diff --git a/.cargo/config.toml b/.cargo/config.toml index f7d8e616f8622..5e3900f08218d 100644 --- a/.cargo/config.toml +++ b/.cargo/config.toml @@ -8,3 +8,7 @@ benchmark = "bench -p ruff_benchmark --bench linter --bench formatter --" # See: https://github.com/astral-sh/ruff/issues/11503 [target.'cfg(all(target_env="msvc", target_os = "windows"))'] rustflags = ["-C", "target-feature=+crt-static"] + +[target.'wasm32-unknown-unknown'] +# See https://docs.rs/getrandom/latest/getrandom/#webassembly-support +rustflags = ["--cfg", 'getrandom_backend="wasm_js"'] \ No newline at end of file diff --git a/.config/nextest.toml b/.config/nextest.toml index e86fea2b367dd..2ab53e2239eae 100644 --- a/.config/nextest.toml +++ b/.config/nextest.toml @@ -6,3 +6,10 @@ failure-output = "immediate-final" fail-fast = false status-level = "skip" + +# Mark tests that take longer than 1s as slow. +# Terminate after 60s as a stop-gap measure to terminate on deadlock. +slow-timeout = { period = "1s", terminate-after = 60 } + +# Show slow jobs in the final summary +final-status-level = "slow" diff --git a/.editorconfig b/.editorconfig index 843bd1f3ad83e..23a805b49f58a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -17,4 +17,7 @@ indent_size = 4 trim_trailing_whitespace = false [*.md] -max_line_length = 100 \ No newline at end of file +max_line_length = 100 + +[*.toml] +indent_size = 4 \ No newline at end of file diff --git a/.gitattributes b/.gitattributes index 9ae06f93d11a9..a12cb611c7934 100644 --- a/.gitattributes +++ b/.gitattributes @@ -12,7 +12,16 @@ crates/ruff_python_parser/resources/invalid/re_lexing/line_continuation_windows_ crates/ruff_python_parser/resources/invalid/re_lex_logical_token_windows_eol.py text eol=crlf crates/ruff_python_parser/resources/invalid/re_lex_logical_token_mac_eol.py text eol=cr +crates/ruff_linter/resources/test/fixtures/ruff/RUF046_CR.py text eol=cr +crates/ruff_linter/resources/test/fixtures/ruff/RUF046_LF.py text eol=lf + +crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_CR.py text eol=cr +crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_LF.py text eol=lf + crates/ruff_python_parser/resources/inline linguist-generated=true -ruff.schema.json linguist-generated=true text=auto eol=lf +ruff.schema.json -diff linguist-generated=true text=auto eol=lf +ty.schema.json -diff linguist-generated=true text=auto eol=lf +crates/ruff_python_ast/src/generated.rs -diff linguist-generated=true text=auto eol=lf +crates/ruff_python_formatter/src/generated.rs -diff linguist-generated=true text=auto eol=lf *.md.snap linguist-language=Markdown diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index b3609b63df02b..43e454d164ad2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -9,13 +9,16 @@ /crates/ruff_formatter/ @MichaReiser /crates/ruff_python_formatter/ @MichaReiser /crates/ruff_python_parser/ @MichaReiser @dhruvmanila +/crates/ruff_annotate_snippets/ @BurntSushi # flake8-pyi /crates/ruff_linter/src/rules/flake8_pyi/ @AlexWaygood -# Script for fuzzing the parser -/scripts/fuzz-parser/ @AlexWaygood +# Script for fuzzing the parser/ty etc. +/python/py-fuzzer/ @AlexWaygood -# red-knot -/crates/red_knot* @carljm @MichaReiser @AlexWaygood -/crates/ruff_db/ @carljm @MichaReiser @AlexWaygood +# ty +/crates/ty* @carljm @MichaReiser @AlexWaygood @sharkdp @dcreager +/crates/ruff_db/ @carljm @MichaReiser @AlexWaygood @sharkdp @dcreager +/scripts/ty_benchmark/ @carljm @MichaReiser @AlexWaygood @sharkdp @dcreager +/crates/ty_python_semantic @carljm @AlexWaygood @sharkdp @dcreager diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b6d15cc8f680c..0000000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,12 +0,0 @@ - diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml new file mode 100644 index 0000000000000..ee04a58b62e53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -0,0 +1,31 @@ +name: Bug report +description: Report an error or unexpected behavior +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report an issue! We're glad to have you involved with Ruff. + + **Before reporting, please make sure to search through [existing issues](https://github.com/astral-sh/ruff/issues?q=is:issue+is:open+label:bug) (including [closed](https://github.com/astral-sh/ruff/issues?q=is:issue%20state:closed%20label:bug)).** + + - type: textarea + attributes: + label: Summary + description: | + A clear and concise description of the bug, including a minimal reproducible example. + + Be sure to include the command you invoked (e.g., `ruff check /path/to/file.py --fix`), ideally including the `--isolated` flag and + the current Ruff settings (e.g., relevant sections from your `pyproject.toml`). + + If possible, try to include the [playground](https://play.ruff.rs) link that reproduces this issue. + + validations: + required: true + + - type: input + attributes: + label: Version + description: What version of ruff are you using? (see `ruff version`) + placeholder: e.g., ruff 0.9.3 (90589372d 2025-01-23) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2_rule_request.yaml b/.github/ISSUE_TEMPLATE/2_rule_request.yaml new file mode 100644 index 0000000000000..02aad445bd656 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_rule_request.yaml @@ -0,0 +1,10 @@ +name: Rule request +description: Anything related to lint rules (proposing new rules, changes to existing rules, auto-fixes, etc.) +body: + - type: textarea + attributes: + label: Summary + description: | + A clear and concise description of the relevant request. If applicable, please describe the current behavior as well. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3_question.yaml b/.github/ISSUE_TEMPLATE/3_question.yaml new file mode 100644 index 0000000000000..4fa356648feb0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_question.yaml @@ -0,0 +1,18 @@ +name: Question +description: Ask a question about Ruff +labels: ["question"] +body: + - type: textarea + attributes: + label: Question + description: Describe your question in detail. + validations: + required: true + + - type: input + attributes: + label: Version + description: What version of ruff are you using? (see `ruff version`) + placeholder: e.g., ruff 0.9.3 (90589372d 2025-01-23) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..5d56b28ace965 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Report an issue with ty + url: https://github.com/astral-sh/ty/issues/new/choose + about: Please report issues for our type checker ty in the ty repository. + - name: Documentation + url: https://docs.astral.sh/ruff + about: Please consult the documentation before creating an issue. + - name: Community + url: https://discord.com/invite/astral-sh + about: Join our Discord community to ask questions and collaborate. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5b6455590f091..3bc48f3cc6747 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,9 @@ diff --git a/.github/actionlint.yaml b/.github/actionlint.yaml new file mode 100644 index 0000000000000..c3464e3992f21 --- /dev/null +++ b/.github/actionlint.yaml @@ -0,0 +1,11 @@ +# Configuration for the actionlint tool, which we run via pre-commit +# to verify the correctness of the syntax in our GitHub Actions workflows. + +self-hosted-runner: + # Various runners we use that aren't recognized out-of-the-box by actionlint: + labels: + - depot-ubuntu-latest-8 + - depot-ubuntu-22.04-16 + - depot-ubuntu-22.04-32 + - github-windows-2025-x86_64-8 + - github-windows-2025-x86_64-16 diff --git a/.github/mypy-primer-ty.toml b/.github/mypy-primer-ty.toml new file mode 100644 index 0000000000000..9317364fe263f --- /dev/null +++ b/.github/mypy-primer-ty.toml @@ -0,0 +1,8 @@ +#:schema ../ty.schema.json +# Configuration overrides for the mypy primer run + +# Enable off-by-default rules. +[rules] +possibly-unresolved-reference = "warn" +unused-ignore-comment = "warn" +division-by-zero = "warn" diff --git a/.github/renovate.json5 b/.github/renovate.json5 index fbc1e95802f70..eb15fa0792b15 100644 --- a/.github/renovate.json5 +++ b/.github/renovate.json5 @@ -40,12 +40,23 @@ enabled: true, }, packageRules: [ + // Pin GitHub Actions to immutable SHAs. + { + matchDepTypes: ["action"], + pinDigests: true, + }, + // Annotate GitHub Actions SHAs with a SemVer version. + { + extends: ["helpers:pinGitHubActionDigests"], + extractVersion: "^(?v?\\d+\\.\\d+\\.\\d+)$", + versioning: "regex:^v?(?\\d+)(\\.(?\\d+)\\.(?\\d+))?$", + }, { // Group upload/download artifact updates, the versions are dependent groupName: "Artifact GitHub Actions dependencies", matchManagers: ["github-actions"], matchDatasources: ["gitea-tags", "github-tags"], - matchPackagePatterns: ["actions/.*-artifact"], + matchPackageNames: ["actions/.*-artifact"], description: "Weekly update of artifact-related GitHub Actions dependencies", }, { @@ -61,7 +72,7 @@ { // Disable updates of `zip-rs`; intentionally pinned for now due to ownership change // See: https://github.com/astral-sh/uv/issues/3642 - matchPackagePatterns: ["zip"], + matchPackageNames: ["zip"], matchManagers: ["cargo"], enabled: false, }, @@ -70,7 +81,7 @@ // with `mkdocs-material-insider`. // See: https://squidfunk.github.io/mkdocs-material/insiders/upgrade/ matchManagers: ["pip_requirements"], - matchPackagePatterns: ["mkdocs-material"], + matchPackageNames: ["mkdocs-material"], enabled: false, }, { @@ -87,22 +98,15 @@ { groupName: "Monaco", matchManagers: ["npm"], - matchPackagePatterns: ["monaco"], + matchPackageNames: ["monaco"], description: "Weekly update of the Monaco editor", }, { groupName: "strum", matchManagers: ["cargo"], - matchPackagePatterns: ["strum"], + matchPackageNames: ["strum"], description: "Weekly update of strum dependencies", - }, - { - groupName: "ESLint", - matchManagers: ["npm"], - matchPackageNames: ["eslint"], - allowedVersions: "<9", - description: "Constraint ESLint to version 8 until TypeScript-eslint supports ESLint 9", // https://github.com/typescript-eslint/typescript-eslint/issues/8211 - }, + } ], vulnerabilityAlerts: { commitMessageSuffix: "", diff --git a/.github/workflows/build-binaries.yml b/.github/workflows/build-binaries.yml index aa65037caeaac..a908489944a86 100644 --- a/.github/workflows/build-binaries.yml +++ b/.github/workflows/build-binaries.yml @@ -23,10 +23,12 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true +permissions: {} + env: PACKAGE_NAME: ruff MODULE_NAME: ruff - PYTHON_VERSION: "3.11" + PYTHON_VERSION: "3.13" CARGO_INCREMENTAL: 0 CARGO_NET_RETRY: 10 CARGO_TERM_COLOR: always @@ -37,26 +39,27 @@ jobs: if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-build') }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build sdist" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: command: sdist args: --out dist - name: "Test sdist" run: | - pip install dist/${{ env.PACKAGE_NAME }}-*.tar.gz --force-reinstall - ${{ env.MODULE_NAME }} --help - python -m ${{ env.MODULE_NAME }} --help + pip install dist/"${PACKAGE_NAME}"-*.tar.gz --force-reinstall + "${MODULE_NAME}" --help + python -m "${MODULE_NAME}" --help - name: "Upload sdist" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-sdist path: dist @@ -65,22 +68,23 @@ jobs: if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-build') }} runs-on: macos-14 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: x64 - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels - x86_64" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: x86_64 args: --release --locked --out dist - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-macos-x86_64 path: dist @@ -95,7 +99,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-macos-x86_64 path: | @@ -106,27 +110,28 @@ jobs: if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-build') }} runs-on: macos-14 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: arm64 - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels - aarch64" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: aarch64 args: --release --locked --out dist - name: "Test wheel - aarch64" run: | - pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall + pip install dist/"${PACKAGE_NAME}"-*.whl --force-reinstall ruff --help python -m ruff --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-aarch64-apple-darwin path: dist @@ -141,7 +146,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-aarch64-apple-darwin path: | @@ -161,17 +166,18 @@ jobs: - target: aarch64-pc-windows-msvc arch: x64 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: ${{ matrix.platform.arch }} - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: ${{ matrix.platform.target }} args: --release --locked --out dist @@ -182,11 +188,11 @@ jobs: if: ${{ !startsWith(matrix.platform.target, 'aarch64') }} shell: bash run: | - python -m pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall - ${{ env.MODULE_NAME }} --help - python -m ${{ env.MODULE_NAME }} --help + python -m pip install dist/"${PACKAGE_NAME}"-*.whl --force-reinstall + "${MODULE_NAME}" --help + python -m "${MODULE_NAME}" --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-${{ matrix.platform.target }} path: dist @@ -197,7 +203,7 @@ jobs: 7z a $ARCHIVE_FILE ./target/${{ matrix.platform.target }}/release/ruff.exe sha256sum $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-${{ matrix.platform.target }} path: | @@ -213,17 +219,18 @@ jobs: - x86_64-unknown-linux-gnu - i686-unknown-linux-gnu steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: x64 - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: ${{ matrix.target }} manylinux: auto @@ -231,11 +238,11 @@ jobs: - name: "Test wheel" if: ${{ startsWith(matrix.target, 'x86_64') }} run: | - pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall - ${{ env.MODULE_NAME }} --help - python -m ${{ env.MODULE_NAME }} --help + pip install dist/"${PACKAGE_NAME}"-*.whl --force-reinstall + "${MODULE_NAME}" --help + python -m "${MODULE_NAME}" --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-${{ matrix.target }} path: dist @@ -253,7 +260,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-${{ matrix.target }} path: | @@ -287,23 +294,24 @@ jobs: arch: arm steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: ${{ matrix.platform.target }} manylinux: auto docker-options: ${{ matrix.platform.maturin_docker_options }} args: --release --locked --out dist - - uses: uraimo/run-on-arch-action@v2 - if: matrix.platform.arch != 'ppc64' + - uses: uraimo/run-on-arch-action@d94c13912ea685de38fccc1109385b83fd79427d # v3.0.1 + if: ${{ matrix.platform.arch != 'ppc64' && matrix.platform.arch != 'ppc64le'}} name: Test wheel with: arch: ${{ matrix.platform.arch == 'arm' && 'armv6' || matrix.platform.arch }} @@ -317,7 +325,7 @@ jobs: pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall ruff --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-${{ matrix.platform.target }} path: dist @@ -335,7 +343,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-${{ matrix.platform.target }} path: | @@ -351,24 +359,25 @@ jobs: - x86_64-unknown-linux-musl - i686-unknown-linux-musl steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: x64 - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: ${{ matrix.target }} manylinux: musllinux_1_2 args: --release --locked --out dist - name: "Test wheel" if: matrix.target == 'x86_64-unknown-linux-musl' - uses: addnab/docker-run-action@v3 + uses: addnab/docker-run-action@4f65fabd2431ebc8d299f8e5a018d79a769ae185 # v3 with: image: alpine:latest options: -v ${{ github.workspace }}:/io -w /io @@ -378,7 +387,7 @@ jobs: .venv/bin/pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall .venv/bin/${{ env.MODULE_NAME }} --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-${{ matrix.target }} path: dist @@ -396,7 +405,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-${{ matrix.target }} path: | @@ -416,22 +425,23 @@ jobs: arch: armv7 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive - - uses: actions/setup-python@v5 + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: target: ${{ matrix.platform.target }} manylinux: musllinux_1_2 args: --release --locked --out dist docker-options: ${{ matrix.platform.maturin_docker_options }} - - uses: uraimo/run-on-arch-action@v2 + - uses: uraimo/run-on-arch-action@d94c13912ea685de38fccc1109385b83fd79427d # v3.0.1 name: Test wheel with: arch: ${{ matrix.platform.arch }} @@ -444,7 +454,7 @@ jobs: .venv/bin/pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall .venv/bin/${{ env.MODULE_NAME }} --help - name: "Upload wheels" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: wheels-${{ matrix.platform.target }} path: dist @@ -462,7 +472,7 @@ jobs: tar czvf $ARCHIVE_FILE $ARCHIVE_NAME shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 - name: "Upload binary" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: artifacts-${{ matrix.platform.target }} path: | diff --git a/.github/workflows/build-docker.yml b/.github/workflows/build-docker.yml index b4ba150656183..3fa86aed6b6df 100644 --- a/.github/workflows/build-docker.yml +++ b/.github/workflows/build-docker.yml @@ -33,13 +33,14 @@ jobs: - linux/amd64 - linux/arm64 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: submodules: recursive + persist-credentials: false - - uses: docker/setup-buildx-action@v3 + - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0 - - uses: docker/login-action@v3 + - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0 with: registry: ghcr.io username: ${{ github.repository_owner }} @@ -47,11 +48,13 @@ jobs: - name: Check tag consistency if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} + env: + TAG: ${{ inputs.plan != '' && fromJson(inputs.plan).announcement_tag || 'dry-run' }} run: | - version=$(grep "version = " pyproject.toml | sed -e 's/version = "\(.*\)"/\1/g') - if [ "${{ fromJson(inputs.plan).announcement_tag }}" != "${version}" ]; then + version=$(grep -m 1 "^version = " pyproject.toml | sed -e 's/version = "\(.*\)"/\1/g') + if [ "${TAG}" != "${version}" ]; then echo "The input tag does not match the version from pyproject.toml:" >&2 - echo "${{ fromJson(inputs.plan).announcement_tag }}" >&2 + echo "${TAG}" >&2 echo "${version}" >&2 exit 1 else @@ -60,7 +63,7 @@ jobs: - name: Extract metadata (tags, labels) for Docker id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0 with: images: ${{ env.RUFF_BASE_IMG }} # Defining this makes sure the org.opencontainers.image.version OCI label becomes the actual release version and not the branch name @@ -71,12 +74,12 @@ jobs: - name: Normalize Platform Pair (replace / with -) run: | platform=${{ matrix.platform }} - echo "PLATFORM_TUPLE=${platform//\//-}" >> $GITHUB_ENV + echo "PLATFORM_TUPLE=${platform//\//-}" >> "$GITHUB_ENV" # Adapted from https://docs.docker.com/build/ci/github-actions/multi-platform/ - name: Build and push by digest id: build - uses: docker/build-push-action@v6 + uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0 with: context: . platforms: ${{ matrix.platform }} @@ -86,13 +89,14 @@ jobs: outputs: type=image,name=${{ env.RUFF_BASE_IMG }},push-by-digest=true,name-canonical=true,push=${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} - name: Export digests + env: + digest: ${{ steps.build.outputs.digest }} run: | mkdir -p /tmp/digests - digest="${{ steps.build.outputs.digest }}" touch "/tmp/digests/${digest#sha256:}" - name: Upload digests - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: digests-${{ env.PLATFORM_TUPLE }} path: /tmp/digests/* @@ -109,17 +113,17 @@ jobs: if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} steps: - name: Download digests - uses: actions/download-artifact@v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 with: path: /tmp/digests pattern: digests-* merge-multiple: true - - uses: docker/setup-buildx-action@v3 + - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0 - name: Extract metadata (tags, labels) for Docker id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0 with: images: ${{ env.RUFF_BASE_IMG }} # Order is on purpose such that the label org.opencontainers.image.version has the first pattern with the full version @@ -127,7 +131,7 @@ jobs: type=pep440,pattern={{ version }},value=${{ fromJson(inputs.plan).announcement_tag }} type=pep440,pattern={{ major }}.{{ minor }},value=${{ fromJson(inputs.plan).announcement_tag }} - - uses: docker/login-action@v3 + - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0 with: registry: ghcr.io username: ${{ github.repository_owner }} @@ -140,9 +144,10 @@ jobs: # The printf will expand the base image with the `@sha256: ...` for each sha256 in the directory # The final command becomes `docker buildx imagetools create -t tag1 -t tag2 ... @sha256: @sha256: ...` run: | + # shellcheck disable=SC2046 docker buildx imagetools create \ $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ env.RUFF_BASE_IMG }}@sha256:%s ' *) + $(printf "${RUFF_BASE_IMG}@sha256:%s " *) docker-publish-extra: name: Publish additional Docker image based on ${{ matrix.image-mapping }} @@ -158,13 +163,13 @@ jobs: # Mapping of base image followed by a comma followed by one or more base tags (comma separated) # Note, org.opencontainers.image.version label will use the first base tag (use the most specific tag first) image-mapping: - - alpine:3.20,alpine3.20,alpine + - alpine:3.21,alpine3.21,alpine - debian:bookworm-slim,bookworm-slim,debian-slim - buildpack-deps:bookworm,bookworm,debian steps: - - uses: docker/setup-buildx-action@v3 + - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0 - - uses: docker/login-action@v3 + - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0 with: registry: ghcr.io username: ${{ github.repository_owner }} @@ -172,6 +177,8 @@ jobs: - name: Generate Dynamic Dockerfile Tags shell: bash + env: + TAG_VALUE: ${{ fromJson(inputs.plan).announcement_tag }} run: | set -euo pipefail @@ -181,7 +188,7 @@ jobs: # Generate Dockerfile content cat < Dockerfile FROM ${BASE_IMAGE} - COPY --from=${{ env.RUFF_BASE_IMG }}:latest /ruff /usr/local/bin/ruff + COPY --from=${RUFF_BASE_IMG}:latest /ruff /usr/local/bin/ruff ENTRYPOINT [] CMD ["/usr/local/bin/ruff"] EOF @@ -192,8 +199,8 @@ jobs: # Loop through all base tags and append its docker metadata pattern to the list # Order is on purpose such that the label org.opencontainers.image.version has the first pattern with the full version IFS=','; for TAG in ${BASE_TAGS}; do - TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ version }},suffix=-${TAG},value=${{ fromJson(inputs.plan).announcement_tag }}\n" - TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ major }}.{{ minor }},suffix=-${TAG},value=${{ fromJson(inputs.plan).announcement_tag }}\n" + TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ version }},suffix=-${TAG},value=${TAG_VALUE}\n" + TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ major }}.{{ minor }},suffix=-${TAG},value=${TAG_VALUE}\n" TAG_PATTERNS="${TAG_PATTERNS}type=raw,value=${TAG}\n" done @@ -201,18 +208,18 @@ jobs: TAG_PATTERNS="${TAG_PATTERNS%\\n}" # Export image cache name - echo "IMAGE_REF=${BASE_IMAGE//:/-}" >> $GITHUB_ENV + echo "IMAGE_REF=${BASE_IMAGE//:/-}" >> "$GITHUB_ENV" # Export tag patterns using the multiline env var syntax { echo "TAG_PATTERNS<> $GITHUB_ENV + } >> "$GITHUB_ENV" - name: Extract metadata (tags, labels) for Docker id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0 # ghcr.io prefers index level annotations env: DOCKER_METADATA_ANNOTATIONS_LEVELS: index @@ -224,7 +231,7 @@ jobs: ${{ env.TAG_PATTERNS }} - name: Build and push - uses: docker/build-push-action@v6 + uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0 with: context: . platforms: linux/amd64,linux/arm64 @@ -249,17 +256,17 @@ jobs: if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} steps: - name: Download digests - uses: actions/download-artifact@v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 with: path: /tmp/digests pattern: digests-* merge-multiple: true - - uses: docker/setup-buildx-action@v3 + - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0 - name: Extract metadata (tags, labels) for Docker id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0 env: DOCKER_METADATA_ANNOTATIONS_LEVELS: index with: @@ -269,7 +276,7 @@ jobs: type=pep440,pattern={{ version }},value=${{ fromJson(inputs.plan).announcement_tag }} type=pep440,pattern={{ major }}.{{ minor }},value=${{ fromJson(inputs.plan).announcement_tag }} - - uses: docker/login-action@v3 + - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0 with: registry: ghcr.io username: ${{ github.repository_owner }} @@ -284,7 +291,9 @@ jobs: # The final command becomes `docker buildx imagetools create -t tag1 -t tag2 ... @sha256: @sha256: ...` run: | readarray -t lines <<< "$DOCKER_METADATA_OUTPUT_ANNOTATIONS"; annotations=(); for line in "${lines[@]}"; do annotations+=(--annotation "$line"); done + + # shellcheck disable=SC2046 docker buildx imagetools create \ "${annotations[@]}" \ $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ env.RUFF_BASE_IMG }}@sha256:%s ' *) + $(printf "${RUFF_BASE_IMG}@sha256:%s " *) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a7d579706584d..d7649eac405bf 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,5 +1,7 @@ name: CI +permissions: {} + on: push: branches: [main] @@ -16,7 +18,7 @@ env: CARGO_TERM_COLOR: always RUSTUP_MAX_RETRIES: 10 PACKAGE_NAME: ruff - PYTHON_VERSION: "3.11" + PYTHON_VERSION: "3.13" jobs: determine_changes: @@ -24,73 +26,179 @@ jobs: runs-on: ubuntu-latest outputs: # Flag that is raised when any code that affects parser is changed - parser: ${{ steps.changed.outputs.parser_any_changed }} + parser: ${{ steps.check_parser.outputs.changed }} # Flag that is raised when any code that affects linter is changed - linter: ${{ steps.changed.outputs.linter_any_changed }} + linter: ${{ steps.check_linter.outputs.changed }} # Flag that is raised when any code that affects formatter is changed - formatter: ${{ steps.changed.outputs.formatter_any_changed }} + formatter: ${{ steps.check_formatter.outputs.changed }} # Flag that is raised when any code is changed # This is superset of the linter and formatter - code: ${{ steps.changed.outputs.code_any_changed }} + code: ${{ steps.check_code.outputs.changed }} + # Flag that is raised when any code that affects the fuzzer is changed + fuzz: ${{ steps.check_fuzzer.outputs.changed }} + # Flag that is set to "true" when code related to ty changes. + ty: ${{ steps.check_ty.outputs.changed }} + + # Flag that is set to "true" when code related to the playground changes. + playground: ${{ steps.check_playground.outputs.changed }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: fetch-depth: 0 + persist-credentials: false - - uses: tj-actions/changed-files@v45 - id: changed - with: - files_yaml: | - parser: - - Cargo.toml - - Cargo.lock - - crates/ruff_python_trivia/** - - crates/ruff_source_file/** - - crates/ruff_text_size/** - - crates/ruff_python_ast/** - - crates/ruff_python_parser/** - - scripts/fuzz-parser/** - - .github/workflows/ci.yaml - - linter: - - Cargo.toml - - Cargo.lock - - crates/** - - "!crates/ruff_python_formatter/**" - - "!crates/ruff_formatter/**" - - "!crates/ruff_dev/**" - - scripts/* - - python/** - - .github/workflows/ci.yaml - - formatter: - - Cargo.toml - - Cargo.lock - - crates/ruff_python_formatter/** - - crates/ruff_formatter/** - - crates/ruff_python_trivia/** - - crates/ruff_python_ast/** - - crates/ruff_source_file/** - - crates/ruff_python_index/** - - crates/ruff_text_size/** - - crates/ruff_python_parser/** - - crates/ruff_dev/** - - scripts/* - - python/** - - .github/workflows/ci.yaml - - code: - - "**/*" - - "!**/*.md" - - "!docs/**" - - "!assets/**" + - name: Determine merge base + id: merge_base + env: + BASE_REF: ${{ github.event.pull_request.base.ref || 'main' }} + run: | + sha=$(git merge-base HEAD "origin/${BASE_REF}") + echo "sha=${sha}" >> "$GITHUB_OUTPUT" + + - name: Check if the parser code changed + id: check_parser + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- \ + ':Cargo.toml' \ + ':Cargo.lock' \ + ':crates/ruff_python_trivia/**' \ + ':crates/ruff_source_file/**' \ + ':crates/ruff_text_size/**' \ + ':crates/ruff_python_ast/**' \ + ':crates/ruff_python_parser/**' \ + ':python/py-fuzzer/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if the linter code changed + id: check_linter + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- ':Cargo.toml' \ + ':Cargo.lock' \ + ':crates/**' \ + ':!crates/ty*/**' \ + ':!crates/ruff_python_formatter/**' \ + ':!crates/ruff_formatter/**' \ + ':!crates/ruff_dev/**' \ + ':!crates/ruff_db/**' \ + ':scripts/*' \ + ':python/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if the formatter code changed + id: check_formatter + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- ':Cargo.toml' \ + ':Cargo.lock' \ + ':crates/ruff_python_formatter/**' \ + ':crates/ruff_formatter/**' \ + ':crates/ruff_python_trivia/**' \ + ':crates/ruff_python_ast/**' \ + ':crates/ruff_source_file/**' \ + ':crates/ruff_python_index/**' \ + ':crates/ruff_python_index/**' \ + ':crates/ruff_text_size/**' \ + ':crates/ruff_python_parser/**' \ + ':scripts/*' \ + ':python/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if the fuzzer code changed + id: check_fuzzer + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- ':Cargo.toml' \ + ':Cargo.lock' \ + ':fuzz/fuzz_targets/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if there was any code related change + id: check_code + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- ':**' \ + ':!**/*.md' \ + ':crates/ty_python_semantic/resources/mdtest/**/*.md' \ + ':!docs/**' \ + ':!assets/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if there was any playground related change + id: check_playground + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- \ + ':playground/**' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi + + - name: Check if the ty code changed + id: check_ty + env: + MERGE_BASE: ${{ steps.merge_base.outputs.sha }} + run: | + if git diff --quiet "${MERGE_BASE}...HEAD" -- \ + ':Cargo.toml' \ + ':Cargo.lock' \ + ':crates/ty*/**' \ + ':crates/ruff_db/**' \ + ':crates/ruff_annotate_snippets/**' \ + ':crates/ruff_python_ast/**' \ + ':crates/ruff_python_parser/**' \ + ':crates/ruff_python_trivia/**' \ + ':crates/ruff_source_file/**' \ + ':crates/ruff_text_size/**' \ + ':.github/workflows/ci.yaml' \ + ; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + fi cargo-fmt: name: "cargo fmt" runs-on: ubuntu-latest timeout-minutes: 10 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: "Install Rust toolchain" run: rustup component add rustfmt - run: cargo fmt --all --check @@ -102,38 +210,50 @@ jobs: if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: | rustup component add clippy rustup target add wasm32-unknown-unknown - - uses: Swatinem/rust-cache@v2 - name: "Clippy" run: cargo clippy --workspace --all-targets --all-features --locked -- -D warnings - name: "Clippy (wasm)" - run: cargo clippy -p ruff_wasm -p red_knot_wasm --target wasm32-unknown-unknown --all-features --locked -- -D warnings + run: cargo clippy -p ruff_wasm -p ty_wasm --target wasm32-unknown-unknown --all-features --locked -- -D warnings cargo-test-linux: name: "cargo test (linux)" - runs-on: ubuntu-latest + runs-on: depot-ubuntu-22.04-16 needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup show - name: "Install mold" - uses: rui314/setup-mold@v1 + uses: rui314/setup-mold@e16410e7f8d9e167b74ad5697a9089a35126eb50 # v1 - name: "Install cargo nextest" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-nextest - name: "Install cargo insta" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-insta - - uses: Swatinem/rust-cache@v2 + - name: ty mdtests (GitHub annotations) + if: ${{ needs.determine_changes.outputs.ty == 'true' }} + env: + NO_COLOR: 1 + MDTEST_GITHUB_ANNOTATIONS_FORMAT: 1 + # Ignore errors if this step fails; we want to continue to later steps in the workflow anyway. + # This step is just to get nice GitHub annotations on the PR diff in the files-changed tab. + run: cargo test -p ty_python_semantic --test mdtest || true - name: "Run tests" shell: bash env: @@ -148,33 +268,69 @@ jobs: # sync, not just public items. Eventually we should do this for all # crates; for now add crates here as they are warning-clean to prevent # regression. - - run: cargo doc --no-deps -p red_knot_python_semantic -p red_knot -p red_knot_test -p ruff_db --document-private-items + - run: cargo doc --no-deps -p ty_python_semantic -p ty -p ty_test -p ruff_db --document-private-items env: # Setting RUSTDOCFLAGS because `cargo doc --check` isn't yet implemented (https://github.com/rust-lang/cargo/issues/10025). RUSTDOCFLAGS: "-D warnings" - - uses: actions/upload-artifact@v4 + - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 with: name: ruff path: target/debug/ruff + - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + with: + name: ty + path: target/debug/ty + + cargo-test-linux-release: + name: "cargo test (linux, release)" + runs-on: depot-ubuntu-22.04-16 + needs: determine_changes + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} + timeout-minutes: 20 + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 + - name: "Install Rust toolchain" + run: rustup show + - name: "Install mold" + uses: rui314/setup-mold@e16410e7f8d9e167b74ad5697a9089a35126eb50 # v1 + - name: "Install cargo nextest" + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 + with: + tool: cargo-nextest + - name: "Install cargo insta" + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 + with: + tool: cargo-insta + - name: "Run tests" + shell: bash + env: + NEXTEST_PROFILE: "ci" + run: cargo insta test --release --all-features --unreferenced reject --test-runner nextest cargo-test-windows: name: "cargo test (windows)" - runs-on: windows-latest + runs-on: github-windows-2025-x86_64-16 needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup show - name: "Install cargo nextest" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-nextest - - uses: Swatinem/rust-cache@v2 - name: "Run tests" shell: bash env: + NEXTEST_PROFILE: "ci" # Workaround for . RUSTUP_WINDOWS_PATH_ADD_BIN: 1 run: | @@ -185,91 +341,103 @@ jobs: name: "cargo test (wasm)" runs-on: ubuntu-latest needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 10 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup target add wasm32-unknown-unknown - - uses: actions/setup-node@v4 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: 20 cache: "npm" cache-dependency-path: playground/package-lock.json - - uses: jetli/wasm-pack-action@v0.4.0 - - uses: Swatinem/rust-cache@v2 + - uses: jetli/wasm-pack-action@0d096b08b4e5a7de8c28de67e11e945404e9eefa # v0.4.0 + with: + version: v0.13.1 - name: "Test ruff_wasm" run: | cd crates/ruff_wasm wasm-pack test --node - - name: "Test red_knot_wasm" + - name: "Test ty_wasm" run: | - cd crates/red_knot_wasm + cd crates/ty_wasm wasm-pack test --node cargo-build-release: name: "cargo build (release)" runs-on: macos-latest - needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ github.ref == 'refs/heads/main' }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup show - name: "Install mold" - uses: rui314/setup-mold@v1 - - uses: Swatinem/rust-cache@v2 + uses: rui314/setup-mold@e16410e7f8d9e167b74ad5697a9089a35126eb50 # v1 - name: "Build" run: cargo build --release --locked cargo-build-msrv: name: "cargo build (msrv)" - runs-on: ubuntu-latest + runs-on: depot-ubuntu-latest-8 needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 - - uses: SebRollen/toml-action@v1.2.0 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: SebRollen/toml-action@b1b3628f55fc3a28208d4203ada8b737e9687876 # v1.2.0 id: msrv with: file: "Cargo.toml" field: "workspace.package.rust-version" + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" - run: rustup default ${{ steps.msrv.outputs.value }} + env: + MSRV: ${{ steps.msrv.outputs.value }} + run: rustup default "${MSRV}" - name: "Install mold" - uses: rui314/setup-mold@v1 + uses: rui314/setup-mold@e16410e7f8d9e167b74ad5697a9089a35126eb50 # v1 - name: "Install cargo nextest" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-nextest - name: "Install cargo insta" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-insta - - uses: Swatinem/rust-cache@v2 - name: "Run tests" shell: bash env: NEXTEST_PROFILE: "ci" - run: cargo +${{ steps.msrv.outputs.value }} insta test --all-features --unreferenced reject --test-runner nextest + MSRV: ${{ steps.msrv.outputs.value }} + run: cargo "+${MSRV}" insta test --all-features --unreferenced reject --test-runner nextest - cargo-fuzz: - name: "cargo fuzz" + cargo-fuzz-build: + name: "cargo fuzz build" runs-on: ubuntu-latest needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ github.ref == 'refs/heads/main' || needs.determine_changes.outputs.fuzz == 'true' || needs.determine_changes.outputs.code == 'true' }} timeout-minutes: 10 steps: - - uses: actions/checkout@v4 - - name: "Install Rust toolchain" - run: rustup show - - uses: Swatinem/rust-cache@v2 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 with: workspaces: "fuzz -> target" + - name: "Install Rust toolchain" + run: rustup show - name: "Install cargo-binstall" - uses: cargo-bins/cargo-binstall@main + uses: cargo-bins/cargo-binstall@5cbf019d8cb9b9d5b086218c41458ea35d817691 # v1.12.5 with: tool: cargo-fuzz@0.11.2 - name: "Install cargo-fuzz" @@ -278,81 +446,95 @@ jobs: - run: cargo fuzz build -s none fuzz-parser: - name: "Fuzz the parser" + name: "fuzz parser" runs-on: ubuntu-latest needs: - cargo-test-linux - determine_changes - if: ${{ needs.determine_changes.outputs.parser == 'true' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && needs.determine_changes.outputs.parser == 'true' }} timeout-minutes: 20 env: FORCE_COLOR: 1 steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: - python-version: ${{ env.PYTHON_VERSION }} - - name: Install uv - run: curl -LsSf https://astral.sh/uv/install.sh | sh - - name: Install Python requirements - run: uv pip install -r scripts/fuzz-parser/requirements.txt --system - - uses: actions/download-artifact@v4 + persist-credentials: false + - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 name: Download Ruff binary to test id: download-cached-binary with: name: ruff path: ruff-to-test - name: Fuzz + env: + DOWNLOAD_PATH: ${{ steps.download-cached-binary.outputs.download-path }} run: | # Make executable, since artifact download doesn't preserve this - chmod +x ${{ steps.download-cached-binary.outputs.download-path }}/ruff - - python scripts/fuzz-parser/fuzz.py 0-500 --test-executable ${{ steps.download-cached-binary.outputs.download-path }}/ruff + chmod +x "${DOWNLOAD_PATH}/ruff" + + ( + uvx \ + --python="${PYTHON_VERSION}" \ + --from=./python/py-fuzzer \ + fuzz \ + --test-executable="${DOWNLOAD_PATH}/ruff" \ + --bin=ruff \ + 0-500 + ) scripts: name: "test scripts" runs-on: ubuntu-latest needs: determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 5 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup component add rustfmt - - uses: Swatinem/rust-cache@v2 - - run: ./scripts/add_rule.py --name DoTheThing --prefix PL --code C0999 --linter pylint + # Run all code generation scripts, and verify that the current output is + # already checked into git. + - run: python crates/ruff_python_ast/generate.py + - run: python crates/ruff_python_formatter/generate.py + - run: test -z "$(git status --porcelain)" + # Verify that adding a plugin or rule produces clean code. + - run: ./scripts/add_rule.py --name DoTheThing --prefix F --code 999 --linter pyflakes - run: cargo check - - run: cargo fmt --all --check - run: | ./scripts/add_plugin.py test --url https://pypi.org/project/-test/0.1.0/ --prefix TST ./scripts/add_rule.py --name FirstRule --prefix TST --code 001 --linter test - run: cargo check - - run: cargo fmt --all --check ecosystem: name: "ecosystem" - runs-on: ubuntu-latest + runs-on: depot-ubuntu-latest-8 needs: - cargo-test-linux - determine_changes # Only runs on pull requests, since that is the only we way we can find the base version for comparison. # Ecosystem check needs linter and/or formatter changes. - if: ${{ github.event_name == 'pull_request' && needs.determine_changes.outputs.code == 'true' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && github.event_name == 'pull_request' && needs.determine_changes.outputs.code == 'true' }} timeout-minutes: 20 steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 name: Download comparison Ruff binary id: ruff-target with: name: ruff path: target/debug - - uses: dawidd6/action-download-artifact@v6 + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 name: Download baseline Ruff binary with: name: ruff @@ -366,64 +548,72 @@ jobs: - name: Run `ruff check` stable ecosystem check if: ${{ needs.determine_changes.outputs.linter == 'true' }} + env: + DOWNLOAD_PATH: ${{ steps.ruff-target.outputs.download-path }} run: | # Make executable, since artifact download doesn't preserve this - chmod +x ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff + chmod +x ./ruff "${DOWNLOAD_PATH}/ruff" # Set pipefail to avoid hiding errors with tee set -eo pipefail - ruff-ecosystem check ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff --cache ./checkouts --output-format markdown | tee ecosystem-result-check-stable + ruff-ecosystem check ./ruff "${DOWNLOAD_PATH}/ruff" --cache ./checkouts --output-format markdown | tee ecosystem-result-check-stable - cat ecosystem-result-check-stable > $GITHUB_STEP_SUMMARY + cat ecosystem-result-check-stable > "$GITHUB_STEP_SUMMARY" echo "### Linter (stable)" > ecosystem-result cat ecosystem-result-check-stable >> ecosystem-result echo "" >> ecosystem-result - name: Run `ruff check` preview ecosystem check if: ${{ needs.determine_changes.outputs.linter == 'true' }} + env: + DOWNLOAD_PATH: ${{ steps.ruff-target.outputs.download-path }} run: | # Make executable, since artifact download doesn't preserve this - chmod +x ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff + chmod +x ./ruff "${DOWNLOAD_PATH}/ruff" # Set pipefail to avoid hiding errors with tee set -eo pipefail - ruff-ecosystem check ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff --cache ./checkouts --output-format markdown --force-preview | tee ecosystem-result-check-preview + ruff-ecosystem check ./ruff "${DOWNLOAD_PATH}/ruff" --cache ./checkouts --output-format markdown --force-preview | tee ecosystem-result-check-preview - cat ecosystem-result-check-preview > $GITHUB_STEP_SUMMARY + cat ecosystem-result-check-preview > "$GITHUB_STEP_SUMMARY" echo "### Linter (preview)" >> ecosystem-result cat ecosystem-result-check-preview >> ecosystem-result echo "" >> ecosystem-result - name: Run `ruff format` stable ecosystem check if: ${{ needs.determine_changes.outputs.formatter == 'true' }} + env: + DOWNLOAD_PATH: ${{ steps.ruff-target.outputs.download-path }} run: | # Make executable, since artifact download doesn't preserve this - chmod +x ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff + chmod +x ./ruff "${DOWNLOAD_PATH}/ruff" # Set pipefail to avoid hiding errors with tee set -eo pipefail - ruff-ecosystem format ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff --cache ./checkouts --output-format markdown | tee ecosystem-result-format-stable + ruff-ecosystem format ./ruff "${DOWNLOAD_PATH}/ruff" --cache ./checkouts --output-format markdown | tee ecosystem-result-format-stable - cat ecosystem-result-format-stable > $GITHUB_STEP_SUMMARY + cat ecosystem-result-format-stable > "$GITHUB_STEP_SUMMARY" echo "### Formatter (stable)" >> ecosystem-result cat ecosystem-result-format-stable >> ecosystem-result echo "" >> ecosystem-result - name: Run `ruff format` preview ecosystem check if: ${{ needs.determine_changes.outputs.formatter == 'true' }} + env: + DOWNLOAD_PATH: ${{ steps.ruff-target.outputs.download-path }} run: | # Make executable, since artifact download doesn't preserve this - chmod +x ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff + chmod +x ./ruff "${DOWNLOAD_PATH}/ruff" # Set pipefail to avoid hiding errors with tee set -eo pipefail - ruff-ecosystem format ./ruff ${{ steps.ruff-target.outputs.download-path }}/ruff --cache ./checkouts --output-format markdown --force-preview | tee ecosystem-result-format-preview + ruff-ecosystem format ./ruff "${DOWNLOAD_PATH}/ruff" --cache ./checkouts --output-format markdown --force-preview | tee ecosystem-result-format-preview - cat ecosystem-result-format-preview > $GITHUB_STEP_SUMMARY + cat ecosystem-result-format-preview > "$GITHUB_STEP_SUMMARY" echo "### Formatter (preview)" >> ecosystem-result cat ecosystem-result-format-preview >> ecosystem-result echo "" >> ecosystem-result @@ -432,26 +622,75 @@ jobs: run: | echo ${{ github.event.number }} > pr-number - - uses: actions/upload-artifact@v4 + - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 name: Upload PR Number with: name: pr-number path: pr-number - - uses: actions/upload-artifact@v4 + - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 name: Upload Results with: name: ecosystem-result path: ecosystem-result + fuzz-ty: + name: "Fuzz for new ty panics" + runs-on: depot-ubuntu-22.04-16 + needs: + - cargo-test-linux + - determine_changes + # Only runs on pull requests, since that is the only we way we can find the base version for comparison. + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && github.event_name == 'pull_request' && needs.determine_changes.outputs.ty == 'true' }} + timeout-minutes: 20 + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + name: Download new ty binary + id: ty-new + with: + name: ty + path: target/debug + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 + name: Download baseline ty binary + with: + name: ty + branch: ${{ github.event.pull_request.base.ref }} + workflow: "ci.yaml" + check_artifacts: true + - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 + - name: Fuzz + env: + FORCE_COLOR: 1 + NEW_TY: ${{ steps.ty-new.outputs.download-path }} + run: | + # Make executable, since artifact download doesn't preserve this + chmod +x "${PWD}/ty" "${NEW_TY}/ty" + + ( + uvx \ + --python="${PYTHON_VERSION}" \ + --from=./python/py-fuzzer \ + fuzz \ + --test-executable="${NEW_TY}/ty" \ + --baseline-executable="${PWD}/ty" \ + --only-new-bugs \ + --bin=ty \ + 0-500 + ) + cargo-shear: name: "cargo shear" runs-on: ubuntu-latest needs: determine_changes if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} steps: - - uses: actions/checkout@v4 - - uses: cargo-bins/cargo-binstall@main + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: cargo-bins/cargo-binstall@5cbf019d8cb9b9d5b086218c41458ea35d817691 # v1.12.5 - run: cargo binstall --no-confirm cargo-shear - run: cargo shear @@ -459,22 +698,25 @@ jobs: name: "python package" runs-on: ubuntu-latest timeout-minutes: 20 + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') }} steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ env.PYTHON_VERSION }} architecture: x64 - - uses: Swatinem/rust-cache@v2 + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Prep README.md" run: python scripts/transform_readme.py --target pypi - name: "Build wheels" - uses: PyO3/maturin-action@v1 + uses: PyO3/maturin-action@aef21716ff3dcae8a1c301d23ec3e4446972a6e3 # v1.49.1 with: args: --out dist - name: "Test wheel" run: | - pip install --force-reinstall --find-links dist ${{ env.PACKAGE_NAME }} + pip install --force-reinstall --find-links dist "${PACKAGE_NAME}" ruff --help python -m ruff --help - name: "Remove wheels from cache" @@ -482,32 +724,32 @@ jobs: pre-commit: name: "pre-commit" - runs-on: ubuntu-latest + runs-on: depot-ubuntu-22.04-16 timeout-minutes: 10 steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: - python-version: ${{ env.PYTHON_VERSION }} - - name: "Install Rust toolchain" - run: rustup show - - uses: Swatinem/rust-cache@v2 - - name: "Install pre-commit" - run: pip install pre-commit + persist-credentials: false + - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 22 - name: "Cache pre-commit" - uses: actions/cache@v4 + uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3 with: path: ~/.cache/pre-commit key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} - name: "Run pre-commit" run: | - echo '```console' > $GITHUB_STEP_SUMMARY + echo '```console' > "$GITHUB_STEP_SUMMARY" # Enable color output for pre-commit and remove it for the summary - SKIP=cargo-fmt,clippy,dev-generate-all pre-commit run --all-files --show-diff-on-failure --color=always | \ - tee >(sed -E 's/\x1B\[([0-9]{1,2}(;[0-9]{1,2})*)?[mGK]//g' >> $GITHUB_STEP_SUMMARY) >&1 - exit_code=${PIPESTATUS[0]} - echo '```' >> $GITHUB_STEP_SUMMARY - exit $exit_code + # Use --hook-stage=manual to enable slower pre-commit hooks that are skipped by default + SKIP=cargo-fmt,clippy,dev-generate-all uvx --python="${PYTHON_VERSION}" pre-commit run --all-files --show-diff-on-failure --color=always --hook-stage=manual | \ + tee >(sed -E 's/\x1B\[([0-9]{1,2}(;[0-9]{1,2})*)?[mGK]//g' >> "$GITHUB_STEP_SUMMARY") >&1 + exit_code="${PIPESTATUS[0]}" + echo '```' >> "$GITHUB_STEP_SUMMARY" + exit "$exit_code" docs: name: "mkdocs" @@ -516,20 +758,22 @@ jobs: env: MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: "3.13" + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Add SSH key" if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@v0.9.0 + uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 with: ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - name: "Install Rust toolchain" run: rustup show - name: Install uv - uses: astral-sh/setup-uv@v3 - - uses: Swatinem/rust-cache@v2 + uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 - name: "Install Insiders dependencies" if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} run: uv pip install -r docs/requirements-insiders.txt --system @@ -553,20 +797,21 @@ jobs: name: "formatter instabilities and black similarity" runs-on: ubuntu-latest needs: determine_changes - if: needs.determine_changes.outputs.formatter == 'true' || github.ref == 'refs/heads/main' + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.formatter == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 10 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup show - - name: "Cache rust" - uses: Swatinem/rust-cache@v2 - - name: "Formatter progress" + - name: "Run checks" run: scripts/formatter_ecosystem_checks.sh - name: "Github step summary" - run: cat target/progress_projects_stats.txt > $GITHUB_STEP_SUMMARY + run: cat target/formatter-ecosystem/stats.txt > "$GITHUB_STEP_SUMMARY" - name: "Remove checkouts from cache" - run: rm -r target/progress_projects + run: rm -r target/formatter-ecosystem check-ruff-lsp: name: "test ruff-lsp" @@ -575,22 +820,24 @@ jobs: needs: - cargo-test-linux - determine_changes - if: ${{ needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main' }} + if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} steps: - - uses: extractions/setup-just@v2 + - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3.0.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 name: "Download ruff-lsp source" with: + persist-credentials: false repository: "astral-sh/ruff-lsp" - - uses: actions/setup-python@v5 + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: - python-version: ${{ env.PYTHON_VERSION }} + # installation fails on 3.13 and newer + python-version: "3.12" - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 name: Download development ruff binary id: ruff-target with: @@ -602,39 +849,76 @@ jobs: just install - name: Run ruff-lsp tests + env: + DOWNLOAD_PATH: ${{ steps.ruff-target.outputs.download-path }} run: | # Setup development binary pip uninstall --yes ruff - chmod +x ${{ steps.ruff-target.outputs.download-path }}/ruff - export PATH=${{ steps.ruff-target.outputs.download-path }}:$PATH + chmod +x "${DOWNLOAD_PATH}/ruff" + export PATH="${DOWNLOAD_PATH}:${PATH}" ruff version just test + check-playground: + name: "check playground" + runs-on: ubuntu-latest + timeout-minutes: 5 + needs: + - determine_changes + if: ${{ (needs.determine_changes.outputs.playground == 'true') }} + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - name: "Install Rust toolchain" + run: rustup target add wasm32-unknown-unknown + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 22 + cache: "npm" + cache-dependency-path: playground/package-lock.json + - uses: jetli/wasm-bindgen-action@20b33e20595891ab1a0ed73145d8a21fc96e7c29 # v0.2.0 + - name: "Install Node dependencies" + run: npm ci + working-directory: playground + - name: "Build playgrounds" + run: npm run dev:wasm + working-directory: playground + - name: "Run TypeScript checks" + run: npm run check + working-directory: playground + - name: "Check formatting" + run: npm run fmt:check + working-directory: playground + benchmarks: - runs-on: ubuntu-22.04 + runs-on: ubuntu-24.04 needs: determine_changes - if: ${{ github.repository == 'astral-sh/ruff' && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} + if: ${{ github.repository == 'astral-sh/ruff' && !contains(github.event.pull_request.labels.*.name, 'no-test') && (needs.determine_changes.outputs.code == 'true' || github.ref == 'refs/heads/main') }} timeout-minutes: 20 steps: - name: "Checkout Branch" - uses: actions/checkout@v4 + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Rust toolchain" run: rustup show - name: "Install codspeed" - uses: taiki-e/install-action@v2 + uses: taiki-e/install-action@941e8a4d9d7cdb696bd4f017cf54aca281f8ffff # v2.51.2 with: tool: cargo-codspeed - - uses: Swatinem/rust-cache@v2 - - name: "Build benchmarks" run: cargo codspeed build --features codspeed -p ruff_benchmark - name: "Run benchmarks" - uses: CodSpeedHQ/action@v3 + uses: CodSpeedHQ/action@0010eb0ca6e89b80c88e8edaaa07cfe5f3e6664d # v3.5.0 with: run: cargo codspeed run token: ${{ secrets.CODSPEED_TOKEN }} diff --git a/.github/workflows/daily_fuzz.yaml b/.github/workflows/daily_fuzz.yaml index 48b0f2eac4e6e..a527a3c8baece 100644 --- a/.github/workflows/daily_fuzz.yaml +++ b/.github/workflows/daily_fuzz.yaml @@ -31,25 +31,31 @@ jobs: # Don't run the cron job on forks: if: ${{ github.repository == 'astral-sh/ruff' || github.event_name != 'schedule' }} steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: - python-version: "3.12" - - name: Install uv - run: curl -LsSf https://astral.sh/uv/install.sh | sh - - name: Install Python requirements - run: uv pip install -r scripts/fuzz-parser/requirements.txt --system + persist-credentials: false + - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 - name: "Install Rust toolchain" run: rustup show - name: "Install mold" - uses: rui314/setup-mold@v1 - - uses: Swatinem/rust-cache@v2 + uses: rui314/setup-mold@e16410e7f8d9e167b74ad5697a9089a35126eb50 # v1 + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: Build ruff # A debug build means the script runs slower once it gets started, # but this is outweighed by the fact that a release build takes *much* longer to compile in CI run: cargo build --locked - name: Fuzz - run: python scripts/fuzz-parser/fuzz.py $(shuf -i 0-9999999999999999999 -n 1000) --test-executable target/debug/ruff + run: | + # shellcheck disable=SC2046 + ( + uvx \ + --python=3.12 \ + --from=./python/py-fuzzer \ + fuzz \ + --test-executable=target/debug/ruff \ + --bin=ruff \ + $(shuf -i 0-9999999999999999999 -n 1000) + ) create-issue-on-failure: name: Create an issue if the daily fuzz surfaced any bugs @@ -59,7 +65,7 @@ jobs: permissions: issues: write steps: - - uses: actions/github-script@v7 + - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | @@ -67,6 +73,6 @@ jobs: owner: "astral-sh", repo: "ruff", title: `Daily parser fuzz failed on ${new Date().toDateString()}`, - body: "Runs listed here: https://github.com/astral-sh/ruff/actions/workflows/daily_fuzz.yml", + body: "Run listed here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}", labels: ["bug", "parser", "fuzzer"], }) diff --git a/.github/workflows/mypy_primer.yaml b/.github/workflows/mypy_primer.yaml new file mode 100644 index 0000000000000..dfa7ef12a2cc3 --- /dev/null +++ b/.github/workflows/mypy_primer.yaml @@ -0,0 +1,101 @@ +name: Run mypy_primer + +permissions: {} + +on: + pull_request: + paths: + - "crates/ty*/**" + - "crates/ruff_db" + - "crates/ruff_python_ast" + - "crates/ruff_python_parser" + - ".github/workflows/mypy_primer.yaml" + - ".github/workflows/mypy_primer_comment.yaml" + - "Cargo.lock" + +concurrency: + group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }} + cancel-in-progress: true + +env: + CARGO_INCREMENTAL: 0 + CARGO_NET_RETRY: 10 + CARGO_TERM_COLOR: always + RUSTUP_MAX_RETRIES: 10 + RUST_BACKTRACE: 1 + +jobs: + mypy_primer: + name: Run mypy_primer + runs-on: depot-ubuntu-22.04-32 + timeout-minutes: 20 + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + path: ruff + fetch-depth: 0 + persist-credentials: false + + - name: Install the latest version of uv + uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 + + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 + with: + workspaces: "ruff" + + - name: Install Rust toolchain + run: rustup show + + - name: Run mypy_primer + shell: bash + run: | + cd ruff + + echo "Enabling mypy primer specific configuration overloads (see .github/mypy-primer-ty.toml)" + mkdir -p ~/.config/ty + cp .github/mypy-primer-ty.toml ~/.config/ty/ty.toml + + PRIMER_SELECTOR="$(paste -s -d'|' crates/ty_python_semantic/resources/primer/good.txt)" + + echo "new commit" + git rev-list --format=%s --max-count=1 "$GITHUB_SHA" + + MERGE_BASE="$(git merge-base "$GITHUB_SHA" "origin/$GITHUB_BASE_REF")" + git checkout -b base_commit "$MERGE_BASE" + echo "base commit" + git rev-list --format=%s --max-count=1 base_commit + + cd .. + + echo "Project selector: $PRIMER_SELECTOR" + # Allow the exit code to be 0 or 1, only fail for actual mypy_primer crashes/bugs + uvx \ + --from="git+https://github.com/hauntsaninja/mypy_primer@01a7ca325f674433c58e02416a867178d1571128" \ + mypy_primer \ + --repo ruff \ + --type-checker ty \ + --old base_commit \ + --new "$GITHUB_SHA" \ + --project-selector "/($PRIMER_SELECTOR)\$" \ + --output concise \ + --debug > mypy_primer.diff || [ $? -eq 1 ] + + # Output diff with ANSI color codes + cat mypy_primer.diff + + # Remove ANSI color codes before uploading + sed -ie 's/\x1b\[[0-9;]*m//g' mypy_primer.diff + + echo ${{ github.event.number }} > pr-number + + - name: Upload diff + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + with: + name: mypy_primer_diff + path: mypy_primer.diff + + - name: Upload pr-number + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + with: + name: pr-number + path: pr-number diff --git a/.github/workflows/mypy_primer_comment.yaml b/.github/workflows/mypy_primer_comment.yaml new file mode 100644 index 0000000000000..85c33677802ea --- /dev/null +++ b/.github/workflows/mypy_primer_comment.yaml @@ -0,0 +1,97 @@ +name: PR comment (mypy_primer) + +on: # zizmor: ignore[dangerous-triggers] + workflow_run: + workflows: [Run mypy_primer] + types: [completed] + workflow_dispatch: + inputs: + workflow_run_id: + description: The mypy_primer workflow that triggers the workflow run + required: true + +jobs: + comment: + runs-on: ubuntu-24.04 + permissions: + pull-requests: write + steps: + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 + name: Download PR number + with: + name: pr-number + run_id: ${{ github.event.workflow_run.id || github.event.inputs.workflow_run_id }} + if_no_artifact_found: ignore + allow_forks: true + + - name: Parse pull request number + id: pr-number + run: | + if [[ -f pr-number ]] + then + echo "pr-number=$(> "$GITHUB_OUTPUT" + fi + + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 + name: "Download mypy_primer results" + id: download-mypy_primer_diff + if: steps.pr-number.outputs.pr-number + with: + name: mypy_primer_diff + workflow: mypy_primer.yaml + pr: ${{ steps.pr-number.outputs.pr-number }} + path: pr/mypy_primer_diff + workflow_conclusion: completed + if_no_artifact_found: ignore + allow_forks: true + + - name: Generate comment content + id: generate-comment + if: steps.download-mypy_primer_diff.outputs.found_artifact == 'true' + run: | + # Guard against malicious mypy_primer results that symlink to a secret + # file on this runner + if [[ -L pr/mypy_primer_diff/mypy_primer.diff ]] + then + echo "Error: mypy_primer.diff cannot be a symlink" + exit 1 + fi + + # Note this identifier is used to find the comment to update on + # subsequent runs + echo '' >> comment.txt + + echo '## `mypy_primer` results' >> comment.txt + if [ -s "pr/mypy_primer_diff/mypy_primer.diff" ]; then + echo '
' >> comment.txt + echo 'Changes were detected when running on open source projects' >> comment.txt + echo '' >> comment.txt + echo '```diff' >> comment.txt + cat pr/mypy_primer_diff/mypy_primer.diff >> comment.txt + echo '```' >> comment.txt + echo '
' >> comment.txt + else + echo 'No ecosystem changes detected ✅' >> comment.txt + fi + + echo 'comment<> "$GITHUB_OUTPUT" + cat comment.txt >> "$GITHUB_OUTPUT" + echo 'EOF' >> "$GITHUB_OUTPUT" + + - name: Find existing comment + uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0 + if: steps.generate-comment.outcome == 'success' + id: find-comment + with: + issue-number: ${{ steps.pr-number.outputs.pr-number }} + comment-author: "github-actions[bot]" + body-includes: "" + + - name: Create or update comment + if: steps.find-comment.outcome == 'success' + uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4 + with: + comment-id: ${{ steps.find-comment.outputs.comment-id }} + issue-number: ${{ steps.pr-number.outputs.pr-number }} + body-path: comment.txt + edit-mode: replace diff --git a/.github/workflows/notify-dependents.yml b/.github/workflows/notify-dependents.yml index 54ddbb19ab265..3f5da3778254b 100644 --- a/.github/workflows/notify-dependents.yml +++ b/.github/workflows/notify-dependents.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest steps: - name: "Update pre-commit mirror" - uses: actions/github-script@v7 + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 with: github-token: ${{ secrets.RUFF_PRE_COMMIT_PAT }} script: | diff --git a/.github/workflows/pr-comment.yaml b/.github/workflows/pr-comment.yaml index 8d67b35082432..0ef00644c1d6e 100644 --- a/.github/workflows/pr-comment.yaml +++ b/.github/workflows/pr-comment.yaml @@ -10,14 +10,13 @@ on: description: The ecosystem workflow that triggers the workflow run required: true -permissions: - pull-requests: write - jobs: comment: runs-on: ubuntu-latest + permissions: + pull-requests: write steps: - - uses: dawidd6/action-download-artifact@v6 + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 name: Download pull request number with: name: pr-number @@ -30,10 +29,10 @@ jobs: run: | if [[ -f pr-number ]] then - echo "pr-number=$(> $GITHUB_OUTPUT + echo "pr-number=$(> "$GITHUB_OUTPUT" fi - - uses: dawidd6/action-download-artifact@v6 + - uses: dawidd6/action-download-artifact@20319c5641d495c8a52e688b7dc5fada6c3a9fbc # v8 name: "Download ecosystem results" id: download-ecosystem-result if: steps.pr-number.outputs.pr-number @@ -66,12 +65,12 @@ jobs: cat pr/ecosystem/ecosystem-result >> comment.txt echo "" >> comment.txt - echo 'comment<> $GITHUB_OUTPUT - cat comment.txt >> $GITHUB_OUTPUT - echo 'EOF' >> $GITHUB_OUTPUT + echo 'comment<> "$GITHUB_OUTPUT" + cat comment.txt >> "$GITHUB_OUTPUT" + echo 'EOF' >> "$GITHUB_OUTPUT" - name: Find existing comment - uses: peter-evans/find-comment@v3 + uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0 if: steps.generate-comment.outcome == 'success' id: find-comment with: @@ -81,7 +80,7 @@ jobs: - name: Create or update comment if: steps.find-comment.outcome == 'success' - uses: peter-evans/create-or-update-comment@v4 + uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4 with: comment-id: ${{ steps.find-comment.outputs.comment-id }} issue-number: ${{ steps.pr-number.outputs.pr-number }} diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index fe2dd5edcbbdd..b1c819f5dc244 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -23,17 +23,19 @@ jobs: env: MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: ref: ${{ inputs.ref }} + persist-credentials: true - - uses: actions/setup-python@v5 + - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: 3.12 - name: "Set docs version" + env: + version: ${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }} run: | - version="${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}" # if version is missing, use 'latest' if [ -z "$version" ]; then echo "Using 'latest' as version" @@ -43,32 +45,30 @@ jobs: # Use version as display name for now display_name="$version" - echo "version=$version" >> $GITHUB_ENV - echo "display_name=$display_name" >> $GITHUB_ENV + echo "version=$version" >> "$GITHUB_ENV" + echo "display_name=$display_name" >> "$GITHUB_ENV" - name: "Set branch name" run: | - version="${{ env.version }}" - display_name="${{ env.display_name }}" timestamp="$(date +%s)" # create branch_display_name from display_name by replacing all # characters disallowed in git branch names with hyphens - branch_display_name="$(echo "$display_name" | tr -c '[:alnum:]._' '-' | tr -s '-')" + branch_display_name="$(echo "${display_name}" | tr -c '[:alnum:]._' '-' | tr -s '-')" - echo "branch_name=update-docs-$branch_display_name-$timestamp" >> $GITHUB_ENV - echo "timestamp=$timestamp" >> $GITHUB_ENV + echo "branch_name=update-docs-$branch_display_name-$timestamp" >> "$GITHUB_ENV" + echo "timestamp=$timestamp" >> "$GITHUB_ENV" - name: "Add SSH key" if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@v0.9.0 + uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 with: ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - name: "Install Rust toolchain" run: rustup show - - uses: Swatinem/rust-cache@v2 + - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8 - name: "Install Insiders dependencies" if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} @@ -92,9 +92,7 @@ jobs: run: mkdocs build --strict -f mkdocs.public.yml - name: "Clone docs repo" - run: | - version="${{ env.version }}" - git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs + run: git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs - name: "Copy docs" run: rm -rf astral-docs/site/ruff && mkdir -p astral-docs/site && cp -r site/ruff astral-docs/site/ @@ -102,12 +100,10 @@ jobs: - name: "Commit docs" working-directory: astral-docs run: | - branch_name="${{ env.branch_name }}" - git config user.name "astral-docs-bot" git config user.email "176161322+astral-docs-bot@users.noreply.github.com" - git checkout -b $branch_name + git checkout -b "${branch_name}" git add site/ruff git commit -m "Update ruff documentation for $version" @@ -116,12 +112,8 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }} run: | - version="${{ env.version }}" - display_name="${{ env.display_name }}" - branch_name="${{ env.branch_name }}" - # set the PR title - pull_request_title="Update ruff documentation for $display_name" + pull_request_title="Update ruff documentation for ${display_name}" # Delete any existing pull requests that are open for this version # by checking against pull_request_title because the new PR will @@ -130,13 +122,15 @@ jobs: xargs -I {} gh pr close {} # push the branch to GitHub - git push origin $branch_name + git push origin "${branch_name}" # create the PR - gh pr create --base main --head $branch_name \ - --title "$pull_request_title" \ - --body "Automated documentation update for $display_name" \ - --label "documentation" + gh pr create \ + --base=main \ + --head="${branch_name}" \ + --title="${pull_request_title}" \ + --body="Automated documentation update for ${display_name}" \ + --label="documentation" - name: "Merge Pull Request" if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} @@ -144,9 +138,7 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }} run: | - branch_name="${{ env.branch_name }}" - # auto-merge the PR if the build was triggered by a release. Manual builds should be reviewed by a human. # give the PR a few seconds to be created before trying to auto-merge it sleep 10 - gh pr merge --squash $branch_name + gh pr merge --squash "${branch_name}" diff --git a/.github/workflows/publish-playground.yml b/.github/workflows/publish-playground.yml index 97b7c6d4dc576..e7bf15dde27de 100644 --- a/.github/workflows/publish-playground.yml +++ b/.github/workflows/publish-playground.yml @@ -24,32 +24,31 @@ jobs: env: CF_API_TOKEN_EXISTS: ${{ secrets.CF_API_TOKEN != '' }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: "Install Rust toolchain" run: rustup target add wasm32-unknown-unknown - - uses: actions/setup-node@v4 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: 20 + node-version: 22 cache: "npm" cache-dependency-path: playground/package-lock.json - - uses: jetli/wasm-pack-action@v0.4.0 - - uses: jetli/wasm-bindgen-action@v0.2.0 - - name: "Run wasm-pack" - run: wasm-pack build --target web --out-dir ../../playground/src/pkg crates/ruff_wasm + - uses: jetli/wasm-bindgen-action@20b33e20595891ab1a0ed73145d8a21fc96e7c29 # v0.2.0 - name: "Install Node dependencies" run: npm ci working-directory: playground - name: "Run TypeScript checks" run: npm run check working-directory: playground - - name: "Build JavaScript bundle" - run: npm run build + - name: "Build Ruff playground" + run: npm run build --workspace ruff-playground working-directory: playground - name: "Deploy to Cloudflare Pages" if: ${{ env.CF_API_TOKEN_EXISTS == 'true' }} - uses: cloudflare/wrangler-action@v3.9.0 + uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3.14.1 with: apiToken: ${{ secrets.CF_API_TOKEN }} accountId: ${{ secrets.CF_ACCOUNT_ID }} # `github.head_ref` is only set during pull requests and for manual runs or tags we use `main` to deploy to production - command: pages deploy playground/dist --project-name=ruff-playground --branch ${{ github.head_ref || 'main' }} --commit-hash ${GITHUB_SHA} + command: pages deploy playground/ruff/dist --project-name=ruff-playground --branch ${{ github.head_ref || 'main' }} --commit-hash ${GITHUB_SHA} diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 4e250f24e013b..81c669f239b42 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -21,14 +21,12 @@ jobs: # For PyPI's trusted publishing. id-token: write steps: - - uses: actions/download-artifact@v4 + - name: "Install uv" + uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6.0.1 + - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 with: pattern: wheels-* path: wheels merge-multiple: true - name: Publish to PyPi - uses: pypa/gh-action-pypi-publish@release/v1 - with: - skip-existing: true - packages-dir: wheels - verbose: true + run: uv publish -v wheels/* diff --git a/.github/workflows/publish-ty-playground.yml b/.github/workflows/publish-ty-playground.yml new file mode 100644 index 0000000000000..b5dc37dc475f1 --- /dev/null +++ b/.github/workflows/publish-ty-playground.yml @@ -0,0 +1,58 @@ +# Publish the ty playground. +name: "[ty Playground] Release" + +permissions: {} + +on: + push: + branches: [main] + paths: + - "crates/ty*/**" + - "crates/ruff_db/**" + - "crates/ruff_python_ast/**" + - "crates/ruff_python_parser/**" + - "playground/**" + - ".github/workflows/publish-ty-playground.yml" + +concurrency: + group: ${{ github.workflow }}-${{ github.ref_name }} + cancel-in-progress: true + +env: + CARGO_INCREMENTAL: 0 + CARGO_NET_RETRY: 10 + CARGO_TERM_COLOR: always + RUSTUP_MAX_RETRIES: 10 + +jobs: + publish: + runs-on: ubuntu-latest + env: + CF_API_TOKEN_EXISTS: ${{ secrets.CF_API_TOKEN != '' }} + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - name: "Install Rust toolchain" + run: rustup target add wasm32-unknown-unknown + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 22 + - uses: jetli/wasm-bindgen-action@20b33e20595891ab1a0ed73145d8a21fc96e7c29 # v0.2.0 + - name: "Install Node dependencies" + run: npm ci + working-directory: playground + - name: "Run TypeScript checks" + run: npm run check + working-directory: playground + - name: "Build ty playground" + run: npm run build --workspace ty-playground + working-directory: playground + - name: "Deploy to Cloudflare Pages" + if: ${{ env.CF_API_TOKEN_EXISTS == 'true' }} + uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3.14.1 + with: + apiToken: ${{ secrets.CF_API_TOKEN }} + accountId: ${{ secrets.CF_ACCOUNT_ID }} + # `github.head_ref` is only set during pull requests and for manual runs or tags we use `main` to deploy to production + command: pages deploy playground/ty/dist --project-name=ty-playground --branch ${{ github.head_ref || 'main' }} --commit-hash ${GITHUB_SHA} diff --git a/.github/workflows/publish-wasm.yml b/.github/workflows/publish-wasm.yml index c33406f118c75..81193b9352d27 100644 --- a/.github/workflows/publish-wasm.yml +++ b/.github/workflows/publish-wasm.yml @@ -29,11 +29,15 @@ jobs: target: [web, bundler, nodejs] fail-fast: false steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: "Install Rust toolchain" run: rustup target add wasm32-unknown-unknown - - uses: jetli/wasm-pack-action@v0.4.0 - - uses: jetli/wasm-bindgen-action@v0.2.0 + - uses: jetli/wasm-pack-action@0d096b08b4e5a7de8c28de67e11e945404e9eefa # v0.4.0 + with: + version: v0.13.1 + - uses: jetli/wasm-bindgen-action@20b33e20595891ab1a0ed73145d8a21fc96e7c29 # v0.2.0 - name: "Run wasm-pack build" run: wasm-pack build --target ${{ matrix.target }} crates/ruff_wasm - name: "Rename generated package" @@ -41,7 +45,7 @@ jobs: jq '.name="@astral-sh/ruff-wasm-${{ matrix.target }}"' crates/ruff_wasm/pkg/package.json > /tmp/package.json mv /tmp/package.json crates/ruff_wasm/pkg - run: cp LICENSE crates/ruff_wasm/pkg # wasm-pack does not put the LICENSE file in the pkg - - uses: actions/setup-node@v4 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: 20 registry-url: "https://registry.npmjs.org" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 769beeaba8e6e..847160c25b368 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,12 +1,13 @@ -# This file was autogenerated by cargo-dist: https://opensource.axo.dev/cargo-dist/ +# This file was autogenerated by dist: https://github.com/astral-sh/cargo-dist # # Copyright 2022-2024, axodotdev +# Copyright 2025 Astral Software Inc. # SPDX-License-Identifier: MIT or Apache-2.0 # # CI that: # # * checks for a Git Tag that looks like a release -# * builds artifacts with cargo-dist (archives, installers, hashes) +# * builds artifacts with dist (archives, installers, hashes) # * uploads those artifacts to temporary workflow zip # * on success, uploads the artifacts to a GitHub Release # @@ -24,10 +25,10 @@ permissions: # must be a Cargo-style SemVer Version (must have at least major.minor.patch). # # If PACKAGE_NAME is specified, then the announcement will be for that -# package (erroring out if it doesn't have the given version or isn't cargo-dist-able). +# package (erroring out if it doesn't have the given version or isn't dist-able). # # If PACKAGE_NAME isn't specified, then the announcement will be for all -# (cargo-dist-able) packages in the workspace with that version (this mode is +# (dist-able) packages in the workspace with that version (this mode is # intended for workspaces with only one dist-able package, or with all dist-able # packages versioned/released in lockstep). # @@ -39,6 +40,7 @@ permissions: # If there's a prerelease-style suffix to the version, then the release(s) # will be marked as a prerelease. on: + pull_request: workflow_dispatch: inputs: tag: @@ -48,9 +50,9 @@ on: type: string jobs: - # Run 'cargo dist plan' (or host) to determine what tasks we need to do + # Run 'dist plan' (or host) to determine what tasks we need to do plan: - runs-on: "ubuntu-20.04" + runs-on: "depot-ubuntu-latest-4" outputs: val: ${{ steps.plan.outputs.manifest }} tag: ${{ (inputs.tag != 'dry-run' && inputs.tag) || '' }} @@ -59,19 +61,20 @@ jobs: env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 with: + persist-credentials: false submodules: recursive - - name: Install cargo-dist + - name: Install dist # we specify bash to get pipefail; it guards against the `curl` command # failing. otherwise `sh` won't catch that `curl` returned non-0 shell: bash - run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.22.1/cargo-dist-installer.sh | sh" - - name: Cache cargo-dist - uses: actions/upload-artifact@v4 + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/astral-sh/cargo-dist/releases/download/v0.28.5-prerelease.1/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@6027e3dd177782cd8ab9af838c04fd81a07f1d47 with: name: cargo-dist-cache - path: ~/.cargo/bin/cargo-dist + path: ~/.cargo/bin/dist # sure would be cool if github gave us proper conditionals... # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible # functionality based on whether this is a pull_request, and whether it's from a fork. @@ -79,12 +82,12 @@ jobs: # but also really annoying to build CI around when it needs secrets to work right.) - id: plan run: | - cargo dist ${{ (inputs.tag && inputs.tag != 'dry-run' && format('host --steps=create --tag={0}', inputs.tag)) || 'plan' }} --output-format=json > plan-dist-manifest.json - echo "cargo dist ran successfully" + dist ${{ (inputs.tag && inputs.tag != 'dry-run' && format('host --steps=create --tag={0}', inputs.tag)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "dist ran successfully" cat plan-dist-manifest.json echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" - name: "Upload dist-manifest.json" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@6027e3dd177782cd8ab9af838c04fd81a07f1d47 with: name: artifacts-plan-dist-manifest path: plan-dist-manifest.json @@ -116,23 +119,24 @@ jobs: - plan - custom-build-binaries - custom-build-docker - runs-on: "ubuntu-20.04" + runs-on: "depot-ubuntu-latest-4" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 with: + persist-credentials: false submodules: recursive - - name: Install cached cargo-dist - uses: actions/download-artifact@v4 + - name: Install cached dist + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 with: name: cargo-dist-cache path: ~/.cargo/bin/ - - run: chmod +x ~/.cargo/bin/cargo-dist + - run: chmod +x ~/.cargo/bin/dist # Get all the local artifacts for the global tasks to use (for e.g. checksums) - name: Fetch local artifacts - uses: actions/download-artifact@v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 with: pattern: artifacts-* path: target/distrib/ @@ -140,8 +144,8 @@ jobs: - id: cargo-dist shell: bash run: | - cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json - echo "cargo dist ran successfully" + dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "dist ran successfully" # Parse out what we just built and upload it to scratch storage echo "paths<> "$GITHUB_OUTPUT" @@ -150,7 +154,7 @@ jobs: cp dist-manifest.json "$BUILD_MANIFEST_NAME" - name: "Upload artifacts" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@6027e3dd177782cd8ab9af838c04fd81a07f1d47 with: name: artifacts-build-global path: | @@ -167,22 +171,23 @@ jobs: if: ${{ always() && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.custom-build-binaries.result == 'skipped' || needs.custom-build-binaries.result == 'success') && (needs.custom-build-docker.result == 'skipped' || needs.custom-build-docker.result == 'success') }} env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - runs-on: "ubuntu-20.04" + runs-on: "depot-ubuntu-latest-4" outputs: val: ${{ steps.host.outputs.manifest }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 with: + persist-credentials: false submodules: recursive - - name: Install cached cargo-dist - uses: actions/download-artifact@v4 + - name: Install cached dist + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 with: name: cargo-dist-cache path: ~/.cargo/bin/ - - run: chmod +x ~/.cargo/bin/cargo-dist + - run: chmod +x ~/.cargo/bin/dist # Fetch artifacts from scratch-storage - name: Fetch artifacts - uses: actions/download-artifact@v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 with: pattern: artifacts-* path: target/distrib/ @@ -191,12 +196,12 @@ jobs: - id: host shell: bash run: | - cargo dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json + dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json echo "artifacts uploaded and released successfully" cat dist-manifest.json echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" - name: "Upload dist-manifest.json" - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@6027e3dd177782cd8ab9af838c04fd81a07f1d47 with: # Overwrite the previous copy name: artifacts-dist-manifest @@ -242,16 +247,17 @@ jobs: # still allowing individual publish jobs to skip themselves (for prereleases). # "host" however must run to completion, no skipping allowed! if: ${{ always() && needs.host.result == 'success' && (needs.custom-publish-pypi.result == 'skipped' || needs.custom-publish-pypi.result == 'success') && (needs.custom-publish-wasm.result == 'skipped' || needs.custom-publish-wasm.result == 'success') }} - runs-on: "ubuntu-20.04" + runs-on: "depot-ubuntu-latest-4" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 with: + persist-credentials: false submodules: recursive # Create a GitHub Release while uploading all files to it - name: "Download GitHub Artifacts" - uses: actions/download-artifact@v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 with: pattern: artifacts-* path: artifacts diff --git a/.github/workflows/sync_typeshed.yaml b/.github/workflows/sync_typeshed.yaml index 4e74ca645fe22..cbdb4a0df37cd 100644 --- a/.github/workflows/sync_typeshed.yaml +++ b/.github/workflows/sync_typeshed.yaml @@ -21,15 +21,17 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 name: Checkout Ruff with: path: ruff - - uses: actions/checkout@v4 + persist-credentials: true + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 name: Checkout typeshed with: repository: python/typeshed path: typeshed + persist-credentials: false - name: Setup git run: | git config --global user.name typeshedbot @@ -37,13 +39,13 @@ jobs: - name: Sync typeshed id: sync run: | - rm -rf ruff/crates/red_knot_vendored/vendor/typeshed - mkdir ruff/crates/red_knot_vendored/vendor/typeshed - cp typeshed/README.md ruff/crates/red_knot_vendored/vendor/typeshed - cp typeshed/LICENSE ruff/crates/red_knot_vendored/vendor/typeshed - cp -r typeshed/stdlib ruff/crates/red_knot_vendored/vendor/typeshed/stdlib - rm -rf ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/@tests - git -C typeshed rev-parse HEAD > ruff/crates/red_knot_vendored/vendor/typeshed/source_commit.txt + rm -rf ruff/crates/ty_vendored/vendor/typeshed + mkdir ruff/crates/ty_vendored/vendor/typeshed + cp typeshed/README.md ruff/crates/ty_vendored/vendor/typeshed + cp typeshed/LICENSE ruff/crates/ty_vendored/vendor/typeshed + cp -r typeshed/stdlib ruff/crates/ty_vendored/vendor/typeshed/stdlib + rm -rf ruff/crates/ty_vendored/vendor/typeshed/stdlib/@tests + git -C typeshed rev-parse HEAD > ruff/crates/ty_vendored/vendor/typeshed/source_commit.txt - name: Commit the changes id: commit if: ${{ steps.sync.outcome == 'success' }} @@ -57,7 +59,7 @@ jobs: run: | cd ruff git push --force origin typeshedbot/sync-typeshed - gh pr list --repo $GITHUB_REPOSITORY --head typeshedbot/sync-typeshed --json id --jq length | grep 1 && exit 0 # exit if there is existing pr + gh pr list --repo "$GITHUB_REPOSITORY" --head typeshedbot/sync-typeshed --json id --jq length | grep 1 && exit 0 # exit if there is existing pr gh pr create --title "Sync vendored typeshed stubs" --body "Close and reopen this PR to trigger CI" --label "internal" create-issue-on-failure: @@ -68,7 +70,7 @@ jobs: permissions: issues: write steps: - - uses: actions/github-script@v7 + - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | @@ -76,5 +78,6 @@ jobs: owner: "astral-sh", repo: "ruff", title: `Automated typeshed sync failed on ${new Date().toDateString()}`, - body: "Runs are listed here: https://github.com/astral-sh/ruff/actions/workflows/sync_typeshed.yaml", + body: "Run listed here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}", + labels: ["bug", "ty"], }) diff --git a/.github/zizmor.yml b/.github/zizmor.yml new file mode 100644 index 0000000000000..383dcea02fbd6 --- /dev/null +++ b/.github/zizmor.yml @@ -0,0 +1,19 @@ +# Configuration for the zizmor static analysis tool, run via pre-commit in CI +# https://woodruffw.github.io/zizmor/configuration/ +# +# TODO: can we remove the ignores here so that our workflows are more secure? +rules: + dangerous-triggers: + ignore: + - pr-comment.yaml + cache-poisoning: + ignore: + - build-docker.yml + - publish-playground.yml + excessive-permissions: + # it's hard to test what the impact of removing these ignores would be + # without actually running the release workflow... + ignore: + - build-docker.yml + - publish-playground.yml + - publish-docs.yml diff --git a/.gitignore b/.gitignore index ad7de8ce76cff..f75e68c745faa 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,10 @@ tracing.folded tracing-flamechart.svg tracing-flamegraph.svg +# insta +*.rs.pending-snap + + ### # Rust.gitignore ### diff --git a/.ignore b/.ignore new file mode 100644 index 0000000000000..19022145b2f97 --- /dev/null +++ b/.ignore @@ -0,0 +1 @@ +!/.github/ diff --git a/.markdownlint.yaml b/.markdownlint.yaml index bdad15c5a58cc..a361d0ab68947 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -21,3 +21,15 @@ MD014: false MD024: # Allow when nested under different parents e.g. CHANGELOG.md siblings_only: true + +# MD046/code-block-style +# +# Ignore this because it conflicts with the code block style used in content +# tabs of mkdocs-material which is to add a blank line after the content title. +# +# Ref: https://github.com/astral-sh/ruff/pull/15011#issuecomment-2544790854 +MD046: false + +# Link text should be descriptive +# Disallows link text like *here* which is annoying. +MD059: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fc47b8fc123ea..68cf34f606678 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,8 +2,11 @@ fail_fast: false exclude: | (?x)^( - crates/red_knot_vendored/vendor/.*| - crates/red_knot_workspace/resources/.*| + .github/workflows/release.yml| + crates/ty_vendored/vendor/.*| + crates/ty_project/resources/.*| + crates/ty/docs/(configuration|rules|cli).md| + crates/ruff_benchmark/resources/.*| crates/ruff_linter/resources/.*| crates/ruff_linter/src/rules/.*/snapshots/.*| crates/ruff_notebook/resources/.*| @@ -16,19 +19,23 @@ exclude: | )$ repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-merge-conflict + - repo: https://github.com/abravalheri/validate-pyproject - rev: v0.21 + rev: v0.24.1 hooks: - id: validate-pyproject - repo: https://github.com/executablebooks/mdformat - rev: 0.7.18 + rev: 0.7.22 hooks: - id: mdformat additional_dependencies: - - mdformat-mkdocs - - mdformat-admon - - mdformat-footnote + - mdformat-mkdocs==4.0.0 + - mdformat-footnote==0.1.1 exclude: | (?x)^( docs/formatter/black\.md @@ -36,7 +43,7 @@ repos: )$ - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.42.0 + rev: v0.45.0 hooks: - id: markdownlint-fix exclude: | @@ -51,11 +58,15 @@ repos: - id: blacken-docs args: ["--pyi", "--line-length", "130"] files: '^crates/.*/resources/mdtest/.*\.md' + exclude: | + (?x)^( + .*?invalid(_.+)*_syntax\.md + )$ additional_dependencies: - - black==24.10.0 + - black==25.1.0 - repo: https://github.com/crate-ci/typos - rev: v1.26.0 + rev: v1.32.0 hooks: - id: typos @@ -69,7 +80,7 @@ repos: pass_filenames: false # This makes it a lot faster - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.7.0 + rev: v0.11.10 hooks: - id: ruff-format - id: ruff @@ -79,10 +90,42 @@ repos: # Prettier - repo: https://github.com/rbubley/mirrors-prettier - rev: v3.3.3 + rev: v3.5.3 hooks: - id: prettier types: [yaml] + # zizmor detects security vulnerabilities in GitHub Actions workflows. + # Additional configuration for the tool is found in `.github/zizmor.yml` + - repo: https://github.com/woodruffw/zizmor-pre-commit + rev: v1.7.0 + hooks: + - id: zizmor + + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.33.0 + hooks: + - id: check-github-workflows + + # `actionlint` hook, for verifying correct syntax in GitHub Actions workflows. + # Some additional configuration for `actionlint` can be found in `.github/actionlint.yaml`. + - repo: https://github.com/rhysd/actionlint + rev: v1.7.7 + hooks: + - id: actionlint + stages: + # This hook is disabled by default, since it's quite slow. + # To run all hooks *including* this hook, use `uvx pre-commit run -a --hook-stage=manual`. + # To run *just* this hook, use `uvx pre-commit run -a actionlint --hook-stage=manual`. + - manual + args: + - "-ignore=SC2129" # ignorable stylistic lint from shellcheck + - "-ignore=SC2016" # another shellcheck lint: seems to have false positives? + additional_dependencies: + # actionlint has a shellcheck integration which extracts shell scripts in `run:` steps from GitHub Actions + # and checks these with shellcheck. This is arguably its most useful feature, + # but the integration only works if shellcheck is installed + - "github.com/wasilibs/go-shellcheck/cmd/shellcheck@v0.10.0" + ci: skip: [cargo-fmt, dev-generate-all] diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index f6000f25ea600..5124ef6a13841 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -1,5 +1,84 @@ # Breaking Changes +## 0.11.0 + +This is a follow-up to release 0.10.0. Because of a mistake in the release process, the `requires-python` inference changes were not included in that release. Ruff 0.11.0 now includes this change as well as the stabilization of the preview behavior for `PGH004`. + +- **Changes to how the Python version is inferred when a `target-version` is not specified** ([#16319](https://github.com/astral-sh/ruff/pull/16319)) + + In previous versions of Ruff, you could specify your Python version with: + + - The `target-version` option in a `ruff.toml` file or the `[tool.ruff]` section of a pyproject.toml file. + - The `project.requires-python` field in a `pyproject.toml` file with a `[tool.ruff]` section. + + These options worked well in most cases, and are still recommended for fine control of the Python version. However, because of the way Ruff discovers config files, `pyproject.toml` files without a `[tool.ruff]` section would be ignored, including the `requires-python` setting. Ruff would then use the default Python version (3.9 as of this writing) instead, which is surprising when you've attempted to request another version. + + In v0.10, config discovery has been updated to address this issue: + + - If Ruff finds a `ruff.toml` file without a `target-version`, it will check + for a `pyproject.toml` file in the same directory and respect its + `requires-python` version, even if it does not contain a `[tool.ruff]` + section. + - If Ruff finds a user-level configuration, the `requires-python` field of the closest `pyproject.toml` in a parent directory will take precedence. + - If there is no config file (`ruff.toml`or `pyproject.toml` with a + `[tool.ruff]` section) in the directory of the file being checked, Ruff will + search for the closest `pyproject.toml` in the parent directories and use its + `requires-python` setting. + +## 0.10.0 + +- **Changes to how the Python version is inferred when a `target-version` is not specified** ([#16319](https://github.com/astral-sh/ruff/pull/16319)) + + Because of a mistake in the release process, the `requires-python` inference changes are not included in this release and instead shipped as part of 0.11.0. + You can find a description of this change in the 0.11.0 section. + +- **Updated `TYPE_CHECKING` behavior** ([#16669](https://github.com/astral-sh/ruff/pull/16669)) + + Previously, Ruff only recognized typechecking blocks that tested the `typing.TYPE_CHECKING` symbol. Now, Ruff recognizes any local variable named `TYPE_CHECKING`. This release also removes support for the legacy `if 0:` and `if False:` typechecking checks. Use a local `TYPE_CHECKING` variable instead. + +- **More robust noqa parsing** ([#16483](https://github.com/astral-sh/ruff/pull/16483)) + + The syntax for both file-level and in-line suppression comments has been unified and made more robust to certain errors. In most cases, this will result in more suppression comments being read by Ruff, but there are a few instances where previously read comments will now log an error to the user instead. Please refer to the documentation on [_Error suppression_](https://docs.astral.sh/ruff/linter/#error-suppression) for the full specification. + +- **Avoid unnecessary parentheses around with statements with a single context manager and a trailing comment** ([#14005](https://github.com/astral-sh/ruff/pull/14005)) + + This change fixes a bug in the formatter where it introduced unnecessary parentheses around with statements with a single context manager and a trailing comment. This change may result in a change in formatting for some users. + +- **Bump alpine default tag to 3.21 for derived Docker images** ([#16456](https://github.com/astral-sh/ruff/pull/16456)) + + Alpine 3.21 was released in Dec 2024 and is used in the official Alpine-based Python images. Now the ruff:alpine image will use 3.21 instead of 3.20 and ruff:alpine3.20 will no longer be updated. + +- **\[`unsafe-markup-use`\]: `RUF035` has been recoded to `S704`** ([#15957](https://github.com/astral-sh/ruff/pull/15957)) + +## 0.9.0 + +Ruff now formats your code according to the 2025 style guide. As a result, your code might now get formatted differently. See the [changelog](./CHANGELOG.md#090) for a detailed list of changes. + +## 0.8.0 + +- **Default to Python 3.9** + + Ruff now defaults to Python 3.9 instead of 3.8 if no explicit Python version is configured using [`ruff.target-version`](https://docs.astral.sh/ruff/settings/#target-version) or [`project.requires-python`](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#python-requires) ([#13896](https://github.com/astral-sh/ruff/pull/13896)) + +- **Changed location of `pydoclint` diagnostics** + + [`pydoclint`](https://docs.astral.sh/ruff/rules/#pydoclint-doc) diagnostics now point to the first-line of the problematic docstring. Previously, this was not the case. + + If you've opted into these preview rules but have them suppressed using + [`noqa`](https://docs.astral.sh/ruff/linter/#error-suppression) comments in + some places, this change may mean that you need to move the `noqa` suppression + comments. Most users should be unaffected by this change. + +- **Use XDG (i.e. `~/.local/bin`) instead of the Cargo home directory in the standalone installer** + + Previously, Ruff's installer used `$CARGO_HOME` or `~/.cargo/bin` for its target install directory. Now, Ruff will be installed into `$XDG_BIN_HOME`, `$XDG_DATA_HOME/../bin`, or `~/.local/bin` (in that order). + + This change is only relevant to users of the standalone Ruff installer (using the shell or PowerShell script). If you installed Ruff using uv or pip, you should be unaffected. + +- **Changes to the line width calculation** + + Ruff now uses a new version of the [unicode-width](https://github.com/unicode-rs/unicode-width) Rust crate to calculate the line width. In very rare cases, this may lead to lines containing Unicode characters being reformatted, or being considered too long when they were not before ([`E501`](https://docs.astral.sh/ruff/rules/line-too-long/)). + ## 0.7.0 - The pytest rules `PT001` and `PT023` now default to omitting the decorator parentheses when there are no arguments @@ -167,7 +246,7 @@ flag or `unsafe-fixes` configuration option can be used to enable unsafe fixes. See the [docs](https://docs.astral.sh/ruff/configuration/#fix-safety) for details. -### Remove formatter-conflicting rules from the default rule set ([#7900](https://github.com/astral-sh/ruff/pull/7900)) +### Remove formatter-conflicting rules from the default rule set ([#7900](https://github.com/astral-sh/ruff/pull/7900)) Previously, Ruff enabled all implemented rules in Pycodestyle (`E`) by default. Ruff now only includes the Pycodestyle prefixes `E4`, `E7`, and `E9` to exclude rules that conflict with automatic formatters. Consequently, @@ -180,8 +259,8 @@ This change only affects those using Ruff under its default rule set. Users that ### Remove support for emoji identifiers ([#7212](https://github.com/astral-sh/ruff/pull/7212)) -Previously, Ruff supported the non-standard compliant emoji identifiers e.g. `📦 = 1`. -We decided to remove this non-standard language extension, and Ruff now reports syntax errors for emoji identifiers in your code, the same as CPython. +Previously, Ruff supported non-standards-compliant emoji identifiers such as `📦 = 1`. +We decided to remove this non-standard language extension. Ruff now reports syntax errors for invalid emoji identifiers in your code, the same as CPython. ### Improved GitLab fingerprints ([#7203](https://github.com/astral-sh/ruff/pull/7203)) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67858c0b65c90..9345ec6570742 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,1293 @@ # Changelog +## 0.11.10 + +### Preview features + +- \[`ruff`\] Implement a recursive check for `RUF060` ([#17976](https://github.com/astral-sh/ruff/pull/17976)) +- \[`airflow`\] Enable autofixes for `AIR301` and `AIR311` ([#17941](https://github.com/astral-sh/ruff/pull/17941)) +- \[`airflow`\] Apply try catch guard to all `AIR3` rules ([#17887](https://github.com/astral-sh/ruff/pull/17887)) +- \[`airflow`\] Extend `AIR311` rules ([#17913](https://github.com/astral-sh/ruff/pull/17913)) + +### Bug fixes + +- \[`flake8-bugbear`\] Ignore `B028` if `skip_file_prefixes` is present ([#18047](https://github.com/astral-sh/ruff/pull/18047)) +- \[`flake8-pie`\] Mark autofix for `PIE804` as unsafe if the dictionary contains comments ([#18046](https://github.com/astral-sh/ruff/pull/18046)) +- \[`flake8-simplify`\] Correct behavior for `str.split`/`rsplit` with `maxsplit=0` (`SIM905`) ([#18075](https://github.com/astral-sh/ruff/pull/18075)) +- \[`flake8-simplify`\] Fix `SIM905` autofix for `rsplit` creating a reversed list literal ([#18045](https://github.com/astral-sh/ruff/pull/18045)) +- \[`flake8-use-pathlib`\] Suppress diagnostics for all `os.*` functions that have the `dir_fd` parameter (`PTH`) ([#17968](https://github.com/astral-sh/ruff/pull/17968)) +- \[`refurb`\] Mark autofix as safe only for number literals (`FURB116`) ([#17692](https://github.com/astral-sh/ruff/pull/17692)) + +### Rule changes + +- \[`flake8-bandit`\] Skip `S608` for expressionless f-strings ([#17999](https://github.com/astral-sh/ruff/pull/17999)) +- \[`flake8-pytest-style`\] Don't recommend `usefixtures` for `parametrize` values (`PT019`) ([#17650](https://github.com/astral-sh/ruff/pull/17650)) +- \[`pyupgrade`\] Add `resource.error` as deprecated alias of `OSError` (`UP024`) ([#17933](https://github.com/astral-sh/ruff/pull/17933)) + +### CLI + +- Disable jemalloc on Android ([#18033](https://github.com/astral-sh/ruff/pull/18033)) + +### Documentation + +- Update Neovim setup docs ([#18108](https://github.com/astral-sh/ruff/pull/18108)) +- \[`flake8-simplify`\] Add fix safety section (`SIM103`) ([#18086](https://github.com/astral-sh/ruff/pull/18086)) +- \[`flake8-simplify`\] Add fix safety section (`SIM112`) ([#18099](https://github.com/astral-sh/ruff/pull/18099)) +- \[`pylint`\] Add fix safety section (`PLC0414`) ([#17802](https://github.com/astral-sh/ruff/pull/17802)) +- \[`pylint`\] Add fix safety section (`PLE4703`) ([#17824](https://github.com/astral-sh/ruff/pull/17824)) +- \[`pylint`\] Add fix safety section (`PLW1514`) ([#17932](https://github.com/astral-sh/ruff/pull/17932)) +- \[`pylint`\] Add fix safety section (`PLW3301`) ([#17878](https://github.com/astral-sh/ruff/pull/17878)) +- \[`ruff`\] Add fix safety section (`RUF007`) ([#17755](https://github.com/astral-sh/ruff/pull/17755)) +- \[`ruff`\] Add fix safety section (`RUF033`) ([#17760](https://github.com/astral-sh/ruff/pull/17760)) + +## 0.11.9 + +### Preview features + +- Default to latest supported Python version for version-related syntax errors ([#17529](https://github.com/astral-sh/ruff/pull/17529)) +- Implement deferred annotations for Python 3.14 ([#17658](https://github.com/astral-sh/ruff/pull/17658)) +- \[`airflow`\] Fix `SQLTableCheckOperator` typo (`AIR302`) ([#17946](https://github.com/astral-sh/ruff/pull/17946)) +- \[`airflow`\] Remove `airflow.utils.dag_parsing_context.get_parsing_context` (`AIR301`) ([#17852](https://github.com/astral-sh/ruff/pull/17852)) +- \[`airflow`\] Skip attribute check in try catch block (`AIR301`) ([#17790](https://github.com/astral-sh/ruff/pull/17790)) +- \[`flake8-bandit`\] Mark tuples of string literals as trusted input in `S603` ([#17801](https://github.com/astral-sh/ruff/pull/17801)) +- \[`isort`\] Check full module path against project root(s) when categorizing first-party imports ([#16565](https://github.com/astral-sh/ruff/pull/16565)) +- \[`ruff`\] Add new rule `in-empty-collection` (`RUF060`) ([#16480](https://github.com/astral-sh/ruff/pull/16480)) + +### Bug fixes + +- Fix missing `combine` call for `lint.typing-extensions` setting ([#17823](https://github.com/astral-sh/ruff/pull/17823)) +- \[`flake8-async`\] Fix module name in `ASYNC110`, `ASYNC115`, and `ASYNC116` fixes ([#17774](https://github.com/astral-sh/ruff/pull/17774)) +- \[`pyupgrade`\] Add spaces between tokens as necessary to avoid syntax errors in `UP018` autofix ([#17648](https://github.com/astral-sh/ruff/pull/17648)) +- \[`refurb`\] Fix false positive for float and complex numbers in `FURB116` ([#17661](https://github.com/astral-sh/ruff/pull/17661)) +- [parser] Flag single unparenthesized generator expr with trailing comma in arguments. ([#17893](https://github.com/astral-sh/ruff/pull/17893)) + +### Documentation + +- Add instructions on how to upgrade to a newer Rust version ([#17928](https://github.com/astral-sh/ruff/pull/17928)) +- Update code of conduct email address ([#17875](https://github.com/astral-sh/ruff/pull/17875)) +- Add fix safety sections to `PLC2801`, `PLR1722`, and `RUF013` ([#17825](https://github.com/astral-sh/ruff/pull/17825), [#17826](https://github.com/astral-sh/ruff/pull/17826), [#17759](https://github.com/astral-sh/ruff/pull/17759)) +- Add link to `check-typed-exception` from `S110` and `S112` ([#17786](https://github.com/astral-sh/ruff/pull/17786)) + +### Other changes + +- Allow passing a virtual environment to `ruff analyze graph` ([#17743](https://github.com/astral-sh/ruff/pull/17743)) + +## 0.11.8 + +### Preview features + +- \[`airflow`\] Apply auto fixes to cases where the names have changed in Airflow 3 (`AIR302`, `AIR311`) ([#17553](https://github.com/astral-sh/ruff/pull/17553), [#17570](https://github.com/astral-sh/ruff/pull/17570), [#17571](https://github.com/astral-sh/ruff/pull/17571)) +- \[`airflow`\] Extend `AIR301` rule ([#17598](https://github.com/astral-sh/ruff/pull/17598)) +- \[`airflow`\] Update existing `AIR302` rules with better suggestions ([#17542](https://github.com/astral-sh/ruff/pull/17542)) +- \[`refurb`\] Mark fix as safe for `readlines-in-for` (`FURB129`) ([#17644](https://github.com/astral-sh/ruff/pull/17644)) +- [syntax-errors] `nonlocal` declaration at module level ([#17559](https://github.com/astral-sh/ruff/pull/17559)) +- [syntax-errors] Detect single starred expression assignment `x = *y` ([#17624](https://github.com/astral-sh/ruff/pull/17624)) + +### Bug fixes + +- \[`flake8-pyi`\] Ensure `Literal[None,] | Literal[None,]` is not autofixed to `None | None` (`PYI061`) ([#17659](https://github.com/astral-sh/ruff/pull/17659)) +- \[`flake8-use-pathlib`\] Avoid suggesting `Path.iterdir()` for `os.listdir` with file descriptor (`PTH208`) ([#17715](https://github.com/astral-sh/ruff/pull/17715)) +- \[`flake8-use-pathlib`\] Fix `PTH104` false positive when `rename` is passed a file descriptor ([#17712](https://github.com/astral-sh/ruff/pull/17712)) +- \[`flake8-use-pathlib`\] Fix `PTH116` false positive when `stat` is passed a file descriptor ([#17709](https://github.com/astral-sh/ruff/pull/17709)) +- \[`flake8-use-pathlib`\] Fix `PTH123` false positive when `open` is passed a file descriptor from a function call ([#17705](https://github.com/astral-sh/ruff/pull/17705)) +- \[`pycodestyle`\] Fix duplicated diagnostic in `E712` ([#17651](https://github.com/astral-sh/ruff/pull/17651)) +- \[`pylint`\] Detect `global` declarations in module scope (`PLE0118`) ([#17411](https://github.com/astral-sh/ruff/pull/17411)) +- [syntax-errors] Make `async-comprehension-in-sync-comprehension` more specific ([#17460](https://github.com/astral-sh/ruff/pull/17460)) + +### Configuration + +- Add option to disable `typing_extensions` imports ([#17611](https://github.com/astral-sh/ruff/pull/17611)) + +### Documentation + +- Fix example syntax for the `lint.pydocstyle.ignore-var-parameters` option ([#17740](https://github.com/astral-sh/ruff/pull/17740)) +- Add fix safety sections (`ASYNC116`, `FLY002`, `D200`, `RUF005`, `RUF017`, `RUF027`, `RUF028`, `RUF057`) ([#17497](https://github.com/astral-sh/ruff/pull/17497), [#17496](https://github.com/astral-sh/ruff/pull/17496), [#17502](https://github.com/astral-sh/ruff/pull/17502), [#17484](https://github.com/astral-sh/ruff/pull/17484), [#17480](https://github.com/astral-sh/ruff/pull/17480), [#17485](https://github.com/astral-sh/ruff/pull/17485), [#17722](https://github.com/astral-sh/ruff/pull/17722), [#17483](https://github.com/astral-sh/ruff/pull/17483)) + +### Other changes + +- Add Python 3.14 to configuration options ([#17647](https://github.com/astral-sh/ruff/pull/17647)) +- Make syntax error for unparenthesized except tuples version specific to before 3.14 ([#17660](https://github.com/astral-sh/ruff/pull/17660)) + +## 0.11.7 + +### Preview features + +- \[`airflow`\] Apply auto fixes to cases where the names have changed in Airflow 3 (`AIR301`) ([#17355](https://github.com/astral-sh/ruff/pull/17355)) +- \[`perflint`\] Implement fix for `manual-dict-comprehension` (`PERF403`) ([#16719](https://github.com/astral-sh/ruff/pull/16719)) +- [syntax-errors] Make duplicate parameter names a semantic error ([#17131](https://github.com/astral-sh/ruff/pull/17131)) + +### Bug fixes + +- \[`airflow`\] Fix typos in provider package names (`AIR302`, `AIR312`) ([#17574](https://github.com/astral-sh/ruff/pull/17574)) +- \[`flake8-type-checking`\] Visit keyword arguments in checks involving `typing.cast`/`typing.NewType` arguments ([#17538](https://github.com/astral-sh/ruff/pull/17538)) +- \[`pyupgrade`\] Preserve parenthesis when fixing native literals containing newlines (`UP018`) ([#17220](https://github.com/astral-sh/ruff/pull/17220)) +- \[`refurb`\] Mark the `FURB161` fix unsafe except for integers and booleans ([#17240](https://github.com/astral-sh/ruff/pull/17240)) + +### Rule changes + +- \[`perflint`\] Allow list function calls to be replaced with a comprehension (`PERF401`) ([#17519](https://github.com/astral-sh/ruff/pull/17519)) +- \[`pycodestyle`\] Auto-fix redundant boolean comparison (`E712`) ([#17090](https://github.com/astral-sh/ruff/pull/17090)) +- \[`pylint`\] make fix unsafe if delete comments (`PLR1730`) ([#17459](https://github.com/astral-sh/ruff/pull/17459)) + +### Documentation + +- Add fix safety sections to docs for several rules ([#17410](https://github.com/astral-sh/ruff/pull/17410),[#17440](https://github.com/astral-sh/ruff/pull/17440),[#17441](https://github.com/astral-sh/ruff/pull/17441),[#17443](https://github.com/astral-sh/ruff/pull/17443),[#17444](https://github.com/astral-sh/ruff/pull/17444)) + +## 0.11.6 + +### Preview features + +- Avoid adding whitespace to the end of a docstring after an escaped quote ([#17216](https://github.com/astral-sh/ruff/pull/17216)) +- \[`airflow`\] Extract `AIR311` from `AIR301` rules (`AIR301`, `AIR311`) ([#17310](https://github.com/astral-sh/ruff/pull/17310), [#17422](https://github.com/astral-sh/ruff/pull/17422)) + +### Bug fixes + +- Raise syntax error when `\` is at end of file ([#17409](https://github.com/astral-sh/ruff/pull/17409)) + +## 0.11.5 + +### Preview features + +- \[`airflow`\] Add missing `AIR302` attribute check ([#17115](https://github.com/astral-sh/ruff/pull/17115)) +- \[`airflow`\] Expand module path check to individual symbols (`AIR302`) ([#17278](https://github.com/astral-sh/ruff/pull/17278)) +- \[`airflow`\] Extract `AIR312` from `AIR302` rules (`AIR302`, `AIR312`) ([#17152](https://github.com/astral-sh/ruff/pull/17152)) +- \[`airflow`\] Update oudated `AIR301`, `AIR302` rules ([#17123](https://github.com/astral-sh/ruff/pull/17123)) +- [syntax-errors] Async comprehension in sync comprehension ([#17177](https://github.com/astral-sh/ruff/pull/17177)) +- [syntax-errors] Check annotations in annotated assignments ([#17283](https://github.com/astral-sh/ruff/pull/17283)) +- [syntax-errors] Extend annotation checks to `await` ([#17282](https://github.com/astral-sh/ruff/pull/17282)) + +### Bug fixes + +- \[`flake8-pie`\] Avoid false positive for multiple assignment with `auto()` (`PIE796`) ([#17274](https://github.com/astral-sh/ruff/pull/17274)) + +### Rule changes + +- \[`ruff`\] Fix `RUF100` to detect unused file-level `noqa` directives with specific codes (#17042) ([#17061](https://github.com/astral-sh/ruff/pull/17061)) +- \[`flake8-pytest-style`\] Avoid false positive for legacy form of `pytest.raises` (`PT011`) ([#17231](https://github.com/astral-sh/ruff/pull/17231)) + +### Documentation + +- Fix formatting of "See Style Guide" link ([#17272](https://github.com/astral-sh/ruff/pull/17272)) + +## 0.11.4 + +### Preview features + +- \[`ruff`\] Implement `invalid-rule-code` as `RUF102` ([#17138](https://github.com/astral-sh/ruff/pull/17138)) +- [syntax-errors] Detect duplicate keys in `match` mapping patterns ([#17129](https://github.com/astral-sh/ruff/pull/17129)) +- [syntax-errors] Detect duplicate attributes in `match` class patterns ([#17186](https://github.com/astral-sh/ruff/pull/17186)) +- [syntax-errors] Detect invalid syntax in annotations ([#17101](https://github.com/astral-sh/ruff/pull/17101)) + +### Bug fixes + +- [syntax-errors] Fix multiple assignment error for class fields in `match` patterns ([#17184](https://github.com/astral-sh/ruff/pull/17184)) +- Don't skip visiting non-tuple slice in `typing.Annotated` subscripts ([#17201](https://github.com/astral-sh/ruff/pull/17201)) + +## 0.11.3 + +### Preview features + +- \[`airflow`\] Add more autofixes for `AIR302` ([#16876](https://github.com/astral-sh/ruff/pull/16876), [#16977](https://github.com/astral-sh/ruff/pull/16977), [#16976](https://github.com/astral-sh/ruff/pull/16976), [#16965](https://github.com/astral-sh/ruff/pull/16965)) +- \[`airflow`\] Move `AIR301` to `AIR002` ([#16978](https://github.com/astral-sh/ruff/pull/16978)) +- \[`airflow`\] Move `AIR302` to `AIR301` and `AIR303` to `AIR302` ([#17151](https://github.com/astral-sh/ruff/pull/17151)) +- \[`flake8-bandit`\] Mark `str` and `list[str]` literals as trusted input (`S603`) ([#17136](https://github.com/astral-sh/ruff/pull/17136)) +- \[`ruff`\] Support slices in `RUF005` ([#17078](https://github.com/astral-sh/ruff/pull/17078)) +- [syntax-errors] Start detecting compile-time syntax errors ([#16106](https://github.com/astral-sh/ruff/pull/16106)) +- [syntax-errors] Duplicate type parameter names ([#16858](https://github.com/astral-sh/ruff/pull/16858)) +- [syntax-errors] Irrefutable `case` pattern before final case ([#16905](https://github.com/astral-sh/ruff/pull/16905)) +- [syntax-errors] Multiple assignments in `case` pattern ([#16957](https://github.com/astral-sh/ruff/pull/16957)) +- [syntax-errors] Single starred assignment target ([#17024](https://github.com/astral-sh/ruff/pull/17024)) +- [syntax-errors] Starred expressions in `return`, `yield`, and `for` ([#17134](https://github.com/astral-sh/ruff/pull/17134)) +- [syntax-errors] Store to or delete `__debug__` ([#16984](https://github.com/astral-sh/ruff/pull/16984)) + +### Bug fixes + +- Error instead of `panic!` when running Ruff from a deleted directory (#16903) ([#17054](https://github.com/astral-sh/ruff/pull/17054)) +- [syntax-errors] Fix false positive for parenthesized tuple index ([#16948](https://github.com/astral-sh/ruff/pull/16948)) + +### CLI + +- Check `pyproject.toml` correctly when it is passed via stdin ([#16971](https://github.com/astral-sh/ruff/pull/16971)) + +### Configuration + +- \[`flake8-import-conventions`\] Add import `numpy.typing as npt` to default `flake8-import-conventions.aliases` ([#17133](https://github.com/astral-sh/ruff/pull/17133)) + +### Documentation + +- \[`refurb`\] Document why `UserDict`, `UserList`, and `UserString` are preferred over `dict`, `list`, and `str` (`FURB189`) ([#16927](https://github.com/astral-sh/ruff/pull/16927)) + +## 0.11.2 + +### Preview features + +- [syntax-errors] Fix false-positive syntax errors emitted for annotations on variadic parameters before Python 3.11 ([#16878](https://github.com/astral-sh/ruff/pull/16878)) + +## 0.11.1 + +### Preview features + +- \[`airflow`\] Add `chain`, `chain_linear` and `cross_downstream` for `AIR302` ([#16647](https://github.com/astral-sh/ruff/pull/16647)) +- [syntax-errors] Improve error message and range for pre-PEP-614 decorator syntax errors ([#16581](https://github.com/astral-sh/ruff/pull/16581)) +- [syntax-errors] PEP 701 f-strings before Python 3.12 ([#16543](https://github.com/astral-sh/ruff/pull/16543)) +- [syntax-errors] Parenthesized context managers before Python 3.9 ([#16523](https://github.com/astral-sh/ruff/pull/16523)) +- [syntax-errors] Star annotations before Python 3.11 ([#16545](https://github.com/astral-sh/ruff/pull/16545)) +- [syntax-errors] Star expression in index before Python 3.11 ([#16544](https://github.com/astral-sh/ruff/pull/16544)) +- [syntax-errors] Unparenthesized assignment expressions in sets and indexes ([#16404](https://github.com/astral-sh/ruff/pull/16404)) + +### Bug fixes + +- Server: Allow `FixAll` action in presence of version-specific syntax errors ([#16848](https://github.com/astral-sh/ruff/pull/16848)) +- \[`flake8-bandit`\] Allow raw strings in `suspicious-mark-safe-usage` (`S308`) #16702 ([#16770](https://github.com/astral-sh/ruff/pull/16770)) +- \[`refurb`\] Avoid panicking `unwrap` in `verbose-decimal-constructor` (`FURB157`) ([#16777](https://github.com/astral-sh/ruff/pull/16777)) +- \[`refurb`\] Fix starred expressions fix (`FURB161`) ([#16550](https://github.com/astral-sh/ruff/pull/16550)) +- Fix `--statistics` reporting for unsafe fixes ([#16756](https://github.com/astral-sh/ruff/pull/16756)) + +### Rule changes + +- \[`flake8-executables`\] Allow `uv run` in shebang line for `shebang-missing-python` (`EXE003`) ([#16849](https://github.com/astral-sh/ruff/pull/16849),[#16855](https://github.com/astral-sh/ruff/pull/16855)) + +### CLI + +- Add `--exit-non-zero-on-format` ([#16009](https://github.com/astral-sh/ruff/pull/16009)) + +### Documentation + +- Update Ruff tutorial to avoid non-existent fix in `__init__.py` ([#16818](https://github.com/astral-sh/ruff/pull/16818)) +- \[`flake8-gettext`\] Swap `format-` and `printf-in-get-text-func-call` examples (`INT002`, `INT003`) ([#16769](https://github.com/astral-sh/ruff/pull/16769)) + +## 0.11.0 + +This is a follow-up to release 0.10.0. Because of a mistake in the release process, the `requires-python` inference changes were not included in that release. Ruff 0.11.0 now includes this change as well as the stabilization of the preview behavior for `PGH004`. + +### Breaking changes + +- **Changes to how the Python version is inferred when a `target-version` is not specified** ([#16319](https://github.com/astral-sh/ruff/pull/16319)) + + In previous versions of Ruff, you could specify your Python version with: + + - The `target-version` option in a `ruff.toml` file or the `[tool.ruff]` section of a pyproject.toml file. + - The `project.requires-python` field in a `pyproject.toml` file with a `[tool.ruff]` section. + + These options worked well in most cases, and are still recommended for fine control of the Python version. However, because of the way Ruff discovers config files, `pyproject.toml` files without a `[tool.ruff]` section would be ignored, including the `requires-python` setting. Ruff would then use the default Python version (3.9 as of this writing) instead, which is surprising when you've attempted to request another version. + + In v0.10, config discovery has been updated to address this issue: + + - If Ruff finds a `ruff.toml` file without a `target-version`, it will check + for a `pyproject.toml` file in the same directory and respect its + `requires-python` version, even if it does not contain a `[tool.ruff]` + section. + - If Ruff finds a user-level configuration, the `requires-python` field of the closest `pyproject.toml` in a parent directory will take precedence. + - If there is no config file (`ruff.toml`or `pyproject.toml` with a + `[tool.ruff]` section) in the directory of the file being checked, Ruff will + search for the closest `pyproject.toml` in the parent directories and use its + `requires-python` setting. + +### Stabilization + +The following behaviors have been stabilized: + +- [`blanket-noqa`](https://docs.astral.sh/ruff/rules/blanket-noqa/) (`PGH004`): Also detect blanked file-level noqa comments (and not just line level comments). + +### Preview features + +- [syntax-errors] Tuple unpacking in `for` statement iterator clause before Python 3.9 ([#16558](https://github.com/astral-sh/ruff/pull/16558)) + +## 0.10.0 + +Check out the [blog post](https://astral.sh/blog/ruff-v0.10.0) for a migration guide and overview of the changes! + +### Breaking changes + +See also, the "Remapped rules" section which may result in disabled rules. + +- **Changes to how the Python version is inferred when a `target-version` is not specified** ([#16319](https://github.com/astral-sh/ruff/pull/16319)) + + Because of a mistake in the release process, the `requires-python` inference changes are not included in this release and instead shipped as part of 0.11.0. + You can find a description of this change in the 0.11.0 section. + +- **Updated `TYPE_CHECKING` behavior** ([#16669](https://github.com/astral-sh/ruff/pull/16669)) + + Previously, Ruff only recognized typechecking blocks that tested the `typing.TYPE_CHECKING` symbol. Now, Ruff recognizes any local variable named `TYPE_CHECKING`. This release also removes support for the legacy `if 0:` and `if False:` typechecking checks. Use a local `TYPE_CHECKING` variable instead. + +- **More robust noqa parsing** ([#16483](https://github.com/astral-sh/ruff/pull/16483)) + + The syntax for both file-level and in-line suppression comments has been unified and made more robust to certain errors. In most cases, this will result in more suppression comments being read by Ruff, but there are a few instances where previously read comments will now log an error to the user instead. Please refer to the documentation on [*Error suppression*](https://docs.astral.sh/ruff/linter/#error-suppression) for the full specification. + +- **Avoid unnecessary parentheses around with statements with a single context manager and a trailing comment** ([#14005](https://github.com/astral-sh/ruff/pull/14005)) + + This change fixes a bug in the formatter where it introduced unnecessary parentheses around with statements with a single context manager and a trailing comment. This change may result in a change in formatting for some users. + +- **Bump alpine default tag to 3.21 for derived Docker images** ([#16456](https://github.com/astral-sh/ruff/pull/16456)) + + Alpine 3.21 was released in Dec 2024 and is used in the official Alpine-based Python images. Now the ruff:alpine image will use 3.21 instead of 3.20 and ruff:alpine3.20 will no longer be updated. + +### Deprecated Rules + +The following rules have been deprecated: + +- [`non-pep604-isinstance`](https://docs.astral.sh/ruff/rules/non-pep604-isinstance/) (`UP038`) +- [`suspicious-xmle-tree-usage`](https://docs.astral.sh/ruff/rules/suspicious-xmle-tree-usage/) (`S320`) + +### Remapped rules + +The following rules have been remapped to new rule codes: + +- \[`unsafe-markup-use`\]: `RUF035` to `S704` + +### Stabilization + +The following rules have been stabilized and are no longer in preview: + +- [`batched-without-explicit-strict`](https://docs.astral.sh/ruff/rules/batched-without-explicit-strict) (`B911`) +- [`unnecessary-dict-comprehension-for-iterable`](https://docs.astral.sh/ruff/rules/unnecessary-dict-comprehension-for-iterable) (`C420`) +- [`datetime-min-max`](https://docs.astral.sh/ruff/rules/datetime-min-max) (`DTZ901`) +- [`fast-api-unused-path-parameter`](https://docs.astral.sh/ruff/rules/fast-api-unused-path-parameter) (`FAST003`) +- [`root-logger-call`](https://docs.astral.sh/ruff/rules/root-logger-call) (`LOG015`) +- [`len-test`](https://docs.astral.sh/ruff/rules/len-test) (`PLC1802`) +- [`shallow-copy-environ`](https://docs.astral.sh/ruff/rules/shallow-copy-environ) (`PLW1507`) +- [`os-listdir`](https://docs.astral.sh/ruff/rules/os-listdir) (`PTH208`) +- [`invalid-pathlib-with-suffix`](https://docs.astral.sh/ruff/rules/invalid-pathlib-with-suffix) (`PTH210`) +- [`invalid-assert-message-literal-argument`](https://docs.astral.sh/ruff/rules/invalid-assert-message-literal-argument) (`RUF040`) +- [`unnecessary-nested-literal`](https://docs.astral.sh/ruff/rules/unnecessary-nested-literal) (`RUF041`) +- [`unnecessary-cast-to-int`](https://docs.astral.sh/ruff/rules/unnecessary-cast-to-int) (`RUF046`) +- [`map-int-version-parsing`](https://docs.astral.sh/ruff/rules/map-int-version-parsing) (`RUF048`) +- [`if-key-in-dict-del`](https://docs.astral.sh/ruff/rules/if-key-in-dict-del) (`RUF051`) +- [`unsafe-markup-use`](https://docs.astral.sh/ruff/rules/unsafe-markup-use) (`S704`). This rule has also been renamed from `RUF035`. +- [`split-static-string`](https://docs.astral.sh/ruff/rules/split-static-string) (`SIM905`) +- [`runtime-cast-value`](https://docs.astral.sh/ruff/rules/runtime-cast-value) (`TC006`) +- [`unquoted-type-alias`](https://docs.astral.sh/ruff/rules/unquoted-type-alias) (`TC007`) +- [`non-pep646-unpack`](https://docs.astral.sh/ruff/rules/non-pep646-unpack) (`UP044`) + +The following behaviors have been stabilized: + +- [`bad-staticmethod-argument`](https://docs.astral.sh/ruff/rules/bad-staticmethod-argument/) (`PLW0211`) [`invalid-first-argument-name-for-class-method`](https://docs.astral.sh/ruff/rules/invalid-first-argument-name-for-class-method/) (`N804`): `__new__` methods are now no longer flagged by `invalid-first-argument-name-for-class-method` (`N804`) but instead by `bad-staticmethod-argument` (`PLW0211`) +- [`bad-str-strip-call`](https://docs.astral.sh/ruff/rules/bad-str-strip-call/) (`PLE1310`): The rule now applies to objects which are known to have type `str` or `bytes`. +- [`custom-type-var-for-self`](https://docs.astral.sh/ruff/rules/custom-type-var-for-self/) (`PYI019`): More accurate detection of custom `TypeVars` replaceable by `Self`. The range of the diagnostic is now the full function header rather than just the return annotation. +- [`invalid-argument-name`](https://docs.astral.sh/ruff/rules/invalid-argument-name/) (`N803`): Ignore argument names of functions decorated with `typing.override` +- [`invalid-envvar-default`](https://docs.astral.sh/ruff/rules/invalid-envvar-default/) (`PLW1508`): Detect default value arguments to `os.environ.get` with invalid type. +- [`pytest-raises-with-multiple-statements`](https://docs.astral.sh/ruff/rules/pytest-raises-with-multiple-statements/) (`PT012`) [`pytest-warns-with-multiple-statements`](https://docs.astral.sh/ruff/rules/pytest-warns-with-multiple-statements/) (`PT031`): Allow `for` statements with an empty body in `pytest.raises` and `pytest.warns` `with` statements. +- [`redundant-open-modes`](https://docs.astral.sh/ruff/rules/redundant-open-modes/) (`UP015`): The diagnostic range is now the range of the redundant mode argument where it previously was the range of the entire open call. You may have to replace your `noqa` comments when suppressing `UP015`. +- [`stdlib-module-shadowing`](https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/) (`A005`): Changes the default value of `lint.flake8-builtins.strict-checking` from `true` to `false`. +- [`type-none-comparison`](https://docs.astral.sh/ruff/rules/type-none-comparison/) (`FURB169`): Now also recognizes `type(expr) is type(None)` comparisons where `expr` isn't a name expression. + +The following fixes or improvements to fixes have been stabilized: + +- [`repeated-equality-comparison`](https://docs.astral.sh/ruff/rules/repeated-equality-comparison/) (`PLR1714`) ([#16685](https://github.com/astral-sh/ruff/pull/16685)) +- [`needless-bool`](https://docs.astral.sh/ruff/rules/needless-bool/) (`SIM103`) ([#16684](https://github.com/astral-sh/ruff/pull/16684)) +- [`unused-private-type-var`](https://docs.astral.sh/ruff/rules/unused-private-type-var/) (`PYI018`) ([#16682](https://github.com/astral-sh/ruff/pull/16682)) + +### Server + +- Remove logging output for `ruff.printDebugInformation` ([#16617](https://github.com/astral-sh/ruff/pull/16617)) + +### Configuration + +- \[`flake8-builtins`\] Deprecate the `builtins-` prefixed options in favor of the unprefixed options (e.g. `builtins-allowed-modules` is now deprecated in favor of `allowed-modules`) ([#16092](https://github.com/astral-sh/ruff/pull/16092)) + +### Bug fixes + +- [flake8-bandit] Fix mixed-case hash algorithm names (S324) ([#16552](https://github.com/astral-sh/ruff/pull/16552)) + +### CLI + +- [ruff] Fix `last_tag`/`commits_since_last_tag` for `version` command ([#16686](https://github.com/astral-sh/ruff/pull/16686)) + +## 0.9.10 + +### Preview features + +- \[`ruff`\] Add new rule `RUF059`: Unused unpacked assignment ([#16449](https://github.com/astral-sh/ruff/pull/16449)) +- \[`syntax-errors`\] Detect assignment expressions before Python 3.8 ([#16383](https://github.com/astral-sh/ruff/pull/16383)) +- \[`syntax-errors`\] Named expressions in decorators before Python 3.9 ([#16386](https://github.com/astral-sh/ruff/pull/16386)) +- \[`syntax-errors`\] Parenthesized keyword argument names after Python 3.8 ([#16482](https://github.com/astral-sh/ruff/pull/16482)) +- \[`syntax-errors`\] Positional-only parameters before Python 3.8 ([#16481](https://github.com/astral-sh/ruff/pull/16481)) +- \[`syntax-errors`\] Tuple unpacking in `return` and `yield` before Python 3.8 ([#16485](https://github.com/astral-sh/ruff/pull/16485)) +- \[`syntax-errors`\] Type parameter defaults before Python 3.13 ([#16447](https://github.com/astral-sh/ruff/pull/16447)) +- \[`syntax-errors`\] Type parameter lists before Python 3.12 ([#16479](https://github.com/astral-sh/ruff/pull/16479)) +- \[`syntax-errors`\] `except*` before Python 3.11 ([#16446](https://github.com/astral-sh/ruff/pull/16446)) +- \[`syntax-errors`\] `type` statements before Python 3.12 ([#16478](https://github.com/astral-sh/ruff/pull/16478)) + +### Bug fixes + +- Escape template filenames in glob patterns in configuration ([#16407](https://github.com/astral-sh/ruff/pull/16407)) +- \[`flake8-simplify`\] Exempt unittest context methods for `SIM115` rule ([#16439](https://github.com/astral-sh/ruff/pull/16439)) +- Formatter: Fix syntax error location in notebooks ([#16499](https://github.com/astral-sh/ruff/pull/16499)) +- \[`pyupgrade`\] Do not offer fix when at least one target is `global`/`nonlocal` (`UP028`) ([#16451](https://github.com/astral-sh/ruff/pull/16451)) +- \[`flake8-builtins`\] Ignore variables matching module attribute names (`A001`) ([#16454](https://github.com/astral-sh/ruff/pull/16454)) +- \[`pylint`\] Convert `code` keyword argument to a positional argument in fix for (`PLR1722`) ([#16424](https://github.com/astral-sh/ruff/pull/16424)) + +### CLI + +- Move rule code from `description` to `check_name` in GitLab output serializer ([#16437](https://github.com/astral-sh/ruff/pull/16437)) + +### Documentation + +- \[`pydocstyle`\] Clarify that `D417` only checks docstrings with an arguments section ([#16494](https://github.com/astral-sh/ruff/pull/16494)) + +## 0.9.9 + +### Preview features + +- Fix caching of unsupported-syntax errors ([#16425](https://github.com/astral-sh/ruff/pull/16425)) + +### Bug fixes + +- Only show unsupported-syntax errors in editors when preview mode is enabled ([#16429](https://github.com/astral-sh/ruff/pull/16429)) + +## 0.9.8 + +### Preview features + +- Start detecting version-related syntax errors in the parser ([#16090](https://github.com/astral-sh/ruff/pull/16090)) + +### Rule changes + +- \[`pylint`\] Mark fix unsafe (`PLW1507`) ([#16343](https://github.com/astral-sh/ruff/pull/16343)) +- \[`pylint`\] Catch `case np.nan`/`case math.nan` in `match` statements (`PLW0177`) ([#16378](https://github.com/astral-sh/ruff/pull/16378)) +- \[`ruff`\] Add more Pydantic models variants to the list of default copy semantics (`RUF012`) ([#16291](https://github.com/astral-sh/ruff/pull/16291)) + +### Server + +- Avoid indexing the project if `configurationPreference` is `editorOnly` ([#16381](https://github.com/astral-sh/ruff/pull/16381)) +- Avoid unnecessary info at non-trace server log level ([#16389](https://github.com/astral-sh/ruff/pull/16389)) +- Expand `ruff.configuration` to allow inline config ([#16296](https://github.com/astral-sh/ruff/pull/16296)) +- Notify users for invalid client settings ([#16361](https://github.com/astral-sh/ruff/pull/16361)) + +### Configuration + +- Add `per-file-target-version` option ([#16257](https://github.com/astral-sh/ruff/pull/16257)) + +### Bug fixes + +- \[`refurb`\] Do not consider docstring(s) (`FURB156`) ([#16391](https://github.com/astral-sh/ruff/pull/16391)) +- \[`flake8-self`\] Ignore attribute accesses on instance-like variables (`SLF001`) ([#16149](https://github.com/astral-sh/ruff/pull/16149)) +- \[`pylint`\] Fix false positives, add missing methods, and support positional-only parameters (`PLE0302`) ([#16263](https://github.com/astral-sh/ruff/pull/16263)) +- \[`flake8-pyi`\] Mark `PYI030` fix unsafe when comments are deleted ([#16322](https://github.com/astral-sh/ruff/pull/16322)) + +### Documentation + +- Fix example for `S611` ([#16316](https://github.com/astral-sh/ruff/pull/16316)) +- Normalize inconsistent markdown headings in docstrings ([#16364](https://github.com/astral-sh/ruff/pull/16364)) +- Document MSRV policy ([#16384](https://github.com/astral-sh/ruff/pull/16384)) + +## 0.9.7 + +### Preview features + +- Consider `__new__` methods as special function type for enforcing class method or static method rules ([#13305](https://github.com/astral-sh/ruff/pull/13305)) +- \[`airflow`\] Improve the internal logic to differentiate deprecated symbols (`AIR303`) ([#16013](https://github.com/astral-sh/ruff/pull/16013)) +- \[`refurb`\] Manual timezone monkeypatching (`FURB162`) ([#16113](https://github.com/astral-sh/ruff/pull/16113)) +- \[`ruff`\] Implicit class variable in dataclass (`RUF045`) ([#14349](https://github.com/astral-sh/ruff/pull/14349)) +- \[`ruff`\] Skip singleton starred expressions for `incorrectly-parenthesized-tuple-in-subscript` (`RUF031`) ([#16083](https://github.com/astral-sh/ruff/pull/16083)) +- \[`refurb`\] Check for subclasses includes subscript expressions (`FURB189`) ([#16155](https://github.com/astral-sh/ruff/pull/16155)) + +### Rule changes + +- \[`flake8-debugger`\] Also flag `sys.breakpointhook` and `sys.__breakpointhook__` (`T100`) ([#16191](https://github.com/astral-sh/ruff/pull/16191)) +- \[`pycodestyle`\] Exempt `site.addsitedir(...)` calls (`E402`) ([#16251](https://github.com/astral-sh/ruff/pull/16251)) + +### Formatter + +- Fix unstable formatting of trailing end-of-line comments of parenthesized attribute values ([#16187](https://github.com/astral-sh/ruff/pull/16187)) + +### Server + +- Fix handling of requests received after shutdown message ([#16262](https://github.com/astral-sh/ruff/pull/16262)) +- Ignore `source.organizeImports.ruff` and `source.fixAll.ruff` code actions for a notebook cell ([#16154](https://github.com/astral-sh/ruff/pull/16154)) +- Include document specific debug info for `ruff.printDebugInformation` ([#16215](https://github.com/astral-sh/ruff/pull/16215)) +- Update server to return the debug info as string with `ruff.printDebugInformation` ([#16214](https://github.com/astral-sh/ruff/pull/16214)) + +### CLI + +- Warn on invalid `noqa` even when there are no diagnostics ([#16178](https://github.com/astral-sh/ruff/pull/16178)) +- Better error messages while loading configuration `extend`s ([#15658](https://github.com/astral-sh/ruff/pull/15658)) + +### Bug fixes + +- \[`flake8-comprehensions`\] Handle trailing comma in `C403` fix ([#16110](https://github.com/astral-sh/ruff/pull/16110)) +- \[`flake8-pyi`\] Avoid flagging `custom-typevar-for-self` on metaclass methods (`PYI019`) ([#16141](https://github.com/astral-sh/ruff/pull/16141)) +- \[`pydocstyle`\] Handle arguments with the same names as sections (`D417`) ([#16011](https://github.com/astral-sh/ruff/pull/16011)) +- \[`pylint`\] Correct ordering of arguments in fix for `if-stmt-min-max` (`PLR1730`) ([#16080](https://github.com/astral-sh/ruff/pull/16080)) +- \[`pylint`\] Do not offer fix for raw strings (`PLE251`) ([#16132](https://github.com/astral-sh/ruff/pull/16132)) +- \[`pyupgrade`\] Do not upgrade functional `TypedDicts` with private field names to the class-based syntax (`UP013`) ([#16219](https://github.com/astral-sh/ruff/pull/16219)) +- \[`pyupgrade`\] Handle micro version numbers correctly (`UP036`) ([#16091](https://github.com/astral-sh/ruff/pull/16091)) +- \[`pyupgrade`\] Unwrap unary expressions correctly (`UP018`) ([#15919](https://github.com/astral-sh/ruff/pull/15919)) +- \[`refurb`\] Correctly handle lengths of literal strings in `slice-to-remove-prefix-or-suffix` (`FURB188`) ([#16237](https://github.com/astral-sh/ruff/pull/16237)) +- \[`ruff`\] Skip `RUF001` diagnostics when visiting string type definitions ([#16122](https://github.com/astral-sh/ruff/pull/16122)) + +### Documentation + +- Add FAQ entry for `source.*` code actions in Notebook ([#16212](https://github.com/astral-sh/ruff/pull/16212)) +- Add `SECURITY.md` ([#16224](https://github.com/astral-sh/ruff/pull/16224)) + +## 0.9.6 + +### Preview features + +- \[`airflow`\] Add `external_task.{ExternalTaskMarker, ExternalTaskSensor}` for `AIR302` ([#16014](https://github.com/astral-sh/ruff/pull/16014)) +- \[`flake8-builtins`\] Make strict module name comparison optional (`A005`) ([#15951](https://github.com/astral-sh/ruff/pull/15951)) +- \[`flake8-pyi`\] Extend fix to Python \<= 3.9 for `redundant-none-literal` (`PYI061`) ([#16044](https://github.com/astral-sh/ruff/pull/16044)) +- \[`pylint`\] Also report when the object isn't a literal (`PLE1310`) ([#15985](https://github.com/astral-sh/ruff/pull/15985)) +- \[`ruff`\] Implement `indented-form-feed` (`RUF054`) ([#16049](https://github.com/astral-sh/ruff/pull/16049)) +- \[`ruff`\] Skip type definitions for `missing-f-string-syntax` (`RUF027`) ([#16054](https://github.com/astral-sh/ruff/pull/16054)) + +### Rule changes + +- \[`flake8-annotations`\] Correct syntax for `typing.Union` in suggested return type fixes for `ANN20x` rules ([#16025](https://github.com/astral-sh/ruff/pull/16025)) +- \[`flake8-builtins`\] Match upstream module name comparison (`A005`) ([#16006](https://github.com/astral-sh/ruff/pull/16006)) +- \[`flake8-comprehensions`\] Detect overshadowed `list`/`set`/`dict`, ignore variadics and named expressions (`C417`) ([#15955](https://github.com/astral-sh/ruff/pull/15955)) +- \[`flake8-pie`\] Remove following comma correctly when the unpacked dictionary is empty (`PIE800`) ([#16008](https://github.com/astral-sh/ruff/pull/16008)) +- \[`flake8-simplify`\] Only trigger `SIM401` on known dictionaries ([#15995](https://github.com/astral-sh/ruff/pull/15995)) +- \[`pylint`\] Do not report calls when object type and argument type mismatch, remove custom escape handling logic (`PLE1310`) ([#15984](https://github.com/astral-sh/ruff/pull/15984)) +- \[`pyupgrade`\] Comments within parenthesized value ranges should not affect applicability (`UP040`) ([#16027](https://github.com/astral-sh/ruff/pull/16027)) +- \[`pyupgrade`\] Don't introduce invalid syntax when upgrading old-style type aliases with parenthesized multiline values (`UP040`) ([#16026](https://github.com/astral-sh/ruff/pull/16026)) +- \[`pyupgrade`\] Ensure we do not rename two type parameters to the same name (`UP049`) ([#16038](https://github.com/astral-sh/ruff/pull/16038)) +- \[`pyupgrade`\] \[`ruff`\] Don't apply renamings if the new name is shadowed in a scope of one of the references to the binding (`UP049`, `RUF052`) ([#16032](https://github.com/astral-sh/ruff/pull/16032)) +- \[`ruff`\] Update `RUF009` to behave similar to `B008` and ignore attributes with immutable types ([#16048](https://github.com/astral-sh/ruff/pull/16048)) + +### Server + +- Root exclusions in the server to project root ([#16043](https://github.com/astral-sh/ruff/pull/16043)) + +### Bug fixes + +- \[`flake8-datetime`\] Ignore `.replace()` calls while looking for `.astimezone` ([#16050](https://github.com/astral-sh/ruff/pull/16050)) +- \[`flake8-type-checking`\] Avoid `TC004` false positive where the runtime definition is provided by `__getattr__` ([#16052](https://github.com/astral-sh/ruff/pull/16052)) + +### Documentation + +- Improve `ruff-lsp` migration document ([#16072](https://github.com/astral-sh/ruff/pull/16072)) +- Undeprecate `ruff.nativeServer` ([#16039](https://github.com/astral-sh/ruff/pull/16039)) + +## 0.9.5 + +### Preview features + +- Recognize all symbols named `TYPE_CHECKING` for `in_type_checking_block` ([#15719](https://github.com/astral-sh/ruff/pull/15719)) +- \[`flake8-comprehensions`\] Handle builtins at top of file correctly for `unnecessary-dict-comprehension-for-iterable` (`C420`) ([#15837](https://github.com/astral-sh/ruff/pull/15837)) +- \[`flake8-logging`\] `.exception()` and `exc_info=` outside exception handlers (`LOG004`, `LOG014`) ([#15799](https://github.com/astral-sh/ruff/pull/15799)) +- \[`flake8-pyi`\] Fix incorrect behaviour of `custom-typevar-return-type` preview-mode autofix if `typing` was already imported (`PYI019`) ([#15853](https://github.com/astral-sh/ruff/pull/15853)) +- \[`flake8-pyi`\] Fix more complex cases (`PYI019`) ([#15821](https://github.com/astral-sh/ruff/pull/15821)) +- \[`flake8-pyi`\] Make `PYI019` autofixable for `.py` files in preview mode as well as stubs ([#15889](https://github.com/astral-sh/ruff/pull/15889)) +- \[`flake8-pyi`\] Remove type parameter correctly when it is the last (`PYI019`) ([#15854](https://github.com/astral-sh/ruff/pull/15854)) +- \[`pylint`\] Fix missing parens in unsafe fix for `unnecessary-dunder-call` (`PLC2801`) ([#15762](https://github.com/astral-sh/ruff/pull/15762)) +- \[`pyupgrade`\] Better messages and diagnostic range (`UP015`) ([#15872](https://github.com/astral-sh/ruff/pull/15872)) +- \[`pyupgrade`\] Rename private type parameters in PEP 695 generics (`UP049`) ([#15862](https://github.com/astral-sh/ruff/pull/15862)) +- \[`refurb`\] Also report non-name expressions (`FURB169`) ([#15905](https://github.com/astral-sh/ruff/pull/15905)) +- \[`refurb`\] Mark fix as unsafe if there are comments (`FURB171`) ([#15832](https://github.com/astral-sh/ruff/pull/15832)) +- \[`ruff`\] Classes with mixed type variable style (`RUF053`) ([#15841](https://github.com/astral-sh/ruff/pull/15841)) +- \[`airflow`\] `BashOperator` has been moved to `airflow.providers.standard.operators.bash.BashOperator` (`AIR302`) ([#15922](https://github.com/astral-sh/ruff/pull/15922)) +- \[`flake8-pyi`\] Add autofix for unused-private-type-var (`PYI018`) ([#15999](https://github.com/astral-sh/ruff/pull/15999)) +- \[`flake8-pyi`\] Significantly improve accuracy of `PYI019` if preview mode is enabled ([#15888](https://github.com/astral-sh/ruff/pull/15888)) + +### Rule changes + +- Preserve triple quotes and prefixes for strings ([#15818](https://github.com/astral-sh/ruff/pull/15818)) +- \[`flake8-comprehensions`\] Skip when `TypeError` present from too many (kw)args for `C410`,`C411`, and `C418` ([#15838](https://github.com/astral-sh/ruff/pull/15838)) +- \[`flake8-pyi`\] Rename `PYI019` and improve its diagnostic message ([#15885](https://github.com/astral-sh/ruff/pull/15885)) +- \[`pep8-naming`\] Ignore `@override` methods (`N803`) ([#15954](https://github.com/astral-sh/ruff/pull/15954)) +- \[`pyupgrade`\] Reuse replacement logic from `UP046` and `UP047` to preserve more comments (`UP040`) ([#15840](https://github.com/astral-sh/ruff/pull/15840)) +- \[`ruff`\] Analyze deferred annotations before enforcing `mutable-(data)class-default` and `function-call-in-dataclass-default-argument` (`RUF008`,`RUF009`,`RUF012`) ([#15921](https://github.com/astral-sh/ruff/pull/15921)) +- \[`pycodestyle`\] Exempt `sys.path += ...` calls (`E402`) ([#15980](https://github.com/astral-sh/ruff/pull/15980)) + +### Configuration + +- Config error only when `flake8-import-conventions` alias conflicts with `isort.required-imports` bound name ([#15918](https://github.com/astral-sh/ruff/pull/15918)) +- Workaround Even Better TOML crash related to `allOf` ([#15992](https://github.com/astral-sh/ruff/pull/15992)) + +### Bug fixes + +- \[`flake8-comprehensions`\] Unnecessary `list` comprehension (rewrite as a `set` comprehension) (`C403`) - Handle extraneous parentheses around list comprehension ([#15877](https://github.com/astral-sh/ruff/pull/15877)) +- \[`flake8-comprehensions`\] Handle trailing comma in fixes for `unnecessary-generator-list/set` (`C400`,`C401`) ([#15929](https://github.com/astral-sh/ruff/pull/15929)) +- \[`flake8-pyi`\] Fix several correctness issues with `custom-type-var-return-type` (`PYI019`) ([#15851](https://github.com/astral-sh/ruff/pull/15851)) +- \[`pep8-naming`\] Consider any number of leading underscore for `N801` ([#15988](https://github.com/astral-sh/ruff/pull/15988)) +- \[`pyflakes`\] Visit forward annotations in `TypeAliasType` as types (`F401`) ([#15829](https://github.com/astral-sh/ruff/pull/15829)) +- \[`pylint`\] Correct min/max auto-fix and suggestion for (`PL1730`) ([#15930](https://github.com/astral-sh/ruff/pull/15930)) +- \[`refurb`\] Handle unparenthesized tuples correctly (`FURB122`, `FURB142`) ([#15953](https://github.com/astral-sh/ruff/pull/15953)) +- \[`refurb`\] Avoid `None | None` as well as better detection and fix (`FURB168`) ([#15779](https://github.com/astral-sh/ruff/pull/15779)) + +### Documentation + +- Add deprecation warning for `ruff-lsp` related settings ([#15850](https://github.com/astral-sh/ruff/pull/15850)) +- Docs (`linter.md`): clarify that Python files are always searched for in subdirectories ([#15882](https://github.com/astral-sh/ruff/pull/15882)) +- Fix a typo in `non_pep695_generic_class.rs` ([#15946](https://github.com/astral-sh/ruff/pull/15946)) +- Improve Docs: Pylint subcategories' codes ([#15909](https://github.com/astral-sh/ruff/pull/15909)) +- Remove non-existing `lint.extendIgnore` editor setting ([#15844](https://github.com/astral-sh/ruff/pull/15844)) +- Update black deviations ([#15928](https://github.com/astral-sh/ruff/pull/15928)) +- Mention `UP049` in `UP046` and `UP047`, add `See also` section to `UP040` ([#15956](https://github.com/astral-sh/ruff/pull/15956)) +- Add instance variable examples to `RUF012` ([#15982](https://github.com/astral-sh/ruff/pull/15982)) +- Explain precedence for `ignore` and `select` config ([#15883](https://github.com/astral-sh/ruff/pull/15883)) + +## 0.9.4 + +### Preview features + +- \[`airflow`\] Extend airflow context parameter check for `BaseOperator.execute` (`AIR302`) ([#15713](https://github.com/astral-sh/ruff/pull/15713)) +- \[`airflow`\] Update `AIR302` to check for deprecated context keys ([#15144](https://github.com/astral-sh/ruff/pull/15144)) +- \[`flake8-bandit`\] Permit suspicious imports within stub files (`S4`) ([#15822](https://github.com/astral-sh/ruff/pull/15822)) +- \[`pylint`\] Do not trigger `PLR6201` on empty collections ([#15732](https://github.com/astral-sh/ruff/pull/15732)) +- \[`refurb`\] Do not emit diagnostic when loop variables are used outside loop body (`FURB122`) ([#15757](https://github.com/astral-sh/ruff/pull/15757)) +- \[`ruff`\] Add support for more `re` patterns (`RUF055`) ([#15764](https://github.com/astral-sh/ruff/pull/15764)) +- \[`ruff`\] Check for shadowed `map` before suggesting fix (`RUF058`) ([#15790](https://github.com/astral-sh/ruff/pull/15790)) +- \[`ruff`\] Do not emit diagnostic when all arguments to `zip()` are variadic (`RUF058`) ([#15744](https://github.com/astral-sh/ruff/pull/15744)) +- \[`ruff`\] Parenthesize fix when argument spans multiple lines for `unnecessary-round` (`RUF057`) ([#15703](https://github.com/astral-sh/ruff/pull/15703)) + +### Rule changes + +- Preserve quote style in generated code ([#15726](https://github.com/astral-sh/ruff/pull/15726), [#15778](https://github.com/astral-sh/ruff/pull/15778), [#15794](https://github.com/astral-sh/ruff/pull/15794)) +- \[`flake8-bugbear`\] Exempt `NewType` calls where the original type is immutable (`B008`) ([#15765](https://github.com/astral-sh/ruff/pull/15765)) +- \[`pylint`\] Honor banned top-level imports by `TID253` in `PLC0415`. ([#15628](https://github.com/astral-sh/ruff/pull/15628)) +- \[`pyupgrade`\] Ignore `is_typeddict` and `TypedDict` for `deprecated-import` (`UP035`) ([#15800](https://github.com/astral-sh/ruff/pull/15800)) + +### CLI + +- Fix formatter warning message for `flake8-quotes` option ([#15788](https://github.com/astral-sh/ruff/pull/15788)) +- Implement tab autocomplete for `ruff config` ([#15603](https://github.com/astral-sh/ruff/pull/15603)) + +### Bug fixes + +- \[`flake8-comprehensions`\] Do not emit `unnecessary-map` diagnostic when lambda has different arity (`C417`) ([#15802](https://github.com/astral-sh/ruff/pull/15802)) +- \[`flake8-comprehensions`\] Parenthesize `sorted` when needed for `unnecessary-call-around-sorted` (`C413`) ([#15825](https://github.com/astral-sh/ruff/pull/15825)) +- \[`pyupgrade`\] Handle end-of-line comments for `quoted-annotation` (`UP037`) ([#15824](https://github.com/astral-sh/ruff/pull/15824)) + +### Documentation + +- Add missing config docstrings ([#15803](https://github.com/astral-sh/ruff/pull/15803)) +- Add references to `trio.run_process` and `anyio.run_process` ([#15761](https://github.com/astral-sh/ruff/pull/15761)) +- Use `uv init --lib` in tutorial ([#15718](https://github.com/astral-sh/ruff/pull/15718)) + +## 0.9.3 + +### Preview features + +- \[`airflow`\] Argument `fail_stop` in DAG has been renamed as `fail_fast` (`AIR302`) ([#15633](https://github.com/astral-sh/ruff/pull/15633)) +- \[`airflow`\] Extend `AIR303` with more symbols ([#15611](https://github.com/astral-sh/ruff/pull/15611)) +- \[`flake8-bandit`\] Report all references to suspicious functions (`S3`) ([#15541](https://github.com/astral-sh/ruff/pull/15541)) +- \[`flake8-pytest-style`\] Do not emit diagnostics for empty `for` loops (`PT012`, `PT031`) ([#15542](https://github.com/astral-sh/ruff/pull/15542)) +- \[`flake8-simplify`\] Avoid double negations (`SIM103`) ([#15562](https://github.com/astral-sh/ruff/pull/15562)) +- \[`pyflakes`\] Fix infinite loop with unused local import in `__init__.py` (`F401`) ([#15517](https://github.com/astral-sh/ruff/pull/15517)) +- \[`pylint`\] Do not report methods with only one `EM101`-compatible `raise` (`PLR6301`) ([#15507](https://github.com/astral-sh/ruff/pull/15507)) +- \[`pylint`\] Implement `redefined-slots-in-subclass` (`W0244`) ([#9640](https://github.com/astral-sh/ruff/pull/9640)) +- \[`pyupgrade`\] Add rules to use PEP 695 generics in classes and functions (`UP046`, `UP047`) ([#15565](https://github.com/astral-sh/ruff/pull/15565), [#15659](https://github.com/astral-sh/ruff/pull/15659)) +- \[`refurb`\] Implement `for-loop-writes` (`FURB122`) ([#10630](https://github.com/astral-sh/ruff/pull/10630)) +- \[`ruff`\] Implement `needless-else` clause (`RUF047`) ([#15051](https://github.com/astral-sh/ruff/pull/15051)) +- \[`ruff`\] Implement `starmap-zip` (`RUF058`) ([#15483](https://github.com/astral-sh/ruff/pull/15483)) + +### Rule changes + +- \[`flake8-bugbear`\] Do not raise error if keyword argument is present and target-python version is less or equals than 3.9 (`B903`) ([#15549](https://github.com/astral-sh/ruff/pull/15549)) +- \[`flake8-comprehensions`\] strip parentheses around generators in `unnecessary-generator-set` (`C401`) ([#15553](https://github.com/astral-sh/ruff/pull/15553)) +- \[`flake8-pytest-style`\] Rewrite references to `.exception` (`PT027`) ([#15680](https://github.com/astral-sh/ruff/pull/15680)) +- \[`flake8-simplify`\] Mark fixes as unsafe (`SIM201`, `SIM202`) ([#15626](https://github.com/astral-sh/ruff/pull/15626)) +- \[`flake8-type-checking`\] Fix some safe fixes being labeled unsafe (`TC006`,`TC008`) ([#15638](https://github.com/astral-sh/ruff/pull/15638)) +- \[`isort`\] Omit trailing whitespace in `unsorted-imports` (`I001`) ([#15518](https://github.com/astral-sh/ruff/pull/15518)) +- \[`pydoclint`\] Allow ignoring one line docstrings for `DOC` rules ([#13302](https://github.com/astral-sh/ruff/pull/13302)) +- \[`pyflakes`\] Apply redefinition fixes by source code order (`F811`) ([#15575](https://github.com/astral-sh/ruff/pull/15575)) +- \[`pyflakes`\] Avoid removing too many imports in `redefined-while-unused` (`F811`) ([#15585](https://github.com/astral-sh/ruff/pull/15585)) +- \[`pyflakes`\] Group redefinition fixes by source statement (`F811`) ([#15574](https://github.com/astral-sh/ruff/pull/15574)) +- \[`pylint`\] Include name of base class in message for `redefined-slots-in-subclass` (`W0244`) ([#15559](https://github.com/astral-sh/ruff/pull/15559)) +- \[`ruff`\] Update fix for `RUF055` to use `var == value` ([#15605](https://github.com/astral-sh/ruff/pull/15605)) + +### Formatter + +- Fix bracket spacing for single-element tuples in f-string expressions ([#15537](https://github.com/astral-sh/ruff/pull/15537)) +- Fix unstable f-string formatting for expressions containing a trailing comma ([#15545](https://github.com/astral-sh/ruff/pull/15545)) + +### Performance + +- Avoid quadratic membership check in import fixes ([#15576](https://github.com/astral-sh/ruff/pull/15576)) + +### Server + +- Allow `unsafe-fixes` settings for code actions ([#15666](https://github.com/astral-sh/ruff/pull/15666)) + +### Bug fixes + +- \[`flake8-bandit`\] Add missing single-line/dotall regex flag (`S608`) ([#15654](https://github.com/astral-sh/ruff/pull/15654)) +- \[`flake8-import-conventions`\] Fix infinite loop between `ICN001` and `I002` (`ICN001`) ([#15480](https://github.com/astral-sh/ruff/pull/15480)) +- \[`flake8-simplify`\] Do not emit diagnostics for expressions inside string type annotations (`SIM222`, `SIM223`) ([#15405](https://github.com/astral-sh/ruff/pull/15405)) +- \[`pyflakes`\] Treat arguments passed to the `default=` parameter of `TypeVar` as type expressions (`F821`) ([#15679](https://github.com/astral-sh/ruff/pull/15679)) +- \[`pyupgrade`\] Avoid syntax error when the iterable is a non-parenthesized tuple (`UP028`) ([#15543](https://github.com/astral-sh/ruff/pull/15543)) +- \[`ruff`\] Exempt `NewType` calls where the original type is immutable (`RUF009`) ([#15588](https://github.com/astral-sh/ruff/pull/15588)) +- Preserve raw string prefix and escapes in all codegen fixes ([#15694](https://github.com/astral-sh/ruff/pull/15694)) + +### Documentation + +- Generate documentation redirects for lowercase rule codes ([#15564](https://github.com/astral-sh/ruff/pull/15564)) +- `TRY300`: Add some extra notes on not catching exceptions you didn't expect ([#15036](https://github.com/astral-sh/ruff/pull/15036)) + +## 0.9.2 + +### Preview features + +- \[`airflow`\] Fix typo "security_managr" to "security_manager" (`AIR303`) ([#15463](https://github.com/astral-sh/ruff/pull/15463)) +- \[`airflow`\] extend and fix AIR302 rules ([#15525](https://github.com/astral-sh/ruff/pull/15525)) +- \[`fastapi`\] Handle parameters with `Depends` correctly (`FAST003`) ([#15364](https://github.com/astral-sh/ruff/pull/15364)) +- \[`flake8-pytest-style`\] Implement pytest.warns diagnostics (`PT029`, `PT030`, `PT031`) ([#15444](https://github.com/astral-sh/ruff/pull/15444)) +- \[`flake8-pytest-style`\] Test function parameters with default arguments (`PT028`) ([#15449](https://github.com/astral-sh/ruff/pull/15449)) +- \[`flake8-type-checking`\] Avoid false positives for `|` in `TC008` ([#15201](https://github.com/astral-sh/ruff/pull/15201)) + +### Rule changes + +- \[`flake8-todos`\] Allow VSCode GitHub PR extension style links in `missing-todo-link` (`TD003`) ([#15519](https://github.com/astral-sh/ruff/pull/15519)) +- \[`pyflakes`\] Show syntax error message for `F722` ([#15523](https://github.com/astral-sh/ruff/pull/15523)) + +### Formatter + +- Fix curly bracket spacing around f-string expressions containing curly braces ([#15471](https://github.com/astral-sh/ruff/pull/15471)) +- Fix joining of f-strings with different quotes when using quote style `Preserve` ([#15524](https://github.com/astral-sh/ruff/pull/15524)) + +### Server + +- Avoid indexing the same workspace multiple times ([#15495](https://github.com/astral-sh/ruff/pull/15495)) +- Display context for `ruff.configuration` errors ([#15452](https://github.com/astral-sh/ruff/pull/15452)) + +### Configuration + +- Remove `flatten` to improve deserialization error messages ([#15414](https://github.com/astral-sh/ruff/pull/15414)) + +### Bug fixes + +- Parse triple-quoted string annotations as if parenthesized ([#15387](https://github.com/astral-sh/ruff/pull/15387)) +- \[`fastapi`\] Update `Annotated` fixes (`FAST002`) ([#15462](https://github.com/astral-sh/ruff/pull/15462)) +- \[`flake8-bandit`\] Check for `builtins` instead of `builtin` (`S102`, `PTH123`) ([#15443](https://github.com/astral-sh/ruff/pull/15443)) +- \[`flake8-pathlib`\] Fix `--select` for `os-path-dirname` (`PTH120`) ([#15446](https://github.com/astral-sh/ruff/pull/15446)) +- \[`ruff`\] Fix false positive on global keyword (`RUF052`) ([#15235](https://github.com/astral-sh/ruff/pull/15235)) + +## 0.9.1 + +### Preview features + +- \[`pycodestyle`\] Run `too-many-newlines-at-end-of-file` on each cell in notebooks (`W391`) ([#15308](https://github.com/astral-sh/ruff/pull/15308)) +- \[`ruff`\] Omit diagnostic for shadowed private function parameters in `used-dummy-variable` (`RUF052`) ([#15376](https://github.com/astral-sh/ruff/pull/15376)) + +### Rule changes + +- \[`flake8-bugbear`\] Improve `assert-raises-exception` message (`B017`) ([#15389](https://github.com/astral-sh/ruff/pull/15389)) + +### Formatter + +- Preserve trailing end-of line comments for the last string literal in implicitly concatenated strings ([#15378](https://github.com/astral-sh/ruff/pull/15378)) + +### Server + +- Fix a bug where the server and client notebooks were out of sync after reordering cells ([#15398](https://github.com/astral-sh/ruff/pull/15398)) + +### Bug fixes + +- \[`flake8-pie`\] Correctly remove wrapping parentheses (`PIE800`) ([#15394](https://github.com/astral-sh/ruff/pull/15394)) +- \[`pyupgrade`\] Handle comments and multiline expressions correctly (`UP037`) ([#15337](https://github.com/astral-sh/ruff/pull/15337)) + +## 0.9.0 + +Check out the [blog post](https://astral.sh/blog/ruff-v0.9.0) for a migration guide and overview of the changes! + +### Breaking changes + +Ruff now formats your code according to the 2025 style guide. As a result, your code might now get formatted differently. See the formatter section for a detailed list of changes. + +This release doesn’t remove or remap any existing stable rules. + +### Stabilization + +The following rules have been stabilized and are no longer in preview: + +- [`stdlib-module-shadowing`](https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/) (`A005`). + This rule has also been renamed: previously, it was called `builtin-module-shadowing`. +- [`builtin-lambda-argument-shadowing`](https://docs.astral.sh/ruff/rules/builtin-lambda-argument-shadowing/) (`A006`) +- [`slice-to-remove-prefix-or-suffix`](https://docs.astral.sh/ruff/rules/slice-to-remove-prefix-or-suffix/) (`FURB188`) +- [`boolean-chained-comparison`](https://docs.astral.sh/ruff/rules/boolean-chained-comparison/) (`PLR1716`) +- [`decimal-from-float-literal`](https://docs.astral.sh/ruff/rules/decimal-from-float-literal/) (`RUF032`) +- [`post-init-default`](https://docs.astral.sh/ruff/rules/post-init-default/) (`RUF033`) +- [`useless-if-else`](https://docs.astral.sh/ruff/rules/useless-if-else/) (`RUF034`) + +The following behaviors have been stabilized: + +- [`pytest-parametrize-names-wrong-type`](https://docs.astral.sh/ruff/rules/pytest-parametrize-names-wrong-type/) (`PT006`): Detect [`pytest.parametrize`](https://docs.pytest.org/en/7.1.x/how-to/parametrize.html#parametrize) calls outside decorators and calls with keyword arguments. +- [`module-import-not-at-top-of-file`](https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/) (`E402`): Ignore [`pytest.importorskip`](https://docs.pytest.org/en/7.1.x/reference/reference.html#pytest-importorskip) calls between import statements. +- [`mutable-dataclass-default`](https://docs.astral.sh/ruff/rules/mutable-dataclass-default/) (`RUF008`) and [`function-call-in-dataclass-default-argument`](https://docs.astral.sh/ruff/rules/function-call-in-dataclass-default-argument/) (`RUF009`): Add support for [`attrs`](https://www.attrs.org/en/stable/). +- [`bad-version-info-comparison`](https://docs.astral.sh/ruff/rules/bad-version-info-comparison/) (`PYI006`): Extend the rule to check non-stub files. + +The following fixes or improvements to fixes have been stabilized: + +- [`redundant-numeric-union`](https://docs.astral.sh/ruff/rules/redundant-numeric-union/) (`PYI041`) +- [`duplicate-union-members`](https://docs.astral.sh/ruff/rules/duplicate-union-member/) (`PYI016`) + +### Formatter + +This release introduces the new 2025 stable style ([#13371](https://github.com/astral-sh/ruff/issues/13371)), stabilizing the following changes: + +- Format expressions in f-string elements ([#7594](https://github.com/astral-sh/ruff/issues/7594)) +- Alternate quotes for strings inside f-strings ([#13860](https://github.com/astral-sh/ruff/pull/13860)) +- Preserve the casing of hex codes in f-string debug expressions ([#14766](https://github.com/astral-sh/ruff/issues/14766)) +- Choose the quote style for each string literal in an implicitly concatenated f-string rather than for the entire string ([#13539](https://github.com/astral-sh/ruff/pull/13539)) +- Automatically join an implicitly concatenated string into a single string literal if it fits on a single line ([#9457](https://github.com/astral-sh/ruff/issues/9457)) +- Remove the [`ISC001`](https://docs.astral.sh/ruff/rules/single-line-implicit-string-concatenation/) incompatibility warning ([#15123](https://github.com/astral-sh/ruff/pull/15123)) +- Prefer parenthesizing the `assert` message over breaking the assertion expression ([#9457](https://github.com/astral-sh/ruff/issues/9457)) +- Automatically parenthesize over-long `if` guards in `match` `case` clauses ([#13513](https://github.com/astral-sh/ruff/pull/13513)) +- More consistent formatting for `match` `case` patterns ([#6933](https://github.com/astral-sh/ruff/issues/6933)) +- Avoid unnecessary parentheses around return type annotations ([#13381](https://github.com/astral-sh/ruff/pull/13381)) +- Keep the opening parentheses on the same line as the `if` keyword for comprehensions where the condition has a leading comment ([#12282](https://github.com/astral-sh/ruff/pull/12282)) +- More consistent formatting for `with` statements with a single context manager for Python 3.8 or older ([#10276](https://github.com/astral-sh/ruff/pull/10276)) +- Correctly calculate the line-width for code blocks in docstrings when using `max-doc-code-line-length = "dynamic"` ([#13523](https://github.com/astral-sh/ruff/pull/13523)) + +### Preview features + +- \[`flake8-bugbear`\] Implement `class-as-data-structure` (`B903`) ([#9601](https://github.com/astral-sh/ruff/pull/9601)) +- \[`flake8-type-checking`\] Apply `quoted-type-alias` more eagerly in `TYPE_CHECKING` blocks and ignore it in stubs (`TC008`) ([#15180](https://github.com/astral-sh/ruff/pull/15180)) +- \[`pylint`\] Ignore `eq-without-hash` in stub files (`PLW1641`) ([#15310](https://github.com/astral-sh/ruff/pull/15310)) +- \[`pyupgrade`\] Split `UP007` into two individual rules: `UP007` for `Union` and `UP045` for `Optional` (`UP007`, `UP045`) ([#15313](https://github.com/astral-sh/ruff/pull/15313)) +- \[`ruff`\] New rule that detects classes that are both an enum and a `dataclass` (`RUF049`) ([#15299](https://github.com/astral-sh/ruff/pull/15299)) +- \[`ruff`\] Recode `RUF025` to `RUF037` (`RUF037`) ([#15258](https://github.com/astral-sh/ruff/pull/15258)) + +### Rule changes + +- \[`flake8-builtins`\] Ignore [`stdlib-module-shadowing`](https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/) in stub files(`A005`) ([#15350](https://github.com/astral-sh/ruff/pull/15350)) +- \[`flake8-return`\] Add support for functions returning `typing.Never` (`RET503`) ([#15298](https://github.com/astral-sh/ruff/pull/15298)) + +### Server + +- Improve the observability by removing the need for the ["trace" value](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#traceValue) to turn on or off logging. The server logging is solely controlled using the [`logLevel` server setting](https://docs.astral.sh/ruff/editors/settings/#loglevel) + which defaults to `info`. This addresses the issue where users were notified about an error and told to consult the log, but it didn’t contain any messages. ([#15232](https://github.com/astral-sh/ruff/pull/15232)) +- Ignore diagnostics from other sources for code action requests ([#15373](https://github.com/astral-sh/ruff/pull/15373)) + +### CLI + +- Improve the error message for `--config key=value` when the `key` is for a table and it’s a simple `value` + +### Bug fixes + +- \[`eradicate`\] Ignore metadata blocks directly followed by normal blocks (`ERA001`) ([#15330](https://github.com/astral-sh/ruff/pull/15330)) +- \[`flake8-django`\] Recognize other magic methods (`DJ012`) ([#15365](https://github.com/astral-sh/ruff/pull/15365)) +- \[`pycodestyle`\] Avoid false positives related to type aliases (`E252`) ([#15356](https://github.com/astral-sh/ruff/pull/15356)) +- \[`pydocstyle`\] Avoid treating newline-separated sections as sub-sections (`D405`) ([#15311](https://github.com/astral-sh/ruff/pull/15311)) +- \[`pyflakes`\] Remove call when removing final argument from `format` (`F523`) ([#15309](https://github.com/astral-sh/ruff/pull/15309)) +- \[`refurb`\] Mark fix as unsafe when the right-hand side is a string (`FURB171`) ([#15273](https://github.com/astral-sh/ruff/pull/15273)) +- \[`ruff`\] Treat `)` as a regex metacharacter (`RUF043`, `RUF055`) ([#15318](https://github.com/astral-sh/ruff/pull/15318)) +- \[`ruff`\] Parenthesize the `int`-call argument when removing the `int` call would change semantics (`RUF046`) ([#15277](https://github.com/astral-sh/ruff/pull/15277)) + +## 0.8.6 + +### Preview features + +- \[`format`\]: Preserve multiline implicit concatenated strings in docstring positions ([#15126](https://github.com/astral-sh/ruff/pull/15126)) +- \[`ruff`\] Add rule to detect empty literal in deque call (`RUF025`) ([#15104](https://github.com/astral-sh/ruff/pull/15104)) +- \[`ruff`\] Avoid reporting when `ndigits` is possibly negative (`RUF057`) ([#15234](https://github.com/astral-sh/ruff/pull/15234)) + +### Rule changes + +- \[`flake8-todos`\] remove issue code length restriction (`TD003`) ([#15175](https://github.com/astral-sh/ruff/pull/15175)) +- \[`pyflakes`\] Ignore errors in `@no_type_check` string annotations (`F722`, `F821`) ([#15215](https://github.com/astral-sh/ruff/pull/15215)) + +### CLI + +- Show errors for attempted fixes only when passed `--verbose` ([#15237](https://github.com/astral-sh/ruff/pull/15237)) + +### Bug fixes + +- \[`ruff`\] Avoid syntax error when removing int over multiple lines (`RUF046`) ([#15230](https://github.com/astral-sh/ruff/pull/15230)) +- \[`pyupgrade`\] Revert "Add all PEP-585 names to `UP006` rule" ([#15250](https://github.com/astral-sh/ruff/pull/15250)) + +## 0.8.5 + +### Preview features + +- \[`airflow`\] Extend names moved from core to provider (`AIR303`) ([#15145](https://github.com/astral-sh/ruff/pull/15145), [#15159](https://github.com/astral-sh/ruff/pull/15159), [#15196](https://github.com/astral-sh/ruff/pull/15196), [#15216](https://github.com/astral-sh/ruff/pull/15216)) +- \[`airflow`\] Extend rule to check class attributes, methods, arguments (`AIR302`) ([#15054](https://github.com/astral-sh/ruff/pull/15054), [#15083](https://github.com/astral-sh/ruff/pull/15083)) +- \[`fastapi`\] Update `FAST002` to check keyword-only arguments ([#15119](https://github.com/astral-sh/ruff/pull/15119)) +- \[`flake8-type-checking`\] Disable `TC006` and `TC007` in stub files ([#15179](https://github.com/astral-sh/ruff/pull/15179)) +- \[`pylint`\] Detect nested methods correctly (`PLW1641`) ([#15032](https://github.com/astral-sh/ruff/pull/15032)) +- \[`ruff`\] Detect more strict-integer expressions (`RUF046`) ([#14833](https://github.com/astral-sh/ruff/pull/14833)) +- \[`ruff`\] Implement `falsy-dict-get-fallback` (`RUF056`) ([#15160](https://github.com/astral-sh/ruff/pull/15160)) +- \[`ruff`\] Implement `unnecessary-round` (`RUF057`) ([#14828](https://github.com/astral-sh/ruff/pull/14828)) + +### Rule changes + +- Visit PEP 764 inline `TypedDict` keys as non-type-expressions ([#15073](https://github.com/astral-sh/ruff/pull/15073)) +- \[`flake8-comprehensions`\] Skip `C416` if comprehension contains unpacking ([#14909](https://github.com/astral-sh/ruff/pull/14909)) +- \[`flake8-pie`\] Allow `cast(SomeType, ...)` (`PIE796`) ([#15141](https://github.com/astral-sh/ruff/pull/15141)) +- \[`flake8-simplify`\] More precise inference for dictionaries (`SIM300`) ([#15164](https://github.com/astral-sh/ruff/pull/15164)) +- \[`flake8-use-pathlib`\] Catch redundant joins in `PTH201` and avoid syntax errors ([#15177](https://github.com/astral-sh/ruff/pull/15177)) +- \[`pycodestyle`\] Preserve original value format (`E731`) ([#15097](https://github.com/astral-sh/ruff/pull/15097)) +- \[`pydocstyle`\] Split on first whitespace character (`D403`) ([#15082](https://github.com/astral-sh/ruff/pull/15082)) +- \[`pyupgrade`\] Add all PEP-585 names to `UP006` rule ([#5454](https://github.com/astral-sh/ruff/pull/5454)) + +### Configuration + +- \[`flake8-type-checking`\] Improve flexibility of `runtime-evaluated-decorators` ([#15204](https://github.com/astral-sh/ruff/pull/15204)) +- \[`pydocstyle`\] Add setting to ignore missing documentation for `*args` and `**kwargs` parameters (`D417`) ([#15210](https://github.com/astral-sh/ruff/pull/15210)) +- \[`ruff`\] Add an allowlist for `unsafe-markup-use` (`RUF035`) ([#15076](https://github.com/astral-sh/ruff/pull/15076)) + +### Bug fixes + +- Fix type subscript on older python versions ([#15090](https://github.com/astral-sh/ruff/pull/15090)) +- Use `TypeChecker` for detecting `fastapi` routes ([#15093](https://github.com/astral-sh/ruff/pull/15093)) +- \[`pycodestyle`\] Avoid false positives and negatives related to type parameter default syntax (`E225`, `E251`) ([#15214](https://github.com/astral-sh/ruff/pull/15214)) + +### Documentation + +- Fix incorrect doc in `shebang-not-executable` (`EXE001`) and add git+windows solution to executable bit ([#15208](https://github.com/astral-sh/ruff/pull/15208)) +- Rename rules currently not conforming to naming convention ([#15102](https://github.com/astral-sh/ruff/pull/15102)) + +## 0.8.4 + +### Preview features + +- \[`airflow`\] Extend `AIR302` with additional functions and classes ([#15015](https://github.com/astral-sh/ruff/pull/15015)) +- \[`airflow`\] Implement `moved-to-provider-in-3` for modules that has been moved to Airflow providers (`AIR303`) ([#14764](https://github.com/astral-sh/ruff/pull/14764)) +- \[`flake8-use-pathlib`\] Extend check for invalid path suffix to include the case `"."` (`PTH210`) ([#14902](https://github.com/astral-sh/ruff/pull/14902)) +- \[`perflint`\] Fix panic in `PERF401` when list variable is after the `for` loop ([#14971](https://github.com/astral-sh/ruff/pull/14971)) +- \[`perflint`\] Simplify finding the loop target in `PERF401` ([#15025](https://github.com/astral-sh/ruff/pull/15025)) +- \[`pylint`\] Preserve original value format (`PLR6104`) ([#14978](https://github.com/astral-sh/ruff/pull/14978)) +- \[`ruff`\] Avoid false positives for `RUF027` for typing context bindings ([#15037](https://github.com/astral-sh/ruff/pull/15037)) +- \[`ruff`\] Check for ambiguous pattern passed to `pytest.raises()` (`RUF043`) ([#14966](https://github.com/astral-sh/ruff/pull/14966)) + +### Rule changes + +- \[`flake8-bandit`\] Check `S105` for annotated assignment ([#15059](https://github.com/astral-sh/ruff/pull/15059)) +- \[`flake8-pyi`\] More autofixes for `redundant-none-literal` (`PYI061`) ([#14872](https://github.com/astral-sh/ruff/pull/14872)) +- \[`pydocstyle`\] Skip leading whitespace for `D403` ([#14963](https://github.com/astral-sh/ruff/pull/14963)) +- \[`ruff`\] Skip `SQLModel` base classes for `mutable-class-default` (`RUF012`) ([#14949](https://github.com/astral-sh/ruff/pull/14949)) + +### Bug + +- \[`perflint`\] Parenthesize walrus expressions in autofix for `manual-list-comprehension` (`PERF401`) ([#15050](https://github.com/astral-sh/ruff/pull/15050)) + +### Server + +- Check diagnostic refresh support from client capability which enables dynamic configuration for various editors ([#15014](https://github.com/astral-sh/ruff/pull/15014)) + +## 0.8.3 + +### Preview features + +- Fix fstring formatting removing overlong implicit concatenated string in expression part ([#14811](https://github.com/astral-sh/ruff/pull/14811)) +- \[`airflow`\] Add fix to remove deprecated keyword arguments (`AIR302`) ([#14887](https://github.com/astral-sh/ruff/pull/14887)) +- \[`airflow`\]: Extend rule to include deprecated names for Airflow 3.0 (`AIR302`) ([#14765](https://github.com/astral-sh/ruff/pull/14765) and [#14804](https://github.com/astral-sh/ruff/pull/14804)) +- \[`flake8-bugbear`\] Improve error messages for `except*` (`B025`, `B029`, `B030`, `B904`) ([#14815](https://github.com/astral-sh/ruff/pull/14815)) +- \[`flake8-bugbear`\] `itertools.batched()` without explicit `strict` (`B911`) ([#14408](https://github.com/astral-sh/ruff/pull/14408)) +- \[`flake8-use-pathlib`\] Dotless suffix passed to `Path.with_suffix()` (`PTH210`) ([#14779](https://github.com/astral-sh/ruff/pull/14779)) +- \[`pylint`\] Include parentheses and multiple comparators in check for `boolean-chained-comparison` (`PLR1716`) ([#14781](https://github.com/astral-sh/ruff/pull/14781)) +- \[`ruff`\] Do not simplify `round()` calls (`RUF046`) ([#14832](https://github.com/astral-sh/ruff/pull/14832)) +- \[`ruff`\] Don't emit `used-dummy-variable` on function parameters (`RUF052`) ([#14818](https://github.com/astral-sh/ruff/pull/14818)) +- \[`ruff`\] Implement `if-key-in-dict-del` (`RUF051`) ([#14553](https://github.com/astral-sh/ruff/pull/14553)) +- \[`ruff`\] Mark autofix for `RUF052` as always unsafe ([#14824](https://github.com/astral-sh/ruff/pull/14824)) +- \[`ruff`\] Teach autofix for `used-dummy-variable` about TypeVars etc. (`RUF052`) ([#14819](https://github.com/astral-sh/ruff/pull/14819)) + +### Rule changes + +- \[`flake8-bugbear`\] Offer unsafe autofix for `no-explicit-stacklevel` (`B028`) ([#14829](https://github.com/astral-sh/ruff/pull/14829)) +- \[`flake8-pyi`\] Skip all type definitions in `string-or-bytes-too-long` (`PYI053`) ([#14797](https://github.com/astral-sh/ruff/pull/14797)) +- \[`pyupgrade`\] Do not report when a UTF-8 comment is followed by a non-UTF-8 one (`UP009`) ([#14728](https://github.com/astral-sh/ruff/pull/14728)) +- \[`pyupgrade`\] Mark fixes for `convert-typed-dict-functional-to-class` and `convert-named-tuple-functional-to-class` as unsafe if they will remove comments (`UP013`, `UP014`) ([#14842](https://github.com/astral-sh/ruff/pull/14842)) + +### Bug fixes + +- Raise syntax error for mixing `except` and `except*` ([#14895](https://github.com/astral-sh/ruff/pull/14895)) +- \[`flake8-bugbear`\] Fix `B028` to allow `stacklevel` to be explicitly assigned as a positional argument ([#14868](https://github.com/astral-sh/ruff/pull/14868)) +- \[`flake8-bugbear`\] Skip `B028` if `warnings.warn` is called with `*args` or `**kwargs` ([#14870](https://github.com/astral-sh/ruff/pull/14870)) +- \[`flake8-comprehensions`\] Skip iterables with named expressions in `unnecessary-map` (`C417`) ([#14827](https://github.com/astral-sh/ruff/pull/14827)) +- \[`flake8-pyi`\] Also remove `self` and `cls`'s annotation (`PYI034`) ([#14801](https://github.com/astral-sh/ruff/pull/14801)) +- \[`flake8-pytest-style`\] Fix `pytest-parametrize-names-wrong-type` (`PT006`) to edit both `argnames` and `argvalues` if both of them are single-element tuples/lists ([#14699](https://github.com/astral-sh/ruff/pull/14699)) +- \[`perflint`\] Improve autofix for `PERF401` ([#14369](https://github.com/astral-sh/ruff/pull/14369)) +- \[`pylint`\] Fix `PLW1508` false positive for default string created via a mult operation ([#14841](https://github.com/astral-sh/ruff/pull/14841)) + +## 0.8.2 + +### Preview features + +- \[`airflow`\] Avoid deprecated values (`AIR302`) ([#14582](https://github.com/astral-sh/ruff/pull/14582)) +- \[`airflow`\] Extend removed names for `AIR302` ([#14734](https://github.com/astral-sh/ruff/pull/14734)) +- \[`ruff`\] Extend `unnecessary-regular-expression` to non-literal strings (`RUF055`) ([#14679](https://github.com/astral-sh/ruff/pull/14679)) +- \[`ruff`\] Implement `used-dummy-variable` (`RUF052`) ([#14611](https://github.com/astral-sh/ruff/pull/14611)) +- \[`ruff`\] Implement `unnecessary-cast-to-int` (`RUF046`) ([#14697](https://github.com/astral-sh/ruff/pull/14697)) + +### Rule changes + +- \[`airflow`\] Check `AIR001` from builtin or providers `operators` module ([#14631](https://github.com/astral-sh/ruff/pull/14631)) +- \[`flake8-pytest-style`\] Remove `@` in `pytest.mark.parametrize` rule messages ([#14770](https://github.com/astral-sh/ruff/pull/14770)) +- \[`pandas-vet`\] Skip rules if the `panda` module hasn't been seen ([#14671](https://github.com/astral-sh/ruff/pull/14671)) +- \[`pylint`\] Fix false negatives for `ascii` and `sorted` in `len-as-condition` (`PLC1802`) ([#14692](https://github.com/astral-sh/ruff/pull/14692)) +- \[`refurb`\] Guard `hashlib` imports and mark `hashlib-digest-hex` fix as safe (`FURB181`) ([#14694](https://github.com/astral-sh/ruff/pull/14694)) + +### Configuration + +- \[`flake8-import-conventions`\] Improve syntax check for aliases supplied in configuration for `unconventional-import-alias` (`ICN001`) ([#14745](https://github.com/astral-sh/ruff/pull/14745)) + +### Bug fixes + +- Revert: [pyflakes] Avoid false positives in `@no_type_check` contexts (`F821`, `F722`) (#14615) ([#14726](https://github.com/astral-sh/ruff/pull/14726)) +- \[`pep8-naming`\] Avoid false positive for `class Bar(type(foo))` (`N804`) ([#14683](https://github.com/astral-sh/ruff/pull/14683)) +- \[`pycodestyle`\] Handle f-strings properly for `invalid-escape-sequence` (`W605`) ([#14748](https://github.com/astral-sh/ruff/pull/14748)) +- \[`pylint`\] Ignore `@overload` in `PLR0904` ([#14730](https://github.com/astral-sh/ruff/pull/14730)) +- \[`refurb`\] Handle non-finite decimals in `verbose-decimal-constructor` (`FURB157`) ([#14596](https://github.com/astral-sh/ruff/pull/14596)) +- \[`ruff`\] Avoid emitting `assignment-in-assert` when all references to the assigned variable are themselves inside `assert`s (`RUF018`) ([#14661](https://github.com/astral-sh/ruff/pull/14661)) + +### Documentation + +- Improve docs for `flake8-use-pathlib` rules ([#14741](https://github.com/astral-sh/ruff/pull/14741)) +- Improve error messages and docs for `flake8-comprehensions` rules ([#14729](https://github.com/astral-sh/ruff/pull/14729)) +- \[`flake8-type-checking`\] Expands `TC006` docs to better explain itself ([#14749](https://github.com/astral-sh/ruff/pull/14749)) + +## 0.8.1 + +### Preview features + +- Formatter: Avoid invalid syntax for format-spec with quotes for all Python versions ([#14625](https://github.com/astral-sh/ruff/pull/14625)) +- Formatter: Consider quotes inside format-specs when choosing the quotes for an f-string ([#14493](https://github.com/astral-sh/ruff/pull/14493)) +- Formatter: Do not consider f-strings with escaped newlines as multiline ([#14624](https://github.com/astral-sh/ruff/pull/14624)) +- Formatter: Fix f-string formatting in assignment statement ([#14454](https://github.com/astral-sh/ruff/pull/14454)) +- Formatter: Fix unnecessary space around power operator (`**`) in overlong f-string expressions ([#14489](https://github.com/astral-sh/ruff/pull/14489)) +- \[`airflow`\] Avoid implicit `schedule` argument to `DAG` and `@dag` (`AIR301`) ([#14581](https://github.com/astral-sh/ruff/pull/14581)) +- \[`flake8-builtins`\] Exempt private built-in modules (`A005`) ([#14505](https://github.com/astral-sh/ruff/pull/14505)) +- \[`flake8-pytest-style`\] Fix `pytest.mark.parametrize` rules to check calls instead of decorators ([#14515](https://github.com/astral-sh/ruff/pull/14515)) +- \[`flake8-type-checking`\] Implement `runtime-cast-value` (`TC006`) ([#14511](https://github.com/astral-sh/ruff/pull/14511)) +- \[`flake8-type-checking`\] Implement `unquoted-type-alias` (`TC007`) and `quoted-type-alias` (`TC008`) ([#12927](https://github.com/astral-sh/ruff/pull/12927)) +- \[`flake8-use-pathlib`\] Recommend `Path.iterdir()` over `os.listdir()` (`PTH208`) ([#14509](https://github.com/astral-sh/ruff/pull/14509)) +- \[`pylint`\] Extend `invalid-envvar-default` to detect `os.environ.get` (`PLW1508`) ([#14512](https://github.com/astral-sh/ruff/pull/14512)) +- \[`pylint`\] Implement `len-test` (`PLC1802`) ([#14309](https://github.com/astral-sh/ruff/pull/14309)) +- \[`refurb`\] Fix bug where methods defined using lambdas were flagged by `FURB118` ([#14639](https://github.com/astral-sh/ruff/pull/14639)) +- \[`ruff`\] Auto-add `r` prefix when string has no backslashes for `unraw-re-pattern` (`RUF039`) ([#14536](https://github.com/astral-sh/ruff/pull/14536)) +- \[`ruff`\] Implement `invalid-assert-message-literal-argument` (`RUF040`) ([#14488](https://github.com/astral-sh/ruff/pull/14488)) +- \[`ruff`\] Implement `unnecessary-nested-literal` (`RUF041`) ([#14323](https://github.com/astral-sh/ruff/pull/14323)) +- \[`ruff`\] Implement `unnecessary-regular-expression` (`RUF055`) ([#14659](https://github.com/astral-sh/ruff/pull/14659)) + +### Rule changes + +- Ignore more rules for stub files ([#14541](https://github.com/astral-sh/ruff/pull/14541)) +- \[`pep8-naming`\] Eliminate false positives for single-letter names (`N811`, `N814`) ([#14584](https://github.com/astral-sh/ruff/pull/14584)) +- \[`pyflakes`\] Avoid false positives in `@no_type_check` contexts (`F821`, `F722`) ([#14615](https://github.com/astral-sh/ruff/pull/14615)) +- \[`ruff`\] Detect redirected-noqa in file-level comments (`RUF101`) ([#14635](https://github.com/astral-sh/ruff/pull/14635)) +- \[`ruff`\] Mark fixes for `unsorted-dunder-all` and `unsorted-dunder-slots` as unsafe when there are complex comments in the sequence (`RUF022`, `RUF023`) ([#14560](https://github.com/astral-sh/ruff/pull/14560)) + +### Bug fixes + +- Avoid fixing code to `None | None` for `redundant-none-literal` (`PYI061`) and `never-union` (`RUF020`) ([#14583](https://github.com/astral-sh/ruff/pull/14583), [#14589](https://github.com/astral-sh/ruff/pull/14589)) +- \[`flake8-bugbear`\] Fix `mutable-contextvar-default` to resolve annotated function calls properly (`B039`) ([#14532](https://github.com/astral-sh/ruff/pull/14532)) +- \[`flake8-pyi`, `ruff`\] Fix traversal of nested literals and unions (`PYI016`, `PYI051`, `PYI055`, `PYI062`, `RUF041`) ([#14641](https://github.com/astral-sh/ruff/pull/14641)) +- \[`flake8-pyi`\] Avoid rewriting invalid type expressions in `unnecessary-type-union` (`PYI055`) ([#14660](https://github.com/astral-sh/ruff/pull/14660)) +- \[`flake8-type-checking`\] Avoid syntax errors and type checking problem for quoted annotations autofix (`TC003`, `TC006`) ([#14634](https://github.com/astral-sh/ruff/pull/14634)) +- \[`pylint`\] Do not wrap function calls in parentheses in the fix for unnecessary-dunder-call (`PLC2801`) ([#14601](https://github.com/astral-sh/ruff/pull/14601)) +- \[`ruff`\] Handle `attrs`'s `auto_attribs` correctly (`RUF009`) ([#14520](https://github.com/astral-sh/ruff/pull/14520)) + +## 0.8.0 + +Check out the [blog post](https://astral.sh/blog/ruff-v0.8.0) for a migration guide and overview of the changes! + +### Breaking changes + +See also, the "Remapped rules" section which may result in disabled rules. + +- **Default to Python 3.9** + + Ruff now defaults to Python 3.9 instead of 3.8 if no explicit Python version is configured using [`ruff.target-version`](https://docs.astral.sh/ruff/settings/#target-version) or [`project.requires-python`](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#python-requires) ([#13896](https://github.com/astral-sh/ruff/pull/13896)) + +- **Changed location of `pydoclint` diagnostics** + + [`pydoclint`](https://docs.astral.sh/ruff/rules/#pydoclint-doc) diagnostics now point to the first-line of the problematic docstring. Previously, this was not the case. + + If you've opted into these preview rules but have them suppressed using + [`noqa`](https://docs.astral.sh/ruff/linter/#error-suppression) comments in + some places, this change may mean that you need to move the `noqa` suppression + comments. Most users should be unaffected by this change. + +- **Use XDG (i.e. `~/.local/bin`) instead of the Cargo home directory in the standalone installer** + + Previously, Ruff's installer used `$CARGO_HOME` or `~/.cargo/bin` for its target install directory. Now, Ruff will be installed into `$XDG_BIN_HOME`, `$XDG_DATA_HOME/../bin`, or `~/.local/bin` (in that order). + + This change is only relevant to users of the standalone Ruff installer (using the shell or PowerShell script). If you installed Ruff using uv or pip, you should be unaffected. + +- **Changes to the line width calculation** + + Ruff now uses a new version of the [unicode-width](https://github.com/unicode-rs/unicode-width) Rust crate to calculate the line width. In very rare cases, this may lead to lines containing Unicode characters being reformatted, or being considered too long when they were not before ([`E501`](https://docs.astral.sh/ruff/rules/line-too-long/)). + +### Removed Rules + +The following deprecated rules have been removed: + +- [`missing-type-self`](https://docs.astral.sh/ruff/rules/missing-type-self/) (`ANN101`) +- [`missing-type-cls`](https://docs.astral.sh/ruff/rules/missing-type-cls/) (`ANN102`) +- [`syntax-error`](https://docs.astral.sh/ruff/rules/syntax-error/) (`E999`) +- [`pytest-missing-fixture-name-underscore`](https://docs.astral.sh/ruff/rules/pytest-missing-fixture-name-underscore/) (`PT004`) +- [`pytest-incorrect-fixture-name-underscore`](https://docs.astral.sh/ruff/rules/pytest-incorrect-fixture-name-underscore/) (`PT005`) +- [`unpacked-list-comprehension`](https://docs.astral.sh/ruff/rules/unpacked-list-comprehension/) (`UP027`) + +### Remapped rules + +The following rules have been remapped to new rule codes: + +- [`flake8-type-checking`](https://docs.astral.sh/ruff/rules/#flake8-type-checking-tc): `TCH` to `TC` + +### Stabilization + +The following rules have been stabilized and are no longer in preview: + +- [`builtin-import-shadowing`](https://docs.astral.sh/ruff/rules/builtin-import-shadowing/) (`A004`) +- [`mutable-contextvar-default`](https://docs.astral.sh/ruff/rules/mutable-contextvar-default/) (`B039`) +- [`fast-api-redundant-response-model`](https://docs.astral.sh/ruff/rules/fast-api-redundant-response-model/) (`FAST001`) +- [`fast-api-non-annotated-dependency`](https://docs.astral.sh/ruff/rules/fast-api-non-annotated-dependency/) (`FAST002`) +- [`dict-index-missing-items`](https://docs.astral.sh/ruff/rules/dict-index-missing-items/) (`PLC0206`) +- [`pep484-style-positional-only-parameter`](https://docs.astral.sh/ruff/rules/pep484-style-positional-only-parameter/) (`PYI063`) +- [`redundant-final-literal`](https://docs.astral.sh/ruff/rules/redundant-final-literal/) (`PYI064`) +- [`bad-version-info-order`](https://docs.astral.sh/ruff/rules/bad-version-info-order/) (`PYI066`) +- [`parenthesize-chained-operators`](https://docs.astral.sh/ruff/rules/parenthesize-chained-operators/) (`RUF021`) +- [`unsorted-dunder-all`](https://docs.astral.sh/ruff/rules/unsorted-dunder-all/) (`RUF022`) +- [`unsorted-dunder-slots`](https://docs.astral.sh/ruff/rules/unsorted-dunder-slots/) (`RUF023`) +- [`assert-with-print-message`](https://docs.astral.sh/ruff/rules/assert-with-print-message/) (`RUF030`) +- [`unnecessary-default-type-args`](https://docs.astral.sh/ruff/rules/unnecessary-default-type-args/) (`UP043`) + +The following behaviors have been stabilized: + +- [`ambiguous-variable-name`](https://docs.astral.sh/ruff/rules/ambiguous-variable-name/) (`E741`): Violations in stub files are now ignored. Stub authors typically don't control variable names. +- [`printf-string-formatting`](https://docs.astral.sh/ruff/rules/printf-string-formatting/) (`UP031`): Report all `printf`-like usages even if no autofix is available + +The following fixes have been stabilized: + +- [`zip-instead-of-pairwise`](https://docs.astral.sh/ruff/rules/zip-instead-of-pairwise/) (`RUF007`) + +### Preview features + +- \[`flake8-datetimez`\] Exempt `min.time()` and `max.time()` (`DTZ901`) ([#14394](https://github.com/astral-sh/ruff/pull/14394)) +- \[`flake8-pie`\] Mark fix as unsafe if the following statement is a string literal (`PIE790`) ([#14393](https://github.com/astral-sh/ruff/pull/14393)) +- \[`flake8-pyi`\] New rule `redundant-none-literal` (`PYI061`) ([#14316](https://github.com/astral-sh/ruff/pull/14316)) +- \[`flake8-pyi`\] Add autofix for `redundant-numeric-union` (`PYI041`) ([#14273](https://github.com/astral-sh/ruff/pull/14273)) +- \[`ruff`\] New rule `map-int-version-parsing` (`RUF048`) ([#14373](https://github.com/astral-sh/ruff/pull/14373)) +- \[`ruff`\] New rule `redundant-bool-literal` (`RUF038`) ([#14319](https://github.com/astral-sh/ruff/pull/14319)) +- \[`ruff`\] New rule `unraw-re-pattern` (`RUF039`) ([#14446](https://github.com/astral-sh/ruff/pull/14446)) +- \[`pycodestyle`\] Exempt `pytest.importorskip()` calls (`E402`) ([#14474](https://github.com/astral-sh/ruff/pull/14474)) +- \[`pylint`\] Autofix suggests using sets when possible (`PLR1714`) ([#14372](https://github.com/astral-sh/ruff/pull/14372)) + +### Rule changes + +- [`invalid-pyproject-toml`](https://docs.astral.sh/ruff/rules/invalid-pyproject-toml/) (`RUF200`): Updated to reflect the provisionally accepted [PEP 639](https://peps.python.org/pep-0639/). +- \[`flake8-pyi`\] Avoid panic in unfixable case (`PYI041`) ([#14402](https://github.com/astral-sh/ruff/pull/14402)) +- \[`flake8-type-checking`\] Correctly handle quotes in subscript expression when generating an autofix ([#14371](https://github.com/astral-sh/ruff/pull/14371)) +- \[`pylint`\] Suggest correct autofix for `__contains__` (`PLC2801`) ([#14424](https://github.com/astral-sh/ruff/pull/14424)) + +### Configuration + +- Ruff now emits a warning instead of an error when a configuration [`ignore`](https://docs.astral.sh/ruff/settings/#lint_ignore)s a rule that has been removed ([#14435](https://github.com/astral-sh/ruff/pull/14435)) +- Ruff now validates that `lint.flake8-import-conventions.aliases` only uses valid module names and aliases ([#14477](https://github.com/astral-sh/ruff/pull/14477)) + +## 0.7.4 + +### Preview features + +- \[`flake8-datetimez`\] Detect usages of `datetime.max`/`datetime.min` (`DTZ901`) ([#14288](https://github.com/astral-sh/ruff/pull/14288)) +- \[`flake8-logging`\] Implement `root-logger-calls` (`LOG015`) ([#14302](https://github.com/astral-sh/ruff/pull/14302)) +- \[`flake8-no-pep420`\] Detect empty implicit namespace packages (`INP001`) ([#14236](https://github.com/astral-sh/ruff/pull/14236)) +- \[`flake8-pyi`\] Add "replace with `Self`" fix (`PYI019`) ([#14238](https://github.com/astral-sh/ruff/pull/14238)) +- \[`perflint`\] Implement quick-fix for `manual-list-comprehension` (`PERF401`) ([#13919](https://github.com/astral-sh/ruff/pull/13919)) +- \[`pylint`\] Implement `shallow-copy-environ` (`W1507`) ([#14241](https://github.com/astral-sh/ruff/pull/14241)) +- \[`ruff`\] Implement `none-not-at-end-of-union` (`RUF036`) ([#14314](https://github.com/astral-sh/ruff/pull/14314)) +- \[`ruff`\] Implementation `unsafe-markup-call` from `flake8-markupsafe` plugin (`RUF035`) ([#14224](https://github.com/astral-sh/ruff/pull/14224)) +- \[`ruff`\] Report problems for `attrs` dataclasses (`RUF008`, `RUF009`) ([#14327](https://github.com/astral-sh/ruff/pull/14327)) + +### Rule changes + +- \[`flake8-boolean-trap`\] Exclude dunder methods that define operators (`FBT001`) ([#14203](https://github.com/astral-sh/ruff/pull/14203)) +- \[`flake8-pyi`\] Add "replace with `Self`" fix (`PYI034`) ([#14217](https://github.com/astral-sh/ruff/pull/14217)) +- \[`flake8-pyi`\] Always autofix `duplicate-union-members` (`PYI016`) ([#14270](https://github.com/astral-sh/ruff/pull/14270)) +- \[`flake8-pyi`\] Improve autofix for nested and mixed type unions for `unnecessary-type-union` (`PYI055`) ([#14272](https://github.com/astral-sh/ruff/pull/14272)) +- \[`flake8-pyi`\] Mark fix as unsafe when type annotation contains comments for `duplicate-literal-member` (`PYI062`) ([#14268](https://github.com/astral-sh/ruff/pull/14268)) + +### Server + +- Use the current working directory to resolve settings from `ruff.configuration` ([#14352](https://github.com/astral-sh/ruff/pull/14352)) + +### Bug fixes + +- Avoid conflicts between `PLC014` (`useless-import-alias`) and `I002` (`missing-required-import`) by considering `lint.isort.required-imports` for `PLC014` ([#14287](https://github.com/astral-sh/ruff/pull/14287)) +- \[`flake8-type-checking`\] Skip quoting annotation if it becomes invalid syntax (`TCH001`) +- \[`flake8-pyi`\] Avoid using `typing.Self` in stub files pre-Python 3.11 (`PYI034`) ([#14230](https://github.com/astral-sh/ruff/pull/14230)) +- \[`flake8-pytest-style`\] Flag `pytest.raises` call with keyword argument `expected_exception` (`PT011`) ([#14298](https://github.com/astral-sh/ruff/pull/14298)) +- \[`flake8-simplify`\] Infer "unknown" truthiness for literal iterables whose items are all unpacks (`SIM222`) ([#14263](https://github.com/astral-sh/ruff/pull/14263)) +- \[`flake8-type-checking`\] Fix false positives for `typing.Annotated` (`TCH001`) ([#14311](https://github.com/astral-sh/ruff/pull/14311)) +- \[`pylint`\] Allow `await` at the top-level scope of a notebook (`PLE1142`) ([#14225](https://github.com/astral-sh/ruff/pull/14225)) +- \[`pylint`\] Fix miscellaneous issues in `await-outside-async` detection (`PLE1142`) ([#14218](https://github.com/astral-sh/ruff/pull/14218)) +- \[`pyupgrade`\] Avoid applying PEP 646 rewrites in invalid contexts (`UP044`) ([#14234](https://github.com/astral-sh/ruff/pull/14234)) +- \[`pyupgrade`\] Detect permutations in redundant open modes (`UP015`) ([#14255](https://github.com/astral-sh/ruff/pull/14255)) +- \[`refurb`\] Avoid triggering `hardcoded-string-charset` for reordered sets (`FURB156`) ([#14233](https://github.com/astral-sh/ruff/pull/14233)) +- \[`refurb`\] Further special cases added to `verbose-decimal-constructor` (`FURB157`) ([#14216](https://github.com/astral-sh/ruff/pull/14216)) +- \[`refurb`\] Use `UserString` instead of non-existent `UserStr` (`FURB189`) ([#14209](https://github.com/astral-sh/ruff/pull/14209)) +- \[`ruff`\] Avoid treating lowercase letters as `# noqa` codes (`RUF100`) ([#14229](https://github.com/astral-sh/ruff/pull/14229)) +- \[`ruff`\] Do not report when `Optional` has no type arguments (`RUF013`) ([#14181](https://github.com/astral-sh/ruff/pull/14181)) + +### Documentation + +- Add "Notebook behavior" section for `F704`, `PLE1142` ([#14266](https://github.com/astral-sh/ruff/pull/14266)) +- Document comment policy around fix safety ([#14300](https://github.com/astral-sh/ruff/pull/14300)) + +## 0.7.3 + +### Preview features + +- Formatter: Disallow single-line implicit concatenated strings ([#13928](https://github.com/astral-sh/ruff/pull/13928)) +- \[`flake8-pyi`\] Include all Python file types for `PYI006` and `PYI066` ([#14059](https://github.com/astral-sh/ruff/pull/14059)) +- \[`flake8-simplify`\] Implement `split-of-static-string` (`SIM905`) ([#14008](https://github.com/astral-sh/ruff/pull/14008)) +- \[`refurb`\] Implement `subclass-builtin` (`FURB189`) ([#14105](https://github.com/astral-sh/ruff/pull/14105)) +- \[`ruff`\] Improve diagnostic messages and docs (`RUF031`, `RUF032`, `RUF034`) ([#14068](https://github.com/astral-sh/ruff/pull/14068)) + +### Rule changes + +- Detect items that hash to same value in duplicate sets (`B033`, `PLC0208`) ([#14064](https://github.com/astral-sh/ruff/pull/14064)) +- \[`eradicate`\] Better detection of IntelliJ language injection comments (`ERA001`) ([#14094](https://github.com/astral-sh/ruff/pull/14094)) +- \[`flake8-pyi`\] Add autofix for `docstring-in-stub` (`PYI021`) ([#14150](https://github.com/astral-sh/ruff/pull/14150)) +- \[`flake8-pyi`\] Update `duplicate-literal-member` (`PYI062`) to alawys provide an autofix ([#14188](https://github.com/astral-sh/ruff/pull/14188)) +- \[`pyflakes`\] Detect items that hash to same value in duplicate dictionaries (`F601`) ([#14065](https://github.com/astral-sh/ruff/pull/14065)) +- \[`ruff`\] Fix false positive for decorators (`RUF028`) ([#14061](https://github.com/astral-sh/ruff/pull/14061)) + +### Bug fixes + +- Avoid parsing joint rule codes as distinct codes in `# noqa` ([#12809](https://github.com/astral-sh/ruff/pull/12809)) +- \[`eradicate`\] ignore `# language=` in commented-out-code rule (ERA001) ([#14069](https://github.com/astral-sh/ruff/pull/14069)) +- \[`flake8-bugbear`\] - do not run `mutable-argument-default` on stubs (`B006`) ([#14058](https://github.com/astral-sh/ruff/pull/14058)) +- \[`flake8-builtins`\] Skip lambda expressions in `builtin-argument-shadowing (A002)` ([#14144](https://github.com/astral-sh/ruff/pull/14144)) +- \[`flake8-comprehension`\] Also remove trailing comma while fixing `C409` and `C419` ([#14097](https://github.com/astral-sh/ruff/pull/14097)) +- \[`flake8-simplify`\] Allow `open` without context manager in `return` statement (`SIM115`) ([#14066](https://github.com/astral-sh/ruff/pull/14066)) +- \[`pylint`\] Respect hash-equivalent literals in `iteration-over-set` (`PLC0208`) ([#14063](https://github.com/astral-sh/ruff/pull/14063)) +- \[`pylint`\] Update known dunder methods for Python 3.13 (`PLW3201`) ([#14146](https://github.com/astral-sh/ruff/pull/14146)) +- \[`pyupgrade`\] - ignore kwarg unpacking for `UP044` ([#14053](https://github.com/astral-sh/ruff/pull/14053)) +- \[`refurb`\] Parse more exotic decimal strings in `verbose-decimal-constructor` (`FURB157`) ([#14098](https://github.com/astral-sh/ruff/pull/14098)) + +### Documentation + +- Add links to missing related options within rule documentations ([#13971](https://github.com/astral-sh/ruff/pull/13971)) +- Add rule short code to mkdocs tags to allow searching via rule codes ([#14040](https://github.com/astral-sh/ruff/pull/14040)) + +## 0.7.2 + +### Preview features + +- Fix formatting of single with-item with trailing comment ([#14005](https://github.com/astral-sh/ruff/pull/14005)) +- \[`pyupgrade`\] Add PEP 646 `Unpack` conversion to `*` with fix (`UP044`) ([#13988](https://github.com/astral-sh/ruff/pull/13988)) + +### Rule changes + +- Regenerate `known_stdlibs.rs` with stdlibs 2024.10.25 ([#13963](https://github.com/astral-sh/ruff/pull/13963)) +- \[`flake8-no-pep420`\] Skip namespace package enforcement for PEP 723 scripts (`INP001`) ([#13974](https://github.com/astral-sh/ruff/pull/13974)) + +### Server + +- Fix server panic when undoing an edit ([#14010](https://github.com/astral-sh/ruff/pull/14010)) + +### Bug fixes + +- Fix issues in discovering ruff in pip build environments ([#13881](https://github.com/astral-sh/ruff/pull/13881)) +- \[`flake8-type-checking`\] Fix false positive for `singledispatchmethod` (`TCH003`) ([#13941](https://github.com/astral-sh/ruff/pull/13941)) +- \[`flake8-type-checking`\] Treat return type of `singledispatch` as runtime-required (`TCH003`) ([#13957](https://github.com/astral-sh/ruff/pull/13957)) + +### Documentation + +- \[`flake8-simplify`\] Include caveats of enabling `if-else-block-instead-of-if-exp` (`SIM108`) ([#14019](https://github.com/astral-sh/ruff/pull/14019)) + ## 0.7.1 ### Preview features - Fix `E221` and `E222` to flag missing or extra whitespace around `==` operator ([#13890](https://github.com/astral-sh/ruff/pull/13890)) -- Formatter: Alternate quotes for strings inside f-strings in preview ([#13860](https://github.com/astral-sh/ruff/pull/13860)) +- Formatter: Alternate quotes for strings inside f-strings in preview ([#13860](https://github.com/astral-sh/ruff/pull/13860)) - Formatter: Join implicit concatenated strings when they fit on a line ([#13663](https://github.com/astral-sh/ruff/pull/13663)) - \[`pylint`\] Restrict `iteration-over-set` to only work on sets of literals (`PLC0208`) ([#13731](https://github.com/astral-sh/ruff/pull/13731)) @@ -356,11 +1638,11 @@ The following rules have been stabilized and are no longer in preview: The following behaviors have been stabilized: -- [`cancel-scope-no-checkpoint`](https://docs.astral.sh/ruff/rules/cancel-scope-no-checkpoint/) (`ASYNC100`): Support `asyncio` and `anyio` context mangers. -- [`async-function-with-timeout`](https://docs.astral.sh/ruff/rules/async-function-with-timeout/) (`ASYNC109`): Support `asyncio` and `anyio` context mangers. -- [`async-busy-wait`](https://docs.astral.sh/ruff/rules/async-busy-wait/) (`ASYNC110`): Support `asyncio` and `anyio` context mangers. -- [`async-zero-sleep`](https://docs.astral.sh/ruff/rules/async-zero-sleep/) (`ASYNC115`): Support `anyio` context mangers. -- [`long-sleep-not-forever`](https://docs.astral.sh/ruff/rules/long-sleep-not-forever/) (`ASYNC116`): Support `anyio` context mangers. +- [`cancel-scope-no-checkpoint`](https://docs.astral.sh/ruff/rules/cancel-scope-no-checkpoint/) (`ASYNC100`): Support `asyncio` and `anyio` context managers. +- [`async-function-with-timeout`](https://docs.astral.sh/ruff/rules/async-function-with-timeout/) (`ASYNC109`): Support `asyncio` and `anyio` context managers. +- [`async-busy-wait`](https://docs.astral.sh/ruff/rules/async-busy-wait/) (`ASYNC110`): Support `asyncio` and `anyio` context managers. +- [`async-zero-sleep`](https://docs.astral.sh/ruff/rules/async-zero-sleep/) (`ASYNC115`): Support `anyio` context managers. +- [`long-sleep-not-forever`](https://docs.astral.sh/ruff/rules/long-sleep-not-forever/) (`ASYNC116`): Support `anyio` context managers. The following fixes have been stabilized: @@ -866,7 +2148,7 @@ The following deprecated CLI commands have been removed: ### Preview features - \[`flake8-bugbear`\] Implement `return-in-generator` (`B901`) ([#11644](https://github.com/astral-sh/ruff/pull/11644)) -- \[`flake8-pyi`\] Implement `PYI063` ([#11699](https://github.com/astral-sh/ruff/pull/11699)) +- \[`flake8-pyi`\] Implement `pep484-style-positional-only-parameter` (`PYI063`) ([#11699](https://github.com/astral-sh/ruff/pull/11699)) - \[`pygrep_hooks`\] Check blanket ignores via file-level pragmas (`PGH004`) ([#11540](https://github.com/astral-sh/ruff/pull/11540)) ### Rule changes @@ -1020,7 +2302,7 @@ To read more about this exciting milestone, check out our [blog post](https://as ### Preview features - \[`pycodestyle`\] Ignore end-of-line comments when determining blank line rules ([#11342](https://github.com/astral-sh/ruff/pull/11342)) -- \[`pylint`\] Detect `pathlib.Path.open` calls in `unspecified-encoding` (`PLW1514`) ([#11288](https://github.com/astral-sh/ruff/pull/11288)) +- \[`pylint`\] Detect `pathlib.Path.open` calls in `unspecified-encoding` (`PLW1514`) ([#11288](https://github.com/astral-sh/ruff/pull/11288)) - \[`flake8-pyi`\] Implement `PYI059` (`generic-not-last-base-class`) ([#11233](https://github.com/astral-sh/ruff/pull/11233)) - \[`flake8-pyi`\] Implement `PYI062` (`duplicate-literal-member`) ([#11269](https://github.com/astral-sh/ruff/pull/11269)) @@ -1395,7 +2677,7 @@ To setup `ruff server` with your editor, refer to the [README.md](https://github - \[`pycodestyle`\] Do not ignore lines before the first logical line in blank lines rules. ([#10382](https://github.com/astral-sh/ruff/pull/10382)) - \[`pycodestyle`\] Do not trigger `E225` and `E275` when the next token is a ')' ([#10315](https://github.com/astral-sh/ruff/pull/10315)) - \[`pylint`\] Avoid false-positive slot non-assignment for `__dict__` (`PLE0237`) ([#10348](https://github.com/astral-sh/ruff/pull/10348)) -- Gate f-string struct size test for Rustc \< 1.76 ([#10371](https://github.com/astral-sh/ruff/pull/10371)) +- Gate f-string struct size test for Rustc < 1.76 ([#10371](https://github.com/astral-sh/ruff/pull/10371)) ### Documentation diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 350f7422a5dea..5c8537b757c2e 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -71,8 +71,7 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -. +reported to the community leaders responsible for enforcement at . All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e0f6295d247e..35afe54ff53be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,11 @@ Welcome! We're happy to have you here. Thank you in advance for your contribution to Ruff. +> [!NOTE] +> +> This guide is for Ruff. If you're looking to contribute to ty, please see [the ty contributing +> guide](https://github.com/astral-sh/ruff/blob/main/crates/ty/CONTRIBUTING.md). + ## The Basics Ruff welcomes contributions in the form of pull requests. @@ -139,7 +144,7 @@ At a high level, the steps involved in adding a new lint rule are as follows: 1. Create a file for your rule (e.g., `crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_false.rs`). 1. In that file, define a violation struct (e.g., `pub struct AssertFalse`). You can grep for - `#[violation]` to see examples. + `#[derive(ViolationMetadata)]` to see examples. 1. In that file, define a function that adds the violation to the diagnostic list as appropriate (e.g., `pub(crate) fn assert_false`) based on whatever inputs are required for the rule (e.g., @@ -366,6 +371,15 @@ uvx --from ./python/ruff-ecosystem ruff-ecosystem format ruff "./target/debug/ru See the [ruff-ecosystem package](https://github.com/astral-sh/ruff/tree/main/python/ruff-ecosystem) for more details. +## Upgrading Rust + +1. Change the `channel` in `./rust-toolchain.toml` to the new Rust version (``) +1. Change the `rust-version` in the `./Cargo.toml` to ` - 2` (e.g. 1.84 if the latest is 1.86) +1. Run `cargo clippy --fix --allow-dirty --allow-staged` to fix new clippy warnings +1. Create and merge the PR +1. Bump the Rust version in Ruff's conda forge recipe. See [this PR](https://github.com/conda-forge/ruff-feedstock/pull/266) for an example. +1. Enjoy the new Rust version! + ## Benchmarking and Profiling We have several ways of benchmarking and profiling Ruff: @@ -397,7 +411,7 @@ cargo install hyperfine To benchmark the release build: ```shell -cargo build --release && hyperfine --warmup 10 \ +cargo build --release --bin ruff && hyperfine --warmup 10 \ "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache -e" \ "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ -e" @@ -467,7 +481,7 @@ cargo build --release && hyperfine --warmup 10 \ "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache -e --select W505,E501" ``` -You can run `poetry install` from `./scripts/benchmarks` to create a working environment for the +You can run `uv venv --project ./scripts/benchmarks`, activate the venv and then run `uv sync --project ./scripts/benchmarks` to create a working environment for the above. All reported benchmarks were computed using the versions specified by `./scripts/benchmarks/pyproject.toml` on Python 3.11. @@ -526,7 +540,7 @@ cargo benchmark #### Benchmark-driven Development Ruff uses [Criterion.rs](https://bheisler.github.io/criterion.rs/book/) for benchmarks. You can use -`--save-baseline=` to store an initial baseline benchmark (e.g. on `main`) and then use +`--save-baseline=` to store an initial baseline benchmark (e.g., on `main`) and then use `--benchmark=` to compare against that benchmark. Criterion will print a message telling you if the benchmark improved/regressed compared to that baseline. @@ -596,8 +610,7 @@ Then convert the recorded profile perf script -F +pid > /tmp/test.perf ``` -You can now view the converted file with [firefox profiler](https://profiler.firefox.com/), with a -more in-depth guide [here](https://profiler.firefox.com/docs/#/./guide-perf-profiling) +You can now view the converted file with [firefox profiler](https://profiler.firefox.com/). To learn more about Firefox profiler, read the [Firefox profiler profiling-guide](https://profiler.firefox.com/docs/#/./guide-perf-profiling). An alternative is to convert the perf data to `flamegraph.svg` using [flamegraph](https://github.com/flamegraph-rs/flamegraph) (`cargo install flamegraph`): @@ -678,9 +691,9 @@ utils with it: 23 Newline 24 ``` -- `cargo dev print-cst `: Print the CST of a python file using +- `cargo dev print-cst `: Print the CST of a Python file using [LibCST](https://github.com/Instagram/LibCST), which is used in addition to the RustPython parser - in Ruff. E.g. for `if True: pass # comment` everything including the whitespace is represented: + in Ruff. For example, for `if True: pass # comment`, everything, including the whitespace, is represented: ```text Module { @@ -863,7 +876,7 @@ each configuration file. The package root is used to determine a file's "module path". Consider, again, `baz.py`. In that case, `./my_project/src/foo` was identified as the package root, so the module path for `baz.py` -would resolve to `foo.bar.baz` — as computed by taking the relative path from the package root +would resolve to `foo.bar.baz` — as computed by taking the relative path from the package root (inclusive of the root itself). The module path can be thought of as "the path you would use to import the module" (e.g., `import foo.bar.baz`). diff --git a/Cargo.lock b/Cargo.lock index faa377a7be1ad..55859345a818d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,31 +1,12 @@ # This file is automatically @generated by Cargo. # It is not intended for manual editing. -version = 3 +version = 4 [[package]] -name = "Inflector" -version = "0.11.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe438c63458706e03479442743baae6c88256498e6431708f6dfc520a26515d3" - -[[package]] -name = "adler" -version = "1.0.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" - -[[package]] -name = "ahash" -version = "0.8.11" +name = "adler2" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011" -dependencies = [ - "cfg-if", - "getrandom", - "once_cell", - "version_check", - "zerocopy", -] +checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627" [[package]] name = "aho-corasick" @@ -36,6 +17,12 @@ dependencies = [ "memchr", ] +[[package]] +name = "allocator-api2" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" + [[package]] name = "android-tzdata" version = "0.1.1" @@ -59,85 +46,91 @@ checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299" [[package]] name = "annotate-snippets" -version = "0.6.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c7021ce4924a3f25f802b2cccd1af585e39ea1a363a1aa2e72afe54b67a3a7a7" - -[[package]] -name = "annotate-snippets" -version = "0.9.2" +version = "0.11.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ccaf7e9dfbb6ab22c82e473cd1a8a7bd313c19a5b7e40970f3d89ef5a5c9e81e" +checksum = "710e8eae58854cdc1790fcb56cca04d712a17be849eeb81da2a724bf4bae2bc4" dependencies = [ - "unicode-width 0.1.13", - "yansi-term", + "anstyle", + "unicode-width 0.2.0", ] [[package]] name = "anstream" -version = "0.6.13" +version = "0.6.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d96bd03f33fe50a863e394ee9718a706f988b9079b20c3784fb726e7678b62fb" +checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b" dependencies = [ "anstyle", "anstyle-parse", "anstyle-query", "anstyle-wincon", "colorchoice", + "is_terminal_polyfill", "utf8parse", ] [[package]] name = "anstyle" -version = "1.0.8" +version = "1.0.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9" + +[[package]] +name = "anstyle-lossy" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1bec1de6f59aedf83baf9ff929c98f2ad654b97c9510f4e70cf6f661d49fd5b1" +checksum = "934ff8719effd2023a48cf63e69536c1c3ced9d3895068f6f5cc9a4ff845e59b" +dependencies = [ + "anstyle", +] [[package]] name = "anstyle-parse" -version = "0.2.3" +version = "0.2.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c75ac65da39e5fe5ab759307499ddad880d724eed2f6ce5b5e8a26f4f387928c" +checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9" dependencies = [ "utf8parse", ] [[package]] name = "anstyle-query" -version = "1.0.2" +version = "1.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e28923312444cdd728e4738b3f9c9cac739500909bb3d3c94b43551b16517648" +checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c" dependencies = [ - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] -name = "anstyle-wincon" -version = "3.0.2" +name = "anstyle-svg" +version = "0.1.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1cd54b81ec8d6180e24654d0b371ad22fc3dd083b6ff8ba325b72e00c87660a7" +checksum = "d3607949e9f6de49ea4bafe12f5e4fd73613ebf24795e48587302a8cc0e4bb35" dependencies = [ + "anstream", "anstyle", - "windows-sys 0.52.0", + "anstyle-lossy", + "html-escape", + "unicode-width 0.2.0", ] [[package]] -name = "anyhow" -version = "1.0.91" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c042108f3ed77fd83760a5fd79b53be043192bb3b9dba91d8c574c0ada7850c8" - -[[package]] -name = "append-only-vec" -version = "0.1.5" +name = "anstyle-wincon" +version = "3.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "74d9f7083455f1a474276ccd32374958d2cb591024aac45101c7623b10271347" +checksum = "ca3534e77181a9cc07539ad51f2141fe32f6c3ffd4df76db8ad92346b003ae4e" +dependencies = [ + "anstyle", + "once_cell", + "windows-sys 0.59.0", +] [[package]] -name = "arc-swap" -version = "1.7.1" +name = "anyhow" +version = "1.0.98" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "69f7f8c3906b62b754cd5326047894316021dcfe5a194c8ea52bdd94934a3457" +checksum = "e16d2d3311acee920a9eb8d33b8cbc1787ce4a264e85f964c2404b969bdcd487" [[package]] name = "argfile" @@ -151,15 +144,15 @@ dependencies = [ [[package]] name = "arrayvec" -version = "0.7.4" +version = "0.7.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "96d30a06541fbafbc7f82ed10c06164cfbd2c401138f6addd8404629c4b16711" +checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50" [[package]] name = "assert_fs" -version = "1.1.2" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7efdb1fdb47602827a342857666feb372712cbc64b414172bd6b167a02927674" +checksum = "a652f6cb1f516886fcfee5e7a5c078b9ade62cfcb889524efe5a64d682dd27a9" dependencies = [ "anstyle", "doc-comment", @@ -172,23 +165,34 @@ dependencies = [ [[package]] name = "autocfg" -version = "1.2.0" +version = "1.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f1fdabc7756949593fe60f30ec81974b613357de856987752631dea1e3394c80" +checksum = "ace50bade8e6234aa140d9a2f552bbee1db4d353f69b8217bc503490fc1a9f26" [[package]] name = "base64" -version = "0.22.0" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9475866fec1451be56a3c2400fd081ff546538961565ccb5b7142cbd22bc7a51" +checksum = "9e1b586273c5702936fe7b7d6896644d8be71e6314cfe09d3167c95f712589e8" [[package]] name = "bincode" -version = "1.3.3" +version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1f45e9417d87227c7a56d22e471c6206462cba514c7590c09aff4cf6d1ddcad" +checksum = "36eaf5d7b090263e8150820482d5d93cd964a81e4019913c972f4edcc6edb740" dependencies = [ + "bincode_derive", "serde", + "unty", +] + +[[package]] +name = "bincode_derive" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf95709a440f45e986983918d0e8a1f30a9b1df04918fc828670606804ac3c09" +dependencies = [ + "virtue", ] [[package]] @@ -199,9 +203,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" [[package]] name = "bitflags" -version = "2.6.0" +version = "2.9.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" +checksum = "1b8e56985ec62d17e9c1001dc89c88ecd7dc08e47eba5ec7c29c7b5eeecde967" [[package]] name = "block-buffer" @@ -212,22 +216,28 @@ dependencies = [ "generic-array", ] +[[package]] +name = "boxcar" +version = "0.2.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "66bb12751a83493ef4b8da1120451a262554e216a247f14b48cb5e8fe7ed8bdf" + [[package]] name = "bstr" -version = "1.10.0" +version = "1.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "40723b8fb387abc38f4f4a37c09073622e41dd12327033091ef8950659e6dc0c" +checksum = "234113d19d0d7d613b40e86fb654acf958910802bcceab913a4f9e7cda03b1a4" dependencies = [ "memchr", - "regex-automata 0.4.8", + "regex-automata 0.4.9", "serde", ] [[package]] name = "bumpalo" -version = "3.16.0" +version = "3.17.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c" +checksum = "1628fb46dfa0b37568d12e5edd512553eccf6a22a78e8bde00bb4aed84d5bdbf" [[package]] name = "byteorder" @@ -270,13 +280,13 @@ dependencies = [ [[package]] name = "cc" -version = "1.0.95" +version = "1.2.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d32a725bc159af97c3e629873bb9f88fb8cf8a4867175f76dc987815ea07c83b" +checksum = "5f4ac86a9e5bc1e2b3449ab9d7d3a6a405e3d1bb28d7b9be8614f55846ae3766" dependencies = [ "jobserver", "libc", - "once_cell", + "shlex", ] [[package]] @@ -285,37 +295,22 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" -[[package]] -name = "cfg_aliases" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fd16c4719339c4530435d38e511904438d07cce7950afa3718a84ac36c10e89e" - [[package]] name = "cfg_aliases" version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724" -[[package]] -name = "chic" -version = "1.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a5b5db619f3556839cb2223ae86ff3f9a09da2c5013be42bc9af08c9589bf70c" -dependencies = [ - "annotate-snippets 0.6.1", -] - [[package]] name = "chrono" -version = "0.4.38" +version = "0.4.41" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a21f936df1771bf62b77f047b726c4625ff2e8aa607c01ec06e5a05bd8463401" +checksum = "c469d952047f47f91b68d1cba3f10d63c11d73e4636f24f08daf0278abf01c4d" dependencies = [ "android-tzdata", "iana-time-zone", "num-traits", - "windows-targets 0.52.6", + "windows-link", ] [[package]] @@ -347,9 +342,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.20" +version = "4.5.38" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b97f376d85a664d5837dbae44bf546e6477a679ff6610010f17276f686d867e8" +checksum = "ed93b9805f8ba930df42c2590f05453d5ec36cbb85d018868a5b24d31f6ac000" dependencies = [ "clap_builder", "clap_derive", @@ -357,22 +352,22 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.5.20" +version = "4.5.38" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "19bc80abd44e4bed93ca373a0704ccbd1b710dc5749406201bb018272808dc54" +checksum = "379026ff283facf611b0ea629334361c4211d1b12ee01024eec1591133b04120" dependencies = [ "anstream", "anstyle", "clap_lex", - "strsim 0.11.1", + "strsim", "terminal_size", ] [[package]] name = "clap_complete" -version = "4.5.2" +version = "4.5.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dd79504325bf38b10165b02e89b4347300f855f273c4cb30c4a3209e6583275e" +checksum = "c91d3baa3bcd889d60e6ef28874126a0b384fd225ab83aa6d8a801c519194ce1" dependencies = [ "clap", ] @@ -390,9 +385,9 @@ dependencies = [ [[package]] name = "clap_complete_nushell" -version = "4.5.2" +version = "4.5.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1accf1b463dee0d3ab2be72591dccdab8bef314958340447c882c4c72acfe2a3" +checksum = "c6a8b1593457dfc2fe539002b795710d022dc62a65bf15023f039f9760c7b18a" dependencies = [ "clap", "clap_complete", @@ -400,78 +395,114 @@ dependencies = [ [[package]] name = "clap_derive" -version = "4.5.18" +version = "4.5.32" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4ac6a0c7b1a9e9a5186361f67dfa1b88213572f427fb9ab038efb2bd8c582dab" +checksum = "09176aae279615badda0765c0c0b3f6ed53f4709118af73cf4655d85d1530cd7" dependencies = [ "heck", "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "clap_lex" -version = "0.7.0" +version = "0.7.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "98cc8fbded0c607b7ba9dd60cd98df59af97e84d24e49c8557331cfc26d301ce" +checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6" [[package]] name = "clearscreen" -version = "3.0.0" +version = "4.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2f8c93eb5f77c9050c7750e14f13ef1033a40a0aac70c6371535b6763a01438c" +checksum = "8c41dc435a7b98e4608224bbf65282309f5403719df9113621b30f8b6f74e2f4" dependencies = [ - "nix 0.28.0", + "nix 0.29.0", "terminfo", - "thiserror", + "thiserror 2.0.12", "which", - "winapi", + "windows-sys 0.59.0", ] [[package]] name = "codspeed" -version = "2.7.2" +version = "2.10.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "450a0e9df9df1c154156f4344f99d8f6f6e69d0fc4de96ef6e2e68b2ec3bce97" +checksum = "93f4cce9c27c49c4f101fffeebb1826f41a9df2e7498b7cd4d95c0658b796c6c" dependencies = [ - "colored", + "colored 2.2.0", "libc", + "serde", "serde_json", + "uuid", ] [[package]] name = "codspeed-criterion-compat" -version = "2.7.2" +version = "2.10.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8eb1a6cb9c20e177fde58cdef97c1c7c9264eb1424fe45c4fccedc2fb078a569" +checksum = "c3c23d880a28a2aab52d38ca8481dd7a3187157d0a952196b6db1db3c8499725" dependencies = [ "codspeed", - "colored", - "criterion", + "codspeed-criterion-compat-walltime", + "colored 2.2.0", +] + +[[package]] +name = "codspeed-criterion-compat-walltime" +version = "2.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b0a2f7365e347f4f22a67e9ea689bf7bc89900a354e22e26cf8a531a42c8fbb" +dependencies = [ + "anes", + "cast", + "ciborium", + "clap", + "codspeed", + "criterion-plot", + "is-terminal", + "itertools 0.10.5", + "num-traits", + "once_cell", + "oorandom", + "regex", + "serde", + "serde_derive", + "serde_json", + "tinytemplate", + "walkdir", ] [[package]] name = "colorchoice" -version = "1.0.0" +version = "1.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" +checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990" [[package]] name = "colored" -version = "2.1.0" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cbf2150cce219b664a8a70df7a1f933836724b503f8a413af9365b4dcc4d90b8" +checksum = "117725a109d387c937a1533ce01b450cbde6b88abceea8473c4d7a85853cda3c" dependencies = [ "lazy_static", - "windows-sys 0.48.0", + "windows-sys 0.59.0", +] + +[[package]] +name = "colored" +version = "3.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fde0e0ec90c9dfb3b4b1a0891a7dcd0e2bffde2f7efed5fe7c9bb00e5bfb915e" +dependencies = [ + "windows-sys 0.59.0", ] [[package]] name = "compact_str" -version = "0.8.0" +version = "0.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6050c3a16ddab2e412160b31f2c871015704239bca62f72f6e5f0be631d3f644" +checksum = "3fdb1325a1cece981e8a296ab8f0f9b63ae357bd0784a9faaf548cc7b480707a" dependencies = [ "castaway", "cfg-if", @@ -484,15 +515,15 @@ dependencies = [ [[package]] name = "console" -version = "0.15.8" +version = "0.15.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0e1f83fc076bd6dd27517eacdf25fef6c4dfe5f1d7448bafaaf3a26f13b5e4eb" +checksum = "054ccb5b10f9f2cbf51eb355ca1d05c2d279ce1804688d0db74b4733a5aeafd8" dependencies = [ "encode_unicode", - "lazy_static", "libc", - "unicode-width 0.1.13", - "windows-sys 0.52.0", + "once_cell", + "unicode-width 0.2.0", + "windows-sys 0.59.0", ] [[package]] @@ -517,9 +548,9 @@ dependencies = [ [[package]] name = "core-foundation-sys" -version = "0.8.6" +version = "0.8.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" [[package]] name = "countme" @@ -534,41 +565,38 @@ dependencies = [ [[package]] name = "cpufeatures" -version = "0.2.13" +version = "0.2.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "51e852e6dc9a5bed1fae92dd2375037bf2b768725bf3be87811edee3249d09ad" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" dependencies = [ "libc", ] [[package]] name = "crc32fast" -version = "1.4.0" +version = "1.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b3855a8a784b474f333699ef2bbca9db2c4a1f6d9088a90a2d25b1eb53111eaa" +checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3" dependencies = [ "cfg-if", ] [[package]] name = "criterion" -version = "0.5.1" +version = "0.6.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f2b12d017a929603d80db1831cd3a24082f8137ce19c69e6447f54f5fc8d692f" +checksum = "3bf7af66b0989381bd0be551bd7cc91912a655a58c6918420c9527b1fd8b4679" dependencies = [ "anes", "cast", "ciborium", "clap", "criterion-plot", - "is-terminal", - "itertools 0.10.5", + "itertools 0.13.0", "num-traits", - "once_cell", "oorandom", "regex", "serde", - "serde_derive", "serde_json", "tinytemplate", "walkdir", @@ -599,18 +627,18 @@ dependencies = [ [[package]] name = "crossbeam-channel" -version = "0.5.12" +version = "0.5.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ab3db02a9c5b5121e1e42fbdb1aeb65f5e02624cc58c43f2884c6ccac0b82f95" +checksum = "82b8f8f868b36967f9606790d1903570de9ceaf870a7bf9fbbd3016d636a2cb2" dependencies = [ "crossbeam-utils", ] [[package]] name = "crossbeam-deque" -version = "0.8.5" +version = "0.8.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "613f8cc01fe9cf1a3eb3d7f488fd2fa8388403e97039e2f73692932e291a770d" +checksum = "9dd111b7b7f7d55b72c0a6ae361660ee5853c9af73f70c3c2ef6858b950e2e51" dependencies = [ "crossbeam-epoch", "crossbeam-utils", @@ -627,24 +655,24 @@ dependencies = [ [[package]] name = "crossbeam-queue" -version = "0.3.11" +version = "0.3.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "df0346b5d5e76ac2fe4e327c5fd1118d6be7c51dfb18f9b7922923f287471e35" +checksum = "0f58bbc28f91df819d0aa2a2c00cd19754769c2fad90579b3592b1c9ba7a3115" dependencies = [ "crossbeam-utils", ] [[package]] name = "crossbeam-utils" -version = "0.8.19" +version = "0.8.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "248e3bacc7dc6baa3b21e405ee045c3047101a49145e7e9eca583ab4c2ca5345" +checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28" [[package]] name = "crunchy" -version = "0.2.2" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7a81dae078cea95a014a339291cec439d2f232ebe854a9d672b796c6afafa9b7" +checksum = "43da5946c66ffcc7745f48db692ffbb10a83bfe0afd96235c5c2a4fb23994929" [[package]] name = "crypto-common" @@ -658,19 +686,19 @@ dependencies = [ [[package]] name = "ctrlc" -version = "3.4.5" +version = "3.4.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90eeab0aa92f3f9b4e87f258c72b139c207d251f9cbc1080a0086b86a8870dd3" +checksum = "46f93780a459b7d656ef7f071fe699c4d3d2cb201c4b24d085b6ddc505276e73" dependencies = [ - "nix 0.29.0", + "nix 0.30.1", "windows-sys 0.59.0", ] [[package]] name = "darling" -version = "0.20.8" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "54e36fcd13ed84ffdfda6f5be89b31287cbb80c439841fe69e04841435464391" +checksum = "fc7f46116c46ff9ab3eb1597a45688b6715c6e628b5c133e288e709a29bcb4ee" dependencies = [ "darling_core", "darling_macro", @@ -678,27 +706,27 @@ dependencies = [ [[package]] name = "darling_core" -version = "0.20.8" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9c2cf1c23a687a1feeb728783b993c4e1ad83d99f351801977dd809b48d0a70f" +checksum = "0d00b9596d185e565c2207a0b01f8bd1a135483d02d9b7b0a54b11da8d53412e" dependencies = [ "fnv", "ident_case", "proc-macro2", "quote", - "strsim 0.10.0", - "syn 2.0.85", + "strsim", + "syn", ] [[package]] name = "darling_macro" -version = "0.20.8" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a668eda54683121533a393014d8692171709ff57a7d61f187b6e782719f8933f" +checksum = "fc34b93ccb385b40dc71c6fceac4b2ad23662c7eeb248cf10d529b7e055b6ead" dependencies = [ "darling_core", "quote", - "syn 2.0.85", + "syn", ] [[package]] @@ -752,64 +780,55 @@ dependencies = [ [[package]] name = "dir-test" -version = "0.3.0" +version = "0.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c44bdf9319ad5223afb7eb15a7110452b0adf0373ea6756561b2c708eef0dd1" +checksum = "62c013fe825864f3e4593f36426c1fa7a74f5603f13ca8d1af7a990c1cd94a79" dependencies = [ "dir-test-macros", ] [[package]] name = "dir-test-macros" -version = "0.3.0" +version = "0.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "644f96047137dfaa7a09e34d4623f9e52a1926ecc25ba32ad2ba3fc422536b25" +checksum = "d42f54d7b4a6bc2400fe5b338e35d1a335787585375322f49c5d5fe7b243da7e" dependencies = [ "glob", "proc-macro2", "quote", - "syn 1.0.109", -] - -[[package]] -name = "dirs" -version = "4.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ca3aa72a6f96ea37bbc5aa912f6788242832f75369bdfdadcb0e38423f100059" -dependencies = [ - "dirs-sys 0.3.7", + "syn", ] [[package]] name = "dirs" -version = "5.0.1" +version = "6.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "44c45a9d03d6676652bcb5e724c7e988de1acad23a711b5217ab9cbecbec2225" +checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e" dependencies = [ - "dirs-sys 0.4.1", + "dirs-sys", ] [[package]] name = "dirs-sys" -version = "0.3.7" +version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6" +checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab" dependencies = [ "libc", + "option-ext", "redox_users", - "winapi", + "windows-sys 0.59.0", ] [[package]] -name = "dirs-sys" -version = "0.4.1" +name = "displaydoc" +version = "0.2.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "520f05a5cbd335fae5a99ff7a6ab8627577660ee5cfd6a94a6a929b52ff0321c" +checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" dependencies = [ - "libc", - "option-ext", - "redox_users", - "windows-sys 0.48.0", + "proc-macro2", + "quote", + "syn", ] [[package]] @@ -824,85 +843,115 @@ version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9bda8e21c04aca2ae33ffc2fd8c23134f3cac46db123ba97bd9d3f3b8a4a85e1" +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + [[package]] name = "dyn-clone" -version = "1.0.17" +version = "1.0.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d6ef0072f8a535281e4876be788938b528e9a1d43900b82c2569af7da799125" +checksum = "1c7a8fb8a9fbf66c1f703fe16184d10ca0ee9d23be5b4436400408ba54a95005" [[package]] name = "either" -version = "1.11.0" +version = "1.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a47c1c47d2f5964e29c61246e81db715514cd532db6b5116a25ea3c03d6780a2" +checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719" [[package]] name = "encode_unicode" -version = "0.3.6" +version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a357d28ed41a50f9c765dbfe56cbc04a64e53e5fc58ba79fbc34c10ef3df831f" +checksum = "34aa73646ffb006b8f5147f3dc182bd4bcb190227ce861fc4a4844bf8e3cb2c0" [[package]] name = "env_filter" -version = "0.1.0" +version = "0.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a009aa4810eb158359dda09d0c87378e4bbb89b5a801f016885a4707ba24f7ea" +checksum = "186e05a59d4c50738528153b83b0b0194d3a29507dfec16eccd4b342903397d0" dependencies = [ "log", "regex", ] +[[package]] +name = "env_home" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7f84e12ccf0a7ddc17a6c41c93326024c42920d7ee630d04950e6926645c0fe" + [[package]] name = "env_logger" -version = "0.11.5" +version = "0.11.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e13fa619b91fb2381732789fc5de83b45675e882f66623b7d8cb4f643017018d" +checksum = "13c863f0904021b108aa8b2f55046443e6b1ebde8fd4a15c399893aae4fa069f" dependencies = [ "anstream", "anstyle", "env_filter", - "humantime", + "jiff", "log", ] [[package]] name = "equivalent" -version = "1.0.1" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" [[package]] name = "errno" -version = "0.3.8" +version = "0.3.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a258e46cdc063eb8519c00b9fc845fc47bcfca4130e2f08e88665ceda8474245" +checksum = "cea14ef9355e3beab063703aa9dab15afd25f0667c341310c1e5274bb1d0da18" dependencies = [ "libc", - "windows-sys 0.52.0", + "windows-sys 0.59.0", +] + +[[package]] +name = "escape8259" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5692dd7b5a1978a5aeb0ce83b7655c58ca8efdcb79d21036ea249da95afec2c6" + +[[package]] +name = "escargot" +version = "0.5.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "83f351750780493fc33fa0ce8ba3c7d61f9736cfa3b3bb9ee2342643ffe40211" +dependencies = [ + "log", + "once_cell", + "serde", + "serde_json", ] [[package]] name = "etcetera" -version = "0.8.0" +version = "0.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "136d1b5283a1ab77bd9257427ffd09d8667ced0570b6f938942bc7568ed5b943" +checksum = "26c7b13d0780cb82722fd59f6f57f925e143427e4a75313a6c77243bf5326ae6" dependencies = [ "cfg-if", "home", - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] name = "fastrand" -version = "2.1.1" +version = "2.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e8c02a5121d4ea3eb16a80748c74f5549a5665e4c21333c6098f283870fbdea6" +checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" [[package]] name = "fern" -version = "0.7.0" +version = "0.7.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "69ff9c9d5fb3e6da8ac2f77ab76fe7e8087d512ce095200f8f29ac5b656cf6dc" +checksum = "4316185f709b23713e41e3195f90edef7fb00c3ed4adc79769cf09cc762a3b29" dependencies = [ "log", ] @@ -921,9 +970,9 @@ dependencies = [ [[package]] name = "flate2" -version = "1.0.28" +version = "1.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "46303f565772937ffe1d394a4fac6f411c6013172fadde9dcdb1e147a086940e" +checksum = "7ced92e76e966ca2fd84c8f7aa01a4aea65b0eb6648d72f7c8f3e2764a67fece" dependencies = [ "crc32fast", "miniz_oxide", @@ -935,6 +984,12 @@ version = "1.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + [[package]] name = "form_urlencoded" version = "1.2.1" @@ -978,38 +1033,50 @@ version = "0.2.21" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "14dbbfd5c71d70241ecf9e6f13737f7b5ce823821063188d7e46c41d371eebd5" dependencies = [ - "unicode-width 0.1.13", + "unicode-width 0.1.14", ] [[package]] name = "getrandom" -version = "0.2.14" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "335ff9f135e4384c8150d6f27c6daed433577f86b4750418338c01a1a2528592" +dependencies = [ + "cfg-if", + "libc", + "wasi 0.11.0+wasi-snapshot-preview1", +] + +[[package]] +name = "getrandom" +version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "94b22e06ecb0110981051723910cbf0b5f5e09a2062dd7663334ee79a9d1286c" +checksum = "26145e563e54f2cadc477553f1ec5ee650b00862f0a58bcd12cbdc5f0ea2d2f4" dependencies = [ "cfg-if", "js-sys", "libc", - "wasi", + "r-efi", + "wasi 0.14.2+wasi-0.2.4", "wasm-bindgen", ] [[package]] name = "glob" -version = "0.3.1" +version = "0.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b" +checksum = "a8d1add55171497b4705a648c6b583acafb01d58050a51727785f0b2c8e0a2b2" [[package]] name = "globset" -version = "0.4.15" +version = "0.4.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "15f1ce686646e7f1e19bf7d5533fe443a45dbfb990e00629110797578b42fb19" +checksum = "54a1028dfc5f5df5da8a56a73e6c153c9a9708ec57232470703592a3f18e49f5" dependencies = [ "aho-corasick", "bstr", "log", - "regex-automata 0.4.8", + "regex-automata 0.4.9", "regex-syntax 0.8.5", ] @@ -1019,16 +1086,16 @@ version = "0.9.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0bf760ebf69878d9fd8f110c89703d90ce35095324d1f1edcb595c63945ee757" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", "ignore", "walkdir", ] [[package]] name = "half" -version = "2.4.1" +version = "2.6.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6dd08c532ae367adf81c312a4580bc67f1d0fe8bc9c460520283f4c0ff277888" +checksum = "459196ed295495a68f7d7fe1d84f6c4b7ff0e21fe3017b2f283c6fac3ad803c9" dependencies = [ "cfg-if", "crunchy", @@ -1039,23 +1106,25 @@ name = "hashbrown" version = "0.14.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" -dependencies = [ - "ahash", -] [[package]] name = "hashbrown" -version = "0.15.0" +version = "0.15.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e087f84d4f86bf4b218b927129862374b72199ae7d8657835f1e89000eea4fb" +checksum = "84b26c544d002229e640969970a2e74021aadf6e2f96372b9c58eff97de08eb3" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash", +] [[package]] name = "hashlink" -version = "0.9.1" +version = "0.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6ba4ff7128dee98c7dc9794b6a411377e1404dba1c97deb8d1a55297bd25d8af" +checksum = "7382cf6263419f2d8df38c55d7da83da5c18aef87fc7a7fc1fb1e344edfe14c1" dependencies = [ - "hashbrown 0.14.5", + "hashbrown 0.15.3", ] [[package]] @@ -1070,31 +1139,41 @@ version = "0.3.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d231dfb89cfffdbc30e7fc41579ed6066ad03abda9e567ccafae602b97ec5024" +[[package]] +name = "hermit-abi" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f154ce46856750ed433c8649605bf7ed2de3bc35fd9d2a9f30cddd873c80cb08" + [[package]] name = "home" -version = "0.5.9" +version = "0.5.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e3d1354bf6b7235cb4a0576c2619fd4ed18183f689b12b006a0ee7329eeff9a5" +checksum = "589533453244b0995c858700322199b2becb13b627df2851f64a2775d024abcf" dependencies = [ - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] -name = "humantime" -version = "2.1.0" +name = "html-escape" +version = "0.2.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4" +checksum = "6d1ad449764d627e22bfd7cd5e8868264fc9236e07c752972b4080cd351cb476" +dependencies = [ + "utf8-width", +] [[package]] name = "iana-time-zone" -version = "0.1.60" +version = "0.1.63" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e7ffbb5a1b541ea2561f8c41c087286cc091e21e556a4f09a8f6cbf17b69b141" +checksum = "b0c919e5debc312ad217002b8048a17b7d83f80703865bbfcfebb0458b0b27d8" dependencies = [ "android_system_properties", "core-foundation-sys", "iana-time-zone-haiku", "js-sys", + "log", "wasm-bindgen", "windows-core", ] @@ -1109,24 +1188,121 @@ dependencies = [ ] [[package]] -name = "ident_case" -version = "1.0.1" +name = "icu_collections" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" +checksum = "200072f5d0e3614556f94a9930d5dc3e0662a652823904c3a75dc3b0af7fee47" +dependencies = [ + "displaydoc", + "potential_utf", + "yoke", + "zerofrom", + "zerovec", +] [[package]] -name = "idna" -version = "0.5.0" +name = "icu_locale_core" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "634d9b1461af396cad843f47fdba5597a4f9e6ddd4bfb6ff5d85028c25cb12f6" +checksum = "0cde2700ccaed3872079a65fb1a78f6c0a36c91570f28755dda67bc8f7d9f00a" dependencies = [ - "unicode-bidi", - "unicode-normalization", + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", ] [[package]] -name = "ignore" -version = "0.4.23" +name = "icu_normalizer" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "436880e8e18df4d7bbc06d58432329d6458cc84531f7ac5f024e93deadb37979" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00210d6893afc98edb752b664b8890f0ef174c8adbb8d0be9710fa66fbbf72d3" + +[[package]] +name = "icu_properties" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2549ca8c7241c82f59c80ba2a6f415d931c5b58d24fb8412caa1a1f02c49139a" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "potential_utf", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8197e866e47b68f8f7d95249e172903bec06004b18b2937f1095d40a0c57de04" + +[[package]] +name = "icu_provider" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03c80da27b5f4187909049ee2d72f276f0d9f99a42c306bd0131ecfe04d8e5af" +dependencies = [ + "displaydoc", + "icu_locale_core", + "stable_deref_trait", + "tinystr", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + +[[package]] +name = "idna" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "686f825264d630750a544639377bae737628043f20d38bbc029e8f29ea968a7e" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3acae9609540aa318d1bc588455225fb2085b9ed0c4f6bd0d9d5bcd86f1a0344" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "ignore" +version = "0.4.23" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6d89fd380afde86567dfba715db065673989d6253f42b88179abd3eae47bda4b" dependencies = [ @@ -1134,7 +1310,7 @@ dependencies = [ "globset", "log", "memchr", - "regex-automata 0.4.8", + "regex-automata 0.4.9", "same-file", "walkdir", "winapi-util", @@ -1142,12 +1318,11 @@ dependencies = [ [[package]] name = "imara-diff" -version = "0.1.7" +version = "0.1.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fc9da1a252bd44cd341657203722352efc9bc0c847d06ea6d2dc1cd1135e0a01" +checksum = "17d34b7d42178945f775e84bc4c36dde7c1c6cdfea656d3354d009056f2bb3d2" dependencies = [ - "ahash", - "hashbrown 0.14.5", + "hashbrown 0.15.3", ] [[package]] @@ -1162,42 +1337,42 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.5.0" +version = "2.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "68b900aa2f7301e21c36462b170ee99994de34dff39a4a6a528e80e7376d07e5" +checksum = "cea70ddb795996207ad57735b50c5982d8844f38ba9ee5f1aedcfb708a2aa11e" dependencies = [ "equivalent", - "hashbrown 0.14.5", + "hashbrown 0.15.3", "serde", ] [[package]] name = "indicatif" -version = "0.17.8" +version = "0.17.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "763a5a8f45087d6bcea4222e7b72c291a054edf80e4ef6efd2a4979878c7bea3" +checksum = "183b3088984b400f4cfac3620d5e076c84da5364016b4f49473de574b2586235" dependencies = [ "console", - "instant", "number_prefix", "portable-atomic", - "unicode-width 0.1.13", + "unicode-width 0.2.0", "vt100", + "web-time", ] [[package]] name = "indoc" -version = "2.0.5" +version = "2.0.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5" +checksum = "f4c7245a08504955605670dbf141fceab975f15ca21570696aebe9d2e71576bd" [[package]] name = "inotify" -version = "0.9.6" +version = "0.11.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8069d3ec154eb856955c1c0fbffefbf5f3c40a104ec912d4797314c1801abff" +checksum = "f37dccff2791ab604f9babef0ba14fbe0be30bd368dc541e2b08d07c8aa908f3" dependencies = [ - "bitflags 1.3.2", + "bitflags 2.9.1", "inotify-sys", "libc", ] @@ -1213,17 +1388,17 @@ dependencies = [ [[package]] name = "insta" -version = "1.41.0" +version = "1.43.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1f72d3e19488cf7d8ea52d2fc0f8754fc933398b337cd3cbdb28aaeb35159ef" +checksum = "154934ea70c58054b556dd430b99a98c2a7ff5309ac9891597e339b5c28f4371" dependencies = [ "console", "globset", - "lazy_static", - "linked-hash-map", + "once_cell", "pest", "pest_derive", "regex", + "ron", "serde", "similar", "walkdir", @@ -1240,15 +1415,6 @@ dependencies = [ "serde_json", ] -[[package]] -name = "instant" -version = "0.1.12" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7a5bbe824c507c5da5956355e86a746d82e0e1464f65d862cc5e71da70e94b2c" -dependencies = [ - "cfg-if", -] - [[package]] name = "is-docker" version = "0.2.0" @@ -1260,25 +1426,25 @@ dependencies = [ [[package]] name = "is-macro" -version = "0.3.6" +version = "0.3.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2069faacbe981460232f880d26bf3c7634e322d49053aa48c27e3ae642f728f1" +checksum = "1d57a3e447e24c22647738e4607f1df1e0ec6f72e16182c4cd199f647cdfb0e4" dependencies = [ - "Inflector", + "heck", "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "is-terminal" -version = "0.4.12" +version = "0.4.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f23ff5ef2b80d608d61efee834934d862cd92461afc0560dedf493e4c033738b" +checksum = "e04d7f318608d35d4b61ddd75cbdaee86b023ebe2bd5a66ee0915f0bf93095a9" dependencies = [ - "hermit-abi", + "hermit-abi 0.5.1", "libc", - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] @@ -1291,6 +1457,12 @@ dependencies = [ "once_cell", ] +[[package]] +name = "is_terminal_polyfill" +version = "1.70.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf" + [[package]] name = "itertools" version = "0.10.5" @@ -1309,41 +1481,93 @@ dependencies = [ "either", ] +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + [[package]] name = "itoa" -version = "1.0.11" +version = "1.0.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c" + +[[package]] +name = "jiff" +version = "0.2.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f02000660d30638906021176af16b17498bd0d12813dbfe7b276d8bc7f3c0806" +dependencies = [ + "jiff-static", + "jiff-tzdb-platform", + "log", + "portable-atomic", + "portable-atomic-util", + "serde", + "windows-sys 0.59.0", +] + +[[package]] +name = "jiff-static" +version = "0.2.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3c30758ddd7188629c6713fc45d1188af4f44c90582311d0c8d8c9907f60c48" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "jiff-tzdb" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1283705eb0a21404d2bfd6eef2a7593d240bc42a0bdb39db0ad6fa2ec026524" + +[[package]] +name = "jiff-tzdb-platform" +version = "0.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" +checksum = "875a5a69ac2bab1a891711cf5eccbec1ce0341ea805560dcd90b7a2e925132e8" +dependencies = [ + "jiff-tzdb", +] [[package]] name = "jobserver" -version = "0.1.32" +version = "0.1.33" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "48d1dbcbbeb6a7fec7e059840aa538bd62aaccf972c7346c4d9d2059312853d0" +checksum = "38f262f097c174adebe41eb73d66ae9c06b2844fb0da69969647bbddd9b0538a" dependencies = [ + "getrandom 0.3.3", "libc", ] [[package]] name = "jod-thread" -version = "0.1.2" +version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8b23360e99b8717f20aaa4598f5a6541efbe30630039fbc7706cf954a87947ae" +checksum = "a037eddb7d28de1d0fc42411f501b53b75838d313908078d6698d064f3029b24" [[package]] name = "js-sys" -version = "0.3.72" +version = "0.3.77" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6a88f1bda2bd75b0452a14784937d796722fdebfe50df998aeb3f0b7603019a9" +checksum = "1cfaf33c695fc6e08064efbc1f72ec937429614f25eef83af942d0e227c3a28f" dependencies = [ + "once_cell", "wasm-bindgen", ] [[package]] name = "kqueue" -version = "1.0.8" +version = "1.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7447f1ca1b7b563588a205fe93dea8df60fd981423a768bc1c0ded35ed147d0c" +checksum = "eac30106d7dce88daf4a3fcb4879ea939476d5074a9b7ddd0fb97fa4bed5596a" dependencies = [ "kqueue-sys", "libc", @@ -1361,46 +1585,46 @@ dependencies = [ [[package]] name = "lazy_static" -version = "1.4.0" +version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" [[package]] name = "libc" -version = "0.2.161" +version = "0.2.172" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e9489c2807c139ffd9c1794f4af0ebe86a828db53ecdc7fea2111d0fed085d1" +checksum = "d750af042f7ef4f724306de029d18836c26c1765a54a6a3f094cbd23a7267ffa" [[package]] name = "libcst" -version = "1.5.0" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1586dd7a857d8a61a577afde1a24cc9573ff549eff092d5ce968b1ec93cc61b6" +checksum = "ad9e315e3f679e61b9095ffd5e509de78b8a4ea3bba9d772f6fb243209f808d4" dependencies = [ - "chic", + "annotate-snippets", "libcst_derive", "memchr", "paste", "peg", "regex", - "thiserror", + "thiserror 1.0.69", ] [[package]] name = "libcst_derive" -version = "1.4.0" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a2ae40017ac09cd2c6a53504cb3c871c7f2b41466eac5bc66ba63f39073b467b" +checksum = "bfa96ed35d0dccc67cf7ba49350cb86de3dcb1d072a7ab28f99117f19d874953" dependencies = [ "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "libmimalloc-sys" -version = "0.1.39" +version = "0.1.42" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "23aa6811d3bd4deb8a84dde645f943476d13b248d818edcf8ce0b2f37f036b44" +checksum = "ec9d6fac27761dabcd4ee73571cdb06b7022dc99089acbe5435691edffaac0f4" dependencies = [ "cc", "libc", @@ -1412,28 +1636,40 @@ version = "0.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", "libc", - "redox_syscall 0.5.3", + "redox_syscall", ] [[package]] -name = "linked-hash-map" -version = "0.5.6" +name = "libtest-mimic" +version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0717cef1bc8b636c6e1c1bbdefc09e6322da8a9321966e8928ef80d20f7f770f" +checksum = "cc0bda45ed5b3a2904262c1bb91e526127aa70e7ef3758aba2ef93cf896b9b58" +dependencies = [ + "clap", + "escape8259", + "termcolor", + "threadpool", +] [[package]] name = "linux-raw-sys" -version = "0.4.14" +version = "0.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "78b3ae25bc7c8c38cec158d1f2757ee79e9b3740fbc7ccf0e59e4b08d793fa89" +checksum = "cd945864f07fe9f5371a27ad7b52a172b4b499999f1d97574c9fa68373937e12" + +[[package]] +name = "litemap" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "241eaef5fd12c88705a01fc1066c48c4b36e0dd4377dcdc7ec3942cea7a69956" [[package]] name = "lock_api" -version = "0.4.11" +version = "0.4.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3c168f8615b12bc01f9c17e2eb0cc07dcae1940121185446edc3744920e8ef45" +checksum = "07af8b9cdd281b7915f413fa73f29ebd5d55d0d3f0155584dade1ff18cea1b17" dependencies = [ "autocfg", "scopeguard", @@ -1441,19 +1677,20 @@ dependencies = [ [[package]] name = "log" -version = "0.4.22" +version = "0.4.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24" +checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94" [[package]] name = "lsp-server" -version = "0.7.7" +version = "0.7.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "550446e84739dcaf6d48a4a093973850669e13e8a34d8f8d64851041be267cd9" +checksum = "9462c4dc73e17f971ec1f171d44bfffb72e65a130117233388a0ebc7ec5656f9" dependencies = [ "crossbeam-channel", "log", "serde", + "serde_derive", "serde_json", ] @@ -1469,6 +1706,15 @@ dependencies = [ "url", ] +[[package]] +name = "markdown" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a5cab8f2cadc416a82d2e783a1946388b31654d391d1c7d92cc1f03e295b1deb" +dependencies = [ + "unicode-id", +] + [[package]] name = "matchers" version = "0.1.0" @@ -1486,9 +1732,9 @@ checksum = "2532096657941c2fea9c289d370a250971c689d4f143798ff67113ec042024a5" [[package]] name = "matchit" -version = "0.8.4" +version = "0.8.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" +checksum = "2f926ade0c4e170215ae43342bf13b9310a437609c81f29f86c5df6657582ef9" [[package]] name = "memchr" @@ -1498,18 +1744,18 @@ checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" [[package]] name = "mimalloc" -version = "0.1.43" +version = "0.1.46" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "68914350ae34959d83f732418d51e2427a794055d0b9529f48259ac07af65633" +checksum = "995942f432bbb4822a7e9c3faa87a695185b0d09273ba85f097b54f4e458f2af" dependencies = [ "libmimalloc-sys", ] [[package]] name = "minicov" -version = "0.3.5" +version = "0.3.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c71e683cd655513b99affab7d317deb690528255a0d5f717f1024093c12b169" +checksum = "f27fe9f1cc3c22e1687f9446c2083c4c5fc7f0bcf1c7a86bdbded14985895b4b" dependencies = [ "cc", "walkdir", @@ -1523,23 +1769,23 @@ checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a" [[package]] name = "miniz_oxide" -version = "0.7.2" +version = "0.8.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d811f3e15f28568be3407c8e7fdb6514c1cda3cb30683f15b6a1a1dc4ea14a7" +checksum = "3be647b768db090acb35d5ec5db2b0e1f1de11133ca123b9eacf5137868f892a" dependencies = [ - "adler", + "adler2", ] [[package]] name = "mio" -version = "0.8.11" +version = "1.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4a650543ca06a924e8b371db273b2756685faae30f8487da1b56505a8f78b0c" +checksum = "2886843bf800fba2e3377cff24abf6379b4c4d5c6681eaf9ea5b0d15090450bd" dependencies = [ "libc", "log", - "wasi", - "windows-sys 0.48.0", + "wasi 0.11.0+wasi-snapshot-preview1", + "windows-sys 0.52.0", ] [[package]] @@ -1550,34 +1796,34 @@ checksum = "308d96db8debc727c3fd9744aac51751243420e46edf401010908da7f8d5e57c" [[package]] name = "newtype-uuid" -version = "1.1.0" +version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3526cb7c660872e401beaf3297f95f548ce3b4b4bdd8121b7c0713771d7c4a6e" +checksum = "ee3224f0e8be7c2a1ebc77ef9c3eecb90f55c6594399ee825de964526b3c9056" dependencies = [ "uuid", ] [[package]] name = "nix" -version = "0.28.0" +version = "0.29.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ab2156c4fce2f8df6c499cc1c763e4394b7482525bf2a9701c9d79d215f519e4" +checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", "cfg-if", - "cfg_aliases 0.1.1", + "cfg_aliases", "libc", ] [[package]] name = "nix" -version = "0.29.0" +version = "0.30.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46" +checksum = "74523f3a35e05aba87a1d978330aef40f67b0304ac79c1c00b294c9830543db6" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", "cfg-if", - "cfg_aliases 0.2.1", + "cfg_aliases", "libc", ] @@ -1591,14 +1837,19 @@ dependencies = [ "minimal-lexical", ] +[[package]] +name = "normalize-line-endings" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61807f77802ff30975e01f4f071c8ba10c022052f98b3294119f3e615d13e5be" + [[package]] name = "notify" -version = "6.1.1" +version = "8.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6205bd8bb1e454ad2e27422015fb5e4f2bcc7e08fa8f27058670d208324a4d2d" +checksum = "2fee8403b3d66ac7b26aee6e40a897d85dc5ce26f44da36b8b73e987cc52e943" dependencies = [ - "bitflags 2.6.0", - "crossbeam-channel", + "bitflags 2.9.1", "filetime", "fsevent-sys", "inotify", @@ -1606,10 +1857,17 @@ dependencies = [ "libc", "log", "mio", + "notify-types", "walkdir", - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] +[[package]] +name = "notify-types" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e0826a989adedc2a244799e823aece04662b66609d96af8dff7ac6df9a8925d" + [[package]] name = "nu-ansi-term" version = "0.46.0" @@ -1621,21 +1879,22 @@ dependencies = [ ] [[package]] -name = "nu-ansi-term" -version = "0.50.1" +name = "num-traits" +version = "0.2.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d4a28e057d01f97e61255210fcff094d74ed0466038633e95017f5beb68e4399" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" dependencies = [ - "windows-sys 0.52.0", + "autocfg", ] [[package]] -name = "num-traits" -version = "0.2.18" +name = "num_cpus" +version = "1.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da0df0e5185db44f69b44f26786fe401b6c293d1907744beaa7fa62b2e5a517a" +checksum = "4161fcb6d602d4d2081af7c3a45852d875a03dd337a6bfdd6e06407b61342a43" dependencies = [ - "autocfg", + "hermit-abi 0.3.9", + "libc", ] [[package]] @@ -1646,15 +1905,15 @@ checksum = "830b246a0e5f20af87141b25c173cd1b609bd7779a4617d6ec582abaf90870f3" [[package]] name = "once_cell" -version = "1.20.2" +version = "1.21.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1261fe7e33c73b354eab43b1273a57c8f967d0391e80353e51f764ac02cf6775" +checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d" [[package]] name = "oorandom" -version = "11.1.3" +version = "11.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0ab1bc2a289d34bd04a330323ac98a1b4bc82c9d9fcb1e66b63caa84da26b575" +checksum = "d6790f58c7ff633d8771f42965289203411a5e5c68388703c06e14f24770b41e" [[package]] name = "option-ext" @@ -1664,18 +1923,28 @@ checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" [[package]] name = "ordermap" -version = "0.5.3" +version = "0.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "31f2bd7b03bf2c767e1bb7b91505dbe022833776e60480275e6f2fb0db0c7503" +checksum = "7d31b8b7a99f71bdff4235faf9ce9eada0ad3562c8fbeb7d607d9f41a6ec569d" dependencies = [ "indexmap", ] +[[package]] +name = "os_pipe" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ffd2b0a5634335b135d5728d84c5e0fd726954b87111f7506a61c502280d982" +dependencies = [ + "libc", + "windows-sys 0.59.0", +] + [[package]] name = "os_str_bytes" -version = "7.0.0" +version = "7.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ac44c994af577c799b1b4bd80dc214701e349873ad894d6cdf96f4f7526e0b9" +checksum = "c86e2db86dd008b4c88c77a9bb83d9286bf77204e255bb3fda3b2eebcae66b62" dependencies = [ "memchr", ] @@ -1698,15 +1967,15 @@ dependencies = [ [[package]] name = "parking_lot_core" -version = "0.9.9" +version = "0.9.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4c42a9226546d68acdd9c0a280d17ce19bfe27a46bf68784e4066115788d008e" +checksum = "1e401f977ab385c9e4e3ab30627d6f26d00e2c73eef317493c4ec6d468726cf8" dependencies = [ "cfg-if", "libc", - "redox_syscall 0.4.1", + "redox_syscall", "smallvec", - "windows-targets 0.48.5", + "windows-targets", ] [[package]] @@ -1741,15 +2010,15 @@ checksum = "1e91099d4268b0e11973f036e885d652fb0b21fedcf69738c627f94db6a44f42" [[package]] name = "pathdiff" -version = "0.2.2" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d61c5ce1153ab5b689d0c074c4e7fc613e942dfb7dd9eea5ab202d2ad91fe361" +checksum = "df94ce210e5bc13cb6651479fa48d14f601d9858cfe0467f43ae157023b938d3" [[package]] name = "peg" -version = "0.8.4" +version = "0.8.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "295283b02df346d1ef66052a757869b2876ac29a6bb0ac3f5f7cd44aebe40e8f" +checksum = "9928cfca101b36ec5163e70049ee5368a8a1c3c6efc9ca9c5f9cc2f816152477" dependencies = [ "peg-macros", "peg-runtime", @@ -1757,9 +2026,9 @@ dependencies = [ [[package]] name = "peg-macros" -version = "0.8.4" +version = "0.8.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bdad6a1d9cf116a059582ce415d5f5566aabcd4008646779dab7fdc2a9a9d426" +checksum = "6298ab04c202fa5b5d52ba03269fb7b74550b150323038878fe6c372d8280f71" dependencies = [ "peg-runtime", "proc-macro2", @@ -1768,47 +2037,43 @@ dependencies = [ [[package]] name = "peg-runtime" -version = "0.8.3" +version = "0.8.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e3aeb8f54c078314c2065ee649a7241f46b9d8e418e1a9581ba0546657d7aa3a" +checksum = "132dca9b868d927b35b5dd728167b2dee150eb1ad686008fc71ccb298b776fca" [[package]] name = "pep440_rs" -version = "0.4.0" +version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e0c29f9c43de378b4e4e0cd7dbcce0e5cfb80443de8c05620368b2948bc936a1" +checksum = "31095ca1f396e3de32745f42b20deef7bc09077f918b085307e8eab6ddd8fb9c" dependencies = [ "once_cell", - "regex", - "serde", - "unicode-width 0.1.13", -] - -[[package]] -name = "pep440_rs" -version = "0.7.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7c8ee724d21f351f9d47276614ac9710975db827ba9fe2ca5a517ba648193307" -dependencies = [ "serde", "unicode-width 0.2.0", "unscanny", + "version-ranges", ] [[package]] name = "pep508_rs" -version = "0.3.0" +version = "0.9.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "910c513bea0f4f833122321c0f20e8c704e01de98692f6989c2ec21f43d88b1e" +checksum = "faee7227064121fcadcd2ff788ea26f0d8f2bd23a0574da11eca23bc935bcc05" dependencies = [ + "boxcar", + "indexmap", + "itertools 0.13.0", "once_cell", - "pep440_rs 0.4.0", + "pep440_rs", "regex", + "rustc-hash 2.1.1", "serde", - "thiserror", - "tracing", - "unicode-width 0.1.13", + "smallvec", + "thiserror 1.0.69", + "unicode-width 0.2.0", "url", + "urlencoding", + "version-ranges", ] [[package]] @@ -1819,20 +2084,20 @@ checksum = "e3148f5046208a5d56bcfc03053e3ca6334e51da8dfb19b6cdc8b306fae3283e" [[package]] name = "pest" -version = "2.7.11" +version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cd53dff83f26735fdc1ca837098ccf133605d794cdae66acfc2bfac3ec809d95" +checksum = "198db74531d58c70a361c42201efde7e2591e976d518caf7662a47dc5720e7b6" dependencies = [ "memchr", - "thiserror", + "thiserror 2.0.12", "ucd-trie", ] [[package]] name = "pest_derive" -version = "2.7.11" +version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2a548d2beca6773b1c244554d36fcf8548a8a58e74156968211567250e48e49a" +checksum = "d725d9cfd79e87dccc9341a2ef39d1b6f6353d68c4b33c177febbe1a402c97c5" dependencies = [ "pest", "pest_generator", @@ -1840,22 +2105,22 @@ dependencies = [ [[package]] name = "pest_generator" -version = "2.7.11" +version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3c93a82e8d145725dcbaf44e5ea887c8a869efdcc28706df2d08c69e17077183" +checksum = "db7d01726be8ab66ab32f9df467ae8b1148906685bbe75c82d1e65d7f5b3f841" dependencies = [ "pest", "pest_meta", "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "pest_meta" -version = "2.7.11" +version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a941429fea7e08bedec25e4f6785b6ffaacc6b755da98df5ef3e7dcf4a124c4f" +checksum = "7f9f832470494906d1fca5329f8ab5791cc60beb230c74815dff541cbd2b5ca0" dependencies = [ "once_cell", "pest", @@ -1864,18 +2129,18 @@ dependencies = [ [[package]] name = "phf" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc" +checksum = "1fd6780a80ae0c52cc120a26a1a42c1ae51b247a253e4e06113d23d2c2edd078" dependencies = [ "phf_shared", ] [[package]] name = "phf_codegen" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e8d39688d359e6b34654d328e262234662d16cc0f60ec8dcbe5e718709342a5a" +checksum = "aef8048c789fa5e851558d709946d6d79a8ff88c0440c587967f8e94bfb1216a" dependencies = [ "phf_generator", "phf_shared", @@ -1883,52 +2148,73 @@ dependencies = [ [[package]] name = "phf_generator" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "48e4cc64c2ad9ebe670cb8fd69dd50ae301650392e81c05f9bfcb2d5bdbc24b0" +checksum = "3c80231409c20246a13fddb31776fb942c38553c51e871f8cbd687a4cfb5843d" dependencies = [ "phf_shared", - "rand", + "rand 0.8.5", ] [[package]] name = "phf_shared" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90fcb95eef784c2ac79119d1dd819e162b5da872ce6f3c3abe1e8ca1c082f72b" +checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5" dependencies = [ "siphasher", ] [[package]] name = "pin-project-lite" -version = "0.2.14" +version = "0.2.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bda66fc9667c18cb2758a2ac84d1167245054bcf85d5d1aaa6923f45801bdd02" +checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b" [[package]] name = "pkg-config" -version = "0.3.30" +version = "0.3.32" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec" +checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c" [[package]] name = "portable-atomic" -version = "1.6.0" +version = "1.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "350e9b48cbc6b0e028b0473b114454c6316e57336ee184ceab6e53f72c178b3e" + +[[package]] +name = "portable-atomic-util" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8a2f0d8d040d7848a709caf78912debcc3f33ee4b3cac47d73d1e1069e83507" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7170ef9988bc169ba16dd36a7fa041e5c4cbeb6a35b76d4c03daded371eae7c0" +checksum = "e5a7c30837279ca13e7c867e9e40053bc68740f988cb07f7ca6df43cc734b585" +dependencies = [ + "zerovec", +] [[package]] name = "ppv-lite86" -version = "0.2.17" +version = "0.2.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy", +] [[package]] name = "predicates" -version = "3.1.2" +version = "3.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e9086cc7640c29a356d1a29fd134380bee9d8f79a17410aa76e7ad295f42c97" +checksum = "a5d19ee57562043d37e82899fade9a22ebab7be9cef5026b07fda9cdd4293573" dependencies = [ "anstyle", "difflib", @@ -1937,15 +2223,15 @@ dependencies = [ [[package]] name = "predicates-core" -version = "1.0.8" +version = "1.0.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae8177bee8e75d6846599c6b9ff679ed51e882816914eec639944d7c9aa11931" +checksum = "727e462b119fe9c93fd0eb1429a5f7647394014cf3c04ab2c0350eeb09095ffa" [[package]] name = "predicates-tree" -version = "1.0.11" +version = "1.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "41b740d195ed3166cd147c8047ec98db0e22ec019eb8eeb76d343b795304fb13" +checksum = "72dd2d6d381dfb73a193c7fca536518d7caee39fc8503f74e7dc0be0531b425c" dependencies = [ "predicates-core", "termtree", @@ -1963,59 +2249,86 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.89" +version = "1.0.95" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f139b0662de085916d1fb67d2b4169d1addddda1919e696f3252b740b629986e" +checksum = "02b3e5e68a3a1a02aad3ec490a98007cbc13c37cbe84a3cd7b8e406d76e7f778" dependencies = [ "unicode-ident", ] [[package]] name = "pyproject-toml" -version = "0.9.0" +version = "0.13.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "95c3dd745f99aa3c554b7bb00859f7d18c2f1d6afd749ccc86d60b61e702abd9" +checksum = "643af57c3f36ba90a8b53e972727d8092f7408a9ebfbaf4c3d2c17b07c58d835" dependencies = [ "indexmap", - "pep440_rs 0.4.0", + "pep440_rs", "pep508_rs", "serde", + "thiserror 1.0.69", "toml", ] [[package]] name = "quick-junit" -version = "0.5.0" +version = "0.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "62ffd2f9a162cfae131bed6d9d1ed60adced33be340a94f96952897d7cb0c240" +checksum = "3ed1a693391a16317257103ad06a88c6529ac640846021da7c435a06fffdacd7" dependencies = [ "chrono", "indexmap", "newtype-uuid", "quick-xml", "strip-ansi-escapes", - "thiserror", + "thiserror 2.0.12", "uuid", ] [[package]] name = "quick-xml" -version = "0.36.1" +version = "0.37.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "96a05e2e8efddfa51a84ca47cec303fac86c8541b686d37cac5efc0e094417bc" +checksum = "331e97a1af0bf59823e6eadffe373d7b27f485be8748f71471c662c1f269b7fb" dependencies = [ "memchr", ] +[[package]] +name = "quickcheck" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "588f6378e4dd99458b60ec275b4477add41ce4fa9f64dcba6f15adccb19b50d6" +dependencies = [ + "rand 0.8.5", +] + +[[package]] +name = "quickcheck_macros" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f71ee38b42f8459a88d3362be6f9b841ad2d5421844f61eb1c59c11bff3ac14a" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "quote" -version = "1.0.37" +version = "1.0.40" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af" +checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d" dependencies = [ "proc-macro2", ] +[[package]] +name = "r-efi" +version = "5.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "74765f6d916ee2faa39bc8e68e4f3ed8949b48cccdac59983d287a7cb71ce9c5" + [[package]] name = "rand" version = "0.8.5" @@ -2023,8 +2336,18 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404" dependencies = [ "libc", - "rand_chacha", - "rand_core", + "rand_chacha 0.3.1", + "rand_core 0.6.4", +] + +[[package]] +name = "rand" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fbfd9d094a40bf3ae768db9361049ace4c0e04a4fd6b359518bd7b73a73dd97" +dependencies = [ + "rand_chacha 0.9.0", + "rand_core 0.9.3", ] [[package]] @@ -2034,7 +2357,17 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" dependencies = [ "ppv-lite86", - "rand_core", + "rand_core 0.6.4", +] + +[[package]] +name = "rand_chacha" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" +dependencies = [ + "ppv-lite86", + "rand_core 0.9.3", ] [[package]] @@ -2043,14 +2376,23 @@ version = "0.6.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" dependencies = [ - "getrandom", + "getrandom 0.2.16", ] [[package]] -name = "rayon" -version = "1.10.0" +name = "rand_core" +version = "0.9.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b418a60154510ca1a002a752ca9714984e21e4241e804d32555251faf8b78ffa" +checksum = "99d9a13982dcf210057a8a78572b2217b667c3beacbf3a0d8b454f6f82837d38" +dependencies = [ + "getrandom 0.3.3", +] + +[[package]] +name = "rayon" +version = "1.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b418a60154510ca1a002a752ca9714984e21e4241e804d32555251faf8b78ffa" dependencies = [ "either", "rayon-core", @@ -2066,183 +2408,24 @@ dependencies = [ "crossbeam-utils", ] -[[package]] -name = "red_knot" -version = "0.0.0" -dependencies = [ - "anyhow", - "chrono", - "clap", - "colored", - "countme", - "crossbeam", - "ctrlc", - "filetime", - "rayon", - "red_knot_python_semantic", - "red_knot_server", - "red_knot_workspace", - "ruff_db", - "salsa", - "tempfile", - "tracing", - "tracing-flame", - "tracing-subscriber", - "tracing-tree", -] - -[[package]] -name = "red_knot_python_semantic" -version = "0.0.0" -dependencies = [ - "anyhow", - "bitflags 2.6.0", - "camino", - "compact_str", - "countme", - "dir-test", - "hashbrown 0.15.0", - "insta", - "itertools 0.13.0", - "memchr", - "ordermap", - "red_knot_test", - "red_knot_vendored", - "ruff_db", - "ruff_index", - "ruff_python_ast", - "ruff_python_literal", - "ruff_python_parser", - "ruff_python_stdlib", - "ruff_source_file", - "ruff_text_size", - "rustc-hash 2.0.0", - "salsa", - "smallvec", - "static_assertions", - "tempfile", - "test-case", - "thiserror", - "tracing", -] - -[[package]] -name = "red_knot_server" -version = "0.0.0" -dependencies = [ - "anyhow", - "crossbeam", - "jod-thread", - "libc", - "lsp-server", - "lsp-types", - "red_knot_workspace", - "ruff_db", - "ruff_notebook", - "ruff_python_ast", - "ruff_source_file", - "ruff_text_size", - "rustc-hash 2.0.0", - "serde", - "serde_json", - "shellexpand", - "tracing", - "tracing-subscriber", -] - -[[package]] -name = "red_knot_test" -version = "0.0.0" -dependencies = [ - "anyhow", - "colored", - "memchr", - "red_knot_python_semantic", - "red_knot_vendored", - "regex", - "ruff_db", - "ruff_index", - "ruff_python_trivia", - "ruff_source_file", - "ruff_text_size", - "rustc-hash 2.0.0", - "salsa", - "smallvec", -] - -[[package]] -name = "red_knot_vendored" -version = "0.0.0" -dependencies = [ - "path-slash", - "ruff_db", - "walkdir", - "zip", -] - -[[package]] -name = "red_knot_wasm" -version = "0.0.0" -dependencies = [ - "console_error_panic_hook", - "console_log", - "js-sys", - "log", - "red_knot_python_semantic", - "red_knot_workspace", - "ruff_db", - "ruff_notebook", - "wasm-bindgen", - "wasm-bindgen-test", -] - -[[package]] -name = "red_knot_workspace" -version = "0.0.0" -dependencies = [ - "anyhow", - "crossbeam", - "notify", - "rayon", - "red_knot_python_semantic", - "red_knot_vendored", - "ruff_cache", - "ruff_db", - "ruff_python_ast", - "ruff_text_size", - "rustc-hash 2.0.0", - "salsa", - "tempfile", - "tracing", -] - -[[package]] -name = "redox_syscall" -version = "0.4.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4722d768eff46b75989dd134e5c353f0d6296e5aaa3132e776cbdb56be7731aa" -dependencies = [ - "bitflags 1.3.2", -] - [[package]] name = "redox_syscall" -version = "0.5.3" +version = "0.5.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2a908a6e00f1fdd0dfd9c0eb08ce85126f6d8bbda50017e74bc4a4b7d4a926a4" +checksum = "928fca9cf2aa042393a8325b9ead81d2f0df4cb12e1e24cef072922ccd99c5af" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", ] [[package]] name = "redox_users" -version = "0.4.5" +version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bd283d9651eeda4b2a83a43c1c91b266c40fd76ecd39a50a8c630ae69dc72891" +checksum = "dd6f9d3d47bdd2ad6945c5015a226ec6155d0bcdfd8f7cd29f86b71f8de99d2b" dependencies = [ - "getrandom", + "getrandom 0.2.16", "libredox", - "thiserror", + "thiserror 2.0.12", ] [[package]] @@ -2253,7 +2436,7 @@ checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191" dependencies = [ "aho-corasick", "memchr", - "regex-automata 0.4.8", + "regex-automata 0.4.9", "regex-syntax 0.8.5", ] @@ -2268,9 +2451,9 @@ dependencies = [ [[package]] name = "regex-automata" -version = "0.4.8" +version = "0.4.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "368758f23274712b504848e9d5a6f010445cc8b87a7cdb4d7cbee666c1288da3" +checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908" dependencies = [ "aho-corasick", "memchr", @@ -2290,35 +2473,30 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c" [[package]] -name = "ring" -version = "0.17.8" +name = "ron" +version = "0.7.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c17fa4cb658e3583423e915b9f3acc01cceaee1860e33d59ebae66adc3a2dc0d" +checksum = "88073939a61e5b7680558e6be56b419e208420c2adb92be54921fa6b72283f1a" dependencies = [ - "cc", - "cfg-if", - "getrandom", - "libc", - "spin", - "untrusted", - "windows-sys 0.52.0", + "base64", + "bitflags 1.3.2", + "serde", ] [[package]] name = "ruff" -version = "0.7.1" +version = "0.11.10" dependencies = [ "anyhow", "argfile", "assert_fs", "bincode", - "bitflags 2.6.0", + "bitflags 2.9.1", "cachedir", - "chrono", "clap", "clap_complete_command", "clearscreen", - "colored", + "colored 3.0.0", "filetime", "globwalk", "ignore", @@ -2326,7 +2504,8 @@ dependencies = [ "insta", "insta-cmd", "is-macro", - "itertools 0.13.0", + "itertools 0.14.0", + "jiff", "log", "mimalloc", "notify", @@ -2340,20 +2519,22 @@ dependencies = [ "ruff_linter", "ruff_macros", "ruff_notebook", + "ruff_options_metadata", "ruff_python_ast", "ruff_python_formatter", + "ruff_python_parser", "ruff_server", "ruff_source_file", "ruff_text_size", "ruff_workspace", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "serde", "serde_json", "shellexpand", "strum", "tempfile", "test-case", - "thiserror", + "thiserror 2.0.12", "tikv-jemallocator", "toml", "tracing", @@ -2361,6 +2542,21 @@ dependencies = [ "wild", ] +[[package]] +name = "ruff_annotate_snippets" +version = "0.1.0" +dependencies = [ + "anstream", + "anstyle", + "memchr", + "ruff_annotate_snippets", + "serde", + "snapbox", + "toml", + "tryfn", + "unicode-width 0.2.0", +] + [[package]] name = "ruff_benchmark" version = "0.0.0" @@ -2369,20 +2565,15 @@ dependencies = [ "criterion", "mimalloc", "rayon", - "red_knot_python_semantic", - "red_knot_workspace", "ruff_db", "ruff_linter", "ruff_python_ast", "ruff_python_formatter", "ruff_python_parser", "ruff_python_trivia", - "rustc-hash 2.0.0", - "serde", - "serde_json", + "rustc-hash 2.1.1", "tikv-jemallocator", - "ureq", - "url", + "ty_project", ] [[package]] @@ -2392,7 +2583,7 @@ dependencies = [ "filetime", "glob", "globset", - "itertools 0.13.0", + "itertools 0.14.0", "regex", "ruff_macros", "seahash", @@ -2402,14 +2593,19 @@ dependencies = [ name = "ruff_db" version = "0.0.0" dependencies = [ + "anstyle", "camino", "countme", "dashmap 6.1.0", + "dunce", + "etcetera", "filetime", + "glob", "ignore", "insta", "matchit", "path-slash", + "ruff_annotate_snippets", "ruff_cache", "ruff_notebook", "ruff_python_ast", @@ -2417,14 +2613,14 @@ dependencies = [ "ruff_python_trivia", "ruff_source_file", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "salsa", + "schemars", "serde", "tempfile", - "thiserror", + "thiserror 2.0.12", "tracing", "tracing-subscriber", - "tracing-tree", "web-time", "zip", ] @@ -2439,8 +2635,9 @@ dependencies = [ "imara-diff", "indicatif", "indoc", - "itertools 0.13.0", + "itertools 0.14.0", "libcst", + "markdown", "pretty_assertions", "rayon", "regex", @@ -2449,6 +2646,7 @@ dependencies = [ "ruff_formatter", "ruff_linter", "ruff_notebook", + "ruff_options_metadata", "ruff_python_ast", "ruff_python_codegen", "ruff_python_formatter", @@ -2465,6 +2663,9 @@ dependencies = [ "tracing", "tracing-indicatif", "tracing-subscriber", + "ty", + "ty_project", + "url", ] [[package]] @@ -2486,12 +2687,12 @@ dependencies = [ "ruff_cache", "ruff_macros", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "schemars", "serde", "static_assertions", "tracing", - "unicode-width 0.1.13", + "unicode-width 0.2.0", ] [[package]] @@ -2500,7 +2701,6 @@ version = "0.1.0" dependencies = [ "anyhow", "clap", - "red_knot_python_semantic", "ruff_cache", "ruff_db", "ruff_linter", @@ -2510,6 +2710,7 @@ dependencies = [ "salsa", "schemars", "serde", + "ty_python_semantic", "zip", ] @@ -2518,20 +2719,19 @@ name = "ruff_index" version = "0.0.0" dependencies = [ "ruff_macros", + "salsa", "static_assertions", ] [[package]] name = "ruff_linter" -version = "0.7.1" +version = "0.11.10" dependencies = [ "aho-corasick", - "annotate-snippets 0.9.2", "anyhow", - "bitflags 2.6.0", - "chrono", + "bitflags 2.9.1", "clap", - "colored", + "colored 3.0.0", "fern", "glob", "globset", @@ -2539,18 +2739,21 @@ dependencies = [ "insta", "is-macro", "is-wsl", - "itertools 0.13.0", + "itertools 0.14.0", + "jiff", "libcst", "log", "memchr", "natord", "path-absolutize", "pathdiff", - "pep440_rs 0.7.1", + "pep440_rs", "pyproject-toml", "quick-junit", "regex", + "ruff_annotate_snippets", "ruff_cache", + "ruff_db", "ruff_diagnostics", "ruff_macros", "ruff_notebook", @@ -2564,7 +2767,7 @@ dependencies = [ "ruff_python_trivia", "ruff_source_file", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "schemars", "serde", "serde_json", @@ -2572,12 +2775,13 @@ dependencies = [ "smallvec", "strum", "strum_macros", + "tempfile", "test-case", - "thiserror", + "thiserror 2.0.12", "toml", "typed-arena", "unicode-normalization", - "unicode-width 0.1.13", + "unicode-width 0.2.0", "unicode_names2", "url", ] @@ -2586,11 +2790,12 @@ dependencies = [ name = "ruff_macros" version = "0.0.0" dependencies = [ - "itertools 0.13.0", + "heck", + "itertools 0.14.0", "proc-macro2", "quote", "ruff_python_trivia", - "syn 2.0.85", + "syn", ] [[package]] @@ -2598,8 +2803,8 @@ name = "ruff_notebook" version = "0.0.0" dependencies = [ "anyhow", - "itertools 0.13.0", - "rand", + "itertools 0.14.0", + "rand 0.9.1", "ruff_diagnostics", "ruff_source_file", "ruff_text_size", @@ -2607,26 +2812,34 @@ dependencies = [ "serde_json", "serde_with", "test-case", - "thiserror", + "thiserror 2.0.12", "uuid", ] +[[package]] +name = "ruff_options_metadata" +version = "0.0.0" +dependencies = [ + "serde", +] + [[package]] name = "ruff_python_ast" version = "0.0.0" dependencies = [ "aho-corasick", - "bitflags 2.6.0", + "bitflags 2.9.1", "compact_str", "is-macro", - "itertools 0.13.0", + "itertools 0.14.0", "memchr", "ruff_cache", "ruff_macros", "ruff_python_trivia", "ruff_source_file", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", + "salsa", "schemars", "serde", ] @@ -2651,6 +2864,7 @@ dependencies = [ "ruff_python_parser", "ruff_source_file", "ruff_text_size", + "test-case", ] [[package]] @@ -2661,10 +2875,11 @@ dependencies = [ "clap", "countme", "insta", - "itertools 0.13.0", + "itertools 0.14.0", "memchr", "regex", "ruff_cache", + "ruff_db", "ruff_formatter", "ruff_macros", "ruff_python_ast", @@ -2672,14 +2887,15 @@ dependencies = [ "ruff_python_trivia", "ruff_source_file", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", + "salsa", "schemars", "serde", "serde_json", "similar", "smallvec", "static_assertions", - "thiserror", + "thiserror 2.0.12", "tracing", ] @@ -2698,8 +2914,8 @@ dependencies = [ name = "ruff_python_literal" version = "0.0.0" dependencies = [ - "bitflags 2.6.0", - "itertools 0.13.0", + "bitflags 2.9.1", + "itertools 0.14.0", "ruff_python_ast", "unic-ucd-category", ] @@ -2708,18 +2924,20 @@ dependencies = [ name = "ruff_python_parser" version = "0.0.0" dependencies = [ - "annotate-snippets 0.9.2", "anyhow", - "bitflags 2.6.0", + "bitflags 2.9.1", "bstr", "compact_str", "insta", "memchr", + "ruff_annotate_snippets", "ruff_python_ast", "ruff_python_trivia", "ruff_source_file", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", + "serde", + "serde_json", "static_assertions", "unicode-ident", "unicode-normalization", @@ -2741,7 +2959,8 @@ dependencies = [ name = "ruff_python_semantic" version = "0.0.0" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", + "insta", "is-macro", "ruff_cache", "ruff_index", @@ -2750,15 +2969,18 @@ dependencies = [ "ruff_python_parser", "ruff_python_stdlib", "ruff_text_size", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "schemars", "serde", + "smallvec", + "test-case", ] [[package]] name = "ruff_python_stdlib" version = "0.0.0" dependencies = [ + "bitflags 2.9.1", "unicode-ident", ] @@ -2766,7 +2988,7 @@ dependencies = [ name = "ruff_python_trivia" version = "0.0.0" dependencies = [ - "itertools 0.13.0", + "itertools 0.14.0", "ruff_source_file", "ruff_text_size", "unicode-ident", @@ -2807,12 +3029,14 @@ dependencies = [ "ruff_source_file", "ruff_text_size", "ruff_workspace", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "serde", "serde_json", "shellexpand", - "thiserror", + "thiserror 2.0.12", + "toml", "tracing", + "tracing-log", "tracing-subscriber", ] @@ -2837,10 +3061,11 @@ dependencies = [ [[package]] name = "ruff_wasm" -version = "0.7.1" +version = "0.11.10" dependencies = [ "console_error_panic_hook", "console_log", + "getrandom 0.3.3", "js-sys", "log", "ruff_formatter", @@ -2865,29 +3090,32 @@ name = "ruff_workspace" version = "0.0.0" dependencies = [ "anyhow", - "colored", + "colored 3.0.0", "etcetera", "glob", "globset", "ignore", + "indexmap", "is-macro", - "itertools 0.13.0", + "itertools 0.14.0", "log", "matchit", "path-absolutize", "path-slash", - "pep440_rs 0.7.1", + "pep440_rs", "regex", "ruff_cache", "ruff_formatter", "ruff_graph", "ruff_linter", "ruff_macros", + "ruff_options_metadata", "ruff_python_ast", "ruff_python_formatter", "ruff_python_semantic", + "ruff_python_stdlib", "ruff_source_file", - "rustc-hash 2.0.0", + "rustc-hash 2.1.1", "schemars", "serde", "shellexpand", @@ -2914,101 +3142,78 @@ checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2" [[package]] name = "rustc-hash" -version = "2.0.0" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "357703d41365b4b27c590e3ed91eabb1b663f07c4c084095e60cbed4362dff0d" + +[[package]] +name = "rustc-stable-hash" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "583034fd73374156e66797ed8e5b0d5690409c9226b22d87cb7f19821c05d152" +checksum = "781442f29170c5c93b7185ad559492601acdc71d5bb0706f5868094f45cfcd08" [[package]] name = "rustix" -version = "0.38.37" +version = "1.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8acb788b847c24f28525660c4d7758620a7210875711f79e7f663cc152726811" +checksum = "c71e83d6afe7ff64890ec6b71d6a69bb8a610ab78ce364b3352876bb4c801266" dependencies = [ - "bitflags 2.6.0", + "bitflags 2.9.1", "errno", "libc", "linux-raw-sys", - "windows-sys 0.52.0", -] - -[[package]] -name = "rustls" -version = "0.23.10" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "05cff451f60db80f490f3c182b77c35260baace73209e9cdbbe526bfe3a4d402" -dependencies = [ - "log", - "once_cell", - "ring", - "rustls-pki-types", - "rustls-webpki", - "subtle", - "zeroize", -] - -[[package]] -name = "rustls-pki-types" -version = "1.7.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "976295e77ce332211c0d24d92c0e83e50f5c5f046d11082cea19f3df13a3562d" - -[[package]] -name = "rustls-webpki" -version = "0.102.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f9a6fccd794a42c2c105b513a2f62bc3fd8f3ba57a4593677ceb0bd035164d78" -dependencies = [ - "ring", - "rustls-pki-types", - "untrusted", + "windows-sys 0.59.0", ] [[package]] name = "rustversion" -version = "1.0.15" +version = "1.0.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "80af6f9131f277a45a3fba6ce8e2258037bb0477a67e610d3c1fe046ab31de47" +checksum = "eded382c5f5f786b989652c49544c4877d9f015cc22e145a5ea8ea66c2921cd2" [[package]] name = "ryu" -version = "1.0.17" +version = "1.0.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e86697c916019a8588c99b5fac3cead74ec0b4b819707a682fd4d23fa0ce1ba1" +checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f" [[package]] name = "salsa" -version = "0.18.0" -source = "git+https://github.com/salsa-rs/salsa.git?rev=254c749b02cde2fd29852a7463a33e800b771758#254c749b02cde2fd29852a7463a33e800b771758" +version = "0.21.1" +source = "git+https://github.com/salsa-rs/salsa.git?rev=4818b15f3b7516555d39f5a41cb75970448bee4c#4818b15f3b7516555d39f5a41cb75970448bee4c" dependencies = [ - "append-only-vec", - "arc-swap", - "crossbeam", + "boxcar", + "compact_str", + "crossbeam-queue", "dashmap 6.1.0", + "hashbrown 0.15.3", "hashlink", "indexmap", - "lazy_static", "parking_lot", - "rustc-hash 2.0.0", + "portable-atomic", + "rayon", + "rustc-hash 2.1.1", "salsa-macro-rules", "salsa-macros", "smallvec", + "thin-vec", "tracing", ] [[package]] name = "salsa-macro-rules" -version = "0.1.0" -source = "git+https://github.com/salsa-rs/salsa.git?rev=254c749b02cde2fd29852a7463a33e800b771758#254c749b02cde2fd29852a7463a33e800b771758" +version = "0.21.1" +source = "git+https://github.com/salsa-rs/salsa.git?rev=4818b15f3b7516555d39f5a41cb75970448bee4c#4818b15f3b7516555d39f5a41cb75970448bee4c" [[package]] name = "salsa-macros" -version = "0.18.0" -source = "git+https://github.com/salsa-rs/salsa.git?rev=254c749b02cde2fd29852a7463a33e800b771758#254c749b02cde2fd29852a7463a33e800b771758" +version = "0.21.1" +source = "git+https://github.com/salsa-rs/salsa.git?rev=4818b15f3b7516555d39f5a41cb75970448bee4c#4818b15f3b7516555d39f5a41cb75970448bee4c" dependencies = [ "heck", "proc-macro2", "quote", - "syn 2.0.85", + "syn", "synstructure", ] @@ -3023,9 +3228,9 @@ dependencies = [ [[package]] name = "schemars" -version = "0.8.21" +version = "0.8.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09c024468a378b7e36765cd36702b7a90cc3cba11654f6685c8f233408e89e92" +checksum = "3fbf2ae1b8bc8e02df939598064d22402220cd5bbcca1c76f7d6a310974d5615" dependencies = [ "dyn-clone", "schemars_derive", @@ -3035,22 +3240,16 @@ dependencies = [ [[package]] name = "schemars_derive" -version = "0.8.21" +version = "0.8.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1eee588578aff73f856ab961cd2f79e36bc45d7ded33a7562adba4667aecc0e" +checksum = "32e265784ad618884abaea0600a9adf15393368d840e0222d101a072f3f7534d" dependencies = [ "proc-macro2", "quote", "serde_derive_internals", - "syn 2.0.85", + "syn", ] -[[package]] -name = "scoped-tls" -version = "1.0.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294" - [[package]] name = "scopeguard" version = "1.2.0" @@ -3065,9 +3264,9 @@ checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b" [[package]] name = "serde" -version = "1.0.213" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3ea7893ff5e2466df8d720bb615088341b295f849602c6956047f8f80f0e9bc1" +checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6" dependencies = [ "serde_derive", ] @@ -3085,31 +3284,31 @@ dependencies = [ [[package]] name = "serde_derive" -version = "1.0.213" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e85ad2009c50b58e87caa8cd6dac16bdf511bbfb7af6c33df902396aa480fa5" +checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "serde_derive_internals" -version = "0.29.0" +version = "0.29.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "330f01ce65a3a5fe59a60c82f3c9a024b573b8a6e875bd233fe5f934e71d54e3" +checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "serde_json" -version = "1.0.132" +version = "1.0.140" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d726bfaff4b320266d395898905d0eba0345aae23b54aee3a737e260fd46db03" +checksum = "20068b6e96dc6c9bd23e01df8827e6c7e1f2fddd43c21810382803c136b99373" dependencies = [ "itoa", "memchr", @@ -3119,20 +3318,20 @@ dependencies = [ [[package]] name = "serde_repr" -version = "0.1.19" +version = "0.1.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6c64451ba24fc7a6a2d60fc75dd9c83c90903b19028d4eff35e88fc1e86564e9" +checksum = "175ee3e80ae9982737ca543e96133087cbd9a485eecc3bc4de9c1a37b47ea59c" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "serde_spanned" -version = "0.6.7" +version = "0.6.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eb5b1b31579f3811bf615c144393417496f152e12ac8b7663bf664f4a815306d" +checksum = "87607cb1398ed59d48732e575a4c28a7a8ebf2454b964fe3f224f2afc07909e1" dependencies = [ "serde", ] @@ -3148,9 +3347,9 @@ dependencies = [ [[package]] name = "serde_with" -version = "3.11.0" +version = "3.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e28bdad6db2b8340e449f7108f020b3b092e8583a9e3fb82713e1d4e71fe817" +checksum = "d6b6f7f2fcb69f747921f79f3926bd1e203fce4fef62c268dd3abfb6d86029aa" dependencies = [ "serde", "serde_derive", @@ -3159,21 +3358,21 @@ dependencies = [ [[package]] name = "serde_with_macros" -version = "3.11.0" +version = "3.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d846214a9854ef724f3da161b426242d8de7c1fc7de2f89bb1efcb154dca79d" +checksum = "8d00caa5193a3c8362ac2b73be6b9e768aa5a4b2f721d8f4b339600c3cb51f8e" dependencies = [ "darling", "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "sha2" -version = "0.10.8" +version = "0.10.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "793db75ad2bcafc3ffa7c68b215fee268f537982cd901d132f89c6343f3a3dc8" +checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283" dependencies = [ "cfg-if", "cpufeatures", @@ -3191,36 +3390,71 @@ dependencies = [ [[package]] name = "shellexpand" -version = "3.1.0" +version = "3.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da03fa3b94cc19e3ebfc88c4229c49d8f08cdbd1228870a45f0ffdf84988e14b" +checksum = "8b1fdf65dd6331831494dd616b30351c38e96e45921a27745cf98490458b90bb" dependencies = [ - "dirs 5.0.1", + "dirs", ] [[package]] -name = "similar" -version = "2.5.0" +name = "shlex" +version = "1.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fa42c91313f1d05da9b26f267f931cf178d4aba455b4c4622dd7355eb80c6640" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" [[package]] -name = "siphasher" -version = "0.3.11" +name = "similar" +version = "2.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d" +checksum = "bbbb5d9659141646ae647b42fe094daf6c6192d1620870b449d9557f748b2daa" + +[[package]] +name = "siphasher" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d" [[package]] name = "smallvec" -version = "1.13.2" +version = "1.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67" +checksum = "8917285742e9f3e1683f0a9c4e6b57960b7314d0b08d30d1ecd426713ee2eee9" [[package]] -name = "spin" -version = "0.9.8" +name = "snapbox" +version = "0.6.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67" +checksum = "96dcfc4581e3355d70ac2ee14cfdf81dce3d85c85f1ed9e2c1d3013f53b3436b" +dependencies = [ + "anstream", + "anstyle", + "anstyle-svg", + "escargot", + "libc", + "normalize-line-endings", + "os_pipe", + "serde_json", + "similar", + "snapbox-macros", + "wait-timeout", + "windows-sys 0.59.0", +] + +[[package]] +name = "snapbox-macros" +version = "0.3.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16569f53ca23a41bb6f62e0a5084aa1661f4814a67fa33696a79073e03a664af" +dependencies = [ + "anstream", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3" [[package]] name = "static_assertions" @@ -3230,19 +3464,13 @@ checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" [[package]] name = "strip-ansi-escapes" -version = "0.2.0" +version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "55ff8ef943b384c414f54aefa961dd2bd853add74ec75e7ac74cf91dba62bcfa" +checksum = "2a8f8038e7e7969abb3f1b7c2a811225e9296da208539e0f79c5251d6cac0025" dependencies = [ - "vte", + "vte 0.14.1", ] -[[package]] -name = "strsim" -version = "0.10.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" - [[package]] name = "strsim" version = "0.11.1" @@ -3251,48 +3479,31 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "strum" -version = "0.26.3" +version = "0.27.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8fec0f0aef304996cf250b31b5a10dee7980c85da9d759361292b8bca5a18f06" +checksum = "f64def088c51c9510a8579e3c5d67c65349dcf755e5479ad3d010aa6454e2c32" dependencies = [ "strum_macros", ] [[package]] name = "strum_macros" -version = "0.26.4" +version = "0.27.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4c6bee85a5a24955dc440386795aa378cd9cf82acd5f764469152d2270e581be" +checksum = "c77a8c5abcaf0f9ce05d62342b7d298c346515365c36b673df4ebe3ced01fde8" dependencies = [ "heck", "proc-macro2", "quote", "rustversion", - "syn 2.0.85", + "syn", ] -[[package]] -name = "subtle" -version = "2.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc" - [[package]] name = "syn" -version = "1.0.109" +version = "2.0.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" -dependencies = [ - "proc-macro2", - "quote", - "unicode-ident", -] - -[[package]] -name = "syn" -version = "2.0.85" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5023162dfcd14ef8f32034d8bcd4cc5ddc61ef7a247c024a33e24e1f24d21b56" +checksum = "8ce2b7fc941b3a24138a0a7cf8e858bfc6a992e7978a068a5c760deb0ed43caf" dependencies = [ "proc-macro2", "quote", @@ -3301,33 +3512,42 @@ dependencies = [ [[package]] name = "synstructure" -version = "0.13.1" +version = "0.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971" +checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "tempfile" -version = "3.13.0" +version = "3.20.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0f2c9fc62d0beef6951ccffd757e241266a2c833136efbe35af6cd2567dca5b" +checksum = "e8a64e3985349f2441a1a9ef0b853f869006c3855f2cda6862a94d26ebb9d6a1" dependencies = [ - "cfg-if", "fastrand", + "getrandom 0.3.3", "once_cell", "rustix", "windows-sys 0.59.0", ] +[[package]] +name = "termcolor" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06794f8f6c5c898b3275aebefa6b8a1cb24cd2c6c79397ab15774837a0bc5755" +dependencies = [ + "winapi-util", +] + [[package]] name = "terminal_size" -version = "0.4.0" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4f599bd7ca042cfdf8f4512b277c02ba102247820f9d9d4a9f521f496751a6ef" +checksum = "45c6481c4829e4cc63825e62c49186a34538b7b2750b73b266581ffb612fb5ed" dependencies = [ "rustix", "windows-sys 0.59.0", @@ -3335,11 +3555,10 @@ dependencies = [ [[package]] name = "terminfo" -version = "0.8.0" +version = "0.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "666cd3a6681775d22b200409aad3b089c5b99fb11ecdd8a204d9d62f8148498f" +checksum = "d4ea810f0692f9f51b382fff5893887bb4580f5fa246fde546e0b13e7fcee662" dependencies = [ - "dirs 4.0.0", "fnv", "nom", "phf", @@ -3348,9 +3567,9 @@ dependencies = [ [[package]] name = "termtree" -version = "0.4.1" +version = "0.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3369f5ac52d5eb6ab48c6b4ffdc8efbcad6b89c765749064ba298f2c68a16a76" +checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683" [[package]] name = "test-case" @@ -3370,7 +3589,7 @@ dependencies = [ "cfg-if", "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] @@ -3381,28 +3600,54 @@ checksum = "5c89e72a01ed4c579669add59014b9a524d609c0c88c6a585ce37485879f6ffb" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", "test-case-core", ] +[[package]] +name = "thin-vec" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "144f754d318415ac792f9d69fc87abbbfc043ce2ef041c60f16ad828f638717d" + +[[package]] +name = "thiserror" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + [[package]] name = "thiserror" -version = "1.0.65" +version = "2.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5d11abd9594d9b38965ef50805c5e469ca9cc6f197f883f717e0269a3057b3d5" +checksum = "567b8a2dae586314f7be2a752ec7474332959c6460e02bde30d702a66d488708" dependencies = [ - "thiserror-impl", + "thiserror-impl 2.0.12", ] [[package]] name = "thiserror-impl" -version = "1.0.65" +version = "1.0.69" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae71770322cbd277e69d762a16c444af02aa0575ac0d174f0b9562d3b37f8602" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f7cf42b4507d8ea322120659672cf1b9dbb93f8f2d4ecfd6e51350ff5b17a1d" +dependencies = [ + "proc-macro2", + "quote", + "syn", ] [[package]] @@ -3415,6 +3660,15 @@ dependencies = [ "once_cell", ] +[[package]] +name = "threadpool" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d050e60b33d41c19108b32cea32164033a9013fe3b46cbd4457559bfbf77afaa" +dependencies = [ + "num_cpus", +] + [[package]] name = "tikv-jemalloc-sys" version = "0.6.0+5.3.0-1-ge13ca993e8ccb9ba9847cc330696e02839f328f7" @@ -3435,6 +3689,16 @@ dependencies = [ "tikv-jemalloc-sys", ] +[[package]] +name = "tinystr" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d4f6d1145dcb577acf783d4e601bc1d76a13337bb54e6233add580b07344c8b" +dependencies = [ + "displaydoc", + "zerovec", +] + [[package]] name = "tinytemplate" version = "1.2.1" @@ -3447,9 +3711,9 @@ dependencies = [ [[package]] name = "tinyvec" -version = "1.6.0" +version = "1.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +checksum = "09b3661f17e86524eccd4371ab0429194e0d7c008abb45f7a7495b1719463c71" dependencies = [ "tinyvec_macros", ] @@ -3462,9 +3726,9 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" [[package]] name = "toml" -version = "0.8.19" +version = "0.8.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1ed1f98e3fdc28d6d910e6737ae6ab1a93bf1985935a1193e68f93eeb68d24e" +checksum = "05ae329d1f08c4d17a59bed7ff5b5a769d062e64a62d34a3261b219e62cd5aae" dependencies = [ "serde", "serde_spanned", @@ -3474,31 +3738,38 @@ dependencies = [ [[package]] name = "toml_datetime" -version = "0.6.8" +version = "0.6.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0dd7358ecb8fc2f8d014bf86f6f638ce72ba252a2c3a2572f2a795f1d23efb41" +checksum = "3da5db5a963e24bc68be8b17b6fa82814bb22ee8660f192bb182771d498f09a3" dependencies = [ "serde", ] [[package]] name = "toml_edit" -version = "0.22.20" +version = "0.22.26" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "583c44c02ad26b0c3f3066fe629275e50627026c51ac2e595cca4c230ce1ce1d" +checksum = "310068873db2c5b3e7659d2cc35d21855dbafa50d1ce336397c666e3cb08137e" dependencies = [ "indexmap", "serde", "serde_spanned", "toml_datetime", + "toml_write", "winnow", ] +[[package]] +name = "toml_write" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfb942dfe1d8e29a7ee7fcbde5bd2b9a25fb89aa70caea2eba3bee836ff41076" + [[package]] name = "tracing" -version = "0.1.40" +version = "0.1.41" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c3523ab5a71916ccf420eebdf5521fcef02141234bbc0b8a49f2fdc4544364ef" +checksum = "784e0ac535deb450455cbfa28a6f0df145ea1bb7ae51b821cf5e7927fdcfbdd0" dependencies = [ "log", "pin-project-lite", @@ -3508,20 +3779,20 @@ dependencies = [ [[package]] name = "tracing-attributes" -version = "0.1.27" +version = "0.1.28" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7" +checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "tracing-core" -version = "0.1.32" +version = "0.1.33" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c06d3da6113f116aaee68e4d601191614c9053067f9ab7f6edbcb161237daa54" +checksum = "e672c95779cf947c5311f83787af4fa8fffd12fb27e4993211a84bdfd9610f9c" dependencies = [ "once_cell", "valuable", @@ -3540,9 +3811,9 @@ dependencies = [ [[package]] name = "tracing-indicatif" -version = "0.3.6" +version = "0.3.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "069580424efe11d97c3fef4197fa98c004fa26672cc71ad8770d224e23b1951d" +checksum = "8201ca430e0cd893ef978226fd3516c06d9c494181c8bf4e5b32e30ed4b40aa1" dependencies = [ "indicatif", "tracing", @@ -3563,12 +3834,13 @@ dependencies = [ [[package]] name = "tracing-subscriber" -version = "0.3.18" +version = "0.3.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ad0f048c97dbd9faa9b7df56362b8ebcaa52adb06b498c050d2f4e32f90a7a8b" +checksum = "e8189decb5ac0fa7bc8b96b7cb9b2701d60d48805aca84a238004d665fcc4008" dependencies = [ + "chrono", "matchers", - "nu-ansi-term 0.46.0", + "nu-ansi-term", "once_cell", "regex", "sharded-slab", @@ -3580,15 +3852,227 @@ dependencies = [ ] [[package]] -name = "tracing-tree" -version = "0.4.0" +name = "tryfn" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f459ca79f1b0d5f71c54ddfde6debfc59c8b6eeb46808ae492077f739dc7b49c" +checksum = "5fe242ee9e646acec9ab73a5c540e8543ed1b107f0ce42be831e0775d423c396" dependencies = [ - "nu-ansi-term 0.50.1", - "tracing-core", - "tracing-log", + "ignore", + "libtest-mimic", + "snapbox", +] + +[[package]] +name = "ty" +version = "0.0.0" +dependencies = [ + "anyhow", + "argfile", + "clap", + "clap_complete_command", + "colored 3.0.0", + "countme", + "crossbeam", + "ctrlc", + "filetime", + "indicatif", + "insta", + "insta-cmd", + "jiff", + "rayon", + "regex", + "ruff_db", + "ruff_python_ast", + "ruff_python_trivia", + "salsa", + "tempfile", + "toml", + "tracing", + "tracing-flame", + "tracing-subscriber", + "ty_project", + "ty_python_semantic", + "ty_server", + "wild", +] + +[[package]] +name = "ty_ide" +version = "0.0.0" +dependencies = [ + "insta", + "ruff_db", + "ruff_python_ast", + "ruff_python_parser", + "ruff_text_size", + "rustc-hash 2.1.1", + "salsa", + "smallvec", + "tracing", + "ty_python_semantic", + "ty_vendored", +] + +[[package]] +name = "ty_project" +version = "0.0.0" +dependencies = [ + "anyhow", + "crossbeam", + "glob", + "insta", + "notify", + "pep440_rs", + "rayon", + "ruff_cache", + "ruff_db", + "ruff_macros", + "ruff_options_metadata", + "ruff_python_ast", + "ruff_python_formatter", + "ruff_text_size", + "rustc-hash 2.1.1", + "salsa", + "schemars", + "serde", + "thiserror 2.0.12", + "toml", + "tracing", + "ty_ide", + "ty_python_semantic", + "ty_vendored", +] + +[[package]] +name = "ty_python_semantic" +version = "0.0.0" +dependencies = [ + "anyhow", + "bitflags 2.9.1", + "camino", + "compact_str", + "countme", + "dir-test", + "drop_bomb", + "hashbrown 0.15.3", + "indexmap", + "insta", + "itertools 0.14.0", + "memchr", + "ordermap", + "quickcheck", + "quickcheck_macros", + "ruff_db", + "ruff_index", + "ruff_macros", + "ruff_python_ast", + "ruff_python_literal", + "ruff_python_parser", + "ruff_python_stdlib", + "ruff_python_trivia", + "ruff_source_file", + "ruff_text_size", + "rustc-hash 2.1.1", + "salsa", + "schemars", + "serde", + "smallvec", + "static_assertions", + "strum", + "strum_macros", + "tempfile", + "test-case", + "thiserror 2.0.12", + "tracing", + "ty_test", + "ty_vendored", +] + +[[package]] +name = "ty_server" +version = "0.0.0" +dependencies = [ + "anyhow", + "crossbeam", + "jod-thread", + "libc", + "lsp-server", + "lsp-types", + "ruff_db", + "ruff_notebook", + "ruff_source_file", + "ruff_text_size", + "rustc-hash 2.1.1", + "serde", + "serde_json", + "shellexpand", + "tracing", "tracing-subscriber", + "ty_ide", + "ty_project", + "ty_python_semantic", +] + +[[package]] +name = "ty_test" +version = "0.0.0" +dependencies = [ + "anyhow", + "camino", + "colored 3.0.0", + "insta", + "memchr", + "regex", + "ruff_db", + "ruff_index", + "ruff_notebook", + "ruff_python_ast", + "ruff_python_trivia", + "ruff_source_file", + "ruff_text_size", + "rustc-hash 2.1.1", + "rustc-stable-hash", + "salsa", + "serde", + "smallvec", + "tempfile", + "thiserror 2.0.12", + "toml", + "tracing", + "ty_python_semantic", + "ty_vendored", +] + +[[package]] +name = "ty_vendored" +version = "0.0.0" +dependencies = [ + "path-slash", + "ruff_db", + "walkdir", + "zip", +] + +[[package]] +name = "ty_wasm" +version = "0.0.0" +dependencies = [ + "console_error_panic_hook", + "console_log", + "getrandom 0.3.3", + "js-sys", + "log", + "ruff_db", + "ruff_notebook", + "ruff_python_formatter", + "ruff_source_file", + "ruff_text_size", + "serde-wasm-bindgen", + "ty_ide", + "ty_project", + "ty_python_semantic", + "wasm-bindgen", + "wasm-bindgen-test", ] [[package]] @@ -3599,15 +4083,15 @@ checksum = "6af6ae20167a9ece4bcb41af5b80f8a1f1df981f6391189ce00fd257af04126a" [[package]] name = "typenum" -version = "1.17.0" +version = "1.18.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825" +checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f" [[package]] name = "ucd-trie" -version = "0.1.6" +version = "0.1.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ed646292ffc8188ef8ea4d1e0e0150fb15a5c2e12ad9b8fc191ae7a8a7f3c4b9" +checksum = "2896d95c02a80c6d6a5d6e953d479f5ddf2dfdb6a244441010e373ac0fb88971" [[package]] name = "unic-char-property" @@ -3652,16 +4136,16 @@ dependencies = [ ] [[package]] -name = "unicode-bidi" -version = "0.3.15" +name = "unicode-id" +version = "0.3.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75" +checksum = "10103c57044730945224467c09f71a4db0071c123a0648cc3e818913bde6b561" [[package]] name = "unicode-ident" -version = "1.0.13" +version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe" +checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512" [[package]] name = "unicode-normalization" @@ -3674,9 +4158,9 @@ dependencies = [ [[package]] name = "unicode-width" -version = "0.1.13" +version = "0.1.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0336d538f7abc86d282a4189614dfaa90810dfc2c6f6427eaf88e16311dd225d" +checksum = "7dd6e30e90baa6f72411720665d41d89b9a3d039dc45b8faea1ddd07f617f6af" [[package]] name = "unicode-width" @@ -3703,7 +4187,7 @@ dependencies = [ "getopts", "log", "phf_codegen", - "rand", + "rand 0.8.5", ] [[package]] @@ -3713,32 +4197,16 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e9df2af067a7953e9c3831320f35c1cc0600c30d44d9f7a12b01db1cd88d6b47" [[package]] -name = "untrusted" -version = "0.9.0" +name = "unty" +version = "0.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" - -[[package]] -name = "ureq" -version = "2.10.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b74fc6b57825be3373f7054754755f03ac3a8f5d70015ccad699ba2029956f4a" -dependencies = [ - "base64", - "flate2", - "log", - "once_cell", - "rustls", - "rustls-pki-types", - "url", - "webpki-roots", -] +checksum = "6d49784317cd0d1ee7ec5c716dd598ec5b4483ea832a2dced265471cc0f690ae" [[package]] name = "url" -version = "2.5.2" +version = "2.5.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "22784dbdf76fdde8af1aeda5622b546b422b6fc585325248a2bf9f5e41e94d6c" +checksum = "32f8b686cadd1473f4bd0117a5d28d36b1ade384ea9b5069a1c40aefed7fda60" dependencies = [ "form_urlencoded", "idna", @@ -3746,46 +4214,80 @@ dependencies = [ "serde", ] +[[package]] +name = "urlencoding" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "daf8dba3b7eb870caf1ddeed7bc9d2a049f3cfdfae7cb521b087cc33ae4c49da" + +[[package]] +name = "utf8-width" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86bd8d4e895da8537e5315b8254664e6b769c4ff3db18321b297a1e7004392e3" + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + [[package]] name = "utf8parse" -version = "0.2.1" +version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" [[package]] name = "uuid" -version = "1.11.0" +version = "1.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8c5f0a0af699448548ad1a2fbf920fb4bee257eae39953ba95cb84891a0446a" +checksum = "458f7a779bf54acc9f347480ac654f68407d3aab21269a6e3c9f922acd9e2da9" dependencies = [ - "getrandom", - "rand", + "getrandom 0.3.3", + "js-sys", + "rand 0.9.1", "uuid-macro-internal", "wasm-bindgen", ] [[package]] name = "uuid-macro-internal" -version = "1.11.0" +version = "1.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6b91f57fe13a38d0ce9e28a03463d8d3c2468ed03d75375110ec71d93b449a08" +checksum = "72dcd78c4f979627a754f5522cea6e6a25e55139056535fe6e69c506cd64a862" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "valuable" -version = "0.1.0" +version = "0.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + +[[package]] +name = "version-ranges" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8d079415ceb2be83fc355adbadafe401307d5c309c7e6ade6638e6f9f42f42d" +dependencies = [ + "smallvec", +] [[package]] name = "version_check" -version = "0.9.4" +version = "0.9.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "virtue" +version = "0.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "051eb1abcf10076295e815102942cc58f9d5e3b4560e46e53c21e8ff6f3af7b1" [[package]] name = "vt100" @@ -3795,8 +4297,8 @@ checksum = "84cd863bf0db7e392ba3bd04994be3473491b31e66340672af5d11943c6274de" dependencies = [ "itoa", "log", - "unicode-width 0.1.13", - "vte", + "unicode-width 0.1.14", + "vte 0.11.1", ] [[package]] @@ -3810,16 +4312,34 @@ dependencies = [ "vte_generate_state_changes", ] +[[package]] +name = "vte" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "231fdcd7ef3037e8330d8e17e61011a2c244126acc0a982f4040ac3f9f0bc077" +dependencies = [ + "memchr", +] + [[package]] name = "vte_generate_state_changes" -version = "0.1.1" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d257817081c7dffcdbab24b9e62d2def62e2ff7d00b1c20062551e6cccc145ff" +checksum = "2e369bee1b05d510a7b4ed645f5faa90619e05437111783ea5848f28d97d3c2e" dependencies = [ "proc-macro2", "quote", ] +[[package]] +name = "wait-timeout" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ac3b126d3914f9849036f826e054cbabdc8519970b8998ddaf3b5bd3c65f11" +dependencies = [ + "libc", +] + [[package]] name = "walkdir" version = "2.5.0" @@ -3836,49 +4356,59 @@ version = "0.11.0+wasi-snapshot-preview1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" +[[package]] +name = "wasi" +version = "0.14.2+wasi-0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9683f9a5a998d873c0d21fcbe3c083009670149a8fab228644b8bd36b2c48cb3" +dependencies = [ + "wit-bindgen-rt", +] + [[package]] name = "wasm-bindgen" -version = "0.2.95" +version = "0.2.100" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "128d1e363af62632b8eb57219c8fd7877144af57558fb2ef0368d0087bddeb2e" +checksum = "1edc8929d7499fc4e8f0be2262a241556cfc54a0bea223790e71446f2aab1ef5" dependencies = [ "cfg-if", "once_cell", + "rustversion", "wasm-bindgen-macro", ] [[package]] name = "wasm-bindgen-backend" -version = "0.2.95" +version = "0.2.100" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb6dd4d3ca0ddffd1dd1c9c04f94b868c37ff5fac97c30b97cff2d74fce3a358" +checksum = "2f0a0651a5c2bc21487bde11ee802ccaf4c51935d0d3d42a6101f98161700bc6" dependencies = [ "bumpalo", "log", - "once_cell", "proc-macro2", "quote", - "syn 2.0.85", + "syn", "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-futures" -version = "0.4.45" +version = "0.4.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cc7ec4f8827a71586374db3e87abdb5a2bb3a15afed140221307c3ec06b1f63b" +checksum = "555d470ec0bc3bb57890405e5d4322cc9ea83cebb085523ced7be4144dac1e61" dependencies = [ "cfg-if", "js-sys", + "once_cell", "wasm-bindgen", "web-sys", ] [[package]] name = "wasm-bindgen-macro" -version = "0.2.95" +version = "0.2.100" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e79384be7f8f5a9dd5d7167216f022090cf1f9ec128e6e6a482a2cb5c5422c56" +checksum = "7fe63fc6d09ed3792bd0897b314f53de8e16568c2b3f7982f468c0bf9bd0b407" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -3886,33 +4416,34 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.95" +version = "0.2.100" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26c6ab57572f7a24a4985830b120de1594465e5d500f24afe89e16b4e833ef68" +checksum = "8ae87ea40c9f689fc23f209965b6fb8a99ad69aeeb0231408be24920604395de" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", "wasm-bindgen-backend", "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-shared" -version = "0.2.95" +version = "0.2.100" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "65fc09f10666a9f147042251e0dda9c18f166ff7de300607007e96bdebc1068d" +checksum = "1a05d73b933a847d6cccdda8f838a22ff101ad9bf93e33684f39c1f5f0eece3d" +dependencies = [ + "unicode-ident", +] [[package]] name = "wasm-bindgen-test" -version = "0.3.45" +version = "0.3.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d381749acb0943d357dcbd8f0b100640679883fcdeeef04def49daf8d33a5426" +checksum = "66c8d5e33ca3b6d9fa3b4676d774c5778031d27a578c2b007f905acf816152c3" dependencies = [ - "console_error_panic_hook", "js-sys", "minicov", - "scoped-tls", "wasm-bindgen", "wasm-bindgen-futures", "wasm-bindgen-test-macro", @@ -3920,20 +4451,20 @@ dependencies = [ [[package]] name = "wasm-bindgen-test-macro" -version = "0.3.45" +version = "0.3.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c97b2ef2c8d627381e51c071c2ab328eac606d3f69dd82bcbca20a9e389d95f0" +checksum = "17d5042cc5fa009658f9a7333ef24291b1291a25b6382dd68862a7f3b969f69b" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] name = "web-sys" -version = "0.3.69" +version = "0.3.77" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "77afa9a11836342370f4817622a2f0f418b134426d91a82dfb48f532d2ec13ef" +checksum = "33b6dd2ef9186f1f2072e409e99cd22a975331a6b3591b12c764e0e55c60d5d2" dependencies = [ "js-sys", "wasm-bindgen", @@ -3949,23 +4480,14 @@ dependencies = [ "wasm-bindgen", ] -[[package]] -name = "webpki-roots" -version = "0.26.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b3de34ae270483955a94f4b21bdaaeb83d508bb84a01435f393818edb0012009" -dependencies = [ - "rustls-pki-types", -] - [[package]] name = "which" -version = "6.0.1" +version = "7.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8211e4f58a2b2805adfbefbc07bab82958fc91e3836339b1ab7ae32465dce0d7" +checksum = "24d643ce3fd3e5b54854602a080f34fb10ab75e0b813ee32d00ca2b44fa74762" dependencies = [ "either", - "home", + "env_home", "rustix", "winsafe", ] @@ -3997,11 +4519,11 @@ checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" [[package]] name = "winapi-util" -version = "0.1.8" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4d4cc384e1e73b93bafa6fb4f1df8c41695c8a91cf9c4c64358067d15a7b6c6b" +checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] @@ -4012,53 +4534,79 @@ checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" [[package]] name = "windows-core" -version = "0.52.0" +version = "0.61.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" +checksum = "46ec44dc15085cea82cf9c78f85a9114c463a369786585ad2882d1ff0b0acf40" dependencies = [ - "windows-targets 0.52.6", + "windows-implement", + "windows-interface", + "windows-link", + "windows-result", + "windows-strings", ] [[package]] -name = "windows-sys" -version = "0.48.0" +name = "windows-implement" +version = "0.60.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +checksum = "a47fddd13af08290e67f4acabf4b459f647552718f683a7b415d290ac744a836" dependencies = [ - "windows-targets 0.48.5", + "proc-macro2", + "quote", + "syn", ] [[package]] -name = "windows-sys" -version = "0.52.0" +name = "windows-interface" +version = "0.59.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +checksum = "bd9211b69f8dcdfa817bfd14bf1c97c9188afa36f4750130fcdf3f400eca9fa8" dependencies = [ - "windows-targets 0.52.6", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "windows-link" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "76840935b766e1b0a05c0066835fb9ec80071d4c09a16f6bd5f7e655e3c14c38" + +[[package]] +name = "windows-result" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b895b5356fc36103d0f64dd1e94dfa7ac5633f1c9dd6e80fe9ec4adef69e09d" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-strings" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2a7ab927b2637c19b3dbe0965e75d8f2d30bdd697a1516191cad2ec4df8fb28a" +dependencies = [ + "windows-link", ] [[package]] name = "windows-sys" -version = "0.59.0" +version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" dependencies = [ - "windows-targets 0.52.6", + "windows-targets", ] [[package]] -name = "windows-targets" -version = "0.48.5" +name = "windows-sys" +version = "0.59.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" dependencies = [ - "windows_aarch64_gnullvm 0.48.5", - "windows_aarch64_msvc 0.48.5", - "windows_i686_gnu 0.48.5", - "windows_i686_msvc 0.48.5", - "windows_x86_64_gnu 0.48.5", - "windows_x86_64_gnullvm 0.48.5", - "windows_x86_64_msvc 0.48.5", + "windows-targets", ] [[package]] @@ -4067,46 +4615,28 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" dependencies = [ - "windows_aarch64_gnullvm 0.52.6", - "windows_aarch64_msvc 0.52.6", - "windows_i686_gnu 0.52.6", + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", "windows_i686_gnullvm", - "windows_i686_msvc 0.52.6", - "windows_x86_64_gnu 0.52.6", - "windows_x86_64_gnullvm 0.52.6", - "windows_x86_64_msvc 0.52.6", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", ] -[[package]] -name = "windows_aarch64_gnullvm" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" - [[package]] name = "windows_aarch64_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" -[[package]] -name = "windows_aarch64_msvc" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" - [[package]] name = "windows_aarch64_msvc" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" -[[package]] -name = "windows_i686_gnu" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" - [[package]] name = "windows_i686_gnu" version = "0.52.6" @@ -4119,48 +4649,24 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" -[[package]] -name = "windows_i686_msvc" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" - [[package]] name = "windows_i686_msvc" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" -[[package]] -name = "windows_x86_64_gnu" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" - [[package]] name = "windows_x86_64_gnu" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" -[[package]] -name = "windows_x86_64_gnullvm" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" - [[package]] name = "windows_x86_64_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" -[[package]] -name = "windows_x86_64_msvc" -version = "0.48.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" - [[package]] name = "windows_x86_64_msvc" version = "0.52.6" @@ -4169,9 +4675,9 @@ checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" [[package]] name = "winnow" -version = "0.6.18" +version = "0.7.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "68a9bda4691f099d435ad181000724da8e5899daa10713c2d432552b9ccd3a6f" +checksum = "c06928c8748d81b05c9be96aad92e1b6ff01833332f281e8cfca3be4b35fc9ec" dependencies = [ "memchr", ] @@ -4182,6 +4688,21 @@ version = "0.0.19" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904" +[[package]] +name = "wit-bindgen-rt" +version = "0.39.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f42320e61fe2cfd34354ecb597f86f413484a798ba44a8ca1165c58d42da6c1" +dependencies = [ + "bitflags 2.9.1", +] + +[[package]] +name = "writeable" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea2f10b9bb0928dfb1b42b65e1f9e36f7f54dbdf08457afefb38afcdec4fa2bb" + [[package]] name = "yansi" version = "1.0.1" @@ -4189,39 +4710,102 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" [[package]] -name = "yansi-term" -version = "0.1.2" +name = "yoke" +version = "0.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe5c30ade05e61656247b2e334a031dfd0cc466fadef865bdcdea8d537951bf1" +checksum = "5f41bb01b8226ef4bfd589436a297c53d118f65921786300e427be8d487695cc" dependencies = [ - "winapi", + "serde", + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38da3c9736e16c5d3c8c597a9aaa5d1fa565d0532ae05e27c24aa62fb32c0ab6" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "synstructure", ] [[package]] name = "zerocopy" -version = "0.7.32" +version = "0.8.25" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "74d4d3961e53fa4c9a25a8637fc2bfaf2595b3d3ae34875568a5cf64787716be" +checksum = "a1702d9583232ddb9174e01bb7c15a2ab8fb1bc6f227aa1233858c351a3ba0cb" dependencies = [ "zerocopy-derive", ] [[package]] name = "zerocopy-derive" -version = "0.7.32" +version = "0.8.25" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9ce1b18ccd8e73a9321186f97e46f9f04b778851177567b1975109d26a08d2a6" +checksum = "28a6e20d751156648aa063f3800b706ee209a32c0b4d9f24be3d980b01be55ef" dependencies = [ "proc-macro2", "quote", - "syn 2.0.85", + "syn", ] [[package]] -name = "zeroize" -version = "1.7.0" +name = "zerofrom" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "525b4ec142c6b68a2d10f01f7bbf6755599ca3f81ea53b8431b7dd348f5fdb2d" +checksum = "50cc42e0333e05660c3587f3bf9d0478688e15d870fab3346451ce7f8c9fbea5" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d71e5d6e06ab090c67b5e44993ec16b72dcbaabc526db883a360057678b48502" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "synstructure", +] + +[[package]] +name = "zerotrie" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36f0bbd478583f79edad978b407914f61b2972f5af6fa089686016be8f9af595" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a05eb080e015ba39cc9e23bbe5e7fb04d5fb040350f99f34e338d5fdd294428" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b96237efa0c878c64bd89c436f661be4e46b2f3eff1ebb976f7ef2321d2f58f" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] [[package]] name = "zip" @@ -4257,9 +4841,9 @@ dependencies = [ [[package]] name = "zstd-sys" -version = "2.0.11+zstd.1.5.6" +version = "2.0.15+zstd.1.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "75652c55c0b6f3e6f12eb786fe1bc960396bf05a1eb3bf1f3691c3610ac2e6d4" +checksum = "eb81183ddd97d0c74cedf1d50d85c8d08c1b8b68ee863bdee9e706eedba1a237" dependencies = [ "cc", "pkg-config", diff --git a/Cargo.toml b/Cargo.toml index 681a20eb9ed46..f2a934387571a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,8 +3,9 @@ members = ["crates/*"] resolver = "2" [workspace.package] -edition = "2021" -rust-version = "1.80" +# Please update rustfmt.toml when bumping the Rust edition +edition = "2024" +rust-version = "1.85" homepage = "https://docs.astral.sh/ruff" documentation = "https://docs.astral.sh/ruff" repository = "https://github.com/astral-sh/ruff" @@ -13,6 +14,7 @@ license = "MIT" [workspace.dependencies] ruff = { path = "crates/ruff" } +ruff_annotate_snippets = { path = "crates/ruff_annotate_snippets" } ruff_cache = { path = "crates/ruff_cache" } ruff_db = { path = "crates/ruff_db", default-features = false } ruff_diagnostics = { path = "crates/ruff_diagnostics" } @@ -22,6 +24,7 @@ ruff_index = { path = "crates/ruff_index" } ruff_linter = { path = "crates/ruff_linter" } ruff_macros = { path = "crates/ruff_macros" } ruff_notebook = { path = "crates/ruff_notebook" } +ruff_options_metadata = { path = "crates/ruff_options_metadata" } ruff_python_ast = { path = "crates/ruff_python_ast" } ruff_python_codegen = { path = "crates/ruff_python_codegen" } ruff_python_formatter = { path = "crates/ruff_python_formatter" } @@ -34,62 +37,70 @@ ruff_python_trivia = { path = "crates/ruff_python_trivia" } ruff_server = { path = "crates/ruff_server" } ruff_source_file = { path = "crates/ruff_source_file" } ruff_text_size = { path = "crates/ruff_text_size" } -red_knot_vendored = { path = "crates/red_knot_vendored" } ruff_workspace = { path = "crates/ruff_workspace" } -red_knot_python_semantic = { path = "crates/red_knot_python_semantic" } -red_knot_server = { path = "crates/red_knot_server" } -red_knot_test = { path = "crates/red_knot_test" } -red_knot_workspace = { path = "crates/red_knot_workspace", default-features = false } +ty = { path = "crates/ty" } +ty_ide = { path = "crates/ty_ide" } +ty_project = { path = "crates/ty_project", default-features = false } +ty_python_semantic = { path = "crates/ty_python_semantic" } +ty_server = { path = "crates/ty_server" } +ty_test = { path = "crates/ty_test" } +ty_vendored = { path = "crates/ty_vendored" } aho-corasick = { version = "1.1.3" } -annotate-snippets = { version = "0.9.2", features = ["color"] } +anstream = { version = "0.6.18" } +anstyle = { version = "1.0.10" } anyhow = { version = "1.0.80" } assert_fs = { version = "1.1.0" } argfile = { version = "0.2.0" } -bincode = { version = "1.3.3" } +bincode = { version = "2.0.0" } bitflags = { version = "2.5.0" } bstr = { version = "1.9.1" } cachedir = { version = "0.3.1" } camino = { version = "1.1.7" } -chrono = { version = "0.4.35", default-features = false, features = ["clock"] } clap = { version = "4.5.3", features = ["derive"] } clap_complete_command = { version = "0.6.0" } -clearscreen = { version = "3.0.0" } +clearscreen = { version = "4.0.0" } codspeed-criterion-compat = { version = "2.6.0", default-features = false } -colored = { version = "2.1.0" } +colored = { version = "3.0.0" } console_error_panic_hook = { version = "0.1.7" } console_log = { version = "1.0.0" } countme = { version = "3.0.1" } -compact_str = "0.8.0" -criterion = { version = "0.5.1", default-features = false } +compact_str = "0.9.0" +criterion = { version = "0.6.0", default-features = false } crossbeam = { version = "0.8.4" } dashmap = { version = "6.0.1" } -dir-test = { version = "0.3.0" } +dir-test = { version = "0.4.0" } +dunce = { version = "1.0.5" } drop_bomb = { version = "0.1.5" } env_logger = { version = "0.11.0" } -etcetera = { version = "0.8.0" } +etcetera = { version = "0.10.0" } fern = { version = "0.7.0" } filetime = { version = "0.2.23" } +getrandom = { version = "0.3.1" } glob = { version = "0.3.1" } globset = { version = "0.4.14" } globwalk = { version = "0.9.1" } hashbrown = { version = "0.15.0", default-features = false, features = [ "raw-entry", + "equivalent", "inline-more", ] } +heck = "0.5.0" ignore = { version = "0.4.22" } imara-diff = { version = "0.1.5" } imperative = { version = "1.0.4" } +indexmap = { version = "2.6.0" } indicatif = { version = "0.17.8" } indoc = { version = "2.0.4" } insta = { version = "1.35.1" } insta-cmd = { version = "0.6.0" } is-macro = { version = "0.3.5" } is-wsl = { version = "0.4.0" } -itertools = { version = "0.13.0" } +itertools = { version = "0.14.0" } +jiff = { version = "0.2.0" } js-sys = { version = "0.3.69" } -jod-thread = { version = "0.1.2" } +jod-thread = { version = "1.0.0" } libc = { version = "0.2.153" } libcst = { version = "1.1.0", default-features = false } log = { version = "0.4.17" } @@ -101,7 +112,7 @@ matchit = { version = "0.8.1" } memchr = { version = "2.7.1" } mimalloc = { version = "0.1.39" } natord = { version = "1.0.9" } -notify = { version = "6.1.1" } +notify = { version = "8.0.0" } ordermap = { version = "0.5.0" } path-absolutize = { version = "3.1.1" } path-slash = { version = "0.2.1" } @@ -109,14 +120,16 @@ pathdiff = { version = "0.2.1" } pep440_rs = { version = "0.7.1" } pretty_assertions = "1.3.0" proc-macro2 = { version = "1.0.79" } -pyproject-toml = { version = "0.9.0" } +pyproject-toml = { version = "0.13.4" } quick-junit = { version = "0.5.0" } quote = { version = "1.0.23" } -rand = { version = "0.8.5" } +rand = { version = "0.9.0" } rayon = { version = "1.10.0" } regex = { version = "1.10.2" } rustc-hash = { version = "2.0.0" } -salsa = { git = "https://github.com/salsa-rs/salsa.git", rev = "254c749b02cde2fd29852a7463a33e800b771758" } +rustc-stable-hash = { version = "0.1.2" } +# When updating salsa, make sure to also update the revision in `fuzz/Cargo.toml` +salsa = { git = "https://github.com/salsa-rs/salsa.git", rev = "4818b15f3b7516555d39f5a41cb75970448bee4c" } schemars = { version = "0.8.16" } seahash = { version = "4.1.0" } serde = { version = "1.0.197", features = ["derive"] } @@ -129,30 +142,38 @@ serde_with = { version = "3.6.0", default-features = false, features = [ shellexpand = { version = "3.0.0" } similar = { version = "2.4.0", features = ["inline"] } smallvec = { version = "1.13.2" } +snapbox = { version = "0.6.0", features = [ + "diff", + "term-svg", + "cmd", + "examples", +] } static_assertions = "1.1.0" -strum = { version = "0.26.0", features = ["strum_macros"] } -strum_macros = { version = "0.26.0" } +strum = { version = "0.27.0", features = ["strum_macros"] } +strum_macros = { version = "0.27.0" } syn = { version = "2.0.55" } tempfile = { version = "3.9.0" } test-case = { version = "3.3.1" } -thiserror = { version = "1.0.58" } +thiserror = { version = "2.0.0" } tikv-jemallocator = { version = "0.6.0" } toml = { version = "0.8.11" } tracing = { version = "0.1.40" } tracing-flame = { version = "0.2.0" } tracing-indicatif = { version = "0.3.6" } +tracing-log = { version = "0.2.0" } tracing-subscriber = { version = "0.3.18", default-features = false, features = [ "env-filter", "fmt", + "ansi", + "smallvec" ] } -tracing-tree = { version = "0.4.0" } +tryfn = { version = "0.2.1" } typed-arena = { version = "2.0.2" } unic-ucd-category = { version = "0.9" } unicode-ident = { version = "1.0.12" } -unicode-width = { version = "0.1.11" } +unicode-width = { version = "0.2.0" } unicode_names2 = { version = "1.2.2" } unicode-normalization = { version = "0.1.23" } -ureq = { version = "2.9.6" } url = { version = "2.5.0" } uuid = { version = "1.6.1", features = [ "v4", @@ -166,6 +187,10 @@ wasm-bindgen-test = { version = "0.3.42" } wild = { version = "2" } zip = { version = "0.6.6", default-features = false } +[workspace.metadata.cargo-shear] +ignored = ["getrandom", "ruff_options_metadata"] + + [workspace.lints.rust] unsafe_code = "warn" unreachable_pub = "warn" @@ -188,8 +213,11 @@ missing_panics_doc = "allow" module_name_repetitions = "allow" must_use_candidate = "allow" similar_names = "allow" +single_match_else = "allow" too_many_lines = "allow" -# To allow `#[allow(clippy::all)]` in `crates/ruff_python_parser/src/python.rs`. +needless_continue = "allow" # An explicit continue can be more readable, especially if the alternative is an empty block. +unnecessary_debug_formatting = "allow" # too many instances, the display also doesn't quote the path which is often desired in logs where we use them the most often. +# Without the hashes we run into a `rustfmt` bug in some snapshot tests, see #13250 needless_raw_string_hashes = "allow" # Disallowed restriction lints print_stdout = "warn" @@ -207,6 +235,9 @@ redundant_clone = "warn" debug_assert_with_mut_call = "warn" unused_peekable = "warn" +# Diagnostics are not actionable: Enable once https://github.com/rust-lang/rust-clippy/issues/13774 is resolved. +large_stack_arrays = "allow" + [profile.release] # Note that we set these explicitly, and these values # were chosen based on a trade-off between compile times @@ -230,6 +261,9 @@ opt-level = 3 [profile.dev.package.similar] opt-level = 3 +[profile.dev.package.salsa] +opt-level = 3 + # Reduce complexity of a parser function that would trigger a locals limit in a wasm tool. # https://github.com/bytecodealliance/wasm-tools/blob/b5c3d98e40590512a3b12470ef358d5c7b983b15/crates/wasmparser/src/limits.rs#L29 [profile.dev.package.ruff_python_parser] @@ -244,64 +278,3 @@ debug = 1 # The profile that 'cargo dist' will build with. [profile.dist] inherits = "release" - -# Config for 'cargo dist' -[workspace.metadata.dist] -# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) -cargo-dist-version = "0.22.1" -# CI backends to support -ci = "github" -# The installers to generate for each app -installers = ["shell", "powershell"] -# The archive format to use for windows builds (defaults .zip) -windows-archive = ".zip" -# The archive format to use for non-windows builds (defaults .tar.xz) -unix-archive = ".tar.gz" -# Target platforms to build apps for (Rust target-triple syntax) -targets = [ - "aarch64-apple-darwin", - "aarch64-pc-windows-msvc", - "aarch64-unknown-linux-gnu", - "aarch64-unknown-linux-musl", - "arm-unknown-linux-musleabihf", - "armv7-unknown-linux-gnueabihf", - "armv7-unknown-linux-musleabihf", - "i686-pc-windows-msvc", - "i686-unknown-linux-gnu", - "i686-unknown-linux-musl", - "powerpc64-unknown-linux-gnu", - "powerpc64le-unknown-linux-gnu", - "s390x-unknown-linux-gnu", - "x86_64-apple-darwin", - "x86_64-pc-windows-msvc", - "x86_64-unknown-linux-gnu", - "x86_64-unknown-linux-musl", -] -# Whether to auto-include files like READMEs, LICENSEs, and CHANGELOGs (default true) -auto-includes = false -# Whether cargo-dist should create a GitHub Release or use an existing draft -create-release = true -# Which actions to run on pull requests -pr-run-mode = "skip" -# Whether CI should trigger releases with dispatches instead of tag pushes -dispatch-releases = true -# Which phase cargo-dist should use to create the GitHub release -github-release = "announce" -# Whether CI should include auto-generated code to build local artifacts -build-local-artifacts = false -# Local artifacts jobs to run in CI -local-artifacts-jobs = ["./build-binaries", "./build-docker"] -# Publish jobs to run in CI -publish-jobs = ["./publish-pypi", "./publish-wasm"] -# Post-announce jobs to run in CI -post-announce-jobs = [ - "./notify-dependents", - "./publish-docs", - "./publish-playground", -] -# Custom permissions for GitHub Jobs -github-custom-job-permissions = { "build-docker" = { packages = "write", contents = "read" }, "publish-wasm" = { contents = "read", id-token = "write", packages = "write" } } -# Whether to install an updater program -install-updater = false -# Path that installers should place binaries in -install-path = "CARGO_HOME" diff --git a/README.md b/README.md index 6a736e0cabe52..99612af0d0fc6 100644 --- a/README.md +++ b/README.md @@ -116,9 +116,22 @@ For more, see the [documentation](https://docs.astral.sh/ruff/). ### Installation -Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI: +Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI. + +Invoke Ruff directly with [`uvx`](https://docs.astral.sh/uv/): + +```shell +uvx ruff check # Lint all files in the current directory. +uvx ruff format # Format all files in the current directory. +``` + +Or install Ruff with `uv` (recommended), `pip`, or `pipx`: ```shell +# With uv. +uv tool install ruff@latest # Install Ruff globally. +uv add --dev ruff # Or add Ruff to your project. + # With pip. pip install ruff @@ -136,8 +149,8 @@ curl -LsSf https://astral.sh/ruff/install.sh | sh powershell -c "irm https://astral.sh/ruff/install.ps1 | iex" # For a specific version. -curl -LsSf https://astral.sh/ruff/0.7.1/install.sh | sh -powershell -c "irm https://astral.sh/ruff/0.7.1/install.ps1 | iex" +curl -LsSf https://astral.sh/ruff/0.11.10/install.sh | sh +powershell -c "irm https://astral.sh/ruff/0.11.10/install.ps1 | iex" ``` You can also install Ruff via [Homebrew](https://formulae.brew.sh/formula/ruff), [Conda](https://anaconda.org/conda-forge/ruff), @@ -170,7 +183,7 @@ Ruff can also be used as a [pre-commit](https://pre-commit.com/) hook via [`ruff ```yaml - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.7.1 + rev: v0.11.10 hooks: # Run the linter. - id: ruff @@ -192,7 +205,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: astral-sh/ruff-action@v1 + - uses: astral-sh/ruff-action@v3 ``` ### Configuration @@ -238,11 +251,11 @@ exclude = [ line-length = 88 indent-width = 4 -# Assume Python 3.8 -target-version = "py38" +# Assume Python 3.9 +target-version = "py39" [lint] -# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. +# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. select = ["E4", "E7", "E9", "F"] ignore = [] @@ -439,6 +452,7 @@ Ruff is used by a number of major open-source projects and companies, including: - ING Bank ([popmon](https://github.com/ing-bank/popmon), [probatus](https://github.com/ing-bank/probatus)) - [Ibis](https://github.com/ibis-project/ibis) - [ivy](https://github.com/unifyai/ivy) +- [JAX](https://github.com/jax-ml/jax) - [Jupyter](https://github.com/jupyter-server/jupyter_server) - [Kraken Tech](https://kraken.tech/) - [LangChain](https://github.com/hwchase17/langchain) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000000..13a07e45ebdbc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security policy + +## Reporting a vulnerability + +If you have found a possible vulnerability, please email `security at astral dot sh`. + +## Bug bounties + +While we sincerely appreciate and encourage reports of suspected security problems, please note that +Astral does not currently run any bug bounty programs. + +## Vulnerability disclosures + +Critical vulnerabilities will be disclosed via GitHub's +[security advisory](https://github.com/astral-sh/ruff/security) system. diff --git a/_typos.toml b/_typos.toml index 748c29e66c990..402e1755337bb 100644 --- a/_typos.toml +++ b/_typos.toml @@ -1,6 +1,10 @@ [files] # https://github.com/crate-ci/typos/issues/868 -extend-exclude = ["crates/red_knot_vendored/vendor/**/*", "**/resources/**/*", "**/snapshots/**/*"] +extend-exclude = [ + "crates/ty_vendored/vendor/**/*", + "**/resources/**/*", + "**/snapshots/**/*", +] [default.extend-words] "arange" = "arange" # e.g. `numpy.arange` @@ -16,7 +20,14 @@ Numer = "Numer" # Library name 'NumerBlox' in "Who's Using Ruff?" [default] extend-ignore-re = [ - # Line ignore with trailing "spellchecker:disable-line" - "(?Rm)^.*#\\s*spellchecker:disable-line$", - "LICENSEs", + # Line ignore with trailing "spellchecker:disable-line" + "(?Rm)^.*#\\s*spellchecker:disable-line$", + "LICENSEs", + # Various third party dependencies uses `typ` as struct field names (e.g., lsp_types::LogMessageParams) + "typ", + # TODO: Remove this once the `TYP` redirects are removed from `rule_redirects.rs` + "TYP", ] + +[default.extend-identifiers] +"FrIeNdLy" = "FrIeNdLy" diff --git a/clippy.toml b/clippy.toml index 12052f24fd26e..539d63305be5a 100644 --- a/clippy.toml +++ b/clippy.toml @@ -1,21 +1,26 @@ doc-valid-idents = [ - "..", - "CodeQL", - "FastAPI", - "IPython", - "LangChain", - "LibCST", - "McCabe", - "NumPy", - "SCREAMING_SNAKE_CASE", - "SQLAlchemy", - "StackOverflow", - "PyCharm", + "..", + "CodeQL", + "CPython", + "FastAPI", + "IPython", + "LangChain", + "LibCST", + "McCabe", + "NumPy", + "SCREAMING_SNAKE_CASE", + "SQLAlchemy", + "StackOverflow", + "PyCharm", + "SNMPv1", + "SNMPv2", + "SNMPv3", + "PyFlakes", ] ignore-interior-mutability = [ - # Interned is read-only. The wrapped `Rc` never gets updated. - "ruff_formatter::format_element::Interned", - # The expression is read-only. - "ruff_python_ast::hashable::HashableExpr", + # Interned is read-only. The wrapped `Rc` never gets updated. + "ruff_formatter::format_element::Interned", + # The expression is read-only. + "ruff_python_ast::hashable::HashableExpr", ] diff --git a/crates/red_knot/Cargo.toml b/crates/red_knot/Cargo.toml deleted file mode 100644 index 1b3fdfa346130..0000000000000 --- a/crates/red_knot/Cargo.toml +++ /dev/null @@ -1,39 +0,0 @@ -[package] -name = "red_knot" -version = "0.0.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - -[dependencies] -red_knot_python_semantic = { workspace = true } -red_knot_workspace = { workspace = true, features = ["zstd"] } -red_knot_server = { workspace = true } -ruff_db = { workspace = true, features = ["os", "cache"] } - -anyhow = { workspace = true } -chrono = { workspace = true } -clap = { workspace = true, features = ["wrap_help"] } -colored = { workspace = true } -countme = { workspace = true, features = ["enable"] } -crossbeam = { workspace = true } -ctrlc = { version = "3.4.4" } -rayon = { workspace = true } -salsa = { workspace = true } -tracing = { workspace = true, features = ["release_max_level_debug"] } -tracing-subscriber = { workspace = true, features = ["env-filter", "fmt"] } -tracing-flame = { workspace = true } -tracing-tree = { workspace = true } - -[dev-dependencies] -filetime = { workspace = true } -tempfile = { workspace = true } - -[lints] -workspace = true diff --git a/crates/red_knot/docs/tracing.md b/crates/red_knot/docs/tracing.md deleted file mode 100644 index 1b5feeadda606..0000000000000 --- a/crates/red_knot/docs/tracing.md +++ /dev/null @@ -1,128 +0,0 @@ -# Tracing - -Traces are a useful tool to narrow down the location of a bug or, at least, to understand why the compiler is doing a particular thing. -Note, tracing messages with severity `debug` or greater are user-facing. They should be phrased accordingly. -Tracing spans are only shown when using `-vvv`. - -## Verbosity levels - -The CLI supports different verbosity levels. - -- default: Only show errors and warnings. -- `-v` activates `info!`: Show generally useful information such as paths of configuration files, detected platform, etc., but it's not a lot of messages, it's something you'll activate in CI by default. cargo build e.g. shows you which packages are fresh. -- `-vv` activates `debug!` and timestamps: This should be enough information to get to the bottom of bug reports. When you're processing many packages or files, you'll get pages and pages of output, but each line is link to a specific action or state change. -- `-vvv` activates `trace!` (only in debug builds) and shows tracing-spans: At this level, you're logging everything. Most of this is wasted, it's really slow, we dump e.g. the entire resolution graph. Only useful to developers, and you almost certainly want to use `RED_KNOT_LOG` to filter it down to the area your investigating. - -## Better logging with `RED_KNOT_LOG` and `RAYON_NUM_THREADS` - -By default, the CLI shows messages from the `ruff` and `red_knot` crates. Tracing messages from other crates are not shown. -The `RED_KNOT_LOG` environment variable allows you to customize which messages are shown by specifying one -or more [filter directives](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives). - -The `RAYON_NUM_THREADS` environment variable, meanwhile, can be used to control the level of concurrency red-knot uses. -By default, red-knot will attempt to parallelize its work so that multiple files are checked simultaneously, -but this can result in a confused logging output where messages from different threads are intertwined. -To switch off concurrency entirely and have more readable logs, use `RAYON_NUM_THREADS=1`. - -### Examples - -#### Show all debug messages - -Shows debug messages from all crates. - -```bash -RED_KNOT_LOG=debug -``` - -#### Show salsa query execution messages - -Show the salsa `execute: my_query` messages in addition to all red knot messages. - -```bash -RED_KNOT_LOG=ruff=trace,red_knot=trace,salsa=info -``` - -#### Show typing traces - -Only show traces for the `red_knot_python_semantic::types` module. - -```bash -RED_KNOT_LOG="red_knot_python_semantic::types" -``` - -Note: Ensure that you use `-vvv` to see tracing spans. - -#### Show messages for a single file - -Shows all messages that are inside of a span for a specific file. - -```bash -RED_KNOT_LOG=red_knot[{file=/home/micha/astral/test/x.py}]=trace -``` - -**Note**: Tracing still shows all spans because tracing can't know at the time of entering the span -whether one if its children has the file `x.py`. - -**Note**: Salsa currently logs the entire memoized values. In our case, the source text and parsed AST. -This very quickly leads to extremely long outputs. - -## Tracing and Salsa - -Be mindful about using `tracing` in Salsa queries, especially when using `warn` or `error` because it isn't guaranteed -that the query will execute after restoring from a persistent cache. In which case the user won't see the message. - -For example, don't use `tracing` to show the user a message when generating a lint violation failed -because the message would only be shown when linting the file the first time, but not on subsequent analysis -runs or when restoring from a persistent cache. This can be confusing for users because they -don't understand why a specific lint violation isn't raised. Instead, change your -query to return the failure as part of the query's result or use a Salsa accumulator. - -## Tracing in tests - -You can use `ruff_db::testing::setup_logging` or `ruff_db::testing::setup_logging_with_filter` to set up logging in tests. - -```rust -use ruff_db::testing::setup_logging; - -#[test] -fn test() { - let _logging = setup_logging(); - - tracing::info!("This message will be printed to stderr"); -} -``` - -Note: Most test runners capture stderr and only show its output when a test fails. - -Note also that `setup_logging` only sets up logging for the current thread because [`set_global_default`](https://docs.rs/tracing/latest/tracing/subscriber/fn.set_global_default.html) can only be -called **once**. - -## Release builds - -`trace!` events are removed in release builds. - -## Profiling - -Red Knot generates a folded stack trace to the current directory named `tracing.folded` when setting the environment variable `RED_KNOT_LOG_PROFILE` to `1` or `true`. - -```bash -RED_KNOT_LOG_PROFILE=1 red_knot -- --current-directory=../test -vvv -``` - -You can convert the textual representation into a visual one using `inferno`. - -```shell -cargo install inferno -``` - -```shell -# flamegraph -cat tracing.folded | inferno-flamegraph > tracing-flamegraph.svg - -# flamechart -cat tracing.folded | inferno-flamegraph --flamechart > tracing-flamechart.svg -``` - -![Example flamegraph](./tracing-flamegraph.png) - -See [`tracing-flame`](https://crates.io/crates/tracing-flame) for more details. diff --git a/crates/red_knot/src/logging.rs b/crates/red_knot/src/logging.rs deleted file mode 100644 index 674c8841f67c4..0000000000000 --- a/crates/red_knot/src/logging.rs +++ /dev/null @@ -1,254 +0,0 @@ -//! Sets up logging for Red Knot - -use anyhow::Context; -use colored::Colorize; -use std::fmt; -use std::fs::File; -use std::io::BufWriter; -use tracing::{Event, Subscriber}; -use tracing_subscriber::filter::LevelFilter; -use tracing_subscriber::fmt::format::Writer; -use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields}; -use tracing_subscriber::registry::LookupSpan; -use tracing_subscriber::EnvFilter; - -/// Logging flags to `#[command(flatten)]` into your CLI -#[derive(clap::Args, Debug, Clone, Default)] -#[command(about = None, long_about = None)] -pub(crate) struct Verbosity { - #[arg( - long, - short = 'v', - help = "Use verbose output (or `-vv` and `-vvv` for more verbose output)", - action = clap::ArgAction::Count, - global = true, - )] - verbose: u8, -} - -impl Verbosity { - /// Returns the verbosity level based on the number of `-v` flags. - /// - /// Returns `None` if the user did not specify any verbosity flags. - pub(crate) fn level(&self) -> VerbosityLevel { - match self.verbose { - 0 => VerbosityLevel::Default, - 1 => VerbosityLevel::Verbose, - 2 => VerbosityLevel::ExtraVerbose, - _ => VerbosityLevel::Trace, - } - } -} - -#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] -pub(crate) enum VerbosityLevel { - /// Default output level. Only shows Ruff and Red Knot events up to the [`WARN`](tracing::Level::WARN). - Default, - - /// Enables verbose output. Emits Ruff and Red Knot events up to the [`INFO`](tracing::Level::INFO). - /// Corresponds to `-v`. - Verbose, - - /// Enables a more verbose tracing format and emits Ruff and Red Knot events up to [`DEBUG`](tracing::Level::DEBUG). - /// Corresponds to `-vv` - ExtraVerbose, - - /// Enables all tracing events and uses a tree-like output format. Corresponds to `-vvv`. - Trace, -} - -impl VerbosityLevel { - const fn level_filter(self) -> LevelFilter { - match self { - VerbosityLevel::Default => LevelFilter::WARN, - VerbosityLevel::Verbose => LevelFilter::INFO, - VerbosityLevel::ExtraVerbose => LevelFilter::DEBUG, - VerbosityLevel::Trace => LevelFilter::TRACE, - } - } - - pub(crate) const fn is_trace(self) -> bool { - matches!(self, VerbosityLevel::Trace) - } - - pub(crate) const fn is_extra_verbose(self) -> bool { - matches!(self, VerbosityLevel::ExtraVerbose) - } -} - -pub(crate) fn setup_tracing(level: VerbosityLevel) -> anyhow::Result { - use tracing_subscriber::prelude::*; - - // The `RED_KNOT_LOG` environment variable overrides the default log level. - let filter = if let Ok(log_env_variable) = std::env::var("RED_KNOT_LOG") { - EnvFilter::builder() - .parse(log_env_variable) - .context("Failed to parse directives specified in RED_KNOT_LOG environment variable.")? - } else { - match level { - VerbosityLevel::Default => { - // Show warning traces - EnvFilter::default().add_directive(LevelFilter::WARN.into()) - } - level => { - let level_filter = level.level_filter(); - - // Show info|debug|trace events, but allow `RED_KNOT_LOG` to override - let filter = EnvFilter::default().add_directive( - format!("red_knot={level_filter}") - .parse() - .expect("Hardcoded directive to be valid"), - ); - - filter.add_directive( - format!("ruff={level_filter}") - .parse() - .expect("Hardcoded directive to be valid"), - ) - } - } - }; - - let (profiling_layer, guard) = setup_profile(); - - let registry = tracing_subscriber::registry() - .with(filter) - .with(profiling_layer); - - if level.is_trace() { - let subscriber = registry.with( - tracing_tree::HierarchicalLayer::default() - .with_indent_lines(true) - .with_indent_amount(2) - .with_bracketed_fields(true) - .with_thread_ids(true) - .with_targets(true) - .with_writer(std::io::stderr) - .with_timer(tracing_tree::time::Uptime::default()), - ); - - subscriber.init(); - } else { - let subscriber = registry.with( - tracing_subscriber::fmt::layer() - .event_format(RedKnotFormat { - display_level: true, - display_timestamp: level.is_extra_verbose(), - show_spans: false, - }) - .with_writer(std::io::stderr), - ); - - subscriber.init(); - } - - Ok(TracingGuard { - _flame_guard: guard, - }) -} - -#[allow(clippy::type_complexity)] -fn setup_profile() -> ( - Option>>, - Option>>, -) -where - S: Subscriber + for<'span> LookupSpan<'span>, -{ - if let Ok("1" | "true") = std::env::var("RED_KNOT_LOG_PROFILE").as_deref() { - let (layer, guard) = tracing_flame::FlameLayer::with_file("tracing.folded") - .expect("Flame layer to be created"); - (Some(layer), Some(guard)) - } else { - (None, None) - } -} - -pub(crate) struct TracingGuard { - _flame_guard: Option>>, -} - -struct RedKnotFormat { - display_timestamp: bool, - display_level: bool, - show_spans: bool, -} - -/// See -impl FormatEvent for RedKnotFormat -where - S: Subscriber + for<'a> LookupSpan<'a>, - N: for<'a> FormatFields<'a> + 'static, -{ - fn format_event( - &self, - ctx: &FmtContext<'_, S, N>, - mut writer: Writer<'_>, - event: &Event<'_>, - ) -> fmt::Result { - let meta = event.metadata(); - let ansi = writer.has_ansi_escapes(); - - if self.display_timestamp { - let timestamp = chrono::Local::now() - .format("%Y-%m-%d %H:%M:%S.%f") - .to_string(); - if ansi { - write!(writer, "{} ", timestamp.dimmed())?; - } else { - write!( - writer, - "{} ", - chrono::Local::now().format("%Y-%m-%d %H:%M:%S.%f") - )?; - } - } - - if self.display_level { - let level = meta.level(); - // Same colors as tracing - if ansi { - let formatted_level = level.to_string(); - match *level { - tracing::Level::TRACE => { - write!(writer, "{} ", formatted_level.purple().bold())?; - } - tracing::Level::DEBUG => write!(writer, "{} ", formatted_level.blue().bold())?, - tracing::Level::INFO => write!(writer, "{} ", formatted_level.green().bold())?, - tracing::Level::WARN => write!(writer, "{} ", formatted_level.yellow().bold())?, - tracing::Level::ERROR => write!(writer, "{} ", level.to_string().red().bold())?, - } - } else { - write!(writer, "{level} ")?; - } - } - - if self.show_spans { - let span = event.parent(); - let mut seen = false; - - let span = span - .and_then(|id| ctx.span(id)) - .or_else(|| ctx.lookup_current()); - - let scope = span.into_iter().flat_map(|span| span.scope().from_root()); - - for span in scope { - seen = true; - if ansi { - write!(writer, "{}:", span.metadata().name().bold())?; - } else { - write!(writer, "{}:", span.metadata().name())?; - } - } - - if seen { - writer.write_char(' ')?; - } - } - - ctx.field_format().format_fields(writer.by_ref(), event)?; - - writeln!(writer) - } -} diff --git a/crates/red_knot/src/main.rs b/crates/red_knot/src/main.rs deleted file mode 100644 index 2244e5df2d4f3..0000000000000 --- a/crates/red_knot/src/main.rs +++ /dev/null @@ -1,384 +0,0 @@ -use std::process::{ExitCode, Termination}; -use std::sync::Mutex; - -use anyhow::{anyhow, Context}; -use clap::Parser; -use colored::Colorize; -use crossbeam::channel as crossbeam_channel; -use salsa::plumbing::ZalsaDatabase; - -use red_knot_python_semantic::SitePackages; -use red_knot_server::run_server; -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::watch; -use red_knot_workspace::watch::WorkspaceWatcher; -use red_knot_workspace::workspace::settings::Configuration; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_db::system::{OsSystem, System, SystemPath, SystemPathBuf}; -use target_version::TargetVersion; - -use crate::logging::{setup_tracing, Verbosity}; - -mod logging; -mod target_version; -mod verbosity; - -#[derive(Debug, Parser)] -#[command( - author, - name = "red-knot", - about = "An extremely fast Python type checker." -)] -#[command(version)] -struct Args { - #[command(subcommand)] - pub(crate) command: Option, - - #[arg( - long, - help = "Changes the current working directory.", - long_help = "Changes the current working directory before any specified operations. This affects the workspace and configuration discovery.", - value_name = "PATH" - )] - current_directory: Option, - - #[arg( - long, - help = "Path to the virtual environment the project uses", - long_help = "\ -Path to the virtual environment the project uses. \ -If provided, red-knot will use the `site-packages` directory of this virtual environment \ -to resolve type information for the project's third-party dependencies.", - value_name = "PATH" - )] - venv_path: Option, - - #[arg( - long, - value_name = "DIRECTORY", - help = "Custom directory to use for stdlib typeshed stubs" - )] - custom_typeshed_dir: Option, - - #[arg( - long, - value_name = "PATH", - help = "Additional path to use as a module-resolution source (can be passed multiple times)" - )] - extra_search_path: Option>, - - #[arg( - long, - help = "Python version to assume when resolving types", - value_name = "VERSION" - )] - target_version: Option, - - #[clap(flatten)] - verbosity: Verbosity, - - #[arg( - long, - help = "Run in watch mode by re-running whenever files change", - short = 'W' - )] - watch: bool, -} - -impl Args { - fn to_configuration(&self, cli_cwd: &SystemPath) -> Configuration { - let mut configuration = Configuration::default(); - - if let Some(target_version) = self.target_version { - configuration.target_version = Some(target_version.into()); - } - - if let Some(venv_path) = &self.venv_path { - configuration.search_paths.site_packages = Some(SitePackages::Derived { - venv_path: SystemPath::absolute(venv_path, cli_cwd), - }); - } - - if let Some(custom_typeshed_dir) = &self.custom_typeshed_dir { - configuration.search_paths.custom_typeshed = - Some(SystemPath::absolute(custom_typeshed_dir, cli_cwd)); - } - - if let Some(extra_search_paths) = &self.extra_search_path { - configuration.search_paths.extra_paths = extra_search_paths - .iter() - .map(|path| Some(SystemPath::absolute(path, cli_cwd))) - .collect(); - } - - configuration - } -} - -#[derive(Debug, clap::Subcommand)] -pub enum Command { - /// Start the language server - Server, -} - -#[allow(clippy::print_stdout, clippy::unnecessary_wraps, clippy::print_stderr)] -pub fn main() -> ExitStatus { - run().unwrap_or_else(|error| { - use std::io::Write; - - // Use `writeln` instead of `eprintln` to avoid panicking when the stderr pipe is broken. - let mut stderr = std::io::stderr().lock(); - - // This communicates that this isn't a linter error but Red Knot itself hard-errored for - // some reason (e.g. failed to resolve the configuration) - writeln!(stderr, "{}", "Red Knot failed".red().bold()).ok(); - // Currently we generally only see one error, but e.g. with io errors when resolving - // the configuration it is help to chain errors ("resolving configuration failed" -> - // "failed to read file: subdir/pyproject.toml") - for cause in error.chain() { - writeln!(stderr, " {} {cause}", "Cause:".bold()).ok(); - } - - ExitStatus::Error - }) -} - -fn run() -> anyhow::Result { - let args = Args::parse_from(std::env::args()); - - if matches!(args.command, Some(Command::Server)) { - return run_server().map(|()| ExitStatus::Success); - } - - let verbosity = args.verbosity.level(); - countme::enable(verbosity.is_trace()); - let _guard = setup_tracing(verbosity)?; - - // The base path to which all CLI arguments are relative to. - let cli_base_path = { - let cwd = std::env::current_dir().context("Failed to get the current working directory")?; - SystemPathBuf::from_path_buf(cwd) - .map_err(|path| { - anyhow!( - "The current working directory `{}` contains non-Unicode characters. Red Knot only supports Unicode paths.", - path.display() - ) - })? - }; - - let cwd = args - .current_directory - .as_ref() - .map(|cwd| { - if cwd.as_std_path().is_dir() { - Ok(SystemPath::absolute(cwd, &cli_base_path)) - } else { - Err(anyhow!( - "Provided current-directory path `{cwd}` is not a directory" - )) - } - }) - .transpose()? - .unwrap_or_else(|| cli_base_path.clone()); - - let system = OsSystem::new(cwd.clone()); - let cli_configuration = args.to_configuration(&cwd); - let workspace_metadata = WorkspaceMetadata::from_path( - system.current_directory(), - &system, - Some(cli_configuration.clone()), - )?; - - // TODO: Use the `program_settings` to compute the key for the database's persistent - // cache and load the cache if it exists. - let mut db = RootDatabase::new(workspace_metadata, system)?; - - let (main_loop, main_loop_cancellation_token) = MainLoop::new(cli_configuration); - - // Listen to Ctrl+C and abort the watch mode. - let main_loop_cancellation_token = Mutex::new(Some(main_loop_cancellation_token)); - ctrlc::set_handler(move || { - let mut lock = main_loop_cancellation_token.lock().unwrap(); - - if let Some(token) = lock.take() { - token.stop(); - } - })?; - - let exit_status = if args.watch { - main_loop.watch(&mut db)? - } else { - main_loop.run(&mut db) - }; - - tracing::trace!("Counts for entire CLI run:\n{}", countme::get_all()); - - std::mem::forget(db); - - Ok(exit_status) -} - -#[derive(Copy, Clone)] -pub enum ExitStatus { - /// Checking was successful and there were no errors. - Success = 0, - - /// Checking was successful but there were errors. - Failure = 1, - - /// Checking failed. - Error = 2, -} - -impl Termination for ExitStatus { - fn report(self) -> ExitCode { - ExitCode::from(self as u8) - } -} - -struct MainLoop { - /// Sender that can be used to send messages to the main loop. - sender: crossbeam_channel::Sender, - - /// Receiver for the messages sent **to** the main loop. - receiver: crossbeam_channel::Receiver, - - /// The file system watcher, if running in watch mode. - watcher: Option, - - cli_configuration: Configuration, -} - -impl MainLoop { - fn new(cli_configuration: Configuration) -> (Self, MainLoopCancellationToken) { - let (sender, receiver) = crossbeam_channel::bounded(10); - - ( - Self { - sender: sender.clone(), - receiver, - watcher: None, - cli_configuration, - }, - MainLoopCancellationToken { sender }, - ) - } - - fn watch(mut self, db: &mut RootDatabase) -> anyhow::Result { - tracing::debug!("Starting watch mode"); - let sender = self.sender.clone(); - let watcher = watch::directory_watcher(move |event| { - sender.send(MainLoopMessage::ApplyChanges(event)).unwrap(); - })?; - - self.watcher = Some(WorkspaceWatcher::new(watcher, db)); - - self.run(db); - - Ok(ExitStatus::Success) - } - - fn run(mut self, db: &mut RootDatabase) -> ExitStatus { - self.sender.send(MainLoopMessage::CheckWorkspace).unwrap(); - - let result = self.main_loop(db); - - tracing::debug!("Exiting main loop"); - - result - } - - fn main_loop(&mut self, db: &mut RootDatabase) -> ExitStatus { - // Schedule the first check. - tracing::debug!("Starting main loop"); - - let mut revision = 0u64; - - while let Ok(message) = self.receiver.recv() { - match message { - MainLoopMessage::CheckWorkspace => { - let db = db.snapshot(); - let sender = self.sender.clone(); - - // Spawn a new task that checks the workspace. This needs to be done in a separate thread - // to prevent blocking the main loop here. - rayon::spawn(move || { - if let Ok(result) = db.check() { - // Send the result back to the main loop for printing. - sender - .send(MainLoopMessage::CheckCompleted { result, revision }) - .unwrap(); - } - }); - } - - MainLoopMessage::CheckCompleted { - result, - revision: check_revision, - } => { - let has_diagnostics = !result.is_empty(); - if check_revision == revision { - for diagnostic in result { - tracing::error!("{}", diagnostic); - } - } else { - tracing::debug!( - "Discarding check result for outdated revision: current: {revision}, result revision: {check_revision}" - ); - } - - if self.watcher.is_none() { - return if has_diagnostics { - ExitStatus::Failure - } else { - ExitStatus::Success - }; - } - - tracing::trace!("Counts after last check:\n{}", countme::get_all()); - } - - MainLoopMessage::ApplyChanges(changes) => { - revision += 1; - // Automatically cancels any pending queries and waits for them to complete. - db.apply_changes(changes, Some(&self.cli_configuration)); - if let Some(watcher) = self.watcher.as_mut() { - watcher.update(db); - } - self.sender.send(MainLoopMessage::CheckWorkspace).unwrap(); - } - MainLoopMessage::Exit => { - // Cancel any pending queries and wait for them to complete. - // TODO: Don't use Salsa internal APIs - // [Zulip-Thread](https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries) - let _ = db.zalsa_mut(); - return ExitStatus::Success; - } - } - - tracing::debug!("Waiting for next main loop message."); - } - - ExitStatus::Success - } -} - -#[derive(Debug)] -struct MainLoopCancellationToken { - sender: crossbeam_channel::Sender, -} - -impl MainLoopCancellationToken { - fn stop(self) { - self.sender.send(MainLoopMessage::Exit).unwrap(); - } -} - -/// Message sent from the orchestrator to the main loop. -#[derive(Debug)] -enum MainLoopMessage { - CheckWorkspace, - CheckCompleted { result: Vec, revision: u64 }, - ApplyChanges(Vec), - Exit, -} diff --git a/crates/red_knot/src/target_version.rs b/crates/red_knot/src/target_version.rs deleted file mode 100644 index 7db3c514e890b..0000000000000 --- a/crates/red_knot/src/target_version.rs +++ /dev/null @@ -1,48 +0,0 @@ -/// Enumeration of all supported Python versions -/// -/// TODO: unify with the `PythonVersion` enum in the linter/formatter crates? -#[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] -pub enum TargetVersion { - Py37, - #[default] - Py38, - Py39, - Py310, - Py311, - Py312, - Py313, -} - -impl TargetVersion { - const fn as_str(self) -> &'static str { - match self { - Self::Py37 => "py37", - Self::Py38 => "py38", - Self::Py39 => "py39", - Self::Py310 => "py310", - Self::Py311 => "py311", - Self::Py312 => "py312", - Self::Py313 => "py313", - } - } -} - -impl std::fmt::Display for TargetVersion { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str(self.as_str()) - } -} - -impl From for red_knot_python_semantic::PythonVersion { - fn from(value: TargetVersion) -> Self { - match value { - TargetVersion::Py37 => Self::PY37, - TargetVersion::Py38 => Self::PY38, - TargetVersion::Py39 => Self::PY39, - TargetVersion::Py310 => Self::PY310, - TargetVersion::Py311 => Self::PY311, - TargetVersion::Py312 => Self::PY312, - TargetVersion::Py313 => Self::PY313, - } - } -} diff --git a/crates/red_knot/src/verbosity.rs b/crates/red_knot/src/verbosity.rs deleted file mode 100644 index 8b137891791fe..0000000000000 --- a/crates/red_knot/src/verbosity.rs +++ /dev/null @@ -1 +0,0 @@ - diff --git a/crates/red_knot/tests/file_watching.rs b/crates/red_knot/tests/file_watching.rs deleted file mode 100644 index 8067214235058..0000000000000 --- a/crates/red_knot/tests/file_watching.rs +++ /dev/null @@ -1,1313 +0,0 @@ -#![allow(clippy::disallowed_names)] - -use std::io::Write; -use std::time::Duration; - -use anyhow::{anyhow, Context}; - -use red_knot_python_semantic::{resolve_module, ModuleName, Program, PythonVersion, SitePackages}; -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::watch; -use red_knot_workspace::watch::{directory_watcher, WorkspaceWatcher}; -use red_knot_workspace::workspace::settings::{Configuration, SearchPathConfiguration}; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_db::files::{system_path_to_file, File, FileError}; -use ruff_db::source::source_text; -use ruff_db::system::{OsSystem, SystemPath, SystemPathBuf}; -use ruff_db::Upcast; - -struct TestCase { - db: RootDatabase, - watcher: Option, - changes_receiver: crossbeam::channel::Receiver>, - /// The temporary directory that contains the test files. - /// We need to hold on to it in the test case or the temp files get deleted. - _temp_dir: tempfile::TempDir, - root_dir: SystemPathBuf, - configuration: Configuration, -} - -impl TestCase { - fn workspace_path(&self, relative: impl AsRef) -> SystemPathBuf { - SystemPath::absolute(relative, self.db.workspace().root(&self.db)) - } - - fn root_path(&self) -> &SystemPath { - &self.root_dir - } - - fn db(&self) -> &RootDatabase { - &self.db - } - - fn stop_watch(&mut self) -> Vec { - self.try_stop_watch(Duration::from_secs(10)) - .expect("Expected watch changes but observed none") - } - - fn try_stop_watch(&mut self, timeout: Duration) -> Option> { - let watcher = self - .watcher - .take() - .expect("Cannot call `stop_watch` more than once"); - - let mut all_events = self - .changes_receiver - .recv_timeout(timeout) - .unwrap_or_default(); - watcher.flush(); - watcher.stop(); - - for event in &self.changes_receiver { - all_events.extend(event); - } - - if all_events.is_empty() { - return None; - } - - Some(all_events) - } - - #[cfg(unix)] - fn take_watch_changes(&self) -> Vec { - self.try_take_watch_changes(Duration::from_secs(10)) - .expect("Expected watch changes but observed none") - } - - fn try_take_watch_changes(&self, timeout: Duration) -> Option> { - let Some(watcher) = &self.watcher else { - return None; - }; - - let mut all_events = self - .changes_receiver - .recv_timeout(timeout) - .unwrap_or_default(); - watcher.flush(); - - while let Ok(event) = self - .changes_receiver - .recv_timeout(Duration::from_millis(10)) - { - all_events.extend(event); - watcher.flush(); - } - - if all_events.is_empty() { - return None; - } - Some(all_events) - } - - fn apply_changes(&mut self, changes: Vec) { - self.db.apply_changes(changes, Some(&self.configuration)); - } - - fn update_search_path_settings( - &mut self, - configuration: SearchPathConfiguration, - ) -> anyhow::Result<()> { - let program = Program::get(self.db()); - - self.configuration.search_paths = configuration.clone(); - let new_settings = configuration.into_settings(self.db.workspace().root(&self.db)); - - program.update_search_paths(&mut self.db, &new_settings)?; - - if let Some(watcher) = &mut self.watcher { - watcher.update(&self.db); - assert!(!watcher.has_errored_paths()); - } - - Ok(()) - } - - fn collect_package_files(&self, path: &SystemPath) -> Vec { - let package = self.db().workspace().package(self.db(), path).unwrap(); - let files = package.files(self.db()); - let mut collected: Vec<_> = files.into_iter().collect(); - collected.sort_unstable_by_key(|file| file.path(self.db()).as_system_path().unwrap()); - collected - } - - fn system_file(&self, path: impl AsRef) -> Result { - system_path_to_file(self.db(), path.as_ref()) - } -} - -trait SetupFiles { - fn setup(self, root_path: &SystemPath, workspace_path: &SystemPath) -> anyhow::Result<()>; -} - -impl SetupFiles for [(P, &'static str); N] -where - P: AsRef, -{ - fn setup(self, _root_path: &SystemPath, workspace_path: &SystemPath) -> anyhow::Result<()> { - for (relative_path, content) in self { - let relative_path = relative_path.as_ref(); - let absolute_path = workspace_path.join(relative_path); - if let Some(parent) = absolute_path.parent() { - std::fs::create_dir_all(parent).with_context(|| { - format!("Failed to create parent directory for file `{relative_path}`") - })?; - } - - let mut file = std::fs::File::create(absolute_path.as_std_path()) - .with_context(|| format!("Failed to open file `{relative_path}`"))?; - file.write_all(content.as_bytes()) - .with_context(|| format!("Failed to write to file `{relative_path}`"))?; - file.sync_data()?; - } - - Ok(()) - } -} - -impl SetupFiles for F -where - F: FnOnce(&SystemPath, &SystemPath) -> anyhow::Result<()>, -{ - fn setup(self, root_path: &SystemPath, workspace_path: &SystemPath) -> anyhow::Result<()> { - self(root_path, workspace_path) - } -} - -fn setup(setup_files: F) -> anyhow::Result -where - F: SetupFiles, -{ - setup_with_search_paths(setup_files, |_root, _workspace_path| { - SearchPathConfiguration::default() - }) -} - -fn setup_with_search_paths( - setup_files: F, - create_search_paths: impl FnOnce(&SystemPath, &SystemPath) -> SearchPathConfiguration, -) -> anyhow::Result -where - F: SetupFiles, -{ - let temp_dir = tempfile::tempdir()?; - - let root_path = SystemPath::from_std_path(temp_dir.path()).ok_or_else(|| { - anyhow!( - "Temporary directory `{}` is not a valid UTF-8 path.", - temp_dir.path().display() - ) - })?; - - let root_path = SystemPathBuf::from_utf8_path_buf( - root_path - .as_utf8_path() - .canonicalize_utf8() - .with_context(|| "Failed to canonicalize root path.")?, - ); - - let workspace_path = root_path.join("workspace"); - - std::fs::create_dir_all(workspace_path.as_std_path()) - .with_context(|| format!("Failed to create workspace directory `{workspace_path}`"))?; - - setup_files - .setup(&root_path, &workspace_path) - .context("Failed to setup test files")?; - - let system = OsSystem::new(&workspace_path); - - let search_paths = create_search_paths(&root_path, &workspace_path); - - for path in search_paths - .extra_paths - .iter() - .flatten() - .chain(search_paths.custom_typeshed.iter()) - .chain(search_paths.site_packages.iter().flat_map(|site_packages| { - if let SitePackages::Known(path) = site_packages { - path.as_slice() - } else { - &[] - } - })) - { - std::fs::create_dir_all(path.as_std_path()) - .with_context(|| format!("Failed to create search path `{path}`"))?; - } - - let configuration = Configuration { - target_version: Some(PythonVersion::PY312), - search_paths, - }; - - let workspace = - WorkspaceMetadata::from_path(&workspace_path, &system, Some(configuration.clone()))?; - - let db = RootDatabase::new(workspace, system)?; - - let (sender, receiver) = crossbeam::channel::unbounded(); - let watcher = directory_watcher(move |events| sender.send(events).unwrap()) - .with_context(|| "Failed to create directory watcher")?; - - let watcher = WorkspaceWatcher::new(watcher, &db); - assert!(!watcher.has_errored_paths()); - - let test_case = TestCase { - db, - changes_receiver: receiver, - watcher: Some(watcher), - _temp_dir: temp_dir, - root_dir: root_path, - configuration, - }; - - // Sometimes the file watcher reports changes for events that happened before the watcher was started. - // Do a best effort at dropping these events. - test_case.try_take_watch_changes(Duration::from_millis(100)); - - Ok(test_case) -} - -/// Updates the content of a file and ensures that the last modified file time is updated. -fn update_file(path: impl AsRef, content: &str) -> anyhow::Result<()> { - let path = path.as_ref().as_std_path(); - - let metadata = path.metadata()?; - let last_modified_time = filetime::FileTime::from_last_modification_time(&metadata); - - let mut file = std::fs::OpenOptions::new() - .create(false) - .write(true) - .truncate(true) - .open(path)?; - file.write_all(content.as_bytes())?; - - loop { - file.sync_all()?; - - let modified_time = filetime::FileTime::from_last_modification_time(&path.metadata()?); - - if modified_time != last_modified_time { - break Ok(()); - } - - std::thread::sleep(Duration::from_nanos(10)); - - filetime::set_file_handle_times(&file, None, Some(filetime::FileTime::now()))?; - } -} - -#[test] -fn new_file() -> anyhow::Result<()> { - let mut case = setup([("bar.py", "")])?; - let bar_path = case.workspace_path("bar.py"); - let bar_file = case.system_file(&bar_path).unwrap(); - let foo_path = case.workspace_path("foo.py"); - - assert_eq!(case.system_file(&foo_path), Err(FileError::NotFound)); - assert_eq!(&case.collect_package_files(&bar_path), &[bar_file]); - - std::fs::write(foo_path.as_std_path(), "print('Hello')")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - let foo = case.system_file(&foo_path).expect("foo.py to exist."); - - assert_eq!(&case.collect_package_files(&bar_path), &[bar_file, foo]); - - Ok(()) -} - -#[test] -fn new_ignored_file() -> anyhow::Result<()> { - let mut case = setup([("bar.py", ""), (".ignore", "foo.py")])?; - let bar_path = case.workspace_path("bar.py"); - let bar_file = case.system_file(&bar_path).unwrap(); - let foo_path = case.workspace_path("foo.py"); - - assert_eq!(case.system_file(&foo_path), Err(FileError::NotFound)); - assert_eq!(&case.collect_package_files(&bar_path), &[bar_file]); - - std::fs::write(foo_path.as_std_path(), "print('Hello')")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(case.system_file(&foo_path).is_ok()); - assert_eq!(&case.collect_package_files(&bar_path), &[bar_file]); - - Ok(()) -} - -#[test] -fn changed_file() -> anyhow::Result<()> { - let foo_source = "print('Hello, world!')"; - let mut case = setup([("foo.py", foo_source)])?; - let foo_path = case.workspace_path("foo.py"); - - let foo = case.system_file(&foo_path)?; - assert_eq!(source_text(case.db(), foo).as_str(), foo_source); - assert_eq!(&case.collect_package_files(&foo_path), &[foo]); - - update_file(&foo_path, "print('Version 2')")?; - - let changes = case.stop_watch(); - - assert!(!changes.is_empty()); - - case.apply_changes(changes); - - assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 2')"); - assert_eq!(&case.collect_package_files(&foo_path), &[foo]); - - Ok(()) -} - -#[test] -fn deleted_file() -> anyhow::Result<()> { - let foo_source = "print('Hello, world!')"; - let mut case = setup([("foo.py", foo_source)])?; - let foo_path = case.workspace_path("foo.py"); - - let foo = case.system_file(&foo_path)?; - - assert!(foo.exists(case.db())); - assert_eq!(&case.collect_package_files(&foo_path), &[foo]); - - std::fs::remove_file(foo_path.as_std_path())?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(!foo.exists(case.db())); - assert_eq!(&case.collect_package_files(&foo_path), &[] as &[File]); - - Ok(()) -} - -/// Tests the case where a file is moved from inside a watched directory to a directory that is not watched. -/// -/// This matches the behavior of deleting a file in VS code. -#[test] -fn move_file_to_trash() -> anyhow::Result<()> { - let foo_source = "print('Hello, world!')"; - let mut case = setup([("foo.py", foo_source)])?; - let foo_path = case.workspace_path("foo.py"); - - let trash_path = case.root_path().join(".trash"); - std::fs::create_dir_all(trash_path.as_std_path())?; - - let foo = case.system_file(&foo_path)?; - - assert!(foo.exists(case.db())); - assert_eq!(&case.collect_package_files(&foo_path), &[foo]); - - std::fs::rename( - foo_path.as_std_path(), - trash_path.join("foo.py").as_std_path(), - )?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(!foo.exists(case.db())); - assert_eq!(&case.collect_package_files(&foo_path), &[] as &[File]); - - Ok(()) -} - -/// Move a file from a non-workspace (non-watched) location into the workspace. -#[test] -fn move_file_to_workspace() -> anyhow::Result<()> { - let mut case = setup([("bar.py", "")])?; - let bar_path = case.workspace_path("bar.py"); - let bar = case.system_file(&bar_path).unwrap(); - - let foo_path = case.root_path().join("foo.py"); - std::fs::write(foo_path.as_std_path(), "")?; - - let foo_in_workspace_path = case.workspace_path("foo.py"); - - assert!(case.system_file(&foo_path).is_ok()); - assert_eq!(&case.collect_package_files(&bar_path), &[bar]); - assert!(case - .db() - .workspace() - .package(case.db(), &foo_path) - .is_none()); - - std::fs::rename(foo_path.as_std_path(), foo_in_workspace_path.as_std_path())?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - let foo_in_workspace = case.system_file(&foo_in_workspace_path)?; - - assert!(foo_in_workspace.exists(case.db())); - assert_eq!( - &case.collect_package_files(&foo_in_workspace_path), - &[bar, foo_in_workspace] - ); - - Ok(()) -} - -/// Rename a workspace file. -#[test] -fn rename_file() -> anyhow::Result<()> { - let mut case = setup([("foo.py", "")])?; - let foo_path = case.workspace_path("foo.py"); - let bar_path = case.workspace_path("bar.py"); - - let foo = case.system_file(&foo_path)?; - - assert_eq!(case.collect_package_files(&foo_path), [foo]); - - std::fs::rename(foo_path.as_std_path(), bar_path.as_std_path())?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(!foo.exists(case.db())); - - let bar = case.system_file(&bar_path)?; - - assert!(bar.exists(case.db())); - assert_eq!(case.collect_package_files(&foo_path), [bar]); - - Ok(()) -} - -#[test] -fn directory_moved_to_workspace() -> anyhow::Result<()> { - let mut case = setup([("bar.py", "import sub.a")])?; - let bar = case.system_file(case.workspace_path("bar.py")).unwrap(); - - let sub_original_path = case.root_path().join("sub"); - let init_original_path = sub_original_path.join("__init__.py"); - let a_original_path = sub_original_path.join("a.py"); - - std::fs::create_dir(sub_original_path.as_std_path()) - .with_context(|| "Failed to create sub directory")?; - std::fs::write(init_original_path.as_std_path(), "") - .with_context(|| "Failed to create __init__.py")?; - std::fs::write(a_original_path.as_std_path(), "").with_context(|| "Failed to create a.py")?; - - let sub_a_module = resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap(), - ); - - assert_eq!(sub_a_module, None); - assert_eq!( - case.collect_package_files(&case.workspace_path("bar.py")), - &[bar] - ); - - let sub_new_path = case.workspace_path("sub"); - std::fs::rename(sub_original_path.as_std_path(), sub_new_path.as_std_path()) - .with_context(|| "Failed to move sub directory")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - let init_file = case - .system_file(sub_new_path.join("__init__.py")) - .expect("__init__.py to exist"); - let a_file = case - .system_file(sub_new_path.join("a.py")) - .expect("a.py to exist"); - - // `import sub.a` should now resolve - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_some()); - - assert_eq!( - case.collect_package_files(&case.workspace_path("bar.py")), - &[bar, init_file, a_file] - ); - - Ok(()) -} - -#[test] -fn directory_moved_to_trash() -> anyhow::Result<()> { - let mut case = setup([ - ("bar.py", "import sub.a"), - ("sub/__init__.py", ""), - ("sub/a.py", ""), - ])?; - let bar = case.system_file(case.workspace_path("bar.py")).unwrap(); - - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_some()); - - let sub_path = case.workspace_path("sub"); - let init_file = case - .system_file(sub_path.join("__init__.py")) - .expect("__init__.py to exist"); - let a_file = case - .system_file(sub_path.join("a.py")) - .expect("a.py to exist"); - - assert_eq!( - case.collect_package_files(&case.workspace_path("bar.py")), - &[bar, init_file, a_file] - ); - - std::fs::create_dir(case.root_path().join(".trash").as_std_path())?; - let trashed_sub = case.root_path().join(".trash/sub"); - std::fs::rename(sub_path.as_std_path(), trashed_sub.as_std_path()) - .with_context(|| "Failed to move the sub directory to the trash")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - // `import sub.a` should no longer resolve - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_none()); - - assert!(!init_file.exists(case.db())); - assert!(!a_file.exists(case.db())); - - assert_eq!( - case.collect_package_files(&case.workspace_path("bar.py")), - &[bar] - ); - - Ok(()) -} - -#[test] -fn directory_renamed() -> anyhow::Result<()> { - let mut case = setup([ - ("bar.py", "import sub.a"), - ("sub/__init__.py", ""), - ("sub/a.py", ""), - ])?; - - let bar = case.system_file(case.workspace_path("bar.py")).unwrap(); - - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_some()); - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("foo.baz").unwrap() - ) - .is_none()); - - let sub_path = case.workspace_path("sub"); - let sub_init = case - .system_file(sub_path.join("__init__.py")) - .expect("__init__.py to exist"); - let sub_a = case - .system_file(sub_path.join("a.py")) - .expect("a.py to exist"); - - assert_eq!( - case.collect_package_files(&sub_path), - &[bar, sub_init, sub_a] - ); - - let foo_baz = case.workspace_path("foo/baz"); - - std::fs::create_dir(case.workspace_path("foo").as_std_path())?; - std::fs::rename(sub_path.as_std_path(), foo_baz.as_std_path()) - .with_context(|| "Failed to move the sub directory")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - // `import sub.a` should no longer resolve - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_none()); - // `import foo.baz` should now resolve - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("foo.baz").unwrap() - ) - .is_some()); - - // The old paths are no longer tracked - assert!(!sub_init.exists(case.db())); - assert!(!sub_a.exists(case.db())); - - let foo_baz_init = case - .system_file(foo_baz.join("__init__.py")) - .expect("__init__.py to exist"); - let foo_baz_a = case - .system_file(foo_baz.join("a.py")) - .expect("a.py to exist"); - - // The new paths are synced - - assert!(foo_baz_init.exists(case.db())); - assert!(foo_baz_a.exists(case.db())); - - assert_eq!( - case.collect_package_files(&sub_path), - &[bar, foo_baz_init, foo_baz_a] - ); - - Ok(()) -} - -#[test] -fn directory_deleted() -> anyhow::Result<()> { - let mut case = setup([ - ("bar.py", "import sub.a"), - ("sub/__init__.py", ""), - ("sub/a.py", ""), - ])?; - - let bar = case.system_file(case.workspace_path("bar.py")).unwrap(); - - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_some()); - - let sub_path = case.workspace_path("sub"); - - let init_file = case - .system_file(sub_path.join("__init__.py")) - .expect("__init__.py to exist"); - let a_file = case - .system_file(sub_path.join("a.py")) - .expect("a.py to exist"); - assert_eq!( - case.collect_package_files(&sub_path), - &[bar, init_file, a_file] - ); - - std::fs::remove_dir_all(sub_path.as_std_path()) - .with_context(|| "Failed to remove the sub directory")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - // `import sub.a` should no longer resolve - assert!(resolve_module( - case.db().upcast(), - &ModuleName::new_static("sub.a").unwrap() - ) - .is_none()); - - assert!(!init_file.exists(case.db())); - assert!(!a_file.exists(case.db())); - assert_eq!(case.collect_package_files(&sub_path), &[bar]); - - Ok(()) -} - -#[test] -fn search_path() -> anyhow::Result<()> { - let mut case = setup_with_search_paths( - [("bar.py", "import sub.a")], - |root_path, _workspace_path| SearchPathConfiguration { - site_packages: Some(SitePackages::Known(vec![root_path.join("site_packages")])), - ..SearchPathConfiguration::default() - }, - )?; - - let site_packages = case.root_path().join("site_packages"); - - assert_eq!( - resolve_module(case.db(), &ModuleName::new("a").unwrap()), - None - ); - - std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_some()); - assert_eq!( - case.collect_package_files(&case.workspace_path("bar.py")), - &[case.system_file(case.workspace_path("bar.py")).unwrap()] - ); - - Ok(()) -} - -#[test] -fn add_search_path() -> anyhow::Result<()> { - let mut case = setup([("bar.py", "import sub.a")])?; - - let site_packages = case.workspace_path("site_packages"); - std::fs::create_dir_all(site_packages.as_std_path())?; - - assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_none()); - - // Register site-packages as a search path. - case.update_search_path_settings(SearchPathConfiguration { - site_packages: Some(SitePackages::Known(vec![site_packages.clone()])), - ..SearchPathConfiguration::default() - }) - .expect("Search path settings to be valid"); - - std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_some()); - - Ok(()) -} - -#[test] -fn remove_search_path() -> anyhow::Result<()> { - let mut case = setup_with_search_paths( - [("bar.py", "import sub.a")], - |root_path, _workspace_path| SearchPathConfiguration { - site_packages: Some(SitePackages::Known(vec![root_path.join("site_packages")])), - ..SearchPathConfiguration::default() - }, - )?; - - // Remove site packages from the search path settings. - let site_packages = case.root_path().join("site_packages"); - case.update_search_path_settings(SearchPathConfiguration { - site_packages: None, - ..SearchPathConfiguration::default() - }) - .expect("Search path settings to be valid"); - - std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; - - let changes = case.try_stop_watch(Duration::from_millis(100)); - - assert_eq!(changes, None); - - Ok(()) -} - -#[test] -fn changed_versions_file() -> anyhow::Result<()> { - let mut case = setup_with_search_paths( - |root_path: &SystemPath, workspace_path: &SystemPath| { - std::fs::write(workspace_path.join("bar.py").as_std_path(), "import sub.a")?; - std::fs::create_dir_all(root_path.join("typeshed/stdlib").as_std_path())?; - std::fs::write(root_path.join("typeshed/stdlib/VERSIONS").as_std_path(), "")?; - std::fs::write( - root_path.join("typeshed/stdlib/os.pyi").as_std_path(), - "# not important", - )?; - - Ok(()) - }, - |root_path, _workspace_path| SearchPathConfiguration { - custom_typeshed: Some(root_path.join("typeshed")), - ..SearchPathConfiguration::default() - }, - )?; - - // Unset the custom typeshed directory. - assert_eq!( - resolve_module(case.db(), &ModuleName::new("os").unwrap()), - None - ); - - std::fs::write( - case.root_path() - .join("typeshed/stdlib/VERSIONS") - .as_std_path(), - "os: 3.0-", - )?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert!(resolve_module(case.db(), &ModuleName::new("os").unwrap()).is_some()); - - Ok(()) -} - -/// Watch a workspace that contains two files where one file is a hardlink to another. -/// -/// Setup: -/// ```text -/// - workspace -/// |- foo.py -/// |- bar.py (hard link to foo.py) -/// ``` -/// -/// # Linux -/// `inotify` only emits a single change event for the file that was changed. -/// Other files that point to the same inode (hardlinks) won't get updated. -/// -/// For reference: VS Code and PyCharm have the same behavior where the results for one of the -/// files are stale. -/// -/// # Windows -/// I haven't found any documentation that states the notification behavior on Windows but what -/// we're seeing is that Windows only emits a single event, similar to Linux. -#[test] -fn hard_links_in_workspace() -> anyhow::Result<()> { - let mut case = setup(|_root: &SystemPath, workspace: &SystemPath| { - let foo_path = workspace.join("foo.py"); - std::fs::write(foo_path.as_std_path(), "print('Version 1')")?; - - // Create a hardlink to `foo` - let bar_path = workspace.join("bar.py"); - std::fs::hard_link(foo_path.as_std_path(), bar_path.as_std_path()) - .context("Failed to create hard link from foo.py -> bar.py")?; - - Ok(()) - })?; - - let foo_path = case.workspace_path("foo.py"); - let foo = case.system_file(&foo_path).unwrap(); - let bar_path = case.workspace_path("bar.py"); - let bar = case.system_file(&bar_path).unwrap(); - - assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 1')"); - assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 1')"); - - // Write to the hard link target. - update_file(foo_path, "print('Version 2')").context("Failed to update foo.py")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 2')"); - - // macOS is the only platform that emits events for every hardlink. - if cfg!(target_os = "macos") { - assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 2')"); - } - - Ok(()) -} - -/// Watch a workspace that contains one file that is a hardlink to a file outside the workspace. -/// -/// Setup: -/// ```text -/// - foo.py -/// - workspace -/// |- bar.py (hard link to /foo.py) -/// ``` -/// -/// # Linux -/// inotiyf doesn't support observing changes to hard linked files. -/// -/// > Note: when monitoring a directory, events are not generated for -/// > the files inside the directory when the events are performed via -/// > a pathname (i.e., a link) that lies outside the monitored -/// > directory. [source](https://man7.org/linux/man-pages/man7/inotify.7.html) -/// -/// # Windows -/// > Retrieves information that describes the changes within the specified directory. -/// -/// [source](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-readdirectorychangesw) -/// -/// My interpretation of this is that Windows doesn't support observing changes made to -/// hard linked files outside the workspace. -#[test] -#[cfg_attr( - target_os = "linux", - ignore = "inotify doesn't support observing changes to hard linked files." -)] -#[cfg_attr( - target_os = "windows", - ignore = "windows doesn't support observing changes to hard linked files." -)] -fn hard_links_to_target_outside_workspace() -> anyhow::Result<()> { - let mut case = setup(|root: &SystemPath, workspace: &SystemPath| { - let foo_path = root.join("foo.py"); - std::fs::write(foo_path.as_std_path(), "print('Version 1')")?; - - // Create a hardlink to `foo` - let bar_path = workspace.join("bar.py"); - std::fs::hard_link(foo_path.as_std_path(), bar_path.as_std_path()) - .context("Failed to create hard link from foo.py -> bar.py")?; - - Ok(()) - })?; - - let foo_path = case.root_path().join("foo.py"); - let foo = case.system_file(&foo_path).unwrap(); - let bar_path = case.workspace_path("bar.py"); - let bar = case.system_file(&bar_path).unwrap(); - - assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 1')"); - assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 1')"); - - // Write to the hard link target. - update_file(foo_path, "print('Version 2')").context("Failed to update foo.py")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 2')"); - - Ok(()) -} - -#[cfg(unix)] -mod unix { - //! Tests that make use of unix specific file-system features. - use super::*; - - /// Changes the metadata of the only file in the workspace. - #[test] - fn changed_metadata() -> anyhow::Result<()> { - use std::os::unix::fs::PermissionsExt; - - let mut case = setup([("foo.py", "")])?; - let foo_path = case.workspace_path("foo.py"); - - let foo = case.system_file(&foo_path)?; - assert_eq!( - foo.permissions(case.db()), - Some( - std::fs::metadata(foo_path.as_std_path()) - .unwrap() - .permissions() - .mode() - ) - ); - - std::fs::set_permissions( - foo_path.as_std_path(), - std::fs::Permissions::from_mode(0o777), - ) - .with_context(|| "Failed to set file permissions.")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert_eq!( - foo.permissions(case.db()), - Some( - std::fs::metadata(foo_path.as_std_path()) - .unwrap() - .permissions() - .mode() - ) - ); - - Ok(()) - } - - /// A workspace path is a symlink to a file outside the workspace. - /// - /// Setup: - /// ```text - /// - bar - /// |- baz.py - /// - /// - workspace - /// |- bar -> /bar - /// ``` - /// - /// # macOS - /// This test case isn't supported on macOS. - /// macOS uses `FSEvents` and `FSEvents` doesn't emit an event if a file in a symlinked directory is changed. - /// - /// > Generally speaking, when working with file system event notifications, you will probably want to use lstat, - /// > because changes to the underlying file will not result in a change notification for the directory containing - /// > the symbolic link to that file. However, if you are working with a controlled file structure in - /// > which symbolic links always point within your watched tree, you might have reason to use stat. - /// - /// [source](https://developer.apple.com/library/archive/documentation/Darwin/Conceptual/FSEvents_ProgGuide/UsingtheFSEventsFramework/UsingtheFSEventsFramework.html#//apple_ref/doc/uid/TP40005289-CH4-SW4) - /// - /// Pyright also does not support this case. - #[test] - #[cfg_attr( - target_os = "macos", - ignore = "FSEvents doesn't emit change events for symlinked directories outside of the watched paths." - )] - fn symlink_target_outside_watched_paths() -> anyhow::Result<()> { - let mut case = setup(|root: &SystemPath, workspace: &SystemPath| { - // Set up the symlink target. - let link_target = root.join("bar"); - std::fs::create_dir_all(link_target.as_std_path()) - .context("Failed to create link target directory")?; - let baz_original = link_target.join("baz.py"); - std::fs::write(baz_original.as_std_path(), "def baz(): ...") - .context("Failed to write link target file")?; - - // Create a symlink inside the workspace - let bar = workspace.join("bar"); - std::os::unix::fs::symlink(link_target.as_std_path(), bar.as_std_path()) - .context("Failed to create symlink to bar package")?; - - Ok(()) - })?; - - let baz = resolve_module( - case.db().upcast(), - &ModuleName::new_static("bar.baz").unwrap(), - ) - .expect("Expected bar.baz to exist in site-packages."); - let baz_workspace = case.workspace_path("bar/baz.py"); - - assert_eq!( - source_text(case.db(), baz.file()).as_str(), - "def baz(): ..." - ); - assert_eq!( - baz.file().path(case.db()).as_system_path(), - Some(&*baz_workspace) - ); - - let baz_original = case.root_path().join("bar/baz.py"); - - // Write to the symlink target. - update_file(baz_original, "def baz(): print('Version 2')") - .context("Failed to update bar/baz.py")?; - - let changes = case.take_watch_changes(); - - case.apply_changes(changes); - - assert_eq!( - source_text(case.db(), baz.file()).as_str(), - "def baz(): print('Version 2')" - ); - - // Write to the symlink source. - update_file(baz_workspace, "def baz(): print('Version 3')") - .context("Failed to update bar/baz.py")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert_eq!( - source_text(case.db(), baz.file()).as_str(), - "def baz(): print('Version 3')" - ); - - Ok(()) - } - - /// Workspace contains a symlink to another directory inside the workspace. - /// Changes to files in the symlinked directory should be reflected - /// to all files. - /// - /// Setup: - /// ```text - /// - workspace - /// | - bar -> /workspace/patched/bar - /// | - /// | - patched - /// | |-- bar - /// | | |- baz.py - /// | - /// |-- foo.py - /// ``` - #[test] - fn symlink_inside_workspace() -> anyhow::Result<()> { - let mut case = setup(|_root: &SystemPath, workspace: &SystemPath| { - // Set up the symlink target. - let link_target = workspace.join("patched/bar"); - std::fs::create_dir_all(link_target.as_std_path()) - .context("Failed to create link target directory")?; - let baz_original = link_target.join("baz.py"); - std::fs::write(baz_original.as_std_path(), "def baz(): ...") - .context("Failed to write link target file")?; - - // Create a symlink inside site-packages - let bar_in_workspace = workspace.join("bar"); - std::os::unix::fs::symlink(link_target.as_std_path(), bar_in_workspace.as_std_path()) - .context("Failed to create symlink to bar package")?; - - Ok(()) - })?; - - let baz = resolve_module( - case.db().upcast(), - &ModuleName::new_static("bar.baz").unwrap(), - ) - .expect("Expected bar.baz to exist in site-packages."); - let bar_baz = case.workspace_path("bar/baz.py"); - - let patched_bar_baz = case.workspace_path("patched/bar/baz.py"); - let patched_bar_baz_file = case.system_file(&patched_bar_baz).unwrap(); - - assert_eq!( - source_text(case.db(), patched_bar_baz_file).as_str(), - "def baz(): ..." - ); - - assert_eq!( - source_text(case.db(), baz.file()).as_str(), - "def baz(): ..." - ); - assert_eq!(baz.file().path(case.db()).as_system_path(), Some(&*bar_baz)); - - // Write to the symlink target. - update_file(&patched_bar_baz, "def baz(): print('Version 2')") - .context("Failed to update bar/baz.py")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - // The file watcher is guaranteed to emit one event for the changed file, but it isn't specified - // if the event is emitted for the "original" or linked path because both paths are watched. - // The best we can assert here is that one of the files should have been updated. - // - // In a perfect world, the file watcher would emit two events, one for the original file and - // one for the symlink. I tried parcel/watcher, node's `fs.watch` and `chokidar` and - // only `chokidar seems to support it (used by Pyright). - // - // I further tested how good editor support is for symlinked files and it is not good ;) - // * VS Code doesn't update the file content if a file gets changed through a symlink - // * PyCharm doesn't update diagnostics if a symlinked module is changed (same as red knot). - // - // That's why I think it's fine to not support this case for now. - - let patched_baz_text = source_text(case.db(), patched_bar_baz_file); - let did_update_patched_baz = patched_baz_text.as_str() == "def baz(): print('Version 2')"; - - let bar_baz_text = source_text(case.db(), baz.file()); - let did_update_bar_baz = bar_baz_text.as_str() == "def baz(): print('Version 2')"; - - assert!( - did_update_patched_baz || did_update_bar_baz, - "Expected one of the files to be updated but neither file was updated.\nOriginal: {patched_baz_text}\nSymlinked: {bar_baz_text}", - patched_baz_text = patched_baz_text.as_str(), - bar_baz_text = bar_baz_text.as_str() - ); - - Ok(()) - } - - /// A module search path is a symlink. - /// - /// Setup: - /// ```text - /// - site-packages - /// | - bar/baz.py - /// - /// - workspace - /// |-- .venv/lib/python3.12/site-packages -> /site-packages - /// | - /// |-- foo.py - /// ``` - #[test] - fn symlinked_module_search_path() -> anyhow::Result<()> { - let mut case = setup_with_search_paths( - |root: &SystemPath, workspace: &SystemPath| { - // Set up the symlink target. - let site_packages = root.join("site-packages"); - let bar = site_packages.join("bar"); - std::fs::create_dir_all(bar.as_std_path()) - .context("Failed to create bar directory")?; - let baz_original = bar.join("baz.py"); - std::fs::write(baz_original.as_std_path(), "def baz(): ...") - .context("Failed to write baz.py")?; - - // Symlink the site packages in the venv to the global site packages - let venv_site_packages = workspace.join(".venv/lib/python3.12/site-packages"); - std::fs::create_dir_all(venv_site_packages.parent().unwrap()) - .context("Failed to create .venv directory")?; - std::os::unix::fs::symlink( - site_packages.as_std_path(), - venv_site_packages.as_std_path(), - ) - .context("Failed to create symlink to site-packages")?; - - Ok(()) - }, - |_root, workspace| SearchPathConfiguration { - site_packages: Some(SitePackages::Known(vec![ - workspace.join(".venv/lib/python3.12/site-packages") - ])), - ..SearchPathConfiguration::default() - }, - )?; - - let baz = resolve_module( - case.db().upcast(), - &ModuleName::new_static("bar.baz").unwrap(), - ) - .expect("Expected bar.baz to exist in site-packages."); - let baz_site_packages_path = - case.workspace_path(".venv/lib/python3.12/site-packages/bar/baz.py"); - let baz_site_packages = case.system_file(&baz_site_packages_path).unwrap(); - let baz_original = case.root_path().join("site-packages/bar/baz.py"); - let baz_original_file = case.system_file(&baz_original).unwrap(); - - assert_eq!( - source_text(case.db(), baz_original_file).as_str(), - "def baz(): ..." - ); - - assert_eq!( - source_text(case.db(), baz_site_packages).as_str(), - "def baz(): ..." - ); - assert_eq!( - baz.file().path(case.db()).as_system_path(), - Some(&*baz_original) - ); - - // Write to the symlink target. - update_file(&baz_original, "def baz(): print('Version 2')") - .context("Failed to update bar/baz.py")?; - - let changes = case.stop_watch(); - - case.apply_changes(changes); - - assert_eq!( - source_text(case.db(), baz_original_file).as_str(), - "def baz(): print('Version 2')" - ); - - // It would be nice if this is supported but the underlying file system watchers - // only emit a single event. For reference - // * VS Code doesn't update the file content if a file gets changed through a symlink - // * PyCharm doesn't update diagnostics if a symlinked module is changed (same as red knot). - // We could add support for it by keeping a reverse map from `real_path` to symlinked path but - // it doesn't seem worth doing considering that as prominent tools like PyCharm don't support it. - // Pyright does support it, thanks to chokidar. - assert_ne!( - source_text(case.db(), baz_site_packages).as_str(), - "def baz(): print('Version 2')" - ); - - Ok(()) - } -} diff --git a/crates/red_knot_python_semantic/Cargo.toml b/crates/red_knot_python_semantic/Cargo.toml deleted file mode 100644 index 27b7684544ec8..0000000000000 --- a/crates/red_knot_python_semantic/Cargo.toml +++ /dev/null @@ -1,52 +0,0 @@ -[package] -name = "red_knot_python_semantic" -version = "0.0.0" -publish = false -authors = { workspace = true } -edition = { workspace = true } -rust-version = { workspace = true } -homepage = { workspace = true } -documentation = { workspace = true } -repository = { workspace = true } -license = { workspace = true } - -[dependencies] -ruff_db = { workspace = true } -ruff_index = { workspace = true } -ruff_python_ast = { workspace = true } -ruff_python_stdlib = { workspace = true } -ruff_source_file = { workspace = true } -ruff_text_size = { workspace = true } -ruff_python_literal = { workspace = true } - -anyhow = { workspace = true } -bitflags = { workspace = true } -camino = { workspace = true } -compact_str = { workspace = true } -countme = { workspace = true } -itertools = { workspace = true} -ordermap = { workspace = true } -salsa = { workspace = true } -thiserror = { workspace = true } -tracing = { workspace = true } -rustc-hash = { workspace = true } -hashbrown = { workspace = true } -smallvec = { workspace = true } -static_assertions = { workspace = true } -test-case = { workspace = true } -memchr = { workspace = true } - -[dev-dependencies] -ruff_db = { workspace = true, features = ["os", "testing"] } -ruff_python_parser = { workspace = true } -red_knot_test = { workspace = true } -red_knot_vendored = { workspace = true } - -anyhow = { workspace = true } -dir-test = {workspace = true} -insta = { workspace = true } -tempfile = { workspace = true } - -[lints] -workspace = true - diff --git a/crates/red_knot_python_semantic/resources/README.md b/crates/red_knot_python_semantic/resources/README.md deleted file mode 100644 index 0a04772b9af87..0000000000000 --- a/crates/red_knot_python_semantic/resources/README.md +++ /dev/null @@ -1,4 +0,0 @@ -Markdown files within the `mdtest/` subdirectory are tests of type inference and type checking; -executed by the `tests/mdtest.rs` integration test. - -See `crates/red_knot_test/README.md` for documentation of this test format. diff --git a/crates/red_knot_python_semantic/resources/mdtest/assignment/annotations.md b/crates/red_knot_python_semantic/resources/mdtest/assignment/annotations.md deleted file mode 100644 index 68481fc2a5724..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/assignment/annotations.md +++ /dev/null @@ -1,43 +0,0 @@ -# Assignment with annotations - -## Annotation only transparent to local inference - -```py -x = 1 -x: int -y = x - -reveal_type(y) # revealed: Literal[1] -``` - -## Violates own annotation - -```py -x: int = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]` is not assignable to `int`" -``` - -## Violates previous annotation - -```py -x: int -x = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]` is not assignable to `int`" -``` - -## PEP-604 annotations are supported - -```py -def foo() -> str | int | None: - return None - -reveal_type(foo()) # revealed: str | int | None - -def bar() -> str | str | None: - return None - -reveal_type(bar()) # revealed: str | None - -def baz() -> str | str: - return "Hello, world!" - -reveal_type(baz()) # revealed: str -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/assignment/unbound.md b/crates/red_knot_python_semantic/resources/mdtest/assignment/unbound.md deleted file mode 100644 index 980dd4b510e3d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/assignment/unbound.md +++ /dev/null @@ -1,32 +0,0 @@ -# Unbound - -## Unbound - -```py -x = foo # error: [unresolved-reference] "Name `foo` used when not defined" -foo = 1 - -# error: [unresolved-reference] -# revealed: Unbound -reveal_type(x) -``` - -## Unbound class variable - -Name lookups within a class scope fall back to globals, but lookups of class attributes don't. - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 - -class C: - y = x - if flag: - x = 2 - -reveal_type(C.x) # revealed: Literal[2] -reveal_type(C.y) # revealed: Literal[1] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/attributes.md b/crates/red_knot_python_semantic/resources/mdtest/attributes.md deleted file mode 100644 index 3278a7e48a2d7..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/attributes.md +++ /dev/null @@ -1,20 +0,0 @@ -# Class attributes - -## Union of attributes - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - class C: - x = 1 - -else: - class C: - x = 2 - -reveal_type(C.x) # revealed: Literal[1, 2] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/binary/booleans.md b/crates/red_knot_python_semantic/resources/mdtest/binary/booleans.md deleted file mode 100644 index 7184c1a631b4d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/binary/booleans.md +++ /dev/null @@ -1,48 +0,0 @@ -## Binary operations on booleans - -## Basic Arithmetic - -We try to be precise and all operations except for division will result in Literal type. - -```py -a = True -b = False - -reveal_type(a + a) # revealed: Literal[2] -reveal_type(a + b) # revealed: Literal[1] -reveal_type(b + a) # revealed: Literal[1] -reveal_type(b + b) # revealed: Literal[0] - -reveal_type(a - a) # revealed: Literal[0] -reveal_type(a - b) # revealed: Literal[1] -reveal_type(b - a) # revealed: Literal[-1] -reveal_type(b - b) # revealed: Literal[0] - -reveal_type(a * a) # revealed: Literal[1] -reveal_type(a * b) # revealed: Literal[0] -reveal_type(b * a) # revealed: Literal[0] -reveal_type(b * b) # revealed: Literal[0] - -reveal_type(a % a) # revealed: Literal[0] -reveal_type(b % a) # revealed: Literal[0] - -reveal_type(a // a) # revealed: Literal[1] -reveal_type(b // a) # revealed: Literal[0] - -reveal_type(a**a) # revealed: Literal[1] -reveal_type(a**b) # revealed: Literal[1] -reveal_type(b**a) # revealed: Literal[0] -reveal_type(b**b) # revealed: Literal[1] - -# Division -reveal_type(a / a) # revealed: float -reveal_type(b / a) # revealed: float -b / b # error: [division-by-zero] "Cannot divide object of type `Literal[False]` by zero" -a / b # error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" - -# bitwise OR -reveal_type(a | a) # revealed: Literal[True] -reveal_type(a | b) # revealed: Literal[True] -reveal_type(b | a) # revealed: Literal[True] -reveal_type(b | b) # revealed: Literal[False] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/binary/instances.md b/crates/red_knot_python_semantic/resources/mdtest/binary/instances.md deleted file mode 100644 index 9375f197c0be3..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/binary/instances.md +++ /dev/null @@ -1,447 +0,0 @@ -# Binary operations on instances - -Binary operations in Python are implemented by means of magic double-underscore methods. - -For references, see: - -- -- - -## Operations - -We support inference for all Python's binary operators: -`+`, `-`, `*`, `@`, `/`, `//`, `%`, `**`, `<<`, `>>`, `&`, `^`, and `|`. - -```py -class A: - def __add__(self, other) -> A: - return self - - def __sub__(self, other) -> A: - return self - - def __mul__(self, other) -> A: - return self - - def __matmul__(self, other) -> A: - return self - - def __truediv__(self, other) -> A: - return self - - def __floordiv__(self, other) -> A: - return self - - def __mod__(self, other) -> A: - return self - - def __pow__(self, other) -> A: - return self - - def __lshift__(self, other) -> A: - return self - - def __rshift__(self, other) -> A: - return self - - def __and__(self, other) -> A: - return self - - def __xor__(self, other) -> A: - return self - - def __or__(self, other) -> A: - return self - -class B: ... - -reveal_type(A() + B()) # revealed: A -reveal_type(A() - B()) # revealed: A -reveal_type(A() * B()) # revealed: A -reveal_type(A() @ B()) # revealed: A -reveal_type(A() / B()) # revealed: A -reveal_type(A() // B()) # revealed: A -reveal_type(A() % B()) # revealed: A -reveal_type(A() ** B()) # revealed: A -reveal_type(A() << B()) # revealed: A -reveal_type(A() >> B()) # revealed: A -reveal_type(A() & B()) # revealed: A -reveal_type(A() ^ B()) # revealed: A -reveal_type(A() | B()) # revealed: A -``` - -## Reflected - -We also support inference for reflected operations: - -```py -class A: - def __radd__(self, other) -> A: - return self - - def __rsub__(self, other) -> A: - return self - - def __rmul__(self, other) -> A: - return self - - def __rmatmul__(self, other) -> A: - return self - - def __rtruediv__(self, other) -> A: - return self - - def __rfloordiv__(self, other) -> A: - return self - - def __rmod__(self, other) -> A: - return self - - def __rpow__(self, other) -> A: - return self - - def __rlshift__(self, other) -> A: - return self - - def __rrshift__(self, other) -> A: - return self - - def __rand__(self, other) -> A: - return self - - def __rxor__(self, other) -> A: - return self - - def __ror__(self, other) -> A: - return self - -class B: ... - -reveal_type(B() + A()) # revealed: A -reveal_type(B() - A()) # revealed: A -reveal_type(B() * A()) # revealed: A -reveal_type(B() @ A()) # revealed: A -reveal_type(B() / A()) # revealed: A -reveal_type(B() // A()) # revealed: A -reveal_type(B() % A()) # revealed: A -reveal_type(B() ** A()) # revealed: A -reveal_type(B() << A()) # revealed: A -reveal_type(B() >> A()) # revealed: A -reveal_type(B() & A()) # revealed: A -reveal_type(B() ^ A()) # revealed: A -reveal_type(B() | A()) # revealed: A -``` - -## Returning a different type - -The magic methods aren't required to return the type of `self`: - -```py -class A: - def __add__(self, other) -> int: - return 1 - - def __rsub__(self, other) -> int: - return 1 - -class B: ... - -reveal_type(A() + B()) # revealed: int -reveal_type(B() - A()) # revealed: int -``` - -## Non-reflected precedence in general - -In general, if the left-hand side defines `__add__` and the right-hand side -defines `__radd__` and the right-hand side is not a subtype of the left-hand -side, `lhs.__add__` will take precedence: - -```py -class A: - def __add__(self, other: B) -> int: - return 42 - -class B: - def __radd__(self, other: A) -> str: - return "foo" - -reveal_type(A() + B()) # revealed: int - -# Edge case: C is a subtype of C, *but* if the two sides are of *equal* types, -# the lhs *still* takes precedence -class C: - def __add__(self, other: C) -> int: - return 42 - - def __radd__(self, other: C) -> str: - return "foo" - -reveal_type(C() + C()) # revealed: int -``` - -## Reflected precedence for subtypes (in some cases) - -If the right-hand operand is a subtype of the left-hand operand and has a -different implementation of the reflected method, the reflected method on the -right-hand operand takes precedence. - -```py -class A: - def __add__(self, other) -> str: - return "foo" - - def __radd__(self, other) -> str: - return "foo" - -class MyString(str): ... - -class B(A): - def __radd__(self, other) -> MyString: - return MyString() - -reveal_type(A() + B()) # revealed: MyString - -# N.B. Still a subtype of `A`, even though `A` does not appear directly in the class's `__bases__` -class C(B): ... - -# TODO: we currently only understand direct subclasses as subtypes of the superclass. -# We need to iterate through the full MRO rather than just the class's bases; -# if we do, we'll understand `C` as a subtype of `A`, and correctly understand this as being -# `MyString` rather than `str` -reveal_type(A() + C()) # revealed: str -``` - -## Reflected precedence 2 - -If the right-hand operand is a subtype of the left-hand operand, but does not -override the reflected method, the left-hand operand's non-reflected method -still takes precedence: - -```py -class A: - def __add__(self, other) -> str: - return "foo" - - def __radd__(self, other) -> int: - return 42 - -class B(A): ... - -reveal_type(A() + B()) # revealed: str -``` - -## Only reflected supported - -For example, at runtime, `(1).__add__(1.2)` is `NotImplemented`, but -`(1.2).__radd__(1) == 2.2`, meaning that `1 + 1.2` succeeds at runtime -(producing `2.2`). The runtime tries the second one only if the first one -returns `NotImplemented` to signal failure. - -Typeshed and other stubs annotate dunder-method calls that would return -`NotImplemented` as being "illegal" calls. `int.__add__` is annotated as only -"accepting" `int`s, even though it strictly-speaking "accepts" any other object -without raising an exception -- it will simply return `NotImplemented`, -allowing the runtime to try the `__radd__` method of the right-hand operand -as well. - -```py -class A: - def __sub__(self, other: A) -> A: - return A() - -class B: - def __rsub__(self, other: A) -> B: - return B() - -# TODO: this should be `B` (the return annotation of `B.__rsub__`), -# because `A.__sub__` is annotated as only accepting `A`, -# but `B.__rsub__` will accept `A`. -reveal_type(A() - B()) # revealed: A -``` - -## Callable instances as dunders - -Believe it or not, this is supported at runtime: - -```py -class A: - def __call__(self, other) -> int: - return 42 - -class B: - __add__ = A() - -reveal_type(B() + B()) # revealed: int -``` - -## Integration test: numbers from typeshed - -```py -reveal_type(3j + 3.14) # revealed: complex -reveal_type(4.2 + 42) # revealed: float -reveal_type(3j + 3) # revealed: complex - -# TODO should be complex, need to check arg type and fall back to `rhs.__radd__` -reveal_type(3.14 + 3j) # revealed: float - -# TODO should be float, need to check arg type and fall back to `rhs.__radd__` -reveal_type(42 + 4.2) # revealed: int - -# TODO should be complex, need to check arg type and fall back to `rhs.__radd__` -reveal_type(3 + 3j) # revealed: int - -def returns_int() -> int: - return 42 - -def returns_bool() -> bool: - return True - -x = returns_bool() -y = returns_int() - -reveal_type(x + y) # revealed: int -reveal_type(4.2 + x) # revealed: float - -# TODO should be float, need to check arg type and fall back to `rhs.__radd__` -reveal_type(y + 4.12) # revealed: int -``` - -## With literal types - -When we have a literal type for one operand, we're able to fall back to the -instance handling for its instance super-type. - -```py -class A: - def __add__(self, other) -> A: - return self - - def __radd__(self, other) -> A: - return self - -reveal_type(A() + 1) # revealed: A -# TODO should be `A` since `int.__add__` doesn't support `A` instances -reveal_type(1 + A()) # revealed: int - -reveal_type(A() + "foo") # revealed: A -# TODO should be `A` since `str.__add__` doesn't support `A` instances -# TODO overloads -reveal_type("foo" + A()) # revealed: @Todo - -reveal_type(A() + b"foo") # revealed: A -# TODO should be `A` since `bytes.__add__` doesn't support `A` instances -reveal_type(b"foo" + A()) # revealed: bytes - -reveal_type(A() + ()) # revealed: A -# TODO this should be `A`, since `tuple.__add__` doesn't support `A` instances -reveal_type(() + A()) # revealed: @Todo - -literal_string_instance = "foo" * 1_000_000_000 -# the test is not testing what it's meant to be testing if this isn't a `LiteralString`: -reveal_type(literal_string_instance) # revealed: LiteralString - -reveal_type(A() + literal_string_instance) # revealed: A -# TODO should be `A` since `str.__add__` doesn't support `A` instances -# TODO overloads -reveal_type(literal_string_instance + A()) # revealed: @Todo -``` - -## Operations involving instances of classes inheriting from `Any` - -`Any` and `Unknown` represent a set of possible runtime objects, wherein the -bounds of the set are unknown. Whether the left-hand operand's dunder or the -right-hand operand's reflected dunder depends on whether the right-hand operand -is an instance of a class that is a subclass of the left-hand operand's class -and overrides the reflected dunder. In the following example, because of the -unknowable nature of `Any`/`Unknown`, we must consider both possibilities: -`Any`/`Unknown` might resolve to an unknown third class that inherits from `X` -and overrides `__radd__`; but it also might not. Thus, the correct answer here -for the `reveal_type` is `int | Unknown`. - -```py -from does_not_exist import Foo # error: [unresolved-import] - -reveal_type(Foo) # revealed: Unknown - -class X: - def __add__(self, other: object) -> int: - return 42 - -class Y(Foo): ... - -# TODO: Should be `int | Unknown`; see above discussion. -reveal_type(X() + Y()) # revealed: int -``` - -## Unsupported - -### Dunder as instance attribute - -The magic method must exist on the class, not just on the instance: - -```py -def add_impl(self, other) -> int: - return 1 - -class A: - def __init__(self): - self.__add__ = add_impl - -# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `A` and `A`" -# revealed: Unknown -reveal_type(A() + A()) -``` - -### Missing dunder - -```py -class A: ... - -# error: [unsupported-operator] -# revealed: Unknown -reveal_type(A() + A()) -``` - -### Wrong position - -A left-hand dunder method doesn't apply for the right-hand operand, or vice versa: - -```py -class A: - def __add__(self, other) -> int: ... - -class B: - def __radd__(self, other) -> int: ... - -class C: ... - -# error: [unsupported-operator] -# revealed: Unknown -reveal_type(C() + A()) - -# error: [unsupported-operator] -# revealed: Unknown -reveal_type(B() + C()) -``` - -### Reflected dunder is not tried between two objects of the same type - -For the specific case where the left-hand operand is the exact same type as the -right-hand operand, the reflected dunder of the right-hand operand is not -tried; the runtime short-circuits after trying the unreflected dunder of the -left-hand operand. For context, see -[this mailing list discussion](https://mail.python.org/archives/list/python-dev@python.org/thread/7NZUCODEAPQFMRFXYRMGJXDSIS3WJYIV/). - -```py -class Foo: - def __radd__(self, other: Foo) -> Foo: - return self - -# error: [unsupported-operator] -# revealed: Unknown -reveal_type(Foo() + Foo()) -``` - -### Wrong type - -TODO: check signature and error if `other` is the wrong type diff --git a/crates/red_knot_python_semantic/resources/mdtest/binary/integers.md b/crates/red_knot_python_semantic/resources/mdtest/binary/integers.md deleted file mode 100644 index 0f4fe2d1fbdfc..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/binary/integers.md +++ /dev/null @@ -1,70 +0,0 @@ -# Binary operations on integers - -## Basic Arithmetic - -```py -reveal_type(2 + 1) # revealed: Literal[3] -reveal_type(3 - 4) # revealed: Literal[-1] -reveal_type(3 * -1) # revealed: Literal[-3] -reveal_type(-3 // 3) # revealed: Literal[-1] -reveal_type(-3 / 3) # revealed: float -reveal_type(5 % 3) # revealed: Literal[2] -``` - -## Power - -For power if the result fits in the int literal type it will be a Literal type. Otherwise the -outcome is int. - -```py -largest_u32 = 4_294_967_295 -reveal_type(2**2) # revealed: Literal[4] -reveal_type(1 ** (largest_u32 + 1)) # revealed: int -reveal_type(2**largest_u32) # revealed: int -``` - -## Division by Zero - -This error is really outside the current Python type system, because e.g. `int.__truediv__` and -friends are not annotated to indicate that it's an error, and we don't even have a facility to -permit such an annotation. So arguably divide-by-zero should be a lint error rather than a type -checker error. But we choose to go ahead and error in the cases that are very likely to be an error: -dividing something typed as `int` or `float` by something known to be `Literal[0]`. - -This isn't _definitely_ an error, because the object typed as `int` or `float` could be an instance -of a custom subclass which overrides division behavior to handle zero without error. But if this -unusual case occurs, the error can be avoided by explicitly typing the dividend as that safe custom -subclass; we only emit the error if the LHS type is exactly `int` or `float`, not if its a subclass. - -```py -a = 1 / 0 # error: "Cannot divide object of type `Literal[1]` by zero" -reveal_type(a) # revealed: float - -b = 2 // 0 # error: "Cannot floor divide object of type `Literal[2]` by zero" -reveal_type(b) # revealed: int - -c = 3 % 0 # error: "Cannot reduce object of type `Literal[3]` modulo zero" -reveal_type(c) # revealed: int - -# error: "Cannot divide object of type `int` by zero" -# revealed: float -reveal_type(int() / 0) - -# error: "Cannot divide object of type `Literal[1]` by zero" -# revealed: float -reveal_type(1 / False) -# error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" -True / False -# error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" -bool(1) / False - -# error: "Cannot divide object of type `float` by zero" -# revealed: float -reveal_type(1.0 / 0) - -class MyInt(int): ... - -# No error for a subclass of int -# revealed: float -reveal_type(MyInt(3) / 0) -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/boolean/short_circuit.md b/crates/red_knot_python_semantic/resources/mdtest/boolean/short_circuit.md deleted file mode 100644 index ed6fa58fbca5b..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/boolean/short_circuit.md +++ /dev/null @@ -1,78 +0,0 @@ -# Short-Circuit Evaluation - -## Not all boolean expressions must be evaluated - -In `or` expressions, if the left-hand side is truthy, the right-hand side is not evaluated. -Similarly, in `and` expressions, if the left-hand side is falsy, the right-hand side is not -evaluated. - -```py -def bool_instance() -> bool: - return True - -if bool_instance() or (x := 1): - # error: [possibly-unresolved-reference] - reveal_type(x) # revealed: Unbound | Literal[1] - -if bool_instance() and (x := 1): - # error: [possibly-unresolved-reference] - reveal_type(x) # revealed: Unbound | Literal[1] -``` - -## First expression is always evaluated - -```py -def bool_instance() -> bool: - return True - -if (x := 1) or bool_instance(): - reveal_type(x) # revealed: Literal[1] - -if (x := 1) and bool_instance(): - reveal_type(x) # revealed: Literal[1] -``` - -## Statically known truthiness - -```py -if True or (x := 1): - # TODO: infer that the second arm is never executed so type should be just "Unbound". - # error: [possibly-unresolved-reference] - reveal_type(x) # revealed: Unbound | Literal[1] - -if True and (x := 1): - # TODO: infer that the second arm is always executed so type should be just "Literal[1]". - # error: [possibly-unresolved-reference] - reveal_type(x) # revealed: Unbound | Literal[1] -``` - -## Later expressions can always use variables from earlier expressions - -```py -def bool_instance() -> bool: - return True - -bool_instance() or (x := 1) or reveal_type(x) # revealed: Literal[1] - -# error: [unresolved-reference] -bool_instance() or reveal_type(y) or (y := 1) # revealed: Unbound -``` - -## Nested expressions - -```py -def bool_instance() -> bool: - return True - -if bool_instance() or ((x := 1) and bool_instance()): - # error: "Name `x` used when possibly not defined" - reveal_type(x) # revealed: Unbound | Literal[1] - -if ((y := 1) and bool_instance()) or bool_instance(): - reveal_type(y) # revealed: Literal[1] - -# error: [possibly-unresolved-reference] -if (bool_instance() and (z := 1)) or reveal_type(z): # revealed: Unbound | Literal[1] - # error: [possibly-unresolved-reference] - reveal_type(z) # revealed: Unbound | Literal[1] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/call/callable_instance.md b/crates/red_knot_python_semantic/resources/mdtest/call/callable_instance.md deleted file mode 100644 index 1719601372ae3..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/call/callable_instance.md +++ /dev/null @@ -1,20 +0,0 @@ -# Callable instance - -## Dunder call - -```py -class Multiplier: - def __init__(self, factor: float): - self.factor = factor - - def __call__(self, number: float) -> float: - return number * self.factor - -a = Multiplier(2.0)(3.0) -reveal_type(a) # revealed: float - -class Unit: ... - -b = Unit()(3.0) # error: "Object of type `Unit` is not callable" -reveal_type(b) # revealed: Unknown -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/call/constructor.md b/crates/red_knot_python_semantic/resources/mdtest/call/constructor.md deleted file mode 100644 index b9927fe086ee9..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/call/constructor.md +++ /dev/null @@ -1,7 +0,0 @@ -# Constructor - -```py -class Foo: ... - -reveal_type(Foo()) # revealed: Foo -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/call/function.md b/crates/red_knot_python_semantic/resources/mdtest/call/function.md deleted file mode 100644 index a87285a9ed429..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/call/function.md +++ /dev/null @@ -1,46 +0,0 @@ -# Call expression - -## Simple - -```py -def get_int() -> int: - return 42 - -reveal_type(get_int()) # revealed: int -``` - -## Async - -```py -async def get_int_async() -> int: - return 42 - -# TODO: we don't yet support `types.CoroutineType`, should be generic `Coroutine[Any, Any, int]` -reveal_type(get_int_async()) # revealed: @Todo -``` - -## Decorated - -```py -from typing import Callable - -def foo() -> int: - return 42 - -def decorator(func) -> Callable[[], int]: - return foo - -@decorator -def bar() -> str: - return "bar" - -# TODO: should reveal `int`, as the decorator replaces `bar` with `foo` -reveal_type(bar()) # revealed: @Todo -``` - -## Invalid callable - -```py -nonsense = 123 -x = nonsense() # error: "Object of type `Literal[123]` is not callable" -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/call/union.md b/crates/red_knot_python_semantic/resources/mdtest/call/union.md deleted file mode 100644 index 911f21947ef3c..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/call/union.md +++ /dev/null @@ -1,104 +0,0 @@ -# Unions in calls - -## Union of return types - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - - def f() -> int: - return 1 - -else: - - def f() -> str: - return "foo" - -reveal_type(f()) # revealed: int | str -``` - -## Calling with an unknown union - -```py -from nonexistent import f # error: [unresolved-import] "Cannot resolve import `nonexistent`" - -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - - def f() -> int: - return 1 - -reveal_type(f()) # revealed: Unknown | int -``` - -## Non-callable elements in a union - -Calling a union with a non-callable element should emit a diagnostic. - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - f = 1 -else: - - def f() -> int: - return 1 - -x = f() # error: "Object of type `Literal[1] | Literal[f]` is not callable (due to union element `Literal[1]`)" -reveal_type(x) # revealed: Unknown | int -``` - -## Multiple non-callable elements in a union - -Calling a union with multiple non-callable elements should mention all of them in the diagnostic. - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() - -if flag: - f = 1 -elif flag2: - f = "foo" -else: - - def f() -> int: - return 1 - -# error: "Object of type `Literal[1] | Literal["foo"] | Literal[f]` is not callable (due to union elements Literal[1], Literal["foo"])" -# revealed: Unknown | int -reveal_type(f()) -``` - -## All non-callable union elements - -Calling a union with no callable elements can emit a simpler diagnostic. - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - f = 1 -else: - f = "foo" - -x = f() # error: "Object of type `Literal[1] | Literal["foo"]` is not callable" -reveal_type(x) # revealed: Unknown -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/membership_test.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/membership_test.md deleted file mode 100644 index 21595db3f5626..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/membership_test.md +++ /dev/null @@ -1,165 +0,0 @@ -# Comparison: Membership Test - -In Python, the term "membership test operators" refers to the operators -`in` and `not in`. To customize their behavior, classes can implement one of -the special methods `__contains__`, `__iter__`, or `__getitem__`. - -For references, see: - -- -- -- - -## Implements `__contains__` - -Classes can support membership tests by implementing the `__contains__` method: - -```py -class A: - def __contains__(self, item: str) -> bool: - return True - -reveal_type("hello" in A()) # revealed: bool -reveal_type("hello" not in A()) # revealed: bool -# TODO: should emit diagnostic, need to check arg type, will fail -reveal_type(42 in A()) # revealed: bool -reveal_type(42 not in A()) # revealed: bool -``` - -## Implements `__iter__` - -Classes that don't implement `__contains__`, but do implement `__iter__`, also -support containment checks; the needle will be sought in their iterated items: - -```py -class StringIterator: - def __next__(self) -> str: - return "foo" - -class A: - def __iter__(self) -> StringIterator: - return StringIterator() - -reveal_type("hello" in A()) # revealed: bool -reveal_type("hello" not in A()) # revealed: bool -reveal_type(42 in A()) # revealed: bool -reveal_type(42 not in A()) # revealed: bool -``` - -## Implements `__getitems__` - -The final fallback is to implement `__getitem__` for integer keys. Python will -call `__getitem__` with `0`, `1`, `2`... until either the needle is found -(leading the membership test to evaluate to `True`) or `__getitem__` raises -`IndexError` (the raised exception is swallowed, but results in the membership -test evaluating to `False`). - -```py -class A: - def __getitem__(self, key: int) -> str: - return "foo" - -reveal_type("hello" in A()) # revealed: bool -reveal_type("hello" not in A()) # revealed: bool -reveal_type(42 in A()) # revealed: bool -reveal_type(42 not in A()) # revealed: bool -``` - -## Wrong Return Type - -Python coerces the results of containment checks to `bool`, even if `__contains__` -returns a non-bool: - -```py -class A: - def __contains__(self, item: str) -> str: - return "foo" - -reveal_type("hello" in A()) # revealed: bool -reveal_type("hello" not in A()) # revealed: bool -``` - -## Literal Result for `in` and `not in` - -`__contains__` with a literal return type may result in a `BooleanLiteral` -outcome. - -```py -from typing import Literal - -class AlwaysTrue: - def __contains__(self, item: int) -> Literal[1]: - return 1 - -class AlwaysFalse: - def __contains__(self, item: int) -> Literal[""]: - return "" - -# TODO: it should be Literal[True] and Literal[False] -reveal_type(42 in AlwaysTrue()) # revealed: @Todo -reveal_type(42 not in AlwaysTrue()) # revealed: @Todo - -# TODO: it should be Literal[False] and Literal[True] -reveal_type(42 in AlwaysFalse()) # revealed: @Todo -reveal_type(42 not in AlwaysFalse()) # revealed: @Todo -``` - -## No Fallback for `__contains__` - -If `__contains__` is implemented, checking membership of a type it doesn't -accept is an error; it doesn't result in a fallback to `__iter__` or -`__getitem__`: - -```py -class CheckContains: ... -class CheckIter: ... -class CheckGetItem: ... - -class CheckIterIterator: - def __next__(self) -> CheckIter: - return CheckIter() - -class A: - def __contains__(self, item: CheckContains) -> bool: - return True - - def __iter__(self) -> CheckIterIterator: - return CheckIterIterator() - - def __getitem__(self, key: int) -> CheckGetItem: - return CheckGetItem() - -reveal_type(CheckContains() in A()) # revealed: bool - -# TODO: should emit diagnostic, need to check arg type, -# should not fall back to __iter__ or __getitem__ -reveal_type(CheckIter() in A()) # revealed: bool -reveal_type(CheckGetItem() in A()) # revealed: bool - -class B: - def __iter__(self) -> CheckIterIterator: - return CheckIterIterator() - - def __getitem__(self, key: int) -> CheckGetItem: - return CheckGetItem() - -reveal_type(CheckIter() in B()) # revealed: bool -# Always use `__iter__`, regardless of iterated type; there's no NotImplemented -# in this case, so there's no fallback to `__getitem__` -reveal_type(CheckGetItem() in B()) # revealed: bool -``` - -## Invalid Old-Style Iteration - -If `__getitem__` is implemented but does not accept integer arguments, then -the membership test is not supported and should trigger a diagnostic. - -```py -class A: - def __getitem__(self, key: str) -> str: - return "foo" - -# TODO should emit a diagnostic -reveal_type(42 in A()) # revealed: bool -reveal_type("hello" in A()) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md deleted file mode 100644 index 5e21beade127a..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md +++ /dev/null @@ -1,336 +0,0 @@ -# Comparison: Rich Comparison - -Rich comparison operations (`==`, `!=`, `<`, `<=`, `>`, `>=`) in Python are -implemented through double-underscore methods that allow customization of -comparison behavior. - -For references, see: - -- -- - -## Rich Comparison Dunder Implementations For Same Class - -Classes can support rich comparison by implementing dunder methods like -`__eq__`, `__ne__`, etc. The most common case involves implementing these -methods for the same type: - -```py -from __future__ import annotations - -class A: - def __eq__(self, other: A) -> int: - return 42 - - def __ne__(self, other: A) -> float: - return 42.0 - - def __lt__(self, other: A) -> str: - return "42" - - def __le__(self, other: A) -> bytes: - return b"42" - - def __gt__(self, other: A) -> list: - return [42] - - def __ge__(self, other: A) -> set: - return {42} - -reveal_type(A() == A()) # revealed: int -reveal_type(A() != A()) # revealed: float -reveal_type(A() < A()) # revealed: str -reveal_type(A() <= A()) # revealed: bytes -reveal_type(A() > A()) # revealed: list -reveal_type(A() >= A()) # revealed: set -``` - -## Rich Comparison Dunder Implementations for Other Class - -In some cases, classes may implement rich comparison dunder methods for -comparisons with a different type: - -```py -from __future__ import annotations - -class A: - def __eq__(self, other: B) -> int: - return 42 - - def __ne__(self, other: B) -> float: - return 42.0 - - def __lt__(self, other: B) -> str: - return "42" - - def __le__(self, other: B) -> bytes: - return b"42" - - def __gt__(self, other: B) -> list: - return [42] - - def __ge__(self, other: B) -> set: - return {42} - -class B: ... - -reveal_type(A() == B()) # revealed: int -reveal_type(A() != B()) # revealed: float -reveal_type(A() < B()) # revealed: str -reveal_type(A() <= B()) # revealed: bytes -reveal_type(A() > B()) # revealed: list -reveal_type(A() >= B()) # revealed: set -``` - -## Reflected Comparisons - -Fallback to the right-hand side’s comparison methods occurs when the left-hand -side does not define them. Note: class `B` has its own `__eq__` and `__ne__` -methods to override those of `object`, but these methods will be ignored here -because they require a mismatched operand type. - -```py -from __future__ import annotations - -class A: - def __eq__(self, other: B) -> int: - return 42 - - def __ne__(self, other: B) -> float: - return 42.0 - - def __lt__(self, other: B) -> str: - return "42" - - def __le__(self, other: B) -> bytes: - return b"42" - - def __gt__(self, other: B) -> list: - return [42] - - def __ge__(self, other: B) -> set: - return {42} - -class B: - # To override builtins.object.__eq__ and builtins.object.__ne__ - # TODO these should emit an invalid override diagnostic - def __eq__(self, other: str) -> B: - return B() - - def __ne__(self, other: str) -> B: - return B() - -# TODO: should be `int` and `float`. -# Need to check arg type and fall back to `rhs.__eq__` and `rhs.__ne__`. -# -# Because `object.__eq__` and `object.__ne__` accept `object` in typeshed, -# this can only happen with an invalid override of these methods, -# but we still support it. -reveal_type(B() == A()) # revealed: B -reveal_type(B() != A()) # revealed: B - -reveal_type(B() < A()) # revealed: list -reveal_type(B() <= A()) # revealed: set - -reveal_type(B() > A()) # revealed: str -reveal_type(B() >= A()) # revealed: bytes - -class C: - def __gt__(self, other: C) -> int: - return 42 - - def __ge__(self, other: C) -> float: - return 42.0 - -reveal_type(C() < C()) # revealed: int -reveal_type(C() <= C()) # revealed: float -``` - -## Reflected Comparisons with Subclasses - -When subclasses override comparison methods, these overridden methods take -precedence over those in the parent class. Class `B` inherits from `A` and -redefines comparison methods to return types other than `A`. - -```py -from __future__ import annotations - -class A: - def __eq__(self, other: A) -> A: - return A() - - def __ne__(self, other: A) -> A: - return A() - - def __lt__(self, other: A) -> A: - return A() - - def __le__(self, other: A) -> A: - return A() - - def __gt__(self, other: A) -> A: - return A() - - def __ge__(self, other: A) -> A: - return A() - -class B(A): - def __eq__(self, other: A) -> int: - return 42 - - def __ne__(self, other: A) -> float: - return 42.0 - - def __lt__(self, other: A) -> str: - return "42" - - def __le__(self, other: A) -> bytes: - return b"42" - - def __gt__(self, other: A) -> list: - return [42] - - def __ge__(self, other: A) -> set: - return {42} - -reveal_type(A() == B()) # revealed: int -reveal_type(A() != B()) # revealed: float - -reveal_type(A() < B()) # revealed: list -reveal_type(A() <= B()) # revealed: set - -reveal_type(A() > B()) # revealed: str -reveal_type(A() >= B()) # revealed: bytes -``` - -## Reflected Comparisons with Subclass But Falls Back to LHS - -In the case of a subclass, the right-hand side has priority. However, if the -overridden dunder method has an mismatched type to operand, the comparison will -fall back to the left-hand side. - -```py -from __future__ import annotations - -class A: - def __lt__(self, other: A) -> A: - return A() - - def __gt__(self, other: A) -> A: - return A() - -class B(A): - def __lt__(self, other: int) -> B: - return B() - - def __gt__(self, other: int) -> B: - return B() - -# TODO: should be `A`, need to check argument type and fall back to LHS method -reveal_type(A() < B()) # revealed: B -reveal_type(A() > B()) # revealed: B -``` - -## Operations involving instances of classes inheriting from `Any` - -`Any` and `Unknown` represent a set of possible runtime objects, wherein the -bounds of the set are unknown. Whether the left-hand operand's dunder or the -right-hand operand's reflected dunder depends on whether the right-hand operand -is an instance of a class that is a subclass of the left-hand operand's class -and overrides the reflected dunder. In the following example, because of the -unknowable nature of `Any`/`Unknown`, we must consider both possibilities: -`Any`/`Unknown` might resolve to an unknown third class that inherits from `X` -and overrides `__gt__`; but it also might not. Thus, the correct answer here for -the `reveal_type` is `int | Unknown`. - -(This test is referenced from `mdtest/binary/instances.md`) - -```py -from does_not_exist import Foo # error: [unresolved-import] - -reveal_type(Foo) # revealed: Unknown - -class X: - def __lt__(self, other: object) -> int: - return 42 - -class Y(Foo): ... - -# TODO: Should be `int | Unknown`; see above discussion. -reveal_type(X() < Y()) # revealed: int -``` - -## Equality and Inequality Fallback - -This test confirms that `==` and `!=` comparisons default to identity -comparisons (`is`, `is not`) when argument types do not match the method -signature. - -Please refer to the -[docs](https://docs.python.org/3/reference/datamodel.html#object.__eq__) - -```py -from __future__ import annotations - -class A: - # TODO both these overrides should emit invalid-override diagnostic - def __eq__(self, other: int) -> A: - return A() - - def __ne__(self, other: int) -> A: - return A() - -# TODO: it should be `bool`, need to check arg type and fall back to `is` and `is not` -reveal_type(A() == A()) # revealed: A -reveal_type(A() != A()) # revealed: A -``` - -## Object Comparisons with Typeshed - -```py -class A: ... - -reveal_type(A() == object()) # revealed: bool -reveal_type(A() != object()) # revealed: bool -reveal_type(object() == A()) # revealed: bool -reveal_type(object() != A()) # revealed: bool - -# error: [unsupported-operator] "Operator `<` is not supported for types `A` and `object`" -# revealed: Unknown -reveal_type(A() < object()) -``` - -## Numbers Comparison with typeshed - -```py -reveal_type(1 == 1.0) # revealed: bool -reveal_type(1 != 1.0) # revealed: bool -reveal_type(1 < 1.0) # revealed: bool -reveal_type(1 <= 1.0) # revealed: bool -reveal_type(1 > 1.0) # revealed: bool -reveal_type(1 >= 1.0) # revealed: bool - -reveal_type(1 == 2j) # revealed: bool -reveal_type(1 != 2j) # revealed: bool - -# TODO: should be Unknown and emit diagnostic, -# need to check arg type and should be failed -reveal_type(1 < 2j) # revealed: bool -reveal_type(1 <= 2j) # revealed: bool -reveal_type(1 > 2j) # revealed: bool -reveal_type(1 >= 2j) # revealed: bool - -def bool_instance() -> bool: - return True - -def int_instance() -> int: - return 42 - -x = bool_instance() -y = int_instance() - -reveal_type(x < y) # revealed: bool -reveal_type(y < x) # revealed: bool -reveal_type(4.2 < x) # revealed: bool -reveal_type(x < 4.2) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/integers.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/integers.md deleted file mode 100644 index a2092af10983b..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/integers.md +++ /dev/null @@ -1,29 +0,0 @@ -# Comparison: Integers - -## Integer literals - -```py -reveal_type(1 == 1 == True) # revealed: Literal[True] -reveal_type(1 == 1 == 2 == 4) # revealed: Literal[False] -reveal_type(False < True <= 2 < 3 != 6) # revealed: Literal[True] -reveal_type(1 < 1) # revealed: Literal[False] -reveal_type(1 > 1) # revealed: Literal[False] -reveal_type(1 is 1) # revealed: bool -reveal_type(1 is not 1) # revealed: bool -reveal_type(1 is 2) # revealed: Literal[False] -reveal_type(1 is not 7) # revealed: Literal[True] -# TODO: should be Unknown, and emit diagnostic, once we check call argument types -reveal_type(1 <= "" and 0 < 1) # revealed: bool -``` - -## Integer instance - -```py -# TODO: implement lookup of `__eq__` on typeshed `int` stub. -def int_instance() -> int: - return 42 - -reveal_type(1 == int_instance()) # revealed: bool -reveal_type(9 < int_instance()) # revealed: bool -reveal_type(int_instance() < int_instance()) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/non_boolean_returns.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/non_boolean_returns.md deleted file mode 100644 index e7178fa3efa8d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/non_boolean_returns.md +++ /dev/null @@ -1,41 +0,0 @@ -# Comparison: Non boolean returns - -Walking through examples: - -- `a = A() < B() < C()` - - 1. `A() < B() and B() < C()` - split in N comparison - 1. `A()` and `B()` - evaluate outcome types - 1. `bool` and `bool` - evaluate truthiness - 1. `A | B` - union of "first true" types - -- `b = 0 < 1 < A() < 3` - - 1. `0 < 1 and 1 < A() and A() < 3` - split in N comparison - 1. `True` and `bool` and `A` - evaluate outcome types - 1. `True` and `bool` and `bool` - evaluate truthiness - 1. `bool | A` - union of "true" types - -- `c = 10 < 0 < A() < B() < C()` short-circuit to False - -```py -from __future__ import annotations - -class A: - def __lt__(self, other) -> A: ... - -class B: - def __lt__(self, other) -> B: ... - -class C: - def __lt__(self, other) -> C: ... - -x = A() < B() < C() -reveal_type(x) # revealed: A | B - -y = 0 < 1 < A() < 3 -reveal_type(y) # revealed: bool | A - -z = 10 < 0 < A() < B() < C() -reveal_type(z) # revealed: Literal[False] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/strings.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/strings.md deleted file mode 100644 index 04cfc6771ed21..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/strings.md +++ /dev/null @@ -1,20 +0,0 @@ -# Comparison: Strings - -## String literals - -```py -def str_instance() -> str: ... - -reveal_type("abc" == "abc") # revealed: Literal[True] -reveal_type("ab_cd" <= "ab_ce") # revealed: Literal[True] -reveal_type("abc" in "ab cd") # revealed: Literal[False] -reveal_type("" not in "hello") # revealed: Literal[False] -reveal_type("--" is "--") # revealed: bool -reveal_type("A" is "B") # revealed: Literal[False] -reveal_type("--" is not "--") # revealed: bool -reveal_type("A" is not "B") # revealed: Literal[True] -reveal_type(str_instance() < "...") # revealed: bool - -# ensure we're not comparing the interned salsa symbols, which compare by order of declaration. -reveal_type("ab" < "ab_cd") # revealed: Literal[True] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/tuples.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/tuples.md deleted file mode 100644 index 7d3d789e07ed9..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/tuples.md +++ /dev/null @@ -1,204 +0,0 @@ -# Comparison: Tuples - -## Heterogeneous - -For tuples like `tuple[int, str, Literal[1]]` - -### Value Comparisons - -"Value Comparisons" refers to the operators: `==`, `!=`, `<`, `<=`, `>`, `>=` - -#### Results without Ambiguity - -Cases where the result can be definitively inferred as a `BooleanLiteral`. - -```py -a = (1, "test", (3, 13), True) -b = (1, "test", (3, 14), False) - -reveal_type(a == a) # revealed: Literal[True] -reveal_type(a != a) # revealed: Literal[False] -reveal_type(a < a) # revealed: Literal[False] -reveal_type(a <= a) # revealed: Literal[True] -reveal_type(a > a) # revealed: Literal[False] -reveal_type(a >= a) # revealed: Literal[True] - -reveal_type(a == b) # revealed: Literal[False] -reveal_type(a != b) # revealed: Literal[True] -reveal_type(a < b) # revealed: Literal[True] -reveal_type(a <= b) # revealed: Literal[True] -reveal_type(a > b) # revealed: Literal[False] -reveal_type(a >= b) # revealed: Literal[False] -``` - -Even when tuples have different lengths, comparisons should be handled appropriately. - -```py path=different_length.py -a = (1, 2, 3) -b = (1, 2, 3, 4) - -reveal_type(a == b) # revealed: Literal[False] -reveal_type(a != b) # revealed: Literal[True] -reveal_type(a < b) # revealed: Literal[True] -reveal_type(a <= b) # revealed: Literal[True] -reveal_type(a > b) # revealed: Literal[False] -reveal_type(a >= b) # revealed: Literal[False] - -c = ("a", "b", "c", "d") -d = ("a", "b", "c") - -reveal_type(c == d) # revealed: Literal[False] -reveal_type(c != d) # revealed: Literal[True] -reveal_type(c < d) # revealed: Literal[False] -reveal_type(c <= d) # revealed: Literal[False] -reveal_type(c > d) # revealed: Literal[True] -reveal_type(c >= d) # revealed: Literal[True] -``` - -#### Results with Ambiguity - -```py -def bool_instance() -> bool: ... -def int_instance() -> int: - return 42 - -a = (bool_instance(),) -b = (int_instance(),) - -reveal_type(a == a) # revealed: bool -reveal_type(a != a) # revealed: bool -reveal_type(a < a) # revealed: bool -reveal_type(a <= a) # revealed: bool -reveal_type(a > a) # revealed: bool -reveal_type(a >= a) # revealed: bool - -reveal_type(a == b) # revealed: bool -reveal_type(a != b) # revealed: bool -reveal_type(a < b) # revealed: bool -reveal_type(a <= b) # revealed: bool -reveal_type(a > b) # revealed: bool -reveal_type(a >= b) # revealed: bool -``` - -#### Comparison Unsupported - -If two tuples contain types that do not support comparison, the result may be `Unknown`. -However, `==` and `!=` are exceptions and can still provide definite results. - -```py -a = (1, 2) -b = (1, "hello") - -# TODO: should be Literal[False], once we implement (in)equality for mismatched literals -reveal_type(a == b) # revealed: bool - -# TODO: should be Literal[True], once we implement (in)equality for mismatched literals -reveal_type(a != b) # revealed: bool - -# TODO: should be Unknown and add more informative diagnostics -reveal_type(a < b) # revealed: bool -reveal_type(a <= b) # revealed: bool -reveal_type(a > b) # revealed: bool -reveal_type(a >= b) # revealed: bool -``` - -However, if the lexicographic comparison completes without reaching a point where str and int are compared, -Python will still produce a result based on the prior elements. - -```py path=short_circuit.py -a = (1, 2) -b = (999999, "hello") - -reveal_type(a == b) # revealed: Literal[False] -reveal_type(a != b) # revealed: Literal[True] -reveal_type(a < b) # revealed: Literal[True] -reveal_type(a <= b) # revealed: Literal[True] -reveal_type(a > b) # revealed: Literal[False] -reveal_type(a >= b) # revealed: Literal[False] -``` - -#### Matryoshka Tuples - -```py -a = (1, True, "Hello") -b = (a, a, a) -c = (b, b, b) - -reveal_type(c == c) # revealed: Literal[True] -reveal_type(c != c) # revealed: Literal[False] -reveal_type(c < c) # revealed: Literal[False] -reveal_type(c <= c) # revealed: Literal[True] -reveal_type(c > c) # revealed: Literal[False] -reveal_type(c >= c) # revealed: Literal[True] -``` - -#### Non Boolean Rich Comparisons - -```py -class A: - def __eq__(self, o) -> str: ... - def __ne__(self, o) -> int: ... - def __lt__(self, o) -> float: ... - def __le__(self, o) -> object: ... - def __gt__(self, o) -> tuple: ... - def __ge__(self, o) -> list: ... - -a = (A(), A()) - -reveal_type(a == a) # revealed: bool -reveal_type(a != a) # revealed: bool -reveal_type(a < a) # revealed: bool -reveal_type(a <= a) # revealed: bool -reveal_type(a > a) # revealed: bool -reveal_type(a >= a) # revealed: bool -``` - -### Membership Test Comparisons - -"Membership Test Comparisons" refers to the operators `in` and `not in`. - -```py -def int_instance() -> int: - return 42 - -a = (1, 2) -b = ((3, 4), (1, 2)) -c = ((1, 2, 3), (4, 5, 6)) -d = ((int_instance(), int_instance()), (int_instance(), int_instance())) - -reveal_type(a in b) # revealed: Literal[True] -reveal_type(a not in b) # revealed: Literal[False] - -reveal_type(a in c) # revealed: Literal[False] -reveal_type(a not in c) # revealed: Literal[True] - -reveal_type(a in d) # revealed: bool -reveal_type(a not in d) # revealed: bool -``` - -### Identity Comparisons - -"Identity Comparisons" refers to `is` and `is not`. - -```py -a = (1, 2) -b = ("a", "b") -c = (1, 2, 3) - -reveal_type(a is (1, 2)) # revealed: bool -reveal_type(a is not (1, 2)) # revealed: bool - -# TODO should be Literal[False] once we implement comparison of mismatched literal types -reveal_type(a is b) # revealed: bool -# TODO should be Literal[True] once we implement comparison of mismatched literal types -reveal_type(a is not b) # revealed: bool - -reveal_type(a is c) # revealed: Literal[False] -reveal_type(a is not c) # revealed: Literal[True] -``` - -## Homogeneous - -For tuples like `tuple[int, ...]`, `tuple[Any, ...]` - -// TODO diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/unions.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/unions.md deleted file mode 100644 index 2a07827738c50..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/unions.md +++ /dev/null @@ -1,88 +0,0 @@ -# Comparison: Unions - -## Union on one side of the comparison - -Comparisons on union types need to consider all possible cases: - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -one_or_two = 1 if flag else 2 - -reveal_type(one_or_two <= 2) # revealed: Literal[True] -reveal_type(one_or_two <= 1) # revealed: bool -reveal_type(one_or_two <= 0) # revealed: Literal[False] - -reveal_type(2 >= one_or_two) # revealed: Literal[True] -reveal_type(1 >= one_or_two) # revealed: bool -reveal_type(0 >= one_or_two) # revealed: Literal[False] - -reveal_type(one_or_two < 1) # revealed: Literal[False] -reveal_type(one_or_two < 2) # revealed: bool -reveal_type(one_or_two < 3) # revealed: Literal[True] - -reveal_type(one_or_two > 0) # revealed: Literal[True] -reveal_type(one_or_two > 1) # revealed: bool -reveal_type(one_or_two > 2) # revealed: Literal[False] - -reveal_type(one_or_two == 3) # revealed: Literal[False] -reveal_type(one_or_two == 1) # revealed: bool - -reveal_type(one_or_two != 3) # revealed: Literal[True] -reveal_type(one_or_two != 1) # revealed: bool - -a_or_ab = "a" if flag else "ab" - -reveal_type(a_or_ab in "ab") # revealed: Literal[True] -reveal_type("a" in a_or_ab) # revealed: Literal[True] - -reveal_type("c" not in a_or_ab) # revealed: Literal[True] -reveal_type("a" not in a_or_ab) # revealed: Literal[False] - -reveal_type("b" in a_or_ab) # revealed: bool -reveal_type("b" not in a_or_ab) # revealed: bool - -one_or_none = 1 if flag else None - -reveal_type(one_or_none is None) # revealed: bool -reveal_type(one_or_none is not None) # revealed: bool -``` - -## Union on both sides of the comparison - -With unions on both sides, we need to consider the full cross product of -options when building the resulting (union) type: - -```py -def bool_instance() -> bool: - return True - -flag_s, flag_l = bool_instance(), bool_instance() -small = 1 if flag_s else 2 -large = 2 if flag_l else 3 - -reveal_type(small <= large) # revealed: Literal[True] -reveal_type(small >= large) # revealed: bool - -reveal_type(small < large) # revealed: bool -reveal_type(small > large) # revealed: Literal[False] -``` - -## Unsupported operations - -Make sure we emit a diagnostic if *any* of the possible comparisons is -unsupported. For now, we fall back to `bool` for the result type instead of -trying to infer something more precise from the other (supported) variants: - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = [1, 2] if flag else 1 - -result = 1 in x # error: "Operator `in` is not supported" -reveal_type(result) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/unsupported.md b/crates/red_knot_python_semantic/resources/mdtest/comparison/unsupported.md deleted file mode 100644 index c1f23b1d48d8a..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/unsupported.md +++ /dev/null @@ -1,36 +0,0 @@ -# Comparison: Unsupported operators - -```py -def bool_instance() -> bool: - return True - -a = 1 in 7 # error: "Operator `in` is not supported for types `Literal[1]` and `Literal[7]`" -reveal_type(a) # revealed: bool - -b = 0 not in 10 # error: "Operator `not in` is not supported for types `Literal[0]` and `Literal[10]`" -reveal_type(b) # revealed: bool - -# TODO: should error, once operand type check is implemented -# ("Operator `<` is not supported for types `object` and `int`") -c = object() < 5 -# TODO: should be Unknown, once operand type check is implemented -reveal_type(c) # revealed: bool - -# TODO: should error, once operand type check is implemented -# ("Operator `<` is not supported for types `int` and `object`") -d = 5 < object() -# TODO: should be Unknown, once operand type check is implemented -reveal_type(d) # revealed: bool - -flag = bool_instance() -int_literal_or_str_literal = 1 if flag else "foo" -# error: "Operator `in` is not supported for types `Literal[42]` and `Literal[1]`, in comparing `Literal[42]` with `Literal[1] | Literal["foo"]`" -e = 42 in int_literal_or_str_literal -reveal_type(e) # revealed: bool - -# TODO: should error, need to check if __lt__ signature is valid for right operand -# error may be "Operator `<` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]` -f = (1, 2) < (1, "hello") -# TODO: should be Unknown, once operand type check is implemented -reveal_type(f) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/conditional/if_expression.md b/crates/red_knot_python_semantic/resources/mdtest/conditional/if_expression.md deleted file mode 100644 index f162a3a39d704..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/conditional/if_expression.md +++ /dev/null @@ -1,49 +0,0 @@ -# If expressions - -## Simple if-expression - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else 2 -reveal_type(x) # revealed: Literal[1, 2] -``` - -## If-expression with walrus operator - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -y = 0 -z = 0 -x = (y := 1) if flag else (z := 2) -reveal_type(x) # revealed: Literal[1, 2] -reveal_type(y) # revealed: Literal[0, 1] -reveal_type(z) # revealed: Literal[0, 2] -``` - -## Nested if-expression - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -x = 1 if flag else 2 if flag2 else 3 -reveal_type(x) # revealed: Literal[1, 2, 3] -``` - -## None - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else None -reveal_type(x) # revealed: Literal[1] | None -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/conditional/if_statement.md b/crates/red_knot_python_semantic/resources/mdtest/conditional/if_statement.md deleted file mode 100644 index a44a58b4cacc7..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/conditional/if_statement.md +++ /dev/null @@ -1,130 +0,0 @@ -# If statements - -## Simple if - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -y = 1 -y = 2 - -if flag: - y = 3 - -reveal_type(y) # revealed: Literal[2, 3] -``` - -## Simple if-elif-else - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -y = 1 -y = 2 -if flag: - y = 3 -elif flag2: - y = 4 -else: - r = y - y = 5 - s = y -x = y - -reveal_type(x) # revealed: Literal[3, 4, 5] - -# revealed: Unbound | Literal[2] -# error: [possibly-unresolved-reference] -reveal_type(r) - -# revealed: Unbound | Literal[5] -# error: [possibly-unresolved-reference] -reveal_type(s) -``` - -## Single symbol across if-elif-else - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() - -if flag: - y = 1 -elif flag2: - y = 2 -else: - y = 3 -reveal_type(y) # revealed: Literal[1, 2, 3] -``` - -## if-elif-else without else assignment - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -y = 0 -if flag: - y = 1 -elif flag2: - y = 2 -else: - pass -reveal_type(y) # revealed: Literal[0, 1, 2] -``` - -## if-elif-else with intervening assignment - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -y = 0 -if flag: - y = 1 - z = 3 -elif flag2: - y = 2 -else: - pass -reveal_type(y) # revealed: Literal[0, 1, 2] -``` - -## Nested if statement - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -y = 0 -if flag: - if flag2: - y = 1 -reveal_type(y) # revealed: Literal[0, 1] -``` - -## if-elif without else - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -y = 1 -y = 2 -if flag: - y = 3 -elif flag2: - y = 4 - -reveal_type(y) # revealed: Literal[2, 3, 4] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/conditional/match.md b/crates/red_knot_python_semantic/resources/mdtest/conditional/match.md deleted file mode 100644 index 5269bc8b89fcd..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/conditional/match.md +++ /dev/null @@ -1,41 +0,0 @@ -# Pattern matching - -## With wildcard - -```py -match 0: - case 1: - y = 2 - case _: - y = 3 - -reveal_type(y) # revealed: Literal[2, 3] -``` - -## Without wildcard - -```py -match 0: - case 1: - y = 2 - case 2: - y = 3 - -# revealed: Unbound | Literal[2, 3] -# error: [possibly-unresolved-reference] -reveal_type(y) -``` - -## Basic match - -```py -y = 1 -y = 2 -match 0: - case 1: - y = 3 - case 2: - y = 4 - -reveal_type(y) # revealed: Literal[2, 3, 4] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/declaration/error.md b/crates/red_knot_python_semantic/resources/mdtest/declaration/error.md deleted file mode 100644 index 19fbfa20a5459..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/declaration/error.md +++ /dev/null @@ -1,51 +0,0 @@ -# Errors while declaring - -## Violates previous assignment - -```py -x = 1 -x: str # error: [invalid-declaration] "Cannot declare type `str` for inferred type `Literal[1]`" -``` - -## Incompatible declarations - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - x: str -else: - x: int -x = 1 # error: [conflicting-declarations] "Conflicting declared types for `x`: str, int" -``` - -## Partial declarations - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - x: int -x = 1 # error: [conflicting-declarations] "Conflicting declared types for `x`: Unknown, int" -``` - -## Incompatible declarations with bad assignment - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - x: str -else: - x: int - -# error: [conflicting-declarations] -# error: [invalid-assignment] -x = b"foo" -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/exception/basic.md b/crates/red_knot_python_semantic/resources/mdtest/exception/basic.md deleted file mode 100644 index 6b67e6a22178e..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/exception/basic.md +++ /dev/null @@ -1,56 +0,0 @@ -# Exception Handling - -## Single Exception - -```py -import re - -try: - help() -except NameError as e: - reveal_type(e) # revealed: NameError -except re.error as f: - reveal_type(f) # revealed: error -``` - -## Unknown type in except handler does not cause spurious diagnostic - -```py -from nonexistent_module import foo # error: [unresolved-import] - -try: - help() -except foo as e: - reveal_type(foo) # revealed: Unknown - reveal_type(e) # revealed: Unknown -``` - -## Multiple Exceptions in a Tuple - -```py -EXCEPTIONS = (AttributeError, TypeError) - -try: - help() -except (RuntimeError, OSError) as e: - reveal_type(e) # revealed: RuntimeError | OSError -except EXCEPTIONS as f: - reveal_type(f) # revealed: AttributeError | TypeError -``` - -## Dynamic exception types - -```py -def foo(x: type[AttributeError], y: tuple[type[OSError], type[RuntimeError]], z: tuple[type[BaseException], ...]): - try: - help() - except x as e: - # TODO: should be `AttributeError` - reveal_type(e) # revealed: @Todo - except y as f: - # TODO: should be `OSError | RuntimeError` - reveal_type(f) # revealed: @Todo - except z as g: - # TODO: should be `BaseException` - reveal_type(g) # revealed: @Todo -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/exception/control_flow.md b/crates/red_knot_python_semantic/resources/mdtest/exception/control_flow.md deleted file mode 100644 index a4af8d4140e43..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/exception/control_flow.md +++ /dev/null @@ -1,641 +0,0 @@ -# Control flow for exception handlers - -These tests assert that we understand the possible "definition states" (which -symbols might or might not be defined) in the various branches of a -`try`/`except`/`else`/`finally` block. - -For a full writeup on the semantics of exception handlers, -see [this document][1]. - -The tests throughout this Markdown document use functions with names starting -with `could_raise_*` to mark definitions that might or might not succeed -(as the function could raise an exception). A type checker must assume that any -arbitrary function call could raise an exception in Python; this is just a -naming convention used in these tests for clarity, and to future-proof the -tests against possible future improvements whereby certain statements or -expressions could potentially be inferred as being incapable of causing an -exception to be raised. - -## A single bare `except` - -Consider the following `try`/`except` block, with a single bare `except:`. -There are different types for the variable `x` in the two branches of this -block, and we can't determine which branch might have been taken from the -perspective of code following this block. The inferred type after the block's -conclusion is therefore the union of the type at the end of the `try` suite -(`str`) and the type at the end of the `except` suite (`Literal[2]`). - -*Within* the `except` suite, we must infer a union of all possible "definition -states" we could have been in at any point during the `try` suite. This is -because control flow could have jumped to the `except` suite without any of the -`try`-suite definitions successfully completing, with only *some* of the -`try`-suite definitions successfully completing, or indeed with *all* of them -successfully completing. The type of `x` at the beginning of the `except` suite -in this example is therefore `Literal[1] | str`, taking into account that we -might have jumped to the `except` suite before the -`x = could_raise_returns_str()` redefinition, but we *also* could have jumped -to the `except` suite *after* that redefinition. - -```py path=union_type_inferred.py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except: - reveal_type(x) # revealed: Literal[1] | str - x = 2 - reveal_type(x) # revealed: Literal[2] - -reveal_type(x) # revealed: str | Literal[2] -``` - -If `x` has the same type at the end of both branches, however, the branches -unify and `x` is not inferred as having a union type following the -`try`/`except` block: - -```py path=branches_unify_to_non_union_type.py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - x = could_raise_returns_str() -except: - x = could_raise_returns_str() - -reveal_type(x) # revealed: str -``` - -## A non-bare `except` - -For simple `try`/`except` blocks, an `except TypeError:` handler has the same -control flow semantics as an `except:` handler. An `except TypeError:` handler -will not catch *all* exceptions: if this is the only handler, it opens up the -possibility that an exception might occur that would not be handled. However, -as described in [the document on exception-handling semantics][1], that would -lead to termination of the scope. It's therefore irrelevant to consider this -possibility when it comes to control-flow analysis. - -```py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = 2 - reveal_type(x) # revealed: Literal[2] - -reveal_type(x) # revealed: str | Literal[2] -``` - -## Multiple `except` branches - -If the scope reaches the final `reveal_type` call in this example, -either the `try`-block suite of statements was executed in its entirety, -or exactly one `except` suite was executed in its entirety. -The inferred type of `x` at this point is the union of the types at the end of -the three suites: - -- At the end of `try`, `type(x) == str` -- At the end of `except TypeError`, `x == 2` -- At the end of `except ValueError`, `x == 3` - -```py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = 2 - reveal_type(x) # revealed: Literal[2] -except ValueError: - reveal_type(x) # revealed: Literal[1] | str - x = 3 - reveal_type(x) # revealed: Literal[3] - -reveal_type(x) # revealed: str | Literal[2, 3] -``` - -## Exception handlers with `else` branches (but no `finally`) - -If we reach the `reveal_type` call at the end of this scope, -either the `try` and `else` suites were both executed in their entireties, -or the `except` suite was executed in its entirety. The type of `x` at this -point is the union of the type at the end of the `else` suite and the type at -the end of the `except` suite: - -- At the end of `else`, `x == 3` -- At the end of `except`, `x == 2` - -```py path=single_except.py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = 2 - reveal_type(x) # revealed: Literal[2] -else: - reveal_type(x) # revealed: str - x = 3 - reveal_type(x) # revealed: Literal[3] - -reveal_type(x) # revealed: Literal[2, 3] -``` - -For a block that has multiple `except` branches and an `else` branch, the same -principle applies. In order to reach the final `reveal_type` call, -either exactly one of the `except` suites must have been executed in its -entirety, or the `try` suite and the `else` suite must both have been executed -in their entireties: - -```py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = 2 - reveal_type(x) # revealed: Literal[2] -except ValueError: - reveal_type(x) # revealed: Literal[1] | str - x = 3 - reveal_type(x) # revealed: Literal[3] -else: - reveal_type(x) # revealed: str - x = 4 - reveal_type(x) # revealed: Literal[4] - -reveal_type(x) # revealed: Literal[2, 3, 4] -``` - -## Exception handlers with `finally` branches (but no `except` branches) - -A `finally` suite is *always* executed. As such, if we reach the `reveal_type` -call at the end of this example, we know that `x` *must* have been reassigned -to `2` during the `finally` suite. The type of `x` at the end of the example is -therefore `Literal[2]`: - -```py path=redef_in_finally.py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -finally: - x = 2 - reveal_type(x) # revealed: Literal[2] - -reveal_type(x) # revealed: Literal[2] -``` - -If `x` was *not* redefined in the `finally` suite, however, things are somewhat -more complicated. If we reach the final `reveal_type` call, -unlike the state when we're visiting the `finally` suite, -we know that the `try`-block suite ran to completion. -This means that there are fewer possible states at this point than there were -when we were inside the `finally` block. - -(Our current model does *not* correctly infer the types *inside* `finally` -suites, however; this is still a TODO item for us.) - -```py path=no_redef_in_finally.py -def could_raise_returns_str() -> str: - return "foo" - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -finally: - # TODO: should be Literal[1] | str - reveal_type(x) # revealed: str - -reveal_type(x) # revealed: str -``` - -## Combining an `except` branch with a `finally` branch - -As previously stated, we do not yet have accurate inference for types *inside* -`finally` suites. When we do, however, we will have to take account of the -following possibilities inside `finally` suites: - -- The `try` suite could have run to completion -- Or we could have jumped from halfway through the `try` suite to an `except` - suite, and the `except` suite ran to completion -- Or we could have jumped from halfway through the `try` suite straight to the - `finally` suite due to an unhandled exception -- Or we could have jumped from halfway through the `try` suite to an - `except` suite, only for an exception raised in the `except` suite to cause - us to jump to the `finally` suite before the `except` suite ran to completion - -```py path=redef_in_finally.py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool -finally: - # TODO: should be `Literal[1] | str | bytes | bool` - reveal_type(x) # revealed: str | bool - x = 2 - reveal_type(x) # revealed: Literal[2] - -reveal_type(x) # revealed: Literal[2] -``` - -Now for an example without a redefinition in the `finally` suite. -As before, there *should* be fewer possibilities after completion of the -`finally` suite than there were during the `finally` suite itself. -(In some control-flow possibilities, some exceptions were merely *suspended* -during the `finally` suite; these lead to the scope's termination following the -conclusion of the `finally` suite.) - -```py path=no_redef_in_finally.py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool -finally: - # TODO: should be `Literal[1] | str | bytes | bool` - reveal_type(x) # revealed: str | bool - -reveal_type(x) # revealed: str | bool -``` - -An example with multiple `except` branches and a `finally` branch: - -```py path=multiple_except_branches.py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -def could_raise_returns_memoryview() -> memoryview: - return memoryview(b"") - -def could_raise_returns_float() -> float: - return 3.14 - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool -except ValueError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_memoryview() - reveal_type(x) # revealed: memoryview - x = could_raise_returns_float() - reveal_type(x) # revealed: float -finally: - # TODO: should be `Literal[1] | str | bytes | bool | memoryview | float` - reveal_type(x) # revealed: str | bool | float - -reveal_type(x) # revealed: str | bool | float -``` - -## Combining `except`, `else` and `finally` branches - -If the exception handler has an `else` branch, we must also take into account -the possibility that control flow could have jumped to the `finally` suite from -partway through the `else` suite due to an exception raised *there*. - -```py path=single_except_branch.py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -def could_raise_returns_memoryview() -> memoryview: - return memoryview(b"") - -def could_raise_returns_float() -> float: - return 3.14 - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool -else: - reveal_type(x) # revealed: str - x = could_raise_returns_memoryview() - reveal_type(x) # revealed: memoryview - x = could_raise_returns_float() - reveal_type(x) # revealed: float -finally: - # TODO: should be `Literal[1] | str | bytes | bool | memoryview | float` - reveal_type(x) # revealed: bool | float - -reveal_type(x) # revealed: bool | float -``` - -The same again, this time with multiple `except` branches: - -```py path=multiple_except_branches.py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -def could_raise_returns_memoryview() -> memoryview: - return memoryview(b"") - -def could_raise_returns_float() -> float: - return 3.14 - -def could_raise_returns_range() -> range: - return range(42) - -def could_raise_returns_slice() -> slice: - return slice(None) - -x = 1 - -try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str -except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool -except ValueError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_memoryview() - reveal_type(x) # revealed: memoryview - x = could_raise_returns_float() - reveal_type(x) # revealed: float -else: - reveal_type(x) # revealed: str - x = could_raise_returns_range() - reveal_type(x) # revealed: range - x = could_raise_returns_slice() - reveal_type(x) # revealed: slice -finally: - # TODO: should be `Literal[1] | str | bytes | bool | memoryview | float | range | slice` - reveal_type(x) # revealed: bool | float | slice - -reveal_type(x) # revealed: bool | float | slice -``` - -## Nested `try`/`except` blocks - -It would take advanced analysis, which we are not yet capable of, to be able -to determine that an exception handler always suppresses all exceptions. This -is partly because it is possible for statements in `except`, `else` and -`finally` suites to raise exceptions as well as statements in `try` suites. -This means that if an exception handler is nested inside the `try` statement of -an enclosing exception handler, it should (at least for now) be treated the -same as any other node: as a suite containing statements that could possibly -raise exceptions, which would lead to control flow jumping out of that suite -prior to the suite running to completion. - -```py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_bool() -> bool: - return True - -def could_raise_returns_memoryview() -> memoryview: - return memoryview(b"") - -def could_raise_returns_float() -> float: - return 3.14 - -def could_raise_returns_range() -> range: - return range(42) - -def could_raise_returns_slice() -> slice: - return slice(None) - -def could_raise_returns_complex() -> complex: - return 3j - -def could_raise_returns_bytearray() -> bytearray: - return bytearray() - -class Foo: ... -class Bar: ... - -def could_raise_returns_Foo() -> Foo: - return Foo() - -def could_raise_returns_Bar() -> Bar: - return Bar() - -x = 1 - -try: - try: - reveal_type(x) # revealed: Literal[1] - x = could_raise_returns_str() - reveal_type(x) # revealed: str - except TypeError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - x = could_raise_returns_bool() - reveal_type(x) # revealed: bool - except ValueError: - reveal_type(x) # revealed: Literal[1] | str - x = could_raise_returns_memoryview() - reveal_type(x) # revealed: memoryview - x = could_raise_returns_float() - reveal_type(x) # revealed: float - else: - reveal_type(x) # revealed: str - x = could_raise_returns_range() - reveal_type(x) # revealed: range - x = could_raise_returns_slice() - reveal_type(x) # revealed: slice - finally: - # TODO: should be `Literal[1] | str | bytes | bool | memoryview | float | range | slice` - reveal_type(x) # revealed: bool | float | slice - x = 2 - reveal_type(x) # revealed: Literal[2] - reveal_type(x) # revealed: Literal[2] -except: - reveal_type(x) # revealed: Literal[1, 2] | str | bytes | bool | memoryview | float | range | slice - x = could_raise_returns_complex() - reveal_type(x) # revealed: complex - x = could_raise_returns_bytearray() - reveal_type(x) # revealed: bytearray -else: - reveal_type(x) # revealed: Literal[2] - x = could_raise_returns_Foo() - reveal_type(x) # revealed: Foo - x = could_raise_returns_Bar() - reveal_type(x) # revealed: Bar -finally: - # TODO: should be `Literal[1, 2] | str | bytes | bool | memoryview | float | range | slice | complex | bytearray | Foo | Bar` - reveal_type(x) # revealed: bytearray | Bar - -# Either one `except` branch or the `else` -# must have been taken and completed to get here: -reveal_type(x) # revealed: bytearray | Bar -``` - -## Nested scopes inside `try` blocks - -Shadowing a variable in an inner scope has no effect on type inference of the -variable by that name in the outer scope: - -```py -def could_raise_returns_str() -> str: - return "foo" - -def could_raise_returns_bytes() -> bytes: - return b"foo" - -def could_raise_returns_range() -> range: - return range(42) - -def could_raise_returns_bytearray() -> bytearray: - return bytearray() - -def could_raise_returns_float() -> float: - return 3.14 - -x = 1 - -try: - - def foo(param=could_raise_returns_str()): - x = could_raise_returns_str() - - try: - reveal_type(x) # revealed: str - x = could_raise_returns_bytes() - reveal_type(x) # revealed: bytes - except: - reveal_type(x) # revealed: str | bytes - x = could_raise_returns_bytearray() - reveal_type(x) # revealed: bytearray - x = could_raise_returns_float() - reveal_type(x) # revealed: float - finally: - # TODO: should be `str | bytes | bytearray | float` - reveal_type(x) # revealed: bytes | float - reveal_type(x) # revealed: bytes | float - x = foo - reveal_type(x) # revealed: Literal[foo] -except: - reveal_type(x) # revealed: Literal[1] | Literal[foo] - - class Bar: - x = could_raise_returns_range() - reveal_type(x) # revealed: range - - x = Bar - reveal_type(x) # revealed: Literal[Bar] -finally: - # TODO: should be `Literal[1] | Literal[foo] | Literal[Bar]` - reveal_type(x) # revealed: Literal[foo] | Literal[Bar] - -reveal_type(x) # revealed: Literal[foo] | Literal[Bar] -``` - -[1]: https://astral-sh.notion.site/Exception-handler-control-flow-11348797e1ca80bb8ce1e9aedbbe439d diff --git a/crates/red_knot_python_semantic/resources/mdtest/exception/except_star.md b/crates/red_knot_python_semantic/resources/mdtest/exception/except_star.md deleted file mode 100644 index b543544e56b35..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/exception/except_star.md +++ /dev/null @@ -1,30 +0,0 @@ -# Except star - -## Except\* with BaseException - -```py -try: - help() -except* BaseException as e: - reveal_type(e) # revealed: BaseExceptionGroup -``` - -## Except\* with specific exception - -```py -try: - help() -except* OSError as e: - # TODO(Alex): more precise would be `ExceptionGroup[OSError]` - reveal_type(e) # revealed: BaseExceptionGroup -``` - -## Except\* with multiple exceptions - -```py -try: - help() -except* (TypeError, AttributeError) as e: - # TODO(Alex): more precise would be `ExceptionGroup[TypeError | AttributeError]`. - reveal_type(e) # revealed: BaseExceptionGroup -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/expression/boolean.md b/crates/red_knot_python_semantic/resources/mdtest/expression/boolean.md deleted file mode 100644 index a84017ba709ee..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/expression/boolean.md +++ /dev/null @@ -1,110 +0,0 @@ -# Expressions - -## OR - -```py -def foo() -> str: - pass - -reveal_type(True or False) # revealed: Literal[True] -reveal_type("x" or "y" or "z") # revealed: Literal["x"] -reveal_type("" or "y" or "z") # revealed: Literal["y"] -reveal_type(False or "z") # revealed: Literal["z"] -reveal_type(False or True) # revealed: Literal[True] -reveal_type(False or False) # revealed: Literal[False] -reveal_type(foo() or False) # revealed: str | Literal[False] -reveal_type(foo() or True) # revealed: str | Literal[True] -``` - -## AND - -```py -def foo() -> str: - pass - -reveal_type(True and False) # revealed: Literal[False] -reveal_type(False and True) # revealed: Literal[False] -reveal_type(foo() and False) # revealed: str | Literal[False] -reveal_type(foo() and True) # revealed: str | Literal[True] -reveal_type("x" and "y" and "z") # revealed: Literal["z"] -reveal_type("x" and "y" and "") # revealed: Literal[""] -reveal_type("" and "y") # revealed: Literal[""] -``` - -## Simple function calls to bool - -```py -def returns_bool() -> bool: - return True - -if returns_bool(): - x = True -else: - x = False - -reveal_type(x) # revealed: bool -``` - -## Complex - -```py -def foo() -> str: - pass - -reveal_type("x" and "y" or "z") # revealed: Literal["y"] -reveal_type("x" or "y" and "z") # revealed: Literal["x"] -reveal_type("" and "y" or "z") # revealed: Literal["z"] -reveal_type("" or "y" and "z") # revealed: Literal["z"] -reveal_type("x" and "y" or "") # revealed: Literal["y"] -reveal_type("x" or "y" and "") # revealed: Literal["x"] -``` - -## `bool()` function - -## Evaluates to builtin - -```py path=a.py -redefined_builtin_bool = bool - -def my_bool(x) -> bool: - return True -``` - -```py -from a import redefined_builtin_bool, my_bool - -reveal_type(redefined_builtin_bool(0)) # revealed: Literal[False] -reveal_type(my_bool(0)) # revealed: bool -``` - -## Truthy values - -```py -reveal_type(bool(1)) # revealed: Literal[True] -reveal_type(bool((0,))) # revealed: Literal[True] -reveal_type(bool("NON EMPTY")) # revealed: Literal[True] -reveal_type(bool(True)) # revealed: Literal[True] - -def foo(): ... - -reveal_type(bool(foo)) # revealed: Literal[True] -``` - -## Falsy values - -```py -reveal_type(bool(0)) # revealed: Literal[False] -reveal_type(bool(())) # revealed: Literal[False] -reveal_type(bool(None)) # revealed: Literal[False] -reveal_type(bool("")) # revealed: Literal[False] -reveal_type(bool(False)) # revealed: Literal[False] -reveal_type(bool()) # revealed: Literal[False] -``` - -## Ambiguous values - -```py -reveal_type(bool([])) # revealed: bool -reveal_type(bool({})) # revealed: bool -reveal_type(bool(set())) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/generics.md b/crates/red_knot_python_semantic/resources/mdtest/generics.md deleted file mode 100644 index 03660b58b6117..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/generics.md +++ /dev/null @@ -1,66 +0,0 @@ -# PEP 695 Generics - -## Class Declarations - -Basic PEP 695 generics - -```py -class MyBox[T]: - # TODO: `T` is defined here - # error: [unresolved-reference] "Name `T` used when not defined" - data: T - box_model_number = 695 - - # TODO: `T` is defined here - # error: [unresolved-reference] "Name `T` used when not defined" - def __init__(self, data: T): - self.data = data - -# TODO not error (should be subscriptable) -box: MyBox[int] = MyBox(5) # error: [non-subscriptable] -# TODO error differently (str and int don't unify) -wrong_innards: MyBox[int] = MyBox("five") # error: [non-subscriptable] -# TODO reveal int -reveal_type(box.data) # revealed: @Todo - -reveal_type(MyBox.box_model_number) # revealed: Literal[695] -``` - -## Subclassing - -```py -class MyBox[T]: - # TODO: `T` is defined here - # error: [unresolved-reference] "Name `T` used when not defined" - data: T - - # TODO: `T` is defined here - # error: [unresolved-reference] "Name `T` used when not defined" - def __init__(self, data: T): - self.data = data - -# TODO not error on the subscripting or the use of type param -# error: [unresolved-reference] "Name `T` used when not defined" -# error: [non-subscriptable] -class MySecureBox[T](MyBox[T]): ... - -secure_box: MySecureBox[int] = MySecureBox(5) -reveal_type(secure_box) # revealed: MySecureBox -# TODO reveal int -reveal_type(secure_box.data) # revealed: @Todo -``` - -## Cyclical class definition - -In type stubs, classes can reference themselves in their base class definitions. For example, in `typeshed`, we have `class str(Sequence[str]): ...`. - -This should hold true even with generics at play. - -```py path=a.pyi -class Seq[T]: ... - -# TODO not error on the subscripting -class S[T](Seq[S]): ... # error: [non-subscriptable] - -reveal_type(S) # revealed: Literal[S] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/basic.md b/crates/red_knot_python_semantic/resources/mdtest/import/basic.md deleted file mode 100644 index fb802bb215ebd..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/import/basic.md +++ /dev/null @@ -1,27 +0,0 @@ -# Structures - -## Class import following - -```py -from b import C as D - -E = D -reveal_type(E) # revealed: Literal[C] -``` - -```py path=b.py -class C: ... -``` - -## Module member resolution - -```py -import b - -D = b.C -reveal_type(D) # revealed: Literal[C] -``` - -```py path=b.py -class C: ... -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/builtins.md b/crates/red_knot_python_semantic/resources/mdtest/import/builtins.md deleted file mode 100644 index b029221bce7a1..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/import/builtins.md +++ /dev/null @@ -1,8 +0,0 @@ -# Importing builtin module - -```py -import builtins - -x = builtins.copyright -reveal_type(x) # revealed: Literal[copyright] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/conditional.md b/crates/red_knot_python_semantic/resources/mdtest/import/conditional.md deleted file mode 100644 index 76756cb527b7d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/import/conditional.md +++ /dev/null @@ -1,110 +0,0 @@ -# Conditional imports - -## Maybe unbound - -```py path=maybe_unbound.py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - y = 3 - -x = y # error: [possibly-unresolved-reference] - -# revealed: Unbound | Literal[3] -# error: [possibly-unresolved-reference] -reveal_type(x) - -# revealed: Unbound | Literal[3] -# error: [possibly-unresolved-reference] -reveal_type(y) -``` - -```py -from maybe_unbound import x, y - -reveal_type(x) # revealed: Literal[3] -reveal_type(y) # revealed: Literal[3] -``` - -## Maybe unbound annotated - -```py path=maybe_unbound_annotated.py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - y: int = 3 -x = y # error: [possibly-unresolved-reference] - -# revealed: Unbound | Literal[3] -# error: [possibly-unresolved-reference] -reveal_type(x) - -# revealed: Unbound | Literal[3] -# error: [possibly-unresolved-reference] -reveal_type(y) -``` - -Importing an annotated name prefers the declared type over the inferred type: - -```py -from maybe_unbound_annotated import x, y - -reveal_type(x) # revealed: Literal[3] -reveal_type(y) # revealed: int -``` - -## Reimport - -```py path=c.py -def f(): ... -``` - -```py path=b.py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - from c import f -else: - - def f(): ... -``` - -```py -from b import f - -# TODO: We should disambiguate in such cases, showing `Literal[b.f, c.f]`. -reveal_type(f) # revealed: Literal[f, f] -``` - -## Reimport with stub declaration - -When we have a declared type in one path and only an inferred-from-definition type in the other, we -should still be able to unify those: - -```py path=c.pyi -x: int -``` - -```py path=b.py -def bool_instance() -> bool: - return True - -flag = bool_instance() -if flag: - from c import x -else: - x = 1 -``` - -```py -from b import x - -reveal_type(x) # revealed: int -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/errors.md b/crates/red_knot_python_semantic/resources/mdtest/import/errors.md deleted file mode 100644 index 1ed943cd13897..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/import/errors.md +++ /dev/null @@ -1,57 +0,0 @@ -# Unresolved Imports - -## Unresolved import statement - -```py -import bar # error: "Cannot resolve import `bar`" - -reveal_type(bar) # revealed: Unknown -``` - -## Unresolved import from statement - -```py -from bar import baz # error: "Cannot resolve import `bar`" - -reveal_type(baz) # revealed: Unknown -``` - -## Unresolved import from resolved module - -```py path=a.py -``` - -```py -from a import thing # error: "Module `a` has no member `thing`" - -reveal_type(thing) # revealed: Unknown -``` - -## Resolved import of symbol from unresolved import - -```py path=a.py -import foo as foo # error: "Cannot resolve import `foo`" - -reveal_type(foo) # revealed: Unknown -``` - -Importing the unresolved import into a second file should not trigger an additional "unresolved -import" violation: - -```py -from a import foo - -reveal_type(foo) # revealed: Unknown -``` - -## No implicit shadowing - -```py path=b.py -x: int -``` - -```py -from b import x - -x = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]" -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/relative.md b/crates/red_knot_python_semantic/resources/mdtest/import/relative.md deleted file mode 100644 index 4695374e94ed1..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/import/relative.md +++ /dev/null @@ -1,143 +0,0 @@ -# Relative - -## Non-existent - -```py path=package/__init__.py -``` - -```py path=package/bar.py -from .foo import X # error: [unresolved-import] - -reveal_type(X) # revealed: Unknown -``` - -## Simple - -```py path=package/__init__.py -``` - -```py path=package/foo.py -X = 42 -``` - -```py path=package/bar.py -from .foo import X - -reveal_type(X) # revealed: Literal[42] -``` - -## Dotted - -```py path=package/__init__.py -``` - -```py path=package/foo/bar/baz.py -X = 42 -``` - -```py path=package/bar.py -from .foo.bar.baz import X - -reveal_type(X) # revealed: Literal[42] -``` - -## Bare to package - -```py path=package/__init__.py -X = 42 -``` - -```py path=package/bar.py -from . import X - -reveal_type(X) # revealed: Literal[42] -``` - -## Non-existent + bare to package - -```py path=package/bar.py -from . import X # error: [unresolved-import] - -reveal_type(X) # revealed: Unknown -``` - -## Dunder init - -```py path=package/__init__.py -from .foo import X - -reveal_type(X) # revealed: Literal[42] -``` - -```py path=package/foo.py -X = 42 -``` - -## Non-existent + dunder init - -```py path=package/__init__.py -from .foo import X # error: [unresolved-import] - -reveal_type(X) # revealed: Unknown -``` - -## Long relative import - -```py path=package/__init__.py -``` - -```py path=package/foo.py -X = 42 -``` - -```py path=package/subpackage/subsubpackage/bar.py -from ...foo import X - -reveal_type(X) # revealed: Literal[42] -``` - -## Unbound symbol - -```py path=package/__init__.py -``` - -```py path=package/foo.py -x # error: [unresolved-reference] -``` - -```py path=package/bar.py -from .foo import x # error: [unresolved-import] - -reveal_type(x) # revealed: Unknown -``` - -## Bare to module - -```py path=package/__init__.py -``` - -```py path=package/foo.py -X = 42 -``` - -```py path=package/bar.py -# TODO: support submodule imports -from . import foo # error: [unresolved-import] - -y = foo.X - -# TODO: should be `Literal[42]` -reveal_type(y) # revealed: Unknown -``` - -## Non-existent + bare to module - -```py path=package/__init__.py -``` - -```py path=package/bar.py -# TODO: support submodule imports -from . import foo # error: [unresolved-import] - -reveal_type(foo) # revealed: Unknown -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/bytes.md b/crates/red_knot_python_semantic/resources/mdtest/literal/bytes.md deleted file mode 100644 index 0cf6222c534ee..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/literal/bytes.md +++ /dev/null @@ -1,10 +0,0 @@ -# Bytes literals - -## Simple - -```py -reveal_type(b"red" b"knot") # revealed: Literal[b"redknot"] -reveal_type(b"hello") # revealed: Literal[b"hello"] -reveal_type(b"world" + b"!") # revealed: Literal[b"world!"] -reveal_type(b"\xff\x00") # revealed: Literal[b"\xff\x00"] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/dictionary.md b/crates/red_knot_python_semantic/resources/mdtest/literal/collections/dictionary.md deleted file mode 100644 index 9a57135f2a343..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/dictionary.md +++ /dev/null @@ -1,7 +0,0 @@ -# Dictionaries - -## Empty dictionary - -```py -reveal_type({}) # revealed: dict -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/list.md b/crates/red_knot_python_semantic/resources/mdtest/literal/collections/list.md deleted file mode 100644 index 70c98aa3a60d9..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/list.md +++ /dev/null @@ -1,7 +0,0 @@ -# Lists - -## Empty list - -```py -reveal_type([]) # revealed: list -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/set.md b/crates/red_knot_python_semantic/resources/mdtest/literal/collections/set.md deleted file mode 100644 index 452fc719dbca7..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/set.md +++ /dev/null @@ -1,7 +0,0 @@ -# Sets - -## Basic set - -```py -reveal_type({1, 2}) # revealed: set -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/f_string.md b/crates/red_knot_python_semantic/resources/mdtest/literal/f_string.md deleted file mode 100644 index 5be1b2a271d24..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/literal/f_string.md +++ /dev/null @@ -1,33 +0,0 @@ -# f-strings - -## Expression - -```py -x = 0 -y = str() -z = False - -reveal_type(f"hello") # revealed: Literal["hello"] -reveal_type(f"h {x}") # revealed: Literal["h 0"] -reveal_type("one " f"single " f"literal") # revealed: Literal["one single literal"] -reveal_type("first " f"second({x})" f" third") # revealed: Literal["first second(0) third"] -reveal_type(f"-{y}-") # revealed: str -reveal_type(f"-{y}-" f"--" "--") # revealed: str -reveal_type(f"{z} == {False} is {True}") # revealed: Literal["False == False is True"] -``` - -## Conversion Flags - -```py -string = "hello" - -# TODO: should be `Literal["'hello'"]` -reveal_type(f"{string!r}") # revealed: str -``` - -## Format Specifiers - -```py -# TODO: should be `Literal["01"]` -reveal_type(f"{1:02}") # revealed: str -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/loops/async_for_loops.md b/crates/red_knot_python_semantic/resources/mdtest/loops/async_for_loops.md deleted file mode 100644 index a1a55f81d3ede..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/loops/async_for_loops.md +++ /dev/null @@ -1,45 +0,0 @@ -# Async - -Async `for` loops do not work according to the synchronous iteration protocol. - -## Invalid async for loop - -```py -async def foo(): - class Iterator: - def __next__(self) -> int: - return 42 - - class Iterable: - def __iter__(self) -> Iterator: - return Iterator() - - async for x in Iterator(): - pass - - # TODO: should reveal `Unbound | Unknown` because `__aiter__` is not defined - # revealed: Unbound | @Todo - # error: [possibly-unresolved-reference] - reveal_type(x) -``` - -## Basic async for loop - -```py -async def foo(): - class IntAsyncIterator: - async def __anext__(self) -> int: - return 42 - - class IntAsyncIterable: - def __aiter__(self) -> IntAsyncIterator: - return IntAsyncIterator() - - # TODO(Alex): async iterables/iterators! - async for x in IntAsyncIterable(): - pass - - # error: [possibly-unresolved-reference] - # revealed: Unbound | @Todo - reveal_type(x) -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/loops/for_loop.md b/crates/red_knot_python_semantic/resources/mdtest/loops/for_loop.md deleted file mode 100644 index 117108928f00f..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/loops/for_loop.md +++ /dev/null @@ -1,146 +0,0 @@ -# For loops - -## Basic `for` loop - -```py -class IntIterator: - def __next__(self) -> int: - return 42 - -class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - -for x in IntIterable(): - pass - -# revealed: Unbound | int -# error: [possibly-unresolved-reference] -reveal_type(x) -``` - -## With previous definition - -```py -class IntIterator: - def __next__(self) -> int: - return 42 - -class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - -x = "foo" - -for x in IntIterable(): - pass - -reveal_type(x) # revealed: Literal["foo"] | int -``` - -## With `else` (no break) - -```py -class IntIterator: - def __next__(self) -> int: - return 42 - -class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - -for x in IntIterable(): - pass -else: - x = "foo" - -reveal_type(x) # revealed: Literal["foo"] -``` - -## May `break` - -```py -class IntIterator: - def __next__(self) -> int: - return 42 - -class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - -for x in IntIterable(): - if x > 5: - break -else: - x = "foo" - -reveal_type(x) # revealed: int | Literal["foo"] -``` - -## With old-style iteration protocol - -```py -class OldStyleIterable: - def __getitem__(self, key: int) -> int: - return 42 - -for x in OldStyleIterable(): - pass - -# revealed: Unbound | int -# error: [possibly-unresolved-reference] -reveal_type(x) -``` - -## With heterogeneous tuple - -```py -for x in (1, "a", b"foo"): - pass - -# revealed: Unbound | Literal[1] | Literal["a"] | Literal[b"foo"] -# error: [possibly-unresolved-reference] -reveal_type(x) -``` - -## With non-callable iterator - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -class NotIterable: - if flag: - __iter__ = 1 - else: - __iter__ = None - -for x in NotIterable(): # error: "Object of type `NotIterable` is not iterable" - pass - -# revealed: Unbound | Unknown -# error: [possibly-unresolved-reference] -reveal_type(x) -``` - -## Invalid iterable - -```py -nonsense = 123 -for x in nonsense: # error: "Object of type `Literal[123]` is not iterable" - pass -``` - -## New over old style iteration protocol - -```py -class NotIterable: - def __getitem__(self, key: int) -> int: - return 42 - __iter__ = None - -for x in NotIterable(): # error: "Object of type `NotIterable` is not iterable" - pass -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/loops/while_loop.md b/crates/red_knot_python_semantic/resources/mdtest/loops/while_loop.md deleted file mode 100644 index 51a123edc232c..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/loops/while_loop.md +++ /dev/null @@ -1,54 +0,0 @@ -# While loops - -## Basic While Loop - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 -while flag: - x = 2 - -reveal_type(x) # revealed: Literal[1, 2] -``` - -## While with else (no break) - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 -while flag: - x = 2 -else: - reveal_type(x) # revealed: Literal[1, 2] - x = 3 - -reveal_type(x) # revealed: Literal[3] -``` - -## While with Else (may break) - -```py -def bool_instance() -> bool: - return True - -flag, flag2 = bool_instance(), bool_instance() -x = 1 -y = 0 -while flag: - x = 2 - if flag2: - y = 4 - break -else: - y = x - x = 3 - -reveal_type(x) # revealed: Literal[2, 3] -reveal_type(y) # revealed: Literal[1, 2, 4] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/boolean.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/boolean.md deleted file mode 100644 index 3ab952839bac5..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/boolean.md +++ /dev/null @@ -1,93 +0,0 @@ -# Narrowing in boolean expressions - -In `or` expressions, the right-hand side is evaluated only if the left-hand side is **falsy**. -So when the right-hand side is evaluated, we know the left side has failed. - -Similarly, in `and` expressions, the right-hand side is evaluated only if the left-hand side is **truthy**. -So when the right-hand side is evaluated, we know the left side has succeeded. - -## Narrowing in `or` - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None = A() if bool_instance() else None - -isinstance(x, A) or reveal_type(x) # revealed: None -x is None or reveal_type(x) # revealed: A -reveal_type(x) # revealed: A | None -``` - -## Narrowing in `and` - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None = A() if bool_instance() else None - -isinstance(x, A) and reveal_type(x) # revealed: A -x is None and reveal_type(x) # revealed: None -reveal_type(x) # revealed: A | None -``` - -## Multiple `and` arms - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None = A() if bool_instance() else None - -bool_instance() and isinstance(x, A) and reveal_type(x) # revealed: A -isinstance(x, A) and bool_instance() and reveal_type(x) # revealed: A -reveal_type(x) and isinstance(x, A) and bool_instance() # revealed: A | None -``` - -## Multiple `or` arms - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None = A() if bool_instance() else None - -bool_instance() or isinstance(x, A) or reveal_type(x) # revealed: None -isinstance(x, A) or bool_instance() or reveal_type(x) # revealed: None -reveal_type(x) or isinstance(x, A) or bool_instance() # revealed: A | None -``` - -## Multiple predicates - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None | Literal[1] = A() if bool_instance() else None if bool_instance() else 1 - -x is None or isinstance(x, A) or reveal_type(x) # revealed: Literal[1] -``` - -## Mix of `and` and `or` - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x: A | None | Literal[1] = A() if bool_instance() else None if bool_instance() else 1 - -isinstance(x, A) or x is not None and reveal_type(x) # revealed: Literal[1] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_elif_else.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_elif_else.md deleted file mode 100644 index 7ac16f4b8d597..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_elif_else.md +++ /dev/null @@ -1,57 +0,0 @@ -# Narrowing for conditionals with elif and else - -## Positive contributions become negative in elif-else blocks - -```py -def int_instance() -> int: - return 42 - -x = int_instance() - -if x == 1: - # cannot narrow; could be a subclass of `int` - reveal_type(x) # revealed: int -elif x == 2: - reveal_type(x) # revealed: int & ~Literal[1] -elif x != 3: - reveal_type(x) # revealed: int & ~Literal[1] & ~Literal[2] & ~Literal[3] -``` - -## Positive contributions become negative in elif-else blocks, with simplification - -```py -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else 2 if bool_instance() else 3 - -if x == 1: - # TODO should be Literal[1] - reveal_type(x) # revealed: Literal[1, 2, 3] -elif x == 2: - # TODO should be Literal[2] - reveal_type(x) # revealed: Literal[2, 3] -else: - reveal_type(x) # revealed: Literal[3] -``` - -## Multiple negative contributions using elif, with simplification - -```py -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else 2 if bool_instance() else 3 - -if x != 1: - reveal_type(x) # revealed: Literal[2, 3] -elif x != 2: - # TODO should be `Literal[1]` - reveal_type(x) # revealed: Literal[1, 3] -elif x == 3: - # TODO should be Never - reveal_type(x) # revealed: Literal[1, 2, 3] -else: - # TODO should be Never - reveal_type(x) # revealed: Literal[1, 2] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is.md deleted file mode 100644 index b9cd22897d18d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is.md +++ /dev/null @@ -1,79 +0,0 @@ -# Narrowing for `is` conditionals - -## `is None` - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = None if flag else 1 - -if x is None: - reveal_type(x) # revealed: None -else: - reveal_type(x) # revealed: Literal[1] - -reveal_type(x) # revealed: None | Literal[1] -``` - -## `is` for other types - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -class A: ... - -x = A() -y = x if flag else None - -if y is x: - reveal_type(y) # revealed: A -else: - reveal_type(y) # revealed: A | None - -reveal_type(y) # revealed: A | None -``` - -## `is` in chained comparisons - -```py -def bool_instance() -> bool: - return True - -x_flag, y_flag = bool_instance(), bool_instance() -x = True if x_flag else False -y = True if y_flag else False - -reveal_type(x) # revealed: bool -reveal_type(y) # revealed: bool - -if y is x is False: # Interpreted as `(y is x) and (x is False)` - reveal_type(x) # revealed: Literal[False] - reveal_type(y) # revealed: bool -else: - # The negation of the clause above is (y is not x) or (x is not False) - # So we can't narrow the type of x or y here, because each arm of the `or` could be true - reveal_type(x) # revealed: bool - reveal_type(y) # revealed: bool -``` - -## `is` in elif clause - -```py -def bool_instance() -> bool: - return True - -x = None if bool_instance() else (1 if bool_instance() else True) - -reveal_type(x) # revealed: None | Literal[1] | Literal[True] -if x is None: - reveal_type(x) # revealed: None -elif x is True: - reveal_type(x) # revealed: Literal[True] -else: - reveal_type(x) # revealed: Literal[1] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is_not.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is_not.md deleted file mode 100644 index f23bae8e1e8c5..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_is_not.md +++ /dev/null @@ -1,97 +0,0 @@ -# Narrowing for `is not` conditionals - -## `is not None` - -The type guard removes `None` from the union type: - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = None if flag else 1 - -if x is not None: - reveal_type(x) # revealed: Literal[1] -else: - reveal_type(x) # revealed: None - -reveal_type(x) # revealed: None | Literal[1] -``` - -## `is not` for other singleton types - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = True if flag else False -reveal_type(x) # revealed: bool - -if x is not False: - reveal_type(x) # revealed: Literal[True] -else: - reveal_type(x) # revealed: Literal[False] -``` - -## `is not` for non-singleton types - -Non-singleton types should *not* narrow the type: two instances of a -non-singleton class may occupy different addresses in memory even if -they compare equal. - -```py -x = 345 -y = 345 - -if x is not y: - reveal_type(x) # revealed: Literal[345] -else: - reveal_type(x) # revealed: Literal[345] -``` - -## `is not` for other types - -```py -def bool_instance() -> bool: - return True - -class A: ... - -x = A() -y = x if bool_instance() else None - -if y is not x: - reveal_type(y) # revealed: A | None -else: - reveal_type(y) # revealed: A - -reveal_type(y) # revealed: A | None -``` - -## `is not` in chained comparisons - -The type guard removes `False` from the union type of the tested value only. - -```py -def bool_instance() -> bool: - return True - -x_flag, y_flag = bool_instance(), bool_instance() -x = True if x_flag else False -y = True if y_flag else False - -reveal_type(x) # revealed: bool -reveal_type(y) # revealed: bool - -if y is not x is not False: # Interpreted as `(y is not x) and (x is not False)` - reveal_type(x) # revealed: Literal[True] - reveal_type(y) # revealed: bool -else: - # The negation of the clause above is (y is x) or (x is False) - # So we can't narrow the type of x or y here, because each arm of the `or` could be true - - reveal_type(x) # revealed: bool - reveal_type(y) # revealed: bool -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_nested.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_nested.md deleted file mode 100644 index cc0f79165e742..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_nested.md +++ /dev/null @@ -1,56 +0,0 @@ -# Narrowing for nested conditionals - -## Multiple negative contributions - -```py -def int_instance() -> int: - return 42 - -x = int_instance() - -if x != 1: - if x != 2: - if x != 3: - reveal_type(x) # revealed: int & ~Literal[1] & ~Literal[2] & ~Literal[3] -``` - -## Multiple negative contributions with simplification - -```py -def bool_instance() -> bool: - return True - -flag1, flag2 = bool_instance(), bool_instance() -x = 1 if flag1 else 2 if flag2 else 3 - -if x != 1: - reveal_type(x) # revealed: Literal[2, 3] - if x != 2: - reveal_type(x) # revealed: Literal[3] -``` - -## elif-else blocks - -```py -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else 2 if bool_instance() else 3 - -if x != 1: - reveal_type(x) # revealed: Literal[2, 3] - if x == 2: - # TODO should be `Literal[2]` - reveal_type(x) # revealed: Literal[2, 3] - elif x == 3: - reveal_type(x) # revealed: Literal[3] - else: - reveal_type(x) # revealed: Never - -elif x != 2: - # TODO should be Literal[1] - reveal_type(x) # revealed: Literal[1, 3] -else: - # TODO should be Never - reveal_type(x) # revealed: Literal[1, 2, 3] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not.md deleted file mode 100644 index 0cf341496c337..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not.md +++ /dev/null @@ -1,33 +0,0 @@ -# Narrowing for `not` conditionals - -The `not` operator negates a constraint. - -## `not is None` - -```py -def bool_instance() -> bool: - return True - -x = None if bool_instance() else 1 - -if not x is None: - reveal_type(x) # revealed: Literal[1] -else: - reveal_type(x) # revealed: None - -reveal_type(x) # revealed: None | Literal[1] -``` - -## `not isinstance` - -```py -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else "a" - -if not isinstance(x, (int)): - reveal_type(x) # revealed: Literal["a"] -else: - reveal_type(x) # revealed: Literal[1] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not_eq.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not_eq.md deleted file mode 100644 index 3ad8ebcb68e10..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/conditionals_not_eq.md +++ /dev/null @@ -1,119 +0,0 @@ -# Narrowing for `!=` conditionals - -## `x != None` - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = None if flag else 1 - -if x != None: - reveal_type(x) # revealed: Literal[1] -else: - # TODO should be None - reveal_type(x) # revealed: None | Literal[1] -``` - -## `!=` for other singleton types - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = True if flag else False - -if x != False: - reveal_type(x) # revealed: Literal[True] -else: - # TODO should be Literal[False] - reveal_type(x) # revealed: bool -``` - -## `x != y` where `y` is of literal type - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else 2 - -if x != 1: - reveal_type(x) # revealed: Literal[2] -``` - -## `x != y` where `y` is a single-valued type - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -class A: ... -class B: ... - -C = A if flag else B - -if C != A: - reveal_type(C) # revealed: Literal[B] -else: - # TODO should be Literal[A] - reveal_type(C) # revealed: Literal[A, B] -``` - -## `x != y` where `y` has multiple single-valued options - -```py -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else 2 -y = 2 if bool_instance() else 3 - -if x != y: - reveal_type(x) # revealed: Literal[1, 2] -else: - # TODO should be Literal[2] - reveal_type(x) # revealed: Literal[1, 2] -``` - -## `!=` for non-single-valued types - -Only single-valued types should narrow the type: - -```py -def bool_instance() -> bool: - return True - -def int_instance() -> int: - return 42 - -flag = bool_instance() -x = int_instance() if flag else None -y = int_instance() - -if x != y: - reveal_type(x) # revealed: int | None -``` - -## Mix of single-valued and non-single-valued types - -```py -def int_instance() -> int: - return 42 - -def bool_instance() -> bool: - return True - -x = 1 if bool_instance() else 2 -y = 2 if bool_instance() else int_instance() - -if x != y: - reveal_type(x) # revealed: Literal[1, 2] -else: - reveal_type(x) # revealed: Literal[1, 2] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/isinstance.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/isinstance.md deleted file mode 100644 index 4b07d5648a760..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/isinstance.md +++ /dev/null @@ -1,209 +0,0 @@ -# Narrowing for `isinstance` checks - -Narrowing for `isinstance(object, classinfo)` expressions. - -## `classinfo` is a single type - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -x = 1 if flag else "a" - -if isinstance(x, int): - reveal_type(x) # revealed: Literal[1] - -if isinstance(x, str): - reveal_type(x) # revealed: Literal["a"] - if isinstance(x, int): - reveal_type(x) # revealed: Never - -if isinstance(x, (int, object)): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -``` - -## `classinfo` is a tuple of types - -Note: `isinstance(x, (int, str))` should not be confused with -`isinstance(x, tuple[(int, str)])`. The former is equivalent to -`isinstance(x, int | str)`: - -```py -def bool_instance() -> bool: - return True - -flag, flag1, flag2 = bool_instance(), bool_instance(), bool_instance() - -x = 1 if flag else "a" - -if isinstance(x, (int, str)): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -else: - reveal_type(x) # revealed: Never - -if isinstance(x, (int, bytes)): - reveal_type(x) # revealed: Literal[1] - -if isinstance(x, (bytes, str)): - reveal_type(x) # revealed: Literal["a"] - -# No narrowing should occur if a larger type is also -# one of the possibilities: -if isinstance(x, (int, object)): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -else: - reveal_type(x) # revealed: Never - -y = 1 if flag1 else "a" if flag2 else b"b" -if isinstance(y, (int, str)): - reveal_type(y) # revealed: Literal[1] | Literal["a"] - -if isinstance(y, (int, bytes)): - reveal_type(y) # revealed: Literal[1] | Literal[b"b"] - -if isinstance(y, (str, bytes)): - reveal_type(y) # revealed: Literal["a"] | Literal[b"b"] -``` - -## `classinfo` is a nested tuple of types - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -x = 1 if flag else "a" - -if isinstance(x, (bool, (bytes, int))): - reveal_type(x) # revealed: Literal[1] -else: - reveal_type(x) # revealed: Literal["a"] -``` - -## Class types - -```py -class A: ... -class B: ... -class C: ... - -def get_object() -> object: ... - -x = get_object() - -if isinstance(x, A): - reveal_type(x) # revealed: A - if isinstance(x, B): - reveal_type(x) # revealed: A & B - else: - reveal_type(x) # revealed: A & ~B - -if isinstance(x, (A, B)): - reveal_type(x) # revealed: A | B -elif isinstance(x, (A, C)): - reveal_type(x) # revealed: C & ~A & ~B -else: - # TODO: Should be simplified to ~A & ~B & ~C - reveal_type(x) # revealed: object & ~A & ~B & ~C -``` - -## No narrowing for instances of `builtins.type` - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -t = type("t", (), {}) - -# This isn't testing what we want it to test if we infer anything more precise here: -reveal_type(t) # revealed: type -x = 1 if flag else "foo" - -if isinstance(x, t): - reveal_type(x) # revealed: Literal[1] | Literal["foo"] -``` - -## Do not use custom `isinstance` for narrowing - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -def isinstance(x, t): - return True - -x = 1 if flag else "a" -if isinstance(x, int): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -``` - -## Do support narrowing if `isinstance` is aliased - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -isinstance_alias = isinstance - -x = 1 if flag else "a" -if isinstance_alias(x, int): - reveal_type(x) # revealed: Literal[1] -``` - -## Do support narrowing if `isinstance` is imported - -```py -from builtins import isinstance as imported_isinstance - -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else "a" -if imported_isinstance(x, int): - reveal_type(x) # revealed: Literal[1] -``` - -## Do not narrow if second argument is not a type - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else "a" - -# TODO: this should cause us to emit a diagnostic during -# type checking -if isinstance(x, "a"): - reveal_type(x) # revealed: Literal[1] | Literal["a"] - -# TODO: this should cause us to emit a diagnostic during -# type checking -if isinstance(x, "int"): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -``` - -## Do not narrow if there are keyword arguments - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() -x = 1 if flag else "a" - -# TODO: this should cause us to emit a diagnostic -# (`isinstance` has no `foo` parameter) -if isinstance(x, int, foo="bar"): - reveal_type(x) # revealed: Literal[1] | Literal["a"] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/narrow/match.md b/crates/red_knot_python_semantic/resources/mdtest/narrow/match.md deleted file mode 100644 index 2144f91f9eff7..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/narrow/match.md +++ /dev/null @@ -1,21 +0,0 @@ -# Narrowing for `match` statements - -## Single `match` pattern - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -x = None if flag else 1 -reveal_type(x) # revealed: None | Literal[1] - -y = 0 - -match x: - case None: - y = x - -reveal_type(y) # revealed: Literal[0] | None -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/scopes/builtin.md b/crates/red_knot_python_semantic/resources/mdtest/scopes/builtin.md deleted file mode 100644 index 7be6c7531b31c..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/scopes/builtin.md +++ /dev/null @@ -1,32 +0,0 @@ -# Builtin scope - -## Conditionally global or builtin - -If a builtin name is conditionally defined as a global, a name lookup should union the builtin type -with the conditionally-defined type: - -```py -def returns_bool() -> bool: - return True - -if returns_bool(): - copyright = 1 - -def f(): - reveal_type(copyright) # revealed: Literal[copyright] | Literal[1] -``` - -## Conditionally global or builtin, with annotation - -Same is true if the name is annotated: - -```py -def returns_bool() -> bool: - return True - -if returns_bool(): - copyright: int = 1 - -def f(): - reveal_type(copyright) # revealed: Literal[copyright] | int -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/shadowing/class.md b/crates/red_knot_python_semantic/resources/mdtest/shadowing/class.md deleted file mode 100644 index 212c97baf9978..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/shadowing/class.md +++ /dev/null @@ -1,19 +0,0 @@ -# Classes shadowing - -## Implicit error - -```py -class C: ... - -C = 1 # error: "Implicit shadowing of class `C`; annotate to make it explicit if this is intentional" -``` - -## Explicit - -No diagnostic is raised in the case of explicit shadowing: - -```py -class C: ... - -C: int = 1 -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/shadowing/function.md b/crates/red_knot_python_semantic/resources/mdtest/shadowing/function.md deleted file mode 100644 index b3e0c81ccc84a..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/shadowing/function.md +++ /dev/null @@ -1,26 +0,0 @@ -# Function shadowing - -## Parameter - -Parameter `x` of type `str` is shadowed and reassigned with a new `int` value inside the function. No diagnostics should be generated. - -```py path=a.py -def f(x: str): - x: int = int(x) -``` - -## Implicit error - -```py path=a.py -def f(): ... - -f = 1 # error: "Implicit shadowing of function `f`; annotate to make it explicit if this is intentional" -``` - -## Explicit shadowing - -```py path=a.py -def f(): ... - -f: int = 1 -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/shadowing/variable_declaration.md b/crates/red_knot_python_semantic/resources/mdtest/shadowing/variable_declaration.md deleted file mode 100644 index 44a93668c9801..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/shadowing/variable_declaration.md +++ /dev/null @@ -1,16 +0,0 @@ -# Shadwing declaration - -## Shadow after incompatible declarations is OK - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - x: str -else: - x: int -x: bytes = b"foo" -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/stubs/class.md b/crates/red_knot_python_semantic/resources/mdtest/stubs/class.md deleted file mode 100644 index c679e51c0c96a..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/stubs/class.md +++ /dev/null @@ -1,11 +0,0 @@ -# Class defenitions in stubs - -## Cyclical class definition - -In type stubs, classes can reference themselves in their base class definitions. For example, in `typeshed`, we have `class str(Sequence[str]): ...`. - -```py path=a.pyi -class C(C): ... - -reveal_type(C) # revealed: Literal[C] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/bytes.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/bytes.md deleted file mode 100644 index 15330e4006b9d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/bytes.md +++ /dev/null @@ -1,35 +0,0 @@ -# Bytes subscript - -## Simple - -```py -b = b"\x00abc\xff" - -reveal_type(b[0]) # revealed: Literal[b"\x00"] -reveal_type(b[1]) # revealed: Literal[b"a"] -reveal_type(b[4]) # revealed: Literal[b"\xff"] - -reveal_type(b[-1]) # revealed: Literal[b"\xff"] -reveal_type(b[-2]) # revealed: Literal[b"c"] -reveal_type(b[-5]) # revealed: Literal[b"\x00"] - -reveal_type(b[False]) # revealed: Literal[b"\x00"] -reveal_type(b[True]) # revealed: Literal[b"a"] - -x = b[5] # error: [index-out-of-bounds] "Index 5 is out of bounds for bytes literal `Literal[b"\x00abc\xff"]` with length 5" -reveal_type(x) # revealed: Unknown - -y = b[-6] # error: [index-out-of-bounds] "Index -6 is out of bounds for bytes literal `Literal[b"\x00abc\xff"]` with length 5" -reveal_type(y) # revealed: Unknown -``` - -## Function return - -```py -def int_instance() -> int: - return 42 - -a = b"abcde"[int_instance()] -# TODO: Support overloads... Should be `bytes` -reveal_type(a) # revealed: @Todo -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/class.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/class.md deleted file mode 100644 index 82d8beff9ef82..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/class.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class subscript - -## Class getitem unbound - -```py -class NotSubscriptable: ... - -a = NotSubscriptable[0] # error: "Cannot subscript object of type `Literal[NotSubscriptable]` with no `__class_getitem__` method" -``` - -## Class getitem - -```py -class Identity: - def __class_getitem__(cls, item: int) -> str: - return item - -reveal_type(Identity[0]) # revealed: str -``` - -## Class getitem union - -```py -flag = True - -class UnionClassGetItem: - if flag: - - def __class_getitem__(cls, item: int) -> str: - return item - else: - - def __class_getitem__(cls, item: int) -> int: - return item - -reveal_type(UnionClassGetItem[0]) # revealed: str | int -``` - -## Class getitem with class union - -```py -flag = True - -class A: - def __class_getitem__(cls, item: int) -> str: - return item - -class B: - def __class_getitem__(cls, item: int) -> int: - return item - -x = A if flag else B - -reveal_type(x) # revealed: Literal[A, B] -reveal_type(x[0]) # revealed: str | int -``` - -## Class getitem with unbound method union - -```py -flag = True - -if flag: - class Spam: - def __class_getitem__(self, x: int) -> str: - return "foo" - -else: - class Spam: ... - -# error: [call-non-callable] "Method `__class_getitem__` of type `Literal[__class_getitem__] | Unbound` is not callable on object of type `Literal[Spam, Spam]`" -# revealed: str | Unknown -reveal_type(Spam[42]) -``` - -## TODO: Class getitem non-class union - -```py -flag = True - -if flag: - class Eggs: - def __class_getitem__(self, x: int) -> str: - return "foo" - -else: - Eggs = 1 - -a = Eggs[42] # error: "Cannot subscript object of type `Literal[Eggs] | Literal[1]` with no `__getitem__` method" - -# TODO: should _probably_ emit `str | Unknown` -reveal_type(a) # revealed: Unknown -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/instance.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/instance.md deleted file mode 100644 index a7d170a29b490..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/instance.md +++ /dev/null @@ -1,46 +0,0 @@ -# Instance subscript - -## Getitem unbound - -```py -class NotSubscriptable: ... - -a = NotSubscriptable()[0] # error: "Cannot subscript object of type `NotSubscriptable` with no `__getitem__` method" -``` - -## Getitem not callable - -```py -class NotSubscriptable: - __getitem__ = None - -a = NotSubscriptable()[0] # error: "Method `__getitem__` of type `None` is not callable on object of type `NotSubscriptable`" -``` - -## Valid getitem - -```py -class Identity: - def __getitem__(self, index: int) -> int: - return index - -reveal_type(Identity()[0]) # revealed: int -``` - -## Getitem union - -```py -flag = True - -class Identity: - if flag: - - def __getitem__(self, index: int) -> int: - return index - else: - - def __getitem__(self, index: int) -> str: - return str(index) - -reveal_type(Identity()[0]) # revealed: int | str -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/lists.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/lists.md deleted file mode 100644 index b82b23f19265f..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/lists.md +++ /dev/null @@ -1,38 +0,0 @@ -# List subscripts - -## Indexing into lists - -A list can be indexed into with: - -- numbers -- slices - -```py -x = [1, 2, 3] -reveal_type(x) # revealed: list - -# TODO reveal int -reveal_type(x[0]) # revealed: @Todo - -# TODO reveal list -reveal_type(x[0:1]) # revealed: @Todo - -# TODO error -reveal_type(x["a"]) # revealed: @Todo -``` - -## Assignments within list assignment - -In assignment, we might also have a named assignment. -This should also get type checked. - -```py -x = [1, 2, 3] -x[0 if (y := 2) else 1] = 5 - -# TODO error? (indeterminite index type) -x["a" if (y := 2) else 1] = 6 - -# TODO error (can't index via string) -x["a" if (y := 2) else "b"] = 6 -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/string.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/string.md deleted file mode 100644 index 6987a95a70b18..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/string.md +++ /dev/null @@ -1,32 +0,0 @@ -# Subscript on strings - -## Simple - -```py -s = "abcde" - -reveal_type(s[0]) # revealed: Literal["a"] -reveal_type(s[1]) # revealed: Literal["b"] -reveal_type(s[-1]) # revealed: Literal["e"] -reveal_type(s[-2]) # revealed: Literal["d"] - -reveal_type(s[False]) # revealed: Literal["a"] -reveal_type(s[True]) # revealed: Literal["b"] - -a = s[8] # error: [index-out-of-bounds] "Index 8 is out of bounds for string `Literal["abcde"]` with length 5" -reveal_type(a) # revealed: Unknown - -b = s[-8] # error: [index-out-of-bounds] "Index -8 is out of bounds for string `Literal["abcde"]` with length 5" -reveal_type(b) # revealed: Unknown -``` - -## Function return - -```py -def int_instance() -> int: - return 42 - -a = "abcde"[int_instance()] -# TODO: Support overloads... Should be `str` -reveal_type(a) # revealed: @Todo -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/subscript/tuple.md b/crates/red_knot_python_semantic/resources/mdtest/subscript/tuple.md deleted file mode 100644 index 7545e8d1c556f..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/subscript/tuple.md +++ /dev/null @@ -1,18 +0,0 @@ -# Tuple subscripts - -## Basic - -```py -t = (1, "a", "b") - -reveal_type(t[0]) # revealed: Literal[1] -reveal_type(t[1]) # revealed: Literal["a"] -reveal_type(t[-1]) # revealed: Literal["b"] -reveal_type(t[-2]) # revealed: Literal["a"] - -a = t[4] # error: [index-out-of-bounds] -reveal_type(a) # revealed: Unknown - -b = t[-4] # error: [index-out-of-bounds] -reveal_type(b) # revealed: Unknown -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/unary/instance.md b/crates/red_knot_python_semantic/resources/mdtest/unary/instance.md deleted file mode 100644 index c07bf7b56c34b..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/unary/instance.md +++ /dev/null @@ -1,29 +0,0 @@ -# Unary Operations - -```py -class Number: - def __init__(self, value: int): - self.value = 1 - - def __pos__(self) -> int: - return +self.value - - def __neg__(self) -> int: - return -self.value - - def __invert__(self) -> Literal[True]: - return True - -a = Number() - -reveal_type(+a) # revealed: int -reveal_type(-a) # revealed: int -reveal_type(~a) # revealed: @Todo - -class NoDunder: ... - -b = NoDunder() -+b # error: [unsupported-operator] "Unary operator `+` is unsupported for type `NoDunder`" --b # error: [unsupported-operator] "Unary operator `-` is unsupported for type `NoDunder`" -~b # error: [unsupported-operator] "Unary operator `~` is unsupported for type `NoDunder`" -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/unary/not.md b/crates/red_knot_python_semantic/resources/mdtest/unary/not.md deleted file mode 100644 index bb9f6ccac735d..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/unary/not.md +++ /dev/null @@ -1,117 +0,0 @@ -# Unary not - -## None - -```py -reveal_type(not None) # revealed: Literal[True] -reveal_type(not not None) # revealed: Literal[False] -``` - -## Function - -```py -from typing import reveal_type - -def f(): - return 1 - -reveal_type(not f) # revealed: Literal[False] -# TODO Unknown should not be part of the type of typing.reveal_type -# reveal_type(not reveal_type) revealed: Literal[False] -``` - -## Module - -```py -import b -import warnings - -reveal_type(not b) # revealed: Literal[False] -reveal_type(not warnings) # revealed: Literal[False] -``` - -```py path=b.py -y = 1 -``` - -## Union - -```py -def bool_instance() -> bool: - return True - -flag = bool_instance() - -if flag: - p = 1 - q = 3.3 - r = "hello" - s = "world" - t = 0 -else: - p = "hello" - q = 4 - r = "" - s = 0 - t = "" - -reveal_type(not p) # revealed: Literal[False] -reveal_type(not q) # revealed: bool -reveal_type(not r) # revealed: bool -reveal_type(not s) # revealed: bool -reveal_type(not t) # revealed: Literal[True] -``` - -## Integer literal - -```py -reveal_type(not 1) # revealed: Literal[False] -reveal_type(not 1234567890987654321) # revealed: Literal[False] -reveal_type(not 0) # revealed: Literal[True] -reveal_type(not -1) # revealed: Literal[False] -reveal_type(not -1234567890987654321) # revealed: Literal[False] -reveal_type(not --987) # revealed: Literal[False] -``` - -## Boolean literal - -```py -w = True -reveal_type(w) # revealed: Literal[True] - -x = False -reveal_type(x) # revealed: Literal[False] - -reveal_type(not w) # revealed: Literal[False] - -reveal_type(not x) # revealed: Literal[True] -``` - -## String literal - -```py -reveal_type(not "hello") # revealed: Literal[False] -reveal_type(not "") # revealed: Literal[True] -reveal_type(not "0") # revealed: Literal[False] -reveal_type(not "hello" + "world") # revealed: Literal[False] -``` - -## Bytes literal - -```py -reveal_type(not b"hello") # revealed: Literal[False] -reveal_type(not b"") # revealed: Literal[True] -reveal_type(not b"0") # revealed: Literal[False] -reveal_type(not b"hello" + b"world") # revealed: Literal[False] -``` - -## Tuple - -```py -reveal_type(not (1,)) # revealed: Literal[False] -reveal_type(not (1, 2)) # revealed: Literal[False] -reveal_type(not (1, 2, 3)) # revealed: Literal[False] -reveal_type(not ()) # revealed: Literal[True] -reveal_type(not ("hello",)) # revealed: Literal[False] -reveal_type(not (1, "hello")) # revealed: Literal[False] -``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/unpacking.md b/crates/red_knot_python_semantic/resources/mdtest/unpacking.md deleted file mode 100644 index e1ee64721161f..0000000000000 --- a/crates/red_knot_python_semantic/resources/mdtest/unpacking.md +++ /dev/null @@ -1,269 +0,0 @@ -# Unpacking - -## Tuple - -### Simple tuple - -```py -(a, b, c) = (1, 2, 3) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: Literal[3] -``` - -### Simple list - -```py -[a, b, c] = (1, 2, 3) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: Literal[3] -``` - -### Simple mixed - -```py -[a, (b, c), d] = (1, (2, 3), 4) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: Literal[3] -reveal_type(d) # revealed: Literal[4] -``` - -### Multiple assignment - -```py -a, b = c = 1, 2 -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: tuple[Literal[1], Literal[2]] -``` - -### Nested tuple with unpacking - -```py -(a, (b, c), d) = (1, (2, 3), 4) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: Literal[3] -reveal_type(d) # revealed: Literal[4] -``` - -### Nested tuple without unpacking - -```py -(a, b, c) = (1, (2, 3), 4) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: tuple[Literal[2], Literal[3]] -reveal_type(c) # revealed: Literal[4] -``` - -### Uneven unpacking (1) - -```py -# TODO: Add diagnostic (there aren't enough values to unpack) -(a, b, c) = (1, 2) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -reveal_type(c) # revealed: Unknown -``` - -### Uneven unpacking (2) - -```py -# TODO: Add diagnostic (too many values to unpack) -(a, b) = (1, 2, 3) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -``` - -### Starred expression (1) - -```py -# TODO: Add diagnostic (need more values to unpack) -# TODO: Remove 'not-iterable' diagnostic -[a, *b, c, d] = (1, 2) # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: Literal[1] -# TODO: Should be list[Any] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: Literal[2] -reveal_type(d) # revealed: Unknown -``` - -### Starred expression (2) - -```py -[a, *b, c] = (1, 2) # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: Literal[1] -# TODO: Should be list[Any] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: Literal[2] -``` - -### Starred expression (3) - -```py -# TODO: Remove 'not-iterable' diagnostic -[a, *b, c] = (1, 2, 3) # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: Literal[1] -# TODO: Should be list[int] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: Literal[3] -``` - -### Starred expression (4) - -```py -# TODO: Remove 'not-iterable' diagnostic -[a, *b, c, d] = (1, 2, 3, 4, 5, 6) # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: Literal[1] -# TODO: Should be list[int] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: Literal[5] -reveal_type(d) # revealed: Literal[6] -``` - -### Starred expression (5) - -```py -# TODO: Remove 'not-iterable' diagnostic -[a, b, *c] = (1, 2, 3, 4) # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: Literal[2] -# TODO: Should be list[int] once support for assigning to starred expression is added -reveal_type(c) # revealed: @Todo -``` - -### Non-iterable unpacking - -TODO: Remove duplicate diagnostics. This is happening because for a sequence-like -assignment target, multiple definitions are created and the inference engine runs -on each of them which results in duplicate diagnostics. - -```py -# error: "Object of type `Literal[1]` is not iterable" -# error: "Object of type `Literal[1]` is not iterable" -a, b = 1 -reveal_type(a) # revealed: Unknown -reveal_type(b) # revealed: Unknown -``` - -### Custom iterator unpacking - -```py -class Iterator: - def __next__(self) -> int: - return 42 - -class Iterable: - def __iter__(self) -> Iterator: - return Iterator() - -(a, b) = Iterable() -reveal_type(a) # revealed: int -reveal_type(b) # revealed: int -``` - -### Custom iterator unpacking nested - -```py -class Iterator: - def __next__(self) -> int: - return 42 - -class Iterable: - def __iter__(self) -> Iterator: - return Iterator() - -(a, (b, c), d) = (1, Iterable(), 2) -reveal_type(a) # revealed: Literal[1] -reveal_type(b) # revealed: int -reveal_type(c) # revealed: int -reveal_type(d) # revealed: Literal[2] -``` - -## String - -### Simple unpacking - -```py -a, b = "ab" -reveal_type(a) # revealed: LiteralString -reveal_type(b) # revealed: LiteralString -``` - -### Uneven unpacking (1) - -```py -# TODO: Add diagnostic (there aren't enough values to unpack) -a, b, c = "ab" -reveal_type(a) # revealed: LiteralString -reveal_type(b) # revealed: LiteralString -reveal_type(c) # revealed: Unknown -``` - -### Uneven unpacking (2) - -```py -# TODO: Add diagnostic (too many values to unpack) -a, b = "abc" -reveal_type(a) # revealed: LiteralString -reveal_type(b) # revealed: LiteralString -``` - -### Starred expression (1) - -```py -# TODO: Add diagnostic (need more values to unpack) -# TODO: Remove 'not-iterable' diagnostic -(a, *b, c, d) = "ab" # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: LiteralString -# TODO: Should be list[LiteralString] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: LiteralString -reveal_type(d) # revealed: Unknown -``` - -### Starred expression (2) - -```py -(a, *b, c) = "ab" # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: LiteralString -# TODO: Should be list[Any] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: LiteralString -``` - -### Starred expression (3) - -```py -# TODO: Remove 'not-iterable' diagnostic -(a, *b, c) = "abc" # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: LiteralString -# TODO: Should be list[LiteralString] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: LiteralString -``` - -### Starred expression (4) - -```py -# TODO: Remove 'not-iterable' diagnostic -(a, *b, c, d) = "abcdef" # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: LiteralString -# TODO: Should be list[LiteralString] once support for assigning to starred expression is added -reveal_type(b) # revealed: @Todo -reveal_type(c) # revealed: LiteralString -reveal_type(d) # revealed: LiteralString -``` - -### Starred expression (5) - -```py -# TODO: Remove 'not-iterable' diagnostic -(a, b, *c) = "abcd" # error: "Object of type `None` is not iterable" -reveal_type(a) # revealed: LiteralString -reveal_type(b) # revealed: LiteralString -# TODO: Should be list[int] once support for assigning to starred expression is added -reveal_type(c) # revealed: @Todo -``` diff --git a/crates/red_knot_python_semantic/src/ast_node_ref.rs b/crates/red_knot_python_semantic/src/ast_node_ref.rs deleted file mode 100644 index 367748b5ad285..0000000000000 --- a/crates/red_knot_python_semantic/src/ast_node_ref.rs +++ /dev/null @@ -1,163 +0,0 @@ -use std::hash::Hash; -use std::ops::Deref; - -use ruff_db::parsed::ParsedModule; - -/// Ref-counted owned reference to an AST node. -/// -/// The type holds an owned reference to the node's ref-counted [`ParsedModule`]. -/// Holding on to the node's [`ParsedModule`] guarantees that the reference to the -/// node must still be valid. -/// -/// Holding on to any [`AstNodeRef`] prevents the [`ParsedModule`] from being released. -/// -/// ## Equality -/// Two `AstNodeRef` are considered equal if their wrapped nodes are equal. -#[derive(Clone)] -pub struct AstNodeRef { - /// Owned reference to the node's [`ParsedModule`]. - /// - /// The node's reference is guaranteed to remain valid as long as it's enclosing - /// [`ParsedModule`] is alive. - _parsed: ParsedModule, - - /// Pointer to the referenced node. - node: std::ptr::NonNull, -} - -#[allow(unsafe_code)] -impl AstNodeRef { - /// Creates a new `AstNodeRef` that reference `node`. The `parsed` is the [`ParsedModule`] to - /// which the `AstNodeRef` belongs. - /// - /// ## Safety - /// - /// Dereferencing the `node` can result in undefined behavior if `parsed` isn't the - /// [`ParsedModule`] to which `node` belongs. It's the caller's responsibility to ensure that - /// the invariant `node belongs to parsed` is upheld. - pub(super) unsafe fn new(parsed: ParsedModule, node: &T) -> Self { - Self { - _parsed: parsed, - node: std::ptr::NonNull::from(node), - } - } - - /// Returns a reference to the wrapped node. - pub fn node(&self) -> &T { - // SAFETY: Holding on to `parsed` ensures that the AST to which `node` belongs is still - // alive and not moved. - unsafe { self.node.as_ref() } - } -} - -impl Deref for AstNodeRef { - type Target = T; - - fn deref(&self) -> &Self::Target { - self.node() - } -} - -impl std::fmt::Debug for AstNodeRef -where - T: std::fmt::Debug, -{ - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.debug_tuple("AstNodeRef").field(&self.node()).finish() - } -} - -impl PartialEq for AstNodeRef -where - T: PartialEq, -{ - fn eq(&self, other: &Self) -> bool { - self.node().eq(other.node()) - } -} - -impl Eq for AstNodeRef where T: Eq {} - -impl Hash for AstNodeRef -where - T: Hash, -{ - fn hash(&self, state: &mut H) { - self.node().hash(state); - } -} - -#[allow(unsafe_code)] -unsafe impl Send for AstNodeRef where T: Send {} -#[allow(unsafe_code)] -unsafe impl Sync for AstNodeRef where T: Sync {} - -#[cfg(test)] -mod tests { - use crate::ast_node_ref::AstNodeRef; - use ruff_db::parsed::ParsedModule; - use ruff_python_ast::PySourceType; - use ruff_python_parser::parse_unchecked_source; - - #[test] - #[allow(unsafe_code)] - fn equality() { - let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); - let parsed = ParsedModule::new(parsed_raw.clone()); - - let stmt = &parsed.syntax().body[0]; - - let node1 = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; - let node2 = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; - - assert_eq!(node1, node2); - - // Compare from different trees - let cloned = ParsedModule::new(parsed_raw); - let stmt_cloned = &cloned.syntax().body[0]; - let cloned_node = unsafe { AstNodeRef::new(cloned.clone(), stmt_cloned) }; - - assert_eq!(node1, cloned_node); - - let other_raw = parse_unchecked_source("2 + 2", PySourceType::Python); - let other = ParsedModule::new(other_raw); - - let other_stmt = &other.syntax().body[0]; - let other_node = unsafe { AstNodeRef::new(other.clone(), other_stmt) }; - - assert_ne!(node1, other_node); - } - - #[allow(unsafe_code)] - #[test] - fn inequality() { - let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); - let parsed = ParsedModule::new(parsed_raw); - - let stmt = &parsed.syntax().body[0]; - let node = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; - - let other_raw = parse_unchecked_source("2 + 2", PySourceType::Python); - let other = ParsedModule::new(other_raw); - - let other_stmt = &other.syntax().body[0]; - let other_node = unsafe { AstNodeRef::new(other.clone(), other_stmt) }; - - assert_ne!(node, other_node); - } - - #[test] - #[allow(unsafe_code)] - fn debug() { - let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); - let parsed = ParsedModule::new(parsed_raw); - - let stmt = &parsed.syntax().body[0]; - - let stmt_node = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; - - let debug = format!("{stmt_node:?}"); - - assert_eq!(debug, format!("AstNodeRef({stmt:?})")); - } -} diff --git a/crates/red_knot_python_semantic/src/db.rs b/crates/red_knot_python_semantic/src/db.rs deleted file mode 100644 index 92f8619babc85..0000000000000 --- a/crates/red_knot_python_semantic/src/db.rs +++ /dev/null @@ -1,111 +0,0 @@ -use ruff_db::files::File; -use ruff_db::{Db as SourceDb, Upcast}; - -/// Database giving access to semantic information about a Python program. -#[salsa::db] -pub trait Db: SourceDb + Upcast { - fn is_file_open(&self, file: File) -> bool; -} - -#[cfg(test)] -pub(crate) mod tests { - use std::sync::Arc; - - use ruff_db::files::{File, Files}; - use ruff_db::system::{DbWithTestSystem, System, TestSystem}; - use ruff_db::vendored::VendoredFileSystem; - use ruff_db::{Db as SourceDb, Upcast}; - - use super::Db; - - #[salsa::db] - pub(crate) struct TestDb { - storage: salsa::Storage, - files: Files, - system: TestSystem, - vendored: VendoredFileSystem, - events: std::sync::Arc>>, - } - - impl TestDb { - pub(crate) fn new() -> Self { - Self { - storage: salsa::Storage::default(), - system: TestSystem::default(), - vendored: red_knot_vendored::file_system().clone(), - events: std::sync::Arc::default(), - files: Files::default(), - } - } - - /// Takes the salsa events. - /// - /// ## Panics - /// If there are any pending salsa snapshots. - pub(crate) fn take_salsa_events(&mut self) -> Vec { - let inner = Arc::get_mut(&mut self.events).expect("no pending salsa snapshots"); - - let events = inner.get_mut().unwrap(); - std::mem::take(&mut *events) - } - - /// Clears the salsa events. - /// - /// ## Panics - /// If there are any pending salsa snapshots. - pub(crate) fn clear_salsa_events(&mut self) { - self.take_salsa_events(); - } - } - - impl DbWithTestSystem for TestDb { - fn test_system(&self) -> &TestSystem { - &self.system - } - - fn test_system_mut(&mut self) -> &mut TestSystem { - &mut self.system - } - } - - #[salsa::db] - impl SourceDb for TestDb { - fn vendored(&self) -> &VendoredFileSystem { - &self.vendored - } - - fn system(&self) -> &dyn System { - &self.system - } - - fn files(&self) -> &Files { - &self.files - } - } - - impl Upcast for TestDb { - fn upcast(&self) -> &(dyn SourceDb + 'static) { - self - } - fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { - self - } - } - - #[salsa::db] - impl Db for TestDb { - fn is_file_open(&self, file: File) -> bool { - !file.path(self).is_vendored_path() - } - } - - #[salsa::db] - impl salsa::Database for TestDb { - fn salsa_event(&self, event: &dyn Fn() -> salsa::Event) { - let event = event(); - tracing::trace!("event: {event:?}"); - let mut events = self.events.lock().unwrap(); - events.push(event); - } - } -} diff --git a/crates/red_knot_python_semantic/src/lib.rs b/crates/red_knot_python_semantic/src/lib.rs deleted file mode 100644 index f48f4900089f0..0000000000000 --- a/crates/red_knot_python_semantic/src/lib.rs +++ /dev/null @@ -1,26 +0,0 @@ -use std::hash::BuildHasherDefault; - -use rustc_hash::FxHasher; - -pub use db::Db; -pub use module_name::ModuleName; -pub use module_resolver::{resolve_module, system_module_search_paths, Module}; -pub use program::{Program, ProgramSettings, SearchPathSettings, SitePackages}; -pub use python_version::PythonVersion; -pub use semantic_model::{HasTy, SemanticModel}; - -pub mod ast_node_ref; -mod db; -mod module_name; -mod module_resolver; -mod node_key; -mod program; -mod python_version; -pub mod semantic_index; -mod semantic_model; -pub(crate) mod site_packages; -mod stdlib; -pub mod types; -mod util; - -type FxOrderSet = ordermap::set::OrderSet>; diff --git a/crates/red_knot_python_semantic/src/module_name.rs b/crates/red_knot_python_semantic/src/module_name.rs deleted file mode 100644 index 885c6adf9f4bf..0000000000000 --- a/crates/red_knot_python_semantic/src/module_name.rs +++ /dev/null @@ -1,216 +0,0 @@ -use std::fmt; -use std::ops::Deref; - -use compact_str::{CompactString, ToCompactString}; - -use ruff_python_stdlib::identifiers::is_identifier; - -/// A module name, e.g. `foo.bar`. -/// -/// Always normalized to the absolute form (never a relative module name, i.e., never `.foo`). -#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)] -pub struct ModuleName(compact_str::CompactString); - -impl ModuleName { - /// Creates a new module name for `name`. Returns `Some` if `name` is a valid, absolute - /// module name and `None` otherwise. - /// - /// The module name is invalid if: - /// - /// * The name is empty - /// * The name is relative - /// * The name ends with a `.` - /// * The name contains a sequence of multiple dots - /// * A component of a name (the part between two dots) isn't a valid python identifier. - #[inline] - #[must_use] - pub fn new(name: &str) -> Option { - Self::is_valid_name(name).then(|| Self(CompactString::from(name))) - } - - /// Creates a new module name for `name` where `name` is a static string. - /// Returns `Some` if `name` is a valid, absolute module name and `None` otherwise. - /// - /// The module name is invalid if: - /// - /// * The name is empty - /// * The name is relative - /// * The name ends with a `.` - /// * The name contains a sequence of multiple dots - /// * A component of a name (the part between two dots) isn't a valid python identifier. - /// - /// ## Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// assert_eq!(ModuleName::new_static("foo.bar").as_deref(), Some("foo.bar")); - /// assert_eq!(ModuleName::new_static(""), None); - /// assert_eq!(ModuleName::new_static("..foo"), None); - /// assert_eq!(ModuleName::new_static(".foo"), None); - /// assert_eq!(ModuleName::new_static("foo."), None); - /// assert_eq!(ModuleName::new_static("foo..bar"), None); - /// assert_eq!(ModuleName::new_static("2000"), None); - /// ``` - #[inline] - #[must_use] - pub fn new_static(name: &'static str) -> Option { - Self::is_valid_name(name).then(|| Self(CompactString::const_new(name))) - } - - #[must_use] - fn is_valid_name(name: &str) -> bool { - !name.is_empty() && name.split('.').all(is_identifier) - } - - /// An iterator over the components of the module name: - /// - /// # Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// assert_eq!(ModuleName::new_static("foo.bar.baz").unwrap().components().collect::>(), vec!["foo", "bar", "baz"]); - /// ``` - #[must_use] - pub fn components(&self) -> impl DoubleEndedIterator { - self.0.split('.') - } - - /// The name of this module's immediate parent, if it has a parent. - /// - /// # Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// assert_eq!(ModuleName::new_static("foo.bar").unwrap().parent(), Some(ModuleName::new_static("foo").unwrap())); - /// assert_eq!(ModuleName::new_static("foo.bar.baz").unwrap().parent(), Some(ModuleName::new_static("foo.bar").unwrap())); - /// assert_eq!(ModuleName::new_static("root").unwrap().parent(), None); - /// ``` - #[must_use] - pub fn parent(&self) -> Option { - let (parent, _) = self.0.rsplit_once('.')?; - Some(Self(parent.to_compact_string())) - } - - /// Returns `true` if the name starts with `other`. - /// - /// This is equivalent to checking if `self` is a sub-module of `other`. - /// - /// # Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// assert!(ModuleName::new_static("foo.bar").unwrap().starts_with(&ModuleName::new_static("foo").unwrap())); - /// - /// assert!(!ModuleName::new_static("foo.bar").unwrap().starts_with(&ModuleName::new_static("bar").unwrap())); - /// assert!(!ModuleName::new_static("foo_bar").unwrap().starts_with(&ModuleName::new_static("foo").unwrap())); - /// ``` - #[must_use] - pub fn starts_with(&self, other: &ModuleName) -> bool { - let mut self_components = self.components(); - let other_components = other.components(); - - for other_component in other_components { - if self_components.next() != Some(other_component) { - return false; - } - } - - true - } - - #[must_use] - #[inline] - pub fn as_str(&self) -> &str { - &self.0 - } - - /// Construct a [`ModuleName`] from a sequence of parts. - /// - /// # Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// assert_eq!(&*ModuleName::from_components(["a"]).unwrap(), "a"); - /// assert_eq!(&*ModuleName::from_components(["a", "b"]).unwrap(), "a.b"); - /// assert_eq!(&*ModuleName::from_components(["a", "b", "c"]).unwrap(), "a.b.c"); - /// - /// assert_eq!(ModuleName::from_components(["a-b"]), None); - /// assert_eq!(ModuleName::from_components(["a", "a-b"]), None); - /// assert_eq!(ModuleName::from_components(["a", "b", "a-b-c"]), None); - /// ``` - #[must_use] - pub fn from_components<'a>(components: impl IntoIterator) -> Option { - let mut components = components.into_iter(); - let first_part = components.next()?; - if !is_identifier(first_part) { - return None; - } - let name = if let Some(second_part) = components.next() { - if !is_identifier(second_part) { - return None; - } - let mut name = format!("{first_part}.{second_part}"); - for part in components { - if !is_identifier(part) { - return None; - } - name.push('.'); - name.push_str(part); - } - CompactString::from(&name) - } else { - CompactString::from(first_part) - }; - Some(Self(name)) - } - - /// Extend `self` with the components of `other` - /// - /// # Examples - /// - /// ``` - /// use red_knot_python_semantic::ModuleName; - /// - /// let mut module_name = ModuleName::new_static("foo").unwrap(); - /// module_name.extend(&ModuleName::new_static("bar").unwrap()); - /// assert_eq!(&module_name, "foo.bar"); - /// module_name.extend(&ModuleName::new_static("baz.eggs.ham").unwrap()); - /// assert_eq!(&module_name, "foo.bar.baz.eggs.ham"); - /// ``` - pub fn extend(&mut self, other: &ModuleName) { - self.0.push('.'); - self.0.push_str(other); - } -} - -impl Deref for ModuleName { - type Target = str; - - #[inline] - fn deref(&self) -> &Self::Target { - self.as_str() - } -} - -impl PartialEq for ModuleName { - fn eq(&self, other: &str) -> bool { - self.as_str() == other - } -} - -impl PartialEq for str { - fn eq(&self, other: &ModuleName) -> bool { - self == other.as_str() - } -} - -impl std::fmt::Display for ModuleName { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str(&self.0) - } -} diff --git a/crates/red_knot_python_semantic/src/module_resolver/mod.rs b/crates/red_knot_python_semantic/src/module_resolver/mod.rs deleted file mode 100644 index c17925606ff29..0000000000000 --- a/crates/red_knot_python_semantic/src/module_resolver/mod.rs +++ /dev/null @@ -1,45 +0,0 @@ -use std::iter::FusedIterator; - -pub use module::Module; -pub use resolver::resolve_module; -pub(crate) use resolver::{file_to_module, SearchPaths}; -use ruff_db::system::SystemPath; - -use crate::module_resolver::resolver::search_paths; -use crate::Db; -use resolver::SearchPathIterator; - -mod module; -mod path; -mod resolver; -mod typeshed; - -#[cfg(test)] -mod testing; - -/// Returns an iterator over all search paths pointing to a system path -pub fn system_module_search_paths(db: &dyn Db) -> SystemModuleSearchPathsIter { - SystemModuleSearchPathsIter { - inner: search_paths(db), - } -} - -pub struct SystemModuleSearchPathsIter<'db> { - inner: SearchPathIterator<'db>, -} - -impl<'db> Iterator for SystemModuleSearchPathsIter<'db> { - type Item = &'db SystemPath; - - fn next(&mut self) -> Option { - loop { - let next = self.inner.next()?; - - if let Some(system_path) = next.as_system_path() { - return Some(system_path); - } - } - } -} - -impl FusedIterator for SystemModuleSearchPathsIter<'_> {} diff --git a/crates/red_knot_python_semantic/src/module_resolver/module.rs b/crates/red_knot_python_semantic/src/module_resolver/module.rs deleted file mode 100644 index e2c1e939572cc..0000000000000 --- a/crates/red_knot_python_semantic/src/module_resolver/module.rs +++ /dev/null @@ -1,85 +0,0 @@ -use std::fmt::Formatter; -use std::sync::Arc; - -use ruff_db::files::File; - -use super::path::SearchPath; -use crate::module_name::ModuleName; - -/// Representation of a Python module. -#[derive(Clone, PartialEq, Eq)] -pub struct Module { - inner: Arc, -} - -impl Module { - pub(crate) fn new( - name: ModuleName, - kind: ModuleKind, - search_path: SearchPath, - file: File, - ) -> Self { - Self { - inner: Arc::new(ModuleInner { - name, - kind, - search_path, - file, - }), - } - } - - /// The absolute name of the module (e.g. `foo.bar`) - pub fn name(&self) -> &ModuleName { - &self.inner.name - } - - /// The file to the source code that defines this module - pub fn file(&self) -> File { - self.inner.file - } - - /// The search path from which the module was resolved. - pub(crate) fn search_path(&self) -> &SearchPath { - &self.inner.search_path - } - - /// Determine whether this module is a single-file module or a package - pub fn kind(&self) -> ModuleKind { - self.inner.kind - } -} - -impl std::fmt::Debug for Module { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - f.debug_struct("Module") - .field("name", &self.name()) - .field("kind", &self.kind()) - .field("file", &self.file()) - .field("search_path", &self.search_path()) - .finish() - } -} - -#[derive(PartialEq, Eq)] -struct ModuleInner { - name: ModuleName, - kind: ModuleKind, - search_path: SearchPath, - file: File, -} - -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -pub enum ModuleKind { - /// A single-file module (e.g. `foo.py` or `foo.pyi`) - Module, - - /// A python package (`foo/__init__.py` or `foo/__init__.pyi`) - Package, -} - -impl ModuleKind { - pub const fn is_package(self) -> bool { - matches!(self, ModuleKind::Package) - } -} diff --git a/crates/red_knot_python_semantic/src/module_resolver/resolver.rs b/crates/red_knot_python_semantic/src/module_resolver/resolver.rs deleted file mode 100644 index 808dbab0fafdd..0000000000000 --- a/crates/red_knot_python_semantic/src/module_resolver/resolver.rs +++ /dev/null @@ -1,1829 +0,0 @@ -use std::borrow::Cow; -use std::iter::FusedIterator; - -use rustc_hash::{FxBuildHasher, FxHashSet}; - -use ruff_db::files::{File, FilePath, FileRootKind}; -use ruff_db::system::{DirectoryEntry, System, SystemPath, SystemPathBuf}; -use ruff_db::vendored::{VendoredFileSystem, VendoredPath}; - -use crate::db::Db; -use crate::module_name::ModuleName; -use crate::module_resolver::typeshed::{vendored_typeshed_versions, TypeshedVersions}; -use crate::site_packages::VirtualEnvironment; -use crate::{Program, PythonVersion, SearchPathSettings, SitePackages}; - -use super::module::{Module, ModuleKind}; -use super::path::{ModulePath, SearchPath, SearchPathValidationError}; - -/// Resolves a module name to a module. -pub fn resolve_module(db: &dyn Db, module_name: &ModuleName) -> Option { - let interned_name = ModuleNameIngredient::new(db, module_name); - - resolve_module_query(db, interned_name) -} - -/// Salsa query that resolves an interned [`ModuleNameIngredient`] to a module. -/// -/// This query should not be called directly. Instead, use [`resolve_module`]. It only exists -/// because Salsa requires the module name to be an ingredient. -#[salsa::tracked] -pub(crate) fn resolve_module_query<'db>( - db: &'db dyn Db, - module_name: ModuleNameIngredient<'db>, -) -> Option { - let name = module_name.name(db); - let _span = tracing::trace_span!("resolve_module", %name).entered(); - - let Some((search_path, module_file, kind)) = resolve_name(db, name) else { - tracing::debug!("Module `{name}` not found in search paths"); - return None; - }; - - let module = Module::new(name.clone(), kind, search_path, module_file); - - tracing::trace!( - "Resolved module `{name}` to `{path}`", - path = module_file.path(db) - ); - - Some(module) -} - -/// Resolves the module for the given path. -/// -/// Returns `None` if the path is not a module locatable via any of the known search paths. -#[allow(unused)] -pub(crate) fn path_to_module(db: &dyn Db, path: &FilePath) -> Option { - // It's not entirely clear on first sight why this method calls `file_to_module` instead of - // it being the other way round, considering that the first thing that `file_to_module` does - // is to retrieve the file's path. - // - // The reason is that `file_to_module` is a tracked Salsa query and salsa queries require that - // all arguments are Salsa ingredients (something stored in Salsa). `Path`s aren't salsa ingredients but - // `VfsFile` is. So what we do here is to retrieve the `path`'s `VfsFile` so that we can make - // use of Salsa's caching and invalidation. - let file = path.to_file(db.upcast())?; - file_to_module(db, file) -} - -#[derive(Debug, Clone, Copy)] -enum SystemOrVendoredPathRef<'a> { - System(&'a SystemPath), - Vendored(&'a VendoredPath), -} - -/// Resolves the module for the file with the given id. -/// -/// Returns `None` if the file is not a module locatable via any of the known search paths. -#[salsa::tracked] -pub(crate) fn file_to_module(db: &dyn Db, file: File) -> Option { - let _span = tracing::trace_span!("file_to_module", ?file).entered(); - - let path = match file.path(db.upcast()) { - FilePath::System(system) => SystemOrVendoredPathRef::System(system), - FilePath::Vendored(vendored) => SystemOrVendoredPathRef::Vendored(vendored), - FilePath::SystemVirtual(_) => return None, - }; - - let mut search_paths = search_paths(db); - - let module_name = loop { - let candidate = search_paths.next()?; - let relative_path = match path { - SystemOrVendoredPathRef::System(path) => candidate.relativize_system_path(path), - SystemOrVendoredPathRef::Vendored(path) => candidate.relativize_vendored_path(path), - }; - if let Some(relative_path) = relative_path { - break relative_path.to_module_name()?; - } - }; - - // Resolve the module name to see if Python would resolve the name to the same path. - // If it doesn't, then that means that multiple modules have the same name in different - // root paths, but that the module corresponding to `path` is in a lower priority search path, - // in which case we ignore it. - let module = resolve_module(db, &module_name)?; - - if file == module.file() { - Some(module) - } else { - // This path is for a module with the same name but with a different precedence. For example: - // ``` - // src/foo.py - // src/foo/__init__.py - // ``` - // The module name of `src/foo.py` is `foo`, but the module loaded by Python is `src/foo/__init__.py`. - // That means we need to ignore `src/foo.py` even though it resolves to the same module name. - None - } -} - -pub(crate) fn search_paths(db: &dyn Db) -> SearchPathIterator { - Program::get(db).search_paths(db).iter(db) -} - -#[derive(Debug, PartialEq, Eq)] -pub(crate) struct SearchPaths { - /// Search paths that have been statically determined purely from reading Ruff's configuration settings. - /// These shouldn't ever change unless the config settings themselves change. - static_paths: Vec, - - /// site-packages paths are not included in the above field: - /// if there are multiple site-packages paths, editable installations can appear - /// *between* the site-packages paths on `sys.path` at runtime. - /// That means we can't know where a second or third `site-packages` path should sit - /// in terms of module-resolution priority until we've discovered the editable installs - /// for the first `site-packages` path - site_packages: Vec, - - typeshed_versions: TypeshedVersions, -} - -impl SearchPaths { - /// Validate and normalize the raw settings given by the user - /// into settings we can use for module resolution - /// - /// This method also implements the typing spec's [module resolution order]. - /// - /// [module resolution order]: https://typing.readthedocs.io/en/latest/spec/distributing.html#import-resolution-ordering - pub(crate) fn from_settings( - db: &dyn Db, - settings: &SearchPathSettings, - ) -> Result { - fn canonicalize(path: &SystemPath, system: &dyn System) -> SystemPathBuf { - system - .canonicalize_path(path) - .unwrap_or_else(|_| path.to_path_buf()) - } - - let SearchPathSettings { - extra_paths, - src_root, - custom_typeshed, - site_packages: site_packages_paths, - } = settings; - - let system = db.system(); - let files = db.files(); - - let mut static_paths = vec![]; - - for path in extra_paths { - let path = canonicalize(path, system); - files.try_add_root(db.upcast(), &path, FileRootKind::LibrarySearchPath); - tracing::debug!("Adding extra search-path '{path}'"); - - static_paths.push(SearchPath::extra(system, path)?); - } - - tracing::debug!("Adding first-party search path '{src_root}'"); - static_paths.push(SearchPath::first_party(system, src_root.to_path_buf())?); - - let (typeshed_versions, stdlib_path) = if let Some(custom_typeshed) = custom_typeshed { - let custom_typeshed = canonicalize(custom_typeshed, system); - tracing::debug!("Adding custom-stdlib search path '{custom_typeshed}'"); - - files.try_add_root( - db.upcast(), - &custom_typeshed, - FileRootKind::LibrarySearchPath, - ); - - let versions_path = custom_typeshed.join("stdlib/VERSIONS"); - - let versions_content = system.read_to_string(&versions_path).map_err(|error| { - SearchPathValidationError::FailedToReadVersionsFile { - path: versions_path, - error, - } - })?; - - let parsed: TypeshedVersions = versions_content.parse()?; - - let search_path = SearchPath::custom_stdlib(db, &custom_typeshed)?; - - (parsed, search_path) - } else { - tracing::debug!("Using vendored stdlib"); - ( - vendored_typeshed_versions(db), - SearchPath::vendored_stdlib(), - ) - }; - - static_paths.push(stdlib_path); - - let site_packages_paths = match site_packages_paths { - SitePackages::Derived { venv_path } => VirtualEnvironment::new(venv_path, system) - .and_then(|venv| venv.site_packages_directories(system))?, - SitePackages::Known(paths) => paths - .iter() - .map(|path| canonicalize(path, system)) - .collect(), - }; - - let mut site_packages: Vec<_> = Vec::with_capacity(site_packages_paths.len()); - - for path in site_packages_paths { - tracing::debug!("Adding site-packages search path '{path}'"); - files.try_add_root(db.upcast(), &path, FileRootKind::LibrarySearchPath); - site_packages.push(SearchPath::site_packages(system, path)?); - } - - // TODO vendor typeshed's third-party stubs as well as the stdlib and fallback to them as a final step - - // Filter out module resolution paths that point to the same directory on disk (the same invariant maintained by [`sys.path` at runtime]). - // (Paths may, however, *overlap* -- e.g. you could have both `src/` and `src/foo` - // as module resolution paths simultaneously.) - // - // This code doesn't use an `IndexSet` because the key is the system path and not the search root. - // - // [`sys.path` at runtime]: https://docs.python.org/3/library/site.html#module-site - let mut seen_paths = FxHashSet::with_capacity_and_hasher(static_paths.len(), FxBuildHasher); - - static_paths.retain(|path| { - if let Some(path) = path.as_system_path() { - seen_paths.insert(path.to_path_buf()) - } else { - true - } - }); - - Ok(SearchPaths { - static_paths, - site_packages, - typeshed_versions, - }) - } - - pub(super) fn iter<'a>(&'a self, db: &'a dyn Db) -> SearchPathIterator<'a> { - SearchPathIterator { - db, - static_paths: self.static_paths.iter(), - dynamic_paths: None, - } - } - - pub(crate) fn custom_stdlib(&self) -> Option<&SystemPath> { - self.static_paths.iter().find_map(|search_path| { - if search_path.is_standard_library() { - search_path.as_system_path() - } else { - None - } - }) - } - - pub(super) fn typeshed_versions(&self) -> &TypeshedVersions { - &self.typeshed_versions - } -} - -/// Collect all dynamic search paths. For each `site-packages` path: -/// - Collect that `site-packages` path -/// - Collect any search paths listed in `.pth` files in that `site-packages` directory -/// due to editable installations of third-party packages. -/// -/// The editable-install search paths for the first `site-packages` directory -/// should come between the two `site-packages` directories when it comes to -/// module-resolution priority. -#[salsa::tracked(return_ref)] -pub(crate) fn dynamic_resolution_paths(db: &dyn Db) -> Vec { - tracing::debug!("Resolving dynamic module resolution paths"); - - let SearchPaths { - static_paths, - site_packages, - typeshed_versions: _, - } = Program::get(db).search_paths(db); - - let mut dynamic_paths = Vec::new(); - - if site_packages.is_empty() { - return dynamic_paths; - } - - let mut existing_paths: FxHashSet<_> = static_paths - .iter() - .filter_map(|path| path.as_system_path()) - .map(Cow::Borrowed) - .collect(); - - let files = db.files(); - let system = db.system(); - - for site_packages_search_path in site_packages { - let site_packages_dir = site_packages_search_path - .as_system_path() - .expect("Expected site package path to be a system path"); - - if !existing_paths.insert(Cow::Borrowed(site_packages_dir)) { - continue; - } - - let site_packages_root = files - .root(db.upcast(), site_packages_dir) - .expect("Site-package root to have been created"); - - // This query needs to be re-executed each time a `.pth` file - // is added, modified or removed from the `site-packages` directory. - // However, we don't use Salsa queries to read the source text of `.pth` files; - // we use the APIs on the `System` trait directly. As such, add a dependency on the - // site-package directory's revision. - site_packages_root.revision(db.upcast()); - - dynamic_paths.push(site_packages_search_path.clone()); - - // As well as modules installed directly into `site-packages`, - // the directory may also contain `.pth` files. - // Each `.pth` file in `site-packages` may contain one or more lines - // containing a (relative or absolute) path. - // Each of these paths may point to an editable install of a package, - // so should be considered an additional search path. - let pth_file_iterator = match PthFileIterator::new(db, site_packages_dir) { - Ok(iterator) => iterator, - Err(error) => { - tracing::warn!( - "Failed to search for editable installation in {site_packages_dir}: {error}" - ); - continue; - } - }; - - // The Python documentation specifies that `.pth` files in `site-packages` - // are processed in alphabetical order, so collecting and then sorting is necessary. - // https://docs.python.org/3/library/site.html#module-site - let mut all_pth_files: Vec = pth_file_iterator.collect(); - all_pth_files.sort_unstable_by(|a, b| a.path.cmp(&b.path)); - - let installations = all_pth_files.iter().flat_map(PthFile::items); - - for installation in installations { - let installation = system - .canonicalize_path(&installation) - .unwrap_or(installation); - - if existing_paths.insert(Cow::Owned(installation.clone())) { - match SearchPath::editable(system, installation.clone()) { - Ok(search_path) => { - tracing::debug!( - "Adding editable installation to module resolution path {path}", - path = installation - ); - dynamic_paths.push(search_path); - } - - Err(error) => { - tracing::debug!("Skipping editable installation: {error}"); - } - } - } - } - } - - dynamic_paths -} - -/// Iterate over the available module-resolution search paths, -/// following the invariants maintained by [`sys.path` at runtime]: -/// "No item is added to `sys.path` more than once." -/// Dynamic search paths (required for editable installs into `site-packages`) -/// are only calculated lazily. -/// -/// [`sys.path` at runtime]: https://docs.python.org/3/library/site.html#module-site -pub(crate) struct SearchPathIterator<'db> { - db: &'db dyn Db, - static_paths: std::slice::Iter<'db, SearchPath>, - dynamic_paths: Option>, -} - -impl<'db> Iterator for SearchPathIterator<'db> { - type Item = &'db SearchPath; - - fn next(&mut self) -> Option { - let SearchPathIterator { - db, - static_paths, - dynamic_paths, - } = self; - - static_paths.next().or_else(|| { - dynamic_paths - .get_or_insert_with(|| dynamic_resolution_paths(*db).iter()) - .next() - }) - } -} - -impl<'db> FusedIterator for SearchPathIterator<'db> {} - -/// Represents a single `.pth` file in a `site-packages` directory. -/// One or more lines in a `.pth` file may be a (relative or absolute) -/// path that represents an editable installation of a package. -struct PthFile<'db> { - path: SystemPathBuf, - contents: String, - site_packages: &'db SystemPath, -} - -impl<'db> PthFile<'db> { - /// Yield paths in this `.pth` file that appear to represent editable installations, - /// and should therefore be added as module-resolution search paths. - fn items(&'db self) -> impl Iterator + 'db { - let PthFile { - path: _, - contents, - site_packages, - } = self; - - // Empty lines or lines starting with '#' are ignored by the Python interpreter. - // Lines that start with "import " or "import\t" do not represent editable installs at all; - // instead, these are lines that are executed by Python at startup. - // https://docs.python.org/3/library/site.html#module-site - contents.lines().filter_map(move |line| { - let line = line.trim_end(); - if line.is_empty() - || line.starts_with('#') - || line.starts_with("import ") - || line.starts_with("import\t") - { - return None; - } - - Some(SystemPath::absolute(line, site_packages)) - }) - } -} - -/// Iterator that yields a [`PthFile`] instance for every `.pth` file -/// found in a given `site-packages` directory. -struct PthFileIterator<'db> { - db: &'db dyn Db, - directory_iterator: Box> + 'db>, - site_packages: &'db SystemPath, -} - -impl<'db> PthFileIterator<'db> { - fn new(db: &'db dyn Db, site_packages: &'db SystemPath) -> std::io::Result { - Ok(Self { - db, - directory_iterator: db.system().read_directory(site_packages)?, - site_packages, - }) - } -} - -impl<'db> Iterator for PthFileIterator<'db> { - type Item = PthFile<'db>; - - fn next(&mut self) -> Option { - let PthFileIterator { - db, - directory_iterator, - site_packages, - } = self; - - let system = db.system(); - - loop { - let entry_result = directory_iterator.next()?; - let Ok(entry) = entry_result else { - continue; - }; - let file_type = entry.file_type(); - if file_type.is_directory() { - continue; - } - let path = entry.into_path(); - if path.extension() != Some("pth") { - continue; - } - - let contents = match system.read_to_string(&path) { - Ok(contents) => contents, - Err(error) => { - tracing::warn!("Failed to read .pth file '{path}': {error}"); - continue; - } - }; - - return Some(PthFile { - path, - contents, - site_packages, - }); - } - } -} - -/// A thin wrapper around `ModuleName` to make it a Salsa ingredient. -/// -/// This is needed because Salsa requires that all query arguments are salsa ingredients. -#[salsa::interned] -struct ModuleNameIngredient<'db> { - #[return_ref] - pub(super) name: ModuleName, -} - -/// Given a module name and a list of search paths in which to lookup modules, -/// attempt to resolve the module name -fn resolve_name(db: &dyn Db, name: &ModuleName) -> Option<(SearchPath, File, ModuleKind)> { - let program = Program::get(db); - let target_version = program.target_version(db); - let resolver_state = ResolverContext::new(db, target_version); - let is_builtin_module = - ruff_python_stdlib::sys::is_builtin_module(target_version.minor, name.as_str()); - - for search_path in search_paths(db) { - // When a builtin module is imported, standard module resolution is bypassed: - // the module name always resolves to the stdlib module, - // even if there's a module of the same name in the first-party root - // (which would normally result in the stdlib module being overridden). - if is_builtin_module && !search_path.is_standard_library() { - continue; - } - - let mut components = name.components(); - let module_name = components.next_back()?; - - match resolve_package(search_path, components, &resolver_state) { - Ok(resolved_package) => { - let mut package_path = resolved_package.path; - - package_path.push(module_name); - - // Check for a regular package first (highest priority) - package_path.push("__init__"); - if let Some(regular_package) = resolve_file_module(&package_path, &resolver_state) { - return Some((search_path.clone(), regular_package, ModuleKind::Package)); - } - - // Check for a file module next - package_path.pop(); - if let Some(file_module) = resolve_file_module(&package_path, &resolver_state) { - return Some((search_path.clone(), file_module, ModuleKind::Module)); - } - - // For regular packages, don't search the next search path. All files of that - // package must be in the same location - if resolved_package.kind.is_regular_package() { - return None; - } - } - Err(parent_kind) => { - if parent_kind.is_regular_package() { - // For regular packages, don't search the next search path. - return None; - } - } - } - } - - None -} - -/// If `module` exists on disk with either a `.pyi` or `.py` extension, -/// return the [`File`] corresponding to that path. -/// -/// `.pyi` files take priority, as they always have priority when -/// resolving modules. -fn resolve_file_module(module: &ModulePath, resolver_state: &ResolverContext) -> Option { - // Stubs have precedence over source files - module - .with_pyi_extension() - .to_file(resolver_state) - .or_else(|| { - module - .with_py_extension() - .and_then(|path| path.to_file(resolver_state)) - }) -} - -fn resolve_package<'a, 'db, I>( - module_search_path: &SearchPath, - components: I, - resolver_state: &ResolverContext<'db>, -) -> Result -where - I: Iterator, -{ - let mut package_path = module_search_path.to_module_path(); - - // `true` if inside a folder that is a namespace package (has no `__init__.py`). - // Namespace packages are special because they can be spread across multiple search paths. - // https://peps.python.org/pep-0420/ - let mut in_namespace_package = false; - - // `true` if resolving a sub-package. For example, `true` when resolving `bar` of `foo.bar`. - let mut in_sub_package = false; - - // For `foo.bar.baz`, test that `foo` and `baz` both contain a `__init__.py`. - for folder in components { - package_path.push(folder); - - let is_regular_package = package_path.is_regular_package(resolver_state); - - if is_regular_package { - in_namespace_package = false; - } else if package_path.is_directory(resolver_state) - // Pure modules hide namespace packages with the same name - && resolve_file_module(&package_path, resolver_state).is_none() - { - // A directory without an `__init__.py` is a namespace package, continue with the next folder. - in_namespace_package = true; - } else if in_namespace_package { - // Package not found but it is part of a namespace package. - return Err(PackageKind::Namespace); - } else if in_sub_package { - // A regular sub package wasn't found. - return Err(PackageKind::Regular); - } else { - // We couldn't find `foo` for `foo.bar.baz`, search the next search path. - return Err(PackageKind::Root); - } - - in_sub_package = true; - } - - let kind = if in_namespace_package { - PackageKind::Namespace - } else if in_sub_package { - PackageKind::Regular - } else { - PackageKind::Root - }; - - Ok(ResolvedPackage { - kind, - path: package_path, - }) -} - -#[derive(Debug)] -struct ResolvedPackage { - path: ModulePath, - kind: PackageKind, -} - -#[derive(Copy, Clone, Eq, PartialEq, Debug)] -enum PackageKind { - /// A root package or module. E.g. `foo` in `foo.bar.baz` or just `foo`. - Root, - - /// A regular sub-package where the parent contains an `__init__.py`. - /// - /// For example, `bar` in `foo.bar` when the `foo` directory contains an `__init__.py`. - Regular, - - /// A sub-package in a namespace package. A namespace package is a package without an `__init__.py`. - /// - /// For example, `bar` in `foo.bar` if the `foo` directory contains no `__init__.py`. - Namespace, -} - -impl PackageKind { - const fn is_regular_package(self) -> bool { - matches!(self, PackageKind::Regular) - } -} - -pub(super) struct ResolverContext<'db> { - pub(super) db: &'db dyn Db, - pub(super) target_version: PythonVersion, -} - -impl<'db> ResolverContext<'db> { - pub(super) fn new(db: &'db dyn Db, target_version: PythonVersion) -> Self { - Self { db, target_version } - } - - pub(super) fn vendored(&self) -> &VendoredFileSystem { - self.db.vendored() - } -} - -#[cfg(test)] -mod tests { - use ruff_db::files::{system_path_to_file, File, FilePath}; - use ruff_db::system::DbWithTestSystem; - use ruff_db::testing::{ - assert_const_function_query_was_not_run, assert_function_query_was_not_run, - }; - use ruff_db::Db; - - use crate::db::tests::TestDb; - use crate::module_name::ModuleName; - use crate::module_resolver::module::ModuleKind; - use crate::module_resolver::testing::{FileSpec, MockedTypeshed, TestCase, TestCaseBuilder}; - use crate::ProgramSettings; - use crate::PythonVersion; - - use super::*; - - #[test] - fn first_party_module() { - let TestCase { db, src, .. } = TestCaseBuilder::new() - .with_src_files(&[("foo.py", "print('Hello, world!')")]) - .build(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - - assert_eq!( - Some(&foo_module), - resolve_module(&db, &foo_module_name).as_ref() - ); - - assert_eq!("foo", foo_module.name()); - assert_eq!(&src, foo_module.search_path()); - assert_eq!(ModuleKind::Module, foo_module.kind()); - - let expected_foo_path = src.join("foo.py"); - assert_eq!(&expected_foo_path, foo_module.file().path(&db)); - assert_eq!( - Some(foo_module), - path_to_module(&db, &FilePath::System(expected_foo_path)) - ); - } - - #[test] - fn builtins_vendored() { - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_vendored_typeshed() - .with_src_files(&[("builtins.py", "FOOOO = 42")]) - .build(); - - let builtins_module_name = ModuleName::new_static("builtins").unwrap(); - let builtins = resolve_module(&db, &builtins_module_name).expect("builtins to resolve"); - - assert_eq!(builtins.file().path(&db), &stdlib.join("builtins.pyi")); - } - - #[test] - fn builtins_custom() { - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: &[("builtins.pyi", "def min(a, b): ...")], - versions: "builtins: 3.8-", - }; - - const SRC: &[FileSpec] = &[("builtins.py", "FOOOO = 42")]; - - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_src_files(SRC) - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let builtins_module_name = ModuleName::new_static("builtins").unwrap(); - let builtins = resolve_module(&db, &builtins_module_name).expect("builtins to resolve"); - - assert_eq!(builtins.file().path(&db), &stdlib.join("builtins.pyi")); - } - - #[test] - fn stdlib() { - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], - versions: "functools: 3.8-", - }; - - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let functools_module_name = ModuleName::new_static("functools").unwrap(); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - - assert_eq!( - Some(&functools_module), - resolve_module(&db, &functools_module_name).as_ref() - ); - - assert_eq!(&stdlib, functools_module.search_path()); - assert_eq!(ModuleKind::Module, functools_module.kind()); - - let expected_functools_path = stdlib.join("functools.pyi"); - assert_eq!(&expected_functools_path, functools_module.file().path(&db)); - - assert_eq!( - Some(functools_module), - path_to_module(&db, &FilePath::System(expected_functools_path)) - ); - } - - fn create_module_names(raw_names: &[&str]) -> Vec { - raw_names - .iter() - .map(|raw| ModuleName::new(raw).unwrap()) - .collect() - } - - #[test] - fn stdlib_resolution_respects_versions_file_py38_existing_modules() { - const VERSIONS: &str = "\ - asyncio: 3.8- # 'Regular' package on py38+ - asyncio.tasks: 3.9-3.11 # Submodule on py39+ only - functools: 3.8- # Top-level single-file module - xml: 3.8-3.8 # Namespace package on py38 only - "; - - const STDLIB: &[FileSpec] = &[ - ("asyncio/__init__.pyi", ""), - ("asyncio/tasks.pyi", ""), - ("functools.pyi", ""), - ("xml/etree.pyi", ""), - ]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: STDLIB, - versions: VERSIONS, - }; - - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let existing_modules = create_module_names(&["asyncio", "functools", "xml.etree"]); - for module_name in existing_modules { - let resolved_module = resolve_module(&db, &module_name).unwrap_or_else(|| { - panic!("Expected module {module_name} to exist in the mock stdlib") - }); - let search_path = resolved_module.search_path(); - assert_eq!( - &stdlib, search_path, - "Search path for {module_name} was unexpectedly {search_path:?}" - ); - assert!( - search_path.is_standard_library(), - "Expected a stdlib search path, but got {search_path:?}" - ); - } - } - - #[test] - fn stdlib_resolution_respects_versions_file_py38_nonexisting_modules() { - const VERSIONS: &str = "\ - asyncio: 3.8- # 'Regular' package on py38+ - asyncio.tasks: 3.9-3.11 # Submodule on py39+ only - collections: 3.9- # 'Regular' package on py39+ - importlib: 3.9- # Namespace package on py39+ - xml: 3.8-3.8 # Namespace package on 3.8 only - "; - - const STDLIB: &[FileSpec] = &[ - ("collections/__init__.pyi", ""), - ("asyncio/__init__.pyi", ""), - ("asyncio/tasks.pyi", ""), - ("importlib/abc.pyi", ""), - ("xml/etree.pyi", ""), - ]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: STDLIB, - versions: VERSIONS, - }; - - let TestCase { db, .. } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let nonexisting_modules = create_module_names(&[ - "collections", - "importlib", - "importlib.abc", - "xml", - "asyncio.tasks", - ]); - - for module_name in nonexisting_modules { - assert!( - resolve_module(&db, &module_name).is_none(), - "Unexpectedly resolved a module for {module_name}" - ); - } - } - - #[test] - fn stdlib_resolution_respects_versions_file_py39_existing_modules() { - const VERSIONS: &str = "\ - asyncio: 3.8- # 'Regular' package on py38+ - asyncio.tasks: 3.9-3.11 # Submodule on py39+ only - collections: 3.9- # 'Regular' package on py39+ - functools: 3.8- # Top-level single-file module - importlib: 3.9- # Namespace package on py39+ - "; - - const STDLIB: &[FileSpec] = &[ - ("asyncio/__init__.pyi", ""), - ("asyncio/tasks.pyi", ""), - ("collections/__init__.pyi", ""), - ("functools.pyi", ""), - ("importlib/abc.pyi", ""), - ]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: STDLIB, - versions: VERSIONS, - }; - - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY39) - .build(); - - let existing_modules = create_module_names(&[ - "asyncio", - "functools", - "importlib.abc", - "collections", - "asyncio.tasks", - ]); - - for module_name in existing_modules { - let resolved_module = resolve_module(&db, &module_name).unwrap_or_else(|| { - panic!("Expected module {module_name} to exist in the mock stdlib") - }); - let search_path = resolved_module.search_path(); - assert_eq!( - &stdlib, search_path, - "Search path for {module_name} was unexpectedly {search_path:?}" - ); - assert!( - search_path.is_standard_library(), - "Expected a stdlib search path, but got {search_path:?}" - ); - } - } - #[test] - fn stdlib_resolution_respects_versions_file_py39_nonexisting_modules() { - const VERSIONS: &str = "\ - importlib: 3.9- # Namespace package on py39+ - xml: 3.8-3.8 # Namespace package on 3.8 only - "; - - const STDLIB: &[FileSpec] = &[("importlib/abc.pyi", ""), ("xml/etree.pyi", "")]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: STDLIB, - versions: VERSIONS, - }; - - let TestCase { db, .. } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY39) - .build(); - - let nonexisting_modules = create_module_names(&["importlib", "xml", "xml.etree"]); - for module_name in nonexisting_modules { - assert!( - resolve_module(&db, &module_name).is_none(), - "Unexpectedly resolved a module for {module_name}" - ); - } - } - - #[test] - fn first_party_precedence_over_stdlib() { - const SRC: &[FileSpec] = &[("functools.py", "def update_wrapper(): ...")]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], - versions: "functools: 3.8-", - }; - - let TestCase { db, src, .. } = TestCaseBuilder::new() - .with_src_files(SRC) - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let functools_module_name = ModuleName::new_static("functools").unwrap(); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - - assert_eq!( - Some(&functools_module), - resolve_module(&db, &functools_module_name).as_ref() - ); - assert_eq!(&src, functools_module.search_path()); - assert_eq!(ModuleKind::Module, functools_module.kind()); - assert_eq!(&src.join("functools.py"), functools_module.file().path(&db)); - - assert_eq!( - Some(functools_module), - path_to_module(&db, &FilePath::System(src.join("functools.py"))) - ); - } - - #[test] - fn stdlib_uses_vendored_typeshed_when_no_custom_typeshed_supplied() { - let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_vendored_typeshed() - .with_target_version(PythonVersion::default()) - .build(); - - let pydoc_data_topics_name = ModuleName::new_static("pydoc_data.topics").unwrap(); - let pydoc_data_topics = resolve_module(&db, &pydoc_data_topics_name).unwrap(); - - assert_eq!("pydoc_data.topics", pydoc_data_topics.name()); - assert_eq!(pydoc_data_topics.search_path(), &stdlib); - assert_eq!( - pydoc_data_topics.file().path(&db), - &stdlib.join("pydoc_data/topics.pyi") - ); - } - - #[test] - fn resolve_package() { - let TestCase { src, db, .. } = TestCaseBuilder::new() - .with_src_files(&[("foo/__init__.py", "print('Hello, world!'")]) - .build(); - - let foo_path = src.join("foo/__init__.py"); - let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); - - assert_eq!("foo", foo_module.name()); - assert_eq!(&src, foo_module.search_path()); - assert_eq!(&foo_path, foo_module.file().path(&db)); - - assert_eq!( - Some(&foo_module), - path_to_module(&db, &FilePath::System(foo_path)).as_ref() - ); - - // Resolving by directory doesn't resolve to the init file. - assert_eq!( - None, - path_to_module(&db, &FilePath::System(src.join("foo"))) - ); - } - - #[test] - fn package_priority_over_module() { - const SRC: &[FileSpec] = &[ - ("foo/__init__.py", "print('Hello, world!')"), - ("foo.py", "print('Hello, world!')"), - ]; - - let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); - - let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); - let foo_init_path = src.join("foo/__init__.py"); - - assert_eq!(&src, foo_module.search_path()); - assert_eq!(&foo_init_path, foo_module.file().path(&db)); - assert_eq!(ModuleKind::Package, foo_module.kind()); - - assert_eq!( - Some(foo_module), - path_to_module(&db, &FilePath::System(foo_init_path)) - ); - assert_eq!( - None, - path_to_module(&db, &FilePath::System(src.join("foo.py"))) - ); - } - - #[test] - fn single_file_takes_priority_over_namespace_package() { - //const SRC: &[FileSpec] = &[("foo.py", "x = 1")]; - const SRC: &[FileSpec] = &[("foo.py", "x = 1"), ("foo/bar.py", "x = 2")]; - - let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_bar_module_name = ModuleName::new_static("foo.bar").unwrap(); - - // `foo.py` takes priority over the `foo` namespace package - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - assert_eq!(foo_module.file().path(&db), &src.join("foo.py")); - - // `foo.bar` isn't recognised as a module - let foo_bar_module = resolve_module(&db, &foo_bar_module_name); - assert_eq!(foo_bar_module, None); - } - - #[test] - fn typing_stub_over_module() { - const SRC: &[FileSpec] = &[("foo.py", "print('Hello, world!')"), ("foo.pyi", "x: int")]; - - let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); - - let foo = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); - let foo_stub = src.join("foo.pyi"); - - assert_eq!(&src, foo.search_path()); - assert_eq!(&foo_stub, foo.file().path(&db)); - - assert_eq!(Some(foo), path_to_module(&db, &FilePath::System(foo_stub))); - assert_eq!( - None, - path_to_module(&db, &FilePath::System(src.join("foo.py"))) - ); - } - - #[test] - fn sub_packages() { - const SRC: &[FileSpec] = &[ - ("foo/__init__.py", ""), - ("foo/bar/__init__.py", ""), - ("foo/bar/baz.py", "print('Hello, world!)'"), - ]; - - let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); - - let baz_module = - resolve_module(&db, &ModuleName::new_static("foo.bar.baz").unwrap()).unwrap(); - let baz_path = src.join("foo/bar/baz.py"); - - assert_eq!(&src, baz_module.search_path()); - assert_eq!(&baz_path, baz_module.file().path(&db)); - - assert_eq!( - Some(baz_module), - path_to_module(&db, &FilePath::System(baz_path)) - ); - } - - #[test] - fn namespace_package() { - // From [PEP420](https://peps.python.org/pep-0420/#nested-namespace-packages). - // But uses `src` for `project1` and `site-packages` for `project2`. - // ``` - // src - // parent - // child - // one.py - // site_packages - // parent - // child - // two.py - // ``` - let TestCase { - db, - src, - site_packages, - .. - } = TestCaseBuilder::new() - .with_src_files(&[("parent/child/one.py", "print('Hello, world!')")]) - .with_site_packages_files(&[("parent/child/two.py", "print('Hello, world!')")]) - .build(); - - let one_module_name = ModuleName::new_static("parent.child.one").unwrap(); - let one_module_path = FilePath::System(src.join("parent/child/one.py")); - assert_eq!( - resolve_module(&db, &one_module_name), - path_to_module(&db, &one_module_path) - ); - - let two_module_name = ModuleName::new_static("parent.child.two").unwrap(); - let two_module_path = FilePath::System(site_packages.join("parent/child/two.py")); - assert_eq!( - resolve_module(&db, &two_module_name), - path_to_module(&db, &two_module_path) - ); - } - - #[test] - fn regular_package_in_namespace_package() { - // Adopted test case from the [PEP420 examples](https://peps.python.org/pep-0420/#nested-namespace-packages). - // The `src/parent/child` package is a regular package. Therefore, `site_packages/parent/child/two.py` should not be resolved. - // ``` - // src - // parent - // child - // one.py - // site_packages - // parent - // child - // two.py - // ``` - const SRC: &[FileSpec] = &[ - ("parent/child/__init__.py", "print('Hello, world!')"), - ("parent/child/one.py", "print('Hello, world!')"), - ]; - - const SITE_PACKAGES: &[FileSpec] = &[("parent/child/two.py", "print('Hello, world!')")]; - - let TestCase { db, src, .. } = TestCaseBuilder::new() - .with_src_files(SRC) - .with_site_packages_files(SITE_PACKAGES) - .build(); - - let one_module_path = FilePath::System(src.join("parent/child/one.py")); - let one_module_name = - resolve_module(&db, &ModuleName::new_static("parent.child.one").unwrap()); - assert_eq!(one_module_name, path_to_module(&db, &one_module_path)); - - assert_eq!( - None, - resolve_module(&db, &ModuleName::new_static("parent.child.two").unwrap()) - ); - } - - #[test] - fn module_search_path_priority() { - let TestCase { - db, - src, - site_packages, - .. - } = TestCaseBuilder::new() - .with_src_files(&[("foo.py", "")]) - .with_site_packages_files(&[("foo.py", "")]) - .build(); - - let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); - let foo_src_path = src.join("foo.py"); - - assert_eq!(&src, foo_module.search_path()); - assert_eq!(&foo_src_path, foo_module.file().path(&db)); - assert_eq!( - Some(foo_module), - path_to_module(&db, &FilePath::System(foo_src_path)) - ); - - assert_eq!( - None, - path_to_module(&db, &FilePath::System(site_packages.join("foo.py"))) - ); - } - - #[test] - #[cfg(target_family = "unix")] - fn symlink() -> anyhow::Result<()> { - use anyhow::Context; - - use crate::program::Program; - use ruff_db::system::{OsSystem, SystemPath}; - - use crate::db::tests::TestDb; - - let mut db = TestDb::new(); - - let temp_dir = tempfile::tempdir()?; - let root = temp_dir - .path() - .canonicalize() - .context("Failed to canonicalize temp dir")?; - let root = SystemPath::from_std_path(&root).unwrap(); - db.use_system(OsSystem::new(root)); - - let src = root.join("src"); - let site_packages = root.join("site-packages"); - let custom_typeshed = root.join("typeshed"); - - let foo = src.join("foo.py"); - let bar = src.join("bar.py"); - - std::fs::create_dir_all(src.as_std_path())?; - std::fs::create_dir_all(site_packages.as_std_path())?; - std::fs::create_dir_all(custom_typeshed.join("stdlib").as_std_path())?; - std::fs::File::create(custom_typeshed.join("stdlib/VERSIONS").as_std_path())?; - - std::fs::write(foo.as_std_path(), "")?; - std::os::unix::fs::symlink(foo.as_std_path(), bar.as_std_path())?; - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::PY38, - search_paths: SearchPathSettings { - extra_paths: vec![], - src_root: src.clone(), - custom_typeshed: Some(custom_typeshed), - site_packages: SitePackages::Known(vec![site_packages]), - }, - }, - ) - .context("Invalid program settings")?; - - let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); - let bar_module = resolve_module(&db, &ModuleName::new_static("bar").unwrap()).unwrap(); - - assert_ne!(foo_module, bar_module); - - assert_eq!(&src, foo_module.search_path()); - assert_eq!(&foo, foo_module.file().path(&db)); - - // `foo` and `bar` shouldn't resolve to the same file - - assert_eq!(&src, bar_module.search_path()); - assert_eq!(&bar, bar_module.file().path(&db)); - assert_eq!(&foo, foo_module.file().path(&db)); - - assert_ne!(&foo_module, &bar_module); - - assert_eq!( - Some(foo_module), - path_to_module(&db, &FilePath::System(foo)) - ); - assert_eq!( - Some(bar_module), - path_to_module(&db, &FilePath::System(bar)) - ); - - Ok(()) - } - - #[test] - fn deleting_an_unrelated_file_doesnt_change_module_resolution() { - let TestCase { mut db, src, .. } = TestCaseBuilder::new() - .with_src_files(&[("foo.py", "x = 1"), ("bar.py", "x = 2")]) - .with_target_version(PythonVersion::PY38) - .build(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - - let bar_path = src.join("bar.py"); - let bar = system_path_to_file(&db, &bar_path).expect("bar.py to exist"); - - db.clear_salsa_events(); - - // Delete `bar.py` - db.memory_file_system().remove_file(&bar_path).unwrap(); - bar.sync(&mut db); - - // Re-query the foo module. The foo module should still be cached because `bar.py` isn't relevant - // for resolving `foo`. - - let foo_module2 = resolve_module(&db, &foo_module_name); - - assert!(!db - .take_salsa_events() - .iter() - .any(|event| { matches!(event.kind, salsa::EventKind::WillExecute { .. }) })); - - assert_eq!(Some(foo_module), foo_module2); - } - - #[test] - fn adding_file_on_which_module_resolution_depends_invalidates_previously_failing_query_that_now_succeeds( - ) -> anyhow::Result<()> { - let TestCase { mut db, src, .. } = TestCaseBuilder::new().build(); - let foo_path = src.join("foo.py"); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - assert_eq!(resolve_module(&db, &foo_module_name), None); - - // Now write the foo file - db.write_file(&foo_path, "x = 1")?; - - let foo_file = system_path_to_file(&db, &foo_path).expect("foo.py to exist"); - - let foo_module = resolve_module(&db, &foo_module_name).expect("Foo module to resolve"); - assert_eq!(foo_file, foo_module.file()); - - Ok(()) - } - - #[test] - fn removing_file_on_which_module_resolution_depends_invalidates_previously_successful_query_that_now_fails( - ) -> anyhow::Result<()> { - const SRC: &[FileSpec] = &[("foo.py", "x = 1"), ("foo/__init__.py", "x = 2")]; - - let TestCase { mut db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).expect("foo module to exist"); - let foo_init_path = src.join("foo/__init__.py"); - - assert_eq!(&foo_init_path, foo_module.file().path(&db)); - - // Delete `foo/__init__.py` and the `foo` folder. `foo` should now resolve to `foo.py` - db.memory_file_system().remove_file(&foo_init_path)?; - db.memory_file_system() - .remove_directory(foo_init_path.parent().unwrap())?; - File::sync_path(&mut db, &foo_init_path); - File::sync_path(&mut db, foo_init_path.parent().unwrap()); - - let foo_module = resolve_module(&db, &foo_module_name).expect("Foo module to resolve"); - assert_eq!(&src.join("foo.py"), foo_module.file().path(&db)); - - Ok(()) - } - - #[test] - fn adding_file_to_search_path_with_lower_priority_does_not_invalidate_query() { - const TYPESHED: MockedTypeshed = MockedTypeshed { - versions: "functools: 3.8-", - stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], - }; - - let TestCase { - mut db, - stdlib, - site_packages, - .. - } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let functools_module_name = ModuleName::new_static("functools").unwrap(); - let stdlib_functools_path = stdlib.join("functools.pyi"); - - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - assert_eq!(functools_module.search_path(), &stdlib); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, &stdlib_functools_path) - ); - - // Adding a file to site-packages does not invalidate the query, - // since site-packages takes lower priority in the module resolution - db.clear_salsa_events(); - let site_packages_functools_path = site_packages.join("functools.py"); - db.write_file(&site_packages_functools_path, "f: int") - .unwrap(); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - let events = db.take_salsa_events(); - assert_function_query_was_not_run( - &db, - resolve_module_query, - ModuleNameIngredient::new(&db, functools_module_name), - &events, - ); - assert_eq!(functools_module.search_path(), &stdlib); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, &stdlib_functools_path) - ); - } - - #[test] - fn adding_file_to_search_path_with_higher_priority_invalidates_the_query() { - const TYPESHED: MockedTypeshed = MockedTypeshed { - versions: "functools: 3.8-", - stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], - }; - - let TestCase { - mut db, - stdlib, - src, - .. - } = TestCaseBuilder::new() - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let functools_module_name = ModuleName::new_static("functools").unwrap(); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - assert_eq!(functools_module.search_path(), &stdlib); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, stdlib.join("functools.pyi")) - ); - - // Adding a first-party file invalidates the query, - // since first-party files take higher priority in module resolution: - let src_functools_path = src.join("functools.py"); - db.write_file(&src_functools_path, "FOO: int").unwrap(); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - assert_eq!(functools_module.search_path(), &src); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, &src_functools_path) - ); - } - - #[test] - fn deleting_file_from_higher_priority_search_path_invalidates_the_query() { - const SRC: &[FileSpec] = &[("functools.py", "FOO: int")]; - - const TYPESHED: MockedTypeshed = MockedTypeshed { - versions: "functools: 3.8-", - stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], - }; - - let TestCase { - mut db, - stdlib, - src, - .. - } = TestCaseBuilder::new() - .with_src_files(SRC) - .with_custom_typeshed(TYPESHED) - .with_target_version(PythonVersion::PY38) - .build(); - - let functools_module_name = ModuleName::new_static("functools").unwrap(); - let src_functools_path = src.join("functools.py"); - - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - assert_eq!(functools_module.search_path(), &src); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, &src_functools_path) - ); - - // If we now delete the first-party file, - // it should resolve to the stdlib: - db.memory_file_system() - .remove_file(&src_functools_path) - .unwrap(); - File::sync_path(&mut db, &src_functools_path); - let functools_module = resolve_module(&db, &functools_module_name).unwrap(); - assert_eq!(functools_module.search_path(), &stdlib); - assert_eq!( - Ok(functools_module.file()), - system_path_to_file(&db, stdlib.join("functools.pyi")) - ); - } - - #[test] - fn editable_install_absolute_path() { - const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; - let x_directory = [("/x/src/foo/__init__.py", ""), ("/x/src/foo/bar.py", "")]; - - let TestCase { mut db, .. } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(x_directory).unwrap(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_bar_module_name = ModuleName::new_static("foo.bar").unwrap(); - - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - let foo_bar_module = resolve_module(&db, &foo_bar_module_name).unwrap(); - - assert_eq!( - foo_module.file().path(&db), - &FilePath::system("/x/src/foo/__init__.py") - ); - assert_eq!( - foo_bar_module.file().path(&db), - &FilePath::system("/x/src/foo/bar.py") - ); - } - - #[test] - fn editable_install_pth_file_with_whitespace() { - const SITE_PACKAGES: &[FileSpec] = &[ - ("_foo.pth", " /x/src"), - ("_bar.pth", "/y/src "), - ]; - let external_files = [("/x/src/foo.py", ""), ("/y/src/bar.py", "")]; - - let TestCase { mut db, .. } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(external_files).unwrap(); - - // Lines with leading whitespace in `.pth` files do not parse: - let foo_module_name = ModuleName::new_static("foo").unwrap(); - assert_eq!(resolve_module(&db, &foo_module_name), None); - - // Lines with trailing whitespace in `.pth` files do: - let bar_module_name = ModuleName::new_static("bar").unwrap(); - let bar_module = resolve_module(&db, &bar_module_name).unwrap(); - assert_eq!( - bar_module.file().path(&db), - &FilePath::system("/y/src/bar.py") - ); - } - - #[test] - fn editable_install_relative_path() { - const SITE_PACKAGES: &[FileSpec] = &[ - ("_foo.pth", "../../x/../x/y/src"), - ("../x/y/src/foo.pyi", ""), - ]; - - let TestCase { db, .. } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - - assert_eq!( - foo_module.file().path(&db), - &FilePath::system("/x/y/src/foo.pyi") - ); - } - - #[test] - fn editable_install_multiple_pth_files_with_multiple_paths() { - const COMPLEX_PTH_FILE: &str = "\ -/ - -# a comment -/baz - -import not_an_editable_install; do_something_else_crazy_dynamic() - -# another comment -spam - -not_a_directory -"; - - const SITE_PACKAGES: &[FileSpec] = &[ - ("_foo.pth", "../../x/../x/y/src"), - ("_lots_of_others.pth", COMPLEX_PTH_FILE), - ("../x/y/src/foo.pyi", ""), - ("spam/spam.py", ""), - ]; - - let root_files = [("/a.py", ""), ("/baz/b.py", "")]; - - let TestCase { - mut db, - site_packages, - .. - } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(root_files).unwrap(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let a_module_name = ModuleName::new_static("a").unwrap(); - let b_module_name = ModuleName::new_static("b").unwrap(); - let spam_module_name = ModuleName::new_static("spam").unwrap(); - - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - let a_module = resolve_module(&db, &a_module_name).unwrap(); - let b_module = resolve_module(&db, &b_module_name).unwrap(); - let spam_module = resolve_module(&db, &spam_module_name).unwrap(); - - assert_eq!( - foo_module.file().path(&db), - &FilePath::system("/x/y/src/foo.pyi") - ); - assert_eq!(a_module.file().path(&db), &FilePath::system("/a.py")); - assert_eq!(b_module.file().path(&db), &FilePath::system("/baz/b.py")); - assert_eq!( - spam_module.file().path(&db), - &FilePath::System(site_packages.join("spam/spam.py")) - ); - } - - #[test] - fn module_resolution_paths_cached_between_different_module_resolutions() { - const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src"), ("_bar.pth", "/y/src")]; - let external_directories = [("/x/src/foo.py", ""), ("/y/src/bar.py", "")]; - - let TestCase { mut db, .. } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(external_directories).unwrap(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let bar_module_name = ModuleName::new_static("bar").unwrap(); - - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - assert_eq!( - foo_module.file().path(&db), - &FilePath::system("/x/src/foo.py") - ); - - db.clear_salsa_events(); - let bar_module = resolve_module(&db, &bar_module_name).unwrap(); - assert_eq!( - bar_module.file().path(&db), - &FilePath::system("/y/src/bar.py") - ); - let events = db.take_salsa_events(); - assert_const_function_query_was_not_run(&db, dynamic_resolution_paths, &events); - } - - #[test] - fn deleting_pth_file_on_which_module_resolution_depends_invalidates_cache() { - const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; - let x_directory = [("/x/src/foo.py", "")]; - - let TestCase { - mut db, - site_packages, - .. - } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(x_directory).unwrap(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - assert_eq!( - foo_module.file().path(&db), - &FilePath::system("/x/src/foo.py") - ); - - db.memory_file_system() - .remove_file(site_packages.join("_foo.pth")) - .unwrap(); - - File::sync_path(&mut db, &site_packages.join("_foo.pth")); - - assert_eq!(resolve_module(&db, &foo_module_name), None); - } - - #[test] - fn deleting_editable_install_on_which_module_resolution_depends_invalidates_cache() { - const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; - let x_directory = [("/x/src/foo.py", "")]; - - let TestCase { mut db, .. } = TestCaseBuilder::new() - .with_site_packages_files(SITE_PACKAGES) - .build(); - - db.write_files(x_directory).unwrap(); - - let foo_module_name = ModuleName::new_static("foo").unwrap(); - let foo_module = resolve_module(&db, &foo_module_name).unwrap(); - let src_path = SystemPathBuf::from("/x/src"); - assert_eq!( - foo_module.file().path(&db), - &FilePath::System(src_path.join("foo.py")) - ); - - db.memory_file_system() - .remove_file(src_path.join("foo.py")) - .unwrap(); - db.memory_file_system().remove_directory(&src_path).unwrap(); - File::sync_path(&mut db, &src_path.join("foo.py")); - File::sync_path(&mut db, &src_path); - assert_eq!(resolve_module(&db, &foo_module_name), None); - } - - #[test] - fn no_duplicate_search_paths_added() { - let TestCase { db, .. } = TestCaseBuilder::new() - .with_src_files(&[("foo.py", "")]) - .with_site_packages_files(&[("_foo.pth", "/src")]) - .build(); - - let search_paths: Vec<&SearchPath> = search_paths(&db).collect(); - - assert!(search_paths.contains( - &&SearchPath::first_party(db.system(), SystemPathBuf::from("/src")).unwrap() - )); - assert!(!search_paths - .contains(&&SearchPath::editable(db.system(), SystemPathBuf::from("/src")).unwrap())); - } - - #[test] - fn multiple_site_packages_with_editables() { - let mut db = TestDb::new(); - - let venv_site_packages = SystemPathBuf::from("/venv-site-packages"); - let site_packages_pth = venv_site_packages.join("foo.pth"); - let system_site_packages = SystemPathBuf::from("/system-site-packages"); - let editable_install_location = SystemPathBuf::from("/x/y/a.py"); - let system_site_packages_location = system_site_packages.join("a.py"); - - db.memory_file_system() - .create_directory_all("/src") - .unwrap(); - db.write_files([ - (&site_packages_pth, "/x/y"), - (&editable_install_location, ""), - (&system_site_packages_location, ""), - ]) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings { - extra_paths: vec![], - src_root: SystemPathBuf::from("/src"), - custom_typeshed: None, - site_packages: SitePackages::Known(vec![ - venv_site_packages, - system_site_packages, - ]), - }, - }, - ) - .expect("Valid program settings"); - - // The editable installs discovered from the `.pth` file in the first `site-packages` directory - // take precedence over the second `site-packages` directory... - let a_module_name = ModuleName::new_static("a").unwrap(); - let a_module = resolve_module(&db, &a_module_name).unwrap(); - assert_eq!(a_module.file().path(&db), &editable_install_location); - - db.memory_file_system() - .remove_file(&site_packages_pth) - .unwrap(); - File::sync_path(&mut db, &site_packages_pth); - - // ...But now that the `.pth` file in the first `site-packages` directory has been deleted, - // the editable install no longer exists, so the module now resolves to the file in the - // second `site-packages` directory - let a_module = resolve_module(&db, &a_module_name).unwrap(); - assert_eq!(a_module.file().path(&db), &system_site_packages_location); - } -} diff --git a/crates/red_knot_python_semantic/src/node_key.rs b/crates/red_knot_python_semantic/src/node_key.rs deleted file mode 100644 index 0935a1f8397b3..0000000000000 --- a/crates/red_knot_python_semantic/src/node_key.rs +++ /dev/null @@ -1,24 +0,0 @@ -use ruff_python_ast::{AnyNodeRef, NodeKind}; -use ruff_text_size::{Ranged, TextRange}; - -/// Compact key for a node for use in a hash map. -/// -/// Compares two nodes by their kind and text range. -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -pub(super) struct NodeKey { - kind: NodeKind, - range: TextRange, -} - -impl NodeKey { - pub(super) fn from_node<'a, N>(node: N) -> Self - where - N: Into>, - { - let node = node.into(); - NodeKey { - kind: node.kind(), - range: node.range(), - } - } -} diff --git a/crates/red_knot_python_semantic/src/program.rs b/crates/red_knot_python_semantic/src/program.rs deleted file mode 100644 index 7671dabb9590c..0000000000000 --- a/crates/red_knot_python_semantic/src/program.rs +++ /dev/null @@ -1,100 +0,0 @@ -use crate::python_version::PythonVersion; -use anyhow::Context; -use salsa::Durability; -use salsa::Setter; - -use ruff_db::system::{SystemPath, SystemPathBuf}; - -use crate::module_resolver::SearchPaths; -use crate::Db; - -#[salsa::input(singleton)] -pub struct Program { - pub target_version: PythonVersion, - - #[return_ref] - pub(crate) search_paths: SearchPaths, -} - -impl Program { - pub fn from_settings(db: &dyn Db, settings: &ProgramSettings) -> anyhow::Result { - let ProgramSettings { - target_version, - search_paths, - } = settings; - - tracing::info!("Target version: Python {target_version}"); - - let search_paths = SearchPaths::from_settings(db, search_paths) - .with_context(|| "Invalid search path settings")?; - - Ok(Program::builder(settings.target_version, search_paths) - .durability(Durability::HIGH) - .new(db)) - } - - pub fn update_search_paths( - self, - db: &mut dyn Db, - search_path_settings: &SearchPathSettings, - ) -> anyhow::Result<()> { - let search_paths = SearchPaths::from_settings(db, search_path_settings)?; - - if self.search_paths(db) != &search_paths { - tracing::debug!("Update search paths"); - self.set_search_paths(db).to(search_paths); - } - - Ok(()) - } - - pub fn custom_stdlib_search_path(self, db: &dyn Db) -> Option<&SystemPath> { - self.search_paths(db).custom_stdlib() - } -} - -#[derive(Clone, Debug, Eq, PartialEq)] -pub struct ProgramSettings { - pub target_version: PythonVersion, - pub search_paths: SearchPathSettings, -} - -/// Configures the search paths for module resolution. -#[derive(Eq, PartialEq, Debug, Clone)] -pub struct SearchPathSettings { - /// List of user-provided paths that should take first priority in the module resolution. - /// Examples in other type checkers are mypy's MYPYPATH environment variable, - /// or pyright's stubPath configuration setting. - pub extra_paths: Vec, - - /// The root of the workspace, used for finding first-party modules. - pub src_root: SystemPathBuf, - - /// Optional path to a "custom typeshed" directory on disk for us to use for standard-library types. - /// If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib, - /// bundled as a zip file in the binary - pub custom_typeshed: Option, - - /// The path to the user's `site-packages` directory, where third-party packages from ``PyPI`` are installed. - pub site_packages: SitePackages, -} - -impl SearchPathSettings { - pub fn new(src_root: SystemPathBuf) -> Self { - Self { - src_root, - extra_paths: vec![], - custom_typeshed: None, - site_packages: SitePackages::Known(vec![]), - } - } -} - -#[derive(Debug, Clone, Eq, PartialEq)] -pub enum SitePackages { - Derived { - venv_path: SystemPathBuf, - }, - /// Resolved site packages paths - Known(Vec), -} diff --git a/crates/red_knot_python_semantic/src/python_version.rs b/crates/red_knot_python_semantic/src/python_version.rs deleted file mode 100644 index 58d15d76f900e..0000000000000 --- a/crates/red_knot_python_semantic/src/python_version.rs +++ /dev/null @@ -1,69 +0,0 @@ -use std::fmt; - -/// Representation of a Python version. -/// -/// Unlike the `TargetVersion` enums in the CLI crates, -/// this does not necessarily represent a Python version that we actually support. -#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)] -pub struct PythonVersion { - pub major: u8, - pub minor: u8, -} - -impl PythonVersion { - pub const PY37: PythonVersion = PythonVersion { major: 3, minor: 7 }; - pub const PY38: PythonVersion = PythonVersion { major: 3, minor: 8 }; - pub const PY39: PythonVersion = PythonVersion { major: 3, minor: 9 }; - pub const PY310: PythonVersion = PythonVersion { - major: 3, - minor: 10, - }; - pub const PY311: PythonVersion = PythonVersion { - major: 3, - minor: 11, - }; - pub const PY312: PythonVersion = PythonVersion { - major: 3, - minor: 12, - }; - pub const PY313: PythonVersion = PythonVersion { - major: 3, - minor: 13, - }; - - pub fn free_threaded_build_available(self) -> bool { - self >= PythonVersion::PY313 - } -} - -impl Default for PythonVersion { - fn default() -> Self { - Self::PY38 - } -} - -impl TryFrom<(&str, &str)> for PythonVersion { - type Error = std::num::ParseIntError; - - fn try_from(value: (&str, &str)) -> Result { - let (major, minor) = value; - Ok(Self { - major: major.parse()?, - minor: minor.parse()?, - }) - } -} - -impl From<(u8, u8)> for PythonVersion { - fn from(value: (u8, u8)) -> Self { - let (major, minor) = value; - Self { major, minor } - } -} - -impl fmt::Display for PythonVersion { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - let PythonVersion { major, minor } = self; - write!(f, "{major}.{minor}") - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index.rs b/crates/red_knot_python_semantic/src/semantic_index.rs deleted file mode 100644 index 083779dc0c9af..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index.rs +++ /dev/null @@ -1,1213 +0,0 @@ -use std::iter::FusedIterator; -use std::sync::Arc; - -use rustc_hash::{FxBuildHasher, FxHashMap}; -use salsa::plumbing::AsId; - -use ruff_db::files::File; -use ruff_db::parsed::parsed_module; -use ruff_index::{IndexSlice, IndexVec}; - -use crate::semantic_index::ast_ids::node_key::ExpressionNodeKey; -use crate::semantic_index::ast_ids::AstIds; -use crate::semantic_index::builder::SemanticIndexBuilder; -use crate::semantic_index::definition::{Definition, DefinitionNodeKey}; -use crate::semantic_index::expression::Expression; -use crate::semantic_index::symbol::{ - FileScopeId, NodeWithScopeKey, NodeWithScopeRef, Scope, ScopeId, ScopedSymbolId, SymbolTable, -}; -use crate::semantic_index::use_def::UseDefMap; -use crate::Db; - -pub mod ast_ids; -mod builder; -pub(crate) mod constraint; -pub mod definition; -pub mod expression; -pub mod symbol; -mod use_def; - -pub(crate) use self::use_def::{ - BindingWithConstraints, BindingWithConstraintsIterator, DeclarationsIterator, -}; - -type SymbolMap = hashbrown::HashMap; - -/// Returns the semantic index for `file`. -/// -/// Prefer using [`symbol_table`] when working with symbols from a single scope. -#[salsa::tracked(return_ref, no_eq)] -pub(crate) fn semantic_index(db: &dyn Db, file: File) -> SemanticIndex<'_> { - let _span = tracing::trace_span!("semantic_index", file = %file.path(db)).entered(); - - let parsed = parsed_module(db.upcast(), file); - - SemanticIndexBuilder::new(db, file, parsed).build() -} - -/// Returns the symbol table for a specific `scope`. -/// -/// Using [`symbol_table`] over [`semantic_index`] has the advantage that -/// Salsa can avoid invalidating dependent queries if this scope's symbol table -/// is unchanged. -#[salsa::tracked] -pub(crate) fn symbol_table<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> Arc { - let file = scope.file(db); - let _span = - tracing::trace_span!("symbol_table", scope=?scope.as_id(), file=%file.path(db)).entered(); - let index = semantic_index(db, file); - - index.symbol_table(scope.file_scope_id(db)) -} - -/// Returns the use-def map for a specific `scope`. -/// -/// Using [`use_def_map`] over [`semantic_index`] has the advantage that -/// Salsa can avoid invalidating dependent queries if this scope's use-def map -/// is unchanged. -#[salsa::tracked] -pub(crate) fn use_def_map<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> Arc> { - let file = scope.file(db); - let _span = - tracing::trace_span!("use_def_map", scope=?scope.as_id(), file=%file.path(db)).entered(); - let index = semantic_index(db, file); - - index.use_def_map(scope.file_scope_id(db)) -} - -/// Returns the module global scope of `file`. -#[salsa::tracked] -pub(crate) fn global_scope(db: &dyn Db, file: File) -> ScopeId<'_> { - let _span = tracing::trace_span!("global_scope", file = %file.path(db)).entered(); - - FileScopeId::global().to_scope_id(db, file) -} - -/// The symbol tables and use-def maps for all scopes in a file. -#[derive(Debug)] -pub(crate) struct SemanticIndex<'db> { - /// List of all symbol tables in this file, indexed by scope. - symbol_tables: IndexVec>, - - /// List of all scopes in this file. - scopes: IndexVec, - - /// Map expressions to their corresponding scope. - scopes_by_expression: FxHashMap, - - /// Map from a node creating a definition to its definition. - definitions_by_node: FxHashMap>, - - /// Map from a standalone expression to its [`Expression`] ingredient. - expressions_by_node: FxHashMap>, - - /// Map from nodes that create a scope to the scope they create. - scopes_by_node: FxHashMap, - - /// Map from the file-local [`FileScopeId`] to the salsa-ingredient [`ScopeId`]. - scope_ids_by_scope: IndexVec>, - - /// Use-def map for each scope in this file. - use_def_maps: IndexVec>>, - - /// Lookup table to map between node ids and ast nodes. - /// - /// Note: We should not depend on this map when analysing other files or - /// changing a file invalidates all dependents. - ast_ids: IndexVec, - - /// Flags about the global scope (code usage impacting inference) - has_future_annotations: bool, -} - -impl<'db> SemanticIndex<'db> { - /// Returns the symbol table for a specific scope. - /// - /// Use the Salsa cached [`symbol_table()`] query if you only need the - /// symbol table for a single scope. - pub(super) fn symbol_table(&self, scope_id: FileScopeId) -> Arc { - self.symbol_tables[scope_id].clone() - } - - /// Returns the use-def map for a specific scope. - /// - /// Use the Salsa cached [`use_def_map()`] query if you only need the - /// use-def map for a single scope. - pub(super) fn use_def_map(&self, scope_id: FileScopeId) -> Arc { - self.use_def_maps[scope_id].clone() - } - - pub(crate) fn ast_ids(&self, scope_id: FileScopeId) -> &AstIds { - &self.ast_ids[scope_id] - } - - /// Returns the ID of the `expression`'s enclosing scope. - pub(crate) fn expression_scope_id( - &self, - expression: impl Into, - ) -> FileScopeId { - self.scopes_by_expression[&expression.into()] - } - - /// Returns the [`Scope`] of the `expression`'s enclosing scope. - #[allow(unused)] - pub(crate) fn expression_scope(&self, expression: impl Into) -> &Scope { - &self.scopes[self.expression_scope_id(expression)] - } - - /// Returns the [`Scope`] with the given id. - pub(crate) fn scope(&self, id: FileScopeId) -> &Scope { - &self.scopes[id] - } - - pub(crate) fn scope_ids(&self) -> impl Iterator { - self.scope_ids_by_scope.iter().copied() - } - - /// Returns the id of the parent scope. - pub(crate) fn parent_scope_id(&self, scope_id: FileScopeId) -> Option { - let scope = self.scope(scope_id); - scope.parent - } - - /// Returns the parent scope of `scope_id`. - #[allow(unused)] - pub(crate) fn parent_scope(&self, scope_id: FileScopeId) -> Option<&Scope> { - Some(&self.scopes[self.parent_scope_id(scope_id)?]) - } - - /// Returns an iterator over the descendent scopes of `scope`. - #[allow(unused)] - pub(crate) fn descendent_scopes(&self, scope: FileScopeId) -> DescendentsIter { - DescendentsIter::new(self, scope) - } - - /// Returns an iterator over the direct child scopes of `scope`. - #[allow(unused)] - pub(crate) fn child_scopes(&self, scope: FileScopeId) -> ChildrenIter { - ChildrenIter::new(self, scope) - } - - /// Returns an iterator over all ancestors of `scope`, starting with `scope` itself. - #[allow(unused)] - pub(crate) fn ancestor_scopes(&self, scope: FileScopeId) -> AncestorsIter { - AncestorsIter::new(self, scope) - } - - /// Returns the [`Definition`] salsa ingredient for `definition_key`. - pub(crate) fn definition( - &self, - definition_key: impl Into, - ) -> Definition<'db> { - self.definitions_by_node[&definition_key.into()] - } - - /// Returns the [`Expression`] ingredient for an expression node. - /// Panics if we have no expression ingredient for that node. We can only call this method for - /// standalone-inferable expressions, which we call `add_standalone_expression` for in - /// [`SemanticIndexBuilder`]. - pub(crate) fn expression( - &self, - expression_key: impl Into, - ) -> Expression<'db> { - self.expressions_by_node[&expression_key.into()] - } - - /// Returns the id of the scope that `node` creates. This is different from [`Definition::scope`] which - /// returns the scope in which that definition is defined in. - pub(crate) fn node_scope(&self, node: NodeWithScopeRef) -> FileScopeId { - self.scopes_by_node[&node.node_key()] - } - - /// Checks if there is an import of `__future__.annotations` in the global scope, which affects - /// the logic for type inference. - pub(super) fn has_future_annotations(&self) -> bool { - self.has_future_annotations - } -} - -pub struct AncestorsIter<'a> { - scopes: &'a IndexSlice, - next_id: Option, -} - -impl<'a> AncestorsIter<'a> { - fn new(module_symbol_table: &'a SemanticIndex, start: FileScopeId) -> Self { - Self { - scopes: &module_symbol_table.scopes, - next_id: Some(start), - } - } -} - -impl<'a> Iterator for AncestorsIter<'a> { - type Item = (FileScopeId, &'a Scope); - - fn next(&mut self) -> Option { - let current_id = self.next_id?; - let current = &self.scopes[current_id]; - self.next_id = current.parent; - - Some((current_id, current)) - } -} - -impl FusedIterator for AncestorsIter<'_> {} - -pub struct DescendentsIter<'a> { - next_id: FileScopeId, - descendents: std::slice::Iter<'a, Scope>, -} - -impl<'a> DescendentsIter<'a> { - fn new(symbol_table: &'a SemanticIndex, scope_id: FileScopeId) -> Self { - let scope = &symbol_table.scopes[scope_id]; - let scopes = &symbol_table.scopes[scope.descendents.clone()]; - - Self { - next_id: scope_id + 1, - descendents: scopes.iter(), - } - } -} - -impl<'a> Iterator for DescendentsIter<'a> { - type Item = (FileScopeId, &'a Scope); - - fn next(&mut self) -> Option { - let descendent = self.descendents.next()?; - let id = self.next_id; - self.next_id = self.next_id + 1; - - Some((id, descendent)) - } - - fn size_hint(&self) -> (usize, Option) { - self.descendents.size_hint() - } -} - -impl FusedIterator for DescendentsIter<'_> {} - -impl ExactSizeIterator for DescendentsIter<'_> {} - -pub struct ChildrenIter<'a> { - parent: FileScopeId, - descendents: DescendentsIter<'a>, -} - -impl<'a> ChildrenIter<'a> { - fn new(module_symbol_table: &'a SemanticIndex, parent: FileScopeId) -> Self { - let descendents = DescendentsIter::new(module_symbol_table, parent); - - Self { - parent, - descendents, - } - } -} - -impl<'a> Iterator for ChildrenIter<'a> { - type Item = (FileScopeId, &'a Scope); - - fn next(&mut self) -> Option { - self.descendents - .find(|(_, scope)| scope.parent == Some(self.parent)) - } -} - -impl FusedIterator for ChildrenIter<'_> {} - -#[cfg(test)] -mod tests { - use ruff_db::files::{system_path_to_file, File}; - use ruff_db::parsed::parsed_module; - use ruff_db::system::DbWithTestSystem; - use ruff_python_ast as ast; - use ruff_text_size::{Ranged, TextRange}; - - use crate::db::tests::TestDb; - use crate::semantic_index::ast_ids::{HasScopedUseId, ScopedUseId}; - use crate::semantic_index::definition::{Definition, DefinitionKind}; - use crate::semantic_index::symbol::{ - FileScopeId, Scope, ScopeKind, ScopedSymbolId, SymbolTable, - }; - use crate::semantic_index::use_def::UseDefMap; - use crate::semantic_index::{global_scope, semantic_index, symbol_table, use_def_map}; - use crate::Db; - - impl UseDefMap<'_> { - fn first_public_binding(&self, symbol: ScopedSymbolId) -> Option> { - self.public_bindings(symbol) - .next() - .map(|constrained_binding| constrained_binding.binding) - } - - fn first_binding_at_use(&self, use_id: ScopedUseId) -> Option> { - self.bindings_at_use(use_id) - .next() - .map(|constrained_binding| constrained_binding.binding) - } - } - - struct TestCase { - db: TestDb, - file: File, - } - - fn test_case(content: impl ToString) -> TestCase { - let mut db = TestDb::new(); - db.write_file("test.py", content).unwrap(); - - let file = system_path_to_file(&db, "test.py").unwrap(); - - TestCase { db, file } - } - - fn names(table: &SymbolTable) -> Vec { - table - .symbols() - .map(|symbol| symbol.name().to_string()) - .collect() - } - - #[test] - fn empty() { - let TestCase { db, file } = test_case(""); - let global_table = symbol_table(&db, global_scope(&db, file)); - - let global_names = names(&global_table); - - assert_eq!(global_names, Vec::<&str>::new()); - } - - #[test] - fn simple() { - let TestCase { db, file } = test_case("x"); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["x"]); - } - - #[test] - fn annotation_only() { - let TestCase { db, file } = test_case("x: int"); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["int", "x"]); - // TODO record definition - } - - #[test] - fn import() { - let TestCase { db, file } = test_case("import foo"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(names(&global_table), vec!["foo"]); - let foo = global_table.symbol_id_by_name("foo").unwrap(); - - let use_def = use_def_map(&db, scope); - let binding = use_def.first_public_binding(foo).unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Import(_))); - } - - #[test] - fn import_sub() { - let TestCase { db, file } = test_case("import foo.bar"); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["foo"]); - } - - #[test] - fn import_as() { - let TestCase { db, file } = test_case("import foo.bar as baz"); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["baz"]); - } - - #[test] - fn import_from() { - let TestCase { db, file } = test_case("from bar import foo"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(names(&global_table), vec!["foo"]); - assert!( - global_table - .symbol_by_name("foo") - .is_some_and(|symbol| { symbol.is_bound() && !symbol.is_used() }), - "symbols that are defined get the defined flag" - ); - - let use_def = use_def_map(&db, scope); - let binding = use_def - .first_public_binding( - global_table - .symbol_id_by_name("foo") - .expect("symbol to exist"), - ) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::ImportFrom(_))); - } - - #[test] - fn assign() { - let TestCase { db, file } = test_case("x = foo"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(names(&global_table), vec!["foo", "x"]); - assert!( - global_table - .symbol_by_name("foo") - .is_some_and(|symbol| { !symbol.is_bound() && symbol.is_used() }), - "a symbol used but not bound in a scope should have only the used flag" - ); - let use_def = use_def_map(&db, scope); - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name("x").expect("symbol exists")) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); - } - - #[test] - fn augmented_assignment() { - let TestCase { db, file } = test_case("x += 1"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(names(&global_table), vec!["x"]); - - let use_def = use_def_map(&db, scope); - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) - .unwrap(); - - assert!(matches!( - binding.kind(&db), - DefinitionKind::AugmentedAssignment(_) - )); - } - - #[test] - fn class_scope() { - let TestCase { db, file } = test_case( - " -class C: - x = 1 -y = 2 -", - ); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["C", "y"]); - - let index = semantic_index(&db, file); - - let [(class_scope_id, class_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope") - }; - assert_eq!(class_scope.kind(), ScopeKind::Class); - assert_eq!(class_scope_id.to_scope_id(&db, file).name(&db), "C"); - - let class_table = index.symbol_table(class_scope_id); - assert_eq!(names(&class_table), vec!["x"]); - - let use_def = index.use_def_map(class_scope_id); - let binding = use_def - .first_public_binding(class_table.symbol_id_by_name("x").expect("symbol exists")) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); - } - - #[test] - fn function_scope() { - let TestCase { db, file } = test_case( - " -def func(): - x = 1 -y = 2 -", - ); - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["func", "y"]); - - let [(function_scope_id, function_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope") - }; - assert_eq!(function_scope.kind(), ScopeKind::Function); - assert_eq!(function_scope_id.to_scope_id(&db, file).name(&db), "func"); - - let function_table = index.symbol_table(function_scope_id); - assert_eq!(names(&function_table), vec!["x"]); - - let use_def = index.use_def_map(function_scope_id); - let binding = use_def - .first_public_binding( - function_table - .symbol_id_by_name("x") - .expect("symbol exists"), - ) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); - } - - #[test] - fn function_parameter_symbols() { - let TestCase { db, file } = test_case( - " -def f(a: str, /, b: str, c: int = 1, *args, d: int = 2, **kwargs): - pass -", - ); - - let index = semantic_index(&db, file); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert_eq!(names(&global_table), vec!["str", "int", "f"]); - - let [(function_scope_id, _function_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("Expected a function scope") - }; - - let function_table = index.symbol_table(function_scope_id); - assert_eq!( - names(&function_table), - vec!["a", "b", "c", "args", "d", "kwargs"], - ); - - let use_def = index.use_def_map(function_scope_id); - for name in ["a", "b", "c", "d"] { - let binding = use_def - .first_public_binding( - function_table - .symbol_id_by_name(name) - .expect("symbol exists"), - ) - .unwrap(); - assert!(matches!( - binding.kind(&db), - DefinitionKind::ParameterWithDefault(_) - )); - } - for name in ["args", "kwargs"] { - let binding = use_def - .first_public_binding( - function_table - .symbol_id_by_name(name) - .expect("symbol exists"), - ) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Parameter(_))); - } - } - - #[test] - fn lambda_parameter_symbols() { - let TestCase { db, file } = test_case("lambda a, b, c=1, *args, d=2, **kwargs: None"); - - let index = semantic_index(&db, file); - let global_table = symbol_table(&db, global_scope(&db, file)); - - assert!(names(&global_table).is_empty()); - - let [(lambda_scope_id, _lambda_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("Expected a lambda scope") - }; - - let lambda_table = index.symbol_table(lambda_scope_id); - assert_eq!( - names(&lambda_table), - vec!["a", "b", "c", "args", "d", "kwargs"], - ); - - let use_def = index.use_def_map(lambda_scope_id); - for name in ["a", "b", "c", "d"] { - let binding = use_def - .first_public_binding(lambda_table.symbol_id_by_name(name).expect("symbol exists")) - .unwrap(); - assert!(matches!( - binding.kind(&db), - DefinitionKind::ParameterWithDefault(_) - )); - } - for name in ["args", "kwargs"] { - let binding = use_def - .first_public_binding(lambda_table.symbol_id_by_name(name).expect("symbol exists")) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Parameter(_))); - } - } - - /// Test case to validate that the comprehension scope is correctly identified and that the target - /// variable is defined only in the comprehension scope and not in the global scope. - #[test] - fn comprehension_scope() { - let TestCase { db, file } = test_case( - " -[x for x, y in iter1] -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["iter1"]); - - let [(comprehension_scope_id, comprehension_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope") - }; - - assert_eq!(comprehension_scope.kind(), ScopeKind::Comprehension); - assert_eq!( - comprehension_scope_id.to_scope_id(&db, file).name(&db), - "" - ); - - let comprehension_symbol_table = index.symbol_table(comprehension_scope_id); - - assert_eq!(names(&comprehension_symbol_table), vec!["x", "y"]); - - let use_def = index.use_def_map(comprehension_scope_id); - for name in ["x", "y"] { - let binding = use_def - .first_public_binding( - comprehension_symbol_table - .symbol_id_by_name(name) - .expect("symbol exists"), - ) - .unwrap(); - assert!(matches!( - binding.kind(&db), - DefinitionKind::Comprehension(_) - )); - } - } - - /// Test case to validate that the `x` variable used in the comprehension is referencing the - /// `x` variable defined by the inner generator (`for x in iter2`) and not the outer one. - #[test] - fn multiple_generators() { - let TestCase { db, file } = test_case( - " -[x for x in iter1 for x in iter2] -", - ); - - let index = semantic_index(&db, file); - let [(comprehension_scope_id, _)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope") - }; - - let use_def = index.use_def_map(comprehension_scope_id); - - let module = parsed_module(&db, file).syntax(); - let element = module.body[0] - .as_expr_stmt() - .unwrap() - .value - .as_list_comp_expr() - .unwrap() - .elt - .as_name_expr() - .unwrap(); - let element_use_id = - element.scoped_use_id(&db, comprehension_scope_id.to_scope_id(&db, file)); - - let binding = use_def.first_binding_at_use(element_use_id).unwrap(); - let DefinitionKind::Comprehension(comprehension) = binding.kind(&db) else { - panic!("expected generator definition") - }; - let target = comprehension.target(); - let name = target.id().as_str(); - - assert_eq!(name, "x"); - assert_eq!(target.range(), TextRange::new(23.into(), 24.into())); - } - - /// Test case to validate that the nested comprehension creates a new scope which is a child of - /// the outer comprehension scope and the variables are correctly defined in the respective - /// scopes. - #[test] - fn nested_generators() { - let TestCase { db, file } = test_case( - " -[{x for x in iter2} for y in iter1] -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["iter1"]); - - let [(comprehension_scope_id, comprehension_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope") - }; - - assert_eq!(comprehension_scope.kind(), ScopeKind::Comprehension); - assert_eq!( - comprehension_scope_id.to_scope_id(&db, file).name(&db), - "" - ); - - let comprehension_symbol_table = index.symbol_table(comprehension_scope_id); - - assert_eq!(names(&comprehension_symbol_table), vec!["y", "iter2"]); - - let [(inner_comprehension_scope_id, inner_comprehension_scope)] = index - .child_scopes(comprehension_scope_id) - .collect::>()[..] - else { - panic!("expected one inner generator scope") - }; - - assert_eq!(inner_comprehension_scope.kind(), ScopeKind::Comprehension); - assert_eq!( - inner_comprehension_scope_id - .to_scope_id(&db, file) - .name(&db), - "" - ); - - let inner_comprehension_symbol_table = index.symbol_table(inner_comprehension_scope_id); - - assert_eq!(names(&inner_comprehension_symbol_table), vec!["x"]); - } - - #[test] - fn with_item_definition() { - let TestCase { db, file } = test_case( - " -with item1 as x, item2 as y: - pass -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["item1", "x", "item2", "y"]); - - let use_def = index.use_def_map(FileScopeId::global()); - for name in ["x", "y"] { - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) - .expect("Expected with item definition for {name}"); - assert!(matches!(binding.kind(&db), DefinitionKind::WithItem(_))); - } - } - - #[test] - fn with_item_unpacked_definition() { - let TestCase { db, file } = test_case( - " -with context() as (x, y): - pass -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["context", "x", "y"]); - - let use_def = index.use_def_map(FileScopeId::global()); - for name in ["x", "y"] { - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) - .expect("Expected with item definition for {name}"); - assert!(matches!(binding.kind(&db), DefinitionKind::WithItem(_))); - } - } - - #[test] - fn dupes() { - let TestCase { db, file } = test_case( - " -def func(): - x = 1 -def func(): - y = 2 -", - ); - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["func"]); - let [(func_scope1_id, func_scope_1), (func_scope2_id, func_scope_2)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected two child scopes"); - }; - - assert_eq!(func_scope_1.kind(), ScopeKind::Function); - - assert_eq!(func_scope1_id.to_scope_id(&db, file).name(&db), "func"); - assert_eq!(func_scope_2.kind(), ScopeKind::Function); - assert_eq!(func_scope2_id.to_scope_id(&db, file).name(&db), "func"); - - let func1_table = index.symbol_table(func_scope1_id); - let func2_table = index.symbol_table(func_scope2_id); - assert_eq!(names(&func1_table), vec!["x"]); - assert_eq!(names(&func2_table), vec!["y"]); - - let use_def = index.use_def_map(FileScopeId::global()); - let binding = use_def - .first_public_binding( - global_table - .symbol_id_by_name("func") - .expect("symbol exists"), - ) - .unwrap(); - assert!(matches!(binding.kind(&db), DefinitionKind::Function(_))); - } - - #[test] - fn generic_function() { - let TestCase { db, file } = test_case( - " -def func[T](): - x = 1 -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["func"]); - - let [(ann_scope_id, ann_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope"); - }; - - assert_eq!(ann_scope.kind(), ScopeKind::Annotation); - assert_eq!(ann_scope_id.to_scope_id(&db, file).name(&db), "func"); - let ann_table = index.symbol_table(ann_scope_id); - assert_eq!(names(&ann_table), vec!["T"]); - - let [(func_scope_id, func_scope)] = - index.child_scopes(ann_scope_id).collect::>()[..] - else { - panic!("expected one child scope"); - }; - assert_eq!(func_scope.kind(), ScopeKind::Function); - assert_eq!(func_scope_id.to_scope_id(&db, file).name(&db), "func"); - let func_table = index.symbol_table(func_scope_id); - assert_eq!(names(&func_table), vec!["x"]); - } - - #[test] - fn generic_class() { - let TestCase { db, file } = test_case( - " -class C[T]: - x = 1 -", - ); - - let index = semantic_index(&db, file); - let global_table = index.symbol_table(FileScopeId::global()); - - assert_eq!(names(&global_table), vec!["C"]); - - let [(ann_scope_id, ann_scope)] = index - .child_scopes(FileScopeId::global()) - .collect::>()[..] - else { - panic!("expected one child scope"); - }; - - assert_eq!(ann_scope.kind(), ScopeKind::Annotation); - assert_eq!(ann_scope_id.to_scope_id(&db, file).name(&db), "C"); - let ann_table = index.symbol_table(ann_scope_id); - assert_eq!(names(&ann_table), vec!["T"]); - assert!( - ann_table - .symbol_by_name("T") - .is_some_and(|s| s.is_bound() && !s.is_used()), - "type parameters are defined by the scope that introduces them" - ); - - let [(class_scope_id, class_scope)] = - index.child_scopes(ann_scope_id).collect::>()[..] - else { - panic!("expected one child scope"); - }; - - assert_eq!(class_scope.kind(), ScopeKind::Class); - assert_eq!(class_scope_id.to_scope_id(&db, file).name(&db), "C"); - assert_eq!(names(&index.symbol_table(class_scope_id)), vec!["x"]); - } - - #[test] - fn reachability_trivial() { - let TestCase { db, file } = test_case("x = 1; x"); - let parsed = parsed_module(&db, file); - let scope = global_scope(&db, file); - let ast = parsed.syntax(); - let ast::Stmt::Expr(ast::StmtExpr { - value: x_use_expr, .. - }) = &ast.body[1] - else { - panic!("should be an expr") - }; - let ast::Expr::Name(x_use_expr_name) = x_use_expr.as_ref() else { - panic!("expected a Name"); - }; - let x_use_id = x_use_expr_name.scoped_use_id(&db, scope); - let use_def = use_def_map(&db, scope); - let binding = use_def.first_binding_at_use(x_use_id).unwrap(); - let DefinitionKind::Assignment(assignment) = binding.kind(&db) else { - panic!("should be an assignment definition") - }; - let ast::Expr::NumberLiteral(ast::ExprNumberLiteral { - value: ast::Number::Int(num), - .. - }) = assignment.value() - else { - panic!("should be a number literal") - }; - assert_eq!(*num, 1); - } - - #[test] - fn expression_scope() { - let TestCase { db, file } = test_case("x = 1;\ndef test():\n y = 4"); - - let index = semantic_index(&db, file); - let parsed = parsed_module(&db, file); - let ast = parsed.syntax(); - - let x_stmt = ast.body[0].as_assign_stmt().unwrap(); - let x = &x_stmt.targets[0]; - - assert_eq!(index.expression_scope(x).kind(), ScopeKind::Module); - assert_eq!(index.expression_scope_id(x), FileScopeId::global()); - - let def = ast.body[1].as_function_def_stmt().unwrap(); - let y_stmt = def.body[0].as_assign_stmt().unwrap(); - let y = &y_stmt.targets[0]; - - assert_eq!(index.expression_scope(y).kind(), ScopeKind::Function); - } - - #[test] - fn scope_iterators() { - fn scope_names<'a>( - scopes: impl Iterator, - db: &'a dyn Db, - file: File, - ) -> Vec<&'a str> { - scopes - .into_iter() - .map(|(scope_id, _)| scope_id.to_scope_id(db, file).name(db)) - .collect() - } - - let TestCase { db, file } = test_case( - r" -class Test: - def foo(): - def bar(): - ... - def baz(): - pass - -def x(): - pass", - ); - - let index = semantic_index(&db, file); - - let descendents = index.descendent_scopes(FileScopeId::global()); - assert_eq!( - scope_names(descendents, &db, file), - vec!["Test", "foo", "bar", "baz", "x"] - ); - - let children = index.child_scopes(FileScopeId::global()); - assert_eq!(scope_names(children, &db, file), vec!["Test", "x"]); - - let test_class = index.child_scopes(FileScopeId::global()).next().unwrap().0; - let test_child_scopes = index.child_scopes(test_class); - assert_eq!( - scope_names(test_child_scopes, &db, file), - vec!["foo", "baz"] - ); - - let bar_scope = index - .descendent_scopes(FileScopeId::global()) - .nth(2) - .unwrap() - .0; - let ancestors = index.ancestor_scopes(bar_scope); - - assert_eq!( - scope_names(ancestors, &db, file), - vec!["bar", "foo", "Test", ""] - ); - } - - #[test] - fn match_stmt() { - let TestCase { db, file } = test_case( - " -match subject: - case a: ... - case [b, c, *d]: ... - case e as f: ... - case {'x': g, **h}: ... - case Foo(i, z=j): ... - case k | l: ... - case _: ... -", - ); - - let global_scope_id = global_scope(&db, file); - let global_table = symbol_table(&db, global_scope_id); - - assert!(global_table.symbol_by_name("Foo").unwrap().is_used()); - assert_eq!( - names(&global_table), - vec!["subject", "a", "b", "c", "d", "e", "f", "g", "h", "Foo", "i", "j", "k", "l"] - ); - - let use_def = use_def_map(&db, global_scope_id); - for (name, expected_index) in [ - ("a", 0), - ("b", 0), - ("c", 1), - ("d", 2), - ("e", 0), - ("f", 1), - ("g", 0), - ("h", 1), - ("i", 0), - ("j", 1), - ("k", 0), - ("l", 1), - ] { - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) - .expect("Expected with item definition for {name}"); - if let DefinitionKind::MatchPattern(pattern) = binding.kind(&db) { - assert_eq!(pattern.index(), expected_index); - } else { - panic!("Expected match pattern definition for {name}"); - } - } - } - - #[test] - fn nested_match_case() { - let TestCase { db, file } = test_case( - " -match 1: - case first: - match 2: - case second: - pass -", - ); - - let global_scope_id = global_scope(&db, file); - let global_table = symbol_table(&db, global_scope_id); - - assert_eq!(names(&global_table), vec!["first", "second"]); - - let use_def = use_def_map(&db, global_scope_id); - for (name, expected_index) in [("first", 0), ("second", 0)] { - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) - .expect("Expected with item definition for {name}"); - if let DefinitionKind::MatchPattern(pattern) = binding.kind(&db) { - assert_eq!(pattern.index(), expected_index); - } else { - panic!("Expected match pattern definition for {name}"); - } - } - } - - #[test] - fn for_loops_single_assignment() { - let TestCase { db, file } = test_case("for x in a: pass"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(&names(&global_table), &["a", "x"]); - - let use_def = use_def_map(&db, scope); - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) - .unwrap(); - - assert!(matches!(binding.kind(&db), DefinitionKind::For(_))); - } - - #[test] - fn for_loops_simple_unpacking() { - let TestCase { db, file } = test_case("for (x, y) in a: pass"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(&names(&global_table), &["a", "x", "y"]); - - let use_def = use_def_map(&db, scope); - let x_binding = use_def - .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) - .unwrap(); - let y_binding = use_def - .first_public_binding(global_table.symbol_id_by_name("y").unwrap()) - .unwrap(); - - assert!(matches!(x_binding.kind(&db), DefinitionKind::For(_))); - assert!(matches!(y_binding.kind(&db), DefinitionKind::For(_))); - } - - #[test] - fn for_loops_complex_unpacking() { - let TestCase { db, file } = test_case("for [((a,) b), (c, d)] in e: pass"); - let scope = global_scope(&db, file); - let global_table = symbol_table(&db, scope); - - assert_eq!(&names(&global_table), &["e", "a", "b", "c", "d"]); - - let use_def = use_def_map(&db, scope); - let binding = use_def - .first_public_binding(global_table.symbol_id_by_name("a").unwrap()) - .unwrap(); - - assert!(matches!(binding.kind(&db), DefinitionKind::For(_))); - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/builder.rs b/crates/red_knot_python_semantic/src/semantic_index/builder.rs deleted file mode 100644 index 284d5820759a7..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/builder.rs +++ /dev/null @@ -1,1282 +0,0 @@ -use std::sync::Arc; - -use except_handlers::TryNodeContextStackManager; -use rustc_hash::FxHashMap; - -use ruff_db::files::File; -use ruff_db::parsed::ParsedModule; -use ruff_index::IndexVec; -use ruff_python_ast as ast; -use ruff_python_ast::name::Name; -use ruff_python_ast::visitor::{walk_expr, walk_pattern, walk_stmt, Visitor}; -use ruff_python_ast::{AnyParameterRef, BoolOp, Expr}; - -use crate::ast_node_ref::AstNodeRef; -use crate::semantic_index::ast_ids::node_key::ExpressionNodeKey; -use crate::semantic_index::ast_ids::AstIdsBuilder; -use crate::semantic_index::definition::{ - AssignmentDefinitionNodeRef, ComprehensionDefinitionNodeRef, Definition, DefinitionNodeKey, - DefinitionNodeRef, ForStmtDefinitionNodeRef, ImportFromDefinitionNodeRef, -}; -use crate::semantic_index::expression::Expression; -use crate::semantic_index::symbol::{ - FileScopeId, NodeWithScopeKey, NodeWithScopeRef, Scope, ScopeId, ScopedSymbolId, - SymbolTableBuilder, -}; -use crate::semantic_index::use_def::{FlowSnapshot, UseDefMapBuilder}; -use crate::semantic_index::SemanticIndex; -use crate::Db; - -use super::constraint::{Constraint, ConstraintNode, PatternConstraint}; -use super::definition::{ - AssignmentKind, DefinitionCategory, ExceptHandlerDefinitionNodeRef, - MatchPatternDefinitionNodeRef, WithItemDefinitionNodeRef, -}; - -mod except_handlers; - -pub(super) struct SemanticIndexBuilder<'db> { - // Builder state - db: &'db dyn Db, - file: File, - module: &'db ParsedModule, - scope_stack: Vec, - /// The assignments we're currently visiting, with - /// the most recent visit at the end of the Vec - current_assignments: Vec>, - /// The match case we're currently visiting. - current_match_case: Option>, - /// Flow states at each `break` in the current loop. - loop_break_states: Vec, - /// Per-scope contexts regarding nested `try`/`except` statements - try_node_context_stack_manager: TryNodeContextStackManager, - - /// Flags about the file's global scope - has_future_annotations: bool, - - // Semantic Index fields - scopes: IndexVec, - scope_ids_by_scope: IndexVec>, - symbol_tables: IndexVec, - ast_ids: IndexVec, - use_def_maps: IndexVec>, - scopes_by_node: FxHashMap, - scopes_by_expression: FxHashMap, - definitions_by_node: FxHashMap>, - expressions_by_node: FxHashMap>, -} - -impl<'db> SemanticIndexBuilder<'db> { - pub(super) fn new(db: &'db dyn Db, file: File, parsed: &'db ParsedModule) -> Self { - let mut builder = Self { - db, - file, - module: parsed, - scope_stack: Vec::new(), - current_assignments: vec![], - current_match_case: None, - loop_break_states: vec![], - try_node_context_stack_manager: TryNodeContextStackManager::default(), - - has_future_annotations: false, - - scopes: IndexVec::new(), - symbol_tables: IndexVec::new(), - ast_ids: IndexVec::new(), - scope_ids_by_scope: IndexVec::new(), - use_def_maps: IndexVec::new(), - - scopes_by_expression: FxHashMap::default(), - scopes_by_node: FxHashMap::default(), - definitions_by_node: FxHashMap::default(), - expressions_by_node: FxHashMap::default(), - }; - - builder.push_scope_with_parent(NodeWithScopeRef::Module, None); - - builder - } - - fn current_scope(&self) -> FileScopeId { - *self - .scope_stack - .last() - .expect("Always to have a root scope") - } - - fn push_scope(&mut self, node: NodeWithScopeRef) { - let parent = self.current_scope(); - self.push_scope_with_parent(node, Some(parent)); - } - - fn push_scope_with_parent(&mut self, node: NodeWithScopeRef, parent: Option) { - let children_start = self.scopes.next_index() + 1; - - let scope = Scope { - parent, - kind: node.scope_kind(), - descendents: children_start..children_start, - }; - self.try_node_context_stack_manager.enter_nested_scope(); - - let file_scope_id = self.scopes.push(scope); - self.symbol_tables.push(SymbolTableBuilder::new()); - self.use_def_maps.push(UseDefMapBuilder::new()); - let ast_id_scope = self.ast_ids.push(AstIdsBuilder::new()); - - #[allow(unsafe_code)] - // SAFETY: `node` is guaranteed to be a child of `self.module` - let scope_id = ScopeId::new( - self.db, - self.file, - file_scope_id, - unsafe { node.to_kind(self.module.clone()) }, - countme::Count::default(), - ); - - self.scope_ids_by_scope.push(scope_id); - self.scopes_by_node.insert(node.node_key(), file_scope_id); - - debug_assert_eq!(ast_id_scope, file_scope_id); - - self.scope_stack.push(file_scope_id); - } - - fn pop_scope(&mut self) -> FileScopeId { - let id = self.scope_stack.pop().expect("Root scope to be present"); - let children_end = self.scopes.next_index(); - let scope = &mut self.scopes[id]; - scope.descendents = scope.descendents.start..children_end; - self.try_node_context_stack_manager.exit_scope(); - id - } - - fn current_symbol_table(&mut self) -> &mut SymbolTableBuilder { - let scope_id = self.current_scope(); - &mut self.symbol_tables[scope_id] - } - - fn current_use_def_map_mut(&mut self) -> &mut UseDefMapBuilder<'db> { - let scope_id = self.current_scope(); - &mut self.use_def_maps[scope_id] - } - - fn current_use_def_map(&self) -> &UseDefMapBuilder<'db> { - let scope_id = self.current_scope(); - &self.use_def_maps[scope_id] - } - - fn current_ast_ids(&mut self) -> &mut AstIdsBuilder { - let scope_id = self.current_scope(); - &mut self.ast_ids[scope_id] - } - - fn flow_snapshot(&self) -> FlowSnapshot { - self.current_use_def_map().snapshot() - } - - fn flow_restore(&mut self, state: FlowSnapshot) { - self.current_use_def_map_mut().restore(state); - } - - fn flow_merge(&mut self, state: FlowSnapshot) { - self.current_use_def_map_mut().merge(state); - } - - fn add_symbol(&mut self, name: Name) -> ScopedSymbolId { - let (symbol_id, added) = self.current_symbol_table().add_symbol(name); - if added { - self.current_use_def_map_mut().add_symbol(symbol_id); - } - symbol_id - } - - fn mark_symbol_bound(&mut self, id: ScopedSymbolId) { - self.current_symbol_table().mark_symbol_bound(id); - } - - fn mark_symbol_used(&mut self, id: ScopedSymbolId) { - self.current_symbol_table().mark_symbol_used(id); - } - - fn add_definition<'a>( - &mut self, - symbol: ScopedSymbolId, - definition_node: impl Into>, - ) -> Definition<'db> { - let definition_node: DefinitionNodeRef<'_> = definition_node.into(); - #[allow(unsafe_code)] - // SAFETY: `definition_node` is guaranteed to be a child of `self.module` - let kind = unsafe { definition_node.into_owned(self.module.clone()) }; - let category = kind.category(); - let definition = Definition::new( - self.db, - self.file, - self.current_scope(), - symbol, - kind, - countme::Count::default(), - ); - - let existing_definition = self - .definitions_by_node - .insert(definition_node.key(), definition); - debug_assert_eq!(existing_definition, None); - - if category.is_binding() { - self.mark_symbol_bound(symbol); - } - - let use_def = self.current_use_def_map_mut(); - match category { - DefinitionCategory::DeclarationAndBinding => { - use_def.record_declaration_and_binding(symbol, definition); - } - DefinitionCategory::Declaration => use_def.record_declaration(symbol, definition), - DefinitionCategory::Binding => use_def.record_binding(symbol, definition), - } - - let mut try_node_stack_manager = std::mem::take(&mut self.try_node_context_stack_manager); - try_node_stack_manager.record_definition(self); - self.try_node_context_stack_manager = try_node_stack_manager; - - definition - } - - fn record_expression_constraint(&mut self, constraint_node: &ast::Expr) -> Constraint<'db> { - let constraint = self.build_constraint(constraint_node); - self.record_constraint(constraint); - constraint - } - - fn record_constraint(&mut self, constraint: Constraint<'db>) { - self.current_use_def_map_mut().record_constraint(constraint); - } - - fn build_constraint(&mut self, constraint_node: &Expr) -> Constraint<'db> { - let expression = self.add_standalone_expression(constraint_node); - Constraint { - node: ConstraintNode::Expression(expression), - is_positive: true, - } - } - - fn record_negated_constraint(&mut self, constraint: Constraint<'db>) { - self.current_use_def_map_mut() - .record_constraint(Constraint { - node: constraint.node, - is_positive: false, - }); - } - - fn push_assignment(&mut self, assignment: CurrentAssignment<'db>) { - self.current_assignments.push(assignment); - } - - fn pop_assignment(&mut self) { - let popped_assignment = self.current_assignments.pop(); - debug_assert!(popped_assignment.is_some()); - } - - fn current_assignment(&self) -> Option<&CurrentAssignment<'db>> { - self.current_assignments.last() - } - - fn add_pattern_constraint( - &mut self, - subject: &ast::Expr, - pattern: &ast::Pattern, - ) -> PatternConstraint<'db> { - #[allow(unsafe_code)] - let (subject, pattern) = unsafe { - ( - AstNodeRef::new(self.module.clone(), subject), - AstNodeRef::new(self.module.clone(), pattern), - ) - }; - let pattern_constraint = PatternConstraint::new( - self.db, - self.file, - self.current_scope(), - subject, - pattern, - countme::Count::default(), - ); - self.current_use_def_map_mut() - .record_constraint(Constraint { - node: ConstraintNode::Pattern(pattern_constraint), - is_positive: true, - }); - pattern_constraint - } - - /// Record an expression that needs to be a Salsa ingredient, because we need to infer its type - /// standalone (type narrowing tests, RHS of an assignment.) - fn add_standalone_expression(&mut self, expression_node: &ast::Expr) -> Expression<'db> { - let expression = Expression::new( - self.db, - self.file, - self.current_scope(), - #[allow(unsafe_code)] - unsafe { - AstNodeRef::new(self.module.clone(), expression_node) - }, - countme::Count::default(), - ); - self.expressions_by_node - .insert(expression_node.into(), expression); - expression - } - - fn with_type_params( - &mut self, - with_scope: NodeWithScopeRef, - type_params: Option<&'db ast::TypeParams>, - nested: impl FnOnce(&mut Self) -> FileScopeId, - ) -> FileScopeId { - if let Some(type_params) = type_params { - self.push_scope(with_scope); - - for type_param in &type_params.type_params { - let (name, bound, default) = match type_param { - ast::TypeParam::TypeVar(ast::TypeParamTypeVar { - range: _, - name, - bound, - default, - }) => (name, bound, default), - ast::TypeParam::ParamSpec(ast::TypeParamParamSpec { - name, default, .. - }) => (name, &None, default), - ast::TypeParam::TypeVarTuple(ast::TypeParamTypeVarTuple { - name, - default, - .. - }) => (name, &None, default), - }; - let symbol = self.add_symbol(name.id.clone()); - // TODO create Definition for PEP 695 typevars - // note that the "bound" on the typevar is a totally different thing than whether - // or not a name is "bound" by a typevar declaration; the latter is always true. - self.mark_symbol_bound(symbol); - if let Some(bounds) = bound { - self.visit_expr(bounds); - } - if let Some(default) = default { - self.visit_expr(default); - } - } - } - - let nested_scope = nested(self); - - if type_params.is_some() { - self.pop_scope(); - } - - nested_scope - } - - /// This method does several things: - /// - It pushes a new scope onto the stack for visiting - /// a list/dict/set comprehension or generator expression - /// - Inside that scope, it visits a list of [`Comprehension`] nodes, - /// assumed to be the "generators" that compose a comprehension - /// (that is, the `for x in y` and `for y in z` parts of `x for x in y for y in z`). - /// - Inside that scope, it also calls a closure for visiting the outer `elt` - /// of a list/dict/set comprehension or generator expression - /// - It then pops the new scope off the stack - /// - /// [`Comprehension`]: ast::Comprehension - fn with_generators_scope( - &mut self, - scope: NodeWithScopeRef, - generators: &'db [ast::Comprehension], - visit_outer_elt: impl FnOnce(&mut Self), - ) { - let mut generators_iter = generators.iter(); - - let Some(generator) = generators_iter.next() else { - unreachable!("Expression must contain at least one generator"); - }; - - // The `iter` of the first generator is evaluated in the outer scope, while all subsequent - // nodes are evaluated in the inner scope. - self.add_standalone_expression(&generator.iter); - self.visit_expr(&generator.iter); - self.push_scope(scope); - - self.push_assignment(CurrentAssignment::Comprehension { - node: generator, - first: true, - }); - self.visit_expr(&generator.target); - self.pop_assignment(); - - for expr in &generator.ifs { - self.visit_expr(expr); - } - - for generator in generators_iter { - self.add_standalone_expression(&generator.iter); - self.visit_expr(&generator.iter); - - self.push_assignment(CurrentAssignment::Comprehension { - node: generator, - first: false, - }); - self.visit_expr(&generator.target); - self.pop_assignment(); - - for expr in &generator.ifs { - self.visit_expr(expr); - } - } - - visit_outer_elt(self); - self.pop_scope(); - } - - fn declare_parameter(&mut self, parameter: AnyParameterRef) { - let symbol = self.add_symbol(parameter.name().id().clone()); - - let definition = self.add_definition(symbol, parameter); - - if let AnyParameterRef::NonVariadic(with_default) = parameter { - // Insert a mapping from the parameter to the same definition. - // This ensures that calling `HasTy::ty` on the inner parameter returns - // a valid type (and doesn't panic) - let existing_definition = self.definitions_by_node.insert( - DefinitionNodeRef::from(AnyParameterRef::Variadic(&with_default.parameter)).key(), - definition, - ); - debug_assert_eq!(existing_definition, None); - } - } - - pub(super) fn build(mut self) -> SemanticIndex<'db> { - let module = self.module; - self.visit_body(module.suite()); - - // Pop the root scope - self.pop_scope(); - assert!(self.scope_stack.is_empty()); - - assert_eq!(&self.current_assignments, &[]); - - let mut symbol_tables: IndexVec<_, _> = self - .symbol_tables - .into_iter() - .map(|builder| Arc::new(builder.finish())) - .collect(); - - let mut use_def_maps: IndexVec<_, _> = self - .use_def_maps - .into_iter() - .map(|builder| Arc::new(builder.finish())) - .collect(); - - let mut ast_ids: IndexVec<_, _> = self - .ast_ids - .into_iter() - .map(super::ast_ids::AstIdsBuilder::finish) - .collect(); - - self.scopes.shrink_to_fit(); - symbol_tables.shrink_to_fit(); - use_def_maps.shrink_to_fit(); - ast_ids.shrink_to_fit(); - self.scopes_by_expression.shrink_to_fit(); - self.definitions_by_node.shrink_to_fit(); - - self.scope_ids_by_scope.shrink_to_fit(); - self.scopes_by_node.shrink_to_fit(); - - SemanticIndex { - symbol_tables, - scopes: self.scopes, - definitions_by_node: self.definitions_by_node, - expressions_by_node: self.expressions_by_node, - scope_ids_by_scope: self.scope_ids_by_scope, - ast_ids, - scopes_by_expression: self.scopes_by_expression, - scopes_by_node: self.scopes_by_node, - use_def_maps, - has_future_annotations: self.has_future_annotations, - } - } -} - -impl<'db, 'ast> Visitor<'ast> for SemanticIndexBuilder<'db> -where - 'ast: 'db, -{ - fn visit_stmt(&mut self, stmt: &'ast ast::Stmt) { - match stmt { - ast::Stmt::FunctionDef(function_def) => { - for decorator in &function_def.decorator_list { - self.visit_decorator(decorator); - } - - self.with_type_params( - NodeWithScopeRef::FunctionTypeParameters(function_def), - function_def.type_params.as_deref(), - |builder| { - builder.visit_parameters(&function_def.parameters); - if let Some(expr) = &function_def.returns { - builder.visit_annotation(expr); - } - - builder.push_scope(NodeWithScopeRef::Function(function_def)); - - // Add symbols and definitions for the parameters to the function scope. - for parameter in &*function_def.parameters { - builder.declare_parameter(parameter); - } - - builder.visit_body(&function_def.body); - builder.pop_scope() - }, - ); - // The default value of the parameters needs to be evaluated in the - // enclosing scope. - for default in function_def - .parameters - .iter_non_variadic_params() - .filter_map(|param| param.default.as_deref()) - { - self.visit_expr(default); - } - // The symbol for the function name itself has to be evaluated - // at the end to match the runtime evaluation of parameter defaults - // and return-type annotations. - let symbol = self.add_symbol(function_def.name.id.clone()); - self.add_definition(symbol, function_def); - } - ast::Stmt::ClassDef(class) => { - for decorator in &class.decorator_list { - self.visit_decorator(decorator); - } - - let symbol = self.add_symbol(class.name.id.clone()); - self.add_definition(symbol, class); - - self.with_type_params( - NodeWithScopeRef::ClassTypeParameters(class), - class.type_params.as_deref(), - |builder| { - if let Some(arguments) = &class.arguments { - builder.visit_arguments(arguments); - } - - builder.push_scope(NodeWithScopeRef::Class(class)); - builder.visit_body(&class.body); - - builder.pop_scope() - }, - ); - } - ast::Stmt::Import(node) => { - for alias in &node.names { - let symbol_name = if let Some(asname) = &alias.asname { - asname.id.clone() - } else { - Name::new(alias.name.id.split('.').next().unwrap()) - }; - - let symbol = self.add_symbol(symbol_name); - self.add_definition(symbol, alias); - } - } - ast::Stmt::ImportFrom(node) => { - for (alias_index, alias) in node.names.iter().enumerate() { - let symbol_name = if let Some(asname) = &alias.asname { - &asname.id - } else { - &alias.name.id - }; - - // Look for imports `from __future__ import annotations`, ignore `as ...` - // We intentionally don't enforce the rules about location of `__future__` - // imports here, we assume the user's intent was to apply the `__future__` - // import, so we still check using it (and will also emit a diagnostic about a - // miss-placed `__future__` import.) - self.has_future_annotations |= alias.name.id == "annotations" - && node.module.as_deref() == Some("__future__"); - - let symbol = self.add_symbol(symbol_name.clone()); - - self.add_definition(symbol, ImportFromDefinitionNodeRef { node, alias_index }); - } - } - ast::Stmt::Assign(node) => { - debug_assert_eq!(&self.current_assignments, &[]); - self.visit_expr(&node.value); - self.add_standalone_expression(&node.value); - for (target_index, target) in node.targets.iter().enumerate() { - let kind = match target { - ast::Expr::List(_) | ast::Expr::Tuple(_) => Some(AssignmentKind::Sequence), - ast::Expr::Name(_) => Some(AssignmentKind::Name), - _ => None, - }; - if let Some(kind) = kind { - self.push_assignment(CurrentAssignment::Assign { - assignment: node, - target_index, - kind, - }); - } - self.visit_expr(target); - if kind.is_some() { - // only need to pop in the case where we pushed something - self.pop_assignment(); - } - } - } - ast::Stmt::AnnAssign(node) => { - debug_assert_eq!(&self.current_assignments, &[]); - self.visit_expr(&node.annotation); - if let Some(value) = &node.value { - self.visit_expr(value); - } - self.push_assignment(node.into()); - self.visit_expr(&node.target); - self.pop_assignment(); - } - ast::Stmt::AugAssign( - aug_assign @ ast::StmtAugAssign { - range: _, - target, - op: _, - value, - }, - ) => { - debug_assert_eq!(&self.current_assignments, &[]); - self.visit_expr(value); - self.push_assignment(aug_assign.into()); - self.visit_expr(target); - self.pop_assignment(); - } - ast::Stmt::If(node) => { - self.visit_expr(&node.test); - let pre_if = self.flow_snapshot(); - let constraint = self.record_expression_constraint(&node.test); - let mut constraints = vec![constraint]; - self.visit_body(&node.body); - let mut post_clauses: Vec = vec![]; - for clause in &node.elif_else_clauses { - // snapshot after every block except the last; the last one will just become - // the state that we merge the other snapshots into - post_clauses.push(self.flow_snapshot()); - // we can only take an elif/else branch if none of the previous ones were - // taken, so the block entry state is always `pre_if` - self.flow_restore(pre_if.clone()); - for constraint in &constraints { - self.record_negated_constraint(*constraint); - } - if let Some(elif_test) = &clause.test { - self.visit_expr(elif_test); - constraints.push(self.record_expression_constraint(elif_test)); - } - self.visit_body(&clause.body); - } - for post_clause_state in post_clauses { - self.flow_merge(post_clause_state); - } - let has_else = node - .elif_else_clauses - .last() - .is_some_and(|clause| clause.test.is_none()); - if !has_else { - // if there's no else clause, then it's possible we took none of the branches, - // and the pre_if state can reach here - self.flow_merge(pre_if); - } - } - ast::Stmt::While(ast::StmtWhile { - test, - body, - orelse, - range: _, - }) => { - self.visit_expr(test); - - let pre_loop = self.flow_snapshot(); - - // Save aside any break states from an outer loop - let saved_break_states = std::mem::take(&mut self.loop_break_states); - - // TODO: definitions created inside the body should be fully visible - // to other statements/expressions inside the body --Alex/Carl - self.visit_body(body); - - // Get the break states from the body of this loop, and restore the saved outer - // ones. - let break_states = - std::mem::replace(&mut self.loop_break_states, saved_break_states); - - // We may execute the `else` clause without ever executing the body, so merge in - // the pre-loop state before visiting `else`. - self.flow_merge(pre_loop); - self.visit_body(orelse); - - // Breaking out of a while loop bypasses the `else` clause, so merge in the break - // states after visiting `else`. - for break_state in break_states { - self.flow_merge(break_state); - } - } - ast::Stmt::With(ast::StmtWith { items, body, .. }) => { - for item in items { - self.visit_expr(&item.context_expr); - if let Some(optional_vars) = item.optional_vars.as_deref() { - self.add_standalone_expression(&item.context_expr); - self.push_assignment(item.into()); - self.visit_expr(optional_vars); - self.pop_assignment(); - } - } - self.visit_body(body); - } - ast::Stmt::Break(_) => { - self.loop_break_states.push(self.flow_snapshot()); - } - - ast::Stmt::For( - for_stmt @ ast::StmtFor { - range: _, - is_async: _, - target, - iter, - body, - orelse, - }, - ) => { - self.add_standalone_expression(iter); - self.visit_expr(iter); - - let pre_loop = self.flow_snapshot(); - let saved_break_states = std::mem::take(&mut self.loop_break_states); - - debug_assert_eq!(&self.current_assignments, &[]); - self.push_assignment(for_stmt.into()); - self.visit_expr(target); - self.pop_assignment(); - - // TODO: Definitions created by loop variables - // (and definitions created inside the body) - // are fully visible to other statements/expressions inside the body --Alex/Carl - self.visit_body(body); - - let break_states = - std::mem::replace(&mut self.loop_break_states, saved_break_states); - - // We may execute the `else` clause without ever executing the body, so merge in - // the pre-loop state before visiting `else`. - self.flow_merge(pre_loop); - self.visit_body(orelse); - - // Breaking out of a `for` loop bypasses the `else` clause, so merge in the break - // states after visiting `else`. - for break_state in break_states { - self.flow_merge(break_state); - } - } - ast::Stmt::Match(ast::StmtMatch { - subject, - cases, - range: _, - }) => { - self.add_standalone_expression(subject); - self.visit_expr(subject); - - let after_subject = self.flow_snapshot(); - let Some((first, remaining)) = cases.split_first() else { - return; - }; - self.add_pattern_constraint(subject, &first.pattern); - self.visit_match_case(first); - - let mut post_case_snapshots = vec![]; - for case in remaining { - post_case_snapshots.push(self.flow_snapshot()); - self.flow_restore(after_subject.clone()); - self.add_pattern_constraint(subject, &case.pattern); - self.visit_match_case(case); - } - for post_clause_state in post_case_snapshots { - self.flow_merge(post_clause_state); - } - if !cases - .last() - .is_some_and(|case| case.guard.is_none() && case.pattern.is_wildcard()) - { - self.flow_merge(after_subject); - } - } - ast::Stmt::Try(ast::StmtTry { - body, - handlers, - orelse, - finalbody, - is_star, - range: _, - }) => { - // Save the state prior to visiting any of the `try` block. - // - // Potentially none of the `try` block could have been executed prior to executing - // the `except` block(s) and/or the `finally` block. - // We will merge this state with all of the intermediate - // states during the `try` block before visiting those suites. - let pre_try_block_state = self.flow_snapshot(); - - self.try_node_context_stack_manager.push_context(); - - // Visit the `try` block! - self.visit_body(body); - - let mut post_except_states = vec![]; - - // Take a record also of all the intermediate states we encountered - // while visiting the `try` block - let try_block_snapshots = self.try_node_context_stack_manager.pop_context(); - - if !handlers.is_empty() { - // Save the state immediately *after* visiting the `try` block - // but *before* we prepare for visiting the `except` block(s). - // - // We will revert to this state prior to visiting the the `else` block, - // as there necessarily must have been 0 `except` blocks executed - // if we hit the `else` block. - let post_try_block_state = self.flow_snapshot(); - - // Prepare for visiting the `except` block(s) - self.flow_restore(pre_try_block_state); - for state in try_block_snapshots { - self.flow_merge(state); - } - - let pre_except_state = self.flow_snapshot(); - let num_handlers = handlers.len(); - - for (i, except_handler) in handlers.iter().enumerate() { - let ast::ExceptHandler::ExceptHandler(except_handler) = except_handler; - let ast::ExceptHandlerExceptHandler { - name: symbol_name, - type_: handled_exceptions, - body: handler_body, - range: _, - } = except_handler; - - if let Some(handled_exceptions) = handled_exceptions { - self.visit_expr(handled_exceptions); - } - - // If `handled_exceptions` above was `None`, it's something like `except as e:`, - // which is invalid syntax. However, it's still pretty obvious here that the user - // *wanted* `e` to be bound, so we should still create a definition here nonetheless. - if let Some(symbol_name) = symbol_name { - let symbol = self.add_symbol(symbol_name.id.clone()); - - self.add_definition( - symbol, - DefinitionNodeRef::ExceptHandler(ExceptHandlerDefinitionNodeRef { - handler: except_handler, - is_star: *is_star, - }), - ); - } - - self.visit_body(handler_body); - // Each `except` block is mutually exclusive with all other `except` blocks. - post_except_states.push(self.flow_snapshot()); - - // It's unnecessary to do the `self.flow_restore()` call for the final except handler, - // as we'll immediately call `self.flow_restore()` to a different state - // as soon as this loop over the handlers terminates. - if i < (num_handlers - 1) { - self.flow_restore(pre_except_state.clone()); - } - } - - // If we get to the `else` block, we know that 0 of the `except` blocks can have been executed, - // and the entire `try` block must have been executed: - self.flow_restore(post_try_block_state); - } - - self.visit_body(orelse); - - for post_except_state in post_except_states { - self.flow_merge(post_except_state); - } - - // TODO: there's lots of complexity here that isn't yet handled by our model. - // In order to accurately model the semantics of `finally` suites, we in fact need to visit - // the suite twice: once under the (current) assumption that either the `try + else` suite - // ran to completion or exactly one `except` branch ran to completion, and then again under - // the assumption that potentially none of the branches ran to completion and we in fact - // jumped from a `try`, `else` or `except` branch straight into the `finally` branch. - // This requires rethinking some fundamental assumptions semantic indexing makes. - // For more details, see: - // - https://astral-sh.notion.site/Exception-handler-control-flow-11348797e1ca80bb8ce1e9aedbbe439d - // - https://github.com/astral-sh/ruff/pull/13633#discussion_r1788626702 - self.visit_body(finalbody); - } - _ => { - walk_stmt(self, stmt); - } - } - } - - fn visit_expr(&mut self, expr: &'ast ast::Expr) { - self.scopes_by_expression - .insert(expr.into(), self.current_scope()); - self.current_ast_ids().record_expression(expr); - - match expr { - ast::Expr::Name(name_node @ ast::ExprName { id, ctx, .. }) => { - let (is_use, is_definition) = match (ctx, self.current_assignment()) { - (ast::ExprContext::Store, Some(CurrentAssignment::AugAssign(_))) => { - // For augmented assignment, the target expression is also used. - (true, true) - } - (ast::ExprContext::Load, _) => (true, false), - (ast::ExprContext::Store, _) => (false, true), - (ast::ExprContext::Del, _) => (false, true), - (ast::ExprContext::Invalid, _) => (false, false), - }; - let symbol = self.add_symbol(id.clone()); - - if is_definition { - match self.current_assignment().copied() { - Some(CurrentAssignment::Assign { - assignment, - target_index, - kind, - }) => { - self.add_definition( - symbol, - AssignmentDefinitionNodeRef { - assignment, - target_index, - name: name_node, - kind, - }, - ); - } - Some(CurrentAssignment::AnnAssign(ann_assign)) => { - self.add_definition(symbol, ann_assign); - } - Some(CurrentAssignment::AugAssign(aug_assign)) => { - self.add_definition(symbol, aug_assign); - } - Some(CurrentAssignment::For(node)) => { - self.add_definition( - symbol, - ForStmtDefinitionNodeRef { - iterable: &node.iter, - target: name_node, - is_async: node.is_async, - }, - ); - } - Some(CurrentAssignment::Named(named)) => { - // TODO(dhruvmanila): If the current scope is a comprehension, then the - // named expression is implicitly nonlocal. This is yet to be - // implemented. - self.add_definition(symbol, named); - } - Some(CurrentAssignment::Comprehension { node, first }) => { - self.add_definition( - symbol, - ComprehensionDefinitionNodeRef { - iterable: &node.iter, - target: name_node, - first, - is_async: node.is_async, - }, - ); - } - Some(CurrentAssignment::WithItem(with_item)) => { - self.add_definition( - symbol, - WithItemDefinitionNodeRef { - node: with_item, - target: name_node, - }, - ); - } - None => {} - } - } - - if is_use { - self.mark_symbol_used(symbol); - let use_id = self.current_ast_ids().record_use(expr); - self.current_use_def_map_mut().record_use(symbol, use_id); - } - - walk_expr(self, expr); - } - ast::Expr::Named(node) => { - // TODO walrus in comprehensions is implicitly nonlocal - self.visit_expr(&node.value); - self.push_assignment(node.into()); - self.visit_expr(&node.target); - self.pop_assignment(); - } - ast::Expr::Lambda(lambda) => { - if let Some(parameters) = &lambda.parameters { - // The default value of the parameters needs to be evaluated in the - // enclosing scope. - for default in parameters - .iter_non_variadic_params() - .filter_map(|param| param.default.as_deref()) - { - self.visit_expr(default); - } - self.visit_parameters(parameters); - } - self.push_scope(NodeWithScopeRef::Lambda(lambda)); - - // Add symbols and definitions for the parameters to the lambda scope. - if let Some(parameters) = &lambda.parameters { - for parameter in parameters { - self.declare_parameter(parameter); - } - } - - self.visit_expr(lambda.body.as_ref()); - self.pop_scope(); - } - ast::Expr::If(ast::ExprIf { - body, test, orelse, .. - }) => { - // TODO detect statically known truthy or falsy test (via type inference, not naive - // AST inspection, so we can't simplify here, need to record test expression for - // later checking) - self.visit_expr(test); - let pre_if = self.flow_snapshot(); - self.visit_expr(body); - let post_body = self.flow_snapshot(); - self.flow_restore(pre_if); - self.visit_expr(orelse); - self.flow_merge(post_body); - } - ast::Expr::ListComp( - list_comprehension @ ast::ExprListComp { - elt, generators, .. - }, - ) => { - self.with_generators_scope( - NodeWithScopeRef::ListComprehension(list_comprehension), - generators, - |builder| builder.visit_expr(elt), - ); - } - ast::Expr::SetComp( - set_comprehension @ ast::ExprSetComp { - elt, generators, .. - }, - ) => { - self.with_generators_scope( - NodeWithScopeRef::SetComprehension(set_comprehension), - generators, - |builder| builder.visit_expr(elt), - ); - } - ast::Expr::Generator( - generator @ ast::ExprGenerator { - elt, generators, .. - }, - ) => { - self.with_generators_scope( - NodeWithScopeRef::GeneratorExpression(generator), - generators, - |builder| builder.visit_expr(elt), - ); - } - ast::Expr::DictComp( - dict_comprehension @ ast::ExprDictComp { - key, - value, - generators, - .. - }, - ) => { - self.with_generators_scope( - NodeWithScopeRef::DictComprehension(dict_comprehension), - generators, - |builder| { - builder.visit_expr(key); - builder.visit_expr(value); - }, - ); - } - ast::Expr::BoolOp(ast::ExprBoolOp { - values, - range: _, - op, - }) => { - // TODO detect statically known truthy or falsy values (via type inference, not naive - // AST inspection, so we can't simplify here, need to record test expression for - // later checking) - let mut snapshots = vec![]; - - for (index, value) in values.iter().enumerate() { - self.visit_expr(value); - // In the last value we don't need to take a snapshot nor add a constraint - if index < values.len() - 1 { - // Snapshot is taken after visiting the expression but before adding the constraint. - snapshots.push(self.flow_snapshot()); - let constraint = self.build_constraint(value); - match op { - BoolOp::And => self.record_constraint(constraint), - BoolOp::Or => self.record_negated_constraint(constraint), - } - } - } - for snapshot in snapshots { - self.flow_merge(snapshot); - } - } - _ => { - walk_expr(self, expr); - } - } - } - - fn visit_parameters(&mut self, parameters: &'ast ast::Parameters) { - // Intentionally avoid walking default expressions, as we handle them in the enclosing - // scope. - for parameter in parameters.iter().map(ast::AnyParameterRef::as_parameter) { - self.visit_parameter(parameter); - } - } - - fn visit_match_case(&mut self, match_case: &'ast ast::MatchCase) { - debug_assert!(self.current_match_case.is_none()); - self.current_match_case = Some(CurrentMatchCase::new(&match_case.pattern)); - self.visit_pattern(&match_case.pattern); - self.current_match_case = None; - - if let Some(expr) = &match_case.guard { - self.visit_expr(expr); - } - self.visit_body(&match_case.body); - } - - fn visit_pattern(&mut self, pattern: &'ast ast::Pattern) { - if let ast::Pattern::MatchStar(ast::PatternMatchStar { - name: Some(name), - range: _, - }) = pattern - { - let symbol = self.add_symbol(name.id().clone()); - let state = self.current_match_case.as_ref().unwrap(); - self.add_definition( - symbol, - MatchPatternDefinitionNodeRef { - pattern: state.pattern, - identifier: name, - index: state.index, - }, - ); - } - - walk_pattern(self, pattern); - - if let ast::Pattern::MatchAs(ast::PatternMatchAs { - name: Some(name), .. - }) - | ast::Pattern::MatchMapping(ast::PatternMatchMapping { - rest: Some(name), .. - }) = pattern - { - let symbol = self.add_symbol(name.id().clone()); - let state = self.current_match_case.as_ref().unwrap(); - self.add_definition( - symbol, - MatchPatternDefinitionNodeRef { - pattern: state.pattern, - identifier: name, - index: state.index, - }, - ); - } - - self.current_match_case.as_mut().unwrap().index += 1; - } -} - -#[derive(Copy, Clone, Debug, PartialEq)] -enum CurrentAssignment<'a> { - Assign { - assignment: &'a ast::StmtAssign, - target_index: usize, - kind: AssignmentKind, - }, - AnnAssign(&'a ast::StmtAnnAssign), - AugAssign(&'a ast::StmtAugAssign), - For(&'a ast::StmtFor), - Named(&'a ast::ExprNamed), - Comprehension { - node: &'a ast::Comprehension, - first: bool, - }, - WithItem(&'a ast::WithItem), -} - -impl<'a> From<&'a ast::StmtAnnAssign> for CurrentAssignment<'a> { - fn from(value: &'a ast::StmtAnnAssign) -> Self { - Self::AnnAssign(value) - } -} - -impl<'a> From<&'a ast::StmtAugAssign> for CurrentAssignment<'a> { - fn from(value: &'a ast::StmtAugAssign) -> Self { - Self::AugAssign(value) - } -} - -impl<'a> From<&'a ast::StmtFor> for CurrentAssignment<'a> { - fn from(value: &'a ast::StmtFor) -> Self { - Self::For(value) - } -} - -impl<'a> From<&'a ast::ExprNamed> for CurrentAssignment<'a> { - fn from(value: &'a ast::ExprNamed) -> Self { - Self::Named(value) - } -} - -impl<'a> From<&'a ast::WithItem> for CurrentAssignment<'a> { - fn from(value: &'a ast::WithItem) -> Self { - Self::WithItem(value) - } -} - -struct CurrentMatchCase<'a> { - /// The pattern that's part of the current match case. - pattern: &'a ast::Pattern, - - /// The index of the sub-pattern that's being currently visited within the pattern. - /// - /// For example: - /// ```py - /// match subject: - /// case a as b: ... - /// case [a, b]: ... - /// case a | b: ... - /// ``` - /// - /// In all of the above cases, the index would be 0 for `a` and 1 for `b`. - index: u32, -} - -impl<'a> CurrentMatchCase<'a> { - fn new(pattern: &'a ast::Pattern) -> Self { - Self { pattern, index: 0 } - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/constraint.rs b/crates/red_knot_python_semantic/src/semantic_index/constraint.rs deleted file mode 100644 index 44b542f0e90ac..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/constraint.rs +++ /dev/null @@ -1,45 +0,0 @@ -use ruff_db::files::File; -use ruff_python_ast as ast; - -use crate::ast_node_ref::AstNodeRef; -use crate::db::Db; -use crate::semantic_index::expression::Expression; -use crate::semantic_index::symbol::{FileScopeId, ScopeId}; - -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub(crate) struct Constraint<'db> { - pub(crate) node: ConstraintNode<'db>, - pub(crate) is_positive: bool, -} - -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub(crate) enum ConstraintNode<'db> { - Expression(Expression<'db>), - Pattern(PatternConstraint<'db>), -} - -#[salsa::tracked] -pub(crate) struct PatternConstraint<'db> { - #[id] - pub(crate) file: File, - - #[id] - pub(crate) file_scope: FileScopeId, - - #[no_eq] - #[return_ref] - pub(crate) subject: AstNodeRef, - - #[no_eq] - #[return_ref] - pub(crate) pattern: AstNodeRef, - - #[no_eq] - count: countme::Count>, -} - -impl<'db> PatternConstraint<'db> { - pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { - self.file_scope(db).to_scope_id(db, self.file(db)) - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/definition.rs b/crates/red_knot_python_semantic/src/semantic_index/definition.rs deleted file mode 100644 index 4da4c4e6a71d6..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/definition.rs +++ /dev/null @@ -1,663 +0,0 @@ -use ruff_db::files::File; -use ruff_db::parsed::ParsedModule; -use ruff_python_ast as ast; - -use crate::ast_node_ref::AstNodeRef; -use crate::module_resolver::file_to_module; -use crate::node_key::NodeKey; -use crate::semantic_index::symbol::{FileScopeId, ScopeId, ScopedSymbolId}; -use crate::Db; - -#[salsa::tracked] -pub struct Definition<'db> { - /// The file in which the definition occurs. - #[id] - pub(crate) file: File, - - /// The scope in which the definition occurs. - #[id] - pub(crate) file_scope: FileScopeId, - - /// The symbol defined. - #[id] - pub(crate) symbol: ScopedSymbolId, - - #[no_eq] - #[return_ref] - pub(crate) kind: DefinitionKind, - - #[no_eq] - count: countme::Count>, -} - -impl<'db> Definition<'db> { - pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { - self.file_scope(db).to_scope_id(db, self.file(db)) - } - - pub(crate) fn category(self, db: &'db dyn Db) -> DefinitionCategory { - self.kind(db).category() - } - - pub(crate) fn is_declaration(self, db: &'db dyn Db) -> bool { - self.kind(db).category().is_declaration() - } - - pub(crate) fn is_binding(self, db: &'db dyn Db) -> bool { - self.kind(db).category().is_binding() - } - - pub(crate) fn is_builtin_definition(self, db: &'db dyn Db) -> bool { - file_to_module(db, self.file(db)).is_some_and(|module| { - module.search_path().is_standard_library() && matches!(&**module.name(), "builtins") - }) - } - - /// Return true if this symbol was defined in the `typing` or `typing_extensions` modules - pub(crate) fn is_typing_definition(self, db: &'db dyn Db) -> bool { - file_to_module(db, self.file(db)).is_some_and(|module| { - module.search_path().is_standard_library() - && matches!(&**module.name(), "typing" | "typing_extensions") - }) - } -} - -#[derive(Copy, Clone, Debug)] -pub(crate) enum DefinitionNodeRef<'a> { - Import(&'a ast::Alias), - ImportFrom(ImportFromDefinitionNodeRef<'a>), - For(ForStmtDefinitionNodeRef<'a>), - Function(&'a ast::StmtFunctionDef), - Class(&'a ast::StmtClassDef), - NamedExpression(&'a ast::ExprNamed), - Assignment(AssignmentDefinitionNodeRef<'a>), - AnnotatedAssignment(&'a ast::StmtAnnAssign), - AugmentedAssignment(&'a ast::StmtAugAssign), - Comprehension(ComprehensionDefinitionNodeRef<'a>), - Parameter(ast::AnyParameterRef<'a>), - WithItem(WithItemDefinitionNodeRef<'a>), - MatchPattern(MatchPatternDefinitionNodeRef<'a>), - ExceptHandler(ExceptHandlerDefinitionNodeRef<'a>), -} - -impl<'a> From<&'a ast::StmtFunctionDef> for DefinitionNodeRef<'a> { - fn from(node: &'a ast::StmtFunctionDef) -> Self { - Self::Function(node) - } -} - -impl<'a> From<&'a ast::StmtClassDef> for DefinitionNodeRef<'a> { - fn from(node: &'a ast::StmtClassDef) -> Self { - Self::Class(node) - } -} - -impl<'a> From<&'a ast::ExprNamed> for DefinitionNodeRef<'a> { - fn from(node: &'a ast::ExprNamed) -> Self { - Self::NamedExpression(node) - } -} - -impl<'a> From<&'a ast::StmtAnnAssign> for DefinitionNodeRef<'a> { - fn from(node: &'a ast::StmtAnnAssign) -> Self { - Self::AnnotatedAssignment(node) - } -} - -impl<'a> From<&'a ast::StmtAugAssign> for DefinitionNodeRef<'a> { - fn from(node: &'a ast::StmtAugAssign) -> Self { - Self::AugmentedAssignment(node) - } -} - -impl<'a> From<&'a ast::Alias> for DefinitionNodeRef<'a> { - fn from(node_ref: &'a ast::Alias) -> Self { - Self::Import(node_ref) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node_ref: ImportFromDefinitionNodeRef<'a>) -> Self { - Self::ImportFrom(node_ref) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(value: ForStmtDefinitionNodeRef<'a>) -> Self { - Self::For(value) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node_ref: AssignmentDefinitionNodeRef<'a>) -> Self { - Self::Assignment(node_ref) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node_ref: WithItemDefinitionNodeRef<'a>) -> Self { - Self::WithItem(node_ref) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node: ComprehensionDefinitionNodeRef<'a>) -> Self { - Self::Comprehension(node) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node: ast::AnyParameterRef<'a>) -> Self { - Self::Parameter(node) - } -} - -impl<'a> From> for DefinitionNodeRef<'a> { - fn from(node: MatchPatternDefinitionNodeRef<'a>) -> Self { - Self::MatchPattern(node) - } -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct ImportFromDefinitionNodeRef<'a> { - pub(crate) node: &'a ast::StmtImportFrom, - pub(crate) alias_index: usize, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct AssignmentDefinitionNodeRef<'a> { - pub(crate) assignment: &'a ast::StmtAssign, - pub(crate) target_index: usize, - pub(crate) name: &'a ast::ExprName, - pub(crate) kind: AssignmentKind, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct WithItemDefinitionNodeRef<'a> { - pub(crate) node: &'a ast::WithItem, - pub(crate) target: &'a ast::ExprName, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct ForStmtDefinitionNodeRef<'a> { - pub(crate) iterable: &'a ast::Expr, - pub(crate) target: &'a ast::ExprName, - pub(crate) is_async: bool, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct ExceptHandlerDefinitionNodeRef<'a> { - pub(crate) handler: &'a ast::ExceptHandlerExceptHandler, - pub(crate) is_star: bool, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct ComprehensionDefinitionNodeRef<'a> { - pub(crate) iterable: &'a ast::Expr, - pub(crate) target: &'a ast::ExprName, - pub(crate) first: bool, - pub(crate) is_async: bool, -} - -#[derive(Copy, Clone, Debug)] -pub(crate) struct MatchPatternDefinitionNodeRef<'a> { - /// The outermost pattern node in which the identifier being defined occurs. - pub(crate) pattern: &'a ast::Pattern, - /// The identifier being defined. - pub(crate) identifier: &'a ast::Identifier, - /// The index of the identifier in the pattern when visiting the `pattern` node in evaluation - /// order. - pub(crate) index: u32, -} - -impl DefinitionNodeRef<'_> { - #[allow(unsafe_code)] - pub(super) unsafe fn into_owned(self, parsed: ParsedModule) -> DefinitionKind { - match self { - DefinitionNodeRef::Import(alias) => { - DefinitionKind::Import(AstNodeRef::new(parsed, alias)) - } - DefinitionNodeRef::ImportFrom(ImportFromDefinitionNodeRef { node, alias_index }) => { - DefinitionKind::ImportFrom(ImportFromDefinitionKind { - node: AstNodeRef::new(parsed, node), - alias_index, - }) - } - DefinitionNodeRef::Function(function) => { - DefinitionKind::Function(AstNodeRef::new(parsed, function)) - } - DefinitionNodeRef::Class(class) => { - DefinitionKind::Class(AstNodeRef::new(parsed, class)) - } - DefinitionNodeRef::NamedExpression(named) => { - DefinitionKind::NamedExpression(AstNodeRef::new(parsed, named)) - } - DefinitionNodeRef::Assignment(AssignmentDefinitionNodeRef { - assignment, - target_index, - name, - kind, - }) => DefinitionKind::Assignment(AssignmentDefinitionKind { - assignment: AstNodeRef::new(parsed.clone(), assignment), - target_index, - name: AstNodeRef::new(parsed, name), - kind, - }), - DefinitionNodeRef::AnnotatedAssignment(assign) => { - DefinitionKind::AnnotatedAssignment(AstNodeRef::new(parsed, assign)) - } - DefinitionNodeRef::AugmentedAssignment(augmented_assignment) => { - DefinitionKind::AugmentedAssignment(AstNodeRef::new(parsed, augmented_assignment)) - } - DefinitionNodeRef::For(ForStmtDefinitionNodeRef { - iterable, - target, - is_async, - }) => DefinitionKind::For(ForStmtDefinitionKind { - iterable: AstNodeRef::new(parsed.clone(), iterable), - target: AstNodeRef::new(parsed, target), - is_async, - }), - DefinitionNodeRef::Comprehension(ComprehensionDefinitionNodeRef { - iterable, - target, - first, - is_async, - }) => DefinitionKind::Comprehension(ComprehensionDefinitionKind { - iterable: AstNodeRef::new(parsed.clone(), iterable), - target: AstNodeRef::new(parsed, target), - first, - is_async, - }), - DefinitionNodeRef::Parameter(parameter) => match parameter { - ast::AnyParameterRef::Variadic(parameter) => { - DefinitionKind::Parameter(AstNodeRef::new(parsed, parameter)) - } - ast::AnyParameterRef::NonVariadic(parameter) => { - DefinitionKind::ParameterWithDefault(AstNodeRef::new(parsed, parameter)) - } - }, - DefinitionNodeRef::WithItem(WithItemDefinitionNodeRef { node, target }) => { - DefinitionKind::WithItem(WithItemDefinitionKind { - node: AstNodeRef::new(parsed.clone(), node), - target: AstNodeRef::new(parsed, target), - }) - } - DefinitionNodeRef::MatchPattern(MatchPatternDefinitionNodeRef { - pattern, - identifier, - index, - }) => DefinitionKind::MatchPattern(MatchPatternDefinitionKind { - pattern: AstNodeRef::new(parsed.clone(), pattern), - identifier: AstNodeRef::new(parsed, identifier), - index, - }), - DefinitionNodeRef::ExceptHandler(ExceptHandlerDefinitionNodeRef { - handler, - is_star, - }) => DefinitionKind::ExceptHandler(ExceptHandlerDefinitionKind { - handler: AstNodeRef::new(parsed, handler), - is_star, - }), - } - } - - pub(super) fn key(self) -> DefinitionNodeKey { - match self { - Self::Import(node) => node.into(), - Self::ImportFrom(ImportFromDefinitionNodeRef { node, alias_index }) => { - (&node.names[alias_index]).into() - } - Self::Function(node) => node.into(), - Self::Class(node) => node.into(), - Self::NamedExpression(node) => node.into(), - Self::Assignment(AssignmentDefinitionNodeRef { - assignment: _, - target_index: _, - name, - kind: _, - }) => name.into(), - Self::AnnotatedAssignment(node) => node.into(), - Self::AugmentedAssignment(node) => node.into(), - Self::For(ForStmtDefinitionNodeRef { - iterable: _, - target, - is_async: _, - }) => target.into(), - Self::Comprehension(ComprehensionDefinitionNodeRef { target, .. }) => target.into(), - Self::Parameter(node) => match node { - ast::AnyParameterRef::Variadic(parameter) => parameter.into(), - ast::AnyParameterRef::NonVariadic(parameter) => parameter.into(), - }, - Self::WithItem(WithItemDefinitionNodeRef { node: _, target }) => target.into(), - Self::MatchPattern(MatchPatternDefinitionNodeRef { identifier, .. }) => { - identifier.into() - } - Self::ExceptHandler(ExceptHandlerDefinitionNodeRef { handler, .. }) => handler.into(), - } - } -} - -#[derive(Clone, Copy, Debug)] -pub(crate) enum DefinitionCategory { - /// A Definition which binds a value to a name (e.g. `x = 1`). - Binding, - /// A Definition which declares the upper-bound of acceptable types for this name (`x: int`). - Declaration, - /// A Definition which both declares a type and binds a value (e.g. `x: int = 1`). - DeclarationAndBinding, -} - -impl DefinitionCategory { - /// True if this definition establishes a "declared type" for the symbol. - /// - /// If so, any assignments reached by this definition are in error if they assign a value of a - /// type not assignable to the declared type. - /// - /// Annotations establish a declared type. So do function and class definitions, and imports. - pub(crate) fn is_declaration(self) -> bool { - matches!( - self, - DefinitionCategory::Declaration | DefinitionCategory::DeclarationAndBinding - ) - } - - /// True if this definition assigns a value to the symbol. - /// - /// False only for annotated assignments without a RHS. - pub(crate) fn is_binding(self) -> bool { - matches!( - self, - DefinitionCategory::Binding | DefinitionCategory::DeclarationAndBinding - ) - } -} - -#[derive(Clone, Debug)] -pub enum DefinitionKind { - Import(AstNodeRef), - ImportFrom(ImportFromDefinitionKind), - Function(AstNodeRef), - Class(AstNodeRef), - NamedExpression(AstNodeRef), - Assignment(AssignmentDefinitionKind), - AnnotatedAssignment(AstNodeRef), - AugmentedAssignment(AstNodeRef), - For(ForStmtDefinitionKind), - Comprehension(ComprehensionDefinitionKind), - Parameter(AstNodeRef), - ParameterWithDefault(AstNodeRef), - WithItem(WithItemDefinitionKind), - MatchPattern(MatchPatternDefinitionKind), - ExceptHandler(ExceptHandlerDefinitionKind), -} - -impl DefinitionKind { - pub(crate) fn category(&self) -> DefinitionCategory { - match self { - // functions, classes, and imports always bind, and we consider them declarations - DefinitionKind::Function(_) - | DefinitionKind::Class(_) - | DefinitionKind::Import(_) - | DefinitionKind::ImportFrom(_) => DefinitionCategory::DeclarationAndBinding, - // a parameter always binds a value, but is only a declaration if annotated - DefinitionKind::Parameter(parameter) => { - if parameter.annotation.is_some() { - DefinitionCategory::DeclarationAndBinding - } else { - DefinitionCategory::Binding - } - } - // presence of a default is irrelevant, same logic as for a no-default parameter - DefinitionKind::ParameterWithDefault(parameter_with_default) => { - if parameter_with_default.parameter.annotation.is_some() { - DefinitionCategory::DeclarationAndBinding - } else { - DefinitionCategory::Binding - } - } - // annotated assignment is always a declaration, only a binding if there is a RHS - DefinitionKind::AnnotatedAssignment(ann_assign) => { - if ann_assign.value.is_some() { - DefinitionCategory::DeclarationAndBinding - } else { - DefinitionCategory::Declaration - } - } - // all of these bind values without declaring a type - DefinitionKind::NamedExpression(_) - | DefinitionKind::Assignment(_) - | DefinitionKind::AugmentedAssignment(_) - | DefinitionKind::For(_) - | DefinitionKind::Comprehension(_) - | DefinitionKind::WithItem(_) - | DefinitionKind::MatchPattern(_) - | DefinitionKind::ExceptHandler(_) => DefinitionCategory::Binding, - } - } -} - -#[derive(Clone, Debug)] -#[allow(dead_code)] -pub struct MatchPatternDefinitionKind { - pattern: AstNodeRef, - identifier: AstNodeRef, - index: u32, -} - -impl MatchPatternDefinitionKind { - pub(crate) fn pattern(&self) -> &ast::Pattern { - self.pattern.node() - } - - pub(crate) fn index(&self) -> u32 { - self.index - } -} - -#[derive(Clone, Debug)] -pub struct ComprehensionDefinitionKind { - iterable: AstNodeRef, - target: AstNodeRef, - first: bool, - is_async: bool, -} - -impl ComprehensionDefinitionKind { - pub(crate) fn iterable(&self) -> &ast::Expr { - self.iterable.node() - } - - pub(crate) fn target(&self) -> &ast::ExprName { - self.target.node() - } - - pub(crate) fn is_first(&self) -> bool { - self.first - } - - pub(crate) fn is_async(&self) -> bool { - self.is_async - } -} - -#[derive(Clone, Debug)] -pub struct ImportFromDefinitionKind { - node: AstNodeRef, - alias_index: usize, -} - -impl ImportFromDefinitionKind { - pub(crate) fn import(&self) -> &ast::StmtImportFrom { - self.node.node() - } - - pub(crate) fn alias(&self) -> &ast::Alias { - &self.node.node().names[self.alias_index] - } -} - -#[derive(Clone, Debug)] -pub struct AssignmentDefinitionKind { - assignment: AstNodeRef, - target_index: usize, - name: AstNodeRef, - kind: AssignmentKind, -} - -impl AssignmentDefinitionKind { - pub(crate) fn value(&self) -> &ast::Expr { - &self.assignment.node().value - } - - pub(crate) fn target(&self) -> &ast::Expr { - &self.assignment.node().targets[self.target_index] - } - - pub(crate) fn name(&self) -> &ast::ExprName { - self.name.node() - } - - pub(crate) fn kind(&self) -> AssignmentKind { - self.kind - } -} - -/// The kind of assignment target expression. -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub enum AssignmentKind { - Sequence, - Name, -} - -#[derive(Clone, Debug)] -pub struct WithItemDefinitionKind { - node: AstNodeRef, - target: AstNodeRef, -} - -impl WithItemDefinitionKind { - pub(crate) fn node(&self) -> &ast::WithItem { - self.node.node() - } - - pub(crate) fn target(&self) -> &ast::ExprName { - self.target.node() - } -} - -#[derive(Clone, Debug)] -pub struct ForStmtDefinitionKind { - iterable: AstNodeRef, - target: AstNodeRef, - is_async: bool, -} - -impl ForStmtDefinitionKind { - pub(crate) fn iterable(&self) -> &ast::Expr { - self.iterable.node() - } - - pub(crate) fn target(&self) -> &ast::ExprName { - self.target.node() - } - - pub(crate) fn is_async(&self) -> bool { - self.is_async - } -} - -#[derive(Clone, Debug)] -pub struct ExceptHandlerDefinitionKind { - handler: AstNodeRef, - is_star: bool, -} - -impl ExceptHandlerDefinitionKind { - pub(crate) fn node(&self) -> &ast::ExceptHandlerExceptHandler { - self.handler.node() - } - - pub(crate) fn handled_exceptions(&self) -> Option<&ast::Expr> { - self.node().type_.as_deref() - } - - pub(crate) fn is_star(&self) -> bool { - self.is_star - } -} - -#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)] -pub(crate) struct DefinitionNodeKey(NodeKey); - -impl From<&ast::Alias> for DefinitionNodeKey { - fn from(node: &ast::Alias) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::StmtFunctionDef> for DefinitionNodeKey { - fn from(node: &ast::StmtFunctionDef) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::StmtClassDef> for DefinitionNodeKey { - fn from(node: &ast::StmtClassDef) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::ExprName> for DefinitionNodeKey { - fn from(node: &ast::ExprName) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::ExprNamed> for DefinitionNodeKey { - fn from(node: &ast::ExprNamed) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::StmtAnnAssign> for DefinitionNodeKey { - fn from(node: &ast::StmtAnnAssign) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::StmtAugAssign> for DefinitionNodeKey { - fn from(node: &ast::StmtAugAssign) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::StmtFor> for DefinitionNodeKey { - fn from(value: &ast::StmtFor) -> Self { - Self(NodeKey::from_node(value)) - } -} - -impl From<&ast::Parameter> for DefinitionNodeKey { - fn from(node: &ast::Parameter) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::ParameterWithDefault> for DefinitionNodeKey { - fn from(node: &ast::ParameterWithDefault) -> Self { - Self(NodeKey::from_node(node)) - } -} - -impl From<&ast::Identifier> for DefinitionNodeKey { - fn from(identifier: &ast::Identifier) -> Self { - Self(NodeKey::from_node(identifier)) - } -} - -impl From<&ast::ExceptHandlerExceptHandler> for DefinitionNodeKey { - fn from(handler: &ast::ExceptHandlerExceptHandler) -> Self { - Self(NodeKey::from_node(handler)) - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/expression.rs b/crates/red_knot_python_semantic/src/semantic_index/expression.rs deleted file mode 100644 index 4a7582bc32243..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/expression.rs +++ /dev/null @@ -1,34 +0,0 @@ -use crate::ast_node_ref::AstNodeRef; -use crate::db::Db; -use crate::semantic_index::symbol::{FileScopeId, ScopeId}; -use ruff_db::files::File; -use ruff_python_ast as ast; -use salsa; - -/// An independently type-inferable expression. -/// -/// Includes constraint expressions (e.g. if tests) and the RHS of an unpacking assignment. -#[salsa::tracked] -pub(crate) struct Expression<'db> { - /// The file in which the expression occurs. - #[id] - pub(crate) file: File, - - /// The scope in which the expression occurs. - #[id] - pub(crate) file_scope: FileScopeId, - - /// The expression node. - #[no_eq] - #[return_ref] - pub(crate) node_ref: AstNodeRef, - - #[no_eq] - count: countme::Count>, -} - -impl<'db> Expression<'db> { - pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { - self.file_scope(db).to_scope_id(db, self.file(db)) - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/symbol.rs b/crates/red_knot_python_semantic/src/semantic_index/symbol.rs deleted file mode 100644 index eeab9bf16907d..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/symbol.rs +++ /dev/null @@ -1,439 +0,0 @@ -use std::hash::{Hash, Hasher}; -use std::ops::Range; - -use bitflags::bitflags; -use hashbrown::hash_map::RawEntryMut; -use ruff_db::files::File; -use ruff_db::parsed::ParsedModule; -use ruff_index::{newtype_index, IndexVec}; -use ruff_python_ast::name::Name; -use ruff_python_ast::{self as ast}; -use rustc_hash::FxHasher; - -use crate::ast_node_ref::AstNodeRef; -use crate::node_key::NodeKey; -use crate::semantic_index::{semantic_index, SymbolMap}; -use crate::Db; - -#[derive(Eq, PartialEq, Debug)] -pub struct Symbol { - name: Name, - flags: SymbolFlags, -} - -impl Symbol { - fn new(name: Name) -> Self { - Self { - name, - flags: SymbolFlags::empty(), - } - } - - fn insert_flags(&mut self, flags: SymbolFlags) { - self.flags.insert(flags); - } - - /// The symbol's name. - pub fn name(&self) -> &Name { - &self.name - } - - /// Is the symbol used in its containing scope? - pub fn is_used(&self) -> bool { - self.flags.contains(SymbolFlags::IS_USED) - } - - /// Is the symbol defined in its containing scope? - pub fn is_bound(&self) -> bool { - self.flags.contains(SymbolFlags::IS_BOUND) - } -} - -bitflags! { - #[derive(Copy, Clone, Debug, Eq, PartialEq)] - struct SymbolFlags: u8 { - const IS_USED = 1 << 0; - const IS_BOUND = 1 << 1; - /// TODO: This flag is not yet set by anything - const MARKED_GLOBAL = 1 << 2; - /// TODO: This flag is not yet set by anything - const MARKED_NONLOCAL = 1 << 3; - } -} - -/// ID that uniquely identifies a symbol in a file. -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -pub struct FileSymbolId { - scope: FileScopeId, - scoped_symbol_id: ScopedSymbolId, -} - -impl FileSymbolId { - pub fn scope(self) -> FileScopeId { - self.scope - } - - pub(crate) fn scoped_symbol_id(self) -> ScopedSymbolId { - self.scoped_symbol_id - } -} - -impl From for ScopedSymbolId { - fn from(val: FileSymbolId) -> Self { - val.scoped_symbol_id() - } -} - -/// Symbol ID that uniquely identifies a symbol inside a [`Scope`]. -#[newtype_index] -pub struct ScopedSymbolId; - -/// A cross-module identifier of a scope that can be used as a salsa query parameter. -#[salsa::tracked] -pub struct ScopeId<'db> { - #[id] - pub file: File, - #[id] - pub file_scope_id: FileScopeId, - - /// The node that introduces this scope. - #[no_eq] - #[return_ref] - pub node: NodeWithScopeKind, - - #[no_eq] - count: countme::Count>, -} - -impl<'db> ScopeId<'db> { - pub(crate) fn is_function_like(self, db: &'db dyn Db) -> bool { - // Type parameter scopes behave like function scopes in terms of name resolution; CPython - // symbol table also uses the term "function-like" for these scopes. - matches!( - self.node(db), - NodeWithScopeKind::ClassTypeParameters(_) - | NodeWithScopeKind::FunctionTypeParameters(_) - | NodeWithScopeKind::Function(_) - | NodeWithScopeKind::ListComprehension(_) - | NodeWithScopeKind::SetComprehension(_) - | NodeWithScopeKind::DictComprehension(_) - | NodeWithScopeKind::GeneratorExpression(_) - ) - } - - #[cfg(test)] - pub(crate) fn name(self, db: &'db dyn Db) -> &'db str { - match self.node(db) { - NodeWithScopeKind::Module => "", - NodeWithScopeKind::Class(class) | NodeWithScopeKind::ClassTypeParameters(class) => { - class.name.as_str() - } - NodeWithScopeKind::Function(function) - | NodeWithScopeKind::FunctionTypeParameters(function) => function.name.as_str(), - NodeWithScopeKind::Lambda(_) => "", - NodeWithScopeKind::ListComprehension(_) => "", - NodeWithScopeKind::SetComprehension(_) => "", - NodeWithScopeKind::DictComprehension(_) => "", - NodeWithScopeKind::GeneratorExpression(_) => "", - } - } -} - -/// ID that uniquely identifies a scope inside of a module. -#[newtype_index] -pub struct FileScopeId; - -impl FileScopeId { - /// Returns the scope id of the module-global scope. - pub fn global() -> Self { - FileScopeId::from_u32(0) - } - - pub fn is_global(self) -> bool { - self == FileScopeId::global() - } - - pub fn to_scope_id(self, db: &dyn Db, file: File) -> ScopeId<'_> { - let index = semantic_index(db, file); - index.scope_ids_by_scope[self] - } -} - -#[derive(Debug, Eq, PartialEq)] -pub struct Scope { - pub(super) parent: Option, - pub(super) kind: ScopeKind, - pub(super) descendents: Range, -} - -impl Scope { - pub fn parent(self) -> Option { - self.parent - } - - pub fn kind(&self) -> ScopeKind { - self.kind - } -} - -#[derive(Copy, Clone, Debug, PartialEq, Eq)] -pub enum ScopeKind { - Module, - Annotation, - Class, - Function, - Comprehension, -} - -impl ScopeKind { - pub const fn is_comprehension(self) -> bool { - matches!(self, ScopeKind::Comprehension) - } -} - -/// Symbol table for a specific [`Scope`]. -#[derive(Debug)] -pub struct SymbolTable { - /// The symbols in this scope. - symbols: IndexVec, - - /// The symbols indexed by name. - symbols_by_name: SymbolMap, -} - -impl SymbolTable { - fn new() -> Self { - Self { - symbols: IndexVec::new(), - symbols_by_name: SymbolMap::default(), - } - } - - fn shrink_to_fit(&mut self) { - self.symbols.shrink_to_fit(); - } - - pub(crate) fn symbol(&self, symbol_id: impl Into) -> &Symbol { - &self.symbols[symbol_id.into()] - } - - #[allow(unused)] - pub(crate) fn symbol_ids(&self) -> impl Iterator { - self.symbols.indices() - } - - pub fn symbols(&self) -> impl Iterator { - self.symbols.iter() - } - - /// Returns the symbol named `name`. - pub(crate) fn symbol_by_name(&self, name: &str) -> Option<&Symbol> { - let id = self.symbol_id_by_name(name)?; - Some(self.symbol(id)) - } - - /// Returns the [`ScopedSymbolId`] of the symbol named `name`. - pub(crate) fn symbol_id_by_name(&self, name: &str) -> Option { - let (id, ()) = self - .symbols_by_name - .raw_entry() - .from_hash(Self::hash_name(name), |id| { - self.symbol(*id).name().as_str() == name - })?; - - Some(*id) - } - - fn hash_name(name: &str) -> u64 { - let mut hasher = FxHasher::default(); - name.hash(&mut hasher); - hasher.finish() - } -} - -impl PartialEq for SymbolTable { - fn eq(&self, other: &Self) -> bool { - // We don't need to compare the symbols_by_name because the name is already captured in `Symbol`. - self.symbols == other.symbols - } -} - -impl Eq for SymbolTable {} - -#[derive(Debug)] -pub(super) struct SymbolTableBuilder { - table: SymbolTable, -} - -impl SymbolTableBuilder { - pub(super) fn new() -> Self { - Self { - table: SymbolTable::new(), - } - } - - pub(super) fn add_symbol(&mut self, name: Name) -> (ScopedSymbolId, bool) { - let hash = SymbolTable::hash_name(&name); - let entry = self - .table - .symbols_by_name - .raw_entry_mut() - .from_hash(hash, |id| self.table.symbols[*id].name() == &name); - - match entry { - RawEntryMut::Occupied(entry) => (*entry.key(), false), - RawEntryMut::Vacant(entry) => { - let symbol = Symbol::new(name); - - let id = self.table.symbols.push(symbol); - entry.insert_with_hasher(hash, id, (), |id| { - SymbolTable::hash_name(self.table.symbols[*id].name().as_str()) - }); - (id, true) - } - } - } - - pub(super) fn mark_symbol_bound(&mut self, id: ScopedSymbolId) { - self.table.symbols[id].insert_flags(SymbolFlags::IS_BOUND); - } - - pub(super) fn mark_symbol_used(&mut self, id: ScopedSymbolId) { - self.table.symbols[id].insert_flags(SymbolFlags::IS_USED); - } - - pub(super) fn finish(mut self) -> SymbolTable { - self.table.shrink_to_fit(); - self.table - } -} - -/// Reference to a node that introduces a new scope. -#[derive(Copy, Clone, Debug)] -pub(crate) enum NodeWithScopeRef<'a> { - Module, - Class(&'a ast::StmtClassDef), - Function(&'a ast::StmtFunctionDef), - Lambda(&'a ast::ExprLambda), - FunctionTypeParameters(&'a ast::StmtFunctionDef), - ClassTypeParameters(&'a ast::StmtClassDef), - ListComprehension(&'a ast::ExprListComp), - SetComprehension(&'a ast::ExprSetComp), - DictComprehension(&'a ast::ExprDictComp), - GeneratorExpression(&'a ast::ExprGenerator), -} - -impl NodeWithScopeRef<'_> { - /// Converts the unowned reference to an owned [`NodeWithScopeKind`]. - /// - /// # Safety - /// The node wrapped by `self` must be a child of `module`. - #[allow(unsafe_code)] - pub(super) unsafe fn to_kind(self, module: ParsedModule) -> NodeWithScopeKind { - match self { - NodeWithScopeRef::Module => NodeWithScopeKind::Module, - NodeWithScopeRef::Class(class) => { - NodeWithScopeKind::Class(AstNodeRef::new(module, class)) - } - NodeWithScopeRef::Function(function) => { - NodeWithScopeKind::Function(AstNodeRef::new(module, function)) - } - NodeWithScopeRef::Lambda(lambda) => { - NodeWithScopeKind::Lambda(AstNodeRef::new(module, lambda)) - } - NodeWithScopeRef::FunctionTypeParameters(function) => { - NodeWithScopeKind::FunctionTypeParameters(AstNodeRef::new(module, function)) - } - NodeWithScopeRef::ClassTypeParameters(class) => { - NodeWithScopeKind::ClassTypeParameters(AstNodeRef::new(module, class)) - } - NodeWithScopeRef::ListComprehension(comprehension) => { - NodeWithScopeKind::ListComprehension(AstNodeRef::new(module, comprehension)) - } - NodeWithScopeRef::SetComprehension(comprehension) => { - NodeWithScopeKind::SetComprehension(AstNodeRef::new(module, comprehension)) - } - NodeWithScopeRef::DictComprehension(comprehension) => { - NodeWithScopeKind::DictComprehension(AstNodeRef::new(module, comprehension)) - } - NodeWithScopeRef::GeneratorExpression(generator) => { - NodeWithScopeKind::GeneratorExpression(AstNodeRef::new(module, generator)) - } - } - } - - pub(super) fn scope_kind(self) -> ScopeKind { - match self { - NodeWithScopeRef::Module => ScopeKind::Module, - NodeWithScopeRef::Class(_) => ScopeKind::Class, - NodeWithScopeRef::Function(_) => ScopeKind::Function, - NodeWithScopeRef::Lambda(_) => ScopeKind::Function, - NodeWithScopeRef::FunctionTypeParameters(_) - | NodeWithScopeRef::ClassTypeParameters(_) => ScopeKind::Annotation, - NodeWithScopeRef::ListComprehension(_) - | NodeWithScopeRef::SetComprehension(_) - | NodeWithScopeRef::DictComprehension(_) - | NodeWithScopeRef::GeneratorExpression(_) => ScopeKind::Comprehension, - } - } - - pub(crate) fn node_key(self) -> NodeWithScopeKey { - match self { - NodeWithScopeRef::Module => NodeWithScopeKey::Module, - NodeWithScopeRef::Class(class) => NodeWithScopeKey::Class(NodeKey::from_node(class)), - NodeWithScopeRef::Function(function) => { - NodeWithScopeKey::Function(NodeKey::from_node(function)) - } - NodeWithScopeRef::Lambda(lambda) => { - NodeWithScopeKey::Lambda(NodeKey::from_node(lambda)) - } - NodeWithScopeRef::FunctionTypeParameters(function) => { - NodeWithScopeKey::FunctionTypeParameters(NodeKey::from_node(function)) - } - NodeWithScopeRef::ClassTypeParameters(class) => { - NodeWithScopeKey::ClassTypeParameters(NodeKey::from_node(class)) - } - NodeWithScopeRef::ListComprehension(comprehension) => { - NodeWithScopeKey::ListComprehension(NodeKey::from_node(comprehension)) - } - NodeWithScopeRef::SetComprehension(comprehension) => { - NodeWithScopeKey::SetComprehension(NodeKey::from_node(comprehension)) - } - NodeWithScopeRef::DictComprehension(comprehension) => { - NodeWithScopeKey::DictComprehension(NodeKey::from_node(comprehension)) - } - NodeWithScopeRef::GeneratorExpression(generator) => { - NodeWithScopeKey::GeneratorExpression(NodeKey::from_node(generator)) - } - } - } -} - -/// Node that introduces a new scope. -#[derive(Clone, Debug)] -pub enum NodeWithScopeKind { - Module, - Class(AstNodeRef), - ClassTypeParameters(AstNodeRef), - Function(AstNodeRef), - FunctionTypeParameters(AstNodeRef), - Lambda(AstNodeRef), - ListComprehension(AstNodeRef), - SetComprehension(AstNodeRef), - DictComprehension(AstNodeRef), - GeneratorExpression(AstNodeRef), -} - -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -pub(crate) enum NodeWithScopeKey { - Module, - Class(NodeKey), - ClassTypeParameters(NodeKey), - Function(NodeKey), - FunctionTypeParameters(NodeKey), - Lambda(NodeKey), - ListComprehension(NodeKey), - SetComprehension(NodeKey), - DictComprehension(NodeKey), - GeneratorExpression(NodeKey), -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/use_def.rs b/crates/red_knot_python_semantic/src/semantic_index/use_def.rs deleted file mode 100644 index 554ee11a3e7d1..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/use_def.rs +++ /dev/null @@ -1,575 +0,0 @@ -//! First, some terminology: -//! -//! * A "binding" gives a new value to a variable. This includes many different Python statements -//! (assignment statements of course, but also imports, `def` and `class` statements, `as` -//! clauses in `with` and `except` statements, match patterns, and others) and even one -//! expression kind (named expressions). It notably does not include annotated assignment -//! statements without a right-hand side value; these do not assign any new value to the -//! variable. We consider function parameters to be bindings as well, since (from the perspective -//! of the function's internal scope), a function parameter begins the scope bound to a value. -//! -//! * A "declaration" establishes an upper bound type for the values that a variable may be -//! permitted to take on. Annotated assignment statements (with or without an RHS value) are -//! declarations; annotated function parameters are also declarations. We consider `def` and -//! `class` statements to also be declarations, so as to prohibit accidentally shadowing them. -//! -//! Annotated assignments with a right-hand side, and annotated function parameters, are both -//! bindings and declarations. -//! -//! We use [`Definition`] as the universal term (and Salsa tracked struct) encompassing both -//! bindings and declarations. (This sacrifices a bit of type safety in exchange for improved -//! performance via fewer Salsa tracked structs and queries, since most declarations -- typed -//! parameters and annotated assignments with RHS -- are both bindings and declarations.) -//! -//! At any given use of a variable, we can ask about both its "declared type" and its "inferred -//! type". These may be different, but the inferred type must always be assignable to the declared -//! type; that is, the declared type is always wider, and the inferred type may be more precise. If -//! we see an invalid assignment, we emit a diagnostic and abandon our inferred type, deferring to -//! the declared type (this allows an explicit annotation to override bad inference, without a -//! cast), maintaining the invariant. -//! -//! The **inferred type** represents the most precise type we believe encompasses all possible -//! values for the variable at a given use. It is based on a union of the bindings which can reach -//! that use through some control flow path, and the narrowing constraints that control flow must -//! have passed through between the binding and the use. For example, in this code: -//! -//! ```python -//! x = 1 if flag else None -//! if x is not None: -//! use(x) -//! ``` -//! -//! For the use of `x` on the third line, the inferred type should be `Literal[1]`. This is based -//! on the binding on the first line, which assigns the type `Literal[1] | None`, and the narrowing -//! constraint on the second line, which rules out the type `None`, since control flow must pass -//! through this constraint to reach the use in question. -//! -//! The **declared type** represents the code author's declaration (usually through a type -//! annotation) that a given variable should not be assigned any type outside the declared type. In -//! our model, declared types are also control-flow-sensitive; we allow the code author to -//! explicitly re-declare the same variable with a different type. So for a given binding of a -//! variable, we will want to ask which declarations of that variable can reach that binding, in -//! order to determine whether the binding is permitted, or should be a type error. For example: -//! -//! ```python -//! from pathlib import Path -//! def f(path: str): -//! path: Path = Path(path) -//! ``` -//! -//! In this function, the initial declared type of `path` is `str`, meaning that the assignment -//! `path = Path(path)` would be a type error, since it assigns to `path` a value whose type is not -//! assignable to `str`. This is the purpose of declared types: they prevent accidental assignment -//! of the wrong type to a variable. -//! -//! But in some cases it is useful to "shadow" or "re-declare" a variable with a new type, and we -//! permit this, as long as it is done with an explicit re-annotation. So `path: Path = -//! Path(path)`, with the explicit `: Path` annotation, is permitted. -//! -//! The general rule is that whatever declaration(s) can reach a given binding determine the -//! validity of that binding. If there is a path in which the symbol is not declared, that is a -//! declaration of `Unknown`. If multiple declarations can reach a binding, we union them, but by -//! default we also issue a type error, since this implicit union of declared types may hide an -//! error. -//! -//! To support type inference, we build a map from each use of a symbol to the bindings live at -//! that use, and the type narrowing constraints that apply to each binding. -//! -//! Let's take this code sample: -//! -//! ```python -//! x = 1 -//! x = 2 -//! y = x -//! if flag: -//! x = 3 -//! else: -//! x = 4 -//! z = x -//! ``` -//! -//! In this snippet, we have four bindings of `x` (the statements assigning `1`, `2`, `3`, and `4` -//! to it), and two uses of `x` (the `y = x` and `z = x` assignments). The first binding of `x` -//! does not reach any use, because it's immediately replaced by the second binding, before any use -//! happens. (A linter could thus flag the statement `x = 1` as likely superfluous.) -//! -//! The first use of `x` has one live binding: the assignment `x = 2`. -//! -//! Things get a bit more complex when we have branches. We will definitely take either the `if` or -//! the `else` branch. Thus, the second use of `x` has two live bindings: `x = 3` and `x = 4`. The -//! `x = 2` assignment is no longer visible, because it must be replaced by either `x = 3` or `x = -//! 4`, no matter which branch was taken. We don't know which branch was taken, so we must consider -//! both bindings as live, which means eventually we would (in type inference) look at these two -//! bindings and infer a type of `Literal[3, 4]` -- the union of `Literal[3]` and `Literal[4]` -- -//! for the second use of `x`. -//! -//! So that's one question our use-def map needs to answer: given a specific use of a symbol, which -//! binding(s) can reach that use. In [`AstIds`](crate::semantic_index::ast_ids::AstIds) we number -//! all uses (that means a `Name` node with `Load` context) so we have a `ScopedUseId` to -//! efficiently represent each use. -//! -//! We also need to know, for a given definition of a symbol, what type narrowing constraints apply -//! to it. For instance, in this code sample: -//! -//! ```python -//! x = 1 if flag else None -//! if x is not None: -//! use(x) -//! ``` -//! -//! At the use of `x`, the live binding of `x` is `1 if flag else None`, which would infer as the -//! type `Literal[1] | None`. But the constraint `x is not None` dominates this use, which means we -//! can rule out the possibility that `x` is `None` here, which should give us the type -//! `Literal[1]` for this use. -//! -//! For declared types, we need to be able to answer the question "given a binding to a symbol, -//! which declarations of that symbol can reach the binding?" This allows us to emit a diagnostic -//! if the binding is attempting to bind a value of a type that is not assignable to the declared -//! type for that symbol, at that point in control flow. -//! -//! We also need to know, given a declaration of a symbol, what the inferred type of that symbol is -//! at that point. This allows us to emit a diagnostic in a case like `x = "foo"; x: int`. The -//! binding `x = "foo"` occurs before the declaration `x: int`, so according to our -//! control-flow-sensitive interpretation of declarations, the assignment is not an error. But the -//! declaration is an error, since it would violate the "inferred type must be assignable to -//! declared type" rule. -//! -//! Another case we need to handle is when a symbol is referenced from a different scope (for -//! example, an import or a nonlocal reference). We call this "public" use of a symbol. For public -//! use of a symbol, we prefer the declared type, if there are any declarations of that symbol; if -//! not, we fall back to the inferred type. So we also need to know which declarations and bindings -//! can reach the end of the scope. -//! -//! Technically, public use of a symbol could occur from any point in control flow of the scope -//! where the symbol is defined (via inline imports and import cycles, in the case of an import, or -//! via a function call partway through the local scope that ends up using a symbol from the scope -//! via a global or nonlocal reference.) But modeling this fully accurately requires whole-program -//! analysis that isn't tractable for an efficient analysis, since it means a given symbol could -//! have a different type every place it's referenced throughout the program, depending on the -//! shape of arbitrarily-sized call/import graphs. So we follow other Python type checkers in -//! making the simplifying assumption that usually the scope will finish execution before its -//! symbols are made visible to other scopes; for instance, most imports will import from a -//! complete module, not a partially-executed module. (We may want to get a little smarter than -//! this in the future for some closures, but for now this is where we start.) -//! -//! The data structure we build to answer these questions is the `UseDefMap`. It has a -//! `bindings_by_use` vector of [`SymbolBindings`] indexed by [`ScopedUseId`], a -//! `declarations_by_binding` vector of [`SymbolDeclarations`] indexed by [`ScopedDefinitionId`], a -//! `bindings_by_declaration` vector of [`SymbolBindings`] indexed by [`ScopedDefinitionId`], and -//! `public_bindings` and `public_definitions` vectors indexed by [`ScopedSymbolId`]. The values in -//! each of these vectors are (in principle) a list of live bindings at that use/definition, or at -//! the end of the scope for that symbol, with a list of the dominating constraints for each -//! binding. -//! -//! In order to avoid vectors-of-vectors-of-vectors and all the allocations that would entail, we -//! don't actually store these "list of visible definitions" as a vector of [`Definition`]. -//! Instead, [`SymbolBindings`] and [`SymbolDeclarations`] are structs which use bit-sets to track -//! definitions (and constraints, in the case of bindings) in terms of [`ScopedDefinitionId`] and -//! [`ScopedConstraintId`], which are indices into the `all_definitions` and `all_constraints` -//! indexvecs in the [`UseDefMap`]. -//! -//! There is another special kind of possible "definition" for a symbol: there might be a path from -//! the scope entry to a given use in which the symbol is never bound. -//! -//! The simplest way to model "unbound" would be as a "binding" itself: the initial "binding" for -//! each symbol in a scope. But actually modeling it this way would unnecessarily increase the -//! number of [`Definition`]s that Salsa must track. Since "unbound" is special in that all symbols -//! share it, and it doesn't have any additional per-symbol state, and constraints are irrelevant -//! to it, we can represent it more efficiently: we use the `may_be_unbound` boolean on the -//! [`SymbolBindings`] struct. If this flag is `true` for a use of a symbol, it means the symbol -//! has a path to the use in which it is never bound. If this flag is `false`, it means we've -//! eliminated the possibility of unbound: every control flow path to the use includes a binding -//! for this symbol. -//! -//! To build a [`UseDefMap`], the [`UseDefMapBuilder`] is notified of each new use, definition, and -//! constraint as they are encountered by the -//! [`SemanticIndexBuilder`](crate::semantic_index::builder::SemanticIndexBuilder) AST visit. For -//! each symbol, the builder tracks the `SymbolState` (`SymbolBindings` and `SymbolDeclarations`) -//! for that symbol. When we hit a use or definition of a symbol, we record the necessary parts of -//! the current state for that symbol that we need for that use or definition. When we reach the -//! end of the scope, it records the state for each symbol as the public definitions of that -//! symbol. -//! -//! Let's walk through the above example. Initially we record for `x` that it has no bindings, and -//! may be unbound. When we see `x = 1`, we record that as the sole live binding of `x`, and flip -//! `may_be_unbound` to `false`. Then we see `x = 2`, and we replace `x = 1` as the sole live -//! binding of `x`. When we get to `y = x`, we record that the live bindings for that use of `x` -//! are just the `x = 2` definition. -//! -//! Then we hit the `if` branch. We visit the `test` node (`flag` in this case), since that will -//! happen regardless. Then we take a pre-branch snapshot of the current state for all symbols, -//! which we'll need later. Then we record `flag` as a possible constraint on the current binding -//! (`x = 2`), and go ahead and visit the `if` body. When we see `x = 3`, it replaces `x = 2` -//! (constrained by `flag`) as the sole live binding of `x`. At the end of the `if` body, we take -//! another snapshot of the current symbol state; we'll call this the post-if-body snapshot. -//! -//! Now we need to visit the `else` clause. The conditions when entering the `else` clause should -//! be the pre-if conditions; if we are entering the `else` clause, we know that the `if` test -//! failed and we didn't execute the `if` body. So we first reset the builder to the pre-if state, -//! using the snapshot we took previously (meaning we now have `x = 2` as the sole binding for `x` -//! again), then visit the `else` clause, where `x = 4` replaces `x = 2` as the sole live binding -//! of `x`. -//! -//! Now we reach the end of the if/else, and want to visit the following code. The state here needs -//! to reflect that we might have gone through the `if` branch, or we might have gone through the -//! `else` branch, and we don't know which. So we need to "merge" our current builder state -//! (reflecting the end-of-else state, with `x = 4` as the only live binding) with our post-if-body -//! snapshot (which has `x = 3` as the only live binding). The result of this merge is that we now -//! have two live bindings of `x`: `x = 3` and `x = 4`. -//! -//! The [`UseDefMapBuilder`] itself just exposes methods for taking a snapshot, resetting to a -//! snapshot, and merging a snapshot into the current state. The logic using these methods lives in -//! [`SemanticIndexBuilder`](crate::semantic_index::builder::SemanticIndexBuilder), e.g. where it -//! visits a `StmtIf` node. -use self::symbol_state::{ - BindingIdWithConstraintsIterator, ConstraintIdIterator, DeclarationIdIterator, - ScopedConstraintId, ScopedDefinitionId, SymbolBindings, SymbolDeclarations, SymbolState, -}; -use crate::semantic_index::ast_ids::ScopedUseId; -use crate::semantic_index::definition::Definition; -use crate::semantic_index::symbol::ScopedSymbolId; -use ruff_index::IndexVec; -use rustc_hash::FxHashMap; - -use super::constraint::Constraint; - -mod bitset; -mod symbol_state; - -/// Applicable definitions and constraints for every use of a name. -#[derive(Debug, PartialEq, Eq)] -pub(crate) struct UseDefMap<'db> { - /// Array of [`Definition`] in this scope. - all_definitions: IndexVec>, - - /// Array of [`Constraint`] in this scope. - all_constraints: IndexVec>, - - /// [`SymbolBindings`] reaching a [`ScopedUseId`]. - bindings_by_use: IndexVec, - - /// [`SymbolBindings`] or [`SymbolDeclarations`] reaching a given [`Definition`]. - /// - /// If the definition is a binding (only) -- `x = 1` for example -- then we need - /// [`SymbolDeclarations`] to know whether this binding is permitted by the live declarations. - /// - /// If the definition is a declaration (only) -- `x: int` for example -- then we need - /// [`SymbolBindings`] to know whether this declaration is consistent with the previously - /// inferred type. - /// - /// If the definition is both a declaration and a binding -- `x: int = 1` for example -- then - /// we don't actually need anything here, all we'll need to validate is that our own RHS is a - /// valid assignment to our own annotation. - definitions_by_definition: FxHashMap, SymbolDefinitions>, - - /// [`SymbolState`] visible at end of scope for each symbol. - public_symbols: IndexVec, -} - -impl<'db> UseDefMap<'db> { - pub(crate) fn bindings_at_use( - &self, - use_id: ScopedUseId, - ) -> BindingWithConstraintsIterator<'_, 'db> { - self.bindings_iterator(&self.bindings_by_use[use_id]) - } - - pub(crate) fn use_may_be_unbound(&self, use_id: ScopedUseId) -> bool { - self.bindings_by_use[use_id].may_be_unbound() - } - - pub(crate) fn public_bindings( - &self, - symbol: ScopedSymbolId, - ) -> BindingWithConstraintsIterator<'_, 'db> { - self.bindings_iterator(self.public_symbols[symbol].bindings()) - } - - pub(crate) fn public_may_be_unbound(&self, symbol: ScopedSymbolId) -> bool { - self.public_symbols[symbol].may_be_unbound() - } - - pub(crate) fn bindings_at_declaration( - &self, - declaration: Definition<'db>, - ) -> BindingWithConstraintsIterator<'_, 'db> { - if let SymbolDefinitions::Bindings(bindings) = &self.definitions_by_definition[&declaration] - { - self.bindings_iterator(bindings) - } else { - unreachable!("Declaration has non-Bindings in definitions_by_definition"); - } - } - - pub(crate) fn declarations_at_binding( - &self, - binding: Definition<'db>, - ) -> DeclarationsIterator<'_, 'db> { - if let SymbolDefinitions::Declarations(declarations) = - &self.definitions_by_definition[&binding] - { - self.declarations_iterator(declarations) - } else { - unreachable!("Binding has non-Declarations in definitions_by_definition"); - } - } - - pub(crate) fn public_declarations( - &self, - symbol: ScopedSymbolId, - ) -> DeclarationsIterator<'_, 'db> { - let declarations = self.public_symbols[symbol].declarations(); - self.declarations_iterator(declarations) - } - - pub(crate) fn has_public_declarations(&self, symbol: ScopedSymbolId) -> bool { - !self.public_symbols[symbol].declarations().is_empty() - } - - fn bindings_iterator<'a>( - &'a self, - bindings: &'a SymbolBindings, - ) -> BindingWithConstraintsIterator<'a, 'db> { - BindingWithConstraintsIterator { - all_definitions: &self.all_definitions, - all_constraints: &self.all_constraints, - inner: bindings.iter(), - } - } - - fn declarations_iterator<'a>( - &'a self, - declarations: &'a SymbolDeclarations, - ) -> DeclarationsIterator<'a, 'db> { - DeclarationsIterator { - all_definitions: &self.all_definitions, - inner: declarations.iter(), - may_be_undeclared: declarations.may_be_undeclared(), - } - } -} - -/// Either live bindings or live declarations for a symbol. -#[derive(Debug, PartialEq, Eq)] -enum SymbolDefinitions { - Bindings(SymbolBindings), - Declarations(SymbolDeclarations), -} - -#[derive(Debug)] -pub(crate) struct BindingWithConstraintsIterator<'map, 'db> { - all_definitions: &'map IndexVec>, - all_constraints: &'map IndexVec>, - inner: BindingIdWithConstraintsIterator<'map>, -} - -impl<'map, 'db> Iterator for BindingWithConstraintsIterator<'map, 'db> { - type Item = BindingWithConstraints<'map, 'db>; - - fn next(&mut self) -> Option { - self.inner - .next() - .map(|def_id_with_constraints| BindingWithConstraints { - binding: self.all_definitions[def_id_with_constraints.definition], - constraints: ConstraintsIterator { - all_constraints: self.all_constraints, - constraint_ids: def_id_with_constraints.constraint_ids, - }, - }) - } -} - -impl std::iter::FusedIterator for BindingWithConstraintsIterator<'_, '_> {} - -pub(crate) struct BindingWithConstraints<'map, 'db> { - pub(crate) binding: Definition<'db>, - pub(crate) constraints: ConstraintsIterator<'map, 'db>, -} - -pub(crate) struct ConstraintsIterator<'map, 'db> { - all_constraints: &'map IndexVec>, - constraint_ids: ConstraintIdIterator<'map>, -} - -impl<'map, 'db> Iterator for ConstraintsIterator<'map, 'db> { - type Item = Constraint<'db>; - - fn next(&mut self) -> Option { - self.constraint_ids - .next() - .map(|constraint_id| self.all_constraints[constraint_id]) - } -} - -impl std::iter::FusedIterator for ConstraintsIterator<'_, '_> {} - -pub(crate) struct DeclarationsIterator<'map, 'db> { - all_definitions: &'map IndexVec>, - inner: DeclarationIdIterator<'map>, - may_be_undeclared: bool, -} - -impl DeclarationsIterator<'_, '_> { - pub(crate) fn may_be_undeclared(&self) -> bool { - self.may_be_undeclared - } -} - -impl<'map, 'db> Iterator for DeclarationsIterator<'map, 'db> { - type Item = Definition<'db>; - - fn next(&mut self) -> Option { - self.inner.next().map(|def_id| self.all_definitions[def_id]) - } -} - -impl std::iter::FusedIterator for DeclarationsIterator<'_, '_> {} - -/// A snapshot of the definitions and constraints state at a particular point in control flow. -#[derive(Clone, Debug)] -pub(super) struct FlowSnapshot { - symbol_states: IndexVec, -} - -#[derive(Debug, Default)] -pub(super) struct UseDefMapBuilder<'db> { - /// Append-only array of [`Definition`]. - all_definitions: IndexVec>, - - /// Append-only array of [`Constraint`]. - all_constraints: IndexVec>, - - /// Live bindings at each so-far-recorded use. - bindings_by_use: IndexVec, - - /// Live bindings or declarations for each so-far-recorded definition. - definitions_by_definition: FxHashMap, SymbolDefinitions>, - - /// Currently live bindings and declarations for each symbol. - symbol_states: IndexVec, -} - -impl<'db> UseDefMapBuilder<'db> { - pub(super) fn new() -> Self { - Self::default() - } - - pub(super) fn add_symbol(&mut self, symbol: ScopedSymbolId) { - let new_symbol = self.symbol_states.push(SymbolState::undefined()); - debug_assert_eq!(symbol, new_symbol); - } - - pub(super) fn record_binding(&mut self, symbol: ScopedSymbolId, binding: Definition<'db>) { - let def_id = self.all_definitions.push(binding); - let symbol_state = &mut self.symbol_states[symbol]; - self.definitions_by_definition.insert( - binding, - SymbolDefinitions::Declarations(symbol_state.declarations().clone()), - ); - symbol_state.record_binding(def_id); - } - - pub(super) fn record_constraint(&mut self, constraint: Constraint<'db>) { - let constraint_id = self.all_constraints.push(constraint); - for state in &mut self.symbol_states { - state.record_constraint(constraint_id); - } - } - - pub(super) fn record_declaration( - &mut self, - symbol: ScopedSymbolId, - declaration: Definition<'db>, - ) { - let def_id = self.all_definitions.push(declaration); - let symbol_state = &mut self.symbol_states[symbol]; - self.definitions_by_definition.insert( - declaration, - SymbolDefinitions::Bindings(symbol_state.bindings().clone()), - ); - symbol_state.record_declaration(def_id); - } - - pub(super) fn record_declaration_and_binding( - &mut self, - symbol: ScopedSymbolId, - definition: Definition<'db>, - ) { - // We don't need to store anything in self.definitions_by_definition. - let def_id = self.all_definitions.push(definition); - let symbol_state = &mut self.symbol_states[symbol]; - symbol_state.record_declaration(def_id); - symbol_state.record_binding(def_id); - } - - pub(super) fn record_use(&mut self, symbol: ScopedSymbolId, use_id: ScopedUseId) { - // We have a use of a symbol; clone the current bindings for that symbol, and record them - // as the live bindings for this use. - let new_use = self - .bindings_by_use - .push(self.symbol_states[symbol].bindings().clone()); - debug_assert_eq!(use_id, new_use); - } - - /// Take a snapshot of the current visible-symbols state. - pub(super) fn snapshot(&self) -> FlowSnapshot { - FlowSnapshot { - symbol_states: self.symbol_states.clone(), - } - } - - /// Restore the current builder symbols state to the given snapshot. - pub(super) fn restore(&mut self, snapshot: FlowSnapshot) { - // We never remove symbols from `symbol_states` (it's an IndexVec, and the symbol - // IDs must line up), so the current number of known symbols must always be equal to or - // greater than the number of known symbols in a previously-taken snapshot. - let num_symbols = self.symbol_states.len(); - debug_assert!(num_symbols >= snapshot.symbol_states.len()); - - // Restore the current visible-definitions state to the given snapshot. - self.symbol_states = snapshot.symbol_states; - - // If the snapshot we are restoring is missing some symbols we've recorded since, we need - // to fill them in so the symbol IDs continue to line up. Since they don't exist in the - // snapshot, the correct state to fill them in with is "undefined". - self.symbol_states - .resize(num_symbols, SymbolState::undefined()); - } - - /// Merge the given snapshot into the current state, reflecting that we might have taken either - /// path to get here. The new state for each symbol should include definitions from both the - /// prior state and the snapshot. - pub(super) fn merge(&mut self, snapshot: FlowSnapshot) { - // We never remove symbols from `symbol_states` (it's an IndexVec, and the symbol - // IDs must line up), so the current number of known symbols must always be equal to or - // greater than the number of known symbols in a previously-taken snapshot. - debug_assert!(self.symbol_states.len() >= snapshot.symbol_states.len()); - - let mut snapshot_definitions_iter = snapshot.symbol_states.into_iter(); - for current in &mut self.symbol_states { - if let Some(snapshot) = snapshot_definitions_iter.next() { - current.merge(snapshot); - } else { - // Symbol not present in snapshot, so it's unbound/undeclared from that path. - current.set_may_be_unbound(); - current.set_may_be_undeclared(); - } - } - } - - pub(super) fn finish(mut self) -> UseDefMap<'db> { - self.all_definitions.shrink_to_fit(); - self.all_constraints.shrink_to_fit(); - self.symbol_states.shrink_to_fit(); - self.bindings_by_use.shrink_to_fit(); - self.definitions_by_definition.shrink_to_fit(); - - UseDefMap { - all_definitions: self.all_definitions, - all_constraints: self.all_constraints, - bindings_by_use: self.bindings_by_use, - public_symbols: self.symbol_states, - definitions_by_definition: self.definitions_by_definition, - } - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/use_def/bitset.rs b/crates/red_knot_python_semantic/src/semantic_index/use_def/bitset.rs deleted file mode 100644 index 464f718e7b4f4..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/use_def/bitset.rs +++ /dev/null @@ -1,309 +0,0 @@ -/// Ordered set of `u32`. -/// -/// Uses an inline bit-set for small values (up to 64 * B), falls back to heap allocated vector of -/// blocks for larger values. -#[derive(Debug, Clone, PartialEq, Eq)] -pub(super) enum BitSet { - /// Bit-set (in 64-bit blocks) for the first 64 * B entries. - Inline([u64; B]), - - /// Overflow beyond 64 * B. - Heap(Vec), -} - -impl Default for BitSet { - fn default() -> Self { - // B * 64 must fit in a u32, or else we have unusable bits; this assertion makes the - // truncating casts to u32 below safe. This would be better as a const assertion, but - // that's not possible on stable with const generic params. (B should never really be - // anywhere close to this large.) - assert!(B * 64 < (u32::MAX as usize)); - // This implementation requires usize >= 32 bits. - static_assertions::const_assert!(usize::BITS >= 32); - Self::Inline([0; B]) - } -} - -impl BitSet { - /// Create and return a new [`BitSet`] with a single `value` inserted. - pub(super) fn with(value: u32) -> Self { - let mut bitset = Self::default(); - bitset.insert(value); - bitset - } - - pub(super) fn is_empty(&self) -> bool { - self.blocks().iter().all(|&b| b == 0) - } - - /// Convert from Inline to Heap, if needed, and resize the Heap vector, if needed. - fn resize(&mut self, value: u32) { - let num_blocks_needed = (value / 64) + 1; - self.resize_blocks(num_blocks_needed as usize); - } - - fn resize_blocks(&mut self, num_blocks_needed: usize) { - match self { - Self::Inline(blocks) => { - let mut vec = blocks.to_vec(); - vec.resize(num_blocks_needed, 0); - *self = Self::Heap(vec); - } - Self::Heap(vec) => { - vec.resize(num_blocks_needed, 0); - } - } - } - - fn blocks_mut(&mut self) -> &mut [u64] { - match self { - Self::Inline(blocks) => blocks.as_mut_slice(), - Self::Heap(blocks) => blocks.as_mut_slice(), - } - } - - fn blocks(&self) -> &[u64] { - match self { - Self::Inline(blocks) => blocks.as_slice(), - Self::Heap(blocks) => blocks.as_slice(), - } - } - - /// Insert a value into the [`BitSet`]. - /// - /// Return true if the value was newly inserted, false if already present. - pub(super) fn insert(&mut self, value: u32) -> bool { - let value_usize = value as usize; - let (block, index) = (value_usize / 64, value_usize % 64); - if block >= self.blocks().len() { - self.resize(value); - } - let blocks = self.blocks_mut(); - let missing = blocks[block] & (1 << index) == 0; - blocks[block] |= 1 << index; - missing - } - - /// Intersect in-place with another [`BitSet`]. - pub(super) fn intersect(&mut self, other: &BitSet) { - let my_blocks = self.blocks_mut(); - let other_blocks = other.blocks(); - let min_len = my_blocks.len().min(other_blocks.len()); - for i in 0..min_len { - my_blocks[i] &= other_blocks[i]; - } - for block in my_blocks.iter_mut().skip(min_len) { - *block = 0; - } - } - - /// Union in-place with another [`BitSet`]. - pub(super) fn union(&mut self, other: &BitSet) { - let mut max_len = self.blocks().len(); - let other_len = other.blocks().len(); - if other_len > max_len { - max_len = other_len; - self.resize_blocks(max_len); - } - for (my_block, other_block) in self.blocks_mut().iter_mut().zip(other.blocks()) { - *my_block |= other_block; - } - } - - /// Return an iterator over the values (in ascending order) in this [`BitSet`]. - pub(super) fn iter(&self) -> BitSetIterator<'_, B> { - let blocks = self.blocks(); - BitSetIterator { - blocks, - current_block_index: 0, - current_block: blocks[0], - } - } -} - -/// Iterator over values in a [`BitSet`]. -#[derive(Debug)] -pub(super) struct BitSetIterator<'a, const B: usize> { - /// The blocks we are iterating over. - blocks: &'a [u64], - - /// The index of the block we are currently iterating through. - current_block_index: usize, - - /// The block we are currently iterating through (and zeroing as we go.) - current_block: u64, -} - -impl Iterator for BitSetIterator<'_, B> { - type Item = u32; - - fn next(&mut self) -> Option { - while self.current_block == 0 { - if self.current_block_index + 1 >= self.blocks.len() { - return None; - } - self.current_block_index += 1; - self.current_block = self.blocks[self.current_block_index]; - } - let lowest_bit_set = self.current_block.trailing_zeros(); - // reset the lowest set bit, without a data dependency on `lowest_bit_set` - self.current_block &= self.current_block.wrapping_sub(1); - // SAFETY: `lowest_bit_set` cannot be more than 64, `current_block_index` cannot be more - // than `B - 1`, and we check above that `B * 64 < u32::MAX`. So both `64 * - // current_block_index` and the final value here must fit in u32. - #[allow(clippy::cast_possible_truncation)] - Some(lowest_bit_set + (64 * self.current_block_index) as u32) - } -} - -impl std::iter::FusedIterator for BitSetIterator<'_, B> {} - -#[cfg(test)] -mod tests { - use super::BitSet; - - fn assert_bitset(bitset: &BitSet, contents: &[u32]) { - assert_eq!(bitset.iter().collect::>(), contents); - } - - #[test] - fn iter() { - let mut b = BitSet::<1>::with(3); - b.insert(27); - b.insert(6); - assert!(matches!(b, BitSet::Inline(_))); - assert_bitset(&b, &[3, 6, 27]); - } - - #[test] - fn iter_overflow() { - let mut b = BitSet::<1>::with(140); - b.insert(100); - b.insert(129); - assert!(matches!(b, BitSet::Heap(_))); - assert_bitset(&b, &[100, 129, 140]); - } - - #[test] - fn intersect() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(23); - b2.insert(5); - - b1.intersect(&b2); - assert_bitset(&b1, &[4]); - } - - #[test] - fn intersect_mixed_1() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(89); - b2.insert(5); - - b1.intersect(&b2); - assert_bitset(&b1, &[4]); - } - - #[test] - fn intersect_mixed_2() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(23); - b2.insert(89); - - b1.intersect(&b2); - assert_bitset(&b1, &[4]); - } - - #[test] - fn intersect_heap() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(89); - b2.insert(90); - - b1.intersect(&b2); - assert_bitset(&b1, &[4]); - } - - #[test] - fn intersect_heap_2() { - let mut b1 = BitSet::<1>::with(89); - let mut b2 = BitSet::<1>::with(89); - b1.insert(91); - b2.insert(90); - - b1.intersect(&b2); - assert_bitset(&b1, &[89]); - } - - #[test] - fn union() { - let mut b1 = BitSet::<1>::with(2); - let b2 = BitSet::<1>::with(4); - - b1.union(&b2); - assert_bitset(&b1, &[2, 4]); - } - - #[test] - fn union_mixed_1() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(89); - b2.insert(5); - - b1.union(&b2); - assert_bitset(&b1, &[4, 5, 89]); - } - - #[test] - fn union_mixed_2() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(23); - b2.insert(89); - - b1.union(&b2); - assert_bitset(&b1, &[4, 23, 89]); - } - - #[test] - fn union_heap() { - let mut b1 = BitSet::<1>::with(4); - let mut b2 = BitSet::<1>::with(4); - b1.insert(89); - b2.insert(90); - - b1.union(&b2); - assert_bitset(&b1, &[4, 89, 90]); - } - - #[test] - fn union_heap_2() { - let mut b1 = BitSet::<1>::with(89); - let mut b2 = BitSet::<1>::with(89); - b1.insert(91); - b2.insert(90); - - b1.union(&b2); - assert_bitset(&b1, &[89, 90, 91]); - } - - #[test] - fn multiple_blocks() { - let mut b = BitSet::<2>::with(120); - b.insert(45); - assert!(matches!(b, BitSet::Inline(_))); - assert_bitset(&b, &[45, 120]); - } - - #[test] - fn empty() { - let b = BitSet::<1>::default(); - - assert!(b.is_empty()); - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_index/use_def/symbol_state.rs b/crates/red_knot_python_semantic/src/semantic_index/use_def/symbol_state.rs deleted file mode 100644 index 09210bfab05d6..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_index/use_def/symbol_state.rs +++ /dev/null @@ -1,588 +0,0 @@ -//! Track live bindings per symbol, applicable constraints per binding, and live declarations. -//! -//! These data structures operate entirely on scope-local newtype-indices for definitions and -//! constraints, referring to their location in the `all_definitions` and `all_constraints` -//! indexvecs in [`super::UseDefMapBuilder`]. -//! -//! We need to track arbitrary associations between bindings and constraints, not just a single set -//! of currently dominating constraints (where "dominating" means "control flow must have passed -//! through it to reach this point"), because we can have dominating constraints that apply to some -//! bindings but not others, as in this code: -//! -//! ```python -//! x = 1 if flag else None -//! if x is not None: -//! if flag2: -//! x = 2 if flag else None -//! x -//! ``` -//! -//! The `x is not None` constraint dominates the final use of `x`, but it applies only to the first -//! binding of `x`, not the second, so `None` is a possible value for `x`. -//! -//! And we can't just track, for each binding, an index into a list of dominating constraints, -//! either, because we can have bindings which are still visible, but subject to constraints that -//! are no longer dominating, as in this code: -//! -//! ```python -//! x = 0 -//! if flag1: -//! x = 1 if flag2 else None -//! assert x is not None -//! x -//! ``` -//! -//! From the point of view of the final use of `x`, the `x is not None` constraint no longer -//! dominates, but it does dominate the `x = 1 if flag2 else None` binding, so we have to keep -//! track of that. -//! -//! The data structures used here ([`BitSet`] and [`smallvec::SmallVec`]) optimize for keeping all -//! data inline (avoiding lots of scattered allocations) in small-to-medium cases, and falling back -//! to heap allocation to be able to scale to arbitrary numbers of live bindings and constraints -//! when needed. -//! -//! Tracking live declarations is simpler, since constraints are not involved, but otherwise very -//! similar to tracking live bindings. -use super::bitset::{BitSet, BitSetIterator}; -use ruff_index::newtype_index; -use smallvec::SmallVec; - -/// A newtype-index for a definition in a particular scope. -#[newtype_index] -pub(super) struct ScopedDefinitionId; - -/// A newtype-index for a constraint expression in a particular scope. -#[newtype_index] -pub(super) struct ScopedConstraintId; - -/// Can reference this * 64 total definitions inline; more will fall back to the heap. -const INLINE_BINDING_BLOCKS: usize = 3; - -/// A [`BitSet`] of [`ScopedDefinitionId`], representing live bindings of a symbol in a scope. -type Bindings = BitSet; -type BindingsIterator<'a> = BitSetIterator<'a, INLINE_BINDING_BLOCKS>; - -/// Can reference this * 64 total declarations inline; more will fall back to the heap. -const INLINE_DECLARATION_BLOCKS: usize = 3; - -/// A [`BitSet`] of [`ScopedDefinitionId`], representing live declarations of a symbol in a scope. -type Declarations = BitSet; -type DeclarationsIterator<'a> = BitSetIterator<'a, INLINE_DECLARATION_BLOCKS>; - -/// Can reference this * 64 total constraints inline; more will fall back to the heap. -const INLINE_CONSTRAINT_BLOCKS: usize = 2; - -/// Can keep inline this many live bindings per symbol at a given time; more will go to heap. -const INLINE_BINDINGS_PER_SYMBOL: usize = 4; - -/// One [`BitSet`] of applicable [`ScopedConstraintId`] per live binding. -type InlineConstraintArray = [BitSet; INLINE_BINDINGS_PER_SYMBOL]; -type Constraints = SmallVec; -type ConstraintsIterator<'a> = std::slice::Iter<'a, BitSet>; -type ConstraintsIntoIterator = smallvec::IntoIter; - -/// Live declarations for a single symbol at some point in control flow. -#[derive(Clone, Debug, PartialEq, Eq)] -pub(super) struct SymbolDeclarations { - /// [`BitSet`]: which declarations (as [`ScopedDefinitionId`]) can reach the current location? - live_declarations: Declarations, - - /// Could the symbol be un-declared at this point? - may_be_undeclared: bool, -} - -impl SymbolDeclarations { - fn undeclared() -> Self { - Self { - live_declarations: Declarations::default(), - may_be_undeclared: true, - } - } - - /// Record a newly-encountered declaration for this symbol. - fn record_declaration(&mut self, declaration_id: ScopedDefinitionId) { - self.live_declarations = Declarations::with(declaration_id.into()); - self.may_be_undeclared = false; - } - - /// Add undeclared as a possibility for this symbol. - fn set_may_be_undeclared(&mut self) { - self.may_be_undeclared = true; - } - - /// Return an iterator over live declarations for this symbol. - pub(super) fn iter(&self) -> DeclarationIdIterator { - DeclarationIdIterator { - inner: self.live_declarations.iter(), - } - } - - pub(super) fn is_empty(&self) -> bool { - self.live_declarations.is_empty() - } - - pub(super) fn may_be_undeclared(&self) -> bool { - self.may_be_undeclared - } -} - -/// Live bindings and narrowing constraints for a single symbol at some point in control flow. -#[derive(Clone, Debug, PartialEq, Eq)] -pub(super) struct SymbolBindings { - /// [`BitSet`]: which bindings (as [`ScopedDefinitionId`]) can reach the current location? - live_bindings: Bindings, - - /// For each live binding, which [`ScopedConstraintId`] apply? - /// - /// This is a [`smallvec::SmallVec`] which should always have one [`BitSet`] of constraints per - /// binding in `live_bindings`. - constraints: Constraints, - - /// Could the symbol be unbound at this point? - may_be_unbound: bool, -} - -impl SymbolBindings { - fn unbound() -> Self { - Self { - live_bindings: Bindings::default(), - constraints: Constraints::default(), - may_be_unbound: true, - } - } - - /// Add Unbound as a possibility for this symbol. - fn set_may_be_unbound(&mut self) { - self.may_be_unbound = true; - } - - /// Record a newly-encountered binding for this symbol. - pub(super) fn record_binding(&mut self, binding_id: ScopedDefinitionId) { - // The new binding replaces all previous live bindings in this path, and has no - // constraints. - self.live_bindings = Bindings::with(binding_id.into()); - self.constraints = Constraints::with_capacity(1); - self.constraints.push(BitSet::default()); - self.may_be_unbound = false; - } - - /// Add given constraint to all live bindings. - pub(super) fn record_constraint(&mut self, constraint_id: ScopedConstraintId) { - for bitset in &mut self.constraints { - bitset.insert(constraint_id.into()); - } - } - - /// Iterate over currently live bindings for this symbol. - pub(super) fn iter(&self) -> BindingIdWithConstraintsIterator { - BindingIdWithConstraintsIterator { - definitions: self.live_bindings.iter(), - constraints: self.constraints.iter(), - } - } - - pub(super) fn may_be_unbound(&self) -> bool { - self.may_be_unbound - } -} - -#[derive(Clone, Debug, PartialEq, Eq)] -pub(super) struct SymbolState { - declarations: SymbolDeclarations, - bindings: SymbolBindings, -} - -impl SymbolState { - /// Return a new [`SymbolState`] representing an unbound, undeclared symbol. - pub(super) fn undefined() -> Self { - Self { - declarations: SymbolDeclarations::undeclared(), - bindings: SymbolBindings::unbound(), - } - } - - /// Add Unbound as a possibility for this symbol. - pub(super) fn set_may_be_unbound(&mut self) { - self.bindings.set_may_be_unbound(); - } - - /// Record a newly-encountered binding for this symbol. - pub(super) fn record_binding(&mut self, binding_id: ScopedDefinitionId) { - self.bindings.record_binding(binding_id); - } - - /// Add given constraint to all live bindings. - pub(super) fn record_constraint(&mut self, constraint_id: ScopedConstraintId) { - self.bindings.record_constraint(constraint_id); - } - - /// Add undeclared as a possibility for this symbol. - pub(super) fn set_may_be_undeclared(&mut self) { - self.declarations.set_may_be_undeclared(); - } - - /// Record a newly-encountered declaration of this symbol. - pub(super) fn record_declaration(&mut self, declaration_id: ScopedDefinitionId) { - self.declarations.record_declaration(declaration_id); - } - - /// Merge another [`SymbolState`] into this one. - pub(super) fn merge(&mut self, b: SymbolState) { - let mut a = Self { - bindings: SymbolBindings { - live_bindings: Bindings::default(), - constraints: Constraints::default(), - may_be_unbound: self.bindings.may_be_unbound || b.bindings.may_be_unbound, - }, - declarations: SymbolDeclarations { - live_declarations: self.declarations.live_declarations.clone(), - may_be_undeclared: self.declarations.may_be_undeclared - || b.declarations.may_be_undeclared, - }, - }; - - std::mem::swap(&mut a, self); - self.declarations - .live_declarations - .union(&b.declarations.live_declarations); - - let mut a_defs_iter = a.bindings.live_bindings.iter(); - let mut b_defs_iter = b.bindings.live_bindings.iter(); - let mut a_constraints_iter = a.bindings.constraints.into_iter(); - let mut b_constraints_iter = b.bindings.constraints.into_iter(); - - let mut opt_a_def: Option = a_defs_iter.next(); - let mut opt_b_def: Option = b_defs_iter.next(); - - // Iterate through the definitions from `a` and `b`, always processing the lower definition - // ID first, and pushing each definition onto the merged `SymbolState` with its - // constraints. If a definition is found in both `a` and `b`, push it with the intersection - // of the constraints from the two paths; a constraint that applies from only one possible - // path is irrelevant. - - // Helper to push `def`, with constraints in `constraints_iter`, onto `self`. - let push = |def, constraints_iter: &mut ConstraintsIntoIterator, merged: &mut Self| { - merged.bindings.live_bindings.insert(def); - // SAFETY: we only ever create SymbolState with either no definitions and no constraint - // bitsets (`::unbound`) or one definition and one constraint bitset (`::with`), and - // `::merge` always pushes one definition and one constraint bitset together (just - // below), so the number of definitions and the number of constraint bitsets can never - // get out of sync. - let constraints = constraints_iter - .next() - .expect("definitions and constraints length mismatch"); - merged.bindings.constraints.push(constraints); - }; - - loop { - match (opt_a_def, opt_b_def) { - (Some(a_def), Some(b_def)) => match a_def.cmp(&b_def) { - std::cmp::Ordering::Less => { - // Next definition ID is only in `a`, push it to `self` and advance `a`. - push(a_def, &mut a_constraints_iter, self); - opt_a_def = a_defs_iter.next(); - } - std::cmp::Ordering::Greater => { - // Next definition ID is only in `b`, push it to `self` and advance `b`. - push(b_def, &mut b_constraints_iter, self); - opt_b_def = b_defs_iter.next(); - } - std::cmp::Ordering::Equal => { - // Next definition is in both; push to `self` and intersect constraints. - push(a_def, &mut b_constraints_iter, self); - // SAFETY: we only ever create SymbolState with either no definitions and - // no constraint bitsets (`::unbound`) or one definition and one constraint - // bitset (`::with`), and `::merge` always pushes one definition and one - // constraint bitset together (just below), so the number of definitions - // and the number of constraint bitsets can never get out of sync. - let a_constraints = a_constraints_iter - .next() - .expect("definitions and constraints length mismatch"); - // If the same definition is visible through both paths, any constraint - // that applies on only one path is irrelevant to the resulting type from - // unioning the two paths, so we intersect the constraints. - self.bindings - .constraints - .last_mut() - .unwrap() - .intersect(&a_constraints); - opt_a_def = a_defs_iter.next(); - opt_b_def = b_defs_iter.next(); - } - }, - (Some(a_def), None) => { - // We've exhausted `b`, just push the def from `a` and move on to the next. - push(a_def, &mut a_constraints_iter, self); - opt_a_def = a_defs_iter.next(); - } - (None, Some(b_def)) => { - // We've exhausted `a`, just push the def from `b` and move on to the next. - push(b_def, &mut b_constraints_iter, self); - opt_b_def = b_defs_iter.next(); - } - (None, None) => break, - } - } - } - - pub(super) fn bindings(&self) -> &SymbolBindings { - &self.bindings - } - - pub(super) fn declarations(&self) -> &SymbolDeclarations { - &self.declarations - } - - /// Could the symbol be unbound? - pub(super) fn may_be_unbound(&self) -> bool { - self.bindings.may_be_unbound() - } -} - -/// The default state of a symbol, if we've seen no definitions of it, is undefined (that is, -/// both unbound and undeclared). -impl Default for SymbolState { - fn default() -> Self { - SymbolState::undefined() - } -} - -/// A single binding (as [`ScopedDefinitionId`]) with an iterator of its applicable -/// [`ScopedConstraintId`]. -#[derive(Debug)] -pub(super) struct BindingIdWithConstraints<'a> { - pub(super) definition: ScopedDefinitionId, - pub(super) constraint_ids: ConstraintIdIterator<'a>, -} - -#[derive(Debug)] -pub(super) struct BindingIdWithConstraintsIterator<'a> { - definitions: BindingsIterator<'a>, - constraints: ConstraintsIterator<'a>, -} - -impl<'a> Iterator for BindingIdWithConstraintsIterator<'a> { - type Item = BindingIdWithConstraints<'a>; - - fn next(&mut self) -> Option { - match (self.definitions.next(), self.constraints.next()) { - (None, None) => None, - (Some(def), Some(constraints)) => Some(BindingIdWithConstraints { - definition: ScopedDefinitionId::from_u32(def), - constraint_ids: ConstraintIdIterator { - wrapped: constraints.iter(), - }, - }), - // SAFETY: see above. - _ => unreachable!("definitions and constraints length mismatch"), - } - } -} - -impl std::iter::FusedIterator for BindingIdWithConstraintsIterator<'_> {} - -#[derive(Debug)] -pub(super) struct ConstraintIdIterator<'a> { - wrapped: BitSetIterator<'a, INLINE_CONSTRAINT_BLOCKS>, -} - -impl Iterator for ConstraintIdIterator<'_> { - type Item = ScopedConstraintId; - - fn next(&mut self) -> Option { - self.wrapped.next().map(ScopedConstraintId::from_u32) - } -} - -impl std::iter::FusedIterator for ConstraintIdIterator<'_> {} - -#[derive(Debug)] -pub(super) struct DeclarationIdIterator<'a> { - inner: DeclarationsIterator<'a>, -} - -impl<'a> Iterator for DeclarationIdIterator<'a> { - type Item = ScopedDefinitionId; - - fn next(&mut self) -> Option { - self.inner.next().map(ScopedDefinitionId::from_u32) - } -} - -impl std::iter::FusedIterator for DeclarationIdIterator<'_> {} - -#[cfg(test)] -mod tests { - use super::{ScopedConstraintId, ScopedDefinitionId, SymbolState}; - - fn assert_bindings(symbol: &SymbolState, may_be_unbound: bool, expected: &[&str]) { - assert_eq!(symbol.may_be_unbound(), may_be_unbound); - let actual = symbol - .bindings() - .iter() - .map(|def_id_with_constraints| { - format!( - "{}<{}>", - def_id_with_constraints.definition.as_u32(), - def_id_with_constraints - .constraint_ids - .map(ScopedConstraintId::as_u32) - .map(|idx| idx.to_string()) - .collect::>() - .join(", ") - ) - }) - .collect::>(); - assert_eq!(actual, expected); - } - - pub(crate) fn assert_declarations( - symbol: &SymbolState, - may_be_undeclared: bool, - expected: &[u32], - ) { - assert_eq!(symbol.declarations.may_be_undeclared(), may_be_undeclared); - let actual = symbol - .declarations() - .iter() - .map(ScopedDefinitionId::as_u32) - .collect::>(); - assert_eq!(actual, expected); - } - - #[test] - fn unbound() { - let sym = SymbolState::undefined(); - - assert_bindings(&sym, true, &[]); - } - - #[test] - fn with() { - let mut sym = SymbolState::undefined(); - sym.record_binding(ScopedDefinitionId::from_u32(0)); - - assert_bindings(&sym, false, &["0<>"]); - } - - #[test] - fn set_may_be_unbound() { - let mut sym = SymbolState::undefined(); - sym.record_binding(ScopedDefinitionId::from_u32(0)); - sym.set_may_be_unbound(); - - assert_bindings(&sym, true, &["0<>"]); - } - - #[test] - fn record_constraint() { - let mut sym = SymbolState::undefined(); - sym.record_binding(ScopedDefinitionId::from_u32(0)); - sym.record_constraint(ScopedConstraintId::from_u32(0)); - - assert_bindings(&sym, false, &["0<0>"]); - } - - #[test] - fn merge() { - // merging the same definition with the same constraint keeps the constraint - let mut sym0a = SymbolState::undefined(); - sym0a.record_binding(ScopedDefinitionId::from_u32(0)); - sym0a.record_constraint(ScopedConstraintId::from_u32(0)); - - let mut sym0b = SymbolState::undefined(); - sym0b.record_binding(ScopedDefinitionId::from_u32(0)); - sym0b.record_constraint(ScopedConstraintId::from_u32(0)); - - sym0a.merge(sym0b); - let mut sym0 = sym0a; - assert_bindings(&sym0, false, &["0<0>"]); - - // merging the same definition with differing constraints drops all constraints - let mut sym1a = SymbolState::undefined(); - sym1a.record_binding(ScopedDefinitionId::from_u32(1)); - sym1a.record_constraint(ScopedConstraintId::from_u32(1)); - - let mut sym1b = SymbolState::undefined(); - sym1b.record_binding(ScopedDefinitionId::from_u32(1)); - sym1b.record_constraint(ScopedConstraintId::from_u32(2)); - - sym1a.merge(sym1b); - let sym1 = sym1a; - assert_bindings(&sym1, false, &["1<>"]); - - // merging a constrained definition with unbound keeps both - let mut sym2a = SymbolState::undefined(); - sym2a.record_binding(ScopedDefinitionId::from_u32(2)); - sym2a.record_constraint(ScopedConstraintId::from_u32(3)); - - let sym2b = SymbolState::undefined(); - - sym2a.merge(sym2b); - let sym2 = sym2a; - assert_bindings(&sym2, true, &["2<3>"]); - - // merging different definitions keeps them each with their existing constraints - sym0.merge(sym2); - let sym = sym0; - assert_bindings(&sym, true, &["0<0>", "2<3>"]); - } - - #[test] - fn no_declaration() { - let sym = SymbolState::undefined(); - - assert_declarations(&sym, true, &[]); - } - - #[test] - fn record_declaration() { - let mut sym = SymbolState::undefined(); - sym.record_declaration(ScopedDefinitionId::from_u32(1)); - - assert_declarations(&sym, false, &[1]); - } - - #[test] - fn record_declaration_override() { - let mut sym = SymbolState::undefined(); - sym.record_declaration(ScopedDefinitionId::from_u32(1)); - sym.record_declaration(ScopedDefinitionId::from_u32(2)); - - assert_declarations(&sym, false, &[2]); - } - - #[test] - fn record_declaration_merge() { - let mut sym = SymbolState::undefined(); - sym.record_declaration(ScopedDefinitionId::from_u32(1)); - - let mut sym2 = SymbolState::undefined(); - sym2.record_declaration(ScopedDefinitionId::from_u32(2)); - - sym.merge(sym2); - - assert_declarations(&sym, false, &[1, 2]); - } - - #[test] - fn record_declaration_merge_partial_undeclared() { - let mut sym = SymbolState::undefined(); - sym.record_declaration(ScopedDefinitionId::from_u32(1)); - - let sym2 = SymbolState::undefined(); - - sym.merge(sym2); - - assert_declarations(&sym, true, &[1]); - } - - #[test] - fn set_may_be_undeclared() { - let mut sym = SymbolState::undefined(); - sym.record_declaration(ScopedDefinitionId::from_u32(0)); - sym.set_may_be_undeclared(); - - assert_declarations(&sym, true, &[0]); - } -} diff --git a/crates/red_knot_python_semantic/src/semantic_model.rs b/crates/red_knot_python_semantic/src/semantic_model.rs deleted file mode 100644 index 9cdbec789c50a..0000000000000 --- a/crates/red_knot_python_semantic/src/semantic_model.rs +++ /dev/null @@ -1,249 +0,0 @@ -use ruff_db::files::{File, FilePath}; -use ruff_db::source::line_index; -use ruff_python_ast as ast; -use ruff_python_ast::{Expr, ExpressionRef}; -use ruff_source_file::LineIndex; - -use crate::module_name::ModuleName; -use crate::module_resolver::{resolve_module, Module}; -use crate::semantic_index::ast_ids::HasScopedAstId; -use crate::semantic_index::semantic_index; -use crate::types::{binding_ty, global_symbol_ty, infer_scope_types, Type}; -use crate::Db; - -pub struct SemanticModel<'db> { - db: &'db dyn Db, - file: File, -} - -impl<'db> SemanticModel<'db> { - pub fn new(db: &'db dyn Db, file: File) -> Self { - Self { db, file } - } - - // TODO we don't actually want to expose the Db directly to lint rules, but we need to find a - // solution for exposing information from types - pub fn db(&self) -> &dyn Db { - self.db - } - - pub fn file_path(&self) -> &FilePath { - self.file.path(self.db) - } - - pub fn line_index(&self) -> LineIndex { - line_index(self.db.upcast(), self.file) - } - - pub fn resolve_module(&self, module_name: &ModuleName) -> Option { - resolve_module(self.db, module_name) - } - - pub fn global_symbol_ty(&self, module: &Module, symbol_name: &str) -> Type<'db> { - global_symbol_ty(self.db, module.file(), symbol_name) - } -} - -pub trait HasTy { - /// Returns the inferred type of `self`. - /// - /// ## Panics - /// May panic if `self` is from another file than `model`. - fn ty<'db>(&self, model: &SemanticModel<'db>) -> Type<'db>; -} - -impl HasTy for ast::ExpressionRef<'_> { - fn ty<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { - let index = semantic_index(model.db, model.file); - let file_scope = index.expression_scope_id(*self); - let scope = file_scope.to_scope_id(model.db, model.file); - - let expression_id = self.scoped_ast_id(model.db, scope); - infer_scope_types(model.db, scope).expression_ty(expression_id) - } -} - -macro_rules! impl_expression_has_ty { - ($ty: ty) => { - impl HasTy for $ty { - #[inline] - fn ty<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { - let expression_ref = ExpressionRef::from(self); - expression_ref.ty(model) - } - } - }; -} - -impl_expression_has_ty!(ast::ExprBoolOp); -impl_expression_has_ty!(ast::ExprNamed); -impl_expression_has_ty!(ast::ExprBinOp); -impl_expression_has_ty!(ast::ExprUnaryOp); -impl_expression_has_ty!(ast::ExprLambda); -impl_expression_has_ty!(ast::ExprIf); -impl_expression_has_ty!(ast::ExprDict); -impl_expression_has_ty!(ast::ExprSet); -impl_expression_has_ty!(ast::ExprListComp); -impl_expression_has_ty!(ast::ExprSetComp); -impl_expression_has_ty!(ast::ExprDictComp); -impl_expression_has_ty!(ast::ExprGenerator); -impl_expression_has_ty!(ast::ExprAwait); -impl_expression_has_ty!(ast::ExprYield); -impl_expression_has_ty!(ast::ExprYieldFrom); -impl_expression_has_ty!(ast::ExprCompare); -impl_expression_has_ty!(ast::ExprCall); -impl_expression_has_ty!(ast::ExprFString); -impl_expression_has_ty!(ast::ExprStringLiteral); -impl_expression_has_ty!(ast::ExprBytesLiteral); -impl_expression_has_ty!(ast::ExprNumberLiteral); -impl_expression_has_ty!(ast::ExprBooleanLiteral); -impl_expression_has_ty!(ast::ExprNoneLiteral); -impl_expression_has_ty!(ast::ExprEllipsisLiteral); -impl_expression_has_ty!(ast::ExprAttribute); -impl_expression_has_ty!(ast::ExprSubscript); -impl_expression_has_ty!(ast::ExprStarred); -impl_expression_has_ty!(ast::ExprName); -impl_expression_has_ty!(ast::ExprList); -impl_expression_has_ty!(ast::ExprTuple); -impl_expression_has_ty!(ast::ExprSlice); -impl_expression_has_ty!(ast::ExprIpyEscapeCommand); - -impl HasTy for ast::Expr { - fn ty<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { - match self { - Expr::BoolOp(inner) => inner.ty(model), - Expr::Named(inner) => inner.ty(model), - Expr::BinOp(inner) => inner.ty(model), - Expr::UnaryOp(inner) => inner.ty(model), - Expr::Lambda(inner) => inner.ty(model), - Expr::If(inner) => inner.ty(model), - Expr::Dict(inner) => inner.ty(model), - Expr::Set(inner) => inner.ty(model), - Expr::ListComp(inner) => inner.ty(model), - Expr::SetComp(inner) => inner.ty(model), - Expr::DictComp(inner) => inner.ty(model), - Expr::Generator(inner) => inner.ty(model), - Expr::Await(inner) => inner.ty(model), - Expr::Yield(inner) => inner.ty(model), - Expr::YieldFrom(inner) => inner.ty(model), - Expr::Compare(inner) => inner.ty(model), - Expr::Call(inner) => inner.ty(model), - Expr::FString(inner) => inner.ty(model), - Expr::StringLiteral(inner) => inner.ty(model), - Expr::BytesLiteral(inner) => inner.ty(model), - Expr::NumberLiteral(inner) => inner.ty(model), - Expr::BooleanLiteral(inner) => inner.ty(model), - Expr::NoneLiteral(inner) => inner.ty(model), - Expr::EllipsisLiteral(inner) => inner.ty(model), - Expr::Attribute(inner) => inner.ty(model), - Expr::Subscript(inner) => inner.ty(model), - Expr::Starred(inner) => inner.ty(model), - Expr::Name(inner) => inner.ty(model), - Expr::List(inner) => inner.ty(model), - Expr::Tuple(inner) => inner.ty(model), - Expr::Slice(inner) => inner.ty(model), - Expr::IpyEscapeCommand(inner) => inner.ty(model), - } - } -} - -macro_rules! impl_binding_has_ty { - ($ty: ty) => { - impl HasTy for $ty { - #[inline] - fn ty<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { - let index = semantic_index(model.db, model.file); - let binding = index.definition(self); - binding_ty(model.db, binding) - } - } - }; -} - -impl_binding_has_ty!(ast::StmtFunctionDef); -impl_binding_has_ty!(ast::StmtClassDef); -impl_binding_has_ty!(ast::Alias); -impl_binding_has_ty!(ast::Parameter); -impl_binding_has_ty!(ast::ParameterWithDefault); - -#[cfg(test)] -mod tests { - use ruff_db::files::system_path_to_file; - use ruff_db::parsed::parsed_module; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - - use crate::db::tests::TestDb; - use crate::program::{Program, SearchPathSettings}; - use crate::python_version::PythonVersion; - use crate::{HasTy, ProgramSettings, SemanticModel}; - - fn setup_db<'a>(files: impl IntoIterator) -> anyhow::Result { - let mut db = TestDb::new(); - db.write_files(files)?; - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(SystemPathBuf::from("/src")), - }, - )?; - - Ok(db) - } - - #[test] - fn function_ty() -> anyhow::Result<()> { - let db = setup_db([("/src/foo.py", "def test(): pass")])?; - - let foo = system_path_to_file(&db, "/src/foo.py").unwrap(); - - let ast = parsed_module(&db, foo); - - let function = ast.suite()[0].as_function_def_stmt().unwrap(); - let model = SemanticModel::new(&db, foo); - let ty = function.ty(&model); - - assert!(ty.is_function_literal()); - - Ok(()) - } - - #[test] - fn class_ty() -> anyhow::Result<()> { - let db = setup_db([("/src/foo.py", "class Test: pass")])?; - - let foo = system_path_to_file(&db, "/src/foo.py").unwrap(); - - let ast = parsed_module(&db, foo); - - let class = ast.suite()[0].as_class_def_stmt().unwrap(); - let model = SemanticModel::new(&db, foo); - let ty = class.ty(&model); - - assert!(ty.is_class_literal()); - - Ok(()) - } - - #[test] - fn alias_ty() -> anyhow::Result<()> { - let db = setup_db([ - ("/src/foo.py", "class Test: pass"), - ("/src/bar.py", "from foo import Test"), - ])?; - - let bar = system_path_to_file(&db, "/src/bar.py").unwrap(); - - let ast = parsed_module(&db, bar); - - let import = ast.suite()[0].as_import_from_stmt().unwrap(); - let alias = &import.names[0]; - let model = SemanticModel::new(&db, bar); - let ty = alias.ty(&model); - - assert!(ty.is_class_literal()); - - Ok(()) - } -} diff --git a/crates/red_knot_python_semantic/src/site_packages.rs b/crates/red_knot_python_semantic/src/site_packages.rs deleted file mode 100644 index b6b65890d18d1..0000000000000 --- a/crates/red_knot_python_semantic/src/site_packages.rs +++ /dev/null @@ -1,842 +0,0 @@ -//! Utilities for finding the `site-packages` directory, -//! into which third-party packages are installed. -//! -//! The routines exposed by this module have different behaviour depending -//! on the platform of the *host machine*, which may be -//! different from the *target platform for type checking*. (A user -//! might be running red-knot on a Windows machine, but might -//! reasonably ask us to type-check code assuming that the code runs -//! on Linux.) - -use std::fmt; -use std::io; -use std::num::NonZeroUsize; -use std::ops::Deref; - -use ruff_db::system::{System, SystemPath, SystemPathBuf}; - -use crate::PythonVersion; - -type SitePackagesDiscoveryResult = Result; - -/// Abstraction for a Python virtual environment. -/// -/// Most of this information is derived from the virtual environment's `pyvenv.cfg` file. -/// The format of this file is not defined anywhere, and exactly which keys are present -/// depends on the tool that was used to create the virtual environment. -#[derive(Debug)] -pub(crate) struct VirtualEnvironment { - venv_path: SysPrefixPath, - base_executable_home_path: PythonHomePath, - include_system_site_packages: bool, - - /// The version of the Python executable that was used to create this virtual environment. - /// - /// The Python version is encoded under different keys and in different formats - /// by different virtual-environment creation tools, - /// and the key is never read by the standard-library `site.py` module, - /// so it's possible that we might not be able to find this information - /// in an acceptable format under any of the keys we expect. - /// This field will be `None` if so. - version: Option, -} - -impl VirtualEnvironment { - pub(crate) fn new( - path: impl AsRef, - system: &dyn System, - ) -> SitePackagesDiscoveryResult { - Self::new_impl(path.as_ref(), system) - } - - fn new_impl(path: &SystemPath, system: &dyn System) -> SitePackagesDiscoveryResult { - fn pyvenv_cfg_line_number(index: usize) -> NonZeroUsize { - index.checked_add(1).and_then(NonZeroUsize::new).unwrap() - } - - let venv_path = SysPrefixPath::new(path, system)?; - let pyvenv_cfg_path = venv_path.join("pyvenv.cfg"); - tracing::debug!("Attempting to parse virtual environment metadata at '{pyvenv_cfg_path}'"); - - let pyvenv_cfg = system - .read_to_string(&pyvenv_cfg_path) - .map_err(SitePackagesDiscoveryError::NoPyvenvCfgFile)?; - - let mut include_system_site_packages = false; - let mut base_executable_home_path = None; - let mut version_info_string = None; - - // A `pyvenv.cfg` file *looks* like a `.ini` file, but actually isn't valid `.ini` syntax! - // The Python standard-library's `site` module parses these files by splitting each line on - // '=' characters, so that's what we should do as well. - // - // See also: https://snarky.ca/how-virtual-environments-work/ - for (index, line) in pyvenv_cfg.lines().enumerate() { - if let Some((key, value)) = line.split_once('=') { - let key = key.trim(); - if key.is_empty() { - return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - pyvenv_cfg_path, - PyvenvCfgParseErrorKind::MalformedKeyValuePair { - line_number: pyvenv_cfg_line_number(index), - }, - )); - } - - let value = value.trim(); - if value.is_empty() { - return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - pyvenv_cfg_path, - PyvenvCfgParseErrorKind::MalformedKeyValuePair { - line_number: pyvenv_cfg_line_number(index), - }, - )); - } - - if value.contains('=') { - return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - pyvenv_cfg_path, - PyvenvCfgParseErrorKind::TooManyEquals { - line_number: pyvenv_cfg_line_number(index), - }, - )); - } - - match key { - "include-system-site-packages" => { - include_system_site_packages = value.eq_ignore_ascii_case("true"); - } - "home" => base_executable_home_path = Some(value), - // `virtualenv` and `uv` call this key `version_info`, - // but the stdlib venv module calls it `version` - "version" | "version_info" => version_info_string = Some(value), - _ => continue, - } - } - } - - // The `home` key is read by the standard library's `site.py` module, - // so if it's missing from the `pyvenv.cfg` file - // (or the provided value is invalid), - // it's reasonable to consider the virtual environment irredeemably broken. - let Some(base_executable_home_path) = base_executable_home_path else { - return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - pyvenv_cfg_path, - PyvenvCfgParseErrorKind::NoHomeKey, - )); - }; - let base_executable_home_path = PythonHomePath::new(base_executable_home_path, system) - .map_err(|io_err| { - SitePackagesDiscoveryError::PyvenvCfgParseError( - pyvenv_cfg_path, - PyvenvCfgParseErrorKind::InvalidHomeValue(io_err), - ) - })?; - - // but the `version`/`version_info` key is not read by the standard library, - // and is provided under different keys depending on which virtual-environment creation tool - // created the `pyvenv.cfg` file. Lenient parsing is appropriate here: - // the file isn't really *invalid* if it doesn't have this key, - // or if the value doesn't parse according to our expectations. - let version = version_info_string.and_then(|version_string| { - let mut version_info_parts = version_string.split('.'); - let (major, minor) = (version_info_parts.next()?, version_info_parts.next()?); - PythonVersion::try_from((major, minor)).ok() - }); - - let metadata = Self { - venv_path, - base_executable_home_path, - include_system_site_packages, - version, - }; - - tracing::trace!("Resolved metadata for virtual environment: {metadata:?}"); - Ok(metadata) - } - - /// Return a list of `site-packages` directories that are available from this virtual environment - /// - /// See the documentation for `site_packages_dir_from_sys_prefix` for more details. - pub(crate) fn site_packages_directories( - &self, - system: &dyn System, - ) -> SitePackagesDiscoveryResult> { - let VirtualEnvironment { - venv_path, - base_executable_home_path, - include_system_site_packages, - version, - } = self; - - let mut site_packages_directories = vec![site_packages_directory_from_sys_prefix( - venv_path, *version, system, - )?]; - - if *include_system_site_packages { - let system_sys_prefix = - SysPrefixPath::from_executable_home_path(base_executable_home_path); - - // If we fail to resolve the `sys.prefix` path from the base executable home path, - // or if we fail to resolve the `site-packages` from the `sys.prefix` path, - // we should probably print a warning but *not* abort type checking - if let Some(sys_prefix_path) = system_sys_prefix { - match site_packages_directory_from_sys_prefix(&sys_prefix_path, *version, system) { - Ok(site_packages_directory) => { - site_packages_directories.push(site_packages_directory); - } - Err(error) => tracing::warn!( - "{error}. System site-packages will not be used for module resolution." - ), - } - } else { - tracing::warn!( - "Failed to resolve `sys.prefix` of the system Python installation \ -from the `home` value in the `pyvenv.cfg` file at `{}`. \ -System site-packages will not be used for module resolution.", - venv_path.join("pyvenv.cfg") - ); - } - } - - tracing::debug!("Resolved site-packages directories for this virtual environment are: {site_packages_directories:?}"); - Ok(site_packages_directories) - } -} - -#[derive(Debug, thiserror::Error)] -pub(crate) enum SitePackagesDiscoveryError { - #[error("Invalid --venv-path argument: {0} could not be canonicalized")] - VenvDirCanonicalizationError(SystemPathBuf, #[source] io::Error), - #[error("Invalid --venv-path argument: {0} does not point to a directory on disk")] - VenvDirIsNotADirectory(SystemPathBuf), - #[error("--venv-path points to a broken venv with no pyvenv.cfg file")] - NoPyvenvCfgFile(#[source] io::Error), - #[error("Failed to parse the pyvenv.cfg file at {0} because {1}")] - PyvenvCfgParseError(SystemPathBuf, PyvenvCfgParseErrorKind), - #[error("Failed to search the `lib` directory of the Python installation at {1} for `site-packages`")] - CouldNotReadLibDirectory(#[source] io::Error, SysPrefixPath), - #[error("Could not find the `site-packages` directory for the Python installation at {0}")] - NoSitePackagesDirFound(SysPrefixPath), -} - -/// The various ways in which parsing a `pyvenv.cfg` file could fail -#[derive(Debug)] -pub(crate) enum PyvenvCfgParseErrorKind { - TooManyEquals { line_number: NonZeroUsize }, - MalformedKeyValuePair { line_number: NonZeroUsize }, - NoHomeKey, - InvalidHomeValue(io::Error), -} - -impl fmt::Display for PyvenvCfgParseErrorKind { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - match self { - Self::TooManyEquals { line_number } => { - write!(f, "line {line_number} has too many '=' characters") - } - Self::MalformedKeyValuePair { line_number } => write!( - f, - "line {line_number} has a malformed ` = ` pair" - ), - Self::NoHomeKey => f.write_str("the file does not have a `home` key"), - Self::InvalidHomeValue(io_err) => { - write!( - f, - "the following error was encountered \ -when trying to resolve the `home` value to a directory on disk: {io_err}" - ) - } - } - } -} - -/// Attempt to retrieve the `site-packages` directory -/// associated with a given Python installation. -/// -/// The location of the `site-packages` directory can vary according to the -/// Python version that this installation represents. The Python version may -/// or may not be known at this point, which is why the `python_version` -/// parameter is an `Option`. -fn site_packages_directory_from_sys_prefix( - sys_prefix_path: &SysPrefixPath, - python_version: Option, - system: &dyn System, -) -> SitePackagesDiscoveryResult { - tracing::debug!("Searching for site-packages directory in {sys_prefix_path}"); - - if cfg!(target_os = "windows") { - let site_packages = sys_prefix_path.join(r"Lib\site-packages"); - return system - .is_directory(&site_packages) - .then_some(site_packages) - .ok_or(SitePackagesDiscoveryError::NoSitePackagesDirFound( - sys_prefix_path.to_owned(), - )); - } - - // In the Python standard library's `site.py` module (used for finding `site-packages` - // at runtime), we can find this in [the non-Windows branch]: - // - // ```py - // libdirs = [sys.platlibdir] - // if sys.platlibdir != "lib": - // libdirs.append("lib") - // ``` - // - // Pyright therefore searches for both a `lib/python3.X/site-packages` directory - // and a `lib64/python3.X/site-packages` directory on non-MacOS Unix systems, - // since `sys.platlibdir` can sometimes be equal to `"lib64"`. - // - // However, we only care about the `site-packages` directory insofar as it allows - // us to discover Python source code that can be used for inferring type - // information regarding third-party dependencies. That means that we don't need - // to care about any possible `lib64/site-packages` directories, since - // [the `sys`-module documentation] states that `sys.platlibdir` is *only* ever - // used for C extensions, never for pure-Python modules. - // - // [the non-Windows branch]: https://github.com/python/cpython/blob/a8be8fc6c4682089be45a87bd5ee1f686040116c/Lib/site.py#L401-L410 - // [the `sys`-module documentation]: https://docs.python.org/3/library/sys.html#sys.platlibdir - - // If we were able to figure out what Python version this installation is, - // we should be able to avoid iterating through all items in the `lib/` directory: - if let Some(version) = python_version { - let expected_path = sys_prefix_path.join(format!("lib/python{version}/site-packages")); - if system.is_directory(&expected_path) { - return Ok(expected_path); - } - if version.free_threaded_build_available() { - // Nearly the same as `expected_path`, but with an additional `t` after {version}: - let alternative_path = - sys_prefix_path.join(format!("lib/python{version}t/site-packages")); - if system.is_directory(&alternative_path) { - return Ok(alternative_path); - } - } - } - - // Either we couldn't figure out the version before calling this function - // (e.g., from a `pyvenv.cfg` file if this was a venv), - // or we couldn't find a `site-packages` folder at the expected location given - // the parsed version - // - // Note: the `python3.x` part of the `site-packages` path can't be computed from - // the `--target-version` the user has passed, as they might be running Python 3.12 locally - // even if they've requested that we type check their code "as if" they're running 3.8. - for entry_result in system - .read_directory(&sys_prefix_path.join("lib")) - .map_err(|io_err| { - SitePackagesDiscoveryError::CouldNotReadLibDirectory(io_err, sys_prefix_path.to_owned()) - })? - { - let Ok(entry) = entry_result else { - continue; - }; - - if !entry.file_type().is_directory() { - continue; - } - - let mut path = entry.into_path(); - - let name = path - .file_name() - .expect("File name to be non-null because path is guaranteed to be a child of `lib`"); - - if !name.starts_with("python3.") { - continue; - } - - path.push("site-packages"); - if system.is_directory(&path) { - return Ok(path); - } - } - Err(SitePackagesDiscoveryError::NoSitePackagesDirFound( - sys_prefix_path.to_owned(), - )) -} - -/// A path that represents the value of [`sys.prefix`] at runtime in Python -/// for a given Python executable. -/// -/// For the case of a virtual environment, where a -/// Python binary is at `/.venv/bin/python`, `sys.prefix` is the path to -/// the virtual environment the Python binary lies inside, i.e. `/.venv`, -/// and `site-packages` will be at `.venv/lib/python3.X/site-packages`. -/// System Python installations generally work the same way: if a system -/// Python installation lies at `/opt/homebrew/bin/python`, `sys.prefix` -/// will be `/opt/homebrew`, and `site-packages` will be at -/// `/opt/homebrew/lib/python3.X/site-packages`. -/// -/// [`sys.prefix`]: https://docs.python.org/3/library/sys.html#sys.prefix -#[derive(Debug, PartialEq, Eq, Clone)] -pub(crate) struct SysPrefixPath(SystemPathBuf); - -impl SysPrefixPath { - fn new( - unvalidated_path: impl AsRef, - system: &dyn System, - ) -> SitePackagesDiscoveryResult { - Self::new_impl(unvalidated_path.as_ref(), system) - } - - fn new_impl( - unvalidated_path: &SystemPath, - system: &dyn System, - ) -> SitePackagesDiscoveryResult { - // It's important to resolve symlinks here rather than simply making the path absolute, - // since system Python installations often only put symlinks in the "expected" - // locations for `home` and `site-packages` - let canonicalized = system - .canonicalize_path(unvalidated_path) - .map_err(|io_err| { - SitePackagesDiscoveryError::VenvDirCanonicalizationError( - unvalidated_path.to_path_buf(), - io_err, - ) - })?; - system - .is_directory(&canonicalized) - .then_some(Self(canonicalized)) - .ok_or_else(|| { - SitePackagesDiscoveryError::VenvDirIsNotADirectory(unvalidated_path.to_path_buf()) - }) - } - - fn from_executable_home_path(path: &PythonHomePath) -> Option { - // No need to check whether `path.parent()` is a directory: - // the parent of a canonicalised path that is known to exist - // is guaranteed to be a directory. - if cfg!(target_os = "windows") { - Some(Self(path.to_path_buf())) - } else { - path.parent().map(|path| Self(path.to_path_buf())) - } - } -} - -impl Deref for SysPrefixPath { - type Target = SystemPath; - - fn deref(&self) -> &Self::Target { - &self.0 - } -} - -impl fmt::Display for SysPrefixPath { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - write!(f, "`sys.prefix` path `{}`", self.0) - } -} - -/// The value given by the `home` key in `pyvenv.cfg` files. -/// -/// This is equivalent to `{sys_prefix_path}/bin`, and points -/// to a directory in which a Python executable can be found. -/// Confusingly, it is *not* the same as the [`PYTHONHOME`] -/// environment variable that Python provides! However, it's -/// consistent among all mainstream creators of Python virtual -/// environments (the stdlib Python `venv` module, the third-party -/// `virtualenv` library, and `uv`), was specified by -/// [the original PEP adding the `venv` module], -/// and it's one of the few fields that's read by the Python -/// standard library's `site.py` module. -/// -/// Although it doesn't appear to be specified anywhere, -/// all existing virtual environment tools always use an absolute path -/// for the `home` value, and the Python standard library also assumes -/// that the `home` value will be an absolute path. -/// -/// Other values, such as the path to the Python executable or the -/// base-executable `sys.prefix` value, are either only provided in -/// `pyvenv.cfg` files by some virtual-environment creators, -/// or are included under different keys depending on which -/// virtual-environment creation tool you've used. -/// -/// [`PYTHONHOME`]: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONHOME -/// [the original PEP adding the `venv` module]: https://peps.python.org/pep-0405/ -#[derive(Debug, PartialEq, Eq)] -struct PythonHomePath(SystemPathBuf); - -impl PythonHomePath { - fn new(path: impl AsRef, system: &dyn System) -> io::Result { - let path = path.as_ref(); - // It's important to resolve symlinks here rather than simply making the path absolute, - // since system Python installations often only put symlinks in the "expected" - // locations for `home` and `site-packages` - let canonicalized = system.canonicalize_path(path)?; - system - .is_directory(&canonicalized) - .then_some(Self(canonicalized)) - .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "not a directory")) - } -} - -impl Deref for PythonHomePath { - type Target = SystemPath; - - fn deref(&self) -> &Self::Target { - &self.0 - } -} - -impl fmt::Display for PythonHomePath { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - write!(f, "`home` location `{}`", self.0) - } -} - -impl PartialEq for PythonHomePath { - fn eq(&self, other: &SystemPath) -> bool { - &*self.0 == other - } -} - -impl PartialEq for PythonHomePath { - fn eq(&self, other: &SystemPathBuf) -> bool { - self == &**other - } -} - -#[cfg(test)] -mod tests { - use ruff_db::system::TestSystem; - - use super::*; - - struct VirtualEnvironmentTester { - system: TestSystem, - minor_version: u8, - free_threaded: bool, - system_site_packages: bool, - pyvenv_cfg_version_field: Option<&'static str>, - } - - impl VirtualEnvironmentTester { - /// Builds a mock virtual environment, and returns the path to the venv - fn build_mock_venv(&self) -> SystemPathBuf { - let VirtualEnvironmentTester { - system, - minor_version, - system_site_packages, - free_threaded, - pyvenv_cfg_version_field, - } = self; - let memory_fs = system.memory_file_system(); - let unix_site_packages = if *free_threaded { - format!("lib/python3.{minor_version}t/site-packages") - } else { - format!("lib/python3.{minor_version}/site-packages") - }; - - let system_install_sys_prefix = - SystemPathBuf::from(&*format!("/Python3.{minor_version}")); - let (system_home_path, system_exe_path, system_site_packages_path) = - if cfg!(target_os = "windows") { - let system_home_path = system_install_sys_prefix.clone(); - let system_exe_path = system_home_path.join("python.exe"); - let system_site_packages_path = - system_install_sys_prefix.join(r"Lib\site-packages"); - (system_home_path, system_exe_path, system_site_packages_path) - } else { - let system_home_path = system_install_sys_prefix.join("bin"); - let system_exe_path = system_home_path.join("python"); - let system_site_packages_path = - system_install_sys_prefix.join(&unix_site_packages); - (system_home_path, system_exe_path, system_site_packages_path) - }; - memory_fs.write_file(system_exe_path, "").unwrap(); - memory_fs - .create_directory_all(&system_site_packages_path) - .unwrap(); - - let venv_sys_prefix = SystemPathBuf::from("/.venv"); - let (venv_exe, site_packages_path) = if cfg!(target_os = "windows") { - ( - venv_sys_prefix.join(r"Scripts\python.exe"), - venv_sys_prefix.join(r"Lib\site-packages"), - ) - } else { - ( - venv_sys_prefix.join("bin/python"), - venv_sys_prefix.join(&unix_site_packages), - ) - }; - memory_fs.write_file(&venv_exe, "").unwrap(); - memory_fs.create_directory_all(&site_packages_path).unwrap(); - - let pyvenv_cfg_path = venv_sys_prefix.join("pyvenv.cfg"); - let mut pyvenv_cfg_contents = format!("home = {system_home_path}\n"); - if let Some(version_field) = pyvenv_cfg_version_field { - pyvenv_cfg_contents.push_str(version_field); - pyvenv_cfg_contents.push('\n'); - } - // Deliberately using weird casing here to test that our pyvenv.cfg parsing is case-insensitive: - if *system_site_packages { - pyvenv_cfg_contents.push_str("include-system-site-packages = TRuE\n"); - } - memory_fs - .write_file(pyvenv_cfg_path, &pyvenv_cfg_contents) - .unwrap(); - - venv_sys_prefix - } - - fn test(self) { - let venv_path = self.build_mock_venv(); - let venv = VirtualEnvironment::new(venv_path.clone(), &self.system).unwrap(); - - assert_eq!( - venv.venv_path, - SysPrefixPath(self.system.canonicalize_path(&venv_path).unwrap()) - ); - assert_eq!(venv.include_system_site_packages, self.system_site_packages); - - if self.pyvenv_cfg_version_field.is_some() { - assert_eq!( - venv.version, - Some(PythonVersion { - major: 3, - minor: self.minor_version - }) - ); - } else { - assert_eq!(venv.version, None); - } - - let expected_home = if cfg!(target_os = "windows") { - SystemPathBuf::from(&*format!(r"\Python3.{}", self.minor_version)) - } else { - SystemPathBuf::from(&*format!("/Python3.{}/bin", self.minor_version)) - }; - assert_eq!(venv.base_executable_home_path, expected_home); - - let site_packages_directories = venv.site_packages_directories(&self.system).unwrap(); - let expected_venv_site_packages = if cfg!(target_os = "windows") { - SystemPathBuf::from(r"\.venv\Lib\site-packages") - } else if self.free_threaded { - SystemPathBuf::from(&*format!( - "/.venv/lib/python3.{}t/site-packages", - self.minor_version - )) - } else { - SystemPathBuf::from(&*format!( - "/.venv/lib/python3.{}/site-packages", - self.minor_version - )) - }; - - let expected_system_site_packages = if cfg!(target_os = "windows") { - SystemPathBuf::from(&*format!( - r"\Python3.{}\Lib\site-packages", - self.minor_version - )) - } else if self.free_threaded { - SystemPathBuf::from(&*format!( - "/Python3.{minor_version}/lib/python3.{minor_version}t/site-packages", - minor_version = self.minor_version - )) - } else { - SystemPathBuf::from(&*format!( - "/Python3.{minor_version}/lib/python3.{minor_version}/site-packages", - minor_version = self.minor_version - )) - }; - - if self.system_site_packages { - assert_eq!( - &site_packages_directories, - &[expected_venv_site_packages, expected_system_site_packages] - ); - } else { - assert_eq!(&site_packages_directories, &[expected_venv_site_packages]); - } - } - } - - #[test] - fn can_find_site_packages_directory_no_version_field_in_pyvenv_cfg() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 12, - free_threaded: false, - system_site_packages: false, - pyvenv_cfg_version_field: None, - }; - tester.test(); - } - - #[test] - fn can_find_site_packages_directory_venv_style_version_field_in_pyvenv_cfg() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 12, - free_threaded: false, - system_site_packages: false, - pyvenv_cfg_version_field: Some("version = 3.12"), - }; - tester.test(); - } - - #[test] - fn can_find_site_packages_directory_uv_style_version_field_in_pyvenv_cfg() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 12, - free_threaded: false, - system_site_packages: false, - pyvenv_cfg_version_field: Some("version_info = 3.12"), - }; - tester.test(); - } - - #[test] - fn can_find_site_packages_directory_virtualenv_style_version_field_in_pyvenv_cfg() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 12, - free_threaded: false, - system_site_packages: false, - pyvenv_cfg_version_field: Some("version_info = 3.12.0rc2"), - }; - tester.test(); - } - - #[test] - fn can_find_site_packages_directory_freethreaded_build() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 13, - free_threaded: true, - system_site_packages: false, - pyvenv_cfg_version_field: Some("version_info = 3.13"), - }; - tester.test(); - } - - #[test] - fn finds_system_site_packages() { - let tester = VirtualEnvironmentTester { - system: TestSystem::default(), - minor_version: 13, - free_threaded: true, - system_site_packages: true, - pyvenv_cfg_version_field: Some("version_info = 3.13"), - }; - tester.test(); - } - - #[test] - fn reject_venv_that_does_not_exist() { - let system = TestSystem::default(); - assert!(matches!( - VirtualEnvironment::new("/.venv", &system), - Err(SitePackagesDiscoveryError::VenvDirIsNotADirectory(_)) - )); - } - - #[test] - fn reject_venv_with_no_pyvenv_cfg_file() { - let system = TestSystem::default(); - system - .memory_file_system() - .create_directory_all("/.venv") - .unwrap(); - assert!(matches!( - VirtualEnvironment::new("/.venv", &system), - Err(SitePackagesDiscoveryError::NoPyvenvCfgFile(_)) - )); - } - - #[test] - fn parsing_pyvenv_cfg_with_too_many_equals() { - let system = TestSystem::default(); - let memory_fs = system.memory_file_system(); - let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); - memory_fs - .write_file(&pyvenv_cfg_path, "home = bar = /.venv/bin") - .unwrap(); - let venv_result = VirtualEnvironment::new("/.venv", &system); - assert!(matches!( - venv_result, - Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - path, - PyvenvCfgParseErrorKind::TooManyEquals { line_number } - )) - if path == pyvenv_cfg_path && Some(line_number) == NonZeroUsize::new(1) - )); - } - - #[test] - fn parsing_pyvenv_cfg_with_key_but_no_value_fails() { - let system = TestSystem::default(); - let memory_fs = system.memory_file_system(); - let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); - memory_fs.write_file(&pyvenv_cfg_path, "home =").unwrap(); - let venv_result = VirtualEnvironment::new("/.venv", &system); - assert!(matches!( - venv_result, - Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - path, - PyvenvCfgParseErrorKind::MalformedKeyValuePair { line_number } - )) - if path == pyvenv_cfg_path && Some(line_number) == NonZeroUsize::new(1) - )); - } - - #[test] - fn parsing_pyvenv_cfg_with_value_but_no_key_fails() { - let system = TestSystem::default(); - let memory_fs = system.memory_file_system(); - let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); - memory_fs - .write_file(&pyvenv_cfg_path, "= whatever") - .unwrap(); - let venv_result = VirtualEnvironment::new("/.venv", &system); - assert!(matches!( - venv_result, - Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - path, - PyvenvCfgParseErrorKind::MalformedKeyValuePair { line_number } - )) - if path == pyvenv_cfg_path && Some(line_number) == NonZeroUsize::new(1) - )); - } - - #[test] - fn parsing_pyvenv_cfg_with_no_home_key_fails() { - let system = TestSystem::default(); - let memory_fs = system.memory_file_system(); - let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); - memory_fs.write_file(&pyvenv_cfg_path, "").unwrap(); - let venv_result = VirtualEnvironment::new("/.venv", &system); - assert!(matches!( - venv_result, - Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - path, - PyvenvCfgParseErrorKind::NoHomeKey - )) - if path == pyvenv_cfg_path - )); - } - - #[test] - fn parsing_pyvenv_cfg_with_invalid_home_key_fails() { - let system = TestSystem::default(); - let memory_fs = system.memory_file_system(); - let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); - memory_fs - .write_file(&pyvenv_cfg_path, "home = foo") - .unwrap(); - let venv_result = VirtualEnvironment::new("/.venv", &system); - assert!(matches!( - venv_result, - Err(SitePackagesDiscoveryError::PyvenvCfgParseError( - path, - PyvenvCfgParseErrorKind::InvalidHomeValue(_) - )) - if path == pyvenv_cfg_path - )); - } -} diff --git a/crates/red_knot_python_semantic/src/stdlib.rs b/crates/red_knot_python_semantic/src/stdlib.rs deleted file mode 100644 index dd62f131b9b74..0000000000000 --- a/crates/red_knot_python_semantic/src/stdlib.rs +++ /dev/null @@ -1,106 +0,0 @@ -use crate::module_name::ModuleName; -use crate::module_resolver::resolve_module; -use crate::semantic_index::global_scope; -use crate::semantic_index::symbol::ScopeId; -use crate::types::{global_symbol_ty, Type}; -use crate::Db; - -/// Enumeration of various core stdlib modules, for which we have dedicated Salsa queries. -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -enum CoreStdlibModule { - Builtins, - Types, - // the Typing enum is currently only used in tests - #[allow(dead_code)] - Typing, - Typeshed, - TypingExtensions, -} - -impl CoreStdlibModule { - fn name(self) -> ModuleName { - let module_name = match self { - Self::Builtins => "builtins", - Self::Types => "types", - Self::Typing => "typing", - Self::Typeshed => "_typeshed", - Self::TypingExtensions => "typing_extensions", - }; - ModuleName::new_static(module_name) - .unwrap_or_else(|| panic!("{module_name} should be a valid module name!")) - } -} - -/// Lookup the type of `symbol` in a given core module -/// -/// Returns `Unbound` if the given core module cannot be resolved for some reason -fn core_module_symbol_ty<'db>( - db: &'db dyn Db, - core_module: CoreStdlibModule, - symbol: &str, -) -> Type<'db> { - resolve_module(db, &core_module.name()) - .map(|module| global_symbol_ty(db, module.file(), symbol)) - .map(|ty| { - if ty.is_unbound() { - ty - } else { - ty.replace_unbound_with(db, Type::Never) - } - }) - .unwrap_or(Type::Unbound) -} - -/// Lookup the type of `symbol` in the builtins namespace. -/// -/// Returns `Unbound` if the `builtins` module isn't available for some reason. -#[inline] -pub(crate) fn builtins_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> { - core_module_symbol_ty(db, CoreStdlibModule::Builtins, symbol) -} - -/// Lookup the type of `symbol` in the `types` module namespace. -/// -/// Returns `Unbound` if the `types` module isn't available for some reason. -#[inline] -pub(crate) fn types_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> { - core_module_symbol_ty(db, CoreStdlibModule::Types, symbol) -} - -/// Lookup the type of `symbol` in the `typing` module namespace. -/// -/// Returns `Unbound` if the `typing` module isn't available for some reason. -#[inline] -#[allow(dead_code)] // currently only used in tests -pub(crate) fn typing_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> { - core_module_symbol_ty(db, CoreStdlibModule::Typing, symbol) -} -/// Lookup the type of `symbol` in the `_typeshed` module namespace. -/// -/// Returns `Unbound` if the `_typeshed` module isn't available for some reason. -#[inline] -pub(crate) fn typeshed_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> { - core_module_symbol_ty(db, CoreStdlibModule::Typeshed, symbol) -} - -/// Lookup the type of `symbol` in the `typing_extensions` module namespace. -/// -/// Returns `Unbound` if the `typing_extensions` module isn't available for some reason. -#[inline] -pub(crate) fn typing_extensions_symbol_ty<'db>(db: &'db dyn Db, symbol: &str) -> Type<'db> { - core_module_symbol_ty(db, CoreStdlibModule::TypingExtensions, symbol) -} - -/// Get the scope of a core stdlib module. -/// -/// Can return `None` if a custom typeshed is used that is missing the core module in question. -fn core_module_scope(db: &dyn Db, core_module: CoreStdlibModule) -> Option> { - resolve_module(db, &core_module.name()).map(|module| global_scope(db, module.file())) -} - -/// Get the `builtins` module scope. -/// -/// Can return `None` if a custom typeshed is used that is missing `builtins.pyi`. -pub(crate) fn builtins_module_scope(db: &dyn Db) -> Option> { - core_module_scope(db, CoreStdlibModule::Builtins) -} diff --git a/crates/red_knot_python_semantic/src/types.rs b/crates/red_knot_python_semantic/src/types.rs deleted file mode 100644 index 092699c9a2926..0000000000000 --- a/crates/red_knot_python_semantic/src/types.rs +++ /dev/null @@ -1,2193 +0,0 @@ -use infer::TypeInferenceBuilder; -use ruff_db::files::File; -use ruff_python_ast as ast; - -use crate::module_resolver::file_to_module; -use crate::semantic_index::ast_ids::HasScopedAstId; -use crate::semantic_index::definition::{Definition, DefinitionKind}; -use crate::semantic_index::symbol::{ScopeId, ScopedSymbolId}; -use crate::semantic_index::{ - global_scope, semantic_index, symbol_table, use_def_map, BindingWithConstraints, - BindingWithConstraintsIterator, DeclarationsIterator, -}; -use crate::stdlib::{ - builtins_symbol_ty, types_symbol_ty, typeshed_symbol_ty, typing_extensions_symbol_ty, -}; -use crate::types::narrow::narrowing_constraint; -use crate::{Db, FxOrderSet, HasTy, Module, SemanticModel}; - -pub(crate) use self::builder::{IntersectionBuilder, UnionBuilder}; -pub use self::diagnostic::{TypeCheckDiagnostic, TypeCheckDiagnostics}; -pub(crate) use self::display::TypeArrayDisplay; -pub(crate) use self::infer::{ - infer_deferred_types, infer_definition_types, infer_expression_types, infer_scope_types, -}; - -mod builder; -mod diagnostic; -mod display; -mod infer; -mod narrow; - -pub fn check_types(db: &dyn Db, file: File) -> TypeCheckDiagnostics { - let _span = tracing::trace_span!("check_types", file=?file.path(db)).entered(); - - let index = semantic_index(db, file); - let mut diagnostics = TypeCheckDiagnostics::new(); - - for scope_id in index.scope_ids() { - let result = infer_scope_types(db, scope_id); - diagnostics.extend(result.diagnostics()); - } - - diagnostics -} - -/// Infer the public type of a symbol (its type as seen from outside its scope). -fn symbol_ty_by_id<'db>(db: &'db dyn Db, scope: ScopeId<'db>, symbol: ScopedSymbolId) -> Type<'db> { - let _span = tracing::trace_span!("symbol_ty_by_id", ?symbol).entered(); - - let use_def = use_def_map(db, scope); - - // If the symbol is declared, the public type is based on declarations; otherwise, it's based - // on inference from bindings. - if use_def.has_public_declarations(symbol) { - let declarations = use_def.public_declarations(symbol); - // If the symbol is undeclared in some paths, include the inferred type in the public type. - let undeclared_ty = if declarations.may_be_undeclared() { - Some(bindings_ty( - db, - use_def.public_bindings(symbol), - use_def - .public_may_be_unbound(symbol) - .then_some(Type::Unbound), - )) - } else { - None - }; - // Intentionally ignore conflicting declared types; that's not our problem, it's the - // problem of the module we are importing from. - declarations_ty(db, declarations, undeclared_ty).unwrap_or_else(|(ty, _)| ty) - } else { - bindings_ty( - db, - use_def.public_bindings(symbol), - use_def - .public_may_be_unbound(symbol) - .then_some(Type::Unbound), - ) - } -} - -/// Shorthand for `symbol_ty_by_id` that takes a symbol name instead of an ID. -fn symbol_ty<'db>(db: &'db dyn Db, scope: ScopeId<'db>, name: &str) -> Type<'db> { - let table = symbol_table(db, scope); - table - .symbol_id_by_name(name) - .map(|symbol| symbol_ty_by_id(db, scope, symbol)) - .unwrap_or(Type::Unbound) -} - -/// Shorthand for `symbol_ty` that looks up a module-global symbol by name in a file. -pub(crate) fn global_symbol_ty<'db>(db: &'db dyn Db, file: File, name: &str) -> Type<'db> { - symbol_ty(db, global_scope(db, file), name) -} - -/// Infer the type of a binding. -pub(crate) fn binding_ty<'db>(db: &'db dyn Db, definition: Definition<'db>) -> Type<'db> { - let inference = infer_definition_types(db, definition); - inference.binding_ty(definition) -} - -/// Infer the type of a declaration. -fn declaration_ty<'db>(db: &'db dyn Db, definition: Definition<'db>) -> Type<'db> { - let inference = infer_definition_types(db, definition); - inference.declaration_ty(definition) -} - -/// Infer the type of a (possibly deferred) sub-expression of a [`Definition`]. -/// -/// ## Panics -/// If the given expression is not a sub-expression of the given [`Definition`]. -fn definition_expression_ty<'db>( - db: &'db dyn Db, - definition: Definition<'db>, - expression: &ast::Expr, -) -> Type<'db> { - let expr_id = expression.scoped_ast_id(db, definition.scope(db)); - let inference = infer_definition_types(db, definition); - if let Some(ty) = inference.try_expression_ty(expr_id) { - ty - } else { - infer_deferred_types(db, definition).expression_ty(expr_id) - } -} - -/// Infer the combined type of an iterator of bindings, plus one optional "unbound type". -/// -/// Will return a union if there is more than one binding, or at least one plus an unbound -/// type. -/// -/// The "unbound type" represents the type in case control flow may not have passed through any -/// bindings in this scope. If this isn't possible, then it will be `None`. If it is possible, and -/// the result in that case should be Unbound (e.g. an unbound function local), then it will be -/// `Some(Type::Unbound)`. If it is possible and the result should be something else (e.g. an -/// implicit global lookup), then `unbound_type` will be `Some(the_global_symbol_type)`. -/// -/// # Panics -/// Will panic if called with zero bindings and no `unbound_ty`. This is a logic error, as any -/// symbol with zero visible bindings clearly may be unbound, and the caller should provide an -/// `unbound_ty`. -fn bindings_ty<'db>( - db: &'db dyn Db, - bindings_with_constraints: BindingWithConstraintsIterator<'_, 'db>, - unbound_ty: Option>, -) -> Type<'db> { - let def_types = bindings_with_constraints.map( - |BindingWithConstraints { - binding, - constraints, - }| { - let mut constraint_tys = constraints - .filter_map(|constraint| narrowing_constraint(db, constraint, binding)) - .peekable(); - - let binding_ty = binding_ty(db, binding); - if constraint_tys.peek().is_some() { - constraint_tys - .fold( - IntersectionBuilder::new(db).add_positive(binding_ty), - IntersectionBuilder::add_positive, - ) - .build() - } else { - binding_ty - } - }, - ); - let mut all_types = unbound_ty.into_iter().chain(def_types); - - let first = all_types - .next() - .expect("bindings_ty should never be called with zero definitions and no unbound_ty"); - - if let Some(second) = all_types.next() { - UnionType::from_elements(db, [first, second].into_iter().chain(all_types)) - } else { - first - } -} - -/// The result of looking up a declared type from declarations; see [`declarations_ty`]. -type DeclaredTypeResult<'db> = Result, (Type<'db>, Box<[Type<'db>]>)>; - -/// Build a declared type from a [`DeclarationsIterator`]. -/// -/// If there is only one declaration, or all declarations declare the same type, returns -/// `Ok(declared_type)`. If there are conflicting declarations, returns -/// `Err((union_of_declared_types, conflicting_declared_types))`. -/// -/// If undeclared is a possibility, `undeclared_ty` type will be part of the return type (and may -/// conflict with other declarations.) -/// -/// # Panics -/// Will panic if there are no declarations and no `undeclared_ty` is provided. This is a logic -/// error, as any symbol with zero live declarations clearly must be undeclared, and the caller -/// should provide an `undeclared_ty`. -fn declarations_ty<'db>( - db: &'db dyn Db, - declarations: DeclarationsIterator<'_, 'db>, - undeclared_ty: Option>, -) -> DeclaredTypeResult<'db> { - let decl_types = declarations.map(|declaration| declaration_ty(db, declaration)); - - let mut all_types = undeclared_ty.into_iter().chain(decl_types); - - let first = all_types.next().expect( - "declarations_ty must not be called with zero declarations and no may-be-undeclared", - ); - - let mut conflicting: Vec> = vec![]; - let declared_ty = if let Some(second) = all_types.next() { - let mut builder = UnionBuilder::new(db).add(first); - for other in [second].into_iter().chain(all_types) { - // Make sure not to emit spurious errors relating to `Type::Todo`, - // since we only infer this type due to a limitation in our current model. - // - // `Unknown` is different here, since we might infer `Unknown` - // for one of these due to a variable being defined in one possible - // control-flow branch but not another one. - if !first.is_equivalent_to(db, other) && !first.is_todo() && !other.is_todo() { - conflicting.push(other); - } - builder = builder.add(other); - } - builder.build() - } else { - first - }; - if conflicting.is_empty() { - Ok(declared_ty) - } else { - Err(( - declared_ty, - [first].into_iter().chain(conflicting).collect(), - )) - } -} - -/// Unique ID for a type. -#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] -pub enum Type<'db> { - /// The dynamic type: a statically-unknown set of values - Any, - /// The empty set of values - Never, - /// Unknown type (either no annotation, or some kind of type error). - /// Equivalent to Any, or possibly to object in strict mode - Unknown, - /// Name does not exist or is not bound to any value (this represents an error, but with some - /// leniency options it could be silently resolved to Unknown in some cases) - Unbound, - /// The None object -- TODO remove this in favor of Instance(types.NoneType) - None, - /// Temporary type for symbols that can't be inferred yet because of missing implementations. - /// Behaves equivalently to `Any`. - /// - /// This variant should eventually be removed once red-knot is spec-compliant. - /// - /// General rule: `Todo` should only propagate when the presence of the input `Todo` caused the - /// output to be unknown. An output should only be `Todo` if fixing all `Todo` inputs to be not - /// `Todo` would change the output type. - Todo, - /// A specific function object - FunctionLiteral(FunctionType<'db>), - /// A specific module object - ModuleLiteral(File), - /// A specific class object - ClassLiteral(ClassType<'db>), - /// The set of Python objects with the given class in their __class__'s method resolution order - Instance(ClassType<'db>), - /// The set of objects in any of the types in the union - Union(UnionType<'db>), - /// The set of objects in all of the types in the intersection - Intersection(IntersectionType<'db>), - /// An integer literal - IntLiteral(i64), - /// A boolean literal, either `True` or `False`. - BooleanLiteral(bool), - /// A string literal - StringLiteral(StringLiteralType<'db>), - /// A string known to originate only from literal values, but whose value is not known (unlike - /// `StringLiteral` above). - LiteralString, - /// A bytes literal - BytesLiteral(BytesLiteralType<'db>), - /// A heterogeneous tuple type, with elements of the given types in source order. - // TODO: Support variable length homogeneous tuple type like `tuple[int, ...]`. - Tuple(TupleType<'db>), - // TODO protocols, callable types, overloads, generics, type vars -} - -impl<'db> Type<'db> { - pub const fn is_unbound(&self) -> bool { - matches!(self, Type::Unbound) - } - - pub const fn is_never(&self) -> bool { - matches!(self, Type::Never) - } - - pub const fn is_todo(&self) -> bool { - matches!(self, Type::Todo) - } - - pub const fn into_class_literal_type(self) -> Option> { - match self { - Type::ClassLiteral(class_type) => Some(class_type), - _ => None, - } - } - - #[track_caller] - pub fn expect_class_literal(self) -> ClassType<'db> { - self.into_class_literal_type() - .expect("Expected a Type::ClassLiteral variant") - } - - pub const fn is_class_literal(&self) -> bool { - matches!(self, Type::ClassLiteral(..)) - } - - pub const fn into_module_literal_type(self) -> Option { - match self { - Type::ModuleLiteral(file) => Some(file), - _ => None, - } - } - - #[track_caller] - pub fn expect_module_literal(self) -> File { - self.into_module_literal_type() - .expect("Expected a Type::ModuleLiteral variant") - } - - #[must_use] - pub fn negate(&self, db: &'db dyn Db) -> Type<'db> { - IntersectionBuilder::new(db).add_negative(*self).build() - } - - pub const fn into_union_type(self) -> Option> { - match self { - Type::Union(union_type) => Some(union_type), - _ => None, - } - } - - #[track_caller] - pub fn expect_union(self) -> UnionType<'db> { - self.into_union_type() - .expect("Expected a Type::Union variant") - } - - pub const fn is_union(&self) -> bool { - matches!(self, Type::Union(..)) - } - - pub const fn into_intersection_type(self) -> Option> { - match self { - Type::Intersection(intersection_type) => Some(intersection_type), - _ => None, - } - } - - #[track_caller] - pub fn expect_intersection(self) -> IntersectionType<'db> { - self.into_intersection_type() - .expect("Expected a Type::Intersection variant") - } - - pub const fn into_function_literal_type(self) -> Option> { - match self { - Type::FunctionLiteral(function_type) => Some(function_type), - _ => None, - } - } - - #[track_caller] - pub fn expect_function_literal(self) -> FunctionType<'db> { - self.into_function_literal_type() - .expect("Expected a Type::FunctionLiteral variant") - } - - pub const fn is_function_literal(&self) -> bool { - matches!(self, Type::FunctionLiteral(..)) - } - - pub const fn into_int_literal_type(self) -> Option { - match self { - Type::IntLiteral(value) => Some(value), - _ => None, - } - } - - #[track_caller] - pub fn expect_int_literal(self) -> i64 { - self.into_int_literal_type() - .expect("Expected a Type::IntLiteral variant") - } - - pub const fn is_boolean_literal(&self) -> bool { - matches!(self, Type::BooleanLiteral(..)) - } - - pub const fn is_literal_string(&self) -> bool { - matches!(self, Type::LiteralString) - } - - pub fn may_be_unbound(&self, db: &'db dyn Db) -> bool { - match self { - Type::Unbound => true, - Type::Union(union) => union.elements(db).contains(&Type::Unbound), - // Unbound can't appear in an intersection, because an intersection with Unbound - // simplifies to just Unbound. - _ => false, - } - } - - #[must_use] - pub fn replace_unbound_with(&self, db: &'db dyn Db, replacement: Type<'db>) -> Type<'db> { - match self { - Type::Unbound => replacement, - Type::Union(union) => { - union.map(db, |element| element.replace_unbound_with(db, replacement)) - } - _ => *self, - } - } - - pub fn is_stdlib_symbol(&self, db: &'db dyn Db, module_name: &str, name: &str) -> bool { - match self { - Type::ClassLiteral(class) => class.is_stdlib_symbol(db, module_name, name), - Type::FunctionLiteral(function) => function.is_stdlib_symbol(db, module_name, name), - _ => false, - } - } - - /// Return true if this type is a [subtype of] type `target`. - /// - /// [subtype of]: https://typing.readthedocs.io/en/latest/spec/concepts.html#subtype-supertype-and-type-equivalence - pub(crate) fn is_subtype_of(self, db: &'db dyn Db, target: Type<'db>) -> bool { - if self.is_equivalent_to(db, target) { - return true; - } - match (self, target) { - (Type::Unknown | Type::Any | Type::Todo, _) => false, - (_, Type::Unknown | Type::Any | Type::Todo) => false, - (Type::Never, _) => true, - (_, Type::Never) => false, - (_, Type::Instance(class)) if class.is_known(db, KnownClass::Object) => true, - (Type::Instance(class), _) if class.is_known(db, KnownClass::Object) => false, - (Type::BooleanLiteral(_), Type::Instance(class)) - if class.is_known(db, KnownClass::Bool) => - { - true - } - (Type::IntLiteral(_), Type::Instance(class)) if class.is_known(db, KnownClass::Int) => { - true - } - (Type::StringLiteral(_), Type::LiteralString) => true, - (Type::StringLiteral(_) | Type::LiteralString, Type::Instance(class)) - if class.is_known(db, KnownClass::Str) => - { - true - } - (Type::BytesLiteral(_), Type::Instance(class)) - if class.is_known(db, KnownClass::Bytes) => - { - true - } - (Type::ClassLiteral(..), Type::Instance(class)) - if class.is_known(db, KnownClass::Type) => - { - true - } - (Type::Union(union), ty) => union - .elements(db) - .iter() - .all(|&elem_ty| elem_ty.is_subtype_of(db, ty)), - (ty, Type::Union(union)) => union - .elements(db) - .iter() - .any(|&elem_ty| ty.is_subtype_of(db, elem_ty)), - (Type::Instance(self_class), Type::Instance(target_class)) => { - self_class.is_subclass_of(db, target_class) - } - // TODO - _ => false, - } - } - - /// Return true if this type is [assignable to] type `target`. - /// - /// [assignable to]: https://typing.readthedocs.io/en/latest/spec/concepts.html#the-assignable-to-or-consistent-subtyping-relation - pub(crate) fn is_assignable_to(self, db: &'db dyn Db, target: Type<'db>) -> bool { - if self.is_equivalent_to(db, target) { - return true; - } - match (self, target) { - (Type::Unknown | Type::Any | Type::Todo, _) => true, - (_, Type::Unknown | Type::Any | Type::Todo) => true, - (ty, Type::Union(union)) => union - .elements(db) - .iter() - .any(|&elem_ty| ty.is_assignable_to(db, elem_ty)), - // TODO other types containing gradual forms (e.g. generics containing Any/Unknown) - _ => self.is_subtype_of(db, target), - } - } - - /// Return true if this type is equivalent to type `other`. - pub(crate) fn is_equivalent_to(self, _db: &'db dyn Db, other: Type<'db>) -> bool { - // TODO equivalent but not identical structural types, differently-ordered unions and - // intersections, other cases? - self == other - } - - /// Return true if this type and `other` have no common elements. - /// - /// Note: This function aims to have no false positives, but might return - /// wrong `false` answers in some cases. - pub(crate) fn is_disjoint_from(self, db: &'db dyn Db, other: Type<'db>) -> bool { - match (self, other) { - (Type::Never, _) | (_, Type::Never) => true, - - (Type::Any, _) | (_, Type::Any) => false, - (Type::Unknown, _) | (_, Type::Unknown) => false, - (Type::Unbound, _) | (_, Type::Unbound) => false, - (Type::Todo, _) | (_, Type::Todo) => false, - - (Type::Union(union), other) | (other, Type::Union(union)) => union - .elements(db) - .iter() - .all(|e| e.is_disjoint_from(db, other)), - - (Type::Intersection(intersection), other) - | (other, Type::Intersection(intersection)) => { - if intersection - .positive(db) - .iter() - .any(|p| p.is_disjoint_from(db, other)) - { - true - } else { - // TODO we can do better here. For example: - // X & ~Literal[1] is disjoint from Literal[1] - false - } - } - - ( - left @ (Type::None - | Type::BooleanLiteral(..) - | Type::IntLiteral(..) - | Type::StringLiteral(..) - | Type::BytesLiteral(..) - | Type::FunctionLiteral(..) - | Type::ModuleLiteral(..) - | Type::ClassLiteral(..)), - right @ (Type::None - | Type::BooleanLiteral(..) - | Type::IntLiteral(..) - | Type::StringLiteral(..) - | Type::BytesLiteral(..) - | Type::FunctionLiteral(..) - | Type::ModuleLiteral(..) - | Type::ClassLiteral(..)), - ) => left != right, - - (Type::None, Type::Instance(class_type)) | (Type::Instance(class_type), Type::None) => { - !matches!( - class_type.known(db), - Some(KnownClass::NoneType | KnownClass::Object) - ) - } - (Type::None, _) | (_, Type::None) => true, - - (Type::BooleanLiteral(..), Type::Instance(class_type)) - | (Type::Instance(class_type), Type::BooleanLiteral(..)) => !matches!( - class_type.known(db), - Some(KnownClass::Bool | KnownClass::Int | KnownClass::Object) - ), - (Type::BooleanLiteral(..), _) | (_, Type::BooleanLiteral(..)) => true, - - (Type::IntLiteral(..), Type::Instance(class_type)) - | (Type::Instance(class_type), Type::IntLiteral(..)) => !matches!( - class_type.known(db), - Some(KnownClass::Int | KnownClass::Object) - ), - (Type::IntLiteral(..), _) | (_, Type::IntLiteral(..)) => true, - - (Type::StringLiteral(..), Type::LiteralString) - | (Type::LiteralString, Type::StringLiteral(..)) => false, - (Type::StringLiteral(..), Type::Instance(class_type)) - | (Type::Instance(class_type), Type::StringLiteral(..)) => !matches!( - class_type.known(db), - Some(KnownClass::Str | KnownClass::Object) - ), - (Type::StringLiteral(..), _) | (_, Type::StringLiteral(..)) => true, - - (Type::LiteralString, Type::LiteralString) => false, - (Type::LiteralString, Type::Instance(class_type)) - | (Type::Instance(class_type), Type::LiteralString) => !matches!( - class_type.known(db), - Some(KnownClass::Str | KnownClass::Object) - ), - (Type::LiteralString, _) | (_, Type::LiteralString) => true, - - (Type::BytesLiteral(..), Type::Instance(class_type)) - | (Type::Instance(class_type), Type::BytesLiteral(..)) => !matches!( - class_type.known(db), - Some(KnownClass::Bytes | KnownClass::Object) - ), - (Type::BytesLiteral(..), _) | (_, Type::BytesLiteral(..)) => true, - - ( - Type::FunctionLiteral(..) | Type::ModuleLiteral(..) | Type::ClassLiteral(..), - Type::Instance(class_type), - ) - | ( - Type::Instance(class_type), - Type::FunctionLiteral(..) | Type::ModuleLiteral(..) | Type::ClassLiteral(..), - ) => !class_type.is_known(db, KnownClass::Object), - - (Type::Instance(..), Type::Instance(..)) => { - // TODO: once we have support for `final`, there might be some cases where - // we can determine that two types are disjoint. For non-final classes, we - // return false (multiple inheritance). - - // TODO: is there anything specific to do for instances of KnownClass::Type? - - false - } - - (Type::Tuple(tuple), other) | (other, Type::Tuple(tuple)) => { - if let Type::Tuple(other_tuple) = other { - if tuple.len(db) == other_tuple.len(db) { - tuple - .elements(db) - .iter() - .zip(other_tuple.elements(db)) - .any(|(e1, e2)| e1.is_disjoint_from(db, *e2)) - } else { - true - } - } else { - // We can not be sure if the tuple is disjoint from 'other' because: - // - 'other' might be the homogeneous arbitrary-length tuple type - // tuple[T, ...] (which we don't have support for yet); if all of - // our element types are not disjoint with T, this is not disjoint - // - 'other' might be a user subtype of tuple, which, if generic - // over the same or compatible *Ts, would overlap with tuple. - // - // TODO: add checks for the above cases once we support them - - false - } - } - } - } - - /// Return true if there is just a single inhabitant for this type. - /// - /// Note: This function aims to have no false positives, but might return `false` - /// for more complicated types that are actually singletons. - pub(crate) fn is_singleton(self) -> bool { - match self { - Type::Any - | Type::Never - | Type::Unknown - | Type::Todo - | Type::Unbound - | Type::Instance(..) // TODO some instance types can be singleton types (EllipsisType, NotImplementedType) - | Type::IntLiteral(..) - | Type::StringLiteral(..) - | Type::BytesLiteral(..) - | Type::LiteralString => { - // Note: The literal types included in this pattern are not true singletons. - // There can be multiple Python objects (at different memory locations) that - // are both of type Literal[345], for example. - false - } - Type::None | Type::BooleanLiteral(_) | Type::FunctionLiteral(..) | Type::ClassLiteral(..) | Type::ModuleLiteral(..) => true, - Type::Tuple(..) => { - // The empty tuple is a singleton on CPython and PyPy, but not on other Python - // implementations such as GraalPy. Its *use* as a singleton is discouraged and - // should not be relied on for type narrowing, so we do not treat it as one. - // See: - // https://docs.python.org/3/reference/expressions.html#parenthesized-forms - false - } - Type::Union(..) => { - // A single-element union, where the sole element was a singleton, would itself - // be a singleton type. However, unions with length < 2 should never appear in - // our model due to [`UnionBuilder::build`]. - false - } - Type::Intersection(..) => { - // Here, we assume that all intersection types that are singletons would have - // been reduced to a different form via [`IntersectionBuilder::build`] by now. - // For example: - // - // bool & ~Literal[False] = Literal[True] - // None & (None | int) = None | None & int = None - // - false - } - } - } - - /// Return true if this type is non-empty and all inhabitants of this type compare equal. - pub(crate) fn is_single_valued(self, db: &'db dyn Db) -> bool { - match self { - Type::None - | Type::FunctionLiteral(..) - | Type::ModuleLiteral(..) - | Type::ClassLiteral(..) - | Type::IntLiteral(..) - | Type::BooleanLiteral(..) - | Type::StringLiteral(..) - | Type::BytesLiteral(..) => true, - - Type::Tuple(tuple) => tuple - .elements(db) - .iter() - .all(|elem| elem.is_single_valued(db)), - - Type::Instance(class_type) => match class_type.known(db) { - Some(KnownClass::NoneType) => true, - Some( - KnownClass::Bool - | KnownClass::Object - | KnownClass::Bytes - | KnownClass::Type - | KnownClass::Int - | KnownClass::Float - | KnownClass::Str - | KnownClass::List - | KnownClass::Tuple - | KnownClass::Set - | KnownClass::Dict - | KnownClass::GenericAlias - | KnownClass::ModuleType - | KnownClass::FunctionType, - ) => false, - None => false, - }, - - Type::Any - | Type::Never - | Type::Unknown - | Type::Unbound - | Type::Todo - | Type::Union(..) - | Type::Intersection(..) - | Type::LiteralString => false, - } - } - - /// Resolve a member access of a type. - /// - /// For example, if `foo` is `Type::Instance()`, - /// `foo.member(&db, "baz")` returns the type of `baz` attributes - /// as accessed from instances of the `Bar` class. - /// - /// TODO: use of this method currently requires manually checking - /// whether the returned type is `Unknown`/`Unbound` - /// (or a union with `Unknown`/`Unbound`) in many places. - /// Ideally we'd use a more type-safe pattern, such as returning - /// an `Option` or a `Result` from this method, which would force - /// us to explicitly consider whether to handle an error or propagate - /// it up the call stack. - #[must_use] - pub fn member(&self, db: &'db dyn Db, name: &str) -> Type<'db> { - match self { - Type::Any => Type::Any, - Type::Never => { - // TODO: attribute lookup on Never type - Type::Todo - } - Type::Unknown => Type::Unknown, - Type::Unbound => Type::Unbound, - Type::None => { - // TODO: attribute lookup on None type - Type::Todo - } - Type::FunctionLiteral(_) => { - // TODO: attribute lookup on function type - Type::Todo - } - Type::ModuleLiteral(file) => global_symbol_ty(db, *file, name), - Type::ClassLiteral(class) => class.class_member(db, name), - Type::Instance(_) => { - // TODO MRO? get_own_instance_member, get_instance_member - Type::Todo - } - Type::Union(union) => union.map(db, |element| element.member(db, name)), - Type::Intersection(_) => { - // TODO perform the get_member on each type in the intersection - // TODO return the intersection of those results - Type::Todo - } - Type::IntLiteral(_) => { - // TODO raise error - Type::Todo - } - Type::BooleanLiteral(_) => Type::Todo, - Type::StringLiteral(_) => { - // TODO defer to `typing.LiteralString`/`builtins.str` methods - // from typeshed's stubs - Type::Todo - } - Type::LiteralString => { - // TODO defer to `typing.LiteralString`/`builtins.str` methods - // from typeshed's stubs - Type::Todo - } - Type::BytesLiteral(_) => { - // TODO defer to Type::Instance().member - Type::Todo - } - Type::Tuple(_) => { - // TODO: implement tuple methods - Type::Todo - } - Type::Todo => Type::Todo, - } - } - - /// Resolves the boolean value of a type. - /// - /// This is used to determine the value that would be returned - /// when `bool(x)` is called on an object `x`. - fn bool(&self, db: &'db dyn Db) -> Truthiness { - match self { - Type::Any | Type::Todo | Type::Never | Type::Unknown | Type::Unbound => { - Truthiness::Ambiguous - } - Type::None => Truthiness::AlwaysFalse, - Type::FunctionLiteral(_) => Truthiness::AlwaysTrue, - Type::ModuleLiteral(_) => Truthiness::AlwaysTrue, - Type::ClassLiteral(_) => { - // TODO: lookup `__bool__` and `__len__` methods on the class's metaclass - // More info in https://docs.python.org/3/library/stdtypes.html#truth-value-testing - Truthiness::Ambiguous - } - Type::Instance(_) => { - // TODO: lookup `__bool__` and `__len__` methods on the instance's class - // More info in https://docs.python.org/3/library/stdtypes.html#truth-value-testing - Truthiness::Ambiguous - } - Type::Union(union) => { - let union_elements = union.elements(db); - let first_element_truthiness = union_elements[0].bool(db); - if first_element_truthiness.is_ambiguous() { - return Truthiness::Ambiguous; - } - if !union_elements - .iter() - .skip(1) - .all(|element| element.bool(db) == first_element_truthiness) - { - return Truthiness::Ambiguous; - } - first_element_truthiness - } - Type::Intersection(_) => { - // TODO - Truthiness::Ambiguous - } - Type::IntLiteral(num) => Truthiness::from(*num != 0), - Type::BooleanLiteral(bool) => Truthiness::from(*bool), - Type::StringLiteral(str) => Truthiness::from(!str.value(db).is_empty()), - Type::LiteralString => Truthiness::Ambiguous, - Type::BytesLiteral(bytes) => Truthiness::from(!bytes.value(db).is_empty()), - Type::Tuple(items) => Truthiness::from(!items.elements(db).is_empty()), - } - } - - /// Return the type resulting from calling an object of this type. - /// - /// Returns `None` if `self` is not a callable type. - #[must_use] - fn call(self, db: &'db dyn Db, arg_types: &[Type<'db>]) -> CallOutcome<'db> { - match self { - // TODO validate typed call arguments vs callable signature - Type::FunctionLiteral(function_type) => { - if function_type.is_known(db, KnownFunction::RevealType) { - CallOutcome::revealed( - function_type.return_type(db), - *arg_types.first().unwrap_or(&Type::Unknown), - ) - } else { - CallOutcome::callable(function_type.return_type(db)) - } - } - - // TODO annotated return type on `__new__` or metaclass `__call__` - Type::ClassLiteral(class) => { - CallOutcome::callable(match class.known(db) { - // If the class is the builtin-bool class (for example `bool(1)`), we try to - // return the specific truthiness value of the input arg, `Literal[True]` for - // the example above. - Some(KnownClass::Bool) => arg_types - .first() - .map(|arg| arg.bool(db).into_type(db)) - .unwrap_or(Type::BooleanLiteral(false)), - _ => Type::Instance(class), - }) - } - - Type::Instance(class) => { - // Since `__call__` is a dunder, we need to access it as an attribute on the class - // rather than the instance (matching runtime semantics). - let dunder_call_method = class.class_member(db, "__call__"); - if dunder_call_method.is_unbound() { - CallOutcome::not_callable(self) - } else { - let args = std::iter::once(self) - .chain(arg_types.iter().copied()) - .collect::>(); - dunder_call_method.call(db, &args) - } - } - - // `Any` is callable, and its return type is also `Any`. - Type::Any => CallOutcome::callable(Type::Any), - - Type::Todo => CallOutcome::callable(Type::Todo), - - Type::Unknown => CallOutcome::callable(Type::Unknown), - - Type::Union(union) => CallOutcome::union( - self, - union - .elements(db) - .iter() - .map(|elem| elem.call(db, arg_types)), - ), - - // TODO: intersection types - Type::Intersection(_) => CallOutcome::callable(Type::Todo), - - _ => CallOutcome::not_callable(self), - } - } - - /// Given the type of an object that is iterated over in some way, - /// return the type of objects that are yielded by that iteration. - /// - /// E.g., for the following loop, given the type of `x`, infer the type of `y`: - /// ```python - /// for y in x: - /// pass - /// ``` - fn iterate(self, db: &'db dyn Db) -> IterationOutcome<'db> { - if let Type::Tuple(tuple_type) = self { - return IterationOutcome::Iterable { - element_ty: UnionType::from_elements(db, tuple_type.elements(db)), - }; - } - - if let Type::Unknown | Type::Any = self { - // Explicit handling of `Unknown` and `Any` necessary until `type[Unknown]` and - // `type[Any]` are not defined as `Todo` anymore. - return IterationOutcome::Iterable { element_ty: self }; - } - - // `self` represents the type of the iterable; - // `__iter__` and `__next__` are both looked up on the class of the iterable: - let iterable_meta_type = self.to_meta_type(db); - - let dunder_iter_method = iterable_meta_type.member(db, "__iter__"); - if !dunder_iter_method.is_unbound() { - let CallOutcome::Callable { - return_ty: iterator_ty, - } = dunder_iter_method.call(db, &[self]) - else { - return IterationOutcome::NotIterable { - not_iterable_ty: self, - }; - }; - - let dunder_next_method = iterator_ty.to_meta_type(db).member(db, "__next__"); - return dunder_next_method - .call(db, &[self]) - .return_ty(db) - .map(|element_ty| IterationOutcome::Iterable { element_ty }) - .unwrap_or(IterationOutcome::NotIterable { - not_iterable_ty: self, - }); - } - - // Although it's not considered great practice, - // classes that define `__getitem__` are also iterable, - // even if they do not define `__iter__`. - // - // TODO(Alex) this is only valid if the `__getitem__` method is annotated as - // accepting `int` or `SupportsIndex` - let dunder_get_item_method = iterable_meta_type.member(db, "__getitem__"); - - dunder_get_item_method - .call(db, &[self, KnownClass::Int.to_instance(db)]) - .return_ty(db) - .map(|element_ty| IterationOutcome::Iterable { element_ty }) - .unwrap_or(IterationOutcome::NotIterable { - not_iterable_ty: self, - }) - } - - #[must_use] - pub fn to_instance(&self, db: &'db dyn Db) -> Type<'db> { - match self { - Type::Any => Type::Any, - Type::Todo => Type::Todo, - Type::Unknown => Type::Unknown, - Type::Unbound => Type::Unknown, - Type::Never => Type::Never, - Type::ClassLiteral(class) => Type::Instance(*class), - Type::Union(union) => union.map(db, |element| element.to_instance(db)), - // TODO: we can probably do better here: --Alex - Type::Intersection(_) => Type::Todo, - // TODO: calling `.to_instance()` on any of these should result in a diagnostic, - // since they already indicate that the object is an instance of some kind: - Type::BooleanLiteral(_) - | Type::BytesLiteral(_) - | Type::FunctionLiteral(_) - | Type::Instance(_) - | Type::ModuleLiteral(_) - | Type::IntLiteral(_) - | Type::StringLiteral(_) - | Type::Tuple(_) - | Type::LiteralString - | Type::None => Type::Unknown, - } - } - - /// Given a type that is assumed to represent an instance of a class, - /// return a type that represents that class itself. - #[must_use] - pub fn to_meta_type(&self, db: &'db dyn Db) -> Type<'db> { - match self { - Type::Unbound => Type::Unbound, - Type::Never => Type::Never, - Type::Instance(class) => Type::ClassLiteral(*class), - Type::Union(union) => union.map(db, |ty| ty.to_meta_type(db)), - Type::BooleanLiteral(_) => KnownClass::Bool.to_class(db), - Type::BytesLiteral(_) => KnownClass::Bytes.to_class(db), - Type::IntLiteral(_) => KnownClass::Int.to_class(db), - Type::FunctionLiteral(_) => KnownClass::FunctionType.to_class(db), - Type::ModuleLiteral(_) => KnownClass::ModuleType.to_class(db), - Type::Tuple(_) => KnownClass::Tuple.to_class(db), - Type::None => KnownClass::NoneType.to_class(db), - // TODO not accurate if there's a custom metaclass... - Type::ClassLiteral(_) => KnownClass::Type.to_class(db), - // TODO can we do better here? `type[LiteralString]`? - Type::StringLiteral(_) | Type::LiteralString => KnownClass::Str.to_class(db), - // TODO: `type[Any]`? - Type::Any => Type::Todo, - // TODO: `type[Unknown]`? - Type::Unknown => Type::Todo, - // TODO intersections - Type::Intersection(_) => Type::Todo, - Type::Todo => Type::Todo, - } - } - - /// Return the string representation of this type when converted to string as it would be - /// provided by the `__str__` method. - /// - /// When not available, this should fall back to the value of `[Type::repr]`. - /// Note: this method is used in the builtins `format`, `print`, `str.format` and `f-strings`. - #[must_use] - pub fn str(&self, db: &'db dyn Db) -> Type<'db> { - match self { - Type::IntLiteral(_) | Type::BooleanLiteral(_) => self.repr(db), - Type::StringLiteral(_) | Type::LiteralString => *self, - // TODO: handle more complex types - _ => KnownClass::Str.to_instance(db), - } - } - - /// Return the string representation of this type as it would be provided by the `__repr__` - /// method at runtime. - #[must_use] - pub fn repr(&self, db: &'db dyn Db) -> Type<'db> { - match self { - Type::IntLiteral(number) => Type::StringLiteral(StringLiteralType::new(db, { - number.to_string().into_boxed_str() - })), - Type::BooleanLiteral(true) => Type::StringLiteral(StringLiteralType::new(db, "True")), - Type::BooleanLiteral(false) => Type::StringLiteral(StringLiteralType::new(db, "False")), - Type::StringLiteral(literal) => Type::StringLiteral(StringLiteralType::new(db, { - format!("'{}'", literal.value(db).escape_default()).into_boxed_str() - })), - Type::LiteralString => Type::LiteralString, - // TODO: handle more complex types - _ => KnownClass::Str.to_instance(db), - } - } -} - -impl<'db> From<&Type<'db>> for Type<'db> { - fn from(value: &Type<'db>) -> Self { - *value - } -} - -/// Non-exhaustive enumeration of known classes (e.g. `builtins.int`, `typing.Any`, ...) to allow -/// for easier syntax when interacting with very common classes. -/// -/// Feel free to expand this enum if you ever find yourself using the same class in multiple -/// places. -/// Note: good candidates are any classes in `[crate::stdlib::CoreStdlibModule]` -#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] -pub enum KnownClass { - // To figure out where an stdlib symbol is defined, you can go into `crates/red_knot_vendored` - // and grep for the symbol name in any `.pyi` file. - - // Builtins - Bool, - Object, - Bytes, - Type, - Int, - Float, - Str, - List, - Tuple, - Set, - Dict, - // Types - GenericAlias, - ModuleType, - FunctionType, - // Typeshed - NoneType, // Part of `types` for Python >= 3.10 -} - -impl<'db> KnownClass { - pub const fn as_str(&self) -> &'static str { - match self { - Self::Bool => "bool", - Self::Object => "object", - Self::Bytes => "bytes", - Self::Tuple => "tuple", - Self::Int => "int", - Self::Float => "float", - Self::Str => "str", - Self::Set => "set", - Self::Dict => "dict", - Self::List => "list", - Self::Type => "type", - Self::GenericAlias => "GenericAlias", - Self::ModuleType => "ModuleType", - Self::FunctionType => "FunctionType", - Self::NoneType => "NoneType", - } - } - - pub fn to_instance(&self, db: &'db dyn Db) -> Type<'db> { - self.to_class(db).to_instance(db) - } - - pub fn to_class(&self, db: &'db dyn Db) -> Type<'db> { - match self { - Self::Bool - | Self::Object - | Self::Bytes - | Self::Type - | Self::Int - | Self::Float - | Self::Str - | Self::List - | Self::Tuple - | Self::Set - | Self::Dict => builtins_symbol_ty(db, self.as_str()), - Self::GenericAlias | Self::ModuleType | Self::FunctionType => { - types_symbol_ty(db, self.as_str()) - } - - Self::NoneType => typeshed_symbol_ty(db, self.as_str()), - } - } - - pub fn maybe_from_module(module: &Module, class_name: &str) -> Option { - let candidate = Self::from_name(class_name)?; - if candidate.check_module(module) { - Some(candidate) - } else { - None - } - } - - fn from_name(name: &str) -> Option { - // Note: if this becomes hard to maintain (as rust can't ensure at compile time that all - // variants of `Self` are covered), we might use a macro (in-house or dependency) - // See: https://stackoverflow.com/q/39070244 - match name { - "bool" => Some(Self::Bool), - "object" => Some(Self::Object), - "bytes" => Some(Self::Bytes), - "tuple" => Some(Self::Tuple), - "type" => Some(Self::Type), - "int" => Some(Self::Int), - "float" => Some(Self::Float), - "str" => Some(Self::Str), - "set" => Some(Self::Set), - "dict" => Some(Self::Dict), - "list" => Some(Self::List), - "GenericAlias" => Some(Self::GenericAlias), - "NoneType" => Some(Self::NoneType), - "ModuleType" => Some(Self::ModuleType), - "FunctionType" => Some(Self::FunctionType), - _ => None, - } - } - - /// Private method checking if known class can be defined in the given module. - fn check_module(self, module: &Module) -> bool { - if !module.search_path().is_standard_library() { - return false; - } - match self { - Self::Bool - | Self::Object - | Self::Bytes - | Self::Type - | Self::Int - | Self::Float - | Self::Str - | Self::List - | Self::Tuple - | Self::Set - | Self::Dict => module.name() == "builtins", - Self::GenericAlias | Self::ModuleType | Self::FunctionType => module.name() == "types", - Self::NoneType => matches!(module.name().as_str(), "_typeshed" | "types"), - } - } -} - -#[derive(Debug, Clone, PartialEq, Eq)] -enum CallOutcome<'db> { - Callable { - return_ty: Type<'db>, - }, - RevealType { - return_ty: Type<'db>, - revealed_ty: Type<'db>, - }, - NotCallable { - not_callable_ty: Type<'db>, - }, - Union { - called_ty: Type<'db>, - outcomes: Box<[CallOutcome<'db>]>, - }, -} - -impl<'db> CallOutcome<'db> { - /// Create a new `CallOutcome::Callable` with given return type. - fn callable(return_ty: Type<'db>) -> CallOutcome<'db> { - CallOutcome::Callable { return_ty } - } - - /// Create a new `CallOutcome::NotCallable` with given not-callable type. - fn not_callable(not_callable_ty: Type<'db>) -> CallOutcome<'db> { - CallOutcome::NotCallable { not_callable_ty } - } - - /// Create a new `CallOutcome::RevealType` with given revealed and return types. - fn revealed(return_ty: Type<'db>, revealed_ty: Type<'db>) -> CallOutcome<'db> { - CallOutcome::RevealType { - return_ty, - revealed_ty, - } - } - - /// Create a new `CallOutcome::Union` with given wrapped outcomes. - fn union( - called_ty: Type<'db>, - outcomes: impl IntoIterator>, - ) -> CallOutcome<'db> { - CallOutcome::Union { - called_ty, - outcomes: outcomes.into_iter().collect(), - } - } - - /// Get the return type of the call, or `None` if not callable. - fn return_ty(&self, db: &'db dyn Db) -> Option> { - match self { - Self::Callable { return_ty } => Some(*return_ty), - Self::RevealType { - return_ty, - revealed_ty: _, - } => Some(*return_ty), - Self::NotCallable { not_callable_ty: _ } => None, - Self::Union { - outcomes, - called_ty: _, - } => outcomes - .iter() - // If all outcomes are NotCallable, we return None; if some outcomes are callable - // and some are not, we return a union including Unknown. - .fold(None, |acc, outcome| { - let ty = outcome.return_ty(db); - match (acc, ty) { - (None, None) => None, - (None, Some(ty)) => Some(UnionBuilder::new(db).add(ty)), - (Some(builder), ty) => Some(builder.add(ty.unwrap_or(Type::Unknown))), - } - }) - .map(UnionBuilder::build), - } - } - - /// Get the return type of the call, emitting default diagnostics if needed. - fn unwrap_with_diagnostic<'a>( - &self, - db: &'db dyn Db, - node: ast::AnyNodeRef, - builder: &'a mut TypeInferenceBuilder<'db>, - ) -> Type<'db> { - match self.return_ty_result(db, node, builder) { - Ok(return_ty) => return_ty, - Err(NotCallableError::Type { - not_callable_ty, - return_ty, - }) => { - builder.add_diagnostic( - node, - "call-non-callable", - format_args!( - "Object of type `{}` is not callable", - not_callable_ty.display(db) - ), - ); - return_ty - } - Err(NotCallableError::UnionElement { - not_callable_ty, - called_ty, - return_ty, - }) => { - builder.add_diagnostic( - node, - "call-non-callable", - format_args!( - "Object of type `{}` is not callable (due to union element `{}`)", - called_ty.display(db), - not_callable_ty.display(db), - ), - ); - return_ty - } - Err(NotCallableError::UnionElements { - not_callable_tys, - called_ty, - return_ty, - }) => { - builder.add_diagnostic( - node, - "call-non-callable", - format_args!( - "Object of type `{}` is not callable (due to union elements {})", - called_ty.display(db), - not_callable_tys.display(db), - ), - ); - return_ty - } - } - } - - /// Get the return type of the call as a result. - fn return_ty_result<'a>( - &self, - db: &'db dyn Db, - node: ast::AnyNodeRef, - builder: &'a mut TypeInferenceBuilder<'db>, - ) -> Result, NotCallableError<'db>> { - match self { - Self::Callable { return_ty } => Ok(*return_ty), - Self::RevealType { - return_ty, - revealed_ty, - } => { - builder.add_diagnostic( - node, - "revealed-type", - format_args!("Revealed type is `{}`", revealed_ty.display(db)), - ); - Ok(*return_ty) - } - Self::NotCallable { not_callable_ty } => Err(NotCallableError::Type { - not_callable_ty: *not_callable_ty, - return_ty: Type::Unknown, - }), - Self::Union { - outcomes, - called_ty, - } => { - let mut not_callable = vec![]; - let mut union_builder = UnionBuilder::new(db); - let mut revealed = false; - for outcome in outcomes { - let return_ty = match outcome { - Self::NotCallable { not_callable_ty } => { - not_callable.push(*not_callable_ty); - Type::Unknown - } - Self::RevealType { - return_ty, - revealed_ty: _, - } => { - if revealed { - *return_ty - } else { - revealed = true; - outcome.unwrap_with_diagnostic(db, node, builder) - } - } - _ => outcome.unwrap_with_diagnostic(db, node, builder), - }; - union_builder = union_builder.add(return_ty); - } - let return_ty = union_builder.build(); - match not_callable[..] { - [] => Ok(return_ty), - [elem] => Err(NotCallableError::UnionElement { - not_callable_ty: elem, - called_ty: *called_ty, - return_ty, - }), - _ if not_callable.len() == outcomes.len() => Err(NotCallableError::Type { - not_callable_ty: *called_ty, - return_ty, - }), - _ => Err(NotCallableError::UnionElements { - not_callable_tys: not_callable.into_boxed_slice(), - called_ty: *called_ty, - return_ty, - }), - } - } - } - } -} - -#[derive(Debug, Clone, PartialEq, Eq)] -enum NotCallableError<'db> { - /// The type is not callable. - Type { - not_callable_ty: Type<'db>, - return_ty: Type<'db>, - }, - /// A single union element is not callable. - UnionElement { - not_callable_ty: Type<'db>, - called_ty: Type<'db>, - return_ty: Type<'db>, - }, - /// Multiple (but not all) union elements are not callable. - UnionElements { - not_callable_tys: Box<[Type<'db>]>, - called_ty: Type<'db>, - return_ty: Type<'db>, - }, -} - -impl<'db> NotCallableError<'db> { - /// The return type that should be used when a call is not callable. - fn return_ty(&self) -> Type<'db> { - match self { - Self::Type { return_ty, .. } => *return_ty, - Self::UnionElement { return_ty, .. } => *return_ty, - Self::UnionElements { return_ty, .. } => *return_ty, - } - } - - /// The resolved type that was not callable. - /// - /// For unions, returns the union type itself, which may contain a mix of callable and - /// non-callable types. - fn called_ty(&self) -> Type<'db> { - match self { - Self::Type { - not_callable_ty, .. - } => *not_callable_ty, - Self::UnionElement { called_ty, .. } => *called_ty, - Self::UnionElements { called_ty, .. } => *called_ty, - } - } -} - -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -enum IterationOutcome<'db> { - Iterable { element_ty: Type<'db> }, - NotIterable { not_iterable_ty: Type<'db> }, -} - -impl<'db> IterationOutcome<'db> { - fn unwrap_with_diagnostic( - self, - iterable_node: ast::AnyNodeRef, - inference_builder: &mut TypeInferenceBuilder<'db>, - ) -> Type<'db> { - match self { - Self::Iterable { element_ty } => element_ty, - Self::NotIterable { not_iterable_ty } => { - inference_builder.not_iterable_diagnostic(iterable_node, not_iterable_ty); - Type::Unknown - } - } - } -} - -#[derive(Debug, Copy, Clone, PartialEq, Eq)] -enum Truthiness { - /// For an object `x`, `bool(x)` will always return `True` - AlwaysTrue, - /// For an object `x`, `bool(x)` will always return `False` - AlwaysFalse, - /// For an object `x`, `bool(x)` could return either `True` or `False` - Ambiguous, -} - -impl Truthiness { - const fn is_ambiguous(self) -> bool { - matches!(self, Truthiness::Ambiguous) - } - - const fn negate(self) -> Self { - match self { - Self::AlwaysTrue => Self::AlwaysFalse, - Self::AlwaysFalse => Self::AlwaysTrue, - Self::Ambiguous => Self::Ambiguous, - } - } - - fn into_type(self, db: &dyn Db) -> Type { - match self { - Self::AlwaysTrue => Type::BooleanLiteral(true), - Self::AlwaysFalse => Type::BooleanLiteral(false), - Self::Ambiguous => KnownClass::Bool.to_instance(db), - } - } -} - -impl From for Truthiness { - fn from(value: bool) -> Self { - if value { - Truthiness::AlwaysTrue - } else { - Truthiness::AlwaysFalse - } - } -} - -#[salsa::interned] -pub struct FunctionType<'db> { - /// name of the function at definition - #[return_ref] - pub name: ast::name::Name, - - /// Is this a function that we special-case somehow? If so, which one? - known: Option, - - definition: Definition<'db>, - - /// types of all decorators on this function - decorators: Box<[Type<'db>]>, -} - -impl<'db> FunctionType<'db> { - /// Return true if this is a standard library function with given module name and name. - pub(crate) fn is_stdlib_symbol(self, db: &'db dyn Db, module_name: &str, name: &str) -> bool { - name == self.name(db) - && file_to_module(db, self.definition(db).file(db)).is_some_and(|module| { - module.search_path().is_standard_library() && module.name() == module_name - }) - } - - pub fn has_decorator(self, db: &dyn Db, decorator: Type<'_>) -> bool { - self.decorators(db).contains(&decorator) - } - - /// inferred return type for this function - pub fn return_type(&self, db: &'db dyn Db) -> Type<'db> { - let definition = self.definition(db); - let DefinitionKind::Function(function_stmt_node) = definition.kind(db) else { - panic!("Function type definition must have `DefinitionKind::Function`") - }; - - // TODO if a function `bar` is decorated by `foo`, - // where `foo` is annotated as returning a type `X` that is a subtype of `Callable`, - // we need to infer the return type from `X`'s return annotation - // rather than from `bar`'s return annotation - // in order to determine the type that `bar` returns - if !function_stmt_node.decorator_list.is_empty() { - return Type::Todo; - } - - function_stmt_node - .returns - .as_ref() - .map(|returns| { - if function_stmt_node.is_async { - // TODO: generic `types.CoroutineType`! - Type::Todo - } else { - definition_expression_ty(db, definition, returns.as_ref()) - } - }) - .unwrap_or(Type::Unknown) - } - - pub fn is_known(self, db: &'db dyn Db, known_function: KnownFunction) -> bool { - self.known(db) == Some(known_function) - } -} - -/// Non-exhaustive enumeration of known functions (e.g. `builtins.reveal_type`, ...) that might -/// have special behavior. -#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] -pub enum KnownFunction { - /// `builtins.reveal_type`, `typing.reveal_type` or `typing_extensions.reveal_type` - RevealType, - /// `builtins.isinstance` - IsInstance, -} - -#[salsa::interned] -pub struct ClassType<'db> { - /// Name of the class at definition - #[return_ref] - pub name: ast::name::Name, - - definition: Definition<'db>, - - body_scope: ScopeId<'db>, - - known: Option, -} - -impl<'db> ClassType<'db> { - pub fn is_known(self, db: &'db dyn Db, known_class: KnownClass) -> bool { - match self.known(db) { - Some(known) => known == known_class, - None => false, - } - } - - /// Return true if this class is a standard library type with given module name and name. - pub(crate) fn is_stdlib_symbol(self, db: &'db dyn Db, module_name: &str, name: &str) -> bool { - name == self.name(db) - && file_to_module(db, self.body_scope(db).file(db)).is_some_and(|module| { - module.search_path().is_standard_library() && module.name() == module_name - }) - } - - /// Return an iterator over the types of this class's bases. - /// - /// # Panics: - /// If `definition` is not a `DefinitionKind::Class`. - pub fn bases(&self, db: &'db dyn Db) -> impl Iterator> { - let definition = self.definition(db); - let DefinitionKind::Class(class_stmt_node) = definition.kind(db) else { - panic!("Class type definition must have DefinitionKind::Class"); - }; - class_stmt_node - .bases() - .iter() - .map(move |base_expr: &ast::Expr| { - if class_stmt_node.type_params.is_some() { - // when we have a specialized scope, we'll look up the inference - // within that scope - let model: SemanticModel<'db> = SemanticModel::new(db, definition.file(db)); - base_expr.ty(&model) - } else { - // Otherwise, we can do the lookup based on the definition scope - definition_expression_ty(db, definition, base_expr) - } - }) - } - - pub fn is_subclass_of(self, db: &'db dyn Db, other: ClassType) -> bool { - // TODO: we need to iterate over the *MRO* here, not the bases - (other == self) - || self.bases(db).any(|base| match base { - Type::ClassLiteral(base_class) => base_class == other, - // `is_subclass_of` is checking the subtype relation, in which gradual types do not - // participate, so we should not return `True` if we find `Any/Unknown` in the - // bases. - _ => false, - }) - } - - /// Returns the class member of this class named `name`. - /// - /// The member resolves to a member of the class itself or any of its bases. - pub fn class_member(self, db: &'db dyn Db, name: &str) -> Type<'db> { - let member = self.own_class_member(db, name); - if !member.is_unbound() { - // TODO diagnostic if maybe unbound? - return member.replace_unbound_with(db, Type::Never); - } - - self.inherited_class_member(db, name) - } - - /// Returns the inferred type of the class member named `name`. - pub fn own_class_member(self, db: &'db dyn Db, name: &str) -> Type<'db> { - let scope = self.body_scope(db); - symbol_ty(db, scope, name) - } - - pub fn inherited_class_member(self, db: &'db dyn Db, name: &str) -> Type<'db> { - for base in self.bases(db) { - let member = base.member(db, name); - if !member.is_unbound() { - return member; - } - } - - Type::Unbound - } -} - -#[salsa::interned] -pub struct UnionType<'db> { - /// The union type includes values in any of these types. - #[return_ref] - elements_boxed: Box<[Type<'db>]>, -} - -impl<'db> UnionType<'db> { - fn elements(self, db: &'db dyn Db) -> &'db [Type<'db>] { - self.elements_boxed(db) - } - - /// Create a union from a list of elements - /// (which may be eagerly simplified into a different variant of [`Type`] altogether). - pub fn from_elements>>( - db: &'db dyn Db, - elements: impl IntoIterator, - ) -> Type<'db> { - elements - .into_iter() - .fold(UnionBuilder::new(db), |builder, element| { - builder.add(element.into()) - }) - .build() - } - - /// Apply a transformation function to all elements of the union, - /// and create a new union from the resulting set of types. - pub fn map( - &self, - db: &'db dyn Db, - transform_fn: impl Fn(&Type<'db>) -> Type<'db>, - ) -> Type<'db> { - Self::from_elements(db, self.elements(db).iter().map(transform_fn)) - } -} - -#[salsa::interned] -pub struct IntersectionType<'db> { - /// The intersection type includes only values in all of these types. - #[return_ref] - positive: FxOrderSet>, - - /// The intersection type does not include any value in any of these types. - /// - /// Negation types aren't expressible in annotations, and are most likely to arise from type - /// narrowing along with intersections (e.g. `if not isinstance(...)`), so we represent them - /// directly in intersections rather than as a separate type. - #[return_ref] - negative: FxOrderSet>, -} - -#[salsa::interned] -pub struct StringLiteralType<'db> { - #[return_ref] - value: Box, -} - -impl<'db> StringLiteralType<'db> { - pub fn len(&self, db: &'db dyn Db) -> usize { - self.value(db).len() - } -} - -#[salsa::interned] -pub struct BytesLiteralType<'db> { - #[return_ref] - value: Box<[u8]>, -} - -#[salsa::interned] -pub struct TupleType<'db> { - #[return_ref] - elements: Box<[Type<'db>]>, -} - -impl<'db> TupleType<'db> { - pub fn get(&self, db: &'db dyn Db, index: usize) -> Option> { - self.elements(db).get(index).copied() - } - - pub fn len(&self, db: &'db dyn Db) -> usize { - self.elements(db).len() - } -} - -#[cfg(test)] -mod tests { - use super::{ - builtins_symbol_ty, BytesLiteralType, IntersectionBuilder, StringLiteralType, Truthiness, - TupleType, Type, UnionType, - }; - use crate::db::tests::TestDb; - use crate::program::{Program, SearchPathSettings}; - use crate::python_version::PythonVersion; - use crate::ProgramSettings; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use test_case::test_case; - - fn setup_db() -> TestDb { - let db = TestDb::new(); - - let src_root = SystemPathBuf::from("/src"); - db.memory_file_system() - .create_directory_all(&src_root) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(src_root), - }, - ) - .expect("Valid search path settings"); - - db - } - - /// A test representation of a type that can be transformed unambiguously into a real Type, - /// given a db. - #[derive(Debug, Clone)] - enum Ty { - Never, - Unknown, - None, - Any, - IntLiteral(i64), - BooleanLiteral(bool), - StringLiteral(&'static str), - LiteralString, - BytesLiteral(&'static str), - BuiltinInstance(&'static str), - Union(Vec), - Intersection { pos: Vec, neg: Vec }, - Tuple(Vec), - } - - impl Ty { - fn into_type(self, db: &TestDb) -> Type<'_> { - match self { - Ty::Never => Type::Never, - Ty::Unknown => Type::Unknown, - Ty::None => Type::None, - Ty::Any => Type::Any, - Ty::IntLiteral(n) => Type::IntLiteral(n), - Ty::StringLiteral(s) => Type::StringLiteral(StringLiteralType::new(db, s)), - Ty::BooleanLiteral(b) => Type::BooleanLiteral(b), - Ty::LiteralString => Type::LiteralString, - Ty::BytesLiteral(s) => Type::BytesLiteral(BytesLiteralType::new(db, s.as_bytes())), - Ty::BuiltinInstance(s) => builtins_symbol_ty(db, s).to_instance(db), - Ty::Union(tys) => { - UnionType::from_elements(db, tys.into_iter().map(|ty| ty.into_type(db))) - } - Ty::Intersection { pos, neg } => { - let mut builder = IntersectionBuilder::new(db); - for p in pos { - builder = builder.add_positive(p.into_type(db)); - } - for n in neg { - builder = builder.add_negative(n.into_type(db)); - } - builder.build() - } - Ty::Tuple(tys) => { - let elements: Box<_> = tys.into_iter().map(|ty| ty.into_type(db)).collect(); - Type::Tuple(TupleType::new(db, elements)) - } - } - } - } - - #[test_case(Ty::BuiltinInstance("str"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::Unknown, Ty::IntLiteral(1))] - #[test_case(Ty::Any, Ty::IntLiteral(1))] - #[test_case(Ty::Never, Ty::IntLiteral(1))] - #[test_case(Ty::IntLiteral(1), Ty::Unknown)] - #[test_case(Ty::IntLiteral(1), Ty::Any)] - #[test_case(Ty::IntLiteral(1), Ty::BuiltinInstance("int"))] - #[test_case(Ty::StringLiteral("foo"), Ty::BuiltinInstance("str"))] - #[test_case(Ty::StringLiteral("foo"), Ty::LiteralString)] - #[test_case(Ty::LiteralString, Ty::BuiltinInstance("str"))] - #[test_case(Ty::BytesLiteral("foo"), Ty::BuiltinInstance("bytes"))] - #[test_case(Ty::IntLiteral(1), Ty::Union(vec![Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str")]))] - #[test_case(Ty::IntLiteral(1), Ty::Union(vec![Ty::Unknown, Ty::BuiltinInstance("str")]))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]))] - fn is_assignable_to(from: Ty, to: Ty) { - let db = setup_db(); - assert!(from.into_type(&db).is_assignable_to(&db, to.into_type(&db))); - } - - #[test_case(Ty::BuiltinInstance("object"), Ty::BuiltinInstance("int"))] - #[test_case(Ty::IntLiteral(1), Ty::BuiltinInstance("str"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::IntLiteral(1))] - fn is_not_assignable_to(from: Ty, to: Ty) { - let db = setup_db(); - assert!(!from.into_type(&db).is_assignable_to(&db, to.into_type(&db))); - } - - #[test_case(Ty::BuiltinInstance("str"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::BuiltinInstance("bool"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::BuiltinInstance("bool"), Ty::BuiltinInstance("int"))] - #[test_case(Ty::Never, Ty::IntLiteral(1))] - #[test_case(Ty::IntLiteral(1), Ty::BuiltinInstance("int"))] - #[test_case(Ty::IntLiteral(1), Ty::BuiltinInstance("object"))] - #[test_case(Ty::BooleanLiteral(true), Ty::BuiltinInstance("bool"))] - #[test_case(Ty::BooleanLiteral(true), Ty::BuiltinInstance("object"))] - #[test_case(Ty::StringLiteral("foo"), Ty::BuiltinInstance("str"))] - #[test_case(Ty::StringLiteral("foo"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::StringLiteral("foo"), Ty::LiteralString)] - #[test_case(Ty::LiteralString, Ty::BuiltinInstance("str"))] - #[test_case(Ty::LiteralString, Ty::BuiltinInstance("object"))] - #[test_case(Ty::BytesLiteral("foo"), Ty::BuiltinInstance("bytes"))] - #[test_case(Ty::BytesLiteral("foo"), Ty::BuiltinInstance("object"))] - #[test_case(Ty::IntLiteral(1), Ty::Union(vec![Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str")]))] - #[test_case(Ty::Union(vec![Ty::BuiltinInstance("str"), Ty::BuiltinInstance("int")]), Ty::BuiltinInstance("object"))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2), Ty::IntLiteral(3)]))] - #[test_case(Ty::BuiltinInstance("TypeError"), Ty::BuiltinInstance("Exception"))] - fn is_subtype_of(from: Ty, to: Ty) { - let db = setup_db(); - assert!(from.into_type(&db).is_subtype_of(&db, to.into_type(&db))); - } - - #[test_case(Ty::BuiltinInstance("object"), Ty::BuiltinInstance("int"))] - #[test_case(Ty::Unknown, Ty::IntLiteral(1))] - #[test_case(Ty::Any, Ty::IntLiteral(1))] - #[test_case(Ty::IntLiteral(1), Ty::Unknown)] - #[test_case(Ty::IntLiteral(1), Ty::Any)] - #[test_case(Ty::IntLiteral(1), Ty::Union(vec![Ty::Unknown, Ty::BuiltinInstance("str")]))] - #[test_case(Ty::IntLiteral(1), Ty::BuiltinInstance("str"))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::IntLiteral(1))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(3)]))] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::IntLiteral(1))] - fn is_not_subtype_of(from: Ty, to: Ty) { - let db = setup_db(); - assert!(!from.into_type(&db).is_subtype_of(&db, to.into_type(&db))); - } - - #[test] - fn is_subtype_of_class_literals() { - let mut db = setup_db(); - db.write_dedented( - "/src/module.py", - " - class A: ... - class B: ... - U = A if flag else B - ", - ) - .unwrap(); - let module = ruff_db::files::system_path_to_file(&db, "/src/module.py").unwrap(); - - let type_a = super::global_symbol_ty(&db, module, "A"); - let type_u = super::global_symbol_ty(&db, module, "U"); - - assert!(type_a.is_class_literal()); - assert!(type_a.is_subtype_of(&db, Ty::BuiltinInstance("type").into_type(&db))); - assert!(type_a.is_subtype_of(&db, Ty::BuiltinInstance("object").into_type(&db))); - - assert!(type_u.is_union()); - assert!(type_u.is_subtype_of(&db, Ty::BuiltinInstance("type").into_type(&db))); - assert!(type_u.is_subtype_of(&db, Ty::BuiltinInstance("object").into_type(&db))); - } - - #[test_case( - Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), - Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]) - )] - fn is_equivalent_to(from: Ty, to: Ty) { - let db = setup_db(); - - assert!(from.into_type(&db).is_equivalent_to(&db, to.into_type(&db))); - } - - #[test_case(Ty::Never, Ty::Never)] - #[test_case(Ty::Never, Ty::None)] - #[test_case(Ty::Never, Ty::BuiltinInstance("int"))] - #[test_case(Ty::None, Ty::BooleanLiteral(true))] - #[test_case(Ty::None, Ty::IntLiteral(1))] - #[test_case(Ty::None, Ty::StringLiteral("test"))] - #[test_case(Ty::None, Ty::BytesLiteral("test"))] - #[test_case(Ty::None, Ty::LiteralString)] - #[test_case(Ty::None, Ty::BuiltinInstance("int"))] - #[test_case(Ty::None, Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::BooleanLiteral(true), Ty::BooleanLiteral(false))] - #[test_case(Ty::BooleanLiteral(true), Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::BooleanLiteral(true), Ty::IntLiteral(1))] - #[test_case(Ty::BooleanLiteral(false), Ty::IntLiteral(0))] - #[test_case(Ty::IntLiteral(1), Ty::IntLiteral(2))] - #[test_case(Ty::IntLiteral(1), Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::StringLiteral("a"), Ty::StringLiteral("b"))] - #[test_case(Ty::StringLiteral("a"), Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::LiteralString, Ty::BytesLiteral("a"))] - #[test_case(Ty::BytesLiteral("a"), Ty::BytesLiteral("b"))] - #[test_case(Ty::BytesLiteral("a"), Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::BytesLiteral("a"), Ty::StringLiteral("a"))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::IntLiteral(3))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Union(vec![Ty::IntLiteral(3), Ty::IntLiteral(4)]))] - #[test_case(Ty::Intersection{pos: vec![Ty::BuiltinInstance("int"), Ty::IntLiteral(1)], neg: vec![]}, Ty::IntLiteral(2))] - #[test_case(Ty::Tuple(vec![Ty::IntLiteral(1)]), Ty::Tuple(vec![Ty::IntLiteral(2)]))] - #[test_case(Ty::Tuple(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Tuple(vec![Ty::IntLiteral(1)]))] - #[test_case(Ty::Tuple(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Tuple(vec![Ty::IntLiteral(1), Ty::IntLiteral(3)]))] - fn is_disjoint_from(a: Ty, b: Ty) { - let db = setup_db(); - let a = a.into_type(&db); - let b = b.into_type(&db); - - assert!(a.is_disjoint_from(&db, b)); - assert!(b.is_disjoint_from(&db, a)); - } - - #[test_case(Ty::Any, Ty::BuiltinInstance("int"))] - #[test_case(Ty::None, Ty::None)] - #[test_case(Ty::None, Ty::BuiltinInstance("object"))] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("int"))] - #[test_case(Ty::BuiltinInstance("str"), Ty::LiteralString)] - #[test_case(Ty::BooleanLiteral(true), Ty::BooleanLiteral(true))] - #[test_case(Ty::BooleanLiteral(false), Ty::BooleanLiteral(false))] - #[test_case(Ty::BooleanLiteral(true), Ty::BuiltinInstance("bool"))] - #[test_case(Ty::BooleanLiteral(true), Ty::BuiltinInstance("int"))] - #[test_case(Ty::IntLiteral(1), Ty::IntLiteral(1))] - #[test_case(Ty::StringLiteral("a"), Ty::StringLiteral("a"))] - #[test_case(Ty::StringLiteral("a"), Ty::LiteralString)] - #[test_case(Ty::StringLiteral("a"), Ty::BuiltinInstance("str"))] - #[test_case(Ty::LiteralString, Ty::LiteralString)] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::IntLiteral(2))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Union(vec![Ty::IntLiteral(2), Ty::IntLiteral(3)]))] - #[test_case(Ty::Intersection{pos: vec![Ty::BuiltinInstance("int"), Ty::IntLiteral(2)], neg: vec![]}, Ty::IntLiteral(2))] - #[test_case(Ty::Tuple(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]), Ty::Tuple(vec![Ty::IntLiteral(1), Ty::BuiltinInstance("int")]))] - fn is_not_disjoint_from(a: Ty, b: Ty) { - let db = setup_db(); - let a = a.into_type(&db); - let b = b.into_type(&db); - - assert!(!a.is_disjoint_from(&db, b)); - assert!(!b.is_disjoint_from(&db, a)); - } - - #[test] - fn is_disjoint_from_union_of_class_types() { - let mut db = setup_db(); - db.write_dedented( - "/src/module.py", - " - class A: ... - class B: ... - U = A if flag else B - ", - ) - .unwrap(); - let module = ruff_db::files::system_path_to_file(&db, "/src/module.py").unwrap(); - - let type_a = super::global_symbol_ty(&db, module, "A"); - let type_u = super::global_symbol_ty(&db, module, "U"); - - assert!(type_a.is_class_literal()); - assert!(type_u.is_union()); - - assert!(!type_a.is_disjoint_from(&db, type_u)); - } - - #[test_case(Ty::None)] - #[test_case(Ty::BooleanLiteral(true))] - #[test_case(Ty::BooleanLiteral(false))] - fn is_singleton(from: Ty) { - let db = setup_db(); - - assert!(from.into_type(&db).is_singleton()); - } - - #[test_case(Ty::None)] - #[test_case(Ty::BooleanLiteral(true))] - #[test_case(Ty::IntLiteral(1))] - #[test_case(Ty::StringLiteral("abc"))] - #[test_case(Ty::BytesLiteral("abc"))] - #[test_case(Ty::Tuple(vec![]))] - #[test_case(Ty::Tuple(vec![Ty::BooleanLiteral(true), Ty::IntLiteral(1)]))] - fn is_single_valued(from: Ty) { - let db = setup_db(); - - assert!(from.into_type(&db).is_single_valued(&db)); - } - - #[test_case(Ty::Never)] - #[test_case(Ty::Any)] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]))] - #[test_case(Ty::Tuple(vec![Ty::None, Ty::BuiltinInstance("int")]))] - #[test_case(Ty::BuiltinInstance("str"))] - #[test_case(Ty::LiteralString)] - fn is_not_single_valued(from: Ty) { - let db = setup_db(); - - assert!(!from.into_type(&db).is_single_valued(&db)); - } - - #[test_case(Ty::Never)] - #[test_case(Ty::IntLiteral(345))] - #[test_case(Ty::BuiltinInstance("str"))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]))] - #[test_case(Ty::Tuple(vec![]))] - #[test_case(Ty::Tuple(vec![Ty::None]))] - #[test_case(Ty::Tuple(vec![Ty::None, Ty::BooleanLiteral(true)]))] - fn is_not_singleton(from: Ty) { - let db = setup_db(); - - assert!(!from.into_type(&db).is_singleton()); - } - - #[test_case(Ty::IntLiteral(1); "is_int_literal_truthy")] - #[test_case(Ty::IntLiteral(-1))] - #[test_case(Ty::StringLiteral("foo"))] - #[test_case(Ty::Tuple(vec![Ty::IntLiteral(0)]))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(2)]))] - fn is_truthy(ty: Ty) { - let db = setup_db(); - assert_eq!(ty.into_type(&db).bool(&db), Truthiness::AlwaysTrue); - } - - #[test_case(Ty::Tuple(vec![]))] - #[test_case(Ty::IntLiteral(0))] - #[test_case(Ty::StringLiteral(""))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(0), Ty::IntLiteral(0)]))] - fn is_falsy(ty: Ty) { - let db = setup_db(); - assert_eq!(ty.into_type(&db).bool(&db), Truthiness::AlwaysFalse); - } - - #[test_case(Ty::BuiltinInstance("str"))] - #[test_case(Ty::Union(vec![Ty::IntLiteral(1), Ty::IntLiteral(0)]))] - #[test_case(Ty::Union(vec![Ty::BuiltinInstance("str"), Ty::IntLiteral(0)]))] - #[test_case(Ty::Union(vec![Ty::BuiltinInstance("str"), Ty::IntLiteral(1)]))] - fn boolean_value_is_unknown(ty: Ty) { - let db = setup_db(); - assert_eq!(ty.into_type(&db).bool(&db), Truthiness::Ambiguous); - } - - #[test_case(Ty::IntLiteral(1), Ty::StringLiteral("1"))] - #[test_case(Ty::BooleanLiteral(true), Ty::StringLiteral("True"))] - #[test_case(Ty::BooleanLiteral(false), Ty::StringLiteral("False"))] - #[test_case(Ty::StringLiteral("ab'cd"), Ty::StringLiteral("ab'cd"))] // no quotes - #[test_case(Ty::LiteralString, Ty::LiteralString)] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str"))] - fn has_correct_str(ty: Ty, expected: Ty) { - let db = setup_db(); - - assert_eq!(ty.into_type(&db).str(&db), expected.into_type(&db)); - } - - #[test_case(Ty::IntLiteral(1), Ty::StringLiteral("1"))] - #[test_case(Ty::BooleanLiteral(true), Ty::StringLiteral("True"))] - #[test_case(Ty::BooleanLiteral(false), Ty::StringLiteral("False"))] - #[test_case(Ty::StringLiteral("ab'cd"), Ty::StringLiteral("'ab\\'cd'"))] // single quotes - #[test_case(Ty::LiteralString, Ty::LiteralString)] - #[test_case(Ty::BuiltinInstance("int"), Ty::BuiltinInstance("str"))] - fn has_correct_repr(ty: Ty, expected: Ty) { - let db = setup_db(); - - assert_eq!(ty.into_type(&db).repr(&db), expected.into_type(&db)); - } -} diff --git a/crates/red_knot_python_semantic/src/types/builder.rs b/crates/red_knot_python_semantic/src/types/builder.rs deleted file mode 100644 index 43a646312bc88..0000000000000 --- a/crates/red_knot_python_semantic/src/types/builder.rs +++ /dev/null @@ -1,1023 +0,0 @@ -//! Smart builders for union and intersection types. -//! -//! Invariants we maintain here: -//! * No single-element union types (should just be the contained type instead.) -//! * No single-positive-element intersection types. Single-negative-element are OK, we don't -//! have a standalone negation type so there's no other representation for this. -//! * The same type should never appear more than once in a union or intersection. (This should -//! be expanded to cover subtyping -- see below -- but for now we only implement it for type -//! identity.) -//! * Disjunctive normal form (DNF): the tree of unions and intersections can never be deeper -//! than a union-of-intersections. Unions cannot contain other unions (the inner union just -//! flattens into the outer one), intersections cannot contain other intersections (also -//! flattens), and intersections cannot contain unions (the intersection distributes over the -//! union, inverting it into a union-of-intersections). -//! -//! The implication of these invariants is that a [`UnionBuilder`] does not necessarily build a -//! [`Type::Union`]. For example, if only one type is added to the [`UnionBuilder`], `build()` will -//! just return that type directly. The same is true for [`IntersectionBuilder`]; for example, if a -//! union type is added to the intersection, it will distribute and [`IntersectionBuilder::build`] -//! may end up returning a [`Type::Union`] of intersections. -//! -//! In the future we should have these additional invariants, but they aren't implemented yet: -//! * No type in a union can be a subtype of any other type in the union (just eliminate the -//! subtype from the union). -//! * No type in an intersection can be a supertype of any other type in the intersection (just -//! eliminate the supertype from the intersection). -//! * An intersection containing two non-overlapping types should simplify to [`Type::Never`]. -use crate::types::{IntersectionType, Type, UnionType}; -use crate::{Db, FxOrderSet}; -use smallvec::SmallVec; - -use super::KnownClass; - -pub(crate) struct UnionBuilder<'db> { - elements: Vec>, - db: &'db dyn Db, -} - -impl<'db> UnionBuilder<'db> { - pub(crate) fn new(db: &'db dyn Db) -> Self { - Self { - db, - elements: vec![], - } - } - - /// Adds a type to this union. - pub(crate) fn add(mut self, ty: Type<'db>) -> Self { - match ty { - Type::Union(union) => { - let new_elements = union.elements(self.db); - self.elements.reserve(new_elements.len()); - for element in new_elements { - self = self.add(*element); - } - } - Type::Never => {} - _ => { - let bool_pair = if let Type::BooleanLiteral(b) = ty { - Some(Type::BooleanLiteral(!b)) - } else { - None - }; - - let mut to_add = ty; - let mut to_remove = SmallVec::<[usize; 2]>::new(); - for (index, element) in self.elements.iter().enumerate() { - if Some(*element) == bool_pair { - to_add = KnownClass::Bool.to_instance(self.db); - to_remove.push(index); - // The type we are adding is a BooleanLiteral, which doesn't have any - // subtypes. And we just found that the union already contained our - // mirror-image BooleanLiteral, so it can't also contain bool or any - // supertype of bool. Therefore, we are done. - break; - } - if ty.is_subtype_of(self.db, *element) { - return self; - } else if element.is_subtype_of(self.db, ty) { - to_remove.push(index); - } - } - - match to_remove[..] { - [] => self.elements.push(to_add), - [index] => self.elements[index] = to_add, - _ => { - let mut current_index = 0; - let mut to_remove = to_remove.into_iter(); - let mut next_to_remove_index = to_remove.next(); - self.elements.retain(|_| { - let retain = if Some(current_index) == next_to_remove_index { - next_to_remove_index = to_remove.next(); - false - } else { - true - }; - current_index += 1; - retain - }); - self.elements.push(to_add); - } - } - } - } - - self - } - - pub(crate) fn build(self) -> Type<'db> { - match self.elements.len() { - 0 => Type::Never, - 1 => self.elements[0], - _ => Type::Union(UnionType::new(self.db, self.elements.into_boxed_slice())), - } - } -} - -#[derive(Clone)] -pub(crate) struct IntersectionBuilder<'db> { - // Really this builds a union-of-intersections, because we always keep our set-theoretic types - // in disjunctive normal form (DNF), a union of intersections. In the simplest case there's - // just a single intersection in this vector, and we are building a single intersection type, - // but if a union is added to the intersection, we'll distribute ourselves over that union and - // create a union of intersections. - intersections: Vec>, - db: &'db dyn Db, -} - -impl<'db> IntersectionBuilder<'db> { - pub(crate) fn new(db: &'db dyn Db) -> Self { - Self { - db, - intersections: vec![InnerIntersectionBuilder::new()], - } - } - - fn empty(db: &'db dyn Db) -> Self { - Self { - db, - intersections: vec![], - } - } - - pub(crate) fn add_positive(mut self, ty: Type<'db>) -> Self { - if let Type::Union(union) = ty { - // Distribute ourself over this union: for each union element, clone ourself and - // intersect with that union element, then create a new union-of-intersections with all - // of those sub-intersections in it. E.g. if `self` is a simple intersection `T1 & T2` - // and we add `T3 | T4` to the intersection, we don't get `T1 & T2 & (T3 | T4)` (that's - // not in DNF), we distribute the union and get `(T1 & T3) | (T2 & T3) | (T1 & T4) | - // (T2 & T4)`. If `self` is already a union-of-intersections `(T1 & T2) | (T3 & T4)` - // and we add `T5 | T6` to it, that flattens all the way out to `(T1 & T2 & T5) | (T1 & - // T2 & T6) | (T3 & T4 & T5) ...` -- you get the idea. - union - .elements(self.db) - .iter() - .map(|elem| self.clone().add_positive(*elem)) - .fold(IntersectionBuilder::empty(self.db), |mut builder, sub| { - builder.intersections.extend(sub.intersections); - builder - }) - } else { - // If we are already a union-of-intersections, distribute the new intersected element - // across all of those intersections. - for inner in &mut self.intersections { - inner.add_positive(self.db, ty); - } - self - } - } - - pub(crate) fn add_negative(mut self, ty: Type<'db>) -> Self { - // See comments above in `add_positive`; this is just the negated version. - if let Type::Union(union) = ty { - for elem in union.elements(self.db) { - self = self.add_negative(*elem); - } - self - } else if let Type::Intersection(intersection) = ty { - // (A | B) & ~(C & ~D) - // -> (A | B) & (~C | D) - // -> ((A | B) & ~C) | ((A | B) & D) - // i.e. if we have an intersection of positive constraints C - // and negative constraints D, then our new intersection - // is (existing & ~C) | (existing & D) - - let positive_side = intersection - .positive(self.db) - .iter() - // we negate all the positive constraints while distributing - .map(|elem| self.clone().add_negative(*elem)); - - let negative_side = intersection - .negative(self.db) - .iter() - // all negative constraints end up becoming positive constraints - .map(|elem| self.clone().add_positive(*elem)); - - positive_side.chain(negative_side).fold( - IntersectionBuilder::empty(self.db), - |mut builder, sub| { - builder.intersections.extend(sub.intersections); - builder - }, - ) - } else { - for inner in &mut self.intersections { - inner.add_negative(self.db, ty); - } - self - } - } - - pub(crate) fn build(mut self) -> Type<'db> { - // Avoid allocating the UnionBuilder unnecessarily if we have just one intersection: - if self.intersections.len() == 1 { - self.intersections.pop().unwrap().build(self.db) - } else { - UnionType::from_elements( - self.db, - self.intersections - .into_iter() - .map(|inner| inner.build(self.db)), - ) - } - } -} - -#[derive(Debug, Clone, Default)] -struct InnerIntersectionBuilder<'db> { - positive: FxOrderSet>, - negative: FxOrderSet>, -} - -impl<'db> InnerIntersectionBuilder<'db> { - fn new() -> Self { - Self::default() - } - - /// Adds a positive type to this intersection. - fn add_positive(&mut self, db: &'db dyn Db, new_positive: Type<'db>) { - if let Type::Intersection(other) = new_positive { - for pos in other.positive(db) { - self.add_positive(db, *pos); - } - for neg in other.negative(db) { - self.add_negative(db, *neg); - } - } else { - // ~Literal[True] & bool = Literal[False] - if let Type::Instance(class_type) = new_positive { - if class_type.is_known(db, KnownClass::Bool) { - if let Some(&Type::BooleanLiteral(value)) = self - .negative - .iter() - .find(|element| element.is_boolean_literal()) - { - *self = Self::new(); - self.positive.insert(Type::BooleanLiteral(!value)); - return; - } - } - } - - let mut to_remove = SmallVec::<[usize; 1]>::new(); - for (index, existing_positive) in self.positive.iter().enumerate() { - // S & T = S if S <: T - if existing_positive.is_subtype_of(db, new_positive) { - return; - } - // same rule, reverse order - if new_positive.is_subtype_of(db, *existing_positive) { - to_remove.push(index); - } - // A & B = Never if A and B are disjoint - if new_positive.is_disjoint_from(db, *existing_positive) { - *self = Self::new(); - self.positive.insert(Type::Never); - return; - } - } - for index in to_remove.iter().rev() { - self.positive.swap_remove_index(*index); - } - - let mut to_remove = SmallVec::<[usize; 1]>::new(); - for (index, existing_negative) in self.negative.iter().enumerate() { - // S & ~T = Never if S <: T - if new_positive.is_subtype_of(db, *existing_negative) { - *self = Self::new(); - self.positive.insert(Type::Never); - return; - } - // A & ~B = A if A and B are disjoint - if existing_negative.is_disjoint_from(db, new_positive) { - to_remove.push(index); - } - } - for index in to_remove.iter().rev() { - self.negative.swap_remove_index(*index); - } - - self.positive.insert(new_positive); - } - } - - /// Adds a negative type to this intersection. - fn add_negative(&mut self, db: &'db dyn Db, new_negative: Type<'db>) { - match new_negative { - Type::Intersection(inter) => { - for pos in inter.positive(db) { - self.add_negative(db, *pos); - } - for neg in inter.negative(db) { - self.add_positive(db, *neg); - } - } - Type::Unbound => {} - ty @ (Type::Any | Type::Unknown | Type::Todo) => { - // Adding any of these types to the negative side of an intersection - // is equivalent to adding it to the positive side. We do this to - // simplify the representation. - self.positive.insert(ty); - } - // ~Literal[True] & bool = Literal[False] - Type::BooleanLiteral(bool) - if self - .positive - .iter() - .any(|pos| *pos == KnownClass::Bool.to_instance(db)) => - { - *self = Self::new(); - self.positive.insert(Type::BooleanLiteral(!bool)); - } - _ => { - let mut to_remove = SmallVec::<[usize; 1]>::new(); - for (index, existing_negative) in self.negative.iter().enumerate() { - // ~S & ~T = ~T if S <: T - if existing_negative.is_subtype_of(db, new_negative) { - to_remove.push(index); - } - // same rule, reverse order - if new_negative.is_subtype_of(db, *existing_negative) { - return; - } - } - for index in to_remove.iter().rev() { - self.negative.swap_remove_index(*index); - } - - for existing_positive in &self.positive { - // S & ~T = Never if S <: T - if existing_positive.is_subtype_of(db, new_negative) { - *self = Self::new(); - self.positive.insert(Type::Never); - return; - } - // A & ~B = A if A and B are disjoint - if existing_positive.is_disjoint_from(db, new_negative) { - return; - } - } - - self.negative.insert(new_negative); - } - } - } - - fn simplify_unbound(&mut self) { - if self.positive.contains(&Type::Unbound) { - self.positive.retain(Type::is_unbound); - self.negative.clear(); - } - } - - fn build(mut self, db: &'db dyn Db) -> Type<'db> { - self.simplify_unbound(); - match (self.positive.len(), self.negative.len()) { - (0, 0) => KnownClass::Object.to_instance(db), - (1, 0) => self.positive[0], - _ => { - self.positive.shrink_to_fit(); - self.negative.shrink_to_fit(); - Type::Intersection(IntersectionType::new(db, self.positive, self.negative)) - } - } - } -} - -#[cfg(test)] -mod tests { - use super::{IntersectionBuilder, IntersectionType, Type, UnionType}; - use crate::db::tests::TestDb; - use crate::program::{Program, SearchPathSettings}; - use crate::python_version::PythonVersion; - use crate::stdlib::typing_symbol_ty; - use crate::types::{KnownClass, StringLiteralType, UnionBuilder}; - use crate::ProgramSettings; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use test_case::test_case; - - fn setup_db() -> TestDb { - let db = TestDb::new(); - - let src_root = SystemPathBuf::from("/src"); - db.memory_file_system() - .create_directory_all(&src_root) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(src_root), - }, - ) - .expect("Valid search path settings"); - - db - } - - #[test] - fn build_union() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let t1 = Type::IntLiteral(1); - let union = UnionType::from_elements(&db, [t0, t1]).expect_union(); - - assert_eq!(union.elements(&db), &[t0, t1]); - } - - #[test] - fn build_union_single() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let ty = UnionType::from_elements(&db, [t0]); - assert_eq!(ty, t0); - } - - #[test] - fn build_union_empty() { - let db = setup_db(); - let ty = UnionBuilder::new(&db).build(); - assert_eq!(ty, Type::Never); - } - - #[test] - fn build_union_never() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let ty = UnionType::from_elements(&db, [t0, Type::Never]); - assert_eq!(ty, t0); - } - - #[test] - fn build_union_bool() { - let db = setup_db(); - let bool_instance_ty = KnownClass::Bool.to_instance(&db); - - let t0 = Type::BooleanLiteral(true); - let t1 = Type::BooleanLiteral(true); - let t2 = Type::BooleanLiteral(false); - let t3 = Type::IntLiteral(17); - - let union = UnionType::from_elements(&db, [t0, t1, t3]).expect_union(); - assert_eq!(union.elements(&db), &[t0, t3]); - - let union = UnionType::from_elements(&db, [t0, t1, t2, t3]).expect_union(); - assert_eq!(union.elements(&db), &[bool_instance_ty, t3]); - - let result_ty = UnionType::from_elements(&db, [bool_instance_ty, t0]); - assert_eq!(result_ty, bool_instance_ty); - - let result_ty = UnionType::from_elements(&db, [t0, bool_instance_ty]); - assert_eq!(result_ty, bool_instance_ty); - } - - #[test] - fn build_union_flatten() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let t1 = Type::IntLiteral(1); - let t2 = Type::IntLiteral(2); - let u1 = UnionType::from_elements(&db, [t0, t1]); - let union = UnionType::from_elements(&db, [u1, t2]).expect_union(); - - assert_eq!(union.elements(&db), &[t0, t1, t2]); - } - - #[test] - fn build_union_simplify_subtype() { - let db = setup_db(); - let t0 = KnownClass::Str.to_instance(&db); - let t1 = Type::LiteralString; - let u0 = UnionType::from_elements(&db, [t0, t1]); - let u1 = UnionType::from_elements(&db, [t1, t0]); - - assert_eq!(u0, t0); - assert_eq!(u1, t0); - } - - #[test] - fn build_union_no_simplify_unknown() { - let db = setup_db(); - let t0 = KnownClass::Str.to_instance(&db); - let t1 = Type::Unknown; - let u0 = UnionType::from_elements(&db, [t0, t1]); - let u1 = UnionType::from_elements(&db, [t1, t0]); - - assert_eq!(u0.expect_union().elements(&db), &[t0, t1]); - assert_eq!(u1.expect_union().elements(&db), &[t1, t0]); - } - - #[test] - fn build_union_subsume_multiple() { - let db = setup_db(); - let str_ty = KnownClass::Str.to_instance(&db); - let int_ty = KnownClass::Int.to_instance(&db); - let object_ty = KnownClass::Object.to_instance(&db); - let unknown_ty = Type::Unknown; - - let u0 = UnionType::from_elements(&db, [str_ty, unknown_ty, int_ty, object_ty]); - - assert_eq!(u0.expect_union().elements(&db), &[unknown_ty, object_ty]); - } - - impl<'db> IntersectionType<'db> { - fn pos_vec(self, db: &'db TestDb) -> Vec> { - self.positive(db).into_iter().copied().collect() - } - - fn neg_vec(self, db: &'db TestDb) -> Vec> { - self.negative(db).into_iter().copied().collect() - } - } - - #[test] - fn build_intersection() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let ta = Type::Any; - let intersection = IntersectionBuilder::new(&db) - .add_positive(ta) - .add_negative(t0) - .build() - .expect_intersection(); - - assert_eq!(intersection.pos_vec(&db), &[ta]); - assert_eq!(intersection.neg_vec(&db), &[t0]); - } - - #[test] - fn build_intersection_empty_intersection_equals_object() { - let db = setup_db(); - - let ty = IntersectionBuilder::new(&db).build(); - - assert_eq!(ty, KnownClass::Object.to_instance(&db)); - } - - #[test] - fn build_intersection_flatten_positive() { - let db = setup_db(); - let ta = Type::Any; - let t1 = Type::IntLiteral(1); - let t2 = Type::IntLiteral(2); - let i0 = IntersectionBuilder::new(&db) - .add_positive(ta) - .add_negative(t1) - .build(); - let intersection = IntersectionBuilder::new(&db) - .add_positive(t2) - .add_positive(i0) - .build() - .expect_intersection(); - - assert_eq!(intersection.pos_vec(&db), &[t2, ta]); - assert_eq!(intersection.neg_vec(&db), &[]); - } - - #[test] - fn build_intersection_flatten_negative() { - let db = setup_db(); - let ta = Type::Any; - let t1 = Type::IntLiteral(1); - let t2 = KnownClass::Int.to_instance(&db); - // i0 = Any & ~Literal[1] - let i0 = IntersectionBuilder::new(&db) - .add_positive(ta) - .add_negative(t1) - .build(); - // ta_not_i0 = int & ~(Any & ~Literal[1]) - // -> int & (~Any | Literal[1]) - // (~Any is equivalent to Any) - // -> (int & Any) | (int & Literal[1]) - // -> (int & Any) | Literal[1] - let ta_not_i0 = IntersectionBuilder::new(&db) - .add_positive(t2) - .add_negative(i0) - .build(); - - assert_eq!(ta_not_i0.display(&db).to_string(), "int & Any | Literal[1]"); - } - - #[test] - fn intersection_distributes_over_union() { - let db = setup_db(); - let t0 = Type::IntLiteral(0); - let t1 = Type::IntLiteral(1); - let ta = Type::Any; - let u0 = UnionType::from_elements(&db, [t0, t1]); - - let union = IntersectionBuilder::new(&db) - .add_positive(ta) - .add_positive(u0) - .build() - .expect_union(); - let [Type::Intersection(i0), Type::Intersection(i1)] = union.elements(&db)[..] else { - panic!("expected a union of two intersections"); - }; - assert_eq!(i0.pos_vec(&db), &[ta, t0]); - assert_eq!(i1.pos_vec(&db), &[ta, t1]); - } - - #[test] - fn intersection_negation_distributes_over_union() { - let db = setup_db(); - let st = typing_symbol_ty(&db, "Sized").to_instance(&db); - let ht = typing_symbol_ty(&db, "Hashable").to_instance(&db); - // sh_t: Sized & Hashable - let sh_t = IntersectionBuilder::new(&db) - .add_positive(st) - .add_positive(ht) - .build() - .expect_intersection(); - assert_eq!(sh_t.pos_vec(&db), &[st, ht]); - assert_eq!(sh_t.neg_vec(&db), &[]); - - // ~sh_t => ~Sized | ~Hashable - let not_s_h_t = IntersectionBuilder::new(&db) - .add_negative(Type::Intersection(sh_t)) - .build() - .expect_union(); - - // should have as elements: (~Sized),(~Hashable) - let not_st = st.negate(&db); - let not_ht = ht.negate(&db); - assert_eq!(not_s_h_t.elements(&db), &[not_st, not_ht]); - } - - #[test] - fn mixed_intersection_negation_distributes_over_union() { - let db = setup_db(); - let it = KnownClass::Int.to_instance(&db); - let st = typing_symbol_ty(&db, "Sized").to_instance(&db); - let ht = typing_symbol_ty(&db, "Hashable").to_instance(&db); - // s_not_h_t: Sized & ~Hashable - let s_not_h_t = IntersectionBuilder::new(&db) - .add_positive(st) - .add_negative(ht) - .build() - .expect_intersection(); - assert_eq!(s_not_h_t.pos_vec(&db), &[st]); - assert_eq!(s_not_h_t.neg_vec(&db), &[ht]); - - // let's build int & ~(Sized & ~Hashable) - let tt = IntersectionBuilder::new(&db) - .add_positive(it) - .add_negative(Type::Intersection(s_not_h_t)) - .build(); - - // int & ~(Sized & ~Hashable) - // -> int & (~Sized | Hashable) - // -> (int & ~Sized) | (int & Hashable) - assert_eq!(tt.display(&db).to_string(), "int & ~Sized | int & Hashable"); - } - - #[test] - fn build_intersection_self_negation() { - let db = setup_db(); - let ty = IntersectionBuilder::new(&db) - .add_positive(Type::None) - .add_negative(Type::None) - .build(); - - assert_eq!(ty, Type::Never); - } - - #[test] - fn build_intersection_simplify_negative_never() { - let db = setup_db(); - let ty = IntersectionBuilder::new(&db) - .add_positive(Type::None) - .add_negative(Type::Never) - .build(); - - assert_eq!(ty, Type::None); - } - - #[test] - fn build_intersection_simplify_positive_never() { - let db = setup_db(); - let ty = IntersectionBuilder::new(&db) - .add_positive(Type::None) - .add_positive(Type::Never) - .build(); - - assert_eq!(ty, Type::Never); - } - - #[test] - fn build_intersection_simplify_positive_unbound() { - let db = setup_db(); - let ty = IntersectionBuilder::new(&db) - .add_positive(Type::Unbound) - .add_positive(Type::IntLiteral(1)) - .build(); - - assert_eq!(ty, Type::Unbound); - } - - #[test] - fn build_intersection_simplify_negative_unbound() { - let db = setup_db(); - let ty = IntersectionBuilder::new(&db) - .add_negative(Type::Unbound) - .add_positive(Type::IntLiteral(1)) - .build(); - - assert_eq!(ty, Type::IntLiteral(1)); - } - - #[test] - fn build_intersection_simplify_negative_none() { - let db = setup_db(); - - let ty = IntersectionBuilder::new(&db) - .add_negative(Type::None) - .add_positive(Type::IntLiteral(1)) - .build(); - assert_eq!(ty, Type::IntLiteral(1)); - - let ty = IntersectionBuilder::new(&db) - .add_positive(Type::IntLiteral(1)) - .add_negative(Type::None) - .build(); - assert_eq!(ty, Type::IntLiteral(1)); - } - - #[test] - fn build_negative_union_de_morgan() { - let db = setup_db(); - - let union = UnionBuilder::new(&db) - .add(Type::IntLiteral(1)) - .add(Type::IntLiteral(2)) - .build(); - assert_eq!(union.display(&db).to_string(), "Literal[1, 2]"); - - let ty = IntersectionBuilder::new(&db).add_negative(union).build(); - - let expected = IntersectionBuilder::new(&db) - .add_negative(Type::IntLiteral(1)) - .add_negative(Type::IntLiteral(2)) - .build(); - - assert_eq!(ty.display(&db).to_string(), "~Literal[1] & ~Literal[2]"); - assert_eq!(ty, expected); - } - - #[test] - fn build_intersection_simplify_positive_type_and_positive_subtype() { - let db = setup_db(); - - let t = KnownClass::Str.to_instance(&db); - let s = Type::LiteralString; - - let ty = IntersectionBuilder::new(&db) - .add_positive(t) - .add_positive(s) - .build(); - assert_eq!(ty, s); - - let ty = IntersectionBuilder::new(&db) - .add_positive(s) - .add_positive(t) - .build(); - assert_eq!(ty, s); - - let literal = Type::StringLiteral(StringLiteralType::new(&db, "a")); - let expected = IntersectionBuilder::new(&db) - .add_positive(s) - .add_negative(literal) - .build(); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t) - .add_negative(literal) - .add_positive(s) - .build(); - assert_eq!(ty, expected); - - let ty = IntersectionBuilder::new(&db) - .add_positive(s) - .add_negative(literal) - .add_positive(t) - .build(); - assert_eq!(ty, expected); - } - - #[test] - fn build_intersection_simplify_negative_type_and_negative_subtype() { - let db = setup_db(); - - let t = KnownClass::Str.to_instance(&db); - let s = Type::LiteralString; - - let expected = IntersectionBuilder::new(&db).add_negative(t).build(); - - let ty = IntersectionBuilder::new(&db) - .add_negative(t) - .add_negative(s) - .build(); - assert_eq!(ty, expected); - - let ty = IntersectionBuilder::new(&db) - .add_negative(s) - .add_negative(t) - .build(); - assert_eq!(ty, expected); - - let object = KnownClass::Object.to_instance(&db); - let expected = IntersectionBuilder::new(&db) - .add_negative(t) - .add_positive(object) - .build(); - - let ty = IntersectionBuilder::new(&db) - .add_negative(t) - .add_positive(object) - .add_negative(s) - .build(); - assert_eq!(ty, expected); - } - - #[test] - fn build_intersection_simplify_negative_type_and_multiple_negative_subtypes() { - let db = setup_db(); - - let s1 = Type::IntLiteral(1); - let s2 = Type::IntLiteral(2); - let t = KnownClass::Int.to_instance(&db); - - let expected = IntersectionBuilder::new(&db).add_negative(t).build(); - - let ty = IntersectionBuilder::new(&db) - .add_negative(s1) - .add_negative(s2) - .add_negative(t) - .build(); - assert_eq!(ty, expected); - } - - #[test] - fn build_intersection_simplify_negative_type_and_positive_subtype() { - let db = setup_db(); - - let t = KnownClass::Str.to_instance(&db); - let s = Type::LiteralString; - - let ty = IntersectionBuilder::new(&db) - .add_negative(t) - .add_positive(s) - .build(); - assert_eq!(ty, Type::Never); - - let ty = IntersectionBuilder::new(&db) - .add_positive(s) - .add_negative(t) - .build(); - assert_eq!(ty, Type::Never); - - // This should also work in the presence of additional contributions: - let ty = IntersectionBuilder::new(&db) - .add_positive(KnownClass::Object.to_instance(&db)) - .add_negative(t) - .add_positive(s) - .build(); - assert_eq!(ty, Type::Never); - - let ty = IntersectionBuilder::new(&db) - .add_positive(s) - .add_negative(Type::StringLiteral(StringLiteralType::new(&db, "a"))) - .add_negative(t) - .build(); - assert_eq!(ty, Type::Never); - } - - #[test] - fn build_intersection_simplify_disjoint_positive_types() { - let db = setup_db(); - - let t1 = Type::IntLiteral(1); - let t2 = Type::None; - - let ty = IntersectionBuilder::new(&db) - .add_positive(t1) - .add_positive(t2) - .build(); - assert_eq!(ty, Type::Never); - - // If there are any negative contributions, they should - // be removed too. - let ty = IntersectionBuilder::new(&db) - .add_positive(KnownClass::Str.to_instance(&db)) - .add_negative(Type::LiteralString) - .add_positive(t2) - .build(); - assert_eq!(ty, Type::Never); - } - - #[test] - fn build_intersection_simplify_disjoint_positive_and_negative_types() { - let db = setup_db(); - - let t_p = KnownClass::Int.to_instance(&db); - let t_n = Type::StringLiteral(StringLiteralType::new(&db, "t_n")); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t_p) - .add_negative(t_n) - .build(); - assert_eq!(ty, t_p); - - let ty = IntersectionBuilder::new(&db) - .add_negative(t_n) - .add_positive(t_p) - .build(); - assert_eq!(ty, t_p); - - let int_literal = Type::IntLiteral(1); - let expected = IntersectionBuilder::new(&db) - .add_positive(t_p) - .add_negative(int_literal) - .build(); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t_p) - .add_negative(int_literal) - .add_negative(t_n) - .build(); - assert_eq!(ty, expected); - - let ty = IntersectionBuilder::new(&db) - .add_negative(t_n) - .add_negative(int_literal) - .add_positive(t_p) - .build(); - assert_eq!(ty, expected); - } - - #[test_case(true)] - #[test_case(false)] - fn build_intersection_simplify_split_bool(bool_value: bool) { - let db = setup_db(); - - let t_bool = KnownClass::Bool.to_instance(&db); - let t_boolean_literal = Type::BooleanLiteral(bool_value); - - // We add t_object in various orders (in first or second position) in - // the tests below to ensure that the boolean simplification eliminates - // everything from the intersection, not just `bool`. - let t_object = KnownClass::Object.to_instance(&db); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t_object) - .add_positive(t_bool) - .add_negative(t_boolean_literal) - .build(); - assert_eq!(ty, Type::BooleanLiteral(!bool_value)); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t_bool) - .add_positive(t_object) - .add_negative(t_boolean_literal) - .build(); - assert_eq!(ty, Type::BooleanLiteral(!bool_value)); - - let ty = IntersectionBuilder::new(&db) - .add_positive(t_object) - .add_negative(t_boolean_literal) - .add_positive(t_bool) - .build(); - assert_eq!(ty, Type::BooleanLiteral(!bool_value)); - - let ty = IntersectionBuilder::new(&db) - .add_negative(t_boolean_literal) - .add_positive(t_object) - .add_positive(t_bool) - .build(); - assert_eq!(ty, Type::BooleanLiteral(!bool_value)); - } - - #[test_case(Type::Any)] - #[test_case(Type::Unknown)] - #[test_case(Type::Todo)] - fn build_intersection_t_and_negative_t_does_not_simplify(ty: Type) { - let db = setup_db(); - - let result = IntersectionBuilder::new(&db) - .add_positive(ty) - .add_negative(ty) - .build(); - assert_eq!(result, ty); - - let result = IntersectionBuilder::new(&db) - .add_negative(ty) - .add_positive(ty) - .build(); - assert_eq!(result, ty); - } -} diff --git a/crates/red_knot_python_semantic/src/types/diagnostic.rs b/crates/red_knot_python_semantic/src/types/diagnostic.rs deleted file mode 100644 index 3da2373d23ab8..0000000000000 --- a/crates/red_knot_python_semantic/src/types/diagnostic.rs +++ /dev/null @@ -1,111 +0,0 @@ -use ruff_db::files::File; -use ruff_text_size::{Ranged, TextRange}; -use std::fmt::Formatter; -use std::ops::Deref; -use std::sync::Arc; - -#[derive(Debug, Eq, PartialEq)] -pub struct TypeCheckDiagnostic { - // TODO: Don't use string keys for rules - pub(super) rule: String, - pub(super) message: String, - pub(super) range: TextRange, - pub(super) file: File, -} - -impl TypeCheckDiagnostic { - pub fn rule(&self) -> &str { - &self.rule - } - - pub fn message(&self) -> &str { - &self.message - } - - pub fn file(&self) -> File { - self.file - } -} - -impl Ranged for TypeCheckDiagnostic { - fn range(&self) -> TextRange { - self.range - } -} - -/// A collection of type check diagnostics. -/// -/// The diagnostics are wrapped in an `Arc` because they need to be cloned multiple times -/// when going from `infer_expression` to `check_file`. We could consider -/// making [`TypeCheckDiagnostic`] a Salsa struct to have them Arena-allocated (once the Tables refactor is done). -/// Using Salsa struct does have the downside that it leaks the Salsa dependency into diagnostics and -/// each Salsa-struct comes with an overhead. -#[derive(Default, Eq, PartialEq)] -pub struct TypeCheckDiagnostics { - inner: Vec>, -} - -impl TypeCheckDiagnostics { - pub fn new() -> Self { - Self { inner: Vec::new() } - } - - pub(super) fn push(&mut self, diagnostic: TypeCheckDiagnostic) { - self.inner.push(Arc::new(diagnostic)); - } - - pub(crate) fn shrink_to_fit(&mut self) { - self.inner.shrink_to_fit(); - } -} - -impl Extend for TypeCheckDiagnostics { - fn extend>(&mut self, iter: T) { - self.inner.extend(iter.into_iter().map(std::sync::Arc::new)); - } -} - -impl Extend> for TypeCheckDiagnostics { - fn extend>>(&mut self, iter: T) { - self.inner.extend(iter); - } -} - -impl<'a> Extend<&'a std::sync::Arc> for TypeCheckDiagnostics { - fn extend>>(&mut self, iter: T) { - self.inner - .extend(iter.into_iter().map(std::sync::Arc::clone)); - } -} - -impl std::fmt::Debug for TypeCheckDiagnostics { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - self.inner.fmt(f) - } -} - -impl Deref for TypeCheckDiagnostics { - type Target = [std::sync::Arc]; - - fn deref(&self) -> &Self::Target { - &self.inner - } -} - -impl IntoIterator for TypeCheckDiagnostics { - type Item = Arc; - type IntoIter = std::vec::IntoIter>; - - fn into_iter(self) -> Self::IntoIter { - self.inner.into_iter() - } -} - -impl<'a> IntoIterator for &'a TypeCheckDiagnostics { - type Item = &'a Arc; - type IntoIter = std::slice::Iter<'a, std::sync::Arc>; - - fn into_iter(self) -> Self::IntoIter { - self.inner.iter() - } -} diff --git a/crates/red_knot_python_semantic/src/types/display.rs b/crates/red_knot_python_semantic/src/types/display.rs deleted file mode 100644 index 395b290ae024c..0000000000000 --- a/crates/red_knot_python_semantic/src/types/display.rs +++ /dev/null @@ -1,379 +0,0 @@ -//! Display implementations for types. - -use std::fmt::{self, Display, Formatter}; - -use ruff_db::display::FormatterJoinExtension; -use ruff_python_ast::str::Quote; -use ruff_python_literal::escape::AsciiEscape; - -use crate::types::{IntersectionType, Type, UnionType}; -use crate::Db; -use rustc_hash::FxHashMap; - -impl<'db> Type<'db> { - pub fn display(&self, db: &'db dyn Db) -> DisplayType { - DisplayType { ty: self, db } - } - fn representation(self, db: &'db dyn Db) -> DisplayRepresentation<'db> { - DisplayRepresentation { db, ty: self } - } -} - -#[derive(Copy, Clone)] -pub struct DisplayType<'db> { - ty: &'db Type<'db>, - db: &'db dyn Db, -} - -impl Display for DisplayType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - let representation = self.ty.representation(self.db); - if matches!( - self.ty, - Type::IntLiteral(_) - | Type::BooleanLiteral(_) - | Type::StringLiteral(_) - | Type::BytesLiteral(_) - | Type::ClassLiteral(_) - | Type::FunctionLiteral(_) - ) { - write!(f, "Literal[{representation}]") - } else { - representation.fmt(f) - } - } -} - -impl fmt::Debug for DisplayType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - Display::fmt(self, f) - } -} - -/// Writes the string representation of a type, which is the value displayed either as -/// `Literal[]` or `Literal[, ]` for literal types or as `` for -/// non literals -struct DisplayRepresentation<'db> { - ty: Type<'db>, - db: &'db dyn Db, -} - -impl Display for DisplayRepresentation<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - match self.ty { - Type::Any => f.write_str("Any"), - Type::Never => f.write_str("Never"), - Type::Unknown => f.write_str("Unknown"), - Type::Unbound => f.write_str("Unbound"), - Type::None => f.write_str("None"), - // `[Type::Todo]`'s display should be explicit that is not a valid display of - // any other type - Type::Todo => f.write_str("@Todo"), - Type::ModuleLiteral(file) => { - write!(f, "", file.path(self.db)) - } - // TODO functions and classes should display using a fully qualified name - Type::ClassLiteral(class) => f.write_str(class.name(self.db)), - Type::Instance(class) => f.write_str(class.name(self.db)), - Type::FunctionLiteral(function) => f.write_str(function.name(self.db)), - Type::Union(union) => union.display(self.db).fmt(f), - Type::Intersection(intersection) => intersection.display(self.db).fmt(f), - Type::IntLiteral(n) => n.fmt(f), - Type::BooleanLiteral(boolean) => f.write_str(if boolean { "True" } else { "False" }), - Type::StringLiteral(string) => { - write!(f, r#""{}""#, string.value(self.db).replace('"', r#"\""#)) - } - Type::LiteralString => f.write_str("LiteralString"), - Type::BytesLiteral(bytes) => { - let escape = - AsciiEscape::with_preferred_quote(bytes.value(self.db).as_ref(), Quote::Double); - - escape.bytes_repr().write(f) - } - Type::Tuple(tuple) => { - f.write_str("tuple[")?; - let elements = tuple.elements(self.db); - if elements.is_empty() { - f.write_str("()")?; - } else { - elements.display(self.db).fmt(f)?; - } - f.write_str("]") - } - } - } -} - -impl<'db> UnionType<'db> { - fn display(&'db self, db: &'db dyn Db) -> DisplayUnionType<'db> { - DisplayUnionType { db, ty: self } - } -} - -struct DisplayUnionType<'db> { - ty: &'db UnionType<'db>, - db: &'db dyn Db, -} - -impl Display for DisplayUnionType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - let elements = self.ty.elements(self.db); - - // Group condensed-display types by kind. - let mut grouped_condensed_kinds = FxHashMap::default(); - - for element in elements { - if let Ok(kind) = CondensedDisplayTypeKind::try_from(*element) { - grouped_condensed_kinds - .entry(kind) - .or_insert_with(Vec::new) - .push(*element); - } - } - - let mut join = f.join(" | "); - - for element in elements { - if let Ok(kind) = CondensedDisplayTypeKind::try_from(*element) { - let Some(mut condensed_kind) = grouped_condensed_kinds.remove(&kind) else { - continue; - }; - if kind == CondensedDisplayTypeKind::Int { - condensed_kind.sort_unstable_by_key(|ty| ty.expect_int_literal()); - } - join.entry(&DisplayLiteralGroup { - literals: condensed_kind, - db: self.db, - }); - } else { - join.entry(&element.display(self.db)); - } - } - - join.finish()?; - - debug_assert!(grouped_condensed_kinds.is_empty()); - - Ok(()) - } -} - -impl fmt::Debug for DisplayUnionType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - Display::fmt(self, f) - } -} - -struct DisplayLiteralGroup<'db> { - literals: Vec>, - db: &'db dyn Db, -} - -impl Display for DisplayLiteralGroup<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - f.write_str("Literal[")?; - f.join(", ") - .entries(self.literals.iter().map(|ty| ty.representation(self.db))) - .finish()?; - f.write_str("]") - } -} - -/// Enumeration of literal types that are displayed in a "condensed way" inside `Literal` slices. -/// -/// For example, `Literal[1] | Literal[2]` is displayed as `"Literal[1, 2]"`. -/// Not all `Literal` types are displayed using `Literal` slices -/// (e.g. it would be inappropriate to display `LiteralString` -/// as `Literal[LiteralString]`). -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -enum CondensedDisplayTypeKind { - Class, - Function, - Int, - String, - Bytes, -} - -impl TryFrom> for CondensedDisplayTypeKind { - type Error = (); - - fn try_from(value: Type<'_>) -> Result { - match value { - Type::ClassLiteral(_) => Ok(Self::Class), - Type::FunctionLiteral(_) => Ok(Self::Function), - Type::IntLiteral(_) => Ok(Self::Int), - Type::StringLiteral(_) => Ok(Self::String), - Type::BytesLiteral(_) => Ok(Self::Bytes), - _ => Err(()), - } - } -} - -impl<'db> IntersectionType<'db> { - fn display(&'db self, db: &'db dyn Db) -> DisplayIntersectionType<'db> { - DisplayIntersectionType { db, ty: self } - } -} - -struct DisplayIntersectionType<'db> { - ty: &'db IntersectionType<'db>, - db: &'db dyn Db, -} - -impl Display for DisplayIntersectionType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - let tys = self - .ty - .positive(self.db) - .iter() - .map(|&ty| DisplayMaybeNegatedType { - ty, - db: self.db, - negated: false, - }) - .chain( - self.ty - .negative(self.db) - .iter() - .map(|&ty| DisplayMaybeNegatedType { - ty, - db: self.db, - negated: true, - }), - ); - f.join(" & ").entries(tys).finish() - } -} - -impl fmt::Debug for DisplayIntersectionType<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - Display::fmt(self, f) - } -} - -struct DisplayMaybeNegatedType<'db> { - ty: Type<'db>, - db: &'db dyn Db, - negated: bool, -} - -impl<'db> Display for DisplayMaybeNegatedType<'db> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - if self.negated { - f.write_str("~")?; - } - self.ty.display(self.db).fmt(f) - } -} - -pub(crate) trait TypeArrayDisplay<'db> { - fn display(&self, db: &'db dyn Db) -> DisplayTypeArray; -} - -impl<'db> TypeArrayDisplay<'db> for Box<[Type<'db>]> { - fn display(&self, db: &'db dyn Db) -> DisplayTypeArray { - DisplayTypeArray { types: self, db } - } -} - -impl<'db> TypeArrayDisplay<'db> for Vec> { - fn display(&self, db: &'db dyn Db) -> DisplayTypeArray { - DisplayTypeArray { types: self, db } - } -} - -pub(crate) struct DisplayTypeArray<'b, 'db> { - types: &'b [Type<'db>], - db: &'db dyn Db, -} - -impl<'db> Display for DisplayTypeArray<'_, 'db> { - fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - f.join(", ") - .entries(self.types.iter().map(|ty| ty.display(self.db))) - .finish() - } -} - -#[cfg(test)] -mod tests { - use ruff_db::files::system_path_to_file; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - - use crate::db::tests::TestDb; - use crate::types::{global_symbol_ty, BytesLiteralType, StringLiteralType, Type, UnionType}; - use crate::{Program, ProgramSettings, PythonVersion, SearchPathSettings}; - - fn setup_db() -> TestDb { - let db = TestDb::new(); - - let src_root = SystemPathBuf::from("/src"); - db.memory_file_system() - .create_directory_all(&src_root) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(src_root), - }, - ) - .expect("Valid search path settings"); - - db - } - - #[test] - fn test_condense_literal_display_by_type() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/main.py", - " - def foo(x: int) -> int: - return x + 1 - - def bar(s: str) -> str: - return s - - class A: ... - class B: ... - ", - )?; - let mod_file = system_path_to_file(&db, "src/main.py").expect("file to exist"); - - let union_elements = &[ - Type::Unknown, - Type::IntLiteral(-1), - global_symbol_ty(&db, mod_file, "A"), - Type::StringLiteral(StringLiteralType::new(&db, "A")), - Type::BytesLiteral(BytesLiteralType::new(&db, [0u8].as_slice())), - Type::BytesLiteral(BytesLiteralType::new(&db, [7u8].as_slice())), - Type::IntLiteral(0), - Type::IntLiteral(1), - Type::StringLiteral(StringLiteralType::new(&db, "B")), - global_symbol_ty(&db, mod_file, "foo"), - global_symbol_ty(&db, mod_file, "bar"), - global_symbol_ty(&db, mod_file, "B"), - Type::BooleanLiteral(true), - Type::None, - ]; - let union = UnionType::from_elements(&db, union_elements).expect_union(); - let display = format!("{}", union.display(&db)); - assert_eq!( - display, - concat!( - "Unknown | ", - "Literal[-1, 0, 1] | ", - "Literal[A, B] | ", - "Literal[\"A\", \"B\"] | ", - "Literal[b\"\\x00\", b\"\\x07\"] | ", - "Literal[foo, bar] | ", - "Literal[True] | ", - "None" - ) - ); - Ok(()) - } -} diff --git a/crates/red_knot_python_semantic/src/types/infer.rs b/crates/red_knot_python_semantic/src/types/infer.rs deleted file mode 100644 index 7720bfcbeb814..0000000000000 --- a/crates/red_knot_python_semantic/src/types/infer.rs +++ /dev/null @@ -1,5044 +0,0 @@ -//! We have Salsa queries for inferring types at three different granularities: scope-level, -//! definition-level, and expression-level. -//! -//! Scope-level inference is for when we are actually checking a file, and need to check types for -//! everything in that file's scopes, or give a linter access to types of arbitrary expressions -//! (via the [`HasTy`](crate::semantic_model::HasTy) trait). -//! -//! Definition-level inference allows us to look up the types of symbols in other scopes (e.g. for -//! imports) with the minimum inference necessary, so that if we're looking up one symbol from a -//! very large module, we can avoid a bunch of unnecessary work. Definition-level inference also -//! allows us to handle import cycles without getting into a cycle of scope-level inference -//! queries. -//! -//! The expression-level inference query is needed in only a few cases. Since some assignments can -//! have multiple targets (via `x = y = z` or unpacking `(x, y) = z`, they can be associated with -//! multiple definitions (one per assigned symbol). In order to avoid inferring the type of the -//! right-hand side once per definition, we infer it as a standalone query, so its result will be -//! cached by Salsa. We also need the expression-level query for inferring types in type guard -//! expressions (e.g. the test clause of an `if` statement.) -//! -//! Inferring types at any of the three region granularities returns a [`TypeInference`], which -//! holds types for every [`Definition`] and expression within the inferred region. -//! -//! Some type expressions can require deferred evaluation. This includes all type expressions in -//! stub files, or annotation expressions in modules with `from __future__ import annotations`, or -//! stringified annotations. We have a fourth Salsa query for inferring the deferred types -//! associated with a particular definition. Scope-level inference infers deferred types for all -//! definitions once the rest of the types in the scope have been inferred. -use itertools::Itertools; -use std::borrow::Cow; -use std::num::NonZeroU32; - -use ruff_db::files::File; -use ruff_db::parsed::parsed_module; -use ruff_python_ast::{self as ast, AnyNodeRef, ExprContext, UnaryOp}; -use ruff_text_size::Ranged; -use rustc_hash::FxHashMap; -use salsa; -use salsa::plumbing::AsId; - -use crate::module_name::ModuleName; -use crate::module_resolver::{file_to_module, resolve_module}; -use crate::semantic_index::ast_ids::{HasScopedAstId, HasScopedUseId, ScopedExpressionId}; -use crate::semantic_index::definition::{ - AssignmentKind, Definition, DefinitionKind, DefinitionNodeKey, ExceptHandlerDefinitionKind, -}; -use crate::semantic_index::expression::Expression; -use crate::semantic_index::semantic_index; -use crate::semantic_index::symbol::{NodeWithScopeKind, NodeWithScopeRef, ScopeId}; -use crate::semantic_index::SemanticIndex; -use crate::stdlib::builtins_module_scope; -use crate::types::diagnostic::{TypeCheckDiagnostic, TypeCheckDiagnostics}; -use crate::types::{ - bindings_ty, builtins_symbol_ty, declarations_ty, global_symbol_ty, symbol_ty, - typing_extensions_symbol_ty, BytesLiteralType, ClassType, FunctionType, KnownFunction, - StringLiteralType, Truthiness, TupleType, Type, TypeArrayDisplay, UnionType, -}; -use crate::util::subscript::PythonSubscript; -use crate::Db; - -use super::{IterationOutcome, KnownClass, UnionBuilder}; - -/// Infer all types for a [`ScopeId`], including all definitions and expressions in that scope. -/// Use when checking a scope, or needing to provide a type for an arbitrary expression in the -/// scope. -#[salsa::tracked(return_ref)] -pub(crate) fn infer_scope_types<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> TypeInference<'db> { - let file = scope.file(db); - let _span = - tracing::trace_span!("infer_scope_types", scope=?scope.as_id(), file=%file.path(db)) - .entered(); - - // Using the index here is fine because the code below depends on the AST anyway. - // The isolation of the query is by the return inferred types. - let index = semantic_index(db, file); - - TypeInferenceBuilder::new(db, InferenceRegion::Scope(scope), index).finish() -} - -/// Cycle recovery for [`infer_definition_types()`]: for now, just [`Type::Unknown`] -/// TODO fixpoint iteration -fn infer_definition_types_cycle_recovery<'db>( - db: &'db dyn Db, - _cycle: &salsa::Cycle, - input: Definition<'db>, -) -> TypeInference<'db> { - tracing::trace!("infer_definition_types_cycle_recovery"); - let mut inference = TypeInference::empty(input.scope(db)); - let category = input.category(db); - if category.is_declaration() { - inference.declarations.insert(input, Type::Unknown); - } - if category.is_binding() { - inference.bindings.insert(input, Type::Unknown); - } - // TODO we don't fill in expression types for the cycle-participant definitions, which can - // later cause a panic when looking up an expression type. - inference -} - -/// Infer all types for a [`Definition`] (including sub-expressions). -/// Use when resolving a symbol name use or public type of a symbol. -#[salsa::tracked(return_ref, recovery_fn=infer_definition_types_cycle_recovery)] -pub(crate) fn infer_definition_types<'db>( - db: &'db dyn Db, - definition: Definition<'db>, -) -> TypeInference<'db> { - let file = definition.file(db); - let _span = tracing::trace_span!( - "infer_definition_types", - definition = ?definition.as_id(), - file = %file.path(db) - ) - .entered(); - - let index = semantic_index(db, file); - - TypeInferenceBuilder::new(db, InferenceRegion::Definition(definition), index).finish() -} - -/// Infer types for all deferred type expressions in a [`Definition`]. -/// -/// Deferred expressions are type expressions (annotations, base classes, aliases...) in a stub -/// file, or in a file with `from __future__ import annotations`, or stringified annotations. -#[salsa::tracked(return_ref)] -pub(crate) fn infer_deferred_types<'db>( - db: &'db dyn Db, - definition: Definition<'db>, -) -> TypeInference<'db> { - let file = definition.file(db); - let _span = tracing::trace_span!( - "infer_deferred_types", - definition = ?definition.as_id(), - file = %file.path(db) - ) - .entered(); - - let index = semantic_index(db, file); - - TypeInferenceBuilder::new(db, InferenceRegion::Deferred(definition), index).finish() -} - -/// Infer all types for an [`Expression`] (including sub-expressions). -/// Use rarely; only for cases where we'd otherwise risk double-inferring an expression: RHS of an -/// assignment, which might be unpacking/multi-target and thus part of multiple definitions, or a -/// type narrowing guard expression (e.g. if statement test node). -#[allow(unused)] -#[salsa::tracked(return_ref)] -pub(crate) fn infer_expression_types<'db>( - db: &'db dyn Db, - expression: Expression<'db>, -) -> TypeInference<'db> { - let file = expression.file(db); - let _span = - tracing::trace_span!("infer_expression_types", expression=?expression.as_id(), file=%file.path(db)) - .entered(); - - let index = semantic_index(db, file); - - TypeInferenceBuilder::new(db, InferenceRegion::Expression(expression), index).finish() -} - -/// A region within which we can infer types. -pub(crate) enum InferenceRegion<'db> { - /// infer types for a standalone [`Expression`] - Expression(Expression<'db>), - /// infer types for a [`Definition`] - Definition(Definition<'db>), - /// infer deferred types for a [`Definition`] - Deferred(Definition<'db>), - /// infer types for an entire [`ScopeId`] - Scope(ScopeId<'db>), -} - -/// The inferred types for a single region. -#[derive(Debug, Eq, PartialEq)] -pub(crate) struct TypeInference<'db> { - /// The types of every expression in this region. - expressions: FxHashMap>, - - /// The types of every binding in this region. - bindings: FxHashMap, Type<'db>>, - - /// The types of every declaration in this region. - declarations: FxHashMap, Type<'db>>, - - /// The diagnostics for this region. - diagnostics: TypeCheckDiagnostics, - - /// Are there deferred type expressions in this region? - has_deferred: bool, - - /// The scope belong to this region. - scope: ScopeId<'db>, -} - -impl<'db> TypeInference<'db> { - pub(crate) fn empty(scope: ScopeId<'db>) -> Self { - Self { - expressions: FxHashMap::default(), - bindings: FxHashMap::default(), - declarations: FxHashMap::default(), - diagnostics: TypeCheckDiagnostics::default(), - has_deferred: false, - scope, - } - } - - #[track_caller] - pub(crate) fn expression_ty(&self, expression: ScopedExpressionId) -> Type<'db> { - self.expressions[&expression] - } - - pub(crate) fn try_expression_ty(&self, expression: ScopedExpressionId) -> Option> { - self.expressions.get(&expression).copied() - } - - #[track_caller] - pub(crate) fn binding_ty(&self, definition: Definition<'db>) -> Type<'db> { - self.bindings[&definition] - } - - #[track_caller] - pub(crate) fn declaration_ty(&self, definition: Definition<'db>) -> Type<'db> { - self.declarations[&definition] - } - - pub(crate) fn diagnostics(&self) -> &[std::sync::Arc] { - &self.diagnostics - } - - fn shrink_to_fit(&mut self) { - self.expressions.shrink_to_fit(); - self.bindings.shrink_to_fit(); - self.declarations.shrink_to_fit(); - self.diagnostics.shrink_to_fit(); - } -} - -/// Builder to infer all types in a region. -/// -/// A builder is used by creating it with [`new()`](TypeInferenceBuilder::new), and then calling -/// [`finish()`](TypeInferenceBuilder::finish) on it, which returns the resulting -/// [`TypeInference`]. -/// -/// There are a few different kinds of methods in the type inference builder, and the naming -/// distinctions are a bit subtle. -/// -/// The `finish` method calls [`infer_region`](TypeInferenceBuilder::infer_region), which delegates -/// to one of [`infer_region_scope`](TypeInferenceBuilder::infer_region_scope), -/// [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition), or -/// [`infer_region_expression`](TypeInferenceBuilder::infer_region_expression), depending which -/// kind of [`InferenceRegion`] we are inferring types for. -/// -/// Scope inference starts with the scope body, walking all statements and expressions and -/// recording the types of each expression in the [`TypeInference`] result. Most of the methods -/// here (with names like `infer_*_statement` or `infer_*_expression` or some other node kind) take -/// a single AST node and are called as part of this AST visit. -/// -/// When the visit encounters a node which creates a [`Definition`], we look up the definition in -/// the semantic index and call the [`infer_definition_types()`] query on it, which creates another -/// [`TypeInferenceBuilder`] just for that definition, and we merge the returned [`TypeInference`] -/// into the one we are currently building for the entire scope. Using the query in this way -/// ensures that if we first infer types for some scattered definitions in a scope, and later for -/// the entire scope, we don't re-infer any types, we re-use the cached inference for those -/// definitions and their sub-expressions. -/// -/// Functions with a name like `infer_*_definition` take both a node and a [`Definition`], and are -/// called by [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition). -/// -/// So for example we have both -/// [`infer_function_definition_statement`](TypeInferenceBuilder::infer_function_definition_statement), -/// which takes just the function AST node, and -/// [`infer_function_definition`](TypeInferenceBuilder::infer_function_definition), which takes -/// both the node and the [`Definition`] id. The former is called as part of walking the AST, and -/// it just looks up the [`Definition`] for that function in the semantic index and calls -/// [`infer_definition_types()`] on it, which will create a new [`TypeInferenceBuilder`] with -/// [`InferenceRegion::Definition`], and in that builder -/// [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition) will call -/// [`infer_function_definition`](TypeInferenceBuilder::infer_function_definition) to actually -/// infer a type for the definition. -/// -/// Similarly, when we encounter a standalone-inferable expression (right-hand side of an -/// assignment, type narrowing guard), we use the [`infer_expression_types()`] query to ensure we -/// don't infer its types more than once. -pub(super) struct TypeInferenceBuilder<'db> { - db: &'db dyn Db, - index: &'db SemanticIndex<'db>, - region: InferenceRegion<'db>, - - // Cached lookups - file: File, - - /// The type inference results - types: TypeInference<'db>, -} - -impl<'db> TypeInferenceBuilder<'db> { - /// How big a string do we build before bailing? - /// - /// This is a fairly arbitrary number. It should be *far* more than enough - /// for most use cases, but we can reevaluate it later if useful. - const MAX_STRING_LITERAL_SIZE: usize = 4096; - - /// Creates a new builder for inferring types in a region. - pub(super) fn new( - db: &'db dyn Db, - region: InferenceRegion<'db>, - index: &'db SemanticIndex<'db>, - ) -> Self { - let (file, scope) = match region { - InferenceRegion::Expression(expression) => (expression.file(db), expression.scope(db)), - InferenceRegion::Definition(definition) | InferenceRegion::Deferred(definition) => { - (definition.file(db), definition.scope(db)) - } - InferenceRegion::Scope(scope) => (scope.file(db), scope), - }; - - Self { - db, - index, - region, - file, - types: TypeInference::empty(scope), - } - } - - fn extend(&mut self, inference: &TypeInference<'db>) { - debug_assert_eq!(self.types.scope, inference.scope); - - self.types.bindings.extend(inference.bindings.iter()); - self.types - .declarations - .extend(inference.declarations.iter()); - self.types.expressions.extend(inference.expressions.iter()); - self.types.diagnostics.extend(&inference.diagnostics); - self.types.has_deferred |= inference.has_deferred; - } - - fn scope(&self) -> ScopeId<'db> { - self.types.scope - } - - /// Are we currently inferring types in file with deferred types? - /// This is true for stub files and files with `__future__.annotations` - fn are_all_types_deferred(&self) -> bool { - self.index.has_future_annotations() || self.file.is_stub(self.db.upcast()) - } - - /// Are we currently inferring deferred types? - fn is_deferred(&self) -> bool { - matches!(self.region, InferenceRegion::Deferred(_)) - } - - /// Get the already-inferred type of an expression node. - /// - /// PANIC if no type has been inferred for this node. - fn expression_ty(&self, expr: &ast::Expr) -> Type<'db> { - self.types - .expression_ty(expr.scoped_ast_id(self.db, self.scope())) - } - - /// Infers types in the given [`InferenceRegion`]. - fn infer_region(&mut self) { - match self.region { - InferenceRegion::Scope(scope) => self.infer_region_scope(scope), - InferenceRegion::Definition(definition) => self.infer_region_definition(definition), - InferenceRegion::Deferred(definition) => self.infer_region_deferred(definition), - InferenceRegion::Expression(expression) => self.infer_region_expression(expression), - } - } - - fn infer_region_scope(&mut self, scope: ScopeId<'db>) { - let node = scope.node(self.db); - match node { - NodeWithScopeKind::Module => { - let parsed = parsed_module(self.db.upcast(), self.file); - self.infer_module(parsed.syntax()); - } - NodeWithScopeKind::Function(function) => self.infer_function_body(function.node()), - NodeWithScopeKind::Lambda(lambda) => self.infer_lambda_body(lambda.node()), - NodeWithScopeKind::Class(class) => self.infer_class_body(class.node()), - NodeWithScopeKind::ClassTypeParameters(class) => { - self.infer_class_type_params(class.node()); - } - NodeWithScopeKind::FunctionTypeParameters(function) => { - self.infer_function_type_params(function.node()); - } - NodeWithScopeKind::ListComprehension(comprehension) => { - self.infer_list_comprehension_expression_scope(comprehension.node()); - } - NodeWithScopeKind::SetComprehension(comprehension) => { - self.infer_set_comprehension_expression_scope(comprehension.node()); - } - NodeWithScopeKind::DictComprehension(comprehension) => { - self.infer_dict_comprehension_expression_scope(comprehension.node()); - } - NodeWithScopeKind::GeneratorExpression(generator) => { - self.infer_generator_expression_scope(generator.node()); - } - } - - if self.types.has_deferred { - let mut deferred_expression_types: FxHashMap> = - FxHashMap::default(); - // invariant: only annotations and base classes are deferred, and both of these only - // occur within a declaration (annotated assignment, function or class definition) - for definition in self.types.declarations.keys() { - if infer_definition_types(self.db, *definition).has_deferred { - let deferred = infer_deferred_types(self.db, *definition); - deferred_expression_types.extend(deferred.expressions.iter()); - } - } - self.types - .expressions - .extend(deferred_expression_types.iter()); - } - } - - fn infer_region_definition(&mut self, definition: Definition<'db>) { - match definition.kind(self.db) { - DefinitionKind::Function(function) => { - self.infer_function_definition(function.node(), definition); - } - DefinitionKind::Class(class) => self.infer_class_definition(class.node(), definition), - DefinitionKind::Import(import) => { - self.infer_import_definition(import.node(), definition); - } - DefinitionKind::ImportFrom(import_from) => { - self.infer_import_from_definition( - import_from.import(), - import_from.alias(), - definition, - ); - } - DefinitionKind::Assignment(assignment) => { - self.infer_assignment_definition( - assignment.target(), - assignment.value(), - assignment.name(), - assignment.kind(), - definition, - ); - } - DefinitionKind::AnnotatedAssignment(annotated_assignment) => { - self.infer_annotated_assignment_definition(annotated_assignment.node(), definition); - } - DefinitionKind::AugmentedAssignment(augmented_assignment) => { - self.infer_augment_assignment_definition(augmented_assignment.node(), definition); - } - DefinitionKind::For(for_statement_definition) => { - self.infer_for_statement_definition( - for_statement_definition.target(), - for_statement_definition.iterable(), - for_statement_definition.is_async(), - definition, - ); - } - DefinitionKind::NamedExpression(named_expression) => { - self.infer_named_expression_definition(named_expression.node(), definition); - } - DefinitionKind::Comprehension(comprehension) => { - self.infer_comprehension_definition( - comprehension.iterable(), - comprehension.target(), - comprehension.is_first(), - comprehension.is_async(), - definition, - ); - } - DefinitionKind::Parameter(parameter) => { - self.infer_parameter_definition(parameter, definition); - } - DefinitionKind::ParameterWithDefault(parameter_with_default) => { - self.infer_parameter_with_default_definition(parameter_with_default, definition); - } - DefinitionKind::WithItem(with_item) => { - self.infer_with_item_definition(with_item.target(), with_item.node(), definition); - } - DefinitionKind::MatchPattern(match_pattern) => { - self.infer_match_pattern_definition( - match_pattern.pattern(), - match_pattern.index(), - definition, - ); - } - DefinitionKind::ExceptHandler(except_handler_definition) => { - self.infer_except_handler_definition(except_handler_definition, definition); - } - } - } - - fn infer_region_deferred(&mut self, definition: Definition<'db>) { - match definition.kind(self.db) { - DefinitionKind::Function(function) => self.infer_function_deferred(function.node()), - DefinitionKind::Class(class) => self.infer_class_deferred(class.node()), - DefinitionKind::AnnotatedAssignment(_annotated_assignment) => { - // TODO self.infer_annotated_assignment_deferred(annotated_assignment.node()); - } - _ => {} - } - } - - fn infer_region_expression(&mut self, expression: Expression<'db>) { - self.infer_expression(expression.node_ref(self.db)); - } - - fn invalid_assignment_diagnostic( - &mut self, - node: AnyNodeRef, - declared_ty: Type<'db>, - assigned_ty: Type<'db>, - ) { - match declared_ty { - Type::ClassLiteral(class) => { - self.add_diagnostic(node, "invalid-assignment", format_args!( - "Implicit shadowing of class `{}`; annotate to make it explicit if this is intentional", - class.name(self.db))); - } - Type::FunctionLiteral(function) => { - self.add_diagnostic(node, "invalid-assignment", format_args!( - "Implicit shadowing of function `{}`; annotate to make it explicit if this is intentional", - function.name(self.db))); - } - _ => { - self.add_diagnostic( - node, - "invalid-assignment", - format_args!( - "Object of type `{}` is not assignable to `{}`", - assigned_ty.display(self.db), - declared_ty.display(self.db), - ), - ); - } - } - } - - /// Raise a diagnostic if the given type cannot be divided by zero. - /// - /// Expects the resolved type of the left side of the binary expression. - fn check_division_by_zero(&mut self, expr: &ast::ExprBinOp, left: Type<'db>) { - match left { - Type::BooleanLiteral(_) | Type::IntLiteral(_) => {} - Type::Instance(cls) - if [KnownClass::Float, KnownClass::Int, KnownClass::Bool] - .iter() - .any(|&k| cls.is_known(self.db, k)) => {} - _ => return, - }; - - let (op, by_zero) = match expr.op { - ast::Operator::Div => ("divide", "by zero"), - ast::Operator::FloorDiv => ("floor divide", "by zero"), - ast::Operator::Mod => ("reduce", "modulo zero"), - _ => return, - }; - - self.add_diagnostic( - expr.into(), - "division-by-zero", - format_args!( - "Cannot {op} object of type `{}` {by_zero}", - left.display(self.db) - ), - ); - } - - fn add_binding(&mut self, node: AnyNodeRef, binding: Definition<'db>, ty: Type<'db>) { - debug_assert!(binding.is_binding(self.db)); - let use_def = self.index.use_def_map(binding.file_scope(self.db)); - let declarations = use_def.declarations_at_binding(binding); - let undeclared_ty = if declarations.may_be_undeclared() { - Some(Type::Unknown) - } else { - None - }; - let mut bound_ty = ty; - let declared_ty = declarations_ty(self.db, declarations, undeclared_ty).unwrap_or_else( - |(ty, conflicting)| { - // TODO point out the conflicting declarations in the diagnostic? - let symbol_table = self.index.symbol_table(binding.file_scope(self.db)); - let symbol_name = symbol_table.symbol(binding.symbol(self.db)).name(); - self.add_diagnostic( - node, - "conflicting-declarations", - format_args!( - "Conflicting declared types for `{symbol_name}`: {}", - conflicting.display(self.db) - ), - ); - ty - }, - ); - if !bound_ty.is_assignable_to(self.db, declared_ty) { - self.invalid_assignment_diagnostic(node, declared_ty, bound_ty); - // allow declarations to override inference in case of invalid assignment - bound_ty = declared_ty; - }; - - self.types.bindings.insert(binding, bound_ty); - } - - fn add_declaration(&mut self, node: AnyNodeRef, declaration: Definition<'db>, ty: Type<'db>) { - debug_assert!(declaration.is_declaration(self.db)); - let use_def = self.index.use_def_map(declaration.file_scope(self.db)); - let prior_bindings = use_def.bindings_at_declaration(declaration); - // unbound_ty is Never because for this check we don't care about unbound - let inferred_ty = bindings_ty(self.db, prior_bindings, Some(Type::Never)); - let ty = if inferred_ty.is_assignable_to(self.db, ty) { - ty - } else { - self.add_diagnostic( - node, - "invalid-declaration", - format_args!( - "Cannot declare type `{}` for inferred type `{}`", - ty.display(self.db), - inferred_ty.display(self.db) - ), - ); - Type::Unknown - }; - self.types.declarations.insert(declaration, ty); - } - - fn add_declaration_with_binding( - &mut self, - node: AnyNodeRef, - definition: Definition<'db>, - declared_ty: Type<'db>, - inferred_ty: Type<'db>, - ) { - debug_assert!(definition.is_binding(self.db)); - debug_assert!(definition.is_declaration(self.db)); - let inferred_ty = if inferred_ty.is_assignable_to(self.db, declared_ty) { - inferred_ty - } else { - self.invalid_assignment_diagnostic(node, declared_ty, inferred_ty); - // if the assignment is invalid, fall back to assuming the annotation is correct - declared_ty - }; - self.types.declarations.insert(definition, declared_ty); - self.types.bindings.insert(definition, inferred_ty); - } - - fn infer_module(&mut self, module: &ast::ModModule) { - self.infer_body(&module.body); - } - - fn infer_class_type_params(&mut self, class: &ast::StmtClassDef) { - let type_params = class - .type_params - .as_deref() - .expect("class type params scope without type params"); - - self.infer_type_parameters(type_params); - - if let Some(arguments) = class.arguments.as_deref() { - self.infer_arguments(arguments); - } - } - - fn infer_class_body(&mut self, class: &ast::StmtClassDef) { - self.infer_body(&class.body); - } - - fn infer_function_type_params(&mut self, function: &ast::StmtFunctionDef) { - let type_params = function - .type_params - .as_deref() - .expect("function type params scope without type params"); - - // TODO: defer annotation resolution in stubs, with __future__.annotations, or stringified - self.infer_optional_expression(function.returns.as_deref()); - self.infer_type_parameters(type_params); - self.infer_parameters(&function.parameters); - } - - fn infer_function_body(&mut self, function: &ast::StmtFunctionDef) { - self.infer_body(&function.body); - } - - fn infer_body(&mut self, suite: &[ast::Stmt]) { - for statement in suite { - self.infer_statement(statement); - } - } - - fn infer_statement(&mut self, statement: &ast::Stmt) { - match statement { - ast::Stmt::FunctionDef(function) => self.infer_function_definition_statement(function), - ast::Stmt::ClassDef(class) => self.infer_class_definition_statement(class), - ast::Stmt::Expr(ast::StmtExpr { range: _, value }) => { - self.infer_expression(value); - } - ast::Stmt::If(if_statement) => self.infer_if_statement(if_statement), - ast::Stmt::Try(try_statement) => self.infer_try_statement(try_statement), - ast::Stmt::With(with_statement) => self.infer_with_statement(with_statement), - ast::Stmt::Match(match_statement) => self.infer_match_statement(match_statement), - ast::Stmt::Assign(assign) => self.infer_assignment_statement(assign), - ast::Stmt::AnnAssign(assign) => self.infer_annotated_assignment_statement(assign), - ast::Stmt::AugAssign(aug_assign) => { - self.infer_augmented_assignment_statement(aug_assign); - } - ast::Stmt::TypeAlias(type_statement) => self.infer_type_alias_statement(type_statement), - ast::Stmt::For(for_statement) => self.infer_for_statement(for_statement), - ast::Stmt::While(while_statement) => self.infer_while_statement(while_statement), - ast::Stmt::Import(import) => self.infer_import_statement(import), - ast::Stmt::ImportFrom(import) => self.infer_import_from_statement(import), - ast::Stmt::Assert(assert_statement) => self.infer_assert_statement(assert_statement), - ast::Stmt::Raise(raise) => self.infer_raise_statement(raise), - ast::Stmt::Return(ret) => self.infer_return_statement(ret), - ast::Stmt::Delete(delete) => self.infer_delete_statement(delete), - ast::Stmt::Break(_) - | ast::Stmt::Continue(_) - | ast::Stmt::Pass(_) - | ast::Stmt::IpyEscapeCommand(_) - | ast::Stmt::Global(_) - | ast::Stmt::Nonlocal(_) => { - // No-op - } - } - } - - fn infer_definition(&mut self, node: impl Into) { - let definition = self.index.definition(node); - let result = infer_definition_types(self.db, definition); - self.extend(result); - } - - fn infer_function_definition_statement(&mut self, function: &ast::StmtFunctionDef) { - self.infer_definition(function); - } - - fn infer_function_definition( - &mut self, - function: &ast::StmtFunctionDef, - definition: Definition<'db>, - ) { - let ast::StmtFunctionDef { - range: _, - is_async: _, - name, - type_params, - parameters, - returns, - body: _, - decorator_list, - } = function; - - let decorator_tys: Box<[Type]> = decorator_list - .iter() - .map(|decorator| self.infer_decorator(decorator)) - .collect(); - - for default in parameters - .iter_non_variadic_params() - .filter_map(|param| param.default.as_deref()) - { - self.infer_expression(default); - } - - // If there are type params, parameters and returns are evaluated in that scope, that is, in - // `infer_function_type_params`, rather than here. - if type_params.is_none() { - self.infer_parameters(parameters); - - // TODO: this should also be applied to parameter annotations. - if self.are_all_types_deferred() { - self.types.has_deferred = true; - } else { - self.infer_optional_annotation_expression(returns.as_deref()); - } - } - - let function_kind = match &**name { - "reveal_type" if definition.is_typing_definition(self.db) => { - Some(KnownFunction::RevealType) - } - "isinstance" if definition.is_builtin_definition(self.db) => { - Some(KnownFunction::IsInstance) - } - _ => None, - }; - let function_ty = Type::FunctionLiteral(FunctionType::new( - self.db, - name.id.clone(), - function_kind, - definition, - decorator_tys, - )); - - self.add_declaration_with_binding(function.into(), definition, function_ty, function_ty); - } - - fn infer_parameters(&mut self, parameters: &ast::Parameters) { - let ast::Parameters { - range: _, - posonlyargs: _, - args: _, - vararg, - kwonlyargs: _, - kwarg, - } = parameters; - - for param_with_default in parameters.iter_non_variadic_params() { - self.infer_parameter_with_default(param_with_default); - } - if let Some(vararg) = vararg { - self.infer_parameter(vararg); - } - if let Some(kwarg) = kwarg { - self.infer_parameter(kwarg); - } - } - - fn infer_parameter_with_default(&mut self, parameter_with_default: &ast::ParameterWithDefault) { - let ast::ParameterWithDefault { - range: _, - parameter, - default: _, - } = parameter_with_default; - - self.infer_optional_expression(parameter.annotation.as_deref()); - } - - fn infer_parameter(&mut self, parameter: &ast::Parameter) { - let ast::Parameter { - range: _, - name: _, - annotation, - } = parameter; - - self.infer_optional_expression(annotation.as_deref()); - } - - fn infer_parameter_with_default_definition( - &mut self, - parameter_with_default: &ast::ParameterWithDefault, - definition: Definition<'db>, - ) { - // TODO(dhruvmanila): Infer types from annotation or default expression - // TODO check that default is assignable to parameter type - self.infer_parameter_definition(¶meter_with_default.parameter, definition); - } - - fn infer_parameter_definition( - &mut self, - parameter: &ast::Parameter, - definition: Definition<'db>, - ) { - // TODO(dhruvmanila): Annotation expression is resolved at the enclosing scope, infer the - // parameter type from there - let annotated_ty = Type::Todo; - if parameter.annotation.is_some() { - self.add_declaration_with_binding( - parameter.into(), - definition, - annotated_ty, - annotated_ty, - ); - } else { - self.add_binding(parameter.into(), definition, annotated_ty); - } - } - - fn infer_class_definition_statement(&mut self, class: &ast::StmtClassDef) { - self.infer_definition(class); - } - - fn infer_class_definition(&mut self, class: &ast::StmtClassDef, definition: Definition<'db>) { - let ast::StmtClassDef { - range: _, - name, - type_params, - decorator_list, - arguments: _, - body: _, - } = class; - - for decorator in decorator_list { - self.infer_decorator(decorator); - } - - let body_scope = self - .index - .node_scope(NodeWithScopeRef::Class(class)) - .to_scope_id(self.db, self.file); - - let maybe_known_class = file_to_module(self.db, body_scope.file(self.db)) - .as_ref() - .and_then(|module| KnownClass::maybe_from_module(module, name.as_str())); - - let class_ty = Type::ClassLiteral(ClassType::new( - self.db, - name.id.clone(), - definition, - body_scope, - maybe_known_class, - )); - - self.add_declaration_with_binding(class.into(), definition, class_ty, class_ty); - - // if there are type parameters, then the keywords and bases are within that scope - // and we don't need to run inference here - if type_params.is_none() { - for keyword in class.keywords() { - self.infer_expression(&keyword.value); - } - - // Inference of bases deferred in stubs - // TODO also defer stringified generic type parameters - if self.are_all_types_deferred() { - self.types.has_deferred = true; - } else { - for base in class.bases() { - self.infer_expression(base); - } - } - } - } - - fn infer_function_deferred(&mut self, function: &ast::StmtFunctionDef) { - self.infer_optional_annotation_expression(function.returns.as_deref()); - } - - fn infer_class_deferred(&mut self, class: &ast::StmtClassDef) { - if self.are_all_types_deferred() { - for base in class.bases() { - self.infer_expression(base); - } - } - } - - fn infer_if_statement(&mut self, if_statement: &ast::StmtIf) { - let ast::StmtIf { - range: _, - test, - body, - elif_else_clauses, - } = if_statement; - - self.infer_expression(test); - self.infer_body(body); - - for clause in elif_else_clauses { - let ast::ElifElseClause { - range: _, - test, - body, - } = clause; - - self.infer_optional_expression(test.as_ref()); - - self.infer_body(body); - } - } - - fn infer_try_statement(&mut self, try_statement: &ast::StmtTry) { - let ast::StmtTry { - range: _, - body, - handlers, - orelse, - finalbody, - is_star: _, - } = try_statement; - - self.infer_body(body); - - for handler in handlers { - let ast::ExceptHandler::ExceptHandler(handler) = handler; - let ast::ExceptHandlerExceptHandler { - type_: handled_exceptions, - name: symbol_name, - body, - range: _, - } = handler; - - // If `symbol_name` is `Some()` and `handled_exceptions` is `None`, - // it's invalid syntax (something like `except as e:`). - // However, it's obvious that the user *wanted* `e` to be bound here, - // so we'll have created a definition in the semantic-index stage anyway. - if symbol_name.is_some() { - self.infer_definition(handler); - } else { - self.infer_optional_expression(handled_exceptions.as_deref()); - } - - self.infer_body(body); - } - - self.infer_body(orelse); - self.infer_body(finalbody); - } - - fn infer_with_statement(&mut self, with_statement: &ast::StmtWith) { - let ast::StmtWith { - range: _, - is_async: _, - items, - body, - } = with_statement; - - for item in items { - let target = item.optional_vars.as_deref(); - if let Some(ast::Expr::Name(name)) = target { - self.infer_definition(name); - } else { - // TODO infer definitions in unpacking assignment - self.infer_expression(&item.context_expr); - self.infer_optional_expression(target); - } - } - - self.infer_body(body); - } - - fn infer_with_item_definition( - &mut self, - target: &ast::ExprName, - with_item: &ast::WithItem, - definition: Definition<'db>, - ) { - let expression = self.index.expression(&with_item.context_expr); - let result = infer_expression_types(self.db, expression); - self.extend(result); - - // TODO(dhruvmanila): The correct type inference here is the return type of the __enter__ - // method of the context manager. - let context_expr_ty = self.expression_ty(&with_item.context_expr); - - self.types - .expressions - .insert(target.scoped_ast_id(self.db, self.scope()), context_expr_ty); - self.add_binding(target.into(), definition, context_expr_ty); - } - - fn infer_except_handler_definition( - &mut self, - except_handler_definition: &ExceptHandlerDefinitionKind, - definition: Definition<'db>, - ) { - let node_ty = except_handler_definition - .handled_exceptions() - .map(|ty| self.infer_expression(ty)) - // If there is no handled exception, it's invalid syntax; - // a diagnostic will have already been emitted - .unwrap_or(Type::Unknown); - - let symbol_ty = if except_handler_definition.is_star() { - // TODO should be generic --Alex - // - // TODO should infer `ExceptionGroup` if all caught exceptions - // are subclasses of `Exception` --Alex - builtins_symbol_ty(self.db, "BaseExceptionGroup").to_instance(self.db) - } else { - // TODO: anything that's a consistent subtype of - // `type[BaseException] | tuple[type[BaseException], ...]` should be valid; - // anything else is invalid and should lead to a diagnostic being reported --Alex - match node_ty { - Type::Any | Type::Unknown => node_ty, - Type::ClassLiteral(class_ty) => Type::Instance(class_ty), - Type::Tuple(tuple) => UnionType::from_elements( - self.db, - tuple.elements(self.db).iter().map(|ty| { - ty.into_class_literal_type() - .map_or(Type::Todo, Type::Instance) - }), - ), - _ => Type::Todo, - } - }; - - self.add_binding( - except_handler_definition.node().into(), - definition, - symbol_ty, - ); - } - - fn infer_match_statement(&mut self, match_statement: &ast::StmtMatch) { - let ast::StmtMatch { - range: _, - subject, - cases, - } = match_statement; - - let expression = self.index.expression(subject.as_ref()); - let result = infer_expression_types(self.db, expression); - self.extend(result); - - for case in cases { - let ast::MatchCase { - range: _, - body, - pattern, - guard, - } = case; - self.infer_match_pattern(pattern); - self.infer_optional_expression(guard.as_deref()); - self.infer_body(body); - } - } - - fn infer_match_pattern_definition( - &mut self, - pattern: &ast::Pattern, - _index: u32, - definition: Definition<'db>, - ) { - // TODO(dhruvmanila): The correct way to infer types here is to perform structural matching - // against the subject expression type (which we can query via `infer_expression_types`) - // and extract the type at the `index` position if the pattern matches. This will be - // similar to the logic in `self.infer_assignment_definition`. - self.add_binding(pattern.into(), definition, Type::Todo); - } - - fn infer_match_pattern(&mut self, pattern: &ast::Pattern) { - // TODO(dhruvmanila): Add a Salsa query for inferring pattern types and matching against - // the subject expression: https://github.com/astral-sh/ruff/pull/13147#discussion_r1739424510 - match pattern { - ast::Pattern::MatchValue(match_value) => { - self.infer_expression(&match_value.value); - } - ast::Pattern::MatchSequence(match_sequence) => { - for pattern in &match_sequence.patterns { - self.infer_match_pattern(pattern); - } - } - ast::Pattern::MatchMapping(match_mapping) => { - let ast::PatternMatchMapping { - range: _, - keys, - patterns, - rest: _, - } = match_mapping; - for key in keys { - self.infer_expression(key); - } - for pattern in patterns { - self.infer_match_pattern(pattern); - } - } - ast::Pattern::MatchClass(match_class) => { - let ast::PatternMatchClass { - range: _, - cls, - arguments, - } = match_class; - for pattern in &arguments.patterns { - self.infer_match_pattern(pattern); - } - for keyword in &arguments.keywords { - self.infer_match_pattern(&keyword.pattern); - } - self.infer_expression(cls); - } - ast::Pattern::MatchAs(match_as) => { - if let Some(pattern) = &match_as.pattern { - self.infer_match_pattern(pattern); - } - } - ast::Pattern::MatchOr(match_or) => { - for pattern in &match_or.patterns { - self.infer_match_pattern(pattern); - } - } - ast::Pattern::MatchStar(_) | ast::Pattern::MatchSingleton(_) => {} - }; - } - - fn infer_assignment_statement(&mut self, assignment: &ast::StmtAssign) { - let ast::StmtAssign { - range: _, - targets, - value, - } = assignment; - - for target in targets { - self.infer_assignment_target(target, value); - } - } - - // TODO: Remove the `value` argument once we handle all possible assignment targets. - fn infer_assignment_target(&mut self, target: &ast::Expr, value: &ast::Expr) { - match target { - ast::Expr::Name(name) => self.infer_definition(name), - ast::Expr::List(ast::ExprList { elts, .. }) - | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => { - for element in elts { - self.infer_assignment_target(element, value); - } - } - _ => { - // TODO: Remove this once we handle all possible assignment targets. - let expression = self.index.expression(value); - self.extend(infer_expression_types(self.db, expression)); - self.infer_expression(target); - } - } - } - - fn infer_assignment_definition( - &mut self, - target: &ast::Expr, - value: &ast::Expr, - name: &ast::ExprName, - kind: AssignmentKind, - definition: Definition<'db>, - ) { - let expression = self.index.expression(value); - let result = infer_expression_types(self.db, expression); - self.extend(result); - - let value_ty = self.expression_ty(value); - - let target_ty = match kind { - AssignmentKind::Sequence => self.infer_sequence_unpacking(target, value_ty, name), - AssignmentKind::Name => value_ty, - }; - - self.add_binding(name.into(), definition, target_ty); - self.types - .expressions - .insert(name.scoped_ast_id(self.db, self.scope()), target_ty); - } - - fn infer_sequence_unpacking( - &mut self, - target: &ast::Expr, - value_ty: Type<'db>, - name: &ast::ExprName, - ) -> Type<'db> { - // The inner function is recursive and only differs in the return type which is an `Option` - // where if the variable is found, the corresponding type is returned otherwise `None`. - fn inner<'db>( - builder: &mut TypeInferenceBuilder<'db>, - target: &ast::Expr, - value_ty: Type<'db>, - name: &ast::ExprName, - ) -> Option> { - match target { - ast::Expr::Name(target_name) if target_name == name => { - return Some(value_ty); - } - ast::Expr::Starred(ast::ExprStarred { value, .. }) => { - return inner(builder, value, value_ty, name); - } - ast::Expr::List(ast::ExprList { elts, .. }) - | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => match value_ty { - Type::Tuple(tuple_ty) => { - let starred_index = elts.iter().position(ast::Expr::is_starred_expr); - - let element_types = if let Some(starred_index) = starred_index { - if tuple_ty.len(builder.db) >= elts.len() - 1 { - let mut element_types = Vec::with_capacity(elts.len()); - element_types.extend_from_slice( - // SAFETY: Safe because of the length check above. - &tuple_ty.elements(builder.db)[..starred_index], - ); - - // E.g., in `(a, *b, c, d) = ...`, the index of starred element `b` - // is 1 and the remaining elements after that are 2. - let remaining = elts.len() - (starred_index + 1); - // This index represents the type of the last element that belongs - // to the starred expression, in an exclusive manner. - let starred_end_index = tuple_ty.len(builder.db) - remaining; - // SAFETY: Safe because of the length check above. - let _starred_element_types = &tuple_ty.elements(builder.db) - [starred_index..starred_end_index]; - // TODO: Combine the types into a list type. If the - // starred_element_types is empty, then it should be `List[Any]`. - // combine_types(starred_element_types); - element_types.push(Type::Todo); - - element_types.extend_from_slice( - // SAFETY: Safe because of the length check above. - &tuple_ty.elements(builder.db)[starred_end_index..], - ); - Cow::Owned(element_types) - } else { - let mut element_types = tuple_ty.elements(builder.db).to_vec(); - element_types.insert(starred_index, Type::Todo); - Cow::Owned(element_types) - } - } else { - Cow::Borrowed(tuple_ty.elements(builder.db).as_ref()) - }; - - for (index, element) in elts.iter().enumerate() { - if let Some(ty) = inner( - builder, - element, - element_types.get(index).copied().unwrap_or(Type::Unknown), - name, - ) { - return Some(ty); - } - } - } - Type::StringLiteral(string_literal_ty) => { - // Deconstruct the string literal to delegate the inference back to the - // tuple type for correct handling of starred expressions. We could go - // further and deconstruct to an array of `StringLiteral` with each - // individual character, instead of just an array of `LiteralString`, but - // there would be a cost and it's not clear that it's worth it. - let value_ty = Type::Tuple(TupleType::new( - builder.db, - vec![Type::LiteralString; string_literal_ty.len(builder.db)] - .into_boxed_slice(), - )); - if let Some(ty) = inner(builder, target, value_ty, name) { - return Some(ty); - } - } - _ => { - let value_ty = if value_ty.is_literal_string() { - Type::LiteralString - } else { - value_ty - .iterate(builder.db) - .unwrap_with_diagnostic(AnyNodeRef::from(target), builder) - }; - for element in elts { - if let Some(ty) = inner(builder, element, value_ty, name) { - return Some(ty); - } - } - } - }, - _ => {} - } - None - } - - inner(self, target, value_ty, name).unwrap_or(Type::Unknown) - } - - fn infer_annotated_assignment_statement(&mut self, assignment: &ast::StmtAnnAssign) { - // assignments to non-Names are not Definitions - if matches!(*assignment.target, ast::Expr::Name(_)) { - self.infer_definition(assignment); - } else { - let ast::StmtAnnAssign { - range: _, - annotation, - value, - target, - simple: _, - } = assignment; - self.infer_annotation_expression(annotation); - self.infer_optional_expression(value.as_deref()); - self.infer_expression(target); - } - } - - fn infer_annotated_assignment_definition( - &mut self, - assignment: &ast::StmtAnnAssign, - definition: Definition<'db>, - ) { - let ast::StmtAnnAssign { - range: _, - target, - annotation, - value, - simple: _, - } = assignment; - - let annotation_ty = self.infer_annotation_expression(annotation); - if let Some(value) = value { - let value_ty = self.infer_expression(value); - self.add_declaration_with_binding( - assignment.into(), - definition, - annotation_ty, - value_ty, - ); - } else { - self.add_declaration(assignment.into(), definition, annotation_ty); - } - - self.infer_expression(target); - } - - fn infer_augmented_assignment_statement(&mut self, assignment: &ast::StmtAugAssign) { - if assignment.target.is_name_expr() { - self.infer_definition(assignment); - } else { - // TODO currently we don't consider assignments to non-Names to be Definitions - self.infer_augment_assignment(assignment); - } - } - - fn infer_augment_assignment_definition( - &mut self, - assignment: &ast::StmtAugAssign, - definition: Definition<'db>, - ) { - let target_ty = self.infer_augment_assignment(assignment); - self.add_binding(assignment.into(), definition, target_ty); - } - - fn infer_augment_assignment(&mut self, assignment: &ast::StmtAugAssign) -> Type<'db> { - let ast::StmtAugAssign { - range: _, - target, - op: _, - value, - } = assignment; - self.infer_expression(value); - self.infer_expression(target); - - // TODO(dhruvmanila): Resolve the target type using the value type and the operator - Type::Todo - } - - fn infer_type_alias_statement(&mut self, type_alias_statement: &ast::StmtTypeAlias) { - let ast::StmtTypeAlias { - range: _, - name, - type_params, - value, - } = type_alias_statement; - self.infer_expression(value); - self.infer_expression(name); - if let Some(type_params) = type_params { - self.infer_type_parameters(type_params); - } - } - - fn infer_for_statement(&mut self, for_statement: &ast::StmtFor) { - let ast::StmtFor { - range: _, - target, - iter, - body, - orelse, - is_async: _, - } = for_statement; - - self.infer_expression(iter); - // TODO more complex assignment targets - if let ast::Expr::Name(name) = &**target { - self.infer_definition(name); - } else { - self.infer_expression(target); - } - self.infer_body(body); - self.infer_body(orelse); - } - - /// Emit a diagnostic declaring that the object represented by `node` is not iterable - pub(super) fn not_iterable_diagnostic(&mut self, node: AnyNodeRef, not_iterable_ty: Type<'db>) { - self.add_diagnostic( - node, - "not-iterable", - format_args!( - "Object of type `{}` is not iterable", - not_iterable_ty.display(self.db) - ), - ); - } - - /// Emit a diagnostic declaring that an index is out of bounds for a tuple. - pub(super) fn index_out_of_bounds_diagnostic( - &mut self, - kind: &'static str, - node: AnyNodeRef, - tuple_ty: Type<'db>, - length: usize, - index: i64, - ) { - self.add_diagnostic( - node, - "index-out-of-bounds", - format_args!( - "Index {index} is out of bounds for {kind} `{}` with length {length}", - tuple_ty.display(self.db) - ), - ); - } - - /// Emit a diagnostic declaring that a type does not support subscripting. - pub(super) fn non_subscriptable_diagnostic( - &mut self, - node: AnyNodeRef, - non_subscriptable_ty: Type<'db>, - method: &str, - ) { - self.add_diagnostic( - node, - "non-subscriptable", - format_args!( - "Cannot subscript object of type `{}` with no `{method}` method", - non_subscriptable_ty.display(self.db) - ), - ); - } - - fn infer_for_statement_definition( - &mut self, - target: &ast::ExprName, - iterable: &ast::Expr, - is_async: bool, - definition: Definition<'db>, - ) { - let expression = self.index.expression(iterable); - let result = infer_expression_types(self.db, expression); - self.extend(result); - let iterable_ty = self.expression_ty(iterable); - - let loop_var_value_ty = if is_async { - // TODO(Alex): async iterables/iterators! - Type::Todo - } else { - iterable_ty - .iterate(self.db) - .unwrap_with_diagnostic(iterable.into(), self) - }; - - self.types.expressions.insert( - target.scoped_ast_id(self.db, self.scope()), - loop_var_value_ty, - ); - self.add_binding(target.into(), definition, loop_var_value_ty); - } - - fn infer_while_statement(&mut self, while_statement: &ast::StmtWhile) { - let ast::StmtWhile { - range: _, - test, - body, - orelse, - } = while_statement; - - self.infer_expression(test); - self.infer_body(body); - self.infer_body(orelse); - } - - fn infer_import_statement(&mut self, import: &ast::StmtImport) { - let ast::StmtImport { range: _, names } = import; - - for alias in names { - self.infer_definition(alias); - } - } - - fn infer_import_definition(&mut self, alias: &'db ast::Alias, definition: Definition<'db>) { - let ast::Alias { - range: _, - name, - asname: _, - } = alias; - - let module_ty = if let Some(module_name) = ModuleName::new(name) { - if let Some(module) = self.module_ty_from_name(&module_name) { - module - } else { - self.unresolved_module_diagnostic(alias, 0, Some(name)); - Type::Unknown - } - } else { - tracing::debug!("Failed to resolve import due to invalid syntax"); - Type::Unknown - }; - - self.add_declaration_with_binding(alias.into(), definition, module_ty, module_ty); - } - - fn infer_import_from_statement(&mut self, import: &ast::StmtImportFrom) { - let ast::StmtImportFrom { - range: _, - module: _, - names, - level: _, - } = import; - - for alias in names { - self.infer_definition(alias); - } - } - - fn infer_assert_statement(&mut self, assert: &ast::StmtAssert) { - let ast::StmtAssert { - range: _, - test, - msg, - } = assert; - - self.infer_expression(test); - self.infer_optional_expression(msg.as_deref()); - } - - fn infer_raise_statement(&mut self, raise: &ast::StmtRaise) { - let ast::StmtRaise { - range: _, - exc, - cause, - } = raise; - self.infer_optional_expression(exc.as_deref()); - self.infer_optional_expression(cause.as_deref()); - } - - fn unresolved_module_diagnostic( - &mut self, - import_node: impl Into>, - level: u32, - module: Option<&str>, - ) { - self.add_diagnostic( - import_node.into(), - "unresolved-import", - format_args!( - "Cannot resolve import `{}{}`", - ".".repeat(level as usize), - module.unwrap_or_default() - ), - ); - } - - /// Given a `from .foo import bar` relative import, resolve the relative module - /// we're importing `bar` from into an absolute [`ModuleName`] - /// using the name of the module we're currently analyzing. - /// - /// - `level` is the number of dots at the beginning of the relative module name: - /// - `from .foo.bar import baz` => `level == 1` - /// - `from ...foo.bar import baz` => `level == 3` - /// - `tail` is the relative module name stripped of all leading dots: - /// - `from .foo import bar` => `tail == "foo"` - /// - `from ..foo.bar import baz` => `tail == "foo.bar"` - fn relative_module_name( - &self, - tail: Option<&str>, - level: NonZeroU32, - ) -> Result { - let module = file_to_module(self.db, self.file) - .ok_or(ModuleNameResolutionError::UnknownCurrentModule)?; - let mut level = level.get(); - if module.kind().is_package() { - level -= 1; - } - let mut module_name = module.name().clone(); - for _ in 0..level { - module_name = module_name - .parent() - .ok_or(ModuleNameResolutionError::TooManyDots)?; - } - if let Some(tail) = tail { - let tail = ModuleName::new(tail).ok_or(ModuleNameResolutionError::InvalidSyntax)?; - module_name.extend(&tail); - } - Ok(module_name) - } - - fn infer_import_from_definition( - &mut self, - import_from: &'db ast::StmtImportFrom, - alias: &ast::Alias, - definition: Definition<'db>, - ) { - // TODO: - // - Absolute `*` imports (`from collections import *`) - // - Relative `*` imports (`from ...foo import *`) - // - Submodule imports (`from collections import abc`, - // where `abc` is a submodule of the `collections` package) - // - // For the last item, see the currently skipped tests - // `follow_relative_import_bare_to_module()` and - // `follow_nonexistent_import_bare_to_module()`. - let ast::StmtImportFrom { module, level, .. } = import_from; - let module = module.as_deref(); - - let module_name = if let Some(level) = NonZeroU32::new(*level) { - tracing::trace!( - "Resolving imported object `{}` from module `{}` relative to file `{}`", - alias.name, - format_import_from_module(level.get(), module), - self.file.path(self.db), - ); - self.relative_module_name(module, level) - } else { - tracing::trace!( - "Resolving imported object `{}` from module `{}`", - alias.name, - format_import_from_module(*level, module), - ); - module - .and_then(ModuleName::new) - .ok_or(ModuleNameResolutionError::InvalidSyntax) - }; - - let ty = match module_name { - Ok(module_name) => { - if let Some(module_ty) = self.module_ty_from_name(&module_name) { - let ast::Alias { - range: _, - name, - asname: _, - } = alias; - - let member_ty = module_ty.member(self.db, &ast::name::Name::new(&name.id)); - - if member_ty.is_unbound() { - self.add_diagnostic( - AnyNodeRef::Alias(alias), - "unresolved-import", - format_args!("Module `{module_name}` has no member `{name}`",), - ); - - Type::Unknown - } else { - // For possibly-unbound names, just eliminate Unbound from the type; we - // must be in a bound path. TODO diagnostic for maybe-unbound import? - member_ty.replace_unbound_with(self.db, Type::Never) - } - } else { - self.unresolved_module_diagnostic(import_from, *level, module); - Type::Unknown - } - } - Err(ModuleNameResolutionError::InvalidSyntax) => { - tracing::debug!("Failed to resolve import due to invalid syntax"); - // Invalid syntax diagnostics are emitted elsewhere. - Type::Unknown - } - Err(ModuleNameResolutionError::TooManyDots) => { - tracing::debug!( - "Relative module resolution `{}` failed: too many leading dots", - format_import_from_module(*level, module), - ); - self.unresolved_module_diagnostic(import_from, *level, module); - Type::Unknown - } - Err(ModuleNameResolutionError::UnknownCurrentModule) => { - tracing::debug!( - "Relative module resolution `{}` failed; could not resolve file `{}` to a module", - format_import_from_module(*level, module), - self.file.path(self.db) - ); - self.unresolved_module_diagnostic(import_from, *level, module); - Type::Unknown - } - }; - - self.add_declaration_with_binding(alias.into(), definition, ty, ty); - } - - fn infer_return_statement(&mut self, ret: &ast::StmtReturn) { - self.infer_optional_expression(ret.value.as_deref()); - } - - fn infer_delete_statement(&mut self, delete: &ast::StmtDelete) { - let ast::StmtDelete { range: _, targets } = delete; - for target in targets { - self.infer_expression(target); - } - } - - fn module_ty_from_name(&self, module_name: &ModuleName) -> Option> { - resolve_module(self.db, module_name).map(|module| Type::ModuleLiteral(module.file())) - } - - fn infer_decorator(&mut self, decorator: &ast::Decorator) -> Type<'db> { - let ast::Decorator { - range: _, - expression, - } = decorator; - - self.infer_expression(expression) - } - - fn infer_arguments(&mut self, arguments: &ast::Arguments) -> Vec> { - let mut types = Vec::with_capacity( - arguments - .args - .len() - .saturating_add(arguments.keywords.len()), - ); - - types.extend(arguments.args.iter().map(|arg| self.infer_expression(arg))); - - types.extend(arguments.keywords.iter().map( - |ast::Keyword { - range: _, - arg: _, - value, - }| self.infer_expression(value), - )); - - types - } - - fn infer_optional_expression(&mut self, expression: Option<&ast::Expr>) -> Option> { - expression.map(|expr| self.infer_expression(expr)) - } - - fn infer_optional_annotation_expression( - &mut self, - expr: Option<&ast::Expr>, - ) -> Option> { - expr.map(|expr| self.infer_annotation_expression(expr)) - } - - fn infer_expression(&mut self, expression: &ast::Expr) -> Type<'db> { - let ty = match expression { - ast::Expr::NoneLiteral(ast::ExprNoneLiteral { range: _ }) => Type::None, - ast::Expr::NumberLiteral(literal) => self.infer_number_literal_expression(literal), - ast::Expr::BooleanLiteral(literal) => self.infer_boolean_literal_expression(literal), - ast::Expr::StringLiteral(literal) => self.infer_string_literal_expression(literal), - ast::Expr::BytesLiteral(bytes_literal) => { - self.infer_bytes_literal_expression(bytes_literal) - } - ast::Expr::FString(fstring) => self.infer_fstring_expression(fstring), - ast::Expr::EllipsisLiteral(literal) => self.infer_ellipsis_literal_expression(literal), - ast::Expr::Tuple(tuple) => self.infer_tuple_expression(tuple), - ast::Expr::List(list) => self.infer_list_expression(list), - ast::Expr::Set(set) => self.infer_set_expression(set), - ast::Expr::Dict(dict) => self.infer_dict_expression(dict), - ast::Expr::Generator(generator) => self.infer_generator_expression(generator), - ast::Expr::ListComp(listcomp) => self.infer_list_comprehension_expression(listcomp), - ast::Expr::DictComp(dictcomp) => self.infer_dict_comprehension_expression(dictcomp), - ast::Expr::SetComp(setcomp) => self.infer_set_comprehension_expression(setcomp), - ast::Expr::Name(name) => self.infer_name_expression(name), - ast::Expr::Attribute(attribute) => self.infer_attribute_expression(attribute), - ast::Expr::UnaryOp(unary_op) => self.infer_unary_expression(unary_op), - ast::Expr::BinOp(binary) => self.infer_binary_expression(binary), - ast::Expr::BoolOp(bool_op) => self.infer_boolean_expression(bool_op), - ast::Expr::Compare(compare) => self.infer_compare_expression(compare), - ast::Expr::Subscript(subscript) => self.infer_subscript_expression(subscript), - ast::Expr::Slice(slice) => self.infer_slice_expression(slice), - ast::Expr::Named(named) => self.infer_named_expression(named), - ast::Expr::If(if_expression) => self.infer_if_expression(if_expression), - ast::Expr::Lambda(lambda_expression) => self.infer_lambda_expression(lambda_expression), - ast::Expr::Call(call_expression) => self.infer_call_expression(call_expression), - ast::Expr::Starred(starred) => self.infer_starred_expression(starred), - ast::Expr::Yield(yield_expression) => self.infer_yield_expression(yield_expression), - ast::Expr::YieldFrom(yield_from) => self.infer_yield_from_expression(yield_from), - ast::Expr::Await(await_expression) => self.infer_await_expression(await_expression), - ast::Expr::IpyEscapeCommand(_) => todo!("Implement Ipy escape command support"), - }; - - let expr_id = expression.scoped_ast_id(self.db, self.scope()); - let previous = self.types.expressions.insert(expr_id, ty); - assert_eq!(previous, None); - - ty - } - - fn infer_number_literal_expression(&mut self, literal: &ast::ExprNumberLiteral) -> Type<'db> { - let ast::ExprNumberLiteral { range: _, value } = literal; - - match value { - ast::Number::Int(n) => n - .as_i64() - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ast::Number::Float(_) => KnownClass::Float.to_instance(self.db), - ast::Number::Complex { .. } => { - builtins_symbol_ty(self.db, "complex").to_instance(self.db) - } - } - } - - #[allow(clippy::unused_self)] - fn infer_boolean_literal_expression(&mut self, literal: &ast::ExprBooleanLiteral) -> Type<'db> { - let ast::ExprBooleanLiteral { range: _, value } = literal; - - Type::BooleanLiteral(*value) - } - - fn infer_string_literal_expression(&mut self, literal: &ast::ExprStringLiteral) -> Type<'db> { - if literal.value.len() <= Self::MAX_STRING_LITERAL_SIZE { - Type::StringLiteral(StringLiteralType::new(self.db, literal.value.to_str())) - } else { - Type::LiteralString - } - } - - fn infer_bytes_literal_expression(&mut self, literal: &ast::ExprBytesLiteral) -> Type<'db> { - // TODO: ignoring r/R prefixes for now, should normalize bytes values - Type::BytesLiteral(BytesLiteralType::new( - self.db, - literal.value.bytes().collect::>(), - )) - } - - fn infer_fstring_expression(&mut self, fstring: &ast::ExprFString) -> Type<'db> { - let ast::ExprFString { range: _, value } = fstring; - - let mut collector = StringPartsCollector::new(); - for part in value { - // Make sure we iter through every parts to infer all sub-expressions. The `collector` - // struct ensures we don't allocate unnecessary strings. - match part { - ast::FStringPart::Literal(literal) => { - collector.push_str(&literal.value); - } - ast::FStringPart::FString(fstring) => { - for element in &fstring.elements { - match element { - ast::FStringElement::Expression(expression) => { - let ast::FStringExpressionElement { - range: _, - expression, - debug_text: _, - conversion, - format_spec, - } = expression; - let ty = self.infer_expression(expression); - - // TODO: handle format specifiers by calling a method - // (`Type::format`?) that handles the `__format__` method. - // Conversion flags should be handled before calling `__format__`. - // https://docs.python.org/3/library/string.html#format-string-syntax - if !conversion.is_none() || format_spec.is_some() { - collector.add_expression(); - } else { - if let Type::StringLiteral(literal) = ty.str(self.db) { - collector.push_str(literal.value(self.db)); - } else { - collector.add_expression(); - } - } - } - ast::FStringElement::Literal(literal) => { - collector.push_str(&literal.value); - } - } - } - } - } - } - collector.ty(self.db) - } - - fn infer_ellipsis_literal_expression( - &mut self, - _literal: &ast::ExprEllipsisLiteral, - ) -> Type<'db> { - builtins_symbol_ty(self.db, "Ellipsis") - } - - fn infer_tuple_expression(&mut self, tuple: &ast::ExprTuple) -> Type<'db> { - let ast::ExprTuple { - range: _, - elts, - ctx: _, - parenthesized: _, - } = tuple; - - let element_types = elts - .iter() - .map(|elt| self.infer_expression(elt)) - .collect::>(); - - Type::Tuple(TupleType::new(self.db, element_types.into_boxed_slice())) - } - - fn infer_list_expression(&mut self, list: &ast::ExprList) -> Type<'db> { - let ast::ExprList { - range: _, - elts, - ctx: _, - } = list; - - for elt in elts { - self.infer_expression(elt); - } - - // TODO generic - KnownClass::List.to_instance(self.db) - } - - fn infer_set_expression(&mut self, set: &ast::ExprSet) -> Type<'db> { - let ast::ExprSet { range: _, elts } = set; - - for elt in elts { - self.infer_expression(elt); - } - - // TODO generic - KnownClass::Set.to_instance(self.db) - } - - fn infer_dict_expression(&mut self, dict: &ast::ExprDict) -> Type<'db> { - let ast::ExprDict { range: _, items } = dict; - - for item in items { - self.infer_optional_expression(item.key.as_ref()); - self.infer_expression(&item.value); - } - - // TODO generic - KnownClass::Dict.to_instance(self.db) - } - - /// Infer the type of the `iter` expression of the first comprehension. - fn infer_first_comprehension_iter(&mut self, comprehensions: &[ast::Comprehension]) { - let mut comprehensions_iter = comprehensions.iter(); - let Some(first_comprehension) = comprehensions_iter.next() else { - unreachable!("Comprehension must contain at least one generator"); - }; - self.infer_expression(&first_comprehension.iter); - } - - fn infer_generator_expression(&mut self, generator: &ast::ExprGenerator) -> Type<'db> { - let ast::ExprGenerator { - range: _, - elt: _, - generators, - parenthesized: _, - } = generator; - - self.infer_first_comprehension_iter(generators); - - // TODO generator type - Type::Todo - } - - fn infer_list_comprehension_expression(&mut self, listcomp: &ast::ExprListComp) -> Type<'db> { - let ast::ExprListComp { - range: _, - elt: _, - generators, - } = listcomp; - - self.infer_first_comprehension_iter(generators); - - // TODO list type - Type::Todo - } - - fn infer_dict_comprehension_expression(&mut self, dictcomp: &ast::ExprDictComp) -> Type<'db> { - let ast::ExprDictComp { - range: _, - key: _, - value: _, - generators, - } = dictcomp; - - self.infer_first_comprehension_iter(generators); - - // TODO dict type - Type::Todo - } - - fn infer_set_comprehension_expression(&mut self, setcomp: &ast::ExprSetComp) -> Type<'db> { - let ast::ExprSetComp { - range: _, - elt: _, - generators, - } = setcomp; - - self.infer_first_comprehension_iter(generators); - - // TODO set type - Type::Todo - } - - fn infer_generator_expression_scope(&mut self, generator: &ast::ExprGenerator) { - let ast::ExprGenerator { - range: _, - elt, - generators, - parenthesized: _, - } = generator; - - self.infer_expression(elt); - self.infer_comprehensions(generators); - } - - fn infer_list_comprehension_expression_scope(&mut self, listcomp: &ast::ExprListComp) { - let ast::ExprListComp { - range: _, - elt, - generators, - } = listcomp; - - self.infer_expression(elt); - self.infer_comprehensions(generators); - } - - fn infer_dict_comprehension_expression_scope(&mut self, dictcomp: &ast::ExprDictComp) { - let ast::ExprDictComp { - range: _, - key, - value, - generators, - } = dictcomp; - - self.infer_expression(key); - self.infer_expression(value); - self.infer_comprehensions(generators); - } - - fn infer_set_comprehension_expression_scope(&mut self, setcomp: &ast::ExprSetComp) { - let ast::ExprSetComp { - range: _, - elt, - generators, - } = setcomp; - - self.infer_expression(elt); - self.infer_comprehensions(generators); - } - - fn infer_comprehensions(&mut self, comprehensions: &[ast::Comprehension]) { - let mut comprehensions_iter = comprehensions.iter(); - let Some(first_comprehension) = comprehensions_iter.next() else { - unreachable!("Comprehension must contain at least one generator"); - }; - self.infer_comprehension(first_comprehension, true); - for comprehension in comprehensions_iter { - self.infer_comprehension(comprehension, false); - } - } - - fn infer_comprehension(&mut self, comprehension: &ast::Comprehension, is_first: bool) { - let ast::Comprehension { - range: _, - target, - iter, - ifs, - is_async: _, - } = comprehension; - - if !is_first { - self.infer_expression(iter); - } - // TODO more complex assignment targets - if let ast::Expr::Name(name) = target { - self.infer_definition(name); - } else { - self.infer_expression(target); - } - for expr in ifs { - self.infer_expression(expr); - } - } - - fn infer_comprehension_definition( - &mut self, - iterable: &ast::Expr, - target: &ast::ExprName, - is_first: bool, - is_async: bool, - definition: Definition<'db>, - ) { - let expression = self.index.expression(iterable); - let result = infer_expression_types(self.db, expression); - - // Two things are different if it's the first comprehension: - // (1) We must lookup the `ScopedExpressionId` of the iterable expression in the outer scope, - // because that's the scope we visit it in in the semantic index builder - // (2) We must *not* call `self.extend()` on the result of the type inference, - // because `ScopedExpressionId`s are only meaningful within their own scope, so - // we'd add types for random wrong expressions in the current scope - let iterable_ty = if is_first { - let lookup_scope = self - .index - .parent_scope_id(self.scope().file_scope_id(self.db)) - .expect("A comprehension should never be the top-level scope") - .to_scope_id(self.db, self.file); - result.expression_ty(iterable.scoped_ast_id(self.db, lookup_scope)) - } else { - self.extend(result); - result.expression_ty(iterable.scoped_ast_id(self.db, self.scope())) - }; - - let target_ty = if is_async { - // TODO: async iterables/iterators! -- Alex - Type::Todo - } else { - iterable_ty - .iterate(self.db) - .unwrap_with_diagnostic(iterable.into(), self) - }; - - self.types - .expressions - .insert(target.scoped_ast_id(self.db, self.scope()), target_ty); - self.add_binding(target.into(), definition, target_ty); - } - - fn infer_named_expression(&mut self, named: &ast::ExprNamed) -> Type<'db> { - let definition = self.index.definition(named); - let result = infer_definition_types(self.db, definition); - self.extend(result); - result.binding_ty(definition) - } - - fn infer_named_expression_definition( - &mut self, - named: &ast::ExprNamed, - definition: Definition<'db>, - ) -> Type<'db> { - let ast::ExprNamed { - range: _, - target, - value, - } = named; - - let value_ty = self.infer_expression(value); - self.infer_expression(target); - - self.add_binding(named.into(), definition, value_ty); - - value_ty - } - - fn infer_if_expression(&mut self, if_expression: &ast::ExprIf) -> Type<'db> { - let ast::ExprIf { - range: _, - test, - body, - orelse, - } = if_expression; - - self.infer_expression(test); - - // TODO detect statically known truthy or falsy test - let body_ty = self.infer_expression(body); - let orelse_ty = self.infer_expression(orelse); - - UnionType::from_elements(self.db, [body_ty, orelse_ty]) - } - - fn infer_lambda_body(&mut self, lambda_expression: &ast::ExprLambda) { - self.infer_expression(&lambda_expression.body); - } - - fn infer_lambda_expression(&mut self, lambda_expression: &ast::ExprLambda) -> Type<'db> { - let ast::ExprLambda { - range: _, - parameters, - body: _, - } = lambda_expression; - - if let Some(parameters) = parameters { - for default in parameters - .iter_non_variadic_params() - .filter_map(|param| param.default.as_deref()) - { - self.infer_expression(default); - } - - self.infer_parameters(parameters); - } - - // TODO function type - Type::Todo - } - - fn infer_call_expression(&mut self, call_expression: &ast::ExprCall) -> Type<'db> { - let ast::ExprCall { - range: _, - func, - arguments, - } = call_expression; - - // TODO: proper typed call signature, representing keyword args etc - let arg_types = self.infer_arguments(arguments); - let function_type = self.infer_expression(func); - function_type - .call(self.db, arg_types.as_slice()) - .unwrap_with_diagnostic(self.db, func.as_ref().into(), self) - } - - fn infer_starred_expression(&mut self, starred: &ast::ExprStarred) -> Type<'db> { - let ast::ExprStarred { - range: _, - value, - ctx: _, - } = starred; - - let iterable_ty = self.infer_expression(value); - iterable_ty - .iterate(self.db) - .unwrap_with_diagnostic(value.as_ref().into(), self); - - // TODO - Type::Todo - } - - fn infer_yield_expression(&mut self, yield_expression: &ast::ExprYield) -> Type<'db> { - let ast::ExprYield { range: _, value } = yield_expression; - - self.infer_optional_expression(value.as_deref()); - - // TODO awaitable type - Type::Todo - } - - fn infer_yield_from_expression(&mut self, yield_from: &ast::ExprYieldFrom) -> Type<'db> { - let ast::ExprYieldFrom { range: _, value } = yield_from; - - let iterable_ty = self.infer_expression(value); - iterable_ty - .iterate(self.db) - .unwrap_with_diagnostic(value.as_ref().into(), self); - - // TODO get type from `ReturnType` of generator - Type::Todo - } - - fn infer_await_expression(&mut self, await_expression: &ast::ExprAwait) -> Type<'db> { - let ast::ExprAwait { range: _, value } = await_expression; - - self.infer_expression(value); - - // TODO awaitable type - Type::Todo - } - - /// Look up a name reference that isn't bound in the local scope. - fn lookup_name(&mut self, name_node: &ast::ExprName) -> Type<'db> { - let ast::ExprName { id: name, .. } = name_node; - let file_scope_id = self.scope().file_scope_id(self.db); - let is_bound = self - .index - .symbol_table(file_scope_id) - .symbol_by_name(name) - .expect("Symbol table should create a symbol for every Name node") - .is_bound(); - - // In function-like scopes, any local variable (symbol that is bound in this scope) can - // only have a definition in this scope, or error; it never references another scope. - // (At runtime, it would use the `LOAD_FAST` opcode.) - if !is_bound || !self.scope().is_function_like(self.db) { - // Walk up parent scopes looking for a possible enclosing scope that may have a - // definition of this name visible to us (would be `LOAD_DEREF` at runtime.) - for (enclosing_scope_file_id, _) in self.index.ancestor_scopes(file_scope_id) { - // Class scopes are not visible to nested scopes, and we need to handle global - // scope differently (because an unbound name there falls back to builtins), so - // check only function-like scopes. - let enclosing_scope_id = enclosing_scope_file_id.to_scope_id(self.db, self.file); - if !enclosing_scope_id.is_function_like(self.db) { - continue; - } - let enclosing_symbol_table = self.index.symbol_table(enclosing_scope_file_id); - let Some(enclosing_symbol) = enclosing_symbol_table.symbol_by_name(name) else { - continue; - }; - if enclosing_symbol.is_bound() { - // We can return early here, because the nearest function-like scope that - // defines a name must be the only source for the nonlocal reference (at - // runtime, it is the scope that creates the cell for our closure.) If the name - // isn't bound in that scope, we should get an unbound name, not continue - // falling back to other scopes / globals / builtins. - return symbol_ty(self.db, enclosing_scope_id, name); - } - } - - // No nonlocal binding, check module globals. Avoid infinite recursion if `self.scope` - // already is module globals. - let ty = if file_scope_id.is_global() { - Type::Unbound - } else { - global_symbol_ty(self.db, self.file, name) - }; - - // Fallback to builtins (without infinite recursion if we're already in builtins.) - if ty.may_be_unbound(self.db) && Some(self.scope()) != builtins_module_scope(self.db) { - let mut builtin_ty = builtins_symbol_ty(self.db, name); - if builtin_ty.is_unbound() && name == "reveal_type" { - self.add_diagnostic( - name_node.into(), - "undefined-reveal", - format_args!( - "`reveal_type` used without importing it; this is allowed for debugging convenience but will fail at runtime"), - ); - builtin_ty = typing_extensions_symbol_ty(self.db, name); - } - ty.replace_unbound_with(self.db, builtin_ty) - } else { - ty - } - } else { - Type::Unbound - } - } - - fn infer_name_expression(&mut self, name: &ast::ExprName) -> Type<'db> { - let ast::ExprName { range: _, id, ctx } = name; - let file_scope_id = self.scope().file_scope_id(self.db); - - match ctx { - ExprContext::Load => { - let use_def = self.index.use_def_map(file_scope_id); - let symbol = self - .index - .symbol_table(file_scope_id) - .symbol_id_by_name(id) - .expect("Expected the symbol table to create a symbol for every Name node"); - // if we're inferring types of deferred expressions, always treat them as public symbols - let (definitions, may_be_unbound) = if self.is_deferred() { - ( - use_def.public_bindings(symbol), - use_def.public_may_be_unbound(symbol), - ) - } else { - let use_id = name.scoped_use_id(self.db, self.scope()); - ( - use_def.bindings_at_use(use_id), - use_def.use_may_be_unbound(use_id), - ) - }; - - let unbound_ty = if may_be_unbound { - Some(self.lookup_name(name)) - } else { - None - }; - let ty = bindings_ty(self.db, definitions, unbound_ty); - - if ty.is_unbound() { - self.add_diagnostic( - name.into(), - "unresolved-reference", - format_args!("Name `{id}` used when not defined"), - ); - } else if ty.may_be_unbound(self.db) { - self.add_diagnostic( - name.into(), - "possibly-unresolved-reference", - format_args!("Name `{id}` used when possibly not defined"), - ); - } - - ty - } - ExprContext::Store | ExprContext::Del => Type::None, - ExprContext::Invalid => Type::Unknown, - } - } - - fn infer_attribute_expression(&mut self, attribute: &ast::ExprAttribute) -> Type<'db> { - let ast::ExprAttribute { - value, - attr, - range: _, - ctx, - } = attribute; - - let value_ty = self.infer_expression(value); - let member_ty = value_ty.member(self.db, &ast::name::Name::new(&attr.id)); - - match ctx { - ExprContext::Load => member_ty, - ExprContext::Store | ExprContext::Del => Type::None, - ExprContext::Invalid => Type::Unknown, - } - } - - fn infer_unary_expression(&mut self, unary: &ast::ExprUnaryOp) -> Type<'db> { - let ast::ExprUnaryOp { - range: _, - op, - operand, - } = unary; - - let operand_type = self.infer_expression(operand); - - match (op, operand_type) { - (UnaryOp::UAdd, Type::IntLiteral(value)) => Type::IntLiteral(value), - (UnaryOp::USub, Type::IntLiteral(value)) => Type::IntLiteral(-value), - (UnaryOp::Invert, Type::IntLiteral(value)) => Type::IntLiteral(!value), - - (UnaryOp::UAdd, Type::BooleanLiteral(bool)) => Type::IntLiteral(i64::from(bool)), - (UnaryOp::USub, Type::BooleanLiteral(bool)) => Type::IntLiteral(-i64::from(bool)), - (UnaryOp::Invert, Type::BooleanLiteral(bool)) => Type::IntLiteral(!i64::from(bool)), - - (UnaryOp::Not, ty) => ty.bool(self.db).negate().into_type(self.db), - (_, Type::Any) => Type::Any, - (_, Type::Unknown) => Type::Unknown, - (op @ (UnaryOp::UAdd | UnaryOp::USub | UnaryOp::Invert), Type::Instance(class)) => { - let unary_dunder_method = match op { - UnaryOp::Invert => "__invert__", - UnaryOp::UAdd => "__pos__", - UnaryOp::USub => "__neg__", - UnaryOp::Not => { - unreachable!("Not operator is handled in its own case"); - } - }; - let class_member = class.class_member(self.db, unary_dunder_method); - let call = class_member.call(self.db, &[operand_type]); - - match call.return_ty_result(self.db, AnyNodeRef::ExprUnaryOp(unary), self) { - Ok(t) => t, - Err(e) => { - self.add_diagnostic( - unary.into(), - "unsupported-operator", - format_args!( - "Unary operator `{op}` is unsupported for type `{}`", - operand_type.display(self.db), - ), - ); - e.return_ty() - } - } - } - _ => Type::Todo, // TODO other unary op types - } - } - - fn infer_binary_expression(&mut self, binary: &ast::ExprBinOp) -> Type<'db> { - let ast::ExprBinOp { - left, - op, - right, - range: _, - } = binary; - - let left_ty = self.infer_expression(left); - let right_ty = self.infer_expression(right); - - // Check for division by zero; this doesn't change the inferred type for the expression, but - // may emit a diagnostic - if matches!( - (op, right_ty), - ( - ast::Operator::Div | ast::Operator::FloorDiv | ast::Operator::Mod, - Type::IntLiteral(0) | Type::BooleanLiteral(false) - ) - ) { - self.check_division_by_zero(binary, left_ty); - } - - self.infer_binary_expression_type(left_ty, right_ty, *op) - .unwrap_or_else(|| { - self.add_diagnostic( - binary.into(), - "unsupported-operator", - format_args!( - "Operator `{op}` is unsupported between objects of type `{}` and `{}`", - left_ty.display(self.db), - right_ty.display(self.db) - ), - ); - Type::Unknown - }) - } - - fn infer_binary_expression_type( - &mut self, - left_ty: Type<'db>, - right_ty: Type<'db>, - op: ast::Operator, - ) -> Option> { - match (left_ty, right_ty, op) { - // When interacting with Todo, Any and Unknown should propagate (as if we fix this - // `Todo` in the future, the result would then become Any or Unknown, respectively.) - (Type::Any, _, _) | (_, Type::Any, _) => Some(Type::Any), - (Type::Unknown, _, _) | (_, Type::Unknown, _) => Some(Type::Unknown), - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Add) => Some( - n.checked_add(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ), - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Sub) => Some( - n.checked_sub(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ), - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Mult) => Some( - n.checked_mul(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ), - - (Type::IntLiteral(_), Type::IntLiteral(_), ast::Operator::Div) => { - Some(KnownClass::Float.to_instance(self.db)) - } - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::FloorDiv) => Some( - n.checked_div(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ), - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Mod) => Some( - n.checked_rem(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - ), - - (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Pow) => { - let m = u32::try_from(m); - Some(match m { - Ok(m) => n - .checked_pow(m) - .map(Type::IntLiteral) - .unwrap_or_else(|| KnownClass::Int.to_instance(self.db)), - Err(_) => KnownClass::Int.to_instance(self.db), - }) - } - - (Type::BytesLiteral(lhs), Type::BytesLiteral(rhs), ast::Operator::Add) => { - Some(Type::BytesLiteral(BytesLiteralType::new( - self.db, - [lhs.value(self.db).as_ref(), rhs.value(self.db).as_ref()] - .concat() - .into_boxed_slice(), - ))) - } - - (Type::StringLiteral(lhs), Type::StringLiteral(rhs), ast::Operator::Add) => { - let lhs_value = lhs.value(self.db).to_string(); - let rhs_value = rhs.value(self.db).as_ref(); - let ty = if lhs_value.len() + rhs_value.len() <= Self::MAX_STRING_LITERAL_SIZE { - Type::StringLiteral(StringLiteralType::new(self.db, { - (lhs_value + rhs_value).into_boxed_str() - })) - } else { - Type::LiteralString - }; - Some(ty) - } - - ( - Type::StringLiteral(_) | Type::LiteralString, - Type::StringLiteral(_) | Type::LiteralString, - ast::Operator::Add, - ) => Some(Type::LiteralString), - - (Type::StringLiteral(s), Type::IntLiteral(n), ast::Operator::Mult) - | (Type::IntLiteral(n), Type::StringLiteral(s), ast::Operator::Mult) => { - let ty = if n < 1 { - Type::StringLiteral(StringLiteralType::new(self.db, "")) - } else if let Ok(n) = usize::try_from(n) { - if n.checked_mul(s.value(self.db).len()) - .is_some_and(|new_length| new_length <= Self::MAX_STRING_LITERAL_SIZE) - { - let new_literal = s.value(self.db).repeat(n); - Type::StringLiteral(StringLiteralType::new( - self.db, - new_literal.into_boxed_str(), - )) - } else { - Type::LiteralString - } - } else { - Type::LiteralString - }; - Some(ty) - } - - (Type::LiteralString, Type::IntLiteral(n), ast::Operator::Mult) - | (Type::IntLiteral(n), Type::LiteralString, ast::Operator::Mult) => { - let ty = if n < 1 { - Type::StringLiteral(StringLiteralType::new(self.db, "")) - } else { - Type::LiteralString - }; - Some(ty) - } - - (Type::Instance(_), Type::IntLiteral(_), op) => { - self.infer_binary_expression_type(left_ty, KnownClass::Int.to_instance(self.db), op) - } - - (Type::IntLiteral(_), Type::Instance(_), op) => self.infer_binary_expression_type( - KnownClass::Int.to_instance(self.db), - right_ty, - op, - ), - - (Type::Instance(_), Type::Tuple(_), op) => self.infer_binary_expression_type( - left_ty, - KnownClass::Tuple.to_instance(self.db), - op, - ), - - (Type::Tuple(_), Type::Instance(_), op) => self.infer_binary_expression_type( - KnownClass::Tuple.to_instance(self.db), - right_ty, - op, - ), - - (Type::Instance(_), Type::StringLiteral(_) | Type::LiteralString, op) => { - self.infer_binary_expression_type(left_ty, KnownClass::Str.to_instance(self.db), op) - } - - (Type::StringLiteral(_) | Type::LiteralString, Type::Instance(_), op) => self - .infer_binary_expression_type(KnownClass::Str.to_instance(self.db), right_ty, op), - - (Type::Instance(_), Type::BytesLiteral(_), op) => self.infer_binary_expression_type( - left_ty, - KnownClass::Bytes.to_instance(self.db), - op, - ), - - (Type::BytesLiteral(_), Type::Instance(_), op) => self.infer_binary_expression_type( - KnownClass::Bytes.to_instance(self.db), - right_ty, - op, - ), - - (Type::Instance(left_class), Type::Instance(right_class), op) => { - if left_class != right_class && right_class.is_subclass_of(self.db, left_class) { - let reflected_dunder = op.reflected_dunder(); - let rhs_reflected = right_class.class_member(self.db, reflected_dunder); - if !rhs_reflected.is_unbound() - && rhs_reflected != left_class.class_member(self.db, reflected_dunder) - { - return rhs_reflected - .call(self.db, &[right_ty, left_ty]) - .return_ty(self.db) - .or_else(|| { - left_class - .class_member(self.db, op.dunder()) - .call(self.db, &[left_ty, right_ty]) - .return_ty(self.db) - }); - } - } - left_class - .class_member(self.db, op.dunder()) - .call(self.db, &[left_ty, right_ty]) - .return_ty(self.db) - .or_else(|| { - if left_class == right_class { - None - } else { - right_class - .class_member(self.db, op.reflected_dunder()) - .call(self.db, &[right_ty, left_ty]) - .return_ty(self.db) - } - }) - } - - ( - Type::BooleanLiteral(b1), - Type::BooleanLiteral(b2), - ruff_python_ast::Operator::BitOr, - ) => Some(Type::BooleanLiteral(b1 | b2)), - - (Type::BooleanLiteral(bool_value), right, op) => self.infer_binary_expression_type( - Type::IntLiteral(i64::from(bool_value)), - right, - op, - ), - (left, Type::BooleanLiteral(bool_value), op) => { - self.infer_binary_expression_type(left, Type::IntLiteral(i64::from(bool_value)), op) - } - _ => Some(Type::Todo), // TODO - } - } - - fn infer_boolean_expression(&mut self, bool_op: &ast::ExprBoolOp) -> Type<'db> { - let ast::ExprBoolOp { - range: _, - op, - values, - } = bool_op; - Self::infer_chained_boolean_types( - self.db, - *op, - values.iter().map(|value| self.infer_expression(value)), - values.len(), - ) - } - - /// Computes the output of a chain of (one) boolean operation, consuming as input an iterator - /// of types. The iterator is consumed even if the boolean evaluation can be short-circuited, - /// in order to ensure the invariant that all expressions are evaluated when inferring types. - fn infer_chained_boolean_types( - db: &'db dyn Db, - op: ast::BoolOp, - values: impl IntoIterator>, - n_values: usize, - ) -> Type<'db> { - let mut done = false; - UnionType::from_elements( - db, - values.into_iter().enumerate().map(|(i, ty)| { - if done { - Type::Never - } else { - let is_last = i == n_values - 1; - match (ty.bool(db), is_last, op) { - (Truthiness::Ambiguous, _, _) => ty, - (Truthiness::AlwaysTrue, false, ast::BoolOp::And) => Type::Never, - (Truthiness::AlwaysFalse, false, ast::BoolOp::Or) => Type::Never, - (Truthiness::AlwaysFalse, _, ast::BoolOp::And) - | (Truthiness::AlwaysTrue, _, ast::BoolOp::Or) => { - done = true; - ty - } - (_, true, _) => ty, - } - } - }), - ) - } - - fn infer_compare_expression(&mut self, compare: &ast::ExprCompare) -> Type<'db> { - let ast::ExprCompare { - range: _, - left, - ops, - comparators, - } = compare; - - self.infer_expression(left); - for right in comparators { - self.infer_expression(right); - } - - // https://docs.python.org/3/reference/expressions.html#comparisons - // > Formally, if `a, b, c, …, y, z` are expressions and `op1, op2, …, opN` are comparison - // > operators, then `a op1 b op2 c ... y opN z` is equivalent to a `op1 b and b op2 c and - // ... > y opN z`, except that each expression is evaluated at most once. - // - // As some operators (==, !=, <, <=, >, >=) *can* return an arbitrary type, the logic below - // is shared with the one in `infer_binary_type_comparison`. - Self::infer_chained_boolean_types( - self.db, - ast::BoolOp::And, - std::iter::once(&**left) - .chain(comparators) - .tuple_windows::<(_, _)>() - .zip(ops) - .map(|((left, right), op)| { - let left_ty = self.expression_ty(left); - let right_ty = self.expression_ty(right); - - self.infer_binary_type_comparison(left_ty, *op, right_ty) - .unwrap_or_else(|error| { - // Handle unsupported operators (diagnostic, `bool`/`Unknown` outcome) - self.add_diagnostic( - AnyNodeRef::ExprCompare(compare), - "unsupported-operator", - format_args!( - "Operator `{}` is not supported for types `{}` and `{}`{}", - error.op, - error.left_ty.display(self.db), - error.right_ty.display(self.db), - if (left_ty, right_ty) == (error.left_ty, error.right_ty) { - String::new() - } else { - format!( - ", in comparing `{}` with `{}`", - left_ty.display(self.db), - right_ty.display(self.db) - ) - } - ), - ); - - match op { - // `in, not in, is, is not` always return bool instances - ast::CmpOp::In - | ast::CmpOp::NotIn - | ast::CmpOp::Is - | ast::CmpOp::IsNot => KnownClass::Bool.to_instance(self.db), - // Other operators can return arbitrary types - _ => Type::Unknown, - } - }) - }), - ops.len(), - ) - } - - /// Infers the type of a binary comparison (e.g. 'left == right'). See - /// `infer_compare_expression` for the higher level logic dealing with multi-comparison - /// expressions. - /// - /// If the operation is not supported, return None (we need upstream context to emit a - /// diagnostic). - fn infer_binary_type_comparison( - &mut self, - left: Type<'db>, - op: ast::CmpOp, - right: Type<'db>, - ) -> Result, CompareUnsupportedError<'db>> { - // Note: identity (is, is not) for equal builtin types is unreliable and not part of the - // language spec. - // - `[ast::CompOp::Is]`: return `false` if unequal, `bool` if equal - // - `[ast::CompOp::IsNot]`: return `true` if unequal, `bool` if equal - match (left, right) { - (Type::Union(union), other) => { - let mut builder = UnionBuilder::new(self.db); - for element in union.elements(self.db) { - builder = builder.add(self.infer_binary_type_comparison(*element, op, other)?); - } - Ok(builder.build()) - } - (other, Type::Union(union)) => { - let mut builder = UnionBuilder::new(self.db); - for element in union.elements(self.db) { - builder = builder.add(self.infer_binary_type_comparison(other, op, *element)?); - } - Ok(builder.build()) - } - - (Type::IntLiteral(n), Type::IntLiteral(m)) => match op { - ast::CmpOp::Eq => Ok(Type::BooleanLiteral(n == m)), - ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(n != m)), - ast::CmpOp::Lt => Ok(Type::BooleanLiteral(n < m)), - ast::CmpOp::LtE => Ok(Type::BooleanLiteral(n <= m)), - ast::CmpOp::Gt => Ok(Type::BooleanLiteral(n > m)), - ast::CmpOp::GtE => Ok(Type::BooleanLiteral(n >= m)), - ast::CmpOp::Is => { - if n == m { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(false)) - } - } - ast::CmpOp::IsNot => { - if n == m { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(true)) - } - } - // Undefined for (int, int) - ast::CmpOp::In | ast::CmpOp::NotIn => Err(CompareUnsupportedError { - op, - left_ty: left, - right_ty: right, - }), - }, - (Type::IntLiteral(_), Type::Instance(_)) => { - self.infer_binary_type_comparison(KnownClass::Int.to_instance(self.db), op, right) - } - (Type::Instance(_), Type::IntLiteral(_)) => { - self.infer_binary_type_comparison(left, op, KnownClass::Int.to_instance(self.db)) - } - - // Booleans are coded as integers (False = 0, True = 1) - (Type::IntLiteral(n), Type::BooleanLiteral(b)) => self.infer_binary_type_comparison( - Type::IntLiteral(n), - op, - Type::IntLiteral(i64::from(b)), - ), - (Type::BooleanLiteral(b), Type::IntLiteral(m)) => self.infer_binary_type_comparison( - Type::IntLiteral(i64::from(b)), - op, - Type::IntLiteral(m), - ), - (Type::BooleanLiteral(a), Type::BooleanLiteral(b)) => self - .infer_binary_type_comparison( - Type::IntLiteral(i64::from(a)), - op, - Type::IntLiteral(i64::from(b)), - ), - - (Type::StringLiteral(salsa_s1), Type::StringLiteral(salsa_s2)) => { - let s1 = salsa_s1.value(self.db); - let s2 = salsa_s2.value(self.db); - match op { - ast::CmpOp::Eq => Ok(Type::BooleanLiteral(s1 == s2)), - ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(s1 != s2)), - ast::CmpOp::Lt => Ok(Type::BooleanLiteral(s1 < s2)), - ast::CmpOp::LtE => Ok(Type::BooleanLiteral(s1 <= s2)), - ast::CmpOp::Gt => Ok(Type::BooleanLiteral(s1 > s2)), - ast::CmpOp::GtE => Ok(Type::BooleanLiteral(s1 >= s2)), - ast::CmpOp::In => Ok(Type::BooleanLiteral(s2.contains(s1.as_ref()))), - ast::CmpOp::NotIn => Ok(Type::BooleanLiteral(!s2.contains(s1.as_ref()))), - ast::CmpOp::Is => { - if s1 == s2 { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(false)) - } - } - ast::CmpOp::IsNot => { - if s1 == s2 { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(true)) - } - } - } - } - (Type::StringLiteral(_), _) => { - self.infer_binary_type_comparison(KnownClass::Str.to_instance(self.db), op, right) - } - (_, Type::StringLiteral(_)) => { - self.infer_binary_type_comparison(left, op, KnownClass::Str.to_instance(self.db)) - } - - (Type::LiteralString, _) => { - self.infer_binary_type_comparison(KnownClass::Str.to_instance(self.db), op, right) - } - (_, Type::LiteralString) => { - self.infer_binary_type_comparison(left, op, KnownClass::Str.to_instance(self.db)) - } - - (Type::BytesLiteral(salsa_b1), Type::BytesLiteral(salsa_b2)) => { - let b1 = &**salsa_b1.value(self.db); - let b2 = &**salsa_b2.value(self.db); - match op { - ast::CmpOp::Eq => Ok(Type::BooleanLiteral(b1 == b2)), - ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(b1 != b2)), - ast::CmpOp::Lt => Ok(Type::BooleanLiteral(b1 < b2)), - ast::CmpOp::LtE => Ok(Type::BooleanLiteral(b1 <= b2)), - ast::CmpOp::Gt => Ok(Type::BooleanLiteral(b1 > b2)), - ast::CmpOp::GtE => Ok(Type::BooleanLiteral(b1 >= b2)), - ast::CmpOp::In => { - Ok(Type::BooleanLiteral(memchr::memmem::find(b2, b1).is_some())) - } - ast::CmpOp::NotIn => { - Ok(Type::BooleanLiteral(memchr::memmem::find(b2, b1).is_none())) - } - ast::CmpOp::Is => { - if b1 == b2 { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(false)) - } - } - ast::CmpOp::IsNot => { - if b1 == b2 { - Ok(KnownClass::Bool.to_instance(self.db)) - } else { - Ok(Type::BooleanLiteral(true)) - } - } - } - } - (Type::BytesLiteral(_), _) => { - self.infer_binary_type_comparison(KnownClass::Bytes.to_instance(self.db), op, right) - } - (_, Type::BytesLiteral(_)) => { - self.infer_binary_type_comparison(left, op, KnownClass::Bytes.to_instance(self.db)) - } - (Type::Tuple(lhs), Type::Tuple(rhs)) => { - // Note: This only works on heterogeneous tuple types. - let lhs_elements = lhs.elements(self.db); - let rhs_elements = rhs.elements(self.db); - - let mut lexicographic_type_comparison = - |op| self.infer_lexicographic_type_comparison(lhs_elements, op, rhs_elements); - - match op { - ast::CmpOp::Eq => lexicographic_type_comparison(RichCompareOperator::Eq), - ast::CmpOp::NotEq => lexicographic_type_comparison(RichCompareOperator::Ne), - ast::CmpOp::Lt => lexicographic_type_comparison(RichCompareOperator::Lt), - ast::CmpOp::LtE => lexicographic_type_comparison(RichCompareOperator::Le), - ast::CmpOp::Gt => lexicographic_type_comparison(RichCompareOperator::Gt), - ast::CmpOp::GtE => lexicographic_type_comparison(RichCompareOperator::Ge), - ast::CmpOp::In | ast::CmpOp::NotIn => { - let mut eq_count = 0usize; - let mut not_eq_count = 0usize; - - for ty in rhs_elements { - let eq_result = self.infer_binary_type_comparison( - Type::Tuple(lhs), - ast::CmpOp::Eq, - *ty, - ).expect("infer_binary_type_comparison should never return None for `CmpOp::Eq`"); - - match eq_result { - Type::Todo => return Ok(Type::Todo), - ty => match ty.bool(self.db) { - Truthiness::AlwaysTrue => eq_count += 1, - Truthiness::AlwaysFalse => not_eq_count += 1, - Truthiness::Ambiguous => (), - }, - } - } - - if eq_count >= 1 { - Ok(Type::BooleanLiteral(op.is_in())) - } else if not_eq_count == rhs_elements.len() { - Ok(Type::BooleanLiteral(op.is_not_in())) - } else { - Ok(KnownClass::Bool.to_instance(self.db)) - } - } - ast::CmpOp::Is | ast::CmpOp::IsNot => { - // - `[ast::CmpOp::Is]`: returns `false` if the elements are definitely unequal, otherwise `bool` - // - `[ast::CmpOp::IsNot]`: returns `true` if the elements are definitely unequal, otherwise `bool` - let eq_result = lexicographic_type_comparison(RichCompareOperator::Eq) - .expect( - "infer_binary_type_comparison should never return None for `CmpOp::Eq`", - ); - - Ok(match eq_result { - Type::Todo => Type::Todo, - ty => match ty.bool(self.db) { - Truthiness::AlwaysFalse => Type::BooleanLiteral(op.is_is_not()), - _ => KnownClass::Bool.to_instance(self.db), - }, - }) - } - } - } - - // Lookup the rich comparison `__dunder__` methods on instances - (Type::Instance(left_class), Type::Instance(right_class)) => { - let rich_comparison = - |op| perform_rich_comparison(self.db, left_class, right_class, op); - let membership_test_comparison = - |op| perform_membership_test_comparison(self.db, left_class, right_class, op); - match op { - ast::CmpOp::Eq => rich_comparison(RichCompareOperator::Eq), - ast::CmpOp::NotEq => rich_comparison(RichCompareOperator::Ne), - ast::CmpOp::Lt => rich_comparison(RichCompareOperator::Lt), - ast::CmpOp::LtE => rich_comparison(RichCompareOperator::Le), - ast::CmpOp::Gt => rich_comparison(RichCompareOperator::Gt), - ast::CmpOp::GtE => rich_comparison(RichCompareOperator::Ge), - ast::CmpOp::In => membership_test_comparison(MembershipTestCompareOperator::In), - ast::CmpOp::NotIn => { - membership_test_comparison(MembershipTestCompareOperator::NotIn) - } - ast::CmpOp::Is => Ok(KnownClass::Bool.to_instance(self.db)), - ast::CmpOp::IsNot => Ok(KnownClass::Bool.to_instance(self.db)), - } - } - // TODO: handle more types - _ => match op { - ast::CmpOp::Is | ast::CmpOp::IsNot => Ok(KnownClass::Bool.to_instance(self.db)), - _ => Ok(Type::Todo), - }, - } - } - - /// Performs lexicographic comparison between two slices of types. - /// - /// For lexicographic comparison, elements from both slices are compared pairwise using - /// `infer_binary_type_comparison`. If a conclusive result cannot be determined as a `BooleanLiteral`, - /// it returns `bool`. Returns `None` if the comparison is not supported. - fn infer_lexicographic_type_comparison( - &mut self, - left: &[Type<'db>], - op: RichCompareOperator, - right: &[Type<'db>], - ) -> Result, CompareUnsupportedError<'db>> { - // Compare paired elements from left and right slices - for (l_ty, r_ty) in left.iter().copied().zip(right.iter().copied()) { - let eq_result = self - .infer_binary_type_comparison(l_ty, ast::CmpOp::Eq, r_ty) - .expect("infer_binary_type_comparison should never return None for `CmpOp::Eq`"); - - match eq_result { - // If propagation is required, return the result as is - Type::Todo => return Ok(Type::Todo), - ty => match ty.bool(self.db) { - // Types are equal, continue to the next pair - Truthiness::AlwaysTrue => continue, - // Types are not equal, perform the specified comparison and return the result - Truthiness::AlwaysFalse => { - return self.infer_binary_type_comparison(l_ty, op.into(), r_ty) - } - // If the intermediate result is ambiguous, we cannot determine the final result as BooleanLiteral. - // In this case, we simply return a bool instance. - Truthiness::Ambiguous => return Ok(KnownClass::Bool.to_instance(self.db)), - }, - } - } - - // At this point, the lengths of the two slices may be different, but the prefix of - // left and right slices is entirely identical. - // We return a comparison of the slice lengths based on the operator. - let (left_len, right_len) = (left.len(), right.len()); - - Ok(Type::BooleanLiteral(match op { - RichCompareOperator::Eq => left_len == right_len, - RichCompareOperator::Ne => left_len != right_len, - RichCompareOperator::Lt => left_len < right_len, - RichCompareOperator::Le => left_len <= right_len, - RichCompareOperator::Gt => left_len > right_len, - RichCompareOperator::Ge => left_len >= right_len, - })) - } - - fn infer_subscript_expression(&mut self, subscript: &ast::ExprSubscript) -> Type<'db> { - let ast::ExprSubscript { - range: _, - value, - slice, - ctx: _, - } = subscript; - - let value_ty = self.infer_expression(value); - let slice_ty = self.infer_expression(slice); - self.infer_subscript_expression_types(value, value_ty, slice_ty) - } - - fn infer_subscript_expression_types( - &mut self, - value_node: &ast::Expr, - value_ty: Type<'db>, - slice_ty: Type<'db>, - ) -> Type<'db> { - match (value_ty, slice_ty) { - // Ex) Given `("a", "b", "c", "d")[1]`, return `"b"` - (Type::Tuple(tuple_ty), Type::IntLiteral(int)) => { - let elements = tuple_ty.elements(self.db); - elements - .iter() - .python_subscript(int) - .copied() - .unwrap_or_else(|| { - self.index_out_of_bounds_diagnostic( - "tuple", - value_node.into(), - value_ty, - elements.len(), - int, - ); - Type::Unknown - }) - } - // Ex) Given `("a", "b", "c", "d")[True]`, return `"b"` - (Type::Tuple(_), Type::BooleanLiteral(bool)) => self.infer_subscript_expression_types( - value_node, - value_ty, - Type::IntLiteral(i64::from(bool)), - ), - // Ex) Given `"value"[1]`, return `"a"` - (Type::StringLiteral(literal_ty), Type::IntLiteral(int)) => { - let literal_value = literal_ty.value(self.db); - literal_value - .chars() - .python_subscript(int) - .map(|ch| { - Type::StringLiteral(StringLiteralType::new( - self.db, - ch.to_string().into_boxed_str(), - )) - }) - .unwrap_or_else(|| { - self.index_out_of_bounds_diagnostic( - "string", - value_node.into(), - value_ty, - literal_value.chars().count(), - int, - ); - Type::Unknown - }) - } - // Ex) Given `b"value"[1]`, return `b"a"` - (Type::BytesLiteral(literal_ty), Type::IntLiteral(int)) => { - let literal_value = literal_ty.value(self.db); - literal_value - .iter() - .python_subscript(int) - .map(|byte| { - Type::BytesLiteral(BytesLiteralType::new(self.db, [*byte].as_slice())) - }) - .unwrap_or_else(|| { - self.index_out_of_bounds_diagnostic( - "bytes literal", - value_node.into(), - value_ty, - literal_value.len(), - int, - ); - Type::Unknown - }) - } - // Ex) Given `"value"[True]`, return `"a"` - (Type::StringLiteral(_) | Type::BytesLiteral(_), Type::BooleanLiteral(bool)) => self - .infer_subscript_expression_types( - value_node, - value_ty, - Type::IntLiteral(i64::from(bool)), - ), - (value_ty, slice_ty) => { - // Resolve the value to its class. - let value_meta_ty = value_ty.to_meta_type(self.db); - - // If the class defines `__getitem__`, return its return type. - // - // See: https://docs.python.org/3/reference/datamodel.html#class-getitem-versus-getitem - let dunder_getitem_method = value_meta_ty.member(self.db, "__getitem__"); - if !dunder_getitem_method.is_unbound() { - return dunder_getitem_method - .call(self.db, &[slice_ty]) - .return_ty_result(self.db, value_node.into(), self) - .unwrap_or_else(|err| { - self.add_diagnostic( - value_node.into(), - "call-non-callable", - format_args!( - "Method `__getitem__` of type `{}` is not callable on object of type `{}`", - err.called_ty().display(self.db), - value_ty.display(self.db), - ), - ); - err.return_ty() - }); - } - - // Otherwise, if the value is itself a class and defines `__class_getitem__`, - // return its return type. - // - // TODO: lots of classes are only subscriptable at runtime on Python 3.9+, - // *but* we should also allow them to be subscripted in stubs - // (and in annotations if `from __future__ import annotations` is enabled), - // even if the target version is Python 3.8 or lower, - // despite the fact that there will be no corresponding `__class_getitem__` - // method in these `sys.version_info` branches. - if value_ty.is_subtype_of(self.db, KnownClass::Type.to_instance(self.db)) { - let dunder_class_getitem_method = value_ty.member(self.db, "__class_getitem__"); - if !dunder_class_getitem_method.is_unbound() { - return dunder_class_getitem_method - .call(self.db, &[slice_ty]) - .return_ty_result(self.db, value_node.into(), self) - .unwrap_or_else(|err| { - self.add_diagnostic( - value_node.into(), - "call-non-callable", - format_args!( - "Method `__class_getitem__` of type `{}` is not callable on object of type `{}`", - err.called_ty().display(self.db), - value_ty.display(self.db), - ), - ); - err.return_ty() - }); - } - - if matches!(value_ty, Type::ClassLiteral(class) if class.is_known(self.db, KnownClass::Type)) - { - return KnownClass::GenericAlias.to_instance(self.db); - } - - self.non_subscriptable_diagnostic( - value_node.into(), - value_ty, - "__class_getitem__", - ); - } else { - self.non_subscriptable_diagnostic(value_node.into(), value_ty, "__getitem__"); - } - - Type::Unknown - } - } - } - - fn infer_slice_expression(&mut self, slice: &ast::ExprSlice) -> Type<'db> { - let ast::ExprSlice { - range: _, - lower, - upper, - step, - } = slice; - - self.infer_optional_expression(lower.as_deref()); - self.infer_optional_expression(upper.as_deref()); - self.infer_optional_expression(step.as_deref()); - - // TODO slice - Type::Todo - } - - fn infer_type_parameters(&mut self, type_parameters: &ast::TypeParams) { - let ast::TypeParams { - range: _, - type_params, - } = type_parameters; - for type_param in type_params { - match type_param { - ast::TypeParam::TypeVar(typevar) => { - let ast::TypeParamTypeVar { - range: _, - name: _, - bound, - default, - } = typevar; - self.infer_optional_expression(bound.as_deref()); - self.infer_optional_expression(default.as_deref()); - } - ast::TypeParam::ParamSpec(param_spec) => { - let ast::TypeParamParamSpec { - range: _, - name: _, - default, - } = param_spec; - self.infer_optional_expression(default.as_deref()); - } - ast::TypeParam::TypeVarTuple(typevar_tuple) => { - let ast::TypeParamTypeVarTuple { - range: _, - name: _, - default, - } = typevar_tuple; - self.infer_optional_expression(default.as_deref()); - } - } - } - } - - /// Adds a new diagnostic. - /// - /// The diagnostic does not get added if the rule isn't enabled for this file. - pub(super) fn add_diagnostic( - &mut self, - node: AnyNodeRef, - rule: &str, - message: std::fmt::Arguments, - ) { - if !self.db.is_file_open(self.file) { - return; - } - - // TODO: Don't emit the diagnostic if: - // * The enclosing node contains any syntax errors - // * The rule is disabled for this file. We probably want to introduce a new query that - // returns a rule selector for a given file that respects the package's settings, - // any global pragma comments in the file, and any per-file-ignores. - - self.types.diagnostics.push(TypeCheckDiagnostic { - file: self.file, - rule: rule.to_string(), - message: message.to_string(), - range: node.range(), - }); - } - - pub(super) fn finish(mut self) -> TypeInference<'db> { - self.infer_region(); - self.types.shrink_to_fit(); - self.types - } -} - -/// Annotation expressions. -impl<'db> TypeInferenceBuilder<'db> { - fn infer_annotation_expression(&mut self, expression: &ast::Expr) -> Type<'db> { - // https://typing.readthedocs.io/en/latest/spec/annotations.html#grammar-token-expression-grammar-annotation_expression - match expression { - // TODO: parse the expression and check whether it is a string annotation, since they - // can be annotation expressions distinct from type expressions. - // https://typing.readthedocs.io/en/latest/spec/annotations.html#string-annotations - ast::Expr::StringLiteral(_literal) => Type::Todo, - - // Annotation expressions also get special handling for `*args` and `**kwargs`. - ast::Expr::Starred(starred) => self.infer_starred_expression(starred), - - // All other annotation expressions are (possibly) valid type expressions, so handle - // them there instead. - type_expr => self.infer_type_expression(type_expr), - } - } -} - -/// Type expressions -impl<'db> TypeInferenceBuilder<'db> { - fn infer_type_expression(&mut self, expression: &ast::Expr) -> Type<'db> { - // https://typing.readthedocs.io/en/latest/spec/annotations.html#grammar-token-expression-grammar-type_expression - // TODO: this does not include any of the special forms, and is only a - // stub of the forms other than a standalone name in scope. - - let ty = match expression { - ast::Expr::Name(name) => { - debug_assert!( - name.ctx.is_load(), - "name in a type expression is always 'load' but got: '{:?}'", - name.ctx - ); - - self.infer_name_expression(name).to_instance(self.db) - } - - ast::Expr::NoneLiteral(_literal) => Type::None, - - // TODO: parse the expression and check whether it is a string annotation. - // https://typing.readthedocs.io/en/latest/spec/annotations.html#string-annotations - ast::Expr::StringLiteral(_literal) => Type::Todo, - - // TODO: an Ellipsis literal *on its own* does not have any meaning in annotation - // expressions, but is meaningful in the context of a number of special forms. - ast::Expr::EllipsisLiteral(_literal) => Type::Todo, - - // Other literals do not have meaningful values in the annotation expression context. - // However, we will we want to handle these differently when working with special forms, - // since (e.g.) `123` is not valid in an annotation expression but `Literal[123]` is. - ast::Expr::BytesLiteral(_literal) => Type::Todo, - ast::Expr::NumberLiteral(_literal) => Type::Todo, - ast::Expr::BooleanLiteral(_literal) => Type::Todo, - - // TODO: this may be a place we need to revisit with special forms. - ast::Expr::Subscript(subscript) => { - self.infer_subscript_expression(subscript); - Type::Todo - } - - ast::Expr::BinOp(binary) => { - #[allow(clippy::single_match_else)] - match binary.op { - // PEP-604 unions are okay, e.g., `int | str` - ast::Operator::BitOr => { - let left_ty = self.infer_type_expression(&binary.left); - let right_ty = self.infer_type_expression(&binary.right); - UnionType::from_elements(self.db, [left_ty, right_ty]) - } - // anything else is an invalid annotation: - _ => { - self.infer_binary_expression(binary); - Type::Unknown - } - } - } - - // Forms which are invalid in the context of annotation expressions: we infer their - // nested expressions as normal expressions, but the type of the top-level expression is - // always `Type::Unknown` in these cases. - ast::Expr::BoolOp(bool_op) => { - self.infer_boolean_expression(bool_op); - Type::Unknown - } - ast::Expr::Named(named) => { - self.infer_named_expression(named); - Type::Unknown - } - ast::Expr::UnaryOp(unary) => { - self.infer_unary_expression(unary); - Type::Unknown - } - ast::Expr::Lambda(lambda_expression) => { - self.infer_lambda_expression(lambda_expression); - Type::Unknown - } - ast::Expr::If(if_expression) => { - self.infer_if_expression(if_expression); - Type::Unknown - } - ast::Expr::Dict(dict) => { - self.infer_dict_expression(dict); - Type::Unknown - } - ast::Expr::Set(set) => { - self.infer_set_expression(set); - Type::Unknown - } - ast::Expr::ListComp(listcomp) => { - self.infer_list_comprehension_expression(listcomp); - Type::Unknown - } - ast::Expr::SetComp(setcomp) => { - self.infer_set_comprehension_expression(setcomp); - Type::Unknown - } - ast::Expr::DictComp(dictcomp) => { - self.infer_dict_comprehension_expression(dictcomp); - Type::Unknown - } - ast::Expr::Generator(generator) => { - self.infer_generator_expression(generator); - Type::Unknown - } - ast::Expr::Await(await_expression) => { - self.infer_await_expression(await_expression); - Type::Unknown - } - ast::Expr::Yield(yield_expression) => { - self.infer_yield_expression(yield_expression); - Type::Unknown - } - ast::Expr::YieldFrom(yield_from) => { - self.infer_yield_from_expression(yield_from); - Type::Unknown - } - ast::Expr::Compare(compare) => { - self.infer_compare_expression(compare); - Type::Unknown - } - ast::Expr::Call(call_expr) => { - self.infer_call_expression(call_expr); - Type::Unknown - } - ast::Expr::FString(fstring) => { - self.infer_fstring_expression(fstring); - Type::Unknown - } - // - ast::Expr::Attribute(attribute) => { - self.infer_attribute_expression(attribute); - Type::Unknown - } - ast::Expr::Starred(starred) => { - self.infer_starred_expression(starred); - Type::Unknown - } - ast::Expr::List(list) => { - self.infer_list_expression(list); - Type::Unknown - } - ast::Expr::Tuple(tuple) => { - self.infer_tuple_expression(tuple); - Type::Unknown - } - ast::Expr::Slice(slice) => { - self.infer_slice_expression(slice); - Type::Unknown - } - - ast::Expr::IpyEscapeCommand(_) => todo!("Implement Ipy escape command support"), - }; - - let expr_id = expression.scoped_ast_id(self.db, self.scope()); - let previous = self.types.expressions.insert(expr_id, ty); - assert!(previous.is_none()); - - ty - } -} - -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -enum RichCompareOperator { - Eq, - Ne, - Gt, - Ge, - Lt, - Le, -} - -impl From for ast::CmpOp { - fn from(value: RichCompareOperator) -> Self { - match value { - RichCompareOperator::Eq => ast::CmpOp::Eq, - RichCompareOperator::Ne => ast::CmpOp::NotEq, - RichCompareOperator::Lt => ast::CmpOp::Lt, - RichCompareOperator::Le => ast::CmpOp::LtE, - RichCompareOperator::Gt => ast::CmpOp::Gt, - RichCompareOperator::Ge => ast::CmpOp::GtE, - } - } -} - -impl RichCompareOperator { - #[must_use] - const fn dunder(self) -> &'static str { - match self { - RichCompareOperator::Eq => "__eq__", - RichCompareOperator::Ne => "__ne__", - RichCompareOperator::Lt => "__lt__", - RichCompareOperator::Le => "__le__", - RichCompareOperator::Gt => "__gt__", - RichCompareOperator::Ge => "__ge__", - } - } - - #[must_use] - const fn reflect(self) -> Self { - match self { - RichCompareOperator::Eq => RichCompareOperator::Eq, - RichCompareOperator::Ne => RichCompareOperator::Ne, - RichCompareOperator::Lt => RichCompareOperator::Gt, - RichCompareOperator::Le => RichCompareOperator::Ge, - RichCompareOperator::Gt => RichCompareOperator::Lt, - RichCompareOperator::Ge => RichCompareOperator::Le, - } - } -} - -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -enum MembershipTestCompareOperator { - In, - NotIn, -} - -impl From for ast::CmpOp { - fn from(value: MembershipTestCompareOperator) -> Self { - match value { - MembershipTestCompareOperator::In => ast::CmpOp::In, - MembershipTestCompareOperator::NotIn => ast::CmpOp::NotIn, - } - } -} - -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -struct CompareUnsupportedError<'db> { - op: ast::CmpOp, - left_ty: Type<'db>, - right_ty: Type<'db>, -} - -fn format_import_from_module(level: u32, module: Option<&str>) -> String { - format!( - "{}{}", - ".".repeat(level as usize), - module.unwrap_or_default() - ) -} - -/// Various ways in which resolving a [`ModuleName`] -/// from an [`ast::StmtImport`] or [`ast::StmtImportFrom`] node might fail -#[derive(Debug, Copy, Clone, PartialEq, Eq)] -enum ModuleNameResolutionError { - /// The import statement has invalid syntax - InvalidSyntax, - - /// We couldn't resolve the file we're currently analyzing back to a module - /// (Only necessary for relative import statements) - UnknownCurrentModule, - - /// The relative import statement seems to take us outside of the module search path - /// (e.g. our current module is `foo.bar`, and the relative import statement in `foo.bar` - /// is `from ....baz import spam`) - TooManyDots, -} - -/// Struct collecting string parts when inferring a formatted string. Infers a string literal if the -/// concatenated string is small enough, otherwise infers a literal string. -/// -/// If the formatted string contains an expression (with a representation unknown at compile time), -/// infers an instance of `builtins.str`. -struct StringPartsCollector { - concatenated: Option, - expression: bool, -} - -impl StringPartsCollector { - fn new() -> Self { - Self { - concatenated: Some(String::new()), - expression: false, - } - } - - fn push_str(&mut self, literal: &str) { - if let Some(mut concatenated) = self.concatenated.take() { - if concatenated.len().saturating_add(literal.len()) - <= TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE - { - concatenated.push_str(literal); - self.concatenated = Some(concatenated); - } else { - self.concatenated = None; - } - } - } - - fn add_expression(&mut self) { - self.concatenated = None; - self.expression = true; - } - - fn ty(self, db: &dyn Db) -> Type { - if self.expression { - KnownClass::Str.to_instance(db) - } else if let Some(concatenated) = self.concatenated { - Type::StringLiteral(StringLiteralType::new(db, concatenated.into_boxed_str())) - } else { - Type::LiteralString - } - } -} - -/// Rich comparison in Python are the operators `==`, `!=`, `<`, `<=`, `>`, and `>=`. Their -/// behaviour can be edited for classes by implementing corresponding dunder methods. -/// This function performs rich comparison between two instances and returns the resulting type. -/// see `` -fn perform_rich_comparison<'db>( - db: &'db dyn Db, - left_class: ClassType<'db>, - right_class: ClassType<'db>, - op: RichCompareOperator, -) -> Result, CompareUnsupportedError<'db>> { - // The following resource has details about the rich comparison algorithm: - // https://snarky.ca/unravelling-rich-comparison-operators/ - // - // TODO: this currently gives the return type even if the arg types are invalid - // (e.g. int.__lt__ with string instance should be errored, currently bool) - - let call_dunder = - |op: RichCompareOperator, left_class: ClassType<'db>, right_class: ClassType<'db>| { - left_class - .class_member(db, op.dunder()) - .call( - db, - &[Type::Instance(left_class), Type::Instance(right_class)], - ) - .return_ty(db) - }; - - // The reflected dunder has priority if the right-hand side is a strict subclass of the left-hand side. - if left_class != right_class && right_class.is_subclass_of(db, left_class) { - call_dunder(op.reflect(), right_class, left_class) - .or_else(|| call_dunder(op, left_class, right_class)) - } else { - call_dunder(op, left_class, right_class) - .or_else(|| call_dunder(op.reflect(), right_class, left_class)) - } - .or_else(|| { - // When no appropriate method returns any value other than NotImplemented, - // the `==` and `!=` operators will fall back to `is` and `is not`, respectively. - // refer to `` - if matches!(op, RichCompareOperator::Eq | RichCompareOperator::Ne) { - Some(KnownClass::Bool.to_instance(db)) - } else { - None - } - }) - .ok_or_else(|| CompareUnsupportedError { - op: op.into(), - left_ty: Type::Instance(left_class), - right_ty: Type::Instance(right_class), - }) -} - -/// Performs a membership test (`in` and `not in`) between two instances and returns the resulting type, or `None` if the test is unsupported. -/// The behavior can be customized in Python by implementing `__contains__`, `__iter__`, or `__getitem__` methods. -/// See `` -/// and `` -fn perform_membership_test_comparison<'db>( - db: &'db dyn Db, - left_class: ClassType<'db>, - right_class: ClassType<'db>, - op: MembershipTestCompareOperator, -) -> Result, CompareUnsupportedError<'db>> { - let (left_instance, right_instance) = (Type::Instance(left_class), Type::Instance(right_class)); - - let contains_dunder = right_class.class_member(db, "__contains__"); - - let compare_result_opt = if contains_dunder.is_unbound() { - // iteration-based membership test - match right_instance.iterate(db) { - IterationOutcome::Iterable { .. } => Some(KnownClass::Bool.to_instance(db)), - IterationOutcome::NotIterable { .. } => None, - } - } else { - // If `__contains__` is available, it is used directly for the membership test. - contains_dunder - .call(db, &[right_instance, left_instance]) - .return_ty(db) - }; - - compare_result_opt - .map(|ty| { - if matches!(ty, Type::Todo) { - return Type::Todo; - } - - match op { - MembershipTestCompareOperator::In => ty.bool(db).into_type(db), - MembershipTestCompareOperator::NotIn => ty.bool(db).negate().into_type(db), - } - }) - .ok_or_else(|| CompareUnsupportedError { - op: op.into(), - left_ty: left_instance, - right_ty: right_instance, - }) -} - -#[cfg(test)] -mod tests { - - use anyhow::Context; - - use crate::db::tests::TestDb; - use crate::program::{Program, SearchPathSettings}; - use crate::python_version::PythonVersion; - use crate::semantic_index::definition::Definition; - use crate::semantic_index::symbol::FileScopeId; - use crate::semantic_index::{global_scope, semantic_index, symbol_table, use_def_map}; - use crate::types::{ - check_types, global_symbol_ty, infer_definition_types, symbol_ty, TypeCheckDiagnostics, - }; - use crate::{HasTy, ProgramSettings, SemanticModel}; - use ruff_db::files::{system_path_to_file, File}; - use ruff_db::parsed::parsed_module; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use ruff_db::testing::assert_function_query_was_not_run; - use ruff_python_ast::name::Name; - - use super::TypeInferenceBuilder; - - fn setup_db() -> TestDb { - let db = TestDb::new(); - - let src_root = SystemPathBuf::from("/src"); - db.memory_file_system() - .create_directory_all(&src_root) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(src_root), - }, - ) - .expect("Valid search path settings"); - - db - } - - fn setup_db_with_custom_typeshed<'a>( - typeshed: &str, - files: impl IntoIterator, - ) -> anyhow::Result { - let mut db = TestDb::new(); - let src_root = SystemPathBuf::from("/src"); - - db.write_files(files) - .context("Failed to write test files")?; - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings { - custom_typeshed: Some(SystemPathBuf::from(typeshed)), - ..SearchPathSettings::new(src_root) - }, - }, - ) - .context("Failed to create Program")?; - - Ok(db) - } - - #[track_caller] - fn assert_public_ty(db: &TestDb, file_name: &str, symbol_name: &str, expected: &str) { - let file = system_path_to_file(db, file_name).expect("file to exist"); - - let ty = global_symbol_ty(db, file, symbol_name); - assert_eq!( - ty.display(db).to_string(), - expected, - "Mismatch for symbol '{symbol_name}' in '{file_name}'" - ); - } - - #[track_caller] - fn assert_scope_ty( - db: &TestDb, - file_name: &str, - scopes: &[&str], - symbol_name: &str, - expected: &str, - ) { - let file = system_path_to_file(db, file_name).expect("file to exist"); - let index = semantic_index(db, file); - let mut file_scope_id = FileScopeId::global(); - let mut scope = file_scope_id.to_scope_id(db, file); - for expected_scope_name in scopes { - file_scope_id = index - .child_scopes(file_scope_id) - .next() - .unwrap_or_else(|| panic!("scope of {expected_scope_name}")) - .0; - scope = file_scope_id.to_scope_id(db, file); - assert_eq!(scope.name(db), *expected_scope_name); - } - - let ty = symbol_ty(db, scope, symbol_name); - assert_eq!(ty.display(db).to_string(), expected); - } - - #[track_caller] - fn assert_diagnostic_messages(diagnostics: &TypeCheckDiagnostics, expected: &[&str]) { - let messages: Vec<&str> = diagnostics - .iter() - .map(|diagnostic| diagnostic.message()) - .collect(); - assert_eq!(&messages, expected); - } - - #[track_caller] - fn assert_file_diagnostics(db: &TestDb, filename: &str, expected: &[&str]) { - let file = system_path_to_file(db, filename).unwrap(); - let diagnostics = check_types(db, file); - - assert_diagnostic_messages(&diagnostics, expected); - } - - #[test] - fn from_import_with_no_module_name() -> anyhow::Result<()> { - // This test checks that invalid syntax in a `StmtImportFrom` node - // leads to the type being inferred as `Unknown` - let mut db = setup_db(); - db.write_file("src/foo.py", "from import bar")?; - assert_public_ty(&db, "src/foo.py", "bar", "Unknown"); - Ok(()) - } - - #[test] - fn resolve_base_class_by_name() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/mod.py", - " - class Base: - pass - - class Sub(Base): - pass - ", - )?; - - let mod_file = system_path_to_file(&db, "src/mod.py").expect("file to exist"); - let ty = global_symbol_ty(&db, mod_file, "Sub"); - - let class = ty.expect_class_literal(); - - let base_names: Vec<_> = class - .bases(&db) - .map(|base_ty| format!("{}", base_ty.display(&db))) - .collect(); - - assert_eq!(base_names, vec!["Literal[Base]"]); - - Ok(()) - } - - #[test] - fn resolve_method() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/mod.py", - " - class C: - def f(self): pass - ", - )?; - - let mod_file = system_path_to_file(&db, "src/mod.py").unwrap(); - let ty = global_symbol_ty(&db, mod_file, "C"); - let class_id = ty.expect_class_literal(); - let member_ty = class_id.class_member(&db, &Name::new_static("f")); - let func = member_ty.expect_function_literal(); - - assert_eq!(func.name(&db), "f"); - Ok(()) - } - - #[test] - fn not_literal_string() -> anyhow::Result<()> { - let mut db = setup_db(); - let content = format!( - r#" - v = not "{y}" - w = not 10*"{y}" - x = not "{y}"*10 - z = not 0*"{y}" - u = not (-100)*"{y}" - "#, - y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), - ); - db.write_dedented("src/a.py", &content)?; - - assert_public_ty(&db, "src/a.py", "v", "bool"); - assert_public_ty(&db, "src/a.py", "w", "bool"); - assert_public_ty(&db, "src/a.py", "x", "bool"); - assert_public_ty(&db, "src/a.py", "z", "Literal[True]"); - assert_public_ty(&db, "src/a.py", "u", "Literal[True]"); - - Ok(()) - } - - #[test] - fn multiplied_string() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - &format!( - r#" - w = 2 * "hello" - x = "goodbye" * 3 - y = "a" * {y} - z = {z} * "b" - a = 0 * "hello" - b = -3 * "hello" - "#, - y = TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE, - z = TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1 - ), - )?; - - assert_public_ty(&db, "src/a.py", "w", r#"Literal["hellohello"]"#); - assert_public_ty(&db, "src/a.py", "x", r#"Literal["goodbyegoodbyegoodbye"]"#); - assert_public_ty( - &db, - "src/a.py", - "y", - &format!( - r#"Literal["{}"]"#, - "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE) - ), - ); - assert_public_ty(&db, "src/a.py", "z", "LiteralString"); - assert_public_ty(&db, "src/a.py", "a", r#"Literal[""]"#); - assert_public_ty(&db, "src/a.py", "b", r#"Literal[""]"#); - - Ok(()) - } - - #[test] - fn multiplied_literal_string() -> anyhow::Result<()> { - let mut db = setup_db(); - let content = format!( - r#" - v = "{y}" - w = 10*"{y}" - x = "{y}"*10 - z = 0*"{y}" - u = (-100)*"{y}" - "#, - y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), - ); - db.write_dedented("src/a.py", &content)?; - - assert_public_ty(&db, "src/a.py", "v", "LiteralString"); - assert_public_ty(&db, "src/a.py", "w", "LiteralString"); - assert_public_ty(&db, "src/a.py", "x", "LiteralString"); - assert_public_ty(&db, "src/a.py", "z", r#"Literal[""]"#); - assert_public_ty(&db, "src/a.py", "u", r#"Literal[""]"#); - Ok(()) - } - - #[test] - fn truncated_string_literals_become_literal_string() -> anyhow::Result<()> { - let mut db = setup_db(); - let content = format!( - r#" - w = "{y}" - x = "a" + "{z}" - "#, - y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), - z = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE), - ); - db.write_dedented("src/a.py", &content)?; - - assert_public_ty(&db, "src/a.py", "w", "LiteralString"); - assert_public_ty(&db, "src/a.py", "x", "LiteralString"); - - Ok(()) - } - - #[test] - fn adding_string_literals_and_literal_string() -> anyhow::Result<()> { - let mut db = setup_db(); - let content = format!( - r#" - v = "{y}" - w = "{y}" + "a" - x = "a" + "{y}" - z = "{y}" + "{y}" - "#, - y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), - ); - db.write_dedented("src/a.py", &content)?; - - assert_public_ty(&db, "src/a.py", "v", "LiteralString"); - assert_public_ty(&db, "src/a.py", "w", "LiteralString"); - assert_public_ty(&db, "src/a.py", "x", "LiteralString"); - assert_public_ty(&db, "src/a.py", "z", "LiteralString"); - - Ok(()) - } - - #[test] - fn bytes_type() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - w = b'red' b'knot' - x = b'hello' - y = b'world' + b'!' - z = b'\\xff\\x00' - ", - )?; - - assert_public_ty(&db, "src/a.py", "w", "Literal[b\"redknot\"]"); - assert_public_ty(&db, "src/a.py", "x", "Literal[b\"hello\"]"); - assert_public_ty(&db, "src/a.py", "y", "Literal[b\"world!\"]"); - assert_public_ty(&db, "src/a.py", "z", "Literal[b\"\\xff\\x00\"]"); - - Ok(()) - } - - #[test] - fn ellipsis_type() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - x = ... - ", - )?; - - // TODO: sys.version_info, and need to understand @final and @type_check_only - assert_public_ty(&db, "src/a.py", "x", "EllipsisType | Unknown"); - - Ok(()) - } - - #[test] - fn function_return_type() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_file("src/a.py", "def example() -> int: return 42")?; - - let mod_file = system_path_to_file(&db, "src/a.py").unwrap(); - let function = global_symbol_ty(&db, mod_file, "example").expect_function_literal(); - let returns = function.return_type(&db); - assert_eq!(returns.display(&db).to_string(), "int"); - - Ok(()) - } - - #[test] - fn import_cycle() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - class A: pass - import b - class C(b.B): pass - ", - )?; - db.write_dedented( - "src/b.py", - " - from a import A - class B(A): pass - ", - )?; - - let a = system_path_to_file(&db, "src/a.py").expect("file to exist"); - let c_ty = global_symbol_ty(&db, a, "C"); - let c_class = c_ty.expect_class_literal(); - let mut c_bases = c_class.bases(&db); - let b_ty = c_bases.next().unwrap(); - let b_class = b_ty.expect_class_literal(); - assert_eq!(b_class.name(&db), "B"); - let mut b_bases = b_class.bases(&db); - let a_ty = b_bases.next().unwrap(); - let a_class = a_ty.expect_class_literal(); - assert_eq!(a_class.name(&db), "A"); - - Ok(()) - } - - /// An unbound function local that has definitions in the scope does not fall back to globals. - #[test] - fn unbound_function_local() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - x = 1 - def f(): - y = x - x = 2 - ", - )?; - - let file = system_path_to_file(&db, "src/a.py").expect("file to exist"); - let index = semantic_index(&db, file); - let function_scope = index - .child_scopes(FileScopeId::global()) - .next() - .unwrap() - .0 - .to_scope_id(&db, file); - let y_ty = symbol_ty(&db, function_scope, "y"); - let x_ty = symbol_ty(&db, function_scope, "x"); - - assert_eq!(y_ty.display(&db).to_string(), "Unbound"); - assert_eq!(x_ty.display(&db).to_string(), "Literal[2]"); - - Ok(()) - } - - /// A name reference to a never-defined symbol in a function is implicitly a global lookup. - #[test] - fn implicit_global_in_function() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - x = 1 - def f(): - y = x - ", - )?; - - let file = system_path_to_file(&db, "src/a.py").expect("file to exist"); - let index = semantic_index(&db, file); - let function_scope = index - .child_scopes(FileScopeId::global()) - .next() - .unwrap() - .0 - .to_scope_id(&db, file); - let y_ty = symbol_ty(&db, function_scope, "y"); - let x_ty = symbol_ty(&db, function_scope, "x"); - - assert_eq!(x_ty.display(&db).to_string(), "Unbound"); - assert_eq!(y_ty.display(&db).to_string(), "Literal[1]"); - - Ok(()) - } - - #[test] - fn local_inference() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_file("/src/a.py", "x = 10")?; - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - - let parsed = parsed_module(&db, a); - - let statement = parsed.suite().first().unwrap().as_assign_stmt().unwrap(); - let model = SemanticModel::new(&db, a); - - let literal_ty = statement.value.ty(&model); - - assert_eq!(format!("{}", literal_ty.display(&db)), "Literal[10]"); - - Ok(()) - } - - #[test] - fn builtin_symbol_vendored_stdlib() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_file("/src/a.py", "c = copyright")?; - - assert_public_ty(&db, "/src/a.py", "c", "Literal[copyright]"); - - Ok(()) - } - - #[test] - fn builtin_symbol_custom_stdlib() -> anyhow::Result<()> { - let db = setup_db_with_custom_typeshed( - "/typeshed", - [ - ("/src/a.py", "c = copyright"), - ( - "/typeshed/stdlib/builtins.pyi", - "def copyright() -> None: ...", - ), - ("/typeshed/stdlib/VERSIONS", "builtins: 3.8-"), - ], - )?; - - assert_public_ty(&db, "/src/a.py", "c", "Literal[copyright]"); - - Ok(()) - } - - #[test] - fn unknown_builtin_later_defined() -> anyhow::Result<()> { - let db = setup_db_with_custom_typeshed( - "/typeshed", - [ - ("/src/a.py", "x = foo"), - ("/typeshed/stdlib/builtins.pyi", "foo = bar; bar = 1"), - ("/typeshed/stdlib/VERSIONS", "builtins: 3.8-"), - ], - )?; - - assert_public_ty(&db, "/src/a.py", "x", "Unbound"); - - Ok(()) - } - - #[test] - fn str_builtin() -> anyhow::Result<()> { - let mut db = setup_db(); - db.write_file("/src/a.py", "x = str")?; - assert_public_ty(&db, "/src/a.py", "x", "Literal[str]"); - Ok(()) - } - - #[test] - fn deferred_annotation_builtin() -> anyhow::Result<()> { - let mut db = setup_db(); - db.write_file("/src/a.pyi", "class C(object): pass")?; - let file = system_path_to_file(&db, "/src/a.pyi").unwrap(); - let ty = global_symbol_ty(&db, file, "C"); - - let base = ty - .expect_class_literal() - .bases(&db) - .next() - .expect("there should be at least one base"); - - assert_eq!(base.display(&db).to_string(), "Literal[object]"); - - Ok(()) - } - - #[test] - fn deferred_annotation_in_stubs_always_resolve() -> anyhow::Result<()> { - let mut db = setup_db(); - - // Stub files should always resolve deferred annotations - db.write_dedented( - "/src/stub.pyi", - " - def get_foo() -> Foo: ... - class Foo: ... - foo = get_foo() - ", - )?; - assert_public_ty(&db, "/src/stub.pyi", "foo", "Foo"); - - Ok(()) - } - - #[test] - fn deferred_annotations_regular_source_fails() -> anyhow::Result<()> { - let mut db = setup_db(); - - // In (regular) source files, deferred annotations are *not* resolved - // Also tests imports from `__future__` that are not annotations - db.write_dedented( - "/src/source.py", - " - from __future__ import with_statement as annotations - def get_foo() -> Foo: ... - class Foo: ... - foo = get_foo() - ", - )?; - assert_public_ty(&db, "/src/source.py", "foo", "Unknown"); - - Ok(()) - } - - #[test] - fn deferred_annotation_in_sources_with_future_resolves() -> anyhow::Result<()> { - let mut db = setup_db(); - - // In source files with `__future__.annotations`, deferred annotations are resolved - db.write_dedented( - "/src/source_with_future.py", - " - from __future__ import annotations - def get_foo() -> Foo: ... - class Foo: ... - foo = get_foo() - ", - )?; - assert_public_ty(&db, "/src/source_with_future.py", "foo", "Foo"); - - Ok(()) - } - - #[test] - fn nonlocal_name_reference() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "/src/a.py", - " - def f(): - x = 1 - def g(): - y = x - ", - )?; - - assert_scope_ty(&db, "/src/a.py", &["f", "g"], "y", "Literal[1]"); - - Ok(()) - } - - #[test] - fn nonlocal_name_reference_multi_level() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "/src/a.py", - " - def f(): - x = 1 - def g(): - def h(): - y = x - ", - )?; - - assert_scope_ty(&db, "/src/a.py", &["f", "g", "h"], "y", "Literal[1]"); - - Ok(()) - } - - #[test] - fn nonlocal_name_reference_skips_class_scope() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "/src/a.py", - " - def f(): - x = 1 - class C: - x = 2 - def g(): - y = x - ", - )?; - - assert_scope_ty(&db, "/src/a.py", &["f", "C", "g"], "y", "Literal[1]"); - - Ok(()) - } - - #[test] - fn nonlocal_name_reference_skips_annotation_only_assignment() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "/src/a.py", - " - def f(): - x = 1 - def g(): - // it's pretty weird to have an annotated assignment in a function where the - // name is otherwise not defined; maybe should be an error? - x: int - def h(): - y = x - ", - )?; - - assert_scope_ty(&db, "/src/a.py", &["f", "g", "h"], "y", "Literal[1]"); - - Ok(()) - } - - #[test] - fn exception_handler_with_invalid_syntax() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - from typing_extensions import reveal_type - - try: - print - except as e: - reveal_type(e) - ", - )?; - - assert_file_diagnostics(&db, "src/a.py", &["Revealed type is `Unknown`"]); - - Ok(()) - } - - #[test] - fn basic_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [x for y in IterableOfIterables() for x in y] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - - class IteratorOfIterables: - def __next__(self) -> IntIterable: - return IntIterable() - - class IterableOfIterables: - def __iter__(self) -> IteratorOfIterables: - return IteratorOfIterables() - ", - )?; - - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "int"); - assert_scope_ty(&db, "src/a.py", &["foo", ""], "y", "IntIterable"); - - Ok(()) - } - - #[test] - fn comprehension_inside_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [[x for x in iter1] for y in iter2] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - - iter1 = IntIterable() - iter2 = IntIterable() - ", - )?; - - assert_scope_ty( - &db, - "src/a.py", - &["foo", "", ""], - "x", - "int", - ); - assert_scope_ty(&db, "src/a.py", &["foo", ""], "y", "int"); - - Ok(()) - } - - #[test] - fn inner_comprehension_referencing_outer_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [[x for x in y] for y in z] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - - class IteratorOfIterables: - def __next__(self) -> IntIterable: - return IntIterable() - - class IterableOfIterables: - def __iter__(self) -> IteratorOfIterables: - return IteratorOfIterables() - - z = IterableOfIterables() - ", - )?; - - assert_scope_ty( - &db, - "src/a.py", - &["foo", "", ""], - "x", - "int", - ); - assert_scope_ty(&db, "src/a.py", &["foo", ""], "y", "IntIterable"); - - Ok(()) - } - - #[test] - fn comprehension_with_unbound_iter() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented("src/a.py", "[z for z in x]")?; - - assert_scope_ty(&db, "src/a.py", &[""], "x", "Unbound"); - - // Iterating over an `Unbound` yields `Unknown`: - assert_scope_ty(&db, "src/a.py", &[""], "z", "Unknown"); - - // TODO: not the greatest error message in the world! --Alex - assert_file_diagnostics( - &db, - "src/a.py", - &[ - "Name `x` used when not defined", - "Object of type `Unbound` is not iterable", - ], - ); - - Ok(()) - } - - #[test] - fn comprehension_with_not_iterable_iter_in_second_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [z for x in IntIterable() for z in x] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - ", - )?; - - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "int"); - assert_scope_ty(&db, "src/a.py", &["foo", ""], "z", "Unknown"); - assert_file_diagnostics(&db, "src/a.py", &["Object of type `int` is not iterable"]); - - Ok(()) - } - - #[test] - fn dict_comprehension_variable_key() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - {x: 0 for x in IntIterable()} - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - ", - )?; - - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "int"); - assert_file_diagnostics(&db, "src/a.py", &[]); - - Ok(()) - } - - #[test] - fn dict_comprehension_variable_value() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - {0: x for x in IntIterable()} - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - ", - )?; - - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "int"); - assert_file_diagnostics(&db, "src/a.py", &[]); - - Ok(()) - } - - #[test] - fn comprehension_with_missing_in_keyword() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [z for z IntIterable()] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - ", - )?; - - // We'll emit a diagnostic separately for invalid syntax, - // but it's reasonably clear here what they *meant* to write, - // so we'll still infer the correct type: - assert_scope_ty(&db, "src/a.py", &["foo", ""], "z", "int"); - Ok(()) - } - - #[test] - fn comprehension_with_missing_iter() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - def foo(): - [z for in IntIterable()] - - class IntIterator: - def __next__(self) -> int: - return 42 - - class IntIterable: - def __iter__(self) -> IntIterator: - return IntIterator() - ", - )?; - - assert_scope_ty(&db, "src/a.py", &["foo", ""], "z", "Unbound"); - - // (There is a diagnostic for invalid syntax that's emitted, but it's not listed by `assert_file_diagnostics`) - assert_file_diagnostics(&db, "src/a.py", &["Name `z` used when not defined"]); - - Ok(()) - } - - #[test] - fn comprehension_with_missing_for() -> anyhow::Result<()> { - let mut db = setup_db(); - db.write_dedented("src/a.py", "[z for z in]")?; - assert_scope_ty(&db, "src/a.py", &[""], "z", "Unknown"); - Ok(()) - } - - #[test] - fn comprehension_with_missing_in_keyword_and_missing_iter() -> anyhow::Result<()> { - let mut db = setup_db(); - db.write_dedented("src/a.py", "[z for z]")?; - assert_scope_ty(&db, "src/a.py", &[""], "z", "Unknown"); - Ok(()) - } - - /// This tests that we understand that `async` comprehensions - /// do not work according to the synchronous iteration protocol - #[test] - fn invalid_async_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - async def foo(): - [x async for x in Iterable()] - class Iterator: - def __next__(self) -> int: - return 42 - class Iterable: - def __iter__(self) -> Iterator: - return Iterator() - ", - )?; - - // We currently return `Todo` for all async comprehensions, - // including comprehensions that have invalid syntax - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "@Todo"); - - Ok(()) - } - - #[test] - fn basic_async_comprehension() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - async def foo(): - [x async for x in AsyncIterable()] - class AsyncIterator: - async def __anext__(self) -> int: - return 42 - class AsyncIterable: - def __aiter__(self) -> AsyncIterator: - return AsyncIterator() - ", - )?; - - // TODO async iterables/iterators! --Alex - assert_scope_ty(&db, "src/a.py", &["foo", ""], "x", "@Todo"); - - Ok(()) - } - - #[test] - fn starred_expressions_must_be_iterable() { - let mut db = setup_db(); - - db.write_dedented( - "src/a.py", - " - class NotIterable: pass - - class Iterator: - def __next__(self) -> int: - return 42 - - class Iterable: - def __iter__(self) -> Iterator: - - x = [*NotIterable()] - y = [*Iterable()] - ", - ) - .unwrap(); - - assert_file_diagnostics( - &db, - "/src/a.py", - &["Object of type `NotIterable` is not iterable"], - ); - } - - // Incremental inference tests - - fn first_public_binding<'db>(db: &'db TestDb, file: File, name: &str) -> Definition<'db> { - let scope = global_scope(db, file); - use_def_map(db, scope) - .public_bindings(symbol_table(db, scope).symbol_id_by_name(name).unwrap()) - .next() - .unwrap() - .binding - } - - #[test] - fn dependency_public_symbol_type_change() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_files([ - ("/src/a.py", "from foo import x"), - ("/src/foo.py", "x = 10\ndef foo(): ..."), - ])?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - let x_ty = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty.display(&db).to_string(), "Literal[10]"); - - // Change `x` to a different value - db.write_file("/src/foo.py", "x = 20\ndef foo(): ...")?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - - let x_ty_2 = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty_2.display(&db).to_string(), "Literal[20]"); - - Ok(()) - } - - #[test] - fn dependency_internal_symbol_change() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_files([ - ("/src/a.py", "from foo import x"), - ("/src/foo.py", "x = 10\ndef foo(): y = 1"), - ])?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - let x_ty = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty.display(&db).to_string(), "Literal[10]"); - - db.write_file("/src/foo.py", "x = 10\ndef foo(): pass")?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - - db.clear_salsa_events(); - - let x_ty_2 = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty_2.display(&db).to_string(), "Literal[10]"); - - let events = db.take_salsa_events(); - - assert_function_query_was_not_run( - &db, - infer_definition_types, - first_public_binding(&db, a, "x"), - &events, - ); - - Ok(()) - } - - #[test] - fn dependency_unrelated_symbol() -> anyhow::Result<()> { - let mut db = setup_db(); - - db.write_files([ - ("/src/a.py", "from foo import x"), - ("/src/foo.py", "x = 10\ny = 20"), - ])?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - let x_ty = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty.display(&db).to_string(), "Literal[10]"); - - db.write_file("/src/foo.py", "x = 10\ny = 30")?; - - let a = system_path_to_file(&db, "/src/a.py").unwrap(); - - db.clear_salsa_events(); - - let x_ty_2 = global_symbol_ty(&db, a, "x"); - - assert_eq!(x_ty_2.display(&db).to_string(), "Literal[10]"); - - let events = db.take_salsa_events(); - - assert_function_query_was_not_run( - &db, - infer_definition_types, - first_public_binding(&db, a, "x"), - &events, - ); - Ok(()) - } -} diff --git a/crates/red_knot_python_semantic/src/types/narrow.rs b/crates/red_knot_python_semantic/src/types/narrow.rs deleted file mode 100644 index 57798a9427ea2..0000000000000 --- a/crates/red_knot_python_semantic/src/types/narrow.rs +++ /dev/null @@ -1,326 +0,0 @@ -use crate::semantic_index::ast_ids::HasScopedAstId; -use crate::semantic_index::constraint::{Constraint, ConstraintNode, PatternConstraint}; -use crate::semantic_index::definition::Definition; -use crate::semantic_index::expression::Expression; -use crate::semantic_index::symbol::{ScopeId, ScopedSymbolId, SymbolTable}; -use crate::semantic_index::symbol_table; -use crate::types::{ - infer_expression_types, IntersectionBuilder, KnownFunction, Type, UnionBuilder, -}; -use crate::Db; -use itertools::Itertools; -use ruff_python_ast as ast; -use rustc_hash::FxHashMap; -use std::sync::Arc; - -/// Return the type constraint that `test` (if true) would place on `definition`, if any. -/// -/// For example, if we have this code: -/// -/// ```python -/// y = 1 if flag else None -/// x = 1 if flag else None -/// if x is not None: -/// ... -/// ``` -/// -/// The `test` expression `x is not None` places the constraint "not None" on the definition of -/// `x`, so in that case we'd return `Some(Type::Intersection(negative=[Type::None]))`. -/// -/// But if we called this with the same `test` expression, but the `definition` of `y`, no -/// constraint is applied to that definition, so we'd just return `None`. -pub(crate) fn narrowing_constraint<'db>( - db: &'db dyn Db, - constraint: Constraint<'db>, - definition: Definition<'db>, -) -> Option> { - match constraint.node { - ConstraintNode::Expression(expression) => { - if constraint.is_positive { - all_narrowing_constraints_for_expression(db, expression) - .get(&definition.symbol(db)) - .copied() - } else { - all_negative_narrowing_constraints_for_expression(db, expression) - .get(&definition.symbol(db)) - .copied() - } - } - ConstraintNode::Pattern(pattern) => all_narrowing_constraints_for_pattern(db, pattern) - .get(&definition.symbol(db)) - .copied(), - } -} - -#[salsa::tracked(return_ref)] -fn all_narrowing_constraints_for_pattern<'db>( - db: &'db dyn Db, - pattern: PatternConstraint<'db>, -) -> NarrowingConstraints<'db> { - NarrowingConstraintsBuilder::new(db, ConstraintNode::Pattern(pattern), true).finish() -} - -#[salsa::tracked(return_ref)] -fn all_narrowing_constraints_for_expression<'db>( - db: &'db dyn Db, - expression: Expression<'db>, -) -> NarrowingConstraints<'db> { - NarrowingConstraintsBuilder::new(db, ConstraintNode::Expression(expression), true).finish() -} - -#[salsa::tracked(return_ref)] -fn all_negative_narrowing_constraints_for_expression<'db>( - db: &'db dyn Db, - expression: Expression<'db>, -) -> NarrowingConstraints<'db> { - NarrowingConstraintsBuilder::new(db, ConstraintNode::Expression(expression), false).finish() -} - -/// Generate a constraint from the *type* of the second argument of an `isinstance` call. -/// -/// Example: for `isinstance(…, str)`, we would infer `Type::ClassLiteral(str)` from the -/// second argument, but we need to generate a `Type::Instance(str)` constraint that can -/// be used to narrow down the type of the first argument. -fn generate_isinstance_constraint<'db>( - db: &'db dyn Db, - classinfo: &Type<'db>, -) -> Option> { - match classinfo { - Type::ClassLiteral(class) => Some(Type::Instance(*class)), - Type::Tuple(tuple) => { - let mut builder = UnionBuilder::new(db); - for element in tuple.elements(db) { - builder = builder.add(generate_isinstance_constraint(db, element)?); - } - Some(builder.build()) - } - _ => None, - } -} - -type NarrowingConstraints<'db> = FxHashMap>; - -struct NarrowingConstraintsBuilder<'db> { - db: &'db dyn Db, - constraint: ConstraintNode<'db>, - is_positive: bool, - constraints: NarrowingConstraints<'db>, -} - -impl<'db> NarrowingConstraintsBuilder<'db> { - fn new(db: &'db dyn Db, constraint: ConstraintNode<'db>, is_positive: bool) -> Self { - Self { - db, - constraint, - is_positive, - constraints: NarrowingConstraints::default(), - } - } - - fn finish(mut self) -> NarrowingConstraints<'db> { - match self.constraint { - ConstraintNode::Expression(expression) => { - self.evaluate_expression_constraint(expression, self.is_positive); - } - ConstraintNode::Pattern(pattern) => self.evaluate_pattern_constraint(pattern), - } - self.constraints.shrink_to_fit(); - self.constraints - } - - fn evaluate_expression_constraint(&mut self, expression: Expression<'db>, is_positive: bool) { - let expression_node = expression.node_ref(self.db).node(); - self.evaluate_expression_node_constraint(expression_node, expression, is_positive); - } - - fn evaluate_expression_node_constraint( - &mut self, - expression_node: &ruff_python_ast::Expr, - expression: Expression<'db>, - is_positive: bool, - ) { - match expression_node { - ast::Expr::Compare(expr_compare) => { - self.add_expr_compare(expr_compare, expression, is_positive); - } - ast::Expr::Call(expr_call) => { - self.add_expr_call(expr_call, expression, is_positive); - } - ast::Expr::UnaryOp(unary_op) if unary_op.op == ast::UnaryOp::Not => { - self.evaluate_expression_node_constraint( - &unary_op.operand, - expression, - !is_positive, - ); - } - _ => {} // TODO other test expression kinds - } - } - - fn evaluate_pattern_constraint(&mut self, pattern: PatternConstraint<'db>) { - let subject = pattern.subject(self.db); - - match pattern.pattern(self.db).node() { - ast::Pattern::MatchValue(_) => { - // TODO - } - ast::Pattern::MatchSingleton(singleton_pattern) => { - self.add_match_pattern_singleton(subject, singleton_pattern); - } - ast::Pattern::MatchSequence(_) => { - // TODO - } - ast::Pattern::MatchMapping(_) => { - // TODO - } - ast::Pattern::MatchClass(_) => { - // TODO - } - ast::Pattern::MatchStar(_) => { - // TODO - } - ast::Pattern::MatchAs(_) => { - // TODO - } - ast::Pattern::MatchOr(_) => { - // TODO - } - } - } - - fn symbols(&self) -> Arc { - symbol_table(self.db, self.scope()) - } - - fn scope(&self) -> ScopeId<'db> { - match self.constraint { - ConstraintNode::Expression(expression) => expression.scope(self.db), - ConstraintNode::Pattern(pattern) => pattern.scope(self.db), - } - } - - fn add_expr_compare( - &mut self, - expr_compare: &ast::ExprCompare, - expression: Expression<'db>, - is_positive: bool, - ) { - let ast::ExprCompare { - range: _, - left, - ops, - comparators, - } = expr_compare; - if !left.is_name_expr() && comparators.iter().all(|c| !c.is_name_expr()) { - // If none of the comparators are name expressions, - // we have no symbol to narrow down the type of. - return; - } - if !is_positive && comparators.len() > 1 { - // We can't negate a constraint made by a multi-comparator expression, since we can't - // know which comparison part is the one being negated. - // For example, the negation of `x is 1 is y is 2`, would be `(x is not 1) or (y is not 1) or (y is not 2)` - // and that requires cross-symbol constraints, which we don't support yet. - return; - } - let scope = self.scope(); - let inference = infer_expression_types(self.db, expression); - - let comparator_tuples = std::iter::once(&**left) - .chain(comparators) - .tuple_windows::<(&ruff_python_ast::Expr, &ruff_python_ast::Expr)>(); - for (op, (left, right)) in std::iter::zip(&**ops, comparator_tuples) { - if let ast::Expr::Name(ast::ExprName { - range: _, - id, - ctx: _, - }) = left - { - // SAFETY: we should always have a symbol for every Name node. - let symbol = self.symbols().symbol_id_by_name(id).unwrap(); - let rhs_ty = inference.expression_ty(right.scoped_ast_id(self.db, scope)); - - match if is_positive { *op } else { op.negate() } { - ast::CmpOp::IsNot => { - if rhs_ty.is_singleton() { - let ty = IntersectionBuilder::new(self.db) - .add_negative(rhs_ty) - .build(); - self.constraints.insert(symbol, ty); - } else { - // Non-singletons cannot be safely narrowed using `is not` - } - } - ast::CmpOp::Is => { - self.constraints.insert(symbol, rhs_ty); - } - ast::CmpOp::NotEq => { - if rhs_ty.is_single_valued(self.db) { - let ty = IntersectionBuilder::new(self.db) - .add_negative(rhs_ty) - .build(); - self.constraints.insert(symbol, ty); - } - } - _ => { - // TODO other comparison types - } - } - } - } - } - - fn add_expr_call( - &mut self, - expr_call: &ast::ExprCall, - expression: Expression<'db>, - is_positive: bool, - ) { - let scope = self.scope(); - let inference = infer_expression_types(self.db, expression); - - if let Some(func_type) = inference - .expression_ty(expr_call.func.scoped_ast_id(self.db, scope)) - .into_function_literal_type() - { - if func_type.is_known(self.db, KnownFunction::IsInstance) - && expr_call.arguments.keywords.is_empty() - { - if let [ast::Expr::Name(ast::ExprName { id, .. }), rhs] = &*expr_call.arguments.args - { - let symbol = self.symbols().symbol_id_by_name(id).unwrap(); - - let rhs_type = inference.expression_ty(rhs.scoped_ast_id(self.db, scope)); - - // TODO: add support for PEP 604 union types on the right hand side: - // isinstance(x, str | (int | float)) - if let Some(mut constraint) = generate_isinstance_constraint(self.db, &rhs_type) - { - if !is_positive { - constraint = constraint.negate(self.db); - } - self.constraints.insert(symbol, constraint); - } - } - } - } - } - - fn add_match_pattern_singleton( - &mut self, - subject: &ast::Expr, - pattern: &ast::PatternMatchSingleton, - ) { - if let Some(ast::ExprName { id, .. }) = subject.as_name_expr() { - // SAFETY: we should always have a symbol for every Name node. - let symbol = self.symbols().symbol_id_by_name(id).unwrap(); - - let ty = match pattern.value { - ast::Singleton::None => Type::None, - ast::Singleton::True => Type::BooleanLiteral(true), - ast::Singleton::False => Type::BooleanLiteral(false), - }; - self.constraints.insert(symbol, ty); - } - } -} diff --git a/crates/red_knot_python_semantic/src/util/subscript.rs b/crates/red_knot_python_semantic/src/util/subscript.rs deleted file mode 100644 index a88276e4b4254..0000000000000 --- a/crates/red_knot_python_semantic/src/util/subscript.rs +++ /dev/null @@ -1,83 +0,0 @@ -pub(crate) trait PythonSubscript { - type Item; - - fn python_subscript(&mut self, index: i64) -> Option; -} - -impl> PythonSubscript for T { - type Item = I; - - fn python_subscript(&mut self, index: i64) -> Option { - if index >= 0 { - self.nth(usize::try_from(index).ok()?) - } else { - let nth_rev = usize::try_from(index.checked_neg()?).ok()?.checked_sub(1)?; - self.rev().nth(nth_rev) - } - } -} - -#[cfg(test)] -#[allow(clippy::redundant_clone)] -mod tests { - use super::PythonSubscript; - - #[test] - fn python_subscript_basic() { - let iter = 'a'..='e'; - - assert_eq!(iter.clone().python_subscript(0), Some('a')); - assert_eq!(iter.clone().python_subscript(1), Some('b')); - assert_eq!(iter.clone().python_subscript(4), Some('e')); - assert_eq!(iter.clone().python_subscript(5), None); - - assert_eq!(iter.clone().python_subscript(-1), Some('e')); - assert_eq!(iter.clone().python_subscript(-2), Some('d')); - assert_eq!(iter.clone().python_subscript(-5), Some('a')); - assert_eq!(iter.clone().python_subscript(-6), None); - } - - #[test] - fn python_subscript_empty() { - let iter = 'a'..'a'; - - assert_eq!(iter.clone().python_subscript(0), None); - assert_eq!(iter.clone().python_subscript(1), None); - assert_eq!(iter.clone().python_subscript(-1), None); - } - - #[test] - fn python_subscript_single_element() { - let iter = 'a'..='a'; - - assert_eq!(iter.clone().python_subscript(0), Some('a')); - assert_eq!(iter.clone().python_subscript(1), None); - assert_eq!(iter.clone().python_subscript(-1), Some('a')); - assert_eq!(iter.clone().python_subscript(-2), None); - } - - #[test] - fn python_subscript_uses_full_index_range() { - let iter = 0..=u64::MAX; - - assert_eq!(iter.clone().python_subscript(0), Some(0)); - assert_eq!(iter.clone().python_subscript(1), Some(1)); - assert_eq!( - iter.clone().python_subscript(i64::MAX), - Some(i64::MAX as u64) - ); - - assert_eq!(iter.clone().python_subscript(-1), Some(u64::MAX)); - assert_eq!(iter.clone().python_subscript(-2), Some(u64::MAX - 1)); - - // i64::MIN is not representable as a positive number, so it is not - // a valid index: - assert_eq!(iter.clone().python_subscript(i64::MIN), None); - - // but i64::MIN +1 is: - assert_eq!( - iter.clone().python_subscript(i64::MIN + 1), - Some(2u64.pow(63) + 1) - ); - } -} diff --git a/crates/red_knot_python_semantic/tests/mdtest.rs b/crates/red_knot_python_semantic/tests/mdtest.rs deleted file mode 100644 index 74e07e65455a5..0000000000000 --- a/crates/red_knot_python_semantic/tests/mdtest.rs +++ /dev/null @@ -1,24 +0,0 @@ -use dir_test::{dir_test, Fixture}; -use red_knot_test::run; -use std::path::Path; - -/// See `crates/red_knot_test/README.md` for documentation on these tests. -#[dir_test( - dir: "$CARGO_MANIFEST_DIR/resources/mdtest", - glob: "**/*.md" -)] -#[allow(clippy::needless_pass_by_value)] -fn mdtest(fixture: Fixture<&str>) { - let path = fixture.path(); - - let crate_dir = Path::new(env!("CARGO_MANIFEST_DIR")) - .join("resources/mdtest") - .canonicalize() - .unwrap(); - - let relative_path = path - .strip_prefix(crate_dir.to_str().unwrap()) - .unwrap_or(path); - - run(Path::new(path), relative_path); -} diff --git a/crates/red_knot_server/Cargo.toml b/crates/red_knot_server/Cargo.toml deleted file mode 100644 index a2bfef6c3c8e6..0000000000000 --- a/crates/red_knot_server/Cargo.toml +++ /dev/null @@ -1,39 +0,0 @@ -[package] -name = "red_knot_server" -version = "0.0.0" -publish = false -authors = { workspace = true } -edition = { workspace = true } -rust-version = { workspace = true } -homepage = { workspace = true } -documentation = { workspace = true } -repository = { workspace = true } -license = { workspace = true } - -[dependencies] -red_knot_workspace = { workspace = true } -ruff_db = { workspace = true } -ruff_notebook = { workspace = true } -ruff_python_ast = { workspace = true } -ruff_source_file = { workspace = true } -ruff_text_size = { workspace = true } - -anyhow = { workspace = true } -crossbeam = { workspace = true } -jod-thread = { workspace = true } -lsp-server = { workspace = true } -lsp-types = { workspace = true } -rustc-hash = { workspace = true } -serde = { workspace = true } -serde_json = { workspace = true } -shellexpand = { workspace = true } -tracing = { workspace = true } -tracing-subscriber = { workspace = true } - -[dev-dependencies] - -[target.'cfg(target_vendor = "apple")'.dependencies] -libc = { workspace = true } - -[lints] -workspace = true diff --git a/crates/red_knot_server/src/edit.rs b/crates/red_knot_server/src/edit.rs deleted file mode 100644 index 94cf84c282118..0000000000000 --- a/crates/red_knot_server/src/edit.rs +++ /dev/null @@ -1,80 +0,0 @@ -//! Types and utilities for working with text, modifying source files, and `Ruff <-> LSP` type conversion. - -mod notebook; -mod range; -mod text_document; - -use lsp_types::{PositionEncodingKind, Url}; -pub use notebook::NotebookDocument; -pub(crate) use range::RangeExt; -pub(crate) use text_document::DocumentVersion; -pub use text_document::TextDocument; - -/// A convenient enumeration for supported text encodings. Can be converted to [`lsp_types::PositionEncodingKind`]. -// Please maintain the order from least to greatest priority for the derived `Ord` impl. -#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)] -pub enum PositionEncoding { - /// UTF 16 is the encoding supported by all LSP clients. - #[default] - UTF16, - - /// Second choice because UTF32 uses a fixed 4 byte encoding for each character (makes conversion relatively easy) - UTF32, - - /// Ruff's preferred encoding - UTF8, -} - -/// A unique document ID, derived from a URL passed as part of an LSP request. -/// This document ID can point to either be a standalone Python file, a full notebook, or a cell within a notebook. -#[derive(Clone, Debug)] -pub enum DocumentKey { - Notebook(Url), - NotebookCell(Url), - Text(Url), -} - -impl DocumentKey { - /// Returns the URL associated with the key. - pub(crate) fn url(&self) -> &Url { - match self { - DocumentKey::NotebookCell(url) - | DocumentKey::Notebook(url) - | DocumentKey::Text(url) => url, - } - } -} - -impl std::fmt::Display for DocumentKey { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - Self::NotebookCell(url) | Self::Notebook(url) | Self::Text(url) => url.fmt(f), - } - } -} - -impl From for lsp_types::PositionEncodingKind { - fn from(value: PositionEncoding) -> Self { - match value { - PositionEncoding::UTF8 => lsp_types::PositionEncodingKind::UTF8, - PositionEncoding::UTF16 => lsp_types::PositionEncodingKind::UTF16, - PositionEncoding::UTF32 => lsp_types::PositionEncodingKind::UTF32, - } - } -} - -impl TryFrom<&lsp_types::PositionEncodingKind> for PositionEncoding { - type Error = (); - - fn try_from(value: &PositionEncodingKind) -> Result { - Ok(if value == &PositionEncodingKind::UTF8 { - PositionEncoding::UTF8 - } else if value == &PositionEncodingKind::UTF16 { - PositionEncoding::UTF16 - } else if value == &PositionEncodingKind::UTF32 { - PositionEncoding::UTF32 - } else { - return Err(()); - }) - } -} diff --git a/crates/red_knot_server/src/edit/notebook.rs b/crates/red_knot_server/src/edit/notebook.rs deleted file mode 100644 index eb716972a94eb..0000000000000 --- a/crates/red_knot_server/src/edit/notebook.rs +++ /dev/null @@ -1,240 +0,0 @@ -use anyhow::Ok; -use lsp_types::NotebookCellKind; -use ruff_notebook::CellMetadata; -use rustc_hash::{FxBuildHasher, FxHashMap}; - -use crate::{PositionEncoding, TextDocument}; - -use super::DocumentVersion; - -pub(super) type CellId = usize; - -/// The state of a notebook document in the server. Contains an array of cells whose -/// contents are internally represented by [`TextDocument`]s. -#[derive(Clone, Debug)] -pub struct NotebookDocument { - cells: Vec, - metadata: ruff_notebook::RawNotebookMetadata, - version: DocumentVersion, - // Used to quickly find the index of a cell for a given URL. - cell_index: FxHashMap, -} - -/// A single cell within a notebook, which has text contents represented as a `TextDocument`. -#[derive(Clone, Debug)] -struct NotebookCell { - url: lsp_types::Url, - kind: NotebookCellKind, - document: TextDocument, -} - -impl NotebookDocument { - pub fn new( - version: DocumentVersion, - cells: Vec, - metadata: serde_json::Map, - cell_documents: Vec, - ) -> crate::Result { - let mut cell_contents: FxHashMap<_, _> = cell_documents - .into_iter() - .map(|document| (document.uri, document.text)) - .collect(); - - let cells: Vec<_> = cells - .into_iter() - .map(|cell| { - let contents = cell_contents.remove(&cell.document).unwrap_or_default(); - NotebookCell::new(cell, contents, version) - }) - .collect(); - - Ok(Self { - version, - cell_index: Self::make_cell_index(cells.as_slice()), - metadata: serde_json::from_value(serde_json::Value::Object(metadata))?, - cells, - }) - } - - /// Generates a pseudo-representation of a notebook that lacks per-cell metadata and contextual information - /// but should still work with Ruff's linter. - pub fn make_ruff_notebook(&self) -> ruff_notebook::Notebook { - let cells = self - .cells - .iter() - .map(|cell| match cell.kind { - NotebookCellKind::Code => ruff_notebook::Cell::Code(ruff_notebook::CodeCell { - execution_count: None, - id: None, - metadata: CellMetadata::default(), - outputs: vec![], - source: ruff_notebook::SourceValue::String( - cell.document.contents().to_string(), - ), - }), - NotebookCellKind::Markup => { - ruff_notebook::Cell::Markdown(ruff_notebook::MarkdownCell { - attachments: None, - id: None, - metadata: CellMetadata::default(), - source: ruff_notebook::SourceValue::String( - cell.document.contents().to_string(), - ), - }) - } - }) - .collect(); - let raw_notebook = ruff_notebook::RawNotebook { - cells, - metadata: self.metadata.clone(), - nbformat: 4, - nbformat_minor: 5, - }; - - ruff_notebook::Notebook::from_raw_notebook(raw_notebook, false) - .unwrap_or_else(|err| panic!("Server notebook document could not be converted to Ruff's notebook document format: {err}")) - } - - pub(crate) fn update( - &mut self, - cells: Option, - metadata_change: Option>, - version: DocumentVersion, - encoding: PositionEncoding, - ) -> crate::Result<()> { - self.version = version; - - if let Some(lsp_types::NotebookDocumentCellChange { - structure, - data, - text_content, - }) = cells - { - // The structural changes should be done first, as they may affect the cell index. - if let Some(structure) = structure { - let start = structure.array.start as usize; - let delete = structure.array.delete_count as usize; - - // This is required because of the way the `NotebookCell` is modelled. We include - // the `TextDocument` within the `NotebookCell` so when it's deleted, the - // corresponding `TextDocument` is removed as well. But, when cells are - // re-oredered, the change request doesn't provide the actual contents of the cell. - // Instead, it only provides that (a) these cell URIs were removed, and (b) these - // cell URIs were added. - // https://github.com/astral-sh/ruff/issues/12573 - let mut deleted_cells = FxHashMap::default(); - - // First, delete the cells and remove them from the index. - if delete > 0 { - for cell in self.cells.drain(start..start + delete) { - self.cell_index.remove(&cell.url); - deleted_cells.insert(cell.url, cell.document); - } - } - - // Second, insert the new cells with the available information. This array does not - // provide the actual contents of the cells, so we'll initialize them with empty - // contents. - for cell in structure.array.cells.into_iter().flatten().rev() { - if let Some(text_document) = deleted_cells.remove(&cell.document) { - let version = text_document.version(); - self.cells.push(NotebookCell::new( - cell, - text_document.into_contents(), - version, - )); - } else { - self.cells - .insert(start, NotebookCell::new(cell, String::new(), 0)); - } - } - - // Third, register the new cells in the index and update existing ones that came - // after the insertion. - for (index, cell) in self.cells.iter().enumerate().skip(start) { - self.cell_index.insert(cell.url.clone(), index); - } - - // Finally, update the text document that represents the cell with the actual - // contents. This should be done at the end so that both the `cells` and - // `cell_index` are updated before we start applying the changes to the cells. - if let Some(did_open) = structure.did_open { - for cell_text_document in did_open { - if let Some(cell) = self.cell_by_uri_mut(&cell_text_document.uri) { - cell.document = TextDocument::new( - cell_text_document.text, - cell_text_document.version, - ); - } - } - } - } - - if let Some(cell_data) = data { - for cell in cell_data { - if let Some(existing_cell) = self.cell_by_uri_mut(&cell.document) { - existing_cell.kind = cell.kind; - } - } - } - - if let Some(content_changes) = text_content { - for content_change in content_changes { - if let Some(cell) = self.cell_by_uri_mut(&content_change.document.uri) { - cell.document - .apply_changes(content_change.changes, version, encoding); - } - } - } - } - - if let Some(metadata_change) = metadata_change { - self.metadata = serde_json::from_value(serde_json::Value::Object(metadata_change))?; - } - - Ok(()) - } - - /// Get the current version of the notebook document. - pub(crate) fn version(&self) -> DocumentVersion { - self.version - } - - /// Get the text document representing the contents of a cell by the cell URI. - pub(crate) fn cell_document_by_uri(&self, uri: &lsp_types::Url) -> Option<&TextDocument> { - self.cells - .get(*self.cell_index.get(uri)?) - .map(|cell| &cell.document) - } - - /// Returns a list of cell URIs in the order they appear in the array. - pub(crate) fn urls(&self) -> impl Iterator { - self.cells.iter().map(|cell| &cell.url) - } - - fn cell_by_uri_mut(&mut self, uri: &lsp_types::Url) -> Option<&mut NotebookCell> { - self.cells.get_mut(*self.cell_index.get(uri)?) - } - - fn make_cell_index(cells: &[NotebookCell]) -> FxHashMap { - let mut index = FxHashMap::with_capacity_and_hasher(cells.len(), FxBuildHasher); - for (i, cell) in cells.iter().enumerate() { - index.insert(cell.url.clone(), i); - } - index - } -} - -impl NotebookCell { - pub(crate) fn new( - cell: lsp_types::NotebookCell, - contents: String, - version: DocumentVersion, - ) -> Self { - Self { - url: cell.document, - kind: cell.kind, - document: TextDocument::new(contents, version), - } - } -} diff --git a/crates/red_knot_server/src/edit/range.rs b/crates/red_knot_server/src/edit/range.rs deleted file mode 100644 index a923b0023a8d1..0000000000000 --- a/crates/red_knot_server/src/edit/range.rs +++ /dev/null @@ -1,98 +0,0 @@ -use super::PositionEncoding; -use ruff_source_file::LineIndex; -use ruff_source_file::OneIndexed; -use ruff_text_size::{TextRange, TextSize}; - -pub(crate) trait RangeExt { - fn to_text_range(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) - -> TextRange; -} - -fn u32_index_to_usize(index: u32) -> usize { - usize::try_from(index).expect("u32 fits in usize") -} - -impl RangeExt for lsp_types::Range { - fn to_text_range( - &self, - text: &str, - index: &LineIndex, - encoding: PositionEncoding, - ) -> TextRange { - let start_line = index.line_range( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.line)), - text, - ); - let end_line = index.line_range( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.line)), - text, - ); - - let (start_column_offset, end_column_offset) = match encoding { - PositionEncoding::UTF8 => ( - TextSize::new(self.start.character), - TextSize::new(self.end.character), - ), - - PositionEncoding::UTF16 => { - // Fast path for ASCII only documents - if index.is_ascii() { - ( - TextSize::new(self.start.character), - TextSize::new(self.end.character), - ) - } else { - // UTF16 encodes characters either as one or two 16 bit words. - // The position in `range` is the 16-bit word offset from the start of the line (and not the character offset) - // UTF-16 with a text that may use variable-length characters. - ( - utf8_column_offset(self.start.character, &text[start_line]), - utf8_column_offset(self.end.character, &text[end_line]), - ) - } - } - PositionEncoding::UTF32 => { - // UTF-32 uses 4 bytes for each character. Meaning, the position in range is a character offset. - return TextRange::new( - index.offset( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.line)), - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.character)), - text, - ), - index.offset( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.line)), - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.character)), - text, - ), - ); - } - }; - - TextRange::new( - start_line.start() + start_column_offset.clamp(TextSize::new(0), start_line.end()), - end_line.start() + end_column_offset.clamp(TextSize::new(0), end_line.end()), - ) - } -} - -/// Converts a UTF-16 code unit offset for a given line into a UTF-8 column number. -fn utf8_column_offset(utf16_code_unit_offset: u32, line: &str) -> TextSize { - let mut utf8_code_unit_offset = TextSize::new(0); - - let mut i = 0u32; - - for c in line.chars() { - if i >= utf16_code_unit_offset { - break; - } - - // Count characters encoded as two 16 bit words as 2 characters. - { - utf8_code_unit_offset += - TextSize::new(u32::try_from(c.len_utf8()).expect("utf8 len always <=4")); - i += u32::try_from(c.len_utf16()).expect("utf16 len always <=2"); - } - } - - utf8_code_unit_offset -} diff --git a/crates/red_knot_server/src/edit/text_document.rs b/crates/red_knot_server/src/edit/text_document.rs deleted file mode 100644 index 1d5d496b5bb48..0000000000000 --- a/crates/red_knot_server/src/edit/text_document.rs +++ /dev/null @@ -1,127 +0,0 @@ -use lsp_types::TextDocumentContentChangeEvent; -use ruff_source_file::LineIndex; - -use crate::PositionEncoding; - -use super::RangeExt; - -pub(crate) type DocumentVersion = i32; - -/// The state of an individual document in the server. Stays up-to-date -/// with changes made by the user, including unsaved changes. -#[derive(Debug, Clone)] -pub struct TextDocument { - /// The string contents of the document. - contents: String, - /// A computed line index for the document. This should always reflect - /// the current version of `contents`. Using a function like [`Self::modify`] - /// will re-calculate the line index automatically when the `contents` value is updated. - index: LineIndex, - /// The latest version of the document, set by the LSP client. The server will panic in - /// debug mode if we attempt to update the document with an 'older' version. - version: DocumentVersion, -} - -impl TextDocument { - pub fn new(contents: String, version: DocumentVersion) -> Self { - let index = LineIndex::from_source_text(&contents); - Self { - contents, - index, - version, - } - } - - pub fn into_contents(self) -> String { - self.contents - } - - pub fn contents(&self) -> &str { - &self.contents - } - - pub fn index(&self) -> &LineIndex { - &self.index - } - - pub fn version(&self) -> DocumentVersion { - self.version - } - - pub fn apply_changes( - &mut self, - changes: Vec, - new_version: DocumentVersion, - encoding: PositionEncoding, - ) { - if let [lsp_types::TextDocumentContentChangeEvent { - range: None, text, .. - }] = changes.as_slice() - { - tracing::debug!("Fast path - replacing entire document"); - self.modify(|contents, version| { - contents.clone_from(text); - *version = new_version; - }); - return; - } - - let old_contents = self.contents().to_string(); - let mut new_contents = self.contents().to_string(); - let mut active_index = self.index().clone(); - - for TextDocumentContentChangeEvent { - range, - text: change, - .. - } in changes - { - if let Some(range) = range { - let range = range.to_text_range(&new_contents, &active_index, encoding); - - new_contents.replace_range( - usize::from(range.start())..usize::from(range.end()), - &change, - ); - } else { - new_contents = change; - } - - if new_contents != old_contents { - active_index = LineIndex::from_source_text(&new_contents); - } - } - - self.modify_with_manual_index(|contents, version, index| { - if contents != &new_contents { - *index = active_index; - } - *contents = new_contents; - *version = new_version; - }); - } - - pub fn update_version(&mut self, new_version: DocumentVersion) { - self.modify_with_manual_index(|_, version, _| { - *version = new_version; - }); - } - - // A private function for modifying the document's internal state - fn modify(&mut self, func: impl FnOnce(&mut String, &mut DocumentVersion)) { - self.modify_with_manual_index(|c, v, i| { - func(c, v); - *i = LineIndex::from_source_text(c); - }); - } - - // A private function for overriding how we update the line index by default. - fn modify_with_manual_index( - &mut self, - func: impl FnOnce(&mut String, &mut DocumentVersion, &mut LineIndex), - ) { - let old_version = self.version; - func(&mut self.contents, &mut self.version, &mut self.index); - debug_assert!(self.version >= old_version); - } -} diff --git a/crates/red_knot_server/src/lib.rs b/crates/red_knot_server/src/lib.rs deleted file mode 100644 index eb29c7bbe428f..0000000000000 --- a/crates/red_knot_server/src/lib.rs +++ /dev/null @@ -1,43 +0,0 @@ -#![allow(dead_code)] - -use anyhow::Context; -pub use edit::{DocumentKey, NotebookDocument, PositionEncoding, TextDocument}; -pub use session::{ClientSettings, DocumentQuery, DocumentSnapshot, Session}; -use std::num::NonZeroUsize; - -use crate::server::Server; - -#[macro_use] -mod message; - -mod edit; -mod server; -mod session; -mod system; -mod trace; - -pub(crate) const SERVER_NAME: &str = "red-knot"; -pub(crate) const DIAGNOSTIC_NAME: &str = "Red Knot"; - -/// A common result type used in most cases where a -/// result type is needed. -pub(crate) type Result = anyhow::Result; - -pub(crate) fn version() -> &'static str { - env!("CARGO_PKG_VERSION") -} - -pub fn run_server() -> anyhow::Result<()> { - let four = NonZeroUsize::new(4).unwrap(); - - // by default, we set the number of worker threads to `num_cpus`, with a maximum of 4. - let worker_threads = std::thread::available_parallelism() - .unwrap_or(four) - .max(four); - - Server::new(worker_threads) - .context("Failed to start server")? - .run()?; - - Ok(()) -} diff --git a/crates/red_knot_server/src/message.rs b/crates/red_knot_server/src/message.rs deleted file mode 100644 index 79d7c63ec347a..0000000000000 --- a/crates/red_knot_server/src/message.rs +++ /dev/null @@ -1,46 +0,0 @@ -use anyhow::Context; -use lsp_types::notification::Notification; -use std::sync::OnceLock; - -use crate::server::ClientSender; - -static MESSENGER: OnceLock = OnceLock::new(); - -pub(crate) fn init_messenger(client_sender: ClientSender) { - MESSENGER - .set(client_sender) - .expect("messenger should only be initialized once"); -} - -pub(crate) fn show_message(message: String, message_type: lsp_types::MessageType) { - try_show_message(message, message_type).unwrap(); -} - -pub(super) fn try_show_message( - message: String, - message_type: lsp_types::MessageType, -) -> crate::Result<()> { - MESSENGER - .get() - .ok_or_else(|| anyhow::anyhow!("messenger not initialized"))? - .send(lsp_server::Message::Notification( - lsp_server::Notification { - method: lsp_types::notification::ShowMessage::METHOD.into(), - params: serde_json::to_value(lsp_types::ShowMessageParams { - typ: message_type, - message, - })?, - }, - )) - .context("Failed to send message")?; - - Ok(()) -} - -/// Sends an error to the client with a formatted message. The error is sent in a -/// `window/showMessage` notification. -macro_rules! show_err_msg { - ($msg:expr$(, $($arg:tt),*)?) => { - crate::message::show_message(::core::format_args!($msg, $($($arg),*)?).to_string(), lsp_types::MessageType::ERROR) - }; -} diff --git a/crates/red_knot_server/src/server.rs b/crates/red_knot_server/src/server.rs deleted file mode 100644 index aa7e20e817df9..0000000000000 --- a/crates/red_knot_server/src/server.rs +++ /dev/null @@ -1,235 +0,0 @@ -//! Scheduling, I/O, and API endpoints. - -use std::num::NonZeroUsize; -// The new PanicInfoHook name requires MSRV >= 1.82 -#[allow(deprecated)] -use std::panic::PanicInfo; - -use lsp_server::Message; -use lsp_types::{ - ClientCapabilities, DiagnosticOptions, DiagnosticServerCapabilities, MessageType, - ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind, TextDocumentSyncOptions, - Url, -}; - -use self::connection::{Connection, ConnectionInitializer}; -use self::schedule::event_loop_thread; -use crate::session::{AllSettings, ClientSettings, Session}; -use crate::PositionEncoding; - -mod api; -mod client; -mod connection; -mod schedule; - -use crate::message::try_show_message; -pub(crate) use connection::ClientSender; - -pub(crate) type Result = std::result::Result; - -pub(crate) struct Server { - connection: Connection, - client_capabilities: ClientCapabilities, - worker_threads: NonZeroUsize, - session: Session, -} - -impl Server { - pub(crate) fn new(worker_threads: NonZeroUsize) -> crate::Result { - let connection = ConnectionInitializer::stdio(); - - let (id, init_params) = connection.initialize_start()?; - - let client_capabilities = init_params.capabilities; - let position_encoding = Self::find_best_position_encoding(&client_capabilities); - let server_capabilities = Self::server_capabilities(position_encoding); - - let connection = connection.initialize_finish( - id, - &server_capabilities, - crate::SERVER_NAME, - crate::version(), - )?; - - if let Some(trace) = init_params.trace { - crate::trace::set_trace_value(trace); - } - - crate::message::init_messenger(connection.make_sender()); - - let AllSettings { - global_settings, - mut workspace_settings, - } = AllSettings::from_value( - init_params - .initialization_options - .unwrap_or_else(|| serde_json::Value::Object(serde_json::Map::default())), - ); - - crate::trace::init_tracing( - connection.make_sender(), - global_settings - .tracing - .log_level - .unwrap_or(crate::trace::LogLevel::Info), - global_settings.tracing.log_file.as_deref(), - init_params.client_info.as_ref(), - ); - - let mut workspace_for_url = |url: Url| { - let Some(workspace_settings) = workspace_settings.as_mut() else { - return (url, ClientSettings::default()); - }; - let settings = workspace_settings.remove(&url).unwrap_or_else(|| { - tracing::warn!("No workspace settings found for {}", url); - ClientSettings::default() - }); - (url, settings) - }; - - let workspaces = init_params - .workspace_folders - .filter(|folders| !folders.is_empty()) - .map(|folders| folders.into_iter().map(|folder| { - workspace_for_url(folder.uri) - }).collect()) - .or_else(|| { - tracing::warn!("No workspace(s) were provided during initialization. Using the current working directory as a default workspace..."); - let uri = Url::from_file_path(std::env::current_dir().ok()?).ok()?; - Some(vec![workspace_for_url(uri)]) - }) - .ok_or_else(|| { - anyhow::anyhow!("Failed to get the current working directory while creating a default workspace.") - })?; - - if workspaces.len() > 1 { - // TODO(dhruvmanila): Support multi-root workspaces - anyhow::bail!("Multi-root workspaces are not supported yet"); - } - - Ok(Self { - connection, - worker_threads, - session: Session::new( - &client_capabilities, - position_encoding, - global_settings, - &workspaces, - )?, - client_capabilities, - }) - } - - pub(crate) fn run(self) -> crate::Result<()> { - // The new PanicInfoHook name requires MSRV >= 1.82 - #[allow(deprecated)] - type PanicHook = Box) + 'static + Sync + Send>; - struct RestorePanicHook { - hook: Option, - } - - impl Drop for RestorePanicHook { - fn drop(&mut self) { - if let Some(hook) = self.hook.take() { - std::panic::set_hook(hook); - } - } - } - - // unregister any previously registered panic hook - // The hook will be restored when this function exits. - let _ = RestorePanicHook { - hook: Some(std::panic::take_hook()), - }; - - // When we panic, try to notify the client. - std::panic::set_hook(Box::new(move |panic_info| { - use std::io::Write; - - let backtrace = std::backtrace::Backtrace::force_capture(); - tracing::error!("{panic_info}\n{backtrace}"); - - // we also need to print to stderr directly for when using `$logTrace` because - // the message won't be sent to the client. - // But don't use `eprintln` because `eprintln` itself may panic if the pipe is broken. - let mut stderr = std::io::stderr().lock(); - writeln!(stderr, "{panic_info}\n{backtrace}").ok(); - - try_show_message( - "The Ruff language server exited with a panic. See the logs for more details." - .to_string(), - MessageType::ERROR, - ) - .ok(); - })); - - event_loop_thread(move || { - Self::event_loop( - &self.connection, - &self.client_capabilities, - self.session, - self.worker_threads, - )?; - self.connection.close()?; - Ok(()) - })? - .join() - } - - #[allow(clippy::needless_pass_by_value)] // this is because we aren't using `next_request_id` yet. - fn event_loop( - connection: &Connection, - _client_capabilities: &ClientCapabilities, - mut session: Session, - worker_threads: NonZeroUsize, - ) -> crate::Result<()> { - let mut scheduler = - schedule::Scheduler::new(&mut session, worker_threads, connection.make_sender()); - - for msg in connection.incoming() { - if connection.handle_shutdown(&msg)? { - break; - } - let task = match msg { - Message::Request(req) => api::request(req), - Message::Notification(notification) => api::notification(notification), - Message::Response(response) => scheduler.response(response), - }; - scheduler.dispatch(task); - } - - Ok(()) - } - - fn find_best_position_encoding(client_capabilities: &ClientCapabilities) -> PositionEncoding { - client_capabilities - .general - .as_ref() - .and_then(|general_capabilities| general_capabilities.position_encodings.as_ref()) - .and_then(|encodings| { - encodings - .iter() - .filter_map(|encoding| PositionEncoding::try_from(encoding).ok()) - .max() // this selects the highest priority position encoding - }) - .unwrap_or_default() - } - - fn server_capabilities(position_encoding: PositionEncoding) -> ServerCapabilities { - ServerCapabilities { - position_encoding: Some(position_encoding.into()), - diagnostic_provider: Some(DiagnosticServerCapabilities::Options(DiagnosticOptions { - identifier: Some(crate::DIAGNOSTIC_NAME.into()), - ..Default::default() - })), - text_document_sync: Some(TextDocumentSyncCapability::Options( - TextDocumentSyncOptions { - open_close: Some(true), - change: Some(TextDocumentSyncKind::INCREMENTAL), - ..Default::default() - }, - )), - ..Default::default() - } - } -} diff --git a/crates/red_knot_server/src/server/api.rs b/crates/red_knot_server/src/server/api.rs deleted file mode 100644 index ebef3472d1565..0000000000000 --- a/crates/red_knot_server/src/server/api.rs +++ /dev/null @@ -1,250 +0,0 @@ -use lsp_server as server; - -use crate::server::schedule::Task; -use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; - -mod diagnostics; -mod notifications; -mod requests; -mod traits; - -use notifications as notification; -use requests as request; - -use self::traits::{NotificationHandler, RequestHandler}; - -use super::{client::Responder, schedule::BackgroundSchedule, Result}; - -pub(super) fn request<'a>(req: server::Request) -> Task<'a> { - let id = req.id.clone(); - - match req.method.as_str() { - request::DocumentDiagnosticRequestHandler::METHOD => { - background_request_task::( - req, - BackgroundSchedule::LatencySensitive, - ) - } - method => { - tracing::warn!("Received request {method} which does not have a handler"); - return Task::nothing(); - } - } - .unwrap_or_else(|err| { - tracing::error!("Encountered error when routing request with ID {id}: {err}"); - show_err_msg!( - "Ruff failed to handle a request from the editor. Check the logs for more details." - ); - let result: Result<()> = Err(err); - Task::immediate(id, result) - }) -} - -pub(super) fn notification<'a>(notif: server::Notification) -> Task<'a> { - match notif.method.as_str() { - notification::DidCloseTextDocumentHandler::METHOD => local_notification_task::(notif), - notification::DidOpenTextDocumentHandler::METHOD => local_notification_task::(notif), - notification::DidChangeTextDocumentHandler::METHOD => local_notification_task::(notif), - notification::DidOpenNotebookHandler::METHOD => { - local_notification_task::(notif) - } - notification::DidCloseNotebookHandler::METHOD => { - local_notification_task::(notif) - } - notification::SetTraceHandler::METHOD => { - local_notification_task::(notif) - } - method => { - tracing::warn!("Received notification {method} which does not have a handler."); - return Task::nothing(); - } - } - .unwrap_or_else(|err| { - tracing::error!("Encountered error when routing notification: {err}"); - show_err_msg!("Ruff failed to handle a notification from the editor. Check the logs for more details."); - Task::nothing() - }) -} - -fn _local_request_task<'a, R: traits::SyncRequestHandler>( - req: server::Request, -) -> super::Result> { - let (id, params) = cast_request::(req)?; - Ok(Task::local(|session, notifier, requester, responder| { - let result = R::run(session, notifier, requester, params); - respond::(id, result, &responder); - })) -} - -fn background_request_task<'a, R: traits::BackgroundDocumentRequestHandler>( - req: server::Request, - schedule: BackgroundSchedule, -) -> super::Result> { - let (id, params) = cast_request::(req)?; - Ok(Task::background(schedule, move |session: &Session| { - let url = R::document_url(¶ms).into_owned(); - - let Ok(path) = url_to_any_system_path(&url) else { - return Box::new(|_, _| {}); - }; - let db = match path { - AnySystemPath::System(path) => { - match session.workspace_db_for_path(path.as_std_path()) { - Some(db) => db.snapshot(), - None => session.default_workspace_db().snapshot(), - } - } - AnySystemPath::SystemVirtual(_) => session.default_workspace_db().snapshot(), - }; - - let Some(snapshot) = session.take_snapshot(url) else { - return Box::new(|_, _| {}); - }; - - Box::new(move |notifier, responder| { - let result = R::run_with_snapshot(snapshot, db, notifier, params); - respond::(id, result, &responder); - }) - })) -} - -fn local_notification_task<'a, N: traits::SyncNotificationHandler>( - notif: server::Notification, -) -> super::Result> { - let (id, params) = cast_notification::(notif)?; - Ok(Task::local(move |session, notifier, requester, _| { - if let Err(err) = N::run(session, notifier, requester, params) { - tracing::error!("An error occurred while running {id}: {err}"); - show_err_msg!("Ruff encountered a problem. Check the logs for more details."); - } - })) -} - -#[allow(dead_code)] -fn background_notification_thread<'a, N: traits::BackgroundDocumentNotificationHandler>( - req: server::Notification, - schedule: BackgroundSchedule, -) -> super::Result> { - let (id, params) = cast_notification::(req)?; - Ok(Task::background(schedule, move |session: &Session| { - // TODO(jane): we should log an error if we can't take a snapshot. - let Some(snapshot) = session.take_snapshot(N::document_url(¶ms).into_owned()) else { - return Box::new(|_, _| {}); - }; - Box::new(move |notifier, _| { - if let Err(err) = N::run_with_snapshot(snapshot, notifier, params) { - tracing::error!("An error occurred while running {id}: {err}"); - show_err_msg!("Ruff encountered a problem. Check the logs for more details."); - } - }) - })) -} - -/// Tries to cast a serialized request from the server into -/// a parameter type for a specific request handler. -/// It is *highly* recommended to not override this function in your -/// implementation. -fn cast_request( - request: server::Request, -) -> super::Result<( - server::RequestId, - <::RequestType as lsp_types::request::Request>::Params, -)> -where - Req: traits::RequestHandler, -{ - request - .extract(Req::METHOD) - .map_err(|err| match err { - json_err @ server::ExtractError::JsonError { .. } => { - anyhow::anyhow!("JSON parsing failure:\n{json_err}") - } - server::ExtractError::MethodMismatch(_) => { - unreachable!("A method mismatch should not be possible here unless you've used a different handler (`Req`) \ - than the one whose method name was matched against earlier.") - } - }) - .with_failure_code(server::ErrorCode::InternalError) -} - -/// Sends back a response to the server using a [`Responder`]. -fn respond( - id: server::RequestId, - result: crate::server::Result< - <::RequestType as lsp_types::request::Request>::Result, - >, - responder: &Responder, -) where - Req: traits::RequestHandler, -{ - if let Err(err) = &result { - tracing::error!("An error occurred with result ID {id}: {err}"); - show_err_msg!("Ruff encountered a problem. Check the logs for more details."); - } - if let Err(err) = responder.respond(id, result) { - tracing::error!("Failed to send response: {err}"); - } -} - -/// Tries to cast a serialized request from the server into -/// a parameter type for a specific request handler. -fn cast_notification( - notification: server::Notification, -) -> super::Result< - ( - &'static str, - <::NotificationType as lsp_types::notification::Notification>::Params, -)> where N: traits::NotificationHandler{ - Ok(( - N::METHOD, - notification - .extract(N::METHOD) - .map_err(|err| match err { - json_err @ server::ExtractError::JsonError { .. } => { - anyhow::anyhow!("JSON parsing failure:\n{json_err}") - } - server::ExtractError::MethodMismatch(_) => { - unreachable!("A method mismatch should not be possible here unless you've used a different handler (`N`) \ - than the one whose method name was matched against earlier.") - } - }) - .with_failure_code(server::ErrorCode::InternalError)?, - )) -} - -pub(crate) struct Error { - pub(crate) code: server::ErrorCode, - pub(crate) error: anyhow::Error, -} - -/// A trait to convert result types into the server result type, [`super::Result`]. -trait LSPResult { - fn with_failure_code(self, code: server::ErrorCode) -> super::Result; -} - -impl> LSPResult for core::result::Result { - fn with_failure_code(self, code: server::ErrorCode) -> super::Result { - self.map_err(|err| Error::new(err.into(), code)) - } -} - -impl Error { - pub(crate) fn new(err: anyhow::Error, code: server::ErrorCode) -> Self { - Self { code, error: err } - } -} - -// Right now, we treat the error code as invisible data that won't -// be printed. -impl std::fmt::Debug for Error { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - self.error.fmt(f) - } -} - -impl std::fmt::Display for Error { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - self.error.fmt(f) - } -} diff --git a/crates/red_knot_server/src/server/api/notifications/did_open.rs b/crates/red_knot_server/src/server/api/notifications/did_open.rs deleted file mode 100644 index 2bc5dc03c4b07..0000000000000 --- a/crates/red_knot_server/src/server/api/notifications/did_open.rs +++ /dev/null @@ -1,52 +0,0 @@ -use lsp_types::notification::DidOpenTextDocument; -use lsp_types::DidOpenTextDocumentParams; - -use red_knot_workspace::watch::ChangeEvent; -use ruff_db::Db; - -use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; -use crate::server::client::{Notifier, Requester}; -use crate::server::Result; -use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; -use crate::TextDocument; - -pub(crate) struct DidOpenTextDocumentHandler; - -impl NotificationHandler for DidOpenTextDocumentHandler { - type NotificationType = DidOpenTextDocument; -} - -impl SyncNotificationHandler for DidOpenTextDocumentHandler { - fn run( - session: &mut Session, - _notifier: Notifier, - _requester: &mut Requester, - params: DidOpenTextDocumentParams, - ) -> Result<()> { - let Ok(path) = url_to_any_system_path(¶ms.text_document.uri) else { - return Ok(()); - }; - - let document = TextDocument::new(params.text_document.text, params.text_document.version); - session.open_text_document(params.text_document.uri, document); - - match path { - AnySystemPath::System(path) => { - let db = match session.workspace_db_for_path_mut(path.as_std_path()) { - Some(db) => db, - None => session.default_workspace_db_mut(), - }; - db.apply_changes(vec![ChangeEvent::Opened(path)], None); - } - AnySystemPath::SystemVirtual(virtual_path) => { - let db = session.default_workspace_db_mut(); - db.files().virtual_file(db, &virtual_path); - } - } - - // TODO(dhruvmanila): Publish diagnostics if the client doesn't support pull diagnostics - - Ok(()) - } -} diff --git a/crates/red_knot_server/src/server/api/notifications/set_trace.rs b/crates/red_knot_server/src/server/api/notifications/set_trace.rs deleted file mode 100644 index 5ff186b01db73..0000000000000 --- a/crates/red_knot_server/src/server/api/notifications/set_trace.rs +++ /dev/null @@ -1,25 +0,0 @@ -use lsp_types::notification::SetTrace; -use lsp_types::SetTraceParams; - -use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; -use crate::server::client::{Notifier, Requester}; -use crate::server::Result; -use crate::session::Session; - -pub(crate) struct SetTraceHandler; - -impl NotificationHandler for SetTraceHandler { - type NotificationType = SetTrace; -} - -impl SyncNotificationHandler for SetTraceHandler { - fn run( - _session: &mut Session, - _notifier: Notifier, - _requester: &mut Requester, - params: SetTraceParams, - ) -> Result<()> { - crate::trace::set_trace_value(params.value); - Ok(()) - } -} diff --git a/crates/red_knot_server/src/server/api/requests.rs b/crates/red_knot_server/src/server/api/requests.rs deleted file mode 100644 index 83e25fc6ed62c..0000000000000 --- a/crates/red_knot_server/src/server/api/requests.rs +++ /dev/null @@ -1,3 +0,0 @@ -mod diagnostic; - -pub(super) use diagnostic::DocumentDiagnosticRequestHandler; diff --git a/crates/red_knot_server/src/server/api/requests/diagnostic.rs b/crates/red_knot_server/src/server/api/requests/diagnostic.rs deleted file mode 100644 index 25622dc32b483..0000000000000 --- a/crates/red_knot_server/src/server/api/requests/diagnostic.rs +++ /dev/null @@ -1,100 +0,0 @@ -use std::borrow::Cow; - -use lsp_types::request::DocumentDiagnosticRequest; -use lsp_types::{ - Diagnostic, DiagnosticSeverity, DocumentDiagnosticParams, DocumentDiagnosticReport, - DocumentDiagnosticReportResult, FullDocumentDiagnosticReport, Position, Range, - RelatedFullDocumentDiagnosticReport, Url, -}; - -use red_knot_workspace::db::RootDatabase; - -use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; -use crate::server::{client::Notifier, Result}; -use crate::session::DocumentSnapshot; - -pub(crate) struct DocumentDiagnosticRequestHandler; - -impl RequestHandler for DocumentDiagnosticRequestHandler { - type RequestType = DocumentDiagnosticRequest; -} - -impl BackgroundDocumentRequestHandler for DocumentDiagnosticRequestHandler { - fn document_url(params: &DocumentDiagnosticParams) -> Cow { - Cow::Borrowed(¶ms.text_document.uri) - } - - fn run_with_snapshot( - snapshot: DocumentSnapshot, - db: RootDatabase, - _notifier: Notifier, - _params: DocumentDiagnosticParams, - ) -> Result { - let diagnostics = compute_diagnostics(&snapshot, &db); - - Ok(DocumentDiagnosticReportResult::Report( - DocumentDiagnosticReport::Full(RelatedFullDocumentDiagnosticReport { - related_documents: None, - full_document_diagnostic_report: FullDocumentDiagnosticReport { - result_id: None, - items: diagnostics, - }, - }), - )) - } -} - -fn compute_diagnostics(snapshot: &DocumentSnapshot, db: &RootDatabase) -> Vec { - let Some(file) = snapshot.file(db) else { - tracing::info!( - "No file found for snapshot for `{}`", - snapshot.query().file_url() - ); - return vec![]; - }; - - let diagnostics = match db.check_file(file) { - Ok(diagnostics) => diagnostics, - Err(cancelled) => { - tracing::info!("Diagnostics computation {cancelled}"); - return vec![]; - } - }; - - diagnostics - .as_slice() - .iter() - .map(|message| to_lsp_diagnostic(message)) - .collect() -} - -fn to_lsp_diagnostic(message: &str) -> Diagnostic { - let words = message.split(':').collect::>(); - - let (range, message) = match words.as_slice() { - [_, _, line, column, message] | [_, line, column, message] => { - let line = line.parse::().unwrap_or_default().saturating_sub(1); - let column = column.parse::().unwrap_or_default(); - ( - Range::new( - Position::new(line, column.saturating_sub(1)), - Position::new(line, column), - ), - message.trim(), - ) - } - _ => (Range::default(), message), - }; - - Diagnostic { - range, - severity: Some(DiagnosticSeverity::ERROR), - tags: None, - code: None, - code_description: None, - source: Some("red-knot".into()), - message: message.to_string(), - related_information: None, - data: None, - } -} diff --git a/crates/red_knot_server/src/server/connection.rs b/crates/red_knot_server/src/server/connection.rs deleted file mode 100644 index c04567c57ae84..0000000000000 --- a/crates/red_knot_server/src/server/connection.rs +++ /dev/null @@ -1,144 +0,0 @@ -use lsp_server as lsp; -use lsp_types::{notification::Notification, request::Request}; -use std::sync::{Arc, Weak}; - -type ConnectionSender = crossbeam::channel::Sender; -type ConnectionReceiver = crossbeam::channel::Receiver; - -/// A builder for `Connection` that handles LSP initialization. -pub(crate) struct ConnectionInitializer { - connection: lsp::Connection, - threads: lsp::IoThreads, -} - -/// Handles inbound and outbound messages with the client. -pub(crate) struct Connection { - sender: Arc, - receiver: ConnectionReceiver, - threads: lsp::IoThreads, -} - -impl ConnectionInitializer { - /// Create a new LSP server connection over stdin/stdout. - pub(super) fn stdio() -> Self { - let (connection, threads) = lsp::Connection::stdio(); - Self { - connection, - threads, - } - } - - /// Starts the initialization process with the client by listening for an initialization request. - /// Returns a request ID that should be passed into `initialize_finish` later, - /// along with the initialization parameters that were provided. - pub(super) fn initialize_start( - &self, - ) -> crate::Result<(lsp::RequestId, lsp_types::InitializeParams)> { - let (id, params) = self.connection.initialize_start()?; - Ok((id, serde_json::from_value(params)?)) - } - - /// Finishes the initialization process with the client, - /// returning an initialized `Connection`. - pub(super) fn initialize_finish( - self, - id: lsp::RequestId, - server_capabilities: &lsp_types::ServerCapabilities, - name: &str, - version: &str, - ) -> crate::Result { - self.connection.initialize_finish( - id, - serde_json::json!({ - "capabilities": server_capabilities, - "serverInfo": { - "name": name, - "version": version - } - }), - )?; - let Self { - connection: lsp::Connection { sender, receiver }, - threads, - } = self; - Ok(Connection { - sender: Arc::new(sender), - receiver, - threads, - }) - } -} - -impl Connection { - /// Make a new `ClientSender` for sending messages to the client. - pub(super) fn make_sender(&self) -> ClientSender { - ClientSender { - weak_sender: Arc::downgrade(&self.sender), - } - } - - /// An iterator over incoming messages from the client. - pub(super) fn incoming(&self) -> crossbeam::channel::Iter { - self.receiver.iter() - } - - /// Check and respond to any incoming shutdown requests; returns`true` if the server should be shutdown. - pub(super) fn handle_shutdown(&self, message: &lsp::Message) -> crate::Result { - match message { - lsp::Message::Request(lsp::Request { id, method, .. }) - if method == lsp_types::request::Shutdown::METHOD => - { - self.sender - .send(lsp::Response::new_ok(id.clone(), ()).into())?; - tracing::info!("Shutdown request received. Waiting for an exit notification..."); - match self.receiver.recv_timeout(std::time::Duration::from_secs(30))? { - lsp::Message::Notification(lsp::Notification { method, .. }) if method == lsp_types::notification::Exit::METHOD => { - tracing::info!("Exit notification received. Server shutting down..."); - Ok(true) - }, - message => anyhow::bail!("Server received unexpected message {message:?} while waiting for exit notification") - } - } - lsp::Message::Notification(lsp::Notification { method, .. }) - if method == lsp_types::notification::Exit::METHOD => - { - tracing::error!("Server received an exit notification before a shutdown request was sent. Exiting..."); - Ok(true) - } - _ => Ok(false), - } - } - - /// Join the I/O threads that underpin this connection. - /// This is guaranteed to be nearly immediate since - /// we close the only active channels to these threads prior - /// to joining them. - pub(super) fn close(self) -> crate::Result<()> { - std::mem::drop( - Arc::into_inner(self.sender) - .expect("the client sender shouldn't have more than one strong reference"), - ); - std::mem::drop(self.receiver); - self.threads.join()?; - Ok(()) - } -} - -/// A weak reference to an underlying sender channel, used for communication with the client. -/// If the `Connection` that created this `ClientSender` is dropped, any `send` calls will throw -/// an error. -#[derive(Clone, Debug)] -pub(crate) struct ClientSender { - weak_sender: Weak, -} - -// note: additional wrapper functions for senders may be implemented as needed. -impl ClientSender { - pub(crate) fn send(&self, msg: lsp::Message) -> crate::Result<()> { - let Some(sender) = self.weak_sender.upgrade() else { - anyhow::bail!("The connection with the client has been closed"); - }; - - Ok(sender.send(msg)?) - } -} diff --git a/crates/red_knot_server/src/session/capabilities.rs b/crates/red_knot_server/src/session/capabilities.rs deleted file mode 100644 index 27d5d09ce7adc..0000000000000 --- a/crates/red_knot_server/src/session/capabilities.rs +++ /dev/null @@ -1,67 +0,0 @@ -use lsp_types::ClientCapabilities; - -#[derive(Debug, Clone, PartialEq, Eq, Default)] -#[allow(clippy::struct_excessive_bools)] -pub(crate) struct ResolvedClientCapabilities { - pub(crate) code_action_deferred_edit_resolution: bool, - pub(crate) apply_edit: bool, - pub(crate) document_changes: bool, - pub(crate) workspace_refresh: bool, - pub(crate) pull_diagnostics: bool, -} - -impl ResolvedClientCapabilities { - pub(super) fn new(client_capabilities: &ClientCapabilities) -> Self { - let code_action_settings = client_capabilities - .text_document - .as_ref() - .and_then(|doc_settings| doc_settings.code_action.as_ref()); - let code_action_data_support = code_action_settings - .and_then(|code_action_settings| code_action_settings.data_support) - .unwrap_or_default(); - let code_action_edit_resolution = code_action_settings - .and_then(|code_action_settings| code_action_settings.resolve_support.as_ref()) - .is_some_and(|resolve_support| resolve_support.properties.contains(&"edit".into())); - - let apply_edit = client_capabilities - .workspace - .as_ref() - .and_then(|workspace| workspace.apply_edit) - .unwrap_or_default(); - - let document_changes = client_capabilities - .workspace - .as_ref() - .and_then(|workspace| workspace.workspace_edit.as_ref()) - .and_then(|workspace_edit| workspace_edit.document_changes) - .unwrap_or_default(); - - let workspace_refresh = true; - - // TODO(jane): Once the bug involving workspace.diagnostic(s) deserialization has been fixed, - // uncomment this. - /* - let workspace_refresh = client_capabilities - .workspace - .as_ref() - .and_then(|workspace| workspace.diagnostic.as_ref()) - .and_then(|diagnostic| diagnostic.refresh_support) - .unwrap_or_default(); - */ - - let pull_diagnostics = client_capabilities - .text_document - .as_ref() - .and_then(|text_document| text_document.diagnostic.as_ref()) - .is_some(); - - Self { - code_action_deferred_edit_resolution: code_action_data_support - && code_action_edit_resolution, - apply_edit, - document_changes, - workspace_refresh, - pull_diagnostics, - } - } -} diff --git a/crates/red_knot_server/src/session/settings.rs b/crates/red_knot_server/src/session/settings.rs deleted file mode 100644 index 0fccad470cbde..0000000000000 --- a/crates/red_knot_server/src/session/settings.rs +++ /dev/null @@ -1,111 +0,0 @@ -use std::path::PathBuf; - -use lsp_types::Url; -use rustc_hash::FxHashMap; -use serde::Deserialize; - -/// Maps a workspace URI to its associated client settings. Used during server initialization. -pub(crate) type WorkspaceSettingsMap = FxHashMap; - -/// This is a direct representation of the settings schema sent by the client. -#[derive(Debug, Deserialize, Default)] -#[cfg_attr(test, derive(PartialEq, Eq))] -#[serde(rename_all = "camelCase")] -pub struct ClientSettings { - // These settings are only needed for tracing, and are only read from the global configuration. - // These will not be in the resolved settings. - #[serde(flatten)] - pub(crate) tracing: TracingSettings, -} - -/// Settings needed to initialize tracing. These will only be -/// read from the global configuration. -#[derive(Debug, Deserialize, Default)] -#[cfg_attr(test, derive(PartialEq, Eq))] -#[serde(rename_all = "camelCase")] -pub(crate) struct TracingSettings { - pub(crate) log_level: Option, - /// Path to the log file - tildes and environment variables are supported. - pub(crate) log_file: Option, -} - -/// This is a direct representation of the workspace settings schema, -/// which inherits the schema of [`ClientSettings`] and adds extra fields -/// to describe the workspace it applies to. -#[derive(Debug, Deserialize)] -#[cfg_attr(test, derive(PartialEq, Eq))] -#[serde(rename_all = "camelCase")] -struct WorkspaceSettings { - #[serde(flatten)] - settings: ClientSettings, - workspace: Url, -} - -/// This is the exact schema for initialization options sent in by the client -/// during initialization. -#[derive(Debug, Deserialize)] -#[cfg_attr(test, derive(PartialEq, Eq))] -#[serde(untagged)] -enum InitializationOptions { - #[serde(rename_all = "camelCase")] - HasWorkspaces { - global_settings: ClientSettings, - #[serde(rename = "settings")] - workspace_settings: Vec, - }, - GlobalOnly { - #[serde(default)] - settings: ClientSettings, - }, -} - -/// Built from the initialization options provided by the client. -#[derive(Debug)] -pub(crate) struct AllSettings { - pub(crate) global_settings: ClientSettings, - /// If this is `None`, the client only passed in global settings. - pub(crate) workspace_settings: Option, -} - -impl AllSettings { - /// Initializes the controller from the serialized initialization options. - /// This fails if `options` are not valid initialization options. - pub(crate) fn from_value(options: serde_json::Value) -> Self { - Self::from_init_options( - serde_json::from_value(options) - .map_err(|err| { - tracing::error!("Failed to deserialize initialization options: {err}. Falling back to default client settings..."); - show_err_msg!("Ruff received invalid client settings - falling back to default client settings."); - }) - .unwrap_or_default(), - ) - } - - fn from_init_options(options: InitializationOptions) -> Self { - let (global_settings, workspace_settings) = match options { - InitializationOptions::GlobalOnly { settings } => (settings, None), - InitializationOptions::HasWorkspaces { - global_settings, - workspace_settings, - } => (global_settings, Some(workspace_settings)), - }; - - Self { - global_settings, - workspace_settings: workspace_settings.map(|workspace_settings| { - workspace_settings - .into_iter() - .map(|settings| (settings.workspace, settings.settings)) - .collect() - }), - } - } -} - -impl Default for InitializationOptions { - fn default() -> Self { - Self::GlobalOnly { - settings: ClientSettings::default(), - } - } -} diff --git a/crates/red_knot_server/src/trace.rs b/crates/red_knot_server/src/trace.rs deleted file mode 100644 index 7bd27747ef3fb..0000000000000 --- a/crates/red_knot_server/src/trace.rs +++ /dev/null @@ -1,221 +0,0 @@ -//! The tracing system for `ruff server`. -//! -//! Traces are controlled by the `logLevel` setting, along with the -//! trace level set through the LSP. On VS Code, the trace level can -//! also be set with `ruff.trace.server`. A trace level of `messages` or -//! `verbose` will enable tracing - otherwise, no traces will be shown. -//! -//! `logLevel` can be used to configure the level of tracing that is shown. -//! By default, `logLevel` is set to `"info"`. -//! -//! The server also supports the `RUFF_TRACE` environment variable, which will -//! override the trace value provided by the LSP client. Use this if there's no good way -//! to set the trace value through your editor's configuration. -//! -//! Tracing will write to `stderr` by default, which should appear in the logs for most LSP clients. -//! A `logFile` path can also be specified in the settings, and output will be directed there instead. -use core::str; -use lsp_server::{Message, Notification}; -use lsp_types::{ - notification::{LogTrace, Notification as _}, - ClientInfo, TraceValue, -}; -use serde::Deserialize; -use std::{ - io::{Error as IoError, ErrorKind, Write}, - path::PathBuf, - str::FromStr, - sync::{Arc, Mutex, OnceLock}, -}; -use tracing::level_filters::LevelFilter; -use tracing_subscriber::{ - fmt::{time::Uptime, writer::BoxMakeWriter, MakeWriter}, - layer::SubscriberExt, - Layer, -}; - -use crate::server::ClientSender; - -const TRACE_ENV_KEY: &str = "RUFF_TRACE"; - -static LOGGING_SENDER: OnceLock = OnceLock::new(); - -static TRACE_VALUE: Mutex = Mutex::new(lsp_types::TraceValue::Off); - -pub(crate) fn set_trace_value(trace_value: TraceValue) { - let mut global_trace_value = TRACE_VALUE - .lock() - .expect("trace value mutex should be available"); - *global_trace_value = trace_value; -} - -// A tracing writer that uses LSPs logTrace method. -struct TraceLogWriter; - -impl Write for TraceLogWriter { - fn write(&mut self, buf: &[u8]) -> std::io::Result { - let message = str::from_utf8(buf).map_err(|e| IoError::new(ErrorKind::InvalidData, e))?; - LOGGING_SENDER - .get() - .expect("logging sender should be initialized at this point") - .send(Message::Notification(Notification { - method: LogTrace::METHOD.to_owned(), - params: serde_json::json!({ - "message": message - }), - })) - .map_err(|e| IoError::new(ErrorKind::Other, e))?; - Ok(buf.len()) - } - - fn flush(&mut self) -> std::io::Result<()> { - Ok(()) - } -} - -impl<'a> MakeWriter<'a> for TraceLogWriter { - type Writer = Self; - - fn make_writer(&'a self) -> Self::Writer { - Self - } -} - -pub(crate) fn init_tracing( - sender: ClientSender, - log_level: LogLevel, - log_file: Option<&std::path::Path>, - client: Option<&ClientInfo>, -) { - LOGGING_SENDER - .set(sender) - .expect("logging sender should only be initialized once"); - - let log_file = log_file - .map(|path| { - // this expands `logFile` so that tildes and environment variables - // are replaced with their values, if possible. - if let Some(expanded) = shellexpand::full(&path.to_string_lossy()) - .ok() - .and_then(|path| PathBuf::from_str(&path).ok()) - { - expanded - } else { - path.to_path_buf() - } - }) - .and_then(|path| { - std::fs::OpenOptions::new() - .create(true) - .append(true) - .open(&path) - .map_err(|err| { - #[allow(clippy::print_stderr)] - { - eprintln!( - "Failed to open file at {} for logging: {err}", - path.display() - ); - } - }) - .ok() - }); - - let logger = match log_file { - Some(file) => BoxMakeWriter::new(Arc::new(file)), - None => { - if client.is_some_and(|client| { - client.name.starts_with("Zed") || client.name.starts_with("Visual Studio Code") - }) { - BoxMakeWriter::new(TraceLogWriter) - } else { - BoxMakeWriter::new(std::io::stderr) - } - } - }; - let subscriber = tracing_subscriber::Registry::default().with( - tracing_subscriber::fmt::layer() - .with_timer(Uptime::default()) - .with_thread_names(true) - .with_ansi(false) - .with_writer(logger) - .with_filter(TraceLevelFilter) - .with_filter(LogLevelFilter { filter: log_level }), - ); - - tracing::subscriber::set_global_default(subscriber) - .expect("should be able to set global default subscriber"); -} - -#[derive(Clone, Copy, Debug, Deserialize, Default, PartialEq, Eq, PartialOrd, Ord)] -#[serde(rename_all = "lowercase")] -pub(crate) enum LogLevel { - #[default] - Error, - Warn, - Info, - Debug, - Trace, -} - -impl LogLevel { - fn trace_level(self) -> tracing::Level { - match self { - Self::Error => tracing::Level::ERROR, - Self::Warn => tracing::Level::WARN, - Self::Info => tracing::Level::INFO, - Self::Debug => tracing::Level::DEBUG, - Self::Trace => tracing::Level::TRACE, - } - } -} - -/// Filters out traces which have a log level lower than the `logLevel` set by the client. -struct LogLevelFilter { - filter: LogLevel, -} - -/// Filters out traces if the trace value set by the client is `off`. -struct TraceLevelFilter; - -impl tracing_subscriber::layer::Filter for LogLevelFilter { - fn enabled( - &self, - meta: &tracing::Metadata<'_>, - _: &tracing_subscriber::layer::Context<'_, S>, - ) -> bool { - let filter = if meta.target().starts_with("ruff") { - self.filter.trace_level() - } else { - tracing::Level::INFO - }; - - meta.level() <= &filter - } - - fn max_level_hint(&self) -> Option { - Some(LevelFilter::from_level(self.filter.trace_level())) - } -} - -impl tracing_subscriber::layer::Filter for TraceLevelFilter { - fn enabled( - &self, - _: &tracing::Metadata<'_>, - _: &tracing_subscriber::layer::Context<'_, S>, - ) -> bool { - trace_value() != lsp_types::TraceValue::Off - } -} - -#[inline] -fn trace_value() -> lsp_types::TraceValue { - std::env::var(TRACE_ENV_KEY) - .ok() - .and_then(|trace| serde_json::from_value(serde_json::Value::String(trace)).ok()) - .unwrap_or_else(|| { - *TRACE_VALUE - .lock() - .expect("trace value mutex should be available") - }) -} diff --git a/crates/red_knot_test/Cargo.toml b/crates/red_knot_test/Cargo.toml deleted file mode 100644 index 68c7f13e96e23..0000000000000 --- a/crates/red_knot_test/Cargo.toml +++ /dev/null @@ -1,33 +0,0 @@ -[package] -name = "red_knot_test" -version = "0.0.0" -publish = false -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true - -[dependencies] -red_knot_python_semantic = { workspace = true } -red_knot_vendored = { workspace = true } -ruff_db = { workspace = true } -ruff_index = { workspace = true } -ruff_python_trivia = { workspace = true } -ruff_source_file = { workspace = true } -ruff_text_size = { workspace = true } - -anyhow = { workspace = true } -colored = { workspace = true } -memchr = { workspace = true } -regex = { workspace = true } -rustc-hash = { workspace = true } -salsa = { workspace = true } -smallvec = { workspace = true } - -[dev-dependencies] - -[lints] -workspace = true diff --git a/crates/red_knot_test/README.md b/crates/red_knot_test/README.md deleted file mode 100644 index e53b9ca4acb77..0000000000000 --- a/crates/red_knot_test/README.md +++ /dev/null @@ -1,470 +0,0 @@ -# Writing type-checking / type-inference tests - -Any Markdown file can be a test suite. - -In order for it to be run as one, `red_knot_test::run` must be called with its path; see -`crates/red_knot_python_semantic/tests/mdtest.rs` for an example that treats all Markdown files -under a certain directory as test suites. - -A Markdown test suite can contain any number of tests. A test consists of one or more embedded -"files", each defined by a triple-backticks fenced code block. The code block must have a tag string -specifying its language; currently only `py` (Python files) and `pyi` (type stub files) are -supported. - -The simplest possible test suite consists of just a single test, with a single embedded file: - -````markdown -```py -reveal_type(1) # revealed: Literal[1] -``` -```` - -When running this test, the mdtest framework will write a file with these contents to the default -file path (`/src/test.py`) in its in-memory file system, run a type check on that file, and then -match the resulting diagnostics with the assertions in the test. Assertions are in the form of -Python comments. If all diagnostics and all assertions are matched, the test passes; otherwise, it -fails. - - - -See actual example mdtest suites in -[`crates/red_knot_python_semantic/resources/mdtest`](https://github.com/astral-sh/ruff/tree/main/crates/red_knot_python_semantic/resources/mdtest). - -> ℹ️ Note: If you use `dir-test`, `rstest` or similar to generate a separate test for all Markdown files in a certain directory, -> as with the example in `crates/red_knot_python_semantic/tests/mdtest.rs`, -> you will likely want to also make sure that the crate the tests are in is rebuilt every time a -> Markdown file is added or removed from the directory. See -> [`crates/red_knot_python_semantic/build.rs`](https://github.com/astral-sh/ruff/tree/main/crates/red_knot_python_semantic/build.rs) -> for an example of how to do this. -> -> This is because these macros generate their tests at build time rather than at runtime. -> Without the `build.rs` file to force a rebuild when a Markdown file is added or removed, -> a new Markdown test suite might not be run unless some other change in the crate caused a rebuild -> following the addition of the new test file. - -## Assertions - -Two kinds of assertions are supported: `# revealed:` (shown above) and `# error:`. - -### Assertion kinds - -#### revealed - -A `# revealed:` assertion should always be paired with a call to the `reveal_type` utility, which -reveals (via a diagnostic) the inferred type of its argument (which can be any expression). The text -after `# revealed:` must match exactly with the displayed form of the revealed type of that -expression. - -The `reveal_type` function can be imported from the `typing` standard library module (or, for older -Python versions, from the `typing_extensions` pseudo-standard-library module[^extensions]): - -```py -from typing import reveal_type - -reveal_type("foo") # revealed: Literal["foo"] -``` - -For convenience, type checkers also pretend that `reveal_type` is a built-in, so that this import is -not required. Using `reveal_type` without importing it issues a diagnostic warning that it was used -without importing it, in addition to the diagnostic revealing the type of the expression. - -The `# revealed:` assertion must always match a revealed-type diagnostic, and will also match the -undefined-reveal diagnostic, if present, so it's safe to use `reveal_type` in tests either with or -without importing it. (Style preference is to not import it in tests, unless specifically testing -something about the behavior of importing it.) - -#### error - -A comment beginning with `# error:` is an assertion that a type checker diagnostic will be emitted, -with text span starting on that line. The matching can be narrowed in three ways: - -- `# error: [invalid-assignment]` requires that the matched diagnostic have the rule code - `invalid-assignment`. (The square brackets are required.) -- `# error: "Some text"` requires that the diagnostic's full message contain the text `Some text`. - (The double quotes are required in the assertion comment; they are not part of the matched text.) -- `# error: 8 [rule-code]` or `# error: 8 "Some text"` additionally requires that the matched - diagnostic's text span begins on column 8 (one-indexed) of this line. - -Assertions must contain either a rule code or a contains-text, or both, and may optionally also -include a column number. They must come in order: first column, if present; then rule code, if -present; then contains-text, if present. For example, an assertion using all three would look like -`# error: 8 [invalid-assignment] "Some text"`. - -Error assertions in tests intended to test type checker semantics should primarily use rule-code -assertions, with occasional contains-text assertions where needed to disambiguate or validate some -details of the diagnostic message. - -### Assertion locations - -An assertion comment may be a line-trailing comment, in which case it applies to the line it is on: - -```py -x: str = 1 # error: [invalid-assignment] -``` - -Or it may be a comment on its own line, in which case it applies to the next line that does not -contain an assertion comment: - -```py -# error: [invalid-assignment] -x: str = 1 -``` - -Multiple assertions applying to the same line may be stacked: - -```py -# error: [invalid-assignment] -# revealed: Literal[1] -x: str = reveal_type(1) -``` - -Intervening empty lines or non-assertion comments are not allowed; an assertion stack must be one -assertion per line, immediately following each other, with the line immediately following the last -assertion as the line of source code on which the matched diagnostics are emitted. - -## Multi-file tests - -Some tests require multiple files, with imports from one file into another. Multiple fenced code -blocks represent multiple embedded files. Since files must have unique names, at most one file can -use the default name of `/src/test.py`. Other files must explicitly specify their file name: - -````markdown -```py -from b import C -reveal_type(C) # revealed: Literal[C] -``` - -```py path=b.py -class C: pass -``` -```` - -Relative file names are always relative to the "workspace root", which is also an import root (that -is, the equivalent of a runtime entry on `sys.path`). - -The default workspace root is `/src/`. Currently it is not possible to customize this in a test, but -this is a feature we will want to add in the future. - -So the above test creates two files, `/src/test.py` and `/src/b.py`, and sets the workspace root to -`/src/`, allowing `test.py` to import from `b.py` using the module name `b`. - -## Multi-test suites - -A single test suite (Markdown file) can contain multiple tests, by demarcating them using Markdown -header lines: - -````markdown -# Same-file invalid assignment - -```py -x: int = "foo" # error: [invalid-assignment] -``` - -# Cross-file invalid assignment - -```py -from b import y -x: int = y # error: [invalid-assignment] -``` - -```py path=b.py -y = "foo" -``` -```` - -This test suite contains two tests, one named "Same-file invalid assignment" and the other named -"Cross-file invalid assignment". The first test involves only a single embedded file, and the second -test involves two embedded files. - -The tests are run independently, in independent in-memory file systems and with new red-knot -[Salsa](https://github.com/salsa-rs/salsa) databases. This means that each is a from-scratch run of -the type checker, with no data persisting from any previous test. - -Due to `cargo test` limitations, an entire test suite (Markdown file) is run as a single Rust test, -so it's not possible to select individual tests within it to run. - -## Structured test suites - -Markdown headers can also be used to group related tests within a suite: - -````markdown -# Literals - -## Numbers - -### Integer - -```py -reveal_type(1) # revealed: Literal[1] -``` - -### Float - -```py -reveal_type(1.0) # revealed: float -``` - -## Strings - -```py -reveal_type("foo") # revealed: Literal["foo"] -``` -```` - -This test suite contains three tests, named "Literals - Numbers - Integer", "Literals - Numbers - -Float", and "Literals - Strings". - -A header-demarcated section must either be a test or a grouping header; it cannot be both. That is, -a header section can either contain embedded files (making it a test), or it can contain more -deeply-nested headers (headers with more `#`), but it cannot contain both. - -## Documentation of tests - -Arbitrary Markdown syntax (including of course normal prose paragraphs) is permitted (and ignored by -the test framework) between fenced code blocks. This permits natural documentation of -why a test exists, and what it intends to assert: - -````markdown -Assigning a string to a variable annotated as `int` is not permitted: - -```py -x: int = "foo" # error: [invalid-assignment] -``` -```` - -## Planned features - -There are some designed features that we intend for the test framework to have, but have not yet -implemented: - -### Multi-line diagnostic assertions - -We may want to be able to assert that a diagnostic spans multiple lines, and to assert the columns it -begins and/or ends on. The planned syntax for this will use `<<<` and `>>>` to mark the start and end lines for -an assertion: - -```py -(3 # error: 2 [unsupported-operands] <<< - + - "foo") # error: 6 >>> -``` - -The column assertion `6` on the ending line should be optional. - -In cases of overlapping such assertions, resolve ambiguity using more angle brackets: `<<<<` begins -an assertion ended by `>>>>`, etc. - -### Non-Python files - -Some tests may need to specify non-Python embedded files: typeshed `stdlib/VERSIONS`, `pth` files, -`py.typed` files, `pyvenv.cfg` files... - -We will allow specifying any of these using the `text` language in the code block tag string: - -````markdown -```text path=/third-party/foo/py.typed -partial -``` -```` - -We may want to also support testing Jupyter notebooks as embedded files; exact syntax for this is -yet to be determined. - -Of course, red-knot is only run directly on `py` and `pyi` files, and assertion comments are only -possible in these files. - -A fenced code block with no language will always be an error. - -### Configuration - -We will add the ability to specify non-default red-knot configurations to use in tests, by including -a TOML code block: - -````markdown -```toml -[tool.knot] -warn-on-any = true -``` - -```py -from typing import Any - -def f(x: Any): # error: [use-of-any] - pass -``` -```` - -It should be possible to include a TOML code block in a single test (as shown), or in a grouping -section, in which case it applies to all nested tests within that grouping section. Configurations -at multiple level are allowed and merged, with the most-nested (closest to the test) taking -precedence. - -### Running just a single test from a suite - -Having each test in a suite always run as a distinct Rust test would require writing our own test -runner or code-generating tests in a build script; neither of these is planned. - -We could still allow running just a single test from a suite, for debugging purposes, either via -some "focus" syntax that could be easily temporarily added to a test, or via an environment -variable. - -### Configuring search paths and kinds - -The red-knot TOML configuration format hasn't been designed yet, and we may want to implement -support in the test framework for configuring search paths before it is designed. If so, we can -define some configuration options for now under the `[tool.knot.tests]` namespace. In the future, -perhaps some of these can be replaced by real red-knot configuration options; some or all may also -be kept long-term as test-specific options. - -Some configuration options we will want to provide: - -- We should be able to configure the default workspace root to something other than `/src/` using a - `workspace-root` configuration option. - -- We should be able to add a third-party root using the `third-party-root` configuration option. - -- We may want to add additional configuration options for setting additional search path kinds. - -Paths for `workspace-root` and `third-party-root` must be absolute. - -Relative embedded-file paths are relative to the workspace root, even if it is explicitly set to a -non-default value using the `workspace-root` config. - -### Specifying a custom typeshed - -Some tests will need to override the default typeshed with custom files. The `[tool.knot.tests]` -configuration option `typeshed-root` should be usable for this: - -````markdown -```toml -[tool.knot.tests] -typeshed-root = "/typeshed" -``` - -This file is importable as part of our custom typeshed, because it is within `/typeshed`, which we -configured above as our custom typeshed root: - -```py path=/typeshed/stdlib/builtins.pyi -I_AM_THE_ONLY_BUILTIN = 1 -``` - -This file is written to `/src/test.py`, because the default workspace root is `/src/ and the default -file path is `test.py`: - -```py -reveal_type(I_AM_THE_ONLY_BUILTIN) # revealed: Literal[1] -``` - -```` - -A fenced code block with language `text` can be used to provide a `stdlib/VERSIONS` file in the -custom typeshed root. If no such file is created explicitly, one should be created implicitly -including entries enabling all specified `/stdlib` files for all supported Python -versions. - -### I/O errors - -We could use an `error=` configuration option in the tag string to make an embedded file cause an -I/O error on read. - -### Asserting on full diagnostic output - -The inline comment diagnostic assertions are useful for making quick, readable assertions about -diagnostics in a particular location. But sometimes we will want to assert on the full diagnostic -output of checking an embedded Python file. Or sometimes (see “incremental tests” below) we will -want to assert on diagnostics in a file, without impacting the contents of that file by changing a -comment in it. In these cases, a Python code block in a test could be followed by a fenced code -block with language `output`; this would contain the full diagnostic output for the preceding test -file: - -````markdown -# full output - -```py -x = 1 -reveal_type(x) -``` - -This is just an example, not a proposal that red-knot would ever actually output diagnostics in -precisely this format: - -```output -test.py, line 1, col 1: revealed type is 'Literal[1]' -``` -```` - -We will want to build tooling to automatically capture and update these “full diagnostic output” -blocks, when tests are run in an update-output mode (probably specified by an environment variable.) - -By default, an `output` block will specify diagnostic output for the file `/test.py`. -An `output` block can have a `path=` option, to explicitly specify the Python file for which it -asserts diagnostic output, and a `stage=` option, to specify which stage of an incremental test it -specifies diagnostic output at. (See “incremental tests” below.) - -It is an error for an `output` block to exist, if there is no `py` or `python` block in the same -test for the same file path. - -### Incremental tests - -Some tests should validate incremental checking, by initially creating some files, checking them, -and then modifying/adding/deleting files and checking again. - -We should add the capability to create an incremental test by using the `stage=` option on some -fenced code blocks in the test: - -````markdown -# Incremental - -## modify a file - -Initial version of `test.py` and `b.py`: - -```py -from b import x -reveal_type(x) -``` - -```py path=b.py -x = 1 -``` - -Initial expected output for `test.py`: - -```output -/src/test.py, line 1, col 1: revealed type is 'Literal[1]' -``` - -Now in our first incremental stage, modify the contents of `b.py`: - -```py path=b.py stage=1 -# b.py -x = 2 -``` - -And this is our updated expected output for `test.py` at stage 1: - -```output stage=1 -/src/test.py, line 1, col 1: revealed type is 'Literal[2]' -``` - -(One reason to use full-diagnostic-output blocks in this test is that updating -inline-comment diagnostic assertions for `test.py` would require specifying new -contents for `test.py` in stage 1, which we don't want to do in this test.) -```` - -It will be possible to provide any number of stages in an incremental test. If a stage re-specifies -a filename that was specified in a previous stage (or the initial stage), that file is modified. A -new filename appearing for the first time in a new stage will create a new file. To delete a -previously created file, specify that file with the tag `delete` in its tag string (in this case, it -is an error to provide non-empty contents). Any previously-created files that are not re-specified -in a later stage continue to exist with their previously-specified contents, and are not "touched". - -All stages should be run in order, incrementally, and then the final state should also be re-checked -cold, to validate equivalence of cold and incremental check results. - -[^extensions]: `typing-extensions` is a third-party module, but typeshed, and thus type checkers - also, treat it as part of the standard library. diff --git a/crates/red_knot_test/src/assertion.rs b/crates/red_knot_test/src/assertion.rs deleted file mode 100644 index b03a0b8547167..0000000000000 --- a/crates/red_knot_test/src/assertion.rs +++ /dev/null @@ -1,616 +0,0 @@ -//! Parse type and type-error assertions in Python comment form. -//! -//! Parses comments of the form `# revealed: SomeType` and `# error: 8 [rule-code] "message text"`. -//! In the latter case, the `8` is a column number, and `"message text"` asserts that the full -//! diagnostic message contains the text `"message text"`; all three are optional (`# error:` will -//! match any error.) -//! -//! Assertion comments may be placed at end-of-line: -//! -//! ```py -//! x: int = "foo" # error: [invalid-assignment] -//! ``` -//! -//! Or as a full-line comment on the preceding line: -//! -//! ```py -//! # error: [invalid-assignment] -//! x: int = "foo" -//! ``` -//! -//! Multiple assertion comments may apply to the same line; in this case all (or all but the last) -//! must be full-line comments: -//! -//! ```py -//! # error: [unbound-name] -//! reveal_type(x) # revealed: Unbound -//! ``` -//! -//! or -//! -//! ```py -//! # error: [unbound-name] -//! # revealed: Unbound -//! reveal_type(x) -//! ``` - -use crate::db::Db; -use regex::Regex; -use ruff_db::files::File; -use ruff_db::parsed::parsed_module; -use ruff_db::source::{line_index, source_text, SourceText}; -use ruff_python_trivia::CommentRanges; -use ruff_source_file::{LineIndex, OneIndexed}; -use ruff_text_size::{Ranged, TextRange}; -use smallvec::SmallVec; -use std::ops::Deref; -use std::sync::LazyLock; - -/// Diagnostic assertion comments in a single embedded file. -#[derive(Debug)] -pub(crate) struct InlineFileAssertions { - comment_ranges: CommentRanges, - source: SourceText, - lines: LineIndex, -} - -impl InlineFileAssertions { - pub(crate) fn from_file(db: &Db, file: File) -> Self { - let source = source_text(db, file); - let lines = line_index(db, file); - let parsed = parsed_module(db, file); - let comment_ranges = CommentRanges::from(parsed.tokens()); - Self { - comment_ranges, - source, - lines, - } - } - - fn line_number(&self, range: &impl Ranged) -> OneIndexed { - self.lines.line_index(range.start()) - } - - fn is_own_line_comment(&self, ranged_assertion: &AssertionWithRange) -> bool { - CommentRanges::is_own_line(ranged_assertion.start(), self.source.as_str()) - } -} - -impl<'a> IntoIterator for &'a InlineFileAssertions { - type Item = LineAssertions<'a>; - type IntoIter = LineAssertionsIterator<'a>; - - fn into_iter(self) -> Self::IntoIter { - Self::IntoIter { - file_assertions: self, - inner: AssertionWithRangeIterator { - file_assertions: self, - inner: self.comment_ranges.into_iter(), - } - .peekable(), - } - } -} - -/// An [`Assertion`] with the [`TextRange`] of its original inline comment. -#[derive(Debug)] -struct AssertionWithRange<'a>(Assertion<'a>, TextRange); - -impl<'a> Deref for AssertionWithRange<'a> { - type Target = Assertion<'a>; - - fn deref(&self) -> &Self::Target { - &self.0 - } -} - -impl Ranged for AssertionWithRange<'_> { - fn range(&self) -> TextRange { - self.1 - } -} - -impl<'a> From> for Assertion<'a> { - fn from(value: AssertionWithRange<'a>) -> Self { - value.0 - } -} - -/// Iterator that yields all assertions within a single embedded Python file. -#[derive(Debug)] -struct AssertionWithRangeIterator<'a> { - file_assertions: &'a InlineFileAssertions, - inner: std::iter::Copied>, -} - -impl<'a> Iterator for AssertionWithRangeIterator<'a> { - type Item = AssertionWithRange<'a>; - - fn next(&mut self) -> Option { - loop { - let inner_next = self.inner.next()?; - let comment = &self.file_assertions.source[inner_next]; - if let Some(assertion) = Assertion::from_comment(comment) { - return Some(AssertionWithRange(assertion, inner_next)); - }; - } - } -} - -impl std::iter::FusedIterator for AssertionWithRangeIterator<'_> {} - -/// A vector of [`Assertion`]s belonging to a single line. -/// -/// Most lines will have zero or one assertion, so we use a [`SmallVec`] optimized for a single -/// element to avoid most heap vector allocations. -type AssertionVec<'a> = SmallVec<[Assertion<'a>; 1]>; - -#[derive(Debug)] -pub(crate) struct LineAssertionsIterator<'a> { - file_assertions: &'a InlineFileAssertions, - inner: std::iter::Peekable>, -} - -impl<'a> Iterator for LineAssertionsIterator<'a> { - type Item = LineAssertions<'a>; - - fn next(&mut self) -> Option { - let file = self.file_assertions; - let ranged_assertion = self.inner.next()?; - let mut collector = AssertionVec::new(); - let mut line_number = file.line_number(&ranged_assertion); - // Collect all own-line comments on consecutive lines; these all apply to the same line of - // code. For example: - // - // ```py - // # error: [unbound-name] - // # revealed: Unbound - // reveal_type(x) - // ``` - // - if file.is_own_line_comment(&ranged_assertion) { - collector.push(ranged_assertion.into()); - let mut only_own_line = true; - while let Some(ranged_assertion) = self.inner.peek() { - let next_line_number = line_number.saturating_add(1); - if file.line_number(ranged_assertion) == next_line_number { - if !file.is_own_line_comment(ranged_assertion) { - only_own_line = false; - } - line_number = next_line_number; - collector.push(self.inner.next().unwrap().into()); - // If we see an end-of-line comment, it has to be the end of the stack, - // otherwise we'd botch this case, attributing all three errors to the `bar` - // line: - // - // ```py - // # error: - // foo # error: - // bar # error: - // ``` - // - if !only_own_line { - break; - } - } else { - break; - } - } - if only_own_line { - // The collected comments apply to the _next_ line in the code. - line_number = line_number.saturating_add(1); - } - } else { - // We have a line-trailing comment; it applies to its own line, and is not grouped. - collector.push(ranged_assertion.into()); - } - Some(LineAssertions { - line_number, - assertions: collector, - }) - } -} - -impl std::iter::FusedIterator for LineAssertionsIterator<'_> {} - -/// One or more assertions referring to the same line of code. -#[derive(Debug)] -pub(crate) struct LineAssertions<'a> { - /// The line these assertions refer to. - /// - /// Not necessarily the same line the assertion comment is located on; for an own-line comment, - /// it's the next non-assertion line. - pub(crate) line_number: OneIndexed, - - /// The assertions referring to this line. - pub(crate) assertions: AssertionVec<'a>, -} - -impl<'a> Deref for LineAssertions<'a> { - type Target = [Assertion<'a>]; - - fn deref(&self) -> &Self::Target { - &self.assertions - } -} - -static TYPE_RE: LazyLock = - LazyLock::new(|| Regex::new(r"^#\s*revealed:\s*(?.+?)\s*$").unwrap()); - -static ERROR_RE: LazyLock = LazyLock::new(|| { - Regex::new( - r#"^#\s*error:(\s*(?\d+))?(\s*\[(?.+?)\])?(\s*"(?.+?)")?\s*$"#, - ) - .unwrap() -}); - -/// A single diagnostic assertion comment. -#[derive(Debug)] -pub(crate) enum Assertion<'a> { - /// A `revealed: ` assertion. - Revealed(&'a str), - - /// An `error: ` assertion. - Error(ErrorAssertion<'a>), -} - -impl<'a> Assertion<'a> { - fn from_comment(comment: &'a str) -> Option { - if let Some(caps) = TYPE_RE.captures(comment) { - Some(Self::Revealed(caps.name("ty_display").unwrap().as_str())) - } else { - ERROR_RE.captures(comment).map(|caps| { - Self::Error(ErrorAssertion { - rule: caps.name("rule").map(|m| m.as_str()), - column: caps.name("column").and_then(|m| m.as_str().parse().ok()), - message_contains: caps.name("message").map(|m| m.as_str()), - }) - }) - } - } -} - -impl std::fmt::Display for Assertion<'_> { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - Self::Revealed(expected_type) => write!(f, "revealed: {expected_type}"), - Self::Error(assertion) => assertion.fmt(f), - } - } -} - -/// An `error: ` assertion comment. -#[derive(Debug)] -pub(crate) struct ErrorAssertion<'a> { - /// The diagnostic rule code we expect. - pub(crate) rule: Option<&'a str>, - - /// The column we expect the diagnostic range to start at. - pub(crate) column: Option, - - /// A string we expect to be contained in the diagnostic message. - pub(crate) message_contains: Option<&'a str>, -} - -impl std::fmt::Display for ErrorAssertion<'_> { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("error:")?; - if let Some(column) = self.column { - write!(f, " {column}")?; - } - if let Some(rule) = self.rule { - write!(f, " [{rule}]")?; - } - if let Some(message) = self.message_contains { - write!(f, r#" "{message}""#)?; - } - Ok(()) - } -} - -#[cfg(test)] -mod tests { - use super::{Assertion, InlineFileAssertions, LineAssertions}; - use ruff_db::files::system_path_to_file; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use ruff_python_trivia::textwrap::dedent; - use ruff_source_file::OneIndexed; - - fn get_assertions(source: &str) -> InlineFileAssertions { - let mut db = crate::db::Db::setup(SystemPathBuf::from("/src")); - db.write_file("/src/test.py", source).unwrap(); - let file = system_path_to_file(&db, "/src/test.py").unwrap(); - InlineFileAssertions::from_file(&db, file) - } - - fn as_vec(assertions: &InlineFileAssertions) -> Vec { - assertions.into_iter().collect() - } - - #[test] - fn ty_display() { - let assertions = get_assertions(&dedent( - " - reveal_type(1) # revealed: Literal[1] - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), "revealed: Literal[1]"); - } - - #[test] - fn error() { - let assertions = get_assertions(&dedent( - " - x # error: - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), "error:"); - } - - #[test] - fn prior_line() { - let assertions = get_assertions(&dedent( - " - # revealed: Literal[1] - reveal_type(1) - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), "revealed: Literal[1]"); - } - - #[test] - fn stacked_prior_line() { - let assertions = get_assertions(&dedent( - " - # revealed: Unbound - # error: [unbound-name] - reveal_type(x) - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(3)); - - let [assert1, assert2] = &line.assertions[..] else { - panic!("expected two assertions"); - }; - - assert_eq!(format!("{assert1}"), "revealed: Unbound"); - assert_eq!(format!("{assert2}"), "error: [unbound-name]"); - } - - #[test] - fn stacked_mixed() { - let assertions = get_assertions(&dedent( - " - # revealed: Unbound - reveal_type(x) # error: [unbound-name] - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); - - let [assert1, assert2] = &line.assertions[..] else { - panic!("expected two assertions"); - }; - - assert_eq!(format!("{assert1}"), "revealed: Unbound"); - assert_eq!(format!("{assert2}"), "error: [unbound-name]"); - } - - #[test] - fn multiple_lines() { - let assertions = get_assertions(&dedent( - r#" - # error: [invalid-assignment] - x: int = "foo" - y # error: [unbound-name] - "#, - )); - - let [line1, line2] = &as_vec(&assertions)[..] else { - panic!("expected two lines"); - }; - - assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(2)); - assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(3)); - - let [Assertion::Error(error1)] = &line1.assertions[..] else { - panic!("expected one error assertion"); - }; - - assert_eq!(error1.rule, Some("invalid-assignment")); - - let [Assertion::Error(error2)] = &line2.assertions[..] else { - panic!("expected one error assertion"); - }; - - assert_eq!(error2.rule, Some("unbound-name")); - } - - #[test] - fn multiple_lines_mixed_stack() { - let assertions = get_assertions(&dedent( - r#" - # error: [invalid-assignment] - x: int = reveal_type("foo") # revealed: str - y # error: [unbound-name] - "#, - )); - - let [line1, line2] = &as_vec(&assertions)[..] else { - panic!("expected two lines"); - }; - - assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(2)); - assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(3)); - - let [Assertion::Error(error1), Assertion::Revealed(expected_ty)] = &line1.assertions[..] - else { - panic!("expected one error assertion and one Revealed assertion"); - }; - - assert_eq!(error1.rule, Some("invalid-assignment")); - assert_eq!(*expected_ty, "str"); - - let [Assertion::Error(error2)] = &line2.assertions[..] else { - panic!("expected one error assertion"); - }; - - assert_eq!(error2.rule, Some("unbound-name")); - } - - #[test] - fn error_with_rule() { - let assertions = get_assertions(&dedent( - " - x # error: [unbound-name] - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), "error: [unbound-name]"); - } - - #[test] - fn error_with_rule_and_column() { - let assertions = get_assertions(&dedent( - " - x # error: 1 [unbound-name] - ", - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), "error: 1 [unbound-name]"); - } - - #[test] - fn error_with_rule_and_message() { - let assertions = get_assertions(&dedent( - r#" - # error: [unbound-name] "`x` is unbound" - x - "#, - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!( - format!("{assert}"), - r#"error: [unbound-name] "`x` is unbound""# - ); - } - - #[test] - fn error_with_message_and_column() { - let assertions = get_assertions(&dedent( - r#" - # error: 1 "`x` is unbound" - x - "#, - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!(format!("{assert}"), r#"error: 1 "`x` is unbound""#); - } - - #[test] - fn error_with_rule_and_message_and_column() { - let assertions = get_assertions(&dedent( - r#" - # error: 1 [unbound-name] "`x` is unbound" - x - "#, - )); - - let [line] = &as_vec(&assertions)[..] else { - panic!("expected one line"); - }; - - assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); - - let [assert] = &line.assertions[..] else { - panic!("expected one assertion"); - }; - - assert_eq!( - format!("{assert}"), - r#"error: 1 [unbound-name] "`x` is unbound""# - ); - } -} diff --git a/crates/red_knot_test/src/db.rs b/crates/red_knot_test/src/db.rs deleted file mode 100644 index 3cbd2eccb7efd..0000000000000 --- a/crates/red_knot_test/src/db.rs +++ /dev/null @@ -1,93 +0,0 @@ -use red_knot_python_semantic::{ - Db as SemanticDb, Program, ProgramSettings, PythonVersion, SearchPathSettings, -}; -use ruff_db::files::{File, Files}; -use ruff_db::system::{DbWithTestSystem, System, SystemPath, SystemPathBuf, TestSystem}; -use ruff_db::vendored::VendoredFileSystem; -use ruff_db::{Db as SourceDb, Upcast}; - -#[salsa::db] -pub(crate) struct Db { - workspace_root: SystemPathBuf, - storage: salsa::Storage, - files: Files, - system: TestSystem, - vendored: VendoredFileSystem, -} - -impl Db { - pub(crate) fn setup(workspace_root: SystemPathBuf) -> Self { - let db = Self { - workspace_root, - storage: salsa::Storage::default(), - system: TestSystem::default(), - vendored: red_knot_vendored::file_system().clone(), - files: Files::default(), - }; - - db.memory_file_system() - .create_directory_all(&db.workspace_root) - .unwrap(); - - Program::from_settings( - &db, - &ProgramSettings { - target_version: PythonVersion::default(), - search_paths: SearchPathSettings::new(db.workspace_root.clone()), - }, - ) - .expect("Invalid search path settings"); - - db - } - - pub(crate) fn workspace_root(&self) -> &SystemPath { - &self.workspace_root - } -} - -impl DbWithTestSystem for Db { - fn test_system(&self) -> &TestSystem { - &self.system - } - - fn test_system_mut(&mut self) -> &mut TestSystem { - &mut self.system - } -} - -#[salsa::db] -impl SourceDb for Db { - fn vendored(&self) -> &VendoredFileSystem { - &self.vendored - } - - fn system(&self) -> &dyn System { - &self.system - } - - fn files(&self) -> &Files { - &self.files - } -} - -impl Upcast for Db { - fn upcast(&self) -> &(dyn SourceDb + 'static) { - self - } - fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { - self - } -} - -#[salsa::db] -impl SemanticDb for Db { - fn is_file_open(&self, file: File) -> bool { - !file.path(self).is_vendored_path() - } -} - -#[salsa::db] -impl salsa::Database for Db { - fn salsa_event(&self, _event: &dyn Fn() -> salsa::Event) {} -} diff --git a/crates/red_knot_test/src/diagnostic.rs b/crates/red_knot_test/src/diagnostic.rs deleted file mode 100644 index 56e4a87906c57..0000000000000 --- a/crates/red_knot_test/src/diagnostic.rs +++ /dev/null @@ -1,173 +0,0 @@ -//! Sort and group diagnostics by line number, so they can be correlated with assertions. -//! -//! We don't assume that we will get the diagnostics in source order. - -use ruff_source_file::{LineIndex, OneIndexed}; -use ruff_text_size::Ranged; -use std::ops::{Deref, Range}; - -/// All diagnostics for one embedded Python file, sorted and grouped by start line number. -/// -/// The diagnostics are kept in a flat vector, sorted by line number. A separate vector of -/// [`LineDiagnosticRange`] has one entry for each contiguous slice of the diagnostics vector -/// containing diagnostics which all start on the same line. -#[derive(Debug)] -pub(crate) struct SortedDiagnostics { - diagnostics: Vec, - line_ranges: Vec, -} - -impl SortedDiagnostics -where - T: Ranged + Clone, -{ - pub(crate) fn new(diagnostics: impl IntoIterator, line_index: &LineIndex) -> Self { - let mut diagnostics: Vec<_> = diagnostics - .into_iter() - .map(|diagnostic| DiagnosticWithLine { - line_number: line_index.line_index(diagnostic.start()), - diagnostic, - }) - .collect(); - diagnostics.sort_unstable_by_key(|diagnostic_with_line| diagnostic_with_line.line_number); - - let mut diags = Self { - diagnostics: Vec::with_capacity(diagnostics.len()), - line_ranges: vec![], - }; - - let mut current_line_number = None; - let mut start = 0; - for DiagnosticWithLine { - line_number, - diagnostic, - } in diagnostics - { - match current_line_number { - None => { - current_line_number = Some(line_number); - } - Some(current) => { - if line_number != current { - let end = diags.diagnostics.len(); - diags.line_ranges.push(LineDiagnosticRange { - line_number: current, - diagnostic_index_range: start..end, - }); - start = end; - current_line_number = Some(line_number); - } - } - } - diags.diagnostics.push(diagnostic); - } - if let Some(line_number) = current_line_number { - diags.line_ranges.push(LineDiagnosticRange { - line_number, - diagnostic_index_range: start..diags.diagnostics.len(), - }); - } - - diags - } - - pub(crate) fn iter_lines(&self) -> LineDiagnosticsIterator { - LineDiagnosticsIterator { - diagnostics: self.diagnostics.as_slice(), - inner: self.line_ranges.iter(), - } - } -} - -/// Range delineating diagnostics in [`SortedDiagnostics`] that begin on a single line. -#[derive(Debug)] -struct LineDiagnosticRange { - line_number: OneIndexed, - diagnostic_index_range: Range, -} - -/// Iterator to group sorted diagnostics by line. -pub(crate) struct LineDiagnosticsIterator<'a, T> { - diagnostics: &'a [T], - inner: std::slice::Iter<'a, LineDiagnosticRange>, -} - -impl<'a, T> Iterator for LineDiagnosticsIterator<'a, T> -where - T: Ranged + Clone, -{ - type Item = LineDiagnostics<'a, T>; - - fn next(&mut self) -> Option { - let LineDiagnosticRange { - line_number, - diagnostic_index_range, - } = self.inner.next()?; - Some(LineDiagnostics { - line_number: *line_number, - diagnostics: &self.diagnostics[diagnostic_index_range.clone()], - }) - } -} - -impl std::iter::FusedIterator for LineDiagnosticsIterator<'_, T> where T: Clone + Ranged {} - -/// All diagnostics that start on a single line of source code in one embedded Python file. -#[derive(Debug)] -pub(crate) struct LineDiagnostics<'a, T> { - /// Line number on which these diagnostics start. - pub(crate) line_number: OneIndexed, - - /// Diagnostics starting on this line. - pub(crate) diagnostics: &'a [T], -} - -impl Deref for LineDiagnostics<'_, T> { - type Target = [T]; - - fn deref(&self) -> &Self::Target { - self.diagnostics - } -} - -#[derive(Debug)] -struct DiagnosticWithLine { - line_number: OneIndexed, - diagnostic: T, -} - -#[cfg(test)] -mod tests { - use crate::db::Db; - use ruff_db::files::system_path_to_file; - use ruff_db::source::line_index; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use ruff_source_file::OneIndexed; - use ruff_text_size::{TextRange, TextSize}; - - #[test] - fn sort_and_group() { - let mut db = Db::setup(SystemPathBuf::from("/src")); - db.write_file("/src/test.py", "one\ntwo\n").unwrap(); - let file = system_path_to_file(&db, "/src/test.py").unwrap(); - let lines = line_index(&db, file); - - let ranges = vec![ - TextRange::new(TextSize::new(0), TextSize::new(1)), - TextRange::new(TextSize::new(5), TextSize::new(10)), - TextRange::new(TextSize::new(1), TextSize::new(7)), - ]; - - let sorted = super::SortedDiagnostics::new(&ranges, &lines); - let grouped = sorted.iter_lines().collect::>(); - - let [line1, line2] = &grouped[..] else { - panic!("expected two lines"); - }; - - assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(0)); - assert_eq!(line1.diagnostics.len(), 2); - assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(1)); - assert_eq!(line2.diagnostics.len(), 1); - } -} diff --git a/crates/red_knot_test/src/lib.rs b/crates/red_knot_test/src/lib.rs deleted file mode 100644 index cd49a98041f74..0000000000000 --- a/crates/red_knot_test/src/lib.rs +++ /dev/null @@ -1,132 +0,0 @@ -use colored::Colorize; -use parser as test_parser; -use red_knot_python_semantic::types::check_types; -use ruff_db::files::{system_path_to_file, File, Files}; -use ruff_db::parsed::parsed_module; -use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; -use ruff_source_file::LineIndex; -use ruff_text_size::TextSize; -use std::path::Path; - -mod assertion; -mod db; -mod diagnostic; -mod matcher; -mod parser; - -/// Run `path` as a markdown test suite with given `title`. -/// -/// Panic on test failure, and print failure details. -#[allow(clippy::print_stdout)] -pub fn run(path: &Path, title: &str) { - let source = std::fs::read_to_string(path).unwrap(); - let suite = match test_parser::parse(title, &source) { - Ok(suite) => suite, - Err(err) => { - panic!("Error parsing `{}`: {err}", path.to_str().unwrap()) - } - }; - - let mut db = db::Db::setup(SystemPathBuf::from("/src")); - - let mut any_failures = false; - for test in suite.tests() { - // Remove all files so that the db is in a "fresh" state. - db.memory_file_system().remove_all(); - Files::sync_all(&mut db); - - if let Err(failures) = run_test(&mut db, &test) { - any_failures = true; - println!("\n{}\n", test.name().bold().underline()); - - let md_index = LineIndex::from_source_text(&source); - - for test_failures in failures { - let backtick_line = md_index.line_index(test_failures.backtick_offset); - - for (relative_line_number, failures) in test_failures.by_line.iter() { - for failure in failures { - let absolute_line_number = - backtick_line.checked_add(relative_line_number).unwrap(); - let line_info = format!("{title}:{absolute_line_number}").cyan(); - println!(" {line_info} {failure}"); - } - } - } - } - } - - println!("\n{}\n", "-".repeat(50)); - - assert!(!any_failures, "Some tests failed."); -} - -fn run_test(db: &mut db::Db, test: &parser::MarkdownTest) -> Result<(), Failures> { - let workspace_root = db.workspace_root().to_path_buf(); - - let test_files: Vec<_> = test - .files() - .map(|embedded| { - assert!( - matches!(embedded.lang, "py" | "pyi"), - "Non-Python files not supported yet." - ); - let full_path = workspace_root.join(embedded.path); - db.write_file(&full_path, embedded.code).unwrap(); - let file = system_path_to_file(db, full_path).unwrap(); - - TestFile { - file, - backtick_offset: embedded.md_offset, - } - }) - .collect(); - - let failures: Failures = test_files - .into_iter() - .filter_map(|test_file| { - let parsed = parsed_module(db, test_file.file); - - // TODO allow testing against code with syntax errors - assert!( - parsed.errors().is_empty(), - "Python syntax errors in {}, {}: {:?}", - test.name(), - test_file.file.path(db), - parsed.errors() - ); - - match matcher::match_file(db, test_file.file, check_types(db, test_file.file)) { - Ok(()) => None, - Err(line_failures) => Some(FileFailures { - backtick_offset: test_file.backtick_offset, - by_line: line_failures, - }), - } - }) - .collect(); - - if failures.is_empty() { - Ok(()) - } else { - Err(failures) - } -} - -type Failures = Vec; - -/// The failures for a single file in a test by line number. -struct FileFailures { - /// The offset of the backticks that starts the code block in the Markdown file - backtick_offset: TextSize, - /// The failures by lines in the code block. - by_line: matcher::FailuresByLine, -} - -/// File in a test. -struct TestFile { - file: File, - - // Offset of the backticks that starts the code block in the Markdown file - backtick_offset: TextSize, -} diff --git a/crates/red_knot_test/src/matcher.rs b/crates/red_knot_test/src/matcher.rs deleted file mode 100644 index fbc3d9ba7739d..0000000000000 --- a/crates/red_knot_test/src/matcher.rs +++ /dev/null @@ -1,929 +0,0 @@ -//! Match [`TypeCheckDiagnostic`]s against [`Assertion`]s and produce test failure messages for any -//! mismatches. -use crate::assertion::{Assertion, ErrorAssertion, InlineFileAssertions}; -use crate::db::Db; -use crate::diagnostic::SortedDiagnostics; -use colored::Colorize; -use red_knot_python_semantic::types::TypeCheckDiagnostic; -use ruff_db::files::File; -use ruff_db::source::{line_index, source_text, SourceText}; -use ruff_source_file::{LineIndex, OneIndexed}; -use ruff_text_size::Ranged; -use std::cmp::Ordering; -use std::ops::Range; -use std::sync::Arc; - -#[derive(Debug, Default)] -pub(super) struct FailuresByLine { - failures: Vec, - lines: Vec, -} - -impl FailuresByLine { - pub(super) fn iter(&self) -> impl Iterator { - self.lines.iter().map(|line_failures| { - ( - line_failures.line_number, - &self.failures[line_failures.range.clone()], - ) - }) - } - - fn push(&mut self, line_number: OneIndexed, messages: Vec) { - let start = self.failures.len(); - self.failures.extend(messages); - self.lines.push(LineFailures { - line_number, - range: start..self.failures.len(), - }); - } - - fn is_empty(&self) -> bool { - self.lines.is_empty() - } -} - -#[derive(Debug)] -struct LineFailures { - line_number: OneIndexed, - range: Range, -} - -pub(super) fn match_file( - db: &Db, - file: File, - diagnostics: impl IntoIterator, -) -> Result<(), FailuresByLine> -where - T: Diagnostic + Clone, -{ - // Parse assertions from comments in the file, and get diagnostics from the file; both - // ordered by line number. - let assertions = InlineFileAssertions::from_file(db, file); - let diagnostics = SortedDiagnostics::new(diagnostics, &line_index(db, file)); - - // Get iterators over assertions and diagnostics grouped by line, in ascending line order. - let mut line_assertions = assertions.into_iter(); - let mut line_diagnostics = diagnostics.iter_lines(); - - let mut current_assertions = line_assertions.next(); - let mut current_diagnostics = line_diagnostics.next(); - - let matcher = Matcher::from_file(db, file); - let mut failures = FailuresByLine::default(); - - loop { - match (¤t_assertions, ¤t_diagnostics) { - (Some(assertions), Some(diagnostics)) => { - match assertions.line_number.cmp(&diagnostics.line_number) { - Ordering::Equal => { - // We have assertions and diagnostics on the same line; check for - // matches and error on any that don't match, then advance both - // iterators. - matcher - .match_line(diagnostics, assertions) - .unwrap_or_else(|messages| { - failures.push(assertions.line_number, messages); - }); - current_assertions = line_assertions.next(); - current_diagnostics = line_diagnostics.next(); - } - Ordering::Less => { - // We have assertions on an earlier line than diagnostics; report these - // assertions as all unmatched, and advance the assertions iterator. - failures.push(assertions.line_number, unmatched(assertions)); - current_assertions = line_assertions.next(); - } - Ordering::Greater => { - // We have diagnostics on an earlier line than assertions; report these - // diagnostics as all unmatched, and advance the diagnostics iterator. - failures.push(diagnostics.line_number, unmatched(diagnostics)); - current_diagnostics = line_diagnostics.next(); - } - } - } - (Some(assertions), None) => { - // We've exhausted diagnostics but still have assertions; report these assertions - // as unmatched and advance the assertions iterator. - failures.push(assertions.line_number, unmatched(assertions)); - current_assertions = line_assertions.next(); - } - (None, Some(diagnostics)) => { - // We've exhausted assertions but still have diagnostics; report these - // diagnostics as unmatched and advance the diagnostics iterator. - failures.push(diagnostics.line_number, unmatched(diagnostics)); - current_diagnostics = line_diagnostics.next(); - } - // When we've exhausted both diagnostics and assertions, break. - (None, None) => break, - } - } - - if failures.is_empty() { - Ok(()) - } else { - Err(failures) - } -} - -pub(super) trait Diagnostic: Ranged { - fn rule(&self) -> &str; - - fn message(&self) -> &str; -} - -impl Diagnostic for Arc { - fn rule(&self) -> &str { - self.as_ref().rule() - } - - fn message(&self) -> &str { - self.as_ref().message() - } -} - -trait Unmatched { - fn unmatched(&self) -> String; -} - -fn unmatched<'a, T: Unmatched + 'a>(unmatched: &'a [T]) -> Vec { - unmatched.iter().map(Unmatched::unmatched).collect() -} - -trait UnmatchedWithColumn { - fn unmatched_with_column(&self, column: OneIndexed) -> String; -} - -impl Unmatched for Assertion<'_> { - fn unmatched(&self) -> String { - format!("{} {self}", "unmatched assertion:".red()) - } -} - -fn maybe_add_undefined_reveal_clarification( - diagnostic: &T, - original: std::fmt::Arguments, -) -> String { - if diagnostic.rule() == "undefined-reveal" { - format!( - "{} add a `# revealed` assertion on this line (original diagnostic: {original})", - "used built-in `reveal_type`:".yellow() - ) - } else { - format!("{} {original}", "unexpected error:".red()) - } -} - -impl Unmatched for T -where - T: Diagnostic, -{ - fn unmatched(&self) -> String { - maybe_add_undefined_reveal_clarification( - self, - format_args!(r#"[{}] "{}""#, self.rule(), self.message()), - ) - } -} - -impl UnmatchedWithColumn for T -where - T: Diagnostic, -{ - fn unmatched_with_column(&self, column: OneIndexed) -> String { - maybe_add_undefined_reveal_clarification( - self, - format_args!(r#"{column} [{}] "{}""#, self.rule(), self.message()), - ) - } -} - -struct Matcher { - line_index: LineIndex, - source: SourceText, -} - -impl Matcher { - fn from_file(db: &Db, file: File) -> Self { - Self { - line_index: line_index(db, file), - source: source_text(db, file), - } - } - - /// Check a slice of [`Diagnostic`]s against a slice of [`Assertion`]s. - /// - /// Return vector of [`Unmatched`] for any unmatched diagnostics or assertions. - fn match_line<'a, 'b, T: Diagnostic + 'a>( - &self, - diagnostics: &'a [T], - assertions: &'a [Assertion<'b>], - ) -> Result<(), Vec> - where - 'b: 'a, - { - let mut failures = vec![]; - let mut unmatched: Vec<_> = diagnostics.iter().collect(); - for assertion in assertions { - if matches!( - assertion, - Assertion::Error(ErrorAssertion { - rule: None, - message_contains: None, - .. - }) - ) { - failures.push(format!( - "{} no rule or message text", - "invalid assertion:".red() - )); - continue; - } - if !self.matches(assertion, &mut unmatched) { - failures.push(assertion.unmatched()); - } - } - for diagnostic in unmatched { - failures.push(diagnostic.unmatched_with_column(self.column(diagnostic))); - } - if failures.is_empty() { - Ok(()) - } else { - Err(failures) - } - } - - fn column(&self, ranged: &T) -> OneIndexed { - self.line_index - .source_location(ranged.start(), &self.source) - .column - } - - /// Check if `assertion` matches any [`Diagnostic`]s in `unmatched`. - /// - /// If so, return `true` and remove the matched diagnostics from `unmatched`. Otherwise, return - /// `false`. - /// - /// An `Error` assertion can only match one diagnostic; even if it could match more than one, - /// we short-circuit after the first match. - /// - /// A `Revealed` assertion must match a revealed-type diagnostic, and may also match an - /// undefined-reveal diagnostic, if present. - fn matches(&self, assertion: &Assertion, unmatched: &mut Vec<&T>) -> bool { - match assertion { - Assertion::Error(error) => { - let position = unmatched.iter().position(|diagnostic| { - !error.rule.is_some_and(|rule| rule != diagnostic.rule()) - && !error - .column - .is_some_and(|col| col != self.column(*diagnostic)) - && !error - .message_contains - .is_some_and(|needle| !diagnostic.message().contains(needle)) - }); - if let Some(position) = position { - unmatched.swap_remove(position); - true - } else { - false - } - } - Assertion::Revealed(expected_type) => { - let mut matched_revealed_type = None; - let mut matched_undefined_reveal = None; - let expected_reveal_type_message = format!("Revealed type is `{expected_type}`"); - for (index, diagnostic) in unmatched.iter().enumerate() { - if matched_revealed_type.is_none() - && diagnostic.rule() == "revealed-type" - && diagnostic.message() == expected_reveal_type_message - { - matched_revealed_type = Some(index); - } else if matched_undefined_reveal.is_none() - && diagnostic.rule() == "undefined-reveal" - { - matched_undefined_reveal = Some(index); - } - if matched_revealed_type.is_some() && matched_undefined_reveal.is_some() { - break; - } - } - let mut idx = 0; - unmatched.retain(|_| { - let retain = - Some(idx) != matched_revealed_type && Some(idx) != matched_undefined_reveal; - idx += 1; - retain - }); - matched_revealed_type.is_some() - } - } - } -} - -#[cfg(test)] -mod tests { - use super::FailuresByLine; - use ruff_db::files::system_path_to_file; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use ruff_python_trivia::textwrap::dedent; - use ruff_source_file::OneIndexed; - use ruff_text_size::{Ranged, TextRange}; - - #[derive(Clone, Debug)] - struct TestDiagnostic { - rule: &'static str, - message: &'static str, - range: TextRange, - } - - impl TestDiagnostic { - fn new(rule: &'static str, message: &'static str, offset: usize) -> Self { - let offset: u32 = offset.try_into().unwrap(); - Self { - rule, - message, - range: TextRange::new(offset.into(), (offset + 1).into()), - } - } - } - - impl super::Diagnostic for TestDiagnostic { - fn rule(&self) -> &str { - self.rule - } - - fn message(&self) -> &str { - self.message - } - } - - impl Ranged for TestDiagnostic { - fn range(&self) -> ruff_text_size::TextRange { - self.range - } - } - - fn get_result(source: &str, diagnostics: Vec) -> Result<(), FailuresByLine> { - colored::control::set_override(false); - - let mut db = crate::db::Db::setup(SystemPathBuf::from("/src")); - db.write_file("/src/test.py", source).unwrap(); - let file = system_path_to_file(&db, "/src/test.py").unwrap(); - - super::match_file(&db, file, diagnostics) - } - - fn assert_fail(result: Result<(), FailuresByLine>, messages: &[(usize, &[&str])]) { - let Err(failures) = result else { - panic!("expected a failure"); - }; - - let expected: Vec<(OneIndexed, Vec)> = messages - .iter() - .map(|(idx, msgs)| { - ( - OneIndexed::from_zero_indexed(*idx), - msgs.iter().map(ToString::to_string).collect(), - ) - }) - .collect(); - let failures: Vec<(OneIndexed, Vec)> = failures - .iter() - .map(|(idx, msgs)| (idx, msgs.to_vec())) - .collect(); - - assert_eq!(failures, expected); - } - - fn assert_ok(result: &Result<(), FailuresByLine>) { - assert!(result.is_ok(), "{result:?}"); - } - - #[test] - fn revealed_match() { - let result = get_result( - "x # revealed: Foo", - vec![TestDiagnostic::new( - "revealed-type", - "Revealed type is `Foo`", - 0, - )], - ); - - assert_ok(&result); - } - - #[test] - fn revealed_wrong_rule() { - let result = get_result( - "x # revealed: Foo", - vec![TestDiagnostic::new( - "not-revealed-type", - "Revealed type is `Foo`", - 0, - )], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: revealed: Foo", - r#"unexpected error: 1 [not-revealed-type] "Revealed type is `Foo`""#, - ], - )], - ); - } - - #[test] - fn revealed_wrong_message() { - let result = get_result( - "x # revealed: Foo", - vec![TestDiagnostic::new("revealed-type", "Something else", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: revealed: Foo", - r#"unexpected error: 1 [revealed-type] "Something else""#, - ], - )], - ); - } - - #[test] - fn revealed_unmatched() { - let result = get_result("x # revealed: Foo", vec![]); - - assert_fail(result, &[(0, &["unmatched assertion: revealed: Foo"])]); - } - - #[test] - fn revealed_match_with_undefined() { - let result = get_result( - "x # revealed: Foo", - vec![ - TestDiagnostic::new("revealed-type", "Revealed type is `Foo`", 0), - TestDiagnostic::new("undefined-reveal", "Doesn't matter", 0), - ], - ); - - assert_ok(&result); - } - - #[test] - fn revealed_match_with_only_undefined() { - let result = get_result( - "x # revealed: Foo", - vec![TestDiagnostic::new("undefined-reveal", "Doesn't matter", 0)], - ); - - assert_fail(result, &[(0, &["unmatched assertion: revealed: Foo"])]); - } - - #[test] - fn revealed_mismatch_with_undefined() { - let result = get_result( - "x # revealed: Foo", - vec![ - TestDiagnostic::new("revealed-type", "Revealed type is `Bar`", 0), - TestDiagnostic::new("undefined-reveal", "Doesn't matter", 0), - ], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: revealed: Foo", - r#"unexpected error: 1 [revealed-type] "Revealed type is `Bar`""#, - ], - )], - ); - } - - #[test] - fn undefined_reveal_type_unmatched() { - let result = get_result( - "reveal_type(1)", - vec![ - TestDiagnostic::new("undefined-reveal", "undefined reveal message", 0), - TestDiagnostic::new("revealed-type", "Revealed type is `Literal[1]`", 12), - ], - ); - - assert_fail( - result, - &[( - 0, - &[ - "used built-in `reveal_type`: add a `# revealed` assertion on this line (\ - original diagnostic: [undefined-reveal] \"undefined reveal message\")", - r#"unexpected error: [revealed-type] "Revealed type is `Literal[1]`""#, - ], - )], - ); - } - - #[test] - fn undefined_reveal_type_mismatched() { - let result = get_result( - "reveal_type(1) # error: [something-else]", - vec![ - TestDiagnostic::new("undefined-reveal", "undefined reveal message", 0), - TestDiagnostic::new("revealed-type", "Revealed type is `Literal[1]`", 12), - ], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: error: [something-else]", - "used built-in `reveal_type`: add a `# revealed` assertion on this line (\ - original diagnostic: 1 [undefined-reveal] \"undefined reveal message\")", - r#"unexpected error: 13 [revealed-type] "Revealed type is `Literal[1]`""#, - ], - )], - ); - } - - #[test] - fn error_unmatched() { - let result = get_result("x # error: [rule]", vec![]); - - assert_fail(result, &[(0, &["unmatched assertion: error: [rule]"])]); - } - - #[test] - fn error_match_rule() { - let result = get_result( - "x # error: [some-rule]", - vec![TestDiagnostic::new("some-rule", "Any message", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_wrong_rule() { - let result = get_result( - "x # error: [some-rule]", - vec![TestDiagnostic::new("anything", "Any message", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: error: [some-rule]", - r#"unexpected error: 1 [anything] "Any message""#, - ], - )], - ); - } - - #[test] - fn error_match_message() { - let result = get_result( - r#"x # error: "contains this""#, - vec![TestDiagnostic::new("anything", "message contains this", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_wrong_message() { - let result = get_result( - r#"x # error: "contains this""#, - vec![TestDiagnostic::new("anything", "Any message", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - r#"unmatched assertion: error: "contains this""#, - r#"unexpected error: 1 [anything] "Any message""#, - ], - )], - ); - } - - #[test] - fn error_match_column_and_rule() { - let result = get_result( - "x # error: 1 [some-rule]", - vec![TestDiagnostic::new("some-rule", "Any message", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_wrong_column() { - let result = get_result( - "x # error: 2 [rule]", - vec![TestDiagnostic::new("rule", "Any message", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - "unmatched assertion: error: 2 [rule]", - r#"unexpected error: 1 [rule] "Any message""#, - ], - )], - ); - } - - #[test] - fn error_match_column_and_message() { - let result = get_result( - r#"x # error: 1 "contains this""#, - vec![TestDiagnostic::new("anything", "message contains this", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_match_rule_and_message() { - let result = get_result( - r#"x # error: [a-rule] "contains this""#, - vec![TestDiagnostic::new("a-rule", "message contains this", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_match_all() { - let result = get_result( - r#"x # error: 1 [a-rule] "contains this""#, - vec![TestDiagnostic::new("a-rule", "message contains this", 0)], - ); - - assert_ok(&result); - } - - #[test] - fn error_match_all_wrong_column() { - let result = get_result( - r#"x # error: 2 [some-rule] "contains this""#, - vec![TestDiagnostic::new("some-rule", "message contains this", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - r#"unmatched assertion: error: 2 [some-rule] "contains this""#, - r#"unexpected error: 1 [some-rule] "message contains this""#, - ], - )], - ); - } - - #[test] - fn error_match_all_wrong_rule() { - let result = get_result( - r#"x # error: 1 [some-rule] "contains this""#, - vec![TestDiagnostic::new( - "other-rule", - "message contains this", - 0, - )], - ); - - assert_fail( - result, - &[( - 0, - &[ - r#"unmatched assertion: error: 1 [some-rule] "contains this""#, - r#"unexpected error: 1 [other-rule] "message contains this""#, - ], - )], - ); - } - - #[test] - fn error_match_all_wrong_message() { - let result = get_result( - r#"x # error: 1 [some-rule] "contains this""#, - vec![TestDiagnostic::new("some-rule", "Any message", 0)], - ); - - assert_fail( - result, - &[( - 0, - &[ - r#"unmatched assertion: error: 1 [some-rule] "contains this""#, - r#"unexpected error: 1 [some-rule] "Any message""#, - ], - )], - ); - } - - #[test] - fn interspersed_matches_and_mismatches() { - let source = dedent( - r#" - 1 # error: [line-one] - 2 - 3 # error: [line-three] - 4 # error: [line-four] - 5 - 6: # error: [line-six] - "#, - ); - let two = source.find('2').unwrap(); - let three = source.find('3').unwrap(); - let five = source.find('5').unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("line-two", "msg", two), - TestDiagnostic::new("line-three", "msg", three), - TestDiagnostic::new("line-five", "msg", five), - ], - ); - - assert_fail( - result, - &[ - (1, &["unmatched assertion: error: [line-one]"]), - (2, &[r#"unexpected error: [line-two] "msg""#]), - (4, &["unmatched assertion: error: [line-four]"]), - (5, &[r#"unexpected error: [line-five] "msg""#]), - (6, &["unmatched assertion: error: [line-six]"]), - ], - ); - } - - #[test] - fn more_diagnostics_than_assertions() { - let source = dedent( - r#" - 1 # error: [line-one] - 2 - "#, - ); - let one = source.find('1').unwrap(); - let two = source.find('2').unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("line-one", "msg", one), - TestDiagnostic::new("line-two", "msg", two), - ], - ); - - assert_fail(result, &[(2, &[r#"unexpected error: [line-two] "msg""#])]); - } - - #[test] - fn multiple_assertions_and_diagnostics_same_line() { - let source = dedent( - " - # error: [one-rule] - # error: [other-rule] - x - ", - ); - let x = source.find('x').unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("one-rule", "msg", x), - TestDiagnostic::new("other-rule", "msg", x), - ], - ); - - assert_ok(&result); - } - - #[test] - fn multiple_assertions_and_diagnostics_same_line_all_same() { - let source = dedent( - " - # error: [one-rule] - # error: [one-rule] - x - ", - ); - let x = source.find('x').unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("one-rule", "msg", x), - TestDiagnostic::new("one-rule", "msg", x), - ], - ); - - assert_ok(&result); - } - - #[test] - fn multiple_assertions_and_diagnostics_same_line_mismatch() { - let source = dedent( - " - # error: [one-rule] - # error: [other-rule] - x - ", - ); - let x = source.find('x').unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("one-rule", "msg", x), - TestDiagnostic::new("other-rule", "msg", x), - TestDiagnostic::new("third-rule", "msg", x), - ], - ); - - assert_fail( - result, - &[(3, &[r#"unexpected error: 1 [third-rule] "msg""#])], - ); - } - - #[test] - fn parenthesized_expression() { - let source = dedent( - " - a = b + ( - error: [undefined-reveal] - reveal_type(5) # revealed: Literal[5] - ) - ", - ); - let reveal = source.find("reveal_type").unwrap(); - let result = get_result( - &source, - vec![ - TestDiagnostic::new("undefined-reveal", "msg", reveal), - TestDiagnostic::new("revealed-type", "Revealed type is `Literal[5]`", reveal), - ], - ); - - assert_ok(&result); - } - - #[test] - fn bare_error_assertion_not_allowed() { - let source = "x # error:"; - let x = source.find('x').unwrap(); - let result = get_result( - source, - vec![TestDiagnostic::new("some-rule", "some message", x)], - ); - - assert_fail( - result, - &[( - 0, - &[ - "invalid assertion: no rule or message text", - r#"unexpected error: 1 [some-rule] "some message""#, - ], - )], - ); - } - - #[test] - fn column_only_error_assertion_not_allowed() { - let source = "x # error: 1"; - let x = source.find('x').unwrap(); - let result = get_result( - source, - vec![TestDiagnostic::new("some-rule", "some message", x)], - ); - - assert_fail( - result, - &[( - 0, - &[ - "invalid assertion: no rule or message text", - r#"unexpected error: 1 [some-rule] "some message""#, - ], - )], - ); - } -} diff --git a/crates/red_knot_test/src/parser.rs b/crates/red_knot_test/src/parser.rs deleted file mode 100644 index 79e9306a5c581..0000000000000 --- a/crates/red_knot_test/src/parser.rs +++ /dev/null @@ -1,731 +0,0 @@ -use std::sync::LazyLock; - -use memchr::memchr2; -use regex::{Captures, Match, Regex}; -use rustc_hash::{FxHashMap, FxHashSet}; - -use ruff_index::{newtype_index, IndexVec}; -use ruff_python_trivia::Cursor; -use ruff_text_size::{TextLen, TextSize}; - -/// Parse the Markdown `source` as a test suite with given `title`. -pub(crate) fn parse<'s>(title: &'s str, source: &'s str) -> anyhow::Result> { - let parser = Parser::new(title, source); - parser.parse() -} - -/// A parsed markdown file containing tests. -/// -/// Borrows from the source string and filepath it was created from. -#[derive(Debug)] -pub(crate) struct MarkdownTestSuite<'s> { - /// Header sections. - sections: IndexVec>, - - /// Test files embedded within the Markdown file. - files: IndexVec>, -} - -impl<'s> MarkdownTestSuite<'s> { - pub(crate) fn tests(&self) -> MarkdownTestIterator<'_, 's> { - MarkdownTestIterator { - suite: self, - current_file_index: 0, - } - } -} - -/// A single test inside a [`MarkdownTestSuite`]. -/// -/// A test is a single header section (or the implicit root section, if there are no Markdown -/// headers in the file), containing one or more embedded Python files as fenced code blocks, and -/// containing no nested header subsections. -#[derive(Debug)] -pub(crate) struct MarkdownTest<'m, 's> { - suite: &'m MarkdownTestSuite<'s>, - section: &'m Section<'s>, - files: &'m [EmbeddedFile<'s>], -} - -impl<'m, 's> MarkdownTest<'m, 's> { - pub(crate) fn name(&self) -> String { - let mut name = String::new(); - let mut parent_id = self.section.parent_id; - while let Some(next_id) = parent_id { - let parent = &self.suite.sections[next_id]; - parent_id = parent.parent_id; - if !name.is_empty() { - name.insert_str(0, " - "); - } - name.insert_str(0, parent.title); - } - if !name.is_empty() { - name.push_str(" - "); - } - name.push_str(self.section.title); - name - } - - pub(crate) fn files(&self) -> impl Iterator> { - self.files.iter() - } -} - -/// Iterator yielding all [`MarkdownTest`]s in a [`MarkdownTestSuite`]. -#[derive(Debug)] -pub(crate) struct MarkdownTestIterator<'m, 's> { - suite: &'m MarkdownTestSuite<'s>, - current_file_index: usize, -} - -impl<'m, 's> Iterator for MarkdownTestIterator<'m, 's> { - type Item = MarkdownTest<'m, 's>; - - fn next(&mut self) -> Option { - let mut current_file_index = self.current_file_index; - let mut file = self.suite.files.get(current_file_index.into()); - let section_id = file?.section; - while file.is_some_and(|file| file.section == section_id) { - current_file_index += 1; - file = self.suite.files.get(current_file_index.into()); - } - let files = &self.suite.files[EmbeddedFileId::from_usize(self.current_file_index) - ..EmbeddedFileId::from_usize(current_file_index)]; - self.current_file_index = current_file_index; - Some(MarkdownTest { - suite: self.suite, - section: &self.suite.sections[section_id], - files, - }) - } -} - -#[newtype_index] -struct SectionId; - -/// A single header section of a [`MarkdownTestSuite`], or the implicit root "section". -/// -/// A header section is the part of a Markdown file beginning with a `#`-prefixed header line, and -/// extending until the next header line at the same or higher outline level (that is, with the -/// same number or fewer `#` characters). -/// -/// A header section may either contain one or more embedded Python files (making it a -/// [`MarkdownTest`]), or it may contain nested sections (headers with more `#` characters), but -/// not both. -#[derive(Debug)] -struct Section<'s> { - title: &'s str, - level: u8, - parent_id: Option, -} - -#[newtype_index] -struct EmbeddedFileId; - -/// A single file embedded in a [`Section`] as a fenced code block. -/// -/// Currently must be a Python file (`py` language) or type stub (`pyi`). In the future we plan -/// support other kinds of files as well (TOML configuration, typeshed VERSIONS, `pth` files...). -/// -/// A Python embedded file makes its containing [`Section`] into a [`MarkdownTest`], and will be -/// type-checked and searched for inline-comment assertions to match against the diagnostics from -/// type checking. -#[derive(Debug)] -pub(crate) struct EmbeddedFile<'s> { - section: SectionId, - pub(crate) path: &'s str, - pub(crate) lang: &'s str, - pub(crate) code: &'s str, - - /// The offset of the backticks beginning the code block within the markdown file - pub(crate) md_offset: TextSize, -} - -/// Matches a sequence of `#` characters, followed by a title heading, followed by a newline. -static HEADER_RE: LazyLock = - LazyLock::new(|| Regex::new(r"^(?#+)\s+(?.+)\s*\n").unwrap()); - -/// Matches a code block fenced by triple backticks, possibly with language and `key=val` -/// configuration items following the opening backticks (in the "tag string" of the code block). -static CODE_RE: LazyLock<Regex> = LazyLock::new(|| { - Regex::new(r"^```(?<lang>(?-u:\w)+)?(?<config>(?: +\S+)*)\s*\n(?<code>(?:.|\n)*?)\n?```\s*\n?") - .unwrap() -}); - -#[derive(Debug)] -struct SectionStack(Vec<SectionId>); - -impl SectionStack { - fn new(root_section_id: SectionId) -> Self { - Self(vec![root_section_id]) - } - - fn push(&mut self, section_id: SectionId) { - self.0.push(section_id); - } - - fn pop(&mut self) -> Option<SectionId> { - let popped = self.0.pop(); - debug_assert_ne!(popped, None, "Should never pop the implicit root section"); - debug_assert!( - !self.0.is_empty(), - "Should never pop the implicit root section" - ); - popped - } - - fn parent(&mut self) -> SectionId { - *self - .0 - .last() - .expect("Should never pop the implicit root section") - } -} - -/// Parse the source of a Markdown file into a [`MarkdownTestSuite`]. -#[derive(Debug)] -struct Parser<'s> { - /// [`Section`]s of the final [`MarkdownTestSuite`]. - sections: IndexVec<SectionId, Section<'s>>, - - /// [`EmbeddedFile`]s of the final [`MarkdownTestSuite`]. - files: IndexVec<EmbeddedFileId, EmbeddedFile<'s>>, - - /// The unparsed remainder of the Markdown source. - cursor: Cursor<'s>, - - source_len: TextSize, - - /// Stack of ancestor sections. - stack: SectionStack, - - /// Names of embedded files in current active section. - current_section_files: Option<FxHashSet<&'s str>>, -} - -impl<'s> Parser<'s> { - fn new(title: &'s str, source: &'s str) -> Self { - let mut sections = IndexVec::default(); - let root_section_id = sections.push(Section { - title, - level: 0, - parent_id: None, - }); - Self { - sections, - files: IndexVec::default(), - cursor: Cursor::new(source), - source_len: source.text_len(), - stack: SectionStack::new(root_section_id), - current_section_files: None, - } - } - - fn parse(mut self) -> anyhow::Result<MarkdownTestSuite<'s>> { - self.parse_impl()?; - Ok(self.finish()) - } - - fn finish(mut self) -> MarkdownTestSuite<'s> { - self.sections.shrink_to_fit(); - self.files.shrink_to_fit(); - - MarkdownTestSuite { - sections: self.sections, - files: self.files, - } - } - - fn parse_impl(&mut self) -> anyhow::Result<()> { - while let Some(position) = memchr2(b'`', b'#', self.cursor.as_bytes()) { - self.cursor.skip_bytes(position.saturating_sub(1)); - - // code blocks and headers must start on a new line. - if position == 0 || self.cursor.eat_char('\n') { - match self.cursor.first() { - '#' => { - if let Some(find) = HEADER_RE.find(self.cursor.as_str()) { - self.parse_header(find.as_str())?; - self.cursor.skip_bytes(find.len()); - continue; - } - } - '`' => { - if let Some(captures) = CODE_RE.captures(self.cursor.as_str()) { - self.parse_code_block(&captures)?; - self.cursor.skip_bytes(captures.get(0).unwrap().len()); - continue; - } - } - _ => unreachable!(), - } - } - - // Skip to the end of the line - if let Some(position) = memchr::memchr(b'\n', self.cursor.as_bytes()) { - self.cursor.skip_bytes(position); - } else { - break; - } - } - - Ok(()) - } - - fn parse_header(&mut self, header: &'s str) -> anyhow::Result<()> { - let mut trimmed = header.trim(); - - let mut header_level = 0usize; - while let Some(rest) = trimmed.strip_prefix('#') { - header_level += 1; - trimmed = rest; - } - - let title = trimmed.trim_start(); - - self.pop_sections_to_level(header_level); - - let parent = self.stack.parent(); - - let section = Section { - title, - level: header_level.try_into()?, - parent_id: Some(parent), - }; - - if self.current_section_files.is_some() { - return Err(anyhow::anyhow!( - "Header '{}' not valid inside a test case; parent '{}' has code files.", - section.title, - self.sections[parent].title, - )); - } - - let section_id = self.sections.push(section); - self.stack.push(section_id); - - self.current_section_files = None; - - Ok(()) - } - - fn parse_code_block(&mut self, captures: &Captures<'s>) -> anyhow::Result<()> { - // We never pop the implicit root section. - let parent = self.stack.parent(); - - let mut config: FxHashMap<&'s str, &'s str> = FxHashMap::default(); - - if let Some(config_match) = captures.name("config") { - for item in config_match.as_str().split_whitespace() { - let mut parts = item.split('='); - let key = parts.next().unwrap(); - let Some(val) = parts.next() else { - return Err(anyhow::anyhow!("Invalid config item `{}`.", item)); - }; - if parts.next().is_some() { - return Err(anyhow::anyhow!("Invalid config item `{}`.", item)); - } - if config.insert(key, val).is_some() { - return Err(anyhow::anyhow!("Duplicate config item `{}`.", item)); - } - } - } - - let path = config.get("path").copied().unwrap_or("test.py"); - - self.files.push(EmbeddedFile { - path, - section: parent, - lang: captures - .name("lang") - .as_ref() - .map(Match::as_str) - .unwrap_or_default(), - // CODE_RE can't match without matches for 'lang' and 'code'. - code: captures.name("code").unwrap().into(), - - md_offset: self.offset(), - }); - - if let Some(current_files) = &mut self.current_section_files { - if !current_files.insert(path) { - if path == "test.py" { - return Err(anyhow::anyhow!( - "Test `{}` has duplicate files named `{path}`. \ - (This is the default filename; \ - consider giving some files an explicit name with `path=...`.)", - self.sections[parent].title - )); - } - return Err(anyhow::anyhow!( - "Test `{}` has duplicate files named `{path}`.", - self.sections[parent].title - )); - }; - } else { - self.current_section_files = Some(FxHashSet::from_iter([path])); - } - - Ok(()) - } - - fn pop_sections_to_level(&mut self, level: usize) { - while level <= self.sections[self.stack.parent()].level.into() { - self.stack.pop(); - // We would have errored before pushing a child section if there were files, so we know - // no parent section can have files. - self.current_section_files = None; - } - } - - /// Retrieves the current offset of the cursor within the source code. - fn offset(&self) -> TextSize { - self.source_len - self.cursor.text_len() - } -} - -#[cfg(test)] -mod tests { - use ruff_python_trivia::textwrap::dedent; - - #[test] - fn empty() { - let mf = super::parse("file.md", "").unwrap(); - - assert!(mf.tests().next().is_none()); - } - - #[test] - fn single_file_test() { - let source = dedent( - " - ```py - x = 1 - ``` - ", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - - assert_eq!(test.name(), "file.md"); - - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "test.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "x = 1"); - } - - #[test] - fn no_new_line_at_eof() { - let source = dedent( - " - ```py - x = 1 - ```", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - - assert_eq!(test.name(), "file.md"); - - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "test.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "x = 1"); - } - - #[test] - fn multiple_tests() { - let source = dedent( - " - # One - - ```py - x = 1 - ``` - - # Two - - ```py - y = 2 - ``` - ", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test1, test2] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected two tests"); - }; - - assert_eq!(test1.name(), "file.md - One"); - assert_eq!(test2.name(), "file.md - Two"); - - let [file] = test1.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "test.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "x = 1"); - - let [file] = test2.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "test.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "y = 2"); - } - - #[test] - fn multiple_file_tests() { - let source = dedent( - " - # One - - ```py path=main.py - from foo import y - ``` - - ```py path=foo.py - y = 2 - ``` - - # Two - - ```py - y = 2 - ``` - ", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test1, test2] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected two tests"); - }; - - assert_eq!(test1.name(), "file.md - One"); - assert_eq!(test2.name(), "file.md - Two"); - - let [main, foo] = test1.files().collect::<Vec<_>>()[..] else { - panic!("expected two files"); - }; - - assert_eq!(main.path, "main.py"); - assert_eq!(main.lang, "py"); - assert_eq!(main.code, "from foo import y"); - - assert_eq!(foo.path, "foo.py"); - assert_eq!(foo.lang, "py"); - assert_eq!(foo.code, "y = 2"); - - let [file] = test2.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "test.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "y = 2"); - } - - #[test] - fn custom_file_path() { - let source = dedent( - " - ```py path=foo.py - x = 1 - ``` - ", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.path, "foo.py"); - assert_eq!(file.lang, "py"); - assert_eq!(file.code, "x = 1"); - } - - #[test] - fn multi_line_file() { - let source = dedent( - " - ```py - x = 1 - y = 2 - ``` - ", - ); - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.code, "x = 1\ny = 2"); - } - - #[test] - fn empty_file() { - let source = dedent( - " - ```py - ``` - ", - ); - - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.code, ""); - } - - #[test] - fn no_lang() { - let source = dedent( - " - ``` - x = 10 - ``` - ", - ); - - let mf = super::parse("file.md", &source).unwrap(); - - let [test] = &mf.tests().collect::<Vec<_>>()[..] else { - panic!("expected one test"); - }; - let [file] = test.files().collect::<Vec<_>>()[..] else { - panic!("expected one file"); - }; - - assert_eq!(file.code, "x = 10"); - } - - #[test] - fn no_header_inside_test() { - let source = dedent( - " - # One - - ```py - x = 1 - ``` - - ## Two - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!( - err.to_string(), - "Header 'Two' not valid inside a test case; parent 'One' has code files." - ); - } - - #[test] - fn invalid_config_item_no_equals() { - let source = dedent( - " - ```py foo - x = 1 - ``` - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!(err.to_string(), "Invalid config item `foo`."); - } - - #[test] - fn invalid_config_item_too_many_equals() { - let source = dedent( - " - ```py foo=bar=baz - x = 1 - ``` - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!(err.to_string(), "Invalid config item `foo=bar=baz`."); - } - - #[test] - fn invalid_config_item_duplicate() { - let source = dedent( - " - ```py foo=bar foo=baz - x = 1 - ``` - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!(err.to_string(), "Duplicate config item `foo=baz`."); - } - - #[test] - fn no_duplicate_name_files_in_test() { - let source = dedent( - " - ```py - x = 1 - ``` - - ```py - y = 2 - ``` - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!( - err.to_string(), - "Test `file.md` has duplicate files named `test.py`. \ - (This is the default filename; consider giving some files an explicit name \ - with `path=...`.)" - ); - } - - #[test] - fn no_duplicate_name_files_in_test_non_default() { - let source = dedent( - " - ```py path=foo.py - x = 1 - ``` - - ```py path=foo.py - y = 2 - ``` - ", - ); - let err = super::parse("file.md", &source).expect_err("Should fail to parse"); - assert_eq!( - err.to_string(), - "Test `file.md` has duplicate files named `foo.py`." - ); - } -} diff --git a/crates/red_knot_vendored/Cargo.toml b/crates/red_knot_vendored/Cargo.toml deleted file mode 100644 index b740bef3f4db5..0000000000000 --- a/crates/red_knot_vendored/Cargo.toml +++ /dev/null @@ -1,31 +0,0 @@ -[package] -name = "red_knot_vendored" -version = "0.0.0" -publish = false -authors = { workspace = true } -edition = { workspace = true } -rust-version = { workspace = true } -homepage = { workspace = true } -documentation = { workspace = true } -repository = { workspace = true } -license = { workspace = true } - -[dependencies] -ruff_db = { workspace = true } -zip = { workspace = true } - -[build-dependencies] -path-slash = { workspace = true } -walkdir = { workspace = true } -zip = { workspace = true, features = ["zstd", "deflate"] } - -[dev-dependencies] -walkdir = { workspace = true } - -[features] -zstd = ["zip/zstd"] -deflate = ["zip/deflate"] - -[lints] -workspace = true - diff --git a/crates/red_knot_vendored/README.md b/crates/red_knot_vendored/README.md deleted file mode 100644 index dd9a5849b00bd..0000000000000 --- a/crates/red_knot_vendored/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Vendored types for the stdlib - -This crate vendors [typeshed](https://github.com/python/typeshed)'s stubs for the standard library. The vendored stubs can be found in `crates/red_knot_vendored/vendor/typeshed`. The file `crates/red_knot_vendored/vendor/typeshed/source_commit.txt` tells you the typeshed commit that our vendored stdlib stubs currently correspond to. - -The typeshed stubs are updated every two weeks via an automated PR using the `sync_typeshed.yaml` workflow in the `.github/workflows` directory. This workflow can also be triggered at any time via [workflow dispatch](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow#running-a-workflow). diff --git a/crates/red_knot_vendored/build.rs b/crates/red_knot_vendored/build.rs deleted file mode 100644 index 08ad3418bff8c..0000000000000 --- a/crates/red_knot_vendored/build.rs +++ /dev/null @@ -1,89 +0,0 @@ -//! Build script to package our vendored typeshed files -//! into a zip archive that can be included in the Ruff binary. -//! -//! This script should be automatically run at build time -//! whenever the script itself changes, or whenever any files -//! in `crates/red_knot_vendored/vendor/typeshed` change. - -use std::fs::File; -use std::path::Path; - -use path_slash::PathExt; -use zip::result::ZipResult; -use zip::write::{FileOptions, ZipWriter}; -use zip::CompressionMethod; - -const TYPESHED_SOURCE_DIR: &str = "vendor/typeshed"; -const TYPESHED_ZIP_LOCATION: &str = "/zipped_typeshed.zip"; - -/// Recursively zip the contents of an entire directory. -/// -/// This routine is adapted from a recipe at -/// <https://github.com/zip-rs/zip-old/blob/5d0f198124946b7be4e5969719a7f29f363118cd/examples/write_dir.rs> -fn zip_dir(directory_path: &str, writer: File) -> ZipResult<File> { - let mut zip = ZipWriter::new(writer); - - // Use deflated compression for WASM builds because compiling `zstd-sys` requires clang - // [source](https://github.com/gyscos/zstd-rs/wiki/Compile-for-WASM) which complicates the build - // by a lot. Deflated compression is slower but it shouldn't matter much for the WASM use case - // (WASM itself is already slower than a native build for a specific platform). - // We can't use `#[cfg(...)]` here because the target-arch in a build script is the - // architecture of the system running the build script and not the architecture of the build-target. - // That's why we use the `TARGET` environment variable here. - let method = if cfg!(feature = "zstd") { - CompressionMethod::Zstd - } else if cfg!(feature = "deflate") { - CompressionMethod::Deflated - } else { - CompressionMethod::Stored - }; - - let options = FileOptions::default() - .compression_method(method) - .unix_permissions(0o644); - - for entry in walkdir::WalkDir::new(directory_path) { - let dir_entry = entry.unwrap(); - let absolute_path = dir_entry.path(); - let normalized_relative_path = absolute_path - .strip_prefix(Path::new(directory_path)) - .unwrap() - .to_slash() - .expect("Unexpected non-utf8 typeshed path!"); - - // Write file or directory explicitly - // Some unzip tools unzip files with directory paths correctly, some do not! - if absolute_path.is_file() { - println!("adding file {absolute_path:?} as {normalized_relative_path:?} ..."); - zip.start_file(normalized_relative_path, options)?; - let mut f = File::open(absolute_path)?; - std::io::copy(&mut f, &mut zip).unwrap(); - } else if !normalized_relative_path.is_empty() { - // Only if not root! Avoids path spec / warning - // and mapname conversion failed error on unzip - println!("adding dir {absolute_path:?} as {normalized_relative_path:?} ..."); - zip.add_directory(normalized_relative_path, options)?; - } - } - zip.finish() -} - -fn main() { - println!("cargo::rerun-if-changed={TYPESHED_SOURCE_DIR}"); - assert!( - Path::new(TYPESHED_SOURCE_DIR).is_dir(), - "Where is typeshed?" - ); - let out_dir = std::env::var("OUT_DIR").unwrap(); - - // N.B. Deliberately using `format!()` instead of `Path::join()` here, - // so that we use `/` as a path separator on all platforms. - // That enables us to load the typeshed zip at compile time in `module.rs` - // (otherwise we'd have to dynamically determine the exact path to the typeshed zip - // based on the default path separator for the specific platform we're on, - // which can't be done at compile time.) - let zipped_typeshed_location = format!("{out_dir}{TYPESHED_ZIP_LOCATION}"); - - let zipped_typeshed = File::create(zipped_typeshed_location).unwrap(); - zip_dir(TYPESHED_SOURCE_DIR, zipped_typeshed).unwrap(); -} diff --git a/crates/red_knot_vendored/vendor/typeshed/README.md b/crates/red_knot_vendored/vendor/typeshed/README.md deleted file mode 100644 index 9776813d07ea7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/README.md +++ /dev/null @@ -1,124 +0,0 @@ -# typeshed - -[![Tests](https://github.com/python/typeshed/actions/workflows/tests.yml/badge.svg)](https://github.com/python/typeshed/actions/workflows/tests.yml) -[![Chat at https://gitter.im/python/typing](https://badges.gitter.im/python/typing.svg)](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Pull Requests Welcome](https://img.shields.io/badge/pull%20requests-welcome-brightgreen.svg)](https://github.com/python/typeshed/blob/main/CONTRIBUTING.md) - -## About - -Typeshed contains external type annotations for the Python standard library -and Python builtins, as well as third party packages as contributed by -people external to those projects. - -This data can e.g. be used for static analysis, type checking, type inference, -and autocompletion. - -For information on how to use typeshed, read below. Information for -contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md). **Please read -it before submitting pull requests; do not report issues with annotations to -the project the stubs are for, but instead report them here to typeshed.** - -Further documentation on stub files, typeshed, and Python's typing system in -general, can also be found at https://typing.readthedocs.io/en/latest/. - -Typeshed supports Python versions 3.8 to 3.13. - -## Using - -If you're just using a type checker ([mypy](https://github.com/python/mypy/), -[pyright](https://github.com/microsoft/pyright), -[pytype](https://github.com/google/pytype/), PyCharm, ...), as opposed to -developing it, you don't need to interact with the typeshed repo at -all: a copy of standard library part of typeshed is bundled with type checkers. -And type stubs for third party packages and modules you are using can -be installed from PyPI. For example, if you are using `html5lib` and `requests`, -you can install the type stubs using - -```bash -$ pip install types-html5lib types-requests -``` - -These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/) -and are automatically released (up to once a day) by -[typeshed internal machinery](https://github.com/typeshed-internal/stub_uploader). - -Type checkers should be able to use these stub packages when installed. For more -details, see the documentation for your type checker. - -### Package versioning for third-party stubs - -Version numbers of third-party stub packages consist of at least four parts. -All parts of the stub version, except for the last part, correspond to the -version of the runtime package being stubbed. For example, if the `types-foo` -package has version `1.2.0.20240309`, this guarantees that the `types-foo` package -contains stubs targeted against `foo==1.2.*` and tested against the latest -version of `foo` matching that specifier. In this example, the final element -of the version number (20240309) indicates that the stub package was pushed on -March 9, 2024. - -At typeshed, we try to keep breaking changes to a minimum. However, due to the -nature of stubs, any version bump can introduce changes that might make your -code fail to type check. - -There are several strategies available for specifying the version of a stubs -package you're using, each with its own tradeoffs: - -1. Use the same bounds that you use for the package being stubbed. For example, - if you use `requests>=2.30.0,<2.32`, you can use - `types-requests>=2.30.0,<2.32`. This ensures that the stubs are compatible - with the package you are using, but it carries a small risk of breaking - type checking due to changes in the stubs. - - Another risk of this strategy is that stubs often lag behind - the package being stubbed. You might want to force the package being stubbed - to a certain minimum version because it fixes a critical bug, but if - correspondingly updated stubs have not been released, your type - checking results may not be fully accurate. -2. Pin the stubs to a known good version and update the pin from time to time - (either manually, or using a tool such as dependabot or renovate). - - For example, if you use `types-requests==2.31.0.1`, you can have confidence - that upgrading dependencies will not break type checking. However, you will - miss out on improvements in the stubs that could potentially improve type - checking until you update the pin. This strategy also has the risk that the - stubs you are using might become incompatible with the package being stubbed. -3. Don't pin the stubs. This is the option that demands the least work from - you when it comes to updating version pins, and has the advantage that you - will automatically benefit from improved stubs whenever a new version of the - stubs package is released. However, it carries the risk that the stubs - become incompatible with the package being stubbed. - - For example, if a new major version of the package is released, there's a - chance the stubs might be updated to reflect the new version of the runtime - package before you update the package being stubbed. - -You can also switch between the different strategies as needed. For example, -you could default to strategy (1), but fall back to strategy (2) when -a problem arises that can't easily be fixed. - -### The `_typeshed` package - -typeshed includes a package `_typeshed` as part of the standard library. -This package and its submodules contain utility types, but are not -available at runtime. For more information about how to use this package, -[see the `stdlib/_typeshed` directory](https://github.com/python/typeshed/tree/main/stdlib/_typeshed). - -## Discussion - -If you've run into behavior in the type checker that suggests the type -stubs for a given library are incorrect or incomplete, -we want to hear from you! - -Our main forum for discussion is the project's [GitHub issue -tracker](https://github.com/python/typeshed/issues). This is the right -place to start a discussion of any of the above or most any other -topic concerning the project. - -If you have general questions about typing with Python, or you need -a review of your type annotations or stubs outside of typeshed, head over to -[our discussion forum](https://github.com/python/typing/discussions). -For less formal discussion, try the typing chat room on -[gitter.im](https://gitter.im/python/typing). Some typeshed maintainers -are almost always present; feel free to find us there and we're happy -to chat. Substantive technical discussion will be directed to the -issue tracker. diff --git a/crates/red_knot_vendored/vendor/typeshed/source_commit.txt b/crates/red_knot_vendored/vendor/typeshed/source_commit.txt deleted file mode 100644 index 0f4ee19408c54..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/source_commit.txt +++ /dev/null @@ -1 +0,0 @@ -a871efd90ca2734b3341dde98cffab66f3e08cee diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/__main__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/__main__.pyi deleted file mode 100644 index e27843e533821..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/__main__.pyi +++ /dev/null @@ -1,3 +0,0 @@ -from typing import Any - -def __getattr__(name: str) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_compression.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_compression.pyi deleted file mode 100644 index a41a8142cc3ac..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_compression.pyi +++ /dev/null @@ -1,25 +0,0 @@ -from _typeshed import WriteableBuffer -from collections.abc import Callable -from io import DEFAULT_BUFFER_SIZE, BufferedIOBase, RawIOBase -from typing import Any, Protocol - -BUFFER_SIZE = DEFAULT_BUFFER_SIZE - -class _Reader(Protocol): - def read(self, n: int, /) -> bytes: ... - def seekable(self) -> bool: ... - def seek(self, n: int, /) -> Any: ... - -class BaseStream(BufferedIOBase): ... - -class DecompressReader(RawIOBase): - def __init__( - self, - fp: _Reader, - decomp_factory: Callable[..., object], - trailing_error: type[Exception] | tuple[type[Exception], ...] = (), - **decomp_args: Any, - ) -> None: ... - def readinto(self, b: WriteableBuffer) -> int: ... - def read(self, size: int = -1) -> bytes: ... - def seek(self, offset: int, whence: int = 0) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_csv.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_csv.pyi deleted file mode 100644 index 6d1893cf8c168..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_csv.pyi +++ /dev/null @@ -1,101 +0,0 @@ -import sys -from _typeshed import SupportsWrite -from collections.abc import Iterable, Iterator -from typing import Any, Final -from typing_extensions import TypeAlias - -__version__: Final[str] - -QUOTE_ALL: Final = 1 -QUOTE_MINIMAL: Final = 0 -QUOTE_NONE: Final = 3 -QUOTE_NONNUMERIC: Final = 2 -if sys.version_info >= (3, 12): - QUOTE_STRINGS: Final = 4 - QUOTE_NOTNULL: Final = 5 - -# Ideally this would be `QUOTE_ALL | QUOTE_MINIMAL | QUOTE_NONE | QUOTE_NONNUMERIC` -# However, using literals in situations like these can cause false-positives (see #7258) -_QuotingType: TypeAlias = int - -class Error(Exception): ... - -_DialectLike: TypeAlias = str | Dialect | type[Dialect] - -class Dialect: - delimiter: str - quotechar: str | None - escapechar: str | None - doublequote: bool - skipinitialspace: bool - lineterminator: str - quoting: _QuotingType - strict: bool - def __init__( - self, - dialect: _DialectLike | None = ..., - delimiter: str = ",", - doublequote: bool = True, - escapechar: str | None = None, - lineterminator: str = "\r\n", - quotechar: str | None = '"', - quoting: _QuotingType = 0, - skipinitialspace: bool = False, - strict: bool = False, - ) -> None: ... - -class _reader(Iterator[list[str]]): - @property - def dialect(self) -> Dialect: ... - line_num: int - def __next__(self) -> list[str]: ... - -class _writer: - @property - def dialect(self) -> Dialect: ... - def writerow(self, row: Iterable[Any]) -> Any: ... - def writerows(self, rows: Iterable[Iterable[Any]]) -> None: ... - -def writer( - csvfile: SupportsWrite[str], - dialect: _DialectLike = "excel", - *, - delimiter: str = ",", - quotechar: str | None = '"', - escapechar: str | None = None, - doublequote: bool = True, - skipinitialspace: bool = False, - lineterminator: str = "\r\n", - quoting: _QuotingType = 0, - strict: bool = False, -) -> _writer: ... -def reader( - csvfile: Iterable[str], - dialect: _DialectLike = "excel", - *, - delimiter: str = ",", - quotechar: str | None = '"', - escapechar: str | None = None, - doublequote: bool = True, - skipinitialspace: bool = False, - lineterminator: str = "\r\n", - quoting: _QuotingType = 0, - strict: bool = False, -) -> _reader: ... -def register_dialect( - name: str, - dialect: type[Dialect] = ..., - *, - delimiter: str = ",", - quotechar: str | None = '"', - escapechar: str | None = None, - doublequote: bool = True, - skipinitialspace: bool = False, - lineterminator: str = "\r\n", - quoting: _QuotingType = 0, - strict: bool = False, -) -> None: ... -def unregister_dialect(name: str) -> None: ... -def get_dialect(name: str) -> Dialect: ... -def list_dialects() -> list[str]: ... -def field_size_limit(new_limit: int = ...) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ctypes.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_ctypes.pyi deleted file mode 100644 index f4d26d05323a0..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ctypes.pyi +++ /dev/null @@ -1,213 +0,0 @@ -import sys -from _typeshed import ReadableBuffer, WriteableBuffer -from abc import abstractmethod -from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence -from ctypes import CDLL, ArgumentError as ArgumentError, c_void_p -from typing import Any, ClassVar, Generic, TypeVar, overload -from typing_extensions import Self, TypeAlias - -if sys.version_info >= (3, 9): - from types import GenericAlias - -_T = TypeVar("_T") -_CT = TypeVar("_CT", bound=_CData) - -FUNCFLAG_CDECL: int -FUNCFLAG_PYTHONAPI: int -FUNCFLAG_USE_ERRNO: int -FUNCFLAG_USE_LASTERROR: int -RTLD_GLOBAL: int -RTLD_LOCAL: int - -if sys.version_info >= (3, 11): - CTYPES_MAX_ARGCOUNT: int - -if sys.version_info >= (3, 12): - SIZEOF_TIME_T: int - -if sys.platform == "win32": - # Description, Source, HelpFile, HelpContext, scode - _COMError_Details: TypeAlias = tuple[str | None, str | None, str | None, int | None, int | None] - - class COMError(Exception): - hresult: int - text: str | None - details: _COMError_Details - - def __init__(self, hresult: int, text: str | None, details: _COMError_Details) -> None: ... - - def CopyComPointer(src: _PointerLike, dst: _PointerLike | _CArgObject) -> int: ... - - FUNCFLAG_HRESULT: int - FUNCFLAG_STDCALL: int - - def FormatError(code: int = ...) -> str: ... - def get_last_error() -> int: ... - def set_last_error(value: int) -> int: ... - def LoadLibrary(name: str, load_flags: int = 0, /) -> int: ... - def FreeLibrary(handle: int, /) -> None: ... - -class _CDataMeta(type): - # By default mypy complains about the following two methods, because strictly speaking cls - # might not be a Type[_CT]. However this can never actually happen, because the only class that - # uses _CDataMeta as its metaclass is _CData. So it's safe to ignore the errors here. - def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - -class _CData(metaclass=_CDataMeta): - _b_base_: int - _b_needsfree_: bool - _objects: Mapping[Any, int] | None - # At runtime the following classmethods are available only on classes, not - # on instances. This can't be reflected properly in the type system: - # - # Structure.from_buffer(...) # valid at runtime - # Structure(...).from_buffer(...) # invalid at runtime - # - @classmethod - def from_buffer(cls, source: WriteableBuffer, offset: int = ...) -> Self: ... - @classmethod - def from_buffer_copy(cls, source: ReadableBuffer, offset: int = ...) -> Self: ... - @classmethod - def from_address(cls, address: int) -> Self: ... - @classmethod - def from_param(cls, value: Any, /) -> Self | _CArgObject: ... - @classmethod - def in_dll(cls, library: CDLL, name: str) -> Self: ... - def __buffer__(self, flags: int, /) -> memoryview: ... - def __release_buffer__(self, buffer: memoryview, /) -> None: ... - -class _SimpleCData(_CData, Generic[_T]): - value: _T - # The TypeVar can be unsolved here, - # but we can't use overloads without creating many, many mypy false-positive errors - def __init__(self, value: _T = ...) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] - -class _CanCastTo(_CData): ... -class _PointerLike(_CanCastTo): ... - -class _Pointer(_PointerLike, _CData, Generic[_CT]): - _type_: type[_CT] - contents: _CT - @overload - def __init__(self) -> None: ... - @overload - def __init__(self, arg: _CT) -> None: ... - @overload - def __getitem__(self, key: int, /) -> Any: ... - @overload - def __getitem__(self, key: slice, /) -> list[Any]: ... - def __setitem__(self, key: int, value: Any, /) -> None: ... - -@overload -def POINTER(type: None, /) -> type[c_void_p]: ... -@overload -def POINTER(type: type[_CT], /) -> type[_Pointer[_CT]]: ... -def pointer(obj: _CT, /) -> _Pointer[_CT]: ... - -class _CArgObject: ... - -def byref(obj: _CData, offset: int = ...) -> _CArgObject: ... - -_ECT: TypeAlias = Callable[[_CData | None, CFuncPtr, tuple[_CData, ...]], _CData] -_PF: TypeAlias = tuple[int] | tuple[int, str | None] | tuple[int, str | None, Any] - -class CFuncPtr(_PointerLike, _CData): - restype: type[_CData] | Callable[[int], Any] | None - argtypes: Sequence[type[_CData]] - errcheck: _ECT - # Abstract attribute that must be defined on subclasses - _flags_: ClassVar[int] - @overload - def __init__(self) -> None: ... - @overload - def __init__(self, address: int, /) -> None: ... - @overload - def __init__(self, callable: Callable[..., Any], /) -> None: ... - @overload - def __init__(self, func_spec: tuple[str | int, CDLL], paramflags: tuple[_PF, ...] | None = ..., /) -> None: ... - if sys.platform == "win32": - @overload - def __init__( - self, vtbl_index: int, name: str, paramflags: tuple[_PF, ...] | None = ..., iid: _CData | None = ..., / - ) -> None: ... - - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - -_GetT = TypeVar("_GetT") -_SetT = TypeVar("_SetT") - -class _CField(Generic[_CT, _GetT, _SetT]): - offset: int - size: int - @overload - def __get__(self, instance: None, owner: type[Any] | None, /) -> Self: ... - @overload - def __get__(self, instance: Any, owner: type[Any] | None, /) -> _GetT: ... - def __set__(self, instance: Any, value: _SetT, /) -> None: ... - -class _StructUnionMeta(_CDataMeta): - _fields_: Sequence[tuple[str, type[_CData]] | tuple[str, type[_CData], int]] - _pack_: int - _anonymous_: Sequence[str] - def __getattr__(self, name: str) -> _CField[Any, Any, Any]: ... - -class _StructUnionBase(_CData, metaclass=_StructUnionMeta): - def __init__(self, *args: Any, **kw: Any) -> None: ... - def __getattr__(self, name: str) -> Any: ... - def __setattr__(self, name: str, value: Any) -> None: ... - -class Union(_StructUnionBase): ... -class Structure(_StructUnionBase): ... - -class Array(_CData, Generic[_CT]): - @property - @abstractmethod - def _length_(self) -> int: ... - @_length_.setter - def _length_(self, value: int) -> None: ... - @property - @abstractmethod - def _type_(self) -> type[_CT]: ... - @_type_.setter - def _type_(self, value: type[_CT]) -> None: ... - # Note: only available if _CT == c_char - @property - def raw(self) -> bytes: ... - @raw.setter - def raw(self, value: ReadableBuffer) -> None: ... - value: Any # Note: bytes if _CT == c_char, str if _CT == c_wchar, unavailable otherwise - # TODO These methods cannot be annotated correctly at the moment. - # All of these "Any"s stand for the array's element type, but it's not possible to use _CT - # here, because of a special feature of ctypes. - # By default, when accessing an element of an Array[_CT], the returned object has type _CT. - # However, when _CT is a "simple type" like c_int, ctypes automatically "unboxes" the object - # and converts it to the corresponding Python primitive. For example, when accessing an element - # of an Array[c_int], a Python int object is returned, not a c_int. - # This behavior does *not* apply to subclasses of "simple types". - # If MyInt is a subclass of c_int, then accessing an element of an Array[MyInt] returns - # a MyInt, not an int. - # This special behavior is not easy to model in a stub, so for now all places where - # the array element type would belong are annotated with Any instead. - def __init__(self, *args: Any) -> None: ... - @overload - def __getitem__(self, key: int, /) -> Any: ... - @overload - def __getitem__(self, key: slice, /) -> list[Any]: ... - @overload - def __setitem__(self, key: int, value: Any, /) -> None: ... - @overload - def __setitem__(self, key: slice, value: Iterable[Any], /) -> None: ... - def __iter__(self) -> Iterator[Any]: ... - # Can't inherit from Sized because the metaclass conflict between - # Sized and _CData prevents using _CDataMeta. - def __len__(self) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -def addressof(obj: _CData, /) -> int: ... -def alignment(obj_or_type: _CData | type[_CData], /) -> int: ... -def get_errno() -> int: ... -def resize(obj: _CData, size: int, /) -> None: ... -def set_errno(value: int, /) -> int: ... -def sizeof(obj_or_type: _CData | type[_CData], /) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_thread.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_thread.pyi deleted file mode 100644 index 1182e53c66c30..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_thread.pyi +++ /dev/null @@ -1,33 +0,0 @@ -from collections.abc import Callable -from types import TracebackType -from typing import Any, NoReturn, overload -from typing_extensions import TypeVarTuple, Unpack - -__all__ = ["error", "start_new_thread", "exit", "get_ident", "allocate_lock", "interrupt_main", "LockType", "RLock"] - -_Ts = TypeVarTuple("_Ts") - -TIMEOUT_MAX: int -error = RuntimeError - -@overload -def start_new_thread(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]]) -> None: ... -@overload -def start_new_thread(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any]) -> None: ... -def exit() -> NoReturn: ... -def get_ident() -> int: ... -def allocate_lock() -> LockType: ... -def stack_size(size: int | None = None) -> int: ... - -class LockType: - locked_status: bool - def acquire(self, waitflag: bool | None = None, timeout: int = -1) -> bool: ... - def __enter__(self, waitflag: bool | None = None, timeout: int = -1) -> bool: ... - def __exit__(self, typ: type[BaseException] | None, val: BaseException | None, tb: TracebackType | None) -> None: ... - def release(self) -> bool: ... - def locked(self) -> bool: ... - -class RLock(LockType): - def release(self) -> None: ... # type: ignore[override] - -def interrupt_main() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_threading.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_threading.pyi deleted file mode 100644 index 21d1d1921c0eb..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_dummy_threading.pyi +++ /dev/null @@ -1,164 +0,0 @@ -import sys -from _thread import _excepthook, _ExceptHookArgs -from _typeshed import ProfileFunction, TraceFunction -from collections.abc import Callable, Iterable, Mapping -from types import TracebackType -from typing import Any, TypeVar - -_T = TypeVar("_T") - -__all__ = [ - "get_ident", - "active_count", - "Condition", - "current_thread", - "enumerate", - "main_thread", - "TIMEOUT_MAX", - "Event", - "Lock", - "RLock", - "Semaphore", - "BoundedSemaphore", - "Thread", - "Barrier", - "BrokenBarrierError", - "Timer", - "ThreadError", - "setprofile", - "settrace", - "local", - "stack_size", - "ExceptHookArgs", - "excepthook", -] - -def active_count() -> int: ... -def current_thread() -> Thread: ... -def currentThread() -> Thread: ... -def get_ident() -> int: ... -def enumerate() -> list[Thread]: ... -def main_thread() -> Thread: ... -def settrace(func: TraceFunction) -> None: ... -def setprofile(func: ProfileFunction | None) -> None: ... -def stack_size(size: int | None = None) -> int: ... - -TIMEOUT_MAX: float - -class ThreadError(Exception): ... - -class local: - def __getattribute__(self, name: str) -> Any: ... - def __setattr__(self, name: str, value: Any) -> None: ... - def __delattr__(self, name: str) -> None: ... - -class Thread: - name: str - daemon: bool - @property - def ident(self) -> int | None: ... - def __init__( - self, - group: None = None, - target: Callable[..., object] | None = None, - name: str | None = None, - args: Iterable[Any] = (), - kwargs: Mapping[str, Any] | None = None, - *, - daemon: bool | None = None, - ) -> None: ... - def start(self) -> None: ... - def run(self) -> None: ... - def join(self, timeout: float | None = None) -> None: ... - def getName(self) -> str: ... - def setName(self, name: str) -> None: ... - @property - def native_id(self) -> int | None: ... # only available on some platforms - def is_alive(self) -> bool: ... - if sys.version_info < (3, 9): - def isAlive(self) -> bool: ... - - def isDaemon(self) -> bool: ... - def setDaemon(self, daemonic: bool) -> None: ... - -class _DummyThread(Thread): ... - -class Lock: - def __enter__(self) -> bool: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> bool | None: ... - def acquire(self, blocking: bool = ..., timeout: float = ...) -> bool: ... - def release(self) -> None: ... - def locked(self) -> bool: ... - -class _RLock: - def __enter__(self) -> bool: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> bool | None: ... - def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... - def release(self) -> None: ... - -RLock = _RLock - -class Condition: - def __init__(self, lock: Lock | _RLock | None = None) -> None: ... - def __enter__(self) -> bool: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> bool | None: ... - def acquire(self, blocking: bool = ..., timeout: float = ...) -> bool: ... - def release(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - def wait_for(self, predicate: Callable[[], _T], timeout: float | None = None) -> _T: ... - def notify(self, n: int = 1) -> None: ... - def notify_all(self) -> None: ... - def notifyAll(self) -> None: ... - -class Semaphore: - def __init__(self, value: int = 1) -> None: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> bool | None: ... - def acquire(self, blocking: bool = True, timeout: float | None = None) -> bool: ... - def __enter__(self, blocking: bool = True, timeout: float | None = None) -> bool: ... - if sys.version_info >= (3, 9): - def release(self, n: int = ...) -> None: ... - else: - def release(self) -> None: ... - -class BoundedSemaphore(Semaphore): ... - -class Event: - def is_set(self) -> bool: ... - def set(self) -> None: ... - def clear(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - -excepthook = _excepthook -ExceptHookArgs = _ExceptHookArgs - -class Timer(Thread): - def __init__( - self, - interval: float, - function: Callable[..., object], - args: Iterable[Any] | None = None, - kwargs: Mapping[str, Any] | None = None, - ) -> None: ... - def cancel(self) -> None: ... - -class Barrier: - @property - def parties(self) -> int: ... - @property - def n_waiting(self) -> int: ... - @property - def broken(self) -> bool: ... - def __init__(self, parties: int, action: Callable[[], None] | None = None, timeout: float | None = None) -> None: ... - def wait(self, timeout: float | None = None) -> int: ... - def reset(self) -> None: ... - def abort(self) -> None: ... - -class BrokenBarrierError(RuntimeError): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpqueues.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpqueues.pyi deleted file mode 100644 index db5e4cff5068a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpqueues.pyi +++ /dev/null @@ -1,16 +0,0 @@ -from typing import Any, SupportsIndex - -class QueueError(RuntimeError): ... -class QueueNotFoundError(QueueError): ... - -def bind(qid: SupportsIndex) -> None: ... -def create(maxsize: SupportsIndex, fmt: SupportsIndex) -> int: ... -def destroy(qid: SupportsIndex) -> None: ... -def get(qid: SupportsIndex) -> tuple[Any, int]: ... -def get_count(qid: SupportsIndex) -> int: ... -def get_maxsize(qid: SupportsIndex) -> int: ... -def get_queue_defaults(qid: SupportsIndex) -> tuple[int]: ... -def is_full(qid: SupportsIndex) -> bool: ... -def list_all() -> list[tuple[int, int]]: ... -def put(qid: SupportsIndex, obj: Any, fmt: SupportsIndex) -> None: ... -def release(qid: SupportsIndex) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_io.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_io.pyi deleted file mode 100644 index e8290daad106d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_io.pyi +++ /dev/null @@ -1,195 +0,0 @@ -import builtins -import codecs -import sys -from _typeshed import FileDescriptorOrPath, MaybeNone, ReadableBuffer, WriteableBuffer -from collections.abc import Callable, Iterable, Iterator -from io import BufferedIOBase, RawIOBase, TextIOBase, UnsupportedOperation as UnsupportedOperation -from os import _Opener -from types import TracebackType -from typing import IO, Any, BinaryIO, Final, Generic, Literal, Protocol, TextIO, TypeVar, overload, type_check_only -from typing_extensions import Self - -_T = TypeVar("_T") - -DEFAULT_BUFFER_SIZE: Final = 8192 - -open = builtins.open - -def open_code(path: str) -> IO[bytes]: ... - -BlockingIOError = builtins.BlockingIOError - -class _IOBase: - def __iter__(self) -> Iterator[bytes]: ... - def __next__(self) -> bytes: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - def close(self) -> None: ... - def fileno(self) -> int: ... - def flush(self) -> None: ... - def isatty(self) -> bool: ... - def readable(self) -> bool: ... - read: Callable[..., Any] - def readlines(self, hint: int = -1, /) -> list[bytes]: ... - def seek(self, offset: int, whence: int = ..., /) -> int: ... - def seekable(self) -> bool: ... - def tell(self) -> int: ... - def truncate(self, size: int | None = ..., /) -> int: ... - def writable(self) -> bool: ... - write: Callable[..., Any] - def writelines(self, lines: Iterable[ReadableBuffer], /) -> None: ... - def readline(self, size: int | None = -1, /) -> bytes: ... - def __del__(self) -> None: ... - @property - def closed(self) -> bool: ... - def _checkClosed(self) -> None: ... # undocumented - -class _RawIOBase(_IOBase): - def readall(self) -> bytes: ... - # The following methods can return None if the file is in non-blocking mode - # and no data is available. - def readinto(self, buffer: WriteableBuffer, /) -> int | MaybeNone: ... - def write(self, b: ReadableBuffer, /) -> int | MaybeNone: ... - def read(self, size: int = -1, /) -> bytes | MaybeNone: ... - -class _BufferedIOBase(_IOBase): - def detach(self) -> RawIOBase: ... - def readinto(self, buffer: WriteableBuffer, /) -> int: ... - def write(self, buffer: ReadableBuffer, /) -> int: ... - def readinto1(self, buffer: WriteableBuffer, /) -> int: ... - def read(self, size: int | None = ..., /) -> bytes: ... - def read1(self, size: int = ..., /) -> bytes: ... - -class FileIO(RawIOBase, _RawIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of writelines in the base classes - mode: str - # The type of "name" equals the argument passed in to the constructor, - # but that can make FileIO incompatible with other I/O types that assume - # "name" is a str. In the future, making FileIO generic might help. - name: Any - def __init__( - self, file: FileDescriptorOrPath, mode: str = ..., closefd: bool = ..., opener: _Opener | None = ... - ) -> None: ... - @property - def closefd(self) -> bool: ... - -class BytesIO(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of methods in the base classes - def __init__(self, initial_bytes: ReadableBuffer = ...) -> None: ... - # BytesIO does not contain a "name" field. This workaround is necessary - # to allow BytesIO sub-classes to add this field, as it is defined - # as a read-only property on IO[]. - name: Any - def getvalue(self) -> bytes: ... - def getbuffer(self) -> memoryview: ... - def read1(self, size: int | None = -1, /) -> bytes: ... - -class BufferedReader(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of methods in the base classes - raw: RawIOBase - def __init__(self, raw: RawIOBase, buffer_size: int = ...) -> None: ... - def peek(self, size: int = 0, /) -> bytes: ... - -class BufferedWriter(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of writelines in the base classes - raw: RawIOBase - def __init__(self, raw: RawIOBase, buffer_size: int = ...) -> None: ... - def write(self, buffer: ReadableBuffer, /) -> int: ... - -class BufferedRandom(BufferedReader, BufferedWriter, BufferedIOBase, _BufferedIOBase): # type: ignore[misc] # incompatible definitions of methods in the base classes - def seek(self, target: int, whence: int = 0, /) -> int: ... # stubtest needs this - -class BufferedRWPair(BufferedIOBase, _BufferedIOBase): - def __init__(self, reader: RawIOBase, writer: RawIOBase, buffer_size: int = ...) -> None: ... - def peek(self, size: int = ..., /) -> bytes: ... - -class _TextIOBase(_IOBase): - encoding: str - errors: str | None - newlines: str | tuple[str, ...] | None - def __iter__(self) -> Iterator[str]: ... # type: ignore[override] - def __next__(self) -> str: ... # type: ignore[override] - def detach(self) -> BinaryIO: ... - def write(self, s: str, /) -> int: ... - def writelines(self, lines: Iterable[str], /) -> None: ... # type: ignore[override] - def readline(self, size: int = ..., /) -> str: ... # type: ignore[override] - def readlines(self, hint: int = -1, /) -> list[str]: ... # type: ignore[override] - def read(self, size: int | None = ..., /) -> str: ... - -@type_check_only -class _WrappedBuffer(Protocol): - # "name" is wrapped by TextIOWrapper. Its type is inconsistent between - # the various I/O types, see the comments on TextIOWrapper.name and - # TextIO.name. - @property - def name(self) -> Any: ... - @property - def closed(self) -> bool: ... - def read(self, size: int = ..., /) -> ReadableBuffer: ... - # Optional: def read1(self, size: int, /) -> ReadableBuffer: ... - def write(self, b: bytes, /) -> object: ... - def flush(self) -> object: ... - def close(self) -> object: ... - def seekable(self) -> bool: ... - def readable(self) -> bool: ... - def writable(self) -> bool: ... - def truncate(self, size: int, /) -> int: ... - def fileno(self) -> int: ... - def isatty(self) -> bool: ... - # Optional: Only needs to be present if seekable() returns True. - # def seek(self, offset: Literal[0], whence: Literal[2]) -> int: ... - # def tell(self) -> int: ... - -_BufferT_co = TypeVar("_BufferT_co", bound=_WrappedBuffer, default=_WrappedBuffer, covariant=True) - -class TextIOWrapper(TextIOBase, _TextIOBase, TextIO, Generic[_BufferT_co]): # type: ignore[misc] # incompatible definitions of write in the base classes - def __init__( - self, - buffer: _BufferT_co, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - line_buffering: bool = False, - write_through: bool = False, - ) -> None: ... - # Equals the "buffer" argument passed in to the constructor. - @property - def buffer(self) -> _BufferT_co: ... # type: ignore[override] - @property - def line_buffering(self) -> bool: ... - @property - def write_through(self) -> bool: ... - def reconfigure( - self, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - line_buffering: bool | None = None, - write_through: bool | None = None, - ) -> None: ... - def readline(self, size: int = -1, /) -> str: ... # type: ignore[override] - # Equals the "buffer" argument passed in to the constructor. - def detach(self) -> _BufferT_co: ... # type: ignore[override] - # TextIOWrapper's version of seek only supports a limited subset of - # operations. - def seek(self, cookie: int, whence: int = 0, /) -> int: ... - -class StringIO(TextIOWrapper, TextIOBase, _TextIOBase): # type: ignore[misc] # incompatible definitions of write in the base classes - def __init__(self, initial_value: str | None = ..., newline: str | None = ...) -> None: ... - # StringIO does not contain a "name" field. This workaround is necessary - # to allow StringIO sub-classes to add this field, as it is defined - # as a read-only property on IO[]. - name: Any - def getvalue(self) -> str: ... - -class IncrementalNewlineDecoder(codecs.IncrementalDecoder): - def __init__(self, decoder: codecs.IncrementalDecoder | None, translate: bool, errors: str = ...) -> None: ... - def decode(self, input: ReadableBuffer | str, final: bool = False) -> str: ... - @property - def newlines(self) -> str | tuple[str, ...] | None: ... - def setstate(self, state: tuple[bytes, int], /) -> None: ... - -if sys.version_info >= (3, 10): - @overload - def text_encoding(encoding: None, stacklevel: int = 2, /) -> Literal["locale", "utf-8"]: ... - @overload - def text_encoding(encoding: _T, stacklevel: int = 2, /) -> _T: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi deleted file mode 100644 index 49e88a196825e..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi +++ /dev/null @@ -1,16 +0,0 @@ -from collections.abc import Iterable -from typing import ClassVar, Literal, NoReturn - -class Quitter: - name: str - eof: str - def __init__(self, name: str, eof: str) -> None: ... - def __call__(self, code: int | None = None) -> NoReturn: ... - -class _Printer: - MAXLINES: ClassVar[Literal[23]] - def __init__(self, name: str, data: str, files: Iterable[str] = (), dirs: Iterable[str] = ()) -> None: ... - def __call__(self) -> None: ... - -class _Helper: - def __call__(self, request: object) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_thread.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_thread.pyi deleted file mode 100644 index b75e7608fa77d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_thread.pyi +++ /dev/null @@ -1,83 +0,0 @@ -import signal -import sys -from _typeshed import structseq -from collections.abc import Callable -from threading import Thread -from types import TracebackType -from typing import Any, Final, NoReturn, final, overload -from typing_extensions import TypeVarTuple, Unpack - -_Ts = TypeVarTuple("_Ts") - -error = RuntimeError - -def _count() -> int: ... -@final -class LockType: - def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... - def release(self) -> None: ... - def locked(self) -> bool: ... - def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ... - def release_lock(self) -> None: ... - def locked_lock(self) -> bool: ... - def __enter__(self) -> bool: ... - def __exit__( - self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> None: ... - -if sys.version_info >= (3, 13): - @final - class _ThreadHandle: - ident: int - - def join(self, timeout: float | None = None, /) -> None: ... - def is_done(self) -> bool: ... - def _set_done(self) -> None: ... - - def start_joinable_thread( - function: Callable[[], object], handle: _ThreadHandle | None = None, daemon: bool = True - ) -> _ThreadHandle: ... - lock = LockType - -@overload -def start_new_thread(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ... -@overload -def start_new_thread(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ... - -if sys.version_info >= (3, 10): - def interrupt_main(signum: signal.Signals = ..., /) -> None: ... - -else: - def interrupt_main() -> None: ... - -def exit() -> NoReturn: ... -def allocate_lock() -> LockType: ... -def get_ident() -> int: ... -def stack_size(size: int = 0, /) -> int: ... - -TIMEOUT_MAX: float - -def get_native_id() -> int: ... # only available on some platforms -@final -class _ExceptHookArgs(structseq[Any], tuple[type[BaseException], BaseException | None, TracebackType | None, Thread | None]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("exc_type", "exc_value", "exc_traceback", "thread") - - @property - def exc_type(self) -> type[BaseException]: ... - @property - def exc_value(self) -> BaseException | None: ... - @property - def exc_traceback(self) -> TracebackType | None: ... - @property - def thread(self) -> Thread | None: ... - -_excepthook: Callable[[_ExceptHookArgs], Any] - -if sys.version_info >= (3, 12): - def daemon_threads_allowed() -> bool: ... - -class _local: - def __getattribute__(self, name: str, /) -> Any: ... - def __setattr__(self, name: str, value: Any, /) -> None: ... - def __delattr__(self, name: str, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_threading_local.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_threading_local.pyi deleted file mode 100644 index 98683dabcef8f..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_threading_local.pyi +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Any -from typing_extensions import TypeAlias -from weakref import ReferenceType - -__all__ = ["local"] -_LocalDict: TypeAlias = dict[Any, Any] - -class _localimpl: - key: str - dicts: dict[int, tuple[ReferenceType[Any], _LocalDict]] - def get_dict(self) -> _LocalDict: ... - def create_dict(self) -> _LocalDict: ... - -class local: - def __getattribute__(self, name: str) -> Any: ... - def __setattr__(self, name: str, value: Any) -> None: ... - def __delattr__(self, name: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi deleted file mode 100644 index 7201819b25ed9..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi +++ /dev/null @@ -1,363 +0,0 @@ -# Utility types for typeshed -# -# See the README.md file in this directory for more information. - -import sys -from collections.abc import Awaitable, Callable, Iterable, Sequence, Set as AbstractSet, Sized -from dataclasses import Field -from os import PathLike -from types import FrameType, TracebackType -from typing import ( - Any, - AnyStr, - ClassVar, - Final, - Generic, - Literal, - Protocol, - SupportsFloat, - SupportsIndex, - SupportsInt, - TypeVar, - final, - overload, -) -from typing_extensions import Buffer, LiteralString, TypeAlias - -_KT = TypeVar("_KT") -_KT_co = TypeVar("_KT_co", covariant=True) -_KT_contra = TypeVar("_KT_contra", contravariant=True) -_VT = TypeVar("_VT") -_VT_co = TypeVar("_VT_co", covariant=True) -_T = TypeVar("_T") -_T_co = TypeVar("_T_co", covariant=True) -_T_contra = TypeVar("_T_contra", contravariant=True) - -# Alternative to `typing_extensions.Self`, exclusively for use with `__new__` -# in metaclasses: -# def __new__(cls: type[Self], ...) -> Self: ... -# In other cases, use `typing_extensions.Self`. -Self = TypeVar("Self") # noqa: Y001 - -# covariant version of typing.AnyStr, useful for protocols -AnyStr_co = TypeVar("AnyStr_co", str, bytes, covariant=True) # noqa: Y001 - -# For partially known annotations. Usually, fields where type annotations -# haven't been added are left unannotated, but in some situations this -# isn't possible or a type is already partially known. In cases like these, -# use Incomplete instead of Any as a marker. For example, use -# "Incomplete | None" instead of "Any | None". -Incomplete: TypeAlias = Any # stable - -# To describe a function parameter that is unused and will work with anything. -Unused: TypeAlias = object # stable - -# Marker for return types that include None, but where forcing the user to -# check for None can be detrimental. Sometimes called "the Any trick". See -# CONTRIBUTING.md for more information. -MaybeNone: TypeAlias = Any # stable - -# Used to mark arguments that default to a sentinel value. This prevents -# stubtest from complaining about the default value not matching. -# -# def foo(x: int | None = sentinel) -> None: ... -# -# In cases where the sentinel object is exported and can be used by user code, -# a construct like this is better: -# -# _SentinelType = NewType("_SentinelType", object) -# sentinel: _SentinelType -# def foo(x: int | None | _SentinelType = ...) -> None: ... -sentinel: Any - -# stable -class IdentityFunction(Protocol): - def __call__(self, x: _T, /) -> _T: ... - -# stable -class SupportsNext(Protocol[_T_co]): - def __next__(self) -> _T_co: ... - -# stable -class SupportsAnext(Protocol[_T_co]): - def __anext__(self) -> Awaitable[_T_co]: ... - -# Comparison protocols - -class SupportsDunderLT(Protocol[_T_contra]): - def __lt__(self, other: _T_contra, /) -> bool: ... - -class SupportsDunderGT(Protocol[_T_contra]): - def __gt__(self, other: _T_contra, /) -> bool: ... - -class SupportsDunderLE(Protocol[_T_contra]): - def __le__(self, other: _T_contra, /) -> bool: ... - -class SupportsDunderGE(Protocol[_T_contra]): - def __ge__(self, other: _T_contra, /) -> bool: ... - -class SupportsAllComparisons( - SupportsDunderLT[Any], SupportsDunderGT[Any], SupportsDunderLE[Any], SupportsDunderGE[Any], Protocol -): ... - -SupportsRichComparison: TypeAlias = SupportsDunderLT[Any] | SupportsDunderGT[Any] -SupportsRichComparisonT = TypeVar("SupportsRichComparisonT", bound=SupportsRichComparison) # noqa: Y001 - -# Dunder protocols - -class SupportsAdd(Protocol[_T_contra, _T_co]): - def __add__(self, x: _T_contra, /) -> _T_co: ... - -class SupportsRAdd(Protocol[_T_contra, _T_co]): - def __radd__(self, x: _T_contra, /) -> _T_co: ... - -class SupportsSub(Protocol[_T_contra, _T_co]): - def __sub__(self, x: _T_contra, /) -> _T_co: ... - -class SupportsRSub(Protocol[_T_contra, _T_co]): - def __rsub__(self, x: _T_contra, /) -> _T_co: ... - -class SupportsDivMod(Protocol[_T_contra, _T_co]): - def __divmod__(self, other: _T_contra, /) -> _T_co: ... - -class SupportsRDivMod(Protocol[_T_contra, _T_co]): - def __rdivmod__(self, other: _T_contra, /) -> _T_co: ... - -# This protocol is generic over the iterator type, while Iterable is -# generic over the type that is iterated over. -class SupportsIter(Protocol[_T_co]): - def __iter__(self) -> _T_co: ... - -# This protocol is generic over the iterator type, while AsyncIterable is -# generic over the type that is iterated over. -class SupportsAiter(Protocol[_T_co]): - def __aiter__(self) -> _T_co: ... - -class SupportsLenAndGetItem(Protocol[_T_co]): - def __len__(self) -> int: ... - def __getitem__(self, k: int, /) -> _T_co: ... - -class SupportsTrunc(Protocol): - def __trunc__(self) -> int: ... - -# Mapping-like protocols - -# stable -class SupportsItems(Protocol[_KT_co, _VT_co]): - def items(self) -> AbstractSet[tuple[_KT_co, _VT_co]]: ... - -# stable -class SupportsKeysAndGetItem(Protocol[_KT, _VT_co]): - def keys(self) -> Iterable[_KT]: ... - def __getitem__(self, key: _KT, /) -> _VT_co: ... - -# This protocol is currently under discussion. Use SupportsContainsAndGetItem -# instead, if you require the __contains__ method. -# See https://github.com/python/typeshed/issues/11822. -class SupportsGetItem(Protocol[_KT_contra, _VT_co]): - def __contains__(self, x: Any, /) -> bool: ... - def __getitem__(self, key: _KT_contra, /) -> _VT_co: ... - -# stable -class SupportsContainsAndGetItem(Protocol[_KT_contra, _VT_co]): - def __contains__(self, x: Any, /) -> bool: ... - def __getitem__(self, key: _KT_contra, /) -> _VT_co: ... - -# stable -class SupportsItemAccess(Protocol[_KT_contra, _VT]): - def __contains__(self, x: Any, /) -> bool: ... - def __getitem__(self, key: _KT_contra, /) -> _VT: ... - def __setitem__(self, key: _KT_contra, value: _VT, /) -> None: ... - def __delitem__(self, key: _KT_contra, /) -> None: ... - -StrPath: TypeAlias = str | PathLike[str] # stable -BytesPath: TypeAlias = bytes | PathLike[bytes] # stable -GenericPath: TypeAlias = AnyStr | PathLike[AnyStr] -StrOrBytesPath: TypeAlias = str | bytes | PathLike[str] | PathLike[bytes] # stable - -OpenTextModeUpdating: TypeAlias = Literal[ - "r+", - "+r", - "rt+", - "r+t", - "+rt", - "tr+", - "t+r", - "+tr", - "w+", - "+w", - "wt+", - "w+t", - "+wt", - "tw+", - "t+w", - "+tw", - "a+", - "+a", - "at+", - "a+t", - "+at", - "ta+", - "t+a", - "+ta", - "x+", - "+x", - "xt+", - "x+t", - "+xt", - "tx+", - "t+x", - "+tx", -] -OpenTextModeWriting: TypeAlias = Literal["w", "wt", "tw", "a", "at", "ta", "x", "xt", "tx"] -OpenTextModeReading: TypeAlias = Literal["r", "rt", "tr", "U", "rU", "Ur", "rtU", "rUt", "Urt", "trU", "tUr", "Utr"] -OpenTextMode: TypeAlias = OpenTextModeUpdating | OpenTextModeWriting | OpenTextModeReading -OpenBinaryModeUpdating: TypeAlias = Literal[ - "rb+", - "r+b", - "+rb", - "br+", - "b+r", - "+br", - "wb+", - "w+b", - "+wb", - "bw+", - "b+w", - "+bw", - "ab+", - "a+b", - "+ab", - "ba+", - "b+a", - "+ba", - "xb+", - "x+b", - "+xb", - "bx+", - "b+x", - "+bx", -] -OpenBinaryModeWriting: TypeAlias = Literal["wb", "bw", "ab", "ba", "xb", "bx"] -OpenBinaryModeReading: TypeAlias = Literal["rb", "br", "rbU", "rUb", "Urb", "brU", "bUr", "Ubr"] -OpenBinaryMode: TypeAlias = OpenBinaryModeUpdating | OpenBinaryModeReading | OpenBinaryModeWriting - -# stable -class HasFileno(Protocol): - def fileno(self) -> int: ... - -FileDescriptor: TypeAlias = int # stable -FileDescriptorLike: TypeAlias = int | HasFileno # stable -FileDescriptorOrPath: TypeAlias = int | StrOrBytesPath - -# stable -class SupportsRead(Protocol[_T_co]): - def read(self, length: int = ..., /) -> _T_co: ... - -# stable -class SupportsReadline(Protocol[_T_co]): - def readline(self, length: int = ..., /) -> _T_co: ... - -# stable -class SupportsNoArgReadline(Protocol[_T_co]): - def readline(self) -> _T_co: ... - -# stable -class SupportsWrite(Protocol[_T_contra]): - def write(self, s: _T_contra, /) -> object: ... - -# stable -class SupportsFlush(Protocol): - def flush(self) -> object: ... - -# Unfortunately PEP 688 does not allow us to distinguish read-only -# from writable buffers. We use these aliases for readability for now. -# Perhaps a future extension of the buffer protocol will allow us to -# distinguish these cases in the type system. -ReadOnlyBuffer: TypeAlias = Buffer # stable -# Anything that implements the read-write buffer interface. -WriteableBuffer: TypeAlias = Buffer -# Same as WriteableBuffer, but also includes read-only buffer types (like bytes). -ReadableBuffer: TypeAlias = Buffer # stable - -class SliceableBuffer(Buffer, Protocol): - def __getitem__(self, slice: slice, /) -> Sequence[int]: ... - -class IndexableBuffer(Buffer, Protocol): - def __getitem__(self, i: int, /) -> int: ... - -class SupportsGetItemBuffer(SliceableBuffer, IndexableBuffer, Protocol): - def __contains__(self, x: Any, /) -> bool: ... - @overload - def __getitem__(self, slice: slice, /) -> Sequence[int]: ... - @overload - def __getitem__(self, i: int, /) -> int: ... - -class SizedBuffer(Sized, Buffer, Protocol): ... - -# for compatibility with third-party stubs that may use this -_BufferWithLen: TypeAlias = SizedBuffer # not stable # noqa: Y047 - -ExcInfo: TypeAlias = tuple[type[BaseException], BaseException, TracebackType] -OptExcInfo: TypeAlias = ExcInfo | tuple[None, None, None] - -# stable -if sys.version_info >= (3, 10): - from types import NoneType as NoneType -else: - # Used by type checkers for checks involving None (does not exist at runtime) - @final - class NoneType: - def __bool__(self) -> Literal[False]: ... - -# This is an internal CPython type that is like, but subtly different from, a NamedTuple -# Subclasses of this type are found in multiple modules. -# In typeshed, `structseq` is only ever used as a mixin in combination with a fixed-length `Tuple` -# See discussion at #6546 & #6560 -# `structseq` classes are unsubclassable, so are all decorated with `@final`. -class structseq(Generic[_T_co]): - n_fields: Final[int] - n_unnamed_fields: Final[int] - n_sequence_fields: Final[int] - # The first parameter will generally only take an iterable of a specific length. - # E.g. `os.uname_result` takes any iterable of length exactly 5. - # - # The second parameter will accept a dict of any kind without raising an exception, - # but only has any meaning if you supply it a dict where the keys are strings. - # https://github.com/python/typeshed/pull/6560#discussion_r767149830 - def __new__(cls: type[Self], sequence: Iterable[_T_co], dict: dict[str, Any] = ...) -> Self: ... - if sys.version_info >= (3, 13): - def __replace__(self: Self, **kwargs: Any) -> Self: ... - -# Superset of typing.AnyStr that also includes LiteralString -AnyOrLiteralStr = TypeVar("AnyOrLiteralStr", str, bytes, LiteralString) # noqa: Y001 - -# Represents when str or LiteralStr is acceptable. Useful for string processing -# APIs where literalness of return value depends on literalness of inputs -StrOrLiteralStr = TypeVar("StrOrLiteralStr", LiteralString, str) # noqa: Y001 - -# Objects suitable to be passed to sys.setprofile, threading.setprofile, and similar -ProfileFunction: TypeAlias = Callable[[FrameType, str, Any], object] - -# Objects suitable to be passed to sys.settrace, threading.settrace, and similar -TraceFunction: TypeAlias = Callable[[FrameType, str, Any], TraceFunction | None] - -# experimental -# Might not work as expected for pyright, see -# https://github.com/python/typeshed/pull/9362 -# https://github.com/microsoft/pyright/issues/4339 -class DataclassInstance(Protocol): - __dataclass_fields__: ClassVar[dict[str, Field[Any]]] - -# Anything that can be passed to the int/float constructors -ConvertibleToInt: TypeAlias = str | ReadableBuffer | SupportsInt | SupportsIndex | SupportsTrunc -ConvertibleToFloat: TypeAlias = str | ReadableBuffer | SupportsFloat | SupportsIndex - -# A few classes updated from Foo(str, Enum) to Foo(StrEnum). This is a convenience so these -# can be accurate on all python versions without getting too wordy -if sys.version_info >= (3, 11): - from enum import StrEnum as StrEnum -else: - from enum import Enum - - class StrEnum(str, Enum): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/array.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/array.pyi deleted file mode 100644 index 878d8d8cb808b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/array.pyi +++ /dev/null @@ -1,92 +0,0 @@ -import sys -from _typeshed import ReadableBuffer, SupportsRead, SupportsWrite -from collections.abc import Iterable - -# pytype crashes if array inherits from collections.abc.MutableSequence instead of typing.MutableSequence -from typing import Any, Literal, MutableSequence, SupportsIndex, TypeVar, overload # noqa: Y022 -from typing_extensions import Self, TypeAlias - -if sys.version_info >= (3, 12): - from types import GenericAlias - -_IntTypeCode: TypeAlias = Literal["b", "B", "h", "H", "i", "I", "l", "L", "q", "Q"] -_FloatTypeCode: TypeAlias = Literal["f", "d"] -_UnicodeTypeCode: TypeAlias = Literal["u"] -_TypeCode: TypeAlias = _IntTypeCode | _FloatTypeCode | _UnicodeTypeCode - -_T = TypeVar("_T", int, float, str) - -typecodes: str - -class array(MutableSequence[_T]): - @property - def typecode(self) -> _TypeCode: ... - @property - def itemsize(self) -> int: ... - @overload - def __init__(self: array[int], typecode: _IntTypeCode, initializer: bytes | bytearray | Iterable[int] = ..., /) -> None: ... - @overload - def __init__( - self: array[float], typecode: _FloatTypeCode, initializer: bytes | bytearray | Iterable[float] = ..., / - ) -> None: ... - @overload - def __init__( - self: array[str], typecode: _UnicodeTypeCode, initializer: bytes | bytearray | Iterable[str] = ..., / - ) -> None: ... - @overload - def __init__(self, typecode: str, initializer: Iterable[_T], /) -> None: ... - @overload - def __init__(self, typecode: str, initializer: bytes | bytearray = ..., /) -> None: ... - def append(self, v: _T, /) -> None: ... - def buffer_info(self) -> tuple[int, int]: ... - def byteswap(self) -> None: ... - def count(self, v: _T, /) -> int: ... - def extend(self, bb: Iterable[_T], /) -> None: ... - def frombytes(self, buffer: ReadableBuffer, /) -> None: ... - def fromfile(self, f: SupportsRead[bytes], n: int, /) -> None: ... - def fromlist(self, list: list[_T], /) -> None: ... - def fromunicode(self, ustr: str, /) -> None: ... - if sys.version_info >= (3, 10): - def index(self, v: _T, start: int = 0, stop: int = sys.maxsize, /) -> int: ... - else: - def index(self, v: _T, /) -> int: ... # type: ignore[override] - - def insert(self, i: int, v: _T, /) -> None: ... - def pop(self, i: int = -1, /) -> _T: ... - def remove(self, v: _T, /) -> None: ... - def tobytes(self) -> bytes: ... - def tofile(self, f: SupportsWrite[bytes], /) -> None: ... - def tolist(self) -> list[_T]: ... - def tounicode(self) -> str: ... - if sys.version_info < (3, 9): - def fromstring(self, buffer: str | ReadableBuffer, /) -> None: ... - def tostring(self) -> bytes: ... - - def __len__(self) -> int: ... - @overload - def __getitem__(self, key: SupportsIndex, /) -> _T: ... - @overload - def __getitem__(self, key: slice, /) -> array[_T]: ... - @overload # type: ignore[override] - def __setitem__(self, key: SupportsIndex, value: _T, /) -> None: ... - @overload - def __setitem__(self, key: slice, value: array[_T], /) -> None: ... - def __delitem__(self, key: SupportsIndex | slice, /) -> None: ... - def __add__(self, value: array[_T], /) -> array[_T]: ... - def __eq__(self, value: object, /) -> bool: ... - def __ge__(self, value: array[_T], /) -> bool: ... - def __gt__(self, value: array[_T], /) -> bool: ... - def __iadd__(self, value: array[_T], /) -> Self: ... # type: ignore[override] - def __imul__(self, value: int, /) -> Self: ... - def __le__(self, value: array[_T], /) -> bool: ... - def __lt__(self, value: array[_T], /) -> bool: ... - def __mul__(self, value: int, /) -> array[_T]: ... - def __rmul__(self, value: int, /) -> array[_T]: ... - def __copy__(self) -> array[_T]: ... - def __deepcopy__(self, unused: Any, /) -> array[_T]: ... - def __buffer__(self, flags: int, /) -> memoryview: ... - def __release_buffer__(self, buffer: memoryview, /) -> None: ... - if sys.version_info >= (3, 12): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -ArrayType = array diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi deleted file mode 100644 index daf28862aa6a9..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi +++ /dev/null @@ -1,41 +0,0 @@ -import sys -from collections.abc import Awaitable, Coroutine, Generator -from typing import Any, TypeVar -from typing_extensions import TypeAlias - -# As at runtime, this depends on all submodules defining __all__ accurately. -from .base_events import * -from .coroutines import * -from .events import * -from .exceptions import * -from .futures import * -from .locks import * -from .protocols import * -from .queues import * -from .runners import * -from .streams import * -from .subprocess import * -from .tasks import * -from .transports import * - -if sys.version_info >= (3, 9): - from .threads import * - -if sys.version_info >= (3, 11): - from .taskgroups import * - from .timeouts import * - -if sys.platform == "win32": - from .windows_events import * -else: - from .unix_events import * - -_T_co = TypeVar("_T_co", covariant=True) - -# Aliases imported by multiple submodules in typeshed -if sys.version_info >= (3, 12): - _AwaitableLike: TypeAlias = Awaitable[_T_co] # noqa: Y047 - _CoroutineLike: TypeAlias = Coroutine[Any, Any, _T_co] # noqa: Y047 -else: - _AwaitableLike: TypeAlias = Generator[Any, None, _T_co] | Awaitable[_T_co] - _CoroutineLike: TypeAlias = Generator[Any, None, _T_co] | Coroutine[Any, Any, _T_co] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi deleted file mode 100644 index 28e6ca8c86a33..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi +++ /dev/null @@ -1,16 +0,0 @@ -from _asyncio import Future as Future -from concurrent.futures._base import Future as _ConcurrentFuture -from typing import Any, TypeVar -from typing_extensions import TypeIs - -from .events import AbstractEventLoop - -__all__ = ("Future", "wrap_future", "isfuture") - -_T = TypeVar("_T") - -# asyncio defines 'isfuture()' in base_futures.py and re-imports it in futures.py -# but it leads to circular import error in pytype tool. -# That's why the import order is reversed. -def isfuture(obj: object) -> TypeIs[Future[Any]]: ... -def wrap_future(future: _ConcurrentFuture[_T] | Future[_T], *, loop: AbstractEventLoop | None = None) -> Future[_T]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi deleted file mode 100644 index 0114aeb233292..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi +++ /dev/null @@ -1,121 +0,0 @@ -import enum -import sys -from _typeshed import Unused -from collections import deque -from collections.abc import Callable, Generator -from types import TracebackType -from typing import Any, Literal, TypeVar -from typing_extensions import Self - -from .events import AbstractEventLoop -from .futures import Future - -if sys.version_info >= (3, 10): - from .mixins import _LoopBoundMixin -else: - _LoopBoundMixin = object - -if sys.version_info >= (3, 11): - __all__ = ("Lock", "Event", "Condition", "Semaphore", "BoundedSemaphore", "Barrier") -else: - __all__ = ("Lock", "Event", "Condition", "Semaphore", "BoundedSemaphore") - -_T = TypeVar("_T") - -if sys.version_info >= (3, 9): - class _ContextManagerMixin: - async def __aenter__(self) -> None: ... - async def __aexit__( - self, exc_type: type[BaseException] | None, exc: BaseException | None, tb: TracebackType | None - ) -> None: ... - -else: - class _ContextManager: - def __init__(self, lock: Lock | Semaphore) -> None: ... - def __enter__(self) -> None: ... - def __exit__(self, *args: Unused) -> None: ... - - class _ContextManagerMixin: - # Apparently this exists to *prohibit* use as a context manager. - # def __enter__(self) -> NoReturn: ... see: https://github.com/python/typing/issues/1043 - # def __exit__(self, *args: Any) -> None: ... - def __iter__(self) -> Generator[Any, None, _ContextManager]: ... - def __await__(self) -> Generator[Any, None, _ContextManager]: ... - async def __aenter__(self) -> None: ... - async def __aexit__( - self, exc_type: type[BaseException] | None, exc: BaseException | None, tb: TracebackType | None - ) -> None: ... - -class Lock(_ContextManagerMixin, _LoopBoundMixin): - _waiters: deque[Future[Any]] | None - if sys.version_info >= (3, 10): - def __init__(self) -> None: ... - else: - def __init__(self, *, loop: AbstractEventLoop | None = None) -> None: ... - - def locked(self) -> bool: ... - async def acquire(self) -> Literal[True]: ... - def release(self) -> None: ... - -class Event(_LoopBoundMixin): - _waiters: deque[Future[Any]] - if sys.version_info >= (3, 10): - def __init__(self) -> None: ... - else: - def __init__(self, *, loop: AbstractEventLoop | None = None) -> None: ... - - def is_set(self) -> bool: ... - def set(self) -> None: ... - def clear(self) -> None: ... - async def wait(self) -> Literal[True]: ... - -class Condition(_ContextManagerMixin, _LoopBoundMixin): - _waiters: deque[Future[Any]] - if sys.version_info >= (3, 10): - def __init__(self, lock: Lock | None = None) -> None: ... - else: - def __init__(self, lock: Lock | None = None, *, loop: AbstractEventLoop | None = None) -> None: ... - - def locked(self) -> bool: ... - async def acquire(self) -> Literal[True]: ... - def release(self) -> None: ... - async def wait(self) -> Literal[True]: ... - async def wait_for(self, predicate: Callable[[], _T]) -> _T: ... - def notify(self, n: int = 1) -> None: ... - def notify_all(self) -> None: ... - -class Semaphore(_ContextManagerMixin, _LoopBoundMixin): - _value: int - _waiters: deque[Future[Any]] | None - if sys.version_info >= (3, 10): - def __init__(self, value: int = 1) -> None: ... - else: - def __init__(self, value: int = 1, *, loop: AbstractEventLoop | None = None) -> None: ... - - def locked(self) -> bool: ... - async def acquire(self) -> Literal[True]: ... - def release(self) -> None: ... - def _wake_up_next(self) -> None: ... - -class BoundedSemaphore(Semaphore): ... - -if sys.version_info >= (3, 11): - class _BarrierState(enum.Enum): # undocumented - FILLING = "filling" - DRAINING = "draining" - RESETTING = "resetting" - BROKEN = "broken" - - class Barrier(_LoopBoundMixin): - def __init__(self, parties: int) -> None: ... - async def __aenter__(self) -> Self: ... - async def __aexit__(self, *args: Unused) -> None: ... - async def wait(self) -> int: ... - async def abort(self) -> None: ... - async def reset(self) -> None: ... - @property - def parties(self) -> int: ... - @property - def n_waiting(self) -> int: ... - @property - def broken(self) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi deleted file mode 100644 index 895205aa95197..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi +++ /dev/null @@ -1,56 +0,0 @@ -import sys -from asyncio.events import AbstractEventLoop -from typing import Any, Generic, TypeVar - -if sys.version_info >= (3, 9): - from types import GenericAlias - -if sys.version_info >= (3, 10): - from .mixins import _LoopBoundMixin -else: - _LoopBoundMixin = object - -class QueueEmpty(Exception): ... -class QueueFull(Exception): ... - -if sys.version_info >= (3, 13): - __all__ = ("Queue", "PriorityQueue", "LifoQueue", "QueueFull", "QueueEmpty", "QueueShutDown") - -else: - __all__ = ("Queue", "PriorityQueue", "LifoQueue", "QueueFull", "QueueEmpty") - -_T = TypeVar("_T") - -if sys.version_info >= (3, 13): - class QueueShutDown(Exception): ... - -# If Generic[_T] is last and _LoopBoundMixin is object, pyright is unhappy. -# We can remove the noqa pragma when dropping 3.9 support. -class Queue(Generic[_T], _LoopBoundMixin): # noqa: Y059 - if sys.version_info >= (3, 10): - def __init__(self, maxsize: int = 0) -> None: ... - else: - def __init__(self, maxsize: int = 0, *, loop: AbstractEventLoop | None = None) -> None: ... - - def _init(self, maxsize: int) -> None: ... - def _get(self) -> _T: ... - def _put(self, item: _T) -> None: ... - def _format(self) -> str: ... - def qsize(self) -> int: ... - @property - def maxsize(self) -> int: ... - def empty(self) -> bool: ... - def full(self) -> bool: ... - async def put(self, item: _T) -> None: ... - def put_nowait(self, item: _T) -> None: ... - async def get(self) -> _T: ... - def get_nowait(self) -> _T: ... - async def join(self) -> None: ... - def task_done(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, type: Any, /) -> GenericAlias: ... - if sys.version_info >= (3, 13): - def shutdown(self, immediate: bool = False) -> None: ... - -class PriorityQueue(Queue[_T]): ... -class LifoQueue(Queue[_T]): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi deleted file mode 100644 index 430f2dd405cd6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi +++ /dev/null @@ -1,8 +0,0 @@ -import selectors - -from . import base_events - -__all__ = ("BaseSelectorEventLoop",) - -class BaseSelectorEventLoop(base_events.BaseEventLoop): - def __init__(self, selector: selectors.BaseSelector | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi deleted file mode 100644 index 19452d4eb469c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi +++ /dev/null @@ -1,229 +0,0 @@ -import subprocess -import sys -from _typeshed import StrOrBytesPath -from asyncio import events, protocols, streams, transports -from collections.abc import Callable, Collection -from typing import IO, Any, Literal - -__all__ = ("create_subprocess_exec", "create_subprocess_shell") - -PIPE: int -STDOUT: int -DEVNULL: int - -class SubprocessStreamProtocol(streams.FlowControlMixin, protocols.SubprocessProtocol): - stdin: streams.StreamWriter | None - stdout: streams.StreamReader | None - stderr: streams.StreamReader | None - def __init__(self, limit: int, loop: events.AbstractEventLoop) -> None: ... - def pipe_data_received(self, fd: int, data: bytes | str) -> None: ... - -class Process: - stdin: streams.StreamWriter | None - stdout: streams.StreamReader | None - stderr: streams.StreamReader | None - pid: int - def __init__( - self, transport: transports.BaseTransport, protocol: protocols.BaseProtocol, loop: events.AbstractEventLoop - ) -> None: ... - @property - def returncode(self) -> int | None: ... - async def wait(self) -> int: ... - def send_signal(self, signal: int) -> None: ... - def terminate(self) -> None: ... - def kill(self) -> None: ... - async def communicate(self, input: bytes | bytearray | memoryview | None = None) -> tuple[bytes, bytes]: ... - -if sys.version_info >= (3, 11): - async def create_subprocess_shell( - cmd: str | bytes, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - limit: int = 65536, - *, - # These parameters are forced to these values by BaseEventLoop.subprocess_shell - universal_newlines: Literal[False] = False, - shell: Literal[True] = True, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - process_group: int | None = None, - pipesize: int = -1, - ) -> Process: ... - async def create_subprocess_exec( - program: StrOrBytesPath, - *args: StrOrBytesPath, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - limit: int = 65536, - # These parameters are forced to these values by BaseEventLoop.subprocess_exec - universal_newlines: Literal[False] = False, - shell: Literal[False] = False, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - process_group: int | None = None, - pipesize: int = -1, - ) -> Process: ... - -elif sys.version_info >= (3, 10): - async def create_subprocess_shell( - cmd: str | bytes, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - limit: int = 65536, - *, - # These parameters are forced to these values by BaseEventLoop.subprocess_shell - universal_newlines: Literal[False] = False, - shell: Literal[True] = True, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - pipesize: int = -1, - ) -> Process: ... - async def create_subprocess_exec( - program: StrOrBytesPath, - *args: StrOrBytesPath, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - limit: int = 65536, - # These parameters are forced to these values by BaseEventLoop.subprocess_exec - universal_newlines: Literal[False] = False, - shell: Literal[False] = False, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - pipesize: int = -1, - ) -> Process: ... - -else: # >= 3.9 - async def create_subprocess_shell( - cmd: str | bytes, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - loop: events.AbstractEventLoop | None = None, - limit: int = 65536, - *, - # These parameters are forced to these values by BaseEventLoop.subprocess_shell - universal_newlines: Literal[False] = False, - shell: Literal[True] = True, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - ) -> Process: ... - async def create_subprocess_exec( - program: StrOrBytesPath, - *args: StrOrBytesPath, - stdin: int | IO[Any] | None = None, - stdout: int | IO[Any] | None = None, - stderr: int | IO[Any] | None = None, - loop: events.AbstractEventLoop | None = None, - limit: int = 65536, - # These parameters are forced to these values by BaseEventLoop.subprocess_exec - universal_newlines: Literal[False] = False, - shell: Literal[False] = False, - bufsize: Literal[0] = 0, - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - # These parameters are taken by subprocess.Popen, which this ultimately delegates to - executable: StrOrBytesPath | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - cwd: StrOrBytesPath | None = None, - env: subprocess._ENV | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - group: None | str | int = None, - extra_groups: None | Collection[str | int] = None, - user: None | str | int = None, - umask: int = -1, - ) -> Process: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/bz2.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/bz2.pyi deleted file mode 100644 index cd11baa1a0c1c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/bz2.pyi +++ /dev/null @@ -1,146 +0,0 @@ -import _compression -import sys -from _compression import BaseStream -from _typeshed import ReadableBuffer, StrOrBytesPath, WriteableBuffer -from collections.abc import Iterable -from typing import IO, Any, Literal, Protocol, SupportsIndex, TextIO, final, overload -from typing_extensions import Self, TypeAlias - -__all__ = ["BZ2File", "BZ2Compressor", "BZ2Decompressor", "open", "compress", "decompress"] - -# The following attributes and methods are optional: -# def fileno(self) -> int: ... -# def close(self) -> object: ... -class _ReadableFileobj(_compression._Reader, Protocol): ... - -class _WritableFileobj(Protocol): - def write(self, b: bytes, /) -> object: ... - # The following attributes and methods are optional: - # def fileno(self) -> int: ... - # def close(self) -> object: ... - -def compress(data: ReadableBuffer, compresslevel: int = 9) -> bytes: ... -def decompress(data: ReadableBuffer) -> bytes: ... - -_ReadBinaryMode: TypeAlias = Literal["", "r", "rb"] -_WriteBinaryMode: TypeAlias = Literal["w", "wb", "x", "xb", "a", "ab"] -_ReadTextMode: TypeAlias = Literal["rt"] -_WriteTextMode: TypeAlias = Literal["wt", "xt", "at"] - -@overload -def open( - filename: _ReadableFileobj, - mode: _ReadBinaryMode = "rb", - compresslevel: int = 9, - encoding: None = None, - errors: None = None, - newline: None = None, -) -> BZ2File: ... -@overload -def open( - filename: _ReadableFileobj, - mode: _ReadTextMode, - compresslevel: int = 9, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> TextIO: ... -@overload -def open( - filename: _WritableFileobj, - mode: _WriteBinaryMode, - compresslevel: int = 9, - encoding: None = None, - errors: None = None, - newline: None = None, -) -> BZ2File: ... -@overload -def open( - filename: _WritableFileobj, - mode: _WriteTextMode, - compresslevel: int = 9, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> TextIO: ... -@overload -def open( - filename: StrOrBytesPath, - mode: _ReadBinaryMode | _WriteBinaryMode = "rb", - compresslevel: int = 9, - encoding: None = None, - errors: None = None, - newline: None = None, -) -> BZ2File: ... -@overload -def open( - filename: StrOrBytesPath, - mode: _ReadTextMode | _WriteTextMode, - compresslevel: int = 9, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> TextIO: ... -@overload -def open( - filename: StrOrBytesPath | _ReadableFileobj | _WritableFileobj, - mode: str, - compresslevel: int = 9, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> BZ2File | TextIO: ... - -class BZ2File(BaseStream, IO[bytes]): - def __enter__(self) -> Self: ... - if sys.version_info >= (3, 9): - @overload - def __init__(self, filename: _WritableFileobj, mode: _WriteBinaryMode, *, compresslevel: int = 9) -> None: ... - @overload - def __init__(self, filename: _ReadableFileobj, mode: _ReadBinaryMode = "r", *, compresslevel: int = 9) -> None: ... - @overload - def __init__( - self, filename: StrOrBytesPath, mode: _ReadBinaryMode | _WriteBinaryMode = "r", *, compresslevel: int = 9 - ) -> None: ... - else: - @overload - def __init__( - self, filename: _WritableFileobj, mode: _WriteBinaryMode, buffering: Any | None = None, compresslevel: int = 9 - ) -> None: ... - @overload - def __init__( - self, filename: _ReadableFileobj, mode: _ReadBinaryMode = "r", buffering: Any | None = None, compresslevel: int = 9 - ) -> None: ... - @overload - def __init__( - self, - filename: StrOrBytesPath, - mode: _ReadBinaryMode | _WriteBinaryMode = "r", - buffering: Any | None = None, - compresslevel: int = 9, - ) -> None: ... - - def read(self, size: int | None = -1) -> bytes: ... - def read1(self, size: int = -1) -> bytes: ... - def readline(self, size: SupportsIndex = -1) -> bytes: ... # type: ignore[override] - def readinto(self, b: WriteableBuffer) -> int: ... - def readlines(self, size: SupportsIndex = -1) -> list[bytes]: ... - def seek(self, offset: int, whence: int = 0) -> int: ... - def write(self, data: ReadableBuffer) -> int: ... - def writelines(self, seq: Iterable[ReadableBuffer]) -> None: ... - -@final -class BZ2Compressor: - def __init__(self, compresslevel: int = 9) -> None: ... - def compress(self, data: ReadableBuffer, /) -> bytes: ... - def flush(self) -> bytes: ... - -@final -class BZ2Decompressor: - def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes: ... - @property - def eof(self) -> bool: ... - @property - def needs_input(self) -> bool: ... - @property - def unused_data(self) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/code.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/code.pyi deleted file mode 100644 index 54971f3ae93cf..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/code.pyi +++ /dev/null @@ -1,56 +0,0 @@ -import sys -from codeop import CommandCompiler -from collections.abc import Callable, Mapping -from types import CodeType -from typing import Any - -__all__ = ["InteractiveInterpreter", "InteractiveConsole", "interact", "compile_command"] - -class InteractiveInterpreter: - locals: Mapping[str, Any] # undocumented - compile: CommandCompiler # undocumented - def __init__(self, locals: Mapping[str, Any] | None = None) -> None: ... - def runsource(self, source: str, filename: str = "<input>", symbol: str = "single") -> bool: ... - def runcode(self, code: CodeType) -> None: ... - if sys.version_info >= (3, 13): - def showsyntaxerror(self, filename: str | None = None, *, source: str = "") -> None: ... - else: - def showsyntaxerror(self, filename: str | None = None) -> None: ... - - def showtraceback(self) -> None: ... - def write(self, data: str) -> None: ... - -class InteractiveConsole(InteractiveInterpreter): - buffer: list[str] # undocumented - filename: str # undocumented - if sys.version_info >= (3, 13): - def __init__( - self, locals: Mapping[str, Any] | None = None, filename: str = "<console>", *, local_exit: bool = False - ) -> None: ... - def push(self, line: str, filename: str | None = None) -> bool: ... - else: - def __init__(self, locals: Mapping[str, Any] | None = None, filename: str = "<console>") -> None: ... - def push(self, line: str) -> bool: ... - - def interact(self, banner: str | None = None, exitmsg: str | None = None) -> None: ... - def resetbuffer(self) -> None: ... - def raw_input(self, prompt: str = "") -> str: ... - -if sys.version_info >= (3, 13): - def interact( - banner: str | None = None, - readfunc: Callable[[str], str] | None = None, - local: Mapping[str, Any] | None = None, - exitmsg: str | None = None, - local_exit: bool = False, - ) -> None: ... - -else: - def interact( - banner: str | None = None, - readfunc: Callable[[str], str] | None = None, - local: Mapping[str, Any] | None = None, - exitmsg: str | None = None, - ) -> None: ... - -def compile_command(source: str, filename: str = "<input>", symbol: str = "single") -> CodeType | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/codeop.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/codeop.pyi deleted file mode 100644 index 6a51b7786384c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/codeop.pyi +++ /dev/null @@ -1,13 +0,0 @@ -from types import CodeType - -__all__ = ["compile_command", "Compile", "CommandCompiler"] - -def compile_command(source: str, filename: str = "<input>", symbol: str = "single") -> CodeType | None: ... - -class Compile: - flags: int - def __call__(self, source: str, filename: str, symbol: str) -> CodeType: ... - -class CommandCompiler: - compiler: Compile - def __call__(self, source: str, filename: str = "<input>", symbol: str = "single") -> CodeType | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/collections/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/collections/__init__.pyi deleted file mode 100644 index 2d136318813cc..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/collections/__init__.pyi +++ /dev/null @@ -1,502 +0,0 @@ -import sys -from _collections_abc import dict_items, dict_keys, dict_values -from _typeshed import SupportsItems, SupportsKeysAndGetItem, SupportsRichComparison, SupportsRichComparisonT -from typing import Any, Generic, NoReturn, SupportsIndex, TypeVar, final, overload -from typing_extensions import Self - -if sys.version_info >= (3, 9): - from types import GenericAlias - -if sys.version_info >= (3, 10): - from collections.abc import ( - Callable, - ItemsView, - Iterable, - Iterator, - KeysView, - Mapping, - MutableMapping, - MutableSequence, - Sequence, - ValuesView, - ) -else: - from _collections_abc import * - -__all__ = ["ChainMap", "Counter", "OrderedDict", "UserDict", "UserList", "UserString", "defaultdict", "deque", "namedtuple"] - -_S = TypeVar("_S") -_T = TypeVar("_T") -_T1 = TypeVar("_T1") -_T2 = TypeVar("_T2") -_KT = TypeVar("_KT") -_VT = TypeVar("_VT") -_KT_co = TypeVar("_KT_co", covariant=True) -_VT_co = TypeVar("_VT_co", covariant=True) - -# namedtuple is special-cased in the type checker; the initializer is ignored. -def namedtuple( - typename: str, - field_names: str | Iterable[str], - *, - rename: bool = False, - module: str | None = None, - defaults: Iterable[Any] | None = None, -) -> type[tuple[Any, ...]]: ... - -class UserDict(MutableMapping[_KT, _VT]): - data: dict[_KT, _VT] - # __init__ should be kept roughly in line with `dict.__init__`, which has the same semantics - @overload - def __init__(self, dict: None = None, /) -> None: ... - @overload - def __init__( - self: UserDict[str, _VT], dict: None = None, /, **kwargs: _VT # pyright: ignore[reportInvalidTypeVarUse] #11780 - ) -> None: ... - @overload - def __init__(self, dict: SupportsKeysAndGetItem[_KT, _VT], /) -> None: ... - @overload - def __init__( - self: UserDict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - dict: SupportsKeysAndGetItem[str, _VT], - /, - **kwargs: _VT, - ) -> None: ... - @overload - def __init__(self, iterable: Iterable[tuple[_KT, _VT]], /) -> None: ... - @overload - def __init__( - self: UserDict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - iterable: Iterable[tuple[str, _VT]], - /, - **kwargs: _VT, - ) -> None: ... - @overload - def __init__(self: UserDict[str, str], iterable: Iterable[list[str]], /) -> None: ... - @overload - def __init__(self: UserDict[bytes, bytes], iterable: Iterable[list[bytes]], /) -> None: ... - def __len__(self) -> int: ... - def __getitem__(self, key: _KT) -> _VT: ... - def __setitem__(self, key: _KT, item: _VT) -> None: ... - def __delitem__(self, key: _KT) -> None: ... - def __iter__(self) -> Iterator[_KT]: ... - def __contains__(self, key: object) -> bool: ... - def copy(self) -> Self: ... - def __copy__(self) -> Self: ... - - # `UserDict.fromkeys` has the same semantics as `dict.fromkeys`, so should be kept in line with `dict.fromkeys`. - # TODO: Much like `dict.fromkeys`, the true signature of `UserDict.fromkeys` is inexpressible in the current type system. - # See #3800 & https://github.com/python/typing/issues/548#issuecomment-683336963. - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T], value: None = None) -> UserDict[_T, Any | None]: ... - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T], value: _S) -> UserDict[_T, _S]: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, other: UserDict[_KT, _VT] | dict[_KT, _VT]) -> Self: ... - @overload - def __or__(self, other: UserDict[_T1, _T2] | dict[_T1, _T2]) -> UserDict[_KT | _T1, _VT | _T2]: ... - @overload - def __ror__(self, other: UserDict[_KT, _VT] | dict[_KT, _VT]) -> Self: ... - @overload - def __ror__(self, other: UserDict[_T1, _T2] | dict[_T1, _T2]) -> UserDict[_KT | _T1, _VT | _T2]: ... - # UserDict.__ior__ should be kept roughly in line with MutableMapping.update() - @overload # type: ignore[misc] - def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... - @overload - def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... - if sys.version_info >= (3, 12): - @overload - def get(self, key: _KT, default: None = None) -> _VT | None: ... - @overload - def get(self, key: _KT, default: _T) -> _VT | _T: ... - -class UserList(MutableSequence[_T]): - data: list[_T] - @overload - def __init__(self, initlist: None = None) -> None: ... - @overload - def __init__(self, initlist: Iterable[_T]) -> None: ... - def __lt__(self, other: list[_T] | UserList[_T]) -> bool: ... - def __le__(self, other: list[_T] | UserList[_T]) -> bool: ... - def __gt__(self, other: list[_T] | UserList[_T]) -> bool: ... - def __ge__(self, other: list[_T] | UserList[_T]) -> bool: ... - def __eq__(self, other: object) -> bool: ... - def __contains__(self, item: object) -> bool: ... - def __len__(self) -> int: ... - @overload - def __getitem__(self, i: SupportsIndex) -> _T: ... - @overload - def __getitem__(self, i: slice) -> Self: ... - @overload - def __setitem__(self, i: SupportsIndex, item: _T) -> None: ... - @overload - def __setitem__(self, i: slice, item: Iterable[_T]) -> None: ... - def __delitem__(self, i: SupportsIndex | slice) -> None: ... - def __add__(self, other: Iterable[_T]) -> Self: ... - def __radd__(self, other: Iterable[_T]) -> Self: ... - def __iadd__(self, other: Iterable[_T]) -> Self: ... - def __mul__(self, n: int) -> Self: ... - def __rmul__(self, n: int) -> Self: ... - def __imul__(self, n: int) -> Self: ... - def append(self, item: _T) -> None: ... - def insert(self, i: int, item: _T) -> None: ... - def pop(self, i: int = -1) -> _T: ... - def remove(self, item: _T) -> None: ... - def copy(self) -> Self: ... - def __copy__(self) -> Self: ... - def count(self, item: _T) -> int: ... - # The runtime signature is "item, *args", and the arguments are then passed - # to `list.index`. In order to give more precise types, we pretend that the - # `item` argument is positional-only. - def index(self, item: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: ... - # All arguments are passed to `list.sort` at runtime, so the signature should be kept in line with `list.sort`. - @overload - def sort(self: UserList[SupportsRichComparisonT], *, key: None = None, reverse: bool = False) -> None: ... - @overload - def sort(self, *, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None: ... - def extend(self, other: Iterable[_T]) -> None: ... - -class UserString(Sequence[UserString]): - data: str - def __init__(self, seq: object) -> None: ... - def __int__(self) -> int: ... - def __float__(self) -> float: ... - def __complex__(self) -> complex: ... - def __getnewargs__(self) -> tuple[str]: ... - def __lt__(self, string: str | UserString) -> bool: ... - def __le__(self, string: str | UserString) -> bool: ... - def __gt__(self, string: str | UserString) -> bool: ... - def __ge__(self, string: str | UserString) -> bool: ... - def __eq__(self, string: object) -> bool: ... - def __hash__(self) -> int: ... - def __contains__(self, char: object) -> bool: ... - def __len__(self) -> int: ... - def __getitem__(self, index: SupportsIndex | slice) -> Self: ... - def __iter__(self) -> Iterator[Self]: ... - def __reversed__(self) -> Iterator[Self]: ... - def __add__(self, other: object) -> Self: ... - def __radd__(self, other: object) -> Self: ... - def __mul__(self, n: int) -> Self: ... - def __rmul__(self, n: int) -> Self: ... - def __mod__(self, args: Any) -> Self: ... - def __rmod__(self, template: object) -> Self: ... - def capitalize(self) -> Self: ... - def casefold(self) -> Self: ... - def center(self, width: int, *args: Any) -> Self: ... - def count(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... - def encode(self: UserString, encoding: str | None = "utf-8", errors: str | None = "strict") -> bytes: ... - def endswith(self, suffix: str | tuple[str, ...], start: int | None = 0, end: int | None = sys.maxsize) -> bool: ... - def expandtabs(self, tabsize: int = 8) -> Self: ... - def find(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... - def format(self, *args: Any, **kwds: Any) -> str: ... - def format_map(self, mapping: Mapping[str, Any]) -> str: ... - def index(self, sub: str, start: int = 0, end: int = sys.maxsize) -> int: ... - def isalpha(self) -> bool: ... - def isalnum(self) -> bool: ... - def isdecimal(self) -> bool: ... - def isdigit(self) -> bool: ... - def isidentifier(self) -> bool: ... - def islower(self) -> bool: ... - def isnumeric(self) -> bool: ... - def isprintable(self) -> bool: ... - def isspace(self) -> bool: ... - def istitle(self) -> bool: ... - def isupper(self) -> bool: ... - def isascii(self) -> bool: ... - def join(self, seq: Iterable[str]) -> str: ... - def ljust(self, width: int, *args: Any) -> Self: ... - def lower(self) -> Self: ... - def lstrip(self, chars: str | None = None) -> Self: ... - maketrans = str.maketrans - def partition(self, sep: str) -> tuple[str, str, str]: ... - if sys.version_info >= (3, 9): - def removeprefix(self, prefix: str | UserString, /) -> Self: ... - def removesuffix(self, suffix: str | UserString, /) -> Self: ... - - def replace(self, old: str | UserString, new: str | UserString, maxsplit: int = -1) -> Self: ... - def rfind(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... - def rindex(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... - def rjust(self, width: int, *args: Any) -> Self: ... - def rpartition(self, sep: str) -> tuple[str, str, str]: ... - def rstrip(self, chars: str | None = None) -> Self: ... - def split(self, sep: str | None = None, maxsplit: int = -1) -> list[str]: ... - def rsplit(self, sep: str | None = None, maxsplit: int = -1) -> list[str]: ... - def splitlines(self, keepends: bool = False) -> list[str]: ... - def startswith(self, prefix: str | tuple[str, ...], start: int | None = 0, end: int | None = sys.maxsize) -> bool: ... - def strip(self, chars: str | None = None) -> Self: ... - def swapcase(self) -> Self: ... - def title(self) -> Self: ... - def translate(self, *args: Any) -> Self: ... - def upper(self) -> Self: ... - def zfill(self, width: int) -> Self: ... - -class deque(MutableSequence[_T]): - @property - def maxlen(self) -> int | None: ... - @overload - def __init__(self, *, maxlen: int | None = None) -> None: ... - @overload - def __init__(self, iterable: Iterable[_T], maxlen: int | None = None) -> None: ... - def append(self, x: _T, /) -> None: ... - def appendleft(self, x: _T, /) -> None: ... - def copy(self) -> Self: ... - def count(self, x: _T, /) -> int: ... - def extend(self, iterable: Iterable[_T], /) -> None: ... - def extendleft(self, iterable: Iterable[_T], /) -> None: ... - def insert(self, i: int, x: _T, /) -> None: ... - def index(self, x: _T, start: int = 0, stop: int = ..., /) -> int: ... - def pop(self) -> _T: ... # type: ignore[override] - def popleft(self) -> _T: ... - def remove(self, value: _T, /) -> None: ... - def rotate(self, n: int = 1, /) -> None: ... - def __copy__(self) -> Self: ... - def __len__(self) -> int: ... - # These methods of deque don't take slices, unlike MutableSequence, hence the type: ignores - def __getitem__(self, key: SupportsIndex, /) -> _T: ... # type: ignore[override] - def __setitem__(self, key: SupportsIndex, value: _T, /) -> None: ... # type: ignore[override] - def __delitem__(self, key: SupportsIndex, /) -> None: ... # type: ignore[override] - def __contains__(self, key: object, /) -> bool: ... - def __reduce__(self) -> tuple[type[Self], tuple[()], None, Iterator[_T]]: ... - def __iadd__(self, value: Iterable[_T], /) -> Self: ... - def __add__(self, value: Self, /) -> Self: ... - def __mul__(self, value: int, /) -> Self: ... - def __imul__(self, value: int, /) -> Self: ... - def __lt__(self, value: deque[_T], /) -> bool: ... - def __le__(self, value: deque[_T], /) -> bool: ... - def __gt__(self, value: deque[_T], /) -> bool: ... - def __ge__(self, value: deque[_T], /) -> bool: ... - def __eq__(self, value: object, /) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class Counter(dict[_T, int], Generic[_T]): - @overload - def __init__(self, iterable: None = None, /) -> None: ... - @overload - def __init__(self: Counter[str], iterable: None = None, /, **kwargs: int) -> None: ... - @overload - def __init__(self, mapping: SupportsKeysAndGetItem[_T, int], /) -> None: ... - @overload - def __init__(self, iterable: Iterable[_T], /) -> None: ... - def copy(self) -> Self: ... - def elements(self) -> Iterator[_T]: ... - def most_common(self, n: int | None = None) -> list[tuple[_T, int]]: ... - @classmethod - def fromkeys(cls, iterable: Any, v: int | None = None) -> NoReturn: ... # type: ignore[override] - @overload - def subtract(self, iterable: None = None, /) -> None: ... - @overload - def subtract(self, mapping: Mapping[_T, int], /) -> None: ... - @overload - def subtract(self, iterable: Iterable[_T], /) -> None: ... - # Unlike dict.update(), use Mapping instead of SupportsKeysAndGetItem for the first overload - # (source code does an `isinstance(other, Mapping)` check) - # - # The second overload is also deliberately different to dict.update() - # (if it were `Iterable[_T] | Iterable[tuple[_T, int]]`, - # the tuples would be added as keys, breaking type safety) - @overload # type: ignore[override] - def update(self, m: Mapping[_T, int], /, **kwargs: int) -> None: ... - @overload - def update(self, iterable: Iterable[_T], /, **kwargs: int) -> None: ... - @overload - def update(self, iterable: None = None, /, **kwargs: int) -> None: ... - def __missing__(self, key: _T) -> int: ... - def __delitem__(self, elem: object) -> None: ... - if sys.version_info >= (3, 10): - def __eq__(self, other: object) -> bool: ... - def __ne__(self, other: object) -> bool: ... - - def __add__(self, other: Counter[_S]) -> Counter[_T | _S]: ... - def __sub__(self, other: Counter[_T]) -> Counter[_T]: ... - def __and__(self, other: Counter[_T]) -> Counter[_T]: ... - def __or__(self, other: Counter[_S]) -> Counter[_T | _S]: ... # type: ignore[override] - def __pos__(self) -> Counter[_T]: ... - def __neg__(self) -> Counter[_T]: ... - # several type: ignores because __iadd__ is supposedly incompatible with __add__, etc. - def __iadd__(self, other: SupportsItems[_T, int]) -> Self: ... # type: ignore[misc] - def __isub__(self, other: SupportsItems[_T, int]) -> Self: ... - def __iand__(self, other: SupportsItems[_T, int]) -> Self: ... - def __ior__(self, other: SupportsItems[_T, int]) -> Self: ... # type: ignore[override,misc] - if sys.version_info >= (3, 10): - def total(self) -> int: ... - def __le__(self, other: Counter[Any]) -> bool: ... - def __lt__(self, other: Counter[Any]) -> bool: ... - def __ge__(self, other: Counter[Any]) -> bool: ... - def __gt__(self, other: Counter[Any]) -> bool: ... - -# The pure-Python implementations of the "views" classes -# These are exposed at runtime in `collections/__init__.py` -class _OrderedDictKeysView(KeysView[_KT_co]): - def __reversed__(self) -> Iterator[_KT_co]: ... - -class _OrderedDictItemsView(ItemsView[_KT_co, _VT_co]): - def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... - -class _OrderedDictValuesView(ValuesView[_VT_co]): - def __reversed__(self) -> Iterator[_VT_co]: ... - -# The C implementations of the "views" classes -# (At runtime, these are called `odict_keys`, `odict_items` and `odict_values`, -# but they are not exposed anywhere) -# pyright doesn't have a specific error code for subclassing error! -@final -class _odict_keys(dict_keys[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - def __reversed__(self) -> Iterator[_KT_co]: ... - -@final -class _odict_items(dict_items[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... - -@final -class _odict_values(dict_values[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - def __reversed__(self) -> Iterator[_VT_co]: ... - -class OrderedDict(dict[_KT, _VT]): - def popitem(self, last: bool = True) -> tuple[_KT, _VT]: ... - def move_to_end(self, key: _KT, last: bool = True) -> None: ... - def copy(self) -> Self: ... - def __reversed__(self) -> Iterator[_KT]: ... - def keys(self) -> _odict_keys[_KT, _VT]: ... - def items(self) -> _odict_items[_KT, _VT]: ... - def values(self) -> _odict_values[_KT, _VT]: ... - # The signature of OrderedDict.fromkeys should be kept in line with `dict.fromkeys`, modulo positional-only differences. - # Like dict.fromkeys, its true signature is not expressible in the current type system. - # See #3800 & https://github.com/python/typing/issues/548#issuecomment-683336963. - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T], value: None = None) -> OrderedDict[_T, Any | None]: ... - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T], value: _S) -> OrderedDict[_T, _S]: ... - # Keep OrderedDict.setdefault in line with MutableMapping.setdefault, modulo positional-only differences. - @overload - def setdefault(self: OrderedDict[_KT, _T | None], key: _KT, default: None = None) -> _T | None: ... - @overload - def setdefault(self, key: _KT, default: _VT) -> _VT: ... - # Same as dict.pop, but accepts keyword arguments - @overload - def pop(self, key: _KT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _T) -> _VT | _T: ... - def __eq__(self, value: object, /) -> bool: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, value: dict[_KT, _VT], /) -> Self: ... - @overload - def __or__(self, value: dict[_T1, _T2], /) -> OrderedDict[_KT | _T1, _VT | _T2]: ... - @overload - def __ror__(self, value: dict[_KT, _VT], /) -> Self: ... - @overload - def __ror__(self, value: dict[_T1, _T2], /) -> OrderedDict[_KT | _T1, _VT | _T2]: ... # type: ignore[misc] - -class defaultdict(dict[_KT, _VT]): - default_factory: Callable[[], _VT] | None - @overload - def __init__(self) -> None: ... - @overload - def __init__(self: defaultdict[str, _VT], **kwargs: _VT) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] #11780 - @overload - def __init__(self, default_factory: Callable[[], _VT] | None, /) -> None: ... - @overload - def __init__( - self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - default_factory: Callable[[], _VT] | None, - /, - **kwargs: _VT, - ) -> None: ... - @overload - def __init__(self, default_factory: Callable[[], _VT] | None, map: SupportsKeysAndGetItem[_KT, _VT], /) -> None: ... - @overload - def __init__( - self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - default_factory: Callable[[], _VT] | None, - map: SupportsKeysAndGetItem[str, _VT], - /, - **kwargs: _VT, - ) -> None: ... - @overload - def __init__(self, default_factory: Callable[[], _VT] | None, iterable: Iterable[tuple[_KT, _VT]], /) -> None: ... - @overload - def __init__( - self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - default_factory: Callable[[], _VT] | None, - iterable: Iterable[tuple[str, _VT]], - /, - **kwargs: _VT, - ) -> None: ... - def __missing__(self, key: _KT, /) -> _VT: ... - def __copy__(self) -> Self: ... - def copy(self) -> Self: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, value: dict[_KT, _VT], /) -> Self: ... - @overload - def __or__(self, value: dict[_T1, _T2], /) -> defaultdict[_KT | _T1, _VT | _T2]: ... - @overload - def __ror__(self, value: dict[_KT, _VT], /) -> Self: ... - @overload - def __ror__(self, value: dict[_T1, _T2], /) -> defaultdict[_KT | _T1, _VT | _T2]: ... # type: ignore[misc] - -class ChainMap(MutableMapping[_KT, _VT]): - maps: list[MutableMapping[_KT, _VT]] - def __init__(self, *maps: MutableMapping[_KT, _VT]) -> None: ... - def new_child(self, m: MutableMapping[_KT, _VT] | None = None) -> Self: ... - @property - def parents(self) -> Self: ... - def __setitem__(self, key: _KT, value: _VT) -> None: ... - def __delitem__(self, key: _KT) -> None: ... - def __getitem__(self, key: _KT) -> _VT: ... - def __iter__(self) -> Iterator[_KT]: ... - def __len__(self) -> int: ... - def __contains__(self, key: object) -> bool: ... - @overload - def get(self, key: _KT, default: None = None) -> _VT | None: ... - @overload - def get(self, key: _KT, default: _T) -> _VT | _T: ... - def __missing__(self, key: _KT) -> _VT: ... # undocumented - def __bool__(self) -> bool: ... - # Keep ChainMap.setdefault in line with MutableMapping.setdefault, modulo positional-only differences. - @overload - def setdefault(self: ChainMap[_KT, _T | None], key: _KT, default: None = None) -> _T | None: ... - @overload - def setdefault(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _T) -> _VT | _T: ... - def copy(self) -> Self: ... - __copy__ = copy - # All arguments to `fromkeys` are passed to `dict.fromkeys` at runtime, - # so the signature should be kept in line with `dict.fromkeys`. - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T]) -> ChainMap[_T, Any | None]: ... - @classmethod - @overload - # Special-case None: the user probably wants to add non-None values later. - def fromkeys(cls, iterable: Iterable[_T], value: None, /) -> ChainMap[_T, Any | None]: ... - @classmethod - @overload - def fromkeys(cls, iterable: Iterable[_T], value: _S, /) -> ChainMap[_T, _S]: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, other: Mapping[_KT, _VT]) -> Self: ... - @overload - def __or__(self, other: Mapping[_T1, _T2]) -> ChainMap[_KT | _T1, _VT | _T2]: ... - @overload - def __ror__(self, other: Mapping[_KT, _VT]) -> Self: ... - @overload - def __ror__(self, other: Mapping[_T1, _T2]) -> ChainMap[_KT | _T1, _VT | _T2]: ... - # ChainMap.__ior__ should be kept roughly in line with MutableMapping.update() - @overload # type: ignore[misc] - def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... - @overload - def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi deleted file mode 100644 index 68fd0bc5acb43..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi +++ /dev/null @@ -1,51 +0,0 @@ -import sys - -from ._base import ( - ALL_COMPLETED as ALL_COMPLETED, - FIRST_COMPLETED as FIRST_COMPLETED, - FIRST_EXCEPTION as FIRST_EXCEPTION, - BrokenExecutor as BrokenExecutor, - CancelledError as CancelledError, - Executor as Executor, - Future as Future, - InvalidStateError as InvalidStateError, - TimeoutError as TimeoutError, - as_completed as as_completed, - wait as wait, -) -from .process import ProcessPoolExecutor as ProcessPoolExecutor -from .thread import ThreadPoolExecutor as ThreadPoolExecutor - -if sys.version_info >= (3, 13): - __all__ = ( - "FIRST_COMPLETED", - "FIRST_EXCEPTION", - "ALL_COMPLETED", - "CancelledError", - "TimeoutError", - "InvalidStateError", - "BrokenExecutor", - "Future", - "Executor", - "wait", - "as_completed", - "ProcessPoolExecutor", - "ThreadPoolExecutor", - ) -else: - __all__ = ( - "FIRST_COMPLETED", - "FIRST_EXCEPTION", - "ALL_COMPLETED", - "CancelledError", - "TimeoutError", - "BrokenExecutor", - "Future", - "Executor", - "wait", - "as_completed", - "ProcessPoolExecutor", - "ThreadPoolExecutor", - ) - -def __dir__() -> tuple[str, ...]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi deleted file mode 100644 index 0c019457902b0..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi +++ /dev/null @@ -1,126 +0,0 @@ -import sys -import threading -from _typeshed import Unused -from collections.abc import Callable, Collection, Iterable, Iterator -from logging import Logger -from types import TracebackType -from typing import Any, Final, Generic, NamedTuple, Protocol, TypeVar -from typing_extensions import ParamSpec, Self - -if sys.version_info >= (3, 9): - from types import GenericAlias - -FIRST_COMPLETED: Final = "FIRST_COMPLETED" -FIRST_EXCEPTION: Final = "FIRST_EXCEPTION" -ALL_COMPLETED: Final = "ALL_COMPLETED" -PENDING: Final = "PENDING" -RUNNING: Final = "RUNNING" -CANCELLED: Final = "CANCELLED" -CANCELLED_AND_NOTIFIED: Final = "CANCELLED_AND_NOTIFIED" -FINISHED: Final = "FINISHED" -_FUTURE_STATES: list[str] -_STATE_TO_DESCRIPTION_MAP: dict[str, str] -LOGGER: Logger - -class Error(Exception): ... -class CancelledError(Error): ... - -if sys.version_info >= (3, 11): - from builtins import TimeoutError as TimeoutError -else: - class TimeoutError(Error): ... - -class InvalidStateError(Error): ... -class BrokenExecutor(RuntimeError): ... - -_T = TypeVar("_T") -_T_co = TypeVar("_T_co", covariant=True) -_P = ParamSpec("_P") - -class Future(Generic[_T]): - _condition: threading.Condition - _state: str - _result: _T | None - _exception: BaseException | None - _waiters: list[_Waiter] - def cancel(self) -> bool: ... - def cancelled(self) -> bool: ... - def running(self) -> bool: ... - def done(self) -> bool: ... - def add_done_callback(self, fn: Callable[[Future[_T]], object]) -> None: ... - def result(self, timeout: float | None = None) -> _T: ... - def set_running_or_notify_cancel(self) -> bool: ... - def set_result(self, result: _T) -> None: ... - def exception(self, timeout: float | None = None) -> BaseException | None: ... - def set_exception(self, exception: BaseException | None) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class Executor: - if sys.version_info >= (3, 9): - def submit(self, fn: Callable[_P, _T], /, *args: _P.args, **kwargs: _P.kwargs) -> Future[_T]: ... - else: - def submit(self, fn: Callable[_P, _T], *args: _P.args, **kwargs: _P.kwargs) -> Future[_T]: ... - - def map( - self, fn: Callable[..., _T], *iterables: Iterable[Any], timeout: float | None = None, chunksize: int = 1 - ) -> Iterator[_T]: ... - if sys.version_info >= (3, 9): - def shutdown(self, wait: bool = True, *, cancel_futures: bool = False) -> None: ... - else: - def shutdown(self, wait: bool = True) -> None: ... - - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> bool | None: ... - -class _AsCompletedFuture(Protocol[_T_co]): - # as_completed only mutates non-generic aspects of passed Futures and does not do any nominal - # checks. Therefore, we can use a Protocol here to allow as_completed to act covariantly. - # See the tests for concurrent.futures - _condition: threading.Condition - _state: str - _waiters: list[_Waiter] - # Not used by as_completed, but needed to propagate the generic type - def result(self, timeout: float | None = None) -> _T_co: ... - -def as_completed(fs: Iterable[_AsCompletedFuture[_T]], timeout: float | None = None) -> Iterator[Future[_T]]: ... - -class DoneAndNotDoneFutures(NamedTuple, Generic[_T]): - done: set[Future[_T]] - not_done: set[Future[_T]] - -if sys.version_info >= (3, 9): - def wait( - fs: Iterable[Future[_T]], timeout: float | None = None, return_when: str = "ALL_COMPLETED" - ) -> DoneAndNotDoneFutures[_T]: ... - -else: - def wait( - fs: Collection[Future[_T]], timeout: float | None = None, return_when: str = "ALL_COMPLETED" - ) -> DoneAndNotDoneFutures[_T]: ... - -class _Waiter: - event: threading.Event - finished_futures: list[Future[Any]] - def add_result(self, future: Future[Any]) -> None: ... - def add_exception(self, future: Future[Any]) -> None: ... - def add_cancelled(self, future: Future[Any]) -> None: ... - -class _AsCompletedWaiter(_Waiter): - lock: threading.Lock - -class _FirstCompletedWaiter(_Waiter): ... - -class _AllCompletedWaiter(_Waiter): - num_pending_calls: int - stop_on_exception: bool - lock: threading.Lock - def __init__(self, num_pending_calls: int, stop_on_exception: bool) -> None: ... - -class _AcquireFutures: - futures: Iterable[Future[Any]] - def __init__(self, futures: Iterable[Future[Any]]) -> None: ... - def __enter__(self) -> None: ... - def __exit__(self, *args: Unused) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi deleted file mode 100644 index d1b7858eae026..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi +++ /dev/null @@ -1,80 +0,0 @@ -import queue -import sys -from collections.abc import Callable, Iterable, Mapping, Set as AbstractSet -from threading import Lock, Semaphore, Thread -from typing import Any, Generic, TypeVar, overload -from typing_extensions import TypeVarTuple, Unpack -from weakref import ref - -from ._base import BrokenExecutor, Executor, Future - -_Ts = TypeVarTuple("_Ts") - -_threads_queues: Mapping[Any, Any] -_shutdown: bool -_global_shutdown_lock: Lock - -def _python_exit() -> None: ... - -if sys.version_info >= (3, 9): - from types import GenericAlias - -_S = TypeVar("_S") - -class _WorkItem(Generic[_S]): - future: Future[_S] - fn: Callable[..., _S] - args: Iterable[Any] - kwargs: Mapping[str, Any] - def __init__(self, future: Future[_S], fn: Callable[..., _S], args: Iterable[Any], kwargs: Mapping[str, Any]) -> None: ... - def run(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -def _worker( - executor_reference: ref[Any], - work_queue: queue.SimpleQueue[Any], - initializer: Callable[[Unpack[_Ts]], object], - initargs: tuple[Unpack[_Ts]], -) -> None: ... - -class BrokenThreadPool(BrokenExecutor): ... - -class ThreadPoolExecutor(Executor): - _max_workers: int - _idle_semaphore: Semaphore - _threads: AbstractSet[Thread] - _broken: bool - _shutdown: bool - _shutdown_lock: Lock - _thread_name_prefix: str | None - _initializer: Callable[..., None] | None - _initargs: tuple[Any, ...] - _work_queue: queue.SimpleQueue[_WorkItem[Any]] - @overload - def __init__( - self, - max_workers: int | None = None, - thread_name_prefix: str = "", - initializer: Callable[[], object] | None = None, - initargs: tuple[()] = (), - ) -> None: ... - @overload - def __init__( - self, - max_workers: int | None = None, - thread_name_prefix: str = "", - *, - initializer: Callable[[Unpack[_Ts]], object], - initargs: tuple[Unpack[_Ts]], - ) -> None: ... - @overload - def __init__( - self, - max_workers: int | None, - thread_name_prefix: str, - initializer: Callable[[Unpack[_Ts]], object], - initargs: tuple[Unpack[_Ts]], - ) -> None: ... - def _adjust_thread_count(self) -> None: ... - def _initializer_failed(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/configparser.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/configparser.pyi deleted file mode 100644 index ee5000196e0e7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/configparser.pyi +++ /dev/null @@ -1,404 +0,0 @@ -import sys -from _typeshed import StrOrBytesPath, SupportsWrite -from collections.abc import Callable, ItemsView, Iterable, Iterator, Mapping, MutableMapping, Sequence -from re import Pattern -from typing import Any, ClassVar, Final, Literal, TypeVar, overload -from typing_extensions import TypeAlias - -if sys.version_info >= (3, 13): - __all__ = ( - "NoSectionError", - "DuplicateOptionError", - "DuplicateSectionError", - "NoOptionError", - "InterpolationError", - "InterpolationDepthError", - "InterpolationMissingOptionError", - "InterpolationSyntaxError", - "ParsingError", - "MissingSectionHeaderError", - "ConfigParser", - "RawConfigParser", - "Interpolation", - "BasicInterpolation", - "ExtendedInterpolation", - "SectionProxy", - "ConverterMapping", - "DEFAULTSECT", - "MAX_INTERPOLATION_DEPTH", - "UNNAMED_SECTION", - "MultilineContinuationError", - ) -elif sys.version_info >= (3, 12): - __all__ = ( - "NoSectionError", - "DuplicateOptionError", - "DuplicateSectionError", - "NoOptionError", - "InterpolationError", - "InterpolationDepthError", - "InterpolationMissingOptionError", - "InterpolationSyntaxError", - "ParsingError", - "MissingSectionHeaderError", - "ConfigParser", - "RawConfigParser", - "Interpolation", - "BasicInterpolation", - "ExtendedInterpolation", - "LegacyInterpolation", - "SectionProxy", - "ConverterMapping", - "DEFAULTSECT", - "MAX_INTERPOLATION_DEPTH", - ) -else: - __all__ = [ - "NoSectionError", - "DuplicateOptionError", - "DuplicateSectionError", - "NoOptionError", - "InterpolationError", - "InterpolationDepthError", - "InterpolationMissingOptionError", - "InterpolationSyntaxError", - "ParsingError", - "MissingSectionHeaderError", - "ConfigParser", - "SafeConfigParser", - "RawConfigParser", - "Interpolation", - "BasicInterpolation", - "ExtendedInterpolation", - "LegacyInterpolation", - "SectionProxy", - "ConverterMapping", - "DEFAULTSECT", - "MAX_INTERPOLATION_DEPTH", - ] - -_Section: TypeAlias = Mapping[str, str] -_Parser: TypeAlias = MutableMapping[str, _Section] -_ConverterCallback: TypeAlias = Callable[[str], Any] -_ConvertersMap: TypeAlias = dict[str, _ConverterCallback] -_T = TypeVar("_T") - -DEFAULTSECT: Final = "DEFAULT" -MAX_INTERPOLATION_DEPTH: Final = 10 - -class Interpolation: - def before_get(self, parser: _Parser, section: str, option: str, value: str, defaults: _Section) -> str: ... - def before_set(self, parser: _Parser, section: str, option: str, value: str) -> str: ... - def before_read(self, parser: _Parser, section: str, option: str, value: str) -> str: ... - def before_write(self, parser: _Parser, section: str, option: str, value: str) -> str: ... - -class BasicInterpolation(Interpolation): ... -class ExtendedInterpolation(Interpolation): ... - -if sys.version_info < (3, 13): - class LegacyInterpolation(Interpolation): - def before_get(self, parser: _Parser, section: str, option: str, value: str, vars: _Section) -> str: ... - -class RawConfigParser(_Parser): - _SECT_TMPL: ClassVar[str] # undocumented - _OPT_TMPL: ClassVar[str] # undocumented - _OPT_NV_TMPL: ClassVar[str] # undocumented - - SECTCRE: Pattern[str] - OPTCRE: ClassVar[Pattern[str]] - OPTCRE_NV: ClassVar[Pattern[str]] # undocumented - NONSPACECRE: ClassVar[Pattern[str]] # undocumented - - BOOLEAN_STATES: ClassVar[Mapping[str, bool]] # undocumented - default_section: str - if sys.version_info >= (3, 13): - @overload - def __init__( - self, - defaults: Mapping[str, str | None] | None = None, - dict_type: type[Mapping[str, str]] = ..., - *, - allow_no_value: Literal[True], - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - allow_unnamed_section: bool = False, - ) -> None: ... - @overload - def __init__( - self, - defaults: Mapping[str, str | None] | None, - dict_type: type[Mapping[str, str]], - allow_no_value: Literal[True], - *, - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - allow_unnamed_section: bool = False, - ) -> None: ... - @overload - def __init__( - self, - defaults: _Section | None = None, - dict_type: type[Mapping[str, str]] = ..., - allow_no_value: bool = False, - *, - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - allow_unnamed_section: bool = False, - ) -> None: ... - else: - @overload - def __init__( - self, - defaults: Mapping[str, str | None] | None = None, - dict_type: type[Mapping[str, str]] = ..., - *, - allow_no_value: Literal[True], - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - ) -> None: ... - @overload - def __init__( - self, - defaults: Mapping[str, str | None] | None, - dict_type: type[Mapping[str, str]], - allow_no_value: Literal[True], - *, - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - ) -> None: ... - @overload - def __init__( - self, - defaults: _Section | None = None, - dict_type: type[Mapping[str, str]] = ..., - allow_no_value: bool = False, - *, - delimiters: Sequence[str] = ("=", ":"), - comment_prefixes: Sequence[str] = ("#", ";"), - inline_comment_prefixes: Sequence[str] | None = None, - strict: bool = True, - empty_lines_in_values: bool = True, - default_section: str = "DEFAULT", - interpolation: Interpolation | None = ..., - converters: _ConvertersMap = ..., - ) -> None: ... - - def __len__(self) -> int: ... - def __getitem__(self, key: str) -> SectionProxy: ... - def __setitem__(self, key: str, value: _Section) -> None: ... - def __delitem__(self, key: str) -> None: ... - def __iter__(self) -> Iterator[str]: ... - def __contains__(self, key: object) -> bool: ... - def defaults(self) -> _Section: ... - def sections(self) -> list[str]: ... - def add_section(self, section: str) -> None: ... - def has_section(self, section: str) -> bool: ... - def options(self, section: str) -> list[str]: ... - def has_option(self, section: str, option: str) -> bool: ... - def read(self, filenames: StrOrBytesPath | Iterable[StrOrBytesPath], encoding: str | None = None) -> list[str]: ... - def read_file(self, f: Iterable[str], source: str | None = None) -> None: ... - def read_string(self, string: str, source: str = "<string>") -> None: ... - def read_dict(self, dictionary: Mapping[str, Mapping[str, Any]], source: str = "<dict>") -> None: ... - if sys.version_info < (3, 12): - def readfp(self, fp: Iterable[str], filename: str | None = None) -> None: ... - # These get* methods are partially applied (with the same names) in - # SectionProxy; the stubs should be kept updated together - @overload - def getint(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None) -> int: ... - @overload - def getint( - self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... - ) -> int | _T: ... - @overload - def getfloat(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None) -> float: ... - @overload - def getfloat( - self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... - ) -> float | _T: ... - @overload - def getboolean(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None) -> bool: ... - @overload - def getboolean( - self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... - ) -> bool | _T: ... - def _get_conv( - self, - section: str, - option: str, - conv: Callable[[str], _T], - *, - raw: bool = False, - vars: _Section | None = None, - fallback: _T = ..., - ) -> _T: ... - # This is incompatible with MutableMapping so we ignore the type - @overload # type: ignore[override] - def get(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None) -> str | Any: ... - @overload - def get( - self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T - ) -> str | _T | Any: ... - @overload - def items(self, *, raw: bool = False, vars: _Section | None = None) -> ItemsView[str, SectionProxy]: ... - @overload - def items(self, section: str, raw: bool = False, vars: _Section | None = None) -> list[tuple[str, str]]: ... - def set(self, section: str, option: str, value: str | None = None) -> None: ... - def write(self, fp: SupportsWrite[str], space_around_delimiters: bool = True) -> None: ... - def remove_option(self, section: str, option: str) -> bool: ... - def remove_section(self, section: str) -> bool: ... - def optionxform(self, optionstr: str) -> str: ... - -class ConfigParser(RawConfigParser): - # This is incompatible with MutableMapping so we ignore the type - @overload # type: ignore[override] - def get(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None) -> str: ... - @overload - def get(self, section: str, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T) -> str | _T: ... - -if sys.version_info < (3, 12): - class SafeConfigParser(ConfigParser): ... # deprecated alias - -class SectionProxy(MutableMapping[str, str]): - def __init__(self, parser: RawConfigParser, name: str) -> None: ... - def __getitem__(self, key: str) -> str: ... - def __setitem__(self, key: str, value: str) -> None: ... - def __delitem__(self, key: str) -> None: ... - def __contains__(self, key: object) -> bool: ... - def __len__(self) -> int: ... - def __iter__(self) -> Iterator[str]: ... - @property - def parser(self) -> RawConfigParser: ... - @property - def name(self) -> str: ... - def get( # type: ignore[override] - self, - option: str, - fallback: str | None = None, - *, - raw: bool = False, - vars: _Section | None = None, - _impl: Any | None = None, - **kwargs: Any, - ) -> str | Any: ... # can be None in RawConfigParser's sections - # These are partially-applied version of the methods with the same names in - # RawConfigParser; the stubs should be kept updated together - @overload - def getint(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> int: ... - @overload - def getint(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> int | _T: ... - @overload - def getfloat(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> float: ... - @overload - def getfloat(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> float | _T: ... - @overload - def getboolean(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> bool: ... - @overload - def getboolean(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> bool | _T: ... - # SectionProxy can have arbitrary attributes when custom converters are used - def __getattr__(self, key: str) -> Callable[..., Any]: ... - -class ConverterMapping(MutableMapping[str, _ConverterCallback | None]): - GETTERCRE: ClassVar[Pattern[Any]] - def __init__(self, parser: RawConfigParser) -> None: ... - def __getitem__(self, key: str) -> _ConverterCallback: ... - def __setitem__(self, key: str, value: _ConverterCallback | None) -> None: ... - def __delitem__(self, key: str) -> None: ... - def __iter__(self) -> Iterator[str]: ... - def __len__(self) -> int: ... - -class Error(Exception): - message: str - def __init__(self, msg: str = "") -> None: ... - -class NoSectionError(Error): - section: str - def __init__(self, section: str) -> None: ... - -class DuplicateSectionError(Error): - section: str - source: str | None - lineno: int | None - def __init__(self, section: str, source: str | None = None, lineno: int | None = None) -> None: ... - -class DuplicateOptionError(Error): - section: str - option: str - source: str | None - lineno: int | None - def __init__(self, section: str, option: str, source: str | None = None, lineno: int | None = None) -> None: ... - -class NoOptionError(Error): - section: str - option: str - def __init__(self, option: str, section: str) -> None: ... - -class InterpolationError(Error): - section: str - option: str - def __init__(self, option: str, section: str, msg: str) -> None: ... - -class InterpolationDepthError(InterpolationError): - def __init__(self, option: str, section: str, rawval: object) -> None: ... - -class InterpolationMissingOptionError(InterpolationError): - reference: str - def __init__(self, option: str, section: str, rawval: object, reference: str) -> None: ... - -class InterpolationSyntaxError(InterpolationError): ... - -class ParsingError(Error): - source: str - errors: list[tuple[int, str]] - if sys.version_info >= (3, 13): - def __init__(self, source: str, *args: object) -> None: ... - def combine(self, others: Iterable[ParsingError]) -> ParsingError: ... - elif sys.version_info >= (3, 12): - def __init__(self, source: str) -> None: ... - else: - def __init__(self, source: str | None = None, filename: str | None = None) -> None: ... - - def append(self, lineno: int, line: str) -> None: ... - -class MissingSectionHeaderError(ParsingError): - lineno: int - line: str - def __init__(self, filename: str, lineno: int, line: str) -> None: ... - -if sys.version_info >= (3, 13): - class _UNNAMED_SECTION: ... - UNNAMED_SECTION: _UNNAMED_SECTION - - class MultilineContinuationError(ParsingError): - lineno: int - line: str - def __init__(self, filename: str, lineno: int, line: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/contextvars.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/contextvars.pyi deleted file mode 100644 index dd5ea0acbe2c0..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/contextvars.pyi +++ /dev/null @@ -1,63 +0,0 @@ -import sys -from collections.abc import Callable, Iterator, Mapping -from typing import Any, ClassVar, Generic, TypeVar, final, overload -from typing_extensions import ParamSpec - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = ("Context", "ContextVar", "Token", "copy_context") - -_T = TypeVar("_T") -_D = TypeVar("_D") -_P = ParamSpec("_P") - -@final -class ContextVar(Generic[_T]): - @overload - def __init__(self, name: str) -> None: ... - @overload - def __init__(self, name: str, *, default: _T) -> None: ... - def __hash__(self) -> int: ... - @property - def name(self) -> str: ... - @overload - def get(self) -> _T: ... - @overload - def get(self, default: _T, /) -> _T: ... - @overload - def get(self, default: _D, /) -> _D | _T: ... - def set(self, value: _T, /) -> Token[_T]: ... - def reset(self, token: Token[_T], /) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -@final -class Token(Generic[_T]): - @property - def var(self) -> ContextVar[_T]: ... - @property - def old_value(self) -> Any: ... # returns either _T or MISSING, but that's hard to express - MISSING: ClassVar[object] - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -def copy_context() -> Context: ... - -# It doesn't make sense to make this generic, because for most Contexts each ContextVar will have -# a different value. -@final -class Context(Mapping[ContextVar[Any], Any]): - def __init__(self) -> None: ... - @overload - def get(self, key: ContextVar[_T], default: None = None, /) -> _T | None: ... - @overload - def get(self, key: ContextVar[_T], default: _T, /) -> _T: ... - @overload - def get(self, key: ContextVar[_T], default: _D, /) -> _T | _D: ... - def run(self, callable: Callable[_P, _T], *args: _P.args, **kwargs: _P.kwargs) -> _T: ... - def copy(self) -> Context: ... - def __getitem__(self, key: ContextVar[_T], /) -> _T: ... - def __iter__(self) -> Iterator[ContextVar[Any]]: ... - def __len__(self) -> int: ... - def __eq__(self, value: object, /) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/crypt.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/crypt.pyi deleted file mode 100644 index 2940038592861..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/crypt.pyi +++ /dev/null @@ -1,13 +0,0 @@ -import sys -from typing import Final - -if sys.platform != "win32": - class _Method: ... - METHOD_CRYPT: Final[_Method] - METHOD_MD5: Final[_Method] - METHOD_SHA256: Final[_Method] - METHOD_SHA512: Final[_Method] - METHOD_BLOWFISH: Final[_Method] - methods: list[_Method] - def mksalt(method: _Method | None = None, *, rounds: int | None = None) -> str: ... - def crypt(word: str, salt: str | _Method | None = None) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi deleted file mode 100644 index 40a073d107c76..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi +++ /dev/null @@ -1,192 +0,0 @@ -import sys -from _ctypes import ( - POINTER as POINTER, - RTLD_GLOBAL as RTLD_GLOBAL, - RTLD_LOCAL as RTLD_LOCAL, - Array as Array, - CFuncPtr as _CFuncPtr, - Structure as Structure, - Union as Union, - _CanCastTo as _CanCastTo, - _CArgObject as _CArgObject, - _CData as _CData, - _CDataMeta as _CDataMeta, - _CField as _CField, - _Pointer as _Pointer, - _PointerLike as _PointerLike, - _SimpleCData as _SimpleCData, - _StructUnionBase as _StructUnionBase, - _StructUnionMeta as _StructUnionMeta, - addressof as addressof, - alignment as alignment, - byref as byref, - get_errno as get_errno, - pointer as pointer, - resize as resize, - set_errno as set_errno, - sizeof as sizeof, -) -from ctypes._endian import BigEndianStructure as BigEndianStructure, LittleEndianStructure as LittleEndianStructure -from typing import Any, ClassVar, Generic, TypeVar -from typing_extensions import TypeAlias - -if sys.platform == "win32": - from _ctypes import FormatError as FormatError, get_last_error as get_last_error, set_last_error as set_last_error - -if sys.version_info >= (3, 11): - from ctypes._endian import BigEndianUnion as BigEndianUnion, LittleEndianUnion as LittleEndianUnion - -if sys.version_info >= (3, 9): - from types import GenericAlias - -_T = TypeVar("_T") -_DLLT = TypeVar("_DLLT", bound=CDLL) - -DEFAULT_MODE: int - -class ArgumentError(Exception): ... - -class CDLL: - _func_flags_: ClassVar[int] - _func_restype_: ClassVar[_CData] - _name: str - _handle: int - _FuncPtr: type[_FuncPointer] - def __init__( - self, - name: str | None, - mode: int = ..., - handle: int | None = None, - use_errno: bool = False, - use_last_error: bool = False, - winmode: int | None = None, - ) -> None: ... - def __getattr__(self, name: str) -> _NamedFuncPointer: ... - def __getitem__(self, name_or_ordinal: str) -> _NamedFuncPointer: ... - -if sys.platform == "win32": - class OleDLL(CDLL): ... - class WinDLL(CDLL): ... - -class PyDLL(CDLL): ... - -class LibraryLoader(Generic[_DLLT]): - def __init__(self, dlltype: type[_DLLT]) -> None: ... - def __getattr__(self, name: str) -> _DLLT: ... - def __getitem__(self, name: str) -> _DLLT: ... - def LoadLibrary(self, name: str) -> _DLLT: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -cdll: LibraryLoader[CDLL] -if sys.platform == "win32": - windll: LibraryLoader[WinDLL] - oledll: LibraryLoader[OleDLL] -pydll: LibraryLoader[PyDLL] -pythonapi: PyDLL - -class _FuncPointer(_CFuncPtr): ... - -class _NamedFuncPointer(_FuncPointer): - __name__: str - -def CFUNCTYPE( - restype: type[_CData] | None, *argtypes: type[_CData], use_errno: bool = ..., use_last_error: bool = ... -) -> type[_FuncPointer]: ... - -if sys.platform == "win32": - def WINFUNCTYPE( - restype: type[_CData] | None, *argtypes: type[_CData], use_errno: bool = ..., use_last_error: bool = ... - ) -> type[_FuncPointer]: ... - -def PYFUNCTYPE(restype: type[_CData] | None, *argtypes: type[_CData]) -> type[_FuncPointer]: ... - -# Any type that can be implicitly converted to c_void_p when passed as a C function argument. -# (bytes is not included here, see below.) -_CVoidPLike: TypeAlias = _PointerLike | Array[Any] | _CArgObject | int -# Same as above, but including types known to be read-only (i. e. bytes). -# This distinction is not strictly necessary (ctypes doesn't differentiate between const -# and non-const pointers), but it catches errors like memmove(b'foo', buf, 4) -# when memmove(buf, b'foo', 4) was intended. -_CVoidConstPLike: TypeAlias = _CVoidPLike | bytes - -_CastT = TypeVar("_CastT", bound=_CanCastTo) - -def cast(obj: _CData | _CArgObject | int, typ: type[_CastT]) -> _CastT: ... -def create_string_buffer(init: int | bytes, size: int | None = None) -> Array[c_char]: ... - -c_buffer = create_string_buffer - -def create_unicode_buffer(init: int | str, size: int | None = None) -> Array[c_wchar]: ... - -if sys.platform == "win32": - def DllCanUnloadNow() -> int: ... - def DllGetClassObject(rclsid: Any, riid: Any, ppv: Any) -> int: ... # TODO not documented - def GetLastError() -> int: ... - -def memmove(dst: _CVoidPLike, src: _CVoidConstPLike, count: int) -> int: ... -def memset(dst: _CVoidPLike, c: int, count: int) -> int: ... -def string_at(address: _CVoidConstPLike, size: int = -1) -> bytes: ... - -if sys.platform == "win32": - def WinError(code: int | None = None, descr: str | None = None) -> OSError: ... - -def wstring_at(address: _CVoidConstPLike, size: int = -1) -> str: ... - -class c_byte(_SimpleCData[int]): ... - -class c_char(_SimpleCData[bytes]): - def __init__(self, value: int | bytes | bytearray = ...) -> None: ... - -class c_char_p(_PointerLike, _SimpleCData[bytes | None]): - def __init__(self, value: int | bytes | None = ...) -> None: ... - -class c_double(_SimpleCData[float]): ... -class c_longdouble(_SimpleCData[float]): ... # can be an alias for c_double -class c_float(_SimpleCData[float]): ... -class c_int(_SimpleCData[int]): ... # can be an alias for c_long -class c_long(_SimpleCData[int]): ... -class c_longlong(_SimpleCData[int]): ... # can be an alias for c_long -class c_short(_SimpleCData[int]): ... -class c_size_t(_SimpleCData[int]): ... # alias for c_uint, c_ulong, or c_ulonglong -class c_ssize_t(_SimpleCData[int]): ... # alias for c_int, c_long, or c_longlong -class c_ubyte(_SimpleCData[int]): ... -class c_uint(_SimpleCData[int]): ... # can be an alias for c_ulong -class c_ulong(_SimpleCData[int]): ... -class c_ulonglong(_SimpleCData[int]): ... # can be an alias for c_ulong -class c_ushort(_SimpleCData[int]): ... -class c_void_p(_PointerLike, _SimpleCData[int | None]): ... -class c_wchar(_SimpleCData[str]): ... - -c_int8 = c_byte - -# these are actually dynamic aliases for c_short, c_int, c_long, or c_longlong -class c_int16(_SimpleCData[int]): ... -class c_int32(_SimpleCData[int]): ... -class c_int64(_SimpleCData[int]): ... - -c_uint8 = c_ubyte - -# these are actually dynamic aliases for c_ushort, c_uint, c_ulong, or c_ulonglong -class c_uint16(_SimpleCData[int]): ... -class c_uint32(_SimpleCData[int]): ... -class c_uint64(_SimpleCData[int]): ... - -class c_wchar_p(_PointerLike, _SimpleCData[str | None]): - def __init__(self, value: int | str | None = ...) -> None: ... - -class c_bool(_SimpleCData[bool]): - def __init__(self, value: bool = ...) -> None: ... - -if sys.platform == "win32": - class HRESULT(_SimpleCData[int]): ... # TODO undocumented - -if sys.version_info >= (3, 12): - c_time_t: type[c_int32 | c_int64] # alias for one or the other at runtime - -class py_object(_CanCastTo, _SimpleCData[_T]): ... - -if sys.version_info >= (3, 14): - class c_float_complex(_SimpleCData[complex]): ... - class c_double_complex(_SimpleCData[complex]): ... - class c_longdouble_complex(_SimpleCData[complex]): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/util.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/util.pyi deleted file mode 100644 index c0274f5e539b9..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/util.pyi +++ /dev/null @@ -1,6 +0,0 @@ -import sys - -def find_library(name: str) -> str | None: ... - -if sys.platform == "win32": - def find_msvcrt() -> str | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/__init__.pyi deleted file mode 100644 index 939cec0cede91..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/__init__.pyi +++ /dev/null @@ -1,27 +0,0 @@ -from _curses import * -from _curses import window as window -from collections.abc import Callable -from typing import TypeVar -from typing_extensions import Concatenate, ParamSpec - -# NOTE: The _curses module is ordinarily only available on Unix, but the -# windows-curses package makes it available on Windows as well with the same -# contents. - -_T = TypeVar("_T") -_P = ParamSpec("_P") - -# available after calling `curses.initscr()` -LINES: int -COLS: int - -# available after calling `curses.start_color()` -COLORS: int -COLOR_PAIRS: int - -def wrapper(func: Callable[Concatenate[window, _P], _T], /, *arg: _P.args, **kwds: _P.kwargs) -> _T: ... - -# typeshed used the name _CursesWindow for the underlying C class before -# it was mapped to the name 'window' in 3.8. -# Kept here as a legacy alias in case any third-party code is relying on it. -_CursesWindow = window diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/panel.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/panel.pyi deleted file mode 100644 index d94f76635d8f7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/panel.pyi +++ /dev/null @@ -1,22 +0,0 @@ -from _curses import window - -version: str - -class _Curses_Panel: # type is <class '_curses_panel.curses panel'> (note the space in the class name) - def above(self) -> _Curses_Panel: ... - def below(self) -> _Curses_Panel: ... - def bottom(self) -> None: ... - def hidden(self) -> bool: ... - def hide(self) -> None: ... - def move(self, y: int, x: int) -> None: ... - def replace(self, win: window) -> None: ... - def set_userptr(self, obj: object) -> None: ... - def show(self) -> None: ... - def top(self) -> None: ... - def userptr(self) -> object: ... - def window(self) -> window: ... - -def bottom_panel() -> _Curses_Panel: ... -def new_panel(win: window, /) -> _Curses_Panel: ... -def top_panel() -> _Curses_Panel: ... -def update_panels() -> _Curses_Panel: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dataclasses.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/dataclasses.pyi deleted file mode 100644 index 3295b1c1f8356..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/dataclasses.pyi +++ /dev/null @@ -1,316 +0,0 @@ -import enum -import sys -import types -from _typeshed import DataclassInstance -from builtins import type as Type # alias to avoid name clashes with fields named "type" -from collections.abc import Callable, Iterable, Mapping -from typing import Any, Generic, Literal, Protocol, TypeVar, overload -from typing_extensions import Never, TypeAlias, TypeIs - -if sys.version_info >= (3, 9): - from types import GenericAlias - -_T = TypeVar("_T") -_T_co = TypeVar("_T_co", covariant=True) - -__all__ = [ - "dataclass", - "field", - "Field", - "FrozenInstanceError", - "InitVar", - "MISSING", - "fields", - "asdict", - "astuple", - "make_dataclass", - "replace", - "is_dataclass", -] - -if sys.version_info >= (3, 10): - __all__ += ["KW_ONLY"] - -_DataclassT = TypeVar("_DataclassT", bound=DataclassInstance) - -# define _MISSING_TYPE as an enum within the type stubs, -# even though that is not really its type at runtime -# this allows us to use Literal[_MISSING_TYPE.MISSING] -# for background, see: -# https://github.com/python/typeshed/pull/5900#issuecomment-895513797 -class _MISSING_TYPE(enum.Enum): - MISSING = enum.auto() - -MISSING = _MISSING_TYPE.MISSING - -if sys.version_info >= (3, 10): - class KW_ONLY: ... - -@overload -def asdict(obj: DataclassInstance) -> dict[str, Any]: ... -@overload -def asdict(obj: DataclassInstance, *, dict_factory: Callable[[list[tuple[str, Any]]], _T]) -> _T: ... -@overload -def astuple(obj: DataclassInstance) -> tuple[Any, ...]: ... -@overload -def astuple(obj: DataclassInstance, *, tuple_factory: Callable[[list[Any]], _T]) -> _T: ... -@overload -def dataclass(cls: None, /) -> Callable[[type[_T]], type[_T]]: ... -@overload -def dataclass(cls: type[_T], /) -> type[_T]: ... - -if sys.version_info >= (3, 11): - @overload - def dataclass( - *, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - match_args: bool = True, - kw_only: bool = False, - slots: bool = False, - weakref_slot: bool = False, - ) -> Callable[[type[_T]], type[_T]]: ... - -elif sys.version_info >= (3, 10): - @overload - def dataclass( - *, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - match_args: bool = True, - kw_only: bool = False, - slots: bool = False, - ) -> Callable[[type[_T]], type[_T]]: ... - -else: - @overload - def dataclass( - *, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - ) -> Callable[[type[_T]], type[_T]]: ... - -# See https://github.com/python/mypy/issues/10750 -class _DefaultFactory(Protocol[_T_co]): - def __call__(self) -> _T_co: ... - -class Field(Generic[_T]): - name: str - type: Type[_T] | str | Any - default: _T | Literal[_MISSING_TYPE.MISSING] - default_factory: _DefaultFactory[_T] | Literal[_MISSING_TYPE.MISSING] - repr: bool - hash: bool | None - init: bool - compare: bool - metadata: types.MappingProxyType[Any, Any] - if sys.version_info >= (3, 10): - kw_only: bool | Literal[_MISSING_TYPE.MISSING] - def __init__( - self, - default: _T, - default_factory: Callable[[], _T], - init: bool, - repr: bool, - hash: bool | None, - compare: bool, - metadata: Mapping[Any, Any], - kw_only: bool, - ) -> None: ... - else: - def __init__( - self, - default: _T, - default_factory: Callable[[], _T], - init: bool, - repr: bool, - hash: bool | None, - compare: bool, - metadata: Mapping[Any, Any], - ) -> None: ... - - def __set_name__(self, owner: Type[Any], name: str) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -# NOTE: Actual return type is 'Field[_T]', but we want to help type checkers -# to understand the magic that happens at runtime. -if sys.version_info >= (3, 10): - @overload # `default` and `default_factory` are optional and mutually exclusive. - def field( - *, - default: _T, - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - kw_only: bool = ..., - ) -> _T: ... - @overload - def field( - *, - default_factory: Callable[[], _T], - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - kw_only: bool = ..., - ) -> _T: ... - @overload - def field( - *, - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - kw_only: bool = ..., - ) -> Any: ... - -else: - @overload # `default` and `default_factory` are optional and mutually exclusive. - def field( - *, - default: _T, - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - ) -> _T: ... - @overload - def field( - *, - default_factory: Callable[[], _T], - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - ) -> _T: ... - @overload - def field( - *, - init: bool = True, - repr: bool = True, - hash: bool | None = None, - compare: bool = True, - metadata: Mapping[Any, Any] | None = None, - ) -> Any: ... - -def fields(class_or_instance: DataclassInstance | type[DataclassInstance]) -> tuple[Field[Any], ...]: ... - -# HACK: `obj: Never` typing matches if object argument is using `Any` type. -@overload -def is_dataclass(obj: Never) -> TypeIs[DataclassInstance | type[DataclassInstance]]: ... # type: ignore[narrowed-type-not-subtype] # pyright: ignore[reportGeneralTypeIssues] -@overload -def is_dataclass(obj: type) -> TypeIs[type[DataclassInstance]]: ... -@overload -def is_dataclass(obj: object) -> TypeIs[DataclassInstance | type[DataclassInstance]]: ... - -class FrozenInstanceError(AttributeError): ... - -if sys.version_info >= (3, 9): - _InitVarMeta: TypeAlias = type -else: - class _InitVarMeta(type): - # Not used, instead `InitVar.__class_getitem__` is called. - # pyright (not unreasonably) thinks this is an invalid use of InitVar. - def __getitem__(self, params: Any) -> InitVar[Any]: ... # pyright: ignore[reportInvalidTypeForm] - -class InitVar(Generic[_T], metaclass=_InitVarMeta): - type: Type[_T] - def __init__(self, type: Type[_T]) -> None: ... - if sys.version_info >= (3, 9): - @overload - def __class_getitem__(cls, type: Type[_T]) -> InitVar[_T]: ... # pyright: ignore[reportInvalidTypeForm] - @overload - def __class_getitem__(cls, type: Any) -> InitVar[Any]: ... # pyright: ignore[reportInvalidTypeForm] - -if sys.version_info >= (3, 12): - def make_dataclass( - cls_name: str, - fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], - *, - bases: tuple[type, ...] = (), - namespace: dict[str, Any] | None = None, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - match_args: bool = True, - kw_only: bool = False, - slots: bool = False, - weakref_slot: bool = False, - module: str | None = None, - ) -> type: ... - -elif sys.version_info >= (3, 11): - def make_dataclass( - cls_name: str, - fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], - *, - bases: tuple[type, ...] = (), - namespace: dict[str, Any] | None = None, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - match_args: bool = True, - kw_only: bool = False, - slots: bool = False, - weakref_slot: bool = False, - ) -> type: ... - -elif sys.version_info >= (3, 10): - def make_dataclass( - cls_name: str, - fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], - *, - bases: tuple[type, ...] = (), - namespace: dict[str, Any] | None = None, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - match_args: bool = True, - kw_only: bool = False, - slots: bool = False, - ) -> type: ... - -else: - def make_dataclass( - cls_name: str, - fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], - *, - bases: tuple[type, ...] = (), - namespace: dict[str, Any] | None = None, - init: bool = True, - repr: bool = True, - eq: bool = True, - order: bool = False, - unsafe_hash: bool = False, - frozen: bool = False, - ) -> type: ... - -def replace(obj: _DataclassT, /, **changes: Any) -> _DataclassT: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi deleted file mode 100644 index f414763e02a67..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi +++ /dev/null @@ -1,102 +0,0 @@ -import sys -from _typeshed import StrOrBytesPath -from collections.abc import Iterator, MutableMapping -from types import TracebackType -from typing import Literal -from typing_extensions import Self, TypeAlias - -__all__ = ["open", "whichdb", "error"] - -_KeyType: TypeAlias = str | bytes -_ValueType: TypeAlias = str | bytes | bytearray -_TFlags: TypeAlias = Literal[ - "r", - "w", - "c", - "n", - "rf", - "wf", - "cf", - "nf", - "rs", - "ws", - "cs", - "ns", - "ru", - "wu", - "cu", - "nu", - "rfs", - "wfs", - "cfs", - "nfs", - "rfu", - "wfu", - "cfu", - "nfu", - "rsf", - "wsf", - "csf", - "nsf", - "rsu", - "wsu", - "csu", - "nsu", - "ruf", - "wuf", - "cuf", - "nuf", - "rus", - "wus", - "cus", - "nus", - "rfsu", - "wfsu", - "cfsu", - "nfsu", - "rfus", - "wfus", - "cfus", - "nfus", - "rsfu", - "wsfu", - "csfu", - "nsfu", - "rsuf", - "wsuf", - "csuf", - "nsuf", - "rufs", - "wufs", - "cufs", - "nufs", - "rusf", - "wusf", - "cusf", - "nusf", -] - -class _Database(MutableMapping[_KeyType, bytes]): - def close(self) -> None: ... - def __getitem__(self, key: _KeyType) -> bytes: ... - def __setitem__(self, key: _KeyType, value: _ValueType) -> None: ... - def __delitem__(self, key: _KeyType) -> None: ... - def __iter__(self) -> Iterator[bytes]: ... - def __len__(self) -> int: ... - def __del__(self) -> None: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - -class _error(Exception): ... - -error: tuple[type[_error], type[OSError]] - -if sys.version_info >= (3, 11): - def whichdb(filename: StrOrBytesPath) -> str | None: ... - def open(file: StrOrBytesPath, flag: _TFlags = "r", mode: int = 0o666) -> _Database: ... - -else: - def whichdb(filename: str) -> str | None: ... - def open(file: str, flag: _TFlags = "r", mode: int = 0o666) -> _Database: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi deleted file mode 100644 index 4113a7e3ffb9b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi +++ /dev/null @@ -1,43 +0,0 @@ -import sys -from _typeshed import ReadOnlyBuffer, StrOrBytesPath -from types import TracebackType -from typing import TypeVar, overload -from typing_extensions import Self, TypeAlias - -if sys.platform != "win32": - _T = TypeVar("_T") - _KeyType: TypeAlias = str | ReadOnlyBuffer - _ValueType: TypeAlias = str | ReadOnlyBuffer - - class error(OSError): ... - library: str - - # Actual typename dbm, not exposed by the implementation - class _dbm: - def close(self) -> None: ... - if sys.version_info >= (3, 13): - def clear(self) -> None: ... - - def __getitem__(self, item: _KeyType) -> bytes: ... - def __setitem__(self, key: _KeyType, value: _ValueType) -> None: ... - def __delitem__(self, key: _KeyType) -> None: ... - def __len__(self) -> int: ... - def __del__(self) -> None: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - @overload - def get(self, k: _KeyType) -> bytes | None: ... - @overload - def get(self, k: _KeyType, default: _T) -> bytes | _T: ... - def keys(self) -> list[bytes]: ... - def setdefault(self, k: _KeyType, default: _ValueType = ...) -> bytes: ... - # Don't exist at runtime - __new__: None # type: ignore[assignment] - __init__: None # type: ignore[assignment] - - if sys.version_info >= (3, 11): - def open(filename: StrOrBytesPath, flags: str = "r", mode: int = 0o666, /) -> _dbm: ... - else: - def open(filename: str, flags: str = "r", mode: int = 0o666, /) -> _dbm: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi deleted file mode 100644 index 19997882dd537..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi +++ /dev/null @@ -1,21 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class bdist_dumb(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - default_format: ClassVar[dict[str, str]] - bdist_dir: Any - plat_name: Any - format: Any - keep_temp: int - dist_dir: Any - skip_build: Any - relative: int - owner: Any - group: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi deleted file mode 100644 index d0eac1a3be5bb..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi +++ /dev/null @@ -1,45 +0,0 @@ -import sys -from typing import Any, ClassVar, Literal - -from ..cmd import Command - -if sys.platform == "win32": - from msilib import Dialog - - class PyDialog(Dialog): - def __init__(self, *args, **kw) -> None: ... - def title(self, title) -> None: ... - def back(self, title, next, name: str = "Back", active: bool | Literal[0, 1] = 1): ... - def cancel(self, title, next, name: str = "Cancel", active: bool | Literal[0, 1] = 1): ... - def next(self, title, next, name: str = "Next", active: bool | Literal[0, 1] = 1): ... - def xbutton(self, name, title, next, xpos): ... - - class bdist_msi(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - all_versions: Any - other_version: str - if sys.version_info >= (3, 9): - def __init__(self, *args, **kw) -> None: ... - bdist_dir: Any - plat_name: Any - keep_temp: int - no_target_compile: int - no_target_optimize: int - target_version: Any - dist_dir: Any - skip_build: Any - install_script: Any - pre_install_script: Any - versions: Any - def initialize_options(self) -> None: ... - install_script_key: Any - def finalize_options(self) -> None: ... - db: Any - def run(self) -> None: ... - def add_files(self) -> None: ... - def add_find_python(self) -> None: ... - def add_scripts(self) -> None: ... - def add_ui(self) -> None: ... - def get_installer_filename(self, fullname): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi deleted file mode 100644 index 89c43e1b974cd..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi +++ /dev/null @@ -1,52 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class bdist_rpm(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - negative_opt: ClassVar[dict[str, str]] - bdist_base: Any - rpm_base: Any - dist_dir: Any - python: Any - fix_python: Any - spec_only: Any - binary_only: Any - source_only: Any - use_bzip2: Any - distribution_name: Any - group: Any - release: Any - serial: Any - vendor: Any - packager: Any - doc_files: Any - changelog: Any - icon: Any - prep_script: Any - build_script: Any - install_script: Any - clean_script: Any - verify_script: Any - pre_install: Any - post_install: Any - pre_uninstall: Any - post_uninstall: Any - prep: Any - provides: Any - requires: Any - conflicts: Any - build_requires: Any - obsoletes: Any - keep_temp: int - use_rpm_opt_flags: int - rpm3_mode: int - no_autoreq: int - force_arch: Any - quiet: int - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def finalize_package_data(self) -> None: ... - def run(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi deleted file mode 100644 index 78ba6b7042dc1..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi +++ /dev/null @@ -1,34 +0,0 @@ -from _typeshed import Unused -from collections.abc import Callable -from typing import Any, ClassVar - -from ..cmd import Command - -def show_compilers() -> None: ... - -class build(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] - build_base: str - build_purelib: Any - build_platlib: Any - build_lib: Any - build_temp: Any - build_scripts: Any - compiler: Any - plat_name: Any - debug: Any - force: int - executable: Any - parallel: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def has_pure_modules(self): ... - def has_c_libraries(self): ... - def has_ext_modules(self): ... - def has_scripts(self): ... - # Any to work around variance issues - sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi deleted file mode 100644 index 1f66e2efc20c7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi +++ /dev/null @@ -1,29 +0,0 @@ -from _typeshed import Unused -from collections.abc import Callable -from typing import Any, ClassVar - -from ..cmd import Command - -def show_compilers() -> None: ... - -class build_clib(Command): - description: str - user_options: ClassVar[list[tuple[str, str, str]]] - boolean_options: ClassVar[list[str]] - help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] - build_clib: Any - build_temp: Any - libraries: Any - include_dirs: Any - define: Any - undef: Any - debug: Any - force: int - compiler: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def check_library_list(self, libraries) -> None: ... - def get_library_names(self): ... - def get_source_files(self): ... - def build_libraries(self, libraries) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi deleted file mode 100644 index a0813c314021d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi +++ /dev/null @@ -1,52 +0,0 @@ -from _typeshed import Unused -from collections.abc import Callable -from typing import Any, ClassVar - -from ..cmd import Command - -extension_name_re: Any - -def show_compilers() -> None: ... - -class build_ext(Command): - description: str - sep_by: Any - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] - extensions: Any - build_lib: Any - plat_name: Any - build_temp: Any - inplace: int - package: Any - include_dirs: Any - define: Any - undef: Any - libraries: Any - library_dirs: Any - rpath: Any - link_objects: Any - debug: Any - force: Any - compiler: Any - swig: Any - swig_cpp: Any - swig_opts: Any - user: Any - parallel: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def check_extensions_list(self, extensions) -> None: ... - def get_source_files(self): ... - def get_outputs(self): ... - def build_extensions(self) -> None: ... - def build_extension(self, ext) -> None: ... - def swig_sources(self, sources, extension): ... - def find_swig(self): ... - def get_ext_fullpath(self, ext_name: str) -> str: ... - def get_ext_fullname(self, ext_name: str) -> str: ... - def get_ext_filename(self, ext_name: str) -> str: ... - def get_export_symbols(self, ext): ... - def get_libraries(self, ext): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi deleted file mode 100644 index 7871bb8a57197..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi +++ /dev/null @@ -1,24 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command -from ..util import Mixin2to3 as Mixin2to3 - -first_line_re: Any - -class build_scripts(Command): - description: str - user_options: ClassVar[list[tuple[str, str, str]]] - boolean_options: ClassVar[list[str]] - build_dir: Any - scripts: Any - force: Any - executable: Any - outfiles: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def get_source_files(self): ... - def run(self) -> None: ... - def copy_scripts(self): ... - -class build_scripts_2to3(build_scripts, Mixin2to3): - def copy_scripts(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi deleted file mode 100644 index 55f0a0eeaf10b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class clean(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - build_base: Any - build_lib: Any - build_temp: Any - build_scripts: Any - bdist_base: Any - all: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi deleted file mode 100644 index b0910091d5b6d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi +++ /dev/null @@ -1,84 +0,0 @@ -from _typeshed import StrOrBytesPath -from collections.abc import Sequence -from re import Pattern -from typing import Any, ClassVar, Final, Literal - -from ..ccompiler import CCompiler -from ..cmd import Command - -LANG_EXT: Final[dict[str, str]] - -class config(Command): - description: str - # Tuple is full name, short name, description - user_options: ClassVar[list[tuple[str, str | None, str]]] - compiler: str | CCompiler - cc: str | None - include_dirs: Sequence[str] | None - libraries: Sequence[str] | None - library_dirs: Sequence[str] | None - noisy: int - dump_source: int - temp_files: Sequence[str] - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def try_cpp( - self, - body: str | None = None, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - lang: str = "c", - ) -> bool: ... - def search_cpp( - self, - pattern: Pattern[str] | str, - body: str | None = None, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - lang: str = "c", - ) -> bool: ... - def try_compile( - self, body: str, headers: Sequence[str] | None = None, include_dirs: Sequence[str] | None = None, lang: str = "c" - ) -> bool: ... - def try_link( - self, - body: str, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - libraries: Sequence[str] | None = None, - library_dirs: Sequence[str] | None = None, - lang: str = "c", - ) -> bool: ... - def try_run( - self, - body: str, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - libraries: Sequence[str] | None = None, - library_dirs: Sequence[str] | None = None, - lang: str = "c", - ) -> bool: ... - def check_func( - self, - func: str, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - libraries: Sequence[str] | None = None, - library_dirs: Sequence[str] | None = None, - decl: bool | Literal[0, 1] = 0, - call: bool | Literal[0, 1] = 0, - ) -> bool: ... - def check_lib( - self, - library: str, - library_dirs: Sequence[str] | None = None, - headers: Sequence[str] | None = None, - include_dirs: Sequence[str] | None = None, - other_libraries: list[str] = [], - ) -> bool: ... - def check_header( - self, header: str, include_dirs: Sequence[str] | None = None, library_dirs: Sequence[str] | None = None, lang: str = "c" - ) -> bool: ... - -def dump_file(filename: StrOrBytesPath, head: Any | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi deleted file mode 100644 index 24a4eff2fb10f..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi +++ /dev/null @@ -1,70 +0,0 @@ -import sys -from collections.abc import Callable -from typing import Any, ClassVar, Final, Literal - -from ..cmd import Command - -HAS_USER_SITE: Final[bool] - -SCHEME_KEYS: Final[tuple[Literal["purelib"], Literal["platlib"], Literal["headers"], Literal["scripts"], Literal["data"]]] -INSTALL_SCHEMES: Final[dict[str, dict[str, str]]] - -if sys.version_info < (3, 10): - WINDOWS_SCHEME: Final[dict[str, str]] - -class install(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - negative_opt: ClassVar[dict[str, str]] - prefix: str | None - exec_prefix: Any - home: str | None - user: bool - install_base: Any - install_platbase: Any - root: str | None - install_purelib: Any - install_platlib: Any - install_headers: Any - install_lib: str | None - install_scripts: Any - install_data: Any - install_userbase: Any - install_usersite: Any - compile: Any - optimize: Any - extra_path: Any - install_path_file: int - force: int - skip_build: int - warn_dir: int - build_base: Any - build_lib: Any - record: Any - def initialize_options(self) -> None: ... - config_vars: Any - install_libbase: Any - def finalize_options(self) -> None: ... - def dump_dirs(self, msg) -> None: ... - def finalize_unix(self) -> None: ... - def finalize_other(self) -> None: ... - def select_scheme(self, name) -> None: ... - def expand_basedirs(self) -> None: ... - def expand_dirs(self) -> None: ... - def convert_paths(self, *names) -> None: ... - path_file: Any - extra_dirs: Any - def handle_extra_path(self) -> None: ... - def change_roots(self, *names) -> None: ... - def create_home_path(self) -> None: ... - def run(self) -> None: ... - def create_path_file(self) -> None: ... - def get_outputs(self): ... - def get_inputs(self): ... - def has_lib(self): ... - def has_headers(self): ... - def has_scripts(self): ... - def has_data(self): ... - # Any to work around variance issues - sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi deleted file mode 100644 index 342c7a7ccca4a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi +++ /dev/null @@ -1,19 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class install_data(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - install_dir: Any - outfiles: Any - root: Any - force: int - data_files: Any - warn_dir: int - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def get_inputs(self): ... - def get_outputs(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi deleted file mode 100644 index 3fd54989d14f3..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi +++ /dev/null @@ -1,18 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class install_egg_info(Command): - description: ClassVar[str] - user_options: ClassVar[list[tuple[str, str, str]]] - install_dir: Any - def initialize_options(self) -> None: ... - target: Any - outputs: Any - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def get_outputs(self) -> list[str]: ... - -def safe_name(name): ... -def safe_version(version): ... -def to_filename(name): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi deleted file mode 100644 index 149ecae897817..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi +++ /dev/null @@ -1,25 +0,0 @@ -from typing import Any, ClassVar, Final - -from ..cmd import Command - -PYTHON_SOURCE_EXTENSION: Final = ".py" - -class install_lib(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - negative_opt: ClassVar[dict[str, str]] - install_dir: Any - build_dir: Any - force: int - compile: Any - optimize: Any - skip_build: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def build(self) -> None: ... - def install(self): ... - def byte_compile(self, files) -> None: ... - def get_outputs(self): ... - def get_inputs(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi deleted file mode 100644 index 5ee5589ad33d0..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi +++ /dev/null @@ -1,18 +0,0 @@ -from typing import Any, ClassVar - -from ..cmd import Command - -class install_scripts(Command): - description: str - user_options: ClassVar[list[tuple[str, str | None, str]]] - boolean_options: ClassVar[list[str]] - install_dir: Any - force: int - build_dir: Any - skip_build: Any - def initialize_options(self) -> None: ... - def finalize_options(self) -> None: ... - outfiles: Any - def run(self) -> None: ... - def get_inputs(self): ... - def get_outputs(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi deleted file mode 100644 index e6b77825c5f5b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Any, ClassVar - -from ..config import PyPIRCCommand - -class upload(PyPIRCCommand): - description: ClassVar[str] - username: str - password: str - show_response: int - sign: bool - identity: Any - def initialize_options(self) -> None: ... - repository: Any - realm: Any - def finalize_options(self) -> None: ... - def run(self) -> None: ... - def upload_file(self, command: str, pyversion: str, filename: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi deleted file mode 100644 index c4d37419ed06c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi +++ /dev/null @@ -1,34 +0,0 @@ -from collections.abc import Iterable, Mapping -from re import Pattern -from typing import Any, Final, overload -from typing_extensions import TypeAlias - -_Option: TypeAlias = tuple[str, str | None, str] -_GR: TypeAlias = tuple[list[str], OptionDummy] - -longopt_pat: Final = r"[a-zA-Z](?:[a-zA-Z0-9-]*)" -longopt_re: Final[Pattern[str]] -neg_alias_re: Final[Pattern[str]] -longopt_xlate: Final[dict[int, int]] - -class FancyGetopt: - def __init__(self, option_table: list[_Option] | None = None) -> None: ... - # TODO kinda wrong, `getopt(object=object())` is invalid - @overload - def getopt(self, args: list[str] | None = None) -> _GR: ... - @overload - def getopt(self, args: list[str] | None, object: Any) -> list[str]: ... - def get_option_order(self) -> list[tuple[str, str]]: ... - def generate_help(self, header: str | None = None) -> list[str]: ... - -def fancy_getopt( - options: list[_Option], negative_opt: Mapping[_Option, _Option], object: Any, args: list[str] | None -) -> list[str] | _GR: ... - -WS_TRANS: Final[dict[int, str]] - -def wrap_text(text: str, width: int) -> list[str]: ... -def translate_longopt(opt: str) -> str: ... - -class OptionDummy: - def __init__(self, options: Iterable[str] = []) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi deleted file mode 100644 index 50d89aeb9e5fd..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi +++ /dev/null @@ -1,6 +0,0 @@ -from typing import Literal - -def spawn( - cmd: list[str], search_path: bool | Literal[0, 1] = 1, verbose: bool | Literal[0, 1] = 0, dry_run: bool | Literal[0, 1] = 0 -) -> None: ... -def find_executable(executable: str, path: str | None = None) -> str | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dummy_threading.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/dummy_threading.pyi deleted file mode 100644 index 757cb8d4bd4ce..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/dummy_threading.pyi +++ /dev/null @@ -1,2 +0,0 @@ -from _dummy_threading import * -from _dummy_threading import __all__ as __all__ diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/__init__.pyi deleted file mode 100644 index fca302f5f1a7d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/__init__.pyi +++ /dev/null @@ -1,29 +0,0 @@ -from collections.abc import Callable -from email.message import Message -from email.policy import Policy -from typing import IO -from typing_extensions import TypeAlias - -# Definitions imported by multiple submodules in typeshed -_ParamType: TypeAlias = str | tuple[str | None, str | None, str] # noqa: Y047 -_ParamsType: TypeAlias = str | None | tuple[str, str | None, str] # noqa: Y047 - -def message_from_string(s: str, _class: Callable[[], Message] = ..., *, policy: Policy = ...) -> Message: ... -def message_from_bytes(s: bytes | bytearray, _class: Callable[[], Message] = ..., *, policy: Policy = ...) -> Message: ... -def message_from_file(fp: IO[str], _class: Callable[[], Message] = ..., *, policy: Policy = ...) -> Message: ... -def message_from_binary_file(fp: IO[bytes], _class: Callable[[], Message] = ..., *, policy: Policy = ...) -> Message: ... - -# Names in __all__ with no definition: -# base64mime -# charset -# encoders -# errors -# feedparser -# generator -# header -# iterators -# message -# mime -# parser -# quoprimime -# utils diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/_policybase.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/_policybase.pyi deleted file mode 100644 index 900224eabb3dc..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/_policybase.pyi +++ /dev/null @@ -1,75 +0,0 @@ -from abc import ABCMeta, abstractmethod -from email.errors import MessageDefect -from email.header import Header -from email.message import Message -from typing import Generic, Protocol, TypeVar, type_check_only -from typing_extensions import Self - -_MessageT = TypeVar("_MessageT", bound=Message, default=Message) - -@type_check_only -class _MessageFactory(Protocol[_MessageT]): - def __call__(self, policy: Policy[_MessageT]) -> _MessageT: ... - -# Policy below is the only known direct subclass of _PolicyBase. We therefore -# assume that the __init__ arguments and attributes of _PolicyBase are -# the same as those of Policy. -class _PolicyBase(Generic[_MessageT]): - max_line_length: int | None - linesep: str - cte_type: str - raise_on_defect: bool - mangle_from_: bool - message_factory: _MessageFactory[_MessageT] | None - # Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 - verify_generated_headers: bool - - def __init__( - self, - *, - max_line_length: int | None = 78, - linesep: str = "\n", - cte_type: str = "8bit", - raise_on_defect: bool = False, - mangle_from_: bool = ..., # default depends on sub-class - message_factory: _MessageFactory[_MessageT] | None = None, - # Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 - verify_generated_headers: bool = True, - ) -> None: ... - def clone( - self, - *, - max_line_length: int | None = ..., - linesep: str = ..., - cte_type: str = ..., - raise_on_defect: bool = ..., - mangle_from_: bool = ..., - message_factory: _MessageFactory[_MessageT] | None = ..., - # Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 - verify_generated_headers: bool = ..., - ) -> Self: ... - def __add__(self, other: Policy) -> Self: ... - -class Policy(_PolicyBase[_MessageT], metaclass=ABCMeta): - def handle_defect(self, obj: _MessageT, defect: MessageDefect) -> None: ... - def register_defect(self, obj: _MessageT, defect: MessageDefect) -> None: ... - def header_max_count(self, name: str) -> int | None: ... - @abstractmethod - def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... - @abstractmethod - def header_store_parse(self, name: str, value: str) -> tuple[str, str]: ... - @abstractmethod - def header_fetch_parse(self, name: str, value: str) -> str: ... - @abstractmethod - def fold(self, name: str, value: str) -> str: ... - @abstractmethod - def fold_binary(self, name: str, value: str) -> bytes: ... - -class Compat32(Policy[_MessageT]): - def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... - def header_store_parse(self, name: str, value: str) -> tuple[str, str]: ... - def header_fetch_parse(self, name: str, value: str) -> str | Header: ... # type: ignore[override] - def fold(self, name: str, value: str) -> str: ... - def fold_binary(self, name: str, value: str) -> bytes: ... - -compat32: Compat32[Message] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/message.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/message.pyi deleted file mode 100644 index f04b014431f9d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/message.pyi +++ /dev/null @@ -1,171 +0,0 @@ -from collections.abc import Generator, Iterator, Sequence -from email import _ParamsType, _ParamType -from email.charset import Charset -from email.contentmanager import ContentManager -from email.errors import MessageDefect -from email.policy import Policy -from typing import Any, Generic, Literal, Protocol, TypeVar, overload -from typing_extensions import Self, TypeAlias - -__all__ = ["Message", "EmailMessage"] - -_T = TypeVar("_T") -# Type returned by Policy.header_fetch_parse, often str or Header. -_HeaderT = TypeVar("_HeaderT", default=str) -_HeaderParamT = TypeVar("_HeaderParamT", default=str) -# Represents headers constructed by HeaderRegistry. Those are sub-classes -# of BaseHeader and another header type. -_HeaderRegistryT = TypeVar("_HeaderRegistryT", default=Any) -_HeaderRegistryParamT = TypeVar("_HeaderRegistryParamT", default=Any) - -_PayloadType: TypeAlias = Message | str -_EncodedPayloadType: TypeAlias = Message | bytes -_MultipartPayloadType: TypeAlias = list[_PayloadType] -_CharsetType: TypeAlias = Charset | str | None - -class _SupportsEncodeToPayload(Protocol): - def encode(self, encoding: str, /) -> _PayloadType | _MultipartPayloadType | _SupportsDecodeToPayload: ... - -class _SupportsDecodeToPayload(Protocol): - def decode(self, encoding: str, errors: str, /) -> _PayloadType | _MultipartPayloadType: ... - -class Message(Generic[_HeaderT, _HeaderParamT]): - # The policy attributes and arguments in this class and its subclasses - # would ideally use Policy[Self], but this is not possible. - policy: Policy[Any] # undocumented - preamble: str | None - epilogue: str | None - defects: list[MessageDefect] - def __init__(self, policy: Policy[Any] = ...) -> None: ... - def is_multipart(self) -> bool: ... - def set_unixfrom(self, unixfrom: str) -> None: ... - def get_unixfrom(self) -> str | None: ... - def attach(self, payload: _PayloadType) -> None: ... - # `i: int` without a multipart payload results in an error - # `| Any`: can be None for cleared or unset payload, but annoying to check - @overload # multipart - def get_payload(self, i: int, decode: Literal[True]) -> None: ... - @overload # multipart - def get_payload(self, i: int, decode: Literal[False] = False) -> _PayloadType | Any: ... - @overload # either - def get_payload(self, i: None = None, decode: Literal[False] = False) -> _PayloadType | _MultipartPayloadType | Any: ... - @overload # not multipart - def get_payload(self, i: None = None, *, decode: Literal[True]) -> _EncodedPayloadType | Any: ... - @overload # not multipart, IDEM but w/o kwarg - def get_payload(self, i: None, decode: Literal[True]) -> _EncodedPayloadType | Any: ... - # If `charset=None` and payload supports both `encode` AND `decode`, - # then an invalid payload could be passed, but this is unlikely - # Not[_SupportsEncodeToPayload] - @overload - def set_payload( - self, payload: _SupportsDecodeToPayload | _PayloadType | _MultipartPayloadType, charset: None = None - ) -> None: ... - @overload - def set_payload( - self, - payload: _SupportsEncodeToPayload | _SupportsDecodeToPayload | _PayloadType | _MultipartPayloadType, - charset: Charset | str, - ) -> None: ... - def set_charset(self, charset: _CharsetType) -> None: ... - def get_charset(self) -> _CharsetType: ... - def __len__(self) -> int: ... - def __contains__(self, name: str) -> bool: ... - def __iter__(self) -> Iterator[str]: ... - # Same as `get` with `failobj=None`, but with the expectation that it won't return None in most scenarios - # This is important for protocols using __getitem__, like SupportsKeysAndGetItem - # Morally, the return type should be `AnyOf[_HeaderType, None]`, - # so using "the Any trick" instead. - def __getitem__(self, name: str) -> _HeaderT | Any: ... - def __setitem__(self, name: str, val: _HeaderParamT) -> None: ... - def __delitem__(self, name: str) -> None: ... - def keys(self) -> list[str]: ... - def values(self) -> list[_HeaderT]: ... - def items(self) -> list[tuple[str, _HeaderT]]: ... - @overload - def get(self, name: str, failobj: None = None) -> _HeaderT | None: ... - @overload - def get(self, name: str, failobj: _T) -> _HeaderT | _T: ... - @overload - def get_all(self, name: str, failobj: None = None) -> list[_HeaderT] | None: ... - @overload - def get_all(self, name: str, failobj: _T) -> list[_HeaderT] | _T: ... - def add_header(self, _name: str, _value: str, **_params: _ParamsType) -> None: ... - def replace_header(self, _name: str, _value: _HeaderParamT) -> None: ... - def get_content_type(self) -> str: ... - def get_content_maintype(self) -> str: ... - def get_content_subtype(self) -> str: ... - def get_default_type(self) -> str: ... - def set_default_type(self, ctype: str) -> None: ... - @overload - def get_params( - self, failobj: None = None, header: str = "content-type", unquote: bool = True - ) -> list[tuple[str, str]] | None: ... - @overload - def get_params(self, failobj: _T, header: str = "content-type", unquote: bool = True) -> list[tuple[str, str]] | _T: ... - @overload - def get_param( - self, param: str, failobj: None = None, header: str = "content-type", unquote: bool = True - ) -> _ParamType | None: ... - @overload - def get_param(self, param: str, failobj: _T, header: str = "content-type", unquote: bool = True) -> _ParamType | _T: ... - def del_param(self, param: str, header: str = "content-type", requote: bool = True) -> None: ... - def set_type(self, type: str, header: str = "Content-Type", requote: bool = True) -> None: ... - @overload - def get_filename(self, failobj: None = None) -> str | None: ... - @overload - def get_filename(self, failobj: _T) -> str | _T: ... - @overload - def get_boundary(self, failobj: None = None) -> str | None: ... - @overload - def get_boundary(self, failobj: _T) -> str | _T: ... - def set_boundary(self, boundary: str) -> None: ... - @overload - def get_content_charset(self) -> str | None: ... - @overload - def get_content_charset(self, failobj: _T) -> str | _T: ... - @overload - def get_charsets(self, failobj: None = None) -> list[str | None]: ... - @overload - def get_charsets(self, failobj: _T) -> list[str | _T]: ... - def walk(self) -> Generator[Self, None, None]: ... - def get_content_disposition(self) -> str | None: ... - def as_string(self, unixfrom: bool = False, maxheaderlen: int = 0, policy: Policy[Any] | None = None) -> str: ... - def as_bytes(self, unixfrom: bool = False, policy: Policy[Any] | None = None) -> bytes: ... - def __bytes__(self) -> bytes: ... - def set_param( - self, - param: str, - value: str, - header: str = "Content-Type", - requote: bool = True, - charset: str | None = None, - language: str = "", - replace: bool = False, - ) -> None: ... - # The following two methods are undocumented, but a source code comment states that they are public API - def set_raw(self, name: str, value: _HeaderParamT) -> None: ... - def raw_items(self) -> Iterator[tuple[str, _HeaderT]]: ... - -class MIMEPart(Message[_HeaderRegistryT, _HeaderRegistryParamT]): - def __init__(self, policy: Policy[Any] | None = None) -> None: ... - def get_body(self, preferencelist: Sequence[str] = ("related", "html", "plain")) -> MIMEPart[_HeaderRegistryT] | None: ... - def attach(self, payload: Self) -> None: ... # type: ignore[override] - # The attachments are created via type(self) in the attach method. It's theoretically - # possible to sneak other attachment types into a MIMEPart instance, but could cause - # cause unforseen consequences. - def iter_attachments(self) -> Iterator[Self]: ... - def iter_parts(self) -> Iterator[MIMEPart[_HeaderRegistryT]]: ... - def get_content(self, *args: Any, content_manager: ContentManager | None = None, **kw: Any) -> Any: ... - def set_content(self, *args: Any, content_manager: ContentManager | None = None, **kw: Any) -> None: ... - def make_related(self, boundary: str | None = None) -> None: ... - def make_alternative(self, boundary: str | None = None) -> None: ... - def make_mixed(self, boundary: str | None = None) -> None: ... - def add_related(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... - def add_alternative(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... - def add_attachment(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... - def clear(self) -> None: ... - def clear_content(self) -> None: ... - def as_string(self, unixfrom: bool = False, maxheaderlen: int | None = None, policy: Policy[Any] | None = None) -> str: ... - def is_attachment(self) -> bool: ... - -class EmailMessage(MIMEPart): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/message.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/message.pyi deleted file mode 100644 index 23cf58619ad96..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/message.pyi +++ /dev/null @@ -1,8 +0,0 @@ -from email.message import Message -from email.mime.nonmultipart import MIMENonMultipart -from email.policy import Policy - -__all__ = ["MIMEMessage"] - -class MIMEMessage(MIMENonMultipart): - def __init__(self, _msg: Message, _subtype: str = "rfc822", *, policy: Policy | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi deleted file mode 100644 index 6163810ed94ae..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi +++ /dev/null @@ -1,18 +0,0 @@ -from collections.abc import Sequence -from email import _ParamsType -from email.message import Message -from email.mime.base import MIMEBase -from email.policy import Policy - -__all__ = ["MIMEMultipart"] - -class MIMEMultipart(MIMEBase): - def __init__( - self, - _subtype: str = "mixed", - boundary: str | None = None, - _subparts: Sequence[Message] | None = None, - *, - policy: Policy | None = None, - **_params: _ParamsType, - ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/parser.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/parser.pyi deleted file mode 100644 index a1a57b4eef4b1..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/parser.pyi +++ /dev/null @@ -1,38 +0,0 @@ -from _typeshed import SupportsRead -from collections.abc import Callable -from email.feedparser import BytesFeedParser as BytesFeedParser, FeedParser as FeedParser -from email.message import Message -from email.policy import Policy -from io import _WrappedBuffer -from typing import Generic, TypeVar, overload - -__all__ = ["Parser", "HeaderParser", "BytesParser", "BytesHeaderParser", "FeedParser", "BytesFeedParser"] - -_MessageT = TypeVar("_MessageT", bound=Message, default=Message) - -class Parser(Generic[_MessageT]): - @overload - def __init__(self: Parser[Message[str, str]], _class: None = None, *, policy: Policy[Message[str, str]] = ...) -> None: ... - @overload - def __init__(self, _class: Callable[[], _MessageT], *, policy: Policy[_MessageT] = ...) -> None: ... - def parse(self, fp: SupportsRead[str], headersonly: bool = False) -> _MessageT: ... - def parsestr(self, text: str, headersonly: bool = False) -> _MessageT: ... - -class HeaderParser(Parser[_MessageT]): - def parse(self, fp: SupportsRead[str], headersonly: bool = True) -> _MessageT: ... - def parsestr(self, text: str, headersonly: bool = True) -> _MessageT: ... - -class BytesParser(Generic[_MessageT]): - parser: Parser[_MessageT] - @overload - def __init__( - self: BytesParser[Message[str, str]], _class: None = None, *, policy: Policy[Message[str, str]] = ... - ) -> None: ... - @overload - def __init__(self, _class: Callable[[], _MessageT], *, policy: Policy[_MessageT] = ...) -> None: ... - def parse(self, fp: _WrappedBuffer, headersonly: bool = False) -> _MessageT: ... - def parsebytes(self, text: bytes | bytearray, headersonly: bool = False) -> _MessageT: ... - -class BytesHeaderParser(BytesParser[_MessageT]): - def parse(self, fp: _WrappedBuffer, headersonly: bool = True) -> _MessageT: ... - def parsebytes(self, text: bytes | bytearray, headersonly: bool = True) -> _MessageT: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/policy.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/email/policy.pyi deleted file mode 100644 index 5adf4a8c23905..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/policy.pyi +++ /dev/null @@ -1,56 +0,0 @@ -from collections.abc import Callable -from email._policybase import Compat32 as Compat32, Policy as Policy, _MessageFactory, compat32 as compat32 -from email.contentmanager import ContentManager -from email.message import EmailMessage, Message -from typing import Any, TypeVar, overload - -__all__ = ["Compat32", "compat32", "Policy", "EmailPolicy", "default", "strict", "SMTP", "HTTP"] - -_MessageT = TypeVar("_MessageT", bound=Message, default=Message) - -class EmailPolicy(Policy[_MessageT]): - utf8: bool - refold_source: str - header_factory: Callable[[str, Any], Any] - content_manager: ContentManager - @overload - def __init__( - self: EmailPolicy[EmailMessage], - *, - max_line_length: int | None = ..., - linesep: str = ..., - cte_type: str = ..., - raise_on_defect: bool = ..., - mangle_from_: bool = ..., - message_factory: None = None, - utf8: bool = ..., - refold_source: str = ..., - header_factory: Callable[[str, str], str] = ..., - content_manager: ContentManager = ..., - ) -> None: ... - @overload - def __init__( - self, - *, - max_line_length: int | None = ..., - linesep: str = ..., - cte_type: str = ..., - raise_on_defect: bool = ..., - mangle_from_: bool = ..., - message_factory: _MessageFactory[_MessageT] | None = ..., - utf8: bool = ..., - refold_source: str = ..., - header_factory: Callable[[str, str], str] = ..., - content_manager: ContentManager = ..., - ) -> None: ... - def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... - def header_store_parse(self, name: str, value: Any) -> tuple[str, Any]: ... - def header_fetch_parse(self, name: str, value: str) -> Any: ... - def fold(self, name: str, value: str) -> Any: ... - def fold_binary(self, name: str, value: str) -> bytes: ... - -default: EmailPolicy[EmailMessage] -SMTP: EmailPolicy[EmailMessage] -SMTPUTF8: EmailPolicy[EmailMessage] -HTTP: EmailPolicy[EmailMessage] -strict: EmailPolicy[EmailMessage] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi deleted file mode 100644 index 2e83f0f65a71a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi +++ /dev/null @@ -1,10 +0,0 @@ -from _typeshed import Incomplete -from codecs import CodecInfo - -class CodecRegistryError(LookupError, SystemError): ... - -def normalize_encoding(encoding: str | bytes) -> str: ... -def search_function(encoding: str) -> CodecInfo | None: ... - -# Needed for submodules -def __getattr__(name: str) -> Incomplete: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/fnmatch.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/fnmatch.pyi deleted file mode 100644 index 7051c999c4305..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/fnmatch.pyi +++ /dev/null @@ -1,9 +0,0 @@ -from collections.abc import Iterable -from typing import AnyStr - -__all__ = ["filter", "fnmatch", "fnmatchcase", "translate"] - -def fnmatch(name: AnyStr, pat: AnyStr) -> bool: ... -def fnmatchcase(name: AnyStr, pat: AnyStr) -> bool: ... -def filter(names: Iterable[AnyStr], pat: AnyStr) -> list[AnyStr]: ... -def translate(pat: str) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/functools.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/functools.pyi deleted file mode 100644 index 9957fa8f16349..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/functools.pyi +++ /dev/null @@ -1,213 +0,0 @@ -import sys -import types -from _typeshed import SupportsAllComparisons, SupportsItems -from collections.abc import Callable, Hashable, Iterable, Sequence, Sized -from typing import Any, Generic, Literal, NamedTuple, TypedDict, TypeVar, final, overload -from typing_extensions import ParamSpec, Self, TypeAlias - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = [ - "update_wrapper", - "wraps", - "WRAPPER_ASSIGNMENTS", - "WRAPPER_UPDATES", - "total_ordering", - "cmp_to_key", - "lru_cache", - "reduce", - "partial", - "partialmethod", - "singledispatch", - "cached_property", - "singledispatchmethod", -] - -if sys.version_info >= (3, 9): - __all__ += ["cache"] - -_T = TypeVar("_T") -_T_co = TypeVar("_T_co", covariant=True) -_S = TypeVar("_S") -_PWrapped = ParamSpec("_PWrapped") -_RWrapped = TypeVar("_RWrapped") -_PWrapper = ParamSpec("_PWrapper") -_RWrapper = TypeVar("_RWrapper") - -@overload -def reduce(function: Callable[[_T, _S], _T], sequence: Iterable[_S], initial: _T, /) -> _T: ... -@overload -def reduce(function: Callable[[_T, _T], _T], sequence: Iterable[_T], /) -> _T: ... - -class _CacheInfo(NamedTuple): - hits: int - misses: int - maxsize: int | None - currsize: int - -if sys.version_info >= (3, 9): - class _CacheParameters(TypedDict): - maxsize: int - typed: bool - -@final -class _lru_cache_wrapper(Generic[_T]): - __wrapped__: Callable[..., _T] - def __call__(self, *args: Hashable, **kwargs: Hashable) -> _T: ... - def cache_info(self) -> _CacheInfo: ... - def cache_clear(self) -> None: ... - if sys.version_info >= (3, 9): - def cache_parameters(self) -> _CacheParameters: ... - - def __copy__(self) -> _lru_cache_wrapper[_T]: ... - def __deepcopy__(self, memo: Any, /) -> _lru_cache_wrapper[_T]: ... - -@overload -def lru_cache(maxsize: int | None = 128, typed: bool = False) -> Callable[[Callable[..., _T]], _lru_cache_wrapper[_T]]: ... -@overload -def lru_cache(maxsize: Callable[..., _T], typed: bool = False) -> _lru_cache_wrapper[_T]: ... - -if sys.version_info >= (3, 12): - WRAPPER_ASSIGNMENTS: tuple[ - Literal["__module__"], - Literal["__name__"], - Literal["__qualname__"], - Literal["__doc__"], - Literal["__annotations__"], - Literal["__type_params__"], - ] -else: - WRAPPER_ASSIGNMENTS: tuple[ - Literal["__module__"], Literal["__name__"], Literal["__qualname__"], Literal["__doc__"], Literal["__annotations__"] - ] -WRAPPER_UPDATES: tuple[Literal["__dict__"]] - -class _Wrapped(Generic[_PWrapped, _RWrapped, _PWrapper, _RWrapper]): - __wrapped__: Callable[_PWrapped, _RWrapped] - def __call__(self, *args: _PWrapper.args, **kwargs: _PWrapper.kwargs) -> _RWrapper: ... - # as with ``Callable``, we'll assume that these attributes exist - __name__: str - __qualname__: str - -class _Wrapper(Generic[_PWrapped, _RWrapped]): - def __call__(self, f: Callable[_PWrapper, _RWrapper]) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... - -if sys.version_info >= (3, 12): - def update_wrapper( - wrapper: Callable[_PWrapper, _RWrapper], - wrapped: Callable[_PWrapped, _RWrapped], - assigned: Sequence[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__", "__type_params__"), - updated: Sequence[str] = ("__dict__",), - ) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... - def wraps( - wrapped: Callable[_PWrapped, _RWrapped], - assigned: Sequence[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__", "__type_params__"), - updated: Sequence[str] = ("__dict__",), - ) -> _Wrapper[_PWrapped, _RWrapped]: ... - -else: - def update_wrapper( - wrapper: Callable[_PWrapper, _RWrapper], - wrapped: Callable[_PWrapped, _RWrapped], - assigned: Sequence[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__"), - updated: Sequence[str] = ("__dict__",), - ) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... - def wraps( - wrapped: Callable[_PWrapped, _RWrapped], - assigned: Sequence[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__"), - updated: Sequence[str] = ("__dict__",), - ) -> _Wrapper[_PWrapped, _RWrapped]: ... - -def total_ordering(cls: type[_T]) -> type[_T]: ... -def cmp_to_key(mycmp: Callable[[_T, _T], int]) -> Callable[[_T], SupportsAllComparisons]: ... - -class partial(Generic[_T]): - @property - def func(self) -> Callable[..., _T]: ... - @property - def args(self) -> tuple[Any, ...]: ... - @property - def keywords(self) -> dict[str, Any]: ... - def __new__(cls, func: Callable[..., _T], /, *args: Any, **kwargs: Any) -> Self: ... - def __call__(self, /, *args: Any, **kwargs: Any) -> _T: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -# With protocols, this could change into a generic protocol that defines __get__ and returns _T -_Descriptor: TypeAlias = Any - -class partialmethod(Generic[_T]): - func: Callable[..., _T] | _Descriptor - args: tuple[Any, ...] - keywords: dict[str, Any] - @overload - def __init__(self, func: Callable[..., _T], /, *args: Any, **keywords: Any) -> None: ... - @overload - def __init__(self, func: _Descriptor, /, *args: Any, **keywords: Any) -> None: ... - def __get__(self, obj: Any, cls: type[Any] | None = None) -> Callable[..., _T]: ... - @property - def __isabstractmethod__(self) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class _SingleDispatchCallable(Generic[_T]): - registry: types.MappingProxyType[Any, Callable[..., _T]] - def dispatch(self, cls: Any) -> Callable[..., _T]: ... - # @fun.register(complex) - # def _(arg, verbose=False): ... - @overload - def register(self, cls: type[Any], func: None = None) -> Callable[[Callable[..., _T]], Callable[..., _T]]: ... - # @fun.register - # def _(arg: int, verbose=False): - @overload - def register(self, cls: Callable[..., _T], func: None = None) -> Callable[..., _T]: ... - # fun.register(int, lambda x: x) - @overload - def register(self, cls: type[Any], func: Callable[..., _T]) -> Callable[..., _T]: ... - def _clear_cache(self) -> None: ... - def __call__(self, /, *args: Any, **kwargs: Any) -> _T: ... - -def singledispatch(func: Callable[..., _T]) -> _SingleDispatchCallable[_T]: ... - -class singledispatchmethod(Generic[_T]): - dispatcher: _SingleDispatchCallable[_T] - func: Callable[..., _T] - def __init__(self, func: Callable[..., _T]) -> None: ... - @property - def __isabstractmethod__(self) -> bool: ... - @overload - def register(self, cls: type[Any], method: None = None) -> Callable[[Callable[..., _T]], Callable[..., _T]]: ... - @overload - def register(self, cls: Callable[..., _T], method: None = None) -> Callable[..., _T]: ... - @overload - def register(self, cls: type[Any], method: Callable[..., _T]) -> Callable[..., _T]: ... - def __get__(self, obj: _S, cls: type[_S] | None = None) -> Callable[..., _T]: ... - -class cached_property(Generic[_T_co]): - func: Callable[[Any], _T_co] - attrname: str | None - def __init__(self, func: Callable[[Any], _T_co]) -> None: ... - @overload - def __get__(self, instance: None, owner: type[Any] | None = None) -> Self: ... - @overload - def __get__(self, instance: object, owner: type[Any] | None = None) -> _T_co: ... - def __set_name__(self, owner: type[Any], name: str) -> None: ... - # __set__ is not defined at runtime, but @cached_property is designed to be settable - def __set__(self, instance: object, value: _T_co) -> None: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -if sys.version_info >= (3, 9): - def cache(user_function: Callable[..., _T], /) -> _lru_cache_wrapper[_T]: ... - -def _make_key( - args: tuple[Hashable, ...], - kwds: SupportsItems[Any, Any], - typed: bool, - kwd_mark: tuple[object, ...] = ..., - fasttypes: set[type] = ..., - tuple: type = ..., - type: Any = ..., - len: Callable[[Sized], int] = ..., -) -> Hashable: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/getopt.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/getopt.pyi deleted file mode 100644 index bc9d4da4796b2..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/getopt.pyi +++ /dev/null @@ -1,11 +0,0 @@ -__all__ = ["GetoptError", "error", "getopt", "gnu_getopt"] - -def getopt(args: list[str], shortopts: str, longopts: list[str] = []) -> tuple[list[tuple[str, str]], list[str]]: ... -def gnu_getopt(args: list[str], shortopts: str, longopts: list[str] = []) -> tuple[list[tuple[str, str]], list[str]]: ... - -class GetoptError(Exception): - msg: str - opt: str - def __init__(self, msg: str, opt: str = "") -> None: ... - -error = GetoptError diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/getpass.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/getpass.pyi deleted file mode 100644 index 6104e0dedfee4..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/getpass.pyi +++ /dev/null @@ -1,8 +0,0 @@ -from typing import TextIO - -__all__ = ["getpass", "getuser", "GetPassWarning"] - -def getpass(prompt: str = "Password: ", stream: TextIO | None = None) -> str: ... -def getuser() -> str: ... - -class GetPassWarning(UserWarning): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/hashlib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/hashlib.pyi deleted file mode 100644 index 93bd986c9d314..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/hashlib.pyi +++ /dev/null @@ -1,167 +0,0 @@ -import sys -from _typeshed import ReadableBuffer -from collections.abc import Callable, Set as AbstractSet -from typing import Protocol, final -from typing_extensions import Self - -if sys.version_info >= (3, 11): - __all__ = ( - "md5", - "sha1", - "sha224", - "sha256", - "sha384", - "sha512", - "blake2b", - "blake2s", - "sha3_224", - "sha3_256", - "sha3_384", - "sha3_512", - "shake_128", - "shake_256", - "new", - "algorithms_guaranteed", - "algorithms_available", - "pbkdf2_hmac", - "file_digest", - ) -else: - __all__ = ( - "md5", - "sha1", - "sha224", - "sha256", - "sha384", - "sha512", - "blake2b", - "blake2s", - "sha3_224", - "sha3_256", - "sha3_384", - "sha3_512", - "shake_128", - "shake_256", - "new", - "algorithms_guaranteed", - "algorithms_available", - "pbkdf2_hmac", - ) - -class _Hash: - @property - def digest_size(self) -> int: ... - @property - def block_size(self) -> int: ... - @property - def name(self) -> str: ... - def __init__(self, data: ReadableBuffer = ...) -> None: ... - def copy(self) -> Self: ... - def digest(self) -> bytes: ... - def hexdigest(self) -> str: ... - def update(self, data: ReadableBuffer, /) -> None: ... - -if sys.version_info >= (3, 9): - def new(name: str, data: ReadableBuffer = b"", *, usedforsecurity: bool = ...) -> _Hash: ... - def md5(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - def sha1(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - def sha224(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - def sha256(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - def sha384(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - def sha512(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> _Hash: ... - -else: - def new(name: str, data: ReadableBuffer = b"") -> _Hash: ... - def md5(string: ReadableBuffer = b"") -> _Hash: ... - def sha1(string: ReadableBuffer = b"") -> _Hash: ... - def sha224(string: ReadableBuffer = b"") -> _Hash: ... - def sha256(string: ReadableBuffer = b"") -> _Hash: ... - def sha384(string: ReadableBuffer = b"") -> _Hash: ... - def sha512(string: ReadableBuffer = b"") -> _Hash: ... - -algorithms_guaranteed: AbstractSet[str] -algorithms_available: AbstractSet[str] - -def pbkdf2_hmac( - hash_name: str, password: ReadableBuffer, salt: ReadableBuffer, iterations: int, dklen: int | None = None -) -> bytes: ... - -class _VarLenHash: - digest_size: int - block_size: int - name: str - def __init__(self, data: ReadableBuffer = ...) -> None: ... - def copy(self) -> _VarLenHash: ... - def digest(self, length: int, /) -> bytes: ... - def hexdigest(self, length: int, /) -> str: ... - def update(self, data: ReadableBuffer, /) -> None: ... - -sha3_224 = _Hash -sha3_256 = _Hash -sha3_384 = _Hash -sha3_512 = _Hash -shake_128 = _VarLenHash -shake_256 = _VarLenHash - -def scrypt( - password: ReadableBuffer, *, salt: ReadableBuffer, n: int, r: int, p: int, maxmem: int = 0, dklen: int = 64 -) -> bytes: ... -@final -class _BlakeHash(_Hash): - MAX_DIGEST_SIZE: int - MAX_KEY_SIZE: int - PERSON_SIZE: int - SALT_SIZE: int - - if sys.version_info >= (3, 9): - def __init__( - self, - data: ReadableBuffer = ..., - /, - *, - digest_size: int = ..., - key: ReadableBuffer = ..., - salt: ReadableBuffer = ..., - person: ReadableBuffer = ..., - fanout: int = ..., - depth: int = ..., - leaf_size: int = ..., - node_offset: int = ..., - node_depth: int = ..., - inner_size: int = ..., - last_node: bool = ..., - usedforsecurity: bool = ..., - ) -> None: ... - else: - def __init__( - self, - data: ReadableBuffer = ..., - /, - *, - digest_size: int = ..., - key: ReadableBuffer = ..., - salt: ReadableBuffer = ..., - person: ReadableBuffer = ..., - fanout: int = ..., - depth: int = ..., - leaf_size: int = ..., - node_offset: int = ..., - node_depth: int = ..., - inner_size: int = ..., - last_node: bool = ..., - ) -> None: ... - -blake2b = _BlakeHash -blake2s = _BlakeHash - -if sys.version_info >= (3, 11): - class _BytesIOLike(Protocol): - def getbuffer(self) -> ReadableBuffer: ... - - class _FileDigestFileObj(Protocol): - def readinto(self, buf: bytearray, /) -> int: ... - def readable(self) -> bool: ... - - def file_digest( - fileobj: _BytesIOLike | _FileDigestFileObj, digest: str | Callable[[], _Hash], /, *, _bufsize: int = 262144 - ) -> _Hash: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/http/__init__.pyi deleted file mode 100644 index d455283948d19..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/__init__.pyi +++ /dev/null @@ -1,112 +0,0 @@ -import sys -from enum import IntEnum - -if sys.version_info >= (3, 11): - from enum import StrEnum - -if sys.version_info >= (3, 11): - __all__ = ["HTTPStatus", "HTTPMethod"] -else: - __all__ = ["HTTPStatus"] - -class HTTPStatus(IntEnum): - @property - def phrase(self) -> str: ... - @property - def description(self) -> str: ... - CONTINUE = 100 - SWITCHING_PROTOCOLS = 101 - PROCESSING = 102 - OK = 200 - CREATED = 201 - ACCEPTED = 202 - NON_AUTHORITATIVE_INFORMATION = 203 - NO_CONTENT = 204 - RESET_CONTENT = 205 - PARTIAL_CONTENT = 206 - MULTI_STATUS = 207 - ALREADY_REPORTED = 208 - IM_USED = 226 - MULTIPLE_CHOICES = 300 - MOVED_PERMANENTLY = 301 - FOUND = 302 - SEE_OTHER = 303 - NOT_MODIFIED = 304 - USE_PROXY = 305 - TEMPORARY_REDIRECT = 307 - PERMANENT_REDIRECT = 308 - BAD_REQUEST = 400 - UNAUTHORIZED = 401 - PAYMENT_REQUIRED = 402 - FORBIDDEN = 403 - NOT_FOUND = 404 - METHOD_NOT_ALLOWED = 405 - NOT_ACCEPTABLE = 406 - PROXY_AUTHENTICATION_REQUIRED = 407 - REQUEST_TIMEOUT = 408 - CONFLICT = 409 - GONE = 410 - LENGTH_REQUIRED = 411 - PRECONDITION_FAILED = 412 - if sys.version_info >= (3, 13): - CONTENT_TOO_LARGE = 413 - REQUEST_ENTITY_TOO_LARGE = 413 - if sys.version_info >= (3, 13): - URI_TOO_LONG = 414 - REQUEST_URI_TOO_LONG = 414 - UNSUPPORTED_MEDIA_TYPE = 415 - if sys.version_info >= (3, 13): - RANGE_NOT_SATISFIABLE = 416 - REQUESTED_RANGE_NOT_SATISFIABLE = 416 - EXPECTATION_FAILED = 417 - if sys.version_info >= (3, 13): - UNPROCESSABLE_CONTENT = 422 - UNPROCESSABLE_ENTITY = 422 - LOCKED = 423 - FAILED_DEPENDENCY = 424 - UPGRADE_REQUIRED = 426 - PRECONDITION_REQUIRED = 428 - TOO_MANY_REQUESTS = 429 - REQUEST_HEADER_FIELDS_TOO_LARGE = 431 - INTERNAL_SERVER_ERROR = 500 - NOT_IMPLEMENTED = 501 - BAD_GATEWAY = 502 - SERVICE_UNAVAILABLE = 503 - GATEWAY_TIMEOUT = 504 - HTTP_VERSION_NOT_SUPPORTED = 505 - VARIANT_ALSO_NEGOTIATES = 506 - INSUFFICIENT_STORAGE = 507 - LOOP_DETECTED = 508 - NOT_EXTENDED = 510 - NETWORK_AUTHENTICATION_REQUIRED = 511 - MISDIRECTED_REQUEST = 421 - UNAVAILABLE_FOR_LEGAL_REASONS = 451 - if sys.version_info >= (3, 9): - EARLY_HINTS = 103 - IM_A_TEAPOT = 418 - TOO_EARLY = 425 - if sys.version_info >= (3, 12): - @property - def is_informational(self) -> bool: ... - @property - def is_success(self) -> bool: ... - @property - def is_redirection(self) -> bool: ... - @property - def is_client_error(self) -> bool: ... - @property - def is_server_error(self) -> bool: ... - -if sys.version_info >= (3, 11): - class HTTPMethod(StrEnum): - @property - def description(self) -> str: ... - CONNECT = "CONNECT" - DELETE = "DELETE" - GET = "GET" - HEAD = "HEAD" - OPTIONS = "OPTIONS" - PATCH = "PATCH" - POST = "POST" - PUT = "PUT" - TRACE = "TRACE" diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/client.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/http/client.pyi deleted file mode 100644 index f47c744a6c7d6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/client.pyi +++ /dev/null @@ -1,246 +0,0 @@ -import email.message -import io -import ssl -import sys -import types -from _typeshed import ReadableBuffer, SupportsRead, SupportsReadline, WriteableBuffer -from collections.abc import Callable, Iterable, Iterator, Mapping -from socket import socket -from typing import Any, BinaryIO, TypeVar, overload -from typing_extensions import Self, TypeAlias - -__all__ = [ - "HTTPResponse", - "HTTPConnection", - "HTTPException", - "NotConnected", - "UnknownProtocol", - "UnknownTransferEncoding", - "UnimplementedFileMode", - "IncompleteRead", - "InvalidURL", - "ImproperConnectionState", - "CannotSendRequest", - "CannotSendHeader", - "ResponseNotReady", - "BadStatusLine", - "LineTooLong", - "RemoteDisconnected", - "error", - "responses", - "HTTPSConnection", -] - -_DataType: TypeAlias = SupportsRead[bytes] | Iterable[ReadableBuffer] | ReadableBuffer -_T = TypeVar("_T") -_MessageT = TypeVar("_MessageT", bound=email.message.Message) -_HeaderValue: TypeAlias = ReadableBuffer | str | int - -HTTP_PORT: int -HTTPS_PORT: int - -CONTINUE: int -SWITCHING_PROTOCOLS: int -PROCESSING: int - -OK: int -CREATED: int -ACCEPTED: int -NON_AUTHORITATIVE_INFORMATION: int -NO_CONTENT: int -RESET_CONTENT: int -PARTIAL_CONTENT: int -MULTI_STATUS: int -IM_USED: int - -MULTIPLE_CHOICES: int -MOVED_PERMANENTLY: int -FOUND: int -SEE_OTHER: int -NOT_MODIFIED: int -USE_PROXY: int -TEMPORARY_REDIRECT: int - -BAD_REQUEST: int -UNAUTHORIZED: int -PAYMENT_REQUIRED: int -FORBIDDEN: int -NOT_FOUND: int -METHOD_NOT_ALLOWED: int -NOT_ACCEPTABLE: int -PROXY_AUTHENTICATION_REQUIRED: int -REQUEST_TIMEOUT: int -CONFLICT: int -GONE: int -LENGTH_REQUIRED: int -PRECONDITION_FAILED: int -REQUEST_ENTITY_TOO_LARGE: int -REQUEST_URI_TOO_LONG: int -UNSUPPORTED_MEDIA_TYPE: int -REQUESTED_RANGE_NOT_SATISFIABLE: int -EXPECTATION_FAILED: int -UNPROCESSABLE_ENTITY: int -LOCKED: int -FAILED_DEPENDENCY: int -UPGRADE_REQUIRED: int -PRECONDITION_REQUIRED: int -TOO_MANY_REQUESTS: int -REQUEST_HEADER_FIELDS_TOO_LARGE: int - -INTERNAL_SERVER_ERROR: int -NOT_IMPLEMENTED: int -BAD_GATEWAY: int -SERVICE_UNAVAILABLE: int -GATEWAY_TIMEOUT: int -HTTP_VERSION_NOT_SUPPORTED: int -INSUFFICIENT_STORAGE: int -NOT_EXTENDED: int -NETWORK_AUTHENTICATION_REQUIRED: int - -responses: dict[int, str] - -class HTTPMessage(email.message.Message[str, str]): - def getallmatchingheaders(self, name: str) -> list[str]: ... # undocumented - -@overload -def parse_headers(fp: SupportsReadline[bytes], _class: Callable[[], _MessageT]) -> _MessageT: ... -@overload -def parse_headers(fp: SupportsReadline[bytes]) -> HTTPMessage: ... - -class HTTPResponse(io.BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible method definitions in the base classes - msg: HTTPMessage - headers: HTTPMessage - version: int - debuglevel: int - fp: io.BufferedReader - closed: bool - status: int - reason: str - chunked: bool - chunk_left: int | None - length: int | None - will_close: bool - # url is set on instances of the class in urllib.request.AbstractHTTPHandler.do_open - # to match urllib.response.addinfourl's interface. - # It's not set in HTTPResponse.__init__ or any other method on the class - url: str - def __init__(self, sock: socket, debuglevel: int = 0, method: str | None = None, url: str | None = None) -> None: ... - def peek(self, n: int = -1) -> bytes: ... - def read(self, amt: int | None = None) -> bytes: ... - def read1(self, n: int = -1) -> bytes: ... - def readinto(self, b: WriteableBuffer) -> int: ... - def readline(self, limit: int = -1) -> bytes: ... # type: ignore[override] - @overload - def getheader(self, name: str) -> str | None: ... - @overload - def getheader(self, name: str, default: _T) -> str | _T: ... - def getheaders(self) -> list[tuple[str, str]]: ... - def isclosed(self) -> bool: ... - def __iter__(self) -> Iterator[bytes]: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None - ) -> None: ... - def info(self) -> email.message.Message: ... - def geturl(self) -> str: ... - def getcode(self) -> int: ... - def begin(self) -> None: ... - -class HTTPConnection: - auto_open: int # undocumented - debuglevel: int - default_port: int # undocumented - response_class: type[HTTPResponse] # undocumented - timeout: float | None - host: str - port: int - sock: socket | Any # can be `None` if `.connect()` was not called - def __init__( - self, - host: str, - port: int | None = None, - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - blocksize: int = 8192, - ) -> None: ... - def request( - self, - method: str, - url: str, - body: _DataType | str | None = None, - headers: Mapping[str, _HeaderValue] = {}, - *, - encode_chunked: bool = False, - ) -> None: ... - def getresponse(self) -> HTTPResponse: ... - def set_debuglevel(self, level: int) -> None: ... - if sys.version_info >= (3, 12): - def get_proxy_response_headers(self) -> HTTPMessage | None: ... - - def set_tunnel(self, host: str, port: int | None = None, headers: Mapping[str, str] | None = None) -> None: ... - def connect(self) -> None: ... - def close(self) -> None: ... - def putrequest(self, method: str, url: str, skip_host: bool = False, skip_accept_encoding: bool = False) -> None: ... - def putheader(self, header: str | bytes, *values: _HeaderValue) -> None: ... - def endheaders(self, message_body: _DataType | None = None, *, encode_chunked: bool = False) -> None: ... - def send(self, data: _DataType | str) -> None: ... - -class HTTPSConnection(HTTPConnection): - # Can be `None` if `.connect()` was not called: - sock: ssl.SSLSocket | Any - if sys.version_info >= (3, 12): - def __init__( - self, - host: str, - port: int | None = None, - *, - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - context: ssl.SSLContext | None = None, - blocksize: int = 8192, - ) -> None: ... - else: - def __init__( - self, - host: str, - port: int | None = None, - key_file: str | None = None, - cert_file: str | None = None, - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - *, - context: ssl.SSLContext | None = None, - check_hostname: bool | None = None, - blocksize: int = 8192, - ) -> None: ... - -class HTTPException(Exception): ... - -error = HTTPException - -class NotConnected(HTTPException): ... -class InvalidURL(HTTPException): ... - -class UnknownProtocol(HTTPException): - def __init__(self, version: str) -> None: ... - -class UnknownTransferEncoding(HTTPException): ... -class UnimplementedFileMode(HTTPException): ... - -class IncompleteRead(HTTPException): - def __init__(self, partial: bytes, expected: int | None = None) -> None: ... - partial: bytes - expected: int | None - -class ImproperConnectionState(HTTPException): ... -class CannotSendRequest(ImproperConnectionState): ... -class CannotSendHeader(ImproperConnectionState): ... -class ResponseNotReady(ImproperConnectionState): ... - -class BadStatusLine(HTTPException): - def __init__(self, line: str) -> None: ... - -class LineTooLong(HTTPException): - def __init__(self, line_type: str) -> None: ... - -class RemoteDisconnected(ConnectionResetError, BadStatusLine): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/server.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/http/server.pyi deleted file mode 100644 index 07cde553c1df6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/server.pyi +++ /dev/null @@ -1,83 +0,0 @@ -import _socket -import email.message -import io -import socketserver -import sys -from _typeshed import StrPath, SupportsRead, SupportsWrite -from collections.abc import Mapping, Sequence -from typing import Any, AnyStr, BinaryIO, ClassVar - -__all__ = ["HTTPServer", "ThreadingHTTPServer", "BaseHTTPRequestHandler", "SimpleHTTPRequestHandler", "CGIHTTPRequestHandler"] - -class HTTPServer(socketserver.TCPServer): - server_name: str - server_port: int - -class ThreadingHTTPServer(socketserver.ThreadingMixIn, HTTPServer): ... - -class BaseHTTPRequestHandler(socketserver.StreamRequestHandler): - client_address: tuple[str, int] - close_connection: bool - requestline: str - command: str - path: str - request_version: str - headers: email.message.Message - server_version: str - sys_version: str - error_message_format: str - error_content_type: str - protocol_version: str - MessageClass: type - responses: Mapping[int, tuple[str, str]] - default_request_version: str # undocumented - weekdayname: ClassVar[Sequence[str]] # undocumented - monthname: ClassVar[Sequence[str | None]] # undocumented - def handle_one_request(self) -> None: ... - def handle_expect_100(self) -> bool: ... - def send_error(self, code: int, message: str | None = None, explain: str | None = None) -> None: ... - def send_response(self, code: int, message: str | None = None) -> None: ... - def send_header(self, keyword: str, value: str) -> None: ... - def send_response_only(self, code: int, message: str | None = None) -> None: ... - def end_headers(self) -> None: ... - def flush_headers(self) -> None: ... - def log_request(self, code: int | str = "-", size: int | str = "-") -> None: ... - def log_error(self, format: str, *args: Any) -> None: ... - def log_message(self, format: str, *args: Any) -> None: ... - def version_string(self) -> str: ... - def date_time_string(self, timestamp: float | None = None) -> str: ... - def log_date_time_string(self) -> str: ... - def address_string(self) -> str: ... - def parse_request(self) -> bool: ... # undocumented - -class SimpleHTTPRequestHandler(BaseHTTPRequestHandler): - extensions_map: dict[str, str] - if sys.version_info >= (3, 12): - index_pages: ClassVar[tuple[str, ...]] - directory: str - def __init__( - self, - request: socketserver._RequestType, - client_address: _socket._RetAddress, - server: socketserver.BaseServer, - *, - directory: str | None = None, - ) -> None: ... - def do_GET(self) -> None: ... - def do_HEAD(self) -> None: ... - def send_head(self) -> io.BytesIO | BinaryIO | None: ... # undocumented - def list_directory(self, path: StrPath) -> io.BytesIO | None: ... # undocumented - def translate_path(self, path: str) -> str: ... # undocumented - def copyfile(self, source: SupportsRead[AnyStr], outputfile: SupportsWrite[AnyStr]) -> None: ... # undocumented - def guess_type(self, path: StrPath) -> str: ... # undocumented - -def executable(path: StrPath) -> bool: ... # undocumented - -class CGIHTTPRequestHandler(SimpleHTTPRequestHandler): - cgi_directories: list[str] - have_fork: bool # undocumented - def do_POST(self) -> None: ... - def is_cgi(self) -> bool: ... # undocumented - def is_executable(self, path: StrPath) -> bool: ... # undocumented - def is_python(self, path: StrPath) -> bool: ... # undocumented - def run_cgi(self) -> None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi deleted file mode 100644 index 8506efc01171f..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi +++ /dev/null @@ -1,24 +0,0 @@ -import sys -from collections.abc import Mapping, Sequence -from importlib.abc import Loader -from types import ModuleType - -__all__ = ["__import__", "import_module", "invalidate_caches", "reload"] - -# Signature of `builtins.__import__` should be kept identical to `importlib.__import__` -def __import__( - name: str, - globals: Mapping[str, object] | None = None, - locals: Mapping[str, object] | None = None, - fromlist: Sequence[str] = (), - level: int = 0, -) -> ModuleType: ... - -# `importlib.import_module` return type should be kept the same as `builtins.__import__` -def import_module(name: str, package: str | None = None) -> ModuleType: ... - -if sys.version_info < (3, 12): - def find_loader(name: str, path: str | None = None) -> Loader | None: ... - -def invalidate_caches() -> None: ... -def reload(module: ModuleType) -> ModuleType: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/abc.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/abc.pyi deleted file mode 100644 index 4a0a70d0930da..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/abc.pyi +++ /dev/null @@ -1,172 +0,0 @@ -import _ast -import sys -import types -from _typeshed import ReadableBuffer, StrPath -from abc import ABCMeta, abstractmethod -from collections.abc import Iterator, Mapping, Sequence -from importlib.machinery import ModuleSpec -from io import BufferedReader -from typing import IO, Any, Literal, Protocol, overload, runtime_checkable - -if sys.version_info >= (3, 11): - __all__ = [ - "Loader", - "MetaPathFinder", - "PathEntryFinder", - "ResourceLoader", - "InspectLoader", - "ExecutionLoader", - "FileLoader", - "SourceLoader", - ] - - if sys.version_info < (3, 12): - __all__ += ["Finder", "ResourceReader", "Traversable", "TraversableResources"] - -if sys.version_info >= (3, 10): - from importlib._abc import Loader as Loader -else: - class Loader(metaclass=ABCMeta): - def load_module(self, fullname: str) -> types.ModuleType: ... - def module_repr(self, module: types.ModuleType) -> str: ... - def create_module(self, spec: ModuleSpec) -> types.ModuleType | None: ... - # Not defined on the actual class for backwards-compatibility reasons, - # but expected in new code. - def exec_module(self, module: types.ModuleType) -> None: ... - -if sys.version_info < (3, 12): - class Finder(metaclass=ABCMeta): ... - -class ResourceLoader(Loader): - @abstractmethod - def get_data(self, path: str) -> bytes: ... - -class InspectLoader(Loader): - def is_package(self, fullname: str) -> bool: ... - def get_code(self, fullname: str) -> types.CodeType | None: ... - @abstractmethod - def get_source(self, fullname: str) -> str | None: ... - def exec_module(self, module: types.ModuleType) -> None: ... - @staticmethod - def source_to_code( - data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, path: ReadableBuffer | StrPath = "<string>" - ) -> types.CodeType: ... - -class ExecutionLoader(InspectLoader): - @abstractmethod - def get_filename(self, fullname: str) -> str: ... - -class SourceLoader(ResourceLoader, ExecutionLoader, metaclass=ABCMeta): - def path_mtime(self, path: str) -> float: ... - def set_data(self, path: str, data: bytes) -> None: ... - def get_source(self, fullname: str) -> str | None: ... - def path_stats(self, path: str) -> Mapping[str, Any]: ... - -# The base classes differ starting in 3.10: -if sys.version_info >= (3, 10): - # Please keep in sync with _typeshed.importlib.MetaPathFinderProtocol - class MetaPathFinder(metaclass=ABCMeta): - if sys.version_info < (3, 12): - def find_module(self, fullname: str, path: Sequence[str] | None) -> Loader | None: ... - - def invalidate_caches(self) -> None: ... - # Not defined on the actual class, but expected to exist. - def find_spec( - self, fullname: str, path: Sequence[str] | None, target: types.ModuleType | None = ..., / - ) -> ModuleSpec | None: ... - - class PathEntryFinder(metaclass=ABCMeta): - if sys.version_info < (3, 12): - def find_module(self, fullname: str) -> Loader | None: ... - def find_loader(self, fullname: str) -> tuple[Loader | None, Sequence[str]]: ... - - def invalidate_caches(self) -> None: ... - # Not defined on the actual class, but expected to exist. - def find_spec(self, fullname: str, target: types.ModuleType | None = ...) -> ModuleSpec | None: ... - -else: - # Please keep in sync with _typeshed.importlib.MetaPathFinderProtocol - class MetaPathFinder(Finder): - def find_module(self, fullname: str, path: Sequence[str] | None) -> Loader | None: ... - def invalidate_caches(self) -> None: ... - # Not defined on the actual class, but expected to exist. - def find_spec( - self, fullname: str, path: Sequence[str] | None, target: types.ModuleType | None = ..., / - ) -> ModuleSpec | None: ... - - class PathEntryFinder(Finder): - def find_module(self, fullname: str) -> Loader | None: ... - def find_loader(self, fullname: str) -> tuple[Loader | None, Sequence[str]]: ... - def invalidate_caches(self) -> None: ... - # Not defined on the actual class, but expected to exist. - def find_spec(self, fullname: str, target: types.ModuleType | None = ...) -> ModuleSpec | None: ... - -class FileLoader(ResourceLoader, ExecutionLoader, metaclass=ABCMeta): - name: str - path: str - def __init__(self, fullname: str, path: str) -> None: ... - def get_data(self, path: str) -> bytes: ... - def get_filename(self, name: str | None = None) -> str: ... - def load_module(self, name: str | None = None) -> types.ModuleType: ... - -class ResourceReader(metaclass=ABCMeta): - @abstractmethod - def open_resource(self, resource: str) -> IO[bytes]: ... - @abstractmethod - def resource_path(self, resource: str) -> str: ... - if sys.version_info >= (3, 10): - @abstractmethod - def is_resource(self, path: str) -> bool: ... - else: - @abstractmethod - def is_resource(self, name: str) -> bool: ... - - @abstractmethod - def contents(self) -> Iterator[str]: ... - -if sys.version_info >= (3, 9): - @runtime_checkable - class Traversable(Protocol): - @abstractmethod - def is_dir(self) -> bool: ... - @abstractmethod - def is_file(self) -> bool: ... - @abstractmethod - def iterdir(self) -> Iterator[Traversable]: ... - if sys.version_info >= (3, 11): - @abstractmethod - def joinpath(self, *descendants: str) -> Traversable: ... - else: - @abstractmethod - def joinpath(self, child: str, /) -> Traversable: ... - - # The documentation and runtime protocol allows *args, **kwargs arguments, - # but this would mean that all implementers would have to support them, - # which is not the case. - @overload - @abstractmethod - def open(self, mode: Literal["r"] = "r", *, encoding: str | None = None, errors: str | None = None) -> IO[str]: ... - @overload - @abstractmethod - def open(self, mode: Literal["rb"]) -> IO[bytes]: ... - @property - @abstractmethod - def name(self) -> str: ... - if sys.version_info >= (3, 10): - def __truediv__(self, child: str, /) -> Traversable: ... - else: - @abstractmethod - def __truediv__(self, child: str, /) -> Traversable: ... - - @abstractmethod - def read_bytes(self) -> bytes: ... - @abstractmethod - def read_text(self, encoding: str | None = None) -> str: ... - - class TraversableResources(ResourceReader): - @abstractmethod - def files(self) -> Traversable: ... - def open_resource(self, resource: str) -> BufferedReader: ... - def resource_path(self, resource: Any) -> str: ... - def is_resource(self, path: str) -> bool: ... - def contents(self) -> Iterator[str]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi deleted file mode 100644 index 586c2b80ab7bd..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi +++ /dev/null @@ -1,179 +0,0 @@ -import importlib.abc -import sys -import types -from _typeshed import ReadableBuffer -from collections.abc import Callable, Iterable, MutableSequence, Sequence -from importlib.metadata import DistributionFinder, PathDistribution -from typing import Any, Literal -from typing_extensions import deprecated - -class ModuleSpec: - def __init__( - self, - name: str, - loader: importlib.abc.Loader | None, - *, - origin: str | None = None, - loader_state: Any = None, - is_package: bool | None = None, - ) -> None: ... - name: str - loader: importlib.abc.Loader | None - origin: str | None - submodule_search_locations: list[str] | None - loader_state: Any - cached: str | None - @property - def parent(self) -> str | None: ... - has_location: bool - def __eq__(self, other: object) -> bool: ... - -class BuiltinImporter(importlib.abc.MetaPathFinder, importlib.abc.InspectLoader): - # MetaPathFinder - if sys.version_info < (3, 12): - @classmethod - def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... - - @classmethod - def find_spec( - cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None - ) -> ModuleSpec | None: ... - # InspectLoader - @classmethod - def is_package(cls, fullname: str) -> bool: ... - @classmethod - def load_module(cls, fullname: str) -> types.ModuleType: ... - @classmethod - def get_code(cls, fullname: str) -> None: ... - @classmethod - def get_source(cls, fullname: str) -> None: ... - # Loader - if sys.version_info < (3, 12): - @staticmethod - def module_repr(module: types.ModuleType) -> str: ... - if sys.version_info >= (3, 10): - @staticmethod - def create_module(spec: ModuleSpec) -> types.ModuleType | None: ... - @staticmethod - def exec_module(module: types.ModuleType) -> None: ... - else: - @classmethod - def create_module(cls, spec: ModuleSpec) -> types.ModuleType | None: ... - @classmethod - def exec_module(cls, module: types.ModuleType) -> None: ... - -class FrozenImporter(importlib.abc.MetaPathFinder, importlib.abc.InspectLoader): - # MetaPathFinder - if sys.version_info < (3, 12): - @classmethod - def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... - - @classmethod - def find_spec( - cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None - ) -> ModuleSpec | None: ... - # InspectLoader - @classmethod - def is_package(cls, fullname: str) -> bool: ... - @classmethod - def load_module(cls, fullname: str) -> types.ModuleType: ... - @classmethod - def get_code(cls, fullname: str) -> None: ... - @classmethod - def get_source(cls, fullname: str) -> None: ... - # Loader - if sys.version_info < (3, 12): - @staticmethod - def module_repr(m: types.ModuleType) -> str: ... - if sys.version_info >= (3, 10): - @staticmethod - def create_module(spec: ModuleSpec) -> types.ModuleType | None: ... - else: - @classmethod - def create_module(cls, spec: ModuleSpec) -> types.ModuleType | None: ... - - @staticmethod - def exec_module(module: types.ModuleType) -> None: ... - -class WindowsRegistryFinder(importlib.abc.MetaPathFinder): - if sys.version_info < (3, 12): - @classmethod - def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... - - @classmethod - def find_spec( - cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None - ) -> ModuleSpec | None: ... - -class PathFinder: - if sys.version_info >= (3, 10): - @staticmethod - def invalidate_caches() -> None: ... - else: - @classmethod - def invalidate_caches(cls) -> None: ... - if sys.version_info >= (3, 10): - @staticmethod - def find_distributions(context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... - else: - @classmethod - def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... - - @classmethod - def find_spec( - cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None - ) -> ModuleSpec | None: ... - if sys.version_info < (3, 12): - @classmethod - def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... - -SOURCE_SUFFIXES: list[str] -DEBUG_BYTECODE_SUFFIXES: list[str] -OPTIMIZED_BYTECODE_SUFFIXES: list[str] -BYTECODE_SUFFIXES: list[str] -EXTENSION_SUFFIXES: list[str] - -def all_suffixes() -> list[str]: ... - -class FileFinder(importlib.abc.PathEntryFinder): - path: str - def __init__(self, path: str, *loader_details: tuple[type[importlib.abc.Loader], list[str]]) -> None: ... - @classmethod - def path_hook( - cls, *loader_details: tuple[type[importlib.abc.Loader], list[str]] - ) -> Callable[[str], importlib.abc.PathEntryFinder]: ... - -class SourceFileLoader(importlib.abc.FileLoader, importlib.abc.SourceLoader): - def set_data(self, path: str, data: ReadableBuffer, *, _mode: int = 0o666) -> None: ... - -class SourcelessFileLoader(importlib.abc.FileLoader, importlib.abc.SourceLoader): ... - -class ExtensionFileLoader(importlib.abc.ExecutionLoader): - def __init__(self, name: str, path: str) -> None: ... - def get_filename(self, name: str | None = None) -> str: ... - def get_source(self, fullname: str) -> None: ... - def create_module(self, spec: ModuleSpec) -> types.ModuleType: ... - def exec_module(self, module: types.ModuleType) -> None: ... - def get_code(self, fullname: str) -> None: ... - def __eq__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - -if sys.version_info >= (3, 11): - import importlib.readers - - class NamespaceLoader(importlib.abc.InspectLoader): - def __init__( - self, name: str, path: MutableSequence[str], path_finder: Callable[[str, tuple[str, ...]], ModuleSpec] - ) -> None: ... - def is_package(self, fullname: str) -> Literal[True]: ... - def get_source(self, fullname: str) -> Literal[""]: ... - def get_code(self, fullname: str) -> types.CodeType: ... - def create_module(self, spec: ModuleSpec) -> None: ... - def exec_module(self, module: types.ModuleType) -> None: ... - @deprecated("load_module() is deprecated; use exec_module() instead") - def load_module(self, fullname: str) -> types.ModuleType: ... - def get_resource_reader(self, module: types.ModuleType) -> importlib.readers.NamespaceReader: ... - if sys.version_info < (3, 12): - @staticmethod - @deprecated("module_repr() is deprecated, and has been removed in Python 3.12") - def module_repr(module: types.ModuleType) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi deleted file mode 100644 index 5e26f89872772..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi +++ /dev/null @@ -1,291 +0,0 @@ -import abc -import pathlib -import sys -import types -from _collections_abc import dict_keys, dict_values -from _typeshed import StrPath -from collections.abc import Iterable, Iterator, Mapping -from email.message import Message -from importlib.abc import MetaPathFinder -from os import PathLike -from pathlib import Path -from re import Pattern -from typing import Any, ClassVar, Generic, NamedTuple, TypeVar, overload -from typing_extensions import Self, TypeAlias - -_T = TypeVar("_T") -_KT = TypeVar("_KT") -_VT = TypeVar("_VT") - -__all__ = [ - "Distribution", - "DistributionFinder", - "PackageNotFoundError", - "distribution", - "distributions", - "entry_points", - "files", - "metadata", - "requires", - "version", -] - -if sys.version_info >= (3, 10): - __all__ += ["PackageMetadata", "packages_distributions"] - -if sys.version_info >= (3, 10): - from importlib.metadata._meta import PackageMetadata as PackageMetadata, SimplePath - def packages_distributions() -> Mapping[str, list[str]]: ... - - _SimplePath: TypeAlias = SimplePath - -else: - _SimplePath: TypeAlias = Path - -class PackageNotFoundError(ModuleNotFoundError): - @property - def name(self) -> str: ... # type: ignore[override] - -if sys.version_info >= (3, 13): - _EntryPointBase = object -elif sys.version_info >= (3, 11): - class DeprecatedTuple: - def __getitem__(self, item: int) -> str: ... - - _EntryPointBase = DeprecatedTuple -else: - class _EntryPointBase(NamedTuple): - name: str - value: str - group: str - -class EntryPoint(_EntryPointBase): - pattern: ClassVar[Pattern[str]] - if sys.version_info >= (3, 11): - name: str - value: str - group: str - - def __init__(self, name: str, value: str, group: str) -> None: ... - - def load(self) -> Any: ... # Callable[[], Any] or an importable module - @property - def extras(self) -> list[str]: ... - if sys.version_info >= (3, 9): - @property - def module(self) -> str: ... - @property - def attr(self) -> str: ... - if sys.version_info >= (3, 10): - dist: ClassVar[Distribution | None] - def matches( - self, - *, - name: str = ..., - value: str = ..., - group: str = ..., - module: str = ..., - attr: str = ..., - extras: list[str] = ..., - ) -> bool: ... # undocumented - - def __hash__(self) -> int: ... - def __eq__(self, other: object) -> bool: ... - if sys.version_info >= (3, 11): - def __lt__(self, other: object) -> bool: ... - if sys.version_info < (3, 12): - def __iter__(self) -> Iterator[Any]: ... # result of iter((str, Self)), really - -if sys.version_info >= (3, 12): - class EntryPoints(tuple[EntryPoint, ...]): - def __getitem__(self, name: str) -> EntryPoint: ... # type: ignore[override] - def select( - self, - *, - name: str = ..., - value: str = ..., - group: str = ..., - module: str = ..., - attr: str = ..., - extras: list[str] = ..., - ) -> EntryPoints: ... - @property - def names(self) -> set[str]: ... - @property - def groups(self) -> set[str]: ... - -elif sys.version_info >= (3, 10): - class DeprecatedList(list[_T]): ... - - class EntryPoints(DeprecatedList[EntryPoint]): # use as list is deprecated since 3.10 - # int argument is deprecated since 3.10 - def __getitem__(self, name: int | str) -> EntryPoint: ... # type: ignore[override] - def select( - self, - *, - name: str = ..., - value: str = ..., - group: str = ..., - module: str = ..., - attr: str = ..., - extras: list[str] = ..., - ) -> EntryPoints: ... - @property - def names(self) -> set[str]: ... - @property - def groups(self) -> set[str]: ... - -if sys.version_info >= (3, 10) and sys.version_info < (3, 12): - class Deprecated(Generic[_KT, _VT]): - def __getitem__(self, name: _KT) -> _VT: ... - @overload - def get(self, name: _KT) -> _VT | None: ... - @overload - def get(self, name: _KT, default: _T) -> _VT | _T: ... - def __iter__(self) -> Iterator[_KT]: ... - def __contains__(self, *args: object) -> bool: ... - def keys(self) -> dict_keys[_KT, _VT]: ... - def values(self) -> dict_values[_KT, _VT]: ... - - class SelectableGroups(Deprecated[str, EntryPoints], dict[str, EntryPoints]): # use as dict is deprecated since 3.10 - @classmethod - def load(cls, eps: Iterable[EntryPoint]) -> Self: ... - @property - def groups(self) -> set[str]: ... - @property - def names(self) -> set[str]: ... - @overload - def select(self) -> Self: ... - @overload - def select( - self, - *, - name: str = ..., - value: str = ..., - group: str = ..., - module: str = ..., - attr: str = ..., - extras: list[str] = ..., - ) -> EntryPoints: ... - -class PackagePath(pathlib.PurePosixPath): - def read_text(self, encoding: str = "utf-8") -> str: ... - def read_binary(self) -> bytes: ... - def locate(self) -> PathLike[str]: ... - # The following attributes are not defined on PackagePath, but are dynamically added by Distribution.files: - hash: FileHash | None - size: int | None - dist: Distribution - -class FileHash: - mode: str - value: str - def __init__(self, spec: str) -> None: ... - -if sys.version_info >= (3, 12): - class DeprecatedNonAbstract: ... - _distribution_parent = DeprecatedNonAbstract -else: - _distribution_parent = object - -class Distribution(_distribution_parent): - @abc.abstractmethod - def read_text(self, filename: str) -> str | None: ... - @abc.abstractmethod - def locate_file(self, path: StrPath) -> _SimplePath: ... - @classmethod - def from_name(cls, name: str) -> Distribution: ... - @overload - @classmethod - def discover(cls, *, context: DistributionFinder.Context) -> Iterable[Distribution]: ... - @overload - @classmethod - def discover( - cls, *, context: None = None, name: str | None = ..., path: list[str] = ..., **kwargs: Any - ) -> Iterable[Distribution]: ... - @staticmethod - def at(path: StrPath) -> PathDistribution: ... - - if sys.version_info >= (3, 10): - @property - def metadata(self) -> PackageMetadata: ... - @property - def entry_points(self) -> EntryPoints: ... - else: - @property - def metadata(self) -> Message: ... - @property - def entry_points(self) -> list[EntryPoint]: ... - - @property - def version(self) -> str: ... - @property - def files(self) -> list[PackagePath] | None: ... - @property - def requires(self) -> list[str] | None: ... - if sys.version_info >= (3, 10): - @property - def name(self) -> str: ... - if sys.version_info >= (3, 13): - @property - def origin(self) -> types.SimpleNamespace: ... - -class DistributionFinder(MetaPathFinder): - class Context: - name: str | None - def __init__(self, *, name: str | None = ..., path: list[str] = ..., **kwargs: Any) -> None: ... - @property - def path(self) -> list[str]: ... - - @abc.abstractmethod - def find_distributions(self, context: DistributionFinder.Context = ...) -> Iterable[Distribution]: ... - -class MetadataPathFinder(DistributionFinder): - @classmethod - def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... - if sys.version_info >= (3, 11): - @classmethod - def invalidate_caches(cls) -> None: ... - elif sys.version_info >= (3, 10): - # Yes, this is an instance method that has a parameter named "cls" - def invalidate_caches(cls) -> None: ... - -class PathDistribution(Distribution): - _path: _SimplePath - def __init__(self, path: _SimplePath) -> None: ... - def read_text(self, filename: StrPath) -> str | None: ... - def locate_file(self, path: StrPath) -> _SimplePath: ... - -def distribution(distribution_name: str) -> Distribution: ... -@overload -def distributions(*, context: DistributionFinder.Context) -> Iterable[Distribution]: ... -@overload -def distributions( - *, context: None = None, name: str | None = ..., path: list[str] = ..., **kwargs: Any -) -> Iterable[Distribution]: ... - -if sys.version_info >= (3, 10): - def metadata(distribution_name: str) -> PackageMetadata: ... - -else: - def metadata(distribution_name: str) -> Message: ... - -if sys.version_info >= (3, 12): - def entry_points( - *, name: str = ..., value: str = ..., group: str = ..., module: str = ..., attr: str = ..., extras: list[str] = ... - ) -> EntryPoints: ... - -elif sys.version_info >= (3, 10): - @overload - def entry_points() -> SelectableGroups: ... - @overload - def entry_points( - *, name: str = ..., value: str = ..., group: str = ..., module: str = ..., attr: str = ..., extras: list[str] = ... - ) -> EntryPoints: ... - -else: - def entry_points() -> dict[str, list[EntryPoint]]: ... - -def version(distribution_name: str) -> str: ... -def files(distribution_name: str) -> list[PackagePath] | None: ... -def requires(distribution_name: str) -> list[str] | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi deleted file mode 100644 index f82df8c591fad..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi +++ /dev/null @@ -1,70 +0,0 @@ -import os -import sys -from collections.abc import Iterator -from contextlib import AbstractContextManager -from pathlib import Path -from types import ModuleType -from typing import Any, BinaryIO, TextIO -from typing_extensions import TypeAlias - -if sys.version_info >= (3, 11): - from importlib.resources._common import Package as Package -else: - Package: TypeAlias = str | ModuleType - -if sys.version_info >= (3, 9): - from importlib.abc import Traversable - -__all__ = ["Package", "contents", "is_resource", "open_binary", "open_text", "path", "read_binary", "read_text"] - -if sys.version_info >= (3, 9): - __all__ += ["as_file", "files"] - -if sys.version_info >= (3, 10): - __all__ += ["ResourceReader"] - -if sys.version_info < (3, 13): - __all__ += ["Resource"] - -if sys.version_info < (3, 11): - Resource: TypeAlias = str | os.PathLike[Any] -elif sys.version_info < (3, 13): - Resource: TypeAlias = str - -if sys.version_info >= (3, 13): - from importlib.resources._common import Anchor as Anchor - - __all__ += ["Anchor"] - - from importlib.resources._functional import ( - contents as contents, - is_resource as is_resource, - open_binary as open_binary, - open_text as open_text, - path as path, - read_binary as read_binary, - read_text as read_text, - ) - -else: - def open_binary(package: Package, resource: Resource) -> BinaryIO: ... - def open_text(package: Package, resource: Resource, encoding: str = "utf-8", errors: str = "strict") -> TextIO: ... - def read_binary(package: Package, resource: Resource) -> bytes: ... - def read_text(package: Package, resource: Resource, encoding: str = "utf-8", errors: str = "strict") -> str: ... - def path(package: Package, resource: Resource) -> AbstractContextManager[Path]: ... - def is_resource(package: Package, name: str) -> bool: ... - def contents(package: Package) -> Iterator[str]: ... - -if sys.version_info >= (3, 11): - from importlib.resources._common import as_file as as_file -elif sys.version_info >= (3, 9): - def as_file(path: Traversable) -> AbstractContextManager[Path]: ... - -if sys.version_info >= (3, 11): - from importlib.resources._common import files as files - -elif sys.version_info >= (3, 9): - def files(package: Package) -> Traversable: ... - -if sys.version_info >= (3, 10): - from importlib.abc import ResourceReader as ResourceReader diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi deleted file mode 100644 index a36c952d01acf..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi +++ /dev/null @@ -1,12 +0,0 @@ -import sys - -if sys.version_info >= (3, 11): - # These are all actually defined in this file on 3.11+, - # and re-exported from importlib.abc, - # but it's much less code duplication for typeshed if we pretend that they're still defined - # in importlib.abc on 3.11+, and re-exported from this file - from importlib.abc import ( - ResourceReader as ResourceReader, - Traversable as Traversable, - TraversableResources as TraversableResources, - ) diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/util.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/util.pyi deleted file mode 100644 index 2492c76d5c6ce..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/util.pyi +++ /dev/null @@ -1,44 +0,0 @@ -import importlib.abc -import importlib.machinery -import sys -import types -from _typeshed import ReadableBuffer, StrOrBytesPath -from _typeshed.importlib import LoaderProtocol -from collections.abc import Callable -from typing import Any -from typing_extensions import ParamSpec - -_P = ParamSpec("_P") - -if sys.version_info < (3, 12): - def module_for_loader(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... - def set_loader(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... - def set_package(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... - -def resolve_name(name: str, package: str | None) -> str: ... - -MAGIC_NUMBER: bytes - -def cache_from_source(path: str, debug_override: bool | None = None, *, optimization: Any | None = None) -> str: ... -def source_from_cache(path: str) -> str: ... -def decode_source(source_bytes: ReadableBuffer) -> str: ... -def find_spec(name: str, package: str | None = None) -> importlib.machinery.ModuleSpec | None: ... -def spec_from_loader( - name: str, loader: LoaderProtocol | None, *, origin: str | None = None, is_package: bool | None = None -) -> importlib.machinery.ModuleSpec | None: ... -def spec_from_file_location( - name: str, - location: StrOrBytesPath | None = None, - *, - loader: LoaderProtocol | None = None, - submodule_search_locations: list[str] | None = ..., -) -> importlib.machinery.ModuleSpec | None: ... -def module_from_spec(spec: importlib.machinery.ModuleSpec) -> types.ModuleType: ... - -class LazyLoader(importlib.abc.Loader): - def __init__(self, loader: importlib.abc.Loader) -> None: ... - @classmethod - def factory(cls, loader: importlib.abc.Loader) -> Callable[..., LazyLoader]: ... - def exec_module(self, module: types.ModuleType) -> None: ... - -def source_hash(source_bytes: ReadableBuffer) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/keyword.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/keyword.pyi deleted file mode 100644 index 960dfd2fa155a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/keyword.pyi +++ /dev/null @@ -1,21 +0,0 @@ -import sys -from collections.abc import Sequence -from typing import Final - -if sys.version_info >= (3, 9): - __all__ = ["iskeyword", "issoftkeyword", "kwlist", "softkwlist"] -else: - __all__ = ["iskeyword", "kwlist"] - -def iskeyword(s: str, /) -> bool: ... - -# a list at runtime, but you're not meant to mutate it; -# type it as a sequence -kwlist: Final[Sequence[str]] - -if sys.version_info >= (3, 9): - def issoftkeyword(s: str, /) -> bool: ... - - # a list at runtime, but you're not meant to mutate it; - # type it as a sequence - softkwlist: Final[Sequence[str]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/__init__.pyi deleted file mode 100644 index 9a4827a8f626f..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/__init__.pyi +++ /dev/null @@ -1,684 +0,0 @@ -import sys -import threading -from _typeshed import StrPath, SupportsWrite -from collections.abc import Callable, Iterable, Mapping, MutableMapping, Sequence -from io import TextIOWrapper -from re import Pattern -from string import Template -from time import struct_time -from types import FrameType, TracebackType -from typing import Any, ClassVar, Final, Generic, Literal, Protocol, TextIO, TypeVar, overload -from typing_extensions import Self, TypeAlias, deprecated - -if sys.version_info >= (3, 11): - from types import GenericAlias - -__all__ = [ - "BASIC_FORMAT", - "BufferingFormatter", - "CRITICAL", - "DEBUG", - "ERROR", - "FATAL", - "FileHandler", - "Filter", - "Formatter", - "Handler", - "INFO", - "LogRecord", - "Logger", - "LoggerAdapter", - "NOTSET", - "NullHandler", - "StreamHandler", - "WARN", - "WARNING", - "addLevelName", - "basicConfig", - "captureWarnings", - "critical", - "debug", - "disable", - "error", - "exception", - "fatal", - "getLevelName", - "getLogger", - "getLoggerClass", - "info", - "log", - "makeLogRecord", - "setLoggerClass", - "shutdown", - "warning", - "getLogRecordFactory", - "setLogRecordFactory", - "lastResort", - "raiseExceptions", - "warn", -] - -if sys.version_info >= (3, 11): - __all__ += ["getLevelNamesMapping"] -if sys.version_info >= (3, 12): - __all__ += ["getHandlerByName", "getHandlerNames"] - -_SysExcInfoType: TypeAlias = tuple[type[BaseException], BaseException, TracebackType | None] | tuple[None, None, None] -_ExcInfoType: TypeAlias = None | bool | _SysExcInfoType | BaseException -_ArgsType: TypeAlias = tuple[object, ...] | Mapping[str, object] -_Level: TypeAlias = int | str -_FormatStyle: TypeAlias = Literal["%", "{", "$"] - -if sys.version_info >= (3, 12): - class _SupportsFilter(Protocol): - def filter(self, record: LogRecord, /) -> bool | LogRecord: ... - - _FilterType: TypeAlias = Filter | Callable[[LogRecord], bool | LogRecord] | _SupportsFilter -else: - class _SupportsFilter(Protocol): - def filter(self, record: LogRecord, /) -> bool: ... - - _FilterType: TypeAlias = Filter | Callable[[LogRecord], bool] | _SupportsFilter - -raiseExceptions: bool -logThreads: bool -logMultiprocessing: bool -logProcesses: bool -_srcfile: str | None - -def currentframe() -> FrameType: ... - -_levelToName: dict[int, str] -_nameToLevel: dict[str, int] - -class Filterer: - filters: list[_FilterType] - def addFilter(self, filter: _FilterType) -> None: ... - def removeFilter(self, filter: _FilterType) -> None: ... - if sys.version_info >= (3, 12): - def filter(self, record: LogRecord) -> bool | LogRecord: ... - else: - def filter(self, record: LogRecord) -> bool: ... - -class Manager: # undocumented - root: RootLogger - disable: int - emittedNoHandlerWarning: bool - loggerDict: dict[str, Logger | PlaceHolder] - loggerClass: type[Logger] | None - logRecordFactory: Callable[..., LogRecord] | None - def __init__(self, rootnode: RootLogger) -> None: ... - def getLogger(self, name: str) -> Logger: ... - def setLoggerClass(self, klass: type[Logger]) -> None: ... - def setLogRecordFactory(self, factory: Callable[..., LogRecord]) -> None: ... - -class Logger(Filterer): - name: str # undocumented - level: int # undocumented - parent: Logger | None # undocumented - propagate: bool - handlers: list[Handler] # undocumented - disabled: bool # undocumented - root: ClassVar[RootLogger] # undocumented - manager: Manager # undocumented - def __init__(self, name: str, level: _Level = 0) -> None: ... - def setLevel(self, level: _Level) -> None: ... - def isEnabledFor(self, level: int) -> bool: ... - def getEffectiveLevel(self) -> int: ... - def getChild(self, suffix: str) -> Self: ... # see python/typing#980 - if sys.version_info >= (3, 12): - def getChildren(self) -> set[Logger]: ... - - def debug( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def info( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def warning( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - @deprecated("Deprecated; use warning() instead.") - def warn( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def error( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def exception( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = True, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def critical( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def log( - self, - level: int, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - ) -> None: ... - def _log( - self, - level: int, - msg: object, - args: _ArgsType, - exc_info: _ExcInfoType | None = None, - extra: Mapping[str, object] | None = None, - stack_info: bool = False, - stacklevel: int = 1, - ) -> None: ... # undocumented - fatal = critical - def addHandler(self, hdlr: Handler) -> None: ... - def removeHandler(self, hdlr: Handler) -> None: ... - def findCaller(self, stack_info: bool = False, stacklevel: int = 1) -> tuple[str, int, str, str | None]: ... - def handle(self, record: LogRecord) -> None: ... - def makeRecord( - self, - name: str, - level: int, - fn: str, - lno: int, - msg: object, - args: _ArgsType, - exc_info: _SysExcInfoType | None, - func: str | None = None, - extra: Mapping[str, object] | None = None, - sinfo: str | None = None, - ) -> LogRecord: ... - def hasHandlers(self) -> bool: ... - def callHandlers(self, record: LogRecord) -> None: ... # undocumented - -CRITICAL: Final = 50 -FATAL: Final = CRITICAL -ERROR: Final = 40 -WARNING: Final = 30 -WARN: Final = WARNING -INFO: Final = 20 -DEBUG: Final = 10 -NOTSET: Final = 0 - -class Handler(Filterer): - level: int # undocumented - formatter: Formatter | None # undocumented - lock: threading.Lock | None # undocumented - name: str | None # undocumented - def __init__(self, level: _Level = 0) -> None: ... - def get_name(self) -> str: ... # undocumented - def set_name(self, name: str) -> None: ... # undocumented - def createLock(self) -> None: ... - def acquire(self) -> None: ... - def release(self) -> None: ... - def setLevel(self, level: _Level) -> None: ... - def setFormatter(self, fmt: Formatter | None) -> None: ... - def flush(self) -> None: ... - def close(self) -> None: ... - def handle(self, record: LogRecord) -> bool: ... - def handleError(self, record: LogRecord) -> None: ... - def format(self, record: LogRecord) -> str: ... - def emit(self, record: LogRecord) -> None: ... - -if sys.version_info >= (3, 12): - def getHandlerByName(name: str) -> Handler | None: ... - def getHandlerNames() -> frozenset[str]: ... - -class Formatter: - converter: Callable[[float | None], struct_time] - _fmt: str | None # undocumented - datefmt: str | None # undocumented - _style: PercentStyle # undocumented - default_time_format: str - if sys.version_info >= (3, 9): - default_msec_format: str | None - else: - default_msec_format: str - - if sys.version_info >= (3, 10): - def __init__( - self, - fmt: str | None = None, - datefmt: str | None = None, - style: _FormatStyle = "%", - validate: bool = True, - *, - defaults: Mapping[str, Any] | None = None, - ) -> None: ... - else: - def __init__( - self, fmt: str | None = None, datefmt: str | None = None, style: _FormatStyle = "%", validate: bool = True - ) -> None: ... - - def format(self, record: LogRecord) -> str: ... - def formatTime(self, record: LogRecord, datefmt: str | None = None) -> str: ... - def formatException(self, ei: _SysExcInfoType) -> str: ... - def formatMessage(self, record: LogRecord) -> str: ... # undocumented - def formatStack(self, stack_info: str) -> str: ... - def usesTime(self) -> bool: ... # undocumented - -class BufferingFormatter: - linefmt: Formatter - def __init__(self, linefmt: Formatter | None = None) -> None: ... - def formatHeader(self, records: Sequence[LogRecord]) -> str: ... - def formatFooter(self, records: Sequence[LogRecord]) -> str: ... - def format(self, records: Sequence[LogRecord]) -> str: ... - -class Filter: - name: str # undocumented - nlen: int # undocumented - def __init__(self, name: str = "") -> None: ... - if sys.version_info >= (3, 12): - def filter(self, record: LogRecord) -> bool | LogRecord: ... - else: - def filter(self, record: LogRecord) -> bool: ... - -class LogRecord: - # args can be set to None by logging.handlers.QueueHandler - # (see https://bugs.python.org/issue44473) - args: _ArgsType | None - asctime: str - created: float - exc_info: _SysExcInfoType | None - exc_text: str | None - filename: str - funcName: str - levelname: str - levelno: int - lineno: int - module: str - msecs: float - # Only created when logging.Formatter.format is called. See #6132. - message: str - msg: str | Any # The runtime accepts any object, but will be a str in 99% of cases - name: str - pathname: str - process: int | None - processName: str | None - relativeCreated: float - stack_info: str | None - thread: int | None - threadName: str | None - if sys.version_info >= (3, 12): - taskName: str | None - - def __init__( - self, - name: str, - level: int, - pathname: str, - lineno: int, - msg: object, - args: _ArgsType | None, - exc_info: _SysExcInfoType | None, - func: str | None = None, - sinfo: str | None = None, - ) -> None: ... - def getMessage(self) -> str: ... - # Allows setting contextual information on LogRecord objects as per the docs, see #7833 - def __setattr__(self, name: str, value: Any, /) -> None: ... - -_L = TypeVar("_L", bound=Logger | LoggerAdapter[Any]) - -class LoggerAdapter(Generic[_L]): - logger: _L - manager: Manager # undocumented - - if sys.version_info >= (3, 13): - def __init__(self, logger: _L, extra: Mapping[str, object] | None = None, merge_extra: bool = False) -> None: ... - elif sys.version_info >= (3, 10): - def __init__(self, logger: _L, extra: Mapping[str, object] | None = None) -> None: ... - else: - def __init__(self, logger: _L, extra: Mapping[str, object]) -> None: ... - - if sys.version_info >= (3, 10): - extra: Mapping[str, object] | None - else: - extra: Mapping[str, object] - - def process(self, msg: Any, kwargs: MutableMapping[str, Any]) -> tuple[Any, MutableMapping[str, Any]]: ... - def debug( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def info( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def warning( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - @deprecated("Deprecated; use warning() instead.") - def warn( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def error( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def exception( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = True, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def critical( - self, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def log( - self, - level: int, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, - **kwargs: object, - ) -> None: ... - def isEnabledFor(self, level: int) -> bool: ... - def getEffectiveLevel(self) -> int: ... - def setLevel(self, level: _Level) -> None: ... - def hasHandlers(self) -> bool: ... - if sys.version_info >= (3, 11): - def _log( - self, - level: int, - msg: object, - args: _ArgsType, - *, - exc_info: _ExcInfoType | None = None, - extra: Mapping[str, object] | None = None, - stack_info: bool = False, - ) -> None: ... # undocumented - else: - def _log( - self, - level: int, - msg: object, - args: _ArgsType, - exc_info: _ExcInfoType | None = None, - extra: Mapping[str, object] | None = None, - stack_info: bool = False, - ) -> None: ... # undocumented - - @property - def name(self) -> str: ... # undocumented - if sys.version_info >= (3, 11): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -def getLogger(name: str | None = None) -> Logger: ... -def getLoggerClass() -> type[Logger]: ... -def getLogRecordFactory() -> Callable[..., LogRecord]: ... -def debug( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def info( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def warning( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -@deprecated("Deprecated; use warning() instead.") -def warn( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def error( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def critical( - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def exception( - msg: object, - *args: object, - exc_info: _ExcInfoType = True, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... -def log( - level: int, - msg: object, - *args: object, - exc_info: _ExcInfoType = None, - stack_info: bool = False, - stacklevel: int = 1, - extra: Mapping[str, object] | None = None, -) -> None: ... - -fatal = critical - -def disable(level: int = 50) -> None: ... -def addLevelName(level: int, levelName: str) -> None: ... -@overload -def getLevelName(level: int) -> str: ... -@overload -@deprecated("The str -> int case is considered a mistake.") -def getLevelName(level: str) -> Any: ... - -if sys.version_info >= (3, 11): - def getLevelNamesMapping() -> dict[str, int]: ... - -def makeLogRecord(dict: Mapping[str, object]) -> LogRecord: ... - -if sys.version_info >= (3, 9): - def basicConfig( - *, - filename: StrPath | None = ..., - filemode: str = ..., - format: str = ..., - datefmt: str | None = ..., - style: _FormatStyle = ..., - level: _Level | None = ..., - stream: SupportsWrite[str] | None = ..., - handlers: Iterable[Handler] | None = ..., - force: bool | None = ..., - encoding: str | None = ..., - errors: str | None = ..., - ) -> None: ... - -else: - def basicConfig( - *, - filename: StrPath | None = ..., - filemode: str = ..., - format: str = ..., - datefmt: str | None = ..., - style: _FormatStyle = ..., - level: _Level | None = ..., - stream: SupportsWrite[str] | None = ..., - handlers: Iterable[Handler] | None = ..., - force: bool = ..., - ) -> None: ... - -def shutdown(handlerList: Sequence[Any] = ...) -> None: ... # handlerList is undocumented -def setLoggerClass(klass: type[Logger]) -> None: ... -def captureWarnings(capture: bool) -> None: ... -def setLogRecordFactory(factory: Callable[..., LogRecord]) -> None: ... - -lastResort: Handler | None - -_StreamT = TypeVar("_StreamT", bound=SupportsWrite[str]) - -class StreamHandler(Handler, Generic[_StreamT]): - stream: _StreamT # undocumented - terminator: str - @overload - def __init__(self: StreamHandler[TextIO], stream: None = None) -> None: ... - @overload - def __init__(self: StreamHandler[_StreamT], stream: _StreamT) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] #11780 - def setStream(self, stream: _StreamT) -> _StreamT | None: ... - if sys.version_info >= (3, 11): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class FileHandler(StreamHandler[TextIOWrapper]): - baseFilename: str # undocumented - mode: str # undocumented - encoding: str | None # undocumented - delay: bool # undocumented - if sys.version_info >= (3, 9): - errors: str | None # undocumented - def __init__( - self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None - ) -> None: ... - else: - def __init__(self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False) -> None: ... - - def _open(self) -> TextIOWrapper: ... # undocumented - -class NullHandler(Handler): ... - -class PlaceHolder: # undocumented - loggerMap: dict[Logger, None] - def __init__(self, alogger: Logger) -> None: ... - def append(self, alogger: Logger) -> None: ... - -# Below aren't in module docs but still visible - -class RootLogger(Logger): - def __init__(self, level: int) -> None: ... - -root: RootLogger - -class PercentStyle: # undocumented - default_format: str - asctime_format: str - asctime_search: str - validation_pattern: Pattern[str] - _fmt: str - if sys.version_info >= (3, 10): - def __init__(self, fmt: str, *, defaults: Mapping[str, Any] | None = None) -> None: ... - else: - def __init__(self, fmt: str) -> None: ... - - def usesTime(self) -> bool: ... - def validate(self) -> None: ... - def format(self, record: Any) -> str: ... - -class StrFormatStyle(PercentStyle): # undocumented - fmt_spec: Pattern[str] - field_spec: Pattern[str] - -class StringTemplateStyle(PercentStyle): # undocumented - _tpl: Template - -_STYLES: Final[dict[str, tuple[PercentStyle, str]]] - -BASIC_FORMAT: Final[str] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/config.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/config.pyi deleted file mode 100644 index 83fe7461cb5c5..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/config.pyi +++ /dev/null @@ -1,134 +0,0 @@ -import sys -from _typeshed import StrOrBytesPath -from collections.abc import Callable, Hashable, Iterable, Sequence -from configparser import RawConfigParser -from re import Pattern -from threading import Thread -from typing import IO, Any, Final, Literal, SupportsIndex, TypedDict, overload -from typing_extensions import Required, TypeAlias - -from . import Filter, Filterer, Formatter, Handler, Logger, _FilterType, _FormatStyle, _Level - -DEFAULT_LOGGING_CONFIG_PORT: int -RESET_ERROR: Final[int] # undocumented -IDENTIFIER: Final[Pattern[str]] # undocumented - -if sys.version_info >= (3, 11): - class _RootLoggerConfiguration(TypedDict, total=False): - level: _Level - filters: Sequence[str | _FilterType] - handlers: Sequence[str] - -else: - class _RootLoggerConfiguration(TypedDict, total=False): - level: _Level - filters: Sequence[str] - handlers: Sequence[str] - -class _LoggerConfiguration(_RootLoggerConfiguration, TypedDict, total=False): - propagate: bool - -_FormatterConfigurationTypedDict = TypedDict( - "_FormatterConfigurationTypedDict", {"class": str, "format": str, "datefmt": str, "style": _FormatStyle}, total=False -) - -class _FilterConfigurationTypedDict(TypedDict): - name: str - -# Formatter and filter configs can specify custom factories via the special `()` key. -# If that is the case, the dictionary can contain any additional keys -# https://docs.python.org/3/library/logging.config.html#user-defined-objects -_FormatterConfiguration: TypeAlias = _FormatterConfigurationTypedDict | dict[str, Any] -_FilterConfiguration: TypeAlias = _FilterConfigurationTypedDict | dict[str, Any] -# Handler config can have additional keys even when not providing a custom factory so we just use `dict`. -_HandlerConfiguration: TypeAlias = dict[str, Any] - -class _DictConfigArgs(TypedDict, total=False): - version: Required[Literal[1]] - formatters: dict[str, _FormatterConfiguration] - filters: dict[str, _FilterConfiguration] - handlers: dict[str, _HandlerConfiguration] - loggers: dict[str, _LoggerConfiguration] - root: _RootLoggerConfiguration - incremental: bool - disable_existing_loggers: bool - -# Accept dict[str, Any] to avoid false positives if called with a dict -# type, since dict types are not compatible with TypedDicts. -# -# Also accept a TypedDict type, to allow callers to use TypedDict -# types, and for somewhat stricter type checking of dict literals. -def dictConfig(config: _DictConfigArgs | dict[str, Any]) -> None: ... - -if sys.version_info >= (3, 10): - def fileConfig( - fname: StrOrBytesPath | IO[str] | RawConfigParser, - defaults: dict[str, str] | None = None, - disable_existing_loggers: bool = True, - encoding: str | None = None, - ) -> None: ... - -else: - def fileConfig( - fname: StrOrBytesPath | IO[str] | RawConfigParser, - defaults: dict[str, str] | None = None, - disable_existing_loggers: bool = True, - ) -> None: ... - -def valid_ident(s: str) -> Literal[True]: ... # undocumented -def listen(port: int = 9030, verify: Callable[[bytes], bytes | None] | None = None) -> Thread: ... -def stopListening() -> None: ... - -class ConvertingMixin: # undocumented - def convert_with_key(self, key: Any, value: Any, replace: bool = True) -> Any: ... - def convert(self, value: Any) -> Any: ... - -class ConvertingDict(dict[Hashable, Any], ConvertingMixin): # undocumented - def __getitem__(self, key: Hashable) -> Any: ... - def get(self, key: Hashable, default: Any = None) -> Any: ... - def pop(self, key: Hashable, default: Any = None) -> Any: ... - -class ConvertingList(list[Any], ConvertingMixin): # undocumented - @overload - def __getitem__(self, key: SupportsIndex) -> Any: ... - @overload - def __getitem__(self, key: slice) -> Any: ... - def pop(self, idx: SupportsIndex = -1) -> Any: ... - -class ConvertingTuple(tuple[Any, ...], ConvertingMixin): # undocumented - @overload - def __getitem__(self, key: SupportsIndex) -> Any: ... - @overload - def __getitem__(self, key: slice) -> Any: ... - -class BaseConfigurator: # undocumented - CONVERT_PATTERN: Pattern[str] - WORD_PATTERN: Pattern[str] - DOT_PATTERN: Pattern[str] - INDEX_PATTERN: Pattern[str] - DIGIT_PATTERN: Pattern[str] - value_converters: dict[str, str] - importer: Callable[..., Any] - - def __init__(self, config: _DictConfigArgs | dict[str, Any]) -> None: ... - def resolve(self, s: str) -> Any: ... - def ext_convert(self, value: str) -> Any: ... - def cfg_convert(self, value: str) -> Any: ... - def convert(self, value: Any) -> Any: ... - def configure_custom(self, config: dict[str, Any]) -> Any: ... - def as_tuple(self, value: list[Any] | tuple[Any]) -> tuple[Any]: ... - -class DictConfigurator(BaseConfigurator): - def configure(self) -> None: ... # undocumented - def configure_formatter(self, config: _FormatterConfiguration) -> Formatter | Any: ... # undocumented - def configure_filter(self, config: _FilterConfiguration) -> Filter | Any: ... # undocumented - def add_filters(self, filterer: Filterer, filters: Iterable[_FilterType]) -> None: ... # undocumented - def configure_handler(self, config: _HandlerConfiguration) -> Handler | Any: ... # undocumented - def add_handlers(self, logger: Logger, handlers: Iterable[str]) -> None: ... # undocumented - def common_logger_config( - self, logger: Logger, config: _LoggerConfiguration, incremental: bool = False - ) -> None: ... # undocumented - def configure_logger(self, name: str, config: _LoggerConfiguration, incremental: bool = False) -> None: ... # undocumented - def configure_root(self, config: _LoggerConfiguration, incremental: bool = False) -> None: ... # undocumented - -dictConfigClass = DictConfigurator diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lzma.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/lzma.pyi deleted file mode 100644 index 2df2b9a8bd6a4..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/lzma.pyi +++ /dev/null @@ -1,197 +0,0 @@ -from _compression import BaseStream -from _typeshed import ReadableBuffer, StrOrBytesPath -from collections.abc import Mapping, Sequence -from typing import IO, Any, Final, Literal, TextIO, final, overload -from typing_extensions import Self, TypeAlias - -__all__ = [ - "CHECK_NONE", - "CHECK_CRC32", - "CHECK_CRC64", - "CHECK_SHA256", - "CHECK_ID_MAX", - "CHECK_UNKNOWN", - "FILTER_LZMA1", - "FILTER_LZMA2", - "FILTER_DELTA", - "FILTER_X86", - "FILTER_IA64", - "FILTER_ARM", - "FILTER_ARMTHUMB", - "FILTER_POWERPC", - "FILTER_SPARC", - "FORMAT_AUTO", - "FORMAT_XZ", - "FORMAT_ALONE", - "FORMAT_RAW", - "MF_HC3", - "MF_HC4", - "MF_BT2", - "MF_BT3", - "MF_BT4", - "MODE_FAST", - "MODE_NORMAL", - "PRESET_DEFAULT", - "PRESET_EXTREME", - "LZMACompressor", - "LZMADecompressor", - "LZMAFile", - "LZMAError", - "open", - "compress", - "decompress", - "is_check_supported", -] - -_OpenBinaryWritingMode: TypeAlias = Literal["w", "wb", "x", "xb", "a", "ab"] -_OpenTextWritingMode: TypeAlias = Literal["wt", "xt", "at"] - -_PathOrFile: TypeAlias = StrOrBytesPath | IO[bytes] - -_FilterChain: TypeAlias = Sequence[Mapping[str, Any]] - -FORMAT_AUTO: Final = 0 -FORMAT_XZ: Final = 1 -FORMAT_ALONE: Final = 2 -FORMAT_RAW: Final = 3 -CHECK_NONE: Final = 0 -CHECK_CRC32: Final = 1 -CHECK_CRC64: Final = 4 -CHECK_SHA256: Final = 10 -CHECK_ID_MAX: Final = 15 -CHECK_UNKNOWN: Final = 16 -FILTER_LZMA1: int # v big number -FILTER_LZMA2: Final = 33 -FILTER_DELTA: Final = 3 -FILTER_X86: Final = 4 -FILTER_IA64: Final = 6 -FILTER_ARM: Final = 7 -FILTER_ARMTHUMB: Final = 8 -FILTER_SPARC: Final = 9 -FILTER_POWERPC: Final = 5 -MF_HC3: Final = 3 -MF_HC4: Final = 4 -MF_BT2: Final = 18 -MF_BT3: Final = 19 -MF_BT4: Final = 20 -MODE_FAST: Final = 1 -MODE_NORMAL: Final = 2 -PRESET_DEFAULT: Final = 6 -PRESET_EXTREME: int # v big number - -# from _lzma.c -@final -class LZMADecompressor: - def __init__(self, format: int | None = ..., memlimit: int | None = ..., filters: _FilterChain | None = ...) -> None: ... - def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes: ... - @property - def check(self) -> int: ... - @property - def eof(self) -> bool: ... - @property - def unused_data(self) -> bytes: ... - @property - def needs_input(self) -> bool: ... - -# from _lzma.c -@final -class LZMACompressor: - def __init__( - self, format: int | None = ..., check: int = ..., preset: int | None = ..., filters: _FilterChain | None = ... - ) -> None: ... - def compress(self, data: ReadableBuffer, /) -> bytes: ... - def flush(self) -> bytes: ... - -class LZMAError(Exception): ... - -class LZMAFile(BaseStream, IO[bytes]): # type: ignore[misc] # incompatible definitions of writelines in the base classes - def __init__( - self, - filename: _PathOrFile | None = None, - mode: str = "r", - *, - format: int | None = None, - check: int = -1, - preset: int | None = None, - filters: _FilterChain | None = None, - ) -> None: ... - def __enter__(self) -> Self: ... - def peek(self, size: int = -1) -> bytes: ... - def read(self, size: int | None = -1) -> bytes: ... - def read1(self, size: int = -1) -> bytes: ... - def readline(self, size: int | None = -1) -> bytes: ... - def write(self, data: ReadableBuffer) -> int: ... - def seek(self, offset: int, whence: int = 0) -> int: ... - -@overload -def open( - filename: _PathOrFile, - mode: Literal["r", "rb"] = "rb", - *, - format: int | None = None, - check: Literal[-1] = -1, - preset: None = None, - filters: _FilterChain | None = None, - encoding: None = None, - errors: None = None, - newline: None = None, -) -> LZMAFile: ... -@overload -def open( - filename: _PathOrFile, - mode: _OpenBinaryWritingMode, - *, - format: int | None = None, - check: int = -1, - preset: int | None = None, - filters: _FilterChain | None = None, - encoding: None = None, - errors: None = None, - newline: None = None, -) -> LZMAFile: ... -@overload -def open( - filename: StrOrBytesPath, - mode: Literal["rt"], - *, - format: int | None = None, - check: Literal[-1] = -1, - preset: None = None, - filters: _FilterChain | None = None, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> TextIO: ... -@overload -def open( - filename: StrOrBytesPath, - mode: _OpenTextWritingMode, - *, - format: int | None = None, - check: int = -1, - preset: int | None = None, - filters: _FilterChain | None = None, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> TextIO: ... -@overload -def open( - filename: _PathOrFile, - mode: str, - *, - format: int | None = None, - check: int = -1, - preset: int | None = None, - filters: _FilterChain | None = None, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, -) -> LZMAFile | TextIO: ... -def compress( - data: ReadableBuffer, format: int = 1, check: int = -1, preset: int | None = None, filters: _FilterChain | None = None -) -> bytes: ... -def decompress( - data: ReadableBuffer, format: int = 0, memlimit: int | None = None, filters: _FilterChain | None = None -) -> bytes: ... -def is_check_supported(check_id: int, /) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/math.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/math.pyi deleted file mode 100644 index 2bb61e0669b4d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/math.pyi +++ /dev/null @@ -1,128 +0,0 @@ -import sys -from collections.abc import Iterable -from typing import Protocol, SupportsFloat, SupportsIndex, TypeVar, overload -from typing_extensions import TypeAlias - -_T = TypeVar("_T") -_T_co = TypeVar("_T_co", covariant=True) - -_SupportsFloatOrIndex: TypeAlias = SupportsFloat | SupportsIndex - -e: float -pi: float -inf: float -nan: float -tau: float - -def acos(x: _SupportsFloatOrIndex, /) -> float: ... -def acosh(x: _SupportsFloatOrIndex, /) -> float: ... -def asin(x: _SupportsFloatOrIndex, /) -> float: ... -def asinh(x: _SupportsFloatOrIndex, /) -> float: ... -def atan(x: _SupportsFloatOrIndex, /) -> float: ... -def atan2(y: _SupportsFloatOrIndex, x: _SupportsFloatOrIndex, /) -> float: ... -def atanh(x: _SupportsFloatOrIndex, /) -> float: ... - -if sys.version_info >= (3, 11): - def cbrt(x: _SupportsFloatOrIndex, /) -> float: ... - -class _SupportsCeil(Protocol[_T_co]): - def __ceil__(self) -> _T_co: ... - -@overload -def ceil(x: _SupportsCeil[_T], /) -> _T: ... -@overload -def ceil(x: _SupportsFloatOrIndex, /) -> int: ... -def comb(n: SupportsIndex, k: SupportsIndex, /) -> int: ... -def copysign(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... -def cos(x: _SupportsFloatOrIndex, /) -> float: ... -def cosh(x: _SupportsFloatOrIndex, /) -> float: ... -def degrees(x: _SupportsFloatOrIndex, /) -> float: ... -def dist(p: Iterable[_SupportsFloatOrIndex], q: Iterable[_SupportsFloatOrIndex], /) -> float: ... -def erf(x: _SupportsFloatOrIndex, /) -> float: ... -def erfc(x: _SupportsFloatOrIndex, /) -> float: ... -def exp(x: _SupportsFloatOrIndex, /) -> float: ... - -if sys.version_info >= (3, 11): - def exp2(x: _SupportsFloatOrIndex, /) -> float: ... - -def expm1(x: _SupportsFloatOrIndex, /) -> float: ... -def fabs(x: _SupportsFloatOrIndex, /) -> float: ... -def factorial(x: SupportsIndex, /) -> int: ... - -class _SupportsFloor(Protocol[_T_co]): - def __floor__(self) -> _T_co: ... - -@overload -def floor(x: _SupportsFloor[_T], /) -> _T: ... -@overload -def floor(x: _SupportsFloatOrIndex, /) -> int: ... -def fmod(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... -def frexp(x: _SupportsFloatOrIndex, /) -> tuple[float, int]: ... -def fsum(seq: Iterable[_SupportsFloatOrIndex], /) -> float: ... -def gamma(x: _SupportsFloatOrIndex, /) -> float: ... - -if sys.version_info >= (3, 9): - def gcd(*integers: SupportsIndex) -> int: ... - -else: - def gcd(x: SupportsIndex, y: SupportsIndex, /) -> int: ... - -def hypot(*coordinates: _SupportsFloatOrIndex) -> float: ... -def isclose( - a: _SupportsFloatOrIndex, - b: _SupportsFloatOrIndex, - *, - rel_tol: _SupportsFloatOrIndex = 1e-09, - abs_tol: _SupportsFloatOrIndex = 0.0, -) -> bool: ... -def isinf(x: _SupportsFloatOrIndex, /) -> bool: ... -def isfinite(x: _SupportsFloatOrIndex, /) -> bool: ... -def isnan(x: _SupportsFloatOrIndex, /) -> bool: ... -def isqrt(n: SupportsIndex, /) -> int: ... - -if sys.version_info >= (3, 9): - def lcm(*integers: SupportsIndex) -> int: ... - -def ldexp(x: _SupportsFloatOrIndex, i: int, /) -> float: ... -def lgamma(x: _SupportsFloatOrIndex, /) -> float: ... -def log(x: _SupportsFloatOrIndex, base: _SupportsFloatOrIndex = ...) -> float: ... -def log10(x: _SupportsFloatOrIndex, /) -> float: ... -def log1p(x: _SupportsFloatOrIndex, /) -> float: ... -def log2(x: _SupportsFloatOrIndex, /) -> float: ... -def modf(x: _SupportsFloatOrIndex, /) -> tuple[float, float]: ... - -if sys.version_info >= (3, 12): - def nextafter(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /, *, steps: SupportsIndex | None = None) -> float: ... - -elif sys.version_info >= (3, 9): - def nextafter(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... - -def perm(n: SupportsIndex, k: SupportsIndex | None = None, /) -> int: ... -def pow(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... -@overload -def prod(iterable: Iterable[SupportsIndex], /, *, start: SupportsIndex = 1) -> int: ... # type: ignore[overload-overlap] -@overload -def prod(iterable: Iterable[_SupportsFloatOrIndex], /, *, start: _SupportsFloatOrIndex = 1) -> float: ... -def radians(x: _SupportsFloatOrIndex, /) -> float: ... -def remainder(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... -def sin(x: _SupportsFloatOrIndex, /) -> float: ... -def sinh(x: _SupportsFloatOrIndex, /) -> float: ... - -if sys.version_info >= (3, 12): - def sumprod(p: Iterable[float], q: Iterable[float], /) -> float: ... - -def sqrt(x: _SupportsFloatOrIndex, /) -> float: ... -def tan(x: _SupportsFloatOrIndex, /) -> float: ... -def tanh(x: _SupportsFloatOrIndex, /) -> float: ... - -# Is different from `_typeshed.SupportsTrunc`, which is not generic -class _SupportsTrunc(Protocol[_T_co]): - def __trunc__(self) -> _T_co: ... - -def trunc(x: _SupportsTrunc[_T], /) -> _T: ... - -if sys.version_info >= (3, 9): - def ulp(x: _SupportsFloatOrIndex, /) -> float: ... - -if sys.version_info >= (3, 13): - def fma(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, z: _SupportsFloatOrIndex, /) -> float: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi deleted file mode 100644 index c5a1134377a1b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi +++ /dev/null @@ -1,218 +0,0 @@ -import queue -import sys -import threading -from _typeshed import Incomplete, SupportsKeysAndGetItem, SupportsRichComparison, SupportsRichComparisonT -from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping, MutableSequence, Sequence -from types import TracebackType -from typing import Any, AnyStr, ClassVar, Generic, SupportsIndex, TypeVar, overload -from typing_extensions import Self, TypeAlias - -from .connection import Connection -from .context import BaseContext -from .shared_memory import _SLT, ShareableList as _ShareableList, SharedMemory as _SharedMemory - -__all__ = ["BaseManager", "SyncManager", "BaseProxy", "Token", "SharedMemoryManager"] - -if sys.version_info >= (3, 9): - from types import GenericAlias - -_T = TypeVar("_T") -_KT = TypeVar("_KT") -_VT = TypeVar("_VT") - -class Namespace: - def __init__(self, **kwds: Any) -> None: ... - def __getattr__(self, name: str, /) -> Any: ... - def __setattr__(self, name: str, value: Any, /) -> None: ... - -_Namespace: TypeAlias = Namespace - -class Token: - typeid: str | bytes | None - address: tuple[str | bytes, int] - id: str | bytes | int | None - def __init__(self, typeid: bytes | str | None, address: tuple[str | bytes, int], id: str | bytes | int | None) -> None: ... - def __getstate__(self) -> tuple[str | bytes | None, tuple[str | bytes, int], str | bytes | int | None]: ... - def __setstate__(self, state: tuple[str | bytes | None, tuple[str | bytes, int], str | bytes | int | None]) -> None: ... - -class BaseProxy: - _address_to_local: dict[Any, Any] - _mutex: Any - def __init__( - self, - token: Any, - serializer: str, - manager: Any = None, - authkey: AnyStr | None = None, - exposed: Any = None, - incref: bool = True, - manager_owned: bool = False, - ) -> None: ... - def __deepcopy__(self, memo: Any | None) -> Any: ... - def _callmethod(self, methodname: str, args: tuple[Any, ...] = (), kwds: dict[Any, Any] = {}) -> None: ... - def _getvalue(self) -> Any: ... - def __reduce__(self) -> tuple[Any, tuple[Any, Any, str, dict[Any, Any]]]: ... - -class ValueProxy(BaseProxy, Generic[_T]): - def get(self) -> _T: ... - def set(self, value: _T) -> None: ... - value: _T - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class DictProxy(BaseProxy, MutableMapping[_KT, _VT]): - __builtins__: ClassVar[dict[str, Any]] - def __len__(self) -> int: ... - def __getitem__(self, key: _KT, /) -> _VT: ... - def __setitem__(self, key: _KT, value: _VT, /) -> None: ... - def __delitem__(self, key: _KT, /) -> None: ... - def __iter__(self) -> Iterator[_KT]: ... - def copy(self) -> dict[_KT, _VT]: ... - @overload # type: ignore[override] - def get(self, key: _KT, /) -> _VT | None: ... - @overload - def get(self, key: _KT, default: _VT, /) -> _VT: ... - @overload - def get(self, key: _KT, default: _T, /) -> _VT | _T: ... - @overload - def pop(self, key: _KT, /) -> _VT: ... - @overload - def pop(self, key: _KT, default: _VT, /) -> _VT: ... - @overload - def pop(self, key: _KT, default: _T, /) -> _VT | _T: ... - def keys(self) -> list[_KT]: ... # type: ignore[override] - def items(self) -> list[tuple[_KT, _VT]]: ... # type: ignore[override] - def values(self) -> list[_VT]: ... # type: ignore[override] - if sys.version_info >= (3, 13): - def __class_getitem__(cls, args: Any, /) -> Any: ... - -class BaseListProxy(BaseProxy, MutableSequence[_T]): - __builtins__: ClassVar[dict[str, Any]] - def __len__(self) -> int: ... - def __add__(self, x: list[_T], /) -> list[_T]: ... - def __delitem__(self, i: SupportsIndex | slice, /) -> None: ... - @overload - def __getitem__(self, i: SupportsIndex, /) -> _T: ... - @overload - def __getitem__(self, s: slice, /) -> list[_T]: ... - @overload - def __setitem__(self, i: SupportsIndex, o: _T, /) -> None: ... - @overload - def __setitem__(self, s: slice, o: Iterable[_T], /) -> None: ... - def __mul__(self, n: SupportsIndex, /) -> list[_T]: ... - def __rmul__(self, n: SupportsIndex, /) -> list[_T]: ... - def __reversed__(self) -> Iterator[_T]: ... - def append(self, object: _T, /) -> None: ... - def extend(self, iterable: Iterable[_T], /) -> None: ... - def pop(self, index: SupportsIndex = ..., /) -> _T: ... - def index(self, value: _T, start: SupportsIndex = ..., stop: SupportsIndex = ..., /) -> int: ... - def count(self, value: _T, /) -> int: ... - def insert(self, index: SupportsIndex, object: _T, /) -> None: ... - def remove(self, value: _T, /) -> None: ... - # Use BaseListProxy[SupportsRichComparisonT] for the first overload rather than [SupportsRichComparison] - # to work around invariance - @overload - def sort(self: BaseListProxy[SupportsRichComparisonT], *, key: None = None, reverse: bool = ...) -> None: ... - @overload - def sort(self, *, key: Callable[[_T], SupportsRichComparison], reverse: bool = ...) -> None: ... - -class ListProxy(BaseListProxy[_T]): - def __iadd__(self, value: Iterable[_T], /) -> Self: ... # type: ignore[override] - def __imul__(self, value: SupportsIndex, /) -> Self: ... # type: ignore[override] - if sys.version_info >= (3, 13): - def __class_getitem__(cls, args: Any, /) -> Any: ... - -# Returned by BaseManager.get_server() -class Server: - address: Any - def __init__( - self, registry: dict[str, tuple[Callable[..., Any], Any, Any, Any]], address: Any, authkey: bytes, serializer: str - ) -> None: ... - def serve_forever(self) -> None: ... - def accept_connection( - self, c: Connection[tuple[str, str | None], tuple[str, str, Iterable[Incomplete], Mapping[str, Incomplete]]], name: str - ) -> None: ... - -class BaseManager: - if sys.version_info >= (3, 11): - def __init__( - self, - address: Any | None = None, - authkey: bytes | None = None, - serializer: str = "pickle", - ctx: BaseContext | None = None, - *, - shutdown_timeout: float = 1.0, - ) -> None: ... - else: - def __init__( - self, - address: Any | None = None, - authkey: bytes | None = None, - serializer: str = "pickle", - ctx: BaseContext | None = None, - ) -> None: ... - - def get_server(self) -> Server: ... - def connect(self) -> None: ... - def start(self, initializer: Callable[..., object] | None = None, initargs: Iterable[Any] = ()) -> None: ... - def shutdown(self) -> None: ... # only available after start() was called - def join(self, timeout: float | None = None) -> None: ... # undocumented - @property - def address(self) -> Any: ... - @classmethod - def register( - cls, - typeid: str, - callable: Callable[..., object] | None = None, - proxytype: Any = None, - exposed: Sequence[str] | None = None, - method_to_typeid: Mapping[str, str] | None = None, - create_method: bool = True, - ) -> None: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - -class SyncManager(BaseManager): - def BoundedSemaphore(self, value: Any = ...) -> threading.BoundedSemaphore: ... - def Condition(self, lock: Any = ...) -> threading.Condition: ... - def Event(self) -> threading.Event: ... - def Lock(self) -> threading.Lock: ... - def Namespace(self) -> _Namespace: ... - def Queue(self, maxsize: int = ...) -> queue.Queue[Any]: ... - def RLock(self) -> threading.RLock: ... - def Semaphore(self, value: Any = ...) -> threading.Semaphore: ... - def Array(self, typecode: Any, sequence: Sequence[_T]) -> Sequence[_T]: ... - def Value(self, typecode: Any, value: _T) -> ValueProxy[_T]: ... - # Overloads are copied from builtins.dict.__init__ - @overload - def dict(self) -> DictProxy[Any, Any]: ... - @overload - def dict(self, **kwargs: _VT) -> DictProxy[str, _VT]: ... - @overload - def dict(self, map: SupportsKeysAndGetItem[_KT, _VT], /) -> DictProxy[_KT, _VT]: ... - @overload - def dict(self, map: SupportsKeysAndGetItem[str, _VT], /, **kwargs: _VT) -> DictProxy[str, _VT]: ... - @overload - def dict(self, iterable: Iterable[tuple[_KT, _VT]], /) -> DictProxy[_KT, _VT]: ... - @overload - def dict(self, iterable: Iterable[tuple[str, _VT]], /, **kwargs: _VT) -> DictProxy[str, _VT]: ... - @overload - def dict(self, iterable: Iterable[list[str]], /) -> DictProxy[str, str]: ... - @overload - def dict(self, iterable: Iterable[list[bytes]], /) -> DictProxy[bytes, bytes]: ... - @overload - def list(self, sequence: Sequence[_T], /) -> ListProxy[_T]: ... - @overload - def list(self) -> ListProxy[Any]: ... - -class RemoteError(Exception): ... -class SharedMemoryServer(Server): ... - -class SharedMemoryManager(BaseManager): - def get_server(self) -> SharedMemoryServer: ... - def SharedMemory(self, size: int) -> _SharedMemory: ... - def ShareableList(self, sequence: Iterable[_SLT] | None) -> _ShareableList[_SLT]: ... - def __del__(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi deleted file mode 100644 index 581a46ea0bc85..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi +++ /dev/null @@ -1,41 +0,0 @@ -import sys -from typing import Any, Generic, TypeVar - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = ["Queue", "SimpleQueue", "JoinableQueue"] - -_T = TypeVar("_T") - -class Queue(Generic[_T]): - # FIXME: `ctx` is a circular dependency and it's not actually optional. - # It's marked as such to be able to use the generic Queue in __init__.pyi. - def __init__(self, maxsize: int = 0, *, ctx: Any = ...) -> None: ... - def put(self, obj: _T, block: bool = True, timeout: float | None = None) -> None: ... - def get(self, block: bool = True, timeout: float | None = None) -> _T: ... - def qsize(self) -> int: ... - def empty(self) -> bool: ... - def full(self) -> bool: ... - def get_nowait(self) -> _T: ... - def put_nowait(self, obj: _T) -> None: ... - def close(self) -> None: ... - def join_thread(self) -> None: ... - def cancel_join_thread(self) -> None: ... - if sys.version_info >= (3, 12): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class JoinableQueue(Queue[_T]): - def task_done(self) -> None: ... - def join(self) -> None: ... - -class SimpleQueue(Generic[_T]): - def __init__(self, *, ctx: Any = ...) -> None: ... - if sys.version_info >= (3, 9): - def close(self) -> None: ... - - def empty(self) -> bool: ... - def get(self) -> _T: ... - def put(self, obj: _T) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi deleted file mode 100644 index 43ce2f07d9962..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi +++ /dev/null @@ -1,32 +0,0 @@ -from collections.abc import Mapping, Sequence -from types import ModuleType -from typing import Any, Final - -__all__ = [ - "_main", - "freeze_support", - "set_executable", - "get_executable", - "get_preparation_data", - "get_command_line", - "import_main_path", -] - -WINEXE: Final[bool] -WINSERVICE: Final[bool] - -def set_executable(exe: str) -> None: ... -def get_executable() -> str: ... -def is_forking(argv: Sequence[str]) -> bool: ... -def freeze_support() -> None: ... -def get_command_line(**kwds: Any) -> list[str]: ... -def spawn_main(pipe_handle: int, parent_pid: int | None = None, tracker_fd: int | None = None) -> None: ... - -# undocumented -def _main(fd: int) -> Any: ... -def get_preparation_data(name: str) -> dict[str, Any]: ... - -old_main_modules: list[ModuleType] - -def prepare(data: Mapping[str, Any]) -> None: ... -def import_main_path(main_path: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi deleted file mode 100644 index b417925fb17bc..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi +++ /dev/null @@ -1,54 +0,0 @@ -import threading -from collections.abc import Callable -from contextlib import AbstractContextManager -from multiprocessing.context import BaseContext -from types import TracebackType -from typing_extensions import TypeAlias - -__all__ = ["Lock", "RLock", "Semaphore", "BoundedSemaphore", "Condition", "Event"] - -_LockLike: TypeAlias = Lock | RLock - -class Barrier(threading.Barrier): - def __init__( - self, parties: int, action: Callable[[], object] | None = None, timeout: float | None = None, *ctx: BaseContext - ) -> None: ... - -class Condition(AbstractContextManager[bool, None]): - def __init__(self, lock: _LockLike | None = None, *, ctx: BaseContext) -> None: ... - def notify(self, n: int = 1) -> None: ... - def notify_all(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - def wait_for(self, predicate: Callable[[], bool], timeout: float | None = None) -> bool: ... - def acquire(self, block: bool = ..., timeout: float | None = ...) -> bool: ... - def release(self) -> None: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None, / - ) -> None: ... - -class Event: - def __init__(self, *, ctx: BaseContext) -> None: ... - def is_set(self) -> bool: ... - def set(self) -> None: ... - def clear(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - -# Not part of public API -class SemLock(AbstractContextManager[bool, None]): - def acquire(self, block: bool = ..., timeout: float | None = ...) -> bool: ... - def release(self) -> None: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None, / - ) -> None: ... - -class Lock(SemLock): - def __init__(self, *, ctx: BaseContext) -> None: ... - -class RLock(SemLock): - def __init__(self, *, ctx: BaseContext) -> None: ... - -class Semaphore(SemLock): - def __init__(self, value: int = 1, *, ctx: BaseContext) -> None: ... - -class BoundedSemaphore(Semaphore): - def __init__(self, value: int = 1, *, ctx: BaseContext) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/nturl2path.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/nturl2path.pyi deleted file mode 100644 index b8ad8d6821554..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/nturl2path.pyi +++ /dev/null @@ -1,2 +0,0 @@ -def url2pathname(url: str) -> str: ... -def pathname2url(p: str) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/opcode.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/opcode.pyi deleted file mode 100644 index f9f76962f8765..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/opcode.pyi +++ /dev/null @@ -1,63 +0,0 @@ -import sys -from typing import Literal - -__all__ = [ - "cmp_op", - "hasconst", - "hasname", - "hasjrel", - "hasjabs", - "haslocal", - "hascompare", - "hasfree", - "opname", - "opmap", - "HAVE_ARGUMENT", - "EXTENDED_ARG", - "stack_effect", -] -if sys.version_info >= (3, 12): - __all__ += ["hasarg", "hasexc"] -else: - __all__ += ["hasnargs"] -if sys.version_info >= (3, 13): - __all__ += ["hasjump"] - -if sys.version_info >= (3, 9): - cmp_op: tuple[Literal["<"], Literal["<="], Literal["=="], Literal["!="], Literal[">"], Literal[">="]] -else: - cmp_op: tuple[ - Literal["<"], - Literal["<="], - Literal["=="], - Literal["!="], - Literal[">"], - Literal[">="], - Literal["in"], - Literal["not in"], - Literal["is"], - Literal["is not"], - Literal["exception match"], - Literal["BAD"], - ] -hasconst: list[int] -hasname: list[int] -hasjrel: list[int] -hasjabs: list[int] -haslocal: list[int] -hascompare: list[int] -hasfree: list[int] -if sys.version_info >= (3, 12): - hasarg: list[int] - hasexc: list[int] -else: - hasnargs: list[int] -if sys.version_info >= (3, 13): - hasjump: list[int] -opname: list[str] - -opmap: dict[str, int] -HAVE_ARGUMENT: int -EXTENDED_ARG: int - -def stack_effect(opcode: int, oparg: int | None = None, /, *, jump: bool | None = None) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/optparse.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/optparse.pyi deleted file mode 100644 index b513bb6470605..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/optparse.pyi +++ /dev/null @@ -1,255 +0,0 @@ -from _typeshed import Incomplete -from abc import abstractmethod -from collections.abc import Callable, Iterable, Mapping, Sequence -from typing import IO, Any, AnyStr, Literal, NoReturn, overload - -__all__ = [ - "Option", - "make_option", - "SUPPRESS_HELP", - "SUPPRESS_USAGE", - "Values", - "OptionContainer", - "OptionGroup", - "OptionParser", - "HelpFormatter", - "IndentedHelpFormatter", - "TitledHelpFormatter", - "OptParseError", - "OptionError", - "OptionConflictError", - "OptionValueError", - "BadOptionError", - "check_choice", -] - -NO_DEFAULT: tuple[str, ...] -SUPPRESS_HELP: str -SUPPRESS_USAGE: str - -def check_builtin(option: Option, opt, value: str): ... -def check_choice(option: Option, opt, value: str) -> str: ... - -class OptParseError(Exception): - msg: str - def __init__(self, msg: str) -> None: ... - -class BadOptionError(OptParseError): - opt_str: str - def __init__(self, opt_str: str) -> None: ... - -class AmbiguousOptionError(BadOptionError): - possibilities: Iterable[str] - def __init__(self, opt_str: str, possibilities: Sequence[str]) -> None: ... - -class OptionError(OptParseError): - option_id: str - def __init__(self, msg: str, option: Option) -> None: ... - -class OptionConflictError(OptionError): ... -class OptionValueError(OptParseError): ... - -class HelpFormatter: - NO_DEFAULT_VALUE: str - _long_opt_fmt: str - _short_opt_fmt: str - current_indent: int - default_tag: str - help_position: int - help_width: int | Any # initialized as None and computed later as int when storing option strings - indent_increment: int - level: int - max_help_position: int - option_strings: dict[Option, str] - parser: OptionParser - short_first: Incomplete - width: int - def __init__(self, indent_increment: int, max_help_position: int, width: int | None, short_first: int) -> None: ... - def dedent(self) -> None: ... - def expand_default(self, option: Option) -> str: ... - def format_description(self, description: str | None) -> str: ... - def format_epilog(self, epilog: str | None) -> str: ... - @abstractmethod - def format_heading(self, heading: str) -> str: ... - def format_option(self, option: Option) -> str: ... - def format_option_strings(self, option: Option) -> str: ... - @abstractmethod - def format_usage(self, usage: str) -> str: ... - def indent(self) -> None: ... - def set_long_opt_delimiter(self, delim: str) -> None: ... - def set_parser(self, parser: OptionParser) -> None: ... - def set_short_opt_delimiter(self, delim: str) -> None: ... - def store_option_strings(self, parser: OptionParser) -> None: ... - -class IndentedHelpFormatter(HelpFormatter): - def __init__( - self, indent_increment: int = 2, max_help_position: int = 24, width: int | None = None, short_first: int = 1 - ) -> None: ... - def format_heading(self, heading: str) -> str: ... - def format_usage(self, usage: str) -> str: ... - -class TitledHelpFormatter(HelpFormatter): - def __init__( - self, indent_increment: int = 0, max_help_position: int = 24, width: int | None = None, short_first: int = 0 - ) -> None: ... - def format_heading(self, heading: str) -> str: ... - def format_usage(self, usage: str) -> str: ... - -class Option: - ACTIONS: tuple[str, ...] - ALWAYS_TYPED_ACTIONS: tuple[str, ...] - ATTRS: list[str] - CHECK_METHODS: list[Callable[..., Incomplete]] | None - CONST_ACTIONS: tuple[str, ...] - STORE_ACTIONS: tuple[str, ...] - TYPED_ACTIONS: tuple[str, ...] - TYPES: tuple[str, ...] - TYPE_CHECKER: dict[str, Callable[[Option, str, Incomplete], Any]] - _long_opts: list[str] - _short_opts: list[str] - action: str - dest: str | None - default: Incomplete - nargs: int - type: Incomplete - callback: Callable[..., Incomplete] | None - callback_args: tuple[Incomplete, ...] | None - callback_kwargs: dict[str, Incomplete] | None - help: str | None - metavar: str | None - def __init__(self, *opts: str | None, **attrs) -> None: ... - def _check_action(self) -> None: ... - def _check_callback(self) -> None: ... - def _check_choice(self) -> None: ... - def _check_const(self) -> None: ... - def _check_dest(self) -> None: ... - def _check_nargs(self) -> None: ... - def _check_opt_strings(self, opts: Iterable[str | None]) -> list[str]: ... - def _check_type(self) -> None: ... - def _set_attrs(self, attrs: dict[str, Incomplete]) -> None: ... - def _set_opt_strings(self, opts: Iterable[str]) -> None: ... - def check_value(self, opt: str, value): ... - def convert_value(self, opt: str, value): ... - def get_opt_string(self) -> str: ... - def process(self, opt, value, values, parser: OptionParser) -> int: ... - def take_action(self, action: str, dest: str, opt, value, values, parser: OptionParser) -> int: ... - def takes_value(self) -> bool: ... - -make_option = Option - -class OptionContainer: - _long_opt: dict[str, Option] - _short_opt: dict[str, Option] - conflict_handler: str - defaults: dict[str, Incomplete] - description: str | None - option_class: type[Option] - def __init__( - self, option_class: type[Option], conflict_handler: Literal["error", "resolve"], description: str | None - ) -> None: ... - def _check_conflict(self, option: Option) -> None: ... - def _create_option_mappings(self) -> None: ... - def _share_option_mappings(self, parser: OptionParser) -> None: ... - @overload - def add_option(self, opt: Option, /) -> Option: ... - @overload - def add_option(self, arg: str, /, *args: str | None, **kwargs) -> Option: ... - def add_options(self, option_list: Iterable[Option]) -> None: ... - def destroy(self) -> None: ... - def format_option_help(self, formatter: HelpFormatter) -> str: ... - def format_description(self, formatter: HelpFormatter) -> str: ... - def format_help(self, formatter: HelpFormatter) -> str: ... - def get_description(self) -> str | None: ... - def get_option(self, opt_str: str) -> Option | None: ... - def has_option(self, opt_str: str) -> bool: ... - def remove_option(self, opt_str: str) -> None: ... - def set_conflict_handler(self, handler: Literal["error", "resolve"]) -> None: ... - def set_description(self, description: str | None) -> None: ... - -class OptionGroup(OptionContainer): - option_list: list[Option] - parser: OptionParser - title: str - def __init__(self, parser: OptionParser, title: str, description: str | None = None) -> None: ... - def _create_option_list(self) -> None: ... - def set_title(self, title: str) -> None: ... - -class Values: - def __init__(self, defaults: Mapping[str, Incomplete] | None = None) -> None: ... - def _update(self, dict: Mapping[str, Incomplete], mode) -> None: ... - def _update_careful(self, dict: Mapping[str, Incomplete]) -> None: ... - def _update_loose(self, dict: Mapping[str, Incomplete]) -> None: ... - def ensure_value(self, attr: str, value): ... - def read_file(self, filename: str, mode: str = "careful") -> None: ... - def read_module(self, modname: str, mode: str = "careful") -> None: ... - def __getattr__(self, name: str): ... - def __setattr__(self, name: str, value, /) -> None: ... - def __eq__(self, other: object) -> bool: ... - -class OptionParser(OptionContainer): - allow_interspersed_args: bool - epilog: str | None - formatter: HelpFormatter - largs: list[str] | None - option_groups: list[OptionGroup] - option_list: list[Option] - process_default_values: bool - prog: str | None - rargs: list[str] | None - standard_option_list: list[Option] - usage: str | None - values: Values | None - version: str - def __init__( - self, - usage: str | None = None, - option_list: Iterable[Option] | None = None, - option_class: type[Option] = ..., - version: str | None = None, - conflict_handler: str = "error", - description: str | None = None, - formatter: HelpFormatter | None = None, - add_help_option: bool = True, - prog: str | None = None, - epilog: str | None = None, - ) -> None: ... - def _add_help_option(self) -> None: ... - def _add_version_option(self) -> None: ... - def _create_option_list(self) -> None: ... - def _get_all_options(self) -> list[Option]: ... - def _get_args(self, args: Iterable[Incomplete]) -> list[Incomplete]: ... - def _init_parsing_state(self) -> None: ... - def _match_long_opt(self, opt: str) -> str: ... - def _populate_option_list(self, option_list: Iterable[Option], add_help: bool = True) -> None: ... - def _process_args(self, largs: list[Incomplete], rargs: list[Incomplete], values: Values) -> None: ... - def _process_long_opt(self, rargs: list[Incomplete], values) -> None: ... - def _process_short_opts(self, rargs: list[Incomplete], values) -> None: ... - @overload - def add_option_group(self, opt_group: OptionGroup, /) -> OptionGroup: ... - @overload - def add_option_group(self, *args, **kwargs) -> OptionGroup: ... - def check_values(self, values: Values, args: list[str]) -> tuple[Values, list[str]]: ... - def disable_interspersed_args(self) -> None: ... - def enable_interspersed_args(self) -> None: ... - def error(self, msg: str) -> NoReturn: ... - def exit(self, status: int = 0, msg: str | None = None) -> NoReturn: ... - def expand_prog_name(self, s: str) -> str: ... - def format_epilog(self, formatter: HelpFormatter) -> str: ... - def format_help(self, formatter: HelpFormatter | None = None) -> str: ... - def format_option_help(self, formatter: HelpFormatter | None = None) -> str: ... - def get_default_values(self) -> Values: ... - def get_option_group(self, opt_str: str) -> OptionGroup | None: ... - def get_prog_name(self) -> str: ... - def get_usage(self) -> str: ... - def get_version(self) -> str: ... - @overload - def parse_args(self, args: None = None, values: Values | None = None) -> tuple[Values, list[str]]: ... - @overload - def parse_args(self, args: Sequence[AnyStr], values: Values | None = None) -> tuple[Values, list[AnyStr]]: ... - def print_usage(self, file: IO[str] | None = None) -> None: ... - def print_help(self, file: IO[str] | None = None) -> None: ... - def print_version(self, file: IO[str] | None = None) -> None: ... - def set_default(self, dest, value) -> None: ... - def set_defaults(self, **kwargs) -> None: ... - def set_process_default_values(self, process) -> None: ... - def set_usage(self, usage: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/os/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/os/__init__.pyi deleted file mode 100644 index 833f9b1e56cbf..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/os/__init__.pyi +++ /dev/null @@ -1,1205 +0,0 @@ -import sys -from _typeshed import ( - AnyStr_co, - BytesPath, - FileDescriptor, - FileDescriptorLike, - FileDescriptorOrPath, - GenericPath, - OpenBinaryMode, - OpenBinaryModeReading, - OpenBinaryModeUpdating, - OpenBinaryModeWriting, - OpenTextMode, - ReadableBuffer, - StrOrBytesPath, - StrPath, - SupportsLenAndGetItem, - Unused, - WriteableBuffer, - structseq, -) -from abc import abstractmethod -from builtins import OSError -from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping, Sequence -from contextlib import AbstractContextManager -from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper -from subprocess import Popen -from types import TracebackType -from typing import ( - IO, - Any, - AnyStr, - BinaryIO, - Final, - Generic, - Literal, - NoReturn, - Protocol, - TypeVar, - final, - overload, - runtime_checkable, -) -from typing_extensions import Self, TypeAlias, Unpack, deprecated - -from . import path as _path - -if sys.version_info >= (3, 9): - from types import GenericAlias - -# This unnecessary alias is to work around various errors -path = _path - -_T = TypeVar("_T") -_T1 = TypeVar("_T1") -_T2 = TypeVar("_T2") - -# ----- os variables ----- - -error = OSError - -supports_bytes_environ: bool - -supports_dir_fd: set[Callable[..., Any]] -supports_fd: set[Callable[..., Any]] -supports_effective_ids: set[Callable[..., Any]] -supports_follow_symlinks: set[Callable[..., Any]] - -if sys.platform != "win32": - # Unix only - PRIO_PROCESS: int - PRIO_PGRP: int - PRIO_USER: int - - F_LOCK: int - F_TLOCK: int - F_ULOCK: int - F_TEST: int - - if sys.platform != "darwin": - POSIX_FADV_NORMAL: int - POSIX_FADV_SEQUENTIAL: int - POSIX_FADV_RANDOM: int - POSIX_FADV_NOREUSE: int - POSIX_FADV_WILLNEED: int - POSIX_FADV_DONTNEED: int - - if sys.platform != "linux" and sys.platform != "darwin": - # In the os-module docs, these are marked as being available - # on "Unix, not Emscripten, not WASI." - # However, in the source code, a comment indicates they're "FreeBSD constants". - # sys.platform could have one of many values on a FreeBSD Python build, - # so the sys-module docs recommend doing `if sys.platform.startswith('freebsd')` - # to detect FreeBSD builds. Unfortunately that would be too dynamic - # for type checkers, however. - SF_NODISKIO: int - SF_MNOWAIT: int - SF_SYNC: int - - if sys.version_info >= (3, 11): - SF_NOCACHE: int - - if sys.platform == "linux": - XATTR_SIZE_MAX: int - XATTR_CREATE: int - XATTR_REPLACE: int - - P_PID: int - P_PGID: int - P_ALL: int - - if sys.platform == "linux" and sys.version_info >= (3, 9): - P_PIDFD: int - - WEXITED: int - WSTOPPED: int - WNOWAIT: int - - CLD_EXITED: int - CLD_DUMPED: int - CLD_TRAPPED: int - CLD_CONTINUED: int - - if sys.version_info >= (3, 9): - CLD_KILLED: int - CLD_STOPPED: int - - # TODO: SCHED_RESET_ON_FORK not available on darwin? - # TODO: SCHED_BATCH and SCHED_IDLE are linux only? - SCHED_OTHER: int # some flavors of Unix - SCHED_BATCH: int # some flavors of Unix - SCHED_IDLE: int # some flavors of Unix - SCHED_SPORADIC: int # some flavors of Unix - SCHED_FIFO: int # some flavors of Unix - SCHED_RR: int # some flavors of Unix - SCHED_RESET_ON_FORK: int # some flavors of Unix - -if sys.platform != "win32": - RTLD_LAZY: int - RTLD_NOW: int - RTLD_GLOBAL: int - RTLD_LOCAL: int - RTLD_NODELETE: int - RTLD_NOLOAD: int - -if sys.platform == "linux": - RTLD_DEEPBIND: int - GRND_NONBLOCK: int - GRND_RANDOM: int - -if sys.platform == "darwin" and sys.version_info >= (3, 12): - PRIO_DARWIN_BG: int - PRIO_DARWIN_NONUI: int - PRIO_DARWIN_PROCESS: int - PRIO_DARWIN_THREAD: int - -SEEK_SET: int -SEEK_CUR: int -SEEK_END: int -if sys.platform != "win32": - SEEK_DATA: int # some flavors of Unix - SEEK_HOLE: int # some flavors of Unix - -O_RDONLY: int -O_WRONLY: int -O_RDWR: int -O_APPEND: int -O_CREAT: int -O_EXCL: int -O_TRUNC: int -# We don't use sys.platform for O_* flags to denote platform-dependent APIs because some codes, -# including tests for mypy, use a more finer way than sys.platform before using these APIs -# See https://github.com/python/typeshed/pull/2286 for discussions -O_DSYNC: int # Unix only -O_RSYNC: int # Unix only -O_SYNC: int # Unix only -O_NDELAY: int # Unix only -O_NONBLOCK: int # Unix only -O_NOCTTY: int # Unix only -O_CLOEXEC: int # Unix only -O_SHLOCK: int # Unix only -O_EXLOCK: int # Unix only -O_BINARY: int # Windows only -O_NOINHERIT: int # Windows only -O_SHORT_LIVED: int # Windows only -O_TEMPORARY: int # Windows only -O_RANDOM: int # Windows only -O_SEQUENTIAL: int # Windows only -O_TEXT: int # Windows only -O_ASYNC: int # Gnu extension if in C library -O_DIRECT: int # Gnu extension if in C library -O_DIRECTORY: int # Gnu extension if in C library -O_NOFOLLOW: int # Gnu extension if in C library -O_NOATIME: int # Gnu extension if in C library -O_PATH: int # Gnu extension if in C library -O_TMPFILE: int # Gnu extension if in C library -O_LARGEFILE: int # Gnu extension if in C library -O_ACCMODE: int # TODO: when does this exist? - -if sys.platform != "win32" and sys.platform != "darwin": - # posix, but apparently missing on macos - ST_APPEND: int - ST_MANDLOCK: int - ST_NOATIME: int - ST_NODEV: int - ST_NODIRATIME: int - ST_NOEXEC: int - ST_RELATIME: int - ST_SYNCHRONOUS: int - ST_WRITE: int - -if sys.platform != "win32": - NGROUPS_MAX: int - ST_NOSUID: int - ST_RDONLY: int - -curdir: str -pardir: str -sep: str -if sys.platform == "win32": - altsep: str -else: - altsep: str | None -extsep: str -pathsep: str -defpath: str -linesep: str -devnull: str -name: str - -F_OK: int -R_OK: int -W_OK: int -X_OK: int - -_EnvironCodeFunc: TypeAlias = Callable[[AnyStr], AnyStr] - -class _Environ(MutableMapping[AnyStr, AnyStr], Generic[AnyStr]): - encodekey: _EnvironCodeFunc[AnyStr] - decodekey: _EnvironCodeFunc[AnyStr] - encodevalue: _EnvironCodeFunc[AnyStr] - decodevalue: _EnvironCodeFunc[AnyStr] - if sys.version_info >= (3, 9): - def __init__( - self, - data: MutableMapping[AnyStr, AnyStr], - encodekey: _EnvironCodeFunc[AnyStr], - decodekey: _EnvironCodeFunc[AnyStr], - encodevalue: _EnvironCodeFunc[AnyStr], - decodevalue: _EnvironCodeFunc[AnyStr], - ) -> None: ... - else: - putenv: Callable[[AnyStr, AnyStr], object] - unsetenv: Callable[[AnyStr, AnyStr], object] - def __init__( - self, - data: MutableMapping[AnyStr, AnyStr], - encodekey: _EnvironCodeFunc[AnyStr], - decodekey: _EnvironCodeFunc[AnyStr], - encodevalue: _EnvironCodeFunc[AnyStr], - decodevalue: _EnvironCodeFunc[AnyStr], - putenv: Callable[[AnyStr, AnyStr], object], - unsetenv: Callable[[AnyStr, AnyStr], object], - ) -> None: ... - - def setdefault(self, key: AnyStr, value: AnyStr) -> AnyStr: ... - def copy(self) -> dict[AnyStr, AnyStr]: ... - def __delitem__(self, key: AnyStr) -> None: ... - def __getitem__(self, key: AnyStr) -> AnyStr: ... - def __setitem__(self, key: AnyStr, value: AnyStr) -> None: ... - def __iter__(self) -> Iterator[AnyStr]: ... - def __len__(self) -> int: ... - if sys.version_info >= (3, 9): - def __or__(self, other: Mapping[_T1, _T2]) -> dict[AnyStr | _T1, AnyStr | _T2]: ... - def __ror__(self, other: Mapping[_T1, _T2]) -> dict[AnyStr | _T1, AnyStr | _T2]: ... - # We use @overload instead of a Union for reasons similar to those given for - # overloading MutableMapping.update in stdlib/typing.pyi - # The type: ignore is needed due to incompatible __or__/__ior__ signatures - @overload # type: ignore[misc] - def __ior__(self, other: Mapping[AnyStr, AnyStr]) -> Self: ... - @overload - def __ior__(self, other: Iterable[tuple[AnyStr, AnyStr]]) -> Self: ... - -environ: _Environ[str] -if sys.platform != "win32": - environb: _Environ[bytes] - -if sys.version_info >= (3, 11) or sys.platform != "win32": - EX_OK: int - -if sys.platform != "win32": - confstr_names: dict[str, int] - pathconf_names: dict[str, int] - sysconf_names: dict[str, int] - - EX_USAGE: int - EX_DATAERR: int - EX_NOINPUT: int - EX_NOUSER: int - EX_NOHOST: int - EX_UNAVAILABLE: int - EX_SOFTWARE: int - EX_OSERR: int - EX_OSFILE: int - EX_CANTCREAT: int - EX_IOERR: int - EX_TEMPFAIL: int - EX_PROTOCOL: int - EX_NOPERM: int - EX_CONFIG: int - -# Exists on some Unix platforms, e.g. Solaris. -if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": - EX_NOTFOUND: int - -P_NOWAIT: int -P_NOWAITO: int -P_WAIT: int -if sys.platform == "win32": - P_DETACH: int - P_OVERLAY: int - -# wait()/waitpid() options -if sys.platform != "win32": - WNOHANG: int # Unix only - WCONTINUED: int # some Unix systems - WUNTRACED: int # Unix only - -TMP_MAX: int # Undocumented, but used by tempfile - -# ----- os classes (structures) ----- -@final -class stat_result(structseq[float], tuple[int, int, int, int, int, int, int, float, float, float]): - # The constructor of this class takes an iterable of variable length (though it must be at least 10). - # - # However, this class behaves like a tuple of 10 elements, - # no matter how long the iterable supplied to the constructor is. - # https://github.com/python/typeshed/pull/6560#discussion_r767162532 - # - # The 10 elements always present are st_mode, st_ino, st_dev, st_nlink, - # st_uid, st_gid, st_size, st_atime, st_mtime, st_ctime. - # - # More items may be added at the end by some implementations. - if sys.version_info >= (3, 10): - __match_args__: Final = ("st_mode", "st_ino", "st_dev", "st_nlink", "st_uid", "st_gid", "st_size") - - @property - def st_mode(self) -> int: ... # protection bits, - @property - def st_ino(self) -> int: ... # inode number, - @property - def st_dev(self) -> int: ... # device, - @property - def st_nlink(self) -> int: ... # number of hard links, - @property - def st_uid(self) -> int: ... # user id of owner, - @property - def st_gid(self) -> int: ... # group id of owner, - @property - def st_size(self) -> int: ... # size of file, in bytes, - @property - def st_atime(self) -> float: ... # time of most recent access, - @property - def st_mtime(self) -> float: ... # time of most recent content modification, - # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows) - if sys.version_info >= (3, 12) and sys.platform == "win32": - @property - @deprecated( - """\ -Use st_birthtime instead to retrieve the file creation time. \ -In the future, this property will contain the last metadata change time.""" - ) - def st_ctime(self) -> float: ... - else: - @property - def st_ctime(self) -> float: ... - - @property - def st_atime_ns(self) -> int: ... # time of most recent access, in nanoseconds - @property - def st_mtime_ns(self) -> int: ... # time of most recent content modification in nanoseconds - # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows) in nanoseconds - @property - def st_ctime_ns(self) -> int: ... - if sys.platform == "win32": - @property - def st_file_attributes(self) -> int: ... - @property - def st_reparse_tag(self) -> int: ... - if sys.version_info >= (3, 12): - @property - def st_birthtime(self) -> float: ... # time of file creation in seconds - @property - def st_birthtime_ns(self) -> int: ... # time of file creation in nanoseconds - else: - @property - def st_blocks(self) -> int: ... # number of blocks allocated for file - @property - def st_blksize(self) -> int: ... # filesystem blocksize - @property - def st_rdev(self) -> int: ... # type of device if an inode device - if sys.platform != "linux": - # These properties are available on MacOS, but not Ubuntu. - # On other Unix systems (such as FreeBSD), the following attributes may be - # available (but may be only filled out if root tries to use them): - @property - def st_gen(self) -> int: ... # file generation number - @property - def st_birthtime(self) -> float: ... # time of file creation in seconds - if sys.platform == "darwin": - @property - def st_flags(self) -> int: ... # user defined flags for file - # Attributes documented as sometimes appearing, but deliberately omitted from the stub: `st_creator`, `st_rsize`, `st_type`. - # See https://github.com/python/typeshed/pull/6560#issuecomment-991253327 - -@runtime_checkable -class PathLike(Protocol[AnyStr_co]): - @abstractmethod - def __fspath__(self) -> AnyStr_co: ... - -@overload -def listdir(path: StrPath | None = None) -> list[str]: ... -@overload -def listdir(path: BytesPath) -> list[bytes]: ... -@overload -def listdir(path: int) -> list[str]: ... -@final -class DirEntry(Generic[AnyStr]): - # This is what the scandir iterator yields - # The constructor is hidden - - @property - def name(self) -> AnyStr: ... - @property - def path(self) -> AnyStr: ... - def inode(self) -> int: ... - def is_dir(self, *, follow_symlinks: bool = True) -> bool: ... - def is_file(self, *, follow_symlinks: bool = True) -> bool: ... - def is_symlink(self) -> bool: ... - def stat(self, *, follow_symlinks: bool = True) -> stat_result: ... - def __fspath__(self) -> AnyStr: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - if sys.version_info >= (3, 12): - def is_junction(self) -> bool: ... - -@final -class statvfs_result(structseq[int], tuple[int, int, int, int, int, int, int, int, int, int, int]): - if sys.version_info >= (3, 10): - __match_args__: Final = ( - "f_bsize", - "f_frsize", - "f_blocks", - "f_bfree", - "f_bavail", - "f_files", - "f_ffree", - "f_favail", - "f_flag", - "f_namemax", - ) - - @property - def f_bsize(self) -> int: ... - @property - def f_frsize(self) -> int: ... - @property - def f_blocks(self) -> int: ... - @property - def f_bfree(self) -> int: ... - @property - def f_bavail(self) -> int: ... - @property - def f_files(self) -> int: ... - @property - def f_ffree(self) -> int: ... - @property - def f_favail(self) -> int: ... - @property - def f_flag(self) -> int: ... - @property - def f_namemax(self) -> int: ... - @property - def f_fsid(self) -> int: ... - -# ----- os function stubs ----- -def fsencode(filename: StrOrBytesPath) -> bytes: ... -def fsdecode(filename: StrOrBytesPath) -> str: ... -@overload -def fspath(path: str) -> str: ... -@overload -def fspath(path: bytes) -> bytes: ... -@overload -def fspath(path: PathLike[AnyStr]) -> AnyStr: ... -def get_exec_path(env: Mapping[str, str] | None = None) -> list[str]: ... -def getlogin() -> str: ... -def getpid() -> int: ... -def getppid() -> int: ... -def strerror(code: int, /) -> str: ... -def umask(mask: int, /) -> int: ... -@final -class uname_result(structseq[str], tuple[str, str, str, str, str]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("sysname", "nodename", "release", "version", "machine") - - @property - def sysname(self) -> str: ... - @property - def nodename(self) -> str: ... - @property - def release(self) -> str: ... - @property - def version(self) -> str: ... - @property - def machine(self) -> str: ... - -if sys.platform != "win32": - def ctermid() -> str: ... - def getegid() -> int: ... - def geteuid() -> int: ... - def getgid() -> int: ... - def getgrouplist(user: str, group: int, /) -> list[int]: ... - def getgroups() -> list[int]: ... # Unix only, behaves differently on Mac - def initgroups(username: str, gid: int, /) -> None: ... - def getpgid(pid: int) -> int: ... - def getpgrp() -> int: ... - def getpriority(which: int, who: int) -> int: ... - def setpriority(which: int, who: int, priority: int) -> None: ... - if sys.platform != "darwin": - def getresuid() -> tuple[int, int, int]: ... - def getresgid() -> tuple[int, int, int]: ... - - def getuid() -> int: ... - def setegid(egid: int, /) -> None: ... - def seteuid(euid: int, /) -> None: ... - def setgid(gid: int, /) -> None: ... - def setgroups(groups: Sequence[int], /) -> None: ... - def setpgrp() -> None: ... - def setpgid(pid: int, pgrp: int, /) -> None: ... - def setregid(rgid: int, egid: int, /) -> None: ... - if sys.platform != "darwin": - def setresgid(rgid: int, egid: int, sgid: int, /) -> None: ... - def setresuid(ruid: int, euid: int, suid: int, /) -> None: ... - - def setreuid(ruid: int, euid: int, /) -> None: ... - def getsid(pid: int, /) -> int: ... - def setsid() -> None: ... - def setuid(uid: int, /) -> None: ... - def uname() -> uname_result: ... - -@overload -def getenv(key: str) -> str | None: ... -@overload -def getenv(key: str, default: _T) -> str | _T: ... - -if sys.platform != "win32": - @overload - def getenvb(key: bytes) -> bytes | None: ... - @overload - def getenvb(key: bytes, default: _T) -> bytes | _T: ... - def putenv(name: StrOrBytesPath, value: StrOrBytesPath, /) -> None: ... - def unsetenv(name: StrOrBytesPath, /) -> None: ... - -else: - def putenv(name: str, value: str, /) -> None: ... - - if sys.version_info >= (3, 9): - def unsetenv(name: str, /) -> None: ... - -_Opener: TypeAlias = Callable[[str, int], int] - -@overload -def fdopen( - fd: int, - mode: OpenTextMode = "r", - buffering: int = -1, - encoding: str | None = None, - errors: str | None = ..., - newline: str | None = ..., - closefd: bool = ..., - opener: _Opener | None = ..., -) -> TextIOWrapper: ... -@overload -def fdopen( - fd: int, - mode: OpenBinaryMode, - buffering: Literal[0], - encoding: None = None, - errors: None = None, - newline: None = None, - closefd: bool = ..., - opener: _Opener | None = ..., -) -> FileIO: ... -@overload -def fdopen( - fd: int, - mode: OpenBinaryModeUpdating, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - closefd: bool = ..., - opener: _Opener | None = ..., -) -> BufferedRandom: ... -@overload -def fdopen( - fd: int, - mode: OpenBinaryModeWriting, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - closefd: bool = ..., - opener: _Opener | None = ..., -) -> BufferedWriter: ... -@overload -def fdopen( - fd: int, - mode: OpenBinaryModeReading, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - closefd: bool = ..., - opener: _Opener | None = ..., -) -> BufferedReader: ... -@overload -def fdopen( - fd: int, - mode: OpenBinaryMode, - buffering: int = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - closefd: bool = ..., - opener: _Opener | None = ..., -) -> BinaryIO: ... -@overload -def fdopen( - fd: int, - mode: str, - buffering: int = -1, - encoding: str | None = None, - errors: str | None = ..., - newline: str | None = ..., - closefd: bool = ..., - opener: _Opener | None = ..., -) -> IO[Any]: ... -def close(fd: int) -> None: ... -def closerange(fd_low: int, fd_high: int, /) -> None: ... -def device_encoding(fd: int) -> str | None: ... -def dup(fd: int, /) -> int: ... -def dup2(fd: int, fd2: int, inheritable: bool = True) -> int: ... -def fstat(fd: int) -> stat_result: ... -def ftruncate(fd: int, length: int, /) -> None: ... -def fsync(fd: FileDescriptorLike) -> None: ... -def isatty(fd: int, /) -> bool: ... - -if sys.platform != "win32" and sys.version_info >= (3, 11): - def login_tty(fd: int, /) -> None: ... - -if sys.version_info >= (3, 11): - def lseek(fd: int, position: int, whence: int, /) -> int: ... - -else: - def lseek(fd: int, position: int, how: int, /) -> int: ... - -def open(path: StrOrBytesPath, flags: int, mode: int = 0o777, *, dir_fd: int | None = None) -> int: ... -def pipe() -> tuple[int, int]: ... -def read(fd: int, length: int, /) -> bytes: ... - -if sys.version_info >= (3, 12) or sys.platform != "win32": - def get_blocking(fd: int, /) -> bool: ... - def set_blocking(fd: int, blocking: bool, /) -> None: ... - -if sys.platform != "win32": - def fchown(fd: int, uid: int, gid: int) -> None: ... - def fpathconf(fd: int, name: str | int, /) -> int: ... - def fstatvfs(fd: int, /) -> statvfs_result: ... - def lockf(fd: int, command: int, length: int, /) -> None: ... - def openpty() -> tuple[int, int]: ... # some flavors of Unix - if sys.platform != "darwin": - def fdatasync(fd: FileDescriptorLike) -> None: ... - def pipe2(flags: int, /) -> tuple[int, int]: ... # some flavors of Unix - def posix_fallocate(fd: int, offset: int, length: int, /) -> None: ... - def posix_fadvise(fd: int, offset: int, length: int, advice: int, /) -> None: ... - - def pread(fd: int, length: int, offset: int, /) -> bytes: ... - def pwrite(fd: int, buffer: ReadableBuffer, offset: int, /) -> int: ... - # In CI, stubtest sometimes reports that these are available on MacOS, sometimes not - def preadv(fd: int, buffers: SupportsLenAndGetItem[WriteableBuffer], offset: int, flags: int = 0, /) -> int: ... - def pwritev(fd: int, buffers: SupportsLenAndGetItem[ReadableBuffer], offset: int, flags: int = 0, /) -> int: ... - if sys.platform != "darwin": - if sys.version_info >= (3, 10): - RWF_APPEND: int # docs say available on 3.7+, stubtest says otherwise - RWF_DSYNC: int - RWF_SYNC: int - RWF_HIPRI: int - RWF_NOWAIT: int - - if sys.platform == "linux": - def sendfile(out_fd: FileDescriptor, in_fd: FileDescriptor, offset: int | None, count: int) -> int: ... - else: - def sendfile( - out_fd: FileDescriptor, - in_fd: FileDescriptor, - offset: int, - count: int, - headers: Sequence[ReadableBuffer] = ..., - trailers: Sequence[ReadableBuffer] = ..., - flags: int = 0, - ) -> int: ... # FreeBSD and Mac OS X only - - def readv(fd: int, buffers: SupportsLenAndGetItem[WriteableBuffer], /) -> int: ... - def writev(fd: int, buffers: SupportsLenAndGetItem[ReadableBuffer], /) -> int: ... - -@final -class terminal_size(structseq[int], tuple[int, int]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("columns", "lines") - - @property - def columns(self) -> int: ... - @property - def lines(self) -> int: ... - -def get_terminal_size(fd: int = ..., /) -> terminal_size: ... -def get_inheritable(fd: int, /) -> bool: ... -def set_inheritable(fd: int, inheritable: bool, /) -> None: ... - -if sys.platform == "win32": - def get_handle_inheritable(handle: int, /) -> bool: ... - def set_handle_inheritable(handle: int, inheritable: bool, /) -> None: ... - -if sys.platform != "win32": - # Unix only - def tcgetpgrp(fd: int, /) -> int: ... - def tcsetpgrp(fd: int, pgid: int, /) -> None: ... - def ttyname(fd: int, /) -> str: ... - -def write(fd: int, data: ReadableBuffer, /) -> int: ... -def access( - path: FileDescriptorOrPath, mode: int, *, dir_fd: int | None = None, effective_ids: bool = False, follow_symlinks: bool = True -) -> bool: ... -def chdir(path: FileDescriptorOrPath) -> None: ... - -if sys.platform != "win32": - def fchdir(fd: FileDescriptorLike) -> None: ... - -def getcwd() -> str: ... -def getcwdb() -> bytes: ... -def chmod(path: FileDescriptorOrPath, mode: int, *, dir_fd: int | None = None, follow_symlinks: bool = ...) -> None: ... - -if sys.platform != "win32" and sys.platform != "linux": - def chflags(path: StrOrBytesPath, flags: int, follow_symlinks: bool = True) -> None: ... # some flavors of Unix - def lchflags(path: StrOrBytesPath, flags: int) -> None: ... - -if sys.platform != "win32": - def chroot(path: StrOrBytesPath) -> None: ... - def chown( - path: FileDescriptorOrPath, uid: int, gid: int, *, dir_fd: int | None = None, follow_symlinks: bool = True - ) -> None: ... - def lchown(path: StrOrBytesPath, uid: int, gid: int) -> None: ... - -def link( - src: StrOrBytesPath, - dst: StrOrBytesPath, - *, - src_dir_fd: int | None = None, - dst_dir_fd: int | None = None, - follow_symlinks: bool = True, -) -> None: ... -def lstat(path: StrOrBytesPath, *, dir_fd: int | None = None) -> stat_result: ... -def mkdir(path: StrOrBytesPath, mode: int = 0o777, *, dir_fd: int | None = None) -> None: ... - -if sys.platform != "win32": - def mkfifo(path: StrOrBytesPath, mode: int = 0o666, *, dir_fd: int | None = None) -> None: ... # Unix only - -def makedirs(name: StrOrBytesPath, mode: int = 0o777, exist_ok: bool = False) -> None: ... - -if sys.platform != "win32": - def mknod(path: StrOrBytesPath, mode: int = 0o600, device: int = 0, *, dir_fd: int | None = None) -> None: ... - def major(device: int, /) -> int: ... - def minor(device: int, /) -> int: ... - def makedev(major: int, minor: int, /) -> int: ... - def pathconf(path: FileDescriptorOrPath, name: str | int) -> int: ... # Unix only - -def readlink(path: GenericPath[AnyStr], *, dir_fd: int | None = None) -> AnyStr: ... -def remove(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... -def removedirs(name: StrOrBytesPath) -> None: ... -def rename(src: StrOrBytesPath, dst: StrOrBytesPath, *, src_dir_fd: int | None = None, dst_dir_fd: int | None = None) -> None: ... -def renames(old: StrOrBytesPath, new: StrOrBytesPath) -> None: ... -def replace( - src: StrOrBytesPath, dst: StrOrBytesPath, *, src_dir_fd: int | None = None, dst_dir_fd: int | None = None -) -> None: ... -def rmdir(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... - -class _ScandirIterator(Iterator[DirEntry[AnyStr]], AbstractContextManager[_ScandirIterator[AnyStr], None]): - def __next__(self) -> DirEntry[AnyStr]: ... - def __exit__(self, *args: Unused) -> None: ... - def close(self) -> None: ... - -@overload -def scandir(path: None = None) -> _ScandirIterator[str]: ... -@overload -def scandir(path: int) -> _ScandirIterator[str]: ... -@overload -def scandir(path: GenericPath[AnyStr]) -> _ScandirIterator[AnyStr]: ... -def stat(path: FileDescriptorOrPath, *, dir_fd: int | None = None, follow_symlinks: bool = True) -> stat_result: ... - -if sys.platform != "win32": - def statvfs(path: FileDescriptorOrPath) -> statvfs_result: ... # Unix only - -def symlink( - src: StrOrBytesPath, dst: StrOrBytesPath, target_is_directory: bool = False, *, dir_fd: int | None = None -) -> None: ... - -if sys.platform != "win32": - def sync() -> None: ... # Unix only - -def truncate(path: FileDescriptorOrPath, length: int) -> None: ... # Unix only up to version 3.4 -def unlink(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... -def utime( - path: FileDescriptorOrPath, - times: tuple[int, int] | tuple[float, float] | None = None, - *, - ns: tuple[int, int] = ..., - dir_fd: int | None = None, - follow_symlinks: bool = True, -) -> None: ... - -_OnError: TypeAlias = Callable[[OSError], object] - -def walk( - top: GenericPath[AnyStr], topdown: bool = True, onerror: _OnError | None = None, followlinks: bool = False -) -> Iterator[tuple[AnyStr, list[AnyStr], list[AnyStr]]]: ... - -if sys.platform != "win32": - @overload - def fwalk( - top: StrPath = ".", - topdown: bool = True, - onerror: _OnError | None = None, - *, - follow_symlinks: bool = False, - dir_fd: int | None = None, - ) -> Iterator[tuple[str, list[str], list[str], int]]: ... - @overload - def fwalk( - top: BytesPath, - topdown: bool = True, - onerror: _OnError | None = None, - *, - follow_symlinks: bool = False, - dir_fd: int | None = None, - ) -> Iterator[tuple[bytes, list[bytes], list[bytes], int]]: ... - if sys.platform == "linux": - def getxattr(path: FileDescriptorOrPath, attribute: StrOrBytesPath, *, follow_symlinks: bool = True) -> bytes: ... - def listxattr(path: FileDescriptorOrPath | None = None, *, follow_symlinks: bool = True) -> list[str]: ... - def removexattr(path: FileDescriptorOrPath, attribute: StrOrBytesPath, *, follow_symlinks: bool = True) -> None: ... - def setxattr( - path: FileDescriptorOrPath, - attribute: StrOrBytesPath, - value: ReadableBuffer, - flags: int = 0, - *, - follow_symlinks: bool = True, - ) -> None: ... - -def abort() -> NoReturn: ... - -# These are defined as execl(file, *args) but the first *arg is mandatory. -def execl(file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]]]]) -> NoReturn: ... -def execlp(file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]]]]) -> NoReturn: ... - -# These are: execle(file, *args, env) but env is pulled from the last element of the args. -def execle( - file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]], _ExecEnv]] -) -> NoReturn: ... -def execlpe( - file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]], _ExecEnv]] -) -> NoReturn: ... - -# The docs say `args: tuple or list of strings` -# The implementation enforces tuple or list so we can't use Sequence. -# Not separating out PathLike[str] and PathLike[bytes] here because it doesn't make much difference -# in practice, and doing so would explode the number of combinations in this already long union. -# All these combinations are necessary due to list being invariant. -_ExecVArgs: TypeAlias = ( - tuple[StrOrBytesPath, ...] - | list[bytes] - | list[str] - | list[PathLike[Any]] - | list[bytes | str] - | list[bytes | PathLike[Any]] - | list[str | PathLike[Any]] - | list[bytes | str | PathLike[Any]] -) -# Depending on the OS, the keys and values are passed either to -# PyUnicode_FSDecoder (which accepts str | ReadableBuffer) or to -# PyUnicode_FSConverter (which accepts StrOrBytesPath). For simplicity, -# we limit to str | bytes. -_ExecEnv: TypeAlias = Mapping[bytes, bytes | str] | Mapping[str, bytes | str] - -def execv(path: StrOrBytesPath, argv: _ExecVArgs, /) -> NoReturn: ... -def execve(path: FileDescriptorOrPath, argv: _ExecVArgs, env: _ExecEnv) -> NoReturn: ... -def execvp(file: StrOrBytesPath, args: _ExecVArgs) -> NoReturn: ... -def execvpe(file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> NoReturn: ... -def _exit(status: int) -> NoReturn: ... -def kill(pid: int, signal: int, /) -> None: ... - -if sys.platform != "win32": - # Unix only - def fork() -> int: ... - def forkpty() -> tuple[int, int]: ... # some flavors of Unix - def killpg(pgid: int, signal: int, /) -> None: ... - def nice(increment: int, /) -> int: ... - if sys.platform != "darwin" and sys.platform != "linux": - def plock(op: int, /) -> None: ... - -class _wrap_close: - def __init__(self, stream: TextIOWrapper, proc: Popen[str]) -> None: ... - def close(self) -> int | None: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - def __iter__(self) -> Iterator[str]: ... - # Methods below here don't exist directly on the _wrap_close object, but - # are copied from the wrapped TextIOWrapper object via __getattr__. - # The full set of TextIOWrapper methods are technically available this way, - # but undocumented. Only a subset are currently included here. - def read(self, size: int | None = -1, /) -> str: ... - def readable(self) -> bool: ... - def readline(self, size: int = -1, /) -> str: ... - def readlines(self, hint: int = -1, /) -> list[str]: ... - def writable(self) -> bool: ... - def write(self, s: str, /) -> int: ... - def writelines(self, lines: Iterable[str], /) -> None: ... - -def popen(cmd: str, mode: str = "r", buffering: int = -1) -> _wrap_close: ... -def spawnl(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: StrOrBytesPath) -> int: ... -def spawnle(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: Any) -> int: ... # Imprecise sig - -if sys.platform != "win32": - def spawnv(mode: int, file: StrOrBytesPath, args: _ExecVArgs) -> int: ... - def spawnve(mode: int, file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> int: ... - -else: - def spawnv(mode: int, path: StrOrBytesPath, argv: _ExecVArgs, /) -> int: ... - def spawnve(mode: int, path: StrOrBytesPath, argv: _ExecVArgs, env: _ExecEnv, /) -> int: ... - -def system(command: StrOrBytesPath) -> int: ... -@final -class times_result(structseq[float], tuple[float, float, float, float, float]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("user", "system", "children_user", "children_system", "elapsed") - - @property - def user(self) -> float: ... - @property - def system(self) -> float: ... - @property - def children_user(self) -> float: ... - @property - def children_system(self) -> float: ... - @property - def elapsed(self) -> float: ... - -def times() -> times_result: ... -def waitpid(pid: int, options: int, /) -> tuple[int, int]: ... - -if sys.platform == "win32": - if sys.version_info >= (3, 10): - def startfile( - filepath: StrOrBytesPath, - operation: str = ..., - arguments: str = "", - cwd: StrOrBytesPath | None = None, - show_cmd: int = 1, - ) -> None: ... - else: - def startfile(filepath: StrOrBytesPath, operation: str = ...) -> None: ... - -else: - def spawnlp(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: StrOrBytesPath) -> int: ... - def spawnlpe(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: Any) -> int: ... # Imprecise signature - def spawnvp(mode: int, file: StrOrBytesPath, args: _ExecVArgs) -> int: ... - def spawnvpe(mode: int, file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> int: ... - def wait() -> tuple[int, int]: ... # Unix only - # Added to MacOS in 3.13 - if sys.platform != "darwin" or sys.version_info >= (3, 13): - @final - class waitid_result(structseq[int], tuple[int, int, int, int, int]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("si_pid", "si_uid", "si_signo", "si_status", "si_code") - - @property - def si_pid(self) -> int: ... - @property - def si_uid(self) -> int: ... - @property - def si_signo(self) -> int: ... - @property - def si_status(self) -> int: ... - @property - def si_code(self) -> int: ... - - def waitid(idtype: int, ident: int, options: int, /) -> waitid_result | None: ... - - from resource import struct_rusage - - def wait3(options: int) -> tuple[int, int, struct_rusage]: ... - def wait4(pid: int, options: int) -> tuple[int, int, struct_rusage]: ... - def WCOREDUMP(status: int, /) -> bool: ... - def WIFCONTINUED(status: int) -> bool: ... - def WIFSTOPPED(status: int) -> bool: ... - def WIFSIGNALED(status: int) -> bool: ... - def WIFEXITED(status: int) -> bool: ... - def WEXITSTATUS(status: int) -> int: ... - def WSTOPSIG(status: int) -> int: ... - def WTERMSIG(status: int) -> int: ... - def posix_spawn( - path: StrOrBytesPath, - argv: _ExecVArgs, - env: _ExecEnv, - /, - *, - file_actions: Sequence[tuple[Any, ...]] | None = ..., - setpgroup: int | None = ..., - resetids: bool = ..., - setsid: bool = ..., - setsigmask: Iterable[int] = ..., - setsigdef: Iterable[int] = ..., - scheduler: tuple[Any, sched_param] | None = ..., - ) -> int: ... - def posix_spawnp( - path: StrOrBytesPath, - argv: _ExecVArgs, - env: _ExecEnv, - /, - *, - file_actions: Sequence[tuple[Any, ...]] | None = ..., - setpgroup: int | None = ..., - resetids: bool = ..., - setsid: bool = ..., - setsigmask: Iterable[int] = ..., - setsigdef: Iterable[int] = ..., - scheduler: tuple[Any, sched_param] | None = ..., - ) -> int: ... - POSIX_SPAWN_OPEN: int - POSIX_SPAWN_CLOSE: int - POSIX_SPAWN_DUP2: int - -if sys.platform != "win32": - @final - class sched_param(structseq[int], tuple[int]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("sched_priority",) - - def __new__(cls, sched_priority: int) -> Self: ... - @property - def sched_priority(self) -> int: ... - - def sched_get_priority_min(policy: int) -> int: ... # some flavors of Unix - def sched_get_priority_max(policy: int) -> int: ... # some flavors of Unix - def sched_yield() -> None: ... # some flavors of Unix - if sys.platform != "darwin": - def sched_setscheduler(pid: int, policy: int, param: sched_param, /) -> None: ... # some flavors of Unix - def sched_getscheduler(pid: int, /) -> int: ... # some flavors of Unix - def sched_rr_get_interval(pid: int, /) -> float: ... # some flavors of Unix - def sched_setparam(pid: int, param: sched_param, /) -> None: ... # some flavors of Unix - def sched_getparam(pid: int, /) -> sched_param: ... # some flavors of Unix - def sched_setaffinity(pid: int, mask: Iterable[int], /) -> None: ... # some flavors of Unix - def sched_getaffinity(pid: int, /) -> set[int]: ... # some flavors of Unix - -def cpu_count() -> int | None: ... - -if sys.platform != "win32": - # Unix only - def confstr(name: str | int, /) -> str | None: ... - def getloadavg() -> tuple[float, float, float]: ... - def sysconf(name: str | int, /) -> int: ... - -if sys.platform == "linux": - def getrandom(size: int, flags: int = 0) -> bytes: ... - -def urandom(size: int, /) -> bytes: ... - -if sys.platform != "win32": - def register_at_fork( - *, - before: Callable[..., Any] | None = ..., - after_in_parent: Callable[..., Any] | None = ..., - after_in_child: Callable[..., Any] | None = ..., - ) -> None: ... - -if sys.platform == "win32": - class _AddedDllDirectory: - path: str | None - def __init__(self, path: str | None, cookie: _T, remove_dll_directory: Callable[[_T], object]) -> None: ... - def close(self) -> None: ... - def __enter__(self) -> Self: ... - def __exit__(self, *args: Unused) -> None: ... - - def add_dll_directory(path: str) -> _AddedDllDirectory: ... - -if sys.platform == "linux": - MFD_CLOEXEC: int - MFD_ALLOW_SEALING: int - MFD_HUGETLB: int - MFD_HUGE_SHIFT: int - MFD_HUGE_MASK: int - MFD_HUGE_64KB: int - MFD_HUGE_512KB: int - MFD_HUGE_1MB: int - MFD_HUGE_2MB: int - MFD_HUGE_8MB: int - MFD_HUGE_16MB: int - MFD_HUGE_32MB: int - MFD_HUGE_256MB: int - MFD_HUGE_512MB: int - MFD_HUGE_1GB: int - MFD_HUGE_2GB: int - MFD_HUGE_16GB: int - def memfd_create(name: str, flags: int = ...) -> int: ... - def copy_file_range(src: int, dst: int, count: int, offset_src: int | None = ..., offset_dst: int | None = ...) -> int: ... - -if sys.version_info >= (3, 9): - def waitstatus_to_exitcode(status: int) -> int: ... - - if sys.platform == "linux": - def pidfd_open(pid: int, flags: int = ...) -> int: ... - -if sys.version_info >= (3, 12) and sys.platform == "win32": - def listdrives() -> list[str]: ... - def listmounts(volume: str) -> list[str]: ... - def listvolumes() -> list[str]: ... - -if sys.version_info >= (3, 10) and sys.platform == "linux": - EFD_CLOEXEC: int - EFD_NONBLOCK: int - EFD_SEMAPHORE: int - SPLICE_F_MORE: int - SPLICE_F_MOVE: int - SPLICE_F_NONBLOCK: int - def eventfd(initval: int, flags: int = 524288) -> FileDescriptor: ... - def eventfd_read(fd: FileDescriptor) -> int: ... - def eventfd_write(fd: FileDescriptor, value: int) -> None: ... - def splice( - src: FileDescriptor, - dst: FileDescriptor, - count: int, - offset_src: int | None = ..., - offset_dst: int | None = ..., - flags: int = 0, - ) -> int: ... - -if sys.version_info >= (3, 12) and sys.platform == "linux": - CLONE_FILES: int - CLONE_FS: int - CLONE_NEWCGROUP: int # Linux 4.6+ - CLONE_NEWIPC: int # Linux 2.6.19+ - CLONE_NEWNET: int # Linux 2.6.24+ - CLONE_NEWNS: int - CLONE_NEWPID: int # Linux 3.8+ - CLONE_NEWTIME: int # Linux 5.6+ - CLONE_NEWUSER: int # Linux 3.8+ - CLONE_NEWUTS: int # Linux 2.6.19+ - CLONE_SIGHAND: int - CLONE_SYSVSEM: int # Linux 2.6.26+ - CLONE_THREAD: int - CLONE_VM: int - def unshare(flags: int) -> None: ... - def setns(fd: FileDescriptorLike, nstype: int = 0) -> None: ... - -if sys.version_info >= (3, 13) and sys.platform != "win32": - def posix_openpt(oflag: int, /) -> int: ... - def grantpt(fd: FileDescriptorLike, /) -> None: ... - def unlockpt(fd: FileDescriptorLike, /) -> None: ... - def ptsname(fd: FileDescriptorLike, /) -> str: ... - -if sys.version_info >= (3, 13) and sys.platform == "linux": - TFD_TIMER_ABSTIME: Final = 1 - TFD_TIMER_CANCEL_ON_SET: Final = 2 - TFD_NONBLOCK: Final[int] - TFD_CLOEXEC: Final[int] - POSIX_SPAWN_CLOSEFROM: Final[int] - - def timerfd_create(clockid: int, /, *, flags: int = 0) -> int: ... - def timerfd_settime( - fd: FileDescriptor, /, *, flags: int = 0, initial: float = 0.0, interval: float = 0.0 - ) -> tuple[float, float]: ... - def timerfd_settime_ns(fd: FileDescriptor, /, *, flags: int = 0, initial: int = 0, interval: int = 0) -> tuple[int, int]: ... - def timerfd_gettime(fd: FileDescriptor, /) -> tuple[float, float]: ... - def timerfd_gettime_ns(fd: FileDescriptor, /) -> tuple[int, int]: ... - -if sys.version_info >= (3, 13) or sys.platform != "win32": - # Added to Windows in 3.13. - def fchmod(fd: int, mode: int) -> None: ... - -if sys.platform != "linux": - if sys.version_info >= (3, 13) or sys.platform != "win32": - # Added to Windows in 3.13. - def lchmod(path: StrOrBytesPath, mode: int) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/parser.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/parser.pyi deleted file mode 100644 index bafc8015fed9c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/parser.pyi +++ /dev/null @@ -1,24 +0,0 @@ -from _typeshed import StrOrBytesPath -from collections.abc import Sequence -from types import CodeType -from typing import Any, final - -def expr(source: str) -> STType: ... -def suite(source: str) -> STType: ... -def sequence2st(sequence: Sequence[Any]) -> STType: ... -def tuple2st(sequence: Sequence[Any]) -> STType: ... -def st2list(st: STType, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ... -def st2tuple(st: STType, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ... -def compilest(st: STType, filename: StrOrBytesPath = ...) -> CodeType: ... -def isexpr(st: STType) -> bool: ... -def issuite(st: STType) -> bool: ... - -class ParserError(Exception): ... - -@final -class STType: - def compile(self, filename: StrOrBytesPath = ...) -> CodeType: ... - def isexpr(self) -> bool: ... - def issuite(self) -> bool: ... - def tolist(self, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ... - def totuple(self, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pathlib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/pathlib.pyi deleted file mode 100644 index bdca375f626da..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pathlib.pyi +++ /dev/null @@ -1,298 +0,0 @@ -import sys -import types -from _typeshed import ( - OpenBinaryMode, - OpenBinaryModeReading, - OpenBinaryModeUpdating, - OpenBinaryModeWriting, - OpenTextMode, - ReadableBuffer, - StrOrBytesPath, - StrPath, - Unused, -) -from collections.abc import Callable, Generator, Iterator, Sequence -from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper -from os import PathLike, stat_result -from types import TracebackType -from typing import IO, Any, BinaryIO, ClassVar, Literal, overload -from typing_extensions import Self, deprecated - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = ["PurePath", "PurePosixPath", "PureWindowsPath", "Path", "PosixPath", "WindowsPath"] - -if sys.version_info >= (3, 13): - __all__ += ["UnsupportedOperation"] - -class PurePath(PathLike[str]): - if sys.version_info >= (3, 13): - parser: ClassVar[types.ModuleType] - def full_match(self, pattern: StrPath, *, case_sensitive: bool | None = None) -> bool: ... - - @property - def parts(self) -> tuple[str, ...]: ... - @property - def drive(self) -> str: ... - @property - def root(self) -> str: ... - @property - def anchor(self) -> str: ... - @property - def name(self) -> str: ... - @property - def suffix(self) -> str: ... - @property - def suffixes(self) -> list[str]: ... - @property - def stem(self) -> str: ... - if sys.version_info >= (3, 12): - def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... - def __init__(self, *args: StrPath) -> None: ... # pyright: ignore[reportInconsistentConstructor] - else: - def __new__(cls, *args: StrPath) -> Self: ... - - def __hash__(self) -> int: ... - def __fspath__(self) -> str: ... - def __lt__(self, other: PurePath) -> bool: ... - def __le__(self, other: PurePath) -> bool: ... - def __gt__(self, other: PurePath) -> bool: ... - def __ge__(self, other: PurePath) -> bool: ... - def __truediv__(self, key: StrPath) -> Self: ... - def __rtruediv__(self, key: StrPath) -> Self: ... - def __bytes__(self) -> bytes: ... - def as_posix(self) -> str: ... - def as_uri(self) -> str: ... - def is_absolute(self) -> bool: ... - def is_reserved(self) -> bool: ... - if sys.version_info >= (3, 12): - def is_relative_to(self, other: StrPath, /, *_deprecated: StrPath) -> bool: ... - elif sys.version_info >= (3, 9): - def is_relative_to(self, *other: StrPath) -> bool: ... - - if sys.version_info >= (3, 12): - def match(self, path_pattern: str, *, case_sensitive: bool | None = None) -> bool: ... - else: - def match(self, path_pattern: str) -> bool: ... - - if sys.version_info >= (3, 12): - def relative_to(self, other: StrPath, /, *_deprecated: StrPath, walk_up: bool = False) -> Self: ... - else: - def relative_to(self, *other: StrPath) -> Self: ... - - def with_name(self, name: str) -> Self: ... - if sys.version_info >= (3, 9): - def with_stem(self, stem: str) -> Self: ... - - def with_suffix(self, suffix: str) -> Self: ... - def joinpath(self, *other: StrPath) -> Self: ... - @property - def parents(self) -> Sequence[Self]: ... - @property - def parent(self) -> Self: ... - if sys.version_info >= (3, 9) and sys.version_info < (3, 11): - def __class_getitem__(cls, type: Any) -> GenericAlias: ... - - if sys.version_info >= (3, 12): - def with_segments(self, *args: StrPath) -> Self: ... - -class PurePosixPath(PurePath): ... -class PureWindowsPath(PurePath): ... - -class Path(PurePath): - if sys.version_info >= (3, 12): - def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... # pyright: ignore[reportInconsistentConstructor] - else: - def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... - - @classmethod - def cwd(cls) -> Self: ... - if sys.version_info >= (3, 10): - def stat(self, *, follow_symlinks: bool = True) -> stat_result: ... - def chmod(self, mode: int, *, follow_symlinks: bool = True) -> None: ... - else: - def stat(self) -> stat_result: ... - def chmod(self, mode: int) -> None: ... - - if sys.version_info >= (3, 13): - @classmethod - def from_uri(cls, uri: str) -> Self: ... - def is_dir(self, *, follow_symlinks: bool = True) -> bool: ... - def is_file(self, *, follow_symlinks: bool = True) -> bool: ... - def read_text(self, encoding: str | None = None, errors: str | None = None, newline: str | None = None) -> str: ... - else: - def __enter__(self) -> Self: ... - def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... - def is_dir(self) -> bool: ... - def is_file(self) -> bool: ... - def read_text(self, encoding: str | None = None, errors: str | None = None) -> str: ... - - if sys.version_info >= (3, 13): - def glob( - self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = False - ) -> Generator[Self, None, None]: ... - def rglob( - self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = False - ) -> Generator[Self, None, None]: ... - elif sys.version_info >= (3, 12): - def glob(self, pattern: str, *, case_sensitive: bool | None = None) -> Generator[Self, None, None]: ... - def rglob(self, pattern: str, *, case_sensitive: bool | None = None) -> Generator[Self, None, None]: ... - else: - def glob(self, pattern: str) -> Generator[Self, None, None]: ... - def rglob(self, pattern: str) -> Generator[Self, None, None]: ... - - if sys.version_info >= (3, 12): - def exists(self, *, follow_symlinks: bool = True) -> bool: ... - else: - def exists(self) -> bool: ... - - def is_symlink(self) -> bool: ... - def is_socket(self) -> bool: ... - def is_fifo(self) -> bool: ... - def is_block_device(self) -> bool: ... - def is_char_device(self) -> bool: ... - if sys.version_info >= (3, 12): - def is_junction(self) -> bool: ... - - def iterdir(self) -> Generator[Self, None, None]: ... - def lchmod(self, mode: int) -> None: ... - def lstat(self) -> stat_result: ... - def mkdir(self, mode: int = 0o777, parents: bool = False, exist_ok: bool = False) -> None: ... - - if sys.version_info >= (3, 14): - def copy(self, target: StrPath, *, follow_symlinks: bool = True, preserve_metadata: bool = False) -> None: ... - def copytree( - self, - target: StrPath, - *, - follow_symlinks: bool = True, - preserve_metadata: bool = False, - dirs_exist_ok: bool = False, - ignore: Callable[[Self], bool] | None = None, - on_error: Callable[[OSError], object] | None = None, - ) -> None: ... - - # Adapted from builtins.open - # Text mode: always returns a TextIOWrapper - # The Traversable .open in stdlib/importlib/abc.pyi should be kept in sync with this. - @overload - def open( - self, - mode: OpenTextMode = "r", - buffering: int = -1, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> TextIOWrapper: ... - # Unbuffered binary mode: returns a FileIO - @overload - def open( - self, mode: OpenBinaryMode, buffering: Literal[0], encoding: None = None, errors: None = None, newline: None = None - ) -> FileIO: ... - # Buffering is on: return BufferedRandom, BufferedReader, or BufferedWriter - @overload - def open( - self, - mode: OpenBinaryModeUpdating, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - ) -> BufferedRandom: ... - @overload - def open( - self, - mode: OpenBinaryModeWriting, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - ) -> BufferedWriter: ... - @overload - def open( - self, - mode: OpenBinaryModeReading, - buffering: Literal[-1, 1] = -1, - encoding: None = None, - errors: None = None, - newline: None = None, - ) -> BufferedReader: ... - # Buffering cannot be determined: fall back to BinaryIO - @overload - def open( - self, mode: OpenBinaryMode, buffering: int = -1, encoding: None = None, errors: None = None, newline: None = None - ) -> BinaryIO: ... - # Fallback if mode is not specified - @overload - def open( - self, mode: str, buffering: int = -1, encoding: str | None = None, errors: str | None = None, newline: str | None = None - ) -> IO[Any]: ... - if sys.platform != "win32": - # These methods do "exist" on Windows, but they always raise NotImplementedError, - # so it's safer to pretend they don't exist - if sys.version_info >= (3, 13): - def owner(self, *, follow_symlinks: bool = True) -> str: ... - def group(self, *, follow_symlinks: bool = True) -> str: ... - else: - def owner(self) -> str: ... - def group(self) -> str: ... - - # This method does "exist" on Windows on <3.12, but always raises NotImplementedError - # On py312+, it works properly on Windows, as with all other platforms - if sys.platform != "win32" or sys.version_info >= (3, 12): - def is_mount(self) -> bool: ... - - if sys.version_info >= (3, 9): - def readlink(self) -> Self: ... - - if sys.version_info >= (3, 10): - def rename(self, target: StrPath) -> Self: ... - def replace(self, target: StrPath) -> Self: ... - else: - def rename(self, target: str | PurePath) -> Self: ... - def replace(self, target: str | PurePath) -> Self: ... - - def resolve(self, strict: bool = False) -> Self: ... - def rmdir(self) -> None: ... - if sys.version_info >= (3, 14): - def delete(self, ignore_errors: bool = False, on_error: Callable[[OSError], object] | None = None) -> None: ... - - def symlink_to(self, target: StrOrBytesPath, target_is_directory: bool = False) -> None: ... - if sys.version_info >= (3, 10): - def hardlink_to(self, target: StrOrBytesPath) -> None: ... - - def touch(self, mode: int = 0o666, exist_ok: bool = True) -> None: ... - def unlink(self, missing_ok: bool = False) -> None: ... - @classmethod - def home(cls) -> Self: ... - def absolute(self) -> Self: ... - def expanduser(self) -> Self: ... - def read_bytes(self) -> bytes: ... - def samefile(self, other_path: StrPath) -> bool: ... - def write_bytes(self, data: ReadableBuffer) -> int: ... - if sys.version_info >= (3, 10): - def write_text( - self, data: str, encoding: str | None = None, errors: str | None = None, newline: str | None = None - ) -> int: ... - else: - def write_text(self, data: str, encoding: str | None = None, errors: str | None = None) -> int: ... - if sys.version_info < (3, 12): - if sys.version_info >= (3, 10): - @deprecated("Deprecated as of Python 3.10 and removed in Python 3.12. Use hardlink_to() instead.") - def link_to(self, target: StrOrBytesPath) -> None: ... - else: - def link_to(self, target: StrOrBytesPath) -> None: ... - if sys.version_info >= (3, 12): - def walk( - self, top_down: bool = ..., on_error: Callable[[OSError], object] | None = ..., follow_symlinks: bool = ... - ) -> Iterator[tuple[Self, list[str], list[str]]]: ... - - if sys.version_info >= (3, 14): - def rmtree(self, ignore_errors: bool = False, on_error: Callable[[OSError], object] | None = None) -> None: ... - -class PosixPath(Path, PurePosixPath): ... -class WindowsPath(Path, PureWindowsPath): ... - -if sys.version_info >= (3, 13): - class UnsupportedOperation(NotImplementedError): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pickle.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/pickle.pyi deleted file mode 100644 index 9bea92ef1c9eb..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pickle.pyi +++ /dev/null @@ -1,271 +0,0 @@ -from _typeshed import ReadableBuffer, SupportsWrite -from collections.abc import Callable, Iterable, Iterator, Mapping -from typing import Any, ClassVar, Protocol, SupportsBytes, SupportsIndex, final -from typing_extensions import TypeAlias - -__all__ = [ - "PickleBuffer", - "PickleError", - "PicklingError", - "UnpicklingError", - "Pickler", - "Unpickler", - "dump", - "dumps", - "load", - "loads", - "ADDITEMS", - "APPEND", - "APPENDS", - "BINBYTES", - "BINBYTES8", - "BINFLOAT", - "BINGET", - "BININT", - "BININT1", - "BININT2", - "BINPERSID", - "BINPUT", - "BINSTRING", - "BINUNICODE", - "BINUNICODE8", - "BUILD", - "BYTEARRAY8", - "DEFAULT_PROTOCOL", - "DICT", - "DUP", - "EMPTY_DICT", - "EMPTY_LIST", - "EMPTY_SET", - "EMPTY_TUPLE", - "EXT1", - "EXT2", - "EXT4", - "FALSE", - "FLOAT", - "FRAME", - "FROZENSET", - "GET", - "GLOBAL", - "HIGHEST_PROTOCOL", - "INST", - "INT", - "LIST", - "LONG", - "LONG1", - "LONG4", - "LONG_BINGET", - "LONG_BINPUT", - "MARK", - "MEMOIZE", - "NEWFALSE", - "NEWOBJ", - "NEWOBJ_EX", - "NEWTRUE", - "NEXT_BUFFER", - "NONE", - "OBJ", - "PERSID", - "POP", - "POP_MARK", - "PROTO", - "PUT", - "READONLY_BUFFER", - "REDUCE", - "SETITEM", - "SETITEMS", - "SHORT_BINBYTES", - "SHORT_BINSTRING", - "SHORT_BINUNICODE", - "STACK_GLOBAL", - "STOP", - "STRING", - "TRUE", - "TUPLE", - "TUPLE1", - "TUPLE2", - "TUPLE3", - "UNICODE", -] - -HIGHEST_PROTOCOL: int -DEFAULT_PROTOCOL: int - -bytes_types: tuple[type[Any], ...] # undocumented - -class _ReadableFileobj(Protocol): - def read(self, n: int, /) -> bytes: ... - def readline(self) -> bytes: ... - -@final -class PickleBuffer: - def __init__(self, buffer: ReadableBuffer) -> None: ... - def raw(self) -> memoryview: ... - def release(self) -> None: ... - def __buffer__(self, flags: int, /) -> memoryview: ... - def __release_buffer__(self, buffer: memoryview, /) -> None: ... - -_BufferCallback: TypeAlias = Callable[[PickleBuffer], Any] | None - -def dump( - obj: Any, - file: SupportsWrite[bytes], - protocol: int | None = None, - *, - fix_imports: bool = True, - buffer_callback: _BufferCallback = None, -) -> None: ... -def dumps( - obj: Any, protocol: int | None = None, *, fix_imports: bool = True, buffer_callback: _BufferCallback = None -) -> bytes: ... -def load( - file: _ReadableFileobj, - *, - fix_imports: bool = True, - encoding: str = "ASCII", - errors: str = "strict", - buffers: Iterable[Any] | None = (), -) -> Any: ... -def loads( - data: ReadableBuffer, - /, - *, - fix_imports: bool = True, - encoding: str = "ASCII", - errors: str = "strict", - buffers: Iterable[Any] | None = (), -) -> Any: ... - -class PickleError(Exception): ... -class PicklingError(PickleError): ... -class UnpicklingError(PickleError): ... - -_ReducedType: TypeAlias = ( - str - | tuple[Callable[..., Any], tuple[Any, ...]] - | tuple[Callable[..., Any], tuple[Any, ...], Any] - | tuple[Callable[..., Any], tuple[Any, ...], Any, Iterator[Any] | None] - | tuple[Callable[..., Any], tuple[Any, ...], Any, Iterator[Any] | None, Iterator[Any] | None] -) - -class Pickler: - fast: bool - dispatch_table: Mapping[type, Callable[[Any], _ReducedType]] - bin: bool # undocumented - dispatch: ClassVar[dict[type, Callable[[Unpickler, Any], None]]] # undocumented, _Pickler only - - def __init__( - self, - file: SupportsWrite[bytes], - protocol: int | None = None, - *, - fix_imports: bool = True, - buffer_callback: _BufferCallback = None, - ) -> None: ... - def reducer_override(self, obj: Any) -> Any: ... - def dump(self, obj: Any, /) -> None: ... - def clear_memo(self) -> None: ... - def persistent_id(self, obj: Any) -> Any: ... - -class Unpickler: - dispatch: ClassVar[dict[int, Callable[[Unpickler], None]]] # undocumented, _Unpickler only - - def __init__( - self, - file: _ReadableFileobj, - *, - fix_imports: bool = True, - encoding: str = "ASCII", - errors: str = "strict", - buffers: Iterable[Any] | None = (), - ) -> None: ... - def load(self) -> Any: ... - def find_class(self, module_name: str, global_name: str, /) -> Any: ... - def persistent_load(self, pid: Any) -> Any: ... - -MARK: bytes -STOP: bytes -POP: bytes -POP_MARK: bytes -DUP: bytes -FLOAT: bytes -INT: bytes -BININT: bytes -BININT1: bytes -LONG: bytes -BININT2: bytes -NONE: bytes -PERSID: bytes -BINPERSID: bytes -REDUCE: bytes -STRING: bytes -BINSTRING: bytes -SHORT_BINSTRING: bytes -UNICODE: bytes -BINUNICODE: bytes -APPEND: bytes -BUILD: bytes -GLOBAL: bytes -DICT: bytes -EMPTY_DICT: bytes -APPENDS: bytes -GET: bytes -BINGET: bytes -INST: bytes -LONG_BINGET: bytes -LIST: bytes -EMPTY_LIST: bytes -OBJ: bytes -PUT: bytes -BINPUT: bytes -LONG_BINPUT: bytes -SETITEM: bytes -TUPLE: bytes -EMPTY_TUPLE: bytes -SETITEMS: bytes -BINFLOAT: bytes - -TRUE: bytes -FALSE: bytes - -# protocol 2 -PROTO: bytes -NEWOBJ: bytes -EXT1: bytes -EXT2: bytes -EXT4: bytes -TUPLE1: bytes -TUPLE2: bytes -TUPLE3: bytes -NEWTRUE: bytes -NEWFALSE: bytes -LONG1: bytes -LONG4: bytes - -# protocol 3 -BINBYTES: bytes -SHORT_BINBYTES: bytes - -# protocol 4 -SHORT_BINUNICODE: bytes -BINUNICODE8: bytes -BINBYTES8: bytes -EMPTY_SET: bytes -ADDITEMS: bytes -FROZENSET: bytes -NEWOBJ_EX: bytes -STACK_GLOBAL: bytes -MEMOIZE: bytes -FRAME: bytes - -# protocol 5 -BYTEARRAY8: bytes -NEXT_BUFFER: bytes -READONLY_BUFFER: bytes - -def encode_long(x: int) -> bytes: ... # undocumented -def decode_long(data: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer) -> int: ... # undocumented - -# pure-Python implementations -_Pickler = Pickler # undocumented -_Unpickler = Unpickler # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pkgutil.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/pkgutil.pyi deleted file mode 100644 index 7e7fa4fda9a18..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pkgutil.pyi +++ /dev/null @@ -1,53 +0,0 @@ -import sys -from _typeshed import SupportsRead -from _typeshed.importlib import LoaderProtocol, MetaPathFinderProtocol, PathEntryFinderProtocol -from collections.abc import Callable, Iterable, Iterator -from typing import IO, Any, NamedTuple, TypeVar -from typing_extensions import deprecated - -__all__ = [ - "get_importer", - "iter_importers", - "get_loader", - "find_loader", - "walk_packages", - "iter_modules", - "get_data", - "read_code", - "extend_path", - "ModuleInfo", -] -if sys.version_info < (3, 12): - __all__ += ["ImpImporter", "ImpLoader"] - -_PathT = TypeVar("_PathT", bound=Iterable[str]) - -class ModuleInfo(NamedTuple): - module_finder: MetaPathFinderProtocol | PathEntryFinderProtocol - name: str - ispkg: bool - -def extend_path(path: _PathT, name: str) -> _PathT: ... - -if sys.version_info < (3, 12): - class ImpImporter: - def __init__(self, path: str | None = None) -> None: ... - - class ImpLoader: - def __init__(self, fullname: str, file: IO[str], filename: str, etc: tuple[str, str, int]) -> None: ... - -@deprecated("Use importlib.util.find_spec() instead. Will be removed in Python 3.14.") -def find_loader(fullname: str) -> LoaderProtocol | None: ... -def get_importer(path_item: str) -> PathEntryFinderProtocol | None: ... -@deprecated("Use importlib.util.find_spec() instead. Will be removed in Python 3.14.") -def get_loader(module_or_name: str) -> LoaderProtocol | None: ... -def iter_importers(fullname: str = "") -> Iterator[MetaPathFinderProtocol | PathEntryFinderProtocol]: ... -def iter_modules(path: Iterable[str] | None = None, prefix: str = "") -> Iterator[ModuleInfo]: ... -def read_code(stream: SupportsRead[bytes]) -> Any: ... # undocumented -def walk_packages( - path: Iterable[str] | None = None, prefix: str = "", onerror: Callable[[str], object] | None = None -) -> Iterator[ModuleInfo]: ... -def get_data(package: str, resource: str) -> bytes | None: ... - -if sys.version_info >= (3, 9): - def resolve_name(name: str) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/platform.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/platform.pyi deleted file mode 100644 index c47ecdc51df49..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/platform.pyi +++ /dev/null @@ -1,67 +0,0 @@ -import sys -from typing import NamedTuple - -def libc_ver(executable: str | None = None, lib: str = "", version: str = "", chunksize: int = 16384) -> tuple[str, str]: ... -def win32_ver(release: str = "", version: str = "", csd: str = "", ptype: str = "") -> tuple[str, str, str, str]: ... -def win32_edition() -> str: ... -def win32_is_iot() -> bool: ... -def mac_ver( - release: str = "", versioninfo: tuple[str, str, str] = ("", "", ""), machine: str = "" -) -> tuple[str, tuple[str, str, str], str]: ... -def java_ver( - release: str = "", vendor: str = "", vminfo: tuple[str, str, str] = ("", "", ""), osinfo: tuple[str, str, str] = ("", "", "") -) -> tuple[str, str, tuple[str, str, str], tuple[str, str, str]]: ... -def system_alias(system: str, release: str, version: str) -> tuple[str, str, str]: ... -def architecture(executable: str = sys.executable, bits: str = "", linkage: str = "") -> tuple[str, str]: ... - -class uname_result(NamedTuple): - system: str - node: str - release: str - version: str - machine: str - processor: str - -def uname() -> uname_result: ... -def system() -> str: ... -def node() -> str: ... -def release() -> str: ... -def version() -> str: ... -def machine() -> str: ... -def processor() -> str: ... -def python_implementation() -> str: ... -def python_version() -> str: ... -def python_version_tuple() -> tuple[str, str, str]: ... -def python_branch() -> str: ... -def python_revision() -> str: ... -def python_build() -> tuple[str, str]: ... -def python_compiler() -> str: ... -def platform(aliased: bool = ..., terse: bool = ...) -> str: ... - -if sys.version_info >= (3, 10): - def freedesktop_os_release() -> dict[str, str]: ... - -if sys.version_info >= (3, 13): - class AndroidVer(NamedTuple): - release: str - api_level: int - manufacturer: str - model: str - device: str - is_emulator: bool - - class IOSVersionInfo(NamedTuple): - system: str - release: str - model: str - is_simulator: bool - - def android_ver( - release: str = "", - api_level: int = 0, - manufacturer: str = "", - model: str = "", - device: str = "", - is_emulator: bool = False, - ) -> AndroidVer: ... - def ios_ver(system: str = "", release: str = "", model: str = "", is_simulator: bool = False) -> IOSVersionInfo: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/plistlib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/plistlib.pyi deleted file mode 100644 index 09637673ce212..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/plistlib.pyi +++ /dev/null @@ -1,113 +0,0 @@ -import sys -from _typeshed import ReadableBuffer -from collections.abc import Mapping, MutableMapping -from datetime import datetime -from enum import Enum -from typing import IO, Any -from typing_extensions import Self - -__all__ = ["InvalidFileException", "FMT_XML", "FMT_BINARY", "load", "dump", "loads", "dumps", "UID"] -if sys.version_info < (3, 9): - __all__ += ["readPlist", "writePlist", "readPlistFromBytes", "writePlistToBytes", "Data"] - -class PlistFormat(Enum): - FMT_XML = 1 - FMT_BINARY = 2 - -FMT_XML = PlistFormat.FMT_XML -FMT_BINARY = PlistFormat.FMT_BINARY -if sys.version_info >= (3, 13): - def load( - fp: IO[bytes], - *, - fmt: PlistFormat | None = None, - dict_type: type[MutableMapping[str, Any]] = ..., - aware_datetime: bool = False, - ) -> Any: ... - def loads( - value: ReadableBuffer | str, - *, - fmt: PlistFormat | None = None, - dict_type: type[MutableMapping[str, Any]] = ..., - aware_datetime: bool = False, - ) -> Any: ... - -elif sys.version_info >= (3, 9): - def load(fp: IO[bytes], *, fmt: PlistFormat | None = None, dict_type: type[MutableMapping[str, Any]] = ...) -> Any: ... - def loads( - value: ReadableBuffer, *, fmt: PlistFormat | None = None, dict_type: type[MutableMapping[str, Any]] = ... - ) -> Any: ... - -else: - def load( - fp: IO[bytes], - *, - fmt: PlistFormat | None = None, - use_builtin_types: bool = True, - dict_type: type[MutableMapping[str, Any]] = ..., - ) -> Any: ... - def loads( - value: ReadableBuffer, - *, - fmt: PlistFormat | None = None, - use_builtin_types: bool = True, - dict_type: type[MutableMapping[str, Any]] = ..., - ) -> Any: ... - -if sys.version_info >= (3, 13): - def dump( - value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, - fp: IO[bytes], - *, - fmt: PlistFormat = ..., - sort_keys: bool = True, - skipkeys: bool = False, - aware_datetime: bool = False, - ) -> None: ... - def dumps( - value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, - *, - fmt: PlistFormat = ..., - skipkeys: bool = False, - sort_keys: bool = True, - aware_datetime: bool = False, - ) -> bytes: ... - -else: - def dump( - value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, - fp: IO[bytes], - *, - fmt: PlistFormat = ..., - sort_keys: bool = True, - skipkeys: bool = False, - ) -> None: ... - def dumps( - value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, - *, - fmt: PlistFormat = ..., - skipkeys: bool = False, - sort_keys: bool = True, - ) -> bytes: ... - -if sys.version_info < (3, 9): - def readPlist(pathOrFile: str | IO[bytes]) -> Any: ... - def writePlist(value: Mapping[str, Any], pathOrFile: str | IO[bytes]) -> None: ... - def readPlistFromBytes(data: ReadableBuffer) -> Any: ... - def writePlistToBytes(value: Mapping[str, Any]) -> bytes: ... - -if sys.version_info < (3, 9): - class Data: - data: bytes - def __init__(self, data: bytes) -> None: ... - -class UID: - data: int - def __init__(self, data: int) -> None: ... - def __index__(self) -> int: ... - def __reduce__(self) -> tuple[type[Self], tuple[int]]: ... - def __hash__(self) -> int: ... - def __eq__(self, other: object) -> bool: ... - -class InvalidFileException(ValueError): - def __init__(self, message: str = "Invalid file") -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pstats.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/pstats.pyi deleted file mode 100644 index 83256b433035a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pstats.pyi +++ /dev/null @@ -1,80 +0,0 @@ -import sys -from _typeshed import StrEnum, StrOrBytesPath -from collections.abc import Iterable -from cProfile import Profile as _cProfile -from profile import Profile -from typing import IO, Any, Literal, overload -from typing_extensions import Self, TypeAlias - -if sys.version_info >= (3, 9): - __all__ = ["Stats", "SortKey", "FunctionProfile", "StatsProfile"] -else: - __all__ = ["Stats", "SortKey"] - -_Selector: TypeAlias = str | float | int - -class SortKey(StrEnum): - CALLS = "calls" - CUMULATIVE = "cumulative" - FILENAME = "filename" - LINE = "line" - NAME = "name" - NFL = "nfl" - PCALLS = "pcalls" - STDNAME = "stdname" - TIME = "time" - -if sys.version_info >= (3, 9): - from dataclasses import dataclass - - @dataclass(unsafe_hash=True) - class FunctionProfile: - ncalls: str - tottime: float - percall_tottime: float - cumtime: float - percall_cumtime: float - file_name: str - line_number: int - - @dataclass(unsafe_hash=True) - class StatsProfile: - total_tt: float - func_profiles: dict[str, FunctionProfile] - -_SortArgDict: TypeAlias = dict[str, tuple[tuple[tuple[int, int], ...], str]] - -class Stats: - sort_arg_dict_default: _SortArgDict - def __init__( - self, - arg: None | str | Profile | _cProfile = ..., - /, - *args: None | str | Profile | _cProfile | Self, - stream: IO[Any] | None = None, - ) -> None: ... - def init(self, arg: None | str | Profile | _cProfile) -> None: ... - def load_stats(self, arg: None | str | Profile | _cProfile) -> None: ... - def get_top_level_stats(self) -> None: ... - def add(self, *arg_list: None | str | Profile | _cProfile | Self) -> Self: ... - def dump_stats(self, filename: StrOrBytesPath) -> None: ... - def get_sort_arg_defs(self) -> _SortArgDict: ... - @overload - def sort_stats(self, field: Literal[-1, 0, 1, 2]) -> Self: ... - @overload - def sort_stats(self, *field: str) -> Self: ... - def reverse_order(self) -> Self: ... - def strip_dirs(self) -> Self: ... - def calc_callees(self) -> None: ... - def eval_print_amount(self, sel: _Selector, list: list[str], msg: str) -> tuple[list[str], str]: ... - if sys.version_info >= (3, 9): - def get_stats_profile(self) -> StatsProfile: ... - - def get_print_list(self, sel_list: Iterable[_Selector]) -> tuple[int, list[str]]: ... - def print_stats(self, *amount: _Selector) -> Self: ... - def print_callees(self, *amount: _Selector) -> Self: ... - def print_callers(self, *amount: _Selector) -> Self: ... - def print_call_heading(self, name_size: int, column_title: str) -> None: ... - def print_call_line(self, name_size: int, source: str, call_dict: dict[str, Any], arrow: str = "->") -> None: ... - def print_title(self) -> None: ... - def print_line(self, func: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi deleted file mode 100644 index d38259a20d729..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi +++ /dev/null @@ -1,80 +0,0 @@ -from _typeshed import ReadableBuffer, SupportsRead -from collections.abc import Callable -from pyexpat import errors as errors, model as model -from typing import Any, Final, final -from typing_extensions import TypeAlias -from xml.parsers.expat import ExpatError as ExpatError - -EXPAT_VERSION: Final[str] # undocumented -version_info: tuple[int, int, int] # undocumented -native_encoding: str # undocumented -features: list[tuple[str, int]] # undocumented - -error = ExpatError -XML_PARAM_ENTITY_PARSING_NEVER: Final = 0 -XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE: Final = 1 -XML_PARAM_ENTITY_PARSING_ALWAYS: Final = 2 - -_Model: TypeAlias = tuple[int, int, str | None, tuple[Any, ...]] - -@final -class XMLParserType: - def Parse(self, data: str | ReadableBuffer, isfinal: bool = False, /) -> int: ... - def ParseFile(self, file: SupportsRead[bytes], /) -> int: ... - def SetBase(self, base: str, /) -> None: ... - def GetBase(self) -> str | None: ... - def GetInputContext(self) -> bytes | None: ... - def ExternalEntityParserCreate(self, context: str | None, encoding: str = ..., /) -> XMLParserType: ... - def SetParamEntityParsing(self, flag: int, /) -> int: ... - def UseForeignDTD(self, flag: bool = True, /) -> None: ... - def GetReparseDeferralEnabled(self) -> bool: ... - def SetReparseDeferralEnabled(self, enabled: bool, /) -> None: ... - @property - def intern(self) -> dict[str, str]: ... - buffer_size: int - buffer_text: bool - buffer_used: int - namespace_prefixes: bool # undocumented - ordered_attributes: bool - specified_attributes: bool - ErrorByteIndex: int - ErrorCode: int - ErrorColumnNumber: int - ErrorLineNumber: int - CurrentByteIndex: int - CurrentColumnNumber: int - CurrentLineNumber: int - XmlDeclHandler: Callable[[str, str | None, int], Any] | None - StartDoctypeDeclHandler: Callable[[str, str | None, str | None, bool], Any] | None - EndDoctypeDeclHandler: Callable[[], Any] | None - ElementDeclHandler: Callable[[str, _Model], Any] | None - AttlistDeclHandler: Callable[[str, str, str, str | None, bool], Any] | None - StartElementHandler: ( - Callable[[str, dict[str, str]], Any] - | Callable[[str, list[str]], Any] - | Callable[[str, dict[str, str], list[str]], Any] - | None - ) - EndElementHandler: Callable[[str], Any] | None - ProcessingInstructionHandler: Callable[[str, str], Any] | None - CharacterDataHandler: Callable[[str], Any] | None - UnparsedEntityDeclHandler: Callable[[str, str | None, str, str | None, str], Any] | None - EntityDeclHandler: Callable[[str, bool, str | None, str | None, str, str | None, str | None], Any] | None - NotationDeclHandler: Callable[[str, str | None, str, str | None], Any] | None - StartNamespaceDeclHandler: Callable[[str, str], Any] | None - EndNamespaceDeclHandler: Callable[[str], Any] | None - CommentHandler: Callable[[str], Any] | None - StartCdataSectionHandler: Callable[[], Any] | None - EndCdataSectionHandler: Callable[[], Any] | None - DefaultHandler: Callable[[str], Any] | None - DefaultHandlerExpand: Callable[[str], Any] | None - NotStandaloneHandler: Callable[[], int] | None - ExternalEntityRefHandler: Callable[[str, str | None, str | None, str | None], int] | None - SkippedEntityHandler: Callable[[str, bool], Any] | None - -def ErrorString(code: int, /) -> str: ... - -# intern is undocumented -def ParserCreate( - encoding: str | None = None, namespace_separator: str | None = None, intern: dict[str, Any] | None = None -) -> XMLParserType: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/queue.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/queue.pyi deleted file mode 100644 index 16643c99d08df..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/queue.pyi +++ /dev/null @@ -1,68 +0,0 @@ -import sys -from threading import Condition, Lock -from typing import Any, Generic, TypeVar - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = ["Empty", "Full", "Queue", "PriorityQueue", "LifoQueue", "SimpleQueue"] -if sys.version_info >= (3, 13): - __all__ += ["ShutDown"] - -_T = TypeVar("_T") - -class Empty(Exception): ... -class Full(Exception): ... - -if sys.version_info >= (3, 13): - class ShutDown(Exception): ... - -class Queue(Generic[_T]): - maxsize: int - - mutex: Lock # undocumented - not_empty: Condition # undocumented - not_full: Condition # undocumented - all_tasks_done: Condition # undocumented - unfinished_tasks: int # undocumented - if sys.version_info >= (3, 13): - is_shutdown: bool # undocumented - # Despite the fact that `queue` has `deque` type, - # we treat it as `Any` to allow different implementations in subtypes. - queue: Any # undocumented - def __init__(self, maxsize: int = 0) -> None: ... - def _init(self, maxsize: int) -> None: ... - def empty(self) -> bool: ... - def full(self) -> bool: ... - def get(self, block: bool = True, timeout: float | None = None) -> _T: ... - def get_nowait(self) -> _T: ... - if sys.version_info >= (3, 13): - def shutdown(self, immediate: bool = False) -> None: ... - - def _get(self) -> _T: ... - def put(self, item: _T, block: bool = True, timeout: float | None = None) -> None: ... - def put_nowait(self, item: _T) -> None: ... - def _put(self, item: _T) -> None: ... - def join(self) -> None: ... - def qsize(self) -> int: ... - def _qsize(self) -> int: ... - def task_done(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -class PriorityQueue(Queue[_T]): - queue: list[_T] - -class LifoQueue(Queue[_T]): - queue: list[_T] - -class SimpleQueue(Generic[_T]): - def __init__(self) -> None: ... - def empty(self) -> bool: ... - def get(self, block: bool = True, timeout: float | None = None) -> _T: ... - def get_nowait(self) -> _T: ... - def put(self, item: _T, block: bool = True, timeout: float | None = None) -> None: ... - def put_nowait(self, item: _T) -> None: ... - def qsize(self) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/signal.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/signal.pyi deleted file mode 100644 index 2e3ac5bf24c37..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/signal.pyi +++ /dev/null @@ -1,188 +0,0 @@ -import sys -from _typeshed import structseq -from collections.abc import Callable, Iterable -from enum import IntEnum -from types import FrameType -from typing import Any, Final, final -from typing_extensions import Never, TypeAlias - -NSIG: int - -class Signals(IntEnum): - SIGABRT = 6 - SIGFPE = 8 - SIGILL = 4 - SIGINT = 2 - SIGSEGV = 11 - SIGTERM = 15 - - if sys.platform == "win32": - SIGBREAK = 21 - CTRL_C_EVENT = 0 - CTRL_BREAK_EVENT = 1 - else: - SIGALRM = 14 - SIGBUS = 7 - SIGCHLD = 17 - SIGCONT = 18 - SIGHUP = 1 - SIGIO = 29 - SIGIOT = 6 - SIGKILL = 9 - SIGPIPE = 13 - SIGPROF = 27 - SIGQUIT = 3 - SIGSTOP = 19 - SIGSYS = 31 - SIGTRAP = 5 - SIGTSTP = 20 - SIGTTIN = 21 - SIGTTOU = 22 - SIGURG = 23 - SIGUSR1 = 10 - SIGUSR2 = 12 - SIGVTALRM = 26 - SIGWINCH = 28 - SIGXCPU = 24 - SIGXFSZ = 25 - if sys.platform != "linux": - SIGEMT = 7 - SIGINFO = 29 - if sys.platform != "darwin": - SIGCLD = 17 - SIGPOLL = 29 - SIGPWR = 30 - SIGRTMAX = 64 - SIGRTMIN = 34 - if sys.version_info >= (3, 11): - SIGSTKFLT = 16 - -class Handlers(IntEnum): - SIG_DFL = 0 - SIG_IGN = 1 - -SIG_DFL: Handlers -SIG_IGN: Handlers - -_SIGNUM: TypeAlias = int | Signals -_HANDLER: TypeAlias = Callable[[int, FrameType | None], Any] | int | Handlers | None - -def default_int_handler(signalnum: int, frame: FrameType | None, /) -> Never: ... - -if sys.version_info >= (3, 10): # arguments changed in 3.10.2 - def getsignal(signalnum: _SIGNUM) -> _HANDLER: ... - def signal(signalnum: _SIGNUM, handler: _HANDLER) -> _HANDLER: ... - -else: - def getsignal(signalnum: _SIGNUM, /) -> _HANDLER: ... - def signal(signalnum: _SIGNUM, handler: _HANDLER, /) -> _HANDLER: ... - -SIGABRT: Signals -SIGFPE: Signals -SIGILL: Signals -SIGINT: Signals -SIGSEGV: Signals -SIGTERM: Signals - -if sys.platform == "win32": - SIGBREAK: Signals - CTRL_C_EVENT: Signals - CTRL_BREAK_EVENT: Signals -else: - if sys.platform != "linux": - SIGINFO: Signals - SIGEMT: Signals - SIGALRM: Signals - SIGBUS: Signals - SIGCHLD: Signals - SIGCONT: Signals - SIGHUP: Signals - SIGIO: Signals - SIGIOT: Signals - SIGKILL: Signals - SIGPIPE: Signals - SIGPROF: Signals - SIGQUIT: Signals - SIGSTOP: Signals - SIGSYS: Signals - SIGTRAP: Signals - SIGTSTP: Signals - SIGTTIN: Signals - SIGTTOU: Signals - SIGURG: Signals - SIGUSR1: Signals - SIGUSR2: Signals - SIGVTALRM: Signals - SIGWINCH: Signals - SIGXCPU: Signals - SIGXFSZ: Signals - - class ItimerError(OSError): ... - ITIMER_PROF: int - ITIMER_REAL: int - ITIMER_VIRTUAL: int - - class Sigmasks(IntEnum): - SIG_BLOCK = 0 - SIG_UNBLOCK = 1 - SIG_SETMASK = 2 - - SIG_BLOCK = Sigmasks.SIG_BLOCK - SIG_UNBLOCK = Sigmasks.SIG_UNBLOCK - SIG_SETMASK = Sigmasks.SIG_SETMASK - def alarm(seconds: int, /) -> int: ... - def getitimer(which: int, /) -> tuple[float, float]: ... - def pause() -> None: ... - def pthread_kill(thread_id: int, signalnum: int, /) -> None: ... - if sys.version_info >= (3, 10): # arguments changed in 3.10.2 - def pthread_sigmask(how: int, mask: Iterable[int]) -> set[_SIGNUM]: ... - else: - def pthread_sigmask(how: int, mask: Iterable[int], /) -> set[_SIGNUM]: ... - - def setitimer(which: int, seconds: float, interval: float = 0.0, /) -> tuple[float, float]: ... - def siginterrupt(signalnum: int, flag: bool, /) -> None: ... - def sigpending() -> Any: ... - if sys.version_info >= (3, 10): # argument changed in 3.10.2 - def sigwait(sigset: Iterable[int]) -> _SIGNUM: ... - else: - def sigwait(sigset: Iterable[int], /) -> _SIGNUM: ... - if sys.platform != "darwin": - SIGCLD: Signals - SIGPOLL: Signals - SIGPWR: Signals - SIGRTMAX: Signals - SIGRTMIN: Signals - if sys.version_info >= (3, 11): - SIGSTKFLT: Signals - - @final - class struct_siginfo(structseq[int], tuple[int, int, int, int, int, int, int]): - if sys.version_info >= (3, 10): - __match_args__: Final = ("si_signo", "si_code", "si_errno", "si_pid", "si_uid", "si_status", "si_band") - - @property - def si_signo(self) -> int: ... - @property - def si_code(self) -> int: ... - @property - def si_errno(self) -> int: ... - @property - def si_pid(self) -> int: ... - @property - def si_uid(self) -> int: ... - @property - def si_status(self) -> int: ... - @property - def si_band(self) -> int: ... - - def sigtimedwait(sigset: Iterable[int], timeout: float, /) -> struct_siginfo | None: ... - def sigwaitinfo(sigset: Iterable[int], /) -> struct_siginfo: ... - -def strsignal(signalnum: _SIGNUM, /) -> str | None: ... -def valid_signals() -> set[Signals]: ... -def raise_signal(signalnum: _SIGNUM, /) -> None: ... -def set_wakeup_fd(fd: int, /, *, warn_on_full_buffer: bool = ...) -> int: ... - -if sys.version_info >= (3, 9): - if sys.platform == "linux": - def pidfd_send_signal(pidfd: int, sig: int, siginfo: None = None, flags: int = ..., /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/socket.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/socket.pyi deleted file mode 100644 index 39a93ce4d0f3a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/socket.pyi +++ /dev/null @@ -1,846 +0,0 @@ -# Ideally, we'd just do "from _socket import *". Unfortunately, socket -# overrides some definitions from _socket incompatibly. mypy incorrectly -# prefers the definitions from _socket over those defined here. -import _socket -import sys -from _socket import ( - CAPI as CAPI, - EAI_AGAIN as EAI_AGAIN, - EAI_BADFLAGS as EAI_BADFLAGS, - EAI_FAIL as EAI_FAIL, - EAI_FAMILY as EAI_FAMILY, - EAI_MEMORY as EAI_MEMORY, - EAI_NODATA as EAI_NODATA, - EAI_NONAME as EAI_NONAME, - EAI_SERVICE as EAI_SERVICE, - EAI_SOCKTYPE as EAI_SOCKTYPE, - INADDR_ALLHOSTS_GROUP as INADDR_ALLHOSTS_GROUP, - INADDR_ANY as INADDR_ANY, - INADDR_BROADCAST as INADDR_BROADCAST, - INADDR_LOOPBACK as INADDR_LOOPBACK, - INADDR_MAX_LOCAL_GROUP as INADDR_MAX_LOCAL_GROUP, - INADDR_NONE as INADDR_NONE, - INADDR_UNSPEC_GROUP as INADDR_UNSPEC_GROUP, - IP_ADD_MEMBERSHIP as IP_ADD_MEMBERSHIP, - IP_DROP_MEMBERSHIP as IP_DROP_MEMBERSHIP, - IP_HDRINCL as IP_HDRINCL, - IP_MULTICAST_IF as IP_MULTICAST_IF, - IP_MULTICAST_LOOP as IP_MULTICAST_LOOP, - IP_MULTICAST_TTL as IP_MULTICAST_TTL, - IP_OPTIONS as IP_OPTIONS, - IP_RECVDSTADDR as IP_RECVDSTADDR, - IP_TOS as IP_TOS, - IP_TTL as IP_TTL, - IPPORT_RESERVED as IPPORT_RESERVED, - IPPORT_USERRESERVED as IPPORT_USERRESERVED, - IPPROTO_AH as IPPROTO_AH, - IPPROTO_DSTOPTS as IPPROTO_DSTOPTS, - IPPROTO_EGP as IPPROTO_EGP, - IPPROTO_ESP as IPPROTO_ESP, - IPPROTO_FRAGMENT as IPPROTO_FRAGMENT, - IPPROTO_GGP as IPPROTO_GGP, - IPPROTO_HOPOPTS as IPPROTO_HOPOPTS, - IPPROTO_ICMP as IPPROTO_ICMP, - IPPROTO_ICMPV6 as IPPROTO_ICMPV6, - IPPROTO_IDP as IPPROTO_IDP, - IPPROTO_IGMP as IPPROTO_IGMP, - IPPROTO_IP as IPPROTO_IP, - IPPROTO_IPV4 as IPPROTO_IPV4, - IPPROTO_IPV6 as IPPROTO_IPV6, - IPPROTO_MAX as IPPROTO_MAX, - IPPROTO_ND as IPPROTO_ND, - IPPROTO_NONE as IPPROTO_NONE, - IPPROTO_PIM as IPPROTO_PIM, - IPPROTO_PUP as IPPROTO_PUP, - IPPROTO_RAW as IPPROTO_RAW, - IPPROTO_ROUTING as IPPROTO_ROUTING, - IPPROTO_SCTP as IPPROTO_SCTP, - IPPROTO_TCP as IPPROTO_TCP, - IPPROTO_UDP as IPPROTO_UDP, - IPV6_CHECKSUM as IPV6_CHECKSUM, - IPV6_JOIN_GROUP as IPV6_JOIN_GROUP, - IPV6_LEAVE_GROUP as IPV6_LEAVE_GROUP, - IPV6_MULTICAST_HOPS as IPV6_MULTICAST_HOPS, - IPV6_MULTICAST_IF as IPV6_MULTICAST_IF, - IPV6_MULTICAST_LOOP as IPV6_MULTICAST_LOOP, - IPV6_RECVTCLASS as IPV6_RECVTCLASS, - IPV6_TCLASS as IPV6_TCLASS, - IPV6_UNICAST_HOPS as IPV6_UNICAST_HOPS, - IPV6_V6ONLY as IPV6_V6ONLY, - NI_DGRAM as NI_DGRAM, - NI_MAXHOST as NI_MAXHOST, - NI_MAXSERV as NI_MAXSERV, - NI_NAMEREQD as NI_NAMEREQD, - NI_NOFQDN as NI_NOFQDN, - NI_NUMERICHOST as NI_NUMERICHOST, - NI_NUMERICSERV as NI_NUMERICSERV, - SHUT_RD as SHUT_RD, - SHUT_RDWR as SHUT_RDWR, - SHUT_WR as SHUT_WR, - SO_ACCEPTCONN as SO_ACCEPTCONN, - SO_BROADCAST as SO_BROADCAST, - SO_DEBUG as SO_DEBUG, - SO_DONTROUTE as SO_DONTROUTE, - SO_ERROR as SO_ERROR, - SO_KEEPALIVE as SO_KEEPALIVE, - SO_LINGER as SO_LINGER, - SO_OOBINLINE as SO_OOBINLINE, - SO_RCVBUF as SO_RCVBUF, - SO_RCVLOWAT as SO_RCVLOWAT, - SO_RCVTIMEO as SO_RCVTIMEO, - SO_REUSEADDR as SO_REUSEADDR, - SO_SNDBUF as SO_SNDBUF, - SO_SNDLOWAT as SO_SNDLOWAT, - SO_SNDTIMEO as SO_SNDTIMEO, - SO_TYPE as SO_TYPE, - SO_USELOOPBACK as SO_USELOOPBACK, - SOL_IP as SOL_IP, - SOL_SOCKET as SOL_SOCKET, - SOL_TCP as SOL_TCP, - SOL_UDP as SOL_UDP, - SOMAXCONN as SOMAXCONN, - TCP_FASTOPEN as TCP_FASTOPEN, - TCP_KEEPCNT as TCP_KEEPCNT, - TCP_KEEPINTVL as TCP_KEEPINTVL, - TCP_MAXSEG as TCP_MAXSEG, - TCP_NODELAY as TCP_NODELAY, - SocketType as SocketType, - _Address as _Address, - _RetAddress as _RetAddress, - close as close, - dup as dup, - getdefaulttimeout as getdefaulttimeout, - gethostbyaddr as gethostbyaddr, - gethostbyname as gethostbyname, - gethostbyname_ex as gethostbyname_ex, - gethostname as gethostname, - getnameinfo as getnameinfo, - getprotobyname as getprotobyname, - getservbyname as getservbyname, - getservbyport as getservbyport, - has_ipv6 as has_ipv6, - htonl as htonl, - htons as htons, - if_indextoname as if_indextoname, - if_nameindex as if_nameindex, - if_nametoindex as if_nametoindex, - inet_aton as inet_aton, - inet_ntoa as inet_ntoa, - inet_ntop as inet_ntop, - inet_pton as inet_pton, - ntohl as ntohl, - ntohs as ntohs, - setdefaulttimeout as setdefaulttimeout, -) -from _typeshed import ReadableBuffer, Unused, WriteableBuffer -from collections.abc import Iterable -from enum import IntEnum, IntFlag -from io import BufferedReader, BufferedRWPair, BufferedWriter, IOBase, RawIOBase, TextIOWrapper -from typing import Any, Literal, Protocol, SupportsIndex, overload -from typing_extensions import Self - -if sys.platform == "win32": - from _socket import ( - RCVALL_MAX as RCVALL_MAX, - RCVALL_OFF as RCVALL_OFF, - RCVALL_ON as RCVALL_ON, - RCVALL_SOCKETLEVELONLY as RCVALL_SOCKETLEVELONLY, - SIO_KEEPALIVE_VALS as SIO_KEEPALIVE_VALS, - SIO_LOOPBACK_FAST_PATH as SIO_LOOPBACK_FAST_PATH, - SIO_RCVALL as SIO_RCVALL, - SO_EXCLUSIVEADDRUSE as SO_EXCLUSIVEADDRUSE, - ) - -if sys.platform != "darwin" or sys.version_info >= (3, 9): - from _socket import ( - IPV6_DONTFRAG as IPV6_DONTFRAG, - IPV6_HOPLIMIT as IPV6_HOPLIMIT, - IPV6_HOPOPTS as IPV6_HOPOPTS, - IPV6_PKTINFO as IPV6_PKTINFO, - IPV6_RECVRTHDR as IPV6_RECVRTHDR, - IPV6_RTHDR as IPV6_RTHDR, - ) - -if sys.platform == "darwin": - from _socket import PF_SYSTEM as PF_SYSTEM, SYSPROTO_CONTROL as SYSPROTO_CONTROL - -if sys.platform != "darwin": - from _socket import ( - IPPROTO_CBT as IPPROTO_CBT, - IPPROTO_ICLFXBM as IPPROTO_ICLFXBM, - IPPROTO_IGP as IPPROTO_IGP, - IPPROTO_L2TP as IPPROTO_L2TP, - IPPROTO_PGM as IPPROTO_PGM, - IPPROTO_RDP as IPPROTO_RDP, - IPPROTO_ST as IPPROTO_ST, - TCP_KEEPIDLE as TCP_KEEPIDLE, - ) - -if sys.version_info >= (3, 10): - from _socket import IP_RECVTOS as IP_RECVTOS -elif sys.platform != "win32" and sys.platform != "darwin": - from _socket import IP_RECVTOS as IP_RECVTOS - -if sys.platform != "win32" and sys.platform != "darwin": - from _socket import ( - IP_BIND_ADDRESS_NO_PORT as IP_BIND_ADDRESS_NO_PORT, - IP_TRANSPARENT as IP_TRANSPARENT, - IPPROTO_BIP as IPPROTO_BIP, - IPPROTO_MOBILE as IPPROTO_MOBILE, - IPPROTO_VRRP as IPPROTO_VRRP, - IPX_TYPE as IPX_TYPE, - SCM_CREDENTIALS as SCM_CREDENTIALS, - SO_BINDTODEVICE as SO_BINDTODEVICE, - SO_DOMAIN as SO_DOMAIN, - SO_MARK as SO_MARK, - SO_PASSCRED as SO_PASSCRED, - SO_PASSSEC as SO_PASSSEC, - SO_PEERCRED as SO_PEERCRED, - SO_PEERSEC as SO_PEERSEC, - SO_PRIORITY as SO_PRIORITY, - SO_PROTOCOL as SO_PROTOCOL, - SO_SETFIB as SO_SETFIB, - SOL_ATALK as SOL_ATALK, - SOL_AX25 as SOL_AX25, - SOL_HCI as SOL_HCI, - SOL_IPX as SOL_IPX, - SOL_NETROM as SOL_NETROM, - SOL_ROSE as SOL_ROSE, - TCP_CONGESTION as TCP_CONGESTION, - TCP_CORK as TCP_CORK, - TCP_DEFER_ACCEPT as TCP_DEFER_ACCEPT, - TCP_INFO as TCP_INFO, - TCP_LINGER2 as TCP_LINGER2, - TCP_QUICKACK as TCP_QUICKACK, - TCP_SYNCNT as TCP_SYNCNT, - TCP_USER_TIMEOUT as TCP_USER_TIMEOUT, - TCP_WINDOW_CLAMP as TCP_WINDOW_CLAMP, - ) - -if sys.platform != "win32": - from _socket import ( - CMSG_LEN as CMSG_LEN, - CMSG_SPACE as CMSG_SPACE, - EAI_ADDRFAMILY as EAI_ADDRFAMILY, - EAI_BADHINTS as EAI_BADHINTS, - EAI_MAX as EAI_MAX, - EAI_OVERFLOW as EAI_OVERFLOW, - EAI_PROTOCOL as EAI_PROTOCOL, - EAI_SYSTEM as EAI_SYSTEM, - IP_DEFAULT_MULTICAST_LOOP as IP_DEFAULT_MULTICAST_LOOP, - IP_DEFAULT_MULTICAST_TTL as IP_DEFAULT_MULTICAST_TTL, - IP_MAX_MEMBERSHIPS as IP_MAX_MEMBERSHIPS, - IP_RECVOPTS as IP_RECVOPTS, - IP_RECVRETOPTS as IP_RECVRETOPTS, - IP_RETOPTS as IP_RETOPTS, - IPPROTO_EON as IPPROTO_EON, - IPPROTO_GRE as IPPROTO_GRE, - IPPROTO_HELLO as IPPROTO_HELLO, - IPPROTO_IPCOMP as IPPROTO_IPCOMP, - IPPROTO_IPIP as IPPROTO_IPIP, - IPPROTO_RSVP as IPPROTO_RSVP, - IPPROTO_TP as IPPROTO_TP, - IPPROTO_XTP as IPPROTO_XTP, - IPV6_RTHDR_TYPE_0 as IPV6_RTHDR_TYPE_0, - LOCAL_PEERCRED as LOCAL_PEERCRED, - SCM_CREDS as SCM_CREDS, - SCM_RIGHTS as SCM_RIGHTS, - SO_REUSEPORT as SO_REUSEPORT, - TCP_NOTSENT_LOWAT as TCP_NOTSENT_LOWAT, - sethostname as sethostname, - ) - - if sys.platform != "darwin" or sys.version_info >= (3, 9): - from _socket import ( - IPV6_DSTOPTS as IPV6_DSTOPTS, - IPV6_NEXTHOP as IPV6_NEXTHOP, - IPV6_PATHMTU as IPV6_PATHMTU, - IPV6_RECVDSTOPTS as IPV6_RECVDSTOPTS, - IPV6_RECVHOPLIMIT as IPV6_RECVHOPLIMIT, - IPV6_RECVHOPOPTS as IPV6_RECVHOPOPTS, - IPV6_RECVPATHMTU as IPV6_RECVPATHMTU, - IPV6_RECVPKTINFO as IPV6_RECVPKTINFO, - IPV6_RTHDRDSTOPTS as IPV6_RTHDRDSTOPTS, - IPV6_USE_MIN_MTU as IPV6_USE_MIN_MTU, - ) - -if sys.platform != "darwin": - if sys.platform != "win32" or sys.version_info >= (3, 9): - from _socket import BDADDR_ANY as BDADDR_ANY, BDADDR_LOCAL as BDADDR_LOCAL, BTPROTO_RFCOMM as BTPROTO_RFCOMM - -if sys.platform == "darwin" and sys.version_info >= (3, 10): - from _socket import TCP_KEEPALIVE as TCP_KEEPALIVE - -if sys.platform == "darwin" and sys.version_info >= (3, 11): - from _socket import TCP_CONNECTION_INFO as TCP_CONNECTION_INFO - -if sys.platform == "linux": - from _socket import ( - ALG_OP_DECRYPT as ALG_OP_DECRYPT, - ALG_OP_ENCRYPT as ALG_OP_ENCRYPT, - ALG_OP_SIGN as ALG_OP_SIGN, - ALG_OP_VERIFY as ALG_OP_VERIFY, - ALG_SET_AEAD_ASSOCLEN as ALG_SET_AEAD_ASSOCLEN, - ALG_SET_AEAD_AUTHSIZE as ALG_SET_AEAD_AUTHSIZE, - ALG_SET_IV as ALG_SET_IV, - ALG_SET_KEY as ALG_SET_KEY, - ALG_SET_OP as ALG_SET_OP, - ALG_SET_PUBKEY as ALG_SET_PUBKEY, - CAN_BCM as CAN_BCM, - CAN_BCM_CAN_FD_FRAME as CAN_BCM_CAN_FD_FRAME, - CAN_BCM_RX_ANNOUNCE_RESUME as CAN_BCM_RX_ANNOUNCE_RESUME, - CAN_BCM_RX_CHANGED as CAN_BCM_RX_CHANGED, - CAN_BCM_RX_CHECK_DLC as CAN_BCM_RX_CHECK_DLC, - CAN_BCM_RX_DELETE as CAN_BCM_RX_DELETE, - CAN_BCM_RX_FILTER_ID as CAN_BCM_RX_FILTER_ID, - CAN_BCM_RX_NO_AUTOTIMER as CAN_BCM_RX_NO_AUTOTIMER, - CAN_BCM_RX_READ as CAN_BCM_RX_READ, - CAN_BCM_RX_RTR_FRAME as CAN_BCM_RX_RTR_FRAME, - CAN_BCM_RX_SETUP as CAN_BCM_RX_SETUP, - CAN_BCM_RX_STATUS as CAN_BCM_RX_STATUS, - CAN_BCM_RX_TIMEOUT as CAN_BCM_RX_TIMEOUT, - CAN_BCM_SETTIMER as CAN_BCM_SETTIMER, - CAN_BCM_STARTTIMER as CAN_BCM_STARTTIMER, - CAN_BCM_TX_ANNOUNCE as CAN_BCM_TX_ANNOUNCE, - CAN_BCM_TX_COUNTEVT as CAN_BCM_TX_COUNTEVT, - CAN_BCM_TX_CP_CAN_ID as CAN_BCM_TX_CP_CAN_ID, - CAN_BCM_TX_DELETE as CAN_BCM_TX_DELETE, - CAN_BCM_TX_EXPIRED as CAN_BCM_TX_EXPIRED, - CAN_BCM_TX_READ as CAN_BCM_TX_READ, - CAN_BCM_TX_RESET_MULTI_IDX as CAN_BCM_TX_RESET_MULTI_IDX, - CAN_BCM_TX_SEND as CAN_BCM_TX_SEND, - CAN_BCM_TX_SETUP as CAN_BCM_TX_SETUP, - CAN_BCM_TX_STATUS as CAN_BCM_TX_STATUS, - CAN_EFF_FLAG as CAN_EFF_FLAG, - CAN_EFF_MASK as CAN_EFF_MASK, - CAN_ERR_FLAG as CAN_ERR_FLAG, - CAN_ERR_MASK as CAN_ERR_MASK, - CAN_ISOTP as CAN_ISOTP, - CAN_RAW as CAN_RAW, - CAN_RAW_ERR_FILTER as CAN_RAW_ERR_FILTER, - CAN_RAW_FD_FRAMES as CAN_RAW_FD_FRAMES, - CAN_RAW_FILTER as CAN_RAW_FILTER, - CAN_RAW_LOOPBACK as CAN_RAW_LOOPBACK, - CAN_RAW_RECV_OWN_MSGS as CAN_RAW_RECV_OWN_MSGS, - CAN_RTR_FLAG as CAN_RTR_FLAG, - CAN_SFF_MASK as CAN_SFF_MASK, - IOCTL_VM_SOCKETS_GET_LOCAL_CID as IOCTL_VM_SOCKETS_GET_LOCAL_CID, - NETLINK_ARPD as NETLINK_ARPD, - NETLINK_CRYPTO as NETLINK_CRYPTO, - NETLINK_DNRTMSG as NETLINK_DNRTMSG, - NETLINK_FIREWALL as NETLINK_FIREWALL, - NETLINK_IP6_FW as NETLINK_IP6_FW, - NETLINK_NFLOG as NETLINK_NFLOG, - NETLINK_ROUTE as NETLINK_ROUTE, - NETLINK_ROUTE6 as NETLINK_ROUTE6, - NETLINK_SKIP as NETLINK_SKIP, - NETLINK_TAPBASE as NETLINK_TAPBASE, - NETLINK_TCPDIAG as NETLINK_TCPDIAG, - NETLINK_USERSOCK as NETLINK_USERSOCK, - NETLINK_W1 as NETLINK_W1, - NETLINK_XFRM as NETLINK_XFRM, - PACKET_BROADCAST as PACKET_BROADCAST, - PACKET_FASTROUTE as PACKET_FASTROUTE, - PACKET_HOST as PACKET_HOST, - PACKET_LOOPBACK as PACKET_LOOPBACK, - PACKET_MULTICAST as PACKET_MULTICAST, - PACKET_OTHERHOST as PACKET_OTHERHOST, - PACKET_OUTGOING as PACKET_OUTGOING, - PF_CAN as PF_CAN, - PF_PACKET as PF_PACKET, - PF_RDS as PF_RDS, - RDS_CANCEL_SENT_TO as RDS_CANCEL_SENT_TO, - RDS_CMSG_RDMA_ARGS as RDS_CMSG_RDMA_ARGS, - RDS_CMSG_RDMA_DEST as RDS_CMSG_RDMA_DEST, - RDS_CMSG_RDMA_MAP as RDS_CMSG_RDMA_MAP, - RDS_CMSG_RDMA_STATUS as RDS_CMSG_RDMA_STATUS, - RDS_CMSG_RDMA_UPDATE as RDS_CMSG_RDMA_UPDATE, - RDS_CONG_MONITOR as RDS_CONG_MONITOR, - RDS_FREE_MR as RDS_FREE_MR, - RDS_GET_MR as RDS_GET_MR, - RDS_GET_MR_FOR_DEST as RDS_GET_MR_FOR_DEST, - RDS_RDMA_DONTWAIT as RDS_RDMA_DONTWAIT, - RDS_RDMA_FENCE as RDS_RDMA_FENCE, - RDS_RDMA_INVALIDATE as RDS_RDMA_INVALIDATE, - RDS_RDMA_NOTIFY_ME as RDS_RDMA_NOTIFY_ME, - RDS_RDMA_READWRITE as RDS_RDMA_READWRITE, - RDS_RDMA_SILENT as RDS_RDMA_SILENT, - RDS_RDMA_USE_ONCE as RDS_RDMA_USE_ONCE, - RDS_RECVERR as RDS_RECVERR, - SO_VM_SOCKETS_BUFFER_MAX_SIZE as SO_VM_SOCKETS_BUFFER_MAX_SIZE, - SO_VM_SOCKETS_BUFFER_MIN_SIZE as SO_VM_SOCKETS_BUFFER_MIN_SIZE, - SO_VM_SOCKETS_BUFFER_SIZE as SO_VM_SOCKETS_BUFFER_SIZE, - SOL_ALG as SOL_ALG, - SOL_CAN_BASE as SOL_CAN_BASE, - SOL_CAN_RAW as SOL_CAN_RAW, - SOL_RDS as SOL_RDS, - SOL_TIPC as SOL_TIPC, - TIPC_ADDR_ID as TIPC_ADDR_ID, - TIPC_ADDR_NAME as TIPC_ADDR_NAME, - TIPC_ADDR_NAMESEQ as TIPC_ADDR_NAMESEQ, - TIPC_CFG_SRV as TIPC_CFG_SRV, - TIPC_CLUSTER_SCOPE as TIPC_CLUSTER_SCOPE, - TIPC_CONN_TIMEOUT as TIPC_CONN_TIMEOUT, - TIPC_CRITICAL_IMPORTANCE as TIPC_CRITICAL_IMPORTANCE, - TIPC_DEST_DROPPABLE as TIPC_DEST_DROPPABLE, - TIPC_HIGH_IMPORTANCE as TIPC_HIGH_IMPORTANCE, - TIPC_IMPORTANCE as TIPC_IMPORTANCE, - TIPC_LOW_IMPORTANCE as TIPC_LOW_IMPORTANCE, - TIPC_MEDIUM_IMPORTANCE as TIPC_MEDIUM_IMPORTANCE, - TIPC_NODE_SCOPE as TIPC_NODE_SCOPE, - TIPC_PUBLISHED as TIPC_PUBLISHED, - TIPC_SRC_DROPPABLE as TIPC_SRC_DROPPABLE, - TIPC_SUB_CANCEL as TIPC_SUB_CANCEL, - TIPC_SUB_PORTS as TIPC_SUB_PORTS, - TIPC_SUB_SERVICE as TIPC_SUB_SERVICE, - TIPC_SUBSCR_TIMEOUT as TIPC_SUBSCR_TIMEOUT, - TIPC_TOP_SRV as TIPC_TOP_SRV, - TIPC_WAIT_FOREVER as TIPC_WAIT_FOREVER, - TIPC_WITHDRAWN as TIPC_WITHDRAWN, - TIPC_ZONE_SCOPE as TIPC_ZONE_SCOPE, - VM_SOCKETS_INVALID_VERSION as VM_SOCKETS_INVALID_VERSION, - VMADDR_CID_ANY as VMADDR_CID_ANY, - VMADDR_CID_HOST as VMADDR_CID_HOST, - VMADDR_PORT_ANY as VMADDR_PORT_ANY, - ) - -if sys.platform == "linux" and sys.version_info >= (3, 9): - from _socket import ( - CAN_J1939 as CAN_J1939, - CAN_RAW_JOIN_FILTERS as CAN_RAW_JOIN_FILTERS, - J1939_EE_INFO_NONE as J1939_EE_INFO_NONE, - J1939_EE_INFO_TX_ABORT as J1939_EE_INFO_TX_ABORT, - J1939_FILTER_MAX as J1939_FILTER_MAX, - J1939_IDLE_ADDR as J1939_IDLE_ADDR, - J1939_MAX_UNICAST_ADDR as J1939_MAX_UNICAST_ADDR, - J1939_NLA_BYTES_ACKED as J1939_NLA_BYTES_ACKED, - J1939_NLA_PAD as J1939_NLA_PAD, - J1939_NO_ADDR as J1939_NO_ADDR, - J1939_NO_NAME as J1939_NO_NAME, - J1939_NO_PGN as J1939_NO_PGN, - J1939_PGN_ADDRESS_CLAIMED as J1939_PGN_ADDRESS_CLAIMED, - J1939_PGN_ADDRESS_COMMANDED as J1939_PGN_ADDRESS_COMMANDED, - J1939_PGN_MAX as J1939_PGN_MAX, - J1939_PGN_PDU1_MAX as J1939_PGN_PDU1_MAX, - J1939_PGN_REQUEST as J1939_PGN_REQUEST, - SCM_J1939_DEST_ADDR as SCM_J1939_DEST_ADDR, - SCM_J1939_DEST_NAME as SCM_J1939_DEST_NAME, - SCM_J1939_ERRQUEUE as SCM_J1939_ERRQUEUE, - SCM_J1939_PRIO as SCM_J1939_PRIO, - SO_J1939_ERRQUEUE as SO_J1939_ERRQUEUE, - SO_J1939_FILTER as SO_J1939_FILTER, - SO_J1939_PROMISC as SO_J1939_PROMISC, - SO_J1939_SEND_PRIO as SO_J1939_SEND_PRIO, - UDPLITE_RECV_CSCOV as UDPLITE_RECV_CSCOV, - UDPLITE_SEND_CSCOV as UDPLITE_SEND_CSCOV, - ) -if sys.platform == "linux" and sys.version_info >= (3, 10): - from _socket import IPPROTO_MPTCP as IPPROTO_MPTCP -if sys.platform == "linux" and sys.version_info >= (3, 11): - from _socket import SO_INCOMING_CPU as SO_INCOMING_CPU - -if sys.version_info >= (3, 12): - from _socket import ( - IP_ADD_SOURCE_MEMBERSHIP as IP_ADD_SOURCE_MEMBERSHIP, - IP_BLOCK_SOURCE as IP_BLOCK_SOURCE, - IP_DROP_SOURCE_MEMBERSHIP as IP_DROP_SOURCE_MEMBERSHIP, - IP_PKTINFO as IP_PKTINFO, - IP_UNBLOCK_SOURCE as IP_UNBLOCK_SOURCE, - ) - - if sys.platform == "win32": - from _socket import ( - HV_GUID_BROADCAST as HV_GUID_BROADCAST, - HV_GUID_CHILDREN as HV_GUID_CHILDREN, - HV_GUID_LOOPBACK as HV_GUID_LOOPBACK, - HV_GUID_PARENT as HV_GUID_PARENT, - HV_GUID_WILDCARD as HV_GUID_WILDCARD, - HV_GUID_ZERO as HV_GUID_ZERO, - HV_PROTOCOL_RAW as HV_PROTOCOL_RAW, - HVSOCKET_ADDRESS_FLAG_PASSTHRU as HVSOCKET_ADDRESS_FLAG_PASSTHRU, - HVSOCKET_CONNECT_TIMEOUT as HVSOCKET_CONNECT_TIMEOUT, - HVSOCKET_CONNECT_TIMEOUT_MAX as HVSOCKET_CONNECT_TIMEOUT_MAX, - HVSOCKET_CONNECTED_SUSPEND as HVSOCKET_CONNECTED_SUSPEND, - ) - else: - from _socket import ( - ETHERTYPE_ARP as ETHERTYPE_ARP, - ETHERTYPE_IP as ETHERTYPE_IP, - ETHERTYPE_IPV6 as ETHERTYPE_IPV6, - ETHERTYPE_VLAN as ETHERTYPE_VLAN, - ) - - if sys.platform == "linux": - from _socket import ETH_P_ALL as ETH_P_ALL - - if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin": - # FreeBSD >= 14.0 - from _socket import PF_DIVERT as PF_DIVERT - -# Re-exported from errno -EBADF: int -EAGAIN: int -EWOULDBLOCK: int - -# These errors are implemented in _socket at runtime -# but they consider themselves to live in socket so we'll put them here. -error = OSError - -class herror(error): ... -class gaierror(error): ... - -if sys.version_info >= (3, 10): - timeout = TimeoutError -else: - class timeout(error): ... - -class AddressFamily(IntEnum): - AF_INET = 2 - AF_INET6 = 10 - AF_APPLETALK = 5 - AF_DECnet = ... - AF_IPX = 4 - AF_SNA = 22 - AF_UNSPEC = 0 - if sys.platform != "darwin": - AF_IRDA = 23 - if sys.platform != "win32": - AF_ROUTE = 16 - AF_SYSTEM = 32 - AF_UNIX = 1 - if sys.platform != "win32" and sys.platform != "darwin": - AF_AAL5 = ... - AF_ASH = 18 - AF_ATMPVC = 8 - AF_ATMSVC = 20 - AF_AX25 = 3 - AF_BRIDGE = 7 - AF_ECONET = 19 - AF_KEY = 15 - AF_LLC = 26 - AF_NETBEUI = 13 - AF_NETROM = 6 - AF_PPPOX = 24 - AF_ROSE = 11 - AF_SECURITY = 14 - AF_WANPIPE = 25 - AF_X25 = 9 - if sys.platform == "linux": - AF_CAN = 29 - AF_PACKET = 17 - AF_RDS = 21 - AF_TIPC = 30 - AF_ALG = 38 - AF_NETLINK = 16 - AF_VSOCK = 40 - AF_QIPCRTR = 42 - if sys.platform != "win32" or sys.version_info >= (3, 9): - AF_LINK = 33 - if sys.platform != "darwin": - AF_BLUETOOTH = 32 - if sys.platform == "win32" and sys.version_info >= (3, 12): - AF_HYPERV = 34 - if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 12): - # FreeBSD >= 14.0 - AF_DIVERT = 44 - -AF_INET = AddressFamily.AF_INET -AF_INET6 = AddressFamily.AF_INET6 -AF_APPLETALK = AddressFamily.AF_APPLETALK -AF_DECnet = AddressFamily.AF_DECnet -AF_IPX = AddressFamily.AF_IPX -AF_SNA = AddressFamily.AF_SNA -AF_UNSPEC = AddressFamily.AF_UNSPEC - -if sys.platform != "darwin": - AF_IRDA = AddressFamily.AF_IRDA - -if sys.platform != "win32": - AF_ROUTE = AddressFamily.AF_ROUTE - AF_SYSTEM = AddressFamily.AF_SYSTEM - AF_UNIX = AddressFamily.AF_UNIX - -if sys.platform != "win32" and sys.platform != "darwin": - AF_AAL5 = AddressFamily.AF_AAL5 - AF_ASH = AddressFamily.AF_ASH - AF_ATMPVC = AddressFamily.AF_ATMPVC - AF_ATMSVC = AddressFamily.AF_ATMSVC - AF_AX25 = AddressFamily.AF_AX25 - AF_BRIDGE = AddressFamily.AF_BRIDGE - AF_ECONET = AddressFamily.AF_ECONET - AF_KEY = AddressFamily.AF_KEY - AF_LLC = AddressFamily.AF_LLC - AF_NETBEUI = AddressFamily.AF_NETBEUI - AF_NETROM = AddressFamily.AF_NETROM - AF_PPPOX = AddressFamily.AF_PPPOX - AF_ROSE = AddressFamily.AF_ROSE - AF_SECURITY = AddressFamily.AF_SECURITY - AF_WANPIPE = AddressFamily.AF_WANPIPE - AF_X25 = AddressFamily.AF_X25 - -if sys.platform == "linux": - AF_CAN = AddressFamily.AF_CAN - AF_PACKET = AddressFamily.AF_PACKET - AF_RDS = AddressFamily.AF_RDS - AF_TIPC = AddressFamily.AF_TIPC - AF_ALG = AddressFamily.AF_ALG - AF_NETLINK = AddressFamily.AF_NETLINK - AF_VSOCK = AddressFamily.AF_VSOCK - AF_QIPCRTR = AddressFamily.AF_QIPCRTR - -if sys.platform != "win32" or sys.version_info >= (3, 9): - AF_LINK = AddressFamily.AF_LINK - if sys.platform != "darwin": - AF_BLUETOOTH = AddressFamily.AF_BLUETOOTH - -if sys.platform == "win32" and sys.version_info >= (3, 12): - AF_HYPERV = AddressFamily.AF_HYPERV -if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 12): - # FreeBSD >= 14.0 - AF_DIVERT = AddressFamily.AF_DIVERT - -class SocketKind(IntEnum): - SOCK_STREAM = 1 - SOCK_DGRAM = 2 - SOCK_RAW = 3 - SOCK_RDM = 4 - SOCK_SEQPACKET = 5 - if sys.platform == "linux": - SOCK_CLOEXEC = 524288 - SOCK_NONBLOCK = 2048 - -SOCK_STREAM = SocketKind.SOCK_STREAM -SOCK_DGRAM = SocketKind.SOCK_DGRAM -SOCK_RAW = SocketKind.SOCK_RAW -SOCK_RDM = SocketKind.SOCK_RDM -SOCK_SEQPACKET = SocketKind.SOCK_SEQPACKET -if sys.platform == "linux": - SOCK_CLOEXEC = SocketKind.SOCK_CLOEXEC - SOCK_NONBLOCK = SocketKind.SOCK_NONBLOCK - -class MsgFlag(IntFlag): - MSG_CTRUNC = 8 - MSG_DONTROUTE = 4 - MSG_OOB = 1 - MSG_PEEK = 2 - MSG_TRUNC = 32 - MSG_WAITALL = 256 - - if sys.platform != "darwin": - MSG_BCAST = 1024 - MSG_MCAST = 2048 - MSG_ERRQUEUE = 8192 - - if sys.platform != "win32" and sys.platform != "darwin": - MSG_BTAG = ... - MSG_CMSG_CLOEXEC = 1073741821 - MSG_CONFIRM = 2048 - MSG_ETAG = ... - MSG_FASTOPEN = 536870912 - MSG_MORE = 32768 - MSG_NOTIFICATION = ... - - if sys.platform != "win32": - MSG_DONTWAIT = 64 - MSG_EOF = 256 - MSG_EOR = 128 - MSG_NOSIGNAL = 16384 # sometimes this exists on darwin, sometimes not - -MSG_CTRUNC = MsgFlag.MSG_CTRUNC -MSG_DONTROUTE = MsgFlag.MSG_DONTROUTE -MSG_OOB = MsgFlag.MSG_OOB -MSG_PEEK = MsgFlag.MSG_PEEK -MSG_TRUNC = MsgFlag.MSG_TRUNC -MSG_WAITALL = MsgFlag.MSG_WAITALL - -if sys.platform != "darwin": - MSG_BCAST = MsgFlag.MSG_BCAST - MSG_MCAST = MsgFlag.MSG_MCAST - MSG_ERRQUEUE = MsgFlag.MSG_ERRQUEUE - -if sys.platform != "win32": - MSG_DONTWAIT = MsgFlag.MSG_DONTWAIT - MSG_EOF = MsgFlag.MSG_EOF - MSG_EOR = MsgFlag.MSG_EOR - MSG_NOSIGNAL = MsgFlag.MSG_NOSIGNAL # Sometimes this exists on darwin, sometimes not - -if sys.platform != "win32" and sys.platform != "darwin": - MSG_BTAG = MsgFlag.MSG_BTAG - MSG_CMSG_CLOEXEC = MsgFlag.MSG_CMSG_CLOEXEC - MSG_CONFIRM = MsgFlag.MSG_CONFIRM - MSG_ETAG = MsgFlag.MSG_ETAG - MSG_FASTOPEN = MsgFlag.MSG_FASTOPEN - MSG_MORE = MsgFlag.MSG_MORE - MSG_NOTIFICATION = MsgFlag.MSG_NOTIFICATION - -class AddressInfo(IntFlag): - AI_ADDRCONFIG = 32 - AI_ALL = 16 - AI_CANONNAME = 2 - AI_NUMERICHOST = 4 - AI_NUMERICSERV = 1024 - AI_PASSIVE = 1 - AI_V4MAPPED = 8 - if sys.platform != "win32": - AI_DEFAULT = 1536 - AI_MASK = 5127 - AI_V4MAPPED_CFG = 512 - -AI_ADDRCONFIG = AddressInfo.AI_ADDRCONFIG -AI_ALL = AddressInfo.AI_ALL -AI_CANONNAME = AddressInfo.AI_CANONNAME -AI_NUMERICHOST = AddressInfo.AI_NUMERICHOST -AI_NUMERICSERV = AddressInfo.AI_NUMERICSERV -AI_PASSIVE = AddressInfo.AI_PASSIVE -AI_V4MAPPED = AddressInfo.AI_V4MAPPED - -if sys.platform != "win32": - AI_DEFAULT = AddressInfo.AI_DEFAULT - AI_MASK = AddressInfo.AI_MASK - AI_V4MAPPED_CFG = AddressInfo.AI_V4MAPPED_CFG - -if sys.platform == "win32": - errorTab: dict[int, str] # undocumented - -class _SendableFile(Protocol): - def read(self, size: int, /) -> bytes: ... - def seek(self, offset: int, /) -> object: ... - - # optional fields: - # - # @property - # def mode(self) -> str: ... - # def fileno(self) -> int: ... - -class socket(_socket.socket): - def __init__( - self, family: AddressFamily | int = -1, type: SocketKind | int = -1, proto: int = -1, fileno: int | None = None - ) -> None: ... - def __enter__(self) -> Self: ... - def __exit__(self, *args: Unused) -> None: ... - def dup(self) -> Self: ... # noqa: F811 - def accept(self) -> tuple[socket, _RetAddress]: ... - # Note that the makefile's documented windows-specific behavior is not represented - # mode strings with duplicates are intentionally excluded - @overload - def makefile( - self, - mode: Literal["b", "rb", "br", "wb", "bw", "rwb", "rbw", "wrb", "wbr", "brw", "bwr"], - buffering: Literal[0], - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> SocketIO: ... - @overload - def makefile( - self, - mode: Literal["rwb", "rbw", "wrb", "wbr", "brw", "bwr"], - buffering: Literal[-1, 1] | None = None, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> BufferedRWPair: ... - @overload - def makefile( - self, - mode: Literal["rb", "br"], - buffering: Literal[-1, 1] | None = None, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> BufferedReader: ... - @overload - def makefile( - self, - mode: Literal["wb", "bw"], - buffering: Literal[-1, 1] | None = None, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> BufferedWriter: ... - @overload - def makefile( - self, - mode: Literal["b", "rb", "br", "wb", "bw", "rwb", "rbw", "wrb", "wbr", "brw", "bwr"], - buffering: int, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> IOBase: ... - @overload - def makefile( - self, - mode: Literal["r", "w", "rw", "wr", ""] = "r", - buffering: int | None = None, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> TextIOWrapper: ... - def sendfile(self, file: _SendableFile, offset: int = 0, count: int | None = None) -> int: ... - @property - def family(self) -> AddressFamily: ... - @property - def type(self) -> SocketKind: ... - def get_inheritable(self) -> bool: ... - def set_inheritable(self, inheritable: bool) -> None: ... - -def fromfd(fd: SupportsIndex, family: AddressFamily | int, type: SocketKind | int, proto: int = 0) -> socket: ... - -if sys.platform != "win32": - if sys.version_info >= (3, 9): - def send_fds( - sock: socket, buffers: Iterable[ReadableBuffer], fds: Iterable[int], flags: Unused = 0, address: Unused = None - ) -> int: ... - def recv_fds(sock: socket, bufsize: int, maxfds: int, flags: int = 0) -> tuple[bytes, list[int], int, Any]: ... - -if sys.platform == "win32": - def fromshare(info: bytes) -> socket: ... - -if sys.platform == "win32": - def socketpair(family: int = ..., type: int = ..., proto: int = 0) -> tuple[socket, socket]: ... - -else: - def socketpair( - family: int | AddressFamily | None = None, type: SocketType | int = ..., proto: int = 0 - ) -> tuple[socket, socket]: ... - -class SocketIO(RawIOBase): - def __init__(self, sock: socket, mode: Literal["r", "w", "rw", "rb", "wb", "rwb"]) -> None: ... - def readinto(self, b: WriteableBuffer) -> int | None: ... - def write(self, b: ReadableBuffer) -> int | None: ... - @property - def name(self) -> int: ... # return value is really "int" - @property - def mode(self) -> Literal["rb", "wb", "rwb"]: ... - -def getfqdn(name: str = "") -> str: ... - -if sys.version_info >= (3, 11): - def create_connection( - address: tuple[str | None, int], - timeout: float | None = ..., - source_address: _Address | None = None, - *, - all_errors: bool = False, - ) -> socket: ... - -else: - def create_connection( - address: tuple[str | None, int], timeout: float | None = ..., source_address: _Address | None = None - ) -> socket: ... - -def has_dualstack_ipv6() -> bool: ... -def create_server( - address: _Address, *, family: int = ..., backlog: int | None = None, reuse_port: bool = False, dualstack_ipv6: bool = False -) -> socket: ... - -# the 5th tuple item is an address -def getaddrinfo( - host: bytes | str | None, port: bytes | str | int | None, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0 -) -> list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int]]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi deleted file mode 100644 index 3c3e7c6e5b40a..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi +++ /dev/null @@ -1,465 +0,0 @@ -import sys -from _typeshed import ReadableBuffer, StrOrBytesPath, SupportsLenAndGetItem, Unused -from collections.abc import Callable, Generator, Iterable, Iterator, Mapping, Sequence -from sqlite3.dbapi2 import ( - PARSE_COLNAMES as PARSE_COLNAMES, - PARSE_DECLTYPES as PARSE_DECLTYPES, - SQLITE_ALTER_TABLE as SQLITE_ALTER_TABLE, - SQLITE_ANALYZE as SQLITE_ANALYZE, - SQLITE_ATTACH as SQLITE_ATTACH, - SQLITE_CREATE_INDEX as SQLITE_CREATE_INDEX, - SQLITE_CREATE_TABLE as SQLITE_CREATE_TABLE, - SQLITE_CREATE_TEMP_INDEX as SQLITE_CREATE_TEMP_INDEX, - SQLITE_CREATE_TEMP_TABLE as SQLITE_CREATE_TEMP_TABLE, - SQLITE_CREATE_TEMP_TRIGGER as SQLITE_CREATE_TEMP_TRIGGER, - SQLITE_CREATE_TEMP_VIEW as SQLITE_CREATE_TEMP_VIEW, - SQLITE_CREATE_TRIGGER as SQLITE_CREATE_TRIGGER, - SQLITE_CREATE_VIEW as SQLITE_CREATE_VIEW, - SQLITE_CREATE_VTABLE as SQLITE_CREATE_VTABLE, - SQLITE_DELETE as SQLITE_DELETE, - SQLITE_DENY as SQLITE_DENY, - SQLITE_DETACH as SQLITE_DETACH, - SQLITE_DONE as SQLITE_DONE, - SQLITE_DROP_INDEX as SQLITE_DROP_INDEX, - SQLITE_DROP_TABLE as SQLITE_DROP_TABLE, - SQLITE_DROP_TEMP_INDEX as SQLITE_DROP_TEMP_INDEX, - SQLITE_DROP_TEMP_TABLE as SQLITE_DROP_TEMP_TABLE, - SQLITE_DROP_TEMP_TRIGGER as SQLITE_DROP_TEMP_TRIGGER, - SQLITE_DROP_TEMP_VIEW as SQLITE_DROP_TEMP_VIEW, - SQLITE_DROP_TRIGGER as SQLITE_DROP_TRIGGER, - SQLITE_DROP_VIEW as SQLITE_DROP_VIEW, - SQLITE_DROP_VTABLE as SQLITE_DROP_VTABLE, - SQLITE_FUNCTION as SQLITE_FUNCTION, - SQLITE_IGNORE as SQLITE_IGNORE, - SQLITE_INSERT as SQLITE_INSERT, - SQLITE_OK as SQLITE_OK, - SQLITE_PRAGMA as SQLITE_PRAGMA, - SQLITE_READ as SQLITE_READ, - SQLITE_RECURSIVE as SQLITE_RECURSIVE, - SQLITE_REINDEX as SQLITE_REINDEX, - SQLITE_SAVEPOINT as SQLITE_SAVEPOINT, - SQLITE_SELECT as SQLITE_SELECT, - SQLITE_TRANSACTION as SQLITE_TRANSACTION, - SQLITE_UPDATE as SQLITE_UPDATE, - Binary as Binary, - Date as Date, - DateFromTicks as DateFromTicks, - Time as Time, - TimeFromTicks as TimeFromTicks, - TimestampFromTicks as TimestampFromTicks, - adapt as adapt, - adapters as adapters, - apilevel as apilevel, - complete_statement as complete_statement, - connect as connect, - converters as converters, - enable_callback_tracebacks as enable_callback_tracebacks, - paramstyle as paramstyle, - register_adapter as register_adapter, - register_converter as register_converter, - sqlite_version as sqlite_version, - sqlite_version_info as sqlite_version_info, - threadsafety as threadsafety, - version_info as version_info, -) -from types import TracebackType -from typing import Any, Literal, Protocol, SupportsIndex, TypeVar, final, overload -from typing_extensions import Self, TypeAlias - -if sys.version_info >= (3, 12): - from sqlite3.dbapi2 import ( - LEGACY_TRANSACTION_CONTROL as LEGACY_TRANSACTION_CONTROL, - SQLITE_DBCONFIG_DEFENSIVE as SQLITE_DBCONFIG_DEFENSIVE, - SQLITE_DBCONFIG_DQS_DDL as SQLITE_DBCONFIG_DQS_DDL, - SQLITE_DBCONFIG_DQS_DML as SQLITE_DBCONFIG_DQS_DML, - SQLITE_DBCONFIG_ENABLE_FKEY as SQLITE_DBCONFIG_ENABLE_FKEY, - SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER as SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, - SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION as SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, - SQLITE_DBCONFIG_ENABLE_QPSG as SQLITE_DBCONFIG_ENABLE_QPSG, - SQLITE_DBCONFIG_ENABLE_TRIGGER as SQLITE_DBCONFIG_ENABLE_TRIGGER, - SQLITE_DBCONFIG_ENABLE_VIEW as SQLITE_DBCONFIG_ENABLE_VIEW, - SQLITE_DBCONFIG_LEGACY_ALTER_TABLE as SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, - SQLITE_DBCONFIG_LEGACY_FILE_FORMAT as SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, - SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE as SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, - SQLITE_DBCONFIG_RESET_DATABASE as SQLITE_DBCONFIG_RESET_DATABASE, - SQLITE_DBCONFIG_TRIGGER_EQP as SQLITE_DBCONFIG_TRIGGER_EQP, - SQLITE_DBCONFIG_TRUSTED_SCHEMA as SQLITE_DBCONFIG_TRUSTED_SCHEMA, - SQLITE_DBCONFIG_WRITABLE_SCHEMA as SQLITE_DBCONFIG_WRITABLE_SCHEMA, - ) - -if sys.version_info >= (3, 11): - from sqlite3.dbapi2 import ( - SQLITE_ABORT as SQLITE_ABORT, - SQLITE_ABORT_ROLLBACK as SQLITE_ABORT_ROLLBACK, - SQLITE_AUTH as SQLITE_AUTH, - SQLITE_AUTH_USER as SQLITE_AUTH_USER, - SQLITE_BUSY as SQLITE_BUSY, - SQLITE_BUSY_RECOVERY as SQLITE_BUSY_RECOVERY, - SQLITE_BUSY_SNAPSHOT as SQLITE_BUSY_SNAPSHOT, - SQLITE_BUSY_TIMEOUT as SQLITE_BUSY_TIMEOUT, - SQLITE_CANTOPEN as SQLITE_CANTOPEN, - SQLITE_CANTOPEN_CONVPATH as SQLITE_CANTOPEN_CONVPATH, - SQLITE_CANTOPEN_DIRTYWAL as SQLITE_CANTOPEN_DIRTYWAL, - SQLITE_CANTOPEN_FULLPATH as SQLITE_CANTOPEN_FULLPATH, - SQLITE_CANTOPEN_ISDIR as SQLITE_CANTOPEN_ISDIR, - SQLITE_CANTOPEN_NOTEMPDIR as SQLITE_CANTOPEN_NOTEMPDIR, - SQLITE_CANTOPEN_SYMLINK as SQLITE_CANTOPEN_SYMLINK, - SQLITE_CONSTRAINT as SQLITE_CONSTRAINT, - SQLITE_CONSTRAINT_CHECK as SQLITE_CONSTRAINT_CHECK, - SQLITE_CONSTRAINT_COMMITHOOK as SQLITE_CONSTRAINT_COMMITHOOK, - SQLITE_CONSTRAINT_FOREIGNKEY as SQLITE_CONSTRAINT_FOREIGNKEY, - SQLITE_CONSTRAINT_FUNCTION as SQLITE_CONSTRAINT_FUNCTION, - SQLITE_CONSTRAINT_NOTNULL as SQLITE_CONSTRAINT_NOTNULL, - SQLITE_CONSTRAINT_PINNED as SQLITE_CONSTRAINT_PINNED, - SQLITE_CONSTRAINT_PRIMARYKEY as SQLITE_CONSTRAINT_PRIMARYKEY, - SQLITE_CONSTRAINT_ROWID as SQLITE_CONSTRAINT_ROWID, - SQLITE_CONSTRAINT_TRIGGER as SQLITE_CONSTRAINT_TRIGGER, - SQLITE_CONSTRAINT_UNIQUE as SQLITE_CONSTRAINT_UNIQUE, - SQLITE_CONSTRAINT_VTAB as SQLITE_CONSTRAINT_VTAB, - SQLITE_CORRUPT as SQLITE_CORRUPT, - SQLITE_CORRUPT_INDEX as SQLITE_CORRUPT_INDEX, - SQLITE_CORRUPT_SEQUENCE as SQLITE_CORRUPT_SEQUENCE, - SQLITE_CORRUPT_VTAB as SQLITE_CORRUPT_VTAB, - SQLITE_EMPTY as SQLITE_EMPTY, - SQLITE_ERROR as SQLITE_ERROR, - SQLITE_ERROR_MISSING_COLLSEQ as SQLITE_ERROR_MISSING_COLLSEQ, - SQLITE_ERROR_RETRY as SQLITE_ERROR_RETRY, - SQLITE_ERROR_SNAPSHOT as SQLITE_ERROR_SNAPSHOT, - SQLITE_FORMAT as SQLITE_FORMAT, - SQLITE_FULL as SQLITE_FULL, - SQLITE_INTERNAL as SQLITE_INTERNAL, - SQLITE_INTERRUPT as SQLITE_INTERRUPT, - SQLITE_IOERR as SQLITE_IOERR, - SQLITE_IOERR_ACCESS as SQLITE_IOERR_ACCESS, - SQLITE_IOERR_AUTH as SQLITE_IOERR_AUTH, - SQLITE_IOERR_BEGIN_ATOMIC as SQLITE_IOERR_BEGIN_ATOMIC, - SQLITE_IOERR_BLOCKED as SQLITE_IOERR_BLOCKED, - SQLITE_IOERR_CHECKRESERVEDLOCK as SQLITE_IOERR_CHECKRESERVEDLOCK, - SQLITE_IOERR_CLOSE as SQLITE_IOERR_CLOSE, - SQLITE_IOERR_COMMIT_ATOMIC as SQLITE_IOERR_COMMIT_ATOMIC, - SQLITE_IOERR_CONVPATH as SQLITE_IOERR_CONVPATH, - SQLITE_IOERR_CORRUPTFS as SQLITE_IOERR_CORRUPTFS, - SQLITE_IOERR_DATA as SQLITE_IOERR_DATA, - SQLITE_IOERR_DELETE as SQLITE_IOERR_DELETE, - SQLITE_IOERR_DELETE_NOENT as SQLITE_IOERR_DELETE_NOENT, - SQLITE_IOERR_DIR_CLOSE as SQLITE_IOERR_DIR_CLOSE, - SQLITE_IOERR_DIR_FSYNC as SQLITE_IOERR_DIR_FSYNC, - SQLITE_IOERR_FSTAT as SQLITE_IOERR_FSTAT, - SQLITE_IOERR_FSYNC as SQLITE_IOERR_FSYNC, - SQLITE_IOERR_GETTEMPPATH as SQLITE_IOERR_GETTEMPPATH, - SQLITE_IOERR_LOCK as SQLITE_IOERR_LOCK, - SQLITE_IOERR_MMAP as SQLITE_IOERR_MMAP, - SQLITE_IOERR_NOMEM as SQLITE_IOERR_NOMEM, - SQLITE_IOERR_RDLOCK as SQLITE_IOERR_RDLOCK, - SQLITE_IOERR_READ as SQLITE_IOERR_READ, - SQLITE_IOERR_ROLLBACK_ATOMIC as SQLITE_IOERR_ROLLBACK_ATOMIC, - SQLITE_IOERR_SEEK as SQLITE_IOERR_SEEK, - SQLITE_IOERR_SHMLOCK as SQLITE_IOERR_SHMLOCK, - SQLITE_IOERR_SHMMAP as SQLITE_IOERR_SHMMAP, - SQLITE_IOERR_SHMOPEN as SQLITE_IOERR_SHMOPEN, - SQLITE_IOERR_SHMSIZE as SQLITE_IOERR_SHMSIZE, - SQLITE_IOERR_SHORT_READ as SQLITE_IOERR_SHORT_READ, - SQLITE_IOERR_TRUNCATE as SQLITE_IOERR_TRUNCATE, - SQLITE_IOERR_UNLOCK as SQLITE_IOERR_UNLOCK, - SQLITE_IOERR_VNODE as SQLITE_IOERR_VNODE, - SQLITE_IOERR_WRITE as SQLITE_IOERR_WRITE, - SQLITE_LIMIT_ATTACHED as SQLITE_LIMIT_ATTACHED, - SQLITE_LIMIT_COLUMN as SQLITE_LIMIT_COLUMN, - SQLITE_LIMIT_COMPOUND_SELECT as SQLITE_LIMIT_COMPOUND_SELECT, - SQLITE_LIMIT_EXPR_DEPTH as SQLITE_LIMIT_EXPR_DEPTH, - SQLITE_LIMIT_FUNCTION_ARG as SQLITE_LIMIT_FUNCTION_ARG, - SQLITE_LIMIT_LENGTH as SQLITE_LIMIT_LENGTH, - SQLITE_LIMIT_LIKE_PATTERN_LENGTH as SQLITE_LIMIT_LIKE_PATTERN_LENGTH, - SQLITE_LIMIT_SQL_LENGTH as SQLITE_LIMIT_SQL_LENGTH, - SQLITE_LIMIT_TRIGGER_DEPTH as SQLITE_LIMIT_TRIGGER_DEPTH, - SQLITE_LIMIT_VARIABLE_NUMBER as SQLITE_LIMIT_VARIABLE_NUMBER, - SQLITE_LIMIT_VDBE_OP as SQLITE_LIMIT_VDBE_OP, - SQLITE_LIMIT_WORKER_THREADS as SQLITE_LIMIT_WORKER_THREADS, - SQLITE_LOCKED as SQLITE_LOCKED, - SQLITE_LOCKED_SHAREDCACHE as SQLITE_LOCKED_SHAREDCACHE, - SQLITE_LOCKED_VTAB as SQLITE_LOCKED_VTAB, - SQLITE_MISMATCH as SQLITE_MISMATCH, - SQLITE_MISUSE as SQLITE_MISUSE, - SQLITE_NOLFS as SQLITE_NOLFS, - SQLITE_NOMEM as SQLITE_NOMEM, - SQLITE_NOTADB as SQLITE_NOTADB, - SQLITE_NOTFOUND as SQLITE_NOTFOUND, - SQLITE_NOTICE as SQLITE_NOTICE, - SQLITE_NOTICE_RECOVER_ROLLBACK as SQLITE_NOTICE_RECOVER_ROLLBACK, - SQLITE_NOTICE_RECOVER_WAL as SQLITE_NOTICE_RECOVER_WAL, - SQLITE_OK_LOAD_PERMANENTLY as SQLITE_OK_LOAD_PERMANENTLY, - SQLITE_OK_SYMLINK as SQLITE_OK_SYMLINK, - SQLITE_PERM as SQLITE_PERM, - SQLITE_PROTOCOL as SQLITE_PROTOCOL, - SQLITE_RANGE as SQLITE_RANGE, - SQLITE_READONLY as SQLITE_READONLY, - SQLITE_READONLY_CANTINIT as SQLITE_READONLY_CANTINIT, - SQLITE_READONLY_CANTLOCK as SQLITE_READONLY_CANTLOCK, - SQLITE_READONLY_DBMOVED as SQLITE_READONLY_DBMOVED, - SQLITE_READONLY_DIRECTORY as SQLITE_READONLY_DIRECTORY, - SQLITE_READONLY_RECOVERY as SQLITE_READONLY_RECOVERY, - SQLITE_READONLY_ROLLBACK as SQLITE_READONLY_ROLLBACK, - SQLITE_ROW as SQLITE_ROW, - SQLITE_SCHEMA as SQLITE_SCHEMA, - SQLITE_TOOBIG as SQLITE_TOOBIG, - SQLITE_WARNING as SQLITE_WARNING, - SQLITE_WARNING_AUTOINDEX as SQLITE_WARNING_AUTOINDEX, - ) - -if sys.version_info < (3, 12): - from sqlite3.dbapi2 import enable_shared_cache as enable_shared_cache, version as version - -if sys.version_info < (3, 10): - from sqlite3.dbapi2 import OptimizedUnicode as OptimizedUnicode - -_CursorT = TypeVar("_CursorT", bound=Cursor) -_SqliteData: TypeAlias = str | ReadableBuffer | int | float | None -# Data that is passed through adapters can be of any type accepted by an adapter. -_AdaptedInputData: TypeAlias = _SqliteData | Any -# The Mapping must really be a dict, but making it invariant is too annoying. -_Parameters: TypeAlias = SupportsLenAndGetItem[_AdaptedInputData] | Mapping[str, _AdaptedInputData] - -class _AnyParamWindowAggregateClass(Protocol): - def step(self, *args: Any) -> object: ... - def inverse(self, *args: Any) -> object: ... - def value(self) -> _SqliteData: ... - def finalize(self) -> _SqliteData: ... - -class _WindowAggregateClass(Protocol): - step: Callable[..., object] - inverse: Callable[..., object] - def value(self) -> _SqliteData: ... - def finalize(self) -> _SqliteData: ... - -class _AggregateProtocol(Protocol): - def step(self, value: int, /) -> object: ... - def finalize(self) -> int: ... - -class _SingleParamWindowAggregateClass(Protocol): - def step(self, param: Any, /) -> object: ... - def inverse(self, param: Any, /) -> object: ... - def value(self) -> _SqliteData: ... - def finalize(self) -> _SqliteData: ... - -# These classes are implemented in the C module _sqlite3. At runtime, they're imported -# from there into sqlite3.dbapi2 and from that module to here. However, they -# consider themselves to live in the sqlite3.* namespace, so we'll define them here. - -class Error(Exception): - if sys.version_info >= (3, 11): - sqlite_errorcode: int - sqlite_errorname: str - -class DatabaseError(Error): ... -class DataError(DatabaseError): ... -class IntegrityError(DatabaseError): ... -class InterfaceError(Error): ... -class InternalError(DatabaseError): ... -class NotSupportedError(DatabaseError): ... -class OperationalError(DatabaseError): ... -class ProgrammingError(DatabaseError): ... -class Warning(Exception): ... - -class Connection: - @property - def DataError(self) -> type[DataError]: ... - @property - def DatabaseError(self) -> type[DatabaseError]: ... - @property - def Error(self) -> type[Error]: ... - @property - def IntegrityError(self) -> type[IntegrityError]: ... - @property - def InterfaceError(self) -> type[InterfaceError]: ... - @property - def InternalError(self) -> type[InternalError]: ... - @property - def NotSupportedError(self) -> type[NotSupportedError]: ... - @property - def OperationalError(self) -> type[OperationalError]: ... - @property - def ProgrammingError(self) -> type[ProgrammingError]: ... - @property - def Warning(self) -> type[Warning]: ... - @property - def in_transaction(self) -> bool: ... - isolation_level: str | None # one of '', 'DEFERRED', 'IMMEDIATE' or 'EXCLUSIVE' - @property - def total_changes(self) -> int: ... - if sys.version_info >= (3, 12): - @property - def autocommit(self) -> int: ... - @autocommit.setter - def autocommit(self, val: int) -> None: ... - row_factory: Any - text_factory: Any - if sys.version_info >= (3, 12): - def __init__( - self, - database: StrOrBytesPath, - timeout: float = ..., - detect_types: int = ..., - isolation_level: str | None = ..., - check_same_thread: bool = ..., - factory: type[Connection] | None = ..., - cached_statements: int = ..., - uri: bool = ..., - autocommit: bool = ..., - ) -> None: ... - else: - def __init__( - self, - database: StrOrBytesPath, - timeout: float = ..., - detect_types: int = ..., - isolation_level: str | None = ..., - check_same_thread: bool = ..., - factory: type[Connection] | None = ..., - cached_statements: int = ..., - uri: bool = ..., - ) -> None: ... - - def close(self) -> None: ... - if sys.version_info >= (3, 11): - def blobopen(self, table: str, column: str, row: int, /, *, readonly: bool = False, name: str = "main") -> Blob: ... - - def commit(self) -> None: ... - def create_aggregate(self, name: str, n_arg: int, aggregate_class: Callable[[], _AggregateProtocol]) -> None: ... - if sys.version_info >= (3, 11): - # num_params determines how many params will be passed to the aggregate class. We provide an overload - # for the case where num_params = 1, which is expected to be the common case. - @overload - def create_window_function( - self, name: str, num_params: Literal[1], aggregate_class: Callable[[], _SingleParamWindowAggregateClass] | None, / - ) -> None: ... - # And for num_params = -1, which means the aggregate must accept any number of parameters. - @overload - def create_window_function( - self, name: str, num_params: Literal[-1], aggregate_class: Callable[[], _AnyParamWindowAggregateClass] | None, / - ) -> None: ... - @overload - def create_window_function( - self, name: str, num_params: int, aggregate_class: Callable[[], _WindowAggregateClass] | None, / - ) -> None: ... - - def create_collation(self, name: str, callback: Callable[[str, str], int | SupportsIndex] | None, /) -> None: ... - def create_function( - self, name: str, narg: int, func: Callable[..., _SqliteData] | None, *, deterministic: bool = False - ) -> None: ... - @overload - def cursor(self, factory: None = None) -> Cursor: ... - @overload - def cursor(self, factory: Callable[[Connection], _CursorT]) -> _CursorT: ... - def execute(self, sql: str, parameters: _Parameters = ..., /) -> Cursor: ... - def executemany(self, sql: str, parameters: Iterable[_Parameters], /) -> Cursor: ... - def executescript(self, sql_script: str, /) -> Cursor: ... - def interrupt(self) -> None: ... - if sys.version_info >= (3, 13): - def iterdump(self, *, filter: str | None = None) -> Generator[str, None, None]: ... - else: - def iterdump(self) -> Generator[str, None, None]: ... - - def rollback(self) -> None: ... - def set_authorizer( - self, authorizer_callback: Callable[[int, str | None, str | None, str | None, str | None], int] | None - ) -> None: ... - def set_progress_handler(self, progress_handler: Callable[[], int | None] | None, n: int) -> None: ... - def set_trace_callback(self, trace_callback: Callable[[str], object] | None) -> None: ... - # enable_load_extension and load_extension is not available on python distributions compiled - # without sqlite3 loadable extension support. see footnotes https://docs.python.org/3/library/sqlite3.html#f1 - def enable_load_extension(self, enable: bool, /) -> None: ... - if sys.version_info >= (3, 12): - def load_extension(self, name: str, /, *, entrypoint: str | None = None) -> None: ... - else: - def load_extension(self, name: str, /) -> None: ... - - def backup( - self, - target: Connection, - *, - pages: int = -1, - progress: Callable[[int, int, int], object] | None = None, - name: str = "main", - sleep: float = 0.25, - ) -> None: ... - if sys.version_info >= (3, 11): - def setlimit(self, category: int, limit: int, /) -> int: ... - def getlimit(self, category: int, /) -> int: ... - def serialize(self, *, name: str = "main") -> bytes: ... - def deserialize(self, data: ReadableBuffer, /, *, name: str = "main") -> None: ... - if sys.version_info >= (3, 12): - def getconfig(self, op: int, /) -> bool: ... - def setconfig(self, op: int, enable: bool = True, /) -> bool: ... - - def __call__(self, sql: str, /) -> _Statement: ... - def __enter__(self) -> Self: ... - def __exit__( - self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None, / - ) -> Literal[False]: ... - -class Cursor(Iterator[Any]): - arraysize: int - @property - def connection(self) -> Connection: ... - # May be None, but using | Any instead to avoid slightly annoying false positives. - @property - def description(self) -> tuple[tuple[str, None, None, None, None, None, None], ...] | Any: ... - @property - def lastrowid(self) -> int | None: ... - row_factory: Callable[[Cursor, Row], object] | None - @property - def rowcount(self) -> int: ... - def __init__(self, cursor: Connection, /) -> None: ... - def close(self) -> None: ... - def execute(self, sql: str, parameters: _Parameters = (), /) -> Self: ... - def executemany(self, sql: str, seq_of_parameters: Iterable[_Parameters], /) -> Self: ... - def executescript(self, sql_script: str, /) -> Cursor: ... - def fetchall(self) -> list[Any]: ... - def fetchmany(self, size: int | None = 1) -> list[Any]: ... - # Returns either a row (as created by the row_factory) or None, but - # putting None in the return annotation causes annoying false positives. - def fetchone(self) -> Any: ... - def setinputsizes(self, sizes: Unused, /) -> None: ... # does nothing - def setoutputsize(self, size: Unused, column: Unused = None, /) -> None: ... # does nothing - def __iter__(self) -> Self: ... - def __next__(self) -> Any: ... - -@final -class PrepareProtocol: - def __init__(self, *args: object, **kwargs: object) -> None: ... - -class Row(Sequence[Any]): - def __init__(self, cursor: Cursor, data: tuple[Any, ...], /) -> None: ... - def keys(self) -> list[str]: ... - @overload - def __getitem__(self, key: int | str, /) -> Any: ... - @overload - def __getitem__(self, key: slice, /) -> tuple[Any, ...]: ... - def __hash__(self) -> int: ... - def __iter__(self) -> Iterator[Any]: ... - def __len__(self) -> int: ... - # These return NotImplemented for anything that is not a Row. - def __eq__(self, value: object, /) -> bool: ... - def __ge__(self, value: object, /) -> bool: ... - def __gt__(self, value: object, /) -> bool: ... - def __le__(self, value: object, /) -> bool: ... - def __lt__(self, value: object, /) -> bool: ... - def __ne__(self, value: object, /) -> bool: ... - -@final -class _Statement: ... - -if sys.version_info >= (3, 11): - @final - class Blob: - def close(self) -> None: ... - def read(self, length: int = -1, /) -> bytes: ... - def write(self, data: ReadableBuffer, /) -> None: ... - def tell(self) -> int: ... - # whence must be one of os.SEEK_SET, os.SEEK_CUR, os.SEEK_END - def seek(self, offset: int, origin: int = 0, /) -> None: ... - def __len__(self) -> int: ... - def __enter__(self) -> Self: ... - def __exit__(self, type: object, val: object, tb: object, /) -> Literal[False]: ... - def __getitem__(self, key: SupportsIndex | slice, /) -> int: ... - def __setitem__(self, key: SupportsIndex | slice, value: int, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sre_constants.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/sre_constants.pyi deleted file mode 100644 index 383f0f7eb8bd6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/sre_constants.pyi +++ /dev/null @@ -1,124 +0,0 @@ -import sys -from re import error as error -from typing import Any -from typing_extensions import Self - -MAXGROUPS: int - -MAGIC: int - -class _NamedIntConstant(int): - name: Any - def __new__(cls, value: int, name: str) -> Self: ... - -MAXREPEAT: _NamedIntConstant -OPCODES: list[_NamedIntConstant] -ATCODES: list[_NamedIntConstant] -CHCODES: list[_NamedIntConstant] -OP_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] -OP_LOCALE_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] -OP_UNICODE_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] -AT_MULTILINE: dict[_NamedIntConstant, _NamedIntConstant] -AT_LOCALE: dict[_NamedIntConstant, _NamedIntConstant] -AT_UNICODE: dict[_NamedIntConstant, _NamedIntConstant] -CH_LOCALE: dict[_NamedIntConstant, _NamedIntConstant] -CH_UNICODE: dict[_NamedIntConstant, _NamedIntConstant] -if sys.version_info < (3, 13): - SRE_FLAG_TEMPLATE: int -SRE_FLAG_IGNORECASE: int -SRE_FLAG_LOCALE: int -SRE_FLAG_MULTILINE: int -SRE_FLAG_DOTALL: int -SRE_FLAG_UNICODE: int -SRE_FLAG_VERBOSE: int -SRE_FLAG_DEBUG: int -SRE_FLAG_ASCII: int -SRE_INFO_PREFIX: int -SRE_INFO_LITERAL: int -SRE_INFO_CHARSET: int - -# Stubgen above; manually defined constants below (dynamic at runtime) - -# from OPCODES -FAILURE: _NamedIntConstant -SUCCESS: _NamedIntConstant -ANY: _NamedIntConstant -ANY_ALL: _NamedIntConstant -ASSERT: _NamedIntConstant -ASSERT_NOT: _NamedIntConstant -AT: _NamedIntConstant -BRANCH: _NamedIntConstant -if sys.version_info < (3, 11): - CALL: _NamedIntConstant -CATEGORY: _NamedIntConstant -CHARSET: _NamedIntConstant -BIGCHARSET: _NamedIntConstant -GROUPREF: _NamedIntConstant -GROUPREF_EXISTS: _NamedIntConstant -GROUPREF_IGNORE: _NamedIntConstant -IN: _NamedIntConstant -IN_IGNORE: _NamedIntConstant -INFO: _NamedIntConstant -JUMP: _NamedIntConstant -LITERAL: _NamedIntConstant -LITERAL_IGNORE: _NamedIntConstant -MARK: _NamedIntConstant -MAX_UNTIL: _NamedIntConstant -MIN_UNTIL: _NamedIntConstant -NOT_LITERAL: _NamedIntConstant -NOT_LITERAL_IGNORE: _NamedIntConstant -NEGATE: _NamedIntConstant -RANGE: _NamedIntConstant -REPEAT: _NamedIntConstant -REPEAT_ONE: _NamedIntConstant -SUBPATTERN: _NamedIntConstant -MIN_REPEAT_ONE: _NamedIntConstant -if sys.version_info >= (3, 11): - ATOMIC_GROUP: _NamedIntConstant - POSSESSIVE_REPEAT: _NamedIntConstant - POSSESSIVE_REPEAT_ONE: _NamedIntConstant -RANGE_UNI_IGNORE: _NamedIntConstant -GROUPREF_LOC_IGNORE: _NamedIntConstant -GROUPREF_UNI_IGNORE: _NamedIntConstant -IN_LOC_IGNORE: _NamedIntConstant -IN_UNI_IGNORE: _NamedIntConstant -LITERAL_LOC_IGNORE: _NamedIntConstant -LITERAL_UNI_IGNORE: _NamedIntConstant -NOT_LITERAL_LOC_IGNORE: _NamedIntConstant -NOT_LITERAL_UNI_IGNORE: _NamedIntConstant -MIN_REPEAT: _NamedIntConstant -MAX_REPEAT: _NamedIntConstant - -# from ATCODES -AT_BEGINNING: _NamedIntConstant -AT_BEGINNING_LINE: _NamedIntConstant -AT_BEGINNING_STRING: _NamedIntConstant -AT_BOUNDARY: _NamedIntConstant -AT_NON_BOUNDARY: _NamedIntConstant -AT_END: _NamedIntConstant -AT_END_LINE: _NamedIntConstant -AT_END_STRING: _NamedIntConstant -AT_LOC_BOUNDARY: _NamedIntConstant -AT_LOC_NON_BOUNDARY: _NamedIntConstant -AT_UNI_BOUNDARY: _NamedIntConstant -AT_UNI_NON_BOUNDARY: _NamedIntConstant - -# from CHCODES -CATEGORY_DIGIT: _NamedIntConstant -CATEGORY_NOT_DIGIT: _NamedIntConstant -CATEGORY_SPACE: _NamedIntConstant -CATEGORY_NOT_SPACE: _NamedIntConstant -CATEGORY_WORD: _NamedIntConstant -CATEGORY_NOT_WORD: _NamedIntConstant -CATEGORY_LINEBREAK: _NamedIntConstant -CATEGORY_NOT_LINEBREAK: _NamedIntConstant -CATEGORY_LOC_WORD: _NamedIntConstant -CATEGORY_LOC_NOT_WORD: _NamedIntConstant -CATEGORY_UNI_DIGIT: _NamedIntConstant -CATEGORY_UNI_NOT_DIGIT: _NamedIntConstant -CATEGORY_UNI_SPACE: _NamedIntConstant -CATEGORY_UNI_NOT_SPACE: _NamedIntConstant -CATEGORY_UNI_WORD: _NamedIntConstant -CATEGORY_UNI_NOT_WORD: _NamedIntConstant -CATEGORY_UNI_LINEBREAK: _NamedIntConstant -CATEGORY_UNI_NOT_LINEBREAK: _NamedIntConstant diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/string.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/string.pyi deleted file mode 100644 index 35a76e9c8628d..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/string.pyi +++ /dev/null @@ -1,83 +0,0 @@ -import sys -from _typeshed import StrOrLiteralStr -from collections.abc import Iterable, Mapping, Sequence -from re import Pattern, RegexFlag -from typing import Any, ClassVar, overload -from typing_extensions import LiteralString, TypeAlias - -__all__ = [ - "ascii_letters", - "ascii_lowercase", - "ascii_uppercase", - "capwords", - "digits", - "hexdigits", - "octdigits", - "printable", - "punctuation", - "whitespace", - "Formatter", - "Template", -] - -ascii_letters: LiteralString -ascii_lowercase: LiteralString -ascii_uppercase: LiteralString -digits: LiteralString -hexdigits: LiteralString -octdigits: LiteralString -punctuation: LiteralString -printable: LiteralString -whitespace: LiteralString - -def capwords(s: StrOrLiteralStr, sep: StrOrLiteralStr | None = None) -> StrOrLiteralStr: ... - -if sys.version_info >= (3, 9): - _TemplateMetaclass: TypeAlias = type -else: - class _TemplateMetaclass(type): - pattern: ClassVar[str] - def __init__(cls, name: str, bases: tuple[type, ...], dct: dict[str, Any]) -> None: ... - -class Template(metaclass=_TemplateMetaclass): - template: str - delimiter: ClassVar[str] - idpattern: ClassVar[str] - braceidpattern: ClassVar[str | None] - flags: ClassVar[RegexFlag] - pattern: ClassVar[Pattern[str]] - def __init__(self, template: str) -> None: ... - def substitute(self, mapping: Mapping[str, object] = {}, /, **kwds: object) -> str: ... - def safe_substitute(self, mapping: Mapping[str, object] = {}, /, **kwds: object) -> str: ... - if sys.version_info >= (3, 11): - def get_identifiers(self) -> list[str]: ... - def is_valid(self) -> bool: ... - -class Formatter: - @overload - def format(self, format_string: LiteralString, /, *args: LiteralString, **kwargs: LiteralString) -> LiteralString: ... - @overload - def format(self, format_string: str, /, *args: Any, **kwargs: Any) -> str: ... - @overload - def vformat( - self, format_string: LiteralString, args: Sequence[LiteralString], kwargs: Mapping[LiteralString, LiteralString] - ) -> LiteralString: ... - @overload - def vformat(self, format_string: str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> str: ... - def _vformat( # undocumented - self, - format_string: str, - args: Sequence[Any], - kwargs: Mapping[str, Any], - used_args: set[int | str], - recursion_depth: int, - auto_arg_index: int = 0, - ) -> tuple[str, int]: ... - def parse( - self, format_string: StrOrLiteralStr - ) -> Iterable[tuple[StrOrLiteralStr, StrOrLiteralStr | None, StrOrLiteralStr | None, StrOrLiteralStr | None]]: ... - def get_field(self, field_name: str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> Any: ... - def get_value(self, key: int | str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> Any: ... - def check_unused_args(self, used_args: set[int | str], args: Sequence[Any], kwargs: Mapping[str, Any]) -> None: ... - def format_field(self, value: Any, format_spec: str) -> Any: ... - def convert_field(self, value: Any, conversion: str | None) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/struct.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/struct.pyi deleted file mode 100644 index e684632489ea0..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/struct.pyi +++ /dev/null @@ -1,26 +0,0 @@ -from _typeshed import ReadableBuffer, WriteableBuffer -from collections.abc import Iterator -from typing import Any - -__all__ = ["calcsize", "pack", "pack_into", "unpack", "unpack_from", "iter_unpack", "Struct", "error"] - -class error(Exception): ... - -def pack(fmt: str | bytes, /, *v: Any) -> bytes: ... -def pack_into(fmt: str | bytes, buffer: WriteableBuffer, offset: int, /, *v: Any) -> None: ... -def unpack(format: str | bytes, buffer: ReadableBuffer, /) -> tuple[Any, ...]: ... -def unpack_from(format: str | bytes, /, buffer: ReadableBuffer, offset: int = 0) -> tuple[Any, ...]: ... -def iter_unpack(format: str | bytes, buffer: ReadableBuffer, /) -> Iterator[tuple[Any, ...]]: ... -def calcsize(format: str | bytes, /) -> int: ... - -class Struct: - @property - def format(self) -> str: ... - @property - def size(self) -> int: ... - def __init__(self, format: str | bytes) -> None: ... - def pack(self, *v: Any) -> bytes: ... - def pack_into(self, buffer: WriteableBuffer, offset: int, *v: Any) -> None: ... - def unpack(self, buffer: ReadableBuffer, /) -> tuple[Any, ...]: ... - def unpack_from(self, buffer: ReadableBuffer, offset: int = 0) -> tuple[Any, ...]: ... - def iter_unpack(self, buffer: ReadableBuffer, /) -> Iterator[tuple[Any, ...]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/subprocess.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/subprocess.pyi deleted file mode 100644 index 703a5012012cf..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/subprocess.pyi +++ /dev/null @@ -1,2628 +0,0 @@ -import sys -from _typeshed import ReadableBuffer, StrOrBytesPath -from collections.abc import Callable, Collection, Iterable, Mapping, Sequence -from types import TracebackType -from typing import IO, Any, AnyStr, Final, Generic, Literal, TypeVar, overload -from typing_extensions import Self, TypeAlias - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = [ - "Popen", - "PIPE", - "STDOUT", - "call", - "check_call", - "getstatusoutput", - "getoutput", - "check_output", - "run", - "CalledProcessError", - "DEVNULL", - "SubprocessError", - "TimeoutExpired", - "CompletedProcess", -] - -if sys.platform == "win32": - __all__ += [ - "CREATE_NEW_CONSOLE", - "CREATE_NEW_PROCESS_GROUP", - "STARTF_USESHOWWINDOW", - "STARTF_USESTDHANDLES", - "STARTUPINFO", - "STD_ERROR_HANDLE", - "STD_INPUT_HANDLE", - "STD_OUTPUT_HANDLE", - "SW_HIDE", - "ABOVE_NORMAL_PRIORITY_CLASS", - "BELOW_NORMAL_PRIORITY_CLASS", - "CREATE_BREAKAWAY_FROM_JOB", - "CREATE_DEFAULT_ERROR_MODE", - "CREATE_NO_WINDOW", - "DETACHED_PROCESS", - "HIGH_PRIORITY_CLASS", - "IDLE_PRIORITY_CLASS", - "NORMAL_PRIORITY_CLASS", - "REALTIME_PRIORITY_CLASS", - ] - -# We prefer to annotate inputs to methods (eg subprocess.check_call) with these -# union types. -# For outputs we use laborious literal based overloads to try to determine -# which specific return types to use, and prefer to fall back to Any when -# this does not work, so the caller does not have to use an assertion to confirm -# which type. -# -# For example: -# -# try: -# x = subprocess.check_output(["ls", "-l"]) -# reveal_type(x) # bytes, based on the overloads -# except TimeoutError as e: -# reveal_type(e.cmd) # Any, but morally is _CMD -_FILE: TypeAlias = None | int | IO[Any] -_InputString: TypeAlias = ReadableBuffer | str -_CMD: TypeAlias = StrOrBytesPath | Sequence[StrOrBytesPath] -if sys.platform == "win32": - _ENV: TypeAlias = Mapping[str, str] -else: - _ENV: TypeAlias = Mapping[bytes, StrOrBytesPath] | Mapping[str, StrOrBytesPath] - -_T = TypeVar("_T") - -# These two are private but documented -if sys.version_info >= (3, 11): - _USE_VFORK: Final[bool] -_USE_POSIX_SPAWN: Final[bool] - -class CompletedProcess(Generic[_T]): - # morally: _CMD - args: Any - returncode: int - # These can both be None, but requiring checks for None would be tedious - # and writing all the overloads would be horrific. - stdout: _T - stderr: _T - def __init__(self, args: _CMD, returncode: int, stdout: _T | None = None, stderr: _T | None = None) -> None: ... - def check_returncode(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -if sys.version_info >= (3, 11): - # 3.11 adds "process_group" argument - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: Literal[True], - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the *real* keyword only args start - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: None = None, - errors: None = None, - input: ReadableBuffer | None = None, - text: Literal[False] | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[bytes]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: _InputString | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> CompletedProcess[Any]: ... - -elif sys.version_info >= (3, 10): - # 3.10 adds "pipesize" argument - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: Literal[True], - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the *real* keyword only args start - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: None = None, - errors: None = None, - input: ReadableBuffer | None = None, - text: Literal[False] | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[bytes]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: _InputString | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> CompletedProcess[Any]: ... - -elif sys.version_info >= (3, 9): - # 3.9 adds arguments "user", "group", "extra_groups" and "umask" - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: Literal[True], - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the *real* keyword only args start - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: None = None, - errors: None = None, - input: ReadableBuffer | None = None, - text: Literal[False] | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[bytes]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: _InputString | None = None, - text: bool | None = None, - timeout: float | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> CompletedProcess[Any]: ... - -else: - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: Literal[True], - timeout: float | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the *real* keyword only args start - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: str | None = None, - text: bool | None = None, - timeout: float | None = None, - ) -> CompletedProcess[str]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: None = None, - errors: None = None, - input: ReadableBuffer | None = None, - text: Literal[False] | None = None, - timeout: float | None = None, - ) -> CompletedProcess[bytes]: ... - @overload - def run( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - capture_output: bool = False, - check: bool = False, - encoding: str | None = None, - errors: str | None = None, - input: _InputString | None = None, - text: bool | None = None, - timeout: float | None = None, - ) -> CompletedProcess[Any]: ... - -# Same args as Popen.__init__ -if sys.version_info >= (3, 11): - # 3.11 adds "process_group" argument - def call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - encoding: str | None = None, - timeout: float | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> int: ... - -elif sys.version_info >= (3, 10): - # 3.10 adds "pipesize" argument - def call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - encoding: str | None = None, - timeout: float | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> int: ... - -elif sys.version_info >= (3, 9): - # 3.9 adds arguments "user", "group", "extra_groups" and "umask" - def call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - encoding: str | None = None, - timeout: float | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> int: ... - -else: - def call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - encoding: str | None = None, - timeout: float | None = None, - text: bool | None = None, - ) -> int: ... - -# Same args as Popen.__init__ -if sys.version_info >= (3, 11): - # 3.11 adds "process_group" argument - def check_call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - timeout: float | None = ..., - *, - encoding: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> int: ... - -elif sys.version_info >= (3, 10): - # 3.10 adds "pipesize" argument - def check_call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - timeout: float | None = ..., - *, - encoding: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> int: ... - -elif sys.version_info >= (3, 9): - # 3.9 adds arguments "user", "group", "extra_groups" and "umask" - def check_call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - timeout: float | None = ..., - *, - encoding: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> int: ... - -else: - def check_call( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stdout: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - timeout: float | None = ..., - *, - encoding: str | None = None, - text: bool | None = None, - ) -> int: ... - -if sys.version_info >= (3, 11): - # 3.11 adds "process_group" argument - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: Literal[True], - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the real keyword only ones start - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> bytes: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> Any: ... # morally: -> str | bytes - -elif sys.version_info >= (3, 10): - # 3.10 adds "pipesize" argument - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: Literal[True], - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the real keyword only ones start - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> bytes: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> Any: ... # morally: -> str | bytes - -elif sys.version_info >= (3, 9): - # 3.9 adds arguments "user", "group", "extra_groups" and "umask" - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: Literal[True], - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the real keyword only ones start - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> bytes: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> Any: ... # morally: -> str | bytes - -else: - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: Literal[True], - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str, - errors: str | None = None, - text: bool | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str, - text: bool | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - # where the real keyword only ones start - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - ) -> str: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: None = None, - errors: None = None, - text: Literal[False] | None = None, - ) -> bytes: ... - @overload - def check_output( - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE = None, - stderr: _FILE = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = ..., - *, - timeout: float | None = None, - input: _InputString | None = ..., - encoding: str | None = None, - errors: str | None = None, - text: bool | None = None, - ) -> Any: ... # morally: -> str | bytes - -PIPE: Final[int] -STDOUT: Final[int] -DEVNULL: Final[int] - -class SubprocessError(Exception): ... - -class TimeoutExpired(SubprocessError): - def __init__( - self, cmd: _CMD, timeout: float, output: str | bytes | None = None, stderr: str | bytes | None = None - ) -> None: ... - # morally: _CMD - cmd: Any - timeout: float - # morally: str | bytes | None - output: Any - stdout: bytes | None - stderr: bytes | None - -class CalledProcessError(SubprocessError): - returncode: int - # morally: _CMD - cmd: Any - # morally: str | bytes | None - output: Any - - # morally: str | bytes | None - stdout: Any - stderr: Any - def __init__( - self, returncode: int, cmd: _CMD, output: str | bytes | None = None, stderr: str | bytes | None = None - ) -> None: ... - -class Popen(Generic[AnyStr]): - args: _CMD - stdin: IO[AnyStr] | None - stdout: IO[AnyStr] | None - stderr: IO[AnyStr] | None - pid: int - returncode: int | Any - universal_newlines: bool - - if sys.version_info >= (3, 11): - # process_group is added in 3.11 - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - # where the *real* keyword only args start - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[True], - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[bytes], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[False] | None = None, - encoding: None = None, - errors: None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[Any], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - process_group: int | None = None, - ) -> None: ... - elif sys.version_info >= (3, 10): - # pipesize is added in 3.10 - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - # where the *real* keyword only args start - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[True], - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[bytes], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[False] | None = None, - encoding: None = None, - errors: None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[Any], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - pipesize: int = -1, - ) -> None: ... - elif sys.version_info >= (3, 9): - # user, group, extra_groups, umask were added in 3.9 - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - # where the *real* keyword only args start - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[True], - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[bytes], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[False] | None = None, - encoding: None = None, - errors: None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - @overload - def __init__( - self: Popen[Any], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - user: str | int | None = None, - group: str | int | None = None, - extra_groups: Iterable[str | int] | None = None, - umask: int = -1, - ) -> None: ... - else: - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str, - errors: str | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - *, - universal_newlines: Literal[True], - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - # where the *real* keyword only args start - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[str], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[True], - encoding: str | None = None, - errors: str | None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[bytes], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: Literal[False] | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: Literal[False] | None = None, - encoding: None = None, - errors: None = None, - ) -> None: ... - @overload - def __init__( - self: Popen[Any], - args: _CMD, - bufsize: int = -1, - executable: StrOrBytesPath | None = None, - stdin: _FILE | None = None, - stdout: _FILE | None = None, - stderr: _FILE | None = None, - preexec_fn: Callable[[], Any] | None = None, - close_fds: bool = True, - shell: bool = False, - cwd: StrOrBytesPath | None = None, - env: _ENV | None = None, - universal_newlines: bool | None = None, - startupinfo: Any | None = None, - creationflags: int = 0, - restore_signals: bool = True, - start_new_session: bool = False, - pass_fds: Collection[int] = (), - *, - text: bool | None = None, - encoding: str | None = None, - errors: str | None = None, - ) -> None: ... - - def poll(self) -> int | None: ... - def wait(self, timeout: float | None = None) -> int: ... - # morally the members of the returned tuple should be optional - # TODO this should allow ReadableBuffer for Popen[bytes], but adding - # overloads for that runs into a mypy bug (python/mypy#14070). - def communicate(self, input: AnyStr | None = None, timeout: float | None = None) -> tuple[AnyStr, AnyStr]: ... - def send_signal(self, sig: int) -> None: ... - def terminate(self) -> None: ... - def kill(self) -> None: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> None: ... - def __del__(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -# The result really is always a str. -if sys.version_info >= (3, 11): - def getstatusoutput(cmd: _CMD, *, encoding: str | None = None, errors: str | None = None) -> tuple[int, str]: ... - def getoutput(cmd: _CMD, *, encoding: str | None = None, errors: str | None = None) -> str: ... - -else: - def getstatusoutput(cmd: _CMD) -> tuple[int, str]: ... - def getoutput(cmd: _CMD) -> str: ... - -def list2cmdline(seq: Iterable[StrOrBytesPath]) -> str: ... # undocumented - -if sys.platform == "win32": - if sys.version_info >= (3, 13): - from _winapi import STARTF_FORCEOFFFEEDBACK, STARTF_FORCEONFEEDBACK - - __all__ += ["STARTF_FORCEOFFFEEDBACK", "STARTF_FORCEONFEEDBACK"] - - class STARTUPINFO: - def __init__( - self, - *, - dwFlags: int = 0, - hStdInput: Any | None = None, - hStdOutput: Any | None = None, - hStdError: Any | None = None, - wShowWindow: int = 0, - lpAttributeList: Mapping[str, Any] | None = None, - ) -> None: ... - dwFlags: int - hStdInput: Any | None - hStdOutput: Any | None - hStdError: Any | None - wShowWindow: int - lpAttributeList: Mapping[str, Any] - def copy(self) -> STARTUPINFO: ... - - from _winapi import ( - ABOVE_NORMAL_PRIORITY_CLASS as ABOVE_NORMAL_PRIORITY_CLASS, - BELOW_NORMAL_PRIORITY_CLASS as BELOW_NORMAL_PRIORITY_CLASS, - CREATE_BREAKAWAY_FROM_JOB as CREATE_BREAKAWAY_FROM_JOB, - CREATE_DEFAULT_ERROR_MODE as CREATE_DEFAULT_ERROR_MODE, - CREATE_NEW_CONSOLE as CREATE_NEW_CONSOLE, - CREATE_NEW_PROCESS_GROUP as CREATE_NEW_PROCESS_GROUP, - CREATE_NO_WINDOW as CREATE_NO_WINDOW, - DETACHED_PROCESS as DETACHED_PROCESS, - HIGH_PRIORITY_CLASS as HIGH_PRIORITY_CLASS, - IDLE_PRIORITY_CLASS as IDLE_PRIORITY_CLASS, - NORMAL_PRIORITY_CLASS as NORMAL_PRIORITY_CLASS, - REALTIME_PRIORITY_CLASS as REALTIME_PRIORITY_CLASS, - STARTF_USESHOWWINDOW as STARTF_USESHOWWINDOW, - STARTF_USESTDHANDLES as STARTF_USESTDHANDLES, - STD_ERROR_HANDLE as STD_ERROR_HANDLE, - STD_INPUT_HANDLE as STD_INPUT_HANDLE, - STD_OUTPUT_HANDLE as STD_OUTPUT_HANDLE, - SW_HIDE as SW_HIDE, - ) diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sys/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/sys/__init__.pyi deleted file mode 100644 index d65ddfe3825d5..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/sys/__init__.pyi +++ /dev/null @@ -1,373 +0,0 @@ -import sys -from _typeshed import MaybeNone, OptExcInfo, ProfileFunction, TraceFunction, structseq -from _typeshed.importlib import MetaPathFinderProtocol, PathEntryFinderProtocol -from builtins import object as _object -from collections.abc import AsyncGenerator, Callable, Sequence -from io import TextIOWrapper -from types import FrameType, ModuleType, TracebackType -from typing import Any, Final, Literal, NoReturn, Protocol, TextIO, TypeVar, final -from typing_extensions import TypeAlias - -_T = TypeVar("_T") - -# see https://github.com/python/typeshed/issues/8513#issue-1333671093 for the rationale behind this alias -_ExitCode: TypeAlias = str | int | None -_OptExcInfo: TypeAlias = OptExcInfo # noqa: Y047 # TODO: obsolete, remove fall 2022 or later - -# ----- sys variables ----- -if sys.platform != "win32": - abiflags: str -argv: list[str] -base_exec_prefix: str -base_prefix: str -byteorder: Literal["little", "big"] -builtin_module_names: Sequence[str] # actually a tuple of strings -copyright: str -if sys.platform == "win32": - dllhandle: int -dont_write_bytecode: bool -displayhook: Callable[[object], Any] -excepthook: Callable[[type[BaseException], BaseException, TracebackType | None], Any] -exec_prefix: str -executable: str -float_repr_style: Literal["short", "legacy"] -hexversion: int -last_type: type[BaseException] | None -last_value: BaseException | None -last_traceback: TracebackType | None -if sys.version_info >= (3, 12): - last_exc: BaseException # or undefined. -maxsize: int -maxunicode: int -meta_path: list[MetaPathFinderProtocol] -modules: dict[str, ModuleType] -if sys.version_info >= (3, 10): - orig_argv: list[str] -path: list[str] -path_hooks: list[Callable[[str], PathEntryFinderProtocol]] -path_importer_cache: dict[str, PathEntryFinderProtocol | None] -platform: str -if sys.version_info >= (3, 9): - platlibdir: str -prefix: str -pycache_prefix: str | None -ps1: object -ps2: object - -# TextIO is used instead of more specific types for the standard streams, -# since they are often monkeypatched at runtime. At startup, the objects -# are initialized to instances of TextIOWrapper, but can also be None under -# some circumstances. -# -# To use methods from TextIOWrapper, use an isinstance check to ensure that -# the streams have not been overridden: -# -# if isinstance(sys.stdout, io.TextIOWrapper): -# sys.stdout.reconfigure(...) -stdin: TextIO | MaybeNone -stdout: TextIO | MaybeNone -stderr: TextIO | MaybeNone - -if sys.version_info >= (3, 10): - stdlib_module_names: frozenset[str] - -__stdin__: Final[TextIOWrapper | None] # Contains the original value of stdin -__stdout__: Final[TextIOWrapper | None] # Contains the original value of stdout -__stderr__: Final[TextIOWrapper | None] # Contains the original value of stderr -tracebacklimit: int -version: str -api_version: int -warnoptions: Any -# Each entry is a tuple of the form (action, message, category, module, -# lineno) -if sys.platform == "win32": - winver: str -_xoptions: dict[Any, Any] - -# Type alias used as a mixin for structseq classes that cannot be instantiated at runtime -# This can't be represented in the type system, so we just use `structseq[Any]` -_UninstantiableStructseq: TypeAlias = structseq[Any] - -flags: _flags - -if sys.version_info >= (3, 10): - _FlagTuple: TypeAlias = tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, bool, int, int] -else: - _FlagTuple: TypeAlias = tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, bool, int] - -@final -class _flags(_UninstantiableStructseq, _FlagTuple): - @property - def debug(self) -> int: ... - @property - def inspect(self) -> int: ... - @property - def interactive(self) -> int: ... - @property - def optimize(self) -> int: ... - @property - def dont_write_bytecode(self) -> int: ... - @property - def no_user_site(self) -> int: ... - @property - def no_site(self) -> int: ... - @property - def ignore_environment(self) -> int: ... - @property - def verbose(self) -> int: ... - @property - def bytes_warning(self) -> int: ... - @property - def quiet(self) -> int: ... - @property - def hash_randomization(self) -> int: ... - @property - def isolated(self) -> int: ... - @property - def dev_mode(self) -> bool: ... - @property - def utf8_mode(self) -> int: ... - if sys.version_info >= (3, 10): - @property - def warn_default_encoding(self) -> int: ... # undocumented - if sys.version_info >= (3, 11): - @property - def safe_path(self) -> bool: ... - -float_info: _float_info - -@final -class _float_info(structseq[float], tuple[float, int, int, float, int, int, int, int, float, int, int]): - @property - def max(self) -> float: ... # DBL_MAX - @property - def max_exp(self) -> int: ... # DBL_MAX_EXP - @property - def max_10_exp(self) -> int: ... # DBL_MAX_10_EXP - @property - def min(self) -> float: ... # DBL_MIN - @property - def min_exp(self) -> int: ... # DBL_MIN_EXP - @property - def min_10_exp(self) -> int: ... # DBL_MIN_10_EXP - @property - def dig(self) -> int: ... # DBL_DIG - @property - def mant_dig(self) -> int: ... # DBL_MANT_DIG - @property - def epsilon(self) -> float: ... # DBL_EPSILON - @property - def radix(self) -> int: ... # FLT_RADIX - @property - def rounds(self) -> int: ... # FLT_ROUNDS - -hash_info: _hash_info - -@final -class _hash_info(structseq[Any | int], tuple[int, int, int, int, int, str, int, int, int]): - @property - def width(self) -> int: ... - @property - def modulus(self) -> int: ... - @property - def inf(self) -> int: ... - @property - def nan(self) -> int: ... - @property - def imag(self) -> int: ... - @property - def algorithm(self) -> str: ... - @property - def hash_bits(self) -> int: ... - @property - def seed_bits(self) -> int: ... - @property - def cutoff(self) -> int: ... # undocumented - -implementation: _implementation - -class _implementation: - name: str - version: _version_info - hexversion: int - cache_tag: str - # Define __getattr__, as the documentation states: - # > sys.implementation may contain additional attributes specific to the Python implementation. - # > These non-standard attributes must start with an underscore, and are not described here. - def __getattr__(self, name: str) -> Any: ... - -int_info: _int_info - -@final -class _int_info(structseq[int], tuple[int, int, int, int]): - @property - def bits_per_digit(self) -> int: ... - @property - def sizeof_digit(self) -> int: ... - @property - def default_max_str_digits(self) -> int: ... - @property - def str_digits_check_threshold(self) -> int: ... - -_ThreadInfoName: TypeAlias = Literal["nt", "pthread", "pthread-stubs", "solaris"] -_ThreadInfoLock: TypeAlias = Literal["semaphore", "mutex+cond"] | None - -@final -class _thread_info(_UninstantiableStructseq, tuple[_ThreadInfoName, _ThreadInfoLock, str | None]): - @property - def name(self) -> _ThreadInfoName: ... - @property - def lock(self) -> _ThreadInfoLock: ... - @property - def version(self) -> str | None: ... - -thread_info: _thread_info -_ReleaseLevel: TypeAlias = Literal["alpha", "beta", "candidate", "final"] - -@final -class _version_info(_UninstantiableStructseq, tuple[int, int, int, _ReleaseLevel, int]): - @property - def major(self) -> int: ... - @property - def minor(self) -> int: ... - @property - def micro(self) -> int: ... - @property - def releaselevel(self) -> _ReleaseLevel: ... - @property - def serial(self) -> int: ... - -version_info: _version_info - -def call_tracing(func: Callable[..., _T], args: Any, /) -> _T: ... -def _clear_type_cache() -> None: ... -def _current_frames() -> dict[int, FrameType]: ... -def _getframe(depth: int = 0, /) -> FrameType: ... -def _debugmallocstats() -> None: ... -def __displayhook__(object: object, /) -> None: ... -def __excepthook__(exctype: type[BaseException], value: BaseException, traceback: TracebackType | None, /) -> None: ... -def exc_info() -> OptExcInfo: ... - -if sys.version_info >= (3, 11): - def exception() -> BaseException | None: ... - -def exit(status: _ExitCode = None, /) -> NoReturn: ... -def getallocatedblocks() -> int: ... -def getdefaultencoding() -> str: ... - -if sys.platform != "win32": - def getdlopenflags() -> int: ... - -def getfilesystemencoding() -> str: ... -def getfilesystemencodeerrors() -> str: ... -def getrefcount(object: Any, /) -> int: ... -def getrecursionlimit() -> int: ... -def getsizeof(obj: object, default: int = ...) -> int: ... -def getswitchinterval() -> float: ... -def getprofile() -> ProfileFunction | None: ... -def setprofile(function: ProfileFunction | None, /) -> None: ... -def gettrace() -> TraceFunction | None: ... -def settrace(function: TraceFunction | None, /) -> None: ... - -if sys.platform == "win32": - # A tuple of length 5, even though it has more than 5 attributes. - @final - class _WinVersion(_UninstantiableStructseq, tuple[int, int, int, int, str]): - @property - def major(self) -> int: ... - @property - def minor(self) -> int: ... - @property - def build(self) -> int: ... - @property - def platform(self) -> int: ... - @property - def service_pack(self) -> str: ... - @property - def service_pack_minor(self) -> int: ... - @property - def service_pack_major(self) -> int: ... - @property - def suite_mask(self) -> int: ... - @property - def product_type(self) -> int: ... - @property - def platform_version(self) -> tuple[int, int, int]: ... - - def getwindowsversion() -> _WinVersion: ... - -def intern(string: str, /) -> str: ... -def is_finalizing() -> bool: ... -def breakpointhook(*args: Any, **kwargs: Any) -> Any: ... - -__breakpointhook__ = breakpointhook # Contains the original value of breakpointhook - -if sys.platform != "win32": - def setdlopenflags(flags: int, /) -> None: ... - -def setrecursionlimit(limit: int, /) -> None: ... -def setswitchinterval(interval: float, /) -> None: ... -def gettotalrefcount() -> int: ... # Debug builds only - -if sys.version_info < (3, 9): - def getcheckinterval() -> int: ... # deprecated - def setcheckinterval(n: int, /) -> None: ... # deprecated - -if sys.version_info < (3, 9): - # An 11-tuple or None - def callstats() -> tuple[int, int, int, int, int, int, int, int, int, int, int] | None: ... - -# Doesn't exist at runtime, but exported in the stubs so pytest etc. can annotate their code more easily. -class UnraisableHookArgs(Protocol): - exc_type: type[BaseException] - exc_value: BaseException | None - exc_traceback: TracebackType | None - err_msg: str | None - object: _object - -unraisablehook: Callable[[UnraisableHookArgs], Any] - -def __unraisablehook__(unraisable: UnraisableHookArgs, /) -> Any: ... -def addaudithook(hook: Callable[[str, tuple[Any, ...]], Any]) -> None: ... -def audit(event: str, /, *args: Any) -> None: ... - -_AsyncgenHook: TypeAlias = Callable[[AsyncGenerator[Any, Any]], None] | None - -@final -class _asyncgen_hooks(structseq[_AsyncgenHook], tuple[_AsyncgenHook, _AsyncgenHook]): - @property - def firstiter(self) -> _AsyncgenHook: ... - @property - def finalizer(self) -> _AsyncgenHook: ... - -def get_asyncgen_hooks() -> _asyncgen_hooks: ... -def set_asyncgen_hooks(firstiter: _AsyncgenHook = ..., finalizer: _AsyncgenHook = ...) -> None: ... - -if sys.platform == "win32": - def _enablelegacywindowsfsencoding() -> None: ... - -def get_coroutine_origin_tracking_depth() -> int: ... -def set_coroutine_origin_tracking_depth(depth: int) -> None: ... - -# The following two functions were added in 3.11.0, 3.10.7, 3.9.14, and 3.8.14, -# as part of the response to CVE-2020-10735 -def set_int_max_str_digits(maxdigits: int) -> None: ... -def get_int_max_str_digits() -> int: ... - -if sys.version_info >= (3, 12): - if sys.version_info >= (3, 13): - def getunicodeinternedsize(*, _only_immortal: bool = False) -> int: ... - else: - def getunicodeinternedsize() -> int: ... - - def deactivate_stack_trampoline() -> None: ... - def is_stack_trampoline_active() -> bool: ... - # It always exists, but raises on non-linux platforms: - if sys.platform == "linux": - def activate_stack_trampoline(backend: str, /) -> None: ... - else: - def activate_stack_trampoline(backend: str, /) -> NoReturn: ... - - from . import _monitoring - - monitoring = _monitoring diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tarfile.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/tarfile.pyi deleted file mode 100644 index 4d9ede57ea998..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tarfile.pyi +++ /dev/null @@ -1,589 +0,0 @@ -import bz2 -import io -import sys -from _typeshed import StrOrBytesPath, StrPath -from builtins import list as _list # aliases to avoid name clashes with fields named "type" or "list" -from collections.abc import Callable, Iterable, Iterator, Mapping -from gzip import _ReadableFileobj as _GzipReadableFileobj, _WritableFileobj as _GzipWritableFileobj -from types import TracebackType -from typing import IO, ClassVar, Literal, Protocol, overload -from typing_extensions import Self, TypeAlias - -__all__ = [ - "TarFile", - "TarInfo", - "is_tarfile", - "TarError", - "ReadError", - "CompressionError", - "StreamError", - "ExtractError", - "HeaderError", - "ENCODING", - "USTAR_FORMAT", - "GNU_FORMAT", - "PAX_FORMAT", - "DEFAULT_FORMAT", - "open", -] -if sys.version_info >= (3, 12): - __all__ += [ - "fully_trusted_filter", - "data_filter", - "tar_filter", - "FilterError", - "AbsoluteLinkError", - "OutsideDestinationError", - "SpecialFileError", - "AbsolutePathError", - "LinkOutsideDestinationError", - ] - -_FilterFunction: TypeAlias = Callable[[TarInfo, str], TarInfo | None] -_TarfileFilter: TypeAlias = Literal["fully_trusted", "tar", "data"] | _FilterFunction - -class _Fileobj(Protocol): - def read(self, size: int, /) -> bytes: ... - def write(self, b: bytes, /) -> object: ... - def tell(self) -> int: ... - def seek(self, pos: int, /) -> object: ... - def close(self) -> object: ... - # Optional fields: - # name: str | bytes - # mode: Literal["rb", "r+b", "wb", "xb"] - -class _Bz2ReadableFileobj(bz2._ReadableFileobj): - def close(self) -> object: ... - -class _Bz2WritableFileobj(bz2._WritableFileobj): - def close(self) -> object: ... - -# tar constants -NUL: bytes -BLOCKSIZE: int -RECORDSIZE: int -GNU_MAGIC: bytes -POSIX_MAGIC: bytes - -LENGTH_NAME: int -LENGTH_LINK: int -LENGTH_PREFIX: int - -REGTYPE: bytes -AREGTYPE: bytes -LNKTYPE: bytes -SYMTYPE: bytes -CONTTYPE: bytes -BLKTYPE: bytes -DIRTYPE: bytes -FIFOTYPE: bytes -CHRTYPE: bytes - -GNUTYPE_LONGNAME: bytes -GNUTYPE_LONGLINK: bytes -GNUTYPE_SPARSE: bytes - -XHDTYPE: bytes -XGLTYPE: bytes -SOLARIS_XHDTYPE: bytes - -USTAR_FORMAT: int -GNU_FORMAT: int -PAX_FORMAT: int -DEFAULT_FORMAT: int - -# tarfile constants - -SUPPORTED_TYPES: tuple[bytes, ...] -REGULAR_TYPES: tuple[bytes, ...] -GNU_TYPES: tuple[bytes, ...] -PAX_FIELDS: tuple[str, ...] -PAX_NUMBER_FIELDS: dict[str, type] -PAX_NAME_FIELDS: set[str] - -ENCODING: str - -@overload -def open( - name: StrOrBytesPath | None = None, - mode: Literal["r", "r:*", "r:", "r:gz", "r:bz2", "r:xz"] = "r", - fileobj: IO[bytes] | None = None, - bufsize: int = 10240, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None, - mode: Literal["x", "x:", "a", "a:", "w", "w:"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None = None, - *, - mode: Literal["x", "x:", "a", "a:", "w", "w:"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None, - mode: Literal["x:gz", "x:bz2", "w:gz", "w:bz2"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - compresslevel: int = 9, -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None = None, - *, - mode: Literal["x:gz", "x:bz2", "w:gz", "w:bz2"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - compresslevel: int = 9, -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None, - mode: Literal["x:xz", "w:xz"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - preset: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9] | None = ..., -) -> TarFile: ... -@overload -def open( - name: StrOrBytesPath | None = None, - *, - mode: Literal["x:xz", "w:xz"], - fileobj: _Fileobj | None = None, - bufsize: int = 10240, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - preset: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9] | None = ..., -) -> TarFile: ... - -# TODO: Temporary fallback for modes containing pipe characters. These don't -# work with mypy 1.10, but this should be fixed with mypy 1.11. -# https://github.com/python/typeshed/issues/12182 -@overload -def open( - name: StrOrBytesPath | None = None, - *, - mode: str, - fileobj: IO[bytes] | None = None, - bufsize: int = 10240, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - preset: int | None = ..., -) -> TarFile: ... - -class ExFileObject(io.BufferedReader): - def __init__(self, tarfile: TarFile, tarinfo: TarInfo) -> None: ... - -class TarFile: - OPEN_METH: ClassVar[Mapping[str, str]] - name: StrOrBytesPath | None - mode: Literal["r", "a", "w", "x"] - fileobj: _Fileobj | None - format: int | None - tarinfo: type[TarInfo] - dereference: bool | None - ignore_zeros: bool | None - encoding: str | None - errors: str - fileobject: type[ExFileObject] - pax_headers: Mapping[str, str] | None - debug: int | None - errorlevel: int | None - offset: int # undocumented - extraction_filter: _FilterFunction | None - if sys.version_info >= (3, 13): - stream: bool - def __init__( - self, - name: StrOrBytesPath | None = None, - mode: Literal["r", "a", "w", "x"] = "r", - fileobj: _Fileobj | None = None, - format: int | None = None, - tarinfo: type[TarInfo] | None = None, - dereference: bool | None = None, - ignore_zeros: bool | None = None, - encoding: str | None = None, - errors: str = "surrogateescape", - pax_headers: Mapping[str, str] | None = None, - debug: int | None = None, - errorlevel: int | None = None, - copybufsize: int | None = None, # undocumented - stream: bool = False, - ) -> None: ... - else: - def __init__( - self, - name: StrOrBytesPath | None = None, - mode: Literal["r", "a", "w", "x"] = "r", - fileobj: _Fileobj | None = None, - format: int | None = None, - tarinfo: type[TarInfo] | None = None, - dereference: bool | None = None, - ignore_zeros: bool | None = None, - encoding: str | None = None, - errors: str = "surrogateescape", - pax_headers: Mapping[str, str] | None = None, - debug: int | None = None, - errorlevel: int | None = None, - copybufsize: int | None = None, # undocumented - ) -> None: ... - - def __enter__(self) -> Self: ... - def __exit__( - self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> None: ... - def __iter__(self) -> Iterator[TarInfo]: ... - @classmethod - def open( - cls, - name: StrOrBytesPath | None = None, - mode: str = "r", - fileobj: IO[bytes] | None = None, # depends on mode - bufsize: int = 10240, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - errors: str = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @classmethod - def taropen( - cls, - name: StrOrBytesPath | None, - mode: Literal["r", "a", "w", "x"] = "r", - fileobj: _Fileobj | None = None, - *, - compresslevel: int = ..., - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @overload - @classmethod - def gzopen( - cls, - name: StrOrBytesPath | None, - mode: Literal["r"] = "r", - fileobj: _GzipReadableFileobj | None = None, - compresslevel: int = 9, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @overload - @classmethod - def gzopen( - cls, - name: StrOrBytesPath | None, - mode: Literal["w", "x"], - fileobj: _GzipWritableFileobj | None = None, - compresslevel: int = 9, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @overload - @classmethod - def bz2open( - cls, - name: StrOrBytesPath | None, - mode: Literal["w", "x"], - fileobj: _Bz2WritableFileobj | None = None, - compresslevel: int = 9, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @overload - @classmethod - def bz2open( - cls, - name: StrOrBytesPath | None, - mode: Literal["r"] = "r", - fileobj: _Bz2ReadableFileobj | None = None, - compresslevel: int = 9, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - @classmethod - def xzopen( - cls, - name: StrOrBytesPath | None, - mode: Literal["r", "w", "x"] = "r", - fileobj: IO[bytes] | None = None, - preset: int | None = None, - *, - format: int | None = ..., - tarinfo: type[TarInfo] | None = ..., - dereference: bool | None = ..., - ignore_zeros: bool | None = ..., - encoding: str | None = ..., - pax_headers: Mapping[str, str] | None = ..., - debug: int | None = ..., - errorlevel: int | None = ..., - ) -> Self: ... - def getmember(self, name: str) -> TarInfo: ... - def getmembers(self) -> _list[TarInfo]: ... - def getnames(self) -> _list[str]: ... - def list(self, verbose: bool = True, *, members: _list[TarInfo] | None = None) -> None: ... - def next(self) -> TarInfo | None: ... - # Calling this method without `filter` is deprecated, but it may be set either on the class or in an - # individual call, so we can't mark it as @deprecated here. - def extractall( - self, - path: StrOrBytesPath = ".", - members: Iterable[TarInfo] | None = None, - *, - numeric_owner: bool = False, - filter: _TarfileFilter | None = ..., - ) -> None: ... - # Same situation as for `extractall`. - def extract( - self, - member: str | TarInfo, - path: StrOrBytesPath = "", - set_attrs: bool = True, - *, - numeric_owner: bool = False, - filter: _TarfileFilter | None = ..., - ) -> None: ... - def _extract_member( - self, tarinfo: TarInfo, targetpath: str, set_attrs: bool = True, numeric_owner: bool = False - ) -> None: ... # undocumented - def extractfile(self, member: str | TarInfo) -> IO[bytes] | None: ... - def makedir(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def makefile(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def makeunknown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def makefifo(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def makedev(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def makelink(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def chown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath, numeric_owner: bool) -> None: ... # undocumented - def chmod(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def utime(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented - def add( - self, - name: StrPath, - arcname: StrPath | None = None, - recursive: bool = True, - *, - filter: Callable[[TarInfo], TarInfo | None] | None = None, - ) -> None: ... - def addfile(self, tarinfo: TarInfo, fileobj: IO[bytes] | None = None) -> None: ... - def gettarinfo( - self, name: StrOrBytesPath | None = None, arcname: str | None = None, fileobj: IO[bytes] | None = None - ) -> TarInfo: ... - def close(self) -> None: ... - -if sys.version_info >= (3, 9): - def is_tarfile(name: StrOrBytesPath | IO[bytes]) -> bool: ... - -else: - def is_tarfile(name: StrOrBytesPath) -> bool: ... - -class TarError(Exception): ... -class ReadError(TarError): ... -class CompressionError(TarError): ... -class StreamError(TarError): ... -class ExtractError(TarError): ... -class HeaderError(TarError): ... - -class FilterError(TarError): - # This attribute is only set directly on the subclasses, but the documentation guarantees - # that it is always present on FilterError. - tarinfo: TarInfo - -class AbsolutePathError(FilterError): - def __init__(self, tarinfo: TarInfo) -> None: ... - -class OutsideDestinationError(FilterError): - def __init__(self, tarinfo: TarInfo, path: str) -> None: ... - -class SpecialFileError(FilterError): - def __init__(self, tarinfo: TarInfo) -> None: ... - -class AbsoluteLinkError(FilterError): - def __init__(self, tarinfo: TarInfo) -> None: ... - -class LinkOutsideDestinationError(FilterError): - def __init__(self, tarinfo: TarInfo, path: str) -> None: ... - -def fully_trusted_filter(member: TarInfo, dest_path: str) -> TarInfo: ... -def tar_filter(member: TarInfo, dest_path: str) -> TarInfo: ... -def data_filter(member: TarInfo, dest_path: str) -> TarInfo: ... - -class TarInfo: - name: str - path: str - size: int - mtime: int | float - chksum: int - devmajor: int - devminor: int - offset: int - offset_data: int - sparse: bytes | None - tarfile: TarFile | None - mode: int - type: bytes - linkname: str - uid: int - gid: int - uname: str - gname: str - pax_headers: Mapping[str, str] - def __init__(self, name: str = "") -> None: ... - @classmethod - def frombuf(cls, buf: bytes | bytearray, encoding: str, errors: str) -> Self: ... - @classmethod - def fromtarfile(cls, tarfile: TarFile) -> Self: ... - @property - def linkpath(self) -> str: ... - @linkpath.setter - def linkpath(self, linkname: str) -> None: ... - def replace( - self, - *, - name: str = ..., - mtime: int = ..., - mode: int = ..., - linkname: str = ..., - uid: int = ..., - gid: int = ..., - uname: str = ..., - gname: str = ..., - deep: bool = True, - ) -> Self: ... - def get_info(self) -> Mapping[str, str | int | bytes | Mapping[str, str]]: ... - def tobuf(self, format: int | None = 2, encoding: str | None = "utf-8", errors: str = "surrogateescape") -> bytes: ... - def create_ustar_header( - self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str, errors: str - ) -> bytes: ... - def create_gnu_header( - self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str, errors: str - ) -> bytes: ... - def create_pax_header(self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str) -> bytes: ... - @classmethod - def create_pax_global_header(cls, pax_headers: Mapping[str, str]) -> bytes: ... - def isfile(self) -> bool: ... - def isreg(self) -> bool: ... - def issparse(self) -> bool: ... - def isdir(self) -> bool: ... - def issym(self) -> bool: ... - def islnk(self) -> bool: ... - def ischr(self) -> bool: ... - def isblk(self) -> bool: ... - def isfifo(self) -> bool: ... - def isdev(self) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/termios.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/termios.pyi deleted file mode 100644 index a5378e40fdf2c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/termios.pyi +++ /dev/null @@ -1,267 +0,0 @@ -import sys -from _typeshed import FileDescriptorLike -from typing import Any -from typing_extensions import TypeAlias - -# Must be a list of length 7, containing 6 ints and a list of NCCS 1-character bytes or ints. -_Attr: TypeAlias = list[int | list[bytes | int]] | list[int | list[bytes]] | list[int | list[int]] -# Same as _Attr for return types; we use Any to avoid a union. -_AttrReturn: TypeAlias = list[Any] - -if sys.platform != "win32": - B0: int - B1000000: int - B110: int - B115200: int - B1152000: int - B1200: int - B134: int - B150: int - B1500000: int - B1800: int - B19200: int - B200: int - B2000000: int - B230400: int - B2400: int - B2500000: int - B300: int - B3000000: int - B3500000: int - B38400: int - B4000000: int - B460800: int - B4800: int - B50: int - B500000: int - B57600: int - B576000: int - B600: int - B75: int - B921600: int - B9600: int - BRKINT: int - BS0: int - BS1: int - BSDLY: int - CBAUD: int - CBAUDEX: int - CDEL: int - CDSUSP: int - CEOF: int - CEOL: int - CEOL2: int - CEOT: int - CERASE: int - CESC: int - CFLUSH: int - CIBAUD: int - CINTR: int - CKILL: int - CLNEXT: int - CLOCAL: int - CNUL: int - COMMON: int - CQUIT: int - CR0: int - CR1: int - CR2: int - CR3: int - CRDLY: int - CREAD: int - CRPRNT: int - CRTSCTS: int - CS5: int - CS6: int - CS7: int - CS8: int - CSIZE: int - CSTART: int - CSTOP: int - CSTOPB: int - CSUSP: int - CSWTCH: int - CWERASE: int - ECHO: int - ECHOCTL: int - ECHOE: int - ECHOK: int - ECHOKE: int - ECHONL: int - ECHOPRT: int - EXTA: int - EXTB: int - FF0: int - FF1: int - FFDLY: int - FIOASYNC: int - FIOCLEX: int - FIONBIO: int - FIONCLEX: int - FIONREAD: int - FLUSHO: int - HUPCL: int - IBSHIFT: int - ICANON: int - ICRNL: int - IEXTEN: int - IGNBRK: int - IGNCR: int - IGNPAR: int - IMAXBEL: int - INIT_C_CC: int - INLCR: int - INPCK: int - IOCSIZE_MASK: int - IOCSIZE_SHIFT: int - ISIG: int - ISTRIP: int - IUCLC: int - IXANY: int - IXOFF: int - IXON: int - N_MOUSE: int - N_PPP: int - N_SLIP: int - N_STRIP: int - N_TTY: int - NCC: int - NCCS: int - NL0: int - NL1: int - NLDLY: int - NOFLSH: int - NSWTCH: int - OCRNL: int - OFDEL: int - OFILL: int - OLCUC: int - ONLCR: int - ONLRET: int - ONOCR: int - OPOST: int - PARENB: int - PARMRK: int - PARODD: int - PENDIN: int - TAB0: int - TAB1: int - TAB2: int - TAB3: int - TABDLY: int - TCFLSH: int - TCGETA: int - TCGETS: int - TCIFLUSH: int - TCIOFF: int - TCIOFLUSH: int - TCION: int - TCOFLUSH: int - TCOOFF: int - TCOON: int - TCSADRAIN: int - TCSAFLUSH: int - TCSANOW: int - TCSASOFT: int - TCSBRK: int - TCSBRKP: int - TCSETA: int - TCSETAF: int - TCSETAW: int - TCSETS: int - TCSETSF: int - TCSETSW: int - TCXONC: int - TIOCCONS: int - TIOCEXCL: int - TIOCGETD: int - TIOCGICOUNT: int - TIOCGLCKTRMIOS: int - TIOCGPGRP: int - TIOCGSERIAL: int - TIOCGSIZE: int - TIOCGSOFTCAR: int - TIOCGWINSZ: int - TIOCINQ: int - TIOCLINUX: int - TIOCM_CAR: int - TIOCM_CD: int - TIOCM_CTS: int - TIOCM_DSR: int - TIOCM_DTR: int - TIOCM_LE: int - TIOCM_RI: int - TIOCM_RNG: int - TIOCM_RTS: int - TIOCM_SR: int - TIOCM_ST: int - TIOCMBIC: int - TIOCMBIS: int - TIOCMGET: int - TIOCMIWAIT: int - TIOCMSET: int - TIOCNOTTY: int - TIOCNXCL: int - TIOCOUTQ: int - TIOCPKT_DATA: int - TIOCPKT_DOSTOP: int - TIOCPKT_FLUSHREAD: int - TIOCPKT_FLUSHWRITE: int - TIOCPKT_NOSTOP: int - TIOCPKT_START: int - TIOCPKT_STOP: int - TIOCPKT: int - TIOCSCTTY: int - TIOCSER_TEMT: int - TIOCSERCONFIG: int - TIOCSERGETLSR: int - TIOCSERGETMULTI: int - TIOCSERGSTRUCT: int - TIOCSERGWILD: int - TIOCSERSETMULTI: int - TIOCSERSWILD: int - TIOCSETD: int - TIOCSLCKTRMIOS: int - TIOCSPGRP: int - TIOCSSERIAL: int - TIOCSSIZE: int - TIOCSSOFTCAR: int - TIOCSTI: int - TIOCSWINSZ: int - TIOCTTYGSTRUCT: int - TOSTOP: int - VDISCARD: int - VEOF: int - VEOL: int - VEOL2: int - VERASE: int - VINTR: int - VKILL: int - VLNEXT: int - VMIN: int - VQUIT: int - VREPRINT: int - VSTART: int - VSTOP: int - VSUSP: int - VSWTC: int - VSWTCH: int - VT0: int - VT1: int - VTDLY: int - VTIME: int - VWERASE: int - XCASE: int - XTABS: int - - def tcgetattr(fd: FileDescriptorLike, /) -> _AttrReturn: ... - def tcsetattr(fd: FileDescriptorLike, when: int, attributes: _Attr, /) -> None: ... - def tcsendbreak(fd: FileDescriptorLike, duration: int, /) -> None: ... - def tcdrain(fd: FileDescriptorLike, /) -> None: ... - def tcflush(fd: FileDescriptorLike, queue: int, /) -> None: ... - def tcflow(fd: FileDescriptorLike, action: int, /) -> None: ... - if sys.version_info >= (3, 11): - def tcgetwinsize(fd: FileDescriptorLike, /) -> tuple[int, int]: ... - def tcsetwinsize(fd: FileDescriptorLike, winsize: tuple[int, int], /) -> None: ... - - class error(Exception): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/threading.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/threading.pyi deleted file mode 100644 index c441a04681e22..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/threading.pyi +++ /dev/null @@ -1,190 +0,0 @@ -import _thread -import sys -from _thread import _excepthook, _ExceptHookArgs, get_native_id as get_native_id -from _typeshed import ProfileFunction, TraceFunction -from collections.abc import Callable, Iterable, Mapping -from types import TracebackType -from typing import Any, TypeVar, final - -_T = TypeVar("_T") - -__all__ = [ - "get_ident", - "active_count", - "Condition", - "current_thread", - "enumerate", - "main_thread", - "TIMEOUT_MAX", - "Event", - "Lock", - "RLock", - "Semaphore", - "BoundedSemaphore", - "Thread", - "Barrier", - "BrokenBarrierError", - "Timer", - "ThreadError", - "ExceptHookArgs", - "setprofile", - "settrace", - "local", - "stack_size", - "excepthook", - "get_native_id", -] - -if sys.version_info >= (3, 10): - __all__ += ["getprofile", "gettrace"] - -if sys.version_info >= (3, 12): - __all__ += ["setprofile_all_threads", "settrace_all_threads"] - -_profile_hook: ProfileFunction | None - -def active_count() -> int: ... -def activeCount() -> int: ... # deprecated alias for active_count() -def current_thread() -> Thread: ... -def currentThread() -> Thread: ... # deprecated alias for current_thread() -def get_ident() -> int: ... -def enumerate() -> list[Thread]: ... -def main_thread() -> Thread: ... -def settrace(func: TraceFunction) -> None: ... -def setprofile(func: ProfileFunction | None) -> None: ... - -if sys.version_info >= (3, 12): - def setprofile_all_threads(func: ProfileFunction | None) -> None: ... - def settrace_all_threads(func: TraceFunction) -> None: ... - -if sys.version_info >= (3, 10): - def gettrace() -> TraceFunction | None: ... - def getprofile() -> ProfileFunction | None: ... - -def stack_size(size: int = 0, /) -> int: ... - -TIMEOUT_MAX: float - -ThreadError = _thread.error -local = _thread._local - -class Thread: - name: str - @property - def ident(self) -> int | None: ... - daemon: bool - def __init__( - self, - group: None = None, - target: Callable[..., object] | None = None, - name: str | None = None, - args: Iterable[Any] = (), - kwargs: Mapping[str, Any] | None = None, - *, - daemon: bool | None = None, - ) -> None: ... - def start(self) -> None: ... - def run(self) -> None: ... - def join(self, timeout: float | None = None) -> None: ... - @property - def native_id(self) -> int | None: ... # only available on some platforms - def is_alive(self) -> bool: ... - if sys.version_info < (3, 9): - def isAlive(self) -> bool: ... - # the following methods are all deprecated - def getName(self) -> str: ... - def setName(self, name: str) -> None: ... - def isDaemon(self) -> bool: ... - def setDaemon(self, daemonic: bool) -> None: ... - -class _DummyThread(Thread): - def __init__(self) -> None: ... - -@final -class Lock: - def __enter__(self) -> bool: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - def acquire(self, blocking: bool = ..., timeout: float = ...) -> bool: ... - def release(self) -> None: ... - def locked(self) -> bool: ... - def acquire_lock(self, blocking: bool = ..., timeout: float = ...) -> bool: ... # undocumented - def release_lock(self) -> None: ... # undocumented - def locked_lock(self) -> bool: ... # undocumented - -@final -class _RLock: - def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... - def release(self) -> None: ... - __enter__ = acquire - def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... - -RLock = _RLock - -class Condition: - def __init__(self, lock: Lock | _RLock | None = None) -> None: ... - def __enter__(self) -> bool: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - def acquire(self, blocking: bool = ..., timeout: float = ...) -> bool: ... - def release(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - def wait_for(self, predicate: Callable[[], _T], timeout: float | None = None) -> _T: ... - def notify(self, n: int = 1) -> None: ... - def notify_all(self) -> None: ... - def notifyAll(self) -> None: ... # deprecated alias for notify_all() - -class Semaphore: - _value: int - def __init__(self, value: int = 1) -> None: ... - def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... - def acquire(self, blocking: bool = True, timeout: float | None = None) -> bool: ... - def __enter__(self, blocking: bool = True, timeout: float | None = None) -> bool: ... - if sys.version_info >= (3, 9): - def release(self, n: int = 1) -> None: ... - else: - def release(self) -> None: ... - -class BoundedSemaphore(Semaphore): ... - -class Event: - def is_set(self) -> bool: ... - def isSet(self) -> bool: ... # deprecated alias for is_set() - def set(self) -> None: ... - def clear(self) -> None: ... - def wait(self, timeout: float | None = None) -> bool: ... - -excepthook = _excepthook -ExceptHookArgs = _ExceptHookArgs - -class Timer(Thread): - args: Iterable[Any] # undocumented - finished: Event # undocumented - function: Callable[..., Any] # undocumented - interval: float # undocumented - kwargs: Mapping[str, Any] # undocumented - - def __init__( - self, - interval: float, - function: Callable[..., object], - args: Iterable[Any] | None = None, - kwargs: Mapping[str, Any] | None = None, - ) -> None: ... - def cancel(self) -> None: ... - -class Barrier: - @property - def parties(self) -> int: ... - @property - def n_waiting(self) -> int: ... - @property - def broken(self) -> bool: ... - def __init__(self, parties: int, action: Callable[[], None] | None = None, timeout: float | None = None) -> None: ... - def wait(self, timeout: float | None = None) -> int: ... - def reset(self) -> None: ... - def abort(self) -> None: ... - -class BrokenBarrierError(RuntimeError): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi deleted file mode 100644 index 4d25a04f8eb75..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi +++ /dev/null @@ -1,3845 +0,0 @@ -import _tkinter -import sys -from _typeshed import Incomplete, StrEnum, StrOrBytesPath -from collections.abc import Callable, Iterable, Mapping, Sequence -from tkinter.constants import * -from tkinter.font import _FontDescription -from types import TracebackType -from typing import Any, Generic, Literal, NamedTuple, TypedDict, TypeVar, overload, type_check_only -from typing_extensions import TypeAlias, TypeVarTuple, Unpack, deprecated - -if sys.version_info >= (3, 9): - __all__ = [ - "TclError", - "NO", - "FALSE", - "OFF", - "YES", - "TRUE", - "ON", - "N", - "S", - "W", - "E", - "NW", - "SW", - "NE", - "SE", - "NS", - "EW", - "NSEW", - "CENTER", - "NONE", - "X", - "Y", - "BOTH", - "LEFT", - "TOP", - "RIGHT", - "BOTTOM", - "RAISED", - "SUNKEN", - "FLAT", - "RIDGE", - "GROOVE", - "SOLID", - "HORIZONTAL", - "VERTICAL", - "NUMERIC", - "CHAR", - "WORD", - "BASELINE", - "INSIDE", - "OUTSIDE", - "SEL", - "SEL_FIRST", - "SEL_LAST", - "END", - "INSERT", - "CURRENT", - "ANCHOR", - "ALL", - "NORMAL", - "DISABLED", - "ACTIVE", - "HIDDEN", - "CASCADE", - "CHECKBUTTON", - "COMMAND", - "RADIOBUTTON", - "SEPARATOR", - "SINGLE", - "BROWSE", - "MULTIPLE", - "EXTENDED", - "DOTBOX", - "UNDERLINE", - "PIESLICE", - "CHORD", - "ARC", - "FIRST", - "LAST", - "BUTT", - "PROJECTING", - "ROUND", - "BEVEL", - "MITER", - "MOVETO", - "SCROLL", - "UNITS", - "PAGES", - "TkVersion", - "TclVersion", - "READABLE", - "WRITABLE", - "EXCEPTION", - "EventType", - "Event", - "NoDefaultRoot", - "Variable", - "StringVar", - "IntVar", - "DoubleVar", - "BooleanVar", - "mainloop", - "getint", - "getdouble", - "getboolean", - "Misc", - "CallWrapper", - "XView", - "YView", - "Wm", - "Tk", - "Tcl", - "Pack", - "Place", - "Grid", - "BaseWidget", - "Widget", - "Toplevel", - "Button", - "Canvas", - "Checkbutton", - "Entry", - "Frame", - "Label", - "Listbox", - "Menu", - "Menubutton", - "Message", - "Radiobutton", - "Scale", - "Scrollbar", - "Text", - "OptionMenu", - "Image", - "PhotoImage", - "BitmapImage", - "image_names", - "image_types", - "Spinbox", - "LabelFrame", - "PanedWindow", - ] - -# Using anything from tkinter.font in this file means that 'import tkinter' -# seems to also load tkinter.font. That's not how it actually works, but -# unfortunately not much can be done about it. https://github.com/python/typeshed/pull/4346 - -TclError = _tkinter.TclError -wantobjects: int -TkVersion: float -TclVersion: float -READABLE = _tkinter.READABLE -WRITABLE = _tkinter.WRITABLE -EXCEPTION = _tkinter.EXCEPTION - -# Quick guide for figuring out which widget class to choose: -# - Misc: any widget (don't use BaseWidget because Tk doesn't inherit from BaseWidget) -# - Widget: anything that is meant to be put into another widget with e.g. pack or grid -# -# Don't trust tkinter's docstrings, because they have been created by copy/pasting from -# Tk's manual pages more than 10 years ago. Use the latest manual pages instead: -# -# $ sudo apt install tk-doc tcl-doc -# $ man 3tk label # tkinter.Label -# $ man 3tk ttk_label # tkinter.ttk.Label -# $ man 3tcl after # tkinter.Misc.after -# -# You can also read the manual pages online: https://www.tcl.tk/doc/ - -# Some widgets have an option named -compound that accepts different values -# than the _Compound defined here. Many other options have similar things. -_Anchor: TypeAlias = Literal["nw", "n", "ne", "w", "center", "e", "sw", "s", "se"] # manual page: Tk_GetAnchor -_ButtonCommand: TypeAlias = str | Callable[[], Any] # accepts string of tcl code, return value is returned from Button.invoke() -_Compound: TypeAlias = Literal["top", "left", "center", "right", "bottom", "none"] # -compound in manual page named 'options' -# manual page: Tk_GetCursor -_Cursor: TypeAlias = str | tuple[str] | tuple[str, str] | tuple[str, str, str] | tuple[str, str, str, str] -# example when it's sequence: entry['invalidcommand'] = [entry.register(print), '%P'] -_EntryValidateCommand: TypeAlias = str | list[str] | tuple[str, ...] | Callable[[], bool] -_ImageSpec: TypeAlias = _Image | str # str can be from e.g. tkinter.image_names() -_Relief: TypeAlias = Literal["raised", "sunken", "flat", "ridge", "solid", "groove"] # manual page: Tk_GetRelief -_ScreenUnits: TypeAlias = str | float # Often the right type instead of int. Manual page: Tk_GetPixels -# -xscrollcommand and -yscrollcommand in 'options' manual page -_XYScrollCommand: TypeAlias = str | Callable[[float, float], object] -_TakeFocusValue: TypeAlias = bool | Literal[0, 1, ""] | Callable[[str], bool | None] # -takefocus in manual page named 'options' - -if sys.version_info >= (3, 11): - class _VersionInfoType(NamedTuple): - major: int - minor: int - micro: int - releaselevel: str - serial: int - -class EventType(StrEnum): - Activate = "36" - ButtonPress = "4" - Button = ButtonPress - ButtonRelease = "5" - Circulate = "26" - CirculateRequest = "27" - ClientMessage = "33" - Colormap = "32" - Configure = "22" - ConfigureRequest = "23" - Create = "16" - Deactivate = "37" - Destroy = "17" - Enter = "7" - Expose = "12" - FocusIn = "9" - FocusOut = "10" - GraphicsExpose = "13" - Gravity = "24" - KeyPress = "2" - Key = "2" - KeyRelease = "3" - Keymap = "11" - Leave = "8" - Map = "19" - MapRequest = "20" - Mapping = "34" - Motion = "6" - MouseWheel = "38" - NoExpose = "14" - Property = "28" - Reparent = "21" - ResizeRequest = "25" - Selection = "31" - SelectionClear = "29" - SelectionRequest = "30" - Unmap = "18" - VirtualEvent = "35" - Visibility = "15" - -_W = TypeVar("_W", bound=Misc) -# Events considered covariant because you should never assign to event.widget. -_W_co = TypeVar("_W_co", covariant=True, bound=Misc) - -class Event(Generic[_W_co]): - serial: int - num: int - focus: bool - height: int - width: int - keycode: int - state: int | str - time: int - x: int - y: int - x_root: int - y_root: int - char: str - send_event: bool - keysym: str - keysym_num: int - type: EventType - widget: _W_co - delta: int - -def NoDefaultRoot() -> None: ... - -class Variable: - def __init__(self, master: Misc | None = None, value: Incomplete | None = None, name: str | None = None) -> None: ... - def set(self, value) -> None: ... - initialize = set - def get(self): ... - def trace_add(self, mode: Literal["array", "read", "write", "unset"], callback: Callable[[str, str, str], object]) -> str: ... - def trace_remove(self, mode: Literal["array", "read", "write", "unset"], cbname: str) -> None: ... - def trace_info(self) -> list[tuple[tuple[Literal["array", "read", "write", "unset"], ...], str]]: ... - @deprecated("use trace_add() instead of trace()") - def trace(self, mode, callback): ... - @deprecated("use trace_add() instead of trace_variable()") - def trace_variable(self, mode, callback): ... - @deprecated("use trace_remove() instead of trace_vdelete()") - def trace_vdelete(self, mode, cbname) -> None: ... - @deprecated("use trace_info() instead of trace_vinfo()") - def trace_vinfo(self): ... - def __eq__(self, other: object) -> bool: ... - def __del__(self) -> None: ... - -class StringVar(Variable): - def __init__(self, master: Misc | None = None, value: str | None = None, name: str | None = None) -> None: ... - def set(self, value: str) -> None: ... - initialize = set - def get(self) -> str: ... - -class IntVar(Variable): - def __init__(self, master: Misc | None = None, value: int | None = None, name: str | None = None) -> None: ... - def set(self, value: int) -> None: ... - initialize = set - def get(self) -> int: ... - -class DoubleVar(Variable): - def __init__(self, master: Misc | None = None, value: float | None = None, name: str | None = None) -> None: ... - def set(self, value: float) -> None: ... - initialize = set - def get(self) -> float: ... - -class BooleanVar(Variable): - def __init__(self, master: Misc | None = None, value: bool | None = None, name: str | None = None) -> None: ... - def set(self, value: bool) -> None: ... - initialize = set - def get(self) -> bool: ... - -def mainloop(n: int = 0) -> None: ... - -getint: Incomplete -getdouble: Incomplete - -def getboolean(s): ... - -_Ts = TypeVarTuple("_Ts") - -class _GridIndexInfo(TypedDict, total=False): - minsize: _ScreenUnits - pad: _ScreenUnits - uniform: str | None - weight: int - -class Misc: - master: Misc | None - tk: _tkinter.TkappType - children: dict[str, Widget] - def destroy(self) -> None: ... - def deletecommand(self, name: str) -> None: ... - def tk_strictMotif(self, boolean: Incomplete | None = None): ... - def tk_bisque(self) -> None: ... - def tk_setPalette(self, *args, **kw) -> None: ... - def wait_variable(self, name: str | Variable = "PY_VAR") -> None: ... - waitvar = wait_variable - def wait_window(self, window: Misc | None = None) -> None: ... - def wait_visibility(self, window: Misc | None = None) -> None: ... - def setvar(self, name: str = "PY_VAR", value: str = "1") -> None: ... - def getvar(self, name: str = "PY_VAR"): ... - def getint(self, s): ... - def getdouble(self, s): ... - def getboolean(self, s): ... - def focus_set(self) -> None: ... - focus = focus_set - def focus_force(self) -> None: ... - def focus_get(self) -> Misc | None: ... - def focus_displayof(self) -> Misc | None: ... - def focus_lastfor(self) -> Misc | None: ... - def tk_focusFollowsMouse(self) -> None: ... - def tk_focusNext(self) -> Misc | None: ... - def tk_focusPrev(self) -> Misc | None: ... - # .after() can be called without the "func" argument, but it is basically never what you want. - # It behaves like time.sleep() and freezes the GUI app. - def after(self, ms: int | Literal["idle"], func: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> str: ... - # after_idle is essentially partialmethod(after, "idle") - def after_idle(self, func: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> str: ... - def after_cancel(self, id: str) -> None: ... - def bell(self, displayof: Literal[0] | Misc | None = 0) -> None: ... - def clipboard_get(self, *, displayof: Misc = ..., type: str = ...) -> str: ... - def clipboard_clear(self, *, displayof: Misc = ...) -> None: ... - def clipboard_append(self, string: str, *, displayof: Misc = ..., format: str = ..., type: str = ...) -> None: ... - def grab_current(self): ... - def grab_release(self) -> None: ... - def grab_set(self) -> None: ... - def grab_set_global(self) -> None: ... - def grab_status(self) -> Literal["local", "global"] | None: ... - def option_add( - self, pattern, value, priority: int | Literal["widgetDefault", "startupFile", "userDefault", "interactive"] | None = None - ) -> None: ... - def option_clear(self) -> None: ... - def option_get(self, name, className): ... - def option_readfile(self, fileName, priority: Incomplete | None = None) -> None: ... - def selection_clear(self, **kw) -> None: ... - def selection_get(self, **kw): ... - def selection_handle(self, command, **kw) -> None: ... - def selection_own(self, **kw) -> None: ... - def selection_own_get(self, **kw): ... - def send(self, interp, cmd, *args): ... - def lower(self, belowThis: Incomplete | None = None) -> None: ... - def tkraise(self, aboveThis: Incomplete | None = None) -> None: ... - lift = tkraise - if sys.version_info >= (3, 11): - def info_patchlevel(self) -> _VersionInfoType: ... - - def winfo_atom(self, name: str, displayof: Literal[0] | Misc | None = 0) -> int: ... - def winfo_atomname(self, id: int, displayof: Literal[0] | Misc | None = 0) -> str: ... - def winfo_cells(self) -> int: ... - def winfo_children(self) -> list[Widget]: ... # Widget because it can't be Toplevel or Tk - def winfo_class(self) -> str: ... - def winfo_colormapfull(self) -> bool: ... - def winfo_containing(self, rootX: int, rootY: int, displayof: Literal[0] | Misc | None = 0) -> Misc | None: ... - def winfo_depth(self) -> int: ... - def winfo_exists(self) -> bool: ... - def winfo_fpixels(self, number: _ScreenUnits) -> float: ... - def winfo_geometry(self) -> str: ... - def winfo_height(self) -> int: ... - def winfo_id(self) -> int: ... - def winfo_interps(self, displayof: Literal[0] | Misc | None = 0) -> tuple[str, ...]: ... - def winfo_ismapped(self) -> bool: ... - def winfo_manager(self) -> str: ... - def winfo_name(self) -> str: ... - def winfo_parent(self) -> str: ... # return value needs nametowidget() - def winfo_pathname(self, id: int, displayof: Literal[0] | Misc | None = 0): ... - def winfo_pixels(self, number: _ScreenUnits) -> int: ... - def winfo_pointerx(self) -> int: ... - def winfo_pointerxy(self) -> tuple[int, int]: ... - def winfo_pointery(self) -> int: ... - def winfo_reqheight(self) -> int: ... - def winfo_reqwidth(self) -> int: ... - def winfo_rgb(self, color: str) -> tuple[int, int, int]: ... - def winfo_rootx(self) -> int: ... - def winfo_rooty(self) -> int: ... - def winfo_screen(self) -> str: ... - def winfo_screencells(self) -> int: ... - def winfo_screendepth(self) -> int: ... - def winfo_screenheight(self) -> int: ... - def winfo_screenmmheight(self) -> int: ... - def winfo_screenmmwidth(self) -> int: ... - def winfo_screenvisual(self) -> str: ... - def winfo_screenwidth(self) -> int: ... - def winfo_server(self) -> str: ... - def winfo_toplevel(self) -> Tk | Toplevel: ... - def winfo_viewable(self) -> bool: ... - def winfo_visual(self) -> str: ... - def winfo_visualid(self) -> str: ... - def winfo_visualsavailable(self, includeids: bool = False) -> list[tuple[str, int]]: ... - def winfo_vrootheight(self) -> int: ... - def winfo_vrootwidth(self) -> int: ... - def winfo_vrootx(self) -> int: ... - def winfo_vrooty(self) -> int: ... - def winfo_width(self) -> int: ... - def winfo_x(self) -> int: ... - def winfo_y(self) -> int: ... - def update(self) -> None: ... - def update_idletasks(self) -> None: ... - @overload - def bindtags(self, tagList: None = None) -> tuple[str, ...]: ... - @overload - def bindtags(self, tagList: list[str] | tuple[str, ...]) -> None: ... - # bind with isinstance(func, str) doesn't return anything, but all other - # binds do. The default value of func is not str. - @overload - def bind( - self, - sequence: str | None = None, - func: Callable[[Event[Misc]], object] | None = None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def bind(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - @overload - def bind(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - # There's no way to know what type of widget bind_all and bind_class - # callbacks will get, so those are Misc. - @overload - def bind_all( - self, - sequence: str | None = None, - func: Callable[[Event[Misc]], object] | None = None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def bind_all(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - @overload - def bind_all(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - @overload - def bind_class( - self, - className: str, - sequence: str | None = None, - func: Callable[[Event[Misc]], object] | None = None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def bind_class(self, className: str, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - @overload - def bind_class(self, className: str, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - def unbind(self, sequence: str, funcid: str | None = None) -> None: ... - def unbind_all(self, sequence: str) -> None: ... - def unbind_class(self, className: str, sequence: str) -> None: ... - def mainloop(self, n: int = 0) -> None: ... - def quit(self) -> None: ... - @property - def _windowingsystem(self) -> Literal["win32", "aqua", "x11"]: ... - def nametowidget(self, name: str | Misc | _tkinter.Tcl_Obj) -> Any: ... - def register( - self, func: Callable[..., object], subst: Callable[..., Sequence[Any]] | None = None, needcleanup: int = 1 - ) -> str: ... - def keys(self) -> list[str]: ... - @overload - def pack_propagate(self, flag: bool) -> bool | None: ... - @overload - def pack_propagate(self) -> None: ... - propagate = pack_propagate - def grid_anchor(self, anchor: _Anchor | None = None) -> None: ... - anchor = grid_anchor - @overload - def grid_bbox( - self, column: None = None, row: None = None, col2: None = None, row2: None = None - ) -> tuple[int, int, int, int] | None: ... - @overload - def grid_bbox(self, column: int, row: int, col2: None = None, row2: None = None) -> tuple[int, int, int, int] | None: ... - @overload - def grid_bbox(self, column: int, row: int, col2: int, row2: int) -> tuple[int, int, int, int] | None: ... - bbox = grid_bbox - def grid_columnconfigure( - self, - index: int | str | list[int] | tuple[int, ...], - cnf: _GridIndexInfo = {}, - *, - minsize: _ScreenUnits = ..., - pad: _ScreenUnits = ..., - uniform: str = ..., - weight: int = ..., - ) -> _GridIndexInfo | Any: ... # can be None but annoying to check - def grid_rowconfigure( - self, - index: int | str | list[int] | tuple[int, ...], - cnf: _GridIndexInfo = {}, - *, - minsize: _ScreenUnits = ..., - pad: _ScreenUnits = ..., - uniform: str = ..., - weight: int = ..., - ) -> _GridIndexInfo | Any: ... # can be None but annoying to check - columnconfigure = grid_columnconfigure - rowconfigure = grid_rowconfigure - def grid_location(self, x: _ScreenUnits, y: _ScreenUnits) -> tuple[int, int]: ... - @overload - def grid_propagate(self, flag: bool) -> None: ... - @overload - def grid_propagate(self) -> bool: ... - def grid_size(self) -> tuple[int, int]: ... - size = grid_size - # Widget because Toplevel or Tk is never a slave - def pack_slaves(self) -> list[Widget]: ... - def grid_slaves(self, row: int | None = None, column: int | None = None) -> list[Widget]: ... - def place_slaves(self) -> list[Widget]: ... - slaves = pack_slaves - def event_add(self, virtual: str, *sequences: str) -> None: ... - def event_delete(self, virtual: str, *sequences: str) -> None: ... - def event_generate( - self, - sequence: str, - *, - above: Misc | int = ..., - borderwidth: _ScreenUnits = ..., - button: int = ..., - count: int = ..., - data: Any = ..., # anything with usable str() value - delta: int = ..., - detail: str = ..., - focus: bool = ..., - height: _ScreenUnits = ..., - keycode: int = ..., - keysym: str = ..., - mode: str = ..., - override: bool = ..., - place: Literal["PlaceOnTop", "PlaceOnBottom"] = ..., - root: Misc | int = ..., - rootx: _ScreenUnits = ..., - rooty: _ScreenUnits = ..., - sendevent: bool = ..., - serial: int = ..., - state: int | str = ..., - subwindow: Misc | int = ..., - time: int = ..., - warp: bool = ..., - width: _ScreenUnits = ..., - when: Literal["now", "tail", "head", "mark"] = ..., - x: _ScreenUnits = ..., - y: _ScreenUnits = ..., - ) -> None: ... - def event_info(self, virtual: str | None = None) -> tuple[str, ...]: ... - def image_names(self) -> tuple[str, ...]: ... - def image_types(self) -> tuple[str, ...]: ... - # See #4363 and #4891 - def __setitem__(self, key: str, value: Any) -> None: ... - def __getitem__(self, key: str) -> Any: ... - def cget(self, key: str) -> Any: ... - def configure(self, cnf: Any = None) -> Any: ... - # TODO: config is an alias of configure, but adding that here creates lots of mypy errors - -class CallWrapper: - func: Incomplete - subst: Incomplete - widget: Incomplete - def __init__(self, func, subst, widget) -> None: ... - def __call__(self, *args): ... - -class XView: - @overload - def xview(self) -> tuple[float, float]: ... - @overload - def xview(self, *args): ... - def xview_moveto(self, fraction: float) -> None: ... - @overload - def xview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ... - @overload - def xview_scroll(self, number: _ScreenUnits, what: Literal["pixels"]) -> None: ... - -class YView: - @overload - def yview(self) -> tuple[float, float]: ... - @overload - def yview(self, *args): ... - def yview_moveto(self, fraction: float) -> None: ... - @overload - def yview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ... - @overload - def yview_scroll(self, number: _ScreenUnits, what: Literal["pixels"]) -> None: ... - -class Wm: - @overload - def wm_aspect(self, minNumer: int, minDenom: int, maxNumer: int, maxDenom: int) -> None: ... - @overload - def wm_aspect( - self, minNumer: None = None, minDenom: None = None, maxNumer: None = None, maxDenom: None = None - ) -> tuple[int, int, int, int] | None: ... - aspect = wm_aspect - @overload - def wm_attributes(self) -> tuple[Any, ...]: ... - @overload - def wm_attributes(self, option: str, /): ... - @overload - def wm_attributes(self, option: str, value, /, *__other_option_value_pairs: Any) -> None: ... - attributes = wm_attributes - def wm_client(self, name: str | None = None) -> str: ... - client = wm_client - @overload - def wm_colormapwindows(self) -> list[Misc]: ... - @overload - def wm_colormapwindows(self, wlist: list[Misc] | tuple[Misc, ...], /) -> None: ... - @overload - def wm_colormapwindows(self, first_wlist_item: Misc, /, *other_wlist_items: Misc) -> None: ... - colormapwindows = wm_colormapwindows - def wm_command(self, value: str | None = None) -> str: ... - command = wm_command - # Some of these always return empty string, but return type is set to None to prevent accidentally using it - def wm_deiconify(self) -> None: ... - deiconify = wm_deiconify - def wm_focusmodel(self, model: Literal["active", "passive"] | None = None) -> Literal["active", "passive", ""]: ... - focusmodel = wm_focusmodel - def wm_forget(self, window: Wm) -> None: ... - forget = wm_forget - def wm_frame(self) -> str: ... - frame = wm_frame - @overload - def wm_geometry(self, newGeometry: None = None) -> str: ... - @overload - def wm_geometry(self, newGeometry: str) -> None: ... - geometry = wm_geometry - def wm_grid( - self, - baseWidth: Incomplete | None = None, - baseHeight: Incomplete | None = None, - widthInc: Incomplete | None = None, - heightInc: Incomplete | None = None, - ): ... - grid = wm_grid - def wm_group(self, pathName: Incomplete | None = None): ... - group = wm_group - def wm_iconbitmap(self, bitmap: Incomplete | None = None, default: Incomplete | None = None): ... - iconbitmap = wm_iconbitmap - def wm_iconify(self) -> None: ... - iconify = wm_iconify - def wm_iconmask(self, bitmap: Incomplete | None = None): ... - iconmask = wm_iconmask - def wm_iconname(self, newName: Incomplete | None = None) -> str: ... - iconname = wm_iconname - def wm_iconphoto(self, default: bool, image1: _PhotoImageLike | str, /, *args: _PhotoImageLike | str) -> None: ... - iconphoto = wm_iconphoto - def wm_iconposition(self, x: int | None = None, y: int | None = None) -> tuple[int, int] | None: ... - iconposition = wm_iconposition - def wm_iconwindow(self, pathName: Incomplete | None = None): ... - iconwindow = wm_iconwindow - def wm_manage(self, widget) -> None: ... - manage = wm_manage - @overload - def wm_maxsize(self, width: None = None, height: None = None) -> tuple[int, int]: ... - @overload - def wm_maxsize(self, width: int, height: int) -> None: ... - maxsize = wm_maxsize - @overload - def wm_minsize(self, width: None = None, height: None = None) -> tuple[int, int]: ... - @overload - def wm_minsize(self, width: int, height: int) -> None: ... - minsize = wm_minsize - @overload - def wm_overrideredirect(self, boolean: None = None) -> bool | None: ... # returns True or None - @overload - def wm_overrideredirect(self, boolean: bool) -> None: ... - overrideredirect = wm_overrideredirect - def wm_positionfrom(self, who: Literal["program", "user"] | None = None) -> Literal["", "program", "user"]: ... - positionfrom = wm_positionfrom - @overload - def wm_protocol(self, name: str, func: Callable[[], object] | str) -> None: ... - @overload - def wm_protocol(self, name: str, func: None = None) -> str: ... - @overload - def wm_protocol(self, name: None = None, func: None = None) -> tuple[str, ...]: ... - protocol = wm_protocol - @overload - def wm_resizable(self, width: None = None, height: None = None) -> tuple[bool, bool]: ... - @overload - def wm_resizable(self, width: bool, height: bool) -> None: ... - resizable = wm_resizable - def wm_sizefrom(self, who: Literal["program", "user"] | None = None) -> Literal["", "program", "user"]: ... - sizefrom = wm_sizefrom - @overload - def wm_state(self, newstate: None = None) -> str: ... - @overload - def wm_state(self, newstate: str) -> None: ... - state = wm_state - @overload - def wm_title(self, string: None = None) -> str: ... - @overload - def wm_title(self, string: str) -> None: ... - title = wm_title - @overload - def wm_transient(self, master: None = None) -> _tkinter.Tcl_Obj: ... - @overload - def wm_transient(self, master: Wm | _tkinter.Tcl_Obj) -> None: ... - transient = wm_transient - def wm_withdraw(self) -> None: ... - withdraw = wm_withdraw - -class Tk(Misc, Wm): - master: None - def __init__( - # Make sure to keep in sync with other functions that use the same - # args. - # use `git grep screenName` to find them - self, - screenName: str | None = None, - baseName: str | None = None, - className: str = "Tk", - useTk: bool = True, - sync: bool = False, - use: str | None = None, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - menu: Menu = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - takefocus: _TakeFocusValue = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def destroy(self) -> None: ... - def readprofile(self, baseName: str, className: str) -> None: ... - report_callback_exception: Callable[[type[BaseException], BaseException, TracebackType | None], object] - # Tk has __getattr__ so that tk_instance.foo falls back to tk_instance.tk.foo - # Please keep in sync with _tkinter.TkappType. - # Some methods are intentionally missing because they are inherited from Misc instead. - def adderrorinfo(self, msg, /): ... - def call(self, command: Any, /, *args: Any) -> Any: ... - def createcommand(self, name, func, /): ... - if sys.platform != "win32": - def createfilehandler(self, file, mask, func, /): ... - def deletefilehandler(self, file, /): ... - - def createtimerhandler(self, milliseconds, func, /): ... - def dooneevent(self, flags: int = ..., /): ... - def eval(self, script: str, /) -> str: ... - def evalfile(self, fileName, /): ... - def exprboolean(self, s, /): ... - def exprdouble(self, s, /): ... - def exprlong(self, s, /): ... - def exprstring(self, s, /): ... - def globalgetvar(self, *args, **kwargs): ... - def globalsetvar(self, *args, **kwargs): ... - def globalunsetvar(self, *args, **kwargs): ... - def interpaddr(self): ... - def loadtk(self) -> None: ... - def record(self, script, /): ... - if sys.version_info < (3, 11): - def split(self, arg, /): ... - - def splitlist(self, arg, /): ... - def unsetvar(self, *args, **kwargs): ... - def wantobjects(self, *args, **kwargs): ... - def willdispatch(self): ... - -def Tcl(screenName: str | None = None, baseName: str | None = None, className: str = "Tk", useTk: bool = False) -> Tk: ... - -_InMiscTotal = TypedDict("_InMiscTotal", {"in": Misc}) -_InMiscNonTotal = TypedDict("_InMiscNonTotal", {"in": Misc}, total=False) - -class _PackInfo(_InMiscTotal): - # 'before' and 'after' never appear in _PackInfo - anchor: _Anchor - expand: bool - fill: Literal["none", "x", "y", "both"] - side: Literal["left", "right", "top", "bottom"] - # Paddings come out as int or tuple of int, even though any _ScreenUnits - # can be specified in pack(). - ipadx: int - ipady: int - padx: int | tuple[int, int] - pady: int | tuple[int, int] - -class Pack: - # _PackInfo is not the valid type for cnf because pad stuff accepts any - # _ScreenUnits instead of int only. I didn't bother to create another - # TypedDict for cnf because it appears to be a legacy thing that was - # replaced by **kwargs. - def pack_configure( - self, - cnf: Mapping[str, Any] | None = {}, - *, - after: Misc = ..., - anchor: _Anchor = ..., - before: Misc = ..., - expand: bool | Literal[0, 1] = 0, - fill: Literal["none", "x", "y", "both"] = ..., - side: Literal["left", "right", "top", "bottom"] = ..., - ipadx: _ScreenUnits = ..., - ipady: _ScreenUnits = ..., - padx: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., - pady: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., - in_: Misc = ..., - **kw: Any, # allow keyword argument named 'in', see #4836 - ) -> None: ... - def pack_forget(self) -> None: ... - def pack_info(self) -> _PackInfo: ... # errors if widget hasn't been packed - pack = pack_configure - forget = pack_forget - propagate = Misc.pack_propagate - -class _PlaceInfo(_InMiscNonTotal): # empty dict if widget hasn't been placed - anchor: _Anchor - bordermode: Literal["inside", "outside", "ignore"] - width: str # can be int()ed (even after e.g. widget.place(height='2.3c') or similar) - height: str # can be int()ed - x: str # can be int()ed - y: str # can be int()ed - relheight: str # can be float()ed if not empty string - relwidth: str # can be float()ed if not empty string - relx: str # can be float()ed if not empty string - rely: str # can be float()ed if not empty string - -class Place: - def place_configure( - self, - cnf: Mapping[str, Any] | None = {}, - *, - anchor: _Anchor = ..., - bordermode: Literal["inside", "outside", "ignore"] = ..., - width: _ScreenUnits = ..., - height: _ScreenUnits = ..., - x: _ScreenUnits = ..., - y: _ScreenUnits = ..., - # str allowed for compatibility with place_info() - relheight: str | float = ..., - relwidth: str | float = ..., - relx: str | float = ..., - rely: str | float = ..., - in_: Misc = ..., - **kw: Any, # allow keyword argument named 'in', see #4836 - ) -> None: ... - def place_forget(self) -> None: ... - def place_info(self) -> _PlaceInfo: ... - place = place_configure - info = place_info - -class _GridInfo(_InMiscNonTotal): # empty dict if widget hasn't been gridded - column: int - columnspan: int - row: int - rowspan: int - ipadx: int - ipady: int - padx: int | tuple[int, int] - pady: int | tuple[int, int] - sticky: str # consists of letters 'n', 's', 'w', 'e', no repeats, may be empty - -class Grid: - def grid_configure( - self, - cnf: Mapping[str, Any] | None = {}, - *, - column: int = ..., - columnspan: int = ..., - row: int = ..., - rowspan: int = ..., - ipadx: _ScreenUnits = ..., - ipady: _ScreenUnits = ..., - padx: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., - pady: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., - sticky: str = ..., # consists of letters 'n', 's', 'w', 'e', may contain repeats, may be empty - in_: Misc = ..., - **kw: Any, # allow keyword argument named 'in', see #4836 - ) -> None: ... - def grid_forget(self) -> None: ... - def grid_remove(self) -> None: ... - def grid_info(self) -> _GridInfo: ... - grid = grid_configure - location = Misc.grid_location - size = Misc.grid_size - -class BaseWidget(Misc): - master: Misc - widgetName: Incomplete - def __init__(self, master, widgetName, cnf={}, kw={}, extra=()) -> None: ... - def destroy(self) -> None: ... - -# This class represents any widget except Toplevel or Tk. -class Widget(BaseWidget, Pack, Place, Grid): - # Allow bind callbacks to take e.g. Event[Label] instead of Event[Misc]. - # Tk and Toplevel get notified for their child widgets' events, but other - # widgets don't. - @overload - def bind( - self: _W, - sequence: str | None = None, - func: Callable[[Event[_W]], object] | None = None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def bind(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - @overload - def bind(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - -class Toplevel(BaseWidget, Wm): - # Toplevel and Tk have the same options because they correspond to the same - # Tcl/Tk toplevel widget. For some reason, config and configure must be - # copy/pasted here instead of aliasing as 'config = Tk.config'. - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = 0, - bg: str = ..., - border: _ScreenUnits = 0, - borderwidth: _ScreenUnits = 0, - class_: str = "Toplevel", - colormap: Literal["new", ""] | Misc = "", - container: bool = False, - cursor: _Cursor = "", - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - menu: Menu = ..., - name: str = ..., - padx: _ScreenUnits = 0, - pady: _ScreenUnits = 0, - relief: _Relief = "flat", - screen: str = "", # can't be changed after creating widget - takefocus: _TakeFocusValue = 0, - use: int = ..., - visual: str | tuple[str, int] = "", - width: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - menu: Menu = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - takefocus: _TakeFocusValue = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class Button(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = "center", - background: str = ..., - bd: _ScreenUnits = ..., # same as borderwidth - bg: str = ..., # same as background - bitmap: str = "", - border: _ScreenUnits = ..., # same as borderwidth - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = "", - compound: _Compound = "none", - cursor: _Cursor = "", - default: Literal["normal", "active", "disabled"] = "disabled", - disabledforeground: str = ..., - fg: str = ..., # same as foreground - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - # width and height must be int for buttons containing just text, but - # ints are also valid _ScreenUnits - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 1, - image: _ImageSpec = "", - justify: Literal["left", "center", "right"] = "center", - name: str = ..., - overrelief: _Relief | Literal[""] = "", - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - repeatdelay: int = ..., - repeatinterval: int = ..., - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - text: float | str = "", - # We allow the textvariable to be any Variable, not necessarily - # StringVar. This is useful for e.g. a button that displays the value - # of an IntVar. - textvariable: Variable = ..., - underline: int = -1, - width: _ScreenUnits = 0, - wraplength: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = ..., - compound: _Compound = ..., - cursor: _Cursor = ..., - default: Literal["normal", "active", "disabled"] = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - image: _ImageSpec = ..., - justify: Literal["left", "center", "right"] = ..., - overrelief: _Relief | Literal[""] = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - repeatdelay: int = ..., - repeatinterval: int = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - underline: int = ..., - width: _ScreenUnits = ..., - wraplength: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def flash(self) -> None: ... - def invoke(self) -> Any: ... - -class Canvas(Widget, XView, YView): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = 0, - bg: str = ..., - border: _ScreenUnits = 0, - borderwidth: _ScreenUnits = 0, - closeenough: float = 1.0, - confine: bool = True, - cursor: _Cursor = "", - # canvas manual page has a section named COORDINATES, and the first - # part of it describes _ScreenUnits. - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = 0, - insertofftime: int = 300, - insertontime: int = 600, - insertwidth: _ScreenUnits = 2, - name: str = ..., - offset=..., # undocumented - relief: _Relief = "flat", - # Setting scrollregion to None doesn't reset it back to empty, - # but setting it to () does. - scrollregion: tuple[_ScreenUnits, _ScreenUnits, _ScreenUnits, _ScreenUnits] | tuple[()] = (), - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = 1, - selectforeground: str = ..., - # man page says that state can be 'hidden', but it can't - state: Literal["normal", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - width: _ScreenUnits = ..., - xscrollcommand: _XYScrollCommand = "", - xscrollincrement: _ScreenUnits = 0, - yscrollcommand: _XYScrollCommand = "", - yscrollincrement: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - closeenough: float = ..., - confine: bool = ..., - cursor: _Cursor = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = ..., - insertofftime: int = ..., - insertontime: int = ..., - insertwidth: _ScreenUnits = ..., - offset=..., # undocumented - relief: _Relief = ..., - scrollregion: tuple[_ScreenUnits, _ScreenUnits, _ScreenUnits, _ScreenUnits] | tuple[()] = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - state: Literal["normal", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - width: _ScreenUnits = ..., - xscrollcommand: _XYScrollCommand = ..., - xscrollincrement: _ScreenUnits = ..., - yscrollcommand: _XYScrollCommand = ..., - yscrollincrement: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def addtag(self, *args): ... # internal method - def addtag_above(self, newtag: str, tagOrId: str | int) -> None: ... - def addtag_all(self, newtag: str) -> None: ... - def addtag_below(self, newtag: str, tagOrId: str | int) -> None: ... - def addtag_closest( - self, newtag: str, x: _ScreenUnits, y: _ScreenUnits, halo: _ScreenUnits | None = None, start: str | int | None = None - ) -> None: ... - def addtag_enclosed(self, newtag: str, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> None: ... - def addtag_overlapping(self, newtag: str, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> None: ... - def addtag_withtag(self, newtag: str, tagOrId: str | int) -> None: ... - def find(self, *args): ... # internal method - def find_above(self, tagOrId: str | int) -> tuple[int, ...]: ... - def find_all(self) -> tuple[int, ...]: ... - def find_below(self, tagOrId: str | int) -> tuple[int, ...]: ... - def find_closest( - self, x: _ScreenUnits, y: _ScreenUnits, halo: _ScreenUnits | None = None, start: str | int | None = None - ) -> tuple[int, ...]: ... - def find_enclosed(self, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> tuple[int, ...]: ... - def find_overlapping(self, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: float) -> tuple[int, ...]: ... - def find_withtag(self, tagOrId: str | int) -> tuple[int, ...]: ... - # Incompatible with Misc.bbox(), tkinter violates LSP - def bbox(self, *args: str | int) -> tuple[int, int, int, int]: ... # type: ignore[override] - @overload - def tag_bind( - self, - tagOrId: str | int, - sequence: str | None = None, - func: Callable[[Event[Canvas]], object] | None = None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def tag_bind( - self, tagOrId: str | int, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None - ) -> None: ... - @overload - def tag_bind(self, tagOrId: str | int, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - def tag_unbind(self, tagOrId: str | int, sequence: str, funcid: str | None = None) -> None: ... - def canvasx(self, screenx, gridspacing: Incomplete | None = None): ... - def canvasy(self, screeny, gridspacing: Incomplete | None = None): ... - @overload - def coords(self, tagOrId: str | int, /) -> list[float]: ... - @overload - def coords(self, tagOrId: str | int, args: list[int] | list[float] | tuple[float, ...], /) -> None: ... - @overload - def coords(self, tagOrId: str | int, x1: float, y1: float, /, *args: float) -> None: ... - # create_foo() methods accept coords as a list or tuple, or as separate arguments. - # Lists and tuples can be flat as in [1, 2, 3, 4], or nested as in [(1, 2), (3, 4)]. - # Keyword arguments should be the same in all overloads of each method. - def create_arc(self, *args, **kw) -> int: ... - def create_bitmap(self, *args, **kw) -> int: ... - def create_image(self, *args, **kw) -> int: ... - @overload - def create_line( - self, - x0: float, - y0: float, - x1: float, - y1: float, - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - arrow: Literal["first", "last", "both"] = ..., - arrowshape: tuple[float, float, float] = ..., - capstyle: Literal["round", "projecting", "butt"] = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_line( - self, - xy_pair_0: tuple[float, float], - xy_pair_1: tuple[float, float], - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - arrow: Literal["first", "last", "both"] = ..., - arrowshape: tuple[float, float, float] = ..., - capstyle: Literal["round", "projecting", "butt"] = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_line( - self, - coords: ( - tuple[float, float, float, float] - | tuple[tuple[float, float], tuple[float, float]] - | list[int] - | list[float] - | list[tuple[int, int]] - | list[tuple[float, float]] - ), - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - arrow: Literal["first", "last", "both"] = ..., - arrowshape: tuple[float, float, float] = ..., - capstyle: Literal["round", "projecting", "butt"] = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_oval( - self, - x0: float, - y0: float, - x1: float, - y1: float, - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_oval( - self, - xy_pair_0: tuple[float, float], - xy_pair_1: tuple[float, float], - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_oval( - self, - coords: ( - tuple[float, float, float, float] - | tuple[tuple[float, float], tuple[float, float]] - | list[int] - | list[float] - | list[tuple[int, int]] - | list[tuple[float, float]] - ), - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_polygon( - self, - x0: float, - y0: float, - x1: float, - y1: float, - /, - *xy_pairs: float, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_polygon( - self, - xy_pair_0: tuple[float, float], - xy_pair_1: tuple[float, float], - /, - *xy_pairs: tuple[float, float], - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_polygon( - self, - coords: ( - tuple[float, ...] - | tuple[tuple[float, float], ...] - | list[int] - | list[float] - | list[tuple[int, int]] - | list[tuple[float, float]] - ), - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - joinstyle: Literal["round", "bevel", "miter"] = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - smooth: bool = ..., - splinesteps: float = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_rectangle( - self, - x0: float, - y0: float, - x1: float, - y1: float, - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_rectangle( - self, - xy_pair_0: tuple[float, float], - xy_pair_1: tuple[float, float], - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_rectangle( - self, - coords: ( - tuple[float, float, float, float] - | tuple[tuple[float, float], tuple[float, float]] - | list[int] - | list[float] - | list[tuple[int, int]] - | list[tuple[float, float]] - ), - /, - *, - activedash: str | int | list[int] | tuple[int, ...] = ..., - activefill: str = ..., - activeoutline: str = ..., - activeoutlinestipple: str = ..., - activestipple: str = ..., - activewidth: _ScreenUnits = ..., - dash: str | int | list[int] | tuple[int, ...] = ..., - dashoffset: _ScreenUnits = ..., - disableddash: str | int | list[int] | tuple[int, ...] = ..., - disabledfill: str = ..., - disabledoutline: str = ..., - disabledoutlinestipple: str = ..., - disabledstipple: str = ..., - disabledwidth: _ScreenUnits = ..., - fill: str = ..., - offset: _ScreenUnits = ..., - outline: str = ..., - outlineoffset: _ScreenUnits = ..., - outlinestipple: str = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_text( - self, - x: float, - y: float, - /, - *, - activefill: str = ..., - activestipple: str = ..., - anchor: _Anchor = ..., - angle: float | str = ..., - disabledfill: str = ..., - disabledstipple: str = ..., - fill: str = ..., - font: _FontDescription = ..., - justify: Literal["left", "center", "right"] = ..., - offset: _ScreenUnits = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - text: float | str = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_text( - self, - coords: tuple[float, float] | list[int] | list[float], - /, - *, - activefill: str = ..., - activestipple: str = ..., - anchor: _Anchor = ..., - angle: float | str = ..., - disabledfill: str = ..., - disabledstipple: str = ..., - fill: str = ..., - font: _FontDescription = ..., - justify: Literal["left", "center", "right"] = ..., - offset: _ScreenUnits = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - stipple: str = ..., - tags: str | list[str] | tuple[str, ...] = ..., - text: float | str = ..., - width: _ScreenUnits = ..., - ) -> int: ... - @overload - def create_window( - self, - x: float, - y: float, - /, - *, - anchor: _Anchor = ..., - height: _ScreenUnits = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - window: Widget = ..., - ) -> int: ... - @overload - def create_window( - self, - coords: tuple[float, float] | list[int] | list[float], - /, - *, - anchor: _Anchor = ..., - height: _ScreenUnits = ..., - state: Literal["normal", "hidden", "disabled"] = ..., - tags: str | list[str] | tuple[str, ...] = ..., - width: _ScreenUnits = ..., - window: Widget = ..., - ) -> int: ... - def dchars(self, *args) -> None: ... - def delete(self, *tagsOrCanvasIds: str | int) -> None: ... - @overload - def dtag(self, tag: str, tag_to_delete: str | None = ..., /) -> None: ... - @overload - def dtag(self, id: int, tag_to_delete: str, /) -> None: ... - def focus(self, *args): ... - def gettags(self, tagOrId: str | int, /) -> tuple[str, ...]: ... - def icursor(self, *args) -> None: ... - def index(self, *args): ... - def insert(self, *args) -> None: ... - def itemcget(self, tagOrId, option): ... - # itemconfigure kwargs depend on item type, which is not known when type checking - def itemconfigure( - self, tagOrId: str | int, cnf: dict[str, Any] | None = None, **kw: Any - ) -> dict[str, tuple[str, str, str, str, str]] | None: ... - itemconfig = itemconfigure - def move(self, *args) -> None: ... - def moveto(self, tagOrId: str | int, x: Literal[""] | float = "", y: Literal[""] | float = "") -> None: ... - def postscript(self, cnf={}, **kw): ... - # tkinter does: - # lower = tag_lower - # lift = tkraise = tag_raise - # - # But mypy doesn't like aliasing here (maybe because Misc defines the same names) - def tag_lower(self, first: str | int, second: str | int | None = ..., /) -> None: ... - def lower(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] - def tag_raise(self, first: str | int, second: str | int | None = ..., /) -> None: ... - def tkraise(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] - def lift(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] - def scale( - self, tagOrId: str | int, xOrigin: _ScreenUnits, yOrigin: _ScreenUnits, xScale: float, yScale: float, / - ) -> None: ... - def scan_mark(self, x, y) -> None: ... - def scan_dragto(self, x, y, gain: int = 10) -> None: ... - def select_adjust(self, tagOrId, index) -> None: ... - def select_clear(self) -> None: ... - def select_from(self, tagOrId, index) -> None: ... - def select_item(self): ... - def select_to(self, tagOrId, index) -> None: ... - def type(self, tagOrId: str | int) -> int | None: ... - -class Checkbutton(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = "center", - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = "", - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = "", - compound: _Compound = "none", - cursor: _Cursor = "", - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 1, - image: _ImageSpec = "", - indicatoron: bool = True, - justify: Literal["left", "center", "right"] = "center", - name: str = ..., - offrelief: _Relief = ..., - # The checkbutton puts a value to its variable when it's checked or - # unchecked. We don't restrict the type of that value here, so - # Any-typing is fine. - # - # I think Checkbutton shouldn't be generic, because then specifying - # "any checkbutton regardless of what variable it uses" would be - # difficult, and we might run into issues just like how list[float] - # and list[int] are incompatible. Also, we would need a way to - # specify "Checkbutton not associated with any variable", which is - # done by setting variable to empty string (the default). - offvalue: Any = 0, - onvalue: Any = 1, - overrelief: _Relief | Literal[""] = "", - padx: _ScreenUnits = 1, - pady: _ScreenUnits = 1, - relief: _Relief = "flat", - selectcolor: str = ..., - selectimage: _ImageSpec = "", - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - text: float | str = "", - textvariable: Variable = ..., - tristateimage: _ImageSpec = "", - tristatevalue: Any = "", - underline: int = -1, - variable: Variable | Literal[""] = ..., - width: _ScreenUnits = 0, - wraplength: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = ..., - compound: _Compound = ..., - cursor: _Cursor = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - justify: Literal["left", "center", "right"] = ..., - offrelief: _Relief = ..., - offvalue: Any = ..., - onvalue: Any = ..., - overrelief: _Relief | Literal[""] = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - tristateimage: _ImageSpec = ..., - tristatevalue: Any = ..., - underline: int = ..., - variable: Variable | Literal[""] = ..., - width: _ScreenUnits = ..., - wraplength: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def deselect(self) -> None: ... - def flash(self) -> None: ... - def invoke(self) -> Any: ... - def select(self) -> None: ... - def toggle(self) -> None: ... - -class Entry(Widget, XView): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = "xterm", - disabledbackground: str = ..., - disabledforeground: str = ..., - exportselection: bool = True, - fg: str = ..., - font: _FontDescription = "TkTextFont", - foreground: str = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = 0, - insertofftime: int = 300, - insertontime: int = 600, - insertwidth: _ScreenUnits = ..., - invalidcommand: _EntryValidateCommand = "", - invcmd: _EntryValidateCommand = "", # same as invalidcommand - justify: Literal["left", "center", "right"] = "left", - name: str = ..., - readonlybackground: str = ..., - relief: _Relief = "sunken", - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - show: str = "", - state: Literal["normal", "disabled", "readonly"] = "normal", - takefocus: _TakeFocusValue = "", - textvariable: Variable = ..., - validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = "none", - validatecommand: _EntryValidateCommand = "", - vcmd: _EntryValidateCommand = "", # same as validatecommand - width: int = 20, - xscrollcommand: _XYScrollCommand = "", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - disabledbackground: str = ..., - disabledforeground: str = ..., - exportselection: bool = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = ..., - insertofftime: int = ..., - insertontime: int = ..., - insertwidth: _ScreenUnits = ..., - invalidcommand: _EntryValidateCommand = ..., - invcmd: _EntryValidateCommand = ..., - justify: Literal["left", "center", "right"] = ..., - readonlybackground: str = ..., - relief: _Relief = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - show: str = ..., - state: Literal["normal", "disabled", "readonly"] = ..., - takefocus: _TakeFocusValue = ..., - textvariable: Variable = ..., - validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = ..., - validatecommand: _EntryValidateCommand = ..., - vcmd: _EntryValidateCommand = ..., - width: int = ..., - xscrollcommand: _XYScrollCommand = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def delete(self, first: str | int, last: str | int | None = None) -> None: ... - def get(self) -> str: ... - def icursor(self, index: str | int) -> None: ... - def index(self, index: str | int) -> int: ... - def insert(self, index: str | int, string: str) -> None: ... - def scan_mark(self, x) -> None: ... - def scan_dragto(self, x) -> None: ... - def selection_adjust(self, index: str | int) -> None: ... - def selection_clear(self) -> None: ... # type: ignore[override] - def selection_from(self, index: str | int) -> None: ... - def selection_present(self) -> bool: ... - def selection_range(self, start: str | int, end: str | int) -> None: ... - def selection_to(self, index: str | int) -> None: ... - select_adjust = selection_adjust - select_clear = selection_clear - select_from = selection_from - select_present = selection_present - select_range = selection_range - select_to = selection_to - -class Frame(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = 0, - bg: str = ..., - border: _ScreenUnits = 0, - borderwidth: _ScreenUnits = 0, - class_: str = "Frame", # can't be changed with configure() - colormap: Literal["new", ""] | Misc = "", # can't be changed with configure() - container: bool = False, # can't be changed with configure() - cursor: _Cursor = "", - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - name: str = ..., - padx: _ScreenUnits = 0, - pady: _ScreenUnits = 0, - relief: _Relief = "flat", - takefocus: _TakeFocusValue = 0, - visual: str | tuple[str, int] = "", # can't be changed with configure() - width: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - takefocus: _TakeFocusValue = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class Label(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = "center", - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = "", - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - compound: _Compound = "none", - cursor: _Cursor = "", - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - image: _ImageSpec = "", - justify: Literal["left", "center", "right"] = "center", - name: str = ..., - padx: _ScreenUnits = 1, - pady: _ScreenUnits = 1, - relief: _Relief = "flat", - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = 0, - text: float | str = "", - textvariable: Variable = ..., - underline: int = -1, - width: _ScreenUnits = 0, - wraplength: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - compound: _Compound = ..., - cursor: _Cursor = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - image: _ImageSpec = ..., - justify: Literal["left", "center", "right"] = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - underline: int = ..., - width: _ScreenUnits = ..., - wraplength: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class Listbox(Widget, XView, YView): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activestyle: Literal["dotbox", "none", "underline"] = ..., - background: str = ..., - bd: _ScreenUnits = 1, - bg: str = ..., - border: _ScreenUnits = 1, - borderwidth: _ScreenUnits = 1, - cursor: _Cursor = "", - disabledforeground: str = ..., - exportselection: bool | Literal[0, 1] = 1, - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: int = 10, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - justify: Literal["left", "center", "right"] = "left", - # There's no tkinter.ListVar, but seems like bare tkinter.Variable - # actually works for this: - # - # >>> import tkinter - # >>> lb = tkinter.Listbox() - # >>> var = lb['listvariable'] = tkinter.Variable() - # >>> var.set(['foo', 'bar', 'baz']) - # >>> lb.get(0, 'end') - # ('foo', 'bar', 'baz') - listvariable: Variable = ..., - name: str = ..., - relief: _Relief = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = 0, - selectforeground: str = ..., - # from listbox man page: "The value of the [selectmode] option may be - # arbitrary, but the default bindings expect it to be either single, - # browse, multiple, or extended" - # - # I have never seen anyone setting this to something else than what - # "the default bindings expect", but let's support it anyway. - selectmode: str | Literal["single", "browse", "multiple", "extended"] = "browse", # noqa: Y051 - setgrid: bool = False, - state: Literal["normal", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - width: int = 20, - xscrollcommand: _XYScrollCommand = "", - yscrollcommand: _XYScrollCommand = "", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activestyle: Literal["dotbox", "none", "underline"] = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - disabledforeground: str = ..., - exportselection: bool = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: int = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - justify: Literal["left", "center", "right"] = ..., - listvariable: Variable = ..., - relief: _Relief = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - selectmode: str | Literal["single", "browse", "multiple", "extended"] = ..., # noqa: Y051 - setgrid: bool = ..., - state: Literal["normal", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - width: int = ..., - xscrollcommand: _XYScrollCommand = ..., - yscrollcommand: _XYScrollCommand = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def activate(self, index: str | int) -> None: ... - def bbox(self, index: str | int) -> tuple[int, int, int, int] | None: ... # type: ignore[override] - def curselection(self): ... - def delete(self, first: str | int, last: str | int | None = None) -> None: ... - def get(self, first: str | int, last: str | int | None = None): ... - def index(self, index: str | int) -> int: ... - def insert(self, index: str | int, *elements: str | float) -> None: ... - def nearest(self, y): ... - def scan_mark(self, x, y) -> None: ... - def scan_dragto(self, x, y) -> None: ... - def see(self, index: str | int) -> None: ... - def selection_anchor(self, index: str | int) -> None: ... - select_anchor = selection_anchor - def selection_clear(self, first: str | int, last: str | int | None = None) -> None: ... # type: ignore[override] - select_clear = selection_clear - def selection_includes(self, index: str | int): ... - select_includes = selection_includes - def selection_set(self, first: str | int, last: str | int | None = None) -> None: ... - select_set = selection_set - def size(self) -> int: ... # type: ignore[override] - def itemcget(self, index: str | int, option): ... - def itemconfigure(self, index: str | int, cnf: Incomplete | None = None, **kw): ... - itemconfig = itemconfigure - -class Menu(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeborderwidth: _ScreenUnits = ..., - activeforeground: str = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = "arrow", - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - name: str = ..., - postcommand: Callable[[], object] | str = "", - relief: _Relief = ..., - selectcolor: str = ..., - takefocus: _TakeFocusValue = 0, - tearoff: bool | Literal[0, 1] = 1, - # I guess tearoffcommand arguments are supposed to be widget objects, - # but they are widget name strings. Use nametowidget() to handle the - # arguments of tearoffcommand. - tearoffcommand: Callable[[str, str], object] | str = "", - title: str = "", - type: Literal["menubar", "tearoff", "normal"] = "normal", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeborderwidth: _ScreenUnits = ..., - activeforeground: str = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - postcommand: Callable[[], object] | str = ..., - relief: _Relief = ..., - selectcolor: str = ..., - takefocus: _TakeFocusValue = ..., - tearoff: bool = ..., - tearoffcommand: Callable[[str, str], object] | str = ..., - title: str = ..., - type: Literal["menubar", "tearoff", "normal"] = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def tk_popup(self, x: int, y: int, entry: str | int = "") -> None: ... - def activate(self, index: str | int) -> None: ... - def add(self, itemType, cnf={}, **kw): ... # docstring says "Internal function." - def insert(self, index, itemType, cnf={}, **kw): ... # docstring says "Internal function." - def add_cascade( - self, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - label: str = ..., - menu: Menu = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - ) -> None: ... - def add_checkbutton( - self, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - label: str = ..., - offvalue: Any = ..., - onvalue: Any = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - variable: Variable = ..., - ) -> None: ... - def add_command( - self, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - label: str = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - ) -> None: ... - def add_radiobutton( - self, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - label: str = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - value: Any = ..., - variable: Variable = ..., - ) -> None: ... - def add_separator(self, cnf: dict[str, Any] | None = {}, *, background: str = ...) -> None: ... - def insert_cascade( - self, - index: str | int, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - label: str = ..., - menu: Menu = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - ) -> None: ... - def insert_checkbutton( - self, - index: str | int, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - label: str = ..., - offvalue: Any = ..., - onvalue: Any = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - variable: Variable = ..., - ) -> None: ... - def insert_command( - self, - index: str | int, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - label: str = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - ) -> None: ... - def insert_radiobutton( - self, - index: str | int, - cnf: dict[str, Any] | None = {}, - *, - accelerator: str = ..., - activebackground: str = ..., - activeforeground: str = ..., - background: str = ..., - bitmap: str = ..., - columnbreak: int = ..., - command: Callable[[], object] | str = ..., - compound: _Compound = ..., - font: _FontDescription = ..., - foreground: str = ..., - hidemargin: bool = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - label: str = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - underline: int = ..., - value: Any = ..., - variable: Variable = ..., - ) -> None: ... - def insert_separator(self, index: str | int, cnf: dict[str, Any] | None = {}, *, background: str = ...) -> None: ... - def delete(self, index1: str | int, index2: str | int | None = None) -> None: ... - def entrycget(self, index: str | int, option: str) -> Any: ... - def entryconfigure( - self, index: str | int, cnf: dict[str, Any] | None = None, **kw: Any - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - entryconfig = entryconfigure - def index(self, index: str | int) -> int | None: ... - def invoke(self, index: str | int) -> Any: ... - def post(self, x: int, y: int) -> None: ... - def type(self, index: str | int) -> Literal["cascade", "checkbutton", "command", "radiobutton", "separator"]: ... - def unpost(self) -> None: ... - def xposition(self, index: str | int) -> int: ... - def yposition(self, index: str | int) -> int: ... - -class Menubutton(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = "", - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - compound: _Compound = "none", - cursor: _Cursor = "", - direction: Literal["above", "below", "left", "right", "flush"] = "below", - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - image: _ImageSpec = "", - indicatoron: bool = ..., - justify: Literal["left", "center", "right"] = ..., - menu: Menu = ..., - name: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = "flat", - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = 0, - text: float | str = "", - textvariable: Variable = ..., - underline: int = -1, - width: _ScreenUnits = 0, - wraplength: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - compound: _Compound = ..., - cursor: _Cursor = ..., - direction: Literal["above", "below", "left", "right", "flush"] = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - justify: Literal["left", "center", "right"] = ..., - menu: Menu = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - underline: int = ..., - width: _ScreenUnits = ..., - wraplength: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class Message(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - anchor: _Anchor = "center", - aspect: int = 150, - background: str = ..., - bd: _ScreenUnits = 1, - bg: str = ..., - border: _ScreenUnits = 1, - borderwidth: _ScreenUnits = 1, - cursor: _Cursor = "", - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - justify: Literal["left", "center", "right"] = "left", - name: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = "flat", - takefocus: _TakeFocusValue = 0, - text: float | str = "", - textvariable: Variable = ..., - # there's width but no height - width: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - anchor: _Anchor = ..., - aspect: int = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - justify: Literal["left", "center", "right"] = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class Radiobutton(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = "center", - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = "", - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = "", - compound: _Compound = "none", - cursor: _Cursor = "", - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 1, - image: _ImageSpec = "", - indicatoron: bool = True, - justify: Literal["left", "center", "right"] = "center", - name: str = ..., - offrelief: _Relief = ..., - overrelief: _Relief | Literal[""] = "", - padx: _ScreenUnits = 1, - pady: _ScreenUnits = 1, - relief: _Relief = "flat", - selectcolor: str = ..., - selectimage: _ImageSpec = "", - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - text: float | str = "", - textvariable: Variable = ..., - tristateimage: _ImageSpec = "", - tristatevalue: Any = "", - underline: int = -1, - value: Any = "", - variable: Variable | Literal[""] = ..., - width: _ScreenUnits = 0, - wraplength: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activeforeground: str = ..., - anchor: _Anchor = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bitmap: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: _ButtonCommand = ..., - compound: _Compound = ..., - cursor: _Cursor = ..., - disabledforeground: str = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - image: _ImageSpec = ..., - indicatoron: bool = ..., - justify: Literal["left", "center", "right"] = ..., - offrelief: _Relief = ..., - overrelief: _Relief | Literal[""] = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - selectcolor: str = ..., - selectimage: _ImageSpec = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - textvariable: Variable = ..., - tristateimage: _ImageSpec = ..., - tristatevalue: Any = ..., - underline: int = ..., - value: Any = ..., - variable: Variable | Literal[""] = ..., - width: _ScreenUnits = ..., - wraplength: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def deselect(self) -> None: ... - def flash(self) -> None: ... - def invoke(self) -> Any: ... - def select(self) -> None: ... - -class Scale(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - background: str = ..., - bd: _ScreenUnits = 1, - bg: str = ..., - bigincrement: float = 0.0, - border: _ScreenUnits = 1, - borderwidth: _ScreenUnits = 1, - # don't know why the callback gets string instead of float - command: str | Callable[[str], object] = "", - cursor: _Cursor = "", - digits: int = 0, - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - from_: float = 0.0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - label: str = "", - length: _ScreenUnits = 100, - name: str = ..., - orient: Literal["horizontal", "vertical"] = "vertical", - relief: _Relief = "flat", - repeatdelay: int = 300, - repeatinterval: int = 100, - resolution: float = 1.0, - showvalue: bool = True, - sliderlength: _ScreenUnits = 30, - sliderrelief: _Relief = "raised", - state: Literal["normal", "active", "disabled"] = "normal", - takefocus: _TakeFocusValue = "", - tickinterval: float = 0.0, - to: float = 100.0, - troughcolor: str = ..., - variable: IntVar | DoubleVar = ..., - width: _ScreenUnits = 15, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - bigincrement: float = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: str | Callable[[str], object] = ..., - cursor: _Cursor = ..., - digits: int = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - from_: float = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - label: str = ..., - length: _ScreenUnits = ..., - orient: Literal["horizontal", "vertical"] = ..., - relief: _Relief = ..., - repeatdelay: int = ..., - repeatinterval: int = ..., - resolution: float = ..., - showvalue: bool = ..., - sliderlength: _ScreenUnits = ..., - sliderrelief: _Relief = ..., - state: Literal["normal", "active", "disabled"] = ..., - takefocus: _TakeFocusValue = ..., - tickinterval: float = ..., - to: float = ..., - troughcolor: str = ..., - variable: IntVar | DoubleVar = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def get(self) -> float: ... - def set(self, value) -> None: ... - def coords(self, value: float | None = None) -> tuple[int, int]: ... - def identify(self, x, y) -> Literal["", "slider", "trough1", "trough2"]: ... - -class Scrollbar(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - activerelief: _Relief = "raised", - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - # There are many ways how the command may get called. Search for - # 'SCROLLING COMMANDS' in scrollbar man page. There doesn't seem to - # be any way to specify an overloaded callback function, so we say - # that it can take any args while it can't in reality. - command: Callable[..., tuple[float, float] | None] | str = "", - cursor: _Cursor = "", - elementborderwidth: _ScreenUnits = -1, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - jump: bool = False, - name: str = ..., - orient: Literal["horizontal", "vertical"] = "vertical", - relief: _Relief = ..., - repeatdelay: int = 300, - repeatinterval: int = 100, - takefocus: _TakeFocusValue = "", - troughcolor: str = ..., - width: _ScreenUnits = ..., - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - activerelief: _Relief = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - command: Callable[..., tuple[float, float] | None] | str = ..., - cursor: _Cursor = ..., - elementborderwidth: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - jump: bool = ..., - orient: Literal["horizontal", "vertical"] = ..., - relief: _Relief = ..., - repeatdelay: int = ..., - repeatinterval: int = ..., - takefocus: _TakeFocusValue = ..., - troughcolor: str = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def activate(self, index: Incomplete | None = None): ... - def delta(self, deltax: int, deltay: int) -> float: ... - def fraction(self, x: int, y: int) -> float: ... - def identify(self, x: int, y: int) -> Literal["arrow1", "arrow2", "slider", "trough1", "trough2", ""]: ... - def get(self) -> tuple[float, float, float, float] | tuple[float, float]: ... - def set(self, first: float | str, last: float | str) -> None: ... - -_TextIndex: TypeAlias = _tkinter.Tcl_Obj | str | float | Misc -_WhatToCount: TypeAlias = Literal[ - "chars", "displaychars", "displayindices", "displaylines", "indices", "lines", "xpixels", "ypixels" -] - -class Text(Widget, XView, YView): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - autoseparators: bool = True, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - blockcursor: bool = False, - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = "xterm", - endline: int | Literal[""] = "", - exportselection: bool = True, - fg: str = ..., - font: _FontDescription = "TkFixedFont", - foreground: str = ..., - # width is always int, but height is allowed to be ScreenUnits. - # This doesn't make any sense to me, and this isn't documented. - # The docs seem to say that both should be integers. - height: _ScreenUnits = 24, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - inactiveselectbackground: str = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = 0, - insertofftime: int = 300, - insertontime: int = 600, - insertunfocussed: Literal["none", "hollow", "solid"] = "none", - insertwidth: _ScreenUnits = ..., - maxundo: int = 0, - name: str = ..., - padx: _ScreenUnits = 1, - pady: _ScreenUnits = 1, - relief: _Relief = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - setgrid: bool = False, - spacing1: _ScreenUnits = 0, - spacing2: _ScreenUnits = 0, - spacing3: _ScreenUnits = 0, - startline: int | Literal[""] = "", - state: Literal["normal", "disabled"] = "normal", - # Literal inside Tuple doesn't actually work - tabs: _ScreenUnits | str | tuple[_ScreenUnits | str, ...] = "", - tabstyle: Literal["tabular", "wordprocessor"] = "tabular", - takefocus: _TakeFocusValue = "", - undo: bool = False, - width: int = 80, - wrap: Literal["none", "char", "word"] = "char", - xscrollcommand: _XYScrollCommand = "", - yscrollcommand: _XYScrollCommand = "", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - autoseparators: bool = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - blockcursor: bool = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - endline: int | Literal[""] = ..., - exportselection: bool = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - inactiveselectbackground: str = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = ..., - insertofftime: int = ..., - insertontime: int = ..., - insertunfocussed: Literal["none", "hollow", "solid"] = ..., - insertwidth: _ScreenUnits = ..., - maxundo: int = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - setgrid: bool = ..., - spacing1: _ScreenUnits = ..., - spacing2: _ScreenUnits = ..., - spacing3: _ScreenUnits = ..., - startline: int | Literal[""] = ..., - state: Literal["normal", "disabled"] = ..., - tabs: _ScreenUnits | str | tuple[_ScreenUnits | str, ...] = ..., - tabstyle: Literal["tabular", "wordprocessor"] = ..., - takefocus: _TakeFocusValue = ..., - undo: bool = ..., - width: int = ..., - wrap: Literal["none", "char", "word"] = ..., - xscrollcommand: _XYScrollCommand = ..., - yscrollcommand: _XYScrollCommand = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def bbox(self, index: _TextIndex) -> tuple[int, int, int, int] | None: ... # type: ignore[override] - def compare(self, index1: _TextIndex, op: Literal["<", "<=", "==", ">=", ">", "!="], index2: _TextIndex) -> bool: ... - if sys.version_info >= (3, 13): - @overload - def count(self, index1: _TextIndex, index2: _TextIndex, *, return_ints: Literal[True]) -> int: ... - @overload - def count( - self, index1: _TextIndex, index2: _TextIndex, arg: _WhatToCount | Literal["update"], /, *, return_ints: Literal[True] - ) -> int: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: Literal["update"], - arg2: _WhatToCount, - /, - *, - return_ints: Literal[True], - ) -> int: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount, - arg2: Literal["update"], - /, - *, - return_ints: Literal[True], - ) -> int: ... - @overload - def count( - self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: _WhatToCount, /, *, return_ints: Literal[True] - ) -> tuple[int, int]: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount | Literal["update"], - arg2: _WhatToCount | Literal["update"], - arg3: _WhatToCount | Literal["update"], - /, - *args: _WhatToCount | Literal["update"], - return_ints: Literal[True], - ) -> tuple[int, ...]: ... - @overload - def count(self, index1: _TextIndex, index2: _TextIndex, *, return_ints: Literal[False] = False) -> tuple[int] | None: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg: _WhatToCount | Literal["update"], - /, - *, - return_ints: Literal[False] = False, - ) -> tuple[int] | None: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: Literal["update"], - arg2: _WhatToCount, - /, - *, - return_ints: Literal[False] = False, - ) -> int | None: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount, - arg2: Literal["update"], - /, - *, - return_ints: Literal[False] = False, - ) -> int | None: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount, - arg2: _WhatToCount, - /, - *, - return_ints: Literal[False] = False, - ) -> tuple[int, int]: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount | Literal["update"], - arg2: _WhatToCount | Literal["update"], - arg3: _WhatToCount | Literal["update"], - /, - *args: _WhatToCount | Literal["update"], - return_ints: Literal[False] = False, - ) -> tuple[int, ...]: ... - else: - @overload - def count(self, index1: _TextIndex, index2: _TextIndex) -> tuple[int] | None: ... - @overload - def count( - self, index1: _TextIndex, index2: _TextIndex, arg: _WhatToCount | Literal["update"], / - ) -> tuple[int] | None: ... - @overload - def count(self, index1: _TextIndex, index2: _TextIndex, arg1: Literal["update"], arg2: _WhatToCount, /) -> int | None: ... - @overload - def count(self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: Literal["update"], /) -> int | None: ... - @overload - def count(self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: _WhatToCount, /) -> tuple[int, int]: ... - @overload - def count( - self, - index1: _TextIndex, - index2: _TextIndex, - arg1: _WhatToCount | Literal["update"], - arg2: _WhatToCount | Literal["update"], - arg3: _WhatToCount | Literal["update"], - /, - *args: _WhatToCount | Literal["update"], - ) -> tuple[int, ...]: ... - - @overload - def debug(self, boolean: None = None) -> bool: ... - @overload - def debug(self, boolean: bool) -> None: ... - def delete(self, index1: _TextIndex, index2: _TextIndex | None = None) -> None: ... - def dlineinfo(self, index: _TextIndex) -> tuple[int, int, int, int, int] | None: ... - @overload - def dump( - self, - index1: _TextIndex, - index2: _TextIndex | None = None, - command: None = None, - *, - all: bool = ..., - image: bool = ..., - mark: bool = ..., - tag: bool = ..., - text: bool = ..., - window: bool = ..., - ) -> list[tuple[str, str, str]]: ... - @overload - def dump( - self, - index1: _TextIndex, - index2: _TextIndex | None, - command: Callable[[str, str, str], object] | str, - *, - all: bool = ..., - image: bool = ..., - mark: bool = ..., - tag: bool = ..., - text: bool = ..., - window: bool = ..., - ) -> None: ... - @overload - def dump( - self, - index1: _TextIndex, - index2: _TextIndex | None = None, - *, - command: Callable[[str, str, str], object] | str, - all: bool = ..., - image: bool = ..., - mark: bool = ..., - tag: bool = ..., - text: bool = ..., - window: bool = ..., - ) -> None: ... - def edit(self, *args): ... # docstring says "Internal method" - @overload - def edit_modified(self, arg: None = None) -> bool: ... # actually returns Literal[0, 1] - @overload - def edit_modified(self, arg: bool) -> None: ... # actually returns empty string - def edit_redo(self) -> None: ... # actually returns empty string - def edit_reset(self) -> None: ... # actually returns empty string - def edit_separator(self) -> None: ... # actually returns empty string - def edit_undo(self) -> None: ... # actually returns empty string - def get(self, index1: _TextIndex, index2: _TextIndex | None = None) -> str: ... - @overload - def image_cget(self, index: _TextIndex, option: Literal["image", "name"]) -> str: ... - @overload - def image_cget(self, index: _TextIndex, option: Literal["padx", "pady"]) -> int: ... - @overload - def image_cget(self, index: _TextIndex, option: Literal["align"]) -> Literal["baseline", "bottom", "center", "top"]: ... - @overload - def image_cget(self, index: _TextIndex, option: str) -> Any: ... - @overload - def image_configure(self, index: _TextIndex, cnf: str) -> tuple[str, str, str, str, str | int]: ... - @overload - def image_configure( - self, - index: _TextIndex, - cnf: dict[str, Any] | None = {}, - *, - align: Literal["baseline", "bottom", "center", "top"] = ..., - image: _ImageSpec = ..., - name: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, str, str | int]] | None: ... - def image_create( - self, - index: _TextIndex, - cnf: dict[str, Any] | None = {}, - *, - align: Literal["baseline", "bottom", "center", "top"] = ..., - image: _ImageSpec = ..., - name: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - ) -> str: ... - def image_names(self) -> tuple[str, ...]: ... - def index(self, index: _TextIndex) -> str: ... - def insert(self, index: _TextIndex, chars: str, *args: str | list[str] | tuple[str, ...]) -> None: ... - @overload - def mark_gravity(self, markName: str, direction: None = None) -> Literal["left", "right"]: ... - @overload - def mark_gravity(self, markName: str, direction: Literal["left", "right"]) -> None: ... # actually returns empty string - def mark_names(self) -> tuple[str, ...]: ... - def mark_set(self, markName: str, index: _TextIndex) -> None: ... - def mark_unset(self, *markNames: str) -> None: ... - def mark_next(self, index: _TextIndex) -> str | None: ... - def mark_previous(self, index: _TextIndex) -> str | None: ... - # **kw of peer_create is same as the kwargs of Text.__init__ - def peer_create(self, newPathName: str | Text, cnf: dict[str, Any] = {}, **kw) -> None: ... - def peer_names(self) -> tuple[_tkinter.Tcl_Obj, ...]: ... - def replace(self, index1: _TextIndex, index2: _TextIndex, chars: str, *args: str | list[str] | tuple[str, ...]) -> None: ... - def scan_mark(self, x: int, y: int) -> None: ... - def scan_dragto(self, x: int, y: int) -> None: ... - def search( - self, - pattern: str, - index: _TextIndex, - stopindex: _TextIndex | None = None, - forwards: bool | None = None, - backwards: bool | None = None, - exact: bool | None = None, - regexp: bool | None = None, - nocase: bool | None = None, - count: Variable | None = None, - elide: bool | None = None, - ) -> str: ... # returns empty string for not found - def see(self, index: _TextIndex) -> None: ... - def tag_add(self, tagName: str, index1: _TextIndex, *args: _TextIndex) -> None: ... - # tag_bind stuff is very similar to Canvas - @overload - def tag_bind( - self, - tagName: str, - sequence: str | None, - func: Callable[[Event[Text]], object] | None, - add: Literal["", "+"] | bool | None = None, - ) -> str: ... - @overload - def tag_bind(self, tagName: str, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... - def tag_unbind(self, tagName: str, sequence: str, funcid: str | None = None) -> None: ... - # allowing any string for cget instead of just Literals because there's no other way to look up tag options - def tag_cget(self, tagName: str, option: str): ... - @overload - def tag_configure( - self, - tagName: str, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bgstipple: str = ..., - borderwidth: _ScreenUnits = ..., - border: _ScreenUnits = ..., # alias for borderwidth - elide: bool = ..., - fgstipple: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - justify: Literal["left", "right", "center"] = ..., - lmargin1: _ScreenUnits = ..., - lmargin2: _ScreenUnits = ..., - lmargincolor: str = ..., - offset: _ScreenUnits = ..., - overstrike: bool = ..., - overstrikefg: str = ..., - relief: _Relief = ..., - rmargin: _ScreenUnits = ..., - rmargincolor: str = ..., - selectbackground: str = ..., - selectforeground: str = ..., - spacing1: _ScreenUnits = ..., - spacing2: _ScreenUnits = ..., - spacing3: _ScreenUnits = ..., - tabs: Any = ..., # the exact type is kind of complicated, see manual page - tabstyle: Literal["tabular", "wordprocessor"] = ..., - underline: bool = ..., - underlinefg: str = ..., - wrap: Literal["none", "char", "word"] = ..., # be careful with "none" vs None - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def tag_configure(self, tagName: str, cnf: str) -> tuple[str, str, str, Any, Any]: ... - tag_config = tag_configure - def tag_delete(self, first_tag_name: str, /, *tagNames: str) -> None: ... # error if no tag names given - def tag_lower(self, tagName: str, belowThis: str | None = None) -> None: ... - def tag_names(self, index: _TextIndex | None = None) -> tuple[str, ...]: ... - def tag_nextrange( - self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None - ) -> tuple[str, str] | tuple[()]: ... - def tag_prevrange( - self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None - ) -> tuple[str, str] | tuple[()]: ... - def tag_raise(self, tagName: str, aboveThis: str | None = None) -> None: ... - def tag_ranges(self, tagName: str) -> tuple[_tkinter.Tcl_Obj, ...]: ... - # tag_remove and tag_delete are different - def tag_remove(self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None) -> None: ... - @overload - def window_cget(self, index: _TextIndex, option: Literal["padx", "pady"]) -> int: ... - @overload - def window_cget(self, index: _TextIndex, option: Literal["stretch"]) -> bool: ... # actually returns Literal[0, 1] - @overload - def window_cget(self, index: _TextIndex, option: Literal["align"]) -> Literal["baseline", "bottom", "center", "top"]: ... - @overload # window is set to a widget, but read as the string name. - def window_cget(self, index: _TextIndex, option: Literal["create", "window"]) -> str: ... - @overload - def window_cget(self, index: _TextIndex, option: str) -> Any: ... - @overload - def window_configure(self, index: _TextIndex, cnf: str) -> tuple[str, str, str, str, str | int]: ... - @overload - def window_configure( - self, - index: _TextIndex, - cnf: dict[str, Any] | None = None, - *, - align: Literal["baseline", "bottom", "center", "top"] = ..., - create: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - stretch: bool | Literal[0, 1] = ..., - window: Misc | str = ..., - ) -> dict[str, tuple[str, str, str, str, str | int]] | None: ... - window_config = window_configure - def window_create( - self, - index: _TextIndex, - cnf: dict[str, Any] | None = {}, - *, - align: Literal["baseline", "bottom", "center", "top"] = ..., - create: str = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - stretch: bool | Literal[0, 1] = ..., - window: Misc | str = ..., - ) -> None: ... - def window_names(self) -> tuple[str, ...]: ... - def yview_pickplace(self, *what): ... # deprecated - -class _setit: - def __init__(self, var, value, callback: Incomplete | None = None) -> None: ... - def __call__(self, *args) -> None: ... - -# manual page: tk_optionMenu -class OptionMenu(Menubutton): - widgetName: Incomplete - menuname: Incomplete - def __init__( - # differs from other widgets - self, - master: Misc | None, - variable: StringVar, - value: str, - *values: str, - # kwarg only from now on - command: Callable[[StringVar], object] | None = ..., - ) -> None: ... - # configure, config, cget are inherited from Menubutton - # destroy and __getitem__ are overridden, signature does not change - -# Marker to indicate that it is a valid bitmap/photo image. PIL implements compatible versions -# which don't share a class hierarchy. The actual API is a __str__() which returns a valid name, -# not something that type checkers can detect. -@type_check_only -class _Image: ... - -@type_check_only -class _BitmapImageLike(_Image): ... - -@type_check_only -class _PhotoImageLike(_Image): ... - -class Image(_Image): - name: Incomplete - tk: _tkinter.TkappType - def __init__( - self, imgtype, name: Incomplete | None = None, cnf={}, master: Misc | _tkinter.TkappType | None = None, **kw - ) -> None: ... - def __del__(self) -> None: ... - def __setitem__(self, key, value) -> None: ... - def __getitem__(self, key): ... - configure: Incomplete - config: Incomplete - def height(self) -> int: ... - def type(self): ... - def width(self) -> int: ... - -class PhotoImage(Image, _PhotoImageLike): - # This should be kept in sync with PIL.ImageTK.PhotoImage.__init__() - def __init__( - self, - name: str | None = None, - cnf: dict[str, Any] = {}, - master: Misc | _tkinter.TkappType | None = None, - *, - data: str | bytes = ..., # not same as data argument of put() - format: str = ..., - file: StrOrBytesPath = ..., - gamma: float = ..., - height: int = ..., - palette: int | str = ..., - width: int = ..., - ) -> None: ... - def configure( - self, - *, - data: str | bytes = ..., - format: str = ..., - file: StrOrBytesPath = ..., - gamma: float = ..., - height: int = ..., - palette: int | str = ..., - width: int = ..., - ) -> None: ... - config = configure - def blank(self) -> None: ... - def cget(self, option: str) -> str: ... - def __getitem__(self, key: str) -> str: ... # always string: image['height'] can be '0' - if sys.version_info >= (3, 13): - def copy( - self, - *, - from_coords: Iterable[int] | None = None, - zoom: int | tuple[int, int] | list[int] | None = None, - subsample: int | tuple[int, int] | list[int] | None = None, - ) -> PhotoImage: ... - def subsample(self, x: int, y: Literal[""] = "", *, from_coords: Iterable[int] | None = None) -> PhotoImage: ... - def zoom(self, x: int, y: Literal[""] = "", *, from_coords: Iterable[int] | None = None) -> PhotoImage: ... - def copy_replace( - self, - sourceImage: PhotoImage | str, - *, - from_coords: Iterable[int] | None = None, - to: Iterable[int] | None = None, - shrink: bool = False, - zoom: int | tuple[int, int] | list[int] | None = None, - subsample: int | tuple[int, int] | list[int] | None = None, - # `None` defaults to overlay. - compositingrule: Literal["overlay", "set"] | None = None, - ) -> None: ... - else: - def copy(self) -> PhotoImage: ... - def zoom(self, x: int, y: int | Literal[""] = "") -> PhotoImage: ... - def subsample(self, x: int, y: int | Literal[""] = "") -> PhotoImage: ... - - def get(self, x: int, y: int) -> tuple[int, int, int]: ... - def put( - self, - data: ( - str - | list[str] - | list[list[str]] - | list[tuple[str, ...]] - | tuple[str, ...] - | tuple[list[str], ...] - | tuple[tuple[str, ...], ...] - ), - to: tuple[int, int] | None = None, - ) -> None: ... - if sys.version_info >= (3, 13): - def read( - self, - filename: StrOrBytesPath, - format: str | None = None, - *, - from_coords: Iterable[int] | None = None, - to: Iterable[int] | None = None, - shrink: bool = False, - ) -> None: ... - def write( - self, - filename: StrOrBytesPath, - format: str | None = None, - from_coords: Iterable[int] | None = None, - *, - background: str | None = None, - grayscale: bool = False, - ) -> None: ... - @overload - def data( - self, format: str, *, from_coords: Iterable[int] | None = None, background: str | None = None, grayscale: bool = False - ) -> bytes: ... - @overload - def data( - self, - format: None = None, - *, - from_coords: Iterable[int] | None = None, - background: str | None = None, - grayscale: bool = False, - ) -> tuple[str, ...]: ... - - else: - def write( - self, filename: StrOrBytesPath, format: str | None = None, from_coords: tuple[int, int] | None = None - ) -> None: ... - - def transparency_get(self, x: int, y: int) -> bool: ... - def transparency_set(self, x: int, y: int, boolean: bool) -> None: ... - -class BitmapImage(Image, _BitmapImageLike): - # This should be kept in sync with PIL.ImageTK.BitmapImage.__init__() - def __init__( - self, - name: Incomplete | None = None, - cnf: dict[str, Any] = {}, - master: Misc | _tkinter.TkappType | None = None, - *, - background: str = ..., - data: str | bytes = ..., - file: StrOrBytesPath = ..., - foreground: str = ..., - maskdata: str = ..., - maskfile: StrOrBytesPath = ..., - ) -> None: ... - -def image_names() -> tuple[str, ...]: ... -def image_types() -> tuple[str, ...]: ... - -class Spinbox(Widget, XView): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - activebackground: str = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - buttonbackground: str = ..., - buttoncursor: _Cursor = "", - buttondownrelief: _Relief = ..., - buttonuprelief: _Relief = ..., - # percent substitutions don't seem to be supported, it's similar to Entry's validation stuff - command: Callable[[], object] | str | list[str] | tuple[str, ...] = "", - cursor: _Cursor = "xterm", - disabledbackground: str = ..., - disabledforeground: str = ..., - exportselection: bool = True, - fg: str = ..., - font: _FontDescription = "TkTextFont", - foreground: str = ..., - format: str = "", - from_: float = 0.0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - increment: float = 1.0, - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = 0, - insertofftime: int = 300, - insertontime: int = 600, - insertwidth: _ScreenUnits = ..., - invalidcommand: _EntryValidateCommand = "", - invcmd: _EntryValidateCommand = "", - justify: Literal["left", "center", "right"] = "left", - name: str = ..., - readonlybackground: str = ..., - relief: _Relief = "sunken", - repeatdelay: int = 400, - repeatinterval: int = 100, - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - state: Literal["normal", "disabled", "readonly"] = "normal", - takefocus: _TakeFocusValue = "", - textvariable: Variable = ..., - to: float = 0.0, - validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = "none", - validatecommand: _EntryValidateCommand = "", - vcmd: _EntryValidateCommand = "", - values: list[str] | tuple[str, ...] = ..., - width: int = 20, - wrap: bool = False, - xscrollcommand: _XYScrollCommand = "", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - activebackground: str = ..., - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - buttonbackground: str = ..., - buttoncursor: _Cursor = ..., - buttondownrelief: _Relief = ..., - buttonuprelief: _Relief = ..., - command: Callable[[], object] | str | list[str] | tuple[str, ...] = ..., - cursor: _Cursor = ..., - disabledbackground: str = ..., - disabledforeground: str = ..., - exportselection: bool = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - format: str = ..., - from_: float = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - increment: float = ..., - insertbackground: str = ..., - insertborderwidth: _ScreenUnits = ..., - insertofftime: int = ..., - insertontime: int = ..., - insertwidth: _ScreenUnits = ..., - invalidcommand: _EntryValidateCommand = ..., - invcmd: _EntryValidateCommand = ..., - justify: Literal["left", "center", "right"] = ..., - readonlybackground: str = ..., - relief: _Relief = ..., - repeatdelay: int = ..., - repeatinterval: int = ..., - selectbackground: str = ..., - selectborderwidth: _ScreenUnits = ..., - selectforeground: str = ..., - state: Literal["normal", "disabled", "readonly"] = ..., - takefocus: _TakeFocusValue = ..., - textvariable: Variable = ..., - to: float = ..., - validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = ..., - validatecommand: _EntryValidateCommand = ..., - vcmd: _EntryValidateCommand = ..., - values: list[str] | tuple[str, ...] = ..., - width: int = ..., - wrap: bool = ..., - xscrollcommand: _XYScrollCommand = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def bbox(self, index) -> tuple[int, int, int, int] | None: ... # type: ignore[override] - def delete(self, first, last: Incomplete | None = None) -> Literal[""]: ... - def get(self) -> str: ... - def icursor(self, index): ... - def identify(self, x: int, y: int) -> Literal["", "buttondown", "buttonup", "entry"]: ... - def index(self, index: str | int) -> int: ... - def insert(self, index: str | int, s: str) -> Literal[""]: ... - # spinbox.invoke("asdf") gives error mentioning .invoke("none"), but it's not documented - def invoke(self, element: Literal["none", "buttonup", "buttondown"]) -> Literal[""]: ... - def scan(self, *args): ... - def scan_mark(self, x): ... - def scan_dragto(self, x): ... - def selection(self, *args) -> tuple[int, ...]: ... - def selection_adjust(self, index): ... - def selection_clear(self): ... # type: ignore[override] - def selection_element(self, element: Incomplete | None = None): ... - def selection_from(self, index: int) -> None: ... - def selection_present(self) -> None: ... - def selection_range(self, start: int, end: int) -> None: ... - def selection_to(self, index: int) -> None: ... - -class LabelFrame(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = 2, - bg: str = ..., - border: _ScreenUnits = 2, - borderwidth: _ScreenUnits = 2, - class_: str = "Labelframe", # can't be changed with configure() - colormap: Literal["new", ""] | Misc = "", # can't be changed with configure() - container: bool = False, # undocumented, can't be changed with configure() - cursor: _Cursor = "", - fg: str = ..., - font: _FontDescription = "TkDefaultFont", - foreground: str = ..., - height: _ScreenUnits = 0, - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = 0, - # 'ne' and 'en' are valid labelanchors, but only 'ne' is a valid _Anchor. - labelanchor: Literal["nw", "n", "ne", "en", "e", "es", "se", "s", "sw", "ws", "w", "wn"] = "nw", - labelwidget: Misc = ..., - name: str = ..., - padx: _ScreenUnits = 0, - pady: _ScreenUnits = 0, - relief: _Relief = "groove", - takefocus: _TakeFocusValue = 0, - text: float | str = "", - visual: str | tuple[str, int] = "", # can't be changed with configure() - width: _ScreenUnits = 0, - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - fg: str = ..., - font: _FontDescription = ..., - foreground: str = ..., - height: _ScreenUnits = ..., - highlightbackground: str = ..., - highlightcolor: str = ..., - highlightthickness: _ScreenUnits = ..., - labelanchor: Literal["nw", "n", "ne", "en", "e", "es", "se", "s", "sw", "ws", "w", "wn"] = ..., - labelwidget: Misc = ..., - padx: _ScreenUnits = ..., - pady: _ScreenUnits = ..., - relief: _Relief = ..., - takefocus: _TakeFocusValue = ..., - text: float | str = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - -class PanedWindow(Widget): - def __init__( - self, - master: Misc | None = None, - cnf: dict[str, Any] | None = {}, - *, - background: str = ..., - bd: _ScreenUnits = 1, - bg: str = ..., - border: _ScreenUnits = 1, - borderwidth: _ScreenUnits = 1, - cursor: _Cursor = "", - handlepad: _ScreenUnits = 8, - handlesize: _ScreenUnits = 8, - height: _ScreenUnits = "", - name: str = ..., - opaqueresize: bool = True, - orient: Literal["horizontal", "vertical"] = "horizontal", - proxybackground: str = "", - proxyborderwidth: _ScreenUnits = 2, - proxyrelief: _Relief = "flat", - relief: _Relief = "flat", - sashcursor: _Cursor = "", - sashpad: _ScreenUnits = 0, - sashrelief: _Relief = "flat", - sashwidth: _ScreenUnits = 3, - showhandle: bool = False, - width: _ScreenUnits = "", - ) -> None: ... - @overload - def configure( - self, - cnf: dict[str, Any] | None = None, - *, - background: str = ..., - bd: _ScreenUnits = ..., - bg: str = ..., - border: _ScreenUnits = ..., - borderwidth: _ScreenUnits = ..., - cursor: _Cursor = ..., - handlepad: _ScreenUnits = ..., - handlesize: _ScreenUnits = ..., - height: _ScreenUnits = ..., - opaqueresize: bool = ..., - orient: Literal["horizontal", "vertical"] = ..., - proxybackground: str = ..., - proxyborderwidth: _ScreenUnits = ..., - proxyrelief: _Relief = ..., - relief: _Relief = ..., - sashcursor: _Cursor = ..., - sashpad: _ScreenUnits = ..., - sashrelief: _Relief = ..., - sashwidth: _ScreenUnits = ..., - showhandle: bool = ..., - width: _ScreenUnits = ..., - ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... - @overload - def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... - config = configure - def add(self, child: Widget, **kw) -> None: ... - def remove(self, child) -> None: ... - forget: Incomplete - def identify(self, x: int, y: int): ... - def proxy(self, *args): ... - def proxy_coord(self): ... - def proxy_forget(self): ... - def proxy_place(self, x, y): ... - def sash(self, *args): ... - def sash_coord(self, index): ... - def sash_mark(self, index): ... - def sash_place(self, index, x, y): ... - def panecget(self, child, option): ... - def paneconfigure(self, tagOrId, cnf: Incomplete | None = None, **kw): ... - paneconfig: Incomplete - def panes(self): ... - -def _test() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi deleted file mode 100644 index 09bc8cbb4f1ee..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi +++ /dev/null @@ -1,20 +0,0 @@ -import sys -from tkinter import Misc -from tkinter.commondialog import Dialog -from typing import ClassVar - -if sys.version_info >= (3, 9): - __all__ = ["Chooser", "askcolor"] - -class Chooser(Dialog): - command: ClassVar[str] - -if sys.version_info >= (3, 9): - def askcolor( - color: str | bytes | None = None, *, initialcolor: str = ..., parent: Misc = ..., title: str = ... - ) -> tuple[None, None] | tuple[tuple[int, int, int], str]: ... - -else: - def askcolor( - color: str | bytes | None = None, *, initialcolor: str = ..., parent: Misc = ..., title: str = ... - ) -> tuple[None, None] | tuple[tuple[float, float, float], str]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tomllib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/tomllib.pyi deleted file mode 100644 index d559568b912b5..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tomllib.pyi +++ /dev/null @@ -1,10 +0,0 @@ -from _typeshed import SupportsRead -from collections.abc import Callable -from typing import Any - -__all__ = ("loads", "load", "TOMLDecodeError") - -class TOMLDecodeError(ValueError): ... - -def load(fp: SupportsRead[bytes], /, *, parse_float: Callable[[str], Any] = ...) -> dict[str, Any]: ... -def loads(s: str, /, *, parse_float: Callable[[str], Any] = ...) -> dict[str, Any]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/types.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/types.pyi deleted file mode 100644 index 0c5a436170405..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/types.pyi +++ /dev/null @@ -1,638 +0,0 @@ -import sys -from _typeshed import SupportsKeysAndGetItem -from _typeshed.importlib import LoaderProtocol -from collections.abc import ( - AsyncGenerator, - Awaitable, - Callable, - Coroutine, - Generator, - ItemsView, - Iterable, - Iterator, - KeysView, - MutableSequence, - ValuesView, -) -from importlib.machinery import ModuleSpec - -# pytype crashes if types.MappingProxyType inherits from collections.abc.Mapping instead of typing.Mapping -from typing import Any, ClassVar, Literal, Mapping, TypeVar, final, overload # noqa: Y022 -from typing_extensions import ParamSpec, Self, TypeVarTuple, deprecated - -__all__ = [ - "FunctionType", - "LambdaType", - "CodeType", - "MappingProxyType", - "SimpleNamespace", - "GeneratorType", - "CoroutineType", - "AsyncGeneratorType", - "MethodType", - "BuiltinFunctionType", - "ModuleType", - "TracebackType", - "FrameType", - "GetSetDescriptorType", - "MemberDescriptorType", - "new_class", - "prepare_class", - "DynamicClassAttribute", - "coroutine", - "BuiltinMethodType", - "ClassMethodDescriptorType", - "MethodDescriptorType", - "MethodWrapperType", - "WrapperDescriptorType", - "resolve_bases", - "CellType", -] - -if sys.version_info >= (3, 9): - __all__ += ["GenericAlias"] - -if sys.version_info >= (3, 10): - __all__ += ["EllipsisType", "NoneType", "NotImplementedType", "UnionType"] - -if sys.version_info >= (3, 12): - __all__ += ["get_original_bases"] - -if sys.version_info >= (3, 13): - __all__ += ["CapsuleType"] - -# Note, all classes "defined" here require special handling. - -_T1 = TypeVar("_T1") -_T2 = TypeVar("_T2") -_KT = TypeVar("_KT") -_VT_co = TypeVar("_VT_co", covariant=True) - -# Make sure this class definition stays roughly in line with `builtins.function` -@final -class FunctionType: - @property - def __closure__(self) -> tuple[CellType, ...] | None: ... - __code__: CodeType - __defaults__: tuple[Any, ...] | None - __dict__: dict[str, Any] - @property - def __globals__(self) -> dict[str, Any]: ... - __name__: str - __qualname__: str - __annotations__: dict[str, Any] - __kwdefaults__: dict[str, Any] | None - if sys.version_info >= (3, 10): - @property - def __builtins__(self) -> dict[str, Any]: ... - if sys.version_info >= (3, 12): - __type_params__: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] - - __module__: str - def __new__( - cls, - code: CodeType, - globals: dict[str, Any], - name: str | None = ..., - argdefs: tuple[object, ...] | None = ..., - closure: tuple[CellType, ...] | None = ..., - ) -> Self: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - @overload - def __get__(self, instance: None, owner: type, /) -> FunctionType: ... - @overload - def __get__(self, instance: object, owner: type | None = None, /) -> MethodType: ... - -LambdaType = FunctionType - -@final -class CodeType: - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - @property - def co_argcount(self) -> int: ... - @property - def co_posonlyargcount(self) -> int: ... - @property - def co_kwonlyargcount(self) -> int: ... - @property - def co_nlocals(self) -> int: ... - @property - def co_stacksize(self) -> int: ... - @property - def co_flags(self) -> int: ... - @property - def co_code(self) -> bytes: ... - @property - def co_consts(self) -> tuple[Any, ...]: ... - @property - def co_names(self) -> tuple[str, ...]: ... - @property - def co_varnames(self) -> tuple[str, ...]: ... - @property - def co_filename(self) -> str: ... - @property - def co_name(self) -> str: ... - @property - def co_firstlineno(self) -> int: ... - if sys.version_info >= (3, 10): - @property - @deprecated("Will be removed in Python 3.14. Use the co_lines() method instead.") - def co_lnotab(self) -> bytes: ... - else: - @property - def co_lnotab(self) -> bytes: ... - - @property - def co_freevars(self) -> tuple[str, ...]: ... - @property - def co_cellvars(self) -> tuple[str, ...]: ... - if sys.version_info >= (3, 10): - @property - def co_linetable(self) -> bytes: ... - def co_lines(self) -> Iterator[tuple[int, int, int | None]]: ... - if sys.version_info >= (3, 11): - @property - def co_exceptiontable(self) -> bytes: ... - @property - def co_qualname(self) -> str: ... - def co_positions(self) -> Iterable[tuple[int | None, int | None, int | None, int | None]]: ... - - if sys.version_info >= (3, 11): - def __new__( - cls, - argcount: int, - posonlyargcount: int, - kwonlyargcount: int, - nlocals: int, - stacksize: int, - flags: int, - codestring: bytes, - constants: tuple[object, ...], - names: tuple[str, ...], - varnames: tuple[str, ...], - filename: str, - name: str, - qualname: str, - firstlineno: int, - linetable: bytes, - exceptiontable: bytes, - freevars: tuple[str, ...] = ..., - cellvars: tuple[str, ...] = ..., - /, - ) -> Self: ... - elif sys.version_info >= (3, 10): - def __new__( - cls, - argcount: int, - posonlyargcount: int, - kwonlyargcount: int, - nlocals: int, - stacksize: int, - flags: int, - codestring: bytes, - constants: tuple[object, ...], - names: tuple[str, ...], - varnames: tuple[str, ...], - filename: str, - name: str, - firstlineno: int, - linetable: bytes, - freevars: tuple[str, ...] = ..., - cellvars: tuple[str, ...] = ..., - /, - ) -> Self: ... - else: - def __new__( - cls, - argcount: int, - posonlyargcount: int, - kwonlyargcount: int, - nlocals: int, - stacksize: int, - flags: int, - codestring: bytes, - constants: tuple[object, ...], - names: tuple[str, ...], - varnames: tuple[str, ...], - filename: str, - name: str, - firstlineno: int, - lnotab: bytes, - freevars: tuple[str, ...] = ..., - cellvars: tuple[str, ...] = ..., - /, - ) -> Self: ... - if sys.version_info >= (3, 11): - def replace( - self, - *, - co_argcount: int = -1, - co_posonlyargcount: int = -1, - co_kwonlyargcount: int = -1, - co_nlocals: int = -1, - co_stacksize: int = -1, - co_flags: int = -1, - co_firstlineno: int = -1, - co_code: bytes = ..., - co_consts: tuple[object, ...] = ..., - co_names: tuple[str, ...] = ..., - co_varnames: tuple[str, ...] = ..., - co_freevars: tuple[str, ...] = ..., - co_cellvars: tuple[str, ...] = ..., - co_filename: str = ..., - co_name: str = ..., - co_qualname: str = ..., - co_linetable: bytes = ..., - co_exceptiontable: bytes = ..., - ) -> Self: ... - elif sys.version_info >= (3, 10): - def replace( - self, - *, - co_argcount: int = -1, - co_posonlyargcount: int = -1, - co_kwonlyargcount: int = -1, - co_nlocals: int = -1, - co_stacksize: int = -1, - co_flags: int = -1, - co_firstlineno: int = -1, - co_code: bytes = ..., - co_consts: tuple[object, ...] = ..., - co_names: tuple[str, ...] = ..., - co_varnames: tuple[str, ...] = ..., - co_freevars: tuple[str, ...] = ..., - co_cellvars: tuple[str, ...] = ..., - co_filename: str = ..., - co_name: str = ..., - co_linetable: bytes = ..., - ) -> Self: ... - else: - def replace( - self, - *, - co_argcount: int = -1, - co_posonlyargcount: int = -1, - co_kwonlyargcount: int = -1, - co_nlocals: int = -1, - co_stacksize: int = -1, - co_flags: int = -1, - co_firstlineno: int = -1, - co_code: bytes = ..., - co_consts: tuple[object, ...] = ..., - co_names: tuple[str, ...] = ..., - co_varnames: tuple[str, ...] = ..., - co_freevars: tuple[str, ...] = ..., - co_cellvars: tuple[str, ...] = ..., - co_filename: str = ..., - co_name: str = ..., - co_lnotab: bytes = ..., - ) -> Self: ... - - if sys.version_info >= (3, 13): - __replace__ = replace - -@final -class MappingProxyType(Mapping[_KT, _VT_co]): - __hash__: ClassVar[None] # type: ignore[assignment] - def __new__(cls, mapping: SupportsKeysAndGetItem[_KT, _VT_co]) -> Self: ... - def __getitem__(self, key: _KT, /) -> _VT_co: ... - def __iter__(self) -> Iterator[_KT]: ... - def __len__(self) -> int: ... - def __eq__(self, value: object, /) -> bool: ... - def copy(self) -> dict[_KT, _VT_co]: ... - def keys(self) -> KeysView[_KT]: ... - def values(self) -> ValuesView[_VT_co]: ... - def items(self) -> ItemsView[_KT, _VT_co]: ... - @overload - def get(self, key: _KT, /) -> _VT_co | None: ... - @overload - def get(self, key: _KT, default: _VT_co | _T2, /) -> _VT_co | _T2: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - def __reversed__(self) -> Iterator[_KT]: ... - def __or__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ... - def __ror__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ... - -class SimpleNamespace: - __hash__: ClassVar[None] # type: ignore[assignment] - if sys.version_info >= (3, 13): - def __init__(self, mapping_or_iterable: Mapping[str, Any] | Iterable[tuple[str, Any]] = (), /, **kwargs: Any) -> None: ... - else: - def __init__(self, **kwargs: Any) -> None: ... - - def __eq__(self, value: object, /) -> bool: ... - def __getattribute__(self, name: str, /) -> Any: ... - def __setattr__(self, name: str, value: Any, /) -> None: ... - def __delattr__(self, name: str, /) -> None: ... - if sys.version_info >= (3, 13): - def __replace__(self, **kwargs: Any) -> Self: ... - -class ModuleType: - __name__: str - __file__: str | None - @property - def __dict__(self) -> dict[str, Any]: ... # type: ignore[override] - __loader__: LoaderProtocol | None - __package__: str | None - __path__: MutableSequence[str] - __spec__: ModuleSpec | None - def __init__(self, name: str, doc: str | None = ...) -> None: ... - # __getattr__ doesn't exist at runtime, - # but having it here in typeshed makes dynamic imports - # using `builtins.__import__` or `importlib.import_module` less painful - def __getattr__(self, name: str) -> Any: ... - -@final -class CellType: - def __new__(cls, contents: object = ..., /) -> Self: ... - __hash__: ClassVar[None] # type: ignore[assignment] - cell_contents: Any - -_YieldT_co = TypeVar("_YieldT_co", covariant=True) -_SendT_contra = TypeVar("_SendT_contra", contravariant=True) -_ReturnT_co = TypeVar("_ReturnT_co", covariant=True) - -@final -class GeneratorType(Generator[_YieldT_co, _SendT_contra, _ReturnT_co]): - @property - def gi_yieldfrom(self) -> GeneratorType[_YieldT_co, _SendT_contra, Any] | None: ... - if sys.version_info >= (3, 11): - @property - def gi_suspended(self) -> bool: ... - __name__: str - __qualname__: str - def __iter__(self) -> Self: ... - def __next__(self) -> _YieldT_co: ... - def send(self, arg: _SendT_contra, /) -> _YieldT_co: ... - @overload - def throw( - self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / - ) -> _YieldT_co: ... - @overload - def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... - if sys.version_info >= (3, 13): - def __class_getitem__(cls, item: Any, /) -> Any: ... - -@final -class AsyncGeneratorType(AsyncGenerator[_YieldT_co, _SendT_contra]): - @property - def ag_await(self) -> Awaitable[Any] | None: ... - __name__: str - __qualname__: str - if sys.version_info >= (3, 12): - @property - def ag_suspended(self) -> bool: ... - - def __aiter__(self) -> Self: ... - def __anext__(self) -> Coroutine[Any, Any, _YieldT_co]: ... - def asend(self, val: _SendT_contra, /) -> Coroutine[Any, Any, _YieldT_co]: ... - @overload - async def athrow( - self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / - ) -> _YieldT_co: ... - @overload - async def athrow(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... - def aclose(self) -> Coroutine[Any, Any, None]: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -@final -class CoroutineType(Coroutine[_YieldT_co, _SendT_contra, _ReturnT_co]): - __name__: str - __qualname__: str - @property - def cr_origin(self) -> tuple[tuple[str, int, str], ...] | None: ... - if sys.version_info >= (3, 11): - @property - def cr_suspended(self) -> bool: ... - - def close(self) -> None: ... - def __await__(self) -> Generator[Any, None, _ReturnT_co]: ... - def send(self, arg: _SendT_contra, /) -> _YieldT_co: ... - @overload - def throw( - self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / - ) -> _YieldT_co: ... - @overload - def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... - if sys.version_info >= (3, 13): - def __class_getitem__(cls, item: Any, /) -> Any: ... - -@final -class MethodType: - @property - def __closure__(self) -> tuple[CellType, ...] | None: ... # inherited from the added function - @property - def __code__(self) -> CodeType: ... # inherited from the added function - @property - def __defaults__(self) -> tuple[Any, ...] | None: ... # inherited from the added function - @property - def __func__(self) -> Callable[..., Any]: ... - @property - def __self__(self) -> object: ... - @property - def __name__(self) -> str: ... # inherited from the added function - @property - def __qualname__(self) -> str: ... # inherited from the added function - def __new__(cls, func: Callable[..., Any], obj: object, /) -> Self: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - -@final -class BuiltinFunctionType: - @property - def __self__(self) -> object | ModuleType: ... - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - -BuiltinMethodType = BuiltinFunctionType - -@final -class WrapperDescriptorType: - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... - -@final -class MethodWrapperType: - @property - def __self__(self) -> object: ... - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __eq__(self, value: object, /) -> bool: ... - def __ne__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - -@final -class MethodDescriptorType: - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... - -@final -class ClassMethodDescriptorType: - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... - -@final -class TracebackType: - def __new__(cls, tb_next: TracebackType | None, tb_frame: FrameType, tb_lasti: int, tb_lineno: int) -> Self: ... - tb_next: TracebackType | None - # the rest are read-only - @property - def tb_frame(self) -> FrameType: ... - @property - def tb_lasti(self) -> int: ... - @property - def tb_lineno(self) -> int: ... - -@final -class FrameType: - @property - def f_back(self) -> FrameType | None: ... - @property - def f_builtins(self) -> dict[str, Any]: ... - @property - def f_code(self) -> CodeType: ... - @property - def f_globals(self) -> dict[str, Any]: ... - @property - def f_lasti(self) -> int: ... - # see discussion in #6769: f_lineno *can* sometimes be None, - # but you should probably file a bug report with CPython if you encounter it being None in the wild. - # An `int | None` annotation here causes too many false-positive errors. - @property - def f_lineno(self) -> int | Any: ... - @property - def f_locals(self) -> dict[str, Any]: ... - f_trace: Callable[[FrameType, str, Any], Any] | None - f_trace_lines: bool - f_trace_opcodes: bool - def clear(self) -> None: ... - -@final -class GetSetDescriptorType: - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... - def __set__(self, instance: Any, value: Any, /) -> None: ... - def __delete__(self, instance: Any, /) -> None: ... - -@final -class MemberDescriptorType: - @property - def __name__(self) -> str: ... - @property - def __qualname__(self) -> str: ... - @property - def __objclass__(self) -> type: ... - def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... - def __set__(self, instance: Any, value: Any, /) -> None: ... - def __delete__(self, instance: Any, /) -> None: ... - -def new_class( - name: str, - bases: Iterable[object] = (), - kwds: dict[str, Any] | None = None, - exec_body: Callable[[dict[str, Any]], object] | None = None, -) -> type: ... -def resolve_bases(bases: Iterable[object]) -> tuple[Any, ...]: ... -def prepare_class( - name: str, bases: tuple[type, ...] = (), kwds: dict[str, Any] | None = None -) -> tuple[type, dict[str, Any], dict[str, Any]]: ... - -if sys.version_info >= (3, 12): - def get_original_bases(cls: type, /) -> tuple[Any, ...]: ... - -# Actually a different type, but `property` is special and we want that too. -DynamicClassAttribute = property - -_Fn = TypeVar("_Fn", bound=Callable[..., object]) -_R = TypeVar("_R") -_P = ParamSpec("_P") - -# it's not really an Awaitable, but can be used in an await expression. Real type: Generator & Awaitable -@overload -def coroutine(func: Callable[_P, Generator[Any, Any, _R]]) -> Callable[_P, Awaitable[_R]]: ... -@overload -def coroutine(func: _Fn) -> _Fn: ... - -if sys.version_info >= (3, 9): - class GenericAlias: - @property - def __origin__(self) -> type: ... - @property - def __args__(self) -> tuple[Any, ...]: ... - @property - def __parameters__(self) -> tuple[Any, ...]: ... - def __new__(cls, origin: type, args: Any) -> Self: ... - def __getitem__(self, typeargs: Any, /) -> GenericAlias: ... - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - if sys.version_info >= (3, 11): - @property - def __unpacked__(self) -> bool: ... - @property - def __typing_unpacked_tuple_args__(self) -> tuple[Any, ...] | None: ... - if sys.version_info >= (3, 10): - def __or__(self, value: Any, /) -> UnionType: ... - def __ror__(self, value: Any, /) -> UnionType: ... - - # GenericAlias delegates attr access to `__origin__` - def __getattr__(self, name: str) -> Any: ... - -if sys.version_info >= (3, 10): - @final - class NoneType: - def __bool__(self) -> Literal[False]: ... - - @final - class EllipsisType: ... - - from builtins import _NotImplementedType - - NotImplementedType = _NotImplementedType - @final - class UnionType: - @property - def __args__(self) -> tuple[Any, ...]: ... - def __or__(self, value: Any, /) -> UnionType: ... - def __ror__(self, value: Any, /) -> UnionType: ... - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - -if sys.version_info >= (3, 13): - @final - class CapsuleType: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/typing_extensions.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/typing_extensions.pyi deleted file mode 100644 index 3240eff0f5e92..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/typing_extensions.pyi +++ /dev/null @@ -1,533 +0,0 @@ -import abc -import sys -import typing -from _collections_abc import dict_items, dict_keys, dict_values -from _typeshed import IdentityFunction -from contextlib import AbstractAsyncContextManager as AsyncContextManager, AbstractContextManager as ContextManager -from typing import ( # noqa: Y022,Y037,Y038,Y039 - IO as IO, - TYPE_CHECKING as TYPE_CHECKING, - AbstractSet as AbstractSet, - Any as Any, - AnyStr as AnyStr, - AsyncGenerator as AsyncGenerator, - AsyncIterable as AsyncIterable, - AsyncIterator as AsyncIterator, - Awaitable as Awaitable, - BinaryIO as BinaryIO, - Callable as Callable, - ChainMap as ChainMap, - ClassVar as ClassVar, - Collection as Collection, - Container as Container, - Coroutine as Coroutine, - Counter as Counter, - DefaultDict as DefaultDict, - Deque as Deque, - Dict as Dict, - ForwardRef as ForwardRef, - FrozenSet as FrozenSet, - Generator as Generator, - Generic as Generic, - Hashable as Hashable, - ItemsView as ItemsView, - Iterable as Iterable, - Iterator as Iterator, - KeysView as KeysView, - List as List, - Mapping as Mapping, - MappingView as MappingView, - Match as Match, - MutableMapping as MutableMapping, - MutableSequence as MutableSequence, - MutableSet as MutableSet, - NoReturn as NoReturn, - Optional as Optional, - Pattern as Pattern, - Reversible as Reversible, - Sequence as Sequence, - Set as Set, - Sized as Sized, - SupportsAbs as SupportsAbs, - SupportsBytes as SupportsBytes, - SupportsComplex as SupportsComplex, - SupportsFloat as SupportsFloat, - SupportsInt as SupportsInt, - SupportsRound as SupportsRound, - Text as Text, - TextIO as TextIO, - Tuple as Tuple, - Type as Type, - Union as Union, - ValuesView as ValuesView, - _Alias, - cast as cast, - no_type_check as no_type_check, - no_type_check_decorator as no_type_check_decorator, - overload as overload, - type_check_only, -) - -if sys.version_info >= (3, 10): - from types import UnionType -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = [ - "Any", - "Buffer", - "ClassVar", - "Concatenate", - "Final", - "LiteralString", - "ParamSpec", - "ParamSpecArgs", - "ParamSpecKwargs", - "Self", - "Type", - "TypeVar", - "TypeVarTuple", - "Unpack", - "Awaitable", - "AsyncIterator", - "AsyncIterable", - "Coroutine", - "AsyncGenerator", - "AsyncContextManager", - "CapsuleType", - "ChainMap", - "ContextManager", - "Counter", - "Deque", - "DefaultDict", - "NamedTuple", - "OrderedDict", - "TypedDict", - "SupportsIndex", - "SupportsAbs", - "SupportsRound", - "SupportsBytes", - "SupportsComplex", - "SupportsFloat", - "SupportsInt", - "Annotated", - "assert_never", - "assert_type", - "dataclass_transform", - "deprecated", - "final", - "IntVar", - "is_typeddict", - "Literal", - "NewType", - "overload", - "override", - "Protocol", - "reveal_type", - "runtime", - "runtime_checkable", - "Text", - "TypeAlias", - "TypeAliasType", - "TypeGuard", - "TYPE_CHECKING", - "Never", - "NoReturn", - "Required", - "NotRequired", - "clear_overloads", - "get_args", - "get_origin", - "get_original_bases", - "get_overloads", - "get_type_hints", - "AbstractSet", - "AnyStr", - "BinaryIO", - "Callable", - "Collection", - "Container", - "Dict", - "Doc", - "ForwardRef", - "FrozenSet", - "Generator", - "Generic", - "Hashable", - "IO", - "ItemsView", - "Iterable", - "Iterator", - "KeysView", - "List", - "Mapping", - "MappingView", - "Match", - "MutableMapping", - "MutableSequence", - "MutableSet", - "NoDefault", - "Optional", - "Pattern", - "Reversible", - "Sequence", - "Set", - "Sized", - "TextIO", - "Tuple", - "Union", - "ValuesView", - "cast", - "get_protocol_members", - "is_protocol", - "no_type_check", - "no_type_check_decorator", - "ReadOnly", - "TypeIs", -] - -_T = typing.TypeVar("_T") -_F = typing.TypeVar("_F", bound=Callable[..., Any]) -_TC = typing.TypeVar("_TC", bound=type[object]) - -# unfortunately we have to duplicate this class definition from typing.pyi or we break pytype -class _SpecialForm: - def __getitem__(self, parameters: Any) -> object: ... - if sys.version_info >= (3, 10): - def __or__(self, other: Any) -> _SpecialForm: ... - def __ror__(self, other: Any) -> _SpecialForm: ... - -# Do not import (and re-export) Protocol or runtime_checkable from -# typing module because type checkers need to be able to distinguish -# typing.Protocol and typing_extensions.Protocol so they can properly -# warn users about potential runtime exceptions when using typing.Protocol -# on older versions of Python. -Protocol: _SpecialForm - -def runtime_checkable(cls: _TC) -> _TC: ... - -# This alias for above is kept here for backwards compatibility. -runtime = runtime_checkable -Final: _SpecialForm - -def final(f: _F) -> _F: ... - -Literal: _SpecialForm - -def IntVar(name: str) -> Any: ... # returns a new TypeVar - -# Internal mypy fallback type for all typed dicts (does not exist at runtime) -# N.B. Keep this mostly in sync with typing._TypedDict/mypy_extensions._TypedDict -@type_check_only -class _TypedDict(Mapping[str, object], metaclass=abc.ABCMeta): - __required_keys__: ClassVar[frozenset[str]] - __optional_keys__: ClassVar[frozenset[str]] - __total__: ClassVar[bool] - __orig_bases__: ClassVar[tuple[Any, ...]] - # PEP 705 - __readonly_keys__: ClassVar[frozenset[str]] - __mutable_keys__: ClassVar[frozenset[str]] - # PEP 728 - __closed__: ClassVar[bool] - __extra_items__: ClassVar[Any] - def copy(self) -> Self: ... - # Using Never so that only calls using mypy plugin hook that specialize the signature - # can go through. - def setdefault(self, k: Never, default: object) -> object: ... - # Mypy plugin hook for 'pop' expects that 'default' has a type variable type. - def pop(self, k: Never, default: _T = ...) -> object: ... # pyright: ignore[reportInvalidTypeVarUse] - def update(self: _T, m: _T, /) -> None: ... - def items(self) -> dict_items[str, object]: ... - def keys(self) -> dict_keys[str, object]: ... - def values(self) -> dict_values[str, object]: ... - def __delitem__(self, k: Never) -> None: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, value: Self, /) -> Self: ... - @overload - def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... - @overload - def __ror__(self, value: Self, /) -> Self: ... - @overload - def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... - # supposedly incompatible definitions of `__ior__` and `__or__`: - def __ior__(self, value: Self, /) -> Self: ... # type: ignore[misc] - -# TypedDict is a (non-subscriptable) special form. -TypedDict: object - -OrderedDict = _Alias() - -def get_type_hints( - obj: Callable[..., Any], - globalns: dict[str, Any] | None = None, - localns: Mapping[str, Any] | None = None, - include_extras: bool = False, -) -> dict[str, Any]: ... -def get_args(tp: Any) -> tuple[Any, ...]: ... - -if sys.version_info >= (3, 10): - @overload - def get_origin(tp: UnionType) -> type[UnionType]: ... - -if sys.version_info >= (3, 9): - @overload - def get_origin(tp: GenericAlias) -> type: ... - -@overload -def get_origin(tp: ParamSpecArgs | ParamSpecKwargs) -> ParamSpec: ... -@overload -def get_origin(tp: Any) -> Any | None: ... - -Annotated: _SpecialForm -_AnnotatedAlias: Any # undocumented - -@runtime_checkable -class SupportsIndex(Protocol, metaclass=abc.ABCMeta): - @abc.abstractmethod - def __index__(self) -> int: ... - -# New and changed things in 3.10 -if sys.version_info >= (3, 10): - from typing import ( - Concatenate as Concatenate, - ParamSpecArgs as ParamSpecArgs, - ParamSpecKwargs as ParamSpecKwargs, - TypeAlias as TypeAlias, - TypeGuard as TypeGuard, - is_typeddict as is_typeddict, - ) -else: - @final - class ParamSpecArgs: - @property - def __origin__(self) -> ParamSpec: ... - def __init__(self, origin: ParamSpec) -> None: ... - - @final - class ParamSpecKwargs: - @property - def __origin__(self) -> ParamSpec: ... - def __init__(self, origin: ParamSpec) -> None: ... - - Concatenate: _SpecialForm - TypeAlias: _SpecialForm - TypeGuard: _SpecialForm - def is_typeddict(tp: object) -> bool: ... - -# New and changed things in 3.11 -if sys.version_info >= (3, 11): - from typing import ( - LiteralString as LiteralString, - NamedTuple as NamedTuple, - Never as Never, - NewType as NewType, - NotRequired as NotRequired, - Required as Required, - Self as Self, - Unpack as Unpack, - assert_never as assert_never, - assert_type as assert_type, - clear_overloads as clear_overloads, - dataclass_transform as dataclass_transform, - get_overloads as get_overloads, - reveal_type as reveal_type, - ) -else: - Self: _SpecialForm - Never: _SpecialForm - def reveal_type(obj: _T, /) -> _T: ... - def assert_never(arg: Never, /) -> Never: ... - def assert_type(val: _T, typ: Any, /) -> _T: ... - def clear_overloads() -> None: ... - def get_overloads(func: Callable[..., object]) -> Sequence[Callable[..., object]]: ... - - Required: _SpecialForm - NotRequired: _SpecialForm - LiteralString: _SpecialForm - Unpack: _SpecialForm - - def dataclass_transform( - *, - eq_default: bool = True, - order_default: bool = False, - kw_only_default: bool = False, - frozen_default: bool = False, - field_specifiers: tuple[type[Any] | Callable[..., Any], ...] = (), - **kwargs: object, - ) -> IdentityFunction: ... - - class NamedTuple(tuple[Any, ...]): - if sys.version_info < (3, 9): - _field_types: ClassVar[dict[str, type]] - _field_defaults: ClassVar[dict[str, Any]] - _fields: ClassVar[tuple[str, ...]] - __orig_bases__: ClassVar[tuple[Any, ...]] - @overload - def __init__(self, typename: str, fields: Iterable[tuple[str, Any]] = ...) -> None: ... - @overload - def __init__(self, typename: str, fields: None = None, **kwargs: Any) -> None: ... - @classmethod - def _make(cls, iterable: Iterable[Any]) -> Self: ... - def _asdict(self) -> dict[str, Any]: ... - def _replace(self, **kwargs: Any) -> Self: ... - - class NewType: - def __init__(self, name: str, tp: Any) -> None: ... - def __call__(self, obj: _T, /) -> _T: ... - __supertype__: type | NewType - if sys.version_info >= (3, 10): - def __or__(self, other: Any) -> _SpecialForm: ... - def __ror__(self, other: Any) -> _SpecialForm: ... - -if sys.version_info >= (3, 12): - from collections.abc import Buffer as Buffer - from types import get_original_bases as get_original_bases - from typing import TypeAliasType as TypeAliasType, override as override -else: - def override(arg: _F, /) -> _F: ... - def get_original_bases(cls: type, /) -> tuple[Any, ...]: ... - @final - class TypeAliasType: - def __init__( - self, name: str, value: Any, *, type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = () - ) -> None: ... - @property - def __value__(self) -> Any: ... - @property - def __type_params__(self) -> tuple[TypeVar | ParamSpec | TypeVarTuple, ...]: ... - @property - def __parameters__(self) -> tuple[Any, ...]: ... - @property - def __name__(self) -> str: ... - # It's writable on types, but not on instances of TypeAliasType. - @property - def __module__(self) -> str | None: ... # type: ignore[override] - # Returns typing._GenericAlias, which isn't stubbed. - def __getitem__(self, parameters: Any) -> Any: ... - if sys.version_info >= (3, 10): - def __or__(self, right: Any) -> _SpecialForm: ... - def __ror__(self, left: Any) -> _SpecialForm: ... - - @runtime_checkable - class Buffer(Protocol): - # Not actually a Protocol at runtime; see - # https://github.com/python/typeshed/issues/10224 for why we're defining it this way - def __buffer__(self, flags: int, /) -> memoryview: ... - -if sys.version_info >= (3, 13): - from types import CapsuleType as CapsuleType - from typing import ( - NoDefault as NoDefault, - ParamSpec as ParamSpec, - ReadOnly as ReadOnly, - TypeIs as TypeIs, - TypeVar as TypeVar, - TypeVarTuple as TypeVarTuple, - get_protocol_members as get_protocol_members, - is_protocol as is_protocol, - ) - from warnings import deprecated as deprecated -else: - def is_protocol(tp: type, /) -> bool: ... - def get_protocol_members(tp: type, /) -> frozenset[str]: ... - @final - class _NoDefaultType: ... - - NoDefault: _NoDefaultType - @final - class CapsuleType: ... - - class deprecated: - message: LiteralString - category: type[Warning] | None - stacklevel: int - def __init__(self, message: LiteralString, /, *, category: type[Warning] | None = ..., stacklevel: int = 1) -> None: ... - def __call__(self, arg: _T, /) -> _T: ... - - @final - class TypeVar: - @property - def __name__(self) -> str: ... - @property - def __bound__(self) -> Any | None: ... - @property - def __constraints__(self) -> tuple[Any, ...]: ... - @property - def __covariant__(self) -> bool: ... - @property - def __contravariant__(self) -> bool: ... - @property - def __infer_variance__(self) -> bool: ... - @property - def __default__(self) -> Any: ... - def __init__( - self, - name: str, - *constraints: Any, - bound: Any | None = None, - covariant: bool = False, - contravariant: bool = False, - default: Any = ..., - infer_variance: bool = False, - ) -> None: ... - def has_default(self) -> bool: ... - def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... - if sys.version_info >= (3, 10): - def __or__(self, right: Any) -> _SpecialForm: ... - def __ror__(self, left: Any) -> _SpecialForm: ... - if sys.version_info >= (3, 11): - def __typing_subst__(self, arg: Any) -> Any: ... - - @final - class ParamSpec: - @property - def __name__(self) -> str: ... - @property - def __bound__(self) -> Any | None: ... - @property - def __covariant__(self) -> bool: ... - @property - def __contravariant__(self) -> bool: ... - @property - def __infer_variance__(self) -> bool: ... - @property - def __default__(self) -> Any: ... - def __init__( - self, - name: str, - *, - bound: None | type[Any] | str = None, - contravariant: bool = False, - covariant: bool = False, - default: Any = ..., - ) -> None: ... - @property - def args(self) -> ParamSpecArgs: ... - @property - def kwargs(self) -> ParamSpecKwargs: ... - def has_default(self) -> bool: ... - def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... - if sys.version_info >= (3, 10): - def __or__(self, right: Any) -> _SpecialForm: ... - def __ror__(self, left: Any) -> _SpecialForm: ... - - @final - class TypeVarTuple: - @property - def __name__(self) -> str: ... - @property - def __default__(self) -> Any: ... - def __init__(self, name: str, *, default: Any = ...) -> None: ... - def __iter__(self) -> Any: ... # Unpack[Self] - def has_default(self) -> bool: ... - def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... - - ReadOnly: _SpecialForm - TypeIs: _SpecialForm - -class Doc: - documentation: str - def __init__(self, documentation: str, /) -> None: ... - def __hash__(self) -> int: ... - def __eq__(self, other: object) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/request.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/request.pyi deleted file mode 100644 index ad4f91fc31ae7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/request.pyi +++ /dev/null @@ -1,408 +0,0 @@ -import ssl -import sys -from _typeshed import ReadableBuffer, StrOrBytesPath, SupportsRead -from collections.abc import Callable, Iterable, Mapping, MutableMapping, Sequence -from email.message import Message -from http.client import HTTPConnection, HTTPMessage, HTTPResponse -from http.cookiejar import CookieJar -from re import Pattern -from typing import IO, Any, ClassVar, NoReturn, Protocol, TypeVar, overload -from typing_extensions import TypeAlias -from urllib.error import HTTPError as HTTPError -from urllib.response import addclosehook, addinfourl - -__all__ = [ - "Request", - "OpenerDirector", - "BaseHandler", - "HTTPDefaultErrorHandler", - "HTTPRedirectHandler", - "HTTPCookieProcessor", - "ProxyHandler", - "HTTPPasswordMgr", - "HTTPPasswordMgrWithDefaultRealm", - "HTTPPasswordMgrWithPriorAuth", - "AbstractBasicAuthHandler", - "HTTPBasicAuthHandler", - "ProxyBasicAuthHandler", - "AbstractDigestAuthHandler", - "HTTPDigestAuthHandler", - "ProxyDigestAuthHandler", - "HTTPHandler", - "FileHandler", - "FTPHandler", - "CacheFTPHandler", - "DataHandler", - "UnknownHandler", - "HTTPErrorProcessor", - "urlopen", - "install_opener", - "build_opener", - "pathname2url", - "url2pathname", - "getproxies", - "urlretrieve", - "urlcleanup", - "URLopener", - "FancyURLopener", - "HTTPSHandler", -] - -_T = TypeVar("_T") -_UrlopenRet: TypeAlias = Any -_DataType: TypeAlias = ReadableBuffer | SupportsRead[bytes] | Iterable[bytes] | None - -if sys.version_info >= (3, 13): - def urlopen( - url: str | Request, data: _DataType | None = None, timeout: float | None = ..., *, context: ssl.SSLContext | None = None - ) -> _UrlopenRet: ... - -else: - def urlopen( - url: str | Request, - data: _DataType | None = None, - timeout: float | None = ..., - *, - cafile: str | None = None, - capath: str | None = None, - cadefault: bool = False, - context: ssl.SSLContext | None = None, - ) -> _UrlopenRet: ... - -def install_opener(opener: OpenerDirector) -> None: ... -def build_opener(*handlers: BaseHandler | Callable[[], BaseHandler]) -> OpenerDirector: ... - -if sys.platform == "win32": - from nturl2path import pathname2url as pathname2url, url2pathname as url2pathname -else: - def url2pathname(pathname: str) -> str: ... - def pathname2url(pathname: str) -> str: ... - -def getproxies() -> dict[str, str]: ... -def getproxies_environment() -> dict[str, str]: ... -def parse_http_list(s: str) -> list[str]: ... -def parse_keqv_list(l: list[str]) -> dict[str, str]: ... - -if sys.platform == "win32" or sys.platform == "darwin": - def proxy_bypass(host: str) -> Any: ... # undocumented - -else: - def proxy_bypass(host: str, proxies: Mapping[str, str] | None = None) -> Any: ... # undocumented - -class Request: - @property - def full_url(self) -> str: ... - @full_url.setter - def full_url(self, value: str) -> None: ... - @full_url.deleter - def full_url(self) -> None: ... - type: str - host: str - origin_req_host: str - selector: str - data: _DataType - headers: MutableMapping[str, str] - unredirected_hdrs: dict[str, str] - unverifiable: bool - method: str | None - timeout: float | None # Undocumented, only set after __init__() by OpenerDirector.open() - def __init__( - self, - url: str, - data: _DataType = None, - headers: MutableMapping[str, str] = {}, - origin_req_host: str | None = None, - unverifiable: bool = False, - method: str | None = None, - ) -> None: ... - def get_method(self) -> str: ... - def add_header(self, key: str, val: str) -> None: ... - def add_unredirected_header(self, key: str, val: str) -> None: ... - def has_header(self, header_name: str) -> bool: ... - def remove_header(self, header_name: str) -> None: ... - def get_full_url(self) -> str: ... - def set_proxy(self, host: str, type: str) -> None: ... - @overload - def get_header(self, header_name: str) -> str | None: ... - @overload - def get_header(self, header_name: str, default: _T) -> str | _T: ... - def header_items(self) -> list[tuple[str, str]]: ... - def has_proxy(self) -> bool: ... - -class OpenerDirector: - addheaders: list[tuple[str, str]] - def add_handler(self, handler: BaseHandler) -> None: ... - def open(self, fullurl: str | Request, data: _DataType = None, timeout: float | None = ...) -> _UrlopenRet: ... - def error(self, proto: str, *args: Any) -> _UrlopenRet: ... - def close(self) -> None: ... - -class BaseHandler: - handler_order: ClassVar[int] - parent: OpenerDirector - def add_parent(self, parent: OpenerDirector) -> None: ... - def close(self) -> None: ... - def __lt__(self, other: object) -> bool: ... - -class HTTPDefaultErrorHandler(BaseHandler): - def http_error_default( - self, req: Request, fp: IO[bytes], code: int, msg: str, hdrs: HTTPMessage - ) -> HTTPError: ... # undocumented - -class HTTPRedirectHandler(BaseHandler): - max_redirections: ClassVar[int] # undocumented - max_repeats: ClassVar[int] # undocumented - inf_msg: ClassVar[str] # undocumented - def redirect_request( - self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage, newurl: str - ) -> Request | None: ... - def http_error_301(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - def http_error_302(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - def http_error_303(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - def http_error_307(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - if sys.version_info >= (3, 11): - def http_error_308( - self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage - ) -> _UrlopenRet | None: ... - -class HTTPCookieProcessor(BaseHandler): - cookiejar: CookieJar - def __init__(self, cookiejar: CookieJar | None = None) -> None: ... - def http_request(self, request: Request) -> Request: ... # undocumented - def http_response(self, request: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented - def https_request(self, request: Request) -> Request: ... # undocumented - def https_response(self, request: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented - -class ProxyHandler(BaseHandler): - def __init__(self, proxies: dict[str, str] | None = None) -> None: ... - def proxy_open(self, req: Request, proxy: str, type: str) -> _UrlopenRet | None: ... # undocumented - # TODO add a method for every (common) proxy protocol - -class HTTPPasswordMgr: - def add_password(self, realm: str, uri: str | Sequence[str], user: str, passwd: str) -> None: ... - def find_user_password(self, realm: str, authuri: str) -> tuple[str | None, str | None]: ... - def is_suburi(self, base: str, test: str) -> bool: ... # undocumented - def reduce_uri(self, uri: str, default_port: bool = True) -> tuple[str, str]: ... # undocumented - -class HTTPPasswordMgrWithDefaultRealm(HTTPPasswordMgr): - def add_password(self, realm: str | None, uri: str | Sequence[str], user: str, passwd: str) -> None: ... - def find_user_password(self, realm: str | None, authuri: str) -> tuple[str | None, str | None]: ... - -class HTTPPasswordMgrWithPriorAuth(HTTPPasswordMgrWithDefaultRealm): - def add_password( - self, realm: str | None, uri: str | Sequence[str], user: str, passwd: str, is_authenticated: bool = False - ) -> None: ... - def update_authenticated(self, uri: str | Sequence[str], is_authenticated: bool = False) -> None: ... - def is_authenticated(self, authuri: str) -> bool | None: ... - -class AbstractBasicAuthHandler: - rx: ClassVar[Pattern[str]] # undocumented - passwd: HTTPPasswordMgr - add_password: Callable[[str, str | Sequence[str], str, str], None] - def __init__(self, password_mgr: HTTPPasswordMgr | None = None) -> None: ... - def http_error_auth_reqed(self, authreq: str, host: str, req: Request, headers: HTTPMessage) -> None: ... - def http_request(self, req: Request) -> Request: ... # undocumented - def http_response(self, req: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented - def https_request(self, req: Request) -> Request: ... # undocumented - def https_response(self, req: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented - def retry_http_basic_auth(self, host: str, req: Request, realm: str) -> _UrlopenRet | None: ... # undocumented - -class HTTPBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): - auth_header: ClassVar[str] # undocumented - def http_error_401(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - -class ProxyBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): - auth_header: ClassVar[str] - def http_error_407(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - -class AbstractDigestAuthHandler: - def __init__(self, passwd: HTTPPasswordMgr | None = None) -> None: ... - def reset_retry_count(self) -> None: ... - def http_error_auth_reqed(self, auth_header: str, host: str, req: Request, headers: HTTPMessage) -> None: ... - def retry_http_digest_auth(self, req: Request, auth: str) -> _UrlopenRet | None: ... - def get_cnonce(self, nonce: str) -> str: ... - def get_authorization(self, req: Request, chal: Mapping[str, str]) -> str | None: ... - def get_algorithm_impls(self, algorithm: str) -> tuple[Callable[[str], str], Callable[[str, str], str]]: ... - def get_entity_digest(self, data: ReadableBuffer | None, chal: Mapping[str, str]) -> str | None: ... - -class HTTPDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): - auth_header: ClassVar[str] # undocumented - def http_error_401(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - -class ProxyDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): - auth_header: ClassVar[str] # undocumented - def http_error_407(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... - -class _HTTPConnectionProtocol(Protocol): - def __call__( - self, - host: str, - /, - *, - port: int | None = ..., - timeout: float = ..., - source_address: tuple[str, int] | None = ..., - blocksize: int = ..., - ) -> HTTPConnection: ... - -class AbstractHTTPHandler(BaseHandler): # undocumented - if sys.version_info >= (3, 12): - def __init__(self, debuglevel: int | None = None) -> None: ... - else: - def __init__(self, debuglevel: int = 0) -> None: ... - - def set_http_debuglevel(self, level: int) -> None: ... - def do_request_(self, request: Request) -> Request: ... - def do_open(self, http_class: _HTTPConnectionProtocol, req: Request, **http_conn_args: Any) -> HTTPResponse: ... - -class HTTPHandler(AbstractHTTPHandler): - def http_open(self, req: Request) -> HTTPResponse: ... - def http_request(self, request: Request) -> Request: ... # undocumented - -class HTTPSHandler(AbstractHTTPHandler): - if sys.version_info >= (3, 12): - def __init__( - self, debuglevel: int | None = None, context: ssl.SSLContext | None = None, check_hostname: bool | None = None - ) -> None: ... - else: - def __init__( - self, debuglevel: int = 0, context: ssl.SSLContext | None = None, check_hostname: bool | None = None - ) -> None: ... - - def https_open(self, req: Request) -> HTTPResponse: ... - def https_request(self, request: Request) -> Request: ... # undocumented - -class FileHandler(BaseHandler): - names: ClassVar[tuple[str, ...] | None] # undocumented - def file_open(self, req: Request) -> addinfourl: ... - def get_names(self) -> tuple[str, ...]: ... # undocumented - def open_local_file(self, req: Request) -> addinfourl: ... # undocumented - -class DataHandler(BaseHandler): - def data_open(self, req: Request) -> addinfourl: ... - -class ftpwrapper: # undocumented - def __init__( - self, user: str, passwd: str, host: str, port: int, dirs: str, timeout: float | None = None, persistent: bool = True - ) -> None: ... - def close(self) -> None: ... - def endtransfer(self) -> None: ... - def file_close(self) -> None: ... - def init(self) -> None: ... - def real_close(self) -> None: ... - def retrfile(self, file: str, type: str) -> tuple[addclosehook, int | None]: ... - -class FTPHandler(BaseHandler): - def ftp_open(self, req: Request) -> addinfourl: ... - def connect_ftp( - self, user: str, passwd: str, host: str, port: int, dirs: str, timeout: float - ) -> ftpwrapper: ... # undocumented - -class CacheFTPHandler(FTPHandler): - def setTimeout(self, t: float) -> None: ... - def setMaxConns(self, m: int) -> None: ... - def check_cache(self) -> None: ... # undocumented - def clear_cache(self) -> None: ... # undocumented - -class UnknownHandler(BaseHandler): - def unknown_open(self, req: Request) -> NoReturn: ... - -class HTTPErrorProcessor(BaseHandler): - def http_response(self, request: Request, response: HTTPResponse) -> _UrlopenRet: ... - def https_response(self, request: Request, response: HTTPResponse) -> _UrlopenRet: ... - -def urlretrieve( - url: str, - filename: StrOrBytesPath | None = None, - reporthook: Callable[[int, int, int], object] | None = None, - data: _DataType = None, -) -> tuple[str, HTTPMessage]: ... -def urlcleanup() -> None: ... - -class URLopener: - version: ClassVar[str] - def __init__(self, proxies: dict[str, str] | None = None, **x509: str) -> None: ... - def open(self, fullurl: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... - def open_unknown(self, fullurl: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... - def retrieve( - self, - url: str, - filename: str | None = None, - reporthook: Callable[[int, int, int], object] | None = None, - data: ReadableBuffer | None = None, - ) -> tuple[str, Message | None]: ... - def addheader(self, *args: tuple[str, str]) -> None: ... # undocumented - def cleanup(self) -> None: ... # undocumented - def close(self) -> None: ... # undocumented - def http_error( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: bytes | None = None - ) -> _UrlopenRet: ... # undocumented - def http_error_default( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage - ) -> _UrlopenRet: ... # undocumented - def open_data(self, url: str, data: ReadableBuffer | None = None) -> addinfourl: ... # undocumented - def open_file(self, url: str) -> addinfourl: ... # undocumented - def open_ftp(self, url: str) -> addinfourl: ... # undocumented - def open_http(self, url: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... # undocumented - def open_https(self, url: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... # undocumented - def open_local_file(self, url: str) -> addinfourl: ... # undocumented - def open_unknown_proxy(self, proxy: str, fullurl: str, data: ReadableBuffer | None = None) -> None: ... # undocumented - def __del__(self) -> None: ... - -class FancyURLopener(URLopener): - def prompt_user_passwd(self, host: str, realm: str) -> tuple[str, str]: ... - def get_user_passwd(self, host: str, realm: str, clear_cache: int = 0) -> tuple[str, str]: ... # undocumented - def http_error_301( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None - ) -> _UrlopenRet | addinfourl | None: ... # undocumented - def http_error_302( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None - ) -> _UrlopenRet | addinfourl | None: ... # undocumented - def http_error_303( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None - ) -> _UrlopenRet | addinfourl | None: ... # undocumented - def http_error_307( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None - ) -> _UrlopenRet | addinfourl | None: ... # undocumented - if sys.version_info >= (3, 11): - def http_error_308( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None - ) -> _UrlopenRet | addinfourl | None: ... # undocumented - - def http_error_401( - self, - url: str, - fp: IO[bytes], - errcode: int, - errmsg: str, - headers: HTTPMessage, - data: ReadableBuffer | None = None, - retry: bool = False, - ) -> _UrlopenRet | None: ... # undocumented - def http_error_407( - self, - url: str, - fp: IO[bytes], - errcode: int, - errmsg: str, - headers: HTTPMessage, - data: ReadableBuffer | None = None, - retry: bool = False, - ) -> _UrlopenRet | None: ... # undocumented - def http_error_default( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage - ) -> addinfourl: ... # undocumented - def redirect_internal( - self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None - ) -> _UrlopenRet | None: ... # undocumented - def retry_http_basic_auth( - self, url: str, realm: str, data: ReadableBuffer | None = None - ) -> _UrlopenRet | None: ... # undocumented - def retry_https_basic_auth( - self, url: str, realm: str, data: ReadableBuffer | None = None - ) -> _UrlopenRet | None: ... # undocumented - def retry_proxy_http_basic_auth( - self, url: str, realm: str, data: ReadableBuffer | None = None - ) -> _UrlopenRet | None: ... # undocumented - def retry_proxy_https_basic_auth( - self, url: str, realm: str, data: ReadableBuffer | None = None - ) -> _UrlopenRet | None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/weakref.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/weakref.pyi deleted file mode 100644 index 853caf3e8abb2..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/weakref.pyi +++ /dev/null @@ -1,182 +0,0 @@ -import sys -from _typeshed import SupportsKeysAndGetItem -from _weakref import getweakrefcount as getweakrefcount, getweakrefs as getweakrefs, proxy as proxy -from _weakrefset import WeakSet as WeakSet -from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping -from typing import Any, Generic, TypeVar, final, overload -from typing_extensions import ParamSpec, Self - -if sys.version_info >= (3, 9): - from types import GenericAlias - -__all__ = [ - "ref", - "proxy", - "getweakrefcount", - "getweakrefs", - "WeakKeyDictionary", - "ReferenceType", - "ProxyType", - "CallableProxyType", - "ProxyTypes", - "WeakValueDictionary", - "WeakSet", - "WeakMethod", - "finalize", -] - -_T = TypeVar("_T") -_T1 = TypeVar("_T1") -_T2 = TypeVar("_T2") -_KT = TypeVar("_KT") -_VT = TypeVar("_VT") -_CallableT = TypeVar("_CallableT", bound=Callable[..., Any]) -_P = ParamSpec("_P") - -ProxyTypes: tuple[type[Any], ...] - -# These classes are implemented in C and imported from _weakref at runtime. However, -# they consider themselves to live in the weakref module for sys.version_info >= (3, 11), -# so defining their stubs here means we match their __module__ value. -# Prior to 3.11 they did not declare a module for themselves and ended up looking like they -# came from the builtin module at runtime, which was just wrong, and we won't attempt to -# duplicate that. - -@final -class CallableProxyType(Generic[_CallableT]): # "weakcallableproxy" - def __eq__(self, value: object, /) -> bool: ... - def __getattr__(self, attr: str) -> Any: ... - __call__: _CallableT - -@final -class ProxyType(Generic[_T]): # "weakproxy" - def __eq__(self, value: object, /) -> bool: ... - def __getattr__(self, attr: str) -> Any: ... - -class ReferenceType(Generic[_T]): # "weakref" - __callback__: Callable[[Self], Any] - def __new__(cls, o: _T, callback: Callable[[Self], Any] | None = ..., /) -> Self: ... - def __call__(self) -> _T | None: ... - def __eq__(self, value: object, /) -> bool: ... - def __hash__(self) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - -ref = ReferenceType - -# everything below here is implemented in weakref.py - -class WeakMethod(ref[_CallableT]): - def __new__(cls, meth: _CallableT, callback: Callable[[Self], Any] | None = None) -> Self: ... - def __call__(self) -> _CallableT | None: ... - def __eq__(self, other: object) -> bool: ... - def __ne__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - -class WeakValueDictionary(MutableMapping[_KT, _VT]): - @overload - def __init__(self) -> None: ... - @overload - def __init__( - self: WeakValueDictionary[_KT, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - other: Mapping[_KT, _VT] | Iterable[tuple[_KT, _VT]], - /, - ) -> None: ... - @overload - def __init__( - self: WeakValueDictionary[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 - other: Mapping[str, _VT] | Iterable[tuple[str, _VT]] = (), - /, - **kwargs: _VT, - ) -> None: ... - def __len__(self) -> int: ... - def __getitem__(self, key: _KT) -> _VT: ... - def __setitem__(self, key: _KT, value: _VT) -> None: ... - def __delitem__(self, key: _KT) -> None: ... - def __contains__(self, key: object) -> bool: ... - def __iter__(self) -> Iterator[_KT]: ... - def copy(self) -> WeakValueDictionary[_KT, _VT]: ... - __copy__ = copy - def __deepcopy__(self, memo: Any) -> Self: ... - @overload - def get(self, key: _KT, default: None = None) -> _VT | None: ... - @overload - def get(self, key: _KT, default: _T) -> _VT | _T: ... - # These are incompatible with Mapping - def keys(self) -> Iterator[_KT]: ... # type: ignore[override] - def values(self) -> Iterator[_VT]: ... # type: ignore[override] - def items(self) -> Iterator[tuple[_KT, _VT]]: ... # type: ignore[override] - def itervaluerefs(self) -> Iterator[KeyedRef[_KT, _VT]]: ... - def valuerefs(self) -> list[KeyedRef[_KT, _VT]]: ... - def setdefault(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _T) -> _VT | _T: ... - if sys.version_info >= (3, 9): - def __or__(self, other: Mapping[_T1, _T2]) -> WeakValueDictionary[_KT | _T1, _VT | _T2]: ... - def __ror__(self, other: Mapping[_T1, _T2]) -> WeakValueDictionary[_KT | _T1, _VT | _T2]: ... - # WeakValueDictionary.__ior__ should be kept roughly in line with MutableMapping.update() - @overload # type: ignore[misc] - def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... - @overload - def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... - -class KeyedRef(ref[_T], Generic[_KT, _T]): - key: _KT - def __new__(type, ob: _T, callback: Callable[[Self], Any], key: _KT) -> Self: ... - def __init__(self, ob: _T, callback: Callable[[Self], Any], key: _KT) -> None: ... - -class WeakKeyDictionary(MutableMapping[_KT, _VT]): - @overload - def __init__(self, dict: None = None) -> None: ... - @overload - def __init__(self, dict: Mapping[_KT, _VT] | Iterable[tuple[_KT, _VT]]) -> None: ... - def __len__(self) -> int: ... - def __getitem__(self, key: _KT) -> _VT: ... - def __setitem__(self, key: _KT, value: _VT) -> None: ... - def __delitem__(self, key: _KT) -> None: ... - def __contains__(self, key: object) -> bool: ... - def __iter__(self) -> Iterator[_KT]: ... - def copy(self) -> WeakKeyDictionary[_KT, _VT]: ... - __copy__ = copy - def __deepcopy__(self, memo: Any) -> Self: ... - @overload - def get(self, key: _KT, default: None = None) -> _VT | None: ... - @overload - def get(self, key: _KT, default: _T) -> _VT | _T: ... - # These are incompatible with Mapping - def keys(self) -> Iterator[_KT]: ... # type: ignore[override] - def values(self) -> Iterator[_VT]: ... # type: ignore[override] - def items(self) -> Iterator[tuple[_KT, _VT]]: ... # type: ignore[override] - def keyrefs(self) -> list[ref[_KT]]: ... - # Keep WeakKeyDictionary.setdefault in line with MutableMapping.setdefault, modulo positional-only differences - @overload - def setdefault(self: WeakKeyDictionary[_KT, _VT | None], key: _KT, default: None = None) -> _VT: ... - @overload - def setdefault(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _VT) -> _VT: ... - @overload - def pop(self, key: _KT, default: _T) -> _VT | _T: ... - if sys.version_info >= (3, 9): - def __or__(self, other: Mapping[_T1, _T2]) -> WeakKeyDictionary[_KT | _T1, _VT | _T2]: ... - def __ror__(self, other: Mapping[_T1, _T2]) -> WeakKeyDictionary[_KT | _T1, _VT | _T2]: ... - # WeakKeyDictionary.__ior__ should be kept roughly in line with MutableMapping.update() - @overload # type: ignore[misc] - def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... - @overload - def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... - -class finalize: # TODO: This is a good candidate for to be a `Generic[_P, _T]` class - def __init__(self, obj: object, func: Callable[_P, Any], /, *args: _P.args, **kwargs: _P.kwargs) -> None: ... - def __call__(self, _: Any = None) -> Any | None: ... - def detach(self) -> tuple[Any, Any, tuple[Any, ...], dict[str, Any]] | None: ... - def peek(self) -> tuple[Any, Any, tuple[Any, ...], dict[str, Any]] | None: ... - @property - def alive(self) -> bool: ... - atexit: bool diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi deleted file mode 100644 index 86212df8ccdc4..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi +++ /dev/null @@ -1,32 +0,0 @@ -from collections.abc import Callable, Iterable, Iterator -from sys import _OptExcInfo -from typing import Any, Protocol -from typing_extensions import TypeAlias - -__all__ = ["StartResponse", "WSGIEnvironment", "WSGIApplication", "InputStream", "ErrorStream", "FileWrapper"] - -class StartResponse(Protocol): - def __call__( - self, status: str, headers: list[tuple[str, str]], exc_info: _OptExcInfo | None = ..., / - ) -> Callable[[bytes], object]: ... - -WSGIEnvironment: TypeAlias = dict[str, Any] -WSGIApplication: TypeAlias = Callable[[WSGIEnvironment, StartResponse], Iterable[bytes]] - -class InputStream(Protocol): - def read(self, size: int = ..., /) -> bytes: ... - def readline(self, size: int = ..., /) -> bytes: ... - def readlines(self, hint: int = ..., /) -> list[bytes]: ... - def __iter__(self) -> Iterator[bytes]: ... - -class ErrorStream(Protocol): - def flush(self) -> object: ... - def write(self, s: str, /) -> object: ... - def writelines(self, seq: list[str], /) -> object: ... - -class _Readable(Protocol): - def read(self, size: int = ..., /) -> bytes: ... - # Optional: def close(self) -> object: ... - -class FileWrapper(Protocol): - def __call__(self, file: _Readable, block_size: int = ..., /) -> Iterable[bytes]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/__init__.pyi deleted file mode 100644 index a487d2467f41b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/__init__.pyi +++ /dev/null @@ -1 +0,0 @@ -from xml import parsers as parsers diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi deleted file mode 100644 index 80fb73d234332..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi +++ /dev/null @@ -1,19 +0,0 @@ -class NodeFilter: - FILTER_ACCEPT: int - FILTER_REJECT: int - FILTER_SKIP: int - - SHOW_ALL: int - SHOW_ELEMENT: int - SHOW_ATTRIBUTE: int - SHOW_TEXT: int - SHOW_CDATA_SECTION: int - SHOW_ENTITY_REFERENCE: int - SHOW_ENTITY: int - SHOW_PROCESSING_INSTRUCTION: int - SHOW_COMMENT: int - SHOW_DOCUMENT: int - SHOW_DOCUMENT_TYPE: int - SHOW_DOCUMENT_FRAGMENT: int - SHOW_NOTATION: int - def acceptNode(self, node) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi deleted file mode 100644 index 8738015638a93..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi +++ /dev/null @@ -1,69 +0,0 @@ -from typing import Any, Final - -from .domreg import getDOMImplementation as getDOMImplementation, registerDOMImplementation as registerDOMImplementation - -class Node: - ELEMENT_NODE: int - ATTRIBUTE_NODE: int - TEXT_NODE: int - CDATA_SECTION_NODE: int - ENTITY_REFERENCE_NODE: int - ENTITY_NODE: int - PROCESSING_INSTRUCTION_NODE: int - COMMENT_NODE: int - DOCUMENT_NODE: int - DOCUMENT_TYPE_NODE: int - DOCUMENT_FRAGMENT_NODE: int - NOTATION_NODE: int - -# ExceptionCode -INDEX_SIZE_ERR: Final[int] -DOMSTRING_SIZE_ERR: Final[int] -HIERARCHY_REQUEST_ERR: Final[int] -WRONG_DOCUMENT_ERR: Final[int] -INVALID_CHARACTER_ERR: Final[int] -NO_DATA_ALLOWED_ERR: Final[int] -NO_MODIFICATION_ALLOWED_ERR: Final[int] -NOT_FOUND_ERR: Final[int] -NOT_SUPPORTED_ERR: Final[int] -INUSE_ATTRIBUTE_ERR: Final[int] -INVALID_STATE_ERR: Final[int] -SYNTAX_ERR: Final[int] -INVALID_MODIFICATION_ERR: Final[int] -NAMESPACE_ERR: Final[int] -INVALID_ACCESS_ERR: Final[int] -VALIDATION_ERR: Final[int] - -class DOMException(Exception): - code: int - def __init__(self, *args: Any, **kw: Any) -> None: ... - def _get_code(self) -> int: ... - -class IndexSizeErr(DOMException): ... -class DomstringSizeErr(DOMException): ... -class HierarchyRequestErr(DOMException): ... -class WrongDocumentErr(DOMException): ... -class InvalidCharacterErr(DOMException): ... -class NoDataAllowedErr(DOMException): ... -class NoModificationAllowedErr(DOMException): ... -class NotFoundErr(DOMException): ... -class NotSupportedErr(DOMException): ... -class InuseAttributeErr(DOMException): ... -class InvalidStateErr(DOMException): ... -class SyntaxErr(DOMException): ... -class InvalidModificationErr(DOMException): ... -class NamespaceErr(DOMException): ... -class InvalidAccessErr(DOMException): ... -class ValidationErr(DOMException): ... - -class UserDataHandler: - NODE_CLONED: int - NODE_IMPORTED: int - NODE_DELETED: int - NODE_RENAMED: int - -XML_NAMESPACE: Final[str] -XMLNS_NAMESPACE: Final[str] -XHTML_NAMESPACE: Final[str] -EMPTY_NAMESPACE: Final[None] -EMPTY_PREFIX: Final[None] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi deleted file mode 100644 index 45f0af7aa9799..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi +++ /dev/null @@ -1,100 +0,0 @@ -from _typeshed import Incomplete, ReadableBuffer, SupportsRead -from typing import Any, NoReturn -from xml.dom.minidom import Document, DOMImplementation, Node, TypeInfo -from xml.dom.xmlbuilder import DOMBuilderFilter, Options - -TEXT_NODE = Node.TEXT_NODE -CDATA_SECTION_NODE = Node.CDATA_SECTION_NODE -DOCUMENT_NODE = Node.DOCUMENT_NODE -FILTER_ACCEPT = DOMBuilderFilter.FILTER_ACCEPT -FILTER_REJECT = DOMBuilderFilter.FILTER_REJECT -FILTER_SKIP = DOMBuilderFilter.FILTER_SKIP -FILTER_INTERRUPT = DOMBuilderFilter.FILTER_INTERRUPT -theDOMImplementation: DOMImplementation | None - -class ElementInfo: - tagName: Incomplete - def __init__(self, tagName, model: Incomplete | None = None) -> None: ... - def getAttributeType(self, aname) -> TypeInfo: ... - def getAttributeTypeNS(self, namespaceURI, localName) -> TypeInfo: ... - def isElementContent(self) -> bool: ... - def isEmpty(self) -> bool: ... - def isId(self, aname) -> bool: ... - def isIdNS(self, euri, ename, auri, aname) -> bool: ... - -class ExpatBuilder: - document: Document # Created in self.reset() - curNode: Incomplete # Created in self.reset() - def __init__(self, options: Options | None = None) -> None: ... - def createParser(self): ... - def getParser(self): ... - def reset(self) -> None: ... - def install(self, parser) -> None: ... - def parseFile(self, file: SupportsRead[ReadableBuffer | str]) -> Document: ... - def parseString(self, string: str | ReadableBuffer) -> Document: ... - def start_doctype_decl_handler(self, doctypeName, systemId, publicId, has_internal_subset) -> None: ... - def end_doctype_decl_handler(self) -> None: ... - def pi_handler(self, target, data) -> None: ... - def character_data_handler_cdata(self, data) -> None: ... - def character_data_handler(self, data) -> None: ... - def start_cdata_section_handler(self) -> None: ... - def end_cdata_section_handler(self) -> None: ... - def entity_decl_handler(self, entityName, is_parameter_entity, value, base, systemId, publicId, notationName) -> None: ... - def notation_decl_handler(self, notationName, base, systemId, publicId) -> None: ... - def comment_handler(self, data) -> None: ... - def external_entity_ref_handler(self, context, base, systemId, publicId) -> int: ... - def first_element_handler(self, name, attributes) -> None: ... - def start_element_handler(self, name, attributes) -> None: ... - def end_element_handler(self, name) -> None: ... - def element_decl_handler(self, name, model) -> None: ... - def attlist_decl_handler(self, elem, name, type, default, required) -> None: ... - def xml_decl_handler(self, version, encoding, standalone) -> None: ... - -class FilterVisibilityController: - filter: DOMBuilderFilter - def __init__(self, filter: DOMBuilderFilter) -> None: ... - def startContainer(self, node: Node) -> int: ... - def acceptNode(self, node: Node) -> int: ... - -class FilterCrutch: - def __init__(self, builder) -> None: ... - -class Rejecter(FilterCrutch): - def start_element_handler(self, *args: Any) -> None: ... - def end_element_handler(self, *args: Any) -> None: ... - -class Skipper(FilterCrutch): - def start_element_handler(self, *args: Any) -> None: ... - def end_element_handler(self, *args: Any) -> None: ... - -class FragmentBuilder(ExpatBuilder): - fragment: Incomplete | None - originalDocument: Incomplete - context: Incomplete - def __init__(self, context, options: Options | None = None) -> None: ... - -class Namespaces: - def createParser(self): ... - def install(self, parser) -> None: ... - def start_namespace_decl_handler(self, prefix, uri) -> None: ... - def start_element_handler(self, name, attributes) -> None: ... - def end_element_handler(self, name) -> None: ... - -class ExpatBuilderNS(Namespaces, ExpatBuilder): ... -class FragmentBuilderNS(Namespaces, FragmentBuilder): ... -class ParseEscape(Exception): ... - -class InternalSubsetExtractor(ExpatBuilder): - subset: Any | None - def getSubset(self) -> Any | None: ... - def parseFile(self, file: SupportsRead[ReadableBuffer | str]) -> None: ... # type: ignore[override] - def parseString(self, string: str | ReadableBuffer) -> None: ... # type: ignore[override] - def start_doctype_decl_handler(self, name, publicId, systemId, has_internal_subset) -> None: ... # type: ignore[override] - def end_doctype_decl_handler(self) -> NoReturn: ... - def start_element_handler(self, name, attrs) -> NoReturn: ... - -def parse(file: str | SupportsRead[ReadableBuffer | str], namespaces: bool = True): ... -def parseString(string: str | ReadableBuffer, namespaces: bool = True): ... -def parseFragment(file, context, namespaces: bool = True): ... -def parseFragmentString(string: str, context, namespaces: bool = True): ... -def makeBuilder(options: Options) -> ExpatBuilderNS | ExpatBuilder: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi deleted file mode 100644 index fae2c4d987146..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi +++ /dev/null @@ -1,404 +0,0 @@ -import sys -import xml.dom -from _typeshed import Incomplete, ReadableBuffer, SupportsRead, SupportsWrite -from typing import Literal, NoReturn, TypeVar, overload -from typing_extensions import Self -from xml.dom.minicompat import NodeList -from xml.dom.xmlbuilder import DocumentLS, DOMImplementationLS -from xml.sax.xmlreader import XMLReader - -_N = TypeVar("_N", bound=Node) - -def parse( - file: str | SupportsRead[ReadableBuffer | str], parser: XMLReader | None = None, bufsize: int | None = None -) -> Document: ... -def parseString(string: str | ReadableBuffer, parser: XMLReader | None = None) -> Document: ... -def getDOMImplementation(features=None) -> DOMImplementation | None: ... - -class Node(xml.dom.Node): - namespaceURI: str | None - parentNode: Incomplete - ownerDocument: Incomplete - nextSibling: Incomplete - previousSibling: Incomplete - prefix: Incomplete - @property - def firstChild(self) -> Node | None: ... - @property - def lastChild(self) -> Node | None: ... - @property - def localName(self) -> str | None: ... - def __bool__(self) -> Literal[True]: ... - if sys.version_info >= (3, 9): - @overload - def toxml(self, encoding: str, standalone: bool | None = None) -> bytes: ... - @overload - def toxml(self, encoding: None = None, standalone: bool | None = None) -> str: ... - @overload - def toprettyxml( - self, - indent: str = "\t", - newl: str = "\n", - # Handle any case where encoding is not provided or where it is passed with None - encoding: None = None, - standalone: bool | None = None, - ) -> str: ... - @overload - def toprettyxml( - self, - indent: str, - newl: str, - # Handle cases where encoding is passed as str *positionally* - encoding: str, - standalone: bool | None = None, - ) -> bytes: ... - @overload - def toprettyxml( - self, - indent: str = "\t", - newl: str = "\n", - # Handle all cases where encoding is passed as a keyword argument; because standalone - # comes after, it will also have to be a keyword arg if encoding is - *, - encoding: str, - standalone: bool | None = None, - ) -> bytes: ... - else: - @overload - def toxml(self, encoding: str) -> bytes: ... - @overload - def toxml(self, encoding: None = None) -> str: ... - @overload - def toprettyxml( - self, - indent: str = "\t", - newl: str = "\n", - # Handle any case where encoding is not provided or where it is passed with None - encoding: None = None, - ) -> str: ... - @overload - def toprettyxml( - self, - indent: str, - newl: str, - # Handle cases where encoding is passed as str *positionally* - encoding: str, - ) -> bytes: ... - @overload - def toprettyxml( - self, - indent: str = "\t", - newl: str = "\n", - # Handle all cases where encoding is passed as a keyword argument - *, - encoding: str, - ) -> bytes: ... - - def hasChildNodes(self) -> bool: ... - def insertBefore(self, newChild, refChild): ... - def appendChild(self, node: _N) -> _N: ... - def replaceChild(self, newChild, oldChild): ... - def removeChild(self, oldChild): ... - def normalize(self) -> None: ... - def cloneNode(self, deep): ... - def isSupported(self, feature, version): ... - def isSameNode(self, other): ... - def getInterface(self, feature): ... - def getUserData(self, key): ... - def setUserData(self, key, data, handler): ... - childNodes: Incomplete - def unlink(self) -> None: ... - def __enter__(self) -> Self: ... - def __exit__(self, et, ev, tb) -> None: ... - -class DocumentFragment(Node): - nodeType: int - nodeName: str - nodeValue: Incomplete - attributes: Incomplete - parentNode: Incomplete - childNodes: Incomplete - def __init__(self) -> None: ... - -class Attr(Node): - name: str - nodeType: int - attributes: Incomplete - specified: bool - ownerElement: Incomplete - namespaceURI: str | None - childNodes: Incomplete - nodeName: Incomplete - nodeValue: str - value: str - prefix: Incomplete - def __init__( - self, qName: str, namespaceURI: str | None = None, localName: str | None = None, prefix: Incomplete | None = None - ) -> None: ... - def unlink(self) -> None: ... - @property - def isId(self) -> bool: ... - @property - def schemaType(self): ... - -class NamedNodeMap: - def __init__(self, attrs, attrsNS, ownerElement) -> None: ... - def item(self, index): ... - def items(self): ... - def itemsNS(self): ... - def __contains__(self, key): ... - def keys(self): ... - def keysNS(self): ... - def values(self): ... - def get(self, name: str, value: Incomplete | None = None): ... - def __len__(self) -> int: ... - def __eq__(self, other: object) -> bool: ... - def __ge__(self, other: NamedNodeMap) -> bool: ... - def __gt__(self, other: NamedNodeMap) -> bool: ... - def __le__(self, other: NamedNodeMap) -> bool: ... - def __lt__(self, other: NamedNodeMap) -> bool: ... - def __getitem__(self, attname_or_tuple: tuple[str, str | None] | str): ... - def __setitem__(self, attname: str, value: Attr | str) -> None: ... - def getNamedItem(self, name: str) -> Attr | None: ... - def getNamedItemNS(self, namespaceURI: str, localName: str | None) -> Attr | None: ... - def removeNamedItem(self, name: str) -> Attr: ... - def removeNamedItemNS(self, namespaceURI: str, localName: str | None): ... - def setNamedItem(self, node: Attr) -> Attr: ... - def setNamedItemNS(self, node: Attr) -> Attr: ... - def __delitem__(self, attname_or_tuple: tuple[str, str | None] | str) -> None: ... - @property - def length(self) -> int: ... - -AttributeList = NamedNodeMap - -class TypeInfo: - namespace: Incomplete | None - name: str - def __init__(self, namespace: Incomplete | None, name: str) -> None: ... - -class Element(Node): - nodeType: int - nodeValue: Incomplete - schemaType: Incomplete - parentNode: Incomplete - tagName: str - nodeName: str - prefix: Incomplete - namespaceURI: str | None - childNodes: Incomplete - nextSibling: Incomplete - def __init__( - self, tagName, namespaceURI: str | None = None, prefix: Incomplete | None = None, localName: Incomplete | None = None - ) -> None: ... - def unlink(self) -> None: ... - def getAttribute(self, attname: str) -> str: ... - def getAttributeNS(self, namespaceURI: str, localName): ... - def setAttribute(self, attname: str, value: str) -> None: ... - def setAttributeNS(self, namespaceURI: str, qualifiedName: str, value) -> None: ... - def getAttributeNode(self, attrname: str): ... - def getAttributeNodeNS(self, namespaceURI: str, localName): ... - def setAttributeNode(self, attr): ... - setAttributeNodeNS: Incomplete - def removeAttribute(self, name: str) -> None: ... - def removeAttributeNS(self, namespaceURI: str, localName) -> None: ... - def removeAttributeNode(self, node): ... - removeAttributeNodeNS: Incomplete - def hasAttribute(self, name: str) -> bool: ... - def hasAttributeNS(self, namespaceURI: str, localName) -> bool: ... - def getElementsByTagName(self, name: str) -> NodeList[Element]: ... - def getElementsByTagNameNS(self, namespaceURI: str, localName: str) -> NodeList[Element]: ... - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - def hasAttributes(self) -> bool: ... - def setIdAttribute(self, name) -> None: ... - def setIdAttributeNS(self, namespaceURI: str, localName) -> None: ... - def setIdAttributeNode(self, idAttr) -> None: ... - @property - def attributes(self) -> NamedNodeMap: ... - -class Childless: - attributes: Incomplete - childNodes: Incomplete - firstChild: Incomplete - lastChild: Incomplete - def appendChild(self, node) -> NoReturn: ... - def hasChildNodes(self) -> bool: ... - def insertBefore(self, newChild, refChild) -> NoReturn: ... - def removeChild(self, oldChild) -> NoReturn: ... - def normalize(self) -> None: ... - def replaceChild(self, newChild, oldChild) -> NoReturn: ... - -class ProcessingInstruction(Childless, Node): - nodeType: int - target: Incomplete - data: Incomplete - def __init__(self, target, data) -> None: ... - nodeValue: Incomplete - nodeName: Incomplete - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - -class CharacterData(Childless, Node): - ownerDocument: Incomplete - previousSibling: Incomplete - def __init__(self) -> None: ... - def __len__(self) -> int: ... - data: str - nodeValue: Incomplete - def substringData(self, offset: int, count: int) -> str: ... - def appendData(self, arg: str) -> None: ... - def insertData(self, offset: int, arg: str) -> None: ... - def deleteData(self, offset: int, count: int) -> None: ... - def replaceData(self, offset: int, count: int, arg: str) -> None: ... - @property - def length(self) -> int: ... - -class Text(CharacterData): - nodeType: int - nodeName: str - attributes: Incomplete - data: Incomplete - def splitText(self, offset: int) -> Self: ... - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - def replaceWholeText(self, content) -> Self | None: ... - @property - def isWhitespaceInElementContent(self) -> bool: ... - @property - def wholeText(self) -> str: ... - -class Comment(CharacterData): - nodeType: int - nodeName: str - def __init__(self, data) -> None: ... - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - -class CDATASection(Text): - nodeType: int - nodeName: str - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - -class ReadOnlySequentialNamedNodeMap: - def __init__(self, seq=()) -> None: ... - def __len__(self) -> int: ... - def getNamedItem(self, name): ... - def getNamedItemNS(self, namespaceURI: str, localName): ... - def __getitem__(self, name_or_tuple): ... - def item(self, index): ... - def removeNamedItem(self, name) -> None: ... - def removeNamedItemNS(self, namespaceURI: str, localName) -> None: ... - def setNamedItem(self, node) -> None: ... - def setNamedItemNS(self, node) -> None: ... - @property - def length(self) -> int: ... - -class Identified: - publicId: Incomplete - systemId: Incomplete - -class DocumentType(Identified, Childless, Node): - nodeType: int - nodeValue: Incomplete - name: Incomplete - internalSubset: Incomplete - entities: Incomplete - notations: Incomplete - nodeName: Incomplete - def __init__(self, qualifiedName: str) -> None: ... - def cloneNode(self, deep): ... - def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... - -class Entity(Identified, Node): - attributes: Incomplete - nodeType: int - nodeValue: Incomplete - actualEncoding: Incomplete - encoding: Incomplete - version: Incomplete - nodeName: Incomplete - notationName: Incomplete - childNodes: Incomplete - def __init__(self, name, publicId, systemId, notation) -> None: ... - def appendChild(self, newChild) -> NoReturn: ... - def insertBefore(self, newChild, refChild) -> NoReturn: ... - def removeChild(self, oldChild) -> NoReturn: ... - def replaceChild(self, newChild, oldChild) -> NoReturn: ... - -class Notation(Identified, Childless, Node): - nodeType: int - nodeValue: Incomplete - nodeName: Incomplete - def __init__(self, name, publicId, systemId) -> None: ... - -class DOMImplementation(DOMImplementationLS): - def hasFeature(self, feature: str, version: str | None) -> bool: ... - def createDocument(self, namespaceURI: str | None, qualifiedName: str | None, doctype: DocumentType | None) -> Document: ... - def createDocumentType(self, qualifiedName: str | None, publicId: str, systemId: str) -> DocumentType: ... - def getInterface(self, feature: str) -> Self | None: ... - -class ElementInfo: - tagName: Incomplete - def __init__(self, name) -> None: ... - def getAttributeType(self, aname): ... - def getAttributeTypeNS(self, namespaceURI: str, localName): ... - def isElementContent(self): ... - def isEmpty(self): ... - def isId(self, aname): ... - def isIdNS(self, namespaceURI: str, localName): ... - -class Document(Node, DocumentLS): - implementation: Incomplete - nodeType: int - nodeName: str - nodeValue: Incomplete - attributes: Incomplete - parentNode: Incomplete - previousSibling: Incomplete - nextSibling: Incomplete - actualEncoding: Incomplete - encoding: str | None - standalone: bool | None - version: Incomplete - strictErrorChecking: bool - errorHandler: Incomplete - documentURI: Incomplete - doctype: DocumentType | None - childNodes: Incomplete - def __init__(self) -> None: ... - def appendChild(self, node: _N) -> _N: ... - documentElement: Incomplete - def removeChild(self, oldChild): ... - def unlink(self) -> None: ... - def cloneNode(self, deep): ... - def createDocumentFragment(self) -> DocumentFragment: ... - def createElement(self, tagName: str) -> Element: ... - def createTextNode(self, data: str) -> Text: ... - def createCDATASection(self, data: str) -> CDATASection: ... - def createComment(self, data: str) -> Comment: ... - def createProcessingInstruction(self, target, data): ... - def createAttribute(self, qName) -> Attr: ... - def createElementNS(self, namespaceURI: str, qualifiedName: str): ... - def createAttributeNS(self, namespaceURI: str, qualifiedName: str) -> Attr: ... - def getElementById(self, id: str) -> Element | None: ... - def getElementsByTagName(self, name: str) -> NodeList[Element]: ... - def getElementsByTagNameNS(self, namespaceURI: str, localName: str) -> NodeList[Element]: ... - def isSupported(self, feature: str, version: str | None) -> bool: ... - def importNode(self, node, deep): ... - if sys.version_info >= (3, 9): - def writexml( - self, - writer: SupportsWrite[str], - indent: str = "", - addindent: str = "", - newl: str = "", - encoding: str | None = None, - standalone: bool | None = None, - ) -> None: ... - else: - def writexml( - self, - writer: SupportsWrite[str], - indent: str = "", - addindent: str = "", - newl: str = "", - encoding: Incomplete | None = None, - ) -> None: ... - - def renameNode(self, n, namespaceURI: str, name): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi deleted file mode 100644 index 50250de5cb2f6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi +++ /dev/null @@ -1,94 +0,0 @@ -import sys -from _typeshed import Incomplete, SupportsRead -from collections.abc import Sequence -from typing import Final, Literal -from typing_extensions import TypeAlias -from xml.dom.minidom import Document, DOMImplementation, Element, Text -from xml.sax.handler import ContentHandler -from xml.sax.xmlreader import XMLReader - -START_ELEMENT: Final = "START_ELEMENT" -END_ELEMENT: Final = "END_ELEMENT" -COMMENT: Final = "COMMENT" -START_DOCUMENT: Final = "START_DOCUMENT" -END_DOCUMENT: Final = "END_DOCUMENT" -PROCESSING_INSTRUCTION: Final = "PROCESSING_INSTRUCTION" -IGNORABLE_WHITESPACE: Final = "IGNORABLE_WHITESPACE" -CHARACTERS: Final = "CHARACTERS" - -_DocumentFactory: TypeAlias = DOMImplementation | None -_Node: TypeAlias = Document | Element | Text - -_Event: TypeAlias = tuple[ - Literal[ - Literal["START_ELEMENT"], - Literal["END_ELEMENT"], - Literal["COMMENT"], - Literal["START_DOCUMENT"], - Literal["END_DOCUMENT"], - Literal["PROCESSING_INSTRUCTION"], - Literal["IGNORABLE_WHITESPACE"], - Literal["CHARACTERS"], - ], - _Node, -] - -class PullDOM(ContentHandler): - document: Document | None - documentFactory: _DocumentFactory - firstEvent: Incomplete - lastEvent: Incomplete - elementStack: Sequence[Incomplete] - pending_events: Sequence[Incomplete] - def __init__(self, documentFactory: _DocumentFactory = None) -> None: ... - def pop(self) -> Element: ... - def setDocumentLocator(self, locator) -> None: ... - def startPrefixMapping(self, prefix, uri) -> None: ... - def endPrefixMapping(self, prefix) -> None: ... - def startElementNS(self, name, tagName, attrs) -> None: ... - def endElementNS(self, name, tagName) -> None: ... - def startElement(self, name, attrs) -> None: ... - def endElement(self, name) -> None: ... - def comment(self, s) -> None: ... - def processingInstruction(self, target, data) -> None: ... - def ignorableWhitespace(self, chars) -> None: ... - def characters(self, chars) -> None: ... - def startDocument(self) -> None: ... - def buildDocument(self, uri, tagname): ... - def endDocument(self) -> None: ... - def clear(self) -> None: ... - -class ErrorHandler: - def warning(self, exception) -> None: ... - def error(self, exception) -> None: ... - def fatalError(self, exception) -> None: ... - -class DOMEventStream: - stream: SupportsRead[bytes] | SupportsRead[str] - parser: XMLReader - bufsize: int - def __init__(self, stream: SupportsRead[bytes] | SupportsRead[str], parser: XMLReader, bufsize: int) -> None: ... - pulldom: Incomplete - if sys.version_info < (3, 11): - def __getitem__(self, pos): ... - - def __next__(self): ... - def __iter__(self): ... - def getEvent(self) -> _Event: ... - def expandNode(self, node: _Node) -> None: ... - def reset(self) -> None: ... - def clear(self) -> None: ... - -class SAX2DOM(PullDOM): - def startElementNS(self, name, tagName, attrs) -> None: ... - def startElement(self, name, attrs) -> None: ... - def processingInstruction(self, target, data) -> None: ... - def ignorableWhitespace(self, chars) -> None: ... - def characters(self, chars) -> None: ... - -default_bufsize: int - -def parse( - stream_or_string: str | SupportsRead[bytes] | SupportsRead[str], parser: XMLReader | None = None, bufsize: int | None = None -) -> DOMEventStream: ... -def parseString(string: str, parser: XMLReader | None = None) -> DOMEventStream: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi deleted file mode 100644 index ab76d362e23f7..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi +++ /dev/null @@ -1,108 +0,0 @@ -from _typeshed import Incomplete, Unused -from typing import Any, Literal, NoReturn -from typing_extensions import TypeAlias -from urllib.request import OpenerDirector -from xml.dom.expatbuilder import ExpatBuilder, ExpatBuilderNS -from xml.dom.minidom import Node - -__all__ = ["DOMBuilder", "DOMEntityResolver", "DOMInputSource"] - -# UNKNOWN TYPES: -# - `Options.errorHandler`. -# The same as `_DOMBuilderErrorHandlerType`? -# Maybe `xml.sax.handler.ErrorHandler`? -# - Return type of DOMBuilder.getFeature(). -# We could get rid of the `Incomplete` if we knew more -# about `Options.errorHandler`. - -# ALIASES REPRESENTING MORE UNKNOWN TYPES: - -# probably the same as `Options.errorHandler`? -# Maybe `xml.sax.handler.ErrorHandler`? -_DOMBuilderErrorHandlerType: TypeAlias = Incomplete | None -# probably some kind of IO... -_DOMInputSourceCharacterStreamType: TypeAlias = Incomplete | None -# probably a string?? -_DOMInputSourceStringDataType: TypeAlias = Incomplete | None -# probably a string?? -_DOMInputSourceEncodingType: TypeAlias = Incomplete | None - -class Options: - namespaces: int - namespace_declarations: bool - validation: bool - external_parameter_entities: bool - external_general_entities: bool - external_dtd_subset: bool - validate_if_schema: bool - validate: bool - datatype_normalization: bool - create_entity_ref_nodes: bool - entities: bool - whitespace_in_element_content: bool - cdata_sections: bool - comments: bool - charset_overrides_xml_encoding: bool - infoset: bool - supported_mediatypes_only: bool - errorHandler: Any | None - filter: DOMBuilderFilter | None # a guess, but seems likely - -class DOMBuilder: - entityResolver: DOMEntityResolver | None # a guess, but seems likely - errorHandler: _DOMBuilderErrorHandlerType - filter: DOMBuilderFilter | None # a guess, but seems likely - ACTION_REPLACE: Literal[1] - ACTION_APPEND_AS_CHILDREN: Literal[2] - ACTION_INSERT_AFTER: Literal[3] - ACTION_INSERT_BEFORE: Literal[4] - def setFeature(self, name: str, state: int) -> None: ... - def supportsFeature(self, name: str) -> bool: ... - def canSetFeature(self, name: str, state: int) -> bool: ... - # getFeature could return any attribute from an instance of `Options` - def getFeature(self, name: str) -> Any: ... - def parseURI(self, uri: str) -> ExpatBuilder | ExpatBuilderNS: ... - def parse(self, input: DOMInputSource) -> ExpatBuilder | ExpatBuilderNS: ... - # `input` and `cnode` argtypes for `parseWithContext` are unknowable - # as the function does nothing with them, and always raises an exception. - # But `input` is *probably* `DOMInputSource`? - def parseWithContext(self, input: Unused, cnode: Unused, action: Literal[1, 2, 3, 4]) -> NoReturn: ... - -class DOMEntityResolver: - def resolveEntity(self, publicId: str | None, systemId: str) -> DOMInputSource: ... - -class DOMInputSource: - byteStream: OpenerDirector | None - characterStream: _DOMInputSourceCharacterStreamType - stringData: _DOMInputSourceStringDataType - encoding: _DOMInputSourceEncodingType - publicId: str | None - systemId: str | None - baseURI: str | None - -class DOMBuilderFilter: - FILTER_ACCEPT: Literal[1] - FILTER_REJECT: Literal[2] - FILTER_SKIP: Literal[3] - FILTER_INTERRUPT: Literal[4] - whatToShow: int - def acceptNode(self, element: Unused) -> Literal[1]: ... - def startContainer(self, element: Unused) -> Literal[1]: ... - -class DocumentLS: - async_: bool - def abort(self) -> NoReturn: ... - # `load()` and `loadXML()` always raise exceptions - # so the argtypes of `uri` and `source` are unknowable. - # `source` is *probably* `DOMInputSource`? - # `uri` is *probably* a str? (see DOMBuilder.parseURI()) - def load(self, uri: Unused) -> NoReturn: ... - def loadXML(self, source: Unused) -> NoReturn: ... - def saveXML(self, snode: Node | None) -> str: ... - -class DOMImplementationLS: - MODE_SYNCHRONOUS: Literal[1] - MODE_ASYNCHRONOUS: Literal[2] - def createDOMBuilder(self, mode: Literal[1], schemaType: None) -> DOMBuilder: ... - def createDOMWriter(self) -> NoReturn: ... - def createDOMInputSource(self) -> DOMInputSource: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi deleted file mode 100644 index 5a15772ec2a96..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi +++ /dev/null @@ -1,29 +0,0 @@ -import sys -from _typeshed import FileDescriptorOrPath -from collections.abc import Callable -from typing import Final -from xml.etree.ElementTree import Element - -XINCLUDE: Final[str] -XINCLUDE_INCLUDE: Final[str] -XINCLUDE_FALLBACK: Final[str] - -if sys.version_info >= (3, 9): - DEFAULT_MAX_INCLUSION_DEPTH: Final = 6 - -class FatalIncludeError(SyntaxError): ... - -def default_loader(href: FileDescriptorOrPath, parse: str, encoding: str | None = None) -> str | Element: ... - -# TODO: loader is of type default_loader ie it takes a callable that has the -# same signature as default_loader. But default_loader has a keyword argument -# Which can't be represented using Callable... -if sys.version_info >= (3, 9): - def include( - elem: Element, loader: Callable[..., str | Element] | None = None, base_url: str | None = None, max_depth: int | None = 6 - ) -> None: ... - - class LimitedRecursiveIncludeError(FatalIncludeError): ... - -else: - def include(elem: Element, loader: Callable[..., str | Element] | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi deleted file mode 100644 index c3f6207ea2411..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi +++ /dev/null @@ -1,34 +0,0 @@ -from collections.abc import Callable, Generator -from re import Pattern -from typing import TypeVar -from typing_extensions import TypeAlias -from xml.etree.ElementTree import Element - -xpath_tokenizer_re: Pattern[str] - -_Token: TypeAlias = tuple[str, str] -_Next: TypeAlias = Callable[[], _Token] -_Callback: TypeAlias = Callable[[_SelectorContext, list[Element]], Generator[Element, None, None]] - -def xpath_tokenizer(pattern: str, namespaces: dict[str, str] | None = None) -> Generator[_Token, None, None]: ... -def get_parent_map(context: _SelectorContext) -> dict[Element, Element]: ... -def prepare_child(next: _Next, token: _Token) -> _Callback: ... -def prepare_star(next: _Next, token: _Token) -> _Callback: ... -def prepare_self(next: _Next, token: _Token) -> _Callback: ... -def prepare_descendant(next: _Next, token: _Token) -> _Callback: ... -def prepare_parent(next: _Next, token: _Token) -> _Callback: ... -def prepare_predicate(next: _Next, token: _Token) -> _Callback: ... - -ops: dict[str, Callable[[_Next, _Token], _Callback]] - -class _SelectorContext: - parent_map: dict[Element, Element] | None - root: Element - def __init__(self, root: Element) -> None: ... - -_T = TypeVar("_T") - -def iterfind(elem: Element, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... -def find(elem: Element, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... -def findall(elem: Element, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... -def findtext(elem: Element, path: str, default: _T | None = None, namespaces: dict[str, str] | None = None) -> _T | str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi deleted file mode 100644 index 64ebbd3ee63f2..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi +++ /dev/null @@ -1,333 +0,0 @@ -import sys -from _collections_abc import dict_keys -from _typeshed import FileDescriptorOrPath, ReadableBuffer, SupportsRead, SupportsWrite -from collections.abc import Callable, Generator, ItemsView, Iterable, Iterator, Mapping, Sequence -from typing import Any, Final, Literal, SupportsIndex, TypeVar, overload -from typing_extensions import TypeAlias, TypeGuard, deprecated - -__all__ = [ - "C14NWriterTarget", - "Comment", - "dump", - "Element", - "ElementTree", - "canonicalize", - "fromstring", - "fromstringlist", - "iselement", - "iterparse", - "parse", - "ParseError", - "PI", - "ProcessingInstruction", - "QName", - "SubElement", - "tostring", - "tostringlist", - "TreeBuilder", - "VERSION", - "XML", - "XMLID", - "XMLParser", - "XMLPullParser", - "register_namespace", -] - -if sys.version_info >= (3, 9): - __all__ += ["indent"] - -_T = TypeVar("_T") -_FileRead: TypeAlias = FileDescriptorOrPath | SupportsRead[bytes] | SupportsRead[str] -_FileWriteC14N: TypeAlias = FileDescriptorOrPath | SupportsWrite[bytes] -_FileWrite: TypeAlias = _FileWriteC14N | SupportsWrite[str] - -VERSION: Final[str] - -class ParseError(SyntaxError): - code: int - position: tuple[int, int] - -# In reality it works based on `.tag` attribute duck typing. -def iselement(element: object) -> TypeGuard[Element]: ... -@overload -def canonicalize( - xml_data: str | ReadableBuffer | None = None, - *, - out: None = None, - from_file: _FileRead | None = None, - with_comments: bool = False, - strip_text: bool = False, - rewrite_prefixes: bool = False, - qname_aware_tags: Iterable[str] | None = None, - qname_aware_attrs: Iterable[str] | None = None, - exclude_attrs: Iterable[str] | None = None, - exclude_tags: Iterable[str] | None = None, -) -> str: ... -@overload -def canonicalize( - xml_data: str | ReadableBuffer | None = None, - *, - out: SupportsWrite[str], - from_file: _FileRead | None = None, - with_comments: bool = False, - strip_text: bool = False, - rewrite_prefixes: bool = False, - qname_aware_tags: Iterable[str] | None = None, - qname_aware_attrs: Iterable[str] | None = None, - exclude_attrs: Iterable[str] | None = None, - exclude_tags: Iterable[str] | None = None, -) -> None: ... - -class Element: - tag: str - attrib: dict[str, str] - text: str | None - tail: str | None - def __init__(self, tag: str, attrib: dict[str, str] = ..., **extra: str) -> None: ... - def append(self, subelement: Element, /) -> None: ... - def clear(self) -> None: ... - def extend(self, elements: Iterable[Element], /) -> None: ... - def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... - def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... - @overload - def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ... - @overload - def findtext(self, path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ... - @overload - def get(self, key: str, default: None = None) -> str | None: ... - @overload - def get(self, key: str, default: _T) -> str | _T: ... - def insert(self, index: int, subelement: Element, /) -> None: ... - def items(self) -> ItemsView[str, str]: ... - def iter(self, tag: str | None = None) -> Generator[Element, None, None]: ... - def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... - def itertext(self) -> Generator[str, None, None]: ... - def keys(self) -> dict_keys[str, str]: ... - # makeelement returns the type of self in Python impl, but not in C impl - def makeelement(self, tag: str, attrib: dict[str, str], /) -> Element: ... - def remove(self, subelement: Element, /) -> None: ... - def set(self, key: str, value: str, /) -> None: ... - def __copy__(self) -> Element: ... # returns the type of self in Python impl, but not in C impl - def __deepcopy__(self, memo: Any, /) -> Element: ... # Only exists in C impl - def __delitem__(self, key: SupportsIndex | slice, /) -> None: ... - @overload - def __getitem__(self, key: SupportsIndex, /) -> Element: ... - @overload - def __getitem__(self, key: slice, /) -> list[Element]: ... - def __len__(self) -> int: ... - # Doesn't actually exist at runtime, but instance of the class are indeed iterable due to __getitem__. - def __iter__(self) -> Iterator[Element]: ... - @overload - def __setitem__(self, key: SupportsIndex, value: Element, /) -> None: ... - @overload - def __setitem__(self, key: slice, value: Iterable[Element], /) -> None: ... - - # Doesn't really exist in earlier versions, where __len__ is called implicitly instead - @deprecated("Testing an element's truth value is deprecated.") - def __bool__(self) -> bool: ... - if sys.version_info < (3, 9): - def getchildren(self) -> list[Element]: ... - def getiterator(self, tag: str | None = None) -> list[Element]: ... - -def SubElement(parent: Element, tag: str, attrib: dict[str, str] = ..., **extra: str) -> Element: ... -def Comment(text: str | None = None) -> Element: ... -def ProcessingInstruction(target: str, text: str | None = None) -> Element: ... - -PI = ProcessingInstruction - -class QName: - text: str - def __init__(self, text_or_uri: str, tag: str | None = None) -> None: ... - def __lt__(self, other: QName | str) -> bool: ... - def __le__(self, other: QName | str) -> bool: ... - def __gt__(self, other: QName | str) -> bool: ... - def __ge__(self, other: QName | str) -> bool: ... - def __eq__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - -class ElementTree: - def __init__(self, element: Element | None = None, file: _FileRead | None = None) -> None: ... - def getroot(self) -> Element | Any: ... - def parse(self, source: _FileRead, parser: XMLParser | None = None) -> Element: ... - def iter(self, tag: str | None = None) -> Generator[Element, None, None]: ... - if sys.version_info < (3, 9): - def getiterator(self, tag: str | None = None) -> list[Element]: ... - - def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... - @overload - def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ... - @overload - def findtext(self, path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ... - def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... - def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... - def write( - self, - file_or_filename: _FileWrite, - encoding: str | None = None, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - method: str | None = None, - *, - short_empty_elements: bool = True, - ) -> None: ... - def write_c14n(self, file: _FileWriteC14N) -> None: ... - -def register_namespace(prefix: str, uri: str) -> None: ... -@overload -def tostring( - element: Element, - encoding: None = None, - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> bytes: ... -@overload -def tostring( - element: Element, - encoding: Literal["unicode"], - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> str: ... -@overload -def tostring( - element: Element, - encoding: str, - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> Any: ... -@overload -def tostringlist( - element: Element, - encoding: None = None, - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> list[bytes]: ... -@overload -def tostringlist( - element: Element, - encoding: Literal["unicode"], - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> list[str]: ... -@overload -def tostringlist( - element: Element, - encoding: str, - method: str | None = None, - *, - xml_declaration: bool | None = None, - default_namespace: str | None = None, - short_empty_elements: bool = True, -) -> list[Any]: ... -def dump(elem: Element) -> None: ... - -if sys.version_info >= (3, 9): - def indent(tree: Element | ElementTree, space: str = " ", level: int = 0) -> None: ... - -def parse(source: _FileRead, parser: XMLParser | None = None) -> ElementTree: ... - -class _IterParseIterator(Iterator[tuple[str, Any]]): - def __next__(self) -> tuple[str, Any]: ... - if sys.version_info >= (3, 13): - def close(self) -> None: ... - if sys.version_info >= (3, 11): - def __del__(self) -> None: ... - -def iterparse(source: _FileRead, events: Sequence[str] | None = None, parser: XMLParser | None = None) -> _IterParseIterator: ... - -class XMLPullParser: - def __init__(self, events: Sequence[str] | None = None, *, _parser: XMLParser | None = None) -> None: ... - def feed(self, data: str | ReadableBuffer) -> None: ... - def close(self) -> None: ... - # Second element in the tuple could be `Element`, `tuple[str, str]` or `None`. - # Use `Any` to avoid false-positive errors. - def read_events(self) -> Iterator[tuple[str, Any]]: ... - def flush(self) -> None: ... - -def XML(text: str | ReadableBuffer, parser: XMLParser | None = None) -> Element: ... -def XMLID(text: str | ReadableBuffer, parser: XMLParser | None = None) -> tuple[Element, dict[str, Element]]: ... - -# This is aliased to XML in the source. -fromstring = XML - -def fromstringlist(sequence: Sequence[str | ReadableBuffer], parser: XMLParser | None = None) -> Element: ... - -# This type is both not precise enough and too precise. The TreeBuilder -# requires the elementfactory to accept tag and attrs in its args and produce -# some kind of object that has .text and .tail properties. -# I've chosen to constrain the ElementFactory to always produce an Element -# because that is how almost everyone will use it. -# Unfortunately, the type of the factory arguments is dependent on how -# TreeBuilder is called by client code (they could pass strs, bytes or whatever); -# but we don't want to use a too-broad type, or it would be too hard to write -# elementfactories. -_ElementFactory: TypeAlias = Callable[[Any, dict[Any, Any]], Element] - -class TreeBuilder: - # comment_factory can take None because passing None to Comment is not an error - def __init__( - self, - element_factory: _ElementFactory | None = ..., - *, - comment_factory: Callable[[str | None], Element] | None = ..., - pi_factory: Callable[[str, str | None], Element] | None = ..., - insert_comments: bool = ..., - insert_pis: bool = ..., - ) -> None: ... - insert_comments: bool - insert_pis: bool - - def close(self) -> Element: ... - def data(self, data: str, /) -> None: ... - # tag and attrs are passed to the element_factory, so they could be anything - # depending on what the particular factory supports. - def start(self, tag: Any, attrs: dict[Any, Any], /) -> Element: ... - def end(self, tag: str, /) -> Element: ... - # These two methods have pos-only parameters in the C implementation - def comment(self, text: str | None, /) -> Element: ... - def pi(self, target: str, text: str | None = None, /) -> Element: ... - -class C14NWriterTarget: - def __init__( - self, - write: Callable[[str], object], - *, - with_comments: bool = False, - strip_text: bool = False, - rewrite_prefixes: bool = False, - qname_aware_tags: Iterable[str] | None = None, - qname_aware_attrs: Iterable[str] | None = None, - exclude_attrs: Iterable[str] | None = None, - exclude_tags: Iterable[str] | None = None, - ) -> None: ... - def data(self, data: str) -> None: ... - def start_ns(self, prefix: str, uri: str) -> None: ... - def start(self, tag: str, attrs: Mapping[str, str]) -> None: ... - def end(self, tag: str) -> None: ... - def comment(self, text: str) -> None: ... - def pi(self, target: str, data: str) -> None: ... - -class XMLParser: - parser: Any - target: Any - # TODO-what is entity used for??? - entity: Any - version: str - def __init__(self, *, target: Any = ..., encoding: str | None = ...) -> None: ... - def close(self) -> Any: ... - def feed(self, data: str | ReadableBuffer, /) -> None: ... - def flush(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi deleted file mode 100644 index 8a437a971f13b..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi +++ /dev/null @@ -1,19 +0,0 @@ -from typing import NoReturn -from xml.sax.xmlreader import Locator - -class SAXException(Exception): - def __init__(self, msg: str, exception: Exception | None = None) -> None: ... - def getMessage(self) -> str: ... - def getException(self) -> Exception: ... - def __getitem__(self, ix: object) -> NoReturn: ... - -class SAXParseException(SAXException): - def __init__(self, msg: str, exception: Exception | None, locator: Locator) -> None: ... - def getColumnNumber(self) -> int: ... - def getLineNumber(self) -> int: ... - def getPublicId(self): ... - def getSystemId(self): ... - -class SAXNotRecognizedException(SAXException): ... -class SAXNotSupportedException(SAXException): ... -class SAXReaderNotAvailable(SAXNotSupportedException): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi deleted file mode 100644 index 7b7c69048efd1..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi +++ /dev/null @@ -1,55 +0,0 @@ -import sys -from typing import NoReturn -from xml.sax import xmlreader - -version: str - -class ErrorHandler: - def error(self, exception: BaseException) -> NoReturn: ... - def fatalError(self, exception: BaseException) -> NoReturn: ... - def warning(self, exception: BaseException) -> None: ... - -class ContentHandler: - def setDocumentLocator(self, locator: xmlreader.Locator) -> None: ... - def startDocument(self) -> None: ... - def endDocument(self) -> None: ... - def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... - def endPrefixMapping(self, prefix: str | None) -> None: ... - def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... - def endElement(self, name: str) -> None: ... - def startElementNS(self, name: tuple[str, str], qname: str, attrs: xmlreader.AttributesNSImpl) -> None: ... - def endElementNS(self, name: tuple[str, str], qname: str) -> None: ... - def characters(self, content: str) -> None: ... - def ignorableWhitespace(self, whitespace: str) -> None: ... - def processingInstruction(self, target: str, data: str) -> None: ... - def skippedEntity(self, name: str) -> None: ... - -class DTDHandler: - def notationDecl(self, name, publicId, systemId): ... - def unparsedEntityDecl(self, name, publicId, systemId, ndata): ... - -class EntityResolver: - def resolveEntity(self, publicId, systemId): ... - -feature_namespaces: str -feature_namespace_prefixes: str -feature_string_interning: str -feature_validation: str -feature_external_ges: str -feature_external_pes: str -all_features: list[str] -property_lexical_handler: str -property_declaration_handler: str -property_dom_node: str -property_xml_string: str -property_encoding: str -property_interning_dict: str -all_properties: list[str] - -if sys.version_info >= (3, 10): - class LexicalHandler: - def comment(self, content: str) -> object: ... - def startDTD(self, name: str, public_id: str | None, system_id: str | None) -> object: ... - def endDTD(self) -> object: ... - def startCDATA(self) -> object: ... - def endCDATA(self) -> object: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi deleted file mode 100644 index 528f359639471..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi +++ /dev/null @@ -1,60 +0,0 @@ -from _typeshed import SupportsWrite -from codecs import StreamReaderWriter, StreamWriter -from collections.abc import Mapping -from io import RawIOBase, TextIOBase -from xml.sax import _Source, handler, xmlreader - -def escape(data: str, entities: Mapping[str, str] = {}) -> str: ... -def unescape(data: str, entities: Mapping[str, str] = {}) -> str: ... -def quoteattr(data: str, entities: Mapping[str, str] = {}) -> str: ... - -class XMLGenerator(handler.ContentHandler): - def __init__( - self, - out: TextIOBase | RawIOBase | StreamWriter | StreamReaderWriter | SupportsWrite[bytes] | None = None, - encoding: str = "iso-8859-1", - short_empty_elements: bool = False, - ) -> None: ... - def startDocument(self) -> None: ... - def endDocument(self) -> None: ... - def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... - def endPrefixMapping(self, prefix: str | None) -> None: ... - def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... - def endElement(self, name: str) -> None: ... - def startElementNS(self, name: tuple[str, str], qname: str, attrs: xmlreader.AttributesNSImpl) -> None: ... - def endElementNS(self, name: tuple[str, str], qname: str) -> None: ... - def characters(self, content: str) -> None: ... - def ignorableWhitespace(self, content: str) -> None: ... - def processingInstruction(self, target: str, data: str) -> None: ... - -class XMLFilterBase(xmlreader.XMLReader): - def __init__(self, parent: xmlreader.XMLReader | None = None) -> None: ... - def error(self, exception): ... - def fatalError(self, exception): ... - def warning(self, exception): ... - def setDocumentLocator(self, locator: xmlreader.Locator) -> None: ... - def startDocument(self) -> None: ... - def endDocument(self) -> None: ... - def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... - def endPrefixMapping(self, prefix: str | None) -> None: ... - def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... - def endElement(self, name: str) -> None: ... - def startElementNS(self, name: tuple[str, str], qname: str, attrs: xmlreader.AttributesNSImpl) -> None: ... - def endElementNS(self, name: tuple[str, str], qname: str) -> None: ... - def characters(self, content: str) -> None: ... - def ignorableWhitespace(self, chars: str) -> None: ... - def processingInstruction(self, target: str, data: str) -> None: ... - def skippedEntity(self, name: str) -> None: ... - def notationDecl(self, name, publicId, systemId): ... - def unparsedEntityDecl(self, name, publicId, systemId, ndata): ... - def resolveEntity(self, publicId, systemId): ... - def parse(self, source: _Source) -> None: ... - def setLocale(self, locale): ... - def getFeature(self, name: str) -> object: ... - def setFeature(self, name: str, state: object) -> None: ... - def getProperty(self, name: str) -> object: ... - def setProperty(self, name: str, value: object) -> None: ... - def getParent(self) -> xmlreader.XMLReader: ... - def setParent(self, parent: xmlreader.XMLReader) -> None: ... - -def prepare_input_source(source, base=""): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi deleted file mode 100644 index 2ccbc95bbef02..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi +++ /dev/null @@ -1,87 +0,0 @@ -from collections.abc import Mapping -from typing import overload -from typing_extensions import Self, TypeAlias -from xml.sax.handler import ContentHandler, DTDHandler, EntityResolver, ErrorHandler - -class XMLReader: - def parse(self, source): ... - def getContentHandler(self) -> ContentHandler: ... - def setContentHandler(self, handler: ContentHandler) -> None: ... - def getDTDHandler(self) -> DTDHandler: ... - def setDTDHandler(self, handler: DTDHandler) -> None: ... - def getEntityResolver(self) -> EntityResolver: ... - def setEntityResolver(self, resolver: EntityResolver) -> None: ... - def getErrorHandler(self) -> ErrorHandler: ... - def setErrorHandler(self, handler: ErrorHandler) -> None: ... - def setLocale(self, locale): ... - def getFeature(self, name: str) -> object: ... - def setFeature(self, name: str, state: object) -> None: ... - def getProperty(self, name: str) -> object: ... - def setProperty(self, name: str, value: object) -> None: ... - -class IncrementalParser(XMLReader): - def __init__(self, bufsize: int = 65536) -> None: ... - def parse(self, source): ... - def feed(self, data): ... - def prepareParser(self, source): ... - def close(self): ... - def reset(self): ... - -class Locator: - def getColumnNumber(self): ... - def getLineNumber(self): ... - def getPublicId(self): ... - def getSystemId(self): ... - -class InputSource: - def __init__(self, system_id: str | None = None) -> None: ... - def setPublicId(self, public_id): ... - def getPublicId(self): ... - def setSystemId(self, system_id): ... - def getSystemId(self): ... - def setEncoding(self, encoding): ... - def getEncoding(self): ... - def setByteStream(self, bytefile): ... - def getByteStream(self): ... - def setCharacterStream(self, charfile): ... - def getCharacterStream(self): ... - -class AttributesImpl: - def __init__(self, attrs: Mapping[str, str]) -> None: ... - def getLength(self) -> int: ... - def getType(self, name: str) -> str: ... - def getValue(self, name: str) -> str: ... - def getValueByQName(self, name: str) -> str: ... - def getNameByQName(self, name: str) -> str: ... - def getQNameByName(self, name: str) -> str: ... - def getNames(self) -> list[str]: ... - def getQNames(self) -> list[str]: ... - def __len__(self) -> int: ... - def __getitem__(self, name: str) -> str: ... - def keys(self) -> list[str]: ... - def __contains__(self, name: str) -> bool: ... - @overload - def get(self, name: str, alternative: None = None) -> str | None: ... - @overload - def get(self, name: str, alternative: str) -> str: ... - def copy(self) -> Self: ... - def items(self) -> list[tuple[str, str]]: ... - def values(self) -> list[str]: ... - -_NSName: TypeAlias = tuple[str | None, str] - -class AttributesNSImpl(AttributesImpl): - def __init__(self, attrs: Mapping[_NSName, str], qnames: Mapping[_NSName, str]) -> None: ... - def getType(self, name: _NSName) -> str: ... # type: ignore[override] - def getValue(self, name: _NSName) -> str: ... # type: ignore[override] - def getNameByQName(self, name: str) -> _NSName: ... # type: ignore[override] - def getQNameByName(self, name: _NSName) -> str: ... # type: ignore[override] - def getNames(self) -> list[_NSName]: ... # type: ignore[override] - def __getitem__(self, name: _NSName) -> str: ... # type: ignore[override] - def keys(self) -> list[_NSName]: ... # type: ignore[override] - def __contains__(self, name: _NSName) -> bool: ... # type: ignore[override] - @overload # type: ignore[override] - def get(self, name: _NSName, alternative: None = None) -> str | None: ... - @overload - def get(self, name: _NSName, alternative: str) -> str: ... - def items(self) -> list[tuple[_NSName, str]]: ... # type: ignore[override] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi deleted file mode 100644 index 5899d1d72a389..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi +++ /dev/null @@ -1,296 +0,0 @@ -import gzip -import http.client -import time -from _typeshed import ReadableBuffer, SizedBuffer, SupportsRead, SupportsWrite -from collections.abc import Callable, Iterable, Mapping -from datetime import datetime -from io import BytesIO -from types import TracebackType -from typing import Any, Final, Literal, Protocol, overload -from typing_extensions import Self, TypeAlias - -class _SupportsTimeTuple(Protocol): - def timetuple(self) -> time.struct_time: ... - -_DateTimeComparable: TypeAlias = DateTime | datetime | str | _SupportsTimeTuple -_Marshallable: TypeAlias = ( - bool - | int - | float - | str - | bytes - | bytearray - | None - | tuple[_Marshallable, ...] - # Ideally we'd use _Marshallable for list and dict, but invariance makes that impractical - | list[Any] - | dict[str, Any] - | datetime - | DateTime - | Binary -) -_XMLDate: TypeAlias = int | datetime | tuple[int, ...] | time.struct_time -_HostType: TypeAlias = tuple[str, dict[str, str]] | str - -def escape(s: str) -> str: ... # undocumented - -MAXINT: Final[int] # undocumented -MININT: Final[int] # undocumented - -PARSE_ERROR: Final[int] # undocumented -SERVER_ERROR: Final[int] # undocumented -APPLICATION_ERROR: Final[int] # undocumented -SYSTEM_ERROR: Final[int] # undocumented -TRANSPORT_ERROR: Final[int] # undocumented - -NOT_WELLFORMED_ERROR: Final[int] # undocumented -UNSUPPORTED_ENCODING: Final[int] # undocumented -INVALID_ENCODING_CHAR: Final[int] # undocumented -INVALID_XMLRPC: Final[int] # undocumented -METHOD_NOT_FOUND: Final[int] # undocumented -INVALID_METHOD_PARAMS: Final[int] # undocumented -INTERNAL_ERROR: Final[int] # undocumented - -class Error(Exception): ... - -class ProtocolError(Error): - url: str - errcode: int - errmsg: str - headers: dict[str, str] - def __init__(self, url: str, errcode: int, errmsg: str, headers: dict[str, str]) -> None: ... - -class ResponseError(Error): ... - -class Fault(Error): - faultCode: int - faultString: str - def __init__(self, faultCode: int, faultString: str, **extra: Any) -> None: ... - -boolean = bool -Boolean = bool - -def _iso8601_format(value: datetime) -> str: ... # undocumented -def _strftime(value: _XMLDate) -> str: ... # undocumented - -class DateTime: - value: str # undocumented - def __init__(self, value: int | str | datetime | time.struct_time | tuple[int, ...] = 0) -> None: ... - def __lt__(self, other: _DateTimeComparable) -> bool: ... - def __le__(self, other: _DateTimeComparable) -> bool: ... - def __gt__(self, other: _DateTimeComparable) -> bool: ... - def __ge__(self, other: _DateTimeComparable) -> bool: ... - def __eq__(self, other: _DateTimeComparable) -> bool: ... # type: ignore[override] - def make_comparable(self, other: _DateTimeComparable) -> tuple[str, str]: ... # undocumented - def timetuple(self) -> time.struct_time: ... # undocumented - def decode(self, data: Any) -> None: ... - def encode(self, out: SupportsWrite[str]) -> None: ... - -def _datetime(data: Any) -> DateTime: ... # undocumented -def _datetime_type(data: str) -> datetime: ... # undocumented - -class Binary: - data: bytes - def __init__(self, data: bytes | bytearray | None = None) -> None: ... - def decode(self, data: ReadableBuffer) -> None: ... - def encode(self, out: SupportsWrite[str]) -> None: ... - def __eq__(self, other: object) -> bool: ... - -def _binary(data: ReadableBuffer) -> Binary: ... # undocumented - -WRAPPERS: Final[tuple[type[DateTime], type[Binary]]] # undocumented - -class ExpatParser: # undocumented - def __init__(self, target: Unmarshaller) -> None: ... - def feed(self, data: str | ReadableBuffer) -> None: ... - def close(self) -> None: ... - -_WriteCallback: TypeAlias = Callable[[str], object] - -class Marshaller: - # TODO: Replace 'Any' with some kind of binding - dispatch: dict[type[Any], Callable[[Marshaller, Any, _WriteCallback], None]] - memo: dict[Any, None] - data: None - encoding: str | None - allow_none: bool - def __init__(self, encoding: str | None = None, allow_none: bool = False) -> None: ... - def dumps(self, values: Fault | Iterable[_Marshallable]) -> str: ... - def __dump(self, value: _Marshallable, write: _WriteCallback) -> None: ... # undocumented - def dump_nil(self, value: None, write: _WriteCallback) -> None: ... - def dump_bool(self, value: bool, write: _WriteCallback) -> None: ... - def dump_long(self, value: int, write: _WriteCallback) -> None: ... - def dump_int(self, value: int, write: _WriteCallback) -> None: ... - def dump_double(self, value: float, write: _WriteCallback) -> None: ... - def dump_unicode(self, value: str, write: _WriteCallback, escape: Callable[[str], str] = ...) -> None: ... - def dump_bytes(self, value: ReadableBuffer, write: _WriteCallback) -> None: ... - def dump_array(self, value: Iterable[_Marshallable], write: _WriteCallback) -> None: ... - def dump_struct( - self, value: Mapping[str, _Marshallable], write: _WriteCallback, escape: Callable[[str], str] = ... - ) -> None: ... - def dump_datetime(self, value: _XMLDate, write: _WriteCallback) -> None: ... - def dump_instance(self, value: object, write: _WriteCallback) -> None: ... - -class Unmarshaller: - dispatch: dict[str, Callable[[Unmarshaller, str], None]] - - _type: str | None - _stack: list[_Marshallable] - _marks: list[int] - _data: list[str] - _value: bool - _methodname: str | None - _encoding: str - append: Callable[[Any], None] - _use_datetime: bool - _use_builtin_types: bool - def __init__(self, use_datetime: bool = False, use_builtin_types: bool = False) -> None: ... - def close(self) -> tuple[_Marshallable, ...]: ... - def getmethodname(self) -> str | None: ... - def xml(self, encoding: str, standalone: Any) -> None: ... # Standalone is ignored - def start(self, tag: str, attrs: dict[str, str]) -> None: ... - def data(self, text: str) -> None: ... - def end(self, tag: str) -> None: ... - def end_dispatch(self, tag: str, data: str) -> None: ... - def end_nil(self, data: str) -> None: ... - def end_boolean(self, data: str) -> None: ... - def end_int(self, data: str) -> None: ... - def end_double(self, data: str) -> None: ... - def end_bigdecimal(self, data: str) -> None: ... - def end_string(self, data: str) -> None: ... - def end_array(self, data: str) -> None: ... - def end_struct(self, data: str) -> None: ... - def end_base64(self, data: str) -> None: ... - def end_dateTime(self, data: str) -> None: ... - def end_value(self, data: str) -> None: ... - def end_params(self, data: str) -> None: ... - def end_fault(self, data: str) -> None: ... - def end_methodName(self, data: str) -> None: ... - -class _MultiCallMethod: # undocumented - __call_list: list[tuple[str, tuple[_Marshallable, ...]]] - __name: str - def __init__(self, call_list: list[tuple[str, _Marshallable]], name: str) -> None: ... - def __getattr__(self, name: str) -> _MultiCallMethod: ... - def __call__(self, *args: _Marshallable) -> None: ... - -class MultiCallIterator: # undocumented - results: list[list[_Marshallable]] - def __init__(self, results: list[list[_Marshallable]]) -> None: ... - def __getitem__(self, i: int) -> _Marshallable: ... - -class MultiCall: - __server: ServerProxy - __call_list: list[tuple[str, tuple[_Marshallable, ...]]] - def __init__(self, server: ServerProxy) -> None: ... - def __getattr__(self, name: str) -> _MultiCallMethod: ... - def __call__(self) -> MultiCallIterator: ... - -# A little white lie -FastMarshaller: Marshaller | None -FastParser: ExpatParser | None -FastUnmarshaller: Unmarshaller | None - -def getparser(use_datetime: bool = False, use_builtin_types: bool = False) -> tuple[ExpatParser, Unmarshaller]: ... -def dumps( - params: Fault | tuple[_Marshallable, ...], - methodname: str | None = None, - methodresponse: bool | None = None, - encoding: str | None = None, - allow_none: bool = False, -) -> str: ... -def loads( - data: str | ReadableBuffer, use_datetime: bool = False, use_builtin_types: bool = False -) -> tuple[tuple[_Marshallable, ...], str | None]: ... -def gzip_encode(data: ReadableBuffer) -> bytes: ... # undocumented -def gzip_decode(data: ReadableBuffer, max_decode: int = 20971520) -> bytes: ... # undocumented - -class GzipDecodedResponse(gzip.GzipFile): # undocumented - io: BytesIO - def __init__(self, response: SupportsRead[ReadableBuffer]) -> None: ... - -class _Method: # undocumented - __send: Callable[[str, tuple[_Marshallable, ...]], _Marshallable] - __name: str - def __init__(self, send: Callable[[str, tuple[_Marshallable, ...]], _Marshallable], name: str) -> None: ... - def __getattr__(self, name: str) -> _Method: ... - def __call__(self, *args: _Marshallable) -> _Marshallable: ... - -class Transport: - user_agent: str - accept_gzip_encoding: bool - encode_threshold: int | None - - _use_datetime: bool - _use_builtin_types: bool - _connection: tuple[_HostType | None, http.client.HTTPConnection | None] - _headers: list[tuple[str, str]] - _extra_headers: list[tuple[str, str]] - - def __init__( - self, use_datetime: bool = False, use_builtin_types: bool = False, *, headers: Iterable[tuple[str, str]] = () - ) -> None: ... - def request( - self, host: _HostType, handler: str, request_body: SizedBuffer, verbose: bool = False - ) -> tuple[_Marshallable, ...]: ... - def single_request( - self, host: _HostType, handler: str, request_body: SizedBuffer, verbose: bool = False - ) -> tuple[_Marshallable, ...]: ... - def getparser(self) -> tuple[ExpatParser, Unmarshaller]: ... - def get_host_info(self, host: _HostType) -> tuple[str, list[tuple[str, str]], dict[str, str]]: ... - def make_connection(self, host: _HostType) -> http.client.HTTPConnection: ... - def close(self) -> None: ... - def send_request( - self, host: _HostType, handler: str, request_body: SizedBuffer, debug: bool - ) -> http.client.HTTPConnection: ... - def send_headers(self, connection: http.client.HTTPConnection, headers: list[tuple[str, str]]) -> None: ... - def send_content(self, connection: http.client.HTTPConnection, request_body: SizedBuffer) -> None: ... - def parse_response(self, response: http.client.HTTPResponse) -> tuple[_Marshallable, ...]: ... - -class SafeTransport(Transport): - def __init__( - self, - use_datetime: bool = False, - use_builtin_types: bool = False, - *, - headers: Iterable[tuple[str, str]] = (), - context: Any | None = None, - ) -> None: ... - def make_connection(self, host: _HostType) -> http.client.HTTPSConnection: ... - -class ServerProxy: - __host: str - __handler: str - __transport: Transport - __encoding: str - __verbose: bool - __allow_none: bool - - def __init__( - self, - uri: str, - transport: Transport | None = None, - encoding: str | None = None, - verbose: bool = False, - allow_none: bool = False, - use_datetime: bool = False, - use_builtin_types: bool = False, - *, - headers: Iterable[tuple[str, str]] = (), - context: Any | None = None, - ) -> None: ... - def __getattr__(self, name: str) -> _Method: ... - @overload - def __call__(self, attr: Literal["close"]) -> Callable[[], None]: ... - @overload - def __call__(self, attr: Literal["transport"]) -> Transport: ... - @overload - def __call__(self, attr: str) -> Callable[[], None] | Transport: ... - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None - ) -> None: ... - def __close(self) -> None: ... # undocumented - def __request(self, methodname: str, params: tuple[_Marshallable, ...]) -> tuple[_Marshallable, ...]: ... # undocumented - -Server = ServerProxy diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi deleted file mode 100644 index 5b8f02f61bce6..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi +++ /dev/null @@ -1,384 +0,0 @@ -import io -import sys -from _typeshed import SizedBuffer, StrOrBytesPath, StrPath -from collections.abc import Callable, Iterable, Iterator -from io import TextIOWrapper -from os import PathLike -from types import TracebackType -from typing import IO, Final, Literal, Protocol, overload -from typing_extensions import Self, TypeAlias - -__all__ = [ - "BadZipFile", - "BadZipfile", - "Path", - "error", - "ZIP_STORED", - "ZIP_DEFLATED", - "ZIP_BZIP2", - "ZIP_LZMA", - "is_zipfile", - "ZipInfo", - "ZipFile", - "PyZipFile", - "LargeZipFile", -] - -# TODO: use TypeAlias for these two when mypy bugs are fixed -# https://github.com/python/mypy/issues/16581 -_DateTuple = tuple[int, int, int, int, int, int] # noqa: Y026 -_ZipFileMode = Literal["r", "w", "x", "a"] # noqa: Y026 - -_ReadWriteMode: TypeAlias = Literal["r", "w"] -_ReadWriteBinaryMode: TypeAlias = Literal["r", "w", "rb", "wb"] - -class BadZipFile(Exception): ... - -BadZipfile = BadZipFile -error = BadZipfile - -class LargeZipFile(Exception): ... - -class _ZipStream(Protocol): - def read(self, n: int, /) -> bytes: ... - # The following methods are optional: - # def seekable(self) -> bool: ... - # def tell(self) -> int: ... - # def seek(self, n: int, /) -> object: ... - -# Stream shape as required by _EndRecData() and _EndRecData64(). -class _SupportsReadSeekTell(Protocol): - def read(self, n: int = ..., /) -> bytes: ... - def seek(self, cookie: int, whence: int, /) -> object: ... - def tell(self) -> int: ... - -class _ClosableZipStream(_ZipStream, Protocol): - def close(self) -> object: ... - -class ZipExtFile(io.BufferedIOBase): - MAX_N: int - MIN_READ_SIZE: int - MAX_SEEK_READ: int - newlines: list[bytes] | None - mode: _ReadWriteMode - name: str - @overload - def __init__( - self, fileobj: _ClosableZipStream, mode: _ReadWriteMode, zipinfo: ZipInfo, pwd: bytes | None, close_fileobj: Literal[True] - ) -> None: ... - @overload - def __init__( - self, - fileobj: _ClosableZipStream, - mode: _ReadWriteMode, - zipinfo: ZipInfo, - pwd: bytes | None = None, - *, - close_fileobj: Literal[True], - ) -> None: ... - @overload - def __init__( - self, - fileobj: _ZipStream, - mode: _ReadWriteMode, - zipinfo: ZipInfo, - pwd: bytes | None = None, - close_fileobj: Literal[False] = False, - ) -> None: ... - def read(self, n: int | None = -1) -> bytes: ... - def readline(self, limit: int = -1) -> bytes: ... # type: ignore[override] - def peek(self, n: int = 1) -> bytes: ... - def read1(self, n: int | None) -> bytes: ... # type: ignore[override] - def seek(self, offset: int, whence: int = 0) -> int: ... - -class _Writer(Protocol): - def write(self, s: str, /) -> object: ... - -class _ZipReadable(Protocol): - def seek(self, offset: int, whence: int = 0, /) -> int: ... - def read(self, n: int = -1, /) -> bytes: ... - -class _ZipTellable(Protocol): - def tell(self) -> int: ... - -class _ZipReadableTellable(_ZipReadable, _ZipTellable, Protocol): ... - -class _ZipWritable(Protocol): - def flush(self) -> None: ... - def close(self) -> None: ... - def write(self, b: bytes, /) -> int: ... - -class ZipFile: - filename: str | None - debug: int - comment: bytes - filelist: list[ZipInfo] - fp: IO[bytes] | None - NameToInfo: dict[str, ZipInfo] - start_dir: int # undocumented - compression: int # undocumented - compresslevel: int | None # undocumented - mode: _ZipFileMode # undocumented - pwd: bytes | None # undocumented - # metadata_encoding is new in 3.11 - if sys.version_info >= (3, 11): - @overload - def __init__( - self, - file: StrPath | IO[bytes], - mode: _ZipFileMode = "r", - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - metadata_encoding: str | None = None, - ) -> None: ... - # metadata_encoding is only allowed for read mode - @overload - def __init__( - self, - file: StrPath | _ZipReadable, - mode: Literal["r"] = "r", - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - metadata_encoding: str | None = None, - ) -> None: ... - @overload - def __init__( - self, - file: StrPath | _ZipWritable, - mode: Literal["w", "x"] = ..., - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - metadata_encoding: None = None, - ) -> None: ... - @overload - def __init__( - self, - file: StrPath | _ZipReadableTellable, - mode: Literal["a"] = ..., - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - metadata_encoding: None = None, - ) -> None: ... - else: - @overload - def __init__( - self, - file: StrPath | IO[bytes], - mode: _ZipFileMode = "r", - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - ) -> None: ... - @overload - def __init__( - self, - file: StrPath | _ZipReadable, - mode: Literal["r"] = "r", - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - ) -> None: ... - @overload - def __init__( - self, - file: StrPath | _ZipWritable, - mode: Literal["w", "x"] = ..., - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - ) -> None: ... - @overload - def __init__( - self, - file: StrPath | _ZipReadableTellable, - mode: Literal["a"] = ..., - compression: int = 0, - allowZip64: bool = True, - compresslevel: int | None = None, - *, - strict_timestamps: bool = True, - ) -> None: ... - - def __enter__(self) -> Self: ... - def __exit__( - self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> None: ... - def close(self) -> None: ... - def getinfo(self, name: str) -> ZipInfo: ... - def infolist(self) -> list[ZipInfo]: ... - def namelist(self) -> list[str]: ... - def open( - self, name: str | ZipInfo, mode: _ReadWriteMode = "r", pwd: bytes | None = None, *, force_zip64: bool = False - ) -> IO[bytes]: ... - def extract(self, member: str | ZipInfo, path: StrPath | None = None, pwd: bytes | None = None) -> str: ... - def extractall( - self, path: StrPath | None = None, members: Iterable[str | ZipInfo] | None = None, pwd: bytes | None = None - ) -> None: ... - def printdir(self, file: _Writer | None = None) -> None: ... - def setpassword(self, pwd: bytes) -> None: ... - def read(self, name: str | ZipInfo, pwd: bytes | None = None) -> bytes: ... - def testzip(self) -> str | None: ... - def write( - self, - filename: StrPath, - arcname: StrPath | None = None, - compress_type: int | None = None, - compresslevel: int | None = None, - ) -> None: ... - def writestr( - self, - zinfo_or_arcname: str | ZipInfo, - data: SizedBuffer | str, - compress_type: int | None = None, - compresslevel: int | None = None, - ) -> None: ... - if sys.version_info >= (3, 11): - def mkdir(self, zinfo_or_directory_name: str | ZipInfo, mode: int = 0o777) -> None: ... - - def __del__(self) -> None: ... - -class PyZipFile(ZipFile): - def __init__( - self, file: str | IO[bytes], mode: _ZipFileMode = "r", compression: int = 0, allowZip64: bool = True, optimize: int = -1 - ) -> None: ... - def writepy(self, pathname: str, basename: str = "", filterfunc: Callable[[str], bool] | None = None) -> None: ... - -class ZipInfo: - filename: str - date_time: _DateTuple - compress_type: int - comment: bytes - extra: bytes - create_system: int - create_version: int - extract_version: int - reserved: int - flag_bits: int - volume: int - internal_attr: int - external_attr: int - header_offset: int - CRC: int - compress_size: int - file_size: int - orig_filename: str # undocumented - if sys.version_info >= (3, 13): - compress_level: int | None - - def __init__(self, filename: str = "NoName", date_time: _DateTuple = (1980, 1, 1, 0, 0, 0)) -> None: ... - @classmethod - def from_file(cls, filename: StrPath, arcname: StrPath | None = None, *, strict_timestamps: bool = True) -> Self: ... - def is_dir(self) -> bool: ... - def FileHeader(self, zip64: bool | None = None) -> bytes: ... - -if sys.version_info >= (3, 12): - from zipfile._path import CompleteDirs as CompleteDirs, Path as Path - -else: - class CompleteDirs(ZipFile): - def resolve_dir(self, name: str) -> str: ... - @overload - @classmethod - def make(cls, source: ZipFile) -> CompleteDirs: ... - @overload - @classmethod - def make(cls, source: StrPath | IO[bytes]) -> Self: ... - - class Path: - root: CompleteDirs - at: str - def __init__(self, root: ZipFile | StrPath | IO[bytes], at: str = "") -> None: ... - @property - def name(self) -> str: ... - @property - def parent(self) -> PathLike[str]: ... # undocumented - if sys.version_info >= (3, 10): - @property - def filename(self) -> PathLike[str]: ... # undocumented - if sys.version_info >= (3, 11): - @property - def suffix(self) -> str: ... - @property - def suffixes(self) -> list[str]: ... - @property - def stem(self) -> str: ... - - if sys.version_info >= (3, 9): - @overload - def open( - self, - mode: Literal["r", "w"] = "r", - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - line_buffering: bool = ..., - write_through: bool = ..., - *, - pwd: bytes | None = None, - ) -> TextIOWrapper: ... - @overload - def open(self, mode: Literal["rb", "wb"], *, pwd: bytes | None = None) -> IO[bytes]: ... - else: - def open( - self, mode: _ReadWriteBinaryMode = "r", pwd: bytes | None = None, *, force_zip64: bool = False - ) -> IO[bytes]: ... - - if sys.version_info >= (3, 10): - def iterdir(self) -> Iterator[Self]: ... - else: - def iterdir(self) -> Iterator[Path]: ... - - def is_dir(self) -> bool: ... - def is_file(self) -> bool: ... - def exists(self) -> bool: ... - def read_text( - self, - encoding: str | None = ..., - errors: str | None = ..., - newline: str | None = ..., - line_buffering: bool = ..., - write_through: bool = ..., - ) -> str: ... - def read_bytes(self) -> bytes: ... - if sys.version_info >= (3, 10): - def joinpath(self, *other: StrPath) -> Path: ... - else: - def joinpath(self, add: StrPath) -> Path: ... # undocumented - if sys.version_info >= (3, 12): - def glob(self, pattern: str) -> Iterator[Self]: ... - def rglob(self, pattern: str) -> Iterator[Self]: ... - def is_symlink(self) -> Literal[False]: ... - def relative_to(self, other: Path, *extra: StrPath) -> str: ... - def match(self, path_pattern: str) -> bool: ... - def __eq__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - - def __truediv__(self, add: StrPath) -> Path: ... - -def is_zipfile(filename: StrOrBytesPath | _SupportsReadSeekTell) -> bool: ... - -ZIP_STORED: Final[int] -ZIP_DEFLATED: Final[int] -ZIP64_LIMIT: Final[int] -ZIP_FILECOUNT_LIMIT: Final[int] -ZIP_MAX_COMMENT: Final[int] -ZIP_BZIP2: Final[int] -ZIP_LZMA: Final[int] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/_path.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/_path.pyi deleted file mode 100644 index 933acf2c4803c..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipfile/_path.pyi +++ /dev/null @@ -1,101 +0,0 @@ -import sys -from _typeshed import StrPath -from collections.abc import Iterator, Sequence -from io import TextIOWrapper -from os import PathLike -from typing import IO, Literal, TypeVar, overload -from typing_extensions import Self, TypeAlias -from zipfile import ZipFile - -_ReadWriteBinaryMode: TypeAlias = Literal["r", "w", "rb", "wb"] - -_ZF = TypeVar("_ZF", bound=ZipFile) - -if sys.version_info >= (3, 12): - class InitializedState: - def __init__(self, *args: object, **kwargs: object) -> None: ... - def __getstate__(self) -> tuple[list[object], dict[object, object]]: ... - def __setstate__(self, state: Sequence[tuple[list[object], dict[object, object]]]) -> None: ... - - class CompleteDirs(InitializedState, ZipFile): - def resolve_dir(self, name: str) -> str: ... - @overload - @classmethod - def make(cls, source: ZipFile) -> CompleteDirs: ... - @overload - @classmethod - def make(cls, source: StrPath | IO[bytes]) -> Self: ... - if sys.version_info >= (3, 13): - @classmethod - def inject(cls, zf: _ZF) -> _ZF: ... - - class Path: - root: CompleteDirs - at: str - def __init__(self, root: ZipFile | StrPath | IO[bytes], at: str = "") -> None: ... - @property - def name(self) -> str: ... - @property - def parent(self) -> PathLike[str]: ... # undocumented - if sys.version_info >= (3, 10): - @property - def filename(self) -> PathLike[str]: ... # undocumented - if sys.version_info >= (3, 11): - @property - def suffix(self) -> str: ... - @property - def suffixes(self) -> list[str]: ... - @property - def stem(self) -> str: ... - - if sys.version_info >= (3, 9): - @overload - def open( - self, - mode: Literal["r", "w"] = "r", - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - line_buffering: bool = ..., - write_through: bool = ..., - *, - pwd: bytes | None = None, - ) -> TextIOWrapper: ... - @overload - def open(self, mode: Literal["rb", "wb"], *, pwd: bytes | None = None) -> IO[bytes]: ... - else: - def open( - self, mode: _ReadWriteBinaryMode = "r", pwd: bytes | None = None, *, force_zip64: bool = False - ) -> IO[bytes]: ... - - if sys.version_info >= (3, 10): - def iterdir(self) -> Iterator[Self]: ... - else: - def iterdir(self) -> Iterator[Path]: ... - - def is_dir(self) -> bool: ... - def is_file(self) -> bool: ... - def exists(self) -> bool: ... - def read_text( - self, - encoding: str | None = ..., - errors: str | None = ..., - newline: str | None = ..., - line_buffering: bool = ..., - write_through: bool = ..., - ) -> str: ... - def read_bytes(self) -> bytes: ... - if sys.version_info >= (3, 10): - def joinpath(self, *other: StrPath) -> Path: ... - else: - def joinpath(self, add: StrPath) -> Path: ... # undocumented - if sys.version_info >= (3, 12): - def glob(self, pattern: str) -> Iterator[Self]: ... - def rglob(self, pattern: str) -> Iterator[Self]: ... - def is_symlink(self) -> Literal[False]: ... - def relative_to(self, other: Path, *extra: StrPath) -> str: ... - def match(self, path_pattern: str) -> bool: ... - def __eq__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - - def __truediv__(self, add: StrPath) -> Path: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zlib.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/zlib.pyi deleted file mode 100644 index 2f6c406560384..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/zlib.pyi +++ /dev/null @@ -1,56 +0,0 @@ -import sys -from _typeshed import ReadableBuffer -from typing import Final - -DEFLATED: Final = 8 -DEF_MEM_LEVEL: int # can change -DEF_BUF_SIZE: Final = 16384 -MAX_WBITS: int -ZLIB_VERSION: str # can change -ZLIB_RUNTIME_VERSION: str # can change -Z_NO_COMPRESSION: Final = 0 -Z_PARTIAL_FLUSH: Final = 1 -Z_BEST_COMPRESSION: Final = 9 -Z_BEST_SPEED: Final = 1 -Z_BLOCK: Final = 5 -Z_DEFAULT_COMPRESSION: Final = -1 -Z_DEFAULT_STRATEGY: Final = 0 -Z_FILTERED: Final = 1 -Z_FINISH: Final = 4 -Z_FIXED: Final = 4 -Z_FULL_FLUSH: Final = 3 -Z_HUFFMAN_ONLY: Final = 2 -Z_NO_FLUSH: Final = 0 -Z_RLE: Final = 3 -Z_SYNC_FLUSH: Final = 2 -Z_TREES: Final = 6 - -class error(Exception): ... - -class _Compress: - def compress(self, data: ReadableBuffer) -> bytes: ... - def flush(self, mode: int = ...) -> bytes: ... - def copy(self) -> _Compress: ... - -class _Decompress: - unused_data: bytes - unconsumed_tail: bytes - eof: bool - def decompress(self, data: ReadableBuffer, max_length: int = ...) -> bytes: ... - def flush(self, length: int = ...) -> bytes: ... - def copy(self) -> _Decompress: ... - -def adler32(data: ReadableBuffer, value: int = 1, /) -> int: ... - -if sys.version_info >= (3, 11): - def compress(data: ReadableBuffer, /, level: int = -1, wbits: int = 15) -> bytes: ... - -else: - def compress(data: ReadableBuffer, /, level: int = -1) -> bytes: ... - -def compressobj( - level: int = -1, method: int = 8, wbits: int = 15, memLevel: int = 8, strategy: int = 0, zdict: ReadableBuffer | None = None -) -> _Compress: ... -def crc32(data: ReadableBuffer, value: int = 0, /) -> int: ... -def decompress(data: ReadableBuffer, /, wbits: int = 15, bufsize: int = 16384) -> bytes: ... -def decompressobj(wbits: int = 15, zdict: ReadableBuffer = b"") -> _Decompress: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi b/crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi deleted file mode 100644 index cc483afad9fff..0000000000000 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi +++ /dev/null @@ -1,35 +0,0 @@ -import sys -from collections.abc import Iterable -from datetime import datetime, timedelta, tzinfo -from typing_extensions import Self - -# TODO: remove this version check -# In theory we shouldn't need this version check. Pyright complains about the imports -# from zoneinfo.* when run on 3.8 and 3.7 without this. Updates to typeshed's -# pyright test script are probably needed, see #11189 -if sys.version_info >= (3, 9): - from zoneinfo._common import ZoneInfoNotFoundError as ZoneInfoNotFoundError, _IOBytes - from zoneinfo._tzpath import ( - TZPATH as TZPATH, - InvalidTZPathWarning as InvalidTZPathWarning, - available_timezones as available_timezones, - reset_tzpath as reset_tzpath, - ) - - __all__ = ["ZoneInfo", "reset_tzpath", "available_timezones", "TZPATH", "ZoneInfoNotFoundError", "InvalidTZPathWarning"] - - class ZoneInfo(tzinfo): - @property - def key(self) -> str: ... - def __init__(self, key: str) -> None: ... - @classmethod - def no_cache(cls, key: str) -> Self: ... - @classmethod - def from_file(cls, fobj: _IOBytes, /, key: str | None = None) -> Self: ... - @classmethod - def clear_cache(cls, *, only_keys: Iterable[str] | None = None) -> None: ... - def tzname(self, dt: datetime | None, /) -> str | None: ... - def utcoffset(self, dt: datetime | None, /) -> timedelta | None: ... - def dst(self, dt: datetime | None, /) -> timedelta | None: ... - - def __dir__() -> list[str]: ... diff --git a/crates/red_knot_wasm/Cargo.toml b/crates/red_knot_wasm/Cargo.toml deleted file mode 100644 index 896af153915a6..0000000000000 --- a/crates/red_knot_wasm/Cargo.toml +++ /dev/null @@ -1,38 +0,0 @@ -[package] -name = "red_knot_wasm" -version = "0.0.0" -publish = false -authors = { workspace = true } -edition = { workspace = true } -rust-version = { workspace = true } -homepage = { workspace = true } -documentation = { workspace = true } -repository = { workspace = true } -license = { workspace = true } -description = "WebAssembly bindings for Red Knot" - -[lib] -crate-type = ["cdylib", "rlib"] -doctest = false - -[features] -default = ["console_error_panic_hook"] - -[dependencies] -red_knot_python_semantic = { workspace = true } -red_knot_workspace = { workspace = true, default-features = false, features = ["deflate"] } - -ruff_db = { workspace = true, features = [] } -ruff_notebook = { workspace = true } - -console_error_panic_hook = { workspace = true, optional = true } -console_log = { workspace = true } -js-sys = { workspace = true } -log = { workspace = true } -wasm-bindgen = { workspace = true } - -[dev-dependencies] -wasm-bindgen-test = { workspace = true } - -[lints] -workspace = true diff --git a/crates/red_knot_wasm/src/lib.rs b/crates/red_knot_wasm/src/lib.rs deleted file mode 100644 index 2d70b3d68419e..0000000000000 --- a/crates/red_knot_wasm/src/lib.rs +++ /dev/null @@ -1,279 +0,0 @@ -use std::any::Any; - -use js_sys::Error; -use wasm_bindgen::prelude::*; - -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::workspace::settings::Configuration; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_db::files::{system_path_to_file, File}; -use ruff_db::system::walk_directory::WalkDirectoryBuilder; -use ruff_db::system::{ - DirectoryEntry, MemoryFileSystem, Metadata, System, SystemPath, SystemPathBuf, - SystemVirtualPath, -}; -use ruff_notebook::Notebook; - -#[wasm_bindgen(start)] -pub fn run() { - use log::Level; - - // When the `console_error_panic_hook` feature is enabled, we can call the - // `set_panic_hook` function at least once during initialization, and then - // we will get better error messages if our code ever panics. - // - // For more details see - // https://github.com/rustwasm/console_error_panic_hook#readme - #[cfg(feature = "console_error_panic_hook")] - console_error_panic_hook::set_once(); - - console_log::init_with_level(Level::Debug).expect("Initializing logger went wrong."); -} - -#[wasm_bindgen] -pub struct Workspace { - db: RootDatabase, - system: WasmSystem, -} - -#[wasm_bindgen] -impl Workspace { - #[wasm_bindgen(constructor)] - pub fn new(root: &str, settings: &Settings) -> Result<Workspace, Error> { - let system = WasmSystem::new(SystemPath::new(root)); - let workspace = WorkspaceMetadata::from_path( - SystemPath::new(root), - &system, - Some(Configuration { - target_version: Some(settings.target_version.into()), - ..Configuration::default() - }), - ) - .map_err(into_error)?; - - let db = RootDatabase::new(workspace, system.clone()).map_err(into_error)?; - - Ok(Self { db, system }) - } - - #[wasm_bindgen(js_name = "openFile")] - pub fn open_file(&mut self, path: &str, contents: &str) -> Result<FileHandle, Error> { - self.system - .fs - .write_file(path, contents) - .map_err(into_error)?; - - let file = system_path_to_file(&self.db, path).expect("File to exist"); - file.sync(&mut self.db); - - self.db.workspace().open_file(&mut self.db, file); - - Ok(FileHandle { - file, - path: SystemPath::new(path).to_path_buf(), - }) - } - - #[wasm_bindgen(js_name = "updateFile")] - pub fn update_file(&mut self, file_id: &FileHandle, contents: &str) -> Result<(), Error> { - if !self.system.fs.exists(&file_id.path) { - return Err(Error::new("File does not exist")); - } - - self.system - .fs - .write_file(&file_id.path, contents) - .map_err(into_error)?; - - file_id.file.sync(&mut self.db); - - Ok(()) - } - - #[wasm_bindgen(js_name = "closeFile")] - pub fn close_file(&mut self, file_id: &FileHandle) -> Result<(), Error> { - let file = file_id.file; - - self.db.workspace().close_file(&mut self.db, file); - self.system - .fs - .remove_file(&file_id.path) - .map_err(into_error)?; - - file.sync(&mut self.db); - - Ok(()) - } - - /// Checks a single file. - #[wasm_bindgen(js_name = "checkFile")] - pub fn check_file(&self, file_id: &FileHandle) -> Result<Vec<String>, Error> { - let result = self.db.check_file(file_id.file).map_err(into_error)?; - - Ok(result) - } - - /// Checks all open files - pub fn check(&self) -> Result<Vec<String>, Error> { - let result = self.db.check().map_err(into_error)?; - - Ok(result) - } - - /// Returns the parsed AST for `path` - pub fn parsed(&self, file_id: &FileHandle) -> Result<String, Error> { - let parsed = ruff_db::parsed::parsed_module(&self.db, file_id.file); - - Ok(format!("{:#?}", parsed.syntax())) - } - - /// Returns the token stream for `path` serialized as a string. - pub fn tokens(&self, file_id: &FileHandle) -> Result<String, Error> { - let parsed = ruff_db::parsed::parsed_module(&self.db, file_id.file); - - Ok(format!("{:#?}", parsed.tokens())) - } - - #[wasm_bindgen(js_name = "sourceText")] - pub fn source_text(&self, file_id: &FileHandle) -> Result<String, Error> { - let source_text = ruff_db::source::source_text(&self.db, file_id.file); - - Ok(source_text.to_string()) - } -} - -pub(crate) fn into_error<E: std::fmt::Display>(err: E) -> Error { - Error::new(&err.to_string()) -} - -#[derive(Debug, Eq, PartialEq)] -#[wasm_bindgen(inspectable)] -pub struct FileHandle { - path: SystemPathBuf, - file: File, -} - -#[wasm_bindgen] -impl FileHandle { - #[wasm_bindgen(js_name = toString)] - pub fn js_to_string(&self) -> String { - format!("file(id: {:?}, path: {})", self.file, self.path) - } -} - -#[wasm_bindgen] -pub struct Settings { - pub target_version: TargetVersion, -} -#[wasm_bindgen] -impl Settings { - #[wasm_bindgen(constructor)] - pub fn new(target_version: TargetVersion) -> Self { - Self { target_version } - } -} - -#[wasm_bindgen] -#[derive(Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, Default)] -pub enum TargetVersion { - Py37, - #[default] - Py38, - Py39, - Py310, - Py311, - Py312, - Py313, -} - -impl From<TargetVersion> for red_knot_python_semantic::PythonVersion { - fn from(value: TargetVersion) -> Self { - match value { - TargetVersion::Py37 => Self::PY37, - TargetVersion::Py38 => Self::PY38, - TargetVersion::Py39 => Self::PY39, - TargetVersion::Py310 => Self::PY310, - TargetVersion::Py311 => Self::PY311, - TargetVersion::Py312 => Self::PY312, - TargetVersion::Py313 => Self::PY313, - } - } -} - -#[derive(Debug, Clone)] -struct WasmSystem { - fs: MemoryFileSystem, -} - -impl WasmSystem { - fn new(root: &SystemPath) -> Self { - Self { - fs: MemoryFileSystem::with_current_directory(root), - } - } -} - -impl System for WasmSystem { - fn path_metadata(&self, path: &SystemPath) -> ruff_db::system::Result<Metadata> { - self.fs.metadata(path) - } - - fn canonicalize_path(&self, path: &SystemPath) -> ruff_db::system::Result<SystemPathBuf> { - Ok(self.fs.canonicalize(path)) - } - - fn read_to_string(&self, path: &SystemPath) -> ruff_db::system::Result<String> { - self.fs.read_to_string(path) - } - - fn read_to_notebook( - &self, - path: &SystemPath, - ) -> Result<ruff_notebook::Notebook, ruff_notebook::NotebookError> { - let content = self.read_to_string(path)?; - Notebook::from_source_code(&content) - } - - fn read_virtual_path_to_string( - &self, - _path: &SystemVirtualPath, - ) -> ruff_db::system::Result<String> { - Err(not_found()) - } - - fn read_virtual_path_to_notebook( - &self, - _path: &SystemVirtualPath, - ) -> Result<ruff_notebook::Notebook, ruff_notebook::NotebookError> { - Err(ruff_notebook::NotebookError::Io(not_found())) - } - - fn current_directory(&self) -> &SystemPath { - self.fs.current_directory() - } - - fn read_directory<'a>( - &'a self, - path: &SystemPath, - ) -> ruff_db::system::Result< - Box<dyn Iterator<Item = ruff_db::system::Result<DirectoryEntry>> + 'a>, - > { - Ok(Box::new(self.fs.read_directory(path)?)) - } - - fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder { - self.fs.walk_directory(path) - } - - fn as_any(&self) -> &dyn Any { - self - } - - fn as_any_mut(&mut self) -> &mut dyn std::any::Any { - self - } -} - -fn not_found() -> std::io::Error { - std::io::Error::new(std::io::ErrorKind::NotFound, "No such file or directory") -} diff --git a/crates/red_knot_wasm/tests/api.rs b/crates/red_knot_wasm/tests/api.rs deleted file mode 100644 index ed2ccd76ba9d1..0000000000000 --- a/crates/red_knot_wasm/tests/api.rs +++ /dev/null @@ -1,24 +0,0 @@ -#![cfg(target_arch = "wasm32")] - -use wasm_bindgen_test::wasm_bindgen_test; - -use red_knot_wasm::{Settings, TargetVersion, Workspace}; - -#[wasm_bindgen_test] -fn check() { - let settings = Settings { - target_version: TargetVersion::Py312, - }; - let mut workspace = Workspace::new("/", &settings).expect("Workspace to be created"); - - workspace - .open_file("test.py", "import random22\n") - .expect("File to be opened"); - - let result = workspace.check().expect("Check to succeed"); - - assert_eq!( - result, - vec!["/test.py:1:8: Cannot resolve import `random22`"] - ); -} diff --git a/crates/red_knot_workspace/Cargo.toml b/crates/red_knot_workspace/Cargo.toml deleted file mode 100644 index 1c0d326df12dc..0000000000000 --- a/crates/red_knot_workspace/Cargo.toml +++ /dev/null @@ -1,41 +0,0 @@ -[package] -name = "red_knot_workspace" -version = "0.0.0" -edition.workspace = true -rust-version.workspace = true -homepage.workspace = true -documentation.workspace = true -repository.workspace = true -authors.workspace = true -license.workspace = true - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - -[dependencies] -red_knot_python_semantic = { workspace = true } - -ruff_cache = { workspace = true } -ruff_db = { workspace = true, features = ["os", "cache"] } -ruff_python_ast = { workspace = true } -ruff_text_size = { workspace = true } -red_knot_vendored = { workspace = true } - -anyhow = { workspace = true } -crossbeam = { workspace = true } -notify = { workspace = true } -rayon = { workspace = true } -rustc-hash = { workspace = true } -salsa = { workspace = true } -tracing = { workspace = true } - -[dev-dependencies] -ruff_db = { workspace = true, features = ["testing"] } -tempfile = { workspace = true } - -[features] -default = ["zstd"] -zstd = ["red_knot_vendored/zstd"] -deflate = ["red_knot_vendored/deflate"] - -[lints] -workspace = true diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_constraint.py b/crates/red_knot_workspace/resources/test/corpus/27_func_generic_constraint.py deleted file mode 100644 index 8f5867f38cabd..0000000000000 --- a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_constraint.py +++ /dev/null @@ -1,2 +0,0 @@ -def foo[T: (str, bytes)](x: T) -> T: - ... diff --git a/crates/red_knot_workspace/resources/test/corpus/89_type_alias.py b/crates/red_knot_workspace/resources/test/corpus/89_type_alias.py deleted file mode 100644 index 5bdfc4b05bf3b..0000000000000 --- a/crates/red_knot_workspace/resources/test/corpus/89_type_alias.py +++ /dev/null @@ -1 +0,0 @@ -type foo = int diff --git a/crates/red_knot_workspace/src/db.rs b/crates/red_knot_workspace/src/db.rs deleted file mode 100644 index 4d44036eca305..0000000000000 --- a/crates/red_knot_workspace/src/db.rs +++ /dev/null @@ -1,266 +0,0 @@ -use std::panic::RefUnwindSafe; -use std::sync::Arc; - -use salsa::plumbing::ZalsaDatabase; -use salsa::{Cancelled, Event}; - -use red_knot_python_semantic::{Db as SemanticDb, Program}; -use ruff_db::files::{File, Files}; -use ruff_db::system::System; -use ruff_db::vendored::VendoredFileSystem; -use ruff_db::{Db as SourceDb, Upcast}; - -use crate::workspace::{check_file, Workspace, WorkspaceMetadata}; - -mod changes; - -#[salsa::db] -pub trait Db: SemanticDb + Upcast<dyn SemanticDb> {} - -#[salsa::db] -pub struct RootDatabase { - workspace: Option<Workspace>, - storage: salsa::Storage<RootDatabase>, - files: Files, - system: Arc<dyn System + Send + Sync + RefUnwindSafe>, -} - -impl RootDatabase { - pub fn new<S>(workspace: WorkspaceMetadata, system: S) -> anyhow::Result<Self> - where - S: System + 'static + Send + Sync + RefUnwindSafe, - { - let mut db = Self { - workspace: None, - storage: salsa::Storage::default(), - files: Files::default(), - system: Arc::new(system), - }; - - // Initialize the `Program` singleton - Program::from_settings(&db, workspace.settings().program())?; - - db.workspace = Some(Workspace::from_metadata(&db, workspace)); - - Ok(db) - } - - pub fn workspace(&self) -> Workspace { - // SAFETY: The workspace is always initialized in `new`. - self.workspace.unwrap() - } - - /// Checks all open files in the workspace and its dependencies. - pub fn check(&self) -> Result<Vec<String>, Cancelled> { - self.with_db(|db| db.workspace().check(db)) - } - - pub fn check_file(&self, file: File) -> Result<Vec<String>, Cancelled> { - let _span = tracing::debug_span!("check_file", file=%file.path(self)).entered(); - - self.with_db(|db| check_file(db, file)) - } - - /// Returns a mutable reference to the system. - /// - /// WARNING: Triggers a new revision, canceling other database handles. This can lead to deadlock. - pub fn system_mut(&mut self) -> &mut dyn System { - // TODO: Use a more official method to cancel other queries. - // https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries - let _ = self.zalsa_mut(); - - Arc::get_mut(&mut self.system).unwrap() - } - - pub(crate) fn with_db<F, T>(&self, f: F) -> Result<T, Cancelled> - where - F: FnOnce(&RootDatabase) -> T + std::panic::UnwindSafe, - { - Cancelled::catch(|| f(self)) - } - - #[must_use] - pub fn snapshot(&self) -> Self { - Self { - workspace: self.workspace, - storage: self.storage.clone(), - files: self.files.snapshot(), - system: Arc::clone(&self.system), - } - } -} - -impl Upcast<dyn SemanticDb> for RootDatabase { - fn upcast(&self) -> &(dyn SemanticDb + 'static) { - self - } - - fn upcast_mut(&mut self) -> &mut (dyn SemanticDb + 'static) { - self - } -} - -impl Upcast<dyn SourceDb> for RootDatabase { - fn upcast(&self) -> &(dyn SourceDb + 'static) { - self - } - - fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { - self - } -} - -#[salsa::db] -impl SemanticDb for RootDatabase { - fn is_file_open(&self, file: File) -> bool { - let Some(workspace) = &self.workspace else { - return false; - }; - - workspace.is_file_open(self, file) - } -} - -#[salsa::db] -impl SourceDb for RootDatabase { - fn vendored(&self) -> &VendoredFileSystem { - red_knot_vendored::file_system() - } - - fn system(&self) -> &dyn System { - &*self.system - } - - fn files(&self) -> &Files { - &self.files - } -} - -#[salsa::db] -impl salsa::Database for RootDatabase { - fn salsa_event(&self, event: &dyn Fn() -> Event) { - if !tracing::enabled!(tracing::Level::TRACE) { - return; - } - - let event = event(); - if matches!(event.kind, salsa::EventKind::WillCheckCancellation { .. }) { - return; - } - - tracing::trace!("Salsa event: {event:?}"); - } -} - -#[salsa::db] -impl Db for RootDatabase {} - -#[cfg(test)] -pub(crate) mod tests { - use std::sync::Arc; - - use salsa::Event; - - use red_knot_python_semantic::Db as SemanticDb; - use ruff_db::files::Files; - use ruff_db::system::{DbWithTestSystem, System, TestSystem}; - use ruff_db::vendored::VendoredFileSystem; - use ruff_db::{Db as SourceDb, Upcast}; - - use crate::db::Db; - - #[salsa::db] - pub(crate) struct TestDb { - storage: salsa::Storage<Self>, - events: std::sync::Arc<std::sync::Mutex<Vec<salsa::Event>>>, - files: Files, - system: TestSystem, - vendored: VendoredFileSystem, - } - - impl TestDb { - pub(crate) fn new() -> Self { - Self { - storage: salsa::Storage::default(), - system: TestSystem::default(), - vendored: red_knot_vendored::file_system().clone(), - files: Files::default(), - events: Arc::default(), - } - } - } - - impl TestDb { - /// Takes the salsa events. - /// - /// ## Panics - /// If there are any pending salsa snapshots. - pub(crate) fn take_salsa_events(&mut self) -> Vec<salsa::Event> { - let inner = Arc::get_mut(&mut self.events).expect("no pending salsa snapshots"); - - let events = inner.get_mut().unwrap(); - std::mem::take(&mut *events) - } - } - - impl DbWithTestSystem for TestDb { - fn test_system(&self) -> &TestSystem { - &self.system - } - - fn test_system_mut(&mut self) -> &mut TestSystem { - &mut self.system - } - } - - #[salsa::db] - impl SourceDb for TestDb { - fn vendored(&self) -> &VendoredFileSystem { - &self.vendored - } - - fn system(&self) -> &dyn System { - &self.system - } - - fn files(&self) -> &Files { - &self.files - } - } - - impl Upcast<dyn SemanticDb> for TestDb { - fn upcast(&self) -> &(dyn SemanticDb + 'static) { - self - } - fn upcast_mut(&mut self) -> &mut (dyn SemanticDb + 'static) { - self - } - } - - impl Upcast<dyn SourceDb> for TestDb { - fn upcast(&self) -> &(dyn SourceDb + 'static) { - self - } - fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { - self - } - } - - #[salsa::db] - impl red_knot_python_semantic::Db for TestDb { - fn is_file_open(&self, file: ruff_db::files::File) -> bool { - !file.path(self).is_vendored_path() - } - } - - #[salsa::db] - impl Db for TestDb {} - - #[salsa::db] - impl salsa::Database for TestDb { - fn salsa_event(&self, event: &dyn Fn() -> Event) { - let mut events = self.events.lock().unwrap(); - events.push(event()); - } - } -} diff --git a/crates/red_knot_workspace/src/db/changes.rs b/crates/red_knot_workspace/src/db/changes.rs deleted file mode 100644 index 30a37dc17bfab..0000000000000 --- a/crates/red_knot_workspace/src/db/changes.rs +++ /dev/null @@ -1,232 +0,0 @@ -use red_knot_python_semantic::Program; -use ruff_db::files::{system_path_to_file, File, Files}; -use ruff_db::system::walk_directory::WalkState; -use ruff_db::system::SystemPath; -use ruff_db::Db; -use rustc_hash::FxHashSet; - -use crate::db::RootDatabase; -use crate::watch; -use crate::watch::{CreatedKind, DeletedKind}; -use crate::workspace::settings::Configuration; -use crate::workspace::WorkspaceMetadata; - -impl RootDatabase { - #[tracing::instrument(level = "debug", skip(self, changes, base_configuration))] - pub fn apply_changes( - &mut self, - changes: Vec<watch::ChangeEvent>, - base_configuration: Option<&Configuration>, - ) { - let workspace = self.workspace(); - let workspace_path = workspace.root(self).to_path_buf(); - let program = Program::get(self); - let custom_stdlib_versions_path = program - .custom_stdlib_search_path(self) - .map(|path| path.join("VERSIONS")); - - let mut workspace_change = false; - // Changes to a custom stdlib path's VERSIONS - let mut custom_stdlib_change = false; - // Packages that need reloading - let mut changed_packages = FxHashSet::default(); - // Paths that were added - let mut added_paths = FxHashSet::default(); - - // Deduplicate the `sync` calls. Many file watchers emit multiple events for the same path. - let mut synced_files = FxHashSet::default(); - let mut synced_recursively = FxHashSet::default(); - - let mut sync_path = |db: &mut RootDatabase, path: &SystemPath| { - if synced_files.insert(path.to_path_buf()) { - File::sync_path(db, path); - } - }; - - let mut sync_recursively = |db: &mut RootDatabase, path: &SystemPath| { - if synced_recursively.insert(path.to_path_buf()) { - Files::sync_recursively(db, path); - } - }; - - for change in changes { - if let Some(path) = change.system_path() { - if matches!( - path.file_name(), - Some(".gitignore" | ".ignore" | "ruff.toml" | ".ruff.toml" | "pyproject.toml") - ) { - // Changes to ignore files or settings can change the workspace structure or add/remove files - // from packages. - if let Some(package) = workspace.package(self, path) { - changed_packages.insert(package); - } else { - workspace_change = true; - } - - continue; - } - - if Some(path) == custom_stdlib_versions_path.as_deref() { - custom_stdlib_change = true; - } - } - - match change { - watch::ChangeEvent::Changed { path, kind: _ } - | watch::ChangeEvent::Opened(path) => sync_path(self, &path), - - watch::ChangeEvent::Created { kind, path } => { - match kind { - CreatedKind::File => sync_path(self, &path), - CreatedKind::Directory | CreatedKind::Any => { - sync_recursively(self, &path); - } - } - - if self.system().is_file(&path) { - // Add the parent directory because `walkdir` always visits explicitly passed files - // even if they match an exclude filter. - added_paths.insert(path.parent().unwrap().to_path_buf()); - } else { - added_paths.insert(path); - } - } - - watch::ChangeEvent::Deleted { kind, path } => { - let is_file = match kind { - DeletedKind::File => true, - DeletedKind::Directory => { - // file watchers emit an event for every deleted file. No need to scan the entire dir. - continue; - } - DeletedKind::Any => self - .files - .try_system(self, &path) - .is_some_and(|file| file.exists(self)), - }; - - if is_file { - sync_path(self, &path); - - if let Some(package) = workspace.package(self, &path) { - if let Some(file) = self.files().try_system(self, &path) { - package.remove_file(self, file); - } - } - } else { - sync_recursively(self, &path); - - if custom_stdlib_versions_path - .as_ref() - .is_some_and(|versions_path| versions_path.starts_with(&path)) - { - custom_stdlib_change = true; - } - - if let Some(package) = workspace.package(self, &path) { - changed_packages.insert(package); - } else { - workspace_change = true; - } - } - } - - watch::ChangeEvent::CreatedVirtual(path) - | watch::ChangeEvent::ChangedVirtual(path) => { - File::sync_virtual_path(self, &path); - } - - watch::ChangeEvent::DeletedVirtual(path) => { - if let Some(virtual_file) = self.files().try_virtual_file(&path) { - virtual_file.close(self); - } - } - - watch::ChangeEvent::Rescan => { - workspace_change = true; - Files::sync_all(self); - break; - } - } - } - - if workspace_change { - match WorkspaceMetadata::from_path( - &workspace_path, - self.system(), - base_configuration.cloned(), - ) { - Ok(metadata) => { - tracing::debug!("Reloading workspace after structural change"); - // TODO: Handle changes in the program settings. - workspace.reload(self, metadata); - } - Err(error) => { - tracing::error!("Failed to load workspace, keep old workspace: {error}"); - } - } - - return; - } else if custom_stdlib_change { - let search_paths = workspace.search_path_settings(self).clone(); - if let Err(error) = program.update_search_paths(self, &search_paths) { - tracing::error!("Failed to set the new search paths: {error}"); - } - } - - let mut added_paths = added_paths.into_iter().filter(|path| { - let Some(package) = workspace.package(self, path) else { - return false; - }; - - // Skip packages that need reloading - !changed_packages.contains(&package) - }); - - // Use directory walking to discover newly added files. - if let Some(path) = added_paths.next() { - let mut walker = self.system().walk_directory(&path); - - for extra_path in added_paths { - walker = walker.add(&extra_path); - } - - let added_paths = std::sync::Mutex::new(Vec::default()); - - walker.run(|| { - Box::new(|entry| { - let Ok(entry) = entry else { - return WalkState::Continue; - }; - - if !entry.file_type().is_file() { - return WalkState::Continue; - } - - let mut paths = added_paths.lock().unwrap(); - - paths.push(entry.into_path()); - - WalkState::Continue - }) - }); - - for path in added_paths.into_inner().unwrap() { - let package = workspace.package(self, &path); - let file = system_path_to_file(self, &path); - - if let (Some(package), Ok(file)) = (package, file) { - package.add_file(self, file); - } - } - } - - // Reload - for package in changed_packages { - package.reload_files(self); - } - } -} - -#[cfg(test)] -mod tests {} diff --git a/crates/red_knot_workspace/src/lib.rs b/crates/red_knot_workspace/src/lib.rs deleted file mode 100644 index 495a1301157fb..0000000000000 --- a/crates/red_knot_workspace/src/lib.rs +++ /dev/null @@ -1,3 +0,0 @@ -pub mod db; -pub mod watch; -pub mod workspace; diff --git a/crates/red_knot_workspace/src/watch/workspace_watcher.rs b/crates/red_knot_workspace/src/watch/workspace_watcher.rs deleted file mode 100644 index 1e653d131aae1..0000000000000 --- a/crates/red_knot_workspace/src/watch/workspace_watcher.rs +++ /dev/null @@ -1,151 +0,0 @@ -use std::fmt::{Formatter, Write}; -use std::hash::Hasher; - -use tracing::info; - -use red_knot_python_semantic::system_module_search_paths; -use ruff_cache::{CacheKey, CacheKeyHasher}; -use ruff_db::system::{SystemPath, SystemPathBuf}; -use ruff_db::Upcast; - -use crate::db::RootDatabase; -use crate::watch::Watcher; - -/// Wrapper around a [`Watcher`] that watches the relevant paths of a workspace. -pub struct WorkspaceWatcher { - watcher: Watcher, - - /// The paths that need to be watched. This includes paths for which setting up file watching failed. - watched_paths: Vec<SystemPathBuf>, - - /// True if registering a watcher for any path failed. - has_errored_paths: bool, - - /// Cache key over the paths that need watching. It allows short-circuiting if the paths haven't changed. - cache_key: Option<u64>, -} - -impl WorkspaceWatcher { - /// Create a new workspace watcher. - pub fn new(watcher: Watcher, db: &RootDatabase) -> Self { - let mut watcher = Self { - watcher, - watched_paths: Vec::new(), - cache_key: None, - has_errored_paths: false, - }; - - watcher.update(db); - - watcher - } - - pub fn update(&mut self, db: &RootDatabase) { - let search_paths: Vec<_> = system_module_search_paths(db.upcast()).collect(); - let workspace_path = db.workspace().root(db).to_path_buf(); - - let new_cache_key = Self::compute_cache_key(&workspace_path, &search_paths); - - if self.cache_key == Some(new_cache_key) { - return; - } - - // Unregister all watch paths because ordering is important for linux because - // it only emits an event for the last added watcher if a subtree is covered by multiple watchers. - // A path can be covered by multiple watchers if a subdirectory symlinks to a path that's covered by another watch path: - // ```text - // - bar - // - baz.py - // - workspace - // - bar -> /bar - // - foo.py - // ``` - for path in self.watched_paths.drain(..) { - if let Err(error) = self.watcher.unwatch(&path) { - info!("Failed to remove the file watcher for path `{path}`: {error}"); - } - } - - self.has_errored_paths = false; - - let workspace_path = workspace_path - .as_utf8_path() - .canonicalize_utf8() - .map(SystemPathBuf::from_utf8_path_buf) - .unwrap_or(workspace_path); - - // Find the non-overlapping module search paths and filter out paths that are already covered by the workspace. - // Module search paths are already canonicalized. - let unique_module_paths = ruff_db::system::deduplicate_nested_paths( - search_paths - .into_iter() - .filter(|path| !path.starts_with(&workspace_path)), - ) - .map(SystemPath::to_path_buf); - - // Now add the new paths, first starting with the workspace path and then - // adding the library search paths. - for path in std::iter::once(workspace_path).chain(unique_module_paths) { - // Log a warning. It's not worth aborting if registering a single folder fails because - // Ruff otherwise stills works as expected. - if let Err(error) = self.watcher.watch(&path) { - // TODO: Log a user-facing warning. - tracing::warn!("Failed to setup watcher for path `{path}`: {error}. You have to restart Ruff after making changes to files under this path or you might see stale results."); - self.has_errored_paths = true; - } else { - self.watched_paths.push(path); - } - } - - info!( - "Set up file watchers for {}", - DisplayWatchedPaths { - paths: &self.watched_paths - } - ); - - self.cache_key = Some(new_cache_key); - } - - fn compute_cache_key(workspace_root: &SystemPath, search_paths: &[&SystemPath]) -> u64 { - let mut cache_key_hasher = CacheKeyHasher::new(); - search_paths.cache_key(&mut cache_key_hasher); - workspace_root.cache_key(&mut cache_key_hasher); - - cache_key_hasher.finish() - } - - /// Returns `true` if setting up watching for any path failed. - pub fn has_errored_paths(&self) -> bool { - self.has_errored_paths - } - - pub fn flush(&self) { - self.watcher.flush(); - } - - pub fn stop(self) { - self.watcher.stop(); - } -} - -struct DisplayWatchedPaths<'a> { - paths: &'a [SystemPathBuf], -} - -impl std::fmt::Display for DisplayWatchedPaths<'_> { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - f.write_char('[')?; - - let mut iter = self.paths.iter(); - if let Some(first) = iter.next() { - write!(f, "\"{first}\"")?; - - for path in iter { - write!(f, ", \"{path}\"")?; - } - } - - f.write_char(']') - } -} diff --git a/crates/red_knot_workspace/src/workspace.rs b/crates/red_knot_workspace/src/workspace.rs deleted file mode 100644 index 52e5f57a7a9c4..0000000000000 --- a/crates/red_knot_workspace/src/workspace.rs +++ /dev/null @@ -1,577 +0,0 @@ -use std::{collections::BTreeMap, sync::Arc}; - -use rustc_hash::{FxBuildHasher, FxHashSet}; -use salsa::{Durability, Setter as _}; - -pub use metadata::{PackageMetadata, WorkspaceMetadata}; -use red_knot_python_semantic::types::check_types; -use red_knot_python_semantic::SearchPathSettings; -use ruff_db::parsed::parsed_module; -use ruff_db::source::{line_index, source_text, SourceDiagnostic}; -use ruff_db::{ - files::{system_path_to_file, File}, - system::{walk_directory::WalkState, SystemPath, SystemPathBuf}, -}; -use ruff_python_ast::{name::Name, PySourceType}; -use ruff_text_size::Ranged; - -use crate::db::Db; -use crate::db::RootDatabase; -use crate::workspace::files::{Index, Indexed, IndexedIter, PackageFiles}; - -mod files; -mod metadata; -pub mod settings; - -/// The project workspace as a Salsa ingredient. -/// -/// A workspace consists of one or multiple packages. Packages can be nested. A file in a workspace -/// belongs to no or exactly one package (files can't belong to multiple packages). -/// -/// How workspaces and packages are discovered is TBD. For now, a workspace can be any directory, -/// and it always contains a single package which has the same root as the workspace. -/// -/// ## Examples -/// -/// ```text -/// app-1/ -/// pyproject.toml -/// src/ -/// ... python files -/// -/// app-2/ -/// pyproject.toml -/// src/ -/// ... python files -/// -/// shared/ -/// pyproject.toml -/// src/ -/// ... python files -/// -/// pyproject.toml -/// ``` -/// -/// The above project structure has three packages: `app-1`, `app-2`, and `shared`. -/// Each of the packages can define their own settings in their `pyproject.toml` file, but -/// they must be compatible. For example, each package can define a different `requires-python` range, -/// but the ranges must overlap. -/// -/// ## How is a workspace different from a program? -/// There are two (related) motivations: -/// -/// 1. Program is defined in `ruff_db` and it can't reference the settings types for the linter and formatter -/// without introducing a cyclic dependency. The workspace is defined in a higher level crate -/// where it can reference these setting types. -/// 2. Running `ruff check` with different target versions results in different programs (settings) but -/// it remains the same workspace. That's why program is a narrowed view of the workspace only -/// holding on to the most fundamental settings required for checking. -#[salsa::input] -pub struct Workspace { - #[return_ref] - root_buf: SystemPathBuf, - - /// The files that are open in the workspace. - /// - /// Setting the open files to a non-`None` value changes `check` to only check the - /// open files rather than all files in the workspace. - #[return_ref] - #[default] - open_fileset: Option<Arc<FxHashSet<File>>>, - - /// The (first-party) packages in this workspace. - #[return_ref] - package_tree: BTreeMap<SystemPathBuf, Package>, - - /// The unresolved search path configuration. - #[return_ref] - pub search_path_settings: SearchPathSettings, -} - -/// A first-party package in a workspace. -#[salsa::input] -pub struct Package { - #[return_ref] - pub name: Name, - - /// The path to the root directory of the package. - #[return_ref] - root_buf: SystemPathBuf, - - /// The files that are part of this package. - #[default] - #[return_ref] - file_set: PackageFiles, - // TODO: Add the loaded settings. -} - -impl Workspace { - /// Discovers the closest workspace at `path` and returns its metadata. - pub fn from_metadata(db: &dyn Db, metadata: WorkspaceMetadata) -> Self { - let mut packages = BTreeMap::new(); - - for package in metadata.packages { - packages.insert(package.root.clone(), Package::from_metadata(db, package)); - } - - Workspace::builder( - metadata.root, - packages, - metadata.settings.program.search_paths, - ) - .durability(Durability::MEDIUM) - .open_fileset_durability(Durability::LOW) - .new(db) - } - - pub fn root(self, db: &dyn Db) -> &SystemPath { - self.root_buf(db) - } - - pub fn packages(self, db: &dyn Db) -> impl Iterator<Item = Package> + '_ { - self.package_tree(db).values().copied() - } - - pub fn reload(self, db: &mut dyn Db, metadata: WorkspaceMetadata) { - tracing::debug!("Reloading workspace"); - assert_eq!(self.root(db), metadata.root()); - - let mut old_packages = self.package_tree(db).clone(); - let mut new_packages = BTreeMap::new(); - - for package_metadata in metadata.packages { - let path = package_metadata.root().to_path_buf(); - - let package = if let Some(old_package) = old_packages.remove(&path) { - old_package.update(db, package_metadata); - old_package - } else { - Package::from_metadata(db, package_metadata) - }; - - new_packages.insert(path, package); - } - - if &metadata.settings.program.search_paths != self.search_path_settings(db) { - self.set_search_path_settings(db) - .to(metadata.settings.program.search_paths); - } - - self.set_package_tree(db).to(new_packages); - } - - pub fn update_package(self, db: &mut dyn Db, metadata: PackageMetadata) -> anyhow::Result<()> { - let path = metadata.root().to_path_buf(); - - if let Some(package) = self.package_tree(db).get(&path).copied() { - package.update(db, metadata); - Ok(()) - } else { - Err(anyhow::anyhow!("Package {path} not found")) - } - } - - /// Returns the closest package to which the first-party `path` belongs. - /// - /// Returns `None` if the `path` is outside of any package or if `file` isn't a first-party file - /// (e.g. third-party dependencies or `excluded`). - pub fn package(self, db: &dyn Db, path: &SystemPath) -> Option<Package> { - let packages = self.package_tree(db); - - let (package_path, package) = packages.range(..=path.to_path_buf()).next_back()?; - - if path.starts_with(package_path) { - Some(*package) - } else { - None - } - } - - /// Checks all open files in the workspace and its dependencies. - pub fn check(self, db: &RootDatabase) -> Vec<String> { - let workspace_span = tracing::debug_span!("check_workspace"); - let _span = workspace_span.enter(); - - tracing::debug!("Checking workspace"); - let files = WorkspaceFiles::new(db, self); - let result = Arc::new(std::sync::Mutex::new(Vec::new())); - let inner_result = Arc::clone(&result); - - let db = db.snapshot(); - let workspace_span = workspace_span.clone(); - - rayon::scope(move |scope| { - for file in &files { - let result = inner_result.clone(); - let db = db.snapshot(); - let workspace_span = workspace_span.clone(); - - scope.spawn(move |_| { - let check_file_span = tracing::debug_span!(parent: &workspace_span, "check_file", file=%file.path(&db)); - let _entered = check_file_span.entered(); - - let file_diagnostics = check_file(&db, file); - result.lock().unwrap().extend(file_diagnostics); - }); - } - }); - - Arc::into_inner(result).unwrap().into_inner().unwrap() - } - - /// Opens a file in the workspace. - /// - /// This changes the behavior of `check` to only check the open files rather than all files in the workspace. - pub fn open_file(self, db: &mut dyn Db, file: File) { - tracing::debug!("Opening file `{}`", file.path(db)); - - let mut open_files = self.take_open_files(db); - open_files.insert(file); - self.set_open_files(db, open_files); - } - - /// Closes a file in the workspace. - pub fn close_file(self, db: &mut dyn Db, file: File) -> bool { - tracing::debug!("Closing file `{}`", file.path(db)); - - let mut open_files = self.take_open_files(db); - let removed = open_files.remove(&file); - - if removed { - self.set_open_files(db, open_files); - } - - removed - } - - /// Returns the open files in the workspace or `None` if the entire workspace should be checked. - pub fn open_files(self, db: &dyn Db) -> Option<&FxHashSet<File>> { - self.open_fileset(db).as_deref() - } - - /// Sets the open files in the workspace. - /// - /// This changes the behavior of `check` to only check the open files rather than all files in the workspace. - #[tracing::instrument(level = "debug", skip(self, db))] - pub fn set_open_files(self, db: &mut dyn Db, open_files: FxHashSet<File>) { - tracing::debug!("Set open workspace files (count: {})", open_files.len()); - - self.set_open_fileset(db).to(Some(Arc::new(open_files))); - } - - /// This takes the open files from the workspace and returns them. - /// - /// This changes the behavior of `check` to check all files in the workspace instead of just the open files. - pub fn take_open_files(self, db: &mut dyn Db) -> FxHashSet<File> { - tracing::debug!("Take open workspace files"); - - // Salsa will cancel any pending queries and remove its own reference to `open_files` - // so that the reference counter to `open_files` now drops to 1. - let open_files = self.set_open_fileset(db).to(None); - - if let Some(open_files) = open_files { - Arc::try_unwrap(open_files).unwrap() - } else { - FxHashSet::default() - } - } - - /// Returns `true` if the file is open in the workspace. - /// - /// A file is considered open when: - /// * explicitly set as an open file using [`open_file`](Self::open_file) - /// * It has a [`SystemPath`] and belongs to a package's `src` files - /// * It has a [`SystemVirtualPath`](ruff_db::system::SystemVirtualPath) - pub fn is_file_open(self, db: &dyn Db, file: File) -> bool { - if let Some(open_files) = self.open_files(db) { - open_files.contains(&file) - } else if let Some(system_path) = file.path(db).as_system_path() { - self.package(db, system_path) - .map_or(false, |package| package.contains_file(db, file)) - } else { - file.path(db).is_system_virtual_path() - } - } -} - -impl Package { - pub fn root(self, db: &dyn Db) -> &SystemPath { - self.root_buf(db) - } - - /// Returns `true` if `file` is a first-party file part of this package. - pub fn contains_file(self, db: &dyn Db, file: File) -> bool { - self.files(db).contains(&file) - } - - #[tracing::instrument(level = "debug", skip(db))] - pub fn remove_file(self, db: &mut dyn Db, file: File) { - tracing::debug!( - "Removing file `{}` from package `{}`", - file.path(db), - self.name(db) - ); - - let Some(mut index) = PackageFiles::indexed_mut(db, self) else { - return; - }; - - index.remove(file); - } - - pub fn add_file(self, db: &mut dyn Db, file: File) { - tracing::debug!( - "Adding file `{}` to package `{}`", - file.path(db), - self.name(db) - ); - - let Some(mut index) = PackageFiles::indexed_mut(db, self) else { - return; - }; - - index.insert(file); - } - - /// Returns the files belonging to this package. - pub fn files(self, db: &dyn Db) -> Indexed<'_> { - let files = self.file_set(db); - - let indexed = match files.get() { - Index::Lazy(vacant) => { - let _entered = - tracing::debug_span!("index_package_files", package = %self.name(db)).entered(); - - let files = discover_package_files(db, self.root(db)); - tracing::info!("Found {} files in package `{}`", files.len(), self.name(db)); - vacant.set(files) - } - Index::Indexed(indexed) => indexed, - }; - - indexed - } - - fn from_metadata(db: &dyn Db, metadata: PackageMetadata) -> Self { - Self::builder(metadata.name, metadata.root) - .durability(Durability::MEDIUM) - .file_set_durability(Durability::LOW) - .new(db) - } - - fn update(self, db: &mut dyn Db, metadata: PackageMetadata) { - let root = self.root(db); - assert_eq!(root, metadata.root()); - - if self.name(db) != metadata.name() { - self.set_name(db).to(metadata.name); - } - } - - pub fn reload_files(self, db: &mut dyn Db) { - tracing::debug!("Reloading files for package `{}`", self.name(db)); - - if !self.file_set(db).is_lazy() { - // Force a re-index of the files in the next revision. - self.set_file_set(db).to(PackageFiles::lazy()); - } - } -} - -#[salsa::tracked] -pub(super) fn check_file(db: &dyn Db, file: File) -> Vec<String> { - tracing::debug!("Checking file '{path}'", path = file.path(db)); - - let mut diagnostics = Vec::new(); - - let source_diagnostics = source_text::accumulated::<SourceDiagnostic>(db.upcast(), file); - // TODO(micha): Consider using a single accumulator for all diagnostics - diagnostics.extend( - source_diagnostics - .iter() - .map(std::string::ToString::to_string), - ); - - // Abort checking if there are IO errors. - let source = source_text(db.upcast(), file); - - if source.has_read_error() { - return diagnostics; - } - - let parsed = parsed_module(db.upcast(), file); - - if !parsed.errors().is_empty() { - let path = file.path(db); - let line_index = line_index(db.upcast(), file); - diagnostics.extend(parsed.errors().iter().map(|err| { - let source_location = line_index.source_location(err.location.start(), source.as_str()); - format!("{path}:{source_location}: {message}", message = err.error) - })); - } - - for diagnostic in check_types(db.upcast(), file) { - let index = line_index(db.upcast(), diagnostic.file()); - let location = index.source_location(diagnostic.start(), source.as_str()); - diagnostics.push(format!( - "{path}:{location}: {message}", - path = file.path(db), - message = diagnostic.message() - )); - } - - diagnostics -} - -fn discover_package_files(db: &dyn Db, path: &SystemPath) -> FxHashSet<File> { - let paths = std::sync::Mutex::new(Vec::new()); - - db.system().walk_directory(path).run(|| { - Box::new(|entry| { - match entry { - Ok(entry) => { - // Skip over any non python files to avoid creating too many entries in `Files`. - if entry.file_type().is_file() - && entry - .path() - .extension() - .and_then(PySourceType::try_from_extension) - .is_some() - { - let mut paths = paths.lock().unwrap(); - paths.push(entry.into_path()); - } - } - Err(error) => { - // TODO Handle error - tracing::error!("Failed to walk path: {error}"); - } - } - - WalkState::Continue - }) - }); - - let paths = paths.into_inner().unwrap(); - let mut files = FxHashSet::with_capacity_and_hasher(paths.len(), FxBuildHasher); - - for path in paths { - // If this returns `None`, then the file was deleted between the `walk_directory` call and now. - // We can ignore this. - if let Ok(file) = system_path_to_file(db.upcast(), &path) { - files.insert(file); - } - } - - files -} - -#[derive(Debug)] -enum WorkspaceFiles<'a> { - OpenFiles(&'a FxHashSet<File>), - PackageFiles(Vec<Indexed<'a>>), -} - -impl<'a> WorkspaceFiles<'a> { - fn new(db: &'a dyn Db, workspace: Workspace) -> Self { - if let Some(open_files) = workspace.open_files(db) { - WorkspaceFiles::OpenFiles(open_files) - } else { - WorkspaceFiles::PackageFiles( - workspace - .packages(db) - .map(|package| package.files(db)) - .collect(), - ) - } - } -} - -impl<'a> IntoIterator for &'a WorkspaceFiles<'a> { - type Item = File; - type IntoIter = WorkspaceFilesIter<'a>; - - fn into_iter(self) -> Self::IntoIter { - match self { - WorkspaceFiles::OpenFiles(files) => WorkspaceFilesIter::OpenFiles(files.iter()), - WorkspaceFiles::PackageFiles(package_files) => { - let mut package_files = package_files.iter(); - WorkspaceFilesIter::PackageFiles { - current: package_files.next().map(IntoIterator::into_iter), - package_files, - } - } - } - } -} - -enum WorkspaceFilesIter<'db> { - OpenFiles(std::collections::hash_set::Iter<'db, File>), - PackageFiles { - package_files: std::slice::Iter<'db, Indexed<'db>>, - current: Option<IndexedIter<'db>>, - }, -} - -impl Iterator for WorkspaceFilesIter<'_> { - type Item = File; - - fn next(&mut self) -> Option<Self::Item> { - match self { - WorkspaceFilesIter::OpenFiles(files) => files.next().copied(), - WorkspaceFilesIter::PackageFiles { - package_files, - current, - } => loop { - if let Some(file) = current.as_mut().and_then(Iterator::next) { - return Some(file); - } - - *current = Some(package_files.next()?.into_iter()); - }, - } - } -} - -#[cfg(test)] -mod tests { - use red_knot_python_semantic::types::check_types; - use ruff_db::files::system_path_to_file; - use ruff_db::source::source_text; - use ruff_db::system::{DbWithTestSystem, SystemPath}; - use ruff_db::testing::assert_function_query_was_not_run; - - use crate::db::tests::TestDb; - use crate::workspace::check_file; - - #[test] - fn check_file_skips_type_checking_when_file_cant_be_read() -> ruff_db::system::Result<()> { - let mut db = TestDb::new(); - let path = SystemPath::new("test.py"); - - db.write_file(path, "x = 10")?; - let file = system_path_to_file(&db, path).unwrap(); - - // Now the file gets deleted before we had a chance to read its source text. - db.memory_file_system().remove_file(path)?; - file.sync(&mut db); - - assert_eq!(source_text(&db, file).as_str(), ""); - assert_eq!( - check_file(&db, file), - vec!["Failed to read file: No such file or directory".to_string()] - ); - - let events = db.take_salsa_events(); - assert_function_query_was_not_run(&db, check_types, file, &events); - - // The user now creates a new file with an empty text. The source text - // content returned by `source_text` remains unchanged, but the diagnostics should get updated. - db.write_file(path, "").unwrap(); - - assert_eq!(source_text(&db, file).as_str(), ""); - assert_eq!(check_file(&db, file), vec![] as Vec<String>); - - Ok(()) - } -} diff --git a/crates/red_knot_workspace/src/workspace/files.rs b/crates/red_knot_workspace/src/workspace/files.rs deleted file mode 100644 index 634cf9ba8ad94..0000000000000 --- a/crates/red_knot_workspace/src/workspace/files.rs +++ /dev/null @@ -1,277 +0,0 @@ -use std::marker::PhantomData; -use std::ops::Deref; -use std::sync::Arc; - -use rustc_hash::FxHashSet; -use salsa::Setter; - -use ruff_db::files::File; - -use crate::db::Db; -use crate::workspace::Package; - -/// Cheap cloneable hash set of files. -type FileSet = Arc<FxHashSet<File>>; - -/// The indexed files of a package. -/// -/// The indexing happens lazily, but the files are then cached for subsequent reads. -/// -/// ## Implementation -/// The implementation uses internal mutability to transition between the lazy and indexed state -/// without triggering a new salsa revision. This is safe because the initial indexing happens on first access, -/// so no query can be depending on the contents of the indexed files before that. All subsequent mutations to -/// the indexed files must go through `IndexedMut`, which uses the Salsa setter `package.set_file_set` to -/// ensure that Salsa always knows when the set of indexed files have changed. -#[derive(Debug)] -pub struct PackageFiles { - state: std::sync::Mutex<State>, -} - -impl PackageFiles { - pub fn lazy() -> Self { - Self { - state: std::sync::Mutex::new(State::Lazy), - } - } - - fn indexed(files: FileSet) -> Self { - Self { - state: std::sync::Mutex::new(State::Indexed(files)), - } - } - - pub(super) fn get(&self) -> Index { - let state = self.state.lock().unwrap(); - - match &*state { - State::Lazy => Index::Lazy(LazyFiles { files: state }), - State::Indexed(files) => Index::Indexed(Indexed { - files: Arc::clone(files), - _lifetime: PhantomData, - }), - } - } - - pub(super) fn is_lazy(&self) -> bool { - matches!(*self.state.lock().unwrap(), State::Lazy) - } - - /// Returns a mutable view on the index that allows cheap in-place mutations. - /// - /// The changes are automatically written back to the database once the view is dropped. - pub(super) fn indexed_mut(db: &mut dyn Db, package: Package) -> Option<IndexedMut> { - // Calling `zalsa_mut` cancels all pending salsa queries. This ensures that there are no pending - // reads to the file set. - // TODO: Use a non-internal API instead https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries - let _ = db.as_dyn_database_mut().zalsa_mut(); - - // Replace the state with lazy. The `IndexedMut` guard restores the state - // to `State::Indexed` or sets a new `PackageFiles` when it gets dropped to ensure the state - // is restored to how it has been before replacing the value. - // - // It isn't necessary to hold on to the lock after this point: - // * The above call to `zalsa_mut` guarantees that there's exactly **one** DB reference. - // * `Indexed` has a `'db` lifetime, and this method requires a `&mut db`. - // This means that there can't be any pending reference to `Indexed` because Rust - // doesn't allow borrowing `db` as mutable (to call this method) and immutable (`Indexed<'db>`) at the same time. - // There can't be any other `Indexed<'db>` references created by clones of this DB because - // all clones must have been dropped at this point and the `Indexed` - // can't outlive the database (constrained by the `db` lifetime). - let state = { - let files = package.file_set(db); - let mut locked = files.state.lock().unwrap(); - std::mem::replace(&mut *locked, State::Lazy) - }; - - let indexed = match state { - // If it's already lazy, just return. We also don't need to restore anything because the - // replace above was a no-op. - State::Lazy => return None, - State::Indexed(indexed) => indexed, - }; - - Some(IndexedMut { - db: Some(db), - package, - files: indexed, - did_change: false, - }) - } -} - -impl Default for PackageFiles { - fn default() -> Self { - Self::lazy() - } -} - -#[derive(Debug)] -enum State { - /// The files of a package haven't been indexed yet. - Lazy, - - /// The files are indexed. Stores the known files of a package. - Indexed(FileSet), -} - -pub(super) enum Index<'db> { - /// The index has not yet been computed. Allows inserting the files. - Lazy(LazyFiles<'db>), - - Indexed(Indexed<'db>), -} - -/// Package files that have not been indexed yet. -pub(super) struct LazyFiles<'db> { - files: std::sync::MutexGuard<'db, State>, -} - -impl<'db> LazyFiles<'db> { - /// Sets the indexed files of a package to `files`. - pub(super) fn set(mut self, files: FxHashSet<File>) -> Indexed<'db> { - let files = Indexed { - files: Arc::new(files), - _lifetime: PhantomData, - }; - *self.files = State::Indexed(Arc::clone(&files.files)); - files - } -} - -/// The indexed files of a package. -/// -/// Note: This type is intentionally non-cloneable. Making it cloneable requires -/// revisiting the locking behavior in [`PackageFiles::indexed_mut`]. -#[derive(Debug, PartialEq, Eq)] -pub struct Indexed<'db> { - files: FileSet, - // Preserve the lifetime of `PackageFiles`. - _lifetime: PhantomData<&'db ()>, -} - -impl Deref for Indexed<'_> { - type Target = FxHashSet<File>; - - fn deref(&self) -> &Self::Target { - &self.files - } -} - -pub(super) type IndexedIter<'a> = std::iter::Copied<std::collections::hash_set::Iter<'a, File>>; - -impl<'a> IntoIterator for &'a Indexed<'_> { - type Item = File; - type IntoIter = IndexedIter<'a>; - - fn into_iter(self) -> Self::IntoIter { - self.files.iter().copied() - } -} - -/// A Mutable view of a package's indexed files. -/// -/// Allows in-place mutation of the files without deep cloning the hash set. -/// The changes are written back when the mutable view is dropped or by calling [`Self::set`] manually. -pub(super) struct IndexedMut<'db> { - db: Option<&'db mut dyn Db>, - package: Package, - files: FileSet, - did_change: bool, -} - -impl IndexedMut<'_> { - pub(super) fn insert(&mut self, file: File) -> bool { - if self.files_mut().insert(file) { - self.did_change = true; - true - } else { - false - } - } - - pub(super) fn remove(&mut self, file: File) -> bool { - if self.files_mut().remove(&file) { - self.did_change = true; - true - } else { - false - } - } - - fn files_mut(&mut self) -> &mut FxHashSet<File> { - Arc::get_mut(&mut self.files).expect("All references to `FilesSet` to have been dropped") - } - - fn set_impl(&mut self) { - let Some(db) = self.db.take() else { - return; - }; - - let files = Arc::clone(&self.files); - - if self.did_change { - // If there are changes, set the new file_set to trigger a salsa revision change. - self.package - .set_file_set(db) - .to(PackageFiles::indexed(files)); - } else { - // The `indexed_mut` replaced the `state` with Lazy. Restore it back to the indexed state. - *self.package.file_set(db).state.lock().unwrap() = State::Indexed(files); - } - } -} - -impl Drop for IndexedMut<'_> { - fn drop(&mut self) { - self.set_impl(); - } -} - -#[cfg(test)] -mod tests { - use rustc_hash::FxHashSet; - - use ruff_db::files::system_path_to_file; - use ruff_db::system::{DbWithTestSystem, SystemPathBuf}; - use ruff_python_ast::name::Name; - - use crate::db::tests::TestDb; - use crate::workspace::files::Index; - use crate::workspace::Package; - - #[test] - fn re_entrance() -> anyhow::Result<()> { - let mut db = TestDb::new(); - - db.write_file("test.py", "")?; - - let package = Package::new(&db, Name::new("test"), SystemPathBuf::from("/test")); - - let file = system_path_to_file(&db, "test.py").unwrap(); - - let files = match package.file_set(&db).get() { - Index::Lazy(lazy) => lazy.set(FxHashSet::from_iter([file])), - Index::Indexed(files) => files, - }; - - // Calling files a second time should not dead-lock. - // This can e.g. happen when `check_file` iterates over all files and - // `is_file_open` queries the open files. - let files_2 = package.file_set(&db).get(); - - match files_2 { - Index::Lazy(_) => { - panic!("Expected indexed files, got lazy files"); - } - Index::Indexed(files_2) => { - assert_eq!( - files_2.iter().collect::<Vec<_>>(), - files.iter().collect::<Vec<_>>() - ); - } - } - - Ok(()) - } -} diff --git a/crates/red_knot_workspace/src/workspace/metadata.rs b/crates/red_knot_workspace/src/workspace/metadata.rs deleted file mode 100644 index a56f93e19b745..0000000000000 --- a/crates/red_knot_workspace/src/workspace/metadata.rs +++ /dev/null @@ -1,88 +0,0 @@ -use crate::workspace::settings::{Configuration, WorkspaceSettings}; -use ruff_db::system::{System, SystemPath, SystemPathBuf}; -use ruff_python_ast::name::Name; - -#[derive(Debug)] -pub struct WorkspaceMetadata { - pub(super) root: SystemPathBuf, - - /// The (first-party) packages in this workspace. - pub(super) packages: Vec<PackageMetadata>, - - pub(super) settings: WorkspaceSettings, -} - -/// A first-party package in a workspace. -#[derive(Debug)] -pub struct PackageMetadata { - pub(super) name: Name, - - /// The path to the root directory of the package. - pub(super) root: SystemPathBuf, - // TODO: Add the loaded package configuration (not the nested ruff settings) -} - -impl WorkspaceMetadata { - /// Discovers the closest workspace at `path` and returns its metadata. - pub fn from_path( - path: &SystemPath, - system: &dyn System, - base_configuration: Option<Configuration>, - ) -> anyhow::Result<WorkspaceMetadata> { - assert!( - system.is_directory(path), - "Workspace root path must be a directory" - ); - tracing::debug!("Searching for workspace in '{path}'"); - - let root = path.to_path_buf(); - - // TODO: Discover package name from `pyproject.toml`. - let package_name: Name = path.file_name().unwrap_or("<root>").into(); - - let package = PackageMetadata { - name: package_name, - root: root.clone(), - }; - - // TODO: Load the configuration from disk. - let mut configuration = Configuration::default(); - - if let Some(base_configuration) = base_configuration { - configuration.extend(base_configuration); - } - - // TODO: Respect the package configurations when resolving settings (e.g. for the target version). - let settings = configuration.into_workspace_settings(&root); - - let workspace = WorkspaceMetadata { - root, - packages: vec![package], - settings, - }; - - Ok(workspace) - } - - pub fn root(&self) -> &SystemPath { - &self.root - } - - pub fn packages(&self) -> &[PackageMetadata] { - &self.packages - } - - pub fn settings(&self) -> &WorkspaceSettings { - &self.settings - } -} - -impl PackageMetadata { - pub fn name(&self) -> &Name { - &self.name - } - - pub fn root(&self) -> &SystemPath { - &self.root - } -} diff --git a/crates/red_knot_workspace/src/workspace/settings.rs b/crates/red_knot_workspace/src/workspace/settings.rs deleted file mode 100644 index 38a633b07dcfe..0000000000000 --- a/crates/red_knot_workspace/src/workspace/settings.rs +++ /dev/null @@ -1,89 +0,0 @@ -use red_knot_python_semantic::{ProgramSettings, PythonVersion, SearchPathSettings, SitePackages}; -use ruff_db::system::{SystemPath, SystemPathBuf}; - -/// The resolved configurations. -/// -/// The main difference to [`Configuration`] is that default values are filled in. -#[derive(Debug, Clone)] -pub struct WorkspaceSettings { - pub(super) program: ProgramSettings, -} - -impl WorkspaceSettings { - pub fn program(&self) -> &ProgramSettings { - &self.program - } -} - -/// The configuration for the workspace or a package. -#[derive(Debug, Default, Clone)] -pub struct Configuration { - pub target_version: Option<PythonVersion>, - pub search_paths: SearchPathConfiguration, -} - -impl Configuration { - /// Extends this configuration by using the values from `with` for all values that are absent in `self`. - pub fn extend(&mut self, with: Configuration) { - self.target_version = self.target_version.or(with.target_version); - self.search_paths.extend(with.search_paths); - } - - pub fn into_workspace_settings(self, workspace_root: &SystemPath) -> WorkspaceSettings { - WorkspaceSettings { - program: ProgramSettings { - target_version: self.target_version.unwrap_or_default(), - search_paths: self.search_paths.into_settings(workspace_root), - }, - } - } -} - -#[derive(Debug, Default, Clone, Eq, PartialEq)] -pub struct SearchPathConfiguration { - /// List of user-provided paths that should take first priority in the module resolution. - /// Examples in other type checkers are mypy's MYPYPATH environment variable, - /// or pyright's stubPath configuration setting. - pub extra_paths: Option<Vec<SystemPathBuf>>, - - /// The root of the workspace, used for finding first-party modules. - pub src_root: Option<SystemPathBuf>, - - /// Optional path to a "custom typeshed" directory on disk for us to use for standard-library types. - /// If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib, - /// bundled as a zip file in the binary - pub custom_typeshed: Option<SystemPathBuf>, - - /// The path to the user's `site-packages` directory, where third-party packages from ``PyPI`` are installed. - pub site_packages: Option<SitePackages>, -} - -impl SearchPathConfiguration { - pub fn into_settings(self, workspace_root: &SystemPath) -> SearchPathSettings { - let site_packages = self.site_packages.unwrap_or(SitePackages::Known(vec![])); - - SearchPathSettings { - extra_paths: self.extra_paths.unwrap_or_default(), - src_root: self - .src_root - .unwrap_or_else(|| workspace_root.to_path_buf()), - custom_typeshed: self.custom_typeshed, - site_packages, - } - } - - pub fn extend(&mut self, with: SearchPathConfiguration) { - if let Some(extra_paths) = with.extra_paths { - self.extra_paths.get_or_insert(extra_paths); - } - if let Some(src_root) = with.src_root { - self.src_root.get_or_insert(src_root); - } - if let Some(custom_typeshed) = with.custom_typeshed { - self.custom_typeshed.get_or_insert(custom_typeshed); - } - if let Some(site_packages) = with.site_packages { - self.site_packages.get_or_insert(site_packages); - } - } -} diff --git a/crates/red_knot_workspace/tests/check.rs b/crates/red_knot_workspace/tests/check.rs deleted file mode 100644 index 609724759049b..0000000000000 --- a/crates/red_knot_workspace/tests/check.rs +++ /dev/null @@ -1,146 +0,0 @@ -use std::fs; -use std::path::PathBuf; - -use red_knot_python_semantic::{HasTy, SemanticModel}; -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_db::files::{system_path_to_file, File}; -use ruff_db::parsed::parsed_module; -use ruff_db::system::{OsSystem, SystemPath, SystemPathBuf}; -use ruff_python_ast::visitor::source_order; -use ruff_python_ast::visitor::source_order::SourceOrderVisitor; -use ruff_python_ast::{self as ast, Alias, Expr, Parameter, ParameterWithDefault, Stmt}; - -fn setup_db(workspace_root: &SystemPath) -> anyhow::Result<RootDatabase> { - let system = OsSystem::new(workspace_root); - let workspace = WorkspaceMetadata::from_path(workspace_root, &system, None)?; - RootDatabase::new(workspace, system) -} - -/// Test that all snippets in testcorpus can be checked without panic -#[test] -#[allow(clippy::print_stdout)] -fn corpus_no_panic() -> anyhow::Result<()> { - let root = SystemPathBuf::from_path_buf(tempfile::TempDir::new()?.into_path()).unwrap(); - let db = setup_db(&root)?; - - let corpus = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources/test/corpus"); - - for path in fs::read_dir(&corpus)? { - let source = path?.path(); - println!("checking {source:?}"); - let source_fn = source.file_name().unwrap().to_str().unwrap(); - let py_dest = root.join(source_fn); - fs::copy(&source, py_dest.as_std_path())?; - // this test is only asserting that we can pull every expression type without a panic - // (and some non-expressions that clearly define a single type) - let file = system_path_to_file(&db, py_dest).unwrap(); - pull_types(&db, file); - - // try the file as a stub also - println!("re-checking as .pyi"); - let pyi_dest = root.join(format!("{source_fn}i")); - std::fs::copy(source, pyi_dest.as_std_path())?; - let file = system_path_to_file(&db, pyi_dest).unwrap(); - pull_types(&db, file); - } - Ok(()) -} - -fn pull_types(db: &RootDatabase, file: File) { - let mut visitor = PullTypesVisitor::new(db, file); - - let ast = parsed_module(db, file); - - visitor.visit_body(ast.suite()); -} - -struct PullTypesVisitor<'db> { - model: SemanticModel<'db>, -} - -impl<'db> PullTypesVisitor<'db> { - fn new(db: &'db RootDatabase, file: File) -> Self { - Self { - model: SemanticModel::new(db, file), - } - } - - fn visit_assign_target(&mut self, target: &Expr) { - match target { - Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { - for element in elts { - self.visit_assign_target(element); - } - } - _ => self.visit_expr(target), - } - } -} - -impl SourceOrderVisitor<'_> for PullTypesVisitor<'_> { - fn visit_stmt(&mut self, stmt: &Stmt) { - match stmt { - Stmt::FunctionDef(function) => { - let _ty = function.ty(&self.model); - } - Stmt::ClassDef(class) => { - let _ty = class.ty(&self.model); - } - Stmt::Assign(assign) => { - for target in &assign.targets { - self.visit_assign_target(target); - } - return; - } - Stmt::AnnAssign(_) - | Stmt::Return(_) - | Stmt::Delete(_) - | Stmt::AugAssign(_) - | Stmt::TypeAlias(_) - | Stmt::For(_) - | Stmt::While(_) - | Stmt::If(_) - | Stmt::With(_) - | Stmt::Match(_) - | Stmt::Raise(_) - | Stmt::Try(_) - | Stmt::Assert(_) - | Stmt::Import(_) - | Stmt::ImportFrom(_) - | Stmt::Global(_) - | Stmt::Nonlocal(_) - | Stmt::Expr(_) - | Stmt::Pass(_) - | Stmt::Break(_) - | Stmt::Continue(_) - | Stmt::IpyEscapeCommand(_) => {} - } - - source_order::walk_stmt(self, stmt); - } - - fn visit_expr(&mut self, expr: &Expr) { - let _ty = expr.ty(&self.model); - - source_order::walk_expr(self, expr); - } - - fn visit_parameter(&mut self, parameter: &Parameter) { - let _ty = parameter.ty(&self.model); - - source_order::walk_parameter(self, parameter); - } - - fn visit_parameter_with_default(&mut self, parameter_with_default: &ParameterWithDefault) { - let _ty = parameter_with_default.ty(&self.model); - - source_order::walk_parameter_with_default(self, parameter_with_default); - } - - fn visit_alias(&mut self, alias: &Alias) { - let _ty = alias.ty(&self.model); - - source_order::walk_alias(self, alias); - } -} diff --git a/crates/ruff/Cargo.toml b/crates/ruff/Cargo.toml index baf65d724044e..777f99ebafd4e 100644 --- a/crates/ruff/Cargo.toml +++ b/crates/ruff/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ruff" -version = "0.7.1" +version = "0.11.10" publish = true authors = { workspace = true } edition = { workspace = true } @@ -20,8 +20,10 @@ ruff_graph = { workspace = true, features = ["serde", "clap"] } ruff_linter = { workspace = true, features = ["clap"] } ruff_macros = { workspace = true } ruff_notebook = { workspace = true } +ruff_options_metadata = { workspace = true, features = ["serde"] } ruff_python_ast = { workspace = true } ruff_python_formatter = { workspace = true } +ruff_python_parser = { workspace = true } ruff_server = { workspace = true } ruff_source_file = { workspace = true } ruff_text_size = { workspace = true } @@ -29,10 +31,9 @@ ruff_workspace = { workspace = true } anyhow = { workspace = true } argfile = { workspace = true } -bincode = { workspace = true } +bincode = { workspace = true, features = ["serde"] } bitflags = { workspace = true } cachedir = { workspace = true } -chrono = { workspace = true } clap = { workspace = true, features = ["derive", "env", "wrap_help"] } clap_complete_command = { workspace = true } clearscreen = { workspace = true } @@ -42,6 +43,7 @@ globwalk = { workspace = true } ignore = { workspace = true } is-macro = { workspace = true } itertools = { workspace = true } +jiff = { workspace = true } log = { workspace = true } notify = { workspace = true } path-absolutize = { workspace = true, features = ["once_cell_cache"] } @@ -74,12 +76,15 @@ test-case = { workspace = true } [package.metadata.cargo-shear] # Used via macro expansion. -ignored = ["chrono"] +ignored = ["jiff"] + +[package.metadata.dist] +dist = true [target.'cfg(target_os = "windows")'.dependencies] mimalloc = { workspace = true } -[target.'cfg(all(not(target_os = "windows"), not(target_os = "openbsd"), not(target_os = "aix"), any(target_arch = "x86_64", target_arch = "aarch64", target_arch = "powerpc64")))'.dependencies] +[target.'cfg(all(not(target_os = "windows"), not(target_os = "openbsd"), not(target_os = "aix"), not(target_os = "android"), any(target_arch = "x86_64", target_arch = "aarch64", target_arch = "powerpc64")))'.dependencies] tikv-jemallocator = { workspace = true } [lints] diff --git a/crates/ruff/build.rs b/crates/ruff/build.rs index 3615ee555d68b..befb62375c374 100644 --- a/crates/ruff/build.rs +++ b/crates/ruff/build.rs @@ -1,4 +1,8 @@ -use std::{fs, path::Path, process::Command}; +use std::{ + fs, + path::{Path, PathBuf}, + process::Command, +}; fn main() { // The workspace root directory is not available without walking up the tree @@ -9,7 +13,6 @@ fn main() { commit_info(&workspace_root); - #[allow(clippy::disallowed_methods)] let target = std::env::var("TARGET").unwrap(); println!("cargo::rustc-env=RUST_HOST_TARGET={target}"); } @@ -21,27 +24,22 @@ fn commit_info(workspace_root: &Path) { return; } - let git_head_path = git_dir.join("HEAD"); - println!( - "cargo::rerun-if-changed={}", - git_head_path.as_path().display() - ); + if let Some(git_head_path) = git_head(&git_dir) { + println!("cargo:rerun-if-changed={}", git_head_path.display()); - let git_head_contents = fs::read_to_string(git_head_path); - if let Ok(git_head_contents) = git_head_contents { - // The contents are either a commit or a reference in the following formats - // - "<commit>" when the head is detached - // - "ref <ref>" when working on a branch - // If a commit, checking if the HEAD file has changed is sufficient - // If a ref, we need to add the head file for that ref to rebuild on commit - let mut git_ref_parts = git_head_contents.split_whitespace(); - git_ref_parts.next(); - if let Some(git_ref) = git_ref_parts.next() { - let git_ref_path = git_dir.join(git_ref); - println!( - "cargo::rerun-if-changed={}", - git_ref_path.as_path().display() - ); + let git_head_contents = fs::read_to_string(git_head_path); + if let Ok(git_head_contents) = git_head_contents { + // The contents are either a commit or a reference in the following formats + // - "<commit>" when the head is detached + // - "ref <ref>" when working on a branch + // If a commit, checking if the HEAD file has changed is sufficient + // If a ref, we need to add the head file for that ref to rebuild on commit + let mut git_ref_parts = git_head_contents.split_whitespace(); + git_ref_parts.next(); + if let Some(git_ref) = git_ref_parts.next() { + let git_ref_path = git_dir.join(git_ref); + println!("cargo:rerun-if-changed={}", git_ref_path.display()); + } } } @@ -50,7 +48,7 @@ fn commit_info(workspace_root: &Path) { .arg("-1") .arg("--date=short") .arg("--abbrev=9") - .arg("--format=%H %h %cd %(describe)") + .arg("--format=%H %h %cd %(describe:tags)") .output() { Ok(output) if output.status.success() => output, @@ -78,3 +76,30 @@ fn commit_info(workspace_root: &Path) { ); } } + +fn git_head(git_dir: &Path) -> Option<PathBuf> { + // The typical case is a standard git repository. + let git_head_path = git_dir.join("HEAD"); + if git_head_path.exists() { + return Some(git_head_path); + } + if !git_dir.is_file() { + return None; + } + // If `.git/HEAD` doesn't exist and `.git` is actually a file, + // then let's try to attempt to read it as a worktree. If it's + // a worktree, then its contents will look like this, e.g.: + // + // gitdir: /home/andrew/astral/uv/main/.git/worktrees/pr2 + // + // And the HEAD file we want to watch will be at: + // + // /home/andrew/astral/uv/main/.git/worktrees/pr2/HEAD + let contents = fs::read_to_string(git_dir).ok()?; + let (label, worktree_path) = contents.split_once(':')?; + if label != "gitdir" { + return None; + } + let worktree_path = worktree_path.trim(); + Some(PathBuf::from(worktree_path)) +} diff --git a/crates/ruff/src/args.rs b/crates/ruff/src/args.rs index 5a3d2f2874106..45db84d0536e8 100644 --- a/crates/ruff/src/args.rs +++ b/crates/ruff/src/args.rs @@ -1,14 +1,16 @@ use std::cmp::Ordering; -use std::fmt::Formatter; +use std::fmt::{Formatter, Write as _}; use std::ops::Deref; use std::path::{Path, PathBuf}; use std::str::FromStr; use std::sync::Arc; +use crate::commands::completions::config::{OptionString, OptionStringParser}; use anyhow::bail; use clap::builder::{TypedValueParser, ValueParserFactory}; -use clap::{command, Parser, Subcommand}; +use clap::{Parser, Subcommand, command}; use colored::Colorize; +use itertools::Itertools; use path_absolutize::path_dedot; use regex::Regex; use ruff_graph::Direction; @@ -20,7 +22,9 @@ use ruff_linter::settings::types::{ PythonVersion, UnsafeFixes, }; use ruff_linter::{RuleParser, RuleSelector, RuleSelectorParser}; -use ruff_source_file::{LineIndex, OneIndexed}; +use ruff_options_metadata::{OptionEntry, OptionsMetadata}; +use ruff_python_ast as ast; +use ruff_source_file::{LineIndex, OneIndexed, PositionEncoding}; use ruff_text_size::TextRange; use ruff_workspace::configuration::{Configuration, RuleSelection}; use ruff_workspace::options::{Options, PycodestyleOptions}; @@ -89,7 +93,7 @@ pub struct Args { pub(crate) global_options: GlobalConfigArgs, } -#[allow(clippy::large_enum_variant)] +#[expect(clippy::large_enum_variant)] #[derive(Debug, clap::Subcommand)] pub enum Command { /// Run Ruff on the given files or directories. @@ -112,7 +116,11 @@ pub enum Command { /// List or describe the available configuration options. Config { /// Config key to show - option: Option<String>, + #[arg( + value_parser = OptionStringParser, + hide_possible_values = true + )] + option: Option<OptionString>, /// Output format #[arg(long, value_enum, default_value = "text")] output_format: HelpFormat, @@ -169,11 +177,14 @@ pub struct AnalyzeGraphCommand { /// The minimum Python version that should be supported. #[arg(long, value_enum)] target_version: Option<PythonVersion>, + /// Path to a virtual environment to use for resolving additional dependencies + #[arg(long)] + python: Option<PathBuf>, } // The `Parser` derive is for ruff_dev, for ruff `Args` would be sufficient #[derive(Clone, Debug, clap::Parser)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct CheckCommand { /// List of files or directories to check. #[clap(help = "List of files or directories to check [default: .]")] @@ -435,7 +446,7 @@ pub struct CheckCommand { } #[derive(Clone, Debug, clap::Parser)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct FormatCommand { /// List of files or directories to format. #[clap(help = "List of files or directories to format [default: .]")] @@ -519,6 +530,10 @@ pub struct FormatCommand { /// The option can only be used when formatting a single file. Range formatting of notebooks is unsupported. #[clap(long, help_heading = "Editor options", verbatim_doc_comment)] pub range: Option<FormatRange>, + + /// Exit with a non-zero status code if any files were modified via format, even if all files were formatted successfully. + #[arg(long, help_heading = "Miscellaneous", alias = "exit-non-zero-on-fix")] + pub exit_non_zero_on_format: bool, } #[derive(Copy, Clone, Debug, clap::Parser)] @@ -545,7 +560,7 @@ pub enum HelpFormat { Json, } -#[allow(clippy::module_name_repetitions)] +#[expect(clippy::module_name_repetitions)] #[derive(Debug, Default, Clone, clap::Args)] pub struct LogLevelArgs { /// Enable verbose logging. @@ -720,7 +735,7 @@ impl CheckCommand { preview: resolve_bool_arg(self.preview, self.no_preview).map(PreviewMode::from), respect_gitignore: resolve_bool_arg(self.respect_gitignore, self.no_respect_gitignore), select: self.select, - target_version: self.target_version, + target_version: self.target_version.map(ast::PythonVersion::from), unfixable: self.unfixable, // TODO(charlie): Included in `pyproject.toml`, but not inherited. cache_dir: self.cache_dir, @@ -754,6 +769,7 @@ impl FormatCommand { no_cache: self.no_cache, stdin_filename: self.stdin_filename, range: self.range, + exit_non_zero_on_format: self.exit_non_zero_on_format, }; let cli_overrides = ExplicitConfigOverrides { @@ -762,7 +778,7 @@ impl FormatCommand { exclude: self.exclude, preview: resolve_bool_arg(self.preview, self.no_preview).map(PreviewMode::from), force_exclude: resolve_bool_arg(self.force_exclude, self.no_force_exclude), - target_version: self.target_version, + target_version: self.target_version.map(ast::PythonVersion::from), cache_dir: self.cache_dir, extension: self.extension, ..ExplicitConfigOverrides::default() @@ -783,6 +799,7 @@ impl AnalyzeGraphCommand { let format_arguments = AnalyzeGraphArgs { files: self.files, direction: self.direction, + python: self.python, }; let cli_overrides = ExplicitConfigOverrides { @@ -792,7 +809,7 @@ impl AnalyzeGraphCommand { None }, preview: resolve_bool_arg(self.preview, self.no_preview).map(PreviewMode::from), - target_version: self.target_version, + target_version: self.target_version.map(ast::PythonVersion::from), ..ExplicitConfigOverrides::default() }; @@ -821,7 +838,7 @@ enum InvalidConfigFlagReason { ValidTomlButInvalidRuffSchema(toml::de::Error), /// It was a valid ruff config file, but the user tried to pass a /// value for `extend` as part of the config override. - // `extend` is special, because it affects which config files we look at + /// `extend` is special, because it affects which config files we look at /// in the first place. We currently only parse --config overrides *after* /// we've combined them with all the arguments from the various config files /// that we found, so trying to override `extend` as part of a --config @@ -957,21 +974,49 @@ A `--config` flag must either be a path to a `.toml` configuration file // We want to display the most helpful error to the user as possible. if Path::new(value) .extension() - .map_or(false, |ext| ext.eq_ignore_ascii_case("toml")) + .is_some_and(|ext| ext.eq_ignore_ascii_case("toml")) { if !value.contains('=') { - tip.push_str(&format!( + let _ = write!( + &mut tip, " It looks like you were trying to pass a path to a configuration file. The path `{value}` does not point to a configuration file" - )); + ); + } + } else if let Some((key, value)) = value.split_once('=') { + let key = key.trim_ascii(); + let value = value.trim_ascii_start(); + + match Options::metadata().find(key) { + Some(OptionEntry::Set(set)) if !value.starts_with('{') => { + let prefixed_subfields = set + .collect_fields() + .iter() + .map(|(name, _)| format!("- `{key}.{name}`")) + .join("\n"); + + let _ = write!( + &mut tip, + " + +`{key}` is a table of configuration options. +Did you want to override one of the table's subkeys? + +Possible choices: + +{prefixed_subfields}" + ); + } + _ => { + let _ = write!( + &mut tip, + "\n\n{}:\n\n{underlying_error}", + config_parse_error.description() + ); + } } - } else if value.contains('=') { - tip.push_str(&format!( - "\n\n{}:\n\n{underlying_error}", - config_parse_error.description() - )); } let tip = tip.trim_end().to_owned().into(); @@ -986,7 +1031,7 @@ The path `{value}` does not point to a configuration file" /// CLI settings that are distinct from configuration (commands, lists of files, /// etc.). -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct CheckArguments { pub add_noqa: bool, pub diff: bool, @@ -1005,7 +1050,7 @@ pub struct CheckArguments { /// CLI settings that are distinct from configuration (commands, lists of files, /// etc.). -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct FormatArguments { pub check: bool, pub no_cache: bool, @@ -1013,6 +1058,7 @@ pub struct FormatArguments { pub files: Vec<PathBuf>, pub stdin_filename: Option<PathBuf>, pub range: Option<FormatRange>, + pub exit_non_zero_on_format: bool, } /// A text range specified by line and column numbers. @@ -1027,8 +1073,9 @@ impl FormatRange { /// /// Returns an empty range if the start range is past the end of `source`. pub(super) fn to_text_range(self, source: &str, line_index: &LineIndex) -> TextRange { - let start_byte_offset = line_index.offset(self.start.line, self.start.column, source); - let end_byte_offset = line_index.offset(self.end.line, self.end.column, source); + let start_byte_offset = + line_index.offset(self.start.into(), source, PositionEncoding::Utf32); + let end_byte_offset = line_index.offset(self.end.into(), source, PositionEncoding::Utf32); TextRange::new(start_byte_offset, end_byte_offset) } @@ -1079,10 +1126,10 @@ impl std::fmt::Display for FormatRangeParseError { write!( f, "the start position '{start_invalid}' is greater than the end position '{end_invalid}'.\n {tip} Try switching start and end: '{end}-{start}'", - start_invalid=start.to_string().bold().yellow(), - end_invalid=end.to_string().bold().yellow(), - start=start.to_string().green().bold(), - end=end.to_string().green().bold() + start_invalid = start.to_string().bold().yellow(), + end_invalid = end.to_string().bold().yellow(), + start = start.to_string().green().bold(), + end = end.to_string().green().bold() ) } FormatRangeParseError::InvalidStart(inner) => inner.write(f, true), @@ -1099,6 +1146,15 @@ pub struct LineColumn { pub column: OneIndexed, } +impl From<LineColumn> for ruff_source_file::SourceLocation { + fn from(value: LineColumn) -> Self { + Self { + line: value.line, + character_offset: value.column, + } + } +} + impl std::fmt::Display for LineColumn { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { write!(f, "{line}:{column}", line = self.line, column = self.column) @@ -1174,30 +1230,36 @@ impl LineColumnParseError { match self { LineColumnParseError::ColumnParseError(inner) => { - write!(f, "the {range}s column is not a valid number ({inner})'\n {tip} The format is 'line:column'.") + write!( + f, + "the {range}s column is not a valid number ({inner})'\n {tip} The format is 'line:column'." + ) } LineColumnParseError::LineParseError(inner) => { - write!(f, "the {range} line is not a valid number ({inner})\n {tip} The format is 'line:column'.") + write!( + f, + "the {range} line is not a valid number ({inner})\n {tip} The format is 'line:column'." + ) } LineColumnParseError::ZeroColumnIndex { line } => { write!( f, "the {range} column is 0, but it should be 1 or greater.\n {tip} The column numbers start at 1.\n {tip} Try {suggestion} instead.", - suggestion=format!("{line}:1").green().bold() + suggestion = format!("{line}:1").green().bold() ) } LineColumnParseError::ZeroLineIndex { column } => { write!( f, "the {range} line is 0, but it should be 1 or greater.\n {tip} The line numbers start at 1.\n {tip} Try {suggestion} instead.", - suggestion=format!("1:{column}").green().bold() + suggestion = format!("1:{column}").green().bold() ) } LineColumnParseError::ZeroLineAndColumnIndex => { write!( f, "the {range} line and column are both 0, but they should be 1 or greater.\n {tip} The line and column numbers start at 1.\n {tip} Try {suggestion} instead.", - suggestion="1:1".to_string().green().bold() + suggestion = "1:1".to_string().green().bold() ) } } @@ -1209,12 +1271,12 @@ impl LineColumnParseError { pub struct AnalyzeGraphArgs { pub files: Vec<PathBuf>, pub direction: Direction, + pub python: Option<PathBuf>, } /// Configuration overrides provided via dedicated CLI flags: /// `--line-length`, `--respect-gitignore`, etc. #[derive(Clone, Default)] -#[allow(clippy::struct_excessive_bools)] struct ExplicitConfigOverrides { dummy_variable_rgx: Option<Regex>, exclude: Option<Vec<FilePattern>>, @@ -1231,7 +1293,7 @@ struct ExplicitConfigOverrides { preview: Option<PreviewMode>, respect_gitignore: Option<bool>, select: Option<Vec<RuleSelector>>, - target_version: Option<PythonVersion>, + target_version: Option<ast::PythonVersion>, unfixable: Option<Vec<RuleSelector>>, // TODO(charlie): Captured in pyproject.toml as a default, but not part of `Settings`. cache_dir: Option<PathBuf>, diff --git a/crates/ruff/src/cache.rs b/crates/ruff/src/cache.rs index 814f6e03482e1..5c3ccf81e7c30 100644 --- a/crates/ruff/src/cache.rs +++ b/crates/ruff/src/cache.rs @@ -3,8 +3,8 @@ use std::fs::{self, File}; use std::hash::Hasher; use std::io::{self, BufReader, Write}; use std::path::{Path, PathBuf}; -use std::sync::atomic::{AtomicU64, Ordering}; use std::sync::Mutex; +use std::sync::atomic::{AtomicU64, Ordering}; use std::time::{Duration, SystemTime}; use anyhow::{Context, Result}; @@ -13,20 +13,21 @@ use itertools::Itertools; use log::{debug, error}; use rayon::iter::ParallelIterator; use rayon::iter::{IntoParallelIterator, ParallelBridge}; +use ruff_linter::codes::Rule; use rustc_hash::FxHashMap; -use serde::{Deserialize, Serialize}; use tempfile::NamedTempFile; use ruff_cache::{CacheKey, CacheKeyHasher}; -use ruff_diagnostics::{DiagnosticKind, Fix}; -use ruff_linter::message::{DiagnosticMessage, Message}; -use ruff_linter::{warn_user, VERSION}; +use ruff_diagnostics::Fix; +use ruff_linter::message::Message; +use ruff_linter::package::PackageRoot; +use ruff_linter::{VERSION, warn_user}; use ruff_macros::CacheKey; use ruff_notebook::NotebookIndex; use ruff_source_file::SourceFileBuilder; -use ruff_text_size::{TextRange, TextSize}; -use ruff_workspace::resolver::Resolver; +use ruff_text_size::{Ranged, TextRange, TextSize}; use ruff_workspace::Settings; +use ruff_workspace::resolver::Resolver; use crate::diagnostics::Diagnostics; @@ -85,7 +86,7 @@ pub(crate) struct Cache { changes: Mutex<Vec<Change>>, /// The "current" timestamp used as cache for the updates of /// [`FileCache::last_seen`] - #[allow(clippy::struct_field_names)] + #[expect(clippy::struct_field_names)] last_seen_cache: u64, } @@ -116,13 +117,14 @@ impl Cache { } }; - let mut package: PackageCache = match bincode::deserialize_from(BufReader::new(file)) { - Ok(package) => package, - Err(err) => { - warn_user!("Failed parse cache file `{}`: {err}", path.display()); - return Cache::empty(path, package_root); - } - }; + let mut package: PackageCache = + match bincode::decode_from_reader(BufReader::new(file), bincode::config::standard()) { + Ok(package) => package, + Err(err) => { + warn_user!("Failed parse cache file `{}`: {err}", path.display()); + return Cache::empty(path, package_root); + } + }; // Sanity check. if package.package_root != package_root { @@ -145,7 +147,7 @@ impl Cache { Cache::new(path, package) } - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] fn new(path: PathBuf, package: PackageCache) -> Self { Cache { path, @@ -174,8 +176,8 @@ impl Cache { // Serialize to in-memory buffer because hyperfine benchmark showed that it's faster than // using a `BufWriter` and our cache files are small enough that streaming isn't necessary. - let serialized = - bincode::serialize(&self.package).context("Failed to serialize cache data")?; + let serialized = bincode::encode_to_vec(&self.package, bincode::config::standard()) + .context("Failed to serialize cache data")?; temp_file .write_all(&serialized) .context("Failed to write serialized cache to temporary file.")?; @@ -203,7 +205,7 @@ impl Cache { } /// Applies the pending changes without storing the cache to disk. - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] pub(crate) fn save(&mut self) -> bool { /// Maximum duration for which we keep a file in cache that hasn't been seen. const MAX_LAST_SEEN: Duration = Duration::from_secs(30 * 24 * 60 * 60); // 30 days. @@ -310,7 +312,7 @@ impl Cache { } /// On disk representation of a cache of a package. -#[derive(Deserialize, Debug, Serialize)] +#[derive(bincode::Encode, Debug, bincode::Decode)] struct PackageCache { /// Path to the root of the package. /// @@ -322,7 +324,7 @@ struct PackageCache { } /// On disk representation of the cache per source file. -#[derive(Deserialize, Debug, Serialize)] +#[derive(bincode::Decode, Debug, bincode::Encode)] pub(crate) struct FileCache { /// Key that determines if the cached item is still valid. key: u64, @@ -346,13 +348,16 @@ impl FileCache { lint.messages .iter() .map(|msg| { - Message::Diagnostic(DiagnosticMessage { - kind: msg.kind.clone(), - range: msg.range, - fix: msg.fix.clone(), - file: file.clone(), - noqa_offset: msg.noqa_offset, - }) + Message::diagnostic( + msg.rule.into(), + msg.body.clone(), + msg.suggestion.clone(), + msg.range, + msg.fix.clone(), + msg.parent, + file.clone(), + msg.noqa_offset, + ) }) .collect() }; @@ -366,7 +371,7 @@ impl FileCache { } } -#[derive(Debug, Default, Deserialize, Serialize)] +#[derive(Debug, Default, bincode::Decode, bincode::Encode)] struct FileCacheData { lint: Option<LintCacheData>, formatted: bool, @@ -404,7 +409,7 @@ pub(crate) fn init(path: &Path) -> Result<()> { Ok(()) } -#[derive(Deserialize, Debug, Serialize, PartialEq)] +#[derive(bincode::Decode, Debug, bincode::Encode, PartialEq)] pub(crate) struct LintCacheData { /// Imports made. // pub(super) imports: ImportMap, @@ -417,6 +422,7 @@ pub(crate) struct LintCacheData { /// This will be empty if `messages` is empty. pub(super) source: String, /// Notebook index if this file is a Jupyter Notebook. + #[bincode(with_serde)] pub(super) notebook_index: Option<NotebookIndex>, } @@ -433,19 +439,22 @@ impl LintCacheData { let messages = messages .iter() - .filter_map(|message| message.as_diagnostic_message()) - .map(|msg| { + .filter_map(|msg| msg.to_rule().map(|rule| (rule, msg))) + .map(|(rule, msg)| { // Make sure that all message use the same source file. assert_eq!( - &msg.file, + msg.source_file(), messages.first().unwrap().source_file(), "message uses a different source file" ); CacheMessage { - kind: msg.kind.clone(), - range: msg.range, - fix: msg.fix.clone(), - noqa_offset: msg.noqa_offset, + rule, + body: msg.body().to_string(), + suggestion: msg.suggestion().map(ToString::to_string), + range: msg.range(), + parent: msg.parent, + fix: msg.fix().cloned(), + noqa_offset: msg.noqa_offset(), } }) .collect(); @@ -459,13 +468,24 @@ impl LintCacheData { } /// On disk representation of a diagnostic message. -#[derive(Deserialize, Debug, Serialize, PartialEq)] +#[derive(bincode::Decode, Debug, bincode::Encode, PartialEq)] pub(super) struct CacheMessage { - kind: DiagnosticKind, + /// The rule for the cached diagnostic. + #[bincode(with_serde)] + rule: Rule, + /// The message body to display to the user, to explain the diagnostic. + body: String, + /// The message to display to the user, to explain the suggested fix. + suggestion: Option<String>, /// Range into the message's [`FileCache::source`]. + #[bincode(with_serde)] range: TextRange, + #[bincode(with_serde)] + parent: Option<TextSize>, + #[bincode(with_serde)] fix: Option<Fix>, - noqa_offset: TextSize, + #[bincode(with_serde)] + noqa_offset: Option<TextSize>, } pub(crate) trait PackageCaches { @@ -497,7 +517,7 @@ pub(crate) struct PackageCacheMap<'a>(FxHashMap<&'a Path, Cache>); impl<'a> PackageCacheMap<'a> { pub(crate) fn init( - package_roots: &FxHashMap<&'a Path, Option<&'a Path>>, + package_roots: &FxHashMap<&'a Path, Option<PackageRoot<'a>>>, resolver: &Resolver, ) -> Self { fn init_cache(path: &Path) { @@ -513,7 +533,9 @@ impl<'a> PackageCacheMap<'a> { Self( package_roots .iter() - .map(|(package, package_root)| package_root.unwrap_or(package)) + .map(|(package, package_root)| { + package_root.map(PackageRoot::path).unwrap_or(package) + }) .unique() .par_bridge() .map(|cache_root| { @@ -581,21 +603,23 @@ mod tests { use std::time::SystemTime; use anyhow::Result; - use filetime::{set_file_mtime, FileTime}; + use filetime::{FileTime, set_file_mtime}; use itertools::Itertools; + use ruff_linter::settings::LinterSettings; use test_case::test_case; use ruff_cache::CACHE_DIR_NAME; use ruff_linter::message::Message; + use ruff_linter::package::PackageRoot; use ruff_linter::settings::flags; use ruff_linter::settings::types::UnsafeFixes; - use ruff_python_ast::PySourceType; + use ruff_python_ast::{PySourceType, PythonVersion}; use ruff_workspace::Settings; use crate::cache::{self, FileCache, FileCacheData, FileCacheKey}; use crate::cache::{Cache, RelativePathBuf}; - use crate::commands::format::{format_path, FormatCommandError, FormatMode, FormatResult}; - use crate::diagnostics::{lint_path, Diagnostics}; + use crate::commands::format::{FormatCommandError, FormatMode, FormatResult, format_path}; + use crate::diagnostics::{Diagnostics, lint_path}; #[test_case("../ruff_linter/resources/test/fixtures", "ruff_tests/cache_same_results_ruff_linter"; "ruff_linter_fixtures")] #[test_case("../ruff_notebook/resources/test/fixtures", "ruff_tests/cache_same_results_ruff_notebook"; "ruff_notebook_fixtures")] @@ -607,6 +631,10 @@ mod tests { let settings = Settings { cache_dir, + linter: LinterSettings { + unresolved_target_version: PythonVersion::latest().into(), + ..Default::default() + }, ..Settings::default() }; @@ -641,7 +669,7 @@ mod tests { let diagnostics = lint_path( &path, - Some(&package_root), + Some(PackageRoot::root(&package_root)), &settings.linter, Some(&cache), flags::Noqa::Enabled, @@ -683,7 +711,7 @@ mod tests { for path in paths { got_diagnostics += lint_path( &path, - Some(&package_root), + Some(PackageRoot::root(&package_root)), &settings.linter, Some(&cache), flags::Noqa::Enabled, @@ -693,7 +721,10 @@ mod tests { .unwrap(); } - assert_eq!(expected_diagnostics, got_diagnostics); + assert_eq!( + expected_diagnostics, got_diagnostics, + "left == {expected_diagnostics:#?}, right == {got_diagnostics:#?}", + ); } #[test] @@ -819,7 +850,6 @@ mod tests { // Regression test for issue #3086. #[cfg(unix)] - #[allow(clippy::items_after_statements)] fn flip_execute_permission_bit(path: &Path) -> io::Result<()> { use std::os::unix::fs::PermissionsExt; let file = fs::OpenOptions::new().write(true).open(path)?; @@ -828,7 +858,6 @@ mod tests { } #[cfg(windows)] - #[allow(clippy::items_after_statements)] fn flip_read_only_permission(path: &Path) -> io::Result<()> { let file = fs::OpenOptions::new().write(true).open(path)?; let mut perms = file.metadata()?.permissions(); @@ -1056,7 +1085,7 @@ mod tests { ) -> Result<Diagnostics, anyhow::Error> { lint_path( &self.package_root.join(path), - Some(&self.package_root), + Some(PackageRoot::root(&self.package_root)), &self.settings.linter, Some(cache), flags::Noqa::Enabled, diff --git a/crates/ruff/src/commands/add_noqa.rs b/crates/ruff/src/commands/add_noqa.rs index 582ce69501a1c..d5eaeb0170ccb 100644 --- a/crates/ruff/src/commands/add_noqa.rs +++ b/crates/ruff/src/commands/add_noqa.rs @@ -11,7 +11,7 @@ use ruff_linter::source_kind::SourceKind; use ruff_linter::warn_user_once; use ruff_python_ast::{PySourceType, SourceType}; use ruff_workspace::resolver::{ - match_exclusion, python_files_in_path, PyprojectConfig, ResolvedFile, + PyprojectConfig, ResolvedFile, match_exclusion, python_files_in_path, }; use crate::args::ConfigArguments; @@ -26,7 +26,7 @@ pub(crate) fn add_noqa( let start = Instant::now(); let (paths, resolver) = python_files_in_path(files, pyproject_config, config_arguments)?; let duration = start.elapsed(); - debug!("Identified files to lint in: {:?}", duration); + debug!("Identified files to lint in: {duration:?}"); if paths.is_empty() { warn_user_once!("No Python files found under the given path(s)"); @@ -87,7 +87,7 @@ pub(crate) fn add_noqa( .sum(); let duration = start.elapsed(); - debug!("Added noqa to files in: {:?}", duration); + debug!("Added noqa to files in: {duration:?}"); Ok(modifications) } diff --git a/crates/ruff/src/commands/analyze_graph.rs b/crates/ruff/src/commands/analyze_graph.rs index f95592623e070..75ff28d0dcbc4 100644 --- a/crates/ruff/src/commands/analyze_graph.rs +++ b/crates/ruff/src/commands/analyze_graph.rs @@ -1,14 +1,15 @@ use crate::args::{AnalyzeGraphArgs, ConfigArguments}; use crate::resolve::resolve; -use crate::{resolve_default_files, ExitStatus}; +use crate::{ExitStatus, resolve_default_files}; use anyhow::Result; use log::{debug, warn}; use path_absolutize::CWD; use ruff_db::system::{SystemPath, SystemPathBuf}; use ruff_graph::{Direction, ImportMap, ModuleDb, ModuleImports}; +use ruff_linter::package::PackageRoot; use ruff_linter::{warn_user, warn_user_once}; use ruff_python_ast::{PySourceType, SourceType}; -use ruff_workspace::resolver::{match_exclusion, python_files_in_path, ResolvedFile}; +use ruff_workspace::resolver::{ResolvedFile, match_exclusion, python_files_in_path}; use rustc_hash::FxHashMap; use std::io::Write; use std::path::{Path, PathBuf}; @@ -49,23 +50,33 @@ pub(crate) fn analyze_graph( .collect::<Vec<_>>(), ) .into_iter() - .map(|(path, package)| (path.to_path_buf(), package.map(Path::to_path_buf))) + .map(|(path, package)| { + ( + path.to_path_buf(), + package.map(PackageRoot::path).map(Path::to_path_buf), + ) + }) .collect::<FxHashMap<_, _>>(); // Create a database from the source roots. + let src_roots = package_roots + .values() + .filter_map(|package| package.as_deref()) + .filter_map(|package| package.parent()) + .map(Path::to_path_buf) + .filter_map(|path| SystemPathBuf::from_path_buf(path).ok()) + .collect(); + let db = ModuleDb::from_src_roots( - package_roots - .values() - .filter_map(|package| package.as_deref()) - .filter_map(|package| package.parent()) - .map(Path::to_path_buf) - .filter_map(|path| SystemPathBuf::from_path_buf(path).ok()), + src_roots, pyproject_config .settings .analyze .target_version .as_tuple() .into(), + args.python + .and_then(|python| SystemPathBuf::from_path_buf(python).ok()), )?; let imports = { @@ -75,7 +86,7 @@ pub(crate) fn analyze_graph( // Collect and resolve the imports for each file. let result = Arc::new(Mutex::new(Vec::new())); let inner_result = Arc::clone(&result); - let db = db.snapshot(); + let db = db.clone(); rayon::scope(move |scope| { for resolved_file in paths { @@ -131,7 +142,7 @@ pub(crate) fn analyze_graph( continue; }; - let db = db.snapshot(); + let db = db.clone(); let glob_resolver = glob_resolver.clone(); let root = root.clone(); let result = inner_result.clone(); diff --git a/crates/ruff/src/commands/check.rs b/crates/ruff/src/commands/check.rs index 24bc3d94d9d12..0b1a223ffc8af 100644 --- a/crates/ruff/src/commands/check.rs +++ b/crates/ruff/src/commands/check.rs @@ -11,25 +11,25 @@ use log::{debug, error, warn}; use rayon::prelude::*; use rustc_hash::FxHashMap; +use ruff_db::panic::catch_unwind; use ruff_diagnostics::Diagnostic; use ruff_linter::message::Message; +use ruff_linter::package::PackageRoot; use ruff_linter::registry::Rule; use ruff_linter::settings::types::UnsafeFixes; -use ruff_linter::settings::{flags, LinterSettings}; -use ruff_linter::{fs, warn_user_once, IOError}; +use ruff_linter::settings::{LinterSettings, flags}; +use ruff_linter::{IOError, fs, warn_user_once}; use ruff_source_file::SourceFileBuilder; -use ruff_text_size::{TextRange, TextSize}; +use ruff_text_size::TextRange; use ruff_workspace::resolver::{ - match_exclusion, python_files_in_path, PyprojectConfig, ResolvedFile, + PyprojectConfig, ResolvedFile, match_exclusion, python_files_in_path, }; use crate::args::ConfigArguments; use crate::cache::{Cache, PackageCacheMap, PackageCaches}; use crate::diagnostics::Diagnostics; -use crate::panic::catch_unwind; /// Run the linter over a collection of files. -#[allow(clippy::too_many_arguments)] pub(crate) fn check( files: &[PathBuf], pyproject_config: &PyprojectConfig, @@ -87,7 +87,9 @@ pub(crate) fn check( return None; } - let cache_root = package.unwrap_or_else(|| path.parent().unwrap_or(path)); + let cache_root = package + .map(PackageRoot::path) + .unwrap_or_else(|| path.parent().unwrap_or(path)); let cache = caches.get(cache_root); lint_path( @@ -131,7 +133,7 @@ pub(crate) fn check( vec![Message::from_diagnostic( Diagnostic::new(IOError { message }, TextRange::default()), dummy, - TextSize::default(), + None, )], FxHashMap::default(), ) @@ -171,17 +173,16 @@ pub(crate) fn check( caches.persist()?; let duration = start.elapsed(); - debug!("Checked {:?} files in: {:?}", checked_files, duration); + debug!("Checked {checked_files:?} files in: {duration:?}"); Ok(all_diagnostics) } /// Wraps [`lint_path`](crate::diagnostics::lint_path) in a [`catch_unwind`](std::panic::catch_unwind) and emits /// a diagnostic if the linting the file panics. -#[allow(clippy::too_many_arguments)] fn lint_path( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, settings: &LinterSettings, cache: Option<&Cache>, noqa: flags::Noqa, @@ -227,9 +228,9 @@ mod test { use ruff_linter::message::{Emitter, EmitterContext, TextEmitter}; use ruff_linter::registry::Rule; use ruff_linter::settings::types::UnsafeFixes; - use ruff_linter::settings::{flags, LinterSettings}; - use ruff_workspace::resolver::{PyprojectConfig, PyprojectDiscoveryStrategy}; + use ruff_linter::settings::{LinterSettings, flags}; use ruff_workspace::Settings; + use ruff_workspace::resolver::{PyprojectConfig, PyprojectDiscoveryStrategy}; use crate::args::ConfigArguments; diff --git a/crates/ruff/src/commands/check_stdin.rs b/crates/ruff/src/commands/check_stdin.rs index d300dd4c2afb3..4b019433537ca 100644 --- a/crates/ruff/src/commands/check_stdin.rs +++ b/crates/ruff/src/commands/check_stdin.rs @@ -1,13 +1,13 @@ use std::path::Path; use anyhow::Result; - +use ruff_linter::package::PackageRoot; use ruff_linter::packaging; use ruff_linter::settings::flags; -use ruff_workspace::resolver::{match_exclusion, python_file_at_path, PyprojectConfig, Resolver}; +use ruff_workspace::resolver::{PyprojectConfig, Resolver, match_exclusion, python_file_at_path}; use crate::args::ConfigArguments; -use crate::diagnostics::{lint_stdin, Diagnostics}; +use crate::diagnostics::{Diagnostics, lint_stdin}; use crate::stdin::{parrot_stdin, read_from_stdin}; /// Run the linter over a single file, read from `stdin`. @@ -42,6 +42,7 @@ pub(crate) fn check_stdin( let stdin = read_from_stdin()?; let package_root = filename.and_then(Path::parent).and_then(|path| { packaging::detect_package_root(path, &resolver.base_settings().linter.namespace_packages) + .map(PackageRoot::root) }); let mut diagnostics = lint_stdin( filename, diff --git a/crates/ruff/src/commands/completions/config.rs b/crates/ruff/src/commands/completions/config.rs new file mode 100644 index 0000000000000..9b9aa773da4b0 --- /dev/null +++ b/crates/ruff/src/commands/completions/config.rs @@ -0,0 +1,156 @@ +use clap::builder::{PossibleValue, TypedValueParser, ValueParserFactory}; +use itertools::Itertools; +use std::str::FromStr; + +use ruff_options_metadata::{OptionField, OptionSet, OptionsMetadata, Visit}; +use ruff_workspace::options::Options; + +#[derive(Default)] +struct CollectOptionsVisitor { + values: Vec<(String, String)>, + parents: Vec<String>, +} + +impl IntoIterator for CollectOptionsVisitor { + type Item = (String, String); + type IntoIter = std::vec::IntoIter<Self::Item>; + + fn into_iter(self) -> Self::IntoIter { + self.values.into_iter() + } +} + +impl Visit for CollectOptionsVisitor { + fn record_set(&mut self, name: &str, group: OptionSet) { + let fully_qualified_name = self + .parents + .iter() + .map(String::as_str) + .chain(std::iter::once(name)) + .collect::<Vec<_>>() + .join("."); + + // Only add the set to completion list if it has it's own documentation. + self.values.push(( + fully_qualified_name, + group.documentation().unwrap_or("").to_owned(), + )); + + self.parents.push(name.to_owned()); + group.record(self); + self.parents.pop(); + } + + fn record_field(&mut self, name: &str, field: OptionField) { + let fqn = self + .parents + .iter() + .map(String::as_str) + .chain(std::iter::once(name)) + .collect::<Vec<_>>() + .join("."); + + self.values.push((fqn, field.doc.to_owned())); + } +} + +/// Opaque type used solely to enable tab completions +/// for `ruff option [OPTION]` command. +#[derive(Clone, Debug)] +pub struct OptionString(String); + +impl From<String> for OptionString { + fn from(s: String) -> Self { + OptionString(s) + } +} + +impl From<OptionString> for String { + fn from(value: OptionString) -> Self { + value.0 + } +} + +impl From<&str> for OptionString { + fn from(s: &str) -> Self { + OptionString(s.to_string()) + } +} + +impl std::ops::Deref for OptionString { + type Target = str; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl FromStr for OptionString { + type Err = (); + + fn from_str(s: &str) -> Result<Self, Self::Err> { + Options::metadata() + .has(s) + .then(|| OptionString(s.to_owned())) + .ok_or(()) + } +} + +#[derive(Clone)] +pub struct OptionStringParser; + +impl ValueParserFactory for OptionString { + type Parser = OptionStringParser; + + fn value_parser() -> Self::Parser { + OptionStringParser + } +} + +impl TypedValueParser for OptionStringParser { + type Value = OptionString; + + fn parse_ref( + &self, + cmd: &clap::Command, + arg: Option<&clap::Arg>, + value: &std::ffi::OsStr, + ) -> Result<Self::Value, clap::Error> { + let value = value + .to_str() + .ok_or_else(|| clap::Error::new(clap::error::ErrorKind::InvalidUtf8))?; + + value.parse().map_err(|()| { + let mut error = clap::Error::new(clap::error::ErrorKind::ValueValidation).with_cmd(cmd); + if let Some(arg) = arg { + error.insert( + clap::error::ContextKind::InvalidArg, + clap::error::ContextValue::String(arg.to_string()), + ); + } + error.insert( + clap::error::ContextKind::InvalidValue, + clap::error::ContextValue::String(value.to_string()), + ); + error + }) + } + + fn possible_values(&self) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>> { + let mut visitor = CollectOptionsVisitor::default(); + Options::metadata().record(&mut visitor); + + Some(Box::new(visitor.into_iter().map(|(name, doc)| { + let first_paragraph = doc + .lines() + .take_while(|line| !line.trim_end().is_empty()) + // Replace double quotes with single quotes,to avoid clap's lack of escaping + // when creating zsh completions. This has no security implications, as it only + // affects the help string, which is never executed + .map(|s| s.replace('"', "'")) + .join(" "); + + PossibleValue::new(name).help(first_paragraph) + }))) + } +} diff --git a/crates/ruff/src/commands/completions/mod.rs b/crates/ruff/src/commands/completions/mod.rs new file mode 100644 index 0000000000000..30e489dae66b9 --- /dev/null +++ b/crates/ruff/src/commands/completions/mod.rs @@ -0,0 +1 @@ +pub(crate) mod config; diff --git a/crates/ruff/src/commands/config.rs b/crates/ruff/src/commands/config.rs index 4f83d7525a932..f6c00548394ab 100644 --- a/crates/ruff/src/commands/config.rs +++ b/crates/ruff/src/commands/config.rs @@ -1,11 +1,11 @@ -use anyhow::{anyhow, Result}; +use anyhow::{Result, anyhow}; use crate::args::HelpFormat; +use ruff_options_metadata::OptionsMetadata; use ruff_workspace::options::Options; -use ruff_workspace::options_base::OptionsMetadata; -#[allow(clippy::print_stdout)] +#[expect(clippy::print_stdout)] pub(crate) fn config(key: Option<&str>, format: HelpFormat) -> Result<()> { match key { None => { diff --git a/crates/ruff/src/commands/format.rs b/crates/ruff/src/commands/format.rs index 4ad789d13936c..1006346008d31 100644 --- a/crates/ruff/src/commands/format.rs +++ b/crates/ruff/src/commands/format.rs @@ -1,7 +1,7 @@ use std::fmt::{Display, Formatter}; use std::fs::File; use std::io; -use std::io::{stderr, stdout, Write}; +use std::io::{Write, stderr, stdout}; use std::path::{Path, PathBuf}; use std::time::Instant; @@ -11,29 +11,31 @@ use itertools::Itertools; use log::{error, warn}; use rayon::iter::Either::{Left, Right}; use rayon::iter::{IntoParallelRefIterator, ParallelIterator}; +use ruff_python_parser::ParseError; use rustc_hash::FxHashSet; use thiserror::Error; use tracing::debug; +use ruff_db::panic::{PanicError, catch_unwind}; use ruff_diagnostics::SourceMap; use ruff_linter::fs; use ruff_linter::logging::{DisplayParseError, LogLevel}; +use ruff_linter::package::PackageRoot; use ruff_linter::registry::Rule; use ruff_linter::rules::flake8_quotes::settings::Quote; use ruff_linter::source_kind::{SourceError, SourceKind}; use ruff_linter::warn_user_once; use ruff_python_ast::{PySourceType, SourceType}; -use ruff_python_formatter::{format_module_source, format_range, FormatModuleError, QuoteStyle}; +use ruff_python_formatter::{FormatModuleError, QuoteStyle, format_module_source, format_range}; use ruff_source_file::LineIndex; use ruff_text_size::{TextLen, TextRange, TextSize}; -use ruff_workspace::resolver::{match_exclusion, python_files_in_path, ResolvedFile, Resolver}; use ruff_workspace::FormatterSettings; +use ruff_workspace::resolver::{ResolvedFile, Resolver, match_exclusion, python_files_in_path}; use crate::args::{ConfigArguments, FormatArguments, FormatRange}; use crate::cache::{Cache, FileCacheKey, PackageCacheMap, PackageCaches}; -use crate::panic::{catch_unwind, PanicError}; use crate::resolve::resolve; -use crate::{resolve_default_files, ExitStatus}; +use crate::{ExitStatus, resolve_default_files}; #[derive(Debug, Copy, Clone, is_macro::Is)] pub(crate) enum FormatMode { @@ -136,7 +138,9 @@ pub(crate) fn format( .parent() .and_then(|parent| package_roots.get(parent).copied()) .flatten(); - let cache_root = package.unwrap_or_else(|| path.parent().unwrap_or(path)); + let cache_root = package + .map(PackageRoot::path) + .unwrap_or_else(|| path.parent().unwrap_or(path)); let cache = caches.get(cache_root); Some( @@ -156,7 +160,7 @@ pub(crate) fn format( }), Err(error) => Err(FormatCommandError::Panic( Some(resolved_file.path().to_path_buf()), - error, + Box::new(error), )), }, ) @@ -210,7 +214,11 @@ pub(crate) fn format( match mode { FormatMode::Write => { if errors.is_empty() { - Ok(ExitStatus::Success) + if cli.exit_non_zero_on_format && results.any_formatted() { + Ok(ExitStatus::Failure) + } else { + Ok(ExitStatus::Success) + } } else { Ok(ExitStatus::Error) } @@ -230,7 +238,7 @@ pub(crate) fn format( } /// Format the file at the given [`Path`]. -#[tracing::instrument(level="debug", skip_all, fields(path = %path.display()))] +#[tracing::instrument(level = "debug", skip_all, fields(path = %path.display()))] pub(crate) fn format_path( path: &Path, settings: &FormatterSettings, @@ -338,7 +346,7 @@ pub(crate) fn format_source( ) -> Result<FormattedSource, FormatCommandError> { match &source_kind { SourceKind::Python(unformatted) => { - let options = settings.to_format_options(source_type, unformatted); + let options = settings.to_format_options(source_type, unformatted, path); let formatted = if let Some(range) = range { let line_index = LineIndex::from_source_text(unformatted); @@ -354,7 +362,7 @@ pub(crate) fn format_source( }) } else { // Using `Printed::into_code` requires adding `ruff_formatter` as a direct dependency, and I suspect that Rust can optimize the closure away regardless. - #[allow(clippy::redundant_closure_for_method_calls)] + #[expect(clippy::redundant_closure_for_method_calls)] format_module_source(unformatted, options).map(|formatted| formatted.into_code()) }; @@ -388,7 +396,7 @@ pub(crate) fn format_source( )); } - let options = settings.to_format_options(source_type, notebook.source_code()); + let options = settings.to_format_options(source_type, notebook.source_code(), path); let mut output: Option<String> = None; let mut last: Option<TextSize> = None; @@ -403,8 +411,12 @@ pub(crate) fn format_source( let formatted = format_module_source(unformatted, options.clone()).map_err(|err| { if let FormatModuleError::ParseError(err) = err { + // Offset the error by the start of the cell DisplayParseError::from_source_kind( - err, + ParseError { + error: err.error, + location: err.location.checked_add(*start).unwrap(), + }, path.map(Path::to_path_buf), source_kind, ) @@ -623,7 +635,7 @@ impl<'a> FormatResults<'a> { pub(crate) enum FormatCommandError { Ignore(#[from] ignore::Error), Parse(#[from] DisplayParseError), - Panic(Option<PathBuf>, PanicError), + Panic(Option<PathBuf>, Box<PanicError>), Read(Option<PathBuf>, SourceError), Format(Option<PathBuf>, FormatModuleError), Write(Option<PathBuf>, SourceError), @@ -785,8 +797,6 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { let mut incompatible_rules = FxHashSet::default(); for setting in resolver.settings() { for rule in [ - // The formatter might collapse implicit string concatenation on a single line. - Rule::SingleLineImplicitStringConcatenation, // Flags missing trailing commas when all arguments are on its own line: // ```python // def args( @@ -796,7 +806,7 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { // ``` Rule::MissingTrailingComma, // The formatter always removes blank lines before the docstring. - Rule::OneBlankLineBeforeClass, + Rule::IncorrectBlankLineBeforeClass, ] { if setting.linter.rules.enabled(rule) { incompatible_rules.insert(rule); @@ -811,9 +821,14 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { .collect(); rule_names.sort(); if let [rule] = rule_names.as_slice() { - warn_user_once!("The following rule may cause conflicts when used with the formatter: {rule}. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `select` or `extend-select` configuration, or adding it to the `ignore` configuration."); + warn_user_once!( + "The following rule may cause conflicts when used with the formatter: {rule}. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `lint.select` or `lint.extend-select` configuration, or adding it to the `lint.ignore` configuration." + ); } else { - warn_user_once!("The following rules may cause conflicts when used with the formatter: {}. To avoid unexpected behavior, we recommend disabling these rules, either by removing them from the `select` or `extend-select` configuration, or adding them to the `ignore` configuration.", rule_names.join(", ")); + warn_user_once!( + "The following rules may cause conflicts when used with the formatter: {}. To avoid unexpected behavior, we recommend disabling these rules, either by removing them from the `lint.select` or `lint.extend-select` configuration, or adding them to the `lint.ignore` configuration.", + rule_names.join(", ") + ); } } @@ -823,14 +838,33 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { if setting.linter.rules.enabled(Rule::TabIndentation) && setting.formatter.indent_style.is_tab() { - warn_user_once!("The `format.indent-style=\"tab\"` option is incompatible with `W191`, which lints against all uses of tabs. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `\"space\"`."); + warn_user_once!( + "The `format.indent-style=\"tab\"` option is incompatible with `W191`, which lints against all uses of tabs. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `\"space\"`." + ); + } + + if !setting + .linter + .rules + .enabled(Rule::SingleLineImplicitStringConcatenation) + && setting + .linter + .rules + .enabled(Rule::MultiLineImplicitStringConcatenation) + && !setting.linter.flake8_implicit_str_concat.allow_multiline + { + warn_user_once!( + "The `lint.flake8-implicit-str-concat.allow-multiline = false` option is incompatible with the formatter unless `ISC001` is enabled. We recommend enabling `ISC001` or setting `allow-multiline=true`." + ); } // Validate all rules that rely on tab styles. - if setting.linter.rules.enabled(Rule::IndentWithSpaces) + if setting.linter.rules.enabled(Rule::DocstringTabIndentation) && setting.formatter.indent_style.is_tab() { - warn_user_once!("The `format.indent-style=\"tab\"` option is incompatible with `D206`, with requires space-based indentation. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `\"space\"`."); + warn_user_once!( + "The `format.indent-style=\"tab\"` option is incompatible with `D206`, with requires space-based indentation. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `\"space\"`." + ); } // Validate all rules that rely on custom indent widths. @@ -839,7 +873,9 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { Rule::IndentationWithInvalidMultipleComment, ]) && setting.formatter.indent_width.value() != 4 { - warn_user_once!("The `format.indent-width` option with a value other than 4 is incompatible with `E111` and `E114`. We recommend disabling these rules when using the formatter, which enforces a consistent indentation width. Alternatively, set the `format.indent-width` option to `4`."); + warn_user_once!( + "The `format.indent-width` option with a value other than 4 is incompatible with `E111` and `E114`. We recommend disabling these rules when using the formatter, which enforces a consistent indentation width. Alternatively, set the `format.indent-width` option to `4`." + ); } // Validate all rules that rely on quote styles. @@ -853,10 +889,14 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { setting.formatter.quote_style, ) { (Quote::Double, QuoteStyle::Single) => { - warn_user_once!("The `flake8-quotes.inline-quotes=\"double\"` option is incompatible with the formatter's `format.quote-style=\"single\"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `\"single\"` or `\"double\"`."); + warn_user_once!( + "The `flake8-quotes.inline-quotes=\"double\"` option is incompatible with the formatter's `format.quote-style=\"single\"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `\"single\"` or `\"double\"`." + ); } (Quote::Single, QuoteStyle::Double) => { - warn_user_once!("The `flake8-quotes.inline-quotes=\"single\"` option is incompatible with the formatter's `format.quote-style=\"double\"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `\"single\"` or `\"double\"`."); + warn_user_once!( + "The `flake8-quotes.inline-quotes=\"single\"` option is incompatible with the formatter's `format.quote-style=\"double\"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `\"single\"` or `\"double\"`." + ); } _ => {} } @@ -869,7 +909,9 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { QuoteStyle::Single | QuoteStyle::Double ) { - warn_user_once!("The `flake8-quotes.multiline-quotes=\"single\"` option is incompatible with the formatter. We recommend disabling `Q001` when using the formatter, which enforces double quotes for multiline strings. Alternatively, set the `flake8-quotes.multiline-quotes` option to `\"double\"`.`"); + warn_user_once!( + "The `flake8-quotes.multiline-quotes=\"single\"` option is incompatible with the formatter. We recommend disabling `Q001` when using the formatter, which enforces double quotes for multiline strings. Alternatively, set the `flake8-quotes.multiline-quotes` option to `\"double\"`.`" + ); } if setting.linter.rules.enabled(Rule::BadQuotesDocstring) @@ -879,7 +921,9 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { QuoteStyle::Single | QuoteStyle::Double ) { - warn_user_once!("The `flake8-quotes.multiline-quotes=\"single\"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `\"double\"`.`"); + warn_user_once!( + "The `flake8-quotes.docstring-quotes=\"single\"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `\"double\"`.`" + ); } // Validate all isort settings. @@ -887,12 +931,16 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { // The formatter removes empty lines if the value is larger than 2 but always inserts a empty line after imports. // Two empty lines are okay because `isort` only uses this setting for top-level imports (not in nested blocks). if !matches!(setting.linter.isort.lines_after_imports, 1 | 2 | -1) { - warn_user_once!("The isort option `isort.lines-after-imports` with a value other than `-1`, `1` or `2` is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `2`, `1`, or `-1` (default)."); + warn_user_once!( + "The isort option `isort.lines-after-imports` with a value other than `-1`, `1` or `2` is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `2`, `1`, or `-1` (default)." + ); } // Values larger than two get reduced to one line by the formatter if the import is in a nested block. if setting.linter.isort.lines_between_types > 1 { - warn_user_once!("The isort option `isort.lines-between-types` with a value greater than 1 is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `1` or `0` (default)."); + warn_user_once!( + "The isort option `isort.lines-between-types` with a value greater than 1 is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `1` or `0` (default)." + ); } // isort inserts a trailing comma which the formatter preserves, but only if `skip-magic-trailing-comma` isn't false. @@ -901,11 +949,15 @@ pub(super) fn warn_incompatible_formatter_settings(resolver: &Resolver) { && !setting.linter.isort.force_single_line { if setting.linter.isort.force_wrap_aliases { - warn_user_once!("The isort option `isort.force-wrap-aliases` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.force-wrap-aliases=false` or `format.skip-magic-trailing-comma=false`."); + warn_user_once!( + "The isort option `isort.force-wrap-aliases` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.force-wrap-aliases=false` or `format.skip-magic-trailing-comma=false`." + ); } if setting.linter.isort.split_on_trailing_comma { - warn_user_once!("The isort option `isort.split-on-trailing-comma` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.split-on-trailing-comma=false` or `format.skip-magic-trailing-comma=false`."); + warn_user_once!( + "The isort option `isort.split-on-trailing-comma` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.split-on-trailing-comma=false` or `format.skip-magic-trailing-comma=false`." + ); } } } diff --git a/crates/ruff/src/commands/format_stdin.rs b/crates/ruff/src/commands/format_stdin.rs index 9c2d8ff3e0e07..f5b8ea6c603c3 100644 --- a/crates/ruff/src/commands/format_stdin.rs +++ b/crates/ruff/src/commands/format_stdin.rs @@ -6,17 +6,17 @@ use log::error; use ruff_linter::source_kind::SourceKind; use ruff_python_ast::{PySourceType, SourceType}; -use ruff_workspace::resolver::{match_exclusion, python_file_at_path, Resolver}; use ruff_workspace::FormatterSettings; +use ruff_workspace::resolver::{Resolver, match_exclusion, python_file_at_path}; +use crate::ExitStatus; use crate::args::{ConfigArguments, FormatArguments, FormatRange}; use crate::commands::format::{ - format_source, warn_incompatible_formatter_settings, FormatCommandError, FormatMode, - FormatResult, FormattedSource, + FormatCommandError, FormatMode, FormatResult, FormattedSource, format_source, + warn_incompatible_formatter_settings, }; use crate::resolve::resolve; use crate::stdin::{parrot_stdin, read_from_stdin}; -use crate::ExitStatus; /// Run the formatter over a single file, read from `stdin`. pub(crate) fn format_stdin( diff --git a/crates/ruff/src/commands/mod.rs b/crates/ruff/src/commands/mod.rs index 4d463a4ef5d15..9358c76877dc6 100644 --- a/crates/ruff/src/commands/mod.rs +++ b/crates/ruff/src/commands/mod.rs @@ -1,3 +1,5 @@ +pub(crate) mod completions; + pub(crate) mod add_noqa; pub(crate) mod analyze_graph; pub(crate) mod check; diff --git a/crates/ruff/src/commands/rule.rs b/crates/ruff/src/commands/rule.rs index 0b0c1ca840788..271a0c4b1c81f 100644 --- a/crates/ruff/src/commands/rule.rs +++ b/crates/ruff/src/commands/rule.rs @@ -1,3 +1,4 @@ +use std::fmt::Write as _; use std::io::{self, BufWriter, Write}; use anyhow::Result; @@ -18,7 +19,7 @@ struct Explanation<'a> { summary: &'a str, message_formats: &'a [&'a str], fix: String, - #[allow(clippy::struct_field_names)] + #[expect(clippy::struct_field_names)] explanation: Option<&'a str>, preview: bool, } @@ -43,12 +44,16 @@ impl<'a> Explanation<'a> { fn format_rule_text(rule: Rule) -> String { let mut output = String::new(); - output.push_str(&format!("# {} ({})", rule.as_ref(), rule.noqa_code())); + let _ = write!(&mut output, "# {} ({})", rule.as_ref(), rule.noqa_code()); output.push('\n'); output.push('\n'); let (linter, _) = Linter::parse_code(&rule.noqa_code().to_string()).unwrap(); - output.push_str(&format!("Derived from the **{}** linter.", linter.name())); + let _ = write!( + &mut output, + "Derived from the **{}** linter.", + linter.name() + ); output.push('\n'); output.push('\n'); @@ -76,7 +81,7 @@ fn format_rule_text(rule: Rule) -> String { output.push_str("Message formats:"); for format in rule.message_formats() { output.push('\n'); - output.push_str(&format!("* {format}")); + let _ = write!(&mut output, "* {format}"); } } output @@ -92,7 +97,7 @@ pub(crate) fn rule(rule: Rule, format: HelpFormat) -> Result<()> { HelpFormat::Json => { serde_json::to_writer_pretty(stdout, &Explanation::from_rule(&rule))?; } - }; + } Ok(()) } diff --git a/crates/ruff/src/commands/show_files.rs b/crates/ruff/src/commands/show_files.rs index f21a9aa9430cc..7c74837fd3495 100644 --- a/crates/ruff/src/commands/show_files.rs +++ b/crates/ruff/src/commands/show_files.rs @@ -5,7 +5,7 @@ use anyhow::Result; use itertools::Itertools; use ruff_linter::warn_user_once; -use ruff_workspace::resolver::{python_files_in_path, PyprojectConfig, ResolvedFile}; +use ruff_workspace::resolver::{PyprojectConfig, ResolvedFile, python_files_in_path}; use crate::args::ConfigArguments; diff --git a/crates/ruff/src/commands/show_settings.rs b/crates/ruff/src/commands/show_settings.rs index 679c2733dff37..ec4b0d54825d1 100644 --- a/crates/ruff/src/commands/show_settings.rs +++ b/crates/ruff/src/commands/show_settings.rs @@ -1,10 +1,10 @@ use std::io::Write; use std::path::PathBuf; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use itertools::Itertools; -use ruff_workspace::resolver::{python_files_in_path, PyprojectConfig, ResolvedFile}; +use ruff_workspace::resolver::{PyprojectConfig, ResolvedFile, python_files_in_path}; use crate::args::ConfigArguments; diff --git a/crates/ruff/src/commands/version.rs b/crates/ruff/src/commands/version.rs index 729d0f15d5e9e..3361071206843 100644 --- a/crates/ruff/src/commands/version.rs +++ b/crates/ruff/src/commands/version.rs @@ -16,6 +16,6 @@ pub(crate) fn version(output_format: HelpFormat) -> Result<()> { HelpFormat::Json => { serde_json::to_writer_pretty(stdout, &version_info)?; } - }; + } Ok(()) } diff --git a/crates/ruff/src/diagnostics.rs b/crates/ruff/src/diagnostics.rs index 99fab940516ef..6b88d7ce36c42 100644 --- a/crates/ruff/src/diagnostics.rs +++ b/crates/ruff/src/diagnostics.rs @@ -14,17 +14,18 @@ use rustc_hash::FxHashMap; use ruff_diagnostics::Diagnostic; use ruff_linter::codes::Rule; -use ruff_linter::linter::{lint_fix, lint_only, FixTable, FixerResult, LinterResult, ParseSource}; -use ruff_linter::message::{Message, SyntaxErrorMessage}; +use ruff_linter::linter::{FixTable, FixerResult, LinterResult, ParseSource, lint_fix, lint_only}; +use ruff_linter::message::Message; +use ruff_linter::package::PackageRoot; use ruff_linter::pyproject_toml::lint_pyproject_toml; use ruff_linter::settings::types::UnsafeFixes; -use ruff_linter::settings::{flags, LinterSettings}; +use ruff_linter::settings::{LinterSettings, flags}; use ruff_linter::source_kind::{SourceError, SourceKind}; -use ruff_linter::{fs, IOError}; +use ruff_linter::{IOError, fs}; use ruff_notebook::{Notebook, NotebookError, NotebookIndex}; use ruff_python_ast::{PySourceType, SourceType, TomlSourceType}; use ruff_source_file::SourceFileBuilder; -use ruff_text_size::{TextRange, TextSize}; +use ruff_text_size::TextRange; use ruff_workspace::Settings; use crate::cache::{Cache, FileCacheKey, LintCacheData}; @@ -70,7 +71,7 @@ impl Diagnostics { TextRange::default(), ), source_file, - TextSize::default(), + None, )], FxHashMap::default(), ) @@ -101,11 +102,7 @@ impl Diagnostics { let name = path.map_or_else(|| "-".into(), Path::to_string_lossy); let dummy = SourceFileBuilder::new(name, "").finish(); Self::new( - vec![Message::SyntaxError(SyntaxErrorMessage { - message: err.to_string(), - range: TextRange::default(), - file: dummy, - })], + vec![Message::syntax_error(err, TextRange::default(), dummy)], FxHashMap::default(), ) } @@ -180,7 +177,7 @@ impl AddAssign for FixMap { /// Lint the source code at the given `Path`. pub(crate) fn lint_path( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, settings: &LinterSettings, cache: Option<&Cache>, noqa: flags::Noqa, @@ -262,48 +259,56 @@ pub(crate) fn lint_path( }; // Lint the file. - let ( - LinterResult { - messages, - has_syntax_error: has_error, - }, - transformed, - fixed, - ) = if matches!(fix_mode, flags::FixMode::Apply | flags::FixMode::Diff) { - if let Ok(FixerResult { - result, - transformed, - fixed, - }) = lint_fix( - path, - package, - noqa, - unsafe_fixes, - settings, - &source_kind, - source_type, - ) { - if !fixed.is_empty() { - match fix_mode { - flags::FixMode::Apply => transformed.write(&mut File::create(path)?)?, - flags::FixMode::Diff => { - write!( - &mut io::stdout().lock(), - "{}", - source_kind.diff(&transformed, Some(path)).unwrap() - )?; + let (result, transformed, fixed) = + if matches!(fix_mode, flags::FixMode::Apply | flags::FixMode::Diff) { + if let Ok(FixerResult { + result, + transformed, + fixed, + }) = lint_fix( + path, + package, + noqa, + unsafe_fixes, + settings, + &source_kind, + source_type, + ) { + if !fixed.is_empty() { + match fix_mode { + flags::FixMode::Apply => transformed.write(&mut File::create(path)?)?, + flags::FixMode::Diff => { + write!( + &mut io::stdout().lock(), + "{}", + source_kind.diff(&transformed, Some(path)).unwrap() + )?; + } + flags::FixMode::Generate => {} } - flags::FixMode::Generate => {} } - } - let transformed = if let Cow::Owned(transformed) = transformed { - transformed + let transformed = if let Cow::Owned(transformed) = transformed { + transformed + } else { + source_kind + }; + (result, transformed, fixed) } else { - source_kind - }; - (result, transformed, fixed) + // If we fail to fix, lint the original source code. + let result = lint_only( + path, + package, + settings, + noqa, + &source_kind, + source_type, + ParseSource::None, + ); + let transformed = source_kind; + let fixed = FxHashMap::default(); + (result, transformed, fixed) + } } else { - // If we fail to fix, lint the original source code. let result = lint_only( path, package, @@ -316,21 +321,10 @@ pub(crate) fn lint_path( let transformed = source_kind; let fixed = FxHashMap::default(); (result, transformed, fixed) - } - } else { - let result = lint_only( - path, - package, - settings, - noqa, - &source_kind, - source_type, - ParseSource::None, - ); - let transformed = source_kind; - let fixed = FxHashMap::default(); - (result, transformed, fixed) - }; + }; + + let has_error = result.has_syntax_errors(); + let messages = result.messages; if let Some((cache, relative_path, key)) = caching { // We don't cache parsing errors. @@ -369,23 +363,46 @@ pub(crate) fn lint_path( }) } -/// Generate `Diagnostic`s from source code content derived from -/// stdin. +/// Generate `Diagnostic`s from source code content derived from stdin. pub(crate) fn lint_stdin( path: Option<&Path>, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, contents: String, settings: &Settings, noqa: flags::Noqa, fix_mode: flags::FixMode, ) -> Result<Diagnostics> { - // TODO(charlie): Support `pyproject.toml`. let source_type = match path.and_then(|path| settings.linter.extension.get(path)) { None => match path.map(SourceType::from).unwrap_or_default() { SourceType::Python(source_type) => source_type, - SourceType::Toml(_) => { - return Ok(Diagnostics::default()); + + SourceType::Toml(source_type) if source_type.is_pyproject() => { + if !settings + .linter + .rules + .iter_enabled() + .any(|rule_code| rule_code.lint_source().is_pyproject_toml()) + { + return Ok(Diagnostics::default()); + } + + let path = path.unwrap(); + let source_file = + SourceFileBuilder::new(path.to_string_lossy(), contents.clone()).finish(); + + match fix_mode { + flags::FixMode::Diff | flags::FixMode::Generate => {} + flags::FixMode::Apply => write!(&mut io::stdout().lock(), "{contents}")?, + } + + return Ok(Diagnostics { + messages: lint_pyproject_toml(source_file, &settings.linter), + fixed: FixMap::from_iter([(fs::relativize_path(path), FixTable::default())]), + notebook_indexes: FxHashMap::default(), + }); } + + SourceType::Toml(_) => return Ok(Diagnostics::default()), }, Some(language) => PySourceType::from(language), }; diff --git a/crates/ruff/src/lib.rs b/crates/ruff/src/lib.rs index b88ae264e8e82..ef8f639746880 100644 --- a/crates/ruff/src/lib.rs +++ b/crates/ruff/src/lib.rs @@ -1,7 +1,7 @@ #![allow(clippy::print_stdout)] use std::fs::File; -use std::io::{self, stdout, BufWriter, Write}; +use std::io::{self, BufWriter, Write, stdout}; use std::num::NonZeroUsize; use std::path::{Path, PathBuf}; use std::process::ExitCode; @@ -11,10 +11,10 @@ use anyhow::Result; use clap::CommandFactory; use colored::Colorize; use log::warn; -use notify::{recommended_watcher, RecursiveMode, Watcher}; +use notify::{RecursiveMode, Watcher, recommended_watcher}; use args::{GlobalConfigArgs, ServerCommand}; -use ruff_linter::logging::{set_up_logging, LogLevel}; +use ruff_linter::logging::{LogLevel, set_up_logging}; use ruff_linter::settings::flags::FixMode; use ruff_linter::settings::types::OutputFormat; use ruff_linter::{fs, warn_user, warn_user_once}; @@ -29,7 +29,6 @@ pub mod args; mod cache; mod commands; mod diagnostics; -mod panic; mod printer; pub mod resolve; mod stdin; @@ -64,11 +63,19 @@ enum ChangeKind { /// Return the [`ChangeKind`] based on the list of modified file paths. /// /// Returns `None` if no relevant changes were detected. -fn change_detected(paths: &[PathBuf]) -> Option<ChangeKind> { +fn change_detected(event: ¬ify::Event) -> Option<ChangeKind> { // If any `.toml` files were modified, return `ChangeKind::Configuration`. Otherwise, return // `ChangeKind::SourceFile` if any `.py`, `.pyi`, `.pyw`, or `.ipynb` files were modified. let mut source_file = false; - for path in paths { + + if event.kind.is_access() || event.kind.is_other() { + return None; + } + + if event.need_rescan() { + return Some(ChangeKind::Configuration); + } + for path in &event.paths { if let Some(suffix) = path.extension() { match suffix.to_str() { Some("toml") => { @@ -105,7 +112,7 @@ fn is_stdin(files: &[PathBuf], stdin_filename: Option<&Path>) -> bool { file == Path::new("-") } -/// Returns the default set of files if none are provided, otherwise returns `None`. +/// Returns the default set of files if none are provided, otherwise returns provided files. fn resolve_default_files(files: Vec<PathBuf>, is_stdin: bool) -> Vec<PathBuf> { if files.is_empty() { if is_stdin { @@ -127,7 +134,7 @@ pub fn run( { let default_panic_hook = std::panic::take_hook(); std::panic::set_hook(Box::new(move |info| { - #[allow(clippy::print_stderr)] + #[expect(clippy::print_stderr)] { eprintln!( r#" @@ -146,7 +153,11 @@ pub fn run( })); } - set_up_logging(global_options.log_level())?; + // Don't set up logging for the server command, as it has its own logging setup + // and setting the global logger can only be done once. + if !matches!(command, Command::Server { .. }) { + set_up_logging(global_options.log_level())?; + } match command { Command::Version { output_format } => { @@ -217,7 +228,7 @@ fn server(args: ServerCommand) -> Result<ExitStatus> { // by default, we set the number of worker threads to `num_cpus`, with a maximum of 4. let worker_threads = std::thread::available_parallelism() .unwrap_or(four) - .max(four); + .min(four); commands::server::run_server(worker_threads, args.resolve_preview()) } @@ -279,8 +290,8 @@ pub fn check(args: CheckCommand, global_options: GlobalConfigArgs) -> Result<Exi // - If `--fix` or `--fix-only` is set, apply applicable fixes to the filesystem (or // print them to stdout, if we're reading from stdin). // - If `--diff` or `--fix-only` are set, don't print any violations (only applicable fixes) - // - By default, applicable fixes only include [`Applicablility::Automatic`], but if - // `--unsafe-fixes` is set, then [`Applicablility::Suggested`] fixes are included. + // - By default, applicable fixes only include [`Applicability::Automatic`], but if + // `--unsafe-fixes` is set, then [`Applicability::Suggested`] fixes are included. let fix_mode = if cli.diff { FixMode::Diff @@ -315,7 +326,7 @@ pub fn check(args: CheckCommand, global_options: GlobalConfigArgs) -> Result<Exi commands::add_noqa::add_noqa(&files, &pyproject_config, &config_arguments)?; if modifications > 0 && config_arguments.log_level >= LogLevel::Default { let s = if modifications == 1 { "" } else { "s" }; - #[allow(clippy::print_stderr)] + #[expect(clippy::print_stderr)] { eprintln!("Added {modifications} noqa directive{s}."); } @@ -377,7 +388,7 @@ pub fn check(args: CheckCommand, global_options: GlobalConfigArgs) -> Result<Exi loop { match rx.recv() { Ok(event) => { - let Some(change_kind) = change_detected(&event?.paths) else { + let Some(change_kind) = change_detected(&event?) else { continue; }; @@ -477,79 +488,119 @@ pub fn check(args: CheckCommand, global_options: GlobalConfigArgs) -> Result<Exi mod test_file_change_detector { use std::path::PathBuf; - use crate::{change_detected, ChangeKind}; + use crate::{ChangeKind, change_detected}; #[test] fn detect_correct_file_change() { assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("tmp/pyproject.toml"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/pyproject.toml"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("pyproject.toml"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("pyproject.toml"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("tmp1/tmp2/tmp3/pyproject.toml"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp1/tmp2/tmp3/pyproject.toml"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("tmp/ruff.toml"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/ruff.toml"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("tmp/.ruff.toml"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/.ruff.toml"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::SourceFile), - change_detected(&[ - PathBuf::from("tmp/rule.py"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/rule.py"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::SourceFile), - change_detected(&[ - PathBuf::from("tmp/rule.pyi"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/rule.pyi"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("pyproject.toml"), - PathBuf::from("tmp/rule.py"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("pyproject.toml"), + PathBuf::from("tmp/rule.py"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( Some(ChangeKind::Configuration), - change_detected(&[ - PathBuf::from("tmp/rule.py"), - PathBuf::from("pyproject.toml"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/rule.py"), + PathBuf::from("pyproject.toml"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); assert_eq!( None, - change_detected(&[ - PathBuf::from("tmp/rule.js"), - PathBuf::from("tmp/bin/ruff.rs"), - ]), + change_detected(¬ify::Event { + kind: notify::EventKind::Create(notify::event::CreateKind::File), + paths: vec![ + PathBuf::from("tmp/rule.js"), + PathBuf::from("tmp/bin/ruff.rs"), + ], + attrs: notify::event::EventAttributes::default(), + }), ); } } diff --git a/crates/ruff/src/main.rs b/crates/ruff/src/main.rs index 2271cca49b617..058b6bc9d509d 100644 --- a/crates/ruff/src/main.rs +++ b/crates/ruff/src/main.rs @@ -5,7 +5,7 @@ use clap::Parser; use colored::Colorize; use ruff::args::Args; -use ruff::{run, ExitStatus}; +use ruff::{ExitStatus, run}; #[cfg(target_os = "windows")] #[global_allocator] @@ -15,6 +15,7 @@ static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc; not(target_os = "windows"), not(target_os = "openbsd"), not(target_os = "aix"), + not(target_os = "android"), any( target_arch = "x86_64", target_arch = "aarch64", @@ -31,7 +32,7 @@ pub fn main() -> ExitCode { // support FORCE_COLOR env var if let Some(force_color) = std::env::var_os("FORCE_COLOR") { - if force_color.len() > 0 { + if !force_color.is_empty() { colored::control::set_override(true); } } diff --git a/crates/ruff/src/panic.rs b/crates/ruff/src/panic.rs deleted file mode 100644 index 5947873ef775d..0000000000000 --- a/crates/ruff/src/panic.rs +++ /dev/null @@ -1,46 +0,0 @@ -#[derive(Default, Debug)] -pub(crate) struct PanicError { - pub(crate) info: String, - pub(crate) backtrace: Option<std::backtrace::Backtrace>, -} - -impl std::fmt::Display for PanicError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - writeln!(f, "{}", self.info)?; - if let Some(backtrace) = &self.backtrace { - writeln!(f, "Backtrace: {backtrace}") - } else { - Ok(()) - } - } -} - -thread_local! { - static LAST_PANIC: std::cell::Cell<Option<PanicError>> = const { std::cell::Cell::new(None) }; -} - -/// [`catch_unwind`](std::panic::catch_unwind) wrapper that sets a custom [`set_hook`](std::panic::set_hook) -/// to extract the backtrace. The original panic-hook gets restored before returning. -pub(crate) fn catch_unwind<F, R>(f: F) -> Result<R, PanicError> -where - F: FnOnce() -> R + std::panic::UnwindSafe, -{ - let prev = std::panic::take_hook(); - std::panic::set_hook(Box::new(|info| { - let info = info.to_string(); - let backtrace = std::backtrace::Backtrace::force_capture(); - LAST_PANIC.with(|cell| { - cell.set(Some(PanicError { - info, - backtrace: Some(backtrace), - })); - }); - })); - - let result = std::panic::catch_unwind(f) - .map_err(|_| LAST_PANIC.with(std::cell::Cell::take).unwrap_or_default()); - - std::panic::set_hook(prev); - - result -} diff --git a/crates/ruff/src/printer.rs b/crates/ruff/src/printer.rs index c3181e98a7828..2f72e2bcd592f 100644 --- a/crates/ruff/src/printer.rs +++ b/crates/ruff/src/printer.rs @@ -1,23 +1,22 @@ use std::cmp::Reverse; -use std::fmt::Display; use std::hash::Hash; use std::io::Write; use anyhow::Result; use bitflags::bitflags; use colored::Colorize; -use itertools::{iterate, Itertools}; +use itertools::{Itertools, iterate}; +use ruff_linter::codes::NoqaCode; use serde::Serialize; use ruff_linter::fs::relativize_path; use ruff_linter::logging::LogLevel; use ruff_linter::message::{ AzureEmitter, Emitter, EmitterContext, GithubEmitter, GitlabEmitter, GroupedEmitter, - JsonEmitter, JsonLinesEmitter, JunitEmitter, Message, MessageKind, PylintEmitter, - RdjsonEmitter, SarifEmitter, TextEmitter, + JsonEmitter, JsonLinesEmitter, JunitEmitter, Message, PylintEmitter, RdjsonEmitter, + SarifEmitter, TextEmitter, }; use ruff_linter::notify_user; -use ruff_linter::registry::Rule; use ruff_linter::settings::flags::{self}; use ruff_linter::settings::types::{OutputFormat, UnsafeFixes}; @@ -27,69 +26,22 @@ bitflags! { #[derive(Default, Debug, Copy, Clone)] pub(crate) struct Flags: u8 { /// Whether to show violations when emitting diagnostics. - const SHOW_VIOLATIONS = 0b0000_0001; + const SHOW_VIOLATIONS = 1 << 0; /// Whether to show a summary of the fixed violations when emitting diagnostics. - const SHOW_FIX_SUMMARY = 0b0000_0100; + const SHOW_FIX_SUMMARY = 1 << 1; /// Whether to show a diff of each fixed violation when emitting diagnostics. - const SHOW_FIX_DIFF = 0b0000_1000; + const SHOW_FIX_DIFF = 1 << 2; } } #[derive(Serialize)] struct ExpandedStatistics { - code: Option<SerializeRuleAsCode>, - name: SerializeMessageKindAsTitle, + code: Option<NoqaCode>, + name: &'static str, count: usize, fixable: bool, } -#[derive(Copy, Clone)] -struct SerializeRuleAsCode(Rule); - -impl Serialize for SerializeRuleAsCode { - fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> - where - S: serde::Serializer, - { - serializer.serialize_str(&self.0.noqa_code().to_string()) - } -} - -impl Display for SerializeRuleAsCode { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - write!(f, "{}", self.0.noqa_code()) - } -} - -impl From<Rule> for SerializeRuleAsCode { - fn from(rule: Rule) -> Self { - Self(rule) - } -} - -struct SerializeMessageKindAsTitle(MessageKind); - -impl Serialize for SerializeMessageKindAsTitle { - fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> - where - S: serde::Serializer, - { - serializer.serialize_str(self.0.as_str()) - } -} - -impl Display for SerializeMessageKindAsTitle { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str(self.0.as_str()) - } -} - -impl From<MessageKind> for SerializeMessageKindAsTitle { - fn from(kind: MessageKind) -> Self { - Self(kind) - } -} - pub(crate) struct Printer { format: OutputFormat, log_level: LogLevel, @@ -157,7 +109,8 @@ impl Printer { } else { "es" }; - writeln!(writer, + writeln!( + writer, "{fix_prefix} {} fixable with the `--fix` option ({} hidden fix{es} can be enabled with the `--unsafe-fixes` option).", fixables.applicable, fixables.inapplicable_unsafe )?; @@ -175,7 +128,8 @@ impl Printer { } else { "es" }; - writeln!(writer, + writeln!( + writer, "No fixes available ({} hidden fix{es} can be enabled with the `--unsafe-fixes` option).", fixables.inapplicable_unsafe )?; @@ -205,15 +159,27 @@ impl Printer { if fixed > 0 { let s = if fixed == 1 { "" } else { "s" }; if self.fix_mode.is_apply() { - writeln!(writer, "Fixed {fixed} error{s} ({unapplied} additional fix{es} available with `--unsafe-fixes`).")?; + writeln!( + writer, + "Fixed {fixed} error{s} ({unapplied} additional fix{es} available with `--unsafe-fixes`)." + )?; } else { - writeln!(writer, "Would fix {fixed} error{s} ({unapplied} additional fix{es} available with `--unsafe-fixes`).")?; + writeln!( + writer, + "Would fix {fixed} error{s} ({unapplied} additional fix{es} available with `--unsafe-fixes`)." + )?; } } else { if self.fix_mode.is_apply() { - writeln!(writer, "No errors fixed ({unapplied} fix{es} available with `--unsafe-fixes`).")?; + writeln!( + writer, + "No errors fixed ({unapplied} fix{es} available with `--unsafe-fixes`)." + )?; } else { - writeln!(writer, "No errors would be fixed ({unapplied} fix{es} available with `--unsafe-fixes`).")?; + writeln!( + writer, + "No errors would be fixed ({unapplied} fix{es} available with `--unsafe-fixes`)." + )?; } } } else { @@ -241,7 +207,6 @@ impl Printer { } if !self.flags.intersects(Flags::SHOW_VIOLATIONS) { - #[allow(deprecated)] if matches!( self.format, OutputFormat::Full | OutputFormat::Concise | OutputFormat::Grouped @@ -337,23 +302,31 @@ impl Printer { let statistics: Vec<ExpandedStatistics> = diagnostics .messages .iter() - .sorted_by_key(|message| (message.rule(), message.fixable())) - .fold(vec![], |mut acc: Vec<(&Message, usize)>, message| { - if let Some((prev_message, count)) = acc.last_mut() { - if prev_message.rule() == message.rule() { - *count += 1; - return acc; + .map(|message| (message.to_noqa_code(), message)) + .sorted_by_key(|(code, message)| (*code, message.fixable())) + .fold( + vec![], + |mut acc: Vec<((Option<NoqaCode>, &Message), usize)>, (code, message)| { + if let Some(((prev_code, _prev_message), count)) = acc.last_mut() { + if *prev_code == code { + *count += 1; + return acc; + } } - } - acc.push((message, 1)); - acc - }) + acc.push(((code, message), 1)); + acc + }, + ) .iter() - .map(|&(message, count)| ExpandedStatistics { - code: message.rule().map(std::convert::Into::into), - name: message.kind().into(), + .map(|&((code, message), count)| ExpandedStatistics { + code, + name: message.name(), count, - fixable: message.fixable(), + fixable: if let Some(fix) = message.fix() { + fix.applies(self.unsafe_fixes.required_applicability()) + } else { + false + }, }) .sorted_by_key(|statistic| Reverse(statistic.count)) .collect(); @@ -412,9 +385,7 @@ impl Printer { )?; } - if any_fixable { - writeln!(writer, "[*] fixable with `ruff check --fix`",)?; - } + self.write_summary_text(writer, diagnostics)?; return Ok(()); } OutputFormat::Json => { diff --git a/crates/ruff/src/resolve.rs b/crates/ruff/src/resolve.rs index 89796ee156507..8c6b0c4bbb262 100644 --- a/crates/ruff/src/resolve.rs +++ b/crates/ruff/src/resolve.rs @@ -1,16 +1,18 @@ use std::path::Path; -use anyhow::Result; +use anyhow::{Result, bail}; use log::debug; use path_absolutize::path_dedot; use ruff_workspace::configuration::Configuration; -use ruff_workspace::pyproject; +use ruff_workspace::pyproject::{self, find_fallback_target_version}; use ruff_workspace::resolver::{ - resolve_root_settings, ConfigurationTransformer, PyprojectConfig, PyprojectDiscoveryStrategy, - Relativity, + ConfigurationOrigin, ConfigurationTransformer, PyprojectConfig, PyprojectDiscoveryStrategy, + resolve_root_settings, }; +use ruff_python_ast as ast; + use crate::args::ConfigArguments; /// Resolve the relevant settings strategy and defaults for the current @@ -19,10 +21,14 @@ pub fn resolve( config_arguments: &ConfigArguments, stdin_filename: Option<&Path>, ) -> Result<PyprojectConfig> { + let Ok(cwd) = std::env::current_dir() else { + bail!("Working directory does not exist") + }; + // First priority: if we're running in isolated mode, use the default settings. if config_arguments.isolated { let config = config_arguments.transform(Configuration::default()); - let settings = config.into_settings(&path_dedot::CWD)?; + let settings = config.into_settings(&cwd)?; debug!("Isolated mode, not reading any pyproject.toml"); return Ok(PyprojectConfig::new( PyprojectDiscoveryStrategy::Fixed, @@ -35,7 +41,11 @@ pub fn resolve( // `pyproject.toml` for _all_ configuration, and resolve paths relative to the // current working directory. (This matches ESLint's behavior.) if let Some(pyproject) = config_arguments.config_file() { - let settings = resolve_root_settings(pyproject, Relativity::Cwd, config_arguments)?; + let settings = resolve_root_settings( + pyproject, + config_arguments, + ConfigurationOrigin::UserSpecified, + )?; debug!( "Using user-specified configuration file at: {}", pyproject.display() @@ -52,16 +62,13 @@ pub fn resolve( // that directory. (With `Strategy::Hierarchical`, we'll end up finding // the "closest" `pyproject.toml` file for every Python file later on, // so these act as the "default" settings.) - if let Some(pyproject) = pyproject::find_settings_toml( - stdin_filename - .as_ref() - .unwrap_or(&path_dedot::CWD.as_path()), - )? { + if let Some(pyproject) = pyproject::find_settings_toml(stdin_filename.unwrap_or(&cwd))? { debug!( "Using configuration file (via parent) at: {}", pyproject.display() ); - let settings = resolve_root_settings(&pyproject, Relativity::Parent, config_arguments)?; + let settings = + resolve_root_settings(&pyproject, config_arguments, ConfigurationOrigin::Ancestor)?; return Ok(PyprojectConfig::new( PyprojectDiscoveryStrategy::Hierarchical, settings, @@ -74,11 +81,35 @@ pub fn resolve( // end up the "closest" `pyproject.toml` file for every Python file later on, so // these act as the "default" settings.) if let Some(pyproject) = pyproject::find_user_settings_toml() { + struct FallbackTransformer<'a> { + arguments: &'a ConfigArguments, + } + + impl ConfigurationTransformer for FallbackTransformer<'_> { + fn transform(&self, mut configuration: Configuration) -> Configuration { + // The `requires-python` constraint from the `pyproject.toml` takes precedence + // over the `target-version` from the user configuration. + let fallback = find_fallback_target_version(&*path_dedot::CWD); + if let Some(fallback) = fallback { + debug!("Derived `target-version` from found `requires-python`: {fallback:?}"); + configuration.target_version = Some(fallback.into()); + } + + self.arguments.transform(configuration) + } + } + debug!( "Using configuration file (via cwd) at: {}", pyproject.display() ); - let settings = resolve_root_settings(&pyproject, Relativity::Cwd, config_arguments)?; + let settings = resolve_root_settings( + &pyproject, + &FallbackTransformer { + arguments: config_arguments, + }, + ConfigurationOrigin::UserSettings, + )?; return Ok(PyprojectConfig::new( PyprojectDiscoveryStrategy::Hierarchical, settings, @@ -91,8 +122,21 @@ pub fn resolve( // "closest" `pyproject.toml` file for every Python file later on, so these act // as the "default" settings.) debug!("Using Ruff default settings"); - let config = config_arguments.transform(Configuration::default()); - let settings = config.into_settings(&path_dedot::CWD)?; + let mut config = config_arguments.transform(Configuration::default()); + if config.target_version.is_none() { + // If we have arrived here we know that there was no `pyproject.toml` + // containing a `[tool.ruff]` section found in an ancestral directory. + // (This is an implicit requirement in the function + // `pyproject::find_settings_toml`.) + // However, there may be a `pyproject.toml` with a `requires-python` + // specified, and that is what we look for in this step. + let fallback = find_fallback_target_version(stdin_filename.unwrap_or(&cwd)); + if let Some(version) = fallback { + debug!("Derived `target-version` from found `requires-python`: {version:?}"); + } + config.target_version = fallback.map(ast::PythonVersion::from); + } + let settings = config.into_settings(&cwd)?; Ok(PyprojectConfig::new( PyprojectDiscoveryStrategy::Hierarchical, settings, diff --git a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting.snap b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting.snap index 501be194f8993..0009f4a09c993 100644 --- a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting.snap +++ b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting.snap @@ -1,5 +1,6 @@ --- source: crates/ruff/src/version.rs expression: version +snapshot_kind: text --- 0.0.0 diff --git a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commit_info.snap b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commit_info.snap index b661aab1a7781..59aa8927d5fdc 100644 --- a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commit_info.snap +++ b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commit_info.snap @@ -1,5 +1,6 @@ --- source: crates/ruff/src/version.rs expression: version +snapshot_kind: text --- 0.0.0 (53b0f5d92 2023-10-19) diff --git a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commits_since_last_tag.snap b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commits_since_last_tag.snap index 8b856e8cf2809..e7055e7459795 100644 --- a/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commits_since_last_tag.snap +++ b/crates/ruff/src/snapshots/ruff__version__tests__version_formatting_with_commits_since_last_tag.snap @@ -1,5 +1,6 @@ --- source: crates/ruff/src/version.rs expression: version +snapshot_kind: text --- 0.0.0+24 (53b0f5d92 2023-10-19) diff --git a/crates/ruff/src/snapshots/ruff__version__tests__version_serializable.snap b/crates/ruff/src/snapshots/ruff__version__tests__version_serializable.snap index afb49fad965a2..352b2da34bde7 100644 --- a/crates/ruff/src/snapshots/ruff__version__tests__version_serializable.snap +++ b/crates/ruff/src/snapshots/ruff__version__tests__version_serializable.snap @@ -1,6 +1,7 @@ --- source: crates/ruff/src/version.rs expression: version +snapshot_kind: text --- { "version": "0.0.0", diff --git a/crates/ruff/tests/analyze_graph.rs b/crates/ruff/tests/analyze_graph.rs index 62f4a6c3f9158..e59a01c2949cc 100644 --- a/crates/ruff/tests/analyze_graph.rs +++ b/crates/ruff/tests/analyze_graph.rs @@ -422,3 +422,153 @@ fn nested_imports() -> Result<()> { Ok(()) } + +/// Test for venv resolution with the `--python` flag. +/// +/// Based on the [albatross-virtual-workspace] example from the uv repo and the report in [#16598]. +/// +/// [albatross-virtual-workspace]: https://github.com/astral-sh/uv/tree/aa629c4a/scripts/workspaces/albatross-virtual-workspace +/// [#16598]: https://github.com/astral-sh/ruff/issues/16598 +#[test] +fn venv() -> Result<()> { + let tempdir = TempDir::new()?; + let root = ChildPath::new(tempdir.path()); + + // packages + // ├── albatross + // │ ├── check_installed_albatross.py + // │ ├── pyproject.toml + // │ └── src + // │ └── albatross + // │ └── __init__.py + // └── bird-feeder + // ├── check_installed_bird_feeder.py + // ├── pyproject.toml + // └── src + // └── bird_feeder + // └── __init__.py + + let packages = root.child("packages"); + + let albatross = packages.child("albatross"); + albatross + .child("check_installed_albatross.py") + .write_str("from albatross import fly")?; + albatross + .child("pyproject.toml") + .write_str(indoc::indoc! {r#" + [project] + name = "albatross" + version = "0.1.0" + requires-python = ">=3.12" + dependencies = ["bird-feeder", "tqdm>=4,<5"] + + [tool.uv.sources] + bird-feeder = { workspace = true } + "#})?; + albatross + .child("src") + .child("albatross") + .child("__init__.py") + .write_str("import tqdm; from bird_feeder import use")?; + + let bird_feeder = packages.child("bird-feeder"); + bird_feeder + .child("check_installed_bird_feeder.py") + .write_str("from bird_feeder import use; from albatross import fly")?; + bird_feeder + .child("pyproject.toml") + .write_str(indoc::indoc! {r#" + [project] + name = "bird-feeder" + version = "1.0.0" + requires-python = ">=3.12" + dependencies = ["anyio>=4.3.0,<5"] + "#})?; + bird_feeder + .child("src") + .child("bird_feeder") + .child("__init__.py") + .write_str("import anyio")?; + + let venv = root.child(".venv"); + let bin = venv.child("bin"); + bin.child("python").touch()?; + let home = format!("home = {}", bin.to_string_lossy()); + venv.child("pyvenv.cfg").write_str(&home)?; + let site_packages = venv.child("lib").child("python3.12").child("site-packages"); + site_packages + .child("_albatross.pth") + .write_str(&albatross.join("src").to_string_lossy())?; + site_packages + .child("_bird_feeder.pth") + .write_str(&bird_feeder.join("src").to_string_lossy())?; + site_packages.child("tqdm").child("__init__.py").touch()?; + + // without `--python .venv`, the result should only include dependencies within the albatross + // package + insta::with_settings!({ + filters => INSTA_FILTERS.to_vec(), + }, { + assert_cmd_snapshot!( + command().arg("packages/albatross").current_dir(&root), + @r#" + success: true + exit_code: 0 + ----- stdout ----- + { + "packages/albatross/check_installed_albatross.py": [ + "packages/albatross/src/albatross/__init__.py" + ], + "packages/albatross/src/albatross/__init__.py": [] + } + + ----- stderr ----- + "#); + }); + + // with `--python .venv` both workspace and third-party dependencies are included + insta::with_settings!({ + filters => INSTA_FILTERS.to_vec(), + }, { + assert_cmd_snapshot!( + command().args(["--python", ".venv"]).arg("packages/albatross").current_dir(&root), + @r#" + success: true + exit_code: 0 + ----- stdout ----- + { + "packages/albatross/check_installed_albatross.py": [ + "packages/albatross/src/albatross/__init__.py" + ], + "packages/albatross/src/albatross/__init__.py": [ + ".venv/lib/python3.12/site-packages/tqdm/__init__.py", + "packages/bird-feeder/src/bird_feeder/__init__.py" + ] + } + + ----- stderr ----- + "#); + }); + + // test the error message for a non-existent venv. it's important that the `ruff analyze graph` + // flag matches the ty flag used to generate the error message (`--python`) + insta::with_settings!({ + filters => INSTA_FILTERS.to_vec(), + }, { + assert_cmd_snapshot!( + command().args(["--python", "none"]).arg("packages/albatross").current_dir(&root), + @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Invalid search path settings + Cause: Failed to discover the site-packages directory: Invalid `--python` argument: `none` could not be canonicalized + "); + }); + + Ok(()) +} diff --git a/crates/ruff/tests/config.rs b/crates/ruff/tests/config.rs index ff0bf59184376..7ef338f68c9b8 100644 --- a/crates/ruff/tests/config.rs +++ b/crates/ruff/tests/config.rs @@ -8,7 +8,7 @@ const BIN_NAME: &str = "ruff"; #[test] fn lint_select() { assert_cmd_snapshot!( - Command::new(get_cargo_bin(BIN_NAME)).arg("config").arg("lint.select"), @r###" + Command::new(get_cargo_bin(BIN_NAME)).arg("config").arg("lint.select"), @r#" success: true exit_code: 0 ----- stdout ----- @@ -18,7 +18,8 @@ fn lint_select() { When breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less - specific prefixes. + specific prefixes. `ignore` takes precedence over `select` if the + same prefix appears in both. Default value: ["E4", "E7", "E9", "F"] Type: list[RuleSelector] @@ -29,19 +30,19 @@ fn lint_select() { ``` ----- stderr ----- - "### + "# ); } #[test] fn lint_select_json() { assert_cmd_snapshot!( - Command::new(get_cargo_bin(BIN_NAME)).arg("config").arg("lint.select").arg("--output-format").arg("json"), @r###" + Command::new(get_cargo_bin(BIN_NAME)).arg("config").arg("lint.select").arg("--output-format").arg("json"), @r##" success: true exit_code: 0 ----- stdout ----- { - "doc": "A list of rule codes or prefixes to enable. Prefixes can specify exact\nrules (like `F841`), entire categories (like `F`), or anything in\nbetween.\n\nWhen breaking ties between enabled and disabled rules (via `select` and\n`ignore`, respectively), more specific prefixes override less\nspecific prefixes.", + "doc": "A list of rule codes or prefixes to enable. Prefixes can specify exact\nrules (like `F841`), entire categories (like `F`), or anything in\nbetween.\n\nWhen breaking ties between enabled and disabled rules (via `select` and\n`ignore`, respectively), more specific prefixes override less\nspecific prefixes. `ignore` takes precedence over `select` if the\nsame prefix appears in both.", "default": "[\"E4\", \"E7\", \"E9\", \"F\"]", "value_type": "list[RuleSelector]", "scope": null, @@ -50,6 +51,6 @@ fn lint_select_json() { } ----- stderr ----- - "### + "## ); } diff --git a/crates/ruff/tests/direxist_guard.rs b/crates/ruff/tests/direxist_guard.rs new file mode 100644 index 0000000000000..3812d9ba0336f --- /dev/null +++ b/crates/ruff/tests/direxist_guard.rs @@ -0,0 +1,30 @@ +//! Test to verify Ruff's behavior when run from deleted directory. +//! It has to be isolated in a separate module. +//! Tests in the same module become flaky under `cargo test`s parallel execution +//! due to in-test working directory manipulation. + +#![cfg(target_family = "unix")] + +use std::env::set_current_dir; +use std::process::Command; + +use insta_cmd::{assert_cmd_snapshot, get_cargo_bin}; +const BIN_NAME: &str = "ruff"; + +#[test] +fn check_in_deleted_directory_errors() { + let temp_dir = tempfile::tempdir().unwrap(); + let temp_path = temp_dir.path().to_path_buf(); + set_current_dir(&temp_path).unwrap(); + drop(temp_dir); + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)).arg("check"), @r###" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Working directory does not exist + "###); +} diff --git a/crates/ruff/tests/format.rs b/crates/ruff/tests/format.rs index e756b03596e63..31991f9b28bf4 100644 --- a/crates/ruff/tests/format.rs +++ b/crates/ruff/tests/format.rs @@ -30,7 +30,7 @@ if condition: print('Hy "Micha"') # Should not change quotes -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -45,7 +45,7 @@ if condition: print('Hy "Micha"') # Should not change quotes ----- stderr ----- - "###); + "#); } #[test] @@ -65,7 +65,7 @@ bar = "needs formatting" )?; assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["format", "--isolated", "--no-cache", "--check"]).current_dir(tempdir.path()), @r###" + .args(["format", "--isolated", "--no-cache", "--check"]).current_dir(tempdir.path()), @r" success: false exit_code: 1 ----- stdout ----- @@ -74,7 +74,7 @@ bar = "needs formatting" 2 files would be reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -84,7 +84,7 @@ fn format_warn_stdin_filename_with_files() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--isolated", "--stdin-filename", "foo.py"]) .arg("foo.py") - .pass_stdin("foo = 1"), @r###" + .pass_stdin("foo = 1"), @r" success: true exit_code: 0 ----- stdout ----- @@ -92,13 +92,13 @@ fn format_warn_stdin_filename_with_files() { ----- stderr ----- warning: Ignoring file foo.py in favor of standard input. - "###); + "); } #[test] fn nonexistent_config_file() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["format", "--config", "foo.toml", "."]), @r###" + .args(["format", "--config", "foo.toml", "."]), @r" success: false exit_code: 2 ----- stdout ----- @@ -114,13 +114,13 @@ fn nonexistent_config_file() { The path `foo.toml` does not point to a configuration file For more information, try '--help'. - "###); + "); } #[test] fn config_override_rejected_if_invalid_toml() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["format", "--config", "foo = bar", "."]), @r###" + .args(["format", "--config", "foo = bar", "."]), @r#" success: false exit_code: 2 ----- stdout ----- @@ -142,7 +142,7 @@ fn config_override_rejected_if_invalid_toml() { expected `"`, `'` For more information, try '--help'. - "###); + "#); } #[test] @@ -161,19 +161,18 @@ fn too_many_config_files() -> Result<()> { .arg(&ruff_dot_toml) .arg("--config") .arg(&ruff2_dot_toml) - .arg("."), @r###" - success: false - exit_code: 2 - ----- stdout ----- - - ----- stderr ----- - ruff failed - Cause: You cannot specify more than one configuration file on the command line. + .arg("."), @r" + success: false + exit_code: 2 + ----- stdout ----- - tip: remove either `--config=[TMP]/ruff.toml` or `--config=[TMP]/ruff2.toml`. - For more information, try `--help`. + ----- stderr ----- + ruff failed + Cause: You cannot specify more than one configuration file on the command line. - "###); + tip: remove either `--config=[TMP]/ruff.toml` or `--config=[TMP]/ruff2.toml`. + For more information, try `--help`. + "); }); Ok(()) } @@ -191,7 +190,7 @@ fn config_file_and_isolated() -> Result<()> { .arg("--config") .arg(&ruff_dot_toml) .arg("--isolated") - .arg("."), @r###" + .arg("."), @r" success: false exit_code: 2 ----- stdout ----- @@ -203,8 +202,7 @@ fn config_file_and_isolated() -> Result<()> { tip: You cannot specify a configuration file and also specify `--isolated`, as `--isolated` causes ruff to ignore all configuration files. For more information, try `--help`. - - "###); + "); }); Ok(()) } @@ -226,7 +224,7 @@ def foo(): // This overrides the long line length set in the config file .args(["--config", "line-length=80"]) .arg("-") - .pass_stdin(fixture), @r###" + .pass_stdin(fixture), @r#" success: true exit_code: 0 ----- stdout ----- @@ -236,7 +234,7 @@ def foo(): ) ----- stderr ----- - "###); + "#); Ok(()) } @@ -259,7 +257,7 @@ def foo(): // ...but this overrides them both: .args(["--line-length", "100"]) .arg("-") - .pass_stdin(fixture), @r###" + .pass_stdin(fixture), @r#" success: true exit_code: 0 ----- stdout ----- @@ -267,7 +265,7 @@ def foo(): print("looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong string") ----- stderr ----- - "###); + "#); Ok(()) } @@ -302,7 +300,7 @@ if condition: print("Should change quotes") -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -316,7 +314,7 @@ if condition: print('Should change quotes') ----- stderr ----- - "###); + "#); Ok(()) } @@ -357,7 +355,7 @@ def f(x): >>> foo, bar, quux = this_is_a_long_line(lion, hippo, lemur, bear) ''' pass -"), @r###" +"), @r#" success: true exit_code: 0 ----- stdout ----- @@ -403,7 +401,7 @@ def f(x): pass ----- stderr ----- - "###); + "#); Ok(()) } @@ -424,14 +422,14 @@ fn mixed_line_endings() -> Result<()> { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(["format", "--no-cache", "--diff", "--isolated"]) - .arg("."), @r###" + .arg("."), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- 2 files already formatted - "###); + "); Ok(()) } @@ -490,7 +488,7 @@ OTHER = "OTHER" // Explicitly pass test.py, should be formatted regardless of it being excluded by format.exclude .arg(test_path.file_name().unwrap()) // Format all other files in the directory, should respect the `exclude` and `format.exclude` options - .arg("."), @r###" + .arg("."), @r" success: false exit_code: 1 ----- stdout ----- @@ -499,7 +497,7 @@ OTHER = "OTHER" 2 files would be reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -517,14 +515,14 @@ from module import = assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(["format", "--no-cache", "--isolated", "--check"]) - .arg("main.py"), @r###" + .arg("main.py"), @r" success: false exit_code: 2 ----- stdout ----- ----- stderr ----- error: Failed to parse main.py:2:20: Expected an import name - "###); + "); Ok(()) } @@ -546,7 +544,7 @@ if __name__ == "__main__": assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(["format", "--no-cache", "--isolated", "--check"]) - .arg("main.py"), @r###" + .arg("main.py"), @r" success: false exit_code: 1 ----- stdout ----- @@ -554,31 +552,110 @@ if __name__ == "__main__": 1 file would be reformatted ----- stderr ----- - "###); + "); assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(["format", "--no-cache", "--isolated"]) - .arg("main.py"), @r###" + .arg("main.py"), @r" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - "###); + "); assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(["format", "--no-cache", "--isolated"]) - .arg("main.py"), @r###" + .arg("main.py"), @r" + success: true + exit_code: 0 + ----- stdout ----- + 1 file left unchanged + + ----- stderr ----- + "); + + Ok(()) +} + +#[test] +fn exit_non_zero_on_format() -> Result<()> { + let tempdir = TempDir::new()?; + + let contents = r#" +from test import say_hy + +if __name__ == "__main__": + say_hy("dear Ruff contributor") +"#; + + fs::write(tempdir.path().join("main.py"), contents)?; + + let mut cmd = Command::new(get_cargo_bin(BIN_NAME)); + cmd.current_dir(tempdir.path()) + .args([ + "format", + "--no-cache", + "--isolated", + "--exit-non-zero-on-format", + ]) + .arg("main.py"); + + // First format should exit with code 1 since the file needed formatting + assert_cmd_snapshot!(cmd, @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 file reformatted + + ----- stderr ----- + "); + + // Second format should exit with code 0 since no files needed formatting + assert_cmd_snapshot!(cmd, @r" + success: true + exit_code: 0 + ----- stdout ----- + 1 file left unchanged + + ----- stderr ----- + "); + + // Repeat the tests above with the --exit-non-zero-on-fix alias + fs::write(tempdir.path().join("main.py"), contents)?; + + let mut cmd = Command::new(get_cargo_bin(BIN_NAME)); + cmd.current_dir(tempdir.path()) + .args([ + "format", + "--no-cache", + "--isolated", + "--exit-non-zero-on-fix", + ]) + .arg("main.py"); + + // First format should exit with code 1 since the file needed formatting + assert_cmd_snapshot!(cmd, @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 file reformatted + + ----- stderr ----- + "); + + // Second format should exit with code 0 since no files needed formatting + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- 1 file left unchanged ----- stderr ----- - "###); + "); Ok(()) } @@ -638,7 +715,7 @@ OTHER = "OTHER" // Explicitly pass test.py, should be respect the `format.exclude` when `--force-exclude` is present .arg(test_path.file_name().unwrap()) // Format all other files in the directory, should respect the `exclude` and `format.exclude` options - .arg("."), @r###" + .arg("."), @r" success: false exit_code: 1 ----- stdout ----- @@ -646,7 +723,7 @@ OTHER = "OTHER" 1 file would be reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -673,7 +750,7 @@ from test import say_hy if __name__ == '__main__': say_hy("dear Ruff contributor") -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -686,7 +763,7 @@ if __name__ == '__main__': warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - 'ignore' -> 'lint.ignore' - "###); + "#); Ok(()) } @@ -713,7 +790,7 @@ from test import say_hy if __name__ == '__main__': say_hy("dear Ruff contributor") -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -727,7 +804,7 @@ if __name__ == '__main__': warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - 'ignore' -> 'lint.ignore' - "###); + "#); Ok(()) } @@ -770,7 +847,7 @@ if condition: print("Should change quotes") -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -785,8 +862,8 @@ if condition: print('Should change quotes') ----- stderr ----- - warning: The following rule may cause conflicts when used with the formatter: `COM812`. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `select` or `extend-select` configuration, or adding it to the `ignore` configuration. - "###); + warning: The following rule may cause conflicts when used with the formatter: `COM812`. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `lint.select` or `lint.extend-select` configuration, or adding it to the `lint.ignore` configuration. + "#); Ok(()) } @@ -811,21 +888,21 @@ tab-size = 2 .pass_stdin(r" if True: pass - "), @r###" + "), @r" success: false exit_code: 2 ----- stdout ----- ----- stderr ----- ruff failed + Cause: Failed to load configuration `[RUFF-TOML-PATH]` Cause: Failed to parse [RUFF-TOML-PATH] Cause: TOML parse error at line 1, column 1 | 1 | | ^ unknown field `tab-size` - - "###); + "); }); Ok(()) } @@ -851,21 +928,21 @@ format = "json" .arg("-") .pass_stdin(r" import os - "), @r###" + "), @r#" success: false exit_code: 2 ----- stdout ----- ----- stderr ----- ruff failed + Cause: Failed to load configuration `[RUFF-TOML-PATH]` Cause: Failed to parse [RUFF-TOML-PATH] Cause: TOML parse error at line 2, column 10 | 2 | format = "json" | ^^^^^^ invalid type: string "json", expected struct FormatOptions - - "###); + "#); }); Ok(()) } @@ -881,7 +958,7 @@ indent-width = 2 [lint] select = ["ALL"] -ignore = ["D203", "D212"] +ignore = ["D203", "D212", "ISC001"] [lint.isort] lines-after-imports = 3 @@ -895,6 +972,9 @@ inline-quotes = "single" docstring-quotes = "single" multiline-quotes = "single" +[lint.flake8-implicit-str-concat] +allow-multiline = false + [format] skip-magic-trailing-comma = true indent-style = "tab" @@ -912,24 +992,25 @@ def say_hy(name: str): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--no-cache", "--config"]) .arg(&ruff_toml) - .arg(test_path), @r###" + .arg(test_path), @r#" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - warning: The following rules may cause conflicts when used with the formatter: `COM812`, `ISC001`. To avoid unexpected behavior, we recommend disabling these rules, either by removing them from the `select` or `extend-select` configuration, or adding them to the `ignore` configuration. + warning: The following rule may cause conflicts when used with the formatter: `COM812`. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `lint.select` or `lint.extend-select` configuration, or adding it to the `lint.ignore` configuration. warning: The `format.indent-style="tab"` option is incompatible with `W191`, which lints against all uses of tabs. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `"space"`. + warning: The `lint.flake8-implicit-str-concat.allow-multiline = false` option is incompatible with the formatter unless `ISC001` is enabled. We recommend enabling `ISC001` or setting `allow-multiline=true`. warning: The `format.indent-style="tab"` option is incompatible with `D206`, with requires space-based indentation. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `"space"`. warning: The `flake8-quotes.inline-quotes="single"` option is incompatible with the formatter's `format.quote-style="double"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `"single"` or `"double"`. warning: The `flake8-quotes.multiline-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q001` when using the formatter, which enforces double quotes for multiline strings. Alternatively, set the `flake8-quotes.multiline-quotes` option to `"double"`.` - warning: The `flake8-quotes.multiline-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `"double"`.` + warning: The `flake8-quotes.docstring-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `"double"`.` warning: The isort option `isort.lines-after-imports` with a value other than `-1`, `1` or `2` is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `2`, `1`, or `-1` (default). warning: The isort option `isort.lines-between-types` with a value greater than 1 is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `1` or `0` (default). warning: The isort option `isort.force-wrap-aliases` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.force-wrap-aliases=false` or `format.skip-magic-trailing-comma=false`. warning: The isort option `isort.split-on-trailing-comma` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.split-on-trailing-comma=false` or `format.skip-magic-trailing-comma=false`. - "###); + "#); Ok(()) } @@ -970,7 +1051,7 @@ indent-style = "tab" .arg("-") .pass_stdin(r#" def say_hy(name: str): - print(f"Hy {name}")"#), @r###" + print(f"Hy {name}")"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -978,17 +1059,17 @@ def say_hy(name: str): print(f"Hy {name}") ----- stderr ----- - warning: The following rules may cause conflicts when used with the formatter: `COM812`, `ISC001`. To avoid unexpected behavior, we recommend disabling these rules, either by removing them from the `select` or `extend-select` configuration, or adding them to the `ignore` configuration. + warning: The following rule may cause conflicts when used with the formatter: `COM812`. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `lint.select` or `lint.extend-select` configuration, or adding it to the `lint.ignore` configuration. warning: The `format.indent-style="tab"` option is incompatible with `W191`, which lints against all uses of tabs. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `"space"`. warning: The `format.indent-style="tab"` option is incompatible with `D206`, with requires space-based indentation. We recommend disabling these rules when using the formatter, which enforces a consistent indentation style. Alternatively, set the `format.indent-style` option to `"space"`. warning: The `flake8-quotes.inline-quotes="single"` option is incompatible with the formatter's `format.quote-style="double"`. We recommend disabling `Q000` and `Q003` when using the formatter, which enforces a consistent quote style. Alternatively, set both options to either `"single"` or `"double"`. warning: The `flake8-quotes.multiline-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q001` when using the formatter, which enforces double quotes for multiline strings. Alternatively, set the `flake8-quotes.multiline-quotes` option to `"double"`.` - warning: The `flake8-quotes.multiline-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `"double"`.` + warning: The `flake8-quotes.docstring-quotes="single"` option is incompatible with the formatter. We recommend disabling `Q002` when using the formatter, which enforces double quotes for docstrings. Alternatively, set the `flake8-quotes.docstring-quotes` option to `"double"`.` warning: The isort option `isort.lines-after-imports` with a value other than `-1`, `1` or `2` is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `2`, `1`, or `-1` (default). warning: The isort option `isort.lines-between-types` with a value greater than 1 is incompatible with the formatter. To avoid unexpected behavior, we recommend setting the option to one of: `1` or `0` (default). warning: The isort option `isort.force-wrap-aliases` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.force-wrap-aliases=false` or `format.skip-magic-trailing-comma=false`. warning: The isort option `isort.split-on-trailing-comma` is incompatible with the formatter `format.skip-magic-trailing-comma=true` option. To avoid unexpected behavior, we recommend either setting `isort.split-on-trailing-comma=false` or `format.skip-magic-trailing-comma=false`. - "###); + "#); Ok(()) } @@ -1032,14 +1113,14 @@ def say_hy(name: str): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--no-cache", "--config"]) .arg(&ruff_toml) - .arg(test_path), @r###" + .arg(test_path), @r" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -1074,14 +1155,14 @@ def say_hy(name: str): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--no-cache", "--config"]) .arg(&ruff_toml) - .arg(test_path), @r###" + .arg(test_path), @r" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -1109,17 +1190,17 @@ def say_hy(name: str): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--no-cache", "--config"]) .arg(&ruff_toml) - .arg(test_path), @r###" + .arg(test_path), @r" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - warning: `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible. Ignoring `one-blank-line-before-class`. + warning: `incorrect-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible. Ignoring `incorrect-blank-line-before-class`. warning: `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible. Ignoring `multi-line-summary-second-line`. - warning: The following rules may cause conflicts when used with the formatter: `COM812`, `ISC001`. To avoid unexpected behavior, we recommend disabling these rules, either by removing them from the `select` or `extend-select` configuration, or adding them to the `ignore` configuration. - "###); + warning: The following rule may cause conflicts when used with the formatter: `COM812`. To avoid unexpected behavior, we recommend disabling this rule, either by removing it from the `lint.select` or `lint.extend-select` configuration, or adding it to the `lint.ignore` configuration. + "); Ok(()) } @@ -1138,7 +1219,7 @@ fn test_diff() { ]}, { assert_cmd_snapshot!( Command::new(get_cargo_bin(BIN_NAME)).args(args).args(paths), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1186,7 +1267,7 @@ fn test_diff() { ----- stderr ----- 2 files would be reformatted, 1 file already formatted - "###); + "); }); } @@ -1201,7 +1282,7 @@ fn test_diff_no_change() { ]}, { assert_cmd_snapshot!( Command::new(get_cargo_bin(BIN_NAME)).args(args).args(paths), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1216,7 +1297,7 @@ fn test_diff_no_change() { ----- stderr ----- 1 file would be reformatted - "### + " ); }); } @@ -1235,7 +1316,7 @@ fn test_diff_stdin_unformatted() { let unformatted = fs::read(fixtures.join("unformatted.py")).unwrap(); assert_cmd_snapshot!( Command::new(get_cargo_bin(BIN_NAME)).args(args).pass_stdin(unformatted), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1249,7 +1330,7 @@ fn test_diff_stdin_unformatted() { ----- stderr ----- - "###); + "); } #[test] @@ -1259,13 +1340,13 @@ fn test_diff_stdin_formatted() { let unformatted = fs::read(fixtures.join("formatted.py")).unwrap(); assert_cmd_snapshot!( Command::new(get_cargo_bin(BIN_NAME)).args(args).pass_stdin(unformatted), - @r###" + @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- - "###); + "); } #[test] @@ -1275,7 +1356,7 @@ fn test_notebook_trailing_semicolon() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--isolated", "--stdin-filename", "test.ipynb"]) .arg("-") - .pass_stdin(unformatted), @r###" + .pass_stdin(unformatted), @r##" success: true exit_code: 0 ----- stdout ----- @@ -1694,7 +1775,88 @@ fn test_notebook_trailing_semicolon() { } ----- stderr ----- - "###); + "##); +} + +#[test] +fn syntax_error_in_notebooks() -> Result<()> { + let tempdir = TempDir::new()?; + + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +include = ["*.ipy"] +"#, + )?; + + fs::write( + tempdir.path().join("main.ipy"), + r#" +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "id": "S6nTuMqGGqp2" + }, + "outputs": [], + "source": [ + "np.random.seed(RANDOM_STATE)\n", + "X = pd.DataFrame(data=X, columns=np.arange(0, X.shape[1]))\n", + "X[10] = X[6] + X[7] + np.random.random() * 0.01" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "id": "fTZWxz1zpb9R" + }, + "outputs": [], + "source": [ + "for i in range(iterations):\n", + " # выберите случайный индекс в диапазон от 0 до len(X)-1 включительно при помощи функции random.randint\n", + " j = # ваш код здесь\n" + ] + } + ], + "metadata": { + "colab": { + "provenance": [] + }, + "kernelspec": { + "display_name": "ml", + "language": "python", + "name": "python3" + }, + "language_info": { + "name": "python", + "version": "3.12.9" + } + }, + "nbformat": 4, + "nbformat_minor": 0 + } +"#, + )?; + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .current_dir(tempdir.path()) + .arg("format") + .arg("--no-cache") + .args(["--config", &ruff_toml.file_name().unwrap().to_string_lossy()]) + .args(["--extension", "ipy:ipynb"]) + .arg("."), @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: Failed to parse main.ipy:2:3:24: Expected an expression + "); + Ok(()) } #[test] @@ -1756,14 +1918,14 @@ include = ["*.ipy"] .arg("--no-cache") .args(["--config", &ruff_toml.file_name().unwrap().to_string_lossy()]) .args(["--extension", "ipy:ipynb"]) - .arg("."), @r###" + .arg("."), @r" success: true exit_code: 0 ----- stdout ----- 1 file reformatted ----- stderr ----- - "###); + "); Ok(()) } @@ -1776,7 +1938,7 @@ fn range_formatting() { def foo(arg1, arg2,): print("Shouldn't format this" ) -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -1789,7 +1951,7 @@ def foo(arg1, arg2,): ----- stderr ----- - "###); + "#); } #[test] @@ -1799,7 +1961,7 @@ fn range_formatting_unicode() { .arg("-") .pass_stdin(r#" def foo(arg1="👋🏽" ): print("Format this" ) -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -1808,7 +1970,7 @@ def foo(arg1="👋🏽" ): print("Format this" ) print("Format this") ----- stderr ----- - "###); + "#); } #[test] @@ -1839,7 +2001,7 @@ def file2(arg1, arg2,): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(["format", "--isolated", "--range=1:8-1:15"]) .arg(file1) - .arg(file2), @r###" + .arg(file2), @r" success: false exit_code: 2 ----- stdout ----- @@ -1847,7 +2009,7 @@ def file2(arg1, arg2,): ----- stderr ----- ruff failed Cause: The `--range` option is only supported when formatting a single file but the specified paths resolve to 2 files. - "###); + "); Ok(()) } @@ -1861,7 +2023,7 @@ fn range_formatting_out_of_bounds() { def foo(arg1, arg2,): print("Shouldn't format this" ) -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -1871,7 +2033,7 @@ def foo(arg1, arg2,): ----- stderr ----- - "###); + "#); } #[test] @@ -1883,7 +2045,7 @@ fn range_start_larger_than_end() { def foo(arg1, arg2,): print("Shouldn't format this" ) -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -1893,7 +2055,7 @@ def foo(arg1, arg2,): tip: Try switching start and end: '50:1-90:1' For more information, try '--help'. - "###); + "); } #[test] @@ -1905,7 +2067,7 @@ fn range_line_numbers_only() { def foo(arg1, arg2,): print("Shouldn't format this" ) -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -1918,7 +2080,7 @@ def foo(arg1, arg2,): ----- stderr ----- - "###); + "#); } #[test] @@ -1930,7 +2092,7 @@ fn range_start_only() { def foo(arg1, arg2,): print("Should format this" ) -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -1939,7 +2101,7 @@ def foo(arg1, arg2,): print("Should format this") ----- stderr ----- - "###); + "#); } #[test] @@ -1975,7 +2137,7 @@ fn range_missing_line() { def foo(arg1, arg2,): print("Should format this" ) -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -1985,7 +2147,7 @@ def foo(arg1, arg2,): tip: The format is 'line:column'. For more information, try '--help'. - "###); + "); } #[test] @@ -1997,7 +2159,7 @@ fn zero_line_number() { def foo(arg1, arg2,): print("Should format this" ) -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -2008,7 +2170,7 @@ def foo(arg1, arg2,): tip: Try 1:2 instead. For more information, try '--help'. - "###); + "); } #[test] @@ -2020,7 +2182,7 @@ fn column_and_line_zero() { def foo(arg1, arg2,): print("Should format this" ) -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -2031,7 +2193,7 @@ def foo(arg1, arg2,): tip: Try 1:1 instead. For more information, try '--help'. - "###); + "); } #[test] @@ -2075,12 +2237,93 @@ fn range_formatting_notebook() { "nbformat": 4, "nbformat_minor": 5 } -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- ----- stderr ----- error: Failed to format main.ipynb: Range formatting isn't supported for notebooks. - "###); + "); +} + +/// Test that the formatter respects `per-file-target-version`. Context managers can't be +/// parenthesized like this before Python 3.10. +/// +/// Adapted from <https://github.com/python/cpython/issues/56991#issuecomment-1093555135> +#[test] +fn per_file_target_version_formatter() { + // without `per-file-target-version` this should not be reformatted in the same way + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(["format", "--isolated", "--stdin-filename", "test.py", "--target-version=py38"]) + .arg("-") + .pass_stdin(r#" +with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open("a_really_long_baz") as baz: + pass +"#), @r#" + success: true + exit_code: 0 + ----- stdout ----- + with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open( + "a_really_long_baz" + ) as baz: + pass + + ----- stderr ----- + "#); + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(["format", "--isolated", "--stdin-filename", "test.py", "--target-version=py38"]) + .args(["--config", r#"per-file-target-version = {"test.py" = "py311"}"#]) + .arg("-") + .pass_stdin(r#" +with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open("a_really_long_baz") as baz: + pass +"#), @r#" + success: true + exit_code: 0 + ----- stdout ----- + with ( + open("a_really_long_foo") as foo, + open("a_really_long_bar") as bar, + open("a_really_long_baz") as baz, + ): + pass + + ----- stderr ----- + "#); +} + +/// Regression test for <https://github.com/astral-sh/ruff/issues/9381> with very helpful +/// reproduction repo here: <https://github.com/lucasfijen/example_ruff_glob_bug> +#[test] +fn cookiecutter_globbing() -> Result<()> { + // This is a simplified directory structure from the repo linked above. The essence of the + // problem is this `{{cookiecutter.repo_name}}` directory containing a config file with a glob. + // The absolute path of the glob contains the glob metacharacters `{{` and `}}` even though the + // user's glob does not. + let tempdir = TempDir::new()?; + let cookiecutter = tempdir.path().join("{{cookiecutter.repo_name}}"); + let cookiecutter_toml = cookiecutter.join("pyproject.toml"); + let tests = cookiecutter.join("tests"); + fs::create_dir_all(&tests)?; + fs::write( + cookiecutter_toml, + r#"tool.ruff.lint.per-file-ignores = { "tests/*" = ["F811"] }"#, + )?; + let maintest = tests.join("maintest.py"); + fs::write(maintest, "import foo\nimport bar\nimport foo\n")?; + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(["format", "--no-cache", "--diff"]) + .current_dir(tempdir.path()), @r" + success: true + exit_code: 0 + ----- stdout ----- + + ----- stderr ----- + 1 file already formatted + "); + + Ok(()) } diff --git a/crates/ruff/tests/integration_test.rs b/crates/ruff/tests/integration_test.rs index 99ed3a74a28e5..3e8f5497ede43 100644 --- a/crates/ruff/tests/integration_test.rs +++ b/crates/ruff/tests/integration_test.rs @@ -97,21 +97,21 @@ impl<'a> RuffCheck<'a> { fn stdin_success() { let mut cmd = RuffCheck::default().args([]).build(); assert_cmd_snapshot!(cmd - .pass_stdin(""), @r###" + .pass_stdin(""), @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[test] fn stdin_error() { let mut cmd = RuffCheck::default().args([]).build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -126,7 +126,7 @@ fn stdin_error() { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); } #[test] @@ -135,7 +135,7 @@ fn stdin_filename() { .args(["--stdin-filename", "F401.py"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -150,7 +150,7 @@ fn stdin_filename() { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); } #[test] @@ -170,7 +170,7 @@ import bar # unused import )?; assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--isolated", "--no-cache", "--select", "F401"]).current_dir(tempdir.path()), @r###" + .args(["check", "--isolated", "--no-cache", "--select", "F401"]).current_dir(tempdir.path()), @r" success: false exit_code: 1 ----- stdout ----- @@ -192,7 +192,7 @@ import bar # unused import [*] 2 fixable with the `--fix` option. ----- stderr ----- - "###); + "); Ok(()) } @@ -204,7 +204,7 @@ fn check_warn_stdin_filename_with_files() { .filename("foo.py") .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -220,7 +220,7 @@ fn check_warn_stdin_filename_with_files() { ----- stderr ----- warning: Ignoring file foo.py in favor of standard input. - "###); + "); } /// Raise `TCH` errors in `.py` files ... @@ -230,7 +230,7 @@ fn stdin_source_type_py() { .args(["--stdin-filename", "TCH.py"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -245,7 +245,7 @@ fn stdin_source_type_py() { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); } /// ... but not in `.pyi` files. @@ -255,14 +255,14 @@ fn stdin_source_type_pyi() { .args(["--stdin-filename", "TCH.pyi", "--select", "TCH"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[cfg(unix)] @@ -288,7 +288,7 @@ fn stdin_json() { fn stdin_fix_py() { let mut cmd = RuffCheck::default().args(["--fix"]).build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\nimport sys\n\nprint(sys.version)\n"), @r###" + .pass_stdin("import os\nimport sys\n\nprint(sys.version)\n"), @r" success: true exit_code: 0 ----- stdout ----- @@ -298,7 +298,7 @@ fn stdin_fix_py() { ----- stderr ----- Found 1 error (1 fixed, 0 remaining). - "###); + "); } #[test] @@ -387,7 +387,7 @@ fn stdin_fix_jupyter() { }, "nbformat": 4, "nbformat_minor": 5 -}"#), @r###" +}"#), @r#" success: false exit_code: 1 ----- stdout ----- @@ -478,7 +478,7 @@ fn stdin_fix_jupyter() { | Found 3 errors (2 fixed, 1 remaining). - "###); + "#); } #[test] @@ -565,7 +565,7 @@ fn stdin_override_parser_ipynb() { }, "nbformat": 4, "nbformat_minor": 5 -}"#), @r###" +}"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -587,7 +587,7 @@ fn stdin_override_parser_ipynb() { [*] 2 fixable with the `--fix` option. ----- stderr ----- - "###); + "); } #[test] @@ -601,7 +601,7 @@ fn stdin_override_parser_py() { ]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import os\n"), @r###" + .pass_stdin("import os\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -616,7 +616,7 @@ fn stdin_override_parser_py() { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); } #[test] @@ -636,7 +636,7 @@ fn stdin_fix_when_not_fixable_should_still_print_contents() { -:3:4: F634 If test is a tuple, which is always `True` | 1 | import sys - 2 | + 2 | 3 | if (1, 2): | ^^^^^^ F634 4 | print(sys.version) @@ -650,7 +650,7 @@ fn stdin_fix_when_not_fixable_should_still_print_contents() { fn stdin_fix_when_no_issues_should_still_print_contents() { let mut cmd = RuffCheck::default().args(["--fix"]).build(); assert_cmd_snapshot!(cmd - .pass_stdin("import sys\n\nprint(sys.version)\n"), @r###" + .pass_stdin("import sys\n\nprint(sys.version)\n"), @r" success: true exit_code: 0 ----- stdout ----- @@ -660,7 +660,7 @@ fn stdin_fix_when_no_issues_should_still_print_contents() { ----- stderr ----- All checks passed! - "###); + "); } #[test] @@ -723,7 +723,7 @@ fn stdin_format_jupyter() { "nbformat": 4, "nbformat_minor": 5 } -"#), @r###" +"#), @r#" success: true exit_code: 0 ----- stdout ----- @@ -787,14 +787,14 @@ fn stdin_format_jupyter() { } ----- stderr ----- - "###); + "#); } #[test] fn stdin_parse_error() { let mut cmd = RuffCheck::default().build(); assert_cmd_snapshot!(cmd - .pass_stdin("from foo import\n"), @r###" + .pass_stdin("from foo import\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -807,14 +807,14 @@ fn stdin_parse_error() { Found 1 error. ----- stderr ----- - "###); + "); } #[test] fn stdin_multiple_parse_error() { let mut cmd = RuffCheck::default().build(); assert_cmd_snapshot!(cmd - .pass_stdin("from foo import\nbar =\n"), @r###" + .pass_stdin("from foo import\nbar =\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -835,15 +835,15 @@ fn stdin_multiple_parse_error() { Found 2 errors. ----- stderr ----- - "###); + "); } #[test] fn parse_error_not_included() { - // Select any rule except for `E999`, syntax error should still be shown. + // Parse errors are always shown let mut cmd = RuffCheck::default().args(["--select=I"]).build(); assert_cmd_snapshot!(cmd - .pass_stdin("foo =\n"), @r###" + .pass_stdin("foo =\n"), @r" success: false exit_code: 1 ----- stdout ----- @@ -856,35 +856,14 @@ fn parse_error_not_included() { Found 1 error. ----- stderr ----- - "###); -} - -#[test] -fn deprecated_parse_error_selection() { - let mut cmd = RuffCheck::default().args(["--select=E999"]).build(); - assert_cmd_snapshot!(cmd - .pass_stdin("foo =\n"), @r###" - success: false - exit_code: 1 - ----- stdout ----- - -:1:6: SyntaxError: Expected an expression - | - 1 | foo = - | ^ - | - - Found 1 error. - - ----- stderr ----- - warning: Rule `E999` is deprecated and will be removed in a future release. Syntax errors will always be shown regardless of whether this rule is selected or not. - "###); + "); } #[test] fn full_output_preview() { let mut cmd = RuffCheck::default().args(["--preview"]).build(); assert_cmd_snapshot!(cmd - .pass_stdin("l = 1"), @r###" + .pass_stdin("l = 1"), @r" success: false exit_code: 1 ----- stdout ----- @@ -897,7 +876,7 @@ fn full_output_preview() { Found 1 error. ----- stderr ----- - "###); + "); } #[test] @@ -912,7 +891,7 @@ preview = true ", )?; let mut cmd = RuffCheck::default().config(&pyproject_toml).build(); - assert_cmd_snapshot!(cmd.pass_stdin("l = 1"), @r###" + assert_cmd_snapshot!(cmd.pass_stdin("l = 1"), @r" success: false exit_code: 1 ----- stdout ----- @@ -925,7 +904,7 @@ preview = true Found 1 error. ----- stderr ----- - "###); + "); Ok(()) } @@ -933,7 +912,7 @@ preview = true fn full_output_format() { let mut cmd = RuffCheck::default().output_format("full").build(); assert_cmd_snapshot!(cmd - .pass_stdin("l = 1"), @r###" + .pass_stdin("l = 1"), @r" success: false exit_code: 1 ----- stdout ----- @@ -946,7 +925,7 @@ fn full_output_format() { Found 1 error. ----- stderr ----- - "###); + "); } #[test] @@ -956,7 +935,7 @@ fn rule_f401() { #[test] fn rule_invalid_rule_name() { - assert_cmd_snapshot!(ruff_cmd().args(["rule", "RUF404"]), @r###" + assert_cmd_snapshot!(ruff_cmd().args(["rule", "RUF404"]), @r" success: false exit_code: 2 ----- stdout ----- @@ -965,24 +944,49 @@ fn rule_invalid_rule_name() { error: invalid value 'RUF404' for '[RULE]' For more information, try '--help'. - "###); + "); } #[test] fn show_statistics() { let mut cmd = RuffCheck::default() - .args(["--select", "F401", "--statistics"]) + .args(["--select", "C416", "--statistics"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import sys\nimport os\n\nprint(os.getuid())\n"), @r###" + .pass_stdin(r#" +def mvce(keys, values): + return {key: value for key, value in zip(keys, values)} +"#), @r" success: false exit_code: 1 ----- stdout ----- - 1 F401 [*] unused-import - [*] fixable with `ruff check --fix` + 1 C416 unnecessary-comprehension + Found 1 error. + No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); +} + +#[test] +fn show_statistics_unsafe_fixes() { + let mut cmd = RuffCheck::default() + .args(["--select", "C416", "--statistics", "--unsafe-fixes"]) + .build(); + assert_cmd_snapshot!(cmd + .pass_stdin(r#" +def mvce(keys, values): + return {key: value for key, value in zip(keys, values)} +"#), @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 C416 [*] unnecessary-comprehension + Found 1 error. + [*] 1 fixable with the --fix option. + + ----- stderr ----- + "); } #[test] @@ -990,28 +994,110 @@ fn show_statistics_json() { let mut cmd = RuffCheck::default() .args([ "--select", - "F401", + "C416", + "--statistics", + "--output-format", + "json", + ]) + .build(); + assert_cmd_snapshot!(cmd + .pass_stdin(r#" +def mvce(keys, values): + return {key: value for key, value in zip(keys, values)} +"#), @r#" + success: false + exit_code: 1 + ----- stdout ----- + [ + { + "code": "C416", + "name": "unnecessary-comprehension", + "count": 1, + "fixable": false + } + ] + + ----- stderr ----- + "#); +} + +#[test] +fn show_statistics_json_unsafe_fixes() { + let mut cmd = RuffCheck::default() + .args([ + "--select", + "C416", "--statistics", + "--unsafe-fixes", "--output-format", "json", ]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("import sys\nimport os\n\nprint(os.getuid())\n"), @r###" + .pass_stdin(r#" +def mvce(keys, values): + return {key: value for key, value in zip(keys, values)} +"#), @r#" success: false exit_code: 1 ----- stdout ----- [ { - "code": "F401", - "name": "unused-import", + "code": "C416", + "name": "unnecessary-comprehension", "count": 1, "fixable": true } ] ----- stderr ----- - "###); + "#); +} + +#[test] +fn show_statistics_syntax_errors() { + let mut cmd = RuffCheck::default() + .args(["--statistics", "--target-version=py39", "--preview"]) + .build(); + + // ParseError + assert_cmd_snapshot!( + cmd.pass_stdin("x ="), + @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 syntax-error + Found 1 error. + + ----- stderr ----- + "); + + // match before 3.10, UnsupportedSyntaxError + assert_cmd_snapshot!( + cmd.pass_stdin("match 2:\n case 1: ..."), + @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 syntax-error + Found 1 error. + + ----- stderr ----- + "); + + // rebound comprehension variable, SemanticSyntaxError + assert_cmd_snapshot!( + cmd.pass_stdin("[x := 1 for x in range(0)]"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + 1 syntax-error + Found 1 error. + + ----- stderr ----- + "); } #[test] @@ -1020,7 +1106,7 @@ fn preview_enabled_prefix() { let mut cmd = RuffCheck::default() .args(["--select", "RUF9", "--output-format=concise", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1034,7 +1120,7 @@ fn preview_enabled_prefix() { [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); } #[test] @@ -1042,7 +1128,7 @@ fn preview_enabled_all() { let mut cmd = RuffCheck::default() .args(["--select", "ALL", "--output-format=concise", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1058,9 +1144,9 @@ fn preview_enabled_all() { [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - warning: `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible. Ignoring `one-blank-line-before-class`. + warning: `incorrect-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible. Ignoring `incorrect-blank-line-before-class`. warning: `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible. Ignoring `multi-line-summary-second-line`. - "###); + "); } #[test] @@ -1069,7 +1155,7 @@ fn preview_enabled_direct() { let mut cmd = RuffCheck::default() .args(["--select", "RUF911", "--output-format=concise", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1077,7 +1163,7 @@ fn preview_enabled_direct() { Found 1 error. ----- stderr ----- - "###); + "); } #[test] @@ -1086,7 +1172,7 @@ fn preview_disabled_direct() { let mut cmd = RuffCheck::default() .args(["--select", "RUF911", "--output-format=concise"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- @@ -1094,7 +1180,7 @@ fn preview_disabled_direct() { ----- stderr ----- warning: Selection `RUF911` has no effect because preview is not enabled. - "###); + "); } #[test] @@ -1103,7 +1189,7 @@ fn preview_disabled_prefix_empty() { let mut cmd = RuffCheck::default() .args(["--select", "RUF91", "--output-format=concise"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- @@ -1111,7 +1197,7 @@ fn preview_disabled_prefix_empty() { ----- stderr ----- warning: Selection `RUF91` has no effect because preview is not enabled. - "###); + "); } #[test] @@ -1120,14 +1206,14 @@ fn preview_disabled_does_not_warn_for_empty_ignore_selections() { let mut cmd = RuffCheck::default() .args(["--ignore", "RUF9", "--output-format=concise"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[test] @@ -1136,14 +1222,14 @@ fn preview_disabled_does_not_warn_for_empty_fixable_selections() { let mut cmd = RuffCheck::default() .args(["--fixable", "RUF9", "--output-format=concise"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[test] @@ -1158,7 +1244,7 @@ fn preview_group_selector() { ]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin("I=42\n"), @r###" + .pass_stdin("I=42\n"), @r" success: false exit_code: 2 ----- stdout ----- @@ -1167,7 +1253,7 @@ fn preview_group_selector() { error: invalid value 'PREVIEW' for '--select <RULE_CODE>' For more information, try '--help'. - "###); + "); } #[test] @@ -1183,7 +1269,7 @@ fn preview_enabled_group_ignore() { "--output-format=concise", ]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1197,14 +1283,14 @@ fn preview_enabled_group_ignore() { [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); } #[test] fn removed_direct() { // Selection of a removed rule should fail let mut cmd = RuffCheck::default().args(["--select", "RUF931"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 2 ----- stdout ----- @@ -1212,7 +1298,7 @@ fn removed_direct() { ----- stderr ----- ruff failed Cause: Rule `RUF931` was removed and cannot be selected. - "###); + "); } #[test] @@ -1222,7 +1308,7 @@ fn removed_direct_multiple() { let mut cmd = RuffCheck::default() .args(["--select", "RUF930", "--select", "RUF931"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 2 ----- stdout ----- @@ -1232,8 +1318,7 @@ fn removed_direct_multiple() { Cause: The following rules have been removed and cannot be selected: - RUF930 - RUF931 - - "###); + "); } #[test] @@ -1241,21 +1326,83 @@ fn removed_indirect() { // Selection _including_ a removed rule without matching should not fail // nor should the rule be used let mut cmd = RuffCheck::default().args(["--select", "RUF93"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); +} + +#[test] +fn removed_ignore_direct() { + let mut cmd = RuffCheck::default().args(["--ignore", "UP027"]).build(); + assert_cmd_snapshot!(cmd, @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + warning: The following rules have been removed and ignoring them has no effect: + - UP027 + "); +} + +#[test] +fn removed_ignore_multiple_direct() { + let mut cmd = RuffCheck::default() + .args(["--ignore", "UP027", "--ignore", "PLR1706"]) + .build(); + assert_cmd_snapshot!(cmd, @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + warning: The following rules have been removed and ignoring them has no effect: + - PLR1706 + - UP027 + "); +} + +#[test] +fn removed_ignore_remapped_direct() { + let mut cmd = RuffCheck::default().args(["--ignore", "PGH001"]).build(); + assert_cmd_snapshot!(cmd, @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + warning: `PGH001` has been remapped to `S307`. + "); +} + +#[test] +fn removed_ignore_indirect() { + // `PLR170` includes removed rules but should not select or warn + // since it is not a "direct" selection + let mut cmd = RuffCheck::default().args(["--ignore", "PLR170"]).build(); + assert_cmd_snapshot!(cmd, @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + "); } #[test] fn redirect_direct() { // Selection of a redirected rule directly should use the new rule and warn let mut cmd = RuffCheck::default().args(["--select", "RUF940"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1264,7 +1411,7 @@ fn redirect_direct() { ----- stderr ----- warning: `RUF940` has been remapped to `RUF950`. - "###); + "); } #[test] @@ -1272,14 +1419,14 @@ fn redirect_indirect() { // Selection _including_ a redirected rule without matching should not fail // nor should the rule be used let mut cmd = RuffCheck::default().args(["--select", "RUF94"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[test] @@ -1287,7 +1434,7 @@ fn redirect_prefix() { // Selection using a redirected prefix should switch to all rules in the // new prefix let mut cmd = RuffCheck::default().args(["--select", "RUF96"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1296,7 +1443,7 @@ fn redirect_prefix() { ----- stderr ----- warning: `RUF96` has been remapped to `RUF95`. - "###); + "); } #[test] @@ -1304,7 +1451,7 @@ fn deprecated_direct() { // Selection of a deprecated rule without preview enabled should still work // but a warning should be displayed let mut cmd = RuffCheck::default().args(["--select", "RUF920"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1313,7 +1460,7 @@ fn deprecated_direct() { ----- stderr ----- warning: Rule `RUF920` is deprecated and will be removed in a future release. - "###); + "); } #[test] @@ -1321,7 +1468,7 @@ fn deprecated_multiple_direct() { let mut cmd = RuffCheck::default() .args(["--select", "RUF920", "--select", "RUF921"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1332,7 +1479,7 @@ fn deprecated_multiple_direct() { ----- stderr ----- warning: Rule `RUF920` is deprecated and will be removed in a future release. warning: Rule `RUF921` is deprecated and will be removed in a future release. - "###); + "); } #[test] @@ -1340,7 +1487,7 @@ fn deprecated_indirect() { // `RUF92` includes deprecated rules but should not warn // since it is not a "direct" selection let mut cmd = RuffCheck::default().args(["--select", "RUF92"]).build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 1 ----- stdout ----- @@ -1349,7 +1496,7 @@ fn deprecated_indirect() { Found 2 errors. ----- stderr ----- - "###); + "); } #[test] @@ -1358,7 +1505,7 @@ fn deprecated_direct_preview_enabled() { let mut cmd = RuffCheck::default() .args(["--select", "RUF920", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 2 ----- stdout ----- @@ -1366,7 +1513,7 @@ fn deprecated_direct_preview_enabled() { ----- stderr ----- ruff failed Cause: Selection of deprecated rule `RUF920` is not allowed when preview is enabled. - "###); + "); } #[test] @@ -1375,14 +1522,14 @@ fn deprecated_indirect_preview_enabled() { let mut cmd = RuffCheck::default() .args(["--select", "RUF92", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); } #[test] @@ -1392,7 +1539,7 @@ fn deprecated_multiple_direct_preview_enabled() { let mut cmd = RuffCheck::default() .args(["--select", "RUF920", "--select", "RUF921", "--preview"]) .build(); - assert_cmd_snapshot!(cmd, @r###" + assert_cmd_snapshot!(cmd, @r" success: false exit_code: 2 ----- stdout ----- @@ -1402,8 +1549,7 @@ fn deprecated_multiple_direct_preview_enabled() { Cause: Selection of deprecated rules is not allowed when preview is enabled. Remove selection of: - RUF920 - RUF921 - - "###); + "); } /// An unreadable pyproject.toml in non-isolated mode causes ruff to hard-error trying to build up @@ -1519,7 +1665,7 @@ fn check_hints_hidden_unsafe_fixes() { .args(["--select", "RUF901,RUF902"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1529,7 +1675,7 @@ fn check_hints_hidden_unsafe_fixes() { [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); } #[test] @@ -1537,7 +1683,7 @@ fn check_hints_hidden_unsafe_fixes_with_no_safe_fixes() { let mut cmd = RuffCheck::default().args(["--select", "RUF902"]).build(); assert_cmd_snapshot!(cmd .pass_stdin("x = {'a': 1, 'a': 1}\n"), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1546,7 +1692,7 @@ fn check_hints_hidden_unsafe_fixes_with_no_safe_fixes() { No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); } #[test] @@ -1555,7 +1701,7 @@ fn check_no_hint_for_hidden_unsafe_fixes_when_disabled() { .args(["--select", "RUF901,RUF902", "--no-unsafe-fixes"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1565,7 +1711,7 @@ fn check_no_hint_for_hidden_unsafe_fixes_when_disabled() { [*] 1 fixable with the --fix option. ----- stderr ----- - "###); + "); } #[test] @@ -1575,7 +1721,7 @@ fn check_no_hint_for_hidden_unsafe_fixes_with_no_safe_fixes_when_disabled() { .build(); assert_cmd_snapshot!(cmd .pass_stdin("x = {'a': 1, 'a': 1}\n"), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1583,7 +1729,7 @@ fn check_no_hint_for_hidden_unsafe_fixes_with_no_safe_fixes_when_disabled() { Found 1 error. ----- stderr ----- - "###); + "); } #[test] @@ -1592,7 +1738,7 @@ fn check_shows_unsafe_fixes_with_opt_in() { .args(["--select", "RUF901,RUF902", "--unsafe-fixes"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1602,7 +1748,7 @@ fn check_shows_unsafe_fixes_with_opt_in() { [*] 2 fixable with the --fix option. ----- stderr ----- - "###); + "); } #[test] @@ -1611,7 +1757,7 @@ fn fix_applies_safe_fixes_by_default() { .args(["--select", "RUF901,RUF902", "--fix"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1621,7 +1767,7 @@ fn fix_applies_safe_fixes_by_default() { -:1:1: RUF902 Hey this is a stable test rule with an unsafe fix. Found 2 errors (1 fixed, 1 remaining). No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). - "###); + "); } #[test] @@ -1630,7 +1776,7 @@ fn fix_applies_unsafe_fixes_with_opt_in() { .args(["--select", "RUF901,RUF902", "--fix", "--unsafe-fixes"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: true exit_code: 0 ----- stdout ----- @@ -1639,7 +1785,7 @@ fn fix_applies_unsafe_fixes_with_opt_in() { ----- stderr ----- Found 2 errors (2 fixed, 0 remaining). - "###); + "); } #[test] @@ -1649,7 +1795,7 @@ fn fix_does_not_apply_display_only_fixes() { .build(); assert_cmd_snapshot!(cmd .pass_stdin("def add_to_list(item, some_list=[]): ..."), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1657,7 +1803,7 @@ fn fix_does_not_apply_display_only_fixes() { ----- stderr ----- -:1:1: RUF903 Hey this is a stable test rule with a display only fix. Found 1 error. - "###); + "); } #[test] @@ -1667,7 +1813,7 @@ fn fix_does_not_apply_display_only_fixes_with_unsafe_fixes_enabled() { .build(); assert_cmd_snapshot!(cmd .pass_stdin("def add_to_list(item, some_list=[]): ..."), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1675,7 +1821,7 @@ fn fix_does_not_apply_display_only_fixes_with_unsafe_fixes_enabled() { ----- stderr ----- -:1:1: RUF903 Hey this is a stable test rule with a display only fix. Found 1 error. - "###); + "); } #[test] @@ -1684,7 +1830,7 @@ fn fix_only_unsafe_fixes_available() { .args(["--select", "RUF902", "--fix"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1693,7 +1839,7 @@ fn fix_only_unsafe_fixes_available() { -:1:1: RUF902 Hey this is a stable test rule with an unsafe fix. Found 1 error. No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). - "###); + "); } #[test] @@ -1702,7 +1848,7 @@ fn fix_only_flag_applies_safe_fixes_by_default() { .args(["--select", "RUF901,RUF902", "--fix-only"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: true exit_code: 0 ----- stdout ----- @@ -1710,7 +1856,7 @@ fn fix_only_flag_applies_safe_fixes_by_default() { ----- stderr ----- Fixed 1 error (1 additional fix available with `--unsafe-fixes`). - "###); + "); } #[test] @@ -1719,7 +1865,7 @@ fn fix_only_flag_applies_unsafe_fixes_with_opt_in() { .args(["--select", "RUF901,RUF902", "--fix-only", "--unsafe-fixes"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: true exit_code: 0 ----- stdout ----- @@ -1728,7 +1874,7 @@ fn fix_only_flag_applies_unsafe_fixes_with_opt_in() { ----- stderr ----- Fixed 2 errors. - "###); + "); } #[test] @@ -1737,7 +1883,7 @@ fn diff_shows_safe_fixes_by_default() { .args(["--select", "RUF901,RUF902", "--diff"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1747,7 +1893,7 @@ fn diff_shows_safe_fixes_by_default() { ----- stderr ----- Would fix 1 error (1 additional fix available with `--unsafe-fixes`). - "### + " ); } @@ -1757,7 +1903,7 @@ fn diff_shows_unsafe_fixes_with_opt_in() { .args(["--select", "RUF901,RUF902", "--diff", "--unsafe-fixes"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1768,7 +1914,7 @@ fn diff_shows_unsafe_fixes_with_opt_in() { ----- stderr ----- Would fix 2 errors. - "### + " ); } @@ -1779,13 +1925,13 @@ fn diff_does_not_show_display_only_fixes_with_unsafe_fixes_enabled() { .build(); assert_cmd_snapshot!(cmd .pass_stdin("def add_to_list(item, some_list=[]): ..."), - @r###" + @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- - "###); + "); } #[test] @@ -1794,14 +1940,14 @@ fn diff_only_unsafe_fixes_available() { .args(["--select", "RUF902", "--diff"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- No errors would be fixed (1 fix available with `--unsafe-fixes`). - "### + " ); } @@ -1822,7 +1968,7 @@ extend-unsafe-fixes = ["RUF901"] .args(["--select", "RUF901,RUF902"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1832,7 +1978,7 @@ extend-unsafe-fixes = ["RUF901"] No fixes available (2 hidden fixes can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); Ok(()) } @@ -1854,7 +2000,7 @@ extend-safe-fixes = ["RUF902"] .args(["--select", "RUF901,RUF902"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1864,7 +2010,7 @@ extend-safe-fixes = ["RUF902"] [*] 2 fixable with the `--fix` option. ----- stderr ----- - "###); + "); Ok(()) } @@ -1888,7 +2034,7 @@ extend-safe-fixes = ["RUF902"] .args(["--select", "RUF901,RUF902"]) .build(); assert_cmd_snapshot!(cmd, - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1898,7 +2044,7 @@ extend-safe-fixes = ["RUF902"] [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); Ok(()) } @@ -1924,7 +2070,7 @@ extend-safe-fixes = ["RUF9"] .build(); assert_cmd_snapshot!(cmd .pass_stdin("x = {'a': 1, 'a': 1}\nprint(('foo'))\nprint(str('foo'))\nisinstance(x, (int, str))\n"), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -1939,7 +2085,7 @@ extend-safe-fixes = ["RUF9"] [*] 1 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); Ok(()) } @@ -1975,14 +2121,14 @@ def log(x, base) -> float: .args(["--select", "D41"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin(stdin), @r###" + .pass_stdin(stdin), @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "### + " ); // But if we select the exact code, we get an error @@ -1991,7 +2137,7 @@ def log(x, base) -> float: .args(["--select", "D417"]) .build(); assert_cmd_snapshot!(cmd - .pass_stdin(stdin), @r###" + .pass_stdin(stdin), @r#" success: false exit_code: 1 ----- stdout ----- @@ -2005,7 +2151,7 @@ def log(x, base) -> float: Found 1 error. ----- stderr ----- - "### + "# ); Ok(()) } @@ -2027,7 +2173,7 @@ select = ["RUF017"] let mut cmd = RuffCheck::default().config(&ruff_toml).build(); assert_cmd_snapshot!(cmd .pass_stdin("x = [1, 2, 3]\ny = [4, 5, 6]\nsum([x, y], [])"), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -2044,7 +2190,7 @@ select = ["RUF017"] No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). ----- stderr ----- - "###); + "); Ok(()) } @@ -2067,7 +2213,7 @@ unfixable = ["RUF"] let mut cmd = RuffCheck::default().config(&ruff_toml).build(); assert_cmd_snapshot!(cmd .pass_stdin("x = [1, 2, 3]\ny = [4, 5, 6]\nsum([x, y], [])"), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -2083,7 +2229,199 @@ unfixable = ["RUF"] Found 1 error. ----- stderr ----- - "###); + "); Ok(()) } + +#[test] +fn pyproject_toml_stdin_syntax_error() { + let mut cmd = RuffCheck::default() + .args(["--stdin-filename", "pyproject.toml", "--select", "RUF200"]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + pyproject.toml:1:9: RUF200 Failed to parse pyproject.toml: invalid table header + expected `.`, `]` + | + 1 | [project + | ^ RUF200 + | + + Found 1 error. + + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_schema_error() { + let mut cmd = RuffCheck::default() + .args(["--stdin-filename", "pyproject.toml", "--select", "RUF200"]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project]\nname = 1"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + pyproject.toml:2:8: RUF200 Failed to parse pyproject.toml: invalid type: integer `1`, expected a string + | + 1 | [project] + 2 | name = 1 + | ^ RUF200 + | + + Found 1 error. + + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_no_applicable_rules_selected() { + let mut cmd = RuffCheck::default() + .args(["--stdin-filename", "pyproject.toml"]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_no_applicable_rules_selected_2() { + let mut cmd = RuffCheck::default() + .args(["--stdin-filename", "pyproject.toml", "--select", "F401"]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_no_errors() { + let mut cmd = RuffCheck::default() + .args(["--stdin-filename", "pyproject.toml"]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin(r#"[project]\nname = "ruff"\nversion = "0.0.0""#), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_schema_error_fix() { + let mut cmd = RuffCheck::default() + .args([ + "--stdin-filename", + "pyproject.toml", + "--select", + "RUF200", + "--fix", + ]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project]\nname = 1"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + [project] + name = 1 + ----- stderr ----- + pyproject.toml:2:8: RUF200 Failed to parse pyproject.toml: invalid type: integer `1`, expected a string + | + 1 | [project] + 2 | name = 1 + | ^ RUF200 + | + + Found 1 error. + " + ); +} + +#[test] +fn pyproject_toml_stdin_schema_error_fix_only() { + let mut cmd = RuffCheck::default() + .args([ + "--stdin-filename", + "pyproject.toml", + "--select", + "RUF200", + "--fix-only", + ]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project]\nname = 1"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + [project] + name = 1 + ----- stderr ----- + " + ); +} + +#[test] +fn pyproject_toml_stdin_schema_error_fix_diff() { + let mut cmd = RuffCheck::default() + .args([ + "--stdin-filename", + "pyproject.toml", + "--select", + "RUF200", + "--fix", + "--diff", + ]) + .build(); + + assert_cmd_snapshot!( + cmd.pass_stdin("[project]\nname = 1"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + + ----- stderr ----- + " + ); +} diff --git a/crates/ruff/tests/lint.rs b/crates/ruff/tests/lint.rs index 450e8e7158dfa..49191f5099b46 100644 --- a/crates/ruff/tests/lint.rs +++ b/crates/ruff/tests/lint.rs @@ -3,19 +3,20 @@ #![cfg(not(target_family = "wasm"))] use regex::escape; -use std::fs; use std::process::Command; use std::str; +use std::{fs, path::Path}; use anyhow::Result; +use assert_fs::fixture::{ChildPath, FileTouch, PathChild}; use insta_cmd::{assert_cmd_snapshot, get_cargo_bin}; use tempfile::TempDir; const BIN_NAME: &str = "ruff"; const STDIN_BASE_OPTIONS: &[&str] = &["check", "--no-cache", "--output-format", "concise"]; -fn tempdir_filter(tempdir: &TempDir) -> String { - format!(r"{}\\?/?", escape(tempdir.path().to_str().unwrap())) +fn tempdir_filter(path: impl AsRef<Path>) -> String { + format!(r"{}\\?/?", escape(path.as_ref().to_str().unwrap())) } #[test] @@ -41,7 +42,7 @@ inline-quotes = "single" .arg(&ruff_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###" + .pass_stdin(r#"a = "abcba".strip("aba")"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -55,7 +56,7 @@ inline-quotes = "single" warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`: - 'extend-select' -> 'lint.extend-select' - 'flake8-quotes' -> 'lint.flake8-quotes' - "###); + "); }); Ok(()) @@ -84,7 +85,7 @@ inline-quotes = "single" .arg("--config") .arg(&ruff_toml) .arg("-") - .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###" + .pass_stdin(r#"a = "abcba".strip("aba")"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -95,7 +96,7 @@ inline-quotes = "single" [*] 2 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) @@ -124,7 +125,7 @@ inline-quotes = "single" .arg("--config") .arg(&ruff_toml) .arg("-") - .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###" + .pass_stdin(r#"a = "abcba".strip("aba")"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -137,7 +138,7 @@ inline-quotes = "single" ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`: - 'extend-select' -> 'lint.extend-select' - "###); + "); }); Ok(()) @@ -170,7 +171,7 @@ inline-quotes = "single" .arg("--config") .arg(&ruff_toml) .arg("-") - .pass_stdin(r#"a = "abcba".strip("aba")"#), @r###" + .pass_stdin(r#"a = "abcba".strip("aba")"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -183,7 +184,7 @@ inline-quotes = "single" ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`: - 'flake8-quotes' -> 'lint.flake8-quotes' - "###); + "); }); Ok(()) @@ -251,7 +252,7 @@ OTHER = "OTHER" // Explicitly pass test.py, should be linted regardless of it being excluded by lint.exclude .arg(test_path.file_name().unwrap()) // Lint all other files in the directory, should respect the `exclude` and `lint.exclude` options - .arg("."), @r###" + .arg("."), @r" success: false exit_code: 1 ----- stdout ----- @@ -264,7 +265,7 @@ OTHER = "OTHER" ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - "###); + "); }); Ok(()) @@ -301,7 +302,7 @@ from test import say_hy if __name__ == "__main__": say_hy("dear Ruff contributor") -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -313,7 +314,7 @@ if __name__ == "__main__": ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - "###); + "); }); Ok(()) @@ -348,7 +349,7 @@ max-line-length = 100 _ = "---------------------------------------------------------------------------亜亜亜亜亜亜" # longer than 100 _ = "---------------------------------------------------------------------------亜亜亜亜亜亜亜亜亜亜亜亜亜亜" -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -359,7 +360,7 @@ _ = "--------------------------------------------------------------------------- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `[TMP]/ruff.toml`: - 'select' -> 'lint.select' - 'pycodestyle' -> 'lint.pycodestyle' - "###); + "); }); Ok(()) @@ -396,7 +397,7 @@ from test import say_hy if __name__ == "__main__": say_hy("dear Ruff contributor") -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -407,7 +408,7 @@ if __name__ == "__main__": ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - "###); + "); }); Ok(()) @@ -444,7 +445,7 @@ from test import say_hy if __name__ == "__main__": say_hy("dear Ruff contributor") -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -455,7 +456,7 @@ if __name__ == "__main__": ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `ruff.toml`: - 'extend-select' -> 'lint.extend-select' - "###); + "); }); Ok(()) @@ -492,7 +493,7 @@ ignore = ["D203", "D212"] assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(sub_dir) .args(STDIN_BASE_OPTIONS) - , @r###" + , @r" success: true exit_code: 0 ----- stdout ----- @@ -500,7 +501,7 @@ ignore = ["D203", "D212"] ----- stderr ----- warning: No Python files found under the given path(s) - "###); + "); }); Ok(()) @@ -510,7 +511,7 @@ ignore = ["D203", "D212"] fn nonexistent_config_file() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(STDIN_BASE_OPTIONS) - .args(["--config", "foo.toml", "."]), @r###" + .args(["--config", "foo.toml", "."]), @r" success: false exit_code: 2 ----- stdout ----- @@ -526,14 +527,14 @@ fn nonexistent_config_file() { The path `foo.toml` does not point to a configuration file For more information, try '--help'. - "###); + "); } #[test] fn config_override_rejected_if_invalid_toml() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(STDIN_BASE_OPTIONS) - .args(["--config", "foo = bar", "."]), @r###" + .args(["--config", "foo = bar", "."]), @r#" success: false exit_code: 2 ----- stdout ----- @@ -555,7 +556,7 @@ fn config_override_rejected_if_invalid_toml() { expected `"`, `'` For more information, try '--help'. - "###); + "#); } #[test] @@ -574,19 +575,18 @@ fn too_many_config_files() -> Result<()> { .arg(&ruff_dot_toml) .arg("--config") .arg(&ruff2_dot_toml) - .arg("."), @r###" - success: false - exit_code: 2 - ----- stdout ----- - - ----- stderr ----- - ruff failed - Cause: You cannot specify more than one configuration file on the command line. + .arg("."), @r" + success: false + exit_code: 2 + ----- stdout ----- - tip: remove either `--config=[TMP]/ruff.toml` or `--config=[TMP]/ruff2.toml`. - For more information, try `--help`. + ----- stderr ----- + ruff failed + Cause: You cannot specify more than one configuration file on the command line. - "###); + tip: remove either `--config=[TMP]/ruff.toml` or `--config=[TMP]/ruff2.toml`. + For more information, try `--help`. + "); }); Ok(()) } @@ -595,7 +595,7 @@ fn too_many_config_files() -> Result<()> { fn extend_passed_via_config_argument() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(STDIN_BASE_OPTIONS) - .args(["--config", "extend = 'foo.toml'", "."]), @r###" + .args(["--config", "extend = 'foo.toml'", "."]), @r" success: false exit_code: 2 ----- stdout ----- @@ -606,7 +606,140 @@ fn extend_passed_via_config_argument() { tip: Cannot include `extend` in a --config flag value For more information, try '--help'. - "###); + "); +} + +#[test] +fn nonexistent_extend_file() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + fs::write( + project_dir.join("ruff.toml"), + r#" +extend = "ruff2.toml" +"#, + )?; + + fs::write( + project_dir.join("ruff2.toml"), + r#" +extend = "ruff3.toml" +"#, + )?; + + insta::with_settings!({ + filters => vec![ + (tempdir_filter(&project_dir).as_str(), "[TMP]/"), + ("The system cannot find the file specified.", "No such file or directory") + ] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(["check"]).current_dir(project_dir), @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Failed to load extended configuration `[TMP]/ruff3.toml` (`[TMP]/ruff.toml` extends `[TMP]/ruff2.toml` extends `[TMP]/ruff3.toml`) + Cause: Failed to read [TMP]/ruff3.toml + Cause: No such file or directory (os error 2) + "); + }); + + Ok(()) +} + +#[test] +fn circular_extend() -> Result<()> { + let tempdir = TempDir::new()?; + let project_path = tempdir.path().canonicalize()?; + + fs::write( + project_path.join("ruff.toml"), + r#" +extend = "ruff2.toml" +"#, + )?; + fs::write( + project_path.join("ruff2.toml"), + r#" +extend = "ruff3.toml" +"#, + )?; + fs::write( + project_path.join("ruff3.toml"), + r#" +extend = "ruff.toml" +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_path).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(["check"]) + .current_dir(project_path), + @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Circular configuration detected: `[TMP]/ruff.toml` extends `[TMP]/ruff2.toml` extends `[TMP]/ruff3.toml` extends `[TMP]/ruff.toml` + "); + }); + + Ok(()) +} + +#[test] +fn parse_error_extends() -> Result<()> { + let tempdir = TempDir::new()?; + let project_path = tempdir.path().canonicalize()?; + + fs::write( + project_path.join("ruff.toml"), + r#" +extend = "ruff2.toml" +"#, + )?; + fs::write( + project_path.join("ruff2.toml"), + r#" +[lint] +select = [E501] +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_path).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(["check"]) + .current_dir(project_path), + @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Failed to load extended configuration `[TMP]/ruff2.toml` (`[TMP]/ruff.toml` extends `[TMP]/ruff2.toml`) + Cause: Failed to parse [TMP]/ruff2.toml + Cause: TOML parse error at line 3, column 11 + | + 3 | select = [E501] + | ^ + invalid array + expected `]` + "); + }); + + Ok(()) } #[test] @@ -622,20 +755,19 @@ fn config_file_and_isolated() -> Result<()> { .arg("--config") .arg(&ruff_dot_toml) .arg("--isolated") - .arg("."), @r###" - success: false - exit_code: 2 - ----- stdout ----- - - ----- stderr ----- - ruff failed - Cause: The argument `--config=[TMP]/ruff.toml` cannot be used with `--isolated` + .arg("."), @r" + success: false + exit_code: 2 + ----- stdout ----- - tip: You cannot specify a configuration file and also specify `--isolated`, - as `--isolated` causes ruff to ignore all configuration files. - For more information, try `--help`. + ----- stderr ----- + ruff failed + Cause: The argument `--config=[TMP]/ruff.toml` cannot be used with `--isolated` - "###); + tip: You cannot specify a configuration file and also specify `--isolated`, + as `--isolated` causes ruff to ignore all configuration files. + For more information, try `--help`. + "); }); Ok(()) } @@ -680,7 +812,7 @@ x = "longer_than_90_charactersssssssssssssssssssssssssssssssssssssssssssssssssss .args(["--config", "lint.extend-select=['E501', 'F841']"]) .args(["--config", "lint.isort.combine-as-imports = false"]) .arg("-") - .pass_stdin(fixture), @r###" + .pass_stdin(fixture), @r" success: false exit_code: 1 ----- stdout ----- @@ -690,7 +822,7 @@ x = "longer_than_90_charactersssssssssssssssssssssssssssssssssssssssssssssssssss [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); Ok(()) } @@ -699,7 +831,7 @@ fn valid_toml_but_nonexistent_option_provided_via_config_argument() { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(STDIN_BASE_OPTIONS) .args([".", "--config", "extend-select=['F481']"]), // No such code as F481! - @r###" + @r" success: false exit_code: 2 ----- stdout ----- @@ -716,7 +848,7 @@ fn valid_toml_but_nonexistent_option_provided_via_config_argument() { Unknown rule selector: `F481` For more information, try '--help'. - "###); + "); } #[test] @@ -726,7 +858,7 @@ fn each_toml_option_requires_a_new_flag_1() { // commas can't be used to delimit different config overrides; // you need a new --config flag for each override .args([".", "--config", "extend-select=['F841'], line-length=90"]), - @r###" + @r" success: false exit_code: 2 ----- stdout ----- @@ -747,7 +879,7 @@ fn each_toml_option_requires_a_new_flag_1() { expected newline, `#` For more information, try '--help'. - "###); + "); } #[test] @@ -757,7 +889,7 @@ fn each_toml_option_requires_a_new_flag_2() { // spaces *also* can't be used to delimit different config overrides; // you need a new --config flag for each override .args([".", "--config", "extend-select=['F841'] line-length=90"]), - @r###" + @r" success: false exit_code: 2 ----- stdout ----- @@ -778,7 +910,94 @@ fn each_toml_option_requires_a_new_flag_2() { expected newline, `#` For more information, try '--help'. - "###); + "); +} + +#[test] +fn value_given_to_table_key_is_not_inline_table_1() { + // https://github.com/astral-sh/ruff/issues/13995 + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args([".", "--config", r#"lint.flake8-pytest-style="csv""#]), + @r#" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: invalid value 'lint.flake8-pytest-style="csv"' for '--config <CONFIG_OPTION>' + + tip: A `--config` flag must either be a path to a `.toml` configuration file + or a TOML `<KEY> = <VALUE>` pair overriding a specific configuration + option + + `lint.flake8-pytest-style` is a table of configuration options. + Did you want to override one of the table's subkeys? + + Possible choices: + + - `lint.flake8-pytest-style.fixture-parentheses` + - `lint.flake8-pytest-style.parametrize-names-type` + - `lint.flake8-pytest-style.parametrize-values-type` + - `lint.flake8-pytest-style.parametrize-values-row-type` + - `lint.flake8-pytest-style.raises-require-match-for` + - `lint.flake8-pytest-style.raises-extend-require-match-for` + - `lint.flake8-pytest-style.mark-parentheses` + - `lint.flake8-pytest-style.warns-require-match-for` + - `lint.flake8-pytest-style.warns-extend-require-match-for` + + For more information, try '--help'. + "#); +} + +#[test] +fn value_given_to_table_key_is_not_inline_table_2() { + // https://github.com/astral-sh/ruff/issues/13995 + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args([".", "--config", r#"lint=123"#]), + @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: invalid value 'lint=123' for '--config <CONFIG_OPTION>' + + tip: A `--config` flag must either be a path to a `.toml` configuration file + or a TOML `<KEY> = <VALUE>` pair overriding a specific configuration + option + + `lint` is a table of configuration options. + Did you want to override one of the table's subkeys? + + Possible choices: + + - `lint.allowed-confusables` + - `lint.dummy-variable-rgx` + - `lint.extend-ignore` + - `lint.extend-select` + - `lint.extend-fixable` + - `lint.external` + - `lint.fixable` + - `lint.ignore` + - `lint.extend-safe-fixes` + - `lint.extend-unsafe-fixes` + - `lint.ignore-init-module-imports` + - `lint.logger-objects` + - `lint.select` + - `lint.explicit-preview-rules` + - `lint.task-tags` + - `lint.typing-modules` + - `lint.unfixable` + - `lint.per-file-ignores` + - `lint.extend-per-file-ignores` + - `lint.exclude` + - `lint.preview` + - `lint.typing-extensions` + + For more information, try '--help'. + "); } #[test] @@ -805,7 +1024,7 @@ select=["E501"] .arg(&ruff_toml) .args(["--config", "line-length=110"]) .arg("-") - .pass_stdin(fixture), @r###" + .pass_stdin(fixture), @r" success: false exit_code: 1 ----- stdout ----- @@ -813,7 +1032,7 @@ select=["E501"] Found 1 error. ----- stderr ----- - "###); + "); Ok(()) } @@ -830,14 +1049,14 @@ fn complex_config_setting_overridden_via_cli() -> Result<()> { .args(["--config", "lint.per-file-ignores = {'generated.py' = ['N801']}"]) .args(["--stdin-filename", "generated.py"]) .arg("-") - .pass_stdin(fixture), @r###" + .pass_stdin(fixture), @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); Ok(()) } @@ -847,7 +1066,7 @@ fn deprecated_config_option_overridden_via_cli() { .args(STDIN_BASE_OPTIONS) .args(["--config", "select=['N801']", "-"]) .pass_stdin("class lowercase: ..."), - @r###" + @r" success: false exit_code: 1 ----- stdout ----- @@ -857,7 +1076,7 @@ fn deprecated_config_option_overridden_via_cli() { ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in your `--config` CLI arguments: - 'select' -> 'lint.select' - "###); + "); } #[test] @@ -921,7 +1140,7 @@ include = ["*.ipy"] .args(STDIN_BASE_OPTIONS) .args(["--config", &ruff_toml.file_name().unwrap().to_string_lossy()]) .args(["--extension", "ipy:ipynb"]) - .arg("."), @r###" + .arg("."), @r" success: false exit_code: 1 ----- stdout ----- @@ -930,12 +1149,30 @@ include = ["*.ipy"] [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) } +#[test] +fn warn_invalid_noqa_with_no_diagnostics() { + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--isolated"]) + .arg("--select") + .arg("F401") + .arg("-") + .pass_stdin( + r#" +# ruff: noqa: AAA101 +print("Hello world!") +"# + ) + ); +} + #[test] fn file_noqa_external() -> Result<()> { let tempdir = TempDir::new()?; @@ -959,7 +1196,7 @@ external = ["AAA"] .pass_stdin(r#" # flake8: noqa: AAA101, BBB102 import os -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -969,7 +1206,7 @@ import os ----- stderr ----- warning: Invalid rule code provided to `# ruff: noqa` at -:2: BBB102 - "###); + "); }); Ok(()) @@ -998,7 +1235,7 @@ required-version = "0.1.0" .arg("-") .pass_stdin(r#" import os -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -1006,7 +1243,7 @@ import os ----- stderr ----- ruff failed Cause: Required version `==0.1.0` does not match the running version `[VERSION]` - "###); + "); }); Ok(()) @@ -1037,7 +1274,7 @@ required-version = "{version}" .arg("-") .pass_stdin(r#" import os -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1046,7 +1283,7 @@ import os [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) @@ -1077,7 +1314,7 @@ required-version = ">{version}" .arg("-") .pass_stdin(r#" import os -"#), @r###" +"#), @r" success: false exit_code: 2 ----- stdout ----- @@ -1085,7 +1322,7 @@ import os ----- stderr ----- ruff failed Cause: Required version `>[VERSION]` does not match the running version `[VERSION]` - "###); + "); }); Ok(()) @@ -1114,7 +1351,7 @@ required-version = ">=0.1.0" .arg("-") .pass_stdin(r#" import os -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1123,7 +1360,7 @@ import os [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) @@ -1155,7 +1392,7 @@ import os def func(): x = 1 -"#), @r###" +"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1164,7 +1401,7 @@ def func(): [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); Ok(()) } @@ -1193,7 +1430,7 @@ fn negated_per_file_ignores() -> Result<()> { .arg("--select") .arg("RUF901") .current_dir(&tempdir) - , @r###" + , @r" success: false exit_code: 1 ----- stdout ----- @@ -1202,7 +1439,7 @@ fn negated_per_file_ignores() -> Result<()> { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); Ok(()) } @@ -1224,10 +1461,7 @@ fn negated_per_file_ignores_absolute() -> Result<()> { let ignored = tempdir.path().join("ignored.py"); fs::write(ignored, "")?; - insta::with_settings!({filters => vec![ - // Replace windows paths - (r"\\", "/"), - ]}, { + insta::with_settings!({filters => vec![(r"\\", "/")]}, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .args(STDIN_BASE_OPTIONS) .arg("--config") @@ -1235,7 +1469,7 @@ fn negated_per_file_ignores_absolute() -> Result<()> { .arg("--select") .arg("RUF901") .current_dir(&tempdir) - , @r###" + , @r" success: false exit_code: 1 ----- stdout ----- @@ -1244,7 +1478,7 @@ fn negated_per_file_ignores_absolute() -> Result<()> { [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) } @@ -1274,14 +1508,14 @@ fn negated_per_file_ignores_overlap() -> Result<()> { .arg("--select") .arg("RUF901") .current_dir(&tempdir) - , @r###" + , @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); Ok(()) } @@ -1313,7 +1547,7 @@ import os # F401 def function(): import os # F811 print(os.name) -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- @@ -1325,7 +1559,7 @@ def function(): ----- stderr ----- Found 1 error (1 fixed, 0 remaining). - "###); + "); }); Ok(()) @@ -1365,22 +1599,22 @@ def first_square(): .arg("-") .pass_stdin(r#" -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); }); let test_code = std::fs::read_to_string(&test_path).expect("should read test file"); - insta::assert_snapshot!(test_code, @r###" + insta::assert_snapshot!(test_code, @r" def first_square(): return [x * x for x in range(20)][0] # noqa: RUF015 - "###); + "); Ok(()) } @@ -1420,23 +1654,22 @@ def unused(x): .arg("-") .pass_stdin(r#" -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); }); let test_code = std::fs::read_to_string(&test_path).expect("should read test file"); - insta::assert_snapshot!(test_code, @r###" - + insta::assert_snapshot!(test_code, @r" def unused(x): # noqa: ANN001, ANN201, D103 pass - "###); + "); Ok(()) } @@ -1476,24 +1709,23 @@ import a .arg("-") .pass_stdin(r#" -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); }); let test_code = std::fs::read_to_string(&test_path).expect("should read test file"); - insta::assert_snapshot!(test_code, @r###" - + insta::assert_snapshot!(test_code, @r" import z # noqa: I001 import c import a - "###); + "); Ok(()) } @@ -1533,23 +1765,22 @@ def unused(x): # noqa: ANN001, ARG001, D103 .arg("-") .pass_stdin(r#" -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); }); let test_code = std::fs::read_to_string(&test_path).expect("should read test file"); - insta::assert_snapshot!(test_code, @r###" - + insta::assert_snapshot!(test_code, @r" def unused(x): # noqa: ANN001, ANN201, ARG001, D103 pass - "###); + "); Ok(()) } @@ -1594,19 +1825,19 @@ print( .arg("-") .pass_stdin(r#" -"#), @r###" +"#), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); }); let test_code = std::fs::read_to_string(&test_path).expect("should read test file"); - insta::assert_snapshot!(test_code, @r###" + insta::assert_snapshot!(test_code, @r#" print( """First line second line @@ -1614,7 +1845,7 @@ print( %s""" # noqa: UP031 % name ) - "###); + "#); Ok(()) } @@ -1658,14 +1889,48 @@ def first_square(): assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) .current_dir(tempdir.path()) .args(STDIN_BASE_OPTIONS) - .args(["--add-noqa"]), @r###" + .args(["--add-noqa"]), @r" success: true exit_code: 0 ----- stdout ----- ----- stderr ----- Added 1 noqa directive. - "###); + "); + }); + + Ok(()) +} + +/// Regression test for <https://github.com/astral-sh/ruff/issues/2253> +#[test] +fn add_noqa_parent() -> Result<()> { + let tempdir = TempDir::new()?; + let test_path = tempdir.path().join("noqa.py"); + fs::write( + &test_path, + r#" +from foo import ( # noqa: F401 + bar +) + "#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--add-noqa") + .arg("--select=F401") + .arg("noqa.py") + .current_dir(&tempdir), @r" + success: true + exit_code: 0 + ----- stdout ----- + + ----- stderr ----- + "); }); Ok(()) @@ -1695,7 +1960,7 @@ select = ["UP006"] .arg(&ruff_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"from typing import List; foo: List[int]"#), @r###" + .pass_stdin(r#"from typing import List; foo: List[int]"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1704,7 +1969,7 @@ select = ["UP006"] [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); let pyproject_toml = tempdir.path().join("pyproject.toml"); @@ -1727,14 +1992,14 @@ select = ["UP006"] .arg(&pyproject_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"from typing import List; foo: List[int]"#), @r###" + .pass_stdin(r#"from typing import List; foo: List[int]"#), @r" success: true exit_code: 0 ----- stdout ----- All checks passed! ----- stderr ----- - "###); + "); }); Ok(()) @@ -1764,7 +2029,7 @@ select = ["UP006"] .arg(&pyproject_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"from typing import List; foo: List[int]"#), @r###" + .pass_stdin(r#"from typing import List; foo: List[int]"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1773,7 +2038,7 @@ select = ["UP006"] [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) @@ -1803,7 +2068,7 @@ select = ["UP006"] .arg(&pyproject_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"from typing import List; foo: List[int]"#), @r###" + .pass_stdin(r#"from typing import List; foo: List[int]"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1812,7 +2077,7 @@ select = ["UP006"] [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) @@ -1842,7 +2107,7 @@ select = ["UP006"] .arg(&pyproject_toml) .args(["--stdin-filename", "test.py"]) .arg("-") - .pass_stdin(r#"from typing import List; foo: List[int]"#), @r###" + .pass_stdin(r#"from typing import List; foo: List[int]"#), @r" success: false exit_code: 1 ----- stdout ----- @@ -1851,70 +2116,3578 @@ select = ["UP006"] [*] 1 fixable with the `--fix` option. ----- stderr ----- - "###); + "); }); Ok(()) } +/// ``` +/// tmp +/// ├── pyproject.toml #<--- no `[tool.ruff]` +/// └── test.py +/// ``` #[test] -fn checks_notebooks_in_stable() -> anyhow::Result<()> { +fn requires_python_no_tool() -> Result<()> { let tempdir = TempDir::new()?; - std::fs::write( - tempdir.path().join("main.ipynb"), - r#" -{ - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "ad6f36d9-4b7d-4562-8d00-f15a0f1fbb6d", - "metadata": {}, - "outputs": [], - "source": [ - "import random" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.0" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &ruff_toml, + r#"[project] +requires-python = ">= 3.11" "#, )?; - assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(STDIN_BASE_OPTIONS) - .arg("--select") - .arg("F401") - .current_dir(&tempdir) - , @r###" - success: false - exit_code: 1 - ----- stdout ----- - main.ipynb:cell 1:1:8: F401 [*] `random` imported but unused - Found 1 error. - [*] 1 fixable with the `--fix` option. + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#"from typing import Union;foo: Union[int, str] = 1"#, + )?; + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .args(["--select","UP007"]) + .arg("test.py") + .arg("-") + .current_dir(project_dir) + , @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/test.py" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.11 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.11 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.11 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} - ----- stderr ----- - "###); + ----- stderr ----- + "#); + }); Ok(()) } + +/// ``` +/// tmp +/// ├── pyproject.toml #<--- no `[tool.ruff]` +/// └── test.py +/// ``` +#[test] +fn requires_python_no_tool_target_version_override() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &ruff_toml, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#"from typing import Union;foo: Union[int, str] = 1"#, + )?; + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .args(["--select","UP007"]) + .args(["--target-version","py310"]) + .arg("test.py") + .arg("-") + .current_dir(project_dir) + , @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/test.py" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.10 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.10 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.10 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + Ok(()) +} +/// ``` +/// tmp +/// ├── pyproject.toml #<--- no `[tool.ruff]` +/// └── test.py +/// ``` +#[test] +fn requires_python_no_tool_with_check() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &ruff_toml, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#"from typing import Union;foo: Union[int, str] = 1"#, + )?; + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--select","UP007"]) + .arg(".") + .current_dir(project_dir) + , @r###" + success: false + exit_code: 1 + ----- stdout ----- + test.py:1:31: UP007 [*] Use `X | Y` for type annotations + Found 1 error. + [*] 1 fixable with the `--fix` option. + + ----- stderr ----- + "###); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── pyproject.toml #<-- no [tool.ruff] +/// ├── ruff.toml #<-- no `target-version` +/// └── test.py +/// ``` +#[test] +fn requires_python_ruff_toml_no_target_fallback() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#"[lint] +select = ["UP007"] +"#, + )?; + + let pyproject_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &pyproject_toml, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("test.py") + .arg("--show-settings") + .current_dir(project_dir), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/test.py" + Settings path: "[TMP]/ruff.toml" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.11 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.11 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.11 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── pyproject.toml #<-- no [tool.ruff] +/// ├── ruff.toml #<-- no `target-version` +/// └── test.py +/// ``` +#[test] +fn requires_python_ruff_toml_no_target_fallback_check() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#"[lint] +select = ["UP007"] +"#, + )?; + + let pyproject_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &pyproject_toml, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg(".") + .current_dir(project_dir), @r###" + success: false + exit_code: 1 + ----- stdout ----- + test.py:2:31: UP007 [*] Use `X | Y` for type annotations + Found 1 error. + [*] 1 fixable with the `--fix` option. + + ----- stderr ----- + "###); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── foo +/// │ ├── pyproject.toml #<-- no [tool.ruff], no `requires-python` +/// │ └── test.py +/// └── pyproject.toml #<-- no [tool.ruff], has `requires-python` +/// ``` +#[test] +fn requires_python_pyproject_toml_above() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let outer_pyproject = tempdir.path().join("pyproject.toml"); + fs::write( + &outer_pyproject, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let foodir = tempdir.path().join("foo"); + fs::create_dir(foodir)?; + + let inner_pyproject = tempdir.path().join("foo/pyproject.toml"); + fs::write( + &inner_pyproject, + r#"[project] +"#, + )?; + + let testpy = tempdir.path().join("foo/test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + let testpy_canon = testpy.canonicalize()?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&testpy_canon).as_str(), "[TMP]/foo/test.py"),(tempdir_filter(&project_dir).as_str(), "[TMP]/"),(r"(?m)^foo\\test","foo/test")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .args(["--select","UP007"]) + .arg("foo/test.py") + .current_dir(&project_dir), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/foo/test.py" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.11 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.11 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.11 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── foo +/// │ ├── pyproject.toml #<-- has [tool.ruff], no `requires-python` +/// │ └── test.py +/// └── pyproject.toml #<-- no [tool.ruff], has `requires-python` +/// ``` +#[test] +fn requires_python_pyproject_toml_above_with_tool() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let outer_pyproject = tempdir.path().join("pyproject.toml"); + fs::write( + &outer_pyproject, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let foodir = tempdir.path().join("foo"); + fs::create_dir(foodir)?; + + let inner_pyproject = tempdir.path().join("foo/pyproject.toml"); + fs::write( + &inner_pyproject, + r#" +[tool.ruff] +target-version = "py310" +"#, + )?; + + let testpy = tempdir.path().join("foo/test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + let testpy_canon = testpy.canonicalize()?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&testpy_canon).as_str(), "[TMP]/foo/test.py"),(tempdir_filter(&project_dir).as_str(), "[TMP]/"),(r"foo\\","foo/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .args(["--select","UP007"]) + .arg("foo/test.py") + .current_dir(&project_dir), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/foo/test.py" + + # General Settings + cache_dir = "[TMP]/foo/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/foo" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/foo" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.10 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/foo", + "[TMP]/foo/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.10 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.10 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── foo +/// │ ├── pyproject.toml #<-- no [tool.ruff] +/// │ └── test.py +/// └── ruff.toml #<-- no `target-version` +/// ``` +#[test] +fn requires_python_ruff_toml_above() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +[lint] +select = ["UP007"] +"#, + )?; + + let foodir = tempdir.path().join("foo"); + fs::create_dir(foodir)?; + + let pyproject_toml = tempdir.path().join("foo/pyproject.toml"); + fs::write( + &pyproject_toml, + r#"[project] +requires-python = ">= 3.11" +"#, + )?; + + let testpy = tempdir.path().join("foo/test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + let testpy_canon = testpy.canonicalize()?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&testpy_canon).as_str(), "[TMP]/foo/test.py"),(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .arg("foo/test.py") + .current_dir(&project_dir), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/foo/test.py" + Settings path: "[TMP]/ruff.toml" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = none + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.9 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.9 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + + insta::with_settings!({ + filters => vec![(tempdir_filter(&testpy_canon).as_str(), "[TMP]/foo/test.py"),(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .arg("test.py") + .current_dir(project_dir.join("foo")), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/foo/test.py" + Settings path: "[TMP]/ruff.toml" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = none + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.9 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.9 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + Ok(()) +} + +/// ``` +/// tmp +/// ├── pyproject.toml <-- requires >=3.10 +/// ├── ruff.toml <--- extends base +/// ├── shared +/// │ └── base_config.toml <-- targets 3.11 +/// └── test.py +/// ``` +#[test] +fn requires_python_extend_from_shared_config() -> Result<()> { + let tempdir = TempDir::new()?; + let project_dir = tempdir.path().canonicalize()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +extend = "./shared/base_config.toml" +[lint] +select = ["UP007"] +"#, + )?; + + let shared_dir = tempdir.path().join("shared"); + fs::create_dir(shared_dir)?; + + let pyproject_toml = tempdir.path().join("pyproject.toml"); + fs::write( + &pyproject_toml, + r#"[project] +requires-python = ">= 3.10" +"#, + )?; + + let shared_toml = tempdir.path().join("shared/base_config.toml"); + fs::write( + &shared_toml, + r#" +target-version = "py311" +"#, + )?; + + let testpy = tempdir.path().join("test.py"); + fs::write( + &testpy, + r#" +from typing import Union;foo: Union[int, str] = 1 +"#, + )?; + + let testpy_canon = testpy.canonicalize()?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&testpy_canon).as_str(), "[TMP]/test.py"),(tempdir_filter(&project_dir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--show-settings") + .arg("test.py") + .current_dir(&project_dir), @r#" + success: true + exit_code: 0 + ----- stdout ----- + Resolved settings for: "[TMP]/test.py" + Settings path: "[TMP]/ruff.toml" + + # General Settings + cache_dir = "[TMP]/.ruff_cache" + fix = false + fix_only = false + output_format = concise + show_fixes = false + unsafe_fixes = hint + + # File Resolver Settings + file_resolver.exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".git-rewrite", + ".hg", + ".ipynb_checkpoints", + ".mypy_cache", + ".nox", + ".pants.d", + ".pyenv", + ".pytest_cache", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + ".vscode", + "__pypackages__", + "_build", + "buck-out", + "dist", + "node_modules", + "site-packages", + "venv", + ] + file_resolver.extend_exclude = [] + file_resolver.force_exclude = false + file_resolver.include = [ + "*.py", + "*.pyi", + "*.ipynb", + "**/pyproject.toml", + ] + file_resolver.extend_include = [] + file_resolver.respect_gitignore = true + file_resolver.project_root = "[TMP]/" + + # Linter Settings + linter.exclude = [] + linter.project_root = "[TMP]/" + linter.rules.enabled = [ + non-pep604-annotation-union (UP007), + ] + linter.rules.should_fix = [ + non-pep604-annotation-union (UP007), + ] + linter.per_file_ignores = {} + linter.safety_table.forced_safe = [] + linter.safety_table.forced_unsafe = [] + linter.unresolved_target_version = 3.10 + linter.per_file_target_version = {} + linter.preview = disabled + linter.explicit_preview_rules = false + linter.extension = ExtensionMapping({}) + linter.allowed_confusables = [] + linter.builtins = [] + linter.dummy_variable_rgx = ^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$ + linter.external = [] + linter.ignore_init_module_imports = true + linter.logger_objects = [] + linter.namespace_packages = [] + linter.src = [ + "[TMP]/", + "[TMP]/src", + ] + linter.tab_size = 4 + linter.line_length = 88 + linter.task_tags = [ + TODO, + FIXME, + XXX, + ] + linter.typing_modules = [] + linter.typing_extensions = true + + # Linter Plugins + linter.flake8_annotations.mypy_init_return = false + linter.flake8_annotations.suppress_dummy_args = false + linter.flake8_annotations.suppress_none_returning = false + linter.flake8_annotations.allow_star_arg_any = false + linter.flake8_annotations.ignore_fully_untyped = false + linter.flake8_bandit.hardcoded_tmp_directory = [ + /tmp, + /var/tmp, + /dev/shm, + ] + linter.flake8_bandit.check_typed_exception = false + linter.flake8_bandit.extend_markup_names = [] + linter.flake8_bandit.allowed_markup_calls = [] + linter.flake8_bugbear.extend_immutable_calls = [] + linter.flake8_builtins.allowed_modules = [] + linter.flake8_builtins.ignorelist = [] + linter.flake8_builtins.strict_checking = false + linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false + linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* + linter.flake8_copyright.author = none + linter.flake8_copyright.min_file_size = 0 + linter.flake8_errmsg.max_string_length = 0 + linter.flake8_gettext.functions_names = [ + _, + gettext, + ngettext, + ] + linter.flake8_implicit_str_concat.allow_multiline = true + linter.flake8_import_conventions.aliases = { + altair = alt, + holoviews = hv, + matplotlib = mpl, + matplotlib.pyplot = plt, + networkx = nx, + numpy = np, + numpy.typing = npt, + pandas = pd, + panel = pn, + plotly.express = px, + polars = pl, + pyarrow = pa, + seaborn = sns, + tensorflow = tf, + tkinter = tk, + xml.etree.ElementTree = ET, + } + linter.flake8_import_conventions.banned_aliases = {} + linter.flake8_import_conventions.banned_from = [] + linter.flake8_pytest_style.fixture_parentheses = false + linter.flake8_pytest_style.parametrize_names_type = tuple + linter.flake8_pytest_style.parametrize_values_type = list + linter.flake8_pytest_style.parametrize_values_row_type = tuple + linter.flake8_pytest_style.raises_require_match_for = [ + BaseException, + Exception, + ValueError, + OSError, + IOError, + EnvironmentError, + socket.error, + ] + linter.flake8_pytest_style.raises_extend_require_match_for = [] + linter.flake8_pytest_style.mark_parentheses = false + linter.flake8_quotes.inline_quotes = double + linter.flake8_quotes.multiline_quotes = double + linter.flake8_quotes.docstring_quotes = double + linter.flake8_quotes.avoid_escape = true + linter.flake8_self.ignore_names = [ + _make, + _asdict, + _replace, + _fields, + _field_defaults, + _name_, + _value_, + ] + linter.flake8_tidy_imports.ban_relative_imports = "parents" + linter.flake8_tidy_imports.banned_api = {} + linter.flake8_tidy_imports.banned_module_level_imports = [] + linter.flake8_type_checking.strict = false + linter.flake8_type_checking.exempt_modules = [ + typing, + typing_extensions, + ] + linter.flake8_type_checking.runtime_required_base_classes = [] + linter.flake8_type_checking.runtime_required_decorators = [] + linter.flake8_type_checking.quote_annotations = false + linter.flake8_unused_arguments.ignore_variadic_names = false + linter.isort.required_imports = [] + linter.isort.combine_as_imports = false + linter.isort.force_single_line = false + linter.isort.force_sort_within_sections = false + linter.isort.detect_same_package = true + linter.isort.case_sensitive = false + linter.isort.force_wrap_aliases = false + linter.isort.force_to_top = [] + linter.isort.known_modules = {} + linter.isort.order_by_type = true + linter.isort.relative_imports_order = furthest_to_closest + linter.isort.single_line_exclusions = [] + linter.isort.split_on_trailing_comma = true + linter.isort.classes = [] + linter.isort.constants = [] + linter.isort.variables = [] + linter.isort.no_lines_before = [] + linter.isort.lines_after_imports = -1 + linter.isort.lines_between_types = 0 + linter.isort.forced_separate = [] + linter.isort.section_order = [ + known { type = future }, + known { type = standard_library }, + known { type = third_party }, + known { type = first_party }, + known { type = local_folder }, + ] + linter.isort.default_section = known { type = third_party } + linter.isort.no_sections = false + linter.isort.from_first = false + linter.isort.length_sort = false + linter.isort.length_sort_straight = false + linter.mccabe.max_complexity = 10 + linter.pep8_naming.ignore_names = [ + setUp, + tearDown, + setUpClass, + tearDownClass, + setUpModule, + tearDownModule, + asyncSetUp, + asyncTearDown, + setUpTestData, + failureException, + longMessage, + maxDiff, + ] + linter.pep8_naming.classmethod_decorators = [] + linter.pep8_naming.staticmethod_decorators = [] + linter.pycodestyle.max_line_length = 88 + linter.pycodestyle.max_doc_length = none + linter.pycodestyle.ignore_overlong_task_comments = false + linter.pyflakes.extend_generics = [] + linter.pyflakes.allowed_unused_imports = [] + linter.pylint.allow_magic_value_types = [ + str, + bytes, + ] + linter.pylint.allow_dunder_method_names = [] + linter.pylint.max_args = 5 + linter.pylint.max_positional_args = 5 + linter.pylint.max_returns = 6 + linter.pylint.max_bool_expr = 5 + linter.pylint.max_branches = 12 + linter.pylint.max_statements = 50 + linter.pylint.max_public_methods = 20 + linter.pylint.max_locals = 15 + linter.pyupgrade.keep_runtime_typing = false + linter.ruff.parenthesize_tuple_in_subscript = false + + # Formatter Settings + formatter.exclude = [] + formatter.unresolved_target_version = 3.10 + formatter.per_file_target_version = {} + formatter.preview = disabled + formatter.line_width = 88 + formatter.line_ending = auto + formatter.indent_style = space + formatter.indent_width = 4 + formatter.quote_style = double + formatter.magic_trailing_comma = respect + formatter.docstring_code_format = disabled + formatter.docstring_code_line_width = dynamic + + # Analyze Settings + analyze.exclude = [] + analyze.preview = disabled + analyze.target_version = 3.10 + analyze.detect_string_imports = false + analyze.extension = ExtensionMapping({}) + analyze.include_dependencies = {} + + ----- stderr ----- + "#); + }); + + Ok(()) +} + +#[test] +fn checks_notebooks_in_stable() -> anyhow::Result<()> { + let tempdir = TempDir::new()?; + std::fs::write( + tempdir.path().join("main.ipynb"), + r#" +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "ad6f36d9-4b7d-4562-8d00-f15a0f1fbb6d", + "metadata": {}, + "outputs": [], + "source": [ + "import random" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.12.0" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} +"#, + )?; + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--select") + .arg("F401") + .current_dir(&tempdir) + , @r" + success: false + exit_code: 1 + ----- stdout ----- + main.ipynb:cell 1:1:8: F401 [*] `random` imported but unused + Found 1 error. + [*] 1 fixable with the `--fix` option. + + ----- stderr ----- + "); + Ok(()) +} + +/// Verify that implicit namespace packages are detected even when they are nested. +/// +/// See: <https://github.com/astral-sh/ruff/issues/13519> +#[test] +fn nested_implicit_namespace_package() -> Result<()> { + let tempdir = TempDir::new()?; + let root = ChildPath::new(tempdir.path()); + + root.child("foo").child("__init__.py").touch()?; + root.child("foo") + .child("bar") + .child("baz") + .child("__init__.py") + .touch()?; + root.child("foo") + .child("bar") + .child("baz") + .child("bop.py") + .touch()?; + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--select") + .arg("INP") + .current_dir(&tempdir) + , @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + "); + + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--select") + .arg("INP") + .arg("--preview") + .current_dir(&tempdir) + , @r" + success: false + exit_code: 1 + ----- stdout ----- + foo/bar/baz/__init__.py:1:1: INP001 File `foo/bar/baz/__init__.py` declares a package, but is nested under an implicit namespace package. Add an `__init__.py` to `foo/bar`. + Found 1 error. + + ----- stderr ----- + "); + }); + + Ok(()) +} + +#[test] +fn flake8_import_convention_invalid_aliases_config_alias_name() -> Result<()> { + let tempdir = TempDir::new()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +[lint.flake8-import-conventions.aliases] +"module.name" = "invalid.alias" +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(&ruff_toml) + , @r#" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Failed to load configuration `[TMP]/ruff.toml` + Cause: Failed to parse [TMP]/ruff.toml + Cause: TOML parse error at line 3, column 17 + | + 3 | "module.name" = "invalid.alias" + | ^^^^^^^^^^^^^^^ + invalid value: string "invalid.alias", expected a Python identifier + "#);}); + Ok(()) +} + +#[test] +fn flake8_import_convention_invalid_aliases_config_extend_alias_name() -> Result<()> { + let tempdir = TempDir::new()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +[lint.flake8-import-conventions.extend-aliases] +"module.name" = "__debug__" +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(&ruff_toml) + , @r#" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Failed to load configuration `[TMP]/ruff.toml` + Cause: Failed to parse [TMP]/ruff.toml + Cause: TOML parse error at line 3, column 17 + | + 3 | "module.name" = "__debug__" + | ^^^^^^^^^^^ + invalid value: string "__debug__", expected an assignable Python identifier + "#);}); + Ok(()) +} + +#[test] +fn flake8_import_convention_invalid_aliases_config_module_name() -> Result<()> { + let tempdir = TempDir::new()?; + let ruff_toml = tempdir.path().join("ruff.toml"); + fs::write( + &ruff_toml, + r#" +[lint.flake8-import-conventions.aliases] +"module..invalid" = "alias" +"#, + )?; + + insta::with_settings!({ + filters => vec![(tempdir_filter(&tempdir).as_str(), "[TMP]/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(&ruff_toml) + , @r#" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + ruff failed + Cause: Failed to load configuration `[TMP]/ruff.toml` + Cause: Failed to parse [TMP]/ruff.toml + Cause: TOML parse error at line 3, column 1 + | + 3 | "module..invalid" = "alias" + | ^^^^^^^^^^^^^^^^^ + invalid value: string "module..invalid", expected a sequence of Python identifiers delimited by periods + "#);}); + Ok(()) +} + +#[test] +fn flake8_import_convention_unused_aliased_import() { + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(r#"lint.isort.required-imports = ["import pandas"]"#) + .args(["--select", "I002,ICN001,F401"]) + .args(["--stdin-filename", "test.py"]) + .arg("--unsafe-fixes") + .arg("--fix") + .arg("-") + .pass_stdin("1") + ); +} + +#[test] +fn flake8_import_convention_unused_aliased_import_no_conflict() { + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(r#"lint.isort.required-imports = ["import pandas as pd"]"#) + .args(["--select", "I002,ICN001,F401"]) + .args(["--stdin-filename", "test.py"]) + .arg("--unsafe-fixes") + .arg("--fix") + .arg("-") + .pass_stdin("1") + ); +} + +// See: https://github.com/astral-sh/ruff/issues/16177 +#[test] +fn flake8_pyi_redundant_none_literal() { + let snippet = r#" +from typing import Literal + +# For each of these expressions, Ruff provides a fix for one of the `Literal[None]` elements +# but not both, as if both were autofixed it would result in `None | None`, +# which leads to a `TypeError` at runtime. +a: Literal[None,] | Literal[None,] +b: Literal[None] | Literal[None] +c: Literal[None] | Literal[None,] +d: Literal[None,] | Literal[None] +"#; + + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--select", "PYI061"]) + .args(["--stdin-filename", "test.py"]) + .arg("--preview") + .arg("--diff") + .arg("-") + .pass_stdin(snippet), @r" + success: false + exit_code: 1 + ----- stdout ----- + --- test.py + +++ test.py + @@ -4,7 +4,7 @@ + # For each of these expressions, Ruff provides a fix for one of the `Literal[None]` elements + # but not both, as if both were autofixed it would result in `None | None`, + # which leads to a `TypeError` at runtime. + -a: Literal[None,] | Literal[None,] + -b: Literal[None] | Literal[None] + -c: Literal[None] | Literal[None,] + -d: Literal[None,] | Literal[None] + +a: None | Literal[None,] + +b: None | Literal[None] + +c: None | Literal[None,] + +d: None | Literal[None] + + + ----- stderr ----- + Would fix 4 errors. + "); +} + +/// Test that private, old-style `TypeVar` generics +/// 1. Get replaced with PEP 695 type parameters (UP046, UP047) +/// 2. Get renamed to remove leading underscores (UP049) +/// 3. Emit a warning that the standalone type variable is now unused (PYI018) +/// 4. Remove the now-unused `Generic` import +#[test] +fn pep695_generic_rename() { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--select", "F401,PYI018,UP046,UP047,UP049"]) + .args(["--stdin-filename", "test.py"]) + .arg("--unsafe-fixes") + .arg("--fix") + .arg("--preview") + .arg("--target-version=py312") + .arg("-") + .pass_stdin( + r#" +from typing import Generic, TypeVar +_T = TypeVar("_T") + +class OldStyle(Generic[_T]): + var: _T + +def func(t: _T) -> _T: + x: _T + return x +"# + ), + @r" + success: true + exit_code: 0 + ----- stdout ----- + + + class OldStyle[T]: + var: T + + def func[T](t: T) -> T: + x: T + return x + + ----- stderr ----- + Found 7 errors (7 fixed, 0 remaining). + " + ); +} + +/// Test that we do not rename two different type parameters to the same name +/// in one execution of Ruff (autofixing this to `class Foo[T, T]: ...` would +/// introduce invalid syntax) +#[test] +fn type_parameter_rename_isolation() { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--select", "UP049"]) + .args(["--stdin-filename", "test.py"]) + .arg("--unsafe-fixes") + .arg("--fix") + .arg("--preview") + .arg("--target-version=py312") + .arg("-") + .pass_stdin( + r#" +class Foo[_T, __T]: + pass +"# + ), + @r" + success: false + exit_code: 1 + ----- stdout ----- + + class Foo[T, __T]: + pass + + ----- stderr ----- + test.py:2:14: UP049 Generic class uses private type parameters + Found 2 errors (1 fixed, 1 remaining). + " + ); +} + +/// construct a directory tree with this structure: +/// . +/// ├── abc +/// │ └── __init__.py +/// ├── collections +/// │ ├── __init__.py +/// │ ├── abc +/// │ │ └── __init__.py +/// │ └── foobar +/// │ └── __init__.py +/// ├── foobar +/// │ ├── __init__.py +/// │ ├── abc +/// │ │ └── __init__.py +/// │ └── collections +/// │ ├── __init__.py +/// │ ├── abc +/// │ │ └── __init__.py +/// │ └── foobar +/// │ └── __init__.py +/// ├── ruff.toml +/// └── urlparse +/// └── __init__.py +fn create_a005_module_structure(tempdir: &TempDir) -> Result<()> { + fn create_module(path: &Path) -> Result<()> { + fs::create_dir(path)?; + fs::File::create(path.join("__init__.py"))?; + Ok(()) + } + + let foobar = tempdir.path().join("foobar"); + create_module(&foobar)?; + for base in [&tempdir.path().into(), &foobar] { + for dir in ["abc", "collections"] { + create_module(&base.join(dir))?; + } + create_module(&base.join("collections").join("abc"))?; + create_module(&base.join("collections").join("foobar"))?; + } + create_module(&tempdir.path().join("urlparse"))?; + // also create a ruff.toml to mark the project root + fs::File::create(tempdir.path().join("ruff.toml"))?; + + Ok(()) +} + +/// Test A005 with `strict-checking = true` +#[test] +fn a005_module_shadowing_strict() -> Result<()> { + let tempdir = TempDir::new()?; + create_a005_module_structure(&tempdir)?; + + insta::with_settings!({ + filters => vec![(r"\\", "/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(r#"lint.flake8-builtins.strict-checking = true"#) + .args(["--select", "A005"]) + .current_dir(tempdir.path()), + @r" + success: false + exit_code: 1 + ----- stdout ----- + abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + collections/__init__.py:1:1: A005 Module `collections` shadows a Python standard-library module + collections/abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + foobar/abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + foobar/collections/__init__.py:1:1: A005 Module `collections` shadows a Python standard-library module + foobar/collections/abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + Found 6 errors. + + ----- stderr ----- + "); + }); + + Ok(()) +} + +/// Test A005 with `strict-checking = false` +#[test] +fn a005_module_shadowing_non_strict() -> Result<()> { + let tempdir = TempDir::new()?; + create_a005_module_structure(&tempdir)?; + + insta::with_settings!({ + filters => vec![(r"\\", "/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--config") + .arg(r#"lint.flake8-builtins.strict-checking = false"#) + .args(["--select", "A005"]) + .current_dir(tempdir.path()), + @r" + success: false + exit_code: 1 + ----- stdout ----- + abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + collections/__init__.py:1:1: A005 Module `collections` shadows a Python standard-library module + Found 2 errors. + + ----- stderr ----- + "); + + }); + + Ok(()) +} + +/// Test A005 with `strict-checking` unset +/// +/// This should match the non-strict version directly above +#[test] +fn a005_module_shadowing_strict_default() -> Result<()> { + let tempdir = TempDir::new()?; + create_a005_module_structure(&tempdir)?; + + insta::with_settings!({ + filters => vec![(r"\\", "/")] + }, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--select", "A005"]) + .current_dir(tempdir.path()), + @r" + success: false + exit_code: 1 + ----- stdout ----- + abc/__init__.py:1:1: A005 Module `abc` shadows a Python standard-library module + collections/__init__.py:1:1: A005 Module `collections` shadows a Python standard-library module + Found 2 errors. + + ----- stderr ----- + "); + }); + Ok(()) +} + +/// Test that the linter respects per-file-target-version. +#[test] +fn per_file_target_version_linter() { + // without per-file-target-version, there should be one UP046 error + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--target-version", "py312"]) + .args(["--select", "UP046"]) // only triggers on 3.12+ + .args(["--stdin-filename", "test.py"]) + .arg("--preview") + .arg("-") + .pass_stdin(r#" +from typing import Generic, TypeVar + +T = TypeVar("T") + +class A(Generic[T]): + var: T +"#), + @r" + success: false + exit_code: 1 + ----- stdout ----- + test.py:6:9: UP046 Generic class `A` uses `Generic` subclass instead of type parameters + Found 1 error. + No fixes available (1 hidden fix can be enabled with the `--unsafe-fixes` option). + + ----- stderr ----- + " + ); + + // with per-file-target-version, there should be no errors because the new generic syntax is + // unavailable + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--target-version", "py312"]) + .args(["--config", r#"per-file-target-version = {"test.py" = "py311"}"#]) + .args(["--select", "UP046"]) // only triggers on 3.12+ + .args(["--stdin-filename", "test.py"]) + .arg("--preview") + .arg("-") + .pass_stdin(r#" +from typing import Generic, TypeVar + +T = TypeVar("T") + +class A(Generic[T]): + var: T +"#), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); +} + +#[test] +fn walrus_before_py38() { + // ok + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--stdin-filename", "test.py"]) + .arg("--target-version=py38") + .arg("-") + .pass_stdin(r#"(x := 1)"#), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); + + // not ok on 3.7 with preview + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--stdin-filename", "test.py"]) + .arg("--target-version=py37") + .arg("--preview") + .arg("-") + .pass_stdin(r#"(x := 1)"#), + @r" + success: false + exit_code: 1 + ----- stdout ----- + test.py:1:2: SyntaxError: Cannot use named assignment expression (`:=`) on Python 3.7 (syntax was added in Python 3.8) + Found 1 error. + + ----- stderr ----- + " + ); +} + +#[test] +fn match_before_py310() { + // ok on 3.10 + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--stdin-filename", "test.py"]) + .arg("--target-version=py310") + .arg("-") + .pass_stdin( + r#" +match 2: + case 1: + print("it's one") +"# + ), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); + + // ok on 3.9 without preview + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--stdin-filename", "test.py"]) + .arg("--target-version=py39") + .arg("-") + .pass_stdin( + r#" +match 2: + case 1: + print("it's one") +"# + ), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); + + // syntax error on 3.9 with preview + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--stdin-filename", "test.py"]) + .arg("--target-version=py39") + .arg("--preview") + .arg("-") + .pass_stdin( + r#" +match 2: + case 1: + print("it's one") +"# + ), + @r" + success: false + exit_code: 1 + ----- stdout ----- + test.py:2:1: SyntaxError: Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10) + Found 1 error. + + ----- stderr ----- + " + ); +} + +/// Regression test for <https://github.com/astral-sh/ruff/issues/16417> +#[test] +fn cache_syntax_errors() -> Result<()> { + let tempdir = TempDir::new()?; + fs::write(tempdir.path().join("main.py"), "match 2:\n case 1: ...")?; + + let mut cmd = Command::new(get_cargo_bin(BIN_NAME)); + // inline STDIN_BASE_OPTIONS to remove --no-cache + cmd.args(["check", "--output-format", "concise"]) + .arg("--target-version=py39") + .arg("--preview") + .arg("--quiet") // suppress `debug build without --no-cache` warnings + .current_dir(&tempdir); + + assert_cmd_snapshot!( + cmd, + @r" + success: false + exit_code: 1 + ----- stdout ----- + main.py:1:1: SyntaxError: Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10) + + ----- stderr ----- + " + ); + + // this should *not* be cached, like normal parse errors + assert_cmd_snapshot!( + cmd, + @r" + success: false + exit_code: 1 + ----- stdout ----- + main.py:1:1: SyntaxError: Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10) + + ----- stderr ----- + " + ); + + Ok(()) +} + +/// Regression test for <https://github.com/astral-sh/ruff/issues/9381> with very helpful +/// reproduction repo here: <https://github.com/lucasfijen/example_ruff_glob_bug> +#[test] +fn cookiecutter_globbing() -> Result<()> { + // This is a simplified directory structure from the repo linked above. The essence of the + // problem is this `{{cookiecutter.repo_name}}` directory containing a config file with a glob. + // The absolute path of the glob contains the glob metacharacters `{{` and `}}` even though the + // user's glob does not. + let tempdir = TempDir::new()?; + let cookiecutter = tempdir.path().join("{{cookiecutter.repo_name}}"); + let cookiecutter_toml = cookiecutter.join("pyproject.toml"); + let tests = cookiecutter.join("tests"); + fs::create_dir_all(&tests)?; + fs::write( + &cookiecutter_toml, + r#"tool.ruff.lint.per-file-ignores = { "tests/*" = ["F811"] }"#, + )?; + // F811 example from the docs to ensure the glob still works + let maintest = tests.join("maintest.py"); + fs::write(maintest, "import foo\nimport bar\nimport foo")?; + + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--select=F811") + .current_dir(tempdir.path()), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + "); + }); + + // after removing the config file with the ignore, F811 applies, so the glob worked above + fs::remove_file(cookiecutter_toml)?; + + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .arg("--select=F811") + .current_dir(tempdir.path()), @r" + success: false + exit_code: 1 + ----- stdout ----- + {{cookiecutter.repo_name}}/tests/maintest.py:3:8: F811 [*] Redefinition of unused `foo` from line 1 + Found 1 error. + [*] 1 fixable with the `--fix` option. + + ----- stderr ----- + "); + }); + + Ok(()) +} + +/// Like the test above but exercises the non-absolute path case in `PerFile::new` +#[test] +fn cookiecutter_globbing_no_project_root() -> Result<()> { + let tempdir = TempDir::new()?; + let tempdir = tempdir.path().join("{{cookiecutter.repo_name}}"); + fs::create_dir(&tempdir)?; + + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) + .current_dir(&tempdir) + .args(STDIN_BASE_OPTIONS) + .args(["--extend-per-file-ignores", "generated.py:Q"]), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + warning: No Python files found under the given path(s) + "); + }); + + Ok(()) +} + +/// Test that semantic syntax errors (1) are emitted, (2) are not cached, (3) don't affect the +/// reporting of normal diagnostics, and (4) are not suppressed by `select = []` (or otherwise +/// disabling all AST-based rules). +#[test] +fn semantic_syntax_errors() -> Result<()> { + let tempdir = TempDir::new()?; + let contents = "[(x := 1) for x in foo]"; + fs::write(tempdir.path().join("main.py"), contents)?; + + let mut cmd = Command::new(get_cargo_bin(BIN_NAME)); + // inline STDIN_BASE_OPTIONS to remove --no-cache + cmd.args(["check", "--output-format", "concise"]) + .arg("--preview") + .arg("--quiet") // suppress `debug build without --no-cache` warnings + .current_dir(&tempdir); + + assert_cmd_snapshot!( + cmd, + @r" + success: false + exit_code: 1 + ----- stdout ----- + main.py:1:3: SyntaxError: assignment expression cannot rebind comprehension variable + main.py:1:20: F821 Undefined name `foo` + + ----- stderr ----- + " + ); + + // this should *not* be cached, like normal parse errors + assert_cmd_snapshot!( + cmd, + @r" + success: false + exit_code: 1 + ----- stdout ----- + main.py:1:3: SyntaxError: assignment expression cannot rebind comprehension variable + main.py:1:20: F821 Undefined name `foo` + + ----- stderr ----- + " + ); + + // ensure semantic errors are caught even without AST-based rules selected + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--config", "lint.select = []"]) + .arg("--preview") + .arg("-") + .pass_stdin(contents), + @r" + success: false + exit_code: 1 + ----- stdout ----- + -:1:3: SyntaxError: assignment expression cannot rebind comprehension variable + Found 1 error. + + ----- stderr ----- + " + ); + + Ok(()) +} + +/// Regression test for <https://github.com/astral-sh/ruff/issues/17821>. +/// +/// `lint.typing-extensions = false` with Python 3.9 should disable the PYI019 lint because it would +/// try to import `Self` from `typing_extensions` +#[test] +fn combine_typing_extensions_config() { + let contents = " +from typing import TypeVar +T = TypeVar('T') +class Foo: + def f(self: T) -> T: ... +"; + assert_cmd_snapshot!( + Command::new(get_cargo_bin(BIN_NAME)) + .args(STDIN_BASE_OPTIONS) + .args(["--config", "lint.typing-extensions = false"]) + .arg("--select=PYI019") + .arg("--target-version=py39") + .arg("-") + .pass_stdin(contents), + @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + " + ); +} diff --git a/crates/ruff/tests/resolve_files.rs b/crates/ruff/tests/resolve_files.rs index 4f64748955287..866357eed22f1 100644 --- a/crates/ruff/tests/resolve_files.rs +++ b/crates/ruff/tests/resolve_files.rs @@ -29,7 +29,7 @@ fn check_project_include_defaults() { filters => TEST_FILTERS.to_vec() }, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--show-files"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r###" + .args(["check", "--show-files"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r" success: true exit_code: 0 ----- stdout ----- @@ -41,7 +41,7 @@ fn check_project_include_defaults() { ----- stderr ----- warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options in `nested-project/pyproject.toml`: - 'select' -> 'lint.select' - "###); + "); }); } @@ -53,14 +53,14 @@ fn check_project_respects_direct_paths() { filters => TEST_FILTERS.to_vec() }, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--show-files", "b.py"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r###" + .args(["check", "--show-files", "b.py"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r" success: true exit_code: 0 ----- stdout ----- [BASEPATH]/include-test/b.py ----- stderr ----- - "###); + "); }); } @@ -72,14 +72,14 @@ fn check_project_respects_subdirectory_includes() { filters => TEST_FILTERS.to_vec() }, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--show-files", "subdirectory"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r###" + .args(["check", "--show-files", "subdirectory"]).current_dir(Path::new("./resources/test/fixtures/include-test")), @r" success: true exit_code: 0 ----- stdout ----- [BASEPATH]/include-test/subdirectory/c.py ----- stderr ----- - "###); + "); }); } @@ -91,13 +91,13 @@ fn check_project_from_project_subdirectory_respects_includes() { filters => TEST_FILTERS.to_vec() }, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--show-files"]).current_dir(Path::new("./resources/test/fixtures/include-test/subdirectory")), @r###" + .args(["check", "--show-files"]).current_dir(Path::new("./resources/test/fixtures/include-test/subdirectory")), @r" success: true exit_code: 0 ----- stdout ----- [BASEPATH]/include-test/subdirectory/c.py ----- stderr ----- - "###); + "); }); } diff --git a/crates/ruff/tests/show_settings.rs b/crates/ruff/tests/show_settings.rs index d418b77228f93..d6fc8e2f96c1d 100644 --- a/crates/ruff/tests/show_settings.rs +++ b/crates/ruff/tests/show_settings.rs @@ -1,33 +1,57 @@ +use anyhow::Context; use insta_cmd::{assert_cmd_snapshot, get_cargo_bin}; use std::path::Path; use std::process::Command; +use tempfile::TempDir; const BIN_NAME: &str = "ruff"; #[test] -fn display_default_settings() { - // Navigate from the crate directory to the workspace root. - let base_path = Path::new(env!("CARGO_MANIFEST_DIR")) - .parent() - .unwrap() - .parent() - .unwrap(); - let base_path = base_path.to_string_lossy(); - - // Escape the backslashes for the regex. - let base_path = regex::escape(&base_path); - - #[cfg(not(target_os = "windows"))] - let test_filters = &[(base_path.as_ref(), "[BASEPATH]")]; - - #[cfg(target_os = "windows")] - let test_filters = &[ - (base_path.as_ref(), "[BASEPATH]"), - (r#"\\+(\w\w|\s|\.|")"#, "/$1"), - ]; - - insta::with_settings!({ filters => test_filters.to_vec() }, { +fn display_default_settings() -> anyhow::Result<()> { + let tempdir = TempDir::new().context("Failed to create temp directory.")?; + + // Tempdir path's on macos are symlinks, which doesn't play nicely with + // our snapshot filtering. + let project_dir = tempdir + .path() + .canonicalize() + .context("Failed to canonical tempdir path.")?; + + std::fs::write( + project_dir.join("pyproject.toml"), + r#" +[project] +name = "ruff" +version = "0.9.2" +requires-python = ">=3.7" + +[tool.ruff] +line-length = 100 + +[tool.ruff.lint] +ignore = [ + # Conflicts with the formatter + "COM812", "ISC001" +] + +"#, + )?; + + std::fs::write(project_dir.join("test.py"), r#"print("Hello")"#) + .context("Failed to write test.py.")?; + + insta::with_settings!({filters => vec![ + (&*tempdir_filter(&project_dir), "<temp_dir>/"), + (r#"\\(\w\w|\s|\.|")"#, "/$1"), + ]}, { assert_cmd_snapshot!(Command::new(get_cargo_bin(BIN_NAME)) - .args(["check", "--show-settings", "unformatted.py"]).current_dir(Path::new("./resources/test/fixtures"))); + .args(["check", "--show-settings", "test.py"]) + .current_dir(project_dir)); }); + + Ok(()) +} + +fn tempdir_filter(project_dir: &Path) -> String { + format!(r#"{}\\?/?"#, regex::escape(project_dir.to_str().unwrap())) } diff --git a/crates/ruff/tests/snapshots/integration_test__rule_f401.snap b/crates/ruff/tests/snapshots/integration_test__rule_f401.snap index 2c2654897f59f..a861fe395ce50 100644 --- a/crates/ruff/tests/snapshots/integration_test__rule_f401.snap +++ b/crates/ruff/tests/snapshots/integration_test__rule_f401.snap @@ -83,12 +83,18 @@ else: print("numpy is not installed") ``` +## Preview +When [preview](https://docs.astral.sh/ruff/preview/) is enabled, +the criterion for determining whether an import is first-party +is stricter, which could affect the suggested fix. See [this FAQ section](https://docs.astral.sh/ruff/faq/#how-does-ruff-determine-which-of-my-imports-are-first-party-third-party-etc) for more details. + ## Options - `lint.ignore-init-module-imports` +- `lint.pyflakes.allowed-unused-imports` ## References - [Python documentation: `import`](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement) - [Python documentation: `importlib.util.find_spec`](https://docs.python.org/3/library/importlib.html#importlib.util.find_spec) -- [Typing documentation: interface conventions](https://typing.readthedocs.io/en/latest/source/libraries.html#library-interface-public-and-private-symbols) +- [Typing documentation: interface conventions](https://typing.python.org/en/latest/source/libraries.html#library-interface-public-and-private-symbols) ----- stderr ----- diff --git a/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import.snap b/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import.snap new file mode 100644 index 0000000000000..95379dfd9b9e4 --- /dev/null +++ b/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff/tests/lint.rs +info: + program: ruff + args: + - check + - "--no-cache" + - "--output-format" + - concise + - "--config" + - "lint.isort.required-imports = [\"import pandas\"]" + - "--select" + - "I002,ICN001,F401" + - "--stdin-filename" + - test.py + - "--unsafe-fixes" + - "--fix" + - "-" + stdin: "1" +snapshot_kind: text +--- +success: false +exit_code: 2 +----- stdout ----- + +----- stderr ----- +ruff failed + Cause: Required import specified in `lint.isort.required-imports` (I002) conflicts with the required import alias specified in either `lint.flake8-import-conventions.aliases` or `lint.flake8-import-conventions.extend-aliases` (ICN001): + - `pandas` -> `pd` + +Help: Remove the required import or alias from your configuration. diff --git a/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import_no_conflict.snap b/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import_no_conflict.snap new file mode 100644 index 0000000000000..b074787f9c176 --- /dev/null +++ b/crates/ruff/tests/snapshots/lint__flake8_import_convention_unused_aliased_import_no_conflict.snap @@ -0,0 +1,27 @@ +--- +source: crates/ruff/tests/lint.rs +info: + program: ruff + args: + - check + - "--no-cache" + - "--output-format" + - concise + - "--config" + - "lint.isort.required-imports = [\"import pandas as pd\"]" + - "--select" + - "I002,ICN001,F401" + - "--stdin-filename" + - test.py + - "--unsafe-fixes" + - "--fix" + - "-" + stdin: "1" +--- +success: true +exit_code: 0 +----- stdout ----- +import pandas as pd +1 +----- stderr ----- +Found 1 error (1 fixed, 0 remaining). diff --git a/crates/ruff/tests/snapshots/lint__warn_invalid_noqa_with_no_diagnostics.snap b/crates/ruff/tests/snapshots/lint__warn_invalid_noqa_with_no_diagnostics.snap new file mode 100644 index 0000000000000..09772b73fcfc2 --- /dev/null +++ b/crates/ruff/tests/snapshots/lint__warn_invalid_noqa_with_no_diagnostics.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff/tests/lint.rs +info: + program: ruff + args: + - check + - "--no-cache" + - "--output-format" + - concise + - "--isolated" + - "--select" + - F401 + - "-" + stdin: "\n# ruff: noqa: AAA101\nprint(\"Hello world!\")\n" +--- +success: true +exit_code: 0 +----- stdout ----- +All checks passed! + +----- stderr ----- +warning: Invalid rule code provided to `# ruff: noqa` at -:2: AAA101 diff --git a/crates/ruff/tests/snapshots/show_settings__display_default_settings.snap b/crates/ruff/tests/snapshots/show_settings__display_default_settings.snap index 223d1b253c219..37e8eae6bcac7 100644 --- a/crates/ruff/tests/snapshots/show_settings__display_default_settings.snap +++ b/crates/ruff/tests/snapshots/show_settings__display_default_settings.snap @@ -5,16 +5,16 @@ info: args: - check - "--show-settings" - - unformatted.py + - test.py --- success: true exit_code: 0 ----- stdout ----- -Resolved settings for: "[BASEPATH]/crates/ruff/resources/test/fixtures/unformatted.py" -Settings path: "[BASEPATH]/pyproject.toml" +Resolved settings for: "<temp_dir>/test.py" +Settings path: "<temp_dir>/pyproject.toml" # General Settings -cache_dir = "[BASEPATH]/.ruff_cache" +cache_dir = "<temp_dir>/.ruff_cache" fix = false fix_only = false output_format = full @@ -49,13 +49,7 @@ file_resolver.exclude = [ "site-packages", "venv", ] -file_resolver.extend_exclude = [ - "crates/red_knot_vendored/vendor/", - "crates/ruff/resources/", - "crates/ruff_linter/resources/", - "crates/ruff_python_formatter/resources/", - "crates/ruff_python_parser/resources/", -] +file_resolver.extend_exclude = [] file_resolver.force_exclude = false file_resolver.include = [ "*.py", @@ -65,11 +59,11 @@ file_resolver.include = [ ] file_resolver.extend_include = [] file_resolver.respect_gitignore = true -file_resolver.project_root = "[BASEPATH]" +file_resolver.project_root = "<temp_dir>/" # Linter Settings linter.exclude = [] -linter.project_root = "[BASEPATH]" +linter.project_root = "<temp_dir>/" linter.rules.enabled = [ multiple-imports-on-one-line (E401), module-import-not-at-top-of-file (E402), @@ -87,7 +81,6 @@ linter.rules.enabled = [ ambiguous-class-name (E742), ambiguous-function-name (E743), io-error (E902), - syntax-error (E999), unused-import (F401), import-shadowed-by-loop-var (F402), undefined-local-with-import-star (F403), @@ -149,7 +142,6 @@ linter.rules.should_fix = [ ambiguous-class-name (E742), ambiguous-function-name (E743), io-error (E902), - syntax-error (E999), unused-import (F401), import-shadowed-by-loop-var (F402), undefined-local-with-import-star (F403), @@ -197,7 +189,8 @@ linter.rules.should_fix = [ linter.per_file_ignores = {} linter.safety_table.forced_safe = [] linter.safety_table.forced_unsafe = [] -linter.target_version = Py37 +linter.unresolved_target_version = 3.7 +linter.per_file_target_version = {} linter.preview = disabled linter.explicit_preview_rules = false linter.extension = ExtensionMapping({}) @@ -209,17 +202,18 @@ linter.ignore_init_module_imports = true linter.logger_objects = [] linter.namespace_packages = [] linter.src = [ - "[BASEPATH]", - "[BASEPATH]/src", + "<temp_dir>/", + "<temp_dir>/src", ] linter.tab_size = 4 -linter.line_length = 88 +linter.line_length = 100 linter.task_tags = [ TODO, FIXME, XXX, ] linter.typing_modules = [] +linter.typing_extensions = true # Linter Plugins linter.flake8_annotations.mypy_init_return = false @@ -233,9 +227,12 @@ linter.flake8_bandit.hardcoded_tmp_directory = [ /dev/shm, ] linter.flake8_bandit.check_typed_exception = false +linter.flake8_bandit.extend_markup_names = [] +linter.flake8_bandit.allowed_markup_calls = [] linter.flake8_bugbear.extend_immutable_calls = [] -linter.flake8_builtins.builtins_allowed_modules = [] -linter.flake8_builtins.builtins_ignorelist = [] +linter.flake8_builtins.allowed_modules = [] +linter.flake8_builtins.ignorelist = [] +linter.flake8_builtins.strict_checking = false linter.flake8_comprehensions.allow_dict_calls_with_keyword_arguments = false linter.flake8_copyright.notice_rgx = (?i)Copyright\s+((?:\(C\)|©)\s+)?\d{4}((-|,\s)\d{4})* linter.flake8_copyright.author = none @@ -254,6 +251,7 @@ linter.flake8_import_conventions.aliases = { matplotlib.pyplot = plt, networkx = nx, numpy = np, + numpy.typing = npt, pandas = pd, panel = pn, plotly.express = px, @@ -355,7 +353,7 @@ linter.pep8_naming.ignore_names = [ ] linter.pep8_naming.classmethod_decorators = [] linter.pep8_naming.staticmethod_decorators = [] -linter.pycodestyle.max_line_length = 88 +linter.pycodestyle.max_line_length = 100 linter.pycodestyle.max_doc_length = none linter.pycodestyle.ignore_overlong_task_comments = false linter.pyflakes.extend_generics = [] @@ -378,9 +376,10 @@ linter.ruff.parenthesize_tuple_in_subscript = false # Formatter Settings formatter.exclude = [] -formatter.target_version = Py37 +formatter.unresolved_target_version = 3.7 +formatter.per_file_target_version = {} formatter.preview = disabled -formatter.line_width = 88 +formatter.line_width = 100 formatter.line_ending = auto formatter.indent_style = space formatter.indent_width = 4 @@ -392,7 +391,7 @@ formatter.docstring_code_line_width = dynamic # Analyze Settings analyze.exclude = [] analyze.preview = disabled -analyze.target_version = Py37 +analyze.target_version = 3.7 analyze.detect_string_imports = false analyze.extension = ExtensionMapping({}) analyze.include_dependencies = {} diff --git a/crates/ruff/tests/version.rs b/crates/ruff/tests/version.rs index 016feffd38472..6dbf7ba97db30 100644 --- a/crates/ruff/tests/version.rs +++ b/crates/ruff/tests/version.rs @@ -16,14 +16,14 @@ const VERSION_FILTER: [(&str, &str); 1] = [( fn version_basics() { insta::with_settings!({filters => VERSION_FILTER.to_vec()}, { assert_cmd_snapshot!( - Command::new(get_cargo_bin(BIN_NAME)).arg("version"), @r###" + Command::new(get_cargo_bin(BIN_NAME)).arg("version"), @r" success: true exit_code: 0 ----- stdout ----- ruff [VERSION] ----- stderr ----- - "### + " ); }); } @@ -42,14 +42,14 @@ fn config_option_allowed_but_ignored() -> Result<()> { .arg("version") .arg("--config") .arg(&ruff_dot_toml) - .args(["--config", "lint.isort.extra-standard-library = ['foo', 'bar']"]), @r###" + .args(["--config", "lint.isort.extra-standard-library = ['foo', 'bar']"]), @r" success: true exit_code: 0 ----- stdout ----- ruff [VERSION] ----- stderr ----- - "### + " ); }); Ok(()) @@ -60,7 +60,7 @@ fn config_option_ignored_but_validated() { assert_cmd_snapshot!( Command::new(get_cargo_bin(BIN_NAME)) .arg("version") - .args(["--config", "foo = bar"]), @r###" + .args(["--config", "foo = bar"]), @r#" success: false exit_code: 2 ----- stdout ----- @@ -82,7 +82,7 @@ fn config_option_ignored_but_validated() { expected `"`, `'` For more information, try '--help'. - "### + "# ); }); } @@ -92,14 +92,14 @@ fn config_option_ignored_but_validated() { fn isolated_option_allowed() { insta::with_settings!({filters => VERSION_FILTER.to_vec()}, { assert_cmd_snapshot!( - Command::new(get_cargo_bin(BIN_NAME)).arg("version").arg("--isolated"), @r###" + Command::new(get_cargo_bin(BIN_NAME)).arg("version").arg("--isolated"), @r" success: true exit_code: 0 ----- stdout ----- ruff [VERSION] ----- stderr ----- - "### + " ); }); } diff --git a/crates/ruff_annotate_snippets/Cargo.toml b/crates/ruff_annotate_snippets/Cargo.toml new file mode 100644 index 0000000000000..7352430948518 --- /dev/null +++ b/crates/ruff_annotate_snippets/Cargo.toml @@ -0,0 +1,37 @@ +[package] +name = "ruff_annotate_snippets" +version = "0.1.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = "MIT OR Apache-2.0" + +[lib] + +[features] +default = [] +testing-colors = [] + +[dependencies] +anstyle = { workspace = true } +memchr = { workspace = true } +unicode-width = { workspace = true } + +[dev-dependencies] +ruff_annotate_snippets = { workspace = true, features = ["testing-colors"] } +anstream = { workspace = true } +serde = { workspace = true, features = ["derive"] } +snapbox = { workspace = true, features = ["diff", "term-svg", "cmd", "examples"] } +toml = { workspace = true } +tryfn = { workspace = true } + +[[test]] +name = "fixtures" +harness = false + +[lints] +workspace = true diff --git a/crates/ruff_annotate_snippets/LICENSE-APACHE b/crates/ruff_annotate_snippets/LICENSE-APACHE new file mode 100644 index 0000000000000..8f71f43fee3f7 --- /dev/null +++ b/crates/ruff_annotate_snippets/LICENSE-APACHE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/crates/ruff_annotate_snippets/LICENSE-MIT b/crates/ruff_annotate_snippets/LICENSE-MIT new file mode 100644 index 0000000000000..a2d01088b6ce5 --- /dev/null +++ b/crates/ruff_annotate_snippets/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) Individual contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/crates/ruff_annotate_snippets/README.md b/crates/ruff_annotate_snippets/README.md new file mode 100644 index 0000000000000..f4fc4a0de6928 --- /dev/null +++ b/crates/ruff_annotate_snippets/README.md @@ -0,0 +1,15 @@ +This is a fork of the [`annotate-snippets` crate]. The principle motivation for +this fork, at the time of writing, is [issue #167]. Specifically, we wanted to +upgrade our version of `annotate-snippets`, but do so _without_ changing our +diagnostic message format. + +This copy of `annotate-snippets` is basically identical to upstream, but with +an extra `Level::None` variant that permits skipping over a new non-optional +header emitted by `annotate-snippets`. + +More generally, it seems plausible that we may want to tweak other aspects of +the output format in the future, so it might make sense to stick with our own +copy so that we can be masters of our own destiny. + +[issue #167]: https://github.com/rust-lang/annotate-snippets-rs/issues/167 +[`annotate-snippets` crate]: https://github.com/rust-lang/annotate-snippets-rs diff --git a/crates/ruff_annotate_snippets/examples/expected_type.rs b/crates/ruff_annotate_snippets/examples/expected_type.rs new file mode 100644 index 0000000000000..80b92c90db435 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/expected_type.rs @@ -0,0 +1,23 @@ +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +fn main() { + let source = r#" annotations: vec![SourceAnnotation { + label: "expected struct `annotate_snippets::snippet::Slice`, found reference" + , + range: <22, 25>,"#; + let message = Level::Error.title("expected type, found `22`").snippet( + Snippet::source(source) + .line_start(26) + .origin("examples/footer.rs") + .fold(true) + .annotation( + Level::Error + .span(193..195) + .label("expected struct `annotate_snippets::snippet::Slice`, found reference"), + ) + .annotation(Level::Info.span(34..50).label("while parsing this struct")), + ); + + let renderer = Renderer::styled(); + anstream::println!("{}", renderer.render(message)); +} diff --git a/crates/ruff_annotate_snippets/examples/expected_type.svg b/crates/ruff_annotate_snippets/examples/expected_type.svg new file mode 100644 index 0000000000000..ed19ef385d3d8 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/expected_type.svg @@ -0,0 +1,46 @@ +<svg width="860px" height="218px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected type, found `22`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> examples/footer.rs:29:25</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">26 |</tspan><tspan> annotations: vec![SourceAnnotation {</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">----------------</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">info: while parsing this struct</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">27 |</tspan><tspan> label: "expected struct `annotate_snippets::snippet::Slice`, found reference"</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">28 |</tspan><tspan> ,</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan class="fg-bright-blue bold">29 |</tspan><tspan> range: <22, 25>,</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected struct `annotate_snippets::snippet::Slice`, found reference</tspan> +</tspan> + <tspan x="10px" y="190px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="208px"> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/examples/footer.rs b/crates/ruff_annotate_snippets/examples/footer.rs new file mode 100644 index 0000000000000..f2d05a15f8d05 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/footer.rs @@ -0,0 +1,22 @@ +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +fn main() { + let message = + Level::Error + .title("mismatched types") + .id("E0308") + .snippet( + Snippet::source(" slices: vec![\"A\",") + .line_start(13) + .origin("src/multislice.rs") + .annotation(Level::Error.span(21..24).label( + "expected struct `annotate_snippets::snippet::Slice`, found reference", + )), + ) + .footer(Level::Note.title( + "expected type: `snippet::Annotation`\n found type: `__&__snippet::Annotation`", + )); + + let renderer = Renderer::styled(); + anstream::println!("{}", renderer.render(message)); +} diff --git a/crates/ruff_annotate_snippets/examples/footer.svg b/crates/ruff_annotate_snippets/examples/footer.svg new file mode 100644 index 0000000000000..76e7d776bf263 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/footer.svg @@ -0,0 +1,43 @@ +<svg width="844px" height="182px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-green { fill: #55FF55 } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/multislice.rs:13:22</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">13 |</tspan><tspan> slices: vec!["A",</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected struct `annotate_snippets::snippet::Slice`, found reference</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan> </tspan><tspan class="fg-bright-blue bold">= </tspan><tspan class="fg-bright-green bold">note</tspan><tspan>: expected type: `snippet::Annotation`</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> found type: `__&__snippet::Annotation`</tspan> +</tspan> + <tspan x="10px" y="172px"> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/examples/format.rs b/crates/ruff_annotate_snippets/examples/format.rs new file mode 100644 index 0000000000000..2365b76f0e9f6 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/format.rs @@ -0,0 +1,44 @@ +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +fn main() { + let source = r#") -> Option<String> { + for ann in annotations { + match (ann.range.0, ann.range.1) { + (None, None) => continue, + (Some(start), Some(end)) if start > end_index => continue, + (Some(start), Some(end)) if start >= start_index => { + let label = if let Some(ref label) = ann.label { + format!(" {}", label) + } else { + String::from("") + }; + + return Some(format!( + "{}{}{}", + " ".repeat(start - start_index), + "^".repeat(end - start), + label + )); + } + _ => continue, + } + }"#; + let message = Level::Error.title("mismatched types").id("E0308").snippet( + Snippet::source(source) + .line_start(51) + .origin("src/format.rs") + .annotation( + Level::Warning + .span(5..19) + .label("expected `Option<String>` because of return type"), + ) + .annotation( + Level::Error + .span(26..724) + .label("expected enum `std::option::Option`"), + ), + ); + + let renderer = Renderer::styled(); + anstream::println!("{}", renderer.render(message)); +} diff --git a/crates/ruff_annotate_snippets/examples/format.svg b/crates/ruff_annotate_snippets/examples/format.svg new file mode 100644 index 0000000000000..ac196c0168556 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/format.svg @@ -0,0 +1,83 @@ +<svg width="740px" height="542px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .fg-yellow { fill: #AA5500 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/format.rs:51:6</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">51 |</tspan><tspan> ) -> Option<String> {</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">--------------</tspan><tspan> </tspan><tspan class="fg-yellow bold">expected `Option<String>` because of return type</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">52 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">/</tspan><tspan> for ann in annotations {</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">53 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> match (ann.range.0, ann.range.1) {</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan class="fg-bright-blue bold">54 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> (None, None) => continue,</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan class="fg-bright-blue bold">55 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> (Some(start), Some(end)) if start > end_index => continue,</tspan> +</tspan> + <tspan x="10px" y="190px"><tspan class="fg-bright-blue bold">56 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> (Some(start), Some(end)) if start >= start_index => {</tspan> +</tspan> + <tspan x="10px" y="208px"><tspan class="fg-bright-blue bold">57 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> let label = if let Some(ref label) = ann.label {</tspan> +</tspan> + <tspan x="10px" y="226px"><tspan class="fg-bright-blue bold">58 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> format!(" {}", label)</tspan> +</tspan> + <tspan x="10px" y="244px"><tspan class="fg-bright-blue bold">59 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> } else {</tspan> +</tspan> + <tspan x="10px" y="262px"><tspan class="fg-bright-blue bold">60 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> String::from("")</tspan> +</tspan> + <tspan x="10px" y="280px"><tspan class="fg-bright-blue bold">61 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> };</tspan> +</tspan> + <tspan x="10px" y="298px"><tspan class="fg-bright-blue bold">62 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan> +</tspan> + <tspan x="10px" y="316px"><tspan class="fg-bright-blue bold">63 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> return Some(format!(</tspan> +</tspan> + <tspan x="10px" y="334px"><tspan class="fg-bright-blue bold">64 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> "{}{}{}",</tspan> +</tspan> + <tspan x="10px" y="352px"><tspan class="fg-bright-blue bold">65 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> " ".repeat(start - start_index),</tspan> +</tspan> + <tspan x="10px" y="370px"><tspan class="fg-bright-blue bold">66 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> "^".repeat(end - start),</tspan> +</tspan> + <tspan x="10px" y="388px"><tspan class="fg-bright-blue bold">67 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> label</tspan> +</tspan> + <tspan x="10px" y="406px"><tspan class="fg-bright-blue bold">68 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> ));</tspan> +</tspan> + <tspan x="10px" y="424px"><tspan class="fg-bright-blue bold">69 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="442px"><tspan class="fg-bright-blue bold">70 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> _ => continue,</tspan> +</tspan> + <tspan x="10px" y="460px"><tspan class="fg-bright-blue bold">71 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="478px"><tspan class="fg-bright-blue bold">72 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="496px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|____^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected enum `std::option::Option`</tspan> +</tspan> + <tspan x="10px" y="514px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="532px"> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/examples/multislice.rs b/crates/ruff_annotate_snippets/examples/multislice.rs new file mode 100644 index 0000000000000..2d4e59c0e956f --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/multislice.rs @@ -0,0 +1,19 @@ +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +fn main() { + let message = Level::Error + .title("mismatched types") + .snippet( + Snippet::source("Foo") + .line_start(51) + .origin("src/format.rs"), + ) + .snippet( + Snippet::source("Faa") + .line_start(129) + .origin("src/display.rs"), + ); + + let renderer = Renderer::styled(); + anstream::println!("{}", renderer.render(message)); +} diff --git a/crates/ruff_annotate_snippets/examples/multislice.svg b/crates/ruff_annotate_snippets/examples/multislice.svg new file mode 100644 index 0000000000000..216a359224444 --- /dev/null +++ b/crates/ruff_annotate_snippets/examples/multislice.svg @@ -0,0 +1,44 @@ +<svg width="740px" height="200px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/format.rs</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold"> 51 |</tspan><tspan> Foo</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">:::</tspan><tspan> src/display.rs</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan class="fg-bright-blue bold">129 |</tspan><tspan> Faa</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="190px"> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/src/lib.rs b/crates/ruff_annotate_snippets/src/lib.rs new file mode 100644 index 0000000000000..f8d0e1e5c6028 --- /dev/null +++ b/crates/ruff_annotate_snippets/src/lib.rs @@ -0,0 +1,69 @@ +//! A library for formatting of text or programming code snippets. +//! +//! It's primary purpose is to build an ASCII-graphical representation of the snippet +//! with annotations. +//! +//! # Example +//! +//! ```rust +#![doc = include_str!("../examples/expected_type.rs")] +//! ``` +//! +#![doc = include_str!("../examples/expected_type.svg")] +//! +//! The crate uses a three stage process with two conversions between states: +//! +//! ```text +//! Message --> Renderer --> impl Display +//! ``` +//! +//! The input type - [Message] is a structure designed +//! to align with likely output from any parser whose code snippet is to be +//! annotated. +//! +//! The middle structure - [Renderer] is a structure designed +//! to convert a snippet into an internal structure that is designed to store +//! the snippet data in a way that is easy to format. +//! [Renderer] also handles the user-configurable formatting +//! options, such as color, or margins. +//! +//! Finally, `impl Display` into a final `String` output. +//! +//! # features +//! - `testing-colors` - Makes [Renderer::styled] colors OS independent, which +//! allows for easier testing when testing colored output. It should be added as +//! a feature in `[dev-dependencies]`, which can be done with the following command: +//! ```text +//! cargo add annotate-snippets --dev --feature testing-colors +//! ``` + +#![cfg_attr(docsrs, feature(doc_auto_cfg))] +#![warn(clippy::print_stderr)] +#![warn(clippy::print_stdout)] +#![warn(missing_debug_implementations)] +// Since this is a vendored copy of `annotate-snippets`, we squash Clippy +// warnings from upstream in order to the reduce the diff. If our copy drifts +// far from upstream such that patches become impractical to apply in both +// places, then we can get rid of these suppressions and fix the lints. +#![allow( + clippy::return_self_not_must_use, + clippy::cast_possible_truncation, + clippy::cast_precision_loss, + clippy::explicit_iter_loop, + clippy::unused_self, + clippy::unnecessary_wraps, + clippy::range_plus_one, + clippy::redundant_closure_for_method_calls, + clippy::struct_field_names, + clippy::cloned_instead_of_copied, + clippy::cast_sign_loss, + clippy::needless_as_bytes, + clippy::unnecessary_map_or +)] + +pub mod renderer; +mod snippet; + +#[doc(inline)] +pub use renderer::Renderer; +pub use snippet::*; diff --git a/crates/ruff_annotate_snippets/src/renderer/display_list.rs b/crates/ruff_annotate_snippets/src/renderer/display_list.rs new file mode 100644 index 0000000000000..91e031b878736 --- /dev/null +++ b/crates/ruff_annotate_snippets/src/renderer/display_list.rs @@ -0,0 +1,1756 @@ +//! `display_list` module stores the output model for the snippet. +//! +//! `DisplayList` is a central structure in the crate, which contains +//! the structured list of lines to be displayed. +//! +//! It is made of two types of lines: `Source` and `Raw`. All `Source` lines +//! are structured using four columns: +//! +//! ```text +//! /------------ (1) Line number column. +//! | /--------- (2) Line number column delimiter. +//! | | /------- (3) Inline marks column. +//! | | | /--- (4) Content column with the source and annotations for slices. +//! | | | | +//! ============================================================================= +//! error[E0308]: mismatched types +//! --> src/format.rs:51:5 +//! | +//! 151 | / fn test() -> String { +//! 152 | | return "test"; +//! 153 | | } +//! | |___^ error: expected `String`, for `&str`. +//! | +//! ``` +//! +//! The first two lines of the example above are `Raw` lines, while the rest +//! are `Source` lines. +//! +//! `DisplayList` does not store column alignment information, and those are +//! only calculated by the implementation of `std::fmt::Display` using information such as +//! styling. +//! +//! The above snippet has been built out of the following structure: +use crate::snippet; +use std::cmp::{Reverse, max, min}; +use std::collections::HashMap; +use std::fmt::Display; +use std::ops::Range; +use std::{cmp, fmt}; + +use unicode_width::UnicodeWidthStr; + +use crate::renderer::styled_buffer::StyledBuffer; +use crate::renderer::{DEFAULT_TERM_WIDTH, Margin, Style, stylesheet::Stylesheet}; + +const ANONYMIZED_LINE_NUM: &str = "LL"; +const ERROR_TXT: &str = "error"; +const HELP_TXT: &str = "help"; +const INFO_TXT: &str = "info"; +const NOTE_TXT: &str = "note"; +const WARNING_TXT: &str = "warning"; + +/// List of lines to be displayed. +pub(crate) struct DisplayList<'a> { + pub(crate) body: Vec<DisplaySet<'a>>, + pub(crate) stylesheet: &'a Stylesheet, + pub(crate) anonymized_line_numbers: bool, + pub(crate) cut_indicator: &'static str, +} + +impl PartialEq for DisplayList<'_> { + fn eq(&self, other: &Self) -> bool { + self.body == other.body && self.anonymized_line_numbers == other.anonymized_line_numbers + } +} + +impl fmt::Debug for DisplayList<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("DisplayList") + .field("body", &self.body) + .field("anonymized_line_numbers", &self.anonymized_line_numbers) + .finish() + } +} + +impl Display for DisplayList<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let lineno_width = self.body.iter().fold(0, |max, set| { + set.display_lines.iter().fold(max, |max, line| match line { + DisplayLine::Source { lineno, .. } => cmp::max(lineno.unwrap_or(0), max), + _ => max, + }) + }); + let lineno_width = if lineno_width == 0 { + lineno_width + } else if self.anonymized_line_numbers { + ANONYMIZED_LINE_NUM.len() + } else { + ((lineno_width as f64).log10().floor() as usize) + 1 + }; + + let multiline_depth = self.body.iter().fold(0, |max, set| { + set.display_lines.iter().fold(max, |max2, line| match line { + DisplayLine::Source { annotations, .. } => cmp::max( + annotations.iter().fold(max2, |max3, line| { + cmp::max( + match line.annotation_part { + DisplayAnnotationPart::Standalone => 0, + DisplayAnnotationPart::LabelContinuation => 0, + DisplayAnnotationPart::MultilineStart(depth) => depth + 1, + DisplayAnnotationPart::MultilineEnd(depth) => depth + 1, + }, + max3, + ) + }), + max, + ), + _ => max2, + }) + }); + let mut buffer = StyledBuffer::new(); + for set in self.body.iter() { + self.format_set(set, lineno_width, multiline_depth, &mut buffer)?; + } + write!(f, "{}", buffer.render(self.stylesheet)?) + } +} + +impl<'a> DisplayList<'a> { + pub(crate) fn new( + message: snippet::Message<'a>, + stylesheet: &'a Stylesheet, + anonymized_line_numbers: bool, + term_width: usize, + cut_indicator: &'static str, + ) -> DisplayList<'a> { + let body = format_message( + message, + term_width, + anonymized_line_numbers, + cut_indicator, + true, + ); + + Self { + body, + stylesheet, + anonymized_line_numbers, + cut_indicator, + } + } + + fn format_set( + &self, + set: &DisplaySet<'_>, + lineno_width: usize, + multiline_depth: usize, + buffer: &mut StyledBuffer, + ) -> fmt::Result { + for line in &set.display_lines { + set.format_line( + line, + lineno_width, + multiline_depth, + self.stylesheet, + self.anonymized_line_numbers, + self.cut_indicator, + buffer, + )?; + } + Ok(()) + } +} + +#[derive(Debug, PartialEq)] +pub(crate) struct DisplaySet<'a> { + pub(crate) display_lines: Vec<DisplayLine<'a>>, + pub(crate) margin: Margin, +} + +impl DisplaySet<'_> { + fn format_label( + &self, + line_offset: usize, + label: &[DisplayTextFragment<'_>], + stylesheet: &Stylesheet, + buffer: &mut StyledBuffer, + ) -> fmt::Result { + for fragment in label { + let style = match fragment.style { + DisplayTextStyle::Regular => stylesheet.none(), + DisplayTextStyle::Emphasis => stylesheet.emphasis(), + }; + buffer.append(line_offset, fragment.content, *style); + } + Ok(()) + } + fn format_annotation( + &self, + line_offset: usize, + annotation: &Annotation<'_>, + continuation: bool, + stylesheet: &Stylesheet, + buffer: &mut StyledBuffer, + ) -> fmt::Result { + let color = get_annotation_style(&annotation.annotation_type, stylesheet); + let formatted_len = if let Some(id) = &annotation.id { + 2 + id.len() + annotation_type_len(&annotation.annotation_type) + } else { + annotation_type_len(&annotation.annotation_type) + }; + + if continuation { + for _ in 0..formatted_len + 2 { + buffer.append(line_offset, " ", Style::new()); + } + return self.format_label(line_offset, &annotation.label, stylesheet, buffer); + } + if formatted_len == 0 { + self.format_label(line_offset, &annotation.label, stylesheet, buffer) + } else { + let id = match &annotation.id { + Some(id) => format!("[{id}]"), + None => String::new(), + }; + buffer.append( + line_offset, + &format!("{}{}", annotation_type_str(&annotation.annotation_type), id), + *color, + ); + + if !is_annotation_empty(annotation) { + buffer.append(line_offset, ": ", stylesheet.none); + self.format_label(line_offset, &annotation.label, stylesheet, buffer)?; + } + Ok(()) + } + } + + #[inline] + fn format_raw_line( + &self, + line_offset: usize, + line: &DisplayRawLine<'_>, + lineno_width: usize, + stylesheet: &Stylesheet, + buffer: &mut StyledBuffer, + ) -> fmt::Result { + match line { + DisplayRawLine::Origin { + path, + pos, + header_type, + } => { + let header_sigil = match header_type { + DisplayHeaderType::Initial => "-->", + DisplayHeaderType::Continuation => ":::", + }; + let lineno_color = stylesheet.line_no(); + buffer.puts(line_offset, lineno_width, header_sigil, *lineno_color); + buffer.puts(line_offset, lineno_width + 4, path, stylesheet.none); + if let Some((col, row)) = pos { + buffer.append(line_offset, ":", stylesheet.none); + buffer.append(line_offset, col.to_string().as_str(), stylesheet.none); + buffer.append(line_offset, ":", stylesheet.none); + buffer.append(line_offset, row.to_string().as_str(), stylesheet.none); + } + Ok(()) + } + DisplayRawLine::Annotation { + annotation, + source_aligned, + continuation, + } => { + if *source_aligned { + if *continuation { + for _ in 0..lineno_width + 3 { + buffer.append(line_offset, " ", stylesheet.none); + } + } else { + let lineno_color = stylesheet.line_no(); + for _ in 0..lineno_width + 1 { + buffer.append(line_offset, " ", stylesheet.none); + } + buffer.append(line_offset, "=", *lineno_color); + buffer.append(line_offset, " ", *lineno_color); + } + } + self.format_annotation(line_offset, annotation, *continuation, stylesheet, buffer) + } + } + } + + // Adapted from https://github.com/rust-lang/rust/blob/d371d17496f2ce3a56da76aa083f4ef157572c20/compiler/rustc_errors/src/emitter.rs#L706-L1211 + #[allow(clippy::too_many_arguments)] + #[inline] + fn format_line( + &self, + dl: &DisplayLine<'_>, + lineno_width: usize, + multiline_depth: usize, + stylesheet: &Stylesheet, + anonymized_line_numbers: bool, + cut_indicator: &'static str, + buffer: &mut StyledBuffer, + ) -> fmt::Result { + let line_offset = buffer.num_lines(); + match dl { + DisplayLine::Source { + lineno, + inline_marks, + line, + annotations, + } => { + let lineno_color = stylesheet.line_no(); + if anonymized_line_numbers && lineno.is_some() { + let num = format!("{ANONYMIZED_LINE_NUM:>lineno_width$} |"); + buffer.puts(line_offset, 0, &num, *lineno_color); + } else { + match lineno { + Some(n) => { + let num = format!("{n:>lineno_width$} |"); + buffer.puts(line_offset, 0, &num, *lineno_color); + } + None => { + buffer.putc(line_offset, lineno_width + 1, '|', *lineno_color); + } + } + } + if let DisplaySourceLine::Content { text, .. } = line { + // The width of the line number, a space, pipe, and a space + // `123 | ` is `lineno_width + 3`. + let width_offset = lineno_width + 3; + let code_offset = if multiline_depth == 0 { + width_offset + } else { + width_offset + multiline_depth + 1 + }; + + // Add any inline marks to the code line + if !inline_marks.is_empty() || 0 < multiline_depth { + format_inline_marks( + line_offset, + inline_marks, + lineno_width, + stylesheet, + buffer, + )?; + } + + let text = normalize_whitespace(text); + let line_len = text.as_bytes().len(); + let left = self.margin.left(line_len); + let right = self.margin.right(line_len); + + // On long lines, we strip the source line, accounting for unicode. + let mut taken = 0; + let mut was_cut_right = false; + let mut code = String::new(); + for ch in text.chars().skip(left) { + // Make sure that the trimming on the right will fall within the terminal width. + // FIXME: `unicode_width` sometimes disagrees with terminals on how wide a `char` + // is. For now, just accept that sometimes the code line will be longer than + // desired. + let next = unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1); + if taken + next > right - left { + was_cut_right = true; + break; + } + taken += next; + code.push(ch); + } + buffer.puts(line_offset, code_offset, &code, Style::new()); + if self.margin.was_cut_left() { + // We have stripped some code/whitespace from the beginning, make it clear. + buffer.puts(line_offset, code_offset, cut_indicator, *lineno_color); + } + if was_cut_right { + buffer.puts( + line_offset, + code_offset + taken - cut_indicator.width(), + cut_indicator, + *lineno_color, + ); + } + + let left: usize = text + .chars() + .take(left) + .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1)) + .sum(); + + let mut annotations = annotations.clone(); + annotations.sort_by_key(|a| Reverse(a.range.0)); + + let mut annotations_positions = vec![]; + let mut line_len: usize = 0; + let mut p = 0; + for (i, annotation) in annotations.iter().enumerate() { + for (j, next) in annotations.iter().enumerate() { + // This label overlaps with another one and both take space ( + // they have text and are not multiline lines). + if overlaps(next, annotation, 0) + && annotation.has_label() + && j > i + && p == 0 + // We're currently on the first line, move the label one line down + { + // If we're overlapping with an un-labelled annotation with the same span + // we can just merge them in the output + if next.range.0 == annotation.range.0 + && next.range.1 == annotation.range.1 + && !next.has_label() + { + continue; + } + + // This annotation needs a new line in the output. + p += 1; + break; + } + } + annotations_positions.push((p, annotation)); + for (j, next) in annotations.iter().enumerate() { + if j > i { + let l = next + .annotation + .label + .iter() + .map(|label| label.content) + .collect::<Vec<_>>() + .join("") + .len() + + 2; + // Do not allow two labels to be in the same line if they + // overlap including padding, to avoid situations like: + // + // fn foo(x: u32) { + // -------^------ + // | | + // fn_spanx_span + // + // Both labels must have some text, otherwise they are not + // overlapping. Do not add a new line if this annotation or + // the next are vertical line placeholders. If either this + // or the next annotation is multiline start/end, move it + // to a new line so as not to overlap the horizontal lines. + if (overlaps(next, annotation, l) + && annotation.has_label() + && next.has_label()) + || (annotation.takes_space() && next.has_label()) + || (annotation.has_label() && next.takes_space()) + || (annotation.takes_space() && next.takes_space()) + || (overlaps(next, annotation, l) + && next.range.1 <= annotation.range.1 + && next.has_label() + && p == 0) + // Avoid #42595. + { + // This annotation needs a new line in the output. + p += 1; + break; + } + } + } + line_len = max(line_len, p); + } + + if line_len != 0 { + line_len += 1; + } + + if annotations_positions.iter().all(|(_, ann)| { + matches!( + ann.annotation_part, + DisplayAnnotationPart::MultilineStart(_) + ) + }) { + if let Some(max_pos) = + annotations_positions.iter().map(|(pos, _)| *pos).max() + { + // Special case the following, so that we minimize overlapping multiline spans. + // + // 3 │ X0 Y0 Z0 + // │ ┏━━━━━┛ │ │ < We are writing these lines + // │ ┃┌───────┘ │ < by reverting the "depth" of + // │ ┃│┌─────────┘ < their multiline spans. + // 4 │ ┃││ X1 Y1 Z1 + // 5 │ ┃││ X2 Y2 Z2 + // │ ┃│└────╿──│──┘ `Z` label + // │ ┃└─────│──┤ + // │ ┗━━━━━━┥ `Y` is a good letter too + // ╰╴ `X` is a good letter + for (pos, _) in &mut annotations_positions { + *pos = max_pos - *pos; + } + // We know then that we don't need an additional line for the span label, saving us + // one line of vertical space. + line_len = line_len.saturating_sub(1); + } + } + + // This is a special case where we have a multiline + // annotation that is at the start of the line disregarding + // any leading whitespace, and no other multiline + // annotations overlap it. In this case, we want to draw + // + // 2 | fn foo() { + // | _^ + // 3 | | + // 4 | | } + // | |_^ test + // + // we simplify the output to: + // + // 2 | / fn foo() { + // 3 | | + // 4 | | } + // | |_^ test + if multiline_depth == 1 + && annotations_positions.len() == 1 + && annotations_positions + .first() + .map_or(false, |(_, annotation)| { + matches!( + annotation.annotation_part, + DisplayAnnotationPart::MultilineStart(_) + ) && text + .chars() + .take(annotation.range.0) + .all(|c| c.is_whitespace()) + }) + { + let (_, ann) = annotations_positions.remove(0); + let style = get_annotation_style(&ann.annotation_type, stylesheet); + buffer.putc(line_offset, 3 + lineno_width, '/', *style); + } + + // Draw the column separator for any extra lines that were + // created + // + // After this we will have: + // + // 2 | fn foo() { + // | + // | + // | + // 3 | + // 4 | } + // | + if !annotations_positions.is_empty() { + for pos in 0..=line_len { + buffer.putc( + line_offset + pos + 1, + lineno_width + 1, + '|', + stylesheet.line_no, + ); + } + } + + // Write the horizontal lines for multiline annotations + // (only the first and last lines need this). + // + // After this we will have: + // + // 2 | fn foo() { + // | __________ + // | + // | + // 3 | + // 4 | } + // | _ + for &(pos, annotation) in &annotations_positions { + let style = get_annotation_style(&annotation.annotation_type, stylesheet); + let pos = pos + 1; + match annotation.annotation_part { + DisplayAnnotationPart::MultilineStart(depth) + | DisplayAnnotationPart::MultilineEnd(depth) => { + for col in width_offset + depth + ..(code_offset + annotation.range.0).saturating_sub(left) + { + buffer.putc(line_offset + pos, col + 1, '_', *style); + } + } + _ => {} + } + } + + // Write the vertical lines for labels that are on a different line as the underline. + // + // After this we will have: + // + // 2 | fn foo() { + // | __________ + // | | | + // | | + // 3 | | + // 4 | | } + // | |_ + for &(pos, annotation) in &annotations_positions { + let style = get_annotation_style(&annotation.annotation_type, stylesheet); + let pos = pos + 1; + if pos > 1 && (annotation.has_label() || annotation.takes_space()) { + for p in line_offset + 2..=line_offset + pos { + buffer.putc( + p, + (code_offset + annotation.range.0).saturating_sub(left), + '|', + *style, + ); + } + } + match annotation.annotation_part { + DisplayAnnotationPart::MultilineStart(depth) => { + for p in line_offset + pos + 1..line_offset + line_len + 2 { + buffer.putc(p, width_offset + depth, '|', *style); + } + } + DisplayAnnotationPart::MultilineEnd(depth) => { + for p in line_offset..=line_offset + pos { + buffer.putc(p, width_offset + depth, '|', *style); + } + } + _ => {} + } + } + + // Add in any inline marks for any extra lines that have + // been created. Output should look like above. + for inline_mark in inline_marks { + let DisplayMarkType::AnnotationThrough(depth) = inline_mark.mark_type; + let style = get_annotation_style(&inline_mark.annotation_type, stylesheet); + if annotations_positions.is_empty() { + buffer.putc(line_offset, width_offset + depth, '|', *style); + } else { + for p in line_offset..=line_offset + line_len + 1 { + buffer.putc(p, width_offset + depth, '|', *style); + } + } + } + + // Write the labels on the annotations that actually have a label. + // + // After this we will have: + // + // 2 | fn foo() { + // | __________ + // | | + // | something about `foo` + // 3 | + // 4 | } + // | _ test + for &(pos, annotation) in &annotations_positions { + if !is_annotation_empty(&annotation.annotation) { + let style = + get_annotation_style(&annotation.annotation_type, stylesheet); + let mut formatted_len = if let Some(id) = &annotation.annotation.id { + 2 + id.len() + + annotation_type_len(&annotation.annotation.annotation_type) + } else { + annotation_type_len(&annotation.annotation.annotation_type) + }; + let (pos, col) = if pos == 0 { + (pos + 1, (annotation.range.1 + 1).saturating_sub(left)) + } else { + (pos + 2, annotation.range.0.saturating_sub(left)) + }; + if annotation.annotation_part + == DisplayAnnotationPart::LabelContinuation + { + formatted_len = 0; + } else if formatted_len != 0 { + formatted_len += 2; + let id = match &annotation.annotation.id { + Some(id) => format!("[{id}]"), + None => String::new(), + }; + buffer.puts( + line_offset + pos, + col + code_offset, + &format!( + "{}{}: ", + annotation_type_str(&annotation.annotation_type), + id + ), + *style, + ); + } else { + formatted_len = 0; + } + let mut before = 0; + for fragment in &annotation.annotation.label { + let inner_col = before + formatted_len + col + code_offset; + buffer.puts(line_offset + pos, inner_col, fragment.content, *style); + before += fragment.content.len(); + } + } + } + + // Sort from biggest span to smallest span so that smaller spans are + // represented in the output: + // + // x | fn foo() + // | ^^^---^^ + // | | | + // | | something about `foo` + // | something about `fn foo()` + annotations_positions.sort_by_key(|(_, ann)| { + // Decreasing order. When annotations share the same length, prefer `Primary`. + Reverse(ann.len()) + }); + + // Write the underlines. + // + // After this we will have: + // + // 2 | fn foo() { + // | ____-_____^ + // | | + // | something about `foo` + // 3 | + // 4 | } + // | _^ test + for &(_, annotation) in &annotations_positions { + let mark = match annotation.annotation_type { + DisplayAnnotationType::Error => '^', + DisplayAnnotationType::Warning => '-', + DisplayAnnotationType::Info => '-', + DisplayAnnotationType::Note => '-', + DisplayAnnotationType::Help => '-', + DisplayAnnotationType::None => ' ', + }; + let style = get_annotation_style(&annotation.annotation_type, stylesheet); + for p in annotation.range.0..annotation.range.1 { + buffer.putc( + line_offset + 1, + (code_offset + p).saturating_sub(left), + mark, + *style, + ); + } + } + } else if !inline_marks.is_empty() { + format_inline_marks( + line_offset, + inline_marks, + lineno_width, + stylesheet, + buffer, + )?; + } + Ok(()) + } + DisplayLine::Fold { inline_marks } => { + buffer.puts(line_offset, 0, cut_indicator, *stylesheet.line_no()); + if !inline_marks.is_empty() || 0 < multiline_depth { + format_inline_marks( + line_offset, + inline_marks, + lineno_width, + stylesheet, + buffer, + )?; + } + Ok(()) + } + DisplayLine::Raw(line) => { + self.format_raw_line(line_offset, line, lineno_width, stylesheet, buffer) + } + } + } +} + +/// Inline annotation which can be used in either Raw or Source line. +#[derive(Clone, Debug, PartialEq)] +pub(crate) struct Annotation<'a> { + pub(crate) annotation_type: DisplayAnnotationType, + pub(crate) id: Option<&'a str>, + pub(crate) label: Vec<DisplayTextFragment<'a>>, +} + +/// A single line used in `DisplayList`. +#[derive(Debug, PartialEq)] +pub(crate) enum DisplayLine<'a> { + /// A line with `lineno` portion of the slice. + Source { + lineno: Option<usize>, + inline_marks: Vec<DisplayMark>, + line: DisplaySourceLine<'a>, + annotations: Vec<DisplaySourceAnnotation<'a>>, + }, + + /// A line indicating a folded part of the slice. + Fold { inline_marks: Vec<DisplayMark> }, + + /// A line which is displayed outside of slices. + Raw(DisplayRawLine<'a>), +} + +/// A source line. +#[derive(Debug, PartialEq)] +pub(crate) enum DisplaySourceLine<'a> { + /// A line with the content of the Snippet. + Content { + text: &'a str, + range: (usize, usize), // meta information for annotation placement. + end_line: EndLine, + }, + /// An empty source line. + Empty, +} + +#[derive(Clone, Debug, PartialEq)] +pub(crate) struct DisplaySourceAnnotation<'a> { + pub(crate) annotation: Annotation<'a>, + pub(crate) range: (usize, usize), + pub(crate) annotation_type: DisplayAnnotationType, + pub(crate) annotation_part: DisplayAnnotationPart, +} + +impl DisplaySourceAnnotation<'_> { + fn has_label(&self) -> bool { + !self + .annotation + .label + .iter() + .all(|label| label.content.is_empty()) + } + + // Length of this annotation as displayed in the stderr output + fn len(&self) -> usize { + // Account for usize underflows + if self.range.1 > self.range.0 { + self.range.1 - self.range.0 + } else { + self.range.0 - self.range.1 + } + } + + fn takes_space(&self) -> bool { + // Multiline annotations always have to keep vertical space. + matches!( + self.annotation_part, + DisplayAnnotationPart::MultilineStart(_) | DisplayAnnotationPart::MultilineEnd(_) + ) + } +} + +/// Raw line - a line which does not have the `lineno` part and is not considered +/// a part of the snippet. +#[derive(Debug, PartialEq)] +pub(crate) enum DisplayRawLine<'a> { + /// A line which provides information about the location of the given + /// slice in the project structure. + Origin { + path: &'a str, + pos: Option<(usize, usize)>, + header_type: DisplayHeaderType, + }, + + /// An annotation line which is not part of any snippet. + Annotation { + annotation: Annotation<'a>, + + /// If set to `true`, the annotation will be aligned to the + /// lineno delimiter of the snippet. + source_aligned: bool, + /// If set to `true`, only the label of the `Annotation` will be + /// displayed. It allows for a multiline annotation to be aligned + /// without displaying the meta information (`type` and `id`) to be + /// displayed on each line. + continuation: bool, + }, +} + +/// An inline text fragment which any label is composed of. +#[derive(Clone, Debug, PartialEq)] +pub(crate) struct DisplayTextFragment<'a> { + pub(crate) content: &'a str, + pub(crate) style: DisplayTextStyle, +} + +/// A style for the `DisplayTextFragment` which can be visually formatted. +/// +/// This information may be used to emphasis parts of the label. +#[derive(Debug, Clone, Copy, PartialEq)] +pub(crate) enum DisplayTextStyle { + Regular, + Emphasis, +} + +/// An indicator of what part of the annotation a given `Annotation` is. +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum DisplayAnnotationPart { + /// A standalone, single-line annotation. + Standalone, + /// A continuation of a multi-line label of an annotation. + LabelContinuation, + /// A line starting a multiline annotation. + MultilineStart(usize), + /// A line ending a multiline annotation. + MultilineEnd(usize), +} + +/// A visual mark used in `inline_marks` field of the `DisplaySourceLine`. +#[derive(Debug, Clone, PartialEq)] +pub(crate) struct DisplayMark { + pub(crate) mark_type: DisplayMarkType, + pub(crate) annotation_type: DisplayAnnotationType, +} + +/// A type of the `DisplayMark`. +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum DisplayMarkType { + /// A mark indicating a multiline annotation going through the current line. + AnnotationThrough(usize), +} + +/// A type of the `Annotation` which may impact the sigils, style or text displayed. +/// +/// There are several ways to uses this information when formatting the `DisplayList`: +/// +/// * An annotation may display the name of the type like `error` or `info`. +/// * An underline for `Error` may be `^^^` while for `Warning` it could be `---`. +/// * `ColorStylesheet` may use different colors for different annotations. +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum DisplayAnnotationType { + None, + Error, + Warning, + Info, + Note, + Help, +} + +impl From<snippet::Level> for DisplayAnnotationType { + fn from(at: snippet::Level) -> Self { + match at { + snippet::Level::None => DisplayAnnotationType::None, + snippet::Level::Error => DisplayAnnotationType::Error, + snippet::Level::Warning => DisplayAnnotationType::Warning, + snippet::Level::Info => DisplayAnnotationType::Info, + snippet::Level::Note => DisplayAnnotationType::Note, + snippet::Level::Help => DisplayAnnotationType::Help, + } + } +} + +/// Information whether the header is the initial one or a consecutive one +/// for multi-slice cases. +// TODO: private +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum DisplayHeaderType { + /// Initial header is the first header in the snippet. + Initial, + + /// Continuation marks all headers of following slices in the snippet. + Continuation, +} + +struct CursorLines<'a>(&'a str); + +impl CursorLines<'_> { + fn new(src: &str) -> CursorLines<'_> { + CursorLines(src) + } +} + +#[derive(Copy, Clone, Debug, PartialEq)] +pub(crate) enum EndLine { + Eof, + Lf, + Crlf, +} + +impl EndLine { + /// The number of characters this line ending occupies in bytes. + pub(crate) fn len(self) -> usize { + match self { + EndLine::Eof => 0, + EndLine::Lf => 1, + EndLine::Crlf => 2, + } + } +} + +impl<'a> Iterator for CursorLines<'a> { + type Item = (&'a str, EndLine); + + fn next(&mut self) -> Option<Self::Item> { + if self.0.is_empty() { + None + } else { + self.0 + .find('\n') + .map(|x| { + let ret = if 0 < x { + if self.0.as_bytes()[x - 1] == b'\r' { + (&self.0[..x - 1], EndLine::Crlf) + } else { + (&self.0[..x], EndLine::Lf) + } + } else { + ("", EndLine::Lf) + }; + self.0 = &self.0[x + 1..]; + ret + }) + .or_else(|| { + let ret = Some((self.0, EndLine::Eof)); + self.0 = ""; + ret + }) + } + } +} + +fn format_message<'m>( + message: snippet::Message<'m>, + term_width: usize, + anonymized_line_numbers: bool, + cut_indicator: &'static str, + primary: bool, +) -> Vec<DisplaySet<'m>> { + let snippet::Message { + level, + id, + title, + footer, + snippets, + } = message; + + let mut sets = vec![]; + let body = if !snippets.is_empty() || primary { + vec![format_title(level, id, title)] + } else { + format_footer(level, id, title) + }; + + for (idx, snippet) in snippets.into_iter().enumerate() { + let snippet = fold_prefix_suffix(snippet); + sets.push(format_snippet( + snippet, + idx == 0, + !footer.is_empty(), + term_width, + anonymized_line_numbers, + cut_indicator, + )); + } + + if let Some(first) = sets.first_mut() { + for line in body { + first.display_lines.insert(0, line); + } + } else { + sets.push(DisplaySet { + display_lines: body, + margin: Margin::new(0, 0, 0, 0, DEFAULT_TERM_WIDTH, 0), + }); + } + + for annotation in footer { + sets.extend(format_message( + annotation, + term_width, + anonymized_line_numbers, + cut_indicator, + false, + )); + } + + sets +} + +fn format_title<'a>(level: crate::Level, id: Option<&'a str>, label: &'a str) -> DisplayLine<'a> { + DisplayLine::Raw(DisplayRawLine::Annotation { + annotation: Annotation { + annotation_type: DisplayAnnotationType::from(level), + id, + label: format_label(Some(label), Some(DisplayTextStyle::Emphasis)), + }, + source_aligned: false, + continuation: false, + }) +} + +fn format_footer<'a>( + level: crate::Level, + id: Option<&'a str>, + label: &'a str, +) -> Vec<DisplayLine<'a>> { + let mut result = vec![]; + for (i, line) in label.lines().enumerate() { + result.push(DisplayLine::Raw(DisplayRawLine::Annotation { + annotation: Annotation { + annotation_type: DisplayAnnotationType::from(level), + id, + label: format_label(Some(line), None), + }, + source_aligned: true, + continuation: i != 0, + })); + } + result +} + +fn format_label( + label: Option<&str>, + style: Option<DisplayTextStyle>, +) -> Vec<DisplayTextFragment<'_>> { + let mut result = vec![]; + if let Some(label) = label { + let element_style = style.unwrap_or(DisplayTextStyle::Regular); + result.push(DisplayTextFragment { + content: label, + style: element_style, + }); + } + result +} + +fn format_snippet<'m>( + snippet: snippet::Snippet<'m>, + is_first: bool, + has_footer: bool, + term_width: usize, + anonymized_line_numbers: bool, + cut_indicator: &'static str, +) -> DisplaySet<'m> { + let main_range = snippet.annotations.first().map(|x| x.range.start); + let origin = snippet.origin; + let need_empty_header = origin.is_some() || is_first; + let mut body = format_body( + snippet, + need_empty_header, + has_footer, + term_width, + anonymized_line_numbers, + cut_indicator, + ); + let header = format_header(origin, main_range, &body.display_lines, is_first); + + if let Some(header) = header { + body.display_lines.insert(0, header); + } + + body +} + +#[inline] +// TODO: option_zip +fn zip_opt<A, B>(a: Option<A>, b: Option<B>) -> Option<(A, B)> { + a.and_then(|a| b.map(|b| (a, b))) +} + +fn format_header<'a>( + origin: Option<&'a str>, + main_range: Option<usize>, + body: &[DisplayLine<'_>], + is_first: bool, +) -> Option<DisplayLine<'a>> { + let display_header = if is_first { + DisplayHeaderType::Initial + } else { + DisplayHeaderType::Continuation + }; + + if let Some((main_range, path)) = zip_opt(main_range, origin) { + let mut col = 1; + let mut line_offset = 1; + + for item in body { + if let DisplayLine::Source { + line: + DisplaySourceLine::Content { + text, + range, + end_line, + }, + lineno, + .. + } = item + { + if main_range >= range.0 && main_range < range.1 + max(*end_line as usize, 1) { + let char_column = text[0..(main_range - range.0).min(text.len())] + .chars() + .count(); + col = char_column + 1; + line_offset = lineno.unwrap_or(1); + break; + } + } + } + + return Some(DisplayLine::Raw(DisplayRawLine::Origin { + path, + pos: Some((line_offset, col)), + header_type: display_header, + })); + } + + if let Some(path) = origin { + return Some(DisplayLine::Raw(DisplayRawLine::Origin { + path, + pos: None, + header_type: display_header, + })); + } + + None +} + +fn fold_prefix_suffix(mut snippet: snippet::Snippet<'_>) -> snippet::Snippet<'_> { + if !snippet.fold { + return snippet; + } + + let ann_start = snippet + .annotations + .iter() + .map(|ann| ann.range.start) + .min() + .unwrap_or(0); + if let Some(before_new_start) = snippet.source[0..ann_start].rfind('\n') { + let new_start = before_new_start + 1; + + let line_offset = newline_count(&snippet.source[..new_start]); + snippet.line_start += line_offset; + + snippet.source = &snippet.source[new_start..]; + + for ann in &mut snippet.annotations { + let range_start = ann.range.start - new_start; + let range_end = ann.range.end - new_start; + ann.range = range_start..range_end; + } + } + + let ann_end = snippet + .annotations + .iter() + .map(|ann| ann.range.end) + .max() + .unwrap_or(snippet.source.len()); + if let Some(end_offset) = snippet.source[ann_end..].find('\n') { + let new_end = ann_end + end_offset; + snippet.source = &snippet.source[..new_end]; + } + + snippet +} + +fn newline_count(body: &str) -> usize { + memchr::memchr_iter(b'\n', body.as_bytes()).count() +} + +fn fold_body(body: Vec<DisplayLine<'_>>) -> Vec<DisplayLine<'_>> { + const INNER_CONTEXT: usize = 1; + const INNER_UNFOLD_SIZE: usize = INNER_CONTEXT * 2 + 1; + + let mut lines = vec![]; + let mut unhighlighted_lines = vec![]; + for line in body { + match &line { + DisplayLine::Source { annotations, .. } => { + if annotations.is_empty() { + unhighlighted_lines.push(line); + } else { + if lines.is_empty() { + // Ignore leading unhighlighted lines + unhighlighted_lines.clear(); + } + match unhighlighted_lines.len() { + 0 => {} + n if n <= INNER_UNFOLD_SIZE => { + // Rather than render our cut indicator, don't fold + lines.append(&mut unhighlighted_lines); + } + _ => { + lines.extend(unhighlighted_lines.drain(..INNER_CONTEXT)); + let inline_marks = lines + .last() + .and_then(|line| { + if let DisplayLine::Source { inline_marks, .. } = line { + let inline_marks = inline_marks.clone(); + Some(inline_marks) + } else { + None + } + }) + .unwrap_or_default(); + lines.push(DisplayLine::Fold { + inline_marks: inline_marks.clone(), + }); + unhighlighted_lines + .drain(..unhighlighted_lines.len().saturating_sub(INNER_CONTEXT)); + lines.append(&mut unhighlighted_lines); + } + } + lines.push(line); + } + } + _ => { + unhighlighted_lines.push(line); + } + } + } + + lines +} + +fn format_body<'m>( + snippet: snippet::Snippet<'m>, + need_empty_header: bool, + has_footer: bool, + term_width: usize, + anonymized_line_numbers: bool, + cut_indicator: &'static str, +) -> DisplaySet<'m> { + let source_len = snippet.source.len(); + if let Some(bigger) = snippet.annotations.iter().find_map(|x| { + // Allow highlighting one past the last character in the source. + if source_len + 1 < x.range.end { + Some(&x.range) + } else { + None + } + }) { + panic!("SourceAnnotation range `{bigger:?}` is beyond the end of buffer `{source_len}`") + } + + let mut body = vec![]; + let mut current_line = snippet.line_start; + let mut current_index = 0; + + let mut whitespace_margin = usize::MAX; + let mut span_left_margin = usize::MAX; + let mut span_right_margin = 0; + let mut label_right_margin = 0; + let mut max_line_len = 0; + + let mut depth_map: HashMap<usize, usize> = HashMap::new(); + let mut current_depth = 0; + let mut annotations = snippet.annotations; + let ranges = annotations + .iter() + .map(|a| a.range.clone()) + .collect::<Vec<_>>(); + // We want to merge multiline annotations that have the same range into one + // multiline annotation to save space. This is done by making any duplicate + // multiline annotations into a single-line annotation pointing at the end + // of the range. + // + // 3 | X0 Y0 Z0 + // | _____^ + // | | ____| + // | || ___| + // | ||| + // 4 | ||| X1 Y1 Z1 + // 5 | ||| X2 Y2 Z2 + // | ||| ^ + // | |||____| + // | ||____`X` is a good letter + // | |____`Y` is a good letter too + // | `Z` label + // Should be + // error: foo + // --> test.rs:3:3 + // | + // 3 | / X0 Y0 Z0 + // 4 | | X1 Y1 Z1 + // 5 | | X2 Y2 Z2 + // | | ^ + // | |____| + // | `X` is a good letter + // | `Y` is a good letter too + // | `Z` label + // | + ranges.iter().enumerate().for_each(|(r_idx, range)| { + annotations + .iter_mut() + .enumerate() + .skip(r_idx + 1) + .for_each(|(ann_idx, ann)| { + // Skip if the annotation's index matches the range index + if ann_idx != r_idx + // We only want to merge multiline annotations + && snippet.source[ann.range.clone()].lines().count() > 1 + // We only want to merge annotations that have the same range + && ann.range.start == range.start + && ann.range.end == range.end + { + ann.range.start = ann.range.end.saturating_sub(1); + } + }); + }); + annotations.sort_by_key(|a| a.range.start); + let mut annotations = annotations.into_iter().enumerate().collect::<Vec<_>>(); + + for (idx, (line, end_line)) in CursorLines::new(snippet.source).enumerate() { + let line_length: usize = line.len(); + let line_range = (current_index, current_index + line_length); + let end_line_size = end_line.len(); + body.push(DisplayLine::Source { + lineno: Some(current_line), + inline_marks: vec![], + line: DisplaySourceLine::Content { + text: line, + range: line_range, + end_line, + }, + annotations: vec![], + }); + + let leading_whitespace = line + .chars() + .take_while(|c| c.is_whitespace()) + .map(|c| { + match c { + // Tabs are displayed as 4 spaces + '\t' => 4, + _ => 1, + } + }) + .sum(); + whitespace_margin = min(whitespace_margin, leading_whitespace); + max_line_len = max(max_line_len, line_length); + + let line_start_index = line_range.0; + let line_end_index = line_range.1; + current_line += 1; + current_index += line_length + end_line_size; + + // It would be nice to use filter_drain here once it's stable. + annotations.retain(|(key, annotation)| { + let body_idx = idx; + let annotation_type = match annotation.level { + snippet::Level::Error => DisplayAnnotationType::None, + snippet::Level::Warning => DisplayAnnotationType::None, + _ => DisplayAnnotationType::from(annotation.level), + }; + let label_right = annotation.label.map_or(0, |label| label.len() + 1); + match annotation.range { + // This handles if the annotation is on the next line. We add + // the `end_line_size` to account for annotating the line end. + Range { start, .. } if start > line_end_index + end_line_size => true, + // This handles the case where an annotation is contained + // within the current line including any line-end characters. + Range { start, end } + if start >= line_start_index + // We add at least one to `line_end_index` to allow + // highlighting the end of a file + && end <= line_end_index + max(end_line_size, 1) => + { + if let DisplayLine::Source { + ref mut annotations, + .. + } = body[body_idx] + { + let annotation_start_col = line + [0..(start - line_start_index).min(line_length)] + .chars() + .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0)) + .sum::<usize>(); + let mut annotation_end_col = line + [0..(end - line_start_index).min(line_length)] + .chars() + .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0)) + .sum::<usize>(); + if annotation_start_col == annotation_end_col { + // At least highlight something + annotation_end_col += 1; + } + + span_left_margin = min(span_left_margin, annotation_start_col); + span_right_margin = max(span_right_margin, annotation_end_col); + label_right_margin = + max(label_right_margin, annotation_end_col + label_right); + + let range = (annotation_start_col, annotation_end_col); + annotations.push(DisplaySourceAnnotation { + annotation: Annotation { + annotation_type, + id: None, + label: format_label(annotation.label, None), + }, + range, + annotation_type: DisplayAnnotationType::from(annotation.level), + annotation_part: DisplayAnnotationPart::Standalone, + }); + } + false + } + // This handles the case where a multiline annotation starts + // somewhere on the current line, including any line-end chars + Range { start, end } + if start >= line_start_index + // The annotation can start on a line ending + && start <= line_end_index + end_line_size.saturating_sub(1) + && end > line_end_index => + { + if let DisplayLine::Source { + ref mut annotations, + .. + } = body[body_idx] + { + let annotation_start_col = line + [0..(start - line_start_index).min(line_length)] + .chars() + .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0)) + .sum::<usize>(); + let annotation_end_col = annotation_start_col + 1; + + span_left_margin = min(span_left_margin, annotation_start_col); + span_right_margin = max(span_right_margin, annotation_end_col); + label_right_margin = + max(label_right_margin, annotation_end_col + label_right); + + let range = (annotation_start_col, annotation_end_col); + annotations.push(DisplaySourceAnnotation { + annotation: Annotation { + annotation_type, + id: None, + label: vec![], + }, + range, + annotation_type: DisplayAnnotationType::from(annotation.level), + annotation_part: DisplayAnnotationPart::MultilineStart(current_depth), + }); + depth_map.insert(*key, current_depth); + current_depth += 1; + } + true + } + // This handles the case where a multiline annotation starts + // somewhere before this line and ends after it as well + Range { start, end } + if start < line_start_index && end > line_end_index + max(end_line_size, 1) => + { + if let DisplayLine::Source { + ref mut inline_marks, + .. + } = body[body_idx] + { + let depth = depth_map.get(key).cloned().unwrap_or_default(); + inline_marks.push(DisplayMark { + mark_type: DisplayMarkType::AnnotationThrough(depth), + annotation_type: DisplayAnnotationType::from(annotation.level), + }); + } + true + } + // This handles the case where a multiline annotation ends + // somewhere on the current line, including any line-end chars + Range { start, end } + if start < line_start_index + && end >= line_start_index + // We add at least one to `line_end_index` to allow + // highlighting the end of a file + && end <= line_end_index + max(end_line_size, 1) => + { + if let DisplayLine::Source { + ref mut annotations, + .. + } = body[body_idx] + { + let end_mark = line[0..(end - line_start_index).min(line_length)] + .chars() + .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0)) + .sum::<usize>() + .saturating_sub(1); + // If the annotation ends on a line-end character, we + // need to annotate one past the end of the line + let (end_mark, end_plus_one) = if end > line_end_index + // Special case for highlighting the end of a file + || (end == line_end_index + 1 && end_line_size == 0) + { + (end_mark + 1, end_mark + 2) + } else { + (end_mark, end_mark + 1) + }; + + span_left_margin = min(span_left_margin, end_mark); + span_right_margin = max(span_right_margin, end_plus_one); + label_right_margin = max(label_right_margin, end_plus_one + label_right); + + let range = (end_mark, end_plus_one); + let depth = depth_map.remove(key).unwrap_or(0); + annotations.push(DisplaySourceAnnotation { + annotation: Annotation { + annotation_type, + id: None, + label: format_label(annotation.label, None), + }, + range, + annotation_type: DisplayAnnotationType::from(annotation.level), + annotation_part: DisplayAnnotationPart::MultilineEnd(depth), + }); + } + false + } + _ => true, + } + }); + // Reset the depth counter, but only after we've processed all + // annotations for a given line. + let max = depth_map.len(); + if current_depth > max { + current_depth = max; + } + } + + if snippet.fold { + body = fold_body(body); + } + + if need_empty_header { + body.insert( + 0, + DisplayLine::Source { + lineno: None, + inline_marks: vec![], + line: DisplaySourceLine::Empty, + annotations: vec![], + }, + ); + } + + if has_footer { + body.push(DisplayLine::Source { + lineno: None, + inline_marks: vec![], + line: DisplaySourceLine::Empty, + annotations: vec![], + }); + } else if let Some(DisplayLine::Source { .. }) = body.last() { + body.push(DisplayLine::Source { + lineno: None, + inline_marks: vec![], + line: DisplaySourceLine::Empty, + annotations: vec![], + }); + } + let max_line_num_len = if anonymized_line_numbers { + ANONYMIZED_LINE_NUM.len() + } else { + current_line.to_string().len() + }; + + let width_offset = cut_indicator.len() + max_line_num_len; + + if span_left_margin == usize::MAX { + span_left_margin = 0; + } + + let margin = Margin::new( + whitespace_margin, + span_left_margin, + span_right_margin, + label_right_margin, + term_width.saturating_sub(width_offset), + max_line_len, + ); + + DisplaySet { + display_lines: body, + margin, + } +} + +#[inline] +fn annotation_type_str(annotation_type: &DisplayAnnotationType) -> &'static str { + match annotation_type { + DisplayAnnotationType::Error => ERROR_TXT, + DisplayAnnotationType::Help => HELP_TXT, + DisplayAnnotationType::Info => INFO_TXT, + DisplayAnnotationType::Note => NOTE_TXT, + DisplayAnnotationType::Warning => WARNING_TXT, + DisplayAnnotationType::None => "", + } +} + +fn annotation_type_len(annotation_type: &DisplayAnnotationType) -> usize { + match annotation_type { + DisplayAnnotationType::Error => ERROR_TXT.len(), + DisplayAnnotationType::Help => HELP_TXT.len(), + DisplayAnnotationType::Info => INFO_TXT.len(), + DisplayAnnotationType::Note => NOTE_TXT.len(), + DisplayAnnotationType::Warning => WARNING_TXT.len(), + DisplayAnnotationType::None => 0, + } +} + +fn get_annotation_style<'a>( + annotation_type: &DisplayAnnotationType, + stylesheet: &'a Stylesheet, +) -> &'a Style { + match annotation_type { + DisplayAnnotationType::Error => stylesheet.error(), + DisplayAnnotationType::Warning => stylesheet.warning(), + DisplayAnnotationType::Info => stylesheet.info(), + DisplayAnnotationType::Note => stylesheet.note(), + DisplayAnnotationType::Help => stylesheet.help(), + DisplayAnnotationType::None => stylesheet.none(), + } +} + +#[inline] +fn is_annotation_empty(annotation: &Annotation<'_>) -> bool { + annotation + .label + .iter() + .all(|fragment| fragment.content.is_empty()) +} + +// We replace some characters so the CLI output is always consistent and underlines aligned. +const OUTPUT_REPLACEMENTS: &[(char, &str)] = &[ + ('\t', " "), // We do our own tab replacement + ('\u{200D}', ""), // Replace ZWJ with nothing for consistent terminal output of grapheme clusters. + ('\u{202A}', ""), // The following unicode text flow control characters are inconsistently + ('\u{202B}', ""), // supported across CLIs and can cause confusion due to the bytes on disk + ('\u{202D}', ""), // not corresponding to the visible source code, so we replace them always. + ('\u{202E}', ""), + ('\u{2066}', ""), + ('\u{2067}', ""), + ('\u{2068}', ""), + ('\u{202C}', ""), + ('\u{2069}', ""), +]; + +fn normalize_whitespace(str: &str) -> String { + let mut s = str.to_owned(); + for (c, replacement) in OUTPUT_REPLACEMENTS { + s = s.replace(*c, replacement); + } + s +} + +fn overlaps( + a1: &DisplaySourceAnnotation<'_>, + a2: &DisplaySourceAnnotation<'_>, + padding: usize, +) -> bool { + (a2.range.0..a2.range.1).contains(&a1.range.0) + || (a1.range.0..a1.range.1 + padding).contains(&a2.range.0) +} + +fn format_inline_marks( + line: usize, + inline_marks: &[DisplayMark], + lineno_width: usize, + stylesheet: &Stylesheet, + buf: &mut StyledBuffer, +) -> fmt::Result { + for mark in inline_marks.iter() { + let annotation_style = get_annotation_style(&mark.annotation_type, stylesheet); + match mark.mark_type { + DisplayMarkType::AnnotationThrough(depth) => { + buf.putc(line, 3 + lineno_width + depth, '|', *annotation_style); + } + } + } + Ok(()) +} diff --git a/crates/ruff_annotate_snippets/src/renderer/margin.rs b/crates/ruff_annotate_snippets/src/renderer/margin.rs new file mode 100644 index 0000000000000..59bd550745dcc --- /dev/null +++ b/crates/ruff_annotate_snippets/src/renderer/margin.rs @@ -0,0 +1,107 @@ +use std::cmp::{max, min}; + +const ELLIPSIS_PASSING: usize = 6; +const LONG_WHITESPACE: usize = 20; +const LONG_WHITESPACE_PADDING: usize = 4; + +#[derive(Clone, Copy, Debug, PartialEq)] +pub(crate) struct Margin { + /// The available whitespace in the left that can be consumed when centering. + whitespace_left: usize, + /// The column of the beginning of left-most span. + span_left: usize, + /// The column of the end of right-most span. + span_right: usize, + /// The beginning of the line to be displayed. + computed_left: usize, + /// The end of the line to be displayed. + computed_right: usize, + /// The current width of the terminal. 140 by default and in tests. + term_width: usize, + /// The end column of a span label, including the span. Doesn't account for labels not in the + /// same line as the span. + label_right: usize, +} + +impl Margin { + pub(crate) fn new( + whitespace_left: usize, + span_left: usize, + span_right: usize, + label_right: usize, + term_width: usize, + max_line_len: usize, + ) -> Self { + // The 6 is padding to give a bit of room for `...` when displaying: + // ``` + // error: message + // --> file.rs:16:58 + // | + // 16 | ... fn foo(self) -> Self::Bar { + // | ^^^^^^^^^ + // ``` + + let mut m = Margin { + whitespace_left: whitespace_left.saturating_sub(ELLIPSIS_PASSING), + span_left: span_left.saturating_sub(ELLIPSIS_PASSING), + span_right: span_right + ELLIPSIS_PASSING, + computed_left: 0, + computed_right: 0, + term_width, + label_right: label_right + ELLIPSIS_PASSING, + }; + m.compute(max_line_len); + m + } + + pub(crate) fn was_cut_left(&self) -> bool { + self.computed_left > 0 + } + + fn compute(&mut self, max_line_len: usize) { + // When there's a lot of whitespace (>20), we want to trim it as it is useless. + self.computed_left = if self.whitespace_left > LONG_WHITESPACE { + self.whitespace_left - (LONG_WHITESPACE - LONG_WHITESPACE_PADDING) // We want some padding. + } else { + 0 + }; + // We want to show as much as possible, max_line_len is the right-most boundary for the + // relevant code. + self.computed_right = max(max_line_len, self.computed_left); + + if self.computed_right - self.computed_left > self.term_width { + // Trimming only whitespace isn't enough, let's get craftier. + if self.label_right - self.whitespace_left <= self.term_width { + // Attempt to fit the code window only trimming whitespace. + self.computed_left = self.whitespace_left; + self.computed_right = self.computed_left + self.term_width; + } else if self.label_right - self.span_left <= self.term_width { + // Attempt to fit the code window considering only the spans and labels. + let padding_left = (self.term_width - (self.label_right - self.span_left)) / 2; + self.computed_left = self.span_left.saturating_sub(padding_left); + self.computed_right = self.computed_left + self.term_width; + } else if self.span_right - self.span_left <= self.term_width { + // Attempt to fit the code window considering the spans and labels plus padding. + let padding_left = (self.term_width - (self.span_right - self.span_left)) / 5 * 2; + self.computed_left = self.span_left.saturating_sub(padding_left); + self.computed_right = self.computed_left + self.term_width; + } else { + // Mostly give up but still don't show the full line. + self.computed_left = self.span_left; + self.computed_right = self.span_right; + } + } + } + + pub(crate) fn left(&self, line_len: usize) -> usize { + min(self.computed_left, line_len) + } + + pub(crate) fn right(&self, line_len: usize) -> usize { + if line_len.saturating_sub(self.computed_left) <= self.term_width { + line_len + } else { + min(line_len, self.computed_right) + } + } +} diff --git a/crates/ruff_annotate_snippets/src/renderer/mod.rs b/crates/ruff_annotate_snippets/src/renderer/mod.rs new file mode 100644 index 0000000000000..0ea77b98c3a4f --- /dev/null +++ b/crates/ruff_annotate_snippets/src/renderer/mod.rs @@ -0,0 +1,175 @@ +//! The renderer for [`Message`]s +//! +//! # Example +//! ``` +//! use ruff_annotate_snippets::{Renderer, Snippet, Level}; +//! let snippet = Level::Error.title("mismatched types") +//! .snippet(Snippet::source("Foo").line_start(51).origin("src/format.rs")) +//! .snippet(Snippet::source("Faa").line_start(129).origin("src/display.rs")); +//! +//! let renderer = Renderer::styled(); +//! println!("{}", renderer.render(snippet)); +//! ``` + +mod display_list; +mod margin; +mod styled_buffer; +pub(crate) mod stylesheet; + +use crate::snippet::Message; +pub use anstyle::*; +use display_list::DisplayList; +use margin::Margin; +use std::fmt::Display; +use stylesheet::Stylesheet; + +pub const DEFAULT_TERM_WIDTH: usize = 140; + +/// A renderer for [`Message`]s +#[derive(Clone, Debug)] +pub struct Renderer { + anonymized_line_numbers: bool, + term_width: usize, + stylesheet: Stylesheet, + cut_indicator: &'static str, +} + +impl Renderer { + /// No terminal styling + pub const fn plain() -> Self { + Self { + anonymized_line_numbers: false, + term_width: DEFAULT_TERM_WIDTH, + stylesheet: Stylesheet::plain(), + cut_indicator: "...", + } + } + + /// Default terminal styling + /// + /// # Note + /// When testing styled terminal output, see the [`testing-colors` feature](crate#features) + pub const fn styled() -> Self { + const USE_WINDOWS_COLORS: bool = cfg!(windows) && !cfg!(feature = "testing-colors"); + const BRIGHT_BLUE: Style = if USE_WINDOWS_COLORS { + AnsiColor::BrightCyan.on_default() + } else { + AnsiColor::BrightBlue.on_default() + }; + Self { + stylesheet: Stylesheet { + error: AnsiColor::BrightRed.on_default().effects(Effects::BOLD), + warning: if USE_WINDOWS_COLORS { + AnsiColor::BrightYellow.on_default() + } else { + AnsiColor::Yellow.on_default() + } + .effects(Effects::BOLD), + info: BRIGHT_BLUE.effects(Effects::BOLD), + note: AnsiColor::BrightGreen.on_default().effects(Effects::BOLD), + help: AnsiColor::BrightCyan.on_default().effects(Effects::BOLD), + line_no: BRIGHT_BLUE.effects(Effects::BOLD), + emphasis: if USE_WINDOWS_COLORS { + AnsiColor::BrightWhite.on_default() + } else { + Style::new() + } + .effects(Effects::BOLD), + none: Style::new(), + }, + ..Self::plain() + } + } + + /// Anonymize line numbers + /// + /// This enables (or disables) line number anonymization. When enabled, line numbers are replaced + /// with `LL`. + /// + /// # Example + /// + /// ```text + /// --> $DIR/whitespace-trimming.rs:4:193 + /// | + /// LL | ... let _: () = 42; + /// | ^^ expected (), found integer + /// | + /// ``` + pub const fn anonymized_line_numbers(mut self, anonymized_line_numbers: bool) -> Self { + self.anonymized_line_numbers = anonymized_line_numbers; + self + } + + /// Set the terminal width + pub const fn term_width(mut self, term_width: usize) -> Self { + self.term_width = term_width; + self + } + + /// Set the output style for `error` + pub const fn error(mut self, style: Style) -> Self { + self.stylesheet.error = style; + self + } + + /// Set the output style for `warning` + pub const fn warning(mut self, style: Style) -> Self { + self.stylesheet.warning = style; + self + } + + /// Set the output style for `info` + pub const fn info(mut self, style: Style) -> Self { + self.stylesheet.info = style; + self + } + + /// Set the output style for `note` + pub const fn note(mut self, style: Style) -> Self { + self.stylesheet.note = style; + self + } + + /// Set the output style for `help` + pub const fn help(mut self, style: Style) -> Self { + self.stylesheet.help = style; + self + } + + /// Set the output style for line numbers + pub const fn line_no(mut self, style: Style) -> Self { + self.stylesheet.line_no = style; + self + } + + /// Set the output style for emphasis + pub const fn emphasis(mut self, style: Style) -> Self { + self.stylesheet.emphasis = style; + self + } + + /// Set the output style for none + pub const fn none(mut self, style: Style) -> Self { + self.stylesheet.none = style; + self + } + + /// Set the string used for when a long line is cut. + /// + /// The default is `...` (three `U+002E` characters). + pub const fn cut_indicator(mut self, string: &'static str) -> Self { + self.cut_indicator = string; + self + } + + /// Render a snippet into a `Display`able object + pub fn render<'a>(&'a self, msg: Message<'a>) -> impl Display + 'a { + DisplayList::new( + msg, + &self.stylesheet, + self.anonymized_line_numbers, + self.term_width, + self.cut_indicator, + ) + } +} diff --git a/crates/ruff_annotate_snippets/src/renderer/styled_buffer.rs b/crates/ruff_annotate_snippets/src/renderer/styled_buffer.rs new file mode 100644 index 0000000000000..ec834e1bce915 --- /dev/null +++ b/crates/ruff_annotate_snippets/src/renderer/styled_buffer.rs @@ -0,0 +1,97 @@ +//! Adapted from [styled_buffer] +//! +//! [styled_buffer]: https://github.com/rust-lang/rust/blob/894f7a4ba6554d3797404bbf550d9919df060b97/compiler/rustc_errors/src/styled_buffer.rs + +use crate::renderer::stylesheet::Stylesheet; +use anstyle::Style; +use std::fmt; +use std::fmt::Write; + +#[derive(Debug)] +pub(crate) struct StyledBuffer { + lines: Vec<Vec<StyledChar>>, +} + +#[derive(Clone, Copy, Debug, PartialEq)] +pub(crate) struct StyledChar { + ch: char, + style: Style, +} + +impl StyledChar { + pub(crate) const SPACE: Self = StyledChar::new(' ', Style::new()); + + pub(crate) const fn new(ch: char, style: Style) -> StyledChar { + StyledChar { ch, style } + } +} + +impl StyledBuffer { + pub(crate) fn new() -> StyledBuffer { + StyledBuffer { lines: vec![] } + } + + fn ensure_lines(&mut self, line: usize) { + if line >= self.lines.len() { + self.lines.resize(line + 1, Vec::new()); + } + } + + pub(crate) fn render(&self, stylesheet: &Stylesheet) -> Result<String, fmt::Error> { + let mut str = String::new(); + for (i, line) in self.lines.iter().enumerate() { + let mut current_style = stylesheet.none; + for ch in line { + if ch.style != current_style { + if !line.is_empty() { + write!(str, "{}", current_style.render_reset())?; + } + current_style = ch.style; + write!(str, "{}", current_style.render())?; + } + write!(str, "{}", ch.ch)?; + } + write!(str, "{}", current_style.render_reset())?; + if i != self.lines.len() - 1 { + writeln!(str)?; + } + } + Ok(str) + } + + /// Sets `chr` with `style` for given `line`, `col`. + /// If `line` does not exist in our buffer, adds empty lines up to the given + /// and fills the last line with unstyled whitespace. + pub(crate) fn putc(&mut self, line: usize, col: usize, chr: char, style: Style) { + self.ensure_lines(line); + if col >= self.lines[line].len() { + self.lines[line].resize(col + 1, StyledChar::SPACE); + } + self.lines[line][col] = StyledChar::new(chr, style); + } + + /// Sets `string` with `style` for given `line`, starting from `col`. + /// If `line` does not exist in our buffer, adds empty lines up to the given + /// and fills the last line with unstyled whitespace. + pub(crate) fn puts(&mut self, line: usize, col: usize, string: &str, style: Style) { + let mut n = col; + for c in string.chars() { + self.putc(line, n, c, style); + n += 1; + } + } + /// For given `line` inserts `string` with `style` after old content of that line, + /// adding lines if needed + pub(crate) fn append(&mut self, line: usize, string: &str, style: Style) { + if line >= self.lines.len() { + self.puts(line, 0, string, style); + } else { + let col = self.lines[line].len(); + self.puts(line, col, string, style); + } + } + + pub(crate) fn num_lines(&self) -> usize { + self.lines.len() + } +} diff --git a/crates/ruff_annotate_snippets/src/renderer/stylesheet.rs b/crates/ruff_annotate_snippets/src/renderer/stylesheet.rs new file mode 100644 index 0000000000000..ee1ab93764c4c --- /dev/null +++ b/crates/ruff_annotate_snippets/src/renderer/stylesheet.rs @@ -0,0 +1,68 @@ +use anstyle::Style; + +#[derive(Clone, Copy, Debug)] +pub(crate) struct Stylesheet { + pub(crate) error: Style, + pub(crate) warning: Style, + pub(crate) info: Style, + pub(crate) note: Style, + pub(crate) help: Style, + pub(crate) line_no: Style, + pub(crate) emphasis: Style, + pub(crate) none: Style, +} + +impl Default for Stylesheet { + fn default() -> Self { + Self::plain() + } +} + +impl Stylesheet { + pub(crate) const fn plain() -> Self { + Self { + error: Style::new(), + warning: Style::new(), + info: Style::new(), + note: Style::new(), + help: Style::new(), + line_no: Style::new(), + emphasis: Style::new(), + none: Style::new(), + } + } +} + +impl Stylesheet { + pub(crate) fn error(&self) -> &Style { + &self.error + } + + pub(crate) fn warning(&self) -> &Style { + &self.warning + } + + pub(crate) fn info(&self) -> &Style { + &self.info + } + + pub(crate) fn note(&self) -> &Style { + &self.note + } + + pub(crate) fn help(&self) -> &Style { + &self.help + } + + pub(crate) fn line_no(&self) -> &Style { + &self.line_no + } + + pub(crate) fn emphasis(&self) -> &Style { + &self.emphasis + } + + pub(crate) fn none(&self) -> &Style { + &self.none + } +} diff --git a/crates/ruff_annotate_snippets/src/snippet.rs b/crates/ruff_annotate_snippets/src/snippet.rs new file mode 100644 index 0000000000000..5830a7b5cd068 --- /dev/null +++ b/crates/ruff_annotate_snippets/src/snippet.rs @@ -0,0 +1,159 @@ +//! Structures used as an input for the library. +//! +//! Example: +//! +//! ``` +//! use ruff_annotate_snippets::*; +//! +//! Level::Error.title("mismatched types") +//! .snippet(Snippet::source("Foo").line_start(51).origin("src/format.rs")) +//! .snippet(Snippet::source("Faa").line_start(129).origin("src/display.rs")); +//! ``` + +use std::ops::Range; + +/// Primary structure provided for formatting +/// +/// See [`Level::title`] to create a [`Message`] +#[derive(Debug)] +pub struct Message<'a> { + pub(crate) level: Level, + pub(crate) id: Option<&'a str>, + pub(crate) title: &'a str, + pub(crate) snippets: Vec<Snippet<'a>>, + pub(crate) footer: Vec<Message<'a>>, +} + +impl<'a> Message<'a> { + pub fn id(mut self, id: &'a str) -> Self { + self.id = Some(id); + self + } + + pub fn snippet(mut self, slice: Snippet<'a>) -> Self { + self.snippets.push(slice); + self + } + + pub fn snippets(mut self, slice: impl IntoIterator<Item = Snippet<'a>>) -> Self { + self.snippets.extend(slice); + self + } + + pub fn footer(mut self, footer: Message<'a>) -> Self { + self.footer.push(footer); + self + } + + pub fn footers(mut self, footer: impl IntoIterator<Item = Message<'a>>) -> Self { + self.footer.extend(footer); + self + } +} + +/// Structure containing the slice of text to be annotated and +/// basic information about the location of the slice. +/// +/// One `Snippet` is meant to represent a single, continuous, +/// slice of source code that you want to annotate. +#[derive(Debug)] +pub struct Snippet<'a> { + pub(crate) origin: Option<&'a str>, + pub(crate) line_start: usize, + + pub(crate) source: &'a str, + pub(crate) annotations: Vec<Annotation<'a>>, + + pub(crate) fold: bool, +} + +impl<'a> Snippet<'a> { + pub fn source(source: &'a str) -> Self { + Self { + origin: None, + line_start: 1, + source, + annotations: vec![], + fold: false, + } + } + + pub fn line_start(mut self, line_start: usize) -> Self { + self.line_start = line_start; + self + } + + pub fn origin(mut self, origin: &'a str) -> Self { + self.origin = Some(origin); + self + } + + pub fn annotation(mut self, annotation: Annotation<'a>) -> Self { + self.annotations.push(annotation); + self + } + + pub fn annotations(mut self, annotation: impl IntoIterator<Item = Annotation<'a>>) -> Self { + self.annotations.extend(annotation); + self + } + + /// Hide lines without [`Annotation`]s + pub fn fold(mut self, fold: bool) -> Self { + self.fold = fold; + self + } +} + +/// An annotation for a [`Snippet`]. +/// +/// See [`Level::span`] to create a [`Annotation`] +#[derive(Debug)] +pub struct Annotation<'a> { + /// The byte range of the annotation in the `source` string + pub(crate) range: Range<usize>, + pub(crate) label: Option<&'a str>, + pub(crate) level: Level, +} + +impl<'a> Annotation<'a> { + pub fn label(mut self, label: &'a str) -> Self { + self.label = Some(label); + self + } +} + +/// Types of annotations. +#[derive(Debug, Clone, Copy, PartialEq)] +pub enum Level { + /// Do not attach any annotation. + None, + /// Error annotations are displayed using red color and "^" character. + Error, + /// Warning annotations are displayed using blue color and "-" character. + Warning, + Info, + Note, + Help, +} + +impl Level { + pub fn title(self, title: &str) -> Message<'_> { + Message { + level: self, + id: None, + title, + snippets: vec![], + footer: vec![], + } + } + + /// Create a [`Annotation`] with the given span for a [`Snippet`] + pub fn span<'a>(self, span: Range<usize>) -> Annotation<'a> { + Annotation { + range: span, + label: None, + level: self, + } + } +} diff --git a/crates/ruff_annotate_snippets/tests/examples.rs b/crates/ruff_annotate_snippets/tests/examples.rs new file mode 100644 index 0000000000000..b6576629f91ba --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/examples.rs @@ -0,0 +1,37 @@ +#[test] +fn expected_type() { + let target = "expected_type"; + let expected = snapbox::file!["../examples/expected_type.svg": TermSvg]; + assert_example(target, expected); +} + +#[test] +fn footer() { + let target = "footer"; + let expected = snapbox::file!["../examples/footer.svg": TermSvg]; + assert_example(target, expected); +} + +#[test] +fn format() { + let target = "format"; + let expected = snapbox::file!["../examples/format.svg": TermSvg]; + assert_example(target, expected); +} + +#[test] +fn multislice() { + let target = "multislice"; + let expected = snapbox::file!["../examples/multislice.svg": TermSvg]; + assert_example(target, expected); +} + +#[track_caller] +fn assert_example(target: &str, expected: snapbox::Data) { + let bin_path = snapbox::cmd::compile_example(target, ["--features=testing-colors"]).unwrap(); + snapbox::cmd::Command::new(bin_path) + .env("CLICOLOR_FORCE", "1") + .assert() + .success() + .stdout_eq(expected.raw()); +} diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.svg new file mode 100644 index 0000000000000..bb12aecf29146 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected `.`, `=`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> Cargo.toml:1:5</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">1 |</tspan><tspan> asdf</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.toml new file mode 100644 index 0000000000000..cee5f0fbcd4ae --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_eof.toml @@ -0,0 +1,15 @@ +[message] +level = "Error" +title = "expected `.`, `=`" + +[[message.snippets]] +source = "asdf" +line_start = 1 +origin = "Cargo.toml" +[[message.snippets.annotations]] +label = "" +level = "Error" +range = [4, 4] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.svg new file mode 100644 index 0000000000000..1f4b6a24a6744 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected `.`, `=`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> Cargo.toml:1:3</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">1 |</tspan><tspan> asf</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">'d' belongs here</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.toml new file mode 100644 index 0000000000000..bf7411ef49c54 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_insertion.toml @@ -0,0 +1,15 @@ +[message] +level = "Error" +title = "expected `.`, `=`" + +[[message.snippets]] +source = "asf" +line_start = 1 +origin = "Cargo.toml" +[[message.snippets.annotations]] +label = "'d' belongs here" +level = "Error" +range = [2, 2] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.svg new file mode 100644 index 0000000000000..913069149d955 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.svg @@ -0,0 +1,42 @@ +<svg width="740px" height="182px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0027]</tspan><tspan>: </tspan><tspan class="bold">pattern does not mention fields `lineno`, `content`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/display_list.rs:139:32</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">139 |</tspan><tspan> if let DisplayLine::Source {</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">________________________________^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">140 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> ref mut inline_marks,</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">141 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> } = body[body_idx]</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|_________________________^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">missing fields `lineno`, `content`</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.toml new file mode 100644 index 0000000000000..9d8c30f9ec5b6 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline.toml @@ -0,0 +1,21 @@ +[message] +level = "Error" +id = "E0027" +title = "pattern does not mention fields `lineno`, `content`" + +[[message.snippets]] +source = """ + if let DisplayLine::Source { + ref mut inline_marks, + } = body[body_idx] +""" +line_start = 139 +origin = "src/display_list.rs" +fold = false +[[message.snippets.annotations]] +label = "missing fields `lineno`, `content`" +level = "Error" +range = [31, 128] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.svg new file mode 100644 index 0000000000000..97948a47a9218 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.svg @@ -0,0 +1,40 @@ +<svg width="740px" height="164px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E####]</tspan><tspan>: </tspan><tspan class="bold">spacing error found</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> foo.txt:26:12</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">26 |</tspan><tspan> This is an example</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^^^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">this should not be on separate lines</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">27 |</tspan><tspan> of an edge case of an annotation overflowing</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">28 |</tspan><tspan> to exactly one character on next line.</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.toml new file mode 100644 index 0000000000000..259d94b421ed0 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_multiline2.toml @@ -0,0 +1,21 @@ +[message] +level = "Error" +id = "E####" +title = "spacing error found" + +[[message.snippets]] +source = """ +This is an example +of an edge case of an annotation overflowing +to exactly one character on next line. +""" +line_start = 26 +origin = "foo.txt" +fold = false +[[message.snippets.annotations]] +label = "this should not be on separate lines" +level = "Error" +range = [11, 19] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.svg new file mode 100644 index 0000000000000..bb12aecf29146 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected `.`, `=`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> Cargo.toml:1:5</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">1 |</tspan><tspan> asdf</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.toml new file mode 100644 index 0000000000000..36f74ef6da08a --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ann_removed_nl.toml @@ -0,0 +1,15 @@ +[message] +level = "Error" +title = "expected `.`, `=`" + +[[message.snippets]] +source = "asdf" +line_start = 1 +origin = "Cargo.toml" +[[message.snippets.annotations]] +label = "" +level = "Error" +range = [4, 5] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.svg new file mode 100644 index 0000000000000..e5646e61ada11 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.svg @@ -0,0 +1,36 @@ +<svg width="1356px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">invalid character ` ` in package name: `haha this isn't a valid name 🐛`, characters must be Unicode XID characters (numbers, `-`, `_`, or most letters)</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> <file>:7:1</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">7 |</tspan><tspan> "haha this isn't a valid name 🐛" = { package = "libc", version = "0.1" }</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.toml new file mode 100644 index 0000000000000..52168b480b8eb --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/ensure-emoji-highlight-width.toml @@ -0,0 +1,18 @@ +[message] +title = "invalid character ` ` in package name: `haha this isn't a valid name 🐛`, characters must be Unicode XID characters (numbers, `-`, `_`, or most letters)" +level = "Error" + + +[[message.snippets]] +source = """ +"haha this isn't a valid name 🐛" = { package = "libc", version = "0.1" } +""" +line_start = 7 +origin = "<file>" +[[message.snippets.annotations]] +label = "" +level = "Error" +range = [0, 35] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.svg new file mode 100644 index 0000000000000..6a89c4f75f1b8 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.svg @@ -0,0 +1,49 @@ +<svg width="869px" height="236px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .fg-yellow { fill: #AA5500 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/format.rs:51:6</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">51 |</tspan><tspan> ) -> Option<String> {</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">--------------</tspan><tspan> </tspan><tspan class="fg-yellow bold">expected `std::option::Option<std::string::String>` because of return type</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">52 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">/</tspan><tspan> for ann in annotations {</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">53 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> match (ann.range.0, ann.range.1) {</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan class="fg-bright-blue bold">...</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan class="fg-bright-blue bold">71 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="190px"><tspan class="fg-bright-blue bold">72 |</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="208px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|_____^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected enum `std::option::Option`, found ()</tspan> +</tspan> + <tspan x="10px" y="226px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.toml new file mode 100644 index 0000000000000..80edfb552afcf --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_ann_multiline.toml @@ -0,0 +1,44 @@ +[message] +level = "Error" +id = "E0308" +title = "mismatched types" + +[[message.snippets]] +source = """ +) -> Option<String> { + for ann in annotations { + match (ann.range.0, ann.range.1) { + (None, None) => continue, + (Some(start), Some(end)) if start > end_index || end < start_index => continue, + (Some(start), Some(end)) if start >= start_index && end <= end_index => { + let label = if let Some(ref label) = ann.label { + format!(" {}", label) + } else { + String::from("") + }; + + return Some(format!( + "{}{}{}", + " ".repeat(start - start_index), + "^".repeat(end - start), + label + )); + } + _ => continue, + } + } +""" +line_start = 51 +origin = "src/format.rs" +fold = true +[[message.snippets.annotations]] +label = "expected `std::option::Option<std::string::String>` because of return type" +level = "Warning" +range = [5, 19] +[[message.snippets.annotations]] +label = "expected enum `std::option::Option`, found ()" +level = "Error" +range = [22, 766] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.svg new file mode 100644 index 0000000000000..23f1b646e4641 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.svg @@ -0,0 +1,37 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .fg-yellow { fill: #AA5500 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> path/to/error.rs:3:1</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">3 |</tspan><tspan> invalid syntax</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">--------------</tspan><tspan> </tspan><tspan class="fg-yellow bold">error here</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.toml new file mode 100644 index 0000000000000..3e40137ac61d9 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_bad_origin_line.toml @@ -0,0 +1,20 @@ +[message] +level = "Error" +title = "" + +[[message.snippets]] +source = """ + + +invalid syntax +""" +line_start = 1 +origin = "path/to/error.rs" +fold = true +[[message.snippets.annotations]] +label = "error here" +level = "Warning" +range = [2,16] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.svg new file mode 100644 index 0000000000000..e69965e98ad15 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">invalid type: integer `20`, expected a bool</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> Cargo.toml:11:13</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">11 |</tspan><tspan> workspace = 20</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.toml new file mode 100644 index 0000000000000..90c6c8c4a628f --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_leading.toml @@ -0,0 +1,29 @@ +[message] +level = "Error" +id = "E0308" +title = "invalid type: integer `20`, expected a bool" + +[[message.snippets]] +source = """ +[workspace] + +[package] +name = "hello" +version = "1.0.0" +license = "MIT" +rust-version = "1.70" +edition = "2021" + +[lints] +workspace = 20 +""" +line_start = 1 +origin = "Cargo.toml" +fold = true +[[message.snippets.annotations]] +label = "" +level = "Error" +range = [132, 134] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.svg new file mode 100644 index 0000000000000..41bf7c7959806 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">invalid type: integer `20`, expected a lints table</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> Cargo.toml:1:9</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">1 |</tspan><tspan> lints = 20</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.toml new file mode 100644 index 0000000000000..10b2240c13f3c --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/fold_trailing.toml @@ -0,0 +1,28 @@ +[message] +level = "Error" +id = "E0308" +title = "invalid type: integer `20`, expected a lints table" + +[[message.snippets]] +source = """ +lints = 20 + +[workspace] + +[package] +name = "hello" +version = "1.0.0" +license = "MIT" +rust-version = "1.70" +edition = "2021" +""" +line_start = 1 +origin = "Cargo.toml" +fold = true +[[message.snippets.annotations]] +label = "" +level = "Error" +range = [8, 10] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.svg new file mode 100644 index 0000000000000..80b891e0affd1 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.svg @@ -0,0 +1,49 @@ +<svg width="911px" height="236px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .fg-yellow { fill: #AA5500 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected one of `.`, `;`, `?`, or an operator, found `for`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> /code/rust/src/test/ui/annotate-snippet/suggestion.rs:4:5</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">4 |</tspan><tspan> let x = vec![1];</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">-</tspan><tspan> </tspan><tspan class="fg-yellow bold">move occurs because `x` has type `std::vec::Vec<i32>`, which does not implement the `Copy` trait</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">7 |</tspan><tspan> let y = x;</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">-</tspan><tspan> </tspan><tspan class="fg-yellow bold">value moved here</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="190px"><tspan class="fg-bright-blue bold">9 |</tspan><tspan> x;</tspan> +</tspan> + <tspan x="10px" y="208px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">value used here after move</tspan> +</tspan> + <tspan x="10px" y="226px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.toml new file mode 100644 index 0000000000000..9de1753402794 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/issue_9.toml @@ -0,0 +1,31 @@ +[message] +level = "Error" +title = "expected one of `.`, `;`, `?`, or an operator, found `for`" + +[[message.snippets]] +source = "let x = vec![1];" +line_start = 4 +origin = "/code/rust/src/test/ui/annotate-snippet/suggestion.rs" +[[message.snippets.annotations]] +label = "move occurs because `x` has type `std::vec::Vec<i32>`, which does not implement the `Copy` trait" +level = "Warning" +range = [4, 5] + +[[message.snippets]] +source = "let y = x;" +line_start = 7 +[[message.snippets.annotations]] +label = "value moved here" +level = "Warning" +range = [8, 9] + +[[message.snippets]] +source = "x;" +line_start = 9 +[[message.snippets.annotations]] +label = "value used here after move" +level = "Error" +range = [0, 1] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.svg new file mode 100644 index 0000000000000..84f474950c587 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.svg @@ -0,0 +1,54 @@ +<svg width="768px" height="290px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan class="fg-bright-blue bold"> 96 |</tspan><tspan> fn add_title_line(result: &mut Vec<String>, main_annotation: Option<&Annotation>) {</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold"> 97 |</tspan><tspan> if let Some(annotation) = main_annotation {</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^^^^^^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">Variable defined here</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold"> 98 |</tspan><tspan> result.push(format_title_line(</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold"> 99 |</tspan><tspan> &annotation.annotation_type,</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^^^^^^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">Referenced here</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan class="fg-bright-blue bold">100 |</tspan><tspan> None,</tspan> +</tspan> + <tspan x="10px" y="190px"><tspan class="fg-bright-blue bold">101 |</tspan><tspan> &annotation.label,</tspan> +</tspan> + <tspan x="10px" y="208px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^^^^^^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">Referenced again here</tspan> +</tspan> + <tspan x="10px" y="226px"><tspan class="fg-bright-blue bold">102 |</tspan><tspan> ));</tspan> +</tspan> + <tspan x="10px" y="244px"><tspan class="fg-bright-blue bold">103 |</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="262px"><tspan class="fg-bright-blue bold">104 |</tspan><tspan> }</tspan> +</tspan> + <tspan x="10px" y="280px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.toml new file mode 100644 index 0000000000000..824c53054cd6b --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/multiple_annotations.toml @@ -0,0 +1,32 @@ +[message] +level = "Error" +title = "" + +[[message.snippets]] +source = """ +fn add_title_line(result: &mut Vec<String>, main_annotation: Option<&Annotation>) { + if let Some(annotation) = main_annotation { + result.push(format_title_line( + &annotation.annotation_type, + None, + &annotation.label, + )); + } +} +""" +line_start = 96 +[[message.snippets.annotations]] +label = "Variable defined here" +level = "Error" +range = [100, 110] +[[message.snippets.annotations]] +label = "Referenced here" +level = "Error" +range = [184, 194] +[[message.snippets.annotations]] +label = "Referenced again here" +level = "Error" +range = [243, 253] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/simple.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/simple.svg new file mode 100644 index 0000000000000..7b92d238fd219 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/simple.svg @@ -0,0 +1,43 @@ +<svg width="740px" height="182px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .fg-yellow { fill: #AA5500 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error</tspan><tspan>: </tspan><tspan class="bold">expected one of `.`, `;`, `?`, or an operator, found `for`</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> src/format_color.rs:171:9</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">169 |</tspan><tspan> })</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-yellow bold">-</tspan><tspan> </tspan><tspan class="fg-yellow bold">expected one of `.`, `;`, `?`, or an operator here</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan class="fg-bright-blue bold">170 |</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan class="fg-bright-blue bold">171 |</tspan><tspan> for line in &self.body {</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">unexpected token</tspan> +</tspan> + <tspan x="10px" y="172px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/simple.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/simple.toml new file mode 100644 index 0000000000000..2e6969f7e7140 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/simple.toml @@ -0,0 +1,22 @@ +[message] +level = "Error" +title = "expected one of `.`, `;`, `?`, or an operator, found `for`" + +[[message.snippets]] +source = """ + }) + + for line in &self.body {""" +line_start = 169 +origin = "src/format_color.rs" +[[message.snippets.annotations]] +label = "unexpected token" +level = "Error" +range = [20, 23] +[[message.snippets.annotations]] +label = "expected one of `.`, `;`, `?`, or an operator here" +level = "Warning" +range = [10, 11] + +[renderer] +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.svg new file mode 100644 index 0000000000000..9da24fe37bf81 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> $DIR/whitespace-trimming.rs:4:193</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">LL |</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">...</tspan><tspan> let _: () = 42;</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected (), found integer</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.toml new file mode 100644 index 0000000000000..546c96a0384c5 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line.toml @@ -0,0 +1,18 @@ +[message] +level = "Error" +id = "E0308" +title = "mismatched types" + +[[message.snippets]] +source = " let _: () = 42;" +line_start = 4 +origin = "$DIR/whitespace-trimming.rs" + +[[message.snippets.annotations]] +label = "expected (), found integer" +level = "Error" +range = [192, 194] + +[renderer] +color = true +anonymized_line_numbers = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.svg new file mode 100644 index 0000000000000..cbafc78915cce --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.svg @@ -0,0 +1,36 @@ +<svg width="740px" height="128px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> $DIR/whitespace-trimming.rs:4:193</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">LL |</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">...</tspan><tspan> let _: () = 42ñ</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected (), found integer</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.toml new file mode 100644 index 0000000000000..863abb3fa8550 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_char.toml @@ -0,0 +1,18 @@ +[message] +level = "Error" +id = "E0308" +title = "mismatched types" + +[[message.snippets]] +source = " let _: () = 42ñ" +line_start = 4 +origin = "$DIR/whitespace-trimming.rs" + +[[message.snippets.annotations]] +label = "expected (), found integer" +level = "Error" +range = [192, 194] + +[renderer] +color = true +anonymized_line_numbers = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.svg b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.svg new file mode 100644 index 0000000000000..e4f8a856b649b --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.svg @@ -0,0 +1,40 @@ +<svg width="1196px" height="164px" xmlns="http://www.w3.org/2000/svg"> + <style> + .fg { fill: #AAAAAA } + .bg { background: #000000 } + .fg-bright-blue { fill: #5555FF } + .fg-bright-red { fill: #FF5555 } + .container { + padding: 0 10px; + line-height: 18px; + } + .bold { font-weight: bold; } + tspan { + font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace; + white-space: pre; + line-height: 18px; + } + </style> + + <rect width="100%" height="100%" y="0" rx="4.5" class="bg" /> + + <text xml:space="preserve" class="container fg"> + <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error[E0308]</tspan><tspan>: </tspan><tspan class="bold">mismatched types</tspan> +</tspan> + <tspan x="10px" y="46px"><tspan> </tspan><tspan class="fg-bright-blue bold">--></tspan><tspan> $DIR/non-whitespace-trimming.rs:4:242</tspan> +</tspan> + <tspan x="10px" y="64px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">LL |</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">...</tspan><tspan> = (); let _: () = (); let _: () = (); let _: () = 42; let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () </tspan><tspan class="fg-bright-blue bold">...</tspan> +</tspan> + <tspan x="10px" y="100px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">^^</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected `()`, found integer</tspan> +</tspan> + <tspan x="10px" y="118px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">|</tspan> +</tspan> + <tspan x="10px" y="136px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan><tspan> </tspan><tspan class="fg-bright-red bold">expected due to this</tspan> +</tspan> + <tspan x="10px" y="154px"><tspan> </tspan><tspan class="fg-bright-blue bold">|</tspan> +</tspan> + </text> + +</svg> diff --git a/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.toml b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.toml new file mode 100644 index 0000000000000..c6573ff40aa37 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/color/strip_line_non_ws.toml @@ -0,0 +1,26 @@ +[message] +level = "Error" +id = "E0308" +title = "mismatched types" + +[[message.snippets]] +source = """ + let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = 42; let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); let _: () = (); +""" +line_start = 4 +origin = "$DIR/non-whitespace-trimming.rs" + +[[message.snippets.annotations]] +label = "expected `()`, found integer" +level = "Error" +range = [241, 243] + +[[message.snippets.annotations]] +label = "expected due to this" +level = "Error" +range = [236, 238] + + +[renderer] +anonymized_line_numbers = true +color = true diff --git a/crates/ruff_annotate_snippets/tests/fixtures/deserialize.rs b/crates/ruff_annotate_snippets/tests/fixtures/deserialize.rs new file mode 100644 index 0000000000000..6f27100816635 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/deserialize.rs @@ -0,0 +1,130 @@ +use serde::Deserialize; +use std::ops::Range; + +use ruff_annotate_snippets::renderer::DEFAULT_TERM_WIDTH; +use ruff_annotate_snippets::{Annotation, Level, Message, Renderer, Snippet}; + +#[derive(Deserialize)] +pub(crate) struct Fixture { + #[serde(default)] + pub(crate) renderer: RendererDef, + pub(crate) message: MessageDef, +} + +#[derive(Deserialize)] +pub struct MessageDef { + #[serde(with = "LevelDef")] + pub level: Level, + pub title: String, + #[serde(default)] + pub id: Option<String>, + #[serde(default)] + pub footer: Vec<MessageDef>, + pub snippets: Vec<SnippetDef>, +} + +impl<'a> From<&'a MessageDef> for Message<'a> { + fn from(val: &'a MessageDef) -> Self { + let MessageDef { + level, + title, + id, + footer, + snippets, + } = val; + let mut message = level.title(title); + if let Some(id) = id { + message = message.id(id); + } + message = message.snippets(snippets.iter().map(Snippet::from)); + message = message.footers(footer.iter().map(Into::into)); + message + } +} + +#[derive(Deserialize)] +pub struct SnippetDef { + pub source: String, + pub line_start: usize, + pub origin: Option<String>, + pub annotations: Vec<AnnotationDef>, + #[serde(default)] + pub fold: bool, +} + +impl<'a> From<&'a SnippetDef> for Snippet<'a> { + fn from(val: &'a SnippetDef) -> Self { + let SnippetDef { + source, + line_start, + origin, + annotations, + fold, + } = val; + let mut snippet = Snippet::source(source).line_start(*line_start).fold(*fold); + if let Some(origin) = origin { + snippet = snippet.origin(origin); + } + snippet = snippet.annotations(annotations.iter().map(Into::into)); + snippet + } +} + +#[derive(Deserialize)] +pub struct AnnotationDef { + pub range: Range<usize>, + pub label: String, + #[serde(with = "LevelDef")] + pub level: Level, +} + +impl<'a> From<&'a AnnotationDef> for Annotation<'a> { + fn from(val: &'a AnnotationDef) -> Self { + let AnnotationDef { + range, + label, + level, + } = val; + level.span(range.start..range.end).label(label) + } +} + +#[allow(dead_code)] +#[derive(Deserialize)] +#[serde(remote = "Level")] +enum LevelDef { + Error, + Warning, + Info, + Note, + Help, +} + +#[derive(Default, Deserialize)] +pub struct RendererDef { + #[serde(default)] + anonymized_line_numbers: bool, + #[serde(default)] + term_width: Option<usize>, + #[serde(default)] + color: bool, +} + +impl From<RendererDef> for Renderer { + fn from(val: RendererDef) -> Self { + let RendererDef { + anonymized_line_numbers, + term_width, + color, + } = val; + + let renderer = if color { + Renderer::styled() + } else { + Renderer::plain() + }; + renderer + .anonymized_line_numbers(anonymized_line_numbers) + .term_width(term_width.unwrap_or(DEFAULT_TERM_WIDTH)) + } +} diff --git a/crates/ruff_annotate_snippets/tests/fixtures/main.rs b/crates/ruff_annotate_snippets/tests/fixtures/main.rs new file mode 100644 index 0000000000000..3ffafc393fa85 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/fixtures/main.rs @@ -0,0 +1,41 @@ +mod deserialize; + +use crate::deserialize::Fixture; +use ruff_annotate_snippets::{Message, Renderer}; +use snapbox::Data; +use snapbox::data::DataFormat; +use std::error::Error; + +fn main() { + tryfn::Harness::new("tests/fixtures/", setup, test) + .select(["*/*.toml"]) + .test(); +} + +fn setup(input_path: std::path::PathBuf) -> tryfn::Case { + let parent = input_path + .parent() + .unwrap() + .file_name() + .unwrap() + .to_str() + .unwrap(); + let file_name = input_path.file_name().unwrap().to_str().unwrap(); + let name = format!("{parent}/{file_name}"); + let expected = Data::read_from(&input_path.with_extension("svg"), None); + tryfn::Case { + name, + fixture: input_path, + expected, + } +} + +fn test(input_path: &std::path::Path) -> Result<Data, Box<dyn Error>> { + let src = std::fs::read_to_string(input_path)?; + let fixture: Fixture = toml::from_str(&src)?; + let renderer: Renderer = fixture.renderer.into(); + let message: Message<'_> = (&fixture.message).into(); + + let actual = renderer.render(message).to_string(); + Ok(Data::from(actual).coerce_to(DataFormat::TermSvg)) +} diff --git a/crates/ruff_annotate_snippets/tests/formatter.rs b/crates/ruff_annotate_snippets/tests/formatter.rs new file mode 100644 index 0000000000000..c150aa54386a8 --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/formatter.rs @@ -0,0 +1,1031 @@ +// Since this is a vendored copy of `annotate-snippets`, we squash Clippy +// warnings from upstream in order to the reduce the diff. If our copy drifts +// far from upstream such that patches become impractical to apply in both +// places, then we can get rid of these suppressions and fix the lints. +#![allow(clippy::redundant_clone, clippy::should_panic_without_expect)] + +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +use snapbox::{assert_data_eq, str}; + +#[test] +fn test_i_29() { + let snippets = Level::Error.title("oops").snippet( + Snippet::source("First line\r\nSecond oops line") + .origin("<current file>") + .annotation(Level::Error.span(19..23).label("oops")) + .fold(true), + ); + let expected = str![[r#" +error: oops + --> <current file>:2:8 + | +2 | Second oops line + | ^^^^ oops + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn test_point_to_double_width_characters() { + let snippets = Level::Error.title("").snippet( + Snippet::source("こんにちは、世界") + .origin("<current file>") + .annotation(Level::Error.span(18..24).label("world")), + ); + + let expected = str![[r#" +error + --> <current file>:1:7 + | +1 | こんにちは、世界 + | ^^^^ world + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn test_point_to_double_width_characters_across_lines() { + let snippets = Level::Error.title("").snippet( + Snippet::source("おはよう\nございます") + .origin("<current file>") + .annotation(Level::Error.span(6..22).label("Good morning")), + ); + + let expected = str![[r#" +error + --> <current file>:1:3 + | +1 | おはよう + | _____^ +2 | | ございます + | |______^ Good morning + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn test_point_to_double_width_characters_multiple() { + let snippets = Level::Error.title("").snippet( + Snippet::source("お寿司\n食べたい🍣") + .origin("<current file>") + .annotation(Level::Error.span(0..9).label("Sushi1")) + .annotation(Level::Note.span(16..22).label("Sushi2")), + ); + + let expected = str![[r#" +error + --> <current file>:1:1 + | +1 | お寿司 + | ^^^^^^ Sushi1 +2 | 食べたい🍣 + | ---- note: Sushi2 + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn test_point_to_double_width_characters_mixed() { + let snippets = Level::Error.title("").snippet( + Snippet::source("こんにちは、新しいWorld！") + .origin("<current file>") + .annotation(Level::Error.span(18..32).label("New world")), + ); + + let expected = str![[r#" +error + --> <current file>:1:7 + | +1 | こんにちは、新しいWorld！ + | ^^^^^^^^^^^ New world + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn test_format_title() { + let input = Level::Error.title("This is a title").id("E0001"); + + let expected = str![r#"error[E0001]: This is a title"#]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +/// Tests that we can format a message *without* a header. +/// +/// This uses `Level::None`, which is somewhat of a hacky API addition I made +/// to our vendored copy of `annotate-snippets` in order to do exactly what +/// this test asserts: skip the header. +#[test] +fn test_format_skip_title() { + let source = + "# Docstring followed by a newline\n\ndef foobar(foot, bar={}):\n \"\"\"\n \"\"\"\n"; + let src_annotation = Level::Error.span(56..58).label("B006"); + let snippet = Snippet::source(source) + .line_start(1) + .annotation(src_annotation) + .fold(false); + let message = Level::None.title("").snippet(snippet); + + let expected = str![[r#" + | +1 | # Docstring followed by a newline +2 | +3 | def foobar(foot, bar={}): + | ^^ B006 +4 | """ +5 | """ + | +"#]]; + assert_data_eq!(Renderer::plain().render(message).to_string(), expected); +} + +#[test] +fn test_format_snippet_only() { + let source = "This is line 1\nThis is line 2"; + let input = Level::Error + .title("") + .snippet(Snippet::source(source).line_start(5402)); + + let expected = str![[r#" +error + | +5402 | This is line 1 +5403 | This is line 2 + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_format_snippets_continuation() { + let src_0 = "This is slice 1"; + let src_1 = "This is slice 2"; + let input = Level::Error + .title("") + .snippet(Snippet::source(src_0).line_start(5402).origin("file1.rs")) + .snippet(Snippet::source(src_1).line_start(2).origin("file2.rs")); + let expected = str![[r#" +error + --> file1.rs + | +5402 | This is slice 1 + | + ::: file2.rs + | + 2 | This is slice 2 + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_format_snippet_annotation_standalone() { + let line_1 = "This is line 1"; + let line_2 = "This is line 2"; + let source = [line_1, line_2].join("\n"); + // In line 2 + let range = 22..24; + let input = Level::Error.title("").snippet( + Snippet::source(&source) + .line_start(5402) + .annotation(Level::Info.span(range.clone()).label("Test annotation")), + ); + let expected = str![[r#" +error + | +5402 | This is line 1 +5403 | This is line 2 + | -- info: Test annotation + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_format_footer_title() { + let input = Level::Error + .title("") + .footer(Level::Error.title("This __is__ a title")); + let expected = str![[r#" +error + = error: This __is__ a title +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +#[should_panic] +fn test_i26() { + let source = "short"; + let label = "label"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .line_start(0) + .annotation(Level::Error.span(0..source.len() + 2).label(label)), + ); + let renderer = Renderer::plain(); + let _ = renderer.render(input).to_string(); +} + +#[test] +fn test_source_content() { + let source = "This is an example\nof content lines"; + let input = Level::Error + .title("") + .snippet(Snippet::source(source).line_start(56)); + let expected = str![[r#" +error + | +56 | This is an example +57 | of content lines + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_source_annotation_standalone_singleline() { + let source = "tests"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .line_start(1) + .annotation(Level::Help.span(0..5).label("Example string")), + ); + let expected = str![[r#" +error + | +1 | tests + | ----- help: Example string + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_source_annotation_standalone_multiline() { + let source = "tests"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .line_start(1) + .annotation(Level::Help.span(0..5).label("Example string")) + .annotation(Level::Help.span(0..5).label("Second line")), + ); + let expected = str![[r#" +error + | +1 | tests + | ----- + | | + | help: Example string + | help: Second line + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_only_source() { + let input = Level::Error + .title("") + .snippet(Snippet::source("").origin("file.rs")); + let expected = str![[r#" +error +--> file.rs + | + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn test_anon_lines() { + let source = "This is an example\nof content lines\n\nabc"; + let input = Level::Error + .title("") + .snippet(Snippet::source(source).line_start(56)); + let expected = str![[r#" +error + | +LL | This is an example +LL | of content lines +LL | +LL | abc + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(true); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn issue_130() { + let input = Level::Error.title("dummy").snippet( + Snippet::source("foo\nbar\nbaz") + .origin("file/path") + .line_start(3) + .fold(true) + .annotation(Level::Error.span(4..11)), // bar\nbaz + ); + + let expected = str![[r#" +error: dummy + --> file/path:4:1 + | +4 | / bar +5 | | baz + | |___^ + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn unterminated_string_multiline() { + let source = "\ +a\" +// ... +"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .fold(true) + .annotation(Level::Error.span(0..10)), // 1..10 works + ); + let expected = str![[r#" +error + --> file/path:3:1 + | +3 | / a" +4 | | // ... + | |_______^ + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn char_and_nl_annotate_char() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(0..2)), // a\r + ); + let expected = str![[r#" +error + --> file/path:3:1 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn char_eol_annotate_char() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(0..3)), // a\r\n + ); + let expected = str![[r#" +error + --> file/path:3:1 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn char_eol_annotate_char_double_width() { + let snippets = Level::Error.title("").snippet( + Snippet::source("こん\r\nにちは\r\n世界") + .origin("<current file>") + .annotation(Level::Error.span(3..8)), // ん\r\n + ); + + let expected = str![[r#" +error + --> <current file>:1:2 + | +1 | こん + | ^^ +2 | にちは +3 | 世界 + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn annotate_eol() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..2)), // \r + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn annotate_eol2() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..3)), // \r\n + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn annotate_eol3() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(2..3)), // \n + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn annotate_eol4() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(2..2)), // \n + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | ^ +4 | b + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn annotate_eol_double_width() { + let snippets = Level::Error.title("").snippet( + Snippet::source("こん\r\nにちは\r\n世界") + .origin("<current file>") + .annotation(Level::Error.span(7..8)), // \n + ); + + let expected = str![[r#" +error + --> <current file>:1:3 + | +1 | こん + | ^ +2 | にちは +3 | 世界 + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn multiline_eol_start() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..4)), // \r\nb + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |_^ + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start2() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(2..4)), // \nb + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |_^ + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start3() { + let source = "a\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..3)), // \nb + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |_^ + |"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start_double_width() { + let snippets = Level::Error.title("").snippet( + Snippet::source("こん\r\nにちは\r\n世界") + .origin("<current file>") + .annotation(Level::Error.span(7..11)), // \r\nに + ); + + let expected = str![[r#" +error + --> <current file>:1:3 + | +1 | こん + | _____^ +2 | | にちは + | |__^ +3 | 世界 + | +"#]]; + + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(snippets).to_string(), expected); +} + +#[test] +fn multiline_eol_start_eol_end() { + let source = "a\nb\nc"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..4)), // \nb\n + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |__^ +5 | c + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start_eol_end2() { + let source = "a\r\nb\r\nc"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(2..5)), // \nb\r + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |__^ +5 | c + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start_eol_end3() { + let source = "a\r\nb\r\nc"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(2..6)), // \nb\r\n + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |__^ +5 | c + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start_eof_end() { + let source = "a\r\nb"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(1..5)), // \r\nb(EOF) + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | a + | __^ +4 | | b + | |__^ + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multiline_eol_start_eof_end_double_width() { + let source = "ん\r\nに"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .origin("file/path") + .line_start(3) + .annotation(Level::Error.span(3..9)), // \r\nに(EOF) + ); + let expected = str![[r#" +error + --> file/path:3:2 + | +3 | ん + | ___^ +4 | | に + | |___^ + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn two_single_line_same_line() { + let source = r#"bar = { version = "0.1.0", optional = true }"#; + let input = Level::Error.title("unused optional dependency").snippet( + Snippet::source(source) + .origin("Cargo.toml") + .line_start(4) + .annotation( + Level::Error + .span(0..3) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Info + .span(27..42) + .label("This should also be long but not too long"), + ), + ); + let expected = str![[r#" +error: unused optional dependency + --> Cargo.toml:4:1 + | +4 | bar = { version = "0.1.0", optional = true } + | ^^^ --------------- info: This should also be long but not too long + | | + | I need this to be really long so I can test overlaps + | +"#]]; + let renderer = Renderer::plain().anonymized_line_numbers(false); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn multi_and_single() { + let source = r#"bar = { version = "0.1.0", optional = true } +this is another line +so is this +bar = { version = "0.1.0", optional = true } +"#; + let input = Level::Error.title("unused optional dependency").snippet( + Snippet::source(source) + .line_start(4) + .annotation( + Level::Error + .span(41..119) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Info + .span(27..42) + .label("This should also be long but not too long"), + ), + ); + let expected = str![[r#" +error: unused optional dependency + | +4 | bar = { version = "0.1.0", optional = true } + | ____________________________--------------^ + | | | + | | info: This should also be long but not too long +5 | | this is another line +6 | | so is this +7 | | bar = { version = "0.1.0", optional = true } + | |__________________________________________^ I need this to be really long so I can test overlaps + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn two_multi_and_single() { + let source = r#"bar = { version = "0.1.0", optional = true } +this is another line +so is this +bar = { version = "0.1.0", optional = true } +"#; + let input = Level::Error.title("unused optional dependency").snippet( + Snippet::source(source) + .line_start(4) + .annotation( + Level::Error + .span(41..119) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Error + .span(8..102) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Info + .span(27..42) + .label("This should also be long but not too long"), + ), + ); + let expected = str![[r#" +error: unused optional dependency + | +4 | bar = { version = "0.1.0", optional = true } + | _________^__________________--------------^ + | | | | + | |_________| info: This should also be long but not too long + | || +5 | || this is another line +6 | || so is this +7 | || bar = { version = "0.1.0", optional = true } + | ||_________________________^________________^ I need this to be really long so I can test overlaps + | |__________________________| + | I need this to be really long so I can test overlaps + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn three_multi_and_single() { + let source = r#"bar = { version = "0.1.0", optional = true } +this is another line +so is this +bar = { version = "0.1.0", optional = true } +this is another line +"#; + let input = Level::Error.title("unused optional dependency").snippet( + Snippet::source(source) + .line_start(4) + .annotation( + Level::Error + .span(41..119) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Error + .span(8..102) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Error + .span(48..126) + .label("I need this to be really long so I can test overlaps"), + ) + .annotation( + Level::Info + .span(27..42) + .label("This should also be long but not too long"), + ), + ); + let expected = str![[r#" +error: unused optional dependency + | +4 | bar = { version = "0.1.0", optional = true } + | __________^__________________--------------^ + | | | | + | |__________| info: This should also be long but not too long + | || +5 | || this is another line + | || ____^ +6 | ||| so is this +7 | ||| bar = { version = "0.1.0", optional = true } + | |||_________________________^________________^ I need this to be really long so I can test overlaps + | |_|_________________________| + | | I need this to be really long so I can test overlaps +8 | | this is another line + | |____^ I need this to be really long so I can test overlaps + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn origin_correct_start_line() { + let source = "aaa\nbbb\nccc\nddd\n"; + let input = Level::Error.title("title").snippet( + Snippet::source(source) + .origin("origin.txt") + .fold(false) + .annotation(Level::Error.span(8..8 + 3).label("annotation")), + ); + + let expected = str![[r#" +error: title + --> origin.txt:3:1 + | +1 | aaa +2 | bbb +3 | ccc + | ^^^ annotation +4 | ddd + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn origin_correct_mid_line() { + let source = "aaa\nbbb\nccc\nddd\n"; + let input = Level::Error.title("title").snippet( + Snippet::source(source) + .origin("origin.txt") + .fold(false) + .annotation(Level::Error.span(8 + 1..8 + 3).label("annotation")), + ); + + let expected = str![[r#" +error: title + --> origin.txt:3:2 + | +1 | aaa +2 | bbb +3 | ccc + | ^^ annotation +4 | ddd + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn long_line_cut() { + let source = "abcd abcd abcd abcd abcd abcd abcd"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .line_start(1) + .annotation(Level::Error.span(0..4)), + ); + let expected = str![[r#" +error + | +1 | abcd abcd a... + | ^^^^ + | +"#]]; + let renderer = Renderer::plain().term_width(18); + assert_data_eq!(renderer.render(input).to_string(), expected); +} + +#[test] +fn long_line_cut_custom() { + let source = "abcd abcd abcd abcd abcd abcd abcd"; + let input = Level::Error.title("").snippet( + Snippet::source(source) + .line_start(1) + .annotation(Level::Error.span(0..4)), + ); + // This trims a little less because `…` is visually smaller than `...`. + let expected = str![[r#" +error + | +1 | abcd abcd abc… + | ^^^^ + | +"#]]; + let renderer = Renderer::plain().term_width(18).cut_indicator("…"); + assert_data_eq!(renderer.render(input).to_string(), expected); +} diff --git a/crates/ruff_annotate_snippets/tests/rustc_tests.rs b/crates/ruff_annotate_snippets/tests/rustc_tests.rs new file mode 100644 index 0000000000000..f89c6a4c5df6d --- /dev/null +++ b/crates/ruff_annotate_snippets/tests/rustc_tests.rs @@ -0,0 +1,783 @@ +//! These tests have been adapted from [Rust's parser tests][parser-tests]. +//! +//! [parser-tests]: https://github.com/rust-lang/rust/blob/894f7a4ba6554d3797404bbf550d9919df060b97/compiler/rustc_parse/src/parser/tests.rs + +use ruff_annotate_snippets::{Level, Renderer, Snippet}; + +use snapbox::{assert_data_eq, str}; + +#[test] +fn ends_on_col0() { + let source = r#" +fn foo() { +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(10..13).label("test")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:2:10 + | +2 | fn foo() { + | __________^ +3 | | } + | |_^ test + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn ends_on_col2() { + let source = r#" +fn foo() { + + + } +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(10..17).label("test")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:2:10 + | +2 | fn foo() { + | __________^ +3 | | +4 | | +5 | | } + | |___^ test + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn non_nested() { + let source = r#" +fn foo() { + X0 Y0 + X1 Y1 + X2 Y2 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..32).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(17..35) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | X0 Y0 + | ____^ - + | | ______| +4 | || X1 Y1 +5 | || X2 Y2 + | ||____^__- `Y` is a good letter too + | |_____| + | `X` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn nested() { + let source = r#" +fn foo() { + X0 Y0 + Y1 X1 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(17..24) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | X0 Y0 + | ____^ - + | | ______| +4 | || Y1 X1 + | ||____-__^ `X` is a good letter + | |____| + | `Y` is a good letter too + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn different_overlap() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(17..38).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(31..49) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:6 + | +3 | X0 Y0 Z0 + | _______^ +4 | | X1 Y1 Z1 + | | _________- +5 | || X2 Y2 Z2 + | ||____^ `X` is a good letter +6 | | X3 Y3 Z3 + | |____- `Y` is a good letter too + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn triple_overlap() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..38).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(17..41) + .label("`Y` is a good letter too"), + ) + .annotation(Level::Warning.span(20..44).label("`Z` label")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | X0 Y0 Z0 + | _____^ - - + | | _______| | + | || _________| +4 | ||| X1 Y1 Z1 +5 | ||| X2 Y2 Z2 + | |||____^__-__- `Z` label + | ||_____|__| + | |______| `Y` is a good letter too + | `X` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn triple_exact_overlap() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..38).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(14..38) + .label("`Y` is a good letter too"), + ) + .annotation(Level::Warning.span(14..38).label("`Z` label")), + ); + + // This should have a `^` but we currently don't support the idea of a + // "primary" annotation, which would solve this + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | / X0 Y0 Z0 +4 | | X1 Y1 Z1 +5 | | X2 Y2 Z2 + | | - + | |____| + | `X` is a good letter + | `Y` is a good letter too + | `Z` label + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn minimum_depth() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(17..27).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(28..44) + .label("`Y` is a good letter too"), + ) + .annotation(Level::Warning.span(36..52).label("`Z`")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:6 + | +3 | X0 Y0 Z0 + | _______^ +4 | | X1 Y1 Z1 + | | ____^_- + | ||____| + | | `X` is a good letter +5 | | X2 Y2 Z2 + | |___-______- `Y` is a good letter too + | ___| + | | +6 | | X3 Y3 Z3 + | |_______- `Z` + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn non_overlapping() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(39..55) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | / X0 Y0 Z0 +4 | | X1 Y1 Z1 + | |____^ `X` is a good letter +5 | X2 Y2 Z2 + | ______- +6 | | X3 Y3 Z3 + | |__________- `Y` is a good letter too + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn overlapping_start_and_end() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 + X2 Y2 Z2 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(17..27).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(31..55) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:6 + | +3 | X0 Y0 Z0 + | _______^ +4 | | X1 Y1 Z1 + | | ____^____- + | ||____| + | | `X` is a good letter +5 | | X2 Y2 Z2 +6 | | X3 Y3 Z3 + | |__________- `Y` is a good letter too + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_primary_without_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(18..25).label("")) + .annotation(Level::Warning.span(14..27).label("`a` is a good letter")) + .annotation(Level::Warning.span(22..23).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:7 + | +3 | a { b { c } d } + | ----^^^^-^^-- `a` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_secondary_without_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("`a` is a good letter")) + .annotation(Level::Warning.span(18..25).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^-------^^ `a` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_primary_without_message_2() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(18..25).label("`b` is a good letter")) + .annotation(Level::Warning.span(14..27).label("")) + .annotation(Level::Warning.span(22..23).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:7 + | +3 | a { b { c } d } + | ----^^^^-^^-- + | | + | `b` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_secondary_without_message_2() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("")) + .annotation(Level::Warning.span(18..25).label("`b` is a good letter")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^-------^^ + | | + | `b` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_secondary_without_message_3() { + let source = r#" +fn foo() { + a bc d +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..18).label("`a` is a good letter")) + .annotation(Level::Warning.span(18..22).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a bc d + | ^^^^---- + | | + | `a` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_without_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("")) + .annotation(Level::Warning.span(18..25).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^-------^^ + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_without_message_2() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(18..25).label("")) + .annotation(Level::Warning.span(14..27).label("")) + .annotation(Level::Warning.span(22..23).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:7 + | +3 | a { b { c } d } + | ----^^^^-^^-- + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn multiple_labels_with_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("`a` is a good letter")) + .annotation(Level::Warning.span(18..25).label("`b` is a good letter")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^-------^^ + | | | + | | `b` is a good letter + | `a` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn ingle_label_with_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("`a` is a good letter")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^^^^^^^^^^ `a` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn single_label_without_message() { + let source = r#" +fn foo() { + a { b { c } d } +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(14..27).label("")), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:3 + | +3 | a { b { c } d } + | ^^^^^^^^^^^^^ + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn long_snippet() { + let source = r#" +fn foo() { + X0 Y0 Z0 + X1 Y1 Z1 +1 +2 +3 +4 +5 +6 +7 +8 +9 +10 + X2 Y2 Z2 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(17..27).label("`X` is a good letter")) + .annotation( + Level::Warning + .span(31..76) + .label("`Y` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:6 + | + 3 | X0 Y0 Z0 + | _______^ + 4 | | X1 Y1 Z1 + | | ____^____- + | ||____| + | | `X` is a good letter + 5 | | 1 +... | +15 | | X2 Y2 Z2 +16 | | X3 Y3 Z3 + | |__________- `Y` is a good letter too + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} +#[test] +fn long_snippet_multiple_spans() { + let source = r#" +fn foo() { + X0 Y0 Z0 +1 +2 +3 + X1 Y1 Z1 +4 +5 +6 + X2 Y2 Z2 +7 +8 +9 +10 + X3 Y3 Z3 +} +"#; + let input = Level::Error.title("foo").snippet( + Snippet::source(source) + .line_start(1) + .origin("test.rs") + .fold(true) + .annotation(Level::Error.span(17..73).label("`Y` is a good letter")) + .annotation( + Level::Warning + .span(37..56) + .label("`Z` is a good letter too"), + ), + ); + + let expected = str![[r#" +error: foo + --> test.rs:3:6 + | + 3 | X0 Y0 Z0 + | _______^ + 4 | | 1 + 5 | | 2 + 6 | | 3 + 7 | | X1 Y1 Z1 + | | _________- + 8 | || 4 + 9 | || 5 +10 | || 6 +11 | || X2 Y2 Z2 + | ||__________- `Z` is a good letter too +12 | | 7 +... | +15 | | 10 +16 | | X3 Y3 Z3 + | |________^ `Y` is a good letter + | +"#]]; + let renderer = Renderer::plain(); + assert_data_eq!(renderer.render(input).to_string(), expected); +} diff --git a/crates/ruff_benchmark/Cargo.toml b/crates/ruff_benchmark/Cargo.toml index c6c8510145d69..b5c2a50a133a0 100644 --- a/crates/ruff_benchmark/Cargo.toml +++ b/crates/ruff_benchmark/Cargo.toml @@ -33,7 +33,7 @@ name = "formatter" harness = false [[bench]] -name = "red_knot" +name = "ty" harness = false [dependencies] @@ -41,10 +41,6 @@ codspeed-criterion-compat = { workspace = true, default-features = false, option criterion = { workspace = true, default-features = false } rayon = { workspace = true } rustc-hash = { workspace = true } -serde = { workspace = true } -serde_json = { workspace = true } -url = { workspace = true } -ureq = { workspace = true } [dev-dependencies] ruff_db = { workspace = true } @@ -53,8 +49,7 @@ ruff_python_ast = { workspace = true } ruff_python_formatter = { workspace = true } ruff_python_parser = { workspace = true } ruff_python_trivia = { workspace = true } -red_knot_python_semantic = { workspace = true } -red_knot_workspace = { workspace = true } +ty_project = { workspace = true } [lints] workspace = true diff --git a/crates/ruff_benchmark/benches/formatter.rs b/crates/ruff_benchmark/benches/formatter.rs index af2b1caa76770..9b445b1dbd048 100644 --- a/crates/ruff_benchmark/benches/formatter.rs +++ b/crates/ruff_benchmark/benches/formatter.rs @@ -1,11 +1,14 @@ use std::path::Path; use ruff_benchmark::criterion::{ - criterion_group, criterion_main, BenchmarkId, Criterion, Throughput, + BenchmarkId, Criterion, Throughput, criterion_group, criterion_main, }; -use ruff_benchmark::{TestCase, TestFile, TestFileDownloadError}; -use ruff_python_formatter::{format_module_ast, PreviewMode, PyFormatOptions}; -use ruff_python_parser::{parse, Mode}; + +use ruff_benchmark::{ + LARGE_DATASET, NUMPY_CTYPESLIB, NUMPY_GLOBALS, PYDANTIC_TYPES, TestCase, UNICODE_PYPINYIN, +}; +use ruff_python_formatter::{PreviewMode, PyFormatOptions, format_module_ast}; +use ruff_python_parser::{Mode, ParseOptions, parse}; use ruff_python_trivia::CommentRanges; #[cfg(target_os = "windows")] @@ -24,27 +27,20 @@ static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc; #[global_allocator] static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc; -fn create_test_cases() -> Result<Vec<TestCase>, TestFileDownloadError> { - Ok(vec![ - TestCase::fast(TestFile::try_download("numpy/globals.py", "https://raw.githubusercontent.com/numpy/numpy/89d64415e349ca75a25250f22b874aa16e5c0973/numpy/_globals.py")?), - TestCase::fast(TestFile::try_download("unicode/pypinyin.py", "https://raw.githubusercontent.com/mozillazg/python-pinyin/9521e47d96e3583a5477f5e43a2e82d513f27a3f/pypinyin/standard.py")?), - TestCase::normal(TestFile::try_download( - "pydantic/types.py", - "https://raw.githubusercontent.com/pydantic/pydantic/83b3c49e99ceb4599d9286a3d793cea44ac36d4b/pydantic/types.py", - )?), - TestCase::normal(TestFile::try_download("numpy/ctypeslib.py", "https://raw.githubusercontent.com/numpy/numpy/e42c9503a14d66adfd41356ef5640c6975c45218/numpy/ctypeslib.py")?), - TestCase::slow(TestFile::try_download( - "large/dataset.py", - "https://raw.githubusercontent.com/DHI/mikeio/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py", - )?), - ]) +fn create_test_cases() -> Vec<TestCase> { + vec![ + TestCase::fast(NUMPY_GLOBALS.clone()), + TestCase::fast(UNICODE_PYPINYIN.clone()), + TestCase::normal(PYDANTIC_TYPES.clone()), + TestCase::normal(NUMPY_CTYPESLIB.clone()), + TestCase::slow(LARGE_DATASET.clone()), + ] } fn benchmark_formatter(criterion: &mut Criterion) { let mut group = criterion.benchmark_group("formatter"); - let test_cases = create_test_cases().unwrap(); - for case in test_cases { + for case in create_test_cases() { group.throughput(Throughput::Bytes(case.code().len() as u64)); group.bench_with_input( @@ -52,8 +48,8 @@ fn benchmark_formatter(criterion: &mut Criterion) { &case, |b, case| { // Parse the source. - let parsed = - parse(case.code(), Mode::Module).expect("Input should be a valid Python code"); + let parsed = parse(case.code(), ParseOptions::from(Mode::Module)) + .expect("Input should be a valid Python code"); let comment_ranges = CommentRanges::from(parsed.tokens()); diff --git a/crates/ruff_benchmark/benches/lexer.rs b/crates/ruff_benchmark/benches/lexer.rs index 64b68a7a3539a..cbba77c78b9e4 100644 --- a/crates/ruff_benchmark/benches/lexer.rs +++ b/crates/ruff_benchmark/benches/lexer.rs @@ -1,8 +1,12 @@ -use ruff_benchmark::criterion::{ - criterion_group, criterion_main, measurement::WallTime, BenchmarkId, Criterion, Throughput, +use ruff_benchmark::criterion; + +use criterion::{ + BenchmarkId, Criterion, Throughput, criterion_group, criterion_main, measurement::WallTime, +}; +use ruff_benchmark::{ + LARGE_DATASET, NUMPY_CTYPESLIB, NUMPY_GLOBALS, PYDANTIC_TYPES, TestCase, UNICODE_PYPINYIN, }; -use ruff_benchmark::{TestCase, TestFile, TestFileDownloadError}; -use ruff_python_parser::{lexer, Mode, TokenKind}; +use ruff_python_parser::{Mode, TokenKind, lexer}; #[cfg(target_os = "windows")] #[global_allocator] @@ -20,24 +24,18 @@ static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc; #[global_allocator] static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc; -fn create_test_cases() -> Result<Vec<TestCase>, TestFileDownloadError> { - Ok(vec![ - TestCase::fast(TestFile::try_download("numpy/globals.py", "https://raw.githubusercontent.com/numpy/numpy/89d64415e349ca75a25250f22b874aa16e5c0973/numpy/_globals.py")?), - TestCase::fast(TestFile::try_download("unicode/pypinyin.py", "https://raw.githubusercontent.com/mozillazg/python-pinyin/9521e47d96e3583a5477f5e43a2e82d513f27a3f/pypinyin/standard.py")?), - TestCase::normal(TestFile::try_download( - "pydantic/types.py", - "https://raw.githubusercontent.com/pydantic/pydantic/83b3c49e99ceb4599d9286a3d793cea44ac36d4b/pydantic/types.py", - )?), - TestCase::normal(TestFile::try_download("numpy/ctypeslib.py", "https://raw.githubusercontent.com/numpy/numpy/e42c9503a14d66adfd41356ef5640c6975c45218/numpy/ctypeslib.py")?), - TestCase::slow(TestFile::try_download( - "large/dataset.py", - "https://raw.githubusercontent.com/DHI/mikeio/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py", - )?), - ]) +fn create_test_cases() -> Vec<TestCase> { + vec![ + TestCase::fast(NUMPY_GLOBALS.clone()), + TestCase::fast(UNICODE_PYPINYIN.clone()), + TestCase::normal(PYDANTIC_TYPES.clone()), + TestCase::normal(NUMPY_CTYPESLIB.clone()), + TestCase::slow(LARGE_DATASET.clone()), + ] } fn benchmark_lexer(criterion: &mut Criterion<WallTime>) { - let test_cases = create_test_cases().unwrap(); + let test_cases = create_test_cases(); let mut group = criterion.benchmark_group("lexer"); for case in test_cases { diff --git a/crates/ruff_benchmark/benches/linter.rs b/crates/ruff_benchmark/benches/linter.rs index eb8667b9e61fd..f90893334b38d 100644 --- a/crates/ruff_benchmark/benches/linter.rs +++ b/crates/ruff_benchmark/benches/linter.rs @@ -1,14 +1,18 @@ -use ruff_benchmark::criterion::{ - criterion_group, criterion_main, BenchmarkGroup, BenchmarkId, Criterion, Throughput, +use ruff_benchmark::criterion; + +use criterion::{ + BenchmarkGroup, BenchmarkId, Criterion, Throughput, criterion_group, criterion_main, +}; +use ruff_benchmark::{ + LARGE_DATASET, NUMPY_CTYPESLIB, NUMPY_GLOBALS, PYDANTIC_TYPES, TestCase, UNICODE_PYPINYIN, }; -use ruff_benchmark::{TestCase, TestFile, TestFileDownloadError}; -use ruff_linter::linter::{lint_only, ParseSource}; +use ruff_linter::linter::{ParseSource, lint_only}; use ruff_linter::rule_selector::PreviewOptions; use ruff_linter::settings::rule_table::RuleTable; use ruff_linter::settings::types::PreviewMode; -use ruff_linter::settings::{flags, LinterSettings}; +use ruff_linter::settings::{LinterSettings, flags}; use ruff_linter::source_kind::SourceKind; -use ruff_linter::{registry::Rule, RuleSelector}; +use ruff_linter::{RuleSelector, registry::Rule}; use ruff_python_ast::PySourceType; use ruff_python_parser::parse_module; @@ -41,29 +45,23 @@ static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc; target_arch = "powerpc64" ) ))] -#[allow(non_upper_case_globals)] -#[export_name = "_rjem_malloc_conf"] -#[allow(unsafe_code)] +#[unsafe(export_name = "_rjem_malloc_conf")] +#[expect(non_upper_case_globals)] +#[expect(unsafe_code)] pub static _rjem_malloc_conf: &[u8] = b"dirty_decay_ms:-1,muzzy_decay_ms:-1\0"; -fn create_test_cases() -> Result<Vec<TestCase>, TestFileDownloadError> { - Ok(vec![ - TestCase::fast(TestFile::try_download("numpy/globals.py", "https://raw.githubusercontent.com/numpy/numpy/89d64415e349ca75a25250f22b874aa16e5c0973/numpy/_globals.py")?), - TestCase::fast(TestFile::try_download("unicode/pypinyin.py", "https://raw.githubusercontent.com/mozillazg/python-pinyin/9521e47d96e3583a5477f5e43a2e82d513f27a3f/pypinyin/standard.py")?), - TestCase::normal(TestFile::try_download( - "pydantic/types.py", - "https://raw.githubusercontent.com/pydantic/pydantic/83b3c49e99ceb4599d9286a3d793cea44ac36d4b/pydantic/types.py", - )?), - TestCase::normal(TestFile::try_download("numpy/ctypeslib.py", "https://raw.githubusercontent.com/numpy/numpy/e42c9503a14d66adfd41356ef5640c6975c45218/numpy/ctypeslib.py")?), - TestCase::slow(TestFile::try_download( - "large/dataset.py", - "https://raw.githubusercontent.com/DHI/mikeio/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py", - )?), - ]) +fn create_test_cases() -> Vec<TestCase> { + vec![ + TestCase::fast(NUMPY_GLOBALS.clone()), + TestCase::fast(UNICODE_PYPINYIN.clone()), + TestCase::normal(PYDANTIC_TYPES.clone()), + TestCase::normal(NUMPY_CTYPESLIB.clone()), + TestCase::slow(LARGE_DATASET.clone()), + ] } fn benchmark_linter(mut group: BenchmarkGroup, settings: &LinterSettings) { - let test_cases = create_test_cases().unwrap(); + let test_cases = create_test_cases(); for case in test_cases { group.throughput(Throughput::Bytes(case.code().len() as u64)); @@ -91,7 +89,7 @@ fn benchmark_linter(mut group: BenchmarkGroup, settings: &LinterSettings) { ); // Assert that file contains no parse errors - assert!(!result.has_syntax_error); + assert!(!result.has_syntax_errors()); }, criterion::BatchSize::SmallInput, ); diff --git a/crates/ruff_benchmark/benches/parser.rs b/crates/ruff_benchmark/benches/parser.rs index ec2fa671c1df0..ac648aabc48c0 100644 --- a/crates/ruff_benchmark/benches/parser.rs +++ b/crates/ruff_benchmark/benches/parser.rs @@ -1,9 +1,13 @@ -use ruff_benchmark::criterion::{ - criterion_group, criterion_main, measurement::WallTime, BenchmarkId, Criterion, Throughput, +use ruff_benchmark::criterion; + +use criterion::{ + BenchmarkId, Criterion, Throughput, criterion_group, criterion_main, measurement::WallTime, +}; +use ruff_benchmark::{ + LARGE_DATASET, NUMPY_CTYPESLIB, NUMPY_GLOBALS, PYDANTIC_TYPES, TestCase, UNICODE_PYPINYIN, }; -use ruff_benchmark::{TestCase, TestFile, TestFileDownloadError}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; use ruff_python_ast::Stmt; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_parser::parse_module; #[cfg(target_os = "windows")] @@ -22,20 +26,14 @@ static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc; #[global_allocator] static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc; -fn create_test_cases() -> Result<Vec<TestCase>, TestFileDownloadError> { - Ok(vec![ - TestCase::fast(TestFile::try_download("numpy/globals.py", "https://raw.githubusercontent.com/numpy/numpy/89d64415e349ca75a25250f22b874aa16e5c0973/numpy/_globals.py")?), - TestCase::fast(TestFile::try_download("unicode/pypinyin.py", "https://raw.githubusercontent.com/mozillazg/python-pinyin/9521e47d96e3583a5477f5e43a2e82d513f27a3f/pypinyin/standard.py")?), - TestCase::normal(TestFile::try_download( - "pydantic/types.py", - "https://raw.githubusercontent.com/pydantic/pydantic/83b3c49e99ceb4599d9286a3d793cea44ac36d4b/pydantic/types.py", - )?), - TestCase::normal(TestFile::try_download("numpy/ctypeslib.py", "https://raw.githubusercontent.com/numpy/numpy/e42c9503a14d66adfd41356ef5640c6975c45218/numpy/ctypeslib.py")?), - TestCase::slow(TestFile::try_download( - "large/dataset.py", - "https://raw.githubusercontent.com/DHI/mikeio/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py", - )?), - ]) +fn create_test_cases() -> Vec<TestCase> { + vec![ + TestCase::fast(NUMPY_GLOBALS.clone()), + TestCase::fast(UNICODE_PYPINYIN.clone()), + TestCase::normal(PYDANTIC_TYPES.clone()), + TestCase::normal(NUMPY_CTYPESLIB.clone()), + TestCase::slow(LARGE_DATASET.clone()), + ] } struct CountVisitor { @@ -50,7 +48,7 @@ impl<'a> StatementVisitor<'a> for CountVisitor { } fn benchmark_parser(criterion: &mut Criterion<WallTime>) { - let test_cases = create_test_cases().unwrap(); + let test_cases = create_test_cases(); let mut group = criterion.benchmark_group("parser"); for case in test_cases { diff --git a/crates/ruff_benchmark/benches/red_knot.rs b/crates/ruff_benchmark/benches/red_knot.rs deleted file mode 100644 index 795c333d7f8e3..0000000000000 --- a/crates/ruff_benchmark/benches/red_knot.rs +++ /dev/null @@ -1,181 +0,0 @@ -#![allow(clippy::disallowed_names)] - -use rayon::ThreadPoolBuilder; -use red_knot_python_semantic::PythonVersion; -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::watch::{ChangeEvent, ChangedKind}; -use red_knot_workspace::workspace::settings::Configuration; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_benchmark::criterion::{criterion_group, criterion_main, BatchSize, Criterion}; -use ruff_benchmark::TestFile; -use ruff_db::files::{system_path_to_file, File}; -use ruff_db::source::source_text; -use ruff_db::system::{MemoryFileSystem, SystemPath, SystemPathBuf, TestSystem}; -use rustc_hash::FxHashSet; - -struct Case { - db: RootDatabase, - fs: MemoryFileSystem, - re: File, - re_path: SystemPathBuf, -} - -const TOMLLIB_312_URL: &str = "https://raw.githubusercontent.com/python/cpython/8e8a4baf652f6e1cee7acde9d78c4b6154539748/Lib/tomllib"; - -static EXPECTED_DIAGNOSTICS: &[&str] = &[ - // We don't support `ModuleType`-attributes as globals yet: - "/src/tomllib/__init__.py:10:30: Name `__name__` used when not defined", - // We don't support `*` imports yet: - "/src/tomllib/_parser.py:7:29: Module `collections.abc` has no member `Iterable`", - // We don't support terminal statements in control flow yet: - "/src/tomllib/_parser.py:66:18: Name `s` used when possibly not defined", - "/src/tomllib/_parser.py:98:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:101:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:104:14: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:108:17: Conflicting declared types for `second_char`: Unknown, str | None", - "/src/tomllib/_parser.py:115:14: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:126:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:267:9: Conflicting declared types for `char`: Unknown, str | None", - "/src/tomllib/_parser.py:348:20: Name `nest` used when possibly not defined", - "/src/tomllib/_parser.py:353:5: Name `nest` used when possibly not defined", - "/src/tomllib/_parser.py:353:5: Method `__getitem__` of type `Unbound | @Todo` is not callable on object of type `Unbound | @Todo`", - "/src/tomllib/_parser.py:364:9: Conflicting declared types for `char`: Unknown, str | None", - "/src/tomllib/_parser.py:381:13: Conflicting declared types for `char`: Unknown, str | None", - "/src/tomllib/_parser.py:395:9: Conflicting declared types for `char`: Unknown, str | None", - "/src/tomllib/_parser.py:453:24: Name `nest` used when possibly not defined", - "/src/tomllib/_parser.py:455:9: Name `nest` used when possibly not defined", - "/src/tomllib/_parser.py:455:9: Method `__getitem__` of type `Unbound | @Todo` is not callable on object of type `Unbound | @Todo`", - "/src/tomllib/_parser.py:482:16: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:566:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:573:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:579:12: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:580:63: Name `char` used when possibly not defined", - "/src/tomllib/_parser.py:590:9: Conflicting declared types for `char`: Unknown, str | None", - "/src/tomllib/_parser.py:629:38: Name `datetime_obj` used when possibly not defined", -]; - -fn get_test_file(name: &str) -> TestFile { - let path = format!("tomllib/{name}"); - let url = format!("{TOMLLIB_312_URL}/{name}"); - TestFile::try_download(&path, &url).unwrap() -} - -fn tomllib_path(filename: &str) -> SystemPathBuf { - SystemPathBuf::from(format!("/src/tomllib/{filename}").as_str()) -} - -fn setup_case() -> Case { - let system = TestSystem::default(); - let fs = system.memory_file_system().clone(); - - let tomllib_filenames = ["__init__.py", "_parser.py", "_re.py", "_types.py"]; - fs.write_files(tomllib_filenames.iter().map(|filename| { - ( - tomllib_path(filename), - get_test_file(filename).code().to_string(), - ) - })) - .unwrap(); - - let src_root = SystemPath::new("/src"); - let metadata = WorkspaceMetadata::from_path( - src_root, - &system, - Some(Configuration { - target_version: Some(PythonVersion::PY312), - ..Configuration::default() - }), - ) - .unwrap(); - - let mut db = RootDatabase::new(metadata, system).unwrap(); - - let tomllib_files: FxHashSet<File> = tomllib_filenames - .iter() - .map(|filename| system_path_to_file(&db, tomllib_path(filename)).unwrap()) - .collect(); - db.workspace().set_open_files(&mut db, tomllib_files); - - let re_path = tomllib_path("_re.py"); - let re = system_path_to_file(&db, &re_path).unwrap(); - Case { - db, - fs, - re, - re_path, - } -} - -static RAYON_INITIALIZED: std::sync::Once = std::sync::Once::new(); - -fn setup_rayon() { - // Initialize the rayon thread pool outside the benchmark because it has a significant cost. - // We limit the thread pool to only one (the current thread) because we're focused on - // where red knot spends time and less about how well the code runs concurrently. - // We might want to add a benchmark focusing on concurrency to detect congestion in the future. - RAYON_INITIALIZED.call_once(|| { - ThreadPoolBuilder::new() - .num_threads(1) - .use_current_thread() - .build_global() - .unwrap(); - }); -} - -fn benchmark_incremental(criterion: &mut Criterion) { - setup_rayon(); - - criterion.bench_function("red_knot_check_file[incremental]", |b| { - b.iter_batched_ref( - || { - let case = setup_case(); - case.db.check().unwrap(); - - case.fs - .write_file( - &case.re_path, - format!("{}\n# A comment\n", source_text(&case.db, case.re).as_str()), - ) - .unwrap(); - - case - }, - |case| { - let Case { db, .. } = case; - - db.apply_changes( - vec![ChangeEvent::Changed { - path: case.re_path.clone(), - kind: ChangedKind::FileContent, - }], - None, - ); - - let result = db.check().unwrap(); - - assert_eq!(result, EXPECTED_DIAGNOSTICS); - }, - BatchSize::SmallInput, - ); - }); -} - -fn benchmark_cold(criterion: &mut Criterion) { - setup_rayon(); - - criterion.bench_function("red_knot_check_file[cold]", |b| { - b.iter_batched_ref( - setup_case, - |case| { - let Case { db, .. } = case; - let result = db.check().unwrap(); - - assert_eq!(result, EXPECTED_DIAGNOSTICS); - }, - BatchSize::SmallInput, - ); - }); -} - -criterion_group!(check_file, benchmark_cold, benchmark_incremental); -criterion_main!(check_file); diff --git a/crates/ruff_benchmark/benches/ty.rs b/crates/ruff_benchmark/benches/ty.rs new file mode 100644 index 0000000000000..bd5fdaa026b5b --- /dev/null +++ b/crates/ruff_benchmark/benches/ty.rs @@ -0,0 +1,356 @@ +#![allow(clippy::disallowed_names)] +use ruff_benchmark::criterion; + +use std::ops::Range; + +use criterion::{BatchSize, Criterion, criterion_group, criterion_main}; +use rayon::ThreadPoolBuilder; +use rustc_hash::FxHashSet; + +use ruff_benchmark::TestFile; +use ruff_db::diagnostic::{Diagnostic, DiagnosticId, Severity}; +use ruff_db::files::{File, system_path_to_file}; +use ruff_db::source::source_text; +use ruff_db::system::{MemoryFileSystem, SystemPath, SystemPathBuf, TestSystem}; +use ruff_python_ast::PythonVersion; +use ty_project::metadata::options::{EnvironmentOptions, Options}; +use ty_project::metadata::value::RangedValue; +use ty_project::watch::{ChangeEvent, ChangedKind}; +use ty_project::{Db, ProjectDatabase, ProjectMetadata}; + +struct Case { + db: ProjectDatabase, + fs: MemoryFileSystem, + file: File, + file_path: SystemPathBuf, +} + +// "https://raw.githubusercontent.com/python/cpython/8e8a4baf652f6e1cee7acde9d78c4b6154539748/Lib/tomllib"; +static TOMLLIB_FILES: [TestFile; 4] = [ + TestFile::new( + "tomllib/__init__.py", + include_str!("../resources/tomllib/__init__.py"), + ), + TestFile::new( + "tomllib/_parser.py", + include_str!("../resources/tomllib/_parser.py"), + ), + TestFile::new( + "tomllib/_re.py", + include_str!("../resources/tomllib/_re.py"), + ), + TestFile::new( + "tomllib/_types.py", + include_str!("../resources/tomllib/_types.py"), + ), +]; + +/// A structured set of fields we use to do diagnostic comparisons. +/// +/// This helps assert benchmark results. Previously, we would compare +/// the actual diagnostic output, but using `insta` inside benchmarks is +/// problematic, and updating the strings otherwise when diagnostic rendering +/// changes is a PITA. +type KeyDiagnosticFields = ( + DiagnosticId, + Option<&'static str>, + Option<Range<usize>>, + &'static str, + Severity, +); + +static EXPECTED_TOMLLIB_DIAGNOSTICS: &[KeyDiagnosticFields] = &[]; + +fn tomllib_path(file: &TestFile) -> SystemPathBuf { + SystemPathBuf::from("src").join(file.name()) +} + +fn setup_tomllib_case() -> Case { + let system = TestSystem::default(); + let fs = system.memory_file_system().clone(); + + fs.write_files_all( + TOMLLIB_FILES + .iter() + .map(|file| (tomllib_path(file), file.code().to_string())), + ) + .unwrap(); + + let src_root = SystemPath::new("/src"); + let mut metadata = ProjectMetadata::discover(src_root, &system).unwrap(); + metadata.apply_cli_options(Options { + environment: Some(EnvironmentOptions { + python_version: Some(RangedValue::cli(PythonVersion::PY312)), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + let mut db = ProjectDatabase::new(metadata, system).unwrap(); + let mut tomllib_files = FxHashSet::default(); + let mut re: Option<File> = None; + + for test_file in &TOMLLIB_FILES { + let file = system_path_to_file(&db, tomllib_path(test_file)).unwrap(); + if test_file.name().ends_with("_re.py") { + re = Some(file); + } + tomllib_files.insert(file); + } + + let re = re.unwrap(); + + db.project().set_open_files(&mut db, tomllib_files); + + let re_path = re.path(&db).as_system_path().unwrap().to_owned(); + Case { + db, + fs, + file: re, + file_path: re_path, + } +} + +static RAYON_INITIALIZED: std::sync::Once = std::sync::Once::new(); + +fn setup_rayon() { + // Initialize the rayon thread pool outside the benchmark because it has a significant cost. + // We limit the thread pool to only one (the current thread) because we're focused on + // where ty spends time and less about how well the code runs concurrently. + // We might want to add a benchmark focusing on concurrency to detect congestion in the future. + RAYON_INITIALIZED.call_once(|| { + ThreadPoolBuilder::new() + .num_threads(1) + .use_current_thread() + .build_global() + .unwrap(); + }); +} + +fn benchmark_incremental(criterion: &mut Criterion) { + fn setup() -> Case { + let case = setup_tomllib_case(); + + let result: Vec<_> = case.db.check().unwrap(); + + assert_diagnostics(&case.db, &result, EXPECTED_TOMLLIB_DIAGNOSTICS); + + case.fs + .write_file_all( + &case.file_path, + format!( + "{}\n# A comment\n", + source_text(&case.db, case.file).as_str() + ), + ) + .unwrap(); + + case + } + + fn incremental(case: &mut Case) { + let Case { db, .. } = case; + + db.apply_changes( + vec![ChangeEvent::Changed { + path: case.file_path.clone(), + kind: ChangedKind::FileContent, + }], + None, + ); + + let result = db.check().unwrap(); + + assert_eq!(result.len(), EXPECTED_TOMLLIB_DIAGNOSTICS.len()); + } + + setup_rayon(); + + criterion.bench_function("ty_check_file[incremental]", |b| { + b.iter_batched_ref(setup, incremental, BatchSize::SmallInput); + }); +} + +fn benchmark_cold(criterion: &mut Criterion) { + setup_rayon(); + + criterion.bench_function("ty_check_file[cold]", |b| { + b.iter_batched_ref( + setup_tomllib_case, + |case| { + let Case { db, .. } = case; + let result: Vec<_> = db.check().unwrap(); + + assert_diagnostics(db, &result, EXPECTED_TOMLLIB_DIAGNOSTICS); + }, + BatchSize::SmallInput, + ); + }); +} + +#[track_caller] +fn assert_diagnostics(db: &dyn Db, diagnostics: &[Diagnostic], expected: &[KeyDiagnosticFields]) { + let normalized: Vec<_> = diagnostics + .iter() + .map(|diagnostic| { + ( + diagnostic.id(), + diagnostic + .primary_span() + .map(|span| span.expect_ty_file()) + .map(|file| file.path(db).as_str()), + diagnostic + .primary_span() + .and_then(|span| span.range()) + .map(Range::<usize>::from), + diagnostic.primary_message(), + diagnostic.severity(), + ) + }) + .collect(); + assert_eq!(&normalized, expected); +} + +fn setup_micro_case(code: &str) -> Case { + let system = TestSystem::default(); + let fs = system.memory_file_system().clone(); + + let file_path = "src/test.py"; + fs.write_file_all( + SystemPathBuf::from(file_path), + ruff_python_trivia::textwrap::dedent(code), + ) + .unwrap(); + + let src_root = SystemPath::new("/src"); + let mut metadata = ProjectMetadata::discover(src_root, &system).unwrap(); + metadata.apply_cli_options(Options { + environment: Some(EnvironmentOptions { + python_version: Some(RangedValue::cli(PythonVersion::PY312)), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + let mut db = ProjectDatabase::new(metadata, system).unwrap(); + let file = system_path_to_file(&db, SystemPathBuf::from(file_path)).unwrap(); + + db.project() + .set_open_files(&mut db, FxHashSet::from_iter([file])); + + let file_path = file.path(&db).as_system_path().unwrap().to_owned(); + + Case { + db, + fs, + file, + file_path, + } +} + +fn benchmark_many_string_assignments(criterion: &mut Criterion) { + setup_rayon(); + + criterion.bench_function("ty_micro[many_string_assignments]", |b| { + b.iter_batched_ref( + || { + // This is a micro benchmark, but it is effectively identical to a code sample + // observed "in the wild": + setup_micro_case( + r#" + def f(x) -> str: + s = "" + # Each conditional doubles the size of the union of string literal types, + # so if we go up to attr10, we have 2**10 = 1024 string literal types + if x.attr1: + s += "attr1" + if x.attr2: + s += "attr2" + if x.attr3: + s += "attr3" + if x.attr4: + s += "attr4" + if x.attr5: + s += "attr5" + if x.attr6: + s += "attr6" + if x.attr7: + s += "attr7" + if x.attr8: + s += "attr8" + if x.attr9: + s += "attr9" + if x.attr10: + s += "attr10" + # The above checked how fast we are in building the union; this checks how + # we manage it once it is built. If implemented naively, this has to check + # each member of the union for compatibility with the Sized protocol. + if len(s) > 0: + s = s[:-3] + return s + "#, + ) + }, + |case| { + let Case { db, .. } = case; + let result = db.check().unwrap(); + assert_eq!(result.len(), 0); + }, + BatchSize::SmallInput, + ); + }); +} + +fn benchmark_many_tuple_assignments(criterion: &mut Criterion) { + setup_rayon(); + + criterion.bench_function("ty_micro[many_tuple_assignments]", |b| { + b.iter_batched_ref( + || { + // This is a micro benchmark, but it is effectively identical to a code sample + // observed in https://github.com/astral-sh/ty/issues/362 + setup_micro_case( + r#" + def flag() -> bool: + return True + + t = () + if flag(): + t += (1,) + if flag(): + t += (2,) + if flag(): + t += (3,) + if flag(): + t += (4,) + if flag(): + t += (5,) + if flag(): + t += (6,) + if flag(): + t += (7,) + if flag(): + t += (8,) + + # Perform some kind of operation on the union type + print(1 in t) + "#, + ) + }, + |case| { + let Case { db, .. } = case; + let result = db.check().unwrap(); + assert_eq!(result.len(), 0); + }, + BatchSize::SmallInput, + ); + }); +} + +criterion_group!(check_file, benchmark_cold, benchmark_incremental); +criterion_group!( + micro, + benchmark_many_string_assignments, + benchmark_many_tuple_assignments +); +criterion_main!(check_file, micro); diff --git a/crates/ruff_benchmark/resources/README.md b/crates/ruff_benchmark/resources/README.md new file mode 100644 index 0000000000000..4a40a70ee5f45 --- /dev/null +++ b/crates/ruff_benchmark/resources/README.md @@ -0,0 +1,16 @@ +This directory vendors some files from actual projects. +This is to benchmark Ruff's performance against real-world +code instead of synthetic benchmarks. + +The following files are included: + +* [`numpy/globals`](https://github.com/numpy/numpy/blob/89d64415e349ca75a25250f22b874aa16e5c0973/numpy/_globals.py) +* [`numpy/ctypeslib.py`](https://github.com/numpy/numpy/blob/e42c9503a14d66adfd41356ef5640c6975c45218/numpy/ctypeslib.py) +* [`pypinyin.py`](https://github.com/mozillazg/python-pinyin/blob/9521e47d96e3583a5477f5e43a2e82d513f27a3f/pypinyin/standard.py) +* [`pydantic/types.py`](https://github.com/pydantic/pydantic/blob/83b3c49e99ceb4599d9286a3d793cea44ac36d4b/pydantic/types.py) +* [`large/dataset.py`](https://github.com/DHI/mikeio/blob/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py) +* [`tomllib`](https://github.com/python/cpython/tree/8e8a4baf652f6e1cee7acde9d78c4b6154539748/Lib/tomllib) (3.12) + +The files are included in the `resources` directory to allow +running benchmarks offline and for simplicity. They're licensed +according to their original licenses (see link). diff --git a/crates/ruff_benchmark/resources/large/dataset.py b/crates/ruff_benchmark/resources/large/dataset.py new file mode 100644 index 0000000000000..2e011dcbfca12 --- /dev/null +++ b/crates/ruff_benchmark/resources/large/dataset.py @@ -0,0 +1,1617 @@ +import os +from datetime import datetime +import numpy as np +import pandas as pd +import pytest + +import mikeio +from mikeio.eum import EUMType, ItemInfo, EUMUnit +from mikeio.exceptions import OutsideModelDomainError + + +@pytest.fixture +def ds1(): + nt = 10 + ne = 7 + + d1 = np.zeros([nt, ne]) + 0.1 + d2 = np.zeros([nt, ne]) + 0.2 + data = [d1, d2] + + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + return mikeio.Dataset( + data=data, time=time, items=items, geometry=mikeio.Grid1D(nx=7, dx=1) + ) + + +@pytest.fixture +def ds2(): + nt = 10 + ne = 7 + + d1 = np.zeros([nt, ne]) + 1.0 + d2 = np.zeros([nt, ne]) + 2.0 + data = [d1, d2] + + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + return mikeio.Dataset(data, time, items) + + +@pytest.fixture +def ds3(): + + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + d3 = np.zeros([nt, 100, 30]) + 3.0 + + data = [d1, d2, d3] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo(x) for x in ["Foo", "Bar", "Baz"]] + return mikeio.Dataset(data, time, items) + + +def test_create_wrong_data_type_error(): + + data = ["item 1", "item 2"] + + nt = 2 + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + + with pytest.raises(TypeError, match="numpy"): + mikeio.Dataset(data=data, time=time) + + +def test_get_names(): + + nt = 100 + d = np.zeros([nt, 100, 30]) + 1.0 + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + data_vars = {"Foo": mikeio.DataArray(data=d, time=time, item=ItemInfo(name="Foo"))} + + ds = mikeio.Dataset(data_vars) + + assert ds["Foo"].name == "Foo" + assert ds["Foo"].type == EUMType.Undefined + assert repr(ds["Foo"].unit) == "undefined" + assert ds.names == ["Foo"] + + +def test_properties(ds1): + nt = 10 + ne = 7 + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + + assert ds1.names == ["Foo", "Bar"] + assert ds1.n_items == 2 + + assert np.all(ds1.time == time) + assert ds1.n_timesteps == nt + assert ds1.timestep == 1 + assert ds1.start_time == time[0] + assert ds1.end_time == time[-1] + + assert ds1.shape == (nt, ne) + assert ds1.dims == ("time", "x") + assert ds1.geometry.nx == 7 + assert ds1._zn is None + + # assert not hasattr(ds1, "keys") # TODO: remove this + # assert not hasattr(ds1, "values") # TODO: remove this + assert isinstance(ds1.items[0], ItemInfo) + + +def test_pop(ds1): + da = ds1.pop("Foo") + assert len(ds1) == 1 + assert ds1.names == ["Bar"] + assert isinstance(da, mikeio.DataArray) + assert da.name == "Foo" + + ds1["Foo2"] = da # re-insert + assert len(ds1) == 2 + + da = ds1.pop(-1) + assert len(ds1) == 1 + assert ds1.names == ["Bar"] + assert isinstance(da, mikeio.DataArray) + assert da.name == "Foo2" + + +def test_popitem(ds1): + da = ds1.popitem() + assert len(ds1) == 1 + assert ds1.names == ["Bar"] + assert isinstance(da, mikeio.DataArray) + assert da.name == "Foo" + + +def test_insert(ds1): + da = ds1[0].copy() + da.name = "Baz" + + ds1.insert(2, da) + assert len(ds1) == 3 + assert ds1.names == ["Foo", "Bar", "Baz"] + assert ds1[-1] == da + + +def test_insert_wrong_type(ds1): + + with pytest.raises(ValueError): + ds1["Foo"] = "Bar" + + +def test_insert_fail(ds1): + da = ds1[0] + with pytest.raises(ValueError, match="Cannot add the same object"): + ds1.insert(2, da) + + vals = ds1[0].values + da = ds1[0].copy() + da.values = vals + with pytest.raises(ValueError, match="refer to the same data"): + ds1.insert(2, da) + + +def test_remove(ds1): + ds1.remove(-1) + assert len(ds1) == 1 + assert ds1.names == ["Foo"] + + ds1.remove("Foo") + assert len(ds1) == 0 + + +def test_index_with_attribute(): + + nt = 10000 + d = np.zeros([nt, 100, 30]) + 1.0 + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + + # We cannot create a mikeio.Dataset with multiple references to the same DataArray + da = mikeio.DataArray(data=d, time=time) + data = [da, da] + with pytest.raises(ValueError): + mikeio.Dataset(data) + + # We cannot create a mikeio.Dataset with multiple references to the same data + da1 = mikeio.DataArray(item="Foo", data=d, time=time) + da2 = mikeio.DataArray(item="Bar", data=d, time=time) + data = [da1, da2] + with pytest.raises(ValueError): + mikeio.Dataset(data) + + da1 = mikeio.DataArray(item="Foo", data=d, time=time) + da2 = mikeio.DataArray(item="Bar", data=d.copy(), time=time) + data = [da1, da2] + ds = mikeio.Dataset(data) + assert ds["Foo"].name == "Foo" + assert ds.Bar.name == "Bar" + + assert ds["Foo"] is ds.Foo # This is the same object + + ds["Foo"] = ds.Foo + 2.0 + assert ( + ds["Foo"] is ds.Foo + ) # This is now modified, but both methods points to the same object + + +def test_getitem_time(ds3): + # time = pd.date_range("2000-1-2", freq="H", periods=100) + ds_sel = ds3["2000-1-2"] + assert ds_sel.n_timesteps == 24 + assert ds_sel.is_equidistant + + ds_sel = ds3["2000-1-2":"2000-1-3 00:00"] + assert ds_sel.n_timesteps == 25 + assert ds_sel.is_equidistant + + time = ["2000-1-2 04:00:00", "2000-1-2 08:00:00", "2000-1-2 12:00:00"] + ds_sel = ds3[time] + assert ds_sel.n_timesteps == 3 + assert ds_sel.is_equidistant + + time = [ds3.time[0], ds3.time[1], ds3.time[7], ds3.time[23]] + ds_sel = ds3[time] + assert ds_sel.n_timesteps == 4 + assert not ds_sel.is_equidistant + + ds_sel = ds3[ds3.time[:10]] + assert ds_sel.n_timesteps == 10 + assert ds_sel.is_equidistant + + +def test_getitem_multi_indexing_attempted(ds3): + with pytest.raises(TypeError, match="not allow multi-index"): + ds3[0, 0] + with pytest.warns(Warning, match="ambiguity"): + ds3[0, 1] # indistinguishable from ds3[(0,1)] + with pytest.raises(TypeError, match="not allow multi-index"): + ds3[:, 1] + with pytest.raises(TypeError, match="not allow multi-index"): + ds3[-1, [0, 1], 1] + + +def test_select_subset_isel(): + + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + d1[0, 10, :] = 2.0 + d2[0, 10, :] = 3.0 + + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + + geometry = mikeio.Grid2D(nx=30, ny=100, bbox=[0, 0, 1, 1]) + + data = { + "Foo": mikeio.DataArray( + data=d1, time=time, geometry=geometry, item=ItemInfo("Foo") + ), + "Bar": mikeio.DataArray( + data=d2, time=time, geometry=geometry, item=ItemInfo("Bar") + ), + } + + ds = mikeio.Dataset(data) + + selds = ds.isel(10, axis=1) + + assert len(selds.items) == 2 + assert len(selds.to_numpy()) == 2 + assert selds["Foo"].shape == (100, 30) + assert selds["Foo"].to_numpy()[0, 0] == 2.0 + assert selds["Bar"].to_numpy()[0, 0] == 3.0 + + selds_named_axis = ds.isel(10, axis="y") + + assert len(selds_named_axis.items) == 2 + assert selds_named_axis["Foo"].shape == (100, 30) + + +def test_select_subset_isel_axis_out_of_range_error(ds2): + + assert len(ds2.shape) == 2 + dss = ds2.isel(idx=0) + + # After subsetting there is only one dimension + assert len(dss.shape) == 1 + + with pytest.raises(IndexError): + dss.isel(idx=0, axis=1) + + +def test_isel_named_axis(ds2: mikeio.Dataset): + dss = ds2.isel(time=0) + assert len(dss.shape) == 1 + + +def test_select_temporal_subset_by_idx(): + + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + d1[0, 10, :] = 2.0 + d2[0, 10, :] = 3.0 + data = [d1, d2] + + time = pd.date_range(start=datetime(2000, 1, 1), freq="S", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + selds = ds.isel([0, 1, 2], axis=0) + + assert len(selds) == 2 + assert selds["Foo"].shape == (3, 100, 30) + + +def test_temporal_subset_fancy(): + + nt = (24 * 31) + 1 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + data = [d1, d2] + + time = pd.date_range("2000-1-1", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + assert ds.time[0].hour == 0 + assert ds.time[-1].hour == 0 + + selds = ds["2000-01-01 00:00":"2000-01-02 00:00"] + + assert len(selds) == 2 + assert selds["Foo"].shape == (25, 100, 30) + + selds = ds[:"2000-01-02 00:00"] + assert selds["Foo"].shape == (25, 100, 30) + + selds = ds["2000-01-31 00:00":] + assert selds["Foo"].shape == (25, 100, 30) + + selds = ds["2000-01-30":] + assert selds["Foo"].shape == (49, 100, 30) + + +def test_subset_with_datetime(): + nt = (24 * 31) + 1 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + dssub = ds[datetime(2000, 1, 2)] + assert dssub.n_timesteps == 1 + + dssub = ds[pd.Timestamp(datetime(2000, 1, 2))] + assert dssub.n_timesteps == 1 + + dssub = ds["2000-1-2"] + assert dssub.n_timesteps == 24 + + +def test_select_item_by_name(): + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + d1[0, 10, :] = 2.0 + d2[0, 10, :] = 3.0 + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + foo_data = ds["Foo"] + assert foo_data.to_numpy()[0, 10, 0] == 2.0 + + +def test_missing_item_error(): + nt = 100 + + da1 = mikeio.DataArray( + data=np.zeros(nt), + time=pd.date_range("2000-1-2", freq="H", periods=nt), + item="Foo", + ) + + da2 = mikeio.DataArray( + data=np.ones(nt), + time=pd.date_range("2000-1-2", freq="H", periods=nt), + item="Bar", + ) + + ds = mikeio.Dataset([da1, da2]) + + with pytest.raises(KeyError, match="Baz"): + ds["Baz"] # there is no Bar item + + +def test_select_multiple_items_by_name(): + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + d3 = np.zeros([nt, 100, 30]) + 3.0 + + data = [d1, d2, d3] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + # items = [ItemInfo("Foo"), ItemInfo("Bar"), ItemInfo("Baz")] + items = [ItemInfo(x) for x in ["Foo", "Bar", "Baz"]] + ds = mikeio.Dataset(data, time, items) + + assert len(ds) == 3 # Length of a dataset is the number of items + + newds = ds[["Baz", "Foo"]] + assert newds.items[0].name == "Baz" + assert newds.items[1].name == "Foo" + assert newds["Foo"].to_numpy()[0, 10, 0] == 1.5 + + assert len(newds) == 2 + + +def test_select_multiple_items_by_index(ds3): + assert len(ds3) == 3 # Length of a dataset is the number of items + + newds = ds3[[2, 0]] + assert len(newds) == 2 + assert newds.items[0].name == "Baz" + assert newds.items[1].name == "Foo" + assert newds["Foo"].to_numpy()[0, 10, 0] == 1.5 + + +def test_select_multiple_items_by_slice(ds3): + assert len(ds3) == 3 # Length of a dataset is the number of items + + newds = ds3[:2] + assert len(newds) == 2 + assert newds.items[0].name == "Foo" + assert newds.items[1].name == "Bar" + assert newds["Foo"].to_numpy()[0, 10, 0] == 1.5 + + +def test_select_item_by_iteminfo(): + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + d1[0, 10, :] = 2.0 + d2[0, 10, :] = 3.0 + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + foo_item = items[0] + + foo_data = ds[foo_item] + assert foo_data.to_numpy()[0, 10, 0] == 2.0 + + +def test_select_subset_isel_multiple_idxs(): + + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + selds = ds.isel([10, 15], axis=1) + + assert len(selds.items) == 2 + assert len(selds.to_numpy()) == 2 + assert selds["Foo"].shape == (100, 2, 30) + + +def test_decribe(ds1): + df = ds1.describe() + assert df.columns[0] == "Foo" + assert df.loc["mean"][1] == pytest.approx(0.2) + assert df.loc["max"][0] == pytest.approx(0.1) + + +def test_create_undefined(): + + nt = 100 + d1 = np.zeros([nt]) + d2 = np.zeros([nt]) + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + data = { + "Item 1": mikeio.DataArray( + data=d1, time=time, item=ItemInfo("Item 1") + ), # TODO redundant name + "Item 2": mikeio.DataArray(data=d2, time=time, item=ItemInfo("Item 2")), + } + + ds = mikeio.Dataset(data) + + assert len(ds.items) == 2 + assert len(ds.to_numpy()) == 2 + assert ds[0].name == "Item 1" + assert ds[0].type == EUMType.Undefined + + +def test_create_named_undefined(): + + nt = 100 + d1 = np.zeros([nt]) + d2 = np.zeros([nt]) + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + ds = mikeio.Dataset(data=data, time=time, items=["Foo", "Bar"]) + + assert len(ds.items) == 2 + assert len(ds.to_numpy()) == 2 + assert ds[1].name == "Bar" + assert ds[1].type == EUMType.Undefined + + +def test_to_dataframe_single_timestep(): + + nt = 1 + d1 = np.zeros([nt]) + d2 = np.zeros([nt]) + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + df = ds.to_dataframe() + + assert "Bar" in df.columns + # assert isinstance(df.index, pd.DatetimeIndex) + + +def test_to_dataframe(): + + nt = 100 + d1 = np.zeros([nt]) + d2 = np.zeros([nt]) + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + df = ds.to_dataframe() + + assert list(df.columns) == ["Foo", "Bar"] + assert isinstance(df.index, pd.DatetimeIndex) + + +def test_multidimensional_to_dataframe_no_supported(): + + nt = 100 + d1 = np.zeros([nt, 2]) + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset([d1], time, items) + + with pytest.raises(ValueError): + ds.to_dataframe() + + +def test_get_data(): + + data = [] + nt = 100 + d = np.zeros([nt, 100, 30]) + 1.0 + data.append(d) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + assert ds.shape == (100, 100, 30) + + +def test_interp_time(): + + nt = 4 + d = np.zeros([nt, 10, 3]) + d[1] = 2.0 + d[3] = 4.0 + data = [d] + time = pd.date_range("2000-1-1", freq="D", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + assert ds[0].shape == (nt, 10, 3) + + dsi = ds.interp_time(dt=3600) + + assert ds.time[0] == dsi.time[0] + assert dsi[0].shape == (73, 10, 3) + + dsi2 = ds.interp_time(freq="2H") + assert dsi2.timestep == 2 * 3600 + + +def test_interp_time_to_other_dataset(): + + # Arrange + ## mikeio.Dataset 1 + nt = 4 + data = [np.zeros([nt, 10, 3])] + time = pd.date_range("2000-1-1", freq="D", periods=nt) + items = [ItemInfo("Foo")] + ds1 = mikeio.Dataset(data, time, items) + assert ds1.shape == (nt, 10, 3) + + ## mikeio.Dataset 2 + nt = 12 + data = [np.ones([nt, 10, 3])] + time = pd.date_range("2000-1-1", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds2 = mikeio.Dataset(data, time, items) + + # Act + ## interp + dsi = ds1.interp_time(dt=ds2.time) + + # Assert + assert dsi.time[0] == ds2.time[0] + assert dsi.time[-1] == ds2.time[-1] + assert len(dsi.time) == len(ds2.time) + assert dsi[0].shape[0] == ds2[0].shape[0] + + # Accept dataset as argument + dsi2 = ds1.interp_time(ds2) + assert dsi2.time[0] == ds2.time[0] + + +def test_extrapolate(): + # Arrange + ## mikeio.Dataset 1 + nt = 2 + data = [np.zeros([nt, 10, 3])] + time = pd.date_range("2000-1-1", freq="D", periods=nt) + items = [ItemInfo("Foo")] + ds1 = mikeio.Dataset(data, time, items) + assert ds1.shape == (nt, 10, 3) + + ## mikeio.Dataset 2 partly overlapping with mikeio.Dataset 1 + nt = 3 + data = [np.ones([nt, 10, 3])] + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds2 = mikeio.Dataset(data, time, items) + + # Act + ## interp + dsi = ds1.interp_time(dt=ds2.time, fill_value=1.0) + + # Assert + assert dsi.time[0] == ds2.time[0] + assert dsi.time[-1] == ds2.time[-1] + assert len(dsi.time) == len(ds2.time) + assert dsi[0].values[0] == pytest.approx(0.0) + assert dsi[0].values[1] == pytest.approx(1.0) # filled + assert dsi[0].values[2] == pytest.approx(1.0) # filled + + +def test_extrapolate_not_allowed(): + ## mikeio.Dataset 1 + nt = 2 + data = [np.zeros([nt, 10, 3])] + time = pd.date_range("2000-1-1", freq="D", periods=nt) + items = [ItemInfo("Foo")] + ds1 = mikeio.Dataset(data, time, items) + assert ds1.shape == (nt, 10, 3) + + ## mikeio.Dataset 2 partly overlapping with mikeio.Dataset 1 + nt = 3 + data = [np.ones([nt, 10, 3])] + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds2 = mikeio.Dataset(data, time, items) + + with pytest.raises(ValueError): + dsi = ds1.interp_time(dt=ds2.time, fill_value=1.0, extrapolate=False) + + +def test_get_data_2(): + + nt = 100 + data = [] + d = np.zeros([nt, 100, 30]) + 1.0 + data.append(d) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + assert data[0].shape == (100, 100, 30) + + +def test_get_data_name(): + + nt = 100 + data = [] + d = np.zeros([nt, 100, 30]) + 1.0 + data.append(d) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + assert ds["Foo"].shape == (100, 100, 30) + + +def test_modify_selected_variable(): + + nt = 100 + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset([np.zeros((nt, 10))], time, items) + + assert ds.Foo.to_numpy()[0, 0] == 0.0 + + foo = ds.Foo + foo_mod = foo + 1.0 + + ds["Foo"] = foo_mod + assert ds.Foo.to_numpy()[0, 0] == 1.0 + + +def test_get_bad_name(): + nt = 100 + data = [] + d = np.zeros([100, 100, 30]) + 1.0 + data.append(d) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + with pytest.raises(Exception): + ds["BAR"] + + +def test_flipud(): + + nt = 2 + d = np.random.random([nt, 100, 30]) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset([d], time, items) + + dsud = ds.copy() + dsud.flipud() + + assert dsud.shape == ds.shape + assert dsud["Foo"].to_numpy()[0, 0, 0] == ds["Foo"].to_numpy()[0, -1, 0] + + +def test_aggregation_workflows(tmpdir): + filename = "tests/testdata/HD2D.dfsu" + dfs = mikeio.open(filename) + + ds = dfs.read(items=["Surface elevation", "Current speed"]) + ds2 = ds.max(axis=1) + + outfilename = os.path.join(tmpdir.dirname, "max.dfs0") + ds2.to_dfs(outfilename) + assert os.path.isfile(outfilename) + + ds3 = ds.min(axis=1) + + outfilename = os.path.join(tmpdir.dirname, "min.dfs0") + ds3.to_dfs(outfilename) + assert os.path.isfile(outfilename) + + +def test_aggregation_dataset_no_time(): + filename = "tests/testdata/HD2D.dfsu" + dfs = mikeio.open(filename) + ds = dfs.read(time=-1, items=["Surface elevation", "Current speed"]) + + ds2 = ds.max() + assert ds2["Current speed"].values == pytest.approx(1.6463733) + + +def test_aggregations(): + filename = "tests/testdata/gebco_sound.dfs2" + ds = mikeio.read(filename) + + for axis in [0, 1, 2]: + ds.mean(axis=axis) + ds.nanmean(axis=axis) + ds.nanmin(axis=axis) + ds.nanmax(axis=axis) + + assert ds.mean().shape == (264, 216) + assert ds.mean(axis="time").shape == (264, 216) + assert ds.mean(axis="spatial").shape == (1,) + assert ds.mean(axis="space").shape == (1,) + + with pytest.raises(ValueError, match="space"): + ds.mean(axis="spaghetti") + + dsm = ds.mean(axis="time") + assert dsm.geometry is not None + + +def test_to_dfs_extension_validation(tmpdir): + + outfilename = os.path.join(tmpdir, "not_gonna_happen.dfs2") + + ds = mikeio.read( + "tests/testdata/HD2D.dfsu", items=["Surface elevation", "Current speed"] + ) + with pytest.raises(ValueError) as excinfo: + ds.to_dfs(outfilename) + + assert "dfsu" in str(excinfo.value) + + +def test_weighted_average(tmpdir): + filename = "tests/testdata/HD2D.dfsu" + dfs = mikeio.open(filename) + + ds = dfs.read(items=["Surface elevation", "Current speed"]) + + area = dfs.get_element_area() + ds2 = ds.average(weights=area, axis=1) + + outfilename = os.path.join(tmpdir.dirname, "average.dfs0") + ds2.to_dfs(outfilename) + assert os.path.isfile(outfilename) + + +def test_quantile_axis1(ds1): + dsq = ds1.quantile(q=0.345, axis=1) + assert dsq[0].to_numpy()[0] == 0.1 + assert dsq[1].to_numpy()[0] == 0.2 + + assert dsq.n_items == ds1.n_items + assert dsq.n_timesteps == ds1.n_timesteps + + # q as list + dsq = ds1.quantile(q=[0.25, 0.75], axis=1) + assert dsq.n_items == 2 * ds1.n_items + assert "Quantile 0.75, " in dsq.items[1].name + assert "Quantile 0.25, " in dsq.items[2].name + + +def test_quantile_axis0(ds1): + dsq = ds1.quantile(q=0.345) # axis=0 is default + assert dsq[0].to_numpy()[0] == 0.1 + assert dsq[1].to_numpy()[0] == 0.2 + + assert dsq.n_items == ds1.n_items + assert dsq.n_timesteps == 1 + assert dsq.shape[-1] == ds1.shape[-1] + + # q as list + dsq = ds1.quantile(q=[0.25, 0.75], axis=0) + assert dsq.n_items == 2 * ds1.n_items + assert dsq[0].to_numpy()[0] == 0.1 + assert dsq[1].to_numpy()[0] == 0.1 + assert dsq[2].to_numpy()[0] == 0.2 + assert dsq[3].to_numpy()[0] == 0.2 + + assert "Quantile 0.75, " in dsq.items[1].name + assert "Quantile 0.25, " in dsq.items[2].name + assert "Quantile 0.75, " in dsq.items[3].name + + +def test_nanquantile(): + q = 0.99 + fn = "tests/testdata/random.dfs0" # has delete value + ds = mikeio.read(fn) + + dsq1 = ds.quantile(q=q) + dsq2 = ds.nanquantile(q=q) + + assert np.isnan(dsq1[0].to_numpy()) + assert not np.isnan(dsq2[0].to_numpy()) + + qnt = np.quantile(ds[0].to_numpy(), q=q) + nqnt = np.nanquantile(ds[0].to_numpy(), q=q) + + assert np.isnan(qnt) + assert dsq2[0].to_numpy() == nqnt + + +def test_aggregate_across_items(): + + ds = mikeio.read("tests/testdata/State_wlbc_north_err.dfs1") + + with pytest.warns(FutureWarning): # TODO: remove in 1.5.0 + dam = ds.max(axis="items") + + assert isinstance(dam, mikeio.DataArray) + assert dam.geometry == ds.geometry + assert dam.dims == ds.dims + assert dam.type == ds[-1].type + + dsm = ds.mean(axis="items", keepdims=True) + + assert isinstance(dsm, mikeio.Dataset) + assert dsm.geometry == ds.geometry + assert dsm.dims == ds.dims + + +def test_aggregate_selected_items_dfsu_save_to_new_file(tmpdir): + + ds = mikeio.read("tests/testdata/State_Area.dfsu", items="*Level*") + + assert ds.n_items == 5 + + with pytest.warns(FutureWarning): # TODO: remove keepdims in 1.5.0 + dsm = ds.max( + axis="items", keepdims=True, name="Max Water Level" + ) # add a nice name + assert len(dsm) == 1 + assert dsm[0].name == "Max Water Level" + assert dsm.geometry == ds.geometry + assert dsm.dims == ds.dims + assert dsm[0].type == ds[-1].type + + outfilename = os.path.join(tmpdir, "maxwl.dfsu") + dsm.to_dfs(outfilename) + + +def test_copy(): + nt = 100 + d1 = np.zeros([nt, 100, 30]) + 1.5 + d2 = np.zeros([nt, 100, 30]) + 2.0 + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + assert len(ds.items) == 2 + assert len(ds.to_numpy()) == 2 + assert ds[0].name == "Foo" + + ds2 = ds.copy() + + ds2[0].name = "New name" + + assert ds2[0].name == "New name" + assert ds[0].name == "Foo" + + +def test_dropna(): + nt = 10 + d1 = np.zeros([nt, 100, 30]) + d2 = np.zeros([nt, 100, 30]) + + d1[9:] = np.nan + d2[8:] = np.nan + + data = [d1, d2] + + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] + ds = mikeio.Dataset(data, time, items) + + assert len(ds.items) == 2 + assert len(ds.to_numpy()) == 2 + + ds2 = ds.dropna() + + assert ds2.n_timesteps == 8 + + +def test_default_type(): + + item = ItemInfo("Foo") + assert item.type == EUMType.Undefined + assert repr(item.unit) == "undefined" + + +def test_int_is_valid_type_info(): + + item = ItemInfo("Foo", 100123) + assert item.type == EUMType.Viscosity + + item = ItemInfo("U", 100002) + assert item.type == EUMType.Wind_Velocity + + +def test_int_is_valid_unit_info(): + + item = ItemInfo("U", 100002, 2000) + assert item.type == EUMType.Wind_Velocity + assert item.unit == EUMUnit.meter_per_sec + assert repr(item.unit) == "meter per sec" # TODO replace _per_ with / + + +def test_default_unit_from_type(): + + item = ItemInfo("Foo", EUMType.Water_Level) + assert item.type == EUMType.Water_Level + assert item.unit == EUMUnit.meter + assert repr(item.unit) == "meter" + + item = ItemInfo("Tp", EUMType.Wave_period) + assert item.type == EUMType.Wave_period + assert item.unit == EUMUnit.second + assert repr(item.unit) == "second" + + item = ItemInfo("Temperature", EUMType.Temperature) + assert item.type == EUMType.Temperature + assert item.unit == EUMUnit.degree_Celsius + assert repr(item.unit) == "degree Celsius" + + +def test_default_name_from_type(): + + item = ItemInfo(EUMType.Current_Speed) + assert item.name == "Current Speed" + assert item.unit == EUMUnit.meter_per_sec + + item2 = ItemInfo(EUMType.Current_Direction, EUMUnit.degree) + assert item2.unit == EUMUnit.degree + item3 = ItemInfo( + "Current direction (going to)", EUMType.Current_Direction, EUMUnit.degree + ) + assert item3.type == EUMType.Current_Direction + assert item3.unit == EUMUnit.degree + + +def test_iteminfo_string_type_should_fail_with_helpful_message(): + + with pytest.raises(ValueError): + + item = ItemInfo("Water level", "Water level") + + +def test_item_search(): + + res = EUMType.search("level") + + assert len(res) > 0 + assert isinstance(res[0], EUMType) + + +def test_dfsu3d_dataset(): + + filename = "tests/testdata/oresund_sigma_z.dfsu" + + dfsu = mikeio.open(filename) + + ds = dfsu.read() + + text = repr(ds) + + assert len(ds) == 2 # Salinity, Temperature + + dsagg = ds.nanmean(axis=0) # Time averaged + + assert len(dsagg) == 2 # Salinity, Temperature + + assert dsagg[0].shape[0] == 17118 + + assert dsagg.time[0] == ds.time[0] # Time-averaged data index by start time + + ds_elm = dfsu.read(elements=[0]) + + assert len(ds_elm) == 2 # Salinity, Temperature + + dss = ds_elm.squeeze() + + assert len(dss) == 2 # Salinity, Temperature + + +def test_items_data_mismatch(): + + nt = 100 + d = np.zeros([nt, 100, 30]) + 1.0 + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo"), ItemInfo("Bar")] # Two items is not correct! + + with pytest.raises(ValueError): + mikeio.Dataset([d], time, items) + + +def test_time_data_mismatch(): + + nt = 100 + d = np.zeros([nt, 100, 30]) + 1.0 + time = pd.date_range( + "2000-1-2", freq="H", periods=nt + 1 + ) # 101 timesteps is not correct! + items = [ItemInfo("Foo")] + + with pytest.raises(ValueError): + mikeio.Dataset([d], time, items) + + +def test_properties_dfs2(): + filename = "tests/testdata/gebco_sound.dfs2" + ds = mikeio.read(filename) + + assert ds.n_timesteps == 1 + assert ds.n_items == 1 + assert np.all(ds.shape == (1, 264, 216)) + assert ds.n_elements == (264 * 216) + assert ds.is_equidistant + + +def test_properties_dfsu(): + filename = "tests/testdata/oresund_vertical_slice.dfsu" + ds = mikeio.read(filename) + + assert ds.n_timesteps == 3 + assert ds.start_time == datetime(1997, 9, 15, 21, 0, 0) + assert ds.end_time == datetime(1997, 9, 16, 3, 0, 0) + assert ds.timestep == (3 * 3600) + assert ds.n_items == 2 + assert np.all(ds.shape == (3, 441)) + assert ds.n_elements == 441 + assert ds.is_equidistant + + +def test_create_empty_data(): + ne = 34 + d = mikeio.Dataset.create_empty_data(n_elements=ne) + assert len(d) == 1 + assert d[0].shape == (1, ne) + + nt = 100 + d = mikeio.Dataset.create_empty_data(n_timesteps=nt, shape=(3, 4, 6)) + assert len(d) == 1 + assert d[0].shape == (nt, 3, 4, 6) + + ni = 4 + d = mikeio.Dataset.create_empty_data(n_items=ni, n_elements=ne) + assert len(d) == ni + assert d[-1].shape == (1, ne) + + with pytest.raises(Exception): + d = mikeio.Dataset.create_empty_data() + + with pytest.raises(Exception): + d = mikeio.Dataset.create_empty_data(n_elements=None, shape=None) + + +def test_create_infer_name_from_eum(): + + nt = 100 + d = np.random.uniform(size=nt) + + ds = mikeio.Dataset( + data=[d], + time=pd.date_range("2000-01-01", freq="H", periods=nt), + items=[EUMType.Wind_speed], + ) + + assert isinstance(ds.items[0], ItemInfo) + assert ds.items[0].type == EUMType.Wind_speed + assert ds.items[0].name == "Wind speed" + + +def test_add_scalar(ds1): + ds2 = ds1 + 10.0 + assert np.all(ds2[0].to_numpy() - ds1[0].to_numpy() == 10.0) + + ds3 = 10.0 + ds1 + assert np.all(ds3[0].to_numpy() == ds2[0].to_numpy()) + assert np.all(ds3[1].to_numpy() == ds2[1].to_numpy()) + + +def test_add_inconsistent_dataset(ds1): + + ds2 = ds1[[0]] + + assert len(ds1) != len(ds2) + + with pytest.raises(ValueError): + ds1 + ds2 + + with pytest.raises(ValueError): + ds1 * ds2 + + +def test_add_bad_value(ds1): + + with pytest.raises(ValueError): + ds1 + ["one"] + + +def test_multiple_bad_value(ds1): + + with pytest.raises(ValueError): + ds1 * ["pi"] + + +def test_sub_scalar(ds1): + ds2 = ds1 - 10.0 + assert isinstance(ds2, mikeio.Dataset) + assert np.all(ds1[0].to_numpy() - ds2[0].to_numpy() == 10.0) + + ds3 = 10.0 - ds1 + assert isinstance(ds3, mikeio.Dataset) + assert np.all(ds3[0].to_numpy() == 9.9) + assert np.all(ds3[1].to_numpy() == 9.8) + + +def test_mul_scalar(ds1): + ds2 = ds1 * 2.0 + assert np.all(ds2[0].to_numpy() * 0.5 == ds1[0].to_numpy()) + + ds3 = 2.0 * ds1 + assert np.all(ds3[0].to_numpy() == ds2[0].to_numpy()) + assert np.all(ds3[1].to_numpy() == ds2[1].to_numpy()) + + +def test_add_dataset(ds1, ds2): + ds3 = ds1 + ds2 + assert np.all(ds3[0].to_numpy() == 1.1) + assert np.all(ds3[1].to_numpy() == 2.2) + + ds4 = ds2 + ds1 + assert np.all(ds3[0].to_numpy() == ds4[0].to_numpy()) + assert np.all(ds3[1].to_numpy() == ds4[1].to_numpy()) + + ds2b = ds2.copy() + ds2b[0].item = ItemInfo(EUMType.Wind_Velocity) + with pytest.raises(ValueError): + # item type does not match + ds1 + ds2b + + ds2c = ds2.copy() + tt = ds2c.time.to_numpy() + tt[-1] = tt[-1] + np.timedelta64(1, "s") + ds2c.time = pd.DatetimeIndex(tt) + with pytest.raises(ValueError): + # time does not match + ds1 + ds2c + + +def test_sub_dataset(ds1, ds2): + ds3 = ds2 - ds1 + assert np.all(ds3[0].to_numpy() == 0.9) + assert np.all(ds3[1].to_numpy() == 1.8) + + +def test_non_equidistant(): + nt = 4 + d = np.random.uniform(size=nt) + + ds = mikeio.Dataset( + data=[d], + time=[ + datetime(2000, 1, 1), + datetime(2001, 1, 1), + datetime(2002, 1, 1), + datetime(2003, 1, 1), + ], + ) + + assert not ds.is_equidistant + + +def test_concat_dataarray_by_time(): + da1 = mikeio.read("tests/testdata/tide1.dfs1")[0] + da2 = mikeio.read("tests/testdata/tide2.dfs1")[0] + da3 = mikeio.DataArray.concat([da1, da2]) + + assert da3.start_time == da1.start_time + assert da3.start_time < da2.start_time + assert da3.end_time == da2.end_time + assert da3.end_time > da1.end_time + assert da3.n_timesteps == 145 + assert da3.is_equidistant + + +def test_concat_by_time(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1") + ds2 = mikeio.read("tests/testdata/tide2.dfs1") + 0.5 # add offset + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert isinstance(ds3, mikeio.Dataset) + assert len(ds1) == len(ds2) == len(ds3) + assert ds3.start_time == ds1.start_time + assert ds3.start_time < ds2.start_time + assert ds3.end_time == ds2.end_time + assert ds3.end_time > ds1.end_time + assert ds3.n_timesteps == 145 + assert ds3.is_equidistant + + +def test_concat_by_time_ndim1(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1").isel(x=0) + ds2 = mikeio.read("tests/testdata/tide2.dfs1").isel(x=0) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert isinstance(ds3, mikeio.Dataset) + assert len(ds1) == len(ds2) == len(ds3) + assert ds3.start_time == ds1.start_time + assert ds3.start_time < ds2.start_time + assert ds3.end_time == ds2.end_time + assert ds3.end_time > ds1.end_time + assert ds3.n_timesteps == 145 + assert ds3.is_equidistant + + +def test_concat_by_time_inconsistent_shape_not_possible(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1").isel(x=[0, 1]) + ds2 = mikeio.read("tests/testdata/tide2.dfs1").isel(x=[0, 1, 2]) + with pytest.raises(ValueError, match="Shape"): + mikeio.Dataset.concat([ds1, ds2]) + + +# TODO: implement this +def test_concat_by_time_no_time(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1", time=0) + ds2 = mikeio.read("tests/testdata/tide2.dfs1", time=1) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert ds3.n_timesteps == 2 + + +def test_concat_by_time_2(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1", time=range(0, 12)) + ds2 = mikeio.read("tests/testdata/tide2.dfs1") + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert ds3.n_timesteps == 109 + assert not ds3.is_equidistant + + # create concatd datasets in 8 chunks of 6 hours + dsall = [] + for j in range(8): + dsall.append( + mikeio.read( + "tests/testdata/tide1.dfs1", time=range(j * 12, 1 + (j + 1) * 12) + ) + ) + ds4 = mikeio.Dataset.concat(dsall) + assert len(dsall) == 8 + assert ds4.n_timesteps == 97 + assert ds4.is_equidistant + + +def test_renamed_dataset_has_updated_attributes(ds1: mikeio.Dataset): + assert hasattr(ds1, "Foo") + assert isinstance(ds1.Foo, mikeio.DataArray) + ds2 = ds1.rename(dict(Foo="Baz")) + assert not hasattr(ds2, "Foo") + assert hasattr(ds2, "Baz") + assert isinstance(ds2.Baz, mikeio.DataArray) + + # inplace version + ds1.rename(dict(Foo="Baz"), inplace=True) + assert not hasattr(ds1, "Foo") + assert hasattr(ds1, "Baz") + assert isinstance(ds1.Baz, mikeio.DataArray) + + +def test_merge_by_item(): + ds1 = mikeio.read("tests/testdata/tide1.dfs1") + ds2 = mikeio.read("tests/testdata/tide1.dfs1") + old_name = ds2[0].name + new_name = old_name + " v2" + # ds2[0].name = ds2[0].name + " v2" + ds2.rename({old_name: new_name}, inplace=True) + ds3 = mikeio.Dataset.merge([ds1, ds2]) + + assert isinstance(ds3, mikeio.Dataset) + assert ds3.n_items == 2 + assert ds3[1].name == ds1[0].name + " v2" + + +def test_merge_by_item_dfsu_3d(): + ds1 = mikeio.read("tests/testdata/oresund_sigma_z.dfsu", items=[0]) + assert ds1.n_items == 1 + ds2 = mikeio.read("tests/testdata/oresund_sigma_z.dfsu", items=[1]) + assert ds2.n_items == 1 + + ds3 = mikeio.Dataset.merge([ds1, ds2]) + + assert isinstance(ds3, mikeio.Dataset) + itemnames = [x.name for x in ds3.items] + assert "Salinity" in itemnames + assert "Temperature" in itemnames + assert ds3.n_items == 2 + + +def test_to_numpy(ds2): + + X = ds2.to_numpy() + + assert X.shape == (ds2.n_items,) + ds2.shape + assert isinstance(X, np.ndarray) + + +def test_concat(): + filename = "tests/testdata/HD2D.dfsu" + ds1 = mikeio.read(filename, time=[0, 1]) + ds2 = mikeio.read(filename, time=[2, 3]) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + ds3.n_timesteps + + assert ds1.n_items == ds2.n_items == ds3.n_items + assert ds3.n_timesteps == (ds1.n_timesteps + ds2.n_timesteps) + assert ds3.start_time == ds1.start_time + assert ds3.end_time == ds2.end_time + assert type(ds3.geometry) == type(ds1.geometry) + assert ds3.geometry.n_elements == ds1.geometry.n_elements + + +def test_concat_dfsu3d(): + filename = "tests/testdata/basin_3d.dfsu" + ds = mikeio.read(filename) + ds1 = mikeio.read(filename, time=[0, 1]) + ds2 = mikeio.read(filename, time=[1, 2]) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert ds1.n_items == ds2.n_items == ds3.n_items + assert ds3.start_time == ds.start_time + assert ds3.end_time == ds.end_time + assert type(ds3.geometry) == type(ds.geometry) + assert ds3.geometry.n_elements == ds1.geometry.n_elements + assert ds3._zn.shape == ds._zn.shape + assert np.all(ds3._zn == ds._zn) + + +def test_concat_dfsu3d_single_timesteps(): + filename = "tests/testdata/basin_3d.dfsu" + ds = mikeio.read(filename) + ds1 = mikeio.read(filename, time=0) + ds2 = mikeio.read(filename, time=2) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert ds1.n_items == ds2.n_items == ds3.n_items + assert ds3.start_time == ds1.start_time + assert ds3.end_time == ds2.end_time + + +def test_concat_dfs2_single_timesteps(): + filename = "tests/testdata/single_row.dfs2" + ds = mikeio.read(filename) + ds1 = mikeio.read(filename, time=0) + ds2 = mikeio.read(filename, time=2) + ds3 = mikeio.Dataset.concat([ds1, ds2]) + + assert ds1.n_items == ds2.n_items == ds3.n_items + assert ds3.start_time == ds1.start_time + assert ds3.end_time == ds2.end_time + assert ds3.n_timesteps == 2 + + +def test_merge_same_name_error(): + filename = "tests/testdata/HD2D.dfsu" + ds1 = mikeio.read(filename, items=0) + ds2 = mikeio.read(filename, items=0) + + assert ds1.items[0].name == ds2.items[0].name + + with pytest.raises(ValueError): + mikeio.Dataset.merge([ds1, ds2]) + + +def test_incompatible_data_not_allowed(): + + da1 = mikeio.read("tests/testdata/HD2D.dfsu")[0] + da2 = mikeio.read("tests/testdata/oresundHD_run1.dfsu")[1] + + with pytest.raises(ValueError) as excinfo: + mikeio.Dataset([da1, da2]) + + assert "shape" in str(excinfo.value).lower() + + da1 = mikeio.read("tests/testdata/tide1.dfs1")[0] + da2 = mikeio.read("tests/testdata/tide2.dfs1")[0] + + with pytest.raises(ValueError) as excinfo: + mikeio.Dataset([da1, da2]) + + assert "name" in str(excinfo.value).lower() + + da1 = mikeio.read("tests/testdata/tide1.dfs1")[0] + da2 = mikeio.read("tests/testdata/tide2.dfs1")[0] + da2.name = "Foo" + + with pytest.raises(ValueError) as excinfo: + mikeio.Dataset([da1, da2]) + + assert "time" in str(excinfo.value).lower() + + +def test_xzy_selection(): + # select in space via x,y,z coordinates test + filename = "tests/testdata/oresund_sigma_z.dfsu" + ds = mikeio.read(filename) + + with pytest.raises(OutsideModelDomainError): + ds.sel(x=340000, y=15.75, z=0) + + +def test_layer_selection(): + # select layer test + filename = "tests/testdata/oresund_sigma_z.dfsu" + ds = mikeio.read(filename) + + dss_layer = ds.sel(layers=0) + # should not be layered after selection + assert type(dss_layer.geometry) == mikeio.spatial.FM_geometry.GeometryFM + + +def test_time_selection(): + # select time test + nt = 100 + data = [] + d = np.random.rand(nt) + data.append(d) + time = pd.date_range("2000-1-2", freq="H", periods=nt) + items = [ItemInfo("Foo")] + ds = mikeio.Dataset(data, time, items) + + # check for string input + dss_t = ds.sel(time="2000-01-05") + # and index based + dss_tix = ds.sel(time=80) + + assert dss_t.shape == (24,) + assert len(dss_tix) == 1 + + +def test_create_dataset_with_many_items(): + n_items = 800 + nt = 2 + time = pd.date_range("2000", freq="H", periods=nt) + + das = [] + + for i in range(n_items): + x = np.random.random(nt) + da = mikeio.DataArray(data=x, time=time, item=mikeio.ItemInfo(f"Item {i+1}")) + das.append(da) + + ds = mikeio.Dataset(das) + + assert ds.n_items == n_items + + +def test_create_array_with_defaults_from_dataset(): + + filename = "tests/testdata/oresund_sigma_z.dfsu" + ds: mikeio.Dataset = mikeio.read(filename) + + values = np.zeros(ds.Temperature.shape) + + da = ds.create_data_array(values) + + assert isinstance(da, mikeio.DataArray) + assert da.geometry == ds.geometry + assert all(da.time == ds.time) + assert da.item.type == mikeio.EUMType.Undefined + + da_name = ds.create_data_array(values, "Foo") + + assert isinstance(da, mikeio.DataArray) + assert da_name.geometry == ds.geometry + assert da_name.item.type == mikeio.EUMType.Undefined + assert da_name.name == "Foo" + + da_eum = ds.create_data_array( + values, item=mikeio.ItemInfo("TS", mikeio.EUMType.Temperature) + ) + + assert isinstance(da_eum, mikeio.DataArray) + assert da_eum.geometry == ds.geometry + assert da_eum.item.type == mikeio.EUMType.Temperature + + +def test_dataset_plot(ds1): + ax = ds1.isel(x=0).plot() + assert len(ax.lines) == 2 + ds2 = ds1 + 0.01 + ax = ds2.isel(x=-1).plot(ax=ax) + assert len(ax.lines) == 4 + + +def test_interp_na(): + time = pd.date_range("2000", periods=5, freq="D") + da = mikeio.DataArray( + data=np.array([np.nan, 1.0, np.nan, np.nan, 4.0]), + time=time, + item=ItemInfo(name="Foo"), + ) + da2 = mikeio.DataArray( + data=np.array([np.nan, np.nan, np.nan, 4.0, 4.0]), + time=time, + item=ItemInfo(name="Bar"), + ) + + ds = mikeio.Dataset([da, da2]) + + dsi = ds.interp_na() + assert np.isnan(dsi[0].to_numpy()[0]) + assert dsi.Foo.to_numpy()[2] == pytest.approx(2.0) + assert np.isnan(dsi.Foo.to_numpy()[0]) + + dsi = ds.interp_na(fill_value="extrapolate") + assert dsi.Foo.to_numpy()[0] == pytest.approx(0.0) + assert dsi.Bar.to_numpy()[2] == pytest.approx(4.0) + + +def test_plot_scatter(): + ds = mikeio.read("tests/testdata/oresund_sigma_z.dfsu", time=0) + ds.plot.scatter(x="Salinity", y="Temperature", title="S-vs-T") diff --git a/crates/ruff_benchmark/resources/numpy/ctypeslib.py b/crates/ruff_benchmark/resources/numpy/ctypeslib.py new file mode 100644 index 0000000000000..c4bafca1bd114 --- /dev/null +++ b/crates/ruff_benchmark/resources/numpy/ctypeslib.py @@ -0,0 +1,547 @@ +""" +============================ +``ctypes`` Utility Functions +============================ + +See Also +-------- +load_library : Load a C library. +ndpointer : Array restype/argtype with verification. +as_ctypes : Create a ctypes array from an ndarray. +as_array : Create an ndarray from a ctypes array. + +References +---------- +.. [1] "SciPy Cookbook: ctypes", https://scipy-cookbook.readthedocs.io/items/Ctypes.html + +Examples +-------- +Load the C library: + +>>> _lib = np.ctypeslib.load_library('libmystuff', '.') #doctest: +SKIP + +Our result type, an ndarray that must be of type double, be 1-dimensional +and is C-contiguous in memory: + +>>> array_1d_double = np.ctypeslib.ndpointer( +... dtype=np.double, +... ndim=1, flags='CONTIGUOUS') #doctest: +SKIP + +Our C-function typically takes an array and updates its values +in-place. For example:: + + void foo_func(double* x, int length) + { + int i; + for (i = 0; i < length; i++) { + x[i] = i*i; + } + } + +We wrap it using: + +>>> _lib.foo_func.restype = None #doctest: +SKIP +>>> _lib.foo_func.argtypes = [array_1d_double, c_int] #doctest: +SKIP + +Then, we're ready to call ``foo_func``: + +>>> out = np.empty(15, dtype=np.double) +>>> _lib.foo_func(out, len(out)) #doctest: +SKIP + +""" +__all__ = ['load_library', 'ndpointer', 'c_intp', 'as_ctypes', 'as_array', + 'as_ctypes_type'] + +import os +from numpy import ( + integer, ndarray, dtype as _dtype, asarray, frombuffer +) +from numpy.core.multiarray import _flagdict, flagsobj + +try: + import ctypes +except ImportError: + ctypes = None + +if ctypes is None: + def _dummy(*args, **kwds): + """ + Dummy object that raises an ImportError if ctypes is not available. + + Raises + ------ + ImportError + If ctypes is not available. + + """ + raise ImportError("ctypes is not available.") + load_library = _dummy + as_ctypes = _dummy + as_array = _dummy + from numpy import intp as c_intp + _ndptr_base = object +else: + import numpy.core._internal as nic + c_intp = nic._getintp_ctype() + del nic + _ndptr_base = ctypes.c_void_p + + # Adapted from Albert Strasheim + def load_library(libname, loader_path): + """ + It is possible to load a library using + + >>> lib = ctypes.cdll[<full_path_name>] # doctest: +SKIP + + But there are cross-platform considerations, such as library file extensions, + plus the fact Windows will just load the first library it finds with that name. + NumPy supplies the load_library function as a convenience. + + .. versionchanged:: 1.20.0 + Allow libname and loader_path to take any + :term:`python:path-like object`. + + Parameters + ---------- + libname : path-like + Name of the library, which can have 'lib' as a prefix, + but without an extension. + loader_path : path-like + Where the library can be found. + + Returns + ------- + ctypes.cdll[libpath] : library object + A ctypes library object + + Raises + ------ + OSError + If there is no library with the expected extension, or the + library is defective and cannot be loaded. + """ + if ctypes.__version__ < '1.0.1': + import warnings + warnings.warn("All features of ctypes interface may not work " + "with ctypes < 1.0.1", stacklevel=2) + + # Convert path-like objects into strings + libname = os.fsdecode(libname) + loader_path = os.fsdecode(loader_path) + + ext = os.path.splitext(libname)[1] + if not ext: + # Try to load library with platform-specific name, otherwise + # default to libname.[so|pyd]. Sometimes, these files are built + # erroneously on non-linux platforms. + from numpy.distutils.misc_util import get_shared_lib_extension + so_ext = get_shared_lib_extension() + libname_ext = [libname + so_ext] + # mac, windows and linux >= py3.2 shared library and loadable + # module have different extensions so try both + so_ext2 = get_shared_lib_extension(is_python_ext=True) + if not so_ext2 == so_ext: + libname_ext.insert(0, libname + so_ext2) + else: + libname_ext = [libname] + + loader_path = os.path.abspath(loader_path) + if not os.path.isdir(loader_path): + libdir = os.path.dirname(loader_path) + else: + libdir = loader_path + + for ln in libname_ext: + libpath = os.path.join(libdir, ln) + if os.path.exists(libpath): + try: + return ctypes.cdll[libpath] + except OSError: + ## defective lib file + raise + ## if no successful return in the libname_ext loop: + raise OSError("no file with expected extension") + + +def _num_fromflags(flaglist): + num = 0 + for val in flaglist: + num += _flagdict[val] + return num + +_flagnames = ['C_CONTIGUOUS', 'F_CONTIGUOUS', 'ALIGNED', 'WRITEABLE', + 'OWNDATA', 'WRITEBACKIFCOPY'] +def _flags_fromnum(num): + res = [] + for key in _flagnames: + value = _flagdict[key] + if (num & value): + res.append(key) + return res + + +class _ndptr(_ndptr_base): + @classmethod + def from_param(cls, obj): + if not isinstance(obj, ndarray): + raise TypeError("argument must be an ndarray") + if cls._dtype_ is not None \ + and obj.dtype != cls._dtype_: + raise TypeError("array must have data type %s" % cls._dtype_) + if cls._ndim_ is not None \ + and obj.ndim != cls._ndim_: + raise TypeError("array must have %d dimension(s)" % cls._ndim_) + if cls._shape_ is not None \ + and obj.shape != cls._shape_: + raise TypeError("array must have shape %s" % str(cls._shape_)) + if cls._flags_ is not None \ + and ((obj.flags.num & cls._flags_) != cls._flags_): + raise TypeError("array must have flags %s" % + _flags_fromnum(cls._flags_)) + return obj.ctypes + + +class _concrete_ndptr(_ndptr): + """ + Like _ndptr, but with `_shape_` and `_dtype_` specified. + + Notably, this means the pointer has enough information to reconstruct + the array, which is not generally true. + """ + def _check_retval_(self): + """ + This method is called when this class is used as the .restype + attribute for a shared-library function, to automatically wrap the + pointer into an array. + """ + return self.contents + + @property + def contents(self): + """ + Get an ndarray viewing the data pointed to by this pointer. + + This mirrors the `contents` attribute of a normal ctypes pointer + """ + full_dtype = _dtype((self._dtype_, self._shape_)) + full_ctype = ctypes.c_char * full_dtype.itemsize + buffer = ctypes.cast(self, ctypes.POINTER(full_ctype)).contents + return frombuffer(buffer, dtype=full_dtype).squeeze(axis=0) + + +# Factory for an array-checking class with from_param defined for +# use with ctypes argtypes mechanism +_pointer_type_cache = {} +def ndpointer(dtype=None, ndim=None, shape=None, flags=None): + """ + Array-checking restype/argtypes. + + An ndpointer instance is used to describe an ndarray in restypes + and argtypes specifications. This approach is more flexible than + using, for example, ``POINTER(c_double)``, since several restrictions + can be specified, which are verified upon calling the ctypes function. + These include data type, number of dimensions, shape and flags. If a + given array does not satisfy the specified restrictions, + a ``TypeError`` is raised. + + Parameters + ---------- + dtype : data-type, optional + Array data-type. + ndim : int, optional + Number of array dimensions. + shape : tuple of ints, optional + Array shape. + flags : str or tuple of str + Array flags; may be one or more of: + + - C_CONTIGUOUS / C / CONTIGUOUS + - F_CONTIGUOUS / F / FORTRAN + - OWNDATA / O + - WRITEABLE / W + - ALIGNED / A + - WRITEBACKIFCOPY / X + + Returns + ------- + klass : ndpointer type object + A type object, which is an ``_ndtpr`` instance containing + dtype, ndim, shape and flags information. + + Raises + ------ + TypeError + If a given array does not satisfy the specified restrictions. + + Examples + -------- + >>> clib.somefunc.argtypes = [np.ctypeslib.ndpointer(dtype=np.float64, + ... ndim=1, + ... flags='C_CONTIGUOUS')] + ... #doctest: +SKIP + >>> clib.somefunc(np.array([1, 2, 3], dtype=np.float64)) + ... #doctest: +SKIP + + """ + + # normalize dtype to an Optional[dtype] + if dtype is not None: + dtype = _dtype(dtype) + + # normalize flags to an Optional[int] + num = None + if flags is not None: + if isinstance(flags, str): + flags = flags.split(',') + elif isinstance(flags, (int, integer)): + num = flags + flags = _flags_fromnum(num) + elif isinstance(flags, flagsobj): + num = flags.num + flags = _flags_fromnum(num) + if num is None: + try: + flags = [x.strip().upper() for x in flags] + except Exception as e: + raise TypeError("invalid flags specification") from e + num = _num_fromflags(flags) + + # normalize shape to an Optional[tuple] + if shape is not None: + try: + shape = tuple(shape) + except TypeError: + # single integer -> 1-tuple + shape = (shape,) + + cache_key = (dtype, ndim, shape, num) + + try: + return _pointer_type_cache[cache_key] + except KeyError: + pass + + # produce a name for the new type + if dtype is None: + name = 'any' + elif dtype.names is not None: + name = str(id(dtype)) + else: + name = dtype.str + if ndim is not None: + name += "_%dd" % ndim + if shape is not None: + name += "_"+"x".join(str(x) for x in shape) + if flags is not None: + name += "_"+"_".join(flags) + + if dtype is not None and shape is not None: + base = _concrete_ndptr + else: + base = _ndptr + + klass = type("ndpointer_%s"%name, (base,), + {"_dtype_": dtype, + "_shape_" : shape, + "_ndim_" : ndim, + "_flags_" : num}) + _pointer_type_cache[cache_key] = klass + return klass + + +if ctypes is not None: + def _ctype_ndarray(element_type, shape): + """ Create an ndarray of the given element type and shape """ + for dim in shape[::-1]: + element_type = dim * element_type + # prevent the type name include np.ctypeslib + element_type.__module__ = None + return element_type + + + def _get_scalar_type_map(): + """ + Return a dictionary mapping native endian scalar dtype to ctypes types + """ + ct = ctypes + simple_types = [ + ct.c_byte, ct.c_short, ct.c_int, ct.c_long, ct.c_longlong, + ct.c_ubyte, ct.c_ushort, ct.c_uint, ct.c_ulong, ct.c_ulonglong, + ct.c_float, ct.c_double, + ct.c_bool, + ] + return {_dtype(ctype): ctype for ctype in simple_types} + + + _scalar_type_map = _get_scalar_type_map() + + + def _ctype_from_dtype_scalar(dtype): + # swapping twice ensure that `=` is promoted to <, >, or | + dtype_with_endian = dtype.newbyteorder('S').newbyteorder('S') + dtype_native = dtype.newbyteorder('=') + try: + ctype = _scalar_type_map[dtype_native] + except KeyError as e: + raise NotImplementedError( + "Converting {!r} to a ctypes type".format(dtype) + ) from None + + if dtype_with_endian.byteorder == '>': + ctype = ctype.__ctype_be__ + elif dtype_with_endian.byteorder == '<': + ctype = ctype.__ctype_le__ + + return ctype + + + def _ctype_from_dtype_subarray(dtype): + element_dtype, shape = dtype.subdtype + ctype = _ctype_from_dtype(element_dtype) + return _ctype_ndarray(ctype, shape) + + + def _ctype_from_dtype_structured(dtype): + # extract offsets of each field + field_data = [] + for name in dtype.names: + field_dtype, offset = dtype.fields[name][:2] + field_data.append((offset, name, _ctype_from_dtype(field_dtype))) + + # ctypes doesn't care about field order + field_data = sorted(field_data, key=lambda f: f[0]) + + if len(field_data) > 1 and all(offset == 0 for offset, name, ctype in field_data): + # union, if multiple fields all at address 0 + size = 0 + _fields_ = [] + for offset, name, ctype in field_data: + _fields_.append((name, ctype)) + size = max(size, ctypes.sizeof(ctype)) + + # pad to the right size + if dtype.itemsize != size: + _fields_.append(('', ctypes.c_char * dtype.itemsize)) + + # we inserted manual padding, so always `_pack_` + return type('union', (ctypes.Union,), dict( + _fields_=_fields_, + _pack_=1, + __module__=None, + )) + else: + last_offset = 0 + _fields_ = [] + for offset, name, ctype in field_data: + padding = offset - last_offset + if padding < 0: + raise NotImplementedError("Overlapping fields") + if padding > 0: + _fields_.append(('', ctypes.c_char * padding)) + + _fields_.append((name, ctype)) + last_offset = offset + ctypes.sizeof(ctype) + + + padding = dtype.itemsize - last_offset + if padding > 0: + _fields_.append(('', ctypes.c_char * padding)) + + # we inserted manual padding, so always `_pack_` + return type('struct', (ctypes.Structure,), dict( + _fields_=_fields_, + _pack_=1, + __module__=None, + )) + + + def _ctype_from_dtype(dtype): + if dtype.fields is not None: + return _ctype_from_dtype_structured(dtype) + elif dtype.subdtype is not None: + return _ctype_from_dtype_subarray(dtype) + else: + return _ctype_from_dtype_scalar(dtype) + + + def as_ctypes_type(dtype): + r""" + Convert a dtype into a ctypes type. + + Parameters + ---------- + dtype : dtype + The dtype to convert + + Returns + ------- + ctype + A ctype scalar, union, array, or struct + + Raises + ------ + NotImplementedError + If the conversion is not possible + + Notes + ----- + This function does not losslessly round-trip in either direction. + + ``np.dtype(as_ctypes_type(dt))`` will: + + - insert padding fields + - reorder fields to be sorted by offset + - discard field titles + + ``as_ctypes_type(np.dtype(ctype))`` will: + + - discard the class names of `ctypes.Structure`\ s and + `ctypes.Union`\ s + - convert single-element `ctypes.Union`\ s into single-element + `ctypes.Structure`\ s + - insert padding fields + + """ + return _ctype_from_dtype(_dtype(dtype)) + + + def as_array(obj, shape=None): + """ + Create a numpy array from a ctypes array or POINTER. + + The numpy array shares the memory with the ctypes object. + + The shape parameter must be given if converting from a ctypes POINTER. + The shape parameter is ignored if converting from a ctypes array + """ + if isinstance(obj, ctypes._Pointer): + # convert pointers to an array of the desired shape + if shape is None: + raise TypeError( + 'as_array() requires a shape argument when called on a ' + 'pointer') + p_arr_type = ctypes.POINTER(_ctype_ndarray(obj._type_, shape)) + obj = ctypes.cast(obj, p_arr_type).contents + + return asarray(obj) + + + def as_ctypes(obj): + """Create and return a ctypes object from a numpy array. Actually + anything that exposes the __array_interface__ is accepted.""" + ai = obj.__array_interface__ + if ai["strides"]: + raise TypeError("strided arrays not supported") + if ai["version"] != 3: + raise TypeError("only __array_interface__ version 3 supported") + addr, readonly = ai["data"] + if readonly: + raise TypeError("readonly arrays unsupported") + + # can't use `_dtype((ai["typestr"], ai["shape"]))` here, as it overflows + # dtype.itemsize (gh-14214) + ctype_scalar = as_ctypes_type(ai["typestr"]) + result_type = _ctype_ndarray(ctype_scalar, ai["shape"]) + result = result_type.from_address(addr) + result.__keep = obj + return result diff --git a/crates/ruff_benchmark/resources/numpy/globals.py b/crates/ruff_benchmark/resources/numpy/globals.py new file mode 100644 index 0000000000000..416a20f5e11b1 --- /dev/null +++ b/crates/ruff_benchmark/resources/numpy/globals.py @@ -0,0 +1,95 @@ +""" +Module defining global singleton classes. + +This module raises a RuntimeError if an attempt to reload it is made. In that +way the identities of the classes defined here are fixed and will remain so +even if numpy itself is reloaded. In particular, a function like the following +will still work correctly after numpy is reloaded:: + + def foo(arg=np._NoValue): + if arg is np._NoValue: + ... + +That was not the case when the singleton classes were defined in the numpy +``__init__.py`` file. See gh-7844 for a discussion of the reload problem that +motivated this module. + +""" +import enum + +from ._utils import set_module as _set_module + +__all__ = ['_NoValue', '_CopyMode'] + + +# Disallow reloading this module so as to preserve the identities of the +# classes defined here. +if '_is_loaded' in globals(): + raise RuntimeError('Reloading numpy._globals is not allowed') +_is_loaded = True + + +class _NoValueType: + """Special keyword value. + + The instance of this class may be used as the default value assigned to a + keyword if no other obvious default (e.g., `None`) is suitable, + + Common reasons for using this keyword are: + + - A new keyword is added to a function, and that function forwards its + inputs to another function or method which can be defined outside of + NumPy. For example, ``np.std(x)`` calls ``x.std``, so when a ``keepdims`` + keyword was added that could only be forwarded if the user explicitly + specified ``keepdims``; downstream array libraries may not have added + the same keyword, so adding ``x.std(..., keepdims=keepdims)`` + unconditionally could have broken previously working code. + - A keyword is being deprecated, and a deprecation warning must only be + emitted when the keyword is used. + + """ + __instance = None + def __new__(cls): + # ensure that only one instance exists + if not cls.__instance: + cls.__instance = super().__new__(cls) + return cls.__instance + + def __repr__(self): + return "<no value>" + + +_NoValue = _NoValueType() + + +@_set_module("numpy") +class _CopyMode(enum.Enum): + """ + An enumeration for the copy modes supported + by numpy.copy() and numpy.array(). The following three modes are supported, + + - ALWAYS: This means that a deep copy of the input + array will always be taken. + - IF_NEEDED: This means that a deep copy of the input + array will be taken only if necessary. + - NEVER: This means that the deep copy will never be taken. + If a copy cannot be avoided then a `ValueError` will be + raised. + + Note that the buffer-protocol could in theory do copies. NumPy currently + assumes an object exporting the buffer protocol will never do this. + """ + + ALWAYS = True + IF_NEEDED = False + NEVER = 2 + + def __bool__(self): + # For backwards compatibility + if self == _CopyMode.ALWAYS: + return True + + if self == _CopyMode.IF_NEEDED: + return False + + raise ValueError(f"{self} is neither True nor False.") diff --git a/crates/ruff_benchmark/resources/pydantic/types.py b/crates/ruff_benchmark/resources/pydantic/types.py new file mode 100644 index 0000000000000..df455020d0ee4 --- /dev/null +++ b/crates/ruff_benchmark/resources/pydantic/types.py @@ -0,0 +1,834 @@ +from __future__ import annotations as _annotations + +import abc +import dataclasses as _dataclasses +import re +from datetime import date, datetime +from decimal import Decimal +from enum import Enum +from pathlib import Path +from typing import ( + TYPE_CHECKING, + Any, + ClassVar, + FrozenSet, + Generic, + Hashable, + List, + Set, + Tuple, + Type, + TypeVar, + Union, + cast, +) +from uuid import UUID + +import annotated_types +from pydantic_core import PydanticCustomError, PydanticKnownError, core_schema +from typing_extensions import Annotated, Literal + +from ._internal import _fields, _validators + +__all__ = [ + 'Strict', + 'StrictStr', + 'conbytes', + 'conlist', + 'conset', + 'confrozenset', + 'constr', + 'ImportString', + 'conint', + 'PositiveInt', + 'NegativeInt', + 'NonNegativeInt', + 'NonPositiveInt', + 'confloat', + 'PositiveFloat', + 'NegativeFloat', + 'NonNegativeFloat', + 'NonPositiveFloat', + 'FiniteFloat', + 'condecimal', + 'UUID1', + 'UUID3', + 'UUID4', + 'UUID5', + 'FilePath', + 'DirectoryPath', + 'Json', + 'SecretField', + 'SecretStr', + 'SecretBytes', + 'StrictBool', + 'StrictBytes', + 'StrictInt', + 'StrictFloat', + 'PaymentCardNumber', + 'ByteSize', + 'PastDate', + 'FutureDate', + 'condate', + 'AwareDatetime', + 'NaiveDatetime', +] + +from ._internal._core_metadata import build_metadata_dict +from ._internal._utils import update_not_none +from .json_schema import JsonSchemaMetadata + + +@_dataclasses.dataclass +class Strict(_fields.PydanticMetadata): + strict: bool = True + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BOOLEAN TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +StrictBool = Annotated[bool, Strict()] + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ INTEGER TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +def conint( + *, + strict: bool | None = None, + gt: int | None = None, + ge: int | None = None, + lt: int | None = None, + le: int | None = None, + multiple_of: int | None = None, +) -> type[int]: + return Annotated[ # type: ignore[return-value] + int, + Strict(strict) if strict is not None else None, + annotated_types.Interval(gt=gt, ge=ge, lt=lt, le=le), + annotated_types.MultipleOf(multiple_of) if multiple_of is not None else None, + ] + + +PositiveInt = Annotated[int, annotated_types.Gt(0)] +NegativeInt = Annotated[int, annotated_types.Lt(0)] +NonPositiveInt = Annotated[int, annotated_types.Le(0)] +NonNegativeInt = Annotated[int, annotated_types.Ge(0)] +StrictInt = Annotated[int, Strict()] + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ FLOAT TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +@_dataclasses.dataclass +class AllowInfNan(_fields.PydanticMetadata): + allow_inf_nan: bool = True + + +def confloat( + *, + strict: bool | None = None, + gt: float | None = None, + ge: float | None = None, + lt: float | None = None, + le: float | None = None, + multiple_of: float | None = None, + allow_inf_nan: bool | None = None, +) -> type[float]: + return Annotated[ # type: ignore[return-value] + float, + Strict(strict) if strict is not None else None, + annotated_types.Interval(gt=gt, ge=ge, lt=lt, le=le), + annotated_types.MultipleOf(multiple_of) if multiple_of is not None else None, + AllowInfNan(allow_inf_nan) if allow_inf_nan is not None else None, + ] + + +PositiveFloat = Annotated[float, annotated_types.Gt(0)] +NegativeFloat = Annotated[float, annotated_types.Lt(0)] +NonPositiveFloat = Annotated[float, annotated_types.Le(0)] +NonNegativeFloat = Annotated[float, annotated_types.Ge(0)] +StrictFloat = Annotated[float, Strict(True)] +FiniteFloat = Annotated[float, AllowInfNan(False)] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BYTES TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +def conbytes( + *, + min_length: int | None = None, + max_length: int | None = None, + strict: bool | None = None, +) -> type[bytes]: + return Annotated[ # type: ignore[return-value] + bytes, + Strict(strict) if strict is not None else None, + annotated_types.Len(min_length or 0, max_length), + ] + + +StrictBytes = Annotated[bytes, Strict()] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ STRING TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +def constr( + *, + strip_whitespace: bool | None = None, + to_upper: bool | None = None, + to_lower: bool | None = None, + strict: bool | None = None, + min_length: int | None = None, + max_length: int | None = None, + pattern: str | None = None, +) -> type[str]: + return Annotated[ # type: ignore[return-value] + str, + Strict(strict) if strict is not None else None, + annotated_types.Len(min_length or 0, max_length), + _fields.PydanticGeneralMetadata( + strip_whitespace=strip_whitespace, + to_upper=to_upper, + to_lower=to_lower, + pattern=pattern, + ), + ] + + +StrictStr = Annotated[str, Strict()] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~ COLLECTION TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +HashableItemType = TypeVar('HashableItemType', bound=Hashable) + + +def conset( + item_type: Type[HashableItemType], *, min_length: int = None, max_length: int = None +) -> Type[Set[HashableItemType]]: + return Annotated[ # type: ignore[return-value] + Set[item_type], annotated_types.Len(min_length or 0, max_length) # type: ignore[valid-type] + ] + + +def confrozenset( + item_type: Type[HashableItemType], *, min_length: int | None = None, max_length: int | None = None +) -> Type[FrozenSet[HashableItemType]]: + return Annotated[ # type: ignore[return-value] + FrozenSet[item_type], # type: ignore[valid-type] + annotated_types.Len(min_length or 0, max_length), + ] + + +AnyItemType = TypeVar('AnyItemType') + + +def conlist( + item_type: Type[AnyItemType], *, min_length: int | None = None, max_length: int | None = None +) -> Type[List[AnyItemType]]: + return Annotated[ # type: ignore[return-value] + List[item_type], # type: ignore[valid-type] + annotated_types.Len(min_length or 0, max_length), + ] + + +def contuple( + item_type: Type[AnyItemType], *, min_length: int | None = None, max_length: int | None = None +) -> Type[Tuple[AnyItemType]]: + return Annotated[ # type: ignore[return-value] + Tuple[item_type], + annotated_types.Len(min_length or 0, max_length), + ] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~ IMPORT STRING TYPE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +AnyType = TypeVar('AnyType') +if TYPE_CHECKING: + ImportString = Annotated[AnyType, ...] +else: + + class ImportString: + @classmethod + def __class_getitem__(cls, item: AnyType) -> AnyType: + return Annotated[item, cls()] + + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.CoreSchema: + if schema is None or schema == {'type': 'any'}: + # Treat bare usage of ImportString (`schema is None`) as the same as ImportString[Any] + return core_schema.function_plain_schema(lambda v, _: _validators.import_string(v)) + else: + return core_schema.function_before_schema(lambda v, _: _validators.import_string(v), schema) + + def __repr__(self) -> str: + return 'ImportString' + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DECIMAL TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +def condecimal( + *, + strict: bool | None = None, + gt: int | Decimal | None = None, + ge: int | Decimal | None = None, + lt: int | Decimal | None = None, + le: int | Decimal | None = None, + multiple_of: int | Decimal | None = None, + max_digits: int | None = None, + decimal_places: int | None = None, + allow_inf_nan: bool | None = None, +) -> Type[Decimal]: + return Annotated[ # type: ignore[return-value] + Decimal, + Strict(strict) if strict is not None else None, + annotated_types.Interval(gt=gt, ge=ge, lt=lt, le=le), + annotated_types.MultipleOf(multiple_of) if multiple_of is not None else None, + _fields.PydanticGeneralMetadata(max_digits=max_digits, decimal_places=decimal_places), + AllowInfNan(allow_inf_nan) if allow_inf_nan is not None else None, + ] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ UUID TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +@_dataclasses.dataclass(frozen=True) # Add frozen=True to make it hashable +class UuidVersion: + uuid_version: Literal[1, 3, 4, 5] + + def __pydantic_modify_json_schema__(self, field_schema: dict[str, Any]) -> None: + field_schema.pop('anyOf', None) # remove the bytes/str union + field_schema.update(type='string', format=f'uuid{self.uuid_version}') + + def __get_pydantic_core_schema__( + self, schema: core_schema.CoreSchema, **_kwargs: Any + ) -> core_schema.FunctionSchema: + return core_schema.function_after_schema(schema, cast(core_schema.ValidatorFunction, self.validate)) + + def validate(self, value: UUID, _: core_schema.ValidationInfo) -> UUID: + if value.version != self.uuid_version: + raise PydanticCustomError( + 'uuid_version', 'uuid version {required_version} expected', {'required_version': self.uuid_version} + ) + return value + + +UUID1 = Annotated[UUID, UuidVersion(1)] +UUID3 = Annotated[UUID, UuidVersion(3)] +UUID4 = Annotated[UUID, UuidVersion(4)] +UUID5 = Annotated[UUID, UuidVersion(5)] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PATH TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +@_dataclasses.dataclass +class PathType: + path_type: Literal['file', 'dir', 'new'] + + def __pydantic_modify_json_schema__(self, field_schema: dict[str, Any]) -> None: + format_conversion = {'file': 'file-path', 'dir': 'directory-path'} + field_schema.update(format=format_conversion.get(self.path_type, 'path'), type='string') + + def __get_pydantic_core_schema__( + self, schema: core_schema.CoreSchema, **_kwargs: Any + ) -> core_schema.FunctionSchema: + function_lookup = { + 'file': cast(core_schema.ValidatorFunction, self.validate_file), + 'dir': cast(core_schema.ValidatorFunction, self.validate_directory), + 'new': cast(core_schema.ValidatorFunction, self.validate_new), + } + + return core_schema.function_after_schema( + schema, + function_lookup[self.path_type], + ) + + @staticmethod + def validate_file(path: Path, _: core_schema.ValidationInfo) -> Path: + if path.is_file(): + return path + else: + raise PydanticCustomError('path_not_file', 'Path does not point to a file') + + @staticmethod + def validate_directory(path: Path, _: core_schema.ValidationInfo) -> Path: + if path.is_dir(): + return path + else: + raise PydanticCustomError('path_not_directory', 'Path does not point to a directory') + + @staticmethod + def validate_new(path: Path, _: core_schema.ValidationInfo) -> Path: + if path.exists(): + raise PydanticCustomError('path_exists', 'path already exists') + elif not path.parent.exists(): + raise PydanticCustomError('parent_does_not_exist', 'Parent directory does not exist') + else: + return path + + +FilePath = Annotated[Path, PathType('file')] +DirectoryPath = Annotated[Path, PathType('dir')] +NewPath = Annotated[Path, PathType('new')] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ JSON TYPE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +if TYPE_CHECKING: + Json = Annotated[AnyType, ...] # Json[list[str]] will be recognized by type checkers as list[str] + +else: + + class Json: + @classmethod + def __class_getitem__(cls, item: AnyType) -> AnyType: + return Annotated[item, cls()] + + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.JsonSchema: + return core_schema.json_schema(schema) + + @classmethod + def __pydantic_modify_json_schema__(cls, field_schema: dict[str, Any]) -> None: + field_schema.update(type='string', format='json-string') + + def __repr__(self) -> str: + return 'Json' + + def __hash__(self) -> int: + return hash(type(self)) + + def __eq__(self, other: Any) -> bool: + return type(other) == type(self) + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SECRET TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +SecretType = TypeVar('SecretType', str, bytes) + + +class SecretField(abc.ABC, Generic[SecretType]): + _error_kind: str + + def __init__(self, secret_value: SecretType) -> None: + self._secret_value: SecretType = secret_value + + def get_secret_value(self) -> SecretType: + return self._secret_value + + @classmethod + def __get_pydantic_core_schema__(cls, **_kwargs: Any) -> core_schema.FunctionSchema: + validator = SecretFieldValidator(cls) + if issubclass(cls, SecretStr): + # Use a lambda here so that `apply_metadata` can be called on the validator before the override is generated + override = lambda: core_schema.str_schema( # noqa E731 + min_length=validator.min_length, + max_length=validator.max_length, + ) + elif issubclass(cls, SecretBytes): + override = lambda: core_schema.bytes_schema( # noqa E731 + min_length=validator.min_length, + max_length=validator.max_length, + ) + else: + override = None + metadata = build_metadata_dict( + update_cs_function=validator.__pydantic_update_schema__, + js_metadata=JsonSchemaMetadata(core_schema_override=override), + ) + return core_schema.function_after_schema( + core_schema.union_schema( + core_schema.is_instance_schema(cls), + cls._pre_core_schema(), + strict=True, + custom_error_type=cls._error_kind, + ), + validator, + metadata=metadata, + serialization=core_schema.function_plain_ser_schema(cls._serialize, json_return_type='str'), + ) + + @classmethod + def _serialize( + cls, value: SecretField[SecretType], info: core_schema.SerializationInfo + ) -> str | SecretField[SecretType]: + if info.mode == 'json': + # we want the output to always be string without the `b'` prefix for byties, + # hence we just use `secret_display` + return secret_display(value) + else: + return value + + @classmethod + @abc.abstractmethod + def _pre_core_schema(cls) -> core_schema.CoreSchema: + ... + + @classmethod + def __pydantic_modify_json_schema__(cls, field_schema: dict[str, Any]) -> None: + update_not_none( + field_schema, + type='string', + writeOnly=True, + format='password', + ) + + def __eq__(self, other: Any) -> bool: + return isinstance(other, self.__class__) and self.get_secret_value() == other.get_secret_value() + + def __hash__(self) -> int: + return hash(self.get_secret_value()) + + def __len__(self) -> int: + return len(self._secret_value) + + @abc.abstractmethod + def _display(self) -> SecretType: + ... + + def __str__(self) -> str: + return str(self._display()) + + def __repr__(self) -> str: + return f'{self.__class__.__name__}({self._display()!r})' + + +def secret_display(secret_field: SecretField[Any]) -> str: + return '**********' if secret_field.get_secret_value() else '' + + +class SecretFieldValidator(_fields.CustomValidator, Generic[SecretType]): + __slots__ = 'field_type', 'min_length', 'max_length', 'error_prefix' + + def __init__( + self, field_type: Type[SecretField[SecretType]], min_length: int | None = None, max_length: int | None = None + ) -> None: + self.field_type: Type[SecretField[SecretType]] = field_type + self.min_length = min_length + self.max_length = max_length + self.error_prefix: Literal['string', 'bytes'] = 'string' if field_type is SecretStr else 'bytes' + + def __call__(self, __value: SecretField[SecretType] | SecretType, _: core_schema.ValidationInfo) -> Any: + if self.min_length is not None and len(__value) < self.min_length: + short_kind: core_schema.ErrorType = f'{self.error_prefix}_too_short' # type: ignore[assignment] + raise PydanticKnownError(short_kind, {'min_length': self.min_length}) + if self.max_length is not None and len(__value) > self.max_length: + long_kind: core_schema.ErrorType = f'{self.error_prefix}_too_long' # type: ignore[assignment] + raise PydanticKnownError(long_kind, {'max_length': self.max_length}) + + if isinstance(__value, self.field_type): + return __value + else: + return self.field_type(__value) # type: ignore[arg-type] + + def __pydantic_update_schema__(self, schema: core_schema.CoreSchema, **constraints: Any) -> None: + self._update_attrs(constraints, {'min_length', 'max_length'}) + + +class SecretStr(SecretField[str]): + _error_kind = 'string_type' + + @classmethod + def _pre_core_schema(cls) -> core_schema.CoreSchema: + return core_schema.str_schema() + + def _display(self) -> str: + return secret_display(self) + + +class SecretBytes(SecretField[bytes]): + _error_kind = 'bytes_type' + + @classmethod + def _pre_core_schema(cls) -> core_schema.CoreSchema: + return core_schema.bytes_schema() + + def _display(self) -> bytes: + return secret_display(self).encode() + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PAYMENT CARD TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +class PaymentCardBrand(str, Enum): + # If you add another card type, please also add it to the + # Hypothesis strategy in `pydantic._hypothesis_plugin`. + amex = 'American Express' + mastercard = 'Mastercard' + visa = 'Visa' + other = 'other' + + def __str__(self) -> str: + return self.value + + +class PaymentCardNumber(str): + """ + Based on: https://en.wikipedia.org/wiki/Payment_card_number + """ + + strip_whitespace: ClassVar[bool] = True + min_length: ClassVar[int] = 12 + max_length: ClassVar[int] = 19 + bin: str + last4: str + brand: PaymentCardBrand + + def __init__(self, card_number: str): + self.validate_digits(card_number) + + card_number = self.validate_luhn_check_digit(card_number) + + self.bin = card_number[:6] + self.last4 = card_number[-4:] + self.brand = self.validate_brand(card_number) + + @classmethod + def __get_pydantic_core_schema__(cls, **_kwargs: Any) -> core_schema.FunctionSchema: + return core_schema.function_after_schema( + core_schema.str_schema( + min_length=cls.min_length, max_length=cls.max_length, strip_whitespace=cls.strip_whitespace + ), + cls.validate, + ) + + @classmethod + def validate(cls, __input_value: str, _: core_schema.ValidationInfo) -> 'PaymentCardNumber': + return cls(__input_value) + + @property + def masked(self) -> str: + num_masked = len(self) - 10 # len(bin) + len(last4) == 10 + return f'{self.bin}{"*" * num_masked}{self.last4}' + + @classmethod + def validate_digits(cls, card_number: str) -> None: + if not card_number.isdigit(): + raise PydanticCustomError('payment_card_number_digits', 'Card number is not all digits') + + @classmethod + def validate_luhn_check_digit(cls, card_number: str) -> str: + """ + Based on: https://en.wikipedia.org/wiki/Luhn_algorithm + """ + sum_ = int(card_number[-1]) + length = len(card_number) + parity = length % 2 + for i in range(length - 1): + digit = int(card_number[i]) + if i % 2 == parity: + digit *= 2 + if digit > 9: + digit -= 9 + sum_ += digit + valid = sum_ % 10 == 0 + if not valid: + raise PydanticCustomError('payment_card_number_luhn', 'Card number is not luhn valid') + return card_number + + @staticmethod + def validate_brand(card_number: str) -> PaymentCardBrand: + """ + Validate length based on BIN for major brands: + https://en.wikipedia.org/wiki/Payment_card_number#Issuer_identification_number_(IIN) + """ + if card_number[0] == '4': + brand = PaymentCardBrand.visa + elif 51 <= int(card_number[:2]) <= 55: + brand = PaymentCardBrand.mastercard + elif card_number[:2] in {'34', '37'}: + brand = PaymentCardBrand.amex + else: + brand = PaymentCardBrand.other + + required_length: Union[None, int, str] = None + if brand in PaymentCardBrand.mastercard: + required_length = 16 + valid = len(card_number) == required_length + elif brand == PaymentCardBrand.visa: + required_length = '13, 16 or 19' + valid = len(card_number) in {13, 16, 19} + elif brand == PaymentCardBrand.amex: + required_length = 15 + valid = len(card_number) == required_length + else: + valid = True + + if not valid: + raise PydanticCustomError( + 'payment_card_number_brand', + 'Length for a {brand} card must be {required_length}', + {'brand': brand, 'required_length': required_length}, + ) + return brand + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BYTE SIZE TYPE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +BYTE_SIZES = { + 'b': 1, + 'kb': 10**3, + 'mb': 10**6, + 'gb': 10**9, + 'tb': 10**12, + 'pb': 10**15, + 'eb': 10**18, + 'kib': 2**10, + 'mib': 2**20, + 'gib': 2**30, + 'tib': 2**40, + 'pib': 2**50, + 'eib': 2**60, +} +BYTE_SIZES.update({k.lower()[0]: v for k, v in BYTE_SIZES.items() if 'i' not in k}) +byte_string_re = re.compile(r'^\s*(\d*\.?\d+)\s*(\w+)?', re.IGNORECASE) + + +class ByteSize(int): + @classmethod + def __get_pydantic_core_schema__(cls, **_kwargs: Any) -> core_schema.FunctionPlainSchema: + # TODO better schema + return core_schema.function_plain_schema(cls.validate) + + @classmethod + def validate(cls, __input_value: Any, _: core_schema.ValidationInfo) -> 'ByteSize': + try: + return cls(int(__input_value)) + except ValueError: + pass + + str_match = byte_string_re.match(str(__input_value)) + if str_match is None: + raise PydanticCustomError('byte_size', 'could not parse value and unit from byte string') + + scalar, unit = str_match.groups() + if unit is None: + unit = 'b' + + try: + unit_mult = BYTE_SIZES[unit.lower()] + except KeyError: + raise PydanticCustomError('byte_size_unit', 'could not interpret byte unit: {unit}', {'unit': unit}) + + return cls(int(float(scalar) * unit_mult)) + + def human_readable(self, decimal: bool = False) -> str: + if decimal: + divisor = 1000 + units = 'B', 'KB', 'MB', 'GB', 'TB', 'PB' + final_unit = 'EB' + else: + divisor = 1024 + units = 'B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB' + final_unit = 'EiB' + + num = float(self) + for unit in units: + if abs(num) < divisor: + if unit == 'B': + return f'{num:0.0f}{unit}' + else: + return f'{num:0.1f}{unit}' + num /= divisor + + return f'{num:0.1f}{final_unit}' + + def to(self, unit: str) -> float: + try: + unit_div = BYTE_SIZES[unit.lower()] + except KeyError: + raise PydanticCustomError('byte_size_unit', 'Could not interpret byte unit: {unit}', {'unit': unit}) + + return self / unit_div + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DATE TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +if TYPE_CHECKING: + PastDate = Annotated[date, ...] + FutureDate = Annotated[date, ...] +else: + + class PastDate: + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.CoreSchema: + if schema is None: + # used directly as a type + return core_schema.date_schema(now_op='past') + else: + assert schema['type'] == 'date' + schema['now_op'] = 'past' + return schema + + def __repr__(self) -> str: + return 'PastDate' + + class FutureDate: + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.CoreSchema: + if schema is None: + # used directly as a type + return core_schema.date_schema(now_op='future') + else: + assert schema['type'] == 'date' + schema['now_op'] = 'future' + return schema + + def __repr__(self) -> str: + return 'FutureDate' + + +def condate(*, strict: bool = None, gt: date = None, ge: date = None, lt: date = None, le: date = None) -> type[date]: + return Annotated[ # type: ignore[return-value] + date, + Strict(strict) if strict is not None else None, + annotated_types.Interval(gt=gt, ge=ge, lt=lt, le=le), + ] + + +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DATETIME TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +if TYPE_CHECKING: + AwareDatetime = Annotated[datetime, ...] + NaiveDatetime = Annotated[datetime, ...] +else: + + class AwareDatetime: + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.CoreSchema: + if schema is None: + # used directly as a type + return core_schema.datetime_schema(tz_constraint='aware') + else: + assert schema['type'] == 'datetime' + schema['tz_constraint'] = 'aware' + return schema + + def __repr__(self) -> str: + return 'AwareDatetime' + + class NaiveDatetime: + @classmethod + def __get_pydantic_core_schema__( + cls, schema: core_schema.CoreSchema | None = None, **_kwargs: Any + ) -> core_schema.CoreSchema: + if schema is None: + # used directly as a type + return core_schema.datetime_schema(tz_constraint='naive') + else: + assert schema['type'] == 'datetime' + schema['tz_constraint'] = 'naive' + return schema + + def __repr__(self) -> str: + return 'NaiveDatetime' diff --git a/crates/ruff_benchmark/resources/pypinyin.py b/crates/ruff_benchmark/resources/pypinyin.py new file mode 100644 index 0000000000000..4dfe41f9d741a --- /dev/null +++ b/crates/ruff_benchmark/resources/pypinyin.py @@ -0,0 +1,161 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +""" +处理汉语拼音方案中的一些特殊情况 + + +汉语拼音方案: + +* https://zh.wiktionary.org/wiki/%E9%99%84%E5%BD%95:%E6%B1%89%E8%AF%AD%E6%8B%BC%E9%9F%B3%E6%96%B9%E6%A1%88 +* http://www.moe.edu.cn/s78/A19/yxs_left/moe_810/s230/195802/t19580201_186000.html +""" # noqa +from __future__ import unicode_literals + +import re + +from pypinyin.style._constants import _FINALS + +# u -> ü +UV_MAP = { + 'u': 'ü', + 'ū': 'ǖ', + 'ú': 'ǘ', + 'ǔ': 'ǚ', + 'ù': 'ǜ', +} +U_TONES = set(UV_MAP.keys()) +# ü行的韵跟声母j，q，x拼的时候，写成ju(居)，qu(区)，xu(虚) +UV_RE = re.compile( + r'^(j|q|x)({tones})(.*)$'.format( + tones='|'.join(UV_MAP.keys()))) +I_TONES = set(['i', 'ī', 'í', 'ǐ', 'ì']) + +# iu -> iou +IU_MAP = { + 'iu': 'iou', + 'iū': 'ioū', + 'iú': 'ioú', + 'iǔ': 'ioǔ', + 'iù': 'ioù', +} +IU_TONES = set(IU_MAP.keys()) +IU_RE = re.compile(r'^([a-z]+)({tones})$'.format(tones='|'.join(IU_TONES))) + +# ui -> uei +UI_MAP = { + 'ui': 'uei', + 'uī': 'ueī', + 'uí': 'ueí', + 'uǐ': 'ueǐ', + 'uì': 'ueì', +} +UI_TONES = set(UI_MAP.keys()) +UI_RE = re.compile(r'([a-z]+)({tones})$'.format(tones='|'.join(UI_TONES))) + +# un -> uen +UN_MAP = { + 'un': 'uen', + 'ūn': 'ūen', + 'ún': 'úen', + 'ǔn': 'ǔen', + 'ùn': 'ùen', +} +UN_TONES = set(UN_MAP.keys()) +UN_RE = re.compile(r'([a-z]+)({tones})$'.format(tones='|'.join(UN_TONES))) + + +def convert_zero_consonant(pinyin): + """零声母转换，还原原始的韵母 + + i行的韵母，前面没有声母的时候，写成yi(衣)，ya(呀)，ye(耶)，yao(腰)， + you(忧)，yan(烟)，yin(因)，yang(央)，ying(英)，yong(雍)。 + + u行的韵母，前面没有声母的时候，写成wu(乌)，wa(蛙)，wo(窝)，wai(歪)， + wei(威)，wan(弯)，wen(温)，wang(汪)，weng(翁)。 + + ü行的韵母，前面没有声母的时候，写成yu(迂)，yue(约)，yuan(冤)， + yun(晕)；ü上两点省略。 + """ + raw_pinyin = pinyin + # y: yu -> v, yi -> i, y -> i + if raw_pinyin.startswith('y'): + # 去除 y 后的拼音 + no_y_py = pinyin[1:] + first_char = no_y_py[0] if len(no_y_py) > 0 else None + + # yu -> ü: yue -> üe + if first_char in U_TONES: + pinyin = UV_MAP[first_char] + pinyin[2:] + # yi -> i: yi -> i + elif first_char in I_TONES: + pinyin = no_y_py + # y -> i: ya -> ia + else: + pinyin = 'i' + no_y_py + + # w: wu -> u, w -> u + if raw_pinyin.startswith('w'): + # 去除 w 后的拼音 + no_w_py = pinyin[1:] + first_char = no_w_py[0] if len(no_w_py) > 0 else None + + # wu -> u: wu -> u + if first_char in U_TONES: + pinyin = pinyin[1:] + # w -> u: wa -> ua + else: + pinyin = 'u' + pinyin[1:] + + # 确保不会出现韵母表中不存在的韵母 + if pinyin not in _FINALS: + return raw_pinyin + + return pinyin + + +def convert_uv(pinyin): + """ü 转换，还原原始的韵母 + + ü行的韵跟声母j，q，x拼的时候，写成ju(居)，qu(区)，xu(虚)， + ü上两点也省略；但是跟声母n，l拼的时候，仍然写成nü(女)，lü(吕)。 + """ + return UV_RE.sub( + lambda m: ''.join((m.group(1), UV_MAP[m.group(2)], m.group(3))), + pinyin) + + +def convert_iou(pinyin): + """iou 转换，还原原始的韵母 + + iou，uei，uen前面加声母的时候，写成iu，ui，un。 + 例如niu(牛)，gui(归)，lun(论)。 + """ + return IU_RE.sub(lambda m: m.group(1) + IU_MAP[m.group(2)], pinyin) + + +def convert_uei(pinyin): + """uei 转换，还原原始的韵母 + + iou，uei，uen前面加声母的时候，写成iu，ui，un。 + 例如niu(牛)，gui(归)，lun(论)。 + """ + return UI_RE.sub(lambda m: m.group(1) + UI_MAP[m.group(2)], pinyin) + + +def convert_uen(pinyin): + """uen 转换，还原原始的韵母 + + iou，uei，uen前面加声母的时候，写成iu，ui，un。 + 例如niu(牛)，gui(归)，lun(论)。 + """ + return UN_RE.sub(lambda m: m.group(1) + UN_MAP[m.group(2)], pinyin) + + +def convert_finals(pinyin): + """还原原始的韵母""" + pinyin = convert_zero_consonant(pinyin) + pinyin = convert_uv(pinyin) + pinyin = convert_iou(pinyin) + pinyin = convert_uei(pinyin) + pinyin = convert_uen(pinyin) + return pinyin diff --git a/crates/ruff_benchmark/resources/tomllib/__init__.py b/crates/ruff_benchmark/resources/tomllib/__init__.py new file mode 100644 index 0000000000000..ef91cb9d25dd7 --- /dev/null +++ b/crates/ruff_benchmark/resources/tomllib/__init__.py @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2021 Taneli Hukkinen +# Licensed to PSF under a Contributor Agreement. + +__all__ = ("loads", "load", "TOMLDecodeError") + +from ._parser import TOMLDecodeError, load, loads + +# Pretend this exception was created here. +TOMLDecodeError.__module__ = __name__ diff --git a/crates/ruff_benchmark/resources/tomllib/_parser.py b/crates/ruff_benchmark/resources/tomllib/_parser.py new file mode 100644 index 0000000000000..45ca7a89630f0 --- /dev/null +++ b/crates/ruff_benchmark/resources/tomllib/_parser.py @@ -0,0 +1,691 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2021 Taneli Hukkinen +# Licensed to PSF under a Contributor Agreement. + +from __future__ import annotations + +from collections.abc import Iterable +import string +from types import MappingProxyType +from typing import Any, BinaryIO, NamedTuple + +from ._re import ( + RE_DATETIME, + RE_LOCALTIME, + RE_NUMBER, + match_to_datetime, + match_to_localtime, + match_to_number, +) +from ._types import Key, ParseFloat, Pos + +ASCII_CTRL = frozenset(chr(i) for i in range(32)) | frozenset(chr(127)) + +# Neither of these sets include quotation mark or backslash. They are +# currently handled as separate cases in the parser functions. +ILLEGAL_BASIC_STR_CHARS = ASCII_CTRL - frozenset("\t") +ILLEGAL_MULTILINE_BASIC_STR_CHARS = ASCII_CTRL - frozenset("\t\n") + +ILLEGAL_LITERAL_STR_CHARS = ILLEGAL_BASIC_STR_CHARS +ILLEGAL_MULTILINE_LITERAL_STR_CHARS = ILLEGAL_MULTILINE_BASIC_STR_CHARS + +ILLEGAL_COMMENT_CHARS = ILLEGAL_BASIC_STR_CHARS + +TOML_WS = frozenset(" \t") +TOML_WS_AND_NEWLINE = TOML_WS | frozenset("\n") +BARE_KEY_CHARS = frozenset(string.ascii_letters + string.digits + "-_") +KEY_INITIAL_CHARS = BARE_KEY_CHARS | frozenset("\"'") +HEXDIGIT_CHARS = frozenset(string.hexdigits) + +BASIC_STR_ESCAPE_REPLACEMENTS = MappingProxyType( + { + "\\b": "\u0008", # backspace + "\\t": "\u0009", # tab + "\\n": "\u000A", # linefeed + "\\f": "\u000C", # form feed + "\\r": "\u000D", # carriage return + '\\"': "\u0022", # quote + "\\\\": "\u005C", # backslash + } +) + + +class TOMLDecodeError(ValueError): + """An error raised if a document is not valid TOML.""" + + +def load(fp: BinaryIO, /, *, parse_float: ParseFloat = float) -> dict[str, Any]: + """Parse TOML from a binary file object.""" + b = fp.read() + try: + s = b.decode() + except AttributeError: + raise TypeError( + "File must be opened in binary mode, e.g. use `open('foo.toml', 'rb')`" + ) from None + return loads(s, parse_float=parse_float) + + +def loads(s: str, /, *, parse_float: ParseFloat = float) -> dict[str, Any]: # noqa: C901 + """Parse TOML from a string.""" + + # The spec allows converting "\r\n" to "\n", even in string + # literals. Let's do so to simplify parsing. + src = s.replace("\r\n", "\n") + pos = 0 + out = Output(NestedDict(), Flags()) + header: Key = () + parse_float = make_safe_parse_float(parse_float) + + # Parse one statement at a time + # (typically means one line in TOML source) + while True: + # 1. Skip line leading whitespace + pos = skip_chars(src, pos, TOML_WS) + + # 2. Parse rules. Expect one of the following: + # - end of file + # - end of line + # - comment + # - key/value pair + # - append dict to list (and move to its namespace) + # - create dict (and move to its namespace) + # Skip trailing whitespace when applicable. + try: + char = src[pos] + except IndexError: + break + if char == "\n": + pos += 1 + continue + if char in KEY_INITIAL_CHARS: + pos = key_value_rule(src, pos, out, header, parse_float) + pos = skip_chars(src, pos, TOML_WS) + elif char == "[": + try: + second_char: str | None = src[pos + 1] + except IndexError: + second_char = None + out.flags.finalize_pending() + if second_char == "[": + pos, header = create_list_rule(src, pos, out) + else: + pos, header = create_dict_rule(src, pos, out) + pos = skip_chars(src, pos, TOML_WS) + elif char != "#": + raise suffixed_err(src, pos, "Invalid statement") + + # 3. Skip comment + pos = skip_comment(src, pos) + + # 4. Expect end of line or end of file + try: + char = src[pos] + except IndexError: + break + if char != "\n": + raise suffixed_err( + src, pos, "Expected newline or end of document after a statement" + ) + pos += 1 + + return out.data.dict + + +class Flags: + """Flags that map to parsed keys/namespaces.""" + + # Marks an immutable namespace (inline array or inline table). + FROZEN = 0 + # Marks a nest that has been explicitly created and can no longer + # be opened using the "[table]" syntax. + EXPLICIT_NEST = 1 + + def __init__(self) -> None: + self._flags: dict[str, dict] = {} + self._pending_flags: set[tuple[Key, int]] = set() + + def add_pending(self, key: Key, flag: int) -> None: + self._pending_flags.add((key, flag)) + + def finalize_pending(self) -> None: + for key, flag in self._pending_flags: + self.set(key, flag, recursive=False) + self._pending_flags.clear() + + def unset_all(self, key: Key) -> None: + cont = self._flags + for k in key[:-1]: + if k not in cont: + return + cont = cont[k]["nested"] + cont.pop(key[-1], None) + + def set(self, key: Key, flag: int, *, recursive: bool) -> None: # noqa: A003 + cont = self._flags + key_parent, key_stem = key[:-1], key[-1] + for k in key_parent: + if k not in cont: + cont[k] = {"flags": set(), "recursive_flags": set(), "nested": {}} + cont = cont[k]["nested"] + if key_stem not in cont: + cont[key_stem] = {"flags": set(), "recursive_flags": set(), "nested": {}} + cont[key_stem]["recursive_flags" if recursive else "flags"].add(flag) + + def is_(self, key: Key, flag: int) -> bool: + if not key: + return False # document root has no flags + cont = self._flags + for k in key[:-1]: + if k not in cont: + return False + inner_cont = cont[k] + if flag in inner_cont["recursive_flags"]: + return True + cont = inner_cont["nested"] + key_stem = key[-1] + if key_stem in cont: + cont = cont[key_stem] + return flag in cont["flags"] or flag in cont["recursive_flags"] + return False + + +class NestedDict: + def __init__(self) -> None: + # The parsed content of the TOML document + self.dict: dict[str, Any] = {} + + def get_or_create_nest( + self, + key: Key, + *, + access_lists: bool = True, + ) -> dict: + cont: Any = self.dict + for k in key: + if k not in cont: + cont[k] = {} + cont = cont[k] + if access_lists and isinstance(cont, list): + cont = cont[-1] + if not isinstance(cont, dict): + raise KeyError("There is no nest behind this key") + return cont + + def append_nest_to_list(self, key: Key) -> None: + cont = self.get_or_create_nest(key[:-1]) + last_key = key[-1] + if last_key in cont: + list_ = cont[last_key] + if not isinstance(list_, list): + raise KeyError("An object other than list found behind this key") + list_.append({}) + else: + cont[last_key] = [{}] + + +class Output(NamedTuple): + data: NestedDict + flags: Flags + + +def skip_chars(src: str, pos: Pos, chars: Iterable[str]) -> Pos: + try: + while src[pos] in chars: + pos += 1 + except IndexError: + pass + return pos + + +def skip_until( + src: str, + pos: Pos, + expect: str, + *, + error_on: frozenset[str], + error_on_eof: bool, +) -> Pos: + try: + new_pos = src.index(expect, pos) + except ValueError: + new_pos = len(src) + if error_on_eof: + raise suffixed_err(src, new_pos, f"Expected {expect!r}") from None + + if not error_on.isdisjoint(src[pos:new_pos]): + while src[pos] not in error_on: + pos += 1 + raise suffixed_err(src, pos, f"Found invalid character {src[pos]!r}") + return new_pos + + +def skip_comment(src: str, pos: Pos) -> Pos: + try: + char: str | None = src[pos] + except IndexError: + char = None + if char == "#": + return skip_until( + src, pos + 1, "\n", error_on=ILLEGAL_COMMENT_CHARS, error_on_eof=False + ) + return pos + + +def skip_comments_and_array_ws(src: str, pos: Pos) -> Pos: + while True: + pos_before_skip = pos + pos = skip_chars(src, pos, TOML_WS_AND_NEWLINE) + pos = skip_comment(src, pos) + if pos == pos_before_skip: + return pos + + +def create_dict_rule(src: str, pos: Pos, out: Output) -> tuple[Pos, Key]: + pos += 1 # Skip "[" + pos = skip_chars(src, pos, TOML_WS) + pos, key = parse_key(src, pos) + + if out.flags.is_(key, Flags.EXPLICIT_NEST) or out.flags.is_(key, Flags.FROZEN): + raise suffixed_err(src, pos, f"Cannot declare {key} twice") + out.flags.set(key, Flags.EXPLICIT_NEST, recursive=False) + try: + out.data.get_or_create_nest(key) + except KeyError: + raise suffixed_err(src, pos, "Cannot overwrite a value") from None + + if not src.startswith("]", pos): + raise suffixed_err(src, pos, "Expected ']' at the end of a table declaration") + return pos + 1, key + + +def create_list_rule(src: str, pos: Pos, out: Output) -> tuple[Pos, Key]: + pos += 2 # Skip "[[" + pos = skip_chars(src, pos, TOML_WS) + pos, key = parse_key(src, pos) + + if out.flags.is_(key, Flags.FROZEN): + raise suffixed_err(src, pos, f"Cannot mutate immutable namespace {key}") + # Free the namespace now that it points to another empty list item... + out.flags.unset_all(key) + # ...but this key precisely is still prohibited from table declaration + out.flags.set(key, Flags.EXPLICIT_NEST, recursive=False) + try: + out.data.append_nest_to_list(key) + except KeyError: + raise suffixed_err(src, pos, "Cannot overwrite a value") from None + + if not src.startswith("]]", pos): + raise suffixed_err(src, pos, "Expected ']]' at the end of an array declaration") + return pos + 2, key + + +def key_value_rule( + src: str, pos: Pos, out: Output, header: Key, parse_float: ParseFloat +) -> Pos: + pos, key, value = parse_key_value_pair(src, pos, parse_float) + key_parent, key_stem = key[:-1], key[-1] + abs_key_parent = header + key_parent + + relative_path_cont_keys = (header + key[:i] for i in range(1, len(key))) + for cont_key in relative_path_cont_keys: + # Check that dotted key syntax does not redefine an existing table + if out.flags.is_(cont_key, Flags.EXPLICIT_NEST): + raise suffixed_err(src, pos, f"Cannot redefine namespace {cont_key}") + # Containers in the relative path can't be opened with the table syntax or + # dotted key/value syntax in following table sections. + out.flags.add_pending(cont_key, Flags.EXPLICIT_NEST) + + if out.flags.is_(abs_key_parent, Flags.FROZEN): + raise suffixed_err( + src, pos, f"Cannot mutate immutable namespace {abs_key_parent}" + ) + + try: + nest = out.data.get_or_create_nest(abs_key_parent) + except KeyError: + raise suffixed_err(src, pos, "Cannot overwrite a value") from None + if key_stem in nest: + raise suffixed_err(src, pos, "Cannot overwrite a value") + # Mark inline table and array namespaces recursively immutable + if isinstance(value, (dict, list)): + out.flags.set(header + key, Flags.FROZEN, recursive=True) + nest[key_stem] = value + return pos + + +def parse_key_value_pair( + src: str, pos: Pos, parse_float: ParseFloat +) -> tuple[Pos, Key, Any]: + pos, key = parse_key(src, pos) + try: + char: str | None = src[pos] + except IndexError: + char = None + if char != "=": + raise suffixed_err(src, pos, "Expected '=' after a key in a key/value pair") + pos += 1 + pos = skip_chars(src, pos, TOML_WS) + pos, value = parse_value(src, pos, parse_float) + return pos, key, value + + +def parse_key(src: str, pos: Pos) -> tuple[Pos, Key]: + pos, key_part = parse_key_part(src, pos) + key: Key = (key_part,) + pos = skip_chars(src, pos, TOML_WS) + while True: + try: + char: str | None = src[pos] + except IndexError: + char = None + if char != ".": + return pos, key + pos += 1 + pos = skip_chars(src, pos, TOML_WS) + pos, key_part = parse_key_part(src, pos) + key += (key_part,) + pos = skip_chars(src, pos, TOML_WS) + + +def parse_key_part(src: str, pos: Pos) -> tuple[Pos, str]: + try: + char: str | None = src[pos] + except IndexError: + char = None + if char in BARE_KEY_CHARS: + start_pos = pos + pos = skip_chars(src, pos, BARE_KEY_CHARS) + return pos, src[start_pos:pos] + if char == "'": + return parse_literal_str(src, pos) + if char == '"': + return parse_one_line_basic_str(src, pos) + raise suffixed_err(src, pos, "Invalid initial character for a key part") + + +def parse_one_line_basic_str(src: str, pos: Pos) -> tuple[Pos, str]: + pos += 1 + return parse_basic_str(src, pos, multiline=False) + + +def parse_array(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, list]: + pos += 1 + array: list = [] + + pos = skip_comments_and_array_ws(src, pos) + if src.startswith("]", pos): + return pos + 1, array + while True: + pos, val = parse_value(src, pos, parse_float) + array.append(val) + pos = skip_comments_and_array_ws(src, pos) + + c = src[pos : pos + 1] + if c == "]": + return pos + 1, array + if c != ",": + raise suffixed_err(src, pos, "Unclosed array") + pos += 1 + + pos = skip_comments_and_array_ws(src, pos) + if src.startswith("]", pos): + return pos + 1, array + + +def parse_inline_table(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, dict]: + pos += 1 + nested_dict = NestedDict() + flags = Flags() + + pos = skip_chars(src, pos, TOML_WS) + if src.startswith("}", pos): + return pos + 1, nested_dict.dict + while True: + pos, key, value = parse_key_value_pair(src, pos, parse_float) + key_parent, key_stem = key[:-1], key[-1] + if flags.is_(key, Flags.FROZEN): + raise suffixed_err(src, pos, f"Cannot mutate immutable namespace {key}") + try: + nest = nested_dict.get_or_create_nest(key_parent, access_lists=False) + except KeyError: + raise suffixed_err(src, pos, "Cannot overwrite a value") from None + if key_stem in nest: + raise suffixed_err(src, pos, f"Duplicate inline table key {key_stem!r}") + nest[key_stem] = value + pos = skip_chars(src, pos, TOML_WS) + c = src[pos : pos + 1] + if c == "}": + return pos + 1, nested_dict.dict + if c != ",": + raise suffixed_err(src, pos, "Unclosed inline table") + if isinstance(value, (dict, list)): + flags.set(key, Flags.FROZEN, recursive=True) + pos += 1 + pos = skip_chars(src, pos, TOML_WS) + + +def parse_basic_str_escape( + src: str, pos: Pos, *, multiline: bool = False +) -> tuple[Pos, str]: + escape_id = src[pos : pos + 2] + pos += 2 + if multiline and escape_id in {"\\ ", "\\\t", "\\\n"}: + # Skip whitespace until next non-whitespace character or end of + # the doc. Error if non-whitespace is found before newline. + if escape_id != "\\\n": + pos = skip_chars(src, pos, TOML_WS) + try: + char = src[pos] + except IndexError: + return pos, "" + if char != "\n": + raise suffixed_err(src, pos, "Unescaped '\\' in a string") + pos += 1 + pos = skip_chars(src, pos, TOML_WS_AND_NEWLINE) + return pos, "" + if escape_id == "\\u": + return parse_hex_char(src, pos, 4) + if escape_id == "\\U": + return parse_hex_char(src, pos, 8) + try: + return pos, BASIC_STR_ESCAPE_REPLACEMENTS[escape_id] + except KeyError: + raise suffixed_err(src, pos, "Unescaped '\\' in a string") from None + + +def parse_basic_str_escape_multiline(src: str, pos: Pos) -> tuple[Pos, str]: + return parse_basic_str_escape(src, pos, multiline=True) + + +def parse_hex_char(src: str, pos: Pos, hex_len: int) -> tuple[Pos, str]: + hex_str = src[pos : pos + hex_len] + if len(hex_str) != hex_len or not HEXDIGIT_CHARS.issuperset(hex_str): + raise suffixed_err(src, pos, "Invalid hex value") + pos += hex_len + hex_int = int(hex_str, 16) + if not is_unicode_scalar_value(hex_int): + raise suffixed_err(src, pos, "Escaped character is not a Unicode scalar value") + return pos, chr(hex_int) + + +def parse_literal_str(src: str, pos: Pos) -> tuple[Pos, str]: + pos += 1 # Skip starting apostrophe + start_pos = pos + pos = skip_until( + src, pos, "'", error_on=ILLEGAL_LITERAL_STR_CHARS, error_on_eof=True + ) + return pos + 1, src[start_pos:pos] # Skip ending apostrophe + + +def parse_multiline_str(src: str, pos: Pos, *, literal: bool) -> tuple[Pos, str]: + pos += 3 + if src.startswith("\n", pos): + pos += 1 + + if literal: + delim = "'" + end_pos = skip_until( + src, + pos, + "'''", + error_on=ILLEGAL_MULTILINE_LITERAL_STR_CHARS, + error_on_eof=True, + ) + result = src[pos:end_pos] + pos = end_pos + 3 + else: + delim = '"' + pos, result = parse_basic_str(src, pos, multiline=True) + + # Add at maximum two extra apostrophes/quotes if the end sequence + # is 4 or 5 chars long instead of just 3. + if not src.startswith(delim, pos): + return pos, result + pos += 1 + if not src.startswith(delim, pos): + return pos, result + delim + pos += 1 + return pos, result + (delim * 2) + + +def parse_basic_str(src: str, pos: Pos, *, multiline: bool) -> tuple[Pos, str]: + if multiline: + error_on = ILLEGAL_MULTILINE_BASIC_STR_CHARS + parse_escapes = parse_basic_str_escape_multiline + else: + error_on = ILLEGAL_BASIC_STR_CHARS + parse_escapes = parse_basic_str_escape + result = "" + start_pos = pos + while True: + try: + char = src[pos] + except IndexError: + raise suffixed_err(src, pos, "Unterminated string") from None + if char == '"': + if not multiline: + return pos + 1, result + src[start_pos:pos] + if src.startswith('"""', pos): + return pos + 3, result + src[start_pos:pos] + pos += 1 + continue + if char == "\\": + result += src[start_pos:pos] + pos, parsed_escape = parse_escapes(src, pos) + result += parsed_escape + start_pos = pos + continue + if char in error_on: + raise suffixed_err(src, pos, f"Illegal character {char!r}") + pos += 1 + + +def parse_value( # noqa: C901 + src: str, pos: Pos, parse_float: ParseFloat +) -> tuple[Pos, Any]: + try: + char: str | None = src[pos] + except IndexError: + char = None + + # IMPORTANT: order conditions based on speed of checking and likelihood + + # Basic strings + if char == '"': + if src.startswith('"""', pos): + return parse_multiline_str(src, pos, literal=False) + return parse_one_line_basic_str(src, pos) + + # Literal strings + if char == "'": + if src.startswith("'''", pos): + return parse_multiline_str(src, pos, literal=True) + return parse_literal_str(src, pos) + + # Booleans + if char == "t": + if src.startswith("true", pos): + return pos + 4, True + if char == "f": + if src.startswith("false", pos): + return pos + 5, False + + # Arrays + if char == "[": + return parse_array(src, pos, parse_float) + + # Inline tables + if char == "{": + return parse_inline_table(src, pos, parse_float) + + # Dates and times + datetime_match = RE_DATETIME.match(src, pos) + if datetime_match: + try: + datetime_obj = match_to_datetime(datetime_match) + except ValueError as e: + raise suffixed_err(src, pos, "Invalid date or datetime") from e + return datetime_match.end(), datetime_obj + localtime_match = RE_LOCALTIME.match(src, pos) + if localtime_match: + return localtime_match.end(), match_to_localtime(localtime_match) + + # Integers and "normal" floats. + # The regex will greedily match any type starting with a decimal + # char, so needs to be located after handling of dates and times. + number_match = RE_NUMBER.match(src, pos) + if number_match: + return number_match.end(), match_to_number(number_match, parse_float) + + # Special floats + first_three = src[pos : pos + 3] + if first_three in {"inf", "nan"}: + return pos + 3, parse_float(first_three) + first_four = src[pos : pos + 4] + if first_four in {"-inf", "+inf", "-nan", "+nan"}: + return pos + 4, parse_float(first_four) + + raise suffixed_err(src, pos, "Invalid value") + + +def suffixed_err(src: str, pos: Pos, msg: str) -> TOMLDecodeError: + """Return a `TOMLDecodeError` where error message is suffixed with + coordinates in source.""" + + def coord_repr(src: str, pos: Pos) -> str: + if pos >= len(src): + return "end of document" + line = src.count("\n", 0, pos) + 1 + if line == 1: + column = pos + 1 + else: + column = pos - src.rindex("\n", 0, pos) + return f"line {line}, column {column}" + + return TOMLDecodeError(f"{msg} (at {coord_repr(src, pos)})") + + +def is_unicode_scalar_value(codepoint: int) -> bool: + return (0 <= codepoint <= 55295) or (57344 <= codepoint <= 1114111) + + +def make_safe_parse_float(parse_float: ParseFloat) -> ParseFloat: + """A decorator to make `parse_float` safe. + + `parse_float` must not return dicts or lists, because these types + would be mixed with parsed TOML tables and arrays, thus confusing + the parser. The returned decorated callable raises `ValueError` + instead of returning illegal types. + """ + # The default `float` callable never returns illegal types. Optimize it. + if parse_float is float: # type: ignore[comparison-overlap] + return float + + def safe_parse_float(float_str: str) -> Any: + float_value = parse_float(float_str) + if isinstance(float_value, (dict, list)): + raise ValueError("parse_float must not return dicts or lists") + return float_value + + return safe_parse_float diff --git a/crates/ruff_benchmark/resources/tomllib/_re.py b/crates/ruff_benchmark/resources/tomllib/_re.py new file mode 100644 index 0000000000000..994bb7493fd92 --- /dev/null +++ b/crates/ruff_benchmark/resources/tomllib/_re.py @@ -0,0 +1,107 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2021 Taneli Hukkinen +# Licensed to PSF under a Contributor Agreement. + +from __future__ import annotations + +from datetime import date, datetime, time, timedelta, timezone, tzinfo +from functools import lru_cache +import re +from typing import Any + +from ._types import ParseFloat + +# E.g. +# - 00:32:00.999999 +# - 00:32:00 +_TIME_RE_STR = r"([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])(?:\.([0-9]{1,6})[0-9]*)?" + +RE_NUMBER = re.compile( + r""" +0 +(?: + x[0-9A-Fa-f](?:_?[0-9A-Fa-f])* # hex + | + b[01](?:_?[01])* # bin + | + o[0-7](?:_?[0-7])* # oct +) +| +[+-]?(?:0|[1-9](?:_?[0-9])*) # dec, integer part +(?P<floatpart> + (?:\.[0-9](?:_?[0-9])*)? # optional fractional part + (?:[eE][+-]?[0-9](?:_?[0-9])*)? # optional exponent part +) +""", + flags=re.VERBOSE, +) +RE_LOCALTIME = re.compile(_TIME_RE_STR) +RE_DATETIME = re.compile( + rf""" +([0-9]{{4}})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) # date, e.g. 1988-10-27 +(?: + [Tt ] + {_TIME_RE_STR} + (?:([Zz])|([+-])([01][0-9]|2[0-3]):([0-5][0-9]))? # optional time offset +)? +""", + flags=re.VERBOSE, +) + + +def match_to_datetime(match: re.Match) -> datetime | date: + """Convert a `RE_DATETIME` match to `datetime.datetime` or `datetime.date`. + + Raises ValueError if the match does not correspond to a valid date + or datetime. + """ + ( + year_str, + month_str, + day_str, + hour_str, + minute_str, + sec_str, + micros_str, + zulu_time, + offset_sign_str, + offset_hour_str, + offset_minute_str, + ) = match.groups() + year, month, day = int(year_str), int(month_str), int(day_str) + if hour_str is None: + return date(year, month, day) + hour, minute, sec = int(hour_str), int(minute_str), int(sec_str) + micros = int(micros_str.ljust(6, "0")) if micros_str else 0 + if offset_sign_str: + tz: tzinfo | None = cached_tz( + offset_hour_str, offset_minute_str, offset_sign_str + ) + elif zulu_time: + tz = timezone.utc + else: # local date-time + tz = None + return datetime(year, month, day, hour, minute, sec, micros, tzinfo=tz) + + +@lru_cache(maxsize=None) +def cached_tz(hour_str: str, minute_str: str, sign_str: str) -> timezone: + sign = 1 if sign_str == "+" else -1 + return timezone( + timedelta( + hours=sign * int(hour_str), + minutes=sign * int(minute_str), + ) + ) + + +def match_to_localtime(match: re.Match) -> time: + hour_str, minute_str, sec_str, micros_str = match.groups() + micros = int(micros_str.ljust(6, "0")) if micros_str else 0 + return time(int(hour_str), int(minute_str), int(sec_str), micros) + + +def match_to_number(match: re.Match, parse_float: ParseFloat) -> Any: + if match.group("floatpart"): + return parse_float(match.group()) + return int(match.group(), 0) diff --git a/crates/ruff_benchmark/resources/tomllib/_types.py b/crates/ruff_benchmark/resources/tomllib/_types.py new file mode 100644 index 0000000000000..d949412e03b29 --- /dev/null +++ b/crates/ruff_benchmark/resources/tomllib/_types.py @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2021 Taneli Hukkinen +# Licensed to PSF under a Contributor Agreement. + +from typing import Any, Callable, Tuple + +# Type annotations +ParseFloat = Callable[[str], Any] +Key = Tuple[str, ...] +Pos = int diff --git a/crates/ruff_benchmark/src/lib.rs b/crates/ruff_benchmark/src/lib.rs index cb6236c29a1e5..3ecde5e8f8ee2 100644 --- a/crates/ruff_benchmark/src/lib.rs +++ b/crates/ruff_benchmark/src/lib.rs @@ -1,10 +1,32 @@ +use std::path::PathBuf; + pub mod criterion; -use std::fmt::{Display, Formatter}; -use std::path::PathBuf; -use std::process::Command; +pub static NUMPY_GLOBALS: TestFile = TestFile::new( + "numpy/globals.py", + include_str!("../resources/numpy/globals.py"), +); + +pub static UNICODE_PYPINYIN: TestFile = TestFile::new( + "unicode/pypinyin.py", + include_str!("../resources/pypinyin.py"), +); + +pub static PYDANTIC_TYPES: TestFile = TestFile::new( + "pydantic/types.py", + include_str!("../resources/pydantic/types.py"), +); + +pub static NUMPY_CTYPESLIB: TestFile = TestFile::new( + "numpy/ctypeslib.py", + include_str!("../resources/numpy/ctypeslib.py"), +); -use url::Url; +// "https://raw.githubusercontent.com/DHI/mikeio/b7d26418f4db2909b0aa965253dbe83194d7bb5b/tests/test_dataset.py" +pub static LARGE_DATASET: TestFile = TestFile::new( + "large/dataset.py", + include_str!("../resources/large/dataset.py"), +); /// Relative size of a test case. Benchmarks can use it to configure the time for how long a benchmark should run to get stable results. #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)] @@ -26,35 +48,33 @@ pub struct TestCase { } impl TestCase { - pub fn fast(file: TestFile) -> Self { + pub const fn fast(file: TestFile) -> Self { Self { file, speed: TestCaseSpeed::Fast, } } - pub fn normal(file: TestFile) -> Self { + pub const fn normal(file: TestFile) -> Self { Self { file, speed: TestCaseSpeed::Normal, } } - pub fn slow(file: TestFile) -> Self { + pub const fn slow(file: TestFile) -> Self { Self { file, speed: TestCaseSpeed::Slow, } } -} -impl TestCase { pub fn code(&self) -> &str { - &self.file.code + self.file.code } pub fn name(&self) -> &str { - &self.file.name + self.file.name } pub fn speed(&self) -> TestCaseSpeed { @@ -62,119 +82,32 @@ impl TestCase { } pub fn path(&self) -> PathBuf { - TARGET_DIR.join(self.name()) + PathBuf::from(file!()) + .parent() + .unwrap() + .parent() + .unwrap() + .join("resources") + .join(self.name()) } } #[derive(Debug, Clone)] pub struct TestFile { - name: String, - code: String, -} - -impl TestFile { - pub fn code(&self) -> &str { - &self.code - } - - pub fn name(&self) -> &str { - &self.name - } -} - -static TARGET_DIR: std::sync::LazyLock<PathBuf> = std::sync::LazyLock::new(|| { - cargo_target_directory().unwrap_or_else(|| PathBuf::from("target")) -}); - -fn cargo_target_directory() -> Option<PathBuf> { - #[derive(serde::Deserialize)] - struct Metadata { - target_directory: PathBuf, - } - - std::env::var_os("CARGO_TARGET_DIR") - .map(PathBuf::from) - .or_else(|| { - let output = Command::new(std::env::var_os("CARGO")?) - .args(["metadata", "--format-version", "1"]) - .output() - .ok()?; - let metadata: Metadata = serde_json::from_slice(&output.stdout).ok()?; - Some(metadata.target_directory) - }) + name: &'static str, + code: &'static str, } impl TestFile { - pub fn new(name: String, code: String) -> Self { + pub const fn new(name: &'static str, code: &'static str) -> Self { Self { name, code } } - #[allow(clippy::print_stderr)] - pub fn try_download(name: &str, url: &str) -> Result<TestFile, TestFileDownloadError> { - let url = Url::parse(url)?; - - let cached_filename = TARGET_DIR.join(name); - - if let Ok(content) = std::fs::read_to_string(&cached_filename) { - Ok(TestFile::new(name.to_string(), content)) - } else { - // File not yet cached, download and cache it in the target directory - let response = ureq::get(url.as_str()).call()?; - - let content = response.into_string()?; - - // SAFETY: There's always the `target` directory - let parent = cached_filename.parent().unwrap(); - if let Err(error) = std::fs::create_dir_all(parent) { - eprintln!("Failed to create the directory for the test case {name}: {error}"); - } else if let Err(error) = std::fs::write(cached_filename, &content) { - eprintln!("Failed to cache test case file downloaded from {url}: {error}"); - } - - Ok(TestFile::new(name.to_string(), content)) - } - } -} - -#[derive(Debug)] -pub enum TestFileDownloadError { - UrlParse(url::ParseError), - Request(Box<ureq::Error>), - Download(std::io::Error), -} - -impl From<url::ParseError> for TestFileDownloadError { - fn from(value: url::ParseError) -> Self { - Self::UrlParse(value) - } -} - -impl From<ureq::Error> for TestFileDownloadError { - fn from(value: ureq::Error) -> Self { - Self::Request(Box::new(value)) - } -} - -impl From<std::io::Error> for TestFileDownloadError { - fn from(value: std::io::Error) -> Self { - Self::Download(value) + pub fn code(&self) -> &str { + self.code } -} -impl Display for TestFileDownloadError { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - match self { - TestFileDownloadError::UrlParse(inner) => { - write!(f, "Failed to parse url: {inner}") - } - TestFileDownloadError::Request(inner) => { - write!(f, "Failed to download file: {inner}") - } - TestFileDownloadError::Download(inner) => { - write!(f, "Failed to download file: {inner}") - } - } + pub fn name(&self) -> &str { + self.name } } - -impl std::error::Error for TestFileDownloadError {} diff --git a/crates/ruff_cache/src/cache_key.rs b/crates/ruff_cache/src/cache_key.rs index de66961dce44f..e371f4baba35b 100644 --- a/crates/ruff_cache/src/cache_key.rs +++ b/crates/ruff_cache/src/cache_key.rs @@ -2,8 +2,8 @@ use std::borrow::Cow; use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet}; use std::hash::{Hash, Hasher}; use std::num::{ - NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8, NonZeroU128, NonZeroU16, - NonZeroU32, NonZeroU64, NonZeroU8, + NonZeroI8, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI128, NonZeroU8, NonZeroU16, NonZeroU32, + NonZeroU64, NonZeroU128, }; use std::path::{Path, PathBuf}; @@ -213,7 +213,7 @@ macro_rules! impl_cache_key_tuple { ( $($name:ident)+) => ( impl<$($name: CacheKey),+> CacheKey for ($($name,)+) where last_type!($($name,)+): ?Sized { - #[allow(non_snake_case)] + #[expect(non_snake_case)] #[inline] fn cache_key(&self, state: &mut CacheKeyHasher) { let ($(ref $name,)+) = *self; diff --git a/crates/ruff_cache/tests/cache_key.rs b/crates/ruff_cache/tests/cache_key.rs index f78697880661c..0027e32953624 100644 --- a/crates/ruff_cache/tests/cache_key.rs +++ b/crates/ruff_cache/tests/cache_key.rs @@ -47,7 +47,7 @@ fn struct_ignored_fields() { struct NamedFieldsStruct { a: String, #[cache_key(ignore)] - #[allow(unused)] + #[expect(unused)] b: String, } diff --git a/crates/ruff_db/Cargo.toml b/crates/ruff_db/Cargo.toml index 3410fe7449cfc..f36a49810c968 100644 --- a/crates/ruff_db/Cargo.toml +++ b/crates/ruff_db/Cargo.toml @@ -11,6 +11,7 @@ repository = { workspace = true } license = { workspace = true } [dependencies] +ruff_annotate_snippets = { workspace = true } ruff_cache = { workspace = true, optional = true } ruff_notebook = { workspace = true } ruff_python_ast = { workspace = true } @@ -19,33 +20,38 @@ ruff_python_trivia = { workspace = true } ruff_source_file = { workspace = true } ruff_text_size = { workspace = true } +anstyle = { workspace = true } camino = { workspace = true } countme = { workspace = true } dashmap = { workspace = true } +dunce = { workspace = true } filetime = { workspace = true } +glob = { workspace = true } ignore = { workspace = true, optional = true } matchit = { workspace = true } salsa = { workspace = true } +schemars = { workspace = true, optional = true } serde = { workspace = true, optional = true } path-slash = { workspace = true } thiserror = { workspace = true } tracing = { workspace = true } tracing-subscriber = { workspace = true, optional = true } -tracing-tree = { workspace = true, optional = true } rustc-hash = { workspace = true } zip = { workspace = true } [target.'cfg(target_arch="wasm32")'.dependencies] web-time = { version = "1.1.0" } +[target.'cfg(not(target_arch="wasm32"))'.dependencies] +etcetera = { workspace = true, optional = true } + [dev-dependencies] insta = { workspace = true } tempfile = { workspace = true } [features] -default = ["os"] cache = ["ruff_cache"] -os = ["ignore"] +os = ["ignore", "dep:etcetera"] serde = ["dep:serde", "camino/serde1"] # Exposes testing utilities. -testing = ["tracing-subscriber", "tracing-tree"] +testing = ["tracing-subscriber"] diff --git a/crates/ruff_db/src/diagnostic/mod.rs b/crates/ruff_db/src/diagnostic/mod.rs new file mode 100644 index 0000000000000..8c373ca1e4c62 --- /dev/null +++ b/crates/ruff_db/src/diagnostic/mod.rs @@ -0,0 +1,1109 @@ +use std::{fmt::Formatter, sync::Arc}; + +use render::{FileResolver, Input}; +use ruff_source_file::{SourceCode, SourceFile}; + +use ruff_annotate_snippets::Level as AnnotateLevel; +use ruff_text_size::{Ranged, TextRange}; + +pub use self::render::DisplayDiagnostic; +use crate::{Db, files::File}; + +mod render; +mod stylesheet; + +/// A collection of information that can be rendered into a diagnostic. +/// +/// A diagnostic is a collection of information gathered by a tool intended +/// for presentation to an end user, and which describes a group of related +/// characteristics in the inputs given to the tool. Typically, but not always, +/// a characteristic is a deficiency. An example of a characteristic that is +/// _not_ a deficiency is the `reveal_type` diagnostic for our type checker. +#[derive(Debug, Clone, Eq, PartialEq)] +pub struct Diagnostic { + /// The actual diagnostic. + /// + /// We box the diagnostic since it is somewhat big. + inner: Arc<DiagnosticInner>, +} + +impl Diagnostic { + /// Create a new diagnostic with the given identifier, severity and + /// message. + /// + /// The identifier should be something that uniquely identifies the _type_ + /// of diagnostic being reported. It should be usable as a reference point + /// for humans communicating about diagnostic categories. It will also + /// appear in the output when this diagnostic is rendered. + /// + /// The severity should describe the assumed level of importance to an end + /// user. + /// + /// The message is meant to be read by end users. The primary message + /// is meant to be a single terse description (usually a short phrase) + /// describing the group of related characteristics that the diagnostic + /// describes. Stated differently, if only one thing from a diagnostic can + /// be shown to an end user in a particular context, it is the primary + /// message. + /// + /// # Types implementing `IntoDiagnosticMessage` + /// + /// Callers can pass anything that implements `std::fmt::Display` + /// directly. If callers want or need to avoid cloning the diagnostic + /// message, then they can also pass a `DiagnosticMessage` directly. + pub fn new<'a>( + id: DiagnosticId, + severity: Severity, + message: impl IntoDiagnosticMessage + 'a, + ) -> Diagnostic { + let inner = Arc::new(DiagnosticInner { + id, + severity, + message: message.into_diagnostic_message(), + annotations: vec![], + subs: vec![], + }); + Diagnostic { inner } + } + + /// Add an annotation to this diagnostic. + /// + /// Annotations for a diagnostic are optional, but if any are added, + /// callers should strive to make at least one of them primary. That is, it + /// should be constructed via [`Annotation::primary`]. A diagnostic with no + /// primary annotations is allowed, but its rendering may be sub-optimal. + pub fn annotate(&mut self, ann: Annotation) { + Arc::make_mut(&mut self.inner).annotations.push(ann); + } + + /// Adds an "info" sub-diagnostic with the given message. + /// + /// If callers want to add an "info" sub-diagnostic with annotations, then + /// create a [`SubDiagnostic`] manually and use [`Diagnostic::sub`] to + /// attach it to a parent diagnostic. + /// + /// An "info" diagnostic is useful when contextualizing or otherwise + /// helpful information can be added to help end users understand the + /// main diagnostic message better. For example, if a the main diagnostic + /// message is about a function call being invalid, a useful "info" + /// sub-diagnostic could show the function definition (or only the relevant + /// parts of it). + /// + /// # Types implementing `IntoDiagnosticMessage` + /// + /// Callers can pass anything that implements `std::fmt::Display` + /// directly. If callers want or need to avoid cloning the diagnostic + /// message, then they can also pass a `DiagnosticMessage` directly. + pub fn info<'a>(&mut self, message: impl IntoDiagnosticMessage + 'a) { + self.sub(SubDiagnostic::new(Severity::Info, message)); + } + + /// Adds a "sub" diagnostic to this diagnostic. + /// + /// This is useful when a sub diagnostic has its own annotations attached + /// to it. For the simpler case of a sub-diagnostic with only a message, + /// using a method like [`Diagnostic::info`] may be more convenient. + pub fn sub(&mut self, sub: SubDiagnostic) { + Arc::make_mut(&mut self.inner).subs.push(sub); + } + + /// Return a `std::fmt::Display` implementation that renders this + /// diagnostic into a human readable format. + /// + /// Note that this `Display` impl includes a trailing line terminator, so + /// callers should prefer using this with `write!` instead of `writeln!`. + pub fn display<'a>( + &'a self, + resolver: &'a dyn FileResolver, + config: &'a DisplayDiagnosticConfig, + ) -> DisplayDiagnostic<'a> { + DisplayDiagnostic::new(resolver, config, self) + } + + /// Returns the identifier for this diagnostic. + pub fn id(&self) -> DiagnosticId { + self.inner.id + } + + /// Returns the primary message for this diagnostic. + /// + /// A diagnostic always has a message, but it may be empty. + /// + /// NOTE: At present, this routine will return the first primary + /// annotation's message as the primary message when the main diagnostic + /// message is empty. This is meant to facilitate an incremental migration + /// in ty over to the new diagnostic data model. (The old data model + /// didn't distinguish between messages on the entire diagnostic and + /// messages attached to a particular span.) + pub fn primary_message(&self) -> &str { + if !self.inner.message.as_str().is_empty() { + return self.inner.message.as_str(); + } + // FIXME: As a special case, while we're migrating ty + // to the new diagnostic data model, we'll look for a primary + // message from the primary annotation. This is because most + // ty diagnostics are created with an empty diagnostic + // message and instead attach the message to the annotation. + // Fixing this will require touching basically every diagnostic + // in ty, so we do it this way for now to match the old + // semantics. ---AG + self.primary_annotation() + .and_then(|ann| ann.get_message()) + .unwrap_or_default() + } + + /// Introspects this diagnostic and returns what kind of "primary" message + /// it contains for concise formatting. + /// + /// When we concisely format diagnostics, we likely want to not only + /// include the primary diagnostic message but also the message attached + /// to the primary annotation. In particular, the primary annotation often + /// contains *essential* information or context for understanding the + /// diagnostic. + /// + /// The reason why we don't just always return both the main diagnostic + /// message and the primary annotation message is because this was written + /// in the midst of an incremental migration of ty over to the new + /// diagnostic data model. At time of writing, diagnostics were still + /// constructed in the old model where the main diagnostic message and the + /// primary annotation message were not distinguished from each other. So + /// for now, we carefully return what kind of messages this diagnostic + /// contains. In effect, if this diagnostic has a non-empty main message + /// *and* a non-empty primary annotation message, then the diagnostic is + /// 100% using the new diagnostic data model and we can format things + /// appropriately. + /// + /// The type returned implements the `std::fmt::Display` trait. In most + /// cases, just converting it to a string (or printing it) will do what + /// you want. + pub fn concise_message(&self) -> ConciseMessage { + let main = self.inner.message.as_str(); + let annotation = self + .primary_annotation() + .and_then(|ann| ann.get_message()) + .unwrap_or_default(); + match (main.is_empty(), annotation.is_empty()) { + (false, true) => ConciseMessage::MainDiagnostic(main), + (true, false) => ConciseMessage::PrimaryAnnotation(annotation), + (false, false) => ConciseMessage::Both { main, annotation }, + (true, true) => ConciseMessage::Empty, + } + } + + /// Returns the severity of this diagnostic. + /// + /// Note that this may be different than the severity of sub-diagnostics. + pub fn severity(&self) -> Severity { + self.inner.severity + } + + /// Returns a shared borrow of the "primary" annotation of this diagnostic + /// if one exists. + /// + /// When there are multiple primary annotations, then the first one that + /// was added to this diagnostic is returned. + pub fn primary_annotation(&self) -> Option<&Annotation> { + self.inner.annotations.iter().find(|ann| ann.is_primary) + } + + /// Returns a mutable borrow of the "primary" annotation of this diagnostic + /// if one exists. + /// + /// When there are multiple primary annotations, then the first one that + /// was added to this diagnostic is returned. + pub fn primary_annotation_mut(&mut self) -> Option<&mut Annotation> { + Arc::make_mut(&mut self.inner) + .annotations + .iter_mut() + .find(|ann| ann.is_primary) + } + + /// Returns the "primary" span of this diagnostic if one exists. + /// + /// When there are multiple primary spans, then the first one that was + /// added to this diagnostic is returned. + pub fn primary_span(&self) -> Option<Span> { + self.primary_annotation().map(|ann| ann.span.clone()) + } + + /// Returns the tags from the primary annotation of this diagnostic if it exists. + pub fn primary_tags(&self) -> Option<&[DiagnosticTag]> { + self.primary_annotation().map(|ann| ann.tags.as_slice()) + } + + /// Returns the "primary" span of this diagnostic, panicking if it does not exist. + /// + /// This should typically only be used when working with diagnostics in Ruff, where diagnostics + /// are currently required to have a primary span. + /// + /// See [`Diagnostic::primary_span`] for more details. + pub fn expect_primary_span(&self) -> Span { + self.primary_span().expect("Expected a primary span") + } + + /// Returns a key that can be used to sort two diagnostics into the canonical order + /// in which they should appear when rendered. + pub fn rendering_sort_key<'a>(&'a self, db: &'a dyn Db) -> impl Ord + 'a { + RenderingSortKey { + db, + diagnostic: self, + } + } + + /// Returns all annotations, skipping the first primary annotation. + pub fn secondary_annotations(&self) -> impl Iterator<Item = &Annotation> { + let mut seen_primary = false; + self.inner.annotations.iter().filter(move |ann| { + if seen_primary { + true + } else if ann.is_primary { + seen_primary = true; + false + } else { + true + } + }) + } + + pub fn sub_diagnostics(&self) -> &[SubDiagnostic] { + &self.inner.subs + } +} + +#[derive(Debug, Clone, Eq, PartialEq)] +struct DiagnosticInner { + id: DiagnosticId, + severity: Severity, + message: DiagnosticMessage, + annotations: Vec<Annotation>, + subs: Vec<SubDiagnostic>, +} + +struct RenderingSortKey<'a> { + db: &'a dyn Db, + diagnostic: &'a Diagnostic, +} + +impl Ord for RenderingSortKey<'_> { + // We sort diagnostics in a way that keeps them in source order + // and grouped by file. After that, we fall back to severity + // (with fatal messages sorting before info messages) and then + // finally the diagnostic ID. + fn cmp(&self, other: &Self) -> std::cmp::Ordering { + if let (Some(span1), Some(span2)) = ( + self.diagnostic.primary_span(), + other.diagnostic.primary_span(), + ) { + let order = span1.file().path(&self.db).cmp(span2.file().path(&self.db)); + if order.is_ne() { + return order; + } + + if let (Some(range1), Some(range2)) = (span1.range(), span2.range()) { + let order = range1.start().cmp(&range2.start()); + if order.is_ne() { + return order; + } + } + } + // Reverse so that, e.g., Fatal sorts before Info. + let order = self + .diagnostic + .severity() + .cmp(&other.diagnostic.severity()) + .reverse(); + if order.is_ne() { + return order; + } + self.diagnostic.id().cmp(&other.diagnostic.id()) + } +} + +impl PartialOrd for RenderingSortKey<'_> { + fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> { + Some(self.cmp(other)) + } +} + +impl PartialEq for RenderingSortKey<'_> { + fn eq(&self, other: &Self) -> bool { + self.cmp(other).is_eq() + } +} + +impl Eq for RenderingSortKey<'_> {} + +/// A collection of information subservient to a diagnostic. +/// +/// A sub-diagnostic is always rendered after the parent diagnostic it is +/// attached to. A parent diagnostic may have many sub-diagnostics, and it is +/// guaranteed that they will not interleave with one another in rendering. +/// +/// Currently, the order in which sub-diagnostics are rendered relative to one +/// another (for a single parent diagnostic) is the order in which they were +/// attached to the diagnostic. +#[derive(Debug, Clone, Eq, PartialEq)] +pub struct SubDiagnostic { + /// Like with `Diagnostic`, we box the `SubDiagnostic` to make it + /// pointer-sized. + inner: Box<SubDiagnosticInner>, +} + +impl SubDiagnostic { + /// Create a new sub-diagnostic with the given severity and message. + /// + /// The severity should describe the assumed level of importance to an end + /// user. + /// + /// The message is meant to be read by end users. The primary message + /// is meant to be a single terse description (usually a short phrase) + /// describing the group of related characteristics that the sub-diagnostic + /// describes. Stated differently, if only one thing from a diagnostic can + /// be shown to an end user in a particular context, it is the primary + /// message. + /// + /// # Types implementing `IntoDiagnosticMessage` + /// + /// Callers can pass anything that implements `std::fmt::Display` + /// directly. If callers want or need to avoid cloning the diagnostic + /// message, then they can also pass a `DiagnosticMessage` directly. + pub fn new<'a>(severity: Severity, message: impl IntoDiagnosticMessage + 'a) -> SubDiagnostic { + let inner = Box::new(SubDiagnosticInner { + severity, + message: message.into_diagnostic_message(), + annotations: vec![], + }); + SubDiagnostic { inner } + } + + /// Add an annotation to this sub-diagnostic. + /// + /// Annotations for a sub-diagnostic, like for a diagnostic, are optional. + /// If any are added, callers should strive to make at least one of them + /// primary. That is, it should be constructed via [`Annotation::primary`]. + /// A diagnostic with no primary annotations is allowed, but its rendering + /// may be sub-optimal. + /// + /// Note that it is expected to be somewhat more common for sub-diagnostics + /// to have no annotations (e.g., a simple note) than for a diagnostic to + /// have no annotations. + pub fn annotate(&mut self, ann: Annotation) { + self.inner.annotations.push(ann); + } + + pub fn annotations(&self) -> &[Annotation] { + &self.inner.annotations + } + + /// Returns a shared borrow of the "primary" annotation of this diagnostic + /// if one exists. + /// + /// When there are multiple primary annotations, then the first one that + /// was added to this diagnostic is returned. + pub fn primary_annotation(&self) -> Option<&Annotation> { + self.inner.annotations.iter().find(|ann| ann.is_primary) + } + + /// Introspects this diagnostic and returns what kind of "primary" message + /// it contains for concise formatting. + /// + /// When we concisely format diagnostics, we likely want to not only + /// include the primary diagnostic message but also the message attached + /// to the primary annotation. In particular, the primary annotation often + /// contains *essential* information or context for understanding the + /// diagnostic. + /// + /// The reason why we don't just always return both the main diagnostic + /// message and the primary annotation message is because this was written + /// in the midst of an incremental migration of ty over to the new + /// diagnostic data model. At time of writing, diagnostics were still + /// constructed in the old model where the main diagnostic message and the + /// primary annotation message were not distinguished from each other. So + /// for now, we carefully return what kind of messages this diagnostic + /// contains. In effect, if this diagnostic has a non-empty main message + /// *and* a non-empty primary annotation message, then the diagnostic is + /// 100% using the new diagnostic data model and we can format things + /// appropriately. + /// + /// The type returned implements the `std::fmt::Display` trait. In most + /// cases, just converting it to a string (or printing it) will do what + /// you want. + pub fn concise_message(&self) -> ConciseMessage { + let main = self.inner.message.as_str(); + let annotation = self + .primary_annotation() + .and_then(|ann| ann.get_message()) + .unwrap_or_default(); + match (main.is_empty(), annotation.is_empty()) { + (false, true) => ConciseMessage::MainDiagnostic(main), + (true, false) => ConciseMessage::PrimaryAnnotation(annotation), + (false, false) => ConciseMessage::Both { main, annotation }, + (true, true) => ConciseMessage::Empty, + } + } +} + +#[derive(Debug, Clone, Eq, PartialEq)] +struct SubDiagnosticInner { + severity: Severity, + message: DiagnosticMessage, + annotations: Vec<Annotation>, +} + +/// A pointer to a subsequence in the end user's input. +/// +/// Also known as an annotation, the pointer can optionally contain a short +/// message, typically describing in general terms what is being pointed to. +/// +/// An annotation is either primary or secondary, depending on whether it was +/// constructed via [`Annotation::primary`] or [`Annotation::secondary`]. +/// Semantically, a primary annotation is meant to point to the "locus" of a +/// diagnostic. Visually, the difference between a primary and a secondary +/// annotation is usually just a different form of highlighting on the +/// corresponding span. +/// +/// # Advice +/// +/// The span on an annotation should be as _specific_ as possible. For example, +/// if there is a problem with a function call because one of its arguments has +/// an invalid type, then the span should point to the specific argument and +/// not to the entire function call. +/// +/// Messages attached to annotations should also be as brief and specific as +/// possible. Long messages could negative impact the quality of rendering. +#[derive(Debug, Clone, Eq, PartialEq)] +pub struct Annotation { + /// The span of this annotation, corresponding to some subsequence of the + /// user's input that we want to highlight. + span: Span, + /// An optional message associated with this annotation's span. + /// + /// When present, rendering will include this message in the output and + /// draw a line between the highlighted span and the message. + message: Option<DiagnosticMessage>, + /// Whether this annotation is "primary" or not. When it isn't primary, an + /// annotation is said to be "secondary." + is_primary: bool, + /// The diagnostic tags associated with this annotation. + tags: Vec<DiagnosticTag>, +} + +impl Annotation { + /// Create a "primary" annotation. + /// + /// A primary annotation is meant to highlight the "locus" of a diagnostic. + /// That is, it should point to something in the end user's input that is + /// the subject or "point" of a diagnostic. + /// + /// A diagnostic may have many primary annotations. A diagnostic may not + /// have any annotations, but if it does, at least one _ought_ to be + /// primary. + pub fn primary(span: Span) -> Annotation { + Annotation { + span, + message: None, + is_primary: true, + tags: Vec::new(), + } + } + + /// Create a "secondary" annotation. + /// + /// A secondary annotation is meant to highlight relevant context for a + /// diagnostic, but not to point to the "locus" of the diagnostic. + /// + /// A diagnostic with only secondary annotations is usually not sensible, + /// but it is allowed and will produce a reasonable rendering. + pub fn secondary(span: Span) -> Annotation { + Annotation { + span, + message: None, + is_primary: false, + tags: Vec::new(), + } + } + + /// Attach a message to this annotation. + /// + /// An annotation without a message will still have a presence in + /// rendering. In particular, it will highlight the span association with + /// this annotation in some way. + /// + /// When a message is attached to an annotation, then it will be associated + /// with the highlighted span in some way during rendering. + /// + /// # Types implementing `IntoDiagnosticMessage` + /// + /// Callers can pass anything that implements `std::fmt::Display` + /// directly. If callers want or need to avoid cloning the diagnostic + /// message, then they can also pass a `DiagnosticMessage` directly. + pub fn message<'a>(self, message: impl IntoDiagnosticMessage + 'a) -> Annotation { + let message = Some(message.into_diagnostic_message()); + Annotation { message, ..self } + } + + /// Sets the message on this annotation. + /// + /// If one was already set, then this overwrites it. + /// + /// This is useful if one needs to set the message on an annotation, + /// and all one has is a `&mut Annotation`. For example, via + /// `Diagnostic::primary_annotation_mut`. + pub fn set_message<'a>(&mut self, message: impl IntoDiagnosticMessage + 'a) { + self.message = Some(message.into_diagnostic_message()); + } + + /// Returns the message attached to this annotation, if one exists. + pub fn get_message(&self) -> Option<&str> { + self.message.as_ref().map(|m| m.as_str()) + } + + /// Returns the `Span` associated with this annotation. + pub fn get_span(&self) -> &Span { + &self.span + } + + /// Sets the span on this annotation. + pub fn set_span(&mut self, span: Span) { + self.span = span; + } + + /// Returns the tags associated with this annotation. + pub fn get_tags(&self) -> &[DiagnosticTag] { + &self.tags + } + + /// Attaches this tag to this annotation. + /// + /// It will not replace any existing tags. + pub fn tag(mut self, tag: DiagnosticTag) -> Annotation { + self.tags.push(tag); + self + } + + /// Attaches an additional tag to this annotation. + pub fn push_tag(&mut self, tag: DiagnosticTag) { + self.tags.push(tag); + } +} + +/// Tags that can be associated with an annotation. +/// +/// These tags are used to provide additional information about the annotation. +/// and are passed through to the language server protocol. +#[derive(Debug, Clone, Eq, PartialEq)] +pub enum DiagnosticTag { + /// Unused or unnecessary code. Used for unused parameters, unreachable code, etc. + Unnecessary, + /// Deprecated or obsolete code. + Deprecated, +} + +/// A string identifier for a lint rule. +/// +/// This string is used in command line and configuration interfaces. The name should always +/// be in kebab case, e.g. `no-foo` (all lower case). +/// +/// Rules use kebab case, e.g. `no-foo`. +#[derive(Debug, Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Hash)] +pub struct LintName(&'static str); + +impl LintName { + pub const fn of(name: &'static str) -> Self { + Self(name) + } + + pub const fn as_str(&self) -> &'static str { + self.0 + } +} + +impl std::ops::Deref for LintName { + type Target = str; + + fn deref(&self) -> &Self::Target { + self.0 + } +} + +impl std::fmt::Display for LintName { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_str(self.0) + } +} + +impl PartialEq<str> for LintName { + fn eq(&self, other: &str) -> bool { + self.0 == other + } +} + +impl PartialEq<&str> for LintName { + fn eq(&self, other: &&str) -> bool { + self.0 == *other + } +} + +/// Uniquely identifies the kind of a diagnostic. +#[derive(Debug, Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Hash)] +pub enum DiagnosticId { + Panic, + + /// Some I/O operation failed + Io, + + /// Some code contains a syntax error + InvalidSyntax, + + /// A lint violation. + /// + /// Lints can be suppressed and some lints can be enabled or disabled in the configuration. + Lint(LintName), + + /// A revealed type: Created by `reveal_type(expression)`. + RevealedType, + + /// No rule with the given name exists. + UnknownRule, +} + +impl DiagnosticId { + /// Creates a new `DiagnosticId` for a lint with the given name. + pub const fn lint(name: &'static str) -> Self { + Self::Lint(LintName::of(name)) + } + + /// Returns `true` if this `DiagnosticId` represents a lint. + pub fn is_lint(&self) -> bool { + matches!(self, DiagnosticId::Lint(_)) + } + + /// Returns `true` if this `DiagnosticId` represents a lint with the given name. + pub fn is_lint_named(&self, name: &str) -> bool { + matches!(self, DiagnosticId::Lint(self_name) if self_name == name) + } + + pub fn strip_category(code: &str) -> Option<&str> { + code.split_once(':').map(|(_, rest)| rest) + } + + /// Returns a concise description of this diagnostic ID. + /// + /// Note that this doesn't include the lint's category. It + /// only includes the lint's name. + pub fn as_str(&self) -> &'static str { + match self { + DiagnosticId::Panic => "panic", + DiagnosticId::Io => "io", + DiagnosticId::InvalidSyntax => "invalid-syntax", + DiagnosticId::Lint(name) => name.as_str(), + DiagnosticId::RevealedType => "revealed-type", + DiagnosticId::UnknownRule => "unknown-rule", + } + } + + pub fn is_invalid_syntax(&self) -> bool { + matches!(self, Self::InvalidSyntax) + } +} + +impl std::fmt::Display for DiagnosticId { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} + +/// A unified file representation for both ruff and ty. +/// +/// Such a representation is needed for rendering [`Diagnostic`]s that can optionally contain +/// [`Annotation`]s with [`Span`]s that need to refer to the text of a file. However, ty and ruff +/// use very different file types: a `Copy`-able salsa-interned [`File`], and a heavier-weight +/// [`SourceFile`], respectively. +/// +/// This enum presents a unified interface to these two types for the sake of creating [`Span`]s and +/// emitting diagnostics from both ty and ruff. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum UnifiedFile { + Ty(File), + Ruff(SourceFile), +} + +impl UnifiedFile { + pub fn path<'a>(&'a self, resolver: &'a dyn FileResolver) -> &'a str { + match self { + UnifiedFile::Ty(file) => resolver.path(*file), + UnifiedFile::Ruff(file) => file.name(), + } + } + + fn diagnostic_source(&self, resolver: &dyn FileResolver) -> DiagnosticSource { + match self { + UnifiedFile::Ty(file) => DiagnosticSource::Ty(resolver.input(*file)), + UnifiedFile::Ruff(file) => DiagnosticSource::Ruff(file.clone()), + } + } +} + +/// A unified wrapper for types that can be converted to a [`SourceCode`]. +/// +/// As with [`UnifiedFile`], ruff and ty use slightly different representations for source code. +/// [`DiagnosticSource`] wraps both of these and provides the single +/// [`DiagnosticSource::as_source_code`] method to produce a [`SourceCode`] with the appropriate +/// lifetimes. +/// +/// See [`UnifiedFile::diagnostic_source`] for a way to obtain a [`DiagnosticSource`] from a file +/// and [`FileResolver`]. +#[derive(Clone, Debug)] +enum DiagnosticSource { + Ty(Input), + Ruff(SourceFile), +} + +impl DiagnosticSource { + /// Returns this input as a `SourceCode` for convenient querying. + fn as_source_code(&self) -> SourceCode { + match self { + DiagnosticSource::Ty(input) => SourceCode::new(input.text.as_str(), &input.line_index), + DiagnosticSource::Ruff(source) => SourceCode::new(source.source_text(), source.index()), + } + } +} + +/// A span represents the source of a diagnostic. +/// +/// It consists of a `File` and an optional range into that file. When the +/// range isn't present, it semantically implies that the diagnostic refers to +/// the entire file. For example, when the file should be executable but isn't. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct Span { + file: UnifiedFile, + range: Option<TextRange>, +} + +impl Span { + /// Returns the `UnifiedFile` attached to this `Span`. + pub fn file(&self) -> &UnifiedFile { + &self.file + } + + /// Returns the range, if available, attached to this `Span`. + /// + /// When there is no range, it is convention to assume that this `Span` + /// refers to the corresponding `File` as a whole. In some cases, consumers + /// of this API may use the range `0..0` to represent this case. + pub fn range(&self) -> Option<TextRange> { + self.range + } + + /// Returns a new `Span` with the given `range` attached to it. + pub fn with_range(self, range: TextRange) -> Span { + self.with_optional_range(Some(range)) + } + + /// Returns a new `Span` with the given optional `range` attached to it. + pub fn with_optional_range(self, range: Option<TextRange>) -> Span { + Span { range, ..self } + } + + /// Returns the [`File`] attached to this [`Span`]. + /// + /// Panics if the file is a [`UnifiedFile::Ruff`] instead of a [`UnifiedFile::Ty`]. + pub fn expect_ty_file(&self) -> File { + match self.file { + UnifiedFile::Ty(file) => file, + UnifiedFile::Ruff(_) => panic!("Expected a ty `File`, found a ruff `SourceFile`"), + } + } + + /// Returns the [`SourceFile`] attached to this [`Span`]. + /// + /// Panics if the file is a [`UnifiedFile::Ty`] instead of a [`UnifiedFile::Ruff`]. + pub fn expect_ruff_file(&self) -> &SourceFile { + match &self.file { + UnifiedFile::Ty(_) => panic!("Expected a ruff `SourceFile`, found a ty `File`"), + UnifiedFile::Ruff(file) => file, + } + } +} + +impl From<File> for Span { + fn from(file: File) -> Span { + let file = UnifiedFile::Ty(file); + Span { file, range: None } + } +} + +impl From<SourceFile> for Span { + fn from(file: SourceFile) -> Self { + let file = UnifiedFile::Ruff(file); + Span { file, range: None } + } +} + +impl From<crate::files::FileRange> for Span { + fn from(file_range: crate::files::FileRange) -> Span { + Span::from(file_range.file()).with_range(file_range.range()) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd)] +pub enum Severity { + Info, + Warning, + Error, + Fatal, +} + +impl Severity { + fn to_annotate(self) -> AnnotateLevel { + match self { + Severity::Info => AnnotateLevel::Info, + Severity::Warning => AnnotateLevel::Warning, + Severity::Error => AnnotateLevel::Error, + // NOTE: Should we really collapse this to "error"? + // + // After collapsing this, the snapshot tests seem to reveal that we + // don't currently have any *tests* with a `fatal` severity level. + // And maybe *rendering* this as just an `error` is fine. If we + // really do need different rendering, then I think we can add a + // `Level::Fatal`. ---AG + Severity::Fatal => AnnotateLevel::Error, + } + } + + pub const fn is_fatal(self) -> bool { + matches!(self, Severity::Fatal) + } +} + +/// Configuration for rendering diagnostics. +#[derive(Clone, Debug)] +pub struct DisplayDiagnosticConfig { + /// The format to use for diagnostic rendering. + /// + /// This uses the "full" format by default. + format: DiagnosticFormat, + /// Whether to enable colors or not. + /// + /// Disabled by default. + color: bool, + /// The number of non-empty lines to show around each snippet. + /// + /// NOTE: It seems like making this a property of rendering *could* + /// be wrong. In particular, I have a suspicion that we may want + /// more granular control over this, perhaps based on the kind of + /// diagnostic or even the snippet itself. But I chose to put this + /// here for now as the most "sensible" place for it to live until + /// we had more concrete use cases. ---AG + context: usize, +} + +impl DisplayDiagnosticConfig { + /// Whether to enable concise diagnostic output or not. + pub fn format(self, format: DiagnosticFormat) -> DisplayDiagnosticConfig { + DisplayDiagnosticConfig { format, ..self } + } + + /// Whether to enable colors or not. + pub fn color(self, yes: bool) -> DisplayDiagnosticConfig { + DisplayDiagnosticConfig { color: yes, ..self } + } + + /// Set the number of contextual lines to show around each snippet. + pub fn context(self, lines: usize) -> DisplayDiagnosticConfig { + DisplayDiagnosticConfig { + context: lines, + ..self + } + } +} + +impl Default for DisplayDiagnosticConfig { + fn default() -> DisplayDiagnosticConfig { + DisplayDiagnosticConfig { + format: DiagnosticFormat::default(), + color: false, + context: 2, + } + } +} + +/// The diagnostic output format. +#[derive(Copy, Clone, Debug, Default, Eq, Hash, PartialEq, PartialOrd, Ord)] +#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))] +#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub enum DiagnosticFormat { + /// The default full mode will print "pretty" diagnostics. + /// + /// That is, color will be used when printing to a `tty`. + /// Moreover, diagnostic messages may include additional + /// context and annotations on the input to help understand + /// the message. + #[default] + Full, + /// Print diagnostics in a concise mode. + /// + /// This will guarantee that each diagnostic is printed on + /// a single line. Only the most important or primary aspects + /// of the diagnostic are included. Contextual information is + /// dropped. + /// + /// This may use color when printing to a `tty`. + Concise, +} + +/// A representation of the kinds of messages inside a diagnostic. +pub enum ConciseMessage<'a> { + /// A diagnostic contains a non-empty main message and an empty + /// primary annotation message. + /// + /// This strongly suggests that the diagnostic is using the + /// "new" data model. + MainDiagnostic(&'a str), + /// A diagnostic contains an empty main message and a non-empty + /// primary annotation message. + /// + /// This strongly suggests that the diagnostic is using the + /// "old" data model. + PrimaryAnnotation(&'a str), + /// A diagnostic contains a non-empty main message and a non-empty + /// primary annotation message. + /// + /// This strongly suggests that the diagnostic is using the + /// "new" data model. + Both { main: &'a str, annotation: &'a str }, + /// A diagnostic contains an empty main message and an empty + /// primary annotation message. + /// + /// This indicates that the diagnostic is probably using the old + /// model. + Empty, +} + +impl std::fmt::Display for ConciseMessage<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match *self { + ConciseMessage::MainDiagnostic(main) => { + write!(f, "{main}") + } + ConciseMessage::PrimaryAnnotation(annotation) => { + write!(f, "{annotation}") + } + ConciseMessage::Both { main, annotation } => { + write!(f, "{main}: {annotation}") + } + ConciseMessage::Empty => Ok(()), + } + } +} + +/// A diagnostic message string. +/// +/// This is, for all intents and purposes, equivalent to a `Box<str>`. +/// But it does not implement `std::fmt::Display`. Indeed, that it its +/// entire reason for existence. It provides a way to pass a string +/// directly into diagnostic methods that accept messages without copying +/// that string. This works via the `IntoDiagnosticMessage` trait. +/// +/// In most cases, callers shouldn't need to use this. Instead, there is +/// a blanket trait implementation for `IntoDiagnosticMessage` for +/// anything that implements `std::fmt::Display`. +#[derive(Clone, Debug, Eq, PartialEq)] +pub struct DiagnosticMessage(Box<str>); + +impl DiagnosticMessage { + /// Returns this message as a borrowed string. + pub fn as_str(&self) -> &str { + &self.0 + } +} + +impl From<&str> for DiagnosticMessage { + fn from(s: &str) -> DiagnosticMessage { + DiagnosticMessage(s.into()) + } +} + +impl From<String> for DiagnosticMessage { + fn from(s: String) -> DiagnosticMessage { + DiagnosticMessage(s.into()) + } +} + +impl From<Box<str>> for DiagnosticMessage { + fn from(s: Box<str>) -> DiagnosticMessage { + DiagnosticMessage(s) + } +} + +impl IntoDiagnosticMessage for DiagnosticMessage { + fn into_diagnostic_message(self) -> DiagnosticMessage { + self + } +} + +/// A trait for values that can be converted into a diagnostic message. +/// +/// Users of the diagnostic API can largely think of this trait as effectively +/// equivalent to `std::fmt::Display`. Indeed, everything that implements +/// `Display` also implements this trait. That means wherever this trait is +/// accepted, you can use things like `format_args!`. +/// +/// The purpose of this trait is to provide a means to give arguments _other_ +/// than `std::fmt::Display` trait implementations. Or rather, to permit +/// the diagnostic API to treat them differently. For example, this lets +/// callers wrap a string in a `DiagnosticMessage` and provide it directly +/// to any of the diagnostic APIs that accept a message. This will move the +/// string and avoid any unnecessary copies. (If we instead required only +/// `std::fmt::Display`, then this would potentially result in a copy via the +/// `ToString` trait implementation.) +pub trait IntoDiagnosticMessage { + fn into_diagnostic_message(self) -> DiagnosticMessage; +} + +/// Every `IntoDiagnosticMessage` is accepted, so to is `std::fmt::Display`. +impl<T: std::fmt::Display> IntoDiagnosticMessage for T { + fn into_diagnostic_message(self) -> DiagnosticMessage { + DiagnosticMessage::from(self.to_string()) + } +} + +/// Creates a `Diagnostic` from a parse error. +/// +/// This should _probably_ be a method on `ruff_python_parser::ParseError`, but +/// at time of writing, `ruff_db` depends on `ruff_python_parser` instead of +/// the other way around. And since we want to do this conversion in a couple +/// places, it makes sense to centralize it _somewhere_. So it's here for now. +pub fn create_parse_diagnostic(file: File, err: &ruff_python_parser::ParseError) -> Diagnostic { + let mut diag = Diagnostic::new(DiagnosticId::InvalidSyntax, Severity::Error, ""); + let span = Span::from(file).with_range(err.location); + diag.annotate(Annotation::primary(span).message(&err.error)); + diag +} + +/// Creates a `Diagnostic` from an unsupported syntax error. +/// +/// See [`create_parse_diagnostic`] for more details. +pub fn create_unsupported_syntax_diagnostic( + file: File, + err: &ruff_python_parser::UnsupportedSyntaxError, +) -> Diagnostic { + let mut diag = Diagnostic::new(DiagnosticId::InvalidSyntax, Severity::Error, ""); + let span = Span::from(file).with_range(err.range); + diag.annotate(Annotation::primary(span).message(err.to_string())); + diag +} + +/// Creates a `Diagnostic` from a semantic syntax error. +/// +/// See [`create_parse_diagnostic`] for more details. +pub fn create_semantic_syntax_diagnostic( + file: File, + err: &ruff_python_parser::semantic_errors::SemanticSyntaxError, +) -> Diagnostic { + let mut diag = Diagnostic::new(DiagnosticId::InvalidSyntax, Severity::Error, ""); + let span = Span::from(file).with_range(err.range); + diag.annotate(Annotation::primary(span).message(err.to_string())); + diag +} diff --git a/crates/ruff_db/src/diagnostic/render.rs b/crates/ruff_db/src/diagnostic/render.rs new file mode 100644 index 0000000000000..af720e45d9454 --- /dev/null +++ b/crates/ruff_db/src/diagnostic/render.rs @@ -0,0 +1,2369 @@ +use std::collections::BTreeMap; + +use ruff_annotate_snippets::{ + Annotation as AnnotateAnnotation, Level as AnnotateLevel, Message as AnnotateMessage, + Renderer as AnnotateRenderer, Snippet as AnnotateSnippet, +}; +use ruff_source_file::{LineIndex, OneIndexed, SourceCode}; +use ruff_text_size::{TextRange, TextSize}; + +use crate::diagnostic::stylesheet::{DiagnosticStylesheet, fmt_styled}; +use crate::{ + Db, + files::File, + source::{SourceText, line_index, source_text}, + system::SystemPath, +}; + +use super::{ + Annotation, Diagnostic, DiagnosticFormat, DiagnosticSource, DisplayDiagnosticConfig, Severity, + SubDiagnostic, +}; + +/// A type that implements `std::fmt::Display` for diagnostic rendering. +/// +/// It is created via [`Diagnostic::display`]. +/// +/// The lifetime parameter, `'a`, refers to the shorter of: +/// +/// * The lifetime of the rendering configuration. +/// * The lifetime of the resolver used to load the contents of `Span` +/// values. When using Salsa, this most commonly corresponds to the lifetime +/// of a Salsa `Db`. +/// * The lifetime of the diagnostic being rendered. +pub struct DisplayDiagnostic<'a> { + config: &'a DisplayDiagnosticConfig, + resolver: &'a dyn FileResolver, + annotate_renderer: AnnotateRenderer, + diag: &'a Diagnostic, +} + +impl<'a> DisplayDiagnostic<'a> { + pub(crate) fn new( + resolver: &'a dyn FileResolver, + config: &'a DisplayDiagnosticConfig, + diag: &'a Diagnostic, + ) -> DisplayDiagnostic<'a> { + let annotate_renderer = if config.color { + AnnotateRenderer::styled() + } else { + AnnotateRenderer::plain() + }; + + DisplayDiagnostic { + config, + resolver, + annotate_renderer, + diag, + } + } +} + +impl std::fmt::Display for DisplayDiagnostic<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + let stylesheet = if self.config.color { + DiagnosticStylesheet::styled() + } else { + DiagnosticStylesheet::plain() + }; + + if matches!(self.config.format, DiagnosticFormat::Concise) { + let (severity, severity_style) = match self.diag.severity() { + Severity::Info => ("info", stylesheet.info), + Severity::Warning => ("warning", stylesheet.warning), + Severity::Error => ("error", stylesheet.error), + Severity::Fatal => ("fatal", stylesheet.error), + }; + + write!( + f, + "{severity}[{id}]", + severity = fmt_styled(severity, severity_style), + id = fmt_styled(self.diag.id(), stylesheet.emphasis) + )?; + + if let Some(span) = self.diag.primary_span() { + write!( + f, + " {path}", + path = fmt_styled(span.file().path(self.resolver), stylesheet.emphasis) + )?; + if let Some(range) = span.range() { + let diagnostic_source = span.file().diagnostic_source(self.resolver); + let start = diagnostic_source + .as_source_code() + .line_column(range.start()); + + write!( + f, + ":{line}:{col}", + line = fmt_styled(start.line, stylesheet.emphasis), + col = fmt_styled(start.column, stylesheet.emphasis), + )?; + } + write!(f, ":")?; + } + return writeln!(f, " {message}", message = self.diag.concise_message()); + } + + let mut renderer = self.annotate_renderer.clone(); + renderer = renderer + .error(stylesheet.error) + .warning(stylesheet.warning) + .info(stylesheet.info) + .note(stylesheet.note) + .help(stylesheet.help) + .line_no(stylesheet.line_no) + .emphasis(stylesheet.emphasis) + .none(stylesheet.none); + + let resolved = Resolved::new(self.resolver, self.diag); + let renderable = resolved.to_renderable(self.config.context); + for diag in renderable.diagnostics.iter() { + writeln!(f, "{}", renderer.render(diag.to_annotate()))?; + } + writeln!(f) + } +} + +/// A sequence of resolved diagnostics. +/// +/// Resolving a diagnostic refers to the process of restructuring its internal +/// data in a way that enables rendering decisions. For example, a `Span` +/// on an `Annotation` in a `Diagnostic` is intentionally very minimal, and +/// thus doesn't have information like line numbers or even the actual file +/// path. Resolution retrieves this information and puts it into a structured +/// representation specifically intended for diagnostic rendering. +/// +/// The lifetime `'a` refers to the shorter of the lifetimes between the file +/// resolver and the diagnostic itself. (The resolved types borrow data from +/// both.) +#[derive(Debug)] +struct Resolved<'a> { + diagnostics: Vec<ResolvedDiagnostic<'a>>, +} + +impl<'a> Resolved<'a> { + /// Creates a new resolved set of diagnostics. + fn new(resolver: &'a dyn FileResolver, diag: &'a Diagnostic) -> Resolved<'a> { + let mut diagnostics = vec![]; + diagnostics.push(ResolvedDiagnostic::from_diagnostic(resolver, diag)); + for sub in &diag.inner.subs { + diagnostics.push(ResolvedDiagnostic::from_sub_diagnostic(resolver, sub)); + } + Resolved { diagnostics } + } + + /// Creates a value that is amenable to rendering directly. + fn to_renderable(&self, context: usize) -> Renderable<'_> { + Renderable { + diagnostics: self + .diagnostics + .iter() + .map(|diag| diag.to_renderable(context)) + .collect(), + } + } +} + +/// A single resolved diagnostic. +/// +/// The lifetime `'a` refers to the shorter of the lifetimes between the file +/// resolver and the diagnostic itself. (The resolved types borrow data from +/// both.) +#[derive(Debug)] +struct ResolvedDiagnostic<'a> { + severity: Severity, + id: Option<String>, + message: String, + annotations: Vec<ResolvedAnnotation<'a>>, +} + +impl<'a> ResolvedDiagnostic<'a> { + /// Resolve a single diagnostic. + fn from_diagnostic( + resolver: &'a dyn FileResolver, + diag: &'a Diagnostic, + ) -> ResolvedDiagnostic<'a> { + let annotations: Vec<_> = diag + .inner + .annotations + .iter() + .filter_map(|ann| { + let path = ann.span.file.path(resolver); + let diagnostic_source = ann.span.file.diagnostic_source(resolver); + ResolvedAnnotation::new(path, &diagnostic_source, ann) + }) + .collect(); + let id = Some(diag.inner.id.to_string()); + let message = diag.inner.message.as_str().to_string(); + ResolvedDiagnostic { + severity: diag.inner.severity, + id, + message, + annotations, + } + } + + /// Resolve a single sub-diagnostic. + fn from_sub_diagnostic( + resolver: &'a dyn FileResolver, + diag: &'a SubDiagnostic, + ) -> ResolvedDiagnostic<'a> { + let annotations: Vec<_> = diag + .inner + .annotations + .iter() + .filter_map(|ann| { + let path = ann.span.file.path(resolver); + let diagnostic_source = ann.span.file.diagnostic_source(resolver); + ResolvedAnnotation::new(path, &diagnostic_source, ann) + }) + .collect(); + ResolvedDiagnostic { + severity: diag.inner.severity, + id: None, + message: diag.inner.message.as_str().to_string(), + annotations, + } + } + + /// Create a diagnostic amenable for rendering. + /// + /// `context` refers to the number of lines both before and after to show + /// for each snippet. + fn to_renderable<'r>(&'r self, context: usize) -> RenderableDiagnostic<'r> { + let mut ann_by_path: BTreeMap<&'a str, Vec<&ResolvedAnnotation<'a>>> = BTreeMap::new(); + for ann in &self.annotations { + ann_by_path.entry(ann.path).or_default().push(ann); + } + for anns in ann_by_path.values_mut() { + anns.sort_by_key(|ann1| ann1.range.start()); + } + + let mut snippet_by_path: BTreeMap<&'a str, Vec<Vec<&ResolvedAnnotation<'a>>>> = + BTreeMap::new(); + for (path, anns) in ann_by_path { + let mut snippet = vec![]; + for ann in anns { + let Some(prev) = snippet.last() else { + snippet.push(ann); + continue; + }; + + let prev_context_ends = context_after( + &prev.diagnostic_source.as_source_code(), + context, + prev.line_end, + ) + .get(); + let this_context_begins = context_before( + &ann.diagnostic_source.as_source_code(), + context, + ann.line_start, + ) + .get(); + // The boundary case here is when `prev_context_ends` + // is exactly one less than `this_context_begins`. In + // that case, the context windows are adajcent and we + // should fall through below to add this annotation to + // the existing snippet. + if this_context_begins.saturating_sub(prev_context_ends) > 1 { + snippet_by_path + .entry(path) + .or_default() + .push(std::mem::take(&mut snippet)); + } + snippet.push(ann); + } + if !snippet.is_empty() { + snippet_by_path.entry(path).or_default().push(snippet); + } + } + + let mut snippets_by_input = vec![]; + for (path, snippets) in snippet_by_path { + snippets_by_input.push(RenderableSnippets::new(context, path, &snippets)); + } + snippets_by_input + .sort_by(|snips1, snips2| snips1.has_primary.cmp(&snips2.has_primary).reverse()); + RenderableDiagnostic { + severity: self.severity, + id: self.id.as_deref(), + message: &self.message, + snippets_by_input, + } + } +} + +/// A resolved annotation with information needed for rendering. +/// +/// For example, this annotation has the corresponding file path, entire +/// source code and the line numbers corresponding to its range in the source +/// code. This information can be used to create renderable data and also +/// sort/organize the annotations into snippets. +#[derive(Debug)] +struct ResolvedAnnotation<'a> { + path: &'a str, + diagnostic_source: DiagnosticSource, + range: TextRange, + line_start: OneIndexed, + line_end: OneIndexed, + message: Option<&'a str>, + is_primary: bool, +} + +impl<'a> ResolvedAnnotation<'a> { + /// Resolve an annotation. + /// + /// `path` is the path of the file that this annotation points to. + /// + /// `input` is the contents of the file that this annotation points to. + fn new( + path: &'a str, + diagnostic_source: &DiagnosticSource, + ann: &'a Annotation, + ) -> Option<ResolvedAnnotation<'a>> { + let source = diagnostic_source.as_source_code(); + let (range, line_start, line_end) = match (ann.span.range(), ann.message.is_some()) { + // An annotation with no range AND no message is probably(?) + // meaningless, but we should try to render it anyway. + (None, _) => ( + TextRange::empty(TextSize::new(0)), + OneIndexed::MIN, + OneIndexed::MIN, + ), + (Some(range), _) => { + let line_start = source.line_index(range.start()); + let mut line_end = source.line_index(range.end()); + // As a special case, if the *end* of our range comes + // right after a line terminator, we say that the last + // line number for this annotation is the previous + // line and not the next line. In other words, in this + // case, we treat our line number as an inclusive + // upper bound. + if source.slice(range).ends_with(['\r', '\n']) { + line_end = line_end.saturating_sub(1).max(line_start); + } + (range, line_start, line_end) + } + }; + Some(ResolvedAnnotation { + path, + diagnostic_source: diagnostic_source.clone(), + range, + line_start, + line_end, + message: ann.get_message(), + is_primary: ann.is_primary, + }) + } +} + +/// A single unit of rendering consisting of one or more diagnostics. +/// +/// There is always exactly one "main" diagnostic that comes first, followed by +/// zero or more sub-diagnostics. +/// +/// The lifetime parameter `'r` refers to the lifetime of whatever created this +/// renderable value. This is usually the lifetime of `Resolved`. +#[derive(Debug)] +struct Renderable<'r> { + diagnostics: Vec<RenderableDiagnostic<'r>>, +} + +/// A single diagnostic amenable to rendering. +#[derive(Debug)] +struct RenderableDiagnostic<'r> { + /// The severity of the diagnostic. + severity: Severity, + /// The ID of the diagnostic. The ID can usually be used on the CLI or in a + /// config file to change the severity of a lint. + /// + /// An ID is always present for top-level diagnostics and always absent for + /// sub-diagnostics. + id: Option<&'r str>, + /// The message emitted with the diagnostic, before any snippets are + /// rendered. + message: &'r str, + /// A collection of collections of snippets. Each collection of snippets + /// should be from the same file, and none of the snippets inside of a + /// collection should overlap with one another or be directly adjacent. + snippets_by_input: Vec<RenderableSnippets<'r>>, +} + +impl RenderableDiagnostic<'_> { + /// Convert this to an "annotate" snippet. + fn to_annotate(&self) -> AnnotateMessage<'_> { + let level = self.severity.to_annotate(); + let snippets = self.snippets_by_input.iter().flat_map(|snippets| { + let path = snippets.path; + snippets + .snippets + .iter() + .map(|snippet| snippet.to_annotate(path)) + }); + let mut message = level.title(self.message); + if let Some(id) = self.id { + message = message.id(id); + } + message.snippets(snippets) + } +} + +/// A collection of renderable snippets for a single file. +#[derive(Debug)] +struct RenderableSnippets<'r> { + /// The path to the file from which all snippets originate from. + path: &'r str, + /// The snippets, the in order of desired rendering. + snippets: Vec<RenderableSnippet<'r>>, + /// Whether this contains any snippets with any annotations marked + /// as primary. This is useful for re-sorting snippets such that + /// the ones with primary annotations are rendered first. + has_primary: bool, +} + +impl<'r> RenderableSnippets<'r> { + /// Creates a new collection of renderable snippets. + /// + /// `context` is the number of lines to include before and after each + /// snippet. + /// + /// `path` is the file path containing the given snippets. (They should all + /// come from the same file path.) + /// + /// The lifetime parameter `'r` refers to the lifetime of the resolved + /// annotation given (since the renderable snippet returned borrows from + /// the resolved annotation's `Input`). This is no longer than the lifetime + /// of the resolver that produced the resolved annotation. + /// + /// # Panics + /// + /// When `resolved_snippets.is_empty()`. + fn new<'a>( + context: usize, + path: &'r str, + resolved_snippets: &'a [Vec<&'r ResolvedAnnotation<'r>>], + ) -> RenderableSnippets<'r> { + assert!(!resolved_snippets.is_empty()); + + let mut has_primary = false; + let mut snippets = vec![]; + for anns in resolved_snippets { + let snippet = RenderableSnippet::new(context, anns); + has_primary = has_primary || snippet.has_primary; + snippets.push(snippet); + } + snippets.sort_by(|s1, s2| s1.has_primary.cmp(&s2.has_primary).reverse()); + RenderableSnippets { + path, + snippets, + has_primary, + } + } +} + +/// A single snippet of code that is rendered as part of a diagnostic message. +/// +/// The intent is that a snippet for one diagnostic does not overlap (or is +/// even directly adjacent to) any other snippets for that same diagnostic. +/// Callers creating a `RenderableSnippet` should enforce this guarantee by +/// grouping annotations according to the lines on which they start and stop. +/// +/// Snippets from different diagnostics (including sub-diagnostics) may +/// overlap. +#[derive(Debug)] +struct RenderableSnippet<'r> { + /// The actual snippet text. + snippet: &'r str, + /// The absolute line number corresponding to where this + /// snippet begins. + line_start: OneIndexed, + /// A non-zero number of annotations on this snippet. + annotations: Vec<RenderableAnnotation<'r>>, + /// Whether this snippet contains at least one primary + /// annotation. + has_primary: bool, +} + +impl<'r> RenderableSnippet<'r> { + /// Creates a new snippet with one or more annotations that is ready to be + /// renderer. + /// + /// The first line of the snippet is the smallest line number on which one + /// of the annotations begins, minus the context window size. The last line + /// is the largest line number on which one of the annotations ends, plus + /// the context window size. + /// + /// Callers should guarantee that the `input` on every `ResolvedAnnotation` + /// given is identical. + /// + /// The lifetime of the snippet returned is only tied to the lifetime of + /// the borrowed resolved annotation given (which is no longer than the + /// lifetime of the resolver that produced the resolved annotation). + /// + /// # Panics + /// + /// When `anns.is_empty()`. + fn new<'a>(context: usize, anns: &'a [&'r ResolvedAnnotation<'r>]) -> RenderableSnippet<'r> { + assert!( + !anns.is_empty(), + "creating a renderable snippet requires a non-zero number of annotations", + ); + let diagnostic_source = &anns[0].diagnostic_source; + let source = diagnostic_source.as_source_code(); + let has_primary = anns.iter().any(|ann| ann.is_primary); + + let line_start = context_before( + &source, + context, + anns.iter().map(|ann| ann.line_start).min().unwrap(), + ); + let line_end = context_after( + &source, + context, + anns.iter().map(|ann| ann.line_end).max().unwrap(), + ); + + let snippet_start = source.line_start(line_start); + let snippet_end = source.line_end(line_end); + let snippet = diagnostic_source + .as_source_code() + .slice(TextRange::new(snippet_start, snippet_end)); + + let annotations = anns + .iter() + .map(|ann| RenderableAnnotation::new(snippet_start, ann)) + .collect(); + RenderableSnippet { + snippet, + line_start, + annotations, + has_primary, + } + } + + /// Convert this to an "annotate" snippet. + fn to_annotate<'a>(&'a self, path: &'a str) -> AnnotateSnippet<'a> { + AnnotateSnippet::source(self.snippet) + .origin(path) + .line_start(self.line_start.get()) + .annotations( + self.annotations + .iter() + .map(RenderableAnnotation::to_annotate), + ) + } +} + +/// A single annotation represented in a way that is amenable to rendering. +#[derive(Debug)] +struct RenderableAnnotation<'r> { + /// The range of the annotation relative to the snippet + /// it points to. This is *not* the absolute range in the + /// corresponding file. + range: TextRange, + /// An optional message or label associated with this annotation. + message: Option<&'r str>, + /// Whether this annotation is considered "primary" or not. + is_primary: bool, +} + +impl<'r> RenderableAnnotation<'r> { + /// Create a new renderable annotation. + /// + /// `snippet_start` should be the absolute offset at which the snippet + /// pointing to by the given annotation begins. + /// + /// The lifetime of the resolved annotation does not matter. The `'r` + /// lifetime parameter here refers to the lifetime of the resolver that + /// created the given `ResolvedAnnotation`. + fn new(snippet_start: TextSize, ann: &'_ ResolvedAnnotation<'r>) -> RenderableAnnotation<'r> { + let range = ann.range - snippet_start; + RenderableAnnotation { + range, + message: ann.message, + is_primary: ann.is_primary, + } + } + + /// Convert this to an "annotate" annotation. + fn to_annotate(&self) -> AnnotateAnnotation<'_> { + // This is not really semantically meaningful, but + // it does currently result in roughly the message + // we want to convey. + // + // TODO: While this means primary annotations use `^` and + // secondary annotations use `-` (which is fine), this does + // result in coloring for primary annotations that looks like + // an error (red) and coloring for secondary annotations that + // looks like a warning (yellow). This is perhaps not quite in + // line with what we want, but fixing this probably requires + // changes to `ruff_annotate_snippets`, so we punt for now. + let level = if self.is_primary { + AnnotateLevel::Error + } else { + AnnotateLevel::Warning + }; + let mut ann = level.span(self.range.into()); + if let Some(message) = self.message { + ann = ann.label(message); + } + ann + } +} + +/// A trait that facilitates the retrieval of source code from a `Span`. +/// +/// At present, this is tightly coupled with a Salsa database. In the future, +/// it is intended for this resolver to become an abstraction providing a +/// similar API. We define things this way for now to keep the Salsa coupling +/// at "arm's" length, and to make it easier to do the actual de-coupling in +/// the future. +/// +/// For example, at time of writing (2025-03-07), the plan is (roughly) for +/// Ruff to grow its own interner of file paths so that a `Span` can store an +/// interned ID instead of a (roughly) `Arc<Path>`. This interner is planned +/// to be entirely separate from the Salsa interner used by ty, and so, +/// callers will need to pass in a different "resolver" for turning `Span`s +/// into actual file paths/contents. The infrastructure for this isn't fully in +/// place, but this type serves to demarcate the intended abstraction boundary. +pub trait FileResolver { + /// Returns the path associated with the file given. + fn path(&self, file: File) -> &str; + + /// Returns the input contents associated with the file given. + fn input(&self, file: File) -> Input; +} + +impl FileResolver for &dyn Db { + fn path(&self, file: File) -> &str { + relativize_path(self.system().current_directory(), file.path(*self).as_str()) + } + + fn input(&self, file: File) -> Input { + Input { + text: source_text(*self, file), + line_index: line_index(*self, file), + } + } +} + +/// An abstraction over a unit of user input. +/// +/// A single unit of user input usually corresponds to a `File`. +/// This contains the actual content of that input as well as a +/// line index for efficiently querying its contents. +#[derive(Clone, Debug)] +pub struct Input { + pub(crate) text: SourceText, + pub(crate) line_index: LineIndex, +} + +/// Returns the line number accounting for the given `len` +/// number of preceding context lines. +/// +/// The line number returned is guaranteed to be less than +/// or equal to `start`. +fn context_before(source: &SourceCode<'_, '_>, len: usize, start: OneIndexed) -> OneIndexed { + let mut line = start.saturating_sub(len); + // Trim leading empty lines. + while line < start { + if !source.line_text(line).trim().is_empty() { + break; + } + line = line.saturating_add(1); + } + line +} + +/// Returns the line number accounting for the given `len` +/// number of following context lines. +/// +/// The line number returned is guaranteed to be greater +/// than or equal to `start` and no greater than the +/// number of lines in `source`. +fn context_after(source: &SourceCode<'_, '_>, len: usize, start: OneIndexed) -> OneIndexed { + let max_lines = OneIndexed::from_zero_indexed(source.line_count()); + let mut line = start.saturating_add(len).min(max_lines); + // Trim trailing empty lines. + while line > start { + if !source.line_text(line).trim().is_empty() { + break; + } + line = line.saturating_sub(1); + } + line +} + +/// Convert an absolute path to be relative to the current working directory. +fn relativize_path<'p>(cwd: &SystemPath, path: &'p str) -> &'p str { + if let Ok(path) = SystemPath::new(path).strip_prefix(cwd) { + return path.as_str(); + } + path +} + +#[cfg(test)] +mod tests { + + use crate::Upcast; + use crate::diagnostic::{Annotation, DiagnosticId, Severity, Span}; + use crate::files::system_path_to_file; + use crate::system::{DbWithWritableSystem, SystemPath}; + use crate::tests::TestDb; + + use super::*; + + static ANIMALS: &str = "\ +aardvark +beetle +canary +dog +elephant +finch +gorilla +hippopotamus +inchworm +jackrabbit +kangaroo +"; + + // Useful for testing context windows that trim leading/trailing + // lines that are pure whitespace or empty. + static SPACEY_ANIMALS: &str = "\ +aardvark + +beetle + +canary + +dog +elephant +finch + +gorilla +hippopotamus +inchworm +jackrabbit + +kangaroo +"; + + static FRUITS: &str = "\ +apple +banana +cantelope +lime +orange +pear +raspberry +strawberry +tomato +watermelon +"; + + static NON_ASCII: &str = "\ +☃☃☃☃☃☃☃☃☃☃☃☃ +💩💩💩💩💩💩💩💩💩💩💩💩 +ΔΔΔΔΔΔΔΔΔΔΔΔ +ββββββββββββ +ΣΣΣΣΣΣΣΣΣΣΣΣ +ξξξξξξξξξξξξ +ππππππππππππ +θθθθθθθθθθθθ +ΦΦΦΦΦΦΦΦΦΦΦΦ +λλλλλλλλλλλλ +"; + + #[test] + fn basic() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + let diag = env.err().primary("animals", "5", "5", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + 7 | gorilla + | + ", + ); + + let diag = env + .builder( + "test-diagnostic", + Severity::Warning, + "main diagnostic message", + ) + .primary("animals", "5", "5", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + warning[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + 7 | gorilla + | + ", + ); + + let diag = env + .builder("test-diagnostic", Severity::Info, "main diagnostic message") + .primary("animals", "5", "5", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + info[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + 7 | gorilla + | + ", + ); + } + + #[test] + fn no_range() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + let mut builder = env.err(); + builder + .diag + .annotate(Annotation::primary(builder.env.path("animals"))); + let diag = builder.build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^ + 2 | beetle + 3 | canary + | + ", + ); + + let mut builder = env.err(); + builder.diag.annotate( + Annotation::primary(builder.env.path("animals")).message("primary annotation message"), + ); + let diag = builder.build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^ primary annotation message + 2 | beetle + 3 | canary + | + ", + ); + } + + #[test] + fn non_ascii() { + let mut env = TestEnvironment::new(); + env.add("non-ascii", NON_ASCII); + + let diag = env.err().primary("non-ascii", "5", "5", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> non-ascii:5:1 + | + 3 | ΔΔΔΔΔΔΔΔΔΔΔΔ + 4 | ββββββββββββ + 5 | ΣΣΣΣΣΣΣΣΣΣΣΣ + | ^^^^^^^^^^^^ + 6 | ξξξξξξξξξξξξ + 7 | ππππππππππππ + | + ", + ); + + // Just highlight one multi-byte codepoint + // that has a >1 Unicode width. + let diag = env.err().primary("non-ascii", "2:4", "2:8", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> non-ascii:2:2 + | + 1 | ☃☃☃☃☃☃☃☃☃☃☃☃ + 2 | 💩💩💩💩💩💩💩💩💩💩💩💩 + | ^^ + 3 | ΔΔΔΔΔΔΔΔΔΔΔΔ + 4 | ββββββββββββ + | + ", + ); + } + + #[test] + fn config_context() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + // Smaller context + let diag = env.err().primary("animals", "5", "5", "").build(); + env.context(1); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + | + ", + ); + + // No context + let diag = env.err().primary("animals", "5", "5", "").build(); + env.context(0); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 5 | elephant + | ^^^^^^^^ + | + ", + ); + + // No context before snippet + let diag = env.err().primary("animals", "1", "1", "").build(); + env.context(2); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + | + ", + ); + + // No context after snippet + let diag = env.err().primary("animals", "11", "11", "").build(); + env.context(2); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:11:1 + | + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | ^^^^^^^^ + | + ", + ); + + // Context that exceeds source + let diag = env.err().primary("animals", "5", "5", "").build(); + env.context(200); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + 7 | gorilla + 8 | hippopotamus + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | + ", + ); + } + + #[test] + fn multiple_annotations_non_overlapping() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "11", "11", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + | + ::: animals:11:1 + | + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | ^^^^^^^^ + | + ", + ); + } + + #[test] + fn multiple_annotations_adjacent_context() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + // Set the context explicitly to 1 to make + // it easier to reason about, and to avoid + // making this test tricky to update if the + // default context changes. + env.context(1); + + let diag = env + .err() + .primary("animals", "1", "1", "") + // This is the line that immediately follows + // the context from the first annotation, + // so there is no overlap. But since it's + // adjacent, the snippet "expands" out to + // include this line. (And the line after, + // for one additional line of context.) + .primary("animals", "3", "3", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + | + ", + ); + + // If the annotation were on the next line, + // then the context windows for each annotation + // are adjacent, and thus we still end up with + // one snippet. + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "4", "4", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + 4 | dog + | ^^^ + 5 | elephant + | + ", + ); + + // But the line after that one, the context + // windows are no longer adjacent. You can + // tell this is correct because line 3 is + // omitted from the snippet below, since it + // is not in either annotation's context + // window. + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "5", "5", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + | + ::: animals:5:1 + | + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + | + ", + ); + + // Do the same round of tests as above, + // but with a bigger context window. + env.context(3); + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "5", "5", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + 4 | dog + 5 | elephant + | ^^^^^^^^ + 6 | finch + 7 | gorilla + 8 | hippopotamus + | + ", + ); + + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "8", "8", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + 4 | dog + 5 | elephant + 6 | finch + 7 | gorilla + 8 | hippopotamus + | ^^^^^^^^^^^^ + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | + ", + ); + + let diag = env + .err() + .primary("animals", "1", "1", "") + .primary("animals", "9", "9", "") + .build(); + // Line 5 is missing, as expected, since + // it is not in either annotation's context + // window. + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:1:1 + | + 1 | aardvark + | ^^^^^^^^ + 2 | beetle + 3 | canary + 4 | dog + | + ::: animals:9:1 + | + 6 | finch + 7 | gorilla + 8 | hippopotamus + 9 | inchworm + | ^^^^^^^^ + 10 | jackrabbit + 11 | kangaroo + | + ", + ); + } + + #[test] + fn trimmed_context() { + let mut env = TestEnvironment::new(); + env.add("spacey-animals", SPACEY_ANIMALS); + + // Set the context to `2` and pick `elephant` + // from the input. It has two adjacent non-whitespace + // lines on both sides, but then two whitespace + // lines after that. As a result, the context window + // effectively shrinks to `1`. + env.context(2); + let diag = env.err().primary("spacey-animals", "8", "8", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> spacey-animals:8:1 + | + 7 | dog + 8 | elephant + | ^^^^^^^^ + 9 | finch + | + ", + ); + + // Same thing, but where trimming only happens + // in the preceding context. + let diag = env.err().primary("spacey-animals", "12", "12", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> spacey-animals:12:1 + | + 11 | gorilla + 12 | hippopotamus + | ^^^^^^^^^^^^ + 13 | inchworm + 14 | jackrabbit + | + ", + ); + + // Again, with trimming only happening in the + // following context. + let diag = env.err().primary("spacey-animals", "13", "13", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> spacey-animals:13:1 + | + 11 | gorilla + 12 | hippopotamus + 13 | inchworm + | ^^^^^^^^ + 14 | jackrabbit + | + ", + ); + } + + #[test] + fn multiple_annotations_trimmed_context() { + let mut env = TestEnvironment::new(); + env.add("spacey-animals", SPACEY_ANIMALS); + + env.context(1); + let diag = env + .err() + .primary("spacey-animals", "3", "3", "") + .primary("spacey-animals", "5", "5", "") + .build(); + // Normally this would be one snippet, since + // a context of `1` on line `3` will be adjacent + // to the same sized context on line `5`. But since + // the context calculation trims leading/trailing + // whitespace lines, the context is not actually + // adjacent. + // + // Arguably, this is perhaps not what we want. In + // this case, the whitespace trimming is probably + // getting in the way of a more succinct and less + // jarring snippet. I wasn't 100% sure which + // behavior we wanted, so I left it as-is for now + // instead of special casing the snippet assembly. + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> spacey-animals:3:1 + | + 3 | beetle + | ^^^^^^ + | + ::: spacey-animals:5:1 + | + 5 | canary + | ^^^^^^ + | + ", + ); + } + + #[test] + fn multiple_files_basic() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let diag = env + .err() + .primary("animals", "3", "3", "") + .primary("fruits", "3", "3", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + ::: fruits:3:1 + | + 1 | apple + 2 | banana + 3 | cantelope + | ^^^^^^^^^ + 4 | lime + 5 | orange + | + ", + ); + } + + #[test] + fn sub_diag_note_only_message() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let mut diag = env.err().primary("animals", "3", "3", "").build(); + diag.sub( + env.sub_builder(Severity::Info, "this is a helpful note") + .build(), + ); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + info: this is a helpful note + ", + ); + } + + #[test] + fn sub_diag_many_notes() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let mut diag = env.err().primary("animals", "3", "3", "").build(); + diag.sub( + env.sub_builder(Severity::Info, "this is a helpful note") + .build(), + ); + diag.sub( + env.sub_builder(Severity::Info, "another helpful note") + .build(), + ); + diag.sub( + env.sub_builder(Severity::Info, "and another helpful note") + .build(), + ); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + info: this is a helpful note + info: another helpful note + info: and another helpful note + ", + ); + } + + #[test] + fn sub_diag_warning_with_annotation() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let mut diag = env.err().primary("animals", "3", "3", "").build(); + diag.sub(env.sub_warn().primary("fruits", "3", "3", "").build()); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + warning: sub-diagnostic message + --> fruits:3:1 + | + 1 | apple + 2 | banana + 3 | cantelope + | ^^^^^^^^^ + 4 | lime + 5 | orange + | + ", + ); + } + + #[test] + fn sub_diag_many_warning_with_annotation_order() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let mut diag = env.err().primary("animals", "3", "3", "").build(); + diag.sub(env.sub_warn().primary("fruits", "3", "3", "").build()); + diag.sub(env.sub_warn().primary("animals", "11", "11", "").build()); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + warning: sub-diagnostic message + --> fruits:3:1 + | + 1 | apple + 2 | banana + 3 | cantelope + | ^^^^^^^^^ + 4 | lime + 5 | orange + | + warning: sub-diagnostic message + --> animals:11:1 + | + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | ^^^^^^^^ + | + ", + ); + + // Flip the order of the subs and ensure + // this is reflected in the output. + let mut diag = env.err().primary("animals", "3", "3", "").build(); + diag.sub(env.sub_warn().primary("animals", "11", "11", "").build()); + diag.sub(env.sub_warn().primary("fruits", "3", "3", "").build()); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + warning: sub-diagnostic message + --> animals:11:1 + | + 9 | inchworm + 10 | jackrabbit + 11 | kangaroo + | ^^^^^^^^ + | + warning: sub-diagnostic message + --> fruits:3:1 + | + 1 | apple + 2 | banana + 3 | cantelope + | ^^^^^^^^^ + 4 | lime + 5 | orange + | + ", + ); + } + + #[test] + fn sub_diag_repeats_snippet() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + let mut diag = env.err().primary("animals", "3", "3", "").build(); + // There's nothing preventing a sub-diagnostic from referencing + // the same snippet rendered in another sub-diagnostic or the + // parent diagnostic. While annotations *within* a diagnostic + // (sub or otherwise) are coalesced into a minimal number of + // snippets, no such minimizing is done for sub-diagnostics. + // Namely, they are generally treated as completely separate. + diag.sub(env.sub_warn().secondary("animals", "3", "3", "").build()); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ^^^^^^ + 4 | dog + 5 | elephant + | + warning: sub-diagnostic message + --> animals:3:1 + | + 1 | aardvark + 2 | beetle + 3 | canary + | ------ + 4 | dog + 5 | elephant + | + ", + ); + } + + #[test] + fn annotation_multi_line() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + // We just try out various offsets here. + + // Two entire lines. + let diag = env.err().primary("animals", "5", "6", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | / elephant + 6 | | finch + | |_____^ + 7 | gorilla + 8 | hippopotamus + | + ", + ); + + // Two lines plus the start of a third. Since we treat the end + // position as inclusive AND because `ruff_annotate_snippets` + // will render the position of the start of the line as just + // past the end of the previous line, our annotation still only + // extends across two lines. + let diag = env.err().primary("animals", "5", "7:0", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | / elephant + 6 | | finch + | |______^ + 7 | gorilla + 8 | hippopotamus + | + ", + ); + + // Add one more to our end position though, and the third + // line gets included (as you might expect). + let diag = env.err().primary("animals", "5", "7:1", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | / elephant + 6 | | finch + 7 | | gorilla + | |_^ + 8 | hippopotamus + 9 | inchworm + | + ", + ); + + // Starting and stopping in the middle of two different lines. + let diag = env.err().primary("animals", "5:3", "8:8", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:4 + | + 3 | canary + 4 | dog + 5 | elephant + | ____^ + 6 | | finch + 7 | | gorilla + 8 | | hippopotamus + | |________^ + 9 | inchworm + 10 | jackrabbit + | + ", + ); + + // Same as above, but with a secondary annotation. + let diag = env.err().secondary("animals", "5:3", "8:8", "").build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:4 + | + 3 | canary + 4 | dog + 5 | elephant + | ____- + 6 | | finch + 7 | | gorilla + 8 | | hippopotamus + | |________- + 9 | inchworm + 10 | jackrabbit + | + ", + ); + } + + #[test] + fn annotation_overlapping_multi_line() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + // One annotation fully contained within another. + let diag = env + .err() + .primary("animals", "5", "6", "") + .primary("animals", "4", "7", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:4:1 + | + 2 | beetle + 3 | canary + 4 | dog + | __^ + 5 | | elephant + | | _^ + 6 | || finch + | ||_____^ + 7 | | gorilla + | |________^ + 8 | hippopotamus + 9 | inchworm + | + ", + ); + + // Same as above, but with order swapped. + // Shouldn't impact rendering. + let diag = env + .err() + .primary("animals", "4", "7", "") + .primary("animals", "5", "6", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:4:1 + | + 2 | beetle + 3 | canary + 4 | dog + | __^ + 5 | | elephant + | | _^ + 6 | || finch + | ||_____^ + 7 | | gorilla + | |________^ + 8 | hippopotamus + 9 | inchworm + | + ", + ); + + // One annotation is completely contained + // by the other, but the other has one + // non-overlapping line preceding the + // overlapping portion. + let diag = env + .err() + .primary("animals", "5", "7", "") + .primary("animals", "6", "7", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | __^ + 6 | | finch + | | _^ + 7 | || gorilla + | ||_______^ + | |_______| + | + 8 | hippopotamus + 9 | inchworm + | + ", + ); + + // One annotation is completely contained + // by the other, but the other has one + // non-overlapping line following the + // overlapping portion. + let diag = env + .err() + .primary("animals", "5", "6", "") + .primary("animals", "5", "7", "") + .build(); + // NOTE: I find the rendering here pretty + // confusing, but I believe it is correct. + // I'm not sure if it's possible to do much + // better using only ASCII art. + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | _^ + | |_| + 6 | || finch + | ||_____^ + 7 | | gorilla + | |_______^ + 8 | hippopotamus + 9 | inchworm + | + ", + ); + + // Annotations partially overlap, but both + // contain lines that aren't in the other. + let diag = env + .err() + .primary("animals", "5", "6", "") + .primary("animals", "6", "7", "") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 3 | canary + 4 | dog + 5 | elephant + | __^ + 6 | | finch + | |__^___^ + | _| + | | + 7 | | gorilla + | |_______^ + 8 | hippopotamus + 9 | inchworm + | + ", + ); + } + + #[test] + fn annotation_message() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + let diag = env + .err() + .primary("animals", "5:2", "5:6", "giant land mammal") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:3 + | + 3 | canary + 4 | dog + 5 | elephant + | ^^^^ giant land mammal + 6 | finch + 7 | gorilla + | + ", + ); + + // Same as above, but add two annotations for the same range. + let diag = env + .err() + .primary("animals", "5:2", "5:6", "giant land mammal") + .secondary("animals", "5:2", "5:6", "but afraid of mice") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:3 + | + 3 | canary + 4 | dog + 5 | elephant + | ---- + | | + | giant land mammal + | but afraid of mice + 6 | finch + 7 | gorilla + | + ", + ); + } + + #[test] + fn annotation_one_file_primary_always_comes_first() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + + // The secondary annotation is not only added first, + // but it appears first in the source. But it still + // comes second. + let diag = env + .err() + .secondary("animals", "1", "1", "secondary") + .primary("animals", "8", "8", "primary") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:8:1 + | + 6 | finch + 7 | gorilla + 8 | hippopotamus + | ^^^^^^^^^^^^ primary + 9 | inchworm + 10 | jackrabbit + | + ::: animals:1:1 + | + 1 | aardvark + | -------- secondary + 2 | beetle + 3 | canary + | + ", + ); + + // This is a weirder case where there are multiple + // snippets with primary annotations. We ensure that + // all such snippets appear before any snippets with + // zero primary annotations. Otherwise, the snippets + // appear in source order. + // + // (We also drop the context so that we can squeeze + // more snippets out of our test data.) + env.context(0); + let diag = env + .err() + .secondary("animals", "7", "7", "secondary 7") + .primary("animals", "9", "9", "primary 9") + .secondary("animals", "3", "3", "secondary 3") + .secondary("animals", "1", "1", "secondary 1") + .primary("animals", "5", "5", "primary 5") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:5:1 + | + 5 | elephant + | ^^^^^^^^ primary 5 + | + ::: animals:9:1 + | + 9 | inchworm + | ^^^^^^^^ primary 9 + | + ::: animals:1:1 + | + 1 | aardvark + | -------- secondary 1 + | + ::: animals:3:1 + | + 3 | canary + | ------ secondary 3 + | + ::: animals:7:1 + | + 7 | gorilla + | ------- secondary 7 + | + ", + ); + } + + #[test] + fn annotation_many_files_primary_always_comes_first() { + let mut env = TestEnvironment::new(); + env.add("animals", ANIMALS); + env.add("fruits", FRUITS); + + let diag = env + .err() + .secondary("animals", "1", "1", "secondary") + .primary("fruits", "1", "1", "primary") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> fruits:1:1 + | + 1 | apple + | ^^^^^ primary + 2 | banana + 3 | cantelope + | + ::: animals:1:1 + | + 1 | aardvark + | -------- secondary + 2 | beetle + 3 | canary + | + ", + ); + + // Same as the single file test, we try adding + // multiple primary annotations across multiple + // files. Those should always appear first + // *within* each file. + env.context(0); + let diag = env + .err() + .secondary("animals", "7", "7", "secondary animals 7") + .secondary("fruits", "2", "2", "secondary fruits 2") + .secondary("animals", "3", "3", "secondary animals 3") + .secondary("animals", "1", "1", "secondary animals 1") + .primary("animals", "11", "11", "primary animals 11") + .primary("fruits", "10", "10", "primary fruits 10") + .build(); + insta::assert_snapshot!( + env.render(&diag), + @r" + error[test-diagnostic]: main diagnostic message + --> animals:11:1 + | + 11 | kangaroo + | ^^^^^^^^ primary animals 11 + | + ::: animals:1:1 + | + 1 | aardvark + | -------- secondary animals 1 + | + ::: animals:3:1 + | + 3 | canary + | ------ secondary animals 3 + | + ::: animals:7:1 + | + 7 | gorilla + | ------- secondary animals 7 + | + ::: fruits:10:1 + | + 10 | watermelon + | ^^^^^^^^^^ primary fruits 10 + | + ::: fruits:2:1 + | + 2 | banana + | ------ secondary fruits 2 + | + ", + ); + } + + /// A small harness for setting up an environment specifically for testing + /// diagnostic rendering. + struct TestEnvironment { + db: TestDb, + config: DisplayDiagnosticConfig, + } + + impl TestEnvironment { + /// Create a new test harness. + /// + /// This uses the default diagnostic rendering configuration. + fn new() -> TestEnvironment { + TestEnvironment { + db: TestDb::new(), + config: DisplayDiagnosticConfig::default(), + } + } + + /// Set the number of contextual lines to include for each snippet + /// in diagnostic rendering. + fn context(&mut self, lines: usize) { + // Kind of annoying. I considered making `DisplayDiagnosticConfig` + // be `Copy` (which it could be, at time of writing, 2025-03-07), + // but it seems likely to me that it will grow non-`Copy` + // configuration. So just deal with this inconvenience for now. + let mut config = std::mem::take(&mut self.config); + config = config.context(lines); + self.config = config; + } + + /// Add a file with the given path and contents to this environment. + fn add(&mut self, path: &str, contents: &str) { + let path = SystemPath::new(path); + self.db.write_file(path, contents).unwrap(); + } + + /// Conveniently create a `Span` that points into a file in this + /// environment. + /// + /// The path given must have been added via `TestEnvironment::add`. + /// + /// The offset strings given should be in `{line}(:{offset})?` format. + /// `line` is a 1-indexed offset corresponding to the line number, + /// while `offset` is a 0-indexed *byte* offset starting from the + /// beginning of the corresponding line. When `offset` is missing from + /// the start of the span, it is assumed to be `0`. When `offset` is + /// missing from the end of the span, it is assumed to be the length + /// of the corresponding line minus one. (The "minus one" is because + /// otherwise, the span will end where the next line begins, and this + /// confuses `ruff_annotate_snippets` as of 2025-03-13.) + fn span(&self, path: &str, line_offset_start: &str, line_offset_end: &str) -> Span { + let span = self.path(path); + + let file = span.expect_ty_file(); + let text = source_text(&self.db, file); + let line_index = line_index(&self.db, file); + let source = SourceCode::new(text.as_str(), &line_index); + + let (line_start, offset_start) = parse_line_offset(line_offset_start); + let (line_end, offset_end) = parse_line_offset(line_offset_end); + + let start = match offset_start { + None => source.line_start(line_start), + Some(offset) => source.line_start(line_start) + offset, + }; + let end = match offset_end { + None => source.line_end(line_end) - TextSize::from(1), + Some(offset) => source.line_start(line_end) + offset, + }; + span.with_range(TextRange::new(start, end)) + } + + /// Like `span`, but only attaches a file path. + fn path(&self, path: &str) -> Span { + let file = system_path_to_file(&self.db, path).unwrap(); + Span::from(file) + } + + /// A convenience function for returning a builder for a diagnostic + /// with "error" severity and canned values for its identifier + /// and message. + fn err(&mut self) -> DiagnosticBuilder<'_> { + self.builder( + "test-diagnostic", + Severity::Error, + "main diagnostic message", + ) + } + + /// A convenience function for returning a builder for a + /// sub-diagnostic with "error" severity and canned values for + /// its identifier and message. + fn sub_warn(&mut self) -> SubDiagnosticBuilder<'_> { + self.sub_builder(Severity::Warning, "sub-diagnostic message") + } + + /// Returns a builder for tersely constructing diagnostics. + fn builder( + &mut self, + identifier: &'static str, + severity: Severity, + message: &str, + ) -> DiagnosticBuilder<'_> { + let diag = Diagnostic::new(id(identifier), severity, message); + DiagnosticBuilder { env: self, diag } + } + + /// Returns a builder for tersely constructing sub-diagnostics. + fn sub_builder(&mut self, severity: Severity, message: &str) -> SubDiagnosticBuilder<'_> { + let subdiag = SubDiagnostic::new(severity, message); + SubDiagnosticBuilder { env: self, subdiag } + } + + /// Render the given diagnostic into a `String`. + /// + /// (This will set the "printed" flag on `Diagnostic`.) + fn render(&self, diag: &Diagnostic) -> String { + diag.display(&self.db.upcast(), &self.config).to_string() + } + } + + /// A helper builder for tersely populating a `Diagnostic`. + /// + /// If you need to mutate the diagnostic in a way that isn't + /// supported by this builder, and this only needs to be done + /// infrequently, consider doing it more verbosely on `diag` + /// itself. + struct DiagnosticBuilder<'e> { + env: &'e mut TestEnvironment, + diag: Diagnostic, + } + + impl<'e> DiagnosticBuilder<'e> { + /// Return the built diagnostic. + fn build(self) -> Diagnostic { + self.diag + } + + /// Add a primary annotation with a message. + /// + /// If the message is empty, then an annotation without any + /// message be created. + /// + /// See the docs on `TestEnvironment::span` for the meaning of + /// `path`, `line_offset_start` and `line_offset_end`. + fn primary( + mut self, + path: &str, + line_offset_start: &str, + line_offset_end: &str, + label: &str, + ) -> DiagnosticBuilder<'e> { + let span = self.env.span(path, line_offset_start, line_offset_end); + let mut ann = Annotation::primary(span); + if !label.is_empty() { + ann = ann.message(label); + } + self.diag.annotate(ann); + self + } + + /// Add a secondary annotation with a message. + /// + /// If the message is empty, then an annotation without any + /// message be created. + /// + /// See the docs on `TestEnvironment::span` for the meaning of + /// `path`, `line_offset_start` and `line_offset_end`. + fn secondary( + mut self, + path: &str, + line_offset_start: &str, + line_offset_end: &str, + label: &str, + ) -> DiagnosticBuilder<'e> { + let span = self.env.span(path, line_offset_start, line_offset_end); + let mut ann = Annotation::secondary(span); + if !label.is_empty() { + ann = ann.message(label); + } + self.diag.annotate(ann); + self + } + } + + /// A helper builder for tersely populating a `SubDiagnostic`. + /// + /// If you need to mutate the sub-diagnostic in a way that isn't + /// supported by this builder, and this only needs to be done + /// infrequently, consider doing it more verbosely on `diag` + /// itself. + struct SubDiagnosticBuilder<'e> { + env: &'e mut TestEnvironment, + subdiag: SubDiagnostic, + } + + impl<'e> SubDiagnosticBuilder<'e> { + /// Return the built sub-diagnostic. + fn build(self) -> SubDiagnostic { + self.subdiag + } + + /// Add a primary annotation with a message. + /// + /// If the message is empty, then an annotation without any + /// message be created. + /// + /// See the docs on `TestEnvironment::span` for the meaning of + /// `path`, `line_offset_start` and `line_offset_end`. + fn primary( + mut self, + path: &str, + line_offset_start: &str, + line_offset_end: &str, + label: &str, + ) -> SubDiagnosticBuilder<'e> { + let span = self.env.span(path, line_offset_start, line_offset_end); + let mut ann = Annotation::primary(span); + if !label.is_empty() { + ann = ann.message(label); + } + self.subdiag.annotate(ann); + self + } + + /// Add a secondary annotation with a message. + /// + /// If the message is empty, then an annotation without any + /// message be created. + /// + /// See the docs on `TestEnvironment::span` for the meaning of + /// `path`, `line_offset_start` and `line_offset_end`. + fn secondary( + mut self, + path: &str, + line_offset_start: &str, + line_offset_end: &str, + label: &str, + ) -> SubDiagnosticBuilder<'e> { + let span = self.env.span(path, line_offset_start, line_offset_end); + let mut ann = Annotation::secondary(span); + if !label.is_empty() { + ann = ann.message(label); + } + self.subdiag.annotate(ann); + self + } + } + + fn id(lint_name: &'static str) -> DiagnosticId { + DiagnosticId::lint(lint_name) + } + + fn parse_line_offset(s: &str) -> (OneIndexed, Option<TextSize>) { + let Some((line, offset)) = s.split_once(":") else { + let line_number = OneIndexed::new(s.parse().unwrap()).unwrap(); + return (line_number, None); + }; + let line_number = OneIndexed::new(line.parse().unwrap()).unwrap(); + let offset = TextSize::from(offset.parse::<u32>().unwrap()); + (line_number, Some(offset)) + } +} diff --git a/crates/ruff_db/src/diagnostic/stylesheet.rs b/crates/ruff_db/src/diagnostic/stylesheet.rs new file mode 100644 index 0000000000000..f3d451030bcb8 --- /dev/null +++ b/crates/ruff_db/src/diagnostic/stylesheet.rs @@ -0,0 +1,80 @@ +use anstyle::{AnsiColor, Effects, Style}; +use std::fmt::Formatter; + +pub(super) const fn fmt_styled<'a, T>( + content: T, + style: anstyle::Style, +) -> impl std::fmt::Display + 'a +where + T: std::fmt::Display + 'a, +{ + struct FmtStyled<T> { + content: T, + style: anstyle::Style, + } + + impl<T> std::fmt::Display for FmtStyled<T> + where + T: std::fmt::Display, + { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!( + f, + "{style_start}{content}{style_end}", + style_start = self.style.render(), + content = self.content, + style_end = self.style.render_reset() + ) + } + } + + FmtStyled { content, style } +} + +#[derive(Clone, Debug)] +pub struct DiagnosticStylesheet { + pub(crate) error: Style, + pub(crate) warning: Style, + pub(crate) info: Style, + pub(crate) note: Style, + pub(crate) help: Style, + pub(crate) line_no: Style, + pub(crate) emphasis: Style, + pub(crate) none: Style, +} + +impl Default for DiagnosticStylesheet { + fn default() -> Self { + Self::plain() + } +} + +impl DiagnosticStylesheet { + /// Default terminal styling + pub fn styled() -> Self { + let bright_blue = AnsiColor::BrightBlue.on_default(); + Self { + error: AnsiColor::BrightRed.on_default().effects(Effects::BOLD), + warning: AnsiColor::Yellow.on_default().effects(Effects::BOLD), + info: bright_blue.effects(Effects::BOLD), + note: AnsiColor::BrightGreen.on_default().effects(Effects::BOLD), + help: AnsiColor::BrightCyan.on_default().effects(Effects::BOLD), + line_no: bright_blue.effects(Effects::BOLD), + emphasis: Style::new().effects(Effects::BOLD), + none: Style::new(), + } + } + + pub fn plain() -> Self { + Self { + error: Style::new(), + warning: Style::new(), + info: Style::new(), + note: Style::new(), + help: Style::new(), + line_no: Style::new(), + emphasis: Style::new(), + none: Style::new(), + } + } +} diff --git a/crates/ruff_db/src/display.rs b/crates/ruff_db/src/display.rs index 439cd4b1becd3..27f93846e8216 100644 --- a/crates/ruff_db/src/display.rs +++ b/crates/ruff_db/src/display.rs @@ -22,7 +22,7 @@ pub struct Join<'a, 'b> { seen_first: bool, } -impl<'a, 'b> Join<'a, 'b> { +impl Join<'_, '_> { pub fn entry(&mut self, item: &dyn Display) -> &mut Self { if self.seen_first { self.result = self diff --git a/crates/ruff_db/src/file_revision.rs b/crates/ruff_db/src/file_revision.rs index 35b27aa9d28fc..8662653299267 100644 --- a/crates/ruff_db/src/file_revision.rs +++ b/crates/ruff_db/src/file_revision.rs @@ -1,3 +1,5 @@ +use crate::system::file_time_now; + /// A number representing the revision of a file. /// /// Two revisions that don't compare equal signify that the file has been modified. @@ -16,7 +18,7 @@ impl FileRevision { } pub fn now() -> Self { - Self::from(filetime::FileTime::now()) + Self::from(file_time_now()) } pub const fn zero() -> Self { @@ -53,13 +55,12 @@ impl From<filetime::FileTime> for FileRevision { #[cfg(test)] mod tests { - use filetime::FileTime; use super::*; #[test] fn revision_from_file_time() { - let file_time = FileTime::now(); + let file_time = file_time_now(); let revision = FileRevision::from(file_time); let revision = revision.as_u128(); diff --git a/crates/ruff_db/src/files.rs b/crates/ruff_db/src/files.rs index 64021902cbf1a..cae4b51853a5b 100644 --- a/crates/ruff_db/src/files.rs +++ b/crates/ruff_db/src/files.rs @@ -1,21 +1,23 @@ -use std::fmt::Formatter; +use std::fmt; use std::sync::Arc; use countme::Count; use dashmap::mapref::entry::Entry; -use salsa::{Durability, Setter}; - pub use file_root::{FileRoot, FileRootKind}; pub use path::FilePath; use ruff_notebook::{Notebook, NotebookError}; use ruff_python_ast::PySourceType; +use ruff_text_size::{Ranged, TextRange}; +use salsa::plumbing::AsId; +use salsa::{Durability, Setter}; +use crate::diagnostic::{Span, UnifiedFile}; use crate::file_revision::FileRevision; use crate::files::file_root::FileRoots; use crate::files::private::FileStatus; use crate::system::{SystemPath, SystemPathBuf, SystemVirtualPath, SystemVirtualPathBuf}; use crate::vendored::{VendoredPath, VendoredPathBuf}; -use crate::{vendored, Db, FxDashMap}; +use crate::{Db, FxDashMap, vendored}; mod file_root; mod path; @@ -48,7 +50,7 @@ pub fn vendored_path_to_file( } /// Lookup table that maps [file paths](`FilePath`) to salsa interned [`File`] instances. -#[derive(Default)] +#[derive(Default, Clone)] pub struct Files { inner: Arc<FilesInner>, } @@ -93,7 +95,9 @@ impl Files { .root(db, path) .map_or(Durability::default(), |root| root.durability(db)); - let builder = File::builder(FilePath::System(absolute)).durability(durability); + let builder = File::builder(FilePath::System(absolute)) + .durability(durability) + .path_durability(Durability::HIGH); let builder = match metadata { Ok(metadata) if metadata.file_type().is_file() => builder @@ -102,7 +106,9 @@ impl Files { Ok(metadata) if metadata.file_type().is_directory() => { builder.status(FileStatus::IsADirectory) } - _ => builder.status(FileStatus::NotFound), + _ => builder + .status(FileStatus::NotFound) + .status_durability(Durability::MEDIUM.max(durability)), }; builder.new(db) @@ -156,9 +162,11 @@ impl Files { tracing::trace!("Adding virtual file {}", path); let virtual_file = VirtualFile( File::builder(FilePath::SystemVirtual(path.to_path_buf())) + .path_durability(Durability::HIGH) .status(FileStatus::Exists) .revision(FileRevision::zero()) .permissions(None) + .permissions_durability(Durability::HIGH) .new(db), ); self.inner @@ -251,16 +259,9 @@ impl Files { root.set_revision(db).to(FileRevision::now()); } } - - #[must_use] - pub fn snapshot(&self) -> Self { - Self { - inner: Arc::clone(&self.inner), - } - } } -impl std::fmt::Debug for Files { +impl fmt::Debug for Files { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { let mut map = f.debug_map(); @@ -274,10 +275,15 @@ impl std::fmt::Debug for Files { impl std::panic::RefUnwindSafe for Files {} /// A file that's either stored on the host system's file system or in the vendored file system. +/// +/// # Ordering +/// Ordering is based on the file's salsa-assigned id and not on its values. +/// The id may change between runs. #[salsa::input] +#[derive(PartialOrd, Ord)] pub struct File { - /// The path of the file. - #[return_ref] + /// The path of the file (immutable). + #[returns(ref)] pub path: FilePath, /// The unix permissions of the file. Only supported on unix systems. Always `None` on Windows @@ -428,9 +434,37 @@ impl File { /// Returns `true` if the file should be analyzed as a type stub. pub fn is_stub(self, db: &dyn Db) -> bool { - self.path(db) - .extension() - .is_some_and(|extension| PySourceType::from_extension(extension).is_stub()) + self.source_type(db).is_stub() + } + + pub fn source_type(self, db: &dyn Db) -> PySourceType { + match self.path(db) { + FilePath::System(path) => path + .extension() + .map_or(PySourceType::Python, PySourceType::from_extension), + FilePath::Vendored(_) => PySourceType::Stub, + FilePath::SystemVirtual(path) => path + .extension() + .map_or(PySourceType::Python, PySourceType::from_extension), + } + } +} + +impl fmt::Debug for File { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + salsa::with_attached_database(|db| { + if f.alternate() { + f.debug_struct("File") + .field("path", &self.path(db)) + .field("status", &self.status(db)) + .field("permissions", &self.permissions(db)) + .field("revision", &self.revision(db)) + .finish() + } else { + f.debug_tuple("File").field(&self.path(db)).finish() + } + }) + .unwrap_or_else(|| f.debug_tuple("file").field(&self.as_id()).finish()) } } @@ -486,8 +520,8 @@ pub enum FileError { NotFound, } -impl std::fmt::Display for FileError { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { +impl fmt::Display for FileError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::fmt::Result { match self { FileError::IsADirectory => f.write_str("Is a directory"), FileError::NotFound => f.write_str("Not found"), @@ -497,11 +531,58 @@ impl std::fmt::Display for FileError { impl std::error::Error for FileError {} +/// Range with its corresponding file. +#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] +pub struct FileRange { + file: File, + range: TextRange, +} + +impl FileRange { + pub const fn new(file: File, range: TextRange) -> Self { + Self { file, range } + } + + pub const fn file(&self) -> File { + self.file + } +} + +impl Ranged for FileRange { + #[inline] + fn range(&self) -> TextRange { + self.range + } +} + +impl TryFrom<&Span> for FileRange { + type Error = (); + + fn try_from(value: &Span) -> Result<Self, Self::Error> { + let UnifiedFile::Ty(file) = value.file() else { + return Err(()); + }; + + Ok(Self { + file: *file, + range: value.range().ok_or(())?, + }) + } +} + +impl TryFrom<Span> for FileRange { + type Error = (); + + fn try_from(value: Span) -> Result<Self, Self::Error> { + Self::try_from(&value) + } +} + #[cfg(test)] mod tests { use crate::file_revision::FileRevision; - use crate::files::{system_path_to_file, vendored_path_to_file, FileError}; - use crate::system::DbWithTestSystem; + use crate::files::{FileError, system_path_to_file, vendored_path_to_file}; + use crate::system::DbWithWritableSystem as _; use crate::tests::TestDb; use crate::vendored::VendoredFileSystemBuilder; use zip::CompressionMethod; diff --git a/crates/ruff_db/src/files/file_root.rs b/crates/ruff_db/src/files/file_root.rs index c12a9e0d0cd5a..baf4716f15fe0 100644 --- a/crates/ruff_db/src/files/file_root.rs +++ b/crates/ruff_db/src/files/file_root.rs @@ -3,24 +3,24 @@ use std::fmt::Formatter; use path_slash::PathExt; use salsa::Durability; +use crate::Db; use crate::file_revision::FileRevision; use crate::system::{SystemPath, SystemPathBuf}; -use crate::Db; /// A root path for files tracked by the database. /// /// We currently create roots for: /// * static module resolution paths -/// * the workspace root +/// * the project root /// /// The main usage of file roots is to determine a file's durability. But it can also be used /// to make a salsa query dependent on whether a file in a root has changed without writing any /// manual invalidation logic. -#[salsa::input] +#[salsa::input(debug)] pub struct FileRoot { /// The path of a root is guaranteed to never change. - #[return_ref] - path_buf: SystemPathBuf, + #[returns(deref)] + pub path: SystemPathBuf, /// The kind of the root at the time of its creation. kind_at_time_of_creation: FileRootKind, @@ -32,10 +32,6 @@ pub struct FileRoot { } impl FileRoot { - pub fn path(self, db: &dyn Db) -> &SystemPath { - self.path_buf(db) - } - pub fn durability(self, db: &dyn Db) -> salsa::Durability { self.kind_at_time_of_creation(db).durability() } @@ -43,17 +39,17 @@ impl FileRoot { #[derive(Copy, Clone, Debug, Eq, PartialEq)] pub enum FileRootKind { - /// The root of a workspace. - Workspace, + /// The root of a project. + Project, - /// A non-workspace module resolution search path. + /// A non-project module resolution search path. LibrarySearchPath, } impl FileRootKind { const fn durability(self) -> Durability { match self { - FileRootKind::Workspace => Durability::LOW, + FileRootKind::Project => Durability::LOW, FileRootKind::LibrarySearchPath => Durability::HIGH, } } diff --git a/crates/ruff_db/src/files/path.rs b/crates/ruff_db/src/files/path.rs index fddac0fa226fc..ebe6e7261a1f9 100644 --- a/crates/ruff_db/src/files/path.rs +++ b/crates/ruff_db/src/files/path.rs @@ -1,7 +1,7 @@ -use crate::files::{system_path_to_file, vendored_path_to_file, File}; +use crate::Db; +use crate::files::{File, system_path_to_file, vendored_path_to_file}; use crate::system::{SystemPath, SystemPathBuf, SystemVirtualPath, SystemVirtualPathBuf}; use crate::vendored::{VendoredPath, VendoredPathBuf}; -use crate::Db; use std::fmt::{Display, Formatter}; /// Path to a file. diff --git a/crates/ruff_db/src/lib.rs b/crates/ruff_db/src/lib.rs index 63369d9fa1716..c970a99d12e4a 100644 --- a/crates/ruff_db/src/lib.rs +++ b/crates/ruff_db/src/lib.rs @@ -1,14 +1,16 @@ -use std::hash::BuildHasherDefault; - -use rustc_hash::FxHasher; - use crate::files::Files; use crate::system::System; use crate::vendored::VendoredFileSystem; +use ruff_python_ast::PythonVersion; +use rustc_hash::FxHasher; +use std::hash::BuildHasherDefault; +use std::num::NonZeroUsize; +pub mod diagnostic; pub mod display; pub mod file_revision; pub mod files; +pub mod panic; pub mod parsed; pub mod source; pub mod system; @@ -25,6 +27,7 @@ pub trait Db: salsa::Database { fn vendored(&self) -> &VendoredFileSystem; fn system(&self) -> &dyn System; fn files(&self) -> &Files; + fn python_version(&self) -> PythonVersion; } /// Trait for upcasting a reference to a base trait object. @@ -33,58 +36,82 @@ pub trait Upcast<T: ?Sized> { fn upcast_mut(&mut self) -> &mut T; } +/// Returns the maximum number of tasks that ty is allowed +/// to process in parallel. +/// +/// Returns [`std::thread::available_parallelism`], unless the environment +/// variable `TY_MAX_PARALLELISM` or `RAYON_NUM_THREADS` is set. `TY_MAX_PARALLELISM` takes +/// precedence over `RAYON_NUM_THREADS`. +/// +/// Falls back to `1` if `available_parallelism` is not available. +/// +/// Setting `TY_MAX_PARALLELISM` to `2` only restricts the number of threads that ty spawns +/// to process work in parallel. For example, to index a directory or checking the files of a project. +/// ty can still spawn more threads for other tasks, e.g. to wait for a Ctrl+C signal or +/// watching the files for changes. +pub fn max_parallelism() -> NonZeroUsize { + std::env::var("TY_MAX_PARALLELISM") + .or_else(|_| std::env::var("RAYON_NUM_THREADS")) + .ok() + .and_then(|s| s.parse().ok()) + .unwrap_or_else(|| { + std::thread::available_parallelism().unwrap_or_else(|_| NonZeroUsize::new(1).unwrap()) + }) +} + #[cfg(test)] mod tests { - use std::sync::Arc; + use std::sync::{Arc, Mutex}; use crate::files::Files; use crate::system::TestSystem; use crate::system::{DbWithTestSystem, System}; use crate::vendored::VendoredFileSystem; - use crate::Db; + use crate::{Db, Upcast}; + + type Events = Arc<Mutex<Vec<salsa::Event>>>; /// Database that can be used for testing. /// /// Uses an in memory filesystem and it stubs out the vendored files by default. #[salsa::db] - #[derive(Default)] + #[derive(Default, Clone)] pub(crate) struct TestDb { storage: salsa::Storage<Self>, files: Files, system: TestSystem, vendored: VendoredFileSystem, - events: std::sync::Arc<std::sync::Mutex<Vec<salsa::Event>>>, + events: Events, } impl TestDb { pub(crate) fn new() -> Self { + let events = Events::default(); Self { - storage: salsa::Storage::default(), + storage: salsa::Storage::new(Some(Box::new({ + let events = events.clone(); + move |event| { + tracing::trace!("event: {:?}", event); + let mut events = events.lock().unwrap(); + events.push(event); + } + }))), system: TestSystem::default(), vendored: VendoredFileSystem::default(), - events: std::sync::Arc::default(), + events, files: Files::default(), } } /// Empties the internal store of salsa events that have been emitted, /// and returns them as a `Vec` (equivalent to [`std::mem::take`]). - /// - /// ## Panics - /// If there are pending database snapshots. - #[allow(unused)] pub(crate) fn take_salsa_events(&mut self) -> Vec<salsa::Event> { - let inner = Arc::get_mut(&mut self.events) - .expect("expected no pending salsa database snapshots."); + let mut events = self.events.lock().unwrap(); - std::mem::take(inner.get_mut().unwrap()) + std::mem::take(&mut *events) } /// Clears the emitted salsa events. - /// - /// ## Panics - /// If there are pending database snapshots. - #[allow(unused)] pub(crate) fn clear_salsa_events(&mut self) { self.take_salsa_events(); } @@ -107,6 +134,19 @@ mod tests { fn files(&self) -> &Files { &self.files } + + fn python_version(&self) -> ruff_python_ast::PythonVersion { + ruff_python_ast::PythonVersion::latest_ty() + } + } + + impl Upcast<dyn Db> for TestDb { + fn upcast(&self) -> &(dyn Db + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn Db + 'static) { + self + } } impl DbWithTestSystem for TestDb { @@ -120,12 +160,5 @@ mod tests { } #[salsa::db] - impl salsa::Database for TestDb { - fn salsa_event(&self, event: &dyn Fn() -> salsa::Event) { - let event = event(); - tracing::trace!("event: {:?}", event); - let mut events = self.events.lock().unwrap(); - events.push(event); - } - } + impl salsa::Database for TestDb {} } diff --git a/crates/ruff_db/src/panic.rs b/crates/ruff_db/src/panic.rs new file mode 100644 index 0000000000000..67ebf940dc3b9 --- /dev/null +++ b/crates/ruff_db/src/panic.rs @@ -0,0 +1,190 @@ +use std::backtrace::BacktraceStatus; +use std::cell::Cell; +use std::panic::Location; +use std::sync::OnceLock; + +#[derive(Debug)] +pub struct PanicError { + pub location: Option<String>, + pub payload: Payload, + pub backtrace: Option<std::backtrace::Backtrace>, + pub salsa_backtrace: Option<salsa::Backtrace>, +} + +#[derive(Debug)] +pub struct Payload(Box<dyn std::any::Any + Send>); + +impl Payload { + pub fn as_str(&self) -> Option<&str> { + if let Some(s) = self.0.downcast_ref::<String>() { + Some(s) + } else if let Some(s) = self.0.downcast_ref::<&str>() { + Some(s) + } else { + None + } + } +} + +impl std::fmt::Display for PanicError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + writeln!(f, "panicked at")?; + if let Some(location) = &self.location { + write!(f, " {location}")?; + } + if let Some(payload) = self.payload.as_str() { + write!(f, ":\n{payload}")?; + } + if let Some(backtrace) = &self.backtrace { + match backtrace.status() { + BacktraceStatus::Disabled => { + writeln!( + f, + "\nrun with `RUST_BACKTRACE=1` environment variable to display a backtrace" + )?; + } + BacktraceStatus::Captured => { + writeln!(f, "\nBacktrace: {backtrace}")?; + } + _ => {} + } + } + Ok(()) + } +} + +#[derive(Default)] +struct CapturedPanicInfo { + backtrace: Option<std::backtrace::Backtrace>, + location: Option<String>, + salsa_backtrace: Option<salsa::Backtrace>, +} + +thread_local! { + static CAPTURE_PANIC_INFO: Cell<bool> = const { Cell::new(false) }; + static LAST_BACKTRACE: Cell<CapturedPanicInfo> = const { + Cell::new(CapturedPanicInfo { backtrace: None, location: None, salsa_backtrace: None }) + }; +} + +fn install_hook() { + static ONCE: OnceLock<()> = OnceLock::new(); + ONCE.get_or_init(|| { + let prev = std::panic::take_hook(); + std::panic::set_hook(Box::new(move |info| { + let should_capture = CAPTURE_PANIC_INFO.with(Cell::get); + if !should_capture { + return (*prev)(info); + } + + let location = info.location().map(Location::to_string); + let backtrace = Some(std::backtrace::Backtrace::capture()); + + LAST_BACKTRACE.set(CapturedPanicInfo { + backtrace, + location, + salsa_backtrace: salsa::Backtrace::capture(), + }); + })); + }); +} + +/// Invokes a closure, capturing and returning the cause of an unwinding panic if one occurs. +/// +/// ### Thread safety +/// +/// This is implemented by installing a custom [panic hook](std::panic::set_hook). This panic hook +/// is a global resource. The hook that we install captures panic info in a thread-safe manner, +/// and also ensures that any threads that are _not_ currently using this `catch_unwind` wrapper +/// still use the previous hook (typically the default hook, which prints out panic information to +/// stderr). +/// +/// We assume that there is nothing else running in this process that needs to install a competing +/// panic hook. We are careful to install our custom hook only once, and we do not ever restore +/// the previous hook (since you can always retain the previous hook's behavior by not calling this +/// wrapper). +pub fn catch_unwind<F, R>(f: F) -> Result<R, PanicError> +where + F: FnOnce() -> R + std::panic::UnwindSafe, +{ + install_hook(); + let prev_should_capture = CAPTURE_PANIC_INFO.replace(true); + let result = std::panic::catch_unwind(f).map_err(|payload| { + // Try to get the backtrace and location from our custom panic hook. + // The custom panic hook only runs once when `panic!` is called (or similar). It doesn't + // run when the panic is propagated with `std::panic::resume_unwind`. The panic hook + // is also not called when the panic is raised with `std::panic::resum_unwind` as is the + // case for salsa unwinds (see the ignored test below). + // Because of that, always take the payload from `catch_unwind` because it may have been transformed + // by an inner `std::panic::catch_unwind` handlers and only use the information + // from the custom handler to enrich the error with the backtrace and location. + let CapturedPanicInfo { + location, + backtrace, + salsa_backtrace, + } = LAST_BACKTRACE.with(Cell::take); + + PanicError { + location, + payload: Payload(payload), + backtrace, + salsa_backtrace, + } + }); + CAPTURE_PANIC_INFO.set(prev_should_capture); + result +} + +#[cfg(test)] +mod tests { + use salsa::{Database, Durability}; + + #[test] + #[ignore = "super::catch_unwind installs a custom panic handler, which could effect test isolation"] + fn no_backtrace_for_salsa_cancelled() { + #[salsa::input] + struct Input { + value: u32, + } + + #[salsa::tracked] + fn test_query(db: &dyn Database, input: Input) -> u32 { + loop { + // This should throw a cancelled error + let _ = input.value(db); + } + } + + let db = salsa::DatabaseImpl::new(); + + let input = Input::new(&db, 42); + + let result = std::thread::scope(move |scope| { + { + let mut db = db.clone(); + scope.spawn(move || { + // This will cancel the other thread by throwing a `salsa::Cancelled` error. + db.synthetic_write(Durability::MEDIUM); + }); + } + + { + scope.spawn(move || { + super::catch_unwind(|| { + test_query(&db, input); + }) + }) + } + .join() + .unwrap() + }); + + match result { + Ok(_) => panic!("Expected query to panic"), + Err(err) => { + // Panics triggered with `resume_unwind` have no backtrace. + assert!(err.backtrace.is_none()); + } + } + } +} diff --git a/crates/ruff_db/src/parsed.rs b/crates/ruff_db/src/parsed.rs index e93d5e55178c2..d1f6f6a125f79 100644 --- a/crates/ruff_db/src/parsed.rs +++ b/crates/ruff_db/src/parsed.rs @@ -2,12 +2,12 @@ use std::fmt::Formatter; use std::ops::Deref; use std::sync::Arc; -use ruff_python_ast::{ModModule, PySourceType}; -use ruff_python_parser::{parse_unchecked_source, Parsed}; +use ruff_python_ast::ModModule; +use ruff_python_parser::{ParseOptions, Parsed, parse_unchecked}; -use crate::files::{File, FilePath}; -use crate::source::source_text; use crate::Db; +use crate::files::File; +use crate::source::source_text; /// Returns the parsed AST of `file`, including its token stream. /// @@ -20,24 +20,20 @@ use crate::Db; /// reflected in the changed AST offsets. /// The other reason is that Ruff's AST doesn't implement `Eq` which Sala requires /// for determining if a query result is unchanged. -#[salsa::tracked(return_ref, no_eq)] +#[salsa::tracked(returns(ref), no_eq)] pub fn parsed_module(db: &dyn Db, file: File) -> ParsedModule { - let _span = tracing::trace_span!("parsed_module", file = %file.path(db)).entered(); + let _span = tracing::trace_span!("parsed_module", ?file).entered(); let source = source_text(db, file); - let path = file.path(db); - - let ty = match path { - FilePath::System(path) => path - .extension() - .map_or(PySourceType::Python, PySourceType::from_extension), - FilePath::Vendored(_) => PySourceType::Stub, - FilePath::SystemVirtual(path) => path - .extension() - .map_or(PySourceType::Python, PySourceType::from_extension), - }; + let ty = file.source_type(db); - ParsedModule::new(parse_unchecked_source(&source, ty)) + let target_version = db.python_version(); + let options = ParseOptions::from(ty).with_target_version(target_version); + let parsed = parse_unchecked(&source, options) + .try_into_module() + .expect("PySourceType always parses into a module"); + + ParsedModule::new(parsed) } /// Cheap cloneable wrapper around the parsed module. @@ -73,14 +69,24 @@ impl std::fmt::Debug for ParsedModule { } } +impl PartialEq for ParsedModule { + fn eq(&self, other: &Self) -> bool { + Arc::ptr_eq(&self.inner, &other.inner) + } +} + +impl Eq for ParsedModule {} + #[cfg(test)] mod tests { + use crate::Db; use crate::files::{system_path_to_file, vendored_path_to_file}; use crate::parsed::parsed_module; - use crate::system::{DbWithTestSystem, SystemPath, SystemVirtualPath}; + use crate::system::{ + DbWithTestSystem, DbWithWritableSystem as _, SystemPath, SystemVirtualPath, + }; use crate::tests::TestDb; use crate::vendored::{VendoredFileSystemBuilder, VendoredPath}; - use crate::Db; use zip::CompressionMethod; #[test] @@ -88,13 +94,13 @@ mod tests { let mut db = TestDb::new(); let path = "test.py"; - db.write_file(path, "x = 10".to_string())?; + db.write_file(path, "x = 10")?; let file = system_path_to_file(&db, path).unwrap(); let parsed = parsed_module(&db, file); - assert!(parsed.is_valid()); + assert!(parsed.has_valid_syntax()); Ok(()) } @@ -104,13 +110,13 @@ mod tests { let mut db = TestDb::new(); let path = SystemPath::new("test.ipynb"); - db.write_file(path, "%timeit a = b".to_string())?; + db.write_file(path, "%timeit a = b")?; let file = system_path_to_file(&db, path).unwrap(); let parsed = parsed_module(&db, file); - assert!(parsed.is_valid()); + assert!(parsed.has_valid_syntax()); Ok(()) } @@ -126,7 +132,7 @@ mod tests { let parsed = parsed_module(&db, virtual_file.file()); - assert!(parsed.is_valid()); + assert!(parsed.has_valid_syntax()); Ok(()) } @@ -142,7 +148,7 @@ mod tests { let parsed = parsed_module(&db, virtual_file.file()); - assert!(parsed.is_valid()); + assert!(parsed.has_valid_syntax()); Ok(()) } @@ -173,6 +179,6 @@ else: let parsed = parsed_module(&db, file); - assert!(parsed.is_valid()); + assert!(parsed.has_valid_syntax()); } } diff --git a/crates/ruff_db/src/source.rs b/crates/ruff_db/src/source.rs index 7605d9f30c1de..aac59a60604e6 100644 --- a/crates/ruff_db/src/source.rs +++ b/crates/ruff_db/src/source.rs @@ -1,32 +1,28 @@ -use std::fmt::Formatter; use std::ops::Deref; use std::sync::Arc; use countme::Count; -use salsa::Accumulator; use ruff_notebook::Notebook; use ruff_python_ast::PySourceType; use ruff_source_file::LineIndex; -use crate::files::{File, FilePath}; use crate::Db; +use crate::files::{File, FilePath}; /// Reads the source text of a python text file (must be valid UTF8) or notebook. #[salsa::tracked] pub fn source_text(db: &dyn Db, file: File) -> SourceText { let path = file.path(db); let _span = tracing::trace_span!("source_text", file = %path).entered(); - let mut has_read_error = false; + let mut read_error = None; let kind = if is_notebook(file.path(db)) { file.read_to_notebook(db) .unwrap_or_else(|error| { tracing::debug!("Failed to read notebook '{path}': {error}"); - has_read_error = true; - SourceDiagnostic(Arc::new(SourceTextError::FailedToReadNotebook(error))) - .accumulate(db); + read_error = Some(SourceTextError::FailedToReadNotebook(error.to_string())); Notebook::empty() }) .into() @@ -35,8 +31,7 @@ pub fn source_text(db: &dyn Db, file: File) -> SourceText { .unwrap_or_else(|error| { tracing::debug!("Failed to read file '{path}': {error}"); - has_read_error = true; - SourceDiagnostic(Arc::new(SourceTextError::FailedToReadFile(error))).accumulate(db); + read_error = Some(SourceTextError::FailedToReadFile(error.to_string())); String::new() }) .into() @@ -45,7 +40,7 @@ pub fn source_text(db: &dyn Db, file: File) -> SourceText { SourceText { inner: Arc::new(SourceTextInner { kind, - has_read_error, + read_error, count: Count::new(), }), } @@ -98,8 +93,8 @@ impl SourceText { } /// Returns `true` if there was an error when reading the content of the file. - pub fn has_read_error(&self) -> bool { - self.inner.has_read_error + pub fn read_error(&self) -> Option<&SourceTextError> { + self.inner.read_error.as_ref() } } @@ -132,13 +127,13 @@ impl std::fmt::Debug for SourceText { struct SourceTextInner { count: Count<SourceText>, kind: SourceTextKind, - has_read_error: bool, + read_error: Option<SourceTextError>, } #[derive(Eq, PartialEq)] enum SourceTextKind { Text(String), - Notebook(Notebook), + Notebook(Box<Notebook>), } impl From<String> for SourceTextKind { @@ -149,31 +144,22 @@ impl From<String> for SourceTextKind { impl From<Notebook> for SourceTextKind { fn from(notebook: Notebook) -> Self { - SourceTextKind::Notebook(notebook) + SourceTextKind::Notebook(Box::new(notebook)) } } -#[salsa::accumulator] -pub struct SourceDiagnostic(Arc<SourceTextError>); - -impl std::fmt::Display for SourceDiagnostic { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - std::fmt::Display::fmt(&self.0, f) - } -} - -#[derive(Debug, thiserror::Error)] +#[derive(Debug, thiserror::Error, PartialEq, Eq, Clone)] pub enum SourceTextError { #[error("Failed to read notebook: {0}`")] - FailedToReadNotebook(#[from] ruff_notebook::NotebookError), + FailedToReadNotebook(String), #[error("Failed to read file: {0}")] - FailedToReadFile(#[from] std::io::Error), + FailedToReadFile(String), } /// Computes the [`LineIndex`] for `file`. #[salsa::tracked] pub fn line_index(db: &dyn Db, file: File) -> LineIndex { - let _span = tracing::trace_span!("line_index", file = ?file).entered(); + let _span = tracing::trace_span!("line_index", ?file).entered(); let source = source_text(db, file); @@ -190,7 +176,7 @@ mod tests { use crate::files::system_path_to_file; use crate::source::{line_index, source_text}; - use crate::system::{DbWithTestSystem, SystemPath}; + use crate::system::{DbWithWritableSystem as _, SystemPath}; use crate::tests::TestDb; #[test] @@ -198,13 +184,13 @@ mod tests { let mut db = TestDb::new(); let path = SystemPath::new("test.py"); - db.write_file(path, "x = 10".to_string())?; + db.write_file(path, "x = 10")?; let file = system_path_to_file(&db, path).unwrap(); assert_eq!(source_text(&db, file).as_str(), "x = 10"); - db.write_file(path, "x = 20".to_string()).unwrap(); + db.write_file(path, "x = 20").unwrap(); assert_eq!(source_text(&db, file).as_str(), "x = 20"); @@ -216,7 +202,7 @@ mod tests { let mut db = TestDb::new(); let path = SystemPath::new("test.py"); - db.write_file(path, "x = 10".to_string())?; + db.write_file(path, "x = 10")?; let file = system_path_to_file(&db, path).unwrap(); @@ -230,9 +216,11 @@ mod tests { let events = db.take_salsa_events(); - assert!(!events - .iter() - .any(|event| matches!(event.kind, EventKind::WillExecute { .. }))); + assert!( + !events + .iter() + .any(|event| matches!(event.kind, EventKind::WillExecute { .. })) + ); Ok(()) } @@ -242,7 +230,7 @@ mod tests { let mut db = TestDb::new(); let path = SystemPath::new("test.py"); - db.write_file(path, "x = 10\ny = 20".to_string())?; + db.write_file(path, "x = 10\ny = 20")?; let file = system_path_to_file(&db, path).unwrap(); let index = line_index(&db, file); diff --git a/crates/ruff_db/src/system.rs b/crates/ruff_db/src/system.rs index 35a916fc47d4c..b4ff1ea439c6b 100644 --- a/crates/ruff_db/src/system.rs +++ b/crates/ruff_db/src/system.rs @@ -1,17 +1,26 @@ -use std::fmt::Debug; - +pub use glob::PatternError; pub use memory_fs::MemoryFileSystem; + +#[cfg(all(feature = "testing", feature = "os"))] +pub use os::testing::UserConfigDirectoryOverrideGuard; + #[cfg(feature = "os")] pub use os::OsSystem; + +use filetime::FileTime; use ruff_notebook::{Notebook, NotebookError}; -pub use test::{DbWithTestSystem, TestSystem}; +use std::error::Error; +use std::fmt::{Debug, Formatter}; +use std::path::{Path, PathBuf}; +use std::{fmt, io}; +pub use test::{DbWithTestSystem, DbWithWritableSystem, InMemorySystem, TestSystem}; use walk_directory::WalkDirectoryBuilder; use crate::file_revision::FileRevision; pub use self::path::{ - deduplicate_nested_paths, DeduplicatedNestedPathsIter, SystemPath, SystemPathBuf, - SystemVirtualPath, SystemVirtualPathBuf, + DeduplicatedNestedPathsIter, SystemPath, SystemPathBuf, SystemVirtualPath, + SystemVirtualPathBuf, deduplicate_nested_paths, }; mod memory_fs; @@ -51,6 +60,10 @@ pub trait System: Debug { /// * `path` does not exist. /// * A non-final component in `path` is not a directory. /// * the symlink target path is not valid Unicode. + /// + /// ## Windows long-paths + /// Unlike `std::fs::canonicalize`, this function does remove UNC prefixes if possible. + /// See [dunce::canonicalize] for more information. fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf>; /// Reads the content of the file at `path` into a [`String`]. @@ -77,21 +90,40 @@ pub trait System: Debug { self.path_metadata(path).is_ok() } + /// Returns `true` if `path` exists on disk using the exact casing as specified in `path` for the parts after `prefix`. + /// + /// This is the same as [`Self::path_exists`] on case-sensitive systems. + /// + /// ## The use of prefix + /// + /// Prefix is only intended as an optimization for systems that can't efficiently check + /// if an entire path exists with the exact casing as specified in `path`. However, + /// implementations are allowed to check the casing of the entire path if they can do so efficiently. + fn path_exists_case_sensitive(&self, path: &SystemPath, prefix: &SystemPath) -> bool; + + /// Returns the [`CaseSensitivity`] of the system's file system. + fn case_sensitivity(&self) -> CaseSensitivity; + /// Returns `true` if `path` exists and is a directory. fn is_directory(&self, path: &SystemPath) -> bool { self.path_metadata(path) - .map_or(false, |metadata| metadata.file_type.is_directory()) + .is_ok_and(|metadata| metadata.file_type.is_directory()) } /// Returns `true` if `path` exists and is a file. fn is_file(&self, path: &SystemPath) -> bool { self.path_metadata(path) - .map_or(false, |metadata| metadata.file_type.is_file()) + .is_ok_and(|metadata| metadata.file_type.is_file()) } /// Returns the current working directory fn current_directory(&self) -> &SystemPath; + /// Returns the directory path where user configurations are stored. + /// + /// Returns `None` if no such convention exists for the system. + fn user_config_directory(&self) -> Option<SystemPathBuf>; + /// Iterate over the contents of the directory at `path`. /// /// The returned iterator must have the following properties: @@ -126,11 +158,66 @@ pub trait System: Debug { /// yields a single entry for that file. fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder; + /// Return an iterator that produces all the `Path`s that match the given + /// pattern using default match options, which may be absolute or relative to + /// the current working directory. + /// + /// This may return an error if the pattern is invalid. + fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + Box<dyn Iterator<Item = std::result::Result<SystemPathBuf, GlobError>> + '_>, + PatternError, + >; + fn as_any(&self) -> &dyn std::any::Any; fn as_any_mut(&mut self) -> &mut dyn std::any::Any; } +#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)] +pub enum CaseSensitivity { + /// The case sensitivity of the file system is unknown. + /// + /// The file system is either case-sensitive or case-insensitive. A caller + /// should not assume either case. + #[default] + Unknown, + + /// The file system is case-sensitive. + CaseSensitive, + + /// The file system is case-insensitive. + CaseInsensitive, +} + +impl CaseSensitivity { + /// Returns `true` if the file system is known to be case-sensitive. + pub const fn is_case_sensitive(self) -> bool { + matches!(self, Self::CaseSensitive) + } +} + +impl fmt::Display for CaseSensitivity { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self { + CaseSensitivity::Unknown => f.write_str("unknown"), + CaseSensitivity::CaseSensitive => f.write_str("case-sensitive"), + CaseSensitivity::CaseInsensitive => f.write_str("case-insensitive"), + } + } +} + +/// System trait for non-readonly systems. +pub trait WritableSystem: System { + /// Writes the given content to the file at the given path. + fn write_file(&self, path: &SystemPath, content: &str) -> Result<()>; + + /// Creates a directory at `path` as well as any intermediate directories. + fn create_directory_all(&self, path: &SystemPath) -> Result<()>; +} + #[derive(Clone, Debug, Eq, PartialEq)] pub struct Metadata { revision: FileRevision, @@ -204,3 +291,83 @@ impl DirectoryEntry { self.file_type } } + +/// A glob iteration error. +/// +/// This is typically returned when a particular path cannot be read +/// to determine if its contents match the glob pattern. This is possible +/// if the program lacks the appropriate permissions, for example. +#[derive(Debug)] +pub struct GlobError { + path: PathBuf, + error: GlobErrorKind, +} + +impl GlobError { + /// The Path that the error corresponds to. + pub fn path(&self) -> &Path { + &self.path + } + + pub fn kind(&self) -> &GlobErrorKind { + &self.error + } +} + +impl Error for GlobError {} + +impl fmt::Display for GlobError { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match &self.error { + GlobErrorKind::IOError(error) => { + write!( + f, + "attempting to read `{}` resulted in an error: {error}", + self.path.display(), + ) + } + GlobErrorKind::NonUtf8Path => { + write!(f, "`{}` is not a valid UTF-8 path", self.path.display(),) + } + } + } +} + +impl From<glob::GlobError> for GlobError { + fn from(value: glob::GlobError) -> Self { + Self { + path: value.path().to_path_buf(), + error: GlobErrorKind::IOError(value.into_error()), + } + } +} + +#[derive(Debug)] +pub enum GlobErrorKind { + IOError(io::Error), + NonUtf8Path, +} + +#[cfg(not(target_arch = "wasm32"))] +pub fn file_time_now() -> FileTime { + FileTime::now() +} + +#[cfg(target_arch = "wasm32")] +pub fn file_time_now() -> FileTime { + // Copied from FileTime::from_system_time() + let time = web_time::SystemTime::now(); + + time.duration_since(web_time::UNIX_EPOCH) + .map(|d| FileTime::from_unix_time(d.as_secs() as i64, d.subsec_nanos())) + .unwrap_or_else(|e| { + let until_epoch = e.duration(); + let (sec_offset, nanos) = if until_epoch.subsec_nanos() == 0 { + (0, 0) + } else { + (-1, 1_000_000_000 - until_epoch.subsec_nanos()) + }; + + FileTime::from_unix_time(-(until_epoch.as_secs() as i64) + sec_offset, nanos) + }) +} diff --git a/crates/ruff_db/src/system/memory_fs.rs b/crates/ruff_db/src/system/memory_fs.rs index 5b584de114697..91587949a7e55 100644 --- a/crates/ruff_db/src/system/memory_fs.rs +++ b/crates/ruff_db/src/system/memory_fs.rs @@ -6,16 +6,14 @@ use camino::{Utf8Path, Utf8PathBuf}; use filetime::FileTime; use rustc_hash::FxHashMap; -use ruff_notebook::{Notebook, NotebookError}; - use crate::system::{ - walk_directory, DirectoryEntry, FileType, Metadata, Result, SystemPath, SystemPathBuf, - SystemVirtualPath, SystemVirtualPathBuf, + DirectoryEntry, FileType, GlobError, GlobErrorKind, Metadata, Result, SystemPath, + SystemPathBuf, SystemVirtualPath, SystemVirtualPathBuf, file_time_now, walk_directory, }; use super::walk_directory::{ - DirectoryWalker, WalkDirectoryBuilder, WalkDirectoryConfiguration, WalkDirectoryVisitor, - WalkDirectoryVisitorBuilder, WalkState, + DirectoryWalker, ErrorKind, WalkDirectoryBuilder, WalkDirectoryConfiguration, + WalkDirectoryVisitor, WalkDirectoryVisitorBuilder, WalkState, }; /// File system that stores all content in memory. @@ -94,8 +92,11 @@ impl MemoryFileSystem { metadata(self, path.as_ref()) } - pub fn canonicalize(&self, path: impl AsRef<SystemPath>) -> SystemPathBuf { - SystemPathBuf::from_utf8_path_buf(self.normalize_path(path)) + pub fn canonicalize(&self, path: impl AsRef<SystemPath>) -> Result<SystemPathBuf> { + let path = path.as_ref(); + // Mimic the behavior of a real FS where canonicalize errors if the `path` doesn't exist + self.metadata(path)?; + Ok(SystemPathBuf::from_utf8_path_buf(self.normalize_path(path))) } pub fn is_file(&self, path: impl AsRef<SystemPath>) -> bool { @@ -128,14 +129,6 @@ impl MemoryFileSystem { read_to_string(self, path.as_ref()) } - pub(crate) fn read_to_notebook( - &self, - path: impl AsRef<SystemPath>, - ) -> std::result::Result<ruff_notebook::Notebook, ruff_notebook::NotebookError> { - let content = self.read_to_string(path)?; - ruff_notebook::Notebook::from_source_code(&content) - } - pub(crate) fn read_virtual_path_to_string( &self, path: impl AsRef<SystemVirtualPath>, @@ -148,14 +141,6 @@ impl MemoryFileSystem { Ok(file.content.clone()) } - pub(crate) fn read_virtual_path_to_notebook( - &self, - path: &SystemVirtualPath, - ) -> std::result::Result<Notebook, NotebookError> { - let content = self.read_virtual_path_to_string(path)?; - ruff_notebook::Notebook::from_source_code(&content) - } - pub fn exists(&self, path: &SystemPath) -> bool { let by_path = self.inner.by_path.read().unwrap(); let normalized = self.normalize_path(path); @@ -168,18 +153,33 @@ impl MemoryFileSystem { virtual_files.contains_key(&path.to_path_buf()) } + /// Stores a new file in the file system. + /// + /// The operation overrides the content for an existing file with the same normalized `path`. + pub fn write_file(&self, path: impl AsRef<SystemPath>, content: impl ToString) -> Result<()> { + let mut by_path = self.inner.by_path.write().unwrap(); + + let normalized = self.normalize_path(path.as_ref()); + + let file = get_or_create_file(&mut by_path, &normalized)?; + file.content = content.to_string(); + file.last_modified = file_time_now(); + + Ok(()) + } + /// Writes the files to the file system. /// /// The operation overrides existing files with the same normalized path. /// /// Enclosing directories are automatically created if they don't exist. - pub fn write_files<P, C>(&self, files: impl IntoIterator<Item = (P, C)>) -> Result<()> + pub fn write_files_all<P, C>(&self, files: impl IntoIterator<Item = (P, C)>) -> Result<()> where P: AsRef<SystemPath>, C: ToString, { for (path, content) in files { - self.write_file(path.as_ref(), content.to_string())?; + self.write_file_all(path.as_ref(), content.to_string())?; } Ok(()) @@ -190,16 +190,18 @@ impl MemoryFileSystem { /// The operation overrides the content for an existing file with the same normalized `path`. /// /// Enclosing directories are automatically created if they don't exist. - pub fn write_file(&self, path: impl AsRef<SystemPath>, content: impl ToString) -> Result<()> { - let mut by_path = self.inner.by_path.write().unwrap(); - - let normalized = self.normalize_path(path.as_ref()); + pub fn write_file_all( + &self, + path: impl AsRef<SystemPath>, + content: impl ToString, + ) -> Result<()> { + let path = path.as_ref(); - let file = get_or_create_file(&mut by_path, &normalized)?; - file.content = content.to_string(); - file.last_modified = now(); + if let Some(parent) = path.parent() { + self.create_directory_all(parent)?; + } - Ok(()) + self.write_file(path, content) } /// Stores a new virtual file in the file system. @@ -213,7 +215,7 @@ impl MemoryFileSystem { std::collections::hash_map::Entry::Vacant(entry) => { entry.insert(File { content: content.to_string(), - last_modified: now(), + last_modified: file_time_now(), }); } std::collections::hash_map::Entry::Occupied(mut entry) => { @@ -230,6 +232,46 @@ impl MemoryFileSystem { WalkDirectoryBuilder::new(path, MemoryWalker { fs: self.clone() }) } + pub fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + impl Iterator<Item = std::result::Result<SystemPathBuf, GlobError>> + '_, + glob::PatternError, + > { + // Very naive implementation that iterates over all files and collects all that match the given pattern. + + let normalized = self.normalize_path(pattern); + let pattern = glob::Pattern::new(normalized.as_str())?; + let matches = std::sync::Mutex::new(Vec::new()); + + self.walk_directory("/").standard_filters(false).run(|| { + Box::new(|entry| { + match entry { + Ok(entry) => { + if pattern.matches_path(entry.path().as_std_path()) { + matches.lock().unwrap().push(Ok(entry.into_path())); + } + } + Err(error) => match error.kind { + ErrorKind::Loop { .. } => { + unreachable!("Loops aren't possible in the memory file system because it doesn't support symlinks.") + } + ErrorKind::Io { err, path } => { + matches.lock().unwrap().push(Err(GlobError { path: path.expect("walk_directory to always set a path").into_std_path_buf(), error: GlobErrorKind::IOError(err)})); + } + ErrorKind::NonUtf8Path { path } => { + matches.lock().unwrap().push(Err(GlobError { path, error: GlobErrorKind::NonUtf8Path})); + } + }, + } + WalkState::Continue + }) + }); + + Ok(matches.into_inner().unwrap().into_iter()) + } + pub fn remove_file(&self, path: impl AsRef<SystemPath>) -> Result<()> { fn remove_file(fs: &MemoryFileSystem, path: &SystemPath) -> Result<()> { let mut by_path = fs.inner.by_path.write().unwrap(); @@ -268,7 +310,7 @@ impl MemoryFileSystem { let mut by_path = self.inner.by_path.write().unwrap(); let normalized = self.normalize_path(path.as_ref()); - get_or_create_file(&mut by_path, &normalized)?.last_modified = now(); + get_or_create_file(&mut by_path, &normalized)?.last_modified = file_time_now(); Ok(()) } @@ -421,17 +463,17 @@ fn not_found() -> std::io::Error { fn is_a_directory() -> std::io::Error { // Note: Rust returns `ErrorKind::IsADirectory` for this error but this is a nightly only variant :(. // So we have to use other for now. - std::io::Error::new(std::io::ErrorKind::Other, "Is a directory") + std::io::Error::other("Is a directory") } fn not_a_directory() -> std::io::Error { // Note: Rust returns `ErrorKind::NotADirectory` for this error but this is a nightly only variant :(. // So we have to use `Other` for now. - std::io::Error::new(std::io::ErrorKind::Other, "Not a directory") + std::io::Error::other("Not a directory") } fn directory_not_empty() -> std::io::Error { - std::io::Error::new(std::io::ErrorKind::Other, "directory not empty") + std::io::Error::other("directory not empty") } fn create_dir_all( @@ -444,7 +486,7 @@ fn create_dir_all( path.push(component); let entry = paths.entry(path.clone()).or_insert_with(|| { Entry::Directory(Directory { - last_modified: now(), + last_modified: file_time_now(), }) }); @@ -461,13 +503,17 @@ fn get_or_create_file<'a>( normalized: &Utf8Path, ) -> Result<&'a mut File> { if let Some(parent) = normalized.parent() { - create_dir_all(paths, parent)?; + let parent_entry = paths.get(parent).ok_or_else(not_found)?; + + if parent_entry.is_file() { + return Err(not_a_directory()); + } } let entry = paths.entry(normalized.to_path_buf()).or_insert_with(|| { Entry::File(File { content: String::new(), - last_modified: now(), + last_modified: file_time_now(), }) }); @@ -629,7 +675,7 @@ impl DirectoryWalker for MemoryWalker { visitor.visit(Err(walk_directory::Error { depth: Some(depth), kind: walk_directory::ErrorKind::Io { - path: None, + path: Some(path.clone()), err: error, }, })); @@ -649,37 +695,14 @@ enum WalkerState { Nested { path: SystemPathBuf, depth: usize }, } -#[cfg(not(target_arch = "wasm32"))] -fn now() -> FileTime { - FileTime::now() -} - -#[cfg(target_arch = "wasm32")] -fn now() -> FileTime { - // Copied from FileTime::from_system_time() - let time = web_time::SystemTime::now(); - - time.duration_since(web_time::UNIX_EPOCH) - .map(|d| FileTime::from_unix_time(d.as_secs() as i64, d.subsec_nanos())) - .unwrap_or_else(|e| { - let until_epoch = e.duration(); - let (sec_offset, nanos) = if until_epoch.subsec_nanos() == 0 { - (0, 0) - } else { - (-1, 1_000_000_000 - until_epoch.subsec_nanos()) - }; - - FileTime::from_unix_time(-(until_epoch.as_secs() as i64) + sec_offset, nanos) - }) -} - #[cfg(test)] mod tests { use std::io::ErrorKind; + use std::time::Duration; - use crate::system::walk_directory::tests::DirectoryEntryToString; use crate::system::walk_directory::WalkState; + use crate::system::walk_directory::tests::DirectoryEntryToString; use crate::system::{ DirectoryEntry, FileType, MemoryFileSystem, Result, SystemPath, SystemPathBuf, SystemVirtualPath, @@ -693,7 +716,7 @@ mod tests { P: AsRef<SystemPath>, { let fs = MemoryFileSystem::new(); - fs.write_files(files.into_iter().map(|path| (path, ""))) + fs.write_files_all(files.into_iter().map(|path| (path, ""))) .unwrap(); fs @@ -796,29 +819,25 @@ mod tests { } #[test] - fn write_file_fails_if_a_component_is_a_file() { - let fs = with_files(["a/b.py"]); + fn write_file_fails_if_a_parent_directory_is_missing() { + let fs = with_files(["c.py"]); let error = fs - .write_file(SystemPath::new("a/b.py/c"), "content".to_string()) + .write_file(SystemPath::new("a/b.py"), "content".to_string()) .unwrap_err(); - assert_eq!(error.kind(), ErrorKind::Other); + assert_eq!(error.kind(), ErrorKind::NotFound); } #[test] - fn write_file_fails_if_path_points_to_a_directory() -> Result<()> { - let fs = MemoryFileSystem::new(); - - fs.create_directory_all("a")?; + fn write_file_all_fails_if_a_component_is_a_file() { + let fs = with_files(["a/b.py"]); let error = fs - .write_file(SystemPath::new("a"), "content".to_string()) + .write_file_all(SystemPath::new("a/b.py/c"), "content".to_string()) .unwrap_err(); assert_eq!(error.kind(), ErrorKind::Other); - - Ok(()) } #[test] @@ -838,7 +857,7 @@ mod tests { let fs = MemoryFileSystem::new(); let path = SystemPath::new("a.py"); - fs.write_file(path, "Test content".to_string())?; + fs.write_file_all(path, "Test content".to_string())?; assert_eq!(fs.read_to_string(path)?, "Test content"); @@ -869,6 +888,21 @@ mod tests { Ok(()) } + #[test] + fn write_file_fails_if_path_points_to_a_directory() -> Result<()> { + let fs = MemoryFileSystem::new(); + + fs.create_directory_all("a")?; + + let error = fs + .write_file(SystemPath::new("a"), "content".to_string()) + .unwrap_err(); + + assert_eq!(error.kind(), ErrorKind::Other); + + Ok(()) + } + #[test] fn read_fails_if_virtual_path_doesnt_exit() { let fs = MemoryFileSystem::new(); @@ -1020,7 +1054,7 @@ mod tests { let root = SystemPath::new("/src"); let system = MemoryFileSystem::with_current_directory(root); - system.write_files([ + system.write_files_all([ (root.join("foo.py"), "print('foo')"), (root.join("a/bar.py"), "print('bar')"), (root.join("a/baz.py"), "print('baz')"), @@ -1079,7 +1113,7 @@ mod tests { let root = SystemPath::new("/src"); let system = MemoryFileSystem::with_current_directory(root); - system.write_files([ + system.write_files_all([ (root.join("foo.py"), "print('foo')"), (root.join("a/bar.py"), "print('bar')"), (root.join("a/.baz.py"), "print('baz')"), @@ -1125,7 +1159,7 @@ mod tests { let root = SystemPath::new("/src"); let system = MemoryFileSystem::with_current_directory(root); - system.write_file(root.join("foo.py"), "print('foo')")?; + system.write_file_all(root.join("foo.py"), "print('foo')")?; let writer = DirectoryEntryToString::new(root.to_path_buf()); @@ -1149,4 +1183,26 @@ mod tests { Ok(()) } + + #[test] + fn glob() -> std::io::Result<()> { + let root = SystemPath::new("/src"); + let fs = MemoryFileSystem::with_current_directory(root); + + fs.write_files_all([ + (root.join("foo.py"), "print('foo')"), + (root.join("a/bar.py"), "print('bar')"), + (root.join("a/.baz.py"), "print('baz')"), + ])?; + + let mut matches = fs.glob("/src/a/**").unwrap().flatten().collect::<Vec<_>>(); + matches.sort_unstable(); + + assert_eq!(matches, vec![root.join("a/.baz.py"), root.join("a/bar.py")]); + + let matches = fs.glob("**/bar.py").unwrap().flatten().collect::<Vec<_>>(); + assert_eq!(matches, vec![root.join("a/bar.py")]); + + Ok(()) + } } diff --git a/crates/ruff_db/src/system/os.rs b/crates/ruff_db/src/system/os.rs index 6652c4a383db5..3d5c905c94492 100644 --- a/crates/ruff_db/src/system/os.rs +++ b/crates/ruff_db/src/system/os.rs @@ -1,22 +1,22 @@ -use std::sync::Arc; -use std::{any::Any, path::PathBuf}; - -use filetime::FileTime; - -use ruff_notebook::{Notebook, NotebookError}; - -use crate::system::{ - DirectoryEntry, FileType, Metadata, Result, System, SystemPath, SystemPathBuf, - SystemVirtualPath, -}; - use super::walk_directory::{ self, DirectoryWalker, WalkDirectoryBuilder, WalkDirectoryConfiguration, WalkDirectoryVisitorBuilder, WalkState, }; +use crate::max_parallelism; +use crate::system::{ + CaseSensitivity, DirectoryEntry, FileType, GlobError, GlobErrorKind, Metadata, Result, System, + SystemPath, SystemPathBuf, SystemVirtualPath, WritableSystem, +}; +use filetime::FileTime; +use ruff_notebook::{Notebook, NotebookError}; +use rustc_hash::FxHashSet; +use std::num::NonZeroUsize; +use std::panic::RefUnwindSafe; +use std::sync::Arc; +use std::{any::Any, path::PathBuf}; /// A system implementation that uses the OS file system. -#[derive(Default, Debug, Clone)] +#[derive(Debug, Clone)] pub struct OsSystem { inner: Arc<OsSystemInner>, } @@ -24,6 +24,15 @@ pub struct OsSystem { #[derive(Default, Debug)] struct OsSystemInner { cwd: SystemPathBuf, + + real_case_cache: CaseSensitivePathsCache, + + case_sensitivity: CaseSensitivity, + + /// Overrides the user's configuration directory for testing. + /// This is an `Option<Option<..>>` to allow setting an override of `None`. + #[cfg(feature = "testing")] + user_config_directory_override: std::sync::Mutex<Option<Option<SystemPathBuf>>>, } impl OsSystem { @@ -31,9 +40,20 @@ impl OsSystem { let cwd = cwd.as_ref(); assert!(cwd.as_utf8_path().is_absolute()); + let case_sensitivity = detect_case_sensitivity(cwd); + + tracing::debug!( + "Architecture: {}, OS: {}, case-sensitive: {case_sensitivity}", + std::env::consts::ARCH, + std::env::consts::OS, + ); + Self { + // Spreading `..Default` because it isn't possible to feature gate the initializer of a single field. inner: Arc::new(OsSystemInner { cwd: cwd.to_path_buf(), + case_sensitivity, + ..Default::default() }), } } @@ -64,9 +84,11 @@ impl System for OsSystem { } fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf> { - path.as_utf8_path() - .canonicalize_utf8() - .map(SystemPathBuf::from_utf8_path_buf) + path.as_utf8_path().canonicalize_utf8().map(|path| { + SystemPathBuf::from_utf8_path_buf(path) + .simplified() + .to_path_buf() + }) } fn read_to_string(&self, path: &SystemPath) -> Result<String> { @@ -92,10 +114,52 @@ impl System for OsSystem { path.as_std_path().exists() } + fn path_exists_case_sensitive(&self, path: &SystemPath, prefix: &SystemPath) -> bool { + if self.case_sensitivity().is_case_sensitive() { + self.path_exists(path) + } else { + self.path_exists_case_sensitive_fast(path) + .unwrap_or_else(|| self.path_exists_case_sensitive_slow(path, prefix)) + } + } + + fn case_sensitivity(&self) -> CaseSensitivity { + self.inner.case_sensitivity + } + fn current_directory(&self) -> &SystemPath { &self.inner.cwd } + #[cfg(not(target_arch = "wasm32"))] + fn user_config_directory(&self) -> Option<SystemPathBuf> { + // In testing, we allow overriding the user configuration directory by using a + // thread local because overriding the environment variables breaks test isolation + // (tests run concurrently) and mutating environment variable in a multithreaded + // application is inherently unsafe. + #[cfg(feature = "testing")] + if let Ok(directory_override) = self.try_get_user_config_directory_override() { + return directory_override; + } + + use etcetera::BaseStrategy as _; + + let strategy = etcetera::base_strategy::choose_base_strategy().ok()?; + SystemPathBuf::from_path_buf(strategy.config_dir()).ok() + } + + // TODO: Remove this feature gating once `ruff_wasm` no longer indirectly depends on `ruff_db` with the + // `os` feature enabled (via `ruff_workspace` -> `ruff_graph` -> `ruff_db`). + #[cfg(target_arch = "wasm32")] + fn user_config_directory(&self) -> Option<SystemPathBuf> { + #[cfg(feature = "testing")] + if let Ok(directory_override) = self.try_get_user_config_directory_override() { + return directory_override; + } + + None + } + /// Creates a builder to recursively walk `path`. /// /// The walker ignores files according to [`ignore::WalkBuilder::standard_filters`] @@ -104,6 +168,30 @@ impl System for OsSystem { WalkDirectoryBuilder::new(path, OsDirectoryWalker {}) } + fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + Box<dyn Iterator<Item = std::result::Result<SystemPathBuf, GlobError>>>, + glob::PatternError, + > { + glob::glob(pattern).map(|inner| { + let iterator = inner.map(|result| { + let path = result?; + + let system_path = SystemPathBuf::from_path_buf(path).map_err(|path| GlobError { + path, + error: GlobErrorKind::NonUtf8Path, + })?; + + Ok(system_path) + }); + + let boxed: Box<dyn Iterator<Item = _>> = Box::new(iterator); + boxed + }) + } + fn as_any(&self) -> &dyn Any { self } @@ -128,6 +216,192 @@ impl System for OsSystem { } } +impl OsSystem { + /// Path sensitive testing if a path exists by canonicalization the path and comparing it with `path`. + /// + /// This is faster than the slow path, because it requires a single system call for each path + /// instead of at least one system call for each component between `path` and `prefix`. + /// + /// However, using `canonicalize` to resolve the path's casing doesn't work in two cases: + /// * if `path` is a symlink because `canonicalize` then returns the symlink's target and not the symlink's source path. + /// * on Windows: If `path` is a mapped network drive because `canonicalize` then returns the UNC path + /// (e.g. `Z:\` is mapped to `\\server\share` and `canonicalize` then returns `\\?\UNC\server\share`). + /// + /// Symlinks and mapped network drives should be rare enough that this fast path is worth trying first, + /// even if it comes at a cost for those rare use cases. + fn path_exists_case_sensitive_fast(&self, path: &SystemPath) -> Option<bool> { + // This is a more forgiving version of `dunce::simplified` that removes all `\\?\` prefixes on Windows. + // We use this more forgiving version because we don't intend on using either path for anything other than comparison + // and the prefix is only relevant when passing the path to other programs and its longer than 200 something + // characters. + fn simplify_ignore_verbatim(path: &SystemPath) -> &SystemPath { + if cfg!(windows) { + if path.as_utf8_path().as_str().starts_with(r"\\?\") { + SystemPath::new(&path.as_utf8_path().as_str()[r"\\?\".len()..]) + } else { + path + } + } else { + path + } + } + + let simplified = simplify_ignore_verbatim(path); + + let Ok(canonicalized) = simplified.as_std_path().canonicalize() else { + // The path doesn't exist or can't be accessed. The path doesn't exist. + return Some(false); + }; + + let Ok(canonicalized) = SystemPathBuf::from_path_buf(canonicalized) else { + // The original path is valid UTF8 but the canonicalized path isn't. This definitely suggests + // that a symlink is involved. Fall back to the slow path. + tracing::debug!( + "Falling back to the slow case-sensitive path existence check because the canonicalized path of `{simplified}` is not valid UTF-8" + ); + return None; + }; + + let simplified_canonicalized = simplify_ignore_verbatim(&canonicalized); + + // Test if the paths differ by anything other than casing. If so, that suggests that + // `path` pointed to a symlink (or some other none reversible path normalization happened). + // In this case, fall back to the slow path. + if simplified_canonicalized.as_str().to_lowercase() != simplified.as_str().to_lowercase() { + tracing::debug!( + "Falling back to the slow case-sensitive path existence check for `{simplified}` because the canonicalized path `{simplified_canonicalized}` differs not only by casing" + ); + return None; + } + + // If there are no symlinks involved, then `path` exists only if it is the same as the canonicalized path. + Some(simplified_canonicalized == simplified) + } + + fn path_exists_case_sensitive_slow(&self, path: &SystemPath, prefix: &SystemPath) -> bool { + // Iterate over the sub-paths up to prefix and check if they match the casing as on disk. + for ancestor in path.ancestors() { + if ancestor == prefix { + break; + } + + match self.inner.real_case_cache.has_name_case(ancestor) { + Ok(true) => { + // Component has correct casing, continue with next component + } + Ok(false) => { + // Component has incorrect casing + return false; + } + Err(_) => { + // Directory doesn't exist or can't be accessed. We can assume that the file with + // the given casing doesn't exist. + return false; + } + } + } + + true + } +} + +impl WritableSystem for OsSystem { + fn write_file(&self, path: &SystemPath, content: &str) -> Result<()> { + std::fs::write(path.as_std_path(), content) + } + + fn create_directory_all(&self, path: &SystemPath) -> Result<()> { + std::fs::create_dir_all(path.as_std_path()) + } +} + +impl Default for OsSystem { + fn default() -> Self { + Self::new( + SystemPathBuf::from_path_buf(std::env::current_dir().unwrap_or_default()) + .unwrap_or_default(), + ) + } +} + +#[derive(Debug, Default)] +struct CaseSensitivePathsCache { + by_lower_case: dashmap::DashMap<SystemPathBuf, ListedDirectory>, +} + +impl CaseSensitivePathsCache { + /// Test if `path`'s file name uses the exact same casing as the file on disk. + /// + /// Returns `false` if the file doesn't exist. + /// + /// Components other than the file portion are ignored. + fn has_name_case(&self, path: &SystemPath) -> Result<bool> { + let Some(parent) = path.parent() else { + // The root path is always considered to exist. + return Ok(true); + }; + + let Some(file_name) = path.file_name() else { + // We can only get here for paths ending in `..` or the root path. Root paths are handled above. + // Return `true` for paths ending in `..` because `..` is the same regardless of casing. + return Ok(true); + }; + + let lower_case_path = SystemPathBuf::from(parent.as_str().to_lowercase()); + let last_modification_time = + FileTime::from_last_modification_time(&parent.as_std_path().metadata()?); + + let entry = self.by_lower_case.entry(lower_case_path); + + if let dashmap::Entry::Occupied(entry) = &entry { + // Only do a cached lookup if the directory hasn't changed. + if entry.get().last_modification_time == last_modification_time { + tracing::trace!("Use cached case-sensitive entry for directory `{}`", parent); + return Ok(entry.get().names.contains(file_name)); + } + } + + tracing::trace!( + "Reading directory `{}` for its case-sensitive filenames", + parent + ); + let start = std::time::Instant::now(); + let mut names = FxHashSet::default(); + + for entry in parent.as_std_path().read_dir()? { + let Ok(entry) = entry else { + continue; + }; + + let Ok(name) = entry.file_name().into_string() else { + continue; + }; + + names.insert(name.into_boxed_str()); + } + + let directory = entry.insert(ListedDirectory { + last_modification_time, + names, + }); + + tracing::debug!( + "Caching the case-sensitive paths for directory `{parent}` took {:?}", + start.elapsed() + ); + + Ok(directory.names.contains(file_name)) + } +} + +impl RefUnwindSafe for CaseSensitivePathsCache {} + +#[derive(Debug, Eq, PartialEq)] +struct ListedDirectory { + last_modification_time: FileTime, + names: FxHashSet<Box<str>>, +} + #[derive(Debug)] struct OsDirectoryWalker; @@ -156,11 +430,7 @@ impl DirectoryWalker for OsDirectoryWalker { builder.add(additional_path.as_std_path()); } - builder.threads( - std::thread::available_parallelism() - .map_or(1, std::num::NonZeroUsize::get) - .min(12), - ); + builder.threads(max_parallelism().min(NonZeroUsize::new(12).unwrap()).get()); builder.build_parallel().run(|| { let mut visitor = visitor_builder.build(); @@ -295,12 +565,109 @@ fn not_found() -> std::io::Error { std::io::Error::new(std::io::ErrorKind::NotFound, "No such file or directory") } +#[cfg(feature = "testing")] +pub(super) mod testing { + + use crate::system::{OsSystem, SystemPathBuf}; + + impl OsSystem { + /// Overrides the user configuration directory for the current scope + /// (for as long as the returned override is not dropped). + pub fn with_user_config_directory( + &self, + directory: Option<SystemPathBuf>, + ) -> UserConfigDirectoryOverrideGuard { + let mut directory_override = self.inner.user_config_directory_override.lock().unwrap(); + let previous = directory_override.replace(directory); + + UserConfigDirectoryOverrideGuard { + previous, + system: self.clone(), + } + } + + /// Returns [`Ok`] if any override is set and [`Err`] otherwise. + pub(super) fn try_get_user_config_directory_override( + &self, + ) -> Result<Option<SystemPathBuf>, ()> { + let directory_override = self.inner.user_config_directory_override.lock().unwrap(); + match directory_override.as_ref() { + Some(directory_override) => Ok(directory_override.clone()), + None => Err(()), + } + } + } + + /// A scoped override of the [user's configuration directory](crate::System::user_config_directory) for the [`OsSystem`]. + /// + /// Prefer overriding the user's configuration directory for tests that require + /// spawning a new process (e.g. CLI tests) by setting the `APPDATA` (windows) + /// or `XDG_CONFIG_HOME` (unix and other platforms) environment variables. + /// For example, by setting the environment variables when invoking the CLI with insta. + /// + /// Requires the `testing` feature. + #[must_use] + pub struct UserConfigDirectoryOverrideGuard { + previous: Option<Option<SystemPathBuf>>, + system: OsSystem, + } + + impl Drop for UserConfigDirectoryOverrideGuard { + fn drop(&mut self) { + if let Ok(mut directory_override) = + self.system.inner.user_config_directory_override.try_lock() + { + *directory_override = self.previous.take(); + } + } + } +} + +#[cfg(not(unix))] +fn detect_case_sensitivity(_path: &SystemPath) -> CaseSensitivity { + // 99% of windows systems aren't case sensitive Don't bother checking. + CaseSensitivity::Unknown +} + +#[cfg(unix)] +fn detect_case_sensitivity(path: &SystemPath) -> CaseSensitivity { + use std::os::unix::fs::MetadataExt; + + let Ok(original_case_metadata) = path.as_std_path().metadata() else { + return CaseSensitivity::Unknown; + }; + + let upper_case = SystemPathBuf::from(path.as_str().to_uppercase()); + if &*upper_case == path { + return CaseSensitivity::Unknown; + } + + match upper_case.as_std_path().metadata() { + Ok(uppercase_meta) => { + // The file system is case insensitive if the upper case and mixed case paths have the same inode. + if uppercase_meta.ino() == original_case_metadata.ino() { + CaseSensitivity::CaseInsensitive + } else { + CaseSensitivity::CaseSensitive + } + } + // In the error case, the file system is case sensitive if the file in all upper case doesn't exist. + Err(error) => { + if error.kind() == std::io::ErrorKind::NotFound { + CaseSensitivity::CaseSensitive + } else { + CaseSensitivity::Unknown + } + } + } +} + #[cfg(test)] mod tests { use tempfile::TempDir; - use crate::system::walk_directory::tests::DirectoryEntryToString; use crate::system::DirectoryEntry; + use crate::system::walk_directory::tests::DirectoryEntryToString; use super::*; diff --git a/crates/ruff_db/src/system/path.rs b/crates/ruff_db/src/system/path.rs index 25cc854c4397b..4aea0cbe8b641 100644 --- a/crates/ruff_db/src/system/path.rs +++ b/crates/ruff_db/src/system/path.rs @@ -1,12 +1,8 @@ -// TODO support untitled files for the LSP use case. Wrap a `str` and `String` -// The main question is how `as_std_path` would work for untitled files, that can only exist in the LSP case -// but there's no compile time guarantee that a [`OsSystem`] never gets an untitled file path. - use camino::{Utf8Path, Utf8PathBuf}; use std::borrow::Borrow; use std::fmt::Formatter; use std::ops::Deref; -use std::path::{Path, StripPrefixError}; +use std::path::{Path, PathBuf, StripPrefixError}; /// A slice of a path on [`System`](super::System) (akin to [`str`]). /// @@ -23,6 +19,32 @@ impl SystemPath { unsafe { &*(path as *const Utf8Path as *const SystemPath) } } + /// Takes any path, and when possible, converts Windows UNC paths to regular paths. + /// If the path can't be converted, it's returned unmodified. + /// + /// On non-Windows this is no-op. + /// + /// `\\?\C:\Windows` will be converted to `C:\Windows`, + /// but `\\?\C:\COM` will be left as-is (due to a reserved filename). + /// + /// Use this to pass arbitrary paths to programs that may not be UNC-aware. + /// + /// It's generally safe to pass UNC paths to legacy programs, because + /// these paths contain a reserved prefix, so will gracefully fail + /// if used with legacy APIs that don't support UNC. + /// + /// This function does not perform any I/O. + /// + /// Currently paths with unpaired surrogates aren't converted even if they + /// could be, due to limitations of Rust's `OsStr` API. + /// + /// To check if a path remained as UNC, use `path.as_os_str().as_encoded_bytes().starts_with(b"\\\\")`. + #[inline] + pub fn simplified(&self) -> &SystemPath { + // SAFETY: simplified only trims the path, that means the returned path must be a valid UTF-8 path. + SystemPath::from_std_path(dunce::simplified(self.as_std_path())).unwrap() + } + /// Extracts the file extension, if possible. /// /// The extension is: @@ -123,6 +145,39 @@ impl SystemPath { self.0.parent().map(SystemPath::new) } + /// Produces an iterator over `SystemPath` and its ancestors. + /// + /// The iterator will yield the `SystemPath` that is returned if the [`parent`] method is used zero + /// or more times. That means, the iterator will yield `&self`, `&self.parent().unwrap()`, + /// `&self.parent().unwrap().parent().unwrap()` and so on. If the [`parent`] method returns + /// [`None`], the iterator will do likewise. The iterator will always yield at least one value, + /// namely `&self`. + /// + /// # Examples + /// + /// ``` + /// use ruff_db::system::SystemPath; + /// + /// let mut ancestors = SystemPath::new("/foo/bar").ancestors(); + /// assert_eq!(ancestors.next(), Some(SystemPath::new("/foo/bar"))); + /// assert_eq!(ancestors.next(), Some(SystemPath::new("/foo"))); + /// assert_eq!(ancestors.next(), Some(SystemPath::new("/"))); + /// assert_eq!(ancestors.next(), None); + /// + /// let mut ancestors = SystemPath::new("../foo/bar").ancestors(); + /// assert_eq!(ancestors.next(), Some(SystemPath::new("../foo/bar"))); + /// assert_eq!(ancestors.next(), Some(SystemPath::new("../foo"))); + /// assert_eq!(ancestors.next(), Some(SystemPath::new(".."))); + /// assert_eq!(ancestors.next(), Some(SystemPath::new(""))); + /// assert_eq!(ancestors.next(), None); + /// ``` + /// + /// [`parent`]: SystemPath::parent + #[inline] + pub fn ancestors(&self) -> impl Iterator<Item = &SystemPath> { + self.0.ancestors().map(SystemPath::new) + } + /// Produces an iterator over the [`camino::Utf8Component`]s of the path. /// /// When parsing the path, there is a small amount of normalization: @@ -416,7 +471,13 @@ impl ToOwned for SystemPath { /// The path is guaranteed to be valid UTF-8. #[repr(transparent)] #[derive(Eq, PartialEq, Clone, Hash, PartialOrd, Ord)] -pub struct SystemPathBuf(Utf8PathBuf); +#[cfg_attr( + feature = "serde", + derive(serde::Serialize, serde::Deserialize), + serde(transparent) +)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct SystemPathBuf(#[cfg_attr(feature = "schemars", schemars(with = "String"))] Utf8PathBuf); impl SystemPathBuf { pub fn new() -> Self { @@ -473,6 +534,10 @@ impl SystemPathBuf { self.0 } + pub fn into_std_path_buf(self) -> PathBuf { + self.0.into_std_path_buf() + } + #[inline] pub fn as_path(&self) -> &SystemPath { SystemPath::new(&self.0) @@ -491,6 +556,12 @@ impl From<&str> for SystemPathBuf { } } +impl From<String> for SystemPathBuf { + fn from(value: String) -> Self { + SystemPathBuf::from_utf8_path_buf(Utf8PathBuf::from(value)) + } +} + impl Default for SystemPathBuf { fn default() -> Self { Self::new() @@ -593,27 +664,6 @@ impl ruff_cache::CacheKey for SystemPathBuf { } } -#[cfg(feature = "serde")] -impl serde::Serialize for SystemPath { - fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> { - self.0.serialize(serializer) - } -} - -#[cfg(feature = "serde")] -impl serde::Serialize for SystemPathBuf { - fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> { - self.0.serialize(serializer) - } -} - -#[cfg(feature = "serde")] -impl<'de> serde::Deserialize<'de> for SystemPathBuf { - fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> { - Utf8PathBuf::deserialize(deserializer).map(SystemPathBuf) - } -} - /// A slice of a virtual path on [`System`](super::System) (akin to [`str`]). #[repr(transparent)] pub struct SystemVirtualPath(str); diff --git a/crates/ruff_db/src/system/test.rs b/crates/ruff_db/src/system/test.rs index 2b8ecdfc29b64..943469127c92f 100644 --- a/crates/ruff_db/src/system/test.rs +++ b/crates/ruff_db/src/system/test.rs @@ -1,17 +1,16 @@ -use std::any::Any; -use std::panic::RefUnwindSafe; -use std::sync::Arc; - +use glob::PatternError; use ruff_notebook::{Notebook, NotebookError}; -use ruff_python_trivia::textwrap; +use std::panic::RefUnwindSafe; +use std::sync::{Arc, Mutex}; +use crate::Db; use crate::files::File; use crate::system::{ - DirectoryEntry, MemoryFileSystem, Metadata, Result, System, SystemPath, SystemPathBuf, - SystemVirtualPath, + CaseSensitivity, DirectoryEntry, GlobError, MemoryFileSystem, Metadata, Result, System, + SystemPath, SystemPathBuf, SystemVirtualPath, }; -use crate::Db; +use super::WritableSystem; use super::walk_directory::WalkDirectoryBuilder; /// System implementation intended for testing. @@ -21,185 +20,192 @@ use super::walk_directory::WalkDirectoryBuilder; /// /// ## Warning /// Don't use this system for production code. It's intended for testing only. -#[derive(Default, Debug)] +#[derive(Debug, Clone)] pub struct TestSystem { - inner: TestSystemInner, + inner: Arc<dyn WritableSystem + RefUnwindSafe + Send + Sync>, } impl TestSystem { + pub fn new(inner: impl WritableSystem + RefUnwindSafe + Send + Sync + 'static) -> Self { + Self { + inner: Arc::new(inner), + } + } + + /// Returns the [`InMemorySystem`]. + /// + /// ## Panics + /// If the underlying test system isn't the [`InMemorySystem`]. + pub fn in_memory(&self) -> &InMemorySystem { + self.as_in_memory() + .expect("The test db is not using a memory file system") + } + + /// Returns the `InMemorySystem` or `None` if the underlying test system isn't the [`InMemorySystem`]. + pub fn as_in_memory(&self) -> Option<&InMemorySystem> { + self.system().as_any().downcast_ref::<InMemorySystem>() + } + /// Returns the memory file system. /// /// ## Panics - /// If this test db isn't using a memory file system. + /// If the underlying test system isn't the [`InMemorySystem`]. pub fn memory_file_system(&self) -> &MemoryFileSystem { - if let TestSystemInner::Stub(fs) = &self.inner { - fs - } else { - panic!("The test db is not using a memory file system"); - } + self.in_memory().fs() } fn use_system<S>(&mut self, system: S) where - S: System + Send + Sync + RefUnwindSafe + 'static, + S: WritableSystem + Send + Sync + RefUnwindSafe + 'static, { - self.inner = TestSystemInner::System(Arc::new(system)); + self.inner = Arc::new(system); + } + + pub fn system(&self) -> &dyn WritableSystem { + &*self.inner } } impl System for TestSystem { - fn path_metadata(&self, path: &SystemPath) -> crate::system::Result<Metadata> { - match &self.inner { - TestSystemInner::Stub(fs) => fs.metadata(path), - TestSystemInner::System(system) => system.path_metadata(path), - } + fn path_metadata(&self, path: &SystemPath) -> Result<Metadata> { + self.system().path_metadata(path) } - fn read_to_string(&self, path: &SystemPath) -> crate::system::Result<String> { - match &self.inner { - TestSystemInner::Stub(fs) => fs.read_to_string(path), - TestSystemInner::System(system) => system.read_to_string(path), - } + fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf> { + self.system().canonicalize_path(path) + } + + fn read_to_string(&self, path: &SystemPath) -> Result<String> { + self.system().read_to_string(path) } fn read_to_notebook(&self, path: &SystemPath) -> std::result::Result<Notebook, NotebookError> { - match &self.inner { - TestSystemInner::Stub(fs) => fs.read_to_notebook(path), - TestSystemInner::System(system) => system.read_to_notebook(path), - } + self.system().read_to_notebook(path) } fn read_virtual_path_to_string(&self, path: &SystemVirtualPath) -> Result<String> { - match &self.inner { - TestSystemInner::Stub(fs) => fs.read_virtual_path_to_string(path), - TestSystemInner::System(system) => system.read_virtual_path_to_string(path), - } + self.system().read_virtual_path_to_string(path) } fn read_virtual_path_to_notebook( &self, path: &SystemVirtualPath, ) -> std::result::Result<Notebook, NotebookError> { - match &self.inner { - TestSystemInner::Stub(fs) => fs.read_virtual_path_to_notebook(path), - TestSystemInner::System(system) => system.read_virtual_path_to_notebook(path), - } + self.system().read_virtual_path_to_notebook(path) } - fn path_exists(&self, path: &SystemPath) -> bool { - match &self.inner { - TestSystemInner::Stub(fs) => fs.exists(path), - TestSystemInner::System(system) => system.path_exists(path), - } + fn current_directory(&self) -> &SystemPath { + self.system().current_directory() } - fn is_directory(&self, path: &SystemPath) -> bool { - match &self.inner { - TestSystemInner::Stub(fs) => fs.is_directory(path), - TestSystemInner::System(system) => system.is_directory(path), - } + fn user_config_directory(&self) -> Option<SystemPathBuf> { + self.system().user_config_directory() } - fn is_file(&self, path: &SystemPath) -> bool { - match &self.inner { - TestSystemInner::Stub(fs) => fs.is_file(path), - TestSystemInner::System(system) => system.is_file(path), - } + fn read_directory<'a>( + &'a self, + path: &SystemPath, + ) -> Result<Box<dyn Iterator<Item = Result<DirectoryEntry>> + 'a>> { + self.system().read_directory(path) } - fn current_directory(&self) -> &SystemPath { - match &self.inner { - TestSystemInner::Stub(fs) => fs.current_directory(), - TestSystemInner::System(system) => system.current_directory(), - } + fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder { + self.system().walk_directory(path) } - fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder { - match &self.inner { - TestSystemInner::Stub(fs) => fs.walk_directory(path), - TestSystemInner::System(system) => system.walk_directory(path), - } + fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + Box<dyn Iterator<Item = std::result::Result<SystemPathBuf, GlobError>> + '_>, + PatternError, + > { + self.system().glob(pattern) } - fn as_any(&self) -> &dyn Any { + fn as_any(&self) -> &dyn std::any::Any { self } - fn as_any_mut(&mut self) -> &mut dyn Any { + fn as_any_mut(&mut self) -> &mut dyn std::any::Any { self } - fn read_directory<'a>( - &'a self, - path: &SystemPath, - ) -> Result<Box<dyn Iterator<Item = Result<DirectoryEntry>> + 'a>> { - match &self.inner { - TestSystemInner::System(fs) => fs.read_directory(path), - TestSystemInner::Stub(fs) => Ok(Box::new(fs.read_directory(path)?)), - } + fn path_exists_case_sensitive(&self, path: &SystemPath, prefix: &SystemPath) -> bool { + self.system().path_exists_case_sensitive(path, prefix) } - fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf> { - match &self.inner { - TestSystemInner::System(fs) => fs.canonicalize_path(path), - TestSystemInner::Stub(fs) => Ok(fs.canonicalize(path)), + fn case_sensitivity(&self) -> CaseSensitivity { + self.system().case_sensitivity() + } +} + +impl Default for TestSystem { + fn default() -> Self { + Self { + inner: Arc::new(InMemorySystem::default()), } } } -/// Extension trait for databases that use [`TestSystem`]. +impl WritableSystem for TestSystem { + fn write_file(&self, path: &SystemPath, content: &str) -> Result<()> { + self.system().write_file(path, content) + } + + fn create_directory_all(&self, path: &SystemPath) -> Result<()> { + self.system().create_directory_all(path) + } +} + +/// Extension trait for databases that use a [`WritableSystem`]. /// /// Provides various helper function that ease testing. -pub trait DbWithTestSystem: Db + Sized { - fn test_system(&self) -> &TestSystem; +pub trait DbWithWritableSystem: Db + Sized { + type System: WritableSystem; - fn test_system_mut(&mut self) -> &mut TestSystem; + fn writable_system(&self) -> &Self::System; /// Writes the content of the given file and notifies the Db about the change. - /// - /// # Panics - /// If the system isn't using the memory file system. - fn write_file( - &mut self, - path: impl AsRef<SystemPath>, - content: impl ToString, - ) -> crate::system::Result<()> { + fn write_file(&mut self, path: impl AsRef<SystemPath>, content: impl AsRef<str>) -> Result<()> { let path = path.as_ref(); - let result = self - .test_system() - .memory_file_system() - .write_file(path, content); - - if result.is_ok() { - File::sync_path(self, path); + match self.writable_system().write_file(path, content.as_ref()) { + Ok(()) => { + File::sync_path(self, path); + Ok(()) + } + Err(error) if error.kind() == std::io::ErrorKind::NotFound => { + if let Some(parent) = path.parent() { + self.writable_system().create_directory_all(parent)?; + + for ancestor in parent.ancestors() { + File::sync_path(self, ancestor); + } + + self.writable_system().write_file(path, content.as_ref())?; + File::sync_path(self, path); + + Ok(()) + } else { + Err(error) + } + } + err => err, } - - result - } - - /// Writes the content of the given virtual file. - fn write_virtual_file(&mut self, path: impl AsRef<SystemVirtualPath>, content: impl ToString) { - let path = path.as_ref(); - self.test_system() - .memory_file_system() - .write_virtual_file(path, content); } /// Writes auto-dedented text to a file. - fn write_dedented(&mut self, path: &str, content: &str) -> crate::system::Result<()> { - self.write_file(path, textwrap::dedent(content))?; + fn write_dedented(&mut self, path: &str, content: &str) -> Result<()> { + self.write_file(path, ruff_python_trivia::textwrap::dedent(content))?; Ok(()) } /// Writes the content of the given files and notifies the Db about the change. - /// - /// # Panics - /// If the system isn't using the memory file system for testing. - fn write_files<P, C, I>(&mut self, files: I) -> crate::system::Result<()> + fn write_files<P, C, I>(&mut self, files: I) -> Result<()> where I: IntoIterator<Item = (P, C)>, P: AsRef<SystemPath>, - C: ToString, + C: AsRef<str>, { for (path, content) in files { self.write_file(path, content)?; @@ -207,6 +213,26 @@ pub trait DbWithTestSystem: Db + Sized { Ok(()) } +} + +/// Extension trait for databases that use [`TestSystem`]. +/// +/// Provides various helper function that ease testing. +pub trait DbWithTestSystem: Db + Sized { + fn test_system(&self) -> &TestSystem; + + fn test_system_mut(&mut self) -> &mut TestSystem; + + /// Writes the content of the given virtual file. + /// + /// ## Panics + /// If the db isn't using the [`InMemorySystem`]. + fn write_virtual_file(&mut self, path: impl AsRef<SystemVirtualPath>, content: impl ToString) { + let path = path.as_ref(); + self.test_system() + .memory_file_system() + .write_virtual_file(path, content); + } /// Uses the given system instead of the testing system. /// @@ -215,7 +241,7 @@ pub trait DbWithTestSystem: Db + Sized { /// Note that any files written to the memory file system won't be copied over. fn use_system<S>(&mut self, os: S) where - S: System + Send + Sync + RefUnwindSafe + 'static, + S: WritableSystem + Send + Sync + RefUnwindSafe + 'static, { self.test_system_mut().use_system(os); } @@ -223,20 +249,132 @@ pub trait DbWithTestSystem: Db + Sized { /// Returns the memory file system. /// /// ## Panics - /// If this system isn't using a memory file system. + /// If the underlying test system isn't the [`InMemorySystem`]. fn memory_file_system(&self) -> &MemoryFileSystem { self.test_system().memory_file_system() } } -#[derive(Debug)] -enum TestSystemInner { - Stub(MemoryFileSystem), - System(Arc<dyn System + RefUnwindSafe + Send + Sync>), +impl<T> DbWithWritableSystem for T +where + T: DbWithTestSystem, +{ + type System = TestSystem; + + fn writable_system(&self) -> &Self::System { + self.test_system() + } +} + +#[derive(Default, Debug)] +pub struct InMemorySystem { + user_config_directory: Mutex<Option<SystemPathBuf>>, + memory_fs: MemoryFileSystem, } -impl Default for TestSystemInner { - fn default() -> Self { - Self::Stub(MemoryFileSystem::default()) +impl InMemorySystem { + pub fn new(cwd: SystemPathBuf) -> Self { + Self { + user_config_directory: Mutex::new(None), + memory_fs: MemoryFileSystem::with_current_directory(cwd), + } + } + + pub fn fs(&self) -> &MemoryFileSystem { + &self.memory_fs + } + + pub fn set_user_configuration_directory(&self, directory: Option<SystemPathBuf>) { + let mut user_directory = self.user_config_directory.lock().unwrap(); + *user_directory = directory; + } +} + +impl System for InMemorySystem { + fn path_metadata(&self, path: &SystemPath) -> Result<Metadata> { + self.memory_fs.metadata(path) + } + + fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf> { + self.memory_fs.canonicalize(path) + } + + fn read_to_string(&self, path: &SystemPath) -> Result<String> { + self.memory_fs.read_to_string(path) + } + + fn read_to_notebook(&self, path: &SystemPath) -> std::result::Result<Notebook, NotebookError> { + let content = self.read_to_string(path)?; + Notebook::from_source_code(&content) + } + + fn read_virtual_path_to_string(&self, path: &SystemVirtualPath) -> Result<String> { + self.memory_fs.read_virtual_path_to_string(path) + } + + fn read_virtual_path_to_notebook( + &self, + path: &SystemVirtualPath, + ) -> std::result::Result<Notebook, NotebookError> { + let content = self.read_virtual_path_to_string(path)?; + Notebook::from_source_code(&content) + } + + fn current_directory(&self) -> &SystemPath { + self.memory_fs.current_directory() + } + + fn user_config_directory(&self) -> Option<SystemPathBuf> { + self.user_config_directory.lock().unwrap().clone() + } + + fn read_directory<'a>( + &'a self, + path: &SystemPath, + ) -> Result<Box<dyn Iterator<Item = Result<DirectoryEntry>> + 'a>> { + Ok(Box::new(self.memory_fs.read_directory(path)?)) + } + + fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder { + self.memory_fs.walk_directory(path) + } + + fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + Box<dyn Iterator<Item = std::result::Result<SystemPathBuf, GlobError>> + '_>, + PatternError, + > { + let iterator = self.memory_fs.glob(pattern)?; + Ok(Box::new(iterator)) + } + + fn as_any(&self) -> &dyn std::any::Any { + self + } + + fn as_any_mut(&mut self) -> &mut dyn std::any::Any { + self + } + + #[inline] + fn path_exists_case_sensitive(&self, path: &SystemPath, _prefix: &SystemPath) -> bool { + // The memory file system is case-sensitive. + self.path_exists(path) + } + + fn case_sensitivity(&self) -> CaseSensitivity { + CaseSensitivity::CaseSensitive + } +} + +impl WritableSystem for InMemorySystem { + fn write_file(&self, path: &SystemPath, content: &str) -> Result<()> { + self.memory_fs.write_file(path, content) + } + + fn create_directory_all(&self, path: &SystemPath) -> Result<()> { + self.memory_fs.create_directory_all(path) } } diff --git a/crates/ruff_db/src/system/walk_directory.rs b/crates/ruff_db/src/system/walk_directory.rs index 7932ccfae7114..752d4dae78857 100644 --- a/crates/ruff_db/src/system/walk_directory.rs +++ b/crates/ruff_db/src/system/walk_directory.rs @@ -35,7 +35,7 @@ impl WalkDirectoryBuilder { /// Each additional path is traversed recursively. /// This should be preferred over building multiple /// walkers since it enables reusing resources. - #[allow(clippy::should_implement_trait)] + #[expect(clippy::should_implement_trait)] pub fn add(mut self, path: impl AsRef<SystemPath>) -> Self { self.paths.push(path.as_ref().to_path_buf()); self diff --git a/crates/ruff_db/src/testing.rs b/crates/ruff_db/src/testing.rs index c32c57d37c227..1ecbeb2c6c993 100644 --- a/crates/ruff_db/src/testing.rs +++ b/crates/ruff_db/src/testing.rs @@ -1,7 +1,7 @@ //! Test helpers for working with Salsa databases -use tracing_subscriber::layer::SubscriberExt; use tracing_subscriber::EnvFilter; +use tracing_subscriber::layer::SubscriberExt; pub fn assert_function_query_was_not_run<Db, Q, QDb, I, R>( db: &Db, @@ -18,7 +18,7 @@ pub fn assert_function_query_was_not_run<Db, Q, QDb, I, R>( db.attach(|_| { if let Some(will_execute_event) = will_execute_event { - panic!("Expected query {query_name}({id}) not to have run but it did: {will_execute_event:?}"); + panic!("Expected query {query_name}({id}) not to have run but it did: {will_execute_event:?}\n\n{events:#?}"); } }); } @@ -46,7 +46,7 @@ pub fn assert_const_function_query_was_not_run<Db, Q, QDb, R>( db.attach(|_| { if let Some(will_execute_event) = event { panic!( - "Expected query {query_name}() not to have run but it did: {will_execute_event:?}" + "Expected query {query_name}() not to have run but it did: {will_execute_event:?}\n\n{events:#?}" ); } }); @@ -107,7 +107,7 @@ fn query_name<Q>(_query: &Q) -> &'static str { .unwrap_or(full_qualified_query_name) } -/// Sets up logging for the current thread. It captures all `red_knot` and `ruff` events. +/// Sets up logging for the current thread. It captures all `ty` and `ruff` events. /// /// Useful for capturing the tracing output in a failing test. /// @@ -128,7 +128,7 @@ pub fn setup_logging() -> LoggingGuard { /// # Examples /// ``` /// use ruff_db::testing::setup_logging_with_filter; -/// let _logging = setup_logging_with_filter("red_knot_module_resolver::resolver"); +/// let _logging = setup_logging_with_filter("ty_module_resolver::resolver"); /// ``` /// /// # Filter @@ -141,67 +141,38 @@ pub fn setup_logging_with_filter(filter: &str) -> Option<LoggingGuard> { #[derive(Debug)] pub struct LoggingBuilder { filter: EnvFilter, - hierarchical: bool, } impl LoggingBuilder { pub fn new() -> Self { Self { filter: EnvFilter::default() - .add_directive( - "red_knot=trace" - .parse() - .expect("Hardcoded directive to be valid"), - ) + .add_directive("ty=trace".parse().expect("Hardcoded directive to be valid")) .add_directive( "ruff=trace" .parse() .expect("Hardcoded directive to be valid"), ), - hierarchical: true, } } pub fn with_filter(filter: &str) -> Option<Self> { let filter = EnvFilter::builder().parse(filter).ok()?; - Some(Self { - filter, - hierarchical: true, - }) - } - - pub fn with_hierarchical(mut self, hierarchical: bool) -> Self { - self.hierarchical = hierarchical; - self + Some(Self { filter }) } pub fn build(self) -> LoggingGuard { let registry = tracing_subscriber::registry().with(self.filter); - let guard = if self.hierarchical { - let subscriber = registry.with( - tracing_tree::HierarchicalLayer::default() - .with_indent_lines(true) - .with_indent_amount(2) - .with_bracketed_fields(true) - .with_thread_ids(true) - .with_targets(true) - .with_writer(std::io::stderr) - .with_timer(tracing_tree::time::Uptime::default()), - ); - - tracing::subscriber::set_default(subscriber) - } else { - let subscriber = registry.with( - tracing_subscriber::fmt::layer() - .compact() - .with_writer(std::io::stderr) - .with_timer(tracing_subscriber::fmt::time()), - ); + let subscriber = registry.with( + tracing_subscriber::fmt::layer() + .compact() + .with_writer(std::io::stderr) + .with_timer(tracing_subscriber::fmt::time()), + ); - tracing::subscriber::set_default(subscriber) - }; + let guard = tracing::subscriber::set_default(subscriber); LoggingGuard { _guard: guard } } @@ -213,6 +184,7 @@ impl Default for LoggingBuilder { } } +#[must_use = "Dropping the guard unregisters the tracing subscriber."] pub struct LoggingGuard { _guard: tracing::subscriber::DefaultGuard, } @@ -222,7 +194,7 @@ fn query_was_not_run() { use crate::tests::TestDb; use salsa::prelude::*; - #[salsa::input] + #[salsa::input(debug)] struct Input { text: String, } @@ -257,7 +229,7 @@ fn query_was_not_run_fails_if_query_was_run() { use crate::tests::TestDb; use salsa::prelude::*; - #[salsa::input] + #[salsa::input(debug)] struct Input { text: String, } @@ -320,7 +292,7 @@ fn query_was_run_fails_if_query_was_not_run() { use crate::tests::TestDb; use salsa::prelude::*; - #[salsa::input] + #[salsa::input(debug)] struct Input { text: String, } diff --git a/crates/ruff_db/src/vendored.rs b/crates/ruff_db/src/vendored.rs index 1a328448c5336..7e8cd6e7cf562 100644 --- a/crates/ruff_db/src/vendored.rs +++ b/crates/ruff_db/src/vendored.rs @@ -7,7 +7,7 @@ use std::sync::{Arc, Mutex, MutexGuard}; use crate::file_revision::FileRevision; use zip::result::ZipResult; use zip::write::FileOptions; -use zip::{read::ZipFile, CompressionMethod, ZipArchive, ZipWriter}; +use zip::{CompressionMethod, ZipArchive, ZipWriter, read::ZipFile}; pub use self::path::{VendoredPath, VendoredPathBuf}; @@ -172,7 +172,7 @@ impl Default for VendoredFileSystem { /// that users of the `VendoredFileSystem` could realistically need. /// For debugging purposes, however, we want to have all information /// available. -#[allow(unused)] +#[expect(unused)] #[derive(Debug)] struct ZipFileDebugInfo { crc32_hash: u32, @@ -270,7 +270,7 @@ impl VendoredZipArchive { #[derive(Debug, Clone, PartialEq, Eq)] struct NormalizedVendoredPath<'a>(Cow<'a, str>); -impl<'a> NormalizedVendoredPath<'a> { +impl NormalizedVendoredPath<'_> { fn with_trailing_slash(self) -> Self { debug_assert!(!self.0.ends_with('/')); let mut data = self.0.into_owned(); @@ -418,7 +418,7 @@ pub(crate) mod tests { #[test] fn filesystem_debug_implementation_alternate() { - assert_snapshot!(format!("{:#?}", mock_typeshed()), @r###" + assert_snapshot!(format!("{:#?}", mock_typeshed()), @r#" VendoredFileSystem { inner_mutex_poisoned: false, paths: [ @@ -454,7 +454,7 @@ pub(crate) mod tests { }, }, } - "###); + "#); } fn test_directory(dirname: &str) { @@ -503,9 +503,11 @@ pub(crate) mod tests { let path = VendoredPath::new(path); assert!(!mock_typeshed.exists(path)); assert!(mock_typeshed.metadata(path).is_err()); - assert!(mock_typeshed - .read_to_string(path) - .is_err_and(|err| err.to_string().contains("file not found"))); + assert!( + mock_typeshed + .read_to_string(path) + .is_err_and(|err| err.to_string().contains("file not found")) + ); } #[test] diff --git a/crates/ruff_dev/Cargo.toml b/crates/ruff_dev/Cargo.toml index 7443d06361f50..1e44acd57390f 100644 --- a/crates/ruff_dev/Cargo.toml +++ b/crates/ruff_dev/Cargo.toml @@ -11,11 +11,14 @@ repository = { workspace = true } license = { workspace = true } [dependencies] +ty = { workspace = true } +ty_project = { workspace = true, features = ["schemars"] } ruff = { workspace = true } ruff_diagnostics = { workspace = true } ruff_formatter = { workspace = true } ruff_linter = { workspace = true, features = ["schemars"] } ruff_notebook = { workspace = true } +ruff_options_metadata = { workspace = true } ruff_python_ast = { workspace = true } ruff_python_codegen = { workspace = true } ruff_python_formatter = { workspace = true } @@ -30,6 +33,7 @@ imara-diff = { workspace = true } indicatif = { workspace = true } itertools = { workspace = true } libcst = { workspace = true } +markdown = { version = "1.0.0" } pretty_assertions = { workspace = true } rayon = { workspace = true } regex = { workspace = true } @@ -43,6 +47,7 @@ toml = { workspace = true, features = ["parse"] } tracing = { workspace = true } tracing-indicatif = { workspace = true } tracing-subscriber = { workspace = true, features = ["env-filter"] } +url = { workspace = true } [dev-dependencies] indoc = { workspace = true } diff --git a/crates/ruff_dev/src/format_dev.rs b/crates/ruff_dev/src/format_dev.rs index f9be6b0bf591a..8f0dcc5183c32 100644 --- a/crates/ruff_dev/src/format_dev.rs +++ b/crates/ruff_dev/src/format_dev.rs @@ -9,11 +9,11 @@ use std::process::ExitCode; use std::time::{Duration, Instant}; use std::{fmt, fs, io, iter}; -use anyhow::{bail, format_err, Context, Error}; +use anyhow::{Context, Error, bail, format_err}; use clap::{CommandFactory, FromArgMatches}; use imara_diff::intern::InternedInput; use imara_diff::sink::Counter; -use imara_diff::{diff, Algorithm}; +use imara_diff::{Algorithm, diff}; use indicatif::ProgressStyle; #[cfg_attr(feature = "singlethreaded", allow(unused_imports))] use rayon::iter::{IntoParallelIterator, ParallelIterator}; @@ -21,11 +21,11 @@ use serde::Deserialize; use similar::{ChangeTag, TextDiff}; use tempfile::NamedTempFile; use tracing::{debug, error, info, info_span}; -use tracing_indicatif::span_ext::IndicatifSpanExt; use tracing_indicatif::IndicatifLayer; +use tracing_indicatif::span_ext::IndicatifSpanExt; +use tracing_subscriber::EnvFilter; use tracing_subscriber::layer::SubscriberExt; use tracing_subscriber::util::SubscriberInitExt; -use tracing_subscriber::EnvFilter; use ruff::args::{ConfigArguments, FormatArguments, FormatCommand, GlobalConfigArgs, LogLevelArgs}; use ruff::resolve::resolve; @@ -33,10 +33,10 @@ use ruff_formatter::{FormatError, LineWidth, PrintError}; use ruff_linter::logging::LogLevel; use ruff_linter::settings::types::{FilePattern, FilePatternSet}; use ruff_python_formatter::{ - format_module_source, FormatModuleError, MagicTrailingComma, PreviewMode, PyFormatOptions, + FormatModuleError, MagicTrailingComma, PreviewMode, PyFormatOptions, format_module_source, }; use ruff_python_parser::ParseError; -use ruff_workspace::resolver::{python_files_in_path, PyprojectConfig, ResolvedFile, Resolver}; +use ruff_workspace::resolver::{PyprojectConfig, ResolvedFile, Resolver, python_files_in_path}; fn parse_cli(dirs: &[PathBuf]) -> anyhow::Result<(FormatArguments, ConfigArguments)> { let args_matches = FormatCommand::command() @@ -63,7 +63,6 @@ fn find_pyproject_config( } /// Find files that ruff would check so we can format them. Adapted from `ruff`. -#[allow(clippy::type_complexity)] fn ruff_check_paths<'a>( pyproject_config: &'a PyprojectConfig, cli: &FormatArguments, @@ -135,12 +134,12 @@ impl Statistics { } /// We currently prefer the similarity index, but i'd like to keep this around - #[allow(clippy::cast_precision_loss, unused)] + #[expect(clippy::cast_precision_loss, unused)] pub(crate) fn jaccard_index(&self) -> f32 { self.intersection as f32 / (self.black_input + self.ruff_output + self.intersection) as f32 } - #[allow(clippy::cast_precision_loss)] + #[expect(clippy::cast_precision_loss)] pub(crate) fn similarity_index(&self) -> f32 { self.intersection as f32 / (self.black_input + self.intersection) as f32 } @@ -177,7 +176,7 @@ pub(crate) enum Format { Full, } -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] #[derive(clap::Args)] pub(crate) struct Args { /// Like `ruff check`'s files. See `--multi-project` if you want to format an ecosystem @@ -222,7 +221,7 @@ pub(crate) struct Args { #[arg(long)] pub(crate) files_with_errors: Option<u32>, #[clap(flatten)] - #[allow(clippy::struct_field_names)] + #[expect(clippy::struct_field_names)] pub(crate) log_level_args: LogLevelArgs, } diff --git a/crates/ruff_dev/src/generate_all.rs b/crates/ruff_dev/src/generate_all.rs index 6b8212ce6419f..4d3fb9577ec4f 100644 --- a/crates/ruff_dev/src/generate_all.rs +++ b/crates/ruff_dev/src/generate_all.rs @@ -2,7 +2,10 @@ use anyhow::Result; -use crate::{generate_cli_help, generate_docs, generate_json_schema}; +use crate::{ + generate_cli_help, generate_docs, generate_json_schema, generate_ty_cli_reference, + generate_ty_options, generate_ty_rules, generate_ty_schema, +}; pub(crate) const REGENERATE_ALL_COMMAND: &str = "cargo dev generate-all"; @@ -33,9 +36,13 @@ impl Mode { pub(crate) fn main(args: &Args) -> Result<()> { generate_json_schema::main(&generate_json_schema::Args { mode: args.mode })?; + generate_ty_schema::main(&generate_ty_schema::Args { mode: args.mode })?; generate_cli_help::main(&generate_cli_help::Args { mode: args.mode })?; generate_docs::main(&generate_docs::Args { dry_run: args.mode.is_dry_run(), })?; + generate_ty_options::main(&generate_ty_options::Args { mode: args.mode })?; + generate_ty_rules::main(&generate_ty_rules::Args { mode: args.mode })?; + generate_ty_cli_reference::main(&generate_ty_cli_reference::Args { mode: args.mode })?; Ok(()) } diff --git a/crates/ruff_dev/src/generate_cli_help.rs b/crates/ruff_dev/src/generate_cli_help.rs index 20eb41bb2f6a6..26f2bd52d0096 100644 --- a/crates/ruff_dev/src/generate_cli_help.rs +++ b/crates/ruff_dev/src/generate_cli_help.rs @@ -1,17 +1,16 @@ //! Generate CLI help. -#![allow(clippy::print_stdout)] use std::path::PathBuf; use std::{fs, str}; -use anyhow::{bail, Context, Result}; +use anyhow::{Context, Result, bail}; use clap::CommandFactory; use pretty_assertions::StrComparison; use ruff::args; -use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; use crate::ROOT_DIR; +use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; const COMMAND_HELP_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated command help. -->\n"; const COMMAND_HELP_END_PRAGMA: &str = "<!-- End auto-generated command help. -->"; @@ -141,7 +140,7 @@ mod tests { use crate::generate_all::Mode; - use super::{main, Args}; + use super::{Args, main}; #[test] fn test_generate_json_schema() -> Result<()> { diff --git a/crates/ruff_dev/src/generate_docs.rs b/crates/ruff_dev/src/generate_docs.rs index c86814031c1d1..e422f498ee2d5 100644 --- a/crates/ruff_dev/src/generate_docs.rs +++ b/crates/ruff_dev/src/generate_docs.rs @@ -1,7 +1,7 @@ //! Generate Markdown documentation for applicable rules. -#![allow(clippy::print_stdout, clippy::print_stderr)] use std::collections::HashSet; +use std::fmt::Write as _; use std::fs; use std::path::PathBuf; @@ -12,8 +12,8 @@ use strum::IntoEnumIterator; use ruff_diagnostics::FixAvailability; use ruff_linter::registry::{Linter, Rule, RuleNamespace}; +use ruff_options_metadata::{OptionEntry, OptionsMetadata}; use ruff_workspace::options::Options; -use ruff_workspace::options_base::{OptionEntry, OptionsMetadata}; use crate::ROOT_DIR; @@ -29,8 +29,7 @@ pub(crate) fn main(args: &Args) -> Result<()> { if let Some(explanation) = rule.explanation() { let mut output = String::new(); - output.push_str(&format!("# {} ({})", rule.as_ref(), rule.noqa_code())); - output.push('\n'); + let _ = writeln!(&mut output, "# {} ({})", rule.as_ref(), rule.noqa_code()); let (linter, _) = Linter::parse_code(&rule.noqa_code().to_string()).unwrap(); if linter.url().is_some() { @@ -49,11 +48,12 @@ pub(crate) fn main(args: &Args) -> Result<()> { common_prefix.to_lowercase() ); - output.push_str(&format!( + let _ = write!( + output, "Derived from the **[{}](../rules.md#{})** linter.", linter.name(), - anchor - )); + anchor, + ); output.push('\n'); output.push('\n'); } @@ -155,8 +155,8 @@ fn process_documentation(documentation: &str, out: &mut String, rule_name: &str) } let anchor = option.replace('.', "_"); - out.push_str(&format!("- [`{option}`][{option}]\n")); - after.push_str(&format!("[{option}]: ../settings.md#{anchor}\n")); + let _ = writeln!(out, "- [`{option}`][{option}]"); + let _ = writeln!(&mut after, "[{option}]: ../settings.md#{anchor}"); referenced_options.insert(option); continue; @@ -171,7 +171,7 @@ fn process_documentation(documentation: &str, out: &mut String, rule_name: &str) if let Some(OptionEntry::Field(field)) = Options::metadata().find(option) { if referenced_options.insert(option) { let anchor = option.replace('.', "_"); - after.push_str(&format!("[{option}]: ../settings.md#{anchor}\n")); + let _ = writeln!(&mut after, "[{option}]: ../settings.md#{anchor}"); } if field.deprecated.is_some() { eprintln!("Rule {rule_name} references deprecated option {option}."); diff --git a/crates/ruff_dev/src/generate_json_schema.rs b/crates/ruff_dev/src/generate_json_schema.rs index c82843eef2597..61d616cfb4b22 100644 --- a/crates/ruff_dev/src/generate_json_schema.rs +++ b/crates/ruff_dev/src/generate_json_schema.rs @@ -1,14 +1,12 @@ -#![allow(clippy::print_stdout, clippy::print_stderr)] - use std::fs; use std::path::PathBuf; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use pretty_assertions::StrComparison; use schemars::schema_for; -use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; use crate::ROOT_DIR; +use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; use ruff_workspace::options::Options; #[derive(clap::Args)] @@ -58,7 +56,7 @@ mod tests { use crate::generate_all::Mode; - use super::{main, Args}; + use super::{Args, main}; #[test] fn test_generate_json_schema() -> Result<()> { diff --git a/crates/ruff_dev/src/generate_options.rs b/crates/ruff_dev/src/generate_options.rs index 652cc4d2ee756..8b8579d730594 100644 --- a/crates/ruff_dev/src/generate_options.rs +++ b/crates/ruff_dev/src/generate_options.rs @@ -4,9 +4,9 @@ use itertools::Itertools; use std::fmt::Write; +use ruff_options_metadata::{OptionField, OptionSet, OptionsMetadata, Visit}; use ruff_python_trivia::textwrap; use ruff_workspace::options::Options; -use ruff_workspace::options_base::{OptionField, OptionSet, OptionsMetadata, Visit}; pub(crate) fn generate() -> String { let mut output = String::new(); @@ -98,17 +98,16 @@ fn emit_field(output: &mut String, name: &str, field: &OptionField, parents: &[S let parents_anchor = parents.iter().filter_map(|parent| parent.name()).join("_"); if parents_anchor.is_empty() { - output.push_str(&format!( - "{header_level} [`{name}`](#{name}) {{: #{name} }}\n" - )); + let _ = writeln!(output, "{header_level} [`{name}`](#{name}) {{: #{name} }}"); } else { - output.push_str(&format!( - "{header_level} [`{name}`](#{parents_anchor}_{name}) {{: #{parents_anchor}_{name} }}\n" - )); + let _ = writeln!( + output, + "{header_level} [`{name}`](#{parents_anchor}_{name}) {{: #{parents_anchor}_{name} }}" + ); // the anchor used to just be the name, but now it's the group name // for backwards compatibility, we need to keep the old anchor - output.push_str(&format!("<span id=\"{name}\"></span>\n")); + let _ = writeln!(output, "<span id=\"{name}\"></span>"); } output.push('\n'); @@ -132,9 +131,9 @@ fn emit_field(output: &mut String, name: &str, field: &OptionField, parents: &[S output.push_str(field.doc); output.push_str("\n\n"); - output.push_str(&format!("**Default value**: `{}`\n", field.default)); + let _ = writeln!(output, "**Default value**: `{}`", field.default); output.push('\n'); - output.push_str(&format!("**Type**: `{}`\n", field.value_type)); + let _ = writeln!(output, "**Type**: `{}`", field.value_type); output.push('\n'); output.push_str("**Example usage**:\n\n"); output.push_str(&format_tab( diff --git a/crates/ruff_dev/src/generate_rules_table.rs b/crates/ruff_dev/src/generate_rules_table.rs index 1a92a756783f7..73cdf65540ff3 100644 --- a/crates/ruff_dev/src/generate_rules_table.rs +++ b/crates/ruff_dev/src/generate_rules_table.rs @@ -5,13 +5,14 @@ use itertools::Itertools; use ruff_linter::codes::RuleGroup; use std::borrow::Cow; +use std::fmt::Write; use strum::IntoEnumIterator; use ruff_diagnostics::FixAvailability; use ruff_linter::registry::{Linter, Rule, RuleNamespace}; use ruff_linter::upstream_categories::UpstreamCategoryAndPrefix; +use ruff_options_metadata::OptionsMetadata; use ruff_workspace::options::Options; -use ruff_workspace::options_base::OptionsMetadata; const FIX_SYMBOL: &str = "🛠️"; const PREVIEW_SYMBOL: &str = "🧪"; @@ -33,7 +34,6 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>, RuleGroup::Deprecated => { format!("<span title='Rule has been deprecated'>{WARNING_SYMBOL}</span>") } - #[allow(deprecated)] RuleGroup::Preview => { format!("<span title='Rule is in preview'>{PREVIEW_SYMBOL}</span>") } @@ -48,7 +48,9 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>, format!("<span title='Automatic fix available'>{FIX_SYMBOL}</span>") } FixAvailability::None => { - format!("<span title='Automatic fix not available' style='opacity: 0.1' aria-hidden='true'>{FIX_SYMBOL}</span>") + format!( + "<span title='Automatic fix not available' style='opacity: 0.1' aria-hidden='true'>{FIX_SYMBOL}</span>" + ) } }; @@ -77,8 +79,9 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>, se = "</span>"; } - #[allow(clippy::or_fun_call)] - table_out.push_str(&format!( + #[expect(clippy::or_fun_call)] + let _ = write!( + table_out, "| {ss}{0}{1}{se} {{ #{0}{1} }} | {ss}{2}{se} | {ss}{3}{se} | {ss}{4}{se} |", linter.common_prefix(), linter.code_for_rule(rule).unwrap(), @@ -88,7 +91,7 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator<Item = Rule>, .unwrap_or(format_args!("{rule_name}")), message, tokens, - )); + ); table_out.push('\n'); } table_out.push('\n'); @@ -101,29 +104,34 @@ pub(crate) fn generate() -> String { table_out.push_str("### Legend"); table_out.push('\n'); - table_out.push_str(&format!( + let _ = write!( + &mut table_out, "{SPACER}{STABLE_SYMBOL}{SPACER} The rule is stable." - )); + ); table_out.push_str("<br />"); - table_out.push_str(&format!( + let _ = write!( + &mut table_out, "{SPACER}{PREVIEW_SYMBOL}{SPACER} The rule is unstable and is in [\"preview\"](faq.md#what-is-preview)." - )); + ); table_out.push_str("<br />"); - table_out.push_str(&format!( + let _ = write!( + &mut table_out, "{SPACER}{WARNING_SYMBOL}{SPACER} The rule has been deprecated and will be removed in a future release." - )); + ); table_out.push_str("<br />"); - table_out.push_str(&format!( + let _ = write!( + &mut table_out, "{SPACER}{REMOVED_SYMBOL}{SPACER} The rule has been removed only the documentation is available." - )); + ); table_out.push_str("<br />"); - table_out.push_str(&format!( + let _ = write!( + &mut table_out, "{SPACER}{FIX_SYMBOL}{SPACER} The rule is automatically fixable by the `--fix` command-line option." - )); + ); table_out.push_str("<br />"); table_out.push('\n'); @@ -137,7 +145,7 @@ pub(crate) fn generate() -> String { .join(", "), prefix => prefix.to_string(), }; - table_out.push_str(&format!("### {} ({codes_csv})", linter.name())); + let _ = write!(&mut table_out, "### {} ({codes_csv})", linter.name()); table_out.push('\n'); table_out.push('\n'); @@ -147,7 +155,8 @@ pub(crate) fn generate() -> String { .split('/') .next() .unwrap(); - table_out.push_str(&format!( + let _ = write!( + table_out, "For more, see [{}]({}) on {}.", linter.name(), url, @@ -160,17 +169,18 @@ pub(crate) fn generate() -> String { linter.name() ), } - )); + ); table_out.push('\n'); table_out.push('\n'); } if Options::metadata().has(&format!("lint.{}", linter.name())) { - table_out.push_str(&format!( + let _ = write!( + table_out, "For related settings, see [{}](settings.md#lint{}).", linter.name(), linter.name(), - )); + ); table_out.push('\n'); table_out.push('\n'); } @@ -198,7 +208,14 @@ pub(crate) fn generate() -> String { for (opt, rules) in rules_by_upstream_category { if opt.is_some() { let UpstreamCategoryAndPrefix { category, prefix } = opt.unwrap(); - table_out.push_str(&format!("#### {category} ({prefix})")); + match codes_csv.as_str() { + "PL" => { + let _ = write!(table_out, "#### {category} ({codes_csv}{prefix})"); + } + _ => { + let _ = write!(table_out, "#### {category} ({prefix})"); + } + } } table_out.push('\n'); table_out.push('\n'); diff --git a/crates/ruff_dev/src/generate_ty_cli_reference.rs b/crates/ruff_dev/src/generate_ty_cli_reference.rs new file mode 100644 index 0000000000000..c240e76537e37 --- /dev/null +++ b/crates/ruff_dev/src/generate_ty_cli_reference.rs @@ -0,0 +1,334 @@ +//! Generate a Markdown-compatible reference for the ty command-line interface. +use std::cmp::max; +use std::path::PathBuf; + +use anyhow::{Result, bail}; +use clap::{Command, CommandFactory}; +use itertools::Itertools; +use pretty_assertions::StrComparison; + +use crate::ROOT_DIR; +use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; + +use ty::Cli; + +const SHOW_HIDDEN_COMMANDS: &[&str] = &["generate-shell-completion"]; + +#[derive(clap::Args)] +pub(crate) struct Args { + #[arg(long, default_value_t, value_enum)] + pub(crate) mode: Mode, +} + +pub(crate) fn main(args: &Args) -> Result<()> { + let reference_string = generate(); + let filename = "crates/ty/docs/cli.md"; + let reference_path = PathBuf::from(ROOT_DIR).join(filename); + + match args.mode { + Mode::DryRun => { + println!("{reference_string}"); + } + Mode::Check => match std::fs::read_to_string(reference_path) { + Ok(current) => { + if current == reference_string { + println!("Up-to-date: {filename}"); + } else { + let comparison = StrComparison::new(¤t, &reference_string); + bail!( + "{filename} changed, please run `{REGENERATE_ALL_COMMAND}`:\n{comparison}" + ); + } + } + Err(err) if err.kind() == std::io::ErrorKind::NotFound => { + bail!("{filename} not found, please run `{REGENERATE_ALL_COMMAND}`"); + } + Err(err) => { + bail!("{filename} changed, please run `{REGENERATE_ALL_COMMAND}`:\n{err}"); + } + }, + Mode::Write => match std::fs::read_to_string(&reference_path) { + Ok(current) => { + if current == reference_string { + println!("Up-to-date: {filename}"); + } else { + println!("Updating: {filename}"); + std::fs::write(reference_path, reference_string.as_bytes())?; + } + } + Err(err) if err.kind() == std::io::ErrorKind::NotFound => { + println!("Updating: {filename}"); + std::fs::write(reference_path, reference_string.as_bytes())?; + } + Err(err) => { + bail!("{filename} changed, please run `cargo dev generate-cli-reference`:\n{err}"); + } + }, + } + + Ok(()) +} + +fn generate() -> String { + let mut output = String::new(); + + let mut ty = Cli::command(); + + // It is very important to build the command before beginning inspection or subcommands + // will be missing all of the propagated options. + ty.build(); + + let mut parents = Vec::new(); + + output.push_str("# CLI Reference\n\n"); + generate_command(&mut output, &ty, &mut parents); + + output +} + +#[allow(clippy::format_push_string)] +fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut Vec<&'a Command>) { + if command.is_hide_set() && !SHOW_HIDDEN_COMMANDS.contains(&command.get_name()) { + return; + } + + // Generate the command header. + let name = if parents.is_empty() { + command.get_name().to_string() + } else { + format!( + "{} {}", + parents.iter().map(|cmd| cmd.get_name()).join(" "), + command.get_name() + ) + }; + + // Display the top-level `ty` command at the same level as its children + let level = max(2, parents.len() + 1); + output.push_str(&format!("{} {name}\n\n", "#".repeat(level))); + + // Display the command description. + if let Some(about) = command.get_long_about().or_else(|| command.get_about()) { + output.push_str(&about.to_string()); + output.push_str("\n\n"); + } + + // Display the usage + { + // This appears to be the simplest way to get rendered usage from Clap, + // it is complicated to render it manually. It's annoying that it + // requires a mutable reference but it doesn't really matter. + let mut command = command.clone(); + output.push_str("<h3 class=\"cli-reference\">Usage</h3>\n\n"); + output.push_str(&format!( + "```\n{}\n```", + command + .render_usage() + .to_string() + .trim_start_matches("Usage: "), + )); + output.push_str("\n\n"); + } + + if command.get_name() == "help" { + return; + } + + // Display a list of child commands + let mut subcommands = command.get_subcommands().peekable(); + let has_subcommands = subcommands.peek().is_some(); + if has_subcommands { + output.push_str("<h3 class=\"cli-reference\">Commands</h3>\n\n"); + output.push_str("<dl class=\"cli-reference\">"); + + for subcommand in subcommands { + if subcommand.is_hide_set() { + continue; + } + let subcommand_name = format!("{name} {}", subcommand.get_name()); + output.push_str(&format!( + "<dt><a href=\"#{}\"><code>{subcommand_name}</code></a></dt>", + subcommand_name.replace(' ', "-") + )); + if let Some(about) = subcommand.get_about() { + output.push_str(&format!( + "<dd>{}</dd>\n", + markdown::to_html(&about.to_string()) + )); + } + } + + output.push_str("</dl>\n\n"); + } + + // Do not display options for commands with children + if !has_subcommands { + let name_key = name.replace(' ', "-"); + + // Display positional arguments + let mut arguments = command + .get_positionals() + .filter(|arg| !arg.is_hide_set()) + .peekable(); + + if arguments.peek().is_some() { + output.push_str("<h3 class=\"cli-reference\">Arguments</h3>\n\n"); + output.push_str("<dl class=\"cli-reference\">"); + + for arg in arguments { + let id = format!("{name_key}--{}", arg.get_id()); + output.push_str(&format!("<dt id=\"{id}\">")); + output.push_str(&format!( + "<a href=\"#{id}\"><code>{}</code></a>", + arg.get_id().to_string().to_uppercase(), + )); + output.push_str("</dt>"); + if let Some(help) = arg.get_long_help().or_else(|| arg.get_help()) { + output.push_str("<dd>"); + output.push_str(&format!("{}\n", markdown::to_html(&help.to_string()))); + output.push_str("</dd>"); + } + } + + output.push_str("</dl>\n\n"); + } + + // Display options and flags + let mut options = command + .get_arguments() + .filter(|arg| !arg.is_positional()) + .filter(|arg| !arg.is_hide_set()) + .sorted_by_key(|arg| arg.get_id()) + .peekable(); + + if options.peek().is_some() { + output.push_str("<h3 class=\"cli-reference\">Options</h3>\n\n"); + output.push_str("<dl class=\"cli-reference\">"); + for opt in options { + let Some(long) = opt.get_long() else { continue }; + let id = format!("{name_key}--{long}"); + + output.push_str(&format!("<dt id=\"{id}\">")); + output.push_str(&format!("<a href=\"#{id}\"><code>--{long}</code></a>")); + for long_alias in opt.get_all_aliases().into_iter().flatten() { + output.push_str(&format!(", <code>--{long_alias}</code>")); + } + if let Some(short) = opt.get_short() { + output.push_str(&format!(", <code>-{short}</code>")); + } + for short_alias in opt.get_all_short_aliases().into_iter().flatten() { + output.push_str(&format!(", <code>-{short_alias}</code>")); + } + + // Re-implements private `Arg::is_takes_value_set` used in `Command::get_opts` + if opt + .get_num_args() + .unwrap_or_else(|| 1.into()) + .takes_values() + { + if let Some(values) = opt.get_value_names() { + for value in values { + output.push_str(&format!( + " <i>{}</i>", + value.to_lowercase().replace('_', "-") + )); + } + } + } + output.push_str("</dt>"); + if let Some(help) = opt.get_long_help().or_else(|| opt.get_help()) { + output.push_str("<dd>"); + output.push_str(&format!("{}\n", markdown::to_html(&help.to_string()))); + emit_env_option(opt, output); + emit_default_option(opt, output); + emit_possible_options(opt, output); + output.push_str("</dd>"); + } + } + + output.push_str("</dl>"); + } + + output.push_str("\n\n"); + } + + parents.push(command); + + // Recurse to all of the subcommands. + for subcommand in command.get_subcommands() { + generate_command(output, subcommand, parents); + } + + parents.pop(); +} + +fn emit_env_option(opt: &clap::Arg, output: &mut String) { + if opt.is_hide_env_set() { + return; + } + if let Some(env) = opt.get_env() { + output.push_str(&markdown::to_html(&format!( + "May also be set with the `{}` environment variable.", + env.to_string_lossy() + ))); + } +} + +fn emit_default_option(opt: &clap::Arg, output: &mut String) { + if opt.is_hide_default_value_set() || !opt.get_num_args().expect("built").takes_values() { + return; + } + + let values = opt.get_default_values(); + if !values.is_empty() { + let value = format!( + "\n[default: {}]", + opt.get_default_values() + .iter() + .map(|s| s.to_string_lossy()) + .join(",") + ); + output.push_str(&markdown::to_html(&value)); + } +} + +fn emit_possible_options(opt: &clap::Arg, output: &mut String) { + if opt.is_hide_possible_values_set() { + return; + } + + let values = opt.get_possible_values(); + if !values.is_empty() { + let value = format!( + "\nPossible values:\n{}", + values + .into_iter() + .filter(|value| !value.is_hide_set()) + .map(|value| { + let name = value.get_name(); + value.get_help().map_or_else( + || format!(" - `{name}`"), + |help| format!(" - `{name}`: {help}"), + ) + }) + .collect_vec() + .join("\n"), + ); + output.push_str(&markdown::to_html(&value)); + } +} + +#[cfg(test)] +mod tests { + + use anyhow::Result; + + use crate::generate_all::Mode; + + use super::{Args, main}; + + #[test] + fn ty_cli_reference_is_up_to_date() -> Result<()> { + main(&Args { mode: Mode::Check }) + } +} diff --git a/crates/ruff_dev/src/generate_ty_options.rs b/crates/ruff_dev/src/generate_ty_options.rs new file mode 100644 index 0000000000000..1542e3e45d365 --- /dev/null +++ b/crates/ruff_dev/src/generate_ty_options.rs @@ -0,0 +1,257 @@ +//! Generate a Markdown-compatible listing of configuration options for `pyproject.toml`. + +use anyhow::bail; +use itertools::Itertools; +use pretty_assertions::StrComparison; +use std::{fmt::Write, path::PathBuf}; + +use ruff_options_metadata::{OptionField, OptionSet, OptionsMetadata, Visit}; +use ty_project::metadata::Options; + +use crate::{ + ROOT_DIR, + generate_all::{Mode, REGENERATE_ALL_COMMAND}, +}; + +#[derive(clap::Args)] +pub(crate) struct Args { + /// Write the generated table to stdout (rather than to `crates/ty/docs/configuration.md`). + #[arg(long, default_value_t, value_enum)] + pub(crate) mode: Mode, +} + +pub(crate) fn main(args: &Args) -> anyhow::Result<()> { + let mut output = String::new(); + let file_name = "crates/ty/docs/configuration.md"; + let markdown_path = PathBuf::from(ROOT_DIR).join(file_name); + + generate_set( + &mut output, + Set::Toplevel(Options::metadata()), + &mut Vec::new(), + ); + + match args.mode { + Mode::DryRun => { + println!("{output}"); + } + Mode::Check => { + let current = std::fs::read_to_string(&markdown_path)?; + if output == current { + println!("Up-to-date: {file_name}",); + } else { + let comparison = StrComparison::new(¤t, &output); + bail!("{file_name} changed, please run `{REGENERATE_ALL_COMMAND}`:\n{comparison}",); + } + } + Mode::Write => { + let current = std::fs::read_to_string(&markdown_path)?; + if current == output { + println!("Up-to-date: {file_name}",); + } else { + println!("Updating: {file_name}",); + std::fs::write(markdown_path, output.as_bytes())?; + } + } + } + + Ok(()) +} + +fn generate_set(output: &mut String, set: Set, parents: &mut Vec<Set>) { + match &set { + Set::Toplevel(_) => { + output.push_str("# Configuration\n"); + } + Set::Named { name, .. } => { + let title = parents + .iter() + .filter_map(|set| set.name()) + .chain(std::iter::once(name.as_str())) + .join("."); + writeln!(output, "## `{title}`\n",).unwrap(); + } + } + + if let Some(documentation) = set.metadata().documentation() { + output.push_str(documentation); + output.push('\n'); + output.push('\n'); + } + + let mut visitor = CollectOptionsVisitor::default(); + set.metadata().record(&mut visitor); + + let (mut fields, mut sets) = (visitor.fields, visitor.groups); + + fields.sort_unstable_by(|(name, _), (name2, _)| name.cmp(name2)); + sets.sort_unstable_by(|(name, _), (name2, _)| name.cmp(name2)); + + parents.push(set); + + // Generate the fields. + for (name, field) in &fields { + emit_field(output, name, field, parents.as_slice()); + output.push_str("---\n\n"); + } + + // Generate all the sub-sets. + for (set_name, sub_set) in &sets { + generate_set( + output, + Set::Named { + name: set_name.to_string(), + set: *sub_set, + }, + parents, + ); + } + + parents.pop(); +} + +enum Set { + Toplevel(OptionSet), + Named { name: String, set: OptionSet }, +} + +impl Set { + fn name(&self) -> Option<&str> { + match self { + Set::Toplevel(_) => None, + Set::Named { name, .. } => Some(name), + } + } + + fn metadata(&self) -> &OptionSet { + match self { + Set::Toplevel(set) => set, + Set::Named { set, .. } => set, + } + } +} + +fn emit_field(output: &mut String, name: &str, field: &OptionField, parents: &[Set]) { + let header_level = if parents.is_empty() { "###" } else { "####" }; + + let _ = writeln!(output, "{header_level} `{name}`"); + + output.push('\n'); + + if let Some(deprecated) = &field.deprecated { + output.push_str("> [!WARN] \"Deprecated\"\n"); + output.push_str("> This option has been deprecated"); + + if let Some(since) = deprecated.since { + write!(output, " in {since}").unwrap(); + } + + output.push('.'); + + if let Some(message) = deprecated.message { + writeln!(output, " {message}").unwrap(); + } + + output.push('\n'); + } + + output.push_str(field.doc); + output.push_str("\n\n"); + let _ = writeln!(output, "**Default value**: `{}`", field.default); + output.push('\n'); + let _ = writeln!(output, "**Type**: `{}`", field.value_type); + output.push('\n'); + output.push_str("**Example usage** (`pyproject.toml`):\n\n"); + output.push_str(&format_example( + &format_header( + field.scope, + field.example, + parents, + ConfigurationFile::PyprojectToml, + ), + field.example, + )); + output.push('\n'); +} + +fn format_example(header: &str, content: &str) -> String { + if header.is_empty() { + format!("```toml\n{content}\n```\n",) + } else { + format!("```toml\n{header}\n{content}\n```\n",) + } +} + +/// Format the TOML header for the example usage for a given option. +/// +/// For example: `[tool.ruff.format]` or `[tool.ruff.lint.isort]`. +fn format_header( + scope: Option<&str>, + example: &str, + parents: &[Set], + configuration: ConfigurationFile, +) -> String { + let tool_parent = match configuration { + ConfigurationFile::PyprojectToml => Some("tool.ty"), + ConfigurationFile::TyToml => None, + }; + + let header = tool_parent + .into_iter() + .chain(parents.iter().filter_map(|parent| parent.name())) + .chain(scope) + .join("."); + + // Ex) `[[tool.ty.xx]]` + if example.starts_with(&format!("[[{header}")) { + return String::new(); + } + // Ex) `[tool.ty.rules]` + if example.starts_with(&format!("[{header}")) { + return String::new(); + } + + if header.is_empty() { + String::new() + } else { + format!("[{header}]") + } +} + +#[derive(Default)] +struct CollectOptionsVisitor { + groups: Vec<(String, OptionSet)>, + fields: Vec<(String, OptionField)>, +} + +impl Visit for CollectOptionsVisitor { + fn record_set(&mut self, name: &str, group: OptionSet) { + self.groups.push((name.to_owned(), group)); + } + + fn record_field(&mut self, name: &str, field: OptionField) { + self.fields.push((name.to_owned(), field)); + } +} + +#[derive(Debug, Copy, Clone)] +enum ConfigurationFile { + PyprojectToml, + #[expect(dead_code)] + TyToml, +} + +#[cfg(test)] +mod tests { + use anyhow::Result; + + use crate::generate_all::Mode; + + use super::{Args, main}; + + #[test] + fn ty_configuration_markdown_up_to_date() -> Result<()> { + main(&Args { mode: Mode::Check })?; + Ok(()) + } +} diff --git a/crates/ruff_dev/src/generate_ty_rules.rs b/crates/ruff_dev/src/generate_ty_rules.rs new file mode 100644 index 0000000000000..d28a2feafbea5 --- /dev/null +++ b/crates/ruff_dev/src/generate_ty_rules.rs @@ -0,0 +1,143 @@ +//! Generates the rules table for ty + +use std::borrow::Cow; +use std::fmt::Write as _; +use std::fs; +use std::path::PathBuf; + +use anyhow::{Result, bail}; +use itertools::Itertools as _; +use pretty_assertions::StrComparison; + +use crate::ROOT_DIR; +use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; + +#[derive(clap::Args)] +pub(crate) struct Args { + /// Write the generated table to stdout (rather than to `ty.schema.json`). + #[arg(long, default_value_t, value_enum)] + pub(crate) mode: Mode, +} + +pub(crate) fn main(args: &Args) -> Result<()> { + let markdown = generate_markdown(); + let filename = "crates/ty/docs/rules.md"; + let schema_path = PathBuf::from(ROOT_DIR).join(filename); + + match args.mode { + Mode::DryRun => { + println!("{markdown}"); + } + Mode::Check => { + let current = fs::read_to_string(schema_path)?; + if current == markdown { + println!("Up-to-date: {filename}"); + } else { + let comparison = StrComparison::new(¤t, &markdown); + bail!("{filename} changed, please run `{REGENERATE_ALL_COMMAND}`:\n{comparison}"); + } + } + Mode::Write => { + let current = fs::read_to_string(&schema_path)?; + if current == markdown { + println!("Up-to-date: {filename}"); + } else { + println!("Updating: {filename}"); + fs::write(schema_path, markdown.as_bytes())?; + } + } + } + + Ok(()) +} + +fn generate_markdown() -> String { + let registry = &*ty_project::DEFAULT_LINT_REGISTRY; + + let mut output = String::new(); + + let _ = writeln!(&mut output, "# Rules\n"); + + let mut lints: Vec<_> = registry.lints().iter().collect(); + lints.sort_by(|a, b| { + a.default_level() + .cmp(&b.default_level()) + .reverse() + .then_with(|| a.name().cmp(&b.name())) + }); + + for lint in lints { + let _ = writeln!(&mut output, "## `{rule_name}`\n", rule_name = lint.name()); + + // Increase the header-level by one + let documentation = lint + .documentation_lines() + .map(|line| { + if line.starts_with('#') { + Cow::Owned(format!("#{line}")) + } else { + Cow::Borrowed(line) + } + }) + .join("\n"); + + let _ = writeln!( + &mut output, + r#"**Default level**: {level} + +<details> +<summary>{summary}</summary> + +{documentation} + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20{encoded_name}) +* [View source](https://github.com/astral-sh/ruff/blob/main/{file}#L{line}) +</details> +"#, + level = lint.default_level(), + // GitHub doesn't support markdown in `summary` headers + summary = replace_inline_code(lint.summary()), + encoded_name = url::form_urlencoded::byte_serialize(lint.name().as_str().as_bytes()) + .collect::<String>(), + file = url::form_urlencoded::byte_serialize(lint.file().replace('\\', "/").as_bytes()) + .collect::<String>(), + line = lint.line(), + ); + } + + output +} + +/// Replaces inline code blocks (`code`) with `<code>code</code>` +fn replace_inline_code(input: &str) -> String { + let mut output = String::new(); + let mut parts = input.split('`'); + + while let Some(before) = parts.next() { + if let Some(between) = parts.next() { + output.push_str(before); + output.push_str("<code>"); + output.push_str(between); + output.push_str("</code>"); + } else { + output.push_str(before); + } + } + + output +} + +#[cfg(test)] +mod tests { + use anyhow::Result; + + use crate::generate_all::Mode; + + use super::{Args, main}; + + #[test] + fn ty_rules_up_to_date() -> Result<()> { + main(&Args { mode: Mode::Check }) + } +} diff --git a/crates/ruff_dev/src/generate_ty_schema.rs b/crates/ruff_dev/src/generate_ty_schema.rs new file mode 100644 index 0000000000000..eac09963b36ea --- /dev/null +++ b/crates/ruff_dev/src/generate_ty_schema.rs @@ -0,0 +1,70 @@ +use std::fs; +use std::path::PathBuf; + +use anyhow::{Result, bail}; +use pretty_assertions::StrComparison; +use schemars::schema_for; + +use crate::ROOT_DIR; +use crate::generate_all::{Mode, REGENERATE_ALL_COMMAND}; +use ty_project::metadata::options::Options; + +#[derive(clap::Args)] +pub(crate) struct Args { + /// Write the generated table to stdout (rather than to `ty.schema.json`). + #[arg(long, default_value_t, value_enum)] + pub(crate) mode: Mode, +} + +pub(crate) fn main(args: &Args) -> Result<()> { + let schema = schema_for!(Options); + let schema_string = serde_json::to_string_pretty(&schema).unwrap(); + let filename = "ty.schema.json"; + let schema_path = PathBuf::from(ROOT_DIR).join(filename); + + match args.mode { + Mode::DryRun => { + println!("{schema_string}"); + } + Mode::Check => { + let current = fs::read_to_string(schema_path)?; + if current == schema_string { + println!("Up-to-date: {filename}"); + } else { + let comparison = StrComparison::new(¤t, &schema_string); + bail!("{filename} changed, please run `{REGENERATE_ALL_COMMAND}`:\n{comparison}"); + } + } + Mode::Write => { + let current = fs::read_to_string(&schema_path)?; + if current == schema_string { + println!("Up-to-date: {filename}"); + } else { + println!("Updating: {filename}"); + fs::write(schema_path, schema_string.as_bytes())?; + } + } + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use anyhow::Result; + use std::env; + + use crate::generate_all::Mode; + + use super::{Args, main}; + + #[test] + fn test_generate_json_schema() -> Result<()> { + let mode = if env::var("TY_UPDATE_SCHEMA").as_deref() == Ok("1") { + Mode::Write + } else { + Mode::Check + }; + main(&Args { mode }) + } +} diff --git a/crates/ruff_dev/src/main.rs b/crates/ruff_dev/src/main.rs index 83bf95f490289..e598bbc8fe95f 100644 --- a/crates/ruff_dev/src/main.rs +++ b/crates/ruff_dev/src/main.rs @@ -2,6 +2,8 @@ //! //! Within the ruff repository you can run it with `cargo dev`. +#![allow(clippy::print_stdout, clippy::print_stderr)] + use anyhow::Result; use clap::{Parser, Subcommand}; use ruff::{args::GlobalConfigArgs, check}; @@ -15,6 +17,10 @@ mod generate_docs; mod generate_json_schema; mod generate_options; mod generate_rules_table; +mod generate_ty_cli_reference; +mod generate_ty_options; +mod generate_ty_rules; +mod generate_ty_schema; mod print_ast; mod print_cst; mod print_tokens; @@ -33,16 +39,20 @@ struct Args { } #[derive(Subcommand)] -#[allow(clippy::large_enum_variant)] +#[expect(clippy::large_enum_variant)] enum Command { /// Run all code and documentation generation steps. GenerateAll(generate_all::Args), /// Generate JSON schema for the TOML configuration file. GenerateJSONSchema(generate_json_schema::Args), + /// Generate JSON schema for the ty TOML configuration file. + GenerateTySchema(generate_ty_schema::Args), /// Generate a Markdown-compatible table of supported lint rules. GenerateRulesTable, + GenerateTyRules(generate_ty_rules::Args), /// Generate a Markdown-compatible listing of configuration options. GenerateOptions, + GenerateTyOptions(generate_ty_options::Args), /// Generate CLI help. GenerateCliHelp(generate_cli_help::Args), /// Generate Markdown docs. @@ -79,12 +89,15 @@ fn main() -> Result<ExitCode> { command, global_options, } = Args::parse(); - #[allow(clippy::print_stdout)] + #[expect(clippy::print_stdout)] match command { Command::GenerateAll(args) => generate_all::main(&args)?, Command::GenerateJSONSchema(args) => generate_json_schema::main(&args)?, + Command::GenerateTySchema(args) => generate_ty_schema::main(&args)?, Command::GenerateRulesTable => println!("{}", generate_rules_table::generate()), + Command::GenerateTyRules(args) => generate_ty_rules::main(&args)?, Command::GenerateOptions => println!("{}", generate_options::generate()), + Command::GenerateTyOptions(args) => generate_ty_options::main(&args)?, Command::GenerateCliHelp(args) => generate_cli_help::main(&args)?, Command::GenerateDocs(args) => generate_docs::main(&args)?, Command::PrintAST(args) => print_ast::main(&args)?, diff --git a/crates/ruff_dev/src/print_ast.rs b/crates/ruff_dev/src/print_ast.rs index 35206ca45ec13..7dc1c4e80185d 100644 --- a/crates/ruff_dev/src/print_ast.rs +++ b/crates/ruff_dev/src/print_ast.rs @@ -1,5 +1,4 @@ //! Print the AST for a given Python file. -#![allow(clippy::print_stdout, clippy::print_stderr)] use std::path::PathBuf; @@ -7,7 +6,7 @@ use anyhow::Result; use ruff_linter::source_kind::SourceKind; use ruff_python_ast::PySourceType; -use ruff_python_parser::{parse, AsMode}; +use ruff_python_parser::{ParseOptions, parse}; #[derive(clap::Args)] pub(crate) struct Args { @@ -24,7 +23,8 @@ pub(crate) fn main(args: &Args) -> Result<()> { args.file.display() ) })?; - let python_ast = parse(source_kind.source_code(), source_type.as_mode())?.into_syntax(); + let python_ast = + parse(source_kind.source_code(), ParseOptions::from(source_type))?.into_syntax(); println!("{python_ast:#?}"); Ok(()) } diff --git a/crates/ruff_dev/src/print_cst.rs b/crates/ruff_dev/src/print_cst.rs index 166923486e149..e85c4b447567a 100644 --- a/crates/ruff_dev/src/print_cst.rs +++ b/crates/ruff_dev/src/print_cst.rs @@ -1,10 +1,9 @@ //! Print the `LibCST` CST for a given Python file. -#![allow(clippy::print_stdout, clippy::print_stderr)] use std::fs; use std::path::PathBuf; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; #[derive(clap::Args)] pub(crate) struct Args { diff --git a/crates/ruff_dev/src/print_tokens.rs b/crates/ruff_dev/src/print_tokens.rs index 2c83affbb5f39..73c7844ccebe2 100644 --- a/crates/ruff_dev/src/print_tokens.rs +++ b/crates/ruff_dev/src/print_tokens.rs @@ -1,5 +1,4 @@ //! Print the token stream for a given Python file. -#![allow(clippy::print_stdout, clippy::print_stderr)] use std::path::PathBuf; diff --git a/crates/ruff_dev/src/round_trip.rs b/crates/ruff_dev/src/round_trip.rs index 6a070c65c1836..7501790b509bc 100644 --- a/crates/ruff_dev/src/round_trip.rs +++ b/crates/ruff_dev/src/round_trip.rs @@ -1,5 +1,4 @@ //! Run round-trip source code generation on a given Python or Jupyter notebook file. -#![allow(clippy::print_stdout, clippy::print_stderr)] use std::fs; use std::path::PathBuf; diff --git a/crates/ruff_diagnostics/src/diagnostic.rs b/crates/ruff_diagnostics/src/diagnostic.rs index 84da5f3904607..f9a93c78f140a 100644 --- a/crates/ruff_diagnostics/src/diagnostic.rs +++ b/crates/ruff_diagnostics/src/diagnostic.rs @@ -1,35 +1,29 @@ use anyhow::Result; -use log::error; -#[cfg(feature = "serde")] -use serde::{Deserialize, Serialize}; +use log::debug; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::Fix; +use crate::{Fix, Violation}; #[derive(Debug, PartialEq, Eq, Clone)] -#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] -pub struct DiagnosticKind { +pub struct Diagnostic { /// The identifier of the diagnostic, used to align the diagnostic with a rule. - pub name: String, + pub name: &'static str, /// The message body to display to the user, to explain the diagnostic. pub body: String, /// The message to display to the user, to explain the suggested fix. pub suggestion: Option<String>, -} - -#[derive(Debug, PartialEq, Eq, Clone)] -pub struct Diagnostic { - pub kind: DiagnosticKind, pub range: TextRange, pub fix: Option<Fix>, pub parent: Option<TextSize>, } impl Diagnostic { - pub fn new<T: Into<DiagnosticKind>>(kind: T, range: TextRange) -> Self { + pub fn new<T: Violation>(kind: T, range: TextRange) -> Self { Self { - kind: kind.into(), + name: T::rule_name(), + body: Violation::message(&kind), + suggestion: Violation::fix_title(&kind), range, fix: None, parent: None, @@ -56,7 +50,7 @@ impl Diagnostic { pub fn try_set_fix(&mut self, func: impl FnOnce() -> Result<Fix>) { match func() { Ok(fix) => self.fix = Some(fix), - Err(err) => error!("Failed to create fix for {}: {}", self.kind.name, err), + Err(err) => debug!("Failed to create fix for {}: {}", self.name, err), } } @@ -67,7 +61,7 @@ impl Diagnostic { match func() { Ok(None) => {} Ok(Some(fix)) => self.fix = Some(fix), - Err(err) => error!("Failed to create fix for {}: {}", self.kind.name, err), + Err(err) => debug!("Failed to create fix for {}: {}", self.name, err), } } diff --git a/crates/ruff_diagnostics/src/edit.rs b/crates/ruff_diagnostics/src/edit.rs index 5bd4e629b4c95..1195fdc540ed9 100644 --- a/crates/ruff_diagnostics/src/edit.rs +++ b/crates/ruff_diagnostics/src/edit.rs @@ -62,6 +62,10 @@ impl Edit { self.content.as_deref() } + pub fn into_content(self) -> Option<Box<str>> { + self.content + } + fn kind(&self) -> EditOperationKind { if self.content.is_none() { EditOperationKind::Deletion diff --git a/crates/ruff_diagnostics/src/fix.rs b/crates/ruff_diagnostics/src/fix.rs index 751258508f718..2db9d799fe35b 100644 --- a/crates/ruff_diagnostics/src/fix.rs +++ b/crates/ruff_diagnostics/src/fix.rs @@ -11,15 +11,21 @@ use crate::edit::Edit; #[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))] pub enum Applicability { /// The fix is unsafe and should only be displayed for manual application by the user. + /// /// The fix is likely to be incorrect or the resulting code may have invalid syntax. DisplayOnly, /// The fix is unsafe and should only be applied with user opt-in. - /// The fix may be what the user intended, but it is uncertain; the resulting code will have valid syntax. + /// + /// The fix may be what the user intended, but it is uncertain. The resulting code will have + /// valid syntax, but may lead to a change in runtime behavior, the removal of user comments, + /// or both. Unsafe, /// The fix is safe and can always be applied. - /// The fix is definitely what the user intended, or it maintains the exact meaning of the code. + /// + /// The fix is definitely what the user intended, or maintains the exact meaning of the code. + /// User comments are preserved, unless the fix removes an entire statement or expression. Safe, } diff --git a/crates/ruff_diagnostics/src/lib.rs b/crates/ruff_diagnostics/src/lib.rs index f21419abe9cd4..fd97fc1408472 100644 --- a/crates/ruff_diagnostics/src/lib.rs +++ b/crates/ruff_diagnostics/src/lib.rs @@ -1,8 +1,8 @@ -pub use diagnostic::{Diagnostic, DiagnosticKind}; +pub use diagnostic::Diagnostic; pub use edit::Edit; pub use fix::{Applicability, Fix, IsolationLevel}; pub use source_map::{SourceMap, SourceMarker}; -pub use violation::{AlwaysFixableViolation, FixAvailability, Violation}; +pub use violation::{AlwaysFixableViolation, FixAvailability, Violation, ViolationMetadata}; mod diagnostic; mod edit; diff --git a/crates/ruff_diagnostics/src/violation.rs b/crates/ruff_diagnostics/src/violation.rs index 70fcdd6c94bb2..d0c7b9c763cd9 100644 --- a/crates/ruff_diagnostics/src/violation.rs +++ b/crates/ruff_diagnostics/src/violation.rs @@ -17,7 +17,16 @@ impl Display for FixAvailability { } } -pub trait Violation: Debug + PartialEq + Eq { +pub trait ViolationMetadata { + /// Returns the rule name of this violation + fn rule_name() -> &'static str; + + /// Returns an explanation of what this violation catches, + /// why it's bad, and what users should do instead. + fn explain() -> Option<&'static str>; +} + +pub trait Violation: ViolationMetadata { /// `None` in the case a fix is never available or otherwise Some /// [`FixAvailability`] describing the available fix. const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; @@ -41,7 +50,7 @@ pub trait Violation: Debug + PartialEq + Eq { /// This trait exists just to make implementing the [`Violation`] trait more /// convenient for violations that can always be fixed. -pub trait AlwaysFixableViolation: Debug + PartialEq + Eq { +pub trait AlwaysFixableViolation: ViolationMetadata { /// The message used to describe the violation. fn message(&self) -> String; diff --git a/crates/ruff_formatter/src/arguments.rs b/crates/ruff_formatter/src/arguments.rs index d26306c4ea502..6beb19c534844 100644 --- a/crates/ruff_formatter/src/arguments.rs +++ b/crates/ruff_formatter/src/arguments.rs @@ -17,7 +17,7 @@ impl<'fmt, Context> Argument<'fmt, Context> { /// Called by the [ruff_formatter::format_args] macro. #[doc(hidden)] #[inline] - pub fn new<F: Format<Context>>(value: &'fmt F) -> Self { + pub const fn new<F: Format<Context>>(value: &'fmt F) -> Self { Self { value } } @@ -55,7 +55,7 @@ pub struct Arguments<'fmt, Context>(pub &'fmt [Argument<'fmt, Context>]); impl<'fmt, Context> Arguments<'fmt, Context> { #[doc(hidden)] #[inline] - pub fn new(arguments: &'fmt [Argument<'fmt, Context>]) -> Self { + pub const fn new(arguments: &'fmt [Argument<'fmt, Context>]) -> Self { Self(arguments) } @@ -98,7 +98,7 @@ impl<'fmt, Context> From<&'fmt Argument<'fmt, Context>> for Arguments<'fmt, Cont mod tests { use crate::format_element::tag::Tag; use crate::prelude::*; - use crate::{format_args, write, FormatState, VecBuffer}; + use crate::{FormatState, VecBuffer, format_args, write}; #[test] fn test_nesting() { diff --git a/crates/ruff_formatter/src/buffer.rs b/crates/ruff_formatter/src/buffer.rs index 94b09df03913c..90822020a3124 100644 --- a/crates/ruff_formatter/src/buffer.rs +++ b/crates/ruff_formatter/src/buffer.rs @@ -1,10 +1,11 @@ -use super::{write, Arguments, FormatElement}; +use super::{Arguments, FormatElement, write}; use crate::format_element::Interned; -use crate::prelude::LineMode; +use crate::prelude::{LineMode, Tag}; use crate::{FormatResult, FormatState}; use rustc_hash::FxHashMap; use std::any::{Any, TypeId}; use std::fmt::Debug; +use std::num::NonZeroUsize; use std::ops::{Deref, DerefMut}; /// A trait for writing or formatting into [`FormatElement`]-accepting buffers or streams. @@ -262,7 +263,7 @@ impl<'inner, Context, Inspector> Inspect<'inner, Context, Inspector> { } } -impl<'inner, Context, Inspector> Buffer for Inspect<'inner, Context, Inspector> +impl<Context, Inspector> Buffer for Inspect<'_, Context, Inspector> where Inspector: FnMut(&FormatElement), { @@ -294,10 +295,12 @@ where } } -/// A Buffer that removes any soft line breaks. +/// A Buffer that removes any soft line breaks or [`if_group_breaks`](crate::builders::if_group_breaks) elements. /// /// - Removes [`lines`](FormatElement::Line) with the mode [`Soft`](LineMode::Soft). /// - Replaces [`lines`](FormatElement::Line) with the mode [`Soft`](LineMode::SoftOrSpace) with a [`Space`](FormatElement::Space) +/// - Removes [`if_group_breaks`](crate::builders::if_group_breaks) and all its content. +/// - Unwraps the content of [`if_group_fits_on_line`](crate::builders::if_group_fits_on_line) elements (but retains it). /// /// # Examples /// @@ -350,6 +353,8 @@ pub struct RemoveSoftLinesBuffer<'a, Context> { /// It's fine to not snapshot the cache. The worst that can happen is that it holds on interned elements /// that are now unused. But there's little harm in that and the cache is cleaned when dropping the buffer. interned_cache: FxHashMap<Interned, Interned>, + + state: RemoveSoftLineBreaksState, } impl<'a, Context> RemoveSoftLinesBuffer<'a, Context> { @@ -357,6 +362,7 @@ impl<'a, Context> RemoveSoftLinesBuffer<'a, Context> { pub fn new(inner: &'a mut dyn Buffer<Context = Context>) -> Self { Self { inner, + state: RemoveSoftLineBreaksState::default(), interned_cache: FxHashMap::default(), } } @@ -375,15 +381,18 @@ fn clean_interned( if let Some(cleaned) = interned_cache.get(interned) { cleaned.clone() } else { + let mut state = RemoveSoftLineBreaksState::default(); + // Find the first soft line break element or interned element that must be changed let result = interned .iter() .enumerate() .find_map(|(index, element)| match element { - FormatElement::Line(LineMode::Soft | LineMode::SoftOrSpace) => { + FormatElement::Line(LineMode::SoftOrSpace) => { let mut cleaned = Vec::new(); - cleaned.extend_from_slice(&interned[..index]); - Some((cleaned, &interned[index..])) + let (before, after) = interned.split_at(index); + cleaned.extend_from_slice(before); + Some((cleaned, &after[1..])) } FormatElement::Interned(inner) => { let cleaned_inner = clean_interned(inner, interned_cache); @@ -398,19 +407,32 @@ fn clean_interned( } } - _ => None, + element => { + if state.should_drop(element) { + let mut cleaned = Vec::new(); + let (before, after) = interned.split_at(index); + cleaned.extend_from_slice(before); + Some((cleaned, &after[1..])) + } else { + None + } + } }); let result = match result { // Copy the whole interned buffer so that becomes possible to change the necessary elements. Some((mut cleaned, rest)) => { for element in rest { + if state.should_drop(element) { + continue; + } + let element = match element { - FormatElement::Line(LineMode::Soft) => continue, FormatElement::Line(LineMode::SoftOrSpace) => FormatElement::Space, FormatElement::Interned(interned) => { FormatElement::Interned(clean_interned(interned, interned_cache)) } + element => element.clone(), }; cleaned.push(element); @@ -431,12 +453,16 @@ impl<Context> Buffer for RemoveSoftLinesBuffer<'_, Context> { type Context = Context; fn write_element(&mut self, element: FormatElement) { + if self.state.should_drop(&element) { + return; + } + let element = match element { - FormatElement::Line(LineMode::Soft) => return, FormatElement::Line(LineMode::SoftOrSpace) => FormatElement::Space, FormatElement::Interned(interned) => { FormatElement::Interned(self.clean_interned(&interned)) } + element => element, }; @@ -456,14 +482,83 @@ impl<Context> Buffer for RemoveSoftLinesBuffer<'_, Context> { } fn snapshot(&self) -> BufferSnapshot { - self.inner.snapshot() + BufferSnapshot::Any(Box::new(RemoveSoftLinebreaksSnapshot { + inner: self.inner.snapshot(), + state: self.state, + })) } fn restore_snapshot(&mut self, snapshot: BufferSnapshot) { - self.inner.restore_snapshot(snapshot); + let RemoveSoftLinebreaksSnapshot { inner, state } = snapshot.unwrap_any(); + self.inner.restore_snapshot(inner); + self.state = state; + } +} + +#[derive(Copy, Clone, Debug, Default)] +enum RemoveSoftLineBreaksState { + #[default] + Default, + InIfGroupBreaks { + conditional_content_level: NonZeroUsize, + }, +} + +impl RemoveSoftLineBreaksState { + fn should_drop(&mut self, element: &FormatElement) -> bool { + match self { + Self::Default => match element { + FormatElement::Line(LineMode::Soft) => true, + + // Entered the start of an `if_group_breaks` or `if_group_fits` + // For `if_group_breaks`: Remove the start and end tag and all content in between. + // For `if_group_fits_on_line`: Unwrap the content. This is important because the enclosing group + // might still *expand* if the content exceeds the line width limit, in which case the + // `if_group_fits_on_line` content would be removed. + FormatElement::Tag(Tag::StartConditionalContent(condition)) => { + if condition.mode.is_expanded() { + *self = Self::InIfGroupBreaks { + conditional_content_level: NonZeroUsize::new(1).unwrap(), + }; + } + true + } + FormatElement::Tag(Tag::EndConditionalContent) => true, + _ => false, + }, + Self::InIfGroupBreaks { + conditional_content_level, + } => { + match element { + // A nested `if_group_breaks` or `if_group_fits_on_line` + FormatElement::Tag(Tag::StartConditionalContent(_)) => { + *conditional_content_level = conditional_content_level.saturating_add(1); + } + // The end of an `if_group_breaks` or `if_group_fits_on_line`. + FormatElement::Tag(Tag::EndConditionalContent) => { + if let Some(level) = NonZeroUsize::new(conditional_content_level.get() - 1) + { + *conditional_content_level = level; + } else { + // Found the end tag of the initial `if_group_breaks`. Skip this element but retain + // the elements coming after + *self = RemoveSoftLineBreaksState::Default; + } + } + _ => {} + } + + true + } + } } } +struct RemoveSoftLinebreaksSnapshot { + inner: BufferSnapshot, + state: RemoveSoftLineBreaksState, +} + pub trait BufferExtensions: Buffer + Sized { /// Returns a new buffer that calls the passed inspector for every element that gets written to the output #[must_use] @@ -561,7 +656,7 @@ where let elements = buffer.elements(); let recorded = if self.start > elements.len() { - // May happen if buffer was rewinded. + // May happen if buffer was rewound. &[] } else { &elements[self.start..] diff --git a/crates/ruff_formatter/src/builders.rs b/crates/ruff_formatter/src/builders.rs index 21ab988b5e38e..48e29795cc933 100644 --- a/crates/ruff_formatter/src/builders.rs +++ b/crates/ruff_formatter/src/builders.rs @@ -2,14 +2,14 @@ use std::cell::Cell; use std::marker::PhantomData; use std::num::NonZeroU8; -use ruff_text_size::TextRange; #[allow(clippy::enum_glob_use)] use Tag::*; +use ruff_text_size::TextRange; use crate::format_element::tag::{Condition, Tag}; use crate::prelude::tag::{DedentMode, GroupMode, LabelId}; use crate::prelude::*; -use crate::{write, Argument, Arguments, FormatContext, FormatOptions, GroupId, TextSize}; +use crate::{Argument, Arguments, FormatContext, FormatOptions, GroupId, TextSize, write}; use crate::{Buffer, VecBuffer}; /// A line break that only gets printed if the enclosing `Group` doesn't fit on a single line. @@ -402,7 +402,10 @@ where } fn debug_assert_no_newlines(text: &str) { - debug_assert!(!text.contains('\r'), "The content '{text}' contains an unsupported '\\r' line terminator character but text must only use line feeds '\\n' as line separator. Use '\\n' instead of '\\r' and '\\r\\n' to insert a line break in strings."); + debug_assert!( + !text.contains('\r'), + "The content '{text}' contains an unsupported '\\r' line terminator character but text must only use line feeds '\\n' as line separator. Use '\\n' instead of '\\r' and '\\r\\n' to insert a line break in strings." + ); } /// Pushes some content to the end of the current line. @@ -1388,7 +1391,7 @@ pub fn soft_space_or_block_indent<Context>(content: &impl Format<Context>) -> Bl pub fn group<Context>(content: &impl Format<Context>) -> Group<Context> { Group { content: Argument::new(content), - group_id: None, + id: None, should_expand: false, } } @@ -1396,14 +1399,14 @@ pub fn group<Context>(content: &impl Format<Context>) -> Group<Context> { #[derive(Copy, Clone)] pub struct Group<'a, Context> { content: Argument<'a, Context>, - group_id: Option<GroupId>, + id: Option<GroupId>, should_expand: bool, } impl<Context> Group<'_, Context> { #[must_use] - pub fn with_group_id(mut self, group_id: Option<GroupId>) -> Self { - self.group_id = group_id; + pub fn with_id(mut self, group_id: Option<GroupId>) -> Self { + self.id = group_id; self } @@ -1429,7 +1432,7 @@ impl<Context> Format<Context> for Group<'_, Context> { }; f.write_element(FormatElement::Tag(StartGroup( - tag::Group::new().with_id(self.group_id).with_mode(mode), + tag::Group::new().with_id(self.id).with_mode(mode), ))); Arguments::from(&self.content).fmt(f)?; @@ -1443,7 +1446,7 @@ impl<Context> Format<Context> for Group<'_, Context> { impl<Context> std::fmt::Debug for Group<'_, Context> { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("Group") - .field("group_id", &self.group_id) + .field("id", &self.id) .field("should_expand", &self.should_expand) .field("content", &"{{content}}") .finish() @@ -1642,7 +1645,7 @@ impl<Context> std::fmt::Debug for BestFitParenthesize<'_, Context> { /// soft_line_break(), /// if_group_breaks(&token(")")) /// ]) -/// .with_group_id(Some(parentheses_id)) +/// .with_id(Some(parentheses_id)) /// .fmt(f) /// }); /// @@ -1991,7 +1994,7 @@ impl<Context> IfGroupBreaks<'_, Context> { /// })), /// token("]") /// ], - /// ).with_group_id(Some(group_id)) + /// ).with_id(Some(group_id)) /// ]) /// })])?; /// @@ -2046,7 +2049,7 @@ impl<Context> std::fmt::Debug for IfGroupBreaks<'_, Context> { /// let id = f.group_id("head"); /// /// write!(f, [ -/// group(&token("Head")).with_group_id(Some(id)), +/// group(&token("Head")).with_id(Some(id)), /// if_group_breaks(&indent(&token("indented"))).with_group_id(Some(id)), /// if_group_fits_on_line(&token("indented")).with_group_id(Some(id)) /// ]) @@ -2071,7 +2074,7 @@ impl<Context> std::fmt::Debug for IfGroupBreaks<'_, Context> { /// let group_id = f.group_id("header"); /// /// write!(f, [ -/// group(&token("(aLongHeaderThatBreaksForSomeReason) =>")).with_group_id(Some(group_id)), +/// group(&token("(aLongHeaderThatBreaksForSomeReason) =>")).with_id(Some(group_id)), /// indent_if_group_breaks(&format_args![hard_line_break(), token("a => b")], group_id) /// ]) /// }); @@ -2101,7 +2104,7 @@ impl<Context> std::fmt::Debug for IfGroupBreaks<'_, Context> { /// let group_id = f.group_id("header"); /// /// write!(f, [ -/// group(&token("(aLongHeaderThatBreaksForSomeReason) =>")).with_group_id(Some(group_id)), +/// group(&token("(aLongHeaderThatBreaksForSomeReason) =>")).with_id(Some(group_id)), /// indent_if_group_breaks(&format_args![hard_line_break(), token("a => b")], group_id) /// ]) /// }); @@ -2564,7 +2567,7 @@ impl<'a, Context> BestFitting<'a, Context> { /// # Panics /// /// When the slice contains less than two variants. - pub fn from_arguments_unchecked(variants: Arguments<'a, Context>) -> Self { + pub const fn from_arguments_unchecked(variants: Arguments<'a, Context>) -> Self { assert!( variants.0.len() >= 2, "Requires at least the least expanded and most expanded variants" @@ -2572,7 +2575,7 @@ impl<'a, Context> BestFitting<'a, Context> { Self { variants, - mode: BestFittingMode::default(), + mode: BestFittingMode::FirstLine, } } diff --git a/crates/ruff_formatter/src/diagnostics.rs b/crates/ruff_formatter/src/diagnostics.rs index 00eae242e889d..eb2f1435b3af9 100644 --- a/crates/ruff_formatter/src/diagnostics.rs +++ b/crates/ruff_formatter/src/diagnostics.rs @@ -1,5 +1,5 @@ -use crate::prelude::TagKind; use crate::GroupId; +use crate::prelude::TagKind; use ruff_text_size::TextRange; use std::error::Error; @@ -29,16 +29,22 @@ pub enum FormatError { impl std::fmt::Display for FormatError { fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { - FormatError::SyntaxError {message} => { + FormatError::SyntaxError { message } => { std::write!(fmt, "syntax error: {message}") - }, + } FormatError::RangeError { input, tree } => std::write!( fmt, "formatting range {input:?} is larger than syntax tree {tree:?}" ), - FormatError::InvalidDocument(error) => std::write!(fmt, "Invalid document: {error}\n\n This is an internal Rome error. Please report if necessary."), + FormatError::InvalidDocument(error) => std::write!( + fmt, + "Invalid document: {error}\n\n This is an internal Rome error. Please report if necessary." + ), FormatError::PoorLayout => { - std::write!(fmt, "Poor layout: The formatter wasn't able to pick a good layout for your document. This is an internal Rome error. Please report if necessary.") + std::write!( + fmt, + "Poor layout: The formatter wasn't able to pick a good layout for your document. This is an internal Rome error. Please report if necessary." + ) } } } @@ -139,24 +145,37 @@ impl std::fmt::Display for InvalidDocumentError { InvalidDocumentError::ExpectedStart { expected_start, actual, - } => { - match actual { - ActualStart::EndOfDocument => { - std::write!(f, "Expected start tag of kind {expected_start:?} but at the end of document.") - } - ActualStart::Start(start) => { - std::write!(f, "Expected start tag of kind {expected_start:?} but found start tag of kind {start:?}.") - } - ActualStart::End(end) => { - std::write!(f, "Expected start tag of kind {expected_start:?} but found end tag of kind {end:?}.") - } - ActualStart::Content => { - std::write!(f, "Expected start tag of kind {expected_start:?} but found non-tag element.") - } + } => match actual { + ActualStart::EndOfDocument => { + std::write!( + f, + "Expected start tag of kind {expected_start:?} but at the end of document." + ) } - } + ActualStart::Start(start) => { + std::write!( + f, + "Expected start tag of kind {expected_start:?} but found start tag of kind {start:?}." + ) + } + ActualStart::End(end) => { + std::write!( + f, + "Expected start tag of kind {expected_start:?} but found end tag of kind {end:?}." + ) + } + ActualStart::Content => { + std::write!( + f, + "Expected start tag of kind {expected_start:?} but found non-tag element." + ) + } + }, InvalidDocumentError::UnknownGroupId { group_id } => { - std::write!(f, "Encountered unknown group id {group_id:?}. Ensure that the group with the id {group_id:?} exists and that the group is a parent of or comes before the element referring to it.") + std::write!( + f, + "Encountered unknown group id {group_id:?}. Ensure that the group with the id {group_id:?} exists and that the group is a parent of or comes before the element referring to it." + ) } } } diff --git a/crates/ruff_formatter/src/format_element.rs b/crates/ruff_formatter/src/format_element.rs index eb42a44bc0765..1d2c502b63acd 100644 --- a/crates/ruff_formatter/src/format_element.rs +++ b/crates/ruff_formatter/src/format_element.rs @@ -442,7 +442,7 @@ impl<'a> Iterator for BestFittingVariantsIter<'a> { } } -impl<'a> DoubleEndedIterator for BestFittingVariantsIter<'a> { +impl DoubleEndedIterator for BestFittingVariantsIter<'_> { fn next_back(&mut self) -> Option<Self::Item> { let start_position = self.elements.iter().rposition(|element| { matches!(element, FormatElement::Tag(Tag::StartBestFittingEntry)) @@ -519,7 +519,7 @@ impl TextWidth { let char_width = match c { '\t' => indent_width.value(), '\n' => return TextWidth::Multiline, - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] c => c.width().unwrap_or(0) as u32, }; width += char_width; @@ -543,7 +543,7 @@ impl TextWidth { #[cfg(test)] mod tests { - use crate::format_element::{normalize_newlines, LINE_TERMINATORS}; + use crate::format_element::{LINE_TERMINATORS, normalize_newlines}; #[test] fn test_normalize_newlines() { diff --git a/crates/ruff_formatter/src/format_element/document.rs b/crates/ruff_formatter/src/format_element/document.rs index 68d8ee906ba1e..2f19f13c0fa09 100644 --- a/crates/ruff_formatter/src/format_element/document.rs +++ b/crates/ruff_formatter/src/format_element/document.rs @@ -8,8 +8,8 @@ use crate::prelude::tag::GroupMode; use crate::prelude::*; use crate::source_code::SourceCode; use crate::{ - format, write, BufferExtensions, Format, FormatContext, FormatElement, FormatOptions, - FormatResult, Formatter, IndentStyle, IndentWidth, LineWidth, PrinterOptions, + BufferExtensions, Format, FormatContext, FormatElement, FormatOptions, FormatResult, Formatter, + IndentStyle, IndentWidth, LineWidth, PrinterOptions, format, write, }; use super::tag::Tag; @@ -151,7 +151,7 @@ impl Document { propagate_expands(self, &mut enclosing, &mut interned); } - pub fn display<'a>(&'a self, source_code: SourceCode<'a>) -> DisplayDocument { + pub fn display<'a>(&'a self, source_code: SourceCode<'a>) -> DisplayDocument<'a> { DisplayDocument { elements: self.elements.as_slice(), source_code, @@ -280,7 +280,7 @@ impl Format<IrFormatContext<'_>> for &[FormatElement] { | FormatElement::SourceCodeSlice { .. }) => { fn write_escaped(element: &FormatElement, f: &mut Formatter<IrFormatContext>) { let (text, text_width) = match element { - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] FormatElement::Token { text } => { (*text, TextWidth::Width(Width::new(text.len() as u32))) } @@ -610,7 +610,7 @@ impl Format<IrFormatContext<'_>> for &[FormatElement] { } } - StartEntry | StartBestFittingEntry { .. } => { + StartEntry | StartBestFittingEntry => { // handled after the match for all start tags } EndEntry | EndBestFittingEntry => write!(f, [ContentArrayEnd])?, @@ -630,7 +630,7 @@ impl Format<IrFormatContext<'_>> for &[FormatElement] { | EndVerbatim => { write!(f, [ContentArrayEnd, token(")")])?; } - }; + } if tag.is_start() { write!(f, [ContentArrayStart])?; @@ -811,8 +811,8 @@ mod tests { use ruff_text_size::{TextRange, TextSize}; use crate::prelude::*; - use crate::{format, format_args, write}; use crate::{SimpleFormatContext, SourceCode}; + use crate::{format, format_args, write}; #[test] fn display_elements() { diff --git a/crates/ruff_formatter/src/format_element/tag.rs b/crates/ruff_formatter/src/format_element/tag.rs index 853008e516be6..606922648241d 100644 --- a/crates/ruff_formatter/src/format_element/tag.rs +++ b/crates/ruff_formatter/src/format_element/tag.rs @@ -144,7 +144,7 @@ impl Tag { StartVerbatim(_) | EndVerbatim => TagKind::Verbatim, StartLabelled(_) | EndLabelled => TagKind::Labelled, StartFitsExpanded { .. } | EndFitsExpanded => TagKind::FitsExpanded, - StartBestFittingEntry { .. } | EndBestFittingEntry => TagKind::BestFittingEntry, + StartBestFittingEntry | EndBestFittingEntry => TagKind::BestFittingEntry, StartBestFitParenthesize { .. } | EndBestFitParenthesize => { TagKind::BestFitParenthesize } @@ -370,7 +370,10 @@ impl PartialEq for LabelId { #[cfg(debug_assertions)] { if is_equal { - assert_eq!(self.name, other.name, "Two `LabelId`s with different names have the same `value`. Are you mixing labels of two different `LabelDefinition` or are the values returned by the `LabelDefinition` not unique?"); + assert_eq!( + self.name, other.name, + "Two `LabelId`s with different names have the same `value`. Are you mixing labels of two different `LabelDefinition` or are the values returned by the `LabelDefinition` not unique?" + ); } } @@ -379,7 +382,7 @@ impl PartialEq for LabelId { } impl LabelId { - #[allow(clippy::needless_pass_by_value)] + #[expect(clippy::needless_pass_by_value)] pub fn of<T: LabelDefinition>(label: T) -> Self { Self { value: label.value(), diff --git a/crates/ruff_formatter/src/lib.rs b/crates/ruff_formatter/src/lib.rs index 0a81cb121902e..133b92108bb8b 100644 --- a/crates/ruff_formatter/src/lib.rs +++ b/crates/ruff_formatter/src/lib.rs @@ -7,10 +7,10 @@ //! //! * [`Format`]: Implemented by objects that can be formatted. //! * [`FormatRule`]: Rule that knows how to format an object of another type. Useful in the situation where -//! it's necessary to implement [Format] on an object from another crate. This module defines the -//! [`FormatRefWithRule`] and [`FormatOwnedWithRule`] structs to pass an item with its corresponding rule. +//! it's necessary to implement [Format] on an object from another crate. This module defines the +//! [`FormatRefWithRule`] and [`FormatOwnedWithRule`] structs to pass an item with its corresponding rule. //! * [`FormatWithRule`] implemented by objects that know how to format another type. Useful for implementing -//! some reusable formatting logic inside of this module if the type itself doesn't implement [Format] +//! some reusable formatting logic inside of this module if the type itself doesn't implement [Format] //! //! ## Formatting Macros //! @@ -38,7 +38,7 @@ use crate::prelude::TagKind; use std::fmt; use std::fmt::{Debug, Display}; use std::marker::PhantomData; -use std::num::{NonZeroU16, NonZeroU8, TryFromIntError}; +use std::num::{NonZeroU8, NonZeroU16, TryFromIntError}; use crate::format_element::document::Document; use crate::printer::{Printer, PrinterOptions}; @@ -50,7 +50,7 @@ pub use builders::BestFitting; pub use source_code::{SourceCode, SourceCodeSlice}; pub use crate::diagnostics::{ActualStart, FormatError, InvalidDocumentError, PrintError}; -pub use format_element::{normalize_newlines, FormatElement, LINE_TERMINATORS}; +pub use format_element::{FormatElement, LINE_TERMINATORS, normalize_newlines}; pub use group_id::GroupId; use ruff_macros::CacheKey; use ruff_text_size::{TextLen, TextRange, TextSize}; @@ -92,7 +92,7 @@ impl std::fmt::Display for IndentStyle { } } -/// The visual width of a indentation. +/// The visual width of an indentation. /// /// Determines the visual width of a tab character (`\t`) and the number of /// spaces per indent when using [`IndentStyle::Space`]. @@ -207,7 +207,7 @@ pub trait FormatOptions { /// What's the max width of a line. Defaults to 80. fn line_width(&self) -> LineWidth; - /// Derives the print options from the these format options + /// Derives the print options from these format options fn as_print_options(&self) -> PrinterOptions; } @@ -470,13 +470,13 @@ impl Printed { for marker in self.sourcemap { // Take the closest start marker, but skip over start_markers that have the same start. if marker.source <= source_range.start() - && !start_marker.is_some_and(|existing| existing.source >= marker.source) + && start_marker.is_none_or(|existing| existing.source < marker.source) { start_marker = Some(marker); } if marker.source >= source_range.end() - && !end_marker.is_some_and(|existing| existing.source <= marker.source) + && end_marker.is_none_or(|existing| existing.source > marker.source) { end_marker = Some(marker); } @@ -925,7 +925,7 @@ pub struct FormatState<Context> { group_id_builder: UniqueGroupIdBuilder, } -#[allow(clippy::missing_fields_in_debug)] +#[expect(clippy::missing_fields_in_debug)] impl<Context> std::fmt::Debug for FormatState<Context> where Context: std::fmt::Debug, diff --git a/crates/ruff_formatter/src/macros.rs b/crates/ruff_formatter/src/macros.rs index 2e327739a9091..4d0d3ef234c80 100644 --- a/crates/ruff_formatter/src/macros.rs +++ b/crates/ruff_formatter/src/macros.rs @@ -328,16 +328,16 @@ macro_rules! format { /// [`MostExpanded`]: crate::format_element::BestFittingVariants::most_expanded #[macro_export] macro_rules! best_fitting { - ($least_expanded:expr, $($tail:expr),+ $(,)?) => {{ + ($least_expanded:expr, $($tail:expr),+ $(,)?) => { // OK because the macro syntax requires at least two variants. $crate::BestFitting::from_arguments_unchecked($crate::format_args!($least_expanded, $($tail),+)) - }} + } } #[cfg(test)] mod tests { use crate::prelude::*; - use crate::{write, FormatState, SimpleFormatOptions, VecBuffer}; + use crate::{FormatState, SimpleFormatOptions, VecBuffer, write}; struct TestFormat; @@ -386,7 +386,7 @@ mod tests { #[test] fn best_fitting_variants_print_as_lists() { use crate::prelude::*; - use crate::{format, format_args, Formatted}; + use crate::{Formatted, format, format_args}; // The second variant below should be selected when printing at a width of 30 let formatted_best_fitting = format!( @@ -398,34 +398,36 @@ mod tests { format_args![token( "Something that will not fit on a line with 30 character print width." )], - format_args![group(&format_args![ - token("Start"), - soft_line_break(), - group(&soft_block_indent(&format_args![ - token("1,"), - soft_line_break_or_space(), - token("2,"), - soft_line_break_or_space(), - token("3"), - ])), - soft_line_break_or_space(), - soft_block_indent(&format_args![ - token("1,"), - soft_line_break_or_space(), - token("2,"), + format_args![ + group(&format_args![ + token("Start"), + soft_line_break(), + group(&soft_block_indent(&format_args![ + token("1,"), + soft_line_break_or_space(), + token("2,"), + soft_line_break_or_space(), + token("3"), + ])), soft_line_break_or_space(), - group(&format_args!( - token("A,"), + soft_block_indent(&format_args![ + token("1,"), + soft_line_break_or_space(), + token("2,"), soft_line_break_or_space(), - token("B") - )), + group(&format_args!( + token("A,"), + soft_line_break_or_space(), + token("B") + )), + soft_line_break_or_space(), + token("3") + ]), soft_line_break_or_space(), - token("3") - ]), - soft_line_break_or_space(), - token("End") - ]) - .should_expand(true)], + token("End") + ]) + .should_expand(true) + ], format_args!(token("Most"), hard_line_break(), token("Expanded")) ] ] diff --git a/crates/ruff_formatter/src/prelude.rs b/crates/ruff_formatter/src/prelude.rs index fb8b58d6e3930..f12d7c8020b96 100644 --- a/crates/ruff_formatter/src/prelude.rs +++ b/crates/ruff_formatter/src/prelude.rs @@ -7,6 +7,6 @@ pub use crate::formatter::Formatter; pub use crate::printer::PrinterOptions; pub use crate::{ - best_fitting, dbg_write, format, format_args, write, Buffer as _, BufferExtensions, Format, - Format as _, FormatResult, FormatRule, FormatWithRule as _, SimpleFormatContext, + Buffer as _, BufferExtensions, Format, Format as _, FormatResult, FormatRule, + FormatWithRule as _, SimpleFormatContext, best_fitting, dbg_write, format, format_args, write, }; diff --git a/crates/ruff_formatter/src/printer/call_stack.rs b/crates/ruff_formatter/src/printer/call_stack.rs index aa5c73dfda597..7c57ff4b3efde 100644 --- a/crates/ruff_formatter/src/printer/call_stack.rs +++ b/crates/ruff_formatter/src/printer/call_stack.rs @@ -1,5 +1,5 @@ -use crate::format_element::tag::TagKind; use crate::format_element::PrintMode; +use crate::format_element::tag::TagKind; use crate::printer::stack::{Stack, StackedStack}; use crate::printer::{Indentation, MeasureMode}; use crate::{IndentStyle, InvalidDocumentError, PrintError, PrintResult}; diff --git a/crates/ruff_formatter/src/printer/line_suffixes.rs b/crates/ruff_formatter/src/printer/line_suffixes.rs index 309499d9a7866..3aa2591824850 100644 --- a/crates/ruff_formatter/src/printer/line_suffixes.rs +++ b/crates/ruff_formatter/src/printer/line_suffixes.rs @@ -1,5 +1,5 @@ -use crate::printer::call_stack::PrintElementArgs; use crate::FormatElement; +use crate::printer::call_stack::PrintElementArgs; /// Stores the queued line suffixes. #[derive(Debug, Default)] diff --git a/crates/ruff_formatter/src/printer/mod.rs b/crates/ruff_formatter/src/printer/mod.rs index 0a7bd8fedf7d7..2b52841beb0a5 100644 --- a/crates/ruff_formatter/src/printer/mod.rs +++ b/crates/ruff_formatter/src/printer/mod.rs @@ -10,7 +10,7 @@ use crate::format_element::document::Document; use crate::format_element::tag::{Condition, GroupMode}; use crate::format_element::{BestFittingMode, BestFittingVariants, LineMode, PrintMode}; use crate::prelude::tag::{DedentMode, Tag, TagKind, VerbatimKind}; -use crate::prelude::{tag, TextWidth}; +use crate::prelude::{TextWidth, tag}; use crate::printer::call_stack::{ CallStack, FitsCallStack, PrintCallStack, PrintElementArgs, StackFrame, }; @@ -331,7 +331,7 @@ impl<'a> Printer<'a> { FormatElement::Tag(StartVerbatim(kind)) => { if let VerbatimKind::Verbatim { length } = kind { // SAFETY: Ruff only supports formatting files <= 4GB - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] self.state.verbatim_markers.push(TextRange::at( TextSize::from(self.state.buffer.len() as u32), *length, @@ -362,9 +362,7 @@ impl<'a> Printer<'a> { stack.push(TagKind::FitsExpanded, args); } - FormatElement::Tag( - tag @ (StartLabelled(_) | StartEntry | StartBestFittingEntry { .. }), - ) => { + FormatElement::Tag(tag @ (StartLabelled(_) | StartEntry | StartBestFittingEntry)) => { stack.push(tag.kind(), args); } @@ -386,7 +384,7 @@ impl<'a> Printer<'a> { ) => { stack.pop(tag.kind())?; } - }; + } Ok(()) } @@ -466,7 +464,7 @@ impl<'a> Printer<'a> { self.push_marker(); match text { - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] Text::Token(token) => { self.state.buffer.push_str(token); self.state.line_width += token.len() as u32; @@ -497,12 +495,7 @@ impl<'a> Printer<'a> { dest: self.state.buffer.text_len(), }; - if self - .state - .source_markers - .last() - .map_or(true, |last| last != &marker) - { + if self.state.source_markers.last() != Some(&marker) { self.state.source_markers.push(marker); } } @@ -838,7 +831,7 @@ impl<'a> Printer<'a> { } else { self.state.buffer.push(char); - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] let char_width = if char == '\t' { self.options.indent_width.value() } else { @@ -899,13 +892,13 @@ struct PrinterState<'a> { line_suffixes: LineSuffixes<'a>, verbatim_markers: Vec<TextRange>, group_modes: GroupModes, - // Re-used queue to measure if a group fits. Optimisation to avoid re-allocating a new + // Reused queue to measure if a group fits. Optimisation to avoid re-allocating a new // vec every time a group gets measured fits_stack: Vec<StackFrame>, fits_queue: Vec<std::slice::Iter<'a, FormatElement>>, } -impl<'a> PrinterState<'a> { +impl PrinterState<'_> { fn with_capacity(capacity: usize) -> Self { Self { buffer: String::with_capacity(capacity), @@ -1049,8 +1042,6 @@ struct FitsMeasurer<'a, 'print> { bomb: DebugDropBomb, } -impl<'a, 'print> FitsMeasurer<'a, 'print> {} - impl<'a, 'print> FitsMeasurer<'a, 'print> { fn new_flat( print_queue: &'print PrintQueue<'a>, @@ -1208,7 +1199,7 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> { text_width: *text_width, }, args, - )) + )); } FormatElement::SourceCodeSlice { slice, text_width } => { let text = slice.text(self.printer.source_code); @@ -1423,7 +1414,7 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> { | StartVerbatim(_) | StartLabelled(_) | StartEntry - | StartBestFittingEntry { .. }), + | StartBestFittingEntry), ) => { self.stack.push(tag.kind(), args); } @@ -1489,7 +1480,7 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> { u32::from(indent.level()) * self.options().indent_width() + u32::from(indent.align()); match text { - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] Text::Token(token) => { self.state.line_width += token.len() as u32; } @@ -1520,7 +1511,7 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> { } } // SAFETY: A u32 is sufficient to format files <= 4GB - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] c => c.width().unwrap_or(0) as u32, }; self.state.line_width += char_width; @@ -1606,11 +1597,7 @@ enum Fits { impl From<bool> for Fits { fn from(value: bool) -> Self { - if value { - Fits::Yes - } else { - Fits::No - } + if value { Fits::Yes } else { Fits::No } } } @@ -1671,8 +1658,8 @@ mod tests { use crate::printer::{LineEnding, Printer, PrinterOptions}; use crate::source_code::SourceCode; use crate::{ - format_args, write, Document, FormatState, IndentStyle, IndentWidth, LineWidth, Printed, - VecBuffer, + Document, FormatState, IndentStyle, IndentWidth, LineWidth, Printed, VecBuffer, + format_args, write, }; fn format(root: &dyn Format<SimpleFormatContext>) -> Printed { @@ -1994,10 +1981,21 @@ two lines`, token("]") ]), token(";"), - line_suffix(&format_args![space(), token("// Using reserved width causes this content to not fit even though it's a line suffix element")], 93) + line_suffix( + &format_args![ + space(), + token( + "// Using reserved width causes this content to not fit even though it's a line suffix element" + ) + ], + 93 + ) ]); - assert_eq!(printed.as_code(), "[\n 1, 2, 3\n]; // Using reserved width causes this content to not fit even though it's a line suffix element"); + assert_eq!( + printed.as_code(), + "[\n 1, 2, 3\n]; // Using reserved width causes this content to not fit even though it's a line suffix element" + ); } #[test] @@ -2011,7 +2009,7 @@ two lines`, token("The referenced group breaks."), hard_line_break() ]) - .with_group_id(Some(group_id)), + .with_id(Some(group_id)), group(&format_args![ token("This group breaks because:"), soft_line_break_or_space(), @@ -2024,7 +2022,10 @@ two lines`, let printed = format(&content); - assert_eq!(printed.as_code(), "The referenced group breaks.\nThis group breaks because:\nIt measures with the 'if_group_breaks' variant because the referenced group breaks and that's just way too much text."); + assert_eq!( + printed.as_code(), + "The referenced group breaks.\nThis group breaks because:\nIt measures with the 'if_group_breaks' variant because the referenced group breaks and that's just way too much text." + ); } #[test] @@ -2036,7 +2037,7 @@ two lines`, write!( f, [ - group(&token("Group with id-2")).with_group_id(Some(id_2)), + group(&token("Group with id-2")).with_id(Some(id_2)), hard_line_break() ] )?; @@ -2044,7 +2045,7 @@ two lines`, write!( f, [ - group(&token("Group with id-1 does not fit on the line because it exceeds the line width of 80 characters by")).with_group_id(Some(id_1)), + group(&token("Group with id-1 does not fit on the line because it exceeds the line width of 80 characters by")).with_id(Some(id_1)), hard_line_break() ] )?; diff --git a/crates/ruff_formatter/src/printer/queue.rs b/crates/ruff_formatter/src/printer/queue.rs index b1f6500c9b6ee..d68c742951895 100644 --- a/crates/ruff_formatter/src/printer/queue.rs +++ b/crates/ruff_formatter/src/printer/queue.rs @@ -145,7 +145,7 @@ impl<'a, 'print> FitsQueue<'a, 'print> { } } -impl<'a, 'print> Queue<'a> for FitsQueue<'a, 'print> { +impl<'a> Queue<'a> for FitsQueue<'a, '_> { fn pop(&mut self) -> Option<&'a FormatElement> { self.queue.pop().or_else( #[cold] @@ -325,10 +325,10 @@ impl FitsEndPredicate for SingleEntryPredicate { #[cfg(test)] mod tests { + use crate::FormatElement; use crate::format_element::LineMode; use crate::prelude::Tag; use crate::printer::queue::{PrintQueue, Queue}; - use crate::FormatElement; #[test] fn extend_back_pop_last() { diff --git a/crates/ruff_formatter/src/source_code.rs b/crates/ruff_formatter/src/source_code.rs index cc81875aadff9..790e87f4a11da 100644 --- a/crates/ruff_formatter/src/source_code.rs +++ b/crates/ruff_formatter/src/source_code.rs @@ -65,7 +65,10 @@ pub struct SourceCodeSlice { impl SourceCodeSlice { /// Returns the slice's text. pub fn text<'a>(&self, code: SourceCode<'a>) -> &'a str { - assert!(usize::from(self.range.end()) <= code.text.len(), "The range of this slice is out of bounds. Did you provide the correct source code for this slice?"); + assert!( + usize::from(self.range.end()) <= code.text.len(), + "The range of this slice is out of bounds. Did you provide the correct source code for this slice?" + ); &code.text[self.range] } } diff --git a/crates/ruff_graph/Cargo.toml b/crates/ruff_graph/Cargo.toml index 645c9cd2e4255..917a2f4e05c35 100644 --- a/crates/ruff_graph/Cargo.toml +++ b/crates/ruff_graph/Cargo.toml @@ -10,13 +10,13 @@ authors.workspace = true license.workspace = true [dependencies] -red_knot_python_semantic = { workspace = true } ruff_cache = { workspace = true } ruff_db = { workspace = true, features = ["os", "serde"] } ruff_linter = { workspace = true } ruff_macros = { workspace = true } ruff_python_ast = { workspace = true } ruff_python_parser = { workspace = true } +ty_python_semantic = { workspace = true } anyhow = { workspace = true } clap = { workspace = true, optional = true } diff --git a/crates/ruff_graph/src/collector.rs b/crates/ruff_graph/src/collector.rs index 7946b2c5a6ef1..0aad63fbe63ae 100644 --- a/crates/ruff_graph/src/collector.rs +++ b/crates/ruff_graph/src/collector.rs @@ -1,8 +1,8 @@ -use red_knot_python_semantic::ModuleName; use ruff_python_ast::visitor::source_order::{ - walk_expr, walk_module, walk_stmt, SourceOrderVisitor, + SourceOrderVisitor, walk_expr, walk_module, walk_stmt, }; use ruff_python_ast::{self as ast, Expr, Mod, Stmt}; +use ty_python_semantic::ModuleName; /// Collect all imports for a given Python file. #[derive(Default, Debug)] diff --git a/crates/ruff_graph/src/db.rs b/crates/ruff_graph/src/db.rs index 39f74081bc83d..06b3eca96cbeb 100644 --- a/crates/ruff_graph/src/db.rs +++ b/crates/ruff_graph/src/db.rs @@ -1,11 +1,17 @@ use anyhow::Result; +use std::sync::Arc; use zip::CompressionMethod; -use red_knot_python_semantic::{Db, Program, ProgramSettings, PythonVersion, SearchPathSettings}; use ruff_db::files::{File, Files}; use ruff_db::system::{OsSystem, System, SystemPathBuf}; use ruff_db::vendored::{VendoredFileSystem, VendoredFileSystemBuilder}; use ruff_db::{Db as SourceDb, Upcast}; +use ruff_python_ast::PythonVersion; +use ty_python_semantic::lint::{LintRegistry, RuleSelection}; +use ty_python_semantic::{ + Db, Program, ProgramSettings, PythonPath, PythonPlatform, PythonVersionSource, + PythonVersionWithSource, SearchPathSettings, default_lint_registry, +}; static EMPTY_VENDORED: std::sync::LazyLock<VendoredFileSystem> = std::sync::LazyLock::new(|| { let mut builder = VendoredFileSystemBuilder::new(CompressionMethod::Stored); @@ -14,54 +20,41 @@ static EMPTY_VENDORED: std::sync::LazyLock<VendoredFileSystem> = std::sync::Lazy }); #[salsa::db] -#[derive(Default)] +#[derive(Default, Clone)] pub struct ModuleDb { storage: salsa::Storage<Self>, files: Files, system: OsSystem, + rule_selection: Arc<RuleSelection>, } impl ModuleDb { /// Initialize a [`ModuleDb`] from the given source root. pub fn from_src_roots( - mut src_roots: impl Iterator<Item = SystemPathBuf>, - target_version: PythonVersion, + src_roots: Vec<SystemPathBuf>, + python_version: PythonVersion, + venv_path: Option<SystemPathBuf>, ) -> Result<Self> { - let search_paths = { - // Use the first source root. - let src_root = src_roots - .next() - .ok_or_else(|| anyhow::anyhow!("No source roots provided"))?; - - let mut search_paths = SearchPathSettings::new(src_root); - - // Add the remaining source roots as extra paths. - search_paths.extra_paths.extend(src_roots); - - search_paths - }; + let mut search_paths = SearchPathSettings::new(src_roots); + if let Some(venv_path) = venv_path { + search_paths.python_path = PythonPath::from_cli_flag(venv_path); + } let db = Self::default(); Program::from_settings( &db, - &ProgramSettings { - target_version, + ProgramSettings { + python_version: PythonVersionWithSource { + version: python_version, + source: PythonVersionSource::default(), + }, + python_platform: PythonPlatform::default(), search_paths, }, )?; Ok(db) } - - /// Create a snapshot of the current database. - #[must_use] - pub fn snapshot(&self) -> Self { - Self { - storage: self.storage.clone(), - system: self.system.clone(), - files: self.files.snapshot(), - } - } } impl Upcast<dyn SourceDb> for ModuleDb { @@ -86,6 +79,10 @@ impl SourceDb for ModuleDb { fn files(&self) -> &Files { &self.files } + + fn python_version(&self) -> PythonVersion { + Program::get(self).python_version(self) + } } #[salsa::db] @@ -93,9 +90,15 @@ impl Db for ModuleDb { fn is_file_open(&self, file: File) -> bool { !file.path(self).is_vendored_path() } + + fn rule_selection(&self) -> &RuleSelection { + &self.rule_selection + } + + fn lint_registry(&self) -> &LintRegistry { + default_lint_registry() + } } #[salsa::db] -impl salsa::Database for ModuleDb { - fn salsa_event(&self, _event: &dyn Fn() -> salsa::Event) {} -} +impl salsa::Database for ModuleDb {} diff --git a/crates/ruff_graph/src/lib.rs b/crates/ruff_graph/src/lib.rs index 0d6a6669bafb6..6d2435efcd848 100644 --- a/crates/ruff_graph/src/lib.rs +++ b/crates/ruff_graph/src/lib.rs @@ -4,7 +4,7 @@ use anyhow::Result; use ruff_db::system::{SystemPath, SystemPathBuf}; use ruff_python_ast::helpers::to_module_path; -use ruff_python_parser::{parse, Mode}; +use ruff_python_parser::{Mode, ParseOptions, parse}; use crate::collector::Collector; pub use crate::db::ModuleDb; @@ -30,7 +30,7 @@ impl ModuleImports { ) -> Result<Self> { // Read and parse the source code. let source = std::fs::read_to_string(path)?; - let parsed = parse(&source, Mode::Module)?; + let parsed = parse(&source, ParseOptions::from(Mode::Module))?; let module_path = package.and_then(|package| to_module_path(package.as_std_path(), path.as_std_path())); diff --git a/crates/ruff_graph/src/resolver.rs b/crates/ruff_graph/src/resolver.rs index f5eb04402092e..baf43c71c9eb5 100644 --- a/crates/ruff_graph/src/resolver.rs +++ b/crates/ruff_graph/src/resolver.rs @@ -1,8 +1,8 @@ -use red_knot_python_semantic::resolve_module; use ruff_db::files::FilePath; +use ty_python_semantic::resolve_module; -use crate::collector::CollectedImport; use crate::ModuleDb; +use crate::collector::CollectedImport; /// Collect all imports for a given Python file. pub(crate) struct Resolver<'a> { @@ -19,19 +19,20 @@ impl<'a> Resolver<'a> { pub(crate) fn resolve(&self, import: CollectedImport) -> Option<&'a FilePath> { match import { CollectedImport::Import(import) => { - resolve_module(self.db, &import).map(|module| module.file().path(self.db)) + let module = resolve_module(self.db, &import)?; + Some(module.file()?.path(self.db)) } CollectedImport::ImportFrom(import) => { // Attempt to resolve the member (e.g., given `from foo import bar`, look for `foo.bar`). let parent = import.parent(); - resolve_module(self.db, &import) - .map(|module| module.file().path(self.db)) - .or_else(|| { - // Attempt to resolve the module (e.g., given `from foo import bar`, look for `foo`). + let module = resolve_module(self.db, &import).or_else(|| { + // Attempt to resolve the module (e.g., given `from foo import bar`, look for `foo`). + + resolve_module(self.db, &parent?) + })?; - resolve_module(self.db, &parent?).map(|module| module.file().path(self.db)) - }) + Some(module.file()?.path(self.db)) } } } diff --git a/crates/ruff_graph/src/settings.rs b/crates/ruff_graph/src/settings.rs index a91e24f2e3ed5..f7174c859272e 100644 --- a/crates/ruff_graph/src/settings.rs +++ b/crates/ruff_graph/src/settings.rs @@ -1,6 +1,7 @@ use ruff_linter::display_settings; -use ruff_linter::settings::types::{ExtensionMapping, FilePatternSet, PreviewMode, PythonVersion}; +use ruff_linter::settings::types::{ExtensionMapping, FilePatternSet, PreviewMode}; use ruff_macros::CacheKey; +use ruff_python_ast::PythonVersion; use std::collections::BTreeMap; use std::fmt; use std::path::PathBuf; @@ -24,7 +25,7 @@ impl fmt::Display for AnalyzeSettings { fields = [ self.exclude, self.preview, - self.target_version | debug, + self.target_version, self.detect_string_imports, self.extension | debug, self.include_dependencies | debug, diff --git a/crates/ruff_index/Cargo.toml b/crates/ruff_index/Cargo.toml index ceaf8315a9609..a96fa738f6452 100644 --- a/crates/ruff_index/Cargo.toml +++ b/crates/ruff_index/Cargo.toml @@ -15,6 +15,7 @@ doctest = false [dependencies] ruff_macros = { workspace = true } +salsa = { workspace = true, optional = true } [dev-dependencies] static_assertions = { workspace = true } diff --git a/crates/ruff_index/src/slice.rs b/crates/ruff_index/src/slice.rs index 9b3f9523f7a9c..75f52c2368af5 100644 --- a/crates/ruff_index/src/slice.rs +++ b/crates/ruff_index/src/slice.rs @@ -1,5 +1,5 @@ -use crate::vec::IndexVec; use crate::Idx; +use crate::vec::IndexVec; use std::fmt::{Debug, Formatter}; use std::marker::PhantomData; use std::ops::{Index, IndexMut, Range}; @@ -22,7 +22,7 @@ impl<I: Idx, T> IndexSlice<I, T> { pub const fn from_raw(raw: &[T]) -> &Self { let ptr: *const [T] = raw; - #[allow(unsafe_code)] + #[expect(unsafe_code)] // SAFETY: `IndexSlice` is `repr(transparent)` over a normal slice unsafe { &*(ptr as *const Self) @@ -33,7 +33,7 @@ impl<I: Idx, T> IndexSlice<I, T> { pub fn from_raw_mut(raw: &mut [T]) -> &mut Self { let ptr: *mut [T] = raw; - #[allow(unsafe_code)] + #[expect(unsafe_code)] // SAFETY: `IndexSlice` is `repr(transparent)` over a normal slice unsafe { &mut *(ptr as *mut Self) @@ -209,5 +209,5 @@ impl<I: Idx, T> Default for &mut IndexSlice<I, T> { // Whether `IndexSlice` is `Send` depends only on the data, // not the phantom data. -#[allow(unsafe_code)] +#[expect(unsafe_code)] unsafe impl<I: Idx, T> Send for IndexSlice<I, T> where T: Send {} diff --git a/crates/ruff_index/src/vec.rs b/crates/ruff_index/src/vec.rs index 184cf0ec89922..fcbd878ae7e03 100644 --- a/crates/ruff_index/src/vec.rs +++ b/crates/ruff_index/src/vec.rs @@ -1,5 +1,5 @@ -use crate::slice::IndexSlice; use crate::Idx; +use crate::slice::IndexSlice; use std::borrow::{Borrow, BorrowMut}; use std::fmt::{Debug, Formatter}; use std::marker::PhantomData; @@ -179,5 +179,18 @@ impl<I: Idx, T, const N: usize> From<[T; N]> for IndexVec<I, T> { // Whether `IndexVec` is `Send` depends only on the data, // not the phantom data. -#[allow(unsafe_code)] +#[expect(unsafe_code)] unsafe impl<I: Idx, T> Send for IndexVec<I, T> where T: Send {} + +#[expect(unsafe_code)] +#[cfg(feature = "salsa")] +unsafe impl<I, T> salsa::Update for IndexVec<I, T> +where + T: salsa::Update, +{ + #[expect(unsafe_code)] + unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool { + let old_vec: &mut IndexVec<I, T> = unsafe { &mut *old_pointer }; + unsafe { salsa::Update::maybe_update(&mut old_vec.raw, new_value.raw) } + } +} diff --git a/crates/ruff_linter/Cargo.toml b/crates/ruff_linter/Cargo.toml index 770f89e2bafbe..af3c527efb88f 100644 --- a/crates/ruff_linter/Cargo.toml +++ b/crates/ruff_linter/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ruff_linter" -version = "0.7.1" +version = "0.11.10" publish = false authors = { workspace = true } edition = { workspace = true } @@ -13,7 +13,9 @@ license = { workspace = true } [lib] [dependencies] +ruff_annotate_snippets = { workspace = true } ruff_cache = { workspace = true } +ruff_db = { workspace = true } ruff_diagnostics = { workspace = true, features = ["serde"] } ruff_notebook = { workspace = true } ruff_macros = { workspace = true } @@ -29,10 +31,8 @@ ruff_source_file = { workspace = true, features = ["serde"] } ruff_text_size = { workspace = true } aho-corasick = { workspace = true } -annotate-snippets = { workspace = true, features = ["color"] } anyhow = { workspace = true } bitflags = { workspace = true } -chrono = { workspace = true } clap = { workspace = true, features = ["derive", "string"], optional = true } colored = { workspace = true } fern = { workspace = true } @@ -43,6 +43,7 @@ is-macro = { workspace = true } is-wsl = { workspace = true } itertools = { workspace = true } libcst = { workspace = true } +jiff = { workspace = true } log = { workspace = true } memchr = { workspace = true } natord = { workspace = true } @@ -76,6 +77,7 @@ insta = { workspace = true, features = ["filters", "json", "redactions"] } test-case = { workspace = true } # Disable colored output in tests colored = { workspace = true, features = ["no-color"] } +tempfile = { workspace = true } [features] default = [] diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR001.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR001.py index 6e8bffcd9754d..d0b6d2443ea98 100644 --- a/crates/ruff_linter/resources/test/fixtures/airflow/AIR001.py +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR001.py @@ -1,4 +1,6 @@ from airflow.operators import PythonOperator +from airflow.providers.airbyte.operators.airbyte import AirbyteTriggerSyncOperator +from airflow.providers.amazon.aws.operators.appflow import AppflowFlowRunOperator def my_callable(): @@ -6,11 +8,15 @@ def my_callable(): my_task = PythonOperator(task_id="my_task", callable=my_callable) -my_task_2 = PythonOperator(callable=my_callable, task_id="my_task_2") +incorrect_name = PythonOperator(task_id="my_task") # AIR001 -incorrect_name = PythonOperator(task_id="my_task") -incorrect_name_2 = PythonOperator(callable=my_callable, task_id="my_task_2") +my_task = AirbyteTriggerSyncOperator(task_id="my_task", callable=my_callable) +incorrect_name = AirbyteTriggerSyncOperator(task_id="my_task") # AIR001 -from my_module import MyClass +my_task = AppflowFlowRunOperator(task_id="my_task", callable=my_callable) +incorrect_name = AppflowFlowRunOperator(task_id="my_task") # AIR001 -incorrect_name = MyClass(task_id="my_task") +# Consider only from the `airflow.operators` (or providers operators) module +from airflow import MyOperator + +incorrect_name = MyOperator(task_id="my_task") diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR002.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR002.py new file mode 100644 index 0000000000000..5ddbbb3e38bba --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR002.py @@ -0,0 +1,30 @@ +from airflow import DAG, dag +from airflow.timetables.simple import NullTimetable + +DAG(dag_id="class_default_schedule") + +DAG(dag_id="class_schedule", schedule="@hourly") + +DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") + +DAG(dag_id="class_timetable", timetable=NullTimetable()) + + +@dag() +def decorator_default_schedule(): + pass + + +@dag(schedule="0 * * * *") +def decorator_schedule(): + pass + + +@dag(schedule_interval="0 * * * *") +def decorator_schedule_interval(): + pass + + +@dag(timetable=NullTimetable()) +def decorator_timetable(): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_airflow_plugin.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_airflow_plugin.py new file mode 100644 index 0000000000000..117c691eca97b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_airflow_plugin.py @@ -0,0 +1,29 @@ +from airflow.plugins_manager import AirflowPlugin + + +class AirflowTestPlugin(AirflowPlugin): + name = "test_plugin" + # --- Invalid extensions start + operators = [PluginOperator] + sensors = [PluginSensorOperator] + hooks = [PluginHook] + executors = [PluginExecutor] + # --- Invalid extensions end + macros = [plugin_macro] + flask_blueprints = [bp] + appbuilder_views = [v_appbuilder_package] + appbuilder_menu_items = [appbuilder_mitem, appbuilder_mitem_toplevel] + global_operator_extra_links = [ + AirflowLink(), + GithubLink(), + ] + operator_extra_links = [ + GoogleLink(), + AirflowLink2(), + CustomOpLink(), + CustomBaseIndexOpLink(1), + ] + timetables = [CustomCronDataIntervalTimetable] + listeners = [empty_listener, ClassBasedListener()] + ti_deps = [CustomTestTriggerRule()] + priority_weight_strategies = [CustomPriorityWeightStrategy] diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_args.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_args.py new file mode 100644 index 0000000000000..ce35d79338195 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_args.py @@ -0,0 +1,107 @@ +from __future__ import annotations + +from datetime import timedelta + +from airflow import DAG, dag +from airflow.operators.datetime import BranchDateTimeOperator +from airflow.operators.trigger_dagrun import TriggerDagRunOperator +from airflow.operators.weekday import BranchDayOfWeekOperator +from airflow.providers.amazon.aws.log.s3_task_handler import S3TaskHandler +from airflow.providers.apache.hdfs.log.hdfs_task_handler import HdfsTaskHandler +from airflow.providers.elasticsearch.log.es_task_handler import ElasticsearchTaskHandler +from airflow.providers.fab.auth_manager.fab_auth_manager import FabAuthManager +from airflow.providers.google.cloud.log.gcs_task_handler import GCSTaskHandler +from airflow.providers.standard.operators import datetime, trigger_dagrun +from airflow.providers.standard.sensors import weekday +from airflow.sensors.weekday import DayOfWeekSensor +from airflow.timetables.simple import NullTimetable + +DAG(dag_id="class_schedule", schedule="@hourly") + +DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") + +DAG(dag_id="class_timetable", timetable=NullTimetable()) + + +DAG(dag_id="class_fail_stop", fail_stop=True) + +DAG(dag_id="class_default_view", default_view="dag_default_view") + +DAG(dag_id="class_orientation", orientation="BT") + +allow_future_exec_dates_dag = DAG(dag_id="class_allow_future_exec_dates") +allow_future_exec_dates_dag.allow_future_exec_dates + + +@dag(schedule="0 * * * *") +def decorator_schedule(): + pass + + +@dag(schedule_interval="0 * * * *") +def decorator_schedule_interval(): + pass + + +@dag(timetable=NullTimetable()) +def decorator_timetable(): + pass + + +@dag() +def decorator_deprecated_operator_args(): + trigger_dagrun_op = trigger_dagrun.TriggerDagRunOperator( + task_id="trigger_dagrun_op1", trigger_dag_id="test", execution_date="2024-12-04" + ) + trigger_dagrun_op2 = TriggerDagRunOperator( + task_id="trigger_dagrun_op2", trigger_dag_id="test", execution_date="2024-12-04" + ) + + branch_dt_op = datetime.BranchDateTimeOperator( + task_id="branch_dt_op", use_task_execution_day=True, task_concurrency=5 + ) + branch_dt_op2 = BranchDateTimeOperator( + task_id="branch_dt_op2", + use_task_execution_day=True, + sla=timedelta(seconds=10), + ) + + dof_task_sensor = weekday.DayOfWeekSensor( + task_id="dof_task_sensor", + week_day=1, + use_task_execution_day=True, + ) + dof_task_sensor2 = DayOfWeekSensor( + task_id="dof_task_sensor2", + week_day=1, + use_task_execution_day=True, + ) + + bdow_op = weekday.BranchDayOfWeekOperator( + task_id="bdow_op", + follow_task_ids_if_false=None, + follow_task_ids_if_true=None, + week_day=1, + use_task_execution_day=True, + ) + bdow_op2 = BranchDayOfWeekOperator( + task_id="bdow_op2", + follow_task_ids_if_false=None, + follow_task_ids_if_true=None, + week_day=1, + use_task_execution_day=True, + ) + + trigger_dagrun_op >> trigger_dagrun_op2 + branch_dt_op >> branch_dt_op2 + dof_task_sensor >> dof_task_sensor2 + bdow_op >> bdow_op2 + + +# deprecated filename_template argument in FileTaskHandler +S3TaskHandler(filename_template="/tmp/test") +HdfsTaskHandler(filename_template="/tmp/test") +ElasticsearchTaskHandler(filename_template="/tmp/test") +GCSTaskHandler(filename_template="/tmp/test") + +FabAuthManager(None) diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_class_attribute.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_class_attribute.py new file mode 100644 index 0000000000000..605ad5b07e52a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_class_attribute.py @@ -0,0 +1,98 @@ +from __future__ import annotations + +from airflow import ( + Dataset as DatasetFromRoot, +) +from airflow.datasets import ( + Dataset, + DatasetAlias, + DatasetAny, +) +from airflow.datasets.manager import DatasetManager +from airflow.lineage.hook import DatasetLineageInfo, HookLineageCollector +from airflow.providers.amazon.aws.auth_manager.aws_auth_manager import AwsAuthManager +from airflow.providers.apache.beam.hooks import BeamHook, NotAir302HookError +from airflow.providers.google.cloud.secrets.secret_manager import ( + CloudSecretManagerBackend, +) +from airflow.providers.hashicorp.secrets.vault import NotAir302SecretError, VaultBackend +from airflow.providers_manager import ProvidersManager +from airflow.secrets.base_secrets import BaseSecretsBackend +from airflow.secrets.local_filesystem import LocalFilesystemBackend + +# airflow.Dataset +dataset_from_root = DatasetFromRoot() +dataset_from_root.iter_datasets() +dataset_from_root.iter_dataset_aliases() + +# airflow.datasets +dataset_to_test_method_call = Dataset() +dataset_to_test_method_call.iter_datasets() +dataset_to_test_method_call.iter_dataset_aliases() + +alias_to_test_method_call = DatasetAlias() +alias_to_test_method_call.iter_datasets() +alias_to_test_method_call.iter_dataset_aliases() + +any_to_test_method_call = DatasetAny() +any_to_test_method_call.iter_datasets() +any_to_test_method_call.iter_dataset_aliases() + +# airflow.datasets.manager +dm = DatasetManager() +dm.register_dataset_change() +dm.create_datasets() +dm.notify_dataset_created() +dm.notify_dataset_changed() +dm.notify_dataset_alias_created() + +# airflow.lineage.hook +dl_info = DatasetLineageInfo() +dl_info.dataset + +hlc = HookLineageCollector() +hlc.create_dataset() +hlc.add_input_dataset() +hlc.add_output_dataset() +hlc.collected_datasets() + +# airflow.providers.amazon.auth_manager.aws_auth_manager +aam = AwsAuthManager() +aam.is_authorized_dataset() + +# airflow.providers.apache.beam.hooks +# check get_conn_uri is caught if the class inherits from an airflow hook +beam_hook = BeamHook() +beam_hook.get_conn_uri() + +not_an_error = NotAir302HookError() +not_an_error.get_conn_uri() + +# airflow.providers.google.cloud.secrets.secret_manager +csm_backend = CloudSecretManagerBackend() +csm_backend.get_conn_uri() +csm_backend.get_connections() + +# airflow.providers.hashicorp.secrets.vault +vault_backend = VaultBackend() +vault_backend.get_conn_uri() +vault_backend.get_connections() + +not_an_error = NotAir302SecretError() +not_an_error.get_conn_uri() + +# airflow.providers_manager +pm = ProvidersManager() +pm.initialize_providers_dataset_uri_resources() +pm.dataset_factories +pm.dataset_uri_handlers +pm.dataset_to_openlineage_converters + +# airflow.secrets.base_secrets +base_secret_backend = BaseSecretsBackend() +base_secret_backend.get_conn_uri() +base_secret_backend.get_connections() + +# airflow.secrets.local_filesystem +lfb = LocalFilesystemBackend() +lfb.get_connections() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_context.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_context.py new file mode 100644 index 0000000000000..2714eb84bc6d5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_context.py @@ -0,0 +1,152 @@ +from __future__ import annotations + +from datetime import datetime + +import pendulum +from airflow.decorators import dag, task +from airflow.models import DAG +from airflow.models.baseoperator import BaseOperator +from airflow.operators.dummy import DummyOperator +from airflow.plugins_manager import AirflowPlugin +from airflow.providers.standard.operators.python import PythonOperator +from airflow.utils.context import get_current_context + + +def access_invalid_key_in_context(**context): + print("access invalid key", context["conf"]) + print("access invalid key", context.get("conf")) + + +@task +def access_invalid_key_task_out_of_dag(**context): + print("access invalid key", context["conf"]) + print("access invalid key", context.get("conf")) + + +@task +def access_invalid_argument_task_out_of_dag( + execution_date, tomorrow_ds, logical_date, **context +): + print("execution date", execution_date) + print("access invalid key", context.get("conf")) + + +@task +def print_config(**context): + # This should not throw an error as logical_date is part of airflow context. + logical_date = context["logical_date"] + + # Removed usage - should trigger violations + execution_date = context["execution_date"] + next_ds = context["next_ds"] + next_ds_nodash = context["next_ds_nodash"] + next_execution_date = context["next_execution_date"] + prev_ds = context["prev_ds"] + prev_ds_nodash = context["prev_ds_nodash"] + prev_execution_date = context["prev_execution_date"] + prev_execution_date_success = context["prev_execution_date_success"] + tomorrow_ds = context["tomorrow_ds"] + yesterday_ds = context["yesterday_ds"] + yesterday_ds_nodash = context["yesterday_ds_nodash"] + + +@task +def print_config_with_get_current_context(): + context = get_current_context() + execution_date = context["execution_date"] + next_ds = context["next_ds"] + next_ds_nodash = context["next_ds_nodash"] + next_execution_date = context["next_execution_date"] + prev_ds = context["prev_ds"] + prev_ds_nodash = context["prev_ds_nodash"] + prev_execution_date = context["prev_execution_date"] + prev_execution_date_success = context["prev_execution_date_success"] + tomorrow_ds = context["tomorrow_ds"] + yesterday_ds = context["yesterday_ds"] + yesterday_ds_nodash = context["yesterday_ds_nodash"] + + +@task(task_id="print_the_context") +def print_context(ds=None, **kwargs): + """Print the Airflow context and ds variable from the context.""" + print(ds) + print(kwargs.get("tomorrow_ds")) + c = get_current_context() + c.get("execution_date") + + +@dag( + schedule=None, + start_date=pendulum.datetime(2021, 1, 1, tz="UTC"), + catchup=False, + tags=[""], +) +def invalid_dag(): + @task() + def access_invalid_key_task(**context): + print("access invalid key", context.get("conf")) + + @task() + def access_invalid_key_explicit_task(execution_date): + print(execution_date) + + task1 = PythonOperator( + task_id="task1", + python_callable=access_invalid_key_in_context, + ) + + access_invalid_key_task() >> task1 + access_invalid_key_explicit_task() + access_invalid_argument_task_out_of_dag() + access_invalid_key_task_out_of_dag() + print_config() + print_config_with_get_current_context() + print_context() + + +invalid_dag() + +with DAG( + dag_id="example_dag", + schedule_interval="@daily", + start_date=datetime(2023, 1, 1), + template_searchpath=["/templates"], +) as dag: + task1 = DummyOperator( + task_id="task1", + params={ + # Removed variables in template + "execution_date": "{{ execution_date }}", + "next_ds": "{{ next_ds }}", + "prev_ds": "{{ prev_ds }}", + }, + ) + + +class CustomMacrosPlugin(AirflowPlugin): + name = "custom_macros" + macros = { + "execution_date_macro": lambda context: context["execution_date"], + "next_ds_macro": lambda context: context["next_ds"], + } + + +class CustomOperator(BaseOperator): + def execute(self, next_ds, context): + execution_date = context["execution_date"] + next_ds = context["next_ds"] + next_ds_nodash = context["next_ds_nodash"] + next_execution_date = context["next_execution_date"] + prev_ds = context["prev_ds"] + prev_ds_nodash = context["prev_ds_nodash"] + prev_execution_date = context["prev_execution_date"] + prev_execution_date_success = context["prev_execution_date_success"] + tomorrow_ds = context["tomorrow_ds"] + yesterday_ds = context["yesterday_ds"] + yesterday_ds_nodash = context["yesterday_ds_nodash"] + + +class CustomOperatorNew(BaseOperator): + def execute(self, context): + execution_date = context.get("execution_date") + next_ds = context.get("next_ds") diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names.py new file mode 100644 index 0000000000000..e3654a4c52ba6 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names.py @@ -0,0 +1,171 @@ +from __future__ import annotations + +from airflow import ( + PY36, + PY37, + PY38, + PY39, + PY310, + PY311, + PY312, +) +from airflow.api_connexion.security import requires_access +from airflow.configuration import ( + as_dict, + get, + getboolean, + getfloat, + getint, + has_option, + remove_option, + set, +) +from airflow.contrib.aws_athena_hook import AWSAthenaHook +from airflow.datasets import DatasetAliasEvent +from airflow.hooks.base_hook import BaseHook +from airflow.operators.subdag import SubDagOperator +from airflow.secrets.local_filesystem import LocalFilesystemBackend +from airflow.sensors.base_sensor_operator import BaseSensorOperator +from airflow.triggers.external_task import TaskStateTrigger +from airflow.utils import dates +from airflow.utils.dag_cycle_tester import test_cycle +from airflow.utils.dates import ( + date_range, + datetime_to_nano, + days_ago, + infer_time_unit, + parse_execution_date, + round_time, + scale_time_units, +) +from airflow.utils.db import create_session +from airflow.utils.decorators import apply_defaults +from airflow.utils.file import TemporaryDirectory, mkdirs +from airflow.utils.helpers import chain as helper_chain +from airflow.utils.helpers import cross_downstream as helper_cross_downstream +from airflow.utils.log import secrets_masker +from airflow.utils.state import SHUTDOWN, terminating_states +from airflow.utils.trigger_rule import TriggerRule +from airflow.www.auth import has_access +from airflow.www.utils import get_sensitive_variables_fields, should_hide_value_for_key + +# airflow root +PY36, PY37, PY38, PY39, PY310, PY311, PY312 + +# airflow.api_connexion.security +requires_access + + +# airflow.configuration +get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + + +# airflow.contrib.* +AWSAthenaHook() + + +# airflow.datasets +DatasetAliasEvent() + + +# airflow.hooks +BaseHook() + + +# airflow.operators.subdag.* +SubDagOperator() + + +# airflow.secrets +# get_connection +LocalFilesystemBackend() + + +# airflow.sensors.base_sensor_operator +BaseSensorOperator() + + +# airflow.triggers.external_task +TaskStateTrigger() + +# airflow.utils.date +dates.date_range +dates.days_ago + +date_range +days_ago +infer_time_unit +parse_execution_date +round_time +scale_time_units + +# This one was not deprecated. +datetime_to_nano +dates.datetime_to_nano + +# airflow.utils.dag_cycle_tester +test_cycle + + +# airflow.utils.db +create_session + +# airflow.utils.decorators +apply_defaults + +# airflow.utils.file +TemporaryDirectory() +mkdirs + +# airflow.utils.helpers +helper_chain +helper_cross_downstream + +# airflow.utils.log +secrets_masker + +# airflow.utils.state +SHUTDOWN +terminating_states + +# airflow.utils.trigger_rule +TriggerRule.DUMMY +TriggerRule.NONE_FAILED_OR_SKIPPED + + +# airflow.www.auth +has_access + +# airflow.www.utils +get_sensitive_variables_fields +should_hide_value_for_key + +# airflow.operators.python +from airflow.operators.python import get_current_context + +get_current_context() + +# airflow.providers.mysql +from airflow.providers.mysql.datasets.mysql import sanitize_uri + +sanitize_uri + +# airflow.providers.postgres +from airflow.providers.postgres.datasets.postgres import sanitize_uri + +sanitize_uri + +# airflow.providers.trino +from airflow.providers.trino.datasets.trino import sanitize_uri + +sanitize_uri + +# airflow.notifications.basenotifier +from airflow.notifications.basenotifier import BaseNotifier + +BaseNotifier() + +# airflow.auth.manager +from airflow.auth.managers.base_auth_manager import BaseAuthManager + +BaseAuthManager() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_fix.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_fix.py new file mode 100644 index 0000000000000..ac4f45eb42811 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_fix.py @@ -0,0 +1,45 @@ +from __future__ import annotations + +from airflow.api_connexion.security import requires_access_dataset +from airflow.auth.managers.models.resource_details import ( + DatasetDetails, + +) +from airflow.datasets.manager import ( + DatasetManager, + dataset_manager, + resolve_dataset_manager, +) +from airflow.lineage.hook import DatasetLineageInfo +from airflow.metrics.validators import AllowListValidator, BlockListValidator +from airflow.secrets.local_filesystm import load_connections +from airflow.security.permissions import RESOURCE_DATASET +from airflow.www.auth import has_access_dataset + +requires_access_dataset() + +DatasetDetails() + + +DatasetManager() +dataset_manager() +resolve_dataset_manager() + +DatasetLineageInfo() + +AllowListValidator() +BlockListValidator() + +load_connections() + +RESOURCE_DATASET + +has_access_dataset() + +from airflow.listeners.spec.dataset import ( + on_dataset_changed, + on_dataset_created, +) + +on_dataset_created() +on_dataset_changed() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_try.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_try.py new file mode 100644 index 0000000000000..e4202741eddbf --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_names_try.py @@ -0,0 +1,8 @@ +from __future__ import annotations + +try: + from airflow.assets.manager import AssetManager +except ModuleNotFoundError: + from airflow.datasets.manager import DatasetManager as AssetManager + +AssetManager() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_provider_names_fix.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_provider_names_fix.py new file mode 100644 index 0000000000000..f5a22b6c169ae --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR301_provider_names_fix.py @@ -0,0 +1,54 @@ +from __future__ import annotations + +from airflow.providers.amazon.aws.auth_manager.avp.entities import AvpEntities +from airflow.providers.amazon.aws.datasets.s3 import ( + convert_dataset_to_openlineage as s3_convert_dataset_to_openlineage, +) +from airflow.providers.amazon.aws.datasets.s3 import create_dataset as s3_create_dataset +from airflow.providers.common.io.dataset.file import ( + convert_dataset_to_openlineage as io_convert_dataset_to_openlineage, +) +from airflow.providers.common.io.dataset.file import create_dataset as io_create_dataset + +from airflow.providers.google.datasets.bigquery import ( + create_dataset as bigquery_create_dataset, +) +from airflow.providers.google.datasets.gcs import ( + convert_dataset_to_openlineage as gcs_convert_dataset_to_openlineage, +) +from airflow.providers.google.datasets.gcs import create_dataset as gcs_create_dataset +from airflow.providers.openlineage.utils.utils import ( + DatasetInfo, + translate_airflow_dataset, +) + +AvpEntities.DATASET + +s3_create_dataset() +s3_convert_dataset_to_openlineage() + +io_create_dataset() +io_convert_dataset_to_openlineage() + + + +# airflow.providers.google.datasets.bigquery +bigquery_create_dataset() +# airflow.providers.google.datasets.gcs +gcs_create_dataset() +gcs_convert_dataset_to_openlineage() +# airflow.providers.openlineage.utils.utils +DatasetInfo() +translate_airflow_dataset() +# +# airflow.secrets.local_filesystem +load_connections() +# +# airflow.security.permissions +RESOURCE_DATASET + +# airflow.timetables +DatasetTriggeredTimetable() +# +# airflow.www.auth +has_access_dataset diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_amazon.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_amazon.py new file mode 100644 index 0000000000000..b72ae553bfa49 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_amazon.py @@ -0,0 +1,39 @@ +from __future__ import annotations + +from airflow.hooks.S3_hook import ( + S3Hook, + provide_bucket_name, +) +from airflow.operators.gcs_to_s3 import GCSToS3Operator +from airflow.operators.google_api_to_s3_transfer import ( + GoogleApiToS3Operator, + GoogleApiToS3Transfer, +) +from airflow.operators.redshift_to_s3_operator import ( + RedshiftToS3Operator, + RedshiftToS3Transfer, +) +from airflow.operators.s3_file_transform_operator import S3FileTransformOperator +from airflow.operators.s3_to_redshift_operator import ( + S3ToRedshiftOperator, + S3ToRedshiftTransfer, +) +from airflow.sensors.s3_key_sensor import S3KeySensor + +S3Hook() +provide_bucket_name() + +GCSToS3Operator() + +GoogleApiToS3Operator() +GoogleApiToS3Transfer() + +RedshiftToS3Operator() +RedshiftToS3Transfer() + +S3FileTransformOperator() + +S3ToRedshiftOperator() +S3ToRedshiftTransfer() + +S3KeySensor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_celery.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_celery.py new file mode 100644 index 0000000000000..defe8fe915d00 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_celery.py @@ -0,0 +1,12 @@ +from __future__ import annotations + +from airflow.config_templates.default_celery import DEFAULT_CELERY_CONFIG +from airflow.executors.celery_executor import ( + CeleryExecutor, + app, +) + +DEFAULT_CELERY_CONFIG + +app +CeleryExecutor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_common_sql.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_common_sql.py new file mode 100644 index 0000000000000..47f4cbda6e377 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_common_sql.py @@ -0,0 +1,129 @@ +from __future__ import annotations + +from airflow.hooks.dbapi import ( + ConnectorProtocol, + DbApiHook, +) +from airflow.hooks.dbapi_hook import DbApiHook +from airflow.operators.check_operator import SQLCheckOperator + +ConnectorProtocol() +DbApiHook() +SQLCheckOperator() + + +from airflow.operators.check_operator import CheckOperator +from airflow.operators.sql import SQLCheckOperator + +SQLCheckOperator() +CheckOperator() + + +from airflow.operators.druid_check_operator import CheckOperator + +CheckOperator() + + +from airflow.operators.presto_check_operator import CheckOperator + +CheckOperator() + + +from airflow.operators.check_operator import ( + IntervalCheckOperator, + SQLIntervalCheckOperator, +) +from airflow.operators.druid_check_operator import DruidCheckOperator +from airflow.operators.presto_check_operator import PrestoCheckOperator + +DruidCheckOperator() +PrestoCheckOperator() +IntervalCheckOperator() +SQLIntervalCheckOperator() + + +from airflow.operators.presto_check_operator import ( + IntervalCheckOperator, + PrestoIntervalCheckOperator, +) +from airflow.operators.sql import SQLIntervalCheckOperator + +IntervalCheckOperator() +SQLIntervalCheckOperator() +PrestoIntervalCheckOperator() + + +from airflow.operators.check_operator import ( + SQLThresholdCheckOperator, + ThresholdCheckOperator, +) + +SQLThresholdCheckOperator() +ThresholdCheckOperator() + + +from airflow.operators.sql import SQLThresholdCheckOperator + +SQLThresholdCheckOperator() + + +from airflow.operators.check_operator import ( + SQLValueCheckOperator, + ValueCheckOperator, +) + +SQLValueCheckOperator() +ValueCheckOperator() + + +from airflow.operators.presto_check_operator import ( + PrestoValueCheckOperator, + ValueCheckOperator, +) +from airflow.operators.sql import SQLValueCheckOperator + +SQLValueCheckOperator() +ValueCheckOperator() +PrestoValueCheckOperator() + + +from airflow.operators.sql import ( + BaseSQLOperator, + BranchSQLOperator, + SQLColumnCheckOperator, + SQLTableCheckOperator, + _convert_to_float_if_possible, + parse_boolean, +) + +BaseSQLOperator() +BranchSQLOperator() +SQLTableCheckOperator() +SQLColumnCheckOperator() +_convert_to_float_if_possible() +parse_boolean() + + +from airflow.sensors.sql import SqlSensor + +SqlSensor() + + +from airflow.sensors.sql_sensor import SqlSensor + +SqlSensor() + + +from airflow.operators.jdbc_operator import JdbcOperator +from airflow.operators.mssql_operator import MsSqlOperator +from airflow.operators.mysql_operator import MySqlOperator +from airflow.operators.oracle_operator import OracleOperator +from airflow.operators.postgres_operator import PostgresOperator +from airflow.operators.sqlite_operator import SqliteOperator + +JdbcOperator() +MsSqlOperator() +MySqlOperator() +OracleOperator() +PostgresOperator() +SqliteOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_daskexecutor.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_daskexecutor.py new file mode 100644 index 0000000000000..9b6c273b13712 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_daskexecutor.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.executors.dask_executor import DaskExecutor + +DaskExecutor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_docker.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_docker.py new file mode 100644 index 0000000000000..85b816a8be423 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_docker.py @@ -0,0 +1,7 @@ +from __future__ import annotations + +from airflow.hooks.docker_hook import DockerHook +from airflow.operators.docker_operator import DockerOperator + +DockerHook() +DockerOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_druid.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_druid.py new file mode 100644 index 0000000000000..1de011de9f069 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_druid.py @@ -0,0 +1,16 @@ +from __future__ import annotations + +from airflow.hooks.druid_hook import ( + DruidDbApiHook, + DruidHook, +) +from airflow.operators.hive_to_druid import ( + HiveToDruidOperator, + HiveToDruidTransfer, +) + +DruidDbApiHook() +DruidHook() + +HiveToDruidOperator() +HiveToDruidTransfer() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_fab.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_fab.py new file mode 100644 index 0000000000000..6a5a5ba7bd6a8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_fab.py @@ -0,0 +1,55 @@ +from __future__ import annotations + +from airflow.api.auth.backend.basic_auth import ( + CLIENT_AUTH, + auth_current_user, + init_app, + requires_authentication, +) + +CLIENT_AUTH +init_app() +auth_current_user() +requires_authentication() + +from airflow.api.auth.backend.kerberos_auth import ( + CLIENT_AUTH, + find_user, + init_app, + log, + requires_authentication, +) + +log() +CLIENT_AUTH +find_user() +init_app() +requires_authentication() + +from airflow.auth.managers.fab.api.auth.backend.kerberos_auth import ( + CLIENT_AUTH, + find_user, + init_app, + log, + requires_authentication, +) + +log() +CLIENT_AUTH +find_user() +init_app() +requires_authentication() + +from airflow.auth.managers.fab.fab_auth_manager import FabAuthManager +from airflow.auth.managers.fab.security_manager.override import ( + MAX_NUM_DATABASE_USER_SESSIONS, + FabAirflowSecurityManagerOverride, +) + +FabAuthManager() +MAX_NUM_DATABASE_USER_SESSIONS +FabAirflowSecurityManagerOverride() + +from airflow.www.security import FabAirflowSecurityManagerOverride + +FabAirflowSecurityManagerOverride() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hdfs.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hdfs.py new file mode 100644 index 0000000000000..a52239fe80bc5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hdfs.py @@ -0,0 +1,7 @@ +from __future__ import annotations + +from airflow.hooks.webhdfs_hook import WebHDFSHook +from airflow.sensors.web_hdfs_sensor import WebHdfsSensor + +WebHDFSHook() +WebHdfsSensor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hive.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hive.py new file mode 100644 index 0000000000000..a018a9fc11a1d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_hive.py @@ -0,0 +1,66 @@ +from __future__ import annotations + +from airflow.hooks.hive_hooks import ( + HIVE_QUEUE_PRIORITIES, + HiveCliHook, + HiveMetastoreHook, + HiveServer2Hook, +) +from airflow.macros.hive import ( + closest_ds_partition, + max_partition, +) +from airflow.operators.hive_operator import HiveOperator +from airflow.operators.hive_stats_operator import HiveStatsCollectionOperator +from airflow.operators.hive_to_mysql import ( + HiveToMySqlOperator, + HiveToMySqlTransfer, +) +from airflow.operators.hive_to_samba_operator import HiveToSambaOperator +from airflow.operators.mssql_to_hive import ( + MsSqlToHiveOperator, + MsSqlToHiveTransfer, +) +from airflow.operators.mysql_to_hive import ( + MySqlToHiveOperator, + MySqlToHiveTransfer, +) +from airflow.operators.s3_to_hive_operator import ( + S3ToHiveOperator, + S3ToHiveTransfer, +) +from airflow.sensors.hive_partition_sensor import HivePartitionSensor +from airflow.sensors.metastore_partition_sensor import MetastorePartitionSensor +from airflow.sensors.named_hive_partition_sensor import NamedHivePartitionSensor + +closest_ds_partition() +max_partition() + +HiveCliHook() +HiveMetastoreHook() +HiveServer2Hook() +HIVE_QUEUE_PRIORITIES + +HiveOperator() + +HiveStatsCollectionOperator() + +HiveToMySqlOperator() +HiveToMySqlTransfer() + +HiveToSambaOperator() + +MsSqlToHiveOperator() +MsSqlToHiveTransfer() + +MySqlToHiveOperator() +MySqlToHiveTransfer() + +S3ToHiveOperator() +S3ToHiveTransfer() + +HivePartitionSensor() + +MetastorePartitionSensor() + +NamedHivePartitionSensor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_http.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_http.py new file mode 100644 index 0000000000000..d2ca3a4206859 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_http.py @@ -0,0 +1,9 @@ +from __future__ import annotations + +from airflow.hooks.http_hook import HttpHook +from airflow.operators.http_operator import SimpleHttpOperator +from airflow.sensors.http_sensor import HttpSensor + +HttpHook() +SimpleHttpOperator() +HttpSensor() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_jdbc.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_jdbc.py new file mode 100644 index 0000000000000..2a00135a9f372 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_jdbc.py @@ -0,0 +1,9 @@ +from __future__ import annotations + +from airflow.hooks.jdbc_hook import ( + JdbcHook, + jaydebeapi, +) + +JdbcHook() +jaydebeapi() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_kubernetes.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_kubernetes.py new file mode 100644 index 0000000000000..2d943b8731ff0 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_kubernetes.py @@ -0,0 +1,117 @@ +from __future__ import annotations + +from airflow.executors.kubernetes_executor_types import ( + ALL_NAMESPACES, + POD_EXECUTOR_DONE_KEY, +) +from airflow.kubernetes.k8s_model import ( + K8SModel, + append_to_pod, +) +from airflow.kubernetes.kube_client import ( + _disable_verify_ssl, + _enable_tcp_keepalive, + get_kube_client, +) +from airflow.kubernetes.kubernetes_helper_functions import ( + add_pod_suffix, + annotations_for_logging_task_metadata, + annotations_to_key, + create_pod_id, + get_logs_task_metadata, + rand_str, +) +from airflow.kubernetes.pod import ( + Port, + Resources, +) + +ALL_NAMESPACES +POD_EXECUTOR_DONE_KEY + +K8SModel() +append_to_pod() + +_disable_verify_ssl() +_enable_tcp_keepalive() +get_kube_client() + +add_pod_suffix() +create_pod_id() + +annotations_for_logging_task_metadata() +annotations_to_key() +get_logs_task_metadata() +rand_str() + +Port() +Resources() + + +from airflow.kubernetes.pod_generator import ( + PodDefaults, + PodGenerator, + PodGeneratorDeprecated, + add_pod_suffix, + datetime_to_label_safe_datestring, + extend_object_field, + label_safe_datestring_to_datetime, + make_safe_label_value, + merge_objects, + rand_str, +) + +datetime_to_label_safe_datestring() +extend_object_field() +label_safe_datestring_to_datetime() +make_safe_label_value() +merge_objects() +PodGenerator() +PodDefaults() +PodGeneratorDeprecated() +add_pod_suffix() +rand_str() + + +from airflow.kubernetes.pod_generator_deprecated import ( + PodDefaults, + PodGenerator, + make_safe_label_value, +) +from airflow.kubernetes.pod_launcher import ( + PodLauncher, + PodStatus, +) + +PodDefaults() +PodGenerator() +make_safe_label_value() + +PodLauncher() +PodStatus() + + +from airflow.kubernetes.pod_launcher_deprecated import ( + PodDefaults, + PodLauncher, + PodStatus, + get_kube_client, +) +from airflow.kubernetes.pod_runtime_info_env import PodRuntimeInfoEnv +from airflow.kubernetes.secret import ( + K8SModel, + Secret, +) +from airflow.kubernetes.volume import Volume +from airflow.kubernetes.volume_mount import VolumeMount + +PodDefaults() +PodLauncher() +PodStatus() +get_kube_client() + +PodRuntimeInfoEnv() +K8SModel() +Secret() +Volume() +VolumeMount() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_mysql.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_mysql.py new file mode 100644 index 0000000000000..0bc3eab8dd04e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_mysql.py @@ -0,0 +1,11 @@ +from __future__ import annotations + +from airflow.hooks.mysql_hook import MySqlHook +from airflow.operators.presto_to_mysql import ( + PrestoToMySqlOperator, + PrestoToMySqlTransfer, +) + +MySqlHook() +PrestoToMySqlOperator() +PrestoToMySqlTransfer() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_oracle.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_oracle.py new file mode 100644 index 0000000000000..3c525e4eb705c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_oracle.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.hooks.oracle_hook import OracleHook + +OracleHook() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_papermill.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_papermill.py new file mode 100644 index 0000000000000..42be2959e3660 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_papermill.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.operators.papermill_operator import PapermillOperator + +PapermillOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_pig.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_pig.py new file mode 100644 index 0000000000000..e09bb35fa6b18 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_pig.py @@ -0,0 +1,7 @@ +from __future__ import annotations + +from airflow.hooks.pig_hook import PigCliHook +from airflow.operators.pig_operator import PigOperator + +PigCliHook() +PigOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_postgres.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_postgres.py new file mode 100644 index 0000000000000..bbd79299fa24e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_postgres.py @@ -0,0 +1,7 @@ +from __future__ import annotations + +from airflow.hooks.postgres_hook import PostgresHook +from airflow.operators.postgres_operator import Mapping + +PostgresHook() +Mapping() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_presto.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_presto.py new file mode 100644 index 0000000000000..f5117884a7b42 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_presto.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.hooks.presto_hook import PrestoHook + +PrestoHook() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_samba.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_samba.py new file mode 100644 index 0000000000000..f18cd97a6e7e9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_samba.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.hooks.samba_hook import SambaHook + +SambaHook() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_slack.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_slack.py new file mode 100644 index 0000000000000..644f7d06b9084 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_slack.py @@ -0,0 +1,8 @@ +from __future__ import annotations + +from airflow.hooks.slack_hook import SlackHook +from airflow.operators.slack_operator import SlackAPIOperator, SlackAPIPostOperator + +SlackHook() +SlackAPIOperator() +SlackAPIPostOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_smtp.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_smtp.py new file mode 100644 index 0000000000000..ea3795460e67b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_smtp.py @@ -0,0 +1,9 @@ +from __future__ import annotations + +from airflow.operators.email_operator import EmailOperator + +EmailOperator() + +from airflow.operators.email import EmailOperator + +EmailOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_sqlite.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_sqlite.py new file mode 100644 index 0000000000000..a4b256ff03a61 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_sqlite.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.hooks.sqlite_hook import SqliteHook + +SqliteHook() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_standard.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_standard.py new file mode 100644 index 0000000000000..3758c3afb556b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_standard.py @@ -0,0 +1,62 @@ +from __future__ import annotations + +from airflow.operators.bash_operator import BashOperator +from airflow.operators.dagrun_operator import ( + TriggerDagRunLink, + TriggerDagRunOperator, +) +from airflow.operators.dummy import ( + DummyOperator, + EmptyOperator, +) +from airflow.operators.latest_only_operator import LatestOnlyOperator +from airflow.operators.python_operator import ( + BranchPythonOperator, + PythonOperator, + PythonVirtualenvOperator, + ShortCircuitOperator, +) +from airflow.sensors.external_task_sensor import ( + ExternalTaskMarker, + ExternalTaskSensor, + ExternalTaskSensorLink, +) + +BashOperator() + +TriggerDagRunLink() +TriggerDagRunOperator() +DummyOperator() +EmptyOperator() + +LatestOnlyOperator() + +BranchPythonOperator() +PythonOperator() +PythonVirtualenvOperator() +ShortCircuitOperator() + +ExternalTaskMarker() +ExternalTaskSensor() +ExternalTaskSensorLink() + +from airflow.operators.dummy_operator import ( + DummyOperator, + EmptyOperator, +) + +DummyOperator() +EmptyOperator() + +from airflow.hooks.subprocess import SubprocessResult +SubprocessResult() +from airflow.hooks.subprocess import working_directory +working_directory() +from airflow.operators.datetime import target_times_as_dates +target_times_as_dates() +from airflow.operators.trigger_dagrun import TriggerDagRunLink +TriggerDagRunLink() +from airflow.sensors.external_task import ExternalTaskSensorLink +ExternalTaskSensorLink() +from airflow.sensors.time_delta import WaitSensor +WaitSensor() \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_try.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_try.py new file mode 100644 index 0000000000000..c062aeb61a17e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_try.py @@ -0,0 +1,8 @@ +from __future__ import annotations + +try: + from airflow.providers.http.operators.http import HttpOperator +except ModuleNotFoundError: + from airflow.operators.http_operator import SimpleHttpOperator as HttpOperator + +HttpOperator() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_zendesk.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_zendesk.py new file mode 100644 index 0000000000000..b64d4c45cf31f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR302_zendesk.py @@ -0,0 +1,5 @@ +from __future__ import annotations + +from airflow.hooks.zendesk_hook import ZendeskHook + +ZendeskHook() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_args.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_args.py new file mode 100644 index 0000000000000..dbceffc602ffc --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_args.py @@ -0,0 +1,28 @@ +from __future__ import annotations + +from datetime import timedelta + +from airflow import DAG, dag +from airflow.operators.datetime import BranchDateTimeOperator + + +def sla_callback(*arg, **kwargs): + pass + + +DAG(dag_id="class_sla_callback", sla_miss_callback=sla_callback) + + +@dag(sla_miss_callback=sla_callback) +def decorator_sla_callback(): + pass + + +@dag() +def decorator_deprecated_operator_args(): + branch_dt_op2 = BranchDateTimeOperator( + task_id="branch_dt_op2", + sla=timedelta(seconds=10), + ) + + branch_dt_op2 diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_names.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_names.py new file mode 100644 index 0000000000000..242b650938f9c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_names.py @@ -0,0 +1,67 @@ +from __future__ import annotations + +from airflow import Dataset as DatasetFromRoot +from airflow.datasets import ( + Dataset, + DatasetAlias, + DatasetAll, + DatasetAny, + expand_alias_to_datasets, +) +from airflow.datasets.metadata import Metadata +from airflow.decorators import dag, setup, task, task_group, teardown +from airflow.io.path import ObjectStoragePath +from airflow.io.storage import attach +from airflow.models import DAG as DAGFromModel +from airflow.models import ( + Connection, + Variable, +) +from airflow.models.baseoperator import chain, chain_linear, cross_downstream +from airflow.models.baseoperatorlink import BaseOperatorLink +from airflow.models.dag import DAG as DAGFromDag +from airflow.timetables.datasets import DatasetOrTimeSchedule +from airflow.utils.dag_parsing_context import get_parsing_context + +# airflow +DatasetFromRoot() + +# airflow.datasets +Dataset() +DatasetAlias() +DatasetAll() +DatasetAny() +Metadata() +expand_alias_to_datasets() + +# airflow.decorators +dag() +task() +task_group() +setup() +teardown() + +# airflow.io +ObjectStoragePath() +attach() + +# airflow.models +Connection() +DAGFromModel() +Variable() + +# airflow.models.baseoperator +chain() +chain_linear() +cross_downstream() + +# airflow.models.baseoperatolinker +BaseOperatorLink() + +# airflow.models.dag +DAGFromDag() +# airflow.timetables.datasets +DatasetOrTimeSchedule() + +# airflow.utils.dag_parsing_context +get_parsing_context() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_try.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_try.py new file mode 100644 index 0000000000000..5f6a1df032855 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR311_try.py @@ -0,0 +1,8 @@ +from __future__ import annotations + +try: + from airflow.sdk import Asset +except ModuleNotFoundError: + from airflow.datasets import Dataset as Asset + +Asset() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR312.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR312.py new file mode 100644 index 0000000000000..84a1f5f5fcaf1 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR312.py @@ -0,0 +1,55 @@ +from __future__ import annotations + +from airflow.hooks.filesystem import FSHook +from airflow.hooks.package_index import PackageIndexHook +from airflow.hooks.subprocess import SubprocessHook +from airflow.operators.bash import BashOperator +from airflow.operators.datetime import BranchDateTimeOperator +from airflow.operators.empty import EmptyOperator +from airflow.operators.latest_only import LatestOnlyOperator +from airflow.operators.python import ( + BranchPythonOperator, + PythonOperator, + PythonVirtualenvOperator, + ShortCircuitOperator, +) +from airflow.operators.trigger_dagrun import TriggerDagRunOperator +from airflow.operators.weekday import BranchDayOfWeekOperator +from airflow.sensors.date_time import DateTimeSensor, DateTimeSensorAsync +from airflow.sensors.external_task import ( + ExternalTaskMarker, + ExternalTaskSensor, + +) +from airflow.sensors.filesystem import FileSensor +from airflow.sensors.time_delta import TimeDeltaSensor, TimeDeltaSensorAsync +from airflow.sensors.time_sensor import TimeSensor, TimeSensorAsync +from airflow.sensors.weekday import DayOfWeekSensor +from airflow.triggers.external_task import DagStateTrigger, WorkflowTrigger +from airflow.triggers.file import FileTrigger +from airflow.triggers.temporal import DateTimeTrigger, TimeDeltaTrigger + +FSHook() +PackageIndexHook() +SubprocessHook() +BashOperator() +BranchDateTimeOperator() +TriggerDagRunOperator() +EmptyOperator() +LatestOnlyOperator() +( + BranchPythonOperator(), + PythonOperator(), + PythonVirtualenvOperator(), + ShortCircuitOperator(), +) +BranchDayOfWeekOperator() +DateTimeSensor(), DateTimeSensorAsync() +ExternalTaskMarker(), ExternalTaskSensor() +FileSensor() +TimeSensor(), TimeSensorAsync() +TimeDeltaSensor(), TimeDeltaSensorAsync() +DayOfWeekSensor() +DagStateTrigger(), WorkflowTrigger() +FileTrigger() +DateTimeTrigger(), TimeDeltaTrigger() diff --git a/crates/ruff_linter/resources/test/fixtures/airflow/AIR312_try.py b/crates/ruff_linter/resources/test/fixtures/airflow/AIR312_try.py new file mode 100644 index 0000000000000..f8cf9402b609a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/airflow/AIR312_try.py @@ -0,0 +1,8 @@ +from __future__ import annotations + +try: + from airflow.providers.standard.triggers.file import FileTrigger +except ModuleNotFoundError: + from airflow.triggers.file import FileTrigger + +FileTrigger() diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/assert.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/assert.py index bfb3ab9030e90..b2cea94541581 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/assert.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/assert.py @@ -9,3 +9,29 @@ def func(): def func(): assert False, "oops" + +def func(): + y = 2 + assert y == 2 + assert y > 1 + assert y < 3 + +def func(): + for i in range(3): + assert i < x + +def func(): + for j in range(3): + x = 2 + else: + assert False + return 1 + +def func(): + for j in range(3): + if j == 2: + print('yay') + break + else: + assert False + return 1 diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/for.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/for.py index 9aef74d5d027f..80d0af4eae2c7 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/for.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/for.py @@ -40,8 +40,6 @@ def func(): if True: break -# TODO(charlie): The `pass` here does not get properly redirected to the top of the -# loop, unlike below. def func(): for i in range(5): pass @@ -54,3 +52,59 @@ def func(): else: return 1 x = 1 + +def func(): + for i in range(5): + pass + else: + pass + +def func(): + for i in range(3): + if i == 2: + assert i is not None + break + else: + raise Exception() + x = 0 + +def func(): + for i in range(13): + for i in range(12): + x = 2 + if True: + break + + x = 3 + if True: + break + + print('hello') + + +def func(): + for i in range(13): + for i in range(12): + x = 2 + if True: + continue + + x = 3 + if True: + break + + print('hello') + + +def func(): + for i in range(13): + for i in range(12): + x = 2 + if True: + break + + x = 3 + if True: + continue + + print('hello') diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/if.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/if.py index 2b5fa420990ec..d505ef5857738 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/if.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/if.py @@ -106,3 +106,25 @@ def func(self, obj: BytesRep) -> bytes: self.error(f"can't resolve buffer '{id}'") return buffer.data + +def func(x): + if x == 1: + return 1 + elif False: + return 2 + elif x == 3: + return 3 + elif True: + return 4 + elif x == 5: + return 5 + elif x == 6: + return 6 + +def func(): + if x: + return + else: + assert x + + print('pop') diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/simple.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/simple.py index d1f710149b627..477955ce04af1 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/simple.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/simple.py @@ -21,3 +21,14 @@ def func(): i = 0 i += 2 return i + +def func(): + with x: + i = 0 + i = 1 + +def func(): + with x: + i = 0 + return 1 + i = 1 diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try-finally-nested-if-while.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try-finally-nested-if-while.py new file mode 100644 index 0000000000000..2f0bca473a31d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try-finally-nested-if-while.py @@ -0,0 +1,9 @@ +def l(): + while T: + try: + while (): + if 3: + break + finally: + return + diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try.py index e9f109dfd7bf6..9eeaf1811d695 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/try.py @@ -1,41 +1,130 @@ def func(): try: - ... + print("try") except Exception: - ... + print("Exception") except OtherException as e: - ... + print("OtherException") else: - ... + print("else") finally: - ... + print("finally") def func(): try: - ... - except Exception: - ... + print("try") + except: + print("Exception") + +def func(): + try: + print("try") + except: + print("Exception") + except OtherException as e: + print("OtherException") def func(): try: - ... + print("try") except Exception: - ... + print("Exception") except OtherException as e: - ... + print("OtherException") def func(): try: - ... + print("try") except Exception: - ... + print("Exception") except OtherException as e: - ... + print("OtherException") else: - ... + print("else") + +def func(): + try: + print("try") + finally: + print("finally") + +def func(): + try: + return 0 + except: + return 1 + finally: + return 2 + +def func(): + try: + raise Exception() + except: + print("reached") + +def func(): + try: + assert False + print("unreachable") + except: + print("reached") + +def func(): + try: + raise Exception() + finally: + print('reached') + return 2 + +def func(): + try: + assert False + print("unreachable") + finally: + print("reached") +# Test case from ibis caused overflow def func(): try: - ... + if catalog is not None: + try: + x = 0 + except PySparkParseException: + x = 1 + try: + x = 2 + except PySparkParseException: + x = 3 + x = 8 finally: - ... + if catalog is not None: + try: + x = 4 + except PySparkParseException: + x = 5 + try: + x = 6 + except PySparkParseException: + x = 7 + + +def func(): + try: + assert False + except ex: + raise ex + + finally: + raise Exception("other") + +# previously caused infinite loop +# found by fuzzer +def func(): + for i in(): + try: + try: + while r: + if t:break + finally:() + return + except:l diff --git a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/while.py b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/while.py index 6a4174358bdba..af509129c3d26 100644 --- a/crates/ruff_linter/resources/test/fixtures/control-flow-graph/while.py +++ b/crates/ruff_linter/resources/test/fixtures/control-flow-graph/while.py @@ -99,12 +99,39 @@ def func(): if True: break -''' -TODO: because `try` statements aren't handled this triggers a false positive as -the last statement is reached, but the rules thinks it isn't (it doesn't -see/process the break statement). +def func(): + while True: + x = 0 + x = 1 + break + x = 2 + x = 3 + +def func(): + while True: + x = 0 + x = 1 + continue + x = 2 + x = 3 + +def func(): + while True: + x = 0 + x = 1 + return + x = 2 + x = 3 + +def func(): + while True: + x = 0 + x = 1 + raise Exception + x = 2 + x = 3 -# Test case found in the Bokeh repository that trigger a false positive. +# Test case found in the Bokeh repository that triggered a false positive. def bokeh2(self, host: str = DEFAULT_HOST, port: int = DEFAULT_PORT) -> None: self.stop_serving = False while True: @@ -118,4 +145,12 @@ def bokeh2(self, host: str = DEFAULT_HOST, port: int = DEFAULT_PORT) -> None: port += 1 self.thread = threading.Thread(target=self._run_web_server) -''' + +def func(): + while T: + try: + while(): + if 3: + break + finally: + return diff --git a/crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py b/crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py index 08a211d2d569b..72c4f911196e2 100644 --- a/crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py +++ b/crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py @@ -76,3 +76,16 @@ class A(): # "requests<3", # "rich", # ] + +# Script tag block followed by normal block (Ok) + +# /// script +# # https://github.com/astral-sh/ruff/issues/15321 +# requires-python = ">=3.12" +# dependencies = [ +# "requests<3", +# "rich", +# ] +# /// +# +# Foobar diff --git a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST001.py b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST001.py index 0563e5c5f99f9..b425a5de91b65 100644 --- a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST001.py +++ b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST001.py @@ -108,3 +108,18 @@ async def create_item(item: Item) -> Dict[str, str]: @app.post("/items/", response_model=Item) async def create_item(item: Item) -> Item: return item + + +# Routes might be defined inside functions + + +def setup_app(app_arg: FastAPI, non_app: str) -> None: + # Error + @app_arg.get("/", response_model=str) + async def get_root() -> str: + return "Hello World!" + + # Ok + @non_app.get("/", response_model=str) + async def get_root() -> str: + return "Hello World!" diff --git a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002.py b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002.py deleted file mode 100644 index 4f1d19463b5ca..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002.py +++ /dev/null @@ -1,96 +0,0 @@ -from fastapi import ( - FastAPI, - APIRouter, - Query, - Path, - Body, - Cookie, - Header, - File, - Form, - Depends, - Security, -) -from pydantic import BaseModel - -app = FastAPI() -router = APIRouter() - - -# Fixable errors - -@app.get("/items/") -def get_items( - current_user: User = Depends(get_current_user), - some_security_param: str = Security(get_oauth2_user), -): - pass - - -@app.post("/stuff/") -def do_stuff( - some_query_param: str | None = Query(default=None), - some_path_param: str = Path(), - some_body_param: str = Body("foo"), - some_cookie_param: str = Cookie(), - some_header_param: int = Header(default=5), - some_file_param: UploadFile = File(), - some_form_param: str = Form(), -): - # do stuff - pass - -@app.get("/users/") -def get_users( - skip: int, - limit: int, - current_user: User = Depends(get_current_user), -): - pass - -@app.get("/users/") -def get_users( - current_user: User = Depends(get_current_user), - skip: int = 0, - limit: int = 10, -): - pass - - - -# Non fixable errors - -@app.get("/users/") -def get_users( - skip: int = 0, - limit: int = 10, - current_user: User = Depends(get_current_user), -): - pass - - -# Unchanged - - -@app.post("/stuff/") -def do_stuff( - no_default: Body("foo"), - no_type_annotation=str, - no_fastapi_default: str = BaseModel(), -): - pass - - -# OK - -@app.post("/stuff/") -def do_stuff( - some_path_param: Annotated[str, Path()], - some_cookie_param: Annotated[str, Cookie()], - some_file_param: Annotated[UploadFile, File()], - some_form_param: Annotated[str, Form()], - some_query_param: Annotated[str | None, Query()] = None, - some_body_param: Annotated[str, Body()] = "foo", - some_header_param: Annotated[int, Header()] = 5, -): - pass diff --git a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_0.py b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_0.py new file mode 100644 index 0000000000000..ed3f589459104 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_0.py @@ -0,0 +1,99 @@ +from fastapi import ( + FastAPI, + APIRouter, + Query, + Path, + Body, + Cookie, + Header, + File, + Form, + Depends, + Security, +) +from pydantic import BaseModel + +app = FastAPI() +router = APIRouter() + + +# Fixable errors + +@app.get("/items/") +def get_items( + current_user: User = Depends(get_current_user), + some_security_param: str = Security(get_oauth2_user), +): + pass + + +@app.post("/stuff/") +def do_stuff( + some_path_param: str = Path(), + some_cookie_param: str = Cookie(), + some_file_param: UploadFile = File(), + some_form_param: str = Form(), + some_query_param: str | None = Query(default=None), + some_body_param: str = Body("foo"), + some_header_param: int = Header(default=5), +): + # do stuff + pass + +@app.get("/users/") +def get_users( + skip: int, + limit: int, + current_user: User = Depends(get_current_user), +): + pass + +@app.get("/users/") +def get_users( + current_user: User = Depends(get_current_user), + skip: int = 0, + limit: int = 10, +): + pass + + +@app.get("/items/{item_id}") +async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): + pass + +# Non fixable errors + +@app.get("/users/") +def get_users( + skip: int = 0, + limit: int = 10, + current_user: User = Depends(get_current_user), +): + pass + + +# Unchanged + + +@app.post("/stuff/") +def do_stuff( + no_default: Body("foo"), + no_type_annotation=str, + no_fastapi_default: str = BaseModel(), +): + pass + + +# OK + +@app.post("/stuff/") +def do_stuff( + some_path_param: Annotated[str, Path()], + some_cookie_param: Annotated[str, Cookie()], + some_file_param: Annotated[UploadFile, File()], + some_form_param: Annotated[str, Form()], + some_query_param: Annotated[str | None, Query()] = None, + some_body_param: Annotated[str, Body()] = "foo", + some_header_param: Annotated[int, Header()] = 5, +): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_1.py b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_1.py new file mode 100644 index 0000000000000..de70967b09b4d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST002_1.py @@ -0,0 +1,21 @@ +"""Test that FAST002 doesn't suggest invalid Annotated fixes with default +values. See #15043 for more details.""" + +from fastapi import FastAPI, Query + +app = FastAPI() + + +@app.get("/test") +def handler(echo: str = Query("")): + return echo + + +@app.get("/test") +def handler2(echo: str = Query(default="")): + return echo + + +@app.get("/test") +def handler3(echo: str = Query("123", min_length=3, max_length=50)): + return echo diff --git a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST003.py b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST003.py index 6a3b14838d93e..ef808e733600d 100644 --- a/crates/ruff_linter/resources/test/fixtures/fastapi/FAST003.py +++ b/crates/ruff_linter/resources/test/fixtures/fastapi/FAST003.py @@ -1,6 +1,6 @@ from typing import Annotated -from fastapi import FastAPI, Path +from fastapi import Depends, FastAPI, Path app = FastAPI() @@ -144,3 +144,37 @@ async def read_thing(query: str): @app.get("/things/{thing_id=}") async def read_thing(query: str): return {"query": query} + + +# https://github.com/astral-sh/ruff/issues/13657 +def takes_thing_id(thing_id): ... +def something_else(lorem): ... + +from foo import unknown_imported +unknown_not_function = unknown_imported() + + +### Errors +@app.get("/things/{thing_id}") +async def single(other: Annotated[str, Depends(something_else)]): ... +@app.get("/things/{thing_id}") +async def default(other: str = Depends(something_else)): ... + + +### No errors +# A parameter with multiple `Depends()` has undefined behaviour. +# https://github.com/astral-sh/ruff/pull/15364#discussion_r1912551710 +@app.get("/things/{thing_id}") +async def single(other: Annotated[str, Depends(takes_thing_id)]): ... +@app.get("/things/{thing_id}") +async def double(other: Annotated[str, Depends(something_else), Depends(takes_thing_id)]): ... +@app.get("/things/{thing_id}") +async def double(other: Annotated[str, Depends(takes_thing_id), Depends(something_else)]): ... +@app.get("/things/{thing_id}") +async def default(other: str = Depends(takes_thing_id)): ... +@app.get("/things/{thing_id}") +async def unknown_1(other: str = Depends(unknown_unresolved)): ... +@app.get("/things/{thing_id}") +async def unknown_2(other: str = Depends(unknown_not_function)): ... +@app.get("/things/{thing_id}") +async def unknown_3(other: str = Depends(unknown_imported)): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_annotations/annotation_presence.py b/crates/ruff_linter/resources/test/fixtures/flake8_annotations/annotation_presence.py index b84ec16576854..4ef4e2220bb93 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_annotations/annotation_presence.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_annotations/annotation_presence.py @@ -71,7 +71,7 @@ class Foo: def foo(self: "Foo", a: int, b: int) -> int: pass - # ANN101 + # OK def foo(self, a: int, b: int) -> int: pass @@ -125,12 +125,12 @@ def foo(self: "Foo", a: int, *params: str, **options: Any) -> int: def foo(cls: Type["Foo"], a: int, b: int) -> int: pass - # ANN102 + # OK @classmethod def foo(cls, a: int, b: int) -> int: pass - # ANN101 + # OK def foo(self, /, a: int, b: int) -> int: pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S102.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S102.py index 4c346d55459d3..e945b224c568f 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S102.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S102.py @@ -3,3 +3,13 @@ def fn(): exec('x = 2') exec('y = 3') + + +## https://github.com/astral-sh/ruff/issues/15442 +def _(): + from builtins import exec + exec('') # Error + +def _(): + from builtin import exec + exec('') # No error diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S105.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S105.py index 6287a68a51610..3f6b9205dde11 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S105.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S105.py @@ -21,6 +21,8 @@ password = safe = "s3cr3t" PASSWORD = "s3cr3t" PassWord = "s3cr3t" +password: str = "s3cr3t" +password: Final = "s3cr3t" d["password"] = "s3cr3t" d["pass"] = "s3cr3t" diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S301.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S301.py index 6d92efc896db4..5e1a07b3bb5e4 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S301.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S301.py @@ -1,3 +1,8 @@ import pickle pickle.loads() + + +# https://github.com/astral-sh/ruff/issues/15522 +map(pickle.load, []) +foo = pickle.load diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S307.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S307.py index 06bccc084a803..38c2153f787ba 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S307.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S307.py @@ -10,3 +10,8 @@ def eval(self): def foo(self): self.eval() # OK + + +# https://github.com/astral-sh/ruff/issues/15522 +map(eval, []) +foo = eval diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S308.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S308.py index 45a335b00c3d7..c952036b1ce41 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S308.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S308.py @@ -1,8 +1,16 @@ from django.utils.safestring import mark_safe -def some_func(): - return mark_safe('<script>alert("evil!")</script>') +def bad_func(): + inject = "harmful_input" + mark_safe(inject) + mark_safe("I will add" + inject + "to my string") + mark_safe("I will add %s to my string" % inject) + mark_safe("I will add {} to my string".format(inject)) + mark_safe(f"I will add {inject} to my string") + +def good_func(): + mark_safe("I won't inject anything") @mark_safe @@ -13,10 +21,23 @@ def some_func(): from django.utils.html import mark_safe -def some_func(): - return mark_safe('<script>alert("evil!")</script>') +def bad_func(): + inject = "harmful_input" + mark_safe(inject) + mark_safe("I will add" + inject + "to my string") + mark_safe("I will add %s to my string" % inject) + mark_safe("I will add {} to my string".format(inject)) + mark_safe(f"I will add {inject} to my string") + +def good_func(): + mark_safe("I won't inject anything") @mark_safe def some_func(): return '<script>alert("evil!")</script>' + + +# https://github.com/astral-sh/ruff/issues/15522 +map(mark_safe, []) +foo = mark_safe diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S310.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S310.py index 7467f79cc65d5..62ec7108fa1f0 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S310.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S310.py @@ -40,3 +40,8 @@ urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) urllib.request.urlopen(urllib.request.Request('file:///foo/bar/baz')) urllib.request.urlopen(urllib.request.Request(url)) + + +# https://github.com/astral-sh/ruff/issues/15522 +map(urllib.request.urlopen, []) +foo = urllib.request.urlopen diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S311.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S311.py index 5c0c0e6b57d0b..0dc85e118e6c2 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S311.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S311.py @@ -20,3 +20,8 @@ # Unrelated os.urandom() a_lib.random() + + +# https://github.com/astral-sh/ruff/issues/15522 +map(random.randrange, []) +foo = random.randrange diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S312.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S312.py index 8bfa3850fa2d4..2dceb42f8f0b0 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S312.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S312.py @@ -1,3 +1,16 @@ from telnetlib import Telnet Telnet("localhost", 23) + + +# https://github.com/astral-sh/ruff/issues/15522 +map(Telnet, []) +foo = Telnet + +import telnetlib +_ = telnetlib.Telnet + +from typing import Annotated +foo: Annotated[Telnet, telnetlib.Telnet()] + +def _() -> Telnet: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S324.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S324.py index c3cb83e4d386d..fe94653f2ead1 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S324.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S324.py @@ -45,3 +45,10 @@ crypt.mksalt() crypt.mksalt(crypt.METHOD_SHA256) crypt.mksalt(crypt.METHOD_SHA512) + +# From issue: https://github.com/astral-sh/ruff/issues/16525#issuecomment-2706188584 +# Errors +hashlib.new("Md5") + +# OK +hashlib.new('Sha256') diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S401.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S401.pyi new file mode 100644 index 0000000000000..6e4f7355fc43c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S401.pyi @@ -0,0 +1,2 @@ +import telnetlib +from telnetlib import Telnet diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S402.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S402.pyi new file mode 100644 index 0000000000000..c5f449092b70e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S402.pyi @@ -0,0 +1,2 @@ +import ftplib +from ftplib import FTP diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S403.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S403.pyi new file mode 100644 index 0000000000000..9972a53548750 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S403.pyi @@ -0,0 +1,8 @@ +import dill +from dill import objects +import shelve +from shelve import open +import cPickle +from cPickle import load +import pickle +from pickle import load diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S404.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S404.pyi new file mode 100644 index 0000000000000..7db7e0c9f085a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S404.pyi @@ -0,0 +1,3 @@ +import subprocess +from subprocess import Popen +from subprocess import Popen as pop diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S405.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S405.pyi new file mode 100644 index 0000000000000..051c51a3d0cd2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S405.pyi @@ -0,0 +1,4 @@ +import xml.etree.cElementTree +from xml.etree import cElementTree +import xml.etree.ElementTree +from xml.etree import ElementTree diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S406.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S406.pyi new file mode 100644 index 0000000000000..446bc8b388593 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S406.pyi @@ -0,0 +1,3 @@ +from xml import sax +import xml.sax as xmls +import xml.sax diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S407.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S407.pyi new file mode 100644 index 0000000000000..9fd44c6a45243 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S407.pyi @@ -0,0 +1,2 @@ +from xml.dom import expatbuilder +import xml.dom.expatbuilder diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S408.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S408.pyi new file mode 100644 index 0000000000000..5c39468132bc0 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S408.pyi @@ -0,0 +1,2 @@ +from xml.dom.minidom import parseString +import xml.dom.minidom diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S409.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S409.pyi new file mode 100644 index 0000000000000..24445bcb78b7a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S409.pyi @@ -0,0 +1,2 @@ +from xml.dom.pulldom import parseString +import xml.dom.pulldom diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S410.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S410.pyi new file mode 100644 index 0000000000000..a39e9731cd040 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S410.pyi @@ -0,0 +1,2 @@ +import lxml +from lxml import etree diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S411.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S411.pyi new file mode 100644 index 0000000000000..946813ca76e0d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S411.pyi @@ -0,0 +1,2 @@ +import xmlrpc +from xmlrpc import server diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S412.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S412.pyi new file mode 100644 index 0000000000000..087d2ca09a0d7 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S412.pyi @@ -0,0 +1 @@ +from twisted.web.twcgi import CGIScript diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S413.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S413.pyi new file mode 100644 index 0000000000000..ff7a181648a84 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S413.pyi @@ -0,0 +1,4 @@ +import Crypto.Hash +from Crypto.Hash import MD2 +import Crypto.PublicKey +from Crypto.PublicKey import RSA diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S415.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S415.pyi new file mode 100644 index 0000000000000..ad861eec8ba2b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S415.pyi @@ -0,0 +1,2 @@ +import pyghmi +from pyghmi import foo diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S603.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S603.py index da9b2dae3f0cf..f46d3d487243c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S603.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S603.py @@ -1,20 +1,47 @@ from subprocess import Popen, call, check_call, check_output, run # Different Popen wrappers are checked. +a = input() +Popen(a, shell=False) +call(a, shell=False) +check_call(a, shell=False) +check_output(a, shell=False) +run(a, shell=False) + +# Falsey values are treated as false. +Popen(a, shell=0) +Popen(a, shell=[]) +Popen(a, shell={}) +Popen(a, shell=None) + +# Unknown values are treated as falsey. +Popen(a, shell=True if True else False) + +# No value is also caught. +Popen(a) + +# Literals are fine, they're trusted. +run("true") +Popen(["true"]) Popen("true", shell=False) call("true", shell=False) check_call("true", shell=False) check_output("true", shell=False) run("true", shell=False) -# Values that falsey values are treated as false. -Popen("true", shell=0) -Popen("true", shell=[]) -Popen("true", shell={}) -Popen("true", shell=None) +# Not through assignments though. +cmd = ["true"] +run(cmd) -# Unknown values are treated as falsey. -Popen("true", shell=True if True else False) +# Instant named expressions are fine. +run(c := "true") -# No value is also caught. -Popen("true") +# But non-instant are not. +(e := "echo") +run(e) + + +# https://github.com/astral-sh/ruff/issues/17798 +# Tuple literals are trusted +check_output(("literal", "cmd", "using", "tuple"), text=True) +Popen(("literal", "cmd", "using", "tuple")) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S608.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S608.py index 5377eb264c02d..447e46dcf25c0 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S608.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S608.py @@ -151,6 +151,21 @@ def query54(): FROM {var}.table """ -# to be handled seperately +# to be handled separately # query58 = f"SELECT\ # * FROM {var}.table" + + +# https://github.com/astral-sh/ruff/issues/15653 +query59 = f""" + SELECT *, foo + FROM ({user_input}) raw +""" +query60 = f""" + SELECT *, + foo + FROM ({user_input}) raw +""" + +# https://github.com/astral-sh/ruff/issues/17967 +query61 = f"SELECT * FROM table" # skip expressionless f-strings diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704.py new file mode 100644 index 0000000000000..41cc8bc44b840 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704.py @@ -0,0 +1,18 @@ +import flask +from markupsafe import Markup, escape + +content = "<script>alert('Hello, world!')</script>" +Markup(f"unsafe {content}") # S704 +flask.Markup("unsafe {}".format(content)) # S704 +Markup("safe {}").format(content) +flask.Markup(b"safe {}", encoding='utf-8').format(content) +escape(content) +Markup(content) # S704 +flask.Markup("unsafe %s" % content) # S704 +Markup(object="safe") +Markup(object="unsafe {}".format(content)) # Not currently detected + +# NOTE: We may be able to get rid of these false positives with ty +# if it includes comprehensive constant expression detection/evaluation. +Markup("*" * 8) # S704 (false positive) +flask.Markup("hello {}".format("world")) # S704 (false positive) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_extend_markup_names.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_extend_markup_names.py new file mode 100644 index 0000000000000..61612d4d02c13 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_extend_markup_names.py @@ -0,0 +1,6 @@ +from markupsafe import Markup +from webhelpers.html import literal + +content = "<script>alert('Hello, world!')</script>" +Markup(f"unsafe {content}") # S704 +literal(f"unsafe {content}") # S704 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_skip_early_out.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_skip_early_out.py new file mode 100644 index 0000000000000..6bedf7441134f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_skip_early_out.py @@ -0,0 +1,7 @@ +from webhelpers.html import literal + +# NOTE: This test case exists to make sure our optimization doesn't cause +# additional markup names to be skipped if we don't import either +# markupsafe or flask first. +content = "<script>alert('Hello, world!')</script>" +literal(f"unsafe {content}") # S704 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_whitelisted_markup_calls.py b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_whitelisted_markup_calls.py new file mode 100644 index 0000000000000..146517a1a1d01 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bandit/S704_whitelisted_markup_calls.py @@ -0,0 +1,9 @@ +from bleach import clean +from markupsafe import Markup + +content = "<script>alert('Hello, world!')</script>" +Markup(clean(content)) + +# indirect assignments are currently not supported +cleaned = clean(content) +Markup(cleaned) # S704 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_boolean_trap/FBT.py b/crates/ruff_linter/resources/test/fixtures/flake8_boolean_trap/FBT.py index 32074fb46765b..1c872e44acbce 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_boolean_trap/FBT.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_boolean_trap/FBT.py @@ -94,7 +94,7 @@ def foo(self) -> None: object.__setattr__(self, "flag", True) -from typing import Optional, Union +from typing import Optional, Union, Self def func(x: Union[list, Optional[int | str | float | bool]]): @@ -154,3 +154,23 @@ def __post_init__(self, force: bool) -> None: class Settings(BaseSettings): foo: bool = Field(True, exclude=True) + + +# https://github.com/astral-sh/ruff/issues/14202 +class SupportsXorBool: + def __xor__(self, other: bool) -> Self: ... + +# check overload +class CustomFloat: + @overload + def __mul__(self, other: bool) -> Self: ... + @overload + def __mul__(self, other: float) -> Self: ... + @overload + def __mul__(self, other: Self) -> Self: ... + +# check union +class BooleanArray: + def __or__(self, other: Self | bool) -> Self: ... + def __ror__(self, other: Self | bool) -> Self: ... + def __ior__(self, other: Self | bool) -> Self: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B006_1.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B006_1.pyi new file mode 100644 index 0000000000000..020aca472529b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B006_1.pyi @@ -0,0 +1,10 @@ +# we disable this rule for pyi files + +def mquantiles( + a: _ArrayLikeFloat_co, + prob: _ArrayLikeFloat_co = [0.25, 0.5, 0.75], + alphap: AnyReal = 0.4, + betap: AnyReal = 0.4, + axis: CanIndex | None = None, + limit: tuple[AnyReal, AnyReal] | tuple[()] = (), +) -> _MArrayND: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B008_extended.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B008_extended.py index a9a6f1496394b..0d7175daa0ea2 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B008_extended.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B008_extended.py @@ -35,3 +35,14 @@ def okay(obj=Class()): def error(obj=OtherClass()): ... + + +# https://github.com/astral-sh/ruff/issues/12717 + +from typing import NewType + +N = NewType("N", int) +L = NewType("L", list[str]) + +def okay(obj = N()): ... +def error(obj = L()): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B025.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B025.py index 085f82f343c91..c2b2a1fefac87 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B025.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B025.py @@ -1,6 +1,6 @@ """ Should emit: -B025 - on lines 15, 22, 31 +B025 - on lines 15, 22, 31, 40, 47, 56 """ import pickle @@ -36,3 +36,28 @@ a = 2 except (OSError, TypeError): a = 2 + +try: + a = 1 +except* ValueError: + a = 2 +except* ValueError: + a = 2 + +try: + a = 1 +except* pickle.PickleError: + a = 2 +except* ValueError: + a = 2 +except* pickle.PickleError: + a = 2 + +try: + a = 1 +except* (ValueError, TypeError): + a = 2 +except* ValueError: + a = 2 +except* (OSError, TypeError): + a = 2 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B028.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B028.py index a2915f29adf08..54362a5070eb6 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B028.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B028.py @@ -5,7 +5,31 @@ B028 - on lines 8 and 9 """ -warnings.warn(DeprecationWarning("test")) -warnings.warn(DeprecationWarning("test"), source=None) -warnings.warn(DeprecationWarning("test"), source=None, stacklevel=2) -warnings.warn(DeprecationWarning("test"), stacklevel=1) +warnings.warn("test", DeprecationWarning) +warnings.warn("test", DeprecationWarning, source=None) +warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) +warnings.warn("test", DeprecationWarning, stacklevel=1) +warnings.warn("test", DeprecationWarning, 1) +warnings.warn("test", category=DeprecationWarning, stacklevel=1) +args = ("test", DeprecationWarning, 1) +warnings.warn(*args) +kwargs = {"message": "test", "category": DeprecationWarning, "stacklevel": 1} +warnings.warn(**kwargs) +args = ("test", DeprecationWarning) +kwargs = {"stacklevel": 1} +warnings.warn(*args, **kwargs) + +warnings.warn( + "test", + DeprecationWarning, + # some comments here + source = None # no trailing comma + ) + +# https://github.com/astral-sh/ruff/issues/18011 +warnings.warn("test", skip_file_prefixes=(os.path.dirname(__file__),)) +# trigger diagnostic if `skip_file_prefixes` is present and set to the default value +warnings.warn("test", skip_file_prefixes=()) + +_my_prefixes = ("this","that") +warnings.warn("test", skip_file_prefixes = _my_prefixes) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B029.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B029.py index beb04a4059392..f30d0b387b886 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B029.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B029.py @@ -1,6 +1,6 @@ """ Should emit: -B029 - on lines 8 and 13 +B029 - on lines 8, 13, 18 and 23 """ try: @@ -11,4 +11,14 @@ try: pass except () as e: - pass \ No newline at end of file + pass + +try: + pass +except* (): + pass + +try: + pass +except* () as e: + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B030.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B030.py index 098f724249ac2..d9e2f94d23f8a 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B030.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B030.py @@ -130,3 +130,23 @@ def what_to_catch(): pass except (a, b) * (c, d): # B030 pass + +try: + pass +except* 1: # Error + pass + +try: + pass +except* (1, ValueError): # Error + pass + +try: + pass +except* (ValueError, (RuntimeError, (KeyError, TypeError))): # Error + pass + +try: + pass +except* (a, b) * (c, d): # B030 + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B033.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B033.py index d4a2eb4d118ae..c0e0ec6faf820 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B033.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B033.py @@ -19,6 +19,7 @@ 1, 1, } +incorrect_set = {False, 1, 0} ### # Non-errors. diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B039.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B039.py index 7d96075f15697..d5ddbee8a1d07 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B039.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B039.py @@ -14,6 +14,8 @@ ContextVar("cv", default=MappingProxyType({})) ContextVar("cv", default=re.compile("foo")) ContextVar("cv", default=float(1)) +ContextVar("cv", default=frozenset[str]()) +ContextVar[frozenset[str]]("cv", default=frozenset[str]()) # Bad ContextVar("cv", default=[]) @@ -25,6 +27,8 @@ ContextVar("cv", default={char for char in "foo"}) ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) ContextVar("cv", default=collections.deque()) +ContextVar("cv", default=set[str]()) +ContextVar[set[str]]("cv", default=set[str]()) def bar() -> list[int]: return [1, 2, 3] diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B904.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B904.py index ec4bc9e6f3a12..d752aeca6e9d6 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B904.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B904.py @@ -1,6 +1,6 @@ """ Should emit: -B904 - on lines 10, 11, 16, 62, and 64 +B904 - on lines 10, 11, 16, 62, 64, 79, 81, 87, 88, 93 and 97 """ try: @@ -71,3 +71,29 @@ def context_switch(): match 0: case 0: raise RuntimeError("boom!") + +try: + ... +except* Exception as e: + if ...: + raise RuntimeError("boom!") + else: + raise RuntimeError("bang!") + +try: + raise ValueError +except* ValueError: + if "abc": + raise TypeError + raise UserWarning +except* AssertionError: + raise # Bare `raise` should not be an error +except* Exception as err: + assert err + raise Exception("No cause here...") +except* BaseException as err: + raise err +except* BaseException as err: + raise some_other_err +finally: + raise Exception("Nothing to chain from, so no warning here") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B911.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B911.py new file mode 100644 index 0000000000000..44a027a88a7b0 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/B911.py @@ -0,0 +1,59 @@ +from itertools import batched, count, cycle, repeat + + +# Errors +batched(range(3), 1) +batched("abc", 2) +batched([i for i in range(42)], some_n) +batched((foo for foo in cycle())) +batched(itertools.batched([1, 2, 3], strict=True)) + +# Errors (limited iterators). +batched(repeat(1, 1)) +batched(repeat(1, times=4)) + +# No fix +batched([], **kwargs) + +# No errors +batched() +batched(range(3), 0, strict=True) +batched(["a", "b"], count, strict=False) +batched(("a", "b", "c"), zip(repeat()), strict=True) + +# No errors (infinite iterators) +batched(cycle("ABCDEF"), 3) +batched(count(), qux + lorem) +batched(repeat(1), ipsum // 19 @ 0x1) +batched(repeat(1, None)) +batched(repeat(1, times=None)) + + +import itertools + +# Errors +itertools.batched(range(3), 1) +itertools.batched("abc", 2) +itertools.batched([i for i in range(42)], some_n) +itertools.batched((foo for foo in cycle())) +itertools.batched(itertools.batched([1, 2, 3], strict=True)) + +# Errors (limited iterators). +itertools.batched(repeat(1, 1)) +itertools.batched(repeat(1, times=4)) + +# No fix +itertools.batched([], **kwargs) + +# No errors +itertools.batched() +itertools.batched(range(3), 0, strict=True) +itertools.batched(["a", "b"], count, strict=False) +itertools.batched(("a", "b", "c"), zip(repeat()), strict=True) + +# No errors (infinite iterators) +itertools.batched(cycle("ABCDEF"), 3) +itertools.batched(count(), qux + lorem) +itertools.batched(repeat(1), ipsum // 19 @ 0x1) +itertools.batched(repeat(1, None)) +itertools.batched(repeat(1, times=None)) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/class_as_data_structure.py b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/class_as_data_structure.py new file mode 100644 index 0000000000000..9d4f8c2cac1df --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_bugbear/class_as_data_structure.py @@ -0,0 +1,104 @@ +from __future__ import annotations + +from dataclasses import dataclass + + +class Point: # B903 + def __init__(self, x: float, y: float) -> None: + self.x = x + self.y = y + + +class Rectangle: # OK + def __init__(self, top_left: Point, bottom_right: Point) -> None: + ... + + def area(self) -> float: + ... + + +@dataclass +class Circle: # OK + center: Point + radius: float + + def area(self) -> float: + ... + + +class CustomException(Exception): # OK + ... + + +class A: # OK + class B: + ... + + def __init__(self): + ... + +class C: # B903 + c: int + def __init__(self,d:list): + self.d = d + +class D: # B903 + """This class has a docstring.""" + # this next method is an init + def __init__(self,e:dict): + self.e = e + +# <--- begin flake8-bugbear tests below +# (we have modified them to have type annotations, +# since our implementation only triggers in that +# stricter setting.) +class NoWarningsMoreMethods: + def __init__(self, foo:int, bar:list): + self.foo = foo + self.bar = bar + + def other_function(self): ... + + +class NoWarningsClassAttributes: + spam = "ham" + + def __init__(self, foo:int, bar:list): + self.foo = foo + self.bar = bar + + +class NoWarningsComplicatedAssignment: + def __init__(self, foo:int, bar:list): + self.foo = foo + self.bar = bar + self.spam = " - ".join([foo, bar]) + + +class NoWarningsMoreStatements: + def __init__(self, foo:int, bar:list): + foo = " - ".join([foo, bar]) + self.foo = foo + self.bar = bar + + +class Warnings: + def __init__(self, foo:int, bar:list): + self.foo = foo + self.bar = bar + + +class WarningsWithDocstring: + """A docstring should not be an impediment to a warning""" + + def __init__(self, foo:int, bar:list): + self.foo = foo + self.bar = bar + + +class KeywordOnly: # OK with python3.9 or less, not OK starting python3.10 + def __init__(self, *, foo: int, bar: int): + self.foo = foo + self.bar = bar + +# <-- end flake8-bugbear tests diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A001.py b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A001.py index a3a51183425dd..031855f39ee26 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A001.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A001.py @@ -28,3 +28,13 @@ class slice: pass [0 for sum in ()] + + +# These should not report violations as discussed in +# https://github.com/astral-sh/ruff/issues/16373 +from importlib.machinery import SourceFileLoader +__doc__ = "..." +__name__ = "a001" +__loader__ = SourceFileLoader(__file__, __name__) +__package__ = None +__spec__ = None \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A002.py b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A002.py index 5dc8d11fcf42d..d235b8ff82f92 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A002.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A002.py @@ -10,6 +10,8 @@ async def func3(id, dir): pass +# this is Ok for A002 (trigger A005 instead) +# https://github.com/astral-sh/ruff/issues/14135 map([], lambda float: ...) from typing import override, overload diff --git a/crates/ruff_linter/__init__.py b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/_abc/__init__.py similarity index 100% rename from crates/ruff_linter/__init__.py rename to crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/_abc/__init__.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/package/collections.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/package/collections.pyi new file mode 100644 index 0000000000000..70bf683346e7f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/package/collections.pyi @@ -0,0 +1 @@ +# A005 does not apply to stub files! diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/__init__.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/utils/__init__.py similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/__init__.pyi rename to crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/utils/__init__.py diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_packager.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/utils/logging.py similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_packager.pyi rename to crates/ruff_linter/resources/test/fixtures/flake8_builtins/A005/modules/utils/logging.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A006.py b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A006.py index 629ce4165ccc2..eabbeb41244a9 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A006.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_builtins/A006.py @@ -3,3 +3,8 @@ lambda min, max: min lambda id: id lambda dir: dir + +# Ok for A006 - should trigger A002 instead +# https://github.com/astral-sh/ruff/issues/14135 +def func1(str, /, type, *complex, Exception, **getattr): + pass \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C400.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C400.py index 5c347f72adf58..465e1f32d031b 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C400.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C400.py @@ -16,6 +16,17 @@ list(((2 * x for x in range(3)))) list((((2 * x for x in range(3))))) +# Account for trailing comma in fix +# See https://github.com/astral-sh/ruff/issues/15852 +list((0 for _ in []),) +list( + (0 for _ in []) + # some comments + , + # some more + ) + + # Not built-in list. def list(*args, **kwargs): return None diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C401.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C401.py index 6f54b249a6a11..7d7ee4c556fbe 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C401.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C401.py @@ -1,4 +1,4 @@ -# Cannot conbime with C416. Should use set comprehension here. +# Cannot combine with C416. Should use set comprehension here. even_nums = set(2 * x for x in range(3)) odd_nums = set( 2 * x + 1 for x in range(3) @@ -21,6 +21,20 @@ def f(x): print(f"{set(a for a in 'abc') - set(a for a in 'ab')}") print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") +# Strip parentheses from inner generators. +set((2 * x for x in range(3))) +set(((2 * x for x in range(3)))) +set((((2 * x for x in range(3))))) + +# Account for trailing comma in fix +# See https://github.com/astral-sh/ruff/issues/15852 +set((0 for _ in []),) +set( + (0 for _ in []) + # some comments + , + # some more +) # Not built-in set. def set(*args, **kwargs): diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C403.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C403.py index 989581c5bc2ad..c1a9feb24cdc1 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C403.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C403.py @@ -21,3 +21,17 @@ def f(x): s = set([ # comment x for x in range(3) ]) + +s = set(([x for x in range(3)])) + +s = set(((([x for x in range(3)])))) + +s = set( # outer set comment +( # inner paren comment - not preserved +(( +[ # comprehension comment + x for x in range(3)] + )))) + +# Test trailing comma case +s = set([x for x in range(3)],) \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C410.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C410.py index 6e6c977bb6472..2f8ef83b4e7e0 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C410.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C410.py @@ -11,3 +11,7 @@ list([ # comment 1, 2 ]) + +# Skip when too many positional arguments +# See https://github.com/astral-sh/ruff/issues/15810 +list([1],[2]) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C411.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C411.py index 8cb272217b881..8d1ce8b1266cc 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C411.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C411.py @@ -1,2 +1,8 @@ x = [1, 2, 3] list([i for i in x]) + +# Skip when too many positional arguments +# or keyword argument present. +# See https://github.com/astral-sh/ruff/issues/15810 +list([x for x in "XYZ"],[]) +list([x for x in "XYZ"],foo=[]) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C413.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C413.py index 28b3e1ee3f19f..54c9e90b7807c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C413.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C413.py @@ -17,3 +17,13 @@ # Regression test for: https://github.com/astral-sh/ruff/issues/10335 reversed(sorted([1, 2, 3], reverse=False or True)) reversed(sorted([1, 2, 3], reverse=(False or True))) + +# These fixes need to be parenthesized to avoid syntax errors and behavior +# changes. +# See https://github.com/astral-sh/ruff/issues/15789 +reversed(sorted +("")) +list(sorted + ("")) +list(sorted +("xy")) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C416.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C416.py index 2e554bdb8170e..e77b22121543a 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C416.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C416.py @@ -8,6 +8,7 @@ {k: v for k, v in y} {k: v for k, v in d.items()} [(k, v) for k, v in d.items()] +[(k, v) for [k, v] in d.items()] {k: (a, b) for k, (a, b) in d.items()} [i for i, in z] @@ -22,3 +23,7 @@ # Regression test for: https://github.com/astral-sh/ruff/issues/7196 any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in[t for t in SymbolType]) + +zz = [[1], [2], [3]] +[(i,) for (i,) in zz] # != list(zz) +{(i,) for (i,) in zz} # != set(zz) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417.py index 18b6525be62fd..8380774d9fd53 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417.py @@ -6,12 +6,12 @@ set(map(lambda x: x % 2 == 0, nums)) dict(map(lambda v: (v, v**2), nums)) dict(map(lambda v: [v, v**2], nums)) -map(lambda: "const", nums) + map(lambda _: 3.0, nums) _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) all(map(lambda v: isinstance(v, dict), nums)) filter(func, map(lambda v: v, nums)) -list(map(lambda x, y: x * y, nums)) + # When inside f-string, then the fix should be surrounded by whitespace _ = f"{set(map(lambda x: x % 2 == 0, nums))}" @@ -47,3 +47,26 @@ def func(arg1: int, arg2: int = 4): map(lambda x: x, y if y else z) map(lambda x: x, (y if y else z)) map(lambda x: x, (x, y, z)) + +# See https://github.com/astral-sh/ruff/issues/14808 +# The following should be Ok since +# named expressions are a syntax error inside comprehensions +a = [1, 2, 3] +b = map(lambda x: x, c := a) +print(c) + +# Check nested as well +map(lambda x:x, [c:=a]) + + +# https://github.com/astral-sh/ruff/issues/15796 +map(lambda: "const", nums) +list(map(lambda x, y: x * y, nums)) + + +map(lambda: 1, "xyz") +map(lambda x, y: x, [(1, 2), (3, 4)]) +list(map(lambda: 1, "xyz")) +list(map(lambda x, y: x, [(1, 2), (3, 4)])) +list(map(lambda: 1, "xyz")) +list(map(lambda x, y: x, [(1, 2), (3, 4)])) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417_1.py new file mode 100644 index 0000000000000..1edc7f8e8db2b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C417_1.py @@ -0,0 +1,28 @@ +##### https://github.com/astral-sh/ruff/issues/15809 + +### Errors + +def overshadowed_list(): + list = ... + list(map(lambda x: x, [])) + + +### No errors + +dict(map(lambda k: (k,), a)) +dict(map(lambda k: (k, v, 0), a)) +dict(map(lambda k: [k], a)) +dict(map(lambda k: [k, v, 0], a)) +dict(map(lambda k: {k, v}, a)) +dict(map(lambda k: {k: 0, v: 1}, a)) + +a = [(1, 2), (3, 4)] +map(lambda x: [*x, 10], *a) +map(lambda x: [*x, 10], *a, *b) +map(lambda x: [*x, 10], a, *b) + + +map(lambda x: x + 10, (a := [])) +list(map(lambda x: x + 10, (a := []))) +set(map(lambda x: x + 10, (a := []))) +dict(map(lambda x: (x, 10), (a := []))) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C418.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C418.py index 01e9be2c0d597..0663ed0f088eb 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C418.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C418.py @@ -8,3 +8,6 @@ dict({}, a=1) dict({x: 1 for x in range(1)}, a=1) +# Skip when too many positional arguments +# See https://github.com/astral-sh/ruff/issues/15810 +dict({"A": 1}, {"B": 2}) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C420_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C420_1.py new file mode 100644 index 0000000000000..550b6d9c2e6f5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_comprehensions/C420_1.py @@ -0,0 +1,7 @@ +{x: NotImplemented for x in "XY"} + + +# Builtin bindings are placed at top of file, but should not count as +# an "expression defined within the comprehension". So the above +# should trigger C420 +# See https://github.com/astral-sh/ruff/issues/15830 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ005.py b/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ005.py index 5d6f8596b6694..5ed541ea02406 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ005.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ005.py @@ -19,3 +19,21 @@ # uses `astimezone` method datetime.now().astimezone() +datetime.now().astimezone + + +# https://github.com/astral-sh/ruff/issues/15998 + +## Errors +datetime.now().replace.astimezone() +datetime.now().replace[0].astimezone() +datetime.now()().astimezone() +datetime.now().replace(datetime.now()).astimezone() + +foo.replace(datetime.now().replace).astimezone() + +## No errors +datetime.now().replace(microsecond=0).astimezone() +datetime.now().replace(0).astimezone() +datetime.now().replace(0).astimezone +datetime.now().replace(0).replace(1).astimezone diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ901.py b/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ901.py new file mode 100644 index 0000000000000..bd6fa399f56c2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_datetimez/DTZ901.py @@ -0,0 +1,42 @@ +import datetime + + +# Error +datetime.datetime.max +datetime.datetime.min + +datetime.datetime.max.replace(year=...) +datetime.datetime.min.replace(hour=...) + + +# No error +datetime.datetime.max.replace(tzinfo=...) +datetime.datetime.min.replace(tzinfo=...) + +datetime.datetime.max.time() +datetime.datetime.min.time() + +datetime.datetime.max.time(foo=...) +datetime.datetime.min.time(foo=...) + + +from datetime import datetime + + +# Error +datetime.max +datetime.min + +datetime.max.replace(year=...) +datetime.min.replace(hour=...) + + +# No error +datetime.max.replace(tzinfo=...) +datetime.min.replace(tzinfo=...) + +datetime.max.time() +datetime.min.time() + +datetime.max.time(foo=...) +datetime.min.time(foo=...) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_debugger/T100.py b/crates/ruff_linter/resources/test/fixtures/flake8_debugger/T100.py index 8154f1a4cd19f..d876c575dfc84 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_debugger/T100.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_debugger/T100.py @@ -23,3 +23,21 @@ enable_attach() break_into_debugger() wait_for_attach() + + +# also flag `breakpointhook` from `sys` but obviously not `sys` itself. see +# https://github.com/astral-sh/ruff/issues/16189 +import sys # ok + +def scope(): + from sys import breakpointhook # error + + breakpointhook() # error + +def scope(): + from sys import __breakpointhook__ # error + + __breakpointhook__() # error + +sys.breakpointhook() # error +sys.__breakpointhook__() # error diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_django/DJ012.py b/crates/ruff_linter/resources/test/fixtures/flake8_django/DJ012.py index 20d3e4078ba96..6a0079ed5b50d 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_django/DJ012.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_django/DJ012.py @@ -145,3 +145,11 @@ def __str__(self): first_name = models.CharField(max_length=32) + +# https://github.com/astral-sh/ruff/issues/13892 +class DunderMethodOtherThanStrBeforeSave(models.Model): + name = models.CharField() + + def __init__(self, *args, **kwargs): ... + + def save(*args, **kwargs): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_executable/EXE003_uv.py b/crates/ruff_linter/resources/test/fixtures/flake8_executable/EXE003_uv.py new file mode 100755 index 0000000000000..30c64dc45b750 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_executable/EXE003_uv.py @@ -0,0 +1,3 @@ +#!/usr/bin/env -S uv run +print("hello world") + diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/custom.py b/crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/custom.py index 09af781b2c5e1..32c624041397c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/custom.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/custom.py @@ -46,3 +46,7 @@ import pyarrow as pa # conventional from tensorflow.keras import Model # conventional + +import numpy.typing # unconventional +import numpy.typing as nt # unconventional +import numpy.typing as npt # conventional \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_0.py b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_0.py new file mode 100644 index 0000000000000..695885485382e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_0.py @@ -0,0 +1,49 @@ +from logging import exception as exc +import logging + + +logger = logging.getLogger(__name__) + +# Tests adapted from: +# https://github.com/adamchainz/flake8-logging/blob/dbe88e7/tests/test_flake8_logging.py + + +### Errors + +logging.exception("") +logger.exception("") +exc("") + + +def _(): + logging.exception("") + logger.exception("") + exc("") + + +try: + ... +except ...: + def _(): + logging.exception("") + logger.exception("") + exc("") + + +### No errors + +try: + ... +except ...: + logging.exception("") + logger.exception("") + exc("") + + +def _(): + try: + ... + except ...: + logging.exception("") + logger.exception("") + exc("") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_1.py new file mode 100644 index 0000000000000..1bc77f957a8c5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG004_1.py @@ -0,0 +1,4 @@ +_ = (logger := __import__("somewhere").logger) + + +logger.exception("") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_0.py b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_0.py new file mode 100644 index 0000000000000..b3dc5f79bb458 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_0.py @@ -0,0 +1,57 @@ +import logging + + +logger = logging.getLogger(__name__) + +# Tests adapted from: +# https://github.com/adamchainz/flake8-logging/blob/dbe88e7/tests/test_flake8_logging.py + + +### Errors + +logging.info("", exc_info=True) +logger.info("", exc_info=True) + + +logging.info("", exc_info=1) +logger.info("", exc_info=1) + + +def _(): + logging.info("", exc_info=True) + logger.info("", exc_info=True) + + +try: + ... +except ...: + def _(): + logging.info("", exc_info=True) + logger.info("", exc_info=True) + + +### No errors + +logging.info("", exc_info=a) +logger.info("", exc_info=a) + +logging.info("", exc_info=False) +logger.info("", exc_info=False) + + +try: + ... +except ...: + logging.info("", exc_info=True) + logger.info("", exc_info=True) + + +def _(): + try: + ... + except ...: + logging.info("", exc_info=True) + logger.info("", exc_info=True) + + +some_variable_that_ends_with_logger.not_a_recognized_method("", exc_info=True) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_1.py new file mode 100644 index 0000000000000..2a993d4fd477e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG014_1.py @@ -0,0 +1,4 @@ +_ = (logger := __import__("somewhere").logger) + + +logger.info("", exc_info=True) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG015.py b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG015.py new file mode 100644 index 0000000000000..14299fd4e777d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_logging/LOG015.py @@ -0,0 +1,59 @@ +# All errors +import logging + +logging.debug("Lorem") +logging.info("ipsum") +logging.warn("dolor") +logging.warning("sit") +logging.error("amet") +logging.critical("consectetur") +logging.log("adipiscing") +logging.exception("elit.") + + +# All errors +from logging import ( + debug, + info, + warn, + warning, + error, + critical, + log, + exception +) + +debug("Lorem") +info("ipsum") +warn("dolor") +warning("sit") +error("amet") +critical("consectetur") +log("adipiscing") +exception("elit.") + + +# No errors +logger = logging.getLogger("") + +logger.debug("Lorem") +logger.info("ipsum") +logger.warn("dolor") +logger.warning("sit") +logger.error("amet") +logger.critical("consectetur") +logger.log("adipiscing") +logger.exception("elit.") + + +# No errors +logging = logging.getLogger("") + +logging.debug("Lorem") +logging.info("ipsum") +logging.warn("dolor") +logging.warning("sit") +logging.error("amet") +logging.critical("consectetur") +logging.log("adipiscing") +logging.exception("elit.") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE790.py b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE790.py index f1b3d25301806..4b6f2652c69b6 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE790.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE790.py @@ -235,3 +235,15 @@ def impl(self) -> str: def contains_meaningful_ellipsis() -> list[int]: """Allow this in a TYPE_CHECKING block.""" ... + +# https://github.com/astral-sh/ruff/issues/12616 +class PotentialDocstring1: + pass + """ + Lorem ipsum dolor sit amet. + """ + + +class PotentialDocstring2: + ... + 'Lorem ipsum dolor sit amet.' diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.py b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.py index 585e38b4d1b0c..83985bf2479e6 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.py @@ -70,3 +70,17 @@ class FakeEnum10(enum.Enum): A = ... B = ... # PIE796 C = ... # PIE796 + + +from typing import cast + +class FakeEnum11(enum.Enum): + A = cast(SomeType, ...) + B = cast(SomeType, ...) # PIE796 + C = cast(SomeType, ...) # PIE796 + + +class FakeEnum12(enum.Enum): + A = enum.auto(), 0 + B = enum.auto(), 1 + C = enum.auto(), 0 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.pyi index ccfb75a2846a6..d3b77adf2efd3 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE796.pyi @@ -5,3 +5,11 @@ class FakeEnum1(enum.Enum): A = ... B = ... C = ... + + +from typing import cast + +class FakeEnum2(enum.Enum): + A = cast(SomeType, ...) + B = cast(SomeType, ...) + C = cast(SomeType, ...) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE800.py b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE800.py index 56a74de9c0e58..f294b6cdf2f4e 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE800.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE800.py @@ -18,6 +18,85 @@ {**foo, **buzz, **{bar: 10}} # PIE800 +# https://github.com/astral-sh/ruff/issues/15366 +{ + "data": [], + **({"count": 1 if include_count else {}}), +} + +{ + "data": [], + **( # Comment + { # Comment + "count": 1 if include_count else {}}), +} + +{ + "data": [], + **( + { + "count": (a := 1),}), +} + +{ + "data": [], + **( + { + "count": (a := 1) + } + ) + , +} + +{ + "data": [], + **( + { + "count": (a := 1), # Comment + } # Comment + ) # Comment + , +} + +({ + "data": [], + **( # Comment + ( # Comment +{ # Comment + "count": (a := 1), # Comment + } # Comment + ) + ) # Comment + , +}) + +{ + "data": [], + ** # Foo + ( # Comment + { "a": b, + # Comment + } + ) , + c: 9, +} + + +# https://github.com/astral-sh/ruff/issues/15997 +{"a": [], **{},} +{"a": [], **({}),} + +{"a": [], **{}, 6: 3} +{"a": [], **({}), 6: 3} + +{"a": [], **{ + # Comment +}, 6: 3} +{"a": [], **({ + # Comment +}), 6: 3} + + {**foo, "bar": True } # OK {"foo": 1, "buzz": {"bar": 1}} # OK diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE804.py b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE804.py index a8233d2917f92..b6229ed24ca1f 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE804.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE804.py @@ -28,3 +28,14 @@ # Some values need to be parenthesized. abc(foo=1, **{'bar': (bar := 1)}) # PIE804 abc(foo=1, **{'bar': (yield 1)}) # PIE804 + +# https://github.com/astral-sh/ruff/issues/18036 +# The autofix for this is unsafe due to the comments inside the dictionary. +foo( + **{ + # Comment 1 + "x": 1.0, + # Comment 2 + "y": 2.0, + } +) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE810.py b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE810.py index 34a02deaf81dc..39a4a496df38f 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE810.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pie/PIE810.py @@ -76,3 +76,9 @@ def func(): if msg.startswith(y) or msg.endswith(x) or msg.startswith("h"): # OK print("yes") + + +def func(): + "Regression test for https://github.com/astral-sh/ruff/issues/9663" + if x.startswith("a") or x.startswith("b") or re.match(r"a\.b", x): + print("yes") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI006.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI006.py index 89420bc50fc0f..72a06595dd905 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI006.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI006.py @@ -7,8 +7,14 @@ if sys.version_info == (3, 9): ... # OK -if sys.version_info <= (3, 10): ... # OK +if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -if sys.version_info > (3, 10): ... # OK +if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -if python_version > (3, 10): ... # OK +if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + +if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + +if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +elif python_version == (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.py index 6b11efb181e2d..75633e423b37b 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.py @@ -84,3 +84,39 @@ def func2() -> str | str: # PYI016: Duplicate union member `str` # duplicates of the outer `int`), but not three times (which would indicate that # we incorrectly re-checked the nested union). field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` + +# Should emit in cases with nested `typing.Union` +field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + +# Should emit in cases with nested `typing.Union` +field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + +# Should emit in cases with mixed `typing.Union` and `|` +field28: typing.Union[int | int] # Error + +# Should emit twice in cases with multiple nested `typing.Union` +field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + +# Should emit once in cases with multiple nested `typing.Union` +field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +# Should emit once, and fix to `typing.Union[float, int]` +field31: typing.Union[float, typing.Union[int | int]] # Error + +# Should emit once, and fix to `typing.Union[float, int]` +field32: typing.Union[float, typing.Union[int | int | int]] # Error + +# Test case for mixed union type fix +field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +# Test case for mixed union type +field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +field35: "int | str | int" # Error + + + +# Technically, this falls into the domain of the rule but it is an unlikely edge case, +# only works if you have from `__future__ import annotations` at the top of the file, +# and stringified annotations are discouraged in stub files. +field36: "int | str" | int # Ok \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.pyi index 6b11efb181e2d..a4ff51f5dea67 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI016.pyi @@ -84,3 +84,30 @@ field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union me # duplicates of the outer `int`), but not three times (which would indicate that # we incorrectly re-checked the nested union). field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` + +# Should emit in cases with nested `typing.Union` +field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + +# Should emit in cases with nested `typing.Union` +field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + +# Should emit in cases with mixed `typing.Union` and `|` +field28: typing.Union[int | int] # Error + +# Should emit twice in cases with multiple nested `typing.Union` +field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + +# Should emit once in cases with multiple nested `typing.Union` +field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +# Should emit once, and fix to `typing.Union[float, int]` +field31: typing.Union[float, typing.Union[int | int]] # Error + +# Should emit once, and fix to `typing.Union[float, int]` +field32: typing.Union[float, typing.Union[int | int | int]] # Error + +# Test case for mixed union type fix +field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +# Test case for mixed union type +field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.py deleted file mode 100644 index 8e9338574e0ae..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.py +++ /dev/null @@ -1,54 +0,0 @@ -from typing import TypeVar, Self, Type - -_S = TypeVar("_S", bound=BadClass) -_S2 = TypeVar("_S2", BadClass, GoodClass) - -class BadClass: - def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 - - - def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 - - - @classmethod - def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 - - - @classmethod - def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 - - - @classmethod - def excluded_edge_case(cls: Type[_S], arg: int) -> _S: ... # Ok - - -class GoodClass: - def __new__(cls: type[Self], *args: list[int], **kwargs: set[str]) -> Self: ... - def good_instance_method_1(self: Self, arg: bytes) -> Self: ... - def good_instance_method_2(self, arg1: _S2, arg2: _S2) -> _S2: ... - @classmethod - def good_cls_method_1(cls: type[Self], arg: int) -> Self: ... - @classmethod - def good_cls_method_2(cls, arg1: _S, arg2: _S) -> _S: ... - @staticmethod - def static_method(arg1: _S) -> _S: ... - - -# Python > 3.12 -class PEP695BadDunderNew[T]: - def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 - - - def generic_instance_method[S](self: S) -> S: ... # PYI019 - - -class PEP695GoodDunderNew[T]: - def __new__(cls, *args: Any, **kwargs: Any) -> Self: ... - - -class CustomClassMethod: - # Should be recognised as a classmethod decorator - # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` - # in the settings for this test: - @foo_classmethod - def foo[S](cls: type[S]) -> S: ... # PYI019 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.pyi deleted file mode 100644 index 8e9338574e0ae..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019.pyi +++ /dev/null @@ -1,54 +0,0 @@ -from typing import TypeVar, Self, Type - -_S = TypeVar("_S", bound=BadClass) -_S2 = TypeVar("_S2", BadClass, GoodClass) - -class BadClass: - def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 - - - def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 - - - @classmethod - def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 - - - @classmethod - def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 - - - @classmethod - def excluded_edge_case(cls: Type[_S], arg: int) -> _S: ... # Ok - - -class GoodClass: - def __new__(cls: type[Self], *args: list[int], **kwargs: set[str]) -> Self: ... - def good_instance_method_1(self: Self, arg: bytes) -> Self: ... - def good_instance_method_2(self, arg1: _S2, arg2: _S2) -> _S2: ... - @classmethod - def good_cls_method_1(cls: type[Self], arg: int) -> Self: ... - @classmethod - def good_cls_method_2(cls, arg1: _S, arg2: _S) -> _S: ... - @staticmethod - def static_method(arg1: _S) -> _S: ... - - -# Python > 3.12 -class PEP695BadDunderNew[T]: - def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 - - - def generic_instance_method[S](self: S) -> S: ... # PYI019 - - -class PEP695GoodDunderNew[T]: - def __new__(cls, *args: Any, **kwargs: Any) -> Self: ... - - -class CustomClassMethod: - # Should be recognised as a classmethod decorator - # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` - # in the settings for this test: - @foo_classmethod - def foo[S](cls: type[S]) -> S: ... # PYI019 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.py new file mode 100644 index 0000000000000..e502d8fc1f79d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.py @@ -0,0 +1,183 @@ +from typing import TypeVar, Self, Type, cast + +_S = TypeVar("_S", bound=BadClass) +_S2 = TypeVar("_S2", BadClass, GoodClass) + +class BadClass: + def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + + + def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + + + @classmethod + def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + + + @classmethod + def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + + + @classmethod + def excluded_edge_case(cls: Type[_S], arg: int) -> _S: ... # Ok + + +class GoodClass: + def __new__(cls: type[Self], *args: list[int], **kwargs: set[str]) -> Self: ... + def good_instance_method_1(self: Self, arg: bytes) -> Self: ... + def good_instance_method_2(self, arg1: _S2, arg2: _S2) -> _S2: ... + @classmethod + def good_cls_method_1(cls: type[Self], arg: int) -> Self: ... + @classmethod + def good_cls_method_2(cls, arg1: _S, arg2: _S) -> _S: ... + @staticmethod + def static_method(arg1: _S) -> _S: ... + + +# Python > 3.12 +class PEP695BadDunderNew[T]: + def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + + + def generic_instance_method[S](self: S) -> S: ... # PYI019 + + +class PEP695GoodDunderNew[T]: + def __new__(cls, *args: Any, **kwargs: Any) -> Self: ... + + +class CustomClassMethod: + # Should be recognised as a classmethod decorator + # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` + # in the settings for this test: + @foo_classmethod + def foo[S](cls: type[S]) -> S: ... # PYI019 + + +_S695 = TypeVar("_S695", bound="PEP695Fix") + + +class PEP695Fix: + def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + + def __init_subclass__[S](cls: type[S]) -> S: ... + + def __neg__[S: PEP695Fix](self: S) -> S: ... + + def __pos__[S](self: S) -> S: ... + + def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + + def __sub__[S](self: S, other: S) -> S: ... + + @classmethod + def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + + @classmethod + def class_method_unbound[S](cls: type[S]) -> S: ... + + def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + + def instance_method_unbound[S](self: S) -> S: ... + + def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + + def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + + def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + + def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + + +class InvalidButWeDoNotPanic: + @classmethod + def m[S](cls: type[S], /) -> S[int]: ... + def n(self: S) -> S[int]: ... + + +import builtins + +class UsesFullyQualifiedType: + @classmethod + def m[S](cls: builtins.type[S]) -> S: ... # False negative (#15821) + + +def shadowed_type(): + type = 1 + class A: + @classmethod + def m[S](cls: type[S]) -> S: ... # no error here + + +class SubscriptReturnType: + @classmethod + def m[S](cls: type[S]) -> type[S]: ... # PYI019 + + +class SelfNotUsedInReturnAnnotation: + def m[S](self: S, other: S) -> int: ... + @classmethod + def n[S](cls: type[S], other: S) -> int: ... + + +class _NotATypeVar: ... + +# Our stable-mode logic uses heuristics and thinks this is a `TypeVar` +# because `self` and the return annotation use the same name as their annotation, +# but our preview-mode logic is smarter about this. +class Foo: + def x(self: _NotATypeVar) -> _NotATypeVar: ... + @classmethod + def y(self: type[_NotATypeVar]) -> _NotATypeVar: ... + + +class NoReturnAnnotations: + def m[S](self: S, other: S): ... + @classmethod + def n[S](cls: type[S], other: S): ... + +class MultipleBoundParameters: + def m[S: int, T: int](self: S, other: T) -> S: ... + def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + +class MethodsWithBody: + def m[S](self: S, other: S) -> S: + x: S = other + return x + + @classmethod + def n[S](cls: type[S], other: S) -> S: + x: type[S] = type(other) + return x() + +class StringizedReferencesCanBeFixed: + def m[S](self: S) -> S: + x = cast("list[tuple[S, S]]", self) + return x + +class ButStrangeStringizedReferencesCannotBeFixed: + def m[_T](self: _T) -> _T: + x = cast('list[_\x54]', self) + return x + +class DeletionsAreNotTouched: + def m[S](self: S) -> S: + # `S` is not a local variable here, and `del` can only be used with local variables, + # so `del S` here is not actually a reference to the type variable `S`. + # This `del` statement is therefore not touched by the autofix (it raises `UnboundLocalError` + # both before and after the autofix) + del S + return self + +class NamesShadowingTypeVarAreNotTouched: + def m[S](self: S) -> S: + type S = int + print(S) # not a reference to the type variable, so not touched by the autofix + return 42 + + +MetaType = TypeVar("MetaType") + +class MetaTestClass(type): + def m(cls: MetaType) -> MetaType: + return cls diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.pyi new file mode 100644 index 0000000000000..1f2f17fc1b303 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_0.pyi @@ -0,0 +1,174 @@ +from typing import TypeVar, Self, Type + +_S = TypeVar("_S", bound=BadClass) +_S2 = TypeVar("_S2", BadClass, GoodClass) + +class BadClass: + def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + + + def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + + + @classmethod + def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + + + @classmethod + def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + + + @classmethod + def excluded_edge_case(cls: Type[_S], arg: int) -> _S: ... # Ok + + +class GoodClass: + def __new__(cls: type[Self], *args: list[int], **kwargs: set[str]) -> Self: ... + def good_instance_method_1(self: Self, arg: bytes) -> Self: ... + def good_instance_method_2(self, arg1: _S2, arg2: _S2) -> _S2: ... + @classmethod + def good_cls_method_1(cls: type[Self], arg: int) -> Self: ... + @classmethod + def good_cls_method_2(cls, arg1: _S, arg2: _S) -> _S: ... + @staticmethod + def static_method(arg1: _S) -> _S: ... + + +# Python > 3.12 +class PEP695BadDunderNew[T]: + def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + + + def generic_instance_method[S](self: S) -> S: ... # PYI019 + + +class PEP695GoodDunderNew[T]: + def __new__(cls, *args: Any, **kwargs: Any) -> Self: ... + + +class CustomClassMethod: + # Should be recognised as a classmethod decorator + # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` + # in the settings for this test: + @foo_classmethod + def foo[S](cls: type[S]) -> S: ... # PYI019 + + +_S695 = TypeVar("_S695", bound="PEP695Fix") + + +class PEP695Fix: + def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + + def __init_subclass__[S](cls: type[S]) -> S: ... + + def __neg__[S: PEP695Fix](self: S) -> S: ... + + def __pos__[S](self: S) -> S: ... + + def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + + def __sub__[S](self: S, other: S) -> S: ... + + @classmethod + def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + + @classmethod + def class_method_unbound[S](cls: type[S]) -> S: ... + + def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + + def instance_method_unbound[S](self: S) -> S: ... + + def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + + def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + + def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + + def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + + +class InvalidButWeDoNotPanic: + @classmethod + def m[S](cls: type[S], /) -> S[int]: ... + def n(self: S) -> S[int]: ... + + +import builtins + +class UsesFullyQualifiedType: + @classmethod + def m[S](cls: builtins.type[S]) -> S: ... # False negative (#15821) + + +def shadowed_type(): + type = 1 + class A: + @classmethod + def m[S](cls: type[S]) -> S: ... # no error here + + +class SubscriptReturnType: + @classmethod + def m[S](cls: type[S]) -> type[S]: ... # PYI019 + + +class PEP695TypeParameterAtTheVeryEndOfTheList: + def f[T, S](self: S) -> S: ... + + +class PEP695Again: + def mixing_and_nested[T](self: _S695, a: list[_S695], b: dict[_S695, str | T | set[_S695]]) -> _S695: ... + def also_uses_s695_but_should_not_be_edited(self, v: set[tuple[_S695]]) -> _S695: ... + + @classmethod + def comment_in_fix_range[T, S]( + cls: type[ # Lorem ipsum + S + ], + a: T, + b: tuple[S, T] + ) -> S: ... + + def comment_outside_fix_range[T, S]( + self: S, + a: T, + b: tuple[ + # Lorem ipsum + S, T + ] + ) -> S: ... + + +class SelfNotUsedInReturnAnnotation: + def m[S](self: S, other: S) -> int: ... + @classmethod + def n[S](cls: type[S], other: S) -> int: ... + + +class _NotATypeVar: ... + +# Our stable-mode logic uses heuristics and thinks this is a `TypeVar` +# because `self` and the return annotation use the same name as their annotation, +# but our preview-mode logic is smarter about this. +class Foo: + def x(self: _NotATypeVar) -> _NotATypeVar: ... + @classmethod + def y(self: type[_NotATypeVar]) -> _NotATypeVar: ... + +class NoReturnAnnotations: + def m[S](self: S, other: S): ... + @classmethod + def n[S](cls: type[S], other: S): ... + +class MultipleBoundParameters: + def m[S: int, T: int](self: S, other: T) -> S: ... + def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + + +MetaType = TypeVar("MetaType") + +class MetaTestClass(type): + def m(cls: MetaType) -> MetaType: + return cls diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_1.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_1.pyi new file mode 100644 index 0000000000000..18f641462ea4b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI019_1.pyi @@ -0,0 +1,4 @@ +import typing + +class F: + def m[S](self: S) -> S: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI021.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI021.pyi index f28a4cb9b1296..a190cd24fbfe8 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI021.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI021.pyi @@ -6,6 +6,19 @@ def foo(): class Bar: """bar""" # ERROR PYI021 +class Qux: + """qux""" # ERROR PYI021 + + def __init__(self) -> None: ... + +class Baz: + """Multiline docstring + + Lorem ipsum dolor sit amet + """ + + def __init__(self) -> None: ... + def bar(): x = 1 """foo""" # OK, not a doc string diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.py index 59edf252dde17..70e7fd956e057 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.py @@ -91,3 +91,15 @@ def func2() -> Literal[1] | Literal[2]: # Error from typing import IO, Literal InlineOption = Literal["a"] | Literal["b"] | IO[str] + +# Should use unsafe fix when comments are deleted +field26: ( + # First comment + Literal["a", "b"] + # Second comment + | Literal["c", "d"] +) +field27: ( + Literal["a", "b"] # First comment + | Literal["c", "d"] # Second comment +) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.pyi index c6cd2b453707a..67fbbe48b6ef9 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI030.pyi @@ -87,3 +87,15 @@ field24: typing.Union[Literal[1], typing.Union[Literal[2], typing.Union[Literal[ # Should use the first literal subscript attribute when fixing field25: typing.Union[typing_extensions.Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]], str] # Error + +# Should use unsafe fix when comments are deleted +field26: ( + # First comment + Literal["a", "b"] + # Second comment + | Literal["c", "d"] +) +field27: ( + Literal["a", "b"] # First comment + | Literal["c", "d"] # Second comment +) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.py index 179c9db90c4c5..52a612a79e3c0 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.py @@ -8,7 +8,7 @@ from abc import ABCMeta, abstractmethod from collections.abc import AsyncIterable, AsyncIterator, Iterable, Iterator from enum import EnumMeta -from typing import Any, overload +from typing import Any, Generic, ParamSpec, Type, TypeVar, TypeVarTuple, overload import typing_extensions from _typeshed import Self @@ -321,3 +321,41 @@ def __imul__(self, other: Any) -> list[str]: class UsesStringizedAnnotations: def __iadd__(self, other: "UsesStringizedAnnotations") -> "typing.Self": return self + + +class NonGeneric1(tuple): + def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + def __enter__(self: NonGeneric1) -> NonGeneric1: ... + +class NonGeneric2(tuple): + def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + +class Generic1[T](list): + def __new__(cls: type[Generic1]) -> Generic1: ... + def __enter__(self: Generic1) -> Generic1: ... + + +### Correctness of typevar-likes are not verified. + +T = TypeVar('T') +P = ParamSpec() +Ts = TypeVarTuple('foo') + +class Generic2(Generic[T]): + def __new__(cls: type[Generic2]) -> Generic2: ... + def __enter__(self: Generic2) -> Generic2: ... + +class Generic3(tuple[*Ts]): + def __new__(cls: type[Generic3]) -> Generic3: ... + def __enter__(self: Generic3) -> Generic3: ... + +class Generic4(collections.abc.Callable[P, ...]): + def __new__(cls: type[Generic4]) -> Generic4: ... + def __enter__(self: Generic4) -> Generic4: ... + +from some_module import PotentialTypeVar + +class Generic5(list[PotentialTypeVar]): + def __new__(cls: type[Generic5]) -> Generic5: ... + def __enter__(self: Generic5) -> Generic5: ... + diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.pyi index ebecadfbd50cc..9567b343ac7cf 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI034.pyi @@ -8,7 +8,7 @@ import typing from abc import ABCMeta, abstractmethod from collections.abc import AsyncIterable, AsyncIterator, Iterable, Iterator from enum import EnumMeta -from typing import Any, overload +from typing import Any, Generic, ParamSpec, Type, TypeVar, TypeVarTuple, overload import typing_extensions from _typeshed import Self @@ -215,3 +215,40 @@ def __imul__(self, other: Any) -> list[str]: ... class UsesStringizedAnnotations: def __iadd__(self, other: "UsesStringizedAnnotations") -> "typing.Self": ... + + +class NonGeneric1(tuple): + def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + def __enter__(self: NonGeneric1) -> NonGeneric1: ... + +class NonGeneric2(tuple): + def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + +class Generic1[T](list): + def __new__(cls: type[Generic1]) -> Generic1: ... + def __enter__(self: Generic1) -> Generic1: ... + + +### Correctness of typevar-likes are not verified. + +T = TypeVar('T') +P = ParamSpec() +Ts = TypeVarTuple('foo') + +class Generic2(Generic[T]): + def __new__(cls: type[Generic2]) -> Generic2: ... + def __enter__(self: Generic2) -> Generic2: ... + +class Generic3(tuple[*Ts]): + def __new__(cls: type[Generic3]) -> Generic3: ... + def __enter__(self: Generic3) -> Generic3: ... + +class Generic4(collections.abc.Callable[P, ...]): + def __new__(cls: type[Generic4]) -> Generic4: ... + def __enter__(self: Generic4) -> Generic4: ... + +from some_module import PotentialTypeVar + +class Generic5(list[PotentialTypeVar]): + def __new__(cls: type[Generic5]) -> Generic5: ... + def __enter__(self: Generic5) -> Generic5: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.py index d1349b3ee3a0f..c5b367644d8ba 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.py @@ -39,9 +39,54 @@ async def f4(**kwargs: int | int | float) -> None: ... +def f5(arg1: int, *args: Union[int, int, float]) -> None: + ... + + +def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: + ... + + +def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: + ... + + +def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: + ... + + +def f9( + arg: Union[ # comment + float, # another + complex, int] + ) -> None: + ... + +def f10( + arg: ( + int | # comment + float | # another + complex + ) + ) -> None: + ... + + class Foo: def good(self, arg: int) -> None: ... def bad(self, arg: int | float | complex) -> None: ... + + def bad2(self, arg: int | Union[float, complex]) -> None: + ... + + def bad3(self, arg: Union[Union[float, complex], int]) -> None: + ... + + def bad4(self, arg: Union[float | complex, int]) -> None: + ... + + def bad5(self, arg: int | (float | complex)) -> None: + ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.pyi index 07c2bd3fd67a3..e465c3eb90076 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI041.pyi @@ -32,8 +32,41 @@ def f3(arg1: int, *args: Union[int | int | float]) -> None: ... # PYI041 async def f4(**kwargs: int | int | float) -> None: ... # PYI041 +def f5( + arg: Union[ # comment + float, # another + complex, int] + ) -> None: ... # PYI041 + +def f6( + arg: ( + int | # comment + float | # another + complex + ) + ) -> None: ... # PYI041 + +def f5(arg1: int, *args: Union[int, int, float]) -> None: ... # PYI041 + + +def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: ... # PYI041 + + +def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: ... # PYI041 + + +def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: ... # PYI041 + class Foo: def good(self, arg: int) -> None: ... def bad(self, arg: int | float | complex) -> None: ... # PYI041 + + def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 + + def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 + + def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 + + def bad5(self, arg: int | (float | complex)) -> None: ... # PYI041 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.py index 543c12974c36e..85e867f84e489 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.py @@ -5,6 +5,9 @@ B: TypeAlias = typing.Union[Literal[b"bar", b"foo"], bytes, str] C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.pyi index 543c12974c36e..85e867f84e489 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI051.pyi @@ -5,6 +5,9 @@ A: str | Literal["foo"] B: TypeAlias = typing.Union[Literal[b"bar", b"foo"], bytes, str] C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI053.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI053.pyi index b25a02db20c7b..5cb3585c57760 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI053.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI053.pyi @@ -67,5 +67,16 @@ def not_a_deprecated_function() -> None: ... fbaz: str = f"51 character {foo} stringgggggggggggggggggggggggggg" # Error: PYI053 +from typing import TypeAlias, Literal, Annotated + # see https://github.com/astral-sh/ruff/issues/12995 -def foo(bar: typing.Literal["a", "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"]):... \ No newline at end of file +def foo(bar: typing.Literal["a", "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"]):... + +# Ok +def f(x: int) -> "AnnotationsForClassesWithVeryLongNamesInQuotesAsReturnTypes":... + +# Ok +x: TypeAlias = Literal["fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooO"] + +# Ok +y: TypeAlias = Annotated[int, "metadataaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"] diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.py index 2a9c2d77871cc..7173a725a1e61 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.py @@ -1,11 +1,14 @@ import builtins from typing import Union -w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -x: type[int] | type[str] | type[float] -y: builtins.type[int] | type[str] | builtins.type[complex] -z: Union[type[float], type[complex]] -z: Union[type[float, int], type[complex]] +s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +t: type[int] | type[str] | type[float] +u: builtins.type[int] | type[str] | builtins.type[complex] +v: Union[type[float], type[complex]] +w: Union[type[float | int], type[complex]] +x: Union[Union[type[Union[float, int]], type[complex]]] +y: Union[Union[Union[type[float | int], type[complex]]]] +z: Union[type[complex], Union[Union[type[Union[float, int]]]]] def func(arg: type[int] | str | type[float]) -> None: @@ -13,8 +16,8 @@ def func(arg: type[int] | str | type[float]) -> None: # OK -x: type[int, str, float] -y: builtins.type[int, str, complex] +x: type[int | str | float] +y: builtins.type[int | str | complex] z: Union[float, complex] @@ -30,6 +33,9 @@ def func(): # PYI055 x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + z: Union[ # comment + type[requests_mock.Mocker], # another comment + type[httpretty], type[str]] = requests_mock.Mocker def func(): @@ -62,3 +68,11 @@ def convert_union(union: UnionType) -> _T | None: Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 ] = union.__args__ ... + + +# `type[float, int]`` is not valid, use `type[float|int]` or `type[Union[float, int]]` +# OK for PYI055, should be covered by another check. +a: Union[type[float, int], type[complex]] +b: Union[Union[type[float, int], type[complex]]] +c: Union[Union[Union[type[float, int], type[complex]]]] +d: Union[type[complex], Union[Union[type[float, int]]]] diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.pyi index 530f395dfa359..516d2630b417c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.pyi @@ -1,25 +1,38 @@ import builtins from typing import Union -w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -x: type[int] | type[str] | type[float] -y: builtins.type[int] | type[str] | builtins.type[complex] -z: Union[type[float], type[complex]] -z: Union[type[float, int], type[complex]] +s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +t: type[int] | type[str] | type[float] +u: builtins.type[int] | type[str] | builtins.type[complex] +v: Union[type[float], type[complex]] +w: Union[type[Union[float, int]], type[complex]] +x: Union[Union[type[Union[float, int]], type[complex]]] +y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +z: Union[type[complex], Union[Union[type[Union[float, int]]]]] def func(arg: type[int] | str | type[float]) -> None: ... # OK -x: type[int, str, float] -y: builtins.type[int, str, complex] +x: type[int | str | float] +y: builtins.type[int | str | complex] z: Union[float, complex] def func(arg: type[int, float] | str) -> None: ... -# OK +# PYI055 item: type[requests_mock.Mocker] | type[httpretty] = requests_mock.Mocker def func(): # PYI055 item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + item3: Union[ # comment + type[requests_mock.Mocker], # another comment + type[httpretty], type[str]] = requests_mock.Mocker + + +# OK +w: Union[type[float, int], type[complex]] +x: Union[Union[type[float, int], type[complex]]] +y: Union[Union[Union[type[float, int], type[complex]]]] +z: Union[type[complex], Union[Union[type[float, int]]]] diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.py new file mode 100644 index 0000000000000..4bdc3d98799b9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.py @@ -0,0 +1,80 @@ +from typing import Literal, Union + + +def func1(arg1: Literal[None]): + ... + + +def func2(arg1: Literal[None] | int): + ... + + +def func3() -> Literal[None]: + ... + + +def func4(arg1: Literal[int, None, float]): + ... + + +def func5(arg1: Literal[None, None]): + ... + + +def func6(arg1: Literal[ + "hello", + None # Comment 1 + , "world" + ]): + ... + + +def func7(arg1: Literal[ + None # Comment 1 + ]): + ... + + +def func8(arg1: Literal[None] | None): + ... + + +def func9(arg1: Union[Literal[None], None]): + ... + + +# OK +def good_func(arg1: Literal[int] | None): + ... + + +# From flake8-pyi +Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" +Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + +### +# The following rules here are slightly subtle, +# but make sense when it comes to giving the best suggestions to users of flake8-pyi. +### + +# If Y061 and Y062 both apply, but all the duplicate members are None, +# only emit Y061... +Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + +# ... but if Y061 and Y062 both apply +# and there are no None members in the Literal[] slice, +# only emit Y062: +Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + + +# Regression tests for https://github.com/astral-sh/ruff/issues/14567 +x: Literal[None] | None +y: None | Literal[None] +z: Union[Literal[None], None] + +a: int | Literal[None] | None +b: None | Literal[None] | None +c: (None | Literal[None]) | None +d: None | (Literal[None] | None) +e: None | ((None | Literal[None]) | None) | None diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.pyi new file mode 100644 index 0000000000000..404ac1157edb9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI061.pyi @@ -0,0 +1,55 @@ +from typing import Literal, Union + + +def func1(arg1: Literal[None]): ... + + +def func2(arg1: Literal[None] | int): ... + + +def func3() -> Literal[None]: ... + + +def func4(arg1: Literal[int, None, float]): ... + + +def func5(arg1: Literal[None, None]): ... + + +def func6(arg1: Literal[ + "hello", + None # Comment 1 + , "world" +]): ... + + +def func7(arg1: Literal[ + None # Comment 1 +]): ... + + +def func8(arg1: Literal[None] | None):... + + +def func9(arg1: Union[Literal[None], None]): ... + + +# OK +def good_func(arg1: Literal[int] | None): ... + + +# From flake8-pyi +Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" +Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + + +# Regression tests for https://github.com/astral-sh/ruff/issues/14567 +x: Literal[None] | None +y: None | Literal[None] +z: Union[Literal[None], None] + +a: int | Literal[None] | None +b: None | Literal[None] | None +c: (None | Literal[None]) | None +d: None | (Literal[None] | None) +e: None | ((None | Literal[None]) | None) | None diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.py b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.py index 9e3b46c1f80c0..7fbb70ce6a71f 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.py @@ -14,8 +14,20 @@ Literal[1, Literal[2], Literal[2]] # once t.Literal[1, t.Literal[2, t.Literal[1]]] # once typing_extensions.Literal[1, 1, 1] # twice +Literal[ + 1, # comment + Literal[ # another comment + 1 + ] +] # once # Ensure issue is only raised once, even on nested literals MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 n: Literal["No", "duplicates", "here", 1, "1"] + + +# nested literals, all equivalent to `Literal[1]` +Literal[Literal[1]] # no duplicate +Literal[Literal[Literal[1], Literal[1]]] # once +Literal[Literal[1], Literal[Literal[Literal[1]]]] # once diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.pyi index 38d04bcd9df68..7fbb70ce6a71f 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.pyi +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.pyi @@ -2,11 +2,11 @@ from typing import Literal import typing as t import typing_extensions -x: Literal[True, False, True, False] # PY062 twice here +x: Literal[True, False, True, False] # PYI062 twice here -y: Literal[1, print("hello"), 3, Literal[4, 1]] # PY062 on the last 1 +y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 -z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PY062 on the set literal +z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal Literal[1, Literal[1]] # once Literal[1, 2, Literal[1, 2]] # twice @@ -14,8 +14,20 @@ Literal[1, Literal[1], Literal[1]] # twice Literal[1, Literal[2], Literal[2]] # once t.Literal[1, t.Literal[2, t.Literal[1]]] # once typing_extensions.Literal[1, 1, 1] # twice +Literal[ + 1, # comment + Literal[ # another comment + 1 + ] +] # once # Ensure issue is only raised once, even on nested literals MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 n: Literal["No", "duplicates", "here", 1, "1"] + + +# nested literals, all equivalent to `Literal[1]` +Literal[Literal[1]] # no duplicate +Literal[Literal[Literal[1], Literal[1]]] # once +Literal[Literal[1], Literal[Literal[Literal[1]]]] # once diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT004.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT004.py deleted file mode 100644 index 0904267775383..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT004.py +++ /dev/null @@ -1,58 +0,0 @@ -import abc -from abc import abstractmethod - -import pytest - - -@pytest.fixture() -def _patch_something(mocker): # OK simple - mocker.patch("some.thing") - - -@pytest.fixture() -def _patch_something(mocker): # OK with return - if something: - return - mocker.patch("some.thing") - - -@pytest.fixture() -def _activate_context(): # OK with yield - with context: - yield - - -class BaseTest: - @pytest.fixture() - @abc.abstractmethod - def my_fixture(): # OK abstract with import abc - raise NotImplementedError - - -class BaseTest: - @pytest.fixture() - @abstractmethod - def my_fixture(): # OK abstract with from import - raise NotImplementedError - - -@pytest.fixture() -def my_fixture(): # OK ignoring yield from - yield from some_generator() - - - -@pytest.fixture() -def my_fixture(): # OK ignoring yield value - yield 1 - - -@pytest.fixture() -def patch_something(mocker): # Error simple - mocker.patch("some.thing") - - -@pytest.fixture() -def activate_context(): # Error with yield - with context: - yield diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT005.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT005.py deleted file mode 100644 index bc19fa7d8ee9f..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT005.py +++ /dev/null @@ -1,57 +0,0 @@ -import abc -from abc import abstractmethod - -import pytest - - -@pytest.fixture() -def my_fixture(mocker): # OK with return - return 0 - - -@pytest.fixture() -def activate_context(): # OK with yield - with get_context() as context: - yield context - - -@pytest.fixture() -def _any_fixture(mocker): # Ok nested function - def nested_function(): - return 1 - - mocker.patch("...", nested_function) - - -class BaseTest: - @pytest.fixture() - @abc.abstractmethod - def _my_fixture(): # OK abstract with import abc - return NotImplemented - - -class BaseTest: - @pytest.fixture() - @abstractmethod - def _my_fixture(): # OK abstract with from import - return NotImplemented - - -@pytest.fixture() -def _my_fixture(mocker): # Error with return - return 0 - - -@pytest.fixture() -def _activate_context(): # Error with yield - with get_context() as context: - yield context - - -@pytest.fixture() -def _activate_context(): # Error with conditional yield from - if some_condition: - with get_context() as context: - yield context - else: - yield from other_context() diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006.py index f444a835efbe5..af6cb50d54505 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006.py @@ -69,3 +69,90 @@ def test_implicit_str_concat_with_multi_parens(param1, param2, param3): @pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) def test_csv_with_parens(param1, param2): ... + + +parametrize = pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) + +@parametrize +def test_not_decorator(param1, param2): + ... + + +@pytest.mark.parametrize(argnames=("param1,param2"), argvalues=[(1, 2), (3, 4)]) +def test_keyword_arguments(param1, param2): + ... + + +@pytest.mark.parametrize(("param",), [(1,), (2,)]) +def test_single_element_tuple(param): + ... + + +@pytest.mark.parametrize(("param",), [[1], [2]]) +def test_single_element_list(param): + ... + + +@pytest.mark.parametrize(("param",), [[1], [2]]) +def test_single_element_list(param): + ... + + +# Unsafe fix +@pytest.mark.parametrize( + ( + # comment + "param", + ), + [[1], [2]], +) +def test_comment_in_argnames(param): + ... + +# Unsafe fix +@pytest.mark.parametrize( + ("param",), + [ + ( + # comment + 1, + ), + (2,), + ], +) +def test_comment_in_argvalues(param): + ... + + +# Safe fix +@pytest.mark.parametrize( + ("param",), + [ + (1,), + # comment + (2,), + ], +) +def test_comment_between_argvalues_items(param): + ... + + +# A fix should be suggested for `argnames`, but not for `argvalues`. +@pytest.mark.parametrize( + ("param",), + [ + (1,), + (2, 3), + ], +) +def test_invalid_argvalues(param): + """ + pytest throws the following error for this test: + ------------------------------------------------ + a.py::test_comment_between_argvalues_items: in "parametrize" the number of names (1): + ('param',) + must be equal to the number of values (2): + (2, 3) + ------------------------------------------------ + """ + ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006_and_PT007.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006_and_PT007.py new file mode 100644 index 0000000000000..b47f267943642 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT006_and_PT007.py @@ -0,0 +1,5 @@ +import pytest + +@pytest.mark.parametrize(("param",), [[1], [2]]) +def test_PT006_and_PT007_do_not_conflict(param): + ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT011.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT011.py index fbec3e2fa0aae..368cea6af67d9 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT011.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT011.py @@ -14,10 +14,20 @@ def test_ok_different_error_from_config(): raise ZeroDivisionError("Can't divide by 0") +def test_ok_legacy_form(): + def func(): + raise ValueError("Can't divide by 0") + + pytest.raises(ValueError, func).match("Can't divide by 0") + + def test_error_no_argument_given(): with pytest.raises(ValueError): raise ValueError("Can't divide 1 by 0") + with pytest.raises(expected_exception=ValueError): + raise ValueError("Can't divide 1 by 0") + with pytest.raises(socket.error): raise ValueError("Can't divide 1 by 0") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT012.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT012.py index fefd2942dcea7..239fcb33547af 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT012.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT012.py @@ -73,3 +73,44 @@ def test_error_try(): [].size except: raise + + +# https://github.com/astral-sh/ruff/issues/9730 +def test_for_loops(): + + ## Errors + + with pytest.raises(RuntimeError): + for a in b: + print() + + with pytest.raises(RuntimeError): + for a in b: + assert foo + + with pytest.raises(RuntimeError): + async for a in b: + print() + + with pytest.raises(RuntimeError): + async for a in b: + assert foo + + + ## No errors in preview + + with pytest.raises(RuntimeError): + for a in b: + pass + + with pytest.raises(RuntimeError): + for a in b: + ... + + with pytest.raises(RuntimeError): + async for a in b: + pass + + with pytest.raises(RuntimeError): + async for a in b: + ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT019.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT019.py index 1df67fd7f8958..2bdbe93116ca7 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT019.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT019.py @@ -12,3 +12,38 @@ def test_xxx(_fixture): # Error arg def test_xxx(*, _fixture): # Error kwonly pass + +# https://github.com/astral-sh/ruff/issues/17599 + +@pytest.mark.parametrize("_foo", [1, 2, 3]) +def test_thingy(_foo): # Ok defined in parametrize + pass + +@pytest.mark.parametrize( + "_test_input,_expected", + [("3+5", 8), ("2+4", 6), pytest.param("6*9", 42, marks=pytest.mark.xfail)], +) +def test_eval(_test_input, _expected): # OK defined in parametrize + pass + + +@pytest.mark.parametrize("_foo", [1, 2, 3]) +def test_thingy2(_foo, _bar): # Error _bar is not defined in parametrize + pass + +@pytest.mark.parametrize(["_foo", "_bar"], [1, 2, 3]) +def test_thingy3(_foo, _bar): # OK defined in parametrize + pass + +@pytest.mark.parametrize(("_foo"), [1, 2, 3]) +def test_thingy4(_foo, _bar): # Error _bar is not defined in parametrize + pass + +@pytest.mark.parametrize([" _foo", " _bar "], [1, 2, 3]) +def test_thingy5(_foo, _bar): # OK defined in parametrize + pass + +x = "other" +@pytest.mark.parametrize(x, [1, 2, 3]) +def test_thingy5(_foo, _bar): # known false negative, we don't try to resolve variables + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT027_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT027_1.py index 708a582ad3d22..a591c19c97108 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT027_1.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT027_1.py @@ -10,3 +10,32 @@ def test_pytest_raises(self): def test_errors(self): with self.assertRaises(ValueError): raise ValueError + + def test_rewrite_references(self): + with self.assertRaises(ValueError) as e: + raise ValueError + + print(e.foo) + print(e.exception) + + def test_rewrite_references_multiple_items(self): + with self.assertRaises(ValueError) as e1, \ + self.assertRaises(ValueError) as e2: + raise ValueError + + print(e1.foo) + print(e1.exception) + + print(e2.foo) + print(e2.exception) + + def test_rewrite_references_multiple_items_nested(self): + with self.assertRaises(ValueError) as e1, \ + foo(self.assertRaises(ValueError)) as e2: + raise ValueError + + print(e1.foo) + print(e1.exception) + + print(e2.foo) + print(e2.exception) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT028.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT028.py new file mode 100644 index 0000000000000..1eb5360d4c231 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT028.py @@ -0,0 +1,17 @@ +# Errors + +def test_foo(a=1): ... +def test_foo(a = 1): ... +def test_foo(a = (1)): ... +def test_foo(a: int=1): ... +def test_foo(a: int = 1): ... +def test_foo(a: (int) = 1): ... +def test_foo(a: int = (1)): ... +def test_foo(a: (int) = (1)): ... +def test_foo(a=1, /, b=2, *, c=3): ... + + +# No errors + +def test_foo(a): ... +def test_foo(a: int): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT029.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT029.py new file mode 100644 index 0000000000000..8d7c21a4efd7c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT029.py @@ -0,0 +1,11 @@ +import pytest + + +def test_ok(): + with pytest.warns(): + pass + + +def test_error(): + with pytest.warns(UserWarning): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT030.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT030.py new file mode 100644 index 0000000000000..129f1f0442eb1 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT030.py @@ -0,0 +1,34 @@ +import pytest +from foo import FooWarning + + +def test_ok(): + with pytest.warns(UserWarning, match="Can't divide by 0"): + pass + + +def test_ok_different_error_from_config(): + with pytest.warns(EncodingWarning): + pass + + +def test_error_no_argument_given(): + with pytest.warns(UserWarning): + pass + + with pytest.warns(expected_warning=UserWarning): + pass + + with pytest.warns(FooWarning): + pass + + +def test_error_match_is_empty(): + with pytest.warns(UserWarning, match=None): + pass + + with pytest.warns(UserWarning, match=""): + pass + + with pytest.warns(UserWarning, match=f""): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT031.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT031.py new file mode 100644 index 0000000000000..0bf3b950ab868 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/PT031.py @@ -0,0 +1,116 @@ +import pytest + + +def test_ok(): + with pytest.warns(UserWarning): + ... + + +async def test_ok_trivial_with(): + with pytest.warns(UserWarning): + with context_manager_under_test(): + pass + + with pytest.warns(UserWarning): + with context_manager_under_test(): + foo() + + with pytest.warns(UserWarning): + async with context_manager_under_test(): + pass + + +def test_ok_complex_single_call(): + with pytest.warns(UserWarning): + foo( + "", + 0, + ) + + +def test_ok_func_and_class(): + with pytest.warns(UserWarning): + class Foo: + pass + + with pytest.warns(UserWarning): + def foo(): + pass + + +def test_error_multiple_statements(): + with pytest.warns(UserWarning): + foo() + bar() + + +async def test_error_complex_statement(): + with pytest.warns(UserWarning): + if True: + foo() + + with pytest.warns(UserWarning): + for i in []: + foo() + + with pytest.warns(UserWarning): + async for i in []: + foo() + + with pytest.warns(UserWarning): + while True: + foo() + + with pytest.warns(UserWarning): + async with context_manager_under_test(): + if True: + foo() + + +def test_error_try(): + with pytest.warns(UserWarning): + try: + foo() + except: + raise + + +# https://github.com/astral-sh/ruff/issues/9730 +def test_for_loops(): + + ## Errors + + with pytest.warns(RuntimeError): + for a in b: + print() + + with pytest.warns(RuntimeError): + for a in b: + assert foo + + with pytest.warns(RuntimeError): + async for a in b: + print() + + with pytest.warns(RuntimeError): + async for a in b: + assert foo + + + ## No errors in preview + + with pytest.warns(RuntimeError): + for a in b: + pass + + with pytest.warns(RuntimeError): + for a in b: + ... + + with pytest.warns(RuntimeError): + async for a in b: + pass + + with pytest.warns(RuntimeError): + async for a in b: + ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/is_pytest_test.py b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/is_pytest_test.py new file mode 100644 index 0000000000000..9383451c9fe93 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_pytest_style/is_pytest_test.py @@ -0,0 +1,17 @@ +# Errors + +def test_this_is_a_test(a=1): ... +def testThisIsAlsoATest(a=1): ... + +class TestClass: + def test_this_too_is_a_test(self, a=1): ... + def testAndOfCourseThis(self, a=1): ... + + +# No errors + +def this_is_not_a_test(a=1): ... + +class TestClassLookalike: + def __init__(self): ... + def test_this_is_not_a_test(self, a=1): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_return/RET503.py b/crates/ruff_linter/resources/test/fixtures/flake8_return/RET503.py index edb729eb98c23..4463ff686cfdc 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_return/RET503.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_return/RET503.py @@ -331,17 +331,16 @@ def end_of_file(): # function return type annotation NoReturn +def bar_no_return_annotation() -> NoReturn: + abort() + def foo(x: int) -> int: - def bar() -> NoReturn: - abort() if x == 5: return 5 - bar() + bar_no_return_annotation() def foo(string: str) -> str: - def raises(value: str) -> NoReturn: - raise RuntimeError("something went wrong") match string: case "a": @@ -351,23 +350,49 @@ def raises(value: str) -> NoReturn: case "c": return "third" case _: - raises(string) + bar_no_return_annotation() def foo() -> int: def baz() -> int: return 1 + if baz() > 3: + return 1 + bar_no_return_annotation() - def bar() -> NoReturn: - a = 1 + 2 - raise AssertionError("Very bad") +# function return type annotation typing_extensions.Never +def bar_never_annotation() -> typing_extensions.Never: + abort() + +def foo(x: int) -> int: + if x == 5: + return 5 + bar_never_annotation() + + +def foo(string: str) -> str: + + match string: + case "a": + return "first" + case "b": + return "second" + case "c": + return "third" + case _: + bar_never_annotation() + + +def foo() -> int: + def baz() -> int: + return 1 if baz() > 3: return 1 - bar() + bar_never_annotation() def f(): @@ -376,3 +401,18 @@ def f(): else: with c: d + + + +# The rule shouldn't generate a diagnostic for functions where one branch +# calls a nested function annotated with `NoReturn` or `Never`. +# However, the rule isn't handling this case correctly yet. +# This is because looking up `bar` fails when analysing `foo` because +# the semantic model hasn't yet seen `bar`'s declaration. +# Supporting nested functions requires making this a deferred rule. +def foo(x: int) -> int: + def bar() -> NoReturn: + abort() + if x == 5: + return 5 + bar() \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_self/SLF001_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_self/SLF001_1.py new file mode 100644 index 0000000000000..1a784f5bdb693 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_self/SLF001_1.py @@ -0,0 +1,45 @@ +from __future__ import annotations + +from typing import Annotated + +# https://github.com/astral-sh/ruff/issues/9022 + +class Lorem[T]: + def f(self): + lorem_1 = Lorem() + lorem_1._value = 1 # fine + + lorem_2 = Lorem[bytes]() + lorem_2._value = 1 # fine + + +class Ipsum: + def __new__(cls): + instance = super().__new__(cls) + instance._value = 1 # fine + + +class Dolor[T]: + def f( + self, + a: Dolor, + b: Dolor[int], + c: Annotated[Dolor, ...], + d: Annotated[Dolor[str], ...] + ): + a._value = 1 # fine + b._value = 1 # fine + c._value = 1 # fine + d._value = 1 # fine + + @classmethod + def m(cls): + instance = cls() + instance._value = 1 # fine + + +class M(type): + @classmethod + def f(mcs): + cls = mcs() + cls._value = 1 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM103.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM103.py index f42b9dc262a80..5654197d08b57 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM103.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM103.py @@ -123,3 +123,39 @@ def f(): if 10 < a: return False return True + + +def f(): + if 10 in a: + return False + return True + + +def f(): + if 10 not in a: + return False + return True + + +def f(): + if a is 10: + return False + return True + + +def f(): + if a is not 10: + return False + return True + + +def f(): + if a == 10: + return False + return True + + +def f(): + if a != 10: + return False + return True diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM108.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM108.py index 25991d478233d..52da2ecd37e2b 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM108.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM108.py @@ -194,3 +194,17 @@ def f(): z = not foo() else: z = other + + +# These two cases double as tests for f-string quote preservation. The first +# f-string should preserve its double quotes, and the second should preserve +# single quotes +if cond: + var = "str" +else: + var = f"{first}-{second}" + +if cond: + var = "str" +else: + var = f'{first}-{second}' diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM115.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM115.py index 3ae57e9b2e25a..88af984ce4684 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM115.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM115.py @@ -256,3 +256,30 @@ def aliased(): # SIM115 f = dbm.sqlite3.open("foo.db") f.close() + +# OK +def func(filepath, encoding): + return open(filepath, mode="rt", encoding=encoding) + +# OK +def func(filepath, encoding): + return f(open(filepath, mode="rt", encoding=encoding)) + + +from unittest import IsolatedAsyncioTestCase, TestCase + +# OK +class ExampleClassTests(TestCase): + @classmethod + def setUpClass(cls): + cls.enterClassContext(open("filename")) + +# OK +class ExampleAsyncTests(IsolatedAsyncioTestCase): + async def test_something(self): + await self.enterAsyncContext(open("filename")) + +# OK +class ExampleTests(TestCase): + def setUp(self): + self.enterContext(open("filename")) \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM222.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM222.py index bd1282ce0f1b8..e2f909acf09af 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM222.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM222.py @@ -167,3 +167,33 @@ def secondToTime(s0: int) -> ((int, int, int) or str): print(f"{a}{''}" or "bar") print(f"{''}{''}" or "bar") print(f"{1}{''}" or "bar") + + +# Regression test for: https://github.com/astral-sh/ruff/issues/14237 +for x in [*a] or [None]: + pass + +for x in {*a} or [None]: + pass + +for x in (*a,) or [None]: + pass + +for x in {**a} or [None]: + pass + +for x in [*a, *b] or [None]: + pass + +for x in {*a, *b} or [None]: + pass + +for x in (*a, *b) or [None]: + pass + +for x in {**a, **b} or [None]: + pass + + +# https://github.com/astral-sh/ruff/issues/7127 +def f(a: "'b' or 'c'"): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM223.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM223.py index 1842f06994c1f..12edbff6bd8bd 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM223.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM223.py @@ -153,3 +153,7 @@ print(f"{a}{''}" and "bar") print(f"{''}{''}" and "bar") print(f"{1}{''}" and "bar") + + +# https://github.com/astral-sh/ruff/issues/7127 +def f(a: "'' and 'b'"): ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM300.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM300.py index f44cf7ef41e2f..0745cc610850d 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM300.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM300.py @@ -14,6 +14,7 @@ 0 < (number - 100) # SIM300 B<A[0][0]or B B or(B)<A[0][0] +{"non-empty-dict": "is-ok"} == DummyHandler.CONFIG # Errors in preview ['upper'] == UPPER_LIST @@ -39,4 +40,7 @@ (number - 100) > 0 SECONDS_IN_DAY == 60 * 60 * 24 # Error in 0.1.8 SomeClass().settings.SOME_CONSTANT_VALUE > (60 * 60) # Error in 0.1.8 -{"non-empty-dict": "is-ok"} == DummyHandler.CONFIG + +# https://github.com/astral-sh/ruff/issues/14761 +{"": print(1)} == print(2) +{0: 1, **print(2)} == print(4) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM401.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM401.py index 26bc35ee63209..0bfa2499a1e7d 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM401.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM401.py @@ -2,6 +2,8 @@ # Positive cases ### +a_dict = {} + # SIM401 (pattern-1) if key in a_dict: var = a_dict[key] @@ -26,6 +28,8 @@ else: var = "default" +dicts = {"key": a_dict} + # SIM401 (complex expression in dict) if key in dicts[idx]: var = dicts[idx][key] @@ -115,6 +119,28 @@ else: vars[idx] = "default" +class NotADictionary: + def __init__(self): + self._dict = {} + + def __getitem__(self, key): + return self._dict[key] + + def __setitem__(self, key, value): + self._dict[key] = value + + def __iter__(self): + return self._dict.__iter__() + +not_dict = NotADictionary() +not_dict["key"] = "value" + +# OK (type `NotADictionary` is not a known dictionary type) +if "key" in not_dict: + value = not_dict["key"] +else: + value = None + ### # Positive cases (preview) ### diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM905.py b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM905.py new file mode 100644 index 0000000000000..049b60dfaffc6 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_simplify/SIM905.py @@ -0,0 +1,132 @@ +# setup +sep = "," +no_sep = None + +# positives +""" + itemA + itemB + itemC +""".split() + +"a,b,c,d".split(",") +"a,b,c,d".split(None) +"a,b,c,d".split(",", 1) +"a,b,c,d".split(None, 1) +"a,b,c,d".split(sep=",") +"a,b,c,d".split(sep=None) +"a,b,c,d".split(sep=",", maxsplit=1) +"a,b,c,d".split(sep=None, maxsplit=1) +"a,b,c,d".split(maxsplit=1, sep=",") +"a,b,c,d".split(maxsplit=1, sep=None) +"a,b,c,d".split(",", maxsplit=1) +"a,b,c,d".split(None, maxsplit=1) +"a,b,c,d".split(maxsplit=1) +"a,b,c,d".split(maxsplit=1.0) +"a,b,c,d".split(maxsplit=1) +"a,b,c,d".split(maxsplit=0) +"VERB AUX PRON ADP DET".split(" ") +' 1 2 3 '.split() +'1<>2<>3<4'.split('<>') + +" a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +"".split() # [] +""" +""".split() # [] +" ".split() # [] +"/abc/".split() # ["/abc/"] +("a,b,c" +# comment +.split() +) # ["a,b,c"] +("a,b,c" +# comment1 +.split(",") +) # ["a", "b", "c"] +("a," +# comment +"b," +"c" +.split(",") +) # ["a", "b", "c"] + +"hello "\ + "world".split() +# ["hello", "world"] + +# prefixes and isc +u"a b".split() # [u"a", u"b"] +r"a \n b".split() # [r"a", r"\n", r"b"] +("a " "b").split() # ["a", "b"] +"a " "b".split() # ["a", "b"] +u"a " "b".split() # [u"a", u"b"] +"a " u"b".split() # ["a", "b"] +u"a " r"\n".split() # [u"a", u"\\n"] +r"\n " u"\n".split() # [r"\n"] +r"\n " "\n".split() # [r"\n"] +"a " r"\n".split() # ["a", "\\n"] + +"a,b,c".split(',', maxsplit=0) # ["a,b,c"] +"a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +"a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +"a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + +# negatives + +# invalid values should not cause panic +"a,b,c,d".split(maxsplit="hello") +"a,b,c,d".split(maxsplit=-"hello") + +# variable names not implemented +"a,b,c,d".split(sep) +"a,b,c,d".split(no_sep) +for n in range(3): + "a,b,c,d".split(",", maxsplit=n) + +# f-strings not yet implemented +world = "world" +_ = f"{world}_hello_world".split("_") + +hello = "hello_world" +_ = f"{hello}_world".split("_") + +# split on bytes not yet implemented, much less frequent +b"TesT.WwW.ExamplE.CoM".split(b".") + +# str.splitlines not yet implemented +"hello\nworld".splitlines() +"hello\nworld".splitlines(keepends=True) +"hello\nworld".splitlines(keepends=False) + + +# another positive demonstrating quote preservation +""" +"itemA" +'itemB' +'''itemC''' +"'itemD'" +""".split() + +# https://github.com/astral-sh/ruff/issues/18042 +print("a,b".rsplit(",")) +print("a,b,c".rsplit(",", 1)) + +# https://github.com/astral-sh/ruff/issues/18069 + +print("".split(maxsplit=0)) +print("".split(sep=None, maxsplit=0)) +print(" ".split(maxsplit=0)) +print(" ".split(sep=None, maxsplit=0)) +print(" x ".split(maxsplit=0)) +print(" x ".split(sep=None, maxsplit=0)) +print(" x ".split(maxsplit=0)) +print(" x ".split(sep=None, maxsplit=0)) +print("".rsplit(maxsplit=0)) +print("".rsplit(sep=None, maxsplit=0)) +print(" ".rsplit(maxsplit=0)) +print(" ".rsplit(sep=None, maxsplit=0)) +print(" x ".rsplit(maxsplit=0)) +print(" x ".rsplit(maxsplit=0)) +print(" x ".rsplit(sep=None, maxsplit=0)) +print(" x ".rsplit(maxsplit=0)) +print(" x ".rsplit(sep=None, maxsplit=0)) \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_todos/TD003.py b/crates/ruff_linter/resources/test/fixtures/flake8_todos/TD003.py index 2f6b5e73fdbea..87bf5291aa079 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_todos/TD003.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_todos/TD003.py @@ -5,6 +5,12 @@ # TODO: this comment has an issue # TDO-3870 +# TODO: the link has an issue code of the minimum length +# T-001 + +# TODO: the issue code can be arbitrarily long +# ABCDEFGHIJKLMNOPQRSTUVWXYZ-001 + # TDO003 - errors # TODO: this comment has no # link after it @@ -28,4 +34,10 @@ def foo(x): # foo # TODO: no link! +# TODO: https://github.com/astral-sh/ruff/pull/9627 A todo with a link on the same line + +# TODO: #9627 A todo with a number on the same line + +# TODO: A todo with a random number, 5431 + # TODO: here's a TODO on the last line with no link diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC001.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC001.py new file mode 100644 index 0000000000000..960392e98c5ab --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC001.py @@ -0,0 +1,28 @@ +"""Tests to determine first-party import classification. + +For typing-only import detection tests, see `TC002.py`. +""" + + +def f(): + import TYP001 + + x: TYP001 + + +def f(): + import TYP001 + + print(TYP001) + + +def f(): + from . import TYP001 + + x: TYP001 + + +def f(): + from . import TYP001 + + print(TYP001) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC002.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC002.py new file mode 100644 index 0000000000000..fdb73a9cf13c8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC002.py @@ -0,0 +1,185 @@ +"""Tests to determine accurate detection of typing-only imports.""" + + +def f(): + import pandas as pd # TC002 + + x: pd.DataFrame + + +def f(): + from pandas import DataFrame # TC002 + + x: DataFrame + + +def f(): + from pandas import DataFrame as df # TC002 + + x: df + + +def f(): + import pandas as pd # TC002 + + x: pd.DataFrame = 1 + + +def f(): + from pandas import DataFrame # TC002 + + x: DataFrame = 2 + + +def f(): + from pandas import DataFrame as df # TC002 + + x: df = 3 + + +def f(): + import pandas as pd # TC002 + + x: "pd.DataFrame" = 1 + + +def f(): + import pandas as pd # TC002 + + x = dict["pd.DataFrame", "pd.DataFrame"] + + +def f(): + import pandas as pd + + print(pd) + + +def f(): + from pandas import DataFrame + + print(DataFrame) + + +def f(): + from pandas import DataFrame + + def f(): + print(DataFrame) + + +def f(): + from typing import Dict, Any + + def example() -> Any: + return 1 + + x: Dict[int] = 20 + + +def f(): + from typing import TYPE_CHECKING + + if TYPE_CHECKING: + from typing import Dict + x: Dict[int] = 20 + + +def f(): + from pathlib import Path + + class ImportVisitor(ast.NodeTransformer): + def __init__(self, cwd: Path) -> None: + self.cwd = cwd + origin = Path(spec.origin) + + class ExampleClass: + def __init__(self): + self.cwd = Path(pandas.getcwd()) + + +def f(): + import pandas + + class Migration: + enum = pandas + + +def f(): + import pandas + + class Migration: + enum = pandas.EnumClass + + +def f(): + from typing import TYPE_CHECKING + + from pandas import y + + if TYPE_CHECKING: + _type = x + else: + _type = y + + +def f(): + from typing import TYPE_CHECKING + + from pandas import y + + if TYPE_CHECKING: + _type = x + elif True: + _type = y + + +def f(): + from typing import cast + + import pandas as pd + + x = cast(pd.DataFrame, 2) + + +def f(): + import pandas as pd + + x = dict[pd.DataFrame, pd.DataFrame] + + +def f(): + import pandas as pd + + +def f(): + from pandas import DataFrame # noqa: TC002 + + x: DataFrame = 2 + + +def f(): + from pandas import ( # noqa: TC002 + DataFrame, + ) + + x: DataFrame = 2 + + +def f(): + global Member + + from module import Member + + x: Member = 1 + + +def f(): + from typing_extensions import TYPE_CHECKING + + from pandas import y + + if TYPE_CHECKING: + _type = x + elif True: + _type = y diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC003.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC003.py new file mode 100644 index 0000000000000..d9dd926e4272e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC003.py @@ -0,0 +1,16 @@ +"""Tests to determine standard library import classification. + +For typing-only import detection tests, see `TC002.py`. +""" + + +def f(): + import os + + x: os + + +def f(): + import os + + print(os) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_1.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_1.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_1.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_10.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_10.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_10.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_10.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_11.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_11.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_11.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_11.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_12.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_12.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_12.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_12.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_13.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_13.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_13.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_13.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_14.pyi b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_14.pyi similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_14.pyi rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_14.pyi diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_15.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_15.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_15.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_15.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_16.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_16.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_16.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_16.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_17.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_17.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_17.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_17.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_2.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_2.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_2.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_3.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_3.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_3.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_3.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_4.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_4.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_4.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_4.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_5.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_5.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_5.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_5.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_6.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_6.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_6.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_6.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_7.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_7.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_7.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_7.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_8.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_8.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_8.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_8.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_9.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_9.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH004_9.py rename to crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC004_9.py diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC005.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC005.py new file mode 100644 index 0000000000000..1030f6aaf54d4 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC005.py @@ -0,0 +1,41 @@ +from typing import TYPE_CHECKING, List + +if TYPE_CHECKING: + pass # TC005 + + +def example(): + if TYPE_CHECKING: + pass # TC005 + return + + +class Test: + if TYPE_CHECKING: + pass # TC005 + x = 2 + + +if TYPE_CHECKING: + if 2: + pass + + +if TYPE_CHECKING: + x: List + + +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + pass # TC005 + +# https://github.com/astral-sh/ruff/issues/11368 +if TYPE_CHECKING: + pass +else: + pass +if TYPE_CHECKING: + pass +elif test: + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC006.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC006.py new file mode 100644 index 0000000000000..a321f2a30e682 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC006.py @@ -0,0 +1,99 @@ +def f(): + from typing import cast + + cast(int, 3.0) # TC006 + + +def f(): + from typing import cast + + cast(list[tuple[bool | float | int | str]], 3.0) # TC006 + + +def f(): + from typing import Union, cast + + cast(list[tuple[Union[bool, float, int, str]]], 3.0) # TC006 + + +def f(): + from typing import cast + + cast("int", 3.0) # OK + + +def f(): + from typing import cast + + cast("list[tuple[bool | float | int | str]]", 3.0) # OK + + +def f(): + from typing import Union, cast + + cast("list[tuple[Union[bool, float, int, str]]]", 3.0) # OK + + +def f(): + from typing import cast as typecast + + typecast(int, 3.0) # TC006 + + +def f(): + import typing + + typing.cast(int, 3.0) # TC006 + + +def f(): + import typing as t + + t.cast(t.Literal["3.0", '3'], 3.0) # TC006 + + +def f(): + from typing import cast + + cast( + int # TC006 (unsafe, because it will get rid of this comment) + | None, + 3.0 + ) + + +def f(): + # Regression test for #14554 + import typing + typing.cast(M-()) + + +def f(): + # Simple case with Literal that should lead to nested quotes + from typing import cast, Literal + + cast(Literal["A"], 'A') + + +def f(): + # Really complex case with nested forward references + from typing import cast, Annotated, Literal + + cast(list[Annotated["list['Literal[\"A\"]']", "Foo"]], ['A']) + + +def f(): + from typing import cast + + cast( + int # TC006 + , 6.0 + ) + + +def f(): + # Keyword arguments + from typing import cast + + cast(typ=int, val=3.0) # TC006 + cast(val=3.0, typ=int) # TC006 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC007.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC007.py new file mode 100644 index 0000000000000..8ad60ef55ca27 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC007.py @@ -0,0 +1,31 @@ +from __future__ import annotations + +from typing import Dict, TypeAlias, TYPE_CHECKING + +if TYPE_CHECKING: + from typing import Dict + + from foo import Foo + + OptStr: TypeAlias = str | None + Bar: TypeAlias = Foo[int] + +a: TypeAlias = int # OK +b: TypeAlias = Dict # OK +c: TypeAlias = Foo # TC007 +d: TypeAlias = Foo | None # TC007 +e: TypeAlias = OptStr # TC007 +f: TypeAlias = Bar # TC007 +g: TypeAlias = Foo | Bar # TC007 x2 +h: TypeAlias = Foo[str] # TC007 +i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) + Bar) + +type C = Foo # OK +type D = Foo | None # OK +type E = OptStr # OK +type F = Bar # OK +type G = Foo | Bar # OK +type H = Foo[str] # OK +type I = (Foo | # OK + Bar) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008.py new file mode 100644 index 0000000000000..b6ca0e8e5da62 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008.py @@ -0,0 +1,52 @@ +from __future__ import annotations + +from typing import TypeAlias, TYPE_CHECKING + +from foo import Foo + +if TYPE_CHECKING: + from typing import Dict + + OptStr: TypeAlias = str | None + Bar: TypeAlias = Foo[int] +else: + Bar = Foo + +a: TypeAlias = 'int' # TC008 +b: TypeAlias = 'Dict' # OK +c: TypeAlias = 'Foo' # TC008 +d: TypeAlias = 'Foo[str]' # OK +e: TypeAlias = 'Foo.bar' # OK +f: TypeAlias = 'Foo | None' # TC008 +g: TypeAlias = 'OptStr' # OK +h: TypeAlias = 'Bar' # TC008 +i: TypeAlias = Foo['str'] # TC008 +j: TypeAlias = 'Baz' # OK +k: TypeAlias = 'k | None' # OK +l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +m: TypeAlias = ('int' # TC008 + | None) +n: TypeAlias = ('int' # TC008 (fix removes comment currently) + ' | None') + +type B = 'Dict' # TC008 +type D = 'Foo[str]' # TC008 +type E = 'Foo.bar' # TC008 +type G = 'OptStr' # TC008 +type I = Foo['str'] # TC008 +type J = 'Baz' # TC008 +type K = 'K | None' # TC008 +type L = 'int' | None # TC008 (because TC010 is not enabled) +type M = ('int' # TC008 + | None) +type N = ('int' # TC008 (fix removes comment currently) + ' | None') + + +class Baz: + a: TypeAlias = 'Baz' # OK + type A = 'Baz' # TC008 + + class Nested: + a: TypeAlias = 'Baz' # OK + type A = 'Baz' # TC008 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_typing_execution_context.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_typing_execution_context.py new file mode 100644 index 0000000000000..86e7ec4a4a3b8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_typing_execution_context.py @@ -0,0 +1,31 @@ +from __future__ import annotations + +from typing import TypeAlias, TYPE_CHECKING + +from foo import Foo + +if TYPE_CHECKING: + from typing import Dict + + OptStr: TypeAlias = str | None + Bar: TypeAlias = Foo[int] + + a: TypeAlias = 'int' # TC008 + b: TypeAlias = 'Dict' # TC008 + c: TypeAlias = 'Foo' # TC008 + d: TypeAlias = 'Foo[str]' # TC008 + e: TypeAlias = 'Foo.bar' # TC008 + f: TypeAlias = 'Foo | None' # TC008 + g: TypeAlias = 'OptStr' # TC008 + h: TypeAlias = 'Bar' # TC008 + i: TypeAlias = Foo['str'] # TC008 + j: TypeAlias = 'Baz' # OK (this would be treated as use before define) + k: TypeAlias = 'k | None' # False negative in type checking block + l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + m: TypeAlias = ('int' # TC008 + | None) + n: TypeAlias = ('int' # TC008 (fix removes comment currently) + ' | None') + + + class Baz: ... diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_union_syntax_pre_py310.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_union_syntax_pre_py310.py new file mode 100644 index 0000000000000..f9229a1bd44f9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC008_union_syntax_pre_py310.py @@ -0,0 +1,12 @@ +from __future__ import annotations + +from typing import Annotated, TypeAlias, TYPE_CHECKING + +a: TypeAlias = 'int | None' # OK +b: TypeAlias = 'Annotated[int, 1 | 2]' # False negative in runtime context + +if TYPE_CHECKING: + c: TypeAlias = 'int | None' # OK + d: TypeAlias = 'Annotated[int, 1 | 2]' # TC008 + e: TypeAlias = 'Annotated[int, 1 + 2]' # TC008 + f: TypeAlias = 'dict[str, int | None]' # OK diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_1.py new file mode 100644 index 0000000000000..268173c56753a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_1.py @@ -0,0 +1,18 @@ +from __future__ import annotations + +from typing import TypeVar + + +x: "int" | str # TC010 +x: ("int" | str) | "bool" # TC010 + + +def func(): + x: "int" | str # OK + + +z: list[str, str | "int"] = [] # TC010 + +type A = Value["int" | str] # OK + +OldS = TypeVar('OldS', int | 'str', str) # TC010 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_2.py new file mode 100644 index 0000000000000..ee4c4e56ea05b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TC010_2.py @@ -0,0 +1,16 @@ +from typing import TypeVar + + +x: "int" | str # TC010 +x: ("int" | str) | "bool" # TC010 + + +def func(): + x: "int" | str # OK + + +z: list[str, str | "int"] = [] # TC010 + +type A = Value["int" | str] # OK + +OldS = TypeVar('OldS', int | 'str', str) # TC010 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH001.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH001.py deleted file mode 100644 index c85cf3874b0bb..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH001.py +++ /dev/null @@ -1,28 +0,0 @@ -"""Tests to determine first-party import classification. - -For typing-only import detection tests, see `TCH002.py`. -""" - - -def f(): - import TYP001 - - x: TYP001 - - -def f(): - import TYP001 - - print(TYP001) - - -def f(): - from . import TYP001 - - x: TYP001 - - -def f(): - from . import TYP001 - - print(TYP001) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH002.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH002.py deleted file mode 100644 index d3c36312eea7a..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH002.py +++ /dev/null @@ -1,185 +0,0 @@ -"""Tests to determine accurate detection of typing-only imports.""" - - -def f(): - import pandas as pd # TCH002 - - x: pd.DataFrame - - -def f(): - from pandas import DataFrame # TCH002 - - x: DataFrame - - -def f(): - from pandas import DataFrame as df # TCH002 - - x: df - - -def f(): - import pandas as pd # TCH002 - - x: pd.DataFrame = 1 - - -def f(): - from pandas import DataFrame # TCH002 - - x: DataFrame = 2 - - -def f(): - from pandas import DataFrame as df # TCH002 - - x: df = 3 - - -def f(): - import pandas as pd # TCH002 - - x: "pd.DataFrame" = 1 - - -def f(): - import pandas as pd # TCH002 - - x = dict["pd.DataFrame", "pd.DataFrame"] - - -def f(): - import pandas as pd - - print(pd) - - -def f(): - from pandas import DataFrame - - print(DataFrame) - - -def f(): - from pandas import DataFrame - - def f(): - print(DataFrame) - - -def f(): - from typing import Dict, Any - - def example() -> Any: - return 1 - - x: Dict[int] = 20 - - -def f(): - from typing import TYPE_CHECKING - - if TYPE_CHECKING: - from typing import Dict - x: Dict[int] = 20 - - -def f(): - from pathlib import Path - - class ImportVisitor(ast.NodeTransformer): - def __init__(self, cwd: Path) -> None: - self.cwd = cwd - origin = Path(spec.origin) - - class ExampleClass: - def __init__(self): - self.cwd = Path(pandas.getcwd()) - - -def f(): - import pandas - - class Migration: - enum = pandas - - -def f(): - import pandas - - class Migration: - enum = pandas.EnumClass - - -def f(): - from typing import TYPE_CHECKING - - from pandas import y - - if TYPE_CHECKING: - _type = x - else: - _type = y - - -def f(): - from typing import TYPE_CHECKING - - from pandas import y - - if TYPE_CHECKING: - _type = x - elif True: - _type = y - - -def f(): - from typing import cast - - import pandas as pd - - x = cast(pd.DataFrame, 2) - - -def f(): - import pandas as pd - - x = dict[pd.DataFrame, pd.DataFrame] - - -def f(): - import pandas as pd - - -def f(): - from pandas import DataFrame # noqa: TCH002 - - x: DataFrame = 2 - - -def f(): - from pandas import ( # noqa: TCH002 - DataFrame, - ) - - x: DataFrame = 2 - - -def f(): - global Member - - from module import Member - - x: Member = 1 - - -def f(): - from typing_extensions import TYPE_CHECKING - - from pandas import y - - if TYPE_CHECKING: - _type = x - elif True: - _type = y diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH003.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH003.py deleted file mode 100644 index 663af2335a0ee..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH003.py +++ /dev/null @@ -1,16 +0,0 @@ -"""Tests to determine standard library import classification. - -For typing-only import detection tests, see `TCH002.py`. -""" - - -def f(): - import os - - x: os - - -def f(): - import os - - print(os) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH005.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH005.py deleted file mode 100644 index 7817da6848e46..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH005.py +++ /dev/null @@ -1,55 +0,0 @@ -from typing import TYPE_CHECKING, List - -if TYPE_CHECKING: - pass # TCH005 - - -if False: - pass # TCH005 - -if 0: - pass # TCH005 - - -def example(): - if TYPE_CHECKING: - pass # TCH005 - return - - -class Test: - if TYPE_CHECKING: - pass # TCH005 - x = 2 - - -if TYPE_CHECKING: - if 2: - pass - - -if TYPE_CHECKING: - x: List - - -if False: - x: List - -if 0: - x: List - - -from typing_extensions import TYPE_CHECKING - -if TYPE_CHECKING: - pass # TCH005 - -# https://github.com/astral-sh/ruff/issues/11368 -if TYPE_CHECKING: - pass -else: - pass -if TYPE_CHECKING: - pass -elif test: - pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_1.py deleted file mode 100644 index d640994930ad8..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_1.py +++ /dev/null @@ -1,18 +0,0 @@ -from __future__ import annotations - -from typing import TypeVar - - -x: "int" | str # TCH010 -x: ("int" | str) | "bool" # TCH010 - - -def func(): - x: "int" | str # OK - - -z: list[str, str | "int"] = [] # TCH010 - -type A = Value["int" | str] # OK - -OldS = TypeVar('OldS', int | 'str', str) # TCH010 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_2.py deleted file mode 100644 index 09fae9a5e6c93..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/TCH010_2.py +++ /dev/null @@ -1,16 +0,0 @@ -from typing import TypeVar - - -x: "int" | str # TCH010 -x: ("int" | str) | "bool" # TCH010 - - -def func(): - x: "int" | str # OK - - -z: list[str, str | "int"] = [] # TCH010 - -type A = Value["int" | str] # OK - -OldS = TypeVar('OldS', int | 'str', str) # TCH010 diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/app.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/app.py new file mode 100644 index 0000000000000..25f43adc72721 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/app.py @@ -0,0 +1,25 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import fastapi +from fastapi import FastAPI as Api + +if TYPE_CHECKING: + import datetime # TC004 + from array import array # TC004 + +app = fastapi.FastAPI("First application") + +class AppContainer: + app = Api("Second application") + +app_container = AppContainer() + +@app.put("/datetime") +def set_datetime(value: datetime.datetime): + pass + +@app_container.app.get("/array") +def get_array() -> array: + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/routes.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/routes.py new file mode 100644 index 0000000000000..82e8250fb0e78 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/module/routes.py @@ -0,0 +1,14 @@ +from __future__ import annotations + +import pathlib # OK +from datetime import date # OK + +from module.app import app, app_container + +@app.get("/path") +def get_path() -> pathlib.Path: + pass + +@app_container.app.put("/date") +def set_date(d: date): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote.py index 547cd30117672..c41b8db62275d 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote.py @@ -90,3 +90,23 @@ def f(): def func(self) -> DataFrame | list[Series]: pass + + +def f(): + from typing import Annotated + + from fastapi import Depends + + from .foo import get_foo + + def test_annotated_non_typing_reference(user: Annotated[str, Depends(get_foo)]): + pass + + +def f(): + from typing import TypeAlias, TYPE_CHECKING + + if TYPE_CHECKING: + from pandas import DataFrame + + x: TypeAlias = DataFrame | None diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote2.py index 4433416da5087..7e2b9fd0c6de4 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote2.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote2.py @@ -85,3 +85,14 @@ def f(): def test_optional_literal_no_removal(arg: Optional[Literal["red", "blue"]]): pass + + +def f(): + from typing import Annotated + + from fastapi import Depends + + from .foo import get_foo + + def test_annotated_non_typing_reference(user: Annotated[str, Depends(get_foo)]): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote3.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote3.py index b360230b4e6e1..ffb008d4dce1c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote3.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/quote3.py @@ -42,3 +42,29 @@ def f(): def test_attribute_typing_literal(arg: models.AbstractBaseUser[Literal["admin"]]): pass + +def f(): + from typing import Annotated + + from fastapi import Depends + + from .foo import get_foo + + def test_annotated_non_typing_reference(user: Annotated[str, Depends(get_foo)]): + pass + + +def f(): + from typing import Literal + from third_party import Type + + def test_string_contains_opposite_quote(self, type1: Type[Literal["'"]], type2: Type[Literal["\'"]]): + pass + + +def f(): + from typing import Literal + from third_party import Type + + def test_quote_contains_backslash(self, type1: Type[Literal["\n"]], type2: Type[Literal["\""]]): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_1.py index d578d95841e88..418b0b28081f4 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_1.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_1.py @@ -7,10 +7,10 @@ from pydantic import BaseModel if TYPE_CHECKING: - import datetime # TCH004 - from array import array # TCH004 + import datetime # TC004 + from array import array # TC004 - import pandas # TCH004 + import pandas # TC004 import pyproj diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_2.py index b54bf2e9c48f2..65d89487655a1 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_2.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_2.py @@ -1,8 +1,8 @@ from __future__ import annotations -import geopandas as gpd # TCH002 +import geopandas as gpd # TC002 import pydantic -import pyproj # TCH002 +import pyproj # TC002 from pydantic import BaseModel import numpy diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_3.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_3.py index 98527b019dee0..a4caaacb00b97 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_3.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_base_classes_3.py @@ -2,7 +2,7 @@ import datetime import pathlib -from uuid import UUID # TCH003 +from uuid import UUID # TC003 import pydantic from pydantic import BaseModel diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_1.py index fbc22a3aad52e..a37ca8fc4424a 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_1.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_1.py @@ -9,10 +9,10 @@ import numpy if TYPE_CHECKING: - import datetime # TCH004 - from array import array # TCH004 + import datetime # TC004 + from array import array # TC004 - import pandas # TCH004 + import pandas # TC004 import pyproj diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_2.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_2.py index 825dd37ca023d..bdf197f4aab12 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_2.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_2.py @@ -7,7 +7,7 @@ import pyproj from attrs import frozen -import numpy # TCH002 +import numpy # TC002 @attrs.define(auto_attribs=True) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_3.py b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_3.py index fd433772f851a..6991d342d0584 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_3.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_type_checking/runtime_evaluated_decorators_3.py @@ -3,7 +3,7 @@ import datetime from array import array from dataclasses import dataclass -from uuid import UUID # TCH003 +from uuid import UUID # TC003 from collections.abc import Sequence from pydantic import validate_call diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_unused_arguments/ARG.py b/crates/ruff_linter/resources/test/fixtures/flake8_unused_arguments/ARG.py index fbebdff4b2b61..7cfb3fceeee4d 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_unused_arguments/ARG.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_unused_arguments/ARG.py @@ -210,6 +210,9 @@ def f(a, b): # Unused arguments on magic methods. ### class C: + def __new__(cls, x): + print("Hello, world!") + def __init__(self, x) -> None: print("Hello, world!") @@ -219,6 +222,12 @@ def __str__(self) -> str: def __exit__(self, exc_type, exc_value, traceback) -> None: print("Hello, world!") + def __init_subclass__(cls, x) -> None: + print("Hello, world!") + + def __class_getitem__(cls, x): + print("Hello, world!") + ### # Used arguments on chained cast. diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH201.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH201.py index ba495cc588cee..852e060f70adf 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH201.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH201.py @@ -1,15 +1,70 @@ from pathlib import Path, PurePath from pathlib import Path as pth + # match _ = Path(".") _ = pth(".") _ = PurePath(".") _ = Path("") +Path('', ) + +Path( + '', +) + +Path( # Comment before argument + '', +) + +Path( + '', # EOL comment +) + +Path( + '' # Comment in the middle of implicitly concatenated string + ".", +) + +Path( + '' # Comment before comma + , +) + +Path( + '', +) / "bare" + +Path( # Comment before argument + '', +) / ("parenthesized") + +Path( + '', # EOL comment +) / ( ("double parenthesized" ) ) + +( Path( + '' # Comment in the middle of implicitly concatenated string + ".", +) )/ (("parenthesized path call") + # Comment between closing parentheses +) + +Path( + '' # Comment before comma + , +) / "multiple" / ( + "frag" # Comment + 'ment' +) + + # no match _ = Path() print(".") Path("file.txt") Path(".", "folder") PurePath(".", "folder") + +Path() diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH207.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH207.py index 752e924b8bfd2..0005327d83c03 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH207.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH207.py @@ -9,3 +9,7 @@ glob.glob(os.path.join(extensions_dir, "ops", "autograd", "*.cpp")) list(glob.iglob(os.path.join(extensions_dir, "ops", "autograd", "*.cpp"))) search("*.png") + +# if `dir_fd` is set, suppress the diagnostic +glob.glob(os.path.join(extensions_dir, "ops", "autograd", "*.cpp"), dir_fd=1) +list(glob.iglob(os.path.join(extensions_dir, "ops", "autograd", "*.cpp"), dir_fd=1)) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH208.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH208.py new file mode 100644 index 0000000000000..3bdf05ae45f6c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH208.py @@ -0,0 +1,26 @@ +import os + +os.listdir('.') +os.listdir(b'.') + +string_path = '.' +os.listdir(string_path) + +bytes_path = b'.' +os.listdir(bytes_path) + + +from pathlib import Path + +path_path = Path('.') +os.listdir(path_path) + + +if os.listdir("dir"): + ... + +if "file" in os.listdir("dir"): + ... + +os.listdir(1) +os.listdir(path=1) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210.py new file mode 100644 index 0000000000000..bf6b88187f11a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210.py @@ -0,0 +1,105 @@ +from pathlib import ( + Path, + PosixPath, + PurePath, + PurePosixPath, + PureWindowsPath, + WindowsPath, +) +import pathlib + + +path = Path() +posix_path: pathlib.PosixPath = PosixPath() +pure_path: PurePath = PurePath() +pure_posix_path = pathlib.PurePosixPath() +pure_windows_path: PureWindowsPath = pathlib.PureWindowsPath() +windows_path: pathlib.WindowsPath = pathlib.WindowsPath() + + +### Errors +path.with_suffix(".") +path.with_suffix("py") +path.with_suffix(r"s") +path.with_suffix(u'' "json") +path.with_suffix(suffix="js") + +posix_path.with_suffix(".") +posix_path.with_suffix("py") +posix_path.with_suffix(r"s") +posix_path.with_suffix(u'' "json") +posix_path.with_suffix(suffix="js") + +pure_path.with_suffix(".") +pure_path.with_suffix("py") +pure_path.with_suffix(r"s") +pure_path.with_suffix(u'' "json") +pure_path.with_suffix(suffix="js") + +pure_posix_path.with_suffix(".") +pure_posix_path.with_suffix("py") +pure_posix_path.with_suffix(r"s") +pure_posix_path.with_suffix(u'' "json") +pure_posix_path.with_suffix(suffix="js") + +pure_windows_path.with_suffix(".") +pure_windows_path.with_suffix("py") +pure_windows_path.with_suffix(r"s") +pure_windows_path.with_suffix(u'' "json") +pure_windows_path.with_suffix(suffix="js") + +windows_path.with_suffix(".") +windows_path.with_suffix("py") +windows_path.with_suffix(r"s") +windows_path.with_suffix(u'' "json") +windows_path.with_suffix(suffix="js") + + +### No errors +path.with_suffix() +path.with_suffix('') +path.with_suffix(".py") +path.with_suffix("foo", "bar") +path.with_suffix(suffix) +path.with_suffix(f"oo") +path.with_suffix(b"ar") + +posix_path.with_suffix() +posix_path.with_suffix('') +posix_path.with_suffix(".py") +posix_path.with_suffix("foo", "bar") +posix_path.with_suffix(suffix) +posix_path.with_suffix(f"oo") +posix_path.with_suffix(b"ar") + +pure_path.with_suffix() +pure_path.with_suffix('') +pure_path.with_suffix(".py") +pure_path.with_suffix("foo", "bar") +pure_path.with_suffix(suffix) +pure_path.with_suffix(f"oo") +pure_path.with_suffix(b"ar") + +pure_posix_path.with_suffix() +pure_posix_path.with_suffix('') +pure_posix_path.with_suffix(".py") +pure_posix_path.with_suffix("foo", "bar") +pure_posix_path.with_suffix(suffix) +pure_posix_path.with_suffix(f"oo") +pure_posix_path.with_suffix(b"ar") + +pure_windows_path.with_suffix() +pure_windows_path.with_suffix('') +pure_windows_path.with_suffix(".py") +pure_windows_path.with_suffix("foo", "bar") +pure_windows_path.with_suffix(suffix) +pure_windows_path.with_suffix(f"oo") +pure_windows_path.with_suffix(b"ar") + +windows_path.with_suffix() +windows_path.with_suffix('') +windows_path.with_suffix(".py") +windows_path.with_suffix("foo", "bar") +windows_path.with_suffix(suffix) +windows_path.with_suffix(f"oo") +windows_path.with_suffix(b"ar") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210_1.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210_1.py new file mode 100644 index 0000000000000..f8e14246930d8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/PTH210_1.py @@ -0,0 +1,116 @@ +from pathlib import ( + Path, + PosixPath, + PurePath, + PurePosixPath, + PureWindowsPath, + WindowsPath, +) + + +def test_path(p: Path) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") + + +def test_posix_path(p: PosixPath) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") + + +def test_pure_path(p: PurePath) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") + + +def test_pure_posix_path(p: PurePosixPath) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") + + +def test_pure_windows_path(p: PureWindowsPath) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") + + +def test_windows_path(p: WindowsPath) -> None: + ## Errors + p.with_suffix(".") + p.with_suffix("py") + p.with_suffix(r"s") + p.with_suffix(u'' "json") + p.with_suffix(suffix="js") + + ## No errors + p.with_suffix() + p.with_suffix('') + p.with_suffix(".py") + p.with_suffix("foo", "bar") + p.with_suffix(suffix) + p.with_suffix(f"oo") + p.with_suffix(b"ar") diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/full_name.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/full_name.py index 20197b9703863..04bc90b801cbc 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/full_name.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/full_name.py @@ -55,3 +55,52 @@ def opener(path, flags): open(x) def foo(y: int): open(y) + + +# https://github.com/astral-sh/ruff/issues/17691 +def f() -> int: + return 1 +open(f()) + +open(b"foo") +byte_str = b"bar" +open(byte_str) + +def bytes_str_func() -> bytes: + return b"foo" +open(bytes_str_func()) + +# https://github.com/astral-sh/ruff/issues/17693 +os.stat(1) +os.stat(x) + + +def func() -> int: + return 2 +os.stat(func()) + + +def bar(x: int): + os.stat(x) + +# https://github.com/astral-sh/ruff/issues/17694 +os.rename("src", "dst", src_dir_fd=3, dst_dir_fd=4) +os.rename("src", "dst", src_dir_fd=3) +os.rename("src", "dst", dst_dir_fd=4) + +# if `dir_fd` is set, suppress the diagnostic +os.readlink(p, dir_fd=1) +os.stat(p, dir_fd=2) +os.unlink(p, dir_fd=3) +os.remove(p, dir_fd=4) +os.rmdir(p, dir_fd=5) +os.mkdir(p, dir_fd=6) +os.chmod(p, dir_fd=7) +# `chmod` can also receive a file descriptor in the first argument +os.chmod(8) +os.chmod(x) + +# if `src_dir_fd` or `dst_dir_fd` are set, suppress the diagnostic +os.replace("src", "dst", src_dir_fd=1, dst_dir_fd=2) +os.replace("src", "dst", src_dir_fd=1) +os.replace("src", "dst", dst_dir_fd=2) diff --git a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/import_from.py b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/import_from.py index fa75b4a99c7af..2a640623edb1c 100644 --- a/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/import_from.py +++ b/crates/ruff_linter/resources/test/fixtures/flake8_use_pathlib/import_from.py @@ -34,3 +34,16 @@ with open(p) as fp: fp.read() open(p).close() + + +# https://github.com/astral-sh/ruff/issues/15442 +def _(): + from builtins import open + + with open(p) as _: ... # Error + + +def _(): + from builtin import open + + with open(p) as _: ... # No error diff --git a/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this.py b/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this.py new file mode 100644 index 0000000000000..3cbee92baf8a5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this.py @@ -0,0 +1 @@ +import this as this \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this_from.py b/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this_from.py new file mode 100644 index 0000000000000..f79c88288fe21 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/isort/required_imports/this_this_from.py @@ -0,0 +1 @@ +from module import this as this \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N801.py b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N801.py index 58175cd3fe048..e594394060d52 100644 --- a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N801.py +++ b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N801.py @@ -6,6 +6,10 @@ class _bad: pass +class __bad: + pass + + class bad_class: pass @@ -13,6 +17,8 @@ class bad_class: class Bad_Class: pass +class Bad__Class: + pass class BAD_CLASS: pass @@ -32,3 +38,6 @@ class GoodClass: class GOOD: pass + +class __GoodClass: + pass \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N803.py b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N803.py index 6d69704fb3197..9f800742d4992 100644 --- a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N803.py +++ b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N803.py @@ -9,3 +9,21 @@ def method(self, _, a, A): def func(_, setUp): return _, setUp + + +from typing import override + +class Extended(Class): + @override + def method(self, _, a, A): ... + + +@override # Incorrect usage +def func(_, a, A): ... + + +func = lambda _, a, A: ... + + +class Extended(Class): + method = override(lambda self, _, a, A: ...) # Incorrect usage diff --git a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N804.py b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N804.py index 17d4d5187adc5..3fbf2d7c70229 100644 --- a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N804.py +++ b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N804.py @@ -76,3 +76,8 @@ def bad_method(this): def func(x): return x + +foo = {} +class Bar(type(foo)): + def foo_method(self): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N811.py b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N811.py index 0ef646edc9461..c18b8f992d859 100644 --- a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N811.py +++ b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N811.py @@ -1,3 +1,9 @@ import mod.CONST as const from mod import CONSTANT as constant from mod import ANOTHER_CONSTANT as another_constant +import mod.CON as c +from mod import C as c + +# These are all OK: +import django.db.models.Q as Query1 +from django.db.models import Q as Query2 diff --git a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N814.py b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N814.py index 65a03383a5a28..4a6809043000c 100644 --- a/crates/ruff_linter/resources/test/fixtures/pep8_naming/N814.py +++ b/crates/ruff_linter/resources/test/fixtures/pep8_naming/N814.py @@ -1,3 +1,7 @@ import mod.Camel as CAMEL from mod import CamelCase as CAMELCASE from mod import AnotherCamelCase as ANOTHER_CAMELCASE + +# These are all OK: +import mod.AppleFruit as A +from mod import BananaFruit as B diff --git a/crates/ruff_linter/resources/test/fixtures/perflint/PERF401.py b/crates/ruff_linter/resources/test/fixtures/perflint/PERF401.py index f8b8014745017..263f0ff6c6eb9 100644 --- a/crates/ruff_linter/resources/test/fixtures/perflint/PERF401.py +++ b/crates/ruff_linter/resources/test/fixtures/perflint/PERF401.py @@ -74,7 +74,7 @@ def f(): result.append(i) # Ok -def f(): +async def f(): items = [1, 2, 3, 4] result = [] async for i in items: @@ -82,8 +82,187 @@ def f(): result.append(i) # PERF401 -def f(): +async def f(): items = [1, 2, 3, 4] result = [] async for i in items: result.append(i) # PERF401 + + +async def f(): + items = [1, 2, 3, 4] + result = [1, 2] + async for i in items: + result.append(i) # PERF401 + + +def f(): + result, _ = [1, 2, 3, 4], ... + for i in range(10): + result.append(i * 2) # PERF401 + + +def f(): + result = [] + if True: + for i in range(10): # single-line comment 1 should be protected + # single-line comment 2 should be protected + if i % 2: # single-line comment 3 should be protected + result.append(i) # PERF401 + + +def f(): + result = [] # comment after assignment should be protected + for i in range(10): # single-line comment 1 should be protected + # single-line comment 2 should be protected + if i % 2: # single-line comment 3 should be protected + result.append(i) # PERF401 + + +def f(): + result = [] + for i in range(10): + """block comment stops the fix""" + result.append(i * 2) # Ok + + +def f(param): + # PERF401 + # make sure the fix does not panic if there is no comments + if param: + new_layers = [] + for value in param: + new_layers.append(value * 3) + + +def f(): + result = [] + var = 1 + for _ in range(10): + result.append(var + 1) # PERF401 + + +def f(): + # make sure that `tmp` is not deleted + tmp = 1; result = [] # comment should be protected + for i in range(10): + result.append(i + 1) # PERF401 + + +def f(): + # make sure that `tmp` is not deleted + result = []; tmp = 1 # comment should be protected + for i in range(10): + result.append(i + 1) # PERF401 + + +def f(): + result = [] # comment should be protected + for i in range(10): + result.append(i * 2) # PERF401 + + +def f(): + result = [] + result.append(1) + for i in range(10): + result.append(i * 2) # PERF401 + + +def f(): + result = [] + result += [1] + for i in range(10): + result.append(i * 2) # PERF401 + + +def f(): + result = [] + for val in range(5): + result.append(val * 2) # Ok + print(val) + + +def f(): + result = [] + for val in range(5): + result.append(val * 2) # PERF401 + val = 1 + print(val) + + +def f(): + i = [1, 2, 3] + result = [] + for i in i: + result.append(i + 1) # PERF401 + + +def f(): + result = [] + for i in range( # Comment 1 should not be duplicated + ( + 2 # Comment 2 + + 1 + ) + ): # Comment 3 + if i % 2: # Comment 4 + result.append( + ( + i + 1, + # Comment 5 + 2, + ) + ) # PERF401 + + +def f(): + result: list[int] = [] + for i in range(10): + result.append(i * 2) # PERF401 + + +def f(): + a, b = [1, 2, 3], [4, 5, 6] + result = [] + for i in a, b: + result.append(i[0] + i[1]) # PERF401 + return result + + +def f(): + values = [1, 2, 3] + result = [] + for a in values: + print(a) + for a in values: + result.append(a + 1) # PERF401 + +def f(): + values = [1, 2, 3] + def g(): + for a in values: + result.append(a + 1) # PERF401 + result = [] + +def f(): + values = [1, 2, 3] + result = [] + for i in values: + result.append(i + 1) # Ok + del i + +# The fix here must parenthesize the walrus operator +# https://github.com/astral-sh/ruff/issues/15047 +def f(): + items = [] + + for i in range(5): + if j := i: + items.append(j) + +def f(): + values = [1, 2, 3] + result = list() # this should be replaced with a comprehension + for i in values: + result.append(i + 1) # PERF401 diff --git a/crates/ruff_linter/resources/test/fixtures/perflint/PERF403.py b/crates/ruff_linter/resources/test/fixtures/perflint/PERF403.py index 8ef430c8fc9f3..89afca39ffd7e 100644 --- a/crates/ruff_linter/resources/test/fixtures/perflint/PERF403.py +++ b/crates/ruff_linter/resources/test/fixtures/perflint/PERF403.py @@ -18,7 +18,9 @@ def foo(): result = {} for idx, name in enumerate(fruit): if idx % 2: - result[idx] = name # Ok (false negative: edge case where `else` is same as `if`) + result[idx] = ( + name # Ok (false negative: edge case where `else` is same as `if`) + ) else: result[idx] = name @@ -85,7 +87,67 @@ def foo(): def foo(): from builtins import dict as SneakyDict + fruit = ["apple", "pear", "orange"] result = SneakyDict() for idx, name in enumerate(fruit): result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + result: dict[str, int] = { + # comment 1 + } + for idx, name in enumerate( + fruit # comment 2 + ): + # comment 3 + result[ + name # comment 4 + ] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + a = 1; result = {}; b = 2 + for idx, name in enumerate(fruit): + result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + result = {"kiwi": 3} + for idx, name in enumerate(fruit): + result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + (_, result) = (None, {"kiwi": 3}) + for idx, name in enumerate(fruit): + result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + result = {} + print(len(result)) + for idx, name in enumerate(fruit): + result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + result = {} + for idx, name in enumerate(fruit): + if last_idx := idx % 3: + result[name] = idx # PERF403 + + +def foo(): + fruit = ["apple", "pear", "orange"] + indices = [0, 1, 2] + result = {} + for idx, name in indices, fruit: + result[name] = idx # PERF403 diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E22.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E22.py index d20bf4278111b..dae9d26b1e2b5 100644 --- a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E22.py +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E22.py @@ -183,3 +183,8 @@ def squares(n): if a == 1: print(a) + + +# No E225: `=` is not an operator in this case +def _[T: str=None](): ... +def _(t: str=None): ... diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E25.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E25.py index 90f112cfc2a1a..7ac031c924c27 100644 --- a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E25.py +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E25.py @@ -75,3 +75,19 @@ def pep_696_good[A = int, B: object = str, C:object = memoryview](): class PEP696Good[A = int, B: object = str, C:object = memoryview]: def pep_696_good_method[A = int, B: object = str, C:object = memoryview](self): pass + + +# https://github.com/astral-sh/ruff/issues/15202 +type Coro[T: object = Any] = Coroutine[None, None, T] + + +# https://github.com/astral-sh/ruff/issues/15339 +type A = Annotated[ + str, Foo(lorem='ipsum') +] +type B = Annotated[ + int, lambda a=1: ... +] +type C = Annotated[ + int, lambda a: ..., lambda a=1: ... +] diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_3.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_3.py new file mode 100644 index 0000000000000..d7faff834a9bf --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_3.py @@ -0,0 +1,8 @@ +import pytest + +pytest.importorskip("foo.bar") + +import re +from sys import version + +from numpy import * diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_4.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_4.py new file mode 100644 index 0000000000000..7bcc01f89b7d1 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_4.py @@ -0,0 +1,7 @@ +import os +import sys + +sys.path += [os.path.dirname(__file__)] +sys.path += ["../"] + +from package import module \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_5.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_5.py new file mode 100644 index 0000000000000..f4554f78ea5a3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E402_5.py @@ -0,0 +1,19 @@ +# Issue: https://github.com/astral-sh/ruff/issues/16247#event-16362806498 + +import os +import site +import sys +import sysconfig + +site.addsitedir( + os.path.join( + os.path.dirname(os.path.dirname(__file__)), + sysconfig.get_path("purelib", vars={"base": "."}), + ) +) + +from mypkg.__main__ import main + +if __name__ == "__main__": + sys.argv[0] = sys.argv[0].removesuffix(".py") + sys.exit(main()) \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E712.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E712.py index c0be4d7aa1c47..adbb8d578fb3e 100644 --- a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E712.py +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E712.py @@ -53,3 +53,7 @@ assert (not foo) in bar assert {"x": not foo} in bar assert [42, not foo] in bar + +# https://github.com/astral-sh/ruff/issues/17582 +if True == True: # No duplicated diagnostic + pass diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E731.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E731.py index a8acec8eec562..e28d613857469 100644 --- a/crates/ruff_linter/resources/test/fixtures/pycodestyle/E731.py +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/E731.py @@ -156,3 +156,24 @@ def scope(): class FilterDataclass: # OK filter: Callable[[str], bool] = lambda _: True + + +# Regression tests for: +# * https://github.com/astral-sh/ruff/issues/7720 +x = lambda: """ + a + b +""" + +# * https://github.com/astral-sh/ruff/issues/10277 +at_least_one_million = lambda _: _ >= 1_000_000 + +x = lambda: ( + # comment + 5 + 10 +) + +x = lambda: ( + # comment + y := 10 +) \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/W391.ipynb b/crates/ruff_linter/resources/test/fixtures/pycodestyle/W391.ipynb new file mode 100644 index 0000000000000..a1d87cd893818 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/W391.ipynb @@ -0,0 +1,92 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "True\n" + ] + } + ], + "source": [ + "True" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# just a comment in this cell" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# a comment and some newlines\n", + "\n", + "\n", + "\n" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "1 + 1\n", + "# a comment\n", + "\n", + "\n", + "\n", + "\n" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "1+1\n" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "\n", + "\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/crates/ruff_linter/resources/test/fixtures/pycodestyle/W605_1.py b/crates/ruff_linter/resources/test/fixtures/pycodestyle/W605_1.py index 7e60a686d228b..735881301ec5b 100644 --- a/crates/ruff_linter/resources/test/fixtures/pycodestyle/W605_1.py +++ b/crates/ruff_linter/resources/test/fixtures/pycodestyle/W605_1.py @@ -57,3 +57,12 @@ f"{{}}+-\d" f"\n{{}}+-\d+" f"\n{{}}�+-\d+" + +# See https://github.com/astral-sh/ruff/issues/11491 +total = 10 +ok = 7 +incomplete = 3 +s = f"TOTAL: {total}\nOK: {ok}\INCOMPLETE: {incomplete}\n" + +# Debug text (should trigger) +t = f"{'\InHere'=}" diff --git a/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_google.py b/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_google.py index a0b4f93871783..1f5424e4bcbf6 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_google.py +++ b/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_google.py @@ -178,7 +178,7 @@ def foo(x: int) -> int | None: """A very helpful docstring. Args: - x (int): An interger. + x (int): An integer. """ if x < 0: return None @@ -191,7 +191,7 @@ def foo(x): """A very helpful docstring. Args: - x (int): An interger. + x (int): An integer. """ if x < 0: return None diff --git a/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_numpy.py b/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_numpy.py index 396fc45713700..2614a17eebcdf 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_numpy.py +++ b/crates/ruff_linter/resources/test/fixtures/pydoclint/DOC201_numpy.py @@ -154,7 +154,7 @@ def foo(x: int) -> int | None: Parameters ---------- x : int - An interger. + An integer. """ if x < 0: return None @@ -169,7 +169,7 @@ def foo(x): Parameters ---------- x : int - An interger. + An integer. """ if x < 0: return None diff --git a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D202.py b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D202.py index ea59bbc4e69fe..da85cb159cfd2 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D202.py +++ b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D202.py @@ -1,4 +1,4 @@ -"""Test: no-blank-line-after-function special-cases around comment handling.""" +"""Test: blank-line-after-function special-cases around comment handling.""" # OK def outer(): diff --git a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D403.py b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D403.py index bd90d60bc84c2..96752e3b3f13b 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D403.py +++ b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D403.py @@ -31,3 +31,59 @@ def single_word(): def single_word_no_dot(): """singleword""" + +def first_word_lots_of_whitespace(): + """ + + + + here is the start of my docstring! + + What do you think? + """ + +def single_word_newline(): + """singleword + + """ + +def single_word_dot_newline(): + """singleword. + + """ + +def single_word_second_line(): + """ + singleword + """ + +def single_word_dot_second_line(): + """ + singleword. + """ + +def single_word_then_more_text(): + """singleword + + This is more text. + """ + +def single_word_dot_then_more_text(): + """singleword. + + This is more text. + """ + +def single_word_second_line_then_more_text(): + """ + singleword + + This is more text. + """ + +def single_word_dot_second_line_then_more_text(): + """ + singleword. + + This is more text. + """ \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D417.py b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D417.py index e9106dc38507c..7c5a1f538c856 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydocstyle/D417.py +++ b/crates/ruff_linter/resources/test/fixtures/pydocstyle/D417.py @@ -168,3 +168,53 @@ def select_data( database: Which database to connect to ("origin" or "destination"). """ + +def f(x, *args, **kwargs): + """Do something. + + Args: + x: the value + *args: var-arguments + """ + return x + + +# regression test for https://github.com/astral-sh/ruff/issues/16007. +# attributes is a section name without subsections, so it was failing the +# previous workaround for Args: args: sections +def send(payload: str, attributes: dict[str, Any]) -> None: + """ + Send a message. + + Args: + payload: + The message payload. + + attributes: + Additional attributes to be sent alongside the message. + """ + + +# undocumented argument with the same name as a section +def should_fail(payload, Args): + """ + Send a message. + + Args: + payload: + The message payload. + """ + + +# documented argument with the same name as a section +def should_not_fail(payload, Args): + """ + Send a message. + + Args: + payload: + The message payload. + + Args: + The other arguments. + """ diff --git a/crates/ruff_linter/resources/test/fixtures/pydocstyle/sections.py b/crates/ruff_linter/resources/test/fixtures/pydocstyle/sections.py index d04c38a74bff9..22769903dff54 100644 --- a/crates/ruff_linter/resources/test/fixtures/pydocstyle/sections.py +++ b/crates/ruff_linter/resources/test/fixtures/pydocstyle/sections.py @@ -564,6 +564,17 @@ def titlecase_sub_section_header(): """ +def newline_sub_section_header(): + """Below, `returns:` should be considered a section header. + + Args: + arg: Here's a note. + + returns: + Here's another note. + """ + + def test_method_should_be_correctly_capitalized(parameters: list[str], other_parameters: dict[str, str]): # noqa: D213 """Test parameters and attributes sections are capitalized correctly. diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_32.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_32.py new file mode 100644 index 0000000000000..8fc3319071480 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_32.py @@ -0,0 +1,8 @@ +from datetime import datetime +from typing import no_type_check + + +# No errors + +@no_type_check +def f(a: datetime, b: "datetime"): ... diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/__init__.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/__init__.py new file mode 100644 index 0000000000000..4375c1931ef5b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/__init__.py @@ -0,0 +1,8 @@ +"""Regression test for https://github.com/astral-sh/ruff/issues/12897""" + +__all__ = ('Spam',) + + +class Spam: + def __init__(self) -> None: + from F401_33.other import Ham diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/other.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/other.py new file mode 100644 index 0000000000000..364ca1d04652c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_33/other.py @@ -0,0 +1 @@ +Ham = 1 diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_34.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_34.py new file mode 100644 index 0000000000000..c59d4f8c10a15 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F401_34.py @@ -0,0 +1,67 @@ +"""Regression tests for https://github.com/astral-sh/ruff/issues/15812""" + + +def f(): + from typing import Union + + from typing_extensions import TypeAliasType + + Json = TypeAliasType( + "Json", + "Union[dict[str, Json], list[Json], str, int, float, bool, None]", + ) + + +def f(): + from typing import Union + + from typing_extensions import TypeAliasType, TypeVar + + T = TypeVar("T") + V = TypeVar("V") + Json = TypeAliasType( + "Json", + "Union[dict[str, Json], list[Json], str, int, float, bool, T, V, None]", + type_params=(T, V), + ) + + +def f(): + from typing import Union + + from typing_extensions import TypeAliasType + + Json = TypeAliasType( + value="Union[dict[str, Json], list[Json], str, int, float, bool, None]", + name="Json", + ) + + +# strictly speaking it's a false positive to emit F401 for both of these, but +# we can't really be expected to understand that the strings here are type +# expressions (and type checkers probably wouldn't understand them as type +# expressions either!) +def f(): + from typing import Union + + from typing_extensions import TypeAliasType + + args = [ + "Json", + "Union[dict[str, Json], list[Json], str, int, float, bool, None]", + ] + + Json = TypeAliasType(*args) + + +def f(): + from typing import Union + + from typing_extensions import TypeAliasType + + kwargs = { + "name": "Json", + "value": "Union[dict[str, Json], list[Json], str, int, float, bool, None]", + } + + Json = TypeAliasType(**kwargs) diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F523.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F523.py index 94dbe7bb2911c..7b4285776102b 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyflakes/F523.py +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F523.py @@ -31,3 +31,7 @@ # Multiline ('' .format(2)) + +# Removing the final argument. +"Hello".format("world") +"Hello".format("world", key="value") diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F601.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F601.py index 3ef8f1e55dfcc..3fdf218b6886f 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyflakes/F601.py +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F601.py @@ -58,3 +58,13 @@ t={"x":"test123", "x":("test123")} t={"x":("test123"), "x":"test123"} + +# Regression test for: https://github.com/astral-sh/ruff/issues/12772 +x = { + 1: "abc", + 1: "def", + True: "ghi", + 0: "foo", + 0: "bar", + False: "baz", +} diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F704.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F704.py index 2c41ca5071660..70a1272d42b51 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyflakes/F704.py +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F704.py @@ -9,3 +9,11 @@ class Foo: yield 3 yield from 3 await f() + +def _(): + # Invalid yield scopes; but not outside a function + type X[T: (yield 1)] = int + type Y = (yield 2) + + # Valid yield scope + yield 3 diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F722.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F722.py index 35231d60af0fa..e77fb5c402f15 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyflakes/F722.py +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F722.py @@ -11,3 +11,34 @@ def g() -> "///": X: """List[int]"""'☃' = [] + +# Type annotations with triple quotes can contain newlines and indentation +# https://github.com/python/typing-council/issues/9 +y: """ + + int | + str +""" + +z: """( + + int | + str +) +""" + +invalid1: """ + int | +str) +""" + +invalid2: """ + int) | +str +""" +invalid3: """ + ((int) +""" +invalid4: """ + (int +""" diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F722_1.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F722_1.py new file mode 100644 index 0000000000000..adf1861615fd7 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F722_1.py @@ -0,0 +1,16 @@ +from typing import no_type_check + + +# Errors + +@no_type_check +class C: + def f(self, arg: "this isn't python") -> "this isn't python either": + x: "this also isn't python" = 1 + + +# No errors + +@no_type_check +def f(arg: "this isn't python") -> "this isn't python either": + x: "this also isn't python" = 0 diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F811_32.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F811_32.py new file mode 100644 index 0000000000000..b8d89385cbad1 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F811_32.py @@ -0,0 +1,9 @@ +"""Regression test for: https://github.com/astral-sh/ruff/issues/15583""" + +from typing import ( + List, + List, +) + + +def foo() -> List[int]: ... diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_30.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_30.py new file mode 100644 index 0000000000000..4152c06da7b1c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_30.py @@ -0,0 +1,28 @@ +# Regression tests for: +# https://github.com/astral-sh/ruff/issues/10812 + +from typing import Annotated, Literal, TypedDict + + +# No errors +single: TypedDict[{"foo": int}] + +# Error at `qux` +multiple: TypedDict[{ + "bar": str, + "baz": list["qux"], +}] + +# Error at `dolor` +nested: TypedDict[ + "lorem": TypedDict[{ + "ipsum": "dolor" + }], + "sit": Literal["amet"] +] + +# Error at `adipiscing`, `eiusmod`, `tempor` +unpack: TypedDict[{ + "consectetur": Annotated["adipiscing", "elit"] + **{"sed do": str, int: "eiusmod", **tempor} +}] diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_31.py b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_31.py new file mode 100644 index 0000000000000..e4f22a21fa39d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_31.py @@ -0,0 +1,16 @@ +import typing + + +# Errors + +@typing.no_type_check +class C: + def f(self, arg: "B") -> "S": + x: "B" = 1 + + +# No errors + +@typing.no_type_check +def f(arg: "A") -> "R": + x: "A" = 1 diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_32.pyi b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_32.pyi new file mode 100644 index 0000000000000..d8d1280a47d36 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyflakes/F821_32.pyi @@ -0,0 +1,6 @@ +from typing import TypeVar + +# Forward references are okay for both `bound` and `default` in a stub file +_P = TypeVar("_P", bound=X, default=X) + +class X: ... diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.ipynb b/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.ipynb new file mode 100644 index 0000000000000..a94aa9fa2c3ca --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.ipynb @@ -0,0 +1,42 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "import asyncio\n", + "\n", + "await asyncio.sleep(1) # This is okay\n", + "\n", + "if True:\n", + " await asyncio.sleep(1) # This is okay\n", + "\n", + "def foo():\n", + " await asyncio.sleep(1) # # [await-outside-async]" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "base", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.5" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.py b/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.py index 2bc1267615a4e..1379d4d7e329a 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/await_outside_async.py @@ -1,13 +1,16 @@ # pylint: disable=missing-docstring,unused-variable import asyncio + async def nested(): return 42 + async def main(): nested() print(await nested()) # This is okay + def not_async(): print(await nested()) # [await-outside-async] @@ -15,6 +18,7 @@ def not_async(): async def func(i): return i**2 + async def okay_function(): var = [await func(i) for i in range(5)] # This should be okay @@ -28,3 +32,55 @@ def inner_func(): def outer_func(): async def inner_func(): await asyncio.sleep(1) + + +def async_for_loop(): + async for x in foo(): + pass + + +def async_with(): + async with foo(): + pass + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def async_for_generator_elt(): + (await x for x in foo()) + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def async_for_list_comprehension_elt(): + [await x for x in foo()] + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def async_for_list_comprehension(): + [x async for x in foo()] + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def await_generator_iter(): + (x for x in await foo()) + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def await_generator_target(): + (x async for x in foo()) + + +# See: https://github.com/astral-sh/ruff/issues/14167 +def async_for_list_comprehension_target(): + [x for x in await foo()] + + +def async_for_dictionary_comprehension_key(): + {await x: y for x, y in foo()} + + +def async_for_dictionary_comprehension_value(): + {y: await x for x, y in foo()} + + +def async_for_dict_comprehension(): + {x: y async for x, y in foo()} diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/bad_staticmethod_argument.py b/crates/ruff_linter/resources/test/fixtures/pylint/bad_staticmethod_argument.py index 69c459fa6b406..cac78f89f115e 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/bad_staticmethod_argument.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/bad_staticmethod_argument.py @@ -48,3 +48,9 @@ class Foo: @staticmethod def __new__(cls, x, y, z): # OK, see https://docs.python.org/3/reference/datamodel.html#basic-customization pass + +# `__new__` is an implicit staticmethod, so this should still trigger (with +# `self` but not with `cls` as first argument - see above). +class Foo: + def __new__(self, x, y, z): # [bad-staticmethod-argument] + pass diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/bad_str_strip_call.py b/crates/ruff_linter/resources/test/fixtures/pylint/bad_str_strip_call.py index b7344b26ad741..9beed03eadb55 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/bad_str_strip_call.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/bad_str_strip_call.py @@ -64,10 +64,47 @@ u''.lstrip('http://') # PLE1310 -b''.rstrip('http://') +b''.rstrip(b'http://') # OK ''.strip('Hi') # OK ''.strip() + + +### https://github.com/astral-sh/ruff/issues/15968 + +# Errors: Multiple backslashes +''.strip('\\b\\x09') +''.strip(r'\b\x09') +''.strip('\\\x5C') + +# Errors: Type inference +b = b'' +b.strip(b'//') + +# Errors: Type inference (preview) +foo: str = ""; bar: bytes = b"" +foo.rstrip("//") +bar.lstrip(b"//") + + +# OK: Different types +b"".strip("//") +"".strip(b"//") + +# OK: Escapes +'\\test'.strip('\\') + +# OK: Extra/missing arguments +"".strip("//", foo) +b"".lstrip(b"//", foo = "bar") +"".rstrip() + +# OK: Not literals +"".strip(foo) +b"".strip(bar) + +# OK: Not `.[lr]?strip` +"".mobius_strip("") diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/boolean_chained_comparison.py b/crates/ruff_linter/resources/test/fixtures/pylint/boolean_chained_comparison.py index 954285487de59..ff6e10a41cc29 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/boolean_chained_comparison.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/boolean_chained_comparison.py @@ -119,10 +119,30 @@ if a > b and b < c: pass - -# Unfixable due to parentheses. +# fixes will balance parentheses (a < b) and b < c a < b and (b < c) ((a < b) and b < c) (a < b) and (b < c) (((a < b))) and (b < c) + +(a<b) and b<c and ((c<d)) + +# should error and fix +a<b<c and c<d + +# more involved examples (all should error and fix) +a < ( # sneaky comment + b + # more comments +) and b < c + +( + a + <b + # hmmm... + <c + and ((c<d)) +) + +a < (b) and (((b)) < c) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/eq_without_hash.py b/crates/ruff_linter/resources/test/fixtures/pylint/eq_without_hash.py index 35c2fab7b5a4b..d4fc15e5c648b 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/eq_without_hash.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/eq_without_hash.py @@ -1,4 +1,6 @@ -class Person: # [eq-without-hash] +### Errors + +class Person: def __init__(self): self.name = "monty" @@ -6,7 +8,108 @@ def __eq__(self, other): return isinstance(other, Person) and other.name == self.name -# OK +class MaybeEqIf: + if ...: + def __eq__(self, other): ... + + +class MaybeEqElif: + if ...: + ... + elif ...: + def __eq__(self, other): ... + + +class MaybeEqElse: + if ...: + ... + else: + def __eq__(self, other): ... + + +class MaybeEqWith: + with ...: + def __eq__(self, other): ... + + +class MaybeEqFor: + for _ in ...: + def __eq__(self, other): ... + + +class MaybeEqForElse: + for _ in ...: + ... + else: + def __eq__(self, other): ... + + +class MaybeEqWhile: + while ...: + def __eq__(self, other): ... + + +class MaybeEqWhileElse: + while ...: + ... + else: + def __eq__(self, other): ... + + +class MaybeEqTry: + try: + def __eq__(self, other): ... + except Exception: + ... + + +class MaybeEqTryExcept: + try: + ... + except Exception: + def __eq__(self, other): ... + + +class MaybeEqTryExceptElse: + try: + ... + except Exception: + ... + else: + def __eq__(self, other): ... + + +class MaybeEqTryFinally: + try: + ... + finally: + def __eq__(self, other): ... + + +class MaybeEqMatchCase: + match ...: + case int(): + def __eq__(self, other): ... + + +class MaybeEqMatchCaseWildcard: + match ...: + case int(): ... + case _: + def __eq__(self, other): ... + + +class MaybeEqDeeplyNested: + if ...: + ... + else: + with ...: + for _ in ...: + def __eq__(self, other): ... + + +### OK + class Language: def __init__(self): self.name = "python" diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/if_stmt_min_max.py b/crates/ruff_linter/resources/test/fixtures/pylint/if_stmt_min_max.py index 5fdeba431ed26..d5fa9d34c3e9f 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/if_stmt_min_max.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/if_stmt_min_max.py @@ -1,39 +1,98 @@ # pylint: disable=missing-docstring, invalid-name, too-few-public-methods, redefined-outer-name + +# the rule take care of the following cases: +# +# | Case | Expression | Fix | +# |-------|------------------|---------------| +# | 1 | if a >= b: a = b | a = min(b, a) | +# | 2 | if a <= b: a = b | a = max(b, a) | +# | 3 | if a <= b: b = a | b = min(a, b) | +# | 4 | if a >= b: b = a | b = max(a, b) | +# | 5 | if a > b: a = b | a = min(a, b) | +# | 6 | if a < b: a = b | a = max(a, b) | +# | 7 | if a < b: b = a | b = min(b, a) | +# | 8 | if a > b: b = a | b = max(b, a) | + +# the 8 base cases +a, b = [], [] + +# case 1: a = min(b, a) +if a >= b: + a = b + +# case 2: a = max(b, a) +if a <= b: + a = b + +# case 3: b = min(a, b) +if a <= b: + b = a + +# case 4: b = max(a, b) +if a >= b: + b = a + +# case 5: a = min(a, b) +if a > b: + a = b + +# case 6: a = max(a, b) +if a < b: + a = b + +# case 7: b = min(b, a) +if a < b: + b = a + +# case 8: b = max(b, a) +if a > b: + b = a + + +# test cases with assigned variables and primitives value = 10 value2 = 0 value3 = 3 -# Positive -if value < 10: # [max-instead-of-if] +# base case 6: value = max(value, 10) +if value < 10: value = 10 -if value <= 10: # [max-instead-of-if] +# base case 2: value = max(10, value) +if value <= 10: value = 10 -if value < value2: # [max-instead-of-if] +# base case 6: value = max(value, value2) +if value < value2: value = value2 -if value > 10: # [min-instead-of-if] +# base case 5: value = min(value, 10) +if value > 10: value = 10 -if value >= 10: # [min-instead-of-if] +# base case 1: value = min(10, value) +if value >= 10: value = 10 -if value > value2: # [min-instead-of-if] +# base case 5: value = min(value, value2) +if value > value2: value = value2 +# cases with calls class A: def __init__(self): self.value = 13 A1 = A() -if A1.value < 10: # [max-instead-of-if] + + +if A1.value < 10: A1.value = 10 -if A1.value > 10: # [min-instead-of-if] +if A1.value > 10: A1.value = 10 @@ -159,3 +218,34 @@ def foo(self, value) -> None: self._min = value if self._max >= value: self._max = value + + +counter = {"a": 0, "b": 0} + +# base case 2: counter["a"] = max(counter["b"], counter["a"]) +if counter["a"] <= counter["b"]: + counter["a"] = counter["b"] + +# case 3: counter["b"] = min(counter["a"], counter["b"]) +if counter["a"] <= counter["b"]: + counter["b"] = counter["a"] + +# case 5: counter["a"] = min(counter["a"], counter["b"]) +if counter["a"] > counter["b"]: + counter["b"] = counter["a"] + +# case 8: counter["a"] = max(counter["b"], counter["a"]) +if counter["a"] > counter["b"]: + counter["b"] = counter["a"] + +# https://github.com/astral-sh/ruff/issues/17311 + +# fix marked unsafe as delete comments +a, b = [], [] +if a >= b: + # very important comment + a = b + +# fix marked safe as preserve comments +if a >= b: + a = b # very important comment diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/import_outside_top_level_with_banned.py b/crates/ruff_linter/resources/test/fixtures/pylint/import_outside_top_level_with_banned.py new file mode 100644 index 0000000000000..2cc836f24a28c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/import_outside_top_level_with_banned.py @@ -0,0 +1,40 @@ +from typing import TYPE_CHECKING + +# Verify that statements nested in conditionals (such as top-level type-checking blocks) +# are still considered top-level +if TYPE_CHECKING: + import string + +def import_in_function(): + import symtable # [import-outside-toplevel] + import os, sys # [import-outside-toplevel] + import time as thyme # [import-outside-toplevel] + import random as rand, socket as sock # [import-outside-toplevel] + from collections import defaultdict # [import-outside-toplevel] + from math import sin as sign, cos as cosplay # [import-outside-toplevel] + + # these should be allowed due to TID253 top-level ban + import foo_banned + import foo_banned as renamed + from pkg import bar_banned + from pkg import bar_banned as renamed + from pkg_banned import one as other, two, three + + # this should still trigger an error due to multiple imports + from pkg import foo_allowed, bar_banned # [import-outside-toplevel] + +class ClassWithImports: + import tokenize # [import-outside-toplevel] + + def __init__(self): + import trace # [import-outside-toplevel] + + # these should be allowed due to TID253 top-level ban + import foo_banned + import foo_banned as renamed + from pkg import bar_banned + from pkg import bar_banned as renamed + from pkg_banned import one as other, two, three + + # this should still trigger an error due to multiple imports + from pkg import foo_allowed, bar_banned # [import-outside-toplevel] diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/invalid_characters.py b/crates/ruff_linter/resources/test/fixtures/pylint/invalid_characters.py index 79c9307695a91..10c8b4202f0fd 100644 Binary files a/crates/ruff_linter/resources/test/fixtures/pylint/invalid_characters.py and b/crates/ruff_linter/resources/test/fixtures/pylint/invalid_characters.py differ diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/invalid_envvar_default.py b/crates/ruff_linter/resources/test/fixtures/pylint/invalid_envvar_default.py index ed1065ce0e233..070df96a03cbe 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/invalid_envvar_default.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/invalid_envvar_default.py @@ -12,3 +12,6 @@ os.getenv("B", Z) os.getenv("AA", "GOOD" if Z else "BAR") os.getenv("AA", 1 if Z else "BAR") # [invalid-envvar-default] +os.environ.get("TEST", 12) # [invalid-envvar-default] +os.environ.get("TEST", "AA" * 12) +os.environ.get("TEST", 13 * "AA") diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/iteration_over_set.py b/crates/ruff_linter/resources/test/fixtures/pylint/iteration_over_set.py index f8d32e59a572b..ae8ccb3513390 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/iteration_over_set.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/iteration_over_set.py @@ -60,3 +60,6 @@ for item in {1, 2, 2}: # duplicate literals will be ignored # B033 catches this print(f"I like {item}.") + +for item in {False, 0, 0.0, 0j, True, 1, 1.0}: + print(item) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/len_as_condition.py b/crates/ruff_linter/resources/test/fixtures/pylint/len_as_condition.py new file mode 100644 index 0000000000000..973e14386c519 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/len_as_condition.py @@ -0,0 +1,238 @@ +if len('TEST'): # [PLC1802] + pass + +if not len('TEST'): # [PLC1802] + pass + +z = [] +if z and len(['T', 'E', 'S', 'T']): # [PLC1802] + pass + +if True or len('TEST'): # [PLC1802] + pass + +if len('TEST') == 0: # Should be fine + pass + +if len('TEST') < 1: # Should be fine + pass + +if len('TEST') <= 0: # Should be fine + pass + +if 1 > len('TEST'): # Should be fine + pass + +if 0 >= len('TEST'): # Should be fine + pass + +if z and len('TEST') == 0: # Should be fine + pass + +if 0 == len('TEST') < 10: # Should be fine + pass + +# Should be fine +if 0 < 1 <= len('TEST') < 10: # [comparison-of-constants] + pass + +if 10 > len('TEST') != 0: # Should be fine + pass + +if 10 > len('TEST') > 1 > 0: # Should be fine + pass + +if 0 <= len('TEST') < 100: # Should be fine + pass + +if z or 10 > len('TEST') != 0: # Should be fine + pass + +if z: + pass +elif len('TEST'): # [PLC1802] + pass + +if z: + pass +elif not len('TEST'): # [PLC1802] + pass + +while len('TEST'): # [PLC1802] + pass + +while not len('TEST'): # [PLC1802] + pass + +while z and len('TEST'): # [PLC1802] + pass + +while not len('TEST') and z: # [PLC1802] + pass + +assert len('TEST') > 0 # Should be fine + +x = 1 if len('TEST') != 0 else 2 # Should be fine + +f_o_o = len('TEST') or 42 # Should be fine + +a = x and len(x) # Should be fine + +def some_func(): + return len('TEST') > 0 # Should be fine + +def github_issue_1325(): + l = [1, 2, 3] + length = len(l) if l else 0 # Should be fine + return length + +def github_issue_1331(*args): + assert False, len(args) # Should be fine + +def github_issue_1331_v2(*args): + assert len(args), args # [PLC1802] + +def github_issue_1331_v3(*args): + assert len(args) or z, args # [PLC1802] + +def github_issue_1331_v4(*args): + assert z and len(args), args # [PLC1802] + +def github_issue_1331_v5(**args): + assert z and len(args), args # [PLC1802] + +b = bool(len(z)) # [PLC1802] +c = bool(len('TEST') or 42) # [PLC1802] + +def github_issue_1879(): + + class ClassWithBool(list): + def __bool__(self): + return True + + class ClassWithoutBool(list): + pass + + class ChildClassWithBool(ClassWithBool): + pass + + class ChildClassWithoutBool(ClassWithoutBool): + pass + + assert len(ClassWithBool()) + assert len(ChildClassWithBool()) + assert len(ClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] + assert len(ChildClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] + assert len(range(0)) # [PLC1802] + assert len([t + 1 for t in []]) # [PLC1802] + # assert len(u + 1 for u in []) generator has no len + assert len({"1":(v + 1) for v in {}}) # [PLC1802] + assert len(set((w + 1) for w in set())) # [PLC1802] + + + import numpy + numpy_array = numpy.array([0]) + if len(numpy_array) > 0: + print('numpy_array') + if len(numpy_array): + print('numpy_array') + if numpy_array: + print('b') + + import pandas as pd + pandas_df = pd.DataFrame() + if len(pandas_df): + print("this works, but pylint tells me not to use len() without comparison") + if len(pandas_df) > 0: + print("this works and pylint likes it, but it's not the solution intended by PEP-8") + if pandas_df: + print("this does not work (truth value of dataframe is ambiguous)") + + def function_returning_list(r): + if r==1: + return [1] + return [2] + + def function_returning_int(r): + if r==1: + return 1 + return 2 + + def function_returning_generator(r): + for i in [r, 1, 2, 3]: + yield i + + def function_returning_comprehension(r): + return [x+1 for x in [r, 1, 2, 3]] + + def function_returning_function(r): + return function_returning_generator(r) + + assert len(function_returning_list(z)) # [PLC1802] differs from pylint + assert len(function_returning_int(z)) + # This should raise a PLC1802 once astroid can infer it + # See https://github.com/pylint-dev/pylint/pull/3821#issuecomment-743771514 + assert len(function_returning_generator(z)) + assert len(function_returning_comprehension(z)) + assert len(function_returning_function(z)) + + +def github_issue_4215(): + # Test undefined variables + # https://github.com/pylint-dev/pylint/issues/4215 + if len(undefined_var): # [undefined-variable] + pass + if len(undefined_var2[0]): # [undefined-variable] + pass + + +def f(cond:bool): + x = [1,2,3] + if cond: + x = [4,5,6] + if len(x): # this should be addressed + print(x) + +def g(cond:bool): + x = [1,2,3] + if cond: + x = [4,5,6] + if len(x): # this should be addressed + print(x) + del x + +def h(cond:bool): + x = [1,2,3] + x = 123 + if len(x): # ok + print(x) + +def outer(): + x = [1,2,3] + def inner(x:int): + return x+1 + if len(x): # [PLC1802] + print(x) + +def redefined(): + x = 123 + x = [1, 2, 3] + if len(x): # this should be addressed + print(x) + +global_seq = [1, 2, 3] + +def i(): + global global_seq + if len(global_seq): # ok + print(global_seq) + +def j(): + if False: + x = [1, 2, 3] + if len(x): # [PLC1802] should be fine + print(x) + +# regression tests for https://github.com/astral-sh/ruff/issues/14690 +bool(len(ascii(1))) +bool(len(sorted(""))) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/literal_membership.py b/crates/ruff_linter/resources/test/fixtures/pylint/literal_membership.py index 446eda66d00c2..45ebdd273e565 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/literal_membership.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/literal_membership.py @@ -13,3 +13,5 @@ fruits in [1, 2, 3] 1 in [[1, 2, 3], [4, 5, 6]] _ = {key: value for key, value in {"a": 1, "b": 2}.items() if key in (["a", "b"], ["c", "d"])} +1 in [] +1 in () diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/load_before_global_declaration.py b/crates/ruff_linter/resources/test/fixtures/pylint/load_before_global_declaration.py index 5ca672e1a1a43..fdbe9cc9b8760 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/load_before_global_declaration.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/load_before_global_declaration.py @@ -156,3 +156,8 @@ def f(): def f(): global x print(f"{x=}") + + +# surprisingly still an error, global in module scope +x = None +global x diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/nan_comparison.py b/crates/ruff_linter/resources/test/fixtures/pylint/nan_comparison.py index e9ef56c1304f5..3481b37d6e1ac 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/nan_comparison.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/nan_comparison.py @@ -53,6 +53,18 @@ if x == builtins.float("nan"): pass +# https://github.com/astral-sh/ruff/issues/16374 +match number: + # Errors + case np.nan: ... + case math.nan: ... + + # No errors + case np.nan(): ... + case math.nan(): ... + case float('nan'): ... + case npy_nan: ... + # OK if math.isnan(x): pass diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/no_self_use.py b/crates/ruff_linter/resources/test/fixtures/pylint/no_self_use.py index bbb966aba42da..34c4709505e02 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/no_self_use.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/no_self_use.py @@ -103,3 +103,40 @@ def validate_x(self, attribute, value): def validate_y(self, attribute, value): if value <= 0: raise ValueError("y must be a positive integer") + + +class Foo: + + # No errors + + def string(self): + msg = "" + raise NotImplementedError(msg) + + def fstring(self, x): + msg = f"{x}" + raise NotImplementedError(msg) + + def docstring(self): + """Lorem ipsum dolor sit amet.""" + msg = "" + raise NotImplementedError(msg) + + + # Errors + + def non_simple_assignment(self): + msg = foo = "" + raise NotImplementedError(msg) + + def non_simple_assignment_2(self): + msg[0] = "" + raise NotImplementedError(msg) + + def unused_message(self): + msg = "" + raise NotImplementedError("") + + def unused_message_2(self, x): + msg = "" + raise NotImplementedError(x) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/non_augmented_assignment.py b/crates/ruff_linter/resources/test/fixtures/pylint/non_augmented_assignment.py index af6dbfaaa030a..ed4fac06d3f45 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/non_augmented_assignment.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/non_augmented_assignment.py @@ -50,6 +50,50 @@ def t(self): obj = T() obj.a = obj.a + 1 + +a = a+-1 + +# Regression tests for https://github.com/astral-sh/ruff/issues/11672 +test = 0x5 +test = test + 0xBA + +test2 = b"" +test2 = test2 + b"\000" + +test3 = "" +test3 = test3 + ( a := R"" + f"oo" ) + +test4 = [] +test4 = test4 + ( e + for e in + range(10) + ) + +test5 = test5 + ( + 4 + * + 10 +) + +test6 = test6 + \ + ( + 4 + * + 10 + ) + +test7 = \ + 100 \ + + test7 + +test8 = \ + 886 \ + + \ + \ + test8 + + # OK a_list[0] = a_list[:] * 3 index = a_number = a_number + 1 diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/redefined_slots_in_subclass.py b/crates/ruff_linter/resources/test/fixtures/pylint/redefined_slots_in_subclass.py new file mode 100644 index 0000000000000..00896ee4e1d3e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/redefined_slots_in_subclass.py @@ -0,0 +1,23 @@ +class Base: + __slots__ = ("a", "b") + + +class Subclass(Base): + __slots__ = ("a", "d") # [redefined-slots-in-subclass] + +class Grandparent: + __slots__ = ("a", "b") + + +class Parent(Grandparent): + pass + + +class Child(Parent): + __slots__ = ("c", "a") + +class AnotherBase: + __slots__ = ["a","b","c","d"] + +class AnotherChild(AnotherBase): + __slots__ = ["a","b","e","f"] diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/repeated_equality_comparison.py b/crates/ruff_linter/resources/test/fixtures/pylint/repeated_equality_comparison.py index 862065c5f183c..328f38666c87d 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/repeated_equality_comparison.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/repeated_equality_comparison.py @@ -65,3 +65,11 @@ foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets foo == "a" and "c" != bar or foo == "b" and "d" != bar # Multiple targets + +foo == 1 or foo == True # Different types, same hashed value + +foo == 1 or foo == 1.0 # Different types, same hashed value + +foo == False or foo == 0 # Different types, same hashed value + +foo == 0.0 or foo == 0j # Different types, same hashed value diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/self_or_cls_assignment.py b/crates/ruff_linter/resources/test/fixtures/pylint/self_or_cls_assignment.py index fe016694fc19a..201dcb4368512 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/self_or_cls_assignment.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/self_or_cls_assignment.py @@ -41,3 +41,10 @@ def list_fruits_static(self, cls) -> None: def list_fruits(self, cls) -> None: self = "apple" # Ok cls = "banana" # Ok + +# `__new__` is implicitly a static method +# but for the purposes of this check we treat +# it as a class method. +class Foo: + def __new__(cls): + cls = "apple" # PLW0642 diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/shallow_copy_environ.py b/crates/ruff_linter/resources/test/fixtures/pylint/shallow_copy_environ.py new file mode 100644 index 0000000000000..5048cd68a93be --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/shallow_copy_environ.py @@ -0,0 +1,12 @@ +import copy +import os + +copied_env = copy.copy(os.environ) # [shallow-copy-environ] + + +# Test case where the proposed fix is wrong, i.e., unsafe fix +# Ref: https://github.com/astral-sh/ruff/issues/16274#event-16423475135 + +os.environ["X"] = "0" +env = copy.copy(os.environ) +os.environ["X"] = "1" diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_13.py b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_13.py new file mode 100644 index 0000000000000..a461695a0c848 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_13.py @@ -0,0 +1,2 @@ +exit(code=2) + diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_14.py b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_14.py new file mode 100644 index 0000000000000..172959e6837d2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_14.py @@ -0,0 +1,2 @@ +code = {"code": 2} +exit(**code) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_15.py b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_15.py new file mode 100644 index 0000000000000..173cf421a12b3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_15.py @@ -0,0 +1,6 @@ +success = True +if success: + code = 0 +else: + code = 1 +exit(code) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_16.py b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_16.py new file mode 100644 index 0000000000000..9a85db81cb210 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/sys_exit_alias_16.py @@ -0,0 +1,23 @@ +def test_case_1(): + # comments preserved with a positional argument + exit( # comment + 1, # 2 + ) # 3 + + +def test_case_2(): + # comments preserved with a single keyword argument + exit( # comment + code=1, # 2 + ) # 3 + + +def test_case_3(): + # no diagnostic for multiple arguments + exit(2, 3, 4) + + +def test_case_4(): + # this should now be fixable + codes = [1] + exit(*codes) diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_arguments.py b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_arguments.py index d2ff54d376d8d..ef0fe15c47d01 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_arguments.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_arguments.py @@ -74,3 +74,8 @@ def f(y, z, a, b, c, d): # OK def f(y, z, a, b, c): # OK pass +class Foo: + # `__new__` counts args like a classmethod + # even though it is an implicit staticmethod + def __new__(cls,a,b,c,d,e): # Ok + ... diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_positional_arguments.py b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_positional_arguments.py index b769acf63777a..1547d1259490a 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_positional_arguments.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_positional_arguments.py @@ -59,3 +59,10 @@ def f(self=1, a=1, b=1, c=1, d=1, e=1): # OK def f(): # OK pass + +class Foo: + # `__new__` counts args like a classmethod + # even though it is an implicit staticmethod + def __new__(cls,a,b,c,d,e): # Ok + ... + diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_public_methods.py b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_public_methods.py index 80cd6e33298a5..8a65c245ba607 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/too_many_public_methods.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/too_many_public_methods.py @@ -1,3 +1,6 @@ +from typing import Any, Literal, overload + + class Everything: foo = 1 @@ -34,6 +37,7 @@ def method8(self): def method9(self): pass + class Small: def __init__(self): pass @@ -58,3 +62,26 @@ def method5(self): def method6(self): pass + + +class SmallWithOverload: + @overload + def method1(self, a: Literal[1]) -> None: ... + @overload + def method1(self, a: Literal[2]) -> None: ... + @overload + def method1(self, a: Literal[3]) -> None: ... + @overload + def method1(self, a: Literal[4]) -> None: ... + @overload + def method1(self, a: Literal[5]) -> None: ... + @overload + def method1(self, a: Literal[6]) -> None: ... + @overload + def method1(self, a: Literal[7]) -> None: ... + @overload + def method1(self, a: Literal[8]) -> None: ... + @overload + def method1(self, a: Literal[9]) -> None: ... + + def method1(self, a: Any) -> None: ... diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/unexpected_special_method_signature.py b/crates/ruff_linter/resources/test/fixtures/pylint/unexpected_special_method_signature.py index 0748872abce6a..5cf4b7ee0c580 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/unexpected_special_method_signature.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/unexpected_special_method_signature.py @@ -68,8 +68,44 @@ def __round__(self, x, y, *args): # disallow 2 args def __eq__(self, **kwargs): # ignore **kwargs ... - def __eq__(self, /, other=42): # ignore positional-only args + def __eq__(self, /, other=42): # support positional-only args ... - def __eq__(self, *, other=42): # ignore positional-only args + def __eq__(self, *, other=42): # ignore keyword-only args ... + + def __cmp__(self): # #16217 assert non-special method is skipped, expects 2 parameters + ... + + def __div__(self): # #16217 assert non-special method is skipped, expects 2 parameters + ... + + def __nonzero__(self, x): # #16217 assert non-special method is skipped, expects 1 parameter + ... + + def __unicode__(self, x): # #16217 assert non-special method is skipped, expects 1 parameter + ... + + def __next__(self, x): # #16217 assert special method is linted, expects 1 parameter + ... + + def __buffer__(self): # #16217 assert special method is linted, expects 2 parameters + ... + + def __class_getitem__(self): # #16217 assert special method is linted, expects 2 parameters + ... + + def __mro_entries__(self): # #16217 assert special method is linted, expects 2 parameters + ... + + def __release_buffer__(self): # #16217 assert special method is linted, expects 2 parameters + ... + + def __subclasshook__(self): # #16217 assert special method is linted, expects 2 parameters + ... + + def __setattr__(self, /, name): # #16217 assert positional-only special method is linted, expects 3 parameters + ... + + def __setitem__(self, key, /, value, extra_value): # #16217 assert positional-only special method is linted, expects 3 parameters + ... \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/unnecessary_dunder_call.py b/crates/ruff_linter/resources/test/fixtures/pylint/unnecessary_dunder_call.py index 71fde30f5e7db..2f46174fd3822 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/unnecessary_dunder_call.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/unnecessary_dunder_call.py @@ -48,6 +48,21 @@ # Calls print(a.__call__()) # PLC2801 (no fix, intentional) +class Foo: + def __init__(self, v): + self.v = v + + def __add__(self, other): + self.v += other + return self + + def get_v(self): + return self.v + +foo = Foo(1) +foo.__add__(2).get_v() # PLC2801 + + # Lambda expressions blah = lambda: a.__add__(1) # PLC2801 @@ -72,13 +87,22 @@ # Subscripts print({"a": a.__add__(1)}["a"]) # PLC2801 +# https://github.com/astral-sh/ruff/issues/15745 +print("x".__add__("y")[0]) # PLC2801 # Starred print(*[a.__add__(1)]) # PLC2801 +list1 = [1, 2, 3] +list2 = [4, 5, 6] +print([*list1.__add__(list2)]) # PLC2801 + # Slices print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 +# Attribute access +# https://github.com/astral-sh/ruff/issues/15745 +print(1j.__add__(1.0).real) # PLC2801 class Thing: def __init__(self, stuff: Any) -> None: @@ -100,3 +124,8 @@ def use_descriptor(self, item): blah = lambda: {"a": 1}.__delitem__("a") # OK blah = dict[{"a": 1}.__delitem__("a")] # OK + +"abc".__contains__("a") + +# https://github.com/astral-sh/ruff/issues/14597 +assert "abc".__str__() == "abc" diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/unreachable.py b/crates/ruff_linter/resources/test/fixtures/pylint/unreachable.py new file mode 100644 index 0000000000000..a1b8c68914a1f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pylint/unreachable.py @@ -0,0 +1,30 @@ +def empty_statement_reachable(): ... + +def pass_statement_reachable(): + pass + +def no_control_flow_reachable(): + x = 1 + x = 2 + class C: + a = 2 + c = C() + del c + def foo(): + return + +def after_return(): + return 1 + print("unreachable") + print("and this") + +def after_raise(): + raise ValueError + print("unreachable") + print("and this") + +def multiple_returns(): + return 1 + print("unreachable") + return 2 + print("unreachable range should include above return") diff --git a/crates/ruff_linter/resources/test/fixtures/pylint/unspecified_encoding.py b/crates/ruff_linter/resources/test/fixtures/pylint/unspecified_encoding.py index fca823bcbc8a2..db89cbf4e2b7b 100644 --- a/crates/ruff_linter/resources/test/fixtures/pylint/unspecified_encoding.py +++ b/crates/ruff_linter/resources/test/fixtures/pylint/unspecified_encoding.py @@ -94,3 +94,6 @@ def func(*args, **kwargs): # Violation but not detectable x = Path("foo.txt") x.open() + +# https://github.com/astral-sh/ruff/issues/18107 +codecs.open("plw1514.py", "r", "utf-8").close() # this is fine diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/.editorconfig b/crates/ruff_linter/resources/test/fixtures/pyupgrade/.editorconfig new file mode 100644 index 0000000000000..048d4deec14e7 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/.editorconfig @@ -0,0 +1,5 @@ +# These rules test for reformatting with specific line endings. +# Using a formatter fixes that and breaks the tests +[UP018_{CR,LF}.py] +generated_code = true +ij_formatter_enabled = false diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP007.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP007.py index af1c1ca35b3a4..cbc3e79b29da2 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP007.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP007.py @@ -1,16 +1,7 @@ import typing -from typing import Optional from typing import Union -def f(x: Optional[str]) -> None: - ... - - -def f(x: typing.Optional[str]) -> None: - ... - - def f(x: Union[str, int, Union[float, bytes]]) -> None: ... @@ -52,9 +43,6 @@ def f(x: Union[("str", "int"), float]) -> None: def f() -> None: - x: Optional[str] - x = Optional[str] - x = Union[str, int] x = Union["str", "int"] x: Union[str, int] @@ -85,31 +73,6 @@ def f(x: Union[str, lambda: int]) -> None: ... -def f(x: Optional[int : float]) -> None: - ... - - -def f(x: Optional[str, int : float]) -> None: - ... - - -def f(x: Optional[int, float]) -> None: - ... - - -# Regression test for: https://github.com/astral-sh/ruff/issues/7131 -class ServiceRefOrValue: - service_specification: Optional[ - list[ServiceSpecificationRef] - | list[ServiceSpecification] - ] = None - - -# Regression test for: https://github.com/astral-sh/ruff/issues/7201 -class ServiceRefOrValue: - service_specification: Optional[str]is not True = None - - # Regression test for: https://github.com/astral-sh/ruff/issues/7452 class Collection(Protocol[*_B0]): def __iter__(self) -> Iterator[Union[*_B0]]: @@ -119,3 +82,11 @@ def __iter__(self) -> Iterator[Union[*_B0]]: # Regression test for: https://github.com/astral-sh/ruff/issues/8609 def f(x: Union[int, str, bytes]) -> None: ... + + +# Regression test for https://github.com/astral-sh/ruff/issues/14132 +class AClass: + ... + +def myfunc(param: "tuple[Union[int, 'AClass', None], str]"): + print(param) diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_code_utf8_utf8.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_code_utf8_utf8.py new file mode 100644 index 0000000000000..c77de7bb119e9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_code_utf8_utf8.py @@ -0,0 +1,3 @@ +print('No coding coments here') +# -*- coding: utf-8 -*- +# -*- coding: utf-8 -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_hashbang_utf8_other.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_hashbang_utf8_other.py new file mode 100644 index 0000000000000..2c5334e80435f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_hashbang_utf8_other.py @@ -0,0 +1,3 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# -*- coding: ascii -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_many_empty_lines.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_many_empty_lines.py new file mode 100644 index 0000000000000..b74967ff486f8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_many_empty_lines.py @@ -0,0 +1,3 @@ + + +# -*- coding: utf-8 -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_other.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_other.py new file mode 100644 index 0000000000000..4733b5f556bd4 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_other.py @@ -0,0 +1,2 @@ +# -*- coding: ascii -*- +# -*- coding: latin -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_utf8.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_utf8.py new file mode 100644 index 0000000000000..299f74f50b7c8 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_other_utf8.py @@ -0,0 +1,2 @@ +# -*- coding: ascii -*- +# -*- coding: utf-8 -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_code_other.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_code_other.py new file mode 100644 index 0000000000000..32696faba3810 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_code_other.py @@ -0,0 +1,3 @@ +# -*- coding: utf8 -*- +print("the following is not a coding comment") +# -*- coding: ascii -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_other.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_other.py new file mode 100644 index 0000000000000..fd72f37c5ab38 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_other.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +# -*- coding: ascii -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8.py new file mode 100644 index 0000000000000..2423a8804832b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +# -*- coding: utf-8 -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8_other.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8_other.py new file mode 100644 index 0000000000000..031144c8a3dd6 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP009_utf8_utf8_other.py @@ -0,0 +1,3 @@ +# -*- coding: utf-8 -*- +# -*- coding: utf-8 -*- +# -*- coding: ascii -*- diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP013.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP013.py index 0f2628dddd117..baad09bf3f92a 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP013.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP013.py @@ -41,3 +41,14 @@ # Empty dict call MyType = TypedDict("MyType", dict()) + +# Unsafe fix if comments are present +X = TypedDict("X", { + "some_config": int, # important +}) + +# Private names should not be reported (OK) +WithPrivate = TypedDict("WithPrivate", {"__x": int}) + +# Dunder names should not be reported (OK) +WithDunder = TypedDict("WithDunder", {"__x__": int}) diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP014.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP014.py index a30c8ee39c671..db3622e20e503 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP014.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP014.py @@ -31,3 +31,9 @@ ("dataHPK",* str), ], ) + +# Unsafe fix if comments are present +X = NamedTuple("X", [ + ("some_config", int), # important +]) + diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP015.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP015.py index 9f78caef4cddd..a3ba91645b121 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP015.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP015.py @@ -6,6 +6,7 @@ open("foo", "rt") open("f", "r", encoding="UTF-8") open("f", "wt") +open("f", "tw") with open("foo", "U") as f: pass @@ -69,19 +70,14 @@ open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -open = 1 -open("foo", "U") -open("foo", "Ur") -open("foo", "Ub") -open("foo", "rUb") -open("foo", "r") -open("foo", "rt") -open("f", "r", encoding="UTF-8") -open("f", "wt") - - import aiofiles aiofiles.open("foo", "U") aiofiles.open("foo", "r") aiofiles.open("foo", mode="r") + +open("foo", "r+") +open("foo", "rb") +open("foo", "r+b") +open("foo", "UU") +open("foo", "wtt") diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018.py index 5b3a148a46eb1..a5b7e1d8949d6 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018.py @@ -59,3 +59,34 @@ int(-1) float(+1.0) float(-1.0) + + +# https://github.com/astral-sh/ruff/issues/15859 +int(-1) ** 0 # (-1) ** 0 +2 ** int(-1) # 2 ** -1 + +int(-1)[0] # (-1)[0] +2[int(-1)] # 2[-1] + +int(-1)(0) # (-1)(0) +2(int(-1)) # 2(-1) + +float(-1.0).foo # (-1.0).foo + +await int(-1) # await (-1) + + +int(+1) ** 0 +float(+1.0)() + + +str( + '''Lorem + ipsum''' # Comment +).foo + +# https://github.com/astral-sh/ruff/issues/17606 +bool(True)and None +int(1)and None +float(1.)and None +bool(True)and() diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_CR.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_CR.py new file mode 100644 index 0000000000000..7535093fa1487 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_CR.py @@ -0,0 +1 @@ +# Keep parenthesis around preserved CR int(- 1) int(+ 1) diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_LF.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_LF.py new file mode 100644 index 0000000000000..3a2d43335e505 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP018_LF.py @@ -0,0 +1,7 @@ +# Keep parentheses around preserved \n + +int(- + 1) + +int(+ + 1) diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP024_2.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP024_2.py index 25e846e0288cc..e99b47da49f79 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP024_2.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP024_2.py @@ -6,14 +6,16 @@ raise error # Testing the modules -import socket, mmap, select +import socket, mmap, select, resource raise socket.error raise mmap.error raise select.error +raise resource.error raise socket.error() raise mmap.error(1) raise select.error(1, 2) +raise resource.error(1, "strerror", "filename") raise socket.error( 1, @@ -30,6 +32,9 @@ from select import error raise error(1, 2) +from resource import error +raise error(1, "strerror", "filename") + # Testing the names raise EnvironmentError raise IOError diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP027.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP027.py deleted file mode 100644 index 5a40da3bb9f46..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP027.py +++ /dev/null @@ -1,18 +0,0 @@ -# Should change -foo, bar, baz = [fn(x) for x in items] - -foo, bar, baz =[fn(x) for x in items] - -foo, bar, baz = [fn(x) for x in items] - -foo, bar, baz = [[i for i in fn(x)] for x in items] - -foo, bar, baz = [ - fn(x) - for x in items -] - -# Should not change -foo = [fn(x) for x in items] - -x, = [await foo for foo in bar] diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_0.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_0.py index e0935713d45cb..f570638af9aa5 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_0.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_0.py @@ -163,3 +163,26 @@ def f(): pass except Exception as x: pass + + +# https://github.com/astral-sh/ruff/issues/15540 +def f(): + for a in 1,: + yield a + + +SOME_GLOBAL = None + +def f(iterable): + global SOME_GLOBAL + + for SOME_GLOBAL in iterable: + yield SOME_GLOBAL + + some_non_local = None + + def g(): + nonlocal some_non_local + + for some_non_local in iterable: + yield some_non_local diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_1.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_1.py index 66675da186712..6bb6eed6c4cf2 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_1.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP028_1.py @@ -121,3 +121,22 @@ def f(): def f(): for x, y in z: yield x, y, x + y + + +def f(): + global some_global + + for element in iterable: + some_global = element + yield some_global + + +def f(): + some_nonlocal = 1 + + def g(): + nonlocal some_nonlocal + + for element in iterable: + some_nonlocal = element + yield some_nonlocal diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP035.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP035.py index 5b2f11798e41a..50e7cbc968916 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP035.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP035.py @@ -109,3 +109,9 @@ # UP035 on py313+ only from typing_extensions import deprecated + + +# https://github.com/astral-sh/ruff/issues/15780 +from typing_extensions import is_typeddict +# https://github.com/astral-sh/ruff/pull/15800#pullrequestreview-2580704217 +from typing_extensions import TypedDict diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP036_5.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP036_5.py index c7e1a8778da50..697c84a8047d6 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP036_5.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP036_5.py @@ -28,3 +28,46 @@ def a(): else: print(3) return None + + +# https://github.com/astral-sh/ruff/issues/16082 + +## Errors +if sys.version_info < (3, 12, 0): + print() + +if sys.version_info <= (3, 12, 0): + print() + +if sys.version_info < (3, 12, 11): + print() + +if sys.version_info < (3, 13, 0): + print() + +if sys.version_info <= (3, 13, 100000): + print() + + +## No errors + +if sys.version_info <= (3, 13, foo): + print() + +if sys.version_info <= (3, 13, 'final'): + print() + +if sys.version_info <= (3, 13, 0): + print() + +if sys.version_info < (3, 13, 37): + print() + +if sys.version_info <= (3, 13, 37): + print() + +if sys.version_info <= (3, 14, 0): + print() + +if sys.version_info <= (3, 14, 15): + print() diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_0.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_0.py index f970c605a827a..9984545e2f933 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_0.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_0.py @@ -106,3 +106,17 @@ def foo(*, inplace): x = cast("str", x) X = List["MyClass"] + +# Handle end of line comment in string annotation +# See https://github.com/astral-sh/ruff/issues/15816 +def f() -> "Literal[0]#": + return 0 + +def g(x: "Literal['abc']#") -> None: + return + +def f() -> """Literal[0] + # + + """: + return 0 diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_2.pyi b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_2.pyi new file mode 100644 index 0000000000000..c7071fb7528ac --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP037_2.pyi @@ -0,0 +1,50 @@ +# https://github.com/astral-sh/ruff/issues/7102 + +def f(a: Foo['SingleLine # Comment']): ... + + +def f(a: Foo['''Bar[ + Multi | + Line]''']): ... + + +def f(a: Foo['''Bar[ + Multi | + Line # Comment +]''']): ... + + +def f(a: Foo['''Bar[ + Multi | + Line] # Comment''']): ... + + +def f(a: Foo[''' +Bar[ + Multi | + Line] # Comment''']): ... + + +def f(a: '''list[int] + ''' = []): ... + + +a: '''\\ +list[int]''' = [42] + + +def f(a: ''' + list[int] + ''' = []): ... + + +def f(a: Foo[''' + Bar + [ + Multi | + Line + ] # Comment''']): ... + + +a: '''list +[int]''' = [42] diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.py index e107f8da25494..f6797167e1f18 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.py @@ -1,5 +1,5 @@ import typing -from typing import TypeAlias +from typing import Any, TypeAlias # UP040 x: typing.TypeAlias = int @@ -43,6 +43,10 @@ class Foo: T = typing.TypeVar(*args) x: typing.TypeAlias = list[T] +# `default` should be skipped for now, added in Python 3.13 +T = typing.TypeVar("T", default=Any) +x: typing.TypeAlias = list[T] + # OK x: TypeAlias x: int = 1 @@ -85,3 +89,42 @@ class Foo: PositiveList = TypeAliasType( "PositiveList2", list[Annotated[T, Gt(0)]], type_params=(T,) ) + +# `default` should be skipped for now, added in Python 3.13 +T = typing.TypeVar("T", default=Any) +AnyList = TypeAliasType("AnyList", list[T], typep_params=(T,)) + +# unsafe fix if comments within the fix +T = TypeVar("T") +PositiveList = TypeAliasType( # eaten comment + "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +) + +T = TypeVar("T") +PositiveList = TypeAliasType( + "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +) # this comment should be okay + + +# this comment will actually be preserved because it's inside the "value" part +T = TypeVar("T") +PositiveList = TypeAliasType( + "PositiveList", list[ + Annotated[T, Gt(0)], # preserved comment + ], type_params=(T,) +) + +T: TypeAlias = ( + int + | str +) + +T: TypeAlias = ( # comment0 + # comment1 + int # comment2 + # comment3 + | # comment4 + # comment5 + str # comment6 + # comment7 +) # comment8 diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.pyi b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.pyi index e2a18694bd86e..a721f4771aa80 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.pyi +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.pyi @@ -5,3 +5,20 @@ from typing import TypeAlias # Fixes in type stub files should be safe to apply unlike in regular code where runtime behavior could change x: typing.TypeAlias = int x: TypeAlias = int + + +# comments in the value are preserved +x: TypeAlias = tuple[ + int, # preserved + float, +] + +T: TypeAlias = ( # comment0 + # comment1 + int # comment2 + # comment3 + | # comment4 + # comment5 + str # comment6 + # comment7 +) # comment8 diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP043.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP043.py index 3968a16a54a83..5613053d81acb 100644 --- a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP043.py +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP043.py @@ -50,3 +50,10 @@ def func() -> Generator[str, None, None]: async def func() -> AsyncGenerator[str, None]: yield "hello" + + +async def func() -> AsyncGenerator[ # type: ignore + str, + None +]: + yield "hello" diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP044.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP044.py new file mode 100644 index 0000000000000..4d26daf7f19c9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP044.py @@ -0,0 +1,58 @@ +from typing import Generic, TypeVarTuple, Unpack + +Shape = TypeVarTuple("Shape") + + +class C(Generic[Unpack[Shape]]): + pass + + +class D(Generic[Unpack[Shape]]): + pass + + +def f(*args: Unpack[tuple[int, ...]]): + pass + + +def f(*args: Unpack[other.Type]): + pass + + +def f(*args: Generic[int, Unpack[int]]): + pass + + +# Valid syntax, but can't be unpacked. +def f(*args: Unpack[int | str]) -> None: + pass + + +def f(*args: Unpack[int and str]) -> None: + pass + + +def f(*args: Unpack[int > str]) -> None: + pass + + +from typing import TypedDict + + +class KwargsDict(TypedDict): + x: int + y: int + + +# OK +def f(name: str, /, **kwargs: Unpack[KwargsDict]) -> None: + pass + + +# OK +def f() -> object: + return Unpack[tuple[int, ...]] + + +# OK +def f(x: Unpack[int]) -> object: ... diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP045.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP045.py new file mode 100644 index 0000000000000..904c1510eabbe --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP045.py @@ -0,0 +1,44 @@ +import typing +from typing import Optional + + +def f(x: Optional[str]) -> None: + ... + + +def f(x: typing.Optional[str]) -> None: + ... + + +def f() -> None: + x: Optional[str] + x = Optional[str] + + +def f(x: list[Optional[int]]) -> None: + ... + + +def f(x: Optional[int : float]) -> None: + ... + + +def f(x: Optional[str, int : float]) -> None: + ... + + +def f(x: Optional[int, float]) -> None: + ... + + +# Regression test for: https://github.com/astral-sh/ruff/issues/7131 +class ServiceRefOrValue: + service_specification: Optional[ + list[ServiceSpecificationRef] + | list[ServiceSpecification] + ] = None + + +# Regression test for: https://github.com/astral-sh/ruff/issues/7201 +class ServiceRefOrValue: + service_specification: Optional[str]is not True = None diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_0.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_0.py new file mode 100644 index 0000000000000..1d3bcc58be03f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_0.py @@ -0,0 +1,136 @@ +from typing import Any, AnyStr, Generic, ParamSpec, TypeVar, TypeVarTuple + +from somewhere import SupportsRichComparisonT + +S = TypeVar("S", str, bytes) # constrained type variable +T = TypeVar("T", bound=float) +Ts = TypeVarTuple("Ts") +P = ParamSpec("P") + + +class A(Generic[T]): + # Comments in a class body are preserved + var: T + + +class B(Generic[*Ts]): + var: tuple[*Ts] + + +class C(Generic[P]): + var: P + + +class Constrained(Generic[S]): + var: S + + +# This case gets a diagnostic but not a fix because we can't look up the bounds +# or constraints on the TypeVar imported from another module +class ExternalType(Generic[T, SupportsRichComparisonT]): + var: T + compare: SupportsRichComparisonT + + +# typing.AnyStr is a common external type variable, so treat it specially as a +# known TypeVar +class MyStr(Generic[AnyStr]): + s: AnyStr + + +class MultipleGenerics(Generic[S, T, *Ts, P]): + var: S + typ: T + tup: tuple[*Ts] + pep: P + + +class MultipleBaseClasses(list, Generic[T]): + var: T + + +# these are just for the MoreBaseClasses and MultipleBaseAndGenerics cases +class Base1: ... + + +class Base2: ... + + +class Base3: ... + + +class MoreBaseClasses(Base1, Base2, Base3, Generic[T]): + var: T + + +class MultipleBaseAndGenerics(Base1, Base2, Base3, Generic[S, T, *Ts, P]): + var: S + typ: T + tup: tuple[*Ts] + pep: P + + +class A(Generic[T]): ... + + +class B(A[S], Generic[S]): + var: S + + +class C(A[S], Generic[S, T]): + var: tuple[S, T] + + +class D(A[int], Generic[T]): + var: T + + +class NotLast(Generic[T], Base1): + var: T + + +class Sandwich(Base1, Generic[T], Base2): + var: T + + +# runtime `TypeError` to inherit from `Generic` multiple times, but we still +# emit a diagnostic +class TooManyGenerics(Generic[T], Generic[S]): + var: T + var: S + + +# These cases are not handled +class D(Generic[T, T]): # duplicate generic variable, runtime error + pass + + +# TODO(brent) we should also apply the fix to methods, but it will need a +# little more work. these should be left alone for now but be fixed eventually. +class NotGeneric: + # -> generic_method[T: float](t: T) + def generic_method(t: T) -> T: + return t + + +# This one is strange in particular because of the mix of old- and new-style +# generics, but according to the PEP, this is okay "if the class, function, or +# type alias does not use the new syntax." `more_generic` doesn't use the new +# syntax, so it can use T from the module and U from the class scope. +class MixedGenerics[U]: + def more_generic(u: U, t: T) -> tuple[U, T]: + return (u, t) + + +# TODO(brent) default requires 3.13 +V = TypeVar("V", default=Any, bound=str) + + +class DefaultTypeVar(Generic[V]): # -> [V: str = Any] + var: V + + +# nested classes and functions are skipped +class Outer: + class Inner(Generic[T]): + var: T diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_1.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_1.py new file mode 100644 index 0000000000000..95aaf734606d1 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP046_1.py @@ -0,0 +1,12 @@ +"""Replacing AnyStr requires specifying the constraints `bytes` and `str`, so +it can't be replaced if these have been shadowed. This test is in a separate +fixture because it doesn't seem possible to restore `str` to its builtin state +""" + +from typing import AnyStr, Generic + +str = "string" + + +class BadStr(Generic[AnyStr]): + var: AnyStr diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP047.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP047.py new file mode 100644 index 0000000000000..48b5d431de6fb --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP047.py @@ -0,0 +1,59 @@ +from collections.abc import Callable +from typing import Any, AnyStr, ParamSpec, TypeVar, TypeVarTuple + +from somewhere import Something + +S = TypeVar("S", str, bytes) # constrained type variable +T = TypeVar("T", bound=float) +Ts = TypeVarTuple("Ts") +P = ParamSpec("P") + + +def f(t: T) -> T: + return t + + +def g(ts: tuple[*Ts]) -> tuple[*Ts]: + return ts + + +def h( + p: Callable[P, T], + # Comment in the middle of a parameter list should be preserved + another_param, + and_another, +) -> Callable[P, T]: + return p + + +def i(s: S) -> S: + return s + + +# NOTE this case is the reason the fix is marked unsafe. If we can't confirm +# that one of the type parameters (`Something` in this case) is a TypeVar, +# which we can't do across module boundaries, we will not convert it to a +# generic type parameter. This leads to code that mixes old-style standalone +# TypeVars with the new-style generic syntax and will be rejected by type +# checkers +def broken_fix(okay: T, bad: Something) -> tuple[T, Something]: + return (okay, bad) + + +def any_str_param(s: AnyStr) -> AnyStr: + return s + + +# these cases are not handled + +# TODO(brent) default requires 3.13 +V = TypeVar("V", default=Any, bound=str) + + +def default_var(v: V) -> V: + return v + + +def outer(): + def inner(t: T) -> T: + return t diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_0.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_0.py new file mode 100644 index 0000000000000..217dbbef84eb3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_0.py @@ -0,0 +1,30 @@ +# simple case, replace _T in signature and body +class Generic[_T]: + buf: list[_T] + + def append(self, t: _T): + self.buf.append(t) + + +# simple case, replace _T in signature and body +def second[_T](var: tuple[_T]) -> _T: + y: _T = var[1] + return y + + +# one diagnostic for each variable, comments are preserved +def many_generics[ + _T, # first generic + _U, # second generic +](args): + return args + + +# neither of these are currently renamed +from typing import Literal, cast + + +def f[_T](v): + cast("_T", v) + cast("Literal['_T']") + cast("list[_T]", v) diff --git a/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_1.py b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_1.py new file mode 100644 index 0000000000000..ad811b3910d97 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/pyupgrade/UP049_1.py @@ -0,0 +1,105 @@ +# bound +class Foo[_T: str]: + var: _T + + +# constraint +class Foo[_T: (str, bytes)]: + var: _T + + +# python 3.13+ default +class Foo[_T = int]: + var: _T + + +# tuple +class Foo[*_Ts]: + var: tuple[*_Ts] + + +# paramspec +class C[**_P]: + var: _P + + +from typing import Callable + + +# each of these will get a separate diagnostic, but at least they'll all get +# fixed +class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + @staticmethod + def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + return None + + +# this should not be fixed because the new name is a keyword, but we still +# offer a diagnostic +class F[_async]: ... + + +# and this should not be fixed because of the conflict with the outer X, but it +# also gets a diagnostic +def f(): + type X = int + + class ScopeConflict[_X]: + var: _X + x: X + + +# these cases should be skipped entirely +def f[_](x: _) -> _: ... +def g[__](x: __) -> __: ... +def h[_T_](x: _T_) -> _T_: ... +def i[__T__](x: __T__) -> __T__: ... + + +# https://github.com/astral-sh/ruff/issues/16024 + +from typing import cast, Literal + + +class C[_0]: ... + + +class C[T, _T]: ... +class C[_T, T]: ... + + +class C[_T]: + v1 = cast(_T, ...) + v2 = cast('_T', ...) + v3 = cast("\u005fT", ...) + + def _(self): + v1 = cast(_T, ...) + v2 = cast('_T', ...) + v3 = cast("\u005fT", ...) + + +class C[_T]: + v = cast('Literal[\'foo\'] | _T', ...) + + +## Name collision +class C[T]: + def f[_T](self): # No fix, collides with `T` from outer scope + v1 = cast(_T, ...) + v2 = cast('_T', ...) + + +# Unfixable as the new name collides with a variable visible from one of the inner scopes +class C[_T]: + T = 42 + + v1 = cast(_T, ...) + v2 = cast('_T', ...) + + +# Unfixable as the new name collides with a variable visible from one of the inner scopes +class C[_T]: + def f[T](self): + v1 = cast(_T, ...) + v2 = cast('_T', ...) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB116.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB116.py index 9c968e32aa888..6ec754dadc09c 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB116.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB116.py @@ -1,3 +1,6 @@ +import datetime +import sys + num = 1337 def return_num() -> int: @@ -10,6 +13,7 @@ def return_num() -> int: print(oct(1337)[2:]) # FURB116 print(hex(1337)[2:]) # FURB116 print(bin(1337)[2:]) # FURB116 +print(bin(+1337)[2:]) # FURB116 print(bin(return_num())[2:]) # FURB116 (no autofix) print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) @@ -17,3 +21,24 @@ def return_num() -> int: ## invalid print(oct(0o1337)[1:]) print(hex(0x1337)[3:]) + +# https://github.com/astral-sh/ruff/issues/16472 +# float and complex numbers should be ignored +print(bin(1.0)[2:]) +print(bin(3.14j)[2:]) + +d = datetime.datetime.now(tz=datetime.UTC) +# autofix is display-only +print(bin(d)[2:]) +# no autofix for Python 3.11 and earlier, as it introduces a syntax error +print(bin(len("xyz").numerator)[2:]) + +# autofix is display-only +print(bin({0: 1}[0].numerator)[2:]) +# no autofix for Python 3.11 and earlier, as it introduces a syntax error +print(bin(ord("\\").numerator)[2:]) +print(hex(sys +.maxunicode)[2:]) + +# for negatives numbers autofix is display-only +print(bin(-1)[2:]) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB118.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB118.py index 52c8c0ac205d5..27f81b4715b1c 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB118.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB118.py @@ -93,3 +93,53 @@ def add(x, y): # Without a slice, trivia is retained op_itemgetter = lambda x: x[1, 2] + + +# All methods in classes are ignored, even those defined using lambdas: +class Foo: + def x(self, other): + return self == other + +class Bar: + y = lambda self, other: self == other + +from typing import Callable +class Baz: + z: Callable = lambda self, other: self == other + + +# Lambdas wrapped in function calls could also still be method definitions! +# To avoid false positives, we shouldn't flag any of these either: +from typing import final, override, no_type_check + + +class Foo: + a = final(lambda self, other: self == other) + b = override(lambda self, other: self == other) + c = no_type_check(lambda self, other: self == other) + d = final(override(no_type_check(lambda self, other: self == other))) + + +# lambdas used in decorators do not constitute method definitions, +# so these *should* be flagged: +class TheLambdasHereAreNotMethods: + @pytest.mark.parametrize( + "slicer, expected", + [ + (lambda x: x[-2:], "foo"), + (lambda x: x[-5:-3], "bar"), + ], + ) + def test_inlet_asset_alias_extra_slice(self, slicer, expected): + assert slice("whatever") == expected + + +class NotAMethodButHardToDetect: + # In an ideal world, perhaps we'd emit a diagnostic here, + # since this `lambda` is clearly not a method definition, + # and *could* be safely replaced with an `operator` function. + # Practically speaking, however, it's hard to see how we'd accurately determine + # that the `lambda` is *not* a method definition + # without risking false positives elsewhere or introducing complex heuristics + # that users would find surprising and confusing + FOO = sorted([x for x in BAR], key=lambda x: x.baz) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB122.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB122.py new file mode 100644 index 0000000000000..9964945f63051 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB122.py @@ -0,0 +1,176 @@ +from pathlib import Path + +lines = ["line 1", "line 2", "line 3"] + + +# Errors + +def _(): + with open("file", "w") as f: + for line in lines: + f.write(line) + + +def _(): + other_line = "other line" + with Path("file").open("w") as f: + for line in lines: + f.write(other_line) + + +def _(): + with Path("file").open("w") as f: + for line in lines: + f.write(line) + + +def _(): + with Path("file").open("wb") as f: + for line in lines: + f.write(line.encode()) + + +def _(): + with Path("file").open("w") as f: + for line in lines: + f.write(line.upper()) + + +def _(): + with Path("file").open("w") as f: + pass + + for line in lines: + f.write(line) + + +def _(): + # Offer unsafe fix if it would delete comments + with open("file","w") as f: + for line in lines: + # a really important comment + f.write(line) + + +def _(): + with open("file", "w") as f: + for () in a: + f.write(()) + + +def _(): + with open("file", "w") as f: + for a, b, c in d: + f.write((a, b)) + + +def _(): + with open("file", "w") as f: + for [(), [a.b], (c,)] in d: + f.write(()) + + +def _(): + with open("file", "w") as f: + for [([([a[b]],)],), [], (c[d],)] in e: + f.write(()) + + +def _(): + # https://github.com/astral-sh/ruff/issues/15936 + with open("file", "w") as f: + for char in "a", "b": + f.write(char) + +def _(): + # https://github.com/astral-sh/ruff/issues/15936 + with open("file", "w") as f: + for char in "a", "b": + f.write(f"{char}") + +def _(): + with open("file", "w") as f: + for char in ( + "a", # Comment + "b" + ): + f.write(f"{char}") + + +# OK + +def _(): + for line in lines: + Path("file").open("w").write(line) + + +def _(): + with Path("file").open("w") as f: + for line in lines: + pass + + f.write(line) + + +def _(): + with Path("file").open("w") as f: + for line in lines: + f.write(line) + else: + pass + + +async def func(): + with Path("file").open("w") as f: + async for line in lines: # type: ignore + f.write(line) + + +def _(): + with Path("file").open("w") as f: + for line in lines: + f.write() # type: ignore + + +def _(): + with open("file", "w") as f: + global CURRENT_LINE + for CURRENT_LINE in lines: + f.write(CURRENT_LINE) + + +def _(): + foo = 1 + def __(): + with open("file", "w") as f: + nonlocal foo + for foo in lines: + f.write(foo) + + +def _(): + with open("file", "w") as f: + line = '' + for line in lines: + f.write(line) + + +def _(): + with open("file", "w") as f: + for a, b, c in d: + f.write((a, b)) + print(a) + + +def _(): + with open("file", "w") as f: + for [*[*a]], b, [[c]] in d: + f.write((a, b)) + print(c) + + +def _(): + with open("file", "w") as f: + global global_foo + for [a, b, (global_foo, c)] in d: + f.write((a, b)) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB129.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB129.py index 51a3cf73a575e..c5c0307098e7b 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB129.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB129.py @@ -57,7 +57,7 @@ def func(): pass -# False positives +# Ok def func(f): for _line in f.readlines(): pass diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB142.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB142.py index 6a4fd0521b1f3..88d4188b9b76a 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB142.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB142.py @@ -31,6 +31,20 @@ for x in (1, 2, 3): s.add(x + num) +# https://github.com/astral-sh/ruff/issues/15936 +for x in 1, 2, 3: + s.add(x) + +for x in 1, 2, 3: + s.add(f"{x}") + +for x in ( + 1, # Comment + 2, 3 +): + s.add(f"{x}") + + # False negative class C: @@ -41,6 +55,7 @@ class C: for x in (1, 2, 3): c.s.add(x) + # Ok s.update(x for x in (1, 2, 3)) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB156.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB156.py index 2dff502bae56b..032e72aa98aec 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB156.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB156.py @@ -9,8 +9,6 @@ _ = r"""!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~""" _ = " \t\n\r\v\f" -_ = "" in "1234567890" -_ = "" in "12345670" _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' _ = ( '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' @@ -19,23 +17,6 @@ _ = id("0123" "4567" "89") -_ = "" in ("123" - "456" - "789" - "0") - -_ = "" in ( # comment - "123" - "456" - "789" - "0") - - -_ = "" in ( - "123" - "456" # inline comment - "789" - "0") _ = ( "0123456789" @@ -46,8 +27,26 @@ # with comment ).capitalize() -# Ok +# example with augmented assignment +_ += "0123456789" + +# OK _ = "1234567890" _ = "1234" -_ = "" in "1234" +_ = "12" in "12345670" + + +# No errors as the string is considered as a docstring +class C: + "01234567" + + +class C: + def method(self): + "01234567" + + +def function(): + """01234567""" + diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB157.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB157.py index 2d4b3aa089c02..236fe1b04699e 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB157.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB157.py @@ -15,3 +15,57 @@ Decimal(0) Decimal("Infinity") decimal.Decimal(0) + +# Handle Python's Decimal parsing +# See https://github.com/astral-sh/ruff/issues/13807 + +# Errors +Decimal("1_000") +Decimal("__1____000") + +# Ok +Decimal("2e-4") +Decimal("2E-4") +Decimal("_1.234__") +Decimal("2e4") +Decimal("2e+4") +Decimal("2E4") +Decimal("1.2") +# Ok: even though this is equal to `Decimal(123)`, +# we assume that a developer would +# only write it this way if they meant to. +Decimal("١٢٣") + +# Further subtleties +# https://github.com/astral-sh/ruff/issues/14204 +Decimal("-0") # Ok +Decimal("_") # Ok +Decimal(" ") # Ok +Decimal("10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000") # Ok + +# Non-finite variants +# https://github.com/astral-sh/ruff/issues/14587 +Decimal(float(" nan ")) # Decimal(" nan ") +Decimal(float(" +nan ")) # Decimal(" +nan ") +# In this one case, " -nan ", the fix has to be +# `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +Decimal(float(" -nan ")) # Decimal("nan") +Decimal(float(" inf ")) # Decimal(" inf ") +Decimal(float(" +inf ")) # Decimal(" +inf ") +Decimal(float(" -inf ")) # Decimal(" -inf ") +Decimal(float(" infinity ")) # Decimal(" infinity ") +Decimal(float(" +infinity ")) # Decimal(" +infinity ") +Decimal(float(" -infinity ")) # Decimal(" -infinity ") + +# Escape sequence handling in "-nan" case +# Here we do not bother respecting the original whitespace +# and other trivia when offering a fix. +# https://github.com/astral-sh/ruff/issues/16771 +Decimal(float("\x2dnan")) +Decimal(float("\x20\x2dnan")) +Decimal(float("\x20\u002dnan")) +Decimal(float("\x20\U0000002dnan")) +Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +Decimal(float(" -" "nan")) +Decimal(float("-nAn")) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB161.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB161.py index a18600c8b7eb7..6dda8a11c9457 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB161.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB161.py @@ -12,6 +12,7 @@ def ten() -> int: count = bin(ten()).count("1") # FURB161 count = bin((10)).count("1") # FURB161 count = bin("10" "15").count("1") # FURB161 +count = bin("123").count("1") # FURB161 count = x.bit_count() # OK count = (10).bit_count() # OK @@ -20,3 +21,5 @@ def ten() -> int: count = 0o12.bit_count() # OK count = (0x10 + 0x1000).bit_count() # OK count = ten().bit_count() # OK +count = bin(*[123]).count("1") # OK +count = bin(*(123)).count("1") # OK diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB162.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB162.py new file mode 100644 index 0000000000000..892cc25dd6d15 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB162.py @@ -0,0 +1,75 @@ +from datetime import datetime + +date = "" + + +### Errors + +datetime.fromisoformat(date.replace("Z", "+00:00")) +datetime.fromisoformat(date.replace("Z", "-00:" "00")) + +datetime.fromisoformat(date[:-1] + "-00") +datetime.fromisoformat(date[:-1:] + "-0000") + +datetime.fromisoformat(date.strip("Z") + """+0""" + """0""") +datetime.fromisoformat(date.rstrip("Z") + "+\x30\60" '\u0030\N{DIGIT ZERO}') + +datetime.fromisoformat( + # Preserved + ( # Preserved + date + ).replace("Z", "+00") +) + +datetime.fromisoformat( + (date + # Preserved + ) + . + rstrip("Z" + # Unsafe + ) + "-00" # Preserved +) + +datetime.fromisoformat( + ( # Preserved + date + ).strip("Z") + "+0000" +) + +datetime.fromisoformat( + (date + # Preserved + ) + [ # Unsafe + :-1 + ] + "-00" +) + + +# Edge case +datetime.fromisoformat("Z2025-01-01T00:00:00Z".strip("Z") + "+00:00") + + +### No errors + +datetime.fromisoformat(date.replace("Z")) +datetime.fromisoformat(date.replace("Z", "+0000"), foo) +datetime.fromisoformat(date.replace("Z", "-0000"), foo = " bar") + +datetime.fromisoformat(date.replace("Z", "-00", lorem = ipsum)) +datetime.fromisoformat(date.replace("Z", -0000)) + +datetime.fromisoformat(date.replace("z", "+00")) +datetime.fromisoformat(date.replace("Z", "0000")) + +datetime.fromisoformat(date.replace("Z", "-000")) + +datetime.fromisoformat(date.rstrip("Z") + f"-00") +datetime.fromisoformat(date[:-1] + "-00" + '00') + +datetime.fromisoformat(date[:-1] * "-00"'00') + +datetime.fromisoformat(date[-1:] + "+00") +datetime.fromisoformat(date[-1::1] + "+00") diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB168.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB168.py index 36a8081f5a4f3..17238d520c4c9 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB168.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB168.py @@ -5,28 +5,45 @@ if isinstance(foo, type(None)): pass -if isinstance(foo, (type(None))): +if isinstance(foo and bar, type(None)): pass if isinstance(foo, (type(None), type(None), type(None))): pass -if isinstance(foo, None | None): +if isinstance(foo, type(None)) is True: pass -if isinstance(foo, (None | None)): +if -isinstance(foo, type(None)): pass if isinstance(foo, None | type(None)): pass -if isinstance(foo, (None | type(None))): +if isinstance(foo, type(None) | type(None)): pass # A bit contrived, but is both technically valid and equivalent to the above. if isinstance(foo, (type(None) | ((((type(None))))) | ((None | type(None))))): pass +if isinstance( + foo, # Comment + None +): + ... + +from typing import Union + +if isinstance(foo, Union[None]): + ... + +if isinstance(foo, Union[None, None]): + ... + +if isinstance(foo, Union[None, type(None)]): + ... + # Okay. @@ -42,6 +59,12 @@ if isinstance(foo, (int, type(None), str)): pass +if isinstance(foo, str | None): + pass + +if isinstance(foo, Union[None, str]): + ... + # This is a TypeError, which the rule ignores. if isinstance(foo, None): pass @@ -49,3 +72,16 @@ # This is also a TypeError, which the rule ignores. if isinstance(foo, (None,)): pass + +if isinstance(foo, None | None): + pass + +if isinstance(foo, (type(None) | ((((type(None))))) | ((None | None | type(None))))): + pass + +# https://github.com/astral-sh/ruff/issues/15776 +def _(): + def type(*args): ... + + if isinstance(foo, type(None)): + ... diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB169.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB169.py index 5a8f74539b066..1dcf67d1484e4 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB169.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB169.py @@ -26,6 +26,23 @@ type(None) != type(None) +type(a.b) is type(None) + +type( + a( + # Comment + ) +) != type(None) + +type( + a := 1 +) == type(None) + +type( + a for a in range(0) +) is not type(None) + + # Ok. foo is None diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB171.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB171.py index 57c0e13f64f3a..109145cb5cb5d 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB171.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB171.py @@ -46,3 +46,74 @@ if 1 in {*[1]}: pass + + +# https://github.com/astral-sh/ruff/issues/10063 +_ = a in ( + # Foo + b, +) + +_ = a in ( # Foo1 + ( # Foo2 + # Foo3 + ( # Tuple + ( # Bar + (b + # Bar + ) + ) + # Foo4 + # Foo5 + , + ) + # Foo6 + ) +) + +foo = ( + lorem() + .ipsum() + .dolor(lambda sit: sit in ( + # Foo1 + # Foo2 + amet, + )) +) + +foo = ( + lorem() + .ipsum() + .dolor(lambda sit: sit in ( + ( + # Foo1 + # Foo2 + amet + ), + )) +) + +foo = lorem() \ + .ipsum() \ + .dolor(lambda sit: sit in ( + # Foo1 + # Foo2 + amet, + )) + +def _(): + if foo not \ + in [ + # Before + bar + # After + ]: ... + +def _(): + if foo not \ + in [ + # Before + bar + # After + ] and \ + 0 < 1: ... diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB188.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB188.py index 45935595183a3..8f58cb9d8f2b9 100644 --- a/crates/ruff_linter/resources/test/fixtures/refurb/FURB188.py +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB188.py @@ -197,4 +197,11 @@ def handle_surrogates(): text = "\ud800\udc00heythere" if text.startswith("\ud800\udc00"): text = text[1:] - \ No newline at end of file + +# Regression test for +# https://github.com/astral-sh/ruff/issues/16231 +def func(): + a = "sjdfaskldjfakljklfoo" + if a.endswith("foo"): + a = a[: -len("foo")] + print(a) diff --git a/crates/ruff_linter/resources/test/fixtures/refurb/FURB189.py b/crates/ruff_linter/resources/test/fixtures/refurb/FURB189.py new file mode 100644 index 0000000000000..4df913feff884 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/refurb/FURB189.py @@ -0,0 +1,48 @@ +# setup +from enum import Enum, EnumMeta +from collections import UserList as UL + +class SetOnceMappingMixin: + __slots__ = () + def __setitem__(self, key, value): + if key in self: + raise KeyError(str(key) + ' already set') + return super().__setitem__(key, value) + + +class CaseInsensitiveEnumMeta(EnumMeta): + pass + +# positives +class D(dict): + pass + +class L(list): + pass + +class S(str): + pass + +class SubscriptDict(dict[str, str]): + pass + +class SubscriptList(list[str]): + pass + +# currently not detected +class SetOnceDict(SetOnceMappingMixin, dict): + pass + +# negatives +class C: + pass + +class I(int): + pass + +class ActivityState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Activity state. This is an optional property and if not provided, the state will be Active by + default. + """ + ACTIVE = "Active" + INACTIVE = "Inactive" diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/.editorconfig b/crates/ruff_linter/resources/test/fixtures/ruff/.editorconfig new file mode 100644 index 0000000000000..bf4811bd1a7a2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/.editorconfig @@ -0,0 +1,5 @@ +# These rules test for reformatting with specific line endings. +# Using a formatter fixes that and breaks the tests +[RUF046_{CR,LF}.py] +generated_code = true +ij_formatter_enabled = false diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF005_slices.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF005_slices.py new file mode 100644 index 0000000000000..2ea85dfd0f854 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF005_slices.py @@ -0,0 +1,6 @@ +foo = [4, 5, 6] +bar = [1, 2, 3] + foo +slicing1 = foo[:1] + [7, 8, 9] +slicing2 = [7, 8, 9] + bar[1:] +slicing3 = foo[:1] + [7, 8, 9] + bar[1:] +indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF008.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008.py index 978b88b0c79f0..19b7ee1d5dcfd 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF008.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008.py @@ -23,3 +23,14 @@ class B: correct_code: list[int] = KNOWINGLY_MUTABLE_DEFAULT perfectly_fine: list[int] = field(default_factory=list) class_variable: ClassVar[list[int]] = [] + +# Lint should account for deferred annotations +# See https://github.com/astral-sh/ruff/issues/15857 +@dataclass +class AWithQuotes: + mutable_default: 'list[int]' = [] + immutable_annotation: 'typing.Sequence[int]' = [] + without_annotation = [] + correct_code: 'list[int]' = KNOWINGLY_MUTABLE_DEFAULT + perfectly_fine: 'list[int]' = field(default_factory=list) + class_variable: 'typing.ClassVar[list[int]]'= [] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_attrs.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_attrs.py new file mode 100644 index 0000000000000..016be01bced00 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_attrs.py @@ -0,0 +1,47 @@ +import typing +from typing import ClassVar, Sequence + +import attr +from attr import s +from attrs import define, frozen + +KNOWINGLY_MUTABLE_DEFAULT = [] + + +@define +class A: + mutable_default: list[int] = [] + immutable_annotation: typing.Sequence[int] = [] + without_annotation = [] + correct_code: list[int] = KNOWINGLY_MUTABLE_DEFAULT + perfectly_fine: list[int] = field(default_factory=list) + class_variable: typing.ClassVar[list[int]] = [] + + +@frozen +class B: + mutable_default: list[int] = [] + immutable_annotation: Sequence[int] = [] + without_annotation = [] + correct_code: list[int] = KNOWINGLY_MUTABLE_DEFAULT + perfectly_fine: list[int] = field(default_factory=list) + class_variable: ClassVar[list[int]] = [] + + +@attr.s +class C: + mutable_default: list[int] = [] + immutable_annotation: Sequence[int] = [] + without_annotation = [] + correct_code: list[int] = KNOWINGLY_MUTABLE_DEFAULT + perfectly_fine: list[int] = field(default_factory=list) + class_variable: ClassVar[list[int]] = [] + +@s +class D: + mutable_default: list[int] = [] + immutable_annotation: Sequence[int] = [] + without_annotation = [] + correct_code: list[int] = KNOWINGLY_MUTABLE_DEFAULT + perfectly_fine: list[int] = field(default_factory=list) + class_variable: ClassVar[list[int]] = [] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_deferred.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_deferred.py new file mode 100644 index 0000000000000..17a6383c134c5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF008_deferred.py @@ -0,0 +1,19 @@ +# Lint should account for deferred annotations +# See https://github.com/astral-sh/ruff/issues/15857 + +from __future__ import annotations + +import typing +from dataclasses import dataclass + + +@dataclass +class Example(): + """Class that uses ClassVar.""" + + options: ClassVar[dict[str, str]] = {} + + +if typing.TYPE_CHECKING: + from typing import ClassVar + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF009.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009.py index f1cc836ffc5aa..a98835577c1d9 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF009.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009.py @@ -69,3 +69,44 @@ def __set__(self, obj, value): @dataclass class InventoryItem: quantity_on_hand: IntConversionDescriptor = IntConversionDescriptor(default=100) + + +# Regression tests for: +# https://github.com/astral-sh/ruff/issues/6447 +from typing import NewType + +ListOfStrings = NewType("ListOfStrs", list[str]) +StringsToInts = NewType("IntsToStrings", dict[str, int]) + +SpecialString = NewType(name="SpecialString", tp=str) +NegativeInteger = NewType("NegInt", tp=int) + +Invalid1 = NewType(*Foo) +Invalid2 = NewType("Invalid2", name=Foo) +Invalid3 = NewType("Invalid3", name=Foo, lorem="ipsum") + +@dataclass +class DataclassWithNewTypeFields: + # Errors + a: ListOfStrings = ListOfStrings([]) + b: StringsToInts = StringsToInts() + c: Invalid1 = Invalid1() + d: Invalid2 = Invalid2() + e: Invalid3 = Invalid3() + + # No errors + e: SpecialString = SpecialString("Lorem ipsum") + f: NegativeInteger = NegativeInteger(-110) + + +# Test for: +# https://github.com/astral-sh/ruff/issues/15772 +def f() -> int: + return 0 + +@dataclass +class ShouldMatchB008RuleOfImmutableTypeAnnotationIgnored: + this_is_not_fine: list[int] = default_function() + # ignored + this_is_fine: int = f() + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs.py new file mode 100644 index 0000000000000..7910b3932306b --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs.py @@ -0,0 +1,75 @@ +import datetime +import re +import typing +from collections import OrderedDict +from fractions import Fraction +from pathlib import Path +from typing import ClassVar, NamedTuple + +import attr +from attrs import Factory, define, field, frozen + + +def default_function() -> list[int]: + return [] + + +class ImmutableType(NamedTuple): + something: int = 8 + + +@attr.s +class A: + hidden_mutable_default: list[int] = default_function() + class_variable: typing.ClassVar[list[int]] = default_function() + another_class_var: ClassVar[list[int]] = default_function() + + fine_path: Path = Path() + fine_date: datetime.date = datetime.date(2042, 1, 1) + fine_timedelta: datetime.timedelta = datetime.timedelta(hours=7) + fine_tuple: tuple[int] = tuple([1]) + fine_regex: re.Pattern = re.compile(r".*") + fine_float: float = float("-inf") + fine_int: int = int(12) + fine_complex: complex = complex(1, 2) + fine_str: str = str("foo") + fine_bool: bool = bool("foo") + fine_fraction: Fraction = Fraction(1, 2) + + +DEFAULT_IMMUTABLETYPE_FOR_ALL_DATACLASSES = ImmutableType(40) +DEFAULT_A_FOR_ALL_DATACLASSES = A([1, 2, 3]) + + +@define +class B: + hidden_mutable_default: list[int] = default_function() + another_dataclass: A = A() + not_optimal: ImmutableType = ImmutableType(20) + good_variant: ImmutableType = DEFAULT_IMMUTABLETYPE_FOR_ALL_DATACLASSES + okay_variant: A = DEFAULT_A_FOR_ALL_DATACLASSES + + fine_dataclass_function: list[int] = field(default_factory=list) + attrs_factory: dict[str, str] = Factory(OrderedDict) + + +class IntConversionDescriptor: + def __init__(self, *, default): + self._default = default + + def __set_name__(self, owner, name): + self._name = "_" + name + + def __get__(self, obj, type): + if obj is None: + return self._default + + return getattr(obj, self._name, self._default) + + def __set__(self, obj, value): + setattr(obj, self._name, int(value)) + + +@frozen +class InventoryItem: + quantity_on_hand: IntConversionDescriptor = IntConversionDescriptor(default=100) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs_auto_attribs.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs_auto_attribs.py new file mode 100644 index 0000000000000..ba7517d4fb293 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_attrs_auto_attribs.py @@ -0,0 +1,125 @@ +import attr +from attrs import define, field, frozen, mutable + + +foo = int + + +@define # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@define() # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@define(auto_attribs=None) # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@frozen # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@frozen() # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@frozen(auto_attribs=None) # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@mutable # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@mutable() # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@mutable(auto_attribs=None) # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s # auto_attribs = False +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s() # auto_attribs = False +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s(auto_attribs=None) # auto_attribs = None => True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s(auto_attribs=False) # auto_attribs = False +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s(auto_attribs=True) # auto_attribs = True +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() + + +@attr.s(auto_attribs=[1, 2, 3]) # auto_attribs = False +class C: + a: str = 0 + b = field() + c: int = foo() + d = list() diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_deferred.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_deferred.py new file mode 100644 index 0000000000000..3dca024086fe5 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF009_deferred.py @@ -0,0 +1,15 @@ +from dataclasses import dataclass +from typing import TYPE_CHECKING + + +def default_function() ->list[int]: + return [] + +@dataclass() +class A: + hidden_mutable_default: list[int] = default_function() + class_variable: typing.ClassVar[list[int]] = default_function() + another_class_var: ClassVar[list[int]] = default_function() + +if TYPE_CHECKING: + from typing import ClassVar diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py index d2ae74bc4b769..eb27b3172684d 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py @@ -79,3 +79,56 @@ class Config(BaseConfig): without_annotation = [] class_variable: ClassVar[list[int]] = [] final_variable: Final[list[int]] = [] + + +from pydantic.v1 import BaseModel as V1BaseModel + + +class I(V1BaseModel): + mutable_default: list[int] = [] + + +from pydantic.v1.generics import GenericModel + + +class J(GenericModel): + mutable_default: list[int] = [] + + +def sqlmodel_import_checker(): + from sqlmodel.main import SQLModel + + class K(SQLModel): + id: int + mutable_default: list[int] = [] + +from sqlmodel import SQLModel + +class L(SQLModel): + id: int + name: str + + +class M(SQLModel): + id: int + i_s: list[J] = [] + + +class N(SQLModel): + id: int + i_j: list[L] = list() + +# Lint should account for deferred annotations +# See https://github.com/astral-sh/ruff/issues/15857 +class AWithQuotes: + __slots__ = { + "mutable_default": "A mutable default value", + } + + mutable_default: 'list[int]' = [] + immutable_annotation: 'Sequence[int]'= [] + without_annotation = [] + class_variable: 'ClassVar[list[int]]' = [] + final_variable: 'Final[list[int]]' = [] + class_variable_without_subscript: 'ClassVar' = [] + final_variable_without_subscript: 'Final' = [] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF012_deferred.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF012_deferred.py new file mode 100644 index 0000000000000..35ebc39cbb88f --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF012_deferred.py @@ -0,0 +1,16 @@ +# Lint should account for deferred annotations +# See https://github.com/astral-sh/ruff/issues/15857 + +from __future__ import annotations + +import typing + + +class Example(): + """Class that uses ClassVar.""" + + options: ClassVar[dict[str, str]] = {} + + +if typing.TYPE_CHECKING: + from typing import ClassVar diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF013_4.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF013_4.py new file mode 100644 index 0000000000000..c6038a9531d2d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF013_4.py @@ -0,0 +1,21 @@ +# https://github.com/astral-sh/ruff/issues/13833 + +from typing import Optional + + +def no_default(arg: Optional): ... + + +def has_default(arg: Optional = None): ... + + +def multiple_1(arg1: Optional, arg2: Optional = None): ... + + +def multiple_2(arg1: Optional, arg2: Optional = None, arg3: int = None): ... + + +def return_type(arg: Optional = None) -> Optional: ... + + +def has_type_argument(arg: Optional[int] = None): ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF018.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF018.py index f7d4e24c6ea3b..0a69217344812 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF018.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF018.py @@ -1,7 +1,20 @@ # RUF018 assert (x := 0) == 0 assert x, (y := "error") +print(x, y) # OK if z := 0: pass + + +# These should not be flagged, because the only uses of the variables defined +# are themselves within `assert` statements. + +# Here the `t` variable is referenced +# from a later `assert` statement: +assert (t:=cancel((F, G))) == (1, P, Q) +assert isinstance(t, tuple) + +# Here the `g` variable is referenced from within the same `assert` statement: +assert (g:=solve(groebner(eqs, s), dict=True)) == sol, g diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF020.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF020.py index 84203b0cc9040..e737216218e20 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF020.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF020.py @@ -6,3 +6,12 @@ NoReturn | int Union[Union[Never, int], Union[NoReturn, int]] Union[NoReturn, int, float] + + +# Regression tests for https://github.com/astral-sh/ruff/issues/14567 +x: None | Never | None +y: (None | Never) | None +z: None | (Never | None) + +a: int | Never | None +b: Never | Never | None diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_0.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_0.py index 4780348c121bd..e5bef3033f181 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_0.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_0.py @@ -72,3 +72,10 @@ def method_calls(): def format_specifiers(): a = 4 b = "{a:b} {a:^5}" + +# fstrings are never correct as type definitions +# so we should always skip those +def in_type_def(): + from typing import cast + a = 'int' + cast('f"{a}"','11') diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_1.py index 6f3b7cf9afc36..b91ec7b69e8f3 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_1.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF027_1.py @@ -68,3 +68,9 @@ def negative_cases(): @app.get("/items/{item_id}") async def read_item(item_id): return {"item_id": item_id} + + from typing import TYPE_CHECKING + if TYPE_CHECKING: + from datetime import date + + t = "foo/{date}" diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF028.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF028.py index 267bb4b5d87a3..e53962c9ee52e 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF028.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF028.py @@ -87,3 +87,17 @@ def match_case_and_elif(): pass elif string == "Hello": # fmt: skip pass + + +# Regression test for decorators +import pytest + +@pytest.mark.parametrize( + "test_input,expected", + [ + ("3+5", 8 ), + ("17+2", 19), + ], +) # fmt: skip +def test_eval(test_input, expected): + assert eval(test_input) == expected diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF029.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF029.py index 47651079fa321..c65ef354b0289 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF029.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF029.py @@ -80,11 +80,20 @@ async def test() -> str: return ",".join(vals) +# FastApi routes can be async without actually using await + from fastapi import FastAPI app = FastAPI() @app.post("/count") -async def fastapi_route(): # Ok: FastApi routes can be async without actually using await +async def fastapi_route(): return 1 + + +def setup_app(app_arg: FastAPI, non_app: str) -> None: + @app_arg.get("/") + async def get_root() -> str: + return "Hello World!" + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF031.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF031.py index e784125680ffc..9e869b22dbddf 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF031.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF031.py @@ -42,3 +42,7 @@ type Y = typing.Literal[1, 2] Z: typing.TypeAlias = dict[int, int] class Foo(dict[str, int]): pass + +# Skip tuples of length one that are single-starred expressions +# https://github.com/astral-sh/ruff/issues/16077 +d[*x] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF031_prefer_parens.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF031_prefer_parens.py index 0d9afff34828a..3c4231c140881 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF031_prefer_parens.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF031_prefer_parens.py @@ -42,3 +42,7 @@ type Y = typing.Literal[1, 2] Z: typing.TypeAlias = dict[int, int] class Foo(dict[str, int]): pass + +# Skip tuples of length one that are single-starred expressions +# https://github.com/astral-sh/ruff/issues/16077 +d[*x] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.py new file mode 100644 index 0000000000000..00aca49ab66bb --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.py @@ -0,0 +1,47 @@ +from typing import Union as U + + +def func1(arg: None | int): + ... + + +def func2() -> None | int: + ... + + +def func3(arg: None | None | int): + ... + + +def func4(arg: U[None, int]): + ... + + +def func5() -> U[None, int]: + ... + + +def func6(arg: U[None, None, int]): + ... + + +# Ok +def good_func1(arg: int | None): + ... + + +def good_func2() -> int | None: + ... + + +def good_func3(arg: None): + ... + + +def good_func4(arg: U[None]): + ... + + +def good_func5(arg: U[int]): + ... + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.pyi b/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.pyi new file mode 100644 index 0000000000000..f4210325bff49 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF036.pyi @@ -0,0 +1,25 @@ +from typing import Union as U + + +def func1(arg: None | int): ... + +def func2() -> None | int: ... + +def func3(arg: None | None | int): ... + +def func4(arg: U[None, int]): ... + +def func5() -> U[None, int]: ... + +def func6(arg: U[None, None, int]): ... + +# Ok +def good_func1(arg: int | None): ... + +def good_func2() -> int | None: ... + +def good_func3(arg: None): ... + +def good_func4(arg: U[None]): ... + +def good_func5(arg: U[int]): ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF037.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF037.py new file mode 100644 index 0000000000000..949f30691f4fc --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF037.py @@ -0,0 +1,58 @@ +from collections import deque +import collections + + +def f(): + queue = collections.deque([]) # RUF037 + + +def f(): + queue = collections.deque([], maxlen=10) # RUF037 + + +def f(): + queue = deque([]) # RUF037 + + +def f(): + queue = deque(()) # RUF037 + + +def f(): + queue = deque({}) # RUF037 + + +def f(): + queue = deque(set()) # RUF037 + + +def f(): + queue = collections.deque([], maxlen=10) # RUF037 + + +def f(): + class FakeDeque: + pass + + deque = FakeDeque + queue = deque([]) # Ok + + +def f(): + class FakeSet: + pass + + set = FakeSet + queue = deque(set()) # Ok + + +def f(): + queue = deque([1, 2]) # Ok + + +def f(): + queue = deque([1, 2], maxlen=10) # Ok + + +def f(): + queue = deque() # Ok diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.py new file mode 100644 index 0000000000000..2fb56a102e5de --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.py @@ -0,0 +1,33 @@ +from typing import Literal + + +def func1(arg1: Literal[True, False]): + ... + + +def func2(arg1: Literal[True, False, True]): + ... + + +def func3() -> Literal[True, False]: + ... + + +def func4(arg1: Literal[True, False] | bool): + ... + + +def func5(arg1: Literal[False, True]): + ... + + +def func6(arg1: Literal[True, False, "hello", "world"]): + ... + +# ok +def good_func1(arg1: bool): + ... + + +def good_func2(arg1: Literal[True]): + ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.pyi b/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.pyi new file mode 100644 index 0000000000000..b015862431ecf --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF038.pyi @@ -0,0 +1,20 @@ +from typing import Literal + + +def func1(arg1: Literal[True, False]): ... + +def func2(arg1: Literal[True, False, True]): ... + +def func3() -> Literal[True, False]: ... + +def func4(arg1: Literal[True, False] | bool): ... + +def func5(arg1: Literal[False, True]): ... + +def func6(arg1: Literal[True, False, "hello", "world"]): ... + +# ok +def good_func1(arg1: bool): ... + +def good_func2(arg1: Literal[True]): ... + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF039.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF039.py new file mode 100644 index 0000000000000..03bdff03610be --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF039.py @@ -0,0 +1,55 @@ +import re +import regex + +# Errors +re.compile('single free-spacing', flags=re.X) +re.findall('si\ngle') +re.finditer("dou\ble") +re.fullmatch('''t\riple single''') +re.match("""\triple double""") +re.search('two', 'args') +re.split("raw", r'second') +re.sub(u'''nicode''', u"f(?i)rst") +re.subn(b"""ytes are""", f"\u006e") + +regex.compile('single free-spacing', flags=regex.X) +regex.findall('si\ngle') +regex.finditer("dou\ble") +regex.fullmatch('''t\riple single''') +regex.match("""\triple double""") +regex.search('two', 'args') +regex.split("raw", r'second') +regex.sub(u'''nicode''', u"f(?i)rst") +regex.subn(b"""ytes are""", f"\u006e") + +regex.template("""(?m) + (?:ulti)? + (?=(?<!(?<=(?!l))) + l(?i:ne) +""", flags = regex.X) + + +# No errors +re.compile(R'uppercase') +re.findall(not_literal) +re.finditer(0, literal_but_not_string) +re.fullmatch() # no first argument +re.match('string' f'''concatenation''') +re.search(R"raw" r'concatenation') +re.split(rf"multiple", f"""lags""") +re.sub(FR'ee', '''as in free speech''') +re.subn(br"""eak your machine with rm -""", rf"""/""") + +regex.compile(R'uppercase') +regex.findall(not_literal) +regex.finditer(0, literal_but_not_string) +regex.fullmatch() # no first argument +regex.match('string' f'''concatenation''') +regex.search(R"raw" r'concatenation') +regex.split(rf"multiple", f"""lags""") +regex.sub(FR'ee', '''as in free speech''') +regex.subn(br"""eak your machine with rm -""", rf"""/""") + +regex.splititer(both, non_literal) +regex.subf(f, lambda _: r'means', '"format"') +regex.subfn(fn, f'''a$1n't''', lambda: "'function'") diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF039_concat.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF039_concat.py new file mode 100644 index 0000000000000..97c2693831881 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF039_concat.py @@ -0,0 +1,93 @@ +import re + + +re.compile( + 'implicit' + 'concatenation' +) +re.findall( + r''' + multiline + ''' + """ + concatenation + """ +) +re.finditer( + f'(?P<{group}>Dynamic' + r'\s+group' + 'name)' +) +re.fullmatch( + u'n'r'''eadable''' + f'much?' +) +re.match( + b'reak' + br'eak' +) +re.search( + r''u'' + '''okay?''' +) +re.split(''U"""w"""U'') +re.sub( + "I''m o" + 'utta ideas' +) +re.subn("()"r' am I'"??") + + +import regex + + +regex.compile( + 'implicit' + 'concatenation' +) +regex.findall( + r''' + multiline + ''' + """ + concatenation + """ +) +regex.finditer( + f'(?P<{group}>Dynamic' + r'\s+group' + 'name)' +) +regex.fullmatch( + u'n'r'''eadable''' + f'much?' +) +regex.match( + b'reak' + br'eak' +) +regex.search( + r''u'' + '''okay?''' +) +regex.split(''U"""w"""U'') +regex.sub( + "I''m o" + 'utta ideas' +) +regex.subn("()"r' am I'"??") + + +regex.template( + r'''kitty says''' + r""r''r""r'aw'r"" +) +regex.splititer( + r'r+r*r?' +) +regex.subf( + rb"haha" + br"ust go" + br''br""br'' +) +regex.subfn(br'I\s\nee*d\s[O0o]me\x20\Qoffe\E, ' br'b') diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF040.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF040.py new file mode 100644 index 0000000000000..5787f2d14dcbf --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF040.py @@ -0,0 +1,5 @@ +fruits = ["apples", "plums", "pear"] +fruits.filter(lambda fruit: fruit.startwith("p")) +assert len(fruits), 2 + +assert True, "always true" \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.py new file mode 100644 index 0000000000000..f783e566e121a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.py @@ -0,0 +1,31 @@ +from typing import Literal +import typing as t +import typing_extensions + + +y: Literal[1, print("hello"), 3, Literal[4, 1]] +Literal[1, Literal[1]] +Literal[1, 2, Literal[1, 2]] +Literal[1, Literal[1], Literal[1]] +Literal[1, Literal[2], Literal[2]] +t.Literal[1, t.Literal[2, t.Literal[1]]] +Literal[ + 1, # comment 1 + Literal[ # another comment + 1 # yet another comment + ] +] # once + +# Ensure issue is only raised once, even on nested literals +MyType = Literal["foo", Literal[True, False, True], "bar"] + +# nested literals, all equivalent to `Literal[1]` +Literal[Literal[1]] +Literal[Literal[Literal[1], Literal[1]]] +Literal[Literal[1], Literal[Literal[Literal[1]]]] + +# OK +x: Literal[True, False, True, False] +z: Literal[{1, 3, 5}, "foobar", {1,3,5}] +typing_extensions.Literal[1, 1, 1] +n: Literal["No", "duplicates", "here", 1, "1"] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.pyi b/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.pyi new file mode 100644 index 0000000000000..f783e566e121a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF041.pyi @@ -0,0 +1,31 @@ +from typing import Literal +import typing as t +import typing_extensions + + +y: Literal[1, print("hello"), 3, Literal[4, 1]] +Literal[1, Literal[1]] +Literal[1, 2, Literal[1, 2]] +Literal[1, Literal[1], Literal[1]] +Literal[1, Literal[2], Literal[2]] +t.Literal[1, t.Literal[2, t.Literal[1]]] +Literal[ + 1, # comment 1 + Literal[ # another comment + 1 # yet another comment + ] +] # once + +# Ensure issue is only raised once, even on nested literals +MyType = Literal["foo", Literal[True, False, True], "bar"] + +# nested literals, all equivalent to `Literal[1]` +Literal[Literal[1]] +Literal[Literal[Literal[1], Literal[1]]] +Literal[Literal[1], Literal[Literal[Literal[1]]]] + +# OK +x: Literal[True, False, True, False] +z: Literal[{1, 3, 5}, "foobar", {1,3,5}] +typing_extensions.Literal[1, 1, 1] +n: Literal["No", "duplicates", "here", 1, "1"] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF043.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF043.py new file mode 100644 index 0000000000000..457c5f4fabc5a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF043.py @@ -0,0 +1,94 @@ +import re +import pytest + +def test_foo(): + + ### Errors + + with pytest.raises(FooAtTheEnd, match="foo."): ... + with pytest.raises(PackageExtraSpecifier, match="Install `foo[bar]` to enjoy all features"): ... + with pytest.raises(InnocentQuestion, match="Did you mean to use `Literal` instead?"): ... + + with pytest.raises(StringConcatenation, match="Huh" + "?"): ... + with pytest.raises(ManuallyEscapedWindowsPathToDotFile, match="C:\\\\Users\\\\Foo\\\\.config"): ... + + with pytest.raises(MiddleDot, match="foo.bar"): ... + with pytest.raises(EndDot, match="foobar."): ... + with pytest.raises(EscapedFollowedByUnescaped, match="foo\\.*bar"): ... + with pytest.raises(UnescapedFollowedByEscaped, match="foo.\\*bar"): ... + + # https://github.com/astral-sh/ruff/issues/15316 + with pytest.raises(ClosingParenthesis, match="foo)"): ... + + + ## Metasequences + + with pytest.raises(StartOfInput, match="foo\\Abar"): ... + with pytest.raises(WordBoundary, match="foo\\bbar"): ... + with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... + with pytest.raises(Digit, match="foo\\dbar"): ... + with pytest.raises(NonDigit, match="foo\\Dbar"): ... + with pytest.raises(Whitespace, match="foo\\sbar"): ... + with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... + with pytest.raises(WordCharacter, match="foo\\wbar"): ... + with pytest.raises(NonWordCharacter, match="foo\\Wbar"): ... + with pytest.raises(EndOfInput, match="foo\\zbar"): ... + + with pytest.raises(StartOfInput2, match="foobar\\A"): ... + with pytest.raises(WordBoundary2, match="foobar\\b"): ... + with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... + with pytest.raises(Digit2, match="foobar\\d"): ... + with pytest.raises(NonDigit2, match="foobar\\D"): ... + with pytest.raises(Whitespace2, match="foobar\\s"): ... + with pytest.raises(NonWhitespace2, match="foobar\\S"): ... + with pytest.raises(WordCharacter2, match="foobar\\w"): ... + with pytest.raises(NonWordCharacter2, match="foobar\\W"): ... + with pytest.raises(EndOfInput2, match="foobar\\z"): ... + + + ### Acceptable false positives + + with pytest.raises(NameEscape, match="\\N{EN DASH}"): ... + + + ### No errors + + with pytest.raises(NoMatch): ... + with pytest.raises(NonLiteral, match=pattern): ... + with pytest.raises(FunctionCall, match=frobnicate("qux")): ... + with pytest.raises(ReEscaped, match=re.escape("foobar")): ... + with pytest.raises(RawString, match=r"fo()bar"): ... + with pytest.raises(RawStringPart, match=r"foo" '\bar'): ... + with pytest.raises(NoMetacharacters, match="foobar"): ... + with pytest.raises(EndBackslash, match="foobar\\"): ... + + with pytest.raises(ManuallyEscaped, match="some\\.fully\\.qualified\\.name"): ... + with pytest.raises(ManuallyEscapedWindowsPath, match="C:\\\\Users\\\\Foo\\\\file\\.py"): ... + + with pytest.raises(MiddleEscapedDot, match="foo\\.bar"): ... + with pytest.raises(MiddleEscapedBackslash, match="foo\\\\bar"): ... + with pytest.raises(EndEscapedDot, match="foobar\\."): ... + with pytest.raises(EndEscapedBackslash, match="foobar\\\\"): ... + + + ## Not-so-special metasequences + + with pytest.raises(Alert, match="\\f"): ... + with pytest.raises(FormFeed, match="\\f"): ... + with pytest.raises(Newline, match="\\n"): ... + with pytest.raises(CarriageReturn, match="\\r"): ... + with pytest.raises(Tab, match="\\t"): ... + with pytest.raises(VerticalTab, match="\\v"): ... + with pytest.raises(HexEscape, match="\\xFF"): ... + with pytest.raises(_16BitUnicodeEscape, match="\\uFFFF"): ... + with pytest.raises(_32BitUnicodeEscape, match="\\U0010FFFF"): ... + + ## Escaped metasequences + + with pytest.raises(Whitespace, match="foo\\\\sbar"): ... + with pytest.raises(NonWhitespace, match="foo\\\\Sbar"): ... + + ## Work by accident + + with pytest.raises(OctalEscape, match="\\042"): ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF045.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF045.py new file mode 100644 index 0000000000000..fed9c6ba3315d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF045.py @@ -0,0 +1,29 @@ +from dataclasses import InitVar, KW_ONLY, MISSING, dataclass, field +from typing import ClassVar + + +@dataclass +class C: + # Errors + no_annotation = r"foo" + missing = MISSING + field = field() + + # No errors + __slots__ = ("foo", "bar") + __radd__ = __add__ + _private_attr = 100 + + with_annotation: str + with_annotation_and_default: int = 42 + with_annotation_and_field_specifier: bytes = field() + + class_var_no_arguments: ClassVar = 42 + class_var_with_arguments: ClassVar[int] = 42 + + init_var_no_arguments: InitVar = "lorem" + init_var_with_arguments: InitVar[str] = "ipsum" + + kw_only: KW_ONLY + tu, ple, [unp, ack, ing] = (0, 1, 2, [3, 4, 5]) + mul, [ti, ple] = (a, ssign), ment = {1: b"3", "2": 4}, [6j, 5] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF046.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046.py new file mode 100644 index 0000000000000..6fd21d779b8f6 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046.py @@ -0,0 +1,208 @@ +import math + + +inferred_int = 1 +inferred_float = 1. + + +### Safely fixable + +int(id()) +int(len([])) +int(ord(foo)) +int(hash(foo, bar)) +int(int('')) + +int(math.comb()) +int(math.factorial()) +int(math.gcd()) +int(math.lcm()) +int(math.isqrt()) +int(math.perm()) + +int(round(1, 0)) +int(round(1, 10)) + +int(round(1)) +int(round(1, None)) + +int(round(1.)) +int(round(1., None)) + +int(1) +int(v := 1) +int(~1) +int(-1) +int(+1) + +int(1 + 1) +int(1 - 1) +int(1 * 1) +int(1 % 1) +int(1 ** 1) +int(1 << 1) +int(1 >> 1) +int(1 | 1) +int(1 ^ 1) +int(1 & 1) +int(1 // 1) + +int(1 if ... else 2) + +int(1 and 0) +int(0 or -1) + + +if int(1 + 2) * 3: + ... + + +### Unsafe + +int(math.ceil()) +int(math.floor()) +int(math.trunc()) + +int(round(inferred_int, 0)) +int(round(inferred_int, 10)) + +int(round(inferred_int)) +int(round(inferred_int, None)) + +int(round(inferred_float)) +int(round(inferred_float, None)) + +int(round(unknown)) +int(round(unknown, None)) + + +### No errors + +int(round(1, unknown)) +int(round(1., unknown)) + +int(round(1., 0)) +int(round(inferred_float, 0)) + +int(round(inferred_int, unknown)) +int(round(inferred_float, unknown)) + +int(round(unknown, 0)) +int(round(unknown, unknown)) + +int(round(0, 3.14)) +int(round(inferred_int, 3.14)) + +int(round(0, 0), base) +int(round(0, 0, extra=keyword)) + +int(foo if ... else 4) + +int(3.14) +int(2.8j) + +async def f(): + int(await f()) + +int(foo.bar) +int(bar([1][False])) + +int(1 == 1) +int(1 != 1) +int(1 < 1) +int(1 <= 1) +int(1 > 1) +int(1 >= 1) +int(1 in 1) +int(1 not in 1) +int(1 is 1) +int(2 is not 3) +int(foo in 1) +int(foo not in 1) +int(foo is 1) +int(foo is not 1) + +int(1 == 2 == 3) +int(foo == 1) +int(foo != 1) +int(foo < 1) +int(foo <= 1) +int(foo > 1) +int(foo >= 1) + +int(v := {}[{}['']]) + +int(foo + 1) +int(foo - 1) +int(foo * 1) +int(foo @ 1) +int(foo / 1) +int(foo % 1) +int(foo ** 1) +int(foo << 1) +int(foo >> 1) +int(foo | 1) +int(foo ^ 1) +int(foo & 1) +int(foo // 1) + +int(v := 3.7) + +int(not 109) + +int(1 / 1) +int(1 @ 1) + +int(1. if ... else .2) + +int(1 + + 1) + +int(round(1, + 0)) + +# function calls may need to retain parentheses +# if the parentheses for the call itself +# lie on the next line. +# See https://github.com/astral-sh/ruff/issues/15263 +int(round +(1)) + +int(round # a comment +# and another comment +(10) +) + +int(round (17)) # this is safe without parens + +int( round ( + 17 + )) # this is also safe without parens + +int((round) # Comment +(42) +) + +int((round # Comment +)(42) +) + +int( # Unsafe fix because of this comment +( # Comment + (round +) # Comment +)(42) +) + +int( + round( + 42 + ) # unsafe fix because of this comment +) + +int( + round( + 42 + ) +# unsafe fix because of this comment +) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_CR.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_CR.py new file mode 100644 index 0000000000000..9723c347dcf0c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_CR.py @@ -0,0 +1 @@ +int(- 1) # Carriage return as newline \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_LF.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_LF.py new file mode 100644 index 0000000000000..53a879a56e714 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF046_LF.py @@ -0,0 +1,3 @@ +# \n as newline +int(- + 1) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_for.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_for.py new file mode 100644 index 0000000000000..9710fefd99e2d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_for.py @@ -0,0 +1,49 @@ +### Errors + +for _ in range(0): + loop_body_is_not_checked() + break +else: + pass + + +for this in comment: + belongs_to() # `for` +else: + ... + + +for of in course(): + this() +else: + ... +# this comment does not belong to the else + + +### No errors + +for this in second_comment: + belongs() # to +# `else` +else: + pass + + +for _and in so: + does() +# this +else: + pass + + +for of in course(): + this() +else: + ... # too + + +for of in course(): + this() +else: + ... + # too diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_if.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_if.py new file mode 100644 index 0000000000000..7b0a1ba275b5a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_if.py @@ -0,0 +1,84 @@ +### Errors + +if False: + condition_is_not_evaluated() +else: + pass + + +if this_comment(): + belongs_to() # `if` +else: + ... + + +if elif_is(): + treated() +elif the_same(): + as_if() +else: + pass + + +if this_second_comment(): + belongs() # to + # `if` +else: + pass + +if this_second_comment(): + belongs() # to + # `if` +else: + pass + + +if of_course(): + this() +else: + ... +# this comment doesn't belong to the if + + +if of_course: this() +else: ... + + +if of_course: + this() # comment +else: ... + + +def nested(): + if a: + b() + else: + ... + + +### No errors + + +if this_second_comment(): + belongs() # to +# `else` +else: + pass + + +if of_course(): + this() +else: + ... # too + + +if of_course(): + this() +else: + ... + # comment + + +if of_course: + this() # comment +else: ... # trailing diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_try.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_try.py new file mode 100644 index 0000000000000..d0b1e40cad6e4 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_try.py @@ -0,0 +1,76 @@ +### Errors + +try: + raise try_body_is_not_checked() +except: + pass +else: + pass + + +try: + this() +except comment: + belongs() +except: + to() # `except` +else: + ... + + +try: + of_course() +except: + this() +else: + ... +# This comment belongs to finally +finally: + pass + + +try: + of_course() +except: + this() +else: + ... +# This comment belongs to the statement coming after the else + + +### No errors + +try: + this() +except (second, comment): + belongs() # to +# `else` +else: + pass + + +try: + and_so() +except: + does() +# this +else: + ... + + +try: + of_course() +except: + this() +else: + ... # too + +try: + of_course() +except: + this() +else: + ... + # This comment belongs to else +finally: + pass diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_while.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_while.py new file mode 100644 index 0000000000000..2b106a00cc236 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF047_while.py @@ -0,0 +1,49 @@ +### No errors + +while True: + loop_body_is_not_checked() + break +else: + pass + + +while this_comment: + belongs_to() # `for` +else: + ... + + +while of_course(): + this() +else: + ... +# this comment belongs to the statement coming after the else + + +### No errors + +while this_second_comment: + belongs() # to +# `else` +else: + pass + + +while and_so: + does() +# this +else: + ... + + +while of_course(): + this() +else: + ... # too + +while of_course(): + this() +else: + ... + # this comment belongs to the else + diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF048.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF048.py new file mode 100644 index 0000000000000..59cd1f3b00beb --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF048.py @@ -0,0 +1,17 @@ +__version__ = (0, 1, 0) + + +tuple(map(int, __version__.split("."))) +list(map(int, __version__.split("."))) + +# `sep` passed as keyword argument +for part in map(int, __version__.split(sep=".")): + print(part) + +# Comma +tuple(map(int, __version__.split(","))) +list(map(int, __version__.split(","))) + +# Multiple arguments +tuple(map(int, __version__.split(".", 1))) +list(map(int, __version__.split(".", maxsplit=2))) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF048_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF048_1.py new file mode 100644 index 0000000000000..8ba9457ae91cb --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF048_1.py @@ -0,0 +1,27 @@ +from foo import __version__ +import bar + + +tuple(map(int, __version__.split("."))) +list(map(int, __version__.split("."))) +tuple(map(int, bar.__version__.split("."))) +list(map(int, bar.__version__.split("."))) + +# `sep` passed as keyword argument +for part in map(int, bar.__version__.split(sep=".")): + print(part) + +for part in map(int, __version__.split(sep=".")): + print(part) + +# Comma +tuple(map(int, __version__.split(","))) +list(map(int, __version__.split(","))) +tuple(map(int, bar.__version__.split(","))) +list(map(int, bar.__version__.split(","))) + +# Multiple arguments +tuple(map(int, __version__.split(",", 1))) +list(map(int, __version__.split(",", maxsplit = 2))) +tuple(map(int, bar.__version__.split(",", 1))) +list(map(int, bar.__version__.split(",", maxsplit = 2))) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF049.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF049.py new file mode 100644 index 0000000000000..603d60795d7a9 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF049.py @@ -0,0 +1,59 @@ +from dataclasses import dataclass +from enum import Enum, Flag, IntEnum, IntFlag, StrEnum, ReprEnum + +import attr +import attrs + + +## Errors + +@dataclass +class E(Enum): ... + + +@dataclass # Foobar +class E(Flag): ... + + +@dataclass() +class E(IntEnum): ... + + +@dataclass() # Foobar +class E(IntFlag): ... + + +@dataclass( + frozen=True +) +class E(StrEnum): ... + + +@dataclass( # Foobar + frozen=True +) +class E(ReprEnum): ... + + +@dataclass( + frozen=True +) # Foobar +class E(Enum): ... + + +## No errors + +@attrs.define +class E(Enum): ... + + +@attrs.frozen +class E(Enum): ... + + +@attrs.mutable +class E(Enum): ... + + +@attr.s +class E(Enum): ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF051.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF051.py new file mode 100644 index 0000000000000..7233bef5b5201 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF051.py @@ -0,0 +1,130 @@ +d = {} +l = [] + + +### Errors + +if k in d: # Bare name + del d[k] + +if '' in d: # String + del d[""] # Different quotes + +if b"" in d: # Bytes + del d[ # Multiline slice + b'''''' # Triple quotes + ] + +if 0 in d: del d[0] # Single-line statement + +if 3j in d: # Complex + del d[3j] + +if 0.1234 in d: # Float + del d[.1_2_3_4] # Number separators and shorthand syntax + +if True in d: # True + del d[True] + +if False in d: # False + del d[False] + +if None in d: # None + del d[ + # Comment in the middle + None + ] + +if ... in d: # Ellipsis + del d[ + # Comment in the middle, indented + ...] + +if "a" "bc" in d: # String concatenation + del d['abc'] + +if r"\foo" in d: # Raw string + del d['\\foo'] + +if b'yt' b'es' in d: # Bytes concatenation + del d[rb"""ytes"""] # Raw bytes + +if k in d: + # comment that gets dropped + del d[k] + +### Safely fixable + +if k in d: + del d[k] + +if '' in d: + del d[""] + +if b"" in d: + del d[ + b'''''' + ] + +if 0 in d: del d[0] + +if 3j in d: + del d[3j] + +if 0.1234 in d: + del d[.1_2_3_4] + +if True in d: + del d[True] + +if False in d: + del d[False] + +if None in d: + del d[ + None + ] + +if ... in d: + del d[ + ...] + +if "a" "bc" in d: + del d['abc'] + +if r"\foo" in d: + del d['\\foo'] + +if b'yt' b'es' in d: + del d[rb"""ytes"""] # This should not make the fix unsafe + + + +### No errors + +if k in l: # Not a dict + del l[k] + +if d.__contains__(k): # Explicit dunder call + del d[k] + +if a.k in d: # Attribute + del d[a.k] + +if (a, b) in d: # Tuple + del d[a, b] + +if 2 in d: # Different key value (int) + del d[3] + +if 2_4j in d: # Different key value (complex) + del d[3.6] # Different key value (float) + +if 0.1 + 0.2 in d: # Complex expression + del d[0.3] + +if f"0" in d: # f-string + del d[f"0"] + +if k in a.d: # Attribute dict + del a.d[k] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF052.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF052.py new file mode 100644 index 0000000000000..ecde5afa896fd --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF052.py @@ -0,0 +1,197 @@ +############## +# Correct +############## + +for _ in range(5): + pass + +_valid_type = int + +_valid_var_1: _valid_type + +_valid_var_1 = 1 + +_valid_var_2 = 2 + +_valid_var_3 = _valid_var_1 + _valid_var_2 + +def _valid_fun(): + pass + +_valid_fun() + +def fun(arg): + _valid_unused_var = arg + pass + +_x = "global" + +def fun(): + global _x + return _x + +def fun(): + __dunder__ = "dunder variable" + return __dunder__ + +def fun(): + global _x + _x = "reassigned global" + return _x + +# (we had a false positive when a global var is used like this in 2 functions) +_num: int + +def set_num(): + global _num + _num = 1 + +def print_num(): + print(_num) + + +class _ValidClass: + pass + +_ValidClass() + +class ClassOk: + _valid_private_cls_attr = 1 + + print(_valid_private_cls_attr) + + def __init__(self): + self._valid_private_ins_attr = 2 + print(self._valid_private_ins_attr) + + def _valid_method(self): + return self._valid_private_ins_attr + + def method(arg): + _valid_unused_var = arg + return + +def fun(x): + _ = 1 + __ = 2 + ___ = 3 + if x == 1: + return _ + if x == 2: + return __ + if x == 3: + return ___ + return x + +########### +# Incorrect +########### + +class Class_: + def fun(self): + _var = "method variable" # [RUF052] + return _var + +def fun(_var): # parameters are ignored + return _var + +def fun(): + _list = "built-in" # [RUF052] + return _list + +x = "global" + +def fun(): + global x + _x = "shadows global" # [RUF052] + return _x + +def foo(): + x = "outer" + def bar(): + nonlocal x + _x = "shadows nonlocal" # [RUF052] + return _x + bar() + return x + +def fun(): + x = "local" + _x = "shadows local" # [RUF052] + return _x + + +GLOBAL_1 = "global 1" +GLOBAL_1_ = "global 1 with trailing underscore" + +def unfixables(): + _GLOBAL_1 = "foo" + # unfixable because the rename would shadow a global variable + print(_GLOBAL_1) # [RUF052] + + local = "local" + local_ = "local2" + + # unfixable because the rename would shadow a local variable + _local = "local3" # [RUF052] + print(_local) + + def nested(): + _GLOBAL_1 = "foo" + # unfixable because the rename would shadow a global variable + print(_GLOBAL_1) # [RUF052] + + # unfixable because the rename would shadow a variable from the outer function + _local = "local4" + print(_local) + +def special_calls(): + from typing import TypeVar, ParamSpec, NamedTuple + from enum import Enum + from collections import namedtuple + + _P = ParamSpec("_P") + _T = TypeVar(name="_T", covariant=True, bound=int|str) + _NT = NamedTuple("_NT", [("foo", int)]) + _E = Enum("_E", ["a", "b", "c"]) + _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + _DynamicClass = type("_DynamicClass", (), {}) + _NotADynamicClass = type("_NotADynamicClass") + + print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + +# Do not emit diagnostic if parameter is private +# even if it is later shadowed in the body of the function +# see https://github.com/astral-sh/ruff/issues/14968 +class Node: + + connected: list[Node] + + def recurse(self, *, _seen: set[Node] | None = None): + if _seen is None: + _seen = set() + elif self in _seen: + return + _seen.add(self) + for other in self.connected: + other.recurse(_seen=_seen) + + +def foo(): + _dummy_var = 42 + + def bar(): + dummy_var = 43 + print(_dummy_var) + + +def foo(): + # Unfixable because both possible candidates for the new name are shadowed + # in the scope of one of the references to the variable + _dummy_var = 42 + + def bar(): + dummy_var = 43 + dummy_var_ = 44 + print(_dummy_var) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF053.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF053.py new file mode 100644 index 0000000000000..06b46a8b8a3f3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF053.py @@ -0,0 +1,109 @@ +from typing import Generic, ParamSpec, TypeVar, TypeVarTuple, Unpack + + +_A = TypeVar('_A') +_B = TypeVar('_B', bound=int) +_C = TypeVar('_C', str, bytes) +_D = TypeVar('_D', default=int) +_E = TypeVar('_E', bound=int, default=int) +_F = TypeVar('_F', str, bytes, default=str) +_G = TypeVar('_G', str, a := int) + +_As = TypeVarTuple('_As') +_Bs = TypeVarTuple('_Bs', bound=tuple[int, str]) +_Cs = TypeVarTuple('_Cs', default=tuple[int, str]) + +_P1 = ParamSpec('_P1') +_P2 = ParamSpec('_P2', bound=[bytes, bool]) +_P3 = ParamSpec('_P3', default=[int, str]) + + +### Errors + +class C[T](Generic[_A]): ... +class C[T](Generic[_B], str): ... +class C[T](int, Generic[_C]): ... +class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults +class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults + +class C[*Ts](Generic[*_As]): ... +class C[*Ts](Generic[Unpack[_As]]): ... +class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... +class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults + + +class C[**P](Generic[_P1]): ... +class C[**P](Generic[_P2]): ... +class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults + + +class C[T](Generic[T, _A]): ... + + +# See `is_existing_param_of_same_class`. +# `expr_name_to_type_var` doesn't handle named expressions, +# only simple assignments, so there is no fix. +class C[T: (_Z := TypeVar('_Z'))](Generic[_Z]): ... + + +class C(Generic[_B]): + class D[T](Generic[_B, T]): ... + + +class C[T]: + class D[U](Generic[T, U]): ... + + +# In a single run, only the first is reported. +# Others will be reported/fixed in following iterations. +class C[T](Generic[_C], Generic[_D]): ... +class C[T, _C: (str, bytes)](Generic[_D]): ... # TODO: Type parameter defaults + + +class C[ +T # Comment +](Generic[_E]): ... # TODO: Type parameter defaults + + +class C[T](Generic[Generic[_F]]): ... +class C[T](Generic[Unpack[_A]]): ... +class C[T](Generic[Unpack[_P1]]): ... +class C[T](Generic[Unpack[Unpack[_P2]]]): ... +class C[T](Generic[Unpack[*_As]]): ... +class C[T](Generic[Unpack[_As, _Bs]]): ... + + +class C[T](Generic[_A, _A]): ... +class C[T](Generic[_A, Unpack[_As]]): ... +class C[T](Generic[*_As, _A]): ... + + +from somewhere import APublicTypeVar +class C[T](Generic[APublicTypeVar]): ... +class C[T](Generic[APublicTypeVar, _A]): ... + + +# `_G` has two constraints: `str` and `a := int`. +# The latter cannot be used as a PEP 695 constraint, +# as named expressions are forbidden within type parameter lists. +# See also the `_Z` example above. +class C[T](Generic[_G]): ... # Should be moved down below eventually + + +# Single-element constraints should not be converted to a bound. +class C[T: (str,)](Generic[_A]): ... +class C[T: [a]](Generic[_A]): ... + + +# Existing bounds should not be deparenthesized. +# class C[T: (_Y := int)](Generic[_A]): ... # TODO: Uncomment this +# class C[T: (*a,)](Generic[_A]): ... # TODO: Uncomment this + + +### No errors + +class C(Generic[_A]): ... +class C[_A]: ... +class C[_A](list[_A]): ... +class C[_A](list[Generic[_A]]): ... diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF054.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF054.py new file mode 100644 index 0000000000000..90d332110d110 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF054.py @@ -0,0 +1,32 @@ +############# Warning ############ +# This file contains form feeds. # +############# Warning ############ + + +# Errors + + + + + +def _(): + pass + +if False: + print('F') + print('T') + + +# No errors + + + + + + + +def _(): + pass + +def f(): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_0.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_0.py new file mode 100644 index 0000000000000..608ea2ef22862 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_0.py @@ -0,0 +1,100 @@ +import re + +s = "str" + +# this should be replaced with `s.replace("abc", "")` +re.sub("abc", "", s) + + +# this example, adapted from https://docs.python.org/3/library/re.html#re.sub, +# should *not* be replaced because repl is a function, not a string +def dashrepl(matchobj): + if matchobj.group(0) == "-": + return " " + else: + return "-" + + +re.sub("-", dashrepl, "pro----gram-files") + +# this one should be replaced with `s.startswith("abc")` because the Match is +# used in an if context for its truth value +if re.match("abc", s): + pass +if m := re.match("abc", s): # this should *not* be replaced + pass +re.match("abc", s) # this should not be replaced because match returns a Match + +# this should be replaced with `"abc" in s` +if re.search("abc", s): + pass +re.search("abc", s) # this should not be replaced + +# this should be replaced with `"abc" == s` +if re.fullmatch("abc", s): + pass +re.fullmatch("abc", s) # this should not be replaced + +# this should be replaced with `s.split("abc")` +re.split("abc", s) + +# these currently should not be modified because the patterns contain regex +# metacharacters +re.sub("ab[c]", "", s) +re.match("ab[c]", s) +re.search("ab[c]", s) +re.fullmatch("ab[c]", s) +re.split("ab[c]", s) + +# test that all of the metacharacters prevent the rule from triggering, also +# use raw strings in line with RUF039 +re.sub(r"abc.", "", s) +re.sub(r"^abc", "", s) +re.sub(r"abc$", "", s) +re.sub(r"abc*", "", s) +re.sub(r"abc+", "", s) +re.sub(r"abc?", "", s) +re.sub(r"abc{2,3}", "", s) +re.sub(r"abc\n", "", s) # this one could be fixed but is not currently +re.sub(r"abc|def", "", s) +re.sub(r"(a)bc", "", s) +re.sub(r"a)bc", "", s) # https://github.com/astral-sh/ruff/issues/15316 + +# and these should not be modified because they have extra arguments +re.sub("abc", "", s, flags=re.A) +re.match("abc", s, flags=re.I) +re.search("abc", s, flags=re.L) +re.fullmatch("abc", s, flags=re.M) +re.split("abc", s, maxsplit=2) + +# this should trigger an unsafe fix because of the presence of comments +re.sub( + # pattern + "abc", + # repl + "", + s, # string +) + +# A diagnostic should not be emitted for `sub` replacements with backreferences or +# most other ASCII escapes +re.sub(r"a", r"\g<0>\g<0>\g<0>", "a") +re.sub(r"a", r"\1", "a") +re.sub(r"a", r"\s", "a") + +# Escapes like \n are "processed": +# `re.sub(r"a", r"\n", some_string)` is fixed to `some_string.replace("a", "\n")` +# *not* `some_string.replace("a", "\\n")`. +# We currently emit diagnostics for some of these without fixing them. +re.sub(r"a", "\n", "a") +re.sub(r"a", r"\n", "a") +re.sub(r"a", "\a", "a") +re.sub(r"a", r"\a", "a") + +re.sub(r"a", "\?", "a") +re.sub(r"a", r"\?", "a") + +# these double as tests for preserving raw string quoting style +re.sub(r'abc', "", s) +re.sub(r"""abc""", "", s) +re.sub(r'''abc''', "", s) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_1.py new file mode 100644 index 0000000000000..89e177d48098e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_1.py @@ -0,0 +1,17 @@ +"""Test that RUF055 can follow a single str assignment for both the pattern and +the replacement argument to re.sub +""" + +import re + +pat1 = "needle" + +re.sub(pat1, "", haystack) + +# aliases are not followed, so this one should not trigger the rule +if pat4 := pat1: + re.sub(pat4, "", haystack) + +# also works for the `repl` argument in sub +repl = "new" +re.sub(r"abc", repl, haystack) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_2.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_2.py new file mode 100644 index 0000000000000..8b1a2d5784081 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF055_2.py @@ -0,0 +1,52 @@ +"""Patterns that don't just involve the call, but rather the parent expression""" +import re + +s = "str" + +# this should be replaced with `"abc" not in s` +re.search("abc", s) is None + + +# this should be replaced with `"abc" in s` +re.search("abc", s) is not None + + +# this should be replaced with `not s.startswith("abc")` +re.match("abc", s) is None + + +# this should be replaced with `s.startswith("abc")` +re.match("abc", s) is not None + + +# this should be replaced with `s != "abc"` +re.fullmatch("abc", s) is None + + +# this should be replaced with `s == "abc"` +re.fullmatch("abc", s) is not None + + +# this should trigger an unsafe fix because of the presence of a comment within the +# expression being replaced (which we'd lose) +if ( + re.fullmatch( + "a really really really really long string", + s, + ) + # with a comment here + is None +): + pass + + +# this should trigger a safe fix (comments are preserved given they're outside the +# expression) +if ( # leading + re.fullmatch( + "a really really really really long string", + s, + ) + is None # trailing +): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF056.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF056.py new file mode 100644 index 0000000000000..831ec4bcead15 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF056.py @@ -0,0 +1,171 @@ +# Correct + +my_dict = {"key": "value", "other_key": "other_value"} + +# Using dict.get without a fallback +value = my_dict.get("key") + +# Using dict.get with a truthy fallback +value = my_dict.get("key", "default") +value = my_dict.get("key", 42) +value = my_dict.get("key", [1, 2, 3]) +value = my_dict.get("key", {"nested": "dict"}) +value = my_dict.get("key", set([1, 2])) +value = my_dict.get("key", True) +value = my_dict.get("key", "Non-empty string") +value = my_dict.get("key", 3.14) +value = my_dict.get("key", (1, 2)) # Tuples are truthy + +# Chained get calls with truthy fallbacks +value1 = my_dict.get("key1", {'k': 'v'}).get("subkey") +value2 = my_dict.get("key2", [1, 2, 3]).append(4) + +# Valid + +# Using dict.get with a falsy fallback: False +value = my_dict.get("key", False) + +# Using dict.get with a falsy fallback: empty string +value = my_dict.get("key", "") + +# Using dict.get with a falsy fallback: empty list +value = my_dict.get("key", []) + +# Using dict.get with a falsy fallback: empty dict +value = my_dict.get("key", {}) + +# Using dict.get with a falsy fallback: empty set +value = my_dict.get("key", set()) + +# Using dict.get with a falsy fallback: zero integer +value = my_dict.get("key", 0) + +# Using dict.get with a falsy fallback: zero float +value = my_dict.get("key", 0.0) + +# Using dict.get with a falsy fallback: None +value = my_dict.get("key", None) + +# Using dict.get with a falsy fallback via function call +value = my_dict.get("key", list()) +value = my_dict.get("key", dict()) +value = my_dict.get("key", set()) + +# Reassigning with falsy fallback +def get_value(d): + return d.get("key", False) + +# Multiple dict.get calls with mixed fallbacks +value1 = my_dict.get("key1", "default") +value2 = my_dict.get("key2", 0) +value3 = my_dict.get("key3", "another default") + +# Using dict.get in a class with falsy fallback +class MyClass: + def method(self): + return self.data.get("key", {}) + +# Using dict.get in a nested function with falsy fallback +def outer(): + def inner(): + return my_dict.get("key", "") + return inner() + +# Using dict.get with variable fallback that is falsy +falsy_value = None +value = my_dict.get("key", falsy_value) + +# Using dict.get with variable fallback that is truthy +truthy_value = "exists" +value = my_dict.get("key", truthy_value) + +# Using dict.get with complex expressions as fallback +value = my_dict.get("key", 0 or "default") +value = my_dict.get("key", [] if condition else {}) + +# testing dict.get call using kwargs +value = my_dict.get(key="key", default=False) +value = my_dict.get(default=[], key="key") + + +# Edge Cases + +dicts = [my_dict, my_dict, my_dict] + +# Falsy fallback in a lambda +get_fallback = lambda d: d.get("key", False) + +# Falsy fallback in a list comprehension +results = [d.get("key", "") for d in dicts] + +# Falsy fallback in a generator expression +results = (d.get("key", None) for d in dicts) + +# Falsy fallback in a ternary expression +value = my_dict.get("key", 0) if True else "default" + + +# Falsy fallback with inline comment +value = my_dict.get("key", # comment1 + [] # comment2 + ) # comment3 + +# Invalid +# Invalid falsy fallbacks are when the call to dict.get is used in a boolean context + +# dict.get in ternary expression +value = "not found" if my_dict.get("key", False) else "default" # [RUF056] + +# dict.get in an if statement +if my_dict.get("key", False): # [RUF056] + pass + +# dict.get in compound if statement +if True and my_dict.get("key", False): # [RUF056] + pass + +if my_dict.get("key", False) or True: # [RUF056] + pass + +# dict.get in an assert statement +assert my_dict.get("key", False) # [RUF056] + +# dict.get in a while statement +while my_dict.get("key", False): # [RUF056] + pass + +# dict.get in unary not expression +value = not my_dict.get("key", False) # [RUF056] + +# testing all falsy fallbacks +value = not my_dict.get("key", False) # [RUF056] +value = not my_dict.get("key", []) # [RUF056] +value = not my_dict.get("key", list()) # [RUF056] +value = not my_dict.get("key", {}) # [RUF056] +value = not my_dict.get("key", dict()) # [RUF056] +value = not my_dict.get("key", set()) # [RUF056] +value = not my_dict.get("key", None) # [RUF056] +value = not my_dict.get("key", 0) # [RUF056] +value = not my_dict.get("key", 0.0) # [RUF056] +value = not my_dict.get("key", "") # [RUF056] + +# testing dict.get call using kwargs +value = not my_dict.get(key="key", default=False) # [RUF056] +value = not my_dict.get(default=[], key="key") # [RUF056] + +# testing invalid dict.get call with inline comment +value = not my_dict.get("key", # comment1 + [] # comment2 + ) # [RUF056] + +# testing invalid dict.get call with kwargs and inline comment +value = not my_dict.get(key="key", # comment1 + default=False # comment2 + ) # [RUF056] +value = not my_dict.get(default=[], # comment1 + key="key" # comment2 + ) # [RUF056] + +# testing invalid dict.get calls +value = not my_dict.get(key="key", other="something", default=False) +value = not my_dict.get(default=False, other="something", key="test") \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF057.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF057.py new file mode 100644 index 0000000000000..2db91ac3226ad --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF057.py @@ -0,0 +1,83 @@ +inferred_int = 1 +inferred_float = 1. + + + +round(42) # Error (safe) +round(42, None) # Error (safe) +round(42, 2) # Error (safe) +round(42, -2) # No error +round(42, inferred_int) # No error +round(42, 3 + 4) # No error +round(42, foo) # No error + + +round(42.) # No error +round(42., None) # No error +round(42., 2) # No error +round(42., -2) # No error +round(42., inferred_int) # No error +round(42., 3 + 4) # No error +round(42., foo) # No error + + +round(4 + 2) # Error (safe) +round(4 + 2, None) # Error (safe) +round(4 + 2, 2) # Error (safe) +round(4 + 2, -2) # No error +round(4 + 2, inferred_int) # No error +round(4 + 2, 3 + 4) # No error +round(4 + 2, foo) # No error + + +round(4. + 2.) # No error +round(4. + 2., None) # No error +round(4. + 2., 2) # No error +round(4. + 2., -2) # No error +round(4. + 2., inferred_int) # No error +round(4. + 2., 3 + 4) # No error +round(4. + 2., foo) # No error + + +round(inferred_int) # Error (unsafe) +round(inferred_int, None) # Error (unsafe) +round(inferred_int, 2) # Error (unsafe) +round(inferred_int, -2) # No error +round(inferred_int, inferred_int) # No error +round(inferred_int, 3 + 4) # No error +round(inferred_int, foo) # No error + + +round(inferred_float) # No error +round(inferred_float, None) # No error +round(inferred_float, 2) # No error +round(inferred_float, -2) # No error +round(inferred_float, inferred_int) # No error +round(inferred_float, 3 + 4) # No error +round(inferred_float, foo) # No error + + +round(lorem) # No error +round(lorem, None) # No error +round(lorem, 2) # No error +round(lorem, -2) # No error +round(lorem, inferred_int) # No error +round(lorem, 3 + 4) # No error +round(lorem, foo) # No error + +# Fixes should preserve parentheses when argument +# contains newline. +# See https://github.com/astral-sh/ruff/issues/15598 +round(- +1) +round(1 +*1 +) + +# fix should be unsafe if comment is in call range +round(# a comment +17 +) +round( + 17 # a comment +) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_0.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_0.py new file mode 100644 index 0000000000000..77d90e6cbc2cb --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_0.py @@ -0,0 +1,77 @@ +from itertools import starmap +import itertools + + +# Errors + +starmap(func, zip()) +starmap(func, zip([])) + + +starmap(func, zip(a, b, c,),) + + +starmap( + func, # Foo + zip( + # Foo + + ) +) + +( # Foo + itertools + ) . starmap ( + + func, zip ( + a, b, c, + ), +) + +( # Foobar + ( starmap ) + # Bazqux +) \ +(func, + ( ( + ( # Zip + ( + ( zip + # Zip + ) + ) + ) + (a, # A + b, # B + c, # C + ) ) + ), +) + +starmap( + func \ + , \ + zip \ + ( + a,\ + b,\ + c,\ + ) +) + + +# No errors + +starmap(func) +starmap(func, zip(a, b, c, **kwargs)) +starmap(func, zip(a, b, c), foo) +starmap(func, zip(a, b, c, lorem=ipsum)) +starmap(func, zip(a, b, c), lorem=ipsum) + +starmap(func, zip(a, b, c, strict=True)) +starmap(func, zip(a, b, c, strict=False)) +starmap(func, zip(a, b, c, strict=strict)) + +# https://github.com/astral-sh/ruff/issues/15742 +starmap(func, zip(*a)) +starmap(func, zip(*a, *b)) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_1.py new file mode 100644 index 0000000000000..00cb2bf182cf2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF058_1.py @@ -0,0 +1,11 @@ +"""Regression test for https://github.com/astral-sh/ruff/issues/15786. This +should be separate from other tests because it shadows the `map` builtin. + +This should still get a diagnostic but not a fix that would lead to an error. +""" + +from itertools import starmap + +map = {} +for _ in starmap(print, zip("A", "12")): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_0.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_0.py new file mode 100644 index 0000000000000..558060bc0f14a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_0.py @@ -0,0 +1,96 @@ +try: + 1 / 0 +except ValueError as e: + pass + + +try: + 1 / 0 +except ValueError as e: + print(e) + + +def f(): + x = 1 + y = 2 + z = x + y + + +def f(): + foo = (1, 2) + (a, b) = (1, 2) + + bar = (1, 2) + (c, d) = bar + + (x, y) = baz = bar + + +def f(): + locals() + x = 1 + + +def f(): + _ = 1 + __ = 1 + _discarded = 1 + + +a = 1 + + +def f(): + global a + + # Used in `c` via `nonlocal`. + b = 1 + + def c(): + # F841 + b = 1 + + def d(): + nonlocal b + + +def f(): + annotations = [] + assert len([annotations for annotations in annotations]) + + +def f(): + def connect(): + return None, None + + with connect() as (connection, cursor): + cursor.execute("SELECT * FROM users") + + +def f(): + def connect(): + return None, None + + with connect() as (connection, cursor): + cursor.execute("SELECT * FROM users") + + +def f(): + with open("file") as my_file, open("") as ((this, that)): + print("hello") + + +def f(): + with ( + open("file") as my_file, + open("") as ((this, that)), + ): + print("hello") + + +def f(): + exponential, base_multiplier = 1, 2 + hash_map = { + (exponential := (exponential * base_multiplier) % 3): i + 1 for i in range(2) + } + return hash_map diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_1.py new file mode 100644 index 0000000000000..85a60f1ce0074 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_1.py @@ -0,0 +1,24 @@ +def f(tup): + x, y = tup + + +def f(): + x, y = 1, 2 # this triggers RUF059 as it's just a simple assignment where unpacking isn't needed + + +def f(): + (x, y) = coords = 1, 2 + if x > 1: + print(coords) + + +def f(): + (x, y) = coords = 1, 2 + + +def f(): + coords = (x, y) = 1, 2 + + +def f(): + (a, b) = (x, y) = 1, 2 # this triggers RUF059 on everything diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_2.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_2.py new file mode 100644 index 0000000000000..730412c3f010c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_2.py @@ -0,0 +1,31 @@ +"""Test case for fixing RUF059 violations.""" + + +def f(): + with foo() as x1: + pass + + with foo() as (x2, y2): + pass + + with (foo() as x3, foo() as y3, foo() as z3): + pass + + +def f(): + (x1, y1) = (1, 2) + (x2, y2) = coords2 = (1, 2) + coords3 = (x3, y3) = (1, 2) + + +def f(): + with Nested(m) as (x, y): + pass + + +def f(): + toplevel = (a, b) = lexer.get_token() + + +def f(): + (a, b) = toplevel = lexer.get_token() diff --git a/crates/ruff_linter/resources/test/fixtures/pyflakes/F841_4.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF059_3.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/pyflakes/F841_4.py rename to crates/ruff_linter/resources/test/fixtures/ruff/RUF059_3.py diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF060.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF060.py new file mode 100644 index 0000000000000..c3b96c6b7be52 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF060.py @@ -0,0 +1,44 @@ +# Errors +1 in [] +1 not in [] +2 in list() +2 not in list() +_ in () +_ not in () +'x' in tuple() +'y' not in tuple() +'a' in set() +'a' not in set() +'b' in {} +'b' not in {} +1 in dict() +2 not in dict() +"a" in "" +b'c' in b"" +"b" in f"" +b"a" in bytearray() +b"a" in bytes() +1 in frozenset() +1 in set(set()) +2 in frozenset([]) +'' in set("") + +# OK +1 in [2] +1 in [1, 2, 3] +_ in ('a') +_ not in ('a') +'a' in set('a', 'b') +'a' not in set('b', 'c') +'b' in {1: 2} +'b' not in {3: 4} +"a" in "x" +b'c' in b"x" +"b" in f"x" +b"a" in bytearray([2]) +b"a" in bytes("a", "utf-8") +1 in frozenset("c") +1 in set(set((1,2))) +1 in set(set([1])) +'' in {""} +frozenset() in {frozenset()} diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_3.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_3.py index 17e6367ad0592..2269552c3be14 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_3.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_3.py @@ -23,6 +23,9 @@ print(a) # noqa: E501, F821 # comment print(a) # noqa: E501, F821 comment print(a) # noqa: E501, F821 comment +print(a) # noqa: E501,,F821 comment +print(a) # noqa: E501, ,F821 comment +print(a) # noqa: E501 F821 comment print(a) # comment with unicode µ # noqa: E501 print(a) # comment with unicode µ # noqa: E501, F821 diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_6.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_6.py new file mode 100644 index 0000000000000..5dbfdb2620248 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_6.py @@ -0,0 +1 @@ +# ruff: noqa: F841 -- intentional unused file directive; will be removed diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_7.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_7.py new file mode 100644 index 0000000000000..a8e7b2a0674d3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF100_7.py @@ -0,0 +1,8 @@ +# flake8: noqa: F841, E501 -- used followed by unused code +# ruff: noqa: E701, F541 -- unused followed by used code + + +def a(): + # Violating noqa'd F841 (unused) and F541 (no-placeholder f-string) + x = f"Hello, world" + return 6 diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF101.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF101_0.py similarity index 100% rename from crates/ruff_linter/resources/test/fixtures/ruff/RUF101.py rename to crates/ruff_linter/resources/test/fixtures/ruff/RUF101_0.py diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF101_1.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF101_1.py new file mode 100644 index 0000000000000..7d620f9c6e8a2 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF101_1.py @@ -0,0 +1,13 @@ +"""Regression test for #14531. + +RUF101 should trigger here because the TCH rules have been recoded to TC. +""" +# ruff: noqa: TCH002 + +from __future__ import annotations + +import local_module + + +def func(sized: local_module.Container) -> int: + return len(sized) diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF102.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF102.py new file mode 100644 index 0000000000000..a7385d177f821 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/RUF102.py @@ -0,0 +1,18 @@ +# Invalid code +import os # noqa: INVALID123 +# External code +import re # noqa: V123 +# Valid noqa +import sys # noqa: E402 +from functools import cache # Preceeding comment # noqa: F401, INVALID456 +from itertools import product # Preceeding comment # noqa: INVALID789 +# Succeeding comment +import math # noqa: INVALID000 # Succeeding comment +# Mixed valid and invalid +from typing import List # noqa: F401, INVALID123 +# Test for multiple invalid +from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +# Test for preserving valid codes when fixing +from itertools import chain # noqa: E402, INVALID300, F401 +# Test for mixed code types +import json # noqa: E402, INVALID400, V100 diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/confusables.py b/crates/ruff_linter/resources/test/fixtures/ruff/confusables.py index b838a284947c3..4c6c8a53ccd9f 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/confusables.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/confusables.py @@ -56,3 +56,6 @@ class Labware: # Implicit string concatenation x = "𝐁ad" f"𝐁ad string" + +from typing import Literal +x: '''"""'Literal["ﮨ"]'"""''' diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/noqa.py b/crates/ruff_linter/resources/test/fixtures/ruff/noqa.py index 30e59400c6f2f..f91ab752ac6d2 100644 --- a/crates/ruff_linter/resources/test/fixtures/ruff/noqa.py +++ b/crates/ruff_linter/resources/test/fixtures/ruff/noqa.py @@ -19,5 +19,6 @@ def f(): def f(): - # Only `E741` should be ignored by the `noqa`. + # Neither of these are ignored and warning is + # logged to user I = 1 # noqa: E741.F841 diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/maturin_gh_1615/pyproject.toml b/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/maturin_gh_1615/pyproject.toml deleted file mode 100644 index 14e8b567ea1b1..0000000000000 --- a/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/maturin_gh_1615/pyproject.toml +++ /dev/null @@ -1,39 +0,0 @@ -# license-files is wrong here -# https://github.com/PyO3/maturin/issues/1615 -[build-system] -requires = [ "maturin>=0.14", "numpy", "wheel", "patchelf",] -build-backend = "maturin" - -[project] -name = "..." -license-files = [ "license.txt",] -requires-python = ">=3.8" -requires-dist = [ "maturin>=0.14", "...",] -dependencies = [ "packaging", "...",] -zip-safe = false -version = "..." -readme = "..." -description = "..." -classifiers = [ "...",] -[[project.authors]] -name = "..." -email = "..." - -[project.urls] -homepage = "..." -documentation = "..." -repository = "..." - -[project.optional-dependencies] -test = [ "coverage", "...",] -docs = [ "sphinx", "sphinx-rtd-theme",] -devel = [] - -[tool.maturin] -include = [ "...",] -bindings = "pyo3" -compatibility = "manylinux2014" - -[tool.pytest.ini_options] -testpaths = [ "...",] -addopts = "--color=yes --tb=native --cov-report term --cov-report html:docs/dist_coverage --cov=aisdb --doctest-modules --envfile .env" diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/pep639/pyproject.toml b/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/pep639/pyproject.toml new file mode 100644 index 0000000000000..04d0746dabc1a --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/pep639/pyproject.toml @@ -0,0 +1,6 @@ +[project] +name = "hello-world" +version = "0.1.0" +# PEP 639 - passing +license = "MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)" +license-files = ["LICEN[CS]E*", "AUTHORS*", "licenses/LICENSE.MIT"] diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/various_invalid/pyproject.toml b/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/various_invalid/pyproject.toml new file mode 100644 index 0000000000000..b0ce273333b1c --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/ruff/pyproject_toml/various_invalid/pyproject.toml @@ -0,0 +1,37 @@ +[build-system] +requires = [ "maturin>=0.14", "numpy", "wheel", "patchelf",] +build-backend = "maturin" + +[project] +name = "..." +license-files = [ "license.txt",] +requires-python = ">=3.8" +requires-dist = [ "maturin>=0.14", "...",] +dependencies = [ "packaging", "...",] +zip-safe = false +version = "..." +readme = "..." +description = "..." +classifiers = [ "...",] +[[project.authors]] +name = "..." +email = "..." + +[project.urls] +homepage = "..." +documentation = "..." +repository = "..." + +[project.optional-dependencies] +test = [ "coverage", "...",] +docs = [ "sphinx", "sphinx-rtd-theme",] +devel = [] + +[tool.maturin] +include = [ "...",] +bindings = "pyo3" +compatibility = "manylinux2014" + +[tool.pytest.ini_options] +testpaths = [ "...",] +addopts = "--color=yes --tb=native --cov-report term --cov-report html:docs/dist_coverage --cov=aisdb --doctest-modules --envfile .env" diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.ipynb b/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.ipynb new file mode 100644 index 0000000000000..8232efb4d2957 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.ipynb @@ -0,0 +1,57 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "6a70904e-dbfe-441c-99ec-12e6cf57f8ba", + "metadata": {}, + "outputs": [], + "source": [ + "async def elements(n): yield n" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5412fc2f-76eb-42c0-8db1-b5af6fdc46aa", + "metadata": {}, + "outputs": [], + "source": [ + "[x async for x in elements(5)] # okay, async at top level" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "dc3c94a7-2e64-42de-9351-260b3f41c3fd", + "metadata": { + "scrolled": true + }, + "outputs": [], + "source": [ + "[[x async for x in elements(5)] for i in range(5)] # error on 3.10, okay after" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.10.16" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.py new file mode 100644 index 0000000000000..c2000f141aca4 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/async_comprehension.py @@ -0,0 +1,11 @@ +async def elements(n): + yield n + +def regular_function(): + [x async for x in elements(1)] + + async with elements(1) as x: + pass + + async for _ in elements(1): + pass diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_outside_async_function.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_outside_async_function.py new file mode 100644 index 0000000000000..dd49cb05f9f6e --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_outside_async_function.py @@ -0,0 +1,5 @@ +def func(): + await 1 + +# Top-level await +await 1 diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_scope.ipynb b/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_scope.ipynb new file mode 100644 index 0000000000000..7d1e2784008a7 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/await_scope.ipynb @@ -0,0 +1,57 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "071bef14-c2b5-48d7-8e01-39f16f06328f", + "metadata": {}, + "outputs": [], + "source": [ + "await 1 # runtime TypeError but not a syntax error" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b4eaebd3-0fae-4e4c-9509-19ae6f743a08", + "metadata": {}, + "outputs": [], + "source": [ + "def _():\n", + " await 1 # SyntaxError: await outside async function" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "bf10b4ac-41c2-4daa-8862-9ee3386667ee", + "metadata": {}, + "outputs": [], + "source": [ + "class _:\n", + " await 1 # SyntaxError: await outside function" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.13.2" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/late_future_import.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/late_future_import.py new file mode 100644 index 0000000000000..1dd40c823c60d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/late_future_import.py @@ -0,0 +1,2 @@ +import random +from __future__ import annotations # Error; not at top of file diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/load_before_global_declaration.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/load_before_global_declaration.py new file mode 100644 index 0000000000000..70183b0891cd3 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/load_before_global_declaration.py @@ -0,0 +1,23 @@ +x = 10 +def test_1(): + global x # ok + x += 1 + + +x = 10 +def test_2(): + x += 1 # error + global x + +def test_3(): + print(x) # error + global x + x = 5 + +def test_4(): + global x + print(x) + x = 1 + +x = 0 +test_4() \ No newline at end of file diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/return_outside_function.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/return_outside_function.py new file mode 100644 index 0000000000000..5fd759479c78d --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/return_outside_function.py @@ -0,0 +1,23 @@ +def f(): + return 1 # okay + + +def f(): + return # okay + + +async def f(): + return # okay + + +return 1 # error +return # error + + +class C: + return 1 # error + + +def f(): + class C: + return 1 # error diff --git a/crates/ruff_linter/resources/test/fixtures/syntax_errors/yield_scope.py b/crates/ruff_linter/resources/test/fixtures/syntax_errors/yield_scope.py new file mode 100644 index 0000000000000..e5347922fb653 --- /dev/null +++ b/crates/ruff_linter/resources/test/fixtures/syntax_errors/yield_scope.py @@ -0,0 +1,41 @@ +yield # error +yield 1 # error +yield from 1 # error +await 1 # error +[(yield x) for x in range(3)] # error + + +def f(): + yield # okay + yield 1 # okay + yield from 1 # okay + await 1 # okay + + +lambda: (yield) # okay +lambda: (yield 1) # okay +lambda: (yield from 1) # okay +lambda: (await 1) # okay + + +def outer(): + class C: + yield 1 # error + + [(yield 1) for x in range(3)] # error + ((yield 1) for x in range(3)) # error + {(yield 1) for x in range(3)} # error + {(yield 1): 0 for x in range(3)} # error + {0: (yield 1) for x in range(3)} # error + + +async def outer(): + [await x for x in range(3)] # okay, comprehensions don't break async scope + + class C: + [await x for x in range(3)] # error, classes break async scope + + lambda x: await x # okay for now, lambda breaks _async_ scope but is a function + + +await 1 # error diff --git a/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs b/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs index 586fa7ada081f..1356bb6288fd8 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs @@ -3,11 +3,15 @@ use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::codes::Rule; -use crate::rules::{flake8_import_conventions, flake8_pyi, pyflakes, pylint, ruff}; +use crate::rules::{ + flake8_import_conventions, flake8_pyi, flake8_pytest_style, flake8_type_checking, pyflakes, + pylint, pyupgrade, refurb, ruff, +}; /// Run lint rules over the [`Binding`]s. -pub(crate) fn bindings(checker: &mut Checker) { +pub(crate) fn bindings(checker: &Checker) { if !checker.any_enabled(&[ + Rule::AssignmentInAssert, Rule::InvalidAllFormat, Rule::InvalidAllObject, Rule::NonAsciiName, @@ -15,11 +19,17 @@ pub(crate) fn bindings(checker: &mut Checker) { Rule::UnconventionalImportAlias, Rule::UnsortedDunderSlots, Rule::UnusedVariable, + Rule::UnquotedTypeAlias, + Rule::UsedDummyVariable, + Rule::PytestUnittestRaisesAssertion, + Rule::ForLoopWrites, + Rule::CustomTypeVarForSelf, + Rule::PrivateTypeParameter, ]) { return; } - for binding in &*checker.semantic.bindings { + for (binding_id, binding) in checker.semantic.bindings.iter_enumerated() { if checker.enabled(Rule::UnusedVariable) { if binding.kind.is_bound_exception() && binding.is_unused() @@ -38,22 +48,22 @@ pub(crate) fn bindings(checker: &mut Checker) { pyflakes::fixes::remove_exception_handler_assignment(binding, checker.locator) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::InvalidAllFormat) { if let Some(diagnostic) = pylint::rules::invalid_all_format(binding) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::InvalidAllObject) { if let Some(diagnostic) = pylint::rules::invalid_all_object(binding) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::NonAsciiName) { if let Some(diagnostic) = pylint::rules::non_ascii_name(binding, checker.locator) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::UnconventionalImportAlias) { @@ -62,19 +72,57 @@ pub(crate) fn bindings(checker: &mut Checker) { binding, &checker.settings.flake8_import_conventions.aliases, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::UnaliasedCollectionsAbcSetImport) { if let Some(diagnostic) = flake8_pyi::rules::unaliased_collections_abc_set_import(checker, binding) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } + if !checker.source_type.is_stub() && checker.enabled(Rule::UnquotedTypeAlias) { + flake8_type_checking::rules::unquoted_type_alias(checker, binding); + } if checker.enabled(Rule::UnsortedDunderSlots) { if let Some(diagnostic) = ruff::rules::sort_dunder_slots(checker, binding) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::UsedDummyVariable) { + if let Some(diagnostic) = ruff::rules::used_dummy_variable(checker, binding, binding_id) + { + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::AssignmentInAssert) { + if let Some(diagnostic) = ruff::rules::assignment_in_assert(checker, binding) { + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::PytestUnittestRaisesAssertion) { + if let Some(diagnostic) = + flake8_pytest_style::rules::unittest_raises_assertion_binding(checker, binding) + { + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::ForLoopWrites) { + if let Some(diagnostic) = refurb::rules::for_loop_writes_binding(checker, binding) { + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::CustomTypeVarForSelf) { + if let Some(diagnostic) = + flake8_pyi::rules::custom_type_var_instead_of_self(checker, binding) + { + checker.report_diagnostic(diagnostic); + } + } + if checker.enabled(Rule::PrivateTypeParameter) { + if let Some(diagnostic) = pyupgrade::rules::private_type_parameter(checker, binding) { + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/comprehension.rs b/crates/ruff_linter/src/checkers/ast/analyze/comprehension.rs index 821e62c283597..356c0ca8992e9 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/comprehension.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/comprehension.rs @@ -5,7 +5,7 @@ use crate::codes::Rule; use crate::rules::{flake8_simplify, refurb}; /// Run lint rules over a [`Comprehension`] syntax nodes. -pub(crate) fn comprehension(comprehension: &Comprehension, checker: &mut Checker) { +pub(crate) fn comprehension(comprehension: &Comprehension, checker: &Checker) { if checker.enabled(Rule::InDictKeys) { flake8_simplify::rules::key_in_dict_comprehension(checker, comprehension); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/deferred_for_loops.rs b/crates/ruff_linter/src/checkers/ast/analyze/deferred_for_loops.rs index 35fe8168e0eaa..abb9110b6ea8b 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/deferred_for_loops.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/deferred_for_loops.rs @@ -14,7 +14,6 @@ pub(crate) fn deferred_for_loops(checker: &mut Checker) { let Stmt::For(stmt_for) = checker.semantic.current_statement() else { unreachable!("Expected Stmt::For"); }; - if checker.enabled(Rule::UnusedLoopControlVariable) { flake8_bugbear::rules::unused_loop_control_variable(checker, stmt_for); } @@ -36,6 +35,12 @@ pub(crate) fn deferred_for_loops(checker: &mut Checker) { if checker.enabled(Rule::DictIndexMissingItems) { pylint::rules::dict_index_missing_items(checker, stmt_for); } + if checker.enabled(Rule::ManualDictComprehension) { + perflint::rules::manual_dict_comprehension(checker, stmt_for); + } + if checker.enabled(Rule::ManualListComprehension) { + perflint::rules::manual_list_comprehension(checker, stmt_for); + } } } } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/deferred_lambdas.rs b/crates/ruff_linter/src/checkers/ast/analyze/deferred_lambdas.rs index 83af7589a2c77..2ec55d48509ac 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/deferred_lambdas.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/deferred_lambdas.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use crate::checkers::ast::Checker; use crate::codes::Rule; -use crate::rules::{flake8_builtins, flake8_pie, pylint, refurb}; +use crate::rules::{flake8_builtins, flake8_pie, pylint}; /// Run lint rules over all deferred lambdas in the [`SemanticModel`]. pub(crate) fn deferred_lambdas(checker: &mut Checker) { @@ -21,9 +21,6 @@ pub(crate) fn deferred_lambdas(checker: &mut Checker) { if checker.enabled(Rule::ReimplementedContainerBuiltin) { flake8_pie::rules::reimplemented_container_builtin(checker, lambda); } - if checker.enabled(Rule::ReimplementedOperator) { - refurb::rules::reimplemented_operator(checker, &lambda.into()); - } if checker.enabled(Rule::BuiltinLambdaArgumentShadowing) { flake8_builtins::rules::builtin_lambda_argument_shadowing(checker, lambda); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/deferred_scopes.rs b/crates/ruff_linter/src/checkers/ast/analyze/deferred_scopes.rs index 003db1d741782..36a8af20fa718 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/deferred_scopes.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/deferred_scopes.rs @@ -2,6 +2,7 @@ use ruff_diagnostics::{Diagnostic, Fix}; use ruff_python_semantic::analyze::visibility; use ruff_python_semantic::{Binding, BindingKind, Imported, ResolvedReference, ScopeKind}; use ruff_text_size::Ranged; +use rustc_hash::FxHashMap; use crate::checkers::ast::Checker; use crate::codes::Rule; @@ -12,16 +13,19 @@ use crate::rules::{ }; /// Run lint rules over all deferred scopes in the [`SemanticModel`]. -pub(crate) fn deferred_scopes(checker: &mut Checker) { +pub(crate) fn deferred_scopes(checker: &Checker) { if !checker.any_enabled(&[ Rule::AsyncioDanglingTask, Rule::BadStaticmethodArgument, Rule::BuiltinAttributeShadowing, + Rule::FunctionCallInDataclassDefaultArgument, Rule::GlobalVariableNotAssigned, Rule::ImportPrivateName, Rule::ImportShadowedByLoopVar, Rule::InvalidFirstArgumentNameForClassMethod, Rule::InvalidFirstArgumentNameForMethod, + Rule::MutableClassDefault, + Rule::MutableDataclassDefault, Rule::NoSelfUse, Rule::RedefinedArgumentFromLocal, Rule::RedefinedWhileUnused, @@ -44,6 +48,7 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { Rule::UnusedPrivateTypedDict, Rule::UnusedPrivateTypeVar, Rule::UnusedStaticMethodArgument, + Rule::UnusedUnpackedVariable, Rule::UnusedVariable, ]) { return; @@ -52,14 +57,13 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { // Identify any valid runtime imports. If a module is imported at runtime, and // used at runtime, then by default, we avoid flagging any other // imports from that model as typing-only. - let enforce_typing_imports = !checker.source_type.is_stub() + let enforce_typing_only_imports = !checker.source_type.is_stub() && checker.any_enabled(&[ - Rule::RuntimeImportInTypeCheckingBlock, Rule::TypingOnlyFirstPartyImport, Rule::TypingOnlyStandardLibraryImport, Rule::TypingOnlyThirdPartyImport, ]); - let runtime_imports: Vec<Vec<&Binding>> = if enforce_typing_imports { + let runtime_imports: Vec<Vec<&Binding>> = if enforce_typing_only_imports { checker .semantic .scopes @@ -82,12 +86,11 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { vec![] }; - let mut diagnostics: Vec<Diagnostic> = vec![]; for scope_id in checker.analyze.scopes.iter().rev().copied() { let scope = &checker.semantic.scopes[scope_id]; if checker.enabled(Rule::UndefinedLocal) { - pyflakes::rules::undefined_local(checker, scope_id, scope, &mut diagnostics); + pyflakes::rules::undefined_local(checker, scope_id, scope); } if checker.enabled(Rule::GlobalVariableNotAssigned) { @@ -109,7 +112,7 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { .map(|id| checker.semantic.reference(*id)) .all(ResolvedReference::is_load) { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pylint::rules::GlobalVariableNotAssigned { name: (*name).to_string(), }, @@ -143,7 +146,7 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { if scope.kind.is_generator() { continue; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pylint::rules::RedefinedArgumentFromLocal { name: name.to_string(), }, @@ -175,15 +178,15 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { } // If the bindings are in different forks, abort. - if shadowed.source.map_or(true, |left| { + if shadowed.source.is_none_or(|left| { binding .source - .map_or(true, |right| !checker.semantic.same_branch(left, right)) + .is_none_or(|right| !checker.semantic.same_branch(left, right)) }) { continue; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::ImportShadowedByLoopVar { name: name.to_string(), row: checker.compute_source_row(shadowed.start()), @@ -195,6 +198,9 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { } if checker.enabled(Rule::RedefinedWhileUnused) { + // Index the redefined bindings by statement. + let mut redefinitions = FxHashMap::default(); + for (name, binding_id) in scope.bindings() { for shadow in checker.semantic.shadowed_bindings(scope_id, binding_id) { // If the shadowing binding is a loop variable, abort, to avoid overlap @@ -264,17 +270,70 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { } // If the bindings are in different forks, abort. - if shadowed.source.map_or(true, |left| { + if shadowed.source.is_none_or(|left| { binding .source - .map_or(true, |right| !checker.semantic.same_branch(left, right)) + .is_none_or(|right| !checker.semantic.same_branch(left, right)) }) { continue; } + redefinitions + .entry(binding.source) + .or_insert_with(Vec::new) + .push((shadowed, binding)); + } + } + + // Create a fix for each source statement. + let mut fixes = FxHashMap::default(); + for (source, entries) in &redefinitions { + let Some(source) = source else { + continue; + }; + + let member_names = entries + .iter() + .filter_map(|(shadowed, binding)| { + if let Some(shadowed_import) = shadowed.as_any_import() { + if let Some(import) = binding.as_any_import() { + if shadowed_import.qualified_name() == import.qualified_name() { + return Some(import.member_name()); + } + } + } + None + }) + .collect::<Vec<_>>(); + + if !member_names.is_empty() { + let statement = checker.semantic.statement(*source); + let parent = checker.semantic.parent_statement(*source); + let Ok(edit) = fix::edits::remove_unused_imports( + member_names.iter().map(std::convert::AsRef::as_ref), + statement, + parent, + checker.locator(), + checker.stylist(), + checker.indexer(), + ) else { + continue; + }; + fixes.insert( + *source, + Fix::safe_edit(edit).isolate(Checker::isolation( + checker.semantic().parent_statement_id(*source), + )), + ); + } + } + + // Create diagnostics for each statement. + for (source, entries) in &redefinitions { + for (shadowed, binding) in entries { let mut diagnostic = Diagnostic::new( pyflakes::rules::RedefinedWhileUnused { - name: (*name).to_string(), + name: binding.name(checker.source()).to_string(), row: checker.compute_source_row(shadowed.start()), }, binding.range(), @@ -284,33 +343,11 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { diagnostic.set_parent(range.start()); } - // Remove the import if the binding and the shadowed binding are both imports, - // and both point to the same qualified name. - if let Some(shadowed_import) = shadowed.as_any_import() { - if let Some(import) = binding.as_any_import() { - if shadowed_import.qualified_name() == import.qualified_name() { - if let Some(source) = binding.source { - diagnostic.try_set_fix(|| { - let statement = checker.semantic().statement(source); - let parent = checker.semantic().parent_statement(source); - let edit = fix::edits::remove_unused_imports( - std::iter::once(import.member_name().as_ref()), - statement, - parent, - checker.locator(), - checker.stylist(), - checker.indexer(), - )?; - Ok(Fix::safe_edit(edit).isolate(Checker::isolation( - checker.semantic().parent_statement_id(source), - ))) - }); - } - } - } + if let Some(fix) = source.as_ref().and_then(|source| fixes.get(source)) { + diagnostic.set_fix(fix.clone()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -319,42 +356,82 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { || matches!(scope.kind, ScopeKind::Module | ScopeKind::Function(_)) { if checker.enabled(Rule::UnusedPrivateTypeVar) { - flake8_pyi::rules::unused_private_type_var(checker, scope, &mut diagnostics); + flake8_pyi::rules::unused_private_type_var(checker, scope); } if checker.enabled(Rule::UnusedPrivateProtocol) { - flake8_pyi::rules::unused_private_protocol(checker, scope, &mut diagnostics); + flake8_pyi::rules::unused_private_protocol(checker, scope); } if checker.enabled(Rule::UnusedPrivateTypeAlias) { - flake8_pyi::rules::unused_private_type_alias(checker, scope, &mut diagnostics); + flake8_pyi::rules::unused_private_type_alias(checker, scope); } if checker.enabled(Rule::UnusedPrivateTypedDict) { - flake8_pyi::rules::unused_private_typed_dict(checker, scope, &mut diagnostics); + flake8_pyi::rules::unused_private_typed_dict(checker, scope); } } if checker.enabled(Rule::AsyncioDanglingTask) { - ruff::rules::asyncio_dangling_binding(scope, &checker.semantic, &mut diagnostics); + ruff::rules::asyncio_dangling_binding(scope, checker); } if let Some(class_def) = scope.kind.as_class() { if checker.enabled(Rule::BuiltinAttributeShadowing) { flake8_builtins::rules::builtin_attribute_shadowing( - checker, - scope_id, - scope, - class_def, - &mut diagnostics, + checker, scope_id, scope, class_def, ); } + if checker.enabled(Rule::FunctionCallInDataclassDefaultArgument) { + ruff::rules::function_call_in_dataclass_default(checker, class_def); + } + if checker.enabled(Rule::MutableClassDefault) { + ruff::rules::mutable_class_default(checker, class_def); + } + if checker.enabled(Rule::MutableDataclassDefault) { + ruff::rules::mutable_dataclass_default(checker, class_def); + } } if matches!(scope.kind, ScopeKind::Function(_) | ScopeKind::Lambda(_)) { - if checker.enabled(Rule::UnusedVariable) { - pyflakes::rules::unused_variable(checker, scope, &mut diagnostics); + if checker.any_enabled(&[Rule::UnusedVariable, Rule::UnusedUnpackedVariable]) + && !(scope.uses_locals() && scope.kind.is_function()) + { + let unused_bindings = scope + .bindings() + .map(|(name, binding_id)| (name, checker.semantic().binding(binding_id))) + .filter_map(|(name, binding)| { + if (binding.kind.is_assignment() + || binding.kind.is_named_expr_assignment() + || binding.kind.is_with_item_var()) + && binding.is_unused() + && !binding.is_nonlocal() + && !binding.is_global() + && !checker.settings.dummy_variable_rgx.is_match(name) + && !matches!( + name, + "__tracebackhide__" + | "__traceback_info__" + | "__traceback_supplement__" + | "__debuggerskip__" + ) + { + return Some((name, binding)); + } + + None + }); + + for (unused_name, unused_binding) in unused_bindings { + if checker.enabled(Rule::UnusedVariable) { + pyflakes::rules::unused_variable(checker, unused_name, unused_binding); + } + + if checker.enabled(Rule::UnusedUnpackedVariable) { + ruff::rules::unused_unpacked_variable(checker, unused_name, unused_binding); + } + } } if checker.enabled(Rule::UnusedAnnotation) { - pyflakes::rules::unused_annotation(checker, scope, &mut diagnostics); + pyflakes::rules::unused_annotation(checker, scope); } if !checker.source_type.is_stub() { @@ -365,17 +442,18 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { Rule::UnusedMethodArgument, Rule::UnusedStaticMethodArgument, ]) { - flake8_unused_arguments::rules::unused_arguments( - checker, - scope, - &mut diagnostics, - ); + flake8_unused_arguments::rules::unused_arguments(checker, scope); } } } if matches!(scope.kind, ScopeKind::Function(_) | ScopeKind::Module) { - if enforce_typing_imports { + if !checker.source_type.is_stub() + && checker.enabled(Rule::RuntimeImportInTypeCheckingBlock) + { + flake8_type_checking::rules::runtime_import_in_type_checking_block(checker, scope); + } + if enforce_typing_only_imports { let runtime_imports: Vec<&Binding> = checker .semantic .scopes @@ -384,65 +462,49 @@ pub(crate) fn deferred_scopes(checker: &mut Checker) { .copied() .collect(); - if checker.enabled(Rule::RuntimeImportInTypeCheckingBlock) { - flake8_type_checking::rules::runtime_import_in_type_checking_block( - checker, - scope, - &mut diagnostics, - ); - } - - if checker.any_enabled(&[ - Rule::TypingOnlyFirstPartyImport, - Rule::TypingOnlyStandardLibraryImport, - Rule::TypingOnlyThirdPartyImport, - ]) { - flake8_type_checking::rules::typing_only_runtime_import( - checker, - scope, - &runtime_imports, - &mut diagnostics, - ); - } + flake8_type_checking::rules::typing_only_runtime_import( + checker, + scope, + &runtime_imports, + ); } if checker.enabled(Rule::UnusedImport) { - pyflakes::rules::unused_import(checker, scope, &mut diagnostics); + pyflakes::rules::unused_import(checker, scope); } if checker.enabled(Rule::ImportPrivateName) { - pylint::rules::import_private_name(checker, scope, &mut diagnostics); + pylint::rules::import_private_name(checker, scope); } } if scope.kind.is_function() { if checker.enabled(Rule::NoSelfUse) { - pylint::rules::no_self_use(checker, scope_id, scope, &mut diagnostics); + pylint::rules::no_self_use(checker, scope_id, scope); } if checker.enabled(Rule::TooManyLocals) { - pylint::rules::too_many_locals(checker, scope, &mut diagnostics); + pylint::rules::too_many_locals(checker, scope); } if checker.enabled(Rule::SingledispatchMethod) { - pylint::rules::singledispatch_method(checker, scope, &mut diagnostics); + pylint::rules::singledispatch_method(checker, scope); } if checker.enabled(Rule::SingledispatchmethodFunction) { - pylint::rules::singledispatchmethod_function(checker, scope, &mut diagnostics); + pylint::rules::singledispatchmethod_function(checker, scope); } if checker.enabled(Rule::BadStaticmethodArgument) { - pylint::rules::bad_staticmethod_argument(checker, scope, &mut diagnostics); + pylint::rules::bad_staticmethod_argument(checker, scope); } if checker.any_enabled(&[ Rule::InvalidFirstArgumentNameForClassMethod, Rule::InvalidFirstArgumentNameForMethod, ]) { - pep8_naming::rules::invalid_first_argument_name(checker, scope, &mut diagnostics); + pep8_naming::rules::invalid_first_argument_name(checker, scope); } } } - checker.diagnostics.extend(diagnostics); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/definitions.rs b/crates/ruff_linter/src/checkers/ast/analyze/definitions.rs index e98214fb3b5e6..a1f85de2e988b 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/definitions.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/definitions.rs @@ -1,10 +1,8 @@ -use ruff_python_ast::str::raw_contents_range; use ruff_python_semantic::all::DunderAllName; use ruff_python_semantic::{ BindingKind, ContextualizedDefinition, Definition, Export, Member, MemberKind, }; -use ruff_source_file::LineRanges; -use ruff_text_size::{Ranged, TextRange}; +use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::codes::Rule; @@ -27,49 +25,47 @@ pub(crate) fn definitions(checker: &mut Checker) { Rule::MissingReturnTypeStaticMethod, Rule::MissingReturnTypeUndocumentedPublicFunction, Rule::MissingTypeArgs, - Rule::MissingTypeCls, Rule::MissingTypeFunctionArgument, Rule::MissingTypeKwargs, - Rule::MissingTypeSelf, ]); let enforce_stubs = checker.source_type.is_stub() && checker.enabled(Rule::DocstringInStub); let enforce_stubs_and_runtime = checker.enabled(Rule::IterMethodReturnIterable); let enforce_dunder_method = checker.enabled(Rule::BadDunderMethodName); let enforce_docstrings = checker.any_enabled(&[ - Rule::BlankLineAfterLastSection, - Rule::BlankLineAfterSummary, + Rule::MissingBlankLineAfterLastSection, + Rule::MissingBlankLineAfterSummary, Rule::BlankLineBeforeClass, Rule::BlankLinesBetweenHeaderAndContent, - Rule::CapitalizeSectionName, - Rule::DashedUnderlineAfterSection, + Rule::NonCapitalizedSectionName, + Rule::MissingDashedUnderlineAfterSection, Rule::DocstringStartsWithThis, Rule::EmptyDocstring, Rule::EmptyDocstringSection, - Rule::EndsInPeriod, - Rule::EndsInPunctuation, + Rule::MissingTrailingPeriod, + Rule::MissingTerminalPunctuation, Rule::EscapeSequenceInDocstring, - Rule::FirstLineCapitalized, - Rule::FitsOnOneLine, - Rule::IndentWithSpaces, + Rule::FirstWordUncapitalized, + Rule::UnnecessaryMultilineDocstring, + Rule::DocstringTabIndentation, Rule::MultiLineSummaryFirstLine, Rule::MultiLineSummarySecondLine, Rule::NewLineAfterLastParagraph, - Rule::NewLineAfterSectionName, - Rule::NoBlankLineAfterFunction, + Rule::MissingNewLineAfterSectionName, + Rule::BlankLineAfterFunction, Rule::NoBlankLineAfterSection, - Rule::NoBlankLineBeforeFunction, + Rule::BlankLineBeforeFunction, Rule::NoBlankLineBeforeSection, - Rule::NoSignature, + Rule::SignatureInDocstring, Rule::NonImperativeMood, - Rule::OneBlankLineAfterClass, - Rule::OneBlankLineBeforeClass, + Rule::IncorrectBlankLineAfterClass, + Rule::IncorrectBlankLineBeforeClass, Rule::OverIndentation, Rule::OverloadWithDocstring, - Rule::SectionNameEndsInColon, - Rule::SectionNotOverIndented, - Rule::SectionUnderlineAfterName, - Rule::SectionUnderlineMatchesSectionLength, - Rule::SectionUnderlineNotOverIndented, + Rule::MissingSectionNameColon, + Rule::OverindentedSection, + Rule::MissingSectionUnderlineAfterName, + Rule::MismatchedSectionUnderlineLength, + Rule::OverindentedSectionUnderline, Rule::SurroundingWhitespace, Rule::TripleSingleQuotes, Rule::UnderIndentation, @@ -141,13 +137,7 @@ pub(crate) fn definitions(checker: &mut Checker) { &checker.semantic, ) }) { - checker - .diagnostics - .extend(flake8_annotations::rules::definition( - checker, - definition, - *visibility, - )); + flake8_annotations::rules::definition(checker, definition, *visibility); } overloaded_name = flake8_annotations::helpers::overloaded_name(definition, &checker.semantic); @@ -155,7 +145,7 @@ pub(crate) fn definitions(checker: &mut Checker) { // flake8-pyi if enforce_stubs { - flake8_pyi::rules::docstring_in_stubs(checker, docstring); + flake8_pyi::rules::docstring_in_stubs(checker, definition, docstring); } if enforce_stubs_and_runtime { flake8_pyi::rules::iter_method_return_iterable(checker, definition); @@ -188,61 +178,48 @@ pub(crate) fn definitions(checker: &mut Checker) { continue; }; - let contents = checker.locator().slice(string_literal); - - let indentation = checker.locator().slice(TextRange::new( - checker.locator.line_start(string_literal.start()), - string_literal.start(), - )); - - if string_literal.value.is_implicit_concatenated() { - #[allow(deprecated)] + // We don't recognise implicitly concatenated strings as valid docstrings in our model currently. + let Some(sole_string_part) = string_literal.as_single_part_string() else { + #[expect(deprecated)] let location = checker .locator .compute_source_location(string_literal.start()); warn_user!( "Docstring at {}:{}:{} contains implicit string concatenation; ignoring...", relativize_path(checker.path), - location.row, + location.line, location.column ); continue; - } + }; - // SAFETY: Safe for docstrings that pass `should_ignore_docstring`. - let body_range = raw_contents_range(contents).unwrap(); let docstring = Docstring { definition, - expr: string_literal, - contents, - body_range, - indentation, + expr: sole_string_part, + source: checker.source(), }; if !pydocstyle::rules::not_empty(checker, &docstring) { continue; } - if checker.enabled(Rule::FitsOnOneLine) { + if checker.enabled(Rule::UnnecessaryMultilineDocstring) { pydocstyle::rules::one_liner(checker, &docstring); } - if checker.any_enabled(&[ - Rule::NoBlankLineAfterFunction, - Rule::NoBlankLineBeforeFunction, - ]) { + if checker.any_enabled(&[Rule::BlankLineAfterFunction, Rule::BlankLineBeforeFunction]) { pydocstyle::rules::blank_before_after_function(checker, &docstring); } if checker.any_enabled(&[ Rule::BlankLineBeforeClass, - Rule::OneBlankLineAfterClass, - Rule::OneBlankLineBeforeClass, + Rule::IncorrectBlankLineAfterClass, + Rule::IncorrectBlankLineBeforeClass, ]) { pydocstyle::rules::blank_before_after_class(checker, &docstring); } - if checker.enabled(Rule::BlankLineAfterSummary) { + if checker.enabled(Rule::MissingBlankLineAfterSummary) { pydocstyle::rules::blank_after_summary(checker, &docstring); } if checker.any_enabled(&[ - Rule::IndentWithSpaces, + Rule::DocstringTabIndentation, Rule::OverIndentation, Rule::UnderIndentation, ]) { @@ -266,7 +243,7 @@ pub(crate) fn definitions(checker: &mut Checker) { if checker.enabled(Rule::EscapeSequenceInDocstring) { pydocstyle::rules::backslashes(checker, &docstring); } - if checker.enabled(Rule::EndsInPeriod) { + if checker.enabled(Rule::MissingTrailingPeriod) { pydocstyle::rules::ends_with_period(checker, &docstring); } if checker.enabled(Rule::NonImperativeMood) { @@ -276,16 +253,16 @@ pub(crate) fn definitions(checker: &mut Checker) { &checker.settings.pydocstyle, ); } - if checker.enabled(Rule::NoSignature) { + if checker.enabled(Rule::SignatureInDocstring) { pydocstyle::rules::no_signature(checker, &docstring); } - if checker.enabled(Rule::FirstLineCapitalized) { + if checker.enabled(Rule::FirstWordUncapitalized) { pydocstyle::rules::capitalized(checker, &docstring); } if checker.enabled(Rule::DocstringStartsWithThis) { pydocstyle::rules::starts_with_this(checker, &docstring); } - if checker.enabled(Rule::EndsInPunctuation) { + if checker.enabled(Rule::MissingTerminalPunctuation) { pydocstyle::rules::ends_with_punctuation(checker, &docstring); } if checker.enabled(Rule::OverloadWithDocstring) { @@ -293,20 +270,20 @@ pub(crate) fn definitions(checker: &mut Checker) { } let enforce_sections = checker.any_enabled(&[ - Rule::BlankLineAfterLastSection, + Rule::MissingBlankLineAfterLastSection, Rule::BlankLinesBetweenHeaderAndContent, - Rule::CapitalizeSectionName, - Rule::DashedUnderlineAfterSection, + Rule::NonCapitalizedSectionName, + Rule::MissingDashedUnderlineAfterSection, Rule::EmptyDocstringSection, Rule::MultiLineSummaryFirstLine, - Rule::NewLineAfterSectionName, + Rule::MissingNewLineAfterSectionName, Rule::NoBlankLineAfterSection, Rule::NoBlankLineBeforeSection, - Rule::SectionNameEndsInColon, - Rule::SectionNotOverIndented, - Rule::SectionUnderlineAfterName, - Rule::SectionUnderlineMatchesSectionLength, - Rule::SectionUnderlineNotOverIndented, + Rule::MissingSectionNameColon, + Rule::OverindentedSection, + Rule::MissingSectionUnderlineAfterName, + Rule::MismatchedSectionUnderlineLength, + Rule::OverindentedSectionUnderline, Rule::UndocumentedParam, ]); if enforce_sections || enforce_pydoclint { diff --git a/crates/ruff_linter/src/checkers/ast/analyze/except_handler.rs b/crates/ruff_linter/src/checkers/ast/analyze/except_handler.rs index 0c3d6372ab225..9a68550216776 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/except_handler.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/except_handler.rs @@ -8,7 +8,7 @@ use crate::rules::{ }; /// Run lint rules over an [`ExceptHandler`] syntax node. -pub(crate) fn except_handler(except_handler: &ExceptHandler, checker: &mut Checker) { +pub(crate) fn except_handler(except_handler: &ExceptHandler, checker: &Checker) { match except_handler { ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, @@ -23,7 +23,7 @@ pub(crate) fn except_handler(except_handler: &ExceptHandler, checker: &mut Check except_handler, checker.locator, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::RaiseWithoutFromInsideExcept) { diff --git a/crates/ruff_linter/src/checkers/ast/analyze/expression.rs b/crates/ruff_linter/src/checkers/ast/analyze/expression.rs index 99deb3b994998..38bbf9874ca87 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/expression.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/expression.rs @@ -4,37 +4,38 @@ use ruff_python_literal::cformat::{CFormatError, CFormatErrorType}; use ruff_diagnostics::Diagnostic; use ruff_python_ast::types::Node; -use ruff_python_semantic::analyze::typing; use ruff_python_semantic::ScopeKind; +use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::registry::Rule; use crate::rules::{ - flake8_2020, flake8_async, flake8_bandit, flake8_boolean_trap, flake8_bugbear, flake8_builtins, - flake8_comprehensions, flake8_datetimez, flake8_debugger, flake8_django, + airflow, flake8_2020, flake8_async, flake8_bandit, flake8_boolean_trap, flake8_bugbear, + flake8_builtins, flake8_comprehensions, flake8_datetimez, flake8_debugger, flake8_django, flake8_future_annotations, flake8_gettext, flake8_implicit_str_concat, flake8_logging, flake8_logging_format, flake8_pie, flake8_print, flake8_pyi, flake8_pytest_style, flake8_self, flake8_simplify, flake8_tidy_imports, flake8_type_checking, flake8_use_pathlib, flynt, numpy, pandas_vet, pep8_naming, pycodestyle, pyflakes, pylint, pyupgrade, refurb, ruff, }; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// Run lint rules over an [`Expr`] syntax node. -pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { +pub(crate) fn expression(expr: &Expr, checker: &Checker) { match expr { Expr::Subscript(subscript @ ast::ExprSubscript { value, slice, .. }) => { // Ex) Optional[...], Union[...] if checker.any_enabled(&[ Rule::FutureRewritableTypeAnnotation, - Rule::NonPEP604Annotation, + Rule::NonPEP604AnnotationUnion, + Rule::NonPEP604AnnotationOptional, ]) { if let Some(operator) = typing::to_pep604_operator(value, slice, &checker.semantic) { if checker.enabled(Rule::FutureRewritableTypeAnnotation) { if !checker.semantic.future_annotations_or_stub() - && checker.settings.target_version < PythonVersion::Py310 - && checker.settings.target_version >= PythonVersion::Py37 + && checker.target_version() < PythonVersion::PY310 + && checker.target_version() >= PythonVersion::PY37 && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing { @@ -43,15 +44,18 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { ); } } - if checker.enabled(Rule::NonPEP604Annotation) { + if checker.any_enabled(&[ + Rule::NonPEP604AnnotationUnion, + Rule::NonPEP604AnnotationOptional, + ]) { if checker.source_type.is_stub() - || checker.settings.target_version >= PythonVersion::Py310 - || (checker.settings.target_version >= PythonVersion::Py37 + || checker.target_version() >= PythonVersion::PY310 + || (checker.target_version() >= PythonVersion::PY37 && checker.semantic.future_annotations_or_stub() && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing) { - pyupgrade::rules::use_pep604_annotation(checker, expr, slice, operator); + pyupgrade::rules::non_pep604_annotation(checker, expr, slice, operator); } } } @@ -60,7 +64,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { // Ex) list[...] if checker.enabled(Rule::FutureRequiredTypeAnnotation) { if !checker.semantic.future_annotations_or_stub() - && checker.settings.target_version < PythonVersion::Py39 + && checker.target_version() < PythonVersion::PY39 && checker.semantic.in_annotation() && checker.semantic.in_runtime_evaluated_annotation() && !checker.semantic.in_string_type_definition() @@ -80,6 +84,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { Rule::DuplicateUnionMember, Rule::RedundantLiteralUnion, Rule::UnnecessaryTypeUnion, + Rule::NoneNotAtEndOfUnion, ]) { // Avoid duplicate checks if the parent is a union, since these rules already // traverse nested unions. @@ -96,13 +101,32 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::UnnecessaryTypeUnion) { flake8_pyi::rules::unnecessary_type_union(checker, expr); } + if checker.enabled(Rule::NoneNotAtEndOfUnion) { + ruff::rules::none_not_at_end_of_union(checker, expr); + } } } // Ex) Literal[...] - if checker.enabled(Rule::DuplicateLiteralMember) { + if checker.any_enabled(&[ + Rule::DuplicateLiteralMember, + Rule::RedundantBoolLiteral, + Rule::RedundantNoneLiteral, + Rule::UnnecessaryNestedLiteral, + ]) { if !checker.semantic.in_nested_literal() { - flake8_pyi::rules::duplicate_literal_member(checker, expr); + if checker.enabled(Rule::DuplicateLiteralMember) { + flake8_pyi::rules::duplicate_literal_member(checker, expr); + } + if checker.enabled(Rule::RedundantBoolLiteral) { + ruff::rules::redundant_bool_literal(checker, expr); + } + if checker.enabled(Rule::RedundantNoneLiteral) { + flake8_pyi::rules::redundant_none_literal(checker, expr); + } + if checker.enabled(Rule::UnnecessaryNestedLiteral) { + ruff::rules::unnecessary_nested_literal(checker, expr); + } } } @@ -111,7 +135,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } if checker.enabled(Rule::UnnecessaryDefaultTypeArgs) { - if checker.settings.target_version >= PythonVersion::Py313 { + if checker.target_version() >= PythonVersion::PY313 { pyupgrade::rules::unnecessary_default_type_args(checker, expr); } } @@ -145,11 +169,15 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::FStringNumberFormat) { refurb::rules::fstring_number_format(checker, subscript); } - if checker.enabled(Rule::IncorrectlyParenthesizedTupleInSubscript) { ruff::rules::subscript_with_parenthesized_tuple(checker, subscript); } - + if checker.enabled(Rule::NonPEP646Unpack) { + pyupgrade::rules::use_pep646_unpack(checker, subscript); + } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_expr(checker, expr); + } pandas_vet::rules::subscript(checker, value, expr); } Expr::Tuple(ast::ExprTuple { @@ -173,7 +201,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { check_two_starred_expressions, expr.range(), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -198,6 +226,43 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::RegexFlagAlias) { refurb::rules::regex_flag_alias(checker, expr); } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_expr(checker, expr); + } + if checker.enabled(Rule::Airflow3SuggestedUpdate) { + airflow::rules::airflow_3_0_suggested_update_expr(checker, expr); + } + if checker.enabled(Rule::Airflow3MovedToProvider) { + airflow::rules::moved_to_provider_in_3(checker, expr); + } + if checker.enabled(Rule::Airflow3SuggestedToMoveToProvider) { + airflow::rules::suggested_to_move_to_provider_in_3(checker, expr); + } + if checker.any_enabled(&[ + Rule::SuspiciousPickleUsage, + Rule::SuspiciousMarshalUsage, + Rule::SuspiciousInsecureHashUsage, + Rule::SuspiciousInsecureCipherUsage, + Rule::SuspiciousInsecureCipherModeUsage, + Rule::SuspiciousMktempUsage, + Rule::SuspiciousEvalUsage, + Rule::SuspiciousMarkSafeUsage, + Rule::SuspiciousURLOpenUsage, + Rule::SuspiciousNonCryptographicRandomUsage, + Rule::SuspiciousTelnetUsage, + Rule::SuspiciousXMLCElementTreeUsage, + Rule::SuspiciousXMLElementTreeUsage, + Rule::SuspiciousXMLExpatReaderUsage, + Rule::SuspiciousXMLExpatBuilderUsage, + Rule::SuspiciousXMLSaxUsage, + Rule::SuspiciousXMLMiniDOMUsage, + Rule::SuspiciousXMLPullDOMUsage, + Rule::SuspiciousXMLETreeUsage, + Rule::SuspiciousFTPLibUsage, + Rule::SuspiciousUnverifiedContextUsage, + ]) { + flake8_bandit::rules::suspicious_function_reference(checker, expr); + } // Ex) List[...] if checker.any_enabled(&[ @@ -209,8 +274,8 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { { if checker.enabled(Rule::FutureRewritableTypeAnnotation) { if !checker.semantic.future_annotations_or_stub() - && checker.settings.target_version < PythonVersion::Py39 - && checker.settings.target_version >= PythonVersion::Py37 + && checker.target_version() < PythonVersion::PY39 + && checker.target_version() >= PythonVersion::PY37 && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing { @@ -219,8 +284,8 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } if checker.enabled(Rule::NonPEP585Annotation) { if checker.source_type.is_stub() - || checker.settings.target_version >= PythonVersion::Py39 - || (checker.settings.target_version >= PythonVersion::Py37 + || checker.target_version() >= PythonVersion::PY39 + || (checker.target_version() >= PythonVersion::PY37 && checker.semantic.future_annotations_or_stub() && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing) @@ -251,6 +316,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { ); } } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_expr(checker, expr); + } if checker.enabled(Rule::MixedCaseVariableInGlobalScope) { if matches!(checker.semantic.current_scope().kind, ScopeKind::Module) { pep8_naming::rules::mixed_case_variable_in_global_scope( @@ -275,11 +343,36 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::UndocumentedWarn) { flake8_logging::rules::undocumented_warn(checker, expr); } - if checker.enabled(Rule::LoadBeforeGlobalDeclaration) { - pylint::rules::load_before_global_declaration(checker, id, expr); - } } Expr::Attribute(attribute) => { + if attribute.ctx == ExprContext::Load { + if checker.any_enabled(&[ + Rule::SuspiciousPickleUsage, + Rule::SuspiciousMarshalUsage, + Rule::SuspiciousInsecureHashUsage, + Rule::SuspiciousInsecureCipherUsage, + Rule::SuspiciousInsecureCipherModeUsage, + Rule::SuspiciousMktempUsage, + Rule::SuspiciousEvalUsage, + Rule::SuspiciousMarkSafeUsage, + Rule::SuspiciousURLOpenUsage, + Rule::SuspiciousNonCryptographicRandomUsage, + Rule::SuspiciousTelnetUsage, + Rule::SuspiciousXMLCElementTreeUsage, + Rule::SuspiciousXMLElementTreeUsage, + Rule::SuspiciousXMLExpatReaderUsage, + Rule::SuspiciousXMLExpatBuilderUsage, + Rule::SuspiciousXMLSaxUsage, + Rule::SuspiciousXMLMiniDOMUsage, + Rule::SuspiciousXMLPullDOMUsage, + Rule::SuspiciousXMLETreeUsage, + Rule::SuspiciousFTPLibUsage, + Rule::SuspiciousUnverifiedContextUsage, + ]) { + flake8_bandit::rules::suspicious_function_reference(checker, expr); + } + } + // Ex) typing.List[...] if checker.any_enabled(&[ Rule::FutureRewritableTypeAnnotation, @@ -288,8 +381,8 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if let Some(replacement) = typing::to_pep585_generic(expr, &checker.semantic) { if checker.enabled(Rule::FutureRewritableTypeAnnotation) { if !checker.semantic.future_annotations_or_stub() - && checker.settings.target_version < PythonVersion::Py39 - && checker.settings.target_version >= PythonVersion::Py37 + && checker.target_version() < PythonVersion::PY39 + && checker.target_version() >= PythonVersion::PY37 && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing { @@ -300,8 +393,8 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } if checker.enabled(Rule::NonPEP585Annotation) { if checker.source_type.is_stub() - || checker.settings.target_version >= PythonVersion::Py39 - || (checker.settings.target_version >= PythonVersion::Py37 + || checker.target_version() >= PythonVersion::PY39 + || (checker.target_version() >= PythonVersion::PY37 && checker.semantic.future_annotations_or_stub() && checker.semantic.in_annotation() && !checker.settings.pyupgrade.keep_runtime_typing) @@ -315,7 +408,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { refurb::rules::regex_flag_alias(checker, expr); } if checker.enabled(Rule::DatetimeTimezoneUTC) { - if checker.settings.target_version >= PythonVersion::Py311 { + if checker.target_version() >= PythonVersion::PY311 { pyupgrade::rules::datetime_utc_alias(checker, expr); } } @@ -337,6 +430,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::SixPY3) { flake8_2020::rules::name_or_attribute(checker, expr); } + if checker.enabled(Rule::DatetimeMinMax) { + flake8_datetimez::rules::datetime_min_max(checker, expr); + } if checker.enabled(Rule::BannedApi) { flake8_tidy_imports::rules::banned_attribute_access(checker, expr); } @@ -355,6 +451,18 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::ByteStringUsage) { flake8_pyi::rules::bytestring_attribute(checker, expr); } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_expr(checker, expr); + } + if checker.enabled(Rule::Airflow3SuggestedUpdate) { + airflow::rules::airflow_3_0_suggested_update_expr(checker, expr); + } + if checker.enabled(Rule::Airflow3MovedToProvider) { + airflow::rules::moved_to_provider_in_3(checker, expr); + } + if checker.enabled(Rule::Airflow3SuggestedToMoveToProvider) { + airflow::rules::suggested_to_move_to_provider_in_3(checker, expr); + } } Expr::Call( call @ ast::ExprCall { @@ -384,6 +492,8 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { Rule::StaticJoinToFString, // refurb Rule::HashlibDigestHex, + // flake8-simplify + Rule::SplitStaticString, ]) { if let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func.as_ref() { let attr = attr.as_str(); @@ -401,13 +511,23 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { string_value.to_str(), ); } + } else if matches!(attr, "split" | "rsplit") { + // "...".split(...) call + if checker.enabled(Rule::SplitStaticString) { + flake8_simplify::rules::split_static_string( + checker, + attr, + call, + string_value, + ); + } } else if attr == "format" { // "...".format(...) call let location = expr.range(); match pyflakes::format::FormatSummary::try_from(string_value.to_str()) { Err(e) => { if checker.enabled(Rule::StringDotFormatInvalidFormat) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::StringDotFormatInvalidFormat { message: pyflakes::format::error_to_string(&e), }, @@ -461,6 +581,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::SuperWithoutBrackets) { pylint::rules::super_without_brackets(checker, func); } + if checker.enabled(Rule::LenTest) { + pylint::rules::len_test(checker, call); + } if checker.enabled(Rule::BitCount) { refurb::rules::bit_count(checker, call); } @@ -499,12 +622,12 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { pyupgrade::rules::os_error_alias_call(checker, func); } if checker.enabled(Rule::TimeoutErrorAlias) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { pyupgrade::rules::timeout_error_alias_call(checker, func); } } if checker.enabled(Rule::NonPEP604Isinstance) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { pyupgrade::rules::use_pep604_isinstance(checker, expr, func, args); } } @@ -579,7 +702,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { ); } if checker.enabled(Rule::ZipWithoutExplicitStrict) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { flake8_bugbear::rules::zip_without_explicit_strict(checker, call); } } @@ -715,7 +838,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { flake8_comprehensions::rules::unnecessary_literal_within_dict_call(checker, call); } if checker.enabled(Rule::UnnecessaryListCall) { - flake8_comprehensions::rules::unnecessary_list_call(checker, expr, func, args); + flake8_comprehensions::rules::unnecessary_list_call(checker, expr, call); } if checker.enabled(Rule::UnnecessaryCallAroundSorted) { flake8_comprehensions::rules::unnecessary_call_around_sorted( @@ -731,13 +854,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { flake8_comprehensions::rules::unnecessary_subscript_reversal(checker, call); } if checker.enabled(Rule::UnnecessaryMap) { - flake8_comprehensions::rules::unnecessary_map( - checker, - expr, - checker.semantic.current_expression_parent(), - func, - args, - ); + flake8_comprehensions::rules::unnecessary_map(checker, call); } if checker.enabled(Rule::UnnecessaryComprehensionInCall) { flake8_comprehensions::rules::unnecessary_comprehension_in_call( @@ -795,13 +912,16 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { pylint::rules::unnecessary_direct_lambda_call(checker, expr, func); } if checker.enabled(Rule::SysExitAlias) { - pylint::rules::sys_exit_alias(checker, func); + pylint::rules::sys_exit_alias(checker, call); } if checker.enabled(Rule::BadOpenMode) { pylint::rules::bad_open_mode(checker, call); } if checker.enabled(Rule::BadStrStripCall) { - pylint::rules::bad_str_strip_call(checker, func, args); + pylint::rules::bad_str_strip_call(checker, call); + } + if checker.enabled(Rule::ShallowCopyEnviron) { + pylint::rules::shallow_copy_environ(checker, call); } if checker.enabled(Rule::InvalidEnvvarDefault) { pylint::rules::invalid_envvar_default(checker, call); @@ -817,22 +937,21 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } if checker.enabled(Rule::PytestPatchWithLambda) { if let Some(diagnostic) = flake8_pytest_style::rules::patch_with_lambda(call) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } + if checker.any_enabled(&[ + Rule::PytestParametrizeNamesWrongType, + Rule::PytestParametrizeValuesWrongType, + Rule::PytestDuplicateParametrizeTestCases, + ]) { + flake8_pytest_style::rules::parametrize(checker, call); + } if checker.enabled(Rule::PytestUnittestAssertion) { - if let Some(diagnostic) = flake8_pytest_style::rules::unittest_assertion( - checker, expr, func, args, keywords, - ) { - checker.diagnostics.push(diagnostic); - } + flake8_pytest_style::rules::unittest_assertion(checker, expr, func, args, keywords); } if checker.enabled(Rule::PytestUnittestRaisesAssertion) { - if let Some(diagnostic) = - flake8_pytest_style::rules::unittest_raises_assertion(checker, call) - { - checker.diagnostics.push(diagnostic); - } + flake8_pytest_style::rules::unittest_raises_assertion_call(checker, call); } if checker.enabled(Rule::SubprocessPopenPreexecFn) { pylint::rules::subprocess_popen_preexec_fn(checker, call); @@ -849,11 +968,14 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { ]) { flake8_pytest_style::rules::raises_call(checker, call); } + if checker.any_enabled(&[Rule::PytestWarnsWithoutWarning, Rule::PytestWarnsTooBroad]) { + flake8_pytest_style::rules::warns_call(checker, call); + } if checker.enabled(Rule::PytestFailWithoutMessage) { flake8_pytest_style::rules::fail_call(checker, call); } if checker.enabled(Rule::ZipInsteadOfPairwise) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { ruff::rules::zip_instead_of_pairwise(checker, call); } } @@ -908,6 +1030,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { Rule::OsPathIsabs, Rule::OsPathJoin, Rule::OsPathBasename, + Rule::OsPathDirname, Rule::OsPathSamefile, Rule::OsPathSplitext, Rule::BuiltinOpen, @@ -917,11 +1040,12 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { Rule::OsPathGetmtime, Rule::OsPathGetctime, Rule::Glob, + Rule::OsListdir, ]) { flake8_use_pathlib::rules::replaceable_by_pathlib(checker, call); } if checker.enabled(Rule::PathConstructorCurrentDirectory) { - flake8_use_pathlib::rules::path_constructor_current_directory(checker, expr, func); + flake8_use_pathlib::rules::path_constructor_current_directory(checker, call); } if checker.enabled(Rule::OsSepSplit) { flake8_use_pathlib::rules::os_sep_split(checker, call); @@ -974,6 +1098,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::ExceptionWithoutExcInfo) { flake8_logging::rules::exception_without_exc_info(checker, call); } + if checker.enabled(Rule::RootLoggerCall) { + flake8_logging::rules::root_logger_call(checker, call); + } if checker.enabled(Rule::IsinstanceTypeNone) { refurb::rules::isinstance_type_none(checker, call); } @@ -1013,6 +1140,60 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::IntOnSlicedStr) { refurb::rules::int_on_sliced_str(checker, call); } + if checker.enabled(Rule::UnsafeMarkupUse) { + flake8_bandit::rules::unsafe_markup_call(checker, call); + } + if checker.enabled(Rule::MapIntVersionParsing) { + ruff::rules::map_int_version_parsing(checker, call); + } + if checker.enabled(Rule::UnrawRePattern) { + ruff::rules::unraw_re_pattern(checker, call); + } + if checker.enabled(Rule::AirflowDagNoScheduleArgument) { + airflow::rules::dag_no_schedule_argument(checker, expr); + } + if checker.enabled(Rule::UnnecessaryRegularExpression) { + ruff::rules::unnecessary_regular_expression(checker, call); + } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_expr(checker, expr); + } + if checker.enabled(Rule::Airflow3SuggestedUpdate) { + airflow::rules::airflow_3_0_suggested_update_expr(checker, expr); + } + if checker.enabled(Rule::UnnecessaryCastToInt) { + ruff::rules::unnecessary_cast_to_int(checker, call); + } + if checker.enabled(Rule::InvalidPathlibWithSuffix) { + flake8_use_pathlib::rules::invalid_pathlib_with_suffix(checker, call); + } + if checker.enabled(Rule::BatchedWithoutExplicitStrict) { + flake8_bugbear::rules::batched_without_explicit_strict(checker, call); + } + if checker.enabled(Rule::PytestRaisesAmbiguousPattern) { + ruff::rules::pytest_raises_ambiguous_pattern(checker, call); + } + if checker.enabled(Rule::FalsyDictGetFallback) { + ruff::rules::falsy_dict_get_fallback(checker, expr); + } + if checker.enabled(Rule::UnnecessaryRound) { + ruff::rules::unnecessary_round(checker, call); + } + if checker.enabled(Rule::UnnecessaryEmptyIterableWithinDequeCall) { + ruff::rules::unnecessary_literal_within_deque_call(checker, call); + } + if checker.enabled(Rule::StarmapZip) { + ruff::rules::starmap_zip(checker, call); + } + if checker.enabled(Rule::LogExceptionOutsideExceptHandler) { + flake8_logging::rules::log_exception_outside_except_handler(checker, call); + } + if checker.enabled(Rule::ExcInfoOutsideExceptHandler) { + flake8_logging::rules::exc_info_outside_except_handler(checker, call); + } + if checker.enabled(Rule::FromisoformatReplaceZ) { + refurb::rules::fromisoformat_replace_z(checker, call); + } } Expr::Dict(dict) => { if checker.any_enabled(&[ @@ -1031,17 +1212,11 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } } Expr::Yield(_) => { - if checker.enabled(Rule::YieldOutsideFunction) { - pyflakes::rules::yield_outside_function(checker, expr); - } if checker.enabled(Rule::YieldInInit) { pylint::rules::yield_in_init(checker, expr); } } Expr::YieldFrom(yield_from) => { - if checker.enabled(Rule::YieldOutsideFunction) { - pyflakes::rules::yield_outside_function(checker, expr); - } if checker.enabled(Rule::YieldInInit) { pylint::rules::yield_in_init(checker, expr); } @@ -1049,14 +1224,6 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { pylint::rules::yield_from_in_async_function(checker, yield_from); } } - Expr::Await(_) => { - if checker.enabled(Rule::YieldOutsideFunction) { - pyflakes::rules::yield_outside_function(checker, expr); - } - if checker.enabled(Rule::AwaitOutsideAsync) { - pylint::rules::await_outside_async(checker, expr); - } - } Expr::FString(f_string_expr @ ast::ExprFString { value, .. }) => { if checker.enabled(Rule::FStringMissingPlaceholders) { pyflakes::rules::f_string_missing_placeholders(checker, f_string_expr); @@ -1118,7 +1285,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { .. }) => { if checker.enabled(Rule::PercentFormatUnsupportedFormatCharacter) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::PercentFormatUnsupportedFormatCharacter { char: c, }, @@ -1128,7 +1295,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } Err(e) => { if checker.enabled(Rule::PercentFormatInvalidFormat) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::PercentFormatInvalidFormat { message: e.to_string(), }, @@ -1202,7 +1369,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { checker.locator, checker.settings, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CollectionLiteralConcatenation) { @@ -1219,7 +1386,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { // Ex) `str | None` if checker.enabled(Rule::FutureRequiredTypeAnnotation) { if !checker.semantic.future_annotations_or_stub() - && checker.settings.target_version < PythonVersion::Py310 + && checker.target_version() < PythonVersion::PY310 && checker.semantic.in_annotation() && checker.semantic.in_runtime_evaluated_annotation() && !checker.semantic.in_string_type_definition() @@ -1256,6 +1423,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::RuntimeStringUnion) { flake8_type_checking::rules::runtime_string_union(checker, expr); } + if checker.enabled(Rule::NoneNotAtEndOfUnion) { + ruff::rules::none_not_at_end_of_union(checker, expr); + } } } Expr::UnaryOp( @@ -1334,6 +1504,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::NanComparison) { pylint::rules::nan_comparison(checker, left, comparators); } + if checker.enabled(Rule::InEmptyCollection) { + ruff::rules::in_empty_collection(checker, compare); + } if checker.enabled(Rule::InDictKeys) { flake8_simplify::rules::key_in_dict_compare(checker, compare); } @@ -1355,9 +1528,6 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { if checker.enabled(Rule::SingleItemMembershipTest) { refurb::rules::single_item_membership_test(checker, expr, left, ops, comparators); } - if checker.enabled(Rule::HardcodedStringCharset) { - refurb::rules::hardcoded_string_charset_comparison(checker, compare); - } } Expr::NumberLiteral(number_literal @ ast::ExprNumberLiteral { .. }) => { if checker.source_type.is_stub() && checker.enabled(Rule::NumericLiteralTooLong) { @@ -1374,7 +1544,7 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { } } if checker.enabled(Rule::MissingFStringSyntax) { - for string_literal in value.as_slice() { + for string_literal in value { ruff::rules::missing_fstring_syntax(checker, string_literal); } } @@ -1577,11 +1747,14 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) { ruff::rules::parenthesize_chained_logical_operators(checker, bool_op); } } - Expr::Named(..) => { - if checker.enabled(Rule::AssignmentInAssert) { - ruff::rules::assignment_in_assert(checker, expr); + Expr::Lambda(lambda) => { + if checker.enabled(Rule::ReimplementedOperator) { + refurb::rules::reimplemented_operator(checker, &lambda.into()); + } + if checker.enabled(Rule::InvalidArgumentName) { + pep8_naming::rules::invalid_argument_name_lambda(checker, lambda); } } _ => {} - }; + } } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/module.rs b/crates/ruff_linter/src/checkers/ast/analyze/module.rs index e80e052b55b3c..cb897ebf266f7 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/module.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/module.rs @@ -5,7 +5,7 @@ use crate::codes::Rule; use crate::rules::{flake8_bugbear, ruff}; /// Run lint rules over a module. -pub(crate) fn module(suite: &Suite, checker: &mut Checker) { +pub(crate) fn module(suite: &Suite, checker: &Checker) { if checker.enabled(Rule::FStringDocstring) { flake8_bugbear::rules::f_string_docstring(checker, suite); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/parameter.rs b/crates/ruff_linter/src/checkers/ast/analyze/parameter.rs index 6627956a33e9c..253dc603517c9 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/parameter.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/parameter.rs @@ -3,10 +3,10 @@ use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::codes::Rule; -use crate::rules::{flake8_builtins, pep8_naming, pycodestyle}; +use crate::rules::{flake8_builtins, pycodestyle}; /// Run lint rules over a [`Parameter`] syntax node. -pub(crate) fn parameter(parameter: &Parameter, checker: &mut Checker) { +pub(crate) fn parameter(parameter: &Parameter, checker: &Checker) { if checker.enabled(Rule::AmbiguousVariableName) { pycodestyle::rules::ambiguous_variable_name( checker, @@ -14,15 +14,6 @@ pub(crate) fn parameter(parameter: &Parameter, checker: &mut Checker) { parameter.name.range(), ); } - if checker.enabled(Rule::InvalidArgumentName) { - if let Some(diagnostic) = pep8_naming::rules::invalid_argument_name( - ¶meter.name, - parameter, - &checker.settings.pep8_naming.ignore_names, - ) { - checker.diagnostics.push(diagnostic); - } - } if checker.enabled(Rule::BuiltinArgumentShadowing) { flake8_builtins::rules::builtin_argument_shadowing(checker, parameter); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/parameters.rs b/crates/ruff_linter/src/checkers/ast/analyze/parameters.rs index 41d525197bd67..a9d2c949b7962 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/parameters.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/parameters.rs @@ -5,7 +5,7 @@ use crate::codes::Rule; use crate::rules::{flake8_bugbear, flake8_pyi, ruff}; /// Run lint rules over a [`Parameters`] syntax node. -pub(crate) fn parameters(parameters: &Parameters, checker: &mut Checker) { +pub(crate) fn parameters(parameters: &Parameters, checker: &Checker) { if checker.enabled(Rule::FunctionCallInDefaultArgument) { flake8_bugbear::rules::function_call_in_argument_default(checker, parameters); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/statement.rs b/crates/ruff_linter/src/checkers/ast/analyze/statement.rs index 6e6e572993f23..84563726a21ee 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/statement.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/statement.rs @@ -14,7 +14,7 @@ use crate::rules::{ flake8_slots, flake8_tidy_imports, flake8_type_checking, mccabe, pandas_vet, pep8_naming, perflint, pycodestyle, pyflakes, pygrep_hooks, pylint, pyupgrade, refurb, ruff, tryceratops, }; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// Run lint rules over a [`Stmt`] syntax node. pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { @@ -39,7 +39,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if !checker.semantic.scope_id.is_global() { for name in names { if checker.semantic.nonlocal(name).is_none() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pylint::rules::NonlocalWithoutBinding { name: name.to_string(), }, @@ -59,7 +59,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { stmt, &mut checker.semantic.current_statements().skip(1), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -69,7 +69,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { stmt, &mut checker.semantic.current_statements().skip(1), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -81,7 +81,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { returns, parameters, body, - type_params, + type_params: _, range: _, }, ) => { @@ -99,7 +99,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } if checker.enabled(Rule::AmbiguousFunctionName) { if let Some(diagnostic) = pycodestyle::rules::ambiguous_function_name(name) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::InvalidBoolReturnType) { @@ -128,7 +128,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, &checker.semantic, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.source_type.is_stub() { @@ -159,24 +159,12 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::GeneratorReturnFromIterMethod) { flake8_pyi::rules::bad_generator_return_type(function_def, checker); } - if checker.enabled(Rule::CustomTypeVarReturnType) { - flake8_pyi::rules::custom_type_var_return_type( - checker, - name, - decorator_list, - returns.as_ref().map(AsRef::as_ref), - parameters, - type_params.as_deref(), - ); - } if checker.source_type.is_stub() { if checker.enabled(Rule::StrOrReprDefinedInStub) { flake8_pyi::rules::str_or_repr_defined_in_stub(checker, stmt); } } - if checker.source_type.is_stub() - || checker.settings.target_version >= PythonVersion::Py311 - { + if checker.source_type.is_stub() || checker.target_version() >= PythonVersion::PY311 { if checker.enabled(Rule::NoReturnArgumentAnnotationInStub) { flake8_pyi::rules::no_return_argument_annotation(checker, parameters); } @@ -187,8 +175,8 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::RedundantNumericUnion) { flake8_pyi::rules::redundant_numeric_union(checker, parameters); } - if checker.enabled(Rule::PrePep570PositionalArgument) { - flake8_pyi::rules::pre_pep570_positional_argument(checker, function_def); + if checker.enabled(Rule::Pep484StylePositionalOnlyParameter) { + flake8_pyi::rules::pep_484_positional_parameter(checker, function_def); } if checker.enabled(Rule::DunderFunctionName) { if let Some(diagnostic) = pep8_naming::rules::dunder_function_name( @@ -197,19 +185,19 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { name, &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::GlobalStatement) { pylint::rules::global_statement(checker, name); } if checker.enabled(Rule::LRUCacheWithoutParameters) { - if checker.settings.target_version >= PythonVersion::Py38 { + if checker.target_version() >= PythonVersion::PY38 { pyupgrade::rules::lru_cache_without_parameters(checker, decorator_list); } } if checker.enabled(Rule::LRUCacheWithMaxsizeNone) { - if checker.settings.target_version >= PythonVersion::Py39 { + if checker.target_version() >= PythonVersion::PY39 { pyupgrade::rules::lru_cache_with_maxsize_none(checker, decorator_list); } } @@ -249,7 +237,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { body, checker.settings.mccabe.max_complexity, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::HardcodedPasswordDefault) { @@ -275,7 +263,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { body, checker.settings.pylint.max_returns, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::TooManyBranches) { @@ -284,7 +272,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { body, checker.settings.pylint.max_branches, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::TooManyStatements) { @@ -293,15 +281,13 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { body, checker.settings.pylint.max_statements, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.any_enabled(&[ Rule::PytestFixtureIncorrectParenthesesStyle, Rule::PytestFixturePositionalArgs, Rule::PytestExtraneousScopeFunction, - Rule::PytestMissingFixtureNameUnderscore, - Rule::PytestIncorrectFixtureNameUnderscore, Rule::PytestFixtureParamWithoutValue, Rule::PytestDeprecatedYieldFixture, Rule::PytestFixtureFinalizerCallback, @@ -311,7 +297,6 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { ]) { flake8_pytest_style::rules::fixture( checker, - stmt, name, parameters, returns.as_deref(), @@ -319,13 +304,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { body, ); } - if checker.any_enabled(&[ - Rule::PytestParametrizeNamesWrongType, - Rule::PytestParametrizeValuesWrongType, - Rule::PytestDuplicateParametrizeTestCases, - ]) { - flake8_pytest_style::rules::parametrize(checker, decorator_list); - } + if checker.any_enabled(&[ Rule::PytestIncorrectMarkParenthesesStyle, Rule::PytestUseFixturesWithoutParameters, @@ -368,6 +347,10 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::AsyncFunctionWithTimeout) { flake8_async::rules::async_function_with_timeout(checker, function_def); } + #[cfg(any(feature = "test-rules", test))] + if checker.enabled(Rule::UnreachableCode) { + pylint::rules::in_function(checker, name, body); + } if checker.enabled(Rule::ReimplementedOperator) { refurb::rules::reimplemented_operator(checker, &function_def.into()); } @@ -383,11 +366,20 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::PostInitDefault) { ruff::rules::post_init_default(checker, function_def); } + if checker.enabled(Rule::PytestParameterWithDefaultArgument) { + flake8_pytest_style::rules::parameter_with_default_argument(checker, function_def); + } + if checker.enabled(Rule::Airflow3Removal) { + airflow::rules::airflow_3_removal_function_def(checker, function_def); + } + if checker.enabled(Rule::NonPEP695GenericFunction) { + pyupgrade::rules::non_pep695_generic_function(checker, function_def); + } + if checker.enabled(Rule::InvalidArgumentName) { + pep8_naming::rules::invalid_argument_name_function(checker, function_def); + } } Stmt::Return(_) => { - if checker.enabled(Rule::ReturnOutsideFunction) { - pyflakes::rules::return_outside_function(checker, stmt); - } if checker.enabled(Rule::ReturnInInit) { pylint::rules::return_in_init(checker, stmt); } @@ -428,6 +420,12 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::EqWithoutHash) { pylint::rules::object_without_hash_method(checker, class_def); } + if checker.enabled(Rule::ClassAsDataStructure) { + flake8_bugbear::rules::class_as_data_structure(checker, class_def); + } + if checker.enabled(Rule::RedefinedSlotsInSubclass) { + pylint::rules::redefined_slots_in_subclass(checker, class_def); + } if checker.enabled(Rule::TooManyPublicMethods) { pylint::rules::too_many_public_methods( checker, @@ -442,7 +440,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { pyupgrade::rules::useless_object_inheritance(checker, class_def); } if checker.enabled(Rule::ReplaceStrEnum) { - if checker.settings.target_version >= PythonVersion::Py311 { + if checker.target_version() >= PythonVersion::PY311 { pyupgrade::rules::replace_str_enum(checker, class_def); } } @@ -451,7 +449,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } if checker.enabled(Rule::AmbiguousClassName) { if let Some(diagnostic) = pycodestyle::rules::ambiguous_class_name(name) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::InvalidClassName) { @@ -460,7 +458,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { name, &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::ErrorSuffixOnExceptionName) { @@ -470,7 +468,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { name, &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if !checker.source_type.is_stub() { @@ -510,15 +508,6 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::NonUniqueEnums) { flake8_pie::rules::non_unique_enums(checker, stmt, body); } - if checker.enabled(Rule::MutableClassDefault) { - ruff::rules::mutable_class_default(checker, class_def); - } - if checker.enabled(Rule::MutableDataclassDefault) { - ruff::rules::mutable_dataclass_default(checker, class_def); - } - if checker.enabled(Rule::FunctionCallInDataclassDefaultArgument) { - ruff::rules::function_call_in_dataclass_default(checker, class_def); - } if checker.enabled(Rule::FStringDocstring) { flake8_bugbear::rules::f_string_docstring(checker, body); } @@ -549,6 +538,21 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::WhitespaceAfterDecorator) { pycodestyle::rules::whitespace_after_decorator(checker, decorator_list); } + if checker.enabled(Rule::SubclassBuiltin) { + refurb::rules::subclass_builtin(checker, class_def); + } + if checker.enabled(Rule::DataclassEnum) { + ruff::rules::dataclass_enum(checker, class_def); + } + if checker.enabled(Rule::NonPEP695GenericClass) { + pyupgrade::rules::non_pep695_generic_class(checker, class_def); + } + if checker.enabled(Rule::ClassWithMixedTypeVars) { + ruff::rules::class_with_mixed_type_vars(checker, class_def); + } + if checker.enabled(Rule::ImplicitClassVarInDataclass) { + ruff::rules::implicit_class_var_in_dataclass(checker, class_def); + } } Stmt::Import(ast::StmtImport { names, range: _ }) => { if checker.enabled(Rule::MultipleImportsOnOneLine) { @@ -594,27 +598,20 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { flake8_bandit::rules::suspicious_imports(checker, stmt); } + if checker.enabled(Rule::BannedModuleLevelImports) { + flake8_tidy_imports::rules::banned_module_level_imports(checker, stmt); + } + for alias in names { if checker.enabled(Rule::NonAsciiImportName) { pylint::rules::non_ascii_module_import(checker, alias); } - // TODO(charlie): Remove when stabilizing A004. - if let Some(asname) = &alias.asname { - if checker.settings.preview.is_disabled() - && checker.enabled(Rule::BuiltinVariableShadowing) - { - flake8_builtins::rules::builtin_variable_shadowing( - checker, - asname, - asname.range(), - ); - } - } + if checker.enabled(Rule::Debugger) { if let Some(diagnostic) = flake8_debugger::rules::debugger_import(stmt, None, &alias.name) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::BannedApi) { @@ -629,18 +626,6 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { ); } - if checker.enabled(Rule::BannedModuleLevelImports) { - flake8_tidy_imports::rules::banned_module_level_imports( - checker, - &flake8_tidy_imports::matchers::NameMatchPolicy::MatchNameOrParent( - flake8_tidy_imports::matchers::MatchNameOrParent { - module: &alias.name, - }, - ), - &alias, - ); - } - if !checker.source_type.is_stub() { if checker.enabled(Rule::UselessImportAlias) { pylint::rules::useless_import_alias(checker, alias); @@ -653,11 +638,11 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if let Some(diagnostic) = pylint::rules::import_self(alias, checker.module.qualified_name()) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if let Some(asname) = &alias.asname { - let name = alias.name.split('.').last().unwrap(); + let name = alias.name.split('.').next_back().unwrap(); if checker.enabled(Rule::ConstantImportedAsNonConstant) { if let Some(diagnostic) = pep8_naming::rules::constant_imported_as_non_constant( @@ -668,7 +653,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::LowercaseImportedAsNonLowercase) { @@ -681,7 +666,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsLowercase) { @@ -694,7 +679,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsConstant) { @@ -705,14 +690,14 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { stmt, &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsAcronym) { if let Some(diagnostic) = pep8_naming::rules::camelcase_imported_as_acronym( name, asname, alias, stmt, checker, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -726,7 +711,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.flake8_import_conventions.banned_aliases, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -736,7 +721,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &alias.name, alias.asname.as_deref(), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::BuiltinImportShadowing) { @@ -775,7 +760,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } } if checker.enabled(Rule::UnnecessaryFutureImport) { - if checker.settings.target_version >= PythonVersion::Py37 { + if checker.target_version() >= PythonVersion::PY37 { if let Some("__future__") = module { pyupgrade::rules::unnecessary_future_import(checker, stmt, names); } @@ -845,41 +830,14 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } } if checker.enabled(Rule::BannedModuleLevelImports) { - if let Some(module) = helpers::resolve_imported_module_path( - level, - module, - checker.module.qualified_name(), - ) { - flake8_tidy_imports::rules::banned_module_level_imports( - checker, - &flake8_tidy_imports::matchers::NameMatchPolicy::MatchNameOrParent( - flake8_tidy_imports::matchers::MatchNameOrParent { module: &module }, - ), - &stmt, - ); - - for alias in names { - if &alias.name == "*" { - continue; - } - flake8_tidy_imports::rules::banned_module_level_imports( - checker, - &flake8_tidy_imports::matchers::NameMatchPolicy::MatchName( - flake8_tidy_imports::matchers::MatchName { - module: &module, - member: &alias.name, - }, - ), - &alias, - ); - } - } + flake8_tidy_imports::rules::banned_module_level_imports(checker, stmt); } + if checker.enabled(Rule::PytestIncorrectPytestImport) { if let Some(diagnostic) = flake8_pytest_style::rules::import_from(stmt, module, level) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.source_type.is_stub() { @@ -892,18 +850,10 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::FutureFeatureNotDefined) { pyflakes::rules::future_feature_not_defined(checker, alias); } - if checker.enabled(Rule::LateFutureImport) { - if checker.semantic.seen_futures_boundary() { - checker.diagnostics.push(Diagnostic::new( - pyflakes::rules::LateFutureImport, - stmt.range(), - )); - } - } } else if &alias.name == "*" { if checker.enabled(Rule::UndefinedLocalWithNestedImportStarUsage) { if !matches!(checker.semantic.current_scope().kind, ScopeKind::Module) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::UndefinedLocalWithNestedImportStarUsage { name: helpers::format_import_from(level, module).to_string(), }, @@ -912,26 +862,13 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } } if checker.enabled(Rule::UndefinedLocalWithImportStar) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::UndefinedLocalWithImportStar { name: helpers::format_import_from(level, module).to_string(), }, stmt.range(), )); } - } else { - // TODO(charlie): Remove when stabilizing A004. - if let Some(asname) = &alias.asname { - if checker.settings.preview.is_disabled() - && checker.enabled(Rule::BuiltinVariableShadowing) - { - flake8_builtins::rules::builtin_variable_shadowing( - checker, - asname, - asname.range(), - ); - } - } } if checker.enabled(Rule::RelativeImports) { if let Some(diagnostic) = flake8_tidy_imports::rules::banned_relative_import( @@ -942,14 +879,14 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { checker.module.qualified_name(), checker.settings.flake8_tidy_imports.ban_relative_imports, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::Debugger) { if let Some(diagnostic) = flake8_debugger::rules::debugger_import(stmt, module, &alias.name) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::BannedImportAlias) { @@ -964,7 +901,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.flake8_import_conventions.banned_aliases, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -979,7 +916,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::LowercaseImportedAsNonLowercase) { @@ -992,7 +929,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsLowercase) { @@ -1005,7 +942,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsConstant) { @@ -1016,7 +953,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { stmt, &checker.settings.pep8_naming.ignore_names, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::CamelcaseImportedAsAcronym) { @@ -1027,12 +964,12 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { stmt, checker, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if !checker.source_type.is_stub() { if checker.enabled(Rule::UselessImportAlias) { - pylint::rules::useless_import_alias(checker, alias); + pylint::rules::useless_import_from_alias(checker, alias, module, level); } } } @@ -1047,7 +984,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { names, checker.module.qualified_name(), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::BannedImportFrom) { @@ -1056,7 +993,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { &helpers::format_import_from(level, module), &checker.settings.flake8_import_conventions.banned_from, ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::ByteStringUsage) { @@ -1089,7 +1026,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { } } if checker.enabled(Rule::TimeoutErrorAlias) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { if let Some(item) = exc { pyupgrade::rules::timeout_error_alias_raise(checker, item); } @@ -1213,50 +1150,55 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { flake8_pyi::rules::unrecognized_platform(checker, test); } } - if checker.any_enabled(&[Rule::BadVersionInfoComparison, Rule::BadVersionInfoOrder]) - { - fn bad_version_info_comparison( - checker: &mut Checker, - test: &Expr, - has_else_clause: bool, - ) { - if let Expr::BoolOp(ast::ExprBoolOp { values, .. }) = test { - for value in values { - flake8_pyi::rules::bad_version_info_comparison( - checker, - value, - has_else_clause, - ); - } - } else { + if checker.enabled(Rule::ComplexIfStatementInStub) { + if let Expr::BoolOp(ast::ExprBoolOp { values, .. }) = test.as_ref() { + for value in values { + flake8_pyi::rules::complex_if_statement_in_stub(checker, value); + } + } else { + flake8_pyi::rules::complex_if_statement_in_stub(checker, test); + } + } + } + if checker.any_enabled(&[Rule::BadVersionInfoComparison, Rule::BadVersionInfoOrder]) { + fn bad_version_info_comparison( + checker: &Checker, + test: &Expr, + has_else_clause: bool, + ) { + if let Expr::BoolOp(ast::ExprBoolOp { values, .. }) = test { + for value in values { flake8_pyi::rules::bad_version_info_comparison( checker, - test, + value, has_else_clause, ); } + } else { + flake8_pyi::rules::bad_version_info_comparison( + checker, + test, + has_else_clause, + ); } + } - let has_else_clause = - elif_else_clauses.iter().any(|clause| clause.test.is_none()); + let has_else_clause = elif_else_clauses.iter().any(|clause| clause.test.is_none()); - bad_version_info_comparison(checker, test.as_ref(), has_else_clause); - for clause in elif_else_clauses { - if let Some(test) = clause.test.as_ref() { - bad_version_info_comparison(checker, test, has_else_clause); - } - } - } - if checker.enabled(Rule::ComplexIfStatementInStub) { - if let Expr::BoolOp(ast::ExprBoolOp { values, .. }) = test.as_ref() { - for value in values { - flake8_pyi::rules::complex_if_statement_in_stub(checker, value); - } - } else { - flake8_pyi::rules::complex_if_statement_in_stub(checker, test); + bad_version_info_comparison(checker, test.as_ref(), has_else_clause); + for clause in elif_else_clauses { + if let Some(test) = clause.test.as_ref() { + bad_version_info_comparison(checker, test, has_else_clause); } } } + + if checker.enabled(Rule::IfKeyInDictDel) { + ruff::rules::if_key_in_dict_del(checker, if_); + } + if checker.enabled(Rule::NeedlessElse) { + ruff::rules::needless_else(checker, if_.into()); + } } Stmt::Assert( assert_stmt @ ast::StmtAssert { @@ -1267,9 +1209,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { ) => { if !checker.semantic.in_type_checking_block() { if checker.enabled(Rule::Assert) { - checker - .diagnostics - .push(flake8_bandit::rules::assert_used(stmt)); + checker.report_diagnostic(flake8_bandit::rules::assert_used(stmt)); } } if checker.enabled(Rule::AssertTuple) { @@ -1298,6 +1238,9 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::AssertWithPrintMessage) { ruff::rules::assert_with_print_message(checker, assert_stmt); } + if checker.enabled(Rule::InvalidAssertMessageLiteralArgument) { + ruff::rules::invalid_assert_message_literal_argument(checker, assert_stmt); + } } Stmt::With(with_stmt @ ast::StmtWith { items, body, .. }) => { if checker.enabled(Rule::TooManyNestedBlocks) { @@ -1309,6 +1252,9 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::PytestRaisesWithMultipleStatements) { flake8_pytest_style::rules::complex_raises(checker, stmt, items, body); } + if checker.enabled(Rule::PytestWarnsWithMultipleStatements) { + flake8_pytest_style::rules::complex_warns(checker, stmt, items, body); + } if checker.enabled(Rule::MultipleWithStatements) { flake8_simplify::rules::multiple_with_statements( checker, @@ -1348,6 +1294,9 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::AsyncBusyWait) { flake8_async::rules::async_busy_wait(checker, while_stmt); } + if checker.enabled(Rule::NeedlessElse) { + ruff::rules::needless_else(checker, while_stmt.into()); + } } Stmt::For( for_stmt @ ast::StmtFor { @@ -1370,6 +1319,8 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { Rule::UnnecessaryEnumerate, Rule::UnusedLoopControlVariable, Rule::YieldInForLoop, + Rule::ManualDictComprehension, + Rule::ManualListComprehension, ]) { checker.analyze.for_loops.push(checker.semantic.snapshot()); } @@ -1394,15 +1345,10 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::DictIterMissingItems) { pylint::rules::dict_iter_missing_items(checker, target, iter); } - if checker.enabled(Rule::ManualListComprehension) { - perflint::rules::manual_list_comprehension(checker, for_stmt); - } if checker.enabled(Rule::ManualListCopy) { perflint::rules::manual_list_copy(checker, for_stmt); } - if checker.enabled(Rule::ManualDictComprehension) { - perflint::rules::manual_dict_comprehension(checker, target, body); - } + if checker.enabled(Rule::ModifiedIteratingSet) { pylint::rules::modified_iterating_set(checker, for_stmt); } @@ -1418,7 +1364,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::ReadlinesInFor) { refurb::rules::readlines_in_for(checker, for_stmt); } - if !is_async { + if !*is_async { if checker.enabled(Rule::ReimplementedBuiltin) { flake8_simplify::rules::convert_for_loop_to_any_all(checker, stmt); } @@ -1431,15 +1377,23 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::ForLoopSetMutations) { refurb::rules::for_loop_set_mutations(checker, for_stmt); } + if checker.enabled(Rule::ForLoopWrites) { + refurb::rules::for_loop_writes_stmt(checker, for_stmt); + } + } + if checker.enabled(Rule::NeedlessElse) { + ruff::rules::needless_else(checker, for_stmt.into()); } } - Stmt::Try(ast::StmtTry { - body, - handlers, - orelse, - finalbody, - .. - }) => { + Stmt::Try( + try_stmt @ ast::StmtTry { + body, + handlers, + orelse, + finalbody, + .. + }, + ) => { if checker.enabled(Rule::TooManyNestedBlocks) { pylint::rules::too_many_nested_blocks(checker, stmt); } @@ -1447,7 +1401,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { flake8_bugbear::rules::jump_statement_in_finally(checker, finalbody); } if checker.enabled(Rule::ContinueInFinally) { - if checker.settings.target_version <= PythonVersion::Py38 { + if checker.target_version() <= PythonVersion::PY38 { pylint::rules::continue_in_finally(checker, finalbody); } } @@ -1455,7 +1409,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if let Some(diagnostic) = pyflakes::rules::default_except_not_last(handlers, checker.locator) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.any_enabled(&[ @@ -1471,7 +1425,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { pyupgrade::rules::os_error_alias_handlers(checker, handlers); } if checker.enabled(Rule::TimeoutErrorAlias) { - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { pyupgrade::rules::timeout_error_alias_handlers(checker, handlers); } } @@ -1506,6 +1460,9 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::ErrorInsteadOfException) { tryceratops::rules::error_instead_of_exception(checker, handlers); } + if checker.enabled(Rule::NeedlessElse) { + ruff::rules::needless_else(checker, try_stmt.into()); + } } Stmt::Assign(assign @ ast::StmtAssign { targets, value, .. }) => { if checker.enabled(Rule::SelfOrClsAssignment) { @@ -1547,12 +1504,9 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { checker, stmt, targets, value, ); } - if checker.enabled(Rule::UnpackedListComprehension) { - pyupgrade::rules::unpacked_list_comprehension(checker, targets, value); - } if checker.enabled(Rule::PandasDfVariableName) { if let Some(diagnostic) = pandas_vet::rules::assignment_to_df(targets) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker @@ -1560,11 +1514,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { .rules .enabled(Rule::AirflowVariableNameTaskIdMismatch) { - if let Some(diagnostic) = - airflow::rules::variable_name_task_id(checker, targets, value) - { - checker.diagnostics.push(diagnostic); - } + airflow::rules::variable_name_task_id(checker, targets, value); } if checker.settings.rules.enabled(Rule::SelfAssigningVariable) { pylint::rules::self_assignment(checker, assign); @@ -1667,6 +1617,15 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if checker.enabled(Rule::NonPEP695TypeAlias) { pyupgrade::rules::non_pep695_type_alias(checker, assign_stmt); } + if checker.enabled(Rule::HardcodedPasswordString) { + if let Some(value) = value.as_deref() { + flake8_bandit::rules::assign_hardcoded_password_string( + checker, + value, + std::slice::from_ref(target), + ); + } + } if checker.settings.rules.enabled(Rule::UnsortedDunderAll) { ruff::rules::sort_dunder_all_ann_assign(checker, assign_stmt); } @@ -1745,7 +1704,7 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { if let Some(diagnostic) = ruff::rules::asyncio_dangling_task(value, checker.semantic()) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if checker.enabled(Rule::RepeatedAppend) { @@ -1755,6 +1714,15 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) { pylint::rules::useless_exception_statement(checker, expr); } } + Stmt::Match(ast::StmtMatch { + subject: _, + cases, + range: _, + }) => { + if checker.enabled(Rule::NanComparison) { + pylint::rules::nan_comparison_match(checker, cases); + } + } _ => {} } } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/string_like.rs b/crates/ruff_linter/src/checkers/ast/analyze/string_like.rs index 88d040acfb473..acd25d9fc73c8 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/string_like.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/string_like.rs @@ -5,7 +5,7 @@ use crate::codes::Rule; use crate::rules::{flake8_bandit, flake8_pyi, flake8_quotes, pycodestyle, ruff}; /// Run lint rules over a [`StringLike`] syntax nodes. -pub(crate) fn string_like(string_like: StringLike, checker: &mut Checker) { +pub(crate) fn string_like(string_like: StringLike, checker: &Checker) { if checker.any_enabled(&[ Rule::AmbiguousUnicodeCharacterString, Rule::AmbiguousUnicodeCharacterDocstring, diff --git a/crates/ruff_linter/src/checkers/ast/analyze/suite.rs b/crates/ruff_linter/src/checkers/ast/analyze/suite.rs index c004ce85ca7f1..f5b56f1081ae9 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/suite.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/suite.rs @@ -6,7 +6,7 @@ use crate::rules::flake8_pie; use crate::rules::refurb; /// Run lint rules over a suite of [`Stmt`] syntax nodes. -pub(crate) fn suite(suite: &[Stmt], checker: &mut Checker) { +pub(crate) fn suite(suite: &[Stmt], checker: &Checker) { if checker.enabled(Rule::UnnecessaryPlaceholder) { flake8_pie::rules::unnecessary_placeholder(checker, suite); } diff --git a/crates/ruff_linter/src/checkers/ast/analyze/unresolved_references.rs b/crates/ruff_linter/src/checkers/ast/analyze/unresolved_references.rs index 22bfd90568eee..dbe2c540ef4d8 100644 --- a/crates/ruff_linter/src/checkers/ast/analyze/unresolved_references.rs +++ b/crates/ruff_linter/src/checkers/ast/analyze/unresolved_references.rs @@ -7,7 +7,7 @@ use crate::codes::Rule; use crate::rules::pyflakes; /// Run lint rules over all [`UnresolvedReference`] entities in the [`SemanticModel`]. -pub(crate) fn unresolved_references(checker: &mut Checker) { +pub(crate) fn unresolved_references(checker: &Checker) { if !checker.any_enabled(&[Rule::UndefinedLocalWithImportStarUsage, Rule::UndefinedName]) { return; } @@ -15,7 +15,7 @@ pub(crate) fn unresolved_references(checker: &mut Checker) { for reference in checker.semantic.unresolved_references() { if reference.is_wildcard_import() { if checker.enabled(Rule::UndefinedLocalWithImportStarUsage) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::UndefinedLocalWithImportStarUsage { name: reference.name(checker.source()).to_string(), }, @@ -24,6 +24,10 @@ pub(crate) fn unresolved_references(checker: &mut Checker) { } } else { if checker.enabled(Rule::UndefinedName) { + if checker.semantic.in_no_type_check() { + continue; + } + // Avoid flagging if `NameError` is handled. if reference.exceptions().contains(Exceptions::NAME_ERROR) { continue; @@ -38,7 +42,7 @@ pub(crate) fn unresolved_references(checker: &mut Checker) { let symbol_name = reference.name(checker.source()); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( pyflakes::rules::UndefinedName { name: symbol_name.to_string(), minor_version_builtin_added: version_builtin_was_added(symbol_name), diff --git a/crates/ruff_linter/src/checkers/ast/annotation.rs b/crates/ruff_linter/src/checkers/ast/annotation.rs index 86d1ba50f8d81..d8d516cc92107 100644 --- a/crates/ruff_linter/src/checkers/ast/annotation.rs +++ b/crates/ruff_linter/src/checkers/ast/annotation.rs @@ -1,4 +1,4 @@ -use ruff_python_ast::StmtFunctionDef; +use ruff_python_ast::{PythonVersion, StmtFunctionDef}; use ruff_python_semantic::{ScopeKind, SemanticModel}; use crate::rules::flake8_type_checking; @@ -29,7 +29,11 @@ pub(super) enum AnnotationContext { impl AnnotationContext { /// Determine the [`AnnotationContext`] for an annotation based on the current scope of the /// semantic model. - pub(super) fn from_model(semantic: &SemanticModel, settings: &LinterSettings) -> Self { + pub(super) fn from_model( + semantic: &SemanticModel, + settings: &LinterSettings, + version: PythonVersion, + ) -> Self { // If the annotation is in a class scope (e.g., an annotated assignment for a // class field) or a function scope, and that class or function is marked as // runtime-required, treat the annotation as runtime-required. @@ -42,7 +46,7 @@ impl AnnotationContext { semantic, ) => { - return Self::RuntimeRequired + return Self::RuntimeRequired; } ScopeKind::Function(function_def) if flake8_type_checking::helpers::runtime_required_function( @@ -51,7 +55,7 @@ impl AnnotationContext { semantic, ) => { - return Self::RuntimeRequired + return Self::RuntimeRequired; } _ => {} } @@ -59,7 +63,7 @@ impl AnnotationContext { // If `__future__` annotations are enabled or it's a stub file, // then annotations are never evaluated at runtime, // so we can treat them as typing-only. - if semantic.future_annotations_or_stub() { + if semantic.future_annotations_or_stub() || version.defers_annotations() { return Self::TypingOnly; } @@ -81,6 +85,7 @@ impl AnnotationContext { function_def: &StmtFunctionDef, semantic: &SemanticModel, settings: &LinterSettings, + version: PythonVersion, ) -> Self { if flake8_type_checking::helpers::runtime_required_function( function_def, @@ -88,7 +93,7 @@ impl AnnotationContext { semantic, ) { Self::RuntimeRequired - } else if semantic.future_annotations_or_stub() { + } else if semantic.future_annotations_or_stub() || version.defers_annotations() { Self::TypingOnly } else { Self::RuntimeEvaluated diff --git a/crates/ruff_linter/src/checkers/ast/mod.rs b/crates/ruff_linter/src/checkers/ast/mod.rs index 2e0937d37b64e..1967f0a79ce1b 100644 --- a/crates/ruff_linter/src/checkers/ast/mod.rs +++ b/crates/ruff_linter/src/checkers/ast/mod.rs @@ -9,11 +9,6 @@ //! parent scopes have been fully traversed. Individual rules may also perform internal traversals //! of the AST. //! -//! While the [`Checker`] is typically passed by mutable reference to the individual lint rule -//! implementations, most of its constituent components are intended to be treated immutably, with -//! the exception of the [`Diagnostic`] vector, which is intended to be mutated by the individual -//! lint rules. In the future, this should be formalized in the API. -//! //! The individual [`Visitor`] implementations within the [`Checker`] typically proceed in four //! steps: //! @@ -31,45 +26,54 @@ use std::path::Path; use itertools::Itertools; use log::debug; -use rustc_hash::FxHashMap; +use ruff_python_parser::semantic_errors::{ + SemanticSyntaxChecker, SemanticSyntaxContext, SemanticSyntaxError, SemanticSyntaxErrorKind, +}; +use rustc_hash::{FxHashMap, FxHashSet}; -use ruff_diagnostics::{Diagnostic, IsolationLevel}; +use ruff_diagnostics::{Diagnostic, Edit, IsolationLevel}; use ruff_notebook::{CellOffsets, NotebookIndex}; use ruff_python_ast::helpers::{collect_import_from_member, is_docstring_stmt, to_module_path}; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::str::Quote; -use ruff_python_ast::visitor::{walk_except_handler, walk_pattern, Visitor}; +use ruff_python_ast::visitor::{Visitor, walk_except_handler, walk_pattern}; use ruff_python_ast::{ - self as ast, AnyParameterRef, Comprehension, ElifElseClause, ExceptHandler, Expr, ExprContext, - FStringElement, Keyword, MatchCase, ModModule, Parameter, Parameters, Pattern, Stmt, Suite, - UnaryOp, + self as ast, AnyParameterRef, ArgOrKeyword, Comprehension, ElifElseClause, ExceptHandler, Expr, + ExprContext, FStringElement, Keyword, MatchCase, ModModule, Parameter, Parameters, Pattern, + PythonVersion, Stmt, Suite, UnaryOp, }; -use ruff_python_ast::{helpers, str, visitor, PySourceType}; +use ruff_python_ast::{PySourceType, helpers, str, visitor}; use ruff_python_codegen::{Generator, Stylist}; use ruff_python_index::Indexer; -use ruff_python_parser::typing::{parse_type_annotation, AnnotationKind, ParsedAnnotation}; -use ruff_python_parser::{Parsed, Tokens}; +use ruff_python_parser::typing::{AnnotationKind, ParsedAnnotation, parse_type_annotation}; +use ruff_python_parser::{ParseError, Parsed, Tokens}; use ruff_python_semantic::all::{DunderAllDefinition, DunderAllFlags}; use ruff_python_semantic::analyze::{imports, typing}; use ruff_python_semantic::{ - BindingFlags, BindingId, BindingKind, Exceptions, Export, FromImport, Globals, Import, Module, - ModuleKind, ModuleSource, NodeId, ScopeId, ScopeKind, SemanticModel, SemanticModelFlags, - StarImport, SubmoduleImport, + BindingFlags, BindingId, BindingKind, Exceptions, Export, FromImport, GeneratorKind, Globals, + Import, Module, ModuleKind, ModuleSource, NodeId, ScopeId, ScopeKind, SemanticModel, + SemanticModelFlags, StarImport, SubmoduleImport, }; -use ruff_python_stdlib::builtins::{python_builtins, MAGIC_GLOBALS}; +use ruff_python_stdlib::builtins::{MAGIC_GLOBALS, python_builtins}; use ruff_python_trivia::CommentRanges; use ruff_source_file::{OneIndexed, SourceRow}; use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::annotation::AnnotationContext; use crate::docstrings::extraction::ExtractionTarget; -use crate::importer::Importer; +use crate::importer::{ImportRequest, Importer, ResolutionError}; use crate::noqa::NoqaMapping; +use crate::package::PackageRoot; +use crate::preview::{is_semantic_errors_enabled, is_undefined_export_in_dunder_init_enabled}; use crate::registry::Rule; +use crate::rules::pyflakes::rules::{ + LateFutureImport, ReturnOutsideFunction, YieldOutsideFunction, +}; +use crate::rules::pylint::rules::{AwaitOutsideAsync, LoadBeforeGlobalDeclaration}; use crate::rules::{flake8_pyi, flake8_type_checking, pyflakes, pyupgrade}; -use crate::settings::{flags, LinterSettings}; -use crate::{docstrings, noqa, Locator}; +use crate::settings::{LinterSettings, TargetVersion, flags}; +use crate::{Locator, docstrings, noqa}; mod analyze; mod annotation; @@ -186,9 +190,9 @@ pub(crate) struct Checker<'a> { /// The [`Path`] to the file under analysis. path: &'a Path, /// The [`Path`] to the package containing the current file. - package: Option<&'a Path>, + package: Option<PackageRoot<'a>>, /// The module representation of the current file (e.g., `foo.bar`). - module: Module<'a>, + pub(crate) module: Module<'a>, /// The [`PySourceType`] of the current file. pub(crate) source_type: PySourceType, /// The [`CellOffsets`] for the current file, if it's a Jupyter notebook. @@ -220,25 +224,32 @@ pub(crate) struct Checker<'a> { /// A set of deferred nodes to be analyzed after the AST traversal (e.g., `for` loops). analyze: deferred::Analyze, /// The cumulative set of diagnostics computed across all lint rules. - pub(crate) diagnostics: Vec<Diagnostic>, - /// The list of names already seen by flake8-bugbear diagnostics, to avoid duplicate violations.. - pub(crate) flake8_bugbear_seen: Vec<TextRange>, + diagnostics: RefCell<Vec<Diagnostic>>, + /// The list of names already seen by flake8-bugbear diagnostics, to avoid duplicate violations. + flake8_bugbear_seen: RefCell<FxHashSet<TextRange>>, /// The end offset of the last visited statement. last_stmt_end: TextSize, /// A state describing if a docstring is expected or not. docstring_state: DocstringState, + /// The target [`PythonVersion`] for version-dependent checks. + target_version: TargetVersion, + /// Helper visitor for detecting semantic syntax errors. + #[expect(clippy::struct_field_names)] + semantic_checker: SemanticSyntaxChecker, + /// Errors collected by the `semantic_checker`. + semantic_errors: RefCell<Vec<SemanticSyntaxError>>, } impl<'a> Checker<'a> { - #[allow(clippy::too_many_arguments)] + #[expect(clippy::too_many_arguments)] pub(crate) fn new( parsed: &'a Parsed<ModModule>, - parsed_annotations_arena: &'a typed_arena::Arena<ParsedAnnotation>, + parsed_annotations_arena: &'a typed_arena::Arena<Result<ParsedAnnotation, ParseError>>, settings: &'a LinterSettings, noqa_line_for: &'a NoqaMapping, noqa: flags::Noqa, path: &'a Path, - package: Option<&'a Path>, + package: Option<PackageRoot<'a>>, module: Module<'a>, locator: &'a Locator, stylist: &'a Stylist, @@ -246,8 +257,10 @@ impl<'a> Checker<'a> { source_type: PySourceType, cell_offsets: Option<&'a CellOffsets>, notebook_index: Option<&'a NotebookIndex>, + target_version: TargetVersion, ) -> Checker<'a> { - Checker { + let semantic = SemanticModel::new(&settings.typing_modules, path, module); + Self { parsed, parsed_type_annotation: None, parsed_annotations_cache: ParsedAnnotationsCache::new(parsed_annotations_arena), @@ -262,15 +275,18 @@ impl<'a> Checker<'a> { stylist, indexer, importer: Importer::new(parsed, locator, stylist), - semantic: SemanticModel::new(&settings.typing_modules, path, module), + semantic, visit: deferred::Visit::default(), analyze: deferred::Analyze::default(), - diagnostics: Vec::default(), - flake8_bugbear_seen: Vec::default(), + diagnostics: RefCell::default(), + flake8_bugbear_seen: RefCell::default(), cell_offsets, notebook_index, last_stmt_end: TextSize::default(), docstring_state: DocstringState::default(), + target_version, + semantic_checker: SemanticSyntaxChecker::new(), + semantic_errors: RefCell::default(), } } } @@ -281,23 +297,50 @@ impl<'a> Checker<'a> { // TODO(charlie): `noqa` directives are mostly enforced in `check_lines.rs`. // However, in rare cases, we need to check them here. For example, when // removing unused imports, we create a single fix that's applied to all - // unused members on a single import. We need to pre-emptively omit any + // unused members on a single import. We need to preemptively omit any // members from the fix that will eventually be excluded by a `noqa`. // Unfortunately, we _do_ want to register a `Diagnostic` for each // eventually-ignored import, so that our `noqa` counts are accurate. if !self.noqa.is_enabled() { return false; } - noqa::rule_is_ignored(code, offset, self.noqa_line_for, self.locator) + + noqa::rule_is_ignored( + code, + offset, + self.noqa_line_for, + self.comment_ranges(), + self.locator, + ) } /// Create a [`Generator`] to generate source code based on the current AST state. pub(crate) fn generator(&self) -> Generator { - Generator::new( - self.stylist.indentation(), - self.f_string_quote_style().unwrap_or(self.stylist.quote()), - self.stylist.line_ending(), - ) + Generator::new(self.stylist.indentation(), self.stylist.line_ending()) + } + + /// Return the preferred quote for a generated `StringLiteral` node, given where we are in the + /// AST. + fn preferred_quote(&self) -> Quote { + self.f_string_quote_style().unwrap_or(self.stylist.quote()) + } + + /// Return the default string flags a generated `StringLiteral` node should use, given where we + /// are in the AST. + pub(crate) fn default_string_flags(&self) -> ast::StringLiteralFlags { + ast::StringLiteralFlags::empty().with_quote_style(self.preferred_quote()) + } + + /// Return the default bytestring flags a generated `ByteStringLiteral` node should use, given + /// where we are in the AST. + pub(crate) fn default_bytes_flags(&self) -> ast::BytesLiteralFlags { + ast::BytesLiteralFlags::empty().with_quote_style(self.preferred_quote()) + } + + /// Return the default f-string flags a generated `FString` node should use, given where we are + /// in the AST. + pub(crate) fn default_fstring_flags(&self) -> ast::FStringFlags { + ast::FStringFlags::empty().with_quote_style(self.preferred_quote()) } /// Returns the appropriate quoting for f-string by reversing the one used outside of @@ -319,7 +362,7 @@ impl<'a> Checker<'a> { /// Returns the [`SourceRow`] for the given offset. pub(crate) fn compute_source_row(&self, offset: TextSize) -> SourceRow { - #[allow(deprecated)] + #[expect(deprecated)] let line = self.locator.compute_line_index(offset); if let Some(notebook_index) = self.notebook_index { @@ -336,6 +379,21 @@ impl<'a> Checker<'a> { self.indexer.comment_ranges() } + /// Push a new [`Diagnostic`] to the collection in the [`Checker`] + pub(crate) fn report_diagnostic(&self, diagnostic: Diagnostic) { + let mut diagnostics = self.diagnostics.borrow_mut(); + diagnostics.push(diagnostic); + } + + /// Adds a [`TextRange`] to the set of ranges of variable names + /// flagged in `flake8-bugbear` violations so far. + /// + /// Returns whether the value was newly inserted. + pub(crate) fn insert_flake8_bugbear_range(&self, range: TextRange) -> bool { + let mut ranges = self.flake8_bugbear_seen.borrow_mut(); + ranges.insert(range) + } + /// Returns the [`Tokens`] for the parsed type annotation if the checker is in a typing context /// or the parsed source code. pub(crate) fn tokens(&self) -> &'a Tokens { @@ -383,7 +441,7 @@ impl<'a> Checker<'a> { } /// The [`Path`] to the package containing the current file. - pub(crate) const fn package(&self) -> Option<&'a Path> { + pub(crate) const fn package(&self) -> Option<PackageRoot<'_>> { self.package } @@ -424,7 +482,7 @@ impl<'a> Checker<'a> { pub(crate) fn parse_type_annotation( &self, annotation: &ast::ExprStringLiteral, - ) -> Option<&'a ParsedAnnotation> { + ) -> Result<&'a ParsedAnnotation, &'a ParseError> { self.parsed_annotations_cache .lookup_or_parse(annotation, self.locator.contents()) } @@ -440,7 +498,7 @@ impl<'a> Checker<'a> { match_fn: impl FnOnce(&ast::Expr) -> bool, ) -> bool { if let ast::Expr::StringLiteral(string_annotation) = expr { - let Some(parsed_annotation) = self.parse_type_annotation(string_annotation) else { + let Some(parsed_annotation) = self.parse_type_annotation(string_annotation).ok() else { return false; }; match_fn(parsed_annotation.expression()) @@ -448,10 +506,240 @@ impl<'a> Checker<'a> { match_fn(expr) } } + + /// Push `diagnostic` if the checker is not in a `@no_type_check` context. + pub(crate) fn report_type_diagnostic(&self, diagnostic: Diagnostic) { + if !self.semantic.in_no_type_check() { + self.report_diagnostic(diagnostic); + } + } + + /// Return the [`PythonVersion`] to use for version-related lint rules. + /// + /// If the user did not provide a target version, this defaults to the lowest supported Python + /// version ([`PythonVersion::default`]). + /// + /// Note that this method should not be used for version-related syntax errors emitted by the + /// parser or the [`SemanticSyntaxChecker`], which should instead default to the _latest_ + /// supported Python version. + pub(crate) fn target_version(&self) -> PythonVersion { + self.target_version.linter_version() + } + + fn with_semantic_checker(&mut self, f: impl FnOnce(&mut SemanticSyntaxChecker, &Checker)) { + let mut checker = std::mem::take(&mut self.semantic_checker); + f(&mut checker, self); + self.semantic_checker = checker; + } + + /// Create a [`TypingImporter`] that will import `member` from either `typing` or + /// `typing_extensions`. + /// + /// On Python <`version_added_to_typing`, `member` is imported from `typing_extensions`, while + /// on Python >=`version_added_to_typing`, it is imported from `typing`. + /// + /// If the Python version is less than `version_added_to_typing` but + /// `LinterSettings::typing_extensions` is `false`, this method returns `None`. + pub(crate) fn typing_importer<'b>( + &'b self, + member: &'b str, + version_added_to_typing: PythonVersion, + ) -> Option<TypingImporter<'b, 'a>> { + let source_module = if self.target_version() >= version_added_to_typing { + "typing" + } else if !self.settings.typing_extensions { + return None; + } else { + "typing_extensions" + }; + Some(TypingImporter { + checker: self, + source_module, + member, + }) + } +} + +pub(crate) struct TypingImporter<'a, 'b> { + checker: &'a Checker<'b>, + source_module: &'static str, + member: &'a str, +} + +impl TypingImporter<'_, '_> { + /// Create an [`Edit`] that makes the requested symbol available at `position`. + /// + /// See [`Importer::get_or_import_symbol`] for more details on the returned values and + /// [`Checker::typing_importer`] for a way to construct a [`TypingImporter`]. + pub(crate) fn import(&self, position: TextSize) -> Result<(Edit, String), ResolutionError> { + let request = ImportRequest::import_from(self.source_module, self.member); + self.checker + .importer + .get_or_import_symbol(&request, position, self.checker.semantic()) + } +} + +impl SemanticSyntaxContext for Checker<'_> { + fn python_version(&self) -> PythonVersion { + // Reuse `parser_version` here, which should default to `PythonVersion::latest` instead of + // `PythonVersion::default` to minimize version-related semantic syntax errors when + // `target_version` is unset. + self.target_version.parser_version() + } + + fn global(&self, name: &str) -> Option<TextRange> { + self.semantic.global(name) + } + + fn report_semantic_error(&self, error: SemanticSyntaxError) { + match error.kind { + SemanticSyntaxErrorKind::LateFutureImport => { + if self.settings.rules.enabled(Rule::LateFutureImport) { + self.report_diagnostic(Diagnostic::new(LateFutureImport, error.range)); + } + } + SemanticSyntaxErrorKind::LoadBeforeGlobalDeclaration { name, start } => { + if self + .settings + .rules + .enabled(Rule::LoadBeforeGlobalDeclaration) + { + self.report_diagnostic(Diagnostic::new( + LoadBeforeGlobalDeclaration { + name, + row: self.compute_source_row(start), + }, + error.range, + )); + } + } + SemanticSyntaxErrorKind::YieldOutsideFunction(kind) => { + if self.settings.rules.enabled(Rule::YieldOutsideFunction) { + self.report_diagnostic(Diagnostic::new( + YieldOutsideFunction::new(kind), + error.range, + )); + } + } + SemanticSyntaxErrorKind::ReturnOutsideFunction => { + if self.settings.rules.enabled(Rule::ReturnOutsideFunction) { + self.report_diagnostic(Diagnostic::new(ReturnOutsideFunction, error.range)); + } + } + SemanticSyntaxErrorKind::AwaitOutsideAsyncFunction(_) => { + if self.settings.rules.enabled(Rule::AwaitOutsideAsync) { + self.report_diagnostic(Diagnostic::new(AwaitOutsideAsync, error.range)); + } + } + SemanticSyntaxErrorKind::ReboundComprehensionVariable + | SemanticSyntaxErrorKind::DuplicateTypeParameter + | SemanticSyntaxErrorKind::MultipleCaseAssignment(_) + | SemanticSyntaxErrorKind::IrrefutableCasePattern(_) + | SemanticSyntaxErrorKind::SingleStarredAssignment + | SemanticSyntaxErrorKind::WriteToDebug(_) + | SemanticSyntaxErrorKind::InvalidExpression(..) + | SemanticSyntaxErrorKind::DuplicateMatchKey(_) + | SemanticSyntaxErrorKind::DuplicateMatchClassAttribute(_) + | SemanticSyntaxErrorKind::InvalidStarExpression + | SemanticSyntaxErrorKind::AsyncComprehensionInSyncComprehension(_) + | SemanticSyntaxErrorKind::DuplicateParameter(_) + | SemanticSyntaxErrorKind::NonlocalDeclarationAtModuleLevel => { + if is_semantic_errors_enabled(self.settings) { + self.semantic_errors.borrow_mut().push(error); + } + } + } + } + + fn source(&self) -> &str { + self.source() + } + + fn future_annotations_or_stub(&self) -> bool { + self.semantic.future_annotations_or_stub() + } + + fn in_async_context(&self) -> bool { + for scope in self.semantic.current_scopes() { + match scope.kind { + ScopeKind::Class(_) | ScopeKind::Lambda(_) => return false, + ScopeKind::Function(ast::StmtFunctionDef { is_async, .. }) => return *is_async, + ScopeKind::Generator { .. } | ScopeKind::Module | ScopeKind::Type => {} + } + } + false + } + + fn in_await_allowed_context(&self) -> bool { + for scope in self.semantic.current_scopes() { + match scope.kind { + ScopeKind::Class(_) => return false, + ScopeKind::Function(_) | ScopeKind::Lambda(_) => return true, + ScopeKind::Generator { .. } | ScopeKind::Module | ScopeKind::Type => {} + } + } + false + } + + fn in_yield_allowed_context(&self) -> bool { + for scope in self.semantic.current_scopes() { + match scope.kind { + ScopeKind::Class(_) | ScopeKind::Generator { .. } => return false, + ScopeKind::Function(_) | ScopeKind::Lambda(_) => return true, + ScopeKind::Module | ScopeKind::Type => {} + } + } + false + } + + fn in_sync_comprehension(&self) -> bool { + for scope in self.semantic.current_scopes() { + if let ScopeKind::Generator { + kind: + GeneratorKind::ListComprehension + | GeneratorKind::DictComprehension + | GeneratorKind::SetComprehension, + is_async: false, + } = scope.kind + { + return true; + } + } + false + } + + fn in_module_scope(&self) -> bool { + self.semantic.current_scope().kind.is_module() + } + + fn in_function_scope(&self) -> bool { + let kind = &self.semantic.current_scope().kind; + matches!(kind, ScopeKind::Function(_) | ScopeKind::Lambda(_)) + } + + fn in_notebook(&self) -> bool { + self.source_type.is_ipynb() + } + + fn in_generator_scope(&self) -> bool { + matches!( + &self.semantic.current_scope().kind, + ScopeKind::Generator { + kind: GeneratorKind::Generator, + .. + } + ) + } } impl<'a> Visitor<'a> for Checker<'a> { fn visit_stmt(&mut self, stmt: &'a Stmt) { + // For functions, defer semantic syntax error checks until the body of the function is + // visited + if !stmt.is_function_def_stmt() { + self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context)); + } + // Step 0: Pre-processing self.semantic.push_node(stmt); @@ -486,24 +774,22 @@ impl<'a> Visitor<'a> for Checker<'a> { { self.semantic.flags |= SemanticModelFlags::FUTURE_ANNOTATIONS; } - } else { - self.semantic.flags |= SemanticModelFlags::FUTURES_BOUNDARY; } } Stmt::Import(_) => { self.semantic.flags |= SemanticModelFlags::MODULE_DOCSTRING_BOUNDARY; - self.semantic.flags |= SemanticModelFlags::FUTURES_BOUNDARY; } _ => { self.semantic.flags |= SemanticModelFlags::MODULE_DOCSTRING_BOUNDARY; - self.semantic.flags |= SemanticModelFlags::FUTURES_BOUNDARY; if !(self.semantic.seen_import_boundary() || stmt.is_ipy_escape_command_stmt() || helpers::is_assignment_to_a_dunder(stmt) || helpers::in_nested_block(self.semantic.current_statements()) || imports::is_matplotlib_activation(stmt, self.semantic()) || imports::is_sys_path_modification(stmt, self.semantic()) - || imports::is_os_environ_modification(stmt, self.semantic())) + || imports::is_os_environ_modification(stmt, self.semantic()) + || imports::is_pytest_importorskip(stmt, self.semantic()) + || imports::is_site_sys_path_modification(stmt, self.semantic())) { self.semantic.flags |= SemanticModelFlags::IMPORT_BOUNDARY; } @@ -720,12 +1006,23 @@ impl<'a> Visitor<'a> for Checker<'a> { // deferred. for decorator in decorator_list { self.visit_decorator(decorator); + + if self + .semantic + .match_typing_expr(&decorator.expression, "no_type_check") + { + self.semantic.flags |= SemanticModelFlags::NO_TYPE_CHECK; + } } // Function annotations are always evaluated at runtime, unless future annotations - // are enabled. - let annotation = - AnnotationContext::from_function(function_def, &self.semantic, self.settings); + // are enabled or the Python version is at least 3.14. + let annotation = AnnotationContext::from_function( + function_def, + &self.semantic, + self.settings, + self.target_version(), + ); // The first parameter may be a single dispatch. let singledispatch = @@ -878,9 +1175,7 @@ impl<'a> Visitor<'a> for Checker<'a> { if let Some(type_params) = type_params { self.visit_type_params(type_params); } - self.visit - .type_param_definitions - .push((value, self.semantic.snapshot())); + self.visit_deferred_type_alias_value(value); self.semantic.pop_scope(); self.visit_expr(name); } @@ -924,7 +1219,11 @@ impl<'a> Visitor<'a> for Checker<'a> { value, .. }) => { - match AnnotationContext::from_model(&self.semantic, self.settings) { + match AnnotationContext::from_model( + &self.semantic, + self.settings, + self.target_version(), + ) { AnnotationContext::RuntimeRequired => { self.visit_runtime_required_annotation(annotation); } @@ -951,7 +1250,7 @@ impl<'a> Visitor<'a> for Checker<'a> { if let Some(expr) = value { if self.semantic.match_typing_expr(annotation, "TypeAlias") { - self.visit_type_definition(expr); + self.visit_annotated_type_alias_value(expr); } else { self.visit_expr(expr); } @@ -963,10 +1262,13 @@ impl<'a> Visitor<'a> for Checker<'a> { msg, range: _, }) => { + let snapshot = self.semantic.flags; + self.semantic.flags |= SemanticModelFlags::ASSERT_STATEMENT; self.visit_boolean_test(test); if let Some(expr) = msg { self.visit_expr(expr); } + self.semantic.flags = snapshot; } Stmt::With(ast::StmtWith { items, @@ -1019,7 +1321,7 @@ impl<'a> Visitor<'a> for Checker<'a> { } } _ => visitor::walk_stmt(self, stmt), - }; + } if self.semantic().at_top_level() || self.semantic().current_scope().kind.is_class() { match stmt { @@ -1057,6 +1359,8 @@ impl<'a> Visitor<'a> for Checker<'a> { } fn visit_expr(&mut self, expr: &'a Expr) { + self.with_semantic_checker(|semantic, context| semantic.visit_expr(expr, context)); + // Step 0: Pre-processing if self.source_type.is_stub() && self.semantic.in_class_base() @@ -1074,7 +1378,7 @@ impl<'a> Visitor<'a> for Checker<'a> { // we can't defer again, or we'll infinitely recurse! && !self.semantic.in_deferred_type_definition() && self.semantic.in_type_definition() - && self.semantic.future_annotations_or_stub() + && (self.semantic.future_annotations_or_stub()||self.target_version().defers_annotations()) && (self.semantic.in_annotation() || self.source_type.is_stub()) { if let Expr::StringLiteral(string_literal) = expr { @@ -1122,6 +1426,16 @@ impl<'a> Visitor<'a> for Checker<'a> { } } } + Expr::Attribute(ast::ExprAttribute { + value: _, + range: _, + ctx, + attr: _, + }) => { + if ctx == &ExprContext::Load { + self.handle_attribute_load(expr); + } + } Expr::Name(ast::ExprName { id, ctx, range: _ }) => match ctx { ExprContext::Load => self.handle_node_load(expr), ExprContext::Store => self.handle_node_store(id, expr), @@ -1137,19 +1451,25 @@ impl<'a> Visitor<'a> for Checker<'a> { elt, generators, range: _, - }) - | Expr::SetComp(ast::ExprSetComp { + }) => { + self.visit_generators(GeneratorKind::ListComprehension, generators); + self.visit_expr(elt); + } + Expr::SetComp(ast::ExprSetComp { elt, generators, range: _, - }) - | Expr::Generator(ast::ExprGenerator { + }) => { + self.visit_generators(GeneratorKind::SetComprehension, generators); + self.visit_expr(elt); + } + Expr::Generator(ast::ExprGenerator { elt, generators, range: _, parenthesized: _, }) => { - self.visit_generators(generators); + self.visit_generators(GeneratorKind::Generator, generators); self.visit_expr(elt); } Expr::DictComp(ast::ExprDictComp { @@ -1158,7 +1478,7 @@ impl<'a> Visitor<'a> for Checker<'a> { generators, range: _, }) => { - self.visit_generators(generators); + self.visit_generators(GeneratorKind::DictComprehension, generators); self.visit_expr(key); self.visit_expr(value); } @@ -1226,6 +1546,11 @@ impl<'a> Visitor<'a> for Checker<'a> { .match_typing_qualified_name(&qualified_name, "TypeVar") { Some(typing::Callable::TypeVar) + } else if self + .semantic + .match_typing_qualified_name(&qualified_name, "TypeAliasType") + { + Some(typing::Callable::TypeAliasType) } else if self .semantic .match_typing_qualified_name(&qualified_name, "NamedTuple") @@ -1267,21 +1592,37 @@ impl<'a> Visitor<'a> for Checker<'a> { } } Some(typing::Callable::Cast) => { - let mut args = arguments.args.iter(); - if let Some(arg) = args.next() { - self.visit_type_definition(arg); - } - for arg in args { - self.visit_expr(arg); + for (i, arg) in arguments.arguments_source_order().enumerate() { + match (i, arg) { + (0, ArgOrKeyword::Arg(arg)) => self.visit_cast_type_argument(arg), + (_, ArgOrKeyword::Arg(arg)) => self.visit_non_type_definition(arg), + (_, ArgOrKeyword::Keyword(Keyword { arg, value, .. })) => { + if let Some(id) = arg { + if id == "typ" { + self.visit_cast_type_argument(value); + } else { + self.visit_non_type_definition(value); + } + } + } + } } } Some(typing::Callable::NewType) => { - let mut args = arguments.args.iter(); - if let Some(arg) = args.next() { - self.visit_non_type_definition(arg); - } - for arg in args { - self.visit_type_definition(arg); + for (i, arg) in arguments.arguments_source_order().enumerate() { + match (i, arg) { + (1, ArgOrKeyword::Arg(arg)) => self.visit_type_definition(arg), + (_, ArgOrKeyword::Arg(arg)) => self.visit_non_type_definition(arg), + (_, ArgOrKeyword::Keyword(Keyword { arg, value, .. })) => { + if let Some(id) = arg { + if id == "tp" { + self.visit_type_definition(value); + } else { + self.visit_non_type_definition(value); + } + } + } + } } } Some(typing::Callable::TypeVar) => { @@ -1299,7 +1640,7 @@ impl<'a> Visitor<'a> for Checker<'a> { range: _, } = keyword; if let Some(id) = arg { - if id.as_str() == "bound" { + if matches!(&**id, "bound" | "default") { self.visit_type_definition(value); } else { self.visit_non_type_definition(value); @@ -1307,6 +1648,24 @@ impl<'a> Visitor<'a> for Checker<'a> { } } } + Some(typing::Callable::TypeAliasType) => { + // Ex) TypeAliasType("Json", "Union[dict[str, Json]]", type_params=()) + for (i, arg) in arguments.arguments_source_order().enumerate() { + match (i, arg) { + (1, ArgOrKeyword::Arg(arg)) => self.visit_type_definition(arg), + (_, ArgOrKeyword::Arg(arg)) => self.visit_non_type_definition(arg), + (_, ArgOrKeyword::Keyword(Keyword { arg, value, .. })) => { + if let Some(id) = arg { + if matches!(&**id, "value" | "type_params") { + self.visit_type_definition(value); + } else { + self.visit_non_type_definition(value); + } + } + } + } + } + } Some(typing::Callable::NamedTuple) => { // Ex) NamedTuple("a", [("a", int)]) let mut args = arguments.args.iter(); @@ -1487,7 +1846,29 @@ impl<'a> Visitor<'a> for Checker<'a> { } self.visit_expr_context(ctx); } else { - debug!("Found non-Expr::Tuple argument to PEP 593 Annotation."); + if self.semantic.in_type_definition() { + // this should potentially trigger some kind of violation in the + // future, since it would indicate an invalid type expression + debug!("Found non-Expr::Tuple argument to PEP 593 Annotation."); + } + // even if the expression is invalid as a type expression, we should + // still visit it so we don't accidentally treat variables as unused + self.visit_expr(slice); + self.visit_expr_context(ctx); + } + } + Some(typing::SubscriptKind::TypedDict) => { + if let Expr::Dict(ast::ExprDict { items, range: _ }) = slice.as_ref() { + for item in items { + if let Some(key) = &item.key { + self.visit_non_type_definition(key); + self.visit_type_definition(&item.value); + } else { + self.visit_non_type_definition(&item.value); + } + } + } else { + self.visit_non_type_definition(slice); } } None => { @@ -1532,10 +1913,9 @@ impl<'a> Visitor<'a> for Checker<'a> { self.semantic.pop_scope(); } _ => {} - }; + } // Step 4: Analysis - analyze::expression(expr, self); match expr { Expr::StringLiteral(string_literal) => { analyze::string_like(string_literal.into(), self); @@ -1546,6 +1926,7 @@ impl<'a> Visitor<'a> for Checker<'a> { } self.semantic.flags = flags_snapshot; + analyze::expression(expr, self); self.semantic.pop_node(); } @@ -1675,12 +2056,12 @@ impl<'a> Visitor<'a> for Checker<'a> { fn visit_type_param(&mut self, type_param: &'a ast::TypeParam) { // Step 1: Binding match type_param { - ast::TypeParam::TypeVar(ast::TypeParamTypeVar { name, range, .. }) - | ast::TypeParam::TypeVarTuple(ast::TypeParamTypeVarTuple { name, range, .. }) - | ast::TypeParam::ParamSpec(ast::TypeParamParamSpec { name, range, .. }) => { + ast::TypeParam::TypeVar(ast::TypeParamTypeVar { name, .. }) + | ast::TypeParam::TypeVarTuple(ast::TypeParamTypeVarTuple { name, .. }) + | ast::TypeParam::ParamSpec(ast::TypeParamParamSpec { name, .. }) => { self.add_binding( name.as_str(), - *range, + name.range(), BindingKind::TypeParam, BindingFlags::empty(), ); @@ -1741,14 +2122,18 @@ impl<'a> Visitor<'a> for Checker<'a> { } impl<'a> Checker<'a> { - /// Visit a [`Module`]. Returns `true` if the module contains a module-level docstring. + /// Visit a [`Module`]. fn visit_module(&mut self, python_ast: &'a Suite) { + // Extract any global bindings from the module body. + if let Some(globals) = Globals::from_body(python_ast) { + self.semantic.set_globals(globals); + } analyze::module(python_ast, self); } /// Visit a list of [`Comprehension`] nodes, assumed to be the comprehensions that compose a /// generator expression, like a list or set comprehension. - fn visit_generators(&mut self, generators: &'a [Comprehension]) { + fn visit_generators(&mut self, kind: GeneratorKind, generators: &'a [Comprehension]) { let mut iterator = generators.iter(); let Some(generator) = iterator.next() else { @@ -1785,9 +2170,13 @@ impl<'a> Checker<'a> { // while all subsequent reads and writes are evaluated in the inner scope. In particular, // `x` is local to `foo`, and the `T` in `y=T` skips the class scope when resolving. self.visit_expr(&generator.iter); - self.semantic.push_scope(ScopeKind::Generator); + self.semantic.push_scope(ScopeKind::Generator { + kind, + is_async: generators + .iter() + .any(|comprehension| comprehension.is_async), + }); - self.semantic.flags = flags | SemanticModelFlags::COMPREHENSION_ASSIGNMENT; self.visit_expr(&generator.target); self.semantic.flags = flags; @@ -1798,7 +2187,6 @@ impl<'a> Checker<'a> { for generator in iterator { self.visit_expr(&generator.iter); - self.semantic.flags = flags | SemanticModelFlags::COMPREHENSION_ASSIGNMENT; self.visit_expr(&generator.target); self.semantic.flags = flags; @@ -1837,6 +2225,45 @@ impl<'a> Checker<'a> { self.semantic.flags = snapshot; } + /// Visit an [`Expr`], and treat it as the value expression + /// of a [PEP 613] type alias. + /// + /// For example: + /// ```python + /// from typing import TypeAlias + /// + /// OptStr: TypeAlias = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + fn visit_annotated_type_alias_value(&mut self, expr: &'a Expr) { + let snapshot = self.semantic.flags; + self.semantic.flags |= SemanticModelFlags::ANNOTATED_TYPE_ALIAS; + self.visit_type_definition(expr); + self.semantic.flags = snapshot; + } + + /// Visit an [`Expr`], and treat it as the value expression + /// of a [PEP 695] type alias. + /// + /// For example: + /// ```python + /// type OptStr = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias + fn visit_deferred_type_alias_value(&mut self, expr: &'a Expr) { + let snapshot = self.semantic.flags; + // even though we don't visit these nodes immediately we need to + // modify the semantic flags before we push the expression and its + // corresponding semantic snapshot + self.semantic.flags |= SemanticModelFlags::DEFERRED_TYPE_ALIAS; + self.visit + .type_param_definitions + .push((expr, self.semantic.snapshot())); + self.semantic.flags = snapshot; + } + /// Visit an [`Expr`], and treat it as a type definition. fn visit_type_definition(&mut self, expr: &'a Expr) { let snapshot = self.semantic.flags; @@ -1853,6 +2280,15 @@ impl<'a> Checker<'a> { self.semantic.flags = snapshot; } + /// Visit an [`Expr`], and treat it as the `typ` argument to `typing.cast`. + fn visit_cast_type_argument(&mut self, arg: &'a Expr) { + self.visit_type_definition(arg); + + if !self.source_type.is_stub() && self.enabled(Rule::RuntimeCastValue) { + flake8_type_checking::rules::runtime_cast_value(self, arg); + } + } + /// Visit an [`Expr`], and treat it as a boolean test. This is useful for detecting whether an /// expressions return value is significant, or whether the calling context only relies on /// its truthiness. @@ -1896,6 +2332,9 @@ impl<'a> Checker<'a> { if self.semantic.in_exception_handler() { flags |= BindingFlags::IN_EXCEPT_HANDLER; } + if self.semantic.in_assert_statement() { + flags |= BindingFlags::IN_ASSERT_STATEMENT; + } // Create the `Binding`. let binding_id = self.semantic.push_binding(range, kind, flags); @@ -1959,17 +2398,14 @@ impl<'a> Checker<'a> { } fn bind_builtins(&mut self) { + let target_version = self.target_version(); let mut bind_builtin = |builtin| { // Add the builtin to the scope. let binding_id = self.semantic.push_builtin(); let scope = self.semantic.global_scope_mut(); scope.add(builtin, binding_id); }; - - let standard_builtins = python_builtins( - self.settings.target_version.minor(), - self.source_type.is_ipynb(), - ); + let standard_builtins = python_builtins(target_version.minor, self.source_type.is_ipynb()); for builtin in standard_builtins { bind_builtin(builtin); } @@ -1988,6 +2424,13 @@ impl<'a> Checker<'a> { self.semantic.resolve_load(expr); } + fn handle_attribute_load(&mut self, expr: &Expr) { + let Expr::Attribute(expr) = expr else { + return; + }; + self.semantic.resolve_attribute_load(expr); + } + fn handle_node_store(&mut self, id: &'a str, expr: &Expr) { let parent = self.semantic.current_statement(); @@ -1996,6 +2439,21 @@ impl<'a> Checker<'a> { flags.insert(BindingFlags::UNPACKED_ASSIGNMENT); } + match parent { + Stmt::TypeAlias(_) => flags.insert(BindingFlags::DEFERRED_TYPE_ALIAS), + Stmt::AnnAssign(ast::StmtAnnAssign { annotation, .. }) => { + // TODO: It is a bit unfortunate that we do this check twice + // maybe we should change how we visit this statement + // so the semantic flag for the type alias sticks around + // until after we've handled this store, so we can check + // the flag instead of duplicating this check + if self.semantic.match_typing_expr(annotation, "TypeAlias") { + flags.insert(BindingFlags::ANNOTATED_TYPE_ALIAS); + } + } + _ => {} + } + let scope = self.semantic.current_scope(); if scope.kind.is_module() @@ -2166,7 +2624,8 @@ impl<'a> Checker<'a> { // if they are annotations in a module where `from __future__ import // annotations` is active, or they are type definitions in a stub file. debug_assert!( - self.semantic.future_annotations_or_stub() + (self.semantic.future_annotations_or_stub() + || self.target_version().defers_annotations()) && (self.source_type.is_stub() || self.semantic.in_annotation()) ); @@ -2222,45 +2681,66 @@ impl<'a> Checker<'a> { while !self.visit.string_type_definitions.is_empty() { let type_definitions = std::mem::take(&mut self.visit.string_type_definitions); for (string_expr, snapshot) in type_definitions { - let annotation_parse_result = self.parse_type_annotation(string_expr); - if let Some(parsed_annotation) = annotation_parse_result { - self.parsed_type_annotation = Some(parsed_annotation); + match self.parse_type_annotation(string_expr) { + Ok(parsed_annotation) => { + self.parsed_type_annotation = Some(parsed_annotation); - let annotation = string_expr.value.to_str(); - let range = string_expr.range(); + let annotation = string_expr.value.to_str(); + let range = string_expr.range(); - self.semantic.restore(snapshot); + self.semantic.restore(snapshot); - if self.semantic.in_annotation() && self.semantic.in_typing_only_annotation() { - if self.enabled(Rule::QuotedAnnotation) { - pyupgrade::rules::quoted_annotation(self, annotation, range); + if self.semantic.in_annotation() + && self.semantic.in_typing_only_annotation() + { + if self.enabled(Rule::QuotedAnnotation) { + pyupgrade::rules::quoted_annotation(self, annotation, range); + } } - } - if self.source_type.is_stub() { - if self.enabled(Rule::QuotedAnnotationInStub) { - flake8_pyi::rules::quoted_annotation_in_stub(self, annotation, range); + if self.source_type.is_stub() { + if self.enabled(Rule::QuotedAnnotationInStub) { + flake8_pyi::rules::quoted_annotation_in_stub( + self, annotation, range, + ); + } } - } - let type_definition_flag = match parsed_annotation.kind() { - AnnotationKind::Simple => SemanticModelFlags::SIMPLE_STRING_TYPE_DEFINITION, - AnnotationKind::Complex => { - SemanticModelFlags::COMPLEX_STRING_TYPE_DEFINITION + let type_definition_flag = match parsed_annotation.kind() { + AnnotationKind::Simple => { + SemanticModelFlags::SIMPLE_STRING_TYPE_DEFINITION + } + AnnotationKind::Complex => { + SemanticModelFlags::COMPLEX_STRING_TYPE_DEFINITION + } + }; + + self.semantic.flags |= + SemanticModelFlags::TYPE_DEFINITION | type_definition_flag; + let parsed_expr = parsed_annotation.expression(); + self.visit_expr(parsed_expr); + if self.semantic.in_type_alias_value() { + // stub files are covered by PYI020 + if !self.source_type.is_stub() && self.enabled(Rule::QuotedTypeAlias) { + flake8_type_checking::rules::quoted_type_alias( + self, + parsed_expr, + string_expr, + ); + } + } + self.parsed_type_annotation = None; + } + Err(parse_error) => { + self.semantic.restore(snapshot); + + if self.enabled(Rule::ForwardAnnotationSyntaxError) { + self.report_type_diagnostic(Diagnostic::new( + pyflakes::rules::ForwardAnnotationSyntaxError { + parse_error: parse_error.error.to_string(), + }, + string_expr.range(), + )); } - }; - - self.semantic.flags |= - SemanticModelFlags::TYPE_DEFINITION | type_definition_flag; - self.visit_expr(parsed_annotation.expression()); - self.parsed_type_annotation = None; - } else { - if self.enabled(Rule::ForwardAnnotationSyntaxError) { - self.diagnostics.push(Diagnostic::new( - pyflakes::rules::ForwardAnnotationSyntaxError { - body: string_expr.value.to_string(), - }, - string_expr.range(), - )); } } } @@ -2309,13 +2789,17 @@ impl<'a> Checker<'a> { for snapshot in deferred_functions { self.semantic.restore(snapshot); + let stmt = self.semantic.current_statement(); + let Stmt::FunctionDef(ast::StmtFunctionDef { body, parameters, .. - }) = self.semantic.current_statement() + }) = stmt else { unreachable!("Expected Stmt::FunctionDef") }; + self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context)); + self.visit_parameters(parameters); // Set the docstring state before visiting the function body. self.docstring_state = DocstringState::Expected(ExpectedDocstringKind::Function); @@ -2396,7 +2880,7 @@ impl<'a> Checker<'a> { } else { if self.semantic.global_scope().uses_star_imports() { if self.enabled(Rule::UndefinedLocalWithImportStarUsage) { - self.diagnostics.push( + self.diagnostics.get_mut().push( Diagnostic::new( pyflakes::rules::UndefinedLocalWithImportStarUsage { name: name.to_string(), @@ -2408,10 +2892,10 @@ impl<'a> Checker<'a> { } } else { if self.enabled(Rule::UndefinedExport) { - if self.settings.preview.is_enabled() + if is_undefined_export_in_dunder_init_enabled(self.settings) || !self.path.ends_with("__init__.py") { - self.diagnostics.push( + self.diagnostics.get_mut().push( Diagnostic::new( pyflakes::rules::UndefinedExport { name: name.to_string(), @@ -2432,12 +2916,12 @@ impl<'a> Checker<'a> { } struct ParsedAnnotationsCache<'a> { - arena: &'a typed_arena::Arena<ParsedAnnotation>, - by_offset: RefCell<FxHashMap<TextSize, Option<&'a ParsedAnnotation>>>, + arena: &'a typed_arena::Arena<Result<ParsedAnnotation, ParseError>>, + by_offset: RefCell<FxHashMap<TextSize, Result<&'a ParsedAnnotation, &'a ParseError>>>, } impl<'a> ParsedAnnotationsCache<'a> { - fn new(arena: &'a typed_arena::Arena<ParsedAnnotation>) -> Self { + fn new(arena: &'a typed_arena::Arena<Result<ParsedAnnotation, ParseError>>) -> Self { Self { arena, by_offset: RefCell::default(), @@ -2448,17 +2932,15 @@ impl<'a> ParsedAnnotationsCache<'a> { &self, annotation: &ast::ExprStringLiteral, source: &str, - ) -> Option<&'a ParsedAnnotation> { + ) -> Result<&'a ParsedAnnotation, &'a ParseError> { *self .by_offset .borrow_mut() .entry(annotation.start()) .or_insert_with(|| { - if let Ok(annotation) = parse_type_annotation(annotation, source) { - Some(self.arena.alloc(annotation)) - } else { - None - } + self.arena + .alloc(parse_type_annotation(annotation, source)) + .as_ref() }) } @@ -2467,7 +2949,7 @@ impl<'a> ParsedAnnotationsCache<'a> { } } -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn check_ast( parsed: &Parsed<ModModule>, locator: &Locator, @@ -2477,12 +2959,15 @@ pub(crate) fn check_ast( settings: &LinterSettings, noqa: flags::Noqa, path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, source_type: PySourceType, cell_offsets: Option<&CellOffsets>, notebook_index: Option<&NotebookIndex>, -) -> Vec<Diagnostic> { - let module_path = package.and_then(|package| to_module_path(package, path)); + target_version: TargetVersion, +) -> (Vec<Diagnostic>, Vec<SemanticSyntaxError>) { + let module_path = package + .map(PackageRoot::path) + .and_then(|package| to_module_path(package, path)); let module = Module { kind: if path.ends_with("__init__.py") { ModuleKind::Package @@ -2518,6 +3003,7 @@ pub(crate) fn check_ast( source_type, cell_offsets, notebook_index, + target_version, ); checker.bind_builtins(); @@ -2535,13 +3021,19 @@ pub(crate) fn check_ast( analyze::deferred_lambdas(&mut checker); analyze::deferred_for_loops(&mut checker); analyze::definitions(&mut checker); - analyze::bindings(&mut checker); - analyze::unresolved_references(&mut checker); + analyze::bindings(&checker); + analyze::unresolved_references(&checker); // Reset the scope to module-level, and check all consumed scopes. checker.semantic.scope_id = ScopeId::global(); checker.analyze.scopes.push(ScopeId::global()); - analyze::deferred_scopes(&mut checker); + analyze::deferred_scopes(&checker); + + let Checker { + diagnostics, + semantic_errors, + .. + } = checker; - checker.diagnostics + (diagnostics.into_inner(), semantic_errors.into_inner()) } diff --git a/crates/ruff_linter/src/checkers/filesystem.rs b/crates/ruff_linter/src/checkers/filesystem.rs index 669ee4877f454..a92088196c0c1 100644 --- a/crates/ruff_linter/src/checkers/filesystem.rs +++ b/crates/ruff_linter/src/checkers/filesystem.rs @@ -1,26 +1,31 @@ use std::path::Path; use ruff_diagnostics::Diagnostic; +use ruff_python_ast::PythonVersion; use ruff_python_trivia::CommentRanges; +use crate::Locator; +use crate::package::PackageRoot; +use crate::preview::is_allow_nested_roots_enabled; use crate::registry::Rule; -use crate::rules::flake8_builtins::rules::builtin_module_shadowing; +use crate::rules::flake8_builtins::rules::stdlib_module_shadowing; use crate::rules::flake8_no_pep420::rules::implicit_namespace_package; use crate::rules::pep8_naming::rules::invalid_module_name; use crate::settings::LinterSettings; -use crate::Locator; pub(crate) fn check_file_path( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, locator: &Locator, comment_ranges: &CommentRanges, settings: &LinterSettings, + target_version: PythonVersion, ) -> Vec<Diagnostic> { let mut diagnostics: Vec<Diagnostic> = vec![]; // flake8-no-pep420 if settings.rules.enabled(Rule::ImplicitNamespacePackage) { + let allow_nested_roots = is_allow_nested_roots_enabled(settings); if let Some(diagnostic) = implicit_namespace_package( path, package, @@ -28,6 +33,7 @@ pub(crate) fn check_file_path( comment_ranges, &settings.project_root, &settings.src, + allow_nested_roots, ) { diagnostics.push(diagnostic); } @@ -43,13 +49,8 @@ pub(crate) fn check_file_path( } // flake8-builtins - if settings.rules.enabled(Rule::BuiltinModuleShadowing) { - if let Some(diagnostic) = builtin_module_shadowing( - path, - package, - &settings.flake8_builtins.builtins_allowed_modules, - settings.target_version, - ) { + if settings.rules.enabled(Rule::StdlibModuleShadowing) { + if let Some(diagnostic) = stdlib_module_shadowing(path, settings, target_version) { diagnostics.push(diagnostic); } } diff --git a/crates/ruff_linter/src/checkers/imports.rs b/crates/ruff_linter/src/checkers/imports.rs index d956167553474..7ce9a527c3719 100644 --- a/crates/ruff_linter/src/checkers/imports.rs +++ b/crates/ruff_linter/src/checkers/imports.rs @@ -1,22 +1,22 @@ //! Lint rules based on import analysis. -use std::path::Path; use ruff_diagnostics::Diagnostic; use ruff_notebook::CellOffsets; use ruff_python_ast::statement_visitor::StatementVisitor; -use ruff_python_ast::{ModModule, PySourceType}; +use ruff_python_ast::{ModModule, PySourceType, PythonVersion}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; use ruff_python_parser::Parsed; +use crate::Locator; use crate::directives::IsortDirectives; +use crate::package::PackageRoot; use crate::registry::Rule; use crate::rules::isort; use crate::rules::isort::block::{Block, BlockBuilder}; use crate::settings::LinterSettings; -use crate::Locator; -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn check_imports( parsed: &Parsed<ModModule>, locator: &Locator, @@ -24,9 +24,10 @@ pub(crate) fn check_imports( directives: &IsortDirectives, settings: &LinterSettings, stylist: &Stylist, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, source_type: PySourceType, cell_offsets: Option<&CellOffsets>, + target_version: PythonVersion, ) -> Vec<Diagnostic> { // Extract all import blocks from the AST. let tracker = { @@ -52,6 +53,7 @@ pub(crate) fn check_imports( package, source_type, parsed.tokens(), + target_version, ) { diagnostics.push(diagnostic); } diff --git a/crates/ruff_linter/src/checkers/logical_lines.rs b/crates/ruff_linter/src/checkers/logical_lines.rs index 1933889387b92..a17302f3b0965 100644 --- a/crates/ruff_linter/src/checkers/logical_lines.rs +++ b/crates/ruff_linter/src/checkers/logical_lines.rs @@ -5,16 +5,17 @@ use ruff_python_parser::{TokenKind, Tokens}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::line_width::IndentWidth; use crate::registry::{AsRule, Rule}; use crate::rules::pycodestyle::rules::logical_lines::{ - extraneous_whitespace, indentation, missing_whitespace, missing_whitespace_after_keyword, - missing_whitespace_around_operator, redundant_backslash, space_after_comma, - space_around_operator, whitespace_around_keywords, whitespace_around_named_parameter_equals, - whitespace_before_comment, whitespace_before_parameters, LogicalLines, TokenFlags, + LogicalLines, TokenFlags, extraneous_whitespace, indentation, missing_whitespace, + missing_whitespace_after_keyword, missing_whitespace_around_operator, redundant_backslash, + space_after_comma, space_around_operator, whitespace_around_keywords, + whitespace_around_named_parameter_equals, whitespace_before_comment, + whitespace_before_parameters, }; use crate::settings::LinterSettings; -use crate::Locator; /// Return the amount of indentation, expanding tabs to the next multiple of the settings' tab size. pub(crate) fn expand_indent(line: &str, indent_width: IndentWidth) -> usize { @@ -169,16 +170,17 @@ pub(crate) fn check_logical_lines( let indent_size = 4; if enforce_indentation { - for kind in indentation( + for diagnostic in indentation( &line, prev_line.as_ref(), indent_char, indent_level, prev_indent_level, indent_size, + range, ) { - if settings.rules.enabled(kind.rule()) { - context.push_diagnostic(Diagnostic::new(kind, range)); + if settings.rules.enabled(diagnostic.rule()) { + context.push_diagnostic(diagnostic); } } } @@ -206,7 +208,7 @@ impl<'a> LogicalLinesContext<'a> { } pub(crate) fn push_diagnostic(&mut self, diagnostic: Diagnostic) { - if self.settings.rules.enabled(diagnostic.kind.rule()) { + if self.settings.rules.enabled(diagnostic.rule()) { self.diagnostics.push(diagnostic); } } diff --git a/crates/ruff_linter/src/checkers/noqa.rs b/crates/ruff_linter/src/checkers/noqa.rs index a2ecc7a34161f..5e93b192d4c3c 100644 --- a/crates/ruff_linter/src/checkers/noqa.rs +++ b/crates/ruff_linter/src/checkers/noqa.rs @@ -9,19 +9,20 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix}; use ruff_python_trivia::CommentRanges; use ruff_text_size::Ranged; +use crate::Locator; use crate::fix::edits::delete_comment; use crate::noqa::{ Code, Directive, FileExemption, FileNoqaDirectives, NoqaDirectives, NoqaMapping, }; +use crate::preview::is_check_file_level_directives_enabled; use crate::registry::{AsRule, Rule, RuleSet}; use crate::rule_redirects::get_redirect_target; use crate::rules::pygrep_hooks; use crate::rules::ruff; use crate::rules::ruff::rules::{UnusedCodes, UnusedNOQA}; use crate::settings::LinterSettings; -use crate::Locator; -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn check_noqa( diagnostics: &mut Vec<Diagnostic>, path: &Path, @@ -38,17 +39,22 @@ pub(crate) fn check_noqa( let exemption = FileExemption::from(&file_noqa_directives); // Extract all `noqa` directives. - let mut noqa_directives = NoqaDirectives::from_commented_ranges(comment_ranges, path, locator); + let mut noqa_directives = + NoqaDirectives::from_commented_ranges(comment_ranges, &settings.external, path, locator); // Indices of diagnostics that were ignored by a `noqa` directive. let mut ignored_diagnostics = vec![]; // Remove any ignored diagnostics. 'outer: for (index, diagnostic) in diagnostics.iter().enumerate() { - if matches!(diagnostic.kind.rule(), Rule::BlanketNOQA) { + let rule = diagnostic.rule(); + + if matches!(rule, Rule::BlanketNOQA) { continue; } + let code = rule.noqa_code(); + match &exemption { FileExemption::All(_) => { // If the file is exempted, ignore all diagnostics. @@ -57,7 +63,7 @@ pub(crate) fn check_noqa( } FileExemption::Codes(codes) => { // If the diagnostic is ignored by a global exemption, ignore it. - if codes.contains(&&diagnostic.kind.rule().noqa_code()) { + if codes.contains(&&code) { ignored_diagnostics.push(index); continue; } @@ -76,17 +82,13 @@ pub(crate) fn check_noqa( { let suppressed = match &directive_line.directive { Directive::All(_) => { - directive_line - .matches - .push(diagnostic.kind.rule().noqa_code()); + directive_line.matches.push(code); ignored_diagnostics.push(index); true } Directive::Codes(directive) => { - if directive.includes(diagnostic.kind.rule()) { - directive_line - .matches - .push(diagnostic.kind.rule().noqa_code()); + if directive.includes(code) { + directive_line.matches.push(code); ignored_diagnostics.push(index); true } else { @@ -109,10 +111,29 @@ pub(crate) fn check_noqa( && !exemption.includes(Rule::UnusedNOQA) && !per_file_ignores.contains(Rule::UnusedNOQA) { - for line in noqa_directives.lines() { - match &line.directive { + let directives: Vec<_> = if is_check_file_level_directives_enabled(settings) { + noqa_directives + .lines() + .iter() + .map(|line| (&line.directive, &line.matches, false)) + .chain( + file_noqa_directives + .lines() + .iter() + .map(|line| (&line.parsed_file_exemption, &line.matches, true)), + ) + .collect() + } else { + noqa_directives + .lines() + .iter() + .map(|line| (&line.directive, &line.matches, false)) + .collect() + }; + for (directive, matches, is_file_level) in directives { + match directive { Directive::All(directive) => { - if line.matches.is_empty() { + if matches.is_empty() { let edit = delete_comment(directive.range(), locator); let mut diagnostic = Diagnostic::new(UnusedNOQA { codes: None }, directive.range()); @@ -136,17 +157,21 @@ pub(crate) fn check_noqa( break; } - if !seen_codes.insert(original_code) { - duplicated_codes.push(original_code); - } else if line.matches.iter().any(|match_| *match_ == code) - || settings + if seen_codes.insert(original_code) { + let is_code_used = if is_file_level { + diagnostics + .iter() + .any(|diag| diag.rule().noqa_code() == code) + } else { + matches.iter().any(|match_| *match_ == code) + } || settings .external .iter() - .any(|external| code.starts_with(external)) - { - valid_codes.push(original_code); - } else { - if let Ok(rule) = Rule::from_code(code) { + .any(|external| code.starts_with(external)); + + if is_code_used { + valid_codes.push(original_code); + } else if let Ok(rule) = Rule::from_code(code) { if settings.rules.enabled(rule) { unmatched_codes.push(original_code); } else { @@ -155,6 +180,8 @@ pub(crate) fn check_noqa( } else { unknown_codes.push(original_code); } + } else { + duplicated_codes.push(original_code); } } @@ -170,8 +197,18 @@ pub(crate) fn check_noqa( let edit = if valid_codes.is_empty() { delete_comment(directive.range(), locator) } else { + let original_text = locator.slice(directive.range()); + let prefix = if is_file_level { + if original_text.contains("flake8") { + "# flake8: noqa: " + } else { + "# ruff: noqa: " + } + } else { + "# noqa: " + }; Edit::range_replacement( - format!("# noqa: {}", valid_codes.join(", ")), + format!("{}{}", prefix, valid_codes.join(", ")), directive.range(), ) }; @@ -211,6 +248,7 @@ pub(crate) fn check_noqa( && !exemption.includes(Rule::RedirectedNOQA) { ruff::rules::redirected_noqa(diagnostics, &noqa_directives); + ruff::rules::redirected_file_noqa(diagnostics, &file_noqa_directives); } if settings.rules.enabled(Rule::BlanketNOQA) @@ -222,10 +260,16 @@ pub(crate) fn check_noqa( &noqa_directives, locator, &file_noqa_directives, - settings.preview, ); } + if settings.rules.enabled(Rule::InvalidRuleCode) + && !per_file_ignores.contains(Rule::InvalidRuleCode) + && !exemption.enumerates(Rule::InvalidRuleCode) + { + ruff::rules::invalid_noqa_code(diagnostics, &noqa_directives, locator, &settings.external); + } + ignored_diagnostics.sort_unstable(); ignored_diagnostics } diff --git a/crates/ruff_linter/src/checkers/physical_lines.rs b/crates/ruff_linter/src/checkers/physical_lines.rs index 9fba92a5fe406..c2f45a7a1a00e 100644 --- a/crates/ruff_linter/src/checkers/physical_lines.rs +++ b/crates/ruff_linter/src/checkers/physical_lines.rs @@ -6,6 +6,7 @@ use ruff_python_index::Indexer; use ruff_source_file::UniversalNewlines; use ruff_text_size::TextSize; +use crate::Locator; use crate::registry::Rule; use crate::rules::flake8_copyright::rules::missing_copyright_notice; use crate::rules::pycodestyle::rules::{ @@ -13,8 +14,8 @@ use crate::rules::pycodestyle::rules::{ trailing_whitespace, }; use crate::rules::pylint; +use crate::rules::ruff::rules::indented_form_feed; use crate::settings::LinterSettings; -use crate::Locator; pub(crate) fn check_physical_lines( locator: &Locator, @@ -71,6 +72,12 @@ pub(crate) fn check_physical_lines( diagnostics.push(diagnostic); } } + + if settings.rules.enabled(Rule::IndentedFormFeed) { + if let Some(diagnostic) = indented_form_feed(&line) { + diagnostics.push(diagnostic); + } + } } if enforce_no_newline_at_end_of_file { @@ -94,11 +101,11 @@ mod tests { use ruff_python_index::Indexer; use ruff_python_parser::parse_module; + use crate::Locator; use crate::line_width::LineLength; use crate::registry::Rule; use crate::rules::pycodestyle; use crate::settings::LinterSettings; - use crate::Locator; use super::check_physical_lines; diff --git a/crates/ruff_linter/src/checkers/tokens.rs b/crates/ruff_linter/src/checkers/tokens.rs index 7be23f8bfd035..99d8807fe33b2 100644 --- a/crates/ruff_linter/src/checkers/tokens.rs +++ b/crates/ruff_linter/src/checkers/tokens.rs @@ -8,8 +8,8 @@ use ruff_python_ast::PySourceType; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; use ruff_python_parser::Tokens; -use ruff_text_size::Ranged; +use crate::Locator; use crate::directives::TodoComment; use crate::registry::{AsRule, Rule}; use crate::rules::pycodestyle::rules::BlankLinesChecker; @@ -18,9 +18,8 @@ use crate::rules::{ flake8_pyi, flake8_todos, pycodestyle, pygrep_hooks, pylint, pyupgrade, ruff, }; use crate::settings::LinterSettings; -use crate::Locator; -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn check_tokens( tokens: &Tokens, path: &Path, @@ -73,12 +72,7 @@ pub(crate) fn check_tokens( } if settings.rules.enabled(Rule::UTF8EncodingDeclaration) { - pyupgrade::rules::unnecessary_coding_comment( - &mut diagnostics, - locator, - indexer, - comment_ranges, - ); + pyupgrade::rules::unnecessary_coding_comment(&mut diagnostics, locator, comment_ranges); } if settings.rules.enabled(Rule::TabIndentation) { @@ -93,12 +87,7 @@ pub(crate) fn check_tokens( Rule::InvalidCharacterZeroWidthSpace, ]) { for token in tokens { - pylint::rules::invalid_string_characters( - &mut diagnostics, - token.kind(), - token.range(), - locator, - ); + pylint::rules::invalid_string_characters(&mut diagnostics, token, locator); } } @@ -188,10 +177,14 @@ pub(crate) fn check_tokens( } if settings.rules.enabled(Rule::TooManyNewlinesAtEndOfFile) { - pycodestyle::rules::too_many_newlines_at_end_of_file(&mut diagnostics, tokens); + pycodestyle::rules::too_many_newlines_at_end_of_file( + &mut diagnostics, + tokens, + cell_offsets, + ); } - diagnostics.retain(|diagnostic| settings.rules.enabled(diagnostic.kind.rule())); + diagnostics.retain(|diagnostic| settings.rules.enabled(diagnostic.rule())); diagnostics } diff --git a/crates/ruff_linter/src/codes.rs b/crates/ruff_linter/src/codes.rs index caa4af3312fcc..63f81714dcf66 100644 --- a/crates/ruff_linter/src/codes.rs +++ b/crates/ruff_linter/src/codes.rs @@ -10,7 +10,7 @@ use crate::registry::{AsRule, Linter}; use crate::rule_selector::is_single_rule_selector; use crate::rules; -#[derive(PartialEq, Eq, PartialOrd, Ord)] +#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] pub struct NoqaCode(&'static str, &'static str); impl NoqaCode { @@ -46,6 +46,15 @@ impl PartialEq<&str> for NoqaCode { } } +impl serde::Serialize for NoqaCode { + fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> + where + S: serde::Serializer, + { + serializer.serialize_str(&self.to_string()) + } +} + #[derive(Debug, Copy, Clone)] pub enum RuleGroup { /// The rule is stable. @@ -61,7 +70,7 @@ pub enum RuleGroup { #[ruff_macros::map_codes] pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { - #[allow(clippy::enum_glob_use)] + #[expect(clippy::enum_glob_use)] use Linter::*; #[rustfmt::skip] @@ -126,7 +135,8 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pycodestyle, "E742") => (RuleGroup::Stable, rules::pycodestyle::rules::AmbiguousClassName), (Pycodestyle, "E743") => (RuleGroup::Stable, rules::pycodestyle::rules::AmbiguousFunctionName), (Pycodestyle, "E902") => (RuleGroup::Stable, rules::pycodestyle::rules::IOError), - (Pycodestyle, "E999") => (RuleGroup::Deprecated, rules::pycodestyle::rules::SyntaxError), + #[allow(deprecated)] + (Pycodestyle, "E999") => (RuleGroup::Removed, rules::pycodestyle::rules::SyntaxError), // pycodestyle warnings (Pycodestyle, "W191") => (RuleGroup::Stable, rules::pycodestyle::rules::TabIndentation), @@ -187,10 +197,11 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pylint, "C0131") => (RuleGroup::Stable, rules::pylint::rules::TypeBivariance), (Pylint, "C0132") => (RuleGroup::Stable, rules::pylint::rules::TypeParamNameMismatch), (Pylint, "C0205") => (RuleGroup::Stable, rules::pylint::rules::SingleStringSlots), - (Pylint, "C0206") => (RuleGroup::Preview, rules::pylint::rules::DictIndexMissingItems), + (Pylint, "C0206") => (RuleGroup::Stable, rules::pylint::rules::DictIndexMissingItems), (Pylint, "C0208") => (RuleGroup::Stable, rules::pylint::rules::IterationOverSet), (Pylint, "C0414") => (RuleGroup::Stable, rules::pylint::rules::UselessImportAlias), (Pylint, "C0415") => (RuleGroup::Preview, rules::pylint::rules::ImportOutsideTopLevel), + (Pylint, "C1802") => (RuleGroup::Stable, rules::pylint::rules::LenTest), (Pylint, "C1901") => (RuleGroup::Preview, rules::pylint::rules::CompareToEmptyString), (Pylint, "C2401") => (RuleGroup::Stable, rules::pylint::rules::NonAsciiName), (Pylint, "C2403") => (RuleGroup::Stable, rules::pylint::rules::NonAsciiImportName), @@ -257,7 +268,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pylint, "R1714") => (RuleGroup::Stable, rules::pylint::rules::RepeatedEqualityComparison), (Pylint, "R1722") => (RuleGroup::Stable, rules::pylint::rules::SysExitAlias), (Pylint, "R1730") => (RuleGroup::Stable, rules::pylint::rules::IfStmtMinMax), - (Pylint, "R1716") => (RuleGroup::Preview, rules::pylint::rules::BooleanChainedComparison), + (Pylint, "R1716") => (RuleGroup::Stable, rules::pylint::rules::BooleanChainedComparison), (Pylint, "R1733") => (RuleGroup::Preview, rules::pylint::rules::UnnecessaryDictIndexLookup), (Pylint, "R1736") => (RuleGroup::Stable, rules::pylint::rules::UnnecessaryListIndexLookup), (Pylint, "R2004") => (RuleGroup::Stable, rules::pylint::rules::MagicValueComparison), @@ -266,6 +277,8 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pylint, "R6104") => (RuleGroup::Preview, rules::pylint::rules::NonAugmentedAssignment), (Pylint, "R6201") => (RuleGroup::Preview, rules::pylint::rules::LiteralMembership), (Pylint, "R6301") => (RuleGroup::Preview, rules::pylint::rules::NoSelfUse), + #[cfg(any(feature = "test-rules", test))] + (Pylint, "W0101") => (RuleGroup::Preview, rules::pylint::rules::UnreachableCode), (Pylint, "W0108") => (RuleGroup::Preview, rules::pylint::rules::UnnecessaryLambda), (Pylint, "W0177") => (RuleGroup::Preview, rules::pylint::rules::NanComparison), (Pylint, "W0120") => (RuleGroup::Stable, rules::pylint::rules::UselessElseOnLoop), @@ -275,6 +288,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pylint, "W0131") => (RuleGroup::Stable, rules::pylint::rules::NamedExprWithoutContext), (Pylint, "W0133") => (RuleGroup::Stable, rules::pylint::rules::UselessExceptionStatement), (Pylint, "W0211") => (RuleGroup::Stable, rules::pylint::rules::BadStaticmethodArgument), + (Pylint, "W0244") => (RuleGroup::Preview, rules::pylint::rules::RedefinedSlotsInSubclass), (Pylint, "W0245") => (RuleGroup::Stable, rules::pylint::rules::SuperWithoutBrackets), (Pylint, "W0406") => (RuleGroup::Stable, rules::pylint::rules::ImportSelf), (Pylint, "W0602") => (RuleGroup::Stable, rules::pylint::rules::GlobalVariableNotAssigned), @@ -283,6 +297,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pylint, "W0642") => (RuleGroup::Stable, rules::pylint::rules::SelfOrClsAssignment), (Pylint, "W0711") => (RuleGroup::Stable, rules::pylint::rules::BinaryOpException), (Pylint, "W1501") => (RuleGroup::Stable, rules::pylint::rules::BadOpenMode), + (Pylint, "W1507") => (RuleGroup::Stable, rules::pylint::rules::ShallowCopyEnviron), (Pylint, "W1508") => (RuleGroup::Stable, rules::pylint::rules::InvalidEnvvarDefault), (Pylint, "W1509") => (RuleGroup::Stable, rules::pylint::rules::SubprocessPopenPreexecFn), (Pylint, "W1510") => (RuleGroup::Stable, rules::pylint::rules::SubprocessRunWithoutCheck), @@ -311,10 +326,9 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Builtins, "001") => (RuleGroup::Stable, rules::flake8_builtins::rules::BuiltinVariableShadowing), (Flake8Builtins, "002") => (RuleGroup::Stable, rules::flake8_builtins::rules::BuiltinArgumentShadowing), (Flake8Builtins, "003") => (RuleGroup::Stable, rules::flake8_builtins::rules::BuiltinAttributeShadowing), - // TODO(charlie): When stabilizing, remove preview gating for A001's treatment of imports. - (Flake8Builtins, "004") => (RuleGroup::Preview, rules::flake8_builtins::rules::BuiltinImportShadowing), - (Flake8Builtins, "005") => (RuleGroup::Preview, rules::flake8_builtins::rules::BuiltinModuleShadowing), - (Flake8Builtins, "006") => (RuleGroup::Preview, rules::flake8_builtins::rules::BuiltinLambdaArgumentShadowing), + (Flake8Builtins, "004") => (RuleGroup::Stable, rules::flake8_builtins::rules::BuiltinImportShadowing), + (Flake8Builtins, "005") => (RuleGroup::Stable, rules::flake8_builtins::rules::StdlibModuleShadowing), + (Flake8Builtins, "006") => (RuleGroup::Stable, rules::flake8_builtins::rules::BuiltinLambdaArgumentShadowing), // flake8-bugbear (Flake8Bugbear, "002") => (RuleGroup::Stable, rules::flake8_bugbear::rules::UnaryPrefixIncrementDecrement), @@ -351,11 +365,13 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Bugbear, "033") => (RuleGroup::Stable, rules::flake8_bugbear::rules::DuplicateValue), (Flake8Bugbear, "034") => (RuleGroup::Stable, rules::flake8_bugbear::rules::ReSubPositionalArgs), (Flake8Bugbear, "035") => (RuleGroup::Stable, rules::flake8_bugbear::rules::StaticKeyDictComprehension), - (Flake8Bugbear, "039") => (RuleGroup::Preview, rules::flake8_bugbear::rules::MutableContextvarDefault), + (Flake8Bugbear, "039") => (RuleGroup::Stable, rules::flake8_bugbear::rules::MutableContextvarDefault), (Flake8Bugbear, "901") => (RuleGroup::Preview, rules::flake8_bugbear::rules::ReturnInGenerator), + (Flake8Bugbear, "903") => (RuleGroup::Preview, rules::flake8_bugbear::rules::ClassAsDataStructure), (Flake8Bugbear, "904") => (RuleGroup::Stable, rules::flake8_bugbear::rules::RaiseWithoutFromInsideExcept), (Flake8Bugbear, "905") => (RuleGroup::Stable, rules::flake8_bugbear::rules::ZipWithoutExplicitStrict), (Flake8Bugbear, "909") => (RuleGroup::Preview, rules::flake8_bugbear::rules::LoopIteratorMutation), + (Flake8Bugbear, "911") => (RuleGroup::Stable, rules::flake8_bugbear::rules::BatchedWithoutExplicitStrict), // flake8-blind-except (Flake8BlindExcept, "001") => (RuleGroup::Stable, rules::flake8_blind_except::rules::BlindExcept), @@ -379,7 +395,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Comprehensions, "17") => (RuleGroup::Stable, rules::flake8_comprehensions::rules::UnnecessaryMap), (Flake8Comprehensions, "18") => (RuleGroup::Stable, rules::flake8_comprehensions::rules::UnnecessaryLiteralWithinDictCall), (Flake8Comprehensions, "19") => (RuleGroup::Stable, rules::flake8_comprehensions::rules::UnnecessaryComprehensionInCall), - (Flake8Comprehensions, "20") => (RuleGroup::Preview, rules::flake8_comprehensions::rules::UnnecessaryDictComprehensionForIterable), + (Flake8Comprehensions, "20") => (RuleGroup::Stable, rules::flake8_comprehensions::rules::UnnecessaryDictComprehensionForIterable), // flake8-debugger (Flake8Debugger, "0") => (RuleGroup::Stable, rules::flake8_debugger::rules::Debugger), @@ -427,8 +443,10 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Annotations, "001") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingTypeFunctionArgument), (Flake8Annotations, "002") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingTypeArgs), (Flake8Annotations, "003") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingTypeKwargs), - (Flake8Annotations, "101") => (RuleGroup::Deprecated, rules::flake8_annotations::rules::MissingTypeSelf), - (Flake8Annotations, "102") => (RuleGroup::Deprecated, rules::flake8_annotations::rules::MissingTypeCls), + #[allow(deprecated)] + (Flake8Annotations, "101") => (RuleGroup::Removed, rules::flake8_annotations::rules::MissingTypeSelf), + #[allow(deprecated)] + (Flake8Annotations, "102") => (RuleGroup::Removed, rules::flake8_annotations::rules::MissingTypeCls), (Flake8Annotations, "201") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingReturnTypeUndocumentedPublicFunction), (Flake8Annotations, "202") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingReturnTypePrivateFunction), (Flake8Annotations, "204") => (RuleGroup::Stable, rules::flake8_annotations::rules::MissingReturnTypeSpecialMethod), @@ -480,6 +498,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Simplify, "223") => (RuleGroup::Stable, rules::flake8_simplify::rules::ExprAndFalse), (Flake8Simplify, "300") => (RuleGroup::Stable, rules::flake8_simplify::rules::YodaConditions), (Flake8Simplify, "401") => (RuleGroup::Stable, rules::flake8_simplify::rules::IfElseBlockInsteadOfDictGet), + (Flake8Simplify, "905") => (RuleGroup::Stable, rules::flake8_simplify::rules::SplitStaticString), (Flake8Simplify, "910") => (RuleGroup::Stable, rules::flake8_simplify::rules::DictGetWithNoneDefault), (Flake8Simplify, "911") => (RuleGroup::Stable, rules::flake8_simplify::rules::ZipDictKeysAndValues), @@ -492,7 +511,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pyupgrade, "004") => (RuleGroup::Stable, rules::pyupgrade::rules::UselessObjectInheritance), (Pyupgrade, "005") => (RuleGroup::Stable, rules::pyupgrade::rules::DeprecatedUnittestAlias), (Pyupgrade, "006") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP585Annotation), - (Pyupgrade, "007") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP604Annotation), + (Pyupgrade, "007") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP604AnnotationUnion), (Pyupgrade, "008") => (RuleGroup::Stable, rules::pyupgrade::rules::SuperCallWithParameters), (Pyupgrade, "009") => (RuleGroup::Stable, rules::pyupgrade::rules::UTF8EncodingDeclaration), (Pyupgrade, "010") => (RuleGroup::Stable, rules::pyupgrade::rules::UnnecessaryFutureImport), @@ -511,7 +530,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pyupgrade, "024") => (RuleGroup::Stable, rules::pyupgrade::rules::OSErrorAlias), (Pyupgrade, "025") => (RuleGroup::Stable, rules::pyupgrade::rules::UnicodeKindPrefix), (Pyupgrade, "026") => (RuleGroup::Stable, rules::pyupgrade::rules::DeprecatedMockImport), - (Pyupgrade, "027") => (RuleGroup::Deprecated, rules::pyupgrade::rules::UnpackedListComprehension), + (Pyupgrade, "027") => (RuleGroup::Removed, rules::pyupgrade::rules::UnpackedListComprehension), (Pyupgrade, "028") => (RuleGroup::Stable, rules::pyupgrade::rules::YieldInForLoop), (Pyupgrade, "029") => (RuleGroup::Stable, rules::pyupgrade::rules::UnnecessaryBuiltinImport), (Pyupgrade, "030") => (RuleGroup::Stable, rules::pyupgrade::rules::FormatLiterals), @@ -522,12 +541,17 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pyupgrade, "035") => (RuleGroup::Stable, rules::pyupgrade::rules::DeprecatedImport), (Pyupgrade, "036") => (RuleGroup::Stable, rules::pyupgrade::rules::OutdatedVersionBlock), (Pyupgrade, "037") => (RuleGroup::Stable, rules::pyupgrade::rules::QuotedAnnotation), - (Pyupgrade, "038") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP604Isinstance), + (Pyupgrade, "038") => (RuleGroup::Deprecated, rules::pyupgrade::rules::NonPEP604Isinstance), (Pyupgrade, "039") => (RuleGroup::Stable, rules::pyupgrade::rules::UnnecessaryClassParentheses), (Pyupgrade, "040") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP695TypeAlias), (Pyupgrade, "041") => (RuleGroup::Stable, rules::pyupgrade::rules::TimeoutErrorAlias), (Pyupgrade, "042") => (RuleGroup::Preview, rules::pyupgrade::rules::ReplaceStrEnum), - (Pyupgrade, "043") => (RuleGroup::Preview, rules::pyupgrade::rules::UnnecessaryDefaultTypeArgs), + (Pyupgrade, "043") => (RuleGroup::Stable, rules::pyupgrade::rules::UnnecessaryDefaultTypeArgs), + (Pyupgrade, "044") => (RuleGroup::Stable, rules::pyupgrade::rules::NonPEP646Unpack), + (Pyupgrade, "045") => (RuleGroup::Preview, rules::pyupgrade::rules::NonPEP604AnnotationOptional), + (Pyupgrade, "046") => (RuleGroup::Preview, rules::pyupgrade::rules::NonPEP695GenericClass), + (Pyupgrade, "047") => (RuleGroup::Preview, rules::pyupgrade::rules::NonPEP695GenericFunction), + (Pyupgrade, "049") => (RuleGroup::Preview, rules::pyupgrade::rules::PrivateTypeParameter), // pydocstyle (Pydocstyle, "100") => (RuleGroup::Stable, rules::pydocstyle::rules::UndocumentedPublicModule), @@ -538,13 +562,13 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pydocstyle, "105") => (RuleGroup::Stable, rules::pydocstyle::rules::UndocumentedMagicMethod), (Pydocstyle, "106") => (RuleGroup::Stable, rules::pydocstyle::rules::UndocumentedPublicNestedClass), (Pydocstyle, "107") => (RuleGroup::Stable, rules::pydocstyle::rules::UndocumentedPublicInit), - (Pydocstyle, "200") => (RuleGroup::Stable, rules::pydocstyle::rules::FitsOnOneLine), - (Pydocstyle, "201") => (RuleGroup::Stable, rules::pydocstyle::rules::NoBlankLineBeforeFunction), - (Pydocstyle, "202") => (RuleGroup::Stable, rules::pydocstyle::rules::NoBlankLineAfterFunction), - (Pydocstyle, "203") => (RuleGroup::Stable, rules::pydocstyle::rules::OneBlankLineBeforeClass), - (Pydocstyle, "204") => (RuleGroup::Stable, rules::pydocstyle::rules::OneBlankLineAfterClass), - (Pydocstyle, "205") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLineAfterSummary), - (Pydocstyle, "206") => (RuleGroup::Stable, rules::pydocstyle::rules::IndentWithSpaces), + (Pydocstyle, "200") => (RuleGroup::Stable, rules::pydocstyle::rules::UnnecessaryMultilineDocstring), + (Pydocstyle, "201") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLineBeforeFunction), + (Pydocstyle, "202") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLineAfterFunction), + (Pydocstyle, "203") => (RuleGroup::Stable, rules::pydocstyle::rules::IncorrectBlankLineBeforeClass), + (Pydocstyle, "204") => (RuleGroup::Stable, rules::pydocstyle::rules::IncorrectBlankLineAfterClass), + (Pydocstyle, "205") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingBlankLineAfterSummary), + (Pydocstyle, "206") => (RuleGroup::Stable, rules::pydocstyle::rules::DocstringTabIndentation), (Pydocstyle, "207") => (RuleGroup::Stable, rules::pydocstyle::rules::UnderIndentation), (Pydocstyle, "208") => (RuleGroup::Stable, rules::pydocstyle::rules::OverIndentation), (Pydocstyle, "209") => (RuleGroup::Stable, rules::pydocstyle::rules::NewLineAfterLastParagraph), @@ -552,27 +576,27 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Pydocstyle, "211") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLineBeforeClass), (Pydocstyle, "212") => (RuleGroup::Stable, rules::pydocstyle::rules::MultiLineSummaryFirstLine), (Pydocstyle, "213") => (RuleGroup::Stable, rules::pydocstyle::rules::MultiLineSummarySecondLine), - (Pydocstyle, "214") => (RuleGroup::Stable, rules::pydocstyle::rules::SectionNotOverIndented), - (Pydocstyle, "215") => (RuleGroup::Stable, rules::pydocstyle::rules::SectionUnderlineNotOverIndented), + (Pydocstyle, "214") => (RuleGroup::Stable, rules::pydocstyle::rules::OverindentedSection), + (Pydocstyle, "215") => (RuleGroup::Stable, rules::pydocstyle::rules::OverindentedSectionUnderline), (Pydocstyle, "300") => (RuleGroup::Stable, rules::pydocstyle::rules::TripleSingleQuotes), (Pydocstyle, "301") => (RuleGroup::Stable, rules::pydocstyle::rules::EscapeSequenceInDocstring), - (Pydocstyle, "400") => (RuleGroup::Stable, rules::pydocstyle::rules::EndsInPeriod), + (Pydocstyle, "400") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingTrailingPeriod), (Pydocstyle, "401") => (RuleGroup::Stable, rules::pydocstyle::rules::NonImperativeMood), - (Pydocstyle, "402") => (RuleGroup::Stable, rules::pydocstyle::rules::NoSignature), - (Pydocstyle, "403") => (RuleGroup::Stable, rules::pydocstyle::rules::FirstLineCapitalized), + (Pydocstyle, "402") => (RuleGroup::Stable, rules::pydocstyle::rules::SignatureInDocstring), + (Pydocstyle, "403") => (RuleGroup::Stable, rules::pydocstyle::rules::FirstWordUncapitalized), (Pydocstyle, "404") => (RuleGroup::Stable, rules::pydocstyle::rules::DocstringStartsWithThis), - (Pydocstyle, "405") => (RuleGroup::Stable, rules::pydocstyle::rules::CapitalizeSectionName), - (Pydocstyle, "406") => (RuleGroup::Stable, rules::pydocstyle::rules::NewLineAfterSectionName), - (Pydocstyle, "407") => (RuleGroup::Stable, rules::pydocstyle::rules::DashedUnderlineAfterSection), - (Pydocstyle, "408") => (RuleGroup::Stable, rules::pydocstyle::rules::SectionUnderlineAfterName), - (Pydocstyle, "409") => (RuleGroup::Stable, rules::pydocstyle::rules::SectionUnderlineMatchesSectionLength), + (Pydocstyle, "405") => (RuleGroup::Stable, rules::pydocstyle::rules::NonCapitalizedSectionName), + (Pydocstyle, "406") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingNewLineAfterSectionName), + (Pydocstyle, "407") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingDashedUnderlineAfterSection), + (Pydocstyle, "408") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingSectionUnderlineAfterName), + (Pydocstyle, "409") => (RuleGroup::Stable, rules::pydocstyle::rules::MismatchedSectionUnderlineLength), (Pydocstyle, "410") => (RuleGroup::Stable, rules::pydocstyle::rules::NoBlankLineAfterSection), (Pydocstyle, "411") => (RuleGroup::Stable, rules::pydocstyle::rules::NoBlankLineBeforeSection), (Pydocstyle, "412") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLinesBetweenHeaderAndContent), - (Pydocstyle, "413") => (RuleGroup::Stable, rules::pydocstyle::rules::BlankLineAfterLastSection), + (Pydocstyle, "413") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingBlankLineAfterLastSection), (Pydocstyle, "414") => (RuleGroup::Stable, rules::pydocstyle::rules::EmptyDocstringSection), - (Pydocstyle, "415") => (RuleGroup::Stable, rules::pydocstyle::rules::EndsInPunctuation), - (Pydocstyle, "416") => (RuleGroup::Stable, rules::pydocstyle::rules::SectionNameEndsInColon), + (Pydocstyle, "415") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingTerminalPunctuation), + (Pydocstyle, "416") => (RuleGroup::Stable, rules::pydocstyle::rules::MissingSectionNameColon), (Pydocstyle, "417") => (RuleGroup::Stable, rules::pydocstyle::rules::UndocumentedParam), (Pydocstyle, "418") => (RuleGroup::Stable, rules::pydocstyle::rules::OverloadWithDocstring), (Pydocstyle, "419") => (RuleGroup::Stable, rules::pydocstyle::rules::EmptyDocstring), @@ -634,7 +658,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Bandit, "317") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousXMLSaxUsage), (Flake8Bandit, "318") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousXMLMiniDOMUsage), (Flake8Bandit, "319") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousXMLPullDOMUsage), - (Flake8Bandit, "320") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousXMLETreeUsage), + (Flake8Bandit, "320") => (RuleGroup::Deprecated, rules::flake8_bandit::rules::SuspiciousXMLETreeUsage), (Flake8Bandit, "321") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousFTPLibUsage), (Flake8Bandit, "323") => (RuleGroup::Stable, rules::flake8_bandit::rules::SuspiciousUnverifiedContextUsage), (Flake8Bandit, "324") => (RuleGroup::Stable, rules::flake8_bandit::rules::HashlibInsecureHashFunction), @@ -675,6 +699,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Bandit, "612") => (RuleGroup::Stable, rules::flake8_bandit::rules::LoggingConfigInsecureListen), (Flake8Bandit, "701") => (RuleGroup::Stable, rules::flake8_bandit::rules::Jinja2AutoescapeFalse), (Flake8Bandit, "702") => (RuleGroup::Stable, rules::flake8_bandit::rules::MakoTemplates), + (Flake8Bandit, "704") => (RuleGroup::Stable, rules::flake8_bandit::rules::UnsafeMarkupUse), // flake8-boolean-trap (Flake8BooleanTrap, "001") => (RuleGroup::Stable, rules::flake8_boolean_trap::rules::BooleanTypeHintPositionalArgument), @@ -703,6 +728,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Datetimez, "007") => (RuleGroup::Stable, rules::flake8_datetimez::rules::CallDatetimeStrptimeWithoutZone), (Flake8Datetimez, "011") => (RuleGroup::Stable, rules::flake8_datetimez::rules::CallDateToday), (Flake8Datetimez, "012") => (RuleGroup::Stable, rules::flake8_datetimez::rules::CallDateFromtimestamp), + (Flake8Datetimez, "901") => (RuleGroup::Stable, rules::flake8_datetimez::rules::DatetimeMinMax), // pygrep-hooks (PygrepHooks, "001") => (RuleGroup::Removed, rules::pygrep_hooks::rules::Eval), @@ -750,7 +776,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Pyi, "016") => (RuleGroup::Stable, rules::flake8_pyi::rules::DuplicateUnionMember), (Flake8Pyi, "017") => (RuleGroup::Stable, rules::flake8_pyi::rules::ComplexAssignmentInStub), (Flake8Pyi, "018") => (RuleGroup::Stable, rules::flake8_pyi::rules::UnusedPrivateTypeVar), - (Flake8Pyi, "019") => (RuleGroup::Stable, rules::flake8_pyi::rules::CustomTypeVarReturnType), + (Flake8Pyi, "019") => (RuleGroup::Stable, rules::flake8_pyi::rules::CustomTypeVarForSelf), (Flake8Pyi, "020") => (RuleGroup::Stable, rules::flake8_pyi::rules::QuotedAnnotationInStub), (Flake8Pyi, "021") => (RuleGroup::Stable, rules::flake8_pyi::rules::DocstringInStub), (Flake8Pyi, "024") => (RuleGroup::Stable, rules::flake8_pyi::rules::CollectionsNamedTuple), @@ -782,17 +808,20 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8Pyi, "058") => (RuleGroup::Stable, rules::flake8_pyi::rules::GeneratorReturnFromIterMethod), (Flake8Pyi, "057") => (RuleGroup::Stable, rules::flake8_pyi::rules::ByteStringUsage), (Flake8Pyi, "059") => (RuleGroup::Preview, rules::flake8_pyi::rules::GenericNotLastBaseClass), + (Flake8Pyi, "061") => (RuleGroup::Preview, rules::flake8_pyi::rules::RedundantNoneLiteral), (Flake8Pyi, "062") => (RuleGroup::Stable, rules::flake8_pyi::rules::DuplicateLiteralMember), - (Flake8Pyi, "063") => (RuleGroup::Preview, rules::flake8_pyi::rules::PrePep570PositionalArgument), - (Flake8Pyi, "064") => (RuleGroup::Preview, rules::flake8_pyi::rules::RedundantFinalLiteral), - (Flake8Pyi, "066") => (RuleGroup::Preview, rules::flake8_pyi::rules::BadVersionInfoOrder), + (Flake8Pyi, "063") => (RuleGroup::Stable, rules::flake8_pyi::rules::Pep484StylePositionalOnlyParameter), + (Flake8Pyi, "064") => (RuleGroup::Stable, rules::flake8_pyi::rules::RedundantFinalLiteral), + (Flake8Pyi, "066") => (RuleGroup::Stable, rules::flake8_pyi::rules::BadVersionInfoOrder), // flake8-pytest-style (Flake8PytestStyle, "001") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestFixtureIncorrectParenthesesStyle), (Flake8PytestStyle, "002") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestFixturePositionalArgs), (Flake8PytestStyle, "003") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestExtraneousScopeFunction), - (Flake8PytestStyle, "004") => (RuleGroup::Deprecated, rules::flake8_pytest_style::rules::PytestMissingFixtureNameUnderscore), - (Flake8PytestStyle, "005") => (RuleGroup::Deprecated, rules::flake8_pytest_style::rules::PytestIncorrectFixtureNameUnderscore), + #[allow(deprecated)] + (Flake8PytestStyle, "004") => (RuleGroup::Removed, rules::flake8_pytest_style::rules::PytestMissingFixtureNameUnderscore), + #[allow(deprecated)] + (Flake8PytestStyle, "005") => (RuleGroup::Removed, rules::flake8_pytest_style::rules::PytestIncorrectFixtureNameUnderscore), (Flake8PytestStyle, "006") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestParametrizeNamesWrongType), (Flake8PytestStyle, "007") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestParametrizeValuesWrongType), (Flake8PytestStyle, "008") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestPatchWithLambda), @@ -815,6 +844,10 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8PytestStyle, "025") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestErroneousUseFixturesOnFixture), (Flake8PytestStyle, "026") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestUseFixturesWithoutParameters), (Flake8PytestStyle, "027") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestUnittestRaisesAssertion), + (Flake8PytestStyle, "028") => (RuleGroup::Preview, rules::flake8_pytest_style::rules::PytestParameterWithDefaultArgument), + (Flake8PytestStyle, "029") => (RuleGroup::Preview, rules::flake8_pytest_style::rules::PytestWarnsWithoutWarning), + (Flake8PytestStyle, "030") => (RuleGroup::Preview, rules::flake8_pytest_style::rules::PytestWarnsTooBroad), + (Flake8PytestStyle, "031") => (RuleGroup::Preview, rules::flake8_pytest_style::rules::PytestWarnsWithMultipleStatements), // flake8-pie (Flake8Pie, "790") => (RuleGroup::Stable, rules::flake8_pie::rules::UnnecessaryPlaceholder), @@ -847,6 +880,9 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8TypeChecking, "003") => (RuleGroup::Stable, rules::flake8_type_checking::rules::TypingOnlyStandardLibraryImport), (Flake8TypeChecking, "004") => (RuleGroup::Stable, rules::flake8_type_checking::rules::RuntimeImportInTypeCheckingBlock), (Flake8TypeChecking, "005") => (RuleGroup::Stable, rules::flake8_type_checking::rules::EmptyTypeCheckingBlock), + (Flake8TypeChecking, "006") => (RuleGroup::Stable, rules::flake8_type_checking::rules::RuntimeCastValue), + (Flake8TypeChecking, "007") => (RuleGroup::Stable, rules::flake8_type_checking::rules::UnquotedTypeAlias), + (Flake8TypeChecking, "008") => (RuleGroup::Preview, rules::flake8_type_checking::rules::QuotedTypeAlias), (Flake8TypeChecking, "010") => (RuleGroup::Stable, rules::flake8_type_checking::rules::RuntimeStringUnion), // tryceratops @@ -895,6 +931,8 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Flake8UsePathlib, "205") => (RuleGroup::Stable, rules::flake8_use_pathlib::rules::OsPathGetctime), (Flake8UsePathlib, "206") => (RuleGroup::Stable, rules::flake8_use_pathlib::rules::OsSepSplit), (Flake8UsePathlib, "207") => (RuleGroup::Stable, rules::flake8_use_pathlib::rules::Glob), + (Flake8UsePathlib, "208") => (RuleGroup::Stable, rules::flake8_use_pathlib::violations::OsListdir), + (Flake8UsePathlib, "210") => (RuleGroup::Stable, rules::flake8_use_pathlib::rules::InvalidPathlibWithSuffix), // flake8-logging-format (Flake8LoggingFormat, "001") => (RuleGroup::Stable, rules::flake8_logging_format::violations::LoggingStringFormat), @@ -919,9 +957,9 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Numpy, "201") => (RuleGroup::Stable, rules::numpy::rules::Numpy2Deprecation), // fastapi - (FastApi, "001") => (RuleGroup::Preview, rules::fastapi::rules::FastApiRedundantResponseModel), - (FastApi, "002") => (RuleGroup::Preview, rules::fastapi::rules::FastApiNonAnnotatedDependency), - (FastApi, "003") => (RuleGroup::Preview, rules::fastapi::rules::FastApiUnusedPathParameter), + (FastApi, "001") => (RuleGroup::Stable, rules::fastapi::rules::FastApiRedundantResponseModel), + (FastApi, "002") => (RuleGroup::Stable, rules::fastapi::rules::FastApiNonAnnotatedDependency), + (FastApi, "003") => (RuleGroup::Stable, rules::fastapi::rules::FastApiUnusedPathParameter), // pydoclint (Pydoclint, "201") => (RuleGroup::Preview, rules::pydoclint::rules::DocstringMissingReturns), @@ -950,21 +988,45 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Ruff, "018") => (RuleGroup::Stable, rules::ruff::rules::AssignmentInAssert), (Ruff, "019") => (RuleGroup::Stable, rules::ruff::rules::UnnecessaryKeyCheck), (Ruff, "020") => (RuleGroup::Stable, rules::ruff::rules::NeverUnion), - (Ruff, "021") => (RuleGroup::Preview, rules::ruff::rules::ParenthesizeChainedOperators), - (Ruff, "022") => (RuleGroup::Preview, rules::ruff::rules::UnsortedDunderAll), - (Ruff, "023") => (RuleGroup::Preview, rules::ruff::rules::UnsortedDunderSlots), + (Ruff, "021") => (RuleGroup::Stable, rules::ruff::rules::ParenthesizeChainedOperators), + (Ruff, "022") => (RuleGroup::Stable, rules::ruff::rules::UnsortedDunderAll), + (Ruff, "023") => (RuleGroup::Stable, rules::ruff::rules::UnsortedDunderSlots), (Ruff, "024") => (RuleGroup::Stable, rules::ruff::rules::MutableFromkeysValue), (Ruff, "026") => (RuleGroup::Stable, rules::ruff::rules::DefaultFactoryKwarg), (Ruff, "027") => (RuleGroup::Preview, rules::ruff::rules::MissingFStringSyntax), (Ruff, "028") => (RuleGroup::Preview, rules::ruff::rules::InvalidFormatterSuppressionComment), (Ruff, "029") => (RuleGroup::Preview, rules::ruff::rules::UnusedAsync), - (Ruff, "030") => (RuleGroup::Preview, rules::ruff::rules::AssertWithPrintMessage), + (Ruff, "030") => (RuleGroup::Stable, rules::ruff::rules::AssertWithPrintMessage), (Ruff, "031") => (RuleGroup::Preview, rules::ruff::rules::IncorrectlyParenthesizedTupleInSubscript), - (Ruff, "032") => (RuleGroup::Preview, rules::ruff::rules::DecimalFromFloatLiteral), - (Ruff, "033") => (RuleGroup::Preview, rules::ruff::rules::PostInitDefault), - (Ruff, "034") => (RuleGroup::Preview, rules::ruff::rules::UselessIfElse), + (Ruff, "032") => (RuleGroup::Stable, rules::ruff::rules::DecimalFromFloatLiteral), + (Ruff, "033") => (RuleGroup::Stable, rules::ruff::rules::PostInitDefault), + (Ruff, "034") => (RuleGroup::Stable, rules::ruff::rules::UselessIfElse), + (Ruff, "035") => (RuleGroup::Removed, rules::ruff::rules::RuffUnsafeMarkupUse), + (Ruff, "036") => (RuleGroup::Preview, rules::ruff::rules::NoneNotAtEndOfUnion), + (Ruff, "037") => (RuleGroup::Preview, rules::ruff::rules::UnnecessaryEmptyIterableWithinDequeCall), + (Ruff, "038") => (RuleGroup::Preview, rules::ruff::rules::RedundantBoolLiteral), + (Ruff, "039") => (RuleGroup::Preview, rules::ruff::rules::UnrawRePattern), + (Ruff, "040") => (RuleGroup::Stable, rules::ruff::rules::InvalidAssertMessageLiteralArgument), + (Ruff, "041") => (RuleGroup::Stable, rules::ruff::rules::UnnecessaryNestedLiteral), + (Ruff, "043") => (RuleGroup::Preview, rules::ruff::rules::PytestRaisesAmbiguousPattern), + (Ruff, "045") => (RuleGroup::Preview, rules::ruff::rules::ImplicitClassVarInDataclass), + (Ruff, "046") => (RuleGroup::Stable, rules::ruff::rules::UnnecessaryCastToInt), + (Ruff, "047") => (RuleGroup::Preview, rules::ruff::rules::NeedlessElse), + (Ruff, "048") => (RuleGroup::Stable, rules::ruff::rules::MapIntVersionParsing), + (Ruff, "049") => (RuleGroup::Preview, rules::ruff::rules::DataclassEnum), + (Ruff, "051") => (RuleGroup::Stable, rules::ruff::rules::IfKeyInDictDel), + (Ruff, "052") => (RuleGroup::Preview, rules::ruff::rules::UsedDummyVariable), + (Ruff, "053") => (RuleGroup::Preview, rules::ruff::rules::ClassWithMixedTypeVars), + (Ruff, "054") => (RuleGroup::Preview, rules::ruff::rules::IndentedFormFeed), + (Ruff, "055") => (RuleGroup::Preview, rules::ruff::rules::UnnecessaryRegularExpression), + (Ruff, "056") => (RuleGroup::Preview, rules::ruff::rules::FalsyDictGetFallback), + (Ruff, "057") => (RuleGroup::Preview, rules::ruff::rules::UnnecessaryRound), + (Ruff, "058") => (RuleGroup::Preview, rules::ruff::rules::StarmapZip), + (Ruff, "059") => (RuleGroup::Preview, rules::ruff::rules::UnusedUnpackedVariable), + (Ruff, "060") => (RuleGroup::Preview, rules::ruff::rules::InEmptyCollection), (Ruff, "100") => (RuleGroup::Stable, rules::ruff::rules::UnusedNOQA), (Ruff, "101") => (RuleGroup::Stable, rules::ruff::rules::RedirectedNOQA), + (Ruff, "102") => (RuleGroup::Preview, rules::ruff::rules::InvalidRuleCode), (Ruff, "200") => (RuleGroup::Stable, rules::ruff::rules::InvalidPyprojectToml), #[cfg(any(feature = "test-rules", test))] @@ -1017,6 +1079,11 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { // airflow (Airflow, "001") => (RuleGroup::Stable, rules::airflow::rules::AirflowVariableNameTaskIdMismatch), + (Airflow, "002") => (RuleGroup::Preview, rules::airflow::rules::AirflowDagNoScheduleArgument), + (Airflow, "301") => (RuleGroup::Preview, rules::airflow::rules::Airflow3Removal), + (Airflow, "302") => (RuleGroup::Preview, rules::airflow::rules::Airflow3MovedToProvider), + (Airflow, "311") => (RuleGroup::Preview, rules::airflow::rules::Airflow3SuggestedUpdate), + (Airflow, "312") => (RuleGroup::Preview, rules::airflow::rules::Airflow3SuggestedToMoveToProvider), // perflint (Perflint, "101") => (RuleGroup::Stable, rules::perflint::rules::UnnecessaryListCast), @@ -1045,6 +1112,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Refurb, "113") => (RuleGroup::Preview, rules::refurb::rules::RepeatedAppend), (Refurb, "116") => (RuleGroup::Preview, rules::refurb::rules::FStringNumberFormat), (Refurb, "118") => (RuleGroup::Preview, rules::refurb::rules::ReimplementedOperator), + (Refurb, "122") => (RuleGroup::Preview, rules::refurb::rules::ForLoopWrites), (Refurb, "129") => (RuleGroup::Stable, rules::refurb::rules::ReadlinesInFor), (Refurb, "131") => (RuleGroup::Preview, rules::refurb::rules::DeleteFullSlice), (Refurb, "132") => (RuleGroup::Preview, rules::refurb::rules::CheckAndRemoveFromSet), @@ -1058,6 +1126,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Refurb, "156") => (RuleGroup::Preview, rules::refurb::rules::HardcodedStringCharset), (Refurb, "157") => (RuleGroup::Preview, rules::refurb::rules::VerboseDecimalConstructor), (Refurb, "161") => (RuleGroup::Stable, rules::refurb::rules::BitCount), + (Refurb, "162") => (RuleGroup::Preview, rules::refurb::rules::FromisoformatReplaceZ), (Refurb, "163") => (RuleGroup::Stable, rules::refurb::rules::RedundantLogBase), (Refurb, "164") => (RuleGroup::Preview, rules::refurb::rules::UnnecessaryFromFloat), (Refurb, "166") => (RuleGroup::Preview, rules::refurb::rules::IntOnSlicedStr), @@ -1069,14 +1138,18 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> { (Refurb, "180") => (RuleGroup::Preview, rules::refurb::rules::MetaClassABCMeta), (Refurb, "181") => (RuleGroup::Stable, rules::refurb::rules::HashlibDigestHex), (Refurb, "187") => (RuleGroup::Stable, rules::refurb::rules::ListReverseCopy), - (Refurb, "188") => (RuleGroup::Preview, rules::refurb::rules::SliceToRemovePrefixOrSuffix), + (Refurb, "188") => (RuleGroup::Stable, rules::refurb::rules::SliceToRemovePrefixOrSuffix), + (Refurb, "189") => (RuleGroup::Preview, rules::refurb::rules::SubclassBuiltin), (Refurb, "192") => (RuleGroup::Preview, rules::refurb::rules::SortedMinMax), // flake8-logging (Flake8Logging, "001") => (RuleGroup::Stable, rules::flake8_logging::rules::DirectLoggerInstantiation), (Flake8Logging, "002") => (RuleGroup::Stable, rules::flake8_logging::rules::InvalidGetLoggerArgument), + (Flake8Logging, "004") => (RuleGroup::Preview, rules::flake8_logging::rules::LogExceptionOutsideExceptHandler), (Flake8Logging, "007") => (RuleGroup::Stable, rules::flake8_logging::rules::ExceptionWithoutExcInfo), (Flake8Logging, "009") => (RuleGroup::Stable, rules::flake8_logging::rules::UndocumentedWarn), + (Flake8Logging, "014") => (RuleGroup::Preview, rules::flake8_logging::rules::ExcInfoOutsideExceptHandler), + (Flake8Logging, "015") => (RuleGroup::Stable, rules::flake8_logging::rules::RootLoggerCall), _ => return None, }) diff --git a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_end_of_line.snap b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_end_of_line.snap index 6e540f9ee6244..9d9661bb8d5c7 100644 --- a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_end_of_line.snap +++ b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_end_of_line.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/comments/shebang.rs expression: "ShebangDirective::try_extract(source)" +snapshot_kind: text --- None diff --git a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_leading_space.snap b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_leading_space.snap index 6e540f9ee6244..9d9661bb8d5c7 100644 --- a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_leading_space.snap +++ b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_leading_space.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/comments/shebang.rs expression: "ShebangDirective::try_extract(source)" +snapshot_kind: text --- None diff --git a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match.snap b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match.snap index 87bd31a99cc06..c8014060ac1b1 100644 --- a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match.snap +++ b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/comments/shebang.rs expression: "ShebangDirective::try_extract(source)" +snapshot_kind: text --- Some( ShebangDirective( diff --git a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match_trailing_comment.snap b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match_trailing_comment.snap index 6177b629e21af..f7db7bfa104a4 100644 --- a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match_trailing_comment.snap +++ b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_match_trailing_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/comments/shebang.rs expression: "ShebangDirective::try_extract(source)" +snapshot_kind: text --- Some( ShebangDirective( diff --git a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_non_match.snap b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_non_match.snap index 6e540f9ee6244..9d9661bb8d5c7 100644 --- a/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_non_match.snap +++ b/crates/ruff_linter/src/comments/snapshots/ruff_linter__comments__shebang__tests__shebang_non_match.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/comments/shebang.rs expression: "ShebangDirective::try_extract(source)" +snapshot_kind: text --- None diff --git a/crates/ruff_linter/src/cst/helpers.rs b/crates/ruff_linter/src/cst/helpers.rs index b41d6348f8605..4e871e53ec98e 100644 --- a/crates/ruff_linter/src/cst/helpers.rs +++ b/crates/ruff_linter/src/cst/helpers.rs @@ -19,14 +19,14 @@ pub(crate) fn or_space(whitespace: ParenthesizableWhitespace) -> Parenthesizable /// Negate a condition, i.e., `a` => `not a` and `not a` => `a`. pub(crate) fn negate<'a>(expression: &Expression<'a>) -> Expression<'a> { - if let Expression::UnaryOperation(ref expression) = expression { + if let Expression::UnaryOperation(expression) = expression { if matches!(expression.operator, libcst_native::UnaryOp::Not { .. }) { return *expression.expression.clone(); } } // If the expression is `True` or `False`, return the opposite. - if let Expression::Name(ref expression) = expression { + if let Expression::Name(expression) = expression { match expression.value { "True" => { return Expression::Name(Box::new(Name { diff --git a/crates/ruff_linter/src/cst/matchers.rs b/crates/ruff_linter/src/cst/matchers.rs index 3bce354cb60b8..3f4e32cca1094 100644 --- a/crates/ruff_linter/src/cst/matchers.rs +++ b/crates/ruff_linter/src/cst/matchers.rs @@ -1,5 +1,5 @@ use crate::fix::codemods::CodegenStylist; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use libcst_native::{ Arg, Attribute, Call, Comparison, CompoundStatement, Dict, Expression, FormattedString, FormattedStringContent, FormattedStringExpression, FunctionDef, GeneratorExp, If, Import, diff --git a/crates/ruff_linter/src/directives.rs b/crates/ruff_linter/src/directives.rs index 128042bc8dba8..bded1a8f2bedf 100644 --- a/crates/ruff_linter/src/directives.rs +++ b/crates/ruff_linter/src/directives.rs @@ -11,15 +11,15 @@ use ruff_python_trivia::CommentRanges; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::noqa::NoqaMapping; use crate::settings::LinterSettings; -use crate::Locator; bitflags! { #[derive(Debug, Copy, Clone)] pub struct Flags: u8 { - const NOQA = 0b0000_0001; - const ISORT = 0b0000_0010; + const NOQA = 1 << 0; + const ISORT = 1 << 1; } } @@ -320,7 +320,7 @@ impl<'a> TodoDirective<'a> { subset = &comment[relative_offset.to_usize()..]; } else { break; - }; + } } None @@ -366,11 +366,11 @@ mod tests { use ruff_python_trivia::CommentRanges; use ruff_text_size::{TextLen, TextRange, TextSize}; + use crate::Locator; use crate::directives::{ - extract_isort_directives, extract_noqa_line_for, TodoDirective, TodoDirectiveKind, + TodoDirective, TodoDirectiveKind, extract_isort_directives, extract_noqa_line_for, }; use crate::noqa::NoqaMapping; - use crate::Locator; use super::IsortDirectives; diff --git a/crates/ruff_linter/src/doc_lines.rs b/crates/ruff_linter/src/doc_lines.rs index 5996d139ab2ec..94e1d16f65a1d 100644 --- a/crates/ruff_linter/src/doc_lines.rs +++ b/crates/ruff_linter/src/doc_lines.rs @@ -4,7 +4,7 @@ use std::iter::FusedIterator; use std::slice::Iter; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Stmt, Suite}; use ruff_python_parser::{Token, TokenKind, Tokens}; use ruff_source_file::UniversalNewlineIterator; diff --git a/crates/ruff_linter/src/docstrings/mod.rs b/crates/ruff_linter/src/docstrings/mod.rs index 7715beea865ba..6d5e6e257848a 100644 --- a/crates/ruff_linter/src/docstrings/mod.rs +++ b/crates/ruff_linter/src/docstrings/mod.rs @@ -1,9 +1,10 @@ use std::fmt::{Debug, Formatter}; use std::ops::Deref; -use ruff_python_ast::ExprStringLiteral; +use ruff_python_ast::{self as ast, StringFlags}; use ruff_python_semantic::Definition; -use ruff_text_size::{Ranged, TextRange}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextRange, TextSize}; pub(crate) mod extraction; pub(crate) mod google; @@ -15,26 +16,71 @@ pub(crate) mod styles; pub(crate) struct Docstring<'a> { pub(crate) definition: &'a Definition<'a>, /// The literal AST node representing the docstring. - pub(crate) expr: &'a ExprStringLiteral, - /// The content of the docstring, including the leading and trailing quotes. - pub(crate) contents: &'a str, - /// The range of the docstring body (without the quotes). The range is relative to [`Self::contents`]. - pub(crate) body_range: TextRange, - pub(crate) indentation: &'a str, + pub(crate) expr: &'a ast::StringLiteral, + /// The source file the docstring was defined in. + pub(crate) source: &'a str, } impl<'a> Docstring<'a> { + fn flags(&self) -> ast::StringLiteralFlags { + self.expr.flags + } + + /// The contents of the docstring, including the opening and closing quotes. + pub(crate) fn contents(&self) -> &'a str { + &self.source[self.range()] + } + + /// The contents of the docstring, excluding the opening and closing quotes. pub(crate) fn body(&self) -> DocstringBody { DocstringBody { docstring: self } } - pub(crate) fn leading_quote(&self) -> &'a str { - &self.contents[TextRange::up_to(self.body_range.start())] + /// Compute the start position of the docstring's opening line + pub(crate) fn line_start(&self) -> TextSize { + self.source.line_start(self.start()) + } + + /// Return the slice of source code that represents the indentation of the docstring's opening quotes. + pub(crate) fn compute_indentation(&self) -> &'a str { + &self.source[TextRange::new(self.line_start(), self.start())] + } + + pub(crate) fn quote_style(&self) -> ast::str::Quote { + self.flags().quote_style() + } + + pub(crate) fn is_raw_string(&self) -> bool { + self.flags().prefix().is_raw() + } + + pub(crate) fn is_u_string(&self) -> bool { + self.flags().prefix().is_unicode() + } + + pub(crate) fn is_triple_quoted(&self) -> bool { + self.flags().is_triple_quoted() + } + + /// The docstring's prefixes as they exist in the original source code. + pub(crate) fn prefix_str(&self) -> &'a str { + // N.B. This will normally be exactly the same as what you might get from + // `self.flags().prefix().as_str()`, but doing it this way has a few small advantages. + // For example, the casing of the `u` prefix will be preserved if it's a u-string. + &self.source[TextRange::new( + self.start(), + self.start() + self.flags().prefix().text_len(), + )] + } + + /// The docstring's "opener" (the string's prefix, if any, and its opening quotes). + pub(crate) fn opener(&self) -> &'a str { + &self.source[TextRange::new(self.start(), self.start() + self.flags().opener_len())] } - pub(crate) fn triple_quoted(&self) -> bool { - let leading_quote = self.leading_quote(); - leading_quote.ends_with("\"\"\"") || leading_quote.ends_with("'''") + /// The docstring's closing quotes. + pub(crate) fn closer(&self) -> &'a str { + &self.source[TextRange::new(self.end() - self.flags().closer_len(), self.end())] } } @@ -51,13 +97,13 @@ pub(crate) struct DocstringBody<'a> { impl<'a> DocstringBody<'a> { pub(crate) fn as_str(self) -> &'a str { - &self.docstring.contents[self.docstring.body_range] + &self.docstring.source[self.range()] } } impl Ranged for DocstringBody<'_> { fn range(&self) -> TextRange { - self.docstring.body_range + self.docstring.start() + self.docstring.expr.content_range() } } diff --git a/crates/ruff_linter/src/docstrings/sections.rs b/crates/ruff_linter/src/docstrings/sections.rs index 1068a0db07535..3151ef45a0357 100644 --- a/crates/ruff_linter/src/docstrings/sections.rs +++ b/crates/ruff_linter/src/docstrings/sections.rs @@ -2,6 +2,7 @@ use std::fmt::{Debug, Formatter}; use std::iter::FusedIterator; use ruff_python_ast::docstrings::{leading_space, leading_words}; +use ruff_python_semantic::Definition; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; use strum_macros::EnumIter; @@ -130,34 +131,6 @@ impl SectionKind { Self::Yields => "Yields", } } - - /// Returns `true` if a section can contain subsections, as in: - /// ```python - /// Yields - /// ------ - /// int - /// Description of the anonymous integer return value. - /// ``` - /// - /// For NumPy, see: <https://numpydoc.readthedocs.io/en/latest/format.html> - /// - /// For Google, see: <https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings> - pub(crate) fn has_subsections(self) -> bool { - matches!( - self, - Self::Args - | Self::Arguments - | Self::OtherArgs - | Self::OtherParameters - | Self::OtherParams - | Self::Parameters - | Self::Raises - | Self::Returns - | Self::SeeAlso - | Self::Warns - | Self::Yields - ) - } } pub(crate) struct SectionContexts<'a> { @@ -195,6 +168,7 @@ impl<'a> SectionContexts<'a> { last.as_ref(), previous_line.as_ref(), lines.peek(), + docstring.definition, ) { if let Some(mut last) = last.take() { last.range = TextRange::new(last.start(), line.start()); @@ -279,7 +253,7 @@ impl<'a> Iterator for SectionContextsIter<'a> { } } -impl<'a> DoubleEndedIterator for SectionContextsIter<'a> { +impl DoubleEndedIterator for SectionContextsIter<'_> { fn next_back(&mut self) -> Option<Self::Item> { let back = self.inner.next_back()?; Some(SectionContext { @@ -444,6 +418,7 @@ fn suspected_as_section(line: &str, style: SectionStyle) -> Option<SectionKind> } /// Check if the suspected context is really a section header. +#[expect(clippy::too_many_arguments)] fn is_docstring_section( line: &Line, indent_size: TextSize, @@ -452,7 +427,9 @@ fn is_docstring_section( previous_section: Option<&SectionContextData>, previous_line: Option<&Line>, next_line: Option<&Line>, + definition: &Definition<'_>, ) -> bool { + // for function definitions, track the known argument names for more accurate section detection. // Determine whether the current line looks like a section header, e.g., "Args:". let section_name_suffix = line[usize::from(indent_size + section_name_size)..].trim(); let this_looks_like_a_section_name = @@ -467,8 +444,7 @@ fn is_docstring_section( if next_line.is_empty() { false } else { - let next_line_is_underline = next_line.chars().all(|char| matches!(char, '-' | '=')); - next_line_is_underline + next_line.chars().all(|char| matches!(char, '-' | '=')) } }); if next_line_is_underline { @@ -476,7 +452,7 @@ fn is_docstring_section( } // Determine whether the previous line looks like the end of a paragraph. - let previous_line_looks_like_end_of_paragraph = previous_line.map_or(true, |previous_line| { + let previous_line_looks_like_end_of_paragraph = previous_line.is_none_or(|previous_line| { let previous_line = previous_line.trim(); let previous_line_ends_with_punctuation = [',', ';', '.', '-', '\\', '/', ']', '}', ')'] .into_iter() @@ -509,44 +485,80 @@ fn is_docstring_section( // ``` // However, if the header is an _exact_ match (like `Returns:`, as opposed to `returns:`), then // continue to treat it as a section header. - if section_kind.has_subsections() { - if let Some(previous_section) = previous_section { - let verbatim = &line[TextRange::at(indent_size, section_name_size)]; - - // If the section is more deeply indented, assume it's a subsection, as in: - // ```python - // def func(args: tuple[int]): - // """Toggle the gizmo. - // - // Args: - // args: The arguments to the function. - // """ - // ``` - if previous_section.indent_size < indent_size { - if section_kind.as_str() != verbatim { - return false; - } + if let Some(previous_section) = previous_section { + let verbatim = &line[TextRange::at(indent_size, section_name_size)]; + + // If the section is more deeply indented, assume it's a subsection, as in: + // ```python + // def func(args: tuple[int]): + // """Toggle the gizmo. + // + // Args: + // args: The arguments to the function. + // """ + // ``` + // As noted above, an exact match for a section name (like the inner `Args:` below) is + // treated as a section header, unless the enclosing `Definition` is a function and contains + // a parameter with the same name, as in: + // ```python + // def func(Args: tuple[int]): + // """Toggle the gizmo. + // + // Args: + // Args: The arguments to the function. + // """ + // ``` + if previous_section.indent_size < indent_size { + let section_name = section_kind.as_str(); + if section_name != verbatim || has_parameter(definition, section_name) { + return false; } + } - // If the section isn't underlined, and isn't title-cased, assume it's a subsection, - // as in: - // ```python - // def func(parameters: tuple[int]): - // """Toggle the gizmo. - // - // Parameters: - // ----- - // parameters: - // The arguments to the function. - // """ - // ``` - if !next_line_is_underline && verbatim.chars().next().is_some_and(char::is_lowercase) { - if section_kind.as_str() != verbatim { - return false; - } + // If the section has a preceding empty line, assume it's _not_ a subsection, as in: + // ```python + // def func(args: tuple[int]): + // """Toggle the gizmo. + // + // Args: + // args: The arguments to the function. + // + // returns: + // The return value of the function. + // """ + // ``` + if previous_line.is_some_and(|line| line.trim().is_empty()) { + return true; + } + + // If the section isn't underlined, and isn't title-cased, assume it's a subsection, + // as in: + // ```python + // def func(parameters: tuple[int]): + // """Toggle the gizmo. + // + // Parameters: + // ----- + // parameters: + // The arguments to the function. + // """ + // ``` + if !next_line_is_underline && verbatim.chars().next().is_some_and(char::is_lowercase) { + if section_kind.as_str() != verbatim { + return false; } } } true } + +/// Returns whether or not `definition` is a function definition and contains a parameter with the +/// same name as `section_name`. +fn has_parameter(definition: &Definition, section_name: &str) -> bool { + definition.as_function_def().is_some_and(|func| { + func.parameters + .iter() + .any(|param| param.name() == section_name) + }) +} diff --git a/crates/ruff_linter/src/fix/codemods.rs b/crates/ruff_linter/src/fix/codemods.rs index fe9c4074bb47b..29db53fed164b 100644 --- a/crates/ruff_linter/src/fix/codemods.rs +++ b/crates/ruff_linter/src/fix/codemods.rs @@ -2,20 +2,21 @@ //! and return the modified code snippet as output. use std::borrow::Cow; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use libcst_native::{ Codegen, CodegenState, Expression, ImportNames, NameOrAttribute, ParenthesizableWhitespace, SmallStatement, Statement, }; -use smallvec::{smallvec, SmallVec}; +use rustc_hash::{FxHashMap, FxHashSet}; +use smallvec::{SmallVec, smallvec}; use unicode_normalization::UnicodeNormalization; -use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::Stmt; +use ruff_python_ast::name::UnqualifiedName; use ruff_python_codegen::Stylist; -use crate::cst::matchers::match_statement; use crate::Locator; +use crate::cst::matchers::match_statement; /// Glue code to make libcst codegen work with ruff's Stylist pub(crate) trait CodegenStylist<'a>: Codegen<'a> { @@ -80,14 +81,21 @@ pub(crate) fn remove_imports<'a>( // Preserve the trailing comma (or not) from the last entry. let trailing_comma = aliases.last().and_then(|alias| alias.comma.clone()); - for member in member_names { - let alias_index = aliases - .iter() - .position(|alias| member == qualified_name_from_name_or_attribute(&alias.name)); - if let Some(index) = alias_index { - aliases.remove(index); + // Remove any imports that are specified in the `imports` iterator (but, e.g., if the name is + // provided once, only remove the first occurrence). + let mut counts = member_names.fold(FxHashMap::<&str, usize>::default(), |mut map, name| { + map.entry(name).and_modify(|c| *c += 1).or_insert(1); + map + }); + aliases.retain(|alias| { + let name = qualified_name_from_name_or_attribute(&alias.name); + if let Some(count) = counts.get_mut(name.as_str()).filter(|count| **count > 0) { + *count -= 1; + false + } else { + true } - } + }); // But avoid destroying any trailing comments. if let Some(alias) = aliases.last_mut() { @@ -144,10 +152,10 @@ pub(crate) fn retain_imports( // Preserve the trailing comma (or not) from the last entry. let trailing_comma = aliases.last().and_then(|alias| alias.comma.clone()); + // Retain any imports that are specified in the `imports` iterator. + let member_names = member_names.iter().copied().collect::<FxHashSet<_>>(); aliases.retain(|alias| { - member_names - .iter() - .any(|member| *member == qualified_name_from_name_or_attribute(&alias.name)) + member_names.contains(qualified_name_from_name_or_attribute(&alias.name).as_str()) }); // But avoid destroying any trailing comments. diff --git a/crates/ruff_linter/src/fix/edits.rs b/crates/ruff_linter/src/fix/edits.rs index e58e9c43412e1..6c6a36f9d7bc4 100644 --- a/crates/ruff_linter/src/fix/edits.rs +++ b/crates/ruff_linter/src/fix/edits.rs @@ -10,30 +10,30 @@ use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; use ruff_python_trivia::textwrap::dedent_to; use ruff_python_trivia::{ - has_leading_content, is_python_whitespace, CommentRanges, PythonWhitespace, SimpleTokenKind, - SimpleTokenizer, + CommentRanges, PythonWhitespace, SimpleTokenKind, SimpleTokenizer, has_leading_content, + is_python_whitespace, }; use ruff_source_file::{LineRanges, NewlineWithTrailingNewline, UniversalNewlines}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::cst::matchers::{match_function_def, match_indented_block, match_statement}; use crate::fix::codemods; use crate::fix::codemods::CodegenStylist; use crate::line_width::{IndentWidth, LineLength, LineWidthBuilder}; -use crate::Locator; -/// Return the `Fix` to use when deleting a `Stmt`. +/// Return the [`Edit`] to use when deleting a [`Stmt`]. /// -/// In some cases, this is as simple as deleting the `Range` of the `Stmt` +/// In some cases, this is as simple as deleting the [`TextRange`] of the [`Stmt`] /// itself. However, there are a few exceptions: -/// - If the `Stmt` is _not_ the terminal statement in a multi-statement line, +/// - If the [`Stmt`] is _not_ the terminal statement in a multi-statement line, /// we need to delete up to the start of the next statement (and avoid /// deleting any content that precedes the statement). -/// - If the `Stmt` is the terminal statement in a multi-statement line, we need +/// - If the [`Stmt`] is the terminal statement in a multi-statement line, we need /// to avoid deleting any content that precedes the statement. -/// - If the `Stmt` has no trailing and leading content, then it's convenient to +/// - If the [`Stmt`] has no trailing and leading content, then it's convenient to /// remove the entire start and end lines. -/// - If the `Stmt` is the last statement in its parent body, replace it with a +/// - If the [`Stmt`] is the last statement in its parent body, replace it with a /// `pass` instead. pub(crate) fn delete_stmt( stmt: &Stmt, @@ -288,11 +288,11 @@ pub(crate) fn add_parameter(parameter: &str, parameters: &Parameters, source: &s .args .iter() .filter(|arg| arg.default.is_none()) - .last() + .next_back() { // Case 1: at least one regular parameter, so append after the last one. Edit::insertion(format!(", {parameter}"), last.end()) - } else if parameters.args.first().is_some() { + } else if !parameters.args.is_empty() { // Case 2: no regular parameters, but at least one keyword parameter, so add before the // first. let pos = parameters.start(); @@ -316,7 +316,7 @@ pub(crate) fn add_parameter(parameter: &str, parameters: &Parameters, source: &s } else { Edit::insertion(format!(", {parameter}"), slash.start()) } - } else if parameters.kwonlyargs.first().is_some() { + } else if !parameters.kwonlyargs.is_empty() { // Case 3: no regular parameter, but a keyword-only parameter exist, so add parameter before that. // We need to backtrack to before the `*` separator. // We know there is no non-keyword-only params, so we can safely assume that the `*` separator is the first @@ -591,7 +591,8 @@ fn all_lines_fit( #[cfg(test)] mod tests { - use anyhow::{anyhow, Result}; + use anyhow::{Result, anyhow}; + use ruff_source_file::SourceFileBuilder; use test_case::test_case; use ruff_diagnostics::{Diagnostic, Edit, Fix}; @@ -600,11 +601,12 @@ mod tests { use ruff_python_parser::{parse_expression, parse_module}; use ruff_text_size::{Ranged, TextRange, TextSize}; + use crate::Locator; use crate::fix::apply_fixes; use crate::fix::edits::{ add_to_dunder_all, make_redundant_alias, next_stmt_break, trailing_semicolon, }; - use crate::Locator; + use crate::message::Message; /// Parse the given source using [`Mode::Module`] and return the first statement. fn parse_first_stmt(source: &str) -> Result<Stmt> { @@ -735,14 +737,24 @@ x = 1 \ let diag = { use crate::rules::pycodestyle::rules::MissingNewlineAtEndOfFile; let mut iter = edits.into_iter(); - Diagnostic::new( + let diag = Diagnostic::new( MissingNewlineAtEndOfFile, // The choice of rule here is arbitrary. TextRange::default(), ) .with_fix(Fix::safe_edits( iter.next().ok_or(anyhow!("expected edits nonempty"))?, iter, - )) + )); + Message::diagnostic( + diag.name, + diag.body, + diag.suggestion, + diag.range, + diag.fix, + diag.parent, + SourceFileBuilder::new("<filename>", "<code>").finish(), + None, + ) }; assert_eq!(apply_fixes([diag].iter(), &locator).code, expect); Ok(()) diff --git a/crates/ruff_linter/src/fix/mod.rs b/crates/ruff_linter/src/fix/mod.rs index 6a46c7a02e61e..e5dfdb64b93bb 100644 --- a/crates/ruff_linter/src/fix/mod.rs +++ b/crates/ruff_linter/src/fix/mod.rs @@ -3,13 +3,14 @@ use std::collections::BTreeSet; use itertools::Itertools; use rustc_hash::{FxHashMap, FxHashSet}; -use ruff_diagnostics::{Diagnostic, Edit, Fix, IsolationLevel, SourceMap}; +use ruff_diagnostics::{Edit, Fix, IsolationLevel, SourceMap}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::linter::FixTable; -use crate::registry::{AsRule, Rule}; +use crate::message::Message; +use crate::registry::Rule; use crate::settings::types::UnsafeFixes; -use crate::Locator; pub(crate) mod codemods; pub(crate) mod edits; @@ -26,19 +27,18 @@ pub(crate) struct FixResult { /// Fix errors in a file, and write the fixed source code to disk. pub(crate) fn fix_file( - diagnostics: &[Diagnostic], + messages: &[Message], locator: &Locator, unsafe_fixes: UnsafeFixes, ) -> Option<FixResult> { let required_applicability = unsafe_fixes.required_applicability(); - let mut with_fixes = diagnostics + let mut with_fixes = messages .iter() - .filter(|diagnostic| { - diagnostic - .fix - .as_ref() - .map_or(false, |fix| fix.applies(required_applicability)) + .filter(|message| { + message + .fix() + .is_some_and(|fix| fix.applies(required_applicability)) }) .peekable(); @@ -51,7 +51,7 @@ pub(crate) fn fix_file( /// Apply a series of fixes. fn apply_fixes<'a>( - diagnostics: impl Iterator<Item = &'a Diagnostic>, + diagnostics: impl Iterator<Item = &'a Message>, locator: &'a Locator<'a>, ) -> FixResult { let mut output = String::with_capacity(locator.len()); @@ -62,12 +62,8 @@ fn apply_fixes<'a>( let mut source_map = SourceMap::default(); for (rule, fix) in diagnostics - .filter_map(|diagnostic| { - diagnostic - .fix - .as_ref() - .map(|fix| (diagnostic.kind.rule(), fix)) - }) + .filter_map(|msg| msg.to_rule().map(|rule| (rule, msg))) + .filter_map(|(rule, diagnostic)| diagnostic.fix().map(|fix| (rule, fix))) .sorted_by(|(rule1, fix1), (rule2, fix2)| cmp_fix(*rule1, *rule2, fix1, fix2)) { let mut edits = fix @@ -134,6 +130,7 @@ fn cmp_fix(rule1: Rule, rule2: Rule, fix1: &Fix, fix2: &Fix) -> std::cmp::Orderi // `< is transitive: a < b and b < c implies a < c. The same must hold for both == and >.` // See https://github.com/astral-sh/ruff/issues/12469#issuecomment-2244392085 match (rule1, rule2) { + (Rule::RedefinedWhileUnused, Rule::RedefinedWhileUnused) => std::cmp::Ordering::Equal, (Rule::RedefinedWhileUnused, _) => std::cmp::Ordering::Less, (_, Rule::RedefinedWhileUnused) => std::cmp::Ordering::Greater, _ => std::cmp::Ordering::Equal, @@ -142,9 +139,11 @@ fn cmp_fix(rule1: Rule, rule2: Rule, fix1: &Fix, fix2: &Fix) -> std::cmp::Orderi .then_with(|| fix1.min_start().cmp(&fix2.min_start())) // Break ties in the event of overlapping rules, for some specific combinations. .then_with(|| match (&rule1, &rule2) { - // Apply `EndsInPeriod` fixes before `NewLineAfterLastParagraph` fixes. - (Rule::EndsInPeriod, Rule::NewLineAfterLastParagraph) => std::cmp::Ordering::Less, - (Rule::NewLineAfterLastParagraph, Rule::EndsInPeriod) => std::cmp::Ordering::Greater, + // Apply `MissingTrailingPeriod` fixes before `NewLineAfterLastParagraph` fixes. + (Rule::MissingTrailingPeriod, Rule::NewLineAfterLastParagraph) => std::cmp::Ordering::Less, + (Rule::NewLineAfterLastParagraph, Rule::MissingTrailingPeriod) => { + std::cmp::Ordering::Greater + } // Apply `IfElseBlockInsteadOfDictGet` fixes before `IfElseBlockInsteadOfIfExp` fixes. (Rule::IfElseBlockInsteadOfDictGet, Rule::IfElseBlockInsteadOfIfExp) => { std::cmp::Ordering::Less @@ -159,21 +158,28 @@ fn cmp_fix(rule1: Rule, rule2: Rule, fix1: &Fix, fix2: &Fix) -> std::cmp::Orderi #[cfg(test)] mod tests { use ruff_diagnostics::{Diagnostic, Edit, Fix, SourceMarker}; + use ruff_source_file::SourceFileBuilder; use ruff_text_size::{Ranged, TextSize}; - use crate::fix::{apply_fixes, FixResult}; - use crate::rules::pycodestyle::rules::MissingNewlineAtEndOfFile; use crate::Locator; + use crate::fix::{FixResult, apply_fixes}; + use crate::message::Message; + use crate::rules::pycodestyle::rules::MissingNewlineAtEndOfFile; - #[allow(deprecated)] - fn create_diagnostics(edit: impl IntoIterator<Item = Edit>) -> Vec<Diagnostic> { + fn create_diagnostics( + filename: &str, + source: &str, + edit: impl IntoIterator<Item = Edit>, + ) -> Vec<Message> { edit.into_iter() - .map(|edit| Diagnostic { + .map(|edit| { // The choice of rule here is arbitrary. - kind: MissingNewlineAtEndOfFile.into(), - range: edit.range(), - fix: Some(Fix::safe_edit(edit)), - parent: None, + let diagnostic = Diagnostic::new(MissingNewlineAtEndOfFile, edit.range()); + Message::from_diagnostic( + diagnostic.with_fix(Fix::safe_edit(edit)), + SourceFileBuilder::new(filename, source).finish(), + None, + ) }) .collect() } @@ -181,7 +187,7 @@ mod tests { #[test] fn empty_file() { let locator = Locator::new(r""); - let diagnostics = create_diagnostics([]); + let diagnostics = create_diagnostics("<filename>", locator.contents(), []); let FixResult { code, fixes, @@ -202,10 +208,14 @@ print("hello world") "# .trim(), ); - let diagnostics = create_diagnostics([Edit::insertion( - "import sys\n".to_string(), - TextSize::new(10), - )]); + let diagnostics = create_diagnostics( + "<filename>", + locator.contents(), + [Edit::insertion( + "import sys\n".to_string(), + TextSize::new(10), + )], + ); let FixResult { code, fixes, @@ -240,11 +250,15 @@ class A(object): " .trim(), ); - let diagnostics = create_diagnostics([Edit::replacement( - "Bar".to_string(), - TextSize::new(8), - TextSize::new(14), - )]); + let diagnostics = create_diagnostics( + "<filename>", + locator.contents(), + [Edit::replacement( + "Bar".to_string(), + TextSize::new(8), + TextSize::new(14), + )], + ); let FixResult { code, fixes, @@ -277,7 +291,11 @@ class A(object): " .trim(), ); - let diagnostics = create_diagnostics([Edit::deletion(TextSize::new(7), TextSize::new(15))]); + let diagnostics = create_diagnostics( + "<filename>", + locator.contents(), + [Edit::deletion(TextSize::new(7), TextSize::new(15))], + ); let FixResult { code, fixes, @@ -310,10 +328,14 @@ class A(object, object, object): " .trim(), ); - let diagnostics = create_diagnostics([ - Edit::deletion(TextSize::from(8), TextSize::from(16)), - Edit::deletion(TextSize::from(22), TextSize::from(30)), - ]); + let diagnostics = create_diagnostics( + "<filename>", + locator.contents(), + [ + Edit::deletion(TextSize::from(8), TextSize::from(16)), + Edit::deletion(TextSize::from(22), TextSize::from(30)), + ], + ); let FixResult { code, fixes, @@ -349,10 +371,14 @@ class A(object): " .trim(), ); - let diagnostics = create_diagnostics([ - Edit::deletion(TextSize::from(7), TextSize::from(15)), - Edit::replacement("ignored".to_string(), TextSize::from(9), TextSize::from(11)), - ]); + let diagnostics = create_diagnostics( + "<filename>", + locator.contents(), + [ + Edit::deletion(TextSize::from(7), TextSize::from(15)), + Edit::replacement("ignored".to_string(), TextSize::from(9), TextSize::from(11)), + ], + ); let FixResult { code, fixes, diff --git a/crates/ruff_linter/src/fs.rs b/crates/ruff_linter/src/fs.rs index 39a09b2ed115e..983651121a8c0 100644 --- a/crates/ruff_linter/src/fs.rs +++ b/crates/ruff_linter/src/fs.rs @@ -1,50 +1,27 @@ use std::path::{Path, PathBuf}; -use log::debug; use path_absolutize::Absolutize; use crate::registry::RuleSet; use crate::settings::types::CompiledPerFileIgnoreList; +/// Return the current working directory. +/// +/// On WASM this just returns `.`. Otherwise, defer to [`path_absolutize::path_dedot::CWD`]. +pub fn get_cwd() -> &'static Path { + #[cfg(target_arch = "wasm32")] + { + static CWD: std::sync::LazyLock<PathBuf> = std::sync::LazyLock::new(|| PathBuf::from(".")); + &CWD + } + #[cfg(not(target_arch = "wasm32"))] + path_absolutize::path_dedot::CWD.as_path() +} + /// Create a set with codes matching the pattern/code pairs. pub(crate) fn ignores_from_path(path: &Path, ignore_list: &CompiledPerFileIgnoreList) -> RuleSet { - let file_name = path.file_name().expect("Unable to parse filename"); ignore_list - .iter() - .filter_map(|entry| { - if entry.basename_matcher.is_match(file_name) { - if entry.negated { None } else { - debug!( - "Adding per-file ignores for {:?} due to basename match on {:?}: {:?}", - path, - entry.basename_matcher.glob().regex(), - entry.rules - ); - Some(&entry.rules) - } - } else if entry.absolute_matcher.is_match(path) { - if entry.negated { None } else { - debug!( - "Adding per-file ignores for {:?} due to absolute match on {:?}: {:?}", - path, - entry.absolute_matcher.glob().regex(), - entry.rules - ); - Some(&entry.rules) - } - } else if entry.negated { - debug!( - "Adding per-file ignores for {:?} due to negated pattern matching neither {:?} nor {:?}: {:?}", - path, - entry.basename_matcher.glob().regex(), - entry.absolute_matcher.glob().regex(), - entry.rules - ); - Some(&entry.rules) - } else { - None - } - }) + .iter_matches(path, "Adding per-file ignores") .flatten() .collect() } @@ -72,11 +49,7 @@ pub fn normalize_path_to<P: AsRef<Path>, R: AsRef<Path>>(path: P, project_root: pub fn relativize_path<P: AsRef<Path>>(path: P) -> String { let path = path.as_ref(); - #[cfg(target_arch = "wasm32")] - let cwd = Path::new("."); - #[cfg(not(target_arch = "wasm32"))] - let cwd = path_absolutize::path_dedot::CWD.as_path(); - + let cwd = get_cwd(); if let Ok(path) = path.strip_prefix(cwd) { return format!("{}", path.display()); } diff --git a/crates/ruff_linter/src/importer/insertion.rs b/crates/ruff_linter/src/importer/insertion.rs index 5181145e9b357..fe46e0cb95c41 100644 --- a/crates/ruff_linter/src/importer/insertion.rs +++ b/crates/ruff_linter/src/importer/insertion.rs @@ -2,11 +2,11 @@ use std::ops::Add; use ruff_diagnostics::Edit; -use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_ast::Stmt; +use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_codegen::Stylist; use ruff_python_parser::{TokenKind, Tokens}; -use ruff_python_trivia::{textwrap::indent, PythonWhitespace}; +use ruff_python_trivia::{PythonWhitespace, textwrap::indent}; use ruff_source_file::{LineRanges, UniversalNewlineIterator}; use ruff_text_size::{Ranged, TextSize}; diff --git a/crates/ruff_linter/src/importer/mod.rs b/crates/ruff_linter/src/importer/mod.rs index 4d97468f11a01..a06b68dd6cb4e 100644 --- a/crates/ruff_linter/src/importer/mod.rs +++ b/crates/ruff_linter/src/importer/mod.rs @@ -9,7 +9,7 @@ use anyhow::Result; use libcst_native::{ImportAlias, Name as cstName, NameOrAttribute}; use ruff_diagnostics::Edit; -use ruff_python_ast::{self as ast, ModModule, Stmt}; +use ruff_python_ast::{self as ast, Expr, ModModule, Stmt}; use ruff_python_codegen::Stylist; use ruff_python_parser::{Parsed, Tokens}; use ruff_python_semantic::{ @@ -18,11 +18,11 @@ use ruff_python_semantic::{ use ruff_python_trivia::textwrap::indent; use ruff_text_size::{Ranged, TextSize}; +use crate::Locator; use crate::cst::matchers::{match_aliases, match_import_from, match_statement}; use crate::fix; use crate::fix::codemods::CodegenStylist; use crate::importer::insertion::Insertion; -use crate::Locator; mod insertion; @@ -125,7 +125,7 @@ impl<'a> Importer<'a> { &self, import: &ImportedMembers, at: TextSize, - semantic: &SemanticModel, + semantic: &SemanticModel<'a>, ) -> Result<TypingImportEdit> { // Generate the modified import statement. let content = fix::codemods::retain_imports( @@ -135,6 +135,39 @@ impl<'a> Importer<'a> { self.stylist, )?; + // Add the import to an existing `TYPE_CHECKING` block. + if let Some(block) = self.preceding_type_checking_block(at) { + // Add the import to the existing `TYPE_CHECKING` block. + let type_checking_edit = + if let Some(statement) = Self::type_checking_binding_statement(semantic, block) { + if statement == import.statement { + // Special-case: if the `TYPE_CHECKING` symbol is imported as part of the same + // statement that we're modifying, avoid adding a no-op edit. For example, here, + // the `TYPE_CHECKING` no-op edit would overlap with the edit to remove `Final` + // from the import: + // ```python + // from __future__ import annotations + // + // from typing import Final, TYPE_CHECKING + // + // Const: Final[dict] = {} + // ``` + None + } else { + Some(Edit::range_replacement( + self.locator.slice(statement.range()).to_string(), + statement.range(), + )) + } + } else { + None + }; + return Ok(TypingImportEdit { + type_checking_edit, + add_import_edit: self.add_to_type_checking_block(&content, block.start()), + }); + } + // Import the `TYPE_CHECKING` symbol from the typing module. let (type_checking_edit, type_checking) = if let Some(type_checking) = Self::find_type_checking(at, semantic)? { @@ -179,13 +212,10 @@ impl<'a> Importer<'a> { (Some(edit), name) }; - // Add the import to a `TYPE_CHECKING` block. - let add_import_edit = if let Some(block) = self.preceding_type_checking_block(at) { - // Add the import to the `TYPE_CHECKING` block. - self.add_to_type_checking_block(&content, block.start()) - } else { - // Add the import to a new `TYPE_CHECKING` block. - self.add_type_checking_block( + // Add the import to a new `TYPE_CHECKING` block. + Ok(TypingImportEdit { + type_checking_edit, + add_import_edit: self.add_type_checking_block( &format!( "{}if {type_checking}:{}{}", self.stylist.line_ending().as_str(), @@ -193,13 +223,25 @@ impl<'a> Importer<'a> { indent(&content, self.stylist.indentation()) ), at, - )? + )?, + }) + } + + fn type_checking_binding_statement( + semantic: &SemanticModel<'a>, + type_checking_block: &Stmt, + ) -> Option<&'a Stmt> { + let Stmt::If(ast::StmtIf { test, .. }) = type_checking_block else { + return None; }; - Ok(TypingImportEdit { - type_checking_edit, - add_import_edit, - }) + let mut source = test; + while let Expr::Attribute(ast::ExprAttribute { value, .. }) = source.as_ref() { + source = value; + } + semantic + .binding(semantic.resolve_name(source.as_name_expr()?)?) + .statement(semantic) } /// Find a reference to `typing.TYPE_CHECKING`. diff --git a/crates/ruff_linter/src/lib.rs b/crates/ruff_linter/src/lib.rs index e9641737d8392..637112d605e00 100644 --- a/crates/ruff_linter/src/lib.rs +++ b/crates/ruff_linter/src/lib.rs @@ -9,9 +9,9 @@ pub use locator::Locator; pub use noqa::generate_noqa_edits; #[cfg(feature = "clap")] pub use registry::clap_completion::RuleParser; +pub use rule_selector::RuleSelector; #[cfg(feature = "clap")] pub use rule_selector::clap_completion::RuleSelectorParser; -pub use rule_selector::RuleSelector; pub use rules::pycodestyle::rules::IOError; pub const VERSION: &str = env!("CARGO_PKG_VERSION"); @@ -32,7 +32,9 @@ mod locator; pub mod logging; pub mod message; mod noqa; +pub mod package; pub mod packaging; +pub mod preview; pub mod pyproject_toml; pub mod registry; mod renamer; diff --git a/crates/ruff_linter/src/line_width.rs b/crates/ruff_linter/src/line_width.rs index 6577ff6ca5465..7525a68cdd832 100644 --- a/crates/ruff_linter/src/line_width.rs +++ b/crates/ruff_linter/src/line_width.rs @@ -1,7 +1,7 @@ use std::error::Error; use std::fmt; use std::hash::Hasher; -use std::num::{NonZeroU16, NonZeroU8, ParseIntError}; +use std::num::{NonZeroU8, NonZeroU16, ParseIntError}; use std::str::FromStr; use serde::{Deserialize, Serialize}; diff --git a/crates/ruff_linter/src/linter.rs b/crates/ruff_linter/src/linter.rs index 375c81715f071..f69922cf321ec 100644 --- a/crates/ruff_linter/src/linter.rs +++ b/crates/ruff_linter/src/linter.rs @@ -3,17 +3,18 @@ use std::cell::LazyCell; use std::ops::Deref; use std::path::Path; -use anyhow::{anyhow, Result}; +use anyhow::{Result, anyhow}; use colored::Colorize; use itertools::Itertools; +use ruff_python_parser::semantic_errors::SemanticSyntaxError; use rustc_hash::FxHashMap; use ruff_diagnostics::Diagnostic; use ruff_notebook::Notebook; -use ruff_python_ast::{ModModule, PySourceType}; +use ruff_python_ast::{ModModule, PySourceType, PythonVersion}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; -use ruff_python_parser::{ParseError, Parsed}; +use ruff_python_parser::{ParseError, ParseOptions, Parsed, UnsupportedSyntaxError}; use ruff_source_file::SourceFileBuilder; use ruff_text_size::Ranged; @@ -25,23 +26,64 @@ use crate::checkers::physical_lines::check_physical_lines; use crate::checkers::tokens::check_tokens; use crate::directives::Directives; use crate::doc_lines::{doc_lines_from_ast, doc_lines_from_tokens}; -use crate::fix::{fix_file, FixResult}; +use crate::fix::{FixResult, fix_file}; use crate::message::Message; use crate::noqa::add_noqa; +use crate::package::PackageRoot; +use crate::preview::{is_py314_support_enabled, is_unsupported_syntax_enabled}; use crate::registry::{AsRule, Rule, RuleSet}; #[cfg(any(feature = "test-rules", test))] -use crate::rules::ruff::rules::test_rules::{self, TestRule, TEST_RULES}; +use crate::rules::ruff::rules::test_rules::{self, TEST_RULES, TestRule}; use crate::settings::types::UnsafeFixes; -use crate::settings::{flags, LinterSettings}; +use crate::settings::{LinterSettings, TargetVersion, flags}; use crate::source_kind::SourceKind; -use crate::{directives, fs, Locator}; +use crate::{Locator, directives, fs, warn_user_once}; pub struct LinterResult { /// A collection of diagnostic messages generated by the linter. pub messages: Vec<Message>, - /// A flag indicating the presence of syntax errors in the source file. - /// If `true`, at least one syntax error was detected in the source file. - pub has_syntax_error: bool, + /// Flag indicating that the parsed source code does not contain any + /// [`ParseError`]s + has_valid_syntax: bool, + /// Flag indicating that the parsed source code does not contain any [`ParseError`]s, + /// [`UnsupportedSyntaxError`]s, or [`SemanticSyntaxError`]s. + has_no_syntax_errors: bool, +} + +impl LinterResult { + /// Returns `true` if the parsed source code contains any [`ParseError`]s *or* + /// [`UnsupportedSyntaxError`]s. + /// + /// See [`LinterResult::has_invalid_syntax`] for a version specific to [`ParseError`]s. + pub fn has_syntax_errors(&self) -> bool { + !self.has_no_syntax_errors() + } + + /// Returns `true` if the parsed source code does not contain any [`ParseError`]s *or* + /// [`UnsupportedSyntaxError`]s. + /// + /// See [`LinterResult::has_valid_syntax`] for a version specific to [`ParseError`]s. + pub fn has_no_syntax_errors(&self) -> bool { + self.has_valid_syntax() && self.has_no_syntax_errors + } + + /// Returns `true` if the parsed source code is valid i.e., it has no [`ParseError`]s. + /// + /// Note that this does not include version-related [`UnsupportedSyntaxError`]s. + /// + /// See [`LinterResult::has_no_syntax_errors`] for a version that takes these into account. + pub fn has_valid_syntax(&self) -> bool { + self.has_valid_syntax + } + + /// Returns `true` if the parsed source code is invalid i.e., it has [`ParseError`]s. + /// + /// Note that this does not include version-related [`UnsupportedSyntaxError`]s. + /// + /// See [`LinterResult::has_no_syntax_errors`] for a version that takes these into account. + pub fn has_invalid_syntax(&self) -> bool { + !self.has_valid_syntax() + } } pub type FixTable = FxHashMap<Rule, usize>; @@ -55,12 +97,11 @@ pub struct FixerResult<'a> { pub fixed: FixTable, } -/// Generate `Diagnostic`s from the source code contents at the -/// given `Path`. -#[allow(clippy::too_many_arguments)] +/// Generate [`Message`]s from the source code contents at the given `Path`. +#[expect(clippy::too_many_arguments)] pub fn check_path( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, locator: &Locator, stylist: &Stylist, indexer: &Indexer, @@ -70,10 +111,14 @@ pub fn check_path( source_kind: &SourceKind, source_type: PySourceType, parsed: &Parsed<ModModule>, -) -> Vec<Diagnostic> { + target_version: TargetVersion, +) -> Vec<Message> { // Aggregate all diagnostics. let mut diagnostics = vec![]; + // Aggregate all semantic syntax errors. + let mut semantic_syntax_errors = vec![]; + let tokens = parsed.tokens(); let comment_ranges = indexer.comment_ranges(); @@ -115,6 +160,7 @@ pub fn check_path( locator, comment_ranges, settings, + target_version.linter_version(), )); } @@ -130,35 +176,34 @@ pub fn check_path( } // Run the AST-based rules only if there are no syntax errors. - if parsed.is_valid() { - let use_ast = settings - .rules - .iter_enabled() - .any(|rule_code| rule_code.lint_source().is_ast()); + if parsed.has_valid_syntax() { + let cell_offsets = source_kind.as_ipy_notebook().map(Notebook::cell_offsets); + let notebook_index = source_kind.as_ipy_notebook().map(Notebook::index); + + let (new_diagnostics, new_semantic_syntax_errors) = check_ast( + parsed, + locator, + stylist, + indexer, + &directives.noqa_line_for, + settings, + noqa, + path, + package, + source_type, + cell_offsets, + notebook_index, + target_version, + ); + diagnostics.extend(new_diagnostics); + semantic_syntax_errors.extend(new_semantic_syntax_errors); + let use_imports = !directives.isort.skip_file && settings .rules .iter_enabled() .any(|rule_code| rule_code.lint_source().is_imports()); - if use_ast || use_imports || use_doc_lines { - let cell_offsets = source_kind.as_ipy_notebook().map(Notebook::cell_offsets); - let notebook_index = source_kind.as_ipy_notebook().map(Notebook::index); - if use_ast { - diagnostics.extend(check_ast( - parsed, - locator, - stylist, - indexer, - &directives.noqa_line_for, - settings, - noqa, - path, - package, - source_type, - cell_offsets, - notebook_index, - )); - } + if use_imports || use_doc_lines { if use_imports { let import_diagnostics = check_imports( parsed, @@ -170,6 +215,7 @@ pub fn check_path( package, source_type, cell_offsets, + target_version.linter_version(), ); diagnostics.extend(import_diagnostics); @@ -262,11 +308,11 @@ pub fn check_path( RuleSet::empty() }; if !per_file_ignores.is_empty() { - diagnostics.retain(|diagnostic| !per_file_ignores.contains(diagnostic.kind.rule())); + diagnostics.retain(|diagnostic| !per_file_ignores.contains(diagnostic.rule())); } // Enforce `noqa` directives. - if (noqa.is_enabled() && !diagnostics.is_empty()) + if noqa.is_enabled() || settings .rules .iter_enabled() @@ -278,7 +324,7 @@ pub fn check_path( locator, comment_ranges, &directives.noqa_line_for, - parsed.is_valid(), + parsed.has_valid_syntax(), &per_file_ignores, settings, ); @@ -289,10 +335,10 @@ pub fn check_path( } } - if parsed.is_valid() { + if parsed.has_valid_syntax() { // Remove fixes for any rules marked as unfixable. for diagnostic in &mut diagnostics { - if !settings.rules.should_fix(diagnostic.kind.rule()) { + if !settings.rules.should_fix(diagnostic.rule()) { diagnostic.fix = None; } } @@ -303,7 +349,7 @@ pub fn check_path( if let Some(fix) = diagnostic.fix.take() { let fixed_applicability = settings .fix_safety - .resolve_applicability(diagnostic.kind.rule(), fix.applicability()); + .resolve_applicability(diagnostic.rule(), fix.applicability()); diagnostic.set_fix(fix.with_applicability(fixed_applicability)); } } @@ -315,7 +361,21 @@ pub fn check_path( } } - diagnostics + let syntax_errors = if is_unsupported_syntax_enabled(settings) { + parsed.unsupported_syntax_errors() + } else { + &[] + }; + + diagnostics_to_messages( + diagnostics, + parsed.errors(), + syntax_errors, + &semantic_syntax_errors, + path, + locator, + directives, + ) } const MAX_ITERATIONS: usize = 100; @@ -323,13 +383,14 @@ const MAX_ITERATIONS: usize = 100; /// Add any missing `# noqa` pragmas to the source code at the given `Path`. pub fn add_noqa_to_path( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, source_kind: &SourceKind, source_type: PySourceType, settings: &LinterSettings, ) -> Result<usize> { // Parse once. - let parsed = ruff_python_parser::parse_unchecked_source(source_kind.source_code(), source_type); + let target_version = settings.resolve_target_version(path); + let parsed = parse_unchecked_source(source_kind, source_type, target_version.parser_version()); // Map row and column locations to byte slices (lazily). let locator = Locator::new(source_kind.source_code()); @@ -349,7 +410,7 @@ pub fn add_noqa_to_path( ); // Generate diagnostics, ignoring any existing `noqa` directives. - let diagnostics = check_path( + let messages = check_path( path, package, &locator, @@ -361,13 +422,14 @@ pub fn add_noqa_to_path( source_kind, source_type, &parsed, + target_version, ); // Add any missing `# noqa` pragmas. // TODO(dhruvmanila): Add support for Jupyter Notebooks add_noqa( path, - &diagnostics, + &messages, &locator, indexer.comment_ranges(), &settings.external, @@ -380,14 +442,24 @@ pub fn add_noqa_to_path( /// code. pub fn lint_only( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, settings: &LinterSettings, noqa: flags::Noqa, source_kind: &SourceKind, source_type: PySourceType, source: ParseSource, ) -> LinterResult { - let parsed = source.into_parsed(source_kind, source_type); + let target_version = settings.resolve_target_version(path); + + if matches!(target_version, TargetVersion(Some(PythonVersion::PY314))) + && !is_py314_support_enabled(settings) + { + warn_user_once!( + "Support for Python 3.14 is under development and may be unstable. Enable `preview` to remove this warning." + ); + } + + let parsed = source.into_parsed(source_kind, source_type, target_version.parser_version()); // Map row and column locations to byte slices (lazily). let locator = Locator::new(source_kind.source_code()); @@ -407,7 +479,7 @@ pub fn lint_only( ); // Generate diagnostics. - let diagnostics = check_path( + let messages = check_path( path, package, &locator, @@ -419,17 +491,13 @@ pub fn lint_only( source_kind, source_type, &parsed, + target_version, ); LinterResult { - messages: diagnostics_to_messages( - diagnostics, - parsed.errors(), - path, - &locator, - &directives, - ), - has_syntax_error: !parsed.is_valid(), + has_valid_syntax: parsed.has_valid_syntax(), + has_no_syntax_errors: !messages.iter().any(Message::is_syntax_error), + messages, } } @@ -437,6 +505,8 @@ pub fn lint_only( fn diagnostics_to_messages( diagnostics: Vec<Diagnostic>, parse_errors: &[ParseError], + unsupported_syntax_errors: &[UnsupportedSyntaxError], + semantic_syntax_errors: &[SemanticSyntaxError], path: &Path, locator: &Locator, directives: &Directives, @@ -455,19 +525,26 @@ fn diagnostics_to_messages( parse_errors .iter() .map(|parse_error| Message::from_parse_error(parse_error, locator, file.deref().clone())) + .chain(unsupported_syntax_errors.iter().map(|syntax_error| { + Message::from_unsupported_syntax_error(syntax_error, file.deref().clone()) + })) + .chain( + semantic_syntax_errors + .iter() + .map(|error| Message::from_semantic_syntax_error(error, file.deref().clone())), + ) .chain(diagnostics.into_iter().map(|diagnostic| { let noqa_offset = directives.noqa_line_for.resolve(diagnostic.start()); - Message::from_diagnostic(diagnostic, file.deref().clone(), noqa_offset) + Message::from_diagnostic(diagnostic, file.deref().clone(), Some(noqa_offset)) })) .collect() } /// Generate `Diagnostic`s from source code content, iteratively fixing /// until stable. -#[allow(clippy::too_many_arguments)] pub fn lint_fix<'a>( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, noqa: flags::Noqa, unsafe_fixes: UnsafeFixes, settings: &LinterSettings, @@ -482,14 +559,27 @@ pub fn lint_fix<'a>( // As an escape hatch, bail after 100 iterations. let mut iterations = 0; - // Track whether the _initial_ source code is valid syntax. - let mut is_valid_syntax = false; + // Track whether the _initial_ source code has valid syntax. + let mut has_valid_syntax = false; + + // Track whether the _initial_ source code has no unsupported syntax errors. + let mut has_no_syntax_errors = false; + + let target_version = settings.resolve_target_version(path); + + if matches!(target_version, TargetVersion(Some(PythonVersion::PY314))) + && !is_py314_support_enabled(settings) + { + warn_user_once!( + "Support for Python 3.14 is under development and may be unstable. Enable `preview` to remove this warning." + ); + } // Continuously fix until the source code stabilizes. loop { // Parse once. let parsed = - ruff_python_parser::parse_unchecked_source(transformed.source_code(), source_type); + parse_unchecked_source(&transformed, source_type, target_version.parser_version()); // Map row and column locations to byte slices (lazily). let locator = Locator::new(transformed.source_code()); @@ -509,7 +599,7 @@ pub fn lint_fix<'a>( ); // Generate diagnostics. - let diagnostics = check_path( + let messages = check_path( path, package, &locator, @@ -521,15 +611,17 @@ pub fn lint_fix<'a>( &transformed, source_type, &parsed, + target_version, ); if iterations == 0 { - is_valid_syntax = parsed.is_valid(); + has_valid_syntax = parsed.has_valid_syntax(); + has_no_syntax_errors = !messages.iter().any(Message::is_syntax_error); } else { - // If the source code was parseable on the first pass, but is no - // longer parseable on a subsequent pass, then we've introduced a + // If the source code had no syntax errors on the first pass, but + // does on a subsequent pass, then we've introduced a // syntax error. Return the original code. - if is_valid_syntax { + if has_valid_syntax && has_no_syntax_errors { if let Some(error) = parsed.errors().first() { report_fix_syntax_error( path, @@ -547,7 +639,7 @@ pub fn lint_fix<'a>( code: fixed_contents, fixes: applied, source_map, - }) = fix_file(&diagnostics, &locator, unsafe_fixes) + }) = fix_file(&messages, &locator, unsafe_fixes) { if iterations < MAX_ITERATIONS { // Count the number of fixed errors. @@ -564,19 +656,14 @@ pub fn lint_fix<'a>( continue; } - report_failed_to_converge_error(path, transformed.source_code(), &diagnostics); + report_failed_to_converge_error(path, transformed.source_code(), &messages); } return Ok(FixerResult { result: LinterResult { - messages: diagnostics_to_messages( - diagnostics, - parsed.errors(), - path, - &locator, - &directives, - ), - has_syntax_error: !is_valid_syntax, + messages, + has_valid_syntax, + has_no_syntax_errors, }, transformed, fixed, @@ -593,9 +680,9 @@ fn collect_rule_codes(rules: impl IntoIterator<Item = Rule>) -> String { .join(", ") } -#[allow(clippy::print_stderr)] -fn report_failed_to_converge_error(path: &Path, transformed: &str, diagnostics: &[Diagnostic]) { - let codes = collect_rule_codes(diagnostics.iter().map(|diagnostic| diagnostic.kind.rule())); +#[expect(clippy::print_stderr)] +fn report_failed_to_converge_error(path: &Path, transformed: &str, messages: &[Message]) { + let codes = collect_rule_codes(messages.iter().filter_map(Message::to_rule)); if cfg!(debug_assertions) { eprintln!( "{}{} Failed to converge after {} iterations in `{}` with rule codes {}:---\n{}\n---", @@ -626,7 +713,7 @@ This indicates a bug in Ruff. If you could open an issue at: } } -#[allow(clippy::print_stderr)] +#[expect(clippy::print_stderr)] fn report_fix_syntax_error( path: &Path, transformed: &str, @@ -674,29 +761,57 @@ pub enum ParseSource { impl ParseSource { /// Consumes the [`ParseSource`] and returns the parsed [`Parsed`], parsing the source code if /// necessary. - fn into_parsed(self, source_kind: &SourceKind, source_type: PySourceType) -> Parsed<ModModule> { + fn into_parsed( + self, + source_kind: &SourceKind, + source_type: PySourceType, + target_version: PythonVersion, + ) -> Parsed<ModModule> { match self { - ParseSource::None => { - ruff_python_parser::parse_unchecked_source(source_kind.source_code(), source_type) - } + ParseSource::None => parse_unchecked_source(source_kind, source_type, target_version), ParseSource::Precomputed(parsed) => parsed, } } } +/// Like [`ruff_python_parser::parse_unchecked_source`] but with an additional [`PythonVersion`] +/// argument. +fn parse_unchecked_source( + source_kind: &SourceKind, + source_type: PySourceType, + target_version: PythonVersion, +) -> Parsed<ModModule> { + let options = ParseOptions::from(source_type).with_target_version(target_version); + // SAFETY: Safe because `PySourceType` always parses to a `ModModule`. See + // `ruff_python_parser::parse_unchecked_source`. We use `parse_unchecked` (and thus + // have to unwrap) in order to pass the `PythonVersion` via `ParseOptions`. + ruff_python_parser::parse_unchecked(source_kind.source_code(), options) + .try_into_module() + .expect("PySourceType always parses into a module") +} + #[cfg(test)] mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::{PySourceType, PythonVersion}; + use ruff_python_codegen::Stylist; + use ruff_python_index::Indexer; + use ruff_python_parser::ParseOptions; + use ruff_python_trivia::textwrap::dedent; + use ruff_text_size::Ranged; use test_case::test_case; use ruff_notebook::{Notebook, NotebookError}; + use crate::linter::check_path; + use crate::message::Message; use crate::registry::Rule; + use crate::settings::LinterSettings; use crate::source_kind::SourceKind; - use crate::test::{assert_notebook_path, test_contents, TestedNotebook}; - use crate::{assert_messages, settings}; + use crate::test::{TestedNotebook, assert_notebook_path, test_contents, test_snippet}; + use crate::{Locator, assert_messages, directives, settings}; /// Construct a path to a Jupyter notebook in the `resources/test/fixtures/jupyter` directory. fn notebook_path(path: impl AsRef<Path>) -> std::path::PathBuf { @@ -714,7 +829,7 @@ mod tests { } = assert_notebook_path( &actual, expected, - &settings::LinterSettings::for_rule(Rule::UnsortedImports), + &LinterSettings::for_rule(Rule::UnsortedImports), )?; assert_messages!(messages, actual, source_notebook); Ok(()) @@ -731,7 +846,7 @@ mod tests { } = assert_notebook_path( &actual, expected, - &settings::LinterSettings::for_rule(Rule::UnusedImport), + &LinterSettings::for_rule(Rule::UnusedImport), )?; assert_messages!(messages, actual, source_notebook); Ok(()) @@ -748,7 +863,7 @@ mod tests { } = assert_notebook_path( &actual, expected, - &settings::LinterSettings::for_rule(Rule::UnusedVariable), + &LinterSettings::for_rule(Rule::UnusedVariable), )?; assert_messages!(messages, actual, source_notebook); Ok(()) @@ -765,7 +880,7 @@ mod tests { } = assert_notebook_path( &actual, expected, - &settings::LinterSettings::for_rule(Rule::UndefinedName), + &LinterSettings::for_rule(Rule::UndefinedName), )?; assert_messages!(messages, actual, source_notebook); Ok(()) @@ -782,7 +897,7 @@ mod tests { } = assert_notebook_path( actual_path, &expected_path, - &settings::LinterSettings::for_rule(Rule::UnusedImport), + &LinterSettings::for_rule(Rule::UnusedImport), )?; let mut writer = Vec::new(); fixed_notebook.write(&mut writer)?; @@ -803,7 +918,7 @@ mod tests { } = assert_notebook_path( &actual, expected, - &settings::LinterSettings::for_rule(Rule::UnusedImport), + &LinterSettings::for_rule(Rule::UnusedImport), )?; assert_messages!(messages, actual, source_notebook); Ok(()) @@ -829,11 +944,11 @@ mod tests { #[test_case(Path::new("add_missing_cell_id.ipynb"), true; "add_missing_cell_id")] fn test_cell_id(path: &Path, has_id: bool) -> Result<()> { let source_notebook = Notebook::from_path(¬ebook_path(path))?; - let source_kind = SourceKind::IpyNotebook(source_notebook); + let source_kind = SourceKind::ipy_notebook(source_notebook); let (_, transformed) = test_contents( &source_kind, path, - &settings::LinterSettings::for_rule(Rule::UnusedImport), + &LinterSettings::for_rule(Rule::UnusedImport), ); let linted_notebook = transformed.into_owned().expect_ipy_notebook(); let mut writer = Vec::new(); @@ -846,4 +961,430 @@ mod tests { } Ok(()) } + + /// Wrapper around `test_contents_syntax_errors` for testing a snippet of code instead of a + /// file. + fn test_snippet_syntax_errors(contents: &str, settings: &LinterSettings) -> Vec<Message> { + let contents = dedent(contents); + test_contents_syntax_errors( + &SourceKind::Python(contents.to_string()), + Path::new("<filename>"), + settings, + ) + } + + /// A custom test runner that prints syntax errors in addition to other diagnostics. Adapted + /// from `flakes` in pyflakes/mod.rs. + fn test_contents_syntax_errors( + source_kind: &SourceKind, + path: &Path, + settings: &LinterSettings, + ) -> Vec<Message> { + let source_type = PySourceType::from(path); + let target_version = settings.resolve_target_version(path); + let options = + ParseOptions::from(source_type).with_target_version(target_version.parser_version()); + let parsed = ruff_python_parser::parse_unchecked(source_kind.source_code(), options) + .try_into_module() + .expect("PySourceType always parses into a module"); + let locator = Locator::new(source_kind.source_code()); + let stylist = Stylist::from_tokens(parsed.tokens(), locator.contents()); + let indexer = Indexer::from_tokens(parsed.tokens(), locator.contents()); + let directives = directives::extract_directives( + parsed.tokens(), + directives::Flags::from_settings(settings), + &locator, + &indexer, + ); + let mut messages = check_path( + path, + None, + &locator, + &stylist, + &indexer, + &directives, + settings, + settings::flags::Noqa::Enabled, + source_kind, + source_type, + &parsed, + target_version, + ); + messages.sort_by_key(Ranged::start); + messages + } + + #[test_case( + "async_in_sync_error_on_310", + "async def f(): return [[x async for x in foo(n)] for n in range(3)]", + PythonVersion::PY310, + "AsyncComprehensionOutsideAsyncFunction" + )] + #[test_case( + "async_in_sync_okay_on_311", + "async def f(): return [[x async for x in foo(n)] for n in range(3)]", + PythonVersion::PY311, + "AsyncComprehensionOutsideAsyncFunction" + )] + #[test_case( + "async_in_sync_okay_on_310", + "async def test(): return [[x async for x in elements(n)] async for n in range(3)]", + PythonVersion::PY310, + "AsyncComprehensionOutsideAsyncFunction" + )] + #[test_case( + "deferred_function_body", + " + async def f(): [x for x in foo()] and [x async for x in foo()] + async def f(): + def g(): ... + [x async for x in foo()] + ", + PythonVersion::PY310, + "AsyncComprehensionOutsideAsyncFunction" + )] + #[test_case( + "async_in_sync_false_positive", + "[x async for x in y]", + PythonVersion::PY310, + "AsyncComprehensionOutsideAsyncFunction" + )] + #[test_case( + "rebound_comprehension", + "[x:= 2 for x in range(2)]", + PythonVersion::PY310, + "ReboundComprehensionVariable" + )] + #[test_case( + "duplicate_type_param", + "class C[T, T]: pass", + PythonVersion::PY312, + "DuplicateTypeParameter" + )] + #[test_case( + "multiple_case_assignment", + " + match x: + case [a, a]: + pass + case _: + pass + ", + PythonVersion::PY310, + "MultipleCaseAssignment" + )] + #[test_case( + "duplicate_match_key", + " + match x: + case {'key': 1, 'key': 2}: + pass + ", + PythonVersion::PY310, + "DuplicateMatchKey" + )] + #[test_case( + "duplicate_match_class_attribute", + " + match x: + case Point(x=1, x=2): + pass + ", + PythonVersion::PY310, + "DuplicateMatchClassAttribute" + )] + #[test_case( + "invalid_star_expression", + " + def func(): + return *x + ", + PythonVersion::PY310, + "InvalidStarExpression" + )] + #[test_case( + "invalid_star_expression_for", + " + for *x in range(10): + pass + ", + PythonVersion::PY310, + "InvalidStarExpression" + )] + #[test_case( + "invalid_star_expression_yield", + " + def func(): + yield *x + ", + PythonVersion::PY310, + "InvalidStarExpression" + )] + #[test_case( + "irrefutable_case_pattern_wildcard", + " + match value: + case _: + pass + case 1: + pass + ", + PythonVersion::PY310, + "IrrefutableCasePattern" + )] + #[test_case( + "irrefutable_case_pattern_capture", + " + match value: + case irrefutable: + pass + case 1: + pass + ", + PythonVersion::PY310, + "IrrefutableCasePattern" + )] + #[test_case( + "single_starred_assignment", + "*a = [1, 2, 3, 4]", + PythonVersion::PY310, + "SingleStarredAssignment" + )] + #[test_case( + "write_to_debug", + " + __debug__ = False + ", + PythonVersion::PY310, + "WriteToDebug" + )] + #[test_case( + "write_to_debug_in_function_param", + " + def process(__debug__): + pass + ", + PythonVersion::PY310, + "WriteToDebug" + )] + #[test_case( + "write_to_debug_class_type_param", + " + class Generic[__debug__]: + pass + ", + PythonVersion::PY312, + "WriteToDebug" + )] + #[test_case( + "invalid_expression_yield_in_type_param", + " + type X[T: (yield 1)] = int + ", + PythonVersion::PY312, + "InvalidExpression" + )] + #[test_case( + "invalid_expression_yield_in_type_alias", + " + type Y = (yield 1) + ", + PythonVersion::PY312, + "InvalidExpression" + )] + #[test_case( + "invalid_expression_walrus_in_return_annotation", + " + def f[T](x: int) -> (y := 3): return x + ", + PythonVersion::PY312, + "InvalidExpression" + )] + #[test_case( + "invalid_expression_yield_from_in_base_class", + " + class C[T]((yield from [object])): + pass + ", + PythonVersion::PY312, + "InvalidExpression" + )] + fn test_semantic_errors( + name: &str, + contents: &str, + python_version: PythonVersion, + error_type: &str, + ) { + let snapshot = format!("semantic_syntax_error_{error_type}_{name}_{python_version}"); + let messages = test_snippet_syntax_errors( + contents, + &LinterSettings { + rules: settings::rule_table::RuleTable::empty(), + unresolved_target_version: python_version.into(), + preview: settings::types::PreviewMode::Enabled, + ..Default::default() + }, + ); + assert_messages!(snapshot, messages); + } + + #[test_case(PythonVersion::PY310)] + #[test_case(PythonVersion::PY311)] + fn test_async_comprehension_notebook(python_version: PythonVersion) -> Result<()> { + let snapshot = + format!("async_comprehension_in_sync_comprehension_notebook_{python_version}"); + let path = Path::new("resources/test/fixtures/syntax_errors/async_comprehension.ipynb"); + let messages = test_contents_syntax_errors( + &SourceKind::ipy_notebook(Notebook::from_path(path)?), + path, + &LinterSettings { + unresolved_target_version: python_version.into(), + rules: settings::rule_table::RuleTable::empty(), + preview: settings::types::PreviewMode::Enabled, + ..Default::default() + }, + ); + assert_messages!(snapshot, messages); + + Ok(()) + } + + #[test_case(Rule::LateFutureImport, Path::new("late_future_import.py"))] + #[test_case(Rule::YieldOutsideFunction, Path::new("yield_scope.py"))] + #[test_case(Rule::ReturnOutsideFunction, Path::new("return_outside_function.py"))] + #[test_case( + Rule::LoadBeforeGlobalDeclaration, + Path::new("load_before_global_declaration.py") + )] + #[test_case(Rule::AwaitOutsideAsync, Path::new("await_outside_async_function.py"))] + #[test_case(Rule::AwaitOutsideAsync, Path::new("async_comprehension.py"))] + fn test_syntax_errors(rule: Rule, path: &Path) -> Result<()> { + let snapshot = path.to_string_lossy().to_string(); + let path = Path::new("resources/test/fixtures/syntax_errors").join(path); + let messages = test_contents_syntax_errors( + &SourceKind::Python(std::fs::read_to_string(&path)?), + &path, + &LinterSettings::for_rule(rule), + ); + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_messages!(snapshot, messages); + }); + + Ok(()) + } + + #[test] + fn test_await_scope_notebook() -> Result<()> { + let path = Path::new("resources/test/fixtures/syntax_errors/await_scope.ipynb"); + let TestedNotebook { + messages, + source_notebook, + .. + } = assert_notebook_path( + path, + path, + &LinterSettings::for_rule(Rule::YieldOutsideFunction), + )?; + assert_messages!(messages, path, source_notebook); + + Ok(()) + } + + const PYI019_EXAMPLE: &str = r#" + from typing import TypeVar + + T = TypeVar("T", bound="_NiceReprEnum") + + class C: + def __new__(cls: type[T]) -> T: + return cls + "#; + + #[test_case( + "pyi019_adds_typing_extensions", + PYI019_EXAMPLE, + &LinterSettings { + unresolved_target_version: PythonVersion::PY310.into(), + typing_extensions: true, + ..LinterSettings::for_rule(Rule::CustomTypeVarForSelf) + } + )] + #[test_case( + "pyi019_does_not_add_typing_extensions", + PYI019_EXAMPLE, + &LinterSettings { + unresolved_target_version: PythonVersion::PY310.into(), + typing_extensions: false, + ..LinterSettings::for_rule(Rule::CustomTypeVarForSelf) + } + )] + #[test_case( + "pyi019_adds_typing_without_extensions_disabled", + PYI019_EXAMPLE, + &LinterSettings { + unresolved_target_version: PythonVersion::PY311.into(), + typing_extensions: true, + ..LinterSettings::for_rule(Rule::CustomTypeVarForSelf) + } + )] + #[test_case( + "pyi019_adds_typing_with_extensions_disabled", + PYI019_EXAMPLE, + &LinterSettings { + unresolved_target_version: PythonVersion::PY311.into(), + typing_extensions: false, + ..LinterSettings::for_rule(Rule::CustomTypeVarForSelf) + } + )] + #[test_case( + "pyi034_disabled", + " + class C: + def __new__(cls) -> C: ... + ", + &LinterSettings { + unresolved_target_version: PythonVersion { major: 3, minor: 10 }.into(), + typing_extensions: false, + ..LinterSettings::for_rule(Rule::NonSelfReturnType) + } + )] + #[test_case( + "fast002_disabled", + r#" + from fastapi import Depends, FastAPI + + app = FastAPI() + + @app.get("/items/") + async def read_items(commons: dict = Depends(common_parameters)): + return commons + "#, + &LinterSettings { + unresolved_target_version: PythonVersion { major: 3, minor: 8 }.into(), + typing_extensions: false, + ..LinterSettings::for_rule(Rule::FastApiNonAnnotatedDependency) + } + )] + fn test_disabled_typing_extensions(name: &str, contents: &str, settings: &LinterSettings) { + let snapshot = format!("disabled_typing_extensions_{name}"); + let messages = test_snippet(contents, settings); + assert_messages!(snapshot, messages); + } + + #[test_case( + "pyi026_disabled", + "Vector = list[float]", + &LinterSettings { + unresolved_target_version: PythonVersion { major: 3, minor: 9 }.into(), + typing_extensions: false, + ..LinterSettings::for_rule(Rule::TypeAliasWithoutAnnotation) + } + )] + fn test_disabled_typing_extensions_pyi(name: &str, contents: &str, settings: &LinterSettings) { + let snapshot = format!("disabled_typing_extensions_pyi_{name}"); + let path = Path::new("<filename>.pyi"); + let contents = dedent(contents); + let messages = test_contents(&SourceKind::Python(contents.into_owned()), path, settings).0; + assert_messages!(snapshot, messages); + } } diff --git a/crates/ruff_linter/src/locator.rs b/crates/ruff_linter/src/locator.rs index c75cfd4d48569..afc212e6a68ca 100644 --- a/crates/ruff_linter/src/locator.rs +++ b/crates/ruff_linter/src/locator.rs @@ -2,7 +2,7 @@ use std::cell::OnceCell; -use ruff_source_file::{LineIndex, LineRanges, OneIndexed, SourceCode, SourceLocation}; +use ruff_source_file::{LineColumn, LineIndex, LineRanges, OneIndexed, SourceCode}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; #[derive(Debug)] @@ -36,8 +36,8 @@ impl<'a> Locator<'a> { #[deprecated( note = "This is expensive, avoid using outside of the diagnostic phase. Prefer the other `Locator` methods instead." )] - pub fn compute_source_location(&self, offset: TextSize) -> SourceLocation { - self.to_source_code().source_location(offset) + pub fn compute_source_location(&self, offset: TextSize) -> LineColumn { + self.to_source_code().line_column(offset) } pub fn to_index(&self) -> &LineIndex { @@ -118,6 +118,86 @@ impl<'a> Locator<'a> { } } + /// Finds the closest [`TextSize`] not less than the offset given for which + /// `is_char_boundary` is `true`. Unless the offset given is greater than + /// the length of the underlying contents, in which case, the length of the + /// contents is returned. + /// + /// Can be replaced with `str::ceil_char_boundary` once it's stable. + /// + /// # Examples + /// + /// From `std`: + /// + /// ``` + /// use ruff_text_size::{Ranged, TextSize}; + /// use ruff_linter::Locator; + /// + /// let locator = Locator::new("❤️🧡💛💚💙💜"); + /// assert_eq!(locator.text_len(), TextSize::from(26)); + /// assert!(!locator.contents().is_char_boundary(13)); + /// + /// let closest = locator.ceil_char_boundary(TextSize::from(13)); + /// assert_eq!(closest, TextSize::from(14)); + /// assert_eq!(&locator.contents()[..closest.to_usize()], "❤️🧡💛"); + /// ``` + /// + /// Additional examples: + /// + /// ``` + /// use ruff_text_size::{Ranged, TextRange, TextSize}; + /// use ruff_linter::Locator; + /// + /// let locator = Locator::new("Hello"); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(0)), + /// TextSize::from(0) + /// ); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(5)), + /// TextSize::from(5) + /// ); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(6)), + /// TextSize::from(5) + /// ); + /// + /// let locator = Locator::new("α"); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(0)), + /// TextSize::from(0) + /// ); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(1)), + /// TextSize::from(2) + /// ); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(2)), + /// TextSize::from(2) + /// ); + /// + /// assert_eq!( + /// locator.ceil_char_boundary(TextSize::from(3)), + /// TextSize::from(2) + /// ); + /// ``` + pub fn ceil_char_boundary(&self, offset: TextSize) -> TextSize { + let upper_bound = offset + .to_u32() + .saturating_add(4) + .min(self.text_len().to_u32()); + (offset.to_u32()..upper_bound) + .map(TextSize::from) + .find(|offset| self.contents.is_char_boundary(offset.to_usize())) + .unwrap_or_else(|| TextSize::from(upper_bound)) + } + /// Take the source code between the given [`TextRange`]. #[inline] pub fn slice<T: Ranged>(&self, ranged: T) -> &'a str { diff --git a/crates/ruff_linter/src/logging.rs b/crates/ruff_linter/src/logging.rs index 4d88c637bcc43..dadf6ce25138c 100644 --- a/crates/ruff_linter/src/logging.rs +++ b/crates/ruff_linter/src/logging.rs @@ -9,7 +9,7 @@ use log::Level; use ruff_python_parser::{ParseError, ParseErrorType}; use rustc_hash::FxHashSet; -use ruff_source_file::{LineIndex, OneIndexed, SourceCode, SourceLocation}; +use ruff_source_file::{LineColumn, LineIndex, OneIndexed, SourceCode}; use crate::fs; use crate::source_kind::SourceKind; @@ -85,8 +85,8 @@ macro_rules! notify_user { ($($arg:tt)*) => { println!( "[{}] {}", - chrono::Local::now() - .format("%H:%M:%S %p") + jiff::Zoned::now() + .strftime("%H:%M:%S %p") .to_string() .dimmed(), format_args!($($arg)*) @@ -109,7 +109,7 @@ pub enum LogLevel { } impl LogLevel { - #[allow(clippy::trivially_copy_pass_by_ref)] + #[expect(clippy::trivially_copy_pass_by_ref)] const fn level_filter(&self) -> log::LevelFilter { match self { LogLevel::Default => log::LevelFilter::Info, @@ -142,7 +142,7 @@ pub fn set_up_logging(level: LogLevel) -> Result<()> { Level::Info | Level::Debug | Level::Trace => { out.finish(format_args!( "{}[{}][{}] {}", - chrono::Local::now().format("[%Y-%m-%d][%H:%M:%S]"), + jiff::Zoned::now().strftime("[%Y-%m-%d][%H:%M:%S]"), record.target(), record.level(), message @@ -151,7 +151,7 @@ pub fn set_up_logging(level: LogLevel) -> Result<()> { }) .level(level.level_filter()) .level_for("globset", log::LevelFilter::Warn) - .level_for("red_knot_python_semantic", log::LevelFilter::Warn) + .level_for("ty_python_semantic", log::LevelFilter::Warn) .level_for("salsa", log::LevelFilter::Warn) .chain(std::io::stderr()) .apply()?; @@ -195,21 +195,21 @@ impl DisplayParseError { // Translate the byte offset to a location in the originating source. let location = if let Some(jupyter_index) = source_kind.as_ipy_notebook().map(Notebook::index) { - let source_location = source_code.source_location(error.location.start()); + let source_location = source_code.line_column(error.location.start()); ErrorLocation::Cell( jupyter_index - .cell(source_location.row) + .cell(source_location.line) .unwrap_or(OneIndexed::MIN), - SourceLocation { - row: jupyter_index - .cell_row(source_location.row) + LineColumn { + line: jupyter_index + .cell_row(source_location.line) .unwrap_or(OneIndexed::MIN), column: source_location.column, }, ) } else { - ErrorLocation::File(source_code.source_location(error.location.start())) + ErrorLocation::File(source_code.line_column(error.location.start())) }; Self { @@ -245,7 +245,7 @@ impl Display for DisplayParseError { write!( f, "{row}{colon}{column}{colon} {inner}", - row = location.row, + row = location.line, column = location.column, colon = ":".cyan(), inner = &DisplayParseErrorType(&self.error.error) @@ -256,7 +256,7 @@ impl Display for DisplayParseError { f, "{cell}{colon}{row}{colon}{column}{colon} {inner}", cell = cell, - row = location.row, + row = location.line, column = location.column, colon = ":".cyan(), inner = &DisplayParseErrorType(&self.error.error) @@ -283,9 +283,9 @@ impl Display for DisplayParseErrorType<'_> { #[derive(Debug)] enum ErrorLocation { /// The error occurred in a Python file. - File(SourceLocation), + File(LineColumn), /// The error occurred in a Jupyter cell. - Cell(OneIndexed, SourceLocation), + Cell(OneIndexed, LineColumn), } /// Truncates the display text before the first newline character to avoid line breaks. diff --git a/crates/ruff_linter/src/message/azure.rs b/crates/ruff_linter/src/message/azure.rs index c7d6049eac049..107224d61ed4d 100644 --- a/crates/ruff_linter/src/message/azure.rs +++ b/crates/ruff_linter/src/message/azure.rs @@ -1,6 +1,6 @@ use std::io::Write; -use ruff_source_file::SourceLocation; +use ruff_source_file::LineColumn; use crate::message::{Emitter, EmitterContext, Message}; @@ -17,10 +17,10 @@ impl Emitter for AzureEmitter { context: &EmitterContext, ) -> anyhow::Result<()> { for message in messages { - let location = if context.is_notebook(message.filename()) { + let location = if context.is_notebook(&message.filename()) { // We can't give a reasonable location for the structured formats, // so we show one that's clearly a fallback - SourceLocation::default() + LineColumn::default() } else { message.compute_start_location() }; @@ -30,11 +30,11 @@ impl Emitter for AzureEmitter { "##vso[task.logissue type=error\ ;sourcepath={filename};linenumber={line};columnnumber={col};{code}]{body}", filename = message.filename(), - line = location.row, + line = location.line, col = location.column, code = message - .rule() - .map_or_else(String::new, |rule| format!("code={};", rule.noqa_code())), + .to_noqa_code() + .map_or_else(String::new, |code| format!("code={code};")), body = message.body(), )?; } @@ -47,10 +47,10 @@ impl Emitter for AzureEmitter { mod tests { use insta::assert_snapshot; + use crate::message::AzureEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::AzureEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/diff.rs b/crates/ruff_linter/src/message/diff.rs index e3b3d99290c82..c0358d0b085d7 100644 --- a/crates/ruff_linter/src/message/diff.rs +++ b/crates/ruff_linter/src/message/diff.rs @@ -22,11 +22,11 @@ use crate::text_helpers::ShowNonprinting; /// * Compute the diff from the [`Edit`] because diff calculation is expensive. pub(super) struct Diff<'a> { fix: &'a Fix, - source_code: &'a SourceFile, + source_code: SourceFile, } impl<'a> Diff<'a> { - pub(crate) fn from_message(message: &'a Message) -> Option<Diff> { + pub(crate) fn from_message(message: &'a Message) -> Option<Diff<'a>> { message.fix().map(|fix| Diff { source_code: message.source_file(), fix, diff --git a/crates/ruff_linter/src/message/github.rs b/crates/ruff_linter/src/message/github.rs index 9fd0a5ee6b912..748af7896439b 100644 --- a/crates/ruff_linter/src/message/github.rs +++ b/crates/ruff_linter/src/message/github.rs @@ -1,6 +1,6 @@ use std::io::Write; -use ruff_source_file::SourceLocation; +use ruff_source_file::LineColumn; use crate::fs::relativize_path; use crate::message::{Emitter, EmitterContext, Message}; @@ -19,12 +19,12 @@ impl Emitter for GithubEmitter { ) -> anyhow::Result<()> { for message in messages { let source_location = message.compute_start_location(); - let location = if context.is_notebook(message.filename()) { + let location = if context.is_notebook(&message.filename()) { // We can't give a reasonable location for the structured formats, // so we show one that's clearly a fallback - SourceLocation::default() + LineColumn::default() } else { - source_location.clone() + source_location }; let end_location = message.compute_end_location(); @@ -32,24 +32,26 @@ impl Emitter for GithubEmitter { write!( writer, "::error title=Ruff{code},file={file},line={row},col={column},endLine={end_row},endColumn={end_column}::", - code = message.rule().map_or_else(String::new, |rule| format!(" ({})", rule.noqa_code())), + code = message + .to_noqa_code() + .map_or_else(String::new, |code| format!(" ({code})")), file = message.filename(), - row = source_location.row, + row = source_location.line, column = source_location.column, - end_row = end_location.row, + end_row = end_location.line, end_column = end_location.column, )?; write!( writer, "{path}:{row}:{column}:", - path = relativize_path(message.filename()), - row = location.row, + path = relativize_path(&*message.filename()), + row = location.line, column = location.column, )?; - if let Some(rule) = message.rule() { - write!(writer, " {}", rule.noqa_code())?; + if let Some(code) = message.to_noqa_code() { + write!(writer, " {code}")?; } writeln!(writer, " {}", message.body())?; @@ -63,10 +65,10 @@ impl Emitter for GithubEmitter { mod tests { use insta::assert_snapshot; + use crate::message::GithubEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::GithubEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/gitlab.rs b/crates/ruff_linter/src/message/gitlab.rs index 15e72832a2e61..3d7fd85e270c5 100644 --- a/crates/ruff_linter/src/message/gitlab.rs +++ b/crates/ruff_linter/src/message/gitlab.rs @@ -1,5 +1,5 @@ -use std::collections::hash_map::DefaultHasher; use std::collections::HashSet; +use std::collections::hash_map::DefaultHasher; use std::hash::{Hash, Hasher}; use std::io::Write; @@ -62,7 +62,7 @@ impl Serialize for SerializedMessages<'_> { let start_location = message.compute_start_location(); let end_location = message.compute_end_location(); - let lines = if self.context.is_notebook(message.filename()) { + let lines = if self.context.is_notebook(&message.filename()) { // We can't give a reasonable location for the structured formats, // so we show one that's clearly a fallback json!({ @@ -71,14 +71,14 @@ impl Serialize for SerializedMessages<'_> { }) } else { json!({ - "begin": start_location.row, - "end": end_location.row + "begin": start_location.line, + "end": end_location.line }) }; let path = self.project_dir.as_ref().map_or_else( - || relativize_path(message.filename()), - |project_dir| relativize_path_to(message.filename(), project_dir), + || relativize_path(&*message.filename()), + |project_dir| relativize_path_to(&*message.filename(), project_dir), ); let mut message_fingerprint = fingerprint(message, &path, 0); @@ -90,13 +90,22 @@ impl Serialize for SerializedMessages<'_> { } fingerprints.insert(message_fingerprint); - let description = if let Some(rule) = message.rule() { - format!("({}) {}", rule.noqa_code(), message.body()) + let (description, check_name) = if let Some(code) = message.to_noqa_code() { + (message.body().to_string(), code.to_string()) } else { - message.body().to_string() + let description = message.body(); + let description_without_prefix = description + .strip_prefix("SyntaxError: ") + .unwrap_or(description); + + ( + description_without_prefix.to_string(), + "syntax-error".to_string(), + ) }; let value = json!({ + "check_name": check_name, "description": description, "severity": "major", "fingerprint": format!("{:x}", message_fingerprint), @@ -128,10 +137,10 @@ fn fingerprint(message: &Message, project_path: &str, salt: u64) -> u64 { mod tests { use insta::assert_snapshot; + use crate::message::GitlabEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::GitlabEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/grouped.rs b/crates/ruff_linter/src/message/grouped.rs index 1dfa5d15e6b2b..0ff386cdfc867 100644 --- a/crates/ruff_linter/src/message/grouped.rs +++ b/crates/ruff_linter/src/message/grouped.rs @@ -11,7 +11,7 @@ use crate::fs::relativize_path; use crate::message::diff::calculate_print_width; use crate::message::text::{MessageCodeFrame, RuleCodeAndBody}; use crate::message::{ - group_messages_by_filename, Emitter, EmitterContext, Message, MessageWithLocation, + Emitter, EmitterContext, Message, MessageWithLocation, group_messages_by_filename, }; use crate::settings::types::UnsafeFixes; @@ -57,7 +57,7 @@ impl Emitter for GroupedEmitter { let mut max_column_length = OneIndexed::MIN; for message in &messages { - max_row_length = max_row_length.max(message.start_location.row); + max_row_length = max_row_length.max(message.start_location.line); max_column_length = max_column_length.max(message.start_location.column); } @@ -65,7 +65,7 @@ impl Emitter for GroupedEmitter { let column_length = calculate_print_width(max_column_length); // Print the filename. - writeln!(writer, "{}:", relativize_path(filename).underline())?; + writeln!(writer, "{}:", relativize_path(&*filename).underline())?; // Print each message. for message in messages { @@ -73,7 +73,7 @@ impl Emitter for GroupedEmitter { writer, "{}", DisplayGroupedMessage { - notebook_index: context.notebook_index(message.filename()), + notebook_index: context.notebook_index(&message.filename()), message, show_fix_status: self.show_fix_status, unsafe_fixes: self.unsafe_fixes, @@ -115,8 +115,8 @@ impl Display for DisplayGroupedMessage<'_> { write!( f, " {row_padding}", - row_padding = - " ".repeat(self.row_length.get() - calculate_print_width(start_location.row).get()) + row_padding = " " + .repeat(self.row_length.get() - calculate_print_width(start_location.line).get()) )?; // Check if we're working on a jupyter notebook and translate positions with cell accordingly @@ -125,18 +125,18 @@ impl Display for DisplayGroupedMessage<'_> { f, "cell {cell}{sep}", cell = jupyter_index - .cell(start_location.row) + .cell(start_location.line) .unwrap_or(OneIndexed::MIN), sep = ":".cyan() )?; ( jupyter_index - .cell_row(start_location.row) + .cell_row(start_location.line) .unwrap_or(OneIndexed::MIN), start_location.column, ) } else { - (start_location.row, start_location.column) + (start_location.line, start_location.column) }; writeln!( @@ -205,10 +205,10 @@ impl std::fmt::Write for PadAdapter<'_> { mod tests { use insta::assert_snapshot; + use crate::message::GroupedEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::GroupedEmitter; use crate::settings::types::UnsafeFixes; #[test] diff --git a/crates/ruff_linter/src/message/json.rs b/crates/ruff_linter/src/message/json.rs index eaa968c167b5b..be2fbd2f761f2 100644 --- a/crates/ruff_linter/src/message/json.rs +++ b/crates/ruff_linter/src/message/json.rs @@ -2,11 +2,11 @@ use std::io::Write; use serde::ser::SerializeSeq; use serde::{Serialize, Serializer}; -use serde_json::{json, Value}; +use serde_json::{Value, json}; use ruff_diagnostics::Edit; use ruff_notebook::NotebookIndex; -use ruff_source_file::{OneIndexed, SourceCode, SourceLocation}; +use ruff_source_file::{LineColumn, OneIndexed, SourceCode}; use ruff_text_size::Ranged; use crate::message::{Emitter, EmitterContext, Message}; @@ -49,8 +49,9 @@ impl Serialize for ExpandedMessages<'_> { } pub(crate) fn message_to_json_value(message: &Message, context: &EmitterContext) -> Value { - let source_code = message.source_file().to_source_code(); - let notebook_index = context.notebook_index(message.filename()); + let source_file = message.source_file(); + let source_code = source_file.to_source_code(); + let notebook_index = context.notebook_index(&message.filename()); let fix = message.fix().map(|fix| { json!({ @@ -60,34 +61,42 @@ pub(crate) fn message_to_json_value(message: &Message, context: &EmitterContext) }) }); - let mut start_location = source_code.source_location(message.start()); - let mut end_location = source_code.source_location(message.end()); + let mut start_location = source_code.line_column(message.start()); + let mut end_location = source_code.line_column(message.end()); let mut noqa_location = message .noqa_offset() - .map(|offset| source_code.source_location(offset)); + .map(|offset| source_code.line_column(offset)); let mut notebook_cell_index = None; if let Some(notebook_index) = notebook_index { notebook_cell_index = Some( notebook_index - .cell(start_location.row) + .cell(start_location.line) .unwrap_or(OneIndexed::MIN), ); - start_location = notebook_index.translate_location(&start_location); - end_location = notebook_index.translate_location(&end_location); - noqa_location = noqa_location.map(|location| notebook_index.translate_location(&location)); + start_location = notebook_index.translate_line_column(&start_location); + end_location = notebook_index.translate_line_column(&end_location); + noqa_location = + noqa_location.map(|location| notebook_index.translate_line_column(&location)); } json!({ - "code": message.rule().map(|rule| rule.noqa_code().to_string()), - "url": message.rule().and_then(|rule| rule.url()), + "code": message.to_noqa_code().map(|code| code.to_string()), + "url": message.to_rule().and_then(|rule| rule.url()), "message": message.body(), "fix": fix, "cell": notebook_cell_index, - "location": start_location, - "end_location": end_location, + "location": location_to_json(start_location), + "end_location": location_to_json(end_location), "filename": message.filename(), - "noqa_row": noqa_location.map(|location| location.row) + "noqa_row": noqa_location.map(|location| location.line) + }) +} + +fn location_to_json(location: LineColumn) -> serde_json::Value { + json!({ + "row": location.line, + "column": location.column }) } @@ -105,8 +114,8 @@ impl Serialize for ExpandedEdits<'_> { let mut s = serializer.serialize_seq(Some(self.edits.len()))?; for edit in self.edits { - let mut location = self.source_code.source_location(edit.start()); - let mut end_location = self.source_code.source_location(edit.end()); + let mut location = self.source_code.line_column(edit.start()); + let mut end_location = self.source_code.line_column(edit.end()); if let Some(notebook_index) = self.notebook_index { // There exists a newline between each cell's source code in the @@ -118,44 +127,44 @@ impl Serialize for ExpandedEdits<'_> { // If it does, we need to translate the end location to the last // character of the previous cell. match ( - notebook_index.cell(location.row), - notebook_index.cell(end_location.row), + notebook_index.cell(location.line), + notebook_index.cell(end_location.line), ) { (Some(start_cell), Some(end_cell)) if start_cell != end_cell => { debug_assert_eq!(end_location.column.get(), 1); - let prev_row = end_location.row.saturating_sub(1); - end_location = SourceLocation { - row: notebook_index.cell_row(prev_row).unwrap_or(OneIndexed::MIN), + let prev_row = end_location.line.saturating_sub(1); + end_location = LineColumn { + line: notebook_index.cell_row(prev_row).unwrap_or(OneIndexed::MIN), column: self .source_code - .source_location(self.source_code.line_end_exclusive(prev_row)) + .line_column(self.source_code.line_end_exclusive(prev_row)) .column, }; } (Some(_), None) => { debug_assert_eq!(end_location.column.get(), 1); - let prev_row = end_location.row.saturating_sub(1); - end_location = SourceLocation { - row: notebook_index.cell_row(prev_row).unwrap_or(OneIndexed::MIN), + let prev_row = end_location.line.saturating_sub(1); + end_location = LineColumn { + line: notebook_index.cell_row(prev_row).unwrap_or(OneIndexed::MIN), column: self .source_code - .source_location(self.source_code.line_end_exclusive(prev_row)) + .line_column(self.source_code.line_end_exclusive(prev_row)) .column, }; } _ => { - end_location = notebook_index.translate_location(&end_location); + end_location = notebook_index.translate_line_column(&end_location); } } - location = notebook_index.translate_location(&location); + location = notebook_index.translate_line_column(&location); } let value = json!({ "content": edit.content().unwrap_or_default(), - "location": location, - "end_location": end_location + "location": location_to_json(location), + "end_location": location_to_json(end_location) }); s.serialize_element(&value)?; @@ -169,11 +178,11 @@ impl Serialize for ExpandedEdits<'_> { mod tests { use insta::assert_snapshot; + use crate::message::JsonEmitter; use crate::message::tests::{ capture_emitter_notebook_output, capture_emitter_output, create_messages, create_notebook_messages, create_syntax_error_messages, }; - use crate::message::JsonEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/junit.rs b/crates/ruff_linter/src/message/junit.rs index 7c7e341809e9b..38575d93d38b1 100644 --- a/crates/ruff_linter/src/message/junit.rs +++ b/crates/ruff_linter/src/message/junit.rs @@ -3,10 +3,10 @@ use std::path::Path; use quick_junit::{NonSuccessKind, Report, TestCase, TestCaseStatus, TestSuite, XmlString}; -use ruff_source_file::SourceLocation; +use ruff_source_file::LineColumn; use crate::message::{ - group_messages_by_filename, Emitter, EmitterContext, Message, MessageWithLocation, + Emitter, EmitterContext, Message, MessageWithLocation, group_messages_by_filename, }; #[derive(Default)] @@ -32,7 +32,7 @@ impl Emitter for JunitEmitter { report.add_test_suite(test_suite); } else { for (filename, messages) in group_messages_by_filename(messages) { - let mut test_suite = TestSuite::new(filename); + let mut test_suite = TestSuite::new(&filename); test_suite .extra .insert(XmlString::new("package"), XmlString::new("org.ruff")); @@ -44,35 +44,35 @@ impl Emitter for JunitEmitter { } = message; let mut status = TestCaseStatus::non_success(NonSuccessKind::Failure); status.set_message(message.body()); - let location = if context.is_notebook(message.filename()) { + let location = if context.is_notebook(&message.filename()) { // We can't give a reasonable location for the structured formats, // so we show one that's clearly a fallback - SourceLocation::default() + LineColumn::default() } else { start_location }; status.set_description(format!( "line {row}, col {col}, {body}", - row = location.row, + row = location.line, col = location.column, body = message.body() )); let mut case = TestCase::new( - if let Some(rule) = message.rule() { - format!("org.ruff.{}", rule.noqa_code()) + if let Some(code) = message.to_noqa_code() { + format!("org.ruff.{code}") } else { "org.ruff".to_string() }, status, ); - let file_path = Path::new(filename); + let file_path = Path::new(&*filename); let file_stem = file_path.file_stem().unwrap().to_str().unwrap(); let classname = file_path.parent().unwrap().join(file_stem); case.set_classname(classname.to_str().unwrap()); case.extra.insert( XmlString::new("line"), - XmlString::new(location.row.to_string()), + XmlString::new(location.line.to_string()), ); case.extra.insert( XmlString::new("column"), @@ -95,10 +95,10 @@ impl Emitter for JunitEmitter { mod tests { use insta::assert_snapshot; + use crate::message::JunitEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::JunitEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/mod.rs b/crates/ruff_linter/src/message/mod.rs index 9ce54301175b1..2b4eedca29bc7 100644 --- a/crates/ruff_linter/src/message/mod.rs +++ b/crates/ruff_linter/src/message/mod.rs @@ -3,6 +3,8 @@ use std::collections::BTreeMap; use std::io::Write; use std::ops::Deref; +use ruff_db::diagnostic::{self as db, Annotation, DiagnosticId, LintName, Severity, Span}; +use ruff_python_parser::semantic_errors::SemanticSyntaxError; use rustc_hash::FxHashMap; pub use azure::AzureEmitter; @@ -14,17 +16,18 @@ pub use json_lines::JsonLinesEmitter; pub use junit::JunitEmitter; pub use pylint::PylintEmitter; pub use rdjson::RdjsonEmitter; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Fix}; +use ruff_diagnostics::{Diagnostic, Fix}; use ruff_notebook::NotebookIndex; -use ruff_python_parser::ParseError; -use ruff_source_file::{SourceFile, SourceLocation}; +use ruff_python_parser::{ParseError, UnsupportedSyntaxError}; +use ruff_source_file::{LineColumn, SourceFile}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; pub use sarif::SarifEmitter; pub use text::TextEmitter; -use crate::logging::DisplayParseErrorType; -use crate::registry::{AsRule, Rule}; use crate::Locator; +use crate::codes::NoqaCode; +use crate::logging::DisplayParseErrorType; +use crate::registry::Rule; mod azure; mod diff; @@ -40,60 +43,97 @@ mod sarif; mod text; /// Message represents either a diagnostic message corresponding to a rule violation or a syntax -/// error message raised by the parser. -#[derive(Debug, PartialEq, Eq)] -pub enum Message { - Diagnostic(DiagnosticMessage), - SyntaxError(SyntaxErrorMessage), -} - -/// A diagnostic message corresponding to a rule violation. -#[derive(Debug, PartialEq, Eq)] -pub struct DiagnosticMessage { - pub kind: DiagnosticKind, - pub range: TextRange, +/// error message. +/// +/// All of the information for syntax errors is captured in the underlying [`db::Diagnostic`], while +/// rule violations can have the additional optional fields like fixes, suggestions, and (parent) +/// `noqa` offsets. +/// +/// For diagnostic messages, the [`db::Diagnostic`]'s primary message contains the +/// [`Diagnostic::body`], and the primary annotation optionally contains the suggestion accompanying +/// a fix. The `db::Diagnostic::id` field contains the kebab-case lint name derived from the `Rule`. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct Message { + pub diagnostic: db::Diagnostic, + + // these fields are specific to rule violations pub fix: Option<Fix>, - pub file: SourceFile, - pub noqa_offset: TextSize, + pub parent: Option<TextSize>, + pub(crate) noqa_offset: Option<TextSize>, } -/// A syntax error message raised by the parser. -#[derive(Debug, PartialEq, Eq)] -pub struct SyntaxErrorMessage { - pub message: String, - pub range: TextRange, - pub file: SourceFile, -} +impl Message { + pub fn syntax_error( + message: impl std::fmt::Display, + range: TextRange, + file: SourceFile, + ) -> Message { + let mut diag = db::Diagnostic::new(DiagnosticId::InvalidSyntax, Severity::Error, message); + let span = Span::from(file).with_range(range); + diag.annotate(Annotation::primary(span)); + Self { + diagnostic: diag, + fix: None, + parent: None, + noqa_offset: None, + } + } -#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] -pub enum MessageKind { - Diagnostic(Rule), - SyntaxError, -} + #[expect(clippy::too_many_arguments)] + pub fn diagnostic( + name: &'static str, + body: String, + suggestion: Option<String>, + range: TextRange, + fix: Option<Fix>, + parent: Option<TextSize>, + file: SourceFile, + noqa_offset: Option<TextSize>, + ) -> Message { + let mut diagnostic = db::Diagnostic::new( + DiagnosticId::Lint(LintName::of(name)), + Severity::Error, + body, + ); + let span = Span::from(file).with_range(range); + let mut annotation = Annotation::primary(span); + if let Some(suggestion) = suggestion { + annotation = annotation.message(suggestion); + } + diagnostic.annotate(annotation); -impl MessageKind { - pub fn as_str(&self) -> &str { - match self { - MessageKind::Diagnostic(rule) => rule.as_ref(), - MessageKind::SyntaxError => "syntax-error", + Message { + diagnostic, + fix, + parent, + noqa_offset, } } -} -impl Message { /// Create a [`Message`] from the given [`Diagnostic`] corresponding to a rule violation. pub fn from_diagnostic( diagnostic: Diagnostic, file: SourceFile, - noqa_offset: TextSize, + noqa_offset: Option<TextSize>, ) -> Message { - Message::Diagnostic(DiagnosticMessage { - range: diagnostic.range(), - kind: diagnostic.kind, - fix: diagnostic.fix, + let Diagnostic { + name, + body, + suggestion, + range, + fix, + parent, + } = diagnostic; + Self::diagnostic( + name, + body, + suggestion, + range, + fix, + parent, file, noqa_offset, - }) + ) } /// Create a [`Message`] from the given [`ParseError`]. @@ -111,74 +151,72 @@ impl Message { .next() .map_or(TextSize::new(0), TextLen::text_len); - Message::SyntaxError(SyntaxErrorMessage { - message: format!( + Message::syntax_error( + format_args!( "SyntaxError: {}", DisplayParseErrorType::new(&parse_error.error) ), - range: TextRange::at(parse_error.location.start(), len), + TextRange::at(parse_error.location.start(), len), file, - }) + ) } - pub const fn as_diagnostic_message(&self) -> Option<&DiagnosticMessage> { - match self { - Message::Diagnostic(m) => Some(m), - Message::SyntaxError(_) => None, - } + /// Create a [`Message`] from the given [`UnsupportedSyntaxError`]. + pub fn from_unsupported_syntax_error( + unsupported_syntax_error: &UnsupportedSyntaxError, + file: SourceFile, + ) -> Message { + Message::syntax_error( + format_args!("SyntaxError: {unsupported_syntax_error}"), + unsupported_syntax_error.range, + file, + ) } - /// Returns `true` if `self` is a syntax error message. - pub const fn is_syntax_error(&self) -> bool { - matches!(self, Message::SyntaxError(_)) + /// Create a [`Message`] from the given [`SemanticSyntaxError`]. + pub fn from_semantic_syntax_error( + semantic_syntax_error: &SemanticSyntaxError, + file: SourceFile, + ) -> Message { + Message::syntax_error( + format_args!("SyntaxError: {semantic_syntax_error}"), + semantic_syntax_error.range, + file, + ) } - /// Returns a message kind. - pub fn kind(&self) -> MessageKind { - match self { - Message::Diagnostic(m) => MessageKind::Diagnostic(m.kind.rule()), - Message::SyntaxError(_) => MessageKind::SyntaxError, - } + /// Returns `true` if `self` is a syntax error message. + pub fn is_syntax_error(&self) -> bool { + self.diagnostic.id().is_invalid_syntax() } /// Returns the name used to represent the diagnostic. - pub fn name(&self) -> &str { - match self { - Message::Diagnostic(m) => &m.kind.name, - Message::SyntaxError(_) => "SyntaxError", + pub fn name(&self) -> &'static str { + if self.is_syntax_error() { + "syntax-error" + } else { + self.diagnostic.id().as_str() } } /// Returns the message body to display to the user. pub fn body(&self) -> &str { - match self { - Message::Diagnostic(m) => &m.kind.body, - Message::SyntaxError(m) => &m.message, - } + self.diagnostic.primary_message() } /// Returns the fix suggestion for the violation. pub fn suggestion(&self) -> Option<&str> { - match self { - Message::Diagnostic(m) => m.kind.suggestion.as_deref(), - Message::SyntaxError(_) => None, - } + self.diagnostic.primary_annotation()?.get_message() } /// Returns the offset at which the `noqa` comment will be placed if it's a diagnostic message. pub fn noqa_offset(&self) -> Option<TextSize> { - match self { - Message::Diagnostic(m) => Some(m.noqa_offset), - Message::SyntaxError(_) => None, - } + self.noqa_offset } /// Returns the [`Fix`] for the message, if there is any. pub fn fix(&self) -> Option<&Fix> { - match self { - Message::Diagnostic(m) => m.fix.as_ref(), - Message::SyntaxError(_) => None, - } + self.fix.as_ref() } /// Returns `true` if the message contains a [`Fix`]. @@ -187,38 +225,64 @@ impl Message { } /// Returns the [`Rule`] corresponding to the diagnostic message. - pub fn rule(&self) -> Option<Rule> { - match self { - Message::Diagnostic(m) => Some(m.kind.rule()), - Message::SyntaxError(_) => None, + pub fn to_rule(&self) -> Option<Rule> { + if self.is_syntax_error() { + None + } else { + Some(self.name().parse().expect("Expected a valid rule name")) } } + /// Returns the [`NoqaCode`] corresponding to the diagnostic message. + pub fn to_noqa_code(&self) -> Option<NoqaCode> { + self.to_rule().map(|rule| rule.noqa_code()) + } + + /// Returns the URL for the rule documentation, if it exists. + pub fn to_url(&self) -> Option<String> { + // TODO(brent) Rule::url calls Rule::explanation, which calls ViolationMetadata::explain, + // which when derived (seems always to be the case?) is always `Some`, so I think it's + // pretty safe to inline the Rule::url implementation here, using `self.name()`: + // + // format!("{}/rules/{}", env!("CARGO_PKG_HOMEPAGE"), self.name()) + // + // at least in the case of diagnostics, I guess syntax errors will return None + self.to_rule().and_then(|rule| rule.url()) + } + /// Returns the filename for the message. - pub fn filename(&self) -> &str { - self.source_file().name() + pub fn filename(&self) -> String { + self.diagnostic + .expect_primary_span() + .expect_ruff_file() + .name() + .to_string() } /// Computes the start source location for the message. - pub fn compute_start_location(&self) -> SourceLocation { - self.source_file() + pub fn compute_start_location(&self) -> LineColumn { + self.diagnostic + .expect_primary_span() + .expect_ruff_file() .to_source_code() - .source_location(self.start()) + .line_column(self.start()) } /// Computes the end source location for the message. - pub fn compute_end_location(&self) -> SourceLocation { - self.source_file() + pub fn compute_end_location(&self) -> LineColumn { + self.diagnostic + .expect_primary_span() + .expect_ruff_file() .to_source_code() - .source_location(self.end()) + .line_column(self.end()) } /// Returns the [`SourceFile`] which the message belongs to. - pub fn source_file(&self) -> &SourceFile { - match self { - Message::Diagnostic(m) => &m.file, - Message::SyntaxError(m) => &m.file, - } + pub fn source_file(&self) -> SourceFile { + self.diagnostic + .expect_primary_span() + .expect_ruff_file() + .clone() } } @@ -236,16 +300,16 @@ impl PartialOrd for Message { impl Ranged for Message { fn range(&self) -> TextRange { - match self { - Message::Diagnostic(m) => m.range, - Message::SyntaxError(m) => m.range, - } + self.diagnostic + .expect_primary_span() + .range() + .expect("Expected range for ruff span") } } struct MessageWithLocation<'a> { message: &'a Message, - start_location: SourceLocation, + start_location: LineColumn, } impl Deref for MessageWithLocation<'_> { @@ -256,11 +320,11 @@ impl Deref for MessageWithLocation<'_> { } } -fn group_messages_by_filename(messages: &[Message]) -> BTreeMap<&str, Vec<MessageWithLocation>> { +fn group_messages_by_filename(messages: &[Message]) -> BTreeMap<String, Vec<MessageWithLocation>> { let mut grouped_messages = BTreeMap::default(); for message in messages { grouped_messages - .entry(message.filename()) + .entry(message.filename().to_string()) .or_insert_with(Vec::new) .push(MessageWithLocation { message, @@ -307,14 +371,14 @@ impl<'a> EmitterContext<'a> { mod tests { use rustc_hash::FxHashMap; - use ruff_diagnostics::{Diagnostic, DiagnosticKind, Edit, Fix}; + use ruff_diagnostics::{Edit, Fix}; use ruff_notebook::NotebookIndex; - use ruff_python_parser::{parse_unchecked, Mode}; + use ruff_python_parser::{Mode, ParseOptions, parse_unchecked}; use ruff_source_file::{OneIndexed, SourceFileBuilder}; - use ruff_text_size::{Ranged, TextRange, TextSize}; + use ruff_text_size::{TextRange, TextSize}; - use crate::message::{Emitter, EmitterContext, Message}; use crate::Locator; + use crate::message::{Emitter, EmitterContext, Message}; pub(super) fn create_syntax_error_messages() -> Vec<Message> { let source = r"from os import @@ -325,7 +389,7 @@ if call(foo "; let locator = Locator::new(source); let source_file = SourceFileBuilder::new("syntax_errors.py", source).finish(); - parse_unchecked(source, Mode::Module) + parse_unchecked(source, ParseOptions::from(Mode::Module)) .errors() .iter() .map(|parse_error| { @@ -349,55 +413,53 @@ def fibonacci(n): return fibonacci(n - 1) + fibonacci(n - 2) "#; - let unused_import = Diagnostic::new( - DiagnosticKind { - name: "UnusedImport".to_string(), - body: "`os` imported but unused".to_string(), - suggestion: Some("Remove unused import: `os`".to_string()), - }, - TextRange::new(TextSize::from(7), TextSize::from(9)), - ) - .with_fix(Fix::unsafe_edit(Edit::range_deletion(TextRange::new( - TextSize::from(0), - TextSize::from(10), - )))); - let fib_source = SourceFileBuilder::new("fib.py", fib).finish(); - let unused_variable = Diagnostic::new( - DiagnosticKind { - name: "UnusedVariable".to_string(), - body: "Local variable `x` is assigned to but never used".to_string(), - suggestion: Some("Remove assignment to unused variable `x`".to_string()), - }, - TextRange::new(TextSize::from(94), TextSize::from(95)), - ) - .with_fix(Fix::unsafe_edit(Edit::deletion( - TextSize::from(94), - TextSize::from(99), - ))); + let unused_import_start = TextSize::from(7); + let unused_import = Message::diagnostic( + "unused-import", + "`os` imported but unused".to_string(), + Some("Remove unused import: `os`".to_string()), + TextRange::new(unused_import_start, TextSize::from(9)), + Some(Fix::unsafe_edit(Edit::range_deletion(TextRange::new( + TextSize::from(0), + TextSize::from(10), + )))), + None, + fib_source.clone(), + Some(unused_import_start), + ); + + let unused_variable_start = TextSize::from(94); + let unused_variable = Message::diagnostic( + "unused-variable", + "Local variable `x` is assigned to but never used".to_string(), + Some("Remove assignment to unused variable `x`".to_string()), + TextRange::new(unused_variable_start, TextSize::from(95)), + Some(Fix::unsafe_edit(Edit::deletion( + TextSize::from(94), + TextSize::from(99), + ))), + None, + fib_source, + Some(unused_variable_start), + ); let file_2 = r"if a == 1: pass"; - let undefined_name = Diagnostic::new( - DiagnosticKind { - name: "UndefinedName".to_string(), - body: "Undefined name `a`".to_string(), - suggestion: None, - }, - TextRange::new(TextSize::from(3), TextSize::from(4)), + let undefined_name_start = TextSize::from(3); + let undefined_name = Message::diagnostic( + "undefined-name", + "Undefined name `a`".to_string(), + None, + TextRange::new(undefined_name_start, TextSize::from(4)), + None, + None, + SourceFileBuilder::new("undef.py", file_2).finish(), + Some(undefined_name_start), ); - let file_2_source = SourceFileBuilder::new("undef.py", file_2).finish(); - - let unused_import_start = unused_import.start(); - let unused_variable_start = unused_variable.start(); - let undefined_name_start = undefined_name.start(); - vec![ - Message::from_diagnostic(unused_import, fib_source.clone(), unused_import_start), - Message::from_diagnostic(unused_variable, fib_source, unused_variable_start), - Message::from_diagnostic(undefined_name, file_2_source, undefined_name_start), - ] + vec![unused_import, unused_variable, undefined_name] } pub(super) fn create_notebook_messages() -> (Vec<Message>, FxHashMap<String, NotebookIndex>) { @@ -413,47 +475,53 @@ def foo(): x = 1 "; - let unused_import_os = Diagnostic::new( - DiagnosticKind { - name: "UnusedImport".to_string(), - body: "`os` imported but unused".to_string(), - suggestion: Some("Remove unused import: `os`".to_string()), - }, - TextRange::new(TextSize::from(16), TextSize::from(18)), - ) - .with_fix(Fix::safe_edit(Edit::range_deletion(TextRange::new( - TextSize::from(9), - TextSize::from(19), - )))); - - let unused_import_math = Diagnostic::new( - DiagnosticKind { - name: "UnusedImport".to_string(), - body: "`math` imported but unused".to_string(), - suggestion: Some("Remove unused import: `math`".to_string()), - }, - TextRange::new(TextSize::from(35), TextSize::from(39)), - ) - .with_fix(Fix::safe_edit(Edit::range_deletion(TextRange::new( - TextSize::from(28), - TextSize::from(40), - )))); - - let unused_variable = Diagnostic::new( - DiagnosticKind { - name: "UnusedVariable".to_string(), - body: "Local variable `x` is assigned to but never used".to_string(), - suggestion: Some("Remove assignment to unused variable `x`".to_string()), - }, - TextRange::new(TextSize::from(98), TextSize::from(99)), - ) - .with_fix(Fix::unsafe_edit(Edit::deletion( - TextSize::from(94), - TextSize::from(104), - ))); - let notebook_source = SourceFileBuilder::new("notebook.ipynb", notebook).finish(); + let unused_import_os_start = TextSize::from(16); + let unused_import_os = Message::diagnostic( + "unused-import", + "`os` imported but unused".to_string(), + Some("Remove unused import: `os`".to_string()), + TextRange::new(unused_import_os_start, TextSize::from(18)), + Some(Fix::safe_edit(Edit::range_deletion(TextRange::new( + TextSize::from(9), + TextSize::from(19), + )))), + None, + notebook_source.clone(), + Some(unused_import_os_start), + ); + + let unused_import_math_start = TextSize::from(35); + let unused_import_math = Message::diagnostic( + "unused-import", + "`math` imported but unused".to_string(), + Some("Remove unused import: `math`".to_string()), + TextRange::new(unused_import_math_start, TextSize::from(39)), + Some(Fix::safe_edit(Edit::range_deletion(TextRange::new( + TextSize::from(28), + TextSize::from(40), + )))), + None, + notebook_source.clone(), + Some(unused_import_math_start), + ); + + let unused_variable_start = TextSize::from(98); + let unused_variable = Message::diagnostic( + "unused-variable", + "Local variable `x` is assigned to but never used".to_string(), + Some("Remove assignment to unused variable `x`".to_string()), + TextRange::new(unused_variable_start, TextSize::from(99)), + Some(Fix::unsafe_edit(Edit::deletion( + TextSize::from(94), + TextSize::from(104), + ))), + None, + notebook_source, + Some(unused_variable_start), + ); + let mut notebook_indexes = FxHashMap::default(); notebook_indexes.insert( "notebook.ipynb".to_string(), @@ -485,24 +553,8 @@ def foo(): ), ); - let unused_import_os_start = unused_import_os.start(); - let unused_import_math_start = unused_import_math.start(); - let unused_variable_start = unused_variable.start(); - ( - vec![ - Message::from_diagnostic( - unused_import_os, - notebook_source.clone(), - unused_import_os_start, - ), - Message::from_diagnostic( - unused_import_math, - notebook_source.clone(), - unused_import_math_start, - ), - Message::from_diagnostic(unused_variable, notebook_source, unused_variable_start), - ], + vec![unused_import_os, unused_import_math, unused_variable], notebook_indexes, ) } diff --git a/crates/ruff_linter/src/message/pylint.rs b/crates/ruff_linter/src/message/pylint.rs index 10b1f81f1076d..60c7a182dce1f 100644 --- a/crates/ruff_linter/src/message/pylint.rs +++ b/crates/ruff_linter/src/message/pylint.rs @@ -18,20 +18,16 @@ impl Emitter for PylintEmitter { context: &EmitterContext, ) -> anyhow::Result<()> { for message in messages { - let row = if context.is_notebook(message.filename()) { + let row = if context.is_notebook(&message.filename()) { // We can't give a reasonable location for the structured formats, // so we show one that's clearly a fallback OneIndexed::from_zero_indexed(0) } else { - message.compute_start_location().row + message.compute_start_location().line }; - let body = if let Some(rule) = message.rule() { - format!( - "[{code}] {body}", - code = rule.noqa_code(), - body = message.body() - ) + let body = if let Some(code) = message.to_noqa_code() { + format!("[{code}] {body}", body = message.body()) } else { message.body().to_string() }; @@ -39,7 +35,7 @@ impl Emitter for PylintEmitter { writeln!( writer, "{path}:{row}: {body}", - path = relativize_path(message.filename()), + path = relativize_path(&*message.filename()), )?; } @@ -51,10 +47,10 @@ impl Emitter for PylintEmitter { mod tests { use insta::assert_snapshot; + use crate::message::PylintEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::PylintEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/rdjson.rs b/crates/ruff_linter/src/message/rdjson.rs index 99b3fc481e257..32d29fa2c4889 100644 --- a/crates/ruff_linter/src/message/rdjson.rs +++ b/crates/ruff_linter/src/message/rdjson.rs @@ -2,13 +2,13 @@ use std::io::Write; use serde::ser::SerializeSeq; use serde::{Serialize, Serializer}; -use serde_json::{json, Value}; +use serde_json::{Value, json}; use ruff_diagnostics::Edit; use ruff_source_file::SourceCode; use ruff_text_size::Ranged; -use crate::message::{Emitter, EmitterContext, Message, SourceLocation}; +use crate::message::{Emitter, EmitterContext, LineColumn, Message}; #[derive(Default)] pub struct RdjsonEmitter; @@ -57,21 +57,22 @@ impl Serialize for ExpandedMessages<'_> { } fn message_to_rdjson_value(message: &Message) -> Value { - let source_code = message.source_file().to_source_code(); + let source_file = message.source_file(); + let source_code = source_file.to_source_code(); - let start_location = source_code.source_location(message.start()); - let end_location = source_code.source_location(message.end()); + let start_location = source_code.line_column(message.start()); + let end_location = source_code.line_column(message.end()); if let Some(fix) = message.fix() { json!({ "message": message.body(), "location": { "path": message.filename(), - "range": rdjson_range(&start_location, &end_location), + "range": rdjson_range(start_location, end_location), }, "code": { - "value": message.rule().map(|rule| rule.noqa_code().to_string()), - "url": message.rule().and_then(|rule| rule.url()), + "value": message.to_noqa_code().map(|code| code.to_string()), + "url": message.to_url(), }, "suggestions": rdjson_suggestions(fix.edits(), &source_code), }) @@ -80,11 +81,11 @@ fn message_to_rdjson_value(message: &Message) -> Value { "message": message.body(), "location": { "path": message.filename(), - "range": rdjson_range(&start_location, &end_location), + "range": rdjson_range(start_location, end_location), }, "code": { - "value": message.rule().map(|rule| rule.noqa_code().to_string()), - "url": message.rule().and_then(|rule| rule.url()), + "value": message.to_noqa_code().map(|code| code.to_string()), + "url": message.to_url(), }, }) } @@ -95,11 +96,11 @@ fn rdjson_suggestions(edits: &[Edit], source_code: &SourceCode) -> Value { edits .iter() .map(|edit| { - let location = source_code.source_location(edit.start()); - let end_location = source_code.source_location(edit.end()); + let location = source_code.line_column(edit.start()); + let end_location = source_code.line_column(edit.end()); json!({ - "range": rdjson_range(&location, &end_location), + "range": rdjson_range(location, end_location), "text": edit.content().unwrap_or_default(), }) }) @@ -107,16 +108,10 @@ fn rdjson_suggestions(edits: &[Edit], source_code: &SourceCode) -> Value { ) } -fn rdjson_range(start: &SourceLocation, end: &SourceLocation) -> Value { +fn rdjson_range(start: LineColumn, end: LineColumn) -> Value { json!({ - "start": { - "line": start.row, - "column": start.column, - }, - "end": { - "line": end.row, - "column": end.column, - }, + "start": start, + "end": end, }) } @@ -124,10 +119,10 @@ fn rdjson_range(start: &SourceLocation, end: &SourceLocation) -> Value { mod tests { use insta::assert_snapshot; + use crate::message::RdjsonEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::RdjsonEmitter; #[test] fn output() { diff --git a/crates/ruff_linter/src/message/sarif.rs b/crates/ruff_linter/src/message/sarif.rs index a04bb441488e9..5b5021b53162f 100644 --- a/crates/ruff_linter/src/message/sarif.rs +++ b/crates/ruff_linter/src/message/sarif.rs @@ -7,11 +7,11 @@ use serde_json::json; use ruff_source_file::OneIndexed; +use crate::VERSION; use crate::codes::Rule; use crate::fs::normalize_path; use crate::message::{Emitter, EmitterContext, Message}; use crate::registry::{Linter, RuleNamespace}; -use crate::VERSION; pub struct SarifEmitter; @@ -121,35 +121,35 @@ impl SarifResult { fn from_message(message: &Message) -> Result<Self> { let start_location = message.compute_start_location(); let end_location = message.compute_end_location(); - let path = normalize_path(message.filename()); + let path = normalize_path(&*message.filename()); Ok(Self { - rule: message.rule(), + rule: message.to_rule(), level: "error".to_string(), message: message.body().to_string(), uri: url::Url::from_file_path(&path) .map_err(|()| anyhow::anyhow!("Failed to convert path to URL: {}", path.display()))? .to_string(), - start_line: start_location.row, + start_line: start_location.line, start_column: start_location.column, - end_line: end_location.row, + end_line: end_location.line, end_column: end_location.column, }) } #[cfg(target_arch = "wasm32")] - #[allow(clippy::unnecessary_wraps)] + #[expect(clippy::unnecessary_wraps)] fn from_message(message: &Message) -> Result<Self> { let start_location = message.compute_start_location(); let end_location = message.compute_end_location(); - let path = normalize_path(message.filename()); + let path = normalize_path(&*message.filename()); Ok(Self { - rule: message.rule(), + rule: message.to_rule(), level: "error".to_string(), message: message.body().to_string(), uri: path.display().to_string(), - start_line: start_location.row, + start_line: start_location.line, start_column: start_location.column, - end_line: end_location.row, + end_line: end_location.line, end_column: end_location.column, }) } @@ -186,10 +186,10 @@ impl Serialize for SarifResult { #[cfg(test)] mod tests { + use crate::message::SarifEmitter; use crate::message::tests::{ capture_emitter_output, create_messages, create_syntax_error_messages, }; - use crate::message::SarifEmitter; fn get_output() -> String { let mut emitter = SarifEmitter {}; diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__output.snap index f918d0cc57118..263548e8ac10f 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__output.snap @@ -1,8 +1,8 @@ --- source: crates/ruff_linter/src/message/azure.rs expression: content +snapshot_kind: text --- ##vso[task.logissue type=error;sourcepath=fib.py;linenumber=1;columnnumber=8;code=F401;]`os` imported but unused ##vso[task.logissue type=error;sourcepath=fib.py;linenumber=6;columnnumber=5;code=F841;]Local variable `x` is assigned to but never used ##vso[task.logissue type=error;sourcepath=undef.py;linenumber=1;columnnumber=4;code=F821;]Undefined name `a` - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__syntax_errors.snap index 8c57205239b4a..725467d98bbbc 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__azure__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/azure.rs expression: content +snapshot_kind: text --- ##vso[task.logissue type=error;sourcepath=syntax_errors.py;linenumber=1;columnnumber=15;]SyntaxError: Expected one or more symbol names after import ##vso[task.logissue type=error;sourcepath=syntax_errors.py;linenumber=3;columnnumber=12;]SyntaxError: Expected ')', found newline diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__output.snap index 868741b71d8df..c816059368afa 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__output.snap @@ -1,8 +1,8 @@ --- source: crates/ruff_linter/src/message/github.rs expression: content +snapshot_kind: text --- ::error title=Ruff (F401),file=fib.py,line=1,col=8,endLine=1,endColumn=10::fib.py:1:8: F401 `os` imported but unused ::error title=Ruff (F841),file=fib.py,line=6,col=5,endLine=6,endColumn=6::fib.py:6:5: F841 Local variable `x` is assigned to but never used ::error title=Ruff (F821),file=undef.py,line=1,col=4,endLine=1,endColumn=5::undef.py:1:4: F821 Undefined name `a` - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__syntax_errors.snap index e7444371c6797..c7e110c715fc6 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__github__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/github.rs expression: content +snapshot_kind: text --- ::error title=Ruff,file=syntax_errors.py,line=1,col=15,endLine=2,endColumn=1::syntax_errors.py:1:15: SyntaxError: Expected one or more symbol names after import ::error title=Ruff,file=syntax_errors.py,line=3,col=12,endLine=4,endColumn=1::syntax_errors.py:3:12: SyntaxError: Expected ')', found newline diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__output.snap index c059077eed4b1..438a434b6a031 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__output.snap @@ -4,7 +4,8 @@ expression: redact_fingerprint(&content) --- [ { - "description": "(F401) `os` imported but unused", + "check_name": "F401", + "description": "`os` imported but unused", "fingerprint": "<redacted>", "location": { "lines": { @@ -16,7 +17,8 @@ expression: redact_fingerprint(&content) "severity": "major" }, { - "description": "(F841) Local variable `x` is assigned to but never used", + "check_name": "F841", + "description": "Local variable `x` is assigned to but never used", "fingerprint": "<redacted>", "location": { "lines": { @@ -28,7 +30,8 @@ expression: redact_fingerprint(&content) "severity": "major" }, { - "description": "(F821) Undefined name `a`", + "check_name": "F821", + "description": "Undefined name `a`", "fingerprint": "<redacted>", "location": { "lines": { diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__syntax_errors.snap index 27c3c4a3ac3e9..a9ff0a93111a2 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__gitlab__tests__syntax_errors.snap @@ -4,7 +4,8 @@ expression: redact_fingerprint(&content) --- [ { - "description": "SyntaxError: Expected one or more symbol names after import", + "check_name": "syntax-error", + "description": "Expected one or more symbol names after import", "fingerprint": "<redacted>", "location": { "lines": { @@ -16,7 +17,8 @@ expression: redact_fingerprint(&content) "severity": "major" }, { - "description": "SyntaxError: Expected ')', found newline", + "check_name": "syntax-error", + "description": "Expected ')', found newline", "fingerprint": "<redacted>", "location": { "lines": { diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__default.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__default.snap index 66b13ba67d681..a5a7a1cfe836f 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__default.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__default.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/grouped.rs expression: content +snapshot_kind: text --- fib.py: 1:8 F401 `os` imported but unused @@ -8,5 +9,3 @@ fib.py: undef.py: 1:4 F821 Undefined name `a` - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status.snap index 37344ef4884d3..50b46b41e22f5 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/grouped.rs expression: content +snapshot_kind: text --- fib.py: 1:8 F401 `os` imported but unused @@ -27,5 +28,3 @@ undef.py: 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status_unsafe.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status_unsafe.snap index 453cf1eda49e2..0ed5b6efcb8ac 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status_unsafe.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__fix_status_unsafe.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/grouped.rs expression: content +snapshot_kind: text --- fib.py: 1:8 F401 [*] `os` imported but unused @@ -27,5 +28,3 @@ undef.py: 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__show_source.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__show_source.snap index 37344ef4884d3..50b46b41e22f5 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__show_source.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__show_source.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/grouped.rs expression: content +snapshot_kind: text --- fib.py: 1:8 F401 `os` imported but unused @@ -27,5 +28,3 @@ undef.py: 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__syntax_errors.snap index 17e7e59a3e9b0..52f3c9f822033 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__grouped__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/grouped.rs expression: content +snapshot_kind: text --- syntax_errors.py: 1:15 SyntaxError: Expected one or more symbol names after import diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__notebook_output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__notebook_output.snap index 7403245cc13aa..544435ac5cc82 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__notebook_output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__notebook_output.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/json.rs expression: content +snapshot_kind: text --- [ { diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap index fed85f04281fe..eaa9ae77bfa10 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/json.rs expression: content +snapshot_kind: text --- [ { diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__syntax_errors.snap index 1a7fa5b1e4f7b..e6cb8b9651f5a 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/json.rs expression: content +snapshot_kind: text --- [ { diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__notebook_output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__notebook_output.snap index e50520b8b9df9..4f1d092d1cac1 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__notebook_output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__notebook_output.snap @@ -1,8 +1,8 @@ --- source: crates/ruff_linter/src/message/json_lines.rs expression: content +snapshot_kind: text --- {"cell":1,"code":"F401","end_location":{"column":10,"row":2},"filename":"notebook.ipynb","fix":{"applicability":"safe","edits":[{"content":"","end_location":{"column":10,"row":2},"location":{"column":1,"row":2}}],"message":"Remove unused import: `os`"},"location":{"column":8,"row":2},"message":"`os` imported but unused","noqa_row":2,"url":"https://docs.astral.sh/ruff/rules/unused-import"} {"cell":2,"code":"F401","end_location":{"column":12,"row":2},"filename":"notebook.ipynb","fix":{"applicability":"safe","edits":[{"content":"","end_location":{"column":1,"row":3},"location":{"column":1,"row":2}}],"message":"Remove unused import: `math`"},"location":{"column":8,"row":2},"message":"`math` imported but unused","noqa_row":2,"url":"https://docs.astral.sh/ruff/rules/unused-import"} {"cell":3,"code":"F841","end_location":{"column":6,"row":4},"filename":"notebook.ipynb","fix":{"applicability":"unsafe","edits":[{"content":"","end_location":{"column":10,"row":4},"location":{"column":1,"row":4}}],"message":"Remove assignment to unused variable `x`"},"location":{"column":5,"row":4},"message":"Local variable `x` is assigned to but never used","noqa_row":4,"url":"https://docs.astral.sh/ruff/rules/unused-variable"} - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap index 57cd47822ceea..9248b0ffd578d 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap @@ -1,8 +1,8 @@ --- source: crates/ruff_linter/src/message/json_lines.rs expression: content +snapshot_kind: text --- {"cell":null,"code":"F401","end_location":{"column":10,"row":1},"filename":"fib.py","fix":{"applicability":"unsafe","edits":[{"content":"","end_location":{"column":1,"row":2},"location":{"column":1,"row":1}}],"message":"Remove unused import: `os`"},"location":{"column":8,"row":1},"message":"`os` imported but unused","noqa_row":1,"url":"https://docs.astral.sh/ruff/rules/unused-import"} {"cell":null,"code":"F841","end_location":{"column":6,"row":6},"filename":"fib.py","fix":{"applicability":"unsafe","edits":[{"content":"","end_location":{"column":10,"row":6},"location":{"column":5,"row":6}}],"message":"Remove assignment to unused variable `x`"},"location":{"column":5,"row":6},"message":"Local variable `x` is assigned to but never used","noqa_row":6,"url":"https://docs.astral.sh/ruff/rules/unused-variable"} {"cell":null,"code":"F821","end_location":{"column":5,"row":1},"filename":"undef.py","fix":null,"location":{"column":4,"row":1},"message":"Undefined name `a`","noqa_row":1,"url":"https://docs.astral.sh/ruff/rules/undefined-name"} - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__syntax_errors.snap index 326913dcdfb10..84665036386e6 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/json_lines.rs expression: content +snapshot_kind: text --- {"cell":null,"code":null,"end_location":{"column":1,"row":2},"filename":"syntax_errors.py","fix":null,"location":{"column":15,"row":1},"message":"SyntaxError: Expected one or more symbol names after import","noqa_row":null,"url":null} {"cell":null,"code":null,"end_location":{"column":1,"row":4},"filename":"syntax_errors.py","fix":null,"location":{"column":12,"row":3},"message":"SyntaxError: Expected ')', found newline","noqa_row":null,"url":null} diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__output.snap index ae5e6c8b43191..5f865140937d1 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__output.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/junit.rs expression: content +snapshot_kind: text --- <?xml version="1.0" encoding="UTF-8"?> <testsuites name="ruff" tests="3" failures="3" errors="0"> @@ -18,4 +19,3 @@ expression: content </testcase> </testsuite> </testsuites> - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__syntax_errors.snap index c8015a9d5e300..6c01051cbd125 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__junit__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/junit.rs expression: content +snapshot_kind: text --- <?xml version="1.0" encoding="UTF-8"?> <testsuites name="ruff" tests="2" failures="2" errors="0"> diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__output.snap index 02b55a48846cf..21ae8043c0fa6 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__output.snap @@ -1,8 +1,8 @@ --- source: crates/ruff_linter/src/message/pylint.rs expression: content +snapshot_kind: text --- fib.py:1: [F401] `os` imported but unused fib.py:6: [F841] Local variable `x` is assigned to but never used undef.py:1: [F821] Undefined name `a` - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__syntax_errors.snap index bc6b33b48e284..2bfd7e3d17a5c 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__pylint__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/pylint.rs expression: content +snapshot_kind: text --- syntax_errors.py:1: SyntaxError: Expected one or more symbol names after import syntax_errors.py:3: SyntaxError: Expected ')', found newline diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__output.snap index cbb8d6c632796..23edde3f3cd5e 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__output.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/rdjson.rs expression: content +snapshot_kind: text --- { "diagnostics": [ diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__syntax_errors.snap index c73c784b19b44..c7eed6f8608ea 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__rdjson__tests__syntax_errors.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/rdjson.rs expression: content +snapshot_kind: text --- { "diagnostics": [ diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__sarif__tests__results.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__sarif__tests__results.snap index a72d48100cba2..224cdf75ae6d9 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__sarif__tests__results.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__sarif__tests__results.snap @@ -81,7 +81,7 @@ expression: value "rules": [ { "fullDescription": { - "text": "## What it does\nChecks for unused imports.\n\n## Why is this bad?\nUnused imports add a performance overhead at runtime, and risk creating\nimport cycles. They also increase the cognitive load of reading the code.\n\nIf an import statement is used to check for the availability or existence\nof a module, consider using `importlib.util.find_spec` instead.\n\nIf an import statement is used to re-export a symbol as part of a module's\npublic interface, consider using a \"redundant\" import alias, which\ninstructs Ruff (and other tools) to respect the re-export, and avoid\nmarking it as unused, as in:\n\n```python\nfrom module import member as member\n```\n\nAlternatively, you can use `__all__` to declare a symbol as part of the module's\ninterface, as in:\n\n```python\n# __init__.py\nimport some_module\n\n__all__ = [\"some_module\"]\n```\n\n## Fix safety\n\nFixes to remove unused imports are safe, except in `__init__.py` files.\n\nApplying fixes to `__init__.py` files is currently in preview. The fix offered depends on the\ntype of the unused import. Ruff will suggest a safe fix to export first-party imports with\neither a redundant alias or, if already present in the file, an `__all__` entry. If multiple\n`__all__` declarations are present, Ruff will not offer a fix. Ruff will suggest an unsafe fix\nto remove third-party and standard library imports -- the fix is unsafe because the module's\ninterface changes.\n\n## Example\n\n```python\nimport numpy as np # unused import\n\n\ndef area(radius):\n return 3.14 * radius**2\n```\n\nUse instead:\n\n```python\ndef area(radius):\n return 3.14 * radius**2\n```\n\nTo check the availability of a module, use `importlib.util.find_spec`:\n\n```python\nfrom importlib.util import find_spec\n\nif find_spec(\"numpy\") is not None:\n print(\"numpy is installed\")\nelse:\n print(\"numpy is not installed\")\n```\n\n## Options\n- `lint.ignore-init-module-imports`\n\n## References\n- [Python documentation: `import`](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement)\n- [Python documentation: `importlib.util.find_spec`](https://docs.python.org/3/library/importlib.html#importlib.util.find_spec)\n- [Typing documentation: interface conventions](https://typing.readthedocs.io/en/latest/source/libraries.html#library-interface-public-and-private-symbols)\n" + "text": "## What it does\nChecks for unused imports.\n\n## Why is this bad?\nUnused imports add a performance overhead at runtime, and risk creating\nimport cycles. They also increase the cognitive load of reading the code.\n\nIf an import statement is used to check for the availability or existence\nof a module, consider using `importlib.util.find_spec` instead.\n\nIf an import statement is used to re-export a symbol as part of a module's\npublic interface, consider using a \"redundant\" import alias, which\ninstructs Ruff (and other tools) to respect the re-export, and avoid\nmarking it as unused, as in:\n\n```python\nfrom module import member as member\n```\n\nAlternatively, you can use `__all__` to declare a symbol as part of the module's\ninterface, as in:\n\n```python\n# __init__.py\nimport some_module\n\n__all__ = [\"some_module\"]\n```\n\n## Fix safety\n\nFixes to remove unused imports are safe, except in `__init__.py` files.\n\nApplying fixes to `__init__.py` files is currently in preview. The fix offered depends on the\ntype of the unused import. Ruff will suggest a safe fix to export first-party imports with\neither a redundant alias or, if already present in the file, an `__all__` entry. If multiple\n`__all__` declarations are present, Ruff will not offer a fix. Ruff will suggest an unsafe fix\nto remove third-party and standard library imports -- the fix is unsafe because the module's\ninterface changes.\n\n## Example\n\n```python\nimport numpy as np # unused import\n\n\ndef area(radius):\n return 3.14 * radius**2\n```\n\nUse instead:\n\n```python\ndef area(radius):\n return 3.14 * radius**2\n```\n\nTo check the availability of a module, use `importlib.util.find_spec`:\n\n```python\nfrom importlib.util import find_spec\n\nif find_spec(\"numpy\") is not None:\n print(\"numpy is installed\")\nelse:\n print(\"numpy is not installed\")\n```\n\n## Preview\nWhen [preview](https://docs.astral.sh/ruff/preview/) is enabled,\nthe criterion for determining whether an import is first-party\nis stricter, which could affect the suggested fix. See [this FAQ section](https://docs.astral.sh/ruff/faq/#how-does-ruff-determine-which-of-my-imports-are-first-party-third-party-etc) for more details.\n\n## Options\n- `lint.ignore-init-module-imports`\n- `lint.pyflakes.allowed-unused-imports`\n\n## References\n- [Python documentation: `import`](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement)\n- [Python documentation: `importlib.util.find_spec`](https://docs.python.org/3/library/importlib.html#importlib.util.find_spec)\n- [Typing documentation: interface conventions](https://typing.python.org/en/latest/source/libraries.html#library-interface-public-and-private-symbols)\n" }, "help": { "text": "`{name}` imported but unused; consider using `importlib.util.find_spec` to test for availability" @@ -119,7 +119,7 @@ expression: value }, { "fullDescription": { - "text": "## What it does\nChecks for the presence of unused variables in function scopes.\n\n## Why is this bad?\nA variable that is defined but not used is likely a mistake, and should\nbe removed to avoid confusion.\n\nIf a variable is intentionally defined-but-not-used, it should be\nprefixed with an underscore, or some other value that adheres to the\n[`lint.dummy-variable-rgx`] pattern.\n\nUnder [preview mode](https://docs.astral.sh/ruff/preview), this rule also\ntriggers on unused unpacked assignments (for example, `x, y = foo()`).\n\n## Example\n```python\ndef foo():\n x = 1\n y = 2\n return x\n```\n\nUse instead:\n```python\ndef foo():\n x = 1\n return x\n```\n\n## Options\n- `lint.dummy-variable-rgx`\n" + "text": "## What it does\nChecks for the presence of unused variables in function scopes.\n\n## Why is this bad?\nA variable that is defined but not used is likely a mistake, and should\nbe removed to avoid confusion.\n\nIf a variable is intentionally defined-but-not-used, it should be\nprefixed with an underscore, or some other value that adheres to the\n[`lint.dummy-variable-rgx`] pattern.\n\n## Example\n```python\ndef foo():\n x = 1\n y = 2\n return x\n```\n\nUse instead:\n```python\ndef foo():\n x = 1\n return x\n```\n\n## Fix safety\n\nThis rule's fix is marked as unsafe because removing an unused variable assignment may\ndelete comments that are attached to the assignment.\n\n## Options\n- `lint.dummy-variable-rgx`\n" }, "help": { "text": "Local variable `{name}` is assigned to but never used" diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__default.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__default.snap index 77cd92056a7de..f3ff7977ada3e 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__default.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__default.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/text.rs expression: content +snapshot_kind: text --- fib.py:1:8: F401 `os` imported but unused | @@ -25,5 +26,3 @@ undef.py:1:4: F821 Undefined name `a` 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status.snap index 77cd92056a7de..f3ff7977ada3e 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/text.rs expression: content +snapshot_kind: text --- fib.py:1:8: F401 `os` imported but unused | @@ -25,5 +26,3 @@ undef.py:1:4: F821 Undefined name `a` 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status_unsafe.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status_unsafe.snap index a53420329c119..9d5ac7b6d620f 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status_unsafe.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__fix_status_unsafe.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_linter/src/message/text.rs expression: content +snapshot_kind: text --- fib.py:1:8: F401 [*] `os` imported but unused | @@ -25,5 +26,3 @@ undef.py:1:4: F821 Undefined name `a` 1 | if a == 1: pass | ^ F821 | - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__notebook_output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__notebook_output.snap index 5cd2f33939a8f..3d8a6d9c4b881 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__notebook_output.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__notebook_output.snap @@ -15,7 +15,7 @@ notebook.ipynb:cell 2:2:8: F401 [*] `math` imported but unused 1 | # cell 2 2 | import math | ^^^^ F401 -3 | +3 | 4 | print('hello world') | = help: Remove unused import: `math` @@ -28,5 +28,3 @@ notebook.ipynb:cell 3:4:5: F841 [*] Local variable `x` is assigned to but never | ^ F841 | = help: Remove assignment to unused variable `x` - - diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__syntax_errors.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__syntax_errors.snap index 618774276b3b5..b0cb4085807d0 100644 --- a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__syntax_errors.snap +++ b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__text__tests__syntax_errors.snap @@ -6,7 +6,7 @@ syntax_errors.py:1:15: SyntaxError: Expected one or more symbol names after impo | 1 | from os import | ^ -2 | +2 | 3 | if call(foo 4 | def bar(): | @@ -14,7 +14,7 @@ syntax_errors.py:1:15: SyntaxError: Expected one or more symbol names after impo syntax_errors.py:3:12: SyntaxError: Expected ')', found newline | 1 | from os import -2 | +2 | 3 | if call(foo | ^ 4 | def bar(): diff --git a/crates/ruff_linter/src/message/text.rs b/crates/ruff_linter/src/message/text.rs index 595d62500ae73..65b98d9c1bd1b 100644 --- a/crates/ruff_linter/src/message/text.rs +++ b/crates/ruff_linter/src/message/text.rs @@ -2,31 +2,30 @@ use std::borrow::Cow; use std::fmt::{Display, Formatter}; use std::io::Write; -use annotate_snippets::display_list::{DisplayList, FormatOptions}; -use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation}; use bitflags::bitflags; use colored::Colorize; +use ruff_annotate_snippets::{Level, Renderer, Snippet}; use ruff_notebook::NotebookIndex; -use ruff_source_file::{OneIndexed, SourceLocation}; -use ruff_text_size::{Ranged, TextRange, TextSize}; +use ruff_source_file::{LineColumn, OneIndexed}; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::fs::relativize_path; use crate::line_width::{IndentWidth, LineWidthBuilder}; use crate::message::diff::Diff; use crate::message::{Emitter, EmitterContext, Message}; use crate::settings::types::UnsafeFixes; -use crate::text_helpers::ShowNonprinting; bitflags! { #[derive(Default)] struct EmitterFlags: u8 { /// Whether to show the fix status of a diagnostic. - const SHOW_FIX_STATUS = 0b0000_0001; + const SHOW_FIX_STATUS = 1 << 0; /// Whether to show the diff of a fix, for diagnostics that have a fix. - const SHOW_FIX_DIFF = 0b0000_0010; + const SHOW_FIX_DIFF = 1 << 1; /// Whether to show the source code of a diagnostic. - const SHOW_SOURCE = 0b0000_0100; + const SHOW_SOURCE = 1 << 2; } } @@ -74,12 +73,12 @@ impl Emitter for TextEmitter { write!( writer, "{path}{sep}", - path = relativize_path(message.filename()).bold(), + path = relativize_path(&*message.filename()).bold(), sep = ":".cyan(), )?; let start_location = message.compute_start_location(); - let notebook_index = context.notebook_index(message.filename()); + let notebook_index = context.notebook_index(&message.filename()); // Check if we're working on a jupyter notebook and translate positions with cell accordingly let diagnostic_location = if let Some(notebook_index) = notebook_index { @@ -87,14 +86,14 @@ impl Emitter for TextEmitter { writer, "cell {cell}{sep}", cell = notebook_index - .cell(start_location.row) + .cell(start_location.line) .unwrap_or(OneIndexed::MIN), sep = ":".cyan(), )?; - SourceLocation { - row: notebook_index - .cell_row(start_location.row) + LineColumn { + line: notebook_index + .cell_row(start_location.line) .unwrap_or(OneIndexed::MIN), column: start_location.column, } @@ -105,7 +104,7 @@ impl Emitter for TextEmitter { writeln!( writer, "{row}{sep}{col}{sep} {code_and_body}", - row = diagnostic_location.row, + row = diagnostic_location.line, col = diagnostic_location.column, sep = ":".cyan(), code_and_body = RuleCodeAndBody { @@ -152,8 +151,8 @@ impl Display for RuleCodeAndBody<'_> { if let Some(fix) = self.message.fix() { // Do not display an indicator for inapplicable fixes if fix.applies(self.unsafe_fixes.required_applicability()) { - if let Some(rule) = self.message.rule() { - write!(f, "{} ", rule.noqa_code().to_string().red().bold())?; + if let Some(code) = self.message.to_noqa_code() { + write!(f, "{} ", code.to_string().red().bold())?; } return write!( f, @@ -163,13 +162,13 @@ impl Display for RuleCodeAndBody<'_> { ); } } - }; + } - if let Some(rule) = self.message.rule() { + if let Some(code) = self.message.to_noqa_code() { write!( f, "{code} {body}", - code = rule.noqa_code().to_string().red().bold(), + code = code.to_string().red().bold(), body = self.message.body(), ) } else { @@ -186,17 +185,14 @@ pub(super) struct MessageCodeFrame<'a> { impl Display for MessageCodeFrame<'_> { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { let suggestion = self.message.suggestion(); - let footer = if suggestion.is_some() { - vec![Annotation { - id: None, - label: suggestion, - annotation_type: AnnotationType::Help, - }] + let footers = if let Some(suggestion) = suggestion { + vec![Level::Help.title(suggestion)] } else { Vec::new() }; - let source_code = self.message.source_file().to_source_code(); + let source_file = self.message.source_file(); + let source_code = source_file.to_source_code(); let content_start_index = source_code.line_index(self.message.start()); let mut start_index = content_start_index.saturating_sub(2); @@ -250,93 +246,109 @@ impl Display for MessageCodeFrame<'_> { let start_offset = source_code.line_start(start_index); let end_offset = source_code.line_end(end_index); - let source = replace_whitespace( + let source = replace_whitespace_and_unprintable( source_code.slice(TextRange::new(start_offset, end_offset)), self.message.range() - start_offset, - ); - - let source_text = source.text.show_nonprinting(); - - let start_char = source.text[TextRange::up_to(source.annotation_range.start())] - .chars() - .count(); - - let char_length = source.text[source.annotation_range].chars().count(); + ) + .fix_up_empty_spans_after_line_terminator(); let label = self .message - .rule() - .map_or_else(String::new, |rule| rule.noqa_code().to_string()); - - let snippet = Snippet { - title: None, - slices: vec![Slice { - source: &source_text, - line_start: self.notebook_index.map_or_else( - || start_index.get(), - |notebook_index| { - notebook_index - .cell_row(start_index) - .unwrap_or(OneIndexed::MIN) - .get() - }, - ), - annotations: vec![SourceAnnotation { - label: &label, - annotation_type: AnnotationType::Error, - range: (start_char, start_char + char_length), - }], - // The origin (file name, line number, and column number) is already encoded - // in the `label`. - origin: None, - fold: false, - }], - footer, - opt: FormatOptions { - #[cfg(test)] - color: false, - #[cfg(not(test))] - color: colored::control::SHOULD_COLORIZE.should_colorize(), - ..FormatOptions::default() + .to_noqa_code() + .map_or_else(String::new, |code| code.to_string()); + + let line_start = self.notebook_index.map_or_else( + || start_index.get(), + |notebook_index| { + notebook_index + .cell_row(start_index) + .unwrap_or(OneIndexed::MIN) + .get() }, - }; + ); - writeln!(f, "{message}", message = DisplayList::from(snippet)) + let span = usize::from(source.annotation_range.start()) + ..usize::from(source.annotation_range.end()); + let annotation = Level::Error.span(span).label(&label); + let snippet = Snippet::source(&source.text) + .line_start(line_start) + .annotation(annotation) + .fold(false); + let message = Level::None.title("").snippet(snippet).footers(footers); + + let renderer = if !cfg!(test) && colored::control::SHOULD_COLORIZE.should_colorize() { + Renderer::styled() + } else { + Renderer::plain() + } + .cut_indicator("…"); + let rendered = renderer.render(message); + writeln!(f, "{rendered}") } } -fn replace_whitespace(source: &str, annotation_range: TextRange) -> SourceCode { +/// Given some source code and an annotation range, this routine replaces +/// tabs with ASCII whitespace, and unprintable characters with printable +/// representations of them. +/// +/// The source code returned has an annotation that is updated to reflect +/// changes made to the source code (if any). +fn replace_whitespace_and_unprintable(source: &str, annotation_range: TextRange) -> SourceCode { let mut result = String::new(); let mut last_end = 0; let mut range = annotation_range; let mut line_width = LineWidthBuilder::new(IndentWidth::default()); + // Updates the range given by the caller whenever a single byte (at + // `index` in `source`) is replaced with `len` bytes. + // + // When the index occurs before the start of the range, the range is + // offset by `len`. When the range occurs after or at the start but before + // the end, then the end of the range only is offset by `len`. + let mut update_range = |index, len| { + if index < usize::from(annotation_range.start()) { + range += TextSize::new(len - 1); + } else if index < usize::from(annotation_range.end()) { + range = range.add_end(TextSize::new(len - 1)); + } + }; + + // If `c` is an unprintable character, then this returns a printable + // representation of it (using a fancier Unicode codepoint). + let unprintable_replacement = |c: char| -> Option<char> { + match c { + '\x07' => Some('␇'), + '\x08' => Some('␈'), + '\x1b' => Some('␛'), + '\x7f' => Some('␡'), + _ => None, + } + }; + for (index, c) in source.char_indices() { let old_width = line_width.get(); line_width = line_width.add_char(c); if matches!(c, '\t') { - // SAFETY: The difference is a value in the range [1..TAB_SIZE] which is guaranteed to be less than `u32`. - #[allow(clippy::cast_possible_truncation)] - let tab_width = (line_width.get() - old_width) as u32; - - if index < usize::from(annotation_range.start()) { - range += TextSize::new(tab_width - 1); - } else if index < usize::from(annotation_range.end()) { - range = range.add_end(TextSize::new(tab_width - 1)); - } - + let tab_width = u32::try_from(line_width.get() - old_width) + .expect("small width because of tab size"); result.push_str(&source[last_end..index]); - for _ in 0..tab_width { result.push(' '); } - last_end = index + 1; + update_range(index, tab_width); + } else if let Some(printable) = unprintable_replacement(c) { + result.push_str(&source[last_end..index]); + result.push(printable); + last_end = index + 1; + + let len = printable.text_len().to_u32(); + update_range(index, len); } } - // No tabs + // No tabs or unprintable chars if result.is_empty() { SourceCode { annotation_range, @@ -356,15 +368,50 @@ struct SourceCode<'a> { annotation_range: TextRange, } +impl<'a> SourceCode<'a> { + /// This attempts to "fix up" the span on `SourceCode` in the case where + /// it's an empty span immediately following a line terminator. + /// + /// At present, `annotate-snippets` (both upstream and our vendored copy) + /// will render annotations of such spans to point to the space immediately + /// following the previous line. But ideally, this should point to the space + /// immediately preceding the next line. + /// + /// After attempting to fix `annotate-snippets` and giving up after a couple + /// hours, this routine takes a different tact: it adjusts the span to be + /// non-empty and it will cover the first codepoint of the following line. + /// This forces `annotate-snippets` to point to the right place. + /// + /// See also: <https://github.com/astral-sh/ruff/issues/15509> + fn fix_up_empty_spans_after_line_terminator(self) -> SourceCode<'a> { + if !self.annotation_range.is_empty() + || self.annotation_range.start() == TextSize::from(0) + || self.annotation_range.start() >= self.text.text_len() + { + return self; + } + if self.text.as_bytes()[self.annotation_range.start().to_usize() - 1] != b'\n' { + return self; + } + let locator = Locator::new(&self.text); + let start = self.annotation_range.start(); + let end = locator.ceil_char_boundary(start + TextSize::from(1)); + SourceCode { + annotation_range: TextRange::new(start, end), + ..self + } + } +} + #[cfg(test)] mod tests { use insta::assert_snapshot; + use crate::message::TextEmitter; use crate::message::tests::{ capture_emitter_notebook_output, capture_emitter_output, create_messages, create_notebook_messages, create_syntax_error_messages, }; - use crate::message::TextEmitter; use crate::settings::types::UnsafeFixes; #[test] diff --git a/crates/ruff_linter/src/noqa.rs b/crates/ruff_linter/src/noqa.rs index 948cd534f95da..8cf9c8ea165e7 100644 --- a/crates/ruff_linter/src/noqa.rs +++ b/crates/ruff_linter/src/noqa.rs @@ -9,25 +9,26 @@ use anyhow::Result; use itertools::Itertools; use log::warn; -use ruff_diagnostics::{Diagnostic, Edit}; -use ruff_python_trivia::{indentation_at_offset, CommentRanges}; +use ruff_diagnostics::Edit; +use ruff_python_trivia::{CommentRanges, Cursor, indentation_at_offset}; use ruff_source_file::{LineEnding, LineRanges}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::codes::NoqaCode; use crate::fs::relativize_path; -use crate::registry::{AsRule, Rule, RuleSet}; +use crate::message::Message; +use crate::registry::{Rule, RuleSet}; use crate::rule_redirects::get_redirect_target; -use crate::Locator; -/// Generates an array of edits that matches the length of `diagnostics`. +/// Generates an array of edits that matches the length of `messages`. /// Each potential edit in the array is paired, in order, with the associated diagnostic. /// Each edit will add a `noqa` comment to the appropriate line in the source to hide /// the diagnostic. These edits may conflict with each other and should not be applied /// simultaneously. pub fn generate_noqa_edits( path: &Path, - diagnostics: &[Diagnostic], + messages: &[Message], locator: &Locator, comment_ranges: &CommentRanges, external: &[String], @@ -36,13 +37,13 @@ pub fn generate_noqa_edits( ) -> Vec<Option<Edit>> { let file_directives = FileNoqaDirectives::extract(locator, comment_ranges, external, path); let exemption = FileExemption::from(&file_directives); - let directives = NoqaDirectives::from_commented_ranges(comment_ranges, path, locator); - let comments = find_noqa_comments(diagnostics, locator, &exemption, &directives, noqa_line_for); + let directives = NoqaDirectives::from_commented_ranges(comment_ranges, external, path, locator); + let comments = find_noqa_comments(messages, locator, &exemption, &directives, noqa_line_for); build_noqa_edits_by_diagnostic(comments, locator, line_ending) } -/// A directive to ignore a set of rules for a given line of Python source code (e.g., -/// `# noqa: F401, F841`). +/// A directive to ignore a set of rules either for a given line of Python source code or an entire file (e.g., +/// `# noqa: F401, F841` or `#ruff: noqa: F401, F841`). #[derive(Debug)] pub(crate) enum Directive<'a> { /// The `noqa` directive ignores all rules (e.g., `# noqa`). @@ -51,148 +52,6 @@ pub(crate) enum Directive<'a> { Codes(Codes<'a>), } -impl<'a> Directive<'a> { - /// Extract the noqa `Directive` from a line of Python source code. - pub(crate) fn try_extract(text: &'a str, offset: TextSize) -> Result<Option<Self>, ParseError> { - for (char_index, char) in text.char_indices() { - // Only bother checking for the `noqa` literal if the character is `n` or `N`. - if !matches!(char, 'n' | 'N') { - continue; - } - - // Determine the start of the `noqa` literal. - if !matches!( - text[char_index..].as_bytes(), - [b'n' | b'N', b'o' | b'O', b'q' | b'Q', b'a' | b'A', ..] - ) { - continue; - } - - let noqa_literal_start = char_index; - let noqa_literal_end = noqa_literal_start + "noqa".len(); - - // Determine the start of the comment. - let mut comment_start = noqa_literal_start; - - // Trim any whitespace between the `#` character and the `noqa` literal. - comment_start = text[..comment_start].trim_end().len(); - - // The next character has to be the `#` character. - if text[..comment_start] - .chars() - .last() - .map_or(true, |c| c != '#') - { - continue; - } - comment_start -= '#'.len_utf8(); - - // If the next character is `:`, then it's a list of codes. Otherwise, it's a directive - // to ignore all rules. - let directive = match text[noqa_literal_end..].chars().next() { - Some(':') => { - // E.g., `# noqa: F401, F841`. - let mut codes_start = noqa_literal_end; - - // Skip the `:` character. - codes_start += ':'.len_utf8(); - - // Skip any whitespace between the `:` and the codes. - codes_start += text[codes_start..] - .find(|c: char| !c.is_whitespace()) - .unwrap_or(0); - - // Extract the comma-separated list of codes. - let mut codes = vec![]; - let mut codes_end = codes_start; - let mut leading_space = 0; - while let Some(code) = Self::lex_code(&text[codes_end + leading_space..]) { - codes_end += leading_space; - codes.push(Code { - code, - range: TextRange::at( - TextSize::try_from(codes_end).unwrap(), - code.text_len(), - ) - .add(offset), - }); - - codes_end += code.len(); - - // Codes can be comma- or whitespace-delimited. Compute the length of the - // delimiter, but only add it in the next iteration, once we find the next - // code. - if let Some(space_between) = - text[codes_end..].find(|c: char| !(c.is_whitespace() || c == ',')) - { - leading_space = space_between; - } else { - break; - } - } - - // If we didn't identify any codes, warn. - if codes.is_empty() { - return Err(ParseError::MissingCodes); - } - - let range = TextRange::new( - TextSize::try_from(comment_start).unwrap(), - TextSize::try_from(codes_end).unwrap(), - ); - - Self::Codes(Codes { - range: range.add(offset), - codes, - }) - } - None | Some('#') => { - // E.g., `# noqa` or `# noqa# ignore`. - let range = TextRange::new( - TextSize::try_from(comment_start).unwrap(), - TextSize::try_from(noqa_literal_end).unwrap(), - ); - Self::All(All { - range: range.add(offset), - }) - } - Some(c) if c.is_whitespace() => { - // E.g., `# noqa # ignore`. - let range = TextRange::new( - TextSize::try_from(comment_start).unwrap(), - TextSize::try_from(noqa_literal_end).unwrap(), - ); - Self::All(All { - range: range.add(offset), - }) - } - _ => return Err(ParseError::InvalidSuffix), - }; - - return Ok(Some(directive)); - } - - Ok(None) - } - - /// Lex an individual rule code (e.g., `F401`). - #[inline] - pub(crate) fn lex_code(line: &str) -> Option<&str> { - // Extract, e.g., the `F` in `F401`. - let prefix = line.chars().take_while(char::is_ascii_uppercase).count(); - // Extract, e.g., the `401` in `F401`. - let suffix = line[prefix..] - .chars() - .take_while(char::is_ascii_digit) - .count(); - if prefix > 0 && suffix > 0 { - Some(&line[..prefix + suffix]) - } else { - None - } - } -} - #[derive(Debug)] pub(crate) struct All { range: TextRange, @@ -225,7 +84,7 @@ impl Display for Code<'_> { } } -impl<'a> Ranged for Code<'a> { +impl Ranged for Code<'_> { /// The range of the rule code. fn range(&self) -> TextRange { self.range @@ -238,7 +97,7 @@ pub(crate) struct Codes<'a> { codes: Vec<Code<'a>>, } -impl<'a> Codes<'a> { +impl Codes<'_> { /// Returns an iterator over the [`Code`]s in the `noqa` directive. pub(crate) fn iter(&self) -> std::slice::Iter<Code> { self.codes.iter() @@ -246,8 +105,7 @@ impl<'a> Codes<'a> { /// Returns `true` if the string list of `codes` includes `code` (or an alias /// thereof). - pub(crate) fn includes(&self, needle: Rule) -> bool { - let needle = needle.noqa_code(); + pub(crate) fn includes(&self, needle: NoqaCode) -> bool { self.iter() .any(|code| needle == get_redirect_target(code.as_str()).unwrap_or(code.as_str())) } @@ -265,13 +123,23 @@ pub(crate) fn rule_is_ignored( code: Rule, offset: TextSize, noqa_line_for: &NoqaMapping, + comment_ranges: &CommentRanges, locator: &Locator, ) -> bool { let offset = noqa_line_for.resolve(offset); let line_range = locator.line_range(offset); - match Directive::try_extract(locator.slice(line_range), line_range.start()) { - Ok(Some(Directive::All(_))) => true, - Ok(Some(Directive::Codes(codes))) => codes.includes(code), + let &[comment_range] = comment_ranges.comments_in_range(line_range) else { + return false; + }; + match lex_inline_noqa(comment_range, locator.contents()) { + Ok(Some(NoqaLexerOutput { + directive: Directive::All(_), + .. + })) => true, + Ok(Some(NoqaLexerOutput { + directive: Directive::Codes(codes), + .. + })) => codes.includes(code.noqa_code()), _ => false, } } @@ -285,7 +153,7 @@ pub(crate) enum FileExemption<'a> { Codes(Vec<&'a NoqaCode>), } -impl<'a> FileExemption<'a> { +impl FileExemption<'_> { /// Returns `true` if the file is exempt from the given rule. pub(crate) fn includes(&self, needle: Rule) -> bool { let needle = needle.noqa_code(); @@ -317,7 +185,7 @@ impl<'a> From<&'a FileNoqaDirectives<'a>> for FileExemption<'a> { if directives .lines() .iter() - .any(|line| ParsedFileExemption::All == line.parsed_file_exemption) + .any(|line| matches!(line.parsed_file_exemption, Directive::All(_))) { FileExemption::All(codes) } else { @@ -332,7 +200,7 @@ pub(crate) struct FileNoqaDirectiveLine<'a> { /// The range of the text line for which the noqa directive applies. pub(crate) range: TextRange, /// The blanket noqa directive. - pub(crate) parsed_file_exemption: ParsedFileExemption<'a>, + pub(crate) parsed_file_exemption: Directive<'a>, /// The codes that are ignored by the parsed exemptions. pub(crate) matches: Vec<NoqaCode>, } @@ -360,28 +228,40 @@ impl<'a> FileNoqaDirectives<'a> { let mut lines = vec![]; for range in comment_ranges { - match ParsedFileExemption::try_extract(&locator.contents()[range]) { - Err(err) => { - #[allow(deprecated)] - let line = locator.compute_line_index(range.start()); - let path_display = relativize_path(path); - warn!("Invalid `# ruff: noqa` directive at {path_display}:{line}: {err}"); - } - Ok(Some(exemption)) => { - if indentation_at_offset(range.start(), locator.contents()).is_none() { - #[allow(deprecated)] + let lexed = lex_file_exemption(range, locator.contents()); + match lexed { + Ok(Some(NoqaLexerOutput { + warnings, + directive, + })) => { + let no_indentation_at_offset = + indentation_at_offset(range.start(), locator.contents()).is_none(); + if !warnings.is_empty() || no_indentation_at_offset { + #[expect(deprecated)] let line = locator.compute_line_index(range.start()); let path_display = relativize_path(path); - warn!("Unexpected `# ruff: noqa` directive at {path_display}:{line}. File-level suppression comments must appear on their own line. For line-level suppression, omit the `ruff:` prefix."); - continue; + + for warning in warnings { + warn!( + "Missing or joined rule code(s) at {path_display}:{line}: {warning}" + ); + } + + if no_indentation_at_offset { + warn!( + "Unexpected `# ruff: noqa` directive at {path_display}:{line}. File-level suppression comments must appear on their own line. For line-level suppression, omit the `ruff:` prefix." + ); + continue; + } } - let matches = match &exemption { - ParsedFileExemption::All => { + let matches = match &directive { + Directive::All(_) => { vec![] } - ParsedFileExemption::Codes(codes) => { + Directive::Codes(codes) => { codes.iter().filter_map(|code| { + let code = code.as_str(); // Ignore externally-defined rules. if external.iter().any(|external| code.starts_with(external)) { return None; @@ -391,7 +271,7 @@ impl<'a> FileNoqaDirectives<'a> { { Some(rule.noqa_code()) } else { - #[allow(deprecated)] + #[expect(deprecated)] let line = locator.compute_line_index(range.start()); let path_display = relativize_path(path); warn!("Invalid rule code provided to `# ruff: noqa` at {path_display}:{line}: {code}"); @@ -403,14 +283,19 @@ impl<'a> FileNoqaDirectives<'a> { lines.push(FileNoqaDirectiveLine { range, - parsed_file_exemption: exemption, + parsed_file_exemption: directive, matches, }); } + Err(err) => { + #[expect(deprecated)] + let line = locator.compute_line_index(range.start()); + let path_display = relativize_path(path); + warn!("Invalid `# ruff: noqa` directive at {path_display}:{line}: {err}"); + } Ok(None) => {} } } - Self(lines) } @@ -419,173 +304,409 @@ impl<'a> FileNoqaDirectives<'a> { } } -/// An individual file-level exemption (e.g., `# ruff: noqa` or `# ruff: noqa: F401, F841`). Like -/// [`FileNoqaDirectives`], but only for a single line, as opposed to an aggregated set of exemptions -/// across a source file. -#[derive(Debug, PartialEq, Eq)] -pub(crate) enum ParsedFileExemption<'a> { - /// The file-level exemption ignores all rules (e.g., `# ruff: noqa`). - All, - /// The file-level exemption ignores specific rules (e.g., `# ruff: noqa: F401, F841`). - Codes(Vec<&'a str>), +/// Output of lexing a `noqa` directive. +#[derive(Debug)] +pub(crate) struct NoqaLexerOutput<'a> { + warnings: Vec<LexicalWarning>, + directive: Directive<'a>, } -impl<'a> ParsedFileExemption<'a> { - /// Return a [`ParsedFileExemption`] for a given comment line. - fn try_extract(line: &'a str) -> Result<Option<Self>, ParseError> { - let line = Self::lex_whitespace(line); - let Some(line) = Self::lex_char(line, '#') else { - return Ok(None); - }; - let line = Self::lex_whitespace(line); +/// Lexes in-line `noqa` comment, e.g. `# noqa: F401` +fn lex_inline_noqa( + comment_range: TextRange, + source: &str, +) -> Result<Option<NoqaLexerOutput<'_>>, LexicalError> { + let lexer = NoqaLexer::in_range(comment_range, source); + lexer.lex_inline_noqa() +} - let Some(line) = Self::lex_flake8(line).or_else(|| Self::lex_ruff(line)) else { - return Ok(None); - }; +/// Lexes file-level exemption comment, e.g. `# ruff: noqa: F401` +fn lex_file_exemption( + comment_range: TextRange, + source: &str, +) -> Result<Option<NoqaLexerOutput<'_>>, LexicalError> { + let lexer = NoqaLexer::in_range(comment_range, source); + lexer.lex_file_exemption() +} - let line = Self::lex_whitespace(line); - let Some(line) = Self::lex_char(line, ':') else { - return Ok(None); - }; - let line = Self::lex_whitespace(line); - let Some(line) = Self::lex_noqa(line) else { - return Ok(None); - }; - let line = Self::lex_whitespace(line); +pub(crate) fn lex_codes(text: &str) -> Result<Vec<Code<'_>>, LexicalError> { + let mut lexer = NoqaLexer::in_range(TextRange::new(TextSize::new(0), text.text_len()), text); + lexer.lex_codes()?; + Ok(lexer.codes) +} - Ok(Some(if line.is_empty() { - // Ex) `# ruff: noqa` - Self::All - } else { - // Ex) `# ruff: noqa: F401, F841` - let Some(line) = Self::lex_char(line, ':') else { - return Err(ParseError::InvalidSuffix); - }; - let line = Self::lex_whitespace(line); - - // Extract the codes from the line (e.g., `F401, F841`). - let mut codes = vec![]; - let mut line = line; - while let Some(code) = Self::lex_code(line) { - codes.push(code); - line = &line[code.len()..]; - - // Codes can be comma- or whitespace-delimited. - if let Some(rest) = Self::lex_delimiter(line).map(Self::lex_whitespace) { - line = rest; - } else { - break; - } +/// Lexer for `noqa` comment lines. +/// +/// Assumed to be initialized with range or offset starting +/// at the `#` at the beginning of a `noqa` comment. +#[derive(Debug)] +struct NoqaLexer<'a> { + /// Length between offset and end of comment range + line_length: TextSize, + /// Contains convenience methods for lexing + cursor: Cursor<'a>, + /// Byte offset of the start of putative `noqa` comment + /// + /// Note: This is updated in the course of lexing in the case + /// where there are multiple comments in a comment range. + /// Ex) `# comment # noqa: F401` + /// start^ ^-- changed to here during lexing + offset: TextSize, + /// Non-fatal warnings collected during lexing + warnings: Vec<LexicalWarning>, + /// Tracks whether we are lexing in a context with a missing delimiter + /// e.g. at `C` in `F401C402`. + missing_delimiter: bool, + /// Rule codes collected during lexing + codes: Vec<Code<'a>>, +} + +impl<'a> NoqaLexer<'a> { + /// Initialize [`NoqaLexer`] in the given range of source text. + fn in_range(range: TextRange, source: &'a str) -> Self { + Self { + line_length: range.len(), + offset: range.start(), + cursor: Cursor::new(&source[range]), + warnings: Vec::new(), + missing_delimiter: false, + codes: Vec::new(), + } + } + + fn lex_inline_noqa(mut self) -> Result<Option<NoqaLexerOutput<'a>>, LexicalError> { + while !self.cursor.is_eof() { + // Skip over any leading content. + self.cursor.eat_while(|c| c != '#'); + + // This updates the offset and line length in the case of + // multiple comments in a range, e.g. + // `# First # Second # noqa` + self.offset += self.cursor.token_len(); + self.line_length -= self.cursor.token_len(); + self.cursor.start_token(); + + if !self.cursor.eat_char('#') { + continue; } - // If we didn't identify any codes, warn. - if codes.is_empty() { - return Err(ParseError::MissingCodes); + self.eat_whitespace(); + + if !is_noqa_uncased(self.cursor.as_str()) { + continue; } - Self::Codes(codes) - })) + self.cursor.skip_bytes("noqa".len()); + + return Ok(Some(self.lex_directive()?)); + } + + Ok(None) } - /// Lex optional leading whitespace. - #[inline] - fn lex_whitespace(line: &str) -> &str { - line.trim_start() + fn lex_file_exemption(mut self) -> Result<Option<NoqaLexerOutput<'a>>, LexicalError> { + while !self.cursor.is_eof() { + // Skip over any leading content + self.cursor.eat_while(|c| c != '#'); + + // This updates the offset and line length in the case of + // multiple comments in a range, e.g. + // # First # Second # noqa + self.offset += self.cursor.token_len(); + self.line_length -= self.cursor.token_len(); + self.cursor.start_token(); + + // The remaining logic implements a simple regex + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^ + if !self.cursor.eat_char('#') { + continue; + } + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^^^ + self.eat_whitespace(); + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^^^^^^^^^^^^^ + if self.cursor.as_str().starts_with("ruff") { + self.cursor.skip_bytes("ruff".len()); + } else if self.cursor.as_str().starts_with("flake8") { + self.cursor.skip_bytes("flake8".len()); + } else { + continue; + } + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^^^ + self.eat_whitespace(); + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^ + if !self.cursor.eat_char(':') { + continue; + } + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^^^ + self.eat_whitespace(); + + // `#\s*(?:ruff|flake8)\s*:\s*(?i)noqa` + // ^^^^^^^ + if !is_noqa_uncased(self.cursor.as_str()) { + continue; + } + self.cursor.skip_bytes("noqa".len()); + + return Ok(Some(self.lex_directive()?)); + } + Ok(None) } - /// Lex a specific character, or return `None` if the character is not the first character in - /// the line. - #[inline] - fn lex_char(line: &str, c: char) -> Option<&str> { - let mut chars = line.chars(); - if chars.next() == Some(c) { - Some(chars.as_str()) - } else { - None + /// Collect codes in `noqa` comment. + fn lex_directive(mut self) -> Result<NoqaLexerOutput<'a>, LexicalError> { + let range = TextRange::at(self.offset, self.position()); + + match self.cursor.bump() { + // End of comment + // Ex) # noqa# A comment + None | Some('#') => { + return Ok(NoqaLexerOutput { + warnings: self.warnings, + directive: Directive::All(All { range }), + }); + } + // Ex) # noqa: F401,F842 + Some(':') => self.lex_codes()?, + // Ex) # noqa A comment + // Ex) # noqa : F401 + Some(c) if c.is_whitespace() => { + self.eat_whitespace(); + match self.cursor.bump() { + Some(':') => self.lex_codes()?, + _ => { + return Ok(NoqaLexerOutput { + warnings: self.warnings, + directive: Directive::All(All { range }), + }); + } + } + } + // Ex) #noqaA comment + // Ex) #noqaF401 + _ => { + return Err(LexicalError::InvalidSuffix); + } } + + let Some(last) = self.codes.last() else { + return Err(LexicalError::MissingCodes); + }; + + Ok(NoqaLexerOutput { + warnings: self.warnings, + directive: Directive::Codes(Codes { + range: TextRange::new(self.offset, last.range.end()), + codes: self.codes, + }), + }) } - /// Lex the "flake8" prefix of a `noqa` directive. - #[inline] - fn lex_flake8(line: &str) -> Option<&str> { - line.strip_prefix("flake8") + fn lex_codes(&mut self) -> Result<(), LexicalError> { + // SAFETY: Every call to `lex_code` advances the cursor at least once. + while !self.cursor.is_eof() { + self.lex_code()?; + } + Ok(()) + } + + fn lex_code(&mut self) -> Result<(), LexicalError> { + self.cursor.start_token(); + self.eat_whitespace(); + + // Ex) # noqa: F401, ,F841 + // ^^^^ + if self.cursor.first() == ',' { + self.warnings.push(LexicalWarning::MissingItem( + self.token_range().add(self.offset), + )); + self.cursor.eat_char(','); + return Ok(()); + } + + let before_code = self.cursor.as_str(); + // Reset start of token so it does not include whitespace + self.cursor.start_token(); + match self.cursor.bump() { + // Ex) # noqa: F401 + // ^ + Some(c) if c.is_ascii_uppercase() => { + self.cursor.eat_while(|chr| chr.is_ascii_uppercase()); + if !self.cursor.eat_if(|c| c.is_ascii_digit()) { + // Fail hard if we're already attempting + // to lex squashed codes, e.g. `F401Fabc` + if self.missing_delimiter { + return Err(LexicalError::InvalidCodeSuffix); + } + // Otherwise we've reached the first invalid code, + // so it could be a comment and we just stop parsing. + // Ex) #noqa: F401 A comment + // we're here^ + self.cursor.skip_bytes(self.cursor.as_str().len()); + return Ok(()); + } + self.cursor.eat_while(|chr| chr.is_ascii_digit()); + + let code = &before_code[..self.cursor.token_len().to_usize()]; + + self.push_code(code); + + if self.cursor.is_eof() { + return Ok(()); + } + + self.missing_delimiter = match self.cursor.first() { + ',' => { + self.cursor.eat_char(','); + false + } + + // Whitespace is an allowed delimiter or the end of the `noqa`. + c if c.is_whitespace() => false, + + // e.g. #noqa:F401F842 + // ^ + // Push a warning and update the `missing_delimiter` + // state but don't consume the character since it's + // part of the next code. + c if c.is_ascii_uppercase() => { + self.warnings + .push(LexicalWarning::MissingDelimiter(TextRange::empty( + self.offset + self.position(), + ))); + true + } + // Start of a new comment + // e.g. #noqa: F401#A comment + // ^ + '#' => false, + _ => return Err(LexicalError::InvalidCodeSuffix), + }; + } + Some(_) => { + // The first time we hit an evidently invalid code, + // it's probably a trailing comment. So stop lexing, + // but don't push an error. + // Ex) + // # noqa: F401 we import this for a reason + // ^----- stop lexing but no error + self.cursor.skip_bytes(self.cursor.as_str().len()); + } + None => {} + } + Ok(()) + } + + /// Push current token to stack of [`Code`] objects + fn push_code(&mut self, code: &'a str) { + self.codes.push(Code { + code, + range: self.token_range().add(self.offset), + }); } - /// Lex the "ruff" prefix of a `noqa` directive. + /// Consume whitespace #[inline] - fn lex_ruff(line: &str) -> Option<&str> { - line.strip_prefix("ruff") + fn eat_whitespace(&mut self) { + self.cursor.eat_while(char::is_whitespace); } - /// Lex a `noqa` directive with case-insensitive matching. + /// Current token range relative to offset #[inline] - fn lex_noqa(line: &str) -> Option<&str> { - match line.as_bytes() { - [b'n' | b'N', b'o' | b'O', b'q' | b'Q', b'a' | b'A', ..] => Some(&line["noqa".len()..]), - _ => None, - } + fn token_range(&self) -> TextRange { + let end = self.position(); + let len = self.cursor.token_len(); + + TextRange::at(end - len, len) } - /// Lex a code delimiter, which can either be a comma or whitespace. + /// Retrieves the current position of the cursor within the line. #[inline] - fn lex_delimiter(line: &str) -> Option<&str> { - let mut chars = line.chars(); - if let Some(c) = chars.next() { - if c == ',' || c.is_whitespace() { - Some(chars.as_str()) - } else { - None + fn position(&self) -> TextSize { + self.line_length - self.cursor.text_len() + } +} + +/// Helper to check if "noqa" (case-insensitive) appears at the given position +#[inline] +fn is_noqa_uncased(text: &str) -> bool { + matches!( + text.as_bytes(), + [b'n' | b'N', b'o' | b'O', b'q' | b'Q', b'a' | b'A', ..] + ) +} + +/// Indicates recoverable error encountered while lexing with [`NoqaLexer`] +#[derive(Debug, Clone, Copy)] +enum LexicalWarning { + MissingItem(TextRange), + MissingDelimiter(TextRange), +} + +impl Display for LexicalWarning { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::MissingItem(_) => f.write_str("expected rule code between commas"), + Self::MissingDelimiter(_) => { + f.write_str("expected comma or space delimiter between codes") } - } else { - None } } +} - /// Lex an individual rule code (e.g., `F401`). - #[inline] - fn lex_code(line: &str) -> Option<&str> { - // Extract, e.g., the `F` in `F401`. - let prefix = line.chars().take_while(char::is_ascii_uppercase).count(); - // Extract, e.g., the `401` in `F401`. - let suffix = line[prefix..] - .chars() - .take_while(char::is_ascii_digit) - .count(); - if prefix > 0 && suffix > 0 { - Some(&line[..prefix + suffix]) - } else { - None +impl Ranged for LexicalWarning { + fn range(&self) -> TextRange { + match *self { + LexicalWarning::MissingItem(text_range) => text_range, + LexicalWarning::MissingDelimiter(text_range) => text_range, } } } -/// The result of an [`Importer::get_or_import_symbol`] call. +/// Fatal error occurring while lexing a `noqa` comment as in [`NoqaLexer`] #[derive(Debug)] -pub(crate) enum ParseError { +pub(crate) enum LexicalError { /// The `noqa` directive was missing valid codes (e.g., `# noqa: unused-import` instead of `# noqa: F401`). MissingCodes, /// The `noqa` directive used an invalid suffix (e.g., `# noqa; F401` instead of `# noqa: F401`). InvalidSuffix, + /// The `noqa` code matched the regex "[A-Z]+[0-9]+" with text remaining + /// (e.g. `# noqa: F401abc`) + InvalidCodeSuffix, } -impl Display for ParseError { +impl Display for LexicalError { fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { - ParseError::MissingCodes => fmt.write_str("expected a comma-separated list of codes (e.g., `# noqa: F401, F841`)."), - ParseError::InvalidSuffix => { + LexicalError::MissingCodes => fmt.write_str("expected a comma-separated list of codes (e.g., `# noqa: F401, F841`)."), + LexicalError::InvalidSuffix => { fmt.write_str("expected `:` followed by a comma-separated list of codes (e.g., `# noqa: F401, F841`).") } + LexicalError::InvalidCodeSuffix => { + fmt.write_str("expected code to consist of uppercase letters followed by digits only (e.g. `F401`)") + } } } } -impl Error for ParseError {} +impl Error for LexicalError {} -/// Adds noqa comments to suppress all diagnostics of a file. +/// Adds noqa comments to suppress all messages of a file. pub(crate) fn add_noqa( path: &Path, - diagnostics: &[Diagnostic], + messages: &[Message], locator: &Locator, comment_ranges: &CommentRanges, external: &[String], @@ -594,7 +715,7 @@ pub(crate) fn add_noqa( ) -> Result<usize> { let (count, output) = add_noqa_inner( path, - diagnostics, + messages, locator, comment_ranges, external, @@ -608,7 +729,7 @@ pub(crate) fn add_noqa( fn add_noqa_inner( path: &Path, - diagnostics: &[Diagnostic], + messages: &[Message], locator: &Locator, comment_ranges: &CommentRanges, external: &[String], @@ -621,9 +742,9 @@ fn add_noqa_inner( let directives = FileNoqaDirectives::extract(locator, comment_ranges, external, path); let exemption = FileExemption::from(&directives); - let directives = NoqaDirectives::from_commented_ranges(comment_ranges, path, locator); + let directives = NoqaDirectives::from_commented_ranges(comment_ranges, external, path, locator); - let comments = find_noqa_comments(diagnostics, locator, &exemption, &directives, noqa_line_for); + let comments = find_noqa_comments(messages, locator, &exemption, &directives, noqa_line_for); let edits = build_noqa_edits_by_line(comments, locator, line_ending); @@ -659,7 +780,7 @@ fn build_noqa_edits_by_diagnostic( if let Some(noqa_edit) = generate_noqa_edit( comment.directive, comment.line, - RuleSet::from_rule(comment.diagnostic.kind.rule()), + RuleSet::from_rule(comment.rule), locator, line_ending, ) { @@ -695,7 +816,7 @@ fn build_noqa_edits_by_line<'a>( offset, matches .into_iter() - .map(|NoqaComment { diagnostic, .. }| diagnostic.kind.rule()) + .map(|NoqaComment { rule, .. }| rule) .collect(), locator, line_ending, @@ -708,22 +829,29 @@ fn build_noqa_edits_by_line<'a>( struct NoqaComment<'a> { line: TextSize, - diagnostic: &'a Diagnostic, + rule: Rule, directive: Option<&'a Directive<'a>>, } fn find_noqa_comments<'a>( - diagnostics: &'a [Diagnostic], + messages: &'a [Message], locator: &'a Locator, exemption: &'a FileExemption, directives: &'a NoqaDirectives, noqa_line_for: &NoqaMapping, ) -> Vec<Option<NoqaComment<'a>>> { - // List of noqa comments, ordered to match up with `diagnostics` + // List of noqa comments, ordered to match up with `messages` let mut comments_by_line: Vec<Option<NoqaComment<'a>>> = vec![]; // Mark any non-ignored diagnostics. - for diagnostic in diagnostics { + for message in messages { + let Some(rule) = message.to_rule() else { + comments_by_line.push(None); + continue; + }; + + let code = rule.noqa_code(); + match &exemption { FileExemption::All(_) => { // If the file is exempted, don't add any noqa directives. @@ -732,7 +860,7 @@ fn find_noqa_comments<'a>( } FileExemption::Codes(codes) => { // If the diagnostic is ignored by a global exemption, don't add a noqa directive. - if codes.contains(&&diagnostic.kind.rule().noqa_code()) { + if codes.contains(&&code) { comments_by_line.push(None); continue; } @@ -740,7 +868,7 @@ fn find_noqa_comments<'a>( } // Is the violation ignored by a `noqa` directive on the parent line? - if let Some(parent) = diagnostic.parent { + if let Some(parent) = message.parent { if let Some(directive_line) = directives.find_line_with_directive(noqa_line_for.resolve(parent)) { @@ -750,7 +878,7 @@ fn find_noqa_comments<'a>( continue; } Directive::Codes(codes) => { - if codes.includes(diagnostic.kind.rule()) { + if codes.includes(code) { comments_by_line.push(None); continue; } @@ -759,7 +887,7 @@ fn find_noqa_comments<'a>( } } - let noqa_offset = noqa_line_for.resolve(diagnostic.start()); + let noqa_offset = noqa_line_for.resolve(message.range().start()); // Or ignored by the directive itself? if let Some(directive_line) = directives.find_line_with_directive(noqa_offset) { @@ -769,11 +897,10 @@ fn find_noqa_comments<'a>( continue; } directive @ Directive::Codes(codes) => { - let rule = diagnostic.kind.rule(); - if !codes.includes(rule) { + if !codes.includes(code) { comments_by_line.push(Some(NoqaComment { line: directive_line.start(), - diagnostic, + rule, directive: Some(directive), })); } @@ -785,7 +912,7 @@ fn find_noqa_comments<'a>( // There's no existing noqa directive that suppresses the diagnostic. comments_by_line.push(Some(NoqaComment { line: locator.line_start(noqa_offset), - diagnostic, + rule, directive: None, })); } @@ -800,7 +927,7 @@ struct NoqaEdit<'a> { line_ending: LineEnding, } -impl<'a> NoqaEdit<'a> { +impl NoqaEdit<'_> { fn into_edit(self) -> Edit { let mut edit_content = String::new(); self.write(&mut edit_content); @@ -832,7 +959,7 @@ impl<'a> NoqaEdit<'a> { } } -impl<'a> Ranged for NoqaEdit<'a> { +impl Ranged for NoqaEdit<'_> { fn range(&self) -> TextRange { self.edit_range } @@ -866,7 +993,7 @@ fn generate_noqa_edit<'a>( codes = Some(existing_codes); } Some(Directive::All(_)) => return None, - }; + } Some(NoqaEdit { edit_range, @@ -895,7 +1022,7 @@ pub(crate) struct NoqaDirectiveLine<'a> { pub(crate) directive: Directive<'a>, /// The codes that are ignored by the directive. pub(crate) matches: Vec<NoqaCode>, - // Whether the directive applies to range.end + /// Whether the directive applies to `range.end`. pub(crate) includes_end: bool, } @@ -914,20 +1041,53 @@ pub(crate) struct NoqaDirectives<'a> { impl<'a> NoqaDirectives<'a> { pub(crate) fn from_commented_ranges( comment_ranges: &CommentRanges, + external: &[String], path: &Path, locator: &'a Locator<'a>, ) -> Self { let mut directives = Vec::new(); for range in comment_ranges { - match Directive::try_extract(locator.slice(range), range.start()) { - Err(err) => { - #[allow(deprecated)] - let line = locator.compute_line_index(range.start()); - let path_display = relativize_path(path); - warn!("Invalid `# noqa` directive on {path_display}:{line}: {err}"); - } - Ok(Some(directive)) => { + let lexed = lex_inline_noqa(range, locator.contents()); + + match lexed { + Ok(Some(NoqaLexerOutput { + warnings, + directive, + })) => { + if !warnings.is_empty() { + #[expect(deprecated)] + let line = locator.compute_line_index(range.start()); + let path_display = relativize_path(path); + for warning in warnings { + warn!( + "Missing or joined rule code(s) at {path_display}:{line}: {warning}" + ); + } + } + if let Directive::Codes(codes) = &directive { + // Warn on invalid rule codes. + for code in &codes.codes { + // Ignore externally-defined rules. + if !external + .iter() + .any(|external| code.as_str().starts_with(external)) + { + if Rule::from_code( + get_redirect_target(code.as_str()).unwrap_or(code.as_str()), + ) + .is_err() + { + #[expect(deprecated)] + let line = locator.compute_line_index(range.start()); + let path_display = relativize_path(path); + warn!( + "Invalid rule code provided to `# noqa` at {path_display}:{line}: {code}" + ); + } + } + } + } // noqa comments are guaranteed to be single line. let range = locator.line_range(range.start()); directives.push(NoqaDirectiveLine { @@ -937,6 +1097,12 @@ impl<'a> NoqaDirectives<'a> { includes_end: range.end() == locator.contents().text_len(), }); } + Err(err) => { + #[expect(deprecated)] + let line = locator.compute_line_index(range.start()); + let path_display = relativize_path(path); + warn!("Invalid `# noqa` directive on {path_display}:{line}: {err}"); + } Ok(None) => {} } } @@ -1050,200 +1216,1612 @@ impl FromIterator<TextRange> for NoqaMapping { #[cfg(test)] mod tests { + use std::path::Path; use insta::assert_debug_snapshot; use ruff_diagnostics::{Diagnostic, Edit}; use ruff_python_trivia::CommentRanges; - use ruff_source_file::LineEnding; - use ruff_text_size::{TextRange, TextSize}; + use ruff_source_file::{LineEnding, SourceFileBuilder}; + use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; - use crate::noqa::{add_noqa_inner, Directive, NoqaMapping, ParsedFileExemption}; + use crate::message::Message; + use crate::noqa::{ + Directive, LexicalError, NoqaLexerOutput, NoqaMapping, add_noqa_inner, lex_codes, + lex_file_exemption, lex_inline_noqa, + }; use crate::rules::pycodestyle::rules::{AmbiguousVariableName, UselessSemicolon}; use crate::rules::pyflakes::rules::UnusedVariable; use crate::rules::pyupgrade::rules::PrintfStringFormatting; - use crate::{generate_noqa_edits, Locator}; + use crate::{Locator, generate_noqa_edits}; + + fn assert_lexed_ranges_match_slices( + directive: Result<Option<NoqaLexerOutput>, LexicalError>, + source: &str, + ) { + if let Ok(Some(NoqaLexerOutput { + warnings: _, + directive: Directive::Codes(codes), + })) = directive + { + for code in codes.iter() { + assert_eq!(&source[code.range], code.code); + } + } + } + + /// Create a [`Message`] with a placeholder filename and rule code from `diagnostic`. + fn message_from_diagnostic( + diagnostic: Diagnostic, + path: impl AsRef<Path>, + source: &str, + ) -> Message { + let noqa_offset = diagnostic.start(); + let file = SourceFileBuilder::new(path.as_ref().to_string_lossy(), source).finish(); + Message::from_diagnostic(diagnostic, file, Some(noqa_offset)) + } + + #[test] + fn noqa_lex_codes() { + let source = " F401,,F402F403 # and so on"; + assert_debug_snapshot!(lex_codes(source), @r#" + Ok( + [ + Code { + code: "F401", + range: 1..5, + }, + Code { + code: "F402", + range: 7..11, + }, + Code { + code: "F403", + range: 11..15, + }, + ], + ) + "#); + } #[test] fn noqa_all() { let source = "# noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..6, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_no_code() { + let source = "# noqa:"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_no_code_invalid_suffix() { + let source = "# noqa: foo"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_no_code_trailing_content() { + let source = "# noqa: # Foo"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn malformed_code_1() { + let source = "# noqa: F"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn malformed_code_2() { + let source = "# noqa: RUF001, F"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..14, + codes: [ + Code { + code: "RUF001", + range: 8..14, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn malformed_code_3() { + let source = "# noqa: RUF001F"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + InvalidCodeSuffix, + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code() { let source = "# noqa: F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..12, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes() { let source = "# noqa: F401, F841"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_all_case_insensitive() { let source = "# NOQA"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..6, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code_case_insensitive() { let source = "# NOQA: F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..12, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes_case_insensitive() { let source = "# NOQA: F401, F841"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_leading_space() { let source = "# # noqa: F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 4..16, + codes: [ + Code { + code: "F401", + range: 12..16, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_trailing_space() { let source = "# noqa: F401 #"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..12, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_all_no_space() { let source = "#noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..5, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code_no_space() { let source = "#noqa:F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..10, + codes: [ + Code { + code: "F401", + range: 6..10, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes_no_space() { let source = "#noqa:F401,F841"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..15, + codes: [ + Code { + code: "F401", + range: 6..10, + }, + Code { + code: "F841", + range: 11..15, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_all_multi_space() { let source = "# noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..7, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code_multi_space() { let source = "# noqa: F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..13, + codes: [ + Code { + code: "F401", + range: 9..13, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes_multi_space() { let source = "# noqa: F401, F841"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..20, + codes: [ + Code { + code: "F401", + range: 9..13, + }, + Code { + code: "F841", + range: 16..20, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_code_leading_hashes() { + let source = "###noqa: F401"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 2..13, + codes: [ + Code { + code: "F401", + range: 9..13, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_code_leading_hashes_with_spaces() { + let source = "# # # noqa: F401"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 6..18, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_all_leading_comment() { let source = "# Some comment describing the noqa # noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 35..41, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code_leading_comment() { let source = "# Some comment describing the noqa # noqa: F401"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 35..47, + codes: [ + Code { + code: "F401", + range: 43..47, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes_leading_comment() { let source = "# Some comment describing the noqa # noqa: F401, F841"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 35..53, + codes: [ + Code { + code: "F401", + range: 43..47, + }, + Code { + code: "F841", + range: 49..53, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_all_trailing_comment() { let source = "# noqa # Some comment describing the noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..6, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_code_trailing_comment() { let source = "# noqa: F401 # Some comment describing the noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..12, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_codes_trailing_comment() { let source = "# noqa: F401, F841 # Some comment describing the noqa"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_invalid_codes() { let source = "# noqa: unused-import, F401, some other code"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_squashed_codes() { + let source = "# noqa: F401F841"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingDelimiter( + 12..12, + ), + ], + directive: Codes( + Codes { + range: 0..16, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 12..16, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_empty_comma() { + let source = "# noqa: F401,,F841"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingItem( + 13..13, + ), + ], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_empty_comma_space() { + let source = "# noqa: F401, ,F841"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingItem( + 13..14, + ), + ], + directive: Codes( + Codes { + range: 0..19, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + Code { + code: "F841", + range: 15..19, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_non_code() { + let source = "# noqa: F401 We're ignoring an import"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..12, + codes: [ + Code { + code: "F401", + range: 8..12, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn noqa_code_invalid_code_suffix() { + let source = "# noqa: F401abc"; + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + InvalidCodeSuffix, + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn noqa_invalid_suffix() { let source = "# noqa[F401]"; - assert_debug_snapshot!(Directive::try_extract(source, TextSize::default())); + let directive = lex_inline_noqa(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + InvalidSuffix, + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn flake8_exemption_all() { let source = "# flake8: noqa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..14, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn flake8_noqa_no_code() { + let source = "# flake8: noqa:"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn flake8_noqa_no_code_invalid_suffix() { + let source = "# flake8: noqa: foo"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn flake8_noqa_no_code_trailing_content() { + let source = "# flake8: noqa: # Foo"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn flake8_malformed_code_1() { + let source = "# flake8: noqa: F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn flake8_malformed_code_2() { + let source = "# flake8: noqa: RUF001, F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..22, + codes: [ + Code { + code: "RUF001", + range: 16..22, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn flake8_malformed_code_3() { + let source = "# flake8: noqa: RUF001F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + InvalidCodeSuffix, + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn ruff_exemption_all() { let source = "# ruff: noqa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_noqa_no_code() { + let source = "# ruff: noqa:"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_noqa_no_code_invalid_suffix() { + let source = "# ruff: noqa: foo"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_noqa_no_code_trailing_content() { + let source = "# ruff: noqa: # Foo"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_malformed_code_1() { + let source = "# ruff: noqa: F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + MissingCodes, + ) + "); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn ruff_malformed_code_2() { + let source = "# ruff: noqa: RUF001, F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..20, + codes: [ + Code { + code: "RUF001", + range: 14..20, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(directive, source); + } + + #[test] + fn ruff_malformed_code_3() { + let source = "# ruff: noqa: RUF001F"; + let directive = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(directive, @r" + Err( + InvalidCodeSuffix, + ) + "); + assert_lexed_ranges_match_slices(directive, source); } #[test] fn flake8_exemption_all_no_space() { let source = "#flake8:noqa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); } #[test] fn ruff_exemption_all_no_space() { let source = "#ruff:noqa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..10, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); } #[test] fn flake8_exemption_codes() { // Note: Flake8 doesn't support this; it's treated as a blanket exemption. let source = "# flake8: noqa: F401, F841"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..26, + codes: [ + Code { + code: "F401", + range: 16..20, + }, + Code { + code: "F841", + range: 22..26, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); } #[test] fn ruff_exemption_codes() { let source = "# ruff: noqa: F401, F841"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..24, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + Code { + code: "F841", + range: 20..24, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + #[test] + fn ruff_exemption_codes_leading_hashes() { + let source = "#### ruff: noqa: F401, F841"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 3..27, + codes: [ + Code { + code: "F401", + range: 17..21, + }, + Code { + code: "F841", + range: 23..27, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_squashed_codes() { + let source = "# ruff: noqa: F401F841"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingDelimiter( + 18..18, + ), + ], + directive: Codes( + Codes { + range: 0..22, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + Code { + code: "F841", + range: 18..22, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_empty_comma() { + let source = "# ruff: noqa: F401,,F841"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingItem( + 19..19, + ), + ], + directive: Codes( + Codes { + range: 0..24, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + Code { + code: "F841", + range: 20..24, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_empty_comma_space() { + let source = "# ruff: noqa: F401, ,F841"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [ + MissingItem( + 19..20, + ), + ], + directive: Codes( + Codes { + range: 0..25, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + Code { + code: "F841", + range: 21..25, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_invalid_code_suffix() { + let source = "# ruff: noqa: F401abc"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Err( + InvalidCodeSuffix, + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_code_leading_comment() { + let source = "# Leading comment # ruff: noqa: F401"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 18..36, + codes: [ + Code { + code: "F401", + range: 32..36, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_code_trailing_comment() { + let source = "# ruff: noqa: F401 # Trailing comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_all_leading_comment() { + let source = "# Leading comment # ruff: noqa"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 18..30, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_all_trailing_comment() { + let source = "# ruff: noqa # Trailing comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_code_trailing_comment_no_space() { + let source = "# ruff: noqa: F401# And another comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_all_trailing_comment_no_space() { + let source = "# ruff: noqa# Trailing comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_all_trailing_comment_no_hash() { + let source = "# ruff: noqa Trailing comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); + } + + #[test] + fn ruff_exemption_code_trailing_comment_no_hash() { + let source = "# ruff: noqa: F401 Trailing comment"; + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r#" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: Codes( + Codes { + range: 0..18, + codes: [ + Code { + code: "F401", + range: 14..18, + }, + ], + }, + ), + }, + ), + ) + "#); + assert_lexed_ranges_match_slices(exemption, source); } #[test] fn flake8_exemption_all_case_insensitive() { let source = "# flake8: NoQa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..14, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); } #[test] fn ruff_exemption_all_case_insensitive() { let source = "# ruff: NoQa"; - assert_debug_snapshot!(ParsedFileExemption::try_extract(source)); + let exemption = lex_file_exemption(TextRange::up_to(source.text_len()), source); + assert_debug_snapshot!(exemption, @r" + Ok( + Some( + NoqaLexerOutput { + warnings: [], + directive: All( + All { + range: 0..12, + }, + ), + }, + ), + ) + "); + assert_lexed_ranges_match_slices(exemption, source); } #[test] @@ -1264,18 +2842,19 @@ mod tests { assert_eq!(count, 0); assert_eq!(output, format!("{contents}")); - let diagnostics = [Diagnostic::new( + let messages = [Diagnostic::new( UnusedVariable { name: "x".to_string(), }, TextRange::new(TextSize::from(0), TextSize::from(0)), - )]; + )] + .map(|d| message_from_diagnostic(d, path, contents)); let contents = "x = 1"; let noqa_line_for = NoqaMapping::default(); let (count, output) = add_noqa_inner( path, - &diagnostics, + &messages, &Locator::new(contents), &CommentRanges::default(), &[], @@ -1285,7 +2864,7 @@ mod tests { assert_eq!(count, 1); assert_eq!(output, "x = 1 # noqa: F841\n"); - let diagnostics = [ + let messages = [ Diagnostic::new( AmbiguousVariableName("x".to_string()), TextRange::new(TextSize::from(0), TextSize::from(0)), @@ -1296,14 +2875,15 @@ mod tests { }, TextRange::new(TextSize::from(0), TextSize::from(0)), ), - ]; + ] + .map(|d| message_from_diagnostic(d, path, contents)); let contents = "x = 1 # noqa: E741\n"; let noqa_line_for = NoqaMapping::default(); let comment_ranges = CommentRanges::new(vec![TextRange::new(TextSize::from(7), TextSize::from(19))]); let (count, output) = add_noqa_inner( path, - &diagnostics, + &messages, &Locator::new(contents), &comment_ranges, &[], @@ -1313,7 +2893,7 @@ mod tests { assert_eq!(count, 1); assert_eq!(output, "x = 1 # noqa: E741, F841\n"); - let diagnostics = [ + let messages = [ Diagnostic::new( AmbiguousVariableName("x".to_string()), TextRange::new(TextSize::from(0), TextSize::from(0)), @@ -1324,14 +2904,15 @@ mod tests { }, TextRange::new(TextSize::from(0), TextSize::from(0)), ), - ]; + ] + .map(|d| message_from_diagnostic(d, path, contents)); let contents = "x = 1 # noqa"; let noqa_line_for = NoqaMapping::default(); let comment_ranges = CommentRanges::new(vec![TextRange::new(TextSize::from(7), TextSize::from(13))]); let (count, output) = add_noqa_inner( path, - &diagnostics, + &messages, &Locator::new(contents), &comment_ranges, &[], @@ -1355,14 +2936,15 @@ print( ) "#; let noqa_line_for = [TextRange::new(8.into(), 68.into())].into_iter().collect(); - let diagnostics = [Diagnostic::new( + let messages = [Diagnostic::new( PrintfStringFormatting, TextRange::new(12.into(), 79.into()), - )]; + )] + .map(|d| message_from_diagnostic(d, path, source)); let comment_ranges = CommentRanges::default(); let edits = generate_noqa_edits( path, - &diagnostics, + &messages, &Locator::new(source), &comment_ranges, &[], @@ -1386,15 +2968,16 @@ print( foo; bar = "; - let diagnostics = [Diagnostic::new( + let messages = [Diagnostic::new( UselessSemicolon, TextRange::new(4.into(), 5.into()), - )]; + )] + .map(|d| message_from_diagnostic(d, path, source)); let noqa_line_for = NoqaMapping::default(); let comment_ranges = CommentRanges::default(); let edits = generate_noqa_edits( path, - &diagnostics, + &messages, &Locator::new(source), &comment_ranges, &[], diff --git a/crates/ruff_linter/src/package.rs b/crates/ruff_linter/src/package.rs new file mode 100644 index 0000000000000..dd11f17b121ef --- /dev/null +++ b/crates/ruff_linter/src/package.rs @@ -0,0 +1,40 @@ +use std::path::Path; + +/// The root directory of a Python package. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum PackageRoot<'a> { + /// A normal package root. + Root { path: &'a Path }, + /// A nested package root. That is, a package root that's a subdirectory (direct or indirect) of + /// another Python package root. + /// + /// For example, `foo/bar/baz` in: + /// ```text + /// foo/ + /// ├── __init__.py + /// └── bar/ + /// └── baz/ + /// └── __init__.py + /// ``` + Nested { path: &'a Path }, +} + +impl<'a> PackageRoot<'a> { + /// Create a [`PackageRoot::Root`] variant. + pub fn root(path: &'a Path) -> Self { + Self::Root { path } + } + + /// Create a [`PackageRoot::Nested`] variant. + pub fn nested(path: &'a Path) -> Self { + Self::Nested { path } + } + + /// Return the [`Path`] of the package root. + pub fn path(self) -> &'a Path { + match self { + Self::Root { path } => path, + Self::Nested { path } => path, + } + } +} diff --git a/crates/ruff_linter/src/preview.rs b/crates/ruff_linter/src/preview.rs new file mode 100644 index 0000000000000..50b4fac603c04 --- /dev/null +++ b/crates/ruff_linter/src/preview.rs @@ -0,0 +1,136 @@ +//! Helpers to test if a specific preview style is enabled or not. +//! +//! The motivation for these functions isn't to avoid code duplication but to ease promoting preview behavior +//! to stable. The challenge with directly checking the `preview` attribute of [`LinterSettings`] is that it is unclear +//! which specific feature this preview check is for. Having named functions simplifies the promotion: +//! Simply delete the function and let Rust tell you which checks you have to remove. + +use crate::settings::LinterSettings; + +// https://github.com/astral-sh/ruff/issues/17412 +// https://github.com/astral-sh/ruff/issues/11934 +pub(crate) const fn is_semantic_errors_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/16429 +pub(crate) const fn is_unsupported_syntax_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +pub(crate) const fn is_py314_support_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/16565 +pub(crate) const fn is_full_path_match_source_strategy_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// Rule-specific behavior + +// https://github.com/astral-sh/ruff/pull/17136 +pub(crate) const fn is_shell_injection_only_trusted_input_enabled( + settings: &LinterSettings, +) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/15541 +pub(crate) const fn is_suspicious_function_reference_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/7501 +pub(crate) const fn is_bool_subtype_of_annotation_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/10759 +pub(crate) const fn is_comprehension_with_min_max_sum_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/12657 +pub(crate) const fn is_check_comprehensions_in_tuple_call_enabled( + settings: &LinterSettings, +) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/issues/15347 +pub(crate) const fn is_bad_version_info_in_non_stub_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/12676 +pub(crate) const fn is_fix_future_annotations_in_stub_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/11074 +pub(crate) const fn is_only_add_return_none_at_end_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/12796 +pub(crate) const fn is_simplify_ternary_to_binary_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/16719 +pub(crate) const fn is_fix_manual_dict_comprehension_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/13919 +pub(crate) const fn is_fix_manual_list_comprehension_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/11436 +// https://github.com/astral-sh/ruff/pull/11168 +pub(crate) const fn is_dunder_init_fix_unused_import_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/15313 +pub(crate) const fn is_defer_optional_to_up045_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/8473 +pub(crate) const fn is_unicode_to_unicode_confusables_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/17078 +pub(crate) const fn is_support_slices_in_literal_concatenation_enabled( + settings: &LinterSettings, +) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/11370 +pub(crate) const fn is_undefined_export_in_dunder_init_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/14236 +pub(crate) const fn is_allow_nested_roots_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/17061 +pub(crate) const fn is_check_file_level_directives_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +// https://github.com/astral-sh/ruff/pull/17644 +pub(crate) const fn is_readlines_in_for_fix_safe_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} + +pub(crate) const fn multiple_with_statements_fix_safe_enabled(settings: &LinterSettings) -> bool { + settings.preview.is_enabled() +} diff --git a/crates/ruff_linter/src/pyproject_toml.rs b/crates/ruff_linter/src/pyproject_toml.rs index 88b0765c23d66..b59e1774b0011 100644 --- a/crates/ruff_linter/src/pyproject_toml.rs +++ b/crates/ruff_linter/src/pyproject_toml.rs @@ -6,11 +6,11 @@ use ruff_text_size::{TextRange, TextSize}; use ruff_diagnostics::Diagnostic; use ruff_source_file::SourceFile; +use crate::IOError; use crate::message::Message; use crate::registry::Rule; use crate::rules::ruff::rules::InvalidPyprojectToml; use crate::settings::LinterSettings; -use crate::IOError; pub fn lint_pyproject_toml(source_file: SourceFile, settings: &LinterSettings) -> Vec<Message> { let Some(err) = toml::from_str::<PyProjectToml>(source_file.source_text()).err() else { @@ -30,11 +30,7 @@ pub fn lint_pyproject_toml(source_file: SourceFile, settings: &LinterSettings) - ); if settings.rules.enabled(Rule::IOError) { let diagnostic = Diagnostic::new(IOError { message }, TextRange::default()); - messages.push(Message::from_diagnostic( - diagnostic, - source_file, - TextSize::default(), - )); + messages.push(Message::from_diagnostic(diagnostic, source_file, None)); } else { warn!( "{}{}{} {message}", @@ -56,11 +52,7 @@ pub fn lint_pyproject_toml(source_file: SourceFile, settings: &LinterSettings) - if settings.rules.enabled(Rule::InvalidPyprojectToml) { let toml_err = err.message().to_string(); let diagnostic = Diagnostic::new(InvalidPyprojectToml { message: toml_err }, range); - messages.push(Message::from_diagnostic( - diagnostic, - source_file, - TextSize::default(), - )); + messages.push(Message::from_diagnostic(diagnostic, source_file, None)); } messages diff --git a/crates/ruff_linter/src/registry.rs b/crates/ruff_linter/src/registry.rs index 1ee0cc5102add..9b03a8b7f35e0 100644 --- a/crates/ruff_linter/src/registry.rs +++ b/crates/ruff_linter/src/registry.rs @@ -33,28 +33,15 @@ pub enum FromCodeError { #[derive(EnumIter, Debug, PartialEq, Eq, Clone, Hash, RuleNamespace)] pub enum Linter { - /// [Pyflakes](https://pypi.org/project/pyflakes/) - #[prefix = "F"] - Pyflakes, - /// [pycodestyle](https://pypi.org/project/pycodestyle/) - #[prefix = "E"] - #[prefix = "W"] - Pycodestyle, - /// [mccabe](https://pypi.org/project/mccabe/) - #[prefix = "C90"] - McCabe, - /// [isort](https://pypi.org/project/isort/) - #[prefix = "I"] - Isort, - /// [pep8-naming](https://pypi.org/project/pep8-naming/) - #[prefix = "N"] - PEP8Naming, - /// [pydocstyle](https://pypi.org/project/pydocstyle/) - #[prefix = "D"] - Pydocstyle, - /// [pyupgrade](https://pypi.org/project/pyupgrade/) - #[prefix = "UP"] - Pyupgrade, + /// [Airflow](https://pypi.org/project/apache-airflow/) + #[prefix = "AIR"] + Airflow, + /// [eradicate](https://pypi.org/project/eradicate/) + #[prefix = "ERA"] + Eradicate, + /// [FastAPI](https://pypi.org/project/fastapi/) + #[prefix = "FAST"] + FastApi, /// [flake8-2020](https://pypi.org/project/flake8-2020/) #[prefix = "YTT"] Flake82020, @@ -82,12 +69,12 @@ pub enum Linter { /// [flake8-commas](https://pypi.org/project/flake8-commas/) #[prefix = "COM"] Flake8Commas, - /// [flake8-copyright](https://pypi.org/project/flake8-copyright/) - #[prefix = "CPY"] - Flake8Copyright, /// [flake8-comprehensions](https://pypi.org/project/flake8-comprehensions/) #[prefix = "C4"] Flake8Comprehensions, + /// [flake8-copyright](https://pypi.org/project/flake8-copyright/) + #[prefix = "CPY"] + Flake8Copyright, /// [flake8-datetimez](https://pypi.org/project/flake8-datetimez/) #[prefix = "DTZ"] Flake8Datetimez, @@ -103,9 +90,15 @@ pub enum Linter { /// [flake8-executable](https://pypi.org/project/flake8-executable/) #[prefix = "EXE"] Flake8Executable, + /// [flake8-fixme](https://github.com/tommilligan/flake8-fixme) + #[prefix = "FIX"] + Flake8Fixme, /// [flake8-future-annotations](https://pypi.org/project/flake8-future-annotations/) #[prefix = "FA"] Flake8FutureAnnotations, + /// [flake8-gettext](https://pypi.org/project/flake8-gettext/) + #[prefix = "INT"] + Flake8GetText, /// [flake8-implicit-str-concat](https://pypi.org/project/flake8-implicit-str-concat/) #[prefix = "ISC"] Flake8ImplicitStrConcat, @@ -145,72 +138,79 @@ pub enum Linter { /// [flake8-self](https://pypi.org/project/flake8-self/) #[prefix = "SLF"] Flake8Self, - /// [flake8-slots](https://pypi.org/project/flake8-slots/) - #[prefix = "SLOT"] - Flake8Slots, /// [flake8-simplify](https://pypi.org/project/flake8-simplify/) #[prefix = "SIM"] Flake8Simplify, + /// [flake8-slots](https://pypi.org/project/flake8-slots/) + #[prefix = "SLOT"] + Flake8Slots, /// [flake8-tidy-imports](https://pypi.org/project/flake8-tidy-imports/) #[prefix = "TID"] Flake8TidyImports, + /// [flake8-todos](https://github.com/orsinium-labs/flake8-todos/) + #[prefix = "TD"] + Flake8Todos, /// [flake8-type-checking](https://pypi.org/project/flake8-type-checking/) - #[prefix = "TCH"] + #[prefix = "TC"] Flake8TypeChecking, - /// [flake8-gettext](https://pypi.org/project/flake8-gettext/) - #[prefix = "INT"] - Flake8GetText, /// [flake8-unused-arguments](https://pypi.org/project/flake8-unused-arguments/) #[prefix = "ARG"] Flake8UnusedArguments, /// [flake8-use-pathlib](https://pypi.org/project/flake8-use-pathlib/) #[prefix = "PTH"] Flake8UsePathlib, - /// [flake8-todos](https://github.com/orsinium-labs/flake8-todos/) - #[prefix = "TD"] - Flake8Todos, - /// [flake8-fixme](https://github.com/tommilligan/flake8-fixme) - #[prefix = "FIX"] - Flake8Fixme, - /// [eradicate](https://pypi.org/project/eradicate/) - #[prefix = "ERA"] - Eradicate, - /// [pandas-vet](https://pypi.org/project/pandas-vet/) - #[prefix = "PD"] - PandasVet, - /// [pygrep-hooks](https://github.com/pre-commit/pygrep-hooks) - #[prefix = "PGH"] - PygrepHooks, - /// [Pylint](https://pypi.org/project/pylint/) - #[prefix = "PL"] - Pylint, - /// [tryceratops](https://pypi.org/project/tryceratops/) - #[prefix = "TRY"] - Tryceratops, /// [flynt](https://pypi.org/project/flynt/) #[prefix = "FLY"] Flynt, + /// [isort](https://pypi.org/project/isort/) + #[prefix = "I"] + Isort, + /// [mccabe](https://pypi.org/project/mccabe/) + #[prefix = "C90"] + McCabe, /// NumPy-specific rules #[prefix = "NPY"] Numpy, - /// [FastAPI](https://pypi.org/project/fastapi/) - #[prefix = "FAST"] - FastApi, - /// [Airflow](https://pypi.org/project/apache-airflow/) - #[prefix = "AIR"] - Airflow, + /// [pandas-vet](https://pypi.org/project/pandas-vet/) + #[prefix = "PD"] + PandasVet, + /// [pep8-naming](https://pypi.org/project/pep8-naming/) + #[prefix = "N"] + PEP8Naming, /// [Perflint](https://pypi.org/project/perflint/) #[prefix = "PERF"] Perflint, - /// [refurb](https://pypi.org/project/refurb/) - #[prefix = "FURB"] - Refurb, + /// [pycodestyle](https://pypi.org/project/pycodestyle/) + #[prefix = "E"] + #[prefix = "W"] + Pycodestyle, /// [pydoclint](https://pypi.org/project/pydoclint/) #[prefix = "DOC"] Pydoclint, + /// [pydocstyle](https://pypi.org/project/pydocstyle/) + #[prefix = "D"] + Pydocstyle, + /// [Pyflakes](https://pypi.org/project/pyflakes/) + #[prefix = "F"] + Pyflakes, + /// [pygrep-hooks](https://github.com/pre-commit/pygrep-hooks) + #[prefix = "PGH"] + PygrepHooks, + /// [Pylint](https://pypi.org/project/pylint/) + #[prefix = "PL"] + Pylint, + /// [pyupgrade](https://pypi.org/project/pyupgrade/) + #[prefix = "UP"] + Pyupgrade, + /// [refurb](https://pypi.org/project/refurb/) + #[prefix = "FURB"] + Refurb, /// Ruff-specific rules #[prefix = "RUF"] Ruff, + /// [tryceratops](https://pypi.org/project/tryceratops/) + #[prefix = "TRY"] + Tryceratops, } pub trait RuleNamespace: Sized { @@ -253,6 +253,7 @@ impl Rule { Rule::BidirectionalUnicode | Rule::BlankLineWithWhitespace | Rule::DocLineTooLong + | Rule::IndentedFormFeed | Rule::LineTooLong | Rule::MissingCopyrightNotice | Rule::MissingNewlineAtEndOfFile @@ -306,7 +307,7 @@ impl Rule { Rule::UnsortedImports | Rule::MissingRequiredImport => LintSource::Imports, Rule::ImplicitNamespacePackage | Rule::InvalidModuleName - | Rule::BuiltinModuleShadowing => LintSource::Filesystem, + | Rule::StdlibModuleShadowing => LintSource::Filesystem, Rule::IndentationWithInvalidMultiple | Rule::IndentationWithInvalidMultipleComment | Rule::MissingWhitespace @@ -357,9 +358,9 @@ impl Rule { pub const INCOMPATIBLE_CODES: &[(Rule, Rule, &str); 2] = &[ ( Rule::BlankLineBeforeClass, - Rule::OneBlankLineBeforeClass, - "`one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are \ - incompatible. Ignoring `one-blank-line-before-class`.", + Rule::IncorrectBlankLineBeforeClass, + "`incorrect-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are \ + incompatible. Ignoring `incorrect-blank-line-before-class`.", ), ( Rule::MultiLineSummaryFirstLine, @@ -429,6 +430,7 @@ pub mod clap_completion { #[cfg(test)] mod tests { + use itertools::Itertools; use std::mem::size_of; use strum::IntoEnumIterator; @@ -492,4 +494,19 @@ mod tests { fn rule_size() { assert_eq!(2, size_of::<Rule>()); } + + #[test] + fn linter_sorting() { + let names: Vec<_> = Linter::iter() + .map(|linter| linter.name().to_lowercase()) + .collect(); + + let sorted: Vec<_> = names.iter().cloned().sorted().collect(); + + assert_eq!( + &names[..], + &sorted[..], + "Linters are not sorted alphabetically (case insensitive)" + ); + } } diff --git a/crates/ruff_linter/src/registry/rule_set.rs b/crates/ruff_linter/src/registry/rule_set.rs index 103906118af3a..d83ff07712c0c 100644 --- a/crates/ruff_linter/src/registry/rule_set.rs +++ b/crates/ruff_linter/src/registry/rule_set.rs @@ -5,7 +5,7 @@ use ruff_macros::CacheKey; use crate::registry::Rule; -const RULESET_SIZE: usize = 14; +const RULESET_SIZE: usize = 15; /// A set of [`Rule`]s. /// @@ -16,7 +16,7 @@ pub struct RuleSet([u64; RULESET_SIZE]); impl RuleSet { const EMPTY: [u64; RULESET_SIZE] = [0; RULESET_SIZE]; // 64 fits into a u16 without truncation - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] const SLICE_BITS: u16 = u64::BITS as u16; /// Returns an empty rule set. @@ -361,14 +361,14 @@ impl Iterator for RuleSetIterator { loop { let slice = self.set.0.get_mut(self.index as usize)?; // `trailing_zeros` is guaranteed to return a value in [0;64] - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] let bit = slice.trailing_zeros() as u16; if bit < RuleSet::SLICE_BITS { *slice ^= 1 << bit; let rule_value = self.index * RuleSet::SLICE_BITS + bit; // SAFETY: RuleSet guarantees that only valid rules are stored in the set. - #[allow(unsafe_code)] + #[expect(unsafe_code)] return Some(unsafe { std::mem::transmute::<u16, Rule>(rule_value) }); } diff --git a/crates/ruff_linter/src/renamer.rs b/crates/ruff_linter/src/renamer.rs index 82c6966fd93df..f20843a1e5987 100644 --- a/crates/ruff_linter/src/renamer.rs +++ b/crates/ruff_linter/src/renamer.rs @@ -1,13 +1,17 @@ //! Code modification struct to support symbol renaming within a scope. -use anyhow::{anyhow, Result}; +use anyhow::{Result, anyhow}; use itertools::Itertools; use ruff_diagnostics::Edit; +use ruff_python_ast as ast; use ruff_python_codegen::Stylist; use ruff_python_semantic::{Binding, BindingKind, Scope, ScopeId, SemanticModel}; +use ruff_python_stdlib::{builtins::is_python_builtin, keyword::is_keyword}; use ruff_text_size::Ranged; +use crate::checkers::ast::Checker; + pub(crate) struct Renamer; impl Renamer { @@ -69,6 +73,11 @@ impl Renamer { /// example, to rename `pandas` to `pd`, we may need to rewrite `import pandas` to /// `import pandas as pd`, rather than `import pd`. /// + /// 1. Check to see if the binding is assigned to a known special call where the first argument + /// must be a string that is the same as the binding's name. For example, + /// `T = TypeVar("_T")` will be rejected by a type checker; only `T = TypeVar("T")` will do. + /// If it *is* one of these calls, we rename the relevant argument as well. + /// /// 1. Rename every reference to the [`Binding`]. For example, renaming the references to the /// `x = 1` binding above would give us: /// @@ -198,6 +207,12 @@ impl Renamer { if let Some(edit) = Renamer::rename_binding(binding, name, target) { edits.push(edit); + if let Some(edit) = + Renamer::fixup_assigned_value(binding, semantic, stylist, name, target) + { + edits.push(edit); + } + // Rename any delayed annotations. if let Some(annotations) = semantic.delayed_annotations(binding_id) { edits.extend(annotations.iter().filter_map(|annotation_id| { @@ -231,6 +246,90 @@ impl Renamer { edits } + /// If the r.h.s. of a call expression is a call expression, + /// we may need to fixup some arguments passed to that call expression. + /// + /// It's impossible to do this entirely rigorously; + /// we only special-case some common standard-library constructors here. + /// + /// For example, in this `TypeVar` definition: + /// ```py + /// from typing import TypeVar + /// + /// _T = TypeVar("_T") + /// ``` + /// + /// If we're renaming it from `_T` to `T`, we want this to be the end result: + /// ```py + /// from typing import TypeVar + /// + /// T = TypeVar("T") + /// ``` + /// + /// Not this, which a type checker will reject: + /// ```py + /// from typing import TypeVar + /// + /// T = TypeVar("_T") + /// ``` + fn fixup_assigned_value( + binding: &Binding, + semantic: &SemanticModel, + stylist: &Stylist, + name: &str, + target: &str, + ) -> Option<Edit> { + let statement = binding.statement(semantic)?; + + let (ast::Stmt::Assign(ast::StmtAssign { value, .. }) + | ast::Stmt::AnnAssign(ast::StmtAnnAssign { + value: Some(value), .. + })) = statement + else { + return None; + }; + + let ast::ExprCall { + func, arguments, .. + } = value.as_call_expr()?; + + let qualified_name = semantic.resolve_qualified_name(func)?; + + let name_argument = match qualified_name.segments() { + ["collections", "namedtuple"] => arguments.find_argument_value("typename", 0), + + [ + "typing" | "typing_extensions", + "TypeVar" | "ParamSpec" | "TypeVarTuple" | "NewType" | "TypeAliasType", + ] => arguments.find_argument_value("name", 0), + + [ + "enum", + "Enum" | "IntEnum" | "StrEnum" | "ReprEnum" | "Flag" | "IntFlag", + ] + | ["typing" | "typing_extensions", "NamedTuple" | "TypedDict"] => { + arguments.find_positional(0) + } + + ["builtins" | "", "type"] if arguments.len() == 3 => arguments.find_positional(0), + + _ => None, + }?; + + let name_argument = name_argument.as_string_literal_expr()?; + + if name_argument.value.to_str() != name { + return None; + } + + let quote = stylist.quote(); + + Some(Edit::range_replacement( + format!("{quote}{target}{quote}"), + name_argument.range(), + )) + } + /// Rename a [`Binding`] reference. fn rename_binding(binding: &Binding, name: &str, target: &str) -> Option<Edit> { match &binding.kind { @@ -277,3 +376,63 @@ impl Renamer { } } } + +/// Enumeration of various ways in which a binding can shadow other variables +#[derive(Debug, PartialEq, Eq, Copy, Clone)] +pub(crate) enum ShadowedKind { + /// The variable shadows a global, nonlocal or local symbol + Some, + /// The variable shadows a builtin symbol + BuiltIn, + /// The variable shadows a keyword + Keyword, + /// The variable does not shadow any other symbols + None, +} + +impl ShadowedKind { + /// Determines the kind of shadowing or conflict for the proposed new name of a given [`Binding`]. + /// + /// This function is useful for checking whether or not the `target` of a [`Renamer::rename`] + /// will shadow another binding. + pub(crate) fn new(binding: &Binding, new_name: &str, checker: &Checker) -> ShadowedKind { + // Check the kind in order of precedence + if is_keyword(new_name) { + return ShadowedKind::Keyword; + } + + if is_python_builtin( + new_name, + checker.target_version().minor, + checker.source_type.is_ipynb(), + ) { + return ShadowedKind::BuiltIn; + } + + let semantic = checker.semantic(); + + if !semantic.is_available_in_scope(new_name, binding.scope) { + return ShadowedKind::Some; + } + + if binding + .references() + .map(|reference_id| semantic.reference(reference_id).scope_id()) + .dedup() + .any(|scope| !semantic.is_available_in_scope(new_name, scope)) + { + return ShadowedKind::Some; + } + + // Default to no shadowing + ShadowedKind::None + } + + /// Returns `true` if `self` shadows any global, nonlocal, or local symbol, keyword, or builtin. + pub(crate) const fn shadows_any(self) -> bool { + matches!( + self, + ShadowedKind::Some | ShadowedKind::BuiltIn | ShadowedKind::Keyword + ) + } +} diff --git a/crates/ruff_linter/src/rule_redirects.rs b/crates/ruff_linter/src/rule_redirects.rs index ccbd4ca571627..953074e10d2b5 100644 --- a/crates/ruff_linter/src/rule_redirects.rs +++ b/crates/ruff_linter/src/rule_redirects.rs @@ -87,8 +87,8 @@ static REDIRECTS: LazyLock<HashMap<&'static str, &'static str>> = LazyLock::new( ("PDV90", "PD90"), ("PDV901", "PD901"), // TODO(charlie): Remove by 2023-04-01. - ("TYP", "TCH"), - ("TYP001", "TCH001"), + ("TYP", "TC"), + ("TYP001", "TC001"), // TODO(charlie): Remove by 2023-06-01. ("RUF004", "B026"), ("PIE802", "C419"), @@ -98,7 +98,6 @@ static REDIRECTS: LazyLock<HashMap<&'static str, &'static str>> = LazyLock::new( ("T003", "FIX003"), ("T004", "FIX004"), ("RUF011", "B035"), - ("TCH006", "TCH010"), ("TRY200", "B904"), ("PGH001", "S307"), ("PGH002", "G010"), @@ -126,5 +125,40 @@ static REDIRECTS: LazyLock<HashMap<&'static str, &'static str>> = LazyLock::new( ("RUF025", "C420"), // See: https://github.com/astral-sh/ruff/issues/13492 ("TRY302", "TRY203"), + // TCH renamed to TC to harmonize with flake8 plugin + ("TCH", "TC"), + ("TCH001", "TC001"), + ("TCH002", "TC002"), + ("TCH003", "TC003"), + ("TCH004", "TC004"), + ("TCH005", "TC005"), + ("TCH006", "TC010"), + ("TCH010", "TC010"), + ("RUF035", "S704"), ]) }); + +#[cfg(test)] +mod tests { + use crate::codes::{Rule, RuleGroup}; + use crate::rule_redirects::REDIRECTS; + use strum::IntoEnumIterator; + + /// Tests for rule codes that overlap with a redirect. + #[test] + fn overshadowing_redirects() { + for rule in Rule::iter() { + let (code, group) = (rule.noqa_code(), rule.group()); + + if matches!(group, RuleGroup::Removed) { + continue; + } + + if let Some(redirect_target) = REDIRECTS.get(&*code.to_string()) { + panic!( + "Rule {code} is overshadowed by a redirect, which points to {redirect_target}." + ); + } + } + } +} diff --git a/crates/ruff_linter/src/rule_selector.rs b/crates/ruff_linter/src/rule_selector.rs index 0c70a49806979..7588aa9f64479 100644 --- a/crates/ruff_linter/src/rule_selector.rs +++ b/crates/ruff_linter/src/rule_selector.rs @@ -202,7 +202,7 @@ impl RuleSelector { } /// Returns rules matching the selector, taking into account rule groups like preview and deprecated. - pub fn rules<'a>(&'a self, preview: &PreviewOptions) -> impl Iterator<Item = Rule> + 'a { + pub fn rules<'a>(&'a self, preview: &PreviewOptions) -> impl Iterator<Item = Rule> + use<'a> { let preview_enabled = preview.mode.is_enabled(); let preview_require_explicit = preview.require_explicit; @@ -216,8 +216,7 @@ impl RuleSelector { } // Deprecated rules are excluded in preview mode and with 'All' option unless explicitly selected RuleGroup::Deprecated => { - (!preview_enabled || self.is_exact()) - && !matches!(self, RuleSelector::All { .. }) + (!preview_enabled || self.is_exact()) && !matches!(self, RuleSelector::All) } // Removed rules are included if explicitly selected but will error downstream RuleGroup::Removed => self.is_exact(), @@ -260,21 +259,21 @@ pub struct PreviewOptions { #[cfg(feature = "schemars")] mod schema { use itertools::Itertools; - use schemars::JsonSchema; use schemars::_serde_json::Value; + use schemars::JsonSchema; use schemars::schema::{InstanceType, Schema, SchemaObject}; use strum::IntoEnumIterator; + use crate::RuleSelector; use crate::registry::RuleNamespace; use crate::rule_selector::{Linter, RuleCodePrefix}; - use crate::RuleSelector; impl JsonSchema for RuleSelector { fn schema_name() -> String { "RuleSelector".to_string() } - fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> Schema { + fn json_schema(_gen: &mut schemars::r#gen::SchemaGenerator) -> Schema { Schema::Object(SchemaObject { instance_type: Some(InstanceType::String.into()), enum_values: Some( @@ -315,8 +314,8 @@ mod schema { .filter(|_rule| { // Filter out all test-only rules #[cfg(any(feature = "test-rules", test))] - #[allow(clippy::used_underscore_binding)] - if _rule.starts_with("RUF9") { + #[expect(clippy::used_underscore_binding)] + if _rule.starts_with("RUF9") || _rule == "PLW0101" { return false; } @@ -347,7 +346,9 @@ impl RuleSelector { 2 => Specificity::Prefix2Chars, 3 => Specificity::Prefix3Chars, 4 => Specificity::Prefix4Chars, - _ => panic!("RuleSelector::specificity doesn't yet support codes with so many characters"), + _ => panic!( + "RuleSelector::specificity doesn't yet support codes with so many characters" + ), } } } @@ -413,10 +414,10 @@ pub mod clap_completion { use strum::IntoEnumIterator; use crate::{ + RuleSelector, codes::RuleCodePrefix, registry::{Linter, RuleNamespace}, rule_selector::is_single_rule_selector, - RuleSelector, }; #[derive(Clone)] diff --git a/crates/ruff_linter/src/rules/airflow/helpers.rs b/crates/ruff_linter/src/rules/airflow/helpers.rs new file mode 100644 index 0000000000000..90c99234d3990 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/helpers.rs @@ -0,0 +1,172 @@ +use crate::rules::numpy::helpers::{AttributeSearcher, ImportSearcher}; +use ruff_python_ast::name::QualifiedNameBuilder; +use ruff_python_ast::statement_visitor::StatementVisitor; +use ruff_python_ast::visitor::Visitor; +use ruff_python_ast::{Expr, ExprName, StmtTry}; +use ruff_python_semantic::Exceptions; +use ruff_python_semantic::SemanticModel; + +#[derive(Clone, Debug, Eq, PartialEq)] +pub(crate) enum Replacement { + // There's no replacement or suggestion other than removal + None, + // The attribute name of a class has been changed. + AttrName(&'static str), + // Additional information. Used when there's replacement but they're not direct mapping. + Message(&'static str), + // Symbols updated in Airflow 3 with replacement + // e.g., `airflow.datasets.Dataset` to `airflow.sdk.Asset` + AutoImport { + module: &'static str, + name: &'static str, + }, + // Symbols updated in Airflow 3 with only module changed. Used when we want to match multiple names. + // e.g., `airflow.configuration.as_dict | get` to `airflow.configuration.conf.as_dict | get` + SourceModuleMoved { + module: &'static str, + name: String, + }, +} + +#[derive(Clone, Debug, Eq, PartialEq)] +pub(crate) enum ProviderReplacement { + None, + AutoImport { + module: &'static str, + name: &'static str, + provider: &'static str, + version: &'static str, + }, + SourceModuleMovedToProvider { + module: &'static str, + name: String, + provider: &'static str, + version: &'static str, + }, +} + +pub(crate) fn is_guarded_by_try_except( + expr: &Expr, + module: &str, + name: &str, + semantic: &SemanticModel, +) -> bool { + match expr { + Expr::Attribute(_) => { + if !semantic.in_exception_handler() { + return false; + } + let Some(try_node) = semantic + .current_statements() + .find_map(|stmt| stmt.as_try_stmt()) + else { + return false; + }; + let suspended_exceptions = Exceptions::from_try_stmt(try_node, semantic); + if !suspended_exceptions.contains(Exceptions::ATTRIBUTE_ERROR) { + return false; + } + try_block_contains_undeprecated_attribute(try_node, module, name, semantic) + } + Expr::Name(ExprName { id, .. }) => { + let Some(binding_id) = semantic.lookup_symbol(id.as_str()) else { + return false; + }; + let binding = semantic.binding(binding_id); + if !binding.is_external() { + return false; + } + if !binding.in_exception_handler() { + return false; + } + let Some(try_node) = binding.source.and_then(|import_id| { + semantic + .statements(import_id) + .find_map(|stmt| stmt.as_try_stmt()) + }) else { + return false; + }; + let suspended_exceptions = Exceptions::from_try_stmt(try_node, semantic); + if !suspended_exceptions + .intersects(Exceptions::IMPORT_ERROR | Exceptions::MODULE_NOT_FOUND_ERROR) + { + return false; + } + try_block_contains_undeprecated_import(try_node, module, name) + } + _ => false, + } +} + +/// Given an [`ast::StmtTry`] node, does the `try` branch of that node +/// contain any [`ast::ExprAttribute`] nodes that indicate the airflow +/// member is being accessed from the non-deprecated location? +fn try_block_contains_undeprecated_attribute( + try_node: &StmtTry, + module: &str, + name: &str, + semantic: &SemanticModel, +) -> bool { + let undeprecated_qualified_name = { + let mut builder = QualifiedNameBuilder::default(); + for part in module.split('.') { + builder.push(part); + } + builder.push(name); + builder.build() + }; + let mut attribute_searcher = AttributeSearcher::new(undeprecated_qualified_name, semantic); + attribute_searcher.visit_body(&try_node.body); + attribute_searcher.found_attribute +} + +/// Given an [`ast::StmtTry`] node, does the `try` branch of that node +/// contain any [`ast::StmtImportFrom`] nodes that indicate the airflow +/// member is being imported from the non-deprecated location? +fn try_block_contains_undeprecated_import(try_node: &StmtTry, module: &str, name: &str) -> bool { + let mut import_searcher = ImportSearcher::new(module, name); + import_searcher.visit_body(&try_node.body); + import_searcher.found_import +} + +/// Check whether the segments corresponding to the fully qualified name points to a symbol that's +/// either a builtin or coming from one of the providers in Airflow. +/// +/// The pattern it looks for are: +/// - `airflow.providers.**.<module>.**.*<symbol_suffix>` for providers +/// - `airflow.<module>.**.*<symbol_suffix>` for builtins +/// +/// where `**` is one or more segments separated by a dot, and `*` is one or more characters. +/// +/// Examples for the above patterns: +/// - `airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend` (provider) +/// - `airflow.secrets.base_secrets.BaseSecretsBackend` (builtin) +pub(crate) fn is_airflow_builtin_or_provider( + segments: &[&str], + module: &str, + symbol_suffix: &str, +) -> bool { + match segments { + ["airflow", "providers", rest @ ..] => { + if let (Some(pos), Some(last_element)) = + (rest.iter().position(|&s| s == module), rest.last()) + { + // Check that the module is not the last element i.e., there's a symbol that's + // being used from the `module` that ends with `symbol_suffix`. + pos + 1 < rest.len() && last_element.ends_with(symbol_suffix) + } else { + false + } + } + + ["airflow", first, rest @ ..] => { + if let Some(last) = rest.last() { + *first == module && last.ends_with(symbol_suffix) + } else { + false + } + } + + _ => false, + } +} diff --git a/crates/ruff_linter/src/rules/airflow/mod.rs b/crates/ruff_linter/src/rules/airflow/mod.rs index 34ba5e4c4a14a..60eb9f5a09616 100644 --- a/crates/ruff_linter/src/rules/airflow/mod.rs +++ b/crates/ruff_linter/src/rules/airflow/mod.rs @@ -1,4 +1,5 @@ //! Airflow-specific rules. +pub(crate) mod helpers; pub(crate) mod rules; #[cfg(test)] @@ -13,6 +14,44 @@ mod tests { use crate::{assert_messages, settings}; #[test_case(Rule::AirflowVariableNameTaskIdMismatch, Path::new("AIR001.py"))] + #[test_case(Rule::AirflowDagNoScheduleArgument, Path::new("AIR002.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_args.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_names.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_names_fix.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_provider_names_fix.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_names_try.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_class_attribute.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_airflow_plugin.py"))] + #[test_case(Rule::Airflow3Removal, Path::new("AIR301_context.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_amazon.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_celery.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_common_sql.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_daskexecutor.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_druid.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_fab.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_hdfs.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_hive.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_http.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_jdbc.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_kubernetes.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_mysql.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_oracle.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_papermill.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_pig.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_postgres.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_presto.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_samba.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_slack.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_smtp.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_sqlite.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_zendesk.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_standard.py"))] + #[test_case(Rule::Airflow3MovedToProvider, Path::new("AIR302_try.py"))] + #[test_case(Rule::Airflow3SuggestedUpdate, Path::new("AIR311_args.py"))] + #[test_case(Rule::Airflow3SuggestedUpdate, Path::new("AIR311_names.py"))] + #[test_case(Rule::Airflow3SuggestedUpdate, Path::new("AIR311_try.py"))] + #[test_case(Rule::Airflow3SuggestedToMoveToProvider, Path::new("AIR312.py"))] + #[test_case(Rule::Airflow3SuggestedToMoveToProvider, Path::new("AIR312_try.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( diff --git a/crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs b/crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs new file mode 100644 index 0000000000000..5263ed963bb23 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs @@ -0,0 +1,91 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Expr; +use ruff_python_ast::{self as ast}; +use ruff_python_semantic::Modules; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for a `DAG()` class or `@dag()` decorator without an explicit +/// `schedule` (or `schedule_interval` for Airflow 1) parameter. +/// +/// ## Why is this bad? +/// The default value of the `schedule` parameter on Airflow 2 and +/// `schedule_interval` on Airflow 1 is `timedelta(days=1)`, which is almost +/// never what a user is looking for. Airflow 3 changed the default value to `None`, +/// and would break existing dags using the implicit default. +/// +/// If your dag does not have an explicit `schedule` / `schedule_interval` argument, +/// Airflow 2 schedules a run for it every day (at the time determined by `start_date`). +/// Such a dag will no longer be scheduled on Airflow 3 at all, without any +/// exceptions or other messages visible to the user. +/// +/// ## Example +/// ```python +/// from airflow import DAG +/// +/// +/// # Using the implicit default schedule. +/// dag = DAG(dag_id="my_dag") +/// ``` +/// +/// Use instead: +/// ```python +/// from datetime import timedelta +/// +/// from airflow import DAG +/// +/// +/// dag = DAG(dag_id="my_dag", schedule=timedelta(days=1)) +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct AirflowDagNoScheduleArgument; + +impl Violation for AirflowDagNoScheduleArgument { + #[derive_message_formats] + fn message(&self) -> String { + "DAG should have an explicit `schedule` argument".to_string() + } +} + +/// AIR002 +pub(crate) fn dag_no_schedule_argument(checker: &Checker, expr: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + // Don't check non-call expressions. + let Expr::Call(ast::ExprCall { + func, arguments, .. + }) = expr + else { + return; + }; + + // We don't do anything unless this is a `DAG` (class) or `dag` (decorator + // function) from Airflow. + if !checker + .semantic() + .resolve_qualified_name(func) + .is_some_and(|qualname| matches!(qualname.segments(), ["airflow", .., "DAG" | "dag"])) + { + return; + } + + // If there's a schedule keyword argument, we are good. + // This includes the canonical 'schedule', and the deprecated 'timetable' + // and 'schedule_interval'. Usages of deprecated schedule arguments are + // covered by AIR301. + if ["schedule", "schedule_interval", "timetable"] + .iter() + .any(|a| arguments.find_keyword(a).is_some()) + { + return; + } + + // Produce a diagnostic when the `schedule` keyword argument is not found. + let diagnostic = Diagnostic::new(AirflowDagNoScheduleArgument, expr.range()); + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/airflow/rules/mod.rs b/crates/ruff_linter/src/rules/airflow/rules/mod.rs index f9917250a865a..9b71032b5f36f 100644 --- a/crates/ruff_linter/src/rules/airflow/rules/mod.rs +++ b/crates/ruff_linter/src/rules/airflow/rules/mod.rs @@ -1,3 +1,13 @@ +pub(crate) use dag_schedule_argument::*; +pub(crate) use moved_to_provider_in_3::*; +pub(crate) use removal_in_3::*; +pub(crate) use suggested_to_move_to_provider_in_3::*; +pub(crate) use suggested_to_update_3_0::*; pub(crate) use task_variable_name::*; +mod dag_schedule_argument; +mod moved_to_provider_in_3; +mod removal_in_3; +mod suggested_to_move_to_provider_in_3; +mod suggested_to_update_3_0; mod task_variable_name; diff --git a/crates/ruff_linter/src/rules/airflow/rules/moved_to_provider_in_3.rs b/crates/ruff_linter/src/rules/airflow/rules/moved_to_provider_in_3.rs new file mode 100644 index 0000000000000..b67d1454502dc --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/rules/moved_to_provider_in_3.rs @@ -0,0 +1,1228 @@ +use crate::importer::ImportRequest; +use crate::rules::airflow::helpers::{ProviderReplacement, is_guarded_by_try_except}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprAttribute}; +use ruff_python_semantic::Modules; +use ruff_text_size::Ranged; +use ruff_text_size::TextRange; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for uses of Airflow functions and values that have been moved to it providers. +/// (e.g., apache-airflow-providers-fab) +/// +/// ## Why is this bad? +/// Airflow 3.0 moved various deprecated functions, members, and other +/// values to its providers. The user needs to install the corresponding provider and replace +/// the original usage with the one in the provider +/// +/// ## Example +/// ```python +/// from airflow.auth.managers.fab.fab_auth_manage import FabAuthManager +/// ``` +/// +/// Use instead: +/// ```python +/// from airflow.providers.fab.auth_manager.fab_auth_manage import FabAuthManager +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct Airflow3MovedToProvider { + deprecated: String, + replacement: ProviderReplacement, +} + +impl Violation for Airflow3MovedToProvider { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + let Airflow3MovedToProvider { + deprecated, + replacement, + } = self; + match replacement { + ProviderReplacement::None => { + format!("`{deprecated}` is removed in Airflow 3.0") + } + ProviderReplacement::AutoImport { + name: _, + module: _, + provider, + version: _, + } + | ProviderReplacement::SourceModuleMovedToProvider { + name: _, + module: _, + provider, + version: _, + } => { + format!("`{deprecated}` is moved into `{provider}` provider in Airflow 3.0;") + } + } + } + + fn fix_title(&self) -> Option<String> { + let Airflow3MovedToProvider { replacement, .. } = self; + match replacement { + ProviderReplacement::None => None, + ProviderReplacement::AutoImport { + name, + module, + provider, + version, + } => Some(format!( + "Install `apache-airflow-providers-{provider}>={version}` and use `{module}.{name}` instead." + )), + ProviderReplacement::SourceModuleMovedToProvider { + name, + module, + provider, + version, + } => Some(format!( + "Install `apache-airflow-providers-{provider}>={version}` and use `{module}.{name}` instead." + )), + } + } +} + +/// AIR302 +pub(crate) fn moved_to_provider_in_3(checker: &Checker, expr: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + match expr { + Expr::Attribute(ExprAttribute { attr, .. }) => { + check_names_moved_to_provider(checker, expr, attr.range()); + } + Expr::Name(_) => check_names_moved_to_provider(checker, expr, expr.range()), + _ => {} + } +} + +fn check_names_moved_to_provider(checker: &Checker, expr: &Expr, ranged: TextRange) { + let Some(qualified_name) = checker.semantic().resolve_qualified_name(expr) else { + return; + }; + + let replacement = match qualified_name.segments() { + // apache-airflow-providers-amazon + [ + "airflow", + "hooks", + "S3_hook", + rest @ ("S3Hook" | "provide_bucket_name"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.amazon.aws.hooks.s3", + provider: "amazon", + version: "1.0.0", + }, + ["airflow", "operators", "gcs_to_s3", "GCSToS3Operator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.transfers.gcs_to_s3", + name: "GCSToS3Operator", + provider: "amazon", + version: "1.0.0", + } + } + [ + "airflow", + "operators", + "google_api_to_s3_transfer", + "GoogleApiToS3Operator" | "GoogleApiToS3Transfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.transfers.google_api_to_s3", + name: "GoogleApiToS3Operator", + provider: "amazon", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "redshift_to_s3_operator", + "RedshiftToS3Operator" | "RedshiftToS3Transfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.transfers.redshift_to_s3", + name: "RedshiftToS3Operator", + provider: "amazon", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "s3_file_transform_operator", + "S3FileTransformOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.operators.s3", + name: "S3FileTransformOperator", + provider: "amazon", + version: "3.0.0", + }, + [ + "airflow", + "operators", + "s3_to_redshift_operator", + "S3ToRedshiftOperator" | "S3ToRedshiftTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.transfers.s3_to_redshift", + name: "S3ToRedshiftOperator", + provider: "amazon", + version: "1.0.0", + }, + ["airflow", "sensors", "s3_key_sensor", "S3KeySensor"] => ProviderReplacement::AutoImport { + module: "airflow.providers.amazon.aws.sensors.s3", + name: "S3KeySensor", + provider: "amazon", + version: "1.0.0", + }, + + // apache-airflow-providers-celery + [ + "airflow", + "config_templates", + "default_celery", + "DEFAULT_CELERY_CONFIG", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.celery.executors.default_celery", + name: "DEFAULT_CELERY_CONFIG", + provider: "celery", + version: "3.3.0", + }, + ["airflow", "executors", "celery_executor", rest] => match *rest { + "app" => ProviderReplacement::AutoImport { + module: "airflow.providers.celery.executors.celery_executor_utils", + name: "app", + provider: "celery", + version: "3.3.0", + }, + "CeleryExecutor" => ProviderReplacement::AutoImport { + module: "airflow.providers.celery.executors.celery_executor", + name: "CeleryExecutor", + provider: "celery", + version: "3.3.0", + }, + _ => return, + }, + [ + "airflow", + "executors", + "celery_kubernetes_executor", + "CeleryKubernetesExecutor", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.celery.executors.celery_kubernetes_executor", + name: "CeleryKubernetesExecutor", + provider: "celery", + version: "3.3.0", + }, + + // apache-airflow-providers-common-sql + [ + "airflow", + "hooks", + "dbapi", + rest @ ("ConnectorProtocol" | "DbApiHook"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.common.sql.hooks.sql", + provider: "common-sql", + version: "1.0.0", + }, + ["airflow", "hooks", "dbapi_hook", "DbApiHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.hooks.sql", + name: "DbApiHook", + provider: "common-sql", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "check_operator" | "sql", + "SQLCheckOperator", + ] + | [ + "airflow", + "operators", + "check_operator" | "druid_check_operator" | "presto_check_operator", + "CheckOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLCheckOperator", + provider: "common-sql", + version: "1.1.0", + }, + [ + "airflow", + "operators", + "druid_check_operator", + "DruidCheckOperator", + ] + | [ + "airflow", + "operators", + "presto_check_operator", + "PrestoCheckOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLCheckOperator", + provider: "common-sql", + version: "1.1.0", + }, + [ + "airflow", + "operators", + "check_operator", + "IntervalCheckOperator" | "SQLIntervalCheckOperator", + ] + | [ + "airflow", + "operators", + "presto_check_operator", + "IntervalCheckOperator", + ] + | ["airflow", "operators", "sql", "SQLIntervalCheckOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLIntervalCheckOperator", + provider: "common-sql", + version: "1.1.0", + } + } + [ + "airflow", + "operators", + "presto_check_operator", + "PrestoIntervalCheckOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLIntervalCheckOperator", + provider: "common-sql", + version: "1.1.0", + }, + [ + "airflow", + "operators", + "check_operator", + "SQLThresholdCheckOperator" | "ThresholdCheckOperator", + ] + | ["airflow", "operators", "sql", "SQLThresholdCheckOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLThresholdCheckOperator", + provider: "common-sql", + version: "1.1.0", + } + } + [ + "airflow", + "operators", + "check_operator", + "SQLValueCheckOperator" | "ValueCheckOperator", + ] + | [ + "airflow", + "operators", + "presto_check_operator", + "ValueCheckOperator", + ] + | ["airflow", "operators", "sql", "SQLValueCheckOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLValueCheckOperator", + provider: "common-sql", + version: "1.1.0", + } + } + [ + "airflow", + "operators", + "presto_check_operator", + "PrestoValueCheckOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLValueCheckOperator", + provider: "common-sql", + version: "1.1.0", + }, + ["airflow", "operators", "sql", rest] => match *rest { + "BaseSQLOperator" | "BranchSQLOperator" | "SQLTableCheckOperator" => { + ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.common.sql.operators.sql", + provider: "common-sql", + version: "1.1.0", + } + } + "SQLColumnCheckOperator" | "_convert_to_float_if_possible" | "parse_boolean" => { + ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.common.sql.operators.sql", + provider: "common-sql", + version: "1.0.0", + } + } + _ => return, + }, + ["airflow", "sensors", "sql" | "sql_sensor", "SqlSensor"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.sensors.sql", + name: "SqlSensor", + provider: "common-sql", + version: "1.0.0", + } + } + ["airflow", "operators", "jdbc_operator", "JdbcOperator"] + | ["airflow", "operators", "mssql_operator", "MsSqlOperator"] + | ["airflow", "operators", "mysql_operator", "MySqlOperator"] + | ["airflow", "operators", "oracle_operator", "OracleOperator"] + | [ + "airflow", + "operators", + "postgres_operator", + "PostgresOperator", + ] + | ["airflow", "operators", "sqlite_operator", "SqliteOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.common.sql.operators.sql", + name: "SQLExecuteQueryOperator", + provider: "common-sql", + version: "1.3.0", + } + } + + // apache-airflow-providers-daskexecutor + ["airflow", "executors", "dask_executor", "DaskExecutor"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.daskexecutor.executors.dask_executor", + name: "DaskExecutor", + provider: "daskexecutor", + version: "1.0.0", + } + } + + // apache-airflow-providers-docker + ["airflow", "hooks", "docker_hook", "DockerHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.docker.hooks.docker", + name: "DockerHook", + provider: "docker", + version: "1.0.0", + }, + ["airflow", "operators", "docker_operator", "DockerOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.docker.operators.docker", + name: "DockerOperator", + provider: "docker", + version: "1.0.0", + } + } + + // apache-airflow-providers-apache-druid + [ + "airflow", + "hooks", + "druid_hook", + rest @ ("DruidDbApiHook" | "DruidHook"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.apache.druid.hooks.druid", + provider: "apache-druid", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "hive_to_druid", + "HiveToDruidOperator" | "HiveToDruidTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.druid.transfers.hive_to_druid", + name: "HiveToDruidOperator", + provider: "apache-druid", + version: "1.0.0", + }, + + // apache-airflow-providers-fab + [ + "airflow", + "api", + "auth", + "backend", + "basic_auth", + rest @ ("CLIENT_AUTH" | "init_app" | "auth_current_user" | "requires_authentication"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth", + provider: "fab", + version: "1.0.0", + }, + [ + "airflow", + "api", + "auth", + "backend", + "kerberos_auth", + rest @ ("log" | "CLIENT_AUTH" | "find_user" | "init_app" | "requires_authentication"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth", + provider: "fab", + version: "1.0.0", + }, + [ + "airflow", + "auth", + "managers", + "fab", + "api", + "auth", + "backend", + "kerberos_auth", + rest @ ("log" | "CLIENT_AUTH" | "find_user" | "init_app" | "requires_authentication"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth", + provider: "fab", + version: "1.0.0", + }, + [ + "airflow", + "auth", + "managers", + "fab", + "fab_auth_manager", + "FabAuthManager", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.fab.auth_manager.fab_auth_manager", + name: "FabAuthManager", + provider: "fab", + version: "1.0.0", + }, + [ + "airflow", + "auth", + "managers", + "fab", + "security_manager", + "override", + "MAX_NUM_DATABASE_USER_SESSIONS", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.fab.auth_manager.security_manager.override", + name: "MAX_NUM_DATABASE_USER_SESSIONS", + provider: "fab", + version: "1.0.0", + }, + [ + "airflow", + "auth", + "managers", + "fab", + "security_manager", + "override", + "FabAirflowSecurityManagerOverride", + ] + | [ + "airflow", + "www", + "security", + "FabAirflowSecurityManagerOverride", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.fab.auth_manager.security_manager.override", + name: "FabAirflowSecurityManagerOverride", + provider: "fab", + version: "1.0.0", + }, + + // apache-airflow-providers-apache-hdfs + ["airflow", "hooks", "webhdfs_hook", "WebHDFSHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hdfs.hooks.webhdfs", + name: "WebHDFSHook", + provider: "apache-hdfs", + version: "1.0.0", + }, + ["airflow", "sensors", "web_hdfs_sensor", "WebHdfsSensor"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hdfs.sensors.web_hdfs", + name: "WebHdfsSensor", + provider: "apache-hdfs", + version: "1.0.0", + } + } + + // apache-airflow-providers-apache-hive + [ + "airflow", + "hooks", + "hive_hooks", + rest @ ("HiveCliHook" + | "HiveMetastoreHook" + | "HiveServer2Hook" + | "HIVE_QUEUE_PRIORITIES"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.apache.hive.hooks.hive", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "macros", + "hive", + rest @ ("closest_ds_partition" | "max_partition"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.apache.hive.macros.hive", + provider: "apache-hive", + version: "5.1.0", + }, + ["airflow", "operators", "hive_operator", "HiveOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.operators.hive", + name: "HiveOperator", + provider: "apache-hive", + version: "1.0.0", + } + } + [ + "airflow", + "operators", + "hive_stats_operator", + "HiveStatsCollectionOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.operators.hive_stats", + name: "HiveStatsCollectionOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "hive_to_mysql", + "HiveToMySqlOperator" | "HiveToMySqlTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.transfers.hive_to_mysql", + name: "HiveToMySqlOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "hive_to_samba_operator", + "HiveToSambaOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.transfers.hive_to_samba", + name: "HiveToSambaOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "mssql_to_hive", + "MsSqlToHiveOperator" | "MsSqlToHiveTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.transfers.mssql_to_hive", + name: "MsSqlToHiveOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "mysql_to_hive", + "MySqlToHiveOperator" | "MySqlToHiveTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.transfers.mysql_to_hive", + name: "MySqlToHiveOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "s3_to_hive_operator", + "S3ToHiveOperator" | "S3ToHiveTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.transfers.s3_to_hive", + name: "S3ToHiveOperator", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "sensors", + "hive_partition_sensor", + "HivePartitionSensor", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.sensors.hive_partition", + name: "HivePartitionSensor", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "sensors", + "metastore_partition_sensor", + "MetastorePartitionSensor", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.sensors.metastore_partition", + name: "MetastorePartitionSensor", + provider: "apache-hive", + version: "1.0.0", + }, + [ + "airflow", + "sensors", + "named_hive_partition_sensor", + "NamedHivePartitionSensor", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.hive.sensors.named_hive_partition", + name: "NamedHivePartitionSensor", + provider: "apache-hive", + version: "1.0.0", + }, + + // apache-airflow-providers-http + ["airflow", "hooks", "http_hook", "HttpHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.http.hooks.http", + name: "HttpHook", + provider: "http", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "http_operator", + "SimpleHttpOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.http.operators.http", + name: "HttpOperator", + provider: "http", + version: "5.0.0", + }, + ["airflow", "sensors", "http_sensor", "HttpSensor"] => ProviderReplacement::AutoImport { + module: "airflow.providers.http.sensors.http", + name: "HttpSensor", + provider: "http", + version: "1.0.0", + }, + + // apache-airflow-providers-jdbc + [ + "airflow", + "hooks", + "jdbc_hook", + rest @ ("JdbcHook" | "jaydebeapi"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.jdbc.hooks.jdbc", + provider: "jdbc", + version: "1.0.0", + }, + + // apache-airflow-providers-cncf-kubernetes + [ + "airflow", + "executors", + "kubernetes_executor_types", + rest @ ("ALL_NAMESPACES" | "POD_EXECUTOR_DONE_KEY"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.executors.kubernetes_executor_types", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "k8s_model", + rest @ ("K8SModel" | "append_to_pod"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.k8s_model", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "kube_client", + rest @ ("_disable_verify_ssl" | "_enable_tcp_keepalive" | "get_kube_client"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.kube_client", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "kubernetes_helper_functions", + "add_pod_suffix", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.kubernetes_helper_functions", + name: "add_unique_suffix", + provider: "cncf-kubernetes", + version: "10.0.0", + }, + [ + "airflow", + "kubernetes", + "kubernetes_helper_functions", + "create_pod_id", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.kubernetes_helper_functions", + name: "create_unique_id", + provider: "cncf-kubernetes", + version: "10.0.0", + }, + [ + "airflow", + "kubernetes", + "kubernetes_helper_functions", + rest @ ("annotations_for_logging_task_metadata" + | "annotations_to_key" + | "get_logs_task_metadata" + | "rand_str"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.kubernetes_helper_functions", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + ["airflow", "kubernetes", "pod", rest] => match *rest { + "Port" => ProviderReplacement::AutoImport { + module: "kubernetes.client.models", + name: "V1ContainerPort", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + "Resources" => ProviderReplacement::AutoImport { + module: "kubernetes.client.models", + name: "V1ResourceRequirements", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + _ => return, + }, + ["airflow", "kubernetes", "pod_generator", rest] => match *rest { + "datetime_to_label_safe_datestring" + | "extend_object_field" + | "label_safe_datestring_to_datetime" + | "make_safe_label_value" + | "merge_objects" + | "PodGenerator" => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.pod_generator", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + "PodDefaults" => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.utils.xcom_sidecar", + name: "PodDefaults", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + "PodGeneratorDeprecated" => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.pod_generator", + name: "PodGenerator", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + "add_pod_suffix" => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.kubernetes_helper_functions", + name: "add_unique_suffix", + provider: "cncf-kubernetes", + version: "10.0.0", + }, + "rand_str" => ProviderReplacement::SourceModuleMovedToProvider { + module: "airflow.providers.cncf.kubernetes.kubernetes_helper_functions", + name: "rand_str".to_string(), + provider: "cncf-kubernetes", + version: "7.4.0", + }, + _ => return, + }, + [ + "airflow", + "kubernetes", + "pod_generator_deprecated", + rest @ ("make_safe_label_value" | "PodGenerator"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.cncf.kubernetes.pod_generator", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "pod_generator_deprecated" | "pod_launcher_deprecated", + "PodDefaults", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.utils.xcom_sidecar", + name: "PodDefaults", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "pod_launcher_deprecated", + "get_kube_client", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.kube_client", + name: "get_kube_client", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + [ + "airflow", + "kubernetes", + "pod_launcher" | "pod_launcher_deprecated", + "PodLauncher", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.utils.pod_manager", + name: "PodManager", + provider: "cncf-kubernetes", + version: "3.0.0", + }, + [ + "airflow", + "kubernetes", + "pod_launcher" | "pod_launcher_deprecated", + "PodStatus", + ] => ProviderReplacement::AutoImport { + module: " airflow.providers.cncf.kubernetes.utils.pod_manager", + name: "PodPhase", + provider: "cncf-kubernetes", + version: "3.0.0", + }, + [ + "airflow", + "kubernetes", + "pod_runtime_info_env", + "PodRuntimeInfoEnv", + ] => ProviderReplacement::AutoImport { + module: "kubernetes.client.models", + name: "V1EnvVar", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + ["airflow", "kubernetes", "secret", rest] => match *rest { + "K8SModel" => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.k8s_model", + name: "K8SModel", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + "Secret" => ProviderReplacement::AutoImport { + module: "airflow.providers.cncf.kubernetes.secret", + name: "Secret", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + _ => return, + }, + ["airflow", "kubernetes", "volume", "Volume"] => ProviderReplacement::AutoImport { + module: "kubernetes.client.models", + name: "V1Volume", + provider: "cncf-kubernetes", + version: "7.4.0", + }, + ["airflow", "kubernetes", "volume_mount", "VolumeMount"] => { + ProviderReplacement::AutoImport { + module: "kubernetes.client.models", + name: "V1VolumeMount", + provider: "cncf-kubernetes", + version: "7.4.0", + } + } + + // apache-airflow-providers-microsoft-mssql + ["airflow", "hooks", "mssql_hook", "MsSqlHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.microsoft.mssql.hooks.mssql", + name: "MsSqlHook", + provider: "microsoft-mssql", + version: "1.0.0", + }, + + // apache-airflow-providers-mysql + ["airflow", "hooks", "mysql_hook", "MySqlHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.mysql.hooks.mysql", + name: "MySqlHook", + provider: "mysql", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "presto_to_mysql", + "PrestoToMySqlOperator" | "PrestoToMySqlTransfer", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.mysql.transfers.presto_to_mysql", + name: "PrestoToMySqlOperator", + provider: "mysql", + version: "1.0.0", + }, + + // apache-airflow-providers-oracle + ["airflow", "hooks", "oracle_hook", "OracleHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.oracle.hooks.oracle", + name: "OracleHook", + provider: "oracle", + version: "1.0.0", + }, + + // apache-airflow-providers-papermill + [ + "airflow", + "operators", + "papermill_operator", + "PapermillOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.papermill.operators.papermill", + name: "PapermillOperator", + provider: "papermill", + version: "1.0.0", + }, + + // apache-airflow-providers-apache-pig + ["airflow", "hooks", "pig_hook", "PigCliHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.apache.pig.hooks.pig", + name: "PigCliHook", + provider: "apache-pig", + version: "1.0.0", + }, + ["airflow", "operators", "pig_operator", "PigOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.apache.pig.operators.pig", + name: "PigOperator", + provider: "apache-pig", + version: "1.0.0", + } + } + + // apache-airflow-providers-postgres + ["airflow", "hooks", "postgres_hook", "PostgresHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.postgres.hooks.postgres", + name: "PostgresHook", + provider: "postgres", + version: "1.0.0", + }, + ["airflow", "operators", "postgres_operator", "Mapping"] => ProviderReplacement::None, + + // apache-airflow-providers-presto + ["airflow", "hooks", "presto_hook", "PrestoHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.presto.hooks.presto", + name: "PrestoHook", + provider: "presto", + version: "1.0.0", + }, + + // apache-airflow-providers-samba + ["airflow", "hooks", "samba_hook", "SambaHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.samba.hooks.samba", + name: "SambaHook", + provider: "samba", + version: "1.0.0", + }, + + // apache-airflow-providers-slack + ["airflow", "hooks", "slack_hook", "SlackHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.slack.hooks.slack", + name: "SlackHook", + provider: "slack", + version: "1.0.0", + }, + [ + "airflow", + "operators", + "slack_operator", + rest @ ("SlackAPIOperator" | "SlackAPIPostOperator"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.slack.operators.slack", + provider: "slack", + version: "1.0.0", + }, + + // apache-airflow-providers-smtp + [ + "airflow", + "operators", + "email_operator" | "email", + "EmailOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.smtp.operators.smtp", + name: "EmailOperator", + provider: "smtp", + version: "1.0.0", + }, + + // apache-airflow-providers-sqlite + ["airflow", "hooks", "sqlite_hook", "SqliteHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.sqlite.hooks.sqlite", + name: "SqliteHook", + provider: "sqlite", + version: "1.0.0", + }, + + // apache-airflow-providers-zendesk + ["airflow", "hooks", "zendesk_hook", "ZendeskHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.zendesk.hooks.zendesk", + name: "ZendeskHook", + provider: "zendesk", + version: "1.0.0", + }, + + // apache-airflow-providers-standard + [ + "airflow", + "hooks", + "subprocess", + rest @ ("SubprocessResult" | "working_directory"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.hooks.subprocess", + provider: "standard", + version: "0.0.3", + }, + ["airflow", "operators", "bash_operator", "BashOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.bash", + name: "BashOperator", + provider: "standard", + version: "0.0.1", + } + } + [ + "airflow", + "operators", + "dagrun_operator", + rest @ ("TriggerDagRunLink" | "TriggerDagRunOperator"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.operators.trigger_dagrun", + provider: "standard", + version: "0.0.2", + }, + [ + "airflow", + "operators", + "trigger_dagrun", + "TriggerDagRunLink", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.trigger_dagrun", + name: "TriggerDagRunLink", + provider: "standard", + version: "0.0.2", + }, + ["airflow", "operators", "datetime", "target_times_as_dates"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.datetime", + name: "target_times_as_dates", + provider: "standard", + version: "0.0.1", + } + } + [ + "airflow", + "operators", + "dummy" | "dummy_operator", + "EmptyOperator" | "DummyOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.empty", + name: "EmptyOperator", + provider: "standard", + version: "0.0.2", + }, + [ + "airflow", + "operators", + "latest_only_operator", + "LatestOnlyOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.latest_only", + name: "LatestOnlyOperator", + provider: "standard", + version: "0.0.3", + }, + [ + "airflow", + "operators", + "python_operator", + rest @ ("BranchPythonOperator" + | "PythonOperator" + | "PythonVirtualenvOperator" + | "ShortCircuitOperator"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.operators.python", + provider: "standard", + version: "0.0.1", + }, + [ + "airflow", + "sensors", + "external_task", + "ExternalTaskSensorLink", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.sensors.external_task", + name: "ExternalDagLink", + provider: "standard", + version: "0.0.3", + }, + [ + "airflow", + "sensors", + "external_task_sensor", + rest @ ("ExternalTaskMarker" | "ExternalTaskSensor" | "ExternalTaskSensorLink"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + module: "airflow.providers.standard.sensors.external_task", + name: (*rest).to_string(), + provider: "standard", + version: "0.0.3", + }, + ["airflow", "sensors", "time_delta", "WaitSensor"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.sensors.time_delta", + name: "WaitSensor", + provider: "standard", + version: "0.0.1", + }, + + _ => return, + }; + + let mut diagnostic = Diagnostic::new( + Airflow3MovedToProvider { + deprecated: qualified_name.to_string(), + replacement: replacement.clone(), + }, + ranged.range(), + ); + + let semantic = checker.semantic(); + if let Some((module, name)) = match &replacement { + ProviderReplacement::AutoImport { module, name, .. } => Some((module, *name)), + ProviderReplacement::SourceModuleMovedToProvider { module, name, .. } => { + Some((module, name.as_str())) + } + ProviderReplacement::None => None, + } { + if is_guarded_by_try_except(expr, module, name, semantic) { + return; + } + diagnostic.try_set_fix(|| { + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from(module, name), + expr.start(), + checker.semantic(), + )?; + let replacement_edit = Edit::range_replacement(binding, ranged.range()); + Ok(Fix::safe_edits(import_edit, [replacement_edit])) + }); + } + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/airflow/rules/removal_in_3.rs b/crates/ruff_linter/src/rules/airflow/rules/removal_in_3.rs new file mode 100644 index 0000000000000..eeacdadd49ba2 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/rules/removal_in_3.rs @@ -0,0 +1,1173 @@ +use crate::checkers::ast::Checker; +use crate::importer::ImportRequest; +use crate::rules::airflow::helpers::{ + Replacement, is_airflow_builtin_or_provider, is_guarded_by_try_except, +}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::map_callable; +use ruff_python_ast::{ + Arguments, Expr, ExprAttribute, ExprCall, ExprContext, ExprName, ExprStringLiteral, + ExprSubscript, Stmt, StmtClassDef, StmtFunctionDef, name::QualifiedName, +}; +use ruff_python_semantic::Modules; +use ruff_python_semantic::ScopeKind; +use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; +use ruff_text_size::Ranged; +use ruff_text_size::TextRange; + +/// ## What it does +/// Checks for uses of deprecated Airflow functions and values. +/// +/// ## Why is this bad? +/// Airflow 3.0 removed various deprecated functions, members, and other +/// values. Some have more modern replacements. Others are considered too niche +/// and not worth to be maintained in Airflow. +/// +/// ## Example +/// ```python +/// from airflow.utils.dates import days_ago +/// +/// +/// yesterday = days_ago(today, 1) +/// ``` +/// +/// Use instead: +/// ```python +/// from datetime import timedelta +/// +/// +/// yesterday = today - timedelta(days=1) +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct Airflow3Removal { + deprecated: String, + replacement: Replacement, +} + +impl Violation for Airflow3Removal { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + let Airflow3Removal { + deprecated, + replacement, + } = self; + match replacement { + Replacement::None + | Replacement::AttrName(_) + | Replacement::Message(_) + | Replacement::AutoImport { module: _, name: _ } + | Replacement::SourceModuleMoved { module: _, name: _ } => { + format!("`{deprecated}` is removed in Airflow 3.0") + } + } + } + + fn fix_title(&self) -> Option<String> { + let Airflow3Removal { replacement, .. } = self; + match replacement { + Replacement::None => None, + Replacement::AttrName(name) => Some(format!("Use `{name}` instead")), + Replacement::Message(message) => Some((*message).to_string()), + Replacement::AutoImport { module, name } => { + Some(format!("Use `{module}.{name}` instead")) + } + Replacement::SourceModuleMoved { module, name } => { + Some(format!("Use `{module}.{name}` instead")) + } + } + } +} + +/// AIR301 +pub(crate) fn airflow_3_removal_expr(checker: &Checker, expr: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + match expr { + Expr::Call( + call_expr @ ExprCall { + func, arguments, .. + }, + ) => { + if let Some(qualified_name) = checker.semantic().resolve_qualified_name(func) { + check_call_arguments(checker, &qualified_name, arguments); + } + check_method(checker, call_expr); + check_context_key_usage_in_call(checker, call_expr); + } + Expr::Attribute(attribute_expr @ ExprAttribute { range, .. }) => { + check_name(checker, expr, *range); + check_class_attribute(checker, attribute_expr); + } + Expr::Name(ExprName { id, ctx, range }) => { + check_name(checker, expr, *range); + if matches!(ctx, ExprContext::Store) { + if let ScopeKind::Class(class_def) = checker.semantic().current_scope().kind { + check_airflow_plugin_extension(checker, expr, id, class_def); + } + } + } + Expr::Subscript(subscript_expr) => { + check_context_key_usage_in_subscript(checker, subscript_expr); + } + _ => {} + } +} + +/// AIR301 +pub(crate) fn airflow_3_removal_function_def(checker: &Checker, function_def: &StmtFunctionDef) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + check_function_parameters(checker, function_def); +} + +const REMOVED_CONTEXT_KEYS: [&str; 12] = [ + "conf", + "execution_date", + "next_ds", + "next_ds_nodash", + "next_execution_date", + "prev_ds", + "prev_ds_nodash", + "prev_execution_date", + "prev_execution_date_success", + "tomorrow_ds", + "yesterday_ds", + "yesterday_ds_nodash", +]; + +/// Check the function parameters for removed context keys. +/// +/// For example: +/// +/// ```python +/// from airflow.decorators import task +/// +/// @task +/// def another_task(execution_date, **kwargs): +/// # ^^^^^^^^^^^^^^ +/// # 'execution_date' is removed in Airflow 3.0 +/// pass +/// ``` +fn check_function_parameters(checker: &Checker, function_def: &StmtFunctionDef) { + if !is_airflow_task(function_def, checker.semantic()) + && !is_execute_method_inherits_from_airflow_operator(function_def, checker.semantic()) + { + return; + } + + for param in function_def.parameters.iter_non_variadic_params() { + let param_name = param.name(); + if REMOVED_CONTEXT_KEYS.contains(¶m_name.as_str()) { + checker.report_diagnostic(Diagnostic::new( + Airflow3Removal { + deprecated: param_name.to_string(), + replacement: Replacement::None, + }, + param_name.range(), + )); + } + } +} + +/// Check whether a removed Airflow argument is passed. +/// +/// For example: +/// +/// ```python +/// from airflow import DAG +/// +/// DAG(schedule_interval="@daily") +/// ``` +fn check_call_arguments(checker: &Checker, qualified_name: &QualifiedName, arguments: &Arguments) { + match qualified_name.segments() { + ["airflow", .., "DAG" | "dag"] => { + // with replacement + diagnostic_for_argument(checker, arguments, "fail_stop", Some("fail_fast")); + diagnostic_for_argument(checker, arguments, "schedule_interval", Some("schedule")); + diagnostic_for_argument(checker, arguments, "timetable", Some("schedule")); + // without replacement + diagnostic_for_argument(checker, arguments, "default_view", None); + diagnostic_for_argument(checker, arguments, "orientation", None); + } + segments => { + if is_airflow_auth_manager(segments) { + if !arguments.is_empty() { + checker.report_diagnostic(Diagnostic::new( + Airflow3Removal { + deprecated: String::from("appbuilder"), + replacement: Replacement::Message( + "The constructor takes no parameter now", + ), + }, + arguments.range(), + )); + } + } else if is_airflow_task_handler(segments) { + diagnostic_for_argument(checker, arguments, "filename_template", None); + } else if is_airflow_builtin_or_provider(segments, "operators", "Operator") { + diagnostic_for_argument( + checker, + arguments, + "task_concurrency", + Some("max_active_tis_per_dag"), + ); + match segments { + [ + "airflow", + .., + "operators", + "trigger_dagrun", + "TriggerDagRunOperator", + ] => { + diagnostic_for_argument( + checker, + arguments, + "execution_date", + Some("logical_date"), + ); + } + [ + "airflow", + .., + "operators", + "datetime", + "BranchDateTimeOperator", + ] + | [ + "airflow", + .., + "operators", + "weekday", + "BranchDayOfWeekOperator", + ] + | ["airflow", .., "sensors", "weekday", "DayOfWeekSensor"] => { + diagnostic_for_argument( + checker, + arguments, + "use_task_execution_day", + Some("use_task_logical_date"), + ); + } + _ => {} + } + } + } + } +} + +/// Check whether a removed Airflow class attribute (include property) is called. +/// +/// For example: +/// +/// ```python +/// from airflow.linesage.hook import DatasetLineageInfo +/// +/// info = DatasetLineageInfo() +/// info.dataset +/// ``` +fn check_class_attribute(checker: &Checker, attribute_expr: &ExprAttribute) { + let ExprAttribute { value, attr, .. } = attribute_expr; + + let Some(qualname) = typing::resolve_assignment(value, checker.semantic()) else { + return; + }; + + let replacement = match *qualname.segments() { + ["airflow", "providers_manager", "ProvidersManager"] => match attr.as_str() { + "dataset_factories" => Replacement::AttrName("asset_factories"), + "dataset_uri_handlers" => Replacement::AttrName("asset_uri_handlers"), + "dataset_to_openlineage_converters" => { + Replacement::AttrName("asset_to_openlineage_converters") + } + _ => return, + }, + ["airflow", "lineage", "hook", "DatasetLineageInfo"] => match attr.as_str() { + "dataset" => Replacement::AttrName("asset"), + _ => return, + }, + _ => return, + }; + + // Create the `Fix` first to avoid cloning `Replacement`. + let fix = if let Replacement::AttrName(name) = replacement { + Some(Fix::safe_edit(Edit::range_replacement( + name.to_string(), + attr.range(), + ))) + } else { + None + }; + let mut diagnostic = Diagnostic::new( + Airflow3Removal { + deprecated: attr.to_string(), + replacement, + }, + attr.range(), + ); + if let Some(fix) = fix { + diagnostic.set_fix(fix); + } + checker.report_diagnostic(diagnostic); +} + +/// Checks whether an Airflow 3.0–removed context key is used in a function decorated with `@task`. +/// +/// Specifically, it flags the following two scenarios: +/// +/// 1. A removed context key accessed via `context.get("...")` where context is coming from +/// `get_current_context` function. +/// +/// ```python +/// from airflow.decorators import task +/// from airflow.utils.context import get_current_context +/// +/// +/// @task +/// def my_task(): +/// context = get_current_context() +/// context.get("conf") # 'conf' is removed in Airflow 3.0 +/// ``` +/// +/// 2. A removed context key accessed via `context.get("...")` where context is a kwarg parameter. +/// +/// ```python +/// from airflow.decorators import task +/// +/// +/// @task +/// def my_task(**context): +/// context.get("conf") # 'conf' is removed in Airflow 3.0 +/// ``` +fn check_context_key_usage_in_call(checker: &Checker, call_expr: &ExprCall) { + if !in_airflow_task_function(checker.semantic()) { + return; + } + + let Expr::Attribute(ExprAttribute { value, attr, .. }) = &*call_expr.func else { + return; + }; + + if attr.as_str() != "get" { + return; + } + + let is_kwarg_parameter = value + .as_name_expr() + .is_some_and(|name| is_kwarg_parameter(checker.semantic(), name)); + + let is_assigned_from_get_current_context = + typing::resolve_assignment(value, checker.semantic()).is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["airflow", "utils", "context", "get_current_context"] + ) + }); + + if !(is_kwarg_parameter || is_assigned_from_get_current_context) { + return; + } + + for removed_key in REMOVED_CONTEXT_KEYS { + let Some(Expr::StringLiteral(ExprStringLiteral { value, range })) = + call_expr.arguments.find_positional(0) + else { + continue; + }; + if value == removed_key { + checker.report_diagnostic(Diagnostic::new( + Airflow3Removal { + deprecated: removed_key.to_string(), + replacement: Replacement::None, + }, + *range, + )); + } + } +} + +/// Check if a subscript expression accesses a removed Airflow context variable. +/// If a removed key is found, push a corresponding diagnostic. +fn check_context_key_usage_in_subscript(checker: &Checker, subscript: &ExprSubscript) { + if !in_airflow_task_function(checker.semantic()) { + return; + } + + let ExprSubscript { value, slice, .. } = subscript; + + let Some(ExprStringLiteral { value: key, .. }) = slice.as_string_literal_expr() else { + return; + }; + + let is_kwarg_parameter = value + .as_name_expr() + .is_some_and(|name| is_kwarg_parameter(checker.semantic(), name)); + + let is_assigned_from_get_current_context = + typing::resolve_assignment(value, checker.semantic()).is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["airflow", "utils", "context", "get_current_context"] + ) + }); + + if !(is_kwarg_parameter || is_assigned_from_get_current_context) { + return; + } + + if REMOVED_CONTEXT_KEYS.contains(&key.to_str()) { + checker.report_diagnostic(Diagnostic::new( + Airflow3Removal { + deprecated: key.to_string(), + replacement: Replacement::None, + }, + slice.range(), + )); + } +} + +/// Finds the parameter definition for a given name expression in a function. +fn is_kwarg_parameter(semantic: &SemanticModel, name: &ExprName) -> bool { + let Some(binding_id) = semantic.only_binding(name) else { + return false; + }; + let binding = semantic.binding(binding_id); + let Some(Stmt::FunctionDef(StmtFunctionDef { parameters, .. })) = binding.statement(semantic) + else { + return false; + }; + parameters + .kwarg + .as_deref() + .is_some_and(|kwarg| kwarg.name.as_str() == name.id.as_str()) +} + +/// Check whether a removed Airflow class method is called. +/// +/// For example: +/// +/// ```python +/// from airflow.datasets.manager import DatasetManager +/// +/// manager = DatasetManager() +/// manager.register_datsaet_change() +/// ``` +fn check_method(checker: &Checker, call_expr: &ExprCall) { + let Expr::Attribute(ExprAttribute { attr, value, .. }) = &*call_expr.func else { + return; + }; + + let Some(qualname) = typing::resolve_assignment(value, checker.semantic()) else { + return; + }; + + let replacement = match qualname.segments() { + ["airflow", "datasets", "manager", "DatasetManager"] => match attr.as_str() { + "register_dataset_change" => Replacement::AttrName("register_asset_change"), + "create_datasets" => Replacement::AttrName("create_assets"), + "notify_dataset_created" => Replacement::AttrName("notify_asset_created"), + "notify_dataset_changed" => Replacement::AttrName("notify_asset_changed"), + "notify_dataset_alias_created" => Replacement::AttrName("notify_asset_alias_created"), + _ => return, + }, + ["airflow", "lineage", "hook", "HookLineageCollector"] => match attr.as_str() { + "create_dataset" => Replacement::AttrName("create_asset"), + "add_input_dataset" => Replacement::AttrName("add_input_asset"), + "add_output_dataset" => Replacement::AttrName("add_output_asset"), + "collected_datasets" => Replacement::AttrName("collected_assets"), + _ => return, + }, + ["airflow", "providers_manager", "ProvidersManager"] => match attr.as_str() { + "initialize_providers_dataset_uri_resources" => { + Replacement::AttrName("initialize_providers_asset_uri_resources") + } + _ => return, + }, + [ + "airflow", + "secrets", + "local_filesystem", + "LocalFilesystemBackend", + ] => match attr.as_str() { + "get_connections" => Replacement::AttrName("get_connection"), + _ => return, + }, + ["airflow", "datasets", ..] | ["airflow", "Dataset"] => match attr.as_str() { + "iter_datasets" => Replacement::AttrName("iter_assets"), + "iter_dataset_aliases" => Replacement::AttrName("iter_asset_aliases"), + _ => return, + }, + segments => { + if is_airflow_secret_backend(segments) { + match attr.as_str() { + "get_conn_uri" => Replacement::AttrName("get_conn_value"), + "get_connections" => Replacement::AttrName("get_connection"), + _ => return, + } + } else if is_airflow_hook(segments) { + match attr.as_str() { + "get_connections" => Replacement::AttrName("get_connection"), + _ => return, + } + } else if is_airflow_auth_manager(segments) { + if attr.as_str() == "is_authorized_dataset" { + Replacement::AttrName("is_authorized_asset") + } else { + return; + } + } else { + return; + } + } + }; + // Create the `Fix` first to avoid cloning `Replacement`. + let fix = if let Replacement::AttrName(name) = replacement { + Some(Fix::safe_edit(Edit::range_replacement( + name.to_string(), + attr.range(), + ))) + } else { + None + }; + + let mut diagnostic = Diagnostic::new( + Airflow3Removal { + deprecated: attr.to_string(), + replacement, + }, + attr.range(), + ); + if let Some(fix) = fix { + diagnostic.set_fix(fix); + } + checker.report_diagnostic(diagnostic); +} + +/// Check whether a removed Airflow name is used. +/// +/// For example: +/// +/// ```python +/// from airflow.operators import subdag +/// from airflow.operators.subdag import SubDagOperator +/// +/// # Accessing via attribute +/// subdag.SubDagOperator() +/// +/// # Or, directly +/// SubDagOperator() +/// ``` +fn check_name(checker: &Checker, expr: &Expr, range: TextRange) { + let semantic = checker.semantic(); + + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return; + }; + + let replacement = match qualified_name.segments() { + // airflow.PY\d{1,2} + [ + "airflow", + "PY36" | "PY37" | "PY38" | "PY39" | "PY310" | "PY311" | "PY312", + ] => Replacement::Message("Use `sys.version_info` instead"), + + // airflow.api_connexion.security + ["airflow", "api_connexion", "security", "requires_access"] => Replacement::Message( + "Use `airflow.api_fastapi.core_api.security.requires_access_*` instead", + ), + [ + "airflow", + "api_connexion", + "security", + "requires_access_dataset", + ] => Replacement::AutoImport { + module: "airflow.api_fastapi.core_api.security", + name: "requires_access_asset", + }, + + // airflow.auth.managers + [ + "airflow", + "auth", + "managers", + "base_auth_manager", + "BaseAuthManager", + ] => Replacement::AutoImport { + module: "airflow.api_fastapi.auth.managers.base_auth_manager", + name: "BaseAuthManager", + }, + [ + "airflow", + "auth", + "managers", + "models", + "resource_details", + "DatasetDetails", + ] => Replacement::AutoImport { + module: "airflow.api_fastapi.auth.managers.models.resource_details", + name: "AssetDetails", + }, + + // airflow.configuration + // TODO: check whether we could improve it + [ + "airflow", + "configuration", + rest @ ("as_dict" | "get" | "getboolean" | "getfloat" | "getint" | "has_option" + | "remove_option" | "set"), + ] => Replacement::SourceModuleMoved { + module: "airflow.configuration", + name: format!("conf.{rest}"), + }, + + // airflow.contrib.* + ["airflow", "contrib", ..] => { + Replacement::Message("The whole `airflow.contrib` module has been removed.") + } + + // airflow.datasets.manager + ["airflow", "datasets", "manager", rest] => match *rest { + "DatasetManager" => Replacement::AutoImport { + module: "airflow.assets.manager", + name: "AssetManager", + }, + "dataset_manager" => Replacement::AutoImport { + module: "airflow.assets.manager", + name: "asset_manager", + }, + "resolve_dataset_manager" => Replacement::AutoImport { + module: "airflow.assets.manager", + name: "resolve_asset_manager", + }, + _ => return, + }, + // airflow.datasets + ["airflow", "datasets", "DatasetAliasEvent"] => Replacement::None, + + // airflow.hooks + ["airflow", "hooks", "base_hook", "BaseHook"] => Replacement::AutoImport { + module: "airflow.hooks.base", + name: "BaseHook", + }, + + // airflow.lineage.hook + ["airflow", "lineage", "hook", "DatasetLineageInfo"] => Replacement::AutoImport { + module: "airflow.lineage.hook", + name: "AssetLineageInfo", + }, + + // airflow.listeners.spec + ["airflow", "listeners", "spec", "dataset", rest] => match *rest { + "on_dataset_created" => Replacement::AutoImport { + module: "airflow.listeners.spec.asset", + name: "on_asset_created", + }, + "on_dataset_changed" => Replacement::AutoImport { + module: "airflow.listeners.spec.asset", + name: "on_asset_changed", + }, + _ => return, + }, + + // airflow.metrics.validators + ["airflow", "metrics", "validators", rest] => match *rest { + "AllowListValidator" => Replacement::AutoImport { + module: "airflow.metrics.validators", + name: "PatternAllowListValidator", + }, + "BlockListValidator" => Replacement::AutoImport { + module: "airflow.metrics.validators", + name: "PatternBlockListValidator", + }, + _ => return, + }, + + // airflow.notifications + ["airflow", "notifications", "basenotifier", "BaseNotifier"] => Replacement::AutoImport { + module: "airflow.sdk.bases.notifier", + name: "BaseNotifier", + }, + + // airflow.operators + ["airflow", "operators", "subdag", ..] => { + Replacement::Message("The whole `airflow.subdag` module has been removed.") + } + ["airflow", "operators", "python", "get_current_context"] => Replacement::AutoImport { + module: "airflow.sdk", + name: "get_current_context", + }, + + // airflow.secrets + ["airflow", "secrets", "local_filesystem", "load_connections"] => Replacement::AutoImport { + module: "airflow.secrets.local_filesystem", + name: "load_connections_dict", + }, + + // airflow.security + ["airflow", "security", "permissions", "RESOURCE_DATASET"] => Replacement::AutoImport { + module: "airflow.security.permissions", + name: "RESOURCE_ASSET", + }, + + // airflow.sensors + [ + "airflow", + "sensors", + "base_sensor_operator", + "BaseSensorOperator", + ] => Replacement::AutoImport { + module: "airflow.sdk.bases.sensor", + name: "BaseSensorOperator", + }, + + // airflow.timetables + [ + "airflow", + "timetables", + "simple", + "DatasetTriggeredTimetable", + ] => Replacement::AutoImport { + module: "airflow.timetables.simple", + name: "AssetTriggeredTimetable", + }, + + // airflow.triggers + ["airflow", "triggers", "external_task", "TaskStateTrigger"] => Replacement::None, + + // airflow.utils + ["airflow", "utils", rest @ ..] => match &rest { + // airflow.utils.dag_cycle_tester + ["dag_cycle_tester", "test_cycle"] => Replacement::None, + + // airflow.utils.db + ["db", "create_session"] => Replacement::None, + + // airflow.utils.decorators + ["decorators", "apply_defaults"] => Replacement::Message( + "`apply_defaults` is now unconditionally done and can be safely removed.", + ), + + // airflow.utils.dates + ["dates", "date_range"] => Replacement::None, + ["dates", "days_ago"] => { + Replacement::Message("Use `pendulum.today('UTC').add(days=-N, ...)` instead") + } + [ + "dates", + "parse_execution_date" | "round_time" | "scale_time_units" | "infer_time_unit", + ] => Replacement::None, + + // airflow.utils.file + ["file", "TemporaryDirectory"] => Replacement::AutoImport { + module: "tempfile", + name: "TemporaryDirectory", + }, + ["file", "mkdirs"] => Replacement::Message("Use `pathlib.Path({path}).mkdir` instead"), + + // airflow.utils.helpers + ["helpers", "chain"] => Replacement::AutoImport { + module: "airflow.sdk", + name: "chain", + }, + ["helpers", "cross_downstream"] => Replacement::AutoImport { + module: "airflow.sdk", + name: "cross_downstream", + }, + + // TODO: update it as SourceModuleMoved + // airflow.utils.log.secrets_masker + ["log", "secrets_masker"] => Replacement::AutoImport { + module: "airflow.sdk.execution_time", + name: "secrets_masker", + }, + + // airflow.utils.state + ["state", "SHUTDOWN" | "terminating_states"] => Replacement::None, + + // airflow.utils.trigger_rule + [ + "trigger_rule", + "TriggerRule", + "DUMMY" | "NONE_FAILED_OR_SKIPPED", + ] => Replacement::None, + _ => return, + }, + + // airflow.www + [ + "airflow", + "www", + "auth", + "has_access" | "has_access_dataset", + ] => Replacement::None, + [ + "airflow", + "www", + "utils", + "get_sensitive_variables_fields" | "should_hide_value_for_key", + ] => Replacement::None, + + // airflow.providers.amazon + [ + "airflow", + "providers", + "amazon", + "aws", + "datasets", + "s3", + rest, + ] => match *rest { + "create_dataset" => Replacement::AutoImport { + module: "airflow.providers.amazon.aws.assets.s3", + name: "create_asset", + }, + "convert_dataset_to_openlineage" => Replacement::AutoImport { + module: "airflow.providers.amazon.aws.assets.s3", + name: "convert_asset_to_openlineage", + }, + "sanitize_uri" => Replacement::AutoImport { + module: "airflow.providers.amazon.aws.assets.s3", + name: "sanitize_uri", + }, + _ => return, + }, + [ + "airflow", + "providers", + "amazon", + "aws", + "auth_manager", + "avp", + "entities", + "AvpEntities", + "DATASET", + ] => Replacement::AutoImport { + module: "airflow.providers.amazon.aws.auth_manager.avp.entities", + name: "AvpEntities.ASSET", + }, + + // airflow.providers.common.io + // airflow.providers.common.io.datasets.file + [ + "airflow", + "providers", + "common", + "io", + "datasets", + "file", + rest, + ] => match *rest { + "create_dataset" => Replacement::AutoImport { + module: "airflow.providers.common.io.assets.file", + name: "create_asset", + }, + "convert_dataset_to_openlineage" => Replacement::AutoImport { + module: "airflow.providers.common.io.assets.file", + name: "convert_asset_to_openlineage", + }, + "sanitize_uri" => Replacement::AutoImport { + module: "airflow.providers.common.io.assets.file", + name: "sanitize_uri", + }, + _ => return, + }, + + // airflow.providers.google + // airflow.providers.google.datasets + ["airflow", "providers", "google", "datasets", rest @ ..] => match &rest { + ["bigquery", "create_dataset"] => Replacement::AutoImport { + module: "airflow.providers.google.assets.bigquery", + name: "create_asset", + }, + ["gcs", "create_dataset"] => Replacement::AutoImport { + module: "airflow.providers.google.assets.gcs", + name: "create_asset", + }, + ["gcs", "convert_dataset_to_openlineage"] => Replacement::AutoImport { + module: "airflow.providers.google.assets.gcs", + name: "convert_asset_to_openlineage", + }, + ["gcs", "sanitize_uri"] => Replacement::AutoImport { + module: "airflow.providers.google.assets.gcs", + name: "sanitize_uri", + }, + + _ => return, + }, + + // airflow.providers.mysql + [ + "airflow", + "providers", + "mysql", + "datasets", + "mysql", + "sanitize_uri", + ] => Replacement::AutoImport { + module: "airflow.providers.mysql.assets.mysql", + name: "sanitize_uri", + }, + + // airflow.providers.postgres + [ + "airflow", + "providers", + "postgres", + "datasets", + "postgres", + "sanitize_uri", + ] => Replacement::AutoImport { + module: "airflow.providers.postgres.assets.postgres", + name: "sanitize_uri", + }, + + // airflow.providers.openlineage + // airflow.providers.openlineage.utils.utils + [ + "airflow", + "providers", + "openlineage", + "utils", + "utils", + rest, + ] => match *rest { + "DatasetInfo" => Replacement::AutoImport { + module: "airflow.providers.openlineage.utils.utils", + name: "AssetInfo", + }, + + "translate_airflow_dataset" => Replacement::AutoImport { + module: "airflow.providers.openlineage.utils.utils", + name: "translate_airflow_asset", + }, + _ => return, + }, + + // airflow.providers.trino + [ + "airflow", + "providers", + "trino", + "datasets", + "trino", + "sanitize_uri", + ] => Replacement::AutoImport { + module: "airflow.providers.trino.assets.trino", + name: "sanitize_uri", + }, + + _ => return, + }; + + let mut diagnostic = Diagnostic::new( + Airflow3Removal { + deprecated: qualified_name.to_string(), + replacement: replacement.clone(), + }, + range, + ); + let semantic = checker.semantic(); + if let Some((module, name)) = match &replacement { + Replacement::AutoImport { module, name } => Some((module, *name)), + Replacement::SourceModuleMoved { module, name } => Some((module, name.as_str())), + _ => None, + } { + if is_guarded_by_try_except(expr, module, name, semantic) { + return; + } + + let import_target = name.split('.').next().unwrap_or(name); + + diagnostic.try_set_fix(|| { + let (import_edit, _) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from(module, import_target), + expr.start(), + checker.semantic(), + )?; + let replacement_edit = Edit::range_replacement(name.to_string(), range); + Ok(Fix::safe_edits(import_edit, [replacement_edit])) + }); + } + + checker.report_diagnostic(diagnostic); +} + +/// Check whether a customized Airflow plugin contains removed extensions. +/// +/// For example: +/// +/// ```python +/// from airflow.plugins_manager import AirflowPlugin +/// +/// +/// class CustomizePlugin(AirflowPlugin) +/// executors = "some.third.party.executor" +/// ``` +fn check_airflow_plugin_extension( + checker: &Checker, + expr: &Expr, + name: &str, + class_def: &StmtClassDef, +) { + if matches!(name, "executors" | "operators" | "sensors" | "hooks") { + if class_def.bases().iter().any(|class_base| { + checker + .semantic() + .resolve_qualified_name(class_base) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["airflow", "plugins_manager", "AirflowPlugin"] + ) + }) + }) { + checker.report_diagnostic(Diagnostic::new( + Airflow3Removal { + deprecated: name.to_string(), + replacement: Replacement::Message( + "This extension should just be imported as a regular python module.", + ), + }, + expr.range(), + )); + } + } +} + +/// Check if the `deprecated` keyword argument is being used and create a diagnostic if so along +/// with a possible `replacement`. +fn diagnostic_for_argument( + checker: &Checker, + arguments: &Arguments, + deprecated: &str, + replacement: Option<&'static str>, +) { + let Some(keyword) = arguments.find_keyword(deprecated) else { + return; + }; + let mut diagnostic = Diagnostic::new( + Airflow3Removal { + deprecated: deprecated.to_string(), + replacement: match replacement { + Some(name) => Replacement::AttrName(name), + None => Replacement::None, + }, + }, + keyword + .arg + .as_ref() + .map_or_else(|| keyword.range(), Ranged::range), + ); + + if let Some(replacement) = replacement { + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + replacement.to_string(), + diagnostic.range, + ))); + } + + checker.report_diagnostic(diagnostic); +} + +/// Check whether the symbol is coming from the `secrets` builtin or provider module which ends +/// with `Backend`. +fn is_airflow_secret_backend(segments: &[&str]) -> bool { + is_airflow_builtin_or_provider(segments, "secrets", "Backend") +} + +/// Check whether the symbol is coming from the `hooks` builtin or provider module which ends +/// with `Hook`. +fn is_airflow_hook(segments: &[&str]) -> bool { + is_airflow_builtin_or_provider(segments, "hooks", "Hook") +} + +/// Check whether the symbol is coming from the `log` builtin or provider module which ends +/// with `TaskHandler`. +fn is_airflow_task_handler(segments: &[&str]) -> bool { + is_airflow_builtin_or_provider(segments, "log", "TaskHandler") +} + +/// Check whether the symbol is coming from the `auth.manager` builtin or provider `auth_manager` module which ends +/// with `AuthManager`. +fn is_airflow_auth_manager(segments: &[&str]) -> bool { + match segments { + ["airflow", "auth", "manager", rest @ ..] => { + if let Some(last_element) = rest.last() { + last_element.ends_with("AuthManager") + } else { + false + } + } + + ["airflow", "providers", rest @ ..] => { + if let (Some(pos), Some(last_element)) = + (rest.iter().position(|&s| s == "auth_manager"), rest.last()) + { + pos + 1 < rest.len() && last_element.ends_with("AuthManager") + } else { + false + } + } + + _ => false, + } +} + +/// Returns `true` if the current statement hierarchy has a function that's decorated with +/// `@airflow.decorators.task`. +fn in_airflow_task_function(semantic: &SemanticModel) -> bool { + semantic + .current_statements() + .find_map(|stmt| stmt.as_function_def_stmt()) + .is_some_and(|function_def| is_airflow_task(function_def, semantic)) +} + +/// Returns `true` if the given function is decorated with `@airflow.decorators.task`. +fn is_airflow_task(function_def: &StmtFunctionDef, semantic: &SemanticModel) -> bool { + function_def.decorator_list.iter().any(|decorator| { + semantic + .resolve_qualified_name(map_callable(&decorator.expression)) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["airflow", "decorators", "task"]) + }) + }) +} + +/// Check it's "execute" method inherits from Airflow base operator +/// +/// For example: +/// +/// ```python +/// from airflow.models.baseoperator import BaseOperator +/// +/// class CustomOperator(BaseOperator): +/// def execute(self): +/// pass +/// ``` +fn is_execute_method_inherits_from_airflow_operator( + function_def: &StmtFunctionDef, + semantic: &SemanticModel, +) -> bool { + if function_def.name.as_str() != "execute" { + return false; + } + + let ScopeKind::Class(class_def) = semantic.current_scope().kind else { + return false; + }; + + class_def.bases().iter().any(|class_base| { + semantic + .resolve_qualified_name(class_base) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["airflow", .., "BaseOperator"]) + }) + }) +} diff --git a/crates/ruff_linter/src/rules/airflow/rules/suggested_to_move_to_provider_in_3.rs b/crates/ruff_linter/src/rules/airflow/rules/suggested_to_move_to_provider_in_3.rs new file mode 100644 index 0000000000000..2f491e24c057b --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/rules/suggested_to_move_to_provider_in_3.rs @@ -0,0 +1,315 @@ +use crate::importer::ImportRequest; + +use crate::rules::airflow::helpers::{ProviderReplacement, is_guarded_by_try_except}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprAttribute}; +use ruff_python_semantic::Modules; +use ruff_text_size::Ranged; +use ruff_text_size::TextRange; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for uses of Airflow functions and values that have been moved to its providers +/// but still have a compatibility layer (e.g., `apache-airflow-providers-standard`). +/// +/// ## Why is this bad? +/// Airflow 3.0 moved various deprecated functions, members, and other +/// values to its providers. Even though these symbols still work fine on Airflow 3.0, +/// they are expected to be removed in a future version. The user is suggested to install +/// the corresponding provider and replace the original usage with the one in the provider. +/// +/// ## Example +/// ```python +/// from airflow.operators.python import PythonOperator +/// ``` +/// +/// Use instead: +/// ```python +/// from airflow.providers.standard.operators.python import PythonOperator +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct Airflow3SuggestedToMoveToProvider { + deprecated: String, + replacement: ProviderReplacement, +} + +impl Violation for Airflow3SuggestedToMoveToProvider { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] + fn message(&self) -> String { + let Airflow3SuggestedToMoveToProvider { + deprecated, + replacement, + } = self; + match replacement { + ProviderReplacement::None => { + format!("`{deprecated}` is removed in Airflow 3.0") + } + ProviderReplacement::AutoImport { + name: _, + module: _, + provider, + version: _, + } + | ProviderReplacement::SourceModuleMovedToProvider { + name: _, + module: _, + provider, + version: _, + } => { + format!( + "`{deprecated}` is deprecated and moved into `{provider}` provider in Airflow 3.0; \ + It still works in Airflow 3.0 but is expected to be removed in a future version." + ) + } + } + } + + fn fix_title(&self) -> Option<String> { + let Airflow3SuggestedToMoveToProvider { replacement, .. } = self; + match replacement { + ProviderReplacement::None => None, + ProviderReplacement::AutoImport { + module, + name, + provider, + version, + } => Some(format!( + "Install `apache-airflow-providers-{provider}>={version}` and use `{module}.{name}` instead." + )), + ProviderReplacement::SourceModuleMovedToProvider { + module, + name, + provider, + version, + } => Some(format!( + "Install `apache-airflow-providers-{provider}>={version}` and use `{module}.{name}` instead." + )), + } + } +} + +// AIR312 +pub(crate) fn suggested_to_move_to_provider_in_3(checker: &Checker, expr: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + match expr { + Expr::Attribute(ExprAttribute { attr, .. }) => { + check_names_moved_to_provider(checker, expr, attr.range()); + } + Expr::Name(_) => check_names_moved_to_provider(checker, expr, expr.range()), + _ => {} + } +} + +fn check_names_moved_to_provider(checker: &Checker, expr: &Expr, ranged: TextRange) { + let Some(qualified_name) = checker.semantic().resolve_qualified_name(expr) else { + return; + }; + + let replacement = match qualified_name.segments() { + // apache-airflow-providers-standard + ["airflow", "hooks", "filesystem", "FSHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.hooks.filesystem", + name: "FSHook", + provider: "standard", + version: "0.0.1", + }, + ["airflow", "hooks", "package_index", "PackageIndexHook"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.hooks.package_index", + name: "PackageIndexHook", + provider: "standard", + version: "0.0.1", + } + } + ["airflow", "hooks", "subprocess", "SubprocessHook"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.hooks.subprocess", + name: "SubprocessHook", + provider: "standard", + version: "0.0.3", + }, + ["airflow", "operators", "bash", "BashOperator"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.bash", + name: "BashOperator", + provider: "standard", + version: "0.0.1", + }, + ["airflow", "operators", "datetime", "BranchDateTimeOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.datetime", + name: "BranchDateTimeOperator", + provider: "standard", + version: "0.0.1", + } + } + [ + "airflow", + "operators", + "trigger_dagrun", + "TriggerDagRunOperator", + ] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.trigger_dagrun", + name: "TriggerDagRunOperator", + provider: "standard", + version: "0.0.2", + }, + ["airflow", "operators", "empty", "EmptyOperator"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.empty", + name: "EmptyOperator", + provider: "standard", + version: "0.0.2", + }, + ["airflow", "operators", "latest_only", "LatestOnlyOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.latest_only", + name: "LatestOnlyOperator", + provider: "standard", + version: "0.0.3", + } + } + [ + "airflow", + "operators", + "python", + rest @ ("BranchPythonOperator" + | "PythonOperator" + | "PythonVirtualenvOperator" + | "ShortCircuitOperator"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.operators.python", + provider: "standard", + version: "0.0.1", + }, + ["airflow", "operators", "weekday", "BranchDayOfWeekOperator"] => { + ProviderReplacement::AutoImport { + module: "airflow.providers.standard.operators.weekday", + name: "BranchDayOfWeekOperator", + provider: "standard", + version: "0.0.1", + } + } + [ + "airflow", + "sensors", + "date_time", + rest @ ("DateTimeSensor" | "DateTimeSensorAsync"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.sensors.date_time", + provider: "standard", + version: "0.0.1", + }, + [ + "airflow", + "sensors", + "external_task", + rest @ ("ExternalTaskMarker" | "ExternalTaskSensor" | "ExternalTaskSensorLink"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.sensors.external_task", + provider: "standard", + version: "0.0.3", + }, + ["airflow", "sensors", "filesystem", "FileSensor"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.sensors.filesystem", + name: "FileSensor", + provider: "standard", + version: "0.0.2", + }, + [ + "airflow", + "sensors", + "time_sensor", + rest @ ("TimeSensor" | "TimeSensorAsync"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.sensors.time", + provider: "standard", + version: "0.0.1", + }, + [ + "airflow", + "sensors", + "time_delta", + rest @ ("TimeDeltaSensor" | "TimeDeltaSensorAsync"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.sensors.time_delta", + provider: "standard", + version: "0.0.1", + }, + ["airflow", "sensors", "weekday", "DayOfWeekSensor"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.sensors.weekday", + name: "DayOfWeekSensor", + provider: "standard", + version: "0.0.1", + }, + [ + "airflow", + "triggers", + "external_task", + rest @ ("DagStateTrigger" | "WorkflowTrigger"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.triggers.external_task", + provider: "standard", + version: "0.0.3", + }, + ["airflow", "triggers", "file", "FileTrigger"] => ProviderReplacement::AutoImport { + module: "airflow.providers.standard.triggers.file", + name: "FileTrigger", + provider: "standard", + version: "0.0.3", + }, + [ + "airflow", + "triggers", + "temporal", + rest @ ("DateTimeTrigger" | "TimeDeltaTrigger"), + ] => ProviderReplacement::SourceModuleMovedToProvider { + name: (*rest).to_string(), + module: "airflow.providers.standard.triggers.temporal", + provider: "standard", + version: "0.0.3", + }, + _ => return, + }; + + let mut diagnostic = Diagnostic::new( + Airflow3SuggestedToMoveToProvider { + deprecated: qualified_name.to_string(), + replacement: replacement.clone(), + }, + ranged.range(), + ); + + let semantic = checker.semantic(); + if let Some((module, name)) = match &replacement { + ProviderReplacement::AutoImport { module, name, .. } => Some((module, *name)), + ProviderReplacement::SourceModuleMovedToProvider { module, name, .. } => { + Some((module, name.as_str())) + } + ProviderReplacement::None => None, + } { + if is_guarded_by_try_except(expr, module, name, semantic) { + return; + } + diagnostic.try_set_fix(|| { + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from(module, name), + expr.start(), + checker.semantic(), + )?; + let replacement_edit = Edit::range_replacement(binding, ranged.range()); + Ok(Fix::safe_edits(import_edit, [replacement_edit])) + }); + } + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/airflow/rules/suggested_to_update_3_0.rs b/crates/ruff_linter/src/rules/airflow/rules/suggested_to_update_3_0.rs new file mode 100644 index 0000000000000..c8a8e208d1ea8 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/rules/suggested_to_update_3_0.rs @@ -0,0 +1,316 @@ +use crate::checkers::ast::Checker; +use crate::importer::ImportRequest; +use crate::rules::airflow::helpers::{ + Replacement, is_airflow_builtin_or_provider, is_guarded_by_try_except, +}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Arguments, Expr, ExprAttribute, ExprCall, ExprName, name::QualifiedName}; +use ruff_python_semantic::Modules; +use ruff_text_size::Ranged; +use ruff_text_size::TextRange; + +/// ## What it does +/// Checks for uses of deprecated Airflow functions and values that still have +/// a compatibility layer. +/// +/// ## Why is this bad? +/// Airflow 3.0 removed various deprecated functions, members, and other +/// values. Some have more modern replacements. Others are considered too niche +/// and not worth to be maintained in Airflow. +/// Even though these symbols still work fine on Airflow 3.0, they are expected to be removed in a future version. +/// The user is suggested to replace the original usage with the new ones. +/// +/// ## Example +/// ```python +/// from airflow import Dataset +/// +/// +/// Dataset(uri="test://test/") +/// ``` +/// +/// Use instead: +/// ```python +/// from airflow.sdk import Asset +/// +/// +/// Asset(uri="test://test/") +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct Airflow3SuggestedUpdate { + deprecated: String, + replacement: Replacement, +} + +impl Violation for Airflow3SuggestedUpdate { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + let Airflow3SuggestedUpdate { + deprecated, + replacement, + } = self; + match replacement { + Replacement::None + | Replacement::AttrName(_) + | Replacement::Message(_) + | Replacement::AutoImport { module: _, name: _ } + | Replacement::SourceModuleMoved { module: _, name: _ } => { + format!( + "`{deprecated}` is removed in Airflow 3.0; \ + It still works in Airflow 3.0 but is expected to be removed in a future version." + ) + } + } + } + + fn fix_title(&self) -> Option<String> { + let Airflow3SuggestedUpdate { replacement, .. } = self; + match replacement { + Replacement::None => None, + Replacement::AttrName(name) => Some(format!("Use `{name}` instead")), + Replacement::Message(message) => Some((*message).to_string()), + Replacement::AutoImport { module, name } => { + Some(format!("Use `{module}.{name}` instead")) + } + Replacement::SourceModuleMoved { module, name } => { + Some(format!("Use `{module}.{name}` instead")) + } + } + } +} + +/// AIR311 +pub(crate) fn airflow_3_0_suggested_update_expr(checker: &Checker, expr: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + + match expr { + Expr::Call(ExprCall { + func, arguments, .. + }) => { + if let Some(qualified_name) = checker.semantic().resolve_qualified_name(func) { + check_call_arguments(checker, &qualified_name, arguments); + } + } + Expr::Attribute(ExprAttribute { attr, .. }) => { + check_name(checker, expr, attr.range()); + } + Expr::Name(ExprName { + id: _, + ctx: _, + range, + }) => { + check_name(checker, expr, *range); + } + _ => {} + } +} + +/// Check if the `deprecated` keyword argument is being used and create a diagnostic if so along +/// with a possible `replacement`. +fn diagnostic_for_argument( + checker: &Checker, + arguments: &Arguments, + deprecated: &str, + replacement: Option<&'static str>, +) { + let Some(keyword) = arguments.find_keyword(deprecated) else { + return; + }; + let mut diagnostic = Diagnostic::new( + Airflow3SuggestedUpdate { + deprecated: deprecated.to_string(), + replacement: match replacement { + Some(name) => Replacement::AttrName(name), + None => Replacement::None, + }, + }, + keyword + .arg + .as_ref() + .map_or_else(|| keyword.range(), Ranged::range), + ); + + if let Some(replacement) = replacement { + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + replacement.to_string(), + diagnostic.range, + ))); + } + + checker.report_diagnostic(diagnostic); +} +/// Check whether a removed Airflow argument is passed. +/// +/// For example: +/// +/// ```python +/// from airflow import DAG +/// +/// DAG(sla="@daily") +/// ``` +fn check_call_arguments(checker: &Checker, qualified_name: &QualifiedName, arguments: &Arguments) { + match qualified_name.segments() { + ["airflow", .., "DAG" | "dag"] => { + diagnostic_for_argument(checker, arguments, "sla_miss_callback", None); + } + segments => { + if is_airflow_builtin_or_provider(segments, "operators", "Operator") { + diagnostic_for_argument(checker, arguments, "sla", None); + } + } + } +} + +/// Check whether a removed Airflow name is used. +/// +/// For example: +/// +/// ```python +/// from airflow import Dataset +/// from airflow import datasets +/// +/// # Accessing via attribute +/// datasets.Dataset() +/// +/// # Or, directly +/// Dataset() +/// ``` +fn check_name(checker: &Checker, expr: &Expr, range: TextRange) { + let semantic = checker.semantic(); + + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return; + }; + + let replacement = match qualified_name.segments() { + // airflow.datasets.metadata + ["airflow", "datasets", "metadata", "Metadata"] => Replacement::AutoImport { + module: "airflow.sdk", + name: "Metadata", + }, + // airflow.datasets + ["airflow", "Dataset"] | ["airflow", "datasets", "Dataset"] => Replacement::AutoImport { + module: "airflow.sdk", + name: "Asset", + }, + ["airflow", "datasets", rest] => match *rest { + "DatasetAliasEvent" => Replacement::None, + "DatasetAlias" => Replacement::AutoImport { + module: "airflow.sdk", + name: "AssetAlias", + }, + "DatasetAll" => Replacement::AutoImport { + module: "airflow.sdk", + name: "AssetAll", + }, + "DatasetAny" => Replacement::AutoImport { + module: "airflow.sdk", + name: "AssetAny", + }, + "expand_alias_to_datasets" => Replacement::AutoImport { + module: "airflow.sdk", + name: "expand_alias_to_assets", + }, + _ => return, + }, + + // airflow.decorators + [ + "airflow", + "decorators", + rest @ ("dag" | "task" | "task_group" | "setup" | "teardown"), + ] => Replacement::SourceModuleMoved { + module: "airflow.sdk", + name: (*rest).to_string(), + }, + + // airflow.io + ["airflow", "io", "path", "ObjectStoragePath"] => Replacement::SourceModuleMoved { + module: "airflow.sdk", + name: "ObjectStoragePath".to_string(), + }, + ["airflow", "io", "storage", "attach"] => Replacement::SourceModuleMoved { + module: "airflow.sdk.io", + name: "attach".to_string(), + }, + + // airflow.models + ["airflow", "models", rest @ ("Connection" | "Variable")] => { + Replacement::SourceModuleMoved { + module: "airflow.sdk", + name: (*rest).to_string(), + } + } + + // airflow.models.baseoperator + [ + "airflow", + "models", + "baseoperator", + rest @ ("chain" | "chain_linear" | "cross_downstream"), + ] => Replacement::SourceModuleMoved { + module: "airflow.sdk", + name: (*rest).to_string(), + }, + ["airflow", "models", "baseoperatorlink", "BaseOperatorLink"] => Replacement::AutoImport { + module: "airflow.sdk.definitions.baseoperatorlink", + name: "BaseOperatorLink", + }, + // airflow.model..DAG + ["airflow", "models", .., "DAG"] => Replacement::SourceModuleMoved { + module: "airflow.sdk", + name: "DAG".to_string(), + }, + // airflow.timetables + ["airflow", "timetables", "datasets", "DatasetOrTimeSchedule"] => Replacement::AutoImport { + module: "airflow.timetables.assets", + name: "AssetOrTimeSchedule", + }, + // airflow.utils + [ + "airflow", + "utils", + "dag_parsing_context", + "get_parsing_context", + ] => Replacement::AutoImport { + module: "airflow.sdk", + name: "get_parsing_context", + }, + + _ => return, + }; + + let mut diagnostic = Diagnostic::new( + Airflow3SuggestedUpdate { + deprecated: qualified_name.to_string(), + replacement: replacement.clone(), + }, + range, + ); + + let semantic = checker.semantic(); + if let Some((module, name)) = match &replacement { + Replacement::AutoImport { module, name } => Some((module, *name)), + Replacement::SourceModuleMoved { module, name } => Some((module, name.as_str())), + _ => None, + } { + if is_guarded_by_try_except(expr, module, name, semantic) { + return; + } + diagnostic.try_set_fix(|| { + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from(module, name), + expr.start(), + checker.semantic(), + )?; + let replacement_edit = Edit::range_replacement(binding, range); + Ok(Fix::safe_edits(import_edit, [replacement_edit])) + }); + } + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/airflow/rules/task_variable_name.rs b/crates/ruff_linter/src/rules/airflow/rules/task_variable_name.rs index 9836f230e7b9b..72e62d15bc2c6 100644 --- a/crates/ruff_linter/src/rules/airflow/rules/task_variable_name.rs +++ b/crates/ruff_linter/src/rules/airflow/rules/task_variable_name.rs @@ -1,7 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::Expr; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -30,8 +31,8 @@ use crate::checkers::ast::Checker; /// /// my_task = PythonOperator(task_id="my_task") /// ``` -#[violation] -pub struct AirflowVariableNameTaskIdMismatch { +#[derive(ViolationMetadata)] +pub(crate) struct AirflowVariableNameTaskIdMismatch { task_id: String, } @@ -44,17 +45,17 @@ impl Violation for AirflowVariableNameTaskIdMismatch { } /// AIR001 -pub(crate) fn variable_name_task_id( - checker: &mut Checker, - targets: &[Expr], - value: &Expr, -) -> Option<Diagnostic> { +pub(crate) fn variable_name_task_id(checker: &Checker, targets: &[Expr], value: &Expr) { + if !checker.semantic().seen_module(Modules::AIRFLOW) { + return; + } + // If we have more than one target, we can't do anything. let [target] = targets else { - return None; + return; }; let Expr::Name(ast::ExprName { id, .. }) = target else { - return None; + return; }; // If the value is not a call, we can't do anything. @@ -62,33 +63,58 @@ pub(crate) fn variable_name_task_id( func, arguments, .. }) = value else { - return None; + return; }; - // If the function doesn't come from Airflow, we can't do anything. + // If the function doesn't come from Airflow's operators module (builtin or providers), we + // can't do anything. if !checker .semantic() .resolve_qualified_name(func) - .is_some_and(|qualified_name| matches!(qualified_name.segments()[0], "airflow")) + .is_some_and(|qualified_name| { + match qualified_name.segments() { + // Match `airflow.operators.*` + ["airflow", "operators", ..] => true, + + // Match `airflow.providers.**.operators.*` + ["airflow", "providers", rest @ ..] => { + // Ensure 'operators' exists somewhere in the middle + if let Some(pos) = rest.iter().position(|&s| s == "operators") { + pos + 1 < rest.len() // Check that 'operators' is not the last element + } else { + false + } + } + + _ => false, + } + }) { - return None; + return; } // If the call doesn't have a `task_id` keyword argument, we can't do anything. - let keyword = arguments.find_keyword("task_id")?; + let Some(keyword) = arguments.find_keyword("task_id") else { + return; + }; // If the keyword argument is not a string, we can't do anything. - let ast::ExprStringLiteral { value: task_id, .. } = keyword.value.as_string_literal_expr()?; + let Some(ast::ExprStringLiteral { value: task_id, .. }) = + keyword.value.as_string_literal_expr() + else { + return; + }; // If the target name is the same as the task_id, no violation. if task_id == id.as_str() { - return None; + return; } - Some(Diagnostic::new( + let diagnostic = Diagnostic::new( AirflowVariableNameTaskIdMismatch { task_id: task_id.to_string(), }, target.range(), - )) + ); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR001_AIR001.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR001_AIR001.py.snap index c4bf5bd7b9120..c2ed187615c33 100644 --- a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR001_AIR001.py.snap +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR001_AIR001.py.snap @@ -3,20 +3,27 @@ source: crates/ruff_linter/src/rules/airflow/mod.rs --- AIR001.py:11:1: AIR001 Task variable name should match the `task_id`: "my_task" | - 9 | my_task_2 = PythonOperator(callable=my_callable, task_id="my_task_2") -10 | -11 | incorrect_name = PythonOperator(task_id="my_task") +10 | my_task = PythonOperator(task_id="my_task", callable=my_callable) +11 | incorrect_name = PythonOperator(task_id="my_task") # AIR001 | ^^^^^^^^^^^^^^ AIR001 -12 | incorrect_name_2 = PythonOperator(callable=my_callable, task_id="my_task_2") +12 | +13 | my_task = AirbyteTriggerSyncOperator(task_id="my_task", callable=my_callable) | -AIR001.py:12:1: AIR001 Task variable name should match the `task_id`: "my_task_2" +AIR001.py:14:1: AIR001 Task variable name should match the `task_id`: "my_task" | -11 | incorrect_name = PythonOperator(task_id="my_task") -12 | incorrect_name_2 = PythonOperator(callable=my_callable, task_id="my_task_2") - | ^^^^^^^^^^^^^^^^ AIR001 -13 | -14 | from my_module import MyClass +13 | my_task = AirbyteTriggerSyncOperator(task_id="my_task", callable=my_callable) +14 | incorrect_name = AirbyteTriggerSyncOperator(task_id="my_task") # AIR001 + | ^^^^^^^^^^^^^^ AIR001 +15 | +16 | my_task = AppflowFlowRunOperator(task_id="my_task", callable=my_callable) | - +AIR001.py:17:1: AIR001 Task variable name should match the `task_id`: "my_task" + | +16 | my_task = AppflowFlowRunOperator(task_id="my_task", callable=my_callable) +17 | incorrect_name = AppflowFlowRunOperator(task_id="my_task") # AIR001 + | ^^^^^^^^^^^^^^ AIR001 +18 | +19 | # Consider only from the `airflow.operators` (or providers operators) module + | diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR002_AIR002.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR002_AIR002.py.snap new file mode 100644 index 0000000000000..11ab436c40691 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR002_AIR002.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR002.py:4:1: AIR002 DAG should have an explicit `schedule` argument + | +2 | from airflow.timetables.simple import NullTimetable +3 | +4 | DAG(dag_id="class_default_schedule") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR002 +5 | +6 | DAG(dag_id="class_schedule", schedule="@hourly") + | + +AIR002.py:13:2: AIR002 DAG should have an explicit `schedule` argument + | +13 | @dag() + | ^^^^^ AIR002 +14 | def decorator_default_schedule(): +15 | pass + | diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_airflow_plugin.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_airflow_plugin.py.snap new file mode 100644 index 0000000000000..173877e2d8aa2 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_airflow_plugin.py.snap @@ -0,0 +1,46 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_airflow_plugin.py:7:5: AIR301 `operators` is removed in Airflow 3.0 + | +5 | name = "test_plugin" +6 | # --- Invalid extensions start +7 | operators = [PluginOperator] + | ^^^^^^^^^ AIR301 +8 | sensors = [PluginSensorOperator] +9 | hooks = [PluginHook] + | + = help: This extension should just be imported as a regular python module. + +AIR301_airflow_plugin.py:8:5: AIR301 `sensors` is removed in Airflow 3.0 + | + 6 | # --- Invalid extensions start + 7 | operators = [PluginOperator] + 8 | sensors = [PluginSensorOperator] + | ^^^^^^^ AIR301 + 9 | hooks = [PluginHook] +10 | executors = [PluginExecutor] + | + = help: This extension should just be imported as a regular python module. + +AIR301_airflow_plugin.py:9:5: AIR301 `hooks` is removed in Airflow 3.0 + | + 7 | operators = [PluginOperator] + 8 | sensors = [PluginSensorOperator] + 9 | hooks = [PluginHook] + | ^^^^^ AIR301 +10 | executors = [PluginExecutor] +11 | # --- Invalid extensions end + | + = help: This extension should just be imported as a regular python module. + +AIR301_airflow_plugin.py:10:5: AIR301 `executors` is removed in Airflow 3.0 + | + 8 | sensors = [PluginSensorOperator] + 9 | hooks = [PluginHook] +10 | executors = [PluginExecutor] + | ^^^^^^^^^ AIR301 +11 | # --- Invalid extensions end +12 | macros = [plugin_macro] + | + = help: This extension should just be imported as a regular python module. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_args.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_args.py.snap new file mode 100644 index 0000000000000..af858937ab620 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_args.py.snap @@ -0,0 +1,288 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_args.py:21:39: AIR301 [*] `schedule_interval` is removed in Airflow 3.0 + | +19 | DAG(dag_id="class_schedule", schedule="@hourly") +20 | +21 | DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") + | ^^^^^^^^^^^^^^^^^ AIR301 +22 | +23 | DAG(dag_id="class_timetable", timetable=NullTimetable()) + | + = help: Use `schedule` instead + +ℹ Safe fix +18 18 | +19 19 | DAG(dag_id="class_schedule", schedule="@hourly") +20 20 | +21 |-DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") + 21 |+DAG(dag_id="class_schedule_interval", schedule="@hourly") +22 22 | +23 23 | DAG(dag_id="class_timetable", timetable=NullTimetable()) +24 24 | + +AIR301_args.py:23:31: AIR301 [*] `timetable` is removed in Airflow 3.0 + | +21 | DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") +22 | +23 | DAG(dag_id="class_timetable", timetable=NullTimetable()) + | ^^^^^^^^^ AIR301 + | + = help: Use `schedule` instead + +ℹ Safe fix +20 20 | +21 21 | DAG(dag_id="class_schedule_interval", schedule_interval="@hourly") +22 22 | +23 |-DAG(dag_id="class_timetable", timetable=NullTimetable()) + 23 |+DAG(dag_id="class_timetable", schedule=NullTimetable()) +24 24 | +25 25 | +26 26 | DAG(dag_id="class_fail_stop", fail_stop=True) + +AIR301_args.py:26:31: AIR301 [*] `fail_stop` is removed in Airflow 3.0 + | +26 | DAG(dag_id="class_fail_stop", fail_stop=True) + | ^^^^^^^^^ AIR301 +27 | +28 | DAG(dag_id="class_default_view", default_view="dag_default_view") + | + = help: Use `fail_fast` instead + +ℹ Safe fix +23 23 | DAG(dag_id="class_timetable", timetable=NullTimetable()) +24 24 | +25 25 | +26 |-DAG(dag_id="class_fail_stop", fail_stop=True) + 26 |+DAG(dag_id="class_fail_stop", fail_fast=True) +27 27 | +28 28 | DAG(dag_id="class_default_view", default_view="dag_default_view") +29 29 | + +AIR301_args.py:28:34: AIR301 `default_view` is removed in Airflow 3.0 + | +26 | DAG(dag_id="class_fail_stop", fail_stop=True) +27 | +28 | DAG(dag_id="class_default_view", default_view="dag_default_view") + | ^^^^^^^^^^^^ AIR301 +29 | +30 | DAG(dag_id="class_orientation", orientation="BT") + | + +AIR301_args.py:30:33: AIR301 `orientation` is removed in Airflow 3.0 + | +28 | DAG(dag_id="class_default_view", default_view="dag_default_view") +29 | +30 | DAG(dag_id="class_orientation", orientation="BT") + | ^^^^^^^^^^^ AIR301 +31 | +32 | allow_future_exec_dates_dag = DAG(dag_id="class_allow_future_exec_dates") + | + +AIR301_args.py:41:6: AIR301 [*] `schedule_interval` is removed in Airflow 3.0 + | +41 | @dag(schedule_interval="0 * * * *") + | ^^^^^^^^^^^^^^^^^ AIR301 +42 | def decorator_schedule_interval(): +43 | pass + | + = help: Use `schedule` instead + +ℹ Safe fix +38 38 | pass +39 39 | +40 40 | +41 |-@dag(schedule_interval="0 * * * *") + 41 |+@dag(schedule="0 * * * *") +42 42 | def decorator_schedule_interval(): +43 43 | pass +44 44 | + +AIR301_args.py:46:6: AIR301 [*] `timetable` is removed in Airflow 3.0 + | +46 | @dag(timetable=NullTimetable()) + | ^^^^^^^^^ AIR301 +47 | def decorator_timetable(): +48 | pass + | + = help: Use `schedule` instead + +ℹ Safe fix +43 43 | pass +44 44 | +45 45 | +46 |-@dag(timetable=NullTimetable()) + 46 |+@dag(schedule=NullTimetable()) +47 47 | def decorator_timetable(): +48 48 | pass +49 49 | + +AIR301_args.py:54:62: AIR301 [*] `execution_date` is removed in Airflow 3.0 + | +52 | def decorator_deprecated_operator_args(): +53 | trigger_dagrun_op = trigger_dagrun.TriggerDagRunOperator( +54 | task_id="trigger_dagrun_op1", trigger_dag_id="test", execution_date="2024-12-04" + | ^^^^^^^^^^^^^^ AIR301 +55 | ) +56 | trigger_dagrun_op2 = TriggerDagRunOperator( + | + = help: Use `logical_date` instead + +ℹ Safe fix +51 51 | @dag() +52 52 | def decorator_deprecated_operator_args(): +53 53 | trigger_dagrun_op = trigger_dagrun.TriggerDagRunOperator( +54 |- task_id="trigger_dagrun_op1", trigger_dag_id="test", execution_date="2024-12-04" + 54 |+ task_id="trigger_dagrun_op1", trigger_dag_id="test", logical_date="2024-12-04" +55 55 | ) +56 56 | trigger_dagrun_op2 = TriggerDagRunOperator( +57 57 | task_id="trigger_dagrun_op2", trigger_dag_id="test", execution_date="2024-12-04" + +AIR301_args.py:57:62: AIR301 [*] `execution_date` is removed in Airflow 3.0 + | +55 | ) +56 | trigger_dagrun_op2 = TriggerDagRunOperator( +57 | task_id="trigger_dagrun_op2", trigger_dag_id="test", execution_date="2024-12-04" + | ^^^^^^^^^^^^^^ AIR301 +58 | ) + | + = help: Use `logical_date` instead + +ℹ Safe fix +54 54 | task_id="trigger_dagrun_op1", trigger_dag_id="test", execution_date="2024-12-04" +55 55 | ) +56 56 | trigger_dagrun_op2 = TriggerDagRunOperator( +57 |- task_id="trigger_dagrun_op2", trigger_dag_id="test", execution_date="2024-12-04" + 57 |+ task_id="trigger_dagrun_op2", trigger_dag_id="test", logical_date="2024-12-04" +58 58 | ) +59 59 | +60 60 | branch_dt_op = datetime.BranchDateTimeOperator( + +AIR301_args.py:61:33: AIR301 [*] `use_task_execution_day` is removed in Airflow 3.0 + | +60 | branch_dt_op = datetime.BranchDateTimeOperator( +61 | task_id="branch_dt_op", use_task_execution_day=True, task_concurrency=5 + | ^^^^^^^^^^^^^^^^^^^^^^ AIR301 +62 | ) +63 | branch_dt_op2 = BranchDateTimeOperator( + | + = help: Use `use_task_logical_date` instead + +ℹ Safe fix +58 58 | ) +59 59 | +60 60 | branch_dt_op = datetime.BranchDateTimeOperator( +61 |- task_id="branch_dt_op", use_task_execution_day=True, task_concurrency=5 + 61 |+ task_id="branch_dt_op", use_task_logical_date=True, task_concurrency=5 +62 62 | ) +63 63 | branch_dt_op2 = BranchDateTimeOperator( +64 64 | task_id="branch_dt_op2", + +AIR301_args.py:61:62: AIR301 [*] `task_concurrency` is removed in Airflow 3.0 + | +60 | branch_dt_op = datetime.BranchDateTimeOperator( +61 | task_id="branch_dt_op", use_task_execution_day=True, task_concurrency=5 + | ^^^^^^^^^^^^^^^^ AIR301 +62 | ) +63 | branch_dt_op2 = BranchDateTimeOperator( + | + = help: Use `max_active_tis_per_dag` instead + +ℹ Safe fix +58 58 | ) +59 59 | +60 60 | branch_dt_op = datetime.BranchDateTimeOperator( +61 |- task_id="branch_dt_op", use_task_execution_day=True, task_concurrency=5 + 61 |+ task_id="branch_dt_op", use_task_execution_day=True, max_active_tis_per_dag=5 +62 62 | ) +63 63 | branch_dt_op2 = BranchDateTimeOperator( +64 64 | task_id="branch_dt_op2", + +AIR301_args.py:65:9: AIR301 [*] `use_task_execution_day` is removed in Airflow 3.0 + | +63 | branch_dt_op2 = BranchDateTimeOperator( +64 | task_id="branch_dt_op2", +65 | use_task_execution_day=True, + | ^^^^^^^^^^^^^^^^^^^^^^ AIR301 +66 | sla=timedelta(seconds=10), +67 | ) + | + = help: Use `use_task_logical_date` instead + +ℹ Safe fix +62 62 | ) +63 63 | branch_dt_op2 = BranchDateTimeOperator( +64 64 | task_id="branch_dt_op2", +65 |- use_task_execution_day=True, + 65 |+ use_task_logical_date=True, +66 66 | sla=timedelta(seconds=10), +67 67 | ) +68 68 | + +AIR301_args.py:92:9: AIR301 [*] `use_task_execution_day` is removed in Airflow 3.0 + | +90 | follow_task_ids_if_true=None, +91 | week_day=1, +92 | use_task_execution_day=True, + | ^^^^^^^^^^^^^^^^^^^^^^ AIR301 +93 | ) + | + = help: Use `use_task_logical_date` instead + +ℹ Safe fix +89 89 | follow_task_ids_if_false=None, +90 90 | follow_task_ids_if_true=None, +91 91 | week_day=1, +92 |- use_task_execution_day=True, + 92 |+ use_task_logical_date=True, +93 93 | ) +94 94 | +95 95 | trigger_dagrun_op >> trigger_dagrun_op2 + +AIR301_args.py:102:15: AIR301 `filename_template` is removed in Airflow 3.0 + | +101 | # deprecated filename_template argument in FileTaskHandler +102 | S3TaskHandler(filename_template="/tmp/test") + | ^^^^^^^^^^^^^^^^^ AIR301 +103 | HdfsTaskHandler(filename_template="/tmp/test") +104 | ElasticsearchTaskHandler(filename_template="/tmp/test") + | + +AIR301_args.py:103:17: AIR301 `filename_template` is removed in Airflow 3.0 + | +101 | # deprecated filename_template argument in FileTaskHandler +102 | S3TaskHandler(filename_template="/tmp/test") +103 | HdfsTaskHandler(filename_template="/tmp/test") + | ^^^^^^^^^^^^^^^^^ AIR301 +104 | ElasticsearchTaskHandler(filename_template="/tmp/test") +105 | GCSTaskHandler(filename_template="/tmp/test") + | + +AIR301_args.py:104:26: AIR301 `filename_template` is removed in Airflow 3.0 + | +102 | S3TaskHandler(filename_template="/tmp/test") +103 | HdfsTaskHandler(filename_template="/tmp/test") +104 | ElasticsearchTaskHandler(filename_template="/tmp/test") + | ^^^^^^^^^^^^^^^^^ AIR301 +105 | GCSTaskHandler(filename_template="/tmp/test") + | + +AIR301_args.py:105:16: AIR301 `filename_template` is removed in Airflow 3.0 + | +103 | HdfsTaskHandler(filename_template="/tmp/test") +104 | ElasticsearchTaskHandler(filename_template="/tmp/test") +105 | GCSTaskHandler(filename_template="/tmp/test") + | ^^^^^^^^^^^^^^^^^ AIR301 +106 | +107 | FabAuthManager(None) + | + +AIR301_args.py:107:15: AIR301 `appbuilder` is removed in Airflow 3.0 + | +105 | GCSTaskHandler(filename_template="/tmp/test") +106 | +107 | FabAuthManager(None) + | ^^^^^^ AIR301 + | + = help: The constructor takes no parameter now diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_class_attribute.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_class_attribute.py.snap new file mode 100644 index 0000000000000..64c7197140a8f --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_class_attribute.py.snap @@ -0,0 +1,670 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_class_attribute.py:25:19: AIR301 [*] `iter_datasets` is removed in Airflow 3.0 + | +23 | # airflow.Dataset +24 | dataset_from_root = DatasetFromRoot() +25 | dataset_from_root.iter_datasets() + | ^^^^^^^^^^^^^ AIR301 +26 | dataset_from_root.iter_dataset_aliases() + | + = help: Use `iter_assets` instead + +ℹ Safe fix +22 22 | +23 23 | # airflow.Dataset +24 24 | dataset_from_root = DatasetFromRoot() +25 |-dataset_from_root.iter_datasets() + 25 |+dataset_from_root.iter_assets() +26 26 | dataset_from_root.iter_dataset_aliases() +27 27 | +28 28 | # airflow.datasets + +AIR301_class_attribute.py:26:19: AIR301 [*] `iter_dataset_aliases` is removed in Airflow 3.0 + | +24 | dataset_from_root = DatasetFromRoot() +25 | dataset_from_root.iter_datasets() +26 | dataset_from_root.iter_dataset_aliases() + | ^^^^^^^^^^^^^^^^^^^^ AIR301 +27 | +28 | # airflow.datasets + | + = help: Use `iter_asset_aliases` instead + +ℹ Safe fix +23 23 | # airflow.Dataset +24 24 | dataset_from_root = DatasetFromRoot() +25 25 | dataset_from_root.iter_datasets() +26 |-dataset_from_root.iter_dataset_aliases() + 26 |+dataset_from_root.iter_asset_aliases() +27 27 | +28 28 | # airflow.datasets +29 29 | dataset_to_test_method_call = Dataset() + +AIR301_class_attribute.py:30:29: AIR301 [*] `iter_datasets` is removed in Airflow 3.0 + | +28 | # airflow.datasets +29 | dataset_to_test_method_call = Dataset() +30 | dataset_to_test_method_call.iter_datasets() + | ^^^^^^^^^^^^^ AIR301 +31 | dataset_to_test_method_call.iter_dataset_aliases() + | + = help: Use `iter_assets` instead + +ℹ Safe fix +27 27 | +28 28 | # airflow.datasets +29 29 | dataset_to_test_method_call = Dataset() +30 |-dataset_to_test_method_call.iter_datasets() + 30 |+dataset_to_test_method_call.iter_assets() +31 31 | dataset_to_test_method_call.iter_dataset_aliases() +32 32 | +33 33 | alias_to_test_method_call = DatasetAlias() + +AIR301_class_attribute.py:31:29: AIR301 [*] `iter_dataset_aliases` is removed in Airflow 3.0 + | +29 | dataset_to_test_method_call = Dataset() +30 | dataset_to_test_method_call.iter_datasets() +31 | dataset_to_test_method_call.iter_dataset_aliases() + | ^^^^^^^^^^^^^^^^^^^^ AIR301 +32 | +33 | alias_to_test_method_call = DatasetAlias() + | + = help: Use `iter_asset_aliases` instead + +ℹ Safe fix +28 28 | # airflow.datasets +29 29 | dataset_to_test_method_call = Dataset() +30 30 | dataset_to_test_method_call.iter_datasets() +31 |-dataset_to_test_method_call.iter_dataset_aliases() + 31 |+dataset_to_test_method_call.iter_asset_aliases() +32 32 | +33 33 | alias_to_test_method_call = DatasetAlias() +34 34 | alias_to_test_method_call.iter_datasets() + +AIR301_class_attribute.py:34:27: AIR301 [*] `iter_datasets` is removed in Airflow 3.0 + | +33 | alias_to_test_method_call = DatasetAlias() +34 | alias_to_test_method_call.iter_datasets() + | ^^^^^^^^^^^^^ AIR301 +35 | alias_to_test_method_call.iter_dataset_aliases() + | + = help: Use `iter_assets` instead + +ℹ Safe fix +31 31 | dataset_to_test_method_call.iter_dataset_aliases() +32 32 | +33 33 | alias_to_test_method_call = DatasetAlias() +34 |-alias_to_test_method_call.iter_datasets() + 34 |+alias_to_test_method_call.iter_assets() +35 35 | alias_to_test_method_call.iter_dataset_aliases() +36 36 | +37 37 | any_to_test_method_call = DatasetAny() + +AIR301_class_attribute.py:35:27: AIR301 [*] `iter_dataset_aliases` is removed in Airflow 3.0 + | +33 | alias_to_test_method_call = DatasetAlias() +34 | alias_to_test_method_call.iter_datasets() +35 | alias_to_test_method_call.iter_dataset_aliases() + | ^^^^^^^^^^^^^^^^^^^^ AIR301 +36 | +37 | any_to_test_method_call = DatasetAny() + | + = help: Use `iter_asset_aliases` instead + +ℹ Safe fix +32 32 | +33 33 | alias_to_test_method_call = DatasetAlias() +34 34 | alias_to_test_method_call.iter_datasets() +35 |-alias_to_test_method_call.iter_dataset_aliases() + 35 |+alias_to_test_method_call.iter_asset_aliases() +36 36 | +37 37 | any_to_test_method_call = DatasetAny() +38 38 | any_to_test_method_call.iter_datasets() + +AIR301_class_attribute.py:38:25: AIR301 [*] `iter_datasets` is removed in Airflow 3.0 + | +37 | any_to_test_method_call = DatasetAny() +38 | any_to_test_method_call.iter_datasets() + | ^^^^^^^^^^^^^ AIR301 +39 | any_to_test_method_call.iter_dataset_aliases() + | + = help: Use `iter_assets` instead + +ℹ Safe fix +35 35 | alias_to_test_method_call.iter_dataset_aliases() +36 36 | +37 37 | any_to_test_method_call = DatasetAny() +38 |-any_to_test_method_call.iter_datasets() + 38 |+any_to_test_method_call.iter_assets() +39 39 | any_to_test_method_call.iter_dataset_aliases() +40 40 | +41 41 | # airflow.datasets.manager + +AIR301_class_attribute.py:39:25: AIR301 [*] `iter_dataset_aliases` is removed in Airflow 3.0 + | +37 | any_to_test_method_call = DatasetAny() +38 | any_to_test_method_call.iter_datasets() +39 | any_to_test_method_call.iter_dataset_aliases() + | ^^^^^^^^^^^^^^^^^^^^ AIR301 +40 | +41 | # airflow.datasets.manager + | + = help: Use `iter_asset_aliases` instead + +ℹ Safe fix +36 36 | +37 37 | any_to_test_method_call = DatasetAny() +38 38 | any_to_test_method_call.iter_datasets() +39 |-any_to_test_method_call.iter_dataset_aliases() + 39 |+any_to_test_method_call.iter_asset_aliases() +40 40 | +41 41 | # airflow.datasets.manager +42 42 | dm = DatasetManager() + +AIR301_class_attribute.py:42:6: AIR301 [*] `airflow.datasets.manager.DatasetManager` is removed in Airflow 3.0 + | +41 | # airflow.datasets.manager +42 | dm = DatasetManager() + | ^^^^^^^^^^^^^^ AIR301 +43 | dm.register_dataset_change() +44 | dm.create_datasets() + | + = help: Use `airflow.assets.manager.AssetManager` instead + +ℹ Safe fix +19 19 | from airflow.providers_manager import ProvidersManager +20 20 | from airflow.secrets.base_secrets import BaseSecretsBackend +21 21 | from airflow.secrets.local_filesystem import LocalFilesystemBackend + 22 |+from airflow.assets.manager import AssetManager +22 23 | +23 24 | # airflow.Dataset +24 25 | dataset_from_root = DatasetFromRoot() +-------------------------------------------------------------------------------- +39 40 | any_to_test_method_call.iter_dataset_aliases() +40 41 | +41 42 | # airflow.datasets.manager +42 |-dm = DatasetManager() + 43 |+dm = AssetManager() +43 44 | dm.register_dataset_change() +44 45 | dm.create_datasets() +45 46 | dm.notify_dataset_created() + +AIR301_class_attribute.py:43:4: AIR301 [*] `register_dataset_change` is removed in Airflow 3.0 + | +41 | # airflow.datasets.manager +42 | dm = DatasetManager() +43 | dm.register_dataset_change() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +44 | dm.create_datasets() +45 | dm.notify_dataset_created() + | + = help: Use `register_asset_change` instead + +ℹ Safe fix +40 40 | +41 41 | # airflow.datasets.manager +42 42 | dm = DatasetManager() +43 |-dm.register_dataset_change() + 43 |+dm.register_asset_change() +44 44 | dm.create_datasets() +45 45 | dm.notify_dataset_created() +46 46 | dm.notify_dataset_changed() + +AIR301_class_attribute.py:44:4: AIR301 [*] `create_datasets` is removed in Airflow 3.0 + | +42 | dm = DatasetManager() +43 | dm.register_dataset_change() +44 | dm.create_datasets() + | ^^^^^^^^^^^^^^^ AIR301 +45 | dm.notify_dataset_created() +46 | dm.notify_dataset_changed() + | + = help: Use `create_assets` instead + +ℹ Safe fix +41 41 | # airflow.datasets.manager +42 42 | dm = DatasetManager() +43 43 | dm.register_dataset_change() +44 |-dm.create_datasets() + 44 |+dm.create_assets() +45 45 | dm.notify_dataset_created() +46 46 | dm.notify_dataset_changed() +47 47 | dm.notify_dataset_alias_created() + +AIR301_class_attribute.py:45:4: AIR301 [*] `notify_dataset_created` is removed in Airflow 3.0 + | +43 | dm.register_dataset_change() +44 | dm.create_datasets() +45 | dm.notify_dataset_created() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR301 +46 | dm.notify_dataset_changed() +47 | dm.notify_dataset_alias_created() + | + = help: Use `notify_asset_created` instead + +ℹ Safe fix +42 42 | dm = DatasetManager() +43 43 | dm.register_dataset_change() +44 44 | dm.create_datasets() +45 |-dm.notify_dataset_created() + 45 |+dm.notify_asset_created() +46 46 | dm.notify_dataset_changed() +47 47 | dm.notify_dataset_alias_created() +48 48 | + +AIR301_class_attribute.py:46:4: AIR301 [*] `notify_dataset_changed` is removed in Airflow 3.0 + | +44 | dm.create_datasets() +45 | dm.notify_dataset_created() +46 | dm.notify_dataset_changed() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR301 +47 | dm.notify_dataset_alias_created() + | + = help: Use `notify_asset_changed` instead + +ℹ Safe fix +43 43 | dm.register_dataset_change() +44 44 | dm.create_datasets() +45 45 | dm.notify_dataset_created() +46 |-dm.notify_dataset_changed() + 46 |+dm.notify_asset_changed() +47 47 | dm.notify_dataset_alias_created() +48 48 | +49 49 | # airflow.lineage.hook + +AIR301_class_attribute.py:47:4: AIR301 [*] `notify_dataset_alias_created` is removed in Airflow 3.0 + | +45 | dm.notify_dataset_created() +46 | dm.notify_dataset_changed() +47 | dm.notify_dataset_alias_created() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +48 | +49 | # airflow.lineage.hook + | + = help: Use `notify_asset_alias_created` instead + +ℹ Safe fix +44 44 | dm.create_datasets() +45 45 | dm.notify_dataset_created() +46 46 | dm.notify_dataset_changed() +47 |-dm.notify_dataset_alias_created() + 47 |+dm.notify_asset_alias_created() +48 48 | +49 49 | # airflow.lineage.hook +50 50 | dl_info = DatasetLineageInfo() + +AIR301_class_attribute.py:50:11: AIR301 [*] `airflow.lineage.hook.DatasetLineageInfo` is removed in Airflow 3.0 + | +49 | # airflow.lineage.hook +50 | dl_info = DatasetLineageInfo() + | ^^^^^^^^^^^^^^^^^^ AIR301 +51 | dl_info.dataset + | + = help: Use `airflow.lineage.hook.AssetLineageInfo` instead + +ℹ Safe fix +9 9 | DatasetAny, +10 10 | ) +11 11 | from airflow.datasets.manager import DatasetManager +12 |-from airflow.lineage.hook import DatasetLineageInfo, HookLineageCollector + 12 |+from airflow.lineage.hook import DatasetLineageInfo, HookLineageCollector, AssetLineageInfo +13 13 | from airflow.providers.amazon.aws.auth_manager.aws_auth_manager import AwsAuthManager +14 14 | from airflow.providers.apache.beam.hooks import BeamHook, NotAir302HookError +15 15 | from airflow.providers.google.cloud.secrets.secret_manager import ( +-------------------------------------------------------------------------------- +47 47 | dm.notify_dataset_alias_created() +48 48 | +49 49 | # airflow.lineage.hook +50 |-dl_info = DatasetLineageInfo() + 50 |+dl_info = AssetLineageInfo() +51 51 | dl_info.dataset +52 52 | +53 53 | hlc = HookLineageCollector() + +AIR301_class_attribute.py:51:9: AIR301 [*] `dataset` is removed in Airflow 3.0 + | +49 | # airflow.lineage.hook +50 | dl_info = DatasetLineageInfo() +51 | dl_info.dataset + | ^^^^^^^ AIR301 +52 | +53 | hlc = HookLineageCollector() + | + = help: Use `asset` instead + +ℹ Safe fix +48 48 | +49 49 | # airflow.lineage.hook +50 50 | dl_info = DatasetLineageInfo() +51 |-dl_info.dataset + 51 |+dl_info.asset +52 52 | +53 53 | hlc = HookLineageCollector() +54 54 | hlc.create_dataset() + +AIR301_class_attribute.py:54:5: AIR301 [*] `create_dataset` is removed in Airflow 3.0 + | +53 | hlc = HookLineageCollector() +54 | hlc.create_dataset() + | ^^^^^^^^^^^^^^ AIR301 +55 | hlc.add_input_dataset() +56 | hlc.add_output_dataset() + | + = help: Use `create_asset` instead + +ℹ Safe fix +51 51 | dl_info.dataset +52 52 | +53 53 | hlc = HookLineageCollector() +54 |-hlc.create_dataset() + 54 |+hlc.create_asset() +55 55 | hlc.add_input_dataset() +56 56 | hlc.add_output_dataset() +57 57 | hlc.collected_datasets() + +AIR301_class_attribute.py:55:5: AIR301 [*] `add_input_dataset` is removed in Airflow 3.0 + | +53 | hlc = HookLineageCollector() +54 | hlc.create_dataset() +55 | hlc.add_input_dataset() + | ^^^^^^^^^^^^^^^^^ AIR301 +56 | hlc.add_output_dataset() +57 | hlc.collected_datasets() + | + = help: Use `add_input_asset` instead + +ℹ Safe fix +52 52 | +53 53 | hlc = HookLineageCollector() +54 54 | hlc.create_dataset() +55 |-hlc.add_input_dataset() + 55 |+hlc.add_input_asset() +56 56 | hlc.add_output_dataset() +57 57 | hlc.collected_datasets() +58 58 | + +AIR301_class_attribute.py:56:5: AIR301 [*] `add_output_dataset` is removed in Airflow 3.0 + | +54 | hlc.create_dataset() +55 | hlc.add_input_dataset() +56 | hlc.add_output_dataset() + | ^^^^^^^^^^^^^^^^^^ AIR301 +57 | hlc.collected_datasets() + | + = help: Use `add_output_asset` instead + +ℹ Safe fix +53 53 | hlc = HookLineageCollector() +54 54 | hlc.create_dataset() +55 55 | hlc.add_input_dataset() +56 |-hlc.add_output_dataset() + 56 |+hlc.add_output_asset() +57 57 | hlc.collected_datasets() +58 58 | +59 59 | # airflow.providers.amazon.auth_manager.aws_auth_manager + +AIR301_class_attribute.py:57:5: AIR301 [*] `collected_datasets` is removed in Airflow 3.0 + | +55 | hlc.add_input_dataset() +56 | hlc.add_output_dataset() +57 | hlc.collected_datasets() + | ^^^^^^^^^^^^^^^^^^ AIR301 +58 | +59 | # airflow.providers.amazon.auth_manager.aws_auth_manager + | + = help: Use `collected_assets` instead + +ℹ Safe fix +54 54 | hlc.create_dataset() +55 55 | hlc.add_input_dataset() +56 56 | hlc.add_output_dataset() +57 |-hlc.collected_datasets() + 57 |+hlc.collected_assets() +58 58 | +59 59 | # airflow.providers.amazon.auth_manager.aws_auth_manager +60 60 | aam = AwsAuthManager() + +AIR301_class_attribute.py:61:5: AIR301 [*] `is_authorized_dataset` is removed in Airflow 3.0 + | +59 | # airflow.providers.amazon.auth_manager.aws_auth_manager +60 | aam = AwsAuthManager() +61 | aam.is_authorized_dataset() + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 +62 | +63 | # airflow.providers.apache.beam.hooks + | + = help: Use `is_authorized_asset` instead + +ℹ Safe fix +58 58 | +59 59 | # airflow.providers.amazon.auth_manager.aws_auth_manager +60 60 | aam = AwsAuthManager() +61 |-aam.is_authorized_dataset() + 61 |+aam.is_authorized_asset() +62 62 | +63 63 | # airflow.providers.apache.beam.hooks +64 64 | # check get_conn_uri is caught if the class inherits from an airflow hook + +AIR301_class_attribute.py:73:13: AIR301 [*] `get_conn_uri` is removed in Airflow 3.0 + | +71 | # airflow.providers.google.cloud.secrets.secret_manager +72 | csm_backend = CloudSecretManagerBackend() +73 | csm_backend.get_conn_uri() + | ^^^^^^^^^^^^ AIR301 +74 | csm_backend.get_connections() + | + = help: Use `get_conn_value` instead + +ℹ Safe fix +70 70 | +71 71 | # airflow.providers.google.cloud.secrets.secret_manager +72 72 | csm_backend = CloudSecretManagerBackend() +73 |-csm_backend.get_conn_uri() + 73 |+csm_backend.get_conn_value() +74 74 | csm_backend.get_connections() +75 75 | +76 76 | # airflow.providers.hashicorp.secrets.vault + +AIR301_class_attribute.py:74:13: AIR301 [*] `get_connections` is removed in Airflow 3.0 + | +72 | csm_backend = CloudSecretManagerBackend() +73 | csm_backend.get_conn_uri() +74 | csm_backend.get_connections() + | ^^^^^^^^^^^^^^^ AIR301 +75 | +76 | # airflow.providers.hashicorp.secrets.vault + | + = help: Use `get_connection` instead + +ℹ Safe fix +71 71 | # airflow.providers.google.cloud.secrets.secret_manager +72 72 | csm_backend = CloudSecretManagerBackend() +73 73 | csm_backend.get_conn_uri() +74 |-csm_backend.get_connections() + 74 |+csm_backend.get_connection() +75 75 | +76 76 | # airflow.providers.hashicorp.secrets.vault +77 77 | vault_backend = VaultBackend() + +AIR301_class_attribute.py:78:15: AIR301 [*] `get_conn_uri` is removed in Airflow 3.0 + | +76 | # airflow.providers.hashicorp.secrets.vault +77 | vault_backend = VaultBackend() +78 | vault_backend.get_conn_uri() + | ^^^^^^^^^^^^ AIR301 +79 | vault_backend.get_connections() + | + = help: Use `get_conn_value` instead + +ℹ Safe fix +75 75 | +76 76 | # airflow.providers.hashicorp.secrets.vault +77 77 | vault_backend = VaultBackend() +78 |-vault_backend.get_conn_uri() + 78 |+vault_backend.get_conn_value() +79 79 | vault_backend.get_connections() +80 80 | +81 81 | not_an_error = NotAir302SecretError() + +AIR301_class_attribute.py:79:15: AIR301 [*] `get_connections` is removed in Airflow 3.0 + | +77 | vault_backend = VaultBackend() +78 | vault_backend.get_conn_uri() +79 | vault_backend.get_connections() + | ^^^^^^^^^^^^^^^ AIR301 +80 | +81 | not_an_error = NotAir302SecretError() + | + = help: Use `get_connection` instead + +ℹ Safe fix +76 76 | # airflow.providers.hashicorp.secrets.vault +77 77 | vault_backend = VaultBackend() +78 78 | vault_backend.get_conn_uri() +79 |-vault_backend.get_connections() + 79 |+vault_backend.get_connection() +80 80 | +81 81 | not_an_error = NotAir302SecretError() +82 82 | not_an_error.get_conn_uri() + +AIR301_class_attribute.py:86:4: AIR301 [*] `initialize_providers_dataset_uri_resources` is removed in Airflow 3.0 + | +84 | # airflow.providers_manager +85 | pm = ProvidersManager() +86 | pm.initialize_providers_dataset_uri_resources() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +87 | pm.dataset_factories +88 | pm.dataset_uri_handlers + | + = help: Use `initialize_providers_asset_uri_resources` instead + +ℹ Safe fix +83 83 | +84 84 | # airflow.providers_manager +85 85 | pm = ProvidersManager() +86 |-pm.initialize_providers_dataset_uri_resources() + 86 |+pm.initialize_providers_asset_uri_resources() +87 87 | pm.dataset_factories +88 88 | pm.dataset_uri_handlers +89 89 | pm.dataset_to_openlineage_converters + +AIR301_class_attribute.py:87:4: AIR301 [*] `dataset_factories` is removed in Airflow 3.0 + | +85 | pm = ProvidersManager() +86 | pm.initialize_providers_dataset_uri_resources() +87 | pm.dataset_factories + | ^^^^^^^^^^^^^^^^^ AIR301 +88 | pm.dataset_uri_handlers +89 | pm.dataset_to_openlineage_converters + | + = help: Use `asset_factories` instead + +ℹ Safe fix +84 84 | # airflow.providers_manager +85 85 | pm = ProvidersManager() +86 86 | pm.initialize_providers_dataset_uri_resources() +87 |-pm.dataset_factories + 87 |+pm.asset_factories +88 88 | pm.dataset_uri_handlers +89 89 | pm.dataset_to_openlineage_converters +90 90 | + +AIR301_class_attribute.py:88:4: AIR301 [*] `dataset_uri_handlers` is removed in Airflow 3.0 + | +86 | pm.initialize_providers_dataset_uri_resources() +87 | pm.dataset_factories +88 | pm.dataset_uri_handlers + | ^^^^^^^^^^^^^^^^^^^^ AIR301 +89 | pm.dataset_to_openlineage_converters + | + = help: Use `asset_uri_handlers` instead + +ℹ Safe fix +85 85 | pm = ProvidersManager() +86 86 | pm.initialize_providers_dataset_uri_resources() +87 87 | pm.dataset_factories +88 |-pm.dataset_uri_handlers + 88 |+pm.asset_uri_handlers +89 89 | pm.dataset_to_openlineage_converters +90 90 | +91 91 | # airflow.secrets.base_secrets + +AIR301_class_attribute.py:89:4: AIR301 [*] `dataset_to_openlineage_converters` is removed in Airflow 3.0 + | +87 | pm.dataset_factories +88 | pm.dataset_uri_handlers +89 | pm.dataset_to_openlineage_converters + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +90 | +91 | # airflow.secrets.base_secrets + | + = help: Use `asset_to_openlineage_converters` instead + +ℹ Safe fix +86 86 | pm.initialize_providers_dataset_uri_resources() +87 87 | pm.dataset_factories +88 88 | pm.dataset_uri_handlers +89 |-pm.dataset_to_openlineage_converters + 89 |+pm.asset_to_openlineage_converters +90 90 | +91 91 | # airflow.secrets.base_secrets +92 92 | base_secret_backend = BaseSecretsBackend() + +AIR301_class_attribute.py:93:21: AIR301 [*] `get_conn_uri` is removed in Airflow 3.0 + | +91 | # airflow.secrets.base_secrets +92 | base_secret_backend = BaseSecretsBackend() +93 | base_secret_backend.get_conn_uri() + | ^^^^^^^^^^^^ AIR301 +94 | base_secret_backend.get_connections() + | + = help: Use `get_conn_value` instead + +ℹ Safe fix +90 90 | +91 91 | # airflow.secrets.base_secrets +92 92 | base_secret_backend = BaseSecretsBackend() +93 |-base_secret_backend.get_conn_uri() + 93 |+base_secret_backend.get_conn_value() +94 94 | base_secret_backend.get_connections() +95 95 | +96 96 | # airflow.secrets.local_filesystem + +AIR301_class_attribute.py:94:21: AIR301 [*] `get_connections` is removed in Airflow 3.0 + | +92 | base_secret_backend = BaseSecretsBackend() +93 | base_secret_backend.get_conn_uri() +94 | base_secret_backend.get_connections() + | ^^^^^^^^^^^^^^^ AIR301 +95 | +96 | # airflow.secrets.local_filesystem + | + = help: Use `get_connection` instead + +ℹ Safe fix +91 91 | # airflow.secrets.base_secrets +92 92 | base_secret_backend = BaseSecretsBackend() +93 93 | base_secret_backend.get_conn_uri() +94 |-base_secret_backend.get_connections() + 94 |+base_secret_backend.get_connection() +95 95 | +96 96 | # airflow.secrets.local_filesystem +97 97 | lfb = LocalFilesystemBackend() + +AIR301_class_attribute.py:98:5: AIR301 [*] `get_connections` is removed in Airflow 3.0 + | +96 | # airflow.secrets.local_filesystem +97 | lfb = LocalFilesystemBackend() +98 | lfb.get_connections() + | ^^^^^^^^^^^^^^^ AIR301 + | + = help: Use `get_connection` instead + +ℹ Safe fix +95 95 | +96 96 | # airflow.secrets.local_filesystem +97 97 | lfb = LocalFilesystemBackend() +98 |-lfb.get_connections() + 98 |+lfb.get_connection() diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_context.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_context.py.snap new file mode 100644 index 0000000000000..e8dfc9d9febd7 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_context.py.snap @@ -0,0 +1,326 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_context.py:22:41: AIR301 `conf` is removed in Airflow 3.0 + | +20 | @task +21 | def access_invalid_key_task_out_of_dag(**context): +22 | print("access invalid key", context["conf"]) + | ^^^^^^ AIR301 +23 | print("access invalid key", context.get("conf")) + | + +AIR301_context.py:23:45: AIR301 `conf` is removed in Airflow 3.0 + | +21 | def access_invalid_key_task_out_of_dag(**context): +22 | print("access invalid key", context["conf"]) +23 | print("access invalid key", context.get("conf")) + | ^^^^^^ AIR301 + | + +AIR301_context.py:28:5: AIR301 `execution_date` is removed in Airflow 3.0 + | +26 | @task +27 | def access_invalid_argument_task_out_of_dag( +28 | execution_date, tomorrow_ds, logical_date, **context + | ^^^^^^^^^^^^^^ AIR301 +29 | ): +30 | print("execution date", execution_date) + | + +AIR301_context.py:28:21: AIR301 `tomorrow_ds` is removed in Airflow 3.0 + | +26 | @task +27 | def access_invalid_argument_task_out_of_dag( +28 | execution_date, tomorrow_ds, logical_date, **context + | ^^^^^^^^^^^ AIR301 +29 | ): +30 | print("execution date", execution_date) + | + +AIR301_context.py:31:45: AIR301 `conf` is removed in Airflow 3.0 + | +29 | ): +30 | print("execution date", execution_date) +31 | print("access invalid key", context.get("conf")) + | ^^^^^^ AIR301 + | + +AIR301_context.py:40:30: AIR301 `execution_date` is removed in Airflow 3.0 + | +39 | # Removed usage - should trigger violations +40 | execution_date = context["execution_date"] + | ^^^^^^^^^^^^^^^^ AIR301 +41 | next_ds = context["next_ds"] +42 | next_ds_nodash = context["next_ds_nodash"] + | + +AIR301_context.py:41:23: AIR301 `next_ds` is removed in Airflow 3.0 + | +39 | # Removed usage - should trigger violations +40 | execution_date = context["execution_date"] +41 | next_ds = context["next_ds"] + | ^^^^^^^^^ AIR301 +42 | next_ds_nodash = context["next_ds_nodash"] +43 | next_execution_date = context["next_execution_date"] + | + +AIR301_context.py:42:30: AIR301 `next_ds_nodash` is removed in Airflow 3.0 + | +40 | execution_date = context["execution_date"] +41 | next_ds = context["next_ds"] +42 | next_ds_nodash = context["next_ds_nodash"] + | ^^^^^^^^^^^^^^^^ AIR301 +43 | next_execution_date = context["next_execution_date"] +44 | prev_ds = context["prev_ds"] + | + +AIR301_context.py:43:35: AIR301 `next_execution_date` is removed in Airflow 3.0 + | +41 | next_ds = context["next_ds"] +42 | next_ds_nodash = context["next_ds_nodash"] +43 | next_execution_date = context["next_execution_date"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 +44 | prev_ds = context["prev_ds"] +45 | prev_ds_nodash = context["prev_ds_nodash"] + | + +AIR301_context.py:44:23: AIR301 `prev_ds` is removed in Airflow 3.0 + | +42 | next_ds_nodash = context["next_ds_nodash"] +43 | next_execution_date = context["next_execution_date"] +44 | prev_ds = context["prev_ds"] + | ^^^^^^^^^ AIR301 +45 | prev_ds_nodash = context["prev_ds_nodash"] +46 | prev_execution_date = context["prev_execution_date"] + | + +AIR301_context.py:45:30: AIR301 `prev_ds_nodash` is removed in Airflow 3.0 + | +43 | next_execution_date = context["next_execution_date"] +44 | prev_ds = context["prev_ds"] +45 | prev_ds_nodash = context["prev_ds_nodash"] + | ^^^^^^^^^^^^^^^^ AIR301 +46 | prev_execution_date = context["prev_execution_date"] +47 | prev_execution_date_success = context["prev_execution_date_success"] + | + +AIR301_context.py:46:35: AIR301 `prev_execution_date` is removed in Airflow 3.0 + | +44 | prev_ds = context["prev_ds"] +45 | prev_ds_nodash = context["prev_ds_nodash"] +46 | prev_execution_date = context["prev_execution_date"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 +47 | prev_execution_date_success = context["prev_execution_date_success"] +48 | tomorrow_ds = context["tomorrow_ds"] + | + +AIR301_context.py:47:43: AIR301 `prev_execution_date_success` is removed in Airflow 3.0 + | +45 | prev_ds_nodash = context["prev_ds_nodash"] +46 | prev_execution_date = context["prev_execution_date"] +47 | prev_execution_date_success = context["prev_execution_date_success"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +48 | tomorrow_ds = context["tomorrow_ds"] +49 | yesterday_ds = context["yesterday_ds"] + | + +AIR301_context.py:48:27: AIR301 `tomorrow_ds` is removed in Airflow 3.0 + | +46 | prev_execution_date = context["prev_execution_date"] +47 | prev_execution_date_success = context["prev_execution_date_success"] +48 | tomorrow_ds = context["tomorrow_ds"] + | ^^^^^^^^^^^^^ AIR301 +49 | yesterday_ds = context["yesterday_ds"] +50 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | + +AIR301_context.py:49:28: AIR301 `yesterday_ds` is removed in Airflow 3.0 + | +47 | prev_execution_date_success = context["prev_execution_date_success"] +48 | tomorrow_ds = context["tomorrow_ds"] +49 | yesterday_ds = context["yesterday_ds"] + | ^^^^^^^^^^^^^^ AIR301 +50 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | + +AIR301_context.py:50:35: AIR301 `yesterday_ds_nodash` is removed in Airflow 3.0 + | +48 | tomorrow_ds = context["tomorrow_ds"] +49 | yesterday_ds = context["yesterday_ds"] +50 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 + | + +AIR301_context.py:56:30: AIR301 `execution_date` is removed in Airflow 3.0 + | +54 | def print_config_with_get_current_context(): +55 | context = get_current_context() +56 | execution_date = context["execution_date"] + | ^^^^^^^^^^^^^^^^ AIR301 +57 | next_ds = context["next_ds"] +58 | next_ds_nodash = context["next_ds_nodash"] + | + +AIR301_context.py:57:23: AIR301 `next_ds` is removed in Airflow 3.0 + | +55 | context = get_current_context() +56 | execution_date = context["execution_date"] +57 | next_ds = context["next_ds"] + | ^^^^^^^^^ AIR301 +58 | next_ds_nodash = context["next_ds_nodash"] +59 | next_execution_date = context["next_execution_date"] + | + +AIR301_context.py:58:30: AIR301 `next_ds_nodash` is removed in Airflow 3.0 + | +56 | execution_date = context["execution_date"] +57 | next_ds = context["next_ds"] +58 | next_ds_nodash = context["next_ds_nodash"] + | ^^^^^^^^^^^^^^^^ AIR301 +59 | next_execution_date = context["next_execution_date"] +60 | prev_ds = context["prev_ds"] + | + +AIR301_context.py:59:35: AIR301 `next_execution_date` is removed in Airflow 3.0 + | +57 | next_ds = context["next_ds"] +58 | next_ds_nodash = context["next_ds_nodash"] +59 | next_execution_date = context["next_execution_date"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 +60 | prev_ds = context["prev_ds"] +61 | prev_ds_nodash = context["prev_ds_nodash"] + | + +AIR301_context.py:60:23: AIR301 `prev_ds` is removed in Airflow 3.0 + | +58 | next_ds_nodash = context["next_ds_nodash"] +59 | next_execution_date = context["next_execution_date"] +60 | prev_ds = context["prev_ds"] + | ^^^^^^^^^ AIR301 +61 | prev_ds_nodash = context["prev_ds_nodash"] +62 | prev_execution_date = context["prev_execution_date"] + | + +AIR301_context.py:61:30: AIR301 `prev_ds_nodash` is removed in Airflow 3.0 + | +59 | next_execution_date = context["next_execution_date"] +60 | prev_ds = context["prev_ds"] +61 | prev_ds_nodash = context["prev_ds_nodash"] + | ^^^^^^^^^^^^^^^^ AIR301 +62 | prev_execution_date = context["prev_execution_date"] +63 | prev_execution_date_success = context["prev_execution_date_success"] + | + +AIR301_context.py:62:35: AIR301 `prev_execution_date` is removed in Airflow 3.0 + | +60 | prev_ds = context["prev_ds"] +61 | prev_ds_nodash = context["prev_ds_nodash"] +62 | prev_execution_date = context["prev_execution_date"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 +63 | prev_execution_date_success = context["prev_execution_date_success"] +64 | tomorrow_ds = context["tomorrow_ds"] + | + +AIR301_context.py:63:43: AIR301 `prev_execution_date_success` is removed in Airflow 3.0 + | +61 | prev_ds_nodash = context["prev_ds_nodash"] +62 | prev_execution_date = context["prev_execution_date"] +63 | prev_execution_date_success = context["prev_execution_date_success"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +64 | tomorrow_ds = context["tomorrow_ds"] +65 | yesterday_ds = context["yesterday_ds"] + | + +AIR301_context.py:64:27: AIR301 `tomorrow_ds` is removed in Airflow 3.0 + | +62 | prev_execution_date = context["prev_execution_date"] +63 | prev_execution_date_success = context["prev_execution_date_success"] +64 | tomorrow_ds = context["tomorrow_ds"] + | ^^^^^^^^^^^^^ AIR301 +65 | yesterday_ds = context["yesterday_ds"] +66 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | + +AIR301_context.py:65:28: AIR301 `yesterday_ds` is removed in Airflow 3.0 + | +63 | prev_execution_date_success = context["prev_execution_date_success"] +64 | tomorrow_ds = context["tomorrow_ds"] +65 | yesterday_ds = context["yesterday_ds"] + | ^^^^^^^^^^^^^^ AIR301 +66 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | + +AIR301_context.py:66:35: AIR301 `yesterday_ds_nodash` is removed in Airflow 3.0 + | +64 | tomorrow_ds = context["tomorrow_ds"] +65 | yesterday_ds = context["yesterday_ds"] +66 | yesterday_ds_nodash = context["yesterday_ds_nodash"] + | ^^^^^^^^^^^^^^^^^^^^^ AIR301 + | + +AIR301_context.py:73:22: AIR301 `tomorrow_ds` is removed in Airflow 3.0 + | +71 | """Print the Airflow context and ds variable from the context.""" +72 | print(ds) +73 | print(kwargs.get("tomorrow_ds")) + | ^^^^^^^^^^^^^ AIR301 +74 | c = get_current_context() +75 | c.get("execution_date") + | + +AIR301_context.py:75:11: AIR301 `execution_date` is removed in Airflow 3.0 + | +73 | print(kwargs.get("tomorrow_ds")) +74 | c = get_current_context() +75 | c.get("execution_date") + | ^^^^^^^^^^^^^^^^ AIR301 + | + +AIR301_context.py:87:49: AIR301 `conf` is removed in Airflow 3.0 + | +85 | @task() +86 | def access_invalid_key_task(**context): +87 | print("access invalid key", context.get("conf")) + | ^^^^^^ AIR301 +88 | +89 | @task() + | + +AIR301_context.py:90:42: AIR301 `execution_date` is removed in Airflow 3.0 + | +89 | @task() +90 | def access_invalid_key_explicit_task(execution_date): + | ^^^^^^^^^^^^^^ AIR301 +91 | print(execution_date) + | + +AIR301_context.py:111:5: AIR301 [*] `schedule_interval` is removed in Airflow 3.0 + | +109 | with DAG( +110 | dag_id="example_dag", +111 | schedule_interval="@daily", + | ^^^^^^^^^^^^^^^^^ AIR301 +112 | start_date=datetime(2023, 1, 1), +113 | template_searchpath=["/templates"], + | + = help: Use `schedule` instead + +ℹ Safe fix +108 108 | +109 109 | with DAG( +110 110 | dag_id="example_dag", +111 |- schedule_interval="@daily", + 111 |+ schedule="@daily", +112 112 | start_date=datetime(2023, 1, 1), +113 113 | template_searchpath=["/templates"], +114 114 | ) as dag: + +AIR301_context.py:135:23: AIR301 `next_ds` is removed in Airflow 3.0 + | +134 | class CustomOperator(BaseOperator): +135 | def execute(self, next_ds, context): + | ^^^^^^^ AIR301 +136 | execution_date = context["execution_date"] +137 | next_ds = context["next_ds"] + | diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names.py.snap new file mode 100644 index 0000000000000..3763881c29678 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names.py.snap @@ -0,0 +1,651 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_names.py:53:1: AIR301 `airflow.PY36` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:7: AIR301 `airflow.PY37` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:13: AIR301 `airflow.PY38` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:19: AIR301 `airflow.PY39` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:25: AIR301 `airflow.PY310` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:32: AIR301 `airflow.PY311` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:53:39: AIR301 `airflow.PY312` is removed in Airflow 3.0 + | +52 | # airflow root +53 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 + | ^^^^^ AIR301 +54 | +55 | # airflow.api_connexion.security + | + = help: Use `sys.version_info` instead + +AIR301_names.py:56:1: AIR301 `airflow.api_connexion.security.requires_access` is removed in Airflow 3.0 + | +55 | # airflow.api_connexion.security +56 | requires_access + | ^^^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.api_fastapi.core_api.security.requires_access_*` instead + +AIR301_names.py:60:1: AIR301 [*] `airflow.configuration.get` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^ AIR301 + | + = help: Use `airflow.configuration.conf.get` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+conf.get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:6: AIR301 [*] `airflow.configuration.getboolean` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.getboolean` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, conf.getboolean, getfloat, getint, has_option, remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:18: AIR301 [*] `airflow.configuration.getfloat` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.getfloat` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, conf.getfloat, getint, has_option, remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:28: AIR301 [*] `airflow.configuration.getint` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.getint` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, getfloat, conf.getint, has_option, remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:36: AIR301 [*] `airflow.configuration.has_option` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.has_option` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, getfloat, getint, conf.has_option, remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:48: AIR301 [*] `airflow.configuration.remove_option` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.remove_option` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, getfloat, getint, has_option, conf.remove_option, as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:63: AIR301 [*] `airflow.configuration.as_dict` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^^^^^ AIR301 + | + = help: Use `airflow.configuration.conf.as_dict` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, getfloat, getint, has_option, remove_option, conf.as_dict, set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:60:72: AIR301 [*] `airflow.configuration.set` is removed in Airflow 3.0 + | +59 | # airflow.configuration +60 | get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + | ^^^ AIR301 + | + = help: Use `airflow.configuration.conf.set` instead + +ℹ Safe fix +19 19 | has_option, +20 20 | remove_option, +21 21 | set, + 22 |+conf, +22 23 | ) +23 24 | from airflow.contrib.aws_athena_hook import AWSAthenaHook +24 25 | from airflow.datasets import DatasetAliasEvent +-------------------------------------------------------------------------------- +57 58 | +58 59 | +59 60 | # airflow.configuration +60 |-get, getboolean, getfloat, getint, has_option, remove_option, as_dict, set + 61 |+get, getboolean, getfloat, getint, has_option, remove_option, as_dict, conf.set +61 62 | +62 63 | +63 64 | # airflow.contrib.* + +AIR301_names.py:64:1: AIR301 `airflow.contrib.aws_athena_hook.AWSAthenaHook` is removed in Airflow 3.0 + | +63 | # airflow.contrib.* +64 | AWSAthenaHook() + | ^^^^^^^^^^^^^ AIR301 + | + = help: The whole `airflow.contrib` module has been removed. + +AIR301_names.py:68:1: AIR301 `airflow.datasets.DatasetAliasEvent` is removed in Airflow 3.0 + | +67 | # airflow.datasets +68 | DatasetAliasEvent() + | ^^^^^^^^^^^^^^^^^ AIR301 + | + +AIR301_names.py:72:1: AIR301 `airflow.hooks.base_hook.BaseHook` is removed in Airflow 3.0 + | +71 | # airflow.hooks +72 | BaseHook() + | ^^^^^^^^ AIR301 + | + = help: Use `airflow.hooks.base.BaseHook` instead + +AIR301_names.py:76:1: AIR301 `airflow.operators.subdag.SubDagOperator` is removed in Airflow 3.0 + | +75 | # airflow.operators.subdag.* +76 | SubDagOperator() + | ^^^^^^^^^^^^^^ AIR301 + | + = help: The whole `airflow.subdag` module has been removed. + +AIR301_names.py:85:1: AIR301 `airflow.sensors.base_sensor_operator.BaseSensorOperator` is removed in Airflow 3.0 + | +84 | # airflow.sensors.base_sensor_operator +85 | BaseSensorOperator() + | ^^^^^^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.sdk.bases.sensor.BaseSensorOperator` instead + +AIR301_names.py:89:1: AIR301 `airflow.triggers.external_task.TaskStateTrigger` is removed in Airflow 3.0 + | +88 | # airflow.triggers.external_task +89 | TaskStateTrigger() + | ^^^^^^^^^^^^^^^^ AIR301 +90 | +91 | # airflow.utils.date + | + +AIR301_names.py:92:1: AIR301 `airflow.utils.dates.date_range` is removed in Airflow 3.0 + | +91 | # airflow.utils.date +92 | dates.date_range + | ^^^^^^^^^^^^^^^^ AIR301 +93 | dates.days_ago + | + +AIR301_names.py:93:1: AIR301 `airflow.utils.dates.days_ago` is removed in Airflow 3.0 + | +91 | # airflow.utils.date +92 | dates.date_range +93 | dates.days_ago + | ^^^^^^^^^^^^^^ AIR301 +94 | +95 | date_range + | + = help: Use `pendulum.today('UTC').add(days=-N, ...)` instead + +AIR301_names.py:95:1: AIR301 `airflow.utils.dates.date_range` is removed in Airflow 3.0 + | +93 | dates.days_ago +94 | +95 | date_range + | ^^^^^^^^^^ AIR301 +96 | days_ago +97 | infer_time_unit + | + +AIR301_names.py:96:1: AIR301 `airflow.utils.dates.days_ago` is removed in Airflow 3.0 + | +95 | date_range +96 | days_ago + | ^^^^^^^^ AIR301 +97 | infer_time_unit +98 | parse_execution_date + | + = help: Use `pendulum.today('UTC').add(days=-N, ...)` instead + +AIR301_names.py:97:1: AIR301 `airflow.utils.dates.infer_time_unit` is removed in Airflow 3.0 + | +95 | date_range +96 | days_ago +97 | infer_time_unit + | ^^^^^^^^^^^^^^^ AIR301 +98 | parse_execution_date +99 | round_time + | + +AIR301_names.py:98:1: AIR301 `airflow.utils.dates.parse_execution_date` is removed in Airflow 3.0 + | + 96 | days_ago + 97 | infer_time_unit + 98 | parse_execution_date + | ^^^^^^^^^^^^^^^^^^^^ AIR301 + 99 | round_time +100 | scale_time_units + | + +AIR301_names.py:99:1: AIR301 `airflow.utils.dates.round_time` is removed in Airflow 3.0 + | + 97 | infer_time_unit + 98 | parse_execution_date + 99 | round_time + | ^^^^^^^^^^ AIR301 +100 | scale_time_units + | + +AIR301_names.py:100:1: AIR301 `airflow.utils.dates.scale_time_units` is removed in Airflow 3.0 + | + 98 | parse_execution_date + 99 | round_time +100 | scale_time_units + | ^^^^^^^^^^^^^^^^ AIR301 +101 | +102 | # This one was not deprecated. + | + +AIR301_names.py:107:1: AIR301 `airflow.utils.dag_cycle_tester.test_cycle` is removed in Airflow 3.0 + | +106 | # airflow.utils.dag_cycle_tester +107 | test_cycle + | ^^^^^^^^^^ AIR301 + | + +AIR301_names.py:111:1: AIR301 `airflow.utils.db.create_session` is removed in Airflow 3.0 + | +110 | # airflow.utils.db +111 | create_session + | ^^^^^^^^^^^^^^ AIR301 +112 | +113 | # airflow.utils.decorators + | + +AIR301_names.py:114:1: AIR301 `airflow.utils.decorators.apply_defaults` is removed in Airflow 3.0 + | +113 | # airflow.utils.decorators +114 | apply_defaults + | ^^^^^^^^^^^^^^ AIR301 +115 | +116 | # airflow.utils.file + | + = help: `apply_defaults` is now unconditionally done and can be safely removed. + +AIR301_names.py:117:1: AIR301 `airflow.utils.file.TemporaryDirectory` is removed in Airflow 3.0 + | +116 | # airflow.utils.file +117 | TemporaryDirectory() + | ^^^^^^^^^^^^^^^^^^ AIR301 +118 | mkdirs + | + = help: Use `tempfile.TemporaryDirectory` instead + +AIR301_names.py:118:1: AIR301 `airflow.utils.file.mkdirs` is removed in Airflow 3.0 + | +116 | # airflow.utils.file +117 | TemporaryDirectory() +118 | mkdirs + | ^^^^^^ AIR301 +119 | +120 | # airflow.utils.helpers + | + = help: Use `pathlib.Path({path}).mkdir` instead + +AIR301_names.py:121:1: AIR301 [*] `airflow.utils.helpers.chain` is removed in Airflow 3.0 + | +120 | # airflow.utils.helpers +121 | helper_chain + | ^^^^^^^^^^^^ AIR301 +122 | helper_cross_downstream + | + = help: Use `airflow.sdk.chain` instead + +ℹ Safe fix +48 48 | from airflow.utils.trigger_rule import TriggerRule +49 49 | from airflow.www.auth import has_access +50 50 | from airflow.www.utils import get_sensitive_variables_fields, should_hide_value_for_key + 51 |+from airflow.sdk import chain +51 52 | +52 53 | # airflow root +53 54 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 +-------------------------------------------------------------------------------- +118 119 | mkdirs +119 120 | +120 121 | # airflow.utils.helpers +121 |-helper_chain + 122 |+chain +122 123 | helper_cross_downstream +123 124 | +124 125 | # airflow.utils.log + +AIR301_names.py:122:1: AIR301 [*] `airflow.utils.helpers.cross_downstream` is removed in Airflow 3.0 + | +120 | # airflow.utils.helpers +121 | helper_chain +122 | helper_cross_downstream + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +123 | +124 | # airflow.utils.log + | + = help: Use `airflow.sdk.cross_downstream` instead + +ℹ Safe fix +48 48 | from airflow.utils.trigger_rule import TriggerRule +49 49 | from airflow.www.auth import has_access +50 50 | from airflow.www.utils import get_sensitive_variables_fields, should_hide_value_for_key + 51 |+from airflow.sdk import cross_downstream +51 52 | +52 53 | # airflow root +53 54 | PY36, PY37, PY38, PY39, PY310, PY311, PY312 +-------------------------------------------------------------------------------- +119 120 | +120 121 | # airflow.utils.helpers +121 122 | helper_chain +122 |-helper_cross_downstream + 123 |+cross_downstream +123 124 | +124 125 | # airflow.utils.log +125 126 | secrets_masker + +AIR301_names.py:125:1: AIR301 `airflow.utils.log.secrets_masker` is removed in Airflow 3.0 + | +124 | # airflow.utils.log +125 | secrets_masker + | ^^^^^^^^^^^^^^ AIR301 +126 | +127 | # airflow.utils.state + | + = help: Use `airflow.sdk.execution_time.secrets_masker` instead + +AIR301_names.py:128:1: AIR301 `airflow.utils.state.SHUTDOWN` is removed in Airflow 3.0 + | +127 | # airflow.utils.state +128 | SHUTDOWN + | ^^^^^^^^ AIR301 +129 | terminating_states + | + +AIR301_names.py:129:1: AIR301 `airflow.utils.state.terminating_states` is removed in Airflow 3.0 + | +127 | # airflow.utils.state +128 | SHUTDOWN +129 | terminating_states + | ^^^^^^^^^^^^^^^^^^ AIR301 +130 | +131 | # airflow.utils.trigger_rule + | + +AIR301_names.py:132:1: AIR301 `airflow.utils.trigger_rule.TriggerRule.DUMMY` is removed in Airflow 3.0 + | +131 | # airflow.utils.trigger_rule +132 | TriggerRule.DUMMY + | ^^^^^^^^^^^^^^^^^ AIR301 +133 | TriggerRule.NONE_FAILED_OR_SKIPPED + | + +AIR301_names.py:133:1: AIR301 `airflow.utils.trigger_rule.TriggerRule.NONE_FAILED_OR_SKIPPED` is removed in Airflow 3.0 + | +131 | # airflow.utils.trigger_rule +132 | TriggerRule.DUMMY +133 | TriggerRule.NONE_FAILED_OR_SKIPPED + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 + | + +AIR301_names.py:137:1: AIR301 `airflow.www.auth.has_access` is removed in Airflow 3.0 + | +136 | # airflow.www.auth +137 | has_access + | ^^^^^^^^^^ AIR301 +138 | +139 | # airflow.www.utils + | + +AIR301_names.py:140:1: AIR301 `airflow.www.utils.get_sensitive_variables_fields` is removed in Airflow 3.0 + | +139 | # airflow.www.utils +140 | get_sensitive_variables_fields + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +141 | should_hide_value_for_key + | + +AIR301_names.py:141:1: AIR301 `airflow.www.utils.should_hide_value_for_key` is removed in Airflow 3.0 + | +139 | # airflow.www.utils +140 | get_sensitive_variables_fields +141 | should_hide_value_for_key + | ^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +142 | +143 | # airflow.operators.python + | + +AIR301_names.py:146:1: AIR301 `airflow.operators.python.get_current_context` is removed in Airflow 3.0 + | +144 | from airflow.operators.python import get_current_context +145 | +146 | get_current_context() + | ^^^^^^^^^^^^^^^^^^^ AIR301 +147 | +148 | # airflow.providers.mysql + | + = help: Use `airflow.sdk.get_current_context` instead + +AIR301_names.py:151:1: AIR301 `airflow.providers.mysql.datasets.mysql.sanitize_uri` is removed in Airflow 3.0 + | +149 | from airflow.providers.mysql.datasets.mysql import sanitize_uri +150 | +151 | sanitize_uri + | ^^^^^^^^^^^^ AIR301 +152 | +153 | # airflow.providers.postgres + | + = help: Use `airflow.providers.mysql.assets.mysql.sanitize_uri` instead + +AIR301_names.py:156:1: AIR301 `airflow.providers.postgres.datasets.postgres.sanitize_uri` is removed in Airflow 3.0 + | +154 | from airflow.providers.postgres.datasets.postgres import sanitize_uri +155 | +156 | sanitize_uri + | ^^^^^^^^^^^^ AIR301 +157 | +158 | # airflow.providers.trino + | + = help: Use `airflow.providers.postgres.assets.postgres.sanitize_uri` instead + +AIR301_names.py:161:1: AIR301 `airflow.providers.trino.datasets.trino.sanitize_uri` is removed in Airflow 3.0 + | +159 | from airflow.providers.trino.datasets.trino import sanitize_uri +160 | +161 | sanitize_uri + | ^^^^^^^^^^^^ AIR301 +162 | +163 | # airflow.notifications.basenotifier + | + = help: Use `airflow.providers.trino.assets.trino.sanitize_uri` instead + +AIR301_names.py:166:1: AIR301 `airflow.notifications.basenotifier.BaseNotifier` is removed in Airflow 3.0 + | +164 | from airflow.notifications.basenotifier import BaseNotifier +165 | +166 | BaseNotifier() + | ^^^^^^^^^^^^ AIR301 +167 | +168 | # airflow.auth.manager + | + = help: Use `airflow.sdk.bases.notifier.BaseNotifier` instead + +AIR301_names.py:171:1: AIR301 `airflow.auth.managers.base_auth_manager.BaseAuthManager` is removed in Airflow 3.0 + | +169 | from airflow.auth.managers.base_auth_manager import BaseAuthManager +170 | +171 | BaseAuthManager() + | ^^^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager` instead diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_fix.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_fix.py.snap new file mode 100644 index 0000000000000..b2f65f18e5aba --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_fix.py.snap @@ -0,0 +1,296 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_names_fix.py:19:1: AIR301 [*] `airflow.api_connexion.security.requires_access_dataset` is removed in Airflow 3.0 + | +17 | from airflow.www.auth import has_access_dataset +18 | +19 | requires_access_dataset() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +20 | +21 | DatasetDetails() + | + = help: Use `airflow.api_fastapi.core_api.security.requires_access_asset` instead + +ℹ Safe fix +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset + 18 |+from airflow.api_fastapi.core_api.security import requires_access_asset +18 19 | +19 |-requires_access_dataset() + 20 |+requires_access_asset() +20 21 | +21 22 | DatasetDetails() +22 23 | + +AIR301_names_fix.py:21:1: AIR301 [*] `airflow.auth.managers.models.resource_details.DatasetDetails` is removed in Airflow 3.0 + | +19 | requires_access_dataset() +20 | +21 | DatasetDetails() + | ^^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.api_fastapi.auth.managers.models.resource_details.AssetDetails` instead + +ℹ Safe fix +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset + 18 |+from airflow.api_fastapi.auth.managers.models.resource_details import AssetDetails +18 19 | +19 20 | requires_access_dataset() +20 21 | +21 |-DatasetDetails() + 22 |+AssetDetails() +22 23 | +23 24 | +24 25 | DatasetManager() + +AIR301_names_fix.py:24:1: AIR301 [*] `airflow.datasets.manager.DatasetManager` is removed in Airflow 3.0 + | +24 | DatasetManager() + | ^^^^^^^^^^^^^^ AIR301 +25 | dataset_manager() +26 | resolve_dataset_manager() + | + = help: Use `airflow.assets.manager.AssetManager` instead + +ℹ Safe fix +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset + 18 |+from airflow.assets.manager import AssetManager +18 19 | +19 20 | requires_access_dataset() +20 21 | +21 22 | DatasetDetails() +22 23 | +23 24 | +24 |-DatasetManager() + 25 |+AssetManager() +25 26 | dataset_manager() +26 27 | resolve_dataset_manager() +27 28 | + +AIR301_names_fix.py:25:1: AIR301 [*] `airflow.datasets.manager.dataset_manager` is removed in Airflow 3.0 + | +24 | DatasetManager() +25 | dataset_manager() + | ^^^^^^^^^^^^^^^ AIR301 +26 | resolve_dataset_manager() + | + = help: Use `airflow.assets.manager.asset_manager` instead + +ℹ Safe fix +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset + 18 |+from airflow.assets.manager import asset_manager +18 19 | +19 20 | requires_access_dataset() +20 21 | +-------------------------------------------------------------------------------- +22 23 | +23 24 | +24 25 | DatasetManager() +25 |-dataset_manager() + 26 |+asset_manager() +26 27 | resolve_dataset_manager() +27 28 | +28 29 | DatasetLineageInfo() + +AIR301_names_fix.py:26:1: AIR301 [*] `airflow.datasets.manager.resolve_dataset_manager` is removed in Airflow 3.0 + | +24 | DatasetManager() +25 | dataset_manager() +26 | resolve_dataset_manager() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +27 | +28 | DatasetLineageInfo() + | + = help: Use `airflow.assets.manager.resolve_asset_manager` instead + +ℹ Safe fix +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset + 18 |+from airflow.assets.manager import resolve_asset_manager +18 19 | +19 20 | requires_access_dataset() +20 21 | +-------------------------------------------------------------------------------- +23 24 | +24 25 | DatasetManager() +25 26 | dataset_manager() +26 |-resolve_dataset_manager() + 27 |+resolve_asset_manager() +27 28 | +28 29 | DatasetLineageInfo() +29 30 | + +AIR301_names_fix.py:28:1: AIR301 [*] `airflow.lineage.hook.DatasetLineageInfo` is removed in Airflow 3.0 + | +26 | resolve_dataset_manager() +27 | +28 | DatasetLineageInfo() + | ^^^^^^^^^^^^^^^^^^ AIR301 +29 | +30 | AllowListValidator() + | + = help: Use `airflow.lineage.hook.AssetLineageInfo` instead + +ℹ Safe fix +10 10 | dataset_manager, +11 11 | resolve_dataset_manager, +12 12 | ) +13 |-from airflow.lineage.hook import DatasetLineageInfo + 13 |+from airflow.lineage.hook import DatasetLineageInfo, AssetLineageInfo +14 14 | from airflow.metrics.validators import AllowListValidator, BlockListValidator +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +-------------------------------------------------------------------------------- +25 25 | dataset_manager() +26 26 | resolve_dataset_manager() +27 27 | +28 |-DatasetLineageInfo() + 28 |+AssetLineageInfo() +29 29 | +30 30 | AllowListValidator() +31 31 | BlockListValidator() + +AIR301_names_fix.py:30:1: AIR301 [*] `airflow.metrics.validators.AllowListValidator` is removed in Airflow 3.0 + | +28 | DatasetLineageInfo() +29 | +30 | AllowListValidator() + | ^^^^^^^^^^^^^^^^^^ AIR301 +31 | BlockListValidator() + | + = help: Use `airflow.metrics.validators.PatternAllowListValidator` instead + +ℹ Safe fix +11 11 | resolve_dataset_manager, +12 12 | ) +13 13 | from airflow.lineage.hook import DatasetLineageInfo +14 |-from airflow.metrics.validators import AllowListValidator, BlockListValidator + 14 |+from airflow.metrics.validators import AllowListValidator, BlockListValidator, PatternAllowListValidator +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset +-------------------------------------------------------------------------------- +27 27 | +28 28 | DatasetLineageInfo() +29 29 | +30 |-AllowListValidator() + 30 |+PatternAllowListValidator() +31 31 | BlockListValidator() +32 32 | +33 33 | load_connections() + +AIR301_names_fix.py:31:1: AIR301 [*] `airflow.metrics.validators.BlockListValidator` is removed in Airflow 3.0 + | +30 | AllowListValidator() +31 | BlockListValidator() + | ^^^^^^^^^^^^^^^^^^ AIR301 +32 | +33 | load_connections() + | + = help: Use `airflow.metrics.validators.PatternBlockListValidator` instead + +ℹ Safe fix +11 11 | resolve_dataset_manager, +12 12 | ) +13 13 | from airflow.lineage.hook import DatasetLineageInfo +14 |-from airflow.metrics.validators import AllowListValidator, BlockListValidator + 14 |+from airflow.metrics.validators import AllowListValidator, BlockListValidator, PatternBlockListValidator +15 15 | from airflow.secrets.local_filesystm import load_connections +16 16 | from airflow.security.permissions import RESOURCE_DATASET +17 17 | from airflow.www.auth import has_access_dataset +-------------------------------------------------------------------------------- +28 28 | DatasetLineageInfo() +29 29 | +30 30 | AllowListValidator() +31 |-BlockListValidator() + 31 |+PatternBlockListValidator() +32 32 | +33 33 | load_connections() +34 34 | + +AIR301_names_fix.py:35:1: AIR301 [*] `airflow.security.permissions.RESOURCE_DATASET` is removed in Airflow 3.0 + | +33 | load_connections() +34 | +35 | RESOURCE_DATASET + | ^^^^^^^^^^^^^^^^ AIR301 +36 | +37 | has_access_dataset() + | + = help: Use `airflow.security.permissions.RESOURCE_ASSET` instead + +ℹ Safe fix +13 13 | from airflow.lineage.hook import DatasetLineageInfo +14 14 | from airflow.metrics.validators import AllowListValidator, BlockListValidator +15 15 | from airflow.secrets.local_filesystm import load_connections +16 |-from airflow.security.permissions import RESOURCE_DATASET + 16 |+from airflow.security.permissions import RESOURCE_DATASET, RESOURCE_ASSET +17 17 | from airflow.www.auth import has_access_dataset +18 18 | +19 19 | requires_access_dataset() +-------------------------------------------------------------------------------- +32 32 | +33 33 | load_connections() +34 34 | +35 |-RESOURCE_DATASET + 35 |+RESOURCE_ASSET +36 36 | +37 37 | has_access_dataset() +38 38 | + +AIR301_names_fix.py:37:1: AIR301 `airflow.www.auth.has_access_dataset` is removed in Airflow 3.0 + | +35 | RESOURCE_DATASET +36 | +37 | has_access_dataset() + | ^^^^^^^^^^^^^^^^^^ AIR301 +38 | +39 | from airflow.listeners.spec.dataset import ( + | + +AIR301_names_fix.py:44:1: AIR301 [*] `airflow.listeners.spec.dataset.on_dataset_created` is removed in Airflow 3.0 + | +42 | ) +43 | +44 | on_dataset_created() + | ^^^^^^^^^^^^^^^^^^ AIR301 +45 | on_dataset_changed() + | + = help: Use `airflow.listeners.spec.asset.on_asset_created` instead + +ℹ Safe fix +40 40 | on_dataset_changed, +41 41 | on_dataset_created, +42 42 | ) + 43 |+from airflow.listeners.spec.asset import on_asset_created +43 44 | +44 |-on_dataset_created() + 45 |+on_asset_created() +45 46 | on_dataset_changed() + +AIR301_names_fix.py:45:1: AIR301 [*] `airflow.listeners.spec.dataset.on_dataset_changed` is removed in Airflow 3.0 + | +44 | on_dataset_created() +45 | on_dataset_changed() + | ^^^^^^^^^^^^^^^^^^ AIR301 + | + = help: Use `airflow.listeners.spec.asset.on_asset_changed` instead + +ℹ Safe fix +40 40 | on_dataset_changed, +41 41 | on_dataset_created, +42 42 | ) + 43 |+from airflow.listeners.spec.asset import on_asset_changed +43 44 | +44 45 | on_dataset_created() +45 |-on_dataset_changed() + 46 |+on_asset_changed() diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_try.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_try.py.snap new file mode 100644 index 0000000000000..6d6d3986fe9dd --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_names_try.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_provider_names_fix.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_provider_names_fix.py.snap new file mode 100644 index 0000000000000..e1ac3ba9c1d7e --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR301_AIR301_provider_names_fix.py.snap @@ -0,0 +1,216 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR301_provider_names_fix.py:25:1: AIR301 [*] `airflow.providers.amazon.aws.auth_manager.avp.entities.AvpEntities.DATASET` is removed in Airflow 3.0 + | +23 | ) +24 | +25 | AvpEntities.DATASET + | ^^^^^^^^^^^^^^^^^^^ AIR301 +26 | +27 | s3_create_dataset() + | + = help: Use `airflow.providers.amazon.aws.auth_manager.avp.entities.AvpEntities.ASSET` instead + +ℹ Safe fix +22 22 | translate_airflow_dataset, +23 23 | ) +24 24 | +25 |-AvpEntities.DATASET + 25 |+AvpEntities.ASSET +26 26 | +27 27 | s3_create_dataset() +28 28 | s3_convert_dataset_to_openlineage() + +AIR301_provider_names_fix.py:27:1: AIR301 [*] `airflow.providers.amazon.aws.datasets.s3.create_dataset` is removed in Airflow 3.0 + | +25 | AvpEntities.DATASET +26 | +27 | s3_create_dataset() + | ^^^^^^^^^^^^^^^^^ AIR301 +28 | s3_convert_dataset_to_openlineage() + | + = help: Use `airflow.providers.amazon.aws.assets.s3.create_asset` instead + +ℹ Safe fix +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, +23 23 | ) + 24 |+from airflow.providers.amazon.aws.assets.s3 import create_asset +24 25 | +25 26 | AvpEntities.DATASET +26 27 | +27 |-s3_create_dataset() + 28 |+create_asset() +28 29 | s3_convert_dataset_to_openlineage() +29 30 | +30 31 | io_create_dataset() + +AIR301_provider_names_fix.py:28:1: AIR301 [*] `airflow.providers.amazon.aws.datasets.s3.convert_dataset_to_openlineage` is removed in Airflow 3.0 + | +27 | s3_create_dataset() +28 | s3_convert_dataset_to_openlineage() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +29 | +30 | io_create_dataset() + | + = help: Use `airflow.providers.amazon.aws.assets.s3.convert_asset_to_openlineage` instead + +ℹ Safe fix +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, +23 23 | ) + 24 |+from airflow.providers.amazon.aws.assets.s3 import convert_asset_to_openlineage +24 25 | +25 26 | AvpEntities.DATASET +26 27 | +27 28 | s3_create_dataset() +28 |-s3_convert_dataset_to_openlineage() + 29 |+convert_asset_to_openlineage() +29 30 | +30 31 | io_create_dataset() +31 32 | io_convert_dataset_to_openlineage() + +AIR301_provider_names_fix.py:36:1: AIR301 [*] `airflow.providers.google.datasets.bigquery.create_dataset` is removed in Airflow 3.0 + | +35 | # airflow.providers.google.datasets.bigquery +36 | bigquery_create_dataset() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +37 | # airflow.providers.google.datasets.gcs +38 | gcs_create_dataset() + | + = help: Use `airflow.providers.google.assets.bigquery.create_asset` instead + +ℹ Safe fix +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, +23 23 | ) + 24 |+from airflow.providers.google.assets.bigquery import create_asset +24 25 | +25 26 | AvpEntities.DATASET +26 27 | +-------------------------------------------------------------------------------- +33 34 | +34 35 | +35 36 | # airflow.providers.google.datasets.bigquery +36 |-bigquery_create_dataset() + 37 |+create_asset() +37 38 | # airflow.providers.google.datasets.gcs +38 39 | gcs_create_dataset() +39 40 | gcs_convert_dataset_to_openlineage() + +AIR301_provider_names_fix.py:38:1: AIR301 [*] `airflow.providers.google.datasets.gcs.create_dataset` is removed in Airflow 3.0 + | +36 | bigquery_create_dataset() +37 | # airflow.providers.google.datasets.gcs +38 | gcs_create_dataset() + | ^^^^^^^^^^^^^^^^^^ AIR301 +39 | gcs_convert_dataset_to_openlineage() +40 | # airflow.providers.openlineage.utils.utils + | + = help: Use `airflow.providers.google.assets.gcs.create_asset` instead + +ℹ Safe fix +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, +23 23 | ) + 24 |+from airflow.providers.google.assets.gcs import create_asset +24 25 | +25 26 | AvpEntities.DATASET +26 27 | +-------------------------------------------------------------------------------- +35 36 | # airflow.providers.google.datasets.bigquery +36 37 | bigquery_create_dataset() +37 38 | # airflow.providers.google.datasets.gcs +38 |-gcs_create_dataset() + 39 |+create_asset() +39 40 | gcs_convert_dataset_to_openlineage() +40 41 | # airflow.providers.openlineage.utils.utils +41 42 | DatasetInfo() + +AIR301_provider_names_fix.py:39:1: AIR301 [*] `airflow.providers.google.datasets.gcs.convert_dataset_to_openlineage` is removed in Airflow 3.0 + | +37 | # airflow.providers.google.datasets.gcs +38 | gcs_create_dataset() +39 | gcs_convert_dataset_to_openlineage() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +40 | # airflow.providers.openlineage.utils.utils +41 | DatasetInfo() + | + = help: Use `airflow.providers.google.assets.gcs.convert_asset_to_openlineage` instead + +ℹ Safe fix +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, +23 23 | ) + 24 |+from airflow.providers.google.assets.gcs import convert_asset_to_openlineage +24 25 | +25 26 | AvpEntities.DATASET +26 27 | +-------------------------------------------------------------------------------- +36 37 | bigquery_create_dataset() +37 38 | # airflow.providers.google.datasets.gcs +38 39 | gcs_create_dataset() +39 |-gcs_convert_dataset_to_openlineage() + 40 |+convert_asset_to_openlineage() +40 41 | # airflow.providers.openlineage.utils.utils +41 42 | DatasetInfo() +42 43 | translate_airflow_dataset() + +AIR301_provider_names_fix.py:41:1: AIR301 [*] `airflow.providers.openlineage.utils.utils.DatasetInfo` is removed in Airflow 3.0 + | +39 | gcs_convert_dataset_to_openlineage() +40 | # airflow.providers.openlineage.utils.utils +41 | DatasetInfo() + | ^^^^^^^^^^^ AIR301 +42 | translate_airflow_dataset() +43 | # + | + = help: Use `airflow.providers.openlineage.utils.utils.AssetInfo` instead + +ℹ Safe fix +20 20 | from airflow.providers.openlineage.utils.utils import ( +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, + 23 |+AssetInfo, +23 24 | ) +24 25 | +25 26 | AvpEntities.DATASET +-------------------------------------------------------------------------------- +38 39 | gcs_create_dataset() +39 40 | gcs_convert_dataset_to_openlineage() +40 41 | # airflow.providers.openlineage.utils.utils +41 |-DatasetInfo() + 42 |+AssetInfo() +42 43 | translate_airflow_dataset() +43 44 | # +44 45 | # airflow.secrets.local_filesystem + +AIR301_provider_names_fix.py:42:1: AIR301 [*] `airflow.providers.openlineage.utils.utils.translate_airflow_dataset` is removed in Airflow 3.0 + | +40 | # airflow.providers.openlineage.utils.utils +41 | DatasetInfo() +42 | translate_airflow_dataset() + | ^^^^^^^^^^^^^^^^^^^^^^^^^ AIR301 +43 | # +44 | # airflow.secrets.local_filesystem + | + = help: Use `airflow.providers.openlineage.utils.utils.translate_airflow_asset` instead + +ℹ Safe fix +20 20 | from airflow.providers.openlineage.utils.utils import ( +21 21 | DatasetInfo, +22 22 | translate_airflow_dataset, + 23 |+translate_airflow_asset, +23 24 | ) +24 25 | +25 26 | AvpEntities.DATASET +-------------------------------------------------------------------------------- +39 40 | gcs_convert_dataset_to_openlineage() +40 41 | # airflow.providers.openlineage.utils.utils +41 42 | DatasetInfo() +42 |-translate_airflow_dataset() + 43 |+translate_airflow_asset() +43 44 | # +44 45 | # airflow.secrets.local_filesystem +45 46 | load_connections() diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_amazon.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_amazon.py.snap new file mode 100644 index 0000000000000..f7f18a458b1e0 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_amazon.py.snap @@ -0,0 +1,113 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_amazon.py:23:1: AIR302 `airflow.hooks.S3_hook.S3Hook` is moved into `amazon` provider in Airflow 3.0; + | +21 | from airflow.sensors.s3_key_sensor import S3KeySensor +22 | +23 | S3Hook() + | ^^^^^^ AIR302 +24 | provide_bucket_name() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.hooks.s3.S3Hook` instead. + +AIR302_amazon.py:24:1: AIR302 `airflow.hooks.S3_hook.provide_bucket_name` is moved into `amazon` provider in Airflow 3.0; + | +23 | S3Hook() +24 | provide_bucket_name() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +25 | +26 | GCSToS3Operator() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.hooks.s3.provide_bucket_name` instead. + +AIR302_amazon.py:26:1: AIR302 `airflow.operators.gcs_to_s3.GCSToS3Operator` is moved into `amazon` provider in Airflow 3.0; + | +24 | provide_bucket_name() +25 | +26 | GCSToS3Operator() + | ^^^^^^^^^^^^^^^ AIR302 +27 | +28 | GoogleApiToS3Operator() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.gcs_to_s3.GCSToS3Operator` instead. + +AIR302_amazon.py:28:1: AIR302 `airflow.operators.google_api_to_s3_transfer.GoogleApiToS3Operator` is moved into `amazon` provider in Airflow 3.0; + | +26 | GCSToS3Operator() +27 | +28 | GoogleApiToS3Operator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +29 | GoogleApiToS3Transfer() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.google_api_to_s3.GoogleApiToS3Operator` instead. + +AIR302_amazon.py:29:1: AIR302 `airflow.operators.google_api_to_s3_transfer.GoogleApiToS3Transfer` is moved into `amazon` provider in Airflow 3.0; + | +28 | GoogleApiToS3Operator() +29 | GoogleApiToS3Transfer() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +30 | +31 | RedshiftToS3Operator() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.google_api_to_s3.GoogleApiToS3Operator` instead. + +AIR302_amazon.py:31:1: AIR302 `airflow.operators.redshift_to_s3_operator.RedshiftToS3Operator` is moved into `amazon` provider in Airflow 3.0; + | +29 | GoogleApiToS3Transfer() +30 | +31 | RedshiftToS3Operator() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +32 | RedshiftToS3Transfer() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.redshift_to_s3.RedshiftToS3Operator` instead. + +AIR302_amazon.py:32:1: AIR302 `airflow.operators.redshift_to_s3_operator.RedshiftToS3Transfer` is moved into `amazon` provider in Airflow 3.0; + | +31 | RedshiftToS3Operator() +32 | RedshiftToS3Transfer() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +33 | +34 | S3FileTransformOperator() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.redshift_to_s3.RedshiftToS3Operator` instead. + +AIR302_amazon.py:34:1: AIR302 `airflow.operators.s3_file_transform_operator.S3FileTransformOperator` is moved into `amazon` provider in Airflow 3.0; + | +32 | RedshiftToS3Transfer() +33 | +34 | S3FileTransformOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +35 | +36 | S3ToRedshiftOperator() + | + = help: Install `apache-airflow-providers-amazon>=3.0.0` and use `airflow.providers.amazon.aws.operators.s3.S3FileTransformOperator` instead. + +AIR302_amazon.py:36:1: AIR302 `airflow.operators.s3_to_redshift_operator.S3ToRedshiftOperator` is moved into `amazon` provider in Airflow 3.0; + | +34 | S3FileTransformOperator() +35 | +36 | S3ToRedshiftOperator() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +37 | S3ToRedshiftTransfer() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.s3_to_redshift.S3ToRedshiftOperator` instead. + +AIR302_amazon.py:37:1: AIR302 `airflow.operators.s3_to_redshift_operator.S3ToRedshiftTransfer` is moved into `amazon` provider in Airflow 3.0; + | +36 | S3ToRedshiftOperator() +37 | S3ToRedshiftTransfer() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +38 | +39 | S3KeySensor() + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.transfers.s3_to_redshift.S3ToRedshiftOperator` instead. + +AIR302_amazon.py:39:1: AIR302 `airflow.sensors.s3_key_sensor.S3KeySensor` is moved into `amazon` provider in Airflow 3.0; + | +37 | S3ToRedshiftTransfer() +38 | +39 | S3KeySensor() + | ^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-amazon>=1.0.0` and use `airflow.providers.amazon.aws.sensors.s3.S3KeySensor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_celery.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_celery.py.snap new file mode 100644 index 0000000000000..554871e39e481 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_celery.py.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_celery.py:9:1: AIR302 `airflow.config_templates.default_celery.DEFAULT_CELERY_CONFIG` is moved into `celery` provider in Airflow 3.0; + | + 7 | ) + 8 | + 9 | DEFAULT_CELERY_CONFIG + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +10 | +11 | app + | + = help: Install `apache-airflow-providers-celery>=3.3.0` and use `airflow.providers.celery.executors.default_celery.DEFAULT_CELERY_CONFIG` instead. + +AIR302_celery.py:11:1: AIR302 `airflow.executors.celery_executor.app` is moved into `celery` provider in Airflow 3.0; + | + 9 | DEFAULT_CELERY_CONFIG +10 | +11 | app + | ^^^ AIR302 +12 | CeleryExecutor() + | + = help: Install `apache-airflow-providers-celery>=3.3.0` and use `airflow.providers.celery.executors.celery_executor_utils.app` instead. + +AIR302_celery.py:12:1: AIR302 `airflow.executors.celery_executor.CeleryExecutor` is moved into `celery` provider in Airflow 3.0; + | +11 | app +12 | CeleryExecutor() + | ^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-celery>=3.3.0` and use `airflow.providers.celery.executors.celery_executor.CeleryExecutor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_common_sql.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_common_sql.py.snap new file mode 100644 index 0000000000000..693e7f44bdce9 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_common_sql.py.snap @@ -0,0 +1,433 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_common_sql.py:10:1: AIR302 `airflow.hooks.dbapi.ConnectorProtocol` is moved into `common-sql` provider in Airflow 3.0; + | + 8 | from airflow.operators.check_operator import SQLCheckOperator + 9 | +10 | ConnectorProtocol() + | ^^^^^^^^^^^^^^^^^ AIR302 +11 | DbApiHook() +12 | SQLCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.hooks.sql.ConnectorProtocol` instead. + +AIR302_common_sql.py:11:1: AIR302 `airflow.hooks.dbapi_hook.DbApiHook` is moved into `common-sql` provider in Airflow 3.0; + | +10 | ConnectorProtocol() +11 | DbApiHook() + | ^^^^^^^^^ AIR302 +12 | SQLCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.hooks.sql.DbApiHook` instead. + +AIR302_common_sql.py:12:1: AIR302 `airflow.operators.check_operator.SQLCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +10 | ConnectorProtocol() +11 | DbApiHook() +12 | SQLCheckOperator() + | ^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:18:1: AIR302 `airflow.operators.sql.SQLCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +16 | from airflow.operators.sql import SQLCheckOperator +17 | +18 | SQLCheckOperator() + | ^^^^^^^^^^^^^^^^ AIR302 +19 | CheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:19:1: AIR302 `airflow.operators.check_operator.CheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +18 | SQLCheckOperator() +19 | CheckOperator() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:24:1: AIR302 `airflow.operators.druid_check_operator.CheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +22 | from airflow.operators.druid_check_operator import CheckOperator +23 | +24 | CheckOperator() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:29:1: AIR302 `airflow.operators.presto_check_operator.CheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +27 | from airflow.operators.presto_check_operator import CheckOperator +28 | +29 | CheckOperator() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:39:1: AIR302 `airflow.operators.druid_check_operator.DruidCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +37 | from airflow.operators.presto_check_operator import PrestoCheckOperator +38 | +39 | DruidCheckOperator() + | ^^^^^^^^^^^^^^^^^^ AIR302 +40 | PrestoCheckOperator() +41 | IntervalCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:40:1: AIR302 `airflow.operators.presto_check_operator.PrestoCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +39 | DruidCheckOperator() +40 | PrestoCheckOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +41 | IntervalCheckOperator() +42 | SQLIntervalCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLCheckOperator` instead. + +AIR302_common_sql.py:41:1: AIR302 `airflow.operators.check_operator.IntervalCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +39 | DruidCheckOperator() +40 | PrestoCheckOperator() +41 | IntervalCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +42 | SQLIntervalCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLIntervalCheckOperator` instead. + +AIR302_common_sql.py:42:1: AIR302 `airflow.operators.check_operator.SQLIntervalCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +40 | PrestoCheckOperator() +41 | IntervalCheckOperator() +42 | SQLIntervalCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLIntervalCheckOperator` instead. + +AIR302_common_sql.py:51:1: AIR302 `airflow.operators.presto_check_operator.IntervalCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +49 | from airflow.operators.sql import SQLIntervalCheckOperator +50 | +51 | IntervalCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +52 | SQLIntervalCheckOperator() +53 | PrestoIntervalCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLIntervalCheckOperator` instead. + +AIR302_common_sql.py:52:1: AIR302 `airflow.operators.sql.SQLIntervalCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +51 | IntervalCheckOperator() +52 | SQLIntervalCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +53 | PrestoIntervalCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLIntervalCheckOperator` instead. + +AIR302_common_sql.py:53:1: AIR302 `airflow.operators.presto_check_operator.PrestoIntervalCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +51 | IntervalCheckOperator() +52 | SQLIntervalCheckOperator() +53 | PrestoIntervalCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLIntervalCheckOperator` instead. + +AIR302_common_sql.py:61:1: AIR302 `airflow.operators.check_operator.SQLThresholdCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +59 | ) +60 | +61 | SQLThresholdCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +62 | ThresholdCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLThresholdCheckOperator` instead. + +AIR302_common_sql.py:62:1: AIR302 `airflow.operators.check_operator.ThresholdCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +61 | SQLThresholdCheckOperator() +62 | ThresholdCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLThresholdCheckOperator` instead. + +AIR302_common_sql.py:67:1: AIR302 `airflow.operators.sql.SQLThresholdCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +65 | from airflow.operators.sql import SQLThresholdCheckOperator +66 | +67 | SQLThresholdCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLThresholdCheckOperator` instead. + +AIR302_common_sql.py:75:1: AIR302 `airflow.operators.check_operator.SQLValueCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +73 | ) +74 | +75 | SQLValueCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +76 | ValueCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLValueCheckOperator` instead. + +AIR302_common_sql.py:76:1: AIR302 `airflow.operators.check_operator.ValueCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +75 | SQLValueCheckOperator() +76 | ValueCheckOperator() + | ^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLValueCheckOperator` instead. + +AIR302_common_sql.py:85:1: AIR302 `airflow.operators.sql.SQLValueCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +83 | from airflow.operators.sql import SQLValueCheckOperator +84 | +85 | SQLValueCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +86 | ValueCheckOperator() +87 | PrestoValueCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLValueCheckOperator` instead. + +AIR302_common_sql.py:86:1: AIR302 `airflow.operators.presto_check_operator.ValueCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +85 | SQLValueCheckOperator() +86 | ValueCheckOperator() + | ^^^^^^^^^^^^^^^^^^ AIR302 +87 | PrestoValueCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLValueCheckOperator` instead. + +AIR302_common_sql.py:87:1: AIR302 `airflow.operators.presto_check_operator.PrestoValueCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +85 | SQLValueCheckOperator() +86 | ValueCheckOperator() +87 | PrestoValueCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLValueCheckOperator` instead. + +AIR302_common_sql.py:99:1: AIR302 `airflow.operators.sql.BaseSQLOperator` is moved into `common-sql` provider in Airflow 3.0; + | + 97 | ) + 98 | + 99 | BaseSQLOperator() + | ^^^^^^^^^^^^^^^ AIR302 +100 | BranchSQLOperator() +101 | SQLTableCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.BaseSQLOperator` instead. + +AIR302_common_sql.py:100:1: AIR302 `airflow.operators.sql.BranchSQLOperator` is moved into `common-sql` provider in Airflow 3.0; + | + 99 | BaseSQLOperator() +100 | BranchSQLOperator() + | ^^^^^^^^^^^^^^^^^ AIR302 +101 | SQLTableCheckOperator() +102 | SQLColumnCheckOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.BranchSQLOperator` instead. + +AIR302_common_sql.py:101:1: AIR302 `airflow.operators.sql.SQLTableCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | + 99 | BaseSQLOperator() +100 | BranchSQLOperator() +101 | SQLTableCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +102 | SQLColumnCheckOperator() +103 | _convert_to_float_if_possible() + | + = help: Install `apache-airflow-providers-common-sql>=1.1.0` and use `airflow.providers.common.sql.operators.sql.SQLTableCheckOperator` instead. + +AIR302_common_sql.py:102:1: AIR302 `airflow.operators.sql.SQLColumnCheckOperator` is moved into `common-sql` provider in Airflow 3.0; + | +100 | BranchSQLOperator() +101 | SQLTableCheckOperator() +102 | SQLColumnCheckOperator() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 +103 | _convert_to_float_if_possible() +104 | parse_boolean() + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.operators.sql.SQLColumnCheckOperator` instead. + +AIR302_common_sql.py:103:1: AIR302 `airflow.operators.sql._convert_to_float_if_possible` is moved into `common-sql` provider in Airflow 3.0; + | +101 | SQLTableCheckOperator() +102 | SQLColumnCheckOperator() +103 | _convert_to_float_if_possible() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +104 | parse_boolean() + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.operators.sql._convert_to_float_if_possible` instead. + +AIR302_common_sql.py:104:1: AIR302 `airflow.operators.sql.parse_boolean` is moved into `common-sql` provider in Airflow 3.0; + | +102 | SQLColumnCheckOperator() +103 | _convert_to_float_if_possible() +104 | parse_boolean() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.operators.sql.parse_boolean` instead. + +AIR302_common_sql.py:109:1: AIR302 `airflow.sensors.sql.SqlSensor` is moved into `common-sql` provider in Airflow 3.0; + | +107 | from airflow.sensors.sql import SqlSensor +108 | +109 | SqlSensor() + | ^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.sensors.sql.SqlSensor` instead. + +AIR302_common_sql.py:114:1: AIR302 `airflow.sensors.sql_sensor.SqlSensor` is moved into `common-sql` provider in Airflow 3.0; + | +112 | from airflow.sensors.sql_sensor import SqlSensor +113 | +114 | SqlSensor() + | ^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.0.0` and use `airflow.providers.common.sql.sensors.sql.SqlSensor` instead. + +AIR302_common_sql.py:124:1: AIR302 [*] `airflow.operators.jdbc_operator.JdbcOperator` is moved into `common-sql` provider in Airflow 3.0; + | +122 | from airflow.operators.sqlite_operator import SqliteOperator +123 | +124 | JdbcOperator() + | ^^^^^^^^^^^^ AIR302 +125 | MsSqlOperator() +126 | MySqlOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 |-JdbcOperator() + 125 |+SQLExecuteQueryOperator() +125 126 | MsSqlOperator() +126 127 | MySqlOperator() +127 128 | OracleOperator() + +AIR302_common_sql.py:125:1: AIR302 [*] `airflow.operators.mssql_operator.MsSqlOperator` is moved into `common-sql` provider in Airflow 3.0; + | +124 | JdbcOperator() +125 | MsSqlOperator() + | ^^^^^^^^^^^^^ AIR302 +126 | MySqlOperator() +127 | OracleOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 125 | JdbcOperator() +125 |-MsSqlOperator() + 126 |+SQLExecuteQueryOperator() +126 127 | MySqlOperator() +127 128 | OracleOperator() +128 129 | PostgresOperator() + +AIR302_common_sql.py:126:1: AIR302 [*] `airflow.operators.mysql_operator.MySqlOperator` is moved into `common-sql` provider in Airflow 3.0; + | +124 | JdbcOperator() +125 | MsSqlOperator() +126 | MySqlOperator() + | ^^^^^^^^^^^^^ AIR302 +127 | OracleOperator() +128 | PostgresOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 125 | JdbcOperator() +125 126 | MsSqlOperator() +126 |-MySqlOperator() + 127 |+SQLExecuteQueryOperator() +127 128 | OracleOperator() +128 129 | PostgresOperator() +129 130 | SqliteOperator() + +AIR302_common_sql.py:127:1: AIR302 [*] `airflow.operators.oracle_operator.OracleOperator` is moved into `common-sql` provider in Airflow 3.0; + | +125 | MsSqlOperator() +126 | MySqlOperator() +127 | OracleOperator() + | ^^^^^^^^^^^^^^ AIR302 +128 | PostgresOperator() +129 | SqliteOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 125 | JdbcOperator() +125 126 | MsSqlOperator() +126 127 | MySqlOperator() +127 |-OracleOperator() + 128 |+SQLExecuteQueryOperator() +128 129 | PostgresOperator() +129 130 | SqliteOperator() + +AIR302_common_sql.py:128:1: AIR302 [*] `airflow.operators.postgres_operator.PostgresOperator` is moved into `common-sql` provider in Airflow 3.0; + | +126 | MySqlOperator() +127 | OracleOperator() +128 | PostgresOperator() + | ^^^^^^^^^^^^^^^^ AIR302 +129 | SqliteOperator() + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 125 | JdbcOperator() +125 126 | MsSqlOperator() +126 127 | MySqlOperator() +127 128 | OracleOperator() +128 |-PostgresOperator() + 129 |+SQLExecuteQueryOperator() +129 130 | SqliteOperator() + +AIR302_common_sql.py:129:1: AIR302 [*] `airflow.operators.sqlite_operator.SqliteOperator` is moved into `common-sql` provider in Airflow 3.0; + | +127 | OracleOperator() +128 | PostgresOperator() +129 | SqliteOperator() + | ^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-common-sql>=1.3.0` and use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead. + +ℹ Safe fix +120 120 | from airflow.operators.oracle_operator import OracleOperator +121 121 | from airflow.operators.postgres_operator import PostgresOperator +122 122 | from airflow.operators.sqlite_operator import SqliteOperator + 123 |+from airflow.providers.common.sql.operators.sql import SQLExecuteQueryOperator +123 124 | +124 125 | JdbcOperator() +125 126 | MsSqlOperator() +126 127 | MySqlOperator() +127 128 | OracleOperator() +128 129 | PostgresOperator() +129 |-SqliteOperator() + 130 |+SQLExecuteQueryOperator() diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_daskexecutor.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_daskexecutor.py.snap new file mode 100644 index 0000000000000..ba40037189fb6 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_daskexecutor.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_daskexecutor.py:5:1: AIR302 `airflow.executors.dask_executor.DaskExecutor` is moved into `daskexecutor` provider in Airflow 3.0; + | +3 | from airflow.executors.dask_executor import DaskExecutor +4 | +5 | DaskExecutor() + | ^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-daskexecutor>=1.0.0` and use `airflow.providers.daskexecutor.executors.dask_executor.DaskExecutor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_druid.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_druid.py.snap new file mode 100644 index 0000000000000..992a7d3da508d --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_druid.py.snap @@ -0,0 +1,40 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_druid.py:12:1: AIR302 `airflow.hooks.druid_hook.DruidDbApiHook` is moved into `apache-druid` provider in Airflow 3.0; + | +10 | ) +11 | +12 | DruidDbApiHook() + | ^^^^^^^^^^^^^^ AIR302 +13 | DruidHook() + | + = help: Install `apache-airflow-providers-apache-druid>=1.0.0` and use `airflow.providers.apache.druid.hooks.druid.DruidDbApiHook` instead. + +AIR302_druid.py:13:1: AIR302 `airflow.hooks.druid_hook.DruidHook` is moved into `apache-druid` provider in Airflow 3.0; + | +12 | DruidDbApiHook() +13 | DruidHook() + | ^^^^^^^^^ AIR302 +14 | +15 | HiveToDruidOperator() + | + = help: Install `apache-airflow-providers-apache-druid>=1.0.0` and use `airflow.providers.apache.druid.hooks.druid.DruidHook` instead. + +AIR302_druid.py:15:1: AIR302 `airflow.operators.hive_to_druid.HiveToDruidOperator` is moved into `apache-druid` provider in Airflow 3.0; + | +13 | DruidHook() +14 | +15 | HiveToDruidOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +16 | HiveToDruidTransfer() + | + = help: Install `apache-airflow-providers-apache-druid>=1.0.0` and use `airflow.providers.apache.druid.transfers.hive_to_druid.HiveToDruidOperator` instead. + +AIR302_druid.py:16:1: AIR302 `airflow.operators.hive_to_druid.HiveToDruidTransfer` is moved into `apache-druid` provider in Airflow 3.0; + | +15 | HiveToDruidOperator() +16 | HiveToDruidTransfer() + | ^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-apache-druid>=1.0.0` and use `airflow.providers.apache.druid.transfers.hive_to_druid.HiveToDruidOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_fab.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_fab.py.snap new file mode 100644 index 0000000000000..0889673ff422d --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_fab.py.snap @@ -0,0 +1,190 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_fab.py:10:1: AIR302 `airflow.api.auth.backend.basic_auth.CLIENT_AUTH` is moved into `fab` provider in Airflow 3.0; + | + 8 | ) + 9 | +10 | CLIENT_AUTH + | ^^^^^^^^^^^ AIR302 +11 | init_app() +12 | auth_current_user() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.CLIENT_AUTH` instead. + +AIR302_fab.py:11:1: AIR302 `airflow.api.auth.backend.basic_auth.init_app` is moved into `fab` provider in Airflow 3.0; + | +10 | CLIENT_AUTH +11 | init_app() + | ^^^^^^^^ AIR302 +12 | auth_current_user() +13 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.init_app` instead. + +AIR302_fab.py:12:1: AIR302 `airflow.api.auth.backend.basic_auth.auth_current_user` is moved into `fab` provider in Airflow 3.0; + | +10 | CLIENT_AUTH +11 | init_app() +12 | auth_current_user() + | ^^^^^^^^^^^^^^^^^ AIR302 +13 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.auth_current_user` instead. + +AIR302_fab.py:13:1: AIR302 `airflow.api.auth.backend.basic_auth.requires_authentication` is moved into `fab` provider in Airflow 3.0; + | +11 | init_app() +12 | auth_current_user() +13 | requires_authentication() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +14 | +15 | from airflow.api.auth.backend.kerberos_auth import ( + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.requires_authentication` instead. + +AIR302_fab.py:23:1: AIR302 `airflow.api.auth.backend.kerberos_auth.log` is moved into `fab` provider in Airflow 3.0; + | +21 | ) +22 | +23 | log() + | ^^^ AIR302 +24 | CLIENT_AUTH +25 | find_user() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.log` instead. + +AIR302_fab.py:24:1: AIR302 `airflow.api.auth.backend.kerberos_auth.CLIENT_AUTH` is moved into `fab` provider in Airflow 3.0; + | +23 | log() +24 | CLIENT_AUTH + | ^^^^^^^^^^^ AIR302 +25 | find_user() +26 | init_app() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.CLIENT_AUTH` instead. + +AIR302_fab.py:25:1: AIR302 `airflow.api.auth.backend.kerberos_auth.find_user` is moved into `fab` provider in Airflow 3.0; + | +23 | log() +24 | CLIENT_AUTH +25 | find_user() + | ^^^^^^^^^ AIR302 +26 | init_app() +27 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.find_user` instead. + +AIR302_fab.py:26:1: AIR302 `airflow.api.auth.backend.kerberos_auth.init_app` is moved into `fab` provider in Airflow 3.0; + | +24 | CLIENT_AUTH +25 | find_user() +26 | init_app() + | ^^^^^^^^ AIR302 +27 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.init_app` instead. + +AIR302_fab.py:27:1: AIR302 `airflow.api.auth.backend.kerberos_auth.requires_authentication` is moved into `fab` provider in Airflow 3.0; + | +25 | find_user() +26 | init_app() +27 | requires_authentication() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +28 | +29 | from airflow.auth.managers.fab.api.auth.backend.kerberos_auth import ( + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.requires_authentication` instead. + +AIR302_fab.py:37:1: AIR302 `airflow.auth.managers.fab.api.auth.backend.kerberos_auth.log` is moved into `fab` provider in Airflow 3.0; + | +35 | ) +36 | +37 | log() + | ^^^ AIR302 +38 | CLIENT_AUTH +39 | find_user() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.log` instead. + +AIR302_fab.py:38:1: AIR302 `airflow.auth.managers.fab.api.auth.backend.kerberos_auth.CLIENT_AUTH` is moved into `fab` provider in Airflow 3.0; + | +37 | log() +38 | CLIENT_AUTH + | ^^^^^^^^^^^ AIR302 +39 | find_user() +40 | init_app() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.CLIENT_AUTH` instead. + +AIR302_fab.py:39:1: AIR302 `airflow.auth.managers.fab.api.auth.backend.kerberos_auth.find_user` is moved into `fab` provider in Airflow 3.0; + | +37 | log() +38 | CLIENT_AUTH +39 | find_user() + | ^^^^^^^^^ AIR302 +40 | init_app() +41 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.find_user` instead. + +AIR302_fab.py:40:1: AIR302 `airflow.auth.managers.fab.api.auth.backend.kerberos_auth.init_app` is moved into `fab` provider in Airflow 3.0; + | +38 | CLIENT_AUTH +39 | find_user() +40 | init_app() + | ^^^^^^^^ AIR302 +41 | requires_authentication() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.init_app` instead. + +AIR302_fab.py:41:1: AIR302 `airflow.auth.managers.fab.api.auth.backend.kerberos_auth.requires_authentication` is moved into `fab` provider in Airflow 3.0; + | +39 | find_user() +40 | init_app() +41 | requires_authentication() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +42 | +43 | from airflow.auth.managers.fab.fab_auth_manager import FabAuthManager + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.requires_authentication` instead. + +AIR302_fab.py:49:1: AIR302 `airflow.auth.managers.fab.fab_auth_manager.FabAuthManager` is moved into `fab` provider in Airflow 3.0; + | +47 | ) +48 | +49 | FabAuthManager() + | ^^^^^^^^^^^^^^ AIR302 +50 | MAX_NUM_DATABASE_USER_SESSIONS +51 | FabAirflowSecurityManagerOverride() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager` instead. + +AIR302_fab.py:50:1: AIR302 `airflow.auth.managers.fab.security_manager.override.MAX_NUM_DATABASE_USER_SESSIONS` is moved into `fab` provider in Airflow 3.0; + | +49 | FabAuthManager() +50 | MAX_NUM_DATABASE_USER_SESSIONS + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +51 | FabAirflowSecurityManagerOverride() + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.security_manager.override.MAX_NUM_DATABASE_USER_SESSIONS` instead. + +AIR302_fab.py:51:1: AIR302 `airflow.auth.managers.fab.security_manager.override.FabAirflowSecurityManagerOverride` is moved into `fab` provider in Airflow 3.0; + | +49 | FabAuthManager() +50 | MAX_NUM_DATABASE_USER_SESSIONS +51 | FabAirflowSecurityManagerOverride() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +52 | +53 | from airflow.www.security import FabAirflowSecurityManagerOverride + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride` instead. + +AIR302_fab.py:55:1: AIR302 `airflow.www.security.FabAirflowSecurityManagerOverride` is moved into `fab` provider in Airflow 3.0; + | +53 | from airflow.www.security import FabAirflowSecurityManagerOverride +54 | +55 | FabAirflowSecurityManagerOverride() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-fab>=1.0.0` and use `airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hdfs.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hdfs.py.snap new file mode 100644 index 0000000000000..8ff613fea1cdb --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hdfs.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_hdfs.py:6:1: AIR302 `airflow.hooks.webhdfs_hook.WebHDFSHook` is moved into `apache-hdfs` provider in Airflow 3.0; + | +4 | from airflow.sensors.web_hdfs_sensor import WebHdfsSensor +5 | +6 | WebHDFSHook() + | ^^^^^^^^^^^ AIR302 +7 | WebHdfsSensor() + | + = help: Install `apache-airflow-providers-apache-hdfs>=1.0.0` and use `airflow.providers.apache.hdfs.hooks.webhdfs.WebHDFSHook` instead. + +AIR302_hdfs.py:7:1: AIR302 `airflow.sensors.web_hdfs_sensor.WebHdfsSensor` is moved into `apache-hdfs` provider in Airflow 3.0; + | +6 | WebHDFSHook() +7 | WebHdfsSensor() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-apache-hdfs>=1.0.0` and use `airflow.providers.apache.hdfs.sensors.web_hdfs.WebHdfsSensor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hive.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hive.py.snap new file mode 100644 index 0000000000000..aa035c4ff715c --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_hive.py.snap @@ -0,0 +1,208 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_hive.py:36:1: AIR302 `airflow.macros.hive.closest_ds_partition` is moved into `apache-hive` provider in Airflow 3.0; + | +34 | from airflow.sensors.named_hive_partition_sensor import NamedHivePartitionSensor +35 | +36 | closest_ds_partition() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +37 | max_partition() + | + = help: Install `apache-airflow-providers-apache-hive>=5.1.0` and use `airflow.providers.apache.hive.macros.hive.closest_ds_partition` instead. + +AIR302_hive.py:37:1: AIR302 `airflow.macros.hive.max_partition` is moved into `apache-hive` provider in Airflow 3.0; + | +36 | closest_ds_partition() +37 | max_partition() + | ^^^^^^^^^^^^^ AIR302 +38 | +39 | HiveCliHook() + | + = help: Install `apache-airflow-providers-apache-hive>=5.1.0` and use `airflow.providers.apache.hive.macros.hive.max_partition` instead. + +AIR302_hive.py:39:1: AIR302 `airflow.hooks.hive_hooks.HiveCliHook` is moved into `apache-hive` provider in Airflow 3.0; + | +37 | max_partition() +38 | +39 | HiveCliHook() + | ^^^^^^^^^^^ AIR302 +40 | HiveMetastoreHook() +41 | HiveServer2Hook() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.hooks.hive.HiveCliHook` instead. + +AIR302_hive.py:40:1: AIR302 `airflow.hooks.hive_hooks.HiveMetastoreHook` is moved into `apache-hive` provider in Airflow 3.0; + | +39 | HiveCliHook() +40 | HiveMetastoreHook() + | ^^^^^^^^^^^^^^^^^ AIR302 +41 | HiveServer2Hook() +42 | HIVE_QUEUE_PRIORITIES + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.hooks.hive.HiveMetastoreHook` instead. + +AIR302_hive.py:41:1: AIR302 `airflow.hooks.hive_hooks.HiveServer2Hook` is moved into `apache-hive` provider in Airflow 3.0; + | +39 | HiveCliHook() +40 | HiveMetastoreHook() +41 | HiveServer2Hook() + | ^^^^^^^^^^^^^^^ AIR302 +42 | HIVE_QUEUE_PRIORITIES + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.hooks.hive.HiveServer2Hook` instead. + +AIR302_hive.py:42:1: AIR302 `airflow.hooks.hive_hooks.HIVE_QUEUE_PRIORITIES` is moved into `apache-hive` provider in Airflow 3.0; + | +40 | HiveMetastoreHook() +41 | HiveServer2Hook() +42 | HIVE_QUEUE_PRIORITIES + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +43 | +44 | HiveOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.hooks.hive.HIVE_QUEUE_PRIORITIES` instead. + +AIR302_hive.py:44:1: AIR302 `airflow.operators.hive_operator.HiveOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +42 | HIVE_QUEUE_PRIORITIES +43 | +44 | HiveOperator() + | ^^^^^^^^^^^^ AIR302 +45 | +46 | HiveStatsCollectionOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.operators.hive.HiveOperator` instead. + +AIR302_hive.py:46:1: AIR302 `airflow.operators.hive_stats_operator.HiveStatsCollectionOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +44 | HiveOperator() +45 | +46 | HiveStatsCollectionOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +47 | +48 | HiveToMySqlOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.operators.hive_stats.HiveStatsCollectionOperator` instead. + +AIR302_hive.py:48:1: AIR302 `airflow.operators.hive_to_mysql.HiveToMySqlOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +46 | HiveStatsCollectionOperator() +47 | +48 | HiveToMySqlOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +49 | HiveToMySqlTransfer() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.hive_to_mysql.HiveToMySqlOperator` instead. + +AIR302_hive.py:49:1: AIR302 `airflow.operators.hive_to_mysql.HiveToMySqlTransfer` is moved into `apache-hive` provider in Airflow 3.0; + | +48 | HiveToMySqlOperator() +49 | HiveToMySqlTransfer() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +50 | +51 | HiveToSambaOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.hive_to_mysql.HiveToMySqlOperator` instead. + +AIR302_hive.py:51:1: AIR302 `airflow.operators.hive_to_samba_operator.HiveToSambaOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +49 | HiveToMySqlTransfer() +50 | +51 | HiveToSambaOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +52 | +53 | MsSqlToHiveOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.hive_to_samba.HiveToSambaOperator` instead. + +AIR302_hive.py:53:1: AIR302 `airflow.operators.mssql_to_hive.MsSqlToHiveOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +51 | HiveToSambaOperator() +52 | +53 | MsSqlToHiveOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +54 | MsSqlToHiveTransfer() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.mssql_to_hive.MsSqlToHiveOperator` instead. + +AIR302_hive.py:54:1: AIR302 `airflow.operators.mssql_to_hive.MsSqlToHiveTransfer` is moved into `apache-hive` provider in Airflow 3.0; + | +53 | MsSqlToHiveOperator() +54 | MsSqlToHiveTransfer() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +55 | +56 | MySqlToHiveOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.mssql_to_hive.MsSqlToHiveOperator` instead. + +AIR302_hive.py:56:1: AIR302 `airflow.operators.mysql_to_hive.MySqlToHiveOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +54 | MsSqlToHiveTransfer() +55 | +56 | MySqlToHiveOperator() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +57 | MySqlToHiveTransfer() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.mysql_to_hive.MySqlToHiveOperator` instead. + +AIR302_hive.py:57:1: AIR302 `airflow.operators.mysql_to_hive.MySqlToHiveTransfer` is moved into `apache-hive` provider in Airflow 3.0; + | +56 | MySqlToHiveOperator() +57 | MySqlToHiveTransfer() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +58 | +59 | S3ToHiveOperator() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.mysql_to_hive.MySqlToHiveOperator` instead. + +AIR302_hive.py:59:1: AIR302 `airflow.operators.s3_to_hive_operator.S3ToHiveOperator` is moved into `apache-hive` provider in Airflow 3.0; + | +57 | MySqlToHiveTransfer() +58 | +59 | S3ToHiveOperator() + | ^^^^^^^^^^^^^^^^ AIR302 +60 | S3ToHiveTransfer() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.s3_to_hive.S3ToHiveOperator` instead. + +AIR302_hive.py:60:1: AIR302 `airflow.operators.s3_to_hive_operator.S3ToHiveTransfer` is moved into `apache-hive` provider in Airflow 3.0; + | +59 | S3ToHiveOperator() +60 | S3ToHiveTransfer() + | ^^^^^^^^^^^^^^^^ AIR302 +61 | +62 | HivePartitionSensor() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.transfers.s3_to_hive.S3ToHiveOperator` instead. + +AIR302_hive.py:62:1: AIR302 `airflow.sensors.hive_partition_sensor.HivePartitionSensor` is moved into `apache-hive` provider in Airflow 3.0; + | +60 | S3ToHiveTransfer() +61 | +62 | HivePartitionSensor() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +63 | +64 | MetastorePartitionSensor() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.sensors.hive_partition.HivePartitionSensor` instead. + +AIR302_hive.py:64:1: AIR302 `airflow.sensors.metastore_partition_sensor.MetastorePartitionSensor` is moved into `apache-hive` provider in Airflow 3.0; + | +62 | HivePartitionSensor() +63 | +64 | MetastorePartitionSensor() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +65 | +66 | NamedHivePartitionSensor() + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.sensors.metastore_partition.MetastorePartitionSensor` instead. + +AIR302_hive.py:66:1: AIR302 `airflow.sensors.named_hive_partition_sensor.NamedHivePartitionSensor` is moved into `apache-hive` provider in Airflow 3.0; + | +64 | MetastorePartitionSensor() +65 | +66 | NamedHivePartitionSensor() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-apache-hive>=1.0.0` and use `airflow.providers.apache.hive.sensors.named_hive_partition.NamedHivePartitionSensor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_http.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_http.py.snap new file mode 100644 index 0000000000000..d8ab77304dd63 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_http.py.snap @@ -0,0 +1,42 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_http.py:7:1: AIR302 `airflow.hooks.http_hook.HttpHook` is moved into `http` provider in Airflow 3.0; + | +5 | from airflow.sensors.http_sensor import HttpSensor +6 | +7 | HttpHook() + | ^^^^^^^^ AIR302 +8 | SimpleHttpOperator() +9 | HttpSensor() + | + = help: Install `apache-airflow-providers-http>=1.0.0` and use `airflow.providers.http.hooks.http.HttpHook` instead. + +AIR302_http.py:8:1: AIR302 [*] `airflow.operators.http_operator.SimpleHttpOperator` is moved into `http` provider in Airflow 3.0; + | +7 | HttpHook() +8 | SimpleHttpOperator() + | ^^^^^^^^^^^^^^^^^^ AIR302 +9 | HttpSensor() + | + = help: Install `apache-airflow-providers-http>=5.0.0` and use `airflow.providers.http.operators.http.HttpOperator` instead. + +ℹ Safe fix +3 3 | from airflow.hooks.http_hook import HttpHook +4 4 | from airflow.operators.http_operator import SimpleHttpOperator +5 5 | from airflow.sensors.http_sensor import HttpSensor + 6 |+from airflow.providers.http.operators.http import HttpOperator +6 7 | +7 8 | HttpHook() +8 |-SimpleHttpOperator() + 9 |+HttpOperator() +9 10 | HttpSensor() + +AIR302_http.py:9:1: AIR302 `airflow.sensors.http_sensor.HttpSensor` is moved into `http` provider in Airflow 3.0; + | +7 | HttpHook() +8 | SimpleHttpOperator() +9 | HttpSensor() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-http>=1.0.0` and use `airflow.providers.http.sensors.http.HttpSensor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_jdbc.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_jdbc.py.snap new file mode 100644 index 0000000000000..ab257a2b2479f --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_jdbc.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_jdbc.py:8:1: AIR302 `airflow.hooks.jdbc_hook.JdbcHook` is moved into `jdbc` provider in Airflow 3.0; + | +6 | ) +7 | +8 | JdbcHook() + | ^^^^^^^^ AIR302 +9 | jaydebeapi() + | + = help: Install `apache-airflow-providers-jdbc>=1.0.0` and use `airflow.providers.jdbc.hooks.jdbc.JdbcHook` instead. + +AIR302_jdbc.py:9:1: AIR302 `airflow.hooks.jdbc_hook.jaydebeapi` is moved into `jdbc` provider in Airflow 3.0; + | +8 | JdbcHook() +9 | jaydebeapi() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-jdbc>=1.0.0` and use `airflow.providers.jdbc.hooks.jdbc.jaydebeapi` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_kubernetes.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_kubernetes.py.snap new file mode 100644 index 0000000000000..cd35c51ba2a92 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_kubernetes.py.snap @@ -0,0 +1,599 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_kubernetes.py:29:1: AIR302 `airflow.executors.kubernetes_executor_types.ALL_NAMESPACES` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +27 | ) +28 | +29 | ALL_NAMESPACES + | ^^^^^^^^^^^^^^ AIR302 +30 | POD_EXECUTOR_DONE_KEY + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.executors.kubernetes_executor_types.ALL_NAMESPACES` instead. + +AIR302_kubernetes.py:30:1: AIR302 `airflow.executors.kubernetes_executor_types.POD_EXECUTOR_DONE_KEY` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +29 | ALL_NAMESPACES +30 | POD_EXECUTOR_DONE_KEY + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +31 | +32 | K8SModel() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.executors.kubernetes_executor_types.POD_EXECUTOR_DONE_KEY` instead. + +AIR302_kubernetes.py:32:1: AIR302 `airflow.kubernetes.k8s_model.K8SModel` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +30 | POD_EXECUTOR_DONE_KEY +31 | +32 | K8SModel() + | ^^^^^^^^ AIR302 +33 | append_to_pod() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.k8s_model.K8SModel` instead. + +AIR302_kubernetes.py:33:1: AIR302 `airflow.kubernetes.k8s_model.append_to_pod` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +32 | K8SModel() +33 | append_to_pod() + | ^^^^^^^^^^^^^ AIR302 +34 | +35 | _disable_verify_ssl() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.k8s_model.append_to_pod` instead. + +AIR302_kubernetes.py:35:1: AIR302 `airflow.kubernetes.kube_client._disable_verify_ssl` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +33 | append_to_pod() +34 | +35 | _disable_verify_ssl() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +36 | _enable_tcp_keepalive() +37 | get_kube_client() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kube_client._disable_verify_ssl` instead. + +AIR302_kubernetes.py:36:1: AIR302 `airflow.kubernetes.kube_client._enable_tcp_keepalive` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +35 | _disable_verify_ssl() +36 | _enable_tcp_keepalive() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +37 | get_kube_client() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kube_client._enable_tcp_keepalive` instead. + +AIR302_kubernetes.py:37:1: AIR302 `airflow.kubernetes.kube_client.get_kube_client` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +35 | _disable_verify_ssl() +36 | _enable_tcp_keepalive() +37 | get_kube_client() + | ^^^^^^^^^^^^^^^ AIR302 +38 | +39 | add_pod_suffix() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kube_client.get_kube_client` instead. + +AIR302_kubernetes.py:39:1: AIR302 [*] `airflow.kubernetes.kubernetes_helper_functions.add_pod_suffix` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +37 | get_kube_client() +38 | +39 | add_pod_suffix() + | ^^^^^^^^^^^^^^ AIR302 +40 | create_pod_id() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=10.0.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.add_unique_suffix` instead. + +ℹ Safe fix +25 25 | Port, +26 26 | Resources, +27 27 | ) + 28 |+from airflow.providers.cncf.kubernetes.kubernetes_helper_functions import add_unique_suffix +28 29 | +29 30 | ALL_NAMESPACES +30 31 | POD_EXECUTOR_DONE_KEY +-------------------------------------------------------------------------------- +36 37 | _enable_tcp_keepalive() +37 38 | get_kube_client() +38 39 | +39 |-add_pod_suffix() + 40 |+add_unique_suffix() +40 41 | create_pod_id() +41 42 | +42 43 | annotations_for_logging_task_metadata() + +AIR302_kubernetes.py:40:1: AIR302 [*] `airflow.kubernetes.kubernetes_helper_functions.create_pod_id` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +39 | add_pod_suffix() +40 | create_pod_id() + | ^^^^^^^^^^^^^ AIR302 +41 | +42 | annotations_for_logging_task_metadata() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=10.0.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.create_unique_id` instead. + +ℹ Safe fix +25 25 | Port, +26 26 | Resources, +27 27 | ) + 28 |+from airflow.providers.cncf.kubernetes.kubernetes_helper_functions import create_unique_id +28 29 | +29 30 | ALL_NAMESPACES +30 31 | POD_EXECUTOR_DONE_KEY +-------------------------------------------------------------------------------- +37 38 | get_kube_client() +38 39 | +39 40 | add_pod_suffix() +40 |-create_pod_id() + 41 |+create_unique_id() +41 42 | +42 43 | annotations_for_logging_task_metadata() +43 44 | annotations_to_key() + +AIR302_kubernetes.py:42:1: AIR302 `airflow.kubernetes.kubernetes_helper_functions.annotations_for_logging_task_metadata` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +40 | create_pod_id() +41 | +42 | annotations_for_logging_task_metadata() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +43 | annotations_to_key() +44 | get_logs_task_metadata() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.annotations_for_logging_task_metadata` instead. + +AIR302_kubernetes.py:43:1: AIR302 `airflow.kubernetes.kubernetes_helper_functions.annotations_to_key` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +42 | annotations_for_logging_task_metadata() +43 | annotations_to_key() + | ^^^^^^^^^^^^^^^^^^ AIR302 +44 | get_logs_task_metadata() +45 | rand_str() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.annotations_to_key` instead. + +AIR302_kubernetes.py:44:1: AIR302 `airflow.kubernetes.kubernetes_helper_functions.get_logs_task_metadata` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +42 | annotations_for_logging_task_metadata() +43 | annotations_to_key() +44 | get_logs_task_metadata() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 +45 | rand_str() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.get_logs_task_metadata` instead. + +AIR302_kubernetes.py:45:1: AIR302 `airflow.kubernetes.kubernetes_helper_functions.rand_str` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +43 | annotations_to_key() +44 | get_logs_task_metadata() +45 | rand_str() + | ^^^^^^^^ AIR302 +46 | +47 | Port() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.rand_str` instead. + +AIR302_kubernetes.py:47:1: AIR302 [*] `airflow.kubernetes.pod.Port` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +45 | rand_str() +46 | +47 | Port() + | ^^^^ AIR302 +48 | Resources() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `kubernetes.client.models.V1ContainerPort` instead. + +ℹ Safe fix +25 25 | Port, +26 26 | Resources, +27 27 | ) + 28 |+from kubernetes.client.models import V1ContainerPort +28 29 | +29 30 | ALL_NAMESPACES +30 31 | POD_EXECUTOR_DONE_KEY +-------------------------------------------------------------------------------- +44 45 | get_logs_task_metadata() +45 46 | rand_str() +46 47 | +47 |-Port() + 48 |+V1ContainerPort() +48 49 | Resources() +49 50 | +50 51 | + +AIR302_kubernetes.py:48:1: AIR302 [*] `airflow.kubernetes.pod.Resources` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +47 | Port() +48 | Resources() + | ^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `kubernetes.client.models.V1ResourceRequirements` instead. + +ℹ Safe fix +25 25 | Port, +26 26 | Resources, +27 27 | ) + 28 |+from kubernetes.client.models import V1ResourceRequirements +28 29 | +29 30 | ALL_NAMESPACES +30 31 | POD_EXECUTOR_DONE_KEY +-------------------------------------------------------------------------------- +45 46 | rand_str() +46 47 | +47 48 | Port() +48 |-Resources() + 49 |+V1ResourceRequirements() +49 50 | +50 51 | +51 52 | from airflow.kubernetes.pod_generator import ( + +AIR302_kubernetes.py:64:1: AIR302 `airflow.kubernetes.pod_generator.datetime_to_label_safe_datestring` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +62 | ) +63 | +64 | datetime_to_label_safe_datestring() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +65 | extend_object_field() +66 | label_safe_datestring_to_datetime() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.datetime_to_label_safe_datestring` instead. + +AIR302_kubernetes.py:65:1: AIR302 `airflow.kubernetes.pod_generator.extend_object_field` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +64 | datetime_to_label_safe_datestring() +65 | extend_object_field() + | ^^^^^^^^^^^^^^^^^^^ AIR302 +66 | label_safe_datestring_to_datetime() +67 | make_safe_label_value() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.extend_object_field` instead. + +AIR302_kubernetes.py:66:1: AIR302 `airflow.kubernetes.pod_generator.label_safe_datestring_to_datetime` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +64 | datetime_to_label_safe_datestring() +65 | extend_object_field() +66 | label_safe_datestring_to_datetime() + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +67 | make_safe_label_value() +68 | merge_objects() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.label_safe_datestring_to_datetime` instead. + +AIR302_kubernetes.py:67:1: AIR302 `airflow.kubernetes.pod_generator.make_safe_label_value` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +65 | extend_object_field() +66 | label_safe_datestring_to_datetime() +67 | make_safe_label_value() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +68 | merge_objects() +69 | PodGenerator() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.make_safe_label_value` instead. + +AIR302_kubernetes.py:68:1: AIR302 `airflow.kubernetes.pod_generator.merge_objects` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +66 | label_safe_datestring_to_datetime() +67 | make_safe_label_value() +68 | merge_objects() + | ^^^^^^^^^^^^^ AIR302 +69 | PodGenerator() +70 | PodDefaults() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.merge_objects` instead. + +AIR302_kubernetes.py:69:1: AIR302 `airflow.kubernetes.pod_generator.PodGenerator` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +67 | make_safe_label_value() +68 | merge_objects() +69 | PodGenerator() + | ^^^^^^^^^^^^ AIR302 +70 | PodDefaults() +71 | PodGeneratorDeprecated() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.PodGenerator` instead. + +AIR302_kubernetes.py:70:1: AIR302 `airflow.kubernetes.pod_generator.PodDefaults` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +68 | merge_objects() +69 | PodGenerator() +70 | PodDefaults() + | ^^^^^^^^^^^ AIR302 +71 | PodGeneratorDeprecated() +72 | add_pod_suffix() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.utils.xcom_sidecar.PodDefaults` instead. + +AIR302_kubernetes.py:71:1: AIR302 `airflow.kubernetes.pod_generator.PodGeneratorDeprecated` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +69 | PodGenerator() +70 | PodDefaults() +71 | PodGeneratorDeprecated() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 +72 | add_pod_suffix() +73 | rand_str() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.PodGenerator` instead. + +AIR302_kubernetes.py:72:1: AIR302 [*] `airflow.kubernetes.pod_generator.add_pod_suffix` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +70 | PodDefaults() +71 | PodGeneratorDeprecated() +72 | add_pod_suffix() + | ^^^^^^^^^^^^^^ AIR302 +73 | rand_str() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=10.0.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.add_unique_suffix` instead. + +ℹ Safe fix +60 60 | merge_objects, +61 61 | rand_str, +62 62 | ) + 63 |+from airflow.providers.cncf.kubernetes.kubernetes_helper_functions import add_unique_suffix +63 64 | +64 65 | datetime_to_label_safe_datestring() +65 66 | extend_object_field() +-------------------------------------------------------------------------------- +69 70 | PodGenerator() +70 71 | PodDefaults() +71 72 | PodGeneratorDeprecated() +72 |-add_pod_suffix() + 73 |+add_unique_suffix() +73 74 | rand_str() +74 75 | +75 76 | + +AIR302_kubernetes.py:73:1: AIR302 `airflow.kubernetes.pod_generator.rand_str` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +71 | PodGeneratorDeprecated() +72 | add_pod_suffix() +73 | rand_str() + | ^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kubernetes_helper_functions.rand_str` instead. + +AIR302_kubernetes.py:86:1: AIR302 `airflow.kubernetes.pod_generator_deprecated.PodDefaults` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +84 | ) +85 | +86 | PodDefaults() + | ^^^^^^^^^^^ AIR302 +87 | PodGenerator() +88 | make_safe_label_value() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.utils.xcom_sidecar.PodDefaults` instead. + +AIR302_kubernetes.py:87:1: AIR302 `airflow.kubernetes.pod_generator_deprecated.PodGenerator` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +86 | PodDefaults() +87 | PodGenerator() + | ^^^^^^^^^^^^ AIR302 +88 | make_safe_label_value() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.PodGenerator` instead. + +AIR302_kubernetes.py:88:1: AIR302 `airflow.kubernetes.pod_generator_deprecated.make_safe_label_value` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +86 | PodDefaults() +87 | PodGenerator() +88 | make_safe_label_value() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +89 | +90 | PodLauncher() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.pod_generator.make_safe_label_value` instead. + +AIR302_kubernetes.py:90:1: AIR302 [*] `airflow.kubernetes.pod_launcher.PodLauncher` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +88 | make_safe_label_value() +89 | +90 | PodLauncher() + | ^^^^^^^^^^^ AIR302 +91 | PodStatus() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=3.0.0` and use `airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager` instead. + +ℹ Safe fix +82 82 | PodLauncher, +83 83 | PodStatus, +84 84 | ) + 85 |+from airflow.providers.cncf.kubernetes.utils.pod_manager import PodManager +85 86 | +86 87 | PodDefaults() +87 88 | PodGenerator() +88 89 | make_safe_label_value() +89 90 | +90 |-PodLauncher() + 91 |+PodManager() +91 92 | PodStatus() +92 93 | +93 94 | + +AIR302_kubernetes.py:91:1: AIR302 [*] `airflow.kubernetes.pod_launcher.PodStatus` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +90 | PodLauncher() +91 | PodStatus() + | ^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=3.0.0` and use ` airflow.providers.cncf.kubernetes.utils.pod_manager.PodPhase` instead. + +ℹ Safe fix +82 82 | PodLauncher, +83 83 | PodStatus, +84 84 | ) + 85 |+from airflow.providers.cncf.kubernetes.utils.pod_manager import PodPhase +85 86 | +86 87 | PodDefaults() +87 88 | PodGenerator() +88 89 | make_safe_label_value() +89 90 | +90 91 | PodLauncher() +91 |-PodStatus() + 92 |+PodPhase() +92 93 | +93 94 | +94 95 | from airflow.kubernetes.pod_launcher_deprecated import ( + +AIR302_kubernetes.py:108:1: AIR302 `airflow.kubernetes.pod_launcher_deprecated.PodDefaults` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +106 | from airflow.kubernetes.volume_mount import VolumeMount +107 | +108 | PodDefaults() + | ^^^^^^^^^^^ AIR302 +109 | PodLauncher() +110 | PodStatus() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.utils.xcom_sidecar.PodDefaults` instead. + +AIR302_kubernetes.py:109:1: AIR302 [*] `airflow.kubernetes.pod_launcher_deprecated.PodLauncher` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +108 | PodDefaults() +109 | PodLauncher() + | ^^^^^^^^^^^ AIR302 +110 | PodStatus() +111 | get_kube_client() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=3.0.0` and use `airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager` instead. + +ℹ Safe fix +104 104 | ) +105 105 | from airflow.kubernetes.volume import Volume +106 106 | from airflow.kubernetes.volume_mount import VolumeMount + 107 |+from airflow.providers.cncf.kubernetes.utils.pod_manager import PodManager +107 108 | +108 109 | PodDefaults() +109 |-PodLauncher() + 110 |+PodManager() +110 111 | PodStatus() +111 112 | get_kube_client() +112 113 | + +AIR302_kubernetes.py:110:1: AIR302 [*] `airflow.kubernetes.pod_launcher_deprecated.PodStatus` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +108 | PodDefaults() +109 | PodLauncher() +110 | PodStatus() + | ^^^^^^^^^ AIR302 +111 | get_kube_client() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=3.0.0` and use ` airflow.providers.cncf.kubernetes.utils.pod_manager.PodPhase` instead. + +ℹ Safe fix +104 104 | ) +105 105 | from airflow.kubernetes.volume import Volume +106 106 | from airflow.kubernetes.volume_mount import VolumeMount + 107 |+from airflow.providers.cncf.kubernetes.utils.pod_manager import PodPhase +107 108 | +108 109 | PodDefaults() +109 110 | PodLauncher() +110 |-PodStatus() + 111 |+PodPhase() +111 112 | get_kube_client() +112 113 | +113 114 | PodRuntimeInfoEnv() + +AIR302_kubernetes.py:111:1: AIR302 `airflow.kubernetes.pod_launcher_deprecated.get_kube_client` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +109 | PodLauncher() +110 | PodStatus() +111 | get_kube_client() + | ^^^^^^^^^^^^^^^ AIR302 +112 | +113 | PodRuntimeInfoEnv() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.kube_client.get_kube_client` instead. + +AIR302_kubernetes.py:113:1: AIR302 [*] `airflow.kubernetes.pod_runtime_info_env.PodRuntimeInfoEnv` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +111 | get_kube_client() +112 | +113 | PodRuntimeInfoEnv() + | ^^^^^^^^^^^^^^^^^ AIR302 +114 | K8SModel() +115 | Secret() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `kubernetes.client.models.V1EnvVar` instead. + +ℹ Safe fix +104 104 | ) +105 105 | from airflow.kubernetes.volume import Volume +106 106 | from airflow.kubernetes.volume_mount import VolumeMount + 107 |+from kubernetes.client.models import V1EnvVar +107 108 | +108 109 | PodDefaults() +109 110 | PodLauncher() +110 111 | PodStatus() +111 112 | get_kube_client() +112 113 | +113 |-PodRuntimeInfoEnv() + 114 |+V1EnvVar() +114 115 | K8SModel() +115 116 | Secret() +116 117 | Volume() + +AIR302_kubernetes.py:114:1: AIR302 `airflow.kubernetes.secret.K8SModel` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +113 | PodRuntimeInfoEnv() +114 | K8SModel() + | ^^^^^^^^ AIR302 +115 | Secret() +116 | Volume() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.k8s_model.K8SModel` instead. + +AIR302_kubernetes.py:115:1: AIR302 `airflow.kubernetes.secret.Secret` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +113 | PodRuntimeInfoEnv() +114 | K8SModel() +115 | Secret() + | ^^^^^^ AIR302 +116 | Volume() +117 | VolumeMount() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `airflow.providers.cncf.kubernetes.secret.Secret` instead. + +AIR302_kubernetes.py:116:1: AIR302 [*] `airflow.kubernetes.volume.Volume` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +114 | K8SModel() +115 | Secret() +116 | Volume() + | ^^^^^^ AIR302 +117 | VolumeMount() + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `kubernetes.client.models.V1Volume` instead. + +ℹ Safe fix +104 104 | ) +105 105 | from airflow.kubernetes.volume import Volume +106 106 | from airflow.kubernetes.volume_mount import VolumeMount + 107 |+from kubernetes.client.models import V1Volume +107 108 | +108 109 | PodDefaults() +109 110 | PodLauncher() +-------------------------------------------------------------------------------- +113 114 | PodRuntimeInfoEnv() +114 115 | K8SModel() +115 116 | Secret() +116 |-Volume() + 117 |+V1Volume() +117 118 | VolumeMount() + +AIR302_kubernetes.py:117:1: AIR302 [*] `airflow.kubernetes.volume_mount.VolumeMount` is moved into `cncf-kubernetes` provider in Airflow 3.0; + | +115 | Secret() +116 | Volume() +117 | VolumeMount() + | ^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-cncf-kubernetes>=7.4.0` and use `kubernetes.client.models.V1VolumeMount` instead. + +ℹ Safe fix +104 104 | ) +105 105 | from airflow.kubernetes.volume import Volume +106 106 | from airflow.kubernetes.volume_mount import VolumeMount + 107 |+from kubernetes.client.models import V1VolumeMount +107 108 | +108 109 | PodDefaults() +109 110 | PodLauncher() +-------------------------------------------------------------------------------- +114 115 | K8SModel() +115 116 | Secret() +116 117 | Volume() +117 |-VolumeMount() + 118 |+V1VolumeMount() diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_mysql.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_mysql.py.snap new file mode 100644 index 0000000000000..d40283a7dd8a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_mysql.py.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_mysql.py:9:1: AIR302 `airflow.hooks.mysql_hook.MySqlHook` is moved into `mysql` provider in Airflow 3.0; + | + 7 | ) + 8 | + 9 | MySqlHook() + | ^^^^^^^^^ AIR302 +10 | PrestoToMySqlOperator() +11 | PrestoToMySqlTransfer() + | + = help: Install `apache-airflow-providers-mysql>=1.0.0` and use `airflow.providers.mysql.hooks.mysql.MySqlHook` instead. + +AIR302_mysql.py:10:1: AIR302 `airflow.operators.presto_to_mysql.PrestoToMySqlOperator` is moved into `mysql` provider in Airflow 3.0; + | + 9 | MySqlHook() +10 | PrestoToMySqlOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +11 | PrestoToMySqlTransfer() + | + = help: Install `apache-airflow-providers-mysql>=1.0.0` and use `airflow.providers.mysql.transfers.presto_to_mysql.PrestoToMySqlOperator` instead. + +AIR302_mysql.py:11:1: AIR302 `airflow.operators.presto_to_mysql.PrestoToMySqlTransfer` is moved into `mysql` provider in Airflow 3.0; + | + 9 | MySqlHook() +10 | PrestoToMySqlOperator() +11 | PrestoToMySqlTransfer() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-mysql>=1.0.0` and use `airflow.providers.mysql.transfers.presto_to_mysql.PrestoToMySqlOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_oracle.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_oracle.py.snap new file mode 100644 index 0000000000000..6b087c471593e --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_oracle.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_oracle.py:5:1: AIR302 `airflow.hooks.oracle_hook.OracleHook` is moved into `oracle` provider in Airflow 3.0; + | +3 | from airflow.hooks.oracle_hook import OracleHook +4 | +5 | OracleHook() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-oracle>=1.0.0` and use `airflow.providers.oracle.hooks.oracle.OracleHook` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_papermill.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_papermill.py.snap new file mode 100644 index 0000000000000..b0ebbed9d619d --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_papermill.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_papermill.py:5:1: AIR302 `airflow.operators.papermill_operator.PapermillOperator` is moved into `papermill` provider in Airflow 3.0; + | +3 | from airflow.operators.papermill_operator import PapermillOperator +4 | +5 | PapermillOperator() + | ^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-papermill>=1.0.0` and use `airflow.providers.papermill.operators.papermill.PapermillOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_pig.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_pig.py.snap new file mode 100644 index 0000000000000..10c5ee05fb1a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_pig.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_pig.py:6:1: AIR302 `airflow.hooks.pig_hook.PigCliHook` is moved into `apache-pig` provider in Airflow 3.0; + | +4 | from airflow.operators.pig_operator import PigOperator +5 | +6 | PigCliHook() + | ^^^^^^^^^^ AIR302 +7 | PigOperator() + | + = help: Install `apache-airflow-providers-apache-pig>=1.0.0` and use `airflow.providers.apache.pig.hooks.pig.PigCliHook` instead. + +AIR302_pig.py:7:1: AIR302 `airflow.operators.pig_operator.PigOperator` is moved into `apache-pig` provider in Airflow 3.0; + | +6 | PigCliHook() +7 | PigOperator() + | ^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-apache-pig>=1.0.0` and use `airflow.providers.apache.pig.operators.pig.PigOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_postgres.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_postgres.py.snap new file mode 100644 index 0000000000000..f54468142b714 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_postgres.py.snap @@ -0,0 +1,19 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_postgres.py:6:1: AIR302 `airflow.hooks.postgres_hook.PostgresHook` is moved into `postgres` provider in Airflow 3.0; + | +4 | from airflow.operators.postgres_operator import Mapping +5 | +6 | PostgresHook() + | ^^^^^^^^^^^^ AIR302 +7 | Mapping() + | + = help: Install `apache-airflow-providers-postgres>=1.0.0` and use `airflow.providers.postgres.hooks.postgres.PostgresHook` instead. + +AIR302_postgres.py:7:1: AIR302 `airflow.operators.postgres_operator.Mapping` is removed in Airflow 3.0 + | +6 | PostgresHook() +7 | Mapping() + | ^^^^^^^ AIR302 + | diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_presto.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_presto.py.snap new file mode 100644 index 0000000000000..cb03cfaf254a1 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_presto.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_presto.py:5:1: AIR302 `airflow.hooks.presto_hook.PrestoHook` is moved into `presto` provider in Airflow 3.0; + | +3 | from airflow.hooks.presto_hook import PrestoHook +4 | +5 | PrestoHook() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-presto>=1.0.0` and use `airflow.providers.presto.hooks.presto.PrestoHook` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_samba.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_samba.py.snap new file mode 100644 index 0000000000000..470f3faa0ed13 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_samba.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_samba.py:5:1: AIR302 `airflow.hooks.samba_hook.SambaHook` is moved into `samba` provider in Airflow 3.0; + | +3 | from airflow.hooks.samba_hook import SambaHook +4 | +5 | SambaHook() + | ^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-samba>=1.0.0` and use `airflow.providers.samba.hooks.samba.SambaHook` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_slack.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_slack.py.snap new file mode 100644 index 0000000000000..40b728f9f505c --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_slack.py.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_slack.py:6:1: AIR302 `airflow.hooks.slack_hook.SlackHook` is moved into `slack` provider in Airflow 3.0; + | +4 | from airflow.operators.slack_operator import SlackAPIOperator, SlackAPIPostOperator +5 | +6 | SlackHook() + | ^^^^^^^^^ AIR302 +7 | SlackAPIOperator() +8 | SlackAPIPostOperator() + | + = help: Install `apache-airflow-providers-slack>=1.0.0` and use `airflow.providers.slack.hooks.slack.SlackHook` instead. + +AIR302_slack.py:7:1: AIR302 `airflow.operators.slack_operator.SlackAPIOperator` is moved into `slack` provider in Airflow 3.0; + | +6 | SlackHook() +7 | SlackAPIOperator() + | ^^^^^^^^^^^^^^^^ AIR302 +8 | SlackAPIPostOperator() + | + = help: Install `apache-airflow-providers-slack>=1.0.0` and use `airflow.providers.slack.operators.slack.SlackAPIOperator` instead. + +AIR302_slack.py:8:1: AIR302 `airflow.operators.slack_operator.SlackAPIPostOperator` is moved into `slack` provider in Airflow 3.0; + | +6 | SlackHook() +7 | SlackAPIOperator() +8 | SlackAPIPostOperator() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-slack>=1.0.0` and use `airflow.providers.slack.operators.slack.SlackAPIPostOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_smtp.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_smtp.py.snap new file mode 100644 index 0000000000000..5bf6522a4d8f4 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_smtp.py.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_smtp.py:5:1: AIR302 `airflow.operators.email_operator.EmailOperator` is moved into `smtp` provider in Airflow 3.0; + | +3 | from airflow.operators.email_operator import EmailOperator +4 | +5 | EmailOperator() + | ^^^^^^^^^^^^^ AIR302 +6 | +7 | from airflow.operators.email import EmailOperator + | + = help: Install `apache-airflow-providers-smtp>=1.0.0` and use `airflow.providers.smtp.operators.smtp.EmailOperator` instead. + +AIR302_smtp.py:9:1: AIR302 `airflow.operators.email.EmailOperator` is moved into `smtp` provider in Airflow 3.0; + | +7 | from airflow.operators.email import EmailOperator +8 | +9 | EmailOperator() + | ^^^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-smtp>=1.0.0` and use `airflow.providers.smtp.operators.smtp.EmailOperator` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_sqlite.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_sqlite.py.snap new file mode 100644 index 0000000000000..6b3b7dcbc4570 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_sqlite.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_sqlite.py:5:1: AIR302 `airflow.hooks.sqlite_hook.SqliteHook` is moved into `sqlite` provider in Airflow 3.0; + | +3 | from airflow.hooks.sqlite_hook import SqliteHook +4 | +5 | SqliteHook() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-sqlite>=1.0.0` and use `airflow.providers.sqlite.hooks.sqlite.SqliteHook` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_standard.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_standard.py.snap new file mode 100644 index 0000000000000..59eb6df5628d3 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_standard.py.snap @@ -0,0 +1,232 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_standard.py:25:1: AIR302 `airflow.operators.bash_operator.BashOperator` is moved into `standard` provider in Airflow 3.0; + | +23 | ) +24 | +25 | BashOperator() + | ^^^^^^^^^^^^ AIR302 +26 | +27 | TriggerDagRunLink() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.bash.BashOperator` instead. + +AIR302_standard.py:27:1: AIR302 `airflow.operators.dagrun_operator.TriggerDagRunLink` is moved into `standard` provider in Airflow 3.0; + | +25 | BashOperator() +26 | +27 | TriggerDagRunLink() + | ^^^^^^^^^^^^^^^^^ AIR302 +28 | TriggerDagRunOperator() +29 | DummyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunLink` instead. + +AIR302_standard.py:28:1: AIR302 `airflow.operators.dagrun_operator.TriggerDagRunOperator` is moved into `standard` provider in Airflow 3.0; + | +27 | TriggerDagRunLink() +28 | TriggerDagRunOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +29 | DummyOperator() +30 | EmptyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunOperator` instead. + +AIR302_standard.py:29:1: AIR302 `airflow.operators.dummy.DummyOperator` is moved into `standard` provider in Airflow 3.0; + | +27 | TriggerDagRunLink() +28 | TriggerDagRunOperator() +29 | DummyOperator() + | ^^^^^^^^^^^^^ AIR302 +30 | EmptyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.empty.EmptyOperator` instead. + +AIR302_standard.py:30:1: AIR302 `airflow.operators.dummy.EmptyOperator` is moved into `standard` provider in Airflow 3.0; + | +28 | TriggerDagRunOperator() +29 | DummyOperator() +30 | EmptyOperator() + | ^^^^^^^^^^^^^ AIR302 +31 | +32 | LatestOnlyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.empty.EmptyOperator` instead. + +AIR302_standard.py:32:1: AIR302 `airflow.operators.latest_only_operator.LatestOnlyOperator` is moved into `standard` provider in Airflow 3.0; + | +30 | EmptyOperator() +31 | +32 | LatestOnlyOperator() + | ^^^^^^^^^^^^^^^^^^ AIR302 +33 | +34 | BranchPythonOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.operators.latest_only.LatestOnlyOperator` instead. + +AIR302_standard.py:34:1: AIR302 `airflow.operators.python_operator.BranchPythonOperator` is moved into `standard` provider in Airflow 3.0; + | +32 | LatestOnlyOperator() +33 | +34 | BranchPythonOperator() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +35 | PythonOperator() +36 | PythonVirtualenvOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.BranchPythonOperator` instead. + +AIR302_standard.py:35:1: AIR302 `airflow.operators.python_operator.PythonOperator` is moved into `standard` provider in Airflow 3.0; + | +34 | BranchPythonOperator() +35 | PythonOperator() + | ^^^^^^^^^^^^^^ AIR302 +36 | PythonVirtualenvOperator() +37 | ShortCircuitOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.PythonOperator` instead. + +AIR302_standard.py:36:1: AIR302 `airflow.operators.python_operator.PythonVirtualenvOperator` is moved into `standard` provider in Airflow 3.0; + | +34 | BranchPythonOperator() +35 | PythonOperator() +36 | PythonVirtualenvOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR302 +37 | ShortCircuitOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.PythonVirtualenvOperator` instead. + +AIR302_standard.py:37:1: AIR302 `airflow.operators.python_operator.ShortCircuitOperator` is moved into `standard` provider in Airflow 3.0; + | +35 | PythonOperator() +36 | PythonVirtualenvOperator() +37 | ShortCircuitOperator() + | ^^^^^^^^^^^^^^^^^^^^ AIR302 +38 | +39 | ExternalTaskMarker() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.ShortCircuitOperator` instead. + +AIR302_standard.py:39:1: AIR302 `airflow.sensors.external_task_sensor.ExternalTaskMarker` is moved into `standard` provider in Airflow 3.0; + | +37 | ShortCircuitOperator() +38 | +39 | ExternalTaskMarker() + | ^^^^^^^^^^^^^^^^^^ AIR302 +40 | ExternalTaskSensor() +41 | ExternalTaskSensorLink() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalTaskMarker` instead. + +AIR302_standard.py:40:1: AIR302 `airflow.sensors.external_task_sensor.ExternalTaskSensor` is moved into `standard` provider in Airflow 3.0; + | +39 | ExternalTaskMarker() +40 | ExternalTaskSensor() + | ^^^^^^^^^^^^^^^^^^ AIR302 +41 | ExternalTaskSensorLink() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalTaskSensor` instead. + +AIR302_standard.py:41:1: AIR302 `airflow.sensors.external_task_sensor.ExternalTaskSensorLink` is moved into `standard` provider in Airflow 3.0; + | +39 | ExternalTaskMarker() +40 | ExternalTaskSensor() +41 | ExternalTaskSensorLink() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 +42 | +43 | from airflow.operators.dummy_operator import ( + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalTaskSensorLink` instead. + +AIR302_standard.py:48:1: AIR302 `airflow.operators.dummy_operator.DummyOperator` is moved into `standard` provider in Airflow 3.0; + | +46 | ) +47 | +48 | DummyOperator() + | ^^^^^^^^^^^^^ AIR302 +49 | EmptyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.empty.EmptyOperator` instead. + +AIR302_standard.py:49:1: AIR302 `airflow.operators.dummy_operator.EmptyOperator` is moved into `standard` provider in Airflow 3.0; + | +48 | DummyOperator() +49 | EmptyOperator() + | ^^^^^^^^^^^^^ AIR302 +50 | +51 | from airflow.hooks.subprocess import SubprocessResult + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.empty.EmptyOperator` instead. + +AIR302_standard.py:52:1: AIR302 `airflow.hooks.subprocess.SubprocessResult` is moved into `standard` provider in Airflow 3.0; + | +51 | from airflow.hooks.subprocess import SubprocessResult +52 | SubprocessResult() + | ^^^^^^^^^^^^^^^^ AIR302 +53 | from airflow.hooks.subprocess import working_directory +54 | working_directory() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.hooks.subprocess.SubprocessResult` instead. + +AIR302_standard.py:54:1: AIR302 `airflow.hooks.subprocess.working_directory` is moved into `standard` provider in Airflow 3.0; + | +52 | SubprocessResult() +53 | from airflow.hooks.subprocess import working_directory +54 | working_directory() + | ^^^^^^^^^^^^^^^^^ AIR302 +55 | from airflow.operators.datetime import target_times_as_dates +56 | target_times_as_dates() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.hooks.subprocess.working_directory` instead. + +AIR302_standard.py:56:1: AIR302 `airflow.operators.datetime.target_times_as_dates` is moved into `standard` provider in Airflow 3.0; + | +54 | working_directory() +55 | from airflow.operators.datetime import target_times_as_dates +56 | target_times_as_dates() + | ^^^^^^^^^^^^^^^^^^^^^ AIR302 +57 | from airflow.operators.trigger_dagrun import TriggerDagRunLink +58 | TriggerDagRunLink() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.datetime.target_times_as_dates` instead. + +AIR302_standard.py:58:1: AIR302 `airflow.operators.trigger_dagrun.TriggerDagRunLink` is moved into `standard` provider in Airflow 3.0; + | +56 | target_times_as_dates() +57 | from airflow.operators.trigger_dagrun import TriggerDagRunLink +58 | TriggerDagRunLink() + | ^^^^^^^^^^^^^^^^^ AIR302 +59 | from airflow.sensors.external_task import ExternalTaskSensorLink +60 | ExternalTaskSensorLink() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunLink` instead. + +AIR302_standard.py:60:1: AIR302 [*] `airflow.sensors.external_task.ExternalTaskSensorLink` is moved into `standard` provider in Airflow 3.0; + | +58 | TriggerDagRunLink() +59 | from airflow.sensors.external_task import ExternalTaskSensorLink +60 | ExternalTaskSensorLink() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR302 +61 | from airflow.sensors.time_delta import WaitSensor +62 | WaitSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalDagLink` instead. + +ℹ Safe fix +57 57 | from airflow.operators.trigger_dagrun import TriggerDagRunLink +58 58 | TriggerDagRunLink() +59 59 | from airflow.sensors.external_task import ExternalTaskSensorLink +60 |-ExternalTaskSensorLink() + 60 |+from airflow.providers.standard.sensors.external_task import ExternalDagLink + 61 |+ExternalDagLink() +61 62 | from airflow.sensors.time_delta import WaitSensor +62 63 | WaitSensor() + +AIR302_standard.py:62:1: AIR302 `airflow.sensors.time_delta.WaitSensor` is moved into `standard` provider in Airflow 3.0; + | +60 | ExternalTaskSensorLink() +61 | from airflow.sensors.time_delta import WaitSensor +62 | WaitSensor() + | ^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.time_delta.WaitSensor` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_try.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_try.py.snap new file mode 100644 index 0000000000000..6d6d3986fe9dd --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_try.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_zendesk.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_zendesk.py.snap new file mode 100644 index 0000000000000..731774ac962e4 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR302_AIR302_zendesk.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR302_zendesk.py:5:1: AIR302 `airflow.hooks.zendesk_hook.ZendeskHook` is moved into `zendesk` provider in Airflow 3.0; + | +3 | from airflow.hooks.zendesk_hook import ZendeskHook +4 | +5 | ZendeskHook() + | ^^^^^^^^^^^ AIR302 + | + = help: Install `apache-airflow-providers-zendesk>=1.0.0` and use `airflow.providers.zendesk.hooks.zendesk.ZendeskHook` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_args.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_args.py.snap new file mode 100644 index 0000000000000..2637a92e53133 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_args.py.snap @@ -0,0 +1,25 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR311_args.py:13:34: AIR311 `sla_miss_callback` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +13 | DAG(dag_id="class_sla_callback", sla_miss_callback=sla_callback) + | ^^^^^^^^^^^^^^^^^ AIR311 + | + +AIR311_args.py:16:6: AIR311 `sla_miss_callback` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +16 | @dag(sla_miss_callback=sla_callback) + | ^^^^^^^^^^^^^^^^^ AIR311 +17 | def decorator_sla_callback(): +18 | pass + | + +AIR311_args.py:25:9: AIR311 `sla` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +23 | branch_dt_op2 = BranchDateTimeOperator( +24 | task_id="branch_dt_op2", +25 | sla=timedelta(seconds=10), + | ^^^ AIR311 +26 | ) + | diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_names.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_names.py.snap new file mode 100644 index 0000000000000..6c6e72b7a1b3a --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_names.py.snap @@ -0,0 +1,404 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR311_names.py:27:1: AIR311 [*] `airflow.Dataset` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +26 | # airflow +27 | DatasetFromRoot() + | ^^^^^^^^^^^^^^^ AIR311 +28 | +29 | # airflow.datasets + | + = help: Use `airflow.sdk.Asset` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import Asset +25 26 | +26 27 | # airflow +27 |-DatasetFromRoot() + 28 |+Asset() +28 29 | +29 30 | # airflow.datasets +30 31 | Dataset() + +AIR311_names.py:30:1: AIR311 [*] `airflow.datasets.Dataset` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +29 | # airflow.datasets +30 | Dataset() + | ^^^^^^^ AIR311 +31 | DatasetAlias() +32 | DatasetAll() + | + = help: Use `airflow.sdk.Asset` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import Asset +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +28 29 | +29 30 | # airflow.datasets +30 |-Dataset() + 31 |+Asset() +31 32 | DatasetAlias() +32 33 | DatasetAll() +33 34 | DatasetAny() + +AIR311_names.py:31:1: AIR311 [*] `airflow.datasets.DatasetAlias` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +29 | # airflow.datasets +30 | Dataset() +31 | DatasetAlias() + | ^^^^^^^^^^^^ AIR311 +32 | DatasetAll() +33 | DatasetAny() + | + = help: Use `airflow.sdk.AssetAlias` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import AssetAlias +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +28 29 | +29 30 | # airflow.datasets +30 31 | Dataset() +31 |-DatasetAlias() + 32 |+AssetAlias() +32 33 | DatasetAll() +33 34 | DatasetAny() +34 35 | Metadata() + +AIR311_names.py:32:1: AIR311 [*] `airflow.datasets.DatasetAll` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +30 | Dataset() +31 | DatasetAlias() +32 | DatasetAll() + | ^^^^^^^^^^ AIR311 +33 | DatasetAny() +34 | Metadata() + | + = help: Use `airflow.sdk.AssetAll` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import AssetAll +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +29 30 | # airflow.datasets +30 31 | Dataset() +31 32 | DatasetAlias() +32 |-DatasetAll() + 33 |+AssetAll() +33 34 | DatasetAny() +34 35 | Metadata() +35 36 | expand_alias_to_datasets() + +AIR311_names.py:33:1: AIR311 [*] `airflow.datasets.DatasetAny` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +31 | DatasetAlias() +32 | DatasetAll() +33 | DatasetAny() + | ^^^^^^^^^^ AIR311 +34 | Metadata() +35 | expand_alias_to_datasets() + | + = help: Use `airflow.sdk.AssetAny` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import AssetAny +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +30 31 | Dataset() +31 32 | DatasetAlias() +32 33 | DatasetAll() +33 |-DatasetAny() + 34 |+AssetAny() +34 35 | Metadata() +35 36 | expand_alias_to_datasets() +36 37 | + +AIR311_names.py:34:1: AIR311 `airflow.datasets.metadata.Metadata` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +32 | DatasetAll() +33 | DatasetAny() +34 | Metadata() + | ^^^^^^^^ AIR311 +35 | expand_alias_to_datasets() + | + = help: Use `airflow.sdk.Metadata` instead + +AIR311_names.py:35:1: AIR311 [*] `airflow.datasets.expand_alias_to_datasets` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +33 | DatasetAny() +34 | Metadata() +35 | expand_alias_to_datasets() + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR311 +36 | +37 | # airflow.decorators + | + = help: Use `airflow.sdk.expand_alias_to_assets` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import expand_alias_to_assets +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +32 33 | DatasetAll() +33 34 | DatasetAny() +34 35 | Metadata() +35 |-expand_alias_to_datasets() + 36 |+expand_alias_to_assets() +36 37 | +37 38 | # airflow.decorators +38 39 | dag() + +AIR311_names.py:38:1: AIR311 `airflow.decorators.dag` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +37 | # airflow.decorators +38 | dag() + | ^^^ AIR311 +39 | task() +40 | task_group() + | + = help: Use `airflow.sdk.dag` instead + +AIR311_names.py:39:1: AIR311 `airflow.decorators.task` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +37 | # airflow.decorators +38 | dag() +39 | task() + | ^^^^ AIR311 +40 | task_group() +41 | setup() + | + = help: Use `airflow.sdk.task` instead + +AIR311_names.py:40:1: AIR311 `airflow.decorators.task_group` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +38 | dag() +39 | task() +40 | task_group() + | ^^^^^^^^^^ AIR311 +41 | setup() +42 | teardown() + | + = help: Use `airflow.sdk.task_group` instead + +AIR311_names.py:41:1: AIR311 `airflow.decorators.setup` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +39 | task() +40 | task_group() +41 | setup() + | ^^^^^ AIR311 +42 | teardown() + | + = help: Use `airflow.sdk.setup` instead + +AIR311_names.py:42:1: AIR311 `airflow.decorators.teardown` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +40 | task_group() +41 | setup() +42 | teardown() + | ^^^^^^^^ AIR311 +43 | +44 | # airflow.io + | + = help: Use `airflow.sdk.teardown` instead + +AIR311_names.py:45:1: AIR311 `airflow.io.path.ObjectStoragePath` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +44 | # airflow.io +45 | ObjectStoragePath() + | ^^^^^^^^^^^^^^^^^ AIR311 +46 | attach() + | + = help: Use `airflow.sdk.ObjectStoragePath` instead + +AIR311_names.py:46:1: AIR311 `airflow.io.storage.attach` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +44 | # airflow.io +45 | ObjectStoragePath() +46 | attach() + | ^^^^^^ AIR311 +47 | +48 | # airflow.models + | + = help: Use `airflow.sdk.io.attach` instead + +AIR311_names.py:49:1: AIR311 `airflow.models.Connection` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +48 | # airflow.models +49 | Connection() + | ^^^^^^^^^^ AIR311 +50 | DAGFromModel() +51 | Variable() + | + = help: Use `airflow.sdk.Connection` instead + +AIR311_names.py:50:1: AIR311 [*] `airflow.models.DAG` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +48 | # airflow.models +49 | Connection() +50 | DAGFromModel() + | ^^^^^^^^^^^^ AIR311 +51 | Variable() + | + = help: Use `airflow.sdk.DAG` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import DAG +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +47 48 | +48 49 | # airflow.models +49 50 | Connection() +50 |-DAGFromModel() + 51 |+DAG() +51 52 | Variable() +52 53 | +53 54 | # airflow.models.baseoperator + +AIR311_names.py:51:1: AIR311 `airflow.models.Variable` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +49 | Connection() +50 | DAGFromModel() +51 | Variable() + | ^^^^^^^^ AIR311 +52 | +53 | # airflow.models.baseoperator + | + = help: Use `airflow.sdk.Variable` instead + +AIR311_names.py:54:1: AIR311 `airflow.models.baseoperator.chain` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +53 | # airflow.models.baseoperator +54 | chain() + | ^^^^^ AIR311 +55 | chain_linear() +56 | cross_downstream() + | + = help: Use `airflow.sdk.chain` instead + +AIR311_names.py:55:1: AIR311 `airflow.models.baseoperator.chain_linear` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +53 | # airflow.models.baseoperator +54 | chain() +55 | chain_linear() + | ^^^^^^^^^^^^ AIR311 +56 | cross_downstream() + | + = help: Use `airflow.sdk.chain_linear` instead + +AIR311_names.py:56:1: AIR311 `airflow.models.baseoperator.cross_downstream` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +54 | chain() +55 | chain_linear() +56 | cross_downstream() + | ^^^^^^^^^^^^^^^^ AIR311 +57 | +58 | # airflow.models.baseoperatolinker + | + = help: Use `airflow.sdk.cross_downstream` instead + +AIR311_names.py:59:1: AIR311 `airflow.models.baseoperatorlink.BaseOperatorLink` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +58 | # airflow.models.baseoperatolinker +59 | BaseOperatorLink() + | ^^^^^^^^^^^^^^^^ AIR311 +60 | +61 | # airflow.models.dag + | + = help: Use `airflow.sdk.definitions.baseoperatorlink.BaseOperatorLink` instead + +AIR311_names.py:62:1: AIR311 [*] `airflow.models.dag.DAG` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +61 | # airflow.models.dag +62 | DAGFromDag() + | ^^^^^^^^^^ AIR311 +63 | # airflow.timetables.datasets +64 | DatasetOrTimeSchedule() + | + = help: Use `airflow.sdk.DAG` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.sdk import DAG +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +59 60 | BaseOperatorLink() +60 61 | +61 62 | # airflow.models.dag +62 |-DAGFromDag() + 63 |+DAG() +63 64 | # airflow.timetables.datasets +64 65 | DatasetOrTimeSchedule() +65 66 | + +AIR311_names.py:64:1: AIR311 [*] `airflow.timetables.datasets.DatasetOrTimeSchedule` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +62 | DAGFromDag() +63 | # airflow.timetables.datasets +64 | DatasetOrTimeSchedule() + | ^^^^^^^^^^^^^^^^^^^^^ AIR311 +65 | +66 | # airflow.utils.dag_parsing_context + | + = help: Use `airflow.timetables.assets.AssetOrTimeSchedule` instead + +ℹ Safe fix +22 22 | from airflow.models.dag import DAG as DAGFromDag +23 23 | from airflow.timetables.datasets import DatasetOrTimeSchedule +24 24 | from airflow.utils.dag_parsing_context import get_parsing_context + 25 |+from airflow.timetables.assets import AssetOrTimeSchedule +25 26 | +26 27 | # airflow +27 28 | DatasetFromRoot() +-------------------------------------------------------------------------------- +61 62 | # airflow.models.dag +62 63 | DAGFromDag() +63 64 | # airflow.timetables.datasets +64 |-DatasetOrTimeSchedule() + 65 |+AssetOrTimeSchedule() +65 66 | +66 67 | # airflow.utils.dag_parsing_context +67 68 | get_parsing_context() + +AIR311_names.py:67:1: AIR311 `airflow.utils.dag_parsing_context.get_parsing_context` is removed in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +66 | # airflow.utils.dag_parsing_context +67 | get_parsing_context() + | ^^^^^^^^^^^^^^^^^^^ AIR311 + | + = help: Use `airflow.sdk.get_parsing_context` instead diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_try.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_try.py.snap new file mode 100644 index 0000000000000..6d6d3986fe9dd --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR311_AIR311_try.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312.py.snap new file mode 100644 index 0000000000000..6c9523a3c0e13 --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312.py.snap @@ -0,0 +1,304 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- +AIR312.py:32:1: AIR312 `airflow.hooks.filesystem.FSHook` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +30 | from airflow.triggers.temporal import DateTimeTrigger, TimeDeltaTrigger +31 | +32 | FSHook() + | ^^^^^^ AIR312 +33 | PackageIndexHook() +34 | SubprocessHook() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.hooks.filesystem.FSHook` instead. + +AIR312.py:33:1: AIR312 `airflow.hooks.package_index.PackageIndexHook` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +32 | FSHook() +33 | PackageIndexHook() + | ^^^^^^^^^^^^^^^^ AIR312 +34 | SubprocessHook() +35 | BashOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.hooks.package_index.PackageIndexHook` instead. + +AIR312.py:34:1: AIR312 `airflow.hooks.subprocess.SubprocessHook` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +32 | FSHook() +33 | PackageIndexHook() +34 | SubprocessHook() + | ^^^^^^^^^^^^^^ AIR312 +35 | BashOperator() +36 | BranchDateTimeOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.hooks.subprocess.SubprocessHook` instead. + +AIR312.py:35:1: AIR312 `airflow.operators.bash.BashOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +33 | PackageIndexHook() +34 | SubprocessHook() +35 | BashOperator() + | ^^^^^^^^^^^^ AIR312 +36 | BranchDateTimeOperator() +37 | TriggerDagRunOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.bash.BashOperator` instead. + +AIR312.py:36:1: AIR312 `airflow.operators.datetime.BranchDateTimeOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +34 | SubprocessHook() +35 | BashOperator() +36 | BranchDateTimeOperator() + | ^^^^^^^^^^^^^^^^^^^^^^ AIR312 +37 | TriggerDagRunOperator() +38 | EmptyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.datetime.BranchDateTimeOperator` instead. + +AIR312.py:37:1: AIR312 `airflow.operators.trigger_dagrun.TriggerDagRunOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +35 | BashOperator() +36 | BranchDateTimeOperator() +37 | TriggerDagRunOperator() + | ^^^^^^^^^^^^^^^^^^^^^ AIR312 +38 | EmptyOperator() +39 | LatestOnlyOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunOperator` instead. + +AIR312.py:38:1: AIR312 `airflow.operators.empty.EmptyOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +36 | BranchDateTimeOperator() +37 | TriggerDagRunOperator() +38 | EmptyOperator() + | ^^^^^^^^^^^^^ AIR312 +39 | LatestOnlyOperator() +40 | ( + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.operators.empty.EmptyOperator` instead. + +AIR312.py:39:1: AIR312 `airflow.operators.latest_only.LatestOnlyOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +37 | TriggerDagRunOperator() +38 | EmptyOperator() +39 | LatestOnlyOperator() + | ^^^^^^^^^^^^^^^^^^ AIR312 +40 | ( +41 | BranchPythonOperator(), + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.operators.latest_only.LatestOnlyOperator` instead. + +AIR312.py:41:5: AIR312 `airflow.operators.python.BranchPythonOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +39 | LatestOnlyOperator() +40 | ( +41 | BranchPythonOperator(), + | ^^^^^^^^^^^^^^^^^^^^ AIR312 +42 | PythonOperator(), +43 | PythonVirtualenvOperator(), + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.BranchPythonOperator` instead. + +AIR312.py:42:5: AIR312 `airflow.operators.python.PythonOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +40 | ( +41 | BranchPythonOperator(), +42 | PythonOperator(), + | ^^^^^^^^^^^^^^ AIR312 +43 | PythonVirtualenvOperator(), +44 | ShortCircuitOperator(), + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.PythonOperator` instead. + +AIR312.py:43:5: AIR312 `airflow.operators.python.PythonVirtualenvOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +41 | BranchPythonOperator(), +42 | PythonOperator(), +43 | PythonVirtualenvOperator(), + | ^^^^^^^^^^^^^^^^^^^^^^^^ AIR312 +44 | ShortCircuitOperator(), +45 | ) + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.PythonVirtualenvOperator` instead. + +AIR312.py:44:5: AIR312 `airflow.operators.python.ShortCircuitOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +42 | PythonOperator(), +43 | PythonVirtualenvOperator(), +44 | ShortCircuitOperator(), + | ^^^^^^^^^^^^^^^^^^^^ AIR312 +45 | ) +46 | BranchDayOfWeekOperator() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.python.ShortCircuitOperator` instead. + +AIR312.py:46:1: AIR312 `airflow.operators.weekday.BranchDayOfWeekOperator` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +44 | ShortCircuitOperator(), +45 | ) +46 | BranchDayOfWeekOperator() + | ^^^^^^^^^^^^^^^^^^^^^^^ AIR312 +47 | DateTimeSensor(), DateTimeSensorAsync() +48 | ExternalTaskMarker(), ExternalTaskSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.operators.weekday.BranchDayOfWeekOperator` instead. + +AIR312.py:47:1: AIR312 `airflow.sensors.date_time.DateTimeSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +45 | ) +46 | BranchDayOfWeekOperator() +47 | DateTimeSensor(), DateTimeSensorAsync() + | ^^^^^^^^^^^^^^ AIR312 +48 | ExternalTaskMarker(), ExternalTaskSensor() +49 | FileSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.date_time.DateTimeSensor` instead. + +AIR312.py:47:19: AIR312 `airflow.sensors.date_time.DateTimeSensorAsync` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +45 | ) +46 | BranchDayOfWeekOperator() +47 | DateTimeSensor(), DateTimeSensorAsync() + | ^^^^^^^^^^^^^^^^^^^ AIR312 +48 | ExternalTaskMarker(), ExternalTaskSensor() +49 | FileSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.date_time.DateTimeSensorAsync` instead. + +AIR312.py:48:1: AIR312 `airflow.sensors.external_task.ExternalTaskMarker` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +46 | BranchDayOfWeekOperator() +47 | DateTimeSensor(), DateTimeSensorAsync() +48 | ExternalTaskMarker(), ExternalTaskSensor() + | ^^^^^^^^^^^^^^^^^^ AIR312 +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalTaskMarker` instead. + +AIR312.py:48:23: AIR312 `airflow.sensors.external_task.ExternalTaskSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +46 | BranchDayOfWeekOperator() +47 | DateTimeSensor(), DateTimeSensorAsync() +48 | ExternalTaskMarker(), ExternalTaskSensor() + | ^^^^^^^^^^^^^^^^^^ AIR312 +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.sensors.external_task.ExternalTaskSensor` instead. + +AIR312.py:49:1: AIR312 `airflow.sensors.filesystem.FileSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +47 | DateTimeSensor(), DateTimeSensorAsync() +48 | ExternalTaskMarker(), ExternalTaskSensor() +49 | FileSensor() + | ^^^^^^^^^^ AIR312 +50 | TimeSensor(), TimeSensorAsync() +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() + | + = help: Install `apache-airflow-providers-standard>=0.0.2` and use `airflow.providers.standard.sensors.filesystem.FileSensor` instead. + +AIR312.py:50:1: AIR312 `airflow.sensors.time_sensor.TimeSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +48 | ExternalTaskMarker(), ExternalTaskSensor() +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() + | ^^^^^^^^^^ AIR312 +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() +52 | DayOfWeekSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.time.TimeSensor` instead. + +AIR312.py:50:15: AIR312 `airflow.sensors.time_sensor.TimeSensorAsync` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +48 | ExternalTaskMarker(), ExternalTaskSensor() +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() + | ^^^^^^^^^^^^^^^ AIR312 +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() +52 | DayOfWeekSensor() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.time.TimeSensorAsync` instead. + +AIR312.py:51:1: AIR312 `airflow.sensors.time_delta.TimeDeltaSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() + | ^^^^^^^^^^^^^^^ AIR312 +52 | DayOfWeekSensor() +53 | DagStateTrigger(), WorkflowTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.time_delta.TimeDeltaSensor` instead. + +AIR312.py:51:20: AIR312 `airflow.sensors.time_delta.TimeDeltaSensorAsync` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +49 | FileSensor() +50 | TimeSensor(), TimeSensorAsync() +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() + | ^^^^^^^^^^^^^^^^^^^^ AIR312 +52 | DayOfWeekSensor() +53 | DagStateTrigger(), WorkflowTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.time_delta.TimeDeltaSensorAsync` instead. + +AIR312.py:52:1: AIR312 `airflow.sensors.weekday.DayOfWeekSensor` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +50 | TimeSensor(), TimeSensorAsync() +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() +52 | DayOfWeekSensor() + | ^^^^^^^^^^^^^^^ AIR312 +53 | DagStateTrigger(), WorkflowTrigger() +54 | FileTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.1` and use `airflow.providers.standard.sensors.weekday.DayOfWeekSensor` instead. + +AIR312.py:53:1: AIR312 `airflow.triggers.external_task.DagStateTrigger` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() +52 | DayOfWeekSensor() +53 | DagStateTrigger(), WorkflowTrigger() + | ^^^^^^^^^^^^^^^ AIR312 +54 | FileTrigger() +55 | DateTimeTrigger(), TimeDeltaTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.triggers.external_task.DagStateTrigger` instead. + +AIR312.py:53:20: AIR312 `airflow.triggers.external_task.WorkflowTrigger` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +51 | TimeDeltaSensor(), TimeDeltaSensorAsync() +52 | DayOfWeekSensor() +53 | DagStateTrigger(), WorkflowTrigger() + | ^^^^^^^^^^^^^^^ AIR312 +54 | FileTrigger() +55 | DateTimeTrigger(), TimeDeltaTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.triggers.external_task.WorkflowTrigger` instead. + +AIR312.py:54:1: AIR312 `airflow.triggers.file.FileTrigger` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +52 | DayOfWeekSensor() +53 | DagStateTrigger(), WorkflowTrigger() +54 | FileTrigger() + | ^^^^^^^^^^^ AIR312 +55 | DateTimeTrigger(), TimeDeltaTrigger() + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.triggers.file.FileTrigger` instead. + +AIR312.py:55:1: AIR312 `airflow.triggers.temporal.DateTimeTrigger` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +53 | DagStateTrigger(), WorkflowTrigger() +54 | FileTrigger() +55 | DateTimeTrigger(), TimeDeltaTrigger() + | ^^^^^^^^^^^^^^^ AIR312 + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.triggers.temporal.DateTimeTrigger` instead. + +AIR312.py:55:20: AIR312 `airflow.triggers.temporal.TimeDeltaTrigger` is deprecated and moved into `standard` provider in Airflow 3.0; It still works in Airflow 3.0 but is expected to be removed in a future version. + | +53 | DagStateTrigger(), WorkflowTrigger() +54 | FileTrigger() +55 | DateTimeTrigger(), TimeDeltaTrigger() + | ^^^^^^^^^^^^^^^^ AIR312 + | + = help: Install `apache-airflow-providers-standard>=0.0.3` and use `airflow.providers.standard.triggers.temporal.TimeDeltaTrigger` instead. diff --git a/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312_try.py.snap b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312_try.py.snap new file mode 100644 index 0000000000000..6d6d3986fe9dd --- /dev/null +++ b/crates/ruff_linter/src/rules/airflow/snapshots/ruff_linter__rules__airflow__tests__AIR312_AIR312_try.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/airflow/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/eradicate/detection.rs b/crates/ruff_linter/src/rules/eradicate/detection.rs index c3ba54a199350..a5beac11af8e9 100644 --- a/crates/ruff_linter/src/rules/eradicate/detection.rs +++ b/crates/ruff_linter/src/rules/eradicate/detection.rs @@ -16,8 +16,43 @@ static CODE_INDICATORS: LazyLock<AhoCorasick> = LazyLock::new(|| { static ALLOWLIST_REGEX: LazyLock<Regex> = LazyLock::new(|| { Regex::new( - r"^(?i)(?:pylint|pyright|noqa|nosec|region|endregion|type:\s*ignore|fmt:\s*(on|off)|isort:\s*(on|off|skip|skip_file|split|dont-add-imports(:\s*\[.*?])?)|mypy:|SPDX-License-Identifier:|(?:en)?coding[:=][ \t]*([-_.a-zA-Z0-9]+))", - ).unwrap() + r"(?x) + ^ + (?: + # Case-sensitive + pyright + | mypy: + | type:\s*ignore + | SPDX-License-Identifier: + | fmt:\s*(on|off|skip) + | region|endregion + + # Case-insensitive + | (?i: + noqa + ) + + # Unknown case sensitivity + | (?i: + pylint + | nosec + | isort:\s*(on|off|skip|skip_file|split|dont-add-imports(:\s*\[.*?])?) + | (?:en)?coding[:=][\x20\t]*([-_.A-Z0-9]+) + ) + + # IntelliJ language injection comments: + # * `language` must be lowercase. + # * No spaces around `=`. + # * Language IDs as used in comments must have no spaces, + # though to IntelliJ they can be anything. + # * May optionally contain `prefix=` and/or `suffix=`, + # not declared here since we use `.is_match()`. + | language=[-_.a-zA-Z0-9]+ + + ) + ", + ) + .unwrap() }); static HASH_NUMBER: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"#\d").unwrap()); @@ -297,6 +332,48 @@ mod tests { )); } + #[test] + fn comment_contains_language_injection() { + // `language` with bad casing + assert!(comment_contains_code("# Language=C#", &[])); + assert!(comment_contains_code("# lAngUAgE=inI", &[])); + + // Unreasonable language IDs, possibly literals + assert!(comment_contains_code("# language=\"pt\"", &[])); + assert!(comment_contains_code("# language='en'", &[])); + + // Spaces around equal sign + assert!(comment_contains_code("# language =xml", &[])); + assert!(comment_contains_code("# language= html", &[])); + assert!(comment_contains_code("# language = RegExp", &[])); + + // Leading whitespace + assert!(!comment_contains_code("#language=CSS", &[])); + assert!(!comment_contains_code("# \t language=C++", &[])); + + // Human language false negatives + assert!(!comment_contains_code("# language=en", &[])); + assert!(!comment_contains_code("# language=en-US", &[])); + + // Casing (fine because such IDs cannot be validated) + assert!(!comment_contains_code("# language=PytHoN", &[])); + assert!(!comment_contains_code("# language=jaVaScrIpt", &[])); + + // Space within ID (fine because `Shell` is considered the ID) + assert!(!comment_contains_code("# language=Shell Script", &[])); + + // With prefix and/or suffix + assert!(!comment_contains_code("# language=HTML prefix=<body>", &[])); + assert!(!comment_contains_code( + r"# language=Requirements suffix=\n", + &[] + )); + assert!(!comment_contains_code( + "language=javascript prefix=(function(){ suffix=})()", + &[] + )); + } + #[test] fn comment_contains_todo() { let task_tags = TASK_TAGS diff --git a/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs b/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs index 5810ef58c63bd..e7578f14b4a34 100644 --- a/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs +++ b/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_source_file::{LineRanges, UniversalNewlineIterator}; use ruff_text_size::TextRange; -use crate::settings::LinterSettings; use crate::Locator; +use crate::settings::LinterSettings; use super::super::detection::comment_contains_code; @@ -29,19 +29,19 @@ use super::super::detection::comment_contains_code; /// - `lint.task-tags` /// /// [#4845]: https://github.com/astral-sh/ruff/issues/4845 -#[violation] -pub struct CommentedOutCode; +#[derive(ViolationMetadata)] +pub(crate) struct CommentedOutCode; impl Violation for CommentedOutCode { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Found commented-out code") + "Found commented-out code".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Remove commented-out code")) + Some("Remove commented-out code".to_string()) } } @@ -90,33 +90,15 @@ where let line_end = locator.full_line_end(script_start.end()); let rest = locator.after(line_end); let mut end_offset = None; - let mut lines = UniversalNewlineIterator::with_offset(rest, line_end); + let lines = UniversalNewlineIterator::with_offset(rest, line_end); - while let Some(line) = lines.next() { + for line in lines { let Some(content) = script_line_content(&line) else { break; }; if content == "///" { - // > Precedence for an ending line # /// is given when the next line is not a valid - // > embedded content line as described above. - // > For example, the following is a single fully valid block: - // > ```python - // > # /// some-toml - // > # embedded-csharp = """ - // > # /// <summary> - // > # /// text - // > # /// - // > # /// </summary> - // > # public class MyClass { } - // > # """ - // > # /// - // ```` - if lines.next().is_some_and(|line| is_valid_script_line(&line)) { - continue; - } end_offset = Some(line.full_end()); - break; } } @@ -152,10 +134,6 @@ fn script_line_content(line: &str) -> Option<&str> { rest.strip_prefix(' ') } -fn is_valid_script_line(line: &str) -> bool { - script_line_content(line).is_some() -} - /// Returns `true` if line contains an own-line comment. fn is_own_line_comment(line: &str) -> bool { for char in line.chars() { @@ -183,8 +161,8 @@ mod tests { use ruff_source_file::LineRanges; use ruff_text_size::TextSize; - use crate::rules::eradicate::rules::commented_out_code::skip_script_comments; use crate::Locator; + use crate::rules::eradicate::rules::commented_out_code::skip_script_comments; #[test] fn script_comment() { diff --git a/crates/ruff_linter/src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap b/crates/ruff_linter/src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap index 826b94dffbfa6..37331b90077ad 100644 --- a/crates/ruff_linter/src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap +++ b/crates/ruff_linter/src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap @@ -58,7 +58,7 @@ ERA001.py:5:1: ERA001 Found commented-out code 4 | a = 4 5 | #foo(1, 2, 3) | ^^^^^^^^^^^^^ ERA001 -6 | +6 | 7 | def foo(x, y, z): | = help: Remove commented-out code @@ -151,7 +151,7 @@ ERA001.py:27:5: ERA001 Found commented-out code ERA001.py:32:1: ERA001 Found commented-out code | 30 | #import os # noqa -31 | +31 | 32 | # case 1: | ^^^^^^^^^ ERA001 33 | # try: @@ -348,6 +348,8 @@ ERA001.py:78:1: ERA001 Found commented-out code 77 | # "rich", 78 | # ] | ^^^ ERA001 +79 | +80 | # Script tag block followed by normal block (Ok) | = help: Remove commented-out code @@ -356,3 +358,6 @@ ERA001.py:78:1: ERA001 Found commented-out code 76 76 | # "requests<3", 77 77 | # "rich", 78 |-# ] +79 78 | +80 79 | # Script tag block followed by normal block (Ok) +81 80 | diff --git a/crates/ruff_linter/src/rules/fastapi/mod.rs b/crates/ruff_linter/src/rules/fastapi/mod.rs index 7d7f00300ad95..90f52b7d66ec6 100644 --- a/crates/ruff_linter/src/rules/fastapi/mod.rs +++ b/crates/ruff_linter/src/rules/fastapi/mod.rs @@ -14,7 +14,8 @@ mod tests { use crate::{assert_messages, settings}; #[test_case(Rule::FastApiRedundantResponseModel, Path::new("FAST001.py"))] - #[test_case(Rule::FastApiNonAnnotatedDependency, Path::new("FAST002.py"))] + #[test_case(Rule::FastApiNonAnnotatedDependency, Path::new("FAST002_0.py"))] + #[test_case(Rule::FastApiNonAnnotatedDependency, Path::new("FAST002_1.py"))] #[test_case(Rule::FastApiUnusedPathParameter, Path::new("FAST003.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.as_ref(), path.to_string_lossy()); @@ -25,4 +26,21 @@ mod tests { assert_messages!(snapshot, diagnostics); Ok(()) } + + // FAST002 autofixes use `typing_extensions` on Python 3.8, + // since `typing.Annotated` was added in Python 3.9 + #[test_case(Rule::FastApiNonAnnotatedDependency, Path::new("FAST002_0.py"))] + #[test_case(Rule::FastApiNonAnnotatedDependency, Path::new("FAST002_1.py"))] + fn rules_py38(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!("{}_{}_py38", rule_code.as_ref(), path.to_string_lossy()); + let diagnostics = test_path( + Path::new("fastapi").join(path).as_path(), + &settings::LinterSettings { + unresolved_target_version: ruff_python_ast::PythonVersion::PY38.into(), + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } } diff --git a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_non_annotated_dependency.rs b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_non_annotated_dependency.rs index 6d116ebad51a3..2ef280bd2e11e 100644 --- a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_non_annotated_dependency.rs +++ b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_non_annotated_dependency.rs @@ -1,24 +1,27 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::helpers::map_callable; use ruff_python_semantic::Modules; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; -use crate::importer::ImportRequest; use crate::rules::fastapi::rules::is_fastapi_route; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does -/// Identifies FastAPI routes with deprecated uses of `Depends`. +/// Identifies FastAPI routes with deprecated uses of `Depends` or similar. /// /// ## Why is this bad? -/// The FastAPI documentation recommends the use of `Annotated` for defining -/// route dependencies and parameters, rather than using `Depends` directly -/// with a default value. +/// The [FastAPI documentation] recommends the use of [`typing.Annotated`][typing-annotated] +/// for defining route dependencies and parameters, rather than using `Depends`, +/// `Query` or similar as a default value for a parameter. Using this approach +/// everywhere helps ensure consistency and clarity in defining dependencies +/// and parameters. /// -/// This approach is also suggested for various route parameters, including Body and Cookie, as it helps ensure consistency and clarity in defining dependencies and parameters. +/// `Annotated` was added to the `typing` module in Python 3.9; however, +/// the third-party [`typing_extensions`][typing-extensions] package +/// provides a backport that can be used on older versions of Python. /// /// ## Example /// @@ -55,26 +58,46 @@ use crate::settings::types::PythonVersion; /// async def read_items(commons: Annotated[dict, Depends(common_parameters)]): /// return commons /// ``` - -#[violation] -pub struct FastApiNonAnnotatedDependency; +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for Python versions +/// before 3.9, its diagnostic will not be emitted, and no fix will be offered, if +/// `typing_extensions` imports have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +/// +/// [FastAPI documentation]: https://fastapi.tiangolo.com/tutorial/query-params-str-validations/?h=annotated#advantages-of-annotated +/// [typing-annotated]: https://docs.python.org/3/library/typing.html#typing.Annotated +/// [typing-extensions]: https://typing-extensions.readthedocs.io/en/stable/ +#[derive(ViolationMetadata)] +pub(crate) struct FastApiNonAnnotatedDependency { + py_version: PythonVersion, +} impl Violation for FastApiNonAnnotatedDependency { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("FastAPI dependency without `Annotated`") + "FastAPI dependency without `Annotated`".to_string() } fn fix_title(&self) -> Option<String> { - Some("Replace with `Annotated`".to_string()) + let title = if self.py_version >= PythonVersion::PY39 { + "Replace with `typing.Annotated`" + } else { + "Replace with `typing_extensions.Annotated`" + }; + Some(title.to_string()) } } -/// RUF103 +/// FAST002 pub(crate) fn fastapi_non_annotated_dependency( - checker: &mut Checker, + checker: &Checker, function_def: &ast::StmtFunctionDef, ) { if !checker.semantic().seen_module(Modules::FASTAPI) @@ -83,89 +106,209 @@ pub(crate) fn fastapi_non_annotated_dependency( return; } - let mut updatable_count = 0; - let mut has_non_updatable_default = false; - let total_params = function_def.parameters.args.len(); + // `create_diagnostic` needs to know if a default argument has been seen to + // avoid emitting fixes that would remove defaults and cause a syntax error. + let mut seen_default = false; - for parameter in &function_def.parameters.args { - let needs_update = matches!( - (¶meter.parameter.annotation, ¶meter.default), - (Some(_annotation), Some(default)) if is_fastapi_dependency(checker, default) - ); + for parameter in function_def + .parameters + .args + .iter() + .chain(&function_def.parameters.kwonlyargs) + { + let (Some(annotation), Some(default)) = (parameter.annotation(), parameter.default()) + else { + seen_default |= parameter.default.is_some(); + continue; + }; - if needs_update { - updatable_count += 1; - // Determine if it's safe to update this parameter: - // - if all parameters are updatable its safe. - // - if we've encountered a non-updatable parameter with a default value, it's no longer - // safe. (https://github.com/astral-sh/ruff/issues/12982) - let safe_to_update = updatable_count == total_params || !has_non_updatable_default; - create_diagnostic(checker, parameter, safe_to_update); - } else if parameter.default.is_some() { - has_non_updatable_default = true; + if let Some(dependency) = is_fastapi_dependency(checker, default) { + let dependency_call = DependencyCall::from_expression(default); + let dependency_parameter = DependencyParameter { + annotation, + default, + kind: dependency, + name: parameter.name(), + range: parameter.range, + }; + seen_default = create_diagnostic( + checker, + &dependency_parameter, + dependency_call, + seen_default, + ); + } else { + seen_default |= parameter.default.is_some(); } } } -fn is_fastapi_dependency(checker: &Checker, expr: &ast::Expr) -> bool { +fn is_fastapi_dependency(checker: &Checker, expr: &ast::Expr) -> Option<FastApiDependency> { checker .semantic() .resolve_qualified_name(map_callable(expr)) - .is_some_and(|qualified_name| { - matches!( - qualified_name.segments(), - [ - "fastapi", - "Query" - | "Path" - | "Body" - | "Cookie" - | "Header" - | "File" - | "Form" - | "Depends" - | "Security" - ] - ) + .and_then(|qualified_name| match qualified_name.segments() { + ["fastapi", dependency_name] => match *dependency_name { + "Query" => Some(FastApiDependency::Query), + "Path" => Some(FastApiDependency::Path), + "Body" => Some(FastApiDependency::Body), + "Cookie" => Some(FastApiDependency::Cookie), + "Header" => Some(FastApiDependency::Header), + "File" => Some(FastApiDependency::File), + "Form" => Some(FastApiDependency::Form), + "Depends" => Some(FastApiDependency::Depends), + "Security" => Some(FastApiDependency::Security), + _ => None, + }, + _ => None, + }) +} + +#[derive(Debug, Copy, Clone)] +enum FastApiDependency { + Query, + Path, + Body, + Cookie, + Header, + File, + Form, + Depends, + Security, +} + +struct DependencyParameter<'a> { + annotation: &'a ast::Expr, + default: &'a ast::Expr, + range: TextRange, + name: &'a str, + kind: FastApiDependency, +} + +struct DependencyCall<'a> { + default_argument: ast::ArgOrKeyword<'a>, + keyword_arguments: Vec<&'a ast::Keyword>, +} + +impl<'a> DependencyCall<'a> { + fn from_expression(expr: &'a ast::Expr) -> Option<Self> { + let call = expr.as_call_expr()?; + let default_argument = call.arguments.find_argument("default", 0)?; + let keyword_arguments = call + .arguments + .keywords + .iter() + .filter(|kwarg| kwarg.arg.as_ref().is_some_and(|name| name != "default")) + .collect(); + + Some(Self { + default_argument, + keyword_arguments, }) + } } +/// Create a [`Diagnostic`] for `parameter` and return an updated value of `seen_default`. +/// +/// While all of the *input* `parameter` values have default values (see the `needs_update` match in +/// [`fastapi_non_annotated_dependency`]), some of the fixes remove default values. For example, +/// +/// ```python +/// def handler(some_path_param: str = Path()): pass +/// ``` +/// +/// Gets fixed to +/// +/// ```python +/// def handler(some_path_param: Annotated[str, Path()]): pass +/// ``` +/// +/// Causing it to lose its default value. That's fine in this example but causes a syntax error if +/// `some_path_param` comes after another argument with a default. We only compute the information +/// necessary to determine this while generating the fix, thus the need to return an updated +/// `seen_default` here. fn create_diagnostic( - checker: &mut Checker, - parameter: &ast::ParameterWithDefault, - safe_to_update: bool, -) { - let mut diagnostic = Diagnostic::new(FastApiNonAnnotatedDependency, parameter.range); - - if safe_to_update { - if let (Some(annotation), Some(default)) = - (¶meter.parameter.annotation, ¶meter.default) - { - diagnostic.try_set_fix(|| { - let module = if checker.settings.target_version >= PythonVersion::Py39 { - "typing" - } else { - "typing_extensions" - }; - let (import_edit, binding) = checker.importer().get_or_import_symbol( - &ImportRequest::import_from(module, "Annotated"), - parameter.range.start(), - checker.semantic(), - )?; - let content = format!( - "{}: {}[{}, {}]", - parameter.parameter.name.id, - binding, - checker.locator().slice(annotation.range()), - checker.locator().slice(default.range()) - ); - let parameter_edit = Edit::range_replacement(content, parameter.range); - Ok(Fix::unsafe_edits(import_edit, [parameter_edit])) - }); - } - } else { - diagnostic.fix = None; + checker: &Checker, + parameter: &DependencyParameter, + dependency_call: Option<DependencyCall>, + mut seen_default: bool, +) -> bool { + let Some(importer) = checker.typing_importer("Annotated", PythonVersion::PY39) else { + return seen_default; + }; + + let mut diagnostic = Diagnostic::new( + FastApiNonAnnotatedDependency { + py_version: checker.target_version(), + }, + parameter.range, + ); + + let try_generate_fix = || { + let (import_edit, binding) = importer.import(parameter.range.start())?; + + // Each of these classes takes a single, optional default + // argument, followed by kw-only arguments + + // Refine the match from `is_fastapi_dependency` to exclude Depends + // and Security, which don't have the same argument structure. The + // others need to be converted from `q: str = Query("")` to `q: + // Annotated[str, Query()] = ""` for example, but Depends and + // Security need to stay like `Annotated[str, Depends(callable)]` + let is_route_param = !matches!( + parameter.kind, + FastApiDependency::Depends | FastApiDependency::Security + ); + + let content = match dependency_call { + Some(dependency_call) if is_route_param => { + let kwarg_list = dependency_call + .keyword_arguments + .iter() + .map(|kwarg| checker.locator().slice(kwarg.range())) + .collect::<Vec<_>>() + .join(", "); + + seen_default = true; + format!( + "{parameter_name}: {binding}[{annotation}, {default_}({kwarg_list})] \ + = {default_value}", + parameter_name = parameter.name, + annotation = checker.locator().slice(parameter.annotation.range()), + default_ = checker + .locator() + .slice(map_callable(parameter.default).range()), + default_value = checker + .locator() + .slice(dependency_call.default_argument.value().range()), + ) + } + _ => { + if seen_default { + return Ok(None); + } + format!( + "{parameter_name}: {binding}[{annotation}, {default_}]", + parameter_name = parameter.name, + annotation = checker.locator().slice(parameter.annotation.range()), + default_ = checker.locator().slice(parameter.default.range()) + ) + } + }; + let parameter_edit = Edit::range_replacement(content, parameter.range); + Ok(Some(Fix::unsafe_edits(import_edit, [parameter_edit]))) + }; + + // make sure we set `seen_default` if we bail out of `try_generate_fix` early. we could + // `match` on the result directly, but still calling `try_set_optional_fix` avoids + // duplicating the debug logging here + let fix: anyhow::Result<Option<Fix>> = try_generate_fix(); + if fix.is_err() { + seen_default = true; } + diagnostic.try_set_optional_fix(|| fix); + + checker.report_diagnostic(diagnostic); - checker.diagnostics.push(diagnostic); + seen_default } diff --git a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_redundant_response_model.rs b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_redundant_response_model.rs index 538949cbe19f0..ab38db93aedf8 100644 --- a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_redundant_response_model.rs +++ b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_redundant_response_model.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Decorator, Expr, ExprCall, Keyword, StmtFunctionDef}; use ruff_python_semantic::{Modules, SemanticModel}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; use crate::rules::fastapi::rules::is_fastapi_route_decorator; /// ## What it does @@ -59,13 +59,13 @@ use crate::rules::fastapi::rules::is_fastapi_route_decorator; /// return item /// ``` -#[violation] -pub struct FastApiRedundantResponseModel; +#[derive(ViolationMetadata)] +pub(crate) struct FastApiRedundantResponseModel; impl AlwaysFixableViolation for FastApiRedundantResponseModel { #[derive_message_formats] fn message(&self) -> String { - format!("FastAPI route with redundant `response_model` argument") + "FastAPI route with redundant `response_model` argument".to_string() } fn fix_title(&self) -> String { @@ -73,11 +73,8 @@ impl AlwaysFixableViolation for FastApiRedundantResponseModel { } } -/// RUF102 -pub(crate) fn fastapi_redundant_response_model( - checker: &mut Checker, - function_def: &StmtFunctionDef, -) { +/// FAST001 +pub(crate) fn fastapi_redundant_response_model(checker: &Checker, function_def: &StmtFunctionDef) { if !checker.semantic().seen_module(Modules::FASTAPI) { return; } @@ -98,7 +95,7 @@ pub(crate) fn fastapi_redundant_response_model( ) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_unused_path_parameter.rs b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_unused_path_parameter.rs index ec6acffebd29d..286617ccdf682 100644 --- a/crates/ruff_linter/src/rules/fastapi/rules/fastapi_unused_path_parameter.rs +++ b/crates/ruff_linter/src/rules/fastapi/rules/fastapi_unused_path_parameter.rs @@ -4,10 +4,10 @@ use std::str::CharIndices; use ruff_diagnostics::Fix; use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_ast::{Expr, Parameter, ParameterWithDefault}; -use ruff_python_semantic::{Modules, SemanticModel}; +use ruff_python_ast::{Arguments, Expr, ExprCall, ExprSubscript, Parameter, ParameterWithDefault}; +use ruff_python_semantic::{BindingKind, Modules, ScopeKind, SemanticModel}; use ruff_python_stdlib::identifiers::is_identifier; use ruff_text_size::{Ranged, TextSize}; @@ -62,8 +62,8 @@ use crate::rules::fastapi::rules::is_fastapi_route_decorator; /// ## Fix safety /// This rule's fix is marked as unsafe, as modifying a function signature can /// change the behavior of the code. -#[violation] -pub struct FastApiUnusedPathParameter { +#[derive(ViolationMetadata)] +pub(crate) struct FastApiUnusedPathParameter { arg_name: String, function_name: String, is_positional: bool, @@ -79,9 +79,11 @@ impl Violation for FastApiUnusedPathParameter { function_name, is_positional, } = self; - #[allow(clippy::if_not_else)] + #[expect(clippy::if_not_else)] if !is_positional { - format!("Parameter `{arg_name}` appears in route path, but not in `{function_name}` signature") + format!( + "Parameter `{arg_name}` appears in route path, but not in `{function_name}` signature" + ) } else { format!( "Parameter `{arg_name}` appears in route path, but only as a positional-only argument in `{function_name}` signature" @@ -105,7 +107,7 @@ impl Violation for FastApiUnusedPathParameter { /// FAST003 pub(crate) fn fastapi_unused_path_parameter( - checker: &mut Checker, + checker: &Checker, function_def: &ast::StmtFunctionDef, ) { if !checker.semantic().seen_module(Modules::FASTAPI) { @@ -137,26 +139,40 @@ pub(crate) fn fastapi_unused_path_parameter( let path_params = PathParamIterator::new(path.to_str()); // Extract the arguments from the function signature - let named_args: Vec<_> = function_def - .parameters - .args - .iter() - .chain(&function_def.parameters.kwonlyargs) - .map(|ParameterWithDefault { parameter, .. }| { - parameter_alias(parameter, checker.semantic()) - .unwrap_or_else(|| parameter.name.as_str()) - }) - .collect(); + let mut named_args = vec![]; + + for parameter_with_default in non_posonly_non_variadic_parameters(function_def) { + let ParameterWithDefault { parameter, .. } = parameter_with_default; + + if let Some(alias) = parameter_alias(parameter, checker.semantic()) { + named_args.push(alias); + } else { + named_args.push(parameter.name.as_str()); + } + + let Some(dependency) = + Dependency::from_parameter(parameter_with_default, checker.semantic()) + else { + continue; + }; + + if let Some(parameter_names) = dependency.parameter_names() { + named_args.extend_from_slice(parameter_names); + } else { + // If we can't determine the dependency, we can't really do anything. + return; + } + } // Check if any of the path parameters are not in the function signature. - let mut diagnostics = vec![]; for (path_param, range) in path_params { // Ignore invalid identifiers (e.g., `user-id`, as opposed to `user_id`) if !is_identifier(path_param) { continue; } - // If the path parameter is already in the function signature, we don't need to do anything. + // If the path parameter is already in the function or the dependency signature, + // we don't need to do anything. if named_args.contains(&path_param) { continue; } @@ -168,7 +184,7 @@ pub(crate) fn fastapi_unused_path_parameter( .parameters .posonlyargs .iter() - .any(|arg| arg.parameter.name.as_str() == path_param); + .any(|param| param.name() == path_param); let mut diagnostic = Diagnostic::new( FastApiUnusedPathParameter { @@ -176,7 +192,7 @@ pub(crate) fn fastapi_unused_path_parameter( function_name: function_def.name.to_string(), is_positional, }, - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] diagnostic_range .add_start(TextSize::from(range.start as u32 + 1)) .sub_end(TextSize::from((path.len() - range.end + 1) as u32)), @@ -188,10 +204,148 @@ pub(crate) fn fastapi_unused_path_parameter( checker.locator().contents(), ))); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); + } +} + +/// Returns an iterator over the non-positional-only, non-variadic parameters of a function. +fn non_posonly_non_variadic_parameters( + function_def: &ast::StmtFunctionDef, +) -> impl Iterator<Item = &ParameterWithDefault> { + function_def + .parameters + .args + .iter() + .chain(&function_def.parameters.kwonlyargs) +} + +#[derive(Debug, is_macro::Is)] +enum Dependency<'a> { + /// Not defined in the same file, or otherwise cannot be determined to be a function. + Unknown, + + /// A function defined in the same file, whose parameter names are as given. + Function(Vec<&'a str>), + + /// There are multiple `Depends()` calls. + /// + /// Multiple `Depends` annotations aren't supported by fastapi and the exact behavior is + /// [unspecified](https://github.com/astral-sh/ruff/pull/15364#discussion_r1912551710). + Multiple, +} + +impl<'a> Dependency<'a> { + fn parameter_names(&self) -> Option<&[&'a str]> { + match self { + Self::Unknown => None, + Self::Multiple => None, + Self::Function(parameter_names) => Some(parameter_names.as_slice()), + } } +} + +impl<'a> Dependency<'a> { + /// Return `foo` in the first metadata `Depends(foo)`, + /// or that of the default value: + /// + /// ```python + /// def _( + /// a: Annotated[str, Depends(foo)], + /// # ^^^^^^^^^^^^ + /// a: str = Depends(foo), + /// # ^^^^^^^^^^^^ + /// ): ... + /// ``` + fn from_parameter( + parameter: &'a ParameterWithDefault, + semantic: &SemanticModel<'a>, + ) -> Option<Self> { + if let Some(dependency) = parameter + .default() + .and_then(|default| Self::from_default(default, semantic)) + { + return Some(dependency); + } + + let ExprSubscript { value, slice, .. } = parameter.annotation()?.as_subscript_expr()?; + + if !semantic.match_typing_expr(value, "Annotated") { + return None; + } + + let Expr::Tuple(tuple) = slice.as_ref() else { + return None; + }; + + let mut dependencies = tuple.elts.iter().skip(1).filter_map(|metadata_element| { + let arguments = depends_arguments(metadata_element, semantic)?; + + Self::from_depends_call(arguments, semantic) + }); + + let dependency = dependencies.next()?; + + if dependencies.next().is_some() { + Some(Self::Multiple) + } else { + Some(dependency) + } + } + + fn from_default(expr: &'a Expr, semantic: &SemanticModel<'a>) -> Option<Self> { + let arguments = depends_arguments(expr, semantic)?; + + Self::from_depends_call(arguments, semantic) + } + + fn from_depends_call(arguments: &'a Arguments, semantic: &SemanticModel<'a>) -> Option<Self> { + let Some(Expr::Name(name)) = arguments.find_argument_value("dependency", 0) else { + return None; + }; + + let Some(binding) = semantic.only_binding(name).map(|id| semantic.binding(id)) else { + return Some(Self::Unknown); + }; + + let BindingKind::FunctionDefinition(scope_id) = binding.kind else { + return Some(Self::Unknown); + }; + + let scope = &semantic.scopes[scope_id]; + + let ScopeKind::Function(function_def) = scope.kind else { + return Some(Self::Unknown); + }; + + let parameter_names = non_posonly_non_variadic_parameters(function_def) + .map(|param| param.name().as_str()) + .collect(); + + Some(Self::Function(parameter_names)) + } +} + +fn depends_arguments<'a>(expr: &'a Expr, semantic: &SemanticModel) -> Option<&'a Arguments> { + let Expr::Call(ExprCall { + func, arguments, .. + }) = expr + else { + return None; + }; + + if !is_fastapi_depends(func.as_ref(), semantic) { + return None; + } + + Some(arguments) +} + +fn is_fastapi_depends(expr: &Expr, semantic: &SemanticModel) -> bool { + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return false; + }; - checker.diagnostics.extend(diagnostics); + matches!(qualified_name.segments(), ["fastapi", "Depends"]) } /// Extract the expected in-route name for a given parameter, if it has an alias. @@ -267,12 +421,12 @@ impl<'a> Iterator for PathParamIterator<'a> { if c == '{' { if let Some((end, _)) = self.chars.by_ref().find(|&(_, ch)| ch == '}') { let param_content = &self.input[start + 1..end]; - // We ignore text after a colon, since those are path convertors + // We ignore text after a colon, since those are path converters // See also: https://fastapi.tiangolo.com/tutorial/path-params/?h=path#path-convertor let param_name_end = param_content.find(':').unwrap_or(param_content.len()); let param_name = ¶m_content[..param_name_end].trim(); - #[allow(clippy::range_plus_one)] + #[expect(clippy::range_plus_one)] return Some((param_name, start..end + 1)); } } diff --git a/crates/ruff_linter/src/rules/fastapi/rules/mod.rs b/crates/ruff_linter/src/rules/fastapi/rules/mod.rs index 9cf10734e466c..d6bbe2fdb61bd 100644 --- a/crates/ruff_linter/src/rules/fastapi/rules/mod.rs +++ b/crates/ruff_linter/src/rules/fastapi/rules/mod.rs @@ -7,18 +7,18 @@ mod fastapi_redundant_response_model; mod fastapi_unused_path_parameter; use ruff_python_ast as ast; -use ruff_python_semantic::analyze::typing::resolve_assignment; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; /// Returns `true` if the function is a FastAPI route. pub(crate) fn is_fastapi_route( function_def: &ast::StmtFunctionDef, semantic: &SemanticModel, ) -> bool { - return function_def + function_def .decorator_list .iter() - .any(|decorator| is_fastapi_route_decorator(decorator, semantic).is_some()); + .any(|decorator| is_fastapi_route_decorator(decorator, semantic).is_some()) } /// Returns `true` if the decorator is indicative of a FastAPI route. @@ -41,11 +41,11 @@ pub(crate) fn is_fastapi_route_call(call_expr: &ast::ExprCall, semantic: &Semant ) { return false; } - - resolve_assignment(value, semantic).is_some_and(|qualified_name| { - matches!( - qualified_name.segments(), - ["fastapi", "FastAPI" | "APIRouter"] - ) - }) + let Some(name) = value.as_name_expr() else { + return false; + }; + let Some(binding_id) = semantic.resolve_name(name) else { + return false; + }; + typing::is_fastapi_route(semantic.binding(binding_id), semantic) } diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002.py.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002.py.snap deleted file mode 100644 index 97ef58d343bc9..0000000000000 --- a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002.py.snap +++ /dev/null @@ -1,332 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/fastapi/mod.rs ---- -FAST002.py:24:5: FAST002 [*] FastAPI dependency without `Annotated` - | -22 | @app.get("/items/") -23 | def get_items( -24 | current_user: User = Depends(get_current_user), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -25 | some_security_param: str = Security(get_oauth2_user), -26 | ): - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -21 22 | -22 23 | @app.get("/items/") -23 24 | def get_items( -24 |- current_user: User = Depends(get_current_user), - 25 |+ current_user: Annotated[User, Depends(get_current_user)], -25 26 | some_security_param: str = Security(get_oauth2_user), -26 27 | ): -27 28 | pass - -FAST002.py:25:5: FAST002 [*] FastAPI dependency without `Annotated` - | -23 | def get_items( -24 | current_user: User = Depends(get_current_user), -25 | some_security_param: str = Security(get_oauth2_user), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -26 | ): -27 | pass - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -22 23 | @app.get("/items/") -23 24 | def get_items( -24 25 | current_user: User = Depends(get_current_user), -25 |- some_security_param: str = Security(get_oauth2_user), - 26 |+ some_security_param: Annotated[str, Security(get_oauth2_user)], -26 27 | ): -27 28 | pass -28 29 | - -FAST002.py:32:5: FAST002 [*] FastAPI dependency without `Annotated` - | -30 | @app.post("/stuff/") -31 | def do_stuff( -32 | some_query_param: str | None = Query(default=None), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -33 | some_path_param: str = Path(), -34 | some_body_param: str = Body("foo"), - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -29 30 | -30 31 | @app.post("/stuff/") -31 32 | def do_stuff( -32 |- some_query_param: str | None = Query(default=None), - 33 |+ some_query_param: Annotated[str | None, Query(default=None)], -33 34 | some_path_param: str = Path(), -34 35 | some_body_param: str = Body("foo"), -35 36 | some_cookie_param: str = Cookie(), - -FAST002.py:33:5: FAST002 [*] FastAPI dependency without `Annotated` - | -31 | def do_stuff( -32 | some_query_param: str | None = Query(default=None), -33 | some_path_param: str = Path(), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -34 | some_body_param: str = Body("foo"), -35 | some_cookie_param: str = Cookie(), - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -30 31 | @app.post("/stuff/") -31 32 | def do_stuff( -32 33 | some_query_param: str | None = Query(default=None), -33 |- some_path_param: str = Path(), - 34 |+ some_path_param: Annotated[str, Path()], -34 35 | some_body_param: str = Body("foo"), -35 36 | some_cookie_param: str = Cookie(), -36 37 | some_header_param: int = Header(default=5), - -FAST002.py:34:5: FAST002 [*] FastAPI dependency without `Annotated` - | -32 | some_query_param: str | None = Query(default=None), -33 | some_path_param: str = Path(), -34 | some_body_param: str = Body("foo"), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -35 | some_cookie_param: str = Cookie(), -36 | some_header_param: int = Header(default=5), - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -31 32 | def do_stuff( -32 33 | some_query_param: str | None = Query(default=None), -33 34 | some_path_param: str = Path(), -34 |- some_body_param: str = Body("foo"), - 35 |+ some_body_param: Annotated[str, Body("foo")], -35 36 | some_cookie_param: str = Cookie(), -36 37 | some_header_param: int = Header(default=5), -37 38 | some_file_param: UploadFile = File(), - -FAST002.py:35:5: FAST002 [*] FastAPI dependency without `Annotated` - | -33 | some_path_param: str = Path(), -34 | some_body_param: str = Body("foo"), -35 | some_cookie_param: str = Cookie(), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -36 | some_header_param: int = Header(default=5), -37 | some_file_param: UploadFile = File(), - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -32 33 | some_query_param: str | None = Query(default=None), -33 34 | some_path_param: str = Path(), -34 35 | some_body_param: str = Body("foo"), -35 |- some_cookie_param: str = Cookie(), - 36 |+ some_cookie_param: Annotated[str, Cookie()], -36 37 | some_header_param: int = Header(default=5), -37 38 | some_file_param: UploadFile = File(), -38 39 | some_form_param: str = Form(), - -FAST002.py:36:5: FAST002 [*] FastAPI dependency without `Annotated` - | -34 | some_body_param: str = Body("foo"), -35 | some_cookie_param: str = Cookie(), -36 | some_header_param: int = Header(default=5), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -37 | some_file_param: UploadFile = File(), -38 | some_form_param: str = Form(), - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -33 34 | some_path_param: str = Path(), -34 35 | some_body_param: str = Body("foo"), -35 36 | some_cookie_param: str = Cookie(), -36 |- some_header_param: int = Header(default=5), - 37 |+ some_header_param: Annotated[int, Header(default=5)], -37 38 | some_file_param: UploadFile = File(), -38 39 | some_form_param: str = Form(), -39 40 | ): - -FAST002.py:37:5: FAST002 [*] FastAPI dependency without `Annotated` - | -35 | some_cookie_param: str = Cookie(), -36 | some_header_param: int = Header(default=5), -37 | some_file_param: UploadFile = File(), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -38 | some_form_param: str = Form(), -39 | ): - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -34 35 | some_body_param: str = Body("foo"), -35 36 | some_cookie_param: str = Cookie(), -36 37 | some_header_param: int = Header(default=5), -37 |- some_file_param: UploadFile = File(), - 38 |+ some_file_param: Annotated[UploadFile, File()], -38 39 | some_form_param: str = Form(), -39 40 | ): -40 41 | # do stuff - -FAST002.py:38:5: FAST002 [*] FastAPI dependency without `Annotated` - | -36 | some_header_param: int = Header(default=5), -37 | some_file_param: UploadFile = File(), -38 | some_form_param: str = Form(), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -39 | ): -40 | # do stuff - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -35 36 | some_cookie_param: str = Cookie(), -36 37 | some_header_param: int = Header(default=5), -37 38 | some_file_param: UploadFile = File(), -38 |- some_form_param: str = Form(), - 39 |+ some_form_param: Annotated[str, Form()], -39 40 | ): -40 41 | # do stuff -41 42 | pass - -FAST002.py:47:5: FAST002 [*] FastAPI dependency without `Annotated` - | -45 | skip: int, -46 | limit: int, -47 | current_user: User = Depends(get_current_user), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -48 | ): -49 | pass - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -44 45 | def get_users( -45 46 | skip: int, -46 47 | limit: int, -47 |- current_user: User = Depends(get_current_user), - 48 |+ current_user: Annotated[User, Depends(get_current_user)], -48 49 | ): -49 50 | pass -50 51 | - -FAST002.py:53:5: FAST002 [*] FastAPI dependency without `Annotated` - | -51 | @app.get("/users/") -52 | def get_users( -53 | current_user: User = Depends(get_current_user), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -54 | skip: int = 0, -55 | limit: int = 10, - | - = help: Replace with `Annotated` - -ℹ Unsafe fix -12 12 | Security, -13 13 | ) -14 14 | from pydantic import BaseModel - 15 |+from typing import Annotated -15 16 | -16 17 | app = FastAPI() -17 18 | router = APIRouter() --------------------------------------------------------------------------------- -50 51 | -51 52 | @app.get("/users/") -52 53 | def get_users( -53 |- current_user: User = Depends(get_current_user), - 54 |+ current_user: Annotated[User, Depends(get_current_user)], -54 55 | skip: int = 0, -55 56 | limit: int = 10, -56 57 | ): - -FAST002.py:67:5: FAST002 FastAPI dependency without `Annotated` - | -65 | skip: int = 0, -66 | limit: int = 10, -67 | current_user: User = Depends(get_current_user), - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 -68 | ): -69 | pass - | - = help: Replace with `Annotated` diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py.snap new file mode 100644 index 0000000000000..6bc341dd027ee --- /dev/null +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py.snap @@ -0,0 +1,360 @@ +--- +source: crates/ruff_linter/src/rules/fastapi/mod.rs +snapshot_kind: text +--- +FAST002_0.py:24:5: FAST002 [*] FastAPI dependency without `Annotated` + | +22 | @app.get("/items/") +23 | def get_items( +24 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +25 | some_security_param: str = Security(get_oauth2_user), +26 | ): + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +21 22 | +22 23 | @app.get("/items/") +23 24 | def get_items( +24 |- current_user: User = Depends(get_current_user), + 25 |+ current_user: Annotated[User, Depends(get_current_user)], +25 26 | some_security_param: str = Security(get_oauth2_user), +26 27 | ): +27 28 | pass + +FAST002_0.py:25:5: FAST002 [*] FastAPI dependency without `Annotated` + | +23 | def get_items( +24 | current_user: User = Depends(get_current_user), +25 | some_security_param: str = Security(get_oauth2_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +26 | ): +27 | pass + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +22 23 | @app.get("/items/") +23 24 | def get_items( +24 25 | current_user: User = Depends(get_current_user), +25 |- some_security_param: str = Security(get_oauth2_user), + 26 |+ some_security_param: Annotated[str, Security(get_oauth2_user)], +26 27 | ): +27 28 | pass +28 29 | + +FAST002_0.py:32:5: FAST002 [*] FastAPI dependency without `Annotated` + | +30 | @app.post("/stuff/") +31 | def do_stuff( +32 | some_path_param: str = Path(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +29 30 | +30 31 | @app.post("/stuff/") +31 32 | def do_stuff( +32 |- some_path_param: str = Path(), + 33 |+ some_path_param: Annotated[str, Path()], +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), + +FAST002_0.py:33:5: FAST002 [*] FastAPI dependency without `Annotated` + | +31 | def do_stuff( +32 | some_path_param: str = Path(), +33 | some_cookie_param: str = Cookie(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +30 31 | @app.post("/stuff/") +31 32 | def do_stuff( +32 33 | some_path_param: str = Path(), +33 |- some_cookie_param: str = Cookie(), + 34 |+ some_cookie_param: Annotated[str, Cookie()], +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), + +FAST002_0.py:34:5: FAST002 [*] FastAPI dependency without `Annotated` + | +32 | some_path_param: str = Path(), +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +31 32 | def do_stuff( +32 33 | some_path_param: str = Path(), +33 34 | some_cookie_param: str = Cookie(), +34 |- some_file_param: UploadFile = File(), + 35 |+ some_file_param: Annotated[UploadFile, File()], +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), + +FAST002_0.py:35:5: FAST002 [*] FastAPI dependency without `Annotated` + | +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +32 33 | some_path_param: str = Path(), +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 |- some_form_param: str = Form(), + 36 |+ some_form_param: Annotated[str, Form()], +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), +38 39 | some_header_param: int = Header(default=5), + +FAST002_0.py:36:5: FAST002 [*] FastAPI dependency without `Annotated` + | +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +37 | some_body_param: str = Body("foo"), +38 | some_header_param: int = Header(default=5), + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 |- some_query_param: str | None = Query(default=None), + 37 |+ some_query_param: Annotated[str | None, Query()] = None, +37 38 | some_body_param: str = Body("foo"), +38 39 | some_header_param: int = Header(default=5), +39 40 | ): + +FAST002_0.py:37:5: FAST002 [*] FastAPI dependency without `Annotated` + | +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +38 | some_header_param: int = Header(default=5), +39 | ): + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 |- some_body_param: str = Body("foo"), + 38 |+ some_body_param: Annotated[str, Body()] = "foo", +38 39 | some_header_param: int = Header(default=5), +39 40 | ): +40 41 | # do stuff + +FAST002_0.py:38:5: FAST002 [*] FastAPI dependency without `Annotated` + | +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), +38 | some_header_param: int = Header(default=5), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +39 | ): +40 | # do stuff + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), +38 |- some_header_param: int = Header(default=5), + 39 |+ some_header_param: Annotated[int, Header()] = 5, +39 40 | ): +40 41 | # do stuff +41 42 | pass + +FAST002_0.py:47:5: FAST002 [*] FastAPI dependency without `Annotated` + | +45 | skip: int, +46 | limit: int, +47 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +48 | ): +49 | pass + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +44 45 | def get_users( +45 46 | skip: int, +46 47 | limit: int, +47 |- current_user: User = Depends(get_current_user), + 48 |+ current_user: Annotated[User, Depends(get_current_user)], +48 49 | ): +49 50 | pass +50 51 | + +FAST002_0.py:53:5: FAST002 [*] FastAPI dependency without `Annotated` + | +51 | @app.get("/users/") +52 | def get_users( +53 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +54 | skip: int = 0, +55 | limit: int = 10, + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +50 51 | +51 52 | @app.get("/users/") +52 53 | def get_users( +53 |- current_user: User = Depends(get_current_user), + 54 |+ current_user: Annotated[User, Depends(get_current_user)], +54 55 | skip: int = 0, +55 56 | limit: int = 10, +56 57 | ): + +FAST002_0.py:61:25: FAST002 [*] FastAPI dependency without `Annotated` + | +60 | @app.get("/items/{item_id}") +61 | async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +62 | pass + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +58 59 | +59 60 | +60 61 | @app.get("/items/{item_id}") +61 |-async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): + 62 |+async def read_items(*, item_id: Annotated[int, Path(title="The ID of the item to get")], q: str): +62 63 | pass +63 64 | +64 65 | # Non fixable errors + +FAST002_0.py:70:5: FAST002 FastAPI dependency without `Annotated` + | +68 | skip: int = 0, +69 | limit: int = 10, +70 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +71 | ): +72 | pass + | + = help: Replace with `typing.Annotated` diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py_py38.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py_py38.snap new file mode 100644 index 0000000000000..2bc02fdeeeca0 --- /dev/null +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_0.py_py38.snap @@ -0,0 +1,360 @@ +--- +source: crates/ruff_linter/src/rules/fastapi/mod.rs +snapshot_kind: text +--- +FAST002_0.py:24:5: FAST002 [*] FastAPI dependency without `Annotated` + | +22 | @app.get("/items/") +23 | def get_items( +24 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +25 | some_security_param: str = Security(get_oauth2_user), +26 | ): + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +21 22 | +22 23 | @app.get("/items/") +23 24 | def get_items( +24 |- current_user: User = Depends(get_current_user), + 25 |+ current_user: Annotated[User, Depends(get_current_user)], +25 26 | some_security_param: str = Security(get_oauth2_user), +26 27 | ): +27 28 | pass + +FAST002_0.py:25:5: FAST002 [*] FastAPI dependency without `Annotated` + | +23 | def get_items( +24 | current_user: User = Depends(get_current_user), +25 | some_security_param: str = Security(get_oauth2_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +26 | ): +27 | pass + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +22 23 | @app.get("/items/") +23 24 | def get_items( +24 25 | current_user: User = Depends(get_current_user), +25 |- some_security_param: str = Security(get_oauth2_user), + 26 |+ some_security_param: Annotated[str, Security(get_oauth2_user)], +26 27 | ): +27 28 | pass +28 29 | + +FAST002_0.py:32:5: FAST002 [*] FastAPI dependency without `Annotated` + | +30 | @app.post("/stuff/") +31 | def do_stuff( +32 | some_path_param: str = Path(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +29 30 | +30 31 | @app.post("/stuff/") +31 32 | def do_stuff( +32 |- some_path_param: str = Path(), + 33 |+ some_path_param: Annotated[str, Path()], +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), + +FAST002_0.py:33:5: FAST002 [*] FastAPI dependency without `Annotated` + | +31 | def do_stuff( +32 | some_path_param: str = Path(), +33 | some_cookie_param: str = Cookie(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +30 31 | @app.post("/stuff/") +31 32 | def do_stuff( +32 33 | some_path_param: str = Path(), +33 |- some_cookie_param: str = Cookie(), + 34 |+ some_cookie_param: Annotated[str, Cookie()], +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), + +FAST002_0.py:34:5: FAST002 [*] FastAPI dependency without `Annotated` + | +32 | some_path_param: str = Path(), +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +31 32 | def do_stuff( +32 33 | some_path_param: str = Path(), +33 34 | some_cookie_param: str = Cookie(), +34 |- some_file_param: UploadFile = File(), + 35 |+ some_file_param: Annotated[UploadFile, File()], +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), + +FAST002_0.py:35:5: FAST002 [*] FastAPI dependency without `Annotated` + | +33 | some_cookie_param: str = Cookie(), +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +32 33 | some_path_param: str = Path(), +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 |- some_form_param: str = Form(), + 36 |+ some_form_param: Annotated[str, Form()], +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), +38 39 | some_header_param: int = Header(default=5), + +FAST002_0.py:36:5: FAST002 [*] FastAPI dependency without `Annotated` + | +34 | some_file_param: UploadFile = File(), +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +37 | some_body_param: str = Body("foo"), +38 | some_header_param: int = Header(default=5), + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +33 34 | some_cookie_param: str = Cookie(), +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 |- some_query_param: str | None = Query(default=None), + 37 |+ some_query_param: Annotated[str | None, Query()] = None, +37 38 | some_body_param: str = Body("foo"), +38 39 | some_header_param: int = Header(default=5), +39 40 | ): + +FAST002_0.py:37:5: FAST002 [*] FastAPI dependency without `Annotated` + | +35 | some_form_param: str = Form(), +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +38 | some_header_param: int = Header(default=5), +39 | ): + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +34 35 | some_file_param: UploadFile = File(), +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 |- some_body_param: str = Body("foo"), + 38 |+ some_body_param: Annotated[str, Body()] = "foo", +38 39 | some_header_param: int = Header(default=5), +39 40 | ): +40 41 | # do stuff + +FAST002_0.py:38:5: FAST002 [*] FastAPI dependency without `Annotated` + | +36 | some_query_param: str | None = Query(default=None), +37 | some_body_param: str = Body("foo"), +38 | some_header_param: int = Header(default=5), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +39 | ): +40 | # do stuff + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +35 36 | some_form_param: str = Form(), +36 37 | some_query_param: str | None = Query(default=None), +37 38 | some_body_param: str = Body("foo"), +38 |- some_header_param: int = Header(default=5), + 39 |+ some_header_param: Annotated[int, Header()] = 5, +39 40 | ): +40 41 | # do stuff +41 42 | pass + +FAST002_0.py:47:5: FAST002 [*] FastAPI dependency without `Annotated` + | +45 | skip: int, +46 | limit: int, +47 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +48 | ): +49 | pass + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +44 45 | def get_users( +45 46 | skip: int, +46 47 | limit: int, +47 |- current_user: User = Depends(get_current_user), + 48 |+ current_user: Annotated[User, Depends(get_current_user)], +48 49 | ): +49 50 | pass +50 51 | + +FAST002_0.py:53:5: FAST002 [*] FastAPI dependency without `Annotated` + | +51 | @app.get("/users/") +52 | def get_users( +53 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +54 | skip: int = 0, +55 | limit: int = 10, + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +50 51 | +51 52 | @app.get("/users/") +52 53 | def get_users( +53 |- current_user: User = Depends(get_current_user), + 54 |+ current_user: Annotated[User, Depends(get_current_user)], +54 55 | skip: int = 0, +55 56 | limit: int = 10, +56 57 | ): + +FAST002_0.py:61:25: FAST002 [*] FastAPI dependency without `Annotated` + | +60 | @app.get("/items/{item_id}") +61 | async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +62 | pass + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +12 12 | Security, +13 13 | ) +14 14 | from pydantic import BaseModel + 15 |+from typing_extensions import Annotated +15 16 | +16 17 | app = FastAPI() +17 18 | router = APIRouter() +-------------------------------------------------------------------------------- +58 59 | +59 60 | +60 61 | @app.get("/items/{item_id}") +61 |-async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): + 62 |+async def read_items(*, item_id: Annotated[int, Path(title="The ID of the item to get")], q: str): +62 63 | pass +63 64 | +64 65 | # Non fixable errors + +FAST002_0.py:70:5: FAST002 FastAPI dependency without `Annotated` + | +68 | skip: int = 0, +69 | limit: int = 10, +70 | current_user: User = Depends(get_current_user), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +71 | ): +72 | pass + | + = help: Replace with `typing_extensions.Annotated` diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py.snap new file mode 100644 index 0000000000000..d93b32d102d2e --- /dev/null +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py.snap @@ -0,0 +1,80 @@ +--- +source: crates/ruff_linter/src/rules/fastapi/mod.rs +snapshot_kind: text +--- +FAST002_1.py:10:13: FAST002 [*] FastAPI dependency without `Annotated` + | + 9 | @app.get("/test") +10 | def handler(echo: str = Query("")): + | ^^^^^^^^^^^^^^^^^^^^^ FAST002 +11 | return echo + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +8 9 | +9 10 | @app.get("/test") +10 |-def handler(echo: str = Query("")): + 11 |+def handler(echo: Annotated[str, Query()] = ""): +11 12 | return echo +12 13 | +13 14 | + +FAST002_1.py:15:14: FAST002 [*] FastAPI dependency without `Annotated` + | +14 | @app.get("/test") +15 | def handler2(echo: str = Query(default="")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +16 | return echo + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +-------------------------------------------------------------------------------- +12 13 | +13 14 | +14 15 | @app.get("/test") +15 |-def handler2(echo: str = Query(default="")): + 16 |+def handler2(echo: Annotated[str, Query()] = ""): +16 17 | return echo +17 18 | +18 19 | + +FAST002_1.py:20:14: FAST002 [*] FastAPI dependency without `Annotated` + | +19 | @app.get("/test") +20 | def handler3(echo: str = Query("123", min_length=3, max_length=50)): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +21 | return echo + | + = help: Replace with `typing.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +-------------------------------------------------------------------------------- +17 18 | +18 19 | +19 20 | @app.get("/test") +20 |-def handler3(echo: str = Query("123", min_length=3, max_length=50)): + 21 |+def handler3(echo: Annotated[str, Query(min_length=3, max_length=50)] = "123"): +21 22 | return echo diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py_py38.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py_py38.snap new file mode 100644 index 0000000000000..3359b5ce5c3ec --- /dev/null +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-non-annotated-dependency_FAST002_1.py_py38.snap @@ -0,0 +1,80 @@ +--- +source: crates/ruff_linter/src/rules/fastapi/mod.rs +snapshot_kind: text +--- +FAST002_1.py:10:13: FAST002 [*] FastAPI dependency without `Annotated` + | + 9 | @app.get("/test") +10 | def handler(echo: str = Query("")): + | ^^^^^^^^^^^^^^^^^^^^^ FAST002 +11 | return echo + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing_extensions import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +8 9 | +9 10 | @app.get("/test") +10 |-def handler(echo: str = Query("")): + 11 |+def handler(echo: Annotated[str, Query()] = ""): +11 12 | return echo +12 13 | +13 14 | + +FAST002_1.py:15:14: FAST002 [*] FastAPI dependency without `Annotated` + | +14 | @app.get("/test") +15 | def handler2(echo: str = Query(default="")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +16 | return echo + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing_extensions import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +-------------------------------------------------------------------------------- +12 13 | +13 14 | +14 15 | @app.get("/test") +15 |-def handler2(echo: str = Query(default="")): + 16 |+def handler2(echo: Annotated[str, Query()] = ""): +16 17 | return echo +17 18 | +18 19 | + +FAST002_1.py:20:14: FAST002 [*] FastAPI dependency without `Annotated` + | +19 | @app.get("/test") +20 | def handler3(echo: str = Query("123", min_length=3, max_length=50)): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FAST002 +21 | return echo + | + = help: Replace with `typing_extensions.Annotated` + +ℹ Unsafe fix +2 2 | values. See #15043 for more details.""" +3 3 | +4 4 | from fastapi import FastAPI, Query + 5 |+from typing_extensions import Annotated +5 6 | +6 7 | app = FastAPI() +7 8 | +-------------------------------------------------------------------------------- +17 18 | +18 19 | +19 20 | @app.get("/test") +20 |-def handler3(echo: str = Query("123", min_length=3, max_length=50)): + 21 |+def handler3(echo: Annotated[str, Query(min_length=3, max_length=50)] = "123"): +21 22 | return echo diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-redundant-response-model_FAST001.py.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-redundant-response-model_FAST001.py.snap index 84b582e502da7..79953ce698354 100644 --- a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-redundant-response-model_FAST001.py.snap +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-redundant-response-model_FAST001.py.snap @@ -171,4 +171,25 @@ FAST001.py:53:24: FAST001 [*] FastAPI route with redundant `response_model` argu 53 |+@router.get("/items/") 54 54 | async def create_item(item: Item) -> Item: 55 55 | return item -56 56 | +56 56 | + +FAST001.py:118:23: FAST001 [*] FastAPI route with redundant `response_model` argument + | +116 | def setup_app(app_arg: FastAPI, non_app: str) -> None: +117 | # Error +118 | @app_arg.get("/", response_model=str) + | ^^^^^^^^^^^^^^^^^^ FAST001 +119 | async def get_root() -> str: +120 | return "Hello World!" + | + = help: Remove argument + +ℹ Unsafe fix +115 115 | +116 116 | def setup_app(app_arg: FastAPI, non_app: str) -> None: +117 117 | # Error +118 |- @app_arg.get("/", response_model=str) + 118 |+ @app_arg.get("/") +119 119 | async def get_root() -> str: +120 120 | return "Hello World!" +121 121 | diff --git a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-unused-path-parameter_FAST003.py.snap b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-unused-path-parameter_FAST003.py.snap index ca471a1886ca1..9cb210585fd38 100644 --- a/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-unused-path-parameter_FAST003.py.snap +++ b/crates/ruff_linter/src/rules/fastapi/snapshots/ruff_linter__rules__fastapi__tests__fast-api-unused-path-parameter_FAST003.py.snap @@ -339,4 +339,44 @@ FAST003.py:87:18: FAST003 [*] Parameter `name` appears in route path, but not in 88 |+async def read_thing(name, *, author: Annotated[str, Path(alias="author_name")], title: str): 89 89 | return {"author": author, "title": title} 90 90 | -91 91 | +91 91 | + +FAST003.py:158:19: FAST003 [*] Parameter `thing_id` appears in route path, but not in `single` signature + | +157 | ### Errors +158 | @app.get("/things/{thing_id}") + | ^^^^^^^^^^ FAST003 +159 | async def single(other: Annotated[str, Depends(something_else)]): ... +160 | @app.get("/things/{thing_id}") + | + = help: Add `thing_id` to function signature + +ℹ Unsafe fix +156 156 | +157 157 | ### Errors +158 158 | @app.get("/things/{thing_id}") +159 |-async def single(other: Annotated[str, Depends(something_else)]): ... + 159 |+async def single(other: Annotated[str, Depends(something_else)], thing_id): ... +160 160 | @app.get("/things/{thing_id}") +161 161 | async def default(other: str = Depends(something_else)): ... +162 162 | + +FAST003.py:160:19: FAST003 [*] Parameter `thing_id` appears in route path, but not in `default` signature + | +158 | @app.get("/things/{thing_id}") +159 | async def single(other: Annotated[str, Depends(something_else)]): ... +160 | @app.get("/things/{thing_id}") + | ^^^^^^^^^^ FAST003 +161 | async def default(other: str = Depends(something_else)): ... + | + = help: Add `thing_id` to function signature + +ℹ Unsafe fix +158 158 | @app.get("/things/{thing_id}") +159 159 | async def single(other: Annotated[str, Depends(something_else)]): ... +160 160 | @app.get("/things/{thing_id}") +161 |-async def default(other: str = Depends(something_else)): ... + 161 |+async def default(thing_id, other: str = Depends(something_else)): ... +162 162 | +163 163 | +164 164 | ### No errors diff --git a/crates/ruff_linter/src/rules/flake8_2020/rules/compare.rs b/crates/ruff_linter/src/rules/flake8_2020/rules/compare.rs index e2a7b0ccdf776..00e310e9d84fc 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/rules/compare.rs +++ b/crates/ruff_linter/src/rules/flake8_2020/rules/compare.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_text_size::Ranged; @@ -40,13 +40,13 @@ use super::super::helpers::is_sys; /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionCmpStr3; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionCmpStr3; impl Violation for SysVersionCmpStr3 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version` compared to string (python3.10), use `sys.version_info`") + "`sys.version` compared to string (python3.10), use `sys.version_info`".to_string() } } @@ -87,13 +87,13 @@ impl Violation for SysVersionCmpStr3 { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionInfo0Eq3; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionInfo0Eq3; impl Violation for SysVersionInfo0Eq3 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version_info[0] == 3` referenced (python4), use `>=`") + "`sys.version_info[0] == 3` referenced (python4), use `>=`".to_string() } } @@ -127,16 +127,15 @@ impl Violation for SysVersionInfo0Eq3 { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionInfo1CmpInt; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionInfo1CmpInt; impl Violation for SysVersionInfo1CmpInt { #[derive_message_formats] fn message(&self) -> String { - format!( - "`sys.version_info[1]` compared to integer (python4), compare `sys.version_info` to \ + "`sys.version_info[1]` compared to integer (python4), compare `sys.version_info` to \ tuple" - ) + .to_string() } } @@ -170,16 +169,15 @@ impl Violation for SysVersionInfo1CmpInt { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionInfoMinorCmpInt; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionInfoMinorCmpInt; impl Violation for SysVersionInfoMinorCmpInt { #[derive_message_formats] fn message(&self) -> String { - format!( - "`sys.version_info.minor` compared to integer (python4), compare `sys.version_info` \ + "`sys.version_info.minor` compared to integer (python4), compare `sys.version_info` \ to tuple" - ) + .to_string() } } @@ -214,18 +212,18 @@ impl Violation for SysVersionInfoMinorCmpInt { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionCmpStr10; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionCmpStr10; impl Violation for SysVersionCmpStr10 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version` compared to string (python10), use `sys.version_info`") + "`sys.version` compared to string (python10), use `sys.version_info`".to_string() } } /// YTT103, YTT201, YTT203, YTT204, YTT302 -pub(crate) fn compare(checker: &mut Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr]) { +pub(crate) fn compare(checker: &Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr]) { match left { Expr::Subscript(ast::ExprSubscript { value, slice, .. }) if is_sys(value, "version_info", checker.semantic()) => @@ -238,31 +236,37 @@ pub(crate) fn compare(checker: &mut Checker, left: &Expr, ops: &[CmpOp], compara if *i == 0 { if let ( [CmpOp::Eq | CmpOp::NotEq], - [Expr::NumberLiteral(ast::ExprNumberLiteral { - value: ast::Number::Int(n), - .. - })], + [ + Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Int(n), + .. + }), + ], ) = (ops, comparators) { if *n == 3 && checker.enabled(Rule::SysVersionInfo0Eq3) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionInfo0Eq3, left.range())); + checker.report_diagnostic(Diagnostic::new( + SysVersionInfo0Eq3, + left.range(), + )); } } } else if *i == 1 { if let ( [CmpOp::Lt | CmpOp::LtE | CmpOp::Gt | CmpOp::GtE], - [Expr::NumberLiteral(ast::ExprNumberLiteral { - value: ast::Number::Int(_), - .. - })], + [ + Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Int(_), + .. + }), + ], ) = (ops, comparators) { if checker.enabled(Rule::SysVersionInfo1CmpInt) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionInfo1CmpInt, left.range())); + checker.report_diagnostic(Diagnostic::new( + SysVersionInfo1CmpInt, + left.range(), + )); } } } @@ -274,16 +278,19 @@ pub(crate) fn compare(checker: &mut Checker, left: &Expr, ops: &[CmpOp], compara { if let ( [CmpOp::Lt | CmpOp::LtE | CmpOp::Gt | CmpOp::GtE], - [Expr::NumberLiteral(ast::ExprNumberLiteral { - value: ast::Number::Int(_), - .. - })], + [ + Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Int(_), + .. + }), + ], ) = (ops, comparators) { if checker.enabled(Rule::SysVersionInfoMinorCmpInt) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionInfoMinorCmpInt, left.range())); + checker.report_diagnostic(Diagnostic::new( + SysVersionInfoMinorCmpInt, + left.range(), + )); } } } @@ -299,14 +306,10 @@ pub(crate) fn compare(checker: &mut Checker, left: &Expr, ops: &[CmpOp], compara { if value.len() == 1 { if checker.enabled(Rule::SysVersionCmpStr10) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionCmpStr10, left.range())); + checker.report_diagnostic(Diagnostic::new(SysVersionCmpStr10, left.range())); } } else if checker.enabled(Rule::SysVersionCmpStr3) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionCmpStr3, left.range())); + checker.report_diagnostic(Diagnostic::new(SysVersionCmpStr3, left.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_2020/rules/name_or_attribute.rs b/crates/ruff_linter/src/rules/flake8_2020/rules/name_or_attribute.rs index ad3d40c9069e1..bcf610d355251 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/rules/name_or_attribute.rs +++ b/crates/ruff_linter/src/rules/flake8_2020/rules/name_or_attribute.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -35,18 +35,18 @@ use crate::checkers::ast::Checker; /// - [PyPI: `six`](https://pypi.org/project/six/) /// - [Six documentation: `six.PY2`](https://six.readthedocs.io/#six.PY2) /// - [Six documentation: `six.PY3`](https://six.readthedocs.io/#six.PY3) -#[violation] -pub struct SixPY3; +#[derive(ViolationMetadata)] +pub(crate) struct SixPY3; impl Violation for SixPY3 { #[derive_message_formats] fn message(&self) -> String { - format!("`six.PY3` referenced (python4), use `not six.PY2`") + "`six.PY3` referenced (python4), use `not six.PY2`".to_string() } } /// YTT202 -pub(crate) fn name_or_attribute(checker: &mut Checker, expr: &Expr) { +pub(crate) fn name_or_attribute(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::SIX) { return; } @@ -56,8 +56,6 @@ pub(crate) fn name_or_attribute(checker: &mut Checker, expr: &Expr) { .resolve_qualified_name(expr) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["six", "PY3"])) { - checker - .diagnostics - .push(Diagnostic::new(SixPY3, expr.range())); + checker.report_diagnostic(Diagnostic::new(SixPY3, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_2020/rules/subscript.rs b/crates/ruff_linter/src/rules/flake8_2020/rules/subscript.rs index cb8ce847a6034..0ed2feb248179 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/rules/subscript.rs +++ b/crates/ruff_linter/src/rules/flake8_2020/rules/subscript.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -37,13 +37,13 @@ use crate::rules::flake8_2020::helpers::is_sys; /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionSlice3; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionSlice3; impl Violation for SysVersionSlice3 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version[:3]` referenced (python3.10), use `sys.version_info`") + "`sys.version[:3]` referenced (python3.10), use `sys.version_info`".to_string() } } @@ -77,13 +77,13 @@ impl Violation for SysVersionSlice3 { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersion2; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersion2; impl Violation for SysVersion2 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version[2]` referenced (python3.10), use `sys.version_info`") + "`sys.version[2]` referenced (python3.10), use `sys.version_info`".to_string() } } @@ -117,13 +117,13 @@ impl Violation for SysVersion2 { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersion0; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersion0; impl Violation for SysVersion0 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version[0]` referenced (python10), use `sys.version_info`") + "`sys.version[0]` referenced (python10), use `sys.version_info`".to_string() } } @@ -157,18 +157,18 @@ impl Violation for SysVersion0 { /// ## References /// - [Python documentation: `sys.version`](https://docs.python.org/3/library/sys.html#sys.version) /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct SysVersionSlice1; +#[derive(ViolationMetadata)] +pub(crate) struct SysVersionSlice1; impl Violation for SysVersionSlice1 { #[derive_message_formats] fn message(&self) -> String { - format!("`sys.version[:1]` referenced (python10), use `sys.version_info`") + "`sys.version[:1]` referenced (python10), use `sys.version_info`".to_string() } } /// YTT101, YTT102, YTT301, YTT303 -pub(crate) fn subscript(checker: &mut Checker, value: &Expr, slice: &Expr) { +pub(crate) fn subscript(checker: &Checker, value: &Expr, slice: &Expr) { if is_sys(value, "version", checker.semantic()) { match slice { Expr::Slice(ast::ExprSlice { @@ -183,13 +183,9 @@ pub(crate) fn subscript(checker: &mut Checker, value: &Expr, slice: &Expr) { }) = upper.as_ref() { if *i == 1 && checker.enabled(Rule::SysVersionSlice1) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionSlice1, value.range())); + checker.report_diagnostic(Diagnostic::new(SysVersionSlice1, value.range())); } else if *i == 3 && checker.enabled(Rule::SysVersionSlice3) { - checker - .diagnostics - .push(Diagnostic::new(SysVersionSlice3, value.range())); + checker.report_diagnostic(Diagnostic::new(SysVersionSlice3, value.range())); } } } @@ -199,13 +195,9 @@ pub(crate) fn subscript(checker: &mut Checker, value: &Expr, slice: &Expr) { .. }) => { if *i == 2 && checker.enabled(Rule::SysVersion2) { - checker - .diagnostics - .push(Diagnostic::new(SysVersion2, value.range())); + checker.report_diagnostic(Diagnostic::new(SysVersion2, value.range())); } else if *i == 0 && checker.enabled(Rule::SysVersion0) { - checker - .diagnostics - .push(Diagnostic::new(SysVersion0, value.range())); + checker.report_diagnostic(Diagnostic::new(SysVersion0, value.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT101_YTT101.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT101_YTT101.py.snap index bc9ee591ad4b4..bd81dd2410289 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT101_YTT101.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT101_YTT101.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT101.py:6:7: YTT101 `sys.version[:3]` referenced (python3.10), use `sys.version_info` | 4 | print(sys.version) -5 | +5 | 6 | print(sys.version[:3]) | ^^^^^^^^^^^ YTT101 7 | print(version[:3]) @@ -25,8 +25,6 @@ YTT101.py:8:7: YTT101 `sys.version[:3]` referenced (python3.10), use `sys.versio 7 | print(version[:3]) 8 | print(v[:3]) | ^ YTT101 - 9 | + 9 | 10 | # the tool is timid and only flags certain numeric slices | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT102_YTT102.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT102_YTT102.py.snap index d53992394e40f..b5b82d89fa9ec 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT102_YTT102.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT102_YTT102.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT102.py:4:12: YTT102 `sys.version[2]` referenced (python3.10), use `sys.version_info` | 2 | from sys import version -3 | +3 | 4 | py_minor = sys.version[2] | ^^^^^^^^^^^ YTT102 5 | py_minor = version[2] @@ -16,5 +16,3 @@ YTT102.py:5:12: YTT102 `sys.version[2]` referenced (python3.10), use `sys.versio 5 | py_minor = version[2] | ^^^^^^^ YTT102 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT103_YTT103.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT103_YTT103.py.snap index 8adb672777bd2..fb884488c8308 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT103_YTT103.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT103_YTT103.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT103.py:4:1: YTT103 `sys.version` compared to string (python3.10), use `sys.version_info` | 2 | from sys import version -3 | +3 | 4 | version < "3.5" | ^^^^^^^ YTT103 5 | sys.version < "3.5" @@ -46,5 +46,3 @@ YTT103.py:8:1: YTT103 `sys.version` compared to string (python3.10), use `sys.ve 8 | sys.version >= "3.5" | ^^^^^^^^^^^ YTT103 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT201_YTT201.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT201_YTT201.py.snap index f546967999764..c2ae9a26987b0 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT201_YTT201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT201_YTT201.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT201.py:7:7: YTT201 `sys.version_info[0] == 3` referenced (python4), use `>=` | 5 | PY3 = sys.version_info[0] >= 3 -6 | +6 | 7 | PY3 = sys.version_info[0] == 3 | ^^^^^^^^^^^^^^^^^^^ YTT201 8 | PY3 = version_info[0] == 3 @@ -36,5 +36,3 @@ YTT201.py:10:7: YTT201 `sys.version_info[0] == 3` referenced (python4), use `>=` 10 | PY2 = version_info[0] != 3 | ^^^^^^^^^^^^^^^ YTT201 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT202_YTT202.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT202_YTT202.py.snap index 0e587466f9a4a..da923c2649d39 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT202_YTT202.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT202_YTT202.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT202.py:4:4: YTT202 `six.PY3` referenced (python4), use `not six.PY2` | 2 | from six import PY3 -3 | +3 | 4 | if six.PY3: | ^^^^^^^ YTT202 5 | print("3") @@ -19,5 +19,3 @@ YTT202.py:6:4: YTT202 `six.PY3` referenced (python4), use `not six.PY2` | ^^^ YTT202 7 | print("3") | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT203_YTT203.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT203_YTT203.py.snap index a10f86b44e881..98340c2c0d41e 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT203_YTT203.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT203_YTT203.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT203.py:4:1: YTT203 `sys.version_info[1]` compared to integer (python4), compare `sys.version_info` to tuple | 2 | from sys import version_info -3 | +3 | 4 | sys.version_info[1] >= 5 | ^^^^^^^^^^^^^^^^^^^ YTT203 5 | version_info[1] < 6 @@ -16,5 +16,3 @@ YTT203.py:5:1: YTT203 `sys.version_info[1]` compared to integer (python4), compa 5 | version_info[1] < 6 | ^^^^^^^^^^^^^^^ YTT203 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT204_YTT204.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT204_YTT204.py.snap index 69997d727b4a6..0d59be0063afd 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT204_YTT204.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT204_YTT204.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT204.py:4:1: YTT204 `sys.version_info.minor` compared to integer (python4), compare `sys.version_info` to tuple | 2 | from sys import version_info -3 | +3 | 4 | sys.version_info.minor <= 7 | ^^^^^^^^^^^^^^^^^^^^^^ YTT204 5 | version_info.minor > 8 @@ -16,5 +16,3 @@ YTT204.py:5:1: YTT204 `sys.version_info.minor` compared to integer (python4), co 5 | version_info.minor > 8 | ^^^^^^^^^^^^^^^^^^ YTT204 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT301_YTT301.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT301_YTT301.py.snap index 543dd08b1eba9..df1b27d3302d1 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT301_YTT301.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT301_YTT301.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT301.py:4:12: YTT301 `sys.version[0]` referenced (python10), use `sys.version_info` | 2 | from sys import version -3 | +3 | 4 | py_major = sys.version[0] | ^^^^^^^^^^^ YTT301 5 | py_major = version[0] @@ -16,5 +16,3 @@ YTT301.py:5:12: YTT301 `sys.version[0]` referenced (python10), use `sys.version_ 5 | py_major = version[0] | ^^^^^^^ YTT301 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT302_YTT302.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT302_YTT302.py.snap index 11a4dea38ba20..27e563290e950 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT302_YTT302.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT302_YTT302.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT302.py:4:1: YTT302 `sys.version` compared to string (python10), use `sys.version_info` | 2 | from sys import version -3 | +3 | 4 | version < "3" | ^^^^^^^ YTT302 5 | sys.version < "3" @@ -46,5 +46,3 @@ YTT302.py:8:1: YTT302 `sys.version` compared to string (python10), use `sys.vers 8 | sys.version >= "3" | ^^^^^^^^^^^ YTT302 | - - diff --git a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT303_YTT303.py.snap b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT303_YTT303.py.snap index 0e84487271647..8cda6c210886b 100644 --- a/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT303_YTT303.py.snap +++ b/crates/ruff_linter/src/rules/flake8_2020/snapshots/ruff_linter__rules__flake8_2020__tests__YTT303_YTT303.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_2020/mod.rs YTT303.py:4:7: YTT303 `sys.version[:1]` referenced (python10), use `sys.version_info` | 2 | from sys import version -3 | +3 | 4 | print(sys.version[:1]) | ^^^^^^^^^^^ YTT303 5 | print(version[:1]) @@ -16,5 +16,3 @@ YTT303.py:5:7: YTT303 `sys.version[:1]` referenced (python10), use `sys.version_ 5 | print(version[:1]) | ^^^^^^^ YTT303 | - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/helpers.rs b/crates/ruff_linter/src/rules/flake8_annotations/helpers.rs index 1cea0f6135233..65ef77667b971 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_annotations/helpers.rs @@ -3,7 +3,7 @@ use rustc_hash::FxHashSet; use ruff_diagnostics::Edit; use ruff_python_ast::helpers::{ - pep_604_union, typing_optional, typing_union, ReturnStatementVisitor, + ReturnStatementVisitor, pep_604_union, typing_optional, typing_union, }; use ruff_python_ast::name::Name; use ruff_python_ast::visitor::Visitor; @@ -14,8 +14,8 @@ use ruff_python_semantic::analyze::visibility; use ruff_python_semantic::{Definition, SemanticModel}; use ruff_text_size::{TextRange, TextSize}; -use crate::importer::{ImportRequest, Importer}; -use crate::settings::types::PythonVersion; +use crate::checkers::ast::Checker; +use ruff_python_ast::PythonVersion; /// Return the name of the function, if it's overloaded. pub(crate) fn overloaded_name<'a>( @@ -119,26 +119,20 @@ impl AutoPythonType { /// additional edits. pub(crate) fn into_expression( self, - importer: &Importer, + checker: &Checker, at: TextSize, - semantic: &SemanticModel, - target_version: PythonVersion, ) -> Option<(Expr, Vec<Edit>)> { + let target_version = checker.target_version(); match self { AutoPythonType::Never => { - let (no_return_edit, binding) = importer - .get_or_import_symbol( - &ImportRequest::import_from( - "typing", - if target_version >= PythonVersion::Py311 { - "Never" - } else { - "NoReturn" - }, - ), - at, - semantic, - ) + let member = if target_version >= PythonVersion::PY311 { + "Never" + } else { + "NoReturn" + }; + let (no_return_edit, binding) = checker + .typing_importer(member, PythonVersion::lowest())? + .import(at) .ok()?; let expr = Expr::Name(ast::ExprName { id: Name::from(binding), @@ -152,7 +146,7 @@ impl AutoPythonType { Some((expr, vec![])) } AutoPythonType::Union(python_types) => { - if target_version >= PythonVersion::Py310 { + if target_version >= PythonVersion::PY310 { // Aggregate all the individual types (e.g., `int`, `float`). let names = python_types .iter() @@ -175,12 +169,9 @@ impl AutoPythonType { let element = type_expr(*python_type)?; // Ex) `Optional[int]` - let (optional_edit, binding) = importer - .get_or_import_symbol( - &ImportRequest::import_from("typing", "Optional"), - at, - semantic, - ) + let (optional_edit, binding) = checker + .typing_importer("Optional", PythonVersion::lowest())? + .import(at) .ok()?; let expr = typing_optional(element, Name::from(binding)); Some((expr, vec![optional_edit])) @@ -192,12 +183,9 @@ impl AutoPythonType { .collect::<Option<Vec<_>>>()?; // Ex) `Union[int, str]` - let (union_edit, binding) = importer - .get_or_import_symbol( - &ImportRequest::import_from("typing", "Union"), - at, - semantic, - ) + let (union_edit, binding) = checker + .typing_importer("Union", PythonVersion::lowest())? + .import(at) .ok()?; let expr = typing_union(&elements, Name::from(binding)); Some((expr, vec![union_edit])) diff --git a/crates/ruff_linter/src/rules/flake8_annotations/mod.rs b/crates/ruff_linter/src/rules/flake8_annotations/mod.rs index 859f8588c5311..8fd8556d74e8e 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_annotations/mod.rs @@ -11,9 +11,9 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::settings::LinterSettings; use crate::test::test_path; + use ruff_python_ast::PythonVersion; #[test] fn defaults() -> Result<()> { @@ -24,8 +24,6 @@ mod tests { Rule::MissingTypeFunctionArgument, Rule::MissingTypeArgs, Rule::MissingTypeKwargs, - Rule::MissingTypeSelf, - Rule::MissingTypeCls, Rule::MissingReturnTypeUndocumentedPublicFunction, Rule::MissingReturnTypePrivateFunction, Rule::MissingReturnTypeSpecialMethod, @@ -52,8 +50,6 @@ mod tests { Rule::MissingTypeFunctionArgument, Rule::MissingTypeArgs, Rule::MissingTypeKwargs, - Rule::MissingTypeSelf, - Rule::MissingTypeCls, Rule::MissingReturnTypeUndocumentedPublicFunction, Rule::MissingReturnTypePrivateFunction, Rule::MissingReturnTypeSpecialMethod, @@ -80,8 +76,6 @@ mod tests { Rule::MissingTypeFunctionArgument, Rule::MissingTypeArgs, Rule::MissingTypeKwargs, - Rule::MissingTypeSelf, - Rule::MissingTypeCls, ]) }, )?; @@ -134,7 +128,7 @@ mod tests { let diagnostics = test_path( Path::new("flake8_annotations/auto_return_type.py"), &LinterSettings { - target_version: PythonVersion::Py38, + unresolved_target_version: PythonVersion::PY38.into(), ..LinterSettings::for_rules(vec![ Rule::MissingReturnTypeUndocumentedPublicFunction, Rule::MissingReturnTypePrivateFunction, @@ -161,8 +155,6 @@ mod tests { Rule::MissingTypeFunctionArgument, Rule::MissingTypeArgs, Rule::MissingTypeKwargs, - Rule::MissingTypeSelf, - Rule::MissingTypeCls, Rule::MissingReturnTypeUndocumentedPublicFunction, Rule::MissingReturnTypePrivateFunction, Rule::MissingReturnTypeSpecialMethod, diff --git a/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs b/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs index b1e5cbbf983c9..1f75ec28a1ea6 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs +++ b/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::{self as ast, Expr, ParameterWithDefault, Stmt}; -use ruff_python_semantic::analyze::visibility; +use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_semantic::Definition; +use ruff_python_semantic::analyze::visibility; use ruff_python_stdlib::typing::simple_magic_return_type; use ruff_text_size::Ranged; @@ -33,8 +33,11 @@ use crate::rules::ruff::typing::type_hint_resolves_to_any; /// ```python /// def foo(x: int): ... /// ``` -#[violation] -pub struct MissingTypeFunctionArgument { +/// +/// ## Options +/// - `lint.flake8-annotations.suppress-dummy-args` +#[derive(ViolationMetadata)] +pub(crate) struct MissingTypeFunctionArgument { name: String, } @@ -65,8 +68,11 @@ impl Violation for MissingTypeFunctionArgument { /// ```python /// def foo(*args: int): ... /// ``` -#[violation] -pub struct MissingTypeArgs { +/// +/// ## Options +/// - `lint.flake8-annotations.suppress-dummy-args` +#[derive(ViolationMetadata)] +pub(crate) struct MissingTypeArgs { name: String, } @@ -97,8 +103,11 @@ impl Violation for MissingTypeArgs { /// ```python /// def foo(**kwargs: int): ... /// ``` -#[violation] -pub struct MissingTypeKwargs { +/// +/// ## Options +/// - `lint.flake8-annotations.suppress-dummy-args` +#[derive(ViolationMetadata)] +pub(crate) struct MissingTypeKwargs { name: String, } @@ -110,9 +119,8 @@ impl Violation for MissingTypeKwargs { } } -/// ## Deprecation -/// This rule is commonly disabled because type checkers can infer this type without annotation. -/// It will be removed in a future release. +/// ## Removed +/// This rule has been removed because type checkers can infer this type without annotation. /// /// ## What it does /// Checks that instance method `self` arguments have type annotations. @@ -138,22 +146,23 @@ impl Violation for MissingTypeKwargs { /// class Foo: /// def bar(self: "Foo"): ... /// ``` -#[violation] -pub struct MissingTypeSelf { - name: String, -} +#[derive(ViolationMetadata)] +#[deprecated(note = "ANN101 has been removed")] +pub(crate) struct MissingTypeSelf; +#[expect(deprecated)] impl Violation for MissingTypeSelf { - #[derive_message_formats] fn message(&self) -> String { - let Self { name } = self; - format!("Missing type annotation for `{name}` in method") + unreachable!("ANN101 has been removed"); + } + + fn message_formats() -> &'static [&'static str] { + &["Missing type annotation for `{name}` in method"] } } -/// ## Deprecation -/// This rule is commonly disabled because type checkers can infer this type without annotation. -/// It will be removed in a future release. +/// ## Removed +/// This rule has been removed because type checkers can infer this type without annotation. /// /// ## What it does /// Checks that class method `cls` arguments have type annotations. @@ -181,16 +190,18 @@ impl Violation for MissingTypeSelf { /// @classmethod /// def bar(cls: Type["Foo"]): ... /// ``` -#[violation] -pub struct MissingTypeCls { - name: String, -} +#[derive(ViolationMetadata)] +#[deprecated(note = "ANN102 has been removed")] +pub(crate) struct MissingTypeCls; +#[expect(deprecated)] impl Violation for MissingTypeCls { - #[derive_message_formats] fn message(&self) -> String { - let Self { name } = self; - format!("Missing type annotation for `{name}` in classmethod") + unreachable!("ANN102 has been removed") + } + + fn message_formats() -> &'static [&'static str] { + &["Missing type annotation for `{name}` in classmethod"] } } @@ -213,8 +224,18 @@ impl Violation for MissingTypeCls { /// def add(a: int, b: int) -> int: /// return a + b /// ``` -#[violation] -pub struct MissingReturnTypeUndocumentedPublicFunction { +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for some Python versions, +/// its diagnostic will not be emitted, and no fix will be offered, if `typing_extensions` imports +/// have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +#[derive(ViolationMetadata)] +pub(crate) struct MissingReturnTypeUndocumentedPublicFunction { name: String, annotation: Option<String>, } @@ -229,12 +250,11 @@ impl Violation for MissingReturnTypeUndocumentedPublicFunction { } fn fix_title(&self) -> Option<String> { - let Self { annotation, .. } = self; - if let Some(annotation) = annotation { - Some(format!("Add return type annotation: `{annotation}`")) - } else { - Some(format!("Add return type annotation")) - } + let title = match &self.annotation { + Some(annotation) => format!("Add return type annotation: `{annotation}`"), + None => "Add return type annotation".to_string(), + }; + Some(title) } } @@ -257,8 +277,18 @@ impl Violation for MissingReturnTypeUndocumentedPublicFunction { /// def _add(a: int, b: int) -> int: /// return a + b /// ``` -#[violation] -pub struct MissingReturnTypePrivateFunction { +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for some Python versions, +/// its diagnostic will not be emitted, and no fix will be offered, if `typing_extensions` imports +/// have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +#[derive(ViolationMetadata)] +pub(crate) struct MissingReturnTypePrivateFunction { name: String, annotation: Option<String>, } @@ -273,12 +303,11 @@ impl Violation for MissingReturnTypePrivateFunction { } fn fix_title(&self) -> Option<String> { - let Self { annotation, .. } = self; - if let Some(annotation) = annotation { - Some(format!("Add return type annotation: `{annotation}`")) - } else { - Some(format!("Add return type annotation")) - } + let title = match &self.annotation { + Some(annotation) => format!("Add return type annotation: `{annotation}`"), + None => "Add return type annotation".to_string(), + }; + Some(title) } } @@ -314,8 +343,8 @@ impl Violation for MissingReturnTypePrivateFunction { /// def __init__(self, x: int) -> None: /// self.x = x /// ``` -#[violation] -pub struct MissingReturnTypeSpecialMethod { +#[derive(ViolationMetadata)] +pub(crate) struct MissingReturnTypeSpecialMethod { name: String, annotation: Option<String>, } @@ -330,12 +359,11 @@ impl Violation for MissingReturnTypeSpecialMethod { } fn fix_title(&self) -> Option<String> { - let Self { annotation, .. } = self; - if let Some(annotation) = annotation { - Some(format!("Add return type annotation: `{annotation}`")) - } else { - Some(format!("Add return type annotation")) - } + let title = match &self.annotation { + Some(annotation) => format!("Add return type annotation: `{annotation}`"), + None => "Add return type annotation".to_string(), + }; + Some(title) } } @@ -362,8 +390,8 @@ impl Violation for MissingReturnTypeSpecialMethod { /// def bar() -> int: /// return 1 /// ``` -#[violation] -pub struct MissingReturnTypeStaticMethod { +#[derive(ViolationMetadata)] +pub(crate) struct MissingReturnTypeStaticMethod { name: String, annotation: Option<String>, } @@ -378,12 +406,11 @@ impl Violation for MissingReturnTypeStaticMethod { } fn fix_title(&self) -> Option<String> { - let Self { annotation, .. } = self; - if let Some(annotation) = annotation { - Some(format!("Add return type annotation: `{annotation}`")) - } else { - Some(format!("Add return type annotation")) - } + let title = match &self.annotation { + Some(annotation) => format!("Add return type annotation: `{annotation}`"), + None => "Add return type annotation".to_string(), + }; + Some(title) } } @@ -410,8 +437,8 @@ impl Violation for MissingReturnTypeStaticMethod { /// def bar(cls) -> int: /// return 1 /// ``` -#[violation] -pub struct MissingReturnTypeClassMethod { +#[derive(ViolationMetadata)] +pub(crate) struct MissingReturnTypeClassMethod { name: String, annotation: Option<String>, } @@ -426,12 +453,11 @@ impl Violation for MissingReturnTypeClassMethod { } fn fix_title(&self) -> Option<String> { - let Self { annotation, .. } = self; - if let Some(annotation) = annotation { - Some(format!("Add return type annotation: `{annotation}`")) - } else { - Some(format!("Add return type annotation")) - } + let title = match &self.annotation { + Some(annotation) => format!("Add return type annotation: `{annotation}`"), + None => "Add return type annotation".to_string(), + }; + Some(title) } } @@ -474,11 +500,11 @@ impl Violation for MissingReturnTypeClassMethod { /// ``` /// /// ## References -/// - [PEP 484](https://www.python.org/dev/peps/pep-0484/#the-any-type) +/// - [Typing spec: `Any`](https://typing.python.org/en/latest/spec/special-types.html#any) /// - [Python documentation: `typing.Any`](https://docs.python.org/3/library/typing.html#typing.Any) /// - [Mypy documentation: The Any type](https://mypy.readthedocs.io/en/stable/kinds_of_types.html#the-any-type) -#[violation] -pub struct AnyType { +#[derive(ViolationMetadata)] +pub(crate) struct AnyType { name: String, } @@ -513,11 +539,11 @@ fn check_dynamically_typed<F>( { if let Expr::StringLiteral(string_expr) = annotation { // Quoted annotations - if let Some(parsed_annotation) = checker.parse_type_annotation(string_expr) { + if let Ok(parsed_annotation) = checker.parse_type_annotation(string_expr) { if type_hint_resolves_to_any( parsed_annotation.expression(), checker, - checker.settings.target_version.minor(), + checker.target_version(), ) { diagnostics.push(Diagnostic::new( AnyType { name: func() }, @@ -526,7 +552,7 @@ fn check_dynamically_typed<F>( } } } else { - if type_hint_resolves_to_any(annotation, checker, checker.settings.target_version.minor()) { + if type_hint_resolves_to_any(annotation, checker, checker.target_version()) { diagnostics.push(Diagnostic::new( AnyType { name: func() }, annotation.range(), @@ -578,9 +604,9 @@ pub(crate) fn definition( checker: &Checker, definition: &Definition, visibility: visibility::Visibility, -) -> Vec<Diagnostic> { +) { let Some(function) = definition.as_function_def() else { - return vec![]; + return; }; let ast::StmtFunctionDef { @@ -599,7 +625,6 @@ pub(crate) fn definition( // Keep track of whether we've seen any typed arguments or return values. let mut has_any_typed_arg = false; // Any argument has been typed? let mut has_typed_return = false; // Return value has been typed? - let mut has_typed_self_or_cls = false; // Has a typed `self` or `cls` argument? // Temporary storage for diagnostics; we emit them at the end // unless configured to suppress ANN* for declarations that are fully untyped. @@ -608,21 +633,17 @@ pub(crate) fn definition( let is_overridden = visibility::is_override(decorator_list, checker.semantic()); // If this is a non-static method, skip `cls` or `self`. - for ParameterWithDefault { - parameter, - default: _, - range: _, - } in parameters.iter_non_variadic_params().skip(usize::from( + for parameter in parameters.iter_non_variadic_params().skip(usize::from( is_method && !visibility::is_staticmethod(decorator_list, checker.semantic()), )) { // ANN401 for dynamically typed parameters - if let Some(annotation) = ¶meter.annotation { + if let Some(annotation) = parameter.annotation() { has_any_typed_arg = true; if checker.enabled(Rule::AnyType) && !is_overridden { check_dynamically_typed( checker, annotation, - || parameter.name.to_string(), + || parameter.name().to_string(), &mut diagnostics, ); } @@ -631,14 +652,14 @@ pub(crate) fn definition( && checker .settings .dummy_variable_rgx - .is_match(¶meter.name)) + .is_match(parameter.name())) { if checker.enabled(Rule::MissingTypeFunctionArgument) { diagnostics.push(Diagnostic::new( MissingTypeFunctionArgument { - name: parameter.name.to_string(), + name: parameter.name().to_string(), }, - parameter.range(), + parameter.parameter.range(), )); } } @@ -702,43 +723,6 @@ pub(crate) fn definition( } } - // ANN101, ANN102 - if is_method && !visibility::is_staticmethod(decorator_list, checker.semantic()) { - if let Some(ParameterWithDefault { - parameter, - default: _, - range: _, - }) = parameters - .posonlyargs - .first() - .or_else(|| parameters.args.first()) - { - if parameter.annotation.is_none() { - if visibility::is_classmethod(decorator_list, checker.semantic()) { - if checker.enabled(Rule::MissingTypeCls) { - diagnostics.push(Diagnostic::new( - MissingTypeCls { - name: parameter.name.to_string(), - }, - parameter.range(), - )); - } - } else { - if checker.enabled(Rule::MissingTypeSelf) { - diagnostics.push(Diagnostic::new( - MissingTypeSelf { - name: parameter.name.to_string(), - }, - parameter.range(), - )); - } - } - } else { - has_typed_self_or_cls = true; - } - } - } - // ANN201, ANN202, ANN401 if let Some(expr) = &returns { has_typed_return = true; @@ -757,12 +741,7 @@ pub(crate) fn definition( } else { auto_return_type(function) .and_then(|return_type| { - return_type.into_expression( - checker.importer(), - function.parameters.start(), - checker.semantic(), - checker.settings.target_version, - ) + return_type.into_expression(checker, function.parameters.start()) }) .map(|(return_type, edits)| (checker.generator().expr(&return_type), edits)) }; @@ -788,12 +767,7 @@ pub(crate) fn definition( } else { auto_return_type(function) .and_then(|return_type| { - return_type.into_expression( - checker.importer(), - function.parameters.start(), - checker.semantic(), - checker.settings.target_version, - ) + return_type.into_expression(checker, function.parameters.start()) }) .map(|(return_type, edits)| (checker.generator().expr(&return_type), edits)) }; @@ -858,12 +832,8 @@ pub(crate) fn definition( } else { auto_return_type(function) .and_then(|return_type| { - return_type.into_expression( - checker.importer(), - function.parameters.start(), - checker.semantic(), - checker.settings.target_version, - ) + return_type + .into_expression(checker, function.parameters.start()) }) .map(|(return_type, edits)| { (checker.generator().expr(&return_type), edits) @@ -897,12 +867,8 @@ pub(crate) fn definition( } else { auto_return_type(function) .and_then(|return_type| { - return_type.into_expression( - checker.importer(), - function.parameters.start(), - checker.semantic(), - checker.settings.target_version, - ) + return_type + .into_expression(checker, function.parameters.start()) }) .map(|(return_type, edits)| { (checker.generator().expr(&return_type), edits) @@ -932,13 +898,22 @@ pub(crate) fn definition( } } } + // If settings say so, don't report any of the // diagnostics gathered here if there were no type annotations at all. - if checker.settings.flake8_annotations.ignore_fully_untyped - && !(has_any_typed_arg || has_typed_self_or_cls || has_typed_return) + if !checker.settings.flake8_annotations.ignore_fully_untyped + || has_any_typed_arg + || has_typed_return + || (is_method + && !visibility::is_staticmethod(decorator_list, checker.semantic()) + && parameters + .posonlyargs + .first() + .or_else(|| parameters.args.first()) + .is_some_and(|first_param| first_param.annotation().is_some())) { - vec![] - } else { - diagnostics + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } } diff --git a/crates/ruff_linter/src/rules/flake8_annotations/settings.rs b/crates/ruff_linter/src/rules/flake8_annotations/settings.rs index 342a56023a0e1..c2b1875100e5d 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_annotations/settings.rs @@ -5,7 +5,7 @@ use ruff_macros::CacheKey; use std::fmt::{Display, Formatter}; #[derive(Debug, Clone, Default, CacheKey)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct Settings { pub mypy_init_return: bool, pub suppress_dummy_args: bool, diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_nested_overload.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_nested_overload.snap index 1cda90bb2d76c..84015aa9bc866 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_nested_overload.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_nested_overload.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_overload.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_overload.snap index 8db1454b2141f..dc8485ff440ac 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_overload.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_overload.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- allow_overload.py:29:9: ANN201 Missing return type annotation for public function `bar` | @@ -9,5 +10,3 @@ allow_overload.py:29:9: ANN201 Missing return type annotation for public functio 30 | return i | = help: Add return type annotation - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_star_arg_any.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_star_arg_any.snap index 15afb6822981a..3a69fd737af3a 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_star_arg_any.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__allow_star_arg_any.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- allow_star_arg_any.py:10:12: ANN401 Dynamically typed expressions (typing.Any) are disallowed in `a` | @@ -32,5 +33,3 @@ allow_star_arg_any.py:44:67: ANN401 Dynamically typed expressions (typing.Any) a | ^^^ ANN401 45 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type.snap index c2be32c1fa995..d3c838bb149fd 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- auto_return_type.py:1:5: ANN201 [*] Missing return type annotation for public function `func` | @@ -768,5 +769,3 @@ auto_return_type.py:299:5: ANN201 [*] Missing return type annotation for public 300 300 | match x: 301 301 | case [1, 2, 3]: 302 302 | return 1 - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type_py38.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type_py38.snap index 4cb5bbfb615fa..49b9a07c81b71 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type_py38.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__auto_return_type_py38.snap @@ -96,7 +96,7 @@ auto_return_type.py:27:5: ANN201 [*] Missing return type annotation for public f | ^^^^ ANN201 28 | return 1 or 2.5 if x > 0 else 1.5 or "str" | - = help: Add return type annotation: `Union[str | float]` + = help: Add return type annotation: `Union[str, float]` ℹ Unsafe fix 1 |+from typing import Union @@ -108,7 +108,7 @@ auto_return_type.py:27:5: ANN201 [*] Missing return type annotation for public f 25 26 | 26 27 | 27 |-def func(x: int): - 28 |+def func(x: int) -> Union[str | float]: + 28 |+def func(x: int) -> Union[str, float]: 28 29 | return 1 or 2.5 if x > 0 else 1.5 or "str" 29 30 | 30 31 | @@ -119,7 +119,7 @@ auto_return_type.py:31:5: ANN201 [*] Missing return type annotation for public f | ^^^^ ANN201 32 | return 1 + 2.5 if x > 0 else 1.5 or "str" | - = help: Add return type annotation: `Union[str | float]` + = help: Add return type annotation: `Union[str, float]` ℹ Unsafe fix 1 |+from typing import Union @@ -131,7 +131,7 @@ auto_return_type.py:31:5: ANN201 [*] Missing return type annotation for public f 29 30 | 30 31 | 31 |-def func(x: int): - 32 |+def func(x: int) -> Union[str | float]: + 32 |+def func(x: int) -> Union[str, float]: 32 33 | return 1 + 2.5 if x > 0 else 1.5 or "str" 33 34 | 34 35 | @@ -203,7 +203,7 @@ auto_return_type.py:59:5: ANN201 [*] Missing return type annotation for public f 60 | if not x: 61 | return 1 | - = help: Add return type annotation: `Union[str | int | None]` + = help: Add return type annotation: `Union[str, int, None]` ℹ Unsafe fix 1 |+from typing import Union @@ -215,7 +215,7 @@ auto_return_type.py:59:5: ANN201 [*] Missing return type annotation for public f 57 58 | 58 59 | 59 |-def func(x: int): - 60 |+def func(x: int) -> Union[str | int | None]: + 60 |+def func(x: int) -> Union[str, int, None]: 60 61 | if not x: 61 62 | return 1 62 63 | elif x > 5: @@ -293,7 +293,7 @@ auto_return_type.py:82:5: ANN201 [*] Missing return type annotation for public f 83 | match x: 84 | case [1, 2, 3]: | - = help: Add return type annotation: `Union[str | int | None]` + = help: Add return type annotation: `Union[str, int, None]` ℹ Unsafe fix 1 |+from typing import Union @@ -305,7 +305,7 @@ auto_return_type.py:82:5: ANN201 [*] Missing return type annotation for public f 80 81 | 81 82 | 82 |-def func(x: int): - 83 |+def func(x: int) -> Union[str | int | None]: + 83 |+def func(x: int) -> Union[str, int, None]: 83 84 | match x: 84 85 | case [1, 2, 3]: 85 86 | return 1 @@ -852,7 +852,7 @@ auto_return_type.py:299:5: ANN201 [*] Missing return type annotation for public 300 | match x: 301 | case [1, 2, 3]: | - = help: Add return type annotation: `Union[str | int]` + = help: Add return type annotation: `Union[str, int]` ℹ Unsafe fix 214 214 | return 1 @@ -868,9 +868,7 @@ auto_return_type.py:299:5: ANN201 [*] Missing return type annotation for public 297 297 | 298 298 | 299 |-def func(x: int): - 299 |+def func(x: int) -> Union[str | int]: + 299 |+def func(x: int) -> Union[str, int]: 300 300 | match x: 301 301 | case [1, 2, 3]: 302 302 | return 1 - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap index 9be33117659ce..d3837dec75837 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap @@ -157,14 +157,6 @@ annotation_presence.py:65:39: ANN401 Dynamically typed expressions (typing.Any) 66 | pass | -annotation_presence.py:75:13: ANN101 Missing type annotation for `self` in method - | -74 | # ANN101 -75 | def foo(self, a: int, b: int) -> int: - | ^^^^ ANN101 -76 | pass - | - annotation_presence.py:79:29: ANN401 Dynamically typed expressions (typing.Any) are disallowed in `a` | 78 | # ANN401 @@ -213,23 +205,6 @@ annotation_presence.py:95:59: ANN401 Dynamically typed expressions (typing.Any) 96 | pass | -annotation_presence.py:130:13: ANN102 Missing type annotation for `cls` in classmethod - | -128 | # ANN102 -129 | @classmethod -130 | def foo(cls, a: int, b: int) -> int: - | ^^^ ANN102 -131 | pass - | - -annotation_presence.py:134:13: ANN101 Missing type annotation for `self` in method - | -133 | # ANN101 -134 | def foo(self, /, a: int, b: int) -> int: - | ^^^^ ANN101 -135 | pass - | - annotation_presence.py:149:10: ANN401 Dynamically typed expressions (typing.Any) are disallowed in `a` | 148 | # ANN401 @@ -323,14 +298,3 @@ annotation_presence.py:165:9: ANN204 [*] Missing return type annotation for spec 165 |- def __init__(self): 165 |+ def __init__(self) -> None: 166 166 | print(f"{self.attr=}") - -annotation_presence.py:165:18: ANN101 Missing type annotation for `self` in method - | -163 | # Regression test for: https://github.com/astral-sh/ruff/issues/7711 -164 | class Class: -165 | def __init__(self): - | ^^^^ ANN101 -166 | print(f"{self.attr=}") - | - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__ignore_fully_untyped.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__ignore_fully_untyped.snap index d806d641b4caa..71e528ec5dfb4 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__ignore_fully_untyped.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__ignore_fully_untyped.snap @@ -54,7 +54,7 @@ ignore_fully_untyped.py:32:5: ANN201 [*] Missing return type annotation for publ ignore_fully_untyped.py:43:9: ANN201 [*] Missing return type annotation for public function `error_typed_self` | 41 | pass -42 | +42 | 43 | def error_typed_self(self: X): | ^^^^^^^^^^^^^^^^ ANN201 44 | pass @@ -68,5 +68,3 @@ ignore_fully_untyped.py:43:9: ANN201 [*] Missing return type annotation for publ 43 |- def error_typed_self(self: X): 43 |+ def error_typed_self(self: X) -> None: 44 44 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap index f25fc530bc8cf..e6ea74c2d4fd6 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- mypy_init_return.py:5:9: ANN204 [*] Missing return type annotation for special method `__init__` | @@ -77,5 +78,3 @@ mypy_init_return.py:47:9: ANN204 [*] Missing return type annotation for special 47 |- def __init__(self, *arg): 47 |+ def __init__(self, *arg) -> None: 48 48 | ... - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap index 29f85e2af8423..bc8e91807bda8 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap @@ -21,7 +21,7 @@ simple_magic_methods.py:2:9: ANN204 [*] Missing return type annotation for speci simple_magic_methods.py:5:9: ANN204 [*] Missing return type annotation for special method `__repr__` | 3 | ... -4 | +4 | 5 | def __repr__(self): | ^^^^^^^^ ANN204 6 | ... @@ -41,7 +41,7 @@ simple_magic_methods.py:5:9: ANN204 [*] Missing return type annotation for speci simple_magic_methods.py:8:9: ANN204 [*] Missing return type annotation for special method `__len__` | 6 | ... -7 | +7 | 8 | def __len__(self): | ^^^^^^^ ANN204 9 | ... @@ -61,7 +61,7 @@ simple_magic_methods.py:8:9: ANN204 [*] Missing return type annotation for speci simple_magic_methods.py:11:9: ANN204 [*] Missing return type annotation for special method `__length_hint__` | 9 | ... -10 | +10 | 11 | def __length_hint__(self): | ^^^^^^^^^^^^^^^ ANN204 12 | ... @@ -81,7 +81,7 @@ simple_magic_methods.py:11:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:14:9: ANN204 [*] Missing return type annotation for special method `__init__` | 12 | ... -13 | +13 | 14 | def __init__(self): | ^^^^^^^^ ANN204 15 | ... @@ -101,7 +101,7 @@ simple_magic_methods.py:14:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:17:9: ANN204 [*] Missing return type annotation for special method `__del__` | 15 | ... -16 | +16 | 17 | def __del__(self): | ^^^^^^^ ANN204 18 | ... @@ -121,7 +121,7 @@ simple_magic_methods.py:17:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:20:9: ANN204 [*] Missing return type annotation for special method `__bool__` | 18 | ... -19 | +19 | 20 | def __bool__(self): | ^^^^^^^^ ANN204 21 | ... @@ -141,7 +141,7 @@ simple_magic_methods.py:20:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:23:9: ANN204 [*] Missing return type annotation for special method `__bytes__` | 21 | ... -22 | +22 | 23 | def __bytes__(self): | ^^^^^^^^^ ANN204 24 | ... @@ -161,7 +161,7 @@ simple_magic_methods.py:23:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:26:9: ANN204 [*] Missing return type annotation for special method `__format__` | 24 | ... -25 | +25 | 26 | def __format__(self, format_spec): | ^^^^^^^^^^ ANN204 27 | ... @@ -181,7 +181,7 @@ simple_magic_methods.py:26:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:29:9: ANN204 [*] Missing return type annotation for special method `__contains__` | 27 | ... -28 | +28 | 29 | def __contains__(self, item): | ^^^^^^^^^^^^ ANN204 30 | ... @@ -201,7 +201,7 @@ simple_magic_methods.py:29:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:32:9: ANN204 [*] Missing return type annotation for special method `__complex__` | 30 | ... -31 | +31 | 32 | def __complex__(self): | ^^^^^^^^^^^ ANN204 33 | ... @@ -221,7 +221,7 @@ simple_magic_methods.py:32:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:35:9: ANN204 [*] Missing return type annotation for special method `__int__` | 33 | ... -34 | +34 | 35 | def __int__(self): | ^^^^^^^ ANN204 36 | ... @@ -241,7 +241,7 @@ simple_magic_methods.py:35:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:38:9: ANN204 [*] Missing return type annotation for special method `__float__` | 36 | ... -37 | +37 | 38 | def __float__(self): | ^^^^^^^^^ ANN204 39 | ... @@ -261,7 +261,7 @@ simple_magic_methods.py:38:9: ANN204 [*] Missing return type annotation for spec simple_magic_methods.py:41:9: ANN204 [*] Missing return type annotation for special method `__index__` | 39 | ... -40 | +40 | 41 | def __index__(self): | ^^^^^^^^^ ANN204 42 | ... @@ -275,5 +275,3 @@ simple_magic_methods.py:41:9: ANN204 [*] Missing return type annotation for spec 41 |- def __index__(self): 41 |+ def __index__(self) -> int: 42 42 | ... - - diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_dummy_args.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_dummy_args.snap index 1cda90bb2d76c..84015aa9bc866 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_dummy_args.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_dummy_args.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_none_returning.snap b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_none_returning.snap index 07d875aa50649..f4f793dbda202 100644 --- a/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_none_returning.snap +++ b/crates/ruff_linter/src/rules/flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__suppress_none_returning.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_annotations/mod.rs +snapshot_kind: text --- suppress_none_returning.py:45:5: ANN201 [*] Missing return type annotation for public function `foo` | @@ -47,5 +48,3 @@ suppress_none_returning.py:59:9: ANN001 Missing type annotation for function arg | ^ ANN001 60 | a = 2 + 2 | - - diff --git a/crates/ruff_linter/src/rules/flake8_async/helpers.rs b/crates/ruff_linter/src/rules/flake8_async/helpers.rs index 65cd7bff273ad..4faf95c40c829 100644 --- a/crates/ruff_linter/src/rules/flake8_async/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_async/helpers.rs @@ -24,8 +24,8 @@ impl AsyncModule { impl std::fmt::Display for AsyncModule { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { - AsyncModule::AnyIo => write!(f, "asyncio"), - AsyncModule::AsyncIo => write!(f, "anyio"), + AsyncModule::AnyIo => write!(f, "anyio"), + AsyncModule::AsyncIo => write!(f, "asyncio"), AsyncModule::Trio => write!(f, "trio"), } } diff --git a/crates/ruff_linter/src/rules/flake8_async/mod.rs b/crates/ruff_linter/src/rules/flake8_async/mod.rs index 19b6551a88a6d..4d9085db047ed 100644 --- a/crates/ruff_linter/src/rules/flake8_async/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_async/mod.rs @@ -11,9 +11,9 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::settings::LinterSettings; use crate::test::test_path; + use ruff_python_ast::PythonVersion; #[test_case(Rule::CancelScopeNoCheckpoint, Path::new("ASYNC100.py"))] #[test_case(Rule::TrioSyncCall, Path::new("ASYNC105.py"))] @@ -44,7 +44,7 @@ mod tests { let diagnostics = test_path( Path::new("flake8_async").join(path), &LinterSettings { - target_version: PythonVersion::Py310, + unresolved_target_version: PythonVersion::PY310.into(), ..LinterSettings::for_rule(Rule::AsyncFunctionWithTimeout) }, )?; diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/async_busy_wait.rs b/crates/ruff_linter/src/rules/flake8_async/rules/async_busy_wait.rs index 9ee406c75b826..60ab11c874bec 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/async_busy_wait.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/async_busy_wait.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::Ranged; @@ -35,10 +35,10 @@ use crate::rules::flake8_async::helpers::AsyncModule; /// /// ## References /// - [`asyncio` events](https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event) -/// - [`anyio` events](https://trio.readthedocs.io/en/latest/reference-core.html#trio.Event) -/// - [`trio` events](https://anyio.readthedocs.io/en/latest/api.html#anyio.Event) -#[violation] -pub struct AsyncBusyWait { +/// - [`anyio` events](https://anyio.readthedocs.io/en/latest/api.html#anyio.Event) +/// - [`trio` events](https://trio.readthedocs.io/en/latest/reference-core.html#trio.Event) +#[derive(ViolationMetadata)] +pub(crate) struct AsyncBusyWait { module: AsyncModule, } @@ -51,7 +51,7 @@ impl Violation for AsyncBusyWait { } /// ASYNC110 -pub(crate) fn async_busy_wait(checker: &mut Checker, while_stmt: &ast::StmtWhile) { +pub(crate) fn async_busy_wait(checker: &Checker, while_stmt: &ast::StmtWhile) { // The body should be a single `await` call. let [stmt] = while_stmt.body.as_slice() else { return; @@ -74,7 +74,7 @@ pub(crate) fn async_busy_wait(checker: &mut Checker, while_stmt: &ast::StmtWhile qualified_name.segments(), ["trio" | "anyio", "sleep" | "sleep_until"] | ["asyncio", "sleep"] ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AsyncBusyWait { module: AsyncModule::try_from(&qualified_name).unwrap(), }, diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs b/crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs index 943cc26288d6c..009aa42c77cb1 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs @@ -1,13 +1,14 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::rules::flake8_async::helpers::AsyncModule; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; +#[expect(clippy::doc_link_with_quotes)] /// ## What it does /// Checks for `async` function definitions with `timeout` parameters. /// @@ -63,15 +64,15 @@ use crate::settings::types::PythonVersion; /// - [`trio` timeouts](https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts) /// /// ["structured concurrency"]: https://vorpus.org/blog/some-thoughts-on-asynchronous-api-design-in-a-post-asyncawait-world/#timeouts-and-cancellation -#[violation] -pub struct AsyncFunctionWithTimeout { +#[derive(ViolationMetadata)] +pub(crate) struct AsyncFunctionWithTimeout { module: AsyncModule, } impl Violation for AsyncFunctionWithTimeout { #[derive_message_formats] fn message(&self) -> String { - format!("Async function definition with a `timeout` parameter") + "Async function definition with a `timeout` parameter".to_string() } fn fix_title(&self) -> Option<String> { @@ -86,10 +87,7 @@ impl Violation for AsyncFunctionWithTimeout { } /// ASYNC109 -pub(crate) fn async_function_with_timeout( - checker: &mut Checker, - function_def: &ast::StmtFunctionDef, -) { +pub(crate) fn async_function_with_timeout(checker: &Checker, function_def: &ast::StmtFunctionDef) { // Detect `async` calls with a `timeout` argument. if !function_def.is_async { return; @@ -110,11 +108,11 @@ pub(crate) fn async_function_with_timeout( }; // asyncio.timeout feature was first introduced in Python 3.11 - if module == AsyncModule::AsyncIo && checker.settings.target_version < PythonVersion::Py311 { + if module == AsyncModule::AsyncIo && checker.target_version() < PythonVersion::PY311 { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AsyncFunctionWithTimeout { module }, timeout.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/async_zero_sleep.rs b/crates/ruff_linter/src/rules/flake8_async/rules/async_zero_sleep.rs index 3b09122e52e30..fa2ad2d3e0573 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/async_zero_sleep.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/async_zero_sleep.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprCall, Int, Number}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -32,8 +32,8 @@ use crate::rules::flake8_async::helpers::AsyncModule; /// async def func(): /// await trio.lowlevel.checkpoint() /// ``` -#[violation] -pub struct AsyncZeroSleep { +#[derive(ViolationMetadata)] +pub(crate) struct AsyncZeroSleep { module: AsyncModule, } @@ -51,7 +51,7 @@ impl AlwaysFixableViolation for AsyncZeroSleep { } /// ASYNC115 -pub(crate) fn async_zero_sleep(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn async_zero_sleep(checker: &Checker, call: &ExprCall) { if !(checker.semantic().seen_module(Modules::TRIO) || checker.semantic().seen_module(Modules::ANYIO)) { @@ -62,7 +62,7 @@ pub(crate) fn async_zero_sleep(checker: &mut Checker, call: &ExprCall) { return; } - let Some(arg) = call.arguments.find_argument("seconds", 0) else { + let Some(arg) = call.arguments.find_argument_value("seconds", 0) else { return; }; @@ -103,6 +103,6 @@ pub(crate) fn async_zero_sleep(checker: &mut Checker, call: &ExprCall) { let arg_edit = Edit::range_replacement("()".to_string(), call.arguments.range()); Ok(Fix::safe_edits(import_edit, [reference_edit, arg_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_http_call.rs b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_http_call.rs index dc80120217ac8..747913352c01a 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_http_call.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_http_call.rs @@ -1,7 +1,7 @@ use ruff_python_ast::ExprCall; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_text_size::Ranged; @@ -31,13 +31,13 @@ use crate::checkers::ast::Checker; /// async with session.get("https://example.com/foo/bar") as resp: /// ... /// ``` -#[violation] -pub struct BlockingHttpCallInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct BlockingHttpCallInAsyncFunction; impl Violation for BlockingHttpCallInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not call blocking HTTP methods") + "Async functions should not call blocking HTTP methods".to_string() } } @@ -62,7 +62,7 @@ fn is_blocking_http_call(qualified_name: &QualifiedName) -> bool { } /// ASYNC210 -pub(crate) fn blocking_http_call(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn blocking_http_call(checker: &Checker, call: &ExprCall) { if checker.semantic().in_async_context() { if checker .semantic() @@ -70,7 +70,7 @@ pub(crate) fn blocking_http_call(checker: &mut Checker, call: &ExprCall) { .as_ref() .is_some_and(is_blocking_http_call) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BlockingHttpCallInAsyncFunction, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_open_call.rs b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_open_call.rs index bfdbbae47320e..621f87cec5125 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_open_call.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_open_call.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{analyze, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -33,18 +33,18 @@ use crate::checkers::ast::Checker; /// async with await anyio.open_file("bar.txt") as f: /// contents = await f.read() /// ``` -#[violation] -pub struct BlockingOpenCallInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct BlockingOpenCallInAsyncFunction; impl Violation for BlockingOpenCallInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not open files with blocking methods like `open`") + "Async functions should not open files with blocking methods like `open`".to_string() } } /// ASYNC230 -pub(crate) fn blocking_open_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn blocking_open_call(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().in_async_context() { return; } @@ -52,7 +52,7 @@ pub(crate) fn blocking_open_call(checker: &mut Checker, call: &ast::ExprCall) { if is_open_call(&call.func, checker.semantic()) || is_open_call_from_pathlib(call.func.as_ref(), checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BlockingOpenCallInAsyncFunction, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_process_invocation.rs b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_process_invocation.rs index bec9bf816c419..e9d6cb7ff2439 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_process_invocation.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_process_invocation.rs @@ -1,8 +1,8 @@ -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::analyze::typing::find_assigned_value; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing::find_assigned_value; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -17,7 +17,8 @@ use crate::registry::AsRule; /// call to complete, negating the benefits of asynchronous programming. /// /// Instead of making a blocking call, use an equivalent asynchronous library -/// or function. +/// or function, like [`trio.run_process()`](https://trio.readthedocs.io/en/stable/reference-io.html#trio.run_process) +/// or [`anyio.run_process()`](https://anyio.readthedocs.io/en/latest/api.html#anyio.run_process). /// /// ## Example /// ```python @@ -30,13 +31,13 @@ use crate::registry::AsRule; /// async def foo(): /// asyncio.create_subprocess_shell(cmd) /// ``` -#[violation] -pub struct CreateSubprocessInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct CreateSubprocessInAsyncFunction; impl Violation for CreateSubprocessInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not create subprocesses with blocking methods") + "Async functions should not create subprocesses with blocking methods".to_string() } } @@ -49,7 +50,8 @@ impl Violation for CreateSubprocessInAsyncFunction { /// call to complete, negating the benefits of asynchronous programming. /// /// Instead of making a blocking call, use an equivalent asynchronous library -/// or function. +/// or function, like [`trio.run_process()`](https://trio.readthedocs.io/en/stable/reference-io.html#trio.run_process) +/// or [`anyio.run_process()`](https://anyio.readthedocs.io/en/latest/api.html#anyio.run_process). /// /// ## Example /// ```python @@ -62,13 +64,13 @@ impl Violation for CreateSubprocessInAsyncFunction { /// async def foo(): /// asyncio.create_subprocess_shell(cmd) /// ``` -#[violation] -pub struct RunProcessInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct RunProcessInAsyncFunction; impl Violation for RunProcessInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not run processes with blocking methods") + "Async functions should not run processes with blocking methods".to_string() } } @@ -81,7 +83,8 @@ impl Violation for RunProcessInAsyncFunction { /// call to complete, negating the benefits of asynchronous programming. /// /// Instead of making a blocking call, use an equivalent asynchronous library -/// or function. +/// or function, like [`trio.to_thread.run_sync()`](https://trio.readthedocs.io/en/latest/reference-core.html#trio.to_thread.run_sync) +/// or [`anyio.to_thread.run_sync()`](https://anyio.readthedocs.io/en/latest/api.html#anyio.to_thread.run_sync). /// /// ## Example /// ```python @@ -98,57 +101,63 @@ impl Violation for RunProcessInAsyncFunction { /// async def foo(): /// await asyncio.loop.run_in_executor(None, wait_for_process) /// ``` -#[violation] -pub struct WaitForProcessInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct WaitForProcessInAsyncFunction; impl Violation for WaitForProcessInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not wait on processes with blocking methods") + "Async functions should not wait on processes with blocking methods".to_string() } } /// ASYNC220, ASYNC221, ASYNC222 -pub(crate) fn blocking_process_invocation(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn blocking_process_invocation(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().in_async_context() { return; } - let Some(diagnostic_kind) = - checker - .semantic() - .resolve_qualified_name(call.func.as_ref()) - .and_then(|qualified_name| match qualified_name.segments() { - ["subprocess", "Popen"] | ["os", "popen"] => { - Some(CreateSubprocessInAsyncFunction.into()) - } - ["os", "system" | "posix_spawn" | "posix_spawnp"] - | ["subprocess", "run" | "call" | "check_call" | "check_output" | "getoutput" - | "getstatusoutput"] => Some(RunProcessInAsyncFunction.into()), - ["os", "wait" | "wait3" | "wait4" | "waitid" | "waitpid"] => { - Some(WaitForProcessInAsyncFunction.into()) - } - ["os", "spawnl" | "spawnle" | "spawnlp" | "spawnlpe" | "spawnv" | "spawnve" - | "spawnvp" | "spawnvpe"] => { - if is_p_wait(call, checker.semantic()) { - Some(RunProcessInAsyncFunction.into()) - } else { - Some(CreateSubprocessInAsyncFunction.into()) - } - } - _ => None, - }) + let Some(qualified_name) = checker + .semantic() + .resolve_qualified_name(call.func.as_ref()) else { return; }; - let diagnostic = Diagnostic::new::<DiagnosticKind>(diagnostic_kind, call.func.range()); - if checker.enabled(diagnostic.kind.rule()) { - checker.diagnostics.push(diagnostic); + + let range = call.func.range(); + let diagnostic = match qualified_name.segments() { + ["subprocess", "Popen"] | ["os", "popen"] => { + Diagnostic::new(CreateSubprocessInAsyncFunction, range) + } + ["os", "system" | "posix_spawn" | "posix_spawnp"] + | [ + "subprocess", + "run" | "call" | "check_call" | "check_output" | "getoutput" | "getstatusoutput", + ] => Diagnostic::new(RunProcessInAsyncFunction, range), + ["os", "wait" | "wait3" | "wait4" | "waitid" | "waitpid"] => { + Diagnostic::new(WaitForProcessInAsyncFunction, range) + } + [ + "os", + "spawnl" | "spawnle" | "spawnlp" | "spawnlpe" | "spawnv" | "spawnve" | "spawnvp" + | "spawnvpe", + ] => { + if is_p_wait(call, checker.semantic()) { + Diagnostic::new(RunProcessInAsyncFunction, range) + } else { + Diagnostic::new(CreateSubprocessInAsyncFunction, range) + } + } + _ => return, + }; + + if checker.enabled(diagnostic.rule()) { + checker.report_diagnostic(diagnostic); } } fn is_p_wait(call: &ast::ExprCall, semantic: &SemanticModel) -> bool { - let Some(arg) = call.arguments.find_argument("mode", 0) else { + let Some(arg) = call.arguments.find_argument_value("mode", 0) else { return true; }; diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_sleep.rs b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_sleep.rs index e1a118ee213a1..c625318796a9b 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/blocking_sleep.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/blocking_sleep.rs @@ -1,7 +1,7 @@ use ruff_python_ast::ExprCall; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_text_size::Ranged; @@ -28,13 +28,13 @@ use crate::checkers::ast::Checker; /// async def fetch(): /// await asyncio.sleep(1) /// ``` -#[violation] -pub struct BlockingSleepInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct BlockingSleepInAsyncFunction; impl Violation for BlockingSleepInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Async functions should not call `time.sleep`") + "Async functions should not call `time.sleep`".to_string() } } @@ -43,7 +43,7 @@ fn is_blocking_sleep(qualified_name: &QualifiedName) -> bool { } /// ASYNC251 -pub(crate) fn blocking_sleep(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn blocking_sleep(checker: &Checker, call: &ExprCall) { if checker.semantic().in_async_context() { if checker .semantic() @@ -51,7 +51,7 @@ pub(crate) fn blocking_sleep(checker: &mut Checker, call: &ExprCall) { .as_ref() .is_some_and(is_blocking_sleep) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BlockingSleepInAsyncFunction, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/cancel_scope_no_checkpoint.rs b/crates/ruff_linter/src/rules/flake8_async/rules/cancel_scope_no_checkpoint.rs index 408aefca50bc3..9ebf0ae2e2994 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/cancel_scope_no_checkpoint.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/cancel_scope_no_checkpoint.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers::{any_over_body, AwaitVisitor}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::{AwaitVisitor, any_over_body}; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{Expr, StmtWith, WithItem}; @@ -38,8 +38,8 @@ use crate::rules::flake8_async::helpers::MethodName; /// - [`asyncio` timeouts](https://docs.python.org/3/library/asyncio-task.html#timeouts) /// - [`anyio` timeouts](https://anyio.readthedocs.io/en/stable/cancellation.html) /// - [`trio` timeouts](https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts) -#[violation] -pub struct CancelScopeNoCheckpoint { +#[derive(ViolationMetadata)] +pub(crate) struct CancelScopeNoCheckpoint { method_name: MethodName, } @@ -47,13 +47,15 @@ impl Violation for CancelScopeNoCheckpoint { #[derive_message_formats] fn message(&self) -> String { let Self { method_name } = self; - format!("A `with {method_name}(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint.") + format!( + "A `with {method_name}(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint." + ) } } /// ASYNC100 pub(crate) fn cancel_scope_no_checkpoint( - checker: &mut Checker, + checker: &Checker, with_stmt: &StmtWith, with_items: &[WithItem], ) { @@ -72,7 +74,7 @@ pub(crate) fn cancel_scope_no_checkpoint( None } }) - .last() + .next_back() else { return; }; @@ -98,7 +100,7 @@ pub(crate) fn cancel_scope_no_checkpoint( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CancelScopeNoCheckpoint { method_name }, with_stmt.range, )); diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/long_sleep_not_forever.rs b/crates/ruff_linter/src/rules/flake8_async/rules/long_sleep_not_forever.rs index 4ab4460113adc..2d51087f2f84b 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/long_sleep_not_forever.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/long_sleep_not_forever.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprCall, ExprNumberLiteral, Number}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -34,8 +34,12 @@ use crate::rules::flake8_async::helpers::AsyncModule; /// async def func(): /// await trio.sleep_forever() /// ``` -#[violation] -pub struct LongSleepNotForever { +/// +/// ## Fix safety +/// +/// This fix is marked as unsafe as it changes program behavior. +#[derive(ViolationMetadata)] +pub(crate) struct LongSleepNotForever { module: AsyncModule, } @@ -56,7 +60,7 @@ impl Violation for LongSleepNotForever { } /// ASYNC116 -pub(crate) fn long_sleep_not_forever(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn long_sleep_not_forever(checker: &Checker, call: &ExprCall) { if !(checker.semantic().seen_module(Modules::TRIO) || checker.semantic().seen_module(Modules::ANYIO)) { @@ -67,7 +71,7 @@ pub(crate) fn long_sleep_not_forever(checker: &mut Checker, call: &ExprCall) { return; } - let Some(arg) = call.arguments.find_argument("seconds", 0) else { + let Some(arg) = call.arguments.find_argument_value("seconds", 0) else { return; }; @@ -88,7 +92,7 @@ pub(crate) fn long_sleep_not_forever(checker: &mut Checker, call: &ExprCall) { } Number::Float(float_value) => { - #[allow(clippy::cast_precision_loss)] + #[expect(clippy::cast_precision_loss)] if *float_value <= one_day_in_secs as f64 { return; } @@ -127,5 +131,5 @@ pub(crate) fn long_sleep_not_forever(checker: &mut Checker, call: &ExprCall) { let arg_edit = Edit::range_replacement("()".to_string(), call.arguments.range()); Ok(Fix::unsafe_edits(import_edit, [reference_edit, arg_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_async/rules/sync_call.rs b/crates/ruff_linter/src/rules/flake8_async/rules/sync_call.rs index cccf7fc20bd91..fc93b806bcf96 100644 --- a/crates/ruff_linter/src/rules/flake8_async/rules/sync_call.rs +++ b/crates/ruff_linter/src/rules/flake8_async/rules/sync_call.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprCall}; use ruff_python_semantic::Modules; use ruff_text_size::{Ranged, TextRange}; @@ -31,8 +31,8 @@ use crate::rules::flake8_async::helpers::MethodName; /// ## Fix safety /// This rule's fix is marked as unsafe, as adding an `await` to a function /// call changes its semantics and runtime behavior. -#[violation] -pub struct TrioSyncCall { +#[derive(ViolationMetadata)] +pub(crate) struct TrioSyncCall { method_name: MethodName, } @@ -46,12 +46,12 @@ impl Violation for TrioSyncCall { } fn fix_title(&self) -> Option<String> { - Some(format!("Add `await`")) + Some("Add `await`".to_string()) } } /// ASYNC105 -pub(crate) fn sync_call(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn sync_call(checker: &Checker, call: &ExprCall) { if !checker.semantic().seen_module(Modules::TRIO) { return; } @@ -78,7 +78,7 @@ pub(crate) fn sync_call(checker: &mut Checker, call: &ExprCall) { .is_some_and(Expr::is_await_expr) { return; - }; + } let mut diagnostic = Diagnostic::new(TrioSyncCall { method_name }, call.range); if checker.semantic().in_async_context() { @@ -91,5 +91,5 @@ pub(crate) fn sync_call(checker: &mut Checker, call: &ExprCall) { call.func.start(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC100_ASYNC100.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC100_ASYNC100.py.snap index 5d92713d307be..2d3adc5b36ce9 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC100_ASYNC100.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC100_ASYNC100.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_async/mod.rs ASYNC100.py:8:5: ASYNC100 A `with trio.fail_after(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 7 | async def func(): -8 | with trio.fail_after(): - | _____^ +8 | / with trio.fail_after(): 9 | | ... | |___________^ ASYNC100 | @@ -13,8 +12,7 @@ ASYNC100.py:8:5: ASYNC100 A `with trio.fail_after(...):` context does not contai ASYNC100.py:18:5: ASYNC100 A `with trio.move_on_after(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 17 | async def func(): -18 | with trio.move_on_after(): - | _____^ +18 | / with trio.move_on_after(): 19 | | ... | |___________^ ASYNC100 | @@ -22,8 +20,7 @@ ASYNC100.py:18:5: ASYNC100 A `with trio.move_on_after(...):` context does not co ASYNC100.py:45:5: ASYNC100 A `with anyio.move_on_after(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 44 | async def func(): -45 | with anyio.move_on_after(delay=0.2): - | _____^ +45 | / with anyio.move_on_after(delay=0.2): 46 | | ... | |___________^ ASYNC100 | @@ -31,8 +28,7 @@ ASYNC100.py:45:5: ASYNC100 A `with anyio.move_on_after(...):` context does not c ASYNC100.py:50:5: ASYNC100 A `with anyio.fail_after(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 49 | async def func(): -50 | with anyio.fail_after(): - | _____^ +50 | / with anyio.fail_after(): 51 | | ... | |___________^ ASYNC100 | @@ -40,8 +36,7 @@ ASYNC100.py:50:5: ASYNC100 A `with anyio.fail_after(...):` context does not cont ASYNC100.py:55:5: ASYNC100 A `with anyio.CancelScope(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 54 | async def func(): -55 | with anyio.CancelScope(): - | _____^ +55 | / with anyio.CancelScope(): 56 | | ... | |___________^ ASYNC100 | @@ -49,8 +44,7 @@ ASYNC100.py:55:5: ASYNC100 A `with anyio.CancelScope(...):` context does not con ASYNC100.py:60:5: ASYNC100 A `with anyio.CancelScope(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 59 | async def func(): -60 | with anyio.CancelScope(), nullcontext(): - | _____^ +60 | / with anyio.CancelScope(), nullcontext(): 61 | | ... | |___________^ ASYNC100 | @@ -58,8 +52,7 @@ ASYNC100.py:60:5: ASYNC100 A `with anyio.CancelScope(...):` context does not con ASYNC100.py:65:5: ASYNC100 A `with anyio.CancelScope(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 64 | async def func(): -65 | with nullcontext(), anyio.CancelScope(): - | _____^ +65 | / with nullcontext(), anyio.CancelScope(): 66 | | ... | |___________^ ASYNC100 | @@ -67,8 +60,7 @@ ASYNC100.py:65:5: ASYNC100 A `with anyio.CancelScope(...):` context does not con ASYNC100.py:70:5: ASYNC100 A `with asyncio.timeout(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 69 | async def func(): -70 | async with asyncio.timeout(delay=0.2): - | _____^ +70 | / async with asyncio.timeout(delay=0.2): 71 | | ... | |___________^ ASYNC100 | @@ -76,8 +68,7 @@ ASYNC100.py:70:5: ASYNC100 A `with asyncio.timeout(...):` context does not conta ASYNC100.py:75:5: ASYNC100 A `with asyncio.timeout_at(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 74 | async def func(): -75 | async with asyncio.timeout_at(when=0.2): - | _____^ +75 | / async with asyncio.timeout_at(when=0.2): 76 | | ... | |___________^ ASYNC100 | @@ -85,8 +76,7 @@ ASYNC100.py:75:5: ASYNC100 A `with asyncio.timeout_at(...):` context does not co ASYNC100.py:85:5: ASYNC100 A `with asyncio.timeout(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 84 | async def func(): -85 | async with asyncio.timeout(delay=0.2), asyncio.TaskGroup(), asyncio.timeout(delay=0.2): - | _____^ +85 | / async with asyncio.timeout(delay=0.2), asyncio.TaskGroup(), asyncio.timeout(delay=0.2): 86 | | ... | |___________^ ASYNC100 | @@ -94,8 +84,7 @@ ASYNC100.py:85:5: ASYNC100 A `with asyncio.timeout(...):` context does not conta ASYNC100.py:95:5: ASYNC100 A `with asyncio.timeout(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint. | 94 | async def func(): -95 | async with asyncio.timeout(delay=0.2), asyncio.timeout(delay=0.2): - | _____^ +95 | / async with asyncio.timeout(delay=0.2), asyncio.timeout(delay=0.2): 96 | | ... | |___________^ ASYNC100 | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC105_ASYNC105.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC105_ASYNC105.py.snap index 1595cdc008549..13b59fdeccabd 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC105_ASYNC105.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC105_ASYNC105.py.snap @@ -467,7 +467,7 @@ ASYNC105.py:53:5: ASYNC105 [*] Call to `trio.lowlevel.wait_writable` is not imme 52 | trio.lowlevel.wait_task_rescheduled(foo) 53 | trio.lowlevel.wait_writable(foo) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ASYNC105 -54 | +54 | 55 | async with await trio.open_file(foo): # Ok | = help: Add `await` @@ -485,7 +485,7 @@ ASYNC105.py:53:5: ASYNC105 [*] Call to `trio.lowlevel.wait_writable` is not imme ASYNC105.py:58:16: ASYNC105 [*] Call to `trio.open_file` is not immediately awaited | 56 | pass -57 | +57 | 58 | async with trio.open_file(foo): # ASYNC105 | ^^^^^^^^^^^^^^^^^^^ ASYNC105 59 | pass diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_0.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_0.py.snap index 1a624f6dc47f6..af1607c156e76 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_0.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_async/mod.rs +snapshot_kind: text --- ASYNC109_0.py:8:16: ASYNC109 Async function definition with a `timeout` parameter | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_1.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_1.py.snap index 78704f6637673..e205d4e18bcfa 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_async/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_0.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_0.py.snap index 1a624f6dc47f6..af1607c156e76 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_0.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_async/mod.rs +snapshot_kind: text --- ASYNC109_0.py:8:16: ASYNC109 Async function definition with a `timeout` parameter | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_1.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_1.py.snap index 5f24e498454fb..6936d2e8112c5 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC109_ASYNC109_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_async/mod.rs +snapshot_kind: text --- ASYNC109_1.py:5:16: ASYNC109 Async function definition with a `timeout` parameter | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC110_ASYNC110.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC110_ASYNC110.py.snap index c878faddf086a..13439f55826c2 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC110_ASYNC110.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC110_ASYNC110.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_async/mod.rs ASYNC110.py:7:5: ASYNC110 Use `trio.Event` instead of awaiting `trio.sleep` in a `while` loop | 6 | async def func(): -7 | while True: - | _____^ +7 | / while True: 8 | | await trio.sleep(10) | |____________________________^ ASYNC110 | @@ -13,35 +12,31 @@ ASYNC110.py:7:5: ASYNC110 Use `trio.Event` instead of awaiting `trio.sleep` in a ASYNC110.py:12:5: ASYNC110 Use `trio.Event` instead of awaiting `trio.sleep` in a `while` loop | 11 | async def func(): -12 | while True: - | _____^ +12 | / while True: 13 | | await trio.sleep_until(10) | |__________________________________^ ASYNC110 | -ASYNC110.py:22:5: ASYNC110 Use `asyncio.Event` instead of awaiting `asyncio.sleep` in a `while` loop +ASYNC110.py:22:5: ASYNC110 Use `anyio.Event` instead of awaiting `anyio.sleep` in a `while` loop | 21 | async def func(): -22 | while True: - | _____^ +22 | / while True: 23 | | await anyio.sleep(10) | |_____________________________^ ASYNC110 | -ASYNC110.py:27:5: ASYNC110 Use `asyncio.Event` instead of awaiting `asyncio.sleep` in a `while` loop +ASYNC110.py:27:5: ASYNC110 Use `anyio.Event` instead of awaiting `anyio.sleep` in a `while` loop | 26 | async def func(): -27 | while True: - | _____^ +27 | / while True: 28 | | await anyio.sleep_until(10) | |___________________________________^ ASYNC110 | -ASYNC110.py:37:5: ASYNC110 Use `anyio.Event` instead of awaiting `anyio.sleep` in a `while` loop +ASYNC110.py:37:5: ASYNC110 Use `asyncio.Event` instead of awaiting `asyncio.sleep` in a `while` loop | 36 | async def func(): -37 | while True: - | _____^ +37 | / while True: 38 | | await asyncio.sleep(10) | |_______________________________^ ASYNC110 | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC115_ASYNC115.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC115_ASYNC115.py.snap index 3e40da955dd3e..c2ec9f1dbe25b 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC115_ASYNC115.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC115_ASYNC115.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_async/mod.rs ASYNC115.py:5:11: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio.sleep(0)` | 3 | from trio import sleep -4 | +4 | 5 | await trio.sleep(0) # ASYNC115 | ^^^^^^^^^^^^^ ASYNC115 6 | await trio.sleep(1) # OK @@ -25,7 +25,7 @@ ASYNC115.py:5:11: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio ASYNC115.py:11:5: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio.sleep(0)` | 9 | await trio.sleep() # OK -10 | +10 | 11 | trio.sleep(0) # ASYNC115 | ^^^^^^^^^^^^^ ASYNC115 12 | foo = 0 @@ -46,10 +46,10 @@ ASYNC115.py:11:5: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio ASYNC115.py:17:5: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio.sleep(0)` | 15 | time.sleep(0) # OK -16 | +16 | 17 | sleep(0) # ASYNC115 | ^^^^^^^^ ASYNC115 -18 | +18 | 19 | bar = "bar" | = help: Replace with `trio.lowlevel.checkpoint()` @@ -67,7 +67,7 @@ ASYNC115.py:17:5: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio ASYNC115.py:48:14: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `trio.sleep(0)` | 46 | import trio -47 | +47 | 48 | trio.run(trio.sleep(0)) # ASYNC115 | ^^^^^^^^^^^^^ ASYNC115 | @@ -133,116 +133,84 @@ ASYNC115.py:59:11: ASYNC115 [*] Use `trio.lowlevel.checkpoint()` instead of `tri 61 61 | 62 62 | def func(): -ASYNC115.py:85:11: ASYNC115 [*] Use `asyncio.lowlevel.checkpoint()` instead of `asyncio.sleep(0)` +ASYNC115.py:85:11: ASYNC115 [*] Use `anyio.lowlevel.checkpoint()` instead of `anyio.sleep(0)` | 83 | from anyio import sleep -84 | +84 | 85 | await anyio.sleep(0) # ASYNC115 | ^^^^^^^^^^^^^^ ASYNC115 86 | await anyio.sleep(1) # OK 87 | await anyio.sleep(0, 1) # OK | - = help: Replace with `asyncio.lowlevel.checkpoint()` + = help: Replace with `anyio.lowlevel.checkpoint()` ℹ Safe fix -49 49 | -50 50 | -51 51 | from trio import Event, sleep - 52 |+from asyncio import lowlevel -52 53 | -53 54 | -54 55 | def func(): --------------------------------------------------------------------------------- -82 83 | import anyio -83 84 | from anyio import sleep -84 85 | +82 82 | import anyio +83 83 | from anyio import sleep +84 84 | 85 |- await anyio.sleep(0) # ASYNC115 - 86 |+ await lowlevel.checkpoint() # ASYNC115 -86 87 | await anyio.sleep(1) # OK -87 88 | await anyio.sleep(0, 1) # OK -88 89 | await anyio.sleep(...) # OK + 85 |+ await anyio.lowlevel.checkpoint() # ASYNC115 +86 86 | await anyio.sleep(1) # OK +87 87 | await anyio.sleep(0, 1) # OK +88 88 | await anyio.sleep(...) # OK -ASYNC115.py:91:5: ASYNC115 [*] Use `asyncio.lowlevel.checkpoint()` instead of `asyncio.sleep(0)` +ASYNC115.py:91:5: ASYNC115 [*] Use `anyio.lowlevel.checkpoint()` instead of `anyio.sleep(0)` | 89 | await anyio.sleep() # OK -90 | +90 | 91 | anyio.sleep(0) # ASYNC115 | ^^^^^^^^^^^^^^ ASYNC115 92 | foo = 0 93 | anyio.sleep(foo) # OK | - = help: Replace with `asyncio.lowlevel.checkpoint()` + = help: Replace with `anyio.lowlevel.checkpoint()` ℹ Safe fix -49 49 | -50 50 | -51 51 | from trio import Event, sleep - 52 |+from asyncio import lowlevel -52 53 | -53 54 | -54 55 | def func(): --------------------------------------------------------------------------------- -88 89 | await anyio.sleep(...) # OK -89 90 | await anyio.sleep() # OK -90 91 | +88 88 | await anyio.sleep(...) # OK +89 89 | await anyio.sleep() # OK +90 90 | 91 |- anyio.sleep(0) # ASYNC115 - 92 |+ lowlevel.checkpoint() # ASYNC115 -92 93 | foo = 0 -93 94 | anyio.sleep(foo) # OK -94 95 | anyio.sleep(1) # OK + 91 |+ anyio.lowlevel.checkpoint() # ASYNC115 +92 92 | foo = 0 +93 93 | anyio.sleep(foo) # OK +94 94 | anyio.sleep(1) # OK -ASYNC115.py:97:5: ASYNC115 [*] Use `asyncio.lowlevel.checkpoint()` instead of `asyncio.sleep(0)` +ASYNC115.py:97:5: ASYNC115 [*] Use `anyio.lowlevel.checkpoint()` instead of `anyio.sleep(0)` | 95 | time.sleep(0) # OK -96 | +96 | 97 | sleep(0) # ASYNC115 | ^^^^^^^^ ASYNC115 -98 | +98 | 99 | bar = "bar" | - = help: Replace with `asyncio.lowlevel.checkpoint()` + = help: Replace with `anyio.lowlevel.checkpoint()` ℹ Safe fix -49 49 | -50 50 | -51 51 | from trio import Event, sleep - 52 |+from asyncio import lowlevel -52 53 | -53 54 | -54 55 | def func(): --------------------------------------------------------------------------------- -94 95 | anyio.sleep(1) # OK -95 96 | time.sleep(0) # OK -96 97 | +94 94 | anyio.sleep(1) # OK +95 95 | time.sleep(0) # OK +96 96 | 97 |- sleep(0) # ASYNC115 - 98 |+ lowlevel.checkpoint() # ASYNC115 -98 99 | -99 100 | bar = "bar" -100 101 | anyio.sleep(bar) + 97 |+ anyio.lowlevel.checkpoint() # ASYNC115 +98 98 | +99 99 | bar = "bar" +100 100 | anyio.sleep(bar) -ASYNC115.py:128:15: ASYNC115 [*] Use `asyncio.lowlevel.checkpoint()` instead of `asyncio.sleep(0)` +ASYNC115.py:128:15: ASYNC115 [*] Use `anyio.lowlevel.checkpoint()` instead of `anyio.sleep(0)` | 126 | import anyio -127 | +127 | 128 | anyio.run(anyio.sleep(0)) # ASYNC115 | ^^^^^^^^^^^^^^ ASYNC115 | - = help: Replace with `asyncio.lowlevel.checkpoint()` + = help: Replace with `anyio.lowlevel.checkpoint()` ℹ Safe fix -49 49 | -50 50 | -51 51 | from trio import Event, sleep - 52 |+from asyncio import lowlevel -52 53 | -53 54 | -54 55 | def func(): --------------------------------------------------------------------------------- -125 126 | def func(): -126 127 | import anyio -127 128 | +125 125 | def func(): +126 126 | import anyio +127 127 | 128 |- anyio.run(anyio.sleep(0)) # ASYNC115 - 129 |+ anyio.run(lowlevel.checkpoint()) # ASYNC115 -129 130 | -130 131 | -131 132 | def func(): + 128 |+ anyio.run(anyio.lowlevel.checkpoint()) # ASYNC115 +129 129 | +130 130 | +131 131 | def func(): diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC116_ASYNC116.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC116_ASYNC116.py.snap index 3421bd0105a7d..6904caf629120 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC116_ASYNC116.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC116_ASYNC116.py.snap @@ -6,7 +6,7 @@ ASYNC116.py:11:11: ASYNC116 [*] `trio.sleep()` with >24 hour interval should usu 10 | # These examples are probably not meant to ever wake up: 11 | await trio.sleep(100000) # error: 116, "async" | ^^^^^^^^^^^^^^^^^^ ASYNC116 -12 | +12 | 13 | # 'inf literal' overflow trick | = help: Replace with `trio.sleep_forever()` @@ -26,7 +26,7 @@ ASYNC116.py:14:11: ASYNC116 [*] `trio.sleep()` with >24 hour interval should usu 13 | # 'inf literal' overflow trick 14 | await trio.sleep(1e999) # error: 116, "async" | ^^^^^^^^^^^^^^^^^ ASYNC116 -15 | +15 | 16 | await trio.sleep(86399) | = help: Replace with `trio.sleep_forever()` @@ -67,7 +67,7 @@ ASYNC116.py:19:11: ASYNC116 [*] `trio.sleep()` with >24 hour interval should usu 18 | await trio.sleep(86400.01) # error: 116, "async" 19 | await trio.sleep(86401) # error: 116, "async" | ^^^^^^^^^^^^^^^^^ ASYNC116 -20 | +20 | 21 | await trio.sleep(-1) # will raise a runtime error | = help: Replace with `trio.sleep_forever()` @@ -147,63 +147,47 @@ ASYNC116.py:57:11: ASYNC116 [*] `trio.sleep()` with >24 hour interval should usu 59 60 | 60 61 | async def import_anyio(): -ASYNC116.py:64:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:64:11: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 63 | # These examples are probably not meant to ever wake up: 64 | await anyio.sleep(100000) # error: 116, "async" | ^^^^^^^^^^^^^^^^^^^ ASYNC116 -65 | +65 | 66 | # 'inf literal' overflow trick | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -61 62 | import anyio -62 63 | -63 64 | # These examples are probably not meant to ever wake up: +61 61 | import anyio +62 62 | +63 63 | # These examples are probably not meant to ever wake up: 64 |- await anyio.sleep(100000) # error: 116, "async" - 65 |+ await sleep_forever() # error: 116, "async" -65 66 | -66 67 | # 'inf literal' overflow trick -67 68 | await anyio.sleep(1e999) # error: 116, "async" + 64 |+ await anyio.sleep_forever() # error: 116, "async" +65 65 | +66 66 | # 'inf literal' overflow trick +67 67 | await anyio.sleep(1e999) # error: 116, "async" -ASYNC116.py:67:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:67:11: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 66 | # 'inf literal' overflow trick 67 | await anyio.sleep(1e999) # error: 116, "async" | ^^^^^^^^^^^^^^^^^^ ASYNC116 -68 | +68 | 69 | await anyio.sleep(86399) | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -64 65 | await anyio.sleep(100000) # error: 116, "async" -65 66 | -66 67 | # 'inf literal' overflow trick +64 64 | await anyio.sleep(100000) # error: 116, "async" +65 65 | +66 66 | # 'inf literal' overflow trick 67 |- await anyio.sleep(1e999) # error: 116, "async" - 68 |+ await sleep_forever() # error: 116, "async" -68 69 | -69 70 | await anyio.sleep(86399) -70 71 | await anyio.sleep(86400) + 67 |+ await anyio.sleep_forever() # error: 116, "async" +68 68 | +69 69 | await anyio.sleep(86399) +70 70 | await anyio.sleep(86400) -ASYNC116.py:71:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:71:11: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 69 | await anyio.sleep(86399) 70 | await anyio.sleep(86400) @@ -211,56 +195,40 @@ ASYNC116.py:71:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should | ^^^^^^^^^^^^^^^^^^^^^ ASYNC116 72 | await anyio.sleep(86401) # error: 116, "async" | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -68 69 | -69 70 | await anyio.sleep(86399) -70 71 | await anyio.sleep(86400) +68 68 | +69 69 | await anyio.sleep(86399) +70 70 | await anyio.sleep(86400) 71 |- await anyio.sleep(86400.01) # error: 116, "async" - 72 |+ await sleep_forever() # error: 116, "async" -72 73 | await anyio.sleep(86401) # error: 116, "async" -73 74 | -74 75 | await anyio.sleep(-1) # will raise a runtime error + 71 |+ await anyio.sleep_forever() # error: 116, "async" +72 72 | await anyio.sleep(86401) # error: 116, "async" +73 73 | +74 74 | await anyio.sleep(-1) # will raise a runtime error -ASYNC116.py:72:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:72:11: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 70 | await anyio.sleep(86400) 71 | await anyio.sleep(86400.01) # error: 116, "async" 72 | await anyio.sleep(86401) # error: 116, "async" | ^^^^^^^^^^^^^^^^^^ ASYNC116 -73 | +73 | 74 | await anyio.sleep(-1) # will raise a runtime error | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -69 70 | await anyio.sleep(86399) -70 71 | await anyio.sleep(86400) -71 72 | await anyio.sleep(86400.01) # error: 116, "async" +69 69 | await anyio.sleep(86399) +70 70 | await anyio.sleep(86400) +71 71 | await anyio.sleep(86400.01) # error: 116, "async" 72 |- await anyio.sleep(86401) # error: 116, "async" - 73 |+ await sleep_forever() # error: 116, "async" -73 74 | -74 75 | await anyio.sleep(-1) # will raise a runtime error -75 76 | await anyio.sleep(0) # handled by different check + 72 |+ await anyio.sleep_forever() # error: 116, "async" +73 73 | +74 74 | await anyio.sleep(-1) # will raise a runtime error +75 75 | await anyio.sleep(0) # handled by different check -ASYNC116.py:101:5: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:101:5: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 100 | # does not require the call to be awaited, nor in an async fun 101 | anyio.sleep(86401) # error: 116, "async" @@ -268,66 +236,50 @@ ASYNC116.py:101:5: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should 102 | # also checks that we don't break visit_Call 103 | anyio.run(anyio.sleep(86401)) # error: 116, "async" | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -98 99 | import anyio -99 100 | -100 101 | # does not require the call to be awaited, nor in an async fun +98 98 | import anyio +99 99 | +100 100 | # does not require the call to be awaited, nor in an async fun 101 |- anyio.sleep(86401) # error: 116, "async" - 102 |+ sleep_forever() # error: 116, "async" -102 103 | # also checks that we don't break visit_Call -103 104 | anyio.run(anyio.sleep(86401)) # error: 116, "async" -104 105 | + 101 |+ anyio.sleep_forever() # error: 116, "async" +102 102 | # also checks that we don't break visit_Call +103 103 | anyio.run(anyio.sleep(86401)) # error: 116, "async" +104 104 | -ASYNC116.py:103:15: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:103:15: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 101 | anyio.sleep(86401) # error: 116, "async" 102 | # also checks that we don't break visit_Call 103 | anyio.run(anyio.sleep(86401)) # error: 116, "async" | ^^^^^^^^^^^^^^^^^^ ASYNC116 | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix -2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. -3 3 | import math -4 4 | from math import inf - 5 |+from asyncio import sleep_forever -5 6 | -6 7 | -7 8 | async def import_trio(): --------------------------------------------------------------------------------- -100 101 | # does not require the call to be awaited, nor in an async fun -101 102 | anyio.sleep(86401) # error: 116, "async" -102 103 | # also checks that we don't break visit_Call +100 100 | # does not require the call to be awaited, nor in an async fun +101 101 | anyio.sleep(86401) # error: 116, "async" +102 102 | # also checks that we don't break visit_Call 103 |- anyio.run(anyio.sleep(86401)) # error: 116, "async" - 104 |+ anyio.run(sleep_forever()) # error: 116, "async" -104 105 | -105 106 | -106 107 | async def import_from_anyio(): + 103 |+ anyio.run(anyio.sleep_forever()) # error: 116, "async" +104 104 | +105 105 | +106 106 | async def import_from_anyio(): -ASYNC116.py:110:11: ASYNC116 [*] `asyncio.sleep()` with >24 hour interval should usually be `asyncio.sleep_forever()` +ASYNC116.py:110:11: ASYNC116 [*] `anyio.sleep()` with >24 hour interval should usually be `anyio.sleep_forever()` | 109 | # catch from import 110 | await sleep(86401) # error: 116, "async" | ^^^^^^^^^^^^ ASYNC116 | - = help: Replace with `asyncio.sleep_forever()` + = help: Replace with `anyio.sleep_forever()` ℹ Unsafe fix 2 2 | # ASYNCIO_NO_ERROR - no asyncio.sleep_forever, so check intentionally doesn't trigger. 3 3 | import math 4 4 | from math import inf - 5 |+from asyncio import sleep_forever + 5 |+from anyio import sleep_forever 5 6 | 6 7 | 7 8 | async def import_trio(): diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC210_ASYNC210.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC210_ASYNC210.py.snap index 8ca70a938797f..3b05d9961dc7d 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC210_ASYNC210.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC210_ASYNC210.py.snap @@ -70,7 +70,7 @@ ASYNC210.py:32:11: ASYNC210 Async functions should not call blocking HTTP method 31 | print(requests.get()) # ASYNC210 32 | print(requests.get(requests.get())) # ASYNC210 | ^^^^^^^^^^^^ ASYNC210 -33 | +33 | 34 | requests.options() # ASYNC210 | @@ -80,14 +80,14 @@ ASYNC210.py:32:24: ASYNC210 Async functions should not call blocking HTTP method 31 | print(requests.get()) # ASYNC210 32 | print(requests.get(requests.get())) # ASYNC210 | ^^^^^^^^^^^^ ASYNC210 -33 | +33 | 34 | requests.options() # ASYNC210 | ASYNC210.py:34:5: ASYNC210 Async functions should not call blocking HTTP methods | 32 | print(requests.get(requests.get())) # ASYNC210 -33 | +33 | 34 | requests.options() # ASYNC210 | ^^^^^^^^^^^^^^^^ ASYNC210 35 | requests.head() # ASYNC210 @@ -145,7 +145,7 @@ ASYNC210.py:39:5: ASYNC210 Async functions should not call blocking HTTP methods ASYNC210.py:42:5: ASYNC210 Async functions should not call blocking HTTP methods | 40 | requests.foo() -41 | +41 | 42 | httpx.options("") # ASYNC210 | ^^^^^^^^^^^^^ ASYNC210 43 | httpx.head("") # ASYNC210 @@ -203,7 +203,7 @@ ASYNC210.py:47:5: ASYNC210 Async functions should not call blocking HTTP methods ASYNC210.py:50:5: ASYNC210 Async functions should not call blocking HTTP methods | 48 | httpx.foo() # Ok -49 | +49 | 50 | urllib3.request() # ASYNC210 | ^^^^^^^^^^^^^^^ ASYNC210 51 | urllib3.request(...) # ASYNC210 @@ -214,16 +214,16 @@ ASYNC210.py:51:5: ASYNC210 Async functions should not call blocking HTTP methods 50 | urllib3.request() # ASYNC210 51 | urllib3.request(...) # ASYNC210 | ^^^^^^^^^^^^^^^ ASYNC210 -52 | +52 | 53 | urllib.request.urlopen("") # ASYNC210 | ASYNC210.py:53:5: ASYNC210 Async functions should not call blocking HTTP methods | 51 | urllib3.request(...) # ASYNC210 -52 | +52 | 53 | urllib.request.urlopen("") # ASYNC210 | ^^^^^^^^^^^^^^^^^^^^^^ ASYNC210 -54 | +54 | 55 | r = {} | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC220_ASYNC22x.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC220_ASYNC22x.py.snap index e7db488fa6b54..6be0e845eac40 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC220_ASYNC22x.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC220_ASYNC22x.py.snap @@ -44,7 +44,7 @@ ASYNC22x.py:76:5: ASYNC220 Async functions should not create subprocesses with b 75 | os.spawnl(mode=os.P_NOWAIT) # ASYNC220 76 | os.spawnl(mode=P_NOWAIT) # ASYNC220 | ^^^^^^^^^ ASYNC220 -77 | +77 | 78 | P_WAIT = os.P_WAIT | @@ -72,6 +72,6 @@ ASYNC22x.py:88:5: ASYNC220 Async functions should not create subprocesses with b 87 | os.spawnl(1) # ASYNC220 88 | os.spawnl(foo()) # ASYNC220 | ^^^^^^^^^ ASYNC220 -89 | +89 | 90 | # ASYNC222 | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC221_ASYNC22x.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC221_ASYNC22x.py.snap index 59fa094dc38ae..b838d960264df 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC221_ASYNC22x.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC221_ASYNC22x.py.snap @@ -31,14 +31,14 @@ ASYNC22x.py:32:5: ASYNC221 Async functions should not run processes with blockin 31 | subprocess.Popen() # ASYNC220 32 | os.system() # ASYNC221 | ^^^^^^^^^ ASYNC221 -33 | +33 | 34 | system() | ASYNC22x.py:38:5: ASYNC221 Async functions should not run processes with blocking methods | 36 | os.anything() -37 | +37 | 38 | subprocess.run() # ASYNC221 | ^^^^^^^^^^^^^^ ASYNC221 39 | subprocess.call() # ASYNC221 @@ -89,7 +89,7 @@ ASYNC22x.py:43:5: ASYNC221 Async functions should not run processes with blockin 42 | subprocess.getoutput() # ASYNC221 43 | subprocess.getstatusoutput() # ASYNC221 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ ASYNC221 -44 | +44 | 45 | await async_fun( | @@ -104,7 +104,7 @@ ASYNC22x.py:46:9: ASYNC221 Async functions should not run processes with blockin ASYNC22x.py:54:5: ASYNC221 Async functions should not run processes with blocking methods | 52 | subprocess() -53 | +53 | 54 | os.posix_spawn() # ASYNC221 | ^^^^^^^^^^^^^^ ASYNC221 55 | os.posix_spawnp() # ASYNC221 @@ -115,14 +115,14 @@ ASYNC22x.py:55:5: ASYNC221 Async functions should not run processes with blockin 54 | os.posix_spawn() # ASYNC221 55 | os.posix_spawnp() # ASYNC221 | ^^^^^^^^^^^^^^^ ASYNC221 -56 | +56 | 57 | os.spawn() | ASYNC22x.py:61:5: ASYNC221 Async functions should not run processes with blocking methods | 59 | os.spawnllll() -60 | +60 | 61 | os.spawnl() # ASYNC221 | ^^^^^^^^^ ASYNC221 62 | os.spawnle() # ASYNC221 @@ -193,7 +193,7 @@ ASYNC22x.py:68:5: ASYNC221 Async functions should not run processes with blockin 67 | os.spawnvp() # ASYNC221 68 | os.spawnvpe() # ASYNC221 | ^^^^^^^^^^^ ASYNC221 -69 | +69 | 70 | P_NOWAIT = os.P_NOWAIT | @@ -221,6 +221,6 @@ ASYNC22x.py:83:5: ASYNC221 Async functions should not run processes with blockin 82 | os.spawnl(mode=os.P_WAIT) # ASYNC221 83 | os.spawnl(mode=P_WAIT) # ASYNC221 | ^^^^^^^^^ ASYNC221 -84 | +84 | 85 | # other weird cases: ASYNC220 | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC222_ASYNC22x.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC222_ASYNC22x.py.snap index 0c9e675ffa144..66ca87ebfec16 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC222_ASYNC22x.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC222_ASYNC22x.py.snap @@ -59,6 +59,6 @@ ASYNC22x.py:95:5: ASYNC222 Async functions should not wait on processes with blo 94 | os.waitid() # ASYNC222 95 | os.waitpid() # ASYNC222 | ^^^^^^^^^^ ASYNC222 -96 | +96 | 97 | os.waitpi() | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC230_ASYNC230.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC230_ASYNC230.py.snap index c0b5faf4c47f3..b84217540675f 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC230_ASYNC230.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC230_ASYNC230.py.snap @@ -15,14 +15,14 @@ ASYNC230.py:7:5: ASYNC230 Async functions should not open files with blocking me 6 | open("") # ASYNC230 7 | io.open_code("") # ASYNC230 | ^^^^^^^^^^^^ ASYNC230 -8 | +8 | 9 | with open(""): # ASYNC230 | ASYNC230.py:9:10: ASYNC230 Async functions should not open files with blocking methods like `open` | 7 | io.open_code("") # ASYNC230 - 8 | + 8 | 9 | with open(""): # ASYNC230 | ^^^^ ASYNC230 10 | ... @@ -31,7 +31,7 @@ ASYNC230.py:9:10: ASYNC230 Async functions should not open files with blocking m ASYNC230.py:12:10: ASYNC230 Async functions should not open files with blocking methods like `open` | 10 | ... -11 | +11 | 12 | with open("") as f: # ASYNC230 | ^^^^ ASYNC230 13 | ... @@ -40,7 +40,7 @@ ASYNC230.py:12:10: ASYNC230 Async functions should not open files with blocking ASYNC230.py:15:17: ASYNC230 Async functions should not open files with blocking methods like `open` | 13 | ... -14 | +14 | 15 | with foo(), open(""): # ASYNC230 | ^^^^ ASYNC230 16 | ... @@ -49,7 +49,7 @@ ASYNC230.py:15:17: ASYNC230 Async functions should not open files with blocking ASYNC230.py:18:16: ASYNC230 Async functions should not open files with blocking methods like `open` | 16 | ... -17 | +17 | 18 | async with open(""): # ASYNC230 | ^^^^ ASYNC230 19 | ... @@ -95,7 +95,7 @@ ASYNC230.py:53:9: ASYNC230 Async functions should not open files with blocking m ASYNC230.py:59:5: ASYNC230 Async functions should not open files with blocking methods like `open` | 57 | (p1, p2) = (Path("foo"), Path("bar")) -58 | +58 | 59 | p1.open() # ASYNC230 | ^^^^^^^ ASYNC230 | diff --git a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC251_ASYNC251.py.snap b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC251_ASYNC251.py.snap index ffafdf9d99cd4..878f40cb8fe10 100644 --- a/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC251_ASYNC251.py.snap +++ b/crates/ruff_linter/src/rules/flake8_async/snapshots/ruff_linter__rules__flake8_async__tests__ASYNC251_ASYNC251.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_async/mod.rs +snapshot_kind: text --- ASYNC251.py:6:5: ASYNC251 Async functions should not call `time.sleep` | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/helpers.rs b/crates/ruff_linter/src/rules/flake8_bandit/helpers.rs index a79d707f8aa13..917c80f2f4925 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/helpers.rs @@ -20,7 +20,7 @@ pub(super) fn matches_password_name(string: &str) -> bool { } pub(super) fn is_untyped_exception(type_: Option<&Expr>, semantic: &SemanticModel) -> bool { - type_.map_or(true, |type_| { + type_.is_none_or(|type_| { if let Expr::Tuple(ast::ExprTuple { elts, .. }) = &type_ { elts.iter().any(|type_| { semantic diff --git a/crates/ruff_linter/src/rules/flake8_bandit/mod.rs b/crates/ruff_linter/src/rules/flake8_bandit/mod.rs index 49e7dd9881d12..868367d6f7635 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/mod.rs @@ -13,6 +13,7 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; #[test_case(Rule::Assert, Path::new("S101.py"))] @@ -51,19 +52,33 @@ mod tests { #[test_case(Rule::SuspiciousNonCryptographicRandomUsage, Path::new("S311.py"))] #[test_case(Rule::SuspiciousTelnetUsage, Path::new("S312.py"))] #[test_case(Rule::SuspiciousTelnetlibImport, Path::new("S401.py"))] + #[test_case(Rule::SuspiciousTelnetlibImport, Path::new("S401.pyi"))] #[test_case(Rule::SuspiciousFtplibImport, Path::new("S402.py"))] + #[test_case(Rule::SuspiciousFtplibImport, Path::new("S402.pyi"))] #[test_case(Rule::SuspiciousPickleImport, Path::new("S403.py"))] + #[test_case(Rule::SuspiciousPickleImport, Path::new("S403.pyi"))] #[test_case(Rule::SuspiciousSubprocessImport, Path::new("S404.py"))] + #[test_case(Rule::SuspiciousSubprocessImport, Path::new("S404.pyi"))] #[test_case(Rule::SuspiciousXmlEtreeImport, Path::new("S405.py"))] + #[test_case(Rule::SuspiciousXmlEtreeImport, Path::new("S405.pyi"))] #[test_case(Rule::SuspiciousXmlSaxImport, Path::new("S406.py"))] + #[test_case(Rule::SuspiciousXmlSaxImport, Path::new("S406.pyi"))] #[test_case(Rule::SuspiciousXmlExpatImport, Path::new("S407.py"))] + #[test_case(Rule::SuspiciousXmlExpatImport, Path::new("S407.pyi"))] #[test_case(Rule::SuspiciousXmlMinidomImport, Path::new("S408.py"))] + #[test_case(Rule::SuspiciousXmlMinidomImport, Path::new("S408.pyi"))] #[test_case(Rule::SuspiciousXmlPulldomImport, Path::new("S409.py"))] + #[test_case(Rule::SuspiciousXmlPulldomImport, Path::new("S409.pyi"))] #[test_case(Rule::SuspiciousLxmlImport, Path::new("S410.py"))] + #[test_case(Rule::SuspiciousLxmlImport, Path::new("S410.pyi"))] #[test_case(Rule::SuspiciousXmlrpcImport, Path::new("S411.py"))] + #[test_case(Rule::SuspiciousXmlrpcImport, Path::new("S411.pyi"))] #[test_case(Rule::SuspiciousHttpoxyImport, Path::new("S412.py"))] + #[test_case(Rule::SuspiciousHttpoxyImport, Path::new("S412.pyi"))] #[test_case(Rule::SuspiciousPycryptoImport, Path::new("S413.py"))] + #[test_case(Rule::SuspiciousPycryptoImport, Path::new("S413.pyi"))] #[test_case(Rule::SuspiciousPyghmiImport, Path::new("S415.py"))] + #[test_case(Rule::SuspiciousPyghmiImport, Path::new("S415.pyi"))] #[test_case(Rule::TryExceptContinue, Path::new("S112.py"))] #[test_case(Rule::TryExceptPass, Path::new("S110.py"))] #[test_case(Rule::UnixCommandWildcardInjection, Path::new("S609.py"))] @@ -72,6 +87,7 @@ mod tests { #[test_case(Rule::DjangoExtra, Path::new("S610.py"))] #[test_case(Rule::DjangoRawSql, Path::new("S611.py"))] #[test_case(Rule::TarfileUnsafeMembers, Path::new("S202.py"))] + #[test_case(Rule::UnsafeMarkupUse, Path::new("S704.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -82,6 +98,73 @@ mod tests { Ok(()) } + #[test_case(Rule::SuspiciousPickleUsage, Path::new("S301.py"))] + #[test_case(Rule::SuspiciousEvalUsage, Path::new("S307.py"))] + #[test_case(Rule::SuspiciousMarkSafeUsage, Path::new("S308.py"))] + #[test_case(Rule::SuspiciousURLOpenUsage, Path::new("S310.py"))] + #[test_case(Rule::SuspiciousNonCryptographicRandomUsage, Path::new("S311.py"))] + #[test_case(Rule::SuspiciousTelnetUsage, Path::new("S312.py"))] + #[test_case(Rule::SubprocessWithoutShellEqualsTrue, Path::new("S603.py"))] + fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "preview__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("flake8_bandit").join(path).as_path(), + &LinterSettings { + preview: PreviewMode::Enabled, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case(Rule::UnsafeMarkupUse, Path::new("S704_extend_markup_names.py"))] + #[test_case(Rule::UnsafeMarkupUse, Path::new("S704_skip_early_out.py"))] + fn extend_allowed_callable(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "extend_allow_callables__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("flake8_bandit").join(path).as_path(), + &LinterSettings { + flake8_bandit: super::settings::Settings { + extend_markup_names: vec!["webhelpers.html.literal".to_string()], + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case(Rule::UnsafeMarkupUse, Path::new("S704_whitelisted_markup_calls.py"))] + fn whitelisted_markup_calls(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "whitelisted_markup_calls__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("flake8_bandit").join(path).as_path(), + &LinterSettings { + flake8_bandit: super::settings::Settings { + allowed_markup_calls: vec!["bleach.clean".to_string()], + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test] fn check_hardcoded_tmp_additional_dirs() -> Result<()> { let diagnostics = test_path( @@ -94,7 +177,7 @@ mod tests { "/dev/shm".to_string(), "/foo".to_string(), ], - check_typed_exception: false, + ..Default::default() }, ..LinterSettings::for_rule(Rule::HardcodedTempFile) }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/assert_used.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/assert_used.rs index 6c91cb0c1747b..2001ef772712b 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/assert_used.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/assert_used.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Stmt; use ruff_text_size::{TextLen, TextRange}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -30,13 +30,13 @@ use ruff_text_size::Ranged; /// if x <= 0: /// raise ValueError("Expected positive value.") /// ``` -#[violation] -pub struct Assert; +#[derive(ViolationMetadata)] +pub(crate) struct Assert; impl Violation for Assert { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `assert` detected") + "Use of `assert` detected".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/bad_file_permissions.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/bad_file_permissions.rs index bff5c20674686..0033504e2d385 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/bad_file_permissions.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/bad_file_permissions.rs @@ -1,7 +1,7 @@ use anyhow::Result; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::{self as ast, Expr, Operator}; use ruff_python_semantic::{Modules, SemanticModel}; @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// - [Python documentation: `os.chmod`](https://docs.python.org/3/library/os.html#os.chmod) /// - [Python documentation: `stat`](https://docs.python.org/3/library/stat.html) /// - [Common Weakness Enumeration: CWE-732](https://cwe.mitre.org/data/definitions/732.html) -#[violation] -pub struct BadFilePermissions { +#[derive(ViolationMetadata)] +pub(crate) struct BadFilePermissions { reason: Reason, } @@ -47,7 +47,9 @@ impl Violation for BadFilePermissions { Reason::Permissive(mask) => { format!("`os.chmod` setting a permissive mask `{mask:#o}` on file or directory") } - Reason::Invalid => format!("`os.chmod` setting an invalid mask on file or directory"), + Reason::Invalid => { + "`os.chmod` setting an invalid mask on file or directory".to_string() + } } } } @@ -59,7 +61,7 @@ enum Reason { } /// S103 -pub(crate) fn bad_file_permissions(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn bad_file_permissions(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::OS) { return; } @@ -69,14 +71,14 @@ pub(crate) fn bad_file_permissions(checker: &mut Checker, call: &ast::ExprCall) .resolve_qualified_name(&call.func) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["os", "chmod"])) { - if let Some(mode_arg) = call.arguments.find_argument("mode", 1) { + if let Some(mode_arg) = call.arguments.find_argument_value("mode", 1) { match parse_mask(mode_arg, checker.semantic()) { // The mask couldn't be determined (e.g., it's dynamic). Ok(None) => {} // The mask is a valid integer value -- check for overly permissive permissions. Ok(Some(mask)) => { if (mask & WRITE_WORLD > 0) || (mask & EXECUTE_GROUP > 0) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadFilePermissions { reason: Reason::Permissive(mask), }, @@ -86,7 +88,7 @@ pub(crate) fn bad_file_permissions(checker: &mut Checker, call: &ast::ExprCall) } // The mask is an invalid integer value (i.e., it's out of range). Err(_) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadFilePermissions { reason: Reason::Invalid, }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rs index 8c872a32540fa..41686ce957b3f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprAttribute}; use ruff_text_size::Ranged; @@ -22,7 +22,7 @@ use crate::checkers::ast::Checker; /// User.objects.all().extra(select={"test": "%secure" % "nos"}) /// ``` /// -/// ## Use instead: +/// Use instead: /// ```python /// from django.contrib.auth.models import User /// @@ -33,18 +33,18 @@ use crate::checkers::ast::Checker; /// ## References /// - [Django documentation: SQL injection protection](https://docs.djangoproject.com/en/dev/topics/security/#sql-injection-protection) /// - [Common Weakness Enumeration: CWE-89](https://cwe.mitre.org/data/definitions/89.html) -#[violation] -pub struct DjangoExtra; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoExtra; impl Violation for DjangoExtra { #[derive_message_formats] fn message(&self) -> String { - format!("Use of Django `extra` can lead to SQL injection vulnerabilities") + "Use of Django `extra` can lead to SQL injection vulnerabilities".to_string() } } /// S610 -pub(crate) fn django_extra(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn django_extra(checker: &Checker, call: &ast::ExprCall) { let Expr::Attribute(ExprAttribute { attr, .. }) = call.func.as_ref() else { return; }; @@ -54,15 +54,13 @@ pub(crate) fn django_extra(checker: &mut Checker, call: &ast::ExprCall) { } if is_call_insecure(call) { - checker - .diagnostics - .push(Diagnostic::new(DjangoExtra, call.arguments.range())); + checker.report_diagnostic(Diagnostic::new(DjangoExtra, call.arguments.range())); } } fn is_call_insecure(call: &ast::ExprCall) -> bool { for (argument_name, position) in [("select", 0), ("where", 1), ("tables", 3)] { - if let Some(argument) = call.arguments.find_argument(argument_name, position) { + if let Some(argument) = call.arguments.find_argument_value(argument_name, position) { match argument_name { "select" => match argument { Expr::Dict(dict) => { diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/django_raw_sql.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/django_raw_sql.rs index 577accaa36f25..c4ddc9decd9a6 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/django_raw_sql.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/django_raw_sql.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -18,24 +18,24 @@ use crate::checkers::ast::Checker; /// from django.db.models.expressions import RawSQL /// from django.contrib.auth.models import User /// -/// User.objects.annotate(val=("%secure" % "nos", [])) +/// User.objects.annotate(val=RawSQL("%s" % input_param, [])) /// ``` /// /// ## References /// - [Django documentation: SQL injection protection](https://docs.djangoproject.com/en/dev/topics/security/#sql-injection-protection) /// - [Common Weakness Enumeration: CWE-89](https://cwe.mitre.org/data/definitions/89.html) -#[violation] -pub struct DjangoRawSql; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoRawSql; impl Violation for DjangoRawSql { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `RawSQL` can lead to SQL injection vulnerabilities") + "Use of `RawSQL` can lead to SQL injection vulnerabilities".to_string() } } /// S611 -pub(crate) fn django_raw_sql(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn django_raw_sql(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -52,12 +52,10 @@ pub(crate) fn django_raw_sql(checker: &mut Checker, call: &ast::ExprCall) { { if !call .arguments - .find_argument("sql", 0) + .find_argument_value("sql", 0) .is_some_and(Expr::is_string_literal_expr) { - checker - .diagnostics - .push(Diagnostic::new(DjangoRawSql, call.func.range())); + checker.report_diagnostic(Diagnostic::new(DjangoRawSql, call.func.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/exec_used.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/exec_used.rs index 83eae0aec6ce0..ee23e38be2a2b 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/exec_used.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/exec_used.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -21,25 +21,19 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `exec`](https://docs.python.org/3/library/functions.html#exec) /// - [Common Weakness Enumeration: CWE-78](https://cwe.mitre.org/data/definitions/78.html) -#[violation] -pub struct ExecBuiltin; +#[derive(ViolationMetadata)] +pub(crate) struct ExecBuiltin; impl Violation for ExecBuiltin { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `exec` detected") + "Use of `exec` detected".to_string() } } /// S102 -pub(crate) fn exec_used(checker: &mut Checker, func: &Expr) { - if checker - .semantic() - .resolve_qualified_name(func) - .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["" | "builtin", "exec"])) - { - checker - .diagnostics - .push(Diagnostic::new(ExecBuiltin, func.range())); +pub(crate) fn exec_used(checker: &Checker, func: &Expr) { + if checker.semantic().match_builtin_expr(func, "exec") { + checker.report_diagnostic(Diagnostic::new(ExecBuiltin, func.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/flask_debug_true.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/flask_debug_true.rs index db3e3adf34c8b..01a3f63ae2e9f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/flask_debug_true.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/flask_debug_true.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; use ruff_python_semantic::analyze::typing; @@ -36,18 +36,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Flask documentation: Debug Mode](https://flask.palletsprojects.com/en/latest/quickstart/#debug-mode) -#[violation] -pub struct FlaskDebugTrue; +#[derive(ViolationMetadata)] +pub(crate) struct FlaskDebugTrue; impl Violation for FlaskDebugTrue { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `debug=True` in Flask app detected") + "Use of `debug=True` in Flask app detected".to_string() } } /// S201 -pub(crate) fn flask_debug_true(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn flask_debug_true(checker: &Checker, call: &ExprCall) { let Expr::Attribute(ExprAttribute { attr, value, .. }) = call.func.as_ref() else { return; }; @@ -67,8 +67,6 @@ pub(crate) fn flask_debug_true(checker: &mut Checker, call: &ExprCall) { if typing::resolve_assignment(value, checker.semantic()) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["flask", "Flask"])) { - checker - .diagnostics - .push(Diagnostic::new(FlaskDebugTrue, debug_argument.range())); + checker.report_diagnostic(Diagnostic::new(FlaskDebugTrue, debug_argument.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_bind_all_interfaces.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_bind_all_interfaces.rs index ea37397430d16..2b8c743fea6e9 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_bind_all_interfaces.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_bind_all_interfaces.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, StringLike}; use ruff_text_size::Ranged; @@ -26,24 +26,23 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Common Weakness Enumeration: CWE-200](https://cwe.mitre.org/data/definitions/200.html) -#[violation] -pub struct HardcodedBindAllInterfaces; +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedBindAllInterfaces; impl Violation for HardcodedBindAllInterfaces { #[derive_message_formats] fn message(&self) -> String { - format!("Possible binding to all interfaces") + "Possible binding to all interfaces".to_string() } } /// S104 -pub(crate) fn hardcoded_bind_all_interfaces(checker: &mut Checker, string: StringLike) { +pub(crate) fn hardcoded_bind_all_interfaces(checker: &Checker, string: StringLike) { match string { StringLike::String(ast::ExprStringLiteral { value, .. }) => { if value == "0.0.0.0" { checker - .diagnostics - .push(Diagnostic::new(HardcodedBindAllInterfaces, string.range())); + .report_diagnostic(Diagnostic::new(HardcodedBindAllInterfaces, string.range())); } } StringLike::FString(ast::ExprFString { value, .. }) => { @@ -51,15 +50,16 @@ pub(crate) fn hardcoded_bind_all_interfaces(checker: &mut Checker, string: Strin match part { ast::FStringPart::Literal(literal) => { if &**literal == "0.0.0.0" { - checker - .diagnostics - .push(Diagnostic::new(HardcodedBindAllInterfaces, literal.range())); + checker.report_diagnostic(Diagnostic::new( + HardcodedBindAllInterfaces, + literal.range(), + )); } } ast::FStringPart::FString(f_string) => { for literal in f_string.elements.literals() { if &**literal == "0.0.0.0" { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HardcodedBindAllInterfaces, literal.range(), )); @@ -70,5 +70,5 @@ pub(crate) fn hardcoded_bind_all_interfaces(checker: &mut Checker, string: Strin } } StringLike::Bytes(_) => (), - }; + } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_default.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_default.rs index ade608a1d5829..08070b92220dc 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_default.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_default.rs @@ -1,7 +1,7 @@ -use ruff_python_ast::{Expr, Parameter, ParameterWithDefault, Parameters}; +use ruff_python_ast::{Expr, Parameter, Parameters}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -38,8 +38,8 @@ use super::super::helpers::{matches_password_name, string_literal}; /// /// ## References /// - [Common Weakness Enumeration: CWE-259](https://cwe.mitre.org/data/definitions/259.html) -#[violation] -pub struct HardcodedPasswordDefault { +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedPasswordDefault { name: String, } @@ -69,18 +69,13 @@ fn check_password_kwarg(parameter: &Parameter, default: &Expr) -> Option<Diagnos } /// S107 -pub(crate) fn hardcoded_password_default(checker: &mut Checker, parameters: &Parameters) { - for ParameterWithDefault { - parameter, - default, - range: _, - } in parameters.iter_non_variadic_params() - { - let Some(default) = default else { +pub(crate) fn hardcoded_password_default(checker: &Checker, parameters: &Parameters) { + for parameter in parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { continue; }; - if let Some(diagnostic) = check_password_kwarg(parameter, default) { - checker.diagnostics.push(diagnostic); + if let Some(diagnostic) = check_password_kwarg(¶meter.parameter, default) { + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_func_arg.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_func_arg.rs index 3c5d48ac19a9f..c242d36832ec7 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_func_arg.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_func_arg.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Keyword; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -34,8 +34,8 @@ use super::super::helpers::{matches_password_name, string_literal}; /// /// ## References /// - [Common Weakness Enumeration: CWE-259](https://cwe.mitre.org/data/definitions/259.html) -#[violation] -pub struct HardcodedPasswordFuncArg { +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedPasswordFuncArg { name: String, } @@ -51,20 +51,22 @@ impl Violation for HardcodedPasswordFuncArg { } /// S106 -pub(crate) fn hardcoded_password_func_arg(checker: &mut Checker, keywords: &[Keyword]) { - checker - .diagnostics - .extend(keywords.iter().filter_map(|keyword| { - string_literal(&keyword.value).filter(|string| !string.is_empty())?; - let arg = keyword.arg.as_ref()?; - if !matches_password_name(arg) { - return None; - } - Some(Diagnostic::new( - HardcodedPasswordFuncArg { - name: arg.to_string(), - }, - keyword.range(), - )) - })); +pub(crate) fn hardcoded_password_func_arg(checker: &Checker, keywords: &[Keyword]) { + for keyword in keywords { + if string_literal(&keyword.value).is_none_or(str::is_empty) { + continue; + } + let Some(arg) = &keyword.arg else { + continue; + }; + if !matches_password_name(arg) { + continue; + } + checker.report_diagnostic(Diagnostic::new( + HardcodedPasswordFuncArg { + name: arg.to_string(), + }, + keyword.range(), + )); + } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_string.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_string.rs index 13e74cabeafb0..6ea4ab32be82d 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_string.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_password_string.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -33,8 +33,8 @@ use super::super::helpers::{matches_password_name, string_literal}; /// /// ## References /// - [Common Weakness Enumeration: CWE-259](https://cwe.mitre.org/data/definitions/259.html) -#[violation] -pub struct HardcodedPasswordString { +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedPasswordString { name: String, } @@ -72,37 +72,35 @@ fn password_target(target: &Expr) -> Option<&str> { /// S105 pub(crate) fn compare_to_hardcoded_password_string( - checker: &mut Checker, + checker: &Checker, left: &Expr, comparators: &[Expr], ) { - checker - .diagnostics - .extend(comparators.iter().filter_map(|comp| { - string_literal(comp).filter(|string| !string.is_empty())?; - let name = password_target(left)?; - Some(Diagnostic::new( - HardcodedPasswordString { - name: name.to_string(), - }, - comp.range(), - )) - })); + for comp in comparators { + if string_literal(comp).is_none_or(str::is_empty) { + continue; + } + let Some(name) = password_target(left) else { + continue; + }; + checker.report_diagnostic(Diagnostic::new( + HardcodedPasswordString { + name: name.to_string(), + }, + comp.range(), + )); + } } /// S105 -pub(crate) fn assign_hardcoded_password_string( - checker: &mut Checker, - value: &Expr, - targets: &[Expr], -) { +pub(crate) fn assign_hardcoded_password_string(checker: &Checker, value: &Expr, targets: &[Expr]) { if string_literal(value) .filter(|string| !string.is_empty()) .is_some() { for target in targets { if let Some(name) = password_target(target) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HardcodedPasswordString { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_sql_expression.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_sql_expression.rs index 322f9dae33da9..70470fd977a69 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_sql_expression.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_sql_expression.rs @@ -3,16 +3,25 @@ use std::sync::LazyLock; use regex::Regex; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::str::raw_contents; use ruff_python_ast::{self as ast, Expr, Operator}; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; static SQL_REGEX: LazyLock<Regex> = LazyLock::new(|| { - Regex::new(r"(?i)\b(select\s+.*\s+from\s|delete\s+from\s|(insert|replace)\s+.*\s+values\s|update\s+.*\s+set\s)") + Regex::new( + r"(?isx) + \b + (select\s+.*\s+from\s + |delete\s+from\s + |(insert|replace)\s+.*\s+values\s + |update\s+.*\s+set\s + ) + ", + ) .unwrap() }); @@ -35,28 +44,28 @@ static SQL_REGEX: LazyLock<Regex> = LazyLock::new(|| { /// ## References /// - [B608: Test for SQL injection](https://bandit.readthedocs.io/en/latest/plugins/b608_hardcoded_sql_expressions.html) /// - [psycopg3: Server-side binding](https://www.psycopg.org/psycopg3/docs/basic/from_pg2.html#server-side-binding) -#[violation] -pub struct HardcodedSQLExpression; +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedSQLExpression; impl Violation for HardcodedSQLExpression { #[derive_message_formats] fn message(&self) -> String { - format!("Possible SQL injection vector through string-based query construction") + "Possible SQL injection vector through string-based query construction".to_string() } } /// S608 -pub(crate) fn hardcoded_sql_expression(checker: &mut Checker, expr: &Expr) { +pub(crate) fn hardcoded_sql_expression(checker: &Checker, expr: &Expr) { let content = match expr { // "select * from table where val = " + "str" + ... Expr::BinOp(ast::ExprBinOp { op: Operator::Add, .. }) => { // Only evaluate the full BinOp, not the nested components. - if !checker + if checker .semantic() .current_expression_parent() - .map_or(true, |parent| !parent.is_bin_op_expr()) + .is_some_and(ruff_python_ast::Expr::is_bin_op_expr) { return; } @@ -91,14 +100,20 @@ pub(crate) fn hardcoded_sql_expression(checker: &mut Checker, expr: &Expr) { } // f"select * from table where val = {val}" - Expr::FString(f_string) => concatenated_f_string(f_string, checker.locator()), + Expr::FString(f_string) + if f_string + .value + .f_strings() + .any(|fs| fs.elements.iter().any(ast::FStringElement::is_expression)) => + { + concatenated_f_string(f_string, checker.locator()) + } + _ => return, }; if SQL_REGEX.is_match(&content) { - checker - .diagnostics - .push(Diagnostic::new(HardcodedSQLExpression, expr.range())); + checker.report_diagnostic(Diagnostic::new(HardcodedSQLExpression, expr.range())); } } @@ -183,7 +198,7 @@ fn is_explicit_concatenation(expr: &Expr) -> Option<bool> { .iter() .map(is_explicit_concatenation) .collect::<Vec<_>>(); - if values.iter().any(|v| *v == Some(true)) { + if values.contains(&Some(true)) { Some(true) } else if values.iter().all(|v| *v == Some(false)) { Some(false) diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_tmp_directory.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_tmp_directory.rs index cccfb58880336..35b35c850f6e8 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_tmp_directory.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hardcoded_tmp_directory.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Expr, StringLike}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -31,12 +31,16 @@ use crate::checkers::ast::Checker; /// ... /// ``` /// +/// ## Options +/// - `lint.flake8-bandit.hardcoded-tmp-directory` +/// - `lint.flake8-bandit.hardcoded-tmp-directory-extend` +/// /// ## References /// - [Common Weakness Enumeration: CWE-377](https://cwe.mitre.org/data/definitions/377.html) /// - [Common Weakness Enumeration: CWE-379](https://cwe.mitre.org/data/definitions/379.html) /// - [Python documentation: `tempfile`](https://docs.python.org/3/library/tempfile.html) -#[violation] -pub struct HardcodedTempFile { +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedTempFile { string: String, } @@ -52,7 +56,7 @@ impl Violation for HardcodedTempFile { } /// S108 -pub(crate) fn hardcoded_tmp_directory(checker: &mut Checker, string: StringLike) { +pub(crate) fn hardcoded_tmp_directory(checker: &Checker, string: StringLike) { match string { StringLike::String(ast::ExprStringLiteral { value, .. }) => { check(checker, value.to_str(), string.range()); @@ -75,7 +79,7 @@ pub(crate) fn hardcoded_tmp_directory(checker: &mut Checker, string: StringLike) } } -fn check(checker: &mut Checker, value: &str, range: TextRange) { +fn check(checker: &Checker, value: &str, range: TextRange) { if !checker .settings .flake8_bandit @@ -98,7 +102,7 @@ fn check(checker: &mut Checker, value: &str, range: TextRange) { } } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HardcodedTempFile { string: value.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/hashlib_insecure_hash_functions.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/hashlib_insecure_hash_functions.rs index e19d6eb848db1..8fdfdd702f8f6 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/hashlib_insecure_hash_functions.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/hashlib_insecure_hash_functions.rs @@ -1,7 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_false; use ruff_python_ast::{self as ast, Arguments}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -42,14 +43,27 @@ use super::super::helpers::string_literal; /// return hash == known_hash /// ``` /// +/// or add `usedforsecurity=False` if the hashing algorithm is not used in a security context, e.g. +/// as a non-cryptographic one-way compression function: +/// ```python +/// import hashlib +/// +/// +/// def certificate_is_valid(certificate: bytes, known_hash: str) -> bool: +/// hash = hashlib.md5(certificate, usedforsecurity=False).hexdigest() +/// return hash == known_hash +/// ``` +/// +/// /// ## References /// - [Python documentation: `hashlib` — Secure hashes and message digests](https://docs.python.org/3/library/hashlib.html) /// - [Python documentation: `crypt` — Function to check Unix passwords](https://docs.python.org/3/library/crypt.html) +/// - [Python documentation: `FIPS` - FIPS compliant hashlib implementation](https://docs.python.org/3/library/hashlib.html#hashlib.algorithms_guaranteed) /// - [Common Weakness Enumeration: CWE-327](https://cwe.mitre.org/data/definitions/327.html) /// - [Common Weakness Enumeration: CWE-328](https://cwe.mitre.org/data/definitions/328.html) /// - [Common Weakness Enumeration: CWE-916](https://cwe.mitre.org/data/definitions/916.html) -#[violation] -pub struct HashlibInsecureHashFunction { +#[derive(ViolationMetadata)] +pub(crate) struct HashlibInsecureHashFunction { library: String, string: String, } @@ -63,7 +77,14 @@ impl Violation for HashlibInsecureHashFunction { } /// S324 -pub(crate) fn hashlib_insecure_hash_functions(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn hashlib_insecure_hash_functions(checker: &Checker, call: &ast::ExprCall) { + if !checker + .semantic() + .seen_module(Modules::HASHLIB | Modules::CRYPT) + { + return; + } + if let Some(weak_hash_call) = checker .semantic() .resolve_qualified_name(&call.func) @@ -97,7 +118,7 @@ pub(crate) fn hashlib_insecure_hash_functions(checker: &mut Checker, call: &ast: } fn detect_insecure_hashlib_calls( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, hashlib_call: HashlibCall, ) { @@ -107,20 +128,20 @@ fn detect_insecure_hashlib_calls( match hashlib_call { HashlibCall::New => { - let Some(name_arg) = call.arguments.find_argument("name", 0) else { + let Some(name_arg) = call.arguments.find_argument_value("name", 0) else { return; }; let Some(hash_func_name) = string_literal(name_arg) else { return; }; - // `hashlib.new` accepts both lowercase and uppercase names for hash + // `hashlib.new` accepts mixed lowercase and uppercase names for hash // functions. if matches!( - hash_func_name, - "md4" | "md5" | "sha" | "sha1" | "MD4" | "MD5" | "SHA" | "SHA1" + hash_func_name.to_ascii_lowercase().as_str(), + "md4" | "md5" | "sha" | "sha1" ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HashlibInsecureHashFunction { library: "hashlib".to_string(), string: hash_func_name.to_string(), @@ -130,7 +151,7 @@ fn detect_insecure_hashlib_calls( } } HashlibCall::WeakHash(func_name) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HashlibInsecureHashFunction { library: "hashlib".to_string(), string: (*func_name).to_string(), @@ -141,7 +162,7 @@ fn detect_insecure_hashlib_calls( } } -fn detect_insecure_crypt_calls(checker: &mut Checker, call: &ast::ExprCall) { +fn detect_insecure_crypt_calls(checker: &Checker, call: &ast::ExprCall) { let Some(method) = checker .semantic() .resolve_qualified_name(&call.func) @@ -151,7 +172,7 @@ fn detect_insecure_crypt_calls(checker: &mut Checker, call: &ast::ExprCall) { _ => None, }) .and_then(|(argument_name, position)| { - call.arguments.find_argument(argument_name, position) + call.arguments.find_argument_value(argument_name, position) }) else { return; @@ -165,7 +186,7 @@ fn detect_insecure_crypt_calls(checker: &mut Checker, call: &ast::ExprCall) { qualified_name.segments(), ["crypt", "METHOD_CRYPT" | "METHOD_MD5" | "METHOD_BLOWFISH"] ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( HashlibInsecureHashFunction { library: "crypt".to_string(), string: qualified_name.to_string(), @@ -178,7 +199,7 @@ fn detect_insecure_crypt_calls(checker: &mut Checker, call: &ast::ExprCall) { fn is_used_for_security(arguments: &Arguments) -> bool { arguments .find_keyword("usedforsecurity") - .map_or(true, |keyword| !is_const_false(&keyword.value)) + .is_none_or(|keyword| !is_const_false(&keyword.value)) } #[derive(Debug, Copy, Clone)] diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/jinja2_autoescape_false.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/jinja2_autoescape_false.rs index 128d0c9c1c8c4..100a15d40ea31 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/jinja2_autoescape_false.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/jinja2_autoescape_false.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -34,36 +34,34 @@ use crate::checkers::ast::Checker; /// ## References /// - [Jinja documentation: API](https://jinja.palletsprojects.com/en/latest/api/#autoescaping) /// - [Common Weakness Enumeration: CWE-94](https://cwe.mitre.org/data/definitions/94.html) -#[violation] -pub struct Jinja2AutoescapeFalse { +#[derive(ViolationMetadata)] +pub(crate) struct Jinja2AutoescapeFalse { value: bool, } impl Violation for Jinja2AutoescapeFalse { #[derive_message_formats] fn message(&self) -> String { - let Jinja2AutoescapeFalse { value } = self; - match value { - true => format!( - "Using jinja2 templates with `autoescape=False` is dangerous and can lead to XSS. \ + if self.value { + "Using jinja2 templates with `autoescape=False` is dangerous and can lead to XSS. \ Ensure `autoescape=True` or use the `select_autoescape` function." - ), - false => format!( - "By default, jinja2 sets `autoescape` to `False`. Consider using \ - `autoescape=True` or the `select_autoescape` function to mitigate XSS \ - vulnerabilities." - ), + .to_string() + } else { + "By default, jinja2 sets `autoescape` to `False`. Consider using \ + `autoescape=True` or the `select_autoescape` function to mitigate XSS \ + vulnerabilities." + .to_string() } } } /// S701 -pub(crate) fn jinja2_autoescape_false(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn jinja2_autoescape_false(checker: &Checker, call: &ast::ExprCall) { if checker .semantic() .resolve_qualified_name(&call.func) - .is_some_and(|qualifieed_name| { - matches!(qualifieed_name.segments(), ["jinja2", "Environment"]) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["jinja2", "Environment"]) }) { if let Some(keyword) = call.arguments.find_keyword("autoescape") { @@ -72,20 +70,20 @@ pub(crate) fn jinja2_autoescape_false(checker: &mut Checker, call: &ast::ExprCal Expr::Call(ast::ExprCall { func, .. }) => { if let Expr::Name(ast::ExprName { id, .. }) = func.as_ref() { if id != "select_autoescape" { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( Jinja2AutoescapeFalse { value: true }, keyword.range(), )); } } } - _ => checker.diagnostics.push(Diagnostic::new( + _ => checker.report_diagnostic(Diagnostic::new( Jinja2AutoescapeFalse { value: true }, keyword.range(), )), } } else { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( Jinja2AutoescapeFalse { value: false }, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/logging_config_insecure_listen.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/logging_config_insecure_listen.rs index c25a846a6db26..95e92641953fa 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/logging_config_insecure_listen.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/logging_config_insecure_listen.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -24,18 +24,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `logging.config.listen()`](https://docs.python.org/3/library/logging.config.html#logging.config.listen) -#[violation] -pub struct LoggingConfigInsecureListen; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingConfigInsecureListen; impl Violation for LoggingConfigInsecureListen { #[derive_message_formats] fn message(&self) -> String { - format!("Use of insecure `logging.config.listen` detected") + "Use of insecure `logging.config.listen` detected".to_string() } } /// S612 -pub(crate) fn logging_config_insecure_listen(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn logging_config_insecure_listen(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::LOGGING) { return; } @@ -51,7 +51,7 @@ pub(crate) fn logging_config_insecure_listen(checker: &mut Checker, call: &ast:: return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( LoggingConfigInsecureListen, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/mako_templates.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/mako_templates.rs index d542487cc74bd..ecf38b92ddc24 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/mako_templates.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/mako_templates.rs @@ -1,6 +1,6 @@ use crate::checkers::ast::Checker; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -31,20 +31,18 @@ use ruff_text_size::Ranged; /// - [Mako documentation](https://www.makotemplates.org/) /// - [OpenStack security: Cross site scripting XSS](https://security.openstack.org/guidelines/dg_cross-site-scripting-xss.html) /// - [Common Weakness Enumeration: CWE-80](https://cwe.mitre.org/data/definitions/80.html) -#[violation] -pub struct MakoTemplates; +#[derive(ViolationMetadata)] +pub(crate) struct MakoTemplates; impl Violation for MakoTemplates { #[derive_message_formats] fn message(&self) -> String { - format!( - "Mako templates allow HTML and JavaScript rendering by default and are inherently open to XSS attacks" - ) + "Mako templates allow HTML and JavaScript rendering by default and are inherently open to XSS attacks".to_string() } } /// S702 -pub(crate) fn mako_templates(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn mako_templates(checker: &Checker, call: &ast::ExprCall) { if checker .semantic() .resolve_qualified_name(&call.func) @@ -52,8 +50,6 @@ pub(crate) fn mako_templates(checker: &mut Checker, call: &ast::ExprCall) { matches!(qualified_name.segments(), ["mako", "template", "Template"]) }) { - checker - .diagnostics - .push(Diagnostic::new(MakoTemplates, call.func.range())); + checker.report_diagnostic(Diagnostic::new(MakoTemplates, call.func.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/mod.rs index 0c9a5953e0b5f..163913b3526ad 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/mod.rs @@ -29,6 +29,7 @@ pub(crate) use suspicious_imports::*; pub(crate) use tarfile_unsafe_members::*; pub(crate) use try_except_continue::*; pub(crate) use try_except_pass::*; +pub(crate) use unsafe_markup_use::*; pub(crate) use unsafe_yaml_load::*; pub(crate) use weak_cryptographic_key::*; @@ -63,5 +64,6 @@ mod suspicious_imports; mod tarfile_unsafe_members; mod try_except_continue; mod try_except_pass; +mod unsafe_markup_use; mod unsafe_yaml_load; mod weak_cryptographic_key; diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/paramiko_calls.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/paramiko_calls.rs index 8cf2cd3870ca6..bc76d74ebc012 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/paramiko_calls.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/paramiko_calls.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -25,18 +25,19 @@ use crate::checkers::ast::Checker; /// ## References /// - [Common Weakness Enumeration: CWE-78](https://cwe.mitre.org/data/definitions/78.html) /// - [Paramiko documentation: `SSHClient.exec_command()`](https://docs.paramiko.org/en/stable/api/client.html#paramiko.client.SSHClient.exec_command) -#[violation] -pub struct ParamikoCall; +#[derive(ViolationMetadata)] +pub(crate) struct ParamikoCall; impl Violation for ParamikoCall { #[derive_message_formats] fn message(&self) -> String { - format!("Possible shell injection via Paramiko call; check inputs are properly sanitized") + "Possible shell injection via Paramiko call; check inputs are properly sanitized" + .to_string() } } /// S601 -pub(crate) fn paramiko_call(checker: &mut Checker, func: &Expr) { +pub(crate) fn paramiko_call(checker: &Checker, func: &Expr) { if checker .semantic() .resolve_qualified_name(func) @@ -44,8 +45,6 @@ pub(crate) fn paramiko_call(checker: &mut Checker, func: &Expr) { matches!(qualified_name.segments(), ["paramiko", "exec_command"]) }) { - checker - .diagnostics - .push(Diagnostic::new(ParamikoCall, func.range())); + checker.report_diagnostic(Diagnostic::new(ParamikoCall, func.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/request_with_no_cert_validation.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/request_with_no_cert_validation.rs index 463a73376be7f..abb0f034b278a 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/request_with_no_cert_validation.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/request_with_no_cert_validation.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::helpers::is_const_false; use ruff_text_size::Ranged; @@ -30,8 +30,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Common Weakness Enumeration: CWE-295](https://cwe.mitre.org/data/definitions/295.html) -#[violation] -pub struct RequestWithNoCertValidation { +#[derive(ViolationMetadata)] +pub(crate) struct RequestWithNoCertValidation { string: String, } @@ -46,22 +46,26 @@ impl Violation for RequestWithNoCertValidation { } /// S501 -pub(crate) fn request_with_no_cert_validation(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn request_with_no_cert_validation(checker: &Checker, call: &ast::ExprCall) { if let Some(target) = checker .semantic() .resolve_qualified_name(&call.func) .and_then(|qualified_name| match qualified_name.segments() { - ["requests", "get" | "options" | "head" | "post" | "put" | "patch" | "delete"] => { - Some("requests") - } - ["httpx", "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request" - | "stream" | "Client" | "AsyncClient"] => Some("httpx"), + [ + "requests", + "get" | "options" | "head" | "post" | "put" | "patch" | "delete", + ] => Some("requests"), + [ + "httpx", + "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request" + | "stream" | "Client" | "AsyncClient", + ] => Some("httpx"), _ => None, }) { if let Some(keyword) = call.arguments.find_keyword("verify") { if is_const_false(&keyword.value) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RequestWithNoCertValidation { string: target.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/request_without_timeout.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/request_without_timeout.rs index a5c08b1f123e1..12a553d9b578c 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/request_without_timeout.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/request_without_timeout.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; @@ -32,8 +32,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Requests documentation: Timeouts](https://requests.readthedocs.io/en/latest/user/advanced/#timeouts) /// - [httpx documentation: Timeouts](https://www.python-httpx.org/advanced/timeouts/) -#[violation] -pub struct RequestWithoutTimeout { +#[derive(ViolationMetadata)] +pub(crate) struct RequestWithoutTimeout { implicit: bool, module: String, } @@ -51,30 +51,39 @@ impl Violation for RequestWithoutTimeout { } /// S113 -pub(crate) fn request_without_timeout(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn request_without_timeout(checker: &Checker, call: &ast::ExprCall) { if let Some(module) = checker .semantic() .resolve_qualified_name(&call.func) .and_then(|qualified_name| match qualified_name.segments() { - ["requests", "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request"] => { - Some("requests") - } - ["httpx", "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request" | "stream" | "Client" | "AsyncClient"] => { - Some("httpx") - } + [ + "requests", + "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request", + ] => Some("requests"), + [ + "httpx", + "get" | "options" | "head" | "post" | "put" | "patch" | "delete" | "request" + | "stream" | "Client" | "AsyncClient", + ] => Some("httpx"), _ => None, }) { if let Some(keyword) = call.arguments.find_keyword("timeout") { if keyword.value.is_none_literal_expr() { - checker.diagnostics.push(Diagnostic::new( - RequestWithoutTimeout { implicit: false, module: module.to_string() }, + checker.report_diagnostic(Diagnostic::new( + RequestWithoutTimeout { + implicit: false, + module: module.to_string(), + }, keyword.range(), )); } } else if module == "requests" { - checker.diagnostics.push(Diagnostic::new( - RequestWithoutTimeout { implicit: true, module: module.to_string() }, + checker.report_diagnostic(Diagnostic::new( + RequestWithoutTimeout { + implicit: true, + module: module.to_string(), + }, call.func.range(), )); } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/shell_injection.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/shell_injection.rs index eeb2f894c39a9..89972bca1a780 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/shell_injection.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/shell_injection.rs @@ -1,7 +1,8 @@ //! Checks relating to shell injection. +use crate::preview::is_shell_injection_only_trusted_input_enabled; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::Truthiness; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_python_semantic::SemanticModel; @@ -36,8 +37,8 @@ use crate::{ /// ## References /// - [Python documentation: `subprocess` — Subprocess management](https://docs.python.org/3/library/subprocess.html) /// - [Common Weakness Enumeration: CWE-78](https://cwe.mitre.org/data/definitions/78.html) -#[violation] -pub struct SubprocessPopenWithShellEqualsTrue { +#[derive(ViolationMetadata)] +pub(crate) struct SubprocessPopenWithShellEqualsTrue { safety: Safety, is_exact: bool, } @@ -46,14 +47,10 @@ impl Violation for SubprocessPopenWithShellEqualsTrue { #[derive_message_formats] fn message(&self) -> String { match (self.safety, self.is_exact) { - (Safety::SeemsSafe, true) => format!( - "`subprocess` call with `shell=True` seems safe, but may be changed in the future; consider rewriting without `shell`" - ), - (Safety::Unknown, true) => format!("`subprocess` call with `shell=True` identified, security issue"), - (Safety::SeemsSafe, false) => format!( - "`subprocess` call with truthy `shell` seems safe, but may be changed in the future; consider rewriting without `shell`" - ), - (Safety::Unknown, false) => format!("`subprocess` call with truthy `shell` identified, security issue"), + (Safety::SeemsSafe, true) => "`subprocess` call with `shell=True` seems safe, but may be changed in the future; consider rewriting without `shell`".to_string(), + (Safety::Unknown, true) => "`subprocess` call with `shell=True` identified, security issue".to_string(), + (Safety::SeemsSafe, false) => "`subprocess` call with truthy `shell` seems safe, but may be changed in the future; consider rewriting without `shell`".to_string(), + (Safety::Unknown, false) => "`subprocess` call with truthy `shell` identified, security issue".to_string(), } } } @@ -82,13 +79,13 @@ impl Violation for SubprocessPopenWithShellEqualsTrue { /// - [Python documentation: `subprocess` — Subprocess management](https://docs.python.org/3/library/subprocess.html) /// /// [#4045]: https://github.com/astral-sh/ruff/issues/4045 -#[violation] -pub struct SubprocessWithoutShellEqualsTrue; +#[derive(ViolationMetadata)] +pub(crate) struct SubprocessWithoutShellEqualsTrue; impl Violation for SubprocessWithoutShellEqualsTrue { #[derive_message_formats] fn message(&self) -> String { - format!("`subprocess` call: check for execution of untrusted input") + "`subprocess` call: check for execution of untrusted input".to_string() } } @@ -120,8 +117,8 @@ impl Violation for SubprocessWithoutShellEqualsTrue { /// /// ## References /// - [Python documentation: Security Considerations](https://docs.python.org/3/library/subprocess.html#security-considerations) -#[violation] -pub struct CallWithShellEqualsTrue { +#[derive(ViolationMetadata)] +pub(crate) struct CallWithShellEqualsTrue { is_exact: bool, } @@ -129,9 +126,9 @@ impl Violation for CallWithShellEqualsTrue { #[derive_message_formats] fn message(&self) -> String { if self.is_exact { - format!("Function call with `shell=True` parameter identified, security issue") + "Function call with `shell=True` parameter identified, security issue".to_string() } else { - format!("Function call with truthy `shell` parameter identified, security issue") + "Function call with truthy `shell` parameter identified, security issue".to_string() } } } @@ -172,8 +169,8 @@ impl Violation for CallWithShellEqualsTrue { /// /// ## References /// - [Python documentation: `subprocess`](https://docs.python.org/3/library/subprocess.html) -#[violation] -pub struct StartProcessWithAShell { +#[derive(ViolationMetadata)] +pub(crate) struct StartProcessWithAShell { safety: Safety, } @@ -181,8 +178,8 @@ impl Violation for StartProcessWithAShell { #[derive_message_formats] fn message(&self) -> String { match self.safety { - Safety::SeemsSafe => format!("Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell`"), - Safety::Unknown => format!("Starting a process with a shell, possible injection detected"), + Safety::SeemsSafe => "Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell`".to_string(), + Safety::Unknown => "Starting a process with a shell, possible injection detected".to_string(), } } } @@ -198,10 +195,10 @@ impl Violation for StartProcessWithAShell { /// This rule specifically flags functions in the `os` module that spawn /// subprocesses *without* the use of a shell. Note that these typically pose a /// much smaller security risk than subprocesses that are started *with* a -/// shell, which are flagged by [`start-process-with-a-shell`] (`S605`). This -/// gives you the option of enabling one rule while disabling the other if you -/// decide that the security risk from these functions is acceptable for your -/// use case. +/// shell, which are flagged by [`start-process-with-a-shell`][S605] (`S605`). +/// This gives you the option of enabling one rule while disabling the other +/// if you decide that the security risk from these functions is acceptable +/// for your use case. /// /// ## Example /// ```python @@ -212,14 +209,14 @@ impl Violation for StartProcessWithAShell { /// os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", arbitrary_user_input) /// ``` /// -/// [start-process-with-a-shell]: https://docs.astral.sh/ruff/rules/start-process-with-a-shell/#start-process-with-a-shell-s605 -#[violation] -pub struct StartProcessWithNoShell; +/// [S605]: https://docs.astral.sh/ruff/rules/start-process-with-a-shell +#[derive(ViolationMetadata)] +pub(crate) struct StartProcessWithNoShell; impl Violation for StartProcessWithNoShell { #[derive_message_formats] fn message(&self) -> String { - format!("Starting a process without a shell") + "Starting a process without a shell".to_string() } } @@ -248,13 +245,13 @@ impl Violation for StartProcessWithNoShell { /// ## References /// - [Python documentation: `subprocess.Popen()`](https://docs.python.org/3/library/subprocess.html#subprocess.Popen) /// - [Common Weakness Enumeration: CWE-426](https://cwe.mitre.org/data/definitions/426.html) -#[violation] -pub struct StartProcessWithPartialPath; +#[derive(ViolationMetadata)] +pub(crate) struct StartProcessWithPartialPath; impl Violation for StartProcessWithPartialPath { #[derive_message_formats] fn message(&self) -> String { - format!("Starting a process with a partial executable path") + "Starting a process with a partial executable path".to_string() } } @@ -281,18 +278,31 @@ impl Violation for StartProcessWithPartialPath { /// /// ## References /// - [Common Weakness Enumeration: CWE-78](https://cwe.mitre.org/data/definitions/78.html) -#[violation] -pub struct UnixCommandWildcardInjection; +#[derive(ViolationMetadata)] +pub(crate) struct UnixCommandWildcardInjection; impl Violation for UnixCommandWildcardInjection { #[derive_message_formats] fn message(&self) -> String { - format!("Possible wildcard injection in call due to `*` usage") + "Possible wildcard injection in call due to `*` usage".to_string() + } +} + +/// Check if an expression is a trusted input for subprocess.run. +/// We assume that any str, list[str] or tuple[str] literal can be trusted. +fn is_trusted_input(arg: &Expr) -> bool { + match arg { + Expr::StringLiteral(_) => true, + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { + elts.iter().all(|elt| matches!(elt, Expr::StringLiteral(_))) + } + Expr::Named(named) => is_trusted_input(&named.value), + _ => false, } } /// S602, S603, S604, S605, S606, S607, S609 -pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn shell_injection(checker: &Checker, call: &ast::ExprCall) { let call_kind = get_call_kind(&call.func, checker.semantic()); let shell_keyword = find_shell_keyword(&call.arguments, checker.semantic()); @@ -304,7 +314,7 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { truthiness: truthiness @ (Truthiness::True | Truthiness::Truthy), }) => { if checker.enabled(Rule::SubprocessPopenWithShellEqualsTrue) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SubprocessPopenWithShellEqualsTrue { safety: Safety::from(arg), is_exact: matches!(truthiness, Truthiness::True), @@ -314,23 +324,16 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { } } // S603 - Some(ShellKeyword { - truthiness: Truthiness::False | Truthiness::Falsey | Truthiness::Unknown, - }) => { - if checker.enabled(Rule::SubprocessWithoutShellEqualsTrue) { - checker.diagnostics.push(Diagnostic::new( - SubprocessWithoutShellEqualsTrue, - call.func.range(), - )); - } - } - // S603 - None => { - if checker.enabled(Rule::SubprocessWithoutShellEqualsTrue) { - checker.diagnostics.push(Diagnostic::new( - SubprocessWithoutShellEqualsTrue, - call.func.range(), - )); + _ => { + if !is_trusted_input(arg) + || !is_shell_injection_only_trusted_input_enabled(checker.settings) + { + if checker.enabled(Rule::SubprocessWithoutShellEqualsTrue) { + checker.report_diagnostic(Diagnostic::new( + SubprocessWithoutShellEqualsTrue, + call.func.range(), + )); + } } } } @@ -341,7 +344,7 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { { // S604 if checker.enabled(Rule::CallWithShellEqualsTrue) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CallWithShellEqualsTrue { is_exact: matches!(truthiness, Truthiness::True), }, @@ -354,7 +357,7 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { if checker.enabled(Rule::StartProcessWithAShell) { if matches!(call_kind, Some(CallKind::Shell)) { if let Some(arg) = call.arguments.args.first() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StartProcessWithAShell { safety: Safety::from(arg), }, @@ -367,9 +370,7 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { // S606 if checker.enabled(Rule::StartProcessWithNoShell) { if matches!(call_kind, Some(CallKind::NoShell)) { - checker - .diagnostics - .push(Diagnostic::new(StartProcessWithNoShell, call.func.range())); + checker.report_diagnostic(Diagnostic::new(StartProcessWithNoShell, call.func.range())); } } @@ -378,9 +379,10 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { if call_kind.is_some() { if let Some(arg) = call.arguments.args.first() { if is_partial_path(arg) { - checker - .diagnostics - .push(Diagnostic::new(StartProcessWithPartialPath, arg.range())); + checker.report_diagnostic(Diagnostic::new( + StartProcessWithPartialPath, + arg.range(), + )); } } } @@ -401,9 +403,10 @@ pub(crate) fn shell_injection(checker: &mut Checker, call: &ast::ExprCall) { { if let Some(arg) = call.arguments.args.first() { if is_wildcard_command(arg) { - checker - .diagnostics - .push(Diagnostic::new(UnixCommandWildcardInjection, arg.range())); + checker.report_diagnostic(Diagnostic::new( + UnixCommandWildcardInjection, + arg.range(), + )); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_insecure_version.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_insecure_version.rs index 0c34637456c0d..82365a74bf929 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_insecure_version.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_insecure_version.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Int}; use ruff_text_size::Ranged; @@ -30,18 +30,18 @@ use crate::checkers::ast::Checker; /// ## References /// - [Cybersecurity and Infrastructure Security Agency (CISA): Alert TA17-156A](https://www.cisa.gov/news-events/alerts/2017/06/05/reducing-risk-snmp-abuse) /// - [Common Weakness Enumeration: CWE-319](https://cwe.mitre.org/data/definitions/319.html) -#[violation] -pub struct SnmpInsecureVersion; +#[derive(ViolationMetadata)] +pub(crate) struct SnmpInsecureVersion; impl Violation for SnmpInsecureVersion { #[derive_message_formats] fn message(&self) -> String { - format!("The use of SNMPv1 and SNMPv2 is insecure. Use SNMPv3 if able.") + "The use of SNMPv1 and SNMPv2 is insecure. Use SNMPv3 if able.".to_string() } } /// S508 -pub(crate) fn snmp_insecure_version(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn snmp_insecure_version(checker: &Checker, call: &ast::ExprCall) { if checker .semantic() .resolve_qualified_name(&call.func) @@ -60,9 +60,7 @@ pub(crate) fn snmp_insecure_version(checker: &mut Checker, call: &ast::ExprCall) .. }) ) { - checker - .diagnostics - .push(Diagnostic::new(SnmpInsecureVersion, keyword.range())); + checker.report_diagnostic(Diagnostic::new(SnmpInsecureVersion, keyword.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_weak_cryptography.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_weak_cryptography.rs index 73b72335179d1..f33fdbc8fce53 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_weak_cryptography.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/snmp_weak_cryptography.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -28,20 +28,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Common Weakness Enumeration: CWE-319](https://cwe.mitre.org/data/definitions/319.html) -#[violation] -pub struct SnmpWeakCryptography; +#[derive(ViolationMetadata)] +pub(crate) struct SnmpWeakCryptography; impl Violation for SnmpWeakCryptography { #[derive_message_formats] fn message(&self) -> String { - format!( - "You should not use SNMPv3 without encryption. `noAuthNoPriv` & `authNoPriv` is insecure." - ) + "You should not use SNMPv3 without encryption. `noAuthNoPriv` & `authNoPriv` is insecure." + .to_string() } } /// S509 -pub(crate) fn snmp_weak_cryptography(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn snmp_weak_cryptography(checker: &Checker, call: &ast::ExprCall) { if call.arguments.len() < 3 { if checker .semantic() @@ -53,9 +52,7 @@ pub(crate) fn snmp_weak_cryptography(checker: &mut Checker, call: &ast::ExprCall ) }) { - checker - .diagnostics - .push(Diagnostic::new(SnmpWeakCryptography, call.func.range())); + checker.report_diagnostic(Diagnostic::new(SnmpWeakCryptography, call.func.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssh_no_host_key_verification.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssh_no_host_key_verification.rs index 848075fc20ac1..7956608f397ff 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssh_no_host_key_verification.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssh_no_host_key_verification.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_callable; use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; use ruff_python_semantic::analyze::typing; @@ -33,18 +33,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Paramiko documentation: set_missing_host_key_policy](https://docs.paramiko.org/en/latest/api/client.html#paramiko.client.SSHClient.set_missing_host_key_policy) -#[violation] -pub struct SSHNoHostKeyVerification; +#[derive(ViolationMetadata)] +pub(crate) struct SSHNoHostKeyVerification; impl Violation for SSHNoHostKeyVerification { #[derive_message_formats] fn message(&self) -> String { - format!("Paramiko call with policy set to automatically trust the unknown host key") + "Paramiko call with policy set to automatically trust the unknown host key".to_string() } } /// S507 -pub(crate) fn ssh_no_host_key_verification(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn ssh_no_host_key_verification(checker: &Checker, call: &ExprCall) { let Expr::Attribute(ExprAttribute { attr, value, .. }) = call.func.as_ref() else { return; }; @@ -53,7 +53,7 @@ pub(crate) fn ssh_no_host_key_verification(checker: &mut Checker, call: &ExprCal return; } - let Some(policy_argument) = call.arguments.find_argument("policy", 0) else { + let Some(policy_argument) = call.arguments.find_argument_value("policy", 0) else { return; }; @@ -78,7 +78,7 @@ pub(crate) fn ssh_no_host_key_verification(checker: &mut Checker, call: &ExprCal ["paramiko", "client", "SSHClient"] | ["paramiko", "SSHClient"] ) }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SSHNoHostKeyVerification, policy_argument.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_insecure_version.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_insecure_version.rs index 796c7979a3e29..70bddf995a968 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_insecure_version.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_insecure_version.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprCall}; use ruff_text_size::Ranged; @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// /// ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1_2) /// ``` -#[violation] -pub struct SslInsecureVersion { +#[derive(ViolationMetadata)] +pub(crate) struct SslInsecureVersion { protocol: String, } @@ -48,7 +48,7 @@ impl Violation for SslInsecureVersion { } /// S502 -pub(crate) fn ssl_insecure_version(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn ssl_insecure_version(checker: &Checker, call: &ExprCall) { let Some(keyword) = checker .semantic() .resolve_qualified_name(call.func.as_ref()) @@ -68,7 +68,7 @@ pub(crate) fn ssl_insecure_version(checker: &mut Checker, call: &ExprCall) { match &keyword.value { Expr::Name(ast::ExprName { id, .. }) => { if is_insecure_protocol(id) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SslInsecureVersion { protocol: id.to_string(), }, @@ -78,7 +78,7 @@ pub(crate) fn ssl_insecure_version(checker: &mut Checker, call: &ExprCall) { } Expr::Attribute(ast::ExprAttribute { attr, .. }) => { if is_insecure_protocol(attr) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SslInsecureVersion { protocol: attr.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_bad_defaults.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_bad_defaults.rs index bfff9cbf343d0..ab8367a7d2c5a 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_bad_defaults.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_bad_defaults.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, StmtFunctionDef}; use crate::checkers::ast::Checker; @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// /// def func(version=ssl.PROTOCOL_TLSv1_2): ... /// ``` -#[violation] -pub struct SslWithBadDefaults { +#[derive(ViolationMetadata)] +pub(crate) struct SslWithBadDefaults { protocol: String, } @@ -48,7 +48,7 @@ impl Violation for SslWithBadDefaults { } /// S503 -pub(crate) fn ssl_with_bad_defaults(checker: &mut Checker, function_def: &StmtFunctionDef) { +pub(crate) fn ssl_with_bad_defaults(checker: &Checker, function_def: &StmtFunctionDef) { for default in function_def .parameters .iter_non_variadic_params() @@ -57,7 +57,7 @@ pub(crate) fn ssl_with_bad_defaults(checker: &mut Checker, function_def: &StmtFu match default { Expr::Name(ast::ExprName { id, range, .. }) => { if is_insecure_protocol(id.as_str()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SslWithBadDefaults { protocol: id.to_string(), }, @@ -67,7 +67,7 @@ pub(crate) fn ssl_with_bad_defaults(checker: &mut Checker, function_def: &StmtFu } Expr::Attribute(ast::ExprAttribute { attr, range, .. }) => { if is_insecure_protocol(attr.as_str()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SslWithBadDefaults { protocol: attr.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_no_version.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_no_version.rs index 13514f95ce1cd..854c8f19cc804 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_no_version.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_with_no_version.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::ExprCall; use ruff_text_size::Ranged; @@ -25,27 +25,25 @@ use crate::checkers::ast::Checker; /// /// ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1_2) /// ``` -#[violation] -pub struct SslWithNoVersion; +#[derive(ViolationMetadata)] +pub(crate) struct SslWithNoVersion; impl Violation for SslWithNoVersion { #[derive_message_formats] fn message(&self) -> String { - format!("`ssl.wrap_socket` called without an `ssl_version``") + "`ssl.wrap_socket` called without an `ssl_version``".to_string() } } /// S504 -pub(crate) fn ssl_with_no_version(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn ssl_with_no_version(checker: &Checker, call: &ExprCall) { if checker .semantic() .resolve_qualified_name(call.func.as_ref()) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["ssl", "wrap_socket"])) { if call.arguments.find_keyword("ssl_version").is_none() { - checker - .diagnostics - .push(Diagnostic::new(SslWithNoVersion, call.range())); + checker.report_diagnostic(Diagnostic::new(SslWithNoVersion, call.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_function_call.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_function_call.rs index aeccb74510d97..c7886e8bcf113 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_function_call.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_function_call.rs @@ -2,12 +2,13 @@ //! //! See: <https://bandit.readthedocs.io/en/latest/blacklists/blacklist_calls.html> use itertools::Either; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Decorator, Expr, ExprCall, Operator}; -use ruff_text_size::Ranged; +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Arguments, Decorator, Expr, ExprCall, Operator}; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use crate::preview::is_suspicious_function_reference_enabled; use crate::registry::AsRule; /// ## What it does @@ -27,6 +28,8 @@ use crate::registry::AsRule; /// payload, This will prevent an attacker from injecting arbitrary objects /// into the serialized data. /// +/// In [preview], this rule will also flag references to `pickle` functions. +/// /// ## Example /// ```python /// import pickle @@ -46,13 +49,15 @@ use crate::registry::AsRule; /// ## References /// - [Python documentation: `pickle` — Python object serialization](https://docs.python.org/3/library/pickle.html) /// - [Common Weakness Enumeration: CWE-502](https://cwe.mitre.org/data/definitions/502.html) -#[violation] -pub struct SuspiciousPickleUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousPickleUsage; impl Violation for SuspiciousPickleUsage { #[derive_message_formats] fn message(&self) -> String { - format!("`pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue") + "`pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue".to_string() } } @@ -72,6 +77,8 @@ impl Violation for SuspiciousPickleUsage { /// payload. This will prevent an attacker from injecting arbitrary objects /// into the serialized data. /// +/// In [preview], this rule will also flag references to `marshal` functions. +/// /// ## Example /// ```python /// import marshal @@ -91,13 +98,15 @@ impl Violation for SuspiciousPickleUsage { /// ## References /// - [Python documentation: `marshal` — Internal Python object serialization](https://docs.python.org/3/library/marshal.html) /// - [Common Weakness Enumeration: CWE-502](https://cwe.mitre.org/data/definitions/502.html) -#[violation] -pub struct SuspiciousMarshalUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousMarshalUsage; impl Violation for SuspiciousMarshalUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Deserialization with the `marshal` module is possibly dangerous") + "Deserialization with the `marshal` module is possibly dangerous".to_string() } } @@ -114,6 +123,8 @@ impl Violation for SuspiciousMarshalUsage { /// Avoid using weak or broken cryptographic hash functions in security /// contexts. Instead, use a known secure hash function such as SHA-256. /// +/// In [preview], this rule will also flag references to insecure hash functions. +/// /// ## Example /// ```python /// from cryptography.hazmat.primitives import hashes @@ -137,13 +148,15 @@ impl Violation for SuspiciousMarshalUsage { /// - [Common Weakness Enumeration: CWE-327](https://cwe.mitre.org/data/definitions/327.html) /// - [Common Weakness Enumeration: CWE-328](https://cwe.mitre.org/data/definitions/328.html) /// - [Common Weakness Enumeration: CWE-916](https://cwe.mitre.org/data/definitions/916.html) -#[violation] -pub struct SuspiciousInsecureHashUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousInsecureHashUsage; impl Violation for SuspiciousInsecureHashUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of insecure MD2, MD4, MD5, or SHA1 hash function") + "Use of insecure MD2, MD4, MD5, or SHA1 hash function".to_string() } } @@ -157,6 +170,8 @@ impl Violation for SuspiciousInsecureHashUsage { /// /// Use strong, modern cryptographic ciphers instead of weak or broken ones. /// +/// In [preview], this rule will also flag references to insecure ciphers. +/// /// ## Example /// ```python /// from cryptography.hazmat.primitives.ciphers import Cipher, algorithms @@ -175,13 +190,15 @@ impl Violation for SuspiciousInsecureHashUsage { /// /// ## References /// - [Common Weakness Enumeration: CWE-327](https://cwe.mitre.org/data/definitions/327.html) -#[violation] -pub struct SuspiciousInsecureCipherUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousInsecureCipherUsage; impl Violation for SuspiciousInsecureCipherUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of insecure cipher, replace with a known secure cipher such as AES") + "Use of insecure cipher, replace with a known secure cipher such as AES".to_string() } } @@ -195,6 +212,8 @@ impl Violation for SuspiciousInsecureCipherUsage { /// /// Use strong, modern cryptographic ciphers instead of weak or broken ones. /// +/// In [preview], this rule will also flag references to insecure cipher modes. +/// /// ## Example /// ```python /// from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes @@ -215,13 +234,16 @@ impl Violation for SuspiciousInsecureCipherUsage { /// /// ## References /// - [Common Weakness Enumeration: CWE-327](https://cwe.mitre.org/data/definitions/327.html) -#[violation] -pub struct SuspiciousInsecureCipherModeUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousInsecureCipherModeUsage; impl Violation for SuspiciousInsecureCipherModeUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of insecure block cipher mode, replace with a known secure mode such as CBC or CTR") + "Use of insecure block cipher mode, replace with a known secure mode such as CBC or CTR" + .to_string() } } @@ -240,6 +262,8 @@ impl Violation for SuspiciousInsecureCipherModeUsage { /// instead, either directly or via a context manager such as /// `tempfile.TemporaryFile`. /// +/// In [preview], this rule will also flag references to `tempfile.mktemp`. +/// /// ## Example /// ```python /// import tempfile @@ -259,13 +283,15 @@ impl Violation for SuspiciousInsecureCipherModeUsage { /// /// ## References /// - [Python documentation:`mktemp`](https://docs.python.org/3/library/tempfile.html#tempfile.mktemp) -#[violation] -pub struct SuspiciousMktempUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousMktempUsage; impl Violation for SuspiciousMktempUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of insecure and deprecated function (`mktemp`)") + "Use of insecure and deprecated function (`mktemp`)".to_string() } } @@ -279,6 +305,8 @@ impl Violation for SuspiciousMktempUsage { /// `ast.literal_eval()` instead, which will raise an exception if the /// expression is not a valid Python literal. /// +/// In [preview], this rule will also flag references to `eval`. +/// /// ## Example /// ```python /// x = eval(input("Enter a number: ")) @@ -295,13 +323,15 @@ impl Violation for SuspiciousMktempUsage { /// - [Python documentation: `eval`](https://docs.python.org/3/library/functions.html#eval) /// - [Python documentation: `literal_eval`](https://docs.python.org/3/library/ast.html#ast.literal_eval) /// - [_Eval really is dangerous_ by Ned Batchelder](https://nedbatchelder.com/blog/201206/eval_really_is_dangerous.html) -#[violation] -pub struct SuspiciousEvalUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousEvalUsage; impl Violation for SuspiciousEvalUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of possibly insecure function; consider using `ast.literal_eval`") + "Use of possibly insecure function; consider using `ast.literal_eval`".to_string() } } @@ -315,32 +345,46 @@ impl Violation for SuspiciousEvalUsage { /// before rending them. /// /// `django.utils.safestring.mark_safe` marks a string as safe for use in HTML -/// templates, bypassing XSS protection. This is dangerous because it may allow +/// templates, bypassing XSS protection. Its usage can be dangerous if the +/// contents of the string are dynamically generated, because it may allow /// cross-site scripting attacks if the string is not properly escaped. /// +/// For dynamically generated strings, consider utilizing +/// `django.utils.html.format_html`. +/// +/// In [preview], this rule will also flag references to `django.utils.safestring.mark_safe`. +/// /// ## Example /// ```python /// from django.utils.safestring import mark_safe /// -/// content = mark_safe("<script>alert('Hello, world!')</script>") # XSS. +/// +/// def render_username(username): +/// return mark_safe(f"<i>{username}</i>") # Dangerous if username is user-provided. /// ``` /// /// Use instead: /// ```python -/// content = "<script>alert('Hello, world!')</script>" # Safe if rendered. +/// from django.utils.html import format_html +/// +/// +/// def render_username(username): +/// return django.utils.html.format_html("<i>{}</i>", username) # username is escaped. /// ``` /// /// ## References /// - [Django documentation: `mark_safe`](https://docs.djangoproject.com/en/dev/ref/utils/#django.utils.safestring.mark_safe) /// - [Django documentation: Cross Site Scripting (XSS) protection](https://docs.djangoproject.com/en/dev/topics/security/#cross-site-scripting-xss-protection) /// - [Common Weakness Enumeration: CWE-80](https://cwe.mitre.org/data/definitions/80.html) -#[violation] -pub struct SuspiciousMarkSafeUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousMarkSafeUsage; impl Violation for SuspiciousMarkSafeUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `mark_safe` may expose cross-site scripting vulnerabilities") + "Use of `mark_safe` may expose cross-site scripting vulnerabilities".to_string() } } @@ -357,6 +401,8 @@ impl Violation for SuspiciousMarkSafeUsage { /// only permitted schemes are used (e.g., allowing `http:` and `https:`, and /// disallowing `file:` and `ftp:`). /// +/// In [preview], this rule will also flag references to URL open functions. +/// /// ## Example /// ```python /// from urllib.request import urlopen @@ -382,13 +428,15 @@ impl Violation for SuspiciousMarkSafeUsage { /// /// ## References /// - [Python documentation: `urlopen`](https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen) -#[violation] -pub struct SuspiciousURLOpenUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousURLOpenUsage; impl Violation for SuspiciousURLOpenUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected.") + "Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected.".to_string() } } @@ -404,6 +452,8 @@ impl Violation for SuspiciousURLOpenUsage { /// (such as using the [`secrets` module](https://docs.python.org/3/library/secrets.html)) /// when generating random numbers for security purposes. /// +/// In [preview], this rule will also flag references to these generators. +/// /// ## Example /// ```python /// import random @@ -420,13 +470,15 @@ impl Violation for SuspiciousURLOpenUsage { /// /// ## References /// - [Python documentation: `random` — Generate pseudo-random numbers](https://docs.python.org/3/library/random.html) -#[violation] -pub struct SuspiciousNonCryptographicRandomUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousNonCryptographicRandomUsage; impl Violation for SuspiciousNonCryptographicRandomUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Standard pseudo-random generators are not suitable for cryptographic purposes") + "Standard pseudo-random generators are not suitable for cryptographic purposes".to_string() } } @@ -441,6 +493,8 @@ impl Violation for SuspiciousNonCryptographicRandomUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.etree.cElementTree import parse @@ -460,13 +514,15 @@ impl Violation for SuspiciousNonCryptographicRandomUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLCElementTreeUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLCElementTreeUsage; impl Violation for SuspiciousXMLCElementTreeUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -481,6 +537,8 @@ impl Violation for SuspiciousXMLCElementTreeUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.etree.ElementTree import parse @@ -500,13 +558,15 @@ impl Violation for SuspiciousXMLCElementTreeUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLElementTreeUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLElementTreeUsage; impl Violation for SuspiciousXMLElementTreeUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -521,6 +581,8 @@ impl Violation for SuspiciousXMLElementTreeUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.sax.expatreader import create_parser @@ -540,13 +602,15 @@ impl Violation for SuspiciousXMLElementTreeUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLExpatReaderUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLExpatReaderUsage; impl Violation for SuspiciousXMLExpatReaderUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -561,6 +625,8 @@ impl Violation for SuspiciousXMLExpatReaderUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.dom.expatbuilder import parse @@ -580,13 +646,15 @@ impl Violation for SuspiciousXMLExpatReaderUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLExpatBuilderUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLExpatBuilderUsage; impl Violation for SuspiciousXMLExpatBuilderUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -601,6 +669,8 @@ impl Violation for SuspiciousXMLExpatBuilderUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.sax import make_parser @@ -620,13 +690,15 @@ impl Violation for SuspiciousXMLExpatBuilderUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLSaxUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLSaxUsage; impl Violation for SuspiciousXMLSaxUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -641,6 +713,8 @@ impl Violation for SuspiciousXMLSaxUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.dom.minidom import parse @@ -660,13 +734,15 @@ impl Violation for SuspiciousXMLSaxUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLMiniDOMUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLMiniDOMUsage; impl Violation for SuspiciousXMLMiniDOMUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } @@ -681,6 +757,8 @@ impl Violation for SuspiciousXMLMiniDOMUsage { /// Consider using the `defusedxml` package when parsing untrusted XML data, /// to protect against XML attacks. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from xml.dom.pulldom import parse @@ -700,16 +778,25 @@ impl Violation for SuspiciousXMLMiniDOMUsage { /// - [PyPI: `defusedxml`](https://pypi.org/project/defusedxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLPullDOMUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLPullDOMUsage; impl Violation for SuspiciousXMLPullDOMUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents") + "Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents".to_string() } } +/// ## Deprecation +/// +/// This rule was deprecated as the `lxml` library has been modified to address +/// known vulnerabilities and unsafe defaults. As such, the `defusedxml` +/// library is no longer necessary, `defusedxml` has [deprecated] its `lxml` +/// module. +/// /// ## What it does /// Checks for uses of insecure XML parsers. /// @@ -718,6 +805,8 @@ impl Violation for SuspiciousXMLPullDOMUsage { /// which cause excessive memory and CPU usage by exploiting recursion. An /// attacker could use such methods to access unauthorized resources. /// +/// In [preview], this rule will also flag references to insecure XML parsers. +/// /// ## Example /// ```python /// from lxml import etree @@ -729,13 +818,16 @@ impl Violation for SuspiciousXMLPullDOMUsage { /// - [PyPI: `lxml`](https://pypi.org/project/lxml/) /// - [Common Weakness Enumeration: CWE-400](https://cwe.mitre.org/data/definitions/400.html) /// - [Common Weakness Enumeration: CWE-776](https://cwe.mitre.org/data/definitions/776.html) -#[violation] -pub struct SuspiciousXMLETreeUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +/// [deprecated]: https://pypi.org/project/defusedxml/0.8.0rc2/#defusedxml-lxml +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXMLETreeUsage; impl Violation for SuspiciousXMLETreeUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Using `lxml` to parse untrusted data is known to be vulnerable to XML attacks") + "Using `lxml` to parse untrusted data is known to be vulnerable to XML attacks".to_string() } } @@ -753,6 +845,8 @@ impl Violation for SuspiciousXMLETreeUsage { /// the previous behavior that does perform verification. Otherwise, use /// `ssl.create_default_context` to create a secure context. /// +/// In [preview], this rule will also flag references to `ssl._create_unverified_context`. +/// /// ## Example /// ```python /// import ssl @@ -772,13 +866,14 @@ impl Violation for SuspiciousXMLETreeUsage { /// - [Python documentation: `ssl` — TLS/SSL wrapper for socket objects](https://docs.python.org/3/library/ssl.html) /// /// [PEP 476]: https://peps.python.org/pep-0476/ -#[violation] -pub struct SuspiciousUnverifiedContextUsage; +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousUnverifiedContextUsage; impl Violation for SuspiciousUnverifiedContextUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Python allows using an insecure context via the `_create_unverified_context` that reverts to the previous behavior that does not validate certificates or perform hostname checks.") + "Python allows using an insecure context via the `_create_unverified_context` that reverts to the previous behavior that does not validate certificates or perform hostname checks.".to_string() } } @@ -791,15 +886,19 @@ impl Violation for SuspiciousUnverifiedContextUsage { /// /// Instead, consider using a more secure protocol such as SSH. /// +/// In [preview], this rule will also flag references to Telnet-related functions. +/// /// ## References /// - [Python documentation: `telnetlib` — Telnet client](https://docs.python.org/3/library/telnetlib.html) -#[violation] -pub struct SuspiciousTelnetUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousTelnetUsage; impl Violation for SuspiciousTelnetUsage { #[derive_message_formats] fn message(&self) -> String { - format!("Telnet-related functions are being called. Telnet is considered insecure. Use SSH or some other encrypted protocol.") + "Telnet is considered insecure. Use SSH or some other encrypted protocol.".to_string() } } @@ -812,20 +911,72 @@ impl Violation for SuspiciousTelnetUsage { /// /// Instead, consider using FTPS (which secures FTP using SSL/TLS) or SFTP. /// +/// In [preview], this rule will also flag references to FTP-related functions. +/// /// ## References /// - [Python documentation: `ftplib` — FTP protocol client](https://docs.python.org/3/library/ftplib.html) -#[violation] -pub struct SuspiciousFTPLibUsage; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousFTPLibUsage; impl Violation for SuspiciousFTPLibUsage { #[derive_message_formats] fn message(&self) -> String { - format!("FTP-related functions are being called. FTP is considered insecure. Use SSH/SFTP/SCP or some other encrypted protocol.") + "FTP-related functions are being called. FTP is considered insecure. Use SSH/SFTP/SCP or some other encrypted protocol.".to_string() } } +pub(crate) fn suspicious_function_call(checker: &Checker, call: &ExprCall) { + suspicious_function( + checker, + call.func.as_ref(), + Some(&call.arguments), + call.range, + ); +} + +pub(crate) fn suspicious_function_reference(checker: &Checker, func: &Expr) { + if !is_suspicious_function_reference_enabled(checker.settings) { + return; + } + + match checker.semantic().current_expression_parent() { + Some(Expr::Call(parent)) => { + // Avoid duplicate diagnostics. For example: + // + // ```python + // # vvvvvvvvvvvvvvvvvvvvvvvvv Already reported as a call expression + // shelve.open(lorem, ipsum) + // # ^^^^^^ Should not be reported as a reference + // ``` + if parent.func.range().contains_range(func.range()) { + return; + } + } + Some(Expr::Attribute(_)) => { + // Avoid duplicate diagnostics. For example: + // + // ```python + // # vvvvvvvvvvv Already reported as an attribute expression + // shelve.open + // # ^^^^^^ Should not be reported as a reference + // ``` + return; + } + _ => {} + } + + suspicious_function(checker, func, None, func.range()); +} + /// S301, S302, S303, S304, S305, S306, S307, S308, S310, S311, S312, S313, S314, S315, S316, S317, S318, S319, S320, S321, S323 -pub(crate) fn suspicious_function_call(checker: &mut Checker, call: &ExprCall) { +fn suspicious_function( + checker: &Checker, + func: &Expr, + arguments: Option<&Arguments>, + range: TextRange, +) { /// Returns `true` if the iterator starts with the given prefix. fn has_prefix(mut chars: impl Iterator<Item = char>, prefix: &str) -> bool { for expected in prefix.chars() { @@ -876,126 +1027,247 @@ pub(crate) fn suspicious_function_call(checker: &mut Checker, call: &ExprCall) { } } - let Some(diagnostic_kind) = checker.semantic().resolve_qualified_name(call.func.as_ref()).and_then(|qualified_name| { - match qualified_name.segments() { - // Pickle - ["pickle" | "dill", "load" | "loads" | "Unpickler"] | - ["shelve", "open" | "DbfilenameShelf"] | - ["jsonpickle", "decode"] | - ["jsonpickle", "unpickler", "decode"] | - ["pandas", "read_pickle"] => Some(SuspiciousPickleUsage.into()), - // Marshal - ["marshal", "load" | "loads"] => Some(SuspiciousMarshalUsage.into()), - // InsecureHash - ["Crypto" | "Cryptodome", "Hash", "SHA" | "MD2" | "MD3" | "MD4" | "MD5", "new"] | - ["cryptography", "hazmat", "primitives", "hashes", "SHA1" | "MD5"] => Some(SuspiciousInsecureHashUsage.into()), - // InsecureCipher - ["Crypto" | "Cryptodome", "Cipher", "ARC2" | "Blowfish" | "DES" | "XOR", "new"] | - ["cryptography", "hazmat", "primitives", "ciphers", "algorithms", "ARC4" | "Blowfish" | "IDEA" ] => Some(SuspiciousInsecureCipherUsage.into()), - // InsecureCipherMode - ["cryptography", "hazmat", "primitives", "ciphers", "modes", "ECB"] => Some(SuspiciousInsecureCipherModeUsage.into()), - // Mktemp - ["tempfile", "mktemp"] => Some(SuspiciousMktempUsage.into()), - // Eval - ["" | "builtins", "eval"] => Some(SuspiciousEvalUsage.into()), - // MarkSafe - ["django", "utils", "safestring" | "html", "mark_safe"] => Some(SuspiciousMarkSafeUsage.into()), - // URLOpen (`Request`) - ["urllib", "request", "Request"] | - ["six", "moves", "urllib", "request", "Request"] => { + if checker.semantic().in_type_definition() { + return; + } + + let Some(qualified_name) = checker.semantic().resolve_qualified_name(func) else { + return; + }; + + let diagnostic = match qualified_name.segments() { + // Pickle + ["pickle" | "dill", "load" | "loads" | "Unpickler"] + | ["shelve", "open" | "DbfilenameShelf"] + | ["jsonpickle", "decode"] + | ["jsonpickle", "unpickler", "decode"] + | ["pandas", "read_pickle"] => Diagnostic::new(SuspiciousPickleUsage, range), + + // Marshal + ["marshal", "load" | "loads"] => Diagnostic::new(SuspiciousMarshalUsage, range), + + // InsecureHash + [ + "Crypto" | "Cryptodome", + "Hash", + "SHA" | "MD2" | "MD3" | "MD4" | "MD5", + "new", + ] + | [ + "cryptography", + "hazmat", + "primitives", + "hashes", + "SHA1" | "MD5", + ] => Diagnostic::new(SuspiciousInsecureHashUsage, range), + + // InsecureCipher + [ + "Crypto" | "Cryptodome", + "Cipher", + "ARC2" | "Blowfish" | "DES" | "XOR", + "new", + ] + | [ + "cryptography", + "hazmat", + "primitives", + "ciphers", + "algorithms", + "ARC4" | "Blowfish" | "IDEA", + ] => Diagnostic::new(SuspiciousInsecureCipherUsage, range), + + // InsecureCipherMode + [ + "cryptography", + "hazmat", + "primitives", + "ciphers", + "modes", + "ECB", + ] => Diagnostic::new(SuspiciousInsecureCipherModeUsage, range), + + // Mktemp + ["tempfile", "mktemp"] => Diagnostic::new(SuspiciousMktempUsage, range), + + // Eval + ["" | "builtins", "eval"] => Diagnostic::new(SuspiciousEvalUsage, range), + + // MarkSafe + ["django", "utils", "safestring" | "html", "mark_safe"] => { + if let Some(arguments) = arguments { + if let [single] = &*arguments.args { + if single.is_string_literal_expr() { + return; + } + } + } + Diagnostic::new(SuspiciousMarkSafeUsage, range) + } + + // URLOpen (`Request`) + ["urllib", "request", "Request"] | ["six", "moves", "urllib", "request", "Request"] => { + if let Some(arguments) = arguments { // If the `url` argument is a string literal or an f-string, allow `http` and `https` schemes. - if call.arguments.args.iter().all(|arg| !arg.is_starred_expr()) && call.arguments.keywords.iter().all(|keyword| keyword.arg.is_some()) { - if call.arguments.find_argument("url", 0).and_then(leading_chars).is_some_and(has_http_prefix) { - return None; + if arguments.args.iter().all(|arg| !arg.is_starred_expr()) + && arguments + .keywords + .iter() + .all(|keyword| keyword.arg.is_some()) + { + if arguments + .find_argument_value("url", 0) + .and_then(leading_chars) + .is_some_and(has_http_prefix) + { + return; } } - Some(SuspiciousURLOpenUsage.into()) } - // URLOpen (`urlopen`, `urlretrieve`) - ["urllib", "request", "urlopen" | "urlretrieve" ] | - ["six", "moves", "urllib", "request", "urlopen" | "urlretrieve" ] => { - if call.arguments.args.iter().all(|arg| !arg.is_starred_expr()) && call.arguments.keywords.iter().all(|keyword| keyword.arg.is_some()) { - match call.arguments.find_argument("url", 0) { + Diagnostic::new(SuspiciousURLOpenUsage, range) + } + + // URLOpen (`urlopen`, `urlretrieve`) + ["urllib", "request", "urlopen" | "urlretrieve"] + | [ + "six", + "moves", + "urllib", + "request", + "urlopen" | "urlretrieve", + ] => { + if let Some(arguments) = arguments { + if arguments.args.iter().all(|arg| !arg.is_starred_expr()) + && arguments + .keywords + .iter() + .all(|keyword| keyword.arg.is_some()) + { + match arguments.find_argument_value("url", 0) { // If the `url` argument is a `urllib.request.Request` object, allow `http` and `https` schemes. - Some(Expr::Call(ExprCall { func, arguments, .. })) => { - if checker.semantic().resolve_qualified_name(func.as_ref()).is_some_and(|name| name.segments() == ["urllib", "request", "Request"]) { - if arguments.find_argument("url", 0).and_then(leading_chars).is_some_and(has_http_prefix) { - return None; + Some(Expr::Call(ExprCall { + func, arguments, .. + })) => { + if checker + .semantic() + .resolve_qualified_name(func.as_ref()) + .is_some_and(|name| { + name.segments() == ["urllib", "request", "Request"] + }) + { + if arguments + .find_argument_value("url", 0) + .and_then(leading_chars) + .is_some_and(has_http_prefix) + { + return; } } - }, + } // If the `url` argument is a string literal, allow `http` and `https` schemes. Some(expr) => { if leading_chars(expr).is_some_and(has_http_prefix) { - return None; + return; } - }, + } _ => {} } } - Some(SuspiciousURLOpenUsage.into()) - }, - // URLOpen (`URLopener`, `FancyURLopener`) - ["urllib", "request", "URLopener" | "FancyURLopener"] | - ["six", "moves", "urllib", "request", "URLopener" | "FancyURLopener"] => Some(SuspiciousURLOpenUsage.into()), - // NonCryptographicRandom - ["random", "Random" | "random" | "randrange" | "randint" | "choice" | "choices" | "uniform" | "triangular" | "randbytes"] => Some(SuspiciousNonCryptographicRandomUsage.into()), - // UnverifiedContext - ["ssl", "_create_unverified_context"] => Some(SuspiciousUnverifiedContextUsage.into()), - // XMLCElementTree - ["xml", "etree", "cElementTree", "parse" | "iterparse" | "fromstring" | "XMLParser"] => Some(SuspiciousXMLCElementTreeUsage.into()), - // XMLElementTree - ["xml", "etree", "ElementTree", "parse" | "iterparse" | "fromstring" | "XMLParser"] => Some(SuspiciousXMLElementTreeUsage.into()), - // XMLExpatReader - ["xml", "sax", "expatreader", "create_parser"] => Some(SuspiciousXMLExpatReaderUsage.into()), - // XMLExpatBuilder - ["xml", "dom", "expatbuilder", "parse" | "parseString"] => Some(SuspiciousXMLExpatBuilderUsage.into()), - // XMLSax - ["xml", "sax", "parse" | "parseString" | "make_parser"] => Some(SuspiciousXMLSaxUsage.into()), - // XMLMiniDOM - ["xml", "dom", "minidom", "parse" | "parseString"] => Some(SuspiciousXMLMiniDOMUsage.into()), - // XMLPullDOM - ["xml", "dom", "pulldom", "parse" | "parseString"] => Some(SuspiciousXMLPullDOMUsage.into()), - // XMLETree - ["lxml", "etree", "parse" | "fromstring" | "RestrictedElement" | "GlobalParserTLS" | "getDefaultParser" | "check_docinfo"] => Some(SuspiciousXMLETreeUsage.into()), - // Telnet - ["telnetlib", ..] => Some(SuspiciousTelnetUsage.into()), - // FTPLib - ["ftplib", ..] => Some(SuspiciousFTPLibUsage.into()), - _ => None + } + Diagnostic::new(SuspiciousURLOpenUsage, range) } - }) else { - return; + + // URLOpen (`URLopener`, `FancyURLopener`) + ["urllib", "request", "URLopener" | "FancyURLopener"] + | [ + "six", + "moves", + "urllib", + "request", + "URLopener" | "FancyURLopener", + ] => Diagnostic::new(SuspiciousURLOpenUsage, range), + + // NonCryptographicRandom + [ + "random", + "Random" | "random" | "randrange" | "randint" | "choice" | "choices" | "uniform" + | "triangular" | "randbytes", + ] => Diagnostic::new(SuspiciousNonCryptographicRandomUsage, range), + + // UnverifiedContext + ["ssl", "_create_unverified_context"] => { + Diagnostic::new(SuspiciousUnverifiedContextUsage, range) + } + + // XMLCElementTree + [ + "xml", + "etree", + "cElementTree", + "parse" | "iterparse" | "fromstring" | "XMLParser", + ] => Diagnostic::new(SuspiciousXMLCElementTreeUsage, range), + + // XMLElementTree + [ + "xml", + "etree", + "ElementTree", + "parse" | "iterparse" | "fromstring" | "XMLParser", + ] => Diagnostic::new(SuspiciousXMLElementTreeUsage, range), + + // XMLExpatReader + ["xml", "sax", "expatreader", "create_parser"] => { + Diagnostic::new(SuspiciousXMLExpatReaderUsage, range) + } + + // XMLExpatBuilder + ["xml", "dom", "expatbuilder", "parse" | "parseString"] => { + Diagnostic::new(SuspiciousXMLExpatBuilderUsage, range) + } + + // XMLSax + ["xml", "sax", "parse" | "parseString" | "make_parser"] => { + Diagnostic::new(SuspiciousXMLSaxUsage, range) + } + + // XMLMiniDOM + ["xml", "dom", "minidom", "parse" | "parseString"] => { + Diagnostic::new(SuspiciousXMLMiniDOMUsage, range) + } + + // XMLPullDOM + ["xml", "dom", "pulldom", "parse" | "parseString"] => { + Diagnostic::new(SuspiciousXMLPullDOMUsage, range) + } + + // XMLETree + [ + "lxml", + "etree", + "parse" | "fromstring" | "RestrictedElement" | "GlobalParserTLS" | "getDefaultParser" + | "check_docinfo", + ] => Diagnostic::new(SuspiciousXMLETreeUsage, range), + + // Telnet + ["telnetlib", ..] => Diagnostic::new(SuspiciousTelnetUsage, range), + + // FTPLib + ["ftplib", ..] => Diagnostic::new(SuspiciousFTPLibUsage, range), + + _ => return, }; - let diagnostic = Diagnostic::new::<DiagnosticKind>(diagnostic_kind, call.range()); - if checker.enabled(diagnostic.kind.rule()) { - checker.diagnostics.push(diagnostic); + if checker.enabled(diagnostic.rule()) { + checker.report_diagnostic(diagnostic); } } /// S308 -pub(crate) fn suspicious_function_decorator(checker: &mut Checker, decorator: &Decorator) { - let Some(diagnostic_kind) = checker - .semantic() - .resolve_qualified_name(&decorator.expression) - .and_then(|qualified_name| { - match qualified_name.segments() { - // MarkSafe - ["django", "utils", "safestring" | "html", "mark_safe"] => { - Some(SuspiciousMarkSafeUsage.into()) - } - _ => None, - } - }) - else { - return; - }; - - let diagnostic = Diagnostic::new::<DiagnosticKind>(diagnostic_kind, decorator.range()); - if checker.enabled(diagnostic.kind.rule()) { - checker.diagnostics.push(diagnostic); +pub(crate) fn suspicious_function_decorator(checker: &Checker, decorator: &Decorator) { + // In preview mode, references are handled collectively by `suspicious_function_reference` + if !is_suspicious_function_reference_enabled(checker.settings) { + suspicious_function(checker, &decorator.expression, None, decorator.range); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_imports.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_imports.rs index 1754f1ac6e242..5b3522c56ed07 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_imports.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/suspicious_imports.rs @@ -1,8 +1,8 @@ //! Check for imports of or from suspicious modules. //! //! See: <https://bandit.readthedocs.io/en/latest/blacklists/blacklist_imports.html> -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::{Ranged, TextRange}; @@ -10,23 +10,28 @@ use crate::checkers::ast::Checker; use crate::registry::AsRule; /// ## What it does -/// Checks for imports of the`telnetlib` module. +/// Checks for imports of the `telnetlib` module. /// /// ## Why is this bad? -/// Telnet is considered insecure. Instead, use SSH or another encrypted +/// Telnet is considered insecure. It is deprecated since version 3.11, and +/// was removed in version 3.13. Instead, use SSH or another encrypted /// protocol. /// /// ## Example /// ```python /// import telnetlib /// ``` -#[violation] -pub struct SuspiciousTelnetlibImport; +/// +/// ## References +/// - [Python documentation: `telnetlib` - Telnet client](https://docs.python.org/3.12/library/telnetlib.html#module-telnetlib) +/// - [PEP 594: `telnetlib`](https://peps.python.org/pep-0594/#telnetlib) +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousTelnetlibImport; impl Violation for SuspiciousTelnetlibImport { #[derive_message_formats] fn message(&self) -> String { - format!("`telnetlib` and related modules are considered insecure. Use SSH or another encrypted protocol.") + "`telnetlib` and related modules are considered insecure. Use SSH or another encrypted protocol.".to_string() } } @@ -41,13 +46,16 @@ impl Violation for SuspiciousTelnetlibImport { /// ```python /// import ftplib /// ``` -#[violation] -pub struct SuspiciousFtplibImport; +/// +/// ## References +/// - [Python documentation: `ftplib` - FTP protocol client](https://docs.python.org/3/library/ftplib.html) +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousFtplibImport; impl Violation for SuspiciousFtplibImport { #[derive_message_formats] fn message(&self) -> String { - format!("`ftplib` and related modules are considered insecure. Use SSH, SFTP, SCP, or another encrypted protocol.") + "`ftplib` and related modules are considered insecure. Use SSH, SFTP, SCP, or another encrypted protocol.".to_string() } } @@ -63,15 +71,16 @@ impl Violation for SuspiciousFtplibImport { /// ```python /// import pickle /// ``` -/// /// ## References -/// - [Python Docs](https://docs.python.org/3/library/pickle.html) -#[violation] -pub struct SuspiciousPickleImport; +/// +/// ## References +/// - [Python documentation: `pickle` — Python object serialization](https://docs.python.org/3/library/pickle.html) +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousPickleImport; impl Violation for SuspiciousPickleImport { #[derive_message_formats] fn message(&self) -> String { - format!("`pickle`, `cPickle`, `dill`, and `shelve` modules are possibly insecure") + "`pickle`, `cPickle`, `dill`, and `shelve` modules are possibly insecure".to_string() } } @@ -86,13 +95,13 @@ impl Violation for SuspiciousPickleImport { /// ```python /// import subprocess /// ``` -#[violation] -pub struct SuspiciousSubprocessImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousSubprocessImport; impl Violation for SuspiciousSubprocessImport { #[derive_message_formats] fn message(&self) -> String { - format!("`subprocess` module is possibly insecure") + "`subprocess` module is possibly insecure".to_string() } } @@ -109,13 +118,13 @@ impl Violation for SuspiciousSubprocessImport { /// ```python /// import xml.etree.cElementTree /// ``` -#[violation] -pub struct SuspiciousXmlEtreeImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlEtreeImport; impl Violation for SuspiciousXmlEtreeImport { #[derive_message_formats] fn message(&self) -> String { - format!("`xml.etree` methods are vulnerable to XML attacks") + "`xml.etree` methods are vulnerable to XML attacks".to_string() } } @@ -132,13 +141,13 @@ impl Violation for SuspiciousXmlEtreeImport { /// ```python /// import xml.sax /// ``` -#[violation] -pub struct SuspiciousXmlSaxImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlSaxImport; impl Violation for SuspiciousXmlSaxImport { #[derive_message_formats] fn message(&self) -> String { - format!("`xml.sax` methods are vulnerable to XML attacks") + "`xml.sax` methods are vulnerable to XML attacks".to_string() } } @@ -155,13 +164,13 @@ impl Violation for SuspiciousXmlSaxImport { /// ```python /// import xml.dom.expatbuilder /// ``` -#[violation] -pub struct SuspiciousXmlExpatImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlExpatImport; impl Violation for SuspiciousXmlExpatImport { #[derive_message_formats] fn message(&self) -> String { - format!("`xml.dom.expatbuilder` is vulnerable to XML attacks") + "`xml.dom.expatbuilder` is vulnerable to XML attacks".to_string() } } @@ -178,13 +187,13 @@ impl Violation for SuspiciousXmlExpatImport { /// ```python /// import xml.dom.minidom /// ``` -#[violation] -pub struct SuspiciousXmlMinidomImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlMinidomImport; impl Violation for SuspiciousXmlMinidomImport { #[derive_message_formats] fn message(&self) -> String { - format!("`xml.dom.minidom` is vulnerable to XML attacks") + "`xml.dom.minidom` is vulnerable to XML attacks".to_string() } } @@ -201,13 +210,13 @@ impl Violation for SuspiciousXmlMinidomImport { /// ```python /// import xml.dom.pulldom /// ``` -#[violation] -pub struct SuspiciousXmlPulldomImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlPulldomImport; impl Violation for SuspiciousXmlPulldomImport { #[derive_message_formats] fn message(&self) -> String { - format!("`xml.dom.pulldom` is vulnerable to XML attacks") + "`xml.dom.pulldom` is vulnerable to XML attacks".to_string() } } @@ -231,13 +240,13 @@ impl Violation for SuspiciousXmlPulldomImport { /// ``` /// /// [deprecated]: https://github.com/tiran/defusedxml/blob/c7445887f5e1bcea470a16f61369d29870cfcfe1/README.md#defusedxmllxml -#[violation] -pub struct SuspiciousLxmlImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousLxmlImport; impl Violation for SuspiciousLxmlImport { #[derive_message_formats] fn message(&self) -> String { - format!("`lxml` is vulnerable to XML attacks") + "`lxml` is vulnerable to XML attacks".to_string() } } @@ -254,13 +263,13 @@ impl Violation for SuspiciousLxmlImport { /// ```python /// import xmlrpc /// ``` -#[violation] -pub struct SuspiciousXmlrpcImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousXmlrpcImport; impl Violation for SuspiciousXmlrpcImport { #[derive_message_formats] fn message(&self) -> String { - format!("XMLRPC is vulnerable to remote XML attacks") + "XMLRPC is vulnerable to remote XML attacks".to_string() } } @@ -280,13 +289,13 @@ impl Violation for SuspiciousXmlrpcImport { /// /// ## References /// - [httpoxy website](https://httpoxy.org/) -#[violation] -pub struct SuspiciousHttpoxyImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousHttpoxyImport; impl Violation for SuspiciousHttpoxyImport { #[derive_message_formats] fn message(&self) -> String { - format!("`httpoxy` is a set of vulnerabilities that affect application code running inCGI, or CGI-like environments. The use of CGI for web applications should be avoided") + "`httpoxy` is a set of vulnerabilities that affect application code running inCGI, or CGI-like environments. The use of CGI for web applications should be avoided".to_string() } } @@ -305,15 +314,14 @@ impl Violation for SuspiciousHttpoxyImport { /// /// ## References /// - [Buffer Overflow Issue](https://github.com/pycrypto/pycrypto/issues/176) -#[violation] -pub struct SuspiciousPycryptoImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousPycryptoImport; impl Violation for SuspiciousPycryptoImport { #[derive_message_formats] fn message(&self) -> String { - format!( - "`pycrypto` library is known to have publicly disclosed buffer overflow vulnerability" - ) + "`pycrypto` library is known to have publicly disclosed buffer overflow vulnerability" + .to_string() } } @@ -331,92 +339,66 @@ impl Violation for SuspiciousPycryptoImport { /// /// ## References /// - [Buffer Overflow Issue](https://github.com/pycrypto/pycrypto/issues/176) -#[violation] -pub struct SuspiciousPyghmiImport; +#[derive(ViolationMetadata)] +pub(crate) struct SuspiciousPyghmiImport; impl Violation for SuspiciousPyghmiImport { #[derive_message_formats] fn message(&self) -> String { - format!("An IPMI-related module is being imported. Prefer an encrypted protocol over IPMI.") + "An IPMI-related module is being imported. Prefer an encrypted protocol over IPMI." + .to_string() } } /// S401, S402, S403, S404, S405, S406, S407, S408, S409, S410, S411, S412, S413, S415 -pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn suspicious_imports(checker: &Checker, stmt: &Stmt) { + // Skip stub files. + if checker.source_type.is_stub() { + return; + } + match stmt { Stmt::Import(ast::StmtImport { names, .. }) => { for name in names { match name.name.as_str() { - "telnetlib" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousTelnetlibImport), - name.range, - ), - "ftplib" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousFtplibImport), - name.range, - ), - "pickle" | "cPickle" | "dill" | "shelve" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousPickleImport), - name.range, - ), - "subprocess" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousSubprocessImport), - name.range, - ), + "telnetlib" => { + check_and_push_diagnostic(checker, SuspiciousTelnetlibImport, name.range); + } + "ftplib" => { + check_and_push_diagnostic(checker, SuspiciousFtplibImport, name.range); + } + "pickle" | "cPickle" | "dill" | "shelve" => { + check_and_push_diagnostic(checker, SuspiciousPickleImport, name.range); + } + "subprocess" => { + check_and_push_diagnostic(checker, SuspiciousSubprocessImport, name.range); + } "xml.etree.cElementTree" | "xml.etree.ElementTree" => { - check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlEtreeImport), - name.range, - ); + check_and_push_diagnostic(checker, SuspiciousXmlEtreeImport, name.range); + } + "xml.sax" => { + check_and_push_diagnostic(checker, SuspiciousXmlSaxImport, name.range); + } + "xml.dom.expatbuilder" => { + check_and_push_diagnostic(checker, SuspiciousXmlExpatImport, name.range); + } + "xml.dom.minidom" => { + check_and_push_diagnostic(checker, SuspiciousXmlMinidomImport, name.range); + } + "xml.dom.pulldom" => { + check_and_push_diagnostic(checker, SuspiciousXmlPulldomImport, name.range); + } + "lxml" => check_and_push_diagnostic(checker, SuspiciousLxmlImport, name.range), + "xmlrpc" => { + check_and_push_diagnostic(checker, SuspiciousXmlrpcImport, name.range); } - "xml.sax" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlSaxImport), - name.range, - ), - "xml.dom.expatbuilder" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlExpatImport), - name.range, - ), - "xml.dom.minidom" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlMinidomImport), - name.range, - ), - "xml.dom.pulldom" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlPulldomImport), - name.range, - ), - "lxml" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousLxmlImport), - name.range, - ), - "xmlrpc" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlrpcImport), - name.range, - ), "Crypto.Cipher" | "Crypto.Hash" | "Crypto.IO" | "Crypto.Protocol" | "Crypto.PublicKey" | "Crypto.Random" | "Crypto.Signature" | "Crypto.Util" => { - check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousPycryptoImport), - name.range, - ); + check_and_push_diagnostic(checker, SuspiciousPycryptoImport, name.range); + } + "pyghmi" => { + check_and_push_diagnostic(checker, SuspiciousPyghmiImport, name.range); } - "pyghmi" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousPyghmiImport), - name.range, - ), _ => {} } } @@ -426,22 +408,18 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { match identifier.as_str() { "telnetlib" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousTelnetlibImport), - identifier.range(), - ), - "ftplib" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousFtplibImport), - identifier.range(), - ), - "pickle" | "cPickle" | "dill" | "shelve" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousPickleImport), + SuspiciousTelnetlibImport, identifier.range(), ), + "ftplib" => { + check_and_push_diagnostic(checker, SuspiciousFtplibImport, identifier.range()); + } + "pickle" | "cPickle" | "dill" | "shelve" => { + check_and_push_diagnostic(checker, SuspiciousPickleImport, identifier.range()); + } "subprocess" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousSubprocessImport), + SuspiciousSubprocessImport, identifier.range(), ), "xml.etree" => { @@ -449,7 +427,7 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { if matches!(name.name.as_str(), "cElementTree" | "ElementTree") { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlEtreeImport), + SuspiciousXmlEtreeImport, identifier.range(), ); } @@ -458,7 +436,7 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { "xml.etree.cElementTree" | "xml.etree.ElementTree" => { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlEtreeImport), + SuspiciousXmlEtreeImport, identifier.range(), ); } @@ -467,70 +445,66 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { if name.name.as_str() == "sax" { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlSaxImport), + SuspiciousXmlSaxImport, identifier.range(), ); } } } - "xml.sax" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlSaxImport), - identifier.range(), - ), + "xml.sax" => { + check_and_push_diagnostic(checker, SuspiciousXmlSaxImport, identifier.range()); + } "xml.dom" => { for name in names { match name.name.as_str() { "expatbuilder" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlExpatImport), + SuspiciousXmlExpatImport, identifier.range(), ), "minidom" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlMinidomImport), + SuspiciousXmlMinidomImport, identifier.range(), ), "pulldom" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlPulldomImport), + SuspiciousXmlPulldomImport, identifier.range(), ), _ => (), } } } - "xml.dom.expatbuilder" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlExpatImport), - identifier.range(), - ), + "xml.dom.expatbuilder" => { + check_and_push_diagnostic( + checker, + SuspiciousXmlExpatImport, + identifier.range(), + ); + } "xml.dom.minidom" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlMinidomImport), + SuspiciousXmlMinidomImport, identifier.range(), ), "xml.dom.pulldom" => check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousXmlPulldomImport), - identifier.range(), - ), - "lxml" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousLxmlImport), - identifier.range(), - ), - "xmlrpc" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousXmlrpcImport), + SuspiciousXmlPulldomImport, identifier.range(), ), + "lxml" => { + check_and_push_diagnostic(checker, SuspiciousLxmlImport, identifier.range()); + } + "xmlrpc" => { + check_and_push_diagnostic(checker, SuspiciousXmlrpcImport, identifier.range()); + } "wsgiref.handlers" => { for name in names { if name.name.as_str() == "CGIHandler" { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousHttpoxyImport), + SuspiciousHttpoxyImport, identifier.range(), ); } @@ -541,7 +515,7 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { if name.name.as_str() == "CGIScript" { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousHttpoxyImport), + SuspiciousHttpoxyImport, identifier.range(), ); } @@ -562,7 +536,7 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { ) { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousPycryptoImport), + SuspiciousPycryptoImport, identifier.range(), ); } @@ -572,29 +546,23 @@ pub(crate) fn suspicious_imports(checker: &mut Checker, stmt: &Stmt) { | "Crypto.PublicKey" | "Crypto.Random" | "Crypto.Signature" | "Crypto.Util" => { check_and_push_diagnostic( checker, - DiagnosticKind::from(SuspiciousPycryptoImport), + SuspiciousPycryptoImport, identifier.range(), ); } - "pyghmi" => check_and_push_diagnostic( - checker, - DiagnosticKind::from(SuspiciousPyghmiImport), - identifier.range(), - ), + "pyghmi" => { + check_and_push_diagnostic(checker, SuspiciousPyghmiImport, identifier.range()); + } _ => {} } } _ => panic!("Expected Stmt::Import | Stmt::ImportFrom"), - }; + } } -fn check_and_push_diagnostic( - checker: &mut Checker, - diagnostic_kind: DiagnosticKind, - range: TextRange, -) { - let diagnostic = Diagnostic::new::<DiagnosticKind>(diagnostic_kind, range); - if checker.enabled(diagnostic.kind.rule()) { - checker.diagnostics.push(diagnostic); +fn check_and_push_diagnostic<T: Violation>(checker: &Checker, diagnostic: T, range: TextRange) { + let diagnostic = Diagnostic::new(diagnostic, range); + if checker.enabled(diagnostic.rule()) { + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/tarfile_unsafe_members.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/tarfile_unsafe_members.rs index e232c2fa72da5..f4d938097151f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/tarfile_unsafe_members.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/tarfile_unsafe_members.rs @@ -1,7 +1,7 @@ use crate::checkers::ast::Checker; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -33,30 +33,30 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Common Weakness Enumeration: CWE-22](https://cwe.mitre.org/data/definitions/22.html) -/// - [Python Documentation: `TarFile.extractall`](https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extractall) -/// - [Python Documentation: Extraction filters](https://docs.python.org/3/library/tarfile.html#tarfile-extraction-filter) +/// - [Python documentation: `TarFile.extractall`](https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extractall) +/// - [Python documentation: Extraction filters](https://docs.python.org/3/library/tarfile.html#tarfile-extraction-filter) /// /// [PEP 706]: https://peps.python.org/pep-0706/#backporting-forward-compatibility -#[violation] -pub struct TarfileUnsafeMembers; +#[derive(ViolationMetadata)] +pub(crate) struct TarfileUnsafeMembers; impl Violation for TarfileUnsafeMembers { #[derive_message_formats] fn message(&self) -> String { - format!("Uses of `tarfile.extractall()`") + "Uses of `tarfile.extractall()`".to_string() } } /// S202 -pub(crate) fn tarfile_unsafe_members(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn tarfile_unsafe_members(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::TARFILE) { return; } - if !call + if call .func .as_attribute_expr() - .is_some_and(|attr| attr.attr.as_str() == "extractall") + .is_none_or(|attr| attr.attr.as_str() != "extractall") { return; } @@ -70,7 +70,5 @@ pub(crate) fn tarfile_unsafe_members(checker: &mut Checker, call: &ast::ExprCall return; } - checker - .diagnostics - .push(Diagnostic::new(TarfileUnsafeMembers, call.func.range())); + checker.report_diagnostic(Diagnostic::new(TarfileUnsafeMembers, call.func.range())); } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_continue.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_continue.rs index 7c73f1cc5aed0..193c797a09a10 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_continue.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_continue.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{ExceptHandler, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -38,22 +38,25 @@ use crate::rules::flake8_bandit::helpers::is_untyped_exception; /// logging.exception("Error occurred") /// ``` /// +/// ## Options +/// - `lint.flake8-bandit.check-typed-exception` +/// /// ## References /// - [Common Weakness Enumeration: CWE-703](https://cwe.mitre.org/data/definitions/703.html) /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) -#[violation] -pub struct TryExceptContinue; +#[derive(ViolationMetadata)] +pub(crate) struct TryExceptContinue; impl Violation for TryExceptContinue { #[derive_message_formats] fn message(&self) -> String { - format!("`try`-`except`-`continue` detected, consider logging the exception") + "`try`-`except`-`continue` detected, consider logging the exception".to_string() } } /// S112 pub(crate) fn try_except_continue( - checker: &mut Checker, + checker: &Checker, except_handler: &ExceptHandler, type_: Option<&Expr>, body: &[Stmt], @@ -61,9 +64,7 @@ pub(crate) fn try_except_continue( ) { if matches!(body, [Stmt::Continue(_)]) { if check_typed_exception || is_untyped_exception(type_, checker.semantic()) { - checker - .diagnostics - .push(Diagnostic::new(TryExceptContinue, except_handler.range())); + checker.report_diagnostic(Diagnostic::new(TryExceptContinue, except_handler.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_pass.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_pass.rs index 02ecf816e4371..ff48968c985b4 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_pass.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/try_except_pass.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{ExceptHandler, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -34,22 +34,25 @@ use crate::rules::flake8_bandit::helpers::is_untyped_exception; /// logging.exception("Exception occurred") /// ``` /// +/// ## Options +/// - `lint.flake8-bandit.check-typed-exception` +/// /// ## References /// - [Common Weakness Enumeration: CWE-703](https://cwe.mitre.org/data/definitions/703.html) /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) -#[violation] -pub struct TryExceptPass; +#[derive(ViolationMetadata)] +pub(crate) struct TryExceptPass; impl Violation for TryExceptPass { #[derive_message_formats] fn message(&self) -> String { - format!("`try`-`except`-`pass` detected, consider logging the exception") + "`try`-`except`-`pass` detected, consider logging the exception".to_string() } } /// S110 pub(crate) fn try_except_pass( - checker: &mut Checker, + checker: &Checker, except_handler: &ExceptHandler, type_: Option<&Expr>, body: &[Stmt], @@ -57,9 +60,7 @@ pub(crate) fn try_except_pass( ) { if matches!(body, [Stmt::Pass(_)]) { if check_typed_exception || is_untyped_exception(type_, checker.semantic()) { - checker - .diagnostics - .push(Diagnostic::new(TryExceptPass, except_handler.range())); + checker.report_diagnostic(Diagnostic::new(TryExceptPass, except_handler.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_markup_use.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_markup_use.rs new file mode 100644 index 0000000000000..7c9cac7921bb3 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_markup_use.rs @@ -0,0 +1,160 @@ +use ruff_python_ast::{Expr, ExprCall}; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::name::QualifiedName; +use ruff_python_semantic::{Modules, SemanticModel}; +use ruff_text_size::Ranged; + +use crate::{checkers::ast::Checker, settings::LinterSettings}; + +/// ## What it does +/// Checks for non-literal strings being passed to [`markupsafe.Markup`][markupsafe-markup]. +/// +/// ## Why is this bad? +/// [`markupsafe.Markup`] does not perform any escaping, so passing dynamic +/// content, like f-strings, variables or interpolated strings will potentially +/// lead to XSS vulnerabilities. +/// +/// Instead you should interpolate the `Markup` object. +/// +/// Using [`lint.flake8-bandit.extend-markup-names`] additional objects can be +/// treated like `Markup`. +/// +/// This rule was originally inspired by [flake8-markupsafe] but doesn't carve +/// out any exceptions for i18n related calls by default. +/// +/// You can use [`lint.flake8-bandit.allowed-markup-calls`] to specify exceptions. +/// +/// ## Example +/// Given: +/// ```python +/// from markupsafe import Markup +/// +/// content = "<script>alert('Hello, world!')</script>" +/// html = Markup(f"<b>{content}</b>") # XSS +/// ``` +/// +/// Use instead: +/// ```python +/// from markupsafe import Markup +/// +/// content = "<script>alert('Hello, world!')</script>" +/// html = Markup("<b>{}</b>").format(content) # Safe +/// ``` +/// +/// Given: +/// ```python +/// from markupsafe import Markup +/// +/// lines = [ +/// Markup("<b>heading</b>"), +/// "<script>alert('XSS attempt')</script>", +/// ] +/// html = Markup("<br>".join(lines)) # XSS +/// ``` +/// +/// Use instead: +/// ```python +/// from markupsafe import Markup +/// +/// lines = [ +/// Markup("<b>heading</b>"), +/// "<script>alert('XSS attempt')</script>", +/// ] +/// html = Markup("<br>").join(lines) # Safe +/// ``` +/// ## Options +/// - `lint.flake8-bandit.extend-markup-names` +/// - `lint.flake8-bandit.allowed-markup-calls` +/// +/// ## References +/// - [MarkupSafe on PyPI](https://pypi.org/project/MarkupSafe/) +/// - [`markupsafe.Markup` API documentation](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup) +/// +/// [markupsafe-markup]: https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup +/// [flake8-markupsafe]: https://github.com/vmagamedov/flake8-markupsafe +#[derive(ViolationMetadata)] +pub(crate) struct UnsafeMarkupUse { + name: String, +} + +impl Violation for UnsafeMarkupUse { + #[derive_message_formats] + fn message(&self) -> String { + let UnsafeMarkupUse { name } = self; + format!("Unsafe use of `{name}` detected") + } +} + +/// S704 +pub(crate) fn unsafe_markup_call(checker: &Checker, call: &ExprCall) { + if checker + .settings + .flake8_bandit + .extend_markup_names + .is_empty() + && !(checker.semantic().seen_module(Modules::MARKUPSAFE) + || checker.semantic().seen_module(Modules::FLASK)) + { + return; + } + + if !is_unsafe_call(call, checker.semantic(), checker.settings) { + return; + } + + let Some(qualified_name) = checker.semantic().resolve_qualified_name(&call.func) else { + return; + }; + + if !is_markup_call(&qualified_name, checker.settings) { + return; + } + + checker.report_diagnostic(Diagnostic::new( + UnsafeMarkupUse { + name: qualified_name.to_string(), + }, + call.range(), + )); +} + +fn is_markup_call(qualified_name: &QualifiedName, settings: &LinterSettings) -> bool { + matches!( + qualified_name.segments(), + ["markupsafe" | "flask", "Markup"] + ) || settings + .flake8_bandit + .extend_markup_names + .iter() + .map(|target| QualifiedName::from_dotted_name(target)) + .any(|target| *qualified_name == target) +} + +fn is_unsafe_call(call: &ExprCall, semantic: &SemanticModel, settings: &LinterSettings) -> bool { + // technically this could be circumvented by using a keyword argument + // but without type-inference we can't really know which keyword argument + // corresponds to the first positional argument and either way it is + // unlikely that someone will actually use a keyword argument here + // TODO: Eventually we may want to allow dynamic values, as long as they + // have a __html__ attribute, since that is part of the API + matches!(&*call.arguments.args, [first] if !first.is_string_literal_expr() && !first.is_bytes_literal_expr() && !is_whitelisted_call(first, semantic, settings)) +} + +fn is_whitelisted_call(expr: &Expr, semantic: &SemanticModel, settings: &LinterSettings) -> bool { + let Expr::Call(ExprCall { func, .. }) = expr else { + return false; + }; + + let Some(qualified_name) = semantic.resolve_qualified_name(func) else { + return false; + }; + + settings + .flake8_bandit + .allowed_markup_calls + .iter() + .map(|target| QualifiedName::from_dotted_name(target)) + .any(|target| qualified_name == target) +} diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_yaml_load.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_yaml_load.rs index f63e134b333f3..00a3df81a2929 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_yaml_load.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/unsafe_yaml_load.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -34,38 +34,38 @@ use crate::checkers::ast::Checker; /// ## References /// - [PyYAML documentation: Loading YAML](https://pyyaml.org/wiki/PyYAMLDocumentation) /// - [Common Weakness Enumeration: CWE-20](https://cwe.mitre.org/data/definitions/20.html) -#[violation] -pub struct UnsafeYAMLLoad { +#[derive(ViolationMetadata)] +pub(crate) struct UnsafeYAMLLoad { pub loader: Option<String>, } impl Violation for UnsafeYAMLLoad { #[derive_message_formats] fn message(&self) -> String { - let UnsafeYAMLLoad { loader } = self; - match loader { + match &self.loader { Some(name) => { format!( "Probable use of unsafe loader `{name}` with `yaml.load`. Allows \ instantiation of arbitrary objects. Consider `yaml.safe_load`." ) } - None => format!( + None => { "Probable use of unsafe `yaml.load`. Allows instantiation of arbitrary objects. \ Consider `yaml.safe_load`." - ), + .to_string() + } } } } /// S506 -pub(crate) fn unsafe_yaml_load(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unsafe_yaml_load(checker: &Checker, call: &ast::ExprCall) { if checker .semantic() .resolve_qualified_name(&call.func) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["yaml", "load"])) { - if let Some(loader_arg) = call.arguments.find_argument("Loader", 1) { + if let Some(loader_arg) = call.arguments.find_argument_value("Loader", 1) { if !checker .semantic() .resolve_qualified_name(loader_arg) @@ -82,13 +82,13 @@ pub(crate) fn unsafe_yaml_load(checker: &mut Checker, call: &ast::ExprCall) { Expr::Name(ast::ExprName { id, .. }) => Some(id.to_string()), _ => None, }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnsafeYAMLLoad { loader }, loader_arg.range(), )); } } else { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnsafeYAMLLoad { loader: None }, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bandit/rules/weak_cryptographic_key.rs b/crates/ruff_linter/src/rules/flake8_bandit/rules/weak_cryptographic_key.rs index 48137db7fb4d0..47cc09a9ddf9f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/rules/weak_cryptographic_key.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/rules/weak_cryptographic_key.rs @@ -1,7 +1,7 @@ use std::fmt::{Display, Formatter}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprAttribute, ExprCall}; use ruff_text_size::{Ranged, TextRange}; @@ -32,8 +32,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [CSRC: Transitioning the Use of Cryptographic Algorithms and Key Lengths](https://csrc.nist.gov/pubs/sp/800/131/a/r2/final) -#[violation] -pub struct WeakCryptographicKey { +#[derive(ViolationMetadata)] +pub(crate) struct WeakCryptographicKey { cryptographic_key: CryptographicKey, } @@ -49,13 +49,13 @@ impl Violation for WeakCryptographicKey { } /// S505 -pub(crate) fn weak_cryptographic_key(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn weak_cryptographic_key(checker: &Checker, call: &ExprCall) { let Some((cryptographic_key, range)) = extract_cryptographic_key(checker, call) else { return; }; if cryptographic_key.is_vulnerable() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( WeakCryptographicKey { cryptographic_key }, range, )); @@ -98,42 +98,47 @@ impl Display for CryptographicKey { } fn extract_cryptographic_key( - checker: &mut Checker, + checker: &Checker, call: &ExprCall, ) -> Option<(CryptographicKey, TextRange)> { let qualified_name = checker.semantic().resolve_qualified_name(&call.func)?; match qualified_name.segments() { - ["cryptography", "hazmat", "primitives", "asymmetric", function, "generate_private_key"] => { - match *function { - "dsa" => { - let (key_size, range) = extract_int_argument(call, "key_size", 0)?; - Some((CryptographicKey::Dsa { key_size }, range)) - } - "rsa" => { - let (key_size, range) = extract_int_argument(call, "key_size", 1)?; - Some((CryptographicKey::Rsa { key_size }, range)) - } - "ec" => { - let argument = call.arguments.find_argument("curve", 0)?; - let ExprAttribute { attr, value, .. } = argument.as_attribute_expr()?; - let qualified_name = checker.semantic().resolve_qualified_name(value)?; - if matches!( - qualified_name.segments(), - ["cryptography", "hazmat", "primitives", "asymmetric", "ec"] - ) { - Some(( - CryptographicKey::Ec { - algorithm: attr.to_string(), - }, - argument.range(), - )) - } else { - None - } + [ + "cryptography", + "hazmat", + "primitives", + "asymmetric", + function, + "generate_private_key", + ] => match *function { + "dsa" => { + let (key_size, range) = extract_int_argument(call, "key_size", 0)?; + Some((CryptographicKey::Dsa { key_size }, range)) + } + "rsa" => { + let (key_size, range) = extract_int_argument(call, "key_size", 1)?; + Some((CryptographicKey::Rsa { key_size }, range)) + } + "ec" => { + let argument = call.arguments.find_argument_value("curve", 0)?; + let ExprAttribute { attr, value, .. } = argument.as_attribute_expr()?; + let qualified_name = checker.semantic().resolve_qualified_name(value)?; + if matches!( + qualified_name.segments(), + ["cryptography", "hazmat", "primitives", "asymmetric", "ec"] + ) { + Some(( + CryptographicKey::Ec { + algorithm: attr.to_string(), + }, + argument.range(), + )) + } else { + None } - _ => None, } - } + _ => None, + }, ["Crypto" | "Cryptodome", "PublicKey", function, "generate"] => match *function { "DSA" => { let (key_size, range) = extract_int_argument(call, "bits", 0)?; @@ -150,7 +155,7 @@ fn extract_cryptographic_key( } fn extract_int_argument(call: &ExprCall, name: &str, position: usize) -> Option<(u16, TextRange)> { - let argument = call.arguments.find_argument(name, position)?; + let argument = call.arguments.find_argument_value(name, position)?; let Expr::NumberLiteral(ast::ExprNumberLiteral { value: ast::Number::Int(i), .. diff --git a/crates/ruff_linter/src/rules/flake8_bandit/settings.rs b/crates/ruff_linter/src/rules/flake8_bandit/settings.rs index ee96e6ee667d2..b8e447c172582 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_bandit/settings.rs @@ -14,6 +14,8 @@ pub fn default_tmp_dirs() -> Vec<String> { pub struct Settings { pub hardcoded_tmp_directory: Vec<String>, pub check_typed_exception: bool, + pub extend_markup_names: Vec<String>, + pub allowed_markup_calls: Vec<String>, } impl Default for Settings { @@ -21,6 +23,8 @@ impl Default for Settings { Self { hardcoded_tmp_directory: default_tmp_dirs(), check_typed_exception: false, + extend_markup_names: vec![], + allowed_markup_calls: vec![], } } } @@ -32,7 +36,9 @@ impl Display for Settings { namespace = "linter.flake8_bandit", fields = [ self.hardcoded_tmp_directory | array, - self.check_typed_exception + self.check_typed_exception, + self.extend_markup_names | array, + self.allowed_markup_calls | array, ] } Ok(()) diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S101_S101.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S101_S101.py.snap index d879988b2798c..899d296ad8ab6 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S101_S101.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S101_S101.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S101.py:1:1: S101 Use of `assert` detected | @@ -23,5 +24,3 @@ S101.py:7:5: S101 Use of `assert` detected 7 | assert x == 2 # S101 | ^^^^^^ S101 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S102_S102.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S102_S102.py.snap index ee1dd35169bc0..317ef1d7f496b 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S102_S102.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S102_S102.py.snap @@ -7,16 +7,24 @@ S102.py:3:5: S102 Use of `exec` detected 2 | # Error 3 | exec('x = 2') | ^^^^ S102 -4 | +4 | 5 | exec('y = 3') | S102.py:5:1: S102 Use of `exec` detected | 3 | exec('x = 2') -4 | +4 | 5 | exec('y = 3') | ^^^^ S102 | - +S102.py:11:5: S102 Use of `exec` detected + | + 9 | def _(): +10 | from builtins import exec +11 | exec('') # Error + | ^^^^ S102 +12 | +13 | def _(): + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S103_S103.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S103_S103.py.snap index b3da522349858..f400e65f28dea 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S103_S103.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S103_S103.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S103.py:6:25: S103 `os.chmod` setting a permissive mask `0o227` on file or directory | 4 | keyfile = "foo" -5 | +5 | 6 | os.chmod("/etc/passwd", 0o227) # Error | ^^^^^ S103 7 | os.chmod("/etc/passwd", 0o7) # Error @@ -136,5 +136,3 @@ S103.py:23:25: S103 `os.chmod` setting an invalid mask on file or directory 23 | os.chmod("/etc/passwd", 0o100000000) # Error | ^^^^^^^^^^^ S103 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S104_S104.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S104_S104.py.snap index 3f87d24d80ef0..15fec6bd70646 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S104_S104.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S104_S104.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S104.py:9:1: S104 Possible binding to all interfaces | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S105_S105.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S105_S105.py.snap index 0da22947637c6..851cb57409bc7 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S105_S105.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S105_S105.py.snap @@ -97,6 +97,7 @@ S105.py:22:12: S105 Possible hardcoded password assigned to: "PASSWORD" 22 | PASSWORD = "s3cr3t" | ^^^^^^^^ S105 23 | PassWord = "s3cr3t" +24 | password: str = "s3cr3t" | S105.py:23:12: S105 Possible hardcoded password assigned to: "PassWord" @@ -105,273 +106,290 @@ S105.py:23:12: S105 Possible hardcoded password assigned to: "PassWord" 22 | PASSWORD = "s3cr3t" 23 | PassWord = "s3cr3t" | ^^^^^^^^ S105 -24 | -25 | d["password"] = "s3cr3t" +24 | password: str = "s3cr3t" +25 | password: Final = "s3cr3t" | -S105.py:25:17: S105 Possible hardcoded password assigned to: "password" +S105.py:24:17: S105 Possible hardcoded password assigned to: "password" + | +22 | PASSWORD = "s3cr3t" +23 | PassWord = "s3cr3t" +24 | password: str = "s3cr3t" + | ^^^^^^^^ S105 +25 | password: Final = "s3cr3t" + | + +S105.py:25:19: S105 Possible hardcoded password assigned to: "password" | 23 | PassWord = "s3cr3t" -24 | -25 | d["password"] = "s3cr3t" +24 | password: str = "s3cr3t" +25 | password: Final = "s3cr3t" + | ^^^^^^^^ S105 +26 | +27 | d["password"] = "s3cr3t" + | + +S105.py:27:17: S105 Possible hardcoded password assigned to: "password" + | +25 | password: Final = "s3cr3t" +26 | +27 | d["password"] = "s3cr3t" | ^^^^^^^^ S105 -26 | d["pass"] = "s3cr3t" -27 | d["passwd"] = "s3cr3t" +28 | d["pass"] = "s3cr3t" +29 | d["passwd"] = "s3cr3t" | -S105.py:26:13: S105 Possible hardcoded password assigned to: "pass" +S105.py:28:13: S105 Possible hardcoded password assigned to: "pass" | -25 | d["password"] = "s3cr3t" -26 | d["pass"] = "s3cr3t" +27 | d["password"] = "s3cr3t" +28 | d["pass"] = "s3cr3t" | ^^^^^^^^ S105 -27 | d["passwd"] = "s3cr3t" -28 | d["pwd"] = "s3cr3t" +29 | d["passwd"] = "s3cr3t" +30 | d["pwd"] = "s3cr3t" | -S105.py:27:15: S105 Possible hardcoded password assigned to: "passwd" +S105.py:29:15: S105 Possible hardcoded password assigned to: "passwd" | -25 | d["password"] = "s3cr3t" -26 | d["pass"] = "s3cr3t" -27 | d["passwd"] = "s3cr3t" +27 | d["password"] = "s3cr3t" +28 | d["pass"] = "s3cr3t" +29 | d["passwd"] = "s3cr3t" | ^^^^^^^^ S105 -28 | d["pwd"] = "s3cr3t" -29 | d["secret"] = "s3cr3t" +30 | d["pwd"] = "s3cr3t" +31 | d["secret"] = "s3cr3t" | -S105.py:28:12: S105 Possible hardcoded password assigned to: "pwd" +S105.py:30:12: S105 Possible hardcoded password assigned to: "pwd" | -26 | d["pass"] = "s3cr3t" -27 | d["passwd"] = "s3cr3t" -28 | d["pwd"] = "s3cr3t" +28 | d["pass"] = "s3cr3t" +29 | d["passwd"] = "s3cr3t" +30 | d["pwd"] = "s3cr3t" | ^^^^^^^^ S105 -29 | d["secret"] = "s3cr3t" -30 | d["token"] = "s3cr3t" +31 | d["secret"] = "s3cr3t" +32 | d["token"] = "s3cr3t" | -S105.py:29:15: S105 Possible hardcoded password assigned to: "secret" +S105.py:31:15: S105 Possible hardcoded password assigned to: "secret" | -27 | d["passwd"] = "s3cr3t" -28 | d["pwd"] = "s3cr3t" -29 | d["secret"] = "s3cr3t" +29 | d["passwd"] = "s3cr3t" +30 | d["pwd"] = "s3cr3t" +31 | d["secret"] = "s3cr3t" | ^^^^^^^^ S105 -30 | d["token"] = "s3cr3t" -31 | d["secrete"] = "s3cr3t" +32 | d["token"] = "s3cr3t" +33 | d["secrete"] = "s3cr3t" | -S105.py:30:14: S105 Possible hardcoded password assigned to: "token" +S105.py:32:14: S105 Possible hardcoded password assigned to: "token" | -28 | d["pwd"] = "s3cr3t" -29 | d["secret"] = "s3cr3t" -30 | d["token"] = "s3cr3t" +30 | d["pwd"] = "s3cr3t" +31 | d["secret"] = "s3cr3t" +32 | d["token"] = "s3cr3t" | ^^^^^^^^ S105 -31 | d["secrete"] = "s3cr3t" -32 | safe = d["password"] = "s3cr3t" +33 | d["secrete"] = "s3cr3t" +34 | safe = d["password"] = "s3cr3t" | -S105.py:31:16: S105 Possible hardcoded password assigned to: "secrete" +S105.py:33:16: S105 Possible hardcoded password assigned to: "secrete" | -29 | d["secret"] = "s3cr3t" -30 | d["token"] = "s3cr3t" -31 | d["secrete"] = "s3cr3t" +31 | d["secret"] = "s3cr3t" +32 | d["token"] = "s3cr3t" +33 | d["secrete"] = "s3cr3t" | ^^^^^^^^ S105 -32 | safe = d["password"] = "s3cr3t" -33 | d["password"] = safe = "s3cr3t" +34 | safe = d["password"] = "s3cr3t" +35 | d["password"] = safe = "s3cr3t" | -S105.py:32:24: S105 Possible hardcoded password assigned to: "password" +S105.py:34:24: S105 Possible hardcoded password assigned to: "password" | -30 | d["token"] = "s3cr3t" -31 | d["secrete"] = "s3cr3t" -32 | safe = d["password"] = "s3cr3t" +32 | d["token"] = "s3cr3t" +33 | d["secrete"] = "s3cr3t" +34 | safe = d["password"] = "s3cr3t" | ^^^^^^^^ S105 -33 | d["password"] = safe = "s3cr3t" +35 | d["password"] = safe = "s3cr3t" | -S105.py:33:24: S105 Possible hardcoded password assigned to: "password" +S105.py:35:24: S105 Possible hardcoded password assigned to: "password" | -31 | d["secrete"] = "s3cr3t" -32 | safe = d["password"] = "s3cr3t" -33 | d["password"] = safe = "s3cr3t" +33 | d["secrete"] = "s3cr3t" +34 | safe = d["password"] = "s3cr3t" +35 | d["password"] = safe = "s3cr3t" | ^^^^^^^^ S105 | -S105.py:37:16: S105 Possible hardcoded password assigned to: "password" +S105.py:39:16: S105 Possible hardcoded password assigned to: "password" | -36 | class MyClass: -37 | password = "s3cr3t" +38 | class MyClass: +39 | password = "s3cr3t" | ^^^^^^^^ S105 -38 | safe = password +40 | safe = password | -S105.py:41:20: S105 Possible hardcoded password assigned to: "password" +S105.py:43:20: S105 Possible hardcoded password assigned to: "password" | -41 | MyClass.password = "s3cr3t" +43 | MyClass.password = "s3cr3t" | ^^^^^^^^ S105 -42 | MyClass._pass = "s3cr3t" -43 | MyClass.passwd = "s3cr3t" +44 | MyClass._pass = "s3cr3t" +45 | MyClass.passwd = "s3cr3t" | -S105.py:42:17: S105 Possible hardcoded password assigned to: "_pass" +S105.py:44:17: S105 Possible hardcoded password assigned to: "_pass" | -41 | MyClass.password = "s3cr3t" -42 | MyClass._pass = "s3cr3t" +43 | MyClass.password = "s3cr3t" +44 | MyClass._pass = "s3cr3t" | ^^^^^^^^ S105 -43 | MyClass.passwd = "s3cr3t" -44 | MyClass.pwd = "s3cr3t" +45 | MyClass.passwd = "s3cr3t" +46 | MyClass.pwd = "s3cr3t" | -S105.py:43:18: S105 Possible hardcoded password assigned to: "passwd" +S105.py:45:18: S105 Possible hardcoded password assigned to: "passwd" | -41 | MyClass.password = "s3cr3t" -42 | MyClass._pass = "s3cr3t" -43 | MyClass.passwd = "s3cr3t" +43 | MyClass.password = "s3cr3t" +44 | MyClass._pass = "s3cr3t" +45 | MyClass.passwd = "s3cr3t" | ^^^^^^^^ S105 -44 | MyClass.pwd = "s3cr3t" -45 | MyClass.secret = "s3cr3t" +46 | MyClass.pwd = "s3cr3t" +47 | MyClass.secret = "s3cr3t" | -S105.py:44:15: S105 Possible hardcoded password assigned to: "pwd" +S105.py:46:15: S105 Possible hardcoded password assigned to: "pwd" | -42 | MyClass._pass = "s3cr3t" -43 | MyClass.passwd = "s3cr3t" -44 | MyClass.pwd = "s3cr3t" +44 | MyClass._pass = "s3cr3t" +45 | MyClass.passwd = "s3cr3t" +46 | MyClass.pwd = "s3cr3t" | ^^^^^^^^ S105 -45 | MyClass.secret = "s3cr3t" -46 | MyClass.token = "s3cr3t" +47 | MyClass.secret = "s3cr3t" +48 | MyClass.token = "s3cr3t" | -S105.py:45:18: S105 Possible hardcoded password assigned to: "secret" +S105.py:47:18: S105 Possible hardcoded password assigned to: "secret" | -43 | MyClass.passwd = "s3cr3t" -44 | MyClass.pwd = "s3cr3t" -45 | MyClass.secret = "s3cr3t" +45 | MyClass.passwd = "s3cr3t" +46 | MyClass.pwd = "s3cr3t" +47 | MyClass.secret = "s3cr3t" | ^^^^^^^^ S105 -46 | MyClass.token = "s3cr3t" -47 | MyClass.secrete = "s3cr3t" +48 | MyClass.token = "s3cr3t" +49 | MyClass.secrete = "s3cr3t" | -S105.py:46:17: S105 Possible hardcoded password assigned to: "token" +S105.py:48:17: S105 Possible hardcoded password assigned to: "token" | -44 | MyClass.pwd = "s3cr3t" -45 | MyClass.secret = "s3cr3t" -46 | MyClass.token = "s3cr3t" +46 | MyClass.pwd = "s3cr3t" +47 | MyClass.secret = "s3cr3t" +48 | MyClass.token = "s3cr3t" | ^^^^^^^^ S105 -47 | MyClass.secrete = "s3cr3t" +49 | MyClass.secrete = "s3cr3t" | -S105.py:47:19: S105 Possible hardcoded password assigned to: "secrete" +S105.py:49:19: S105 Possible hardcoded password assigned to: "secrete" | -45 | MyClass.secret = "s3cr3t" -46 | MyClass.token = "s3cr3t" -47 | MyClass.secrete = "s3cr3t" +47 | MyClass.secret = "s3cr3t" +48 | MyClass.token = "s3cr3t" +49 | MyClass.secrete = "s3cr3t" | ^^^^^^^^ S105 -48 | -49 | password == "s3cr3t" +50 | +51 | password == "s3cr3t" | -S105.py:49:13: S105 Possible hardcoded password assigned to: "password" +S105.py:51:13: S105 Possible hardcoded password assigned to: "password" | -47 | MyClass.secrete = "s3cr3t" -48 | -49 | password == "s3cr3t" +49 | MyClass.secrete = "s3cr3t" +50 | +51 | password == "s3cr3t" | ^^^^^^^^ S105 -50 | _pass == "s3cr3t" -51 | passwd == "s3cr3t" +52 | _pass == "s3cr3t" +53 | passwd == "s3cr3t" | -S105.py:50:10: S105 Possible hardcoded password assigned to: "_pass" +S105.py:52:10: S105 Possible hardcoded password assigned to: "_pass" | -49 | password == "s3cr3t" -50 | _pass == "s3cr3t" +51 | password == "s3cr3t" +52 | _pass == "s3cr3t" | ^^^^^^^^ S105 -51 | passwd == "s3cr3t" -52 | pwd == "s3cr3t" +53 | passwd == "s3cr3t" +54 | pwd == "s3cr3t" | -S105.py:51:11: S105 Possible hardcoded password assigned to: "passwd" +S105.py:53:11: S105 Possible hardcoded password assigned to: "passwd" | -49 | password == "s3cr3t" -50 | _pass == "s3cr3t" -51 | passwd == "s3cr3t" +51 | password == "s3cr3t" +52 | _pass == "s3cr3t" +53 | passwd == "s3cr3t" | ^^^^^^^^ S105 -52 | pwd == "s3cr3t" -53 | secret == "s3cr3t" +54 | pwd == "s3cr3t" +55 | secret == "s3cr3t" | -S105.py:52:8: S105 Possible hardcoded password assigned to: "pwd" +S105.py:54:8: S105 Possible hardcoded password assigned to: "pwd" | -50 | _pass == "s3cr3t" -51 | passwd == "s3cr3t" -52 | pwd == "s3cr3t" +52 | _pass == "s3cr3t" +53 | passwd == "s3cr3t" +54 | pwd == "s3cr3t" | ^^^^^^^^ S105 -53 | secret == "s3cr3t" -54 | token == "s3cr3t" +55 | secret == "s3cr3t" +56 | token == "s3cr3t" | -S105.py:53:11: S105 Possible hardcoded password assigned to: "secret" +S105.py:55:11: S105 Possible hardcoded password assigned to: "secret" | -51 | passwd == "s3cr3t" -52 | pwd == "s3cr3t" -53 | secret == "s3cr3t" +53 | passwd == "s3cr3t" +54 | pwd == "s3cr3t" +55 | secret == "s3cr3t" | ^^^^^^^^ S105 -54 | token == "s3cr3t" -55 | secrete == "s3cr3t" +56 | token == "s3cr3t" +57 | secrete == "s3cr3t" | -S105.py:54:10: S105 Possible hardcoded password assigned to: "token" +S105.py:56:10: S105 Possible hardcoded password assigned to: "token" | -52 | pwd == "s3cr3t" -53 | secret == "s3cr3t" -54 | token == "s3cr3t" +54 | pwd == "s3cr3t" +55 | secret == "s3cr3t" +56 | token == "s3cr3t" | ^^^^^^^^ S105 -55 | secrete == "s3cr3t" -56 | password == safe == "s3cr3t" +57 | secrete == "s3cr3t" +58 | password == safe == "s3cr3t" | -S105.py:55:12: S105 Possible hardcoded password assigned to: "secrete" +S105.py:57:12: S105 Possible hardcoded password assigned to: "secrete" | -53 | secret == "s3cr3t" -54 | token == "s3cr3t" -55 | secrete == "s3cr3t" +55 | secret == "s3cr3t" +56 | token == "s3cr3t" +57 | secrete == "s3cr3t" | ^^^^^^^^ S105 -56 | password == safe == "s3cr3t" +58 | password == safe == "s3cr3t" | -S105.py:56:21: S105 Possible hardcoded password assigned to: "password" +S105.py:58:21: S105 Possible hardcoded password assigned to: "password" | -54 | token == "s3cr3t" -55 | secrete == "s3cr3t" -56 | password == safe == "s3cr3t" +56 | token == "s3cr3t" +57 | secrete == "s3cr3t" +58 | password == safe == "s3cr3t" | ^^^^^^^^ S105 -57 | -58 | if token == "1\n2": +59 | +60 | if token == "1\n2": | -S105.py:58:13: S105 Possible hardcoded password assigned to: "token" +S105.py:60:13: S105 Possible hardcoded password assigned to: "token" | -56 | password == safe == "s3cr3t" -57 | -58 | if token == "1\n2": +58 | password == safe == "s3cr3t" +59 | +60 | if token == "1\n2": | ^^^^^^ S105 -59 | pass +61 | pass | -S105.py:61:13: S105 Possible hardcoded password assigned to: "token" +S105.py:63:13: S105 Possible hardcoded password assigned to: "token" | -59 | pass -60 | -61 | if token == "3\t4": +61 | pass +62 | +63 | if token == "3\t4": | ^^^^^^ S105 -62 | pass +64 | pass | -S105.py:64:13: S105 Possible hardcoded password assigned to: "token" +S105.py:66:13: S105 Possible hardcoded password assigned to: "token" | -62 | pass -63 | -64 | if token == "5\r6": +64 | pass +65 | +66 | if token == "5\r6": | ^^^^^^ S105 -65 | pass +67 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S106_S106.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S106_S106.py.snap index 6677f394e035f..06b8944aafe1c 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S106_S106.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S106_S106.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S106.py:14:9: S106 Possible hardcoded password assigned to argument: "password" | @@ -7,5 +8,3 @@ S106.py:14:9: S106 Possible hardcoded password assigned to argument: "password" 14 | func(1, password="s3cr3t") | ^^^^^^^^^^^^^^^^^ S106 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S107_S107.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S107_S107.py.snap index 339d3126fb786..05ef29a254753 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S107_S107.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S107_S107.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S107.py:5:29: S107 Possible hardcoded password assigned to function default: "password" | @@ -35,5 +36,3 @@ S107.py:29:62: S107 Possible hardcoded password assigned to function default: "p | ^^^^^^^^ S107 30 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_S108.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_S108.py.snap index d7cf9f3ec0a0e..2b601edf61da6 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_S108.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_S108.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S108.py:5:11: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 3 | f.write("def") -4 | +4 | 5 | with open("/tmp/abc", "w") as f: | ^^^^^^^^^^ S108 6 | f.write("def") @@ -13,7 +13,7 @@ S108.py:5:11: S108 Probable insecure usage of temporary file or directory: "/tmp S108.py:8:13: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 6 | f.write("def") -7 | +7 | 8 | with open(f"/tmp/abc", "w") as f: | ^^^^^^^^ S108 9 | f.write("def") @@ -22,7 +22,7 @@ S108.py:8:13: S108 Probable insecure usage of temporary file or directory: "/tmp S108.py:11:11: S108 Probable insecure usage of temporary file or directory: "/var/tmp/123" | 9 | f.write("def") -10 | +10 | 11 | with open("/var/tmp/123", "w") as f: | ^^^^^^^^^^^^^^ S108 12 | f.write("def") @@ -31,7 +31,7 @@ S108.py:11:11: S108 Probable insecure usage of temporary file or directory: "/va S108.py:14:11: S108 Probable insecure usage of temporary file or directory: "/dev/shm/unit/test" | 12 | f.write("def") -13 | +13 | 14 | with open("/dev/shm/unit/test", "w") as f: | ^^^^^^^^^^^^^^^^^^^^ S108 15 | f.write("def") @@ -48,7 +48,7 @@ S108.py:22:11: S108 Probable insecure usage of temporary file or directory: "/tm S108.py:25:11: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 23 | f.write("def") -24 | +24 | 25 | with open("/tmp/abc" f"/tmp/abc", "w") as f: | ^^^^^^^^^^ S108 26 | f.write("def") @@ -57,7 +57,7 @@ S108.py:25:11: S108 Probable insecure usage of temporary file or directory: "/tm S108.py:25:24: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 23 | f.write("def") -24 | +24 | 25 | with open("/tmp/abc" f"/tmp/abc", "w") as f: | ^^^^^^^^ S108 26 | f.write("def") diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_extend.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_extend.snap index 9cebf409e715d..bcaf957a3dc11 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_extend.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S108_extend.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S108.py:5:11: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 3 | f.write("def") -4 | +4 | 5 | with open("/tmp/abc", "w") as f: | ^^^^^^^^^^ S108 6 | f.write("def") @@ -13,7 +13,7 @@ S108.py:5:11: S108 Probable insecure usage of temporary file or directory: "/tmp S108.py:8:13: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 6 | f.write("def") -7 | +7 | 8 | with open(f"/tmp/abc", "w") as f: | ^^^^^^^^ S108 9 | f.write("def") @@ -22,7 +22,7 @@ S108.py:8:13: S108 Probable insecure usage of temporary file or directory: "/tmp S108.py:11:11: S108 Probable insecure usage of temporary file or directory: "/var/tmp/123" | 9 | f.write("def") -10 | +10 | 11 | with open("/var/tmp/123", "w") as f: | ^^^^^^^^^^^^^^ S108 12 | f.write("def") @@ -31,7 +31,7 @@ S108.py:11:11: S108 Probable insecure usage of temporary file or directory: "/va S108.py:14:11: S108 Probable insecure usage of temporary file or directory: "/dev/shm/unit/test" | 12 | f.write("def") -13 | +13 | 14 | with open("/dev/shm/unit/test", "w") as f: | ^^^^^^^^^^^^^^^^^^^^ S108 15 | f.write("def") @@ -56,7 +56,7 @@ S108.py:22:11: S108 Probable insecure usage of temporary file or directory: "/tm S108.py:25:11: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 23 | f.write("def") -24 | +24 | 25 | with open("/tmp/abc" f"/tmp/abc", "w") as f: | ^^^^^^^^^^ S108 26 | f.write("def") @@ -65,7 +65,7 @@ S108.py:25:11: S108 Probable insecure usage of temporary file or directory: "/tm S108.py:25:24: S108 Probable insecure usage of temporary file or directory: "/tmp/abc" | 23 | f.write("def") -24 | +24 | 25 | with open("/tmp/abc" f"/tmp/abc", "w") as f: | ^^^^^^^^ S108 26 | f.write("def") diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_S110.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_S110.py.snap index 8197e8f16ccca..ecf235771ff0d 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_S110.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_S110.py.snap @@ -8,7 +8,7 @@ S110.py:3:1: S110 `try`-`except`-`pass` detected, consider logging the exception 3 | / except Exception: 4 | | pass | |________^ S110 -5 | +5 | 6 | try: | @@ -19,8 +19,6 @@ S110.py:8:1: S110 `try`-`except`-`pass` detected, consider logging the exception 8 | / except: 9 | | pass | |________^ S110 -10 | +10 | 11 | try: | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_typed.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_typed.snap index 701d4112c2813..a0971f71ad02e 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_typed.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S110_typed.snap @@ -8,7 +8,7 @@ S110.py:3:1: S110 `try`-`except`-`pass` detected, consider logging the exception 3 | / except Exception: 4 | | pass | |________^ S110 -5 | +5 | 6 | try: | @@ -19,7 +19,7 @@ S110.py:8:1: S110 `try`-`except`-`pass` detected, consider logging the exception 8 | / except: 9 | | pass | |________^ S110 -10 | +10 | 11 | try: | @@ -31,5 +31,3 @@ S110.py:13:1: S110 `try`-`except`-`pass` detected, consider logging the exceptio 14 | | pass | |________^ S110 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S112_S112.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S112_S112.py.snap index 96976d8b0a6e7..2df863f5fdcfb 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S112_S112.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S112_S112.py.snap @@ -8,7 +8,7 @@ S112.py:3:1: S112 `try`-`except`-`continue` detected, consider logging the excep 3 | / except Exception: 4 | | continue | |____________^ S112 -5 | +5 | 6 | try: | @@ -19,7 +19,7 @@ S112.py:8:1: S112 `try`-`except`-`continue` detected, consider logging the excep 8 | / except: 9 | | continue | |____________^ S112 -10 | +10 | 11 | try: | @@ -30,7 +30,7 @@ S112.py:13:1: S112 `try`-`except`-`continue` detected, consider logging the exce 13 | / except (Exception,): 14 | | continue | |____________^ S112 -15 | +15 | 16 | try: | @@ -41,8 +41,6 @@ S112.py:18:1: S112 `try`-`except`-`continue` detected, consider logging the exce 18 | / except (Exception, ValueError): 19 | | continue | |____________^ S112 -20 | +20 | 21 | try: | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S113_S113.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S113_S113.py.snap index 25eb309248bdf..9ae00a6a68896 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S113_S113.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S113_S113.py.snap @@ -1,6 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs -assertion_line: 81 --- S113.py:46:1: S113 Probable use of `requests` call without timeout | @@ -136,14 +135,14 @@ S113.py:59:36: S113 Probable use of `requests` call with timeout set to `None` 58 | requests.head('https://gmail.com') 59 | requests.head('https://gmail.com', timeout=None) | ^^^^^^^^^^^^ S113 -60 | +60 | 61 | httpx.get('https://gmail.com', timeout=None) | S113.py:61:32: S113 Probable use of `httpx` call with timeout set to `None` | 59 | requests.head('https://gmail.com', timeout=None) -60 | +60 | 61 | httpx.get('https://gmail.com', timeout=None) | ^^^^^^^^^^^^ S113 62 | httpx.post('https://gmail.com', timeout=None) @@ -224,14 +223,14 @@ S113.py:69:19: S113 Probable use of `httpx` call with timeout set to `None` 68 | httpx.Client(timeout=None) 69 | httpx.AsyncClient(timeout=None) | ^^^^^^^^^^^^ S113 -70 | +70 | 71 | with httpx.Client(timeout=None) as client: | S113.py:71:19: S113 Probable use of `httpx` call with timeout set to `None` | 69 | httpx.AsyncClient(timeout=None) -70 | +70 | 71 | with httpx.Client(timeout=None) as client: | ^^^^^^^^^^^^ S113 72 | client.get('https://gmail.com') diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S201_S201.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S201_S201.py.snap index 117d522f946cd..11115cc0bae11 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S201_S201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S201_S201.py.snap @@ -6,8 +6,6 @@ S201.py:10:9: S201 Use of `debug=True` in Flask app detected 9 | # OK 10 | app.run(debug=True) | ^^^^^^^^^^ S201 -11 | +11 | 12 | # Errors | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S202_S202.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S202_S202.py.snap index fb951d05d1d44..711d7de30bc62 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S202_S202.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S202_S202.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S202.py:8:5: S202 Uses of `tarfile.extractall()` | @@ -45,5 +46,3 @@ S202.py:38:5: S202 Uses of `tarfile.extractall()` | ^^^^^^^^^^^^^^^^^^ S202 39 | tar.close() | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S301_S301.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S301_S301.py.snap index 6377796b72af3..4e27b0d75b536 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S301_S301.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S301_S301.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S301.py:3:1: S301 `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue | 1 | import pickle -2 | +2 | 3 | pickle.loads() | ^^^^^^^^^^^^^^ S301 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S307_S307.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S307_S307.py.snap index 596c3c2a305ad..7d474f3d31fb4 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S307_S307.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S307_S307.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S307.py:3:7: S307 Use of possibly insecure function; consider using `ast.literal_eval` | 1 | import os -2 | +2 | 3 | print(eval("1+1")) # S307 | ^^^^^^^^^^^ S307 4 | print(eval("os.getcwd()")) # S307 @@ -16,5 +16,3 @@ S307.py:4:7: S307 Use of possibly insecure function; consider using `ast.literal 4 | print(eval("os.getcwd()")) # S307 | ^^^^^^^^^^^^^^^^^^^ S307 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S308_S308.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S308_S308.py.snap index d2484ff7a57e7..f48701e74c273 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S308_S308.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S308_S308.py.snap @@ -1,34 +1,116 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs --- -S308.py:5:12: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities +S308.py:6:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities | -4 | def some_func(): -5 | return mark_safe('<script>alert("evil!")</script>') - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +4 | def bad_func(): +5 | inject = "harmful_input" +6 | mark_safe(inject) + | ^^^^^^^^^^^^^^^^^ S308 +7 | mark_safe("I will add" + inject + "to my string") +8 | mark_safe("I will add %s to my string" % inject) | -S308.py:8:1: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities +S308.py:7:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +5 | inject = "harmful_input" +6 | mark_safe(inject) +7 | mark_safe("I will add" + inject + "to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +8 | mark_safe("I will add %s to my string" % inject) +9 | mark_safe("I will add {} to my string".format(inject)) + | + +S308.py:8:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities | - 8 | @mark_safe - | ^^^^^^^^^^ S308 - 9 | def some_func(): -10 | return '<script>alert("evil!")</script>' + 6 | mark_safe(inject) + 7 | mark_safe("I will add" + inject + "to my string") + 8 | mark_safe("I will add %s to my string" % inject) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 + 9 | mark_safe("I will add {} to my string".format(inject)) +10 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:9:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | + 7 | mark_safe("I will add" + inject + "to my string") + 8 | mark_safe("I will add %s to my string" % inject) + 9 | mark_safe("I will add {} to my string".format(inject)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +10 | mark_safe(f"I will add {inject} to my string") | -S308.py:17:12: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities +S308.py:10:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities | -16 | def some_func(): -17 | return mark_safe('<script>alert("evil!")</script>') - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 + 8 | mark_safe("I will add %s to my string" % inject) + 9 | mark_safe("I will add {} to my string".format(inject)) +10 | mark_safe(f"I will add {inject} to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +11 | +12 | def good_func(): | -S308.py:20:1: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities +S308.py:16:1: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities | -20 | @mark_safe +16 | @mark_safe | ^^^^^^^^^^ S308 -21 | def some_func(): -22 | return '<script>alert("evil!")</script>' +17 | def some_func(): +18 | return '<script>alert("evil!")</script>' + | + +S308.py:26:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +24 | def bad_func(): +25 | inject = "harmful_input" +26 | mark_safe(inject) + | ^^^^^^^^^^^^^^^^^ S308 +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) + | + +S308.py:27:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +25 | inject = "harmful_input" +26 | mark_safe(inject) +27 | mark_safe("I will add" + inject + "to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) + | + +S308.py:28:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +26 | mark_safe(inject) +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +29 | mark_safe("I will add {} to my string".format(inject)) +30 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:29:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +30 | mark_safe(f"I will add {inject} to my string") | +S308.py:30:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) +30 | mark_safe(f"I will add {inject} to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +31 | +32 | def good_func(): + | +S308.py:36:1: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +36 | @mark_safe + | ^^^^^^^^^^ S308 +37 | def some_func(): +38 | return '<script>alert("evil!")</script>' + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S310_S310.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S310_S310.py.snap index 26612b698f752..1a90de58fad2f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S310_S310.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S310_S310.py.snap @@ -36,7 +36,7 @@ S310.py:11:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` 10 | urllib.request.urlopen('file:///foo/bar/baz') 11 | urllib.request.urlopen(url) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 -12 | +12 | 13 | urllib.request.Request(url='http://www.google.com') | @@ -75,14 +75,14 @@ S310.py:21:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` 20 | urllib.request.Request('file:///foo/bar/baz') 21 | urllib.request.Request(url) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 -22 | +22 | 23 | urllib.request.URLopener().open(fullurl='http://www.google.com') | S310.py:23:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. | 21 | urllib.request.Request(url) -22 | +22 | 23 | urllib.request.URLopener().open(fullurl='http://www.google.com') | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 24 | urllib.request.URLopener().open(fullurl=f'http://www.google.com') @@ -173,7 +173,7 @@ S310.py:32:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` 31 | urllib.request.URLopener().open('file:///foo/bar/baz') 32 | urllib.request.URLopener().open(url) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 -33 | +33 | 34 | urllib.request.urlopen(url=urllib.request.Request('http://www.google.com')) | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S311_S311.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S311_S311.py.snap index 3c395057aaf74..858f04e4a3b93 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S311_S311.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S311_S311.py.snap @@ -85,6 +85,6 @@ S311.py:18:1: S311 Standard pseudo-random generators are not suitable for crypto 17 | random.triangular() 18 | random.randbytes() | ^^^^^^^^^^^^^^^^^^ S311 -19 | +19 | 20 | # Unrelated | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S312_S312.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S312_S312.py.snap index 61adb56edd468..93e90da5ce1d5 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S312_S312.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S312_S312.py.snap @@ -1,12 +1,19 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs --- -S312.py:3:1: S312 Telnet-related functions are being called. Telnet is considered insecure. Use SSH or some other encrypted protocol. +S312.py:3:1: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. | 1 | from telnetlib import Telnet -2 | +2 | 3 | Telnet("localhost", 23) | ^^^^^^^^^^^^^^^^^^^^^^^ S312 | - +S312.py:14:24: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | +13 | from typing import Annotated +14 | foo: Annotated[Telnet, telnetlib.Telnet()] + | ^^^^^^^^^^^^^^^^^^ S312 +15 | +16 | def _() -> Telnet: ... + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S324_S324.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S324_S324.py.snap index 1a521d8ce44aa..a2a47b4b1370b 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S324_S324.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S324_S324.py.snap @@ -126,14 +126,14 @@ S324.py:20:13: S324 Probable use of insecure hash functions in `hashlib`: `sha1` 19 | # usedforsecurity arg only available in Python 3.9+ 20 | hashlib.new('sha1', usedforsecurity=True) | ^^^^^^ S324 -21 | +21 | 22 | crypt.crypt("test", salt=crypt.METHOD_CRYPT) | S324.py:22:26: S324 Probable use of insecure hash functions in `crypt`: `crypt.METHOD_CRYPT` | 20 | hashlib.new('sha1', usedforsecurity=True) -21 | +21 | 22 | crypt.crypt("test", salt=crypt.METHOD_CRYPT) | ^^^^^^^^^^^^^^^^^^ S324 23 | crypt.crypt("test", salt=crypt.METHOD_MD5) @@ -164,14 +164,14 @@ S324.py:25:21: S324 Probable use of insecure hash functions in `crypt`: `crypt.M 24 | crypt.crypt("test", salt=crypt.METHOD_BLOWFISH) 25 | crypt.crypt("test", crypt.METHOD_BLOWFISH) | ^^^^^^^^^^^^^^^^^^^^^ S324 -26 | +26 | 27 | crypt.mksalt(crypt.METHOD_CRYPT) | S324.py:27:14: S324 Probable use of insecure hash functions in `crypt`: `crypt.METHOD_CRYPT` | 25 | crypt.crypt("test", crypt.METHOD_BLOWFISH) -26 | +26 | 27 | crypt.mksalt(crypt.METHOD_CRYPT) | ^^^^^^^^^^^^^^^^^^ S324 28 | crypt.mksalt(crypt.METHOD_MD5) @@ -192,6 +192,16 @@ S324.py:29:14: S324 Probable use of insecure hash functions in `crypt`: `crypt.M 28 | crypt.mksalt(crypt.METHOD_MD5) 29 | crypt.mksalt(crypt.METHOD_BLOWFISH) | ^^^^^^^^^^^^^^^^^^^^^ S324 -30 | +30 | 31 | # OK | + +S324.py:51:13: S324 Probable use of insecure hash functions in `hashlib`: `Md5` + | +49 | # From issue: https://github.com/astral-sh/ruff/issues/16525#issuecomment-2706188584 +50 | # Errors +51 | hashlib.new("Md5") + | ^^^^^ S324 +52 | +53 | # OK + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.py.snap index 238e12cb37a0b..8079727d4dae5 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S401.py:1:8: S401 `telnetlib` and related modules are considered insecure. Use SSH or another encrypted protocol. | @@ -14,5 +15,3 @@ S401.py:2:6: S401 `telnetlib` and related modules are considered insecure. Use S 2 | from telnetlib import Telnet # S401 | ^^^^^^^^^ S401 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S401_S401.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.py.snap index 76133c6a5e3f7..96383582dcbdb 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S402.py:1:8: S402 `ftplib` and related modules are considered insecure. Use SSH, SFTP, SCP, or another encrypted protocol. | @@ -14,5 +15,3 @@ S402.py:2:6: S402 `ftplib` and related modules are considered insecure. Use SSH, 2 | from ftplib import FTP # S402 | ^^^^^^ S402 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S402_S402.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.py.snap index 40a790297e356..23b2b90a22c47 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S403.py:1:8: S403 `pickle`, `cPickle`, `dill`, and `shelve` modules are possibly insecure | @@ -74,5 +75,3 @@ S403.py:8:6: S403 `pickle`, `cPickle`, `dill`, and `shelve` modules are possibly 8 | from pickle import load | ^^^^^^ S403 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S403_S403.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.py.snap index f67e404f427e4..d63505043c646 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S404.py:1:8: S404 `subprocess` module is possibly insecure | @@ -24,5 +25,3 @@ S404.py:3:6: S404 `subprocess` module is possibly insecure 3 | from subprocess import Popen as pop # S404 | ^^^^^^^^^^ S404 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S404_S404.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.py.snap index 9f4f8322c927f..ccd188524f432 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S405.py:1:8: S405 `xml.etree` methods are vulnerable to XML attacks | @@ -34,5 +35,3 @@ S405.py:4:6: S405 `xml.etree` methods are vulnerable to XML attacks 4 | from xml.etree import ElementTree # S405 | ^^^^^^^^^ S405 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S405_S405.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.py.snap index ef1c448cd3579..09c4b4e2a1f43 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S406.py:1:6: S406 `xml.sax` methods are vulnerable to XML attacks | @@ -24,5 +25,3 @@ S406.py:3:8: S406 `xml.sax` methods are vulnerable to XML attacks 3 | import xml.sax # S406 | ^^^^^^^ S406 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S406_S406.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.py.snap index 91c88345a4f17..481d087be8e1a 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S407.py:1:6: S407 `xml.dom.expatbuilder` is vulnerable to XML attacks | @@ -14,5 +15,3 @@ S407.py:2:8: S407 `xml.dom.expatbuilder` is vulnerable to XML attacks 2 | import xml.dom.expatbuilder # S407 | ^^^^^^^^^^^^^^^^^^^^ S407 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S407_S407.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.py.snap index e42d754a9ec54..eddba46724cb9 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S408.py:1:6: S408 `xml.dom.minidom` is vulnerable to XML attacks | @@ -14,5 +15,3 @@ S408.py:2:8: S408 `xml.dom.minidom` is vulnerable to XML attacks 2 | import xml.dom.minidom # S408 | ^^^^^^^^^^^^^^^ S408 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S408_S408.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.py.snap index e65eacfe96f9e..462226266937e 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S409.py:1:6: S409 `xml.dom.pulldom` is vulnerable to XML attacks | @@ -14,5 +15,3 @@ S409.py:2:8: S409 `xml.dom.pulldom` is vulnerable to XML attacks 2 | import xml.dom.pulldom # S409 | ^^^^^^^^^^^^^^^ S409 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S409_S409.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.py.snap index 56304d26707e0..f9477882ae256 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S410.py:1:8: S410 `lxml` is vulnerable to XML attacks | @@ -14,5 +15,3 @@ S410.py:2:6: S410 `lxml` is vulnerable to XML attacks 2 | from lxml import etree # S410 | ^^^^ S410 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S410_S410.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.py.snap index 0cb05d60b5de0..8d89fa5679d80 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S411.py:1:8: S411 XMLRPC is vulnerable to remote XML attacks | @@ -14,5 +15,3 @@ S411.py:2:6: S411 XMLRPC is vulnerable to remote XML attacks 2 | from xmlrpc import server # S411 | ^^^^^^ S411 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S411_S411.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.py.snap index f6acbda39983f..c8c325b36e030 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.py.snap @@ -1,10 +1,9 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S412.py:1:6: S412 `httpoxy` is a set of vulnerabilities that affect application code running inCGI, or CGI-like environments. The use of CGI for web applications should be avoided | 1 | from twisted.web.twcgi import CGIScript # S412 | ^^^^^^^^^^^^^^^^^ S412 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S412_S412.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.py.snap index fa8676bd2d8a1..5fe7a86643767 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S413.py:1:8: S413 `pycrypto` library is known to have publicly disclosed buffer overflow vulnerability | @@ -34,5 +35,3 @@ S413.py:4:6: S413 `pycrypto` library is known to have publicly disclosed buffer 4 | from Crypto.PublicKey import RSA # S413 | ^^^^^^^^^^^^^^^^ S413 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S413_S413.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.py.snap index 3c47930c4b044..86c659fb21afc 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S415.py:1:8: S415 An IPMI-related module is being imported. Prefer an encrypted protocol over IPMI. | @@ -14,5 +15,3 @@ S415.py:2:6: S415 An IPMI-related module is being imported. Prefer an encrypted 2 | from pyghmi import foo # S415 | ^^^^^^ S415 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.pyi.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.pyi.snap new file mode 100644 index 0000000000000..9d651303e1118 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S415_S415.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S501_S501.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S501_S501.py.snap index 3320a4a8102ac..5c2e46e3d1696 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S501_S501.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S501_S501.py.snap @@ -66,7 +66,7 @@ S501.py:17:48: S501 Probable use of `requests` call with `verify=False` disablin 16 | requests.head('https://gmail.com', timeout=30, verify=True) 17 | requests.head('https://gmail.com', timeout=30, verify=False) | ^^^^^^^^^^^^ S501 -18 | +18 | 19 | httpx.request('GET', 'https://gmail.com', verify=True) | @@ -176,5 +176,3 @@ S501.py:40:19: S501 Probable use of `httpx` call with `verify=False` disabling S 40 | httpx.AsyncClient(verify=False) | ^^^^^^^^^^^^ S501 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S502_S502.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S502_S502.py.snap index 31a2a690416c5..4087d85ab4148 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S502_S502.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S502_S502.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S502.py:6:13: S502 Call made with insecure SSL protocol: `PROTOCOL_SSLv3` | 4 | from OpenSSL.SSL import Context -5 | +5 | 6 | wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3) # S502 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S502 7 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 @@ -65,8 +65,6 @@ S502.py:12:9: S502 Call made with insecure SSL protocol: `TLSv1_METHOD` 11 | Context(method=SSL.SSLv3_METHOD) # S502 12 | Context(method=SSL.TLSv1_METHOD) # S502 | ^^^^^^^^^^^^^^^^^^^^^^^ S502 -13 | +13 | 14 | wrap_socket(ssl_version=ssl.PROTOCOL_TLS_CLIENT) # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S503_S503.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S503_S503.py.snap index 93932f9a6b0bf..7ada319330dec 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S503_S503.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S503_S503.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S503.py:6:18: S503 Argument default set to insecure SSL protocol: `PROTOCOL_SSLv2` | @@ -28,5 +29,3 @@ S503.py:18:19: S503 Argument default set to insecure SSL protocol: `PROTOCOL_TLS | ^^^^^^^^^^^^^^ S503 19 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S504_S504.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S504_S504.py.snap index aeaa2578d2952..faf1b6729a1af 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S504_S504.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S504_S504.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S504.py:4:1: S504 `ssl.wrap_socket` called without an `ssl_version`` | 2 | from ssl import wrap_socket -3 | +3 | 4 | ssl.wrap_socket() # S504 | ^^^^^^^^^^^^^^^^^ S504 5 | wrap_socket() # S504 @@ -18,5 +18,3 @@ S504.py:5:1: S504 `ssl.wrap_socket` called without an `ssl_version`` | ^^^^^^^^^^^^^ S504 6 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1_2) # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S505_S505.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S505_S505.py.snap index bc14a8556f74a..0177c4b1e4ca6 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S505_S505.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S505_S505.py.snap @@ -135,8 +135,6 @@ S505.py:44:28: S505 DSA key sizes below 2048 bits are considered breakable 43 | pycryptodomex_dsa.generate(2047) 44 | pycryptodomex_rsa.generate(2047) | ^^^^ S505 -45 | +45 | 46 | # Don't crash when the size is variable. | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S506_S506.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S506_S506.py.snap index 466f3e9f21238..e20574f58159f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S506_S506.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S506_S506.py.snap @@ -15,8 +15,6 @@ S506.py:24:24: S506 Probable use of unsafe loader `Loader` with `yaml.load`. All | 24 | yaml.load("{}", Loader=yaml.Loader) | ^^^^^^^^^^^ S506 -25 | +25 | 26 | # no issue should be found | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S507_S507.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S507_S507.py.snap index 6ff5a45021d54..0cf6adf52237c 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S507_S507.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S507_S507.py.snap @@ -75,8 +75,6 @@ S507.py:22:54: S507 Paramiko call with policy set to automatically trust the unk 21 | ssh_client.set_missing_host_key_policy(policy=WarningPolicy) 22 | ssh_client_from_paramiko.set_missing_host_key_policy(paramiko.AutoAddPolicy) | ^^^^^^^^^^^^^^^^^^^^^^ S507 -23 | +23 | 24 | # Unrelated | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S508_S508.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S508_S508.py.snap index 7b72946d50159..34e169f4868bd 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S508_S508.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S508_S508.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S508.py:3:25: S508 The use of SNMPv1 and SNMPv2 is insecure. Use SNMPv3 if able. | 1 | from pysnmp.hlapi import CommunityData -2 | +2 | 3 | CommunityData("public", mpModel=0) # S508 | ^^^^^^^^^ S508 4 | CommunityData("public", mpModel=1) # S508 @@ -15,8 +15,6 @@ S508.py:4:25: S508 The use of SNMPv1 and SNMPv2 is insecure. Use SNMPv3 if able. 3 | CommunityData("public", mpModel=0) # S508 4 | CommunityData("public", mpModel=1) # S508 | ^^^^^^^^^ S508 -5 | +5 | 6 | CommunityData("public", mpModel=2) # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S509_S509.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S509_S509.py.snap index f9ba5df59d447..f676630f9151f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S509_S509.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S509_S509.py.snap @@ -13,8 +13,6 @@ S509.py:5:16: S509 You should not use SNMPv3 without encryption. `noAuthNoPriv` 4 | insecure = UsmUserData("securityName") # S509 5 | auth_no_priv = UsmUserData("securityName", "authName") # S509 | ^^^^^^^^^^^ S509 -6 | +6 | 7 | less_insecure = UsmUserData("securityName", "authName", "privName") # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S601_S601.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S601_S601.py.snap index 11c0d31bbb8d2..3479fa2b9e6cf 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S601_S601.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S601_S601.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S601.py:3:1: S601 Possible shell injection via Paramiko call; check inputs are properly sanitized | 1 | import paramiko -2 | +2 | 3 | paramiko.exec_command('something; really; unsafe') | ^^^^^^^^^^^^^^^^^^^^^ S601 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S602_S602.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S602_S602.py.snap index 6976a96c1d1cb..54f3baf9f8b63 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S602_S602.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S602_S602.py.snap @@ -45,7 +45,7 @@ S602.py:8:1: S602 `subprocess` call with `shell=True` seems safe, but may be cha 7 | check_output("true", shell=True) 8 | run("true", shell=True) | ^^^ S602 - 9 | + 9 | 10 | # Check values that truthy values are treated as true. | @@ -83,7 +83,7 @@ S602.py:14:1: S602 `subprocess` call with truthy `shell` seems safe, but may be 13 | Popen("true", shell={1: 1}) 14 | Popen("true", shell=(1,)) | ^^^^^ S602 -15 | +15 | 16 | # Check command argument looks unsafe. | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S603_S603.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S603_S603.py.snap index 052f58dd6a921..13003f8def1c3 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S603_S603.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S603_S603.py.snap @@ -1,104 +1,219 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs --- -S603.py:4:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:5:1: S603 `subprocess` call: check for execution of untrusted input | 3 | # Different Popen wrappers are checked. -4 | Popen("true", shell=False) +4 | a = input() +5 | Popen(a, shell=False) | ^^^^^ S603 -5 | call("true", shell=False) -6 | check_call("true", shell=False) +6 | call(a, shell=False) +7 | check_call(a, shell=False) | -S603.py:5:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:6:1: S603 `subprocess` call: check for execution of untrusted input | -3 | # Different Popen wrappers are checked. -4 | Popen("true", shell=False) -5 | call("true", shell=False) +4 | a = input() +5 | Popen(a, shell=False) +6 | call(a, shell=False) | ^^^^ S603 -6 | check_call("true", shell=False) -7 | check_output("true", shell=False) +7 | check_call(a, shell=False) +8 | check_output(a, shell=False) | -S603.py:6:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:7:1: S603 `subprocess` call: check for execution of untrusted input | -4 | Popen("true", shell=False) -5 | call("true", shell=False) -6 | check_call("true", shell=False) +5 | Popen(a, shell=False) +6 | call(a, shell=False) +7 | check_call(a, shell=False) | ^^^^^^^^^^ S603 -7 | check_output("true", shell=False) -8 | run("true", shell=False) +8 | check_output(a, shell=False) +9 | run(a, shell=False) | -S603.py:7:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:8:1: S603 `subprocess` call: check for execution of untrusted input | -5 | call("true", shell=False) -6 | check_call("true", shell=False) -7 | check_output("true", shell=False) +6 | call(a, shell=False) +7 | check_call(a, shell=False) +8 | check_output(a, shell=False) | ^^^^^^^^^^^^ S603 -8 | run("true", shell=False) +9 | run(a, shell=False) | -S603.py:8:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:9:1: S603 `subprocess` call: check for execution of untrusted input | - 6 | check_call("true", shell=False) - 7 | check_output("true", shell=False) - 8 | run("true", shell=False) + 7 | check_call(a, shell=False) + 8 | check_output(a, shell=False) + 9 | run(a, shell=False) | ^^^ S603 - 9 | -10 | # Values that falsey values are treated as false. +10 | +11 | # Falsey values are treated as false. | -S603.py:11:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:12:1: S603 `subprocess` call: check for execution of untrusted input | -10 | # Values that falsey values are treated as false. -11 | Popen("true", shell=0) +11 | # Falsey values are treated as false. +12 | Popen(a, shell=0) | ^^^^^ S603 -12 | Popen("true", shell=[]) -13 | Popen("true", shell={}) +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) | -S603.py:12:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:13:1: S603 `subprocess` call: check for execution of untrusted input | -10 | # Values that falsey values are treated as false. -11 | Popen("true", shell=0) -12 | Popen("true", shell=[]) +11 | # Falsey values are treated as false. +12 | Popen(a, shell=0) +13 | Popen(a, shell=[]) | ^^^^^ S603 -13 | Popen("true", shell={}) -14 | Popen("true", shell=None) +14 | Popen(a, shell={}) +15 | Popen(a, shell=None) | -S603.py:13:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:14:1: S603 `subprocess` call: check for execution of untrusted input | -11 | Popen("true", shell=0) -12 | Popen("true", shell=[]) -13 | Popen("true", shell={}) +12 | Popen(a, shell=0) +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) | ^^^^^ S603 -14 | Popen("true", shell=None) +15 | Popen(a, shell=None) | -S603.py:14:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:15:1: S603 `subprocess` call: check for execution of untrusted input | -12 | Popen("true", shell=[]) -13 | Popen("true", shell={}) -14 | Popen("true", shell=None) +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) +15 | Popen(a, shell=None) | ^^^^^ S603 -15 | -16 | # Unknown values are treated as falsey. +16 | +17 | # Unknown values are treated as falsey. | -S603.py:17:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:18:1: S603 `subprocess` call: check for execution of untrusted input | -16 | # Unknown values are treated as falsey. -17 | Popen("true", shell=True if True else False) +17 | # Unknown values are treated as falsey. +18 | Popen(a, shell=True if True else False) | ^^^^^ S603 -18 | -19 | # No value is also caught. +19 | +20 | # No value is also caught. + | + +S603.py:21:1: S603 `subprocess` call: check for execution of untrusted input + | +20 | # No value is also caught. +21 | Popen(a) + | ^^^^^ S603 +22 | +23 | # Literals are fine, they're trusted. + | + +S603.py:24:1: S603 `subprocess` call: check for execution of untrusted input + | +23 | # Literals are fine, they're trusted. +24 | run("true") + | ^^^ S603 +25 | Popen(["true"]) +26 | Popen("true", shell=False) + | + +S603.py:25:1: S603 `subprocess` call: check for execution of untrusted input + | +23 | # Literals are fine, they're trusted. +24 | run("true") +25 | Popen(["true"]) + | ^^^^^ S603 +26 | Popen("true", shell=False) +27 | call("true", shell=False) + | + +S603.py:26:1: S603 `subprocess` call: check for execution of untrusted input + | +24 | run("true") +25 | Popen(["true"]) +26 | Popen("true", shell=False) + | ^^^^^ S603 +27 | call("true", shell=False) +28 | check_call("true", shell=False) + | + +S603.py:27:1: S603 `subprocess` call: check for execution of untrusted input + | +25 | Popen(["true"]) +26 | Popen("true", shell=False) +27 | call("true", shell=False) + | ^^^^ S603 +28 | check_call("true", shell=False) +29 | check_output("true", shell=False) + | + +S603.py:28:1: S603 `subprocess` call: check for execution of untrusted input + | +26 | Popen("true", shell=False) +27 | call("true", shell=False) +28 | check_call("true", shell=False) + | ^^^^^^^^^^ S603 +29 | check_output("true", shell=False) +30 | run("true", shell=False) + | + +S603.py:29:1: S603 `subprocess` call: check for execution of untrusted input + | +27 | call("true", shell=False) +28 | check_call("true", shell=False) +29 | check_output("true", shell=False) + | ^^^^^^^^^^^^ S603 +30 | run("true", shell=False) + | + +S603.py:30:1: S603 `subprocess` call: check for execution of untrusted input + | +28 | check_call("true", shell=False) +29 | check_output("true", shell=False) +30 | run("true", shell=False) + | ^^^ S603 +31 | +32 | # Not through assignments though. + | + +S603.py:34:1: S603 `subprocess` call: check for execution of untrusted input + | +32 | # Not through assignments though. +33 | cmd = ["true"] +34 | run(cmd) + | ^^^ S603 +35 | +36 | # Instant named expressions are fine. + | + +S603.py:37:1: S603 `subprocess` call: check for execution of untrusted input + | +36 | # Instant named expressions are fine. +37 | run(c := "true") + | ^^^ S603 +38 | +39 | # But non-instant are not. + | + +S603.py:41:1: S603 `subprocess` call: check for execution of untrusted input + | +39 | # But non-instant are not. +40 | (e := "echo") +41 | run(e) + | ^^^ S603 + | + +S603.py:46:1: S603 `subprocess` call: check for execution of untrusted input + | +44 | # https://github.com/astral-sh/ruff/issues/17798 +45 | # Tuple literals are trusted +46 | check_output(("literal", "cmd", "using", "tuple"), text=True) + | ^^^^^^^^^^^^ S603 +47 | Popen(("literal", "cmd", "using", "tuple")) | -S603.py:20:1: S603 `subprocess` call: check for execution of untrusted input +S603.py:47:1: S603 `subprocess` call: check for execution of untrusted input | -19 | # No value is also caught. -20 | Popen("true") +45 | # Tuple literals are trusted +46 | check_output(("literal", "cmd", "using", "tuple"), text=True) +47 | Popen(("literal", "cmd", "using", "tuple")) | ^^^^^ S603 | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S604_S604.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S604_S604.py.snap index 3b05258325e43..a84c6314e615e 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S604_S604.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S604_S604.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S604.py:5:1: S604 Function call with `shell=True` parameter identified, security issue | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S605_S605.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S605_S605.py.snap index aca51dd2663a3..9ad140057445b 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S605_S605.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S605_S605.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S605.py:8:1: S605 Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell` | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S606_S606.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S606_S606.py.snap index 32c365195029e..6b98f5716778f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S606_S606.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S606_S606.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S606.py:4:1: S606 Starting a process without a shell | @@ -166,5 +167,3 @@ S606.py:20:1: S606 Starting a process without a shell 20 | os.startfile("true") | ^^^^^^^^^^^^ S606 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S607_S607.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S607_S607.py.snap index 1e82703d36325..ca8c9abd8416e 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S607_S607.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S607_S607.py.snap @@ -216,8 +216,6 @@ S607.py:37:14: S607 Starting a process with a partial executable path 36 | os.spawnvpe("true") 37 | os.startfile("true") | ^^^^^^ S607 -38 | +38 | 39 | # Check it does not fail for full paths. | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S608_S608.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S608_S608.py.snap index b44cc8f786b37..2170539c1747f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S608_S608.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S608_S608.py.snap @@ -45,14 +45,14 @@ S608.py:6:10: S608 Possible SQL injection vector through string-based query cons 5 | query4 = "SELECT {} FROM table;".format(var) 6 | query5 = f"SELECT * FROM table WHERE var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -7 | +7 | 8 | query6 = "DELETE FROM table WHERE var = %s" % (var,) | S608.py:8:10: S608 Possible SQL injection vector through string-based query construction | 6 | query5 = f"SELECT * FROM table WHERE var = {var}" - 7 | + 7 | 8 | query6 = "DELETE FROM table WHERE var = %s" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 9 | query7 = "DELETE FROM table WHERE VAR = " + var @@ -93,14 +93,14 @@ S608.py:12:11: S608 Possible SQL injection vector through string-based query con 11 | query9 = "DELETE FROM table WHERE var = {}".format(var) 12 | query10 = f"DELETE FROM table WHERE var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -13 | +13 | 14 | query11 = "INSERT INTO table VALUES (%s)" % (var,) | S608.py:14:11: S608 Possible SQL injection vector through string-based query construction | 12 | query10 = f"DELETE FROM table WHERE var = {var}" -13 | +13 | 14 | query11 = "INSERT INTO table VALUES (%s)" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 15 | query12 = "INSERT INTO TABLE VALUES (" + var + ")" @@ -131,14 +131,14 @@ S608.py:17:11: S608 Possible SQL injection vector through string-based query con 16 | query13 = "INSERT INTO {} VALUES ({})".format(table, var) 17 | query14 = f"INSERT INTO {table} VALUES var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -18 | +18 | 19 | query15 = "UPDATE %s SET var = %s" % (table, var) | S608.py:19:11: S608 Possible SQL injection vector through string-based query construction | 17 | query14 = f"INSERT INTO {table} VALUES var = {var}" -18 | +18 | 19 | query15 = "UPDATE %s SET var = %s" % (table, var) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 20 | query16 = "UPDATE " + table + " SET var = " + var @@ -169,14 +169,14 @@ S608.py:22:11: S608 Possible SQL injection vector through string-based query con 21 | query17 = "UPDATE {} SET var = {}".format(table, var) 22 | query18 = f"UPDATE {table} SET var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -23 | +23 | 24 | query19 = "select %s from table" % (var,) | S608.py:24:11: S608 Possible SQL injection vector through string-based query construction | 22 | query18 = f"UPDATE {table} SET var = {var}" -23 | +23 | 24 | query19 = "select %s from table" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 25 | query20 = "select var from " + table @@ -217,14 +217,14 @@ S608.py:28:11: S608 Possible SQL injection vector through string-based query con 27 | query22 = "select {} from table;".format(var) 28 | query23 = f"select * from table where var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -29 | +29 | 30 | query24 = "delete from table where var = %s" % (var,) | S608.py:30:11: S608 Possible SQL injection vector through string-based query construction | 28 | query23 = f"select * from table where var = {var}" -29 | +29 | 30 | query24 = "delete from table where var = %s" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 31 | query25 = "delete from table where var = " + var @@ -265,14 +265,14 @@ S608.py:34:11: S608 Possible SQL injection vector through string-based query con 33 | query27 = "delete from table where var = {}".format(var) 34 | query28 = f"delete from table where var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -35 | +35 | 36 | query29 = "insert into table values (%s)" % (var,) | S608.py:36:11: S608 Possible SQL injection vector through string-based query construction | 34 | query28 = f"delete from table where var = {var}" -35 | +35 | 36 | query29 = "insert into table values (%s)" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 37 | query30 = "insert into table values (" + var + ")" @@ -303,14 +303,14 @@ S608.py:39:11: S608 Possible SQL injection vector through string-based query con 38 | query31 = "insert into {} values ({})".format(table, var) 39 | query32 = f"insert into {table} values var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -40 | +40 | 41 | query33 = "update %s set var = %s" % (table, var) | S608.py:41:11: S608 Possible SQL injection vector through string-based query construction | 39 | query32 = f"insert into {table} values var = {var}" -40 | +40 | 41 | query33 = "update %s set var = %s" % (table, var) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 42 | query34 = "update " + table + " set var = " + var @@ -341,7 +341,7 @@ S608.py:44:11: S608 Possible SQL injection vector through string-based query con 43 | query35 = "update {} set var = {}".format(table, var) 44 | query36 = f"update {table} set var = {var}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -45 | +45 | 46 | # multi-line failures | @@ -356,7 +356,7 @@ S608.py:48:12: S608 Possible SQL injection vector through string-based query con 51 | | WHERE var = %s 52 | | """ % var | |_____________^ S608 -53 | +53 | 54 | def query38(): | @@ -370,7 +370,7 @@ S608.py:55:12: S608 Possible SQL injection vector through string-based query con 58 | | WHERE var = 59 | | """ + var | |_____________^ S608 -60 | +60 | 61 | def query39(): | @@ -384,7 +384,7 @@ S608.py:62:12: S608 Possible SQL injection vector through string-based query con 65 | | WHERE var = {} 66 | | """.format(var) | |___________________^ S608 -67 | +67 | 68 | def query40(): | @@ -398,7 +398,7 @@ S608.py:69:12: S608 Possible SQL injection vector through string-based query con 72 | | WHERE var = {var} 73 | | """ | |_______^ S608 -74 | +74 | 75 | def query41(): | @@ -406,8 +406,7 @@ S608.py:77:9: S608 Possible SQL injection vector through string-based query cons | 75 | def query41(): 76 | return ( -77 | "SELECT * " - | _________^ +77 | / "SELECT * " 78 | | "FROM table " 79 | | f"WHERE var = {var}" | |____________________________^ S608 @@ -448,7 +447,7 @@ S608.py:86:30: S608 Possible SQL injection vector through string-based query con 85 | query44 = cursor.execute("SELECT * FROM table WHERE var = {}".format(var)) 86 | query45 = cursor.executemany("SELECT * FROM table WHERE var = %s" % var, []) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -87 | +87 | 88 | # # pass | @@ -457,7 +456,7 @@ S608.py:98:11: S608 Possible SQL injection vector through string-based query con 97 | # # INSERT without INTO (e.g. MySQL and derivatives) 98 | query46 = "INSERT table VALUES (%s)" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 - 99 | + 99 | 100 | # # REPLACE (e.g. MySQL and derivatives, SQLite) | @@ -475,7 +474,7 @@ S608.py:102:11: S608 Possible SQL injection vector through string-based query co 101 | query47 = "REPLACE INTO table VALUES (%s)" % (var,) 102 | query48 = "REPLACE table VALUES (%s)" % (var,) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -103 | +103 | 104 | query49 = "Deselect something that is not SQL even though it has a ' from ' somewhere in %s." % "there" | @@ -493,7 +492,7 @@ S608.py:112:1: S608 Possible SQL injection vector through string-based query con 111 | "SELECT * FROM " + ("table1" if x > 0 else "table2") # query50 112 | "SELECT * FROM " + ("table1" if x > 0 else ["table2"]) # query51 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S608 -113 | +113 | 114 | # test cases from #12044 | @@ -506,7 +505,7 @@ S608.py:117:12: S608 Possible SQL injection vector through string-based query co 119 | | FROM bar 120 | | """ | |_______^ S608 -121 | +121 | 122 | def query53(): | @@ -520,7 +519,7 @@ S608.py:123:12: S608 Possible SQL injection vector through string-based query co 126 | | FROM bar 127 | | """ | |_______^ S608 -128 | +128 | 129 | def query54(): | @@ -534,46 +533,74 @@ S608.py:130:12: S608 Possible SQL injection vector through string-based query co 133 | | bar 134 | | """ | |_______^ S608 -135 | +135 | 136 | query55 = f"""SELECT * FROM | S608.py:136:11: S608 Possible SQL injection vector through string-based query construction | 134 | """ -135 | +135 | 136 | query55 = f"""SELECT * FROM | ___________^ 137 | | {var}.table 138 | | """ | |___^ S608 -139 | +139 | 140 | query56 = f"""SELECT * | S608.py:140:11: S608 Possible SQL injection vector through string-based query construction | 138 | """ -139 | +139 | 140 | query56 = f"""SELECT * | ___________^ 141 | | FROM {var}.table 142 | | """ | |___^ S608 -143 | +143 | 144 | query57 = f""" | S608.py:144:11: S608 Possible SQL injection vector through string-based query construction | 142 | """ -143 | +143 | 144 | query57 = f""" | ___________^ 145 | | SELECT * 146 | | FROM {var}.table 147 | | """ | |___^ S608 -148 | +148 | 149 | query57 = f""" | + +S608.py:160:11: S608 Possible SQL injection vector through string-based query construction + | +159 | # https://github.com/astral-sh/ruff/issues/15653 +160 | query59 = f""" + | ___________^ +161 | | SELECT *, foo +162 | | FROM ({user_input}) raw +163 | | """ + | |___^ S608 +164 | query60 = f""" +165 | SELECT *, + | + +S608.py:164:11: S608 Possible SQL injection vector through string-based query construction + | +162 | FROM ({user_input}) raw +163 | """ +164 | query60 = f""" + | ___________^ +165 | | SELECT *, +166 | | foo +167 | | FROM ({user_input}) raw +168 | | """ + | |___^ S608 +169 | +170 | # https://github.com/astral-sh/ruff/issues/17967 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S609_S609.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S609_S609.py.snap index 0b98e44ce4e84..2482ce3206c04 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S609_S609.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S609_S609.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S609.py:4:10: S609 Possible wildcard injection in call due to `*` usage | 2 | import subprocess -3 | +3 | 4 | os.popen("chmod +w foo*") | ^^^^^^^^^^^^^^^ S609 5 | subprocess.Popen("/bin/chown root: *", shell=True) diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S610_S610.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S610_S610.py.snap index deb3bdcf182cf..4a8bf84b1a97f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S610_S610.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S610_S610.py.snap @@ -55,7 +55,7 @@ S610.py:9:44: S610 Use of Django `extra` can lead to SQL injection vulnerabiliti 8 | User.objects.filter(username='admin').extra(where=['%secure' % 'nos']) 9 | User.objects.filter(username='admin').extra(where=['{}secure'.format('no')]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S610 -10 | +10 | 11 | query = '"username") AS "username", * FROM "auth_user" WHERE 1=1 OR "username"=? --' | @@ -64,7 +64,7 @@ S610.py:12:44: S610 Use of Django `extra` can lead to SQL injection vulnerabilit 11 | query = '"username") AS "username", * FROM "auth_user" WHERE 1=1 OR "username"=? --' 12 | User.objects.filter(username='admin').extra(select={'test': query}) | ^^^^^^^^^^^^^^^^^^^^^^^^ S610 -13 | +13 | 14 | where_var = ['1=1) OR 1=1 AND (1=1'] | @@ -73,7 +73,7 @@ S610.py:15:44: S610 Use of Django `extra` can lead to SQL injection vulnerabilit 14 | where_var = ['1=1) OR 1=1 AND (1=1'] 15 | User.objects.filter(username='admin').extra(where=where_var) | ^^^^^^^^^^^^^^^^^ S610 -16 | +16 | 17 | where_str = '1=1) OR 1=1 AND (1=1' | @@ -82,7 +82,7 @@ S610.py:18:44: S610 Use of Django `extra` can lead to SQL injection vulnerabilit 17 | where_str = '1=1) OR 1=1 AND (1=1' 18 | User.objects.filter(username='admin').extra(where=[where_str]) | ^^^^^^^^^^^^^^^^^^^ S610 -19 | +19 | 20 | tables_var = ['django_content_type" WHERE "auth_user"."username"="admin'] | @@ -91,7 +91,7 @@ S610.py:21:25: S610 Use of Django `extra` can lead to SQL injection vulnerabilit 20 | tables_var = ['django_content_type" WHERE "auth_user"."username"="admin'] 21 | User.objects.all().extra(tables=tables_var).distinct() | ^^^^^^^^^^^^^^^^^^^ S610 -22 | +22 | 23 | tables_str = 'django_content_type" WHERE "auth_user"."username"="admin' | @@ -100,6 +100,6 @@ S610.py:24:25: S610 Use of Django `extra` can lead to SQL injection vulnerabilit 23 | tables_str = 'django_content_type" WHERE "auth_user"."username"="admin' 24 | User.objects.all().extra(tables=[tables_str]).distinct() | ^^^^^^^^^^^^^^^^^^^^^ S610 -25 | +25 | 26 | # OK | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S611_S611.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S611_S611.py.snap index 026360e756ff1..f3fd1629c589f 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S611_S611.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S611_S611.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +snapshot_kind: text --- S611.py:5:27: S611 Use of `RawSQL` can lead to SQL injection vulnerabilities | @@ -56,5 +57,3 @@ S611.py:13:27: S611 Use of `RawSQL` can lead to SQL injection vulnerabilities 13 | User.objects.annotate(val=RawSQL(params=[], sql='{}secure'.format('no'))) | ^^^^^^ S611 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S612_S612.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S612_S612.py.snap index 7e70531b62a2f..f7a16b78e4c1c 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S612_S612.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S612_S612.py.snap @@ -4,11 +4,9 @@ source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs S612.py:3:5: S612 Use of insecure `logging.config.listen` detected | 1 | import logging.config -2 | +2 | 3 | t = logging.config.listen(9999) | ^^^^^^^^^^^^^^^^^^^^^ S612 -4 | +4 | 5 | def verify_func(): | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S701_S701.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S701_S701.py.snap index a6f08cb71ab0a..61b156e89196a 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S701_S701.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S701_S701.py.snap @@ -27,14 +27,14 @@ S701.py:13:13: S701 Using jinja2 templates with `autoescape=False` is dangerous 12 | load=templateLoader, 13 | autoescape=False) # S701 | ^^^^^^^^^^^^^^^^ S701 -14 | +14 | 15 | Environment(loader=templateLoader, # S701 | S701.py:15:1: S701 By default, jinja2 sets `autoescape` to `False`. Consider using `autoescape=True` or the `select_autoescape` function to mitigate XSS vulnerabilities. | 13 | autoescape=False) # S701 -14 | +14 | 15 | Environment(loader=templateLoader, # S701 | ^^^^^^^^^^^ S701 16 | load=templateLoader) @@ -47,5 +47,3 @@ S701.py:29:36: S701 Using jinja2 templates with `autoescape=False` is dangerous 29 | Environment(loader=templateLoader, autoescape=fake_func()) # S701 | ^^^^^^^^^^^^^^^^^^^^^^ S701 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S702_S702.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S702_S702.py.snap index fa943d7acf938..3297e5af7e831 100644 --- a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S702_S702.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S702_S702.py.snap @@ -5,14 +5,14 @@ S702.py:6:1: S702 Mako templates allow HTML and JavaScript rendering by default | 6 | Template("hello") | ^^^^^^^^ S702 -7 | +7 | 8 | mako.template.Template("hern") | S702.py:8:1: S702 Mako templates allow HTML and JavaScript rendering by default and are inherently open to XSS attacks | 6 | Template("hello") -7 | +7 | 8 | mako.template.Template("hern") | ^^^^^^^^^^^^^^^^^^^^^^ S702 9 | template.Template("hern") @@ -24,5 +24,3 @@ S702.py:9:1: S702 Mako templates allow HTML and JavaScript rendering by default 9 | template.Template("hern") | ^^^^^^^^^^^^^^^^^ S702 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S704_S704.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S704_S704.py.snap new file mode 100644 index 0000000000000..02a25f90f6ecd --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S704_S704.py.snap @@ -0,0 +1,58 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S704.py:5:1: S704 Unsafe use of `markupsafe.Markup` detected + | +4 | content = "<script>alert('Hello, world!')</script>" +5 | Markup(f"unsafe {content}") # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 +6 | flask.Markup("unsafe {}".format(content)) # S704 +7 | Markup("safe {}").format(content) + | + +S704.py:6:1: S704 Unsafe use of `flask.Markup` detected + | +4 | content = "<script>alert('Hello, world!')</script>" +5 | Markup(f"unsafe {content}") # S704 +6 | flask.Markup("unsafe {}".format(content)) # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 +7 | Markup("safe {}").format(content) +8 | flask.Markup(b"safe {}", encoding='utf-8').format(content) + | + +S704.py:10:1: S704 Unsafe use of `markupsafe.Markup` detected + | + 8 | flask.Markup(b"safe {}", encoding='utf-8').format(content) + 9 | escape(content) +10 | Markup(content) # S704 + | ^^^^^^^^^^^^^^^ S704 +11 | flask.Markup("unsafe %s" % content) # S704 +12 | Markup(object="safe") + | + +S704.py:11:1: S704 Unsafe use of `flask.Markup` detected + | + 9 | escape(content) +10 | Markup(content) # S704 +11 | flask.Markup("unsafe %s" % content) # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 +12 | Markup(object="safe") +13 | Markup(object="unsafe {}".format(content)) # Not currently detected + | + +S704.py:17:1: S704 Unsafe use of `markupsafe.Markup` detected + | +15 | # NOTE: We may be able to get rid of these false positives with ty +16 | # if it includes comprehensive constant expression detection/evaluation. +17 | Markup("*" * 8) # S704 (false positive) + | ^^^^^^^^^^^^^^^ S704 +18 | flask.Markup("hello {}".format("world")) # S704 (false positive) + | + +S704.py:18:1: S704 Unsafe use of `flask.Markup` detected + | +16 | # if it includes comprehensive constant expression detection/evaluation. +17 | Markup("*" * 8) # S704 (false positive) +18 | flask.Markup("hello {}".format("world")) # S704 (false positive) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_extend_markup_names.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_extend_markup_names.py.snap new file mode 100644 index 0000000000000..924e5f96232bc --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_extend_markup_names.py.snap @@ -0,0 +1,18 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S704_extend_markup_names.py:5:1: S704 Unsafe use of `markupsafe.Markup` detected + | +4 | content = "<script>alert('Hello, world!')</script>" +5 | Markup(f"unsafe {content}") # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 +6 | literal(f"unsafe {content}") # S704 + | + +S704_extend_markup_names.py:6:1: S704 Unsafe use of `webhelpers.html.literal` detected + | +4 | content = "<script>alert('Hello, world!')</script>" +5 | Markup(f"unsafe {content}") # S704 +6 | literal(f"unsafe {content}") # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_skip_early_out.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_skip_early_out.py.snap new file mode 100644 index 0000000000000..8c04fdf49fb6d --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__extend_allow_callables__S704_S704_skip_early_out.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S704_skip_early_out.py:7:1: S704 Unsafe use of `webhelpers.html.literal` detected + | +5 | # markupsafe or flask first. +6 | content = "<script>alert('Hello, world!')</script>" +7 | literal(f"unsafe {content}") # S704 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S704 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S301_S301.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S301_S301.py.snap new file mode 100644 index 0000000000000..e89cb34be17f8 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S301_S301.py.snap @@ -0,0 +1,26 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S301.py:3:1: S301 `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue + | +1 | import pickle +2 | +3 | pickle.loads() + | ^^^^^^^^^^^^^^ S301 + | + +S301.py:7:5: S301 `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue + | +6 | # https://github.com/astral-sh/ruff/issues/15522 +7 | map(pickle.load, []) + | ^^^^^^^^^^^ S301 +8 | foo = pickle.load + | + +S301.py:8:7: S301 `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue + | +6 | # https://github.com/astral-sh/ruff/issues/15522 +7 | map(pickle.load, []) +8 | foo = pickle.load + | ^^^^^^^^^^^ S301 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S307_S307.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S307_S307.py.snap new file mode 100644 index 0000000000000..dbad2672aaf83 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S307_S307.py.snap @@ -0,0 +1,34 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S307.py:3:7: S307 Use of possibly insecure function; consider using `ast.literal_eval` + | +1 | import os +2 | +3 | print(eval("1+1")) # S307 + | ^^^^^^^^^^^ S307 +4 | print(eval("os.getcwd()")) # S307 + | + +S307.py:4:7: S307 Use of possibly insecure function; consider using `ast.literal_eval` + | +3 | print(eval("1+1")) # S307 +4 | print(eval("os.getcwd()")) # S307 + | ^^^^^^^^^^^^^^^^^^^ S307 + | + +S307.py:16:5: S307 Use of possibly insecure function; consider using `ast.literal_eval` + | +15 | # https://github.com/astral-sh/ruff/issues/15522 +16 | map(eval, []) + | ^^^^ S307 +17 | foo = eval + | + +S307.py:17:7: S307 Use of possibly insecure function; consider using `ast.literal_eval` + | +15 | # https://github.com/astral-sh/ruff/issues/15522 +16 | map(eval, []) +17 | foo = eval + | ^^^^ S307 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S308_S308.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S308_S308.py.snap new file mode 100644 index 0000000000000..bc0f4d524e9a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S308_S308.py.snap @@ -0,0 +1,132 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S308.py:6:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +4 | def bad_func(): +5 | inject = "harmful_input" +6 | mark_safe(inject) + | ^^^^^^^^^^^^^^^^^ S308 +7 | mark_safe("I will add" + inject + "to my string") +8 | mark_safe("I will add %s to my string" % inject) + | + +S308.py:7:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +5 | inject = "harmful_input" +6 | mark_safe(inject) +7 | mark_safe("I will add" + inject + "to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +8 | mark_safe("I will add %s to my string" % inject) +9 | mark_safe("I will add {} to my string".format(inject)) + | + +S308.py:8:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | + 6 | mark_safe(inject) + 7 | mark_safe("I will add" + inject + "to my string") + 8 | mark_safe("I will add %s to my string" % inject) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 + 9 | mark_safe("I will add {} to my string".format(inject)) +10 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:9:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | + 7 | mark_safe("I will add" + inject + "to my string") + 8 | mark_safe("I will add %s to my string" % inject) + 9 | mark_safe("I will add {} to my string".format(inject)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +10 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:10:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | + 8 | mark_safe("I will add %s to my string" % inject) + 9 | mark_safe("I will add {} to my string".format(inject)) +10 | mark_safe(f"I will add {inject} to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +11 | +12 | def good_func(): + | + +S308.py:16:2: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +16 | @mark_safe + | ^^^^^^^^^ S308 +17 | def some_func(): +18 | return '<script>alert("evil!")</script>' + | + +S308.py:26:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +24 | def bad_func(): +25 | inject = "harmful_input" +26 | mark_safe(inject) + | ^^^^^^^^^^^^^^^^^ S308 +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) + | + +S308.py:27:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +25 | inject = "harmful_input" +26 | mark_safe(inject) +27 | mark_safe("I will add" + inject + "to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) + | + +S308.py:28:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +26 | mark_safe(inject) +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +29 | mark_safe("I will add {} to my string".format(inject)) +30 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:29:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +27 | mark_safe("I will add" + inject + "to my string") +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +30 | mark_safe(f"I will add {inject} to my string") + | + +S308.py:30:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +28 | mark_safe("I will add %s to my string" % inject) +29 | mark_safe("I will add {} to my string".format(inject)) +30 | mark_safe(f"I will add {inject} to my string") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S308 +31 | +32 | def good_func(): + | + +S308.py:36:2: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +36 | @mark_safe + | ^^^^^^^^^ S308 +37 | def some_func(): +38 | return '<script>alert("evil!")</script>' + | + +S308.py:42:5: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +41 | # https://github.com/astral-sh/ruff/issues/15522 +42 | map(mark_safe, []) + | ^^^^^^^^^ S308 +43 | foo = mark_safe + | + +S308.py:43:7: S308 Use of `mark_safe` may expose cross-site scripting vulnerabilities + | +41 | # https://github.com/astral-sh/ruff/issues/15522 +42 | map(mark_safe, []) +43 | foo = mark_safe + | ^^^^^^^^^ S308 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S310_S310.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S310_S310.py.snap new file mode 100644 index 0000000000000..6a02c7b1fd182 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S310_S310.py.snap @@ -0,0 +1,248 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S310.py:6:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +4 | urllib.request.urlopen(url=f'http://www.google.com') +5 | urllib.request.urlopen(url='http://' + 'www' + '.google.com') +6 | urllib.request.urlopen(url='http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +7 | urllib.request.urlopen(url=f'http://www.google.com', **kwargs) +8 | urllib.request.urlopen('http://www.google.com') + | + +S310.py:7:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +5 | urllib.request.urlopen(url='http://' + 'www' + '.google.com') +6 | urllib.request.urlopen(url='http://www.google.com', **kwargs) +7 | urllib.request.urlopen(url=f'http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +8 | urllib.request.urlopen('http://www.google.com') +9 | urllib.request.urlopen(f'http://www.google.com') + | + +S310.py:10:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | + 8 | urllib.request.urlopen('http://www.google.com') + 9 | urllib.request.urlopen(f'http://www.google.com') +10 | urllib.request.urlopen('file:///foo/bar/baz') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +11 | urllib.request.urlopen(url) + | + +S310.py:11:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | + 9 | urllib.request.urlopen(f'http://www.google.com') +10 | urllib.request.urlopen('file:///foo/bar/baz') +11 | urllib.request.urlopen(url) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +12 | +13 | urllib.request.Request(url='http://www.google.com') + | + +S310.py:16:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +14 | urllib.request.Request(url=f'http://www.google.com') +15 | urllib.request.Request(url='http://' + 'www' + '.google.com') +16 | urllib.request.Request(url='http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +17 | urllib.request.Request(url=f'http://www.google.com', **kwargs) +18 | urllib.request.Request('http://www.google.com') + | + +S310.py:17:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +15 | urllib.request.Request(url='http://' + 'www' + '.google.com') +16 | urllib.request.Request(url='http://www.google.com', **kwargs) +17 | urllib.request.Request(url=f'http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +18 | urllib.request.Request('http://www.google.com') +19 | urllib.request.Request(f'http://www.google.com') + | + +S310.py:20:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +18 | urllib.request.Request('http://www.google.com') +19 | urllib.request.Request(f'http://www.google.com') +20 | urllib.request.Request('file:///foo/bar/baz') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +21 | urllib.request.Request(url) + | + +S310.py:21:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +19 | urllib.request.Request(f'http://www.google.com') +20 | urllib.request.Request('file:///foo/bar/baz') +21 | urllib.request.Request(url) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +22 | +23 | urllib.request.URLopener().open(fullurl='http://www.google.com') + | + +S310.py:23:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +21 | urllib.request.Request(url) +22 | +23 | urllib.request.URLopener().open(fullurl='http://www.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +24 | urllib.request.URLopener().open(fullurl=f'http://www.google.com') +25 | urllib.request.URLopener().open(fullurl='http://' + 'www' + '.google.com') + | + +S310.py:24:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +23 | urllib.request.URLopener().open(fullurl='http://www.google.com') +24 | urllib.request.URLopener().open(fullurl=f'http://www.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +25 | urllib.request.URLopener().open(fullurl='http://' + 'www' + '.google.com') +26 | urllib.request.URLopener().open(fullurl='http://www.google.com', **kwargs) + | + +S310.py:25:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +23 | urllib.request.URLopener().open(fullurl='http://www.google.com') +24 | urllib.request.URLopener().open(fullurl=f'http://www.google.com') +25 | urllib.request.URLopener().open(fullurl='http://' + 'www' + '.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +26 | urllib.request.URLopener().open(fullurl='http://www.google.com', **kwargs) +27 | urllib.request.URLopener().open(fullurl=f'http://www.google.com', **kwargs) + | + +S310.py:26:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +24 | urllib.request.URLopener().open(fullurl=f'http://www.google.com') +25 | urllib.request.URLopener().open(fullurl='http://' + 'www' + '.google.com') +26 | urllib.request.URLopener().open(fullurl='http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +27 | urllib.request.URLopener().open(fullurl=f'http://www.google.com', **kwargs) +28 | urllib.request.URLopener().open('http://www.google.com') + | + +S310.py:27:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +25 | urllib.request.URLopener().open(fullurl='http://' + 'www' + '.google.com') +26 | urllib.request.URLopener().open(fullurl='http://www.google.com', **kwargs) +27 | urllib.request.URLopener().open(fullurl=f'http://www.google.com', **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +28 | urllib.request.URLopener().open('http://www.google.com') +29 | urllib.request.URLopener().open(f'http://www.google.com') + | + +S310.py:28:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +26 | urllib.request.URLopener().open(fullurl='http://www.google.com', **kwargs) +27 | urllib.request.URLopener().open(fullurl=f'http://www.google.com', **kwargs) +28 | urllib.request.URLopener().open('http://www.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +29 | urllib.request.URLopener().open(f'http://www.google.com') +30 | urllib.request.URLopener().open('http://' + 'www' + '.google.com') + | + +S310.py:29:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +27 | urllib.request.URLopener().open(fullurl=f'http://www.google.com', **kwargs) +28 | urllib.request.URLopener().open('http://www.google.com') +29 | urllib.request.URLopener().open(f'http://www.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +30 | urllib.request.URLopener().open('http://' + 'www' + '.google.com') +31 | urllib.request.URLopener().open('file:///foo/bar/baz') + | + +S310.py:30:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +28 | urllib.request.URLopener().open('http://www.google.com') +29 | urllib.request.URLopener().open(f'http://www.google.com') +30 | urllib.request.URLopener().open('http://' + 'www' + '.google.com') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +31 | urllib.request.URLopener().open('file:///foo/bar/baz') +32 | urllib.request.URLopener().open(url) + | + +S310.py:31:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +29 | urllib.request.URLopener().open(f'http://www.google.com') +30 | urllib.request.URLopener().open('http://' + 'www' + '.google.com') +31 | urllib.request.URLopener().open('file:///foo/bar/baz') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +32 | urllib.request.URLopener().open(url) + | + +S310.py:32:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +30 | urllib.request.URLopener().open('http://' + 'www' + '.google.com') +31 | urllib.request.URLopener().open('file:///foo/bar/baz') +32 | urllib.request.URLopener().open(url) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +33 | +34 | urllib.request.urlopen(url=urllib.request.Request('http://www.google.com')) + | + +S310.py:37:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +35 | urllib.request.urlopen(url=urllib.request.Request(f'http://www.google.com')) +36 | urllib.request.urlopen(url=urllib.request.Request('http://' + 'www' + '.google.com')) +37 | urllib.request.urlopen(url=urllib.request.Request('http://www.google.com'), **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +38 | urllib.request.urlopen(url=urllib.request.Request(f'http://www.google.com'), **kwargs) +39 | urllib.request.urlopen(urllib.request.Request('http://www.google.com')) + | + +S310.py:38:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +36 | urllib.request.urlopen(url=urllib.request.Request('http://' + 'www' + '.google.com')) +37 | urllib.request.urlopen(url=urllib.request.Request('http://www.google.com'), **kwargs) +38 | urllib.request.urlopen(url=urllib.request.Request(f'http://www.google.com'), **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +39 | urllib.request.urlopen(urllib.request.Request('http://www.google.com')) +40 | urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) + | + +S310.py:41:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +39 | urllib.request.urlopen(urllib.request.Request('http://www.google.com')) +40 | urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) +41 | urllib.request.urlopen(urllib.request.Request('file:///foo/bar/baz')) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +42 | urllib.request.urlopen(urllib.request.Request(url)) + | + +S310.py:41:24: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +39 | urllib.request.urlopen(urllib.request.Request('http://www.google.com')) +40 | urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) +41 | urllib.request.urlopen(urllib.request.Request('file:///foo/bar/baz')) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 +42 | urllib.request.urlopen(urllib.request.Request(url)) + | + +S310.py:42:1: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +40 | urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) +41 | urllib.request.urlopen(urllib.request.Request('file:///foo/bar/baz')) +42 | urllib.request.urlopen(urllib.request.Request(url)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 + | + +S310.py:42:24: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +40 | urllib.request.urlopen(urllib.request.Request(f'http://www.google.com')) +41 | urllib.request.urlopen(urllib.request.Request('file:///foo/bar/baz')) +42 | urllib.request.urlopen(urllib.request.Request(url)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ S310 + | + +S310.py:46:5: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +45 | # https://github.com/astral-sh/ruff/issues/15522 +46 | map(urllib.request.urlopen, []) + | ^^^^^^^^^^^^^^^^^^^^^^ S310 +47 | foo = urllib.request.urlopen + | + +S310.py:47:7: S310 Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected. + | +45 | # https://github.com/astral-sh/ruff/issues/15522 +46 | map(urllib.request.urlopen, []) +47 | foo = urllib.request.urlopen + | ^^^^^^^^^^^^^^^^^^^^^^ S310 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S311_S311.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S311_S311.py.snap new file mode 100644 index 0000000000000..2a410db20b185 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S311_S311.py.snap @@ -0,0 +1,106 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S311.py:10:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | + 9 | # Errors +10 | random.Random() + | ^^^^^^^^^^^^^^^ S311 +11 | random.random() +12 | random.randrange() + | + +S311.py:11:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | + 9 | # Errors +10 | random.Random() +11 | random.random() + | ^^^^^^^^^^^^^^^ S311 +12 | random.randrange() +13 | random.randint() + | + +S311.py:12:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +10 | random.Random() +11 | random.random() +12 | random.randrange() + | ^^^^^^^^^^^^^^^^^^ S311 +13 | random.randint() +14 | random.choice() + | + +S311.py:13:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +11 | random.random() +12 | random.randrange() +13 | random.randint() + | ^^^^^^^^^^^^^^^^ S311 +14 | random.choice() +15 | random.choices() + | + +S311.py:14:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +12 | random.randrange() +13 | random.randint() +14 | random.choice() + | ^^^^^^^^^^^^^^^ S311 +15 | random.choices() +16 | random.uniform() + | + +S311.py:15:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +13 | random.randint() +14 | random.choice() +15 | random.choices() + | ^^^^^^^^^^^^^^^^ S311 +16 | random.uniform() +17 | random.triangular() + | + +S311.py:16:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +14 | random.choice() +15 | random.choices() +16 | random.uniform() + | ^^^^^^^^^^^^^^^^ S311 +17 | random.triangular() +18 | random.randbytes() + | + +S311.py:17:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +15 | random.choices() +16 | random.uniform() +17 | random.triangular() + | ^^^^^^^^^^^^^^^^^^^ S311 +18 | random.randbytes() + | + +S311.py:18:1: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +16 | random.uniform() +17 | random.triangular() +18 | random.randbytes() + | ^^^^^^^^^^^^^^^^^^ S311 +19 | +20 | # Unrelated + | + +S311.py:26:5: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +25 | # https://github.com/astral-sh/ruff/issues/15522 +26 | map(random.randrange, []) + | ^^^^^^^^^^^^^^^^ S311 +27 | foo = random.randrange + | + +S311.py:27:7: S311 Standard pseudo-random generators are not suitable for cryptographic purposes + | +25 | # https://github.com/astral-sh/ruff/issues/15522 +26 | map(random.randrange, []) +27 | foo = random.randrange + | ^^^^^^^^^^^^^^^^ S311 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S312_S312.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S312_S312.py.snap new file mode 100644 index 0000000000000..4d81c740bfb40 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S312_S312.py.snap @@ -0,0 +1,46 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S312.py:3:1: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | +1 | from telnetlib import Telnet +2 | +3 | Telnet("localhost", 23) + | ^^^^^^^^^^^^^^^^^^^^^^^ S312 + | + +S312.py:7:5: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | +6 | # https://github.com/astral-sh/ruff/issues/15522 +7 | map(Telnet, []) + | ^^^^^^ S312 +8 | foo = Telnet + | + +S312.py:8:7: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | + 6 | # https://github.com/astral-sh/ruff/issues/15522 + 7 | map(Telnet, []) + 8 | foo = Telnet + | ^^^^^^ S312 + 9 | +10 | import telnetlib + | + +S312.py:11:5: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | +10 | import telnetlib +11 | _ = telnetlib.Telnet + | ^^^^^^^^^^^^^^^^ S312 +12 | +13 | from typing import Annotated + | + +S312.py:14:24: S312 Telnet is considered insecure. Use SSH or some other encrypted protocol. + | +13 | from typing import Annotated +14 | foo: Annotated[Telnet, telnetlib.Telnet()] + | ^^^^^^^^^^^^^^^^^^ S312 +15 | +16 | def _() -> Telnet: ... + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S603_S603.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S603_S603.py.snap new file mode 100644 index 0000000000000..2b8d7c974f855 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__preview__S603_S603.py.snap @@ -0,0 +1,125 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S603.py:5:1: S603 `subprocess` call: check for execution of untrusted input + | +3 | # Different Popen wrappers are checked. +4 | a = input() +5 | Popen(a, shell=False) + | ^^^^^ S603 +6 | call(a, shell=False) +7 | check_call(a, shell=False) + | + +S603.py:6:1: S603 `subprocess` call: check for execution of untrusted input + | +4 | a = input() +5 | Popen(a, shell=False) +6 | call(a, shell=False) + | ^^^^ S603 +7 | check_call(a, shell=False) +8 | check_output(a, shell=False) + | + +S603.py:7:1: S603 `subprocess` call: check for execution of untrusted input + | +5 | Popen(a, shell=False) +6 | call(a, shell=False) +7 | check_call(a, shell=False) + | ^^^^^^^^^^ S603 +8 | check_output(a, shell=False) +9 | run(a, shell=False) + | + +S603.py:8:1: S603 `subprocess` call: check for execution of untrusted input + | +6 | call(a, shell=False) +7 | check_call(a, shell=False) +8 | check_output(a, shell=False) + | ^^^^^^^^^^^^ S603 +9 | run(a, shell=False) + | + +S603.py:9:1: S603 `subprocess` call: check for execution of untrusted input + | + 7 | check_call(a, shell=False) + 8 | check_output(a, shell=False) + 9 | run(a, shell=False) + | ^^^ S603 +10 | +11 | # Falsey values are treated as false. + | + +S603.py:12:1: S603 `subprocess` call: check for execution of untrusted input + | +11 | # Falsey values are treated as false. +12 | Popen(a, shell=0) + | ^^^^^ S603 +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) + | + +S603.py:13:1: S603 `subprocess` call: check for execution of untrusted input + | +11 | # Falsey values are treated as false. +12 | Popen(a, shell=0) +13 | Popen(a, shell=[]) + | ^^^^^ S603 +14 | Popen(a, shell={}) +15 | Popen(a, shell=None) + | + +S603.py:14:1: S603 `subprocess` call: check for execution of untrusted input + | +12 | Popen(a, shell=0) +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) + | ^^^^^ S603 +15 | Popen(a, shell=None) + | + +S603.py:15:1: S603 `subprocess` call: check for execution of untrusted input + | +13 | Popen(a, shell=[]) +14 | Popen(a, shell={}) +15 | Popen(a, shell=None) + | ^^^^^ S603 +16 | +17 | # Unknown values are treated as falsey. + | + +S603.py:18:1: S603 `subprocess` call: check for execution of untrusted input + | +17 | # Unknown values are treated as falsey. +18 | Popen(a, shell=True if True else False) + | ^^^^^ S603 +19 | +20 | # No value is also caught. + | + +S603.py:21:1: S603 `subprocess` call: check for execution of untrusted input + | +20 | # No value is also caught. +21 | Popen(a) + | ^^^^^ S603 +22 | +23 | # Literals are fine, they're trusted. + | + +S603.py:34:1: S603 `subprocess` call: check for execution of untrusted input + | +32 | # Not through assignments though. +33 | cmd = ["true"] +34 | run(cmd) + | ^^^ S603 +35 | +36 | # Instant named expressions are fine. + | + +S603.py:41:1: S603 `subprocess` call: check for execution of untrusted input + | +39 | # But non-instant are not. +40 | (e := "echo") +41 | run(e) + | ^^^ S603 + | diff --git a/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__whitelisted_markup_calls__S704_S704_whitelisted_markup_calls.py.snap b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__whitelisted_markup_calls__S704_S704_whitelisted_markup_calls.py.snap new file mode 100644 index 0000000000000..e326335411e9e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__whitelisted_markup_calls__S704_S704_whitelisted_markup_calls.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs +--- +S704_whitelisted_markup_calls.py:9:1: S704 Unsafe use of `markupsafe.Markup` detected + | +7 | # indirect assignments are currently not supported +8 | cleaned = clean(content) +9 | Markup(cleaned) # S704 + | ^^^^^^^^^^^^^^^ S704 + | diff --git a/crates/ruff_linter/src/rules/flake8_blind_except/rules/blind_except.rs b/crates/ruff_linter/src/rules/flake8_blind_except/rules/blind_except.rs index 8682a1268cad8..5680966fe943a 100644 --- a/crates/ruff_linter/src/rules/flake8_blind_except/rules/blind_except.rs +++ b/crates/ruff_linter/src/rules/flake8_blind_except/rules/blind_except.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Expr, Stmt}; -use ruff_python_semantic::analyze::logging; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::logging; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -60,9 +60,9 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: The `try` statement](https://docs.python.org/3/reference/compound_stmts.html#the-try-statement) /// - [Python documentation: Exception hierarchy](https://docs.python.org/3/library/exceptions.html#exception-hierarchy) -/// - [PEP8 Programming Recommendations on bare `except`](https://peps.python.org/pep-0008/#programming-recommendations) -#[violation] -pub struct BlindExcept { +/// - [PEP 8: Programming Recommendations on bare `except`](https://peps.python.org/pep-0008/#programming-recommendations) +#[derive(ViolationMetadata)] +pub(crate) struct BlindExcept { name: String, } @@ -76,7 +76,7 @@ impl Violation for BlindExcept { /// BLE001 pub(crate) fn blind_except( - checker: &mut Checker, + checker: &Checker, type_: Option<&Expr>, name: Option<&str>, body: &[Stmt], @@ -107,7 +107,7 @@ pub(crate) fn blind_except( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BlindExcept { name: builtin_exception_type.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_blind_except/snapshots/ruff_linter__rules__flake8_blind_except__tests__BLE001_BLE.py.snap b/crates/ruff_linter/src/rules/flake8_blind_except/snapshots/ruff_linter__rules__flake8_blind_except__tests__BLE001_BLE.py.snap index 16313b5f91537..3ca28d3cef2c2 100644 --- a/crates/ruff_linter/src/rules/flake8_blind_except/snapshots/ruff_linter__rules__flake8_blind_except__tests__BLE001_BLE.py.snap +++ b/crates/ruff_linter/src/rules/flake8_blind_except/snapshots/ruff_linter__rules__flake8_blind_except__tests__BLE001_BLE.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_blind_except/mod.rs +snapshot_kind: text --- BLE.py:25:8: BLE001 Do not catch blind exception: `BaseException` | @@ -120,5 +121,3 @@ BLE.py:113:8: BLE001 Do not catch blind exception: `Exception` | ^^^^^^^^^ BLE001 114 | error("...", exc_info=None) | - - diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/helpers.rs b/crates/ruff_linter/src/rules/flake8_boolean_trap/helpers.rs index a931241001563..f11b2b12fa89a 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/helpers.rs @@ -66,9 +66,88 @@ pub(super) fn is_user_allowed_func_call( }) } +/// Returns `true` if a function defines a binary operator. +/// +/// This only includes operators, i.e., functions that are usually not called directly. +/// +/// See: <https://docs.python.org/3/library/operator.html> +pub(super) fn is_operator_method(name: &str) -> bool { + matches!( + name, + "__contains__" // in + // item access ([]) + | "__getitem__" // [] + | "__setitem__" // []= + | "__delitem__" // del [] + // addition (+) + | "__add__" // + + | "__radd__" // + + | "__iadd__" // += + // subtraction (-) + | "__sub__" // - + | "__rsub__" // - + | "__isub__" // -= + // multiplication (*) + | "__mul__" // * + | "__rmul__" // * + | "__imul__" // *= + // division (/) + | "__truediv__" // / + | "__rtruediv__" // / + | "__itruediv__" // /= + // floor division (//) + | "__floordiv__" // // + | "__rfloordiv__" // // + | "__ifloordiv__" // //= + // remainder (%) + | "__mod__" // % + | "__rmod__" // % + | "__imod__" // %= + // exponentiation (**) + | "__pow__" // ** + | "__rpow__" // ** + | "__ipow__" // **= + // left shift (<<) + | "__lshift__" // << + | "__rlshift__" // << + | "__ilshift__" // <<= + // right shift (>>) + | "__rshift__" // >> + | "__rrshift__" // >> + | "__irshift__" // >>= + // matrix multiplication (@) + | "__matmul__" // @ + | "__rmatmul__" // @ + | "__imatmul__" // @= + // meet (&) + | "__and__" // & + | "__rand__" // & + | "__iand__" // &= + // join (|) + | "__or__" // | + | "__ror__" // | + | "__ior__" // |= + // xor (^) + | "__xor__" // ^ + | "__rxor__" // ^ + | "__ixor__" // ^= + // comparison (>, <, >=, <=, ==, !=) + | "__gt__" // > + | "__lt__" // < + | "__ge__" // >= + | "__le__" // <= + | "__eq__" // == + | "__ne__" // != + // unary operators (included for completeness) + | "__pos__" // + + | "__neg__" // - + | "__invert__" // ~ + ) +} + /// Returns `true` if a function definition is allowed to use a boolean trap. pub(super) fn is_allowed_func_def(name: &str) -> bool { - matches!(name, "__setitem__" | "__post_init__") + matches!(name, "__post_init__") || is_operator_method(name) } /// Returns `true` if an argument is allowed to use a boolean trap. To return diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs b/crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs index 80c81bb3f4654..8268ca726b27d 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs @@ -11,8 +11,8 @@ mod tests { use test_case::test_case; use crate::registry::Rule; - use crate::settings::types::PreviewMode; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_default_value_positional_argument.rs b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_default_value_positional_argument.rs index 9761b250b441f..5a27f40e57617 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_default_value_positional_argument.rs +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_default_value_positional_argument.rs @@ -1,9 +1,9 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::identifier::Identifier; use ruff_python_ast::name::UnqualifiedName; -use ruff_python_ast::{Decorator, ParameterWithDefault, Parameters}; +use ruff_python_ast::{Decorator, Expr, Parameters}; use ruff_python_semantic::analyze::visibility; -use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::rules::flake8_boolean_trap::helpers::is_allowed_func_def; @@ -89,38 +89,34 @@ use crate::rules::flake8_boolean_trap::helpers::is_allowed_func_def; /// ## References /// - [Python documentation: Calls](https://docs.python.org/3/reference/expressions.html#calls) /// - [_How to Avoid “The Boolean Trap”_ by Adam Johnson](https://adamj.eu/tech/2021/07/10/python-type-hints-how-to-avoid-the-boolean-trap/) -#[violation] -pub struct BooleanDefaultValuePositionalArgument; +#[derive(ViolationMetadata)] +pub(crate) struct BooleanDefaultValuePositionalArgument; impl Violation for BooleanDefaultValuePositionalArgument { #[derive_message_formats] fn message(&self) -> String { - format!("Boolean default positional argument in function definition") + "Boolean default positional argument in function definition".to_string() } } /// FBT002 pub(crate) fn boolean_default_value_positional_argument( - checker: &mut Checker, + checker: &Checker, name: &str, decorator_list: &[Decorator], parameters: &Parameters, ) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } // Allow Boolean defaults in explicitly-allowed functions. if is_allowed_func_def(name) { return; } - for ParameterWithDefault { - parameter, - default, - range: _, - } in parameters.posonlyargs.iter().chain(¶meters.args) - { - if default - .as_ref() - .is_some_and(|default| default.is_boolean_literal_expr()) - { + for param in parameters.posonlyargs.iter().chain(¶meters.args) { + if param.default().is_some_and(Expr::is_boolean_literal_expr) { // Allow Boolean defaults in setters. if decorator_list.iter().any(|decorator| { UnqualifiedName::from_expr(&decorator.expression) @@ -135,9 +131,9 @@ pub(crate) fn boolean_default_value_positional_argument( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BooleanDefaultValuePositionalArgument, - parameter.name.range(), + param.identifier(), )); } } diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_positional_value_in_call.rs b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_positional_value_in_call.rs index 45aade82696a4..82dfca34bc6df 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_positional_value_in_call.rs +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_positional_value_in_call.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; @@ -41,17 +41,17 @@ use crate::rules::flake8_boolean_trap::helpers::allow_boolean_trap; /// ## References /// - [Python documentation: Calls](https://docs.python.org/3/reference/expressions.html#calls) /// - [_How to Avoid “The Boolean Trap”_ by Adam Johnson](https://adamj.eu/tech/2021/07/10/python-type-hints-how-to-avoid-the-boolean-trap/) -#[violation] -pub struct BooleanPositionalValueInCall; +#[derive(ViolationMetadata)] +pub(crate) struct BooleanPositionalValueInCall; impl Violation for BooleanPositionalValueInCall { #[derive_message_formats] fn message(&self) -> String { - format!("Boolean positional value in function call") + "Boolean positional value in function call".to_string() } } -pub(crate) fn boolean_positional_value_in_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn boolean_positional_value_in_call(checker: &Checker, call: &ast::ExprCall) { if allow_boolean_trap(call, checker) { return; } @@ -61,8 +61,6 @@ pub(crate) fn boolean_positional_value_in_call(checker: &mut Checker, call: &ast .iter() .filter(|arg| arg.is_boolean_literal_expr()) { - checker - .diagnostics - .push(Diagnostic::new(BooleanPositionalValueInCall, arg.range())); + checker.report_diagnostic(Diagnostic::new(BooleanPositionalValueInCall, arg.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_type_hint_positional_argument.rs b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_type_hint_positional_argument.rs index 7b39217ad7935..4be057891346a 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_type_hint_positional_argument.rs +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/rules/boolean_type_hint_positional_argument.rs @@ -1,13 +1,14 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::identifier::Identifier; use ruff_python_ast::name::UnqualifiedName; -use ruff_python_ast::{self as ast, Decorator, Expr, ParameterWithDefault, Parameters}; -use ruff_python_semantic::analyze::visibility; +use ruff_python_ast::{self as ast, Decorator, Expr, Parameters}; use ruff_python_semantic::SemanticModel; -use ruff_text_size::Ranged; +use ruff_python_semantic::analyze::visibility; use crate::checkers::ast::Checker; +use crate::preview::is_bool_subtype_of_annotation_enabled; use crate::rules::flake8_boolean_trap::helpers::is_allowed_func_def; /// ## What it does @@ -27,6 +28,9 @@ use crate::rules::flake8_boolean_trap::helpers::is_allowed_func_def; /// keyword-only argument, to force callers to be explicit when providing /// the argument. /// +/// Dunder methods that define operators are exempt from this rule, as are +/// setters and `@override` definitions. +/// /// In [preview], this rule will also flag annotations that include boolean /// variants, like `bool | int`. /// @@ -95,38 +99,37 @@ use crate::rules::flake8_boolean_trap::helpers::is_allowed_func_def; /// - [_How to Avoid “The Boolean Trap”_ by Adam Johnson](https://adamj.eu/tech/2021/07/10/python-type-hints-how-to-avoid-the-boolean-trap/) /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct BooleanTypeHintPositionalArgument; +#[derive(ViolationMetadata)] +pub(crate) struct BooleanTypeHintPositionalArgument; impl Violation for BooleanTypeHintPositionalArgument { #[derive_message_formats] fn message(&self) -> String { - format!("Boolean-typed positional argument in function definition") + "Boolean-typed positional argument in function definition".to_string() } } /// FBT001 pub(crate) fn boolean_type_hint_positional_argument( - checker: &mut Checker, + checker: &Checker, name: &str, decorator_list: &[Decorator], parameters: &Parameters, ) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } // Allow Boolean type hints in explicitly-allowed functions. if is_allowed_func_def(name) { return; } - for ParameterWithDefault { - parameter, - default: _, - range: _, - } in parameters.posonlyargs.iter().chain(¶meters.args) - { - let Some(annotation) = parameter.annotation.as_ref() else { + for parameter in parameters.posonlyargs.iter().chain(¶meters.args) { + let Some(annotation) = parameter.annotation() else { continue; }; - if checker.settings.preview.is_enabled() { + if is_bool_subtype_of_annotation_enabled(checker.settings) { if !match_annotation_to_complex_bool(annotation, checker.semantic()) { continue; } @@ -155,9 +158,9 @@ pub(crate) fn boolean_type_hint_positional_argument( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BooleanTypeHintPositionalArgument, - parameter.name.range(), + parameter.identifier(), )); } } diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT001_FBT.py.snap b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT001_FBT.py.snap index c14a748e79d6c..ea925637b517e 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT001_FBT.py.snap +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT001_FBT.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +snapshot_kind: text --- FBT.py:4:5: FBT001 Boolean-typed positional argument in function definition | diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT002_FBT.py.snap b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT002_FBT.py.snap index 14c5a21a117ad..1d8ce760c0546 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT002_FBT.py.snap +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT002_FBT.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +snapshot_kind: text --- FBT.py:12:5: FBT002 Boolean default positional argument in function definition | @@ -40,5 +41,3 @@ FBT.py:15:5: FBT002 Boolean default positional argument in function definition 16 | posorkw_nonboolvalued_nohint=1, 17 | posorkw_nonboolvalued_nonboolhint: int = 2, | - - diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT003_FBT.py.snap b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT003_FBT.py.snap index 4985aa37f2c1d..5dc9e2b9db03a 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT003_FBT.py.snap +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__FBT003_FBT.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +snapshot_kind: text --- FBT.py:41:11: FBT003 Boolean positional value in function call | diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__extend_allowed_callable.snap b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__extend_allowed_callable.snap index 71b3e8df8d31d..058c871bf133e 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__extend_allowed_callable.snap +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__extend_allowed_callable.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +snapshot_kind: text --- FBT.py:41:11: FBT003 Boolean positional value in function call | diff --git a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__preview__FBT001_FBT.py.snap b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__preview__FBT001_FBT.py.snap index ee91fa49f8658..d3ab33ec5c3df 100644 --- a/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__preview__FBT001_FBT.py.snap +++ b/crates/ruff_linter/src/rules/flake8_boolean_trap/snapshots/ruff_linter__rules__flake8_boolean_trap__tests__preview__FBT001_FBT.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_boolean_trap/mod.rs +snapshot_kind: text --- FBT.py:4:5: FBT001 Boolean-typed positional argument in function definition | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/mod.rs b/crates/ruff_linter/src/rules/flake8_bugbear/mod.rs index 1f122f15438b3..e787886c51a54 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/mod.rs @@ -16,11 +16,14 @@ mod tests { use crate::settings::LinterSettings; use crate::test::test_path; + use ruff_python_ast::PythonVersion; + #[test_case(Rule::AbstractBaseClassWithoutAbstractMethod, Path::new("B024.py"))] #[test_case(Rule::AssertFalse, Path::new("B011.py"))] #[test_case(Rule::AssertRaisesException, Path::new("B017.py"))] #[test_case(Rule::AssignmentToOsEnviron, Path::new("B003.py"))] #[test_case(Rule::CachedInstanceMethod, Path::new("B019.py"))] + #[test_case(Rule::ClassAsDataStructure, Path::new("class_as_data_structure.py"))] #[test_case(Rule::DuplicateHandlerException, Path::new("B014.py"))] #[test_case(Rule::DuplicateTryBlockException, Path::new("B025.py"))] #[test_case(Rule::DuplicateValue, Path::new("B033.py"))] @@ -43,6 +46,7 @@ mod tests { #[test_case(Rule::MutableArgumentDefault, Path::new("B006_7.py"))] #[test_case(Rule::MutableArgumentDefault, Path::new("B006_8.py"))] #[test_case(Rule::MutableArgumentDefault, Path::new("B006_B008.py"))] + #[test_case(Rule::MutableArgumentDefault, Path::new("B006_1.pyi"))] #[test_case(Rule::NoExplicitStacklevel, Path::new("B028.py"))] #[test_case(Rule::RaiseLiteral, Path::new("B016.py"))] #[test_case(Rule::RaiseWithoutFromInsideExcept, Path::new("B904.py"))] @@ -65,6 +69,7 @@ mod tests { #[test_case(Rule::ReturnInGenerator, Path::new("B901.py"))] #[test_case(Rule::LoopIteratorMutation, Path::new("B909.py"))] #[test_case(Rule::MutableContextvarDefault, Path::new("B039.py"))] + #[test_case(Rule::BatchedWithoutExplicitStrict, Path::new("B911.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -75,6 +80,34 @@ mod tests { Ok(()) } + #[test_case( + Rule::ClassAsDataStructure, + Path::new("class_as_data_structure.py"), + PythonVersion::PY39 + )] + fn rules_with_target_version( + rule_code: Rule, + path: &Path, + target_version: PythonVersion, + ) -> Result<()> { + let snapshot = format!( + "{}_py{}{}_{}", + rule_code.noqa_code(), + target_version.major, + target_version.minor, + path.to_string_lossy(), + ); + let diagnostics = test_path( + Path::new("flake8_bugbear").join(path).as_path(), + &LinterSettings { + unresolved_target_version: target_version.into(), + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test] fn zip_without_explicit_strict() -> Result<()> { let snapshot = "B905.py"; diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/abstract_base_class.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/abstract_base_class.rs index 410c210b174a5..e019e6a6909b7 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/abstract_base_class.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/abstract_base_class.rs @@ -1,22 +1,24 @@ use ruff_python_ast::{self as ast, Arguments, Expr, Keyword, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; -use ruff_python_semantic::analyze::visibility::{is_abstract, is_overload}; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::visibility::{is_abstract, is_overload}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::registry::Rule; /// ## What it does -/// Checks for abstract classes without abstract methods. +/// Checks for abstract classes without abstract methods or properties. +/// Annotated but unassigned class variables are regarded as abstract. /// /// ## Why is this bad? /// Abstract base classes are used to define interfaces. If an abstract base -/// class has no abstract methods, you may have forgotten to add an abstract -/// method to the class or omitted an `@abstractmethod` decorator. +/// class has no abstract methods or properties, you may have forgotten +/// to add an abstract method or property to the class, +/// or omitted an `@abstractmethod` decorator. /// /// If the class is _not_ meant to be used as an interface, consider removing /// the `ABC` base class from the class definition. @@ -24,9 +26,12 @@ use crate::registry::Rule; /// ## Example /// ```python /// from abc import ABC +/// from typing import ClassVar /// /// /// class Foo(ABC): +/// class_var: ClassVar[str] = "assigned" +/// /// def method(self): /// bar() /// ``` @@ -34,9 +39,12 @@ use crate::registry::Rule; /// Use instead: /// ```python /// from abc import ABC, abstractmethod +/// from typing import ClassVar /// /// /// class Foo(ABC): +/// class_var: ClassVar[str] # unassigned +/// /// @abstractmethod /// def method(self): /// bar() @@ -44,8 +52,9 @@ use crate::registry::Rule; /// /// ## References /// - [Python documentation: `abc`](https://docs.python.org/3/library/abc.html) -#[violation] -pub struct AbstractBaseClassWithoutAbstractMethod { +/// - [Python documentation: `typing.ClassVar`](https://docs.python.org/3/library/typing.html#typing.ClassVar) +#[derive(ViolationMetadata)] +pub(crate) struct AbstractBaseClassWithoutAbstractMethod { name: String, } @@ -53,7 +62,7 @@ impl Violation for AbstractBaseClassWithoutAbstractMethod { #[derive_message_formats] fn message(&self) -> String { let AbstractBaseClassWithoutAbstractMethod { name } = self; - format!("`{name}` is an abstract base class, but it has no abstract methods") + format!("`{name}` is an abstract base class, but it has no abstract methods or properties") } } @@ -88,9 +97,9 @@ impl Violation for AbstractBaseClassWithoutAbstractMethod { /// ``` /// /// ## References -/// - [Python documentation: abc](https://docs.python.org/3/library/abc.html) -#[violation] -pub struct EmptyMethodWithoutAbstractDecorator { +/// - [Python documentation: `abc`](https://docs.python.org/3/library/abc.html) +#[derive(ViolationMetadata)] +pub(crate) struct EmptyMethodWithoutAbstractDecorator { name: String, } @@ -135,7 +144,7 @@ fn is_empty_body(body: &[Stmt]) -> bool { /// B024 /// B027 pub(crate) fn abstract_base_class( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, name: &str, arguments: Option<&Arguments>, @@ -187,7 +196,7 @@ pub(crate) fn abstract_base_class( && is_empty_body(body) && !is_overload(decorator_list, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( EmptyMethodWithoutAbstractDecorator { name: format!("{name}.{method_name}"), }, @@ -197,7 +206,7 @@ pub(crate) fn abstract_base_class( } if checker.enabled(Rule::AbstractBaseClassWithoutAbstractMethod) { if !has_abstract_method { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AbstractBaseClassWithoutAbstractMethod { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_false.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_false.rs index e1d90e54be634..5be6814771278 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_false.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_false.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, Stmt}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_false; use crate::checkers::ast::Checker; @@ -34,13 +34,14 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `assert`](https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement) -#[violation] -pub struct AssertFalse; +#[derive(ViolationMetadata)] +pub(crate) struct AssertFalse; impl AlwaysFixableViolation for AssertFalse { #[derive_message_formats] fn message(&self) -> String { - format!("Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`") + "Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`" + .to_string() } fn fix_title(&self) -> String { @@ -73,7 +74,7 @@ fn assertion_error(msg: Option<&Expr>) -> Stmt { } /// B011 -pub(crate) fn assert_false(checker: &mut Checker, stmt: &Stmt, test: &Expr, msg: Option<&Expr>) { +pub(crate) fn assert_false(checker: &Checker, stmt: &Stmt, test: &Expr, msg: Option<&Expr>) { if !is_const_false(test) { return; } @@ -83,5 +84,5 @@ pub(crate) fn assert_false(checker: &mut Checker, stmt: &Stmt, test: &Expr, msg: checker.generator().stmt(&assertion_error(msg)), stmt.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_raises_exception.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_raises_exception.rs index a3da3f9dc69ad..e233a7c0db0f0 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_raises_exception.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assert_raises_exception.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, WithItem}; use ruff_text_size::Ranged; @@ -28,35 +28,16 @@ use crate::checkers::ast::Checker; /// ```python /// self.assertRaises(SomeSpecificException, foo) /// ``` -#[violation] -pub struct AssertRaisesException { - assertion: AssertionKind, +#[derive(ViolationMetadata)] +pub(crate) struct AssertRaisesException { exception: ExceptionKind, } impl Violation for AssertRaisesException { #[derive_message_formats] fn message(&self) -> String { - let AssertRaisesException { - assertion, - exception, - } = self; - format!("`{assertion}({exception})` should be considered evil") - } -} - -#[derive(Debug, PartialEq, Eq)] -enum AssertionKind { - AssertRaises, - PytestRaises, -} - -impl fmt::Display for AssertionKind { - fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { - match self { - AssertionKind::AssertRaises => fmt.write_str("assertRaises"), - AssertionKind::PytestRaises => fmt.write_str("pytest.raises"), - } + let AssertRaisesException { exception } = self; + format!("Do not assert blind exception: `{exception}`") } } @@ -76,7 +57,7 @@ impl fmt::Display for ExceptionKind { } /// B017 -pub(crate) fn assert_raises_exception(checker: &mut Checker, items: &[WithItem]) { +pub(crate) fn assert_raises_exception(checker: &Checker, items: &[WithItem]) { for item in items { let Expr::Call(ast::ExprCall { func, @@ -107,24 +88,19 @@ pub(crate) fn assert_raises_exception(checker: &mut Checker, items: &[WithItem]) _ => continue, }; - let assertion = if matches!(func.as_ref(), Expr::Attribute(ast::ExprAttribute { attr, .. }) if attr == "assertRaises") + if !(matches!(func.as_ref(), Expr::Attribute(ast::ExprAttribute { attr, .. }) if attr == "assertRaises") + || semantic + .resolve_qualified_name(func) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["pytest", "raises"]) + }) + && arguments.find_keyword("match").is_none()) { - AssertionKind::AssertRaises - } else if semantic - .resolve_qualified_name(func) - .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["pytest", "raises"])) - && arguments.find_keyword("match").is_none() - { - AssertionKind::PytestRaises - } else { continue; - }; + } - checker.diagnostics.push(Diagnostic::new( - AssertRaisesException { - assertion, - exception, - }, + checker.report_diagnostic(Diagnostic::new( + AssertRaisesException { exception }, item.range(), )); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assignment_to_os_environ.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assignment_to_os_environ.rs index 9f0fef6c38be3..722f676137044 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/assignment_to_os_environ.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/assignment_to_os_environ.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -39,18 +39,18 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `os.environ`](https://docs.python.org/3/library/os.html#os.environ) /// - [Python documentation: `subprocess.Popen`](https://docs.python.org/3/library/subprocess.html#subprocess.Popen) -#[violation] -pub struct AssignmentToOsEnviron; +#[derive(ViolationMetadata)] +pub(crate) struct AssignmentToOsEnviron; impl Violation for AssignmentToOsEnviron { #[derive_message_formats] fn message(&self) -> String { - format!("Assigning to `os.environ` doesn't clear the environment") + "Assigning to `os.environ` doesn't clear the environment".to_string() } } /// B003 -pub(crate) fn assignment_to_os_environ(checker: &mut Checker, targets: &[Expr]) { +pub(crate) fn assignment_to_os_environ(checker: &Checker, targets: &[Expr]) { let [target] = targets else { return; }; @@ -66,7 +66,5 @@ pub(crate) fn assignment_to_os_environ(checker: &mut Checker, targets: &[Expr]) if id != "os" { return; } - checker - .diagnostics - .push(Diagnostic::new(AssignmentToOsEnviron, target.range())); + checker.report_diagnostic(Diagnostic::new(AssignmentToOsEnviron, target.range())); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/batched_without_explicit_strict.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/batched_without_explicit_strict.rs new file mode 100644 index 0000000000000..fafc2fa96613f --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/batched_without_explicit_strict.rs @@ -0,0 +1,91 @@ +use crate::checkers::ast::Checker; +use crate::rules::flake8_bugbear::rules::is_infinite_iterable; +use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::ExprCall; +use ruff_python_ast::PythonVersion; + +/// ## What it does +/// Checks for `itertools.batched` calls without an explicit `strict` parameter. +/// +/// ## Why is this bad? +/// By default, if the length of the iterable is not divisible by +/// the second argument to `itertools.batched`, the last batch +/// will be shorter than the rest. +/// +/// In Python 3.13, a `strict` parameter was added which allows controlling if the batches must be of uniform length. +/// Pass `strict=True` to raise a `ValueError` if the batches are of non-uniform length. +/// Otherwise, pass `strict=False` to make the intention explicit. +/// +/// ## Example +/// ```python +/// itertools.batched(iterable, n) +/// ``` +/// +/// Use instead if the batches must be of uniform length: +/// ```python +/// itertools.batched(iterable, n, strict=True) +/// ``` +/// +/// Or if the batches can be of non-uniform length: +/// ```python +/// itertools.batched(iterable, n, strict=False) +/// ``` +/// +/// ## Known deviations +/// Unlike the upstream `B911`, this rule will not report infinite iterators +/// (e.g., `itertools.cycle(...)`). +/// +/// ## Options +/// - `target-version` +/// +/// ## References +/// - [Python documentation: `batched`](https://docs.python.org/3/library/itertools.html#batched) +#[derive(ViolationMetadata)] +pub(crate) struct BatchedWithoutExplicitStrict; + +impl Violation for BatchedWithoutExplicitStrict { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; + + #[derive_message_formats] + fn message(&self) -> String { + "`itertools.batched()` without an explicit `strict` parameter".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Add an explicit `strict` parameter".to_string()) + } +} + +/// B911 +pub(crate) fn batched_without_explicit_strict(checker: &Checker, call: &ExprCall) { + if checker.target_version() < PythonVersion::PY313 { + return; + } + + let semantic = checker.semantic(); + let (func, arguments) = (&call.func, &call.arguments); + + let Some(qualified_name) = semantic.resolve_qualified_name(func) else { + return; + }; + + if !matches!(qualified_name.segments(), ["itertools", "batched"]) { + return; + } + + if arguments.find_keyword("strict").is_some() { + return; + } + + let Some(iterable) = arguments.find_positional(0) else { + return; + }; + + if is_infinite_iterable(iterable, semantic) { + return; + } + + let diagnostic = Diagnostic::new(BatchedWithoutExplicitStrict, call.range); + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/cached_instance_method.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/cached_instance_method.rs index 0ebdec98d4a37..30175823c6807 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/cached_instance_method.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/cached_instance_method.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_callable; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::analyze::{class, function_type}; @@ -62,20 +62,19 @@ use crate::checkers::ast::Checker; /// - [Python documentation: `functools.lru_cache`](https://docs.python.org/3/library/functools.html#functools.lru_cache) /// - [Python documentation: `functools.cache`](https://docs.python.org/3/library/functools.html#functools.cache) /// - [don't lru_cache methods!](https://www.youtube.com/watch?v=sVjtp6tGo0g) -#[violation] -pub struct CachedInstanceMethod; +#[derive(ViolationMetadata)] +pub(crate) struct CachedInstanceMethod; impl Violation for CachedInstanceMethod { #[derive_message_formats] fn message(&self) -> String { - format!( - "Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks" - ) + "Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks" + .to_string() } } /// B019 -pub(crate) fn cached_instance_method(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn cached_instance_method(checker: &Checker, function_def: &ast::StmtFunctionDef) { let scope = checker.semantic().current_scope(); // Parent scope _must_ be a class. @@ -103,9 +102,7 @@ pub(crate) fn cached_instance_method(checker: &mut Checker, function_def: &ast:: return; } - checker - .diagnostics - .push(Diagnostic::new(CachedInstanceMethod, decorator.range())); + checker.report_diagnostic(Diagnostic::new(CachedInstanceMethod, decorator.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/class_as_data_structure.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/class_as_data_structure.rs new file mode 100644 index 0000000000000..39ab5a9ae2438 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/class_as_data_structure.rs @@ -0,0 +1,127 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast}; +use ruff_python_semantic::analyze::visibility::{self, Visibility::Public}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use ruff_python_ast::PythonVersion; + +/// ## What it does +/// Checks for classes that only have a public `__init__` method, +/// without base classes and decorators. +/// +/// ## Why is this bad? +/// Classes with just an `__init__` are possibly better off +/// being a dataclass or a namedtuple, which have less boilerplate. +/// +/// ## Example +/// ```python +/// class Point: +/// def __init__(self, x: float, y: float): +/// self.x = x +/// self.y = y +/// ``` +/// +/// Use instead: +/// ```python +/// from dataclasses import dataclass +/// +/// +/// @dataclass +/// class Point: +/// x: float +/// y: float +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct ClassAsDataStructure; + +impl Violation for ClassAsDataStructure { + #[derive_message_formats] + fn message(&self) -> String { + "Class could be dataclass or namedtuple".to_string() + } +} + +/// B903 +pub(crate) fn class_as_data_structure(checker: &Checker, class_def: &ast::StmtClassDef) { + // skip stub files + if checker.source_type.is_stub() { + return; + } + + // allow decorated classes + if !class_def.decorator_list.is_empty() { + return; + } + + // allow classes with base classes + if class_def.arguments.is_some() { + return; + } + + let mut public_methods = 0; + let mut has_dunder_init = false; + + for stmt in &class_def.body { + if public_methods > 1 && has_dunder_init { + // we're good to break here + break; + } + match stmt { + ast::Stmt::FunctionDef(func_def) => { + if !has_dunder_init + && func_def.name.to_string() == "__init__" + && func_def + .parameters + .iter() + // skip `self` + .skip(1) + .all(|param| param.annotation().is_some() && !param.is_variadic()) + && (func_def.parameters.kwonlyargs.is_empty() || checker.target_version() >= PythonVersion::PY310) + // `__init__` should not have complicated logic in it + // only assignments + && func_def + .body + .iter() + .all(is_simple_assignment_to_attribute) + { + has_dunder_init = true; + } + if matches!(visibility::method_visibility(func_def), Public) { + public_methods += 1; + } + } + // Ignore class variables + ast::Stmt::Assign(_) | ast::Stmt::AnnAssign(_) | + // and expressions (e.g. string literals) + ast::Stmt::Expr(_) => {} + _ => { + // Bail for anything else - e.g. nested classes + // or conditional methods. + return; + } + } + } + + if has_dunder_init && public_methods == 1 { + checker.report_diagnostic(Diagnostic::new(ClassAsDataStructure, class_def.range())); + } +} + +// Checks whether a statement is a, possibly augmented, +// assignment of a name to an attribute. +fn is_simple_assignment_to_attribute(stmt: &ast::Stmt) -> bool { + match stmt { + ast::Stmt::Assign(ast::StmtAssign { targets, value, .. }) => { + let [target] = targets.as_slice() else { + return false; + }; + target.is_attribute_expr() && value.is_name_expr() + } + ast::Stmt::AnnAssign(ast::StmtAnnAssign { target, value, .. }) => { + target.is_attribute_expr() && value.as_ref().is_some_and(|val| val.is_name_expr()) + } + _ => false, + } +} diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_exceptions.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_exceptions.rs index 450253b18defc..51d14bd11453a 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_exceptions.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_exceptions.rs @@ -3,7 +3,7 @@ use rustc_hash::{FxHashMap, FxHashSet}; use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::{self as ast, ExceptHandler, Expr, ExprContext}; use ruff_text_size::{Ranged, TextRange}; @@ -39,16 +39,21 @@ use crate::registry::Rule; /// /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) -#[violation] -pub struct DuplicateTryBlockException { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateTryBlockException { name: String, + is_star: bool, } impl Violation for DuplicateTryBlockException { #[derive_message_formats] fn message(&self) -> String { - let DuplicateTryBlockException { name } = self; - format!("try-except block with duplicate exception `{name}`") + let DuplicateTryBlockException { name, is_star } = self; + if *is_star { + format!("try-except* block with duplicate exception `{name}`") + } else { + format!("try-except block with duplicate exception `{name}`") + } } } @@ -81,8 +86,8 @@ impl Violation for DuplicateTryBlockException { /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) /// - [Python documentation: Exception hierarchy](https://docs.python.org/3/library/exceptions.html#exception-hierarchy) -#[violation] -pub struct DuplicateHandlerException { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateHandlerException { pub names: Vec<String>, } @@ -115,7 +120,7 @@ fn type_pattern(elts: Vec<&Expr>) -> Expr { /// B014 fn duplicate_handler_exceptions<'a>( - checker: &mut Checker, + checker: &Checker, expr: &'a Expr, elts: &'a [Expr], ) -> FxHashMap<UnqualifiedName<'a>, &'a Expr> { @@ -162,7 +167,7 @@ fn duplicate_handler_exceptions<'a>( }, expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -170,7 +175,7 @@ fn duplicate_handler_exceptions<'a>( } /// B025 -pub(crate) fn duplicate_exceptions(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn duplicate_exceptions(checker: &Checker, handlers: &[ExceptHandler]) { let mut seen: FxHashSet<UnqualifiedName> = FxHashSet::default(); let mut duplicates: FxHashMap<UnqualifiedName, Vec<&Expr>> = FxHashMap::default(); for handler in handlers { @@ -207,9 +212,15 @@ pub(crate) fn duplicate_exceptions(checker: &mut Checker, handlers: &[ExceptHand if checker.enabled(Rule::DuplicateTryBlockException) { for (name, exprs) in duplicates { for expr in exprs { - checker.diagnostics.push(Diagnostic::new( + let is_star = checker + .semantic() + .current_statement() + .as_try_stmt() + .is_some_and(|try_stmt| try_stmt.is_star); + checker.report_diagnostic(Diagnostic::new( DuplicateTryBlockException { name: name.segments().join("."), + is_star, }, expr.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_value.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_value.rs index 3021c7053fdaf..7a59df6266bc8 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_value.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/duplicate_value.rs @@ -1,10 +1,11 @@ use anyhow::{Context, Result}; -use rustc_hash::FxHashSet; +use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_ast::comparable::ComparableExpr; +use ruff_python_ast::Expr; +use ruff_python_ast::comparable::HashableExpr; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::Ranged; @@ -27,9 +28,10 @@ use crate::checkers::ast::Checker; /// ```python /// {1, 2, 3} /// ``` -#[violation] -pub struct DuplicateValue { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateValue { value: String, + existing: String, } impl Violation for DuplicateValue { @@ -37,26 +39,31 @@ impl Violation for DuplicateValue { #[derive_message_formats] fn message(&self) -> String { - let DuplicateValue { value } = self; - format!("Sets should not contain duplicate item `{value}`") + let DuplicateValue { value, existing } = self; + if value == existing { + format!("Sets should not contain duplicate item `{value}`") + } else { + format!( + "Sets should not contain duplicate items, but `{existing}` and `{value}` has the same value" + ) + } } fn fix_title(&self) -> Option<String> { - Some(format!("Remove duplicate item")) + Some("Remove duplicate item".to_string()) } } /// B033 -pub(crate) fn duplicate_value(checker: &mut Checker, set: &ast::ExprSet) { - let mut seen_values: FxHashSet<ComparableExpr> = FxHashSet::default(); +pub(crate) fn duplicate_value(checker: &Checker, set: &ast::ExprSet) { + let mut seen_values: FxHashMap<HashableExpr, &Expr> = FxHashMap::default(); for (index, value) in set.iter().enumerate() { if value.is_literal_expr() { - let comparable_value = ComparableExpr::from(value); - - if !seen_values.insert(comparable_value) { + if let Some(existing) = seen_values.insert(HashableExpr::from(value), value) { let mut diagnostic = Diagnostic::new( DuplicateValue { value: checker.generator().expr(value), + existing: checker.generator().expr(existing), }, value.range(), ); @@ -65,9 +72,9 @@ pub(crate) fn duplicate_value(checker: &mut Checker, set: &ast::ExprSet) { remove_member(set, index, checker.locator().contents()).map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } - }; + } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_empty_tuple.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_empty_tuple.rs index f89f84862e4c6..cc512fee938c5 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_empty_tuple.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_empty_tuple.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast}; use ruff_python_ast::{ExceptHandler, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -33,18 +33,24 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) -#[violation] -pub struct ExceptWithEmptyTuple; +#[derive(ViolationMetadata)] +pub(crate) struct ExceptWithEmptyTuple { + is_star: bool, +} impl Violation for ExceptWithEmptyTuple { #[derive_message_formats] fn message(&self) -> String { - format!("Using `except ():` with an empty tuple does not catch anything; add exceptions to handle") + if self.is_star { + "Using `except* ():` with an empty tuple does not catch anything; add exceptions to handle".to_string() + } else { + "Using `except ():` with an empty tuple does not catch anything; add exceptions to handle".to_string() + } } } /// B029 -pub(crate) fn except_with_empty_tuple(checker: &mut Checker, except_handler: &ExceptHandler) { +pub(crate) fn except_with_empty_tuple(checker: &Checker, except_handler: &ExceptHandler) { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, .. }) = except_handler; let Some(type_) = type_ else { @@ -53,9 +59,15 @@ pub(crate) fn except_with_empty_tuple(checker: &mut Checker, except_handler: &Ex let Expr::Tuple(ast::ExprTuple { elts, .. }) = type_.as_ref() else { return; }; + if elts.is_empty() { - checker.diagnostics.push(Diagnostic::new( - ExceptWithEmptyTuple, + let is_star = checker + .semantic() + .current_statement() + .as_try_stmt() + .is_some_and(|try_stmt| try_stmt.is_star); + checker.report_diagnostic(Diagnostic::new( + ExceptWithEmptyTuple { is_star }, except_handler.range(), )); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_non_exception_classes.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_non_exception_classes.rs index 43e0348e5dcc8..25e4da777f5ee 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_non_exception_classes.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/except_with_non_exception_classes.rs @@ -3,7 +3,7 @@ use std::collections::VecDeque; use ruff_python_ast::{self as ast, ExceptHandler, Expr, Operator}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -34,21 +34,26 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) /// - [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions) -#[violation] -pub struct ExceptWithNonExceptionClasses; +#[derive(ViolationMetadata)] +pub(crate) struct ExceptWithNonExceptionClasses { + is_star: bool, +} impl Violation for ExceptWithNonExceptionClasses { #[derive_message_formats] fn message(&self) -> String { - format!("`except` handlers should only be exception classes or tuples of exception classes") + if self.is_star { + "`except*` handlers should only be exception classes or tuples of exception classes" + .to_string() + } else { + "`except` handlers should only be exception classes or tuples of exception classes" + .to_string() + } } } /// B030 -pub(crate) fn except_with_non_exception_classes( - checker: &mut Checker, - except_handler: &ExceptHandler, -) { +pub(crate) fn except_with_non_exception_classes(checker: &Checker, except_handler: &ExceptHandler) { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, .. }) = except_handler; let Some(type_) = type_ else { @@ -59,9 +64,15 @@ pub(crate) fn except_with_non_exception_classes( expr, Expr::Subscript(_) | Expr::Attribute(_) | Expr::Name(_) | Expr::Call(_), ) { - checker - .diagnostics - .push(Diagnostic::new(ExceptWithNonExceptionClasses, expr.range())); + let is_star = checker + .semantic() + .current_statement() + .as_try_stmt() + .is_some_and(|try_stmt| try_stmt.is_star); + checker.report_diagnostic(Diagnostic::new( + ExceptWithNonExceptionClasses { is_star }, + expr.range(), + )); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/f_string_docstring.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/f_string_docstring.rs index 7441f8a9ebdff..d5def15e96c1c 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/f_string_docstring.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/f_string_docstring.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use crate::checkers::ast::Checker; @@ -28,22 +28,20 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [PEP 257](https://peps.python.org/pep-0257/) +/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [Python documentation: Formatted string literals](https://docs.python.org/3/reference/lexical_analysis.html#f-strings) -#[violation] -pub struct FStringDocstring; +#[derive(ViolationMetadata)] +pub(crate) struct FStringDocstring; impl Violation for FStringDocstring { #[derive_message_formats] fn message(&self) -> String { - format!( - "f-string used as docstring. Python will interpret this as a joined string, rather than a docstring." - ) + "f-string used as docstring. Python will interpret this as a joined string, rather than a docstring.".to_string() } } /// B021 -pub(crate) fn f_string_docstring(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn f_string_docstring(checker: &Checker, body: &[Stmt]) { let Some(stmt) = body.first() else { return; }; @@ -53,7 +51,5 @@ pub(crate) fn f_string_docstring(checker: &mut Checker, body: &[Stmt]) { if !value.is_f_string_expr() { return; } - checker - .diagnostics - .push(Diagnostic::new(FStringDocstring, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new(FStringDocstring, stmt.identifier())); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_call_in_argument_default.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_call_in_argument_default.rs index 4e356e66f2bac..e6efec2bf7cdd 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_call_in_argument_default.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_call_in_argument_default.rs @@ -1,16 +1,15 @@ -use ruff_python_ast::{self as ast, Expr, ParameterWithDefault, Parameters}; -use ruff_text_size::{Ranged, TextRange}; +use ruff_python_ast::{self as ast, Expr, Parameters}; +use ruff_text_size::Ranged; +use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_diagnostics::{Diagnostic, DiagnosticKind}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::{QualifiedName, UnqualifiedName}; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; use ruff_python_semantic::analyze::typing::{ - is_immutable_annotation, is_immutable_func, is_mutable_func, + is_immutable_annotation, is_immutable_func, is_immutable_newtype_call, is_mutable_func, }; -use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; @@ -22,12 +21,12 @@ use crate::checkers::ast::Checker; /// once, at definition time. The returned value will then be reused by all /// calls to the function, which can lead to unexpected behaviour. /// -/// Calls can be marked as an exception to this rule with the -/// [`lint.flake8-bugbear.extend-immutable-calls`] configuration option. +/// Parameters with immutable type annotations will be ignored by this rule. +/// Those whose default arguments are `NewType` calls where the original type +/// is immutable are also ignored. /// -/// Arguments with immutable type annotations will be ignored by this rule. -/// Types outside of the standard library can be marked as immutable with the -/// [`lint.flake8-bugbear.extend-immutable-calls`] configuration option as well. +/// Calls and types outside of the standard library can be marked as an exception +/// to this rule with the [`lint.flake8-bugbear.extend-immutable-calls`] configuration option. /// /// ## Example /// @@ -64,38 +63,34 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.flake8-bugbear.extend-immutable-calls` -#[violation] -pub struct FunctionCallInDefaultArgument { +#[derive(ViolationMetadata)] +pub(crate) struct FunctionCallInDefaultArgument { name: Option<String>, } impl Violation for FunctionCallInDefaultArgument { #[derive_message_formats] fn message(&self) -> String { - let FunctionCallInDefaultArgument { name } = self; - if let Some(name) = name { - format!("Do not perform function call `{name}` in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable") + if let Some(name) = &self.name { + format!( + "Do not perform function call `{name}` in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable" + ) } else { - format!("Do not perform function call in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable") + "Do not perform function call in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable".to_string() } } } struct ArgumentDefaultVisitor<'a, 'b> { - semantic: &'a SemanticModel<'b>, + checker: &'a Checker<'b>, extend_immutable_calls: &'a [QualifiedName<'b>], - diagnostics: Vec<(DiagnosticKind, TextRange)>, } impl<'a, 'b> ArgumentDefaultVisitor<'a, 'b> { - fn new( - semantic: &'a SemanticModel<'b>, - extend_immutable_calls: &'a [QualifiedName<'b>], - ) -> Self { + fn new(checker: &'a Checker<'b>, extend_immutable_calls: &'a [QualifiedName<'b>]) -> Self { Self { - semantic, + checker, extend_immutable_calls, - diagnostics: Vec::new(), } } } @@ -104,14 +99,24 @@ impl Visitor<'_> for ArgumentDefaultVisitor<'_, '_> { fn visit_expr(&mut self, expr: &Expr) { match expr { Expr::Call(ast::ExprCall { func, .. }) => { - if !is_mutable_func(func, self.semantic) - && !is_immutable_func(func, self.semantic, self.extend_immutable_calls) + if !is_mutable_func(func, self.checker.semantic()) + && !is_immutable_func( + func, + self.checker.semantic(), + self.extend_immutable_calls, + ) + && !func.as_name_expr().is_some_and(|name| { + is_immutable_newtype_call( + name, + self.checker.semantic(), + self.extend_immutable_calls, + ) + }) { - self.diagnostics.push(( + self.checker.report_diagnostic(Diagnostic::new( FunctionCallInDefaultArgument { name: UnqualifiedName::from_expr(func).map(|name| name.to_string()), - } - .into(), + }, expr.range(), )); } @@ -126,7 +131,7 @@ impl Visitor<'_> for ArgumentDefaultVisitor<'_, '_> { } /// B008 -pub(crate) fn function_call_in_argument_default(checker: &mut Checker, parameters: &Parameters) { +pub(crate) fn function_call_in_argument_default(checker: &Checker, parameters: &Parameters) { // Map immutable calls to (module, member) format. let extend_immutable_calls: Vec<QualifiedName> = checker .settings @@ -136,23 +141,14 @@ pub(crate) fn function_call_in_argument_default(checker: &mut Checker, parameter .map(|target| QualifiedName::from_dotted_name(target)) .collect(); - let mut visitor = ArgumentDefaultVisitor::new(checker.semantic(), &extend_immutable_calls); - for ParameterWithDefault { - default, - parameter, - range: _, - } in parameters.iter_non_variadic_params() - { - if let Some(expr) = &default { - if !parameter.annotation.as_ref().is_some_and(|expr| { + let mut visitor = ArgumentDefaultVisitor::new(checker, &extend_immutable_calls); + for parameter in parameters.iter_non_variadic_params() { + if let Some(default) = parameter.default() { + if !parameter.annotation().is_some_and(|expr| { is_immutable_annotation(expr, checker.semantic(), &extend_immutable_calls) }) { - visitor.visit_expr(expr); + visitor.visit_expr(default); } } } - - for (check, range) in visitor.diagnostics { - checker.diagnostics.push(Diagnostic::new(check, range)); - } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_uses_loop_variable.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_uses_loop_variable.rs index 58822804a6054..f40692781c93e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_uses_loop_variable.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/function_uses_loop_variable.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::types::Node; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; @@ -40,9 +40,9 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [The Hitchhiker's Guide to Python: Late Binding Closures](https://docs.python-guide.org/writing/gotchas/#late-binding-closures) -/// - [Python documentation: functools.partial](https://docs.python.org/3/library/functools.html#functools.partial) -#[violation] -pub struct FunctionUsesLoopVariable { +/// - [Python documentation: `functools.partial`](https://docs.python.org/3/library/functools.html#functools.partial) +#[derive(ViolationMetadata)] +pub(crate) struct FunctionUsesLoopVariable { name: String, } @@ -277,7 +277,7 @@ impl<'a> Visitor<'a> for AssignedNamesVisitor<'a> { } /// B023 -pub(crate) fn function_uses_loop_variable(checker: &mut Checker, node: &Node) { +pub(crate) fn function_uses_loop_variable(checker: &Checker, node: &Node) { // Identify any "suspicious" variables. These are defined as variables that are // referenced in a function or lambda body, but aren't bound as arguments. let suspicious_variables = { @@ -304,9 +304,8 @@ pub(crate) fn function_uses_loop_variable(checker: &mut Checker, node: &Node) { // loop, flag it. for name in suspicious_variables { if reassigned_in_loop.contains(&name.id.as_str()) { - if !checker.flake8_bugbear_seen.contains(&name.range()) { - checker.flake8_bugbear_seen.push(name.range()); - checker.diagnostics.push(Diagnostic::new( + if checker.insert_flake8_bugbear_range(name.range()) { + checker.report_diagnostic(Diagnostic::new( FunctionUsesLoopVariable { name: name.id.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/getattr_with_constant.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/getattr_with_constant.rs index 550fed3304682..cdf6841774fac 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/getattr_with_constant.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/getattr_with_constant.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_stdlib::identifiers::{is_identifier, is_mangled_private}; use ruff_source_file::LineRanges; @@ -31,16 +31,15 @@ use crate::fix::edits::pad; /// /// ## References /// - [Python documentation: `getattr`](https://docs.python.org/3/library/functions.html#getattr) -#[violation] -pub struct GetAttrWithConstant; +#[derive(ViolationMetadata)] +pub(crate) struct GetAttrWithConstant; impl AlwaysFixableViolation for GetAttrWithConstant { #[derive_message_formats] fn message(&self) -> String { - format!( - "Do not call `getattr` with a constant attribute value. It is not any safer than \ - normal property access." - ) + "Do not call `getattr` with a constant attribute value. It is not any safer than \ + normal property access." + .to_string() } fn fix_title(&self) -> String { @@ -49,12 +48,7 @@ impl AlwaysFixableViolation for GetAttrWithConstant { } /// B009 -pub(crate) fn getattr_with_constant( - checker: &mut Checker, - expr: &Expr, - func: &Expr, - args: &[Expr], -) { +pub(crate) fn getattr_with_constant(checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr]) { let [obj, arg] = args else { return; }; @@ -94,5 +88,5 @@ pub(crate) fn getattr_with_constant( ), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/jump_statement_in_finally.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/jump_statement_in_finally.rs index 23c23d2f11d73..e835a84dc445e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/jump_statement_in_finally.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/jump_statement_in_finally.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,8 +40,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `try` statement](https://docs.python.org/3/reference/compound_stmts.html#the-try-statement) -#[violation] -pub struct JumpStatementInFinally { +#[derive(ViolationMetadata)] +pub(crate) struct JumpStatementInFinally { name: String, } @@ -53,10 +53,10 @@ impl Violation for JumpStatementInFinally { } } -fn walk_stmt(checker: &mut Checker, body: &[Stmt], f: fn(&Stmt) -> bool) { +fn walk_stmt(checker: &Checker, body: &[Stmt], f: fn(&Stmt) -> bool) { for stmt in body { if f(stmt) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( JumpStatementInFinally { name: match stmt { Stmt::Break(_) => "break", @@ -89,7 +89,7 @@ fn walk_stmt(checker: &mut Checker, body: &[Stmt], f: fn(&Stmt) -> bool) { } /// B012 -pub(crate) fn jump_statement_in_finally(checker: &mut Checker, finalbody: &[Stmt]) { +pub(crate) fn jump_statement_in_finally(checker: &Checker, finalbody: &[Stmt]) { walk_stmt(checker, finalbody, |stmt| { matches!(stmt, Stmt::Break(_) | Stmt::Continue(_) | Stmt::Return(_)) }); diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_iterator_mutation.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_iterator_mutation.rs index 648b0f068dacc..5b0e52543ebe3 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_iterator_mutation.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_iterator_mutation.rs @@ -3,13 +3,13 @@ use std::fmt::Debug; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::{ - visitor::{self, Visitor}, Expr, ExprAttribute, ExprCall, ExprSubscript, ExprTuple, Stmt, StmtAssign, StmtAugAssign, StmtDelete, StmtFor, StmtIf, + visitor::{self, Visitor}, }; use ruff_text_size::TextRange; @@ -36,26 +36,24 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// ## References /// - [Python documentation: Mutable Sequence Types](https://docs.python.org/3/library/stdtypes.html#typesseq-mutable) -#[violation] -pub struct LoopIteratorMutation { +#[derive(ViolationMetadata)] +pub(crate) struct LoopIteratorMutation { name: Option<SourceCodeSnippet>, } impl Violation for LoopIteratorMutation { #[derive_message_formats] fn message(&self) -> String { - let LoopIteratorMutation { name } = self; - - if let Some(name) = name.as_ref().and_then(SourceCodeSnippet::full_display) { + if let Some(name) = self.name.as_ref().and_then(SourceCodeSnippet::full_display) { format!("Mutation to loop iterable `{name}` during iteration") } else { - format!("Mutation to loop iterable during iteration") + "Mutation to loop iterable during iteration".to_string() } } } /// B909 -pub(crate) fn loop_iterator_mutation(checker: &mut Checker, stmt_for: &StmtFor) { +pub(crate) fn loop_iterator_mutation(checker: &Checker, stmt_for: &StmtFor) { let StmtFor { target, iter, @@ -112,9 +110,7 @@ pub(crate) fn loop_iterator_mutation(checker: &mut Checker, stmt_for: &StmtFor) let name = UnqualifiedName::from_expr(iter) .map(|name| name.to_string()) .map(SourceCodeSnippet::new); - checker - .diagnostics - .push(Diagnostic::new(LoopIteratorMutation { name }, *mutation)); + checker.report_diagnostic(Diagnostic::new(LoopIteratorMutation { name }, *mutation)); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_variable_overrides_iterator.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_variable_overrides_iterator.rs index 24c2004453c73..51105419a8512 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_variable_overrides_iterator.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/loop_variable_overrides_iterator.rs @@ -1,8 +1,8 @@ -use ruff_python_ast::{self as ast, Expr, ParameterWithDefault}; +use ruff_python_ast::{self as ast, Expr}; use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; use ruff_text_size::Ranged; @@ -36,8 +36,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `for` statement](https://docs.python.org/3/reference/compound_stmts.html#the-for-statement) -#[violation] -pub struct LoopVariableOverridesIterator { +#[derive(ViolationMetadata)] +pub(crate) struct LoopVariableOverridesIterator { name: String, } @@ -50,7 +50,7 @@ impl Violation for LoopVariableOverridesIterator { } /// B020 -pub(crate) fn loop_variable_overrides_iterator(checker: &mut Checker, target: &Expr, iter: &Expr) { +pub(crate) fn loop_variable_overrides_iterator(checker: &Checker, target: &Expr, iter: &Expr) { let target_names = { let mut target_finder = NameFinder::default(); target_finder.visit_expr(target); @@ -64,7 +64,7 @@ pub(crate) fn loop_variable_overrides_iterator(checker: &mut Checker, target: &E for (name, expr) in target_names { if iter_names.contains_key(name) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( LoopVariableOverridesIterator { name: name.to_string(), }, @@ -101,13 +101,8 @@ impl<'a> Visitor<'a> for NameFinder<'a> { visitor::walk_expr(self, body); if let Some(parameters) = parameters { - for ParameterWithDefault { - parameter, - default: _, - range: _, - } in parameters.iter_non_variadic_params() - { - self.names.remove(parameter.name.as_str()); + for parameter in parameters.iter_non_variadic_params() { + self.names.remove(parameter.name().as_str()); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mod.rs index b4af7755dd435..dcf29d0fc1552 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mod.rs @@ -2,7 +2,9 @@ pub(crate) use abstract_base_class::*; pub(crate) use assert_false::*; pub(crate) use assert_raises_exception::*; pub(crate) use assignment_to_os_environ::*; +pub(crate) use batched_without_explicit_strict::*; pub(crate) use cached_instance_method::*; +pub(crate) use class_as_data_structure::*; pub(crate) use duplicate_exceptions::*; pub(crate) use duplicate_value::*; pub(crate) use except_with_empty_tuple::*; @@ -40,7 +42,9 @@ mod abstract_base_class; mod assert_false; mod assert_raises_exception; mod assignment_to_os_environ; +mod batched_without_explicit_strict; mod cached_instance_method; +mod class_as_data_structure; mod duplicate_exceptions; mod duplicate_value; mod except_with_empty_tuple; diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_argument_default.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_argument_default.rs index 6d78902f162f5..01abdeacfa9dd 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_argument_default.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_argument_default.rs @@ -1,19 +1,21 @@ +use std::fmt::Write; + use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::{self as ast, Expr, Parameter, ParameterWithDefault}; +use ruff_python_ast::{self as ast, Expr, Parameter}; use ruff_python_codegen::{Generator, Stylist}; use ruff_python_index::Indexer; +use ruff_python_semantic::SemanticModel; use ruff_python_semantic::analyze::function_type::is_stub; use ruff_python_semantic::analyze::typing::{is_immutable_annotation, is_mutable_expr}; -use ruff_python_semantic::SemanticModel; use ruff_python_trivia::{indentation_at_offset, textwrap}; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for uses of mutable objects as function argument defaults. @@ -68,31 +70,31 @@ use crate::Locator; /// /// ## References /// - [Python documentation: Default Argument Values](https://docs.python.org/3/tutorial/controlflow.html#default-argument-values) -#[violation] -pub struct MutableArgumentDefault; +#[derive(ViolationMetadata)] +pub(crate) struct MutableArgumentDefault; impl Violation for MutableArgumentDefault { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Do not use mutable data structures for argument defaults") + "Do not use mutable data structures for argument defaults".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `None`; initialize within function")) + Some("Replace with `None`; initialize within function".to_string()) } } /// B006 -pub(crate) fn mutable_argument_default(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { - for ParameterWithDefault { - parameter, - default, - range: _, - } in function_def.parameters.iter_non_variadic_params() - { - let Some(default) = default else { +pub(crate) fn mutable_argument_default(checker: &Checker, function_def: &ast::StmtFunctionDef) { + // Skip stub files + if checker.source_type.is_stub() { + return; + } + + for parameter in function_def.parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { continue; }; @@ -105,7 +107,7 @@ pub(crate) fn mutable_argument_default(checker: &mut Checker, function_def: &ast .collect(); if is_mutable_expr(default, checker.semantic()) - && !parameter.annotation.as_ref().is_some_and(|expr| { + && !parameter.annotation().is_some_and(|expr| { is_immutable_annotation(expr, checker.semantic(), extend_immutable_calls.as_slice()) }) { @@ -114,7 +116,7 @@ pub(crate) fn mutable_argument_default(checker: &mut Checker, function_def: &ast // If the function body is on the same line as the function def, do not fix if let Some(fix) = move_initialization( function_def, - parameter, + ¶meter.parameter, default, checker.semantic(), checker.locator(), @@ -124,14 +126,14 @@ pub(crate) fn mutable_argument_default(checker: &mut Checker, function_def: &ast ) { diagnostic.set_fix(fix); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } /// Generate a [`Fix`] to move a mutable argument default initialization /// into the function body. -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] fn move_initialization( function_def: &ast::StmtFunctionDef, parameter: &Parameter, @@ -160,14 +162,15 @@ fn move_initialization( // Add an `if`, to set the argument to its original value if still `None`. let mut content = String::new(); - content.push_str(&format!("if {} is None:", parameter.name.as_str())); + let _ = write!(&mut content, "if {} is None:", parameter.name()); content.push_str(stylist.line_ending().as_str()); content.push_str(stylist.indentation()); - content.push_str(&format!( + let _ = write!( + &mut content, "{} = {}", - parameter.name.as_str(), + parameter.name(), generator.expr(default) - )); + ); content.push_str(stylist.line_ending().as_str()); // Determine the indentation depth of the function body. @@ -204,7 +207,7 @@ fn move_initialization( } } else { break; - }; + } } let initialization_edit = Edit::insertion(content, pos); diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_contextvar_default.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_contextvar_default.rs index c6dc1394a14f3..1923fcaa25aa5 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_contextvar_default.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/mutable_contextvar_default.rs @@ -1,9 +1,10 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::analyze::typing::{is_immutable_func, is_mutable_expr, is_mutable_func}; use ruff_python_semantic::Modules; +use ruff_python_semantic::analyze::typing::{is_immutable_func, is_mutable_expr, is_mutable_func}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -19,9 +20,9 @@ use crate::checkers::ast::Checker; /// the `ContextVar`. If the object is modified, those modifications will persist /// across calls, which can lead to unexpected behavior. /// -/// Instead, prefer to use immutable data structures; or, take `None` as a -/// default, and initialize a new mutable object inside for each call using the -/// `.set()` method. +/// Instead, prefer to use immutable data structures. Alternatively, take +/// `None` as a default, and initialize a new mutable object inside for each +/// call using the `.set()` method. /// /// Types outside the standard library can be marked as immutable with the /// [`lint.flake8-bugbear.extend-immutable-calls`] configuration option. @@ -51,14 +52,14 @@ use crate::checkers::ast::Checker; /// - `lint.flake8-bugbear.extend-immutable-calls` /// /// ## References -/// - [Python documentation: [`contextvars` — Context Variables](https://docs.python.org/3/library/contextvars.html) -#[violation] -pub struct MutableContextvarDefault; +/// - [Python documentation: `contextvars` — Context Variables](https://docs.python.org/3/library/contextvars.html) +#[derive(ViolationMetadata)] +pub(crate) struct MutableContextvarDefault; impl Violation for MutableContextvarDefault { #[derive_message_formats] fn message(&self) -> String { - format!("Do not use mutable data structures for `ContextVar` defaults") + "Do not use mutable data structures for `ContextVar` defaults".to_string() } fn fix_title(&self) -> Option<String> { @@ -67,7 +68,7 @@ impl Violation for MutableContextvarDefault { } /// B039 -pub(crate) fn mutable_contextvar_default(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn mutable_contextvar_default(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::CONTEXTVARS) { return; } @@ -96,13 +97,11 @@ pub(crate) fn mutable_contextvar_default(checker: &mut Checker, call: &ast::Expr && !is_immutable_func(func, checker.semantic(), &extend_immutable_calls))) && checker .semantic() - .resolve_qualified_name(&call.func) + .resolve_qualified_name(map_subscript(&call.func)) .is_some_and(|qualified_name| { matches!(qualified_name.segments(), ["contextvars", "ContextVar"]) }) { - checker - .diagnostics - .push(Diagnostic::new(MutableContextvarDefault, default.range())); + checker.report_diagnostic(Diagnostic::new(MutableContextvarDefault, default.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/no_explicit_stacklevel.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/no_explicit_stacklevel.rs index 35c929b91341b..261246d63e9b9 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/no_explicit_stacklevel.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/no_explicit_stacklevel.rs @@ -1,9 +1,9 @@ -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; +use crate::{checkers::ast::Checker, fix::edits::add_argument}; /// ## What it does /// Checks for `warnings.warn` calls without an explicit `stacklevel` keyword @@ -11,10 +11,11 @@ use crate::checkers::ast::Checker; /// /// ## Why is this bad? /// The `warnings.warn` method uses a `stacklevel` of 1 by default, which -/// limits the rendered stack trace to that of the line on which the -/// `warn` method is called. +/// will output a stack frame of the line on which the "warn" method +/// is called. Setting it to a higher number will output a stack frame +/// from higher up the stack. /// -/// It's recommended to use a `stacklevel` of 2 or higher, give the caller +/// It's recommended to use a `stacklevel` of 2 or higher, to give the caller /// more context about the warning. /// /// ## Example @@ -26,18 +27,31 @@ use crate::checkers::ast::Checker; /// ```python /// warnings.warn("This is a warning", stacklevel=2) /// ``` -#[violation] -pub struct NoExplicitStacklevel; +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe because it changes +/// the behavior of the code. Moreover, the fix will assign +/// a stacklevel of 2, while the user may wish to assign a +/// higher stacklevel to address the diagnostic. +/// +/// ## References +/// - [Python documentation: `warnings.warn`](https://docs.python.org/3/library/warnings.html#warnings.warn) +#[derive(ViolationMetadata)] +pub(crate) struct NoExplicitStacklevel; -impl Violation for NoExplicitStacklevel { +impl AlwaysFixableViolation for NoExplicitStacklevel { #[derive_message_formats] fn message(&self) -> String { - format!("No explicit `stacklevel` keyword argument found") + "No explicit `stacklevel` keyword argument found".to_string() + } + + fn fix_title(&self) -> String { + "Set `stacklevel=2`".to_string() } } /// B028 -pub(crate) fn no_explicit_stacklevel(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn no_explicit_stacklevel(checker: &Checker, call: &ast::ExprCall) { if !checker .semantic() .resolve_qualified_name(&call.func) @@ -46,11 +60,52 @@ pub(crate) fn no_explicit_stacklevel(checker: &mut Checker, call: &ast::ExprCall return; } - if call.arguments.find_keyword("stacklevel").is_some() { + // When prefixes are supplied, stacklevel is implicitly overridden to be `max(2, stacklevel)`. + // + // Signature as of Python 3.13 (https://docs.python.org/3/library/warnings.html#warnings.warn) + // ```text + // 0 1 2 3 4 + // warnings.warn(message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=()) + // ``` + if call + .arguments + .find_argument_value("stacklevel", 2) + .is_some() + || is_skip_file_prefixes_param_set(&call.arguments) + || call + .arguments + .args + .iter() + .any(ruff_python_ast::Expr::is_starred_expr) + || call + .arguments + .keywords + .iter() + .any(|keyword| keyword.arg.is_none()) + { return; } + let mut diagnostic = Diagnostic::new(NoExplicitStacklevel, call.func.range()); + + let edit = add_argument( + "stacklevel=2", + &call.arguments, + checker.comment_ranges(), + checker.locator().contents(), + ); + + diagnostic.set_fix(Fix::unsafe_edit(edit)); + + checker.report_diagnostic(diagnostic); +} - checker - .diagnostics - .push(Diagnostic::new(NoExplicitStacklevel, call.func.range())); +/// Returns `true` if `skip_file_prefixes` is set to its non-default value. +/// The default value of `skip_file_prefixes` is an empty tuple. +fn is_skip_file_prefixes_param_set(arguments: &ast::Arguments) -> bool { + arguments + .find_keyword("skip_file_prefixes") + .is_some_and(|keyword| match &keyword.value { + Expr::Tuple(tuple) => !tuple.elts.is_empty(), + _ => true, + }) } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_literal.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_literal.rs index 3efc6d8c7d847..4c78d34598aa0 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_literal.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_literal.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -26,21 +26,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#the-raise-statement) -#[violation] -pub struct RaiseLiteral; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseLiteral; impl Violation for RaiseLiteral { #[derive_message_formats] fn message(&self) -> String { - format!("Cannot raise a literal. Did you intend to return it or raise an Exception?") + "Cannot raise a literal. Did you intend to return it or raise an Exception?".to_string() } } /// B016 -pub(crate) fn raise_literal(checker: &mut Checker, expr: &Expr) { +pub(crate) fn raise_literal(checker: &Checker, expr: &Expr) { if expr.is_literal_expr() { - checker - .diagnostics - .push(Diagnostic::new(RaiseLiteral, expr.range())); + checker.report_diagnostic(Diagnostic::new(RaiseLiteral, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_without_from_inside_except.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_without_from_inside_except.rs index 7af198e177e4c..7e61499676227 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_without_from_inside_except.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/raise_without_from_inside_except.rs @@ -2,7 +2,7 @@ use ruff_python_ast as ast; use ruff_python_ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::RaiseStatementVisitor; use ruff_python_ast::statement_visitor::StatementVisitor; @@ -46,22 +46,29 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#the-raise-statement) -#[violation] -pub struct RaiseWithoutFromInsideExcept; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseWithoutFromInsideExcept { + is_star: bool, +} impl Violation for RaiseWithoutFromInsideExcept { #[derive_message_formats] fn message(&self) -> String { - format!( + if self.is_star { + "Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... \ + from None` to distinguish them from errors in exception handling" + .to_string() + } else { "Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... \ - from None` to distinguish them from errors in exception handling" - ) + from None` to distinguish them from errors in exception handling" + .to_string() + } } } /// B904 pub(crate) fn raise_without_from_inside_except( - checker: &mut Checker, + checker: &Checker, name: Option<&str>, body: &[Stmt], ) { @@ -93,9 +100,16 @@ pub(crate) fn raise_without_from_inside_except( } } - checker - .diagnostics - .push(Diagnostic::new(RaiseWithoutFromInsideExcept, range)); + let is_star = checker + .semantic() + .current_statement() + .as_try_stmt() + .is_some_and(|try_stmt| try_stmt.is_star); + + checker.report_diagnostic(Diagnostic::new( + RaiseWithoutFromInsideExcept { is_star }, + range, + )); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/re_sub_positional_args.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/re_sub_positional_args.rs index 06bbc8cdd8237..93ac716753528 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/re_sub_positional_args.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/re_sub_positional_args.rs @@ -3,7 +3,7 @@ use std::fmt; use ruff_python_ast::{self as ast}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -39,8 +39,8 @@ use crate::checkers::ast::Checker; /// - [Python documentation: `re.sub`](https://docs.python.org/3/library/re.html#re.sub) /// - [Python documentation: `re.subn`](https://docs.python.org/3/library/re.html#re.subn) /// - [Python documentation: `re.split`](https://docs.python.org/3/library/re.html#re.split) -#[violation] -pub struct ReSubPositionalArgs { +#[derive(ViolationMetadata)] +pub(crate) struct ReSubPositionalArgs { method: Method, } @@ -56,7 +56,7 @@ impl Violation for ReSubPositionalArgs { } /// B034 -pub(crate) fn re_sub_positional_args(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn re_sub_positional_args(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::RE) { return; } @@ -75,7 +75,7 @@ pub(crate) fn re_sub_positional_args(checker: &mut Checker, call: &ast::ExprCall }; if call.arguments.args.len() > method.num_args() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ReSubPositionalArgs { method }, call.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/redundant_tuple_in_exception_handler.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/redundant_tuple_in_exception_handler.rs index 4cfa189a96f88..5fc41a1144e6c 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/redundant_tuple_in_exception_handler.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/redundant_tuple_in_exception_handler.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, ExceptHandler, Expr}; use ruff_text_size::Ranged; @@ -35,15 +35,15 @@ use crate::fix::edits::pad; /// /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) -#[violation] -pub struct RedundantTupleInExceptionHandler { +#[derive(ViolationMetadata)] +pub(crate) struct RedundantTupleInExceptionHandler { name: String, } impl AlwaysFixableViolation for RedundantTupleInExceptionHandler { #[derive_message_formats] fn message(&self) -> String { - format!("A length-one tuple literal is redundant in exception handlers") + "A length-one tuple literal is redundant in exception handlers".to_string() } fn fix_title(&self) -> String { @@ -53,10 +53,7 @@ impl AlwaysFixableViolation for RedundantTupleInExceptionHandler { } /// B013 -pub(crate) fn redundant_tuple_in_exception_handler( - checker: &mut Checker, - handlers: &[ExceptHandler], -) { +pub(crate) fn redundant_tuple_in_exception_handler(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_: Some(type_), @@ -103,6 +100,6 @@ pub(crate) fn redundant_tuple_in_exception_handler( ), type_.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/return_in_generator.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/return_in_generator.rs index 9e80a2fca52b4..6c77f895229ac 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/return_in_generator.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/return_in_generator.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::statement_visitor; use ruff_python_ast::statement_visitor::StatementVisitor; use ruff_python_ast::{self as ast, Expr, Stmt, StmtFunctionDef}; @@ -79,18 +79,19 @@ use crate::checkers::ast::Checker; /// for file_type in file_types: /// yield from dir_path.glob(f"*.{file_type}") /// ``` -#[violation] -pub struct ReturnInGenerator; +#[derive(ViolationMetadata)] +pub(crate) struct ReturnInGenerator; impl Violation for ReturnInGenerator { #[derive_message_formats] fn message(&self) -> String { - format!("Using `yield` and `return {{value}}` in a generator function can lead to confusing behavior") + "Using `yield` and `return {value}` in a generator function can lead to confusing behavior" + .to_string() } } /// B901 -pub(crate) fn return_in_generator(checker: &mut Checker, function_def: &StmtFunctionDef) { +pub(crate) fn return_in_generator(checker: &Checker, function_def: &StmtFunctionDef) { if function_def.name.id == "__await__" { return; } @@ -100,9 +101,7 @@ pub(crate) fn return_in_generator(checker: &mut Checker, function_def: &StmtFunc if visitor.has_yield { if let Some(return_) = visitor.return_ { - checker - .diagnostics - .push(Diagnostic::new(ReturnInGenerator, return_)); + checker.report_diagnostic(Diagnostic::new(ReturnInGenerator, return_)); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/reuse_of_groupby_generator.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/reuse_of_groupby_generator.rs index c9deccbfc6418..d140cc2078792 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/reuse_of_groupby_generator.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/reuse_of_groupby_generator.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Comprehension, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::{self, Visitor}; use ruff_text_size::Ranged; @@ -15,7 +15,7 @@ use crate::checkers::ast::Checker; /// Using the generator more than once will do nothing on the second usage. /// If that data is needed later, it should be stored as a list. /// -/// ## Examples: +/// ## Example: /// ```python /// import itertools /// @@ -33,13 +33,13 @@ use crate::checkers::ast::Checker; /// for _ in range(5): /// do_something_with_the_group(values) /// ``` -#[violation] -pub struct ReuseOfGroupbyGenerator; +#[derive(ViolationMetadata)] +pub(crate) struct ReuseOfGroupbyGenerator; impl Violation for ReuseOfGroupbyGenerator { #[derive_message_formats] fn message(&self) -> String { - format!("Using the generator returned from `itertools.groupby()` more than once will do nothing on the second usage") + "Using the generator returned from `itertools.groupby()` more than once will do nothing on the second usage".to_string() } } @@ -307,7 +307,7 @@ impl<'a> Visitor<'a> for GroupNameFinder<'a> { /// B031 pub(crate) fn reuse_of_groupby_generator( - checker: &mut Checker, + checker: &Checker, target: &Expr, body: &[Stmt], iter: &Expr, @@ -339,8 +339,6 @@ pub(crate) fn reuse_of_groupby_generator( finder.visit_stmt(stmt); } for expr in finder.exprs { - checker - .diagnostics - .push(Diagnostic::new(ReuseOfGroupbyGenerator, expr.range())); + checker.report_diagnostic(Diagnostic::new(ReuseOfGroupbyGenerator, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/setattr_with_constant.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/setattr_with_constant.rs index 6f0b386c7c040..4694c07df64a9 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/setattr_with_constant.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/setattr_with_constant.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Expr, ExprContext, Identifier, Stmt}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_codegen::Generator; use ruff_python_stdlib::identifiers::{is_identifier, is_mangled_private}; @@ -30,16 +30,15 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `setattr`](https://docs.python.org/3/library/functions.html#setattr) -#[violation] -pub struct SetAttrWithConstant; +#[derive(ViolationMetadata)] +pub(crate) struct SetAttrWithConstant; impl AlwaysFixableViolation for SetAttrWithConstant { #[derive_message_formats] fn message(&self) -> String { - format!( - "Do not call `setattr` with a constant attribute value. It is not any safer than \ + "Do not call `setattr` with a constant attribute value. It is not any safer than \ normal property access." - ) + .to_string() } fn fix_title(&self) -> String { @@ -62,12 +61,7 @@ fn assignment(obj: &Expr, name: &str, value: &Expr, generator: Generator) -> Str } /// B010 -pub(crate) fn setattr_with_constant( - checker: &mut Checker, - expr: &Expr, - func: &Expr, - args: &[Expr], -) { +pub(crate) fn setattr_with_constant(checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr]) { let [obj, name, value] = args else { return; }; @@ -101,7 +95,7 @@ pub(crate) fn setattr_with_constant( assignment(obj, name.to_str(), value, checker.generator()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/star_arg_unpacking_after_keyword_arg.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/star_arg_unpacking_after_keyword_arg.rs index a281b9316389a..dc295cb21f126 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/star_arg_unpacking_after_keyword_arg.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/star_arg_unpacking_after_keyword_arg.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, Keyword}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -45,19 +45,19 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: Calls](https://docs.python.org/3/reference/expressions.html#calls) /// - [Disallow iterable argument unpacking after a keyword argument?](https://github.com/python/cpython/issues/82741) -#[violation] -pub struct StarArgUnpackingAfterKeywordArg; +#[derive(ViolationMetadata)] +pub(crate) struct StarArgUnpackingAfterKeywordArg; impl Violation for StarArgUnpackingAfterKeywordArg { #[derive_message_formats] fn message(&self) -> String { - format!("Star-arg unpacking after a keyword argument is strongly discouraged") + "Star-arg unpacking after a keyword argument is strongly discouraged".to_string() } } /// B026 pub(crate) fn star_arg_unpacking_after_keyword_arg( - checker: &mut Checker, + checker: &Checker, args: &[Expr], keywords: &[Keyword], ) { @@ -71,7 +71,7 @@ pub(crate) fn star_arg_unpacking_after_keyword_arg( if arg.start() <= keyword.start() { continue; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StarArgUnpackingAfterKeywordArg, arg.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/static_key_dict_comprehension.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/static_key_dict_comprehension.rs index a19c22ec238f6..fdd937ade210c 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/static_key_dict_comprehension.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/static_key_dict_comprehension.rs @@ -1,7 +1,7 @@ use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::StoredNameFinder; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, Expr}; @@ -30,25 +30,24 @@ use crate::fix::snippet::SourceCodeSnippet; /// data = ["some", "Data"] /// {value: value.upper() for value in data} /// ``` -#[violation] -pub struct StaticKeyDictComprehension { +#[derive(ViolationMetadata)] +pub(crate) struct StaticKeyDictComprehension { key: SourceCodeSnippet, } impl Violation for StaticKeyDictComprehension { #[derive_message_formats] fn message(&self) -> String { - let StaticKeyDictComprehension { key } = self; - if let Some(key) = key.full_display() { + if let Some(key) = self.key.full_display() { format!("Dictionary comprehension uses static key: `{key}`") } else { - format!("Dictionary comprehension uses static key") + "Dictionary comprehension uses static key".to_string() } } } /// RUF011 -pub(crate) fn static_key_dict_comprehension(checker: &mut Checker, dict_comp: &ast::ExprDictComp) { +pub(crate) fn static_key_dict_comprehension(checker: &Checker, dict_comp: &ast::ExprDictComp) { // Collect the bound names in the comprehension's generators. let names = { let mut visitor = StoredNameFinder::default(); @@ -59,7 +58,7 @@ pub(crate) fn static_key_dict_comprehension(checker: &mut Checker, dict_comp: &a }; if is_constant(&dict_comp.key, &names) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StaticKeyDictComprehension { key: SourceCodeSnippet::from_str(checker.locator().slice(dict_comp.key.as_ref())), }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/strip_with_multi_characters.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/strip_with_multi_characters.rs index 804ce3b6e03ef..7eb149edd9d86 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/strip_with_multi_characters.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/strip_with_multi_characters.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -44,19 +44,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `str.strip`](https://docs.python.org/3/library/stdtypes.html#str.strip) -#[violation] -pub struct StripWithMultiCharacters; +#[derive(ViolationMetadata)] +pub(crate) struct StripWithMultiCharacters; impl Violation for StripWithMultiCharacters { #[derive_message_formats] fn message(&self) -> String { - format!("Using `.strip()` with multi-character strings is misleading") + "Using `.strip()` with multi-character strings is misleading".to_string() } } /// B005 pub(crate) fn strip_with_multi_characters( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -73,8 +73,6 @@ pub(crate) fn strip_with_multi_characters( }; if value.chars().count() > 1 && !value.chars().all_unique() { - checker - .diagnostics - .push(Diagnostic::new(StripWithMultiCharacters, expr.range())); + checker.report_diagnostic(Diagnostic::new(StripWithMultiCharacters, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unary_prefix_increment_decrement.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unary_prefix_increment_decrement.rs index e193385239b8a..d7b6c193c0424 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unary_prefix_increment_decrement.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unary_prefix_increment_decrement.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, UnaryOp}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -30,21 +30,20 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: Unary arithmetic and bitwise operations](https://docs.python.org/3/reference/expressions.html#unary-arithmetic-and-bitwise-operations) /// - [Python documentation: Augmented assignment statements](https://docs.python.org/3/reference/simple_stmts.html#augmented-assignment-statements) -#[violation] -pub struct UnaryPrefixIncrementDecrement { +#[derive(ViolationMetadata)] +pub(crate) struct UnaryPrefixIncrementDecrement { operator: UnaryPrefixOperatorType, } impl Violation for UnaryPrefixIncrementDecrement { #[derive_message_formats] fn message(&self) -> String { - let UnaryPrefixIncrementDecrement { operator } = self; - match operator { + match self.operator { UnaryPrefixOperatorType::Increment => { - format!("Python does not support the unary prefix increment operator (`++`)") + "Python does not support the unary prefix increment operator (`++`)".to_string() } UnaryPrefixOperatorType::Decrement => { - format!("Python does not support the unary prefix decrement operator (`--`)") + "Python does not support the unary prefix decrement operator (`--`)".to_string() } } } @@ -52,7 +51,7 @@ impl Violation for UnaryPrefixIncrementDecrement { /// B002 pub(crate) fn unary_prefix_increment_decrement( - checker: &mut Checker, + checker: &Checker, expr: &Expr, op: UnaryOp, operand: &Expr, @@ -62,7 +61,7 @@ pub(crate) fn unary_prefix_increment_decrement( }; match (op, nested_op) { (UnaryOp::UAdd, UnaryOp::UAdd) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnaryPrefixIncrementDecrement { operator: UnaryPrefixOperatorType::Increment, }, @@ -70,7 +69,7 @@ pub(crate) fn unary_prefix_increment_decrement( )); } (UnaryOp::USub, UnaryOp::USub) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnaryPrefixIncrementDecrement { operator: UnaryPrefixOperatorType::Decrement, }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unintentional_type_annotation.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unintentional_type_annotation.rs index 69f8c5505d4e6..2c2b1442fef57 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unintentional_type_annotation.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unintentional_type_annotation.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -22,21 +22,20 @@ use crate::checkers::ast::Checker; /// ```python /// a["b"] = 1 /// ``` -#[violation] -pub struct UnintentionalTypeAnnotation; +#[derive(ViolationMetadata)] +pub(crate) struct UnintentionalTypeAnnotation; impl Violation for UnintentionalTypeAnnotation { #[derive_message_formats] fn message(&self) -> String { - format!( - "Possible unintentional type annotation (using `:`). Did you mean to assign (using `=`)?" - ) + "Possible unintentional type annotation (using `:`). Did you mean to assign (using `=`)?" + .to_string() } } /// B032 pub(crate) fn unintentional_type_annotation( - checker: &mut Checker, + checker: &Checker, target: &Expr, value: Option<&Expr>, stmt: &Stmt, @@ -48,19 +47,19 @@ pub(crate) fn unintentional_type_annotation( Expr::Subscript(ast::ExprSubscript { value, .. }) => { if value.is_name_expr() { checker - .diagnostics - .push(Diagnostic::new(UnintentionalTypeAnnotation, stmt.range())); + .report_diagnostic(Diagnostic::new(UnintentionalTypeAnnotation, stmt.range())); } } Expr::Attribute(ast::ExprAttribute { value, .. }) => { if let Expr::Name(ast::ExprName { id, .. }) = value.as_ref() { if id != "self" { - checker - .diagnostics - .push(Diagnostic::new(UnintentionalTypeAnnotation, stmt.range())); + checker.report_diagnostic(Diagnostic::new( + UnintentionalTypeAnnotation, + stmt.range(), + )); } } } _ => {} - }; + } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unreliable_callable_check.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unreliable_callable_check.rs index d076946330a96..632fd5d00f4de 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unreliable_callable_check.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unreliable_callable_check.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -31,28 +31,27 @@ use crate::checkers::ast::Checker; /// - [Python documentation: `hasattr`](https://docs.python.org/3/library/functions.html#hasattr) /// - [Python documentation: `__getattr__`](https://docs.python.org/3/reference/datamodel.html#object.__getattr__) /// - [Python documentation: `__call__`](https://docs.python.org/3/reference/datamodel.html#object.__call__) -#[violation] -pub struct UnreliableCallableCheck; +#[derive(ViolationMetadata)] +pub(crate) struct UnreliableCallableCheck; impl Violation for UnreliableCallableCheck { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!( - "Using `hasattr(x, \"__call__\")` to test if x is callable is unreliable. Use \ + "Using `hasattr(x, \"__call__\")` to test if x is callable is unreliable. Use \ `callable(x)` for consistent results." - ) + .to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `callable()`")) + Some("Replace with `callable()`".to_string()) } } /// B004 pub(crate) fn unreliable_callable_check( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -88,5 +87,5 @@ pub(crate) fn unreliable_callable_check( Ok(Fix::safe_edits(binding_edit, import_edit)) }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unused_loop_control_variable.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unused_loop_control_variable.rs index bf8f7318a3b45..01d01ad8532df 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/unused_loop_control_variable.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/unused_loop_control_variable.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::helpers; use ruff_python_ast::helpers::{NameFinder, StoredNameFinder}; @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [PEP 8: Naming Conventions](https://peps.python.org/pep-0008/#naming-conventions) -#[violation] -pub struct UnusedLoopControlVariable { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedLoopControlVariable { /// The name of the loop control variable. name: String, /// The name to which the variable should be renamed, if it can be @@ -76,7 +76,7 @@ impl Violation for UnusedLoopControlVariable { } /// B007 -pub(crate) fn unused_loop_control_variable(checker: &mut Checker, stmt_for: &ast::StmtFor) { +pub(crate) fn unused_loop_control_variable(checker: &Checker, stmt_for: &ast::StmtFor) { let control_names = { let mut finder = StoredNameFinder::default(); finder.visit_expr(stmt_for.target.as_ref()); @@ -147,7 +147,7 @@ pub(crate) fn unused_loop_control_variable(checker: &mut Checker, stmt_for: &ast } } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_comparison.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_comparison.rs index 83e295a3381ae..2c1434106c02e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_comparison.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_comparison.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, Stmt}; use ruff_python_semantic::ScopeKind; use ruff_text_size::Ranged; @@ -33,8 +33,8 @@ use super::super::helpers::at_last_top_level_expression_in_cell; /// /// ## References /// - [Python documentation: `assert` statement](https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement) -#[violation] -pub struct UselessComparison { +#[derive(ViolationMetadata)] +pub(crate) struct UselessComparison { at: ComparisonLocationAt, } @@ -42,20 +42,22 @@ impl Violation for UselessComparison { #[derive_message_formats] fn message(&self) -> String { match self.at { - ComparisonLocationAt::MiddleBody => format!( + ComparisonLocationAt::MiddleBody => { "Pointless comparison. Did you mean to assign a value? \ Otherwise, prepend `assert` or remove it." - ), - ComparisonLocationAt::EndOfFunction => format!( + .to_string() + } + ComparisonLocationAt::EndOfFunction => { "Pointless comparison at end of function scope. Did you mean \ to return the expression result?" - ), + .to_string() + } } } } /// B015 -pub(crate) fn useless_comparison(checker: &mut Checker, expr: &Expr) { +pub(crate) fn useless_comparison(checker: &Checker, expr: &Expr) { if expr.is_compare_expr() { let semantic = checker.semantic(); @@ -76,7 +78,7 @@ pub(crate) fn useless_comparison(checker: &mut Checker, expr: &Expr) { .and_then(Stmt::as_expr_stmt) .is_some_and(|last_stmt| &*last_stmt.value == expr) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UselessComparison { at: ComparisonLocationAt::EndOfFunction, }, @@ -86,7 +88,7 @@ pub(crate) fn useless_comparison(checker: &mut Checker, expr: &Expr) { } } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UselessComparison { at: ComparisonLocationAt::MiddleBody, }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_contextlib_suppress.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_contextlib_suppress.rs index e96b6c631dac8..350681548ce6d 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_contextlib_suppress.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_contextlib_suppress.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -35,23 +35,22 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [Python documentation: contextlib.suppress](https://docs.python.org/3/library/contextlib.html#contextlib.suppress) -#[violation] -pub struct UselessContextlibSuppress; +/// - [Python documentation: `contextlib.suppress`](https://docs.python.org/3/library/contextlib.html#contextlib.suppress) +#[derive(ViolationMetadata)] +pub(crate) struct UselessContextlibSuppress; impl Violation for UselessContextlibSuppress { #[derive_message_formats] fn message(&self) -> String { - format!( - "No arguments passed to `contextlib.suppress`. No exceptions will be suppressed and \ - therefore this context manager is redundant" - ) + "No arguments passed to `contextlib.suppress`. No exceptions will be suppressed and \ + therefore this context manager is redundant" + .to_string() } } /// B022 pub(crate) fn useless_contextlib_suppress( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -64,8 +63,6 @@ pub(crate) fn useless_contextlib_suppress( matches!(qualified_name.segments(), ["contextlib", "suppress"]) }) { - checker - .diagnostics - .push(Diagnostic::new(UselessContextlibSuppress, expr.range())); + checker.report_diagnostic(Diagnostic::new(UselessContextlibSuppress, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_expression.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_expression.rs index a431bb1d92c69..b711dcfdb60e9 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_expression.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/useless_expression.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers::contains_effect; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; +use ruff_python_ast::helpers::contains_effect; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -50,8 +50,8 @@ use super::super::helpers::at_last_top_level_expression_in_cell; /// with errors.ExceptionRaisedContext(): /// _ = obj.attribute /// ``` -#[violation] -pub struct UselessExpression { +#[derive(ViolationMetadata)] +pub(crate) struct UselessExpression { kind: Kind, } @@ -60,19 +60,18 @@ impl Violation for UselessExpression { fn message(&self) -> String { match self.kind { Kind::Expression => { - format!("Found useless expression. Either assign it to a variable or remove it.") + "Found useless expression. Either assign it to a variable or remove it.".to_string() } Kind::Attribute => { - format!( - "Found useless attribute access. Either assign it to a variable or remove it." - ) + "Found useless attribute access. Either assign it to a variable or remove it." + .to_string() } } } } /// B018 -pub(crate) fn useless_expression(checker: &mut Checker, value: &Expr) { +pub(crate) fn useless_expression(checker: &Checker, value: &Expr) { // Ignore comparisons, as they're handled by `useless_comparison`. if value.is_compare_expr() { return; @@ -101,7 +100,7 @@ pub(crate) fn useless_expression(checker: &mut Checker, value: &Expr) { // Flag attributes as useless expressions, even if they're attached to calls or other // expressions. if value.is_attribute_expr() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UselessExpression { kind: Kind::Attribute, }, @@ -111,7 +110,7 @@ pub(crate) fn useless_expression(checker: &mut Checker, value: &Expr) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UselessExpression { kind: Kind::Expression, }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/rules/zip_without_explicit_strict.rs b/crates/ruff_linter/src/rules/flake8_bugbear/rules/zip_without_explicit_strict.rs index 162af2b907305..88e2554000314 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/rules/zip_without_explicit_strict.rs +++ b/crates/ruff_linter/src/rules/flake8_bugbear/rules/zip_without_explicit_strict.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_python_semantic::SemanticModel; @@ -17,7 +17,7 @@ use crate::fix::edits::add_argument; /// iterable. This can lead to subtle bugs. /// /// Pass `strict=True` to raise a `ValueError` if the iterables are of -/// non-uniform length. Alternatively, if the iterables are deliberately +/// non-uniform length. Alternatively, if the iterables are deliberately of /// different lengths, pass `strict=False` to make the intention explicit. /// /// ## Example @@ -37,13 +37,13 @@ use crate::fix::edits::add_argument; /// /// ## References /// - [Python documentation: `zip`](https://docs.python.org/3/library/functions.html#zip) -#[violation] -pub struct ZipWithoutExplicitStrict; +#[derive(ViolationMetadata)] +pub(crate) struct ZipWithoutExplicitStrict; impl AlwaysFixableViolation for ZipWithoutExplicitStrict { #[derive_message_formats] fn message(&self) -> String { - format!("`zip()` without an explicit `strict=` parameter") + "`zip()` without an explicit `strict=` parameter".to_string() } fn fix_title(&self) -> String { @@ -52,7 +52,7 @@ impl AlwaysFixableViolation for ZipWithoutExplicitStrict { } /// B905 -pub(crate) fn zip_without_explicit_strict(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn zip_without_explicit_strict(checker: &Checker, call: &ast::ExprCall) { let semantic = checker.semantic(); if semantic.match_builtin_expr(&call.func, "zip") @@ -61,9 +61,9 @@ pub(crate) fn zip_without_explicit_strict(checker: &mut Checker, call: &ast::Exp .arguments .args .iter() - .any(|arg| is_infinite_iterator(arg, semantic)) + .any(|arg| is_infinite_iterable(arg, semantic)) { - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new(ZipWithoutExplicitStrict, call.range()).with_fix(Fix::applicable_edit( add_argument( "strict=False", @@ -89,7 +89,7 @@ pub(crate) fn zip_without_explicit_strict(checker: &mut Checker, call: &ast::Exp /// Return `true` if the [`Expr`] appears to be an infinite iterator (e.g., a call to /// `itertools.cycle` or similar). -fn is_infinite_iterator(arg: &Expr, semantic: &SemanticModel) -> bool { +pub(crate) fn is_infinite_iterable(arg: &Expr, semantic: &SemanticModel) -> bool { let Expr::Call(ast::ExprCall { func, arguments: Arguments { args, keywords, .. }, diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B002_B002.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B002_B002.py.snap index 2f7974eab8986..bac4567388fb5 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B002_B002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B002_B002.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B002.py:18:9: B002 Python does not support the unary prefix increment operator (`++`) | @@ -32,5 +33,3 @@ B002.py:24:17: B002 Python does not support the unary prefix decrement operator 24 | return ++n, --n | ^^^ B002 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B003_B003.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B003_B003.py.snap index 0ee03ce25df86..3220d7235393a 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B003_B003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B003_B003.py.snap @@ -4,10 +4,8 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B003.py:9:1: B003 Assigning to `os.environ` doesn't clear the environment | 7 | from os import environ - 8 | + 8 | 9 | os.environ = {} | ^^^^^^^^^^ B003 10 | environ = {} # that's fine, assigning a new meaning to the module-level name | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap index da4177d024b9f..2d67212e68d25 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap @@ -65,7 +65,7 @@ B004.py:14:8: B004 Using `hasattr(x, "__call__")` to test if x is callable is un B004.py:24:8: B004 [*] Using `hasattr(x, "__call__")` to test if x is callable is unreliable. Use `callable(x)` for consistent results. | 22 | return True -23 | +23 | 24 | if hasattr(o, "__call__"): | ^^^^^^^^^^^^^^^^^^^^^^ B004 25 | print("STILL a bug!") diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B005_B005.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B005_B005.py.snap index 1eda1ef5f1677..9291a453fab72 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B005_B005.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B005_B005.py.snap @@ -77,8 +77,6 @@ B005.py:24:1: B005 Using `.strip()` with multi-character strings is misleading 23 | s.strip("\ufeff") # no warning 24 | s.strip("\u0074\u0065\u0073\u0074") # warning | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B005 -25 | +25 | 26 | from somewhere import other_type, strip | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap index 1456ef463102a..a14c6205fc5ce 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B006_1.py:3:22: B006 [*] Do not use mutable data structures for argument defaults | 1 | # Docstring followed by a newline -2 | +2 | 3 | def foobar(foor, bar={}): | ^^ B006 4 | """ diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.pyi.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.pyi.snap new file mode 100644 index 0000000000000..30ef2c1efd4af --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap index c050ac73b7212..6148acae1a9e0 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B006_2.py:4:22: B006 [*] Do not use mutable data structures for argument defaults | 2 | # Regression test for https://github.com/astral-sh/ruff/issues/7155 -3 | +3 | 4 | def foobar(foor, bar={}): | ^^ B006 5 | """ diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap index 583e51b5a7cd7..8e304f3b25b7d 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_3.py:4:22: B006 [*] Do not use mutable data structures for argument defaults | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap index 2494c15ac42ef..500d1427dfcd7 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_4.py:7:26: B006 [*] Do not use mutable data structures for argument defaults | @@ -19,6 +20,4 @@ B006_4.py:7:26: B006 [*] Do not use mutable data structures for argument default 8 |+ if a is None: 9 |+ a = [] 8 10 | print(a) -9 11 | - - +9 11 | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_5.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_5.py.snap index 24ad24f06b524..2218f8938221a 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_5.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_5.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_5.py:5:49: B006 [*] Do not use mutable data structures for argument defaults | @@ -309,5 +310,3 @@ B006_5.py:73:49: B006 Do not use mutable data structures for argument defaults 74 | import os | = help: Replace with `None`; initialize within function - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_6.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_6.py.snap index 032ad0e13259d..45040e91fb9e7 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_6.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_6.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B006_6.py:4:22: B006 [*] Do not use mutable data structures for argument defaults | 2 | # Same as B006_2.py, but import instead of docstring -3 | +3 | 4 | def foobar(foor, bar={}): | ^^ B006 5 | import os @@ -21,5 +21,3 @@ B006_6.py:4:22: B006 [*] Do not use mutable data structures for argument default 5 |+ import os 6 |+ if bar is None: 7 |+ bar = {} - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_7.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_7.py.snap index 05fdbd20f189d..3e00a26e6f509 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_7.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_7.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B006_7.py:4:22: B006 [*] Do not use mutable data structures for argument defaults | 2 | # Same as B006_3.py, but import instead of docstring -3 | +3 | 4 | def foobar(foor, bar={}): | ^^ B006 5 | import os @@ -21,5 +21,3 @@ B006_7.py:4:22: B006 [*] Do not use mutable data structures for argument default 5 |+ import os 6 |+ if bar is None: 7 |+ bar = {} - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_8.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_8.py.snap index 866643aa45474..059fe888d64d6 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_8.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_8.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_8.py:1:19: B006 [*] Do not use mutable data structures for argument defaults | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_B008.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_B008.py.snap index 5627954be4cd2..1fa6c1c985931 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_B008.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_B008.py.snap @@ -61,7 +61,7 @@ B006_B008.py:77:31: B006 [*] Do not use mutable data structures for argument def | 77 | def multiline_arg_wrong(value={ | _______________________________^ -78 | | +78 | | 79 | | }): | |_^ B006 80 | ... @@ -83,7 +83,7 @@ B006_B008.py:77:31: B006 [*] Do not use mutable data structures for argument def B006_B008.py:82:36: B006 Do not use mutable data structures for argument defaults | 80 | ... -81 | +81 | 82 | def single_line_func_wrong(value = {}): ... | ^^ B006 | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B007_B007.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B007_B007.py.snap index 5f36888c89df6..ea5052cf82934 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B007_B007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B007_B007.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B007.py:6:5: B007 Loop control variable `i` not used within loop body | 4 | print(i) # name no longer defined on Python 3; no warning yet -5 | +5 | 6 | for i in range(10): # name not used within the loop; B007 | ^ B007 7 | print(10) @@ -70,7 +70,7 @@ B007.py:34:10: B007 Loop control variable `bar` may not be used within loop body B007.py:38:10: B007 Loop control variable `bar` may not be used within loop body | 36 | print(FMT.format(**locals())) -37 | +37 | 38 | for foo, bar in [(1, 2)]: | ^^^ B007 39 | if foo: @@ -81,7 +81,7 @@ B007.py:38:10: B007 Loop control variable `bar` may not be used within loop body B007.py:42:10: B007 Loop control variable `bar` may not be used within loop body | 40 | print(FMT.format(**globals())) -41 | +41 | 42 | for foo, bar in [(1, 2)]: | ^^^ B007 43 | if foo: @@ -92,7 +92,7 @@ B007.py:42:10: B007 Loop control variable `bar` may not be used within loop body B007.py:46:10: B007 Loop control variable `bar` may not be used within loop body | 44 | print(FMT.format(**vars())) -45 | +45 | 46 | for foo, bar in [(1, 2)]: | ^^^ B007 47 | print(FMT.format(foo=foo, bar=eval("bar"))) @@ -182,5 +182,3 @@ B007.py:98:5: B007 Loop control variable `line_` not used within loop body | ^^^^^ B007 99 | fp.readline() | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B008_B006_B008.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B008_B006_B008.py.snap index 9e967b877262c..b0cd27b5305dc 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B008_B006_B008.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B008_B006_B008.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_B008.py:102:61: B008 Do not perform function call `range` in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable | @@ -79,5 +80,3 @@ B006_B008.py:250:37: B008 Do not perform function call `dt.datetime.now` in argu | ^^^^^^^^^^^^^^^^^ B008 251 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B009_B009_B010.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B009_B009_B010.py.snap index fc00bb4ef9792..5748ea4eb7612 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B009_B009_B010.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B009_B009_B010.py.snap @@ -321,7 +321,7 @@ B009_B010.py:58:8: B009 [*] Do not call `getattr` with a constant attribute valu 57 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722458885 58 | assert getattr(func, '_rpc')is True | ^^^^^^^^^^^^^^^^^^^^^ B009 -59 | +59 | 60 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1732387247 | = help: Replace `getattr` with attribute access @@ -342,7 +342,7 @@ B009_B010.py:65:1: B009 [*] Do not call `getattr` with a constant attribute valu 65 | / getattr(self. 66 | | registration.registry, '__name__') | |_____________________________________^ B009 -67 | +67 | 68 | import builtins | = help: Replace `getattr` with attribute access diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B010_B009_B010.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B010_B009_B010.py.snap index cad3fc9306173..42a169cb1b2e0 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B010_B009_B010.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B010_B009_B010.py.snap @@ -110,7 +110,7 @@ B009_B010.py:55:1: B010 [*] Do not call `setattr` with a constant attribute valu 54 | setattr(foo, r"abc123", None) 55 | setattr(foo.bar, r"baz", None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B010 -56 | +56 | 57 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722458885 | = help: Replace `setattr` with assignment @@ -124,5 +124,3 @@ B009_B010.py:55:1: B010 [*] Do not call `setattr` with a constant attribute valu 56 56 | 57 57 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722458885 58 58 | assert getattr(func, '_rpc')is True - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B011_B011.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B011_B011.py.snap index 828397abcea25..b04f7a057aef6 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B011_B011.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B011_B011.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B011.py:8:8: B011 [*] Do not `assert False` (`python -O` removes these calls), raise `AssertionError()` | @@ -35,5 +36,3 @@ B011.py:10:8: B011 [*] Do not `assert False` (`python -O` removes these calls), 9 9 | assert 1 != 2, "message" 10 |-assert False, "message" 10 |+raise AssertionError("message") - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B012_B012.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B012_B012.py.snap index bba51ea1231b1..5bbd36c330033 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B012_B012.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B012_B012.py.snap @@ -43,7 +43,7 @@ B012.py:44:21: B012 `return` inside `finally` blocks cause exceptions to be sile 43 | finally: 44 | return # warning | ^^^^^^ B012 -45 | +45 | 46 | finally: | @@ -53,7 +53,7 @@ B012.py:66:13: B012 `break` inside `finally` blocks cause exceptions to be silen 65 | finally: 66 | break # warning | ^^^^^ B012 -67 | +67 | 68 | def j(): | @@ -63,7 +63,7 @@ B012.py:78:13: B012 `continue` inside `finally` blocks cause exceptions to be si 77 | finally: 78 | continue # warning | ^^^^^^^^ B012 -79 | +79 | 80 | def j(): | @@ -81,7 +81,7 @@ B012.py:101:9: B012 `continue` inside `finally` blocks cause exceptions to be si 100 | finally: 101 | continue # warning | ^^^^^^^^ B012 -102 | +102 | 103 | while True: | @@ -100,5 +100,3 @@ B012.py:118:17: B012 `break` inside `finally` blocks cause exceptions to be sile 118 | break # warning | ^^^^^ B012 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B013_B013.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B013_B013.py.snap index 658dfd3c7a7c0..8dd06047185fc 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B013_B013.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B013_B013.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B013.py:5:8: B013 [*] A length-one tuple literal is redundant in exception handlers | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B014_B014.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B014_B014.py.snap index c35fb2494dcd8..e925e864231ef 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B014_B014.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B014_B014.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B014.py:17:8: B014 [*] Exception handler with duplicate exception: `OSError` | @@ -101,5 +102,3 @@ B014.py:89:7: B014 [*] Exception handler with duplicate exception: `re.error` 89 |-except(re.error, re.error): 89 |+except re.error: 90 90 | p - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.ipynb.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.ipynb.snap index acdae1edf4f29..96eba32108f52 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.ipynb.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.ipynb.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B015.ipynb:5:1: B015 Pointless comparison. Did you mean to assign a value? Otherwise, prepend `assert` or remove it. | @@ -30,5 +31,3 @@ B015.ipynb:13:1: B015 Pointless comparison. Did you mean to assign a value? Othe 14 | # Comments, newlines and whitespace 15 | x == 1 # comment | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.py.snap index 73529071e6797..1fe419d2fd6d6 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B015_B015.py.snap @@ -1,21 +1,20 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs -assertion_line: 74 --- B015.py:3:1: B015 Pointless comparison. Did you mean to assign a value? Otherwise, prepend `assert` or remove it. | 1 | assert 1 == 1 -2 | +2 | 3 | 1 == 1 | ^^^^^^ B015 -4 | +4 | 5 | assert 1 in (1, 2) | B015.py:7:1: B015 Pointless comparison. Did you mean to assign a value? Otherwise, prepend `assert` or remove it. | 5 | assert 1 in (1, 2) -6 | +6 | 7 | 1 in (1, 2) | ^^^^^^^^^^^ B015 | @@ -23,7 +22,7 @@ B015.py:7:1: B015 Pointless comparison. Did you mean to assign a value? Otherwis B015.py:17:5: B015 Pointless comparison at end of function scope. Did you mean to return the expression result? | 15 | assert 1 in (1, 2) -16 | +16 | 17 | 1 in (1, 2) | ^^^^^^^^^^^ B015 | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B016_B016.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B016_B016.py.snap index e0183b0a65ea0..1a999923dbb57 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B016_B016.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B016_B016.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B016.py:6:7: B016 Cannot raise a literal. Did you intend to return it or raise an Exception? | 4 | """ -5 | +5 | 6 | raise False | ^^^^^ B016 7 | raise 1 @@ -29,5 +29,3 @@ B016.py:8:7: B016 Cannot raise a literal. Did you intend to return it or raise a 9 | raise Exception(False) 10 | raise Exception(1) | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B017_B017.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B017_B017.py.snap index 1d4ac20d75a6f..bbee0c1d9158c 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B017_B017.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B017_B017.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs --- -B017.py:23:14: B017 `assertRaises(Exception)` should be considered evil +B017.py:23:14: B017 Do not assert blind exception: `Exception` | 21 | class Foobar(unittest.TestCase): 22 | def evil_raises(self) -> None: @@ -10,7 +10,7 @@ B017.py:23:14: B017 `assertRaises(Exception)` should be considered evil 24 | raise Exception("Evil I say!") | -B017.py:27:14: B017 `assertRaises(BaseException)` should be considered evil +B017.py:27:14: B017 Do not assert blind exception: `BaseException` | 26 | def also_evil_raises(self) -> None: 27 | with self.assertRaises(BaseException): @@ -18,7 +18,7 @@ B017.py:27:14: B017 `assertRaises(BaseException)` should be considered evil 28 | raise Exception("Evil I say!") | -B017.py:45:10: B017 `pytest.raises(Exception)` should be considered evil +B017.py:45:10: B017 Do not assert blind exception: `Exception` | 44 | def test_pytest_raises(): 45 | with pytest.raises(Exception): @@ -26,19 +26,19 @@ B017.py:45:10: B017 `pytest.raises(Exception)` should be considered evil 46 | raise ValueError("Hello") | -B017.py:48:10: B017 `pytest.raises(Exception)` should be considered evil +B017.py:48:10: B017 Do not assert blind exception: `Exception` | 46 | raise ValueError("Hello") -47 | +47 | 48 | with pytest.raises(Exception), pytest.raises(ValueError): | ^^^^^^^^^^^^^^^^^^^^^^^^ B017 49 | raise ValueError("Hello") | -B017.py:57:36: B017 `pytest.raises(Exception)` should be considered evil +B017.py:57:36: B017 Do not assert blind exception: `Exception` | 55 | raise ValueError("This is also fine") -56 | +56 | 57 | with contextlib.nullcontext(), pytest.raises(Exception): | ^^^^^^^^^^^^^^^^^^^^^^^^ B017 58 | raise ValueError("Multiple context managers") diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.ipynb.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.ipynb.snap index 41211ffcaef49..d06676c198ff2 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.ipynb.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.ipynb.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B018.ipynb:5:1: B018 Found useless expression. Either assign it to a variable or remove it. | @@ -30,5 +31,3 @@ B018.ipynb:13:1: B018 Found useless expression. Either assign it to a variable o 14 | # Comments, newlines and whitespace 15 | x # comment | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.py.snap index a3cded1d21458..d455292d9369f 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B018_B018.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B018.py:11:5: B018 Found useless expression. Either assign it to a variable or remove it. | @@ -254,5 +255,3 @@ B018.py:65:5: B018 Found useless expression. Either assign it to a variable or r 65 | "foo" + "bar" # BinOp (raise) | ^^^^^^^^^^^^^ B018 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B019_B019.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B019_B019.py.snap index 907178352a1ad..dfba309de447e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B019_B019.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B019_B019.py.snap @@ -13,7 +13,7 @@ B019.py:78:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:82:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 80 | ... -81 | +81 | 82 | @cache | ^^^^^^ B019 83 | def another_cached_instance_method(self, y): @@ -23,7 +23,7 @@ B019.py:82:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:86:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 84 | ... -85 | +85 | 86 | @functools.cache() | ^^^^^^^^^^^^^^^^^^ B019 87 | def called_cached_instance_method(self, y): @@ -33,7 +33,7 @@ B019.py:86:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:90:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 88 | ... -89 | +89 | 90 | @cache() | ^^^^^^^^ B019 91 | def another_called_cached_instance_method(self, y): @@ -43,7 +43,7 @@ B019.py:90:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:94:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 92 | ... -93 | +93 | 94 | @functools.lru_cache | ^^^^^^^^^^^^^^^^^^^^ B019 95 | def lru_cached_instance_method(self, y): @@ -53,7 +53,7 @@ B019.py:94:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:98:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 96 | ... - 97 | + 97 | 98 | @lru_cache | ^^^^^^^^^^ B019 99 | def another_lru_cached_instance_method(self, y): @@ -63,7 +63,7 @@ B019.py:98:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:102:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 100 | ... -101 | +101 | 102 | @functools.lru_cache() | ^^^^^^^^^^^^^^^^^^^^^^ B019 103 | def called_lru_cached_instance_method(self, y): @@ -73,7 +73,7 @@ B019.py:102:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods B019.py:106:5: B019 Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks | 104 | ... -105 | +105 | 106 | @lru_cache() | ^^^^^^^^^^^^ B019 107 | def another_called_lru_cached_instance_method(self, y): diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B020_B020.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B020_B020.py.snap index ceedf56d97d11..b734156c7292e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B020_B020.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B020_B020.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B020.py:8:5: B020 Loop control variable `items` overrides iterable it iterates | 6 | items = [1, 2, 3] -7 | +7 | 8 | for items in items: | ^^^^^ B020 9 | print(items) @@ -13,7 +13,7 @@ B020.py:8:5: B020 Loop control variable `items` overrides iterable it iterates B020.py:21:10: B020 Loop control variable `values` overrides iterable it iterates | 19 | print(f"{key}, {value}") -20 | +20 | 21 | for key, values in values.items(): | ^^^^^^ B020 22 | print(f"{key}, {values}") @@ -26,5 +26,3 @@ B020.py:36:5: B020 Loop control variable `vars` overrides iterable it iterates | ^^^^ B020 37 | print(vars) | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B021_B021.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B021_B021.py.snap index 55429a975994d..32c3200f25b90 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B021_B021.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B021_B021.py.snap @@ -8,7 +8,7 @@ B021.py:1:1: B021 f-string used as docstring. Python will interpret this as a jo 3 | | B021 - on lines 14, 22, 30, 38, 46, 54, 62, 70, 73 4 | | """ | |___^ B021 -5 | +5 | 6 | VARIABLE = "world" | @@ -76,5 +76,3 @@ B021.py:74:5: B021 f-string used as docstring. Python will interpret this as a j 75 | print(f"""I'm a normal string""") 76 | f"""Don't detect me!""" | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B022_B022.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B022_B022.py.snap index a24c945eed5cc..d5b49021397a6 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B022_B022.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B022_B022.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B022.py:9:6: B022 No arguments passed to `contextlib.suppress`. No exceptions will be suppressed and therefore this context manager is redundant | 7 | from contextlib import suppress - 8 | + 8 | 9 | with contextlib.suppress(): | ^^^^^^^^^^^^^^^^^^^^^ B022 10 | raise ValueError @@ -13,10 +13,8 @@ B022.py:9:6: B022 No arguments passed to `contextlib.suppress`. No exceptions wi B022.py:12:6: B022 No arguments passed to `contextlib.suppress`. No exceptions will be suppressed and therefore this context manager is redundant | 10 | raise ValueError -11 | +11 | 12 | with suppress(): | ^^^^^^^^^^ B022 13 | raise ValueError | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B023_B023.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B023_B023.py.snap index b9a759b2d8e31..0ee9c539387dc 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B023_B023.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B023_B023.py.snap @@ -16,7 +16,7 @@ B023.py:13:30: B023 Function definition does not bind loop variable `y` 12 | functions.append(lambda: x) 13 | functions.append(lambda: y) # not just the loop var | ^ B023 -14 | +14 | 15 | def f_bad_1(): | @@ -25,7 +25,7 @@ B023.py:16:16: B023 Function definition does not bind loop variable `x` 15 | def f_bad_1(): 16 | return x | ^ B023 -17 | +17 | 18 | # Actually OK | @@ -71,14 +71,14 @@ B023.py:40:34: B023 Function definition does not bind loop variable `x` 39 | async for x in pointless_async_iterable(): 40 | functions.append(lambda: x) # error | ^ B023 -41 | +41 | 42 | [lambda: x async for x in pointless_async_iterable()] # error | B023.py:42:14: B023 Function definition does not bind loop variable `x` | 40 | functions.append(lambda: x) # error -41 | +41 | 42 | [lambda: x async for x in pointless_async_iterable()] # error | ^ B023 | @@ -145,7 +145,7 @@ B023.py:68:10: B023 Function definition does not bind loop variable `l` 67 | j = None # OK because it's an assignment 68 | [l for k in range(2)] # error for l, not for k | ^ B023 -69 | +69 | 70 | assert a and functions | @@ -201,7 +201,7 @@ B023.py:121:37: B023 Function definition does not bind loop variable `x` 120 | list(filter(bool, [None, lambda: x])) 121 | all(reduce(bool, [None, lambda: x])) | ^ B023 -122 | +122 | 123 | # But all these should be OK: | @@ -210,7 +210,7 @@ B023.py:171:29: B023 Function definition does not bind loop variable `name` 170 | if foo(name): 171 | return [lambda: name] # known false alarm | ^^^^ B023 -172 | +172 | 173 | if False: | @@ -220,5 +220,3 @@ B023.py:174:29: B023 Function definition does not bind loop variable `i` 174 | return [lambda: i for i in range(3)] # error | ^ B023 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B024_B024.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B024_B024.py.snap index 5f29c87bee74b..fb1957dd24bf6 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B024_B024.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B024_B024.py.snap @@ -1,7 +1,8 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- -B024.py:18:7: B024 `Base_1` is an abstract base class, but it has no abstract methods +B024.py:18:7: B024 `Base_1` is an abstract base class, but it has no abstract methods or properties | 18 | class Base_1(ABC): # error | ^^^^^^ B024 @@ -9,7 +10,7 @@ B024.py:18:7: B024 `Base_1` is an abstract base class, but it has no abstract me 20 | foo() | -B024.py:71:7: B024 `MetaBase_1` is an abstract base class, but it has no abstract methods +B024.py:71:7: B024 `MetaBase_1` is an abstract base class, but it has no abstract methods or properties | 71 | class MetaBase_1(metaclass=ABCMeta): # error | ^^^^^^^^^^ B024 @@ -17,7 +18,7 @@ B024.py:71:7: B024 `MetaBase_1` is an abstract base class, but it has no abstrac 73 | foo() | -B024.py:82:7: B024 `abc_Base_1` is an abstract base class, but it has no abstract methods +B024.py:82:7: B024 `abc_Base_1` is an abstract base class, but it has no abstract methods or properties | 82 | class abc_Base_1(abc.ABC): # error | ^^^^^^^^^^ B024 @@ -25,7 +26,7 @@ B024.py:82:7: B024 `abc_Base_1` is an abstract base class, but it has no abstrac 84 | foo() | -B024.py:87:7: B024 `abc_Base_2` is an abstract base class, but it has no abstract methods +B024.py:87:7: B024 `abc_Base_2` is an abstract base class, but it has no abstract methods or properties | 87 | class abc_Base_2(metaclass=abc.ABCMeta): # error | ^^^^^^^^^^ B024 @@ -33,7 +34,7 @@ B024.py:87:7: B024 `abc_Base_2` is an abstract base class, but it has no abstrac 89 | foo() | -B024.py:92:7: B024 `notabc_Base_1` is an abstract base class, but it has no abstract methods +B024.py:92:7: B024 `notabc_Base_1` is an abstract base class, but it has no abstract methods or properties | 92 | class notabc_Base_1(notabc.ABC): # error | ^^^^^^^^^^^^^ B024 @@ -41,21 +42,21 @@ B024.py:92:7: B024 `notabc_Base_1` is an abstract base class, but it has no abst 94 | foo() | -B024.py:132:7: B024 `abc_set_class_variable_2` is an abstract base class, but it has no abstract methods +B024.py:132:7: B024 `abc_set_class_variable_2` is an abstract base class, but it has no abstract methods or properties | 132 | class abc_set_class_variable_2(ABC): # error (not an abstract attribute) | ^^^^^^^^^^^^^^^^^^^^^^^^ B024 133 | foo = 2 | -B024.py:136:7: B024 `abc_set_class_variable_3` is an abstract base class, but it has no abstract methods +B024.py:136:7: B024 `abc_set_class_variable_3` is an abstract base class, but it has no abstract methods or properties | 136 | class abc_set_class_variable_3(ABC): # error (not an abstract attribute) | ^^^^^^^^^^^^^^^^^^^^^^^^ B024 137 | foo: int = 2 | -B024.py:141:7: B024 `abc_set_class_variable_4` is an abstract base class, but it has no abstract methods +B024.py:141:7: B024 `abc_set_class_variable_4` is an abstract base class, but it has no abstract methods or properties | 140 | # this doesn't actually declare a class variable, it's just an expression 141 | class abc_set_class_variable_4(ABC): # error diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B025_B025.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B025_B025.py.snap index 238ea4893dee0..117f480fc15da 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B025_B025.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B025_B025.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B025.py:19:8: B025 try-except block with duplicate exception `ValueError` | @@ -38,4 +39,39 @@ B025.py:37:18: B025 try-except block with duplicate exception `TypeError` 38 | a = 2 | +B025.py:44:9: B025 try-except* block with duplicate exception `ValueError` + | +42 | except* ValueError: +43 | a = 2 +44 | except* ValueError: + | ^^^^^^^^^^ B025 +45 | a = 2 + | + +B025.py:53:9: B025 try-except* block with duplicate exception `pickle.PickleError` + | +51 | except* ValueError: +52 | a = 2 +53 | except* pickle.PickleError: + | ^^^^^^^^^^^^^^^^^^ B025 +54 | a = 2 + | +B025.py:60:9: B025 try-except* block with duplicate exception `ValueError` + | +58 | except* (ValueError, TypeError): +59 | a = 2 +60 | except* ValueError: + | ^^^^^^^^^^ B025 +61 | a = 2 +62 | except* (OSError, TypeError): + | + +B025.py:62:19: B025 try-except* block with duplicate exception `TypeError` + | +60 | except* ValueError: +61 | a = 2 +62 | except* (OSError, TypeError): + | ^^^^^^^^^ B025 +63 | a = 2 + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B026_B026.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B026_B026.py.snap index 272c3f749e797..f0cae8d0216fc 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B026_B026.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B026_B026.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B026.py:16:16: B026 Star-arg unpacking after a keyword argument is strongly discouraged | @@ -66,5 +67,3 @@ B026.py:21:26: B026 Star-arg unpacking after a keyword argument is strongly disc 21 | foo(*["bar"], bam="bam", *["baz"]) | ^^^^^^^^ B026 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.py.snap index b3da6237def01..371a87144bbd2 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.py.snap @@ -4,53 +4,47 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B027.py:18:5: B027 `AbstractClass.empty_1` is an empty method in an abstract base class, but has no abstract decorator | 17 | class AbstractClass(ABC): -18 | def empty_1(self): # error - | _____^ +18 | / def empty_1(self): # error 19 | | ... | |___________^ B027 -20 | +20 | 21 | def empty_2(self): # error | B027.py:21:5: B027 `AbstractClass.empty_2` is an empty method in an abstract base class, but has no abstract decorator | 19 | ... -20 | -21 | def empty_2(self): # error - | _____^ +20 | +21 | / def empty_2(self): # error 22 | | pass | |____________^ B027 -23 | +23 | 24 | def empty_3(self): # error | B027.py:24:5: B027 `AbstractClass.empty_3` is an empty method in an abstract base class, but has no abstract decorator | 22 | pass -23 | -24 | def empty_3(self): # error - | _____^ +23 | +24 | / def empty_3(self): # error 25 | | """docstring""" 26 | | ... | |___________^ B027 -27 | +27 | 28 | def empty_4(self): # error | B027.py:28:5: B027 `AbstractClass.empty_4` is an empty method in an abstract base class, but has no abstract decorator | 26 | ... -27 | -28 | def empty_4(self): # error - | _____^ +27 | +28 | / def empty_4(self): # error 29 | | """multiple ellipsis/pass""" 30 | | ... 31 | | pass 32 | | ... 33 | | pass | |____________^ B027 -34 | +34 | 35 | @notabstract | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.pyi.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.pyi.snap index 967e60a4f9e9a..30ef2c1efd4af 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B027_B027.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B028_B028.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B028_B028.py.snap index 2b89da03fe765..db323efe66afb 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B028_B028.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B028_B028.py.snap @@ -1,23 +1,86 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs --- -B028.py:8:1: B028 No explicit `stacklevel` keyword argument found +B028.py:8:1: B028 [*] No explicit `stacklevel` keyword argument found | 6 | """ - 7 | - 8 | warnings.warn(DeprecationWarning("test")) + 7 | + 8 | warnings.warn("test", DeprecationWarning) | ^^^^^^^^^^^^^ B028 - 9 | warnings.warn(DeprecationWarning("test"), source=None) -10 | warnings.warn(DeprecationWarning("test"), source=None, stacklevel=2) + 9 | warnings.warn("test", DeprecationWarning, source=None) +10 | warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) | + = help: Set `stacklevel=2` -B028.py:9:1: B028 No explicit `stacklevel` keyword argument found +ℹ Unsafe fix +5 5 | B028 - on lines 8 and 9 +6 6 | """ +7 7 | +8 |-warnings.warn("test", DeprecationWarning) + 8 |+warnings.warn("test", DeprecationWarning, stacklevel=2) +9 9 | warnings.warn("test", DeprecationWarning, source=None) +10 10 | warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) +11 11 | warnings.warn("test", DeprecationWarning, stacklevel=1) + +B028.py:9:1: B028 [*] No explicit `stacklevel` keyword argument found + | + 8 | warnings.warn("test", DeprecationWarning) + 9 | warnings.warn("test", DeprecationWarning, source=None) + | ^^^^^^^^^^^^^ B028 +10 | warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) +11 | warnings.warn("test", DeprecationWarning, stacklevel=1) + | + = help: Set `stacklevel=2` + +ℹ Unsafe fix +6 6 | """ +7 7 | +8 8 | warnings.warn("test", DeprecationWarning) +9 |-warnings.warn("test", DeprecationWarning, source=None) +10 9 | warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) + 10 |+warnings.warn("test", DeprecationWarning, source=None, stacklevel=2) +11 11 | warnings.warn("test", DeprecationWarning, stacklevel=1) +12 12 | warnings.warn("test", DeprecationWarning, 1) +13 13 | warnings.warn("test", category=DeprecationWarning, stacklevel=1) + +B028.py:22:1: B028 [*] No explicit `stacklevel` keyword argument found | - 8 | warnings.warn(DeprecationWarning("test")) - 9 | warnings.warn(DeprecationWarning("test"), source=None) +20 | warnings.warn(*args, **kwargs) +21 | +22 | warnings.warn( | ^^^^^^^^^^^^^ B028 -10 | warnings.warn(DeprecationWarning("test"), source=None, stacklevel=2) -11 | warnings.warn(DeprecationWarning("test"), stacklevel=1) +23 | "test", +24 | DeprecationWarning, | + = help: Set `stacklevel=2` + +ℹ Unsafe fix +23 23 | "test", +24 24 | DeprecationWarning, +25 25 | # some comments here +26 |- source = None # no trailing comma + 26 |+ source = None, stacklevel=2 # no trailing comma +27 27 | ) +28 28 | +29 29 | # https://github.com/astral-sh/ruff/issues/18011 +B028.py:32:1: B028 [*] No explicit `stacklevel` keyword argument found + | +30 | warnings.warn("test", skip_file_prefixes=(os.path.dirname(__file__),)) +31 | # trigger diagnostic if `skip_file_prefixes` is present and set to the default value +32 | warnings.warn("test", skip_file_prefixes=()) + | ^^^^^^^^^^^^^ B028 +33 | +34 | _my_prefixes = ("this","that") + | + = help: Set `stacklevel=2` +ℹ Unsafe fix +29 29 | # https://github.com/astral-sh/ruff/issues/18011 +30 30 | warnings.warn("test", skip_file_prefixes=(os.path.dirname(__file__),)) +31 31 | # trigger diagnostic if `skip_file_prefixes` is present and set to the default value +32 |-warnings.warn("test", skip_file_prefixes=()) + 32 |+warnings.warn("test", skip_file_prefixes=(), stacklevel=2) +33 33 | +34 34 | _my_prefixes = ("this","that") +35 35 | warnings.warn("test", skip_file_prefixes = _my_prefixes) diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B029_B029.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B029_B029.py.snap index 8c469dd4187b9..776d2e3882d67 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B029_B029.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B029_B029.py.snap @@ -8,7 +8,7 @@ B029.py:8:1: B029 Using `except ():` with an empty tuple does not catch anything 8 | / except (): 9 | | pass | |________^ B029 -10 | +10 | 11 | try: | @@ -19,6 +19,26 @@ B029.py:13:1: B029 Using `except ():` with an empty tuple does not catch anythin 13 | / except () as e: 14 | | pass | |________^ B029 +15 | +16 | try: | +B029.py:18:1: B029 Using `except* ():` with an empty tuple does not catch anything; add exceptions to handle + | +16 | try: +17 | pass +18 | / except* (): +19 | | pass + | |________^ B029 +20 | +21 | try: + | +B029.py:23:1: B029 Using `except* ():` with an empty tuple does not catch anything; add exceptions to handle + | +21 | try: +22 | pass +23 | / except* () as e: +24 | | pass + | |________^ B029 + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B030_B030.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B030_B030.py.snap index 6606e05ad0427..c105eb23a028e 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B030_B030.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B030_B030.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B030.py:12:8: B030 `except` handlers should only be exception classes or tuples of exception classes | @@ -46,7 +47,7 @@ B030.py:33:29: B030 `except` handlers should only be exception classes or tuples 34 | pass | -B030.py:39:28: B030 `except` handlers should only be exception classes or tuples of exception classes +B030.py:39:28: B030 `except*` handlers should only be exception classes or tuples of exception classes | 37 | try: 38 | pass @@ -63,3 +64,39 @@ B030.py:131:8: B030 `except` handlers should only be exception classes or tuples | ^^^^^^^^^^^^^^^ B030 132 | pass | + +B030.py:136:9: B030 `except*` handlers should only be exception classes or tuples of exception classes + | +134 | try: +135 | pass +136 | except* 1: # Error + | ^ B030 +137 | pass + | + +B030.py:141:10: B030 `except*` handlers should only be exception classes or tuples of exception classes + | +139 | try: +140 | pass +141 | except* (1, ValueError): # Error + | ^ B030 +142 | pass + | + +B030.py:146:22: B030 `except*` handlers should only be exception classes or tuples of exception classes + | +144 | try: +145 | pass +146 | except* (ValueError, (RuntimeError, (KeyError, TypeError))): # Error + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B030 +147 | pass + | + +B030.py:151:9: B030 `except*` handlers should only be exception classes or tuples of exception classes + | +149 | try: +150 | pass +151 | except* (a, b) * (c, d): # B030 + | ^^^^^^^^^^^^^^^ B030 +152 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B031_B031.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B031_B031.py.snap index 075bffbe6cae7..b13db50fcda64 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B031_B031.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B031_B031.py.snap @@ -17,7 +17,7 @@ B031.py:29:33: B031 Using the generator returned from `itertools.groupby()` more 28 | # We're outside the nested loop and used the group again. 29 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -30 | +30 | 31 | for _section, section_items in groupby(items, key=lambda p: p[1]): | @@ -44,7 +44,7 @@ B031.py:46:29: B031 Using the generator returned from `itertools.groupby()` more 45 | for _section, section_items in groupby(items, key=lambda p: p[1]): 46 | collection.append([list(section_items) for _ in range(3)]) # B031 | ^^^^^^^^^^^^^ B031 -47 | +47 | 48 | unique_items = set() | @@ -62,7 +62,7 @@ B031.py:79:37: B031 Using the generator returned from `itertools.groupby()` more 78 | for shopper in shoppers: 79 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -80 | +80 | 81 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): | @@ -71,7 +71,7 @@ B031.py:82:38: B031 Using the generator returned from `itertools.groupby()` more 81 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): 82 | _ = [collect_shop_items(shopper, section_items) for shopper in shoppers] # B031 | ^^^^^^^^^^^^^ B031 -83 | +83 | 84 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): | @@ -81,7 +81,7 @@ B031.py:94:65: B031 Using the generator returned from `itertools.groupby()` more 93 | # The iterator is being used for the second time. 94 | _ = [(item1, item2) for item1 in section_items for item2 in section_items] # B031 | ^^^^^^^^^^^^^ B031 -95 | +95 | 96 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): | @@ -91,7 +91,7 @@ B031.py:101:37: B031 Using the generator returned from `itertools.groupby()` mor 100 | collect_shop_items(shopper, section_items) 101 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -102 | +102 | 103 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): | @@ -151,7 +151,7 @@ B031.py:126:33: B031 Using the generator returned from `itertools.groupby()` mor 125 | # Now, it should detect 126 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -127 | +127 | 128 | for _section, section_items in itertools.groupby(items, key=lambda p: p[1]): | @@ -191,7 +191,7 @@ B031.py:144:33: B031 Using the generator returned from `itertools.groupby()` mor 143 | # Now, it should detect 144 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -145 | +145 | 146 | for group in groupby(items, key=lambda p: p[1]): | @@ -210,7 +210,7 @@ B031.py:210:37: B031 Using the generator returned from `itertools.groupby()` mor 209 | collect_shop_items(shopper, section_items) 210 | collect_shop_items(shopper, section_items) | ^^^^^^^^^^^^^ B031 -211 | +211 | 212 | # Should trigger, since only one branch has a return statement. | @@ -220,6 +220,6 @@ B031.py:219:33: B031 Using the generator returned from `itertools.groupby()` mor 218 | collect_shop_items(shopper, section_items) 219 | collect_shop_items(shopper, section_items) # B031 | ^^^^^^^^^^^^^ B031 -220 | +220 | 221 | # Let's redefine the `groupby` function to make sure we pick up the correct one. | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B032_B032.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B032_B032.py.snap index a55e9006fad03..dd53337080261 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B032_B032.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B032_B032.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs B032.py:9:1: B032 Possible unintentional type annotation (using `:`). Did you mean to assign (using `=`)? | 7 | dct = {"a": 1} - 8 | + 8 | 9 | dct["b"]: 2 | ^^^^^^^^^^^ B032 10 | dct.b: 2 @@ -15,14 +15,14 @@ B032.py:10:1: B032 Possible unintentional type annotation (using `:`). Did you m 9 | dct["b"]: 2 10 | dct.b: 2 | ^^^^^^^^ B032 -11 | +11 | 12 | dct["b"]: "test" | B032.py:12:1: B032 Possible unintentional type annotation (using `:`). Did you mean to assign (using `=`)? | 10 | dct.b: 2 -11 | +11 | 12 | dct["b"]: "test" | ^^^^^^^^^^^^^^^^ B032 13 | dct.b: "test" @@ -33,7 +33,7 @@ B032.py:13:1: B032 Possible unintentional type annotation (using `:`). Did you m 12 | dct["b"]: "test" 13 | dct.b: "test" | ^^^^^^^^^^^^^ B032 -14 | +14 | 15 | test = "test" | @@ -71,8 +71,6 @@ B032.py:19:1: B032 Possible unintentional type annotation (using `:`). Did you m 18 | dct.b: test 19 | dct.b: test.lower() | ^^^^^^^^^^^^^^^^^^^ B032 -20 | +20 | 21 | # Do not flag below | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B033_B033.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B033_B033.py.snap index 6d468e2683cd3..d04d48aa93da9 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B033_B033.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B033_B033.py.snap @@ -154,6 +154,7 @@ B033.py:20:5: B033 [*] Sets should not contain duplicate item `1` 20 | 1, | ^ B033 21 | } +22 | incorrect_set = {False, 1, 0} | = help: Remove duplicate item @@ -163,7 +164,26 @@ B033.py:20:5: B033 [*] Sets should not contain duplicate item `1` 19 19 | 1, 20 |- 1, 21 20 | } -22 21 | -23 22 | ### +22 21 | incorrect_set = {False, 1, 0} +23 22 | +B033.py:22:28: B033 [*] Sets should not contain duplicate items, but `False` and `0` has the same value + | +20 | 1, +21 | } +22 | incorrect_set = {False, 1, 0} + | ^ B033 +23 | +24 | ### + | + = help: Remove duplicate item +ℹ Safe fix +19 19 | 1, +20 20 | 1, +21 21 | } +22 |-incorrect_set = {False, 1, 0} + 22 |+incorrect_set = {False, 1} +23 23 | +24 24 | ### +25 25 | # Non-errors. diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B034_B034.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B034_B034.py.snap index 92631d1ed858b..c92b98b7d5c79 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B034_B034.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B034_B034.py.snap @@ -95,8 +95,6 @@ B034.py:14:1: B034 `re.sub` should pass `count` and `flags` as keyword arguments 13 | re.split(" ", "a a a a", 2, re.I) 14 | sub("a", "b", "aaa", re.IGNORECASE) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B034 -15 | +15 | 16 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B035_B035.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B035_B035.py.snap index 2991c2e0d5bbe..dd3e1696392c7 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B035_B035.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B035_B035.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B035.py:17:2: B035 Dictionary comprehension uses static key: `"key"` | @@ -86,5 +87,3 @@ B035.py:25:2: B035 Dictionary comprehension uses static key: `tokens` 25 | {tokens: token for token in tokens} | ^^^^^^ B035 | - - diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B039_B039.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B039_B039.py.snap index e2bbb851aa3c8..8b7b9add10f4f 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B039_B039.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B039_B039.py.snap @@ -1,127 +1,149 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs --- -B039.py:19:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:21:26: B039 Do not use mutable data structures for `ContextVar` defaults | -18 | # Bad -19 | ContextVar("cv", default=[]) +20 | # Bad +21 | ContextVar("cv", default=[]) | ^^ B039 -20 | ContextVar("cv", default={}) -21 | ContextVar("cv", default=list()) +22 | ContextVar("cv", default={}) +23 | ContextVar("cv", default=list()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:20:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:22:26: B039 Do not use mutable data structures for `ContextVar` defaults | -18 | # Bad -19 | ContextVar("cv", default=[]) -20 | ContextVar("cv", default={}) +20 | # Bad +21 | ContextVar("cv", default=[]) +22 | ContextVar("cv", default={}) | ^^ B039 -21 | ContextVar("cv", default=list()) -22 | ContextVar("cv", default=set()) +23 | ContextVar("cv", default=list()) +24 | ContextVar("cv", default=set()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:21:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:23:26: B039 Do not use mutable data structures for `ContextVar` defaults | -19 | ContextVar("cv", default=[]) -20 | ContextVar("cv", default={}) -21 | ContextVar("cv", default=list()) +21 | ContextVar("cv", default=[]) +22 | ContextVar("cv", default={}) +23 | ContextVar("cv", default=list()) | ^^^^^^ B039 -22 | ContextVar("cv", default=set()) -23 | ContextVar("cv", default=dict()) +24 | ContextVar("cv", default=set()) +25 | ContextVar("cv", default=dict()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:22:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:24:26: B039 Do not use mutable data structures for `ContextVar` defaults | -20 | ContextVar("cv", default={}) -21 | ContextVar("cv", default=list()) -22 | ContextVar("cv", default=set()) +22 | ContextVar("cv", default={}) +23 | ContextVar("cv", default=list()) +24 | ContextVar("cv", default=set()) | ^^^^^ B039 -23 | ContextVar("cv", default=dict()) -24 | ContextVar("cv", default=[char for char in "foo"]) +25 | ContextVar("cv", default=dict()) +26 | ContextVar("cv", default=[char for char in "foo"]) | = help: Replace with `None`; initialize with `.set()`` -B039.py:23:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:25:26: B039 Do not use mutable data structures for `ContextVar` defaults | -21 | ContextVar("cv", default=list()) -22 | ContextVar("cv", default=set()) -23 | ContextVar("cv", default=dict()) +23 | ContextVar("cv", default=list()) +24 | ContextVar("cv", default=set()) +25 | ContextVar("cv", default=dict()) | ^^^^^^ B039 -24 | ContextVar("cv", default=[char for char in "foo"]) -25 | ContextVar("cv", default={char for char in "foo"}) +26 | ContextVar("cv", default=[char for char in "foo"]) +27 | ContextVar("cv", default={char for char in "foo"}) | = help: Replace with `None`; initialize with `.set()`` -B039.py:24:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:26:26: B039 Do not use mutable data structures for `ContextVar` defaults | -22 | ContextVar("cv", default=set()) -23 | ContextVar("cv", default=dict()) -24 | ContextVar("cv", default=[char for char in "foo"]) +24 | ContextVar("cv", default=set()) +25 | ContextVar("cv", default=dict()) +26 | ContextVar("cv", default=[char for char in "foo"]) | ^^^^^^^^^^^^^^^^^^^^^^^^ B039 -25 | ContextVar("cv", default={char for char in "foo"}) -26 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) +27 | ContextVar("cv", default={char for char in "foo"}) +28 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) | = help: Replace with `None`; initialize with `.set()`` -B039.py:25:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:27:26: B039 Do not use mutable data structures for `ContextVar` defaults | -23 | ContextVar("cv", default=dict()) -24 | ContextVar("cv", default=[char for char in "foo"]) -25 | ContextVar("cv", default={char for char in "foo"}) +25 | ContextVar("cv", default=dict()) +26 | ContextVar("cv", default=[char for char in "foo"]) +27 | ContextVar("cv", default={char for char in "foo"}) | ^^^^^^^^^^^^^^^^^^^^^^^^ B039 -26 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) -27 | ContextVar("cv", default=collections.deque()) +28 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) +29 | ContextVar("cv", default=collections.deque()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:26:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:28:26: B039 Do not use mutable data structures for `ContextVar` defaults | -24 | ContextVar("cv", default=[char for char in "foo"]) -25 | ContextVar("cv", default={char for char in "foo"}) -26 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) +26 | ContextVar("cv", default=[char for char in "foo"]) +27 | ContextVar("cv", default={char for char in "foo"}) +28 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B039 -27 | ContextVar("cv", default=collections.deque()) +29 | ContextVar("cv", default=collections.deque()) +30 | ContextVar("cv", default=set[str]()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:27:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:29:26: B039 Do not use mutable data structures for `ContextVar` defaults | -25 | ContextVar("cv", default={char for char in "foo"}) -26 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) -27 | ContextVar("cv", default=collections.deque()) +27 | ContextVar("cv", default={char for char in "foo"}) +28 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) +29 | ContextVar("cv", default=collections.deque()) | ^^^^^^^^^^^^^^^^^^^ B039 -28 | -29 | def bar() -> list[int]: +30 | ContextVar("cv", default=set[str]()) +31 | ContextVar[set[str]]("cv", default=set[str]()) + | + = help: Replace with `None`; initialize with `.set()`` + +B039.py:30:26: B039 Do not use mutable data structures for `ContextVar` defaults + | +28 | ContextVar("cv", default={char: idx for idx, char in enumerate("foo")}) +29 | ContextVar("cv", default=collections.deque()) +30 | ContextVar("cv", default=set[str]()) + | ^^^^^^^^^^ B039 +31 | ContextVar[set[str]]("cv", default=set[str]()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:32:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:31:36: B039 Do not use mutable data structures for `ContextVar` defaults | -30 | return [1, 2, 3] -31 | -32 | ContextVar("cv", default=bar()) +29 | ContextVar("cv", default=collections.deque()) +30 | ContextVar("cv", default=set[str]()) +31 | ContextVar[set[str]]("cv", default=set[str]()) + | ^^^^^^^^^^ B039 +32 | +33 | def bar() -> list[int]: + | + = help: Replace with `None`; initialize with `.set()`` + +B039.py:36:26: B039 Do not use mutable data structures for `ContextVar` defaults + | +34 | return [1, 2, 3] +35 | +36 | ContextVar("cv", default=bar()) | ^^^^^ B039 -33 | ContextVar("cv", default=time.time()) +37 | ContextVar("cv", default=time.time()) | = help: Replace with `None`; initialize with `.set()`` -B039.py:33:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:37:26: B039 Do not use mutable data structures for `ContextVar` defaults | -32 | ContextVar("cv", default=bar()) -33 | ContextVar("cv", default=time.time()) +36 | ContextVar("cv", default=bar()) +37 | ContextVar("cv", default=time.time()) | ^^^^^^^^^^^ B039 -34 | -35 | def baz(): ... +38 | +39 | def baz(): ... | = help: Replace with `None`; initialize with `.set()`` -B039.py:36:26: B039 Do not use mutable data structures for `ContextVar` defaults +B039.py:40:26: B039 Do not use mutable data structures for `ContextVar` defaults | -35 | def baz(): ... -36 | ContextVar("cv", default=baz()) +39 | def baz(): ... +40 | ContextVar("cv", default=baz()) | ^^^^^ B039 | = help: Replace with `None`; initialize with `.set()`` diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B901_B901.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B901_B901.py.snap index b1e65fb3c0ee2..8d98e5fcd4fe1 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B901_B901.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B901_B901.py.snap @@ -7,7 +7,7 @@ B901.py:9:9: B901 Using `yield` and `return {value}` in a generator function can 8 | if True: 9 | return [1, 2, 3] | ^^^^^^^^^^^^^^^^ B901 -10 | +10 | 11 | yield 3 | @@ -16,6 +16,6 @@ B901.py:36:5: B901 Using `yield` and `return {value}` in a generator function ca 35 | def broken2(): 36 | return [3, 2, 1] | ^^^^^^^^^^^^^^^^ B901 -37 | +37 | 38 | yield from not_broken() | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_class_as_data_structure.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_class_as_data_structure.py.snap new file mode 100644 index 0000000000000..961e89f613c78 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_class_as_data_structure.py.snap @@ -0,0 +1,80 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +--- +class_as_data_structure.py:6:1: B903 Class could be dataclass or namedtuple + | +6 | / class Point: # B903 +7 | | def __init__(self, x: float, y: float) -> None: +8 | | self.x = x +9 | | self.y = y + | |__________________^ B903 + | + +class_as_data_structure.py:40:1: B903 Class could be dataclass or namedtuple + | +38 | ... +39 | +40 | / class C: # B903 +41 | | c: int +42 | | def __init__(self,d:list): +43 | | self.d = d + | |__________________^ B903 +44 | +45 | class D: # B903 + | + +class_as_data_structure.py:45:1: B903 Class could be dataclass or namedtuple + | +43 | self.d = d +44 | +45 | / class D: # B903 +46 | | """This class has a docstring.""" +47 | | # this next method is an init +48 | | def __init__(self,e:dict): +49 | | self.e = e + | |__________________^ B903 +50 | +51 | # <--- begin flake8-bugbear tests below + | + +class_as_data_structure.py:63:1: B903 Class could be dataclass or namedtuple + | +63 | / class NoWarningsClassAttributes: +64 | | spam = "ham" +65 | | +66 | | def __init__(self, foo:int, bar:list): +67 | | self.foo = foo +68 | | self.bar = bar + | |______________________^ B903 + | + +class_as_data_structure.py:85:1: B903 Class could be dataclass or namedtuple + | +85 | / class Warnings: +86 | | def __init__(self, foo:int, bar:list): +87 | | self.foo = foo +88 | | self.bar = bar + | |______________________^ B903 + | + +class_as_data_structure.py:91:1: B903 Class could be dataclass or namedtuple + | +91 | / class WarningsWithDocstring: +92 | | """A docstring should not be an impediment to a warning""" +93 | | +94 | | def __init__(self, foo:int, bar:list): +95 | | self.foo = foo +96 | | self.bar = bar + | |______________________^ B903 + | + +class_as_data_structure.py:99:1: B903 Class could be dataclass or namedtuple + | + 99 | / class KeywordOnly: # OK with python3.9 or less, not OK starting python3.10 +100 | | def __init__(self, *, foo: int, bar: int): +101 | | self.foo = foo +102 | | self.bar = bar + | |______________________^ B903 +103 | +104 | # <-- end flake8-bugbear tests + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_py39_class_as_data_structure.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_py39_class_as_data_structure.py.snap new file mode 100644 index 0000000000000..d801e29068850 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B903_py39_class_as_data_structure.py.snap @@ -0,0 +1,69 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +--- +class_as_data_structure.py:6:1: B903 Class could be dataclass or namedtuple + | +6 | / class Point: # B903 +7 | | def __init__(self, x: float, y: float) -> None: +8 | | self.x = x +9 | | self.y = y + | |__________________^ B903 + | + +class_as_data_structure.py:40:1: B903 Class could be dataclass or namedtuple + | +38 | ... +39 | +40 | / class C: # B903 +41 | | c: int +42 | | def __init__(self,d:list): +43 | | self.d = d + | |__________________^ B903 +44 | +45 | class D: # B903 + | + +class_as_data_structure.py:45:1: B903 Class could be dataclass or namedtuple + | +43 | self.d = d +44 | +45 | / class D: # B903 +46 | | """This class has a docstring.""" +47 | | # this next method is an init +48 | | def __init__(self,e:dict): +49 | | self.e = e + | |__________________^ B903 +50 | +51 | # <--- begin flake8-bugbear tests below + | + +class_as_data_structure.py:63:1: B903 Class could be dataclass or namedtuple + | +63 | / class NoWarningsClassAttributes: +64 | | spam = "ham" +65 | | +66 | | def __init__(self, foo:int, bar:list): +67 | | self.foo = foo +68 | | self.bar = bar + | |______________________^ B903 + | + +class_as_data_structure.py:85:1: B903 Class could be dataclass or namedtuple + | +85 | / class Warnings: +86 | | def __init__(self, foo:int, bar:list): +87 | | self.foo = foo +88 | | self.bar = bar + | |______________________^ B903 + | + +class_as_data_structure.py:91:1: B903 Class could be dataclass or namedtuple + | +91 | / class WarningsWithDocstring: +92 | | """A docstring should not be an impediment to a warning""" +93 | | +94 | | def __init__(self, foo:int, bar:list): +95 | | self.foo = foo +96 | | self.bar = bar + | |______________________^ B903 + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B904_B904.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B904_B904.py.snap index 5e39344cb5250..1d7390ce045eb 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B904_B904.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B904_B904.py.snap @@ -65,6 +65,66 @@ B904.py:73:13: B904 Within an `except` clause, raise exceptions with `raise ... 72 | case 0: 73 | raise RuntimeError("boom!") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ B904 +74 | +75 | try: | +B904.py:79:9: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +77 | except* Exception as e: +78 | if ...: +79 | raise RuntimeError("boom!") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ B904 +80 | else: +81 | raise RuntimeError("bang!") + | + +B904.py:81:9: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +79 | raise RuntimeError("boom!") +80 | else: +81 | raise RuntimeError("bang!") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ B904 +82 | +83 | try: + | + +B904.py:87:9: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +85 | except* ValueError: +86 | if "abc": +87 | raise TypeError + | ^^^^^^^^^^^^^^^ B904 +88 | raise UserWarning +89 | except* AssertionError: + | +B904.py:88:5: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +86 | if "abc": +87 | raise TypeError +88 | raise UserWarning + | ^^^^^^^^^^^^^^^^^ B904 +89 | except* AssertionError: +90 | raise # Bare `raise` should not be an error + | + +B904.py:93:5: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +91 | except* Exception as err: +92 | assert err +93 | raise Exception("No cause here...") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B904 +94 | except* BaseException as err: +95 | raise err + | + +B904.py:97:5: B904 Within an `except*` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + | +95 | raise err +96 | except* BaseException as err: +97 | raise some_other_err + | ^^^^^^^^^^^^^^^^^^^^ B904 +98 | finally: +99 | raise Exception("Nothing to chain from, so no warning here") + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B905.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B905.py.snap index 66bde9f97f3ba..4628deaeeca45 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B905.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B905.py.snap @@ -131,7 +131,7 @@ B905.py:9:1: B905 [*] `zip()` without an explicit `strict=` parameter 8 | zip(zip("a"), strict=False) 9 | zip(zip("a", strict=True)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ B905 -10 | +10 | 11 | # OK | = help: Add explicit value for parameter `strict=` @@ -171,7 +171,7 @@ B905.py:25:1: B905 [*] `zip()` without an explicit `strict=` parameter 24 | zip([1, 2, 3], repeat(1, 1)) 25 | zip([1, 2, 3], repeat(1, times=4)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B905 -26 | +26 | 27 | import builtins | = help: Add explicit value for parameter `strict=` diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B909_B909.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B909_B909.py.snap index a7993b4b2b263..c7385dec29dea 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B909_B909.py.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B909_B909.py.snap @@ -96,7 +96,7 @@ B909.py:21:5: B909 Mutation to loop iterable `some_list` during iteration 20 | some_list.pop(1) 21 | some_list.pop() | ^^^^^^^^^^^^^ B909 -22 | +22 | 23 | # conditional break should error | @@ -135,7 +135,7 @@ B909.py:49:5: B909 Mutation to loop iterable `mydicts` during iteration 48 | mydicts.setdefault("foo", 1) 49 | mydicts.update({"foo": "bar"}) | ^^^^^^^^^^^^^^ B909 -50 | +50 | 51 | # no errors | @@ -194,7 +194,7 @@ B909.py:67:5: B909 Mutation to loop iterable `myset` during iteration 66 | myset.add(4) 67 | myset.discard(3) | ^^^^^^^^^^^^^ B909 -68 | +68 | 69 | # no errors | @@ -260,7 +260,7 @@ B909.py:97:5: B909 Mutation to loop iterable `foo` during iteration 96 | foo[1:2] = bar 97 | foo[1:2:3] = bar | ^^^^^^^^^^^^^^^^ B909 -98 | +98 | 99 | foo = {1, 2, 3} | @@ -317,7 +317,7 @@ B909.py:136:9: B909 Mutation to loop iterable `foo` during iteration 135 | else: 136 | foo.remove(1) | ^^^^^^^^^^ B909 -137 | +137 | 138 | # should error | @@ -365,7 +365,7 @@ B909.py:159:5: B909 Mutation to loop iterable `some_list` during iteration 158 | some_list.remove(elem) 159 | some_list.discard(elem) | ^^^^^^^^^^^^^^^^^ B909 -160 | +160 | 161 | # should not error | @@ -375,6 +375,6 @@ B909.py:167:5: B909 Mutation to loop iterable `some_list` during iteration 166 | for i, elem in enumerate(some_list): 167 | some_list.pop(0) | ^^^^^^^^^^^^^ B909 -168 | +168 | 169 | # should not error (list) | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B911_B911.py.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B911_B911.py.snap new file mode 100644 index 0000000000000..1ce2005be7fc9 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B911_B911.py.snap @@ -0,0 +1,168 @@ +--- +source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +--- +B911.py:5:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +4 | # Errors +5 | batched(range(3), 1) + | ^^^^^^^^^^^^^^^^^^^^ B911 +6 | batched("abc", 2) +7 | batched([i for i in range(42)], some_n) + | + = help: Add an explicit `strict` parameter + +B911.py:6:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +4 | # Errors +5 | batched(range(3), 1) +6 | batched("abc", 2) + | ^^^^^^^^^^^^^^^^^ B911 +7 | batched([i for i in range(42)], some_n) +8 | batched((foo for foo in cycle())) + | + = help: Add an explicit `strict` parameter + +B911.py:7:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +5 | batched(range(3), 1) +6 | batched("abc", 2) +7 | batched([i for i in range(42)], some_n) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +8 | batched((foo for foo in cycle())) +9 | batched(itertools.batched([1, 2, 3], strict=True)) + | + = help: Add an explicit `strict` parameter + +B911.py:8:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +6 | batched("abc", 2) +7 | batched([i for i in range(42)], some_n) +8 | batched((foo for foo in cycle())) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +9 | batched(itertools.batched([1, 2, 3], strict=True)) + | + = help: Add an explicit `strict` parameter + +B911.py:9:1: B911 `itertools.batched()` without an explicit `strict` parameter + | + 7 | batched([i for i in range(42)], some_n) + 8 | batched((foo for foo in cycle())) + 9 | batched(itertools.batched([1, 2, 3], strict=True)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +10 | +11 | # Errors (limited iterators). + | + = help: Add an explicit `strict` parameter + +B911.py:12:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +11 | # Errors (limited iterators). +12 | batched(repeat(1, 1)) + | ^^^^^^^^^^^^^^^^^^^^^ B911 +13 | batched(repeat(1, times=4)) + | + = help: Add an explicit `strict` parameter + +B911.py:13:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +11 | # Errors (limited iterators). +12 | batched(repeat(1, 1)) +13 | batched(repeat(1, times=4)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +14 | +15 | # No fix + | + = help: Add an explicit `strict` parameter + +B911.py:16:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +15 | # No fix +16 | batched([], **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^ B911 +17 | +18 | # No errors + | + = help: Add an explicit `strict` parameter + +B911.py:35:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +34 | # Errors +35 | itertools.batched(range(3), 1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +36 | itertools.batched("abc", 2) +37 | itertools.batched([i for i in range(42)], some_n) + | + = help: Add an explicit `strict` parameter + +B911.py:36:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +34 | # Errors +35 | itertools.batched(range(3), 1) +36 | itertools.batched("abc", 2) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +37 | itertools.batched([i for i in range(42)], some_n) +38 | itertools.batched((foo for foo in cycle())) + | + = help: Add an explicit `strict` parameter + +B911.py:37:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +35 | itertools.batched(range(3), 1) +36 | itertools.batched("abc", 2) +37 | itertools.batched([i for i in range(42)], some_n) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +38 | itertools.batched((foo for foo in cycle())) +39 | itertools.batched(itertools.batched([1, 2, 3], strict=True)) + | + = help: Add an explicit `strict` parameter + +B911.py:38:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +36 | itertools.batched("abc", 2) +37 | itertools.batched([i for i in range(42)], some_n) +38 | itertools.batched((foo for foo in cycle())) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +39 | itertools.batched(itertools.batched([1, 2, 3], strict=True)) + | + = help: Add an explicit `strict` parameter + +B911.py:39:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +37 | itertools.batched([i for i in range(42)], some_n) +38 | itertools.batched((foo for foo in cycle())) +39 | itertools.batched(itertools.batched([1, 2, 3], strict=True)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +40 | +41 | # Errors (limited iterators). + | + = help: Add an explicit `strict` parameter + +B911.py:42:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +41 | # Errors (limited iterators). +42 | itertools.batched(repeat(1, 1)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +43 | itertools.batched(repeat(1, times=4)) + | + = help: Add an explicit `strict` parameter + +B911.py:43:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +41 | # Errors (limited iterators). +42 | itertools.batched(repeat(1, 1)) +43 | itertools.batched(repeat(1, times=4)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +44 | +45 | # No fix + | + = help: Add an explicit `strict` parameter + +B911.py:46:1: B911 `itertools.batched()` without an explicit `strict` parameter + | +45 | # No fix +46 | itertools.batched([], **kwargs) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ B911 +47 | +48 | # No errors + | + = help: Add an explicit `strict` parameter diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_annotation.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_annotation.snap index ff069ea930445..eaa057448f2df 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_annotation.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_annotation.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B006_extended.py:17:55: B006 [*] Do not use mutable data structures for argument defaults | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_default.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_default.snap index 185294223eee4..611467e0f2b99 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_default.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_immutable_calls_arg_default.snap @@ -14,3 +14,10 @@ B008_extended.py:36:15: B008 Do not perform function call `OtherClass` in argume | ^^^^^^^^^^^^ B008 37 | ... | + +B008_extended.py:48:17: B008 Do not perform function call `L` in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable + | +47 | def okay(obj = N()): ... +48 | def error(obj = L()): ... + | ^^^ B008 + | diff --git a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_mutable_contextvar_default.snap b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_mutable_contextvar_default.snap index d03f11124f91f..f2dc889ba3a18 100644 --- a/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_mutable_contextvar_default.snap +++ b/crates/ruff_linter/src/rules/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__extend_mutable_contextvar_default.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_bugbear/mod.rs +snapshot_kind: text --- B039_extended.py:7:26: B039 Do not use mutable data structures for `ContextVar` defaults | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/helpers.rs b/crates/ruff_linter/src/rules/flake8_builtins/helpers.rs index 68a032b05d5ab..fb11f22f01d60 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/helpers.rs @@ -1,5 +1,5 @@ -use crate::settings::types::PythonVersion; use ruff_python_ast::PySourceType; +use ruff_python_ast::PythonVersion; use ruff_python_stdlib::builtins::is_python_builtin; pub(super) fn shadows_builtin( @@ -8,7 +8,7 @@ pub(super) fn shadows_builtin( ignorelist: &[String], python_version: PythonVersion, ) -> bool { - if is_python_builtin(name, python_version.minor(), source_type.is_ipynb()) { + if is_python_builtin(name, python_version.minor, source_type.is_ipynb()) { ignorelist.iter().all(|ignore| ignore != name) } else { false diff --git a/crates/ruff_linter/src/rules/flake8_builtins/mod.rs b/crates/ruff_linter/src/rules/flake8_builtins/mod.rs index 3bc4d8f3f93b4..f60327ec29733 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/mod.rs @@ -12,37 +12,129 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PythonVersion; + use crate::rules::flake8_builtins; use crate::settings::LinterSettings; - use crate::test::test_path; + use crate::test::{test_path, test_resource_path}; + use ruff_python_ast::PythonVersion; #[test_case(Rule::BuiltinVariableShadowing, Path::new("A001.py"))] #[test_case(Rule::BuiltinArgumentShadowing, Path::new("A002.py"))] #[test_case(Rule::BuiltinAttributeShadowing, Path::new("A003.py"))] #[test_case(Rule::BuiltinImportShadowing, Path::new("A004.py"))] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/non_builtin/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/logging/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/string/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/package/bisect.py") )] - #[test_case(Rule::BuiltinModuleShadowing, Path::new("A005/modules/package/xml.py"))] + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/package/collections.pyi") + )] + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/_abc/__init__.py") + )] + #[test_case(Rule::StdlibModuleShadowing, Path::new("A005/modules/package/xml.py"))] #[test_case(Rule::BuiltinLambdaArgumentShadowing, Path::new("A006.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( Path::new("flake8_builtins").join(path).as_path(), - &LinterSettings::for_rule(rule_code), + &LinterSettings { + flake8_builtins: flake8_builtins::settings::Settings { + strict_checking: true, + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/utils/logging.py"), + true + )] + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/utils/logging.py"), + false + )] + fn non_strict_checking(rule_code: Rule, path: &Path, strict: bool) -> Result<()> { + let snapshot = format!( + "{}_{}_{strict}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("flake8_builtins").join(path).as_path(), + &LinterSettings { + flake8_builtins: flake8_builtins::settings::Settings { + strict_checking: strict, + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + /// Test that even with strict checking disabled, a module in `src` will trigger A005 + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/utils/logging.py") + )] + fn non_strict_checking_src(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!("{}_{}_src", rule_code.noqa_code(), path.to_string_lossy()); + let src = Path::new("fixtures/flake8_builtins"); + let diagnostics = test_path( + Path::new("flake8_builtins").join(path).as_path(), + &LinterSettings { + src: vec![test_resource_path(src.join(path.parent().unwrap()))], + flake8_builtins: flake8_builtins::settings::Settings { + strict_checking: false, + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + /// Test that even with strict checking disabled, a module in the `project_root` will trigger + /// A005 + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/utils/logging.py") + )] + fn non_strict_checking_root(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!("{}_{}_root", rule_code.noqa_code(), path.to_string_lossy()); + let src = Path::new("fixtures/flake8_builtins"); + let diagnostics = test_path( + Path::new("flake8_builtins").join(path).as_path(), + &LinterSettings { + project_root: test_resource_path(src.join(path.parent().unwrap())), + flake8_builtins: flake8_builtins::settings::Settings { + strict_checking: false, + ..Default::default() + }, + ..LinterSettings::for_rule(rule_code) + }, )?; assert_messages!(snapshot, diagnostics); Ok(()) @@ -64,7 +156,7 @@ mod tests { Path::new("flake8_builtins").join(path).as_path(), &LinterSettings { flake8_builtins: super::settings::Settings { - builtins_ignorelist: vec!["id".to_string(), "dir".to_string()], + ignorelist: vec!["id".to_string(), "dir".to_string()], ..Default::default() }, ..LinterSettings::for_rules(vec![rule_code]) @@ -76,22 +168,26 @@ mod tests { } #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/non_builtin/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/logging/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/string/__init__.py") )] #[test_case( - Rule::BuiltinModuleShadowing, + Rule::StdlibModuleShadowing, Path::new("A005/modules/package/bisect.py") )] - #[test_case(Rule::BuiltinModuleShadowing, Path::new("A005/modules/package/xml.py"))] + #[test_case( + Rule::StdlibModuleShadowing, + Path::new("A005/modules/_abc/__init__.py") + )] + #[test_case(Rule::StdlibModuleShadowing, Path::new("A005/modules/package/xml.py"))] fn builtins_allowed_modules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!( "{}_{}_builtins_allowed_modules", @@ -103,7 +199,8 @@ mod tests { Path::new("flake8_builtins").join(path).as_path(), &LinterSettings { flake8_builtins: super::settings::Settings { - builtins_allowed_modules: vec!["xml".to_string(), "logging".to_string()], + allowed_modules: vec!["xml".to_string(), "logging".to_string()], + strict_checking: true, ..Default::default() }, ..LinterSettings::for_rules(vec![rule_code]) @@ -120,7 +217,7 @@ mod tests { let diagnostics = test_path( Path::new("flake8_builtins").join(path).as_path(), &LinterSettings { - target_version: PythonVersion::Py38, + unresolved_target_version: PythonVersion::PY38.into(), ..LinterSettings::for_rule(rule_code) }, )?; diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_argument_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_argument_shadowing.rs index 275df8c8df0f2..e2b24dd350314 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_argument_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_argument_shadowing.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::Parameter; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, Parameter}; use ruff_python_semantic::analyze::visibility::{is_overload, is_override}; use ruff_text_size::Ranged; @@ -19,7 +19,7 @@ use super::super::helpers::shadows_builtin; /// builtin and vice versa. /// /// Builtins can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-ignorelist`] configuration option. +/// [`lint.flake8-builtins.ignorelist`] configuration option. /// /// ## Example /// ```python @@ -44,13 +44,13 @@ use super::super::helpers::shadows_builtin; /// ``` /// /// ## Options -/// - `lint.flake8-builtins.builtins-ignorelist` +/// - `lint.flake8-builtins.ignorelist` /// /// ## References /// - [_Is it bad practice to use a built-in function name as an attribute or method identifier?_](https://stackoverflow.com/questions/9109333/is-it-bad-practice-to-use-a-built-in-function-name-as-an-attribute-or-method-ide) /// - [_Why is it a bad idea to name a variable `id` in Python?_](https://stackoverflow.com/questions/77552/id-is-a-bad-variable-name-in-python) -#[violation] -pub struct BuiltinArgumentShadowing { +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinArgumentShadowing { name: String, } @@ -58,18 +58,27 @@ impl Violation for BuiltinArgumentShadowing { #[derive_message_formats] fn message(&self) -> String { let BuiltinArgumentShadowing { name } = self; - format!("Argument `{name}` is shadowing a Python builtin") + format!("Function argument `{name}` is shadowing a Python builtin") } } /// A002 -pub(crate) fn builtin_argument_shadowing(checker: &mut Checker, parameter: &Parameter) { +pub(crate) fn builtin_argument_shadowing(checker: &Checker, parameter: &Parameter) { if shadows_builtin( - parameter.name.as_str(), + parameter.name(), checker.source_type, - &checker.settings.flake8_builtins.builtins_ignorelist, - checker.settings.target_version, + &checker.settings.flake8_builtins.ignorelist, + checker.target_version(), ) { + // Ignore parameters in lambda expressions. + // (That is the domain of A006.) + if checker + .semantic() + .current_expression() + .is_some_and(Expr::is_lambda_expr) + { + return; + } // Ignore `@override` and `@overload` decorated functions. if checker .semantic() @@ -83,7 +92,7 @@ pub(crate) fn builtin_argument_shadowing(checker: &mut Checker, parameter: &Para return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BuiltinArgumentShadowing { name: parameter.name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_attribute_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_attribute_shadowing.rs index 179471ab650a7..d75b1225f2a97 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_attribute_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_attribute_shadowing.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::{BindingKind, Scope, ScopeId}; use ruff_source_file::SourceRow; @@ -37,7 +37,7 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// ``` /// /// Builtins can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-ignorelist`] configuration option, or +/// [`lint.flake8-builtins.ignorelist`] configuration option, or /// converted to the appropriate dunder method. Methods decorated with /// `@typing.override` or `@typing_extensions.override` are also /// ignored. @@ -55,9 +55,9 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// ``` /// /// ## Options -/// - `lint.flake8-builtins.builtins-ignorelist` -#[violation] -pub struct BuiltinAttributeShadowing { +/// - `lint.flake8-builtins.ignorelist` +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinAttributeShadowing { kind: Kind, name: String, row: SourceRow, @@ -84,7 +84,6 @@ pub(crate) fn builtin_attribute_shadowing( scope_id: ScopeId, scope: &Scope, class_def: &ast::StmtClassDef, - diagnostics: &mut Vec<Diagnostic>, ) { for (name, binding_id) in scope.all_bindings() { let binding = checker.semantic().binding(binding_id); @@ -99,8 +98,8 @@ pub(crate) fn builtin_attribute_shadowing( if shadows_builtin( name, checker.source_type, - &checker.settings.flake8_builtins.builtins_ignorelist, - checker.settings.target_version, + &checker.settings.flake8_builtins.ignorelist, + checker.target_version(), ) { // Ignore explicit overrides. if class_def.decorator_list.iter().any(|decorator| { @@ -136,7 +135,7 @@ pub(crate) fn builtin_attribute_shadowing( == Some(scope_id) }) { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BuiltinAttributeShadowing { kind, name: name.to_string(), diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_import_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_import_shadowing.rs index 6e11a7bce465d..a426615f71c9d 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_import_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_import_shadowing.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Alias; use crate::checkers::ast::Checker; @@ -14,12 +14,35 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// as readers may mistake the variable for the builtin and vice versa. /// /// Builtins can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-ignorelist`] configuration option. +/// [`lint.flake8-builtins.ignorelist`] configuration option. +/// +/// ## Example +/// ```python +/// from rich import print +/// +/// print("Some message") +/// ``` +/// +/// Use instead: +/// ```python +/// from rich import print as rich_print +/// +/// rich_print("Some message") +/// ``` +/// +/// or: +/// ```python +/// import rich +/// +/// rich.print("Some message") +/// ``` /// /// ## Options -/// - `lint.flake8-builtins.builtins-ignorelist` -#[violation] -pub struct BuiltinImportShadowing { +/// - `lint.flake8-builtins.ignorelist` +/// - `target-version` +/// +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinImportShadowing { name: String, } @@ -32,15 +55,15 @@ impl Violation for BuiltinImportShadowing { } /// A004 -pub(crate) fn builtin_import_shadowing(checker: &mut Checker, alias: &Alias) { +pub(crate) fn builtin_import_shadowing(checker: &Checker, alias: &Alias) { let name = alias.asname.as_ref().unwrap_or(&alias.name); if shadows_builtin( name.as_str(), checker.source_type, - &checker.settings.flake8_builtins.builtins_ignorelist, - checker.settings.target_version, + &checker.settings.flake8_builtins.ignorelist, + checker.target_version(), ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BuiltinImportShadowing { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_lambda_argument_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_lambda_argument_shadowing.rs index f8f8756df1c9d..ff637cdb2daeb 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_lambda_argument_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_lambda_argument_shadowing.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::ExprLambda; use ruff_text_size::Ranged; @@ -11,17 +11,17 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// /// ## Why is this bad? /// Reusing a builtin name for the name of a lambda argument increases the -/// difficulty of reading and maintaining the code, and can cause -/// non-obvious errors, as readers may mistake the variable for the -/// builtin and vice versa. +/// difficulty of reading and maintaining the code and can cause +/// non-obvious errors. Readers may mistake the variable for the +/// builtin, and vice versa. /// /// Builtins can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-ignorelist`] configuration option. +/// [`lint.flake8-builtins.ignorelist`] configuration option. /// /// ## Options -/// - `lint.flake8-builtins.builtins-ignorelist` -#[violation] -pub struct BuiltinLambdaArgumentShadowing { +/// - `lint.flake8-builtins.ignorelist` +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinLambdaArgumentShadowing { name: String, } @@ -34,19 +34,19 @@ impl Violation for BuiltinLambdaArgumentShadowing { } /// A006 -pub(crate) fn builtin_lambda_argument_shadowing(checker: &mut Checker, lambda: &ExprLambda) { +pub(crate) fn builtin_lambda_argument_shadowing(checker: &Checker, lambda: &ExprLambda) { let Some(parameters) = lambda.parameters.as_ref() else { return; }; for param in parameters.iter_non_variadic_params() { - let name = ¶m.parameter.name; + let name = param.name(); if shadows_builtin( - name.as_ref(), + name, checker.source_type, - &checker.settings.flake8_builtins.builtins_ignorelist, - checker.settings.target_version, + &checker.settings.flake8_builtins.ignorelist, + checker.target_version(), ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BuiltinLambdaArgumentShadowing { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_module_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_module_shadowing.rs deleted file mode 100644 index 14d42fb7e9e4e..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_module_shadowing.rs +++ /dev/null @@ -1,71 +0,0 @@ -use std::path::Path; - -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::PySourceType; -use ruff_python_stdlib::path::is_module_file; -use ruff_python_stdlib::sys::is_known_standard_library; -use ruff_text_size::TextRange; - -use crate::settings::types::PythonVersion; - -/// ## What it does -/// Checks for modules that use the same names as Python builtin modules. -/// -/// ## Why is this bad? -/// Reusing a builtin module name for the name of a module increases the -/// difficulty of reading and maintaining the code, and can cause -/// non-obvious errors, as readers may mistake the variable for the -/// builtin and vice versa. -/// -/// Builtin modules can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-allowed-modules`] configuration option. -/// -/// ## Options -/// - `lint.flake8-builtins.builtins-allowed-modules` -#[violation] -pub struct BuiltinModuleShadowing { - name: String, -} - -impl Violation for BuiltinModuleShadowing { - #[derive_message_formats] - fn message(&self) -> String { - let BuiltinModuleShadowing { name } = self; - format!("Module `{name}` is shadowing a Python builtin module") - } -} - -/// A005 -pub(crate) fn builtin_module_shadowing( - path: &Path, - package: Option<&Path>, - allowed_modules: &[String], - target_version: PythonVersion, -) -> Option<Diagnostic> { - if !PySourceType::try_from_path(path).is_some_and(PySourceType::is_py_file_or_stub) { - return None; - } - - if let Some(package) = package { - let module_name = if is_module_file(path) { - package.file_name().unwrap().to_string_lossy() - } else { - path.file_stem().unwrap().to_string_lossy() - }; - - if is_known_standard_library(target_version.minor(), &module_name) - && allowed_modules - .iter() - .all(|allowed_module| allowed_module != &module_name) - { - return Some(Diagnostic::new( - BuiltinModuleShadowing { - name: module_name.to_string(), - }, - TextRange::default(), - )); - } - } - None -} diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_variable_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_variable_shadowing.rs index 5dc661dc409cc..157f8d6a8f32d 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_variable_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/builtin_variable_shadowing.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::TextRange; use crate::checkers::ast::Checker; @@ -17,7 +17,7 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// builtin and vice versa. /// /// Builtins can be marked as exceptions to this rule via the -/// [`lint.flake8-builtins.builtins-ignorelist`] configuration option. +/// [`lint.flake8-builtins.ignorelist`] configuration option. /// /// ## Example /// ```python @@ -40,12 +40,12 @@ use crate::rules::flake8_builtins::helpers::shadows_builtin; /// ``` /// /// ## Options -/// - `lint.flake8-builtins.builtins-ignorelist` +/// - `lint.flake8-builtins.ignorelist` /// /// ## References /// - [_Why is it a bad idea to name a variable `id` in Python?_](https://stackoverflow.com/questions/77552/id-is-a-bad-variable-name-in-python) -#[violation] -pub struct BuiltinVariableShadowing { +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinVariableShadowing { name: String, } @@ -58,14 +58,23 @@ impl Violation for BuiltinVariableShadowing { } /// A001 -pub(crate) fn builtin_variable_shadowing(checker: &mut Checker, name: &str, range: TextRange) { +pub(crate) fn builtin_variable_shadowing(checker: &Checker, name: &str, range: TextRange) { + // These should not report violations as discussed in + // https://github.com/astral-sh/ruff/issues/16373 + if matches!( + name, + "__doc__" | "__name__" | "__loader__" | "__package__" | "__spec__" + ) { + return; + } + if shadows_builtin( name, checker.source_type, - &checker.settings.flake8_builtins.builtins_ignorelist, - checker.settings.target_version, + &checker.settings.flake8_builtins.ignorelist, + checker.target_version(), ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BuiltinVariableShadowing { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/mod.rs index 46478f7c236a1..1f9aeeb12ece9 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/mod.rs @@ -2,12 +2,12 @@ pub(crate) use builtin_argument_shadowing::*; pub(crate) use builtin_attribute_shadowing::*; pub(crate) use builtin_import_shadowing::*; pub(crate) use builtin_lambda_argument_shadowing::*; -pub(crate) use builtin_module_shadowing::*; pub(crate) use builtin_variable_shadowing::*; +pub(crate) use stdlib_module_shadowing::*; mod builtin_argument_shadowing; mod builtin_attribute_shadowing; mod builtin_import_shadowing; mod builtin_lambda_argument_shadowing; -mod builtin_module_shadowing; mod builtin_variable_shadowing; +mod stdlib_module_shadowing; diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs new file mode 100644 index 0000000000000..61a4494d17491 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs @@ -0,0 +1,146 @@ +use std::borrow::Cow; +use std::path::{Component, Path, PathBuf}; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{PySourceType, PythonVersion}; +use ruff_python_stdlib::path::is_module_file; +use ruff_python_stdlib::sys::is_known_standard_library; +use ruff_text_size::TextRange; + +use crate::settings::LinterSettings; + +/// ## What it does +/// Checks for modules that use the same names as Python standard-library +/// modules. +/// +/// ## Why is this bad? +/// Reusing a standard-library module name for the name of a module increases +/// the difficulty of reading and maintaining the code, and can cause +/// non-obvious errors. Readers may mistake the first-party module for the +/// standard-library module and vice versa. +/// +/// Standard-library modules can be marked as exceptions to this rule via the +/// [`lint.flake8-builtins.allowed-modules`] configuration option. +/// +/// By default, the module path relative to the project root or [`src`] directories is considered, +/// so a top-level `logging.py` or `logging/__init__.py` will clash with the builtin `logging` +/// module, but `utils/logging.py`, for example, will not. With the +/// [`lint.flake8-builtins.strict-checking`] option set to `true`, only the last component +/// of the module name is considered, so `logging.py`, `utils/logging.py`, and +/// `utils/logging/__init__.py` will all trigger the rule. +/// +/// This rule is not applied to stub files, as the name of a stub module is out +/// of the control of the author of the stub file. Instead, a stub should aim to +/// faithfully emulate the runtime module it is stubbing. +/// +/// As of Python 3.13, errors from modules that use the same name as +/// standard-library modules now display a custom message. +/// +/// ## Example +/// +/// ```console +/// $ touch random.py +/// $ python3 -c 'from random import choice' +/// Traceback (most recent call last): +/// File "<string>", line 1, in <module> +/// from random import choice +/// ImportError: cannot import name 'choice' from 'random' (consider renaming '/random.py' since it has the same name as the standard library module named 'random' and prevents importing that standard library module) +/// ``` +/// +/// ## Options +/// - `lint.flake8-builtins.allowed-modules` +/// - `lint.flake8-builtins.strict-checking` +#[derive(ViolationMetadata)] +pub(crate) struct StdlibModuleShadowing { + name: String, +} + +impl Violation for StdlibModuleShadowing { + #[derive_message_formats] + fn message(&self) -> String { + let StdlibModuleShadowing { name } = self; + format!("Module `{name}` shadows a Python standard-library module") + } +} + +/// A005 +pub(crate) fn stdlib_module_shadowing( + mut path: &Path, + settings: &LinterSettings, + target_version: PythonVersion, +) -> Option<Diagnostic> { + if !PySourceType::try_from_path(path).is_some_and(PySourceType::is_py_file) { + return None; + } + + // strip src and root prefixes before converting to a fully-qualified module path + let prefix = get_prefix(settings, path); + if let Some(Ok(new_path)) = prefix.map(|p| path.strip_prefix(p)) { + path = new_path; + } + + // for modules like `modname/__init__.py`, use the parent directory name, otherwise just trim + // the `.py` extension + let path = if is_module_file(path) { + Cow::from(path.parent()?) + } else { + Cow::from(path.with_extension("")) + }; + + // convert a filesystem path like `foobar/collections/abc` to a reversed sequence of modules + // like `["abc", "collections", "foobar"]`, stripping anything that's not a normal component + let mut components = path + .components() + .filter(|c| matches!(c, Component::Normal(_))) + .map(|c| c.as_os_str().to_string_lossy()) + .rev(); + + let module_name = components.next()?; + + if is_allowed_module(settings, target_version, &module_name) { + return None; + } + + // not allowed generally, but check for a parent in non-strict mode + if !settings.flake8_builtins.strict_checking && components.next().is_some() { + return None; + } + + Some(Diagnostic::new( + StdlibModuleShadowing { + name: module_name.to_string(), + }, + TextRange::default(), + )) +} + +/// Return the longest prefix of `path` between `settings.src` and `settings.project_root`. +fn get_prefix<'a>(settings: &'a LinterSettings, path: &Path) -> Option<&'a PathBuf> { + let mut prefix = None; + for dir in settings.src.iter().chain([&settings.project_root]) { + if path.starts_with(dir) && prefix.is_none_or(|existing| existing < dir) { + prefix = Some(dir); + } + } + prefix +} + +fn is_allowed_module(settings: &LinterSettings, version: PythonVersion, module: &str) -> bool { + // Shadowing private stdlib modules is okay. + // https://github.com/astral-sh/ruff/issues/12949 + if module.starts_with('_') && !module.starts_with("__") { + return true; + } + + if settings + .flake8_builtins + .allowed_modules + .iter() + .any(|allowed_module| allowed_module == module) + { + return true; + } + + !is_known_standard_library(version.minor, module) +} diff --git a/crates/ruff_linter/src/rules/flake8_builtins/settings.rs b/crates/ruff_linter/src/rules/flake8_builtins/settings.rs index cfb5573ee05a9..7be3222326cb8 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/settings.rs @@ -6,8 +6,9 @@ use std::fmt::{Display, Formatter}; #[derive(Debug, Clone, Default, CacheKey)] pub struct Settings { - pub builtins_ignorelist: Vec<String>, - pub builtins_allowed_modules: Vec<String>, + pub ignorelist: Vec<String>, + pub allowed_modules: Vec<String>, + pub strict_checking: bool, } impl Display for Settings { @@ -16,8 +17,9 @@ impl Display for Settings { formatter = f, namespace = "linter.flake8_builtins", fields = [ - self.builtins_allowed_modules | array, - self.builtins_ignorelist | array, + self.allowed_modules | array, + self.ignorelist | array, + self.strict_checking, ] } Ok(()) diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py.snap index 60efd0556398e..9baa2d027019d 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py.snap @@ -1,36 +1,10 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -A001.py:1:16: A001 Variable `sum` is shadowing a Python builtin - | -1 | import some as sum - | ^^^ A001 -2 | from some import other as int -3 | from directory import new as dir - | - -A001.py:2:27: A001 Variable `int` is shadowing a Python builtin - | -1 | import some as sum -2 | from some import other as int - | ^^^ A001 -3 | from directory import new as dir - | - -A001.py:3:30: A001 Variable `dir` is shadowing a Python builtin - | -1 | import some as sum -2 | from some import other as int -3 | from directory import new as dir - | ^^^ A001 -4 | -5 | print = 1 - | - A001.py:5:1: A001 Variable `print` is shadowing a Python builtin | 3 | from directory import new as dir -4 | +4 | 5 | print = 1 | ^^^^^ A001 6 | copyright: 'annotation' = 2 @@ -80,7 +54,7 @@ A001.py:9:1: A001 Variable `min` is shadowing a Python builtin 8 | float = object = 4 9 | min, max = 5, 6 | ^^^ A001 -10 | +10 | 11 | id = 4 | @@ -90,24 +64,24 @@ A001.py:9:6: A001 Variable `max` is shadowing a Python builtin 8 | float = object = 4 9 | min, max = 5, 6 | ^^^ A001 -10 | +10 | 11 | id = 4 | A001.py:11:1: A001 Variable `id` is shadowing a Python builtin | 9 | min, max = 5, 6 -10 | +10 | 11 | id = 4 | ^^ A001 -12 | +12 | 13 | def bytes(): | A001.py:13:5: A001 Variable `bytes` is shadowing a Python builtin | 11 | id = 4 -12 | +12 | 13 | def bytes(): | ^^^^^ A001 14 | pass @@ -116,7 +90,7 @@ A001.py:13:5: A001 Variable `bytes` is shadowing a Python builtin A001.py:16:7: A001 Variable `slice` is shadowing a Python builtin | 14 | pass -15 | +15 | 16 | class slice: | ^^^^^ A001 17 | pass @@ -134,7 +108,7 @@ A001.py:21:23: A001 Variable `ValueError` is shadowing a Python builtin A001.py:24:5: A001 Variable `memoryview` is shadowing a Python builtin | 22 | ... -23 | +23 | 24 | for memoryview, *bytearray in []: | ^^^^^^^^^^ A001 25 | pass @@ -143,7 +117,7 @@ A001.py:24:5: A001 Variable `memoryview` is shadowing a Python builtin A001.py:24:18: A001 Variable `bytearray` is shadowing a Python builtin | 22 | ... -23 | +23 | 24 | for memoryview, *bytearray in []: | ^^^^^^^^^ A001 25 | pass @@ -152,7 +126,7 @@ A001.py:24:18: A001 Variable `bytearray` is shadowing a Python builtin A001.py:27:22: A001 Variable `str` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -161,7 +135,7 @@ A001.py:27:22: A001 Variable `str` is shadowing a Python builtin A001.py:27:45: A001 Variable `all` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -170,7 +144,7 @@ A001.py:27:45: A001 Variable `all` is shadowing a Python builtin A001.py:27:50: A001 Variable `any` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -179,9 +153,7 @@ A001.py:27:50: A001 Variable `any` is shadowing a Python builtin A001.py:30:8: A001 Variable `sum` is shadowing a Python builtin | 28 | pass -29 | +29 | 30 | [0 for sum in ()] | ^^^ A001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py_builtins_ignorelist.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py_builtins_ignorelist.snap index dfdd12fe91efd..10d6961236874 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py_builtins_ignorelist.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A001_A001.py_builtins_ignorelist.snap @@ -1,26 +1,10 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -A001.py:1:16: A001 Variable `sum` is shadowing a Python builtin - | -1 | import some as sum - | ^^^ A001 -2 | from some import other as int -3 | from directory import new as dir - | - -A001.py:2:27: A001 Variable `int` is shadowing a Python builtin - | -1 | import some as sum -2 | from some import other as int - | ^^^ A001 -3 | from directory import new as dir - | - A001.py:5:1: A001 Variable `print` is shadowing a Python builtin | 3 | from directory import new as dir -4 | +4 | 5 | print = 1 | ^^^^^ A001 6 | copyright: 'annotation' = 2 @@ -70,7 +54,7 @@ A001.py:9:1: A001 Variable `min` is shadowing a Python builtin 8 | float = object = 4 9 | min, max = 5, 6 | ^^^ A001 -10 | +10 | 11 | id = 4 | @@ -80,14 +64,14 @@ A001.py:9:6: A001 Variable `max` is shadowing a Python builtin 8 | float = object = 4 9 | min, max = 5, 6 | ^^^ A001 -10 | +10 | 11 | id = 4 | A001.py:13:5: A001 Variable `bytes` is shadowing a Python builtin | 11 | id = 4 -12 | +12 | 13 | def bytes(): | ^^^^^ A001 14 | pass @@ -96,7 +80,7 @@ A001.py:13:5: A001 Variable `bytes` is shadowing a Python builtin A001.py:16:7: A001 Variable `slice` is shadowing a Python builtin | 14 | pass -15 | +15 | 16 | class slice: | ^^^^^ A001 17 | pass @@ -114,7 +98,7 @@ A001.py:21:23: A001 Variable `ValueError` is shadowing a Python builtin A001.py:24:5: A001 Variable `memoryview` is shadowing a Python builtin | 22 | ... -23 | +23 | 24 | for memoryview, *bytearray in []: | ^^^^^^^^^^ A001 25 | pass @@ -123,7 +107,7 @@ A001.py:24:5: A001 Variable `memoryview` is shadowing a Python builtin A001.py:24:18: A001 Variable `bytearray` is shadowing a Python builtin | 22 | ... -23 | +23 | 24 | for memoryview, *bytearray in []: | ^^^^^^^^^ A001 25 | pass @@ -132,7 +116,7 @@ A001.py:24:18: A001 Variable `bytearray` is shadowing a Python builtin A001.py:27:22: A001 Variable `str` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -141,7 +125,7 @@ A001.py:27:22: A001 Variable `str` is shadowing a Python builtin A001.py:27:45: A001 Variable `all` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -150,7 +134,7 @@ A001.py:27:45: A001 Variable `all` is shadowing a Python builtin A001.py:27:50: A001 Variable `any` is shadowing a Python builtin | 25 | pass -26 | +26 | 27 | with open('file') as str, open('file2') as (all, any): | ^^^ A001 28 | pass @@ -159,9 +143,7 @@ A001.py:27:50: A001 Variable `any` is shadowing a Python builtin A001.py:30:8: A001 Variable `sum` is shadowing a Python builtin | 28 | pass -29 | +29 | 30 | [0 for sum in ()] | ^^^ A001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py.snap index b00ca145fcf5e..d42706297951e 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py.snap @@ -1,66 +1,59 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- -A002.py:1:11: A002 Argument `str` is shadowing a Python builtin +A002.py:1:11: A002 Function argument `str` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^ A002 2 | pass | -A002.py:1:19: A002 Argument `type` is shadowing a Python builtin +A002.py:1:19: A002 Function argument `type` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^ A002 2 | pass | -A002.py:1:26: A002 Argument `complex` is shadowing a Python builtin +A002.py:1:26: A002 Function argument `complex` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^ A002 2 | pass | -A002.py:1:35: A002 Argument `Exception` is shadowing a Python builtin +A002.py:1:35: A002 Function argument `Exception` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^^^ A002 2 | pass | -A002.py:1:48: A002 Argument `getattr` is shadowing a Python builtin +A002.py:1:48: A002 Function argument `getattr` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^ A002 2 | pass | -A002.py:5:17: A002 Argument `bytes` is shadowing a Python builtin +A002.py:5:17: A002 Function argument `bytes` is shadowing a Python builtin | 5 | async def func2(bytes): | ^^^^^ A002 6 | pass | -A002.py:9:17: A002 Argument `id` is shadowing a Python builtin +A002.py:9:17: A002 Function argument `id` is shadowing a Python builtin | 9 | async def func3(id, dir): | ^^ A002 10 | pass | -A002.py:9:21: A002 Argument `dir` is shadowing a Python builtin +A002.py:9:21: A002 Function argument `dir` is shadowing a Python builtin | 9 | async def func3(id, dir): | ^^^ A002 10 | pass | - -A002.py:13:16: A002 Argument `float` is shadowing a Python builtin - | -13 | map([], lambda float: ...) - | ^^^^^ A002 -14 | -15 | from typing import override, overload - | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py_builtins_ignorelist.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py_builtins_ignorelist.snap index d5627625962a8..3ed8f71870d48 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py_builtins_ignorelist.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A002_A002.py_builtins_ignorelist.snap @@ -1,52 +1,45 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- -A002.py:1:11: A002 Argument `str` is shadowing a Python builtin +A002.py:1:11: A002 Function argument `str` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^ A002 2 | pass | -A002.py:1:19: A002 Argument `type` is shadowing a Python builtin +A002.py:1:19: A002 Function argument `type` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^ A002 2 | pass | -A002.py:1:26: A002 Argument `complex` is shadowing a Python builtin +A002.py:1:26: A002 Function argument `complex` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^ A002 2 | pass | -A002.py:1:35: A002 Argument `Exception` is shadowing a Python builtin +A002.py:1:35: A002 Function argument `Exception` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^^^ A002 2 | pass | -A002.py:1:48: A002 Argument `getattr` is shadowing a Python builtin +A002.py:1:48: A002 Function argument `getattr` is shadowing a Python builtin | 1 | def func1(str, /, type, *complex, Exception, **getattr): | ^^^^^^^ A002 2 | pass | -A002.py:5:17: A002 Argument `bytes` is shadowing a Python builtin +A002.py:5:17: A002 Function argument `bytes` is shadowing a Python builtin | 5 | async def func2(bytes): | ^^^^^ A002 6 | pass | - -A002.py:13:16: A002 Argument `float` is shadowing a Python builtin - | -13 | map([], lambda float: ...) - | ^^^^^ A002 -14 | -15 | from typing import override, overload - | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py.snap index f89f5abeda06d..082f3e3d5cd13 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs A003.py:17:31: A003 Python builtin is shadowed by method `str` from line 14 | 15 | pass -16 | +16 | 17 | def method_usage(self) -> str: | ^^^ A003 18 | pass @@ -13,10 +13,8 @@ A003.py:17:31: A003 Python builtin is shadowed by method `str` from line 14 A003.py:20:34: A003 Python builtin is shadowed by class attribute `id` from line 3 | 18 | pass -19 | +19 | 20 | def attribute_usage(self) -> id: | ^^ A003 21 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py_builtins_ignorelist.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py_builtins_ignorelist.snap index 06d0956121ba7..85f5360b4475c 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py_builtins_ignorelist.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A003_A003.py_builtins_ignorelist.snap @@ -4,10 +4,8 @@ source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs A003.py:17:31: A003 Python builtin is shadowed by method `str` from line 14 | 15 | pass -16 | +16 | 17 | def method_usage(self) -> str: | ^^^ A003 18 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py.snap index c31cebd70b7f0..6c8386ed148b5 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py.snap @@ -52,7 +52,7 @@ A004.py:5:30: A004 Import `dir` is shadowing a Python builtin 4 | from some import input, exec 5 | from directory import new as dir | ^^^ A004 -6 | +6 | 7 | # See: https://github.com/astral-sh/ruff/issues/13037 | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_builtins_ignorelist.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_builtins_ignorelist.snap index 700a881c7f0ff..94ff184b1802c 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_builtins_ignorelist.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_builtins_ignorelist.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- A004.py:1:16: A004 Import `sum` is shadowing a Python builtin | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_py38.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_py38.snap index e33ad847bbc28..b8389e0889178 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_py38.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A004_A004.py_py38.snap @@ -52,6 +52,6 @@ A004.py:5:30: A004 Import `dir` is shadowing a Python builtin 4 | from some import input, exec 5 | from directory import new as dir | ^^^ A004 -6 | +6 | 7 | # See: https://github.com/astral-sh/ruff/issues/13037 | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py.snap new file mode 100644 index 0000000000000..d9ec358dccff3 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py_builtins_allowed_modules.snap new file mode 100644 index 0000000000000..d9ec358dccff3 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules___abc____init__.py_builtins_allowed_modules.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py.snap index 9f05f0aa763d5..1e4858a65e0fa 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -__init__.py:1:1: A005 Module `logging` is shadowing a Python builtin module +__init__.py:1:1: A005 Module `logging` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py_builtins_allowed_modules.snap index df35fcb66a979..d9ec358dccff3 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py_builtins_allowed_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__logging____init__.py_builtins_allowed_modules.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py.snap index df35fcb66a979..d9ec358dccff3 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py_builtins_allowed_modules.snap index df35fcb66a979..d9ec358dccff3 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py_builtins_allowed_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__non_builtin____init__.py_builtins_allowed_modules.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py.snap index 3615ea42974ab..573d2f7e85c13 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -bisect.py:1:1: A005 Module `bisect` is shadowing a Python builtin module +bisect.py:1:1: A005 Module `bisect` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py_builtins_allowed_modules.snap index 3615ea42974ab..573d2f7e85c13 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py_builtins_allowed_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__bisect.py_builtins_allowed_modules.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -bisect.py:1:1: A005 Module `bisect` is shadowing a Python builtin module +bisect.py:1:1: A005 Module `bisect` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__collections.pyi.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__collections.pyi.snap new file mode 100644 index 0000000000000..df35fcb66a979 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__collections.pyi.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py.snap index 3fade6e0a3757..9e70b02ef5a9d 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -xml.py:1:1: A005 Module `xml` is shadowing a Python builtin module +xml.py:1:1: A005 Module `xml` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py_builtins_allowed_modules.snap index df35fcb66a979..d9ec358dccff3 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py_builtins_allowed_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__package__xml.py_builtins_allowed_modules.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py.snap index 69dc571b6ffc5..1bfc390c9e06f 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -__init__.py:1:1: A005 Module `string` is shadowing a Python builtin module +__init__.py:1:1: A005 Module `string` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py_builtins_allowed_modules.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py_builtins_allowed_modules.snap index 69dc571b6ffc5..1bfc390c9e06f 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py_builtins_allowed_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__string____init__.py_builtins_allowed_modules.snap @@ -1,4 +1,4 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs --- -__init__.py:1:1: A005 Module `string` is shadowing a Python builtin module +__init__.py:1:1: A005 Module `string` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_false.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_false.snap new file mode 100644 index 0000000000000..df35fcb66a979 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_false.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_root.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_root.snap new file mode 100644 index 0000000000000..2154e514668f1 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_root.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +--- +logging.py:1:1: A005 Module `logging` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_src.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_src.snap new file mode 100644 index 0000000000000..2154e514668f1 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_src.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +--- +logging.py:1:1: A005 Module `logging` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_true.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_true.snap new file mode 100644 index 0000000000000..2154e514668f1 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A005_A005__modules__utils__logging.py_true.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +--- +logging.py:1:1: A005 Module `logging` shadows a Python standard-library module diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py.snap index 14544a4f3da76..9c968e14f78d5 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py.snap @@ -61,4 +61,6 @@ A006.py:5:8: A006 Lambda argument `dir` is shadowing a Python builtin 4 | lambda id: id 5 | lambda dir: dir | ^^^ A006 +6 | +7 | # Ok for A006 - should trigger A002 instead | diff --git a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py_builtins_ignorelist.snap b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py_builtins_ignorelist.snap index 2ac1bb621e447..3b7a28a6342bf 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py_builtins_ignorelist.snap +++ b/crates/ruff_linter/src/rules/flake8_builtins/snapshots/ruff_linter__rules__flake8_builtins__tests__A006_A006.py_builtins_ignorelist.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_builtins/mod.rs +snapshot_kind: text --- A006.py:1:8: A006 Lambda argument `print` is shadowing a Python builtin | diff --git a/crates/ruff_linter/src/rules/flake8_commas/rules/trailing_commas.rs b/crates/ruff_linter/src/rules/flake8_commas/rules/trailing_commas.rs index b4e2c423cea47..0002b9a14700e 100644 --- a/crates/ruff_linter/src/rules/flake8_commas/rules/trailing_commas.rs +++ b/crates/ruff_linter/src/rules/flake8_commas/rules/trailing_commas.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_index::Indexer; use ruff_python_parser::{TokenKind, Tokens}; use ruff_text_size::{Ranged, TextRange}; @@ -74,7 +74,7 @@ impl From<(TokenKind, TextRange)> for SimpleToken { TokenKind::Import => TokenType::Named, _ => TokenType::Irrelevant, }; - #[allow(clippy::inconsistent_struct_constructor)] + #[expect(clippy::inconsistent_struct_constructor)] Self { range, ty } } } @@ -139,13 +139,19 @@ impl Context { /// "baz": 2, /// } /// ``` -#[violation] -pub struct MissingTrailingComma; +/// +/// ## Formatter compatibility +/// We recommend against using this rule alongside the [formatter]. The +/// formatter enforces consistent use of trailing commas, making the rule redundant. +/// +/// [formatter]:https://docs.astral.sh/ruff/formatter/ +#[derive(ViolationMetadata)] +pub(crate) struct MissingTrailingComma; impl AlwaysFixableViolation for MissingTrailingComma { #[derive_message_formats] fn message(&self) -> String { - format!("Trailing comma missing") + "Trailing comma missing".to_string() } fn fix_title(&self) -> String { @@ -182,15 +188,15 @@ impl AlwaysFixableViolation for MissingTrailingComma { /// import json /// /// -/// foo = (json.dumps({"bar": 1})) +/// foo = (json.dumps({"bar": 1}),) /// ``` -#[violation] -pub struct TrailingCommaOnBareTuple; +#[derive(ViolationMetadata)] +pub(crate) struct TrailingCommaOnBareTuple; impl Violation for TrailingCommaOnBareTuple { #[derive_message_formats] fn message(&self) -> String { - format!("Trailing comma on bare tuple prohibited") + "Trailing comma on bare tuple prohibited".to_string() } } @@ -210,13 +216,19 @@ impl Violation for TrailingCommaOnBareTuple { /// ```python /// foo = (1, 2, 3) /// ``` -#[violation] -pub struct ProhibitedTrailingComma; +/// +/// ## Formatter compatibility +/// We recommend against using this rule alongside the [formatter]. The +/// formatter enforces consistent use of trailing commas, making the rule redundant. +/// +/// [formatter]:https://docs.astral.sh/ruff/formatter/ +#[derive(ViolationMetadata)] +pub(crate) struct ProhibitedTrailingComma; impl AlwaysFixableViolation for ProhibitedTrailingComma { #[derive_message_formats] fn message(&self) -> String { - format!("Trailing comma prohibited") + "Trailing comma prohibited".to_string() } fn fix_title(&self) -> String { diff --git a/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81.py.snap b/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81.py.snap index 1955cf08d063f..56628a26d864c 100644 --- a/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81.py.snap +++ b/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81.py.snap @@ -6,7 +6,7 @@ COM81.py:4:18: COM812 [*] Trailing comma missing 2 | bad_function_call( 3 | param1='test', 4 | param2='test' - | COM812 + | ^ COM812 5 | ) 6 | # ==> bad_list.py <== | @@ -27,7 +27,7 @@ COM81.py:10:6: COM812 [*] Trailing comma missing 8 | 1, 9 | 2, 10 | 3 - | COM812 + | ^ COM812 11 | ] | = help: Add trailing comma @@ -47,7 +47,7 @@ COM81.py:16:6: COM812 [*] Trailing comma missing 14 | 1, 15 | 2, 16 | 3 - | COM812 + | ^ COM812 17 | # still needs a comma! 18 | ] | @@ -68,7 +68,7 @@ COM81.py:23:6: COM812 [*] Trailing comma missing 21 | 1, 22 | 2, 23 | 3 - | COM812 + | ^ COM812 | = help: Add trailing comma @@ -85,30 +85,30 @@ COM81.py:23:6: COM812 [*] Trailing comma missing COM81.py:36:8: COM818 Trailing comma on bare tuple prohibited | 34 | foo = (1,) -35 | +35 | 36 | foo = 1, | ^ COM818 -37 | +37 | 38 | bar = 1; foo = bar, | COM81.py:38:19: COM818 Trailing comma on bare tuple prohibited | 36 | foo = 1, -37 | +37 | 38 | bar = 1; foo = bar, | ^ COM818 -39 | +39 | 40 | foo = ( | COM81.py:45:8: COM818 Trailing comma on bare tuple prohibited | 43 | ) -44 | +44 | 45 | foo = 3, | ^ COM818 -46 | +46 | 47 | class A(object): | @@ -124,20 +124,20 @@ COM81.py:49:10: COM818 Trailing comma on bare tuple prohibited COM81.py:56:32: COM818 Trailing comma on bare tuple prohibited | 54 | from foo import bar, baz -55 | +55 | 56 | group_by = function_call('arg'), | ^ COM818 -57 | +57 | 58 | group_by = ('foobar' * 3), | COM81.py:58:26: COM818 Trailing comma on bare tuple prohibited | 56 | group_by = function_call('arg'), -57 | +57 | 58 | group_by = ('foobar' * 3), | ^ COM818 -59 | +59 | 60 | def foo(): | @@ -146,7 +146,7 @@ COM81.py:61:17: COM818 Trailing comma on bare tuple prohibited 60 | def foo(): 61 | return False, | ^ COM818 -62 | +62 | 63 | # ==> callable_before_parenth_form.py <== | @@ -154,7 +154,7 @@ COM81.py:70:8: COM812 [*] Trailing comma missing | 69 | {'foo': foo}['foo']( 70 | bar - | COM812 + | ^ COM812 71 | ) | = help: Add trailing comma @@ -173,7 +173,7 @@ COM81.py:78:8: COM812 [*] Trailing comma missing | 77 | (foo)( 78 | bar - | COM812 + | ^ COM812 79 | ) | = help: Add trailing comma @@ -192,7 +192,7 @@ COM81.py:86:8: COM812 [*] Trailing comma missing | 85 | [foo][0]( 86 | bar - | COM812 + | ^ COM812 87 | ) | = help: Add trailing comma @@ -212,7 +212,7 @@ COM81.py:152:6: COM812 [*] Trailing comma missing 150 | # ==> keyword_before_parenth_form/base_bad.py <== 151 | from x import ( 152 | y - | COM812 + | ^ COM812 153 | ) | = help: Add trailing comma @@ -232,7 +232,7 @@ COM81.py:158:11: COM812 [*] Trailing comma missing 156 | SyntaxWarning, 157 | ThrownHere, 158 | Anyway - | COM812 + | ^ COM812 159 | ) | = help: Add trailing comma @@ -252,7 +252,7 @@ COM81.py:293:15: COM812 [*] Trailing comma missing 291 | # ==> multiline_bad_dict.py <== 292 | multiline_bad_dict = { 293 | "bad": 123 - | COM812 + | ^ COM812 294 | } 295 | # ==> multiline_bad_function_def.py <== | @@ -273,7 +273,7 @@ COM81.py:304:14: COM812 [*] Trailing comma missing 302 | def func_bad( 303 | a = 3, 304 | b = 2 - | COM812 + | ^ COM812 305 | ): 306 | pass | @@ -294,7 +294,7 @@ COM81.py:310:14: COM812 [*] Trailing comma missing 308 | # ==> multiline_bad_function_one_param.py <== 309 | def func( 310 | a = 3 - | COM812 + | ^ COM812 311 | ): 312 | pass | @@ -314,7 +314,7 @@ COM81.py:316:10: COM812 [*] Trailing comma missing | 315 | func( 316 | a = 3 - | COM812 + | ^ COM812 317 | ) | = help: Add trailing comma @@ -334,7 +334,7 @@ COM81.py:322:15: COM812 [*] Trailing comma missing 320 | multiline_bad_or_dict = { 321 | "good": True or False, 322 | "bad": 123 - | COM812 + | ^ COM812 323 | } | = help: Add trailing comma @@ -354,7 +354,7 @@ COM81.py:368:15: COM812 [*] Trailing comma missing 366 | multiline_index_access[ 367 | "probably fine", 368 | "not good" - | COM812 + | ^ COM812 369 | ] | = help: Add trailing comma @@ -374,7 +374,7 @@ COM81.py:375:15: COM812 [*] Trailing comma missing 373 | "fine", 374 | : 375 | "not good" - | COM812 + | ^ COM812 376 | ] | = help: Add trailing comma @@ -394,7 +394,7 @@ COM81.py:404:15: COM812 [*] Trailing comma missing 402 | "fine" 403 | : 404 | "not fine" - | COM812 + | ^ COM812 405 | ] | = help: Add trailing comma @@ -414,7 +414,7 @@ COM81.py:432:15: COM812 [*] Trailing comma missing 430 | : 431 | "fine", 432 | "not fine" - | COM812 + | ^ COM812 433 | ] | = help: Add trailing comma @@ -434,7 +434,7 @@ COM81.py:485:21: COM819 [*] Trailing comma prohibited 484 | # ==> prohibited.py <== 485 | foo = ['a', 'b', 'c',] | ^ COM819 -486 | +486 | 487 | bar = { a: b,} | = help: Remove trailing comma @@ -452,10 +452,10 @@ COM81.py:485:21: COM819 [*] Trailing comma prohibited COM81.py:487:13: COM819 [*] Trailing comma prohibited | 485 | foo = ['a', 'b', 'c',] -486 | +486 | 487 | bar = { a: b,} | ^ COM819 -488 | +488 | 489 | def bah(ham, spam,): | = help: Remove trailing comma @@ -473,7 +473,7 @@ COM81.py:487:13: COM819 [*] Trailing comma prohibited COM81.py:489:18: COM819 [*] Trailing comma prohibited | 487 | bar = { a: b,} -488 | +488 | 489 | def bah(ham, spam,): | ^ COM819 490 | pass @@ -493,10 +493,10 @@ COM81.py:489:18: COM819 [*] Trailing comma prohibited COM81.py:494:6: COM819 [*] Trailing comma prohibited | 492 | (0,) -493 | +493 | 494 | (0, 1,) | ^ COM819 -495 | +495 | 496 | foo = ['a', 'b', 'c', ] | = help: Remove trailing comma @@ -514,10 +514,10 @@ COM81.py:494:6: COM819 [*] Trailing comma prohibited COM81.py:496:21: COM819 [*] Trailing comma prohibited | 494 | (0, 1,) -495 | +495 | 496 | foo = ['a', 'b', 'c', ] | ^ COM819 -497 | +497 | 498 | bar = { a: b, } | = help: Remove trailing comma @@ -535,10 +535,10 @@ COM81.py:496:21: COM819 [*] Trailing comma prohibited COM81.py:498:13: COM819 [*] Trailing comma prohibited | 496 | foo = ['a', 'b', 'c', ] -497 | +497 | 498 | bar = { a: b, } | ^ COM819 -499 | +499 | 500 | def bah(ham, spam, ): | = help: Remove trailing comma @@ -556,7 +556,7 @@ COM81.py:498:13: COM819 [*] Trailing comma prohibited COM81.py:500:18: COM819 [*] Trailing comma prohibited | 498 | bar = { a: b, } -499 | +499 | 500 | def bah(ham, spam, ): | ^ COM819 501 | pass @@ -576,10 +576,10 @@ COM81.py:500:18: COM819 [*] Trailing comma prohibited COM81.py:505:6: COM819 [*] Trailing comma prohibited | 503 | (0, ) -504 | +504 | 505 | (0, 1, ) | ^ COM819 -506 | +506 | 507 | image[:, :, 0] | = help: Remove trailing comma @@ -597,10 +597,10 @@ COM81.py:505:6: COM819 [*] Trailing comma prohibited COM81.py:511:10: COM819 [*] Trailing comma prohibited | 509 | image[:,] -510 | +510 | 511 | image[:,:,] | ^ COM819 -512 | +512 | 513 | lambda x, : x | = help: Remove trailing comma @@ -618,10 +618,10 @@ COM81.py:511:10: COM819 [*] Trailing comma prohibited COM81.py:513:9: COM819 [*] Trailing comma prohibited | 511 | image[:,:,] -512 | +512 | 513 | lambda x, : x | ^ COM819 -514 | +514 | 515 | # ==> unpack.py <== | = help: Remove trailing comma @@ -641,7 +641,7 @@ COM81.py:519:13: COM812 [*] Trailing comma missing 517 | foo, 518 | bar, 519 | **kwargs - | COM812 + | ^ COM812 520 | ): 521 | pass | @@ -662,7 +662,7 @@ COM81.py:526:10: COM812 [*] Trailing comma missing 524 | foo, 525 | bar, 526 | *args - | COM812 + | ^ COM812 527 | ): 528 | pass | @@ -683,7 +683,7 @@ COM81.py:534:16: COM812 [*] Trailing comma missing 532 | bar, 533 | *args, 534 | extra_kwarg - | COM812 + | ^ COM812 535 | ): 536 | pass | @@ -704,7 +704,7 @@ COM81.py:541:13: COM812 [*] Trailing comma missing 539 | foo, 540 | bar, 541 | **kwargs - | COM812 + | ^ COM812 542 | ) | = help: Add trailing comma @@ -724,7 +724,7 @@ COM81.py:547:24: COM812 [*] Trailing comma missing 545 | foo, 546 | bar, 547 | **not_called_kwargs - | COM812 + | ^ COM812 548 | ) | = help: Add trailing comma @@ -744,7 +744,7 @@ COM81.py:554:15: COM812 [*] Trailing comma missing 552 | spam, 553 | *args, 554 | kwarg_only - | COM812 + | ^ COM812 555 | ): 556 | pass | @@ -764,7 +764,7 @@ COM81.py:561:13: COM812 [*] Trailing comma missing | 560 | foo( 561 | **kwargs - | COM812 + | ^ COM812 562 | ) | = help: Add trailing comma @@ -783,7 +783,7 @@ COM81.py:565:13: COM812 [*] Trailing comma missing | 564 | { 565 | **kwargs - | COM812 + | ^ COM812 566 | } | = help: Add trailing comma @@ -802,7 +802,7 @@ COM81.py:569:10: COM812 [*] Trailing comma missing | 568 | { 569 | *args - | COM812 + | ^ COM812 570 | } | = help: Add trailing comma @@ -821,7 +821,7 @@ COM81.py:573:10: COM812 [*] Trailing comma missing | 572 | [ 573 | *args - | COM812 + | ^ COM812 574 | ] | = help: Add trailing comma @@ -841,7 +841,7 @@ COM81.py:579:10: COM812 [*] Trailing comma missing 577 | ham, 578 | spam, 579 | *args - | COM812 + | ^ COM812 580 | ): 581 | pass | @@ -862,7 +862,7 @@ COM81.py:586:13: COM812 [*] Trailing comma missing 584 | ham, 585 | spam, 586 | **kwargs - | COM812 + | ^ COM812 587 | ): 588 | pass | @@ -883,7 +883,7 @@ COM81.py:594:15: COM812 [*] Trailing comma missing 592 | spam, 593 | *args, 594 | kwarg_only - | COM812 + | ^ COM812 595 | ): 596 | pass | @@ -904,7 +904,7 @@ COM81.py:623:20: COM812 [*] Trailing comma missing 621 | foo, 622 | bar, 623 | **{'ham': spam} - | COM812 + | ^ COM812 624 | ) | = help: Add trailing comma @@ -924,7 +924,7 @@ COM81.py:628:42: COM812 [*] Trailing comma missing 626 | # Make sure the COM812 and UP034 rules don't fix simultaneously and cause a syntax error. 627 | the_first_one = next( 628 | (i for i in range(10) if i // 2 == 0) # COM812 fix should include the final bracket - | COM812 + | ^ COM812 629 | ) | = help: Add trailing comma @@ -944,7 +944,7 @@ COM81.py:640:46: COM819 [*] Trailing comma prohibited 639 | # F-strings 640 | kwargs.pop("remove", f"this {trailing_comma}",) | ^ COM819 -641 | +641 | 642 | raise Exception( | = help: Remove trailing comma @@ -963,7 +963,7 @@ COM81.py:643:49: COM812 [*] Trailing comma missing | 642 | raise Exception( 643 | "first", extra=f"Add trailing comma here ->" - | COM812 + | ^ COM812 644 | ) | = help: Add trailing comma diff --git a/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81_syntax_error.py.snap b/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81_syntax_error.py.snap index d604355cc684d..580392a4995cb 100644 --- a/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/flake8_commas/snapshots/ruff_linter__rules__flake8_commas__tests__COM81_syntax_error.py.snap @@ -13,7 +13,7 @@ COM81_syntax_error.py:3:5: SyntaxError: Starred expression cannot be used here COM81_syntax_error.py:6:9: SyntaxError: Type parameter list cannot be empty | 4 | ) -5 | +5 | 6 | def foo[(param1='test', param2='test',): | ^ 7 | pass @@ -22,7 +22,7 @@ COM81_syntax_error.py:6:9: SyntaxError: Type parameter list cannot be empty COM81_syntax_error.py:6:38: COM819 Trailing comma prohibited | 4 | ) -5 | +5 | 6 | def foo[(param1='test', param2='test',): | ^ COM819 7 | pass diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/fixes.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/fixes.rs index ae4896f8152b6..b796ff8e95876 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/fixes.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/fixes.rs @@ -1,6 +1,6 @@ use std::iter; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use itertools::Itertools; use libcst_native::{ Arg, AssignEqual, AssignTargetExpression, Call, Comma, Comment, CompFor, Dict, DictComp, @@ -11,16 +11,16 @@ use libcst_native::{ }; use ruff_diagnostics::{Edit, Fix}; -use ruff_python_ast::{self as ast, Expr}; +use ruff_python_ast::{self as ast, Expr, ExprCall}; use ruff_python_codegen::Stylist; use ruff_python_semantic::SemanticModel; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::cst::helpers::{negate, space}; use crate::fix::codemods::CodegenStylist; use crate::fix::edits::pad; use crate::rules::flake8_comprehensions::rules::ObjectType; -use crate::Locator; use crate::{ checkers::ast::Checker, cst::matchers::{ @@ -43,7 +43,10 @@ pub(crate) fn fix_unnecessary_generator_dict(expr: &Expr, checker: &Checker) -> // Extract the (k, v) from `(k, v) for ...`. let generator_exp = match_generator_exp(&arg.value)?; let tuple = match_tuple(&generator_exp.elt)?; - let [Element::Simple { value: key, .. }, Element::Simple { value, .. }] = &tuple.elements[..] + let [ + Element::Simple { value: key, .. }, + Element::Simple { value, .. }, + ] = &tuple.elements[..] else { bail!("Expected tuple to contain two elements"); }; @@ -103,7 +106,10 @@ pub(crate) fn fix_unnecessary_list_comprehension_dict( let tuple = match_tuple(&list_comp.elt)?; - let [Element::Simple { value: key, .. }, Element::Simple { value, .. }] = &tuple.elements[..] + let [ + Element::Simple { value: key, .. }, + Element::Simple { value, .. }, + ] = &tuple.elements[..] else { bail!("Expected tuple with two elements"); }; @@ -295,7 +301,7 @@ pub(crate) fn fix_unnecessary_collection_call( /// Re-formats the given expression for use within a formatted string. /// -/// For example, when converting a `dict` call to a dictionary literal within +/// For example, when converting a `dict()` call to a dictionary literal within /// a formatted string, we might naively generate the following code: /// /// ```python @@ -416,9 +422,17 @@ pub(crate) fn fix_unnecessary_call_around_sorted( } }; + let inner_needs_parens = matches!( + inner_call.whitespace_after_func, + ParenthesizableWhitespace::ParenthesizedWhitespace(_) + ); + if let Expression::Name(outer_name) = &*outer_call.func { if outer_name.value == "list" { tree = Expression::Call(Box::new((*inner_call).clone())); + if inner_needs_parens { + tree = tree.with_parens(LeftParen::default(), RightParen::default()); + } } else { // If the `reverse` argument is used... let args = if inner_call.args.iter().any(|arg| { @@ -503,6 +517,9 @@ pub(crate) fn fix_unnecessary_call_around_sorted( whitespace_after_func: inner_call.whitespace_after_func.clone(), whitespace_before_args: inner_call.whitespace_before_args.clone(), })); + if inner_needs_parens { + tree = tree.with_parens(LeftParen::default(), RightParen::default()); + } } } @@ -638,13 +655,13 @@ pub(crate) fn fix_unnecessary_comprehension( /// (C417) Convert `map(lambda x: x * 2, bar)` to `(x * 2 for x in bar)`. pub(crate) fn fix_unnecessary_map( - expr: &Expr, + call_ast_node: &ExprCall, parent: Option<&Expr>, object_type: ObjectType, locator: &Locator, stylist: &Stylist, ) -> Result<Edit> { - let module_text = locator.slice(expr); + let module_text = locator.slice(call_ast_node); let mut tree = match_expression(module_text)?; let call = match_call_mut(&mut tree)?; @@ -789,7 +806,7 @@ pub(crate) fn fix_unnecessary_map( } } - Ok(Edit::range_replacement(content, expr.range())) + Ok(Edit::range_replacement(content, call_ast_node.range())) } /// (C419) Convert `[i for i in a]` into `i for i in a` @@ -978,6 +995,14 @@ pub(crate) fn fix_unnecessary_comprehension_in_call( _ => whitespace_after_arg, }; + // Remove trailing comma, if any. + // + // This relies on the fact that + // there is only one argument, + // which is already checked beforehand + // by both of this function's callers. + call.args[0].comma = None; + Ok(Fix::unsafe_edit(Edit::range_replacement( tree.codegen_stylist(stylist), expr.range(), diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs index 440dbc183fb9f..e10faf55d56a7 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs @@ -12,8 +12,8 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PreviewMode; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; #[test_case(Rule::UnnecessaryCallAroundSorted, Path::new("C413.py"))] @@ -22,6 +22,7 @@ mod tests { #[test_case(Rule::UnnecessaryComprehensionInCall, Path::new("C419.py"))] #[test_case(Rule::UnnecessaryComprehensionInCall, Path::new("C419_2.py"))] #[test_case(Rule::UnnecessaryDictComprehensionForIterable, Path::new("C420.py"))] + #[test_case(Rule::UnnecessaryDictComprehensionForIterable, Path::new("C420_1.py"))] #[test_case(Rule::UnnecessaryDoubleCastOrProcess, Path::new("C414.py"))] #[test_case(Rule::UnnecessaryGeneratorDict, Path::new("C402.py"))] #[test_case(Rule::UnnecessaryGeneratorList, Path::new("C400.py"))] @@ -35,6 +36,7 @@ mod tests { #[test_case(Rule::UnnecessaryLiteralWithinListCall, Path::new("C410.py"))] #[test_case(Rule::UnnecessaryLiteralWithinTupleCall, Path::new("C409.py"))] #[test_case(Rule::UnnecessaryMap, Path::new("C417.py"))] + #[test_case(Rule::UnnecessaryMap, Path::new("C417_1.py"))] #[test_case(Rule::UnnecessarySubscriptReversal, Path::new("C415.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_call_around_sorted.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_call_around_sorted.rs index 2ce7713b1fe9d..444732b3fb089 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_call_around_sorted.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_call_around_sorted.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -8,20 +8,20 @@ use crate::checkers::ast::Checker; use crate::rules::flake8_comprehensions::fixes; /// ## What it does -/// Checks for unnecessary `list` or `reversed` calls around `sorted` +/// Checks for unnecessary `list()` or `reversed()` calls around `sorted()` /// calls. /// /// ## Why is this bad? -/// It is unnecessary to use `list` around `sorted`, as the latter already +/// It is unnecessary to use `list()` around `sorted()`, as the latter already /// returns a list. /// -/// It is also unnecessary to use `reversed` around `sorted`, as the latter +/// It is also unnecessary to use `reversed()` around `sorted()`, as the latter /// has a `reverse` argument that can be used in lieu of an additional -/// `reversed` call. +/// `reversed()` call. /// -/// In both cases, it's clearer to avoid the redundant call. +/// In both cases, it's clearer and more efficient to avoid the redundant call. /// -/// ## Examples +/// ## Example /// ```python /// reversed(sorted(iterable)) /// ``` @@ -32,33 +32,33 @@ use crate::rules::flake8_comprehensions::fixes; /// ``` /// /// ## Fix safety -/// This rule's fix is marked as unsafe, as `reversed` and `reverse=True` will +/// This rule's fix is marked as unsafe, as `reversed()` and `reverse=True` will /// yield different results in the event of custom sort keys or equality -/// functions. Specifically, `reversed` will reverse the order of the -/// collection, while `sorted` with `reverse=True` will perform a stable +/// functions. Specifically, `reversed()` will reverse the order of the +/// collection, while `sorted()` with `reverse=True` will perform a stable /// reverse sort, which will preserve the order of elements that compare as /// equal. -#[violation] -pub struct UnnecessaryCallAroundSorted { - func: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryCallAroundSorted { + func: UnnecessaryFunction, } impl AlwaysFixableViolation for UnnecessaryCallAroundSorted { #[derive_message_formats] fn message(&self) -> String { let UnnecessaryCallAroundSorted { func } = self; - format!("Unnecessary `{func}` call around `sorted()`") + format!("Unnecessary `{func}()` call around `sorted()`") } fn fix_title(&self) -> String { let UnnecessaryCallAroundSorted { func } = self; - format!("Remove unnecessary `{func}` call") + format!("Remove unnecessary `{func}()` call") } } /// C413 pub(crate) fn unnecessary_call_around_sorted( - checker: &mut Checker, + checker: &Checker, expr: &Expr, outer_func: &Expr, args: &[Expr], @@ -73,27 +73,55 @@ pub(crate) fn unnecessary_call_around_sorted( let Some(outer_func_name) = semantic.resolve_builtin_symbol(outer_func) else { return; }; - if !matches!(outer_func_name, "list" | "reversed") { + let Some(unnecessary_function) = UnnecessaryFunction::try_from_str(outer_func_name) else { return; - } + }; if !semantic.match_builtin_expr(inner_func, "sorted") { return; } let mut diagnostic = Diagnostic::new( UnnecessaryCallAroundSorted { - func: outer_func_name.to_string(), + func: unnecessary_function, }, expr.range(), ); diagnostic.try_set_fix(|| { - Ok(Fix::applicable_edit( - fixes::fix_unnecessary_call_around_sorted(expr, checker.locator(), checker.stylist())?, - if outer_func_name == "reversed" { - Applicability::Unsafe - } else { - Applicability::Safe - }, - )) + let edit = + fixes::fix_unnecessary_call_around_sorted(expr, checker.locator(), checker.stylist())?; + let applicability = match unnecessary_function { + UnnecessaryFunction::List => Applicability::Safe, + UnnecessaryFunction::Reversed => Applicability::Unsafe, + }; + Ok(Fix::applicable_edit(edit, applicability)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum UnnecessaryFunction { + List, + Reversed, +} + +impl UnnecessaryFunction { + fn try_from_str(name: &str) -> Option<Self> { + match name { + "list" => Some(Self::List), + "reversed" => Some(Self::Reversed), + _ => None, + } + } + + const fn as_str(self) -> &'static str { + match self { + Self::List => "list", + Self::Reversed => "reversed", + } + } +} + +impl std::fmt::Display for UnnecessaryFunction { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_collection_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_collection_call.rs index 089892b07eabb..f19dd138b3013 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_collection_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_collection_call.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::{Ranged, TextSize}; @@ -9,7 +9,7 @@ use crate::rules::flake8_comprehensions::fixes::{pad_end, pad_start}; use crate::rules::flake8_comprehensions::settings::Settings; /// ## What it does -/// Checks for unnecessary `dict`, `list` or `tuple` calls that can be +/// Checks for unnecessary `dict()`, `list()` or `tuple()` calls that can be /// rewritten as empty literals. /// /// ## Why is this bad? @@ -17,7 +17,7 @@ use crate::rules::flake8_comprehensions::settings::Settings; /// literal (`{}`). The former is slower because the name `dict` must be /// looked up in the global scope in case it has been rebound. /// -/// ## Examples +/// ## Example /// ```python /// dict() /// dict(a=1, b=2) @@ -39,16 +39,16 @@ use crate::rules::flake8_comprehensions::settings::Settings; /// /// ## Options /// - `lint.flake8-comprehensions.allow-dict-calls-with-keyword-arguments` -#[violation] -pub struct UnnecessaryCollectionCall { - obj_type: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryCollectionCall { + kind: Collection, } impl AlwaysFixableViolation for UnnecessaryCollectionCall { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryCollectionCall { obj_type } = self; - format!("Unnecessary `{obj_type}` call (rewrite as a literal)") + let UnnecessaryCollectionCall { kind } = self; + format!("Unnecessary `{kind}()` call (rewrite as a literal)") } fn fix_title(&self) -> String { @@ -58,7 +58,7 @@ impl AlwaysFixableViolation for UnnecessaryCollectionCall { /// C408 pub(crate) fn unnecessary_collection_call( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, settings: &Settings, ) { @@ -88,12 +88,8 @@ pub(crate) fn unnecessary_collection_call( _ => return, }; - let mut diagnostic = Diagnostic::new( - UnnecessaryCollectionCall { - obj_type: builtin.to_string(), - }, - call.range(), - ); + let mut diagnostic = + Diagnostic::new(UnnecessaryCollectionCall { kind: collection }, call.range()); // Convert `dict()` to `{}`. if call.arguments.keywords.is_empty() { @@ -133,11 +129,28 @@ pub(crate) fn unnecessary_collection_call( }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } +#[derive(Debug, Copy, Clone, PartialEq, Eq)] enum Collection { Tuple, List, Dict, } + +impl Collection { + const fn as_str(self) -> &'static str { + match self { + Self::Dict => "dict", + Self::List => "list", + Self::Tuple => "tuple", + } + } +} + +impl std::fmt::Display for Collection { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension.rs index 409e73c2f0396..9b90fe5009fef 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::comparable::ComparableExpr; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Comprehension, Expr}; +use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -9,13 +9,13 @@ use crate::checkers::ast::Checker; use crate::rules::flake8_comprehensions::fixes; /// ## What it does -/// Checks for unnecessary `dict`, `list`, and `set` comprehension. +/// Checks for unnecessary dict, list, and set comprehension. /// /// ## Why is this bad? -/// It's unnecessary to use a `dict`/`list`/`set` comprehension to build a data structure if the +/// It's unnecessary to use a dict/list/set comprehension to build a data structure if the /// elements are unchanged. Wrap the iterable with `dict()`, `list()`, or `set()` instead. /// -/// ## Examples +/// ## Example /// ```python /// {a: b for a, b in iterable} /// [x for x in iterable] @@ -32,9 +32,9 @@ use crate::rules::flake8_comprehensions::fixes; /// ## Known problems /// /// This rule may produce false positives for dictionary comprehensions that iterate over a mapping. -/// The `dict` constructor behaves differently depending on if it receives a sequence (e.g., a -/// `list`) or a mapping (e.g., a `dict`). When a comprehension iterates over the keys of a mapping, -/// replacing it with a `dict` constructor call will give a different result. +/// The dict constructor behaves differently depending on if it receives a sequence (e.g., a +/// list) or a mapping (e.g., a dict). When a comprehension iterates over the keys of a mapping, +/// replacing it with a `dict()` constructor call will give a different result. /// /// For example: /// @@ -56,38 +56,38 @@ use crate::rules::flake8_comprehensions::fixes; /// Due to the known problem with dictionary comprehensions, this fix is marked as unsafe. /// /// Additionally, this fix may drop comments when rewriting the comprehension. -#[violation] -pub struct UnnecessaryComprehension { - obj_type: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryComprehension { + kind: ComprehensionKind, } impl AlwaysFixableViolation for UnnecessaryComprehension { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryComprehension { obj_type } = self; - format!("Unnecessary `{obj_type}` comprehension (rewrite using `{obj_type}()`)") + let UnnecessaryComprehension { kind } = self; + format!("Unnecessary {kind} comprehension (rewrite using `{kind}()`)") } fn fix_title(&self) -> String { - let UnnecessaryComprehension { obj_type } = self; - format!("Rewrite using `{obj_type}()`") + let UnnecessaryComprehension { kind } = self; + format!("Rewrite using `{kind}()`") } } /// Add diagnostic for C416 based on the expression node id. -fn add_diagnostic(checker: &mut Checker, expr: &Expr) { - let id = match expr { - Expr::ListComp(_) => "list", - Expr::SetComp(_) => "set", - Expr::DictComp(_) => "dict", - _ => return, +fn add_diagnostic(checker: &Checker, expr: &Expr) { + let Some(comprehension_kind) = ComprehensionKind::try_from_expr(expr) else { + return; }; - if !checker.semantic().has_builtin_binding(id) { + if !checker + .semantic() + .has_builtin_binding(comprehension_kind.as_str()) + { return; } let mut diagnostic = Diagnostic::new( UnnecessaryComprehension { - obj_type: id.to_string(), + kind: comprehension_kind, }, expr.range(), ); @@ -95,12 +95,12 @@ fn add_diagnostic(checker: &mut Checker, expr: &Expr) { fixes::fix_unnecessary_comprehension(expr, checker.locator(), checker.stylist()) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// C416 pub(crate) fn unnecessary_dict_comprehension( - checker: &mut Checker, + checker: &Checker, expr: &Expr, key: &Expr, value: &Expr, @@ -115,21 +115,30 @@ pub(crate) fn unnecessary_dict_comprehension( let Expr::Tuple(ast::ExprTuple { elts, .. }) = &generator.target else { return; }; - let [target_key, target_value] = elts.as_slice() else { + let [ + Expr::Name(ast::ExprName { id: target_key, .. }), + Expr::Name(ast::ExprName { + id: target_value, .. + }), + ] = elts.as_slice() + else { return; }; - if ComparableExpr::from(key) != ComparableExpr::from(target_key) { + let Expr::Name(ast::ExprName { id: key, .. }) = &key else { return; - } - if ComparableExpr::from(value) != ComparableExpr::from(target_value) { + }; + let Expr::Name(ast::ExprName { id: value, .. }) = &value else { return; + }; + + if target_key == key && target_value == value { + add_diagnostic(checker, expr); } - add_diagnostic(checker, expr); } /// C416 pub(crate) fn unnecessary_list_set_comprehension( - checker: &mut Checker, + checker: &Checker, expr: &Expr, elt: &Expr, generators: &[Comprehension], @@ -140,8 +149,118 @@ pub(crate) fn unnecessary_list_set_comprehension( if !generator.ifs.is_empty() || generator.is_async { return; } - if ComparableExpr::from(elt) != ComparableExpr::from(&generator.target) { - return; + if is_dict_items(checker, &generator.iter) { + match (&generator.target, elt) { + // [(k, v) for k, v in dict.items()] or [(k, v) for [k, v] in dict.items()] + ( + Expr::Tuple(ast::ExprTuple { + elts: target_elts, .. + }) + | Expr::List(ast::ExprList { + elts: target_elts, .. + }), + Expr::Tuple(ast::ExprTuple { elts, .. }), + ) => { + let [ + Expr::Name(ast::ExprName { id: target_key, .. }), + Expr::Name(ast::ExprName { + id: target_value, .. + }), + ] = target_elts.as_slice() + else { + return; + }; + let [ + Expr::Name(ast::ExprName { id: key, .. }), + Expr::Name(ast::ExprName { id: value, .. }), + ] = elts.as_slice() + else { + return; + }; + if target_key == key && target_value == value { + add_diagnostic(checker, expr); + } + } + // [x for x in dict.items()] + ( + Expr::Name(ast::ExprName { + id: target_name, .. + }), + Expr::Name(ast::ExprName { id: elt_name, .. }), + ) if target_name == elt_name => { + add_diagnostic(checker, expr); + } + _ => {} + } + } else { + // [x for x in iterable] + let Expr::Name(ast::ExprName { + id: target_name, .. + }) = &generator.target + else { + return; + }; + let Expr::Name(ast::ExprName { id: elt_name, .. }) = &elt else { + return; + }; + if elt_name == target_name { + add_diagnostic(checker, expr); + } + } +} + +fn is_dict_items(checker: &Checker, expr: &Expr) -> bool { + let Expr::Call(ast::ExprCall { func, .. }) = expr else { + return false; + }; + + let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func.as_ref() else { + return false; + }; + + if attr.as_str() != "items" { + return false; + } + + let Expr::Name(name) = value.as_ref() else { + return false; + }; + + let Some(id) = checker.semantic().resolve_name(name) else { + return false; + }; + + typing::is_dict(checker.semantic().binding(id), checker.semantic()) +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum ComprehensionKind { + List, + Set, + Dict, +} + +impl ComprehensionKind { + const fn as_str(self) -> &'static str { + match self { + Self::List => "list", + Self::Dict => "dict", + Self::Set => "set", + } + } + + const fn try_from_expr(expr: &Expr) -> Option<Self> { + match expr { + Expr::ListComp(_) => Some(Self::List), + Expr::DictComp(_) => Some(Self::Dict), + Expr::SetComp(_) => Some(Self::Set), + _ => None, + } + } +} + +impl std::fmt::Display for ComprehensionKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) } - add_diagnostic(checker, expr); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension_in_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension_in_call.rs index 12dcb9842c2d8..cc9785d331ccd 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension_in_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_comprehension_in_call.rs @@ -1,11 +1,12 @@ use ruff_diagnostics::{Diagnostic, FixAvailability}; use ruff_diagnostics::{Edit, Fix, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::{self as ast, Expr, Keyword}; use ruff_text_size::{Ranged, TextSize}; use crate::checkers::ast::Checker; +use crate::preview::is_comprehension_with_min_max_sum_enabled; use crate::rules::flake8_comprehensions::fixes; /// ## What it does @@ -41,7 +42,7 @@ use crate::rules::flake8_comprehensions::fixes; /// short-circuiting it may not improve performance. (It may even slightly regress performance, /// though the difference will usually be small.) /// -/// ## Examples +/// ## Example /// ```python /// any([x.id for x in bar]) /// all([x.id for x in bar]) @@ -65,8 +66,8 @@ use crate::rules::flake8_comprehensions::fixes; /// rewriting some comprehensions. /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct UnnecessaryComprehensionInCall { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryComprehensionInCall { comprehension_kind: ComprehensionKind, } @@ -76,8 +77,8 @@ impl Violation for UnnecessaryComprehensionInCall { #[derive_message_formats] fn message(&self) -> String { match self.comprehension_kind { - ComprehensionKind::List => format!("Unnecessary list comprehension"), - ComprehensionKind::Set => format!("Unnecessary set comprehension"), + ComprehensionKind::List => "Unnecessary list comprehension".to_string(), + ComprehensionKind::Set => "Unnecessary set comprehension".to_string(), } } @@ -88,7 +89,7 @@ impl Violation for UnnecessaryComprehensionInCall { /// C419 pub(crate) fn unnecessary_comprehension_in_call( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -125,7 +126,7 @@ pub(crate) fn unnecessary_comprehension_in_call( if !(matches!( builtin_function, SupportedBuiltins::Any | SupportedBuiltins::All - ) || (checker.settings.preview.is_enabled() + ) || (is_comprehension_with_min_max_sum_enabled(checker.settings) && matches!( builtin_function, SupportedBuiltins::Sum | SupportedBuiltins::Min | SupportedBuiltins::Max @@ -174,7 +175,7 @@ pub(crate) fn unnecessary_comprehension_in_call( diagnostic.set_fix(Fix::unsafe_edits(collection_start, [collection_end])); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Return `true` if the [`Expr`] contains an `await` expression. diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_dict_comprehension_for_iterable.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_dict_comprehension_for_iterable.rs index 67cf7e96c7e34..e2662ca130219 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_dict_comprehension_for_iterable.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_dict_comprehension_for_iterable.rs @@ -1,6 +1,6 @@ use ast::ExprName; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::{self as ast, Arguments, Comprehension, Expr, ExprCall, ExprContext}; @@ -9,17 +9,17 @@ use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; /// ## What it does -/// Checks for unnecessary `dict` comprehension when creating a dictionary from +/// Checks for unnecessary dict comprehension when creating a dictionary from /// an iterable. /// /// ## Why is this bad? -/// It's unnecessary to use a `dict` comprehension to build a dictionary from +/// It's unnecessary to use a dict comprehension to build a dictionary from /// an iterable when the value is static. /// /// Prefer `dict.fromkeys(iterable)` over `{value: None for value in iterable}`, /// as `dict.fromkeys` is more readable and efficient. /// -/// ## Examples +/// ## Example /// ```python /// {a: None for a in iterable} /// {a: 1 for a in iterable} @@ -30,8 +30,11 @@ use crate::checkers::ast::Checker; /// dict.fromkeys(iterable) /// dict.fromkeys(iterable, 1) /// ``` -#[violation] -pub struct UnnecessaryDictComprehensionForIterable { +/// +/// ## References +/// - [Python documentation: `dict.fromkeys`](https://docs.python.org/3/library/stdtypes.html#dict.fromkeys) +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDictComprehensionForIterable { is_value_none_literal: bool, } @@ -40,21 +43,22 @@ impl Violation for UnnecessaryDictComprehensionForIterable { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary dict comprehension for iterable; use `dict.fromkeys` instead") + "Unnecessary dict comprehension for iterable; use `dict.fromkeys` instead".to_string() } fn fix_title(&self) -> Option<String> { - if self.is_value_none_literal { - Some(format!("Replace with `dict.fromkeys(iterable, value)`)")) + let title = if self.is_value_none_literal { + "Replace with `dict.fromkeys(iterable, value)`)" } else { - Some(format!("Replace with `dict.fromkeys(iterable)`)")) - } + "Replace with `dict.fromkeys(iterable)`)" + }; + Some(title.to_string()) } } -/// RUF025 +/// C420 pub(crate) fn unnecessary_dict_comprehension_for_iterable( - checker: &mut Checker, + checker: &Checker, dict_comp: &ast::ExprDictComp, ) { let [generator] = dict_comp.generators.as_slice() else { @@ -95,6 +99,14 @@ pub(crate) fn unnecessary_dict_comprehension_for_iterable( let binding = checker.semantic().binding(id); + // Builtin bindings have a range of 0..0, and are never + // defined within the comprehension, so we abort before + // checking the range overlap below. Note this only matters + // if the comprehension appears at the top of the file! + if binding.kind.is_builtin() { + return false; + } + dict_comp.range().contains_range(binding.range()) }); if self_referential { @@ -120,7 +132,7 @@ pub(crate) fn unnecessary_dict_comprehension_for_iterable( ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns `true` if the expression can be shared across multiple values. @@ -151,7 +163,7 @@ fn is_constant_like(expr: &Expr) -> bool { }) } -/// Generate a [`Fix`] to replace `dict` comprehension with `dict.fromkeys`. +/// Generate a [`Fix`] to replace a dict comprehension with `dict.fromkeys`. /// /// For example: /// - Given `{n: None for n in [1,2,3]}`, generate `dict.fromkeys([1,2,3])`. diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_double_cast_or_process.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_double_cast_or_process.rs index 2be956db390ad..07a9daf1189b0 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_double_cast_or_process.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_double_cast_or_process.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableKeyword; use ruff_python_ast::{self as ast, Arguments, Expr, Keyword}; use ruff_text_size::Ranged; @@ -9,15 +9,15 @@ use crate::checkers::ast::Checker; use crate::rules::flake8_comprehensions::fixes; /// ## What it does -/// Checks for unnecessary `list`, `reversed`, `set`, `sorted`, and `tuple` -/// call within `list`, `set`, `sorted`, and `tuple` calls. +/// Checks for unnecessary `list()`, `reversed()`, `set()`, `sorted()`, and +/// `tuple()` call within `list()`, `set()`, `sorted()`, and `tuple()` calls. /// /// ## Why is this bad? /// It's unnecessary to double-cast or double-process iterables by wrapping -/// the listed functions within an additional `list`, `set`, `sorted`, or -/// `tuple` call. Doing so is redundant and can be confusing for readers. +/// the listed functions within an additional `list()`, `set()`, `sorted()`, or +/// `tuple()` call. Doing so is redundant and can be confusing for readers. /// -/// ## Examples +/// ## Example /// ```python /// list(tuple(iterable)) /// ``` @@ -27,8 +27,8 @@ use crate::rules::flake8_comprehensions::fixes; /// list(iterable) /// ``` /// -/// This rule applies to a variety of functions, including `list`, `reversed`, -/// `set`, `sorted`, and `tuple`. For example: +/// This rule applies to a variety of functions, including `list()`, `reversed()`, +/// `set()`, `sorted()`, and `tuple()`. For example: /// /// - Instead of `list(list(iterable))`, use `list(iterable)`. /// - Instead of `list(tuple(iterable))`, use `list(iterable)`. @@ -47,8 +47,8 @@ use crate::rules::flake8_comprehensions::fixes; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryDoubleCastOrProcess { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDoubleCastOrProcess { inner: String, outer: String, } @@ -57,18 +57,18 @@ impl AlwaysFixableViolation for UnnecessaryDoubleCastOrProcess { #[derive_message_formats] fn message(&self) -> String { let UnnecessaryDoubleCastOrProcess { inner, outer } = self; - format!("Unnecessary `{inner}` call within `{outer}()`") + format!("Unnecessary `{inner}()` call within `{outer}()`") } fn fix_title(&self) -> String { let UnnecessaryDoubleCastOrProcess { inner, .. } = self; - format!("Remove the inner `{inner}` call") + format!("Remove the inner `{inner}()` call") } } /// C414 pub(crate) fn unnecessary_double_cast_or_process( - checker: &mut Checker, + checker: &Checker, expr: &Expr, outer_func: &Expr, args: &[Expr], @@ -140,6 +140,6 @@ pub(crate) fn unnecessary_double_cast_or_process( ) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_dict.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_dict.rs index 9d368a3da07b2..644d5123a0501 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_dict.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_dict.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Keyword}; use ruff_text_size::Ranged; @@ -10,15 +10,15 @@ use crate::rules::flake8_comprehensions::fixes; use super::helpers; /// ## What it does -/// Checks for unnecessary generators that can be rewritten as `dict` +/// Checks for unnecessary generators that can be rewritten as dict /// comprehensions. /// /// ## Why is this bad? -/// It is unnecessary to use `dict` around a generator expression, since +/// It is unnecessary to use `dict()` around a generator expression, since /// there are equivalent comprehensions for these types. Using a /// comprehension is clearer and more idiomatic. /// -/// ## Examples +/// ## Example /// ```python /// dict((x, f(x)) for x in foo) /// ``` @@ -31,23 +31,23 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryGeneratorDict; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryGeneratorDict; impl AlwaysFixableViolation for UnnecessaryGeneratorDict { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary generator (rewrite as a `dict` comprehension)") + "Unnecessary generator (rewrite as a dict comprehension)".to_string() } fn fix_title(&self) -> String { - "Rewrite as a `dict` comprehension".to_string() + "Rewrite as a dict comprehension".to_string() } } /// C402 (`dict((x, y) for x, y in iterable)`) pub(crate) fn unnecessary_generator_dict( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -73,5 +73,5 @@ pub(crate) fn unnecessary_generator_dict( let mut diagnostic = Diagnostic::new(UnnecessaryGeneratorDict, expr.range()); diagnostic .try_set_fix(|| fixes::fix_unnecessary_generator_dict(expr, checker).map(Fix::unsafe_edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_list.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_list.rs index 8f9769583931b..ecf69a07e002a 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_list.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_list.rs @@ -1,21 +1,22 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; +use ruff_python_ast::ExprGenerator; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_python_ast::ExprGenerator; -use ruff_text_size::{Ranged, TextSize}; +use ruff_python_parser::TokenKind; +use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::Checker; use super::helpers; /// ## What it does -/// Checks for unnecessary generators that can be rewritten as `list` -/// comprehensions (or with `list` directly). +/// Checks for unnecessary generators that can be rewritten as list +/// comprehensions (or with `list()` directly). /// /// ## Why is this bad? -/// It is unnecessary to use `list` around a generator expression, since +/// It is unnecessary to use `list()` around a generator expression, since /// there are equivalent comprehensions for these types. Using a /// comprehension is clearer and more idiomatic. /// @@ -23,7 +24,7 @@ use super::helpers; /// `list(x for x in foo)`, it's better to use `list(foo)` directly, since it's /// even more direct. /// -/// ## Examples +/// ## Example /// ```python /// list(f(x) for x in foo) /// list(x for x in foo) @@ -40,8 +41,8 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryGeneratorList { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryGeneratorList { short_circuit: bool, } @@ -49,9 +50,9 @@ impl AlwaysFixableViolation for UnnecessaryGeneratorList { #[derive_message_formats] fn message(&self) -> String { if self.short_circuit { - format!("Unnecessary generator (rewrite using `list()`)") + "Unnecessary generator (rewrite using `list()`)".to_string() } else { - format!("Unnecessary generator (rewrite as a `list` comprehension)") + "Unnecessary generator (rewrite as a list comprehension)".to_string() } } @@ -59,13 +60,13 @@ impl AlwaysFixableViolation for UnnecessaryGeneratorList { if self.short_circuit { "Rewrite using `list()`".to_string() } else { - "Rewrite as a `list` comprehension".to_string() + "Rewrite as a list comprehension".to_string() } } } /// C400 (`list(generator)`) -pub(crate) fn unnecessary_generator_list(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_generator_list(checker: &Checker, call: &ast::ExprCall) { let Some(argument) = helpers::exactly_one_argument_with_matching_function( "list", &call.func, @@ -74,49 +75,47 @@ pub(crate) fn unnecessary_generator_list(checker: &mut Checker, call: &ast::Expr ) else { return; }; - if !checker.semantic().has_builtin_binding("list") { - return; - } - let Some(ExprGenerator { + let ast::Expr::Generator(ExprGenerator { elt, generators, parenthesized, .. - }) = argument.as_generator_expr() + }) = argument else { return; }; + if !checker.semantic().has_builtin_binding("list") { + return; + } + // Short-circuit: given `list(x for x in y)`, generate `list(y)` (in lieu of `[x for x in y]`). if let [generator] = generators.as_slice() { if generator.ifs.is_empty() && !generator.is_async { if ComparableExpr::from(elt) == ComparableExpr::from(&generator.target) { - let mut diagnostic = Diagnostic::new( + let diagnostic = Diagnostic::new( UnnecessaryGeneratorList { short_circuit: true, }, call.range(), ); let iterator = format!("list({})", checker.locator().slice(generator.iter.range())); - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - iterator, - call.range(), - ))); - checker.diagnostics.push(diagnostic); + let fix = Fix::unsafe_edit(Edit::range_replacement(iterator, call.range())); + checker.report_diagnostic(diagnostic.with_fix(fix)); return; } } } // Convert `list(f(x) for x in y)` to `[f(x) for x in y]`. - let mut diagnostic = Diagnostic::new( + let diagnostic = Diagnostic::new( UnnecessaryGeneratorList { short_circuit: false, }, call.range(), ); - diagnostic.set_fix({ + let fix = { // Replace `list(` with `[`. let call_start = Edit::replacement( "[".to_string(), @@ -125,11 +124,16 @@ pub(crate) fn unnecessary_generator_list(checker: &mut Checker, call: &ast::Expr ); // Replace `)` with `]`. - let call_end = Edit::replacement( - "]".to_string(), - call.arguments.end() - TextSize::from(1), - call.end(), - ); + // Place `]` at argument's end or at trailing comma if present + let after_arg_tokens = checker + .tokens() + .in_range(TextRange::new(argument.end(), call.end())); + let right_bracket_loc = after_arg_tokens + .iter() + .find(|token| token.kind() == TokenKind::Comma) + .map_or(call.arguments.end(), Ranged::end) + - TextSize::from(1); + let call_end = Edit::replacement("]".to_string(), right_bracket_loc, call.end()); // Remove the inner parentheses, if the expression is a generator. The easiest way to do // this reliably is to use the printer. @@ -153,7 +157,6 @@ pub(crate) fn unnecessary_generator_list(checker: &mut Checker, call: &ast::Expr } else { Fix::unsafe_edits(call_start, [call_end]) } - }); - - checker.diagnostics.push(diagnostic); + }; + checker.report_diagnostic(diagnostic.with_fix(fix)); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_set.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_set.rs index 2a69d993b5a00..1f2227087f991 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_set.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_generator_set.rs @@ -1,9 +1,11 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::ExprGenerator; -use ruff_text_size::{Ranged, TextSize}; +use ruff_python_ast::comparable::ComparableExpr; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_parser::TokenKind; +use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::Checker; use crate::rules::flake8_comprehensions::fixes::{pad_end, pad_start}; @@ -11,8 +13,8 @@ use crate::rules::flake8_comprehensions::fixes::{pad_end, pad_start}; use super::helpers; /// ## What it does -/// Checks for unnecessary generators that can be rewritten as `set` -/// comprehensions (or with `set` directly). +/// Checks for unnecessary generators that can be rewritten as set +/// comprehensions (or with `set()` directly). /// /// ## Why is this bad? /// It is unnecessary to use `set` around a generator expression, since @@ -23,23 +25,25 @@ use super::helpers; /// `set(x for x in foo)`, it's better to use `set(foo)` directly, since it's /// even more direct. /// -/// ## Examples +/// ## Example /// ```python /// set(f(x) for x in foo) /// set(x for x in foo) +/// set((x for x in foo)) /// ``` /// /// Use instead: /// ```python /// {f(x) for x in foo} /// set(foo) +/// set(foo) /// ``` /// /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryGeneratorSet { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryGeneratorSet { short_circuit: bool, } @@ -47,9 +51,9 @@ impl AlwaysFixableViolation for UnnecessaryGeneratorSet { #[derive_message_formats] fn message(&self) -> String { if self.short_circuit { - format!("Unnecessary generator (rewrite using `set()`)") + "Unnecessary generator (rewrite using `set()`)".to_string() } else { - format!("Unnecessary generator (rewrite as a `set` comprehension)") + "Unnecessary generator (rewrite as a set comprehension)".to_string() } } @@ -57,13 +61,13 @@ impl AlwaysFixableViolation for UnnecessaryGeneratorSet { if self.short_circuit { "Rewrite using `set()`".to_string() } else { - "Rewrite as a `set` comprehension".to_string() + "Rewrite as a set comprehension".to_string() } } } /// C401 (`set(generator)`) -pub(crate) fn unnecessary_generator_set(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_generator_set(checker: &Checker, call: &ast::ExprCall) { let Some(argument) = helpers::exactly_one_argument_with_matching_function( "set", &call.func, @@ -72,16 +76,19 @@ pub(crate) fn unnecessary_generator_set(checker: &mut Checker, call: &ast::ExprC ) else { return; }; - if !checker.semantic().has_builtin_binding("set") { - return; - } - let Some(ExprGenerator { - elt, generators, .. - }) = argument.as_generator_expr() + let ast::Expr::Generator(ExprGenerator { + elt, + generators, + parenthesized, + .. + }) = argument else { return; }; + if !checker.semantic().has_builtin_binding("set") { + return; + } // Short-circuit: given `set(x for x in y)`, generate `set(y)` (in lieu of `{x for x in y}`). if let [generator] = generators.as_slice() { @@ -98,20 +105,20 @@ pub(crate) fn unnecessary_generator_set(checker: &mut Checker, call: &ast::ExprC iterator, call.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); return; } } } // Convert `set(f(x) for x in y)` to `{f(x) for x in y}`. - let mut diagnostic = Diagnostic::new( + let diagnostic = Diagnostic::new( UnnecessaryGeneratorSet { short_circuit: false, }, call.range(), ); - diagnostic.set_fix({ + let fix = { // Replace `set(` with `}`. let call_start = Edit::replacement( pad_start("{", call.range(), checker.locator(), checker.semantic()), @@ -120,14 +127,43 @@ pub(crate) fn unnecessary_generator_set(checker: &mut Checker, call: &ast::ExprC ); // Replace `)` with `}`. + // Place `}` at argument's end or at trailing comma if present + let after_arg_tokens = checker + .tokens() + .in_range(TextRange::new(argument.end(), call.end())); + let right_brace_loc = after_arg_tokens + .iter() + .find(|token| token.kind() == TokenKind::Comma) + .map_or(call.arguments.end(), Ranged::end) + - TextSize::from(1); let call_end = Edit::replacement( pad_end("}", call.range(), checker.locator(), checker.semantic()), - call.arguments.end() - TextSize::from(1), + right_brace_loc, call.end(), ); - Fix::unsafe_edits(call_start, [call_end]) - }); + // Remove the inner parentheses, if the expression is a generator. The easiest way to do + // this reliably is to use the printer. + if *parenthesized { + // The generator's range will include the innermost parentheses, but it could be + // surrounded by additional parentheses. + let range = parenthesized_range( + argument.into(), + (&call.arguments).into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or(argument.range()); + + // The generator always parenthesizes the expression; trim the parentheses. + let generator = checker.generator().expr(argument); + let generator = generator[1..generator.len() - 1].to_string(); - checker.diagnostics.push(diagnostic); + let replacement = Edit::range_replacement(generator, range); + Fix::unsafe_edits(call_start, [call_end, replacement]) + } else { + Fix::unsafe_edits(call_start, [call_end]) + } + }; + checker.report_diagnostic(diagnostic.with_fix(fix)); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_call.rs index e048ff7a1a096..62a7f5e11b38a 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_call.rs @@ -1,7 +1,7 @@ -use ruff_python_ast::Expr; +use ruff_python_ast::{Arguments, Expr, ExprCall}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -11,12 +11,12 @@ use crate::rules::flake8_comprehensions::fixes; use super::helpers; /// ## What it does -/// Checks for unnecessary `list` calls around list comprehensions. +/// Checks for unnecessary `list()` calls around list comprehensions. /// /// ## Why is this bad? -/// It is redundant to use a `list` call around a list comprehension. +/// It is redundant to use a `list()` call around a list comprehension. /// -/// ## Examples +/// ## Example /// ```python /// list([f(x) for x in foo]) /// ``` @@ -29,34 +29,49 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryListCall; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryListCall; impl AlwaysFixableViolation for UnnecessaryListCall { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary `list` call (remove the outer call to `list()`)") + "Unnecessary `list()` call (remove the outer call to `list()`)".to_string() } fn fix_title(&self) -> String { - "Remove outer `list` call".to_string() + "Remove outer `list()` call".to_string() } } /// C411 -pub(crate) fn unnecessary_list_call( - checker: &mut Checker, - expr: &Expr, - func: &Expr, - args: &[Expr], -) { +pub(crate) fn unnecessary_list_call(checker: &Checker, expr: &Expr, call: &ExprCall) { + let ExprCall { + func, + arguments, + range: _, + } = call; + + if !arguments.keywords.is_empty() { + return; + } + + if arguments.args.len() > 1 { + return; + } + + let Arguments { + range: _, + args, + keywords: _, + } = arguments; + let Some(argument) = helpers::first_argument_with_matching_function("list", func, args) else { return; }; - if !checker.semantic().has_builtin_binding("list") { + if !argument.is_list_comp_expr() { return; } - if !argument.is_list_comp_expr() { + if !checker.semantic().has_builtin_binding("list") { return; } let mut diagnostic = Diagnostic::new(UnnecessaryListCall, expr.range()); @@ -64,5 +79,5 @@ pub(crate) fn unnecessary_list_call( fixes::fix_unnecessary_list_call(expr, checker.locator(), checker.stylist()) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_dict.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_dict.rs index ef109a8f174d9..6ea0f907a9a47 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_dict.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_dict.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Keyword}; use ruff_text_size::Ranged; @@ -13,10 +13,10 @@ use super::helpers; /// Checks for unnecessary list comprehensions. /// /// ## Why is this bad? -/// It's unnecessary to use a list comprehension inside a call to `dict`, +/// It's unnecessary to use a list comprehension inside a call to `dict()`, /// since there is an equivalent comprehension for this type. /// -/// ## Examples +/// ## Example /// ```python /// dict([(x, f(x)) for x in foo]) /// ``` @@ -29,23 +29,23 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryListComprehensionDict; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryListComprehensionDict; impl AlwaysFixableViolation for UnnecessaryListComprehensionDict { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary `list` comprehension (rewrite as a `dict` comprehension)") + "Unnecessary list comprehension (rewrite as a dict comprehension)".to_string() } fn fix_title(&self) -> String { - "Rewrite as a `dict` comprehension".to_string() + "Rewrite as a dict comprehension".to_string() } } /// C404 (`dict([...])`) pub(crate) fn unnecessary_list_comprehension_dict( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -56,9 +56,6 @@ pub(crate) fn unnecessary_list_comprehension_dict( else { return; }; - if !checker.semantic().has_builtin_binding("dict") { - return; - } let Expr::ListComp(ast::ExprListComp { elt, .. }) = argument else { return; }; @@ -68,9 +65,12 @@ pub(crate) fn unnecessary_list_comprehension_dict( if tuple.len() != 2 { return; } + if !checker.semantic().has_builtin_binding("dict") { + return; + } let mut diagnostic = Diagnostic::new(UnnecessaryListComprehensionDict, expr.range()); diagnostic.try_set_fix(|| { fixes::fix_unnecessary_list_comprehension_dict(expr, checker).map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_set.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_set.rs index c990d3239a643..c0f8b29643ff4 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_set.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_list_comprehension_set.rs @@ -1,7 +1,9 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_text_size::{Ranged, TextSize}; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_parser::TokenKind; +use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::Checker; use crate::rules::flake8_comprehensions::fixes::{pad_end, pad_start}; @@ -12,10 +14,10 @@ use super::helpers; /// Checks for unnecessary list comprehensions. /// /// ## Why is this bad? -/// It's unnecessary to use a list comprehension inside a call to `set`, +/// It's unnecessary to use a list comprehension inside a call to `set()`, /// since there is an equivalent comprehension for this type. /// -/// ## Examples +/// ## Example /// ```python /// set([f(x) for x in foo]) /// ``` @@ -28,22 +30,22 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryListComprehensionSet; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryListComprehensionSet; impl AlwaysFixableViolation for UnnecessaryListComprehensionSet { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary `list` comprehension (rewrite as a `set` comprehension)") + "Unnecessary list comprehension (rewrite as a set comprehension)".to_string() } fn fix_title(&self) -> String { - "Rewrite as a `set` comprehension".to_string() + "Rewrite as a set comprehension".to_string() } } /// C403 (`set([...])`) -pub(crate) fn unnecessary_list_comprehension_set(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_list_comprehension_set(checker: &Checker, call: &ast::ExprCall) { let Some(argument) = helpers::exactly_one_argument_with_matching_function( "set", &call.func, @@ -55,32 +57,48 @@ pub(crate) fn unnecessary_list_comprehension_set(checker: &mut Checker, call: &a if !checker.semantic().has_builtin_binding("set") { return; } - if argument.is_list_comp_expr() { - let mut diagnostic = Diagnostic::new(UnnecessaryListComprehensionSet, call.range()); - diagnostic.set_fix({ - // Replace `set(` with `{`. - let call_start = Edit::replacement( - pad_start("{", call.range(), checker.locator(), checker.semantic()), - call.start(), - call.arguments.start() + TextSize::from(1), - ); + if !argument.is_list_comp_expr() { + return; + } + let diagnostic = Diagnostic::new(UnnecessaryListComprehensionSet, call.range()); + let one = TextSize::from(1); - // Replace `)` with `}`. - let call_end = Edit::replacement( - pad_end("}", call.range(), checker.locator(), checker.semantic()), - call.arguments.end() - TextSize::from(1), - call.end(), - ); + // Replace `set(` with `{`. + let call_start = Edit::replacement( + pad_start("{", call.range(), checker.locator(), checker.semantic()), + call.start(), + call.arguments.start() + one, + ); - // Delete the open bracket (`[`). - let argument_start = - Edit::deletion(argument.start(), argument.start() + TextSize::from(1)); + // Replace `)` with `}`. + // Place `}` at argument's end or at trailing comma if present + let after_arg_tokens = checker + .tokens() + .in_range(TextRange::new(argument.end(), call.end())); + let right_brace_loc = after_arg_tokens + .iter() + .find(|token| token.kind() == TokenKind::Comma) + .map_or(call.arguments.end() - one, |comma| comma.end() - one); - // Delete the close bracket (`]`). - let argument_end = Edit::deletion(argument.end() - TextSize::from(1), argument.end()); + let call_end = Edit::replacement( + pad_end("}", call.range(), checker.locator(), checker.semantic()), + right_brace_loc, + call.end(), + ); - Fix::unsafe_edits(call_start, [argument_start, argument_end, call_end]) - }); - checker.diagnostics.push(diagnostic); - } + // If the list comprehension is parenthesized, remove the parentheses in addition to + // removing the brackets. + let replacement_range = parenthesized_range( + argument.into(), + (&call.arguments).into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or_else(|| argument.range()); + + let span = argument.range().add_start(one).sub_end(one); + let replacement = + Edit::range_replacement(checker.source()[span].to_string(), replacement_range); + let fix = Fix::unsafe_edits(call_start, [call_end, replacement]); + checker.report_diagnostic(diagnostic.with_fix(fix)); } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_dict.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_dict.rs index d7a6032b58a61..111a5f8e5feef 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_dict.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_dict.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Keyword}; use ruff_text_size::Ranged; @@ -10,13 +10,13 @@ use crate::rules::flake8_comprehensions::fixes; use super::helpers; /// ## What it does -/// Checks for unnecessary `list` or `tuple` literals. +/// Checks for unnecessary list or tuple literals. /// /// ## Why is this bad? -/// It's unnecessary to use a list or tuple literal within a call to `dict`. +/// It's unnecessary to use a list or tuple literal within a call to `dict()`. /// It can be rewritten as a dict literal (`{}`). /// -/// ## Examples +/// ## Example /// ```python /// dict([(1, 2), (3, 4)]) /// dict(((1, 2), (3, 4))) @@ -33,26 +33,26 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryLiteralDict { - obj_type: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralDict { + obj_type: LiteralKind, } impl AlwaysFixableViolation for UnnecessaryLiteralDict { #[derive_message_formats] fn message(&self) -> String { let UnnecessaryLiteralDict { obj_type } = self; - format!("Unnecessary `{obj_type}` literal (rewrite as a `dict` literal)") + format!("Unnecessary {obj_type} literal (rewrite as a dict literal)") } fn fix_title(&self) -> String { - "Rewrite as a `dict` literal".to_string() + "Rewrite as a dict literal".to_string() } } /// C406 (`dict([(1, 2)])`) pub(crate) fn unnecessary_literal_dict( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -63,12 +63,9 @@ pub(crate) fn unnecessary_literal_dict( else { return; }; - if !checker.semantic().has_builtin_binding("dict") { - return; - } let (kind, elts) = match argument { - Expr::Tuple(ast::ExprTuple { elts, .. }) => ("tuple", elts), - Expr::List(ast::ExprList { elts, .. }) => ("list", elts), + Expr::Tuple(ast::ExprTuple { elts, .. }) => (LiteralKind::Tuple, elts), + Expr::List(ast::ExprList { elts, .. }) => (LiteralKind::List, elts), _ => return, }; // Accept `dict((1, 2), ...))` `dict([(1, 2), ...])`. @@ -78,13 +75,32 @@ pub(crate) fn unnecessary_literal_dict( { return; } - let mut diagnostic = Diagnostic::new( - UnnecessaryLiteralDict { - obj_type: kind.to_string(), - }, - expr.range(), - ); + if !checker.semantic().has_builtin_binding("dict") { + return; + } + let mut diagnostic = Diagnostic::new(UnnecessaryLiteralDict { obj_type: kind }, expr.range()); diagnostic .try_set_fix(|| fixes::fix_unnecessary_literal_dict(expr, checker).map(Fix::unsafe_edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum LiteralKind { + Tuple, + List, +} + +impl LiteralKind { + const fn as_str(self) -> &'static str { + match self { + Self::Tuple => "tuple", + Self::List => "list", + } + } +} + +impl std::fmt::Display for LiteralKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_set.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_set.rs index 445de6658f82d..2f9ee5bc08256 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_set.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_set.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::{Ranged, TextSize}; @@ -9,14 +9,14 @@ use crate::rules::flake8_comprehensions::fixes::{pad_end, pad_start}; use super::helpers; /// ## What it does -/// Checks for `set` calls that take unnecessary `list` or `tuple` literals +/// Checks for `set()` calls that take unnecessary list or tuple literals /// as arguments. /// /// ## Why is this bad? -/// It's unnecessary to use a list or tuple literal within a call to `set`. +/// It's unnecessary to use a list or tuple literal within a call to `set()`. /// Instead, the expression can be rewritten as a set literal. /// -/// ## Examples +/// ## Example /// ```python /// set([1, 2]) /// set((1, 2)) @@ -33,25 +33,25 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryLiteralSet { - obj_type: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralSet { + kind: UnnecessaryLiteral, } impl AlwaysFixableViolation for UnnecessaryLiteralSet { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryLiteralSet { obj_type } = self; - format!("Unnecessary `{obj_type}` literal (rewrite as a `set` literal)") + let UnnecessaryLiteralSet { kind } = self; + format!("Unnecessary {kind} literal (rewrite as a set literal)") } fn fix_title(&self) -> String { - "Rewrite as a `set` literal".to_string() + "Rewrite as a set literal".to_string() } } /// C405 (`set([1, 2])`) -pub(crate) fn unnecessary_literal_set(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_literal_set(checker: &Checker, call: &ast::ExprCall) { let Some(argument) = helpers::exactly_one_argument_with_matching_function( "set", &call.func, @@ -60,21 +60,14 @@ pub(crate) fn unnecessary_literal_set(checker: &mut Checker, call: &ast::ExprCal ) else { return; }; + let Some(kind) = UnnecessaryLiteral::try_from_expr(argument) else { + return; + }; if !checker.semantic().has_builtin_binding("set") { return; } - let kind = match argument { - Expr::List(_) => "list", - Expr::Tuple(_) => "tuple", - _ => return, - }; - let mut diagnostic = Diagnostic::new( - UnnecessaryLiteralSet { - obj_type: kind.to_string(), - }, - call.range(), - ); + let mut diagnostic = Diagnostic::new(UnnecessaryLiteralSet { kind }, call.range()); // Convert `set((1, 2))` to `{1, 2}`. diagnostic.set_fix({ @@ -132,5 +125,34 @@ pub(crate) fn unnecessary_literal_set(checker: &mut Checker, call: &ast::ExprCal } }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum UnnecessaryLiteral { + List, + Tuple, +} + +impl UnnecessaryLiteral { + const fn try_from_expr(expr: &Expr) -> Option<Self> { + match expr { + Expr::List(_) => Some(Self::List), + Expr::Tuple(_) => Some(Self::Tuple), + _ => None, + } + } + + const fn as_str(self) -> &'static str { + match self { + Self::Tuple => "tuple", + Self::List => "list", + } + } +} + +impl std::fmt::Display for UnnecessaryLiteral { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_dict_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_dict_call.rs index 2b18ee8833664..710e790e34ff9 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_dict_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_dict_call.rs @@ -3,37 +3,23 @@ use std::fmt; use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use super::helpers; -#[derive(Debug, PartialEq, Eq)] -pub(crate) enum DictKind { - Literal, - Comprehension, -} - -impl fmt::Display for DictKind { - fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { - match self { - DictKind::Literal => fmt.write_str("literal"), - DictKind::Comprehension => fmt.write_str("comprehension"), - } - } -} - /// ## What it does -/// Checks for `dict` calls that take unnecessary `dict` literals or `dict` +/// Checks for `dict()` calls that take unnecessary dict literals or dict /// comprehensions as arguments. /// /// ## Why is this bad? -/// It's unnecessary to wrap a `dict` literal or comprehension within a `dict` -/// call, since the literal or comprehension syntax already returns a `dict`. +/// It's unnecessary to wrap a dict literal or comprehension within a `dict()` +/// call, since the literal or comprehension syntax already returns a +/// dictionary. /// -/// ## Examples +/// ## Example /// ```python /// dict({}) /// dict({"a": 1}) @@ -48,8 +34,8 @@ impl fmt::Display for DictKind { /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryLiteralWithinDictCall { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralWithinDictCall { kind: DictKind, } @@ -57,32 +43,33 @@ impl AlwaysFixableViolation for UnnecessaryLiteralWithinDictCall { #[derive_message_formats] fn message(&self) -> String { let UnnecessaryLiteralWithinDictCall { kind } = self; - format!("Unnecessary `dict` {kind} passed to `dict()` (remove the outer call to `dict()`)") + format!("Unnecessary dict {kind} passed to `dict()` (remove the outer call to `dict()`)") } fn fix_title(&self) -> String { - "Remove outer `dict` call".to_string() + "Remove outer `dict()` call".to_string() } } /// C418 -pub(crate) fn unnecessary_literal_within_dict_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_literal_within_dict_call(checker: &Checker, call: &ast::ExprCall) { if !call.arguments.keywords.is_empty() { return; } + if call.arguments.args.len() > 1 { + return; + } let Some(argument) = helpers::first_argument_with_matching_function("dict", &call.func, &call.arguments.args) else { return; }; + let Some(argument_kind) = DictKind::try_from_expr(argument) else { + return; + }; if !checker.semantic().has_builtin_binding("dict") { return; } - let argument_kind = match argument { - Expr::DictComp(_) => DictKind::Comprehension, - Expr::Dict(_) => DictKind::Literal, - _ => return, - }; let mut diagnostic = Diagnostic::new( UnnecessaryLiteralWithinDictCall { @@ -102,5 +89,34 @@ pub(crate) fn unnecessary_literal_within_dict_call(checker: &mut Checker, call: Fix::unsafe_edits(call_start, [call_end]) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(crate) enum DictKind { + Literal, + Comprehension, +} + +impl DictKind { + const fn as_str(self) -> &'static str { + match self { + Self::Literal => "literal", + Self::Comprehension => "comprehension", + } + } + + const fn try_from_expr(expr: &Expr) -> Option<Self> { + match expr { + Expr::Dict(_) => Some(Self::Literal), + Expr::DictComp(_) => Some(Self::Comprehension), + _ => None, + } + } +} + +impl fmt::Display for DictKind { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + f.write_str(self.as_str()) + } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_list_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_list_call.rs index f71e11db41b57..61df610404803 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_list_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_list_call.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::{Ranged, TextSize}; @@ -8,7 +8,7 @@ use crate::checkers::ast::Checker; use super::helpers; /// ## What it does -/// Checks for `list` calls that take unnecessary list or tuple literals as +/// Checks for `list()` calls that take unnecessary list or tuple literals as /// arguments. /// /// ## Why is this bad? @@ -17,9 +17,9 @@ use super::helpers; /// /// If a list literal is passed in, then the outer call to `list()` should be /// removed. Otherwise, if a tuple literal is passed in, then it should be -/// rewritten as a `list` literal. +/// rewritten as a list literal. /// -/// ## Examples +/// ## Example /// ```python /// list([1, 2]) /// list((1, 2)) @@ -34,67 +34,63 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryLiteralWithinListCall { - literal: String, +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralWithinListCall { + kind: LiteralKind, } impl AlwaysFixableViolation for UnnecessaryLiteralWithinListCall { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryLiteralWithinListCall { literal } = self; - if literal == "list" { - format!( - "Unnecessary `{literal}` literal passed to `list()` (remove the outer call to \ - `list()`)" - ) - } else { - format!( - "Unnecessary `{literal}` literal passed to `list()` (rewrite as a `list` literal)" - ) + match self.kind { + LiteralKind::List => { + "Unnecessary list literal passed to `list()` (remove the outer call to `list()`)" + .to_string() + } + LiteralKind::Tuple => { + "Unnecessary tuple literal passed to `list()` (rewrite as a single list literal)" + .to_string() + } } } fn fix_title(&self) -> String { - let UnnecessaryLiteralWithinListCall { literal } = self; - { - if literal == "list" { - "Remove outer `list` call".to_string() - } else { - "Rewrite as a `list` literal".to_string() - } + match self.kind { + LiteralKind::List => "Remove outer `list()` call".to_string(), + LiteralKind::Tuple => "Rewrite as a single list literal".to_string(), } } } /// C410 -pub(crate) fn unnecessary_literal_within_list_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_literal_within_list_call(checker: &Checker, call: &ast::ExprCall) { if !call.arguments.keywords.is_empty() { return; } + if call.arguments.args.len() > 1 { + return; + } let Some(argument) = helpers::first_argument_with_matching_function("list", &call.func, &call.arguments.args) else { return; }; + let Some(argument_kind) = LiteralKind::try_from_expr(argument) else { + return; + }; if !checker.semantic().has_builtin_binding("list") { return; } - let argument_kind = match argument { - Expr::Tuple(_) => "tuple", - Expr::List(_) => "list", - _ => return, - }; - let mut diagnostic = Diagnostic::new( + let diagnostic = Diagnostic::new( UnnecessaryLiteralWithinListCall { - literal: argument_kind.to_string(), + kind: argument_kind, }, call.range(), ); // Convert `list([1, 2])` to `[1, 2]` - diagnostic.set_fix({ + let fix = { // Delete from the start of the call to the start of the argument. let call_start = Edit::deletion(call.start(), argument.start()); @@ -121,7 +117,23 @@ pub(crate) fn unnecessary_literal_within_list_call(checker: &mut Checker, call: } else { Fix::unsafe_edits(call_start, [call_end]) } - }); + }; + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} - checker.diagnostics.push(diagnostic); +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum LiteralKind { + Tuple, + List, +} + +impl LiteralKind { + const fn try_from_expr(expr: &Expr) -> Option<Self> { + match expr { + Expr::Tuple(_) => Some(Self::Tuple), + Expr::List(_) => Some(Self::List), + _ => None, + } + } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_tuple_call.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_tuple_call.rs index 8ea9833ae6c04..eae745afd9f96 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_tuple_call.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_literal_within_tuple_call.rs @@ -1,11 +1,12 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::{self as ast, Expr}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::Checker; +use crate::preview::is_check_comprehensions_in_tuple_call_enabled; use crate::rules::flake8_comprehensions::fixes; use super::helpers; @@ -27,7 +28,7 @@ use super::helpers; /// calls. If a list comprehension is found, it should be rewritten as a /// generator expression. /// -/// ## Examples +/// ## Example /// ```python /// tuple([1, 2]) /// tuple((1, 2)) @@ -46,45 +47,43 @@ use super::helpers; /// when rewriting the call. In most cases, though, comments will be preserved. /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct UnnecessaryLiteralWithinTupleCall { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralWithinTupleCall { literal_kind: TupleLiteralKind, } impl AlwaysFixableViolation for UnnecessaryLiteralWithinTupleCall { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryLiteralWithinTupleCall { literal_kind } = self; - match literal_kind { + match self.literal_kind { TupleLiteralKind::List => { - format!( - "Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal)" - ) + "Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal)" + .to_string() } TupleLiteralKind::Tuple => { - format!("Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`)") + "Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`)" + .to_string() } TupleLiteralKind::ListComp => { - format!( - "Unnecessary list comprehension passed to `tuple()` (rewrite as a generator)" - ) + "Unnecessary list comprehension passed to `tuple()` (rewrite as a generator)" + .to_string() } } } fn fix_title(&self) -> String { - let UnnecessaryLiteralWithinTupleCall { literal_kind } = self; - match literal_kind { - TupleLiteralKind::List => "Rewrite as a `tuple` literal".to_string(), - TupleLiteralKind::Tuple => "Remove the outer call to `tuple()`".to_string(), - TupleLiteralKind::ListComp => "Rewrite as a generator".to_string(), - } + let title = match self.literal_kind { + TupleLiteralKind::List => "Rewrite as a tuple literal", + TupleLiteralKind::Tuple => "Remove the outer call to `tuple()`", + TupleLiteralKind::ListComp => "Rewrite as a generator", + }; + title.to_string() } } /// C409 pub(crate) fn unnecessary_literal_within_tuple_call( - checker: &mut Checker, + checker: &Checker, expr: &Expr, call: &ast::ExprCall, ) { @@ -99,15 +98,17 @@ pub(crate) fn unnecessary_literal_within_tuple_call( ) else { return; }; - if !checker.semantic().has_builtin_binding("tuple") { - return; - } let argument_kind = match argument { Expr::Tuple(_) => TupleLiteralKind::Tuple, Expr::List(_) => TupleLiteralKind::List, - Expr::ListComp(_) if checker.settings.preview.is_enabled() => TupleLiteralKind::ListComp, + Expr::ListComp(_) if is_check_comprehensions_in_tuple_call_enabled(checker.settings) => { + TupleLiteralKind::ListComp + } _ => return, }; + if !checker.semantic().has_builtin_binding("tuple") { + return; + } let mut diagnostic = Diagnostic::new( UnnecessaryLiteralWithinTupleCall { @@ -167,7 +168,7 @@ pub(crate) fn unnecessary_literal_within_tuple_call( _ => return, } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_map.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_map.rs index a1dd7fe08d143..36b286b86ed1a 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_map.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_map.rs @@ -2,28 +2,26 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Fix}; use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::visitor; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, Parameters, Stmt}; -use ruff_text_size::Ranged; +use ruff_python_ast::{self as ast, Expr, ExprContext, Parameters, Stmt}; +use ruff_python_ast::{ExprLambda, visitor}; +use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; - use crate::rules::flake8_comprehensions::fixes; -use super::helpers; - /// ## What it does -/// Checks for unnecessary `map` calls with `lambda` functions. +/// Checks for unnecessary `map()` calls with lambda functions. /// /// ## Why is this bad? -/// Using `map(func, iterable)` when `func` is a `lambda` is slower than +/// Using `map(func, iterable)` when `func` is a lambda is slower than /// using a generator expression or a comprehension, as the latter approach /// avoids the function call overhead, in addition to being more readable. /// -/// This rule also applies to `map` calls within `list`, `set`, and `dict` -/// calls. For example: +/// This rule also applies to `map()` calls within `list()`, `set()`, and +/// `dict()` calls. For example: /// /// - Instead of `list(map(lambda num: num * 2, nums))`, use /// `[num * 2 for num in nums]`. @@ -32,7 +30,7 @@ use super::helpers; /// - Instead of `dict(map(lambda v: (v, v ** 2), values))`, use /// `{v: v ** 2 for v in values}`. /// -/// ## Examples +/// ## Example /// ```python /// map(lambda x: x + 1, iterable) /// ``` @@ -45,8 +43,8 @@ use super::helpers; /// ## Fix safety /// This rule's fix is marked as unsafe, as it may occasionally drop comments /// when rewriting the call. In most cases, though, comments will be preserved. -#[violation] -pub struct UnnecessaryMap { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryMap { object_type: ObjectType, } @@ -56,165 +54,94 @@ impl Violation for UnnecessaryMap { #[derive_message_formats] fn message(&self) -> String { let UnnecessaryMap { object_type } = self; - format!("Unnecessary `map` usage (rewrite using a {object_type})") + format!("Unnecessary `map()` usage (rewrite using a {object_type})") } fn fix_title(&self) -> Option<String> { let UnnecessaryMap { object_type } = self; - Some(format!("Replace `map` with a {object_type}")) + Some(format!("Replace `map()` with a {object_type}")) } } /// C417 -pub(crate) fn unnecessary_map( - checker: &mut Checker, - expr: &Expr, - parent: Option<&Expr>, - func: &Expr, - args: &[Expr], -) { - let Some(builtin_name) = checker.semantic().resolve_builtin_symbol(func) else { +pub(crate) fn unnecessary_map(checker: &Checker, call: &ast::ExprCall) { + let semantic = checker.semantic(); + let (func, arguments) = (&call.func, &call.arguments); + + if !arguments.keywords.is_empty() { return; - }; + } - let object_type = match builtin_name { - "map" => ObjectType::Generator, - "list" => ObjectType::List, - "set" => ObjectType::Set, - "dict" => ObjectType::Dict, - _ => return, + let Some(object_type) = ObjectType::from(func, semantic) else { + return; }; - match object_type { - ObjectType::Generator => { - // Exclude the parent if already matched by other arms. - if parent - .and_then(Expr::as_call_expr) - .and_then(|call| call.func.as_name_expr()) - .is_some_and(|name| matches!(name.id.as_str(), "list" | "set" | "dict")) - { - return; - } - - // Only flag, e.g., `map(lambda x: x + 1, iterable)`. - let [Expr::Lambda(ast::ExprLambda { - parameters, body, .. - }), _] = args - else { - return; - }; + let parent = semantic.current_expression_parent(); - if parameters.as_ref().is_some_and(|parameters| { - late_binding(parameters, body) - || parameters - .iter_non_variadic_params() - .any(|param| param.default.is_some()) - || parameters.vararg.is_some() - || parameters.kwarg.is_some() - }) { - return; - } - } - ObjectType::List | ObjectType::Set => { - // Only flag, e.g., `list(map(lambda x: x + 1, iterable))`. - let [Expr::Call(ast::ExprCall { - func, - arguments: Arguments { args, keywords, .. }, - .. - })] = args - else { - return; + let (lambda, iterables) = match object_type { + ObjectType::Generator => { + let parent_call_func = match parent { + Some(Expr::Call(call)) => Some(&call.func), + _ => None, }; - if args.len() != 2 { - return; - } - - if !keywords.is_empty() { + // Exclude the parent if already matched by other arms. + if parent_call_func.is_some_and(|func| is_list_set_or_dict(func, semantic)) { return; } - let Some(argument) = helpers::first_argument_with_matching_function("map", func, args) - else { - return; - }; - - let Expr::Lambda(ast::ExprLambda { - parameters, body, .. - }) = argument - else { + let Some(result) = map_lambda_and_iterables(call, semantic) else { return; }; - if parameters.as_ref().is_some_and(|parameters| { - late_binding(parameters, body) - || parameters - .iter_non_variadic_params() - .any(|param| param.default.is_some()) - || parameters.vararg.is_some() - || parameters.kwarg.is_some() - }) { - return; - } + result } - ObjectType::Dict => { - // Only flag, e.g., `dict(map(lambda v: (v, v ** 2), values))`. - let [Expr::Call(ast::ExprCall { - func, - arguments: Arguments { args, keywords, .. }, - .. - })] = args - else { - return; - }; - - if args.len() != 2 { - return; - } - - if !keywords.is_empty() { - return; - } - let Some(argument) = helpers::first_argument_with_matching_function("map", func, args) - else { + ObjectType::List | ObjectType::Set | ObjectType::Dict => { + let [Expr::Call(inner_call)] = arguments.args.as_ref() else { return; }; - let Expr::Lambda(ast::ExprLambda { - parameters, body, .. - }) = argument - else { + let Some((lambda, iterables)) = map_lambda_and_iterables(inner_call, semantic) else { return; }; - let (Expr::Tuple(ast::ExprTuple { elts, .. }) | Expr::List(ast::ExprList { elts, .. })) = - body.as_ref() - else { - return; - }; + if object_type == ObjectType::Dict { + let (Expr::Tuple(ast::ExprTuple { elts, .. }) + | Expr::List(ast::ExprList { elts, .. })) = &*lambda.body + else { + return; + }; - if elts.len() != 2 { - return; + if elts.len() != 2 { + return; + } } - if parameters.as_ref().is_some_and(|parameters| { - late_binding(parameters, body) - || parameters - .iter_non_variadic_params() - .any(|param| param.default.is_some()) - || parameters.vararg.is_some() - || parameters.kwarg.is_some() - }) { - return; - } + (lambda, iterables) } }; - let mut diagnostic = Diagnostic::new(UnnecessaryMap { object_type }, expr.range()); + for iterable in iterables { + // For example, (x+1 for x in (c:=a)) is invalid syntax + // so we can't suggest it. + if any_over_expr(iterable, &|expr| expr.is_named_expr()) { + return; + } + + if iterable.is_starred_expr() { + return; + } + } + + if !lambda_has_expected_arity(lambda) { + return; + } + + let mut diagnostic = Diagnostic::new(UnnecessaryMap { object_type }, call.range); diagnostic.try_set_fix(|| { fixes::fix_unnecessary_map( - expr, + call, parent, object_type, checker.locator(), @@ -222,7 +149,68 @@ pub(crate) fn unnecessary_map( ) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +fn is_list_set_or_dict(func: &Expr, semantic: &SemanticModel) -> bool { + semantic + .resolve_qualified_name(func) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["" | "builtins", "list" | "set" | "dict"] + ) + }) +} + +fn map_lambda_and_iterables<'a>( + call: &'a ast::ExprCall, + semantic: &'a SemanticModel, +) -> Option<(&'a ExprLambda, &'a [Expr])> { + if !semantic.match_builtin_expr(&call.func, "map") { + return None; + } + + let arguments = &call.arguments; + + if !arguments.keywords.is_empty() { + return None; + } + + let Some((Expr::Lambda(lambda), iterables)) = arguments.args.split_first() else { + return None; + }; + + Some((lambda, iterables)) +} + +/// A lambda as the first argument to `map()` has the "expected" arity when: +/// +/// * It has exactly one parameter +/// * That parameter is not variadic +/// * That parameter does not have a default value +fn lambda_has_expected_arity(lambda: &ExprLambda) -> bool { + let Some(parameters) = lambda.parameters.as_deref() else { + return false; + }; + + let [parameter] = &*parameters.args else { + return false; + }; + + if parameter.default.is_some() { + return false; + } + + if parameters.vararg.is_some() || parameters.kwarg.is_some() { + return false; + } + + if late_binding(parameters, &lambda.body) { + return false; + } + + true } #[derive(Debug, Copy, Clone, PartialEq, Eq)] @@ -233,13 +221,25 @@ pub(crate) enum ObjectType { Dict, } +impl ObjectType { + fn from(func: &Expr, semantic: &SemanticModel) -> Option<Self> { + match semantic.resolve_builtin_symbol(func) { + Some("map") => Some(Self::Generator), + Some("list") => Some(Self::List), + Some("set") => Some(Self::Set), + Some("dict") => Some(Self::Dict), + _ => None, + } + } +} + impl fmt::Display for ObjectType { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { match self { ObjectType::Generator => fmt.write_str("generator expression"), - ObjectType::List => fmt.write_str("`list` comprehension"), - ObjectType::Set => fmt.write_str("`set` comprehension"), - ObjectType::Dict => fmt.write_str("`dict` comprehension"), + ObjectType::List => fmt.write_str("list comprehension"), + ObjectType::Set => fmt.write_str("set comprehension"), + ObjectType::Dict => fmt.write_str("dict comprehension"), } } } diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_subscript_reversal.rs b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_subscript_reversal.rs index 54aca2a6302af..2c26077bf46a5 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_subscript_reversal.rs +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/rules/unnecessary_subscript_reversal.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, UnaryOp}; use ruff_text_size::Ranged; @@ -13,7 +13,7 @@ use crate::checkers::ast::Checker; /// into `reversed()`, `set()` or `sorted()` functions as they will change /// the order of the elements again. /// -/// ## Examples +/// ## Example /// ```python /// sorted(iterable[::-1]) /// set(iterable[::-1]) @@ -26,8 +26,8 @@ use crate::checkers::ast::Checker; /// set(iterable) /// iterable /// ``` -#[violation] -pub struct UnnecessarySubscriptReversal { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessarySubscriptReversal { func: String, } @@ -40,7 +40,7 @@ impl Violation for UnnecessarySubscriptReversal { } /// C415 -pub(crate) fn unnecessary_subscript_reversal(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_subscript_reversal(checker: &Checker, call: &ast::ExprCall) { let Some(first_arg) = call.arguments.args.first() else { return; }; @@ -79,14 +79,14 @@ pub(crate) fn unnecessary_subscript_reversal(checker: &mut Checker, call: &ast:: }; if *val != 1 { return; - }; + } let Some(function_name) = checker.semantic().resolve_builtin_symbol(&call.func) else { return; }; if !matches!(function_name, "reversed" | "set" | "sorted") { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnnecessarySubscriptReversal { func: function_name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C400_C400.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C400_C400.py.snap index d64116390469b..fac96417f0843 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C400_C400.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C400_C400.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C400.py:2:13: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) +C400.py:2:13: C400 [*] Unnecessary generator (rewrite as a list comprehension) | 1 | # Cannot combine with C416. Should use list comprehension here. 2 | even_nums = list(2 * x for x in range(3)) @@ -9,7 +9,7 @@ C400.py:2:13: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 3 | odd_nums = list( 4 | 2 * x + 1 for x in range(3) | - = help: Rewrite as a `list` comprehension + = help: Rewrite as a list comprehension ℹ Unsafe fix 1 1 | # Cannot combine with C416. Should use list comprehension here. @@ -19,7 +19,7 @@ C400.py:2:13: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 4 4 | 2 * x + 1 for x in range(3) 5 5 | ) -C400.py:3:12: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) +C400.py:3:12: C400 [*] Unnecessary generator (rewrite as a list comprehension) | 1 | # Cannot combine with C416. Should use list comprehension here. 2 | even_nums = list(2 * x for x in range(3)) @@ -29,7 +29,7 @@ C400.py:3:12: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 5 | | ) | |_^ C400 | - = help: Rewrite as a `list` comprehension + = help: Rewrite as a list comprehension ℹ Unsafe fix 1 1 | # Cannot combine with C416. Should use list comprehension here. @@ -72,7 +72,7 @@ C400.py:10:5: C400 [*] Unnecessary generator (rewrite using `list()`) 11 | | x for x in range(3) 12 | | ) | |_^ C400 -13 | +13 | 14 | # Strip parentheses from inner generators. | = help: Rewrite using `list()` @@ -89,7 +89,7 @@ C400.py:10:5: C400 [*] Unnecessary generator (rewrite using `list()`) 14 12 | # Strip parentheses from inner generators. 15 13 | list((2 * x for x in range(3))) -C400.py:15:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) +C400.py:15:1: C400 [*] Unnecessary generator (rewrite as a list comprehension) | 14 | # Strip parentheses from inner generators. 15 | list((2 * x for x in range(3))) @@ -97,7 +97,7 @@ C400.py:15:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 16 | list(((2 * x for x in range(3)))) 17 | list((((2 * x for x in range(3))))) | - = help: Rewrite as a `list` comprehension + = help: Rewrite as a list comprehension ℹ Unsafe fix 12 12 | ) @@ -109,7 +109,7 @@ C400.py:15:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 17 17 | list((((2 * x for x in range(3))))) 18 18 | -C400.py:16:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) +C400.py:16:1: C400 [*] Unnecessary generator (rewrite as a list comprehension) | 14 | # Strip parentheses from inner generators. 15 | list((2 * x for x in range(3))) @@ -117,7 +117,7 @@ C400.py:16:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C400 17 | list((((2 * x for x in range(3))))) | - = help: Rewrite as a `list` comprehension + = help: Rewrite as a list comprehension ℹ Unsafe fix 13 13 | @@ -127,18 +127,18 @@ C400.py:16:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 16 |+[2 * x for x in range(3)] 17 17 | list((((2 * x for x in range(3))))) 18 18 | -19 19 | # Not built-in list. +19 19 | # Account for trailing comma in fix -C400.py:17:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) +C400.py:17:1: C400 [*] Unnecessary generator (rewrite as a list comprehension) | 15 | list((2 * x for x in range(3))) 16 | list(((2 * x for x in range(3)))) 17 | list((((2 * x for x in range(3))))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C400 -18 | -19 | # Not built-in list. +18 | +19 | # Account for trailing comma in fix | - = help: Rewrite as a `list` comprehension + = help: Rewrite as a list comprehension ℹ Unsafe fix 14 14 | # Strip parentheses from inner generators. @@ -147,5 +147,57 @@ C400.py:17:1: C400 [*] Unnecessary generator (rewrite as a `list` comprehension) 17 |-list((((2 * x for x in range(3))))) 17 |+[2 * x for x in range(3)] 18 18 | -19 19 | # Not built-in list. -20 20 | def list(*args, **kwargs): +19 19 | # Account for trailing comma in fix +20 20 | # See https://github.com/astral-sh/ruff/issues/15852 + +C400.py:21:1: C400 [*] Unnecessary generator (rewrite as a list comprehension) + | +19 | # Account for trailing comma in fix +20 | # See https://github.com/astral-sh/ruff/issues/15852 +21 | list((0 for _ in []),) + | ^^^^^^^^^^^^^^^^^^^^^^ C400 +22 | list( +23 | (0 for _ in []) + | + = help: Rewrite as a list comprehension + +ℹ Unsafe fix +18 18 | +19 19 | # Account for trailing comma in fix +20 20 | # See https://github.com/astral-sh/ruff/issues/15852 +21 |-list((0 for _ in []),) + 21 |+[0 for _ in []] +22 22 | list( +23 23 | (0 for _ in []) +24 24 | # some comments + +C400.py:22:1: C400 [*] Unnecessary generator (rewrite as a list comprehension) + | +20 | # See https://github.com/astral-sh/ruff/issues/15852 +21 | list((0 for _ in []),) +22 | / list( +23 | | (0 for _ in []) +24 | | # some comments +25 | | , +26 | | # some more +27 | | ) + | |__^ C400 + | + = help: Rewrite as a list comprehension + +ℹ Unsafe fix +19 19 | # Account for trailing comma in fix +20 20 | # See https://github.com/astral-sh/ruff/issues/15852 +21 21 | list((0 for _ in []),) +22 |-list( +23 |- (0 for _ in []) + 22 |+[ + 23 |+ 0 for _ in [] +24 24 | # some comments +25 |- , +26 |- # some more +27 |- ) + 25 |+ ] +28 26 | +29 27 | +30 28 | # Not built-in list. diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C401_C401.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C401_C401.py.snap index be566d8e53a0e..7ca2ce2725889 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C401_C401.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C401_C401.py.snap @@ -1,27 +1,27 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C401.py:2:13: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) +C401.py:2:13: C401 [*] Unnecessary generator (rewrite as a set comprehension) | -1 | # Cannot conbime with C416. Should use set comprehension here. +1 | # Cannot combine with C416. Should use set comprehension here. 2 | even_nums = set(2 * x for x in range(3)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C401 3 | odd_nums = set( 4 | 2 * x + 1 for x in range(3) | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix -1 1 | # Cannot conbime with C416. Should use set comprehension here. +1 1 | # Cannot combine with C416. Should use set comprehension here. 2 |-even_nums = set(2 * x for x in range(3)) 2 |+even_nums = {2 * x for x in range(3)} 3 3 | odd_nums = set( 4 4 | 2 * x + 1 for x in range(3) 5 5 | ) -C401.py:3:12: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) +C401.py:3:12: C401 [*] Unnecessary generator (rewrite as a set comprehension) | -1 | # Cannot conbime with C416. Should use set comprehension here. +1 | # Cannot combine with C416. Should use set comprehension here. 2 | even_nums = set(2 * x for x in range(3)) 3 | odd_nums = set( | ____________^ @@ -30,10 +30,10 @@ C401.py:3:12: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) | |_^ C401 6 | small_nums = f"{set(a if a < 6 else 0 for a in range(3))}" | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix -1 1 | # Cannot conbime with C416. Should use set comprehension here. +1 1 | # Cannot combine with C416. Should use set comprehension here. 2 2 | even_nums = set(2 * x for x in range(3)) 3 |-odd_nums = set( 3 |+odd_nums = { @@ -44,16 +44,16 @@ C401.py:3:12: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) 7 7 | 8 8 | def f(x): -C401.py:6:17: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) +C401.py:6:17: C401 [*] Unnecessary generator (rewrite as a set comprehension) | 4 | 2 * x + 1 for x in range(3) 5 | ) 6 | small_nums = f"{set(a if a < 6 else 0 for a in range(3))}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C401 -7 | +7 | 8 | def f(x): | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 3 3 | odd_nums = set( @@ -65,15 +65,15 @@ C401.py:6:17: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) 8 8 | def f(x): 9 9 | return x -C401.py:11:16: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) +C401.py:11:16: C401 [*] Unnecessary generator (rewrite as a set comprehension) | 9 | return x -10 | +10 | 11 | print(f"Hello {set(f(a) for a in 'abc')} World") | ^^^^^^^^^^^^^^^^^^^^^^^^ C401 12 | print(f"Hello { set(f(a) for a in 'abc') } World") | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 8 8 | def f(x): @@ -85,13 +85,13 @@ C401.py:11:16: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) 13 13 | 14 14 | -C401.py:12:17: C401 [*] Unnecessary generator (rewrite as a `set` comprehension) +C401.py:12:17: C401 [*] Unnecessary generator (rewrite as a set comprehension) | 11 | print(f"Hello {set(f(a) for a in 'abc')} World") 12 | print(f"Hello { set(f(a) for a in 'abc') } World") | ^^^^^^^^^^^^^^^^^^^^^^^^ C401 | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 9 9 | return x @@ -188,7 +188,7 @@ C401.py:21:10: C401 [*] Unnecessary generator (rewrite using `set()`) 21 |+print(f"{set('abc') - set(a for a in 'ab')}") 22 22 | print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") 23 23 | -24 24 | +24 24 | # Strip parentheses from inner generators. C401.py:21:34: C401 [*] Unnecessary generator (rewrite using `set()`) | @@ -208,7 +208,7 @@ C401.py:21:34: C401 [*] Unnecessary generator (rewrite using `set()`) 21 |+print(f"{set(a for a in 'abc') - set('ab')}") 22 22 | print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") 23 23 | -24 24 | +24 24 | # Strip parentheses from inner generators. C401.py:22:11: C401 [*] Unnecessary generator (rewrite using `set()`) | @@ -216,6 +216,8 @@ C401.py:22:11: C401 [*] Unnecessary generator (rewrite using `set()`) 21 | print(f"{set(a for a in 'abc') - set(a for a in 'ab')}") 22 | print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") | ^^^^^^^^^^^^^^^^^^^^^ C401 +23 | +24 | # Strip parentheses from inner generators. | = help: Rewrite using `set()` @@ -226,8 +228,8 @@ C401.py:22:11: C401 [*] Unnecessary generator (rewrite using `set()`) 22 |-print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") 22 |+print(f"{ set('abc') - set(a for a in 'ab') }") 23 23 | -24 24 | -25 25 | # Not built-in set. +24 24 | # Strip parentheses from inner generators. +25 25 | set((2 * x for x in range(3))) C401.py:22:35: C401 [*] Unnecessary generator (rewrite using `set()`) | @@ -235,6 +237,8 @@ C401.py:22:35: C401 [*] Unnecessary generator (rewrite using `set()`) 21 | print(f"{set(a for a in 'abc') - set(a for a in 'ab')}") 22 | print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") | ^^^^^^^^^^^^^^^^^^^^ C401 +23 | +24 | # Strip parentheses from inner generators. | = help: Rewrite using `set()` @@ -245,5 +249,120 @@ C401.py:22:35: C401 [*] Unnecessary generator (rewrite using `set()`) 22 |-print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") 22 |+print(f"{ set(a for a in 'abc') - set('ab') }") 23 23 | -24 24 | -25 25 | # Not built-in set. +24 24 | # Strip parentheses from inner generators. +25 25 | set((2 * x for x in range(3))) + +C401.py:25:1: C401 [*] Unnecessary generator (rewrite as a set comprehension) + | +24 | # Strip parentheses from inner generators. +25 | set((2 * x for x in range(3))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C401 +26 | set(((2 * x for x in range(3)))) +27 | set((((2 * x for x in range(3))))) + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +22 22 | print(f"{ set(a for a in 'abc') - set(a for a in 'ab') }") +23 23 | +24 24 | # Strip parentheses from inner generators. +25 |-set((2 * x for x in range(3))) + 25 |+{2 * x for x in range(3)} +26 26 | set(((2 * x for x in range(3)))) +27 27 | set((((2 * x for x in range(3))))) +28 28 | + +C401.py:26:1: C401 [*] Unnecessary generator (rewrite as a set comprehension) + | +24 | # Strip parentheses from inner generators. +25 | set((2 * x for x in range(3))) +26 | set(((2 * x for x in range(3)))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C401 +27 | set((((2 * x for x in range(3))))) + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +23 23 | +24 24 | # Strip parentheses from inner generators. +25 25 | set((2 * x for x in range(3))) +26 |-set(((2 * x for x in range(3)))) + 26 |+{2 * x for x in range(3)} +27 27 | set((((2 * x for x in range(3))))) +28 28 | +29 29 | # Account for trailing comma in fix + +C401.py:27:1: C401 [*] Unnecessary generator (rewrite as a set comprehension) + | +25 | set((2 * x for x in range(3))) +26 | set(((2 * x for x in range(3)))) +27 | set((((2 * x for x in range(3))))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C401 +28 | +29 | # Account for trailing comma in fix + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +24 24 | # Strip parentheses from inner generators. +25 25 | set((2 * x for x in range(3))) +26 26 | set(((2 * x for x in range(3)))) +27 |-set((((2 * x for x in range(3))))) + 27 |+{2 * x for x in range(3)} +28 28 | +29 29 | # Account for trailing comma in fix +30 30 | # See https://github.com/astral-sh/ruff/issues/15852 + +C401.py:31:1: C401 [*] Unnecessary generator (rewrite as a set comprehension) + | +29 | # Account for trailing comma in fix +30 | # See https://github.com/astral-sh/ruff/issues/15852 +31 | set((0 for _ in []),) + | ^^^^^^^^^^^^^^^^^^^^^ C401 +32 | set( +33 | (0 for _ in []) + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +28 28 | +29 29 | # Account for trailing comma in fix +30 30 | # See https://github.com/astral-sh/ruff/issues/15852 +31 |-set((0 for _ in []),) + 31 |+{0 for _ in []} +32 32 | set( +33 33 | (0 for _ in []) +34 34 | # some comments + +C401.py:32:1: C401 [*] Unnecessary generator (rewrite as a set comprehension) + | +30 | # See https://github.com/astral-sh/ruff/issues/15852 +31 | set((0 for _ in []),) +32 | / set( +33 | | (0 for _ in []) +34 | | # some comments +35 | | , +36 | | # some more +37 | | ) + | |_^ C401 +38 | +39 | # Not built-in set. + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +29 29 | # Account for trailing comma in fix +30 30 | # See https://github.com/astral-sh/ruff/issues/15852 +31 31 | set((0 for _ in []),) +32 |-set( +33 |- (0 for _ in []) + 32 |+{ + 33 |+ 0 for _ in [] +34 34 | # some comments +35 |- , +36 |- # some more +37 |-) + 35 |+ } +38 36 | +39 37 | # Not built-in set. +40 38 | def set(*args, **kwargs): diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C402_C402.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C402_C402.py.snap index 1a79ba66f5baa..12c426627a6db 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C402_C402.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C402_C402.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C402.py:1:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:1:1: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 1 | dict((x, x) for x in range(3)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 2 | dict( 3 | (x, x) for x in range(3) | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 1 |-dict((x, x) for x in range(3)) @@ -17,7 +17,7 @@ C402.py:1:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 3 3 | (x, x) for x in range(3) 4 4 | ) -C402.py:2:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:2:1: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 1 | dict((x, x) for x in range(3)) 2 | / dict( @@ -27,7 +27,7 @@ C402.py:2:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 5 | dict(((x, x) for x in range(3)), z=3) 6 | y = f'{dict((x, x) for x in range(3))}' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 1 1 | dict((x, x) for x in range(3)) @@ -41,7 +41,7 @@ C402.py:2:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 6 6 | y = f'{dict((x, x) for x in range(3))}' 7 7 | print(f'Hello {dict((x, x) for x in range(3))} World') -C402.py:6:8: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:6:8: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 4 | ) 5 | dict(((x, x) for x in range(3)), z=3) @@ -50,7 +50,7 @@ C402.py:6:8: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 7 | print(f'Hello {dict((x, x) for x in range(3))} World') 8 | print(f"Hello {dict((x, x) for x in 'abc')} World") | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 3 3 | (x, x) for x in range(3) @@ -62,7 +62,7 @@ C402.py:6:8: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 8 8 | print(f"Hello {dict((x, x) for x in 'abc')} World") 9 9 | print(f'Hello {dict((x, x) for x in "abc")} World') -C402.py:7:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:7:16: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 5 | dict(((x, x) for x in range(3)), z=3) 6 | y = f'{dict((x, x) for x in range(3))}' @@ -71,7 +71,7 @@ C402.py:7:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 8 | print(f"Hello {dict((x, x) for x in 'abc')} World") 9 | print(f'Hello {dict((x, x) for x in "abc")} World') | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 4 4 | ) @@ -83,7 +83,7 @@ C402.py:7:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 9 9 | print(f'Hello {dict((x, x) for x in "abc")} World') 10 10 | print(f'Hello {dict((x,x) for x in "abc")} World') -C402.py:8:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:8:16: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 6 | y = f'{dict((x, x) for x in range(3))}' 7 | print(f'Hello {dict((x, x) for x in range(3))} World') @@ -92,7 +92,7 @@ C402.py:8:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 9 | print(f'Hello {dict((x, x) for x in "abc")} World') 10 | print(f'Hello {dict((x,x) for x in "abc")} World') | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 5 5 | dict(((x, x) for x in range(3)), z=3) @@ -104,7 +104,7 @@ C402.py:8:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 10 10 | print(f'Hello {dict((x,x) for x in "abc")} World') 11 11 | -C402.py:9:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:9:16: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 7 | print(f'Hello {dict((x, x) for x in range(3))} World') 8 | print(f"Hello {dict((x, x) for x in 'abc')} World") @@ -112,7 +112,7 @@ C402.py:9:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 10 | print(f'Hello {dict((x,x) for x in "abc")} World') | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 6 6 | y = f'{dict((x, x) for x in range(3))}' @@ -124,16 +124,16 @@ C402.py:9:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 11 11 | 12 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' -C402.py:10:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:10:16: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 8 | print(f"Hello {dict((x, x) for x in 'abc')} World") 9 | print(f'Hello {dict((x, x) for x in "abc")} World') 10 | print(f'Hello {dict((x,x) for x in "abc")} World') | ^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 -11 | +11 | 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 7 7 | print(f'Hello {dict((x, x) for x in range(3))} World') @@ -145,15 +145,15 @@ C402.py:10:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension 12 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' 13 13 | f'{ dict((x, x) for x in range(3)) | dict((x, x) for x in range(3)) }' -C402.py:12:4: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:12:4: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 10 | print(f'Hello {dict((x,x) for x in "abc")} World') -11 | +11 | 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 13 | f'{ dict((x, x) for x in range(3)) | dict((x, x) for x in range(3)) }' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 9 9 | print(f'Hello {dict((x, x) for x in "abc")} World') @@ -165,15 +165,15 @@ C402.py:12:4: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 14 14 | 15 15 | def f(x): -C402.py:12:37: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:12:37: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 10 | print(f'Hello {dict((x,x) for x in "abc")} World') -11 | +11 | 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 13 | f'{ dict((x, x) for x in range(3)) | dict((x, x) for x in range(3)) }' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 9 9 | print(f'Hello {dict((x, x) for x in "abc")} World') @@ -185,15 +185,15 @@ C402.py:12:37: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension 14 14 | 15 15 | def f(x): -C402.py:13:5: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:13:5: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' 13 | f'{ dict((x, x) for x in range(3)) | dict((x, x) for x in range(3)) }' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 -14 | +14 | 15 | def f(x): | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 10 10 | print(f'Hello {dict((x,x) for x in "abc")} World') @@ -205,15 +205,15 @@ C402.py:13:5: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 15 15 | def f(x): 16 16 | return x -C402.py:13:38: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:13:38: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 12 | f'{dict((x, x) for x in range(3)) | dict((x, x) for x in range(3))}' 13 | f'{ dict((x, x) for x in range(3)) | dict((x, x) for x in range(3)) }' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 -14 | +14 | 15 | def f(x): | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 10 10 | print(f'Hello {dict((x,x) for x in "abc")} World') @@ -225,16 +225,16 @@ C402.py:13:38: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension 15 15 | def f(x): 16 16 | return x -C402.py:18:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:18:16: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 16 | return x -17 | +17 | 18 | print(f'Hello {dict((x,f(x)) for x in "abc")} World') | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 -19 | +19 | 20 | # Regression test for: https://github.com/astral-sh/ruff/issues/7086 | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 15 15 | def f(x): @@ -246,15 +246,15 @@ C402.py:18:16: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension 20 20 | # Regression test for: https://github.com/astral-sh/ruff/issues/7086 21 21 | dict((k,v)for k,v in d.iteritems() if k in only_args) -C402.py:21:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) +C402.py:21:1: C402 [*] Unnecessary generator (rewrite as a dict comprehension) | 20 | # Regression test for: https://github.com/astral-sh/ruff/issues/7086 21 | dict((k,v)for k,v in d.iteritems() if k in only_args) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C402 -22 | +22 | 23 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722458940 | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 18 18 | print(f'Hello {dict((x,f(x)) for x in "abc")} World') @@ -265,5 +265,3 @@ C402.py:21:1: C402 [*] Unnecessary generator (rewrite as a `dict` comprehension) 22 22 | 23 23 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722458940 24 24 | dict((*v, k) for k, v in enumerate(calendar.month_abbr)) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C403_C403.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C403_C403.py.snap index 8b30f0a8e2537..57b06b06d6ca7 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C403_C403.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C403_C403.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C403.py:1:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:1:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 1 | s = set([x for x in range(3)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ C403 2 | s = set( 3 | [x for x in range(3)] | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 1 |-s = set([x for x in range(3)]) @@ -17,7 +17,7 @@ C403.py:1:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` compr 3 3 | [x for x in range(3)] 4 4 | ) -C403.py:2:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:2:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 1 | s = set([x for x in range(3)]) 2 | s = set( @@ -25,10 +25,10 @@ C403.py:2:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` compr 3 | | [x for x in range(3)] 4 | | ) | |_^ C403 -5 | +5 | 6 | s = f"{set([x for x in 'ab'])}" | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 1 1 | s = set([x for x in range(3)]) @@ -42,15 +42,15 @@ C403.py:2:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` compr 6 6 | s = f"{set([x for x in 'ab'])}" 7 7 | s = f'{set([x for x in "ab"])}' -C403.py:6:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:6:8: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 4 | ) -5 | +5 | 6 | s = f"{set([x for x in 'ab'])}" | ^^^^^^^^^^^^^^^^^^^^^^ C403 7 | s = f'{set([x for x in "ab"])}' | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 3 3 | [x for x in range(3)] @@ -62,15 +62,15 @@ C403.py:6:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` compr 8 8 | 9 9 | def f(x): -C403.py:7:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:7:8: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 6 | s = f"{set([x for x in 'ab'])}" 7 | s = f'{set([x for x in "ab"])}' | ^^^^^^^^^^^^^^^^^^^^^^ C403 -8 | +8 | 9 | def f(x): | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 4 4 | ) @@ -82,16 +82,16 @@ C403.py:7:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` compr 9 9 | def f(x): 10 10 | return x -C403.py:12:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:12:8: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 10 | return x -11 | +11 | 12 | s = f"{set([f(x) for x in 'ab'])}" | ^^^^^^^^^^^^^^^^^^^^^^^^^ C403 -13 | +13 | 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 9 9 | def f(x): @@ -103,15 +103,15 @@ C403.py:12:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comp 14 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" 15 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" -C403.py:14:9: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:14:9: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 12 | s = f"{set([f(x) for x in 'ab'])}" -13 | +13 | 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" | ^^^^^^^^^^^^^^^^^^^^^^ C403 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 11 11 | @@ -123,15 +123,15 @@ C403.py:14:9: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comp 16 16 | 17 17 | s = set( # comment -C403.py:14:34: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:14:34: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 12 | s = f"{set([f(x) for x in 'ab'])}" -13 | +13 | 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" | ^^^^^^^^^^^^^^^^^^^^^^ C403 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 11 11 | @@ -143,15 +143,15 @@ C403.py:14:34: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` com 16 16 | 17 17 | s = set( # comment -C403.py:15:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:15:8: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" | ^^^^^^^^^^^^^^^^^^^^^^ C403 -16 | +16 | 17 | s = set( # comment | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 12 12 | s = f"{set([f(x) for x in 'ab'])}" @@ -163,15 +163,15 @@ C403.py:15:8: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comp 17 17 | s = set( # comment 18 18 | [x for x in range(3)] -C403.py:15:33: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:15:33: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" | ^^^^^^^^^^^^^^^^^^^^^^ C403 -16 | +16 | 17 | s = set( # comment | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 12 12 | s = f"{set([f(x) for x in 'ab'])}" @@ -183,19 +183,19 @@ C403.py:15:33: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` com 17 17 | s = set( # comment 18 18 | [x for x in range(3)] -C403.py:17:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:17:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 15 | s = f"{set([x for x in 'ab']) | set([x for x in 'ab'])}" -16 | +16 | 17 | s = set( # comment | _____^ 18 | | [x for x in range(3)] 19 | | ) | |_^ C403 -20 | +20 | 21 | s = set([ # comment | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 14 14 | s = f"{ set([x for x in 'ab']) | set([x for x in 'ab']) }" @@ -211,17 +211,19 @@ C403.py:17:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comp 21 21 | s = set([ # comment 22 22 | x for x in range(3) -C403.py:21:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comprehension) +C403.py:21:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) | 19 | ) -20 | +20 | 21 | s = set([ # comment | _____^ 22 | | x for x in range(3) 23 | | ]) | |__^ C403 +24 | +25 | s = set(([x for x in range(3)])) | - = help: Rewrite as a `set` comprehension + = help: Rewrite as a set comprehension ℹ Unsafe fix 18 18 | [x for x in range(3)] @@ -232,5 +234,97 @@ C403.py:21:5: C403 [*] Unnecessary `list` comprehension (rewrite as a `set` comp 22 22 | x for x in range(3) 23 |-]) 23 |+} +24 24 | +25 25 | s = set(([x for x in range(3)])) +26 26 | +C403.py:25:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) + | +23 | ]) +24 | +25 | s = set(([x for x in range(3)])) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C403 +26 | +27 | s = set(((([x for x in range(3)])))) + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +22 22 | x for x in range(3) +23 23 | ]) +24 24 | +25 |-s = set(([x for x in range(3)])) + 25 |+s = {x for x in range(3)} +26 26 | +27 27 | s = set(((([x for x in range(3)])))) +28 28 | + +C403.py:27:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) + | +25 | s = set(([x for x in range(3)])) +26 | +27 | s = set(((([x for x in range(3)])))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C403 +28 | +29 | s = set( # outer set comment + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +24 24 | +25 25 | s = set(([x for x in range(3)])) +26 26 | +27 |-s = set(((([x for x in range(3)])))) + 27 |+s = {x for x in range(3)} +28 28 | +29 29 | s = set( # outer set comment +30 30 | ( # inner paren comment - not preserved +C403.py:29:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) + | +27 | s = set(((([x for x in range(3)])))) +28 | +29 | s = set( # outer set comment + | _____^ +30 | | ( # inner paren comment - not preserved +31 | | (( +32 | | [ # comprehension comment +33 | | x for x in range(3)] +34 | | )))) + | |_____^ C403 +35 | +36 | # Test trailing comma case + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +26 26 | +27 27 | s = set(((([x for x in range(3)])))) +28 28 | +29 |-s = set( # outer set comment +30 |-( # inner paren comment - not preserved +31 |-(( +32 |-[ # comprehension comment +33 |- x for x in range(3)] +34 |- )))) + 29 |+s = { # outer set comment + 30 |+ # comprehension comment + 31 |+ x for x in range(3)} +35 32 | +36 33 | # Test trailing comma case +37 34 | s = set([x for x in range(3)],) + +C403.py:37:5: C403 [*] Unnecessary list comprehension (rewrite as a set comprehension) + | +36 | # Test trailing comma case +37 | s = set([x for x in range(3)],) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C403 + | + = help: Rewrite as a set comprehension + +ℹ Unsafe fix +34 34 | )))) +35 35 | +36 36 | # Test trailing comma case +37 |-s = set([x for x in range(3)],) + 37 |+s = {x for x in range(3)} diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C404_C404.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C404_C404.py.snap index 6ee5af803d1de..1267401cfd9e3 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C404_C404.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C404_C404.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C404.py:1:1: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:1:1: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 1 | dict([(i, i) for i in range(3)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 2 | dict([(i, i) for i in range(3)], z=4) | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 1 |-dict([(i, i) for i in range(3)]) @@ -16,16 +16,16 @@ C404.py:1:1: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp 3 3 | 4 4 | def f(x): -C404.py:7:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:7:4: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 5 | return x -6 | +6 | 7 | f'{dict([(s,s) for s in "ab"])}' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 8 | f"{dict([(s,s) for s in 'ab'])}" 9 | f"{dict([(s, s) for s in 'ab'])}" | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 4 4 | def f(x): @@ -37,7 +37,7 @@ C404.py:7:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp 9 9 | f"{dict([(s, s) for s in 'ab'])}" 10 10 | f"{dict([(s,f(s)) for s in 'ab'])}" -C404.py:8:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:8:4: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 7 | f'{dict([(s,s) for s in "ab"])}' 8 | f"{dict([(s,s) for s in 'ab'])}" @@ -45,7 +45,7 @@ C404.py:8:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp 9 | f"{dict([(s, s) for s in 'ab'])}" 10 | f"{dict([(s,f(s)) for s in 'ab'])}" | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 5 5 | return x @@ -57,7 +57,7 @@ C404.py:8:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp 10 10 | f"{dict([(s,f(s)) for s in 'ab'])}" 11 11 | -C404.py:9:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:9:4: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 7 | f'{dict([(s,s) for s in "ab"])}' 8 | f"{dict([(s,s) for s in 'ab'])}" @@ -65,7 +65,7 @@ C404.py:9:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 10 | f"{dict([(s,f(s)) for s in 'ab'])}" | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 6 6 | @@ -77,16 +77,16 @@ C404.py:9:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comp 11 11 | 12 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' -C404.py:10:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:10:4: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 8 | f"{dict([(s,s) for s in 'ab'])}" 9 | f"{dict([(s, s) for s in 'ab'])}" 10 | f"{dict([(s,f(s)) for s in 'ab'])}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 -11 | +11 | 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 7 7 | f'{dict([(s,s) for s in "ab"])}' @@ -98,15 +98,15 @@ C404.py:10:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` com 12 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' 13 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' -C404.py:12:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:12:4: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 10 | f"{dict([(s,f(s)) for s in 'ab'])}" -11 | +11 | 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 9 9 | f"{dict([(s, s) for s in 'ab'])}" @@ -118,15 +118,15 @@ C404.py:12:4: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` com 14 14 | 15 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 -C404.py:12:34: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:12:34: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 10 | f"{dict([(s,f(s)) for s in 'ab'])}" -11 | +11 | 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 9 9 | f"{dict([(s, s) for s in 'ab'])}" @@ -138,15 +138,15 @@ C404.py:12:34: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` co 14 14 | 15 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 -C404.py:13:5: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:13:5: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 -14 | +14 | 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 10 10 | f"{dict([(s,f(s)) for s in 'ab'])}" @@ -158,15 +158,15 @@ C404.py:13:5: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` com 15 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 16 16 | saved.append(dict([(k, v)for k,v in list(unique_instance.__dict__.items()) if k in [f.name for f in unique_instance._meta.fields]])) -C404.py:13:35: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:13:35: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 12 | f'{dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"])}' 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 -14 | +14 | 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 10 10 | f"{dict([(s,f(s)) for s in 'ab'])}" @@ -178,13 +178,13 @@ C404.py:13:35: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` co 15 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 16 16 | saved.append(dict([(k, v)for k,v in list(unique_instance.__dict__.items()) if k in [f.name for f in unique_instance._meta.fields]])) -C404.py:16:14: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` comprehension) +C404.py:16:14: C404 [*] Unnecessary list comprehension (rewrite as a dict comprehension) | 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 16 | saved.append(dict([(k, v)for k,v in list(unique_instance.__dict__.items()) if k in [f.name for f in unique_instance._meta.fields]])) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C404 | - = help: Rewrite as a `dict` comprehension + = help: Rewrite as a dict comprehension ℹ Unsafe fix 13 13 | f'{ dict([(s,s) for s in "ab"]) | dict([(s,s) for s in "ab"]) }' @@ -192,5 +192,3 @@ C404.py:16:14: C404 [*] Unnecessary `list` comprehension (rewrite as a `dict` co 15 15 | # Regression test for: https://github.com/astral-sh/ruff/issues/7087 16 |-saved.append(dict([(k, v)for k,v in list(unique_instance.__dict__.items()) if k in [f.name for f in unique_instance._meta.fields]])) 16 |+saved.append({k: v for k,v in list(unique_instance.__dict__.items()) if k in [f.name for f in unique_instance._meta.fields]}) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C405_C405.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C405_C405.py.snap index 1ab72fff86626..b3c7e4b5bef18 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C405_C405.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C405_C405.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C405.py:1:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:1:1: C405 [*] Unnecessary list literal (rewrite as a set literal) | 1 | set([1, 2]) | ^^^^^^^^^^^ C405 2 | set((1, 2)) 3 | set([]) | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 1 |-set([1, 2]) @@ -17,7 +17,7 @@ C405.py:1:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 3 3 | set([]) 4 4 | set(()) -C405.py:2:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) +C405.py:2:1: C405 [*] Unnecessary tuple literal (rewrite as a set literal) | 1 | set([1, 2]) 2 | set((1, 2)) @@ -25,7 +25,7 @@ C405.py:2:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 3 | set([]) 4 | set(()) | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 1 1 | set([1, 2]) @@ -35,7 +35,7 @@ C405.py:2:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 4 4 | set(()) 5 5 | set() -C405.py:3:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:3:1: C405 [*] Unnecessary list literal (rewrite as a set literal) | 1 | set([1, 2]) 2 | set((1, 2)) @@ -44,7 +44,7 @@ C405.py:3:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 4 | set(()) 5 | set() | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 1 1 | set([1, 2]) @@ -55,7 +55,7 @@ C405.py:3:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 5 5 | set() 6 6 | set((1,)) -C405.py:4:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) +C405.py:4:1: C405 [*] Unnecessary tuple literal (rewrite as a set literal) | 2 | set((1, 2)) 3 | set([]) @@ -64,7 +64,7 @@ C405.py:4:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 5 | set() 6 | set((1,)) | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 1 1 | set([1, 2]) @@ -77,7 +77,7 @@ C405.py:4:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 7 7 | set(( 8 8 | 1, -C405.py:6:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) +C405.py:6:1: C405 [*] Unnecessary tuple literal (rewrite as a set literal) | 4 | set(()) 5 | set() @@ -86,7 +86,7 @@ C405.py:6:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 7 | set(( 8 | 1, | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 3 3 | set([]) @@ -98,7 +98,7 @@ C405.py:6:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 8 8 | 1, 9 9 | )) -C405.py:7:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) +C405.py:7:1: C405 [*] Unnecessary tuple literal (rewrite as a set literal) | 5 | set() 6 | set((1,)) @@ -109,7 +109,7 @@ C405.py:7:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 10 | set([ 11 | 1, | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 4 4 | set(()) @@ -124,7 +124,7 @@ C405.py:7:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 11 11 | 1, 12 12 | ]) -C405.py:10:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:10:1: C405 [*] Unnecessary list literal (rewrite as a set literal) | 8 | 1, 9 | )) @@ -135,7 +135,7 @@ C405.py:10:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 13 | set( 14 | (1,) | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 7 7 | set(( @@ -150,7 +150,7 @@ C405.py:10:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 14 14 | (1,) 15 15 | ) -C405.py:13:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) +C405.py:13:1: C405 [*] Unnecessary tuple literal (rewrite as a set literal) | 11 | 1, 12 | ]) @@ -161,7 +161,7 @@ C405.py:13:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 16 | set( 17 | [1,] | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 10 10 | set([ @@ -175,7 +175,7 @@ C405.py:13:1: C405 [*] Unnecessary `tuple` literal (rewrite as a `set` literal) 17 15 | [1,] 18 16 | ) -C405.py:16:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:16:1: C405 [*] Unnecessary list literal (rewrite as a set literal) | 14 | (1,) 15 | ) @@ -186,7 +186,7 @@ C405.py:16:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 19 | f"{set([1,2,3])}" 20 | f"{set(['a', 'b'])}" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 13 13 | set( @@ -200,7 +200,7 @@ C405.py:16:1: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 20 18 | f"{set(['a', 'b'])}" 21 19 | f'{set(["a", "b"])}' -C405.py:19:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:19:4: C405 [*] Unnecessary list literal (rewrite as a set literal) | 17 | [1,] 18 | ) @@ -209,7 +209,7 @@ C405.py:19:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 20 | f"{set(['a', 'b'])}" 21 | f'{set(["a", "b"])}' | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 16 16 | set( @@ -221,7 +221,7 @@ C405.py:19:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 21 21 | f'{set(["a", "b"])}' 22 22 | -C405.py:20:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:20:4: C405 [*] Unnecessary list literal (rewrite as a set literal) | 18 | ) 19 | f"{set([1,2,3])}" @@ -229,7 +229,7 @@ C405.py:20:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) | ^^^^^^^^^^^^^^^ C405 21 | f'{set(["a", "b"])}' | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 17 17 | [1,] @@ -241,16 +241,16 @@ C405.py:20:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 22 22 | 23 23 | f"{set(['a', 'b']) - set(['a'])}" -C405.py:21:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:21:4: C405 [*] Unnecessary list literal (rewrite as a set literal) | 19 | f"{set([1,2,3])}" 20 | f"{set(['a', 'b'])}" 21 | f'{set(["a", "b"])}' | ^^^^^^^^^^^^^^^ C405 -22 | +22 | 23 | f"{set(['a', 'b']) - set(['a'])}" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 18 18 | ) @@ -262,16 +262,16 @@ C405.py:21:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 23 23 | f"{set(['a', 'b']) - set(['a'])}" 24 24 | f"{ set(['a', 'b']) - set(['a']) }" -C405.py:23:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:23:4: C405 [*] Unnecessary list literal (rewrite as a set literal) | 21 | f'{set(["a", "b"])}' -22 | +22 | 23 | f"{set(['a', 'b']) - set(['a'])}" | ^^^^^^^^^^^^^^^ C405 24 | f"{ set(['a', 'b']) - set(['a']) }" 25 | f"a {set(['a', 'b']) - set(['a'])} b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 20 20 | f"{set(['a', 'b'])}" @@ -283,16 +283,16 @@ C405.py:23:4: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:23:22: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:23:22: C405 [*] Unnecessary list literal (rewrite as a set literal) | 21 | f'{set(["a", "b"])}' -22 | +22 | 23 | f"{set(['a', 'b']) - set(['a'])}" | ^^^^^^^^^^ C405 24 | f"{ set(['a', 'b']) - set(['a']) }" 25 | f"a {set(['a', 'b']) - set(['a'])} b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 20 20 | f"{set(['a', 'b'])}" @@ -304,7 +304,7 @@ C405.py:23:22: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:24:5: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:24:5: C405 [*] Unnecessary list literal (rewrite as a set literal) | 23 | f"{set(['a', 'b']) - set(['a'])}" 24 | f"{ set(['a', 'b']) - set(['a']) }" @@ -312,7 +312,7 @@ C405.py:24:5: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 | f"a { set(['a', 'b']) - set(['a']) } b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 21 21 | f'{set(["a", "b"])}' @@ -323,7 +323,7 @@ C405.py:24:5: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:24:23: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:24:23: C405 [*] Unnecessary list literal (rewrite as a set literal) | 23 | f"{set(['a', 'b']) - set(['a'])}" 24 | f"{ set(['a', 'b']) - set(['a']) }" @@ -331,7 +331,7 @@ C405.py:24:23: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 | f"a { set(['a', 'b']) - set(['a']) } b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 21 21 | f'{set(["a", "b"])}' @@ -342,7 +342,7 @@ C405.py:24:23: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:25:6: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:25:6: C405 [*] Unnecessary list literal (rewrite as a set literal) | 23 | f"{set(['a', 'b']) - set(['a'])}" 24 | f"{ set(['a', 'b']) - set(['a']) }" @@ -350,7 +350,7 @@ C405.py:25:6: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) | ^^^^^^^^^^^^^^^ C405 26 | f"a { set(['a', 'b']) - set(['a']) } b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 22 22 | @@ -360,7 +360,7 @@ C405.py:25:6: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 |+f"a { {'a', 'b'} - set(['a'])} b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:25:24: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:25:24: C405 [*] Unnecessary list literal (rewrite as a set literal) | 23 | f"{set(['a', 'b']) - set(['a'])}" 24 | f"{ set(['a', 'b']) - set(['a']) }" @@ -368,7 +368,7 @@ C405.py:25:24: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) | ^^^^^^^^^^ C405 26 | f"a { set(['a', 'b']) - set(['a']) } b" | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 22 22 | @@ -378,14 +378,14 @@ C405.py:25:24: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 |+f"a {set(['a', 'b']) - {'a'} } b" 26 26 | f"a { set(['a', 'b']) - set(['a']) } b" -C405.py:26:7: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:26:7: C405 [*] Unnecessary list literal (rewrite as a set literal) | 24 | f"{ set(['a', 'b']) - set(['a']) }" 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 | f"a { set(['a', 'b']) - set(['a']) } b" | ^^^^^^^^^^^^^^^ C405 | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 23 23 | f"{set(['a', 'b']) - set(['a'])}" @@ -394,14 +394,14 @@ C405.py:26:7: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 26 |-f"a { set(['a', 'b']) - set(['a']) } b" 26 |+f"a { {'a', 'b'} - set(['a']) } b" -C405.py:26:25: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) +C405.py:26:25: C405 [*] Unnecessary list literal (rewrite as a set literal) | 24 | f"{ set(['a', 'b']) - set(['a']) }" 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 | f"a { set(['a', 'b']) - set(['a']) } b" | ^^^^^^^^^^ C405 | - = help: Rewrite as a `set` literal + = help: Rewrite as a set literal ℹ Unsafe fix 23 23 | f"{set(['a', 'b']) - set(['a'])}" @@ -409,5 +409,3 @@ C405.py:26:25: C405 [*] Unnecessary `list` literal (rewrite as a `set` literal) 25 25 | f"a {set(['a', 'b']) - set(['a'])} b" 26 |-f"a { set(['a', 'b']) - set(['a']) } b" 26 |+f"a { set(['a', 'b']) - {'a'} } b" - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C406_C406.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C406_C406.py.snap index d9847ec6c6178..c8a3853bc18b2 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C406_C406.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C406_C406.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C406.py:1:6: C406 [*] Unnecessary `list` literal (rewrite as a `dict` literal) +C406.py:1:6: C406 [*] Unnecessary list literal (rewrite as a dict literal) | 1 | d1 = dict([(1, 2)]) | ^^^^^^^^^^^^^^ C406 2 | d2 = dict(((1, 2),)) 3 | d3 = dict([]) | - = help: Rewrite as a `dict` literal + = help: Rewrite as a dict literal ℹ Unsafe fix 1 |-d1 = dict([(1, 2)]) @@ -17,7 +17,7 @@ C406.py:1:6: C406 [*] Unnecessary `list` literal (rewrite as a `dict` literal) 3 3 | d3 = dict([]) 4 4 | d4 = dict(()) -C406.py:2:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) +C406.py:2:6: C406 [*] Unnecessary tuple literal (rewrite as a dict literal) | 1 | d1 = dict([(1, 2)]) 2 | d2 = dict(((1, 2),)) @@ -25,7 +25,7 @@ C406.py:2:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) 3 | d3 = dict([]) 4 | d4 = dict(()) | - = help: Rewrite as a `dict` literal + = help: Rewrite as a dict literal ℹ Unsafe fix 1 1 | d1 = dict([(1, 2)]) @@ -35,7 +35,7 @@ C406.py:2:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) 4 4 | d4 = dict(()) 5 5 | d5 = dict() -C406.py:3:6: C406 [*] Unnecessary `list` literal (rewrite as a `dict` literal) +C406.py:3:6: C406 [*] Unnecessary list literal (rewrite as a dict literal) | 1 | d1 = dict([(1, 2)]) 2 | d2 = dict(((1, 2),)) @@ -44,7 +44,7 @@ C406.py:3:6: C406 [*] Unnecessary `list` literal (rewrite as a `dict` literal) 4 | d4 = dict(()) 5 | d5 = dict() | - = help: Rewrite as a `dict` literal + = help: Rewrite as a dict literal ℹ Unsafe fix 1 1 | d1 = dict([(1, 2)]) @@ -54,7 +54,7 @@ C406.py:3:6: C406 [*] Unnecessary `list` literal (rewrite as a `dict` literal) 4 4 | d4 = dict(()) 5 5 | d5 = dict() -C406.py:4:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) +C406.py:4:6: C406 [*] Unnecessary tuple literal (rewrite as a dict literal) | 2 | d2 = dict(((1, 2),)) 3 | d3 = dict([]) @@ -62,7 +62,7 @@ C406.py:4:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) | ^^^^^^^^ C406 5 | d5 = dict() | - = help: Rewrite as a `dict` literal + = help: Rewrite as a dict literal ℹ Unsafe fix 1 1 | d1 = dict([(1, 2)]) @@ -71,5 +71,3 @@ C406.py:4:6: C406 [*] Unnecessary `tuple` literal (rewrite as a `dict` literal) 4 |-d4 = dict(()) 4 |+d4 = {} 5 5 | d5 = dict() - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py.snap index 6b4414d1b4a87..973aa65bc4076 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C408.py:1:5: C408 [*] Unnecessary `tuple` call (rewrite as a literal) +C408.py:1:5: C408 [*] Unnecessary `tuple()` call (rewrite as a literal) | 1 | t = tuple() | ^^^^^^^ C408 @@ -17,7 +17,7 @@ C408.py:1:5: C408 [*] Unnecessary `tuple` call (rewrite as a literal) 3 3 | d1 = dict() 4 4 | d2 = dict(a=1) -C408.py:2:5: C408 [*] Unnecessary `list` call (rewrite as a literal) +C408.py:2:5: C408 [*] Unnecessary `list()` call (rewrite as a literal) | 1 | t = tuple() 2 | l = list() @@ -35,7 +35,7 @@ C408.py:2:5: C408 [*] Unnecessary `list` call (rewrite as a literal) 4 4 | d2 = dict(a=1) 5 5 | d3 = dict(**d2) -C408.py:3:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:3:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 1 | t = tuple() 2 | l = list() @@ -55,7 +55,7 @@ C408.py:3:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 5 5 | d3 = dict(**d2) 6 6 | -C408.py:4:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:4:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 2 | l = list() 3 | d1 = dict() @@ -75,10 +75,10 @@ C408.py:4:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 6 6 | 7 7 | -C408.py:14:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:14:4: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 12 | a = list() -13 | +13 | 14 | f"{dict(x='y')}" | ^^^^^^^^^^^ C408 15 | f'{dict(x="y")}' @@ -96,7 +96,7 @@ C408.py:14:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) 16 16 | f"{dict()}" 17 17 | f"a {dict()} b" -C408.py:15:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:15:4: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 14 | f"{dict(x='y')}" 15 | f'{dict(x="y")}' @@ -116,7 +116,7 @@ C408.py:15:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) 17 17 | f"a {dict()} b" 18 18 | -C408.py:16:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:16:4: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 14 | f"{dict(x='y')}" 15 | f'{dict(x="y")}' @@ -136,13 +136,13 @@ C408.py:16:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) 18 18 | 19 19 | f"{dict(x='y') | dict(y='z')}" -C408.py:17:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:17:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 15 | f'{dict(x="y")}' 16 | f"{dict()}" 17 | f"a {dict()} b" | ^^^^^^ C408 -18 | +18 | 19 | f"{dict(x='y') | dict(y='z')}" | = help: Rewrite as a literal @@ -157,10 +157,10 @@ C408.py:17:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 19 19 | f"{dict(x='y') | dict(y='z')}" 20 20 | f"{ dict(x='y') | dict(y='z') }" -C408.py:19:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:19:4: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 17 | f"a {dict()} b" -18 | +18 | 19 | f"{dict(x='y') | dict(y='z')}" | ^^^^^^^^^^^ C408 20 | f"{ dict(x='y') | dict(y='z') }" @@ -178,10 +178,10 @@ C408.py:19:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) 21 21 | f"a {dict(x='y') | dict(y='z')} b" 22 22 | f"a { dict(x='y') | dict(y='z') } b" -C408.py:19:18: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:19:18: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 17 | f"a {dict()} b" -18 | +18 | 19 | f"{dict(x='y') | dict(y='z')}" | ^^^^^^^^^^^ C408 20 | f"{ dict(x='y') | dict(y='z') }" @@ -199,7 +199,7 @@ C408.py:19:18: C408 [*] Unnecessary `dict` call (rewrite as a literal) 21 21 | f"a {dict(x='y') | dict(y='z')} b" 22 22 | f"a { dict(x='y') | dict(y='z') } b" -C408.py:20:5: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:20:5: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 19 | f"{dict(x='y') | dict(y='z')}" 20 | f"{ dict(x='y') | dict(y='z') }" @@ -219,7 +219,7 @@ C408.py:20:5: C408 [*] Unnecessary `dict` call (rewrite as a literal) 22 22 | f"a { dict(x='y') | dict(y='z') } b" 23 23 | -C408.py:20:19: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:20:19: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 19 | f"{dict(x='y') | dict(y='z')}" 20 | f"{ dict(x='y') | dict(y='z') }" @@ -239,7 +239,7 @@ C408.py:20:19: C408 [*] Unnecessary `dict` call (rewrite as a literal) 22 22 | f"a { dict(x='y') | dict(y='z') } b" 23 23 | -C408.py:21:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:21:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 19 | f"{dict(x='y') | dict(y='z')}" 20 | f"{ dict(x='y') | dict(y='z') }" @@ -259,7 +259,7 @@ C408.py:21:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 23 23 | 24 24 | dict( -C408.py:21:20: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:21:20: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 19 | f"{dict(x='y') | dict(y='z')}" 20 | f"{ dict(x='y') | dict(y='z') }" @@ -279,13 +279,13 @@ C408.py:21:20: C408 [*] Unnecessary `dict` call (rewrite as a literal) 23 23 | 24 24 | dict( -C408.py:22:7: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:22:7: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 20 | f"{ dict(x='y') | dict(y='z') }" 21 | f"a {dict(x='y') | dict(y='z')} b" 22 | f"a { dict(x='y') | dict(y='z') } b" | ^^^^^^^^^^^ C408 -23 | +23 | 24 | dict( | = help: Rewrite as a literal @@ -300,13 +300,13 @@ C408.py:22:7: C408 [*] Unnecessary `dict` call (rewrite as a literal) 24 24 | dict( 25 25 | # comment -C408.py:22:21: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:22:21: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 20 | f"{ dict(x='y') | dict(y='z') }" 21 | f"a {dict(x='y') | dict(y='z')} b" 22 | f"a { dict(x='y') | dict(y='z') } b" | ^^^^^^^^^^^ C408 -23 | +23 | 24 | dict( | = help: Rewrite as a literal @@ -321,15 +321,15 @@ C408.py:22:21: C408 [*] Unnecessary `dict` call (rewrite as a literal) 24 24 | dict( 25 25 | # comment -C408.py:24:1: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:24:1: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 22 | f"a { dict(x='y') | dict(y='z') } b" -23 | +23 | 24 | / dict( 25 | | # comment 26 | | ) | |_^ C408 -27 | +27 | 28 | tuple( # comment | = help: Rewrite as a literal @@ -347,10 +347,10 @@ C408.py:24:1: C408 [*] Unnecessary `dict` call (rewrite as a literal) 28 28 | tuple( # comment 29 29 | ) -C408.py:28:1: C408 [*] Unnecessary `tuple` call (rewrite as a literal) +C408.py:28:1: C408 [*] Unnecessary `tuple()` call (rewrite as a literal) | 26 | ) -27 | +27 | 28 | / tuple( # comment 29 | | ) | |_^ C408 @@ -364,5 +364,3 @@ C408.py:28:1: C408 [*] Unnecessary `tuple` call (rewrite as a literal) 28 |-tuple( # comment 28 |+( # comment 29 29 | ) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py_allow_dict_calls_with_keyword_arguments.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py_allow_dict_calls_with_keyword_arguments.snap index 59c761f4aa603..17911683f1723 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py_allow_dict_calls_with_keyword_arguments.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C408_C408.py_allow_dict_calls_with_keyword_arguments.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C408.py:1:5: C408 [*] Unnecessary `tuple` call (rewrite as a literal) +C408.py:1:5: C408 [*] Unnecessary `tuple()` call (rewrite as a literal) | 1 | t = tuple() | ^^^^^^^ C408 @@ -17,7 +17,7 @@ C408.py:1:5: C408 [*] Unnecessary `tuple` call (rewrite as a literal) 3 3 | d1 = dict() 4 4 | d2 = dict(a=1) -C408.py:2:5: C408 [*] Unnecessary `list` call (rewrite as a literal) +C408.py:2:5: C408 [*] Unnecessary `list()` call (rewrite as a literal) | 1 | t = tuple() 2 | l = list() @@ -35,7 +35,7 @@ C408.py:2:5: C408 [*] Unnecessary `list` call (rewrite as a literal) 4 4 | d2 = dict(a=1) 5 5 | d3 = dict(**d2) -C408.py:3:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:3:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 1 | t = tuple() 2 | l = list() @@ -55,7 +55,7 @@ C408.py:3:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 5 5 | d3 = dict(**d2) 6 6 | -C408.py:16:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:16:4: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 14 | f"{dict(x='y')}" 15 | f'{dict(x="y")}' @@ -75,13 +75,13 @@ C408.py:16:4: C408 [*] Unnecessary `dict` call (rewrite as a literal) 18 18 | 19 19 | f"{dict(x='y') | dict(y='z')}" -C408.py:17:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:17:6: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 15 | f'{dict(x="y")}' 16 | f"{dict()}" 17 | f"a {dict()} b" | ^^^^^^ C408 -18 | +18 | 19 | f"{dict(x='y') | dict(y='z')}" | = help: Rewrite as a literal @@ -96,15 +96,15 @@ C408.py:17:6: C408 [*] Unnecessary `dict` call (rewrite as a literal) 19 19 | f"{dict(x='y') | dict(y='z')}" 20 20 | f"{ dict(x='y') | dict(y='z') }" -C408.py:24:1: C408 [*] Unnecessary `dict` call (rewrite as a literal) +C408.py:24:1: C408 [*] Unnecessary `dict()` call (rewrite as a literal) | 22 | f"a { dict(x='y') | dict(y='z') } b" -23 | +23 | 24 | / dict( 25 | | # comment 26 | | ) | |_^ C408 -27 | +27 | 28 | tuple( # comment | = help: Rewrite as a literal @@ -122,10 +122,10 @@ C408.py:24:1: C408 [*] Unnecessary `dict` call (rewrite as a literal) 28 28 | tuple( # comment 29 29 | ) -C408.py:28:1: C408 [*] Unnecessary `tuple` call (rewrite as a literal) +C408.py:28:1: C408 [*] Unnecessary `tuple()` call (rewrite as a literal) | 26 | ) -27 | +27 | 28 | / tuple( # comment 29 | | ) | |_^ C408 @@ -139,5 +139,3 @@ C408.py:28:1: C408 [*] Unnecessary `tuple` call (rewrite as a literal) 28 |-tuple( # comment 28 |+( # comment 29 29 | ) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C409_C409.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C409_C409.py.snap index e2dbdb31f2d0c..3b2fd728cc6c3 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C409_C409.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C409_C409.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C409.py:1:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:1:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 1 | t1 = tuple([]) | ^^^^^^^^^ C409 2 | t2 = tuple([1, 2]) 3 | t3 = tuple((1, 2)) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 |-t1 = tuple([]) @@ -17,7 +17,7 @@ C409.py:1:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 3 3 | t3 = tuple((1, 2)) 4 4 | t4 = tuple([ -C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:2:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 1 | t1 = tuple([]) 2 | t2 = tuple([1, 2]) @@ -25,7 +25,7 @@ C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 3 | t3 = tuple((1, 2)) 4 | t4 = tuple([ | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 1 | t1 = tuple([]) @@ -35,7 +35,7 @@ C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 4 4 | t4 = tuple([ 5 5 | 1, -C409.py:3:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:3:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 1 | t1 = tuple([]) 2 | t2 = tuple([1, 2]) @@ -55,7 +55,7 @@ C409.py:3:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 5 5 | 1, 6 6 | 2 -C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:4:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 2 | t2 = tuple([1, 2]) 3 | t3 = tuple((1, 2)) @@ -68,7 +68,7 @@ C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 8 | t5 = tuple( 9 | (1, 2) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 1 | t1 = tuple([]) @@ -84,7 +84,7 @@ C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 9 9 | (1, 2) 10 10 | ) -C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:8:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 6 | 2 7 | ]) @@ -93,7 +93,7 @@ C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 9 | | (1, 2) 10 | | ) | |_^ C409 -11 | +11 | 12 | tuple( # comment | = help: Remove the outer call to `tuple()` @@ -110,18 +110,18 @@ C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 12 10 | tuple( # comment 13 11 | [1, 2] -C409.py:12:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:12:1: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 10 | ) -11 | +11 | 12 | / tuple( # comment 13 | | [1, 2] 14 | | ) | |_^ C409 -15 | +15 | 16 | tuple([ # comment | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 9 9 | (1, 2) @@ -135,18 +135,18 @@ C409.py:12:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 16 14 | tuple([ # comment 17 15 | 1, 2 -C409.py:16:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:16:1: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 14 | ) -15 | +15 | 16 | / tuple([ # comment 17 | | 1, 2 18 | | ]) | |__^ C409 -19 | +19 | 20 | tuple(( | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 13 13 | [1, 2] @@ -161,15 +161,15 @@ C409.py:16:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 20 20 | tuple(( 21 21 | 1, -C409.py:20:1: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:20:1: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 18 | ]) -19 | +19 | 20 | / tuple(( 21 | | 1, 22 | | )) | |__^ C409 -23 | +23 | 24 | t6 = tuple([1]) | = help: Remove the outer call to `tuple()` @@ -187,16 +187,16 @@ C409.py:20:1: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove t 24 24 | t6 = tuple([1]) 25 25 | t7 = tuple((1,)) -C409.py:24:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:24:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 22 | )) -23 | +23 | 24 | t6 = tuple([1]) | ^^^^^^^^^^ C409 25 | t7 = tuple((1,)) 26 | t8 = tuple([1,]) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 21 21 | 1, @@ -208,7 +208,7 @@ C409.py:24:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 26 26 | t8 = tuple([1,]) 27 27 | -C409.py:25:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:25:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 24 | t6 = tuple([1]) 25 | t7 = tuple((1,)) @@ -227,16 +227,16 @@ C409.py:25:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove t 27 27 | 28 28 | tuple([x for x in range(5)]) -C409.py:26:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:26:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 24 | t6 = tuple([1]) 25 | t7 = tuple((1,)) 26 | t8 = tuple([1,]) | ^^^^^^^^^^^ C409 -27 | +27 | 28 | tuple([x for x in range(5)]) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 23 23 | diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C410_C410.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C410_C410.py.snap index 921547ca2dedc..35dd289c78739 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C410_C410.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C410_C410.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C410.py:1:6: C410 [*] Unnecessary `list` literal passed to `list()` (remove the outer call to `list()`) +C410.py:1:6: C410 [*] Unnecessary list literal passed to `list()` (remove the outer call to `list()`) | 1 | l1 = list([1, 2]) | ^^^^^^^^^^^^ C410 2 | l2 = list((1, 2)) 3 | l3 = list([]) | - = help: Remove outer `list` call + = help: Remove outer `list()` call ℹ Unsafe fix 1 |-l1 = list([1, 2]) @@ -17,7 +17,7 @@ C410.py:1:6: C410 [*] Unnecessary `list` literal passed to `list()` (remove the 3 3 | l3 = list([]) 4 4 | l4 = list(()) -C410.py:2:6: C410 [*] Unnecessary `tuple` literal passed to `list()` (rewrite as a `list` literal) +C410.py:2:6: C410 [*] Unnecessary tuple literal passed to `list()` (rewrite as a single list literal) | 1 | l1 = list([1, 2]) 2 | l2 = list((1, 2)) @@ -25,7 +25,7 @@ C410.py:2:6: C410 [*] Unnecessary `tuple` literal passed to `list()` (rewrite as 3 | l3 = list([]) 4 | l4 = list(()) | - = help: Rewrite as a `list` literal + = help: Rewrite as a single list literal ℹ Unsafe fix 1 1 | l1 = list([1, 2]) @@ -35,7 +35,7 @@ C410.py:2:6: C410 [*] Unnecessary `tuple` literal passed to `list()` (rewrite as 4 4 | l4 = list(()) 5 5 | -C410.py:3:6: C410 [*] Unnecessary `list` literal passed to `list()` (remove the outer call to `list()`) +C410.py:3:6: C410 [*] Unnecessary list literal passed to `list()` (remove the outer call to `list()`) | 1 | l1 = list([1, 2]) 2 | l2 = list((1, 2)) @@ -43,7 +43,7 @@ C410.py:3:6: C410 [*] Unnecessary `list` literal passed to `list()` (remove the | ^^^^^^^^ C410 4 | l4 = list(()) | - = help: Remove outer `list` call + = help: Remove outer `list()` call ℹ Unsafe fix 1 1 | l1 = list([1, 2]) @@ -54,14 +54,14 @@ C410.py:3:6: C410 [*] Unnecessary `list` literal passed to `list()` (remove the 5 5 | 6 6 | -C410.py:4:6: C410 [*] Unnecessary `tuple` literal passed to `list()` (rewrite as a `list` literal) +C410.py:4:6: C410 [*] Unnecessary tuple literal passed to `list()` (rewrite as a single list literal) | 2 | l2 = list((1, 2)) 3 | l3 = list([]) 4 | l4 = list(()) | ^^^^^^^^ C410 | - = help: Rewrite as a `list` literal + = help: Rewrite as a single list literal ℹ Unsafe fix 1 1 | l1 = list([1, 2]) @@ -73,16 +73,16 @@ C410.py:4:6: C410 [*] Unnecessary `tuple` literal passed to `list()` (rewrite as 6 6 | 7 7 | list( # comment -C410.py:7:1: C410 [*] Unnecessary `list` literal passed to `list()` (remove the outer call to `list()`) +C410.py:7:1: C410 [*] Unnecessary list literal passed to `list()` (remove the outer call to `list()`) | 7 | / list( # comment 8 | | [1, 2] 9 | | ) | |_^ C410 -10 | +10 | 11 | list([ # comment | - = help: Remove outer `list` call + = help: Remove outer `list()` call ℹ Unsafe fix 4 4 | l4 = list(()) @@ -96,16 +96,18 @@ C410.py:7:1: C410 [*] Unnecessary `list` literal passed to `list()` (remove the 11 9 | list([ # comment 12 10 | 1, 2 -C410.py:11:1: C410 [*] Unnecessary `list` literal passed to `list()` (remove the outer call to `list()`) +C410.py:11:1: C410 [*] Unnecessary list literal passed to `list()` (remove the outer call to `list()`) | 9 | ) -10 | +10 | 11 | / list([ # comment 12 | | 1, 2 13 | | ]) | |__^ C410 +14 | +15 | # Skip when too many positional arguments | - = help: Remove outer `list` call + = help: Remove outer `list()` call ℹ Unsafe fix 8 8 | [1, 2] @@ -116,5 +118,6 @@ C410.py:11:1: C410 [*] Unnecessary `list` literal passed to `list()` (remove the 12 12 | 1, 2 13 |-]) 13 |+] - - +14 14 | +15 15 | # Skip when too many positional arguments +16 16 | # See https://github.com/astral-sh/ruff/issues/15810 diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C411_C411.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C411_C411.py.snap index 763f99136ea68..84882a467437d 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C411_C411.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C411_C411.py.snap @@ -1,17 +1,20 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C411.py:2:1: C411 [*] Unnecessary `list` call (remove the outer call to `list()`) +C411.py:2:1: C411 [*] Unnecessary `list()` call (remove the outer call to `list()`) | 1 | x = [1, 2, 3] 2 | list([i for i in x]) | ^^^^^^^^^^^^^^^^^^^^ C411 +3 | +4 | # Skip when too many positional arguments | - = help: Remove outer `list` call + = help: Remove outer `list()` call ℹ Unsafe fix 1 1 | x = [1, 2, 3] 2 |-list([i for i in x]) 2 |+[i for i in x] - - +3 3 | +4 4 | # Skip when too many positional arguments +5 5 | # or keyword argument present. diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C413_C413.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C413_C413.py.snap index def04f25aea8f..5b131c59f2b51 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C413_C413.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C413_C413.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C413.py:3:1: C413 [*] Unnecessary `list` call around `sorted()` +C413.py:3:1: C413 [*] Unnecessary `list()` call around `sorted()` | 1 | x = [2, 3, 1] 2 | list(x) @@ -10,7 +10,7 @@ C413.py:3:1: C413 [*] Unnecessary `list` call around `sorted()` 4 | reversed(sorted(x)) 5 | reversed(sorted(x, key=lambda e: e)) | - = help: Remove unnecessary `list` call + = help: Remove unnecessary `list()` call ℹ Safe fix 1 1 | x = [2, 3, 1] @@ -21,7 +21,7 @@ C413.py:3:1: C413 [*] Unnecessary `list` call around `sorted()` 5 5 | reversed(sorted(x, key=lambda e: e)) 6 6 | reversed(sorted(x, reverse=True)) -C413.py:4:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:4:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 2 | list(x) 3 | list(sorted(x)) @@ -30,7 +30,7 @@ C413.py:4:1: C413 [*] Unnecessary `reversed` call around `sorted()` 5 | reversed(sorted(x, key=lambda e: e)) 6 | reversed(sorted(x, reverse=True)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 1 1 | x = [2, 3, 1] @@ -42,7 +42,7 @@ C413.py:4:1: C413 [*] Unnecessary `reversed` call around `sorted()` 6 6 | reversed(sorted(x, reverse=True)) 7 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) -C413.py:5:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:5:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 3 | list(sorted(x)) 4 | reversed(sorted(x)) @@ -51,7 +51,7 @@ C413.py:5:1: C413 [*] Unnecessary `reversed` call around `sorted()` 6 | reversed(sorted(x, reverse=True)) 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 2 2 | list(x) @@ -63,7 +63,7 @@ C413.py:5:1: C413 [*] Unnecessary `reversed` call around `sorted()` 7 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) 8 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) -C413.py:6:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:6:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 4 | reversed(sorted(x)) 5 | reversed(sorted(x, key=lambda e: e)) @@ -72,7 +72,7 @@ C413.py:6:1: C413 [*] Unnecessary `reversed` call around `sorted()` 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 3 3 | list(sorted(x)) @@ -84,7 +84,7 @@ C413.py:6:1: C413 [*] Unnecessary `reversed` call around `sorted()` 8 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) 9 9 | reversed(sorted(x, reverse=False)) -C413.py:7:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:7:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 5 | reversed(sorted(x, key=lambda e: e)) 6 | reversed(sorted(x, reverse=True)) @@ -93,7 +93,7 @@ C413.py:7:1: C413 [*] Unnecessary `reversed` call around `sorted()` 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) 9 | reversed(sorted(x, reverse=False)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 4 4 | reversed(sorted(x)) @@ -105,7 +105,7 @@ C413.py:7:1: C413 [*] Unnecessary `reversed` call around `sorted()` 9 9 | reversed(sorted(x, reverse=False)) 10 10 | reversed(sorted(x, reverse=x)) -C413.py:8:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:8:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 6 | reversed(sorted(x, reverse=True)) 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) @@ -114,7 +114,7 @@ C413.py:8:1: C413 [*] Unnecessary `reversed` call around `sorted()` 9 | reversed(sorted(x, reverse=False)) 10 | reversed(sorted(x, reverse=x)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 5 5 | reversed(sorted(x, key=lambda e: e)) @@ -126,7 +126,7 @@ C413.py:8:1: C413 [*] Unnecessary `reversed` call around `sorted()` 10 10 | reversed(sorted(x, reverse=x)) 11 11 | reversed(sorted(x, reverse=not x)) -C413.py:9:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:9:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) @@ -135,7 +135,7 @@ C413.py:9:1: C413 [*] Unnecessary `reversed` call around `sorted()` 10 | reversed(sorted(x, reverse=x)) 11 | reversed(sorted(x, reverse=not x)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 6 6 | reversed(sorted(x, reverse=True)) @@ -147,7 +147,7 @@ C413.py:9:1: C413 [*] Unnecessary `reversed` call around `sorted()` 11 11 | reversed(sorted(x, reverse=not x)) 12 12 | -C413.py:10:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:10:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) 9 | reversed(sorted(x, reverse=False)) @@ -155,7 +155,7 @@ C413.py:10:1: C413 [*] Unnecessary `reversed` call around `sorted()` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 11 | reversed(sorted(x, reverse=not x)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 7 7 | reversed(sorted(x, key=lambda e: e, reverse=True)) @@ -167,16 +167,16 @@ C413.py:10:1: C413 [*] Unnecessary `reversed` call around `sorted()` 12 12 | 13 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7289 -C413.py:11:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:11:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 9 | reversed(sorted(x, reverse=False)) 10 | reversed(sorted(x, reverse=x)) 11 | reversed(sorted(x, reverse=not x)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 -12 | +12 | 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7289 | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 8 8 | reversed(sorted(x, reverse=True, key=lambda e: e)) @@ -188,14 +188,14 @@ C413.py:11:1: C413 [*] Unnecessary `reversed` call around `sorted()` 13 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7289 14 14 | reversed(sorted(i for i in range(42))) -C413.py:14:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:14:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7289 14 | reversed(sorted(i for i in range(42))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 15 | reversed(sorted((i for i in range(42)), reverse=True)) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 11 11 | reversed(sorted(x, reverse=not x)) @@ -207,16 +207,16 @@ C413.py:14:1: C413 [*] Unnecessary `reversed` call around `sorted()` 16 16 | 17 17 | # Regression test for: https://github.com/astral-sh/ruff/issues/10335 -C413.py:15:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:15:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7289 14 | reversed(sorted(i for i in range(42))) 15 | reversed(sorted((i for i in range(42)), reverse=True)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 -16 | +16 | 17 | # Regression test for: https://github.com/astral-sh/ruff/issues/10335 | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 12 12 | @@ -228,14 +228,14 @@ C413.py:15:1: C413 [*] Unnecessary `reversed` call around `sorted()` 17 17 | # Regression test for: https://github.com/astral-sh/ruff/issues/10335 18 18 | reversed(sorted([1, 2, 3], reverse=False or True)) -C413.py:18:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:18:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 17 | # Regression test for: https://github.com/astral-sh/ruff/issues/10335 18 | reversed(sorted([1, 2, 3], reverse=False or True)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 19 | reversed(sorted([1, 2, 3], reverse=(False or True))) | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 15 15 | reversed(sorted((i for i in range(42)), reverse=True)) @@ -244,15 +244,19 @@ C413.py:18:1: C413 [*] Unnecessary `reversed` call around `sorted()` 18 |-reversed(sorted([1, 2, 3], reverse=False or True)) 18 |+sorted([1, 2, 3], reverse=not (False or True)) 19 19 | reversed(sorted([1, 2, 3], reverse=(False or True))) +20 20 | +21 21 | # These fixes need to be parenthesized to avoid syntax errors and behavior -C413.py:19:1: C413 [*] Unnecessary `reversed` call around `sorted()` +C413.py:19:1: C413 [*] Unnecessary `reversed()` call around `sorted()` | 17 | # Regression test for: https://github.com/astral-sh/ruff/issues/10335 18 | reversed(sorted([1, 2, 3], reverse=False or True)) 19 | reversed(sorted([1, 2, 3], reverse=(False or True))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C413 +20 | +21 | # These fixes need to be parenthesized to avoid syntax errors and behavior | - = help: Remove unnecessary `reversed` call + = help: Remove unnecessary `reversed()` call ℹ Unsafe fix 16 16 | @@ -260,3 +264,70 @@ C413.py:19:1: C413 [*] Unnecessary `reversed` call around `sorted()` 18 18 | reversed(sorted([1, 2, 3], reverse=False or True)) 19 |-reversed(sorted([1, 2, 3], reverse=(False or True))) 19 |+sorted([1, 2, 3], reverse=not (False or True)) +20 20 | +21 21 | # These fixes need to be parenthesized to avoid syntax errors and behavior +22 22 | # changes. + +C413.py:24:1: C413 [*] Unnecessary `reversed()` call around `sorted()` + | +22 | # changes. +23 | # See https://github.com/astral-sh/ruff/issues/15789 +24 | / reversed(sorted +25 | | ("")) + | |_____^ C413 +26 | list(sorted +27 | ("")) + | + = help: Remove unnecessary `reversed()` call + +ℹ Unsafe fix +21 21 | # These fixes need to be parenthesized to avoid syntax errors and behavior +22 22 | # changes. +23 23 | # See https://github.com/astral-sh/ruff/issues/15789 +24 |-reversed(sorted +25 |-("")) + 24 |+(sorted + 25 |+("", reverse=True)) +26 26 | list(sorted +27 27 | ("")) +28 28 | list(sorted + +C413.py:26:1: C413 [*] Unnecessary `list()` call around `sorted()` + | +24 | reversed(sorted +25 | ("")) +26 | / list(sorted +27 | | ("")) + | |_________^ C413 +28 | list(sorted +29 | ("xy")) + | + = help: Remove unnecessary `list()` call + +ℹ Safe fix +23 23 | # See https://github.com/astral-sh/ruff/issues/15789 +24 24 | reversed(sorted +25 25 | ("")) +26 |-list(sorted + 26 |+(sorted +27 27 | ("")) +28 28 | list(sorted +29 29 | ("xy")) + +C413.py:28:1: C413 [*] Unnecessary `list()` call around `sorted()` + | +26 | list(sorted +27 | ("")) +28 | / list(sorted +29 | | ("xy")) + | |_______^ C413 + | + = help: Remove unnecessary `list()` call + +ℹ Safe fix +25 25 | ("")) +26 26 | list(sorted +27 27 | ("")) +28 |-list(sorted + 28 |+(sorted +29 29 | ("xy")) diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C414_C414.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C414_C414.py.snap index 1551f9ccec221..af3a238f648bb 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C414_C414.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C414_C414.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C414.py:2:1: C414 [*] Unnecessary `list` call within `list()` +C414.py:2:1: C414 [*] Unnecessary `list()` call within `list()` | 1 | x = [1, 2, 3] 2 | list(list(x)) @@ -9,7 +9,7 @@ C414.py:2:1: C414 [*] Unnecessary `list` call within `list()` 3 | list(tuple(x)) 4 | tuple(list(x)) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 1 1 | x = [1, 2, 3] @@ -19,7 +19,7 @@ C414.py:2:1: C414 [*] Unnecessary `list` call within `list()` 4 4 | tuple(list(x)) 5 5 | tuple(tuple(x)) -C414.py:3:1: C414 [*] Unnecessary `tuple` call within `list()` +C414.py:3:1: C414 [*] Unnecessary `tuple()` call within `list()` | 1 | x = [1, 2, 3] 2 | list(list(x)) @@ -28,7 +28,7 @@ C414.py:3:1: C414 [*] Unnecessary `tuple` call within `list()` 4 | tuple(list(x)) 5 | tuple(tuple(x)) | - = help: Remove the inner `tuple` call + = help: Remove the inner `tuple()` call ℹ Unsafe fix 1 1 | x = [1, 2, 3] @@ -39,7 +39,7 @@ C414.py:3:1: C414 [*] Unnecessary `tuple` call within `list()` 5 5 | tuple(tuple(x)) 6 6 | set(set(x)) -C414.py:4:1: C414 [*] Unnecessary `list` call within `tuple()` +C414.py:4:1: C414 [*] Unnecessary `list()` call within `tuple()` | 2 | list(list(x)) 3 | list(tuple(x)) @@ -48,7 +48,7 @@ C414.py:4:1: C414 [*] Unnecessary `list` call within `tuple()` 5 | tuple(tuple(x)) 6 | set(set(x)) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 1 1 | x = [1, 2, 3] @@ -60,7 +60,7 @@ C414.py:4:1: C414 [*] Unnecessary `list` call within `tuple()` 6 6 | set(set(x)) 7 7 | set(list(x)) -C414.py:5:1: C414 [*] Unnecessary `tuple` call within `tuple()` +C414.py:5:1: C414 [*] Unnecessary `tuple()` call within `tuple()` | 3 | list(tuple(x)) 4 | tuple(list(x)) @@ -69,7 +69,7 @@ C414.py:5:1: C414 [*] Unnecessary `tuple` call within `tuple()` 6 | set(set(x)) 7 | set(list(x)) | - = help: Remove the inner `tuple` call + = help: Remove the inner `tuple()` call ℹ Unsafe fix 2 2 | list(list(x)) @@ -81,7 +81,7 @@ C414.py:5:1: C414 [*] Unnecessary `tuple` call within `tuple()` 7 7 | set(list(x)) 8 8 | set(tuple(x)) -C414.py:6:1: C414 [*] Unnecessary `set` call within `set()` +C414.py:6:1: C414 [*] Unnecessary `set()` call within `set()` | 4 | tuple(list(x)) 5 | tuple(tuple(x)) @@ -90,7 +90,7 @@ C414.py:6:1: C414 [*] Unnecessary `set` call within `set()` 7 | set(list(x)) 8 | set(tuple(x)) | - = help: Remove the inner `set` call + = help: Remove the inner `set()` call ℹ Unsafe fix 3 3 | list(tuple(x)) @@ -102,7 +102,7 @@ C414.py:6:1: C414 [*] Unnecessary `set` call within `set()` 8 8 | set(tuple(x)) 9 9 | set(sorted(x)) -C414.py:7:1: C414 [*] Unnecessary `list` call within `set()` +C414.py:7:1: C414 [*] Unnecessary `list()` call within `set()` | 5 | tuple(tuple(x)) 6 | set(set(x)) @@ -111,7 +111,7 @@ C414.py:7:1: C414 [*] Unnecessary `list` call within `set()` 8 | set(tuple(x)) 9 | set(sorted(x)) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 4 4 | tuple(list(x)) @@ -123,7 +123,7 @@ C414.py:7:1: C414 [*] Unnecessary `list` call within `set()` 9 9 | set(sorted(x)) 10 10 | set(sorted(x, key=lambda y: y)) -C414.py:8:1: C414 [*] Unnecessary `tuple` call within `set()` +C414.py:8:1: C414 [*] Unnecessary `tuple()` call within `set()` | 6 | set(set(x)) 7 | set(list(x)) @@ -132,7 +132,7 @@ C414.py:8:1: C414 [*] Unnecessary `tuple` call within `set()` 9 | set(sorted(x)) 10 | set(sorted(x, key=lambda y: y)) | - = help: Remove the inner `tuple` call + = help: Remove the inner `tuple()` call ℹ Unsafe fix 5 5 | tuple(tuple(x)) @@ -144,7 +144,7 @@ C414.py:8:1: C414 [*] Unnecessary `tuple` call within `set()` 10 10 | set(sorted(x, key=lambda y: y)) 11 11 | set(reversed(x)) -C414.py:9:1: C414 [*] Unnecessary `sorted` call within `set()` +C414.py:9:1: C414 [*] Unnecessary `sorted()` call within `set()` | 7 | set(list(x)) 8 | set(tuple(x)) @@ -153,7 +153,7 @@ C414.py:9:1: C414 [*] Unnecessary `sorted` call within `set()` 10 | set(sorted(x, key=lambda y: y)) 11 | set(reversed(x)) | - = help: Remove the inner `sorted` call + = help: Remove the inner `sorted()` call ℹ Unsafe fix 6 6 | set(set(x)) @@ -165,7 +165,7 @@ C414.py:9:1: C414 [*] Unnecessary `sorted` call within `set()` 11 11 | set(reversed(x)) 12 12 | sorted(list(x)) -C414.py:10:1: C414 [*] Unnecessary `sorted` call within `set()` +C414.py:10:1: C414 [*] Unnecessary `sorted()` call within `set()` | 8 | set(tuple(x)) 9 | set(sorted(x)) @@ -174,7 +174,7 @@ C414.py:10:1: C414 [*] Unnecessary `sorted` call within `set()` 11 | set(reversed(x)) 12 | sorted(list(x)) | - = help: Remove the inner `sorted` call + = help: Remove the inner `sorted()` call ℹ Unsafe fix 7 7 | set(list(x)) @@ -186,7 +186,7 @@ C414.py:10:1: C414 [*] Unnecessary `sorted` call within `set()` 12 12 | sorted(list(x)) 13 13 | sorted(tuple(x)) -C414.py:11:1: C414 [*] Unnecessary `reversed` call within `set()` +C414.py:11:1: C414 [*] Unnecessary `reversed()` call within `set()` | 9 | set(sorted(x)) 10 | set(sorted(x, key=lambda y: y)) @@ -195,7 +195,7 @@ C414.py:11:1: C414 [*] Unnecessary `reversed` call within `set()` 12 | sorted(list(x)) 13 | sorted(tuple(x)) | - = help: Remove the inner `reversed` call + = help: Remove the inner `reversed()` call ℹ Unsafe fix 8 8 | set(tuple(x)) @@ -207,7 +207,7 @@ C414.py:11:1: C414 [*] Unnecessary `reversed` call within `set()` 13 13 | sorted(tuple(x)) 14 14 | sorted(sorted(x)) -C414.py:12:1: C414 [*] Unnecessary `list` call within `sorted()` +C414.py:12:1: C414 [*] Unnecessary `list()` call within `sorted()` | 10 | set(sorted(x, key=lambda y: y)) 11 | set(reversed(x)) @@ -216,7 +216,7 @@ C414.py:12:1: C414 [*] Unnecessary `list` call within `sorted()` 13 | sorted(tuple(x)) 14 | sorted(sorted(x)) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 9 9 | set(sorted(x)) @@ -228,7 +228,7 @@ C414.py:12:1: C414 [*] Unnecessary `list` call within `sorted()` 14 14 | sorted(sorted(x)) 15 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) -C414.py:13:1: C414 [*] Unnecessary `tuple` call within `sorted()` +C414.py:13:1: C414 [*] Unnecessary `tuple()` call within `sorted()` | 11 | set(reversed(x)) 12 | sorted(list(x)) @@ -237,7 +237,7 @@ C414.py:13:1: C414 [*] Unnecessary `tuple` call within `sorted()` 14 | sorted(sorted(x)) 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) | - = help: Remove the inner `tuple` call + = help: Remove the inner `tuple()` call ℹ Unsafe fix 10 10 | set(sorted(x, key=lambda y: y)) @@ -249,7 +249,7 @@ C414.py:13:1: C414 [*] Unnecessary `tuple` call within `sorted()` 15 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) 16 16 | sorted(sorted(x, reverse=True), reverse=True) -C414.py:14:1: C414 [*] Unnecessary `sorted` call within `sorted()` +C414.py:14:1: C414 [*] Unnecessary `sorted()` call within `sorted()` | 12 | sorted(list(x)) 13 | sorted(tuple(x)) @@ -258,7 +258,7 @@ C414.py:14:1: C414 [*] Unnecessary `sorted` call within `sorted()` 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) 16 | sorted(sorted(x, reverse=True), reverse=True) | - = help: Remove the inner `sorted` call + = help: Remove the inner `sorted()` call ℹ Unsafe fix 11 11 | set(reversed(x)) @@ -270,7 +270,7 @@ C414.py:14:1: C414 [*] Unnecessary `sorted` call within `sorted()` 16 16 | sorted(sorted(x, reverse=True), reverse=True) 17 17 | sorted(reversed(x)) -C414.py:15:1: C414 [*] Unnecessary `sorted` call within `sorted()` +C414.py:15:1: C414 [*] Unnecessary `sorted()` call within `sorted()` | 13 | sorted(tuple(x)) 14 | sorted(sorted(x)) @@ -279,7 +279,7 @@ C414.py:15:1: C414 [*] Unnecessary `sorted` call within `sorted()` 16 | sorted(sorted(x, reverse=True), reverse=True) 17 | sorted(reversed(x)) | - = help: Remove the inner `sorted` call + = help: Remove the inner `sorted()` call ℹ Unsafe fix 12 12 | sorted(list(x)) @@ -291,7 +291,7 @@ C414.py:15:1: C414 [*] Unnecessary `sorted` call within `sorted()` 17 17 | sorted(reversed(x)) 18 18 | sorted(list(x), key=lambda y: y) -C414.py:16:1: C414 [*] Unnecessary `sorted` call within `sorted()` +C414.py:16:1: C414 [*] Unnecessary `sorted()` call within `sorted()` | 14 | sorted(sorted(x)) 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) @@ -300,7 +300,7 @@ C414.py:16:1: C414 [*] Unnecessary `sorted` call within `sorted()` 17 | sorted(reversed(x)) 18 | sorted(list(x), key=lambda y: y) | - = help: Remove the inner `sorted` call + = help: Remove the inner `sorted()` call ℹ Unsafe fix 13 13 | sorted(tuple(x)) @@ -312,7 +312,7 @@ C414.py:16:1: C414 [*] Unnecessary `sorted` call within `sorted()` 18 18 | sorted(list(x), key=lambda y: y) 19 19 | tuple( -C414.py:17:1: C414 [*] Unnecessary `reversed` call within `sorted()` +C414.py:17:1: C414 [*] Unnecessary `reversed()` call within `sorted()` | 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) 16 | sorted(sorted(x, reverse=True), reverse=True) @@ -321,7 +321,7 @@ C414.py:17:1: C414 [*] Unnecessary `reversed` call within `sorted()` 18 | sorted(list(x), key=lambda y: y) 19 | tuple( | - = help: Remove the inner `reversed` call + = help: Remove the inner `reversed()` call ℹ Unsafe fix 14 14 | sorted(sorted(x)) @@ -333,7 +333,7 @@ C414.py:17:1: C414 [*] Unnecessary `reversed` call within `sorted()` 19 19 | tuple( 20 20 | list( -C414.py:18:1: C414 [*] Unnecessary `list` call within `sorted()` +C414.py:18:1: C414 [*] Unnecessary `list()` call within `sorted()` | 16 | sorted(sorted(x, reverse=True), reverse=True) 17 | sorted(reversed(x)) @@ -342,7 +342,7 @@ C414.py:18:1: C414 [*] Unnecessary `list` call within `sorted()` 19 | tuple( 20 | list( | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 15 15 | sorted(sorted(x, key=foo, reverse=False), reverse=False, key=foo) @@ -354,7 +354,7 @@ C414.py:18:1: C414 [*] Unnecessary `list` call within `sorted()` 20 20 | list( 21 21 | [x, 3, "hell"\ -C414.py:19:1: C414 [*] Unnecessary `list` call within `tuple()` +C414.py:19:1: C414 [*] Unnecessary `list()` call within `tuple()` | 17 | sorted(reversed(x)) 18 | sorted(list(x), key=lambda y: y) @@ -368,7 +368,7 @@ C414.py:19:1: C414 [*] Unnecessary `list` call within `tuple()` 25 | set(set()) 26 | set(list()) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 17 17 | sorted(reversed(x)) @@ -383,7 +383,7 @@ C414.py:19:1: C414 [*] Unnecessary `list` call within `tuple()` 25 23 | set(set()) 26 24 | set(list()) -C414.py:25:1: C414 [*] Unnecessary `set` call within `set()` +C414.py:25:1: C414 [*] Unnecessary `set()` call within `set()` | 23 | ) 24 | ) @@ -392,7 +392,7 @@ C414.py:25:1: C414 [*] Unnecessary `set` call within `set()` 26 | set(list()) 27 | set(tuple()) | - = help: Remove the inner `set` call + = help: Remove the inner `set()` call ℹ Unsafe fix 22 22 | "o"] @@ -404,7 +404,7 @@ C414.py:25:1: C414 [*] Unnecessary `set` call within `set()` 27 27 | set(tuple()) 28 28 | sorted(reversed()) -C414.py:26:1: C414 [*] Unnecessary `list` call within `set()` +C414.py:26:1: C414 [*] Unnecessary `list()` call within `set()` | 24 | ) 25 | set(set()) @@ -413,7 +413,7 @@ C414.py:26:1: C414 [*] Unnecessary `list` call within `set()` 27 | set(tuple()) 28 | sorted(reversed()) | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 23 23 | ) @@ -425,7 +425,7 @@ C414.py:26:1: C414 [*] Unnecessary `list` call within `set()` 28 28 | sorted(reversed()) 29 29 | -C414.py:27:1: C414 [*] Unnecessary `tuple` call within `set()` +C414.py:27:1: C414 [*] Unnecessary `tuple()` call within `set()` | 25 | set(set()) 26 | set(list()) @@ -433,7 +433,7 @@ C414.py:27:1: C414 [*] Unnecessary `tuple` call within `set()` | ^^^^^^^^^^^^ C414 28 | sorted(reversed()) | - = help: Remove the inner `tuple` call + = help: Remove the inner `tuple()` call ℹ Unsafe fix 24 24 | ) @@ -445,16 +445,16 @@ C414.py:27:1: C414 [*] Unnecessary `tuple` call within `set()` 29 29 | 30 30 | # Nested sorts with differing keyword arguments. Not flagged. -C414.py:28:1: C414 [*] Unnecessary `reversed` call within `sorted()` +C414.py:28:1: C414 [*] Unnecessary `reversed()` call within `sorted()` | 26 | set(list()) 27 | set(tuple()) 28 | sorted(reversed()) | ^^^^^^^^^^^^^^^^^^ C414 -29 | +29 | 30 | # Nested sorts with differing keyword arguments. Not flagged. | - = help: Remove the inner `reversed` call + = help: Remove the inner `reversed()` call ℹ Unsafe fix 25 25 | set(set()) @@ -466,7 +466,7 @@ C414.py:28:1: C414 [*] Unnecessary `reversed` call within `sorted()` 30 30 | # Nested sorts with differing keyword arguments. Not flagged. 31 31 | sorted(sorted(x, key=lambda y: y)) -C414.py:37:27: C414 [*] Unnecessary `list` call within `sorted()` +C414.py:37:27: C414 [*] Unnecessary `list()` call within `sorted()` | 36 | # Preserve trailing comments. 37 | xxxxxxxxxxx_xxxxx_xxxxx = sorted( @@ -477,10 +477,10 @@ C414.py:37:27: C414 [*] Unnecessary `list` call within `sorted()` 41 | | key=lambda xxxxx: xxxxx or "", 42 | | ) | |_^ C414 -43 | +43 | 44 | xxxxxxxxxxx_xxxxx_xxxxx = sorted( | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 35 35 | @@ -492,10 +492,10 @@ C414.py:37:27: C414 [*] Unnecessary `list` call within `sorted()` 40 40 | # xx xxxx xxxxxxx xxxx xxx xxxxxxxx Nxxx 41 41 | key=lambda xxxxx: xxxxx or "", -C414.py:44:27: C414 [*] Unnecessary `list` call within `sorted()` +C414.py:44:27: C414 [*] Unnecessary `list()` call within `sorted()` | 42 | ) -43 | +43 | 44 | xxxxxxxxxxx_xxxxx_xxxxx = sorted( | ___________________________^ 45 | | list(x_xxxx_xxxxxxxxxxx_xxxxx.xxxx()), # xxxxxxxxxxx xxxxx xxxx xxx xx Nxxx @@ -503,7 +503,7 @@ C414.py:44:27: C414 [*] Unnecessary `list` call within `sorted()` 47 | | ) | |_^ C414 | - = help: Remove the inner `list` call + = help: Remove the inner `list()` call ℹ Unsafe fix 42 42 | ) @@ -513,5 +513,3 @@ C414.py:44:27: C414 [*] Unnecessary `list` call within `sorted()` 45 |+ x_xxxx_xxxxxxxxxxx_xxxxx.xxxx(), # xxxxxxxxxxx xxxxx xxxx xxx xx Nxxx 46 46 | key=lambda xxxxx: xxxxx or "", 47 47 | ) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C415_C415.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C415_C415.py.snap index 3e3463d093d85..670e9a76fc844 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C415_C415.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C415_C415.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs +snapshot_kind: text --- C415.py:2:5: C415 Unnecessary subscript reversal of iterable within `set()` | @@ -39,5 +40,3 @@ C415.py:5:5: C415 Unnecessary subscript reversal of iterable within `sorted()` 6 | e = set(lst[2:-1]) 7 | f = set(lst[:1:-1]) | - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C416_C416.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C416_C416.py.snap index 4ffbb2c029cde..7266e76c5ecde 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C416_C416.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C416_C416.py.snap @@ -1,10 +1,10 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C416.py:6:1: C416 [*] Unnecessary `list` comprehension (rewrite using `list()`) +C416.py:6:1: C416 [*] Unnecessary list comprehension (rewrite using `list()`) | 4 | d = {"a": 1, "b": 2, "c": 3} -5 | +5 | 6 | [i for i in x] | ^^^^^^^^^^^^^^ C416 7 | {i for i in x} @@ -22,7 +22,7 @@ C416.py:6:1: C416 [*] Unnecessary `list` comprehension (rewrite using `list()`) 8 8 | {k: v for k, v in y} 9 9 | {k: v for k, v in d.items()} -C416.py:7:1: C416 [*] Unnecessary `set` comprehension (rewrite using `set()`) +C416.py:7:1: C416 [*] Unnecessary set comprehension (rewrite using `set()`) | 6 | [i for i in x] 7 | {i for i in x} @@ -42,7 +42,7 @@ C416.py:7:1: C416 [*] Unnecessary `set` comprehension (rewrite using `set()`) 9 9 | {k: v for k, v in d.items()} 10 10 | [(k, v) for k, v in d.items()] -C416.py:8:1: C416 [*] Unnecessary `dict` comprehension (rewrite using `dict()`) +C416.py:8:1: C416 [*] Unnecessary dict comprehension (rewrite using `dict()`) | 6 | [i for i in x] 7 | {i for i in x} @@ -61,16 +61,16 @@ C416.py:8:1: C416 [*] Unnecessary `dict` comprehension (rewrite using `dict()`) 8 |+dict(y) 9 9 | {k: v for k, v in d.items()} 10 10 | [(k, v) for k, v in d.items()] -11 11 | {k: (a, b) for k, (a, b) in d.items()} +11 11 | [(k, v) for [k, v] in d.items()] -C416.py:9:1: C416 [*] Unnecessary `dict` comprehension (rewrite using `dict()`) +C416.py:9:1: C416 [*] Unnecessary dict comprehension (rewrite using `dict()`) | 7 | {i for i in x} 8 | {k: v for k, v in y} 9 | {k: v for k, v in d.items()} | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C416 10 | [(k, v) for k, v in d.items()] -11 | {k: (a, b) for k, (a, b) in d.items()} +11 | [(k, v) for [k, v] in d.items()] | = help: Rewrite using `dict()` @@ -81,16 +81,17 @@ C416.py:9:1: C416 [*] Unnecessary `dict` comprehension (rewrite using `dict()`) 9 |-{k: v for k, v in d.items()} 9 |+dict(d.items()) 10 10 | [(k, v) for k, v in d.items()] -11 11 | {k: (a, b) for k, (a, b) in d.items()} -12 12 | +11 11 | [(k, v) for [k, v] in d.items()] +12 12 | {k: (a, b) for k, (a, b) in d.items()} -C416.py:10:1: C416 [*] Unnecessary `list` comprehension (rewrite using `list()`) +C416.py:10:1: C416 [*] Unnecessary list comprehension (rewrite using `list()`) | 8 | {k: v for k, v in y} 9 | {k: v for k, v in d.items()} 10 | [(k, v) for k, v in d.items()] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C416 -11 | {k: (a, b) for k, (a, b) in d.items()} +11 | [(k, v) for [k, v] in d.items()] +12 | {k: (a, b) for k, (a, b) in d.items()} | = help: Rewrite using `list()` @@ -100,44 +101,46 @@ C416.py:10:1: C416 [*] Unnecessary `list` comprehension (rewrite using `list()`) 9 9 | {k: v for k, v in d.items()} 10 |-[(k, v) for k, v in d.items()] 10 |+list(d.items()) -11 11 | {k: (a, b) for k, (a, b) in d.items()} -12 12 | -13 13 | [i for i, in z] +11 11 | [(k, v) for [k, v] in d.items()] +12 12 | {k: (a, b) for k, (a, b) in d.items()} +13 13 | -C416.py:11:1: C416 [*] Unnecessary `dict` comprehension (rewrite using `dict()`) +C416.py:11:1: C416 [*] Unnecessary list comprehension (rewrite using `list()`) | 9 | {k: v for k, v in d.items()} 10 | [(k, v) for k, v in d.items()] -11 | {k: (a, b) for k, (a, b) in d.items()} - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C416 -12 | -13 | [i for i, in z] +11 | [(k, v) for [k, v] in d.items()] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C416 +12 | {k: (a, b) for k, (a, b) in d.items()} | - = help: Rewrite using `dict()` + = help: Rewrite using `list()` ℹ Unsafe fix 8 8 | {k: v for k, v in y} 9 9 | {k: v for k, v in d.items()} 10 10 | [(k, v) for k, v in d.items()] -11 |-{k: (a, b) for k, (a, b) in d.items()} - 11 |+dict(d.items()) -12 12 | -13 13 | [i for i, in z] -14 14 | [i for i, j in y] +11 |-[(k, v) for [k, v] in d.items()] + 11 |+list(d.items()) +12 12 | {k: (a, b) for k, (a, b) in d.items()} +13 13 | +14 14 | [i for i, in z] -C416.py:24:70: C416 [*] Unnecessary `list` comprehension (rewrite using `list()`) +C416.py:25:70: C416 [*] Unnecessary list comprehension (rewrite using `list()`) | -23 | # Regression test for: https://github.com/astral-sh/ruff/issues/7196 -24 | any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in[t for t in SymbolType]) +24 | # Regression test for: https://github.com/astral-sh/ruff/issues/7196 +25 | any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in[t for t in SymbolType]) | ^^^^^^^^^^^^^^^^^^^^^^^ C416 +26 | +27 | zz = [[1], [2], [3]] | = help: Rewrite using `list()` ℹ Unsafe fix -21 21 | {k: v if v else None for k, v in y} -22 22 | -23 23 | # Regression test for: https://github.com/astral-sh/ruff/issues/7196 -24 |-any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in[t for t in SymbolType]) - 24 |+any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in list(SymbolType)) - - +22 22 | {k: v if v else None for k, v in y} +23 23 | +24 24 | # Regression test for: https://github.com/astral-sh/ruff/issues/7196 +25 |-any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in[t for t in SymbolType]) + 25 |+any(len(symbol_table.get_by_type(symbol_type)) > 0 for symbol_type in list(SymbolType)) +26 26 | +27 27 | zz = [[1], [2], [3]] +28 28 | [(i,) for (i,) in zz] # != list(zz) diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417.py.snap index fc37727a26d86..6f7c3e08814fa 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C417.py:3:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:3:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 1 | # Errors. 2 | nums = [1, 2, 3] @@ -10,7 +10,7 @@ C417.py:3:1: C417 [*] Unnecessary `map` usage (rewrite using a generator express 4 | map(lambda x: str(x), nums) 5 | list(map(lambda x: x * 2, nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 1 1 | # Errors. @@ -21,7 +21,7 @@ C417.py:3:1: C417 [*] Unnecessary `map` usage (rewrite using a generator express 5 5 | list(map(lambda x: x * 2, nums)) 6 6 | set(map(lambda x: x % 2 == 0, nums)) -C417.py:4:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:4:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 2 | nums = [1, 2, 3] 3 | map(lambda x: x + 1, nums) @@ -30,7 +30,7 @@ C417.py:4:1: C417 [*] Unnecessary `map` usage (rewrite using a generator express 5 | list(map(lambda x: x * 2, nums)) 6 | set(map(lambda x: x % 2 == 0, nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 1 1 | # Errors. @@ -42,7 +42,7 @@ C417.py:4:1: C417 [*] Unnecessary `map` usage (rewrite using a generator express 6 6 | set(map(lambda x: x % 2 == 0, nums)) 7 7 | dict(map(lambda v: (v, v**2), nums)) -C417.py:5:1: C417 [*] Unnecessary `map` usage (rewrite using a `list` comprehension) +C417.py:5:1: C417 [*] Unnecessary `map()` usage (rewrite using a list comprehension) | 3 | map(lambda x: x + 1, nums) 4 | map(lambda x: str(x), nums) @@ -51,7 +51,7 @@ C417.py:5:1: C417 [*] Unnecessary `map` usage (rewrite using a `list` comprehens 6 | set(map(lambda x: x % 2 == 0, nums)) 7 | dict(map(lambda v: (v, v**2), nums)) | - = help: Replace `map` with a `list` comprehension + = help: Replace `map()` with a list comprehension ℹ Unsafe fix 2 2 | nums = [1, 2, 3] @@ -63,7 +63,7 @@ C417.py:5:1: C417 [*] Unnecessary `map` usage (rewrite using a `list` comprehens 7 7 | dict(map(lambda v: (v, v**2), nums)) 8 8 | dict(map(lambda v: [v, v**2], nums)) -C417.py:6:1: C417 [*] Unnecessary `map` usage (rewrite using a `set` comprehension) +C417.py:6:1: C417 [*] Unnecessary `map()` usage (rewrite using a set comprehension) | 4 | map(lambda x: str(x), nums) 5 | list(map(lambda x: x * 2, nums)) @@ -72,7 +72,7 @@ C417.py:6:1: C417 [*] Unnecessary `map` usage (rewrite using a `set` comprehensi 7 | dict(map(lambda v: (v, v**2), nums)) 8 | dict(map(lambda v: [v, v**2], nums)) | - = help: Replace `map` with a `set` comprehension + = help: Replace `map()` with a set comprehension ℹ Unsafe fix 3 3 | map(lambda x: x + 1, nums) @@ -82,18 +82,17 @@ C417.py:6:1: C417 [*] Unnecessary `map` usage (rewrite using a `set` comprehensi 6 |+{x % 2 == 0 for x in nums} 7 7 | dict(map(lambda v: (v, v**2), nums)) 8 8 | dict(map(lambda v: [v, v**2], nums)) -9 9 | map(lambda: "const", nums) +9 9 | -C417.py:7:1: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehension) +C417.py:7:1: C417 [*] Unnecessary `map()` usage (rewrite using a dict comprehension) | 5 | list(map(lambda x: x * 2, nums)) 6 | set(map(lambda x: x % 2 == 0, nums)) 7 | dict(map(lambda v: (v, v**2), nums)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 8 | dict(map(lambda v: [v, v**2], nums)) -9 | map(lambda: "const", nums) | - = help: Replace `map` with a `dict` comprehension + = help: Replace `map()` with a dict comprehension ℹ Unsafe fix 4 4 | map(lambda x: str(x), nums) @@ -102,19 +101,19 @@ C417.py:7:1: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehens 7 |-dict(map(lambda v: (v, v**2), nums)) 7 |+{v: v**2 for v in nums} 8 8 | dict(map(lambda v: [v, v**2], nums)) -9 9 | map(lambda: "const", nums) +9 9 | 10 10 | map(lambda _: 3.0, nums) -C417.py:8:1: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehension) +C417.py:8:1: C417 [*] Unnecessary `map()` usage (rewrite using a dict comprehension) | 6 | set(map(lambda x: x % 2 == 0, nums)) 7 | dict(map(lambda v: (v, v**2), nums)) 8 | dict(map(lambda v: [v, v**2], nums)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 - 9 | map(lambda: "const", nums) + 9 | 10 | map(lambda _: 3.0, nums) | - = help: Replace `map` with a `dict` comprehension + = help: Replace `map()` with a dict comprehension ℹ Unsafe fix 5 5 | list(map(lambda x: x * 2, nums)) @@ -122,103 +121,79 @@ C417.py:8:1: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehens 7 7 | dict(map(lambda v: (v, v**2), nums)) 8 |-dict(map(lambda v: [v, v**2], nums)) 8 |+{v: v**2 for v in nums} -9 9 | map(lambda: "const", nums) +9 9 | 10 10 | map(lambda _: 3.0, nums) 11 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) -C417.py:9:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:10:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | - 7 | dict(map(lambda v: (v, v**2), nums)) 8 | dict(map(lambda v: [v, v**2], nums)) - 9 | map(lambda: "const", nums) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 -10 | map(lambda _: 3.0, nums) -11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) - | - = help: Replace `map` with a generator expression - -ℹ Unsafe fix -6 6 | set(map(lambda x: x % 2 == 0, nums)) -7 7 | dict(map(lambda v: (v, v**2), nums)) -8 8 | dict(map(lambda v: [v, v**2], nums)) -9 |-map(lambda: "const", nums) - 9 |+("const" for _ in nums) -10 10 | map(lambda _: 3.0, nums) -11 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) -12 12 | all(map(lambda v: isinstance(v, dict), nums)) - -C417.py:10:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) - | - 8 | dict(map(lambda v: [v, v**2], nums)) - 9 | map(lambda: "const", nums) + 9 | 10 | map(lambda _: 3.0, nums) | ^^^^^^^^^^^^^^^^^^^^^^^^ C417 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 12 | all(map(lambda v: isinstance(v, dict), nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 7 7 | dict(map(lambda v: (v, v**2), nums)) 8 8 | dict(map(lambda v: [v, v**2], nums)) -9 9 | map(lambda: "const", nums) +9 9 | 10 |-map(lambda _: 3.0, nums) 10 |+(3.0 for _ in nums) 11 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 12 12 | all(map(lambda v: isinstance(v, dict), nums)) 13 13 | filter(func, map(lambda v: v, nums)) -C417.py:11:13: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:11:13: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | - 9 | map(lambda: "const", nums) 10 | map(lambda _: 3.0, nums) 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 12 | all(map(lambda v: isinstance(v, dict), nums)) 13 | filter(func, map(lambda v: v, nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 8 8 | dict(map(lambda v: [v, v**2], nums)) -9 9 | map(lambda: "const", nums) +9 9 | 10 10 | map(lambda _: 3.0, nums) 11 |-_ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 11 |+_ = "".join((x in nums and "1" or "0" for x in range(123))) 12 12 | all(map(lambda v: isinstance(v, dict), nums)) 13 13 | filter(func, map(lambda v: v, nums)) -14 14 | list(map(lambda x, y: x * y, nums)) +14 14 | -C417.py:12:5: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:12:5: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 10 | map(lambda _: 3.0, nums) 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 12 | all(map(lambda v: isinstance(v, dict), nums)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 13 | filter(func, map(lambda v: v, nums)) -14 | list(map(lambda x, y: x * y, nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix -9 9 | map(lambda: "const", nums) +9 9 | 10 10 | map(lambda _: 3.0, nums) 11 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 12 |-all(map(lambda v: isinstance(v, dict), nums)) 12 |+all((isinstance(v, dict) for v in nums)) 13 13 | filter(func, map(lambda v: v, nums)) -14 14 | list(map(lambda x, y: x * y, nums)) +14 14 | 15 15 | -C417.py:13:14: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:13:14: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) 12 | all(map(lambda v: isinstance(v, dict), nums)) 13 | filter(func, map(lambda v: v, nums)) | ^^^^^^^^^^^^^^^^^^^^^^ C417 -14 | list(map(lambda x, y: x * y, nums)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 10 10 | map(lambda _: 3.0, nums) @@ -226,42 +201,21 @@ C417.py:13:14: C417 [*] Unnecessary `map` usage (rewrite using a generator expre 12 12 | all(map(lambda v: isinstance(v, dict), nums)) 13 |-filter(func, map(lambda v: v, nums)) 13 |+filter(func, (v for v in nums)) -14 14 | list(map(lambda x, y: x * y, nums)) -15 15 | -16 16 | # When inside f-string, then the fix should be surrounded by whitespace - -C417.py:14:1: C417 [*] Unnecessary `map` usage (rewrite using a `list` comprehension) - | -12 | all(map(lambda v: isinstance(v, dict), nums)) -13 | filter(func, map(lambda v: v, nums)) -14 | list(map(lambda x, y: x * y, nums)) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 -15 | -16 | # When inside f-string, then the fix should be surrounded by whitespace - | - = help: Replace `map` with a `list` comprehension - -ℹ Unsafe fix -11 11 | _ = "".join(map(lambda x: x in nums and "1" or "0", range(123))) -12 12 | all(map(lambda v: isinstance(v, dict), nums)) -13 13 | filter(func, map(lambda v: v, nums)) -14 |-list(map(lambda x, y: x * y, nums)) - 14 |+[x * y for x, y in nums] +14 14 | 15 15 | 16 16 | # When inside f-string, then the fix should be surrounded by whitespace -17 17 | _ = f"{set(map(lambda x: x % 2 == 0, nums))}" -C417.py:17:8: C417 [*] Unnecessary `map` usage (rewrite using a `set` comprehension) +C417.py:17:8: C417 [*] Unnecessary `map()` usage (rewrite using a set comprehension) | 16 | # When inside f-string, then the fix should be surrounded by whitespace 17 | _ = f"{set(map(lambda x: x % 2 == 0, nums))}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 18 | _ = f"{dict(map(lambda v: (v, v**2), nums))}" | - = help: Replace `map` with a `set` comprehension + = help: Replace `map()` with a set comprehension ℹ Unsafe fix -14 14 | list(map(lambda x, y: x * y, nums)) +14 14 | 15 15 | 16 16 | # When inside f-string, then the fix should be surrounded by whitespace 17 |-_ = f"{set(map(lambda x: x % 2 == 0, nums))}" @@ -270,16 +224,16 @@ C417.py:17:8: C417 [*] Unnecessary `map` usage (rewrite using a `set` comprehens 19 19 | 20 20 | # False negatives. -C417.py:18:8: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehension) +C417.py:18:8: C417 [*] Unnecessary `map()` usage (rewrite using a dict comprehension) | 16 | # When inside f-string, then the fix should be surrounded by whitespace 17 | _ = f"{set(map(lambda x: x % 2 == 0, nums))}" 18 | _ = f"{dict(map(lambda v: (v, v**2), nums))}" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 -19 | +19 | 20 | # False negatives. | - = help: Replace `map` with a `dict` comprehension + = help: Replace `map()` with a dict comprehension ℹ Unsafe fix 15 15 | @@ -291,15 +245,15 @@ C417.py:18:8: C417 [*] Unnecessary `map` usage (rewrite using a `dict` comprehen 20 20 | # False negatives. 21 21 | map(lambda x=2, y=1: x + y, nums, nums) -C417.py:36:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:36:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 35 | # Error: the `x` is overridden by the inner lambda. 36 | map(lambda x: lambda x: x, range(4)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 -37 | +37 | 38 | # Ok because of the default parameters, and variadic arguments. | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 33 33 | map(lambda x: lambda: x, range(4)) @@ -311,7 +265,7 @@ C417.py:36:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres 38 38 | # Ok because of the default parameters, and variadic arguments. 39 39 | map(lambda x=1: x, nums) -C417.py:47:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:47:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 46 | # Regression test for: https://github.com/astral-sh/ruff/issues/7121 47 | map(lambda x: x, y if y else z) @@ -319,7 +273,7 @@ C417.py:47:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres 48 | map(lambda x: x, (y if y else z)) 49 | map(lambda x: x, (x, y, z)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 44 44 | dict(map(lambda k, v: (k, v), keys, values)) @@ -329,8 +283,9 @@ C417.py:47:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres 47 |+(x for x in (y if y else z)) 48 48 | map(lambda x: x, (y if y else z)) 49 49 | map(lambda x: x, (x, y, z)) +50 50 | -C417.py:48:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:48:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 46 | # Regression test for: https://github.com/astral-sh/ruff/issues/7121 47 | map(lambda x: x, y if y else z) @@ -338,7 +293,7 @@ C417.py:48:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 49 | map(lambda x: x, (x, y, z)) | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 45 45 | @@ -347,15 +302,19 @@ C417.py:48:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres 48 |-map(lambda x: x, (y if y else z)) 48 |+(x for x in (y if y else z)) 49 49 | map(lambda x: x, (x, y, z)) +50 50 | +51 51 | # See https://github.com/astral-sh/ruff/issues/14808 -C417.py:49:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expression) +C417.py:49:1: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) | 47 | map(lambda x: x, y if y else z) 48 | map(lambda x: x, (y if y else z)) 49 | map(lambda x: x, (x, y, z)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ C417 +50 | +51 | # See https://github.com/astral-sh/ruff/issues/14808 | - = help: Replace `map` with a generator expression + = help: Replace `map()` with a generator expression ℹ Unsafe fix 46 46 | # Regression test for: https://github.com/astral-sh/ruff/issues/7121 @@ -363,5 +322,6 @@ C417.py:49:1: C417 [*] Unnecessary `map` usage (rewrite using a generator expres 48 48 | map(lambda x: x, (y if y else z)) 49 |-map(lambda x: x, (x, y, z)) 49 |+(x for x in (x, y, z)) - - +50 50 | +51 51 | # See https://github.com/astral-sh/ruff/issues/14808 +52 52 | # The following should be Ok since diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417_1.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417_1.py.snap new file mode 100644 index 0000000000000..82312e83fcb7c --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C417_C417_1.py.snap @@ -0,0 +1,21 @@ +--- +source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs +--- +C417_1.py:7:10: C417 [*] Unnecessary `map()` usage (rewrite using a generator expression) + | +5 | def overshadowed_list(): +6 | list = ... +7 | list(map(lambda x: x, [])) + | ^^^^^^^^^^^^^^^^^^^^ C417 + | + = help: Replace `map()` with a generator expression + +ℹ Unsafe fix +4 4 | +5 5 | def overshadowed_list(): +6 6 | list = ... +7 |- list(map(lambda x: x, [])) + 7 |+ list((x for x in [])) +8 8 | +9 9 | +10 10 | ### No errors diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C418_C418.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C418_C418.py.snap index f350adcdcec62..0a90ca25db454 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C418_C418.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C418_C418.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C418.py:1:1: C418 [*] Unnecessary `dict` literal passed to `dict()` (remove the outer call to `dict()`) +C418.py:1:1: C418 [*] Unnecessary dict literal passed to `dict()` (remove the outer call to `dict()`) | 1 | dict({}) | ^^^^^^^^ C418 2 | dict({'a': 1}) 3 | dict({'x': 1 for x in range(10)}) | - = help: Remove outer `dict` call + = help: Remove outer `dict()` call ℹ Unsafe fix 1 |-dict({}) @@ -17,7 +17,7 @@ C418.py:1:1: C418 [*] Unnecessary `dict` literal passed to `dict()` (remove the 3 3 | dict({'x': 1 for x in range(10)}) 4 4 | dict( -C418.py:2:1: C418 [*] Unnecessary `dict` literal passed to `dict()` (remove the outer call to `dict()`) +C418.py:2:1: C418 [*] Unnecessary dict literal passed to `dict()` (remove the outer call to `dict()`) | 1 | dict({}) 2 | dict({'a': 1}) @@ -25,7 +25,7 @@ C418.py:2:1: C418 [*] Unnecessary `dict` literal passed to `dict()` (remove the 3 | dict({'x': 1 for x in range(10)}) 4 | dict( | - = help: Remove outer `dict` call + = help: Remove outer `dict()` call ℹ Unsafe fix 1 1 | dict({}) @@ -35,7 +35,7 @@ C418.py:2:1: C418 [*] Unnecessary `dict` literal passed to `dict()` (remove the 4 4 | dict( 5 5 | {'x': 1 for x in range(10)} -C418.py:3:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remove the outer call to `dict()`) +C418.py:3:1: C418 [*] Unnecessary dict comprehension passed to `dict()` (remove the outer call to `dict()`) | 1 | dict({}) 2 | dict({'a': 1}) @@ -44,7 +44,7 @@ C418.py:3:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remov 4 | dict( 5 | {'x': 1 for x in range(10)} | - = help: Remove outer `dict` call + = help: Remove outer `dict()` call ℹ Unsafe fix 1 1 | dict({}) @@ -55,7 +55,7 @@ C418.py:3:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remov 5 5 | {'x': 1 for x in range(10)} 6 6 | ) -C418.py:4:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remove the outer call to `dict()`) +C418.py:4:1: C418 [*] Unnecessary dict comprehension passed to `dict()` (remove the outer call to `dict()`) | 2 | dict({'a': 1}) 3 | dict({'x': 1 for x in range(10)}) @@ -63,10 +63,10 @@ C418.py:4:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remov 5 | | {'x': 1 for x in range(10)} 6 | | ) | |_^ C418 -7 | +7 | 8 | dict({}, a=1) | - = help: Remove outer `dict` call + = help: Remove outer `dict()` call ℹ Unsafe fix 1 1 | dict({}) @@ -79,5 +79,3 @@ C418.py:4:1: C418 [*] Unnecessary `dict` comprehension passed to `dict()` (remov 7 5 | 8 6 | dict({}, a=1) 9 7 | dict({x: 1 for x in range(1)}, a=1) - - diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419.py.snap index d1b04aebaa8bf..25ff5019b4b29 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419.py.snap @@ -51,7 +51,7 @@ C419.py:4:5: C419 [*] Unnecessary list comprehension 2 2 | all([x.id for x in bar]) 3 3 | any( # first comment 4 |- [x.id for x in bar], # second comment - 4 |+ x.id for x in bar, # second comment + 4 |+ x.id for x in bar # second comment 5 5 | ) # third comment 6 6 | all( # first comment 7 7 | [x.id for x in bar], # second comment @@ -72,7 +72,7 @@ C419.py:7:5: C419 [*] Unnecessary list comprehension 5 5 | ) # third comment 6 6 | all( # first comment 7 |- [x.id for x in bar], # second comment - 7 |+ x.id for x in bar, # second comment + 7 |+ x.id for x in bar # second comment 8 8 | ) # third comment 9 9 | any({x.id for x in bar}) 10 10 | @@ -83,7 +83,7 @@ C419.py:9:5: C419 [*] Unnecessary set comprehension 8 | ) # third comment 9 | any({x.id for x in bar}) | ^^^^^^^^^^^^^^^^^^^ C419 -10 | +10 | 11 | # OK | = help: Remove unnecessary comprehension @@ -102,8 +102,7 @@ C419.py:28:5: C419 [*] Unnecessary list comprehension | 26 | # Special comment handling 27 | any( -28 | [ # lbracket comment - | _____^ +28 | / [ # lbracket comment 29 | | # second line comment 30 | | i.bit_count() 31 | | # random middle comment @@ -188,7 +187,7 @@ C419.py:50:5: C419 [*] Unnecessary set comprehension 49 | any({x.id for x in bar}) 50 | all({x.id for x in bar}) | ^^^^^^^^^^^^^^^^^^^ C419 -51 | +51 | 52 | # should be linted in preview... | = help: Remove unnecessary comprehension diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419_2.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419_2.py.snap index d9845b4ae92f9..0172399c06d9f 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C419_C419_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420.py.snap index c1b1ee2942ee9..2a45889f360df 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420.py.snap @@ -60,7 +60,7 @@ C420.py:15:5: C420 [*] Unnecessary dict comprehension for iterable; use `dict.fr C420.py:26:7: C420 [*] Unnecessary dict comprehension for iterable; use `dict.fromkeys` instead | 24 | return data -25 | +25 | 26 | f({c: "a" for c in "12345"}) # RUF025 | ^^^^^^^^^^^^^^^^^^^^^^^^^ C420 | diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420_1.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420_1.py.snap new file mode 100644 index 0000000000000..9551c10fdebb9 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__C420_C420_1.py.snap @@ -0,0 +1,16 @@ +--- +source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs +--- +C420_1.py:1:1: C420 [*] Unnecessary dict comprehension for iterable; use `dict.fromkeys` instead + | +1 | {x: NotImplemented for x in "XY"} + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C420 + | + = help: Replace with `dict.fromkeys(iterable)`) + +ℹ Safe fix +1 |-{x: NotImplemented for x in "XY"} + 1 |+dict.fromkeys("XY", NotImplemented) +2 2 | +3 3 | +4 4 | # Builtin bindings are placed at top of file, but should not count as diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C409_C409.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C409_C409.py.snap index 4d816904df1c2..cdbe3af0c18af 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C409_C409.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C409_C409.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/flake8_comprehensions/mod.rs --- -C409.py:1:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:1:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 1 | t1 = tuple([]) | ^^^^^^^^^ C409 2 | t2 = tuple([1, 2]) 3 | t3 = tuple((1, 2)) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 |-t1 = tuple([]) @@ -17,7 +17,7 @@ C409.py:1:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 3 3 | t3 = tuple((1, 2)) 4 4 | t4 = tuple([ -C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:2:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 1 | t1 = tuple([]) 2 | t2 = tuple([1, 2]) @@ -25,7 +25,7 @@ C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 3 | t3 = tuple((1, 2)) 4 | t4 = tuple([ | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 1 | t1 = tuple([]) @@ -35,7 +35,7 @@ C409.py:2:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 4 4 | t4 = tuple([ 5 5 | 1, -C409.py:3:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:3:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 1 | t1 = tuple([]) 2 | t2 = tuple([1, 2]) @@ -55,7 +55,7 @@ C409.py:3:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 5 5 | 1, 6 6 | 2 -C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:4:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 2 | t2 = tuple([1, 2]) 3 | t3 = tuple((1, 2)) @@ -68,7 +68,7 @@ C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 8 | t5 = tuple( 9 | (1, 2) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 1 1 | t1 = tuple([]) @@ -84,7 +84,7 @@ C409.py:4:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as 9 9 | (1, 2) 10 10 | ) -C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:8:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 6 | 2 7 | ]) @@ -93,7 +93,7 @@ C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 9 | | (1, 2) 10 | | ) | |_^ C409 -11 | +11 | 12 | tuple( # comment | = help: Remove the outer call to `tuple()` @@ -110,18 +110,18 @@ C409.py:8:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove th 12 10 | tuple( # comment 13 11 | [1, 2] -C409.py:12:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:12:1: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 10 | ) -11 | +11 | 12 | / tuple( # comment 13 | | [1, 2] 14 | | ) | |_^ C409 -15 | +15 | 16 | tuple([ # comment | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 9 9 | (1, 2) @@ -135,18 +135,18 @@ C409.py:12:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 16 14 | tuple([ # comment 17 15 | 1, 2 -C409.py:16:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:16:1: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 14 | ) -15 | +15 | 16 | / tuple([ # comment 17 | | 1, 2 18 | | ]) | |__^ C409 -19 | +19 | 20 | tuple(( | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 13 13 | [1, 2] @@ -161,15 +161,15 @@ C409.py:16:1: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 20 20 | tuple(( 21 21 | 1, -C409.py:20:1: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:20:1: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 18 | ]) -19 | +19 | 20 | / tuple(( 21 | | 1, 22 | | )) | |__^ C409 -23 | +23 | 24 | t6 = tuple([1]) | = help: Remove the outer call to `tuple()` @@ -187,16 +187,16 @@ C409.py:20:1: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove t 24 24 | t6 = tuple([1]) 25 25 | t7 = tuple((1,)) -C409.py:24:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:24:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 22 | )) -23 | +23 | 24 | t6 = tuple([1]) | ^^^^^^^^^^ C409 25 | t7 = tuple((1,)) 26 | t8 = tuple([1,]) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 21 21 | 1, @@ -208,7 +208,7 @@ C409.py:24:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a 26 26 | t8 = tuple([1,]) 27 27 | -C409.py:25:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove the outer call to `tuple()`) +C409.py:25:6: C409 [*] Unnecessary tuple literal passed to `tuple()` (remove the outer call to `tuple()`) | 24 | t6 = tuple([1]) 25 | t7 = tuple((1,)) @@ -227,16 +227,16 @@ C409.py:25:6: C409 [*] Unnecessary `tuple` literal passed to `tuple()` (remove t 27 27 | 28 28 | tuple([x for x in range(5)]) -C409.py:26:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal) +C409.py:26:6: C409 [*] Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal) | 24 | t6 = tuple([1]) 25 | t7 = tuple((1,)) 26 | t8 = tuple([1,]) | ^^^^^^^^^^^ C409 -27 | +27 | 28 | tuple([x for x in range(5)]) | - = help: Rewrite as a `tuple` literal + = help: Rewrite as a tuple literal ℹ Unsafe fix 23 23 | @@ -251,7 +251,7 @@ C409.py:26:6: C409 [*] Unnecessary `list` literal passed to `tuple()` (rewrite a C409.py:28:1: C409 [*] Unnecessary list comprehension passed to `tuple()` (rewrite as a generator) | 26 | t8 = tuple([1,]) -27 | +27 | 28 | tuple([x for x in range(5)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ C409 29 | tuple({x for x in range(10)}) diff --git a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C419_C419_1.py.snap b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C419_C419_1.py.snap index 9bc26685fbd88..c3433692feb3a 100644 --- a/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C419_C419_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_comprehensions/snapshots/ruff_linter__rules__flake8_comprehensions__tests__preview__C419_C419_1.py.snap @@ -60,7 +60,7 @@ C419_1.py:4:5: C419 [*] Unnecessary list comprehension 3 | max([x.val for x in bar]) 4 | sum([x.val for x in bar], 0) | ^^^^^^^^^^^^^^^^^^^^ C419 -5 | +5 | 6 | # OK | = help: Remove unnecessary comprehension @@ -79,8 +79,7 @@ C419_1.py:14:5: C419 [*] Unnecessary list comprehension | 12 | # Multi-line 13 | sum( -14 | [ - | _____^ +14 | / [ 15 | | delta 16 | | for delta in timedelta_list 17 | | if delta diff --git a/crates/ruff_linter/src/rules/flake8_copyright/rules/missing_copyright_notice.rs b/crates/ruff_linter/src/rules/flake8_copyright/rules/missing_copyright_notice.rs index e765d88d0a51f..bbe034ce5dfb9 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/rules/missing_copyright_notice.rs +++ b/crates/ruff_linter/src/rules/flake8_copyright/rules/missing_copyright_notice.rs @@ -1,9 +1,9 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::{TextRange, TextSize}; -use crate::settings::LinterSettings; use crate::Locator; +use crate::settings::LinterSettings; /// ## What it does /// Checks for the absence of copyright notices within Python files. @@ -13,13 +13,18 @@ use crate::Locator; /// ## Why is this bad? /// In some codebases, it's common to have a license header at the top of every /// file. This rule ensures that the license header is present. -#[violation] -pub struct MissingCopyrightNotice; +/// +/// ## Options +/// - `lint.flake8-copyright.author` +/// - `lint.flake8-copyright.min-file-size` +/// - `lint.flake8-copyright.notice-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct MissingCopyrightNotice; impl Violation for MissingCopyrightNotice { #[derive_message_formats] fn message(&self) -> String { - format!("Missing copyright notice at top of file") + "Missing copyright notice at top of file".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__char_boundary.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__char_boundary.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__char_boundary.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__char_boundary.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__invalid_author.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__invalid_author.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__invalid_author.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__invalid_author.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__late_notice.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__late_notice.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__late_notice.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__late_notice.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_c.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_c.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_c.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_c.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_caps.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_caps.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_caps.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_caps.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_comma.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_comma.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_comma.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_comma.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_range.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_range.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_range.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_range.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_unicode_c.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_unicode_c.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_unicode_c.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__notice_with_unicode_c.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__small_file.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__small_file.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__small_file.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__small_file.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_no_space.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_no_space.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_no_space.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_no_space.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_spaces.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_spaces.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_spaces.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_invalid_spaces.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_valid_space.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_valid_space.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_valid_space.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_comma_valid_space.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash.snap index 314ed9c4f967d..071086251aa3e 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_space.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_space.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_space.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_space.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_spaces.snap b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_spaces.snap index 6bac4b05dc4e8..4a99d41b49d53 100644 --- a/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_spaces.snap +++ b/crates/ruff_linter/src/rules/flake8_copyright/snapshots/ruff_linter__rules__flake8_copyright__tests__valid_author_with_dash_invalid_spaces.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_copyright/mod.rs +snapshot_kind: text --- <filename>:1:1: CPY001 Missing copyright notice at top of file diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/mod.rs b/crates/ruff_linter/src/rules/flake8_datetimez/mod.rs index f803eb3e3c638..ef37ee0d73292 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/mod.rs @@ -21,6 +21,7 @@ mod tests { #[test_case(Rule::CallDatetimeStrptimeWithoutZone, Path::new("DTZ007.py"))] #[test_case(Rule::CallDateToday, Path::new("DTZ011.py"))] #[test_case(Rule::CallDateFromtimestamp, Path::new("DTZ012.py"))] + #[test_case(Rule::DatetimeMinMax, Path::new("DTZ901.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_fromtimestamp.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_fromtimestamp.rs index cf3397a4771ac..111916a5eedc7 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_fromtimestamp.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_fromtimestamp.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use crate::checkers::ast::Checker; @@ -44,13 +44,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDateFromtimestamp; +#[derive(ViolationMetadata)] +pub(crate) struct CallDateFromtimestamp; impl Violation for CallDateFromtimestamp { #[derive_message_formats] fn message(&self) -> String { - format!("`datetime.date.fromtimestamp()` used") + "`datetime.date.fromtimestamp()` used".to_string() } fn fix_title(&self) -> Option<String> { @@ -58,7 +58,7 @@ impl Violation for CallDateFromtimestamp { } } -pub(crate) fn call_date_fromtimestamp(checker: &mut Checker, func: &Expr, location: TextRange) { +pub(crate) fn call_date_fromtimestamp(checker: &Checker, func: &Expr, location: TextRange) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -73,8 +73,6 @@ pub(crate) fn call_date_fromtimestamp(checker: &mut Checker, func: &Expr, locati ) }) { - checker - .diagnostics - .push(Diagnostic::new(CallDateFromtimestamp, location)); + checker.report_diagnostic(Diagnostic::new(CallDateFromtimestamp, location)); } } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_today.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_today.rs index 3dd1d967b2f92..721073076ffce 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_today.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_date_today.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use crate::checkers::ast::Checker; @@ -43,13 +43,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDateToday; +#[derive(ViolationMetadata)] +pub(crate) struct CallDateToday; impl Violation for CallDateToday { #[derive_message_formats] fn message(&self) -> String { - format!("`datetime.date.today()` used") + "`datetime.date.today()` used".to_string() } fn fix_title(&self) -> Option<String> { @@ -57,7 +57,7 @@ impl Violation for CallDateToday { } } -pub(crate) fn call_date_today(checker: &mut Checker, func: &Expr, location: TextRange) { +pub(crate) fn call_date_today(checker: &Checker, func: &Expr, location: TextRange) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -69,8 +69,6 @@ pub(crate) fn call_date_today(checker: &mut Checker, func: &Expr, location: Text matches!(qualified_name.segments(), ["datetime", "date", "today"]) }) { - checker - .diagnostics - .push(Diagnostic::new(CallDateToday, location)); + checker.report_diagnostic(Diagnostic::new(CallDateToday, location)); } } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_fromtimestamp.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_fromtimestamp.rs index 26b5682f91e0e..523254619bc1e 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_fromtimestamp.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_fromtimestamp.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_python_semantic::Modules; @@ -47,8 +47,8 @@ use super::helpers::{self, DatetimeModuleAntipattern}; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDatetimeFromtimestamp(DatetimeModuleAntipattern); +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeFromtimestamp(DatetimeModuleAntipattern); impl Violation for CallDatetimeFromtimestamp { #[derive_message_formats] @@ -56,10 +56,10 @@ impl Violation for CallDatetimeFromtimestamp { let CallDatetimeFromtimestamp(antipattern) = self; match antipattern { DatetimeModuleAntipattern::NoTzArgumentPassed => { - format!("`datetime.datetime.fromtimestamp()` called without a `tz` argument") + "`datetime.datetime.fromtimestamp()` called without a `tz` argument".to_string() } DatetimeModuleAntipattern::NonePassedToTzArgument => { - format!("`tz=None` passed to `datetime.datetime.fromtimestamp()`") + "`tz=None` passed to `datetime.datetime.fromtimestamp()`".to_string() } } } @@ -69,7 +69,7 @@ impl Violation for CallDatetimeFromtimestamp { } } -pub(crate) fn call_datetime_fromtimestamp(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn call_datetime_fromtimestamp(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -87,17 +87,17 @@ pub(crate) fn call_datetime_fromtimestamp(checker: &mut Checker, call: &ast::Exp return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - let antipattern = match call.arguments.find_argument("tz", 1) { + let antipattern = match call.arguments.find_argument_value("tz", 1) { Some(ast::Expr::NoneLiteral(_)) => DatetimeModuleAntipattern::NonePassedToTzArgument, Some(_) => return, None => DatetimeModuleAntipattern::NoTzArgumentPassed, }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CallDatetimeFromtimestamp(antipattern), call.range, )); diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_now_without_tzinfo.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_now_without_tzinfo.rs index 603f9ac018576..cb02443b3eb91 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_now_without_tzinfo.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_now_without_tzinfo.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; @@ -45,8 +45,8 @@ use super::helpers::{self, DatetimeModuleAntipattern}; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDatetimeNowWithoutTzinfo(DatetimeModuleAntipattern); +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeNowWithoutTzinfo(DatetimeModuleAntipattern); impl Violation for CallDatetimeNowWithoutTzinfo { #[derive_message_formats] @@ -54,10 +54,10 @@ impl Violation for CallDatetimeNowWithoutTzinfo { let CallDatetimeNowWithoutTzinfo(antipattern) = self; match antipattern { DatetimeModuleAntipattern::NoTzArgumentPassed => { - format!("`datetime.datetime.now()` called without a `tz` argument") + "`datetime.datetime.now()` called without a `tz` argument".to_string() } DatetimeModuleAntipattern::NonePassedToTzArgument => { - format!("`tz=None` passed to `datetime.datetime.now()`") + "`tz=None` passed to `datetime.datetime.now()`".to_string() } } } @@ -67,7 +67,7 @@ impl Violation for CallDatetimeNowWithoutTzinfo { } } -pub(crate) fn call_datetime_now_without_tzinfo(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn call_datetime_now_without_tzinfo(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -82,17 +82,17 @@ pub(crate) fn call_datetime_now_without_tzinfo(checker: &mut Checker, call: &ast return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - let antipattern = match call.arguments.find_argument("tz", 0) { + let antipattern = match call.arguments.find_argument_value("tz", 0) { Some(ast::Expr::NoneLiteral(_)) => DatetimeModuleAntipattern::NonePassedToTzArgument, Some(_) => return, None => DatetimeModuleAntipattern::NoTzArgumentPassed, }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CallDatetimeNowWithoutTzinfo(antipattern), call.range, )); diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_strptime_without_zone.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_strptime_without_zone.rs index 420104871febe..4c89488b8375d 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_strptime_without_zone.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_strptime_without_zone.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::Modules; @@ -50,40 +50,41 @@ use super::helpers::DatetimeModuleAntipattern; /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) /// - [Python documentation: `strftime()` and `strptime()` Behavior](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior) -#[violation] -pub struct CallDatetimeStrptimeWithoutZone(DatetimeModuleAntipattern); +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeStrptimeWithoutZone(DatetimeModuleAntipattern); impl Violation for CallDatetimeStrptimeWithoutZone { #[derive_message_formats] fn message(&self) -> String { let CallDatetimeStrptimeWithoutZone(antipattern) = self; match antipattern { - DatetimeModuleAntipattern::NoTzArgumentPassed => format!( + DatetimeModuleAntipattern::NoTzArgumentPassed => { "Naive datetime constructed using `datetime.datetime.strptime()` without %z" - ), + .to_string() + } DatetimeModuleAntipattern::NonePassedToTzArgument => { - format!("`datetime.datetime.strptime(...).replace(tz=None)` used") + "`datetime.datetime.strptime(...).replace(tz=None)` used".to_string() } } } fn fix_title(&self) -> Option<String> { let CallDatetimeStrptimeWithoutZone(antipattern) = self; - match antipattern { - DatetimeModuleAntipattern::NoTzArgumentPassed => Some( + let title = match antipattern { + DatetimeModuleAntipattern::NoTzArgumentPassed => { "Call `.replace(tzinfo=<timezone>)` or `.astimezone()` \ to convert to an aware datetime" - .to_string(), - ), + } DatetimeModuleAntipattern::NonePassedToTzArgument => { - Some("Pass a `datetime.timezone` object to the `tzinfo` parameter".to_string()) + "Pass a `datetime.timezone` object to the `tzinfo` parameter" } - } + }; + Some(title.to_string()) } } /// DTZ007 -pub(crate) fn call_datetime_strptime_without_zone(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn call_datetime_strptime_without_zone(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -131,14 +132,14 @@ pub(crate) fn call_datetime_strptime_without_zone(checker: &mut Checker, call: & } _ => {} } - }; + } let semantic = checker.semantic(); if let Some(antipattern) = find_antipattern( semantic.current_expression_grandparent(), semantic.current_expression_parent(), ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CallDatetimeStrptimeWithoutZone(antipattern), call.range, )); diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_today.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_today.rs index b22a7e84c2ddb..9ba0332eead67 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_today.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_today.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use crate::checkers::ast::Checker; @@ -42,13 +42,13 @@ use super::helpers; /// /// datetime.datetime.now(tz=datetime.UTC) /// ``` -#[violation] -pub struct CallDatetimeToday; +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeToday; impl Violation for CallDatetimeToday { #[derive_message_formats] fn message(&self) -> String { - format!("`datetime.datetime.today()` used") + "`datetime.datetime.today()` used".to_string() } fn fix_title(&self) -> Option<String> { @@ -56,7 +56,7 @@ impl Violation for CallDatetimeToday { } } -pub(crate) fn call_datetime_today(checker: &mut Checker, func: &Expr, location: TextRange) { +pub(crate) fn call_datetime_today(checker: &Checker, func: &Expr, location: TextRange) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -71,11 +71,9 @@ pub(crate) fn call_datetime_today(checker: &mut Checker, func: &Expr, location: return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - checker - .diagnostics - .push(Diagnostic::new(CallDatetimeToday, location)); + checker.report_diagnostic(Diagnostic::new(CallDatetimeToday, location)); } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcfromtimestamp.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcfromtimestamp.rs index f24b54158d845..4febc8f8f89aa 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcfromtimestamp.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcfromtimestamp.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use crate::checkers::ast::Checker; @@ -46,13 +46,13 @@ use super::helpers; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDatetimeUtcfromtimestamp; +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeUtcfromtimestamp; impl Violation for CallDatetimeUtcfromtimestamp { #[derive_message_formats] fn message(&self) -> String { - format!("`datetime.datetime.utcfromtimestamp()` used") + "`datetime.datetime.utcfromtimestamp()` used".to_string() } fn fix_title(&self) -> Option<String> { @@ -60,11 +60,7 @@ impl Violation for CallDatetimeUtcfromtimestamp { } } -pub(crate) fn call_datetime_utcfromtimestamp( - checker: &mut Checker, - func: &Expr, - location: TextRange, -) { +pub(crate) fn call_datetime_utcfromtimestamp(checker: &Checker, func: &Expr, location: TextRange) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -82,11 +78,9 @@ pub(crate) fn call_datetime_utcfromtimestamp( return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - checker - .diagnostics - .push(Diagnostic::new(CallDatetimeUtcfromtimestamp, location)); + checker.report_diagnostic(Diagnostic::new(CallDatetimeUtcfromtimestamp, location)); } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcnow.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcnow.rs index 059f9b80df572..f54452ab6eb21 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcnow.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_utcnow.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use crate::checkers::ast::Checker; @@ -45,13 +45,13 @@ use super::helpers; /// /// ## References /// - [Python documentation: Aware and Naive Objects](https://docs.python.org/3/library/datetime.html#aware-and-naive-objects) -#[violation] -pub struct CallDatetimeUtcnow; +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeUtcnow; impl Violation for CallDatetimeUtcnow { #[derive_message_formats] fn message(&self) -> String { - format!("`datetime.datetime.utcnow()` used") + "`datetime.datetime.utcnow()` used".to_string() } fn fix_title(&self) -> Option<String> { @@ -60,7 +60,7 @@ impl Violation for CallDatetimeUtcnow { } /// DTZ003 -pub(crate) fn call_datetime_utcnow(checker: &mut Checker, func: &Expr, location: TextRange) { +pub(crate) fn call_datetime_utcnow(checker: &Checker, func: &Expr, location: TextRange) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -78,11 +78,9 @@ pub(crate) fn call_datetime_utcnow(checker: &mut Checker, func: &Expr, location: return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - checker - .diagnostics - .push(Diagnostic::new(CallDatetimeUtcnow, location)); + checker.report_diagnostic(Diagnostic::new(CallDatetimeUtcnow, location)); } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_without_tzinfo.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_without_tzinfo.rs index 264950d937eff..2e46890d5347f 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_without_tzinfo.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/call_datetime_without_tzinfo.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; @@ -41,8 +41,8 @@ use super::helpers::{self, DatetimeModuleAntipattern}; /// /// datetime.datetime(2000, 1, 1, 0, 0, 0, tzinfo=datetime.UTC) /// ``` -#[violation] -pub struct CallDatetimeWithoutTzinfo(DatetimeModuleAntipattern); +#[derive(ViolationMetadata)] +pub(crate) struct CallDatetimeWithoutTzinfo(DatetimeModuleAntipattern); impl Violation for CallDatetimeWithoutTzinfo { #[derive_message_formats] @@ -50,10 +50,10 @@ impl Violation for CallDatetimeWithoutTzinfo { let CallDatetimeWithoutTzinfo(antipattern) = self; match antipattern { DatetimeModuleAntipattern::NoTzArgumentPassed => { - format!("`datetime.datetime()` called without a `tzinfo` argument") + "`datetime.datetime()` called without a `tzinfo` argument".to_string() } DatetimeModuleAntipattern::NonePassedToTzArgument => { - format!("`tzinfo=None` passed to `datetime.datetime()`") + "`tzinfo=None` passed to `datetime.datetime()`".to_string() } } } @@ -63,7 +63,7 @@ impl Violation for CallDatetimeWithoutTzinfo { } } -pub(crate) fn call_datetime_without_tzinfo(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn call_datetime_without_tzinfo(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DATETIME) { return; } @@ -76,17 +76,17 @@ pub(crate) fn call_datetime_without_tzinfo(checker: &mut Checker, call: &ast::Ex return; } - if helpers::parent_expr_is_astimezone(checker) { + if helpers::followed_by_astimezone(checker) { return; } - let antipattern = match call.arguments.find_argument("tzinfo", 7) { + let antipattern = match call.arguments.find_argument_value("tzinfo", 7) { Some(ast::Expr::NoneLiteral(_)) => DatetimeModuleAntipattern::NonePassedToTzArgument, Some(_) => return, None => DatetimeModuleAntipattern::NoTzArgumentPassed, }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CallDatetimeWithoutTzinfo(antipattern), call.range, )); diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/datetime_min_max.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/datetime_min_max.rs new file mode 100644 index 0000000000000..5f6a94ce184ce --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/datetime_min_max.rs @@ -0,0 +1,112 @@ +use std::fmt::{Display, Formatter}; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; +use ruff_python_semantic::{Modules, SemanticModel}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for uses of `datetime.datetime.min` and `datetime.datetime.max`. +/// +/// ## Why is this bad? +/// `datetime.min` and `datetime.max` are non-timezone-aware datetime objects. +/// +/// As such, operations on `datetime.min` and `datetime.max` may behave +/// unexpectedly, as in: +/// +/// ```python +/// # Timezone: UTC-14 +/// datetime.min.timestamp() # ValueError: year 0 is out of range +/// datetime.max.timestamp() # ValueError: year 10000 is out of range +/// ``` +/// +/// ## Example +/// ```python +/// datetime.max +/// ``` +/// +/// Use instead: +/// ```python +/// datetime.max.replace(tzinfo=datetime.UTC) +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct DatetimeMinMax { + min_max: MinMax, +} + +impl Violation for DatetimeMinMax { + #[derive_message_formats] + fn message(&self) -> String { + let DatetimeMinMax { min_max } = self; + format!("Use of `datetime.datetime.{min_max}` without timezone information") + } + + fn fix_title(&self) -> Option<String> { + let DatetimeMinMax { min_max } = self; + Some(format!( + "Replace with `datetime.datetime.{min_max}.replace(tzinfo=...)`" + )) + } +} + +/// DTZ901 +pub(crate) fn datetime_min_max(checker: &Checker, expr: &Expr) { + let semantic = checker.semantic(); + + if !semantic.seen_module(Modules::DATETIME) { + return; + } + + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return; + }; + + let min_max = match qualified_name.segments() { + ["datetime", "datetime", "min"] => MinMax::Min, + ["datetime", "datetime", "max"] => MinMax::Max, + _ => return, + }; + + if usage_is_safe(checker.semantic()) { + return; + } + + checker.report_diagnostic(Diagnostic::new(DatetimeMinMax { min_max }, expr.range())); +} + +/// Check if the current expression has the pattern `foo.replace(tzinfo=bar)` or `foo.time()`. +fn usage_is_safe(semantic: &SemanticModel) -> bool { + let Some(parent) = semantic.current_expression_parent() else { + return false; + }; + let Some(grandparent) = semantic.current_expression_grandparent() else { + return false; + }; + + match (parent, grandparent) { + (Expr::Attribute(ExprAttribute { attr, .. }), Expr::Call(ExprCall { arguments, .. })) => { + attr == "time" || (attr == "replace" && arguments.find_keyword("tzinfo").is_some()) + } + _ => false, + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq)] +enum MinMax { + /// `datetime.datetime.min` + Min, + /// `datetime.datetime.max` + Max, +} + +impl Display for MinMax { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + MinMax::Min => write!(f, "min"), + MinMax::Max => write!(f, "max"), + } + } +} diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/helpers.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/helpers.rs index a580c9bc95e76..508e8b6238f7d 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/helpers.rs @@ -1,4 +1,4 @@ -use ruff_python_ast::{Expr, ExprAttribute}; +use ruff_python_ast::{AnyNodeRef, Expr, ExprAttribute, ExprCall}; use crate::checkers::ast::Checker; @@ -8,10 +8,101 @@ pub(super) enum DatetimeModuleAntipattern { NonePassedToTzArgument, } -/// Check if the parent expression is a call to `astimezone`. This assumes that -/// the current expression is a `datetime.datetime` object. -pub(super) fn parent_expr_is_astimezone(checker: &Checker) -> bool { - checker.semantic().current_expression_parent().is_some_and( |parent| { - matches!(parent, Expr::Attribute(ExprAttribute { attr, .. }) if attr.as_str() == "astimezone") - }) +/// Check if the "current expression" being visited is followed +/// in the source code by a chain of `.replace()` calls followed by `.astimezone`. +/// The function operates on the assumption that the current expression +/// is a [`datetime.datetime`][datetime] object. +/// +/// For example, given the following Python source code: +/// +/// ```py +/// import datetime +/// +/// datetime.now().replace(hours=4).replace(minutes=46).astimezone() +/// ``` +/// +/// The last line will produce an AST looking something like this +/// (this is pseudocode approximating our AST): +/// +/// ```rs +/// Call { +/// func: Attribute { +/// value: Call { +/// func: Attribute { +/// value: Call { +/// func: Attribute { +/// value: Call { // We are visiting this +/// func: Attribute { // expression node here +/// value: Call { // +/// func: Name { // +/// id: "datetime", // +/// }, // +/// }, // +/// attr: "now" // +/// }, // +/// }, // +/// attr: "replace" +/// }, +/// }, +/// attr: "replace" +/// }, +/// }, +/// attr: "astimezone" +/// }, +/// } +/// ``` +/// +/// The node we are visiting as the "current expression" is deeply +/// nested inside many other expressions. As such, in order to check +/// whether the `datetime.now()` call is followed by 0-or-more `.replace()` +/// calls and then an `.astimezone()` call, we must iterate up through the +/// "parent expressions" in the semantic model, checking if they match this +/// AST pattern. +/// +/// [datetime]: https://docs.python.org/3/library/datetime.html#datetime-objects +pub(super) fn followed_by_astimezone(checker: &Checker) -> bool { + let semantic = checker.semantic(); + let mut last = None; + + for (index, expr) in semantic.current_expressions().enumerate() { + if index == 0 { + // datetime.now(...).replace(...).astimezone + // ^^^^^^^^^^^^^^^^^ + continue; + } + + if index % 2 == 1 { + // datetime.now(...).replace(...).astimezone + // ^^^^^^^ ^^^^^^^^^^ + let Expr::Attribute(ExprAttribute { attr, .. }) = expr else { + return false; + }; + + match attr.as_str() { + "replace" => last = Some(AnyNodeRef::from(expr)), + "astimezone" => return true, + _ => return false, + } + } else { + // datetime.now(...).replace(...).astimezone + // ^^^^^ + let Expr::Call(ExprCall { func, .. }) = expr else { + return false; + }; + + // Without this branch, we would fail to emit a diagnostic on code like this: + // + // ```py + // foo.replace(datetime.now().replace).astimezone() + // # ^^^^^^^^^^^^^^ Diagnostic should be emitted here + // # since the `datetime.now()` call is not followed + // # by `.astimezone()` + // ``` + if !last.is_some_and(|it| it.ptr_eq(AnyNodeRef::from(&**func))) { + return false; + } + } + } + + false } diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_datetimez/rules/mod.rs index 87646ca77565a..c119a97760dc9 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_datetimez/rules/mod.rs @@ -7,6 +7,7 @@ pub(crate) use call_datetime_today::*; pub(crate) use call_datetime_utcfromtimestamp::*; pub(crate) use call_datetime_utcnow::*; pub(crate) use call_datetime_without_tzinfo::*; +pub(crate) use datetime_min_max::*; mod call_date_fromtimestamp; mod call_date_today; @@ -17,4 +18,5 @@ mod call_datetime_today; mod call_datetime_utcfromtimestamp; mod call_datetime_utcnow; mod call_datetime_without_tzinfo; +mod datetime_min_max; mod helpers; diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ001_DTZ001.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ001_DTZ001.py.snap index e4e8e1f901ef0..05999334ca8e2 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ001_DTZ001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ001_DTZ001.py.snap @@ -6,7 +6,7 @@ DTZ001.py:4:1: DTZ001 `datetime.datetime()` called without a `tzinfo` argument 3 | # no args 4 | datetime.datetime(2000, 1, 1, 0, 0, 0) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ001 -5 | +5 | 6 | # none args | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter @@ -16,7 +16,7 @@ DTZ001.py:7:1: DTZ001 `tzinfo=None` passed to `datetime.datetime()` 6 | # none args 7 | datetime.datetime(2000, 1, 1, 0, 0, 0, 0, None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ001 -8 | +8 | 9 | # not none arg | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter @@ -26,7 +26,7 @@ DTZ001.py:13:1: DTZ001 `datetime.datetime()` called without a `tzinfo` argument 12 | # no kwargs 13 | datetime.datetime(2000, 1, 1, fold=1) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ001 -14 | +14 | 15 | # none kwargs | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter @@ -36,7 +36,7 @@ DTZ001.py:16:1: DTZ001 `tzinfo=None` passed to `datetime.datetime()` 15 | # none kwargs 16 | datetime.datetime(2000, 1, 1, tzinfo=None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ001 -17 | +17 | 18 | from datetime import datetime | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter @@ -46,7 +46,7 @@ DTZ001.py:21:1: DTZ001 `datetime.datetime()` called without a `tzinfo` argument 20 | # no args unqualified 21 | datetime(2000, 1, 1, 0, 0, 0) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ001 -22 | +22 | 23 | # uses `astimezone` method | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ002_DTZ002.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ002_DTZ002.py.snap index 0f29ecf110394..34a34d1d838d4 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ002_DTZ002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ002_DTZ002.py.snap @@ -6,7 +6,7 @@ DTZ002.py:4:1: DTZ002 `datetime.datetime.today()` used 3 | # qualified 4 | datetime.datetime.today() | ^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ002 -5 | +5 | 6 | from datetime import datetime | = help: Use `datetime.datetime.now(tz=...)` instead @@ -16,7 +16,7 @@ DTZ002.py:9:1: DTZ002 `datetime.datetime.today()` used 8 | # unqualified 9 | datetime.today() | ^^^^^^^^^^^^^^^^ DTZ002 -10 | +10 | 11 | # uses `astimezone` method | = help: Use `datetime.datetime.now(tz=...)` instead diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ003_DTZ003.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ003_DTZ003.py.snap index 2b7953a7148aa..b436bff261cae 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ003_DTZ003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ003_DTZ003.py.snap @@ -6,7 +6,7 @@ DTZ003.py:4:1: DTZ003 `datetime.datetime.utcnow()` used 3 | # qualified 4 | datetime.datetime.utcnow() | ^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ003 -5 | +5 | 6 | from datetime import datetime | = help: Use `datetime.datetime.now(tz=...)` instead @@ -16,7 +16,7 @@ DTZ003.py:9:1: DTZ003 `datetime.datetime.utcnow()` used 8 | # unqualified 9 | datetime.utcnow() | ^^^^^^^^^^^^^^^^^ DTZ003 -10 | +10 | 11 | # uses `astimezone` method | = help: Use `datetime.datetime.now(tz=...)` instead diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ004_DTZ004.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ004_DTZ004.py.snap index 0efe06454de4b..41c2b782a9ecb 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ004_DTZ004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ004_DTZ004.py.snap @@ -6,7 +6,7 @@ DTZ004.py:4:1: DTZ004 `datetime.datetime.utcfromtimestamp()` used 3 | # qualified 4 | datetime.datetime.utcfromtimestamp(1234) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ004 -5 | +5 | 6 | from datetime import datetime | = help: Use `datetime.datetime.fromtimestamp(ts, tz=...)` instead @@ -16,7 +16,7 @@ DTZ004.py:9:1: DTZ004 `datetime.datetime.utcfromtimestamp()` used 8 | # unqualified 9 | datetime.utcfromtimestamp(1234) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ004 -10 | +10 | 11 | # uses `astimezone` method | = help: Use `datetime.datetime.fromtimestamp(ts, tz=...)` instead diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ005_DTZ005.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ005_DTZ005.py.snap index ee6f711e0bfc3..33ac751e3a91f 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ005_DTZ005.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ005_DTZ005.py.snap @@ -6,7 +6,7 @@ DTZ005.py:4:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument 3 | # no args 4 | datetime.datetime.now() | ^^^^^^^^^^^^^^^^^^^^^^^ DTZ005 -5 | +5 | 6 | # wrong keywords | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -16,7 +16,7 @@ DTZ005.py:7:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument 6 | # wrong keywords 7 | datetime.datetime.now(bad=datetime.timezone.utc) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ005 -8 | +8 | 9 | # none args | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -26,7 +26,7 @@ DTZ005.py:10:1: DTZ005 `tz=None` passed to `datetime.datetime.now()` 9 | # none args 10 | datetime.datetime.now(None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ005 -11 | +11 | 12 | # none keywords | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -36,7 +36,7 @@ DTZ005.py:13:1: DTZ005 `tz=None` passed to `datetime.datetime.now()` 12 | # none keywords 13 | datetime.datetime.now(tz=None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ005 -14 | +14 | 15 | from datetime import datetime | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -46,7 +46,60 @@ DTZ005.py:18:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument 17 | # no args unqualified 18 | datetime.now() | ^^^^^^^^^^^^^^ DTZ005 -19 | +19 | 20 | # uses `astimezone` method | = help: Pass a `datetime.timezone` object to the `tz` parameter + +DTZ005.py:28:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument + | +27 | ## Errors +28 | datetime.now().replace.astimezone() + | ^^^^^^^^^^^^^^ DTZ005 +29 | datetime.now().replace[0].astimezone() +30 | datetime.now()().astimezone() + | + = help: Pass a `datetime.timezone` object to the `tz` parameter + +DTZ005.py:29:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument + | +27 | ## Errors +28 | datetime.now().replace.astimezone() +29 | datetime.now().replace[0].astimezone() + | ^^^^^^^^^^^^^^ DTZ005 +30 | datetime.now()().astimezone() +31 | datetime.now().replace(datetime.now()).astimezone() + | + = help: Pass a `datetime.timezone` object to the `tz` parameter + +DTZ005.py:30:1: DTZ005 `datetime.datetime.now()` called without a `tz` argument + | +28 | datetime.now().replace.astimezone() +29 | datetime.now().replace[0].astimezone() +30 | datetime.now()().astimezone() + | ^^^^^^^^^^^^^^ DTZ005 +31 | datetime.now().replace(datetime.now()).astimezone() + | + = help: Pass a `datetime.timezone` object to the `tz` parameter + +DTZ005.py:31:24: DTZ005 `datetime.datetime.now()` called without a `tz` argument + | +29 | datetime.now().replace[0].astimezone() +30 | datetime.now()().astimezone() +31 | datetime.now().replace(datetime.now()).astimezone() + | ^^^^^^^^^^^^^^ DTZ005 +32 | +33 | foo.replace(datetime.now().replace).astimezone() + | + = help: Pass a `datetime.timezone` object to the `tz` parameter + +DTZ005.py:33:13: DTZ005 `datetime.datetime.now()` called without a `tz` argument + | +31 | datetime.now().replace(datetime.now()).astimezone() +32 | +33 | foo.replace(datetime.now().replace).astimezone() + | ^^^^^^^^^^^^^^ DTZ005 +34 | +35 | ## No errors + | + = help: Pass a `datetime.timezone` object to the `tz` parameter diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ006_DTZ006.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ006_DTZ006.py.snap index e708ed9d52404..7ce79909c4d36 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ006_DTZ006.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ006_DTZ006.py.snap @@ -6,7 +6,7 @@ DTZ006.py:4:1: DTZ006 `datetime.datetime.fromtimestamp()` called without a `tz` 3 | # no args 4 | datetime.datetime.fromtimestamp(1234) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ006 -5 | +5 | 6 | # wrong keywords | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -16,7 +16,7 @@ DTZ006.py:7:1: DTZ006 `datetime.datetime.fromtimestamp()` called without a `tz` 6 | # wrong keywords 7 | datetime.datetime.fromtimestamp(1234, bad=datetime.timezone.utc) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ006 -8 | +8 | 9 | # none args | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -26,7 +26,7 @@ DTZ006.py:10:1: DTZ006 `tz=None` passed to `datetime.datetime.fromtimestamp()` 9 | # none args 10 | datetime.datetime.fromtimestamp(1234, None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ006 -11 | +11 | 12 | # none keywords | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -36,7 +36,7 @@ DTZ006.py:13:1: DTZ006 `tz=None` passed to `datetime.datetime.fromtimestamp()` 12 | # none keywords 13 | datetime.datetime.fromtimestamp(1234, tz=None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ006 -14 | +14 | 15 | from datetime import datetime | = help: Pass a `datetime.timezone` object to the `tz` parameter @@ -46,7 +46,7 @@ DTZ006.py:18:1: DTZ006 `datetime.datetime.fromtimestamp()` called without a `tz` 17 | # no args unqualified 18 | datetime.fromtimestamp(1234) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ006 -19 | +19 | 20 | # uses `astimezone` method | = help: Pass a `datetime.timezone` object to the `tz` parameter diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ007_DTZ007.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ007_DTZ007.py.snap index f2579ea9d29a2..06b7452962057 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ007_DTZ007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ007_DTZ007.py.snap @@ -6,7 +6,7 @@ DTZ007.py:4:1: DTZ007 Naive datetime constructed using `datetime.datetime.strpti 3 | # bad format 4 | datetime.datetime.strptime("something", "%H:%M:%S%Z") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ007 -5 | +5 | 6 | # no replace or astimezone | = help: Call `.replace(tzinfo=<timezone>)` or `.astimezone()` to convert to an aware datetime @@ -16,7 +16,7 @@ DTZ007.py:7:1: DTZ007 Naive datetime constructed using `datetime.datetime.strpti 6 | # no replace or astimezone 7 | datetime.datetime.strptime("something", "something") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ007 -8 | +8 | 9 | # wrong replace | = help: Call `.replace(tzinfo=<timezone>)` or `.astimezone()` to convert to an aware datetime @@ -26,7 +26,7 @@ DTZ007.py:10:1: DTZ007 Naive datetime constructed using `datetime.datetime.strpt 9 | # wrong replace 10 | datetime.datetime.strptime("something", "something").replace(hour=1) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ007 -11 | +11 | 12 | # none replace | = help: Call `.replace(tzinfo=<timezone>)` or `.astimezone()` to convert to an aware datetime @@ -36,7 +36,7 @@ DTZ007.py:13:1: DTZ007 `datetime.datetime.strptime(...).replace(tz=None)` used 12 | # none replace 13 | datetime.datetime.strptime("something", "something").replace(tzinfo=None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ007 -14 | +14 | 15 | # OK | = help: Pass a `datetime.timezone` object to the `tzinfo` parameter @@ -46,7 +46,7 @@ DTZ007.py:35:1: DTZ007 Naive datetime constructed using `datetime.datetime.strpt 34 | # no replace orastimezone unqualified 35 | datetime.strptime("something", "something") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ007 -36 | +36 | 37 | # F-strings | = help: Call `.replace(tzinfo=<timezone>)` or `.astimezone()` to convert to an aware datetime diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ011_DTZ011.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ011_DTZ011.py.snap index 2a19a7162f01b..b15b8f9266a4c 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ011_DTZ011.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ011_DTZ011.py.snap @@ -6,7 +6,7 @@ DTZ011.py:4:1: DTZ011 `datetime.date.today()` used 3 | # qualified 4 | datetime.date.today() | ^^^^^^^^^^^^^^^^^^^^^ DTZ011 -5 | +5 | 6 | from datetime import date | = help: Use `datetime.datetime.now(tz=...).date()` instead diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ012_DTZ012.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ012_DTZ012.py.snap index fe0bffe0f4d3c..2c8ab9d3214fe 100644 --- a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ012_DTZ012.py.snap +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ012_DTZ012.py.snap @@ -6,7 +6,7 @@ DTZ012.py:4:1: DTZ012 `datetime.date.fromtimestamp()` used 3 | # qualified 4 | datetime.date.fromtimestamp(1234) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DTZ012 -5 | +5 | 6 | from datetime import date | = help: Use `datetime.datetime.fromtimestamp(ts, tz=...).date()` instead diff --git a/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ901_DTZ901.py.snap b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ901_DTZ901.py.snap new file mode 100644 index 0000000000000..87a4d1a557191 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_datetimez/snapshots/ruff_linter__rules__flake8_datetimez__tests__DTZ901_DTZ901.py.snap @@ -0,0 +1,78 @@ +--- +source: crates/ruff_linter/src/rules/flake8_datetimez/mod.rs +--- +DTZ901.py:5:1: DTZ901 Use of `datetime.datetime.max` without timezone information + | +4 | # Error +5 | datetime.datetime.max + | ^^^^^^^^^^^^^^^^^^^^^ DTZ901 +6 | datetime.datetime.min + | + = help: Replace with `datetime.datetime.max.replace(tzinfo=...)` + +DTZ901.py:6:1: DTZ901 Use of `datetime.datetime.min` without timezone information + | +4 | # Error +5 | datetime.datetime.max +6 | datetime.datetime.min + | ^^^^^^^^^^^^^^^^^^^^^ DTZ901 +7 | +8 | datetime.datetime.max.replace(year=...) + | + = help: Replace with `datetime.datetime.min.replace(tzinfo=...)` + +DTZ901.py:8:1: DTZ901 Use of `datetime.datetime.max` without timezone information + | +6 | datetime.datetime.min +7 | +8 | datetime.datetime.max.replace(year=...) + | ^^^^^^^^^^^^^^^^^^^^^ DTZ901 +9 | datetime.datetime.min.replace(hour=...) + | + = help: Replace with `datetime.datetime.max.replace(tzinfo=...)` + +DTZ901.py:9:1: DTZ901 Use of `datetime.datetime.min` without timezone information + | +8 | datetime.datetime.max.replace(year=...) +9 | datetime.datetime.min.replace(hour=...) + | ^^^^^^^^^^^^^^^^^^^^^ DTZ901 + | + = help: Replace with `datetime.datetime.min.replace(tzinfo=...)` + +DTZ901.py:27:1: DTZ901 Use of `datetime.datetime.max` without timezone information + | +26 | # Error +27 | datetime.max + | ^^^^^^^^^^^^ DTZ901 +28 | datetime.min + | + = help: Replace with `datetime.datetime.max.replace(tzinfo=...)` + +DTZ901.py:28:1: DTZ901 Use of `datetime.datetime.min` without timezone information + | +26 | # Error +27 | datetime.max +28 | datetime.min + | ^^^^^^^^^^^^ DTZ901 +29 | +30 | datetime.max.replace(year=...) + | + = help: Replace with `datetime.datetime.min.replace(tzinfo=...)` + +DTZ901.py:30:1: DTZ901 Use of `datetime.datetime.max` without timezone information + | +28 | datetime.min +29 | +30 | datetime.max.replace(year=...) + | ^^^^^^^^^^^^ DTZ901 +31 | datetime.min.replace(hour=...) + | + = help: Replace with `datetime.datetime.max.replace(tzinfo=...)` + +DTZ901.py:31:1: DTZ901 Use of `datetime.datetime.min` without timezone information + | +30 | datetime.max.replace(year=...) +31 | datetime.min.replace(hour=...) + | ^^^^^^^^^^^^ DTZ901 + | + = help: Replace with `datetime.datetime.min.replace(tzinfo=...)` diff --git a/crates/ruff_linter/src/rules/flake8_debugger/rules/debugger.rs b/crates/ruff_linter/src/rules/flake8_debugger/rules/debugger.rs index fa3ace456be77..9ac6c79bbbfac 100644 --- a/crates/ruff_linter/src/rules/flake8_debugger/rules/debugger.rs +++ b/crates/ruff_linter/src/rules/flake8_debugger/rules/debugger.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_text_size::Ranged; @@ -30,8 +30,8 @@ use crate::rules::flake8_debugger::types::DebuggerUsingType; /// ## References /// - [Python documentation: `pdb` — The Python Debugger](https://docs.python.org/3/library/pdb.html) /// - [Python documentation: `logging` — Logging facility for Python](https://docs.python.org/3/library/logging.html) -#[violation] -pub struct Debugger { +#[derive(ViolationMetadata)] +pub(crate) struct Debugger { using_type: DebuggerUsingType, } @@ -47,7 +47,7 @@ impl Violation for Debugger { } /// Checks for the presence of a debugger call. -pub(crate) fn debugger_call(checker: &mut Checker, expr: &Expr, func: &Expr) { +pub(crate) fn debugger_call(checker: &Checker, expr: &Expr, func: &Expr) { if let Some(using_type) = checker .semantic() @@ -60,9 +60,7 @@ pub(crate) fn debugger_call(checker: &mut Checker, expr: &Expr, func: &Expr) { } }) { - checker - .diagnostics - .push(Diagnostic::new(Debugger { using_type }, expr.range())); + checker.report_diagnostic(Diagnostic::new(Debugger { using_type }, expr.range())); } } @@ -111,14 +109,15 @@ fn is_debugger_call(qualified_name: &QualifiedName) -> bool { | ["builtins" | "", "breakpoint"] | ["debugpy", "breakpoint" | "listen" | "wait_for_client"] | ["ptvsd", "break_into_debugger" | "wait_for_attach"] + | ["sys", "breakpointhook" | "__breakpointhook__"] ) } fn is_debugger_import(qualified_name: &QualifiedName) -> bool { // Constructed by taking every pattern in `is_debugger_call`, removing the last element in // each pattern, and de-duplicating the values. - // As a special-case, we omit `builtins` to allow `import builtins`, which is far more general - // than (e.g.) `import celery.contrib.rdb`. + // As special-cases, we omit `builtins` and `sys` to allow `import builtins` and `import sys` + // which are far more general than (e.g.) `import celery.contrib.rdb`. matches!( qualified_name.segments(), ["pdb" | "pudb" | "ipdb" | "debugpy" | "ptvsd"] diff --git a/crates/ruff_linter/src/rules/flake8_debugger/snapshots/ruff_linter__rules__flake8_debugger__tests__T100_T100.py.snap b/crates/ruff_linter/src/rules/flake8_debugger/snapshots/ruff_linter__rules__flake8_debugger__tests__T100_T100.py.snap index 9fe528f183080..75baaa0379966 100644 --- a/crates/ruff_linter/src/rules/flake8_debugger/snapshots/ruff_linter__rules__flake8_debugger__tests__T100_T100.py.snap +++ b/crates/ruff_linter/src/rules/flake8_debugger/snapshots/ruff_linter__rules__flake8_debugger__tests__T100_T100.py.snap @@ -5,14 +5,14 @@ T100.py:1:1: T100 Trace found: `breakpoint` used | 1 | breakpoint() | ^^^^^^^^^^^^ T100 -2 | +2 | 3 | import pdb | T100.py:3:1: T100 Import for `pdb` found | 1 | breakpoint() -2 | +2 | 3 | import pdb | ^^^^^^^^^^ T100 4 | import builtins @@ -104,14 +104,14 @@ T100.py:15:1: T100 Import for `ptvsd` found 14 | from ptvsd import wait_for_attach 15 | import ptvsd | ^^^^^^^^^^^^ T100 -16 | +16 | 17 | breakpoint() | T100.py:17:1: T100 Trace found: `builtins.breakpoint` used | 15 | import ptvsd -16 | +16 | 17 | breakpoint() | ^^^^^^^^^^^^ T100 18 | st() @@ -183,3 +183,57 @@ T100.py:25:1: T100 Trace found: `ptvsd.wait_for_attach` used 25 | wait_for_attach() | ^^^^^^^^^^^^^^^^^ T100 | + +T100.py:33:5: T100 Import for `sys.breakpointhook` found + | +32 | def scope(): +33 | from sys import breakpointhook # error + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ T100 +34 | +35 | breakpointhook() # error + | + +T100.py:35:5: T100 Trace found: `sys.breakpointhook` used + | +33 | from sys import breakpointhook # error +34 | +35 | breakpointhook() # error + | ^^^^^^^^^^^^^^^^ T100 +36 | +37 | def scope(): + | + +T100.py:38:5: T100 Import for `sys.__breakpointhook__` found + | +37 | def scope(): +38 | from sys import __breakpointhook__ # error + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ T100 +39 | +40 | __breakpointhook__() # error + | + +T100.py:40:5: T100 Trace found: `sys.__breakpointhook__` used + | +38 | from sys import __breakpointhook__ # error +39 | +40 | __breakpointhook__() # error + | ^^^^^^^^^^^^^^^^^^^^ T100 +41 | +42 | sys.breakpointhook() # error + | + +T100.py:42:1: T100 Trace found: `sys.breakpointhook` used + | +40 | __breakpointhook__() # error +41 | +42 | sys.breakpointhook() # error + | ^^^^^^^^^^^^^^^^^^^^ T100 +43 | sys.__breakpointhook__() # error + | + +T100.py:43:1: T100 Trace found: `sys.__breakpointhook__` used + | +42 | sys.breakpointhook() # error +43 | sys.__breakpointhook__() # error + | ^^^^^^^^^^^^^^^^^^^^^^^^ T100 + | diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/all_with_model_form.rs b/crates/ruff_linter/src/rules/flake8_django/rules/all_with_model_form.rs index cb942cf6ae366..794ae075d0ae4 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/all_with_model_form.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/all_with_model_form.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -37,18 +37,18 @@ use crate::rules::flake8_django::rules::helpers::is_model_form; /// model = Post /// fields = ["title", "content"] /// ``` -#[violation] -pub struct DjangoAllWithModelForm; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoAllWithModelForm; impl Violation for DjangoAllWithModelForm { #[derive_message_formats] fn message(&self) -> String { - format!("Do not use `__all__` with `ModelForm`, use `fields` instead") + "Do not use `__all__` with `ModelForm`, use `fields` instead".to_string() } } /// DJ007 -pub(crate) fn all_with_model_form(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn all_with_model_form(checker: &Checker, class_def: &ast::StmtClassDef) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -78,22 +78,24 @@ pub(crate) fn all_with_model_form(checker: &mut Checker, class_def: &ast::StmtCl match value.as_ref() { Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => { if value == "__all__" { - checker - .diagnostics - .push(Diagnostic::new(DjangoAllWithModelForm, element.range())); + checker.report_diagnostic(Diagnostic::new( + DjangoAllWithModelForm, + element.range(), + )); return; } } Expr::BytesLiteral(ast::ExprBytesLiteral { value, .. }) => { if value == "__all__".as_bytes() { - checker - .diagnostics - .push(Diagnostic::new(DjangoAllWithModelForm, element.range())); + checker.report_diagnostic(Diagnostic::new( + DjangoAllWithModelForm, + element.range(), + )); return; } } _ => (), - }; + } } } } diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/exclude_with_model_form.rs b/crates/ruff_linter/src/rules/flake8_django/rules/exclude_with_model_form.rs index 3e1dd6281ffd1..c92c0fc047522 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/exclude_with_model_form.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/exclude_with_model_form.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -35,18 +35,18 @@ use crate::rules::flake8_django::rules::helpers::is_model_form; /// model = Post /// fields = ["title", "content"] /// ``` -#[violation] -pub struct DjangoExcludeWithModelForm; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoExcludeWithModelForm; impl Violation for DjangoExcludeWithModelForm { #[derive_message_formats] fn message(&self) -> String { - format!("Do not use `exclude` with `ModelForm`, use `fields` instead") + "Do not use `exclude` with `ModelForm`, use `fields` instead".to_string() } } /// DJ006 -pub(crate) fn exclude_with_model_form(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn exclude_with_model_form(checker: &Checker, class_def: &ast::StmtClassDef) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -71,9 +71,10 @@ pub(crate) fn exclude_with_model_form(checker: &mut Checker, class_def: &ast::St continue; }; if id == "exclude" { - checker - .diagnostics - .push(Diagnostic::new(DjangoExcludeWithModelForm, target.range())); + checker.report_diagnostic(Diagnostic::new( + DjangoExcludeWithModelForm, + target.range(), + )); return; } } diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/helpers.rs b/crates/ruff_linter/src/rules/flake8_django/rules/helpers.rs index 67c12bbbfb605..4cfedeeec93d7 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/helpers.rs @@ -1,6 +1,6 @@ use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{analyze, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze}; /// Return `true` if a Python class appears to be a Django model, based on its base classes. pub(super) fn is_model(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> bool { diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/locals_in_render_function.rs b/crates/ruff_linter/src/rules/flake8_django/rules/locals_in_render_function.rs index 2b60a5c2ec35d..9dbf1ae2f7075 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/locals_in_render_function.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/locals_in_render_function.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::{Modules, SemanticModel}; use ruff_text_size::Ranged; @@ -33,18 +33,18 @@ use crate::checkers::ast::Checker; /// context = {"posts": posts} /// return render(request, "app/index.html", context) /// ``` -#[violation] -pub struct DjangoLocalsInRenderFunction; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoLocalsInRenderFunction; impl Violation for DjangoLocalsInRenderFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid passing `locals()` as context to a `render` function") + "Avoid passing `locals()` as context to a `render` function".to_string() } } /// DJ003 -pub(crate) fn locals_in_render_function(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn locals_in_render_function(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -59,9 +59,9 @@ pub(crate) fn locals_in_render_function(checker: &mut Checker, call: &ast::ExprC return; } - if let Some(argument) = call.arguments.find_argument("context", 2) { + if let Some(argument) = call.arguments.find_argument_value("context", 2) { if is_locals_call(argument, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DjangoLocalsInRenderFunction, argument.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/model_without_dunder_str.rs b/crates/ruff_linter/src/rules/flake8_django/rules/model_without_dunder_str.rs index 3e16d3e66cfbc..9ea374cca6809 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/model_without_dunder_str.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/model_without_dunder_str.rs @@ -1,9 +1,9 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::{self as ast, Expr, Stmt}; -use ruff_python_semantic::{analyze, Modules, SemanticModel}; +use ruff_python_semantic::{Modules, SemanticModel, analyze}; use crate::checkers::ast::Checker; @@ -40,18 +40,18 @@ use super::helpers; /// def __str__(self): /// return f"{self.field}" /// ``` -#[violation] -pub struct DjangoModelWithoutDunderStr; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoModelWithoutDunderStr; impl Violation for DjangoModelWithoutDunderStr { #[derive_message_formats] fn message(&self) -> String { - format!("Model does not define `__str__` method") + "Model does not define `__str__` method".to_string() } } /// DJ008 -pub(crate) fn model_without_dunder_str(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn model_without_dunder_str(checker: &Checker, class_def: &ast::StmtClassDef) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -64,7 +64,7 @@ pub(crate) fn model_without_dunder_str(checker: &mut Checker, class_def: &ast::S return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DjangoModelWithoutDunderStr, class_def.identifier(), )); diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/non_leading_receiver_decorator.rs b/crates/ruff_linter/src/rules/flake8_django/rules/non_leading_receiver_decorator.rs index 52118e6b67df8..74ef6caf804ce 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/non_leading_receiver_decorator.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/non_leading_receiver_decorator.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Decorator; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -40,18 +40,18 @@ use crate::checkers::ast::Checker; /// def my_handler(sender, instance, created, **kwargs): /// pass /// ``` -#[violation] -pub struct DjangoNonLeadingReceiverDecorator; +#[derive(ViolationMetadata)] +pub(crate) struct DjangoNonLeadingReceiverDecorator; impl Violation for DjangoNonLeadingReceiverDecorator { #[derive_message_formats] fn message(&self) -> String { - format!("`@receiver` decorator must be on top of all the other decorators") + "`@receiver` decorator must be on top of all the other decorators".to_string() } } /// DJ013 -pub(crate) fn non_leading_receiver_decorator(checker: &mut Checker, decorator_list: &[Decorator]) { +pub(crate) fn non_leading_receiver_decorator(checker: &Checker, decorator_list: &[Decorator]) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -70,7 +70,7 @@ pub(crate) fn non_leading_receiver_decorator(checker: &mut Checker, decorator_li }) }); if i > 0 && is_receiver && !seen_receiver { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DjangoNonLeadingReceiverDecorator, decorator.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/nullable_model_string_field.rs b/crates/ruff_linter/src/rules/flake8_django/rules/nullable_model_string_field.rs index 2fe2b6aaba9d2..d01f35154176f 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/nullable_model_string_field.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/nullable_model_string_field.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_semantic::{Modules, SemanticModel}; use ruff_text_size::Ranged; @@ -40,8 +40,8 @@ use super::helpers; /// class MyModel(models.Model): /// field = models.CharField(max_length=255, default="") /// ``` -#[violation] -pub struct DjangoNullableModelStringField { +#[derive(ViolationMetadata)] +pub(crate) struct DjangoNullableModelStringField { field_name: String, } @@ -54,7 +54,7 @@ impl Violation for DjangoNullableModelStringField { } /// DJ001 -pub(crate) fn nullable_model_string_field(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn nullable_model_string_field(checker: &Checker, body: &[Stmt]) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -64,7 +64,7 @@ pub(crate) fn nullable_model_string_field(checker: &mut Checker, body: &[Stmt]) continue; }; if let Some(field_name) = is_nullable_field(value, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DjangoNullableModelStringField { field_name: field_name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_django/rules/unordered_body_content_in_model.rs b/crates/ruff_linter/src/rules/flake8_django/rules/unordered_body_content_in_model.rs index 7b5596d55269b..fdc0b806b0ded 100644 --- a/crates/ruff_linter/src/rules/flake8_django/rules/unordered_body_content_in_model.rs +++ b/crates/ruff_linter/src/rules/flake8_django/rules/unordered_body_content_in_model.rs @@ -1,7 +1,8 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::is_dunder; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_semantic::{Modules, SemanticModel}; use ruff_text_size::Ranged; @@ -26,7 +27,7 @@ use super::helpers; /// 6. `def get_absolute_url()` /// 7. Any custom methods /// -/// ## Examples +/// ## Example /// ```python /// from django.db import models /// @@ -61,8 +62,8 @@ use super::helpers; /// ``` /// /// [Django Style Guide]: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#model-style -#[violation] -pub struct DjangoUnorderedBodyContentInModel { +#[derive(ViolationMetadata)] +pub(crate) struct DjangoUnorderedBodyContentInModel { element_type: ContentType, prev_element_type: ContentType, } @@ -74,15 +75,14 @@ impl Violation for DjangoUnorderedBodyContentInModel { element_type, prev_element_type, } = self; - format!("Order of model's inner classes, methods, and fields does not follow the Django Style Guide: {element_type} should come before {prev_element_type}") + format!( + "Order of model's inner classes, methods, and fields does not follow the Django Style Guide: {element_type} should come before {prev_element_type}" + ) } } /// DJ012 -pub(crate) fn unordered_body_content_in_model( - checker: &mut Checker, - class_def: &ast::StmtClassDef, -) { +pub(crate) fn unordered_body_content_in_model(checker: &Checker, class_def: &ast::StmtClassDef) { if !checker.semantic().seen_module(Modules::DJANGO) { return; } @@ -119,7 +119,7 @@ pub(crate) fn unordered_body_content_in_model( }, element.range(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else { element_types.push(element_type); } @@ -131,7 +131,7 @@ enum ContentType { FieldDeclaration, ManagerDeclaration, MetaClass, - StrMethod, + MagicMethod, SaveMethod, GetAbsoluteUrlMethod, CustomMethod, @@ -143,7 +143,7 @@ impl fmt::Display for ContentType { ContentType::FieldDeclaration => f.write_str("field declaration"), ContentType::ManagerDeclaration => f.write_str("manager declaration"), ContentType::MetaClass => f.write_str("`Meta` class"), - ContentType::StrMethod => f.write_str("`__str__` method"), + ContentType::MagicMethod => f.write_str("Magic method"), ContentType::SaveMethod => f.write_str("`save` method"), ContentType::GetAbsoluteUrlMethod => f.write_str("`get_absolute_url` method"), ContentType::CustomMethod => f.write_str("custom method"), @@ -177,7 +177,7 @@ fn get_element_type(element: &Stmt, semantic: &SemanticModel) -> Option<ContentT } } Stmt::FunctionDef(ast::StmtFunctionDef { name, .. }) => match name.as_str() { - "__str__" => Some(ContentType::StrMethod), + name if is_dunder(name) => Some(ContentType::MagicMethod), "save" => Some(ContentType::SaveMethod), "get_absolute_url" => Some(ContentType::GetAbsoluteUrlMethod), _ => Some(ContentType::CustomMethod), diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ001_DJ001.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ001_DJ001.py.snap index 54812a0f1d7f3..cbb03a4067837 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ001_DJ001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ001_DJ001.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ001.py:7:17: DJ001 Avoid using `null=True` on string-based fields such as `CharField` | @@ -168,5 +169,3 @@ DJ001.py:30:16: DJ001 Avoid using `null=True` on string-based fields such as `UR 30 | urlfield = models.URLField(max_length=255, null=True) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ003_DJ003.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ003_DJ003.py.snap index ce26aedc42f56..9dad4f65f4564 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ003_DJ003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ003_DJ003.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ003.py:5:42: DJ003 Avoid passing `locals()` as context to a `render` function | @@ -14,5 +15,3 @@ DJ003.py:9:50: DJ003 Avoid passing `locals()` as context to a `render` function 9 | return render(request, "index.html", context=locals()) | ^^^^^^^^ DJ003 | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ006_DJ006.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ006_DJ006.py.snap index 185382fe24c2e..206c7035594e6 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ006_DJ006.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ006_DJ006.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ006.py:6:9: DJ006 Do not use `exclude` with `ModelForm`, use `fields` instead | @@ -8,5 +9,3 @@ DJ006.py:6:9: DJ006 Do not use `exclude` with `ModelForm`, use `fields` instead 6 | exclude = ["bar"] | ^^^^^^^ DJ006 | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ007_DJ007.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ007_DJ007.py.snap index 4a38c1a542224..c7ad057ae8871 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ007_DJ007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ007_DJ007.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ007.py:6:9: DJ007 Do not use `__all__` with `ModelForm`, use `fields` instead | @@ -16,5 +17,3 @@ DJ007.py:11:9: DJ007 Do not use `__all__` with `ModelForm`, use `fields` instead 11 | fields = b"__all__" | ^^^^^^^^^^^^^^^^^^^ DJ007 | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ008_DJ008.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ008_DJ008.py.snap index a913353ad76b0..e24f8f8cfdad0 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ008_DJ008.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ008_DJ008.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ008.py:6:7: DJ008 Model does not define `__str__` method | @@ -30,5 +31,3 @@ DJ008.py:182:7: DJ008 Model does not define `__str__` method | ^^^^^^^^^^^^^^^^^^ DJ008 183 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ012_DJ012.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ012_DJ012.py.snap index 79e5d7e39539e..8b124c4474f45 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ012_DJ012.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ012_DJ012.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_django/mod.rs DJ012.py:28:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: field declaration should come before `Meta` class | 26 | return "foobar" -27 | +27 | 28 | first_name = models.CharField(max_length=32) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ012 | @@ -12,17 +12,16 @@ DJ012.py:28:5: DJ012 Order of model's inner classes, methods, and fields does no DJ012.py:43:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: field declaration should come before manager declaration | 41 | return "foobar" -42 | +42 | 43 | first_name = models.CharField(max_length=32) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ012 | -DJ012.py:56:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: `__str__` method should come before custom method +DJ012.py:56:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: Magic method should come before custom method | 54 | pass -55 | -56 | def __str__(self): - | _____^ +55 | +56 | / def __str__(self): 57 | | return "foobar" | |_______________________^ DJ012 | @@ -30,9 +29,8 @@ DJ012.py:56:5: DJ012 Order of model's inner classes, methods, and fields does no DJ012.py:69:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: `save` method should come before `get_absolute_url` method | 67 | pass -68 | -69 | def save(self): - | _____^ +68 | +69 | / def save(self): 70 | | pass | |____________^ DJ012 | @@ -40,7 +38,7 @@ DJ012.py:69:5: DJ012 Order of model's inner classes, methods, and fields does no DJ012.py:123:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: field declaration should come before `Meta` class | 121 | verbose_name = "test" -122 | +122 | 123 | first_name = models.CharField(max_length=32) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ012 124 | last_name = models.CharField(max_length=32) @@ -49,7 +47,7 @@ DJ012.py:123:5: DJ012 Order of model's inner classes, methods, and fields does n DJ012.py:129:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: field declaration should come before `Meta` class | 127 | pass -128 | +128 | 129 | middle_name = models.CharField(max_length=32) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ012 | @@ -57,9 +55,7 @@ DJ012.py:129:5: DJ012 Order of model's inner classes, methods, and fields does n DJ012.py:146:5: DJ012 Order of model's inner classes, methods, and fields does not follow the Django Style Guide: field declaration should come before `Meta` class | 144 | return "foobar" -145 | +145 | 146 | first_name = models.CharField(max_length=32) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DJ012 | - - diff --git a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ013_DJ013.py.snap b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ013_DJ013.py.snap index dbceb4b69b4d8..27a74d79be26a 100644 --- a/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ013_DJ013.py.snap +++ b/crates/ruff_linter/src/rules/flake8_django/snapshots/ruff_linter__rules__flake8_django__tests__DJ013_DJ013.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_django/mod.rs +snapshot_kind: text --- DJ013.py:15:1: DJ013 `@receiver` decorator must be on top of all the other decorators | @@ -19,5 +20,3 @@ DJ013.py:35:1: DJ013 `@receiver` decorator must be on top of all the other decor 36 | def incorrect_multiple(): 37 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_errmsg/rules/string_in_exception.rs b/crates/ruff_linter/src/rules/flake8_errmsg/rules/string_in_exception.rs index c119d11e74aef..85767714069ca 100644 --- a/crates/ruff_linter/src/rules/flake8_errmsg/rules/string_in_exception.rs +++ b/crates/ruff_linter/src/rules/flake8_errmsg/rules/string_in_exception.rs @@ -1,14 +1,14 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::whitespace; use ruff_python_ast::{self as ast, Arguments, Expr, Stmt}; use ruff_python_codegen::Stylist; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::registry::Rule; -use crate::Locator; /// ## What it does /// Checks for the use of string literals in exception constructors. @@ -47,15 +47,15 @@ use crate::Locator; /// raise RuntimeError(msg) /// RuntimeError: 'Some value' is incorrect /// ``` -#[violation] -pub struct RawStringInException; +#[derive(ViolationMetadata)] +pub(crate) struct RawStringInException; impl Violation for RawStringInException { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Exception must not use a string literal, assign to variable first") + "Exception must not use a string literal, assign to variable first".to_string() } fn fix_title(&self) -> Option<String> { @@ -102,15 +102,15 @@ impl Violation for RawStringInException { /// raise RuntimeError(msg) /// RuntimeError: 'Some value' is incorrect /// ``` -#[violation] -pub struct FStringInException; +#[derive(ViolationMetadata)] +pub(crate) struct FStringInException; impl Violation for FStringInException { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Exception must not use an f-string literal, assign to variable first") + "Exception must not use an f-string literal, assign to variable first".to_string() } fn fix_title(&self) -> Option<String> { @@ -158,15 +158,15 @@ impl Violation for FStringInException { /// raise RuntimeError(msg) /// RuntimeError: 'Some value' is incorrect /// ``` -#[violation] -pub struct DotFormatInException; +#[derive(ViolationMetadata)] +pub(crate) struct DotFormatInException; impl Violation for DotFormatInException { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Exception must not use a `.format()` string directly, assign to variable first") + "Exception must not use a `.format()` string directly, assign to variable first".to_string() } fn fix_title(&self) -> Option<String> { @@ -175,7 +175,7 @@ impl Violation for DotFormatInException { } /// EM101, EM102, EM103 -pub(crate) fn string_in_exception(checker: &mut Checker, stmt: &Stmt, exc: &Expr) { +pub(crate) fn string_in_exception(checker: &Checker, stmt: &Stmt, exc: &Expr) { if let Expr::Call(ast::ExprCall { arguments: Arguments { args, .. }, .. @@ -200,7 +200,7 @@ pub(crate) fn string_in_exception(checker: &mut Checker, stmt: &Stmt, exc: &Expr checker.locator(), )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -217,7 +217,7 @@ pub(crate) fn string_in_exception(checker: &mut Checker, stmt: &Stmt, exc: &Expr checker.locator(), )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } // Check for .format() calls. @@ -240,7 +240,7 @@ pub(crate) fn string_in_exception(checker: &mut Checker, stmt: &Stmt, exc: &Expr checker.locator(), )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__custom.snap b/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__custom.snap index d29e987d4952a..bb2dfde20bc68 100644 --- a/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__custom.snap +++ b/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__custom.snap @@ -82,7 +82,7 @@ EM.py:32:24: EM101 [*] Exception must not use a string literal, assign to variab EM.py:39:24: EM101 [*] Exception must not use a string literal, assign to variable first | 37 | msg = "hello" -38 | +38 | 39 | raise RuntimeError("This is an example exception") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ EM101 | @@ -222,8 +222,7 @@ EM.py:76:9: EM103 [*] Exception must not use a `.format()` string directly, assi | 74 | def f_multi_line_string2(): 75 | raise RuntimeError( -76 | "This is an {example} exception".format( - | _________^ +76 | / "This is an {example} exception".format( 77 | | example="example" 78 | | ) | |_________^ EM103 @@ -252,8 +251,7 @@ EM.py:84:9: EM103 [*] Exception must not use a `.format()` string directly, assi | 82 | def f_multi_line_string2(): 83 | raise RuntimeError( -84 | ( - | _________^ +84 | / ( 85 | | "This is an " 86 | | "{example} exception" 87 | | ).format( @@ -280,5 +278,3 @@ EM.py:84:9: EM103 [*] Exception must not use a `.format()` string directly, assi 91 |+ raise RuntimeError( 92 |+ msg 93 |+ ) - - diff --git a/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__defaults.snap b/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__defaults.snap index 593d6b30dcc0e..42e9f412505e0 100644 --- a/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__defaults.snap +++ b/crates/ruff_linter/src/rules/flake8_errmsg/snapshots/ruff_linter__rules__flake8_errmsg__tests__defaults.snap @@ -120,7 +120,7 @@ EM.py:32:24: EM101 [*] Exception must not use a string literal, assign to variab EM.py:39:24: EM101 [*] Exception must not use a string literal, assign to variable first | 37 | msg = "hello" -38 | +38 | 39 | raise RuntimeError("This is an example exception") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ EM101 | @@ -260,8 +260,7 @@ EM.py:69:9: EM101 [*] Exception must not use a string literal, assign to variabl | 67 | def f_multi_line_string(): 68 | raise RuntimeError( -69 | "first" - | _________^ +69 | / "first" 70 | | "second" | |________________^ EM101 71 | ) @@ -288,8 +287,7 @@ EM.py:76:9: EM103 [*] Exception must not use a `.format()` string directly, assi | 74 | def f_multi_line_string2(): 75 | raise RuntimeError( -76 | "This is an {example} exception".format( - | _________^ +76 | / "This is an {example} exception".format( 77 | | example="example" 78 | | ) | |_________^ EM103 @@ -318,8 +316,7 @@ EM.py:84:9: EM103 [*] Exception must not use a `.format()` string directly, assi | 82 | def f_multi_line_string2(): 83 | raise RuntimeError( -84 | ( - | _________^ +84 | / ( 85 | | "This is an " 86 | | "{example} exception" 87 | | ).format( @@ -346,5 +343,3 @@ EM.py:84:9: EM103 [*] Exception must not use a `.format()` string directly, assi 91 |+ raise RuntimeError( 92 |+ msg 93 |+ ) - - diff --git a/crates/ruff_linter/src/rules/flake8_executable/mod.rs b/crates/ruff_linter/src/rules/flake8_executable/mod.rs index 795a81d3b8cc8..f127232890320 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/mod.rs @@ -21,6 +21,7 @@ mod tests { #[test_case(Path::new("EXE002_2.py"))] #[test_case(Path::new("EXE002_3.py"))] #[test_case(Path::new("EXE003.py"))] + #[test_case(Path::new("EXE003_uv.py"))] #[test_case(Path::new("EXE004_1.py"))] #[test_case(Path::new("EXE004_2.py"))] #[test_case(Path::new("EXE004_3.py"))] diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/mod.rs index e8947b596d1ad..e9f7c58058148 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/mod.rs @@ -8,10 +8,10 @@ pub(crate) use shebang_missing_python::*; pub(crate) use shebang_not_executable::*; pub(crate) use shebang_not_first_line::*; +use crate::Locator; use crate::codes::Rule; use crate::comments::shebang::ShebangDirective; use crate::settings::LinterSettings; -use crate::Locator; mod shebang_leading_whitespace; mod shebang_missing_executable_file; diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_leading_whitespace.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_leading_whitespace.rs index 9b865f8b5f4aa..df3aea03fde8e 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_leading_whitespace.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_leading_whitespace.rs @@ -2,7 +2,7 @@ use ruff_text_size::{TextRange, TextSize}; use crate::Locator; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::is_python_whitespace; /// ## What it does @@ -29,17 +29,17 @@ use ruff_python_trivia::is_python_whitespace; /// /// ## References /// - [Python documentation: Executable Python Scripts](https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) -#[violation] -pub struct ShebangLeadingWhitespace; +#[derive(ViolationMetadata)] +pub(crate) struct ShebangLeadingWhitespace; impl AlwaysFixableViolation for ShebangLeadingWhitespace { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid whitespace before shebang") + "Avoid whitespace before shebang".to_string() } fn fix_title(&self) -> String { - format!("Remove whitespace before shebang") + "Remove whitespace before shebang".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_executable_file.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_executable_file.rs index 7e78cd269e163..a297541e2b818 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_executable_file.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_executable_file.rs @@ -5,7 +5,7 @@ use std::path::Path; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::registry::AsRule; #[cfg(target_family = "unix")] @@ -27,7 +27,8 @@ use crate::rules::flake8_executable::helpers::is_executable; /// #!/usr/bin/env python /// ``` /// -/// Otherwise, remove the executable bit from the file (e.g., `chmod -x __main__.py`). +/// Otherwise, remove the executable bit from the file +/// (e.g., `chmod -x __main__.py` or `git update-index --chmod=-x __main__.py`). /// /// A file is considered executable if it has the executable bit set (i.e., its /// permissions mode intersects with `0o111`). As such, _this rule is only @@ -35,13 +36,14 @@ use crate::rules::flake8_executable::helpers::is_executable; /// /// ## References /// - [Python documentation: Executable Python Scripts](https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) -#[violation] -pub struct ShebangMissingExecutableFile; +/// - [Git documentation: `git update-index --chmod`](https://git-scm.com/docs/git-update-index#Documentation/git-update-index.txt---chmod-x) +#[derive(ViolationMetadata)] +pub(crate) struct ShebangMissingExecutableFile; impl Violation for ShebangMissingExecutableFile { #[derive_message_formats] fn message(&self) -> String { - format!("The file is executable but no shebang is present") + "The file is executable but no shebang is present".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_python.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_python.rs index b19e69c098c67..137203e0e73e2 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_python.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_missing_python.rs @@ -1,22 +1,22 @@ use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::comments::shebang::ShebangDirective; /// ## What it does -/// Checks for a shebang directive in `.py` files that does not contain `python`. +/// Checks for a shebang directive in `.py` files that does not contain `python`, +/// `pytest`, or `uv run`. /// /// ## Why is this bad? /// In Python, a shebang (also known as a hashbang) is the first line of a -/// script, which specifies the interpreter that should be used to run the +/// script, which specifies the command that should be used to run the /// script. /// -/// For Python scripts, the shebang must contain `python` to indicate that the -/// script should be executed as a Python script. If the shebang does not -/// contain `python`, then the file will be executed with the default -/// interpreter, which is likely a mistake. +/// For Python scripts, if the shebang does not include a command that explicitly +/// or implicitly specifies an interpreter, then the file will be executed with +/// the default interpreter, which is likely a mistake. /// /// ## Example /// ```python @@ -30,13 +30,13 @@ use crate::comments::shebang::ShebangDirective; /// /// ## References /// - [Python documentation: Executable Python Scripts](https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) -#[violation] -pub struct ShebangMissingPython; +#[derive(ViolationMetadata)] +pub(crate) struct ShebangMissingPython; impl Violation for ShebangMissingPython { #[derive_message_formats] fn message(&self) -> String { - format!("Shebang should contain `python`") + "Shebang should contain `python`, `pytest`, or `uv run`".to_string() } } @@ -45,7 +45,7 @@ pub(crate) fn shebang_missing_python( range: TextRange, shebang: &ShebangDirective, ) -> Option<Diagnostic> { - if shebang.contains("python") || shebang.contains("pytest") { + if shebang.contains("python") || shebang.contains("pytest") || shebang.contains("uv run") { return None; } diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_executable.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_executable.rs index 872cc7e64f1a4..14e7268754a6c 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_executable.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_executable.rs @@ -5,7 +5,7 @@ use std::path::Path; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; #[cfg(target_family = "unix")] use crate::rules::flake8_executable::helpers::is_executable; @@ -22,12 +22,10 @@ use crate::rules::flake8_executable::helpers::is_executable; /// executable. If a file contains a shebang but is not executable, then the /// shebang is misleading, or the file is missing the executable bit. /// -/// If the file is meant to be executable, add a shebang, as in: -/// ```python -/// #!/usr/bin/env python -/// ``` +/// If the file is meant to be executable, add the executable bit to the file +/// (e.g., `chmod +x __main__.py` or `git update-index --chmod=+x __main__.py`). /// -/// Otherwise, remove the executable bit from the file (e.g., `chmod -x __main__.py`). +/// Otherwise, remove the shebang. /// /// A file is considered executable if it has the executable bit set (i.e., its /// permissions mode intersects with `0o111`). As such, _this rule is only @@ -40,13 +38,14 @@ use crate::rules::flake8_executable::helpers::is_executable; /// /// ## References /// - [Python documentation: Executable Python Scripts](https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) -#[violation] -pub struct ShebangNotExecutable; +/// - [Git documentation: `git update-index --chmod`](https://git-scm.com/docs/git-update-index#Documentation/git-update-index.txt---chmod-x) +#[derive(ViolationMetadata)] +pub(crate) struct ShebangNotExecutable; impl Violation for ShebangNotExecutable { #[derive_message_formats] fn message(&self) -> String { - format!("Shebang is present but file is not executable") + "Shebang is present but file is not executable".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_first_line.rs b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_first_line.rs index 47f1eba6a6641..0405e0cebe1a9 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_first_line.rs +++ b/crates/ruff_linter/src/rules/flake8_executable/rules/shebang_not_first_line.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::is_python_whitespace; use ruff_text_size::{TextRange, TextSize}; @@ -31,13 +31,13 @@ use crate::Locator; /// /// ## References /// - [Python documentation: Executable Python Scripts](https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) -#[violation] -pub struct ShebangNotFirstLine; +#[derive(ViolationMetadata)] +pub(crate) struct ShebangNotFirstLine; impl Violation for ShebangNotFirstLine { #[derive_message_formats] fn message(&self) -> String { - format!("Shebang should be at the beginning of the file") + "Shebang should be at the beginning of the file".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE001_1.py.snap b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE001_1.py.snap index ba870fb9657b3..3ebc57f8bb34c 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE001_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE001_1.py.snap @@ -5,7 +5,6 @@ EXE001_1.py:1:1: EXE001 Shebang is present but file is not executable | 1 | #!/usr/bin/python | ^^^^^^^^^^^^^^^^^ EXE001 -2 | +2 | 3 | if __name__ == '__main__': | - diff --git a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003.py.snap b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003.py.snap index eb03aeab9e075..d5dab03c6e0fc 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003.py.snap @@ -1,11 +1,9 @@ --- source: crates/ruff_linter/src/rules/flake8_executable/mod.rs --- -EXE003.py:1:1: EXE003 Shebang should contain `python` +EXE003.py:1:1: EXE003 Shebang should contain `python`, `pytest`, or `uv run` | 1 | #!/usr/bin/bash | ^^^^^^^^^^^^^^^ EXE003 2 | print("hello world") | - - diff --git a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003_uv.py.snap b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003_uv.py.snap new file mode 100644 index 0000000000000..26e075ae3eb6e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE003_uv.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_executable/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE004_4.py.snap b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE004_4.py.snap index feff95aa86af5..5cd13ffc0428b 100644 --- a/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE004_4.py.snap +++ b/crates/ruff_linter/src/rules/flake8_executable/snapshots/ruff_linter__rules__flake8_executable__tests__EXE004_4.py.snap @@ -3,7 +3,7 @@ source: crates/ruff_linter/src/rules/flake8_executable/mod.rs --- EXE004_4.py:1:1: EXE004 [*] Avoid whitespace before shebang | -1 | / +1 | / 2 | | #!/usr/bin/env python | |____^ EXE004 | @@ -13,5 +13,3 @@ EXE004_4.py:1:1: EXE004 [*] Avoid whitespace before shebang 1 |- 2 |- #!/usr/bin/env python 1 |+#!/usr/bin/env python - - diff --git a/crates/ruff_linter/src/rules/flake8_fixme/rules/todos.rs b/crates/ruff_linter/src/rules/flake8_fixme/rules/todos.rs index 1f8aa3a60501d..f8515c4c7e5a7 100644 --- a/crates/ruff_linter/src/rules/flake8_fixme/rules/todos.rs +++ b/crates/ruff_linter/src/rules/flake8_fixme/rules/todos.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::directives::{TodoComment, TodoDirectiveKind}; @@ -21,12 +21,12 @@ use crate::directives::{TodoComment, TodoDirectiveKind}; /// def greet(name): /// return f"Hello, {name}!" # TODO: Add support for custom greetings. /// ``` -#[violation] -pub struct LineContainsTodo; +#[derive(ViolationMetadata)] +pub(crate) struct LineContainsTodo; impl Violation for LineContainsTodo { #[derive_message_formats] fn message(&self) -> String { - format!("Line contains TODO, consider resolving the issue") + "Line contains TODO, consider resolving the issue".to_string() } } @@ -47,12 +47,12 @@ impl Violation for LineContainsTodo { /// def speed(distance, time): /// return distance / time # FIXME: Raises ZeroDivisionError for time = 0. /// ``` -#[violation] -pub struct LineContainsFixme; +#[derive(ViolationMetadata)] +pub(crate) struct LineContainsFixme; impl Violation for LineContainsFixme { #[derive_message_formats] fn message(&self) -> String { - format!("Line contains FIXME, consider resolving the issue") + "Line contains FIXME, consider resolving the issue".to_string() } } @@ -70,12 +70,12 @@ impl Violation for LineContainsFixme { /// def speed(distance, time): /// return distance / time # XXX: Raises ZeroDivisionError for time = 0. /// ``` -#[violation] -pub struct LineContainsXxx; +#[derive(ViolationMetadata)] +pub(crate) struct LineContainsXxx; impl Violation for LineContainsXxx { #[derive_message_formats] fn message(&self) -> String { - format!("Line contains XXX, consider resolving the issue") + "Line contains XXX, consider resolving the issue".to_string() } } @@ -105,12 +105,12 @@ impl Violation for LineContainsXxx { /// os.rmdir("C:\\Windows\\System32\\") /// return False /// ``` -#[violation] -pub struct LineContainsHack; +#[derive(ViolationMetadata)] +pub(crate) struct LineContainsHack; impl Violation for LineContainsHack { #[derive_message_formats] fn message(&self) -> String { - format!("Line contains HACK, consider resolving the issue") + "Line contains HACK, consider resolving the issue".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-fixme_T00.py.snap b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-fixme_T00.py.snap index 3d83ddf257b84..a127236782c6c 100644 --- a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-fixme_T00.py.snap +++ b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-fixme_T00.py.snap @@ -16,6 +16,6 @@ T00.py:8:3: FIX001 Line contains FIXME, consider resolving the issue 7 | # FIXME: fixme 8 | # fixme: fixme | ^^^^^ FIX001 - 9 | + 9 | 10 | # test # TODO: todo | diff --git a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-hack_T00.py.snap b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-hack_T00.py.snap index 48be15b4fd536..be827ead174b3 100644 --- a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-hack_T00.py.snap +++ b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-hack_T00.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_fixme/mod.rs +snapshot_kind: text --- T00.py:5:3: FIX004 Line contains HACK, consider resolving the issue | @@ -20,5 +21,3 @@ T00.py:6:3: FIX004 Line contains HACK, consider resolving the issue 7 | # FIXME: fixme 8 | # fixme: fixme | - - diff --git a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-todo_T00.py.snap b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-todo_T00.py.snap index bd9fcc070d8fc..b4477356751ca 100644 --- a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-todo_T00.py.snap +++ b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-todo_T00.py.snap @@ -21,7 +21,7 @@ T00.py:2:3: FIX002 Line contains TODO, consider resolving the issue T00.py:10:10: FIX002 Line contains TODO, consider resolving the issue | 8 | # fixme: fixme - 9 | + 9 | 10 | # test # TODO: todo | ^^^^ FIX002 | diff --git a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-xxx_T00.py.snap b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-xxx_T00.py.snap index 18eb43a49cb5e..d4218aca2700c 100644 --- a/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-xxx_T00.py.snap +++ b/crates/ruff_linter/src/rules/flake8_fixme/snapshots/ruff_linter__rules__flake8_fixme__tests__line-contains-xxx_T00.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_fixme/mod.rs +snapshot_kind: text --- T00.py:3:3: FIX003 Line contains XXX, consider resolving the issue | @@ -20,5 +21,3 @@ T00.py:4:3: FIX003 Line contains XXX, consider resolving the issue 5 | # HACK: hack 6 | # hack: hack | - - diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs b/crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs index d9b7c6bd60969..188c2beefc844 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs @@ -9,9 +9,9 @@ mod tests { use test_case::test_case; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::test::test_path; use crate::{assert_messages, settings}; + use ruff_python_ast::PythonVersion; #[test_case(Path::new("edge_case.py"))] #[test_case(Path::new("from_typing_import.py"))] @@ -30,7 +30,7 @@ mod tests { let diagnostics = test_path( Path::new("flake8_future_annotations").join(path).as_path(), &settings::LinterSettings { - target_version: PythonVersion::Py37, + unresolved_target_version: PythonVersion::PY37.into(), ..settings::LinterSettings::for_rule(Rule::FutureRewritableTypeAnnotation) }, )?; @@ -49,7 +49,7 @@ mod tests { let diagnostics = test_path( Path::new("flake8_future_annotations").join(path).as_path(), &settings::LinterSettings { - target_version: PythonVersion::Py37, + unresolved_target_version: PythonVersion::PY37.into(), ..settings::LinterSettings::for_rule(Rule::FutureRequiredTypeAnnotation) }, )?; diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_required_type_annotation.rs b/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_required_type_annotation.rs index ae39f653c844f..30207f02d7355 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_required_type_annotation.rs +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_required_type_annotation.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_python_semantic::{MemberNameImport, NameImport}; use ruff_text_size::{Ranged, TextSize}; @@ -49,8 +49,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `target-version` -#[violation] -pub struct FutureRequiredTypeAnnotation { +#[derive(ViolationMetadata)] +pub(crate) struct FutureRequiredTypeAnnotation { reason: Reason, } @@ -79,12 +79,12 @@ impl AlwaysFixableViolation for FutureRequiredTypeAnnotation { } fn fix_title(&self) -> String { - format!("Add `from __future__ import annotations`") + "Add `from __future__ import annotations`".to_string() } } /// FA102 -pub(crate) fn future_required_type_annotation(checker: &mut Checker, expr: &Expr, reason: Reason) { +pub(crate) fn future_required_type_annotation(checker: &Checker, expr: &Expr, reason: Reason) { let mut diagnostic = Diagnostic::new(FutureRequiredTypeAnnotation { reason }, expr.range()); let required_import = NameImport::ImportFrom(MemberNameImport::member( "__future__".to_string(), @@ -95,5 +95,5 @@ pub(crate) fn future_required_type_annotation(checker: &mut Checker, expr: &Expr .importer() .add_import(&required_import, TextSize::default()), )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_rewritable_type_annotation.rs b/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_rewritable_type_annotation.rs index c6e4b2bf96ac8..654ed1acd5b01 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_rewritable_type_annotation.rs +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/rules/future_rewritable_type_annotation.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -63,8 +63,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `target-version` -#[violation] -pub struct FutureRewritableTypeAnnotation { +#[derive(ViolationMetadata)] +pub(crate) struct FutureRewritableTypeAnnotation { name: String, } @@ -77,14 +77,14 @@ impl Violation for FutureRewritableTypeAnnotation { } /// FA100 -pub(crate) fn future_rewritable_type_annotation(checker: &mut Checker, expr: &Expr) { +pub(crate) fn future_rewritable_type_annotation(checker: &Checker, expr: &Expr) { let name = checker .semantic() .resolve_qualified_name(expr) .map(|binding| binding.to_string()); if let Some(name) = name { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( FutureRewritableTypeAnnotation { name }, expr.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__edge_case.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__edge_case.py.snap index 34091b62e6a5c..c3e38a6517da5 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__edge_case.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__edge_case.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- edge_case.py:5:13: FA100 Add `from __future__ import annotations` to simplify `typing.List` | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_lowercase.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_lowercase.py.snap index e9c8efa698a8f..9db68140a4afd 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_lowercase.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_lowercase.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- no_future_import_uses_lowercase.py:6:14: FA102 [*] Missing `from __future__ import annotations`, but uses PEP 585 collection | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union.py.snap index 3631ff04335a3..4f8b2b5dd2d7f 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- no_future_import_uses_union.py:6:14: FA102 [*] Missing `from __future__ import annotations`, but uses PEP 585 collection | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union_inner.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union_inner.py.snap index 2f2e6dbb0375a..bd011e0327aba 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union_inner.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_no_future_import_uses_union_inner.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- no_future_import_uses_union_inner.py:6:14: FA102 [*] Missing `from __future__ import annotations`, but uses PEP 585 collection | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_no_types.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_no_types.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_no_types.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_no_types.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_quoted_type.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_quoted_type.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_quoted_type.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_quoted_type.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_uses_future.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_uses_future.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_uses_future.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__fa102_ok_uses_future.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import.py.snap index 60159406cabcc..d15966d4d210f 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- from_typing_import.py:5:13: FA100 Add `from __future__ import annotations` to simplify `typing.List` | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import_many.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import_many.py.snap index 0ec50bc40a1a8..e3426dc72048a 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import_many.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__from_typing_import_many.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- from_typing_import_many.py:5:13: FA100 Add `from __future__ import annotations` to simplify `typing.List` | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing.py.snap index 328908cfb232c..afa5c4aa522fa 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- import_typing.py:5:13: FA100 Add `from __future__ import annotations` to simplify `typing.List` | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing_as.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing_as.py.snap index 05eb2c2a8b4ba..d2ec4a38fd5b1 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing_as.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__import_typing_as.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- import_typing_as.py:5:13: FA100 Add `from __future__ import annotations` to simplify `typing.List` | diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_lowercase.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_lowercase.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_lowercase.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_lowercase.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union_inner.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union_inner.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union_inner.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__no_future_import_uses_union_inner.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_no_types.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_no_types.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_no_types.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_no_types.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_non_simplifiable_types.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_non_simplifiable_types.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_non_simplifiable_types.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_non_simplifiable_types.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_uses_future.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_uses_future.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_uses_future.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_uses_future.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_variable_name.py.snap b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_variable_name.py.snap index 0e51cf4a6fa77..98e748990e640 100644 --- a/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_variable_name.py.snap +++ b/crates/ruff_linter/src/rules/flake8_future_annotations/snapshots/ruff_linter__rules__flake8_future_annotations__tests__ok_variable_name.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_future_annotations/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_gettext/rules/f_string_in_gettext_func_call.rs b/crates/ruff_linter/src/rules/flake8_gettext/rules/f_string_in_gettext_func_call.rs index b61e15b96d0e0..f9cbac5cabcdf 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/rules/f_string_in_gettext_func_call.rs +++ b/crates/ruff_linter/src/rules/flake8_gettext/rules/f_string_in_gettext_func_call.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -39,24 +39,22 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [Python documentation: gettext](https://docs.python.org/3/library/gettext.html) -#[violation] -pub struct FStringInGetTextFuncCall; +/// - [Python documentation: `gettext` — Multilingual internationalization services](https://docs.python.org/3/library/gettext.html) +#[derive(ViolationMetadata)] +pub(crate) struct FStringInGetTextFuncCall; impl Violation for FStringInGetTextFuncCall { #[derive_message_formats] fn message(&self) -> String { - format!("f-string is resolved before function call; consider `_(\"string %s\") % arg`") + "f-string is resolved before function call; consider `_(\"string %s\") % arg`".to_string() } } /// INT001 -pub(crate) fn f_string_in_gettext_func_call(checker: &mut Checker, args: &[Expr]) { +pub(crate) fn f_string_in_gettext_func_call(checker: &Checker, args: &[Expr]) { if let Some(first) = args.first() { if first.is_f_string_expr() { - checker - .diagnostics - .push(Diagnostic::new(FStringInGetTextFuncCall {}, first.range())); + checker.report_diagnostic(Diagnostic::new(FStringInGetTextFuncCall {}, first.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_gettext/rules/format_in_gettext_func_call.rs b/crates/ruff_linter/src/rules/flake8_gettext/rules/format_in_gettext_func_call.rs index 33f29c3b294d3..818d54e027d1e 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/rules/format_in_gettext_func_call.rs +++ b/crates/ruff_linter/src/rules/flake8_gettext/rules/format_in_gettext_func_call.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -27,7 +27,7 @@ use crate::checkers::ast::Checker; /// from gettext import gettext as _ /// /// name = "Maria" -/// _("Hello, %s!" % name) # Looks for "Hello, Maria!". +/// _("Hello, {}!".format(name)) # Looks for "Hello, Maria!". /// ``` /// /// Use instead: @@ -39,26 +39,27 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [Python documentation: gettext](https://docs.python.org/3/library/gettext.html) -#[violation] -pub struct FormatInGetTextFuncCall; +/// - [Python documentation: `gettext` — Multilingual internationalization services](https://docs.python.org/3/library/gettext.html) +#[derive(ViolationMetadata)] +pub(crate) struct FormatInGetTextFuncCall; impl Violation for FormatInGetTextFuncCall { #[derive_message_formats] fn message(&self) -> String { - format!("`format` method argument is resolved before function call; consider `_(\"string %s\") % arg`") + "`format` method argument is resolved before function call; consider `_(\"string %s\") % arg`".to_string() } } /// INT002 -pub(crate) fn format_in_gettext_func_call(checker: &mut Checker, args: &[Expr]) { +pub(crate) fn format_in_gettext_func_call(checker: &Checker, args: &[Expr]) { if let Some(first) = args.first() { if let Expr::Call(ast::ExprCall { func, .. }) = &first { if let Expr::Attribute(ast::ExprAttribute { attr, .. }) = func.as_ref() { if attr == "format" { - checker - .diagnostics - .push(Diagnostic::new(FormatInGetTextFuncCall {}, first.range())); + checker.report_diagnostic(Diagnostic::new( + FormatInGetTextFuncCall {}, + first.range(), + )); } } } diff --git a/crates/ruff_linter/src/rules/flake8_gettext/rules/printf_in_gettext_func_call.rs b/crates/ruff_linter/src/rules/flake8_gettext/rules/printf_in_gettext_func_call.rs index 334aef836bee7..993f9a7cbee1f 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/rules/printf_in_gettext_func_call.rs +++ b/crates/ruff_linter/src/rules/flake8_gettext/rules/printf_in_gettext_func_call.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Expr, Operator}; use crate::checkers::ast::Checker; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -26,7 +26,7 @@ use ruff_text_size::Ranged; /// from gettext import gettext as _ /// /// name = "Maria" -/// _("Hello, {}!".format(name)) # Looks for "Hello, Maria!". +/// _("Hello, %s!" % name) # Looks for "Hello, Maria!". /// ``` /// /// Use instead: @@ -38,30 +38,30 @@ use ruff_text_size::Ranged; /// ``` /// /// ## References -/// - [Python documentation: gettext](https://docs.python.org/3/library/gettext.html) -#[violation] -pub struct PrintfInGetTextFuncCall; +/// - [Python documentation: `gettext` — Multilingual internationalization services](https://docs.python.org/3/library/gettext.html) +#[derive(ViolationMetadata)] +pub(crate) struct PrintfInGetTextFuncCall; impl Violation for PrintfInGetTextFuncCall { #[derive_message_formats] fn message(&self) -> String { - format!("printf-style format is resolved before function call; consider `_(\"string %s\") % arg`") + "printf-style format is resolved before function call; consider `_(\"string %s\") % arg`" + .to_string() } } /// INT003 -pub(crate) fn printf_in_gettext_func_call(checker: &mut Checker, args: &[Expr]) { +pub(crate) fn printf_in_gettext_func_call(checker: &Checker, args: &[Expr]) { if let Some(first) = args.first() { if let Expr::BinOp(ast::ExprBinOp { - op: Operator::Mod { .. }, + op: Operator::Mod, left, .. }) = &first { if left.is_string_literal_expr() { checker - .diagnostics - .push(Diagnostic::new(PrintfInGetTextFuncCall {}, first.range())); + .report_diagnostic(Diagnostic::new(PrintfInGetTextFuncCall {}, first.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__f-string-in-get-text-func-call_INT001.py.snap b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__f-string-in-get-text-func-call_INT001.py.snap index 6c37750fc8548..90495ebbade21 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__f-string-in-get-text-func-call_INT001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__f-string-in-get-text-func-call_INT001.py.snap @@ -1,10 +1,9 @@ --- source: crates/ruff_linter/src/rules/flake8_gettext/mod.rs +snapshot_kind: text --- INT001.py:1:3: INT001 f-string is resolved before function call; consider `_("string %s") % arg` | 1 | _(f"{'value'}") | ^^^^^^^^^^^^ INT001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__format-in-get-text-func-call_INT002.py.snap b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__format-in-get-text-func-call_INT002.py.snap index 6f37b92e293eb..99e0cc7e469e2 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__format-in-get-text-func-call_INT002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__format-in-get-text-func-call_INT002.py.snap @@ -1,10 +1,9 @@ --- source: crates/ruff_linter/src/rules/flake8_gettext/mod.rs +snapshot_kind: text --- INT002.py:1:3: INT002 `format` method argument is resolved before function call; consider `_("string %s") % arg` | 1 | _("{}".format("line")) | ^^^^^^^^^^^^^^^^^^^ INT002 | - - diff --git a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__printf-in-get-text-func-call_INT003.py.snap b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__printf-in-get-text-func-call_INT003.py.snap index 789401f897693..69a768d94314a 100644 --- a/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__printf-in-get-text-func-call_INT003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_gettext/snapshots/ruff_linter__rules__flake8_gettext__tests__printf-in-get-text-func-call_INT003.py.snap @@ -1,10 +1,9 @@ --- source: crates/ruff_linter/src/rules/flake8_gettext/mod.rs +snapshot_kind: text --- INT003.py:1:3: INT003 printf-style format is resolved before function call; consider `_("string %s") % arg` | 1 | _("%s" % "line") | ^^^^^^^^^^^^^ INT003 | - - diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/explicit.rs b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/explicit.rs index fbc169131e7fc..18690266cd1d6 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/explicit.rs +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/explicit.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Operator}; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; -use crate::settings::LinterSettings; use crate::Locator; +use crate::settings::LinterSettings; /// ## What it does /// Checks for string literals that are explicitly concatenated (using the @@ -31,13 +31,13 @@ use crate::Locator; /// "dog" /// ) /// ``` -#[violation] -pub struct ExplicitStringConcatenation; +#[derive(ViolationMetadata)] +pub(crate) struct ExplicitStringConcatenation; impl Violation for ExplicitStringConcatenation { #[derive_message_formats] fn message(&self) -> String { - format!("Explicitly concatenated string should be implicitly concatenated") + "Explicitly concatenated string should be implicitly concatenated".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/implicit.rs b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/implicit.rs index b3a88e538f661..004ffb9537d8d 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/implicit.rs +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/rules/implicit.rs @@ -3,15 +3,15 @@ use std::borrow::Cow; use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::str::{leading_quote, trailing_quote}; use ruff_python_index::Indexer; use ruff_python_parser::{TokenKind, Tokens}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; -use crate::settings::LinterSettings; use crate::Locator; +use crate::settings::LinterSettings; /// ## What it does /// Checks for implicitly concatenated strings on a single line. @@ -34,15 +34,15 @@ use crate::Locator; /// ```python /// z = "The quick brown fox." /// ``` -#[violation] -pub struct SingleLineImplicitStringConcatenation; +#[derive(ViolationMetadata)] +pub(crate) struct SingleLineImplicitStringConcatenation; impl Violation for SingleLineImplicitStringConcatenation { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Implicitly concatenated string literals on one line") + "Implicitly concatenated string literals on one line".to_string() } fn fix_title(&self) -> Option<String> { @@ -81,14 +81,23 @@ impl Violation for SingleLineImplicitStringConcatenation { /// ## Options /// - `lint.flake8-implicit-str-concat.allow-multiline` /// +/// ## Formatter compatibility +/// Using this rule with `allow-multiline = false` can be incompatible with the +/// formatter because the [formatter] can introduce new multi-line implicitly +/// concatenated strings. We recommend to either: +/// +/// * Enable `ISC001` to disallow all implicit concatenated strings +/// * Setting `allow-multiline = true` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length -#[violation] -pub struct MultiLineImplicitStringConcatenation; +/// [formatter]:https://docs.astral.sh/ruff/formatter/ +#[derive(ViolationMetadata)] +pub(crate) struct MultiLineImplicitStringConcatenation; impl Violation for MultiLineImplicitStringConcatenation { #[derive_message_formats] fn message(&self) -> String { - format!("Implicitly concatenated string literals over multiple lines") + "Implicitly concatenated string literals over multiple lines".to_string() } } @@ -151,7 +160,7 @@ pub(crate) fn implicit( } diagnostics.push(diagnostic); - }; + } } } diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC.py.snap index a168e4b85602f..73d16d6ebd2b2 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC.py.snap @@ -5,7 +5,7 @@ ISC.py:1:5: ISC001 [*] Implicitly concatenated string literals on one line | 1 | _ = "a" "b" "c" | ^^^^^^^ ISC001 -2 | +2 | 3 | _ = "abc" + "def" | = help: Combine string literals @@ -21,7 +21,7 @@ ISC.py:1:9: ISC001 [*] Implicitly concatenated string literals on one line | 1 | _ = "a" "b" "c" | ^^^^^^^ ISC001 -2 | +2 | 3 | _ = "abc" + "def" | = help: Combine string literals @@ -36,10 +36,10 @@ ISC.py:1:9: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:38:5: ISC001 [*] Implicitly concatenated string literals on one line | 36 | ) -37 | +37 | 38 | _ = """a""" """b""" | ^^^^^^^^^^^^^^^ ISC001 -39 | +39 | 40 | _ = """a | = help: Combine string literals @@ -57,13 +57,13 @@ ISC.py:38:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:40:5: ISC001 [*] Implicitly concatenated string literals on one line | 38 | _ = """a""" """b""" -39 | +39 | 40 | _ = """a | _____^ 41 | | b""" """c 42 | | d""" | |____^ ISC001 -43 | +43 | 44 | _ = f"""a""" f"""b""" | = help: Combine string literals @@ -81,10 +81,10 @@ ISC.py:40:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:44:5: ISC001 [*] Implicitly concatenated string literals on one line | 42 | d""" -43 | +43 | 44 | _ = f"""a""" f"""b""" | ^^^^^^^^^^^^^^^^^ ISC001 -45 | +45 | 46 | _ = f"a" "b" | = help: Combine string literals @@ -102,10 +102,10 @@ ISC.py:44:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:46:5: ISC001 Implicitly concatenated string literals on one line | 44 | _ = f"""a""" f"""b""" -45 | +45 | 46 | _ = f"a" "b" | ^^^^^^^^ ISC001 -47 | +47 | 48 | _ = """a""" "b" | = help: Combine string literals @@ -113,10 +113,10 @@ ISC.py:46:5: ISC001 Implicitly concatenated string literals on one line ISC.py:48:5: ISC001 Implicitly concatenated string literals on one line | 46 | _ = f"a" "b" -47 | +47 | 48 | _ = """a""" "b" | ^^^^^^^^^^^ ISC001 -49 | +49 | 50 | _ = 'a' "b" | = help: Combine string literals @@ -124,10 +124,10 @@ ISC.py:48:5: ISC001 Implicitly concatenated string literals on one line ISC.py:50:5: ISC001 Implicitly concatenated string literals on one line | 48 | _ = """a""" "b" -49 | +49 | 50 | _ = 'a' "b" | ^^^^^^^ ISC001 -51 | +51 | 52 | _ = rf"a" rf"b" | = help: Combine string literals @@ -135,10 +135,10 @@ ISC.py:50:5: ISC001 Implicitly concatenated string literals on one line ISC.py:52:5: ISC001 [*] Implicitly concatenated string literals on one line | 50 | _ = 'a' "b" -51 | +51 | 52 | _ = rf"a" rf"b" | ^^^^^^^^^^^ ISC001 -53 | +53 | 54 | # Single-line explicit concatenation should be ignored. | = help: Combine string literals diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC_syntax_error.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC_syntax_error.py.snap index 01fb083645e7b..a14e63a629ca2 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC001_ISC_syntax_error.py.snap @@ -58,7 +58,7 @@ ISC_syntax_error.py:4:1: ISC001 Implicitly concatenated string literals on one l 4 | / "a" """b 5 | | c""" "d | |____^ ISC001 -6 | +6 | 7 | # For f-strings, the `FStringRanges` won't contain the range for | = help: Combine string literals @@ -69,7 +69,7 @@ ISC_syntax_error.py:5:6: SyntaxError: missing closing quote in string literal 4 | "a" """b 5 | c""" "d | ^ -6 | +6 | 7 | # For f-strings, the `FStringRanges` won't contain the range for | @@ -79,7 +79,7 @@ ISC_syntax_error.py:5:8: SyntaxError: Expected a statement 4 | "a" """b 5 | c""" "d | ^ -6 | +6 | 7 | # For f-strings, the `FStringRanges` won't contain the range for 8 | # unterminated f-strings. | @@ -143,7 +143,7 @@ ISC_syntax_error.py:11:1: ISC001 Implicitly concatenated string literals on one 11 | / f"a" f"""b 12 | | c""" f"d {e | |____^ ISC001 -13 | +13 | 14 | ( | = help: Combine string literals @@ -172,10 +172,12 @@ ISC_syntax_error.py:30:1: SyntaxError: unexpected EOF while parsing | 28 | "i" "j" 29 | ) + | ^ | ISC_syntax_error.py:30:1: SyntaxError: f-string: unterminated string | 28 | "i" "j" 29 | ) + | ^ | diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC.py.snap index 8daa1c7e219de..42e5ca2717d6c 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC.py.snap @@ -4,12 +4,12 @@ source: crates/ruff_linter/src/rules/flake8_implicit_str_concat/mod.rs ISC.py:5:5: ISC002 Implicitly concatenated string literals over multiple lines | 3 | _ = "abc" + "def" -4 | +4 | 5 | _ = "abc" \ | _____^ 6 | | "def" | |_________^ ISC002 -7 | +7 | 8 | _ = ( | @@ -21,8 +21,6 @@ ISC.py:74:10: ISC002 Implicitly concatenated string literals over multiple lines | __________^ 75 | | f"def"} g" | |__________^ ISC002 -76 | +76 | 77 | # Explicitly concatenated nested f-strings | - - diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC_syntax_error.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC_syntax_error.py.snap index c09ec34c0f08e..46d99bae675e8 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC002_ISC_syntax_error.py.snap @@ -46,7 +46,7 @@ ISC_syntax_error.py:5:6: SyntaxError: missing closing quote in string literal 4 | "a" """b 5 | c""" "d | ^ -6 | +6 | 7 | # For f-strings, the `FStringRanges` won't contain the range for | @@ -56,7 +56,7 @@ ISC_syntax_error.py:5:8: SyntaxError: Expected a statement 4 | "a" """b 5 | c""" "d | ^ -6 | +6 | 7 | # For f-strings, the `FStringRanges` won't contain the range for 8 | # unterminated f-strings. | @@ -126,10 +126,12 @@ ISC_syntax_error.py:30:1: SyntaxError: unexpected EOF while parsing | 28 | "i" "j" 29 | ) + | ^ | ISC_syntax_error.py:30:1: SyntaxError: f-string: unterminated string | 28 | "i" "j" 29 | ) + | ^ | diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC003_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC003_ISC.py.snap index ced4db0533a40..dccaf146a2f4f 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC003_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__ISC003_ISC.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_implicit_str_concat/mod.rs ISC.py:9:3: ISC003 Explicitly concatenated string should be implicitly concatenated | 8 | _ = ( - 9 | "abc" + - | ___^ + 9 | / "abc" + 10 | | "def" | |_______^ ISC003 11 | ) @@ -14,8 +13,7 @@ ISC.py:9:3: ISC003 Explicitly concatenated string should be implicitly concatena ISC.py:14:3: ISC003 Explicitly concatenated string should be implicitly concatenated | 13 | _ = ( -14 | f"abc" + - | ___^ +14 | / f"abc" + 15 | | "def" | |_______^ ISC003 16 | ) @@ -24,8 +22,7 @@ ISC.py:14:3: ISC003 Explicitly concatenated string should be implicitly concaten ISC.py:19:3: ISC003 Explicitly concatenated string should be implicitly concatenated | 18 | _ = ( -19 | b"abc" + - | ___^ +19 | / b"abc" + 20 | | b"def" | |________^ ISC003 21 | ) @@ -50,6 +47,6 @@ ISC.py:80:10: ISC003 Explicitly concatenated string should be implicitly concate | __________^ 81 | | + f"second"} d" | |_______________^ ISC003 -82 | +82 | 83 | # See https://github.com/astral-sh/ruff/issues/12936 | diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC001_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC001_ISC.py.snap index a168e4b85602f..73d16d6ebd2b2 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC001_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC001_ISC.py.snap @@ -5,7 +5,7 @@ ISC.py:1:5: ISC001 [*] Implicitly concatenated string literals on one line | 1 | _ = "a" "b" "c" | ^^^^^^^ ISC001 -2 | +2 | 3 | _ = "abc" + "def" | = help: Combine string literals @@ -21,7 +21,7 @@ ISC.py:1:9: ISC001 [*] Implicitly concatenated string literals on one line | 1 | _ = "a" "b" "c" | ^^^^^^^ ISC001 -2 | +2 | 3 | _ = "abc" + "def" | = help: Combine string literals @@ -36,10 +36,10 @@ ISC.py:1:9: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:38:5: ISC001 [*] Implicitly concatenated string literals on one line | 36 | ) -37 | +37 | 38 | _ = """a""" """b""" | ^^^^^^^^^^^^^^^ ISC001 -39 | +39 | 40 | _ = """a | = help: Combine string literals @@ -57,13 +57,13 @@ ISC.py:38:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:40:5: ISC001 [*] Implicitly concatenated string literals on one line | 38 | _ = """a""" """b""" -39 | +39 | 40 | _ = """a | _____^ 41 | | b""" """c 42 | | d""" | |____^ ISC001 -43 | +43 | 44 | _ = f"""a""" f"""b""" | = help: Combine string literals @@ -81,10 +81,10 @@ ISC.py:40:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:44:5: ISC001 [*] Implicitly concatenated string literals on one line | 42 | d""" -43 | +43 | 44 | _ = f"""a""" f"""b""" | ^^^^^^^^^^^^^^^^^ ISC001 -45 | +45 | 46 | _ = f"a" "b" | = help: Combine string literals @@ -102,10 +102,10 @@ ISC.py:44:5: ISC001 [*] Implicitly concatenated string literals on one line ISC.py:46:5: ISC001 Implicitly concatenated string literals on one line | 44 | _ = f"""a""" f"""b""" -45 | +45 | 46 | _ = f"a" "b" | ^^^^^^^^ ISC001 -47 | +47 | 48 | _ = """a""" "b" | = help: Combine string literals @@ -113,10 +113,10 @@ ISC.py:46:5: ISC001 Implicitly concatenated string literals on one line ISC.py:48:5: ISC001 Implicitly concatenated string literals on one line | 46 | _ = f"a" "b" -47 | +47 | 48 | _ = """a""" "b" | ^^^^^^^^^^^ ISC001 -49 | +49 | 50 | _ = 'a' "b" | = help: Combine string literals @@ -124,10 +124,10 @@ ISC.py:48:5: ISC001 Implicitly concatenated string literals on one line ISC.py:50:5: ISC001 Implicitly concatenated string literals on one line | 48 | _ = """a""" "b" -49 | +49 | 50 | _ = 'a' "b" | ^^^^^^^ ISC001 -51 | +51 | 52 | _ = rf"a" rf"b" | = help: Combine string literals @@ -135,10 +135,10 @@ ISC.py:50:5: ISC001 Implicitly concatenated string literals on one line ISC.py:52:5: ISC001 [*] Implicitly concatenated string literals on one line | 50 | _ = 'a' "b" -51 | +51 | 52 | _ = rf"a" rf"b" | ^^^^^^^^^^^ ISC001 -53 | +53 | 54 | # Single-line explicit concatenation should be ignored. | = help: Combine string literals diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC002_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC002_ISC.py.snap index 54dfbdc2e33dc..a468ebd279a16 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC002_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC002_ISC.py.snap @@ -4,20 +4,19 @@ source: crates/ruff_linter/src/rules/flake8_implicit_str_concat/mod.rs ISC.py:5:5: ISC002 Implicitly concatenated string literals over multiple lines | 3 | _ = "abc" + "def" -4 | +4 | 5 | _ = "abc" \ | _____^ 6 | | "def" | |_________^ ISC002 -7 | +7 | 8 | _ = ( | ISC.py:24:3: ISC002 Implicitly concatenated string literals over multiple lines | 23 | _ = ( -24 | "abc" - | ___^ +24 | / "abc" 25 | | "def" | |_______^ ISC002 26 | ) @@ -26,8 +25,7 @@ ISC.py:24:3: ISC002 Implicitly concatenated string literals over multiple lines ISC.py:29:3: ISC002 Implicitly concatenated string literals over multiple lines | 28 | _ = ( -29 | f"abc" - | ___^ +29 | / f"abc" 30 | | "def" | |_______^ ISC002 31 | ) @@ -36,8 +34,7 @@ ISC.py:29:3: ISC002 Implicitly concatenated string literals over multiple lines ISC.py:34:3: ISC002 Implicitly concatenated string literals over multiple lines | 33 | _ = ( -34 | b"abc" - | ___^ +34 | / b"abc" 35 | | b"def" | |________^ ISC002 36 | ) @@ -47,8 +44,7 @@ ISC.py:67:5: ISC002 Implicitly concatenated string literals over multiple lines | 65 | _ = f"""abc {"def" "ghi"} jkl""" 66 | _ = f"""abc { -67 | "def" - | _____^ +67 | / "def" 68 | | "ghi" | |_________^ ISC002 69 | } jkl""" @@ -62,8 +58,6 @@ ISC.py:74:10: ISC002 Implicitly concatenated string literals over multiple lines | __________^ 75 | | f"def"} g" | |__________^ ISC002 -76 | +76 | 77 | # Explicitly concatenated nested f-strings | - - diff --git a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC003_ISC.py.snap b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC003_ISC.py.snap index 1858d1d7e1447..bfac2e63a3e93 100644 --- a/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC003_ISC.py.snap +++ b/crates/ruff_linter/src/rules/flake8_implicit_str_concat/snapshots/ruff_linter__rules__flake8_implicit_str_concat__tests__multiline_ISC003_ISC.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_implicit_str_concat/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs index de5d8a89155a8..54e2efcef9d08 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs @@ -11,7 +11,7 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::rules::flake8_import_conventions::settings::{default_aliases, BannedAliases}; + use crate::rules::flake8_import_conventions::settings::{BannedAliases, default_aliases}; use crate::settings::LinterSettings; use crate::test::test_path; diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs index 071736ac3cbae..d0a9039a14095 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs @@ -1,7 +1,7 @@ use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; use ruff_text_size::Ranged; @@ -32,8 +32,8 @@ use crate::rules::flake8_import_conventions::settings::BannedAliases; /// /// ## Options /// - `lint.flake8-import-conventions.banned-aliases` -#[violation] -pub struct BannedImportAlias { +#[derive(ViolationMetadata)] +pub(crate) struct BannedImportAlias { name: String, asname: String, } diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs index 7cbeae6f831f8..afbfc8df4936c 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_from.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Stmt; use rustc_hash::FxHashSet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -31,8 +31,8 @@ use ruff_text_size::Ranged; /// /// ## Options /// - `lint.flake8-import-conventions.banned-from` -#[violation] -pub struct BannedImportFrom { +#[derive(ViolationMetadata)] +pub(crate) struct BannedImportFrom { name: String, } diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs index 2ebe87f48d586..815582df8fa1c 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/rules/unconventional_import_alias.rs @@ -1,7 +1,7 @@ use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::{Binding, Imported}; use ruff_text_size::Ranged; @@ -34,8 +34,8 @@ use crate::renamer::Renamer; /// ## Options /// - `lint.flake8-import-conventions.aliases` /// - `lint.flake8-import-conventions.extend-aliases` -#[violation] -pub struct UnconventionalImportAlias { +#[derive(ViolationMetadata)] +pub(crate) struct UnconventionalImportAlias { name: String, asname: String, } diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs b/crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs index 1692107a13f01..f00406de4a181 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs @@ -15,6 +15,7 @@ const CONVENTIONAL_ALIASES: &[(&str, &str)] = &[ ("matplotlib.pyplot", "plt"), ("networkx", "nx"), ("numpy", "np"), + ("numpy.typing", "npt"), ("pandas", "pd"), ("seaborn", "sns"), ("tensorflow", "tf"), diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom.snap index 5a34324fe70c8..bae5ffd77ecbe 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs custom.py:3:8: ICN001 `altair` should be imported as `alt` | 1 | import math # not checked -2 | +2 | 3 | import altair # unconventional | ^^^^^^ ICN001 4 | import dask.array # unconventional @@ -148,7 +148,7 @@ custom.py:16:8: ICN001 `pyarrow` should be imported as `pa` 15 | import polars # unconventional 16 | import pyarrow # unconventional | ^^^^^^^ ICN001 -17 | +17 | 18 | import altair as altr # unconventional | = help: Alias `pyarrow` to `pa` @@ -156,7 +156,7 @@ custom.py:16:8: ICN001 `pyarrow` should be imported as `pa` custom.py:18:18: ICN001 `altair` should be imported as `alt` | 16 | import pyarrow # unconventional -17 | +17 | 18 | import altair as altr # unconventional | ^^^^ ICN001 19 | import matplotlib.pyplot as plot # unconventional @@ -300,9 +300,27 @@ custom.py:31:19: ICN001 `pyarrow` should be imported as `pa` 30 | import polars as ps # unconventional 31 | import pyarrow as arr # unconventional | ^^^ ICN001 -32 | +32 | 33 | import altair as alt # conventional | = help: Alias `pyarrow` to `pa` +custom.py:50:8: ICN001 `numpy.typing` should be imported as `npt` + | +48 | from tensorflow.keras import Model # conventional +49 | +50 | import numpy.typing # unconventional + | ^^^^^^^^^^^^ ICN001 +51 | import numpy.typing as nt # unconventional +52 | import numpy.typing as npt # conventional + | + = help: Alias `numpy.typing` to `npt` +custom.py:51:24: ICN001 `numpy.typing` should be imported as `npt` + | +50 | import numpy.typing # unconventional +51 | import numpy.typing as nt # unconventional + | ^^ ICN001 +52 | import numpy.typing as npt # conventional + | + = help: Alias `numpy.typing` to `npt` diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned.snap index f0d5ae061ba99..7559c7044092f 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned.snap @@ -13,14 +13,14 @@ custom_banned.py:2:1: ICN002 `typing` should not be imported as `ty` 1 | import typing as t # banned 2 | import typing as ty # banned | ^^^^^^^^^^^^^^^^^^^ ICN002 -3 | +3 | 4 | import numpy as nmp # banned | custom_banned.py:4:1: ICN002 `numpy` should not be imported as `nmp` | 2 | import typing as ty # banned -3 | +3 | 4 | import numpy as nmp # banned | ^^^^^^^^^^^^^^^^^^^ ICN002 5 | import numpy as npy # banned @@ -71,8 +71,6 @@ custom_banned.py:9:1: ICN002 `torch.nn.functional` should not be imported as `F` 8 | from tensorflow.keras import backend as K # banned 9 | from torch.nn import functional as F # banned | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ICN002 -10 | +10 | 11 | from typing import Any # ok | - - diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned_from.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned_from.snap index 529369a42d4dc..f40db3b4c088f 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned_from.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom_banned_from.snap @@ -23,14 +23,14 @@ custom_banned_from.py:3:1: ICN003 Members of `typing` should not be imported exp 2 | from typing import Any, Dict # banned 3 | from typing import * # banned | ^^^^^^^^^^^^^^^^^^^^ ICN003 -4 | +4 | 5 | from pandas import DataFrame # banned | custom_banned_from.py:5:1: ICN003 Members of `pandas` should not be imported explicitly | 3 | from typing import * # banned -4 | +4 | 5 | from pandas import DataFrame # banned | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ICN003 6 | from pandas import * # banned @@ -41,8 +41,6 @@ custom_banned_from.py:6:1: ICN003 Members of `pandas` should not be imported exp 5 | from pandas import DataFrame # banned 6 | from pandas import * # banned | ^^^^^^^^^^^^^^^^^^^^ ICN003 -7 | +7 | 8 | import logging.config # ok | - - diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__defaults.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__defaults.snap index d3f4b0a501404..ee7582135f1a3 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__defaults.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__defaults.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs +snapshot_kind: text --- defaults.py:6:12: ICN001 [*] `altair` should be imported as `alt` | diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__from_imports.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__from_imports.snap index 37d2bed52d000..3cafb07489aba 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__from_imports.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__from_imports.snap @@ -83,9 +83,7 @@ from_imports.py:10:57: ICN001 `xml.dom.minidom.parseString` should be imported a 9 | from xml.dom.minidom import parse, parseString 10 | from xml.dom.minidom import parse as ps, parseString as wrong | ^^^^^ ICN001 -11 | +11 | 12 | # No ICN001 violations | = help: Alias `xml.dom.minidom.parseString` to `pstr` - - diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__override_defaults.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__override_defaults.snap index 1b81f2b87d4f4..16911e7f221fa 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__override_defaults.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__override_defaults.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs override_default.py:3:8: ICN001 `altair` should be imported as `alt` | 1 | import math # not checked -2 | +2 | 3 | import altair # unconventional | ^^^^^^ ICN001 4 | import matplotlib.pyplot # unconventional @@ -49,7 +49,7 @@ override_default.py:7:8: ICN001 `seaborn` should be imported as `sns` 6 | import pandas # unconventional 7 | import seaborn # unconventional | ^^^^^^^ ICN001 -8 | +8 | 9 | import altair as altr # unconventional | = help: Alias `seaborn` to `sns` @@ -57,7 +57,7 @@ override_default.py:7:8: ICN001 `seaborn` should be imported as `sns` override_default.py:9:18: ICN001 `altair` should be imported as `alt` | 7 | import seaborn # unconventional - 8 | + 8 | 9 | import altair as altr # unconventional | ^^^^ ICN001 10 | import matplotlib.pyplot as plot # unconventional @@ -102,9 +102,7 @@ override_default.py:13:19: ICN001 `seaborn` should be imported as `sns` 12 | import pandas as pdas # unconventional 13 | import seaborn as sbrn # unconventional | ^^^^ ICN001 -14 | +14 | 15 | import altair as alt # conventional | = help: Alias `seaborn` to `sns` - - diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__remove_defaults.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__remove_defaults.snap index 2af1097a2e4ed..daf24699fc9e7 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__remove_defaults.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__remove_defaults.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs remove_default.py:3:8: ICN001 `altair` should be imported as `alt` | 1 | import math # not checked -2 | +2 | 3 | import altair # unconventional | ^^^^^^ ICN001 4 | import matplotlib.pyplot # unconventional @@ -38,7 +38,7 @@ remove_default.py:7:8: ICN001 `seaborn` should be imported as `sns` 6 | import pandas # unconventional 7 | import seaborn # unconventional | ^^^^^^^ ICN001 -8 | +8 | 9 | import altair as altr # unconventional | = help: Alias `seaborn` to `sns` @@ -46,7 +46,7 @@ remove_default.py:7:8: ICN001 `seaborn` should be imported as `sns` remove_default.py:9:18: ICN001 `altair` should be imported as `alt` | 7 | import seaborn # unconventional - 8 | + 8 | 9 | import altair as altr # unconventional | ^^^^ ICN001 10 | import matplotlib.pyplot as plot # unconventional @@ -80,9 +80,7 @@ remove_default.py:13:19: ICN001 `seaborn` should be imported as `sns` 12 | import pandas as pdas # unconventional 13 | import seaborn as sbrn # unconventional | ^^^^ ICN001 -14 | +14 | 15 | import altair as alt # conventional | = help: Alias `seaborn` to `sns` - - diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__same_name.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__same_name.snap index c30be9f37554c..0fa59ef67abca 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__same_name.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__same_name.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs +snapshot_kind: text --- same_name.py:10:41: ICN001 [*] `django.conf.settings` should be imported as `settings` | diff --git a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__tricky.snap b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__tricky.snap index b3c7cc2368a49..f2f4f18825ca4 100644 --- a/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__tricky.snap +++ b/crates/ruff_linter/src/rules/flake8_import_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__tricky.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_import_conventions/mod.rs +snapshot_kind: text --- tricky.py:7:16: ICN001 [*] `pandas` should be imported as `pd` | @@ -22,5 +23,3 @@ tricky.py:7:16: ICN001 [*] `pandas` should be imported as `pd` 7 |+ import pandas as pd 8 8 | except ImportError: 9 9 | return False - - diff --git a/crates/ruff_linter/src/rules/flake8_logging/mod.rs b/crates/ruff_linter/src/rules/flake8_logging/mod.rs index 1870a26e631aa..0b16662f33e5a 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/mod.rs @@ -17,6 +17,11 @@ mod tests { #[test_case(Rule::InvalidGetLoggerArgument, Path::new("LOG002.py"))] #[test_case(Rule::ExceptionWithoutExcInfo, Path::new("LOG007.py"))] #[test_case(Rule::UndocumentedWarn, Path::new("LOG009.py"))] + #[test_case(Rule::LogExceptionOutsideExceptHandler, Path::new("LOG004_0.py"))] + #[test_case(Rule::LogExceptionOutsideExceptHandler, Path::new("LOG004_1.py"))] + #[test_case(Rule::ExcInfoOutsideExceptHandler, Path::new("LOG014_0.py"))] + #[test_case(Rule::ExcInfoOutsideExceptHandler, Path::new("LOG014_1.py"))] + #[test_case(Rule::RootLoggerCall, Path::new("LOG015.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/direct_logger_instantiation.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/direct_logger_instantiation.rs index ee93f507c4ee0..83dae3049ca5b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/rules/direct_logger_instantiation.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/direct_logger_instantiation.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -37,24 +37,24 @@ use crate::importer::ImportRequest; /// ``` /// /// [Logger Objects]: https://docs.python.org/3/library/logging.html#logger-objects -#[violation] -pub struct DirectLoggerInstantiation; +#[derive(ViolationMetadata)] +pub(crate) struct DirectLoggerInstantiation; impl Violation for DirectLoggerInstantiation { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `logging.getLogger()` to instantiate loggers") + "Use `logging.getLogger()` to instantiate loggers".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `logging.getLogger()`")) + Some("Replace with `logging.getLogger()`".to_string()) } } /// LOG001 -pub(crate) fn direct_logger_instantiation(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn direct_logger_instantiation(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::LOGGING) { return; } @@ -74,6 +74,6 @@ pub(crate) fn direct_logger_instantiation(checker: &mut Checker, call: &ast::Exp let reference_edit = Edit::range_replacement(binding, call.func.range()); Ok(Fix::unsafe_edits(import_edit, [reference_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/exc_info_outside_except_handler.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/exc_info_outside_except_handler.rs new file mode 100644 index 0000000000000..ec74ffdc48466 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/exc_info_outside_except_handler.rs @@ -0,0 +1,118 @@ +use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::Truthiness; +use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; +use ruff_python_semantic::analyze::logging::is_logger_candidate; +use ruff_python_stdlib::logging::LoggingLevel; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; +use crate::rules::flake8_logging::rules::helpers::outside_handlers; + +/// ## What it does +/// Checks for logging calls with `exc_info=` outside exception handlers. +/// +/// ## Why is this bad? +/// Using `exc_info=True` outside of an exception handler +/// attaches `None` as the exception information, leading to confusing messages: +/// +/// ```pycon +/// >>> logging.warning("Uh oh", exc_info=True) +/// WARNING:root:Uh oh +/// NoneType: None +/// ``` +/// +/// ## Example +/// +/// ```python +/// import logging +/// +/// +/// logging.warning("Foobar", exc_info=True) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// import logging +/// +/// +/// logging.warning("Foobar") +/// ``` +/// +/// ## Fix safety +/// The fix is always marked as unsafe, as it changes runtime behavior. +#[derive(ViolationMetadata)] +pub(crate) struct ExcInfoOutsideExceptHandler; + +impl Violation for ExcInfoOutsideExceptHandler { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "`exc_info=` outside exception handlers".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Remove `exc_info=`".to_string()) + } +} + +pub(crate) fn exc_info_outside_except_handler(checker: &Checker, call: &ExprCall) { + let semantic = checker.semantic(); + + if !outside_handlers(call.start(), semantic) { + return; + } + + match &*call.func { + func @ Expr::Attribute(ExprAttribute { attr, .. }) => { + if !is_logger_candidate(func, semantic, &checker.settings.logger_objects) { + return; + } + + if LoggingLevel::from_attribute(attr).is_none() { + return; + } + } + + func @ Expr::Name(_) => { + let Some(qualified_name) = semantic.resolve_qualified_name(func) else { + return; + }; + + let ["logging", attr] = qualified_name.segments() else { + return; + }; + + if *attr != "log" && LoggingLevel::from_attribute(attr).is_none() { + return; + } + } + + _ => return, + } + + let Some(exc_info) = call.arguments.find_keyword("exc_info") else { + return; + }; + + let truthiness = Truthiness::from_expr(&exc_info.value, |id| semantic.has_builtin_binding(id)); + + if truthiness.into_bool() != Some(true) { + return; + } + + let arguments = &call.arguments; + let source = checker.source(); + + let mut diagnostic = Diagnostic::new(ExcInfoOutsideExceptHandler, exc_info.range); + + diagnostic.try_set_fix(|| { + let edit = remove_argument(exc_info, arguments, Parentheses::Preserve, source)?; + Ok(Fix::unsafe_edit(edit)) + }); + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/exception_without_exc_info.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/exception_without_exc_info.rs index d13c271e57740..f8c36980d2dd9 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/rules/exception_without_exc_info.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/exception_without_exc_info.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::Truthiness; use ruff_python_ast::{self as ast, Expr, ExprCall}; use ruff_python_semantic::analyze::logging; @@ -30,18 +30,18 @@ use crate::checkers::ast::Checker; /// ```python /// logging.error("...") /// ``` -#[violation] -pub struct ExceptionWithoutExcInfo; +#[derive(ViolationMetadata)] +pub(crate) struct ExceptionWithoutExcInfo; impl Violation for ExceptionWithoutExcInfo { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `logging.exception` with falsy `exc_info`") + "Use of `logging.exception` with falsy `exc_info`".to_string() } } /// LOG007 -pub(crate) fn exception_without_exc_info(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn exception_without_exc_info(checker: &Checker, call: &ExprCall) { match call.func.as_ref() { Expr::Attribute(ast::ExprAttribute { attr, .. }) => { if !matches!( @@ -74,19 +74,17 @@ pub(crate) fn exception_without_exc_info(checker: &mut Checker, call: &ExprCall) } if exc_info_arg_is_falsey(call, checker) { - checker - .diagnostics - .push(Diagnostic::new(ExceptionWithoutExcInfo, call.range())); + checker.report_diagnostic(Diagnostic::new(ExceptionWithoutExcInfo, call.range())); } } -fn exc_info_arg_is_falsey(call: &ExprCall, checker: &mut Checker) -> bool { +fn exc_info_arg_is_falsey(call: &ExprCall, checker: &Checker) -> bool { call.arguments .find_keyword("exc_info") .map(|keyword| &keyword.value) .is_some_and(|value| { let truthiness = Truthiness::from_expr(value, |id| checker.semantic().has_builtin_binding(id)); - matches!(truthiness, Truthiness::False | Truthiness::Falsey) + truthiness.into_bool() == Some(false) }) } diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/helpers.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/helpers.rs new file mode 100644 index 0000000000000..47c57d14bebf3 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/helpers.rs @@ -0,0 +1,24 @@ +use ruff_python_ast::{Stmt, StmtTry}; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::{Ranged, TextSize}; + +pub(super) fn outside_handlers(offset: TextSize, semantic: &SemanticModel) -> bool { + for stmt in semantic.current_statements() { + if matches!(stmt, Stmt::FunctionDef(_)) { + break; + } + + let Stmt::Try(StmtTry { handlers, .. }) = stmt else { + continue; + }; + + if handlers + .iter() + .any(|handler| handler.range().contains(offset)) + { + return false; + } + } + + true +} diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/invalid_get_logger_argument.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/invalid_get_logger_argument.rs index d7c5fa703260b..f2a30ee900bdd 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/rules/invalid_get_logger_argument.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/invalid_get_logger_argument.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -40,29 +40,30 @@ use crate::checkers::ast::Checker; /// ``` /// /// [logging documentation]: https://docs.python.org/3/library/logging.html#logger-objects -#[violation] -pub struct InvalidGetLoggerArgument; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidGetLoggerArgument; impl Violation for InvalidGetLoggerArgument { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `__name__` with `logging.getLogger()`") + "Use `__name__` with `logging.getLogger()`".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `__name__`")) + Some("Replace with `__name__`".to_string()) } } /// LOG002 -pub(crate) fn invalid_get_logger_argument(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn invalid_get_logger_argument(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::LOGGING) { return; } - let Some(Expr::Name(expr @ ast::ExprName { id, .. })) = call.arguments.find_argument("name", 0) + let Some(Expr::Name(expr @ ast::ExprName { id, .. })) = + call.arguments.find_argument_value("name", 0) else { return; }; @@ -90,5 +91,5 @@ pub(crate) fn invalid_get_logger_argument(checker: &mut Checker, call: &ast::Exp expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/log_exception_outside_except_handler.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/log_exception_outside_except_handler.rs new file mode 100644 index 0000000000000..5122f9cb0010a --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/log_exception_outside_except_handler.rs @@ -0,0 +1,109 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; +use ruff_python_semantic::analyze::logging; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::rules::flake8_logging::rules::helpers::outside_handlers; + +/// ## What it does +/// Checks for `.exception()` logging calls outside of exception handlers. +/// +/// ## Why is this bad? +/// [The documentation] states: +/// > This function should only be called from an exception handler. +/// +/// Calling `.exception()` outside of an exception handler +/// attaches `None` as exception information, leading to confusing messages: +/// +/// ```pycon +/// >>> logging.exception("example") +/// ERROR:root:example +/// NoneType: None +/// ``` +/// +/// ## Example +/// +/// ```python +/// import logging +/// +/// logging.exception("Foobar") +/// ``` +/// +/// Use instead: +/// +/// ```python +/// import logging +/// +/// logging.error("Foobar") +/// ``` +/// +/// ## Fix safety +/// The fix, if available, will always be marked as unsafe, as it changes runtime behavior. +/// +/// [The documentation]: https://docs.python.org/3/library/logging.html#logging.exception +#[derive(ViolationMetadata)] +pub(crate) struct LogExceptionOutsideExceptHandler; + +impl Violation for LogExceptionOutsideExceptHandler { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "`.exception()` call outside exception handlers".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Replace with `.error()`".to_string()) + } +} + +/// LOG004 +pub(crate) fn log_exception_outside_except_handler(checker: &Checker, call: &ExprCall) { + let semantic = checker.semantic(); + + if !outside_handlers(call.start(), semantic) { + return; + } + + let fix = match &*call.func { + func @ Expr::Attribute(ExprAttribute { attr, .. }) => { + let logger_objects = &checker.settings.logger_objects; + + if !logging::is_logger_candidate(func, semantic, logger_objects) { + return; + } + + if attr != "exception" { + return; + } + + let edit = Edit::range_replacement("error".to_string(), attr.range); + + Some(Fix::unsafe_edit(edit)) + } + + func @ Expr::Name(_) => { + let Some(qualified_name) = semantic.resolve_qualified_name(func) else { + return; + }; + + if !matches!(qualified_name.segments(), ["logging", "exception"]) { + return; + } + + None + } + + _ => return, + }; + + let mut diagnostic = Diagnostic::new(LogExceptionOutsideExceptHandler, call.range); + + if let Some(fix) = fix { + diagnostic.set_fix(fix); + } + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/mod.rs index 6a1756de94ce1..0d0b5e075a818 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/mod.rs @@ -1,9 +1,16 @@ pub(crate) use direct_logger_instantiation::*; +pub(crate) use exc_info_outside_except_handler::*; pub(crate) use exception_without_exc_info::*; pub(crate) use invalid_get_logger_argument::*; +pub(crate) use log_exception_outside_except_handler::*; +pub(crate) use root_logger_call::*; pub(crate) use undocumented_warn::*; mod direct_logger_instantiation; +mod exc_info_outside_except_handler; mod exception_without_exc_info; +mod helpers; mod invalid_get_logger_argument; +mod log_exception_outside_except_handler; +mod root_logger_call; mod undocumented_warn; diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/root_logger_call.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/root_logger_call.rs new file mode 100644 index 0000000000000..167eab4b3a2fe --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/root_logger_call.rs @@ -0,0 +1,77 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::ExprCall; +use ruff_python_semantic::Modules; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for usages of the following `logging` top-level functions: +/// `debug`, `info`, `warn`, `warning`, `error`, `critical`, `log`, `exception`. +/// +/// ## Why is this bad? +/// Using the root logger causes the messages to have no source information, +/// making them less useful for debugging. +/// +/// ## Example +/// ```python +/// import logging +/// +/// logging.info("Foobar") +/// ``` +/// +/// Use instead: +/// ```python +/// import logging +/// +/// logger = logging.getLogger(__name__) +/// logger.info("Foobar") +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct RootLoggerCall { + attr: String, +} + +impl Violation for RootLoggerCall { + #[derive_message_formats] + fn message(&self) -> String { + format!("`{}()` call on root logger", self.attr) + } + + fn fix_title(&self) -> Option<String> { + Some("Use own logger instead".to_string()) + } +} + +/// LOG015 +pub(crate) fn root_logger_call(checker: &Checker, call: &ExprCall) { + let semantic = checker.semantic(); + + if !semantic.seen_module(Modules::LOGGING) { + return; + } + + let Some(qualified_name) = semantic.resolve_qualified_name(&call.func) else { + return; + }; + + let attr = match qualified_name.segments() { + ["logging", attr] if is_logger_method_name(attr) => attr, + _ => return, + }; + + let kind = RootLoggerCall { + attr: (*attr).to_string(), + }; + let diagnostic = Diagnostic::new(kind, call.range); + + checker.report_diagnostic(diagnostic); +} + +#[inline] +fn is_logger_method_name(attr: &str) -> bool { + matches!( + attr, + "debug" | "info" | "warn" | "warning" | "error" | "critical" | "log" | "exception" + ) +} diff --git a/crates/ruff_linter/src/rules/flake8_logging/rules/undocumented_warn.rs b/crates/ruff_linter/src/rules/flake8_logging/rules/undocumented_warn.rs index 8e38ad5e55a6a..8ed90df6d07cc 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/rules/undocumented_warn.rs +++ b/crates/ruff_linter/src/rules/flake8_logging/rules/undocumented_warn.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -32,23 +32,24 @@ use crate::importer::ImportRequest; /// /// logging.basicConfig(level=logging.WARNING) /// ``` -#[violation] -pub struct UndocumentedWarn; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedWarn; impl Violation for UndocumentedWarn { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { - format!("Use of undocumented `logging.WARN` constant") + "Use of undocumented `logging.WARN` constant".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace `logging.WARN` with `logging.WARNING`")) + Some("Replace `logging.WARN` with `logging.WARNING`".to_string()) } } /// LOG009 -pub(crate) fn undocumented_warn(checker: &mut Checker, expr: &Expr) { +pub(crate) fn undocumented_warn(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::LOGGING) { return; } @@ -68,6 +69,6 @@ pub(crate) fn undocumented_warn(checker: &mut Checker, expr: &Expr) { let reference_edit = Edit::range_replacement(binding, expr.range()); Ok(Fix::safe_edits(import_edit, [reference_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG001_LOG001.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG001_LOG001.py.snap index c72edc6042394..c46ebbc1e5463 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG001_LOG001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG001_LOG001.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging/mod.rs LOG001.py:3:1: LOG001 [*] Use `logging.getLogger()` to instantiate loggers | 1 | import logging -2 | +2 | 3 | logging.Logger(__name__) | ^^^^^^^^^^^^^^ LOG001 4 | logging.Logger() @@ -36,5 +36,3 @@ LOG001.py:4:1: LOG001 [*] Use `logging.getLogger()` to instantiate loggers 4 |-logging.Logger() 4 |+logging.getLogger() 5 5 | logging.getLogger(__name__) - - diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG002_LOG002.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG002_LOG002.py.snap index b73778126387b..25a78dfdb0561 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG002_LOG002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG002_LOG002.py.snap @@ -26,7 +26,7 @@ LOG002.py:12:24: LOG002 [*] Use `__name__` with `logging.getLogger()` 11 | getLogger(__file__) 12 | logging.getLogger(name=__file__) | ^^^^^^^^ LOG002 -13 | +13 | 14 | logging.getLogger(__cached__) | = help: Replace with `__name__` @@ -44,7 +44,7 @@ LOG002.py:12:24: LOG002 [*] Use `__name__` with `logging.getLogger()` LOG002.py:14:19: LOG002 [*] Use `__name__` with `logging.getLogger()` | 12 | logging.getLogger(name=__file__) -13 | +13 | 14 | logging.getLogger(__cached__) | ^^^^^^^^^^ LOG002 15 | getLogger(name=__cached__) @@ -78,5 +78,3 @@ LOG002.py:15:16: LOG002 [*] Use `__name__` with `logging.getLogger()` 16 16 | 17 17 | 18 18 | # Override `logging.getLogger` - - diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_0.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_0.py.snap new file mode 100644 index 0000000000000..7a69b894f0aa1 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_0.py.snap @@ -0,0 +1,150 @@ +--- +source: crates/ruff_linter/src/rules/flake8_logging/mod.rs +--- +LOG004_0.py:13:1: LOG004 [*] `.exception()` call outside exception handlers + | +11 | ### Errors +12 | +13 | logging.exception("") + | ^^^^^^^^^^^^^^^^^^^^^ LOG004 +14 | logger.exception("") +15 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +10 10 | +11 11 | ### Errors +12 12 | +13 |-logging.exception("") + 13 |+logging.error("") +14 14 | logger.exception("") +15 15 | exc("") +16 16 | + +LOG004_0.py:14:1: LOG004 [*] `.exception()` call outside exception handlers + | +13 | logging.exception("") +14 | logger.exception("") + | ^^^^^^^^^^^^^^^^^^^^ LOG004 +15 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +11 11 | ### Errors +12 12 | +13 13 | logging.exception("") +14 |-logger.exception("") + 14 |+logger.error("") +15 15 | exc("") +16 16 | +17 17 | + +LOG004_0.py:15:1: LOG004 `.exception()` call outside exception handlers + | +13 | logging.exception("") +14 | logger.exception("") +15 | exc("") + | ^^^^^^^ LOG004 + | + = help: Replace with `.error()` + +LOG004_0.py:19:5: LOG004 [*] `.exception()` call outside exception handlers + | +18 | def _(): +19 | logging.exception("") + | ^^^^^^^^^^^^^^^^^^^^^ LOG004 +20 | logger.exception("") +21 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +16 16 | +17 17 | +18 18 | def _(): +19 |- logging.exception("") + 19 |+ logging.error("") +20 20 | logger.exception("") +21 21 | exc("") +22 22 | + +LOG004_0.py:20:5: LOG004 [*] `.exception()` call outside exception handlers + | +18 | def _(): +19 | logging.exception("") +20 | logger.exception("") + | ^^^^^^^^^^^^^^^^^^^^ LOG004 +21 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +17 17 | +18 18 | def _(): +19 19 | logging.exception("") +20 |- logger.exception("") + 20 |+ logger.error("") +21 21 | exc("") +22 22 | +23 23 | + +LOG004_0.py:21:5: LOG004 `.exception()` call outside exception handlers + | +19 | logging.exception("") +20 | logger.exception("") +21 | exc("") + | ^^^^^^^ LOG004 + | + = help: Replace with `.error()` + +LOG004_0.py:28:9: LOG004 [*] `.exception()` call outside exception handlers + | +26 | except ...: +27 | def _(): +28 | logging.exception("") + | ^^^^^^^^^^^^^^^^^^^^^ LOG004 +29 | logger.exception("") +30 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +25 25 | ... +26 26 | except ...: +27 27 | def _(): +28 |- logging.exception("") + 28 |+ logging.error("") +29 29 | logger.exception("") +30 30 | exc("") +31 31 | + +LOG004_0.py:29:9: LOG004 [*] `.exception()` call outside exception handlers + | +27 | def _(): +28 | logging.exception("") +29 | logger.exception("") + | ^^^^^^^^^^^^^^^^^^^^ LOG004 +30 | exc("") + | + = help: Replace with `.error()` + +ℹ Unsafe fix +26 26 | except ...: +27 27 | def _(): +28 28 | logging.exception("") +29 |- logger.exception("") + 29 |+ logger.error("") +30 30 | exc("") +31 31 | +32 32 | + +LOG004_0.py:30:9: LOG004 `.exception()` call outside exception handlers + | +28 | logging.exception("") +29 | logger.exception("") +30 | exc("") + | ^^^^^^^ LOG004 + | + = help: Replace with `.error()` diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_1.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_1.py.snap new file mode 100644 index 0000000000000..988004f79404b --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG004_LOG004_1.py.snap @@ -0,0 +1,16 @@ +--- +source: crates/ruff_linter/src/rules/flake8_logging/mod.rs +--- +LOG004_1.py:4:1: LOG004 [*] `.exception()` call outside exception handlers + | +4 | logger.exception("") + | ^^^^^^^^^^^^^^^^^^^^ LOG004 + | + = help: Replace with `.error()` + +ℹ Unsafe fix +1 1 | _ = (logger := __import__("somewhere").logger) +2 2 | +3 3 | +4 |-logger.exception("") + 4 |+logger.error("") diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG007_LOG007.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG007_LOG007.py.snap index a8df5679127e4..b98d744c20a17 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG007_LOG007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG007_LOG007.py.snap @@ -43,10 +43,8 @@ LOG007.py:10:1: LOG007 Use of `logging.exception` with falsy `exc_info` LOG007.py:17:1: LOG007 Use of `logging.exception` with falsy `exc_info` | 15 | from logging import exception -16 | +16 | 17 | exception("foo", exc_info=False) # LOG007 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ LOG007 18 | exception("foo", exc_info=True) # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG009_LOG009.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG009_LOG009.py.snap index b630875d83233..7d18aeb14ece5 100644 --- a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG009_LOG009.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG009_LOG009.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging/mod.rs LOG009.py:4:5: LOG009 [*] Use of undocumented `logging.WARN` constant | 2 | import logging -3 | +3 | 4 | logging.WARN # LOG009 | ^^^^^^^^^^^^ LOG009 5 | logging.WARNING # OK @@ -24,7 +24,7 @@ LOG009.py:4:5: LOG009 [*] Use of undocumented `logging.WARN` constant LOG009.py:11:5: LOG009 [*] Use of undocumented `logging.WARN` constant | 9 | from logging import WARN, WARNING -10 | +10 | 11 | WARN # LOG009 | ^^^^ LOG009 12 | WARNING # OK diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_0.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_0.py.snap new file mode 100644 index 0000000000000..47e25d39b3063 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_0.py.snap @@ -0,0 +1,153 @@ +--- +source: crates/ruff_linter/src/rules/flake8_logging/mod.rs +--- +LOG014_0.py:12:18: LOG014 [*] `exc_info=` outside exception handlers + | +10 | ### Errors +11 | +12 | logging.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 +13 | logger.info("", exc_info=True) + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +9 9 | +10 10 | ### Errors +11 11 | +12 |-logging.info("", exc_info=True) + 12 |+logging.info("") +13 13 | logger.info("", exc_info=True) +14 14 | +15 15 | + +LOG014_0.py:13:17: LOG014 [*] `exc_info=` outside exception handlers + | +12 | logging.info("", exc_info=True) +13 | logger.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +10 10 | ### Errors +11 11 | +12 12 | logging.info("", exc_info=True) +13 |-logger.info("", exc_info=True) + 13 |+logger.info("") +14 14 | +15 15 | +16 16 | logging.info("", exc_info=1) + +LOG014_0.py:16:18: LOG014 [*] `exc_info=` outside exception handlers + | +16 | logging.info("", exc_info=1) + | ^^^^^^^^^^ LOG014 +17 | logger.info("", exc_info=1) + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +13 13 | logger.info("", exc_info=True) +14 14 | +15 15 | +16 |-logging.info("", exc_info=1) + 16 |+logging.info("") +17 17 | logger.info("", exc_info=1) +18 18 | +19 19 | + +LOG014_0.py:17:17: LOG014 [*] `exc_info=` outside exception handlers + | +16 | logging.info("", exc_info=1) +17 | logger.info("", exc_info=1) + | ^^^^^^^^^^ LOG014 + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +14 14 | +15 15 | +16 16 | logging.info("", exc_info=1) +17 |-logger.info("", exc_info=1) + 17 |+logger.info("") +18 18 | +19 19 | +20 20 | def _(): + +LOG014_0.py:21:22: LOG014 [*] `exc_info=` outside exception handlers + | +20 | def _(): +21 | logging.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 +22 | logger.info("", exc_info=True) + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +18 18 | +19 19 | +20 20 | def _(): +21 |- logging.info("", exc_info=True) + 21 |+ logging.info("") +22 22 | logger.info("", exc_info=True) +23 23 | +24 24 | + +LOG014_0.py:22:21: LOG014 [*] `exc_info=` outside exception handlers + | +20 | def _(): +21 | logging.info("", exc_info=True) +22 | logger.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +19 19 | +20 20 | def _(): +21 21 | logging.info("", exc_info=True) +22 |- logger.info("", exc_info=True) + 22 |+ logger.info("") +23 23 | +24 24 | +25 25 | try: + +LOG014_0.py:29:26: LOG014 [*] `exc_info=` outside exception handlers + | +27 | except ...: +28 | def _(): +29 | logging.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 +30 | logger.info("", exc_info=True) + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +26 26 | ... +27 27 | except ...: +28 28 | def _(): +29 |- logging.info("", exc_info=True) + 29 |+ logging.info("") +30 30 | logger.info("", exc_info=True) +31 31 | +32 32 | + +LOG014_0.py:30:25: LOG014 [*] `exc_info=` outside exception handlers + | +28 | def _(): +29 | logging.info("", exc_info=True) +30 | logger.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +27 27 | except ...: +28 28 | def _(): +29 29 | logging.info("", exc_info=True) +30 |- logger.info("", exc_info=True) + 30 |+ logger.info("") +31 31 | +32 32 | +33 33 | ### No errors diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_1.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_1.py.snap new file mode 100644 index 0000000000000..0144629b874bb --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG014_LOG014_1.py.snap @@ -0,0 +1,16 @@ +--- +source: crates/ruff_linter/src/rules/flake8_logging/mod.rs +--- +LOG014_1.py:4:17: LOG014 [*] `exc_info=` outside exception handlers + | +4 | logger.info("", exc_info=True) + | ^^^^^^^^^^^^^ LOG014 + | + = help: Remove `exc_info=` + +ℹ Unsafe fix +1 1 | _ = (logger := __import__("somewhere").logger) +2 2 | +3 3 | +4 |-logger.info("", exc_info=True) + 4 |+logger.info("") diff --git a/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG015_LOG015.py.snap b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG015_LOG015.py.snap new file mode 100644 index 0000000000000..6c22e8d998925 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_logging/snapshots/ruff_linter__rules__flake8_logging__tests__LOG015_LOG015.py.snap @@ -0,0 +1,170 @@ +--- +source: crates/ruff_linter/src/rules/flake8_logging/mod.rs +--- +LOG015.py:4:1: LOG015 `debug()` call on root logger + | +2 | import logging +3 | +4 | logging.debug("Lorem") + | ^^^^^^^^^^^^^^^^^^^^^^ LOG015 +5 | logging.info("ipsum") +6 | logging.warn("dolor") + | + = help: Use own logger instead + +LOG015.py:5:1: LOG015 `info()` call on root logger + | +4 | logging.debug("Lorem") +5 | logging.info("ipsum") + | ^^^^^^^^^^^^^^^^^^^^^ LOG015 +6 | logging.warn("dolor") +7 | logging.warning("sit") + | + = help: Use own logger instead + +LOG015.py:6:1: LOG015 `warn()` call on root logger + | +4 | logging.debug("Lorem") +5 | logging.info("ipsum") +6 | logging.warn("dolor") + | ^^^^^^^^^^^^^^^^^^^^^ LOG015 +7 | logging.warning("sit") +8 | logging.error("amet") + | + = help: Use own logger instead + +LOG015.py:7:1: LOG015 `warning()` call on root logger + | +5 | logging.info("ipsum") +6 | logging.warn("dolor") +7 | logging.warning("sit") + | ^^^^^^^^^^^^^^^^^^^^^^ LOG015 +8 | logging.error("amet") +9 | logging.critical("consectetur") + | + = help: Use own logger instead + +LOG015.py:8:1: LOG015 `error()` call on root logger + | + 6 | logging.warn("dolor") + 7 | logging.warning("sit") + 8 | logging.error("amet") + | ^^^^^^^^^^^^^^^^^^^^^ LOG015 + 9 | logging.critical("consectetur") +10 | logging.log("adipiscing") + | + = help: Use own logger instead + +LOG015.py:9:1: LOG015 `critical()` call on root logger + | + 7 | logging.warning("sit") + 8 | logging.error("amet") + 9 | logging.critical("consectetur") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ LOG015 +10 | logging.log("adipiscing") +11 | logging.exception("elit.") + | + = help: Use own logger instead + +LOG015.py:10:1: LOG015 `log()` call on root logger + | + 8 | logging.error("amet") + 9 | logging.critical("consectetur") +10 | logging.log("adipiscing") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ LOG015 +11 | logging.exception("elit.") + | + = help: Use own logger instead + +LOG015.py:11:1: LOG015 `exception()` call on root logger + | + 9 | logging.critical("consectetur") +10 | logging.log("adipiscing") +11 | logging.exception("elit.") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ LOG015 + | + = help: Use own logger instead + +LOG015.py:26:1: LOG015 `debug()` call on root logger + | +24 | ) +25 | +26 | debug("Lorem") + | ^^^^^^^^^^^^^^ LOG015 +27 | info("ipsum") +28 | warn("dolor") + | + = help: Use own logger instead + +LOG015.py:27:1: LOG015 `info()` call on root logger + | +26 | debug("Lorem") +27 | info("ipsum") + | ^^^^^^^^^^^^^ LOG015 +28 | warn("dolor") +29 | warning("sit") + | + = help: Use own logger instead + +LOG015.py:28:1: LOG015 `warn()` call on root logger + | +26 | debug("Lorem") +27 | info("ipsum") +28 | warn("dolor") + | ^^^^^^^^^^^^^ LOG015 +29 | warning("sit") +30 | error("amet") + | + = help: Use own logger instead + +LOG015.py:29:1: LOG015 `warning()` call on root logger + | +27 | info("ipsum") +28 | warn("dolor") +29 | warning("sit") + | ^^^^^^^^^^^^^^ LOG015 +30 | error("amet") +31 | critical("consectetur") + | + = help: Use own logger instead + +LOG015.py:30:1: LOG015 `error()` call on root logger + | +28 | warn("dolor") +29 | warning("sit") +30 | error("amet") + | ^^^^^^^^^^^^^ LOG015 +31 | critical("consectetur") +32 | log("adipiscing") + | + = help: Use own logger instead + +LOG015.py:31:1: LOG015 `critical()` call on root logger + | +29 | warning("sit") +30 | error("amet") +31 | critical("consectetur") + | ^^^^^^^^^^^^^^^^^^^^^^^ LOG015 +32 | log("adipiscing") +33 | exception("elit.") + | + = help: Use own logger instead + +LOG015.py:32:1: LOG015 `log()` call on root logger + | +30 | error("amet") +31 | critical("consectetur") +32 | log("adipiscing") + | ^^^^^^^^^^^^^^^^^ LOG015 +33 | exception("elit.") + | + = help: Use own logger instead + +LOG015.py:33:1: LOG015 `exception()` call on root logger + | +31 | critical("consectetur") +32 | log("adipiscing") +33 | exception("elit.") + | ^^^^^^^^^^^^^^^^^^ LOG015 + | + = help: Use own logger instead diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/rules/logging_call.rs b/crates/ruff_linter/src/rules/flake8_logging_format/rules/logging_call.rs index fede8ba3681d8..a053b4514fb12 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/rules/logging_call.rs +++ b/crates/ruff_linter/src/rules/flake8_logging_format/rules/logging_call.rs @@ -42,22 +42,18 @@ fn is_reserved_attr(attr: &str) -> bool { } /// Check logging messages for violations. -fn check_msg(checker: &mut Checker, msg: &Expr) { +fn check_msg(checker: &Checker, msg: &Expr) { match msg { // Check for string concatenation and percent format. Expr::BinOp(ast::ExprBinOp { op, .. }) => match op { Operator::Add => { if checker.enabled(Rule::LoggingStringConcat) { - checker - .diagnostics - .push(Diagnostic::new(LoggingStringConcat, msg.range())); + checker.report_diagnostic(Diagnostic::new(LoggingStringConcat, msg.range())); } } Operator::Mod => { if checker.enabled(Rule::LoggingPercentFormat) { - checker - .diagnostics - .push(Diagnostic::new(LoggingPercentFormat, msg.range())); + checker.report_diagnostic(Diagnostic::new(LoggingPercentFormat, msg.range())); } } _ => {} @@ -65,9 +61,7 @@ fn check_msg(checker: &mut Checker, msg: &Expr) { // Check for f-strings. Expr::FString(_) => { if checker.enabled(Rule::LoggingFString) { - checker - .diagnostics - .push(Diagnostic::new(LoggingFString, msg.range())); + checker.report_diagnostic(Diagnostic::new(LoggingFString, msg.range())); } } // Check for .format() calls. @@ -76,8 +70,7 @@ fn check_msg(checker: &mut Checker, msg: &Expr) { if let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func.as_ref() { if attr == "format" && value.is_literal_expr() { checker - .diagnostics - .push(Diagnostic::new(LoggingStringFormat, msg.range())); + .report_diagnostic(Diagnostic::new(LoggingStringFormat, msg.range())); } } } @@ -87,7 +80,7 @@ fn check_msg(checker: &mut Checker, msg: &Expr) { } /// Check contents of the `extra` argument to logging calls. -fn check_log_record_attr_clash(checker: &mut Checker, extra: &Keyword) { +fn check_log_record_attr_clash(checker: &Checker, extra: &Keyword) { match &extra.value { Expr::Dict(dict) => { for invalid_key in dict.iter_keys().filter_map(|key| { @@ -98,7 +91,7 @@ fn check_log_record_attr_clash(checker: &mut Checker, extra: &Keyword) { None } }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( LoggingExtraAttrClash(invalid_key.value.to_string()), invalid_key.range(), )); @@ -113,7 +106,7 @@ fn check_log_record_attr_clash(checker: &mut Checker, extra: &Keyword) { for keyword in keywords { if let Some(attr) = &keyword.arg { if is_reserved_attr(attr) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( LoggingExtraAttrClash(attr.to_string()), keyword.range(), )); @@ -145,7 +138,7 @@ impl LoggingCallType { } /// Check logging calls for violations. -pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn logging_call(checker: &Checker, call: &ast::ExprCall) { // Determine the call type (e.g., `info` vs. `exception`) and the range of the attribute. let (logging_call_type, range) = match call.func.as_ref() { Expr::Attribute(ast::ExprAttribute { value: _, attr, .. }) => { @@ -181,7 +174,7 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { // G001 - G004 let msg_pos = usize::from(matches!(logging_call_type, LoggingCallType::LogCall)); - if let Some(format_arg) = call.arguments.find_argument("msg", msg_pos) { + if let Some(format_arg) = call.arguments.find_argument_value("msg", msg_pos) { check_msg(checker, format_arg); } @@ -196,7 +189,7 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { "warning".to_string(), range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -219,16 +212,15 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { match logging_level { LoggingLevel::Error => { if checker.enabled(Rule::LoggingExcInfo) { - checker - .diagnostics - .push(Diagnostic::new(LoggingExcInfo, range)); + checker.report_diagnostic(Diagnostic::new(LoggingExcInfo, range)); } } LoggingLevel::Exception => { if checker.enabled(Rule::LoggingRedundantExcInfo) { - checker - .diagnostics - .push(Diagnostic::new(LoggingRedundantExcInfo, exc_info.range())); + checker.report_diagnostic(Diagnostic::new( + LoggingRedundantExcInfo, + exc_info.range(), + )); } } _ => {} diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G001.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G001.py.snap index f6e052cf559f7..a872a12c9db0c 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G001.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs G001.py:4:14: G001 Logging statement uses `str.format` | 2 | import logging as foo -3 | +3 | 4 | logging.info("Hello {}".format("World!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 5 | logging.log(logging.INFO, "Hello {}".format("World!")) @@ -55,14 +55,14 @@ G001.py:9:17: G001 Logging statement uses `str.format` 8 | logging.log(level=logging.INFO, msg="Hello {}".format("World!")) 9 | logging.log(msg="Hello {}".format("World!"), level=logging.INFO) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 -10 | +10 | 11 | # Flask support | G001.py:16:31: G001 Logging statement uses `str.format` | 14 | from flask import current_app as app -15 | +15 | 16 | flask.current_app.logger.info("Hello {}".format("World!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 17 | current_app.logger.info("Hello {}".format("World!")) @@ -83,14 +83,14 @@ G001.py:18:30: G001 Logging statement uses `str.format` 17 | current_app.logger.info("Hello {}".format("World!")) 18 | app.logger.log(logging.INFO, "Hello {}".format("World!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 -19 | +19 | 20 | from logging import info, log | G001.py:22:6: G001 Logging statement uses `str.format` | 20 | from logging import info, log -21 | +21 | 22 | info("Hello {}".format("World!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 23 | log(logging.INFO, "Hello {}".format("World!")) @@ -142,5 +142,3 @@ G001.py:27:9: G001 Logging statement uses `str.format` 27 | log(msg="Hello {}".format("World!"), level=logging.INFO) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ G001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G002.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G002.py.snap index 6ba827bafa5e2..ac9571bbc3ba2 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G002.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs G002.py:3:14: G002 Logging statement uses `%` | 1 | import logging -2 | +2 | 3 | logging.info("Hello %s" % "World!") | ^^^^^^^^^^^^^^^^^^^^^ G002 4 | logging.log(logging.INFO, "Hello %s" % "World!") @@ -15,14 +15,14 @@ G002.py:4:27: G002 Logging statement uses `%` 3 | logging.info("Hello %s" % "World!") 4 | logging.log(logging.INFO, "Hello %s" % "World!") | ^^^^^^^^^^^^^^^^^^^^^ G002 -5 | +5 | 6 | from logging import info, log | G002.py:8:6: G002 Logging statement uses `%` | 6 | from logging import info, log -7 | +7 | 8 | info("Hello %s" % "World!") | ^^^^^^^^^^^^^^^^^^^^^ G002 9 | log(logging.INFO, "Hello %s" % "World!") @@ -34,5 +34,3 @@ G002.py:9:19: G002 Logging statement uses `%` 9 | log(logging.INFO, "Hello %s" % "World!") | ^^^^^^^^^^^^^^^^^^^^^ G002 | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G003.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G003.py.snap index 494761d268587..431d5dbf323f2 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G003.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs G003.py:3:14: G003 Logging statement uses `+` | 1 | import logging -2 | +2 | 3 | logging.info("Hello" + " " + "World!") | ^^^^^^^^^^^^^^^^^^^^^^^^ G003 4 | logging.log(logging.INFO, "Hello" + " " + "World!") @@ -15,14 +15,14 @@ G003.py:4:27: G003 Logging statement uses `+` 3 | logging.info("Hello" + " " + "World!") 4 | logging.log(logging.INFO, "Hello" + " " + "World!") | ^^^^^^^^^^^^^^^^^^^^^^^^ G003 -5 | +5 | 6 | from logging import info, log | G003.py:8:6: G003 Logging statement uses `+` | 6 | from logging import info, log -7 | +7 | 8 | info("Hello" + " " + "World!") | ^^^^^^^^^^^^^^^^^^^^^^^^ G003 9 | log(logging.INFO, "Hello" + " " + "World!") @@ -34,5 +34,3 @@ G003.py:9:19: G003 Logging statement uses `+` 9 | log(logging.INFO, "Hello" + " " + "World!") | ^^^^^^^^^^^^^^^^^^^^^^^^ G003 | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G004.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G004.py.snap index b0b7f2b82378a..9cd4524dd90e9 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G004.py.snap @@ -15,7 +15,7 @@ G004.py:5:27: G004 Logging statement uses f-string 4 | logging.info(f"Hello {name}") 5 | logging.log(logging.INFO, f"Hello {name}") | ^^^^^^^^^^^^^^^ G004 -6 | +6 | 7 | _LOGGER = logging.getLogger() | @@ -24,24 +24,24 @@ G004.py:8:14: G004 Logging statement uses f-string 7 | _LOGGER = logging.getLogger() 8 | _LOGGER.info(f"{__name__}") | ^^^^^^^^^^^^^ G004 - 9 | + 9 | 10 | logging.getLogger().info(f"{name}") | G004.py:10:26: G004 Logging statement uses f-string | 8 | _LOGGER.info(f"{__name__}") - 9 | + 9 | 10 | logging.getLogger().info(f"{name}") | ^^^^^^^^^ G004 -11 | +11 | 12 | from logging import info | G004.py:14:6: G004 Logging statement uses f-string | 12 | from logging import info -13 | +13 | 14 | info(f"{name}") | ^^^^^^^^^ G004 15 | info(f"{__name__}") diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G010.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G010.py.snap index 8a9191704f79f..f746582a16b69 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G010.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G010.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs G010.py:6:9: G010 [*] Logging statement uses `warn` instead of `warning` | 4 | from logging_setup import logger -5 | +5 | 6 | logging.warn("Hello World!") | ^^^^ G010 7 | log.warn("Hello world!") # This shouldn't be considered as a logger candidate @@ -28,7 +28,7 @@ G010.py:8:8: G010 [*] Logging statement uses `warn` instead of `warning` 7 | log.warn("Hello world!") # This shouldn't be considered as a logger candidate 8 | logger.warn("Hello world!") | ^^^^ G010 - 9 | + 9 | 10 | logging . warn("Hello World!") | = help: Convert to `warning` @@ -46,10 +46,10 @@ G010.py:8:8: G010 [*] Logging statement uses `warn` instead of `warning` G010.py:10:11: G010 [*] Logging statement uses `warn` instead of `warning` | 8 | logger.warn("Hello world!") - 9 | + 9 | 10 | logging . warn("Hello World!") | ^^^^ G010 -11 | +11 | 12 | from logging import warn, warning, exception | = help: Convert to `warning` @@ -82,5 +82,3 @@ G010.py:13:1: G010 [*] Logging statement uses `warn` instead of `warning` 14 13 | warning("foo") 14 |+warning("foo") 15 15 | exception("foo") - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_1.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_1.py.snap index e0fff24c03a91..cc1f53e735798 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- G101_1.py:6:9: G101 Logging statement uses an `extra` field that clashes with a `LogRecord` field: `name` | @@ -20,5 +21,3 @@ G101_1.py:15:9: G101 Logging statement uses an `extra` field that clashes with a 16 | }, 17 | ) | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_2.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_2.py.snap index 7e5e636f87afb..e121d570ab1f4 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G101_2.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- G101_2.py:6:9: G101 Logging statement uses an `extra` field that clashes with a `LogRecord` field: `name` | @@ -20,5 +21,3 @@ G101_2.py:15:9: G101 Logging statement uses an `extra` field that clashes with a 16 | ), 17 | ) | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G201.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G201.py.snap index 34c469ae68bbd..62ce1845b6660 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G201.py.snap @@ -7,7 +7,7 @@ G201.py:8:13: G201 Logging `.exception(...)` should be used instead of `.error(. 7 | except: 8 | logging.error("Hello World", exc_info=True) | ^^^^^ G201 - 9 | + 9 | 10 | try: | @@ -17,7 +17,7 @@ G201.py:13:13: G201 Logging `.exception(...)` should be used instead of `.error( 12 | except: 13 | logging.error("Hello World", exc_info=sys.exc_info()) | ^^^^^ G201 -14 | +14 | 15 | # OK | @@ -27,7 +27,7 @@ G201.py:28:5: G201 Logging `.exception(...)` should be used instead of `.error(. 27 | except: 28 | error("Hello World", exc_info=True) | ^^^^^ G201 -29 | +29 | 30 | try: | @@ -37,8 +37,6 @@ G201.py:33:5: G201 Logging `.exception(...)` should be used instead of `.error(. 32 | except: 33 | error("Hello World", exc_info=sys.exc_info()) | ^^^^^ G201 -34 | +34 | 35 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G202.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G202.py.snap index 17daeba81a893..fa50225852831 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G202.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G202.py.snap @@ -7,7 +7,7 @@ G202.py:8:38: G202 Logging statement has redundant `exc_info` 7 | except: 8 | logging.exception("Hello World", exc_info=True) | ^^^^^^^^^^^^^ G202 - 9 | + 9 | 10 | try: | @@ -17,7 +17,7 @@ G202.py:13:38: G202 Logging statement has redundant `exc_info` 12 | except: 13 | logging.exception("Hello World", exc_info=sys.exc_info()) | ^^^^^^^^^^^^^^^^^^^^^^^ G202 -14 | +14 | 15 | # OK | @@ -27,7 +27,7 @@ G202.py:28:30: G202 Logging statement has redundant `exc_info` 27 | except: 28 | exception("Hello World", exc_info=True) | ^^^^^^^^^^^^^ G202 -29 | +29 | 30 | try: | @@ -37,8 +37,6 @@ G202.py:33:30: G202 Logging statement has redundant `exc_info` 32 | except: 33 | exception("Hello World", exc_info=sys.exc_info()) | ^^^^^^^^^^^^^^^^^^^^^^^ G202 -34 | +34 | 35 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_argparse_parser_error_ok.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_argparse_parser_error_ok.py.snap index d8fca096338cb..013e8b513087b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_argparse_parser_error_ok.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_argparse_parser_error_ok.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_ok.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_ok.py.snap index d8fca096338cb..013e8b513087b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_ok.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_ok.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_str_format_ok.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_str_format_ok.py.snap index d8fca096338cb..013e8b513087b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_str_format_ok.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_extra_str_format_ok.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_simple_ok.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_simple_ok.py.snap index d8fca096338cb..013e8b513087b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_simple_ok.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_simple_ok.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_warnings_ok.py.snap b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_warnings_ok.py.snap index d8fca096338cb..013e8b513087b 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_warnings_ok.py.snap +++ b/crates/ruff_linter/src/rules/flake8_logging_format/snapshots/ruff_linter__rules__flake8_logging_format__tests__G_warnings_ok.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_logging_format/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_logging_format/violations.rs b/crates/ruff_linter/src/rules/flake8_logging_format/violations.rs index 7ac54e9a34e6b..cec46dbeb0120 100644 --- a/crates/ruff_linter/src/rules/flake8_logging_format/violations.rs +++ b/crates/ruff_linter/src/rules/flake8_logging_format/violations.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `str.format` to format logging messages. @@ -73,13 +73,13 @@ use ruff_macros::{derive_message_formats, violation}; /// ## References /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) /// - [Python documentation: Optimization](https://docs.python.org/3/howto/logging.html#optimization) -#[violation] -pub struct LoggingStringFormat; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingStringFormat; impl Violation for LoggingStringFormat { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement uses `str.format`") + "Logging statement uses `str.format`".to_string() } } @@ -157,13 +157,13 @@ impl Violation for LoggingStringFormat { /// ## References /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) /// - [Python documentation: Optimization](https://docs.python.org/3/howto/logging.html#optimization) -#[violation] -pub struct LoggingPercentFormat; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingPercentFormat; impl Violation for LoggingPercentFormat { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement uses `%`") + "Logging statement uses `%`".to_string() } } @@ -240,13 +240,13 @@ impl Violation for LoggingPercentFormat { /// ## References /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) /// - [Python documentation: Optimization](https://docs.python.org/3/howto/logging.html#optimization) -#[violation] -pub struct LoggingStringConcat; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingStringConcat; impl Violation for LoggingStringConcat { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement uses `+`") + "Logging statement uses `+`".to_string() } } @@ -322,13 +322,13 @@ impl Violation for LoggingStringConcat { /// ## References /// - [Python documentation: `logging`](https://docs.python.org/3/library/logging.html) /// - [Python documentation: Optimization](https://docs.python.org/3/howto/logging.html#optimization) -#[violation] -pub struct LoggingFString; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingFString; impl Violation for LoggingFString { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement uses f-string") + "Logging statement uses f-string".to_string() } } @@ -373,13 +373,13 @@ impl Violation for LoggingFString { /// ## References /// - [Python documentation: `logging.warning`](https://docs.python.org/3/library/logging.html#logging.warning) /// - [Python documentation: `logging.Logger.warning`](https://docs.python.org/3/library/logging.html#logging.Logger.warning) -#[violation] -pub struct LoggingWarn; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingWarn; impl AlwaysFixableViolation for LoggingWarn { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement uses `warn` instead of `warning`") + "Logging statement uses `warn` instead of `warning`".to_string() } fn fix_title(&self) -> String { @@ -432,7 +432,7 @@ impl AlwaysFixableViolation for LoggingWarn { /// /// username = "Maria" /// -/// logging.info("Something happened", extra=dict(user=username)) +/// logging.info("Something happened", extra=dict(user_id=username)) /// ``` /// /// ## Options @@ -440,8 +440,8 @@ impl AlwaysFixableViolation for LoggingWarn { /// /// ## References /// - [Python documentation: LogRecord attributes](https://docs.python.org/3/library/logging.html#logrecord-attributes) -#[violation] -pub struct LoggingExtraAttrClash(pub String); +#[derive(ViolationMetadata)] +pub(crate) struct LoggingExtraAttrClash(pub String); impl Violation for LoggingExtraAttrClash { #[derive_message_formats] @@ -502,13 +502,14 @@ impl Violation for LoggingExtraAttrClash { /// - [Python documentation: `exception`](https://docs.python.org/3/library/logging.html#logging.Logger.exception) /// - [Python documentation: `logging.error`](https://docs.python.org/3/library/logging.html#logging.error) /// - [Python documentation: `error`](https://docs.python.org/3/library/logging.html#logging.Logger.error) -#[violation] -pub struct LoggingExcInfo; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingExcInfo; impl Violation for LoggingExcInfo { #[derive_message_formats] fn message(&self) -> String { - format!("Logging `.exception(...)` should be used instead of `.error(..., exc_info=True)`") + "Logging `.exception(...)` should be used instead of `.error(..., exc_info=True)`" + .to_string() } } @@ -563,12 +564,12 @@ impl Violation for LoggingExcInfo { /// - [Python documentation: `exception`](https://docs.python.org/3/library/logging.html#logging.Logger.exception) /// - [Python documentation: `logging.error`](https://docs.python.org/3/library/logging.html#logging.error) /// - [Python documentation: `error`](https://docs.python.org/3/library/logging.html#logging.Logger.error) -#[violation] -pub struct LoggingRedundantExcInfo; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingRedundantExcInfo; impl Violation for LoggingRedundantExcInfo { #[derive_message_formats] fn message(&self) -> String { - format!("Logging statement has redundant `exc_info`") + "Logging statement has redundant `exc_info`".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs b/crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs index cd2df547be580..679896ef0a3b2 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs @@ -8,8 +8,9 @@ mod tests { use anyhow::Result; use test_case::test_case; - use crate::assert_messages; use crate::registry::Rule; + + use crate::assert_messages; use crate::settings::LinterSettings; use crate::test::{test_path, test_resource_path}; @@ -22,7 +23,7 @@ mod tests { #[test_case(Path::new("test_pass_pyi"), Path::new("example.pyi"))] #[test_case(Path::new("test_pass_script"), Path::new("script"))] #[test_case(Path::new("test_pass_shebang"), Path::new("example.py"))] - fn test_flake8_no_pep420(path: &Path, filename: &Path) -> Result<()> { + fn default(path: &Path, filename: &Path) -> Result<()> { let snapshot = format!("{}", path.to_string_lossy()); let p = PathBuf::from(format!( "flake8_no_pep420/{}/{}", @@ -38,7 +39,9 @@ mod tests { ..LinterSettings::for_rule(Rule::ImplicitNamespacePackage) }, )?; - assert_messages!(snapshot, diagnostics); + insta::with_settings!({filters => vec![(r"\\", "/")]}, { + assert_messages!(snapshot, diagnostics); + }); Ok(()) } } diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/rules/implicit_namespace_package.rs b/crates/ruff_linter/src/rules/flake8_no_pep420/rules/implicit_namespace_package.rs index 76fec32529558..bfddb09011263 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/rules/implicit_namespace_package.rs +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/rules/implicit_namespace_package.rs @@ -1,15 +1,16 @@ use std::path::{Path, PathBuf}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::script::ScriptTag; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::PySourceType; +use ruff_python_ast::script::ScriptTag; use ruff_python_trivia::CommentRanges; use ruff_text_size::{TextRange, TextSize}; +use crate::Locator; use crate::comments::shebang::ShebangDirective; use crate::fs; -use crate::Locator; +use crate::package::PackageRoot; /// ## What it does /// Checks for packages that are missing an `__init__.py` file. @@ -22,64 +23,94 @@ use crate::Locator; /// /// Directories that lack an `__init__.py` file can still be imported, but /// they're indicative of a special kind of package, known as a "namespace -/// package" (see: [PEP 420](https://www.python.org/dev/peps/pep-0420/)). +/// package" (see: [PEP 420](https://peps.python.org/pep-0420/)). /// Namespace packages are less widely used, so a package that lacks an /// `__init__.py` file is typically meant to be a regular package, and /// the absence of the `__init__.py` file is probably an oversight. /// /// ## Options /// - `namespace-packages` -#[violation] -pub struct ImplicitNamespacePackage { +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitNamespacePackage { filename: String, + parent: Option<String>, } impl Violation for ImplicitNamespacePackage { #[derive_message_formats] fn message(&self) -> String { - let ImplicitNamespacePackage { filename } = self; - format!("File `{filename}` is part of an implicit namespace package. Add an `__init__.py`.") + let ImplicitNamespacePackage { filename, parent } = self; + match parent { + None => { + format!( + "File `{filename}` is part of an implicit namespace package. Add an `__init__.py`." + ) + } + Some(parent) => { + format!( + "File `{filename}` declares a package, but is nested under an implicit namespace package. Add an `__init__.py` to `{parent}`." + ) + } + } } } /// INP001 pub(crate) fn implicit_namespace_package( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, locator: &Locator, comment_ranges: &CommentRanges, project_root: &Path, src: &[PathBuf], + allow_nested_roots: bool, ) -> Option<Diagnostic> { if package.is_none() // Ignore non-`.py` files, which don't require an `__init__.py`. && PySourceType::try_from_path(path).is_some_and(PySourceType::is_py_file) // Ignore any files that are direct children of the project root. - && !path + && path .parent() - .is_some_and( |parent| parent == project_root) + .is_none_or( |parent| parent != project_root) // Ignore any files that are direct children of a source directory (e.g., `src/manage.py`). && !path .parent() .is_some_and( |parent| src.iter().any(|src| src == parent)) // Ignore files that contain a shebang. - && !comment_ranges + && comment_ranges .first().filter(|range| range.start() == TextSize::from(0)) - .is_some_and(|range| ShebangDirective::try_extract(locator.slice(*range)).is_some()) + .is_none_or(|range| ShebangDirective::try_extract(locator.slice(*range)).is_none()) // Ignore PEP 723 scripts. && ScriptTag::parse(locator.contents().as_bytes()).is_none() { - #[cfg(all(test, windows))] - let path = path - .to_string_lossy() - .replace(std::path::MAIN_SEPARATOR, "/"); // The snapshot test expects / as the path separator. - Some(Diagnostic::new( + return Some(Diagnostic::new( ImplicitNamespacePackage { filename: fs::relativize_path(path), + parent: None, }, TextRange::default(), - )) - } else { - None + )); + } + + if allow_nested_roots { + if let Some(PackageRoot::Nested { path: root }) = package.as_ref() { + if path.ends_with("__init__.py") { + // Identify the intermediary package that's missing the `__init__.py` file. + if let Some(parent) = root + .ancestors() + .find(|parent| !parent.join("__init__.py").exists()) + { + return Some(Diagnostic::new( + ImplicitNamespacePackage { + filename: fs::relativize_path(path), + parent: Some(fs::relativize_path(parent)), + }, + TextRange::default(), + )); + } + } + } } + + None } diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_empty.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_empty.snap index 764fcdac4bfe1..9daebc7a6df31 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_empty.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_empty.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- example.py:1:1: INP001 File `./resources/test/fixtures/flake8_no_pep420/test_fail_empty/example.py` is part of an implicit namespace package. Add an `__init__.py`. diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_nonempty.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_nonempty.snap index dfbb8bccba1ee..075a6bad1fec3 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_nonempty.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_fail_nonempty.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- example.py:1:1: INP001 File `./resources/test/fixtures/flake8_no_pep420/test_fail_nonempty/example.py` is part of an implicit namespace package. Add an `__init__.py`. diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_ignored.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_ignored.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_ignored.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_ignored.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_init.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_init.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_init.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_init.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_namespace_package.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_namespace_package.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_namespace_package.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_namespace_package.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pep723.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pep723.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pep723.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pep723.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pyi.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pyi.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_script.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_script.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_script.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_script.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_shebang.snap b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_shebang.snap index 624dce32257e8..c5d164d0c1b42 100644 --- a/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_shebang.snap +++ b/crates/ruff_linter/src/rules/flake8_no_pep420/snapshots/ruff_linter__rules__flake8_no_pep420__tests__test_pass_shebang.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_no_pep420/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/duplicate_class_field_definition.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/duplicate_class_field_definition.rs index e50af0ec2fc8c..5474c528fdae0 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/duplicate_class_field_definition.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/duplicate_class_field_definition.rs @@ -2,7 +2,7 @@ use rustc_hash::FxHashSet; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::{AlwaysFixableViolation, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::Ranged; @@ -31,8 +31,8 @@ use crate::fix; /// name = Tom /// ... /// ``` -#[violation] -pub struct DuplicateClassFieldDefinition { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateClassFieldDefinition { name: String, } @@ -50,7 +50,7 @@ impl AlwaysFixableViolation for DuplicateClassFieldDefinition { } /// PIE794 -pub(crate) fn duplicate_class_field_definition(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn duplicate_class_field_definition(checker: &Checker, body: &[Stmt]) { let mut seen_targets: FxHashSet<&str> = FxHashSet::default(); for stmt in body { // Extract the property name from the assignment statement. @@ -105,7 +105,7 @@ pub(crate) fn duplicate_class_field_definition(checker: &mut Checker, body: &[St diagnostic.set_fix(Fix::unsafe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/multiple_starts_ends_with.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/multiple_starts_ends_with.rs index 6eaee62631ac0..62c75c9c1876a 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/multiple_starts_ends_with.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/multiple_starts_ends_with.rs @@ -3,14 +3,14 @@ use std::iter; use itertools::Either::{Left, Right}; -use ruff_python_semantic::{analyze, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze}; use ruff_text_size::{Ranged, TextRange}; use ruff_python_ast::{self as ast, Arguments, BoolOp, Expr, ExprContext, Identifier}; use ruff_diagnostics::AlwaysFixableViolation; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -48,8 +48,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `str.startswith`](https://docs.python.org/3/library/stdtypes.html#str.startswith) /// - [Python documentation: `str.endswith`](https://docs.python.org/3/library/stdtypes.html#str.endswith) -#[violation] -pub struct MultipleStartsEndsWith { +#[derive(ViolationMetadata)] +pub(crate) struct MultipleStartsEndsWith { attr: String, } @@ -67,7 +67,7 @@ impl AlwaysFixableViolation for MultipleStartsEndsWith { } /// PIE810 -pub(crate) fn multiple_starts_ends_with(checker: &mut Checker, expr: &Expr) { +pub(crate) fn multiple_starts_ends_with(checker: &Checker, expr: &Expr) { let Expr::BoolOp(ast::ExprBoolOp { op: BoolOp::Or, values, @@ -219,7 +219,7 @@ pub(crate) fn multiple_starts_ends_with(checker: &mut Checker, expr: &Expr) { checker.generator().expr(&bool_op), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/non_unique_enums.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/non_unique_enums.rs index 3b41b15e75d66..d54919bc3cfba 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/non_unique_enums.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/non_unique_enums.rs @@ -1,10 +1,11 @@ +use ruff_python_semantic::SemanticModel; use rustc_hash::FxHashSet; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::{self as ast, Expr, PySourceType, Stmt}; +use ruff_python_ast::{self as ast, Expr, ExprCall, Stmt}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,8 +41,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `enum.Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) -#[violation] -pub struct NonUniqueEnums { +#[derive(ViolationMetadata)] +pub(crate) struct NonUniqueEnums { value: String, } @@ -54,14 +55,15 @@ impl Violation for NonUniqueEnums { } /// PIE796 -pub(crate) fn non_unique_enums(checker: &mut Checker, parent: &Stmt, body: &[Stmt]) { +pub(crate) fn non_unique_enums(checker: &Checker, parent: &Stmt, body: &[Stmt]) { + let semantic = checker.semantic(); + let Stmt::ClassDef(parent) = parent else { return; }; if !parent.bases().iter().any(|expr| { - checker - .semantic() + semantic .resolve_qualified_name(expr) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["enum", "Enum"])) }) { @@ -74,24 +76,20 @@ pub(crate) fn non_unique_enums(checker: &mut Checker, parent: &Stmt, body: &[Stm continue; }; - if let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() { - if checker - .semantic() - .resolve_qualified_name(func) - .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["enum", "auto"])) - { + if is_call_to_enum_auto(semantic, value) { + continue; + } else if let Expr::Tuple(ast::ExprTuple { elts, .. }) = value.as_ref() { + if elts.iter().any(|elt| is_call_to_enum_auto(semantic, elt)) { continue; } } - let comparable = ComparableExpr::from(value); - - if checker.source_type == PySourceType::Stub - && comparable == ComparableExpr::EllipsisLiteral - { + if checker.source_type.is_stub() && member_has_unknown_value(semantic, value) { continue; } + let comparable = ComparableExpr::from(value); + if !seen_targets.insert(comparable) { let diagnostic = Diagnostic::new( NonUniqueEnums { @@ -99,7 +97,39 @@ pub(crate) fn non_unique_enums(checker: &mut Checker, parent: &Stmt, body: &[Stm }, stmt.range(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); + } + } +} + +fn is_call_to_enum_auto(semantic: &SemanticModel, expr: &Expr) -> bool { + expr.as_call_expr().is_some_and(|call| { + semantic + .resolve_qualified_name(&call.func) + .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["enum", "auto"])) + }) +} + +/// Whether the value is a bare ellipsis literal (`A = ...`) +/// or a casted one (`A = cast(SomeType, ...)`). +fn member_has_unknown_value(semantic: &SemanticModel, expr: &Expr) -> bool { + match expr { + Expr::EllipsisLiteral(_) => true, + + Expr::Call(ExprCall { + func, arguments, .. + }) => { + if !semantic.match_typing_expr(func, "cast") { + return false; + } + + if !arguments.keywords.is_empty() { + return false; + } + + matches!(arguments.args.as_ref(), [_, Expr::EllipsisLiteral(_)]) } + + _ => false, } } diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs index c085d235d1568..0f99c813e8729 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{Expr, ExprLambda}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -37,8 +37,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `list`](https://docs.python.org/3/library/functions.html#func-list) -#[violation] -pub struct ReimplementedContainerBuiltin { +#[derive(ViolationMetadata)] +pub(crate) struct ReimplementedContainerBuiltin { container: Container, } @@ -58,7 +58,7 @@ impl Violation for ReimplementedContainerBuiltin { } /// PIE807 -pub(crate) fn reimplemented_container_builtin(checker: &mut Checker, expr: &ExprLambda) { +pub(crate) fn reimplemented_container_builtin(checker: &Checker, expr: &ExprLambda) { let ExprLambda { parameters, body, @@ -84,7 +84,7 @@ pub(crate) fn reimplemented_container_builtin(checker: &mut Checker, expr: &Expr let binding_edit = Edit::range_replacement(binding, expr.range()); Ok(Fix::safe_edits(binding_edit, import_edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_dict_kwargs.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_dict_kwargs.rs index 4bffddb94acde..d8bba791e07cb 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_dict_kwargs.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_dict_kwargs.rs @@ -1,15 +1,15 @@ use itertools::Itertools; use rustc_hash::{FxBuildHasher, FxHashSet}; -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Expr}; use ruff_python_stdlib::identifiers::is_identifier; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for unnecessary `dict` kwargs. @@ -19,6 +19,7 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// arguments directly. /// /// ## Example +/// /// ```python /// def foo(bar): /// return bar + 1 @@ -28,6 +29,7 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// ``` /// /// Use instead: +/// /// ```python /// def foo(bar): /// return bar + 1 @@ -36,27 +38,47 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// print(foo(bar=2)) # prints 3 /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe for dictionaries with comments interleaved between +/// the items, as comments may be removed. +/// +/// For example, the fix would be marked as unsafe in the following case: +/// +/// ```python +/// foo( +/// **{ +/// # comment +/// "x": 1.0, +/// # comment +/// "y": 2.0, +/// } +/// ) +/// ``` +/// +/// as this is converted to `foo(x=1.0, y=2.0)` without any of the comments. +/// /// ## References /// - [Python documentation: Dictionary displays](https://docs.python.org/3/reference/expressions.html#dictionary-displays) /// - [Python documentation: Calls](https://docs.python.org/3/reference/expressions.html#calls) -#[violation] -pub struct UnnecessaryDictKwargs; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDictKwargs; impl Violation for UnnecessaryDictKwargs { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary `dict` kwargs") + "Unnecessary `dict` kwargs".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Remove unnecessary kwargs")) + Some("Remove unnecessary kwargs".to_string()) } } /// PIE804 -pub(crate) fn unnecessary_dict_kwargs(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_dict_kwargs(checker: &Checker, call: &ast::ExprCall) { let mut duplicate_keywords = None; for keyword in &*call.arguments.keywords { // keyword is a spread operator (indicated by None). @@ -75,9 +97,7 @@ pub(crate) fn unnecessary_dict_kwargs(checker: &mut Checker, call: &ast::ExprCal format!("**{}", checker.locator().slice(value)), keyword.range(), ); - checker - .diagnostics - .push(diagnostic.with_fix(Fix::safe_edit(edit))); + checker.report_diagnostic(diagnostic.with_fix(Fix::safe_edit(edit))); continue; } @@ -115,7 +135,7 @@ pub(crate) fn unnecessary_dict_kwargs(checker: &mut Checker, call: &ast::ExprCal .iter() .all(|kwarg| !duplicate_keywords.contains(kwarg)) { - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + let edit = Edit::range_replacement( kwargs .iter() .zip(dict.iter_values()) @@ -136,12 +156,20 @@ pub(crate) fn unnecessary_dict_kwargs(checker: &mut Checker, call: &ast::ExprCal }) .join(", "), keyword.range(), - ))); + ); + diagnostic.set_fix(Fix::applicable_edit( + edit, + if checker.comment_ranges().intersects(dict.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + )); } } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_placeholder.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_placeholder.rs index 85fafcac08467..e704243b350d3 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_placeholder.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_placeholder.rs @@ -1,9 +1,9 @@ -use ruff_diagnostics::AlwaysFixableViolation; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::whitespace::trailing_comment_start_offset; -use ruff_python_ast::Stmt; +use ruff_python_ast::{Expr, ExprStringLiteral, Stmt, StmtExpr}; use ruff_python_semantic::{ScopeKind, SemanticModel}; use ruff_text_size::Ranged; @@ -51,51 +51,55 @@ use crate::fix; /// """Placeholder docstring.""" /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as unsafe in the rare case that the `pass` or ellipsis +/// is followed by a string literal, since removal of the placeholder would convert the +/// subsequent string literal into a docstring. +/// /// ## References /// - [Python documentation: The `pass` statement](https://docs.python.org/3/reference/simple_stmts.html#the-pass-statement) -#[violation] -pub struct UnnecessaryPlaceholder { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryPlaceholder { kind: Placeholder, } impl AlwaysFixableViolation for UnnecessaryPlaceholder { #[derive_message_formats] fn message(&self) -> String { - let Self { kind } = self; - match kind { - Placeholder::Pass => format!("Unnecessary `pass` statement"), - Placeholder::Ellipsis => format!("Unnecessary `...` literal"), + match &self.kind { + Placeholder::Pass => "Unnecessary `pass` statement".to_string(), + Placeholder::Ellipsis => "Unnecessary `...` literal".to_string(), } } fn fix_title(&self) -> String { - let Self { kind } = self; - match kind { - Placeholder::Pass => format!("Remove unnecessary `pass`"), - Placeholder::Ellipsis => format!("Remove unnecessary `...`"), - } + let title = match &self.kind { + Placeholder::Pass => "Remove unnecessary `pass`", + Placeholder::Ellipsis => "Remove unnecessary `...`", + }; + title.to_string() } } /// PIE790 -pub(crate) fn unnecessary_placeholder(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn unnecessary_placeholder(checker: &Checker, body: &[Stmt]) { if body.len() < 2 { return; } - for stmt in body { + for (index, stmt) in body.iter().enumerate() { let kind = match stmt { Stmt::Pass(_) => Placeholder::Pass, Stmt::Expr(expr) if expr.value.is_ellipsis_literal_expr() => { - // In a type-checking block, a trailing ellipsis might be meaningful. A - // user might be using the type-checking context to declare a stub. + // In a type-checking block, a trailing ellipsis might be meaningful. + // A user might be using the type-checking context to declare a stub. if checker.semantic().in_type_checking_block() { return; } - // Ellipses are significant in protocol methods and abstract methods. Specifically, - // Pyright uses the presence of an ellipsis to indicate that a method is a stub, - // rather than a default implementation. + // Ellipses are significant in protocol methods and abstract methods. + // Specifically, Pyright uses the presence of an ellipsis to indicate that + // a method is a stub, rather than a default implementation. if in_protocol_or_abstract_method(checker.semantic()) { return; } @@ -104,19 +108,46 @@ pub(crate) fn unnecessary_placeholder(checker: &mut Checker, body: &[Stmt]) { _ => continue, }; - let mut diagnostic = Diagnostic::new(UnnecessaryPlaceholder { kind }, stmt.range()); - let edit = if let Some(index) = trailing_comment_start_offset(stmt, checker.source()) { - Edit::range_deletion(stmt.range().add_end(index)) - } else { - fix::edits::delete_stmt(stmt, None, checker.locator(), checker.indexer()) - }; - diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( - checker.semantic().current_statement_id(), - ))); - checker.diagnostics.push(diagnostic); + let next_stmt = body.get(index + 1); + add_diagnostic(checker, stmt, next_stmt, kind); } } +/// Add a diagnostic for the given statement. +fn add_diagnostic( + checker: &Checker, + stmt: &Stmt, + next_stmt: Option<&Stmt>, + placeholder_kind: Placeholder, +) { + let edit = if let Some(index) = trailing_comment_start_offset(stmt, checker.source()) { + Edit::range_deletion(stmt.range().add_end(index)) + } else { + fix::edits::delete_stmt(stmt, None, checker.locator(), checker.indexer()) + }; + let applicability = match next_stmt { + // Mark the fix as unsafe if the following statement is a string literal, + // as it will become the module/class/function's docstring after the fix. + Some(Stmt::Expr(StmtExpr { value, .. })) => match value.as_ref() { + Expr::StringLiteral(ExprStringLiteral { .. }) => Applicability::Unsafe, + _ => Applicability::Safe, + }, + _ => Applicability::Safe, + }; + + let isolation_level = Checker::isolation(checker.semantic().current_statement_id()); + let fix = Fix::applicable_edit(edit, applicability).isolate(isolation_level); + + let diagnostic = Diagnostic::new( + UnnecessaryPlaceholder { + kind: placeholder_kind, + }, + stmt.range(), + ); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + #[derive(Debug, PartialEq, Eq)] enum Placeholder { Pass, diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_range_start.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_range_start.rs index 86dfaa673d7bb..b046df61d0f79 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_range_start.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_range_start.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::{AlwaysFixableViolation, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for `range` calls with an unnecessary `start` argument. @@ -27,22 +27,22 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// /// ## References /// - [Python documentation: `range`](https://docs.python.org/3/library/stdtypes.html#range) -#[violation] -pub struct UnnecessaryRangeStart; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryRangeStart; impl AlwaysFixableViolation for UnnecessaryRangeStart { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary `start` argument in `range`") + "Unnecessary `start` argument in `range`".to_string() } fn fix_title(&self) -> String { - format!("Remove `start` argument") + "Remove `start` argument".to_string() } } /// PIE808 -pub(crate) fn unnecessary_range_start(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_range_start(checker: &Checker, call: &ast::ExprCall) { // `range` doesn't accept keyword arguments. if !call.arguments.keywords.is_empty() { return; @@ -63,12 +63,12 @@ pub(crate) fn unnecessary_range_start(checker: &mut Checker, call: &ast::ExprCal }; if *value != 0 { return; - }; + } // Verify that the call is to the `range` builtin. if !checker.semantic().match_builtin_expr(&call.func, "range") { return; - }; + } let mut diagnostic = Diagnostic::new(UnnecessaryRangeStart, start.range()); diagnostic.try_set_fix(|| { @@ -80,5 +80,5 @@ pub(crate) fn unnecessary_range_start(checker: &mut Checker, call: &ast::ExprCal ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_spread.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_spread.rs index 8bff1abe68729..e1d3eed5b9db2 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_spread.rs +++ b/crates/ruff_linter/src/rules/flake8_pie/rules/unnecessary_spread.rs @@ -1,11 +1,10 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; -use ruff_text_size::{Ranged, TextSize}; +use ruff_python_parser::{TokenKind, Tokens}; +use ruff_text_size::{Ranged, TextLen, TextSize}; use crate::checkers::ast::Checker; -use crate::Locator; /// ## What it does /// Checks for unnecessary dictionary unpacking operators (`**`). @@ -28,24 +27,24 @@ use crate::Locator; /// /// ## References /// - [Python documentation: Dictionary displays](https://docs.python.org/3/reference/expressions.html#dictionary-displays) -#[violation] -pub struct UnnecessarySpread; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessarySpread; impl Violation for UnnecessarySpread { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary spread `**`") + "Unnecessary spread `**`".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Remove unnecessary dict")) + Some("Remove unnecessary dict".to_string()) } } /// PIE800 -pub(crate) fn unnecessary_spread(checker: &mut Checker, dict: &ast::ExprDict) { +pub(crate) fn unnecessary_spread(checker: &Checker, dict: &ast::ExprDict) { // The first "end" is the start of the dictionary, immediately following the open bracket. let mut prev_end = dict.start() + TextSize::from(1); for ast::DictItem { key, value } in dict { @@ -54,10 +53,10 @@ pub(crate) fn unnecessary_spread(checker: &mut Checker, dict: &ast::ExprDict) { // inside a dict. if let Expr::Dict(inner) = value { let mut diagnostic = Diagnostic::new(UnnecessarySpread, value.range()); - if let Some(fix) = unnecessary_spread_fix(inner, prev_end, checker.locator()) { + if let Some(fix) = unnecessary_spread_fix(inner, prev_end, checker.tokens()) { diagnostic.set_fix(fix); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } prev_end = value.end(); @@ -68,38 +67,81 @@ pub(crate) fn unnecessary_spread(checker: &mut Checker, dict: &ast::ExprDict) { fn unnecessary_spread_fix( dict: &ast::ExprDict, prev_end: TextSize, - locator: &Locator, + tokens: &Tokens, ) -> Option<Fix> { // Find the `**` token preceding the spread. - let doublestar = SimpleTokenizer::starts_at(prev_end, locator.contents()) - .find(|tok| matches!(tok.kind(), SimpleTokenKind::DoubleStar))?; - - if let Some(last) = dict.iter_values().last() { - // Ex) `**{a: 1, b: 2}` - let mut edits = vec![]; - for tok in SimpleTokenizer::starts_at(last.end(), locator.contents()).skip_trivia() { - match tok.kind() { - SimpleTokenKind::Comma => { - edits.push(Edit::range_deletion(tok.range())); + let doublestar = tokens + .after(prev_end) + .iter() + .find(|tok| matches!(tok.kind(), TokenKind::DoubleStar))?; + + let (empty, last_value_end) = if let Some(last) = dict.iter_values().last() { + (false, last.end()) + } else { + (true, dict.start() + "{".text_len()) + }; + + let mut edits = vec![]; + let mut open_parens: u32 = 0; + + for tok in tokens.after(doublestar.end()) { + match tok.kind() { + kind if kind.is_trivia() => {} + TokenKind::Lpar => { + edits.push(Edit::range_deletion(tok.range())); + open_parens += 1; + } + TokenKind::Lbrace => { + edits.push(Edit::range_deletion(tok.range())); + break; + } + _ => { + // Unexpected token, bail + return None; + } + } + } + + let mut found_r_curly = false; + let mut found_dict_comma = false; + + for tok in tokens.after(last_value_end) { + if found_r_curly && open_parens == 0 && (!empty || found_dict_comma) { + break; + } + + match tok.kind() { + kind if kind.is_trivia() => {} + TokenKind::Comma => { + edits.push(Edit::range_deletion(tok.range())); + + if found_r_curly { + found_dict_comma = true; } - SimpleTokenKind::RBrace => { + } + TokenKind::Rpar => { + if found_r_curly { edits.push(Edit::range_deletion(tok.range())); + open_parens -= 1; + } + } + TokenKind::Rbrace => { + if found_r_curly { break; } - _ => {} + + edits.push(Edit::range_deletion(tok.range())); + found_r_curly = true; + } + _ => { + // Unexpected token, bail + return None; } } - Some(Fix::safe_edits( - // Delete the first `**{` - Edit::deletion(doublestar.start(), dict.start() + TextSize::from(1)), - // Delete the trailing `}` - edits, - )) - } else { - // Ex) `**{}` - Some(Fix::safe_edit(Edit::deletion( - doublestar.start(), - dict.end(), - ))) } + + Some(Fix::safe_edits( + Edit::range_deletion(doublestar.range()), + edits, + )) } diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE790_PIE790.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE790_PIE790.py.snap index b2356b7f347a8..8fcca36699435 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE790_PIE790.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE790_PIE790.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pie/mod.rs PIE790.py:4:5: PIE790 [*] Unnecessary `pass` statement | 2 | """buzz""" -3 | +3 | 4 | pass | ^^^^ PIE790 | @@ -131,7 +131,7 @@ PIE790.py:42:5: PIE790 [*] Unnecessary `pass` statement PIE790.py:50:5: PIE790 [*] Unnecessary `pass` statement | 48 | """ -49 | +49 | 50 | pass | ^^^^ PIE790 | @@ -149,7 +149,7 @@ PIE790.py:50:5: PIE790 [*] Unnecessary `pass` statement PIE790.py:58:5: PIE790 [*] Unnecessary `pass` statement | 56 | """ -57 | +57 | 58 | pass | ^^^^ PIE790 | @@ -208,7 +208,7 @@ PIE790.py:79:5: PIE790 [*] Unnecessary `pass` statement 78 | """buzz""" 79 | pass | ^^^^ PIE790 -80 | +80 | 81 | async for _ in range(10): | = help: Remove unnecessary `pass` @@ -228,7 +228,7 @@ PIE790.py:83:5: PIE790 [*] Unnecessary `pass` statement 82 | """buzz""" 83 | pass | ^^^^ PIE790 -84 | +84 | 85 | while cond: | = help: Remove unnecessary `pass` @@ -266,7 +266,7 @@ PIE790.py:92:5: PIE790 [*] Unnecessary `pass` statement 91 | """buzz""" 92 | pass | ^^^^ PIE790 -93 | +93 | 94 | async with bar: | = help: Remove unnecessary `pass` @@ -377,7 +377,7 @@ PIE790.py:141:5: PIE790 [*] Unnecessary `pass` statement 140 | pass 141 | pass | ^^^^ PIE790 -142 | +142 | 143 | for i in range(10): | = help: Remove unnecessary `pass` @@ -396,7 +396,7 @@ PIE790.py:144:5: PIE790 [*] Unnecessary `pass` statement 143 | for i in range(10): 144 | pass | ^^^^ PIE790 -145 | +145 | 146 | pass | = help: Remove unnecessary `pass` @@ -413,10 +413,10 @@ PIE790.py:144:5: PIE790 [*] Unnecessary `pass` statement PIE790.py:146:5: PIE790 [*] Unnecessary `pass` statement | 144 | pass -145 | +145 | 146 | pass | ^^^^ PIE790 -147 | +147 | 148 | for i in range(10): | = help: Remove unnecessary `pass` @@ -527,7 +527,7 @@ PIE790.py:166:5: PIE790 [*] Unnecessary `...` literal 165 | ... 166 | ... | ^^^ PIE790 -167 | +167 | 168 | for i in range(10): | = help: Remove unnecessary `...` @@ -546,7 +546,7 @@ PIE790.py:169:5: PIE790 [*] Unnecessary `...` literal 168 | for i in range(10): 169 | ... | ^^^ PIE790 -170 | +170 | 171 | ... | = help: Remove unnecessary `...` @@ -563,10 +563,10 @@ PIE790.py:169:5: PIE790 [*] Unnecessary `...` literal PIE790.py:171:5: PIE790 [*] Unnecessary `...` literal | 169 | ... -170 | +170 | 171 | ... | ^^^ PIE790 -172 | +172 | 173 | for i in range(10): | = help: Remove unnecessary `...` @@ -605,7 +605,7 @@ PIE790.py:175:5: PIE790 [*] Unnecessary `...` literal 174 | ... # comment 175 | ... | ^^^ PIE790 -176 | +176 | 177 | for i in range(10): | = help: Remove unnecessary `...` @@ -643,7 +643,7 @@ PIE790.py:179:5: PIE790 [*] Unnecessary `pass` statement 178 | ... 179 | pass | ^^^^ PIE790 -180 | +180 | 181 | from typing import Protocol | = help: Remove unnecessary `pass` @@ -675,4 +675,38 @@ PIE790.py:209:9: PIE790 [*] Unnecessary `...` literal 211 210 | 212 211 | class Repro(Protocol[int]): +PIE790.py:241:5: PIE790 [*] Unnecessary `pass` statement + | +239 | # https://github.com/astral-sh/ruff/issues/12616 +240 | class PotentialDocstring1: +241 | pass + | ^^^^ PIE790 +242 | """ +243 | Lorem ipsum dolor sit amet. + | + = help: Remove unnecessary `pass` + +ℹ Unsafe fix +238 238 | +239 239 | # https://github.com/astral-sh/ruff/issues/12616 +240 240 | class PotentialDocstring1: +241 |- pass +242 241 | """ +243 242 | Lorem ipsum dolor sit amet. +244 243 | """ + +PIE790.py:248:5: PIE790 [*] Unnecessary `...` literal + | +247 | class PotentialDocstring2: +248 | ... + | ^^^ PIE790 +249 | 'Lorem ipsum dolor sit amet.' + | + = help: Remove unnecessary `...` +ℹ Unsafe fix +245 245 | +246 246 | +247 247 | class PotentialDocstring2: +248 |- ... +249 248 | 'Lorem ipsum dolor sit amet.' diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE794_PIE794.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE794_PIE794.py.snap index f5945563ffb5f..3e6e4df3d580b 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE794_PIE794.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE794_PIE794.py.snap @@ -7,7 +7,7 @@ PIE794.py:4:5: PIE794 [*] Class field `name` is defined multiple times 3 | # .... 4 | name = StringField() # PIE794 | ^^^^^^^^^^^^^^^^^^^^ PIE794 -5 | +5 | 6 | def remove(self) -> None: | = help: Remove duplicate field definition for `name` @@ -27,7 +27,7 @@ PIE794.py:13:5: PIE794 [*] Class field `name` is defined multiple times 12 | # .... 13 | name = StringField() # PIE794 | ^^^^^^^^^^^^^^^^^^^^ PIE794 -14 | +14 | 15 | def foo(self) -> None: | = help: Remove duplicate field definition for `name` @@ -109,5 +109,3 @@ PIE794.py:52:5: PIE794 [*] Class field `name` is defined multiple times 50 50 | name: str = "Foo" 51 51 | name: str = name + " Bar" 52 |- name: str = "Bar" # PIE794 - - diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.py.snap index e10325ed1b541..cad6da6d9d605 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pie/mod.rs +snapshot_kind: text --- PIE796.py:8:5: PIE796 Enum contains duplicate value: `"B"` | @@ -74,4 +75,19 @@ PIE796.py:72:5: PIE796 Enum contains duplicate value: `...` | ^^^^^^^ PIE796 | +PIE796.py:79:5: PIE796 Enum contains duplicate value: `cast(SomeType, ...)` + | +77 | class FakeEnum11(enum.Enum): +78 | A = cast(SomeType, ...) +79 | B = cast(SomeType, ...) # PIE796 + | ^^^^^^^^^^^^^^^^^^^^^^^ PIE796 +80 | C = cast(SomeType, ...) # PIE796 + | +PIE796.py:80:5: PIE796 Enum contains duplicate value: `cast(SomeType, ...)` + | +78 | A = cast(SomeType, ...) +79 | B = cast(SomeType, ...) # PIE796 +80 | C = cast(SomeType, ...) # PIE796 + | ^^^^^^^^^^^^^^^^^^^^^^^ PIE796 + | diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.pyi.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.pyi.snap index 5c6e954faaa5a..4f0d8e6042f8b 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE796_PIE796.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pie/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE800_PIE800.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE800_PIE800.py.snap index 217e4c71f3a21..6eb78b21f6ed5 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE800_PIE800.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE800_PIE800.py.snap @@ -5,7 +5,7 @@ PIE800.py:1:14: PIE800 [*] Unnecessary spread `**` | 1 | {"foo": 1, **{"bar": 1}} # PIE800 | ^^^^^^^^^^ PIE800 -2 | +2 | 3 | {**{"bar": 10}, "a": "b"} # PIE800 | = help: Remove unnecessary dict @@ -20,10 +20,10 @@ PIE800.py:1:14: PIE800 [*] Unnecessary spread `**` PIE800.py:3:4: PIE800 [*] Unnecessary spread `**` | 1 | {"foo": 1, **{"bar": 1}} # PIE800 -2 | +2 | 3 | {**{"bar": 10}, "a": "b"} # PIE800 | ^^^^^^^^^^^ PIE800 -4 | +4 | 5 | foo({**foo, **{"bar": True}}) # PIE800 | = help: Remove unnecessary dict @@ -40,10 +40,10 @@ PIE800.py:3:4: PIE800 [*] Unnecessary spread `**` PIE800.py:5:15: PIE800 [*] Unnecessary spread `**` | 3 | {**{"bar": 10}, "a": "b"} # PIE800 -4 | +4 | 5 | foo({**foo, **{"bar": True}}) # PIE800 | ^^^^^^^^^^^^^ PIE800 -6 | +6 | 7 | {**foo, **{"bar": 10}} # PIE800 | = help: Remove unnecessary dict @@ -61,10 +61,10 @@ PIE800.py:5:15: PIE800 [*] Unnecessary spread `**` PIE800.py:7:11: PIE800 [*] Unnecessary spread `**` | 5 | foo({**foo, **{"bar": True}}) # PIE800 -6 | +6 | 7 | {**foo, **{"bar": 10}} # PIE800 | ^^^^^^^^^^^ PIE800 -8 | +8 | 9 | { # PIE800 | = help: Remove unnecessary dict @@ -113,11 +113,11 @@ PIE800.py:12:7: PIE800 [*] Unnecessary spread `**` PIE800.py:19:19: PIE800 [*] Unnecessary spread `**` | 17 | } -18 | +18 | 19 | {**foo, **buzz, **{bar: 10}} # PIE800 | ^^^^^^^^^ PIE800 -20 | -21 | {**foo, "bar": True } # OK +20 | +21 | # https://github.com/astral-sh/ruff/issues/15366 | = help: Remove unnecessary dict @@ -128,7 +128,335 @@ PIE800.py:19:19: PIE800 [*] Unnecessary spread `**` 19 |-{**foo, **buzz, **{bar: 10}} # PIE800 19 |+{**foo, **buzz, bar: 10} # PIE800 20 20 | -21 21 | {**foo, "bar": True } # OK -22 22 | +21 21 | # https://github.com/astral-sh/ruff/issues/15366 +22 22 | { +PIE800.py:24:8: PIE800 [*] Unnecessary spread `**` + | +22 | { +23 | "data": [], +24 | **({"count": 1 if include_count else {}}), + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PIE800 +25 | } + | + = help: Remove unnecessary dict + +ℹ Safe fix +21 21 | # https://github.com/astral-sh/ruff/issues/15366 +22 22 | { +23 23 | "data": [], +24 |- **({"count": 1 if include_count else {}}), + 24 |+ "count": 1 if include_count else {}, +25 25 | } +26 26 | +27 27 | { + +PIE800.py:30:9: PIE800 [*] Unnecessary spread `**` + | +28 | "data": [], +29 | **( # Comment +30 | / { # Comment +31 | | "count": 1 if include_count else {}}), + | |________________________________________________^ PIE800 +32 | } + | + = help: Remove unnecessary dict + +ℹ Safe fix +26 26 | +27 27 | { +28 28 | "data": [], +29 |- **( # Comment +30 |- { # Comment +31 |- "count": 1 if include_count else {}}), + 29 |+ # Comment + 30 |+ # Comment + 31 |+ "count": 1 if include_count else {}, +32 32 | } +33 33 | +34 34 | { + +PIE800.py:37:9: PIE800 [*] Unnecessary spread `**` + | +35 | "data": [], +36 | **( +37 | / { +38 | | "count": (a := 1),}), + | |_______________________________^ PIE800 +39 | } + | + = help: Remove unnecessary dict + +ℹ Safe fix +33 33 | +34 34 | { +35 35 | "data": [], +36 |- **( +37 |- { +38 |- "count": (a := 1),}), + 36 |+ + 37 |+ + 38 |+ "count": (a := 1), +39 39 | } +40 40 | +41 41 | { + +PIE800.py:44:9: PIE800 [*] Unnecessary spread `**` + | +42 | "data": [], +43 | **( +44 | / { +45 | | "count": (a := 1) +46 | | } + | |_____________^ PIE800 +47 | ) +48 | , + | + = help: Remove unnecessary dict + +ℹ Safe fix +40 40 | +41 41 | { +42 42 | "data": [], +43 |- **( +44 |- { + 43 |+ + 44 |+ +45 45 | "count": (a := 1) +46 |- } +47 |- ) + 46 |+ + 47 |+ +48 48 | , +49 49 | } +50 50 | + +PIE800.py:54:9: PIE800 [*] Unnecessary spread `**` + | +52 | "data": [], +53 | **( +54 | / { +55 | | "count": (a := 1), # Comment +56 | | } # Comment + | |_____________^ PIE800 +57 | ) # Comment +58 | , + | + = help: Remove unnecessary dict + +ℹ Safe fix +50 50 | +51 51 | { +52 52 | "data": [], +53 |- **( +54 |- { +55 |- "count": (a := 1), # Comment +56 |- } # Comment +57 |- ) # Comment + 53 |+ + 54 |+ + 55 |+ "count": (a := 1) # Comment + 56 |+ # Comment + 57 |+ # Comment +58 58 | , +59 59 | } +60 60 | + +PIE800.py:65:1: PIE800 [*] Unnecessary spread `**` + | +63 | **( # Comment +64 | ( # Comment +65 | / { # Comment +66 | | "count": (a := 1), # Comment +67 | | } # Comment + | |_________^ PIE800 +68 | ) +69 | ) # Comment + | + = help: Remove unnecessary dict + +ℹ Safe fix +60 60 | +61 61 | ({ +62 62 | "data": [], +63 |- **( # Comment +64 |- ( # Comment +65 |-{ # Comment +66 |- "count": (a := 1), # Comment +67 |- } # Comment +68 |- ) +69 |- ) # Comment + 63 |+ # Comment + 64 |+ # Comment + 65 |+ # Comment + 66 |+ "count": (a := 1) # Comment + 67 |+ # Comment + 68 |+ + 69 |+ # Comment +70 70 | , +71 71 | }) +72 72 | + +PIE800.py:77:9: PIE800 [*] Unnecessary spread `**` + | +75 | ** # Foo +76 | ( # Comment +77 | / { "a": b, +78 | | # Comment +79 | | } + | |___________^ PIE800 +80 | ) , +81 | c: 9, + | + = help: Remove unnecessary dict + +ℹ Safe fix +72 72 | +73 73 | { +74 74 | "data": [], +75 |- ** # Foo +76 |- ( # Comment +77 |- { "a": b, + 75 |+ # Foo + 76 |+ # Comment + 77 |+ "a": b +78 78 | # Comment +79 |- } +80 |- ) , + 79 |+ + 80 |+ , +81 81 | c: 9, +82 82 | } +83 83 | + +PIE800.py:86:13: PIE800 [*] Unnecessary spread `**` + | +85 | # https://github.com/astral-sh/ruff/issues/15997 +86 | {"a": [], **{},} + | ^^ PIE800 +87 | {"a": [], **({}),} + | + = help: Remove unnecessary dict + +ℹ Safe fix +83 83 | +84 84 | +85 85 | # https://github.com/astral-sh/ruff/issues/15997 +86 |-{"a": [], **{},} + 86 |+{"a": [], } +87 87 | {"a": [], **({}),} +88 88 | +89 89 | {"a": [], **{}, 6: 3} + +PIE800.py:87:14: PIE800 [*] Unnecessary spread `**` + | +85 | # https://github.com/astral-sh/ruff/issues/15997 +86 | {"a": [], **{},} +87 | {"a": [], **({}),} + | ^^ PIE800 +88 | +89 | {"a": [], **{}, 6: 3} + | + = help: Remove unnecessary dict + +ℹ Safe fix +84 84 | +85 85 | # https://github.com/astral-sh/ruff/issues/15997 +86 86 | {"a": [], **{},} +87 |-{"a": [], **({}),} + 87 |+{"a": [], } +88 88 | +89 89 | {"a": [], **{}, 6: 3} +90 90 | {"a": [], **({}), 6: 3} + +PIE800.py:89:13: PIE800 [*] Unnecessary spread `**` + | +87 | {"a": [], **({}),} +88 | +89 | {"a": [], **{}, 6: 3} + | ^^ PIE800 +90 | {"a": [], **({}), 6: 3} + | + = help: Remove unnecessary dict +ℹ Safe fix +86 86 | {"a": [], **{},} +87 87 | {"a": [], **({}),} +88 88 | +89 |-{"a": [], **{}, 6: 3} + 89 |+{"a": [], 6: 3} +90 90 | {"a": [], **({}), 6: 3} +91 91 | +92 92 | {"a": [], **{ + +PIE800.py:90:14: PIE800 [*] Unnecessary spread `**` + | +89 | {"a": [], **{}, 6: 3} +90 | {"a": [], **({}), 6: 3} + | ^^ PIE800 +91 | +92 | {"a": [], **{ + | + = help: Remove unnecessary dict + +ℹ Safe fix +87 87 | {"a": [], **({}),} +88 88 | +89 89 | {"a": [], **{}, 6: 3} +90 |-{"a": [], **({}), 6: 3} + 90 |+{"a": [], 6: 3} +91 91 | +92 92 | {"a": [], **{ +93 93 | # Comment + +PIE800.py:92:13: PIE800 [*] Unnecessary spread `**` + | +90 | {"a": [], **({}), 6: 3} +91 | +92 | {"a": [], **{ + | _____________^ +93 | | # Comment +94 | | }, 6: 3} + | |_^ PIE800 +95 | {"a": [], **({ +96 | # Comment + | + = help: Remove unnecessary dict + +ℹ Safe fix +89 89 | {"a": [], **{}, 6: 3} +90 90 | {"a": [], **({}), 6: 3} +91 91 | +92 |-{"a": [], **{ + 92 |+{"a": [], +93 93 | # Comment +94 |-}, 6: 3} + 94 |+ 6: 3} +95 95 | {"a": [], **({ +96 96 | # Comment +97 97 | }), 6: 3} + +PIE800.py:95:14: PIE800 [*] Unnecessary spread `**` + | +93 | # Comment +94 | }, 6: 3} +95 | {"a": [], **({ + | ______________^ +96 | | # Comment +97 | | }), 6: 3} + | |_^ PIE800 + | + = help: Remove unnecessary dict + +ℹ Safe fix +92 92 | {"a": [], **{ +93 93 | # Comment +94 94 | }, 6: 3} +95 |-{"a": [], **({ + 95 |+{"a": [], +96 96 | # Comment +97 |-}), 6: 3} + 97 |+ 6: 3} +98 98 | +99 99 | +100 100 | {**foo, "bar": True } # OK diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE804_PIE804.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE804_PIE804.py.snap index b6a65ca50d257..68e4f648e62bf 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE804_PIE804.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE804_PIE804.py.snap @@ -5,7 +5,7 @@ PIE804.py:1:5: PIE804 [*] Unnecessary `dict` kwargs | 1 | foo(**{"bar": True}) # PIE804 | ^^^^^^^^^^^^^^^ PIE804 -2 | +2 | 3 | foo(**{"r2d2": True}) # PIE804 | = help: Remove unnecessary kwargs @@ -20,10 +20,10 @@ PIE804.py:1:5: PIE804 [*] Unnecessary `dict` kwargs PIE804.py:3:5: PIE804 [*] Unnecessary `dict` kwargs | 1 | foo(**{"bar": True}) # PIE804 -2 | +2 | 3 | foo(**{"r2d2": True}) # PIE804 | ^^^^^^^^^^^^^^^^ PIE804 -4 | +4 | 5 | Foo.objects.create(**{"bar": True}) # PIE804 | = help: Remove unnecessary kwargs @@ -40,10 +40,10 @@ PIE804.py:3:5: PIE804 [*] Unnecessary `dict` kwargs PIE804.py:5:20: PIE804 [*] Unnecessary `dict` kwargs | 3 | foo(**{"r2d2": True}) # PIE804 -4 | +4 | 5 | Foo.objects.create(**{"bar": True}) # PIE804 | ^^^^^^^^^^^^^^^ PIE804 -6 | +6 | 7 | Foo.objects.create(**{"_id": some_id}) # PIE804 | = help: Remove unnecessary kwargs @@ -61,10 +61,10 @@ PIE804.py:5:20: PIE804 [*] Unnecessary `dict` kwargs PIE804.py:7:20: PIE804 [*] Unnecessary `dict` kwargs | 5 | Foo.objects.create(**{"bar": True}) # PIE804 -6 | +6 | 7 | Foo.objects.create(**{"_id": some_id}) # PIE804 | ^^^^^^^^^^^^^^^^^^ PIE804 -8 | +8 | 9 | Foo.objects.create(**{**bar}) # PIE804 | = help: Remove unnecessary kwargs @@ -82,10 +82,10 @@ PIE804.py:7:20: PIE804 [*] Unnecessary `dict` kwargs PIE804.py:9:20: PIE804 [*] Unnecessary `dict` kwargs | 7 | Foo.objects.create(**{"_id": some_id}) # PIE804 - 8 | + 8 | 9 | Foo.objects.create(**{**bar}) # PIE804 | ^^^^^^^^^ PIE804 -10 | +10 | 11 | foo(**{}) | = help: Remove unnecessary kwargs @@ -103,10 +103,10 @@ PIE804.py:9:20: PIE804 [*] Unnecessary `dict` kwargs PIE804.py:11:5: PIE804 [*] Unnecessary `dict` kwargs | 9 | Foo.objects.create(**{**bar}) # PIE804 -10 | +10 | 11 | foo(**{}) | ^^^^ PIE804 -12 | +12 | 13 | foo(**{**data, "foo": "buzz"}) | = help: Remove unnecessary kwargs @@ -127,7 +127,7 @@ PIE804.py:22:5: PIE804 [*] Unnecessary `dict` kwargs 21 | abc(**{"for": 3}) 22 | foo(**{},) | ^^^^ PIE804 -23 | +23 | 24 | # Duplicated key names won't be fixed, to avoid syntax errors. | = help: Remove unnecessary kwargs @@ -166,7 +166,7 @@ PIE804.py:26:10: PIE804 Unnecessary `dict` kwargs 25 | abc(**{'a': b}, **{'a': c}) # PIE804 26 | abc(a=1, **{'a': c}, **{'b': c}) # PIE804 | ^^^^^^^^^^ PIE804 -27 | +27 | 28 | # Some values need to be parenthesized. | = help: Remove unnecessary kwargs @@ -177,7 +177,7 @@ PIE804.py:26:22: PIE804 [*] Unnecessary `dict` kwargs 25 | abc(**{'a': b}, **{'a': c}) # PIE804 26 | abc(a=1, **{'a': c}, **{'b': c}) # PIE804 | ^^^^^^^^^^ PIE804 -27 | +27 | 28 | # Some values need to be parenthesized. | = help: Remove unnecessary kwargs @@ -208,6 +208,8 @@ PIE804.py:29:12: PIE804 [*] Unnecessary `dict` kwargs 29 |-abc(foo=1, **{'bar': (bar := 1)}) # PIE804 29 |+abc(foo=1, bar=(bar := 1)) # PIE804 30 30 | abc(foo=1, **{'bar': (yield 1)}) # PIE804 +31 31 | +32 32 | # https://github.com/astral-sh/ruff/issues/18036 PIE804.py:30:12: PIE804 [*] Unnecessary `dict` kwargs | @@ -215,6 +217,8 @@ PIE804.py:30:12: PIE804 [*] Unnecessary `dict` kwargs 29 | abc(foo=1, **{'bar': (bar := 1)}) # PIE804 30 | abc(foo=1, **{'bar': (yield 1)}) # PIE804 | ^^^^^^^^^^^^^^^^^^^^ PIE804 +31 | +32 | # https://github.com/astral-sh/ruff/issues/18036 | = help: Remove unnecessary kwargs @@ -224,3 +228,34 @@ PIE804.py:30:12: PIE804 [*] Unnecessary `dict` kwargs 29 29 | abc(foo=1, **{'bar': (bar := 1)}) # PIE804 30 |-abc(foo=1, **{'bar': (yield 1)}) # PIE804 30 |+abc(foo=1, bar=(yield 1)) # PIE804 +31 31 | +32 32 | # https://github.com/astral-sh/ruff/issues/18036 +33 33 | # The autofix for this is unsafe due to the comments inside the dictionary. + +PIE804.py:35:5: PIE804 [*] Unnecessary `dict` kwargs + | +33 | # The autofix for this is unsafe due to the comments inside the dictionary. +34 | foo( +35 | / **{ +36 | | # Comment 1 +37 | | "x": 1.0, +38 | | # Comment 2 +39 | | "y": 2.0, +40 | | } + | |_____^ PIE804 +41 | ) + | + = help: Remove unnecessary kwargs + +ℹ Unsafe fix +32 32 | # https://github.com/astral-sh/ruff/issues/18036 +33 33 | # The autofix for this is unsafe due to the comments inside the dictionary. +34 34 | foo( +35 |- **{ +36 |- # Comment 1 +37 |- "x": 1.0, +38 |- # Comment 2 +39 |- "y": 2.0, +40 |- } + 35 |+ x=1.0, y=2.0 +41 36 | ) diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap index 474c3456d53f9..dac3e255b8513 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pie/mod.rs +snapshot_kind: text --- PIE807.py:3:44: PIE807 [*] Prefer `list` over useless lambda | @@ -114,5 +115,3 @@ PIE807.py:14:36: PIE807 [*] Prefer `dict` over useless lambda 15 15 | 16 16 | 17 17 | @dataclass - - diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE808_PIE808.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE808_PIE808.py.snap index 91c5932b028c7..86f5cb633258e 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE808_PIE808.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE808_PIE808.py.snap @@ -6,7 +6,7 @@ PIE808.py:2:7: PIE808 [*] Unnecessary `start` argument in `range` 1 | # PIE808 2 | range(0, 10) | ^ PIE808 -3 | +3 | 4 | import builtins | = help: Remove `start` argument @@ -24,7 +24,7 @@ PIE808.py:5:16: PIE808 [*] Unnecessary `start` argument in `range` 4 | import builtins 5 | builtins.range(0, 10) | ^ PIE808 -6 | +6 | 7 | # OK | = help: Remove `start` argument diff --git a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE810_PIE810.py.snap b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE810_PIE810.py.snap index d2d29d693f350..929042cc47079 100644 --- a/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE810_PIE810.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE810_PIE810.py.snap @@ -88,7 +88,7 @@ PIE810.py:10:1: PIE810 [*] Call `startswith` once with a `tuple` 9 | # error 10 | obj.endswith(foo) or obj.startswith(foo) or obj.startswith("foo") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PIE810 -11 | +11 | 12 | def func(): | = help: Merge into a single `startswith` call @@ -106,7 +106,7 @@ PIE810.py:10:1: PIE810 [*] Call `startswith` once with a `tuple` PIE810.py:19:8: PIE810 [*] Call `startswith` once with a `tuple` | 17 | z = "w" -18 | +18 | 19 | if msg.startswith(x) or msg.startswith(y) or msg.startswith(z): # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PIE810 20 | print("yes") @@ -126,7 +126,7 @@ PIE810.py:19:8: PIE810 [*] Call `startswith` once with a `tuple` PIE810.py:25:8: PIE810 [*] Call `startswith` once with a `tuple` | 23 | msg = "hello world" -24 | +24 | 25 | if msg.startswith(("h", "e", "l", "l", "o")) or msg.startswith("h") or msg.startswith("w"): # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PIE810 26 | print("yes") @@ -143,4 +143,20 @@ PIE810.py:25:8: PIE810 [*] Call `startswith` once with a `tuple` 27 27 | 28 28 | # ok +PIE810.py:83:8: PIE810 [*] Call `startswith` once with a `tuple` + | +81 | def func(): +82 | "Regression test for https://github.com/astral-sh/ruff/issues/9663" +83 | if x.startswith("a") or x.startswith("b") or re.match(r"a\.b", x): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PIE810 +84 | print("yes") + | + = help: Merge into a single `startswith` call +ℹ Unsafe fix +80 80 | +81 81 | def func(): +82 82 | "Regression test for https://github.com/astral-sh/ruff/issues/9663" +83 |- if x.startswith("a") or x.startswith("b") or re.match(r"a\.b", x): + 83 |+ if x.startswith(("a", "b")) or re.match(r"a\.b", x): +84 84 | print("yes") diff --git a/crates/ruff_linter/src/rules/flake8_print/rules/print_call.rs b/crates/ruff_linter/src/rules/flake8_print/rules/print_call.rs index 50cfcf825500c..41e4cde22e016 100644 --- a/crates/ruff_linter/src/rules/flake8_print/rules/print_call.rs +++ b/crates/ruff_linter/src/rules/flake8_print/rules/print_call.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; @@ -11,36 +11,52 @@ use crate::registry::AsRule; /// Checks for `print` statements. /// /// ## Why is this bad? -/// `print` statements are useful in some situations (e.g., debugging), but -/// should typically be omitted from production code. `print` statements can -/// lead to the accidental inclusion of sensitive information in logs, and are -/// not configurable by clients, unlike `logging` statements. +/// `print` statements used for debugging should be omitted from production +/// code. They can lead the accidental inclusion of sensitive information in +/// logs, and are not configurable by clients, unlike `logging` statements. +/// +/// `print` statements used to produce output as a part of a command-line +/// interface program are not typically a problem. /// /// ## Example /// ```python -/// def add_numbers(a, b): -/// print(f"The sum of {a} and {b} is {a + b}") -/// return a + b +/// def sum_less_than_four(a, b): +/// print(f"Calling sum_less_than_four") +/// return a + b < 4 /// ``` /// -/// Use instead: +/// The automatic fix will remove the print statement entirely: +/// /// ```python -/// def add_numbers(a, b): -/// return a + b +/// def sum_less_than_four(a, b): +/// return a + b < 4 +/// ``` +/// +/// To keep the line for logging purposes, instead use something like: +/// +/// ```python +/// import logging +/// +/// logging.basicConfig(level=logging.INFO) +/// +/// +/// def sum_less_than_four(a, b): +/// logging.debug("Calling sum_less_than_four") +/// return a + b < 4 /// ``` /// /// ## Fix safety -/// This rule's fix is marked as unsafe, as it may remove `print` statements +/// This rule's fix is marked as unsafe, as it will remove `print` statements /// that are used beyond debugging purposes. -#[violation] -pub struct Print; +#[derive(ViolationMetadata)] +pub(crate) struct Print; impl Violation for Print { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`print` found") + "`print` found".to_string() } fn fix_title(&self) -> Option<String> { @@ -52,11 +68,13 @@ impl Violation for Print { /// Checks for `pprint` statements. /// /// ## Why is this bad? -/// Like `print` statements, `pprint` statements are useful in some situations -/// (e.g., debugging), but should typically be omitted from production code. -/// `pprint` statements can lead to the accidental inclusion of sensitive -/// information in logs, and are not configurable by clients, unlike `logging` -/// statements. +/// Like `print` statements, `pprint` statements used for debugging should +/// be omitted from production code. They can lead the accidental inclusion +/// of sensitive information in logs, and are not configurable by clients, +/// unlike `logging` statements. +/// +/// `pprint` statements used to produce output as a part of a command-line +/// interface program are not typically a problem. /// /// ## Example /// ```python @@ -77,17 +95,17 @@ impl Violation for Print { /// ``` /// /// ## Fix safety -/// This rule's fix is marked as unsafe, as it may remove `pprint` statements +/// This rule's fix is marked as unsafe, as it will remove `pprint` statements /// that are used beyond debugging purposes. -#[violation] -pub struct PPrint; +#[derive(ViolationMetadata)] +pub(crate) struct PPrint; impl Violation for PPrint { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`pprint` found") + "`pprint` found".to_string() } fn fix_title(&self) -> Option<String> { @@ -96,7 +114,7 @@ impl Violation for PPrint { } /// T201, T203 -pub(crate) fn print_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn print_call(checker: &Checker, call: &ast::ExprCall) { let semantic = checker.semantic(); let Some(qualified_name) = semantic.resolve_qualified_name(&call.func) else { @@ -109,8 +127,7 @@ pub(crate) fn print_call(checker: &mut Checker, call: &ast::ExprCall) { // or `"sys.stderr"`), don't trigger T201. if let Some(keyword) = call.arguments.find_keyword("file") { if !keyword.value.is_none_literal_expr() { - if semantic.resolve_qualified_name(&keyword.value).map_or( - true, + if semantic.resolve_qualified_name(&keyword.value).is_none_or( |qualified_name| { !matches!(qualified_name.segments(), ["sys", "stdout" | "stderr"]) }, @@ -125,7 +142,7 @@ pub(crate) fn print_call(checker: &mut Checker, call: &ast::ExprCall) { _ => return, }; - if !checker.enabled(diagnostic.kind.rule()) { + if !checker.enabled(diagnostic.rule()) { return; } @@ -140,5 +157,5 @@ pub(crate) fn print_call(checker: &mut Checker, call: &ast::ExprCall) { ); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T201_T201.py.snap b/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T201_T201.py.snap index 2cbb5753612a3..3177ee0830be5 100644 --- a/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T201_T201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T201_T201.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_print/mod.rs T201.py:4:1: T201 [*] `print` found | 2 | import tempfile -3 | +3 | 4 | print("Hello, world!") # T201 | ^^^^^ T201 5 | print("Hello, world!", file=None) # T201 @@ -65,7 +65,7 @@ T201.py:7:1: T201 [*] `print` found 6 | print("Hello, world!", file=sys.stdout) # T201 7 | print("Hello, world!", file=sys.stderr) # T201 | ^^^^^ T201 -8 | +8 | 9 | with tempfile.NamedTemporaryFile() as fp: | = help: Remove `print` @@ -78,5 +78,3 @@ T201.py:7:1: T201 [*] `print` found 8 7 | 9 8 | with tempfile.NamedTemporaryFile() as fp: 10 9 | print("Hello, world!", file=fp) # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T203_T203.py.snap b/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T203_T203.py.snap index f63e108c8618c..24d4d7193d794 100644 --- a/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T203_T203.py.snap +++ b/crates/ruff_linter/src/rules/flake8_print/snapshots/ruff_linter__rules__flake8_print__tests__T203_T203.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_print/mod.rs T203.py:3:1: T203 [*] `pprint` found | 1 | from pprint import pprint -2 | +2 | 3 | pprint("Hello, world!") # T203 | ^^^^^^ T203 -4 | +4 | 5 | import pprint | = help: Remove `pprint` @@ -23,10 +23,10 @@ T203.py:3:1: T203 [*] `pprint` found T203.py:7:1: T203 [*] `pprint` found | 5 | import pprint -6 | +6 | 7 | pprint.pprint("Hello, world!") # T203 | ^^^^^^^^^^^^^ T203 -8 | +8 | 9 | pprint.pformat("Hello, world!") | = help: Remove `pprint` @@ -38,5 +38,3 @@ T203.py:7:1: T203 [*] `pprint` found 7 |-pprint.pprint("Hello, world!") # T203 8 7 | 9 8 | pprint.pformat("Hello, world!") - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/mod.rs b/crates/ruff_linter/src/rules/flake8_pyi/mod.rs index 72b4f19af8ec5..ea59b73d1c96f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/mod.rs @@ -6,11 +6,12 @@ mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::PythonVersion; use test_case::test_case; use crate::registry::Rule; use crate::rules::pep8_naming; - use crate::settings::types::{PreviewMode, PythonVersion}; + use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; @@ -66,8 +67,8 @@ mod tests { #[test_case(Rule::PatchVersionComparison, Path::new("PYI004.pyi"))] #[test_case(Rule::QuotedAnnotationInStub, Path::new("PYI020.py"))] #[test_case(Rule::QuotedAnnotationInStub, Path::new("PYI020.pyi"))] - #[test_case(Rule::PrePep570PositionalArgument, Path::new("PYI063.py"))] - #[test_case(Rule::PrePep570PositionalArgument, Path::new("PYI063.pyi"))] + #[test_case(Rule::Pep484StylePositionalOnlyParameter, Path::new("PYI063.py"))] + #[test_case(Rule::Pep484StylePositionalOnlyParameter, Path::new("PYI063.pyi"))] #[test_case(Rule::RedundantFinalLiteral, Path::new("PYI064.py"))] #[test_case(Rule::RedundantFinalLiteral, Path::new("PYI064.pyi"))] #[test_case(Rule::RedundantLiteralUnion, Path::new("PYI051.py"))] @@ -124,6 +125,8 @@ mod tests { #[test_case(Rule::UnusedPrivateTypedDict, Path::new("PYI049.pyi"))] #[test_case(Rule::WrongTupleLengthVersionComparison, Path::new("PYI005.py"))] #[test_case(Rule::WrongTupleLengthVersionComparison, Path::new("PYI005.pyi"))] + #[test_case(Rule::RedundantNoneLiteral, Path::new("PYI061.py"))] + #[test_case(Rule::RedundantNoneLiteral, Path::new("PYI061.pyi"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -134,8 +137,9 @@ mod tests { Ok(()) } - #[test_case(Rule::CustomTypeVarReturnType, Path::new("PYI019.py"))] - #[test_case(Rule::CustomTypeVarReturnType, Path::new("PYI019.pyi"))] + #[test_case(Rule::CustomTypeVarForSelf, Path::new("PYI019_0.py"))] + #[test_case(Rule::CustomTypeVarForSelf, Path::new("PYI019_0.pyi"))] + #[test_case(Rule::CustomTypeVarForSelf, Path::new("PYI019_1.pyi"))] fn custom_classmethod_rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -154,12 +158,14 @@ mod tests { #[test_case(Rule::TypeAliasWithoutAnnotation, Path::new("PYI026.py"))] #[test_case(Rule::TypeAliasWithoutAnnotation, Path::new("PYI026.pyi"))] + #[test_case(Rule::RedundantNoneLiteral, Path::new("PYI061.py"))] + #[test_case(Rule::RedundantNoneLiteral, Path::new("PYI061.pyi"))] fn py38(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("py38_{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( Path::new("flake8_pyi").join(path).as_path(), &settings::LinterSettings { - target_version: PythonVersion::Py38, + unresolved_target_version: PythonVersion::PY38.into(), ..settings::LinterSettings::for_rule(rule_code) }, )?; diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/any_eq_ne_annotation.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/any_eq_ne_annotation.rs index 01a2d1447e3f1..653229819889b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/any_eq_ne_annotation.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/any_eq_ne_annotation.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Parameters; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -41,8 +41,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: The `Any` type](https://docs.python.org/3/library/typing.html#the-any-type) /// - [Mypy documentation: Any vs. object](https://mypy.readthedocs.io/en/latest/dynamic_typing.html#any-vs-object) -#[violation] -pub struct AnyEqNeAnnotation { +#[derive(ViolationMetadata)] +pub(crate) struct AnyEqNeAnnotation { method_name: String, } @@ -54,12 +54,12 @@ impl AlwaysFixableViolation for AnyEqNeAnnotation { } fn fix_title(&self) -> String { - format!("Replace with `object`") + "Replace with `object`".to_string() } } /// PYI032 -pub(crate) fn any_eq_ne_annotation(checker: &mut Checker, name: &str, parameters: &Parameters) { +pub(crate) fn any_eq_ne_annotation(checker: &Checker, name: &str, parameters: &Parameters) { if !matches!(name, "__eq__" | "__ne__") { return; } @@ -68,7 +68,7 @@ pub(crate) fn any_eq_ne_annotation(checker: &mut Checker, name: &str, parameters return; } - let Some(annotation) = ¶meters.args[1].parameter.annotation else { + let Some(annotation) = ¶meters.args[1].annotation() else { return; }; @@ -100,5 +100,5 @@ pub(crate) fn any_eq_ne_annotation(checker: &mut Checker, name: &str, parameters let binding_edit = Edit::range_replacement(binding, annotation.range()); Ok(Fix::safe_edits(binding_edit, import_edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_generator_return_type.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_generator_return_type.rs index 1406bb4bd2073..d3fbb436bfe52 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_generator_return_type.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_generator_return_type.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::identifier::Identifier; @@ -58,8 +58,8 @@ use crate::importer::ImportRequest; /// applied to runtime Python (`.py` files). As such, the fix is marked as /// unsafe for any `__iter__` or `__aiter__` method in a `.py` file that has /// more than two statements (including docstrings) in its body. -#[violation] -pub struct GeneratorReturnFromIterMethod { +#[derive(ViolationMetadata)] +pub(crate) struct GeneratorReturnFromIterMethod { return_type: Iterator, method: Method, } @@ -88,10 +88,7 @@ impl Violation for GeneratorReturnFromIterMethod { } /// PYI058 -pub(crate) fn bad_generator_return_type( - function_def: &ast::StmtFunctionDef, - checker: &mut Checker, -) { +pub(crate) fn bad_generator_return_type(function_def: &ast::StmtFunctionDef, checker: &Checker) { if function_def.is_async { return; } @@ -212,7 +209,7 @@ pub(crate) fn bad_generator_return_type( _ => return, } } - }; + } let mut diagnostic = Diagnostic::new( GeneratorReturnFromIterMethod { return_type: member.to_iter(), @@ -220,17 +217,19 @@ pub(crate) fn bad_generator_return_type( }, function_def.identifier(), ); - if let Some(fix) = generate_fix( - function_def, - returns, - yield_type_info, - module, - member, - checker, - ) { - diagnostic.set_fix(fix); - }; - checker.diagnostics.push(diagnostic); + + diagnostic.try_set_fix(|| { + generate_fix( + function_def, + returns, + yield_type_info, + module, + member, + checker, + ) + }); + + checker.report_diagnostic(diagnostic); } /// Returns `true` if the [`ast::Expr`] is a `None` literal or a `typing.Any` expression. @@ -246,17 +245,14 @@ fn generate_fix( module: Module, member: Generator, checker: &Checker, -) -> Option<Fix> { +) -> anyhow::Result<Fix> { let expr = map_subscript(returns); - let (import_edit, binding) = checker - .importer() - .get_or_import_symbol( - &ImportRequest::import_from(&module.to_string(), &member.to_iter().to_string()), - expr.start(), - checker.semantic(), - ) - .ok()?; + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from(&module.to_string(), &member.to_iter().to_string()), + expr.start(), + checker.semantic(), + )?; let binding_edit = Edit::range_replacement(binding, expr.range()); let yield_edit = yield_type_info.map(|yield_type_info| { Edit::range_replacement( @@ -272,7 +268,7 @@ fn generate_fix( Applicability::Unsafe }; - Some(Fix::applicable_edits( + Ok(Fix::applicable_edits( import_edit, std::iter::once(binding_edit).chain(yield_edit), applicability, diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_version_info_comparison.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_version_info_comparison.rs index 2c189c963c80a..1feef776c207c 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_version_info_comparison.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/bad_version_info_comparison.rs @@ -1,23 +1,25 @@ use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; +use crate::preview::is_bad_version_info_in_non_stub_enabled; use crate::registry::Rule; /// ## What it does /// Checks for uses of comparators other than `<` and `>=` for -/// `sys.version_info` checks in `.pyi` files. All other comparators, such +/// `sys.version_info` checks. All other comparators, such /// as `>`, `<=`, and `==`, are banned. /// /// ## Why is this bad? /// Comparing `sys.version_info` with `==` or `<=` has unexpected behavior /// and can lead to bugs. /// -/// For example, `sys.version_info > (3, 8)` will also match `3.8.10`, -/// while `sys.version_info <= (3, 8)` will _not_ match `3.8.10`: +/// For example, `sys.version_info > (3, 8, 1)` will resolve to `True` if your +/// Python version is 3.8.1; meanwhile, `sys.version_info <= (3, 8)` will _not_ +/// resolve to `True` if your Python version is 3.8.10: /// /// ```python /// >>> import sys @@ -34,37 +36,45 @@ use crate::registry::Rule; /// ``` /// /// ## Example -/// ```pyi +/// ```py /// import sys /// /// if sys.version_info > (3, 8): ... /// ``` /// /// Use instead: -/// ```pyi +/// ```py /// import sys /// /// if sys.version_info >= (3, 9): ... /// ``` -#[violation] -pub struct BadVersionInfoComparison; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct BadVersionInfoComparison; impl Violation for BadVersionInfoComparison { #[derive_message_formats] fn message(&self) -> String { - format!("Use `<` or `>=` for `sys.version_info` comparisons") + "Use `<` or `>=` for `sys.version_info` comparisons".to_string() } } /// ## What it does -/// Checks for if-else statements with `sys.version_info` comparisons that use -/// `<` comparators. +/// Checks for code that branches on `sys.version_info` comparisons where +/// branches corresponding to older Python versions come before branches +/// corresponding to newer Python versions. /// /// ## Why is this bad? /// As a convention, branches that correspond to newer Python versions should -/// come first when using `sys.version_info` comparisons. This makes it easier -/// to understand the desired behavior, which typically corresponds to the -/// latest Python versions. +/// come first. This makes it easier to understand the desired behavior, which +/// typically corresponds to the latest Python versions. +/// +/// This rule enforces the convention by checking for `if` tests that compare +/// `sys.version_info` with `<` rather than `>=`. +/// +/// By default, this rule only applies to stub files. +/// In [preview], it will also flag this anti-pattern in non-stub files. /// /// ## Example /// @@ -87,22 +97,20 @@ impl Violation for BadVersionInfoComparison { /// else: /// def read_data(x, *, preserve_order=True): ... /// ``` -#[violation] -pub struct BadVersionInfoOrder; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct BadVersionInfoOrder; impl Violation for BadVersionInfoOrder { #[derive_message_formats] fn message(&self) -> String { - format!("Use `>=` when using `if`-`else` with `sys.version_info` comparisons") + "Put branches for newer Python versions first when branching on `sys.version_info` comparisons".to_string() } } /// PYI006, PYI066 -pub(crate) fn bad_version_info_comparison( - checker: &mut Checker, - test: &Expr, - has_else_clause: bool, -) { +pub(crate) fn bad_version_info_comparison(checker: &Checker, test: &Expr, has_else_clause: bool) { let Expr::Compare(ast::ExprCompare { left, ops, @@ -131,18 +139,17 @@ pub(crate) fn bad_version_info_comparison( } if matches!(op, CmpOp::Lt) { - if checker.enabled(Rule::BadVersionInfoOrder) { + if checker.enabled(Rule::BadVersionInfoOrder) + // See https://github.com/astral-sh/ruff/issues/15347 + && (checker.source_type.is_stub() || is_bad_version_info_in_non_stub_enabled(checker.settings)) + { if has_else_clause { - checker - .diagnostics - .push(Diagnostic::new(BadVersionInfoOrder, test.range())); + checker.report_diagnostic(Diagnostic::new(BadVersionInfoOrder, test.range())); } } } else { if checker.enabled(Rule::BadVersionInfoComparison) { - checker - .diagnostics - .push(Diagnostic::new(BadVersionInfoComparison, test.range())); - }; + checker.report_diagnostic(Diagnostic::new(BadVersionInfoComparison, test.range())); + } } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/bytestring_usage.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/bytestring_usage.rs index c8bf140491dd9..7b8ff0ce6d7cd 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/bytestring_usage.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/bytestring_usage.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -27,8 +27,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `ByteString` type](https://docs.python.org/3/library/typing.html#typing.ByteString) -#[violation] -pub struct ByteStringUsage { +#[derive(ViolationMetadata)] +pub(crate) struct ByteStringUsage { origin: ByteStringOrigin, } @@ -58,7 +58,7 @@ impl std::fmt::Display for ByteStringOrigin { } /// PYI057 -pub(crate) fn bytestring_attribute(checker: &mut Checker, attribute: &Expr) { +pub(crate) fn bytestring_attribute(checker: &Checker, attribute: &Expr) { let semantic = checker.semantic(); if !semantic .seen @@ -74,14 +74,14 @@ pub(crate) fn bytestring_attribute(checker: &mut Checker, attribute: &Expr) { ["collections", "abc", "ByteString"] => ByteStringOrigin::CollectionsAbc, _ => return, }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ByteStringUsage { origin }, attribute.range(), )); } /// PYI057 -pub(crate) fn bytestring_import(checker: &mut Checker, import_from: &ast::StmtImportFrom) { +pub(crate) fn bytestring_import(checker: &Checker, import_from: &ast::StmtImportFrom) { let ast::StmtImportFrom { names, module, .. } = import_from; let module_id = match module { @@ -97,9 +97,7 @@ pub(crate) fn bytestring_import(checker: &mut Checker, import_from: &ast::StmtIm for name in names { if name.name.as_str() == "ByteString" { - checker - .diagnostics - .push(Diagnostic::new(ByteStringUsage { origin }, name.range())); + checker.report_diagnostic(Diagnostic::new(ByteStringUsage { origin }, name.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/collections_named_tuple.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/collections_named_tuple.rs index 4f63b454d7ecf..9e01fb1420b57 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/collections_named_tuple.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/collections_named_tuple.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -35,22 +35,22 @@ use crate::checkers::ast::Checker; /// name: str /// age: int /// ``` -#[violation] -pub struct CollectionsNamedTuple; +#[derive(ViolationMetadata)] +pub(crate) struct CollectionsNamedTuple; impl Violation for CollectionsNamedTuple { #[derive_message_formats] fn message(&self) -> String { - format!("Use `typing.NamedTuple` instead of `collections.namedtuple`") + "Use `typing.NamedTuple` instead of `collections.namedtuple`".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `typing.NamedTuple`")) + Some("Replace with `typing.NamedTuple`".to_string()) } } /// PYI024 -pub(crate) fn collections_named_tuple(checker: &mut Checker, expr: &Expr) { +pub(crate) fn collections_named_tuple(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::COLLECTIONS) { return; } @@ -62,8 +62,6 @@ pub(crate) fn collections_named_tuple(checker: &mut Checker, expr: &Expr) { matches!(qualified_name.segments(), ["collections", "namedtuple"]) }) { - checker - .diagnostics - .push(Diagnostic::new(CollectionsNamedTuple, expr.range())); + checker.report_diagnostic(Diagnostic::new(CollectionsNamedTuple, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_assignment_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_assignment_in_stub.rs index 711698f7857ac..08d7b95f761c4 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_assignment_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_assignment_in_stub.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, StmtAssign}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -41,22 +41,20 @@ use crate::checkers::ast::Checker; /// class Klass: /// X: TypeAlias = int /// ``` -#[violation] -pub struct ComplexAssignmentInStub; +#[derive(ViolationMetadata)] +pub(crate) struct ComplexAssignmentInStub; impl Violation for ComplexAssignmentInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Stubs should not contain assignments to attributes or multiple targets") + "Stubs should not contain assignments to attributes or multiple targets".to_string() } } /// PYI017 -pub(crate) fn complex_assignment_in_stub(checker: &mut Checker, stmt: &StmtAssign) { +pub(crate) fn complex_assignment_in_stub(checker: &Checker, stmt: &StmtAssign) { if matches!(stmt.targets.as_slice(), [Expr::Name(_)]) { return; } - checker - .diagnostics - .push(Diagnostic::new(ComplexAssignmentInStub, stmt.range)); + checker.report_diagnostic(Diagnostic::new(ComplexAssignmentInStub, stmt.range)); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_if_statement_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_if_statement_in_stub.rs index 06abeecc38b0a..c6001371432b9 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_if_statement_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/complex_if_statement_in_stub.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -30,35 +30,30 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// The [typing documentation on stub files](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct ComplexIfStatementInStub; +/// - [Typing documentation: Version and platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct ComplexIfStatementInStub; impl Violation for ComplexIfStatementInStub { #[derive_message_formats] fn message(&self) -> String { - format!( - "`if` test must be a simple comparison against `sys.platform` or `sys.version_info`" - ) + "`if` test must be a simple comparison against `sys.platform` or `sys.version_info`" + .to_string() } } /// PYI002 -pub(crate) fn complex_if_statement_in_stub(checker: &mut Checker, test: &Expr) { +pub(crate) fn complex_if_statement_in_stub(checker: &Checker, test: &Expr) { let Expr::Compare(ast::ExprCompare { left, comparators, .. }) = test else { - checker - .diagnostics - .push(Diagnostic::new(ComplexIfStatementInStub, test.range())); + checker.report_diagnostic(Diagnostic::new(ComplexIfStatementInStub, test.range())); return; }; if comparators.len() != 1 { - checker - .diagnostics - .push(Diagnostic::new(ComplexIfStatementInStub, test.range())); + checker.report_diagnostic(Diagnostic::new(ComplexIfStatementInStub, test.range())); return; } @@ -79,7 +74,5 @@ pub(crate) fn complex_if_statement_in_stub(checker: &mut Checker, test: &Expr) { return; } - checker - .diagnostics - .push(Diagnostic::new(ComplexIfStatementInStub, test.range())); + checker.report_diagnostic(Diagnostic::new(ComplexIfStatementInStub, test.range())); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_for_self.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_for_self.rs new file mode 100644 index 0000000000000..c3655eebdaf1e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_for_self.rs @@ -0,0 +1,482 @@ +use anyhow::{Context, bail}; +use itertools::Itertools; + +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; +use ruff_python_semantic::analyze::class::is_metaclass; +use ruff_python_semantic::analyze::function_type::{self, FunctionType}; +use ruff_python_semantic::analyze::visibility::{is_abstract, is_overload}; +use ruff_python_semantic::{Binding, ResolvedReference, ScopeId, SemanticModel}; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::{Checker, TypingImporter}; +use ruff_python_ast::PythonVersion; + +/// ## What it does +/// Checks for methods that use custom [`TypeVar`s][typing_TypeVar] in their +/// annotations when they could use [`Self`][Self] instead. +/// +/// ## Why is this bad? +/// While the semantics are often identical, using `Self` is more intuitive +/// and succinct (per [PEP 673]) than a custom `TypeVar`. For example, the +/// use of `Self` will typically allow for the omission of type parameters +/// on the `self` and `cls` arguments. +/// +/// This check currently applies to instance methods that return `self`, +/// class methods that return an instance of `cls`, class methods that return +/// `cls`, and `__new__` methods. +/// +/// ## Example +/// +/// ```pyi +/// from typing import TypeVar +/// +/// _S = TypeVar("_S", bound="Foo") +/// +/// class Foo: +/// def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... +/// def foo(self: _S, arg: bytes) -> _S: ... +/// @classmethod +/// def bar(cls: type[_S], arg: int) -> _S: ... +/// ``` +/// +/// Use instead: +/// +/// ```pyi +/// from typing import Self +/// +/// class Foo: +/// def __new__(cls, *args: str, **kwargs: int) -> Self: ... +/// def foo(self, arg: bytes) -> Self: ... +/// @classmethod +/// def bar(cls, arg: int) -> Self: ... +/// ``` +/// +/// ## Fix behaviour and safety +/// The fix replaces all references to the custom type variable in the method's header and body +/// with references to `Self`. The fix also adds an import of `Self` if neither `Self` nor `typing` +/// is already imported in the module. If your [`target-version`] setting is set to Python 3.11 or +/// newer, the fix imports `Self` from the standard-library `typing` module; otherwise, the fix +/// imports `Self` from the third-party [`typing_extensions`][typing_extensions] backport package. +/// +/// If the custom type variable is a [PEP-695]-style `TypeVar`, the fix also removes the `TypeVar` +/// declaration from the method's [type parameter list]. However, if the type variable is an +/// old-style `TypeVar`, the declaration of the type variable will not be removed by this rule's +/// fix, as the type variable could still be used by other functions, methods or classes. See +/// [`unused-private-type-var`][PYI018] for a rule that will clean up unused private type +/// variables. +/// +/// The fix is only marked as unsafe if there is the possibility that it might delete a comment +/// from your code. +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for Python versions +/// before 3.11, its diagnostic will not be emitted, and no fix will be offered, if +/// `typing_extensions` imports have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +/// +/// [PEP 673]: https://peps.python.org/pep-0673/#motivation +/// [PEP-695]: https://peps.python.org/pep-0695/ +/// [PYI018]: https://docs.astral.sh/ruff/rules/unused-private-type-var/ +/// [type parameter list]: https://docs.python.org/3/reference/compound_stmts.html#type-params +/// [Self]: https://docs.python.org/3/library/typing.html#typing.Self +/// [typing_TypeVar]: https://docs.python.org/3/library/typing.html#typing.TypeVar +/// [typing_extensions]: https://typing-extensions.readthedocs.io/en/latest/ +#[derive(ViolationMetadata)] +pub(crate) struct CustomTypeVarForSelf { + typevar_name: String, +} + +impl Violation for CustomTypeVarForSelf { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + format!( + "Use `Self` instead of custom TypeVar `{}`", + &self.typevar_name + ) + } + + fn fix_title(&self) -> Option<String> { + Some(format!( + "Replace TypeVar `{}` with `Self`", + &self.typevar_name + )) + } +} + +/// PYI019 +pub(crate) fn custom_type_var_instead_of_self( + checker: &Checker, + binding: &Binding, +) -> Option<Diagnostic> { + let semantic = checker.semantic(); + let current_scope = &semantic.scopes[binding.scope]; + let function_def = binding.statement(semantic)?.as_function_def_stmt()?; + let importer = checker.typing_importer("Self", PythonVersion::PY311)?; + + let ast::StmtFunctionDef { + name: function_name, + parameters, + returns, + decorator_list, + type_params, + .. + } = function_def; + + let type_params = type_params.as_deref(); + + // Given, e.g., `def foo(self: _S, arg: bytes)`, extract `_S`. + let self_or_cls_parameter = parameters + .posonlyargs + .iter() + .chain(¶meters.args) + .next()?; + + let self_or_cls_annotation = self_or_cls_parameter.annotation()?; + let parent_class = current_scope.kind.as_class()?; + + // Skip any abstract/static/overloaded methods, + // and any methods in metaclasses + if is_abstract(decorator_list, semantic) + || is_overload(decorator_list, semantic) + || is_metaclass(parent_class, semantic).is_yes() + { + return None; + } + + let function_kind = function_type::classify( + function_name, + decorator_list, + current_scope, + semantic, + &checker.settings.pep8_naming.classmethod_decorators, + &checker.settings.pep8_naming.staticmethod_decorators, + ); + + let method = match function_kind { + FunctionType::ClassMethod | FunctionType::NewMethod => Method::Class(ClassMethod { + cls_annotation: self_or_cls_annotation, + type_params, + }), + FunctionType::Method => Method::Instance(InstanceMethod { + self_annotation: self_or_cls_annotation, + type_params, + }), + FunctionType::Function | FunctionType::StaticMethod => return None, + }; + + let custom_typevar = method.custom_typevar(semantic, binding.scope)?; + + let function_header_end = returns + .as_deref() + .map(Ranged::end) + .unwrap_or_else(|| parameters.end()); + + let mut diagnostic = Diagnostic::new( + CustomTypeVarForSelf { + typevar_name: custom_typevar.name(checker.source()).to_string(), + }, + TextRange::new(function_name.end(), function_header_end), + ); + + diagnostic.try_set_fix(|| { + replace_custom_typevar_with_self( + checker, + &importer, + function_def, + custom_typevar, + self_or_cls_parameter, + self_or_cls_annotation, + ) + }); + + Some(diagnostic) +} + +#[derive(Debug)] +enum Method<'a> { + Class(ClassMethod<'a>), + Instance(InstanceMethod<'a>), +} + +impl Method<'_> { + fn custom_typevar<'a>( + &'a self, + semantic: &'a SemanticModel<'a>, + scope: ScopeId, + ) -> Option<TypeVar<'a>> { + match self { + Self::Class(class_method) => class_method.custom_typevar(semantic, scope), + Self::Instance(instance_method) => instance_method.custom_typevar(semantic), + } + } +} + +#[derive(Debug)] +struct ClassMethod<'a> { + cls_annotation: &'a ast::Expr, + type_params: Option<&'a ast::TypeParams>, +} + +impl ClassMethod<'_> { + /// Returns `Some(typevar)` if the class method is annotated with + /// a custom `TypeVar` for the `cls` parameter + fn custom_typevar<'a>( + &'a self, + semantic: &'a SemanticModel<'a>, + scope: ScopeId, + ) -> Option<TypeVar<'a>> { + let ast::ExprSubscript { + value: cls_annotation_value, + slice: cls_annotation_typevar, + .. + } = self.cls_annotation.as_subscript_expr()?; + + let cls_annotation_typevar = cls_annotation_typevar.as_name_expr()?; + + let ast::ExprName { id, .. } = cls_annotation_value.as_name_expr()?; + if id != "type" { + return None; + } + if !semantic.has_builtin_binding_in_scope("type", scope) { + return None; + } + + custom_typevar(cls_annotation_typevar, self.type_params, semantic) + } +} + +#[derive(Debug)] +struct InstanceMethod<'a> { + self_annotation: &'a ast::Expr, + type_params: Option<&'a ast::TypeParams>, +} + +impl InstanceMethod<'_> { + /// Returns `Some(typevar)` if the instance method is annotated with + /// a custom `TypeVar` for the `self` parameter + fn custom_typevar<'a>(&'a self, semantic: &'a SemanticModel<'a>) -> Option<TypeVar<'a>> { + custom_typevar( + self.self_annotation.as_name_expr()?, + self.type_params, + semantic, + ) + } +} + +/// Returns `Some(TypeVar)` if `typevar_expr` refers to a `TypeVar` binding +fn custom_typevar<'a>( + typevar_expr: &'a ast::ExprName, + type_params: Option<&ast::TypeParams>, + semantic: &'a SemanticModel<'a>, +) -> Option<TypeVar<'a>> { + let binding = semantic + .resolve_name(typevar_expr) + .map(|binding_id| semantic.binding(binding_id))?; + + // Example: + // ```py + // class Foo: + // def m[S](self: S) -> S: ... + // ``` + if binding.kind.is_type_param() { + return type_params? + .iter() + .filter_map(ast::TypeParam::as_type_var) + .any(|ast::TypeParamTypeVar { name, .. }| name.id == typevar_expr.id) + .then_some(TypeVar(binding)); + } + + // Example: + // ```py + // from typing import TypeVar + // + // S = TypeVar("S", bound="Foo") + // + // class Foo: + // def m(self: S) -> S: ... + // ``` + if !semantic.seen_typing() { + return None; + } + let statement = binding.source.map(|node_id| semantic.statement(node_id))?; + let rhs_function = statement.as_assign_stmt()?.value.as_call_expr()?; + + semantic + .match_typing_expr(&rhs_function.func, "TypeVar") + .then_some(TypeVar(binding)) +} + +/// Add a "Replace with `Self`" fix that does the following: +/// +/// * Import `Self` if necessary +/// * Remove the first parameter's annotation +/// * Replace other uses of the original type variable elsewhere in the function with `Self` +/// * If it was a PEP-695 type variable, removes that `TypeVar` from the PEP-695 type-parameter list +fn replace_custom_typevar_with_self( + checker: &Checker, + importer: &TypingImporter, + function_def: &ast::StmtFunctionDef, + custom_typevar: TypeVar, + self_or_cls_parameter: &ast::ParameterWithDefault, + self_or_cls_annotation: &ast::Expr, +) -> anyhow::Result<Fix> { + // (1) Import `Self` (if necessary) + let (import_edit, self_symbol_binding) = importer.import(function_def.start())?; + + // (2) Remove the first parameter's annotation + let mut other_edits = vec![Edit::deletion( + self_or_cls_parameter.name().end(), + self_or_cls_annotation.end(), + )]; + + // (3) If it was a PEP-695 type variable, remove that `TypeVar` from the PEP-695 type-parameter list + if custom_typevar.is_pep695_typevar() { + let type_params = function_def.type_params.as_deref().context( + "Should not be possible to have a type parameter without a type parameter list", + )?; + let deletion_edit = remove_pep695_typevar_declaration(type_params, custom_typevar) + .context("Failed to find a `TypeVar` in the type params that matches the binding")?; + other_edits.push(deletion_edit); + } + + // (4) Replace all other references to the original type variable elsewhere in the function with `Self` + let replace_references_range = TextRange::new(self_or_cls_annotation.end(), function_def.end()); + + replace_typevar_usages_with_self( + custom_typevar, + checker.source(), + self_or_cls_annotation.range(), + &self_symbol_binding, + replace_references_range, + checker.semantic(), + &mut other_edits, + )?; + + // (5) Determine the safety of the fixes as a whole + let comment_ranges = checker.comment_ranges(); + + let applicability = if other_edits + .iter() + .any(|edit| comment_ranges.intersects(edit.range())) + { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + Ok(Fix::applicable_edits( + import_edit, + other_edits, + applicability, + )) +} + +/// Returns a series of [`Edit`]s that modify all references to the given `typevar`. +/// +/// Only references within `editable_range` will be modified. +/// This ensures that no edit in this series will overlap with other edits. +fn replace_typevar_usages_with_self<'a>( + typevar: TypeVar<'a>, + source: &'a str, + self_or_cls_annotation_range: TextRange, + self_symbol_binding: &'a str, + editable_range: TextRange, + semantic: &'a SemanticModel<'a>, + edits: &mut Vec<Edit>, +) -> anyhow::Result<()> { + let tvar_name = typevar.name(source); + for reference in typevar.references(semantic) { + let reference_range = reference.range(); + if &source[reference_range] != tvar_name { + bail!( + "Cannot autofix: reference in the source code (`{}`) is not equal to the typevar name (`{}`)", + &source[reference_range], + tvar_name + ); + } + if !editable_range.contains_range(reference_range) { + continue; + } + if self_or_cls_annotation_range.contains_range(reference_range) { + continue; + } + edits.push(Edit::range_replacement( + self_symbol_binding.to_string(), + reference_range, + )); + } + Ok(()) +} + +/// Create an [`Edit`] removing the `TypeVar` binding from the PEP 695 type parameter list. +/// +/// Return `None` if we fail to find a `TypeVar` that matches the range of `typevar_binding`. +fn remove_pep695_typevar_declaration( + type_params: &ast::TypeParams, + custom_typevar: TypeVar, +) -> Option<Edit> { + if let [sole_typevar] = &**type_params { + return (sole_typevar.name().range() == custom_typevar.range()) + .then(|| Edit::range_deletion(type_params.range)); + } + + // `custom_typevar.range()` will return the range of the name of the typevar binding. + // We need the full range of the `TypeVar` declaration (including any constraints or bounds) + // to determine the correct deletion range. + let (tvar_index, tvar_declaration) = type_params + .iter() + .find_position(|param| param.name().range() == custom_typevar.range())?; + + let last_index = type_params.len() - 1; + + let deletion_range = if tvar_index < last_index { + // def f[A, B, C](): ... + // ^^^ Remove this + TextRange::new( + tvar_declaration.start(), + type_params[tvar_index + 1].start(), + ) + } else { + // def f[A, B, C](): ... + // ^^^ Remove this + TextRange::new(type_params[tvar_index - 1].end(), tvar_declaration.end()) + }; + + Some(Edit::range_deletion(deletion_range)) +} + +#[derive(Debug, Copy, Clone)] +struct TypeVar<'a>(&'a Binding<'a>); + +impl<'a> TypeVar<'a> { + const fn is_pep695_typevar(self) -> bool { + self.0.kind.is_type_param() + } + + fn name(self, source: &'a str) -> &'a str { + self.0.name(source) + } + + fn references( + self, + semantic: &'a SemanticModel<'a>, + ) -> impl Iterator<Item = &'a ResolvedReference> + 'a { + self.0 + .references() + .map(|reference_id| semantic.reference(reference_id)) + } +} + +impl Ranged for TypeVar<'_> { + fn range(&self) -> TextRange { + self.0.range() + } +} diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_return_type.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_return_type.rs deleted file mode 100644 index 34eb68943f693..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/custom_type_var_return_type.rs +++ /dev/null @@ -1,232 +0,0 @@ -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast as ast; -use ruff_python_ast::helpers::map_subscript; -use ruff_python_ast::{Decorator, Expr, Parameters, TypeParam, TypeParams}; -use ruff_python_semantic::analyze::function_type::{self, FunctionType}; -use ruff_python_semantic::analyze::visibility::{is_abstract, is_overload}; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; - -/// ## What it does -/// Checks for methods that define a custom `TypeVar` for their return type -/// annotation instead of using `typing_extensions.Self`. -/// -/// ## Why is this bad? -/// While the semantics are often identical, using `typing_extensions.Self` is -/// more intuitive and succinct (per [PEP 673]) than a custom `TypeVar`. For -/// example, the use of `Self` will typically allow for the omission of type -/// parameters on the `self` and `cls` arguments. -/// -/// This check currently applies to instance methods that return `self`, class -/// methods that return an instance of `cls`, and `__new__` methods. -/// -/// ## Example -/// -/// ```pyi -/// class Foo: -/// def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... -/// def foo(self: _S, arg: bytes) -> _S: ... -/// @classmethod -/// def bar(cls: type[_S], arg: int) -> _S: ... -/// ``` -/// -/// Use instead: -/// -/// ```pyi -/// from typing import Self -/// -/// class Foo: -/// def __new__(cls, *args: str, **kwargs: int) -> Self: ... -/// def foo(self, arg: bytes) -> Self: ... -/// @classmethod -/// def bar(cls, arg: int) -> Self: ... -/// ``` -/// -/// [PEP 673]: https://peps.python.org/pep-0673/#motivation -#[violation] -pub struct CustomTypeVarReturnType { - method_name: String, -} - -impl Violation for CustomTypeVarReturnType { - #[derive_message_formats] - fn message(&self) -> String { - let CustomTypeVarReturnType { method_name } = self; - format!( - "Methods like `{method_name}` should return `typing.Self` instead of a custom `TypeVar`" - ) - } -} - -/// PYI019 -pub(crate) fn custom_type_var_return_type( - checker: &mut Checker, - name: &str, - decorator_list: &[Decorator], - returns: Option<&Expr>, - args: &Parameters, - type_params: Option<&TypeParams>, -) { - // Given, e.g., `def foo(self: _S, arg: bytes) -> _T`, extract `_T`. - let Some(returns) = returns else { - return; - }; - - // Given, e.g., `def foo(self: _S, arg: bytes)`, extract `_S`. - let Some(self_or_cls_annotation) = args - .posonlyargs - .iter() - .chain(&args.args) - .next() - .and_then(|parameter_with_default| parameter_with_default.parameter.annotation.as_ref()) - else { - return; - }; - - let semantic = checker.semantic(); - - // Skip any abstract, static, and overloaded methods. - if is_abstract(decorator_list, semantic) || is_overload(decorator_list, semantic) { - return; - } - - let method = match function_type::classify( - name, - decorator_list, - semantic.current_scope(), - semantic, - &checker.settings.pep8_naming.classmethod_decorators, - &checker.settings.pep8_naming.staticmethod_decorators, - ) { - FunctionType::Function => return, - FunctionType::StaticMethod => return, - FunctionType::ClassMethod => Method::Class(ClassMethod { - cls_annotation: self_or_cls_annotation, - returns, - type_params, - }), - FunctionType::Method => Method::Instance(InstanceMethod { - self_annotation: self_or_cls_annotation, - returns, - type_params, - }), - }; - - if method.uses_custom_var() { - checker.diagnostics.push(Diagnostic::new( - CustomTypeVarReturnType { - method_name: name.to_string(), - }, - returns.range(), - )); - } -} - -#[derive(Debug)] -enum Method<'a> { - Class(ClassMethod<'a>), - Instance(InstanceMethod<'a>), -} - -impl<'a> Method<'a> { - fn uses_custom_var(&self) -> bool { - match self { - Self::Class(class_method) => class_method.uses_custom_var(), - Self::Instance(instance_method) => instance_method.uses_custom_var(), - } - } -} - -#[derive(Debug)] -struct ClassMethod<'a> { - cls_annotation: &'a Expr, - returns: &'a Expr, - type_params: Option<&'a TypeParams>, -} - -impl<'a> ClassMethod<'a> { - /// Returns `true` if the class method is annotated with a custom `TypeVar` that is likely - /// private. - fn uses_custom_var(&self) -> bool { - let Expr::Subscript(ast::ExprSubscript { slice, value, .. }) = self.cls_annotation else { - return false; - }; - - let Expr::Name(value) = value.as_ref() else { - return false; - }; - - // Don't error if the first argument is annotated with typing.Type[T]. - // These are edge cases, and it's hard to give good error messages for them. - if value.id != "type" { - return false; - }; - - let Expr::Name(slice) = slice.as_ref() else { - return false; - }; - - let Expr::Name(return_annotation) = map_subscript(self.returns) else { - return false; - }; - - if slice.id != return_annotation.id { - return false; - } - - is_likely_private_typevar(&slice.id, self.type_params) - } -} - -#[derive(Debug)] -struct InstanceMethod<'a> { - self_annotation: &'a Expr, - returns: &'a Expr, - type_params: Option<&'a TypeParams>, -} - -impl<'a> InstanceMethod<'a> { - /// Returns `true` if the instance method is annotated with a custom `TypeVar` that is likely - /// private. - fn uses_custom_var(&self) -> bool { - let Expr::Name(ast::ExprName { - id: first_arg_type, .. - }) = self.self_annotation - else { - return false; - }; - - let Expr::Name(ast::ExprName { - id: return_type, .. - }) = map_subscript(self.returns) - else { - return false; - }; - - if first_arg_type != return_type { - return false; - } - - is_likely_private_typevar(first_arg_type, self.type_params) - } -} - -/// Returns `true` if the type variable is likely private. -fn is_likely_private_typevar(type_var_name: &str, type_params: Option<&TypeParams>) -> bool { - // Ex) `_T` - if type_var_name.starts_with('_') { - return true; - } - // Ex) `class Foo[T]: ...` - type_params.is_some_and(|type_params| { - type_params.iter().any(|type_param| { - if let TypeParam::TypeVar(ast::TypeParamTypeVar { name, .. }) = type_param { - name == type_var_name - } else { - false - } - }) - }) -} diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/docstring_in_stubs.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/docstring_in_stubs.rs index e03d359b963e0..140df88d42d8f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/docstring_in_stubs.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/docstring_in_stubs.rs @@ -1,9 +1,11 @@ use ruff_python_ast::ExprStringLiteral; -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; +use ruff_python_semantic::Definition; + use crate::checkers::ast::Checker; /// ## What it does @@ -26,21 +28,43 @@ use crate::checkers::ast::Checker; /// ```pyi /// def func(param: int) -> str: ... /// ``` -#[violation] -pub struct DocstringInStub; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringInStub; -impl Violation for DocstringInStub { +impl AlwaysFixableViolation for DocstringInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Docstrings should not be included in stubs") + "Docstrings should not be included in stubs".to_string() + } + + fn fix_title(&self) -> String { + "Remove docstring".to_string() } } /// PYI021 -pub(crate) fn docstring_in_stubs(checker: &mut Checker, docstring: Option<&ExprStringLiteral>) { - if let Some(docstr) = docstring { - checker - .diagnostics - .push(Diagnostic::new(DocstringInStub, docstr.range())); - } +pub(crate) fn docstring_in_stubs( + checker: &Checker, + definition: &Definition, + docstring: Option<&ExprStringLiteral>, +) { + let Some(docstring_range) = docstring.map(ExprStringLiteral::range) else { + return; + }; + + let statements = match definition { + Definition::Module(module) => module.python_ast, + Definition::Member(member) => member.body(), + }; + + let edit = if statements.len() == 1 { + Edit::range_replacement("...".to_string(), docstring_range) + } else { + Edit::range_deletion(docstring_range) + }; + + let fix = Fix::unsafe_edit(edit); + let diagnostic = Diagnostic::new(DocstringInStub, docstring_range).with_fix(fix); + + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_literal_member.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_literal_member.rs index 4c3a8001dc6d6..e2f831d0a12ba 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_literal_member.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_literal_member.rs @@ -2,12 +2,12 @@ use std::collections::HashSet; use rustc_hash::FxHashSet; -use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::Expr; +use ruff_python_ast::{self as ast, Expr, ExprContext}; use ruff_python_semantic::analyze::typing::traverse_literal; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -27,31 +27,42 @@ use crate::checkers::ast::Checker; /// foo: Literal["a", "b"] /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the type annotation contains comments. +/// +/// Note that while the fix may flatten nested literals into a single top-level literal, +/// the semantics of the annotation will remain unchanged. +/// /// ## References /// - [Python documentation: `typing.Literal`](https://docs.python.org/3/library/typing.html#typing.Literal) -#[violation] -pub struct DuplicateLiteralMember { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateLiteralMember { duplicate_name: String, } -impl Violation for DuplicateLiteralMember { - const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; - +impl AlwaysFixableViolation for DuplicateLiteralMember { #[derive_message_formats] fn message(&self) -> String { format!("Duplicate literal member `{}`", self.duplicate_name) } + + fn fix_title(&self) -> String { + "Remove duplicates".to_string() + } } /// PYI062 -pub(crate) fn duplicate_literal_member<'a>(checker: &mut Checker, expr: &'a Expr) { +pub(crate) fn duplicate_literal_member<'a>(checker: &Checker, expr: &'a Expr) { let mut seen_nodes: HashSet<ComparableExpr<'_>, _> = FxHashSet::default(); + let mut unique_nodes: Vec<&Expr> = Vec::new(); let mut diagnostics: Vec<Diagnostic> = Vec::new(); // Adds a member to `literal_exprs` if it is a `Literal` annotation let mut check_for_duplicate_members = |expr: &'a Expr, _: &'a Expr| { // If we've already seen this literal member, raise a violation. - if !seen_nodes.insert(expr.into()) { + if seen_nodes.insert(expr.into()) { + unique_nodes.push(expr); + } else { diagnostics.push(Diagnostic::new( DuplicateLiteralMember { duplicate_name: checker.generator().expr(expr), @@ -61,7 +72,44 @@ pub(crate) fn duplicate_literal_member<'a>(checker: &mut Checker, expr: &'a Expr } }; - // Traverse the literal, collect all diagnostic members + // Traverse the literal, collect all diagnostic members. traverse_literal(&mut check_for_duplicate_members, checker.semantic(), expr); - checker.diagnostics.append(&mut diagnostics); + + if diagnostics.is_empty() { + return; + } + + // If there's at least one diagnostic, create a fix to remove the duplicate members. + if let Expr::Subscript(subscript) = expr { + let subscript = Expr::Subscript(ast::ExprSubscript { + slice: Box::new(if let [elt] = unique_nodes.as_slice() { + (*elt).clone() + } else { + Expr::Tuple(ast::ExprTuple { + elts: unique_nodes.into_iter().cloned().collect(), + range: TextRange::default(), + ctx: ExprContext::Load, + parenthesized: false, + }) + }), + value: subscript.value.clone(), + range: TextRange::default(), + ctx: ExprContext::Load, + }); + let fix = Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(&subscript), expr.range()), + if checker.comment_ranges().intersects(expr.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + ); + for diagnostic in &mut diagnostics { + diagnostic.set_fix(fix.clone()); + } + } + + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_union_member.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_union_member.rs index b14cb5a72c04c..6ed4436c44396 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_union_member.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_union_member.rs @@ -2,15 +2,17 @@ use std::collections::HashSet; use rustc_hash::FxHashSet; -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::{self as ast, Expr}; +use ruff_python_ast::{Expr, ExprBinOp, Operator, PythonVersion}; use ruff_python_semantic::analyze::typing::traverse_union; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use super::generate_union_fix; + /// ## What it does /// Checks for duplicate union members. /// @@ -27,10 +29,16 @@ use crate::checkers::ast::Checker; /// foo: str /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as safe unless the union contains comments. +/// +/// For nested union, the fix will flatten type expressions into a single +/// top-level union. +/// /// ## References /// - [Python documentation: `typing.Union`](https://docs.python.org/3/library/typing.html#typing.Union) -#[violation] -pub struct DuplicateUnionMember { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateUnionMember { duplicate_name: String, } @@ -51,39 +59,126 @@ impl Violation for DuplicateUnionMember { } /// PYI016 -pub(crate) fn duplicate_union_member<'a>(checker: &mut Checker, expr: &'a Expr) { +pub(crate) fn duplicate_union_member<'a>(checker: &Checker, expr: &'a Expr) { let mut seen_nodes: HashSet<ComparableExpr<'_>, _> = FxHashSet::default(); + let mut unique_nodes: Vec<&Expr> = Vec::new(); let mut diagnostics: Vec<Diagnostic> = Vec::new(); + let mut union_type = UnionKind::TypingUnion; // Adds a member to `literal_exprs` if it is a `Literal` annotation let mut check_for_duplicate_members = |expr: &'a Expr, parent: &'a Expr| { + if matches!(parent, Expr::BinOp(_)) { + union_type = UnionKind::PEP604; + } + // If we've already seen this union member, raise a violation. - if !seen_nodes.insert(expr.into()) { - let mut diagnostic = Diagnostic::new( + if seen_nodes.insert(expr.into()) { + unique_nodes.push(expr); + } else { + diagnostics.push(Diagnostic::new( DuplicateUnionMember { duplicate_name: checker.generator().expr(expr), }, expr.range(), - ); - // Delete the "|" character as well as the duplicate value by reconstructing the - // parent without the duplicate. - - // If the parent node is not a `BinOp` we will not perform a fix - if let Expr::BinOp(ast::ExprBinOp { left, right, .. }) = parent { - // Replace the parent with its non-duplicate child. - let child = if expr == left.as_ref() { right } else { left }; - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - checker.locator().slice(child.as_ref()).to_string(), - parent.range(), - ))); - } - diagnostics.push(diagnostic); + )); } }; // Traverse the union, collect all diagnostic members traverse_union(&mut check_for_duplicate_members, checker.semantic(), expr); + if diagnostics.is_empty() { + return; + } + + // Mark [`Fix`] as unsafe when comments are in range. + let applicability = if checker.comment_ranges().intersects(expr.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + // Generate the flattened fix once. + let fix = if let &[edit_expr] = unique_nodes.as_slice() { + // Generate a [`Fix`] for a single type expression, e.g. `int`. + Some(Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(edit_expr), expr.range()), + applicability, + )) + } else { + match union_type { + // See redundant numeric union + UnionKind::PEP604 => Some(generate_pep604_fix( + checker, + unique_nodes, + expr, + applicability, + )), + UnionKind::TypingUnion => { + // Request `typing.Union` + let Some(importer) = checker.typing_importer("Union", PythonVersion::lowest()) + else { + return; + }; + generate_union_fix( + checker.generator(), + &importer, + unique_nodes, + expr, + applicability, + ) + .ok() + } + } + }; + + if let Some(fix) = fix { + for diagnostic in &mut diagnostics { + diagnostic.set_fix(fix.clone()); + } + } + // Add all diagnostics to the checker - checker.diagnostics.append(&mut diagnostics); + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum UnionKind { + /// E.g., `typing.Union[int, str]` + TypingUnion, + /// E.g., `int | str` + PEP604, +} + +/// Generate a [`Fix`] for two or more type expressions, e.g. `int | float | complex`. +fn generate_pep604_fix( + checker: &Checker, + nodes: Vec<&Expr>, + annotation: &Expr, + applicability: Applicability, +) -> Fix { + debug_assert!(nodes.len() >= 2, "At least two nodes required"); + + let new_expr = nodes + .into_iter() + .fold(None, |acc: Option<Expr>, right: &Expr| { + if let Some(left) = acc { + Some(Expr::BinOp(ExprBinOp { + left: Box::new(left), + op: Operator::BitOr, + right: Box::new(right.clone()), + range: TextRange::default(), + })) + } else { + Some(right.clone()) + } + }) + .unwrap(); + + Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(&new_expr), annotation.range()), + applicability, + ) } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/ellipsis_in_non_empty_class_body.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/ellipsis_in_non_empty_class_body.rs index 938a40730e7d8..b358ad801893e 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/ellipsis_in_non_empty_class_body.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/ellipsis_in_non_empty_class_body.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Stmt, StmtExpr}; use ruff_text_size::Ranged; @@ -26,15 +26,15 @@ use crate::fix; /// class Foo: /// value: int /// ``` -#[violation] -pub struct EllipsisInNonEmptyClassBody; +#[derive(ViolationMetadata)] +pub(crate) struct EllipsisInNonEmptyClassBody; impl Violation for EllipsisInNonEmptyClassBody { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Non-empty class body must not contain `...`") + "Non-empty class body must not contain `...`".to_string() } fn fix_title(&self) -> Option<String> { @@ -43,7 +43,7 @@ impl Violation for EllipsisInNonEmptyClassBody { } /// PYI013 -pub(crate) fn ellipsis_in_non_empty_class_body(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn ellipsis_in_non_empty_class_body(checker: &Checker, body: &[Stmt]) { // If the class body contains a single statement, then it's fine for it to be an ellipsis. if body.len() == 1 { return; @@ -61,7 +61,7 @@ pub(crate) fn ellipsis_in_non_empty_class_body(checker: &mut Checker, body: &[St diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/exit_annotations.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/exit_annotations.rs index 15a92bae415b4..1829f4930b66e 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/exit_annotations.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/exit_annotations.rs @@ -7,9 +7,9 @@ use ruff_python_ast::{ use smallvec::SmallVec; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; -use ruff_python_semantic::{analyze::visibility::is_overload, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze::visibility::is_overload}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -46,8 +46,8 @@ use crate::checkers::ast::Checker; /// tb: TracebackType | None, /// ) -> None: ... /// ``` -#[violation] -pub struct BadExitAnnotation { +#[derive(ViolationMetadata)] +pub(crate) struct BadExitAnnotation { func_kind: FuncKind, error_kind: ErrorKind, } @@ -59,17 +59,31 @@ impl Violation for BadExitAnnotation { fn message(&self) -> String { let method_name = self.func_kind.to_string(); match self.error_kind { - ErrorKind::StarArgsNotAnnotated => format!("Star-args in `{method_name}` should be annotated with `object`"), - ErrorKind::MissingArgs => format!("If there are no star-args, `{method_name}` should have at least 3 non-keyword-only args (excluding `self`)"), - ErrorKind::ArgsAfterFirstFourMustHaveDefault => format!("All arguments after the first four in `{method_name}` must have a default value"), - ErrorKind::AllKwargsMustHaveDefault => format!("All keyword-only arguments in `{method_name}` must have a default value"), - ErrorKind::FirstArgBadAnnotation => format!("The first argument in `{method_name}` should be annotated with `object` or `type[BaseException] | None`"), - ErrorKind::SecondArgBadAnnotation => format!("The second argument in `{method_name}` should be annotated with `object` or `BaseException | None`"), - ErrorKind::ThirdArgBadAnnotation => format!("The third argument in `{method_name}` should be annotated with `object` or `types.TracebackType | None`"), + ErrorKind::StarArgsNotAnnotated => { + format!("Star-args in `{method_name}` should be annotated with `object`") + } + ErrorKind::MissingArgs => format!( + "If there are no star-args, `{method_name}` should have at least 3 non-keyword-only args (excluding `self`)" + ), + ErrorKind::ArgsAfterFirstFourMustHaveDefault => format!( + "All arguments after the first four in `{method_name}` must have a default value" + ), + ErrorKind::AllKwargsMustHaveDefault => { + format!("All keyword-only arguments in `{method_name}` must have a default value") + } + ErrorKind::FirstArgBadAnnotation => format!( + "The first argument in `{method_name}` should be annotated with `object` or `type[BaseException] | None`" + ), + ErrorKind::SecondArgBadAnnotation => format!( + "The second argument in `{method_name}` should be annotated with `object` or `BaseException | None`" + ), + ErrorKind::ThirdArgBadAnnotation => format!( + "The third argument in `{method_name}` should be annotated with `object` or `types.TracebackType | None`" + ), ErrorKind::UnrecognizedExitOverload => format!( "Annotations for a three-argument `{method_name}` overload (excluding `self`) \ should either be `None, None, None` or `type[BaseException], BaseException, types.TracebackType`" - ) + ), } } @@ -116,7 +130,7 @@ enum ErrorKind { } /// PYI036 -pub(crate) fn bad_exit_annotation(checker: &mut Checker, function: &StmtFunctionDef) { +pub(crate) fn bad_exit_annotation(checker: &Checker, function: &StmtFunctionDef) { let StmtFunctionDef { is_async, decorator_list, @@ -167,7 +181,7 @@ pub(crate) fn bad_exit_annotation(checker: &mut Checker, function: &StmtFunction .skip(3) .filter(|parameter| parameter.default.is_none()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadExitAnnotation { func_kind, error_kind: ErrorKind::ArgsAfterFirstFourMustHaveDefault, @@ -182,7 +196,7 @@ pub(crate) fn bad_exit_annotation(checker: &mut Checker, function: &StmtFunction .iter() .filter(|arg| arg.default.is_none()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadExitAnnotation { func_kind, error_kind: ErrorKind::AllKwargsMustHaveDefault, @@ -196,11 +210,10 @@ pub(crate) fn bad_exit_annotation(checker: &mut Checker, function: &StmtFunction /// Determine whether a "short" argument list (i.e., an argument list with less than four elements) /// contains a star-args argument annotated with `object`. If not, report an error. -fn check_short_args_list(checker: &mut Checker, parameters: &Parameters, func_kind: FuncKind) { +fn check_short_args_list(checker: &Checker, parameters: &Parameters, func_kind: FuncKind) { if let Some(varargs) = ¶meters.vararg { if let Some(annotation) = varargs - .annotation - .as_ref() + .annotation() .filter(|ann| !is_object_or_unused(ann, checker.semantic())) { let mut diagnostic = Diagnostic::new( @@ -221,10 +234,10 @@ fn check_short_args_list(checker: &mut Checker, parameters: &Parameters, func_ki Ok(Fix::safe_edits(binding_edit, import_edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadExitAnnotation { func_kind, error_kind: ErrorKind::MissingArgs, @@ -237,8 +250,8 @@ fn check_short_args_list(checker: &mut Checker, parameters: &Parameters, func_ki /// Determines whether the positional arguments of an `__exit__` or `__aexit__` method /// (that is not decorated with `@typing.overload`) are annotated correctly. fn check_positional_args_for_non_overloaded_method( - checker: &mut Checker, - non_self_positional_args: &[&ParameterWithDefault], + checker: &Checker, + non_self_positional_params: &[&ParameterWithDefault], kind: FuncKind, ) { // For each argument, define the predicate against which to check the annotation. @@ -252,8 +265,10 @@ fn check_positional_args_for_non_overloaded_method( (ErrorKind::ThirdArgBadAnnotation, is_traceback_type), ]; - for (arg, (error_info, predicate)) in non_self_positional_args.iter().take(3).zip(validations) { - let Some(annotation) = arg.parameter.annotation.as_ref() else { + for (param, (error_info, predicate)) in + non_self_positional_params.iter().take(3).zip(validations) + { + let Some(annotation) = param.annotation() else { continue; }; @@ -269,7 +284,7 @@ fn check_positional_args_for_non_overloaded_method( continue; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadExitAnnotation { func_kind: kind, error_kind: error_info, @@ -282,7 +297,7 @@ fn check_positional_args_for_non_overloaded_method( /// Determines whether the positional arguments of an `__exit__` or `__aexit__` method /// overload are annotated correctly. fn check_positional_args_for_overloaded_method( - checker: &mut Checker, + checker: &Checker, non_self_positional_args: &[&ParameterWithDefault], kind: FuncKind, parent_class_def: &StmtClassDef, @@ -293,13 +308,9 @@ fn check_positional_args_for_overloaded_method( predicate: impl FnOnce(&Expr) -> bool, semantic: &SemanticModel, ) -> bool { - parameter - .parameter - .annotation - .as_ref() - .map_or(true, |annotation| { - predicate(annotation) || is_object_or_unused(annotation, semantic) - }) + parameter.annotation().is_none_or(|annotation| { + predicate(annotation) || is_object_or_unused(annotation, semantic) + }) } let semantic = checker.semantic(); @@ -412,7 +423,7 @@ fn check_positional_args_for_overloaded_method( } // Okay, neither of them match... - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadExitAnnotation { func_kind: kind, error_kind: ErrorKind::UnrecognizedExitOverload, diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/future_annotations_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/future_annotations_in_stub.rs index c3d50ceaea391..7f8d85871cf24 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/future_annotations_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/future_annotations_in_stub.rs @@ -1,9 +1,9 @@ use ruff_python_ast::StmtImportFrom; use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; -use crate::{checkers::ast::Checker, fix}; +use crate::{checkers::ast::Checker, fix, preview::is_fix_future_annotations_in_stub_enabled}; /// ## What it does /// Checks for the presence of the `from __future__ import annotations` import @@ -16,16 +16,16 @@ use crate::{checkers::ast::Checker, fix}; /// statement has no effect and should be omitted. /// /// ## References -/// - [Static Typing with Python: Type Stubs](https://typing.readthedocs.io/en/latest/source/stubs.html) -#[violation] -pub struct FutureAnnotationsInStub; +/// - [Static Typing with Python: Type Stubs](https://typing.python.org/en/latest/source/stubs.html) +#[derive(ViolationMetadata)] +pub(crate) struct FutureAnnotationsInStub; impl Violation for FutureAnnotationsInStub { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`from __future__ import annotations` has no effect in stub files, since type checkers automatically treat stubs as having those semantics") + "`from __future__ import annotations` has no effect in stub files, since type checkers automatically treat stubs as having those semantics".to_string() } fn fix_title(&self) -> Option<String> { @@ -34,35 +34,43 @@ impl Violation for FutureAnnotationsInStub { } /// PYI044 -pub(crate) fn from_future_import(checker: &mut Checker, target: &StmtImportFrom) { - if let StmtImportFrom { +pub(crate) fn from_future_import(checker: &Checker, target: &StmtImportFrom) { + let StmtImportFrom { range, - module: Some(name), + module: Some(module_name), names, .. } = target - { - if name == "__future__" && names.iter().any(|alias| &*alias.name == "annotations") { - let mut diagnostic = Diagnostic::new(FutureAnnotationsInStub, *range); + else { + return; + }; - if checker.settings.preview.is_enabled() { - let stmt = checker.semantic().current_statement(); + if module_name != "__future__" { + return; + } + + if names.iter().all(|alias| &*alias.name != "annotations") { + return; + } - diagnostic.try_set_fix(|| { - let edit = fix::edits::remove_unused_imports( - std::iter::once("annotations"), - stmt, - None, - checker.locator(), - checker.stylist(), - checker.indexer(), - )?; + let mut diagnostic = Diagnostic::new(FutureAnnotationsInStub, *range); - Ok(Fix::safe_edit(edit)) - }); - } + if is_fix_future_annotations_in_stub_enabled(checker.settings) { + let stmt = checker.semantic().current_statement(); - checker.diagnostics.push(diagnostic); - } + diagnostic.try_set_fix(|| { + let edit = fix::edits::remove_unused_imports( + std::iter::once("annotations"), + stmt, + None, + checker.locator(), + checker.stylist(), + checker.indexer(), + )?; + + Ok(Fix::safe_edit(edit)) + }); } + + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/generic_not_last_base_class.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/generic_not_last_base_class.rs index 1fe815fa10d9f..f4af4d5fefc1b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/generic_not_last_base_class.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/generic_not_last_base_class.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, helpers::map_subscript}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{add_argument, remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, add_argument, remove_argument}; /// ## What it does /// Checks for classes inheriting from `typing.Generic[]` where `Generic[]` is @@ -47,15 +47,15 @@ use crate::fix::edits::{add_argument, remove_argument, Parentheses}; /// - [`typing.Generic` documentation](https://docs.python.org/3/library/typing.html#typing.Generic) /// /// [1]: https://github.com/python/cpython/issues/106102 -#[violation] -pub struct GenericNotLastBaseClass; +#[derive(ViolationMetadata)] +pub(crate) struct GenericNotLastBaseClass; impl Violation for GenericNotLastBaseClass { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`Generic[]` should always be the last base class") + "`Generic[]` should always be the last base class".to_string() } fn fix_title(&self) -> Option<String> { @@ -64,7 +64,7 @@ impl Violation for GenericNotLastBaseClass { } /// PYI059 -pub(crate) fn generic_not_last_base_class(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn generic_not_last_base_class(checker: &Checker, class_def: &ast::StmtClassDef) { let Some(bases) = class_def.arguments.as_deref() else { return; }; @@ -99,7 +99,7 @@ pub(crate) fn generic_not_last_base_class(checker: &mut Checker, class_def: &ast diagnostic.try_set_fix(|| generate_fix(generic_base, bases, checker)); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } fn generate_fix( diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/iter_method_return_iterable.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/iter_method_return_iterable.rs index a2e0244b741b0..bcaa46086ff9f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/iter_method_return_iterable.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/iter_method_return_iterable.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; use ruff_text_size::Ranged; @@ -68,25 +68,25 @@ use crate::checkers::ast::Checker; /// class Klass: /// def __iter__(self) -> collections.abc.Iterator[str]: ... /// ``` -#[violation] -pub struct IterMethodReturnIterable { +#[derive(ViolationMetadata)] +pub(crate) struct IterMethodReturnIterable { is_async: bool, } impl Violation for IterMethodReturnIterable { #[derive_message_formats] fn message(&self) -> String { - let IterMethodReturnIterable { is_async } = self; - if *is_async { - format!("`__aiter__` methods should return an `AsyncIterator`, not an `AsyncIterable`") + if self.is_async { + "`__aiter__` methods should return an `AsyncIterator`, not an `AsyncIterable`" + .to_string() } else { - format!("`__iter__` methods should return an `Iterator`, not an `Iterable`") + "`__iter__` methods should return an `Iterator`, not an `Iterable`".to_string() } } } /// PYI045 -pub(crate) fn iter_method_return_iterable(checker: &mut Checker, definition: &Definition) { +pub(crate) fn iter_method_return_iterable(checker: &Checker, definition: &Definition) { let Definition::Member(Member { kind: MemberKind::Method(function), .. @@ -125,7 +125,7 @@ pub(crate) fn iter_method_return_iterable(checker: &mut Checker, definition: &De } }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( IterMethodReturnIterable { is_async }, returns.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/mod.rs index cfa311f2d7834..0b9826d9768c3 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/mod.rs @@ -1,3 +1,14 @@ +use std::fmt; + +use anyhow::Result; + +use ruff_diagnostics::{Applicability, Edit, Fix}; +use ruff_python_ast::{Expr, ExprContext, ExprName, ExprSubscript, ExprTuple, name::Name}; +use ruff_python_codegen::Generator; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::TypingImporter; + pub(crate) use any_eq_ne_annotation::*; pub(crate) use bad_generator_return_type::*; pub(crate) use bad_version_info_comparison::*; @@ -5,7 +16,7 @@ pub(crate) use bytestring_usage::*; pub(crate) use collections_named_tuple::*; pub(crate) use complex_assignment_in_stub::*; pub(crate) use complex_if_statement_in_stub::*; -pub(crate) use custom_type_var_return_type::*; +pub(crate) use custom_type_var_for_self::*; pub(crate) use docstring_in_stubs::*; pub(crate) use duplicate_literal_member::*; pub(crate) use duplicate_union_member::*; @@ -25,9 +36,9 @@ pub(crate) use prefix_type_params::*; pub(crate) use quoted_annotation_in_stub::*; pub(crate) use redundant_final_literal::*; pub(crate) use redundant_literal_union::*; +pub(crate) use redundant_none_literal::*; pub(crate) use redundant_numeric_union::*; pub(crate) use simple_defaults::*; -use std::fmt; pub(crate) use str_or_repr_defined_in_stub::*; pub(crate) use string_or_bytes_too_long::*; pub(crate) use stub_body_multiple_statements::*; @@ -48,7 +59,7 @@ mod bytestring_usage; mod collections_named_tuple; mod complex_assignment_in_stub; mod complex_if_statement_in_stub; -mod custom_type_var_return_type; +mod custom_type_var_for_self; mod docstring_in_stubs; mod duplicate_literal_member; mod duplicate_union_member; @@ -68,6 +79,7 @@ mod prefix_type_params; mod quoted_annotation_in_stub; mod redundant_final_literal; mod redundant_literal_union; +mod redundant_none_literal; mod redundant_numeric_union; mod simple_defaults; mod str_or_repr_defined_in_stub; @@ -105,3 +117,39 @@ impl fmt::Display for TypingModule { fmt.write_str(self.as_str()) } } + +/// Generate a [`Fix`] for two or more type expressions, e.g. `typing.Union[int, float, complex]`. +fn generate_union_fix( + generator: Generator, + importer: &TypingImporter, + nodes: Vec<&Expr>, + annotation: &Expr, + applicability: Applicability, +) -> Result<Fix> { + debug_assert!(nodes.len() >= 2, "At least two nodes required"); + + let (import_edit, binding) = importer.import(annotation.start())?; + + // Construct the expression as `Subscript[typing.Union, Tuple[expr, [expr, ...]]]` + let new_expr = Expr::Subscript(ExprSubscript { + range: TextRange::default(), + value: Box::new(Expr::Name(ExprName { + id: Name::new(binding), + ctx: ExprContext::Store, + range: TextRange::default(), + })), + slice: Box::new(Expr::Tuple(ExprTuple { + elts: nodes.into_iter().cloned().collect(), + range: TextRange::default(), + ctx: ExprContext::Load, + parenthesized: false, + })), + ctx: ExprContext::Load, + }); + + Ok(Fix::applicable_edits( + Edit::range_replacement(generator.expr(&new_expr), annotation.range()), + [import_edit], + applicability, + )) +} diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/no_return_argument_annotation.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/no_return_argument_annotation.rs index e07f868407b23..c657dce97e35d 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/no_return_argument_annotation.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/no_return_argument_annotation.rs @@ -1,12 +1,12 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion::Py311; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for uses of `typing.NoReturn` (and `typing_extensions.NoReturn`) for @@ -40,8 +40,8 @@ use crate::settings::types::PythonVersion::Py311; /// - [Python documentation: `typing.NoReturn`](https://docs.python.org/3/library/typing.html#typing.NoReturn) /// /// [bottom type]: https://en.wikipedia.org/wiki/Bottom_type -#[violation] -pub struct NoReturnArgumentAnnotationInStub { +#[derive(ViolationMetadata)] +pub(crate) struct NoReturnArgumentAnnotationInStub { module: TypingModule, } @@ -54,7 +54,7 @@ impl Violation for NoReturnArgumentAnnotationInStub { } /// PYI050 -pub(crate) fn no_return_argument_annotation(checker: &mut Checker, parameters: &ast::Parameters) { +pub(crate) fn no_return_argument_annotation(checker: &Checker, parameters: &ast::Parameters) { // Ex) def func(arg: NoReturn): ... // Ex) def func(arg: NoReturn, /): ... // Ex) def func(*, arg: NoReturn): ... @@ -65,9 +65,9 @@ pub(crate) fn no_return_argument_annotation(checker: &mut Checker, parameters: & .filter_map(ast::AnyParameterRef::annotation) { if is_no_return(annotation, checker) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NoReturnArgumentAnnotationInStub { - module: if checker.settings.target_version >= Py311 { + module: if checker.target_version() >= PythonVersion::PY311 { TypingModule::Typing } else { TypingModule::TypingExtensions diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/non_empty_stub_body.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/non_empty_stub_body.rs index 2324a9cb20f63..f6ec5b567d47f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/non_empty_stub_body.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/non_empty_stub_body.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::Ranged; @@ -26,24 +26,23 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [The recommended style for stub functions and methods](https://typing.readthedocs.io/en/latest/source/stubs.html#id6) -/// in the typing docs. -#[violation] -pub struct NonEmptyStubBody; +/// - [Typing documentation - Writing and Maintaining Stub Files](https://typing.python.org/en/latest/guides/writing_stubs.html) +#[derive(ViolationMetadata)] +pub(crate) struct NonEmptyStubBody; impl AlwaysFixableViolation for NonEmptyStubBody { #[derive_message_formats] fn message(&self) -> String { - format!("Function body must contain only `...`") + "Function body must contain only `...`".to_string() } fn fix_title(&self) -> String { - format!("Replace function body with `...`") + "Replace function body with `...`".to_string() } } /// PYI010 -pub(crate) fn non_empty_stub_body(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn non_empty_stub_body(checker: &Checker, body: &[Stmt]) { // Ignore multi-statement bodies (covered by PYI048). let [stmt] = body else { return; @@ -68,8 +67,8 @@ pub(crate) fn non_empty_stub_body(checker: &mut Checker, body: &[Stmt]) { let mut diagnostic = Diagnostic::new(NonEmptyStubBody, stmt.range()); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - format!("..."), + "...".to_string(), stmt.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/non_self_return_type.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/non_self_return_type.rs index 706c377b9dec0..1329cabaac653 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/non_self_return_type.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/non_self_return_type.rs @@ -1,14 +1,15 @@ -use ruff_python_ast::{self as ast, Decorator, Expr, Parameters, Stmt}; - -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use crate::checkers::ast::{Checker, TypingImporter}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; +use ruff_python_ast::PythonVersion; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze; +use ruff_python_semantic::analyze::class::might_be_generic; use ruff_python_semantic::analyze::visibility::{is_abstract, is_final, is_overload}; use ruff_python_semantic::{ScopeKind, SemanticModel}; - -use crate::checkers::ast::Checker; +use ruff_text_size::Ranged; /// ## What it does /// Checks for methods that are annotated with a fixed return type which @@ -70,42 +71,61 @@ use crate::checkers::ast::Checker; /// async def __aenter__(self) -> Self: ... /// def __iadd__(self, other: Foo) -> Self: ... /// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe as it changes the meaning of your type annotations. +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for Python versions +/// before 3.11, its diagnostic will not be emitted, and no fix will be offered, if +/// `typing_extensions` imports have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +/// /// ## References -/// - [`typing.Self` documentation](https://docs.python.org/3/library/typing.html#typing.Self) -#[violation] -pub struct NonSelfReturnType { +/// - [Python documentation: `typing.Self`](https://docs.python.org/3/library/typing.html#typing.Self) +#[derive(ViolationMetadata)] +pub(crate) struct NonSelfReturnType { class_name: String, method_name: String, } impl Violation for NonSelfReturnType { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { let NonSelfReturnType { class_name, method_name, } = self; + if matches!(class_name.as_str(), "__new__") { - format!("`__new__` methods usually return `self` at runtime") + "`__new__` methods usually return `self` at runtime".to_string() } else { - format!("`{method_name}` methods in classes like `{class_name}` usually return `self` at runtime") + format!( + "`{method_name}` methods in classes like `{class_name}` usually return `self` at runtime" + ) } } fn fix_title(&self) -> Option<String> { - Some("Consider using `typing_extensions.Self` as return type".to_string()) + Some("Use `Self` as return type".to_string()) } } /// PYI034 pub(crate) fn non_self_return_type( - checker: &mut Checker, - stmt: &Stmt, + checker: &Checker, + stmt: &ast::Stmt, is_async: bool, name: &str, - decorator_list: &[Decorator], - returns: Option<&Expr>, - parameters: &Parameters, + decorator_list: &[ast::Decorator], + returns: Option<&ast::Expr>, + parameters: &ast::Parameters, ) { let semantic = checker.semantic(); @@ -122,7 +142,7 @@ pub(crate) fn non_self_return_type( }; // PEP 673 forbids the use of `typing(_extensions).Self` in metaclasses. - if analyze::class::is_metaclass(class_def, semantic) { + if analyze::class::is_metaclass(class_def, semantic).is_yes() { return; } @@ -136,13 +156,7 @@ pub(crate) fn non_self_return_type( && is_name(returns, &class_def.name) && !is_final(&class_def.decorator_list, semantic) { - checker.diagnostics.push(Diagnostic::new( - NonSelfReturnType { - class_name: class_def.name.to_string(), - method_name: name.to_string(), - }, - stmt.identifier(), - )); + add_diagnostic(checker, stmt, returns, class_def, name); } return; } @@ -150,13 +164,7 @@ pub(crate) fn non_self_return_type( // In-place methods that are expected to return `Self`. if is_inplace_bin_op(name) { if !is_self(returns, checker) { - checker.diagnostics.push(Diagnostic::new( - NonSelfReturnType { - class_name: class_def.name.to_string(), - method_name: name.to_string(), - }, - stmt.identifier(), - )); + add_diagnostic(checker, stmt, returns, class_def, name); } return; } @@ -164,13 +172,7 @@ pub(crate) fn non_self_return_type( if is_name(returns, &class_def.name) { if matches!(name, "__enter__" | "__new__") && !is_final(&class_def.decorator_list, semantic) { - checker.diagnostics.push(Diagnostic::new( - NonSelfReturnType { - class_name: class_def.name.to_string(), - method_name: name.to_string(), - }, - stmt.identifier(), - )); + add_diagnostic(checker, stmt, returns, class_def, name); } return; } @@ -180,32 +182,96 @@ pub(crate) fn non_self_return_type( if is_iterable_or_iterator(returns, semantic) && subclasses_iterator(class_def, semantic) { - checker.diagnostics.push(Diagnostic::new( - NonSelfReturnType { - class_name: class_def.name.to_string(), - method_name: name.to_string(), - }, - stmt.identifier(), - )); + add_diagnostic(checker, stmt, returns, class_def, name); } } "__aiter__" => { if is_async_iterable_or_iterator(returns, semantic) && subclasses_async_iterator(class_def, semantic) { - checker.diagnostics.push(Diagnostic::new( - NonSelfReturnType { - class_name: class_def.name.to_string(), - method_name: name.to_string(), - }, - stmt.identifier(), - )); + add_diagnostic(checker, stmt, returns, class_def, name); } } _ => {} } } +/// Add a diagnostic for the given method. +fn add_diagnostic( + checker: &Checker, + stmt: &ast::Stmt, + returns: &ast::Expr, + class_def: &ast::StmtClassDef, + method_name: &str, +) { + let Some(importer) = checker.typing_importer("Self", PythonVersion::PY311) else { + return; + }; + + let mut diagnostic = Diagnostic::new( + NonSelfReturnType { + class_name: class_def.name.to_string(), + method_name: method_name.to_string(), + }, + stmt.identifier(), + ); + + diagnostic.try_set_fix(|| { + replace_with_self_fix(checker.semantic(), &importer, stmt, returns, class_def) + }); + + checker.report_diagnostic(diagnostic); +} + +fn replace_with_self_fix( + semantic: &SemanticModel, + importer: &TypingImporter, + stmt: &ast::Stmt, + returns: &ast::Expr, + class_def: &ast::StmtClassDef, +) -> anyhow::Result<Fix> { + let (self_import, self_binding) = importer.import(returns.start())?; + + let mut others = Vec::with_capacity(2); + + let remove_first_argument_type_hint = || -> Option<Edit> { + let ast::StmtFunctionDef { parameters, .. } = stmt.as_function_def_stmt()?; + let first = parameters.iter().next()?; + let annotation = first.annotation()?; + + is_class_reference(semantic, annotation, &class_def.name) + .then(|| Edit::deletion(first.name().end(), annotation.end())) + }; + + others.extend(remove_first_argument_type_hint()); + others.push(Edit::range_replacement(self_binding, returns.range())); + + let applicability = if might_be_generic(class_def, semantic) { + Applicability::DisplayOnly + } else { + Applicability::Unsafe + }; + + Ok(Fix::applicable_edits(self_import, others, applicability)) +} + +/// Return true if `annotation` is either `ClassName` or `type[ClassName]` +fn is_class_reference(semantic: &SemanticModel, annotation: &ast::Expr, expected: &str) -> bool { + if is_name(annotation, expected) { + return true; + } + + let ast::Expr::Subscript(ast::ExprSubscript { value, slice, .. }) = annotation else { + return false; + }; + + if !semantic.match_builtin_expr(value, "type") && !semantic.match_typing_expr(value, "Type") { + return false; + } + + is_name(slice, expected) +} + /// Returns `true` if the method is an in-place binary operator. fn is_inplace_bin_op(name: &str) -> bool { matches!( @@ -227,15 +293,15 @@ fn is_inplace_bin_op(name: &str) -> bool { } /// Return `true` if the given expression resolves to the given name. -fn is_name(expr: &Expr, name: &str) -> bool { - let Expr::Name(ast::ExprName { id, .. }) = expr else { +fn is_name(expr: &ast::Expr, name: &str) -> bool { + let ast::Expr::Name(ast::ExprName { id, .. }) = expr else { return false; }; id.as_str() == name } /// Return `true` if the given expression resolves to `typing.Self`. -fn is_self(expr: &Expr, checker: &Checker) -> bool { +fn is_self(expr: &ast::Expr, checker: &Checker) -> bool { checker.match_maybe_stringized_annotation(expr, |expr| { checker.semantic().match_typing_expr(expr, "Self") }) @@ -252,7 +318,7 @@ fn subclasses_iterator(class_def: &ast::StmtClassDef, semantic: &SemanticModel) } /// Return `true` if the given expression resolves to `collections.abc.Iterable` or `collections.abc.Iterator`. -fn is_iterable_or_iterator(expr: &Expr, semantic: &SemanticModel) -> bool { +fn is_iterable_or_iterator(expr: &ast::Expr, semantic: &SemanticModel) -> bool { semantic .resolve_qualified_name(map_subscript(expr)) .is_some_and(|qualified_name| { @@ -275,7 +341,7 @@ fn subclasses_async_iterator(class_def: &ast::StmtClassDef, semantic: &SemanticM } /// Return `true` if the given expression resolves to `collections.abc.AsyncIterable` or `collections.abc.AsyncIterator`. -fn is_async_iterable_or_iterator(expr: &Expr, semantic: &SemanticModel) -> bool { +fn is_async_iterable_or_iterator(expr: &ast::Expr, semantic: &SemanticModel) -> bool { semantic .resolve_qualified_name(map_subscript(expr)) .is_some_and(|qualified_name| { diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/numeric_literal_too_long.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/numeric_literal_too_long.rs index 11e70892fbb47..fc258077a68d1 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/numeric_literal_too_long.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/numeric_literal_too_long.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::{Ranged, TextSize}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -12,7 +12,7 @@ use crate::checkers::ast::Checker; /// /// ## Why is this bad? /// If a function has a default value where the literal representation is -/// greater than 50 characters, the value is likely to be an implementation +/// greater than 10 characters, the value is likely to be an implementation /// detail or a constant that varies depending on the system you're running on. /// /// Default values like these should generally be omitted from stubs. Use @@ -29,13 +29,14 @@ use crate::checkers::ast::Checker; /// ```pyi /// def foo(arg: int = ...) -> None: ... /// ``` -#[violation] -pub struct NumericLiteralTooLong; +#[derive(ViolationMetadata)] +pub(crate) struct NumericLiteralTooLong; impl AlwaysFixableViolation for NumericLiteralTooLong { #[derive_message_formats] fn message(&self) -> String { - format!("Numeric literals with a string representation longer than ten characters are not permitted") + "Numeric literals with a string representation longer than ten characters are not permitted" + .to_string() } fn fix_title(&self) -> String { @@ -44,7 +45,7 @@ impl AlwaysFixableViolation for NumericLiteralTooLong { } /// PYI054 -pub(crate) fn numeric_literal_too_long(checker: &mut Checker, expr: &Expr) { +pub(crate) fn numeric_literal_too_long(checker: &Checker, expr: &Expr) { if expr.range().len() <= TextSize::new(10) { return; } @@ -54,5 +55,5 @@ pub(crate) fn numeric_literal_too_long(checker: &mut Checker, expr: &Expr) { "...".to_string(), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_in_class_body.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_in_class_body.rs index 06e13a6090fae..2ba5d60dcd5fb 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_in_class_body.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_in_class_body.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -26,22 +26,22 @@ use crate::fix; /// class MyClass: /// x: int /// ``` -#[violation] -pub struct PassInClassBody; +#[derive(ViolationMetadata)] +pub(crate) struct PassInClassBody; impl AlwaysFixableViolation for PassInClassBody { #[derive_message_formats] fn message(&self) -> String { - format!("Class body must not contain `pass`") + "Class body must not contain `pass`".to_string() } fn fix_title(&self) -> String { - format!("Remove unnecessary `pass`") + "Remove unnecessary `pass`".to_string() } } /// PYI012 -pub(crate) fn pass_in_class_body(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn pass_in_class_body(checker: &Checker, class_def: &ast::StmtClassDef) { // `pass` is required in these situations (or handled by `pass_statement_stub_body`). if class_def.body.len() < 2 { return; @@ -57,6 +57,6 @@ pub(crate) fn pass_in_class_body(checker: &mut Checker, class_def: &ast::StmtCla diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_statement_stub_body.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_statement_stub_body.rs index ce2dd53b61be9..c3ea8bccca77e 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_statement_stub_body.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/pass_statement_stub_body.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; use ruff_text_size::Ranged; @@ -23,32 +23,31 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// The [recommended style for functions and methods](https://typing.readthedocs.io/en/latest/source/stubs.html#functions-and-methods) -/// in the typing docs. -#[violation] -pub struct PassStatementStubBody; +/// - [Typing documentation - Writing and Maintaining Stub Files](https://typing.python.org/en/latest/guides/writing_stubs.html) +#[derive(ViolationMetadata)] +pub(crate) struct PassStatementStubBody; impl AlwaysFixableViolation for PassStatementStubBody { #[derive_message_formats] fn message(&self) -> String { - format!("Empty body should contain `...`, not `pass`") + "Empty body should contain `...`, not `pass`".to_string() } fn fix_title(&self) -> String { - format!("Replace `pass` with `...`") + "Replace `pass` with `...`".to_string() } } /// PYI009 -pub(crate) fn pass_statement_stub_body(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn pass_statement_stub_body(checker: &Checker, body: &[Stmt]) { let [Stmt::Pass(pass)] = body else { return; }; let mut diagnostic = Diagnostic::new(PassStatementStubBody, pass.range()); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - format!("..."), + "...".to_string(), pass.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/pre_pep570_positional_argument.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/pre_pep570_positional_argument.rs index 135dab0647746..f078e74cdd3d3 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/pre_pep570_positional_argument.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/pre_pep570_positional_argument.rs @@ -1,19 +1,26 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::{self as ast, ParameterWithDefault}; use ruff_python_semantic::analyze::function_type; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does -/// Checks for the presence of [PEP 484]-style positional-only arguments. +/// Checks for the presence of [PEP 484]-style positional-only parameters. /// /// ## Why is this bad? -/// Historically, [PEP 484] recommended prefixing positional-only arguments -/// with a double underscore (`__`). However, [PEP 570] introduced a dedicated -/// syntax for positional-only arguments, which should be preferred. +/// Historically, [PEP 484] recommended prefixing parameter names with double +/// underscores (`__`) to indicate to a type checker that they were +/// positional-only. However, [PEP 570] (introduced in Python 3.8) introduced +/// dedicated syntax for positional-only arguments. If a forward slash (`/`) is +/// present in a function signature on Python 3.8+, all parameters prior to the +/// slash are interpreted as positional-only. +/// +/// The new syntax should be preferred as it is more widely used, more concise +/// and more readable. It is also respected by Python at runtime, whereas the +/// old-style syntax was only understood by type checkers. /// /// ## Example /// @@ -27,15 +34,18 @@ use crate::settings::types::PythonVersion; /// def foo(x: int, /) -> None: ... /// ``` /// +/// ## Options +/// - `target-version` +/// /// [PEP 484]: https://peps.python.org/pep-0484/#positional-only-arguments /// [PEP 570]: https://peps.python.org/pep-0570 -#[violation] -pub struct PrePep570PositionalArgument; +#[derive(ViolationMetadata)] +pub(crate) struct Pep484StylePositionalOnlyParameter; -impl Violation for PrePep570PositionalArgument { +impl Violation for Pep484StylePositionalOnlyParameter { #[derive_message_formats] fn message(&self) -> String { - format!("Use PEP 570 syntax for positional-only arguments") + "Use PEP 570 syntax for positional-only parameters".to_string() } fn fix_title(&self) -> Option<String> { @@ -44,12 +54,9 @@ impl Violation for PrePep570PositionalArgument { } /// PYI063 -pub(crate) fn pre_pep570_positional_argument( - checker: &mut Checker, - function_def: &ast::StmtFunctionDef, -) { +pub(crate) fn pep_484_positional_parameter(checker: &Checker, function_def: &ast::StmtFunctionDef) { // PEP 570 was introduced in Python 3.8. - if checker.settings.target_version < PythonVersion::Py38 { + if checker.target_version() < PythonVersion::PY38 { return; } @@ -79,18 +86,18 @@ pub(crate) fn pre_pep570_positional_argument( )); if let Some(arg) = function_def.parameters.args.get(skip) { - if is_pre_pep570_positional_only(arg) { - checker.diagnostics.push(Diagnostic::new( - PrePep570PositionalArgument, + if is_old_style_positional_only(arg) { + checker.report_diagnostic(Diagnostic::new( + Pep484StylePositionalOnlyParameter, arg.identifier(), )); } } } -/// Returns `true` if the [`ParameterWithDefault`] is an old-style positional-only argument (i.e., +/// Returns `true` if the [`ParameterWithDefault`] is an old-style positional-only parameter (i.e., /// its name starts with `__` and does not end with `__`). -fn is_pre_pep570_positional_only(arg: &ParameterWithDefault) -> bool { - let arg_name = &arg.parameter.name; +fn is_old_style_positional_only(param: &ParameterWithDefault) -> bool { + let arg_name = param.name(); arg_name.starts_with("__") && !arg_name.ends_with("__") } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/prefix_type_params.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/prefix_type_params.rs index a1f696d39990a..73c452fe23507 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/prefix_type_params.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/prefix_type_params.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -45,8 +45,8 @@ impl fmt::Display for VarKind { /// /// _T = TypeVar("_T") /// ``` -#[violation] -pub struct UnprefixedTypeParam { +#[derive(ViolationMetadata)] +pub(crate) struct UnprefixedTypeParam { kind: VarKind, } @@ -59,7 +59,7 @@ impl Violation for UnprefixedTypeParam { } /// PYI001 -pub(crate) fn prefix_type_params(checker: &mut Checker, value: &Expr, targets: &[Expr]) { +pub(crate) fn prefix_type_params(checker: &Checker, value: &Expr, targets: &[Expr]) { // If the typing modules were never imported, we'll never match below. if !checker.semantic().seen_typing() { return; @@ -73,7 +73,7 @@ pub(crate) fn prefix_type_params(checker: &mut Checker, value: &Expr, targets: & if id.starts_with('_') { return; } - }; + } let Expr::Call(ast::ExprCall { func, .. }) = value else { return; @@ -106,7 +106,5 @@ pub(crate) fn prefix_type_params(checker: &mut Checker, value: &Expr, targets: & return; }; - checker - .diagnostics - .push(Diagnostic::new(UnprefixedTypeParam { kind }, value.range())); + checker.report_diagnostic(Diagnostic::new(UnprefixedTypeParam { kind }, value.range())); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/quoted_annotation_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/quoted_annotation_in_stub.rs index 4e6cf0e00856f..6b00c41d921ff 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/quoted_annotation_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/quoted_annotation_in_stub.rs @@ -1,7 +1,7 @@ use ruff_text_size::TextRange; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -27,14 +27,14 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [Static Typing with Python: Type Stubs](https://typing.readthedocs.io/en/latest/source/stubs.html) -#[violation] -pub struct QuotedAnnotationInStub; +/// - [Typing documentation - Writing and Maintaining Stub Files](https://typing.python.org/en/latest/guides/writing_stubs.html) +#[derive(ViolationMetadata)] +pub(crate) struct QuotedAnnotationInStub; impl AlwaysFixableViolation for QuotedAnnotationInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Quoted annotations should not be included in stubs") + "Quoted annotations should not be included in stubs".to_string() } fn fix_title(&self) -> String { @@ -43,11 +43,11 @@ impl AlwaysFixableViolation for QuotedAnnotationInStub { } /// PYI020 -pub(crate) fn quoted_annotation_in_stub(checker: &mut Checker, annotation: &str, range: TextRange) { +pub(crate) fn quoted_annotation_in_stub(checker: &Checker, annotation: &str, range: TextRange) { let mut diagnostic = Diagnostic::new(QuotedAnnotationInStub, range); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( annotation.to_string(), range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_final_literal.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_final_literal.rs index be77a3a948efe..1d5761db77c6b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_final_literal.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_final_literal.rs @@ -1,33 +1,40 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, comparable::ComparableExpr}; use ruff_text_size::{Ranged, TextSize}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; -use crate::Locator; /// ## What it does /// Checks for redundant `Final[Literal[...]]` annotations. /// /// ## Why is this bad? -/// A `Final[Literal[...]]` annotation can be replaced with `Final`; the literal -/// use is unnecessary. +/// All constant variables annotated as `Final` are understood as implicitly +/// having `Literal` types by a type checker. As such, a `Final[Literal[...]]` +/// annotation can often be replaced with a bare `Final`, annotation, which +/// will have the same meaning to the type checker while being more concise and +/// more readable. /// /// ## Example /// /// ```pyi +/// from typing import Final, Literal +/// /// x: Final[Literal[42]] /// y: Final[Literal[42]] = 42 /// ``` /// /// Use instead: /// ```pyi +/// from typing import Final, Literal +/// /// x: Final = 42 /// y: Final = 42 /// ``` -#[violation] -pub struct RedundantFinalLiteral { +#[derive(ViolationMetadata)] +pub(crate) struct RedundantFinalLiteral { literal: SourceCodeSnippet, } @@ -49,7 +56,7 @@ impl Violation for RedundantFinalLiteral { } /// PYI064 -pub(crate) fn redundant_final_literal(checker: &mut Checker, ann_assign: &ast::StmtAnnAssign) { +pub(crate) fn redundant_final_literal(checker: &Checker, ann_assign: &ast::StmtAnnAssign) { if !checker.semantic().seen_typing() { return; } @@ -107,7 +114,7 @@ pub(crate) fn redundant_final_literal(checker: &mut Checker, ann_assign: &ast::S diagnostic.set_fix(generate_fix(annotation, Some(literal), checker.locator())); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Generate a fix to convert a `Final[Literal[...]]` annotation to a `Final` annotation. diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_literal_union.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_literal_union.rs index 282e17d71c19f..fdb545bedfa06 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_literal_union.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_literal_union.rs @@ -3,10 +3,10 @@ use std::fmt; use rustc_hash::FxHashSet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, LiteralExpressionRef}; -use ruff_python_semantic::analyze::typing::traverse_union; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing::traverse_union; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -36,8 +36,8 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// x: Literal[b"B"] | str /// ``` -#[violation] -pub struct RedundantLiteralUnion { +#[derive(ViolationMetadata)] +pub(crate) struct RedundantLiteralUnion { literal: SourceCodeSnippet, builtin_type: ExprType, } @@ -58,7 +58,7 @@ impl Violation for RedundantLiteralUnion { } /// PYI051 -pub(crate) fn redundant_literal_union<'a>(checker: &mut Checker, union: &'a Expr) { +pub(crate) fn redundant_literal_union<'a>(checker: &Checker, union: &'a Expr) { let mut typing_literal_exprs = Vec::new(); let mut builtin_types_in_union = FxHashSet::default(); @@ -90,7 +90,7 @@ pub(crate) fn redundant_literal_union<'a>(checker: &mut Checker, union: &'a Expr }; if builtin_types_in_union.contains(&literal_type) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RedundantLiteralUnion { literal: SourceCodeSnippet::from_str( checker.locator().slice(typing_literal_expr), diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_none_literal.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_none_literal.rs new file mode 100644 index 0000000000000..a9f1b50226cd2 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_none_literal.rs @@ -0,0 +1,256 @@ +use anyhow::Result; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + self as ast, Expr, ExprBinOp, ExprContext, ExprNoneLiteral, Operator, PythonVersion, + helpers::{pep_604_union, typing_optional}, + name::Name, +}; +use ruff_python_semantic::analyze::typing::{traverse_literal, traverse_union}; +use ruff_text_size::{Ranged, TextRange}; + +use smallvec::SmallVec; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for redundant `Literal[None]` annotations. +/// +/// ## Why is this bad? +/// While `Literal[None]` is a valid type annotation, it is semantically equivalent to `None`. +/// Prefer `None` over `Literal[None]` for both consistency and readability. +/// +/// ## Example +/// ```python +/// from typing import Literal +/// +/// Literal[None] +/// Literal[1, 2, 3, "foo", 5, None] +/// ``` +/// +/// Use instead: +/// ```python +/// from typing import Literal +/// +/// None +/// Literal[1, 2, 3, "foo", 5] | None +/// ``` +/// +/// ## Fix safety and availability +/// This rule's fix is marked as safe unless the literal contains comments. +/// +/// There is currently no fix available when applying the fix would lead to +/// a `TypeError` from an expression of the form `None | None` or when we +/// are unable to import the symbol `typing.Optional` and the Python version +/// is 3.9 or below. +/// +/// ## References +/// - [Typing documentation: Legal parameters for `Literal` at type check time](https://typing.python.org/en/latest/spec/literal.html#legal-parameters-for-literal-at-type-check-time) +#[derive(ViolationMetadata)] +pub(crate) struct RedundantNoneLiteral { + union_kind: UnionKind, +} + +impl Violation for RedundantNoneLiteral { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + match self.union_kind { + UnionKind::NoUnion => "Use `None` rather than `Literal[None]`".to_string(), + UnionKind::TypingOptional => { + "Use `Optional[Literal[...]]` rather than `Literal[None, ...]` ".to_string() + } + UnionKind::BitOr => { + "Use `Literal[...] | None` rather than `Literal[None, ...]` ".to_string() + } + } + } + + fn fix_title(&self) -> Option<String> { + Some(match self.union_kind { + UnionKind::NoUnion => "Replace with `None`".to_string(), + UnionKind::TypingOptional => "Replace with `Optional[Literal[...]]`".to_string(), + UnionKind::BitOr => "Replace with `Literal[...] | None`".to_string(), + }) + } +} + +/// PYI061 +pub(crate) fn redundant_none_literal<'a>(checker: &Checker, literal_expr: &'a Expr) { + let semantic = checker.semantic(); + + if !semantic.seen_typing() { + return; + } + + let Expr::Subscript(ast::ExprSubscript { + value: literal_subscript, + .. + }) = literal_expr + else { + return; + }; + + let mut none_exprs: SmallVec<[&ExprNoneLiteral; 1]> = SmallVec::new(); + let mut literal_elements = vec![]; + + let mut partition_literal_elements = |expr: &'a Expr, _parent: &'a Expr| { + if let Expr::NoneLiteral(none_expr) = expr { + none_exprs.push(none_expr); + } else { + literal_elements.push(expr); + } + }; + + traverse_literal(&mut partition_literal_elements, semantic, literal_expr); + + if none_exprs.is_empty() { + return; + } + + let union_kind = if literal_elements.is_empty() { + UnionKind::NoUnion + } else if (checker.target_version() >= PythonVersion::PY310) || checker.source_type.is_stub() { + UnionKind::BitOr + } else { + UnionKind::TypingOptional + }; + + // N.B. Applying the fix can leave an unused import to be fixed by the `unused-import` rule. + for none_expr in none_exprs { + let mut diagnostic = + Diagnostic::new(RedundantNoneLiteral { union_kind }, none_expr.range()); + diagnostic.try_set_optional_fix(|| { + create_fix( + checker, + literal_expr, + literal_subscript, + literal_elements.clone(), + union_kind, + ) + // Isolate the fix to ensure multiple fixes on the same expression (like + // `Literal[None,] | Literal[None,]` -> `None | None`) happen across separate passes, + // preventing the production of invalid code. + .map(|fix| { + fix.map(|fix| fix.isolate(Checker::isolation(semantic.current_statement_id()))) + }) + }); + checker.report_diagnostic(diagnostic); + } +} + +/// If possible, return a [`Fix`] for a violation of this rule. +/// +/// Avoid producing code that would raise an exception when +/// `Literal[None] | None` would be fixed to `None | None`. +/// Instead, do not provide a fix. We don't need to worry about unions +/// that use [`typing.Union`], as `Union[None, None]` is valid Python. +/// See <https://github.com/astral-sh/ruff/issues/14567>. +/// +/// [`typing.Union`]: https://docs.python.org/3/library/typing.html#typing.Union +fn create_fix( + checker: &Checker, + literal_expr: &Expr, + literal_subscript: &Expr, + literal_elements: Vec<&Expr>, + union_kind: UnionKind, +) -> Result<Option<Fix>> { + let semantic = checker.semantic(); + + let enclosing_pep604_union = semantic + .current_expressions() + .skip(1) + .take_while(|expr| { + matches!( + expr, + Expr::BinOp(ExprBinOp { + op: Operator::BitOr, + .. + }) + ) + }) + .last(); + + if let Some(enclosing_pep604_union) = enclosing_pep604_union { + let mut is_fixable = true; + + traverse_union( + &mut |expr, _| { + if expr.is_none_literal_expr() { + is_fixable = false; + } + }, + semantic, + enclosing_pep604_union, + ); + + if !is_fixable { + return Ok(None); + } + } + + let applicability = if checker.comment_ranges().intersects(literal_expr.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + if matches!(union_kind, UnionKind::NoUnion) { + return Ok(Some(Fix::applicable_edit( + Edit::range_replacement("None".to_string(), literal_expr.range()), + applicability, + ))); + } + + let new_literal_expr = Expr::Subscript(ast::ExprSubscript { + value: Box::new(literal_subscript.clone()), + range: TextRange::default(), + ctx: ExprContext::Load, + slice: Box::new(if literal_elements.len() > 1 { + Expr::Tuple(ast::ExprTuple { + elts: literal_elements.into_iter().cloned().collect(), + range: TextRange::default(), + ctx: ExprContext::Load, + parenthesized: true, + }) + } else { + literal_elements[0].clone() + }), + }); + + let fix = match union_kind { + UnionKind::TypingOptional => { + let Some(importer) = checker.typing_importer("Optional", PythonVersion::lowest()) + else { + return Ok(None); + }; + let (import_edit, bound_name) = importer.import(literal_expr.start())?; + let optional_expr = typing_optional(new_literal_expr, Name::from(bound_name)); + let content = checker.generator().expr(&optional_expr); + let optional_edit = Edit::range_replacement(content, literal_expr.range()); + Fix::applicable_edits(import_edit, [optional_edit], applicability) + } + UnionKind::BitOr => { + let none_expr = Expr::NoneLiteral(ExprNoneLiteral { + range: TextRange::default(), + }); + let union_expr = pep_604_union(&[new_literal_expr, none_expr]); + let content = checker.generator().expr(&union_expr); + let union_edit = Edit::range_replacement(content, literal_expr.range()); + Fix::applicable_edit(union_edit, applicability) + } + // We dealt with this case earlier to avoid allocating `lhs` and `rhs` + UnionKind::NoUnion => { + unreachable!() + } + }; + Ok(Some(fix)) +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +enum UnionKind { + NoUnion, + TypingOptional, + BitOr, +} diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_numeric_union.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_numeric_union.rs index 00c4296fa658b..23f7cb4a03181 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_numeric_union.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/redundant_numeric_union.rs @@ -1,11 +1,15 @@ -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{AnyParameterRef, Expr, Parameters}; +use bitflags::bitflags; + +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{AnyParameterRef, Expr, ExprBinOp, Operator, Parameters, PythonVersion}; use ruff_python_semantic::analyze::typing::traverse_union; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use super::generate_union_fix; + /// ## What it does /// Checks for parameter annotations that contain redundant unions between /// builtin numeric types (e.g., `int | float`). @@ -37,86 +41,227 @@ use crate::checkers::ast::Checker; /// def foo(x: float | str) -> None: ... /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the type annotation contains comments. +/// +/// Note that while the fix may flatten nested unions into a single top-level union, +/// the semantics of the annotation will remain unchanged. +/// /// ## References -/// - [The typing specification](https://docs.python.org/3/library/numbers.html#the-numeric-tower) +/// - [Python documentation: The numeric tower](https://docs.python.org/3/library/numbers.html#the-numeric-tower) /// - [PEP 484: The numeric tower](https://peps.python.org/pep-0484/#the-numeric-tower) /// -/// [typing specification]: https://typing.readthedocs.io/en/latest/spec/special-types.html#special-cases-for-float-and-complex -#[violation] -pub struct RedundantNumericUnion { +/// [typing specification]: https://typing.python.org/en/latest/spec/special-types.html#special-cases-for-float-and-complex +#[derive(ViolationMetadata)] +pub(crate) struct RedundantNumericUnion { redundancy: Redundancy, } impl Violation for RedundantNumericUnion { + // Always fixable, but currently under preview. + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { let (subtype, supertype) = match self.redundancy { + Redundancy::IntFloatComplex => ("int | float", "complex"), Redundancy::FloatComplex => ("float", "complex"), Redundancy::IntComplex => ("int", "complex"), Redundancy::IntFloat => ("int", "float"), }; format!("Use `{supertype}` instead of `{subtype} | {supertype}`") } + + fn fix_title(&self) -> Option<String> { + Some("Remove redundant type".to_string()) + } } /// PYI041 -pub(crate) fn redundant_numeric_union(checker: &mut Checker, parameters: &Parameters) { +pub(crate) fn redundant_numeric_union(checker: &Checker, parameters: &Parameters) { for annotation in parameters.iter().filter_map(AnyParameterRef::annotation) { check_annotation(checker, annotation); } } -#[derive(Debug, Clone, Copy, Eq, PartialEq)] -enum Redundancy { - FloatComplex, - IntComplex, - IntFloat, -} - -fn check_annotation(checker: &mut Checker, annotation: &Expr) { - let mut has_float = false; - let mut has_complex = false; - let mut has_int = false; +fn check_annotation<'a>(checker: &Checker, annotation: &'a Expr) { + let mut numeric_flags = NumericFlags::empty(); let mut find_numeric_type = |expr: &Expr, _parent: &Expr| { let Some(builtin_type) = checker.semantic().resolve_builtin_symbol(expr) else { return; }; - match builtin_type { - "int" => has_int = true, - "float" => has_float = true, - "complex" => has_complex = true, - _ => {} - } + numeric_flags.seen_builtin_type(builtin_type); }; + // Traverse the union, and remember which numeric types are found. traverse_union(&mut find_numeric_type, checker.semantic(), annotation); - if has_complex { - if has_float { - checker.diagnostics.push(Diagnostic::new( - RedundantNumericUnion { - redundancy: Redundancy::FloatComplex, - }, - annotation.range(), - )); + let Some(redundancy) = Redundancy::from_numeric_flags(numeric_flags) else { + return; + }; + + // Traverse the union a second time to construct the fix. + let mut necessary_nodes: Vec<&Expr> = Vec::new(); + + let mut union_type = UnionKind::TypingUnion; + let mut remove_numeric_type = |expr: &'a Expr, parent: &'a Expr| { + let Some(builtin_type) = checker.semantic().resolve_builtin_symbol(expr) else { + // Keep type annotations that are not numeric. + necessary_nodes.push(expr); + return; + }; + + if matches!(parent, Expr::BinOp(_)) { + union_type = UnionKind::PEP604; + } + + // `int` is always dropped, since `float` or `complex` must be present. + // `float` is only dropped if `complex`` is present. + if (builtin_type == "float" && !numeric_flags.contains(NumericFlags::COMPLEX)) + || (builtin_type != "float" && builtin_type != "int") + { + necessary_nodes.push(expr); + } + }; + + // Traverse the union a second time to construct a [`Fix`]. + traverse_union(&mut remove_numeric_type, checker.semantic(), annotation); + + let mut diagnostic = Diagnostic::new(RedundantNumericUnion { redundancy }, annotation.range()); + + // Mark [`Fix`] as unsafe when comments are in range. + let applicability = if checker.comment_ranges().intersects(annotation.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + // Generate the flattened fix once. + let fix = if let &[edit_expr] = necessary_nodes.as_slice() { + // Generate a [`Fix`] for a single type expression, e.g. `int`. + Some(Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(edit_expr), annotation.range()), + applicability, + )) + } else { + match union_type { + UnionKind::PEP604 => Some(generate_pep604_fix( + checker, + necessary_nodes, + annotation, + applicability, + )), + UnionKind::TypingUnion => { + let Some(importer) = checker.typing_importer("Union", PythonVersion::lowest()) + else { + return; + }; + generate_union_fix( + checker.generator(), + &importer, + necessary_nodes, + annotation, + applicability, + ) + .ok() + } } + }; + + if let Some(fix) = fix { + diagnostic.set_fix(fix); + } + + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +enum Redundancy { + IntFloatComplex, + FloatComplex, + IntComplex, + IntFloat, +} - if has_int { - checker.diagnostics.push(Diagnostic::new( - RedundantNumericUnion { - redundancy: Redundancy::IntComplex, - }, - annotation.range(), - )); +impl Redundancy { + pub(super) fn from_numeric_flags(numeric_flags: NumericFlags) -> Option<Self> { + if numeric_flags == NumericFlags::INT | NumericFlags::FLOAT | NumericFlags::COMPLEX { + Some(Self::IntFloatComplex) + } else if numeric_flags == NumericFlags::FLOAT | NumericFlags::COMPLEX { + Some(Self::FloatComplex) + } else if numeric_flags == NumericFlags::INT | NumericFlags::COMPLEX { + Some(Self::IntComplex) + } else if numeric_flags == NumericFlags::FLOAT | NumericFlags::INT { + Some(Self::IntFloat) + } else { + None } - } else if has_float && has_int { - checker.diagnostics.push(Diagnostic::new( - RedundantNumericUnion { - redundancy: Redundancy::IntFloat, - }, - annotation.range(), - )); } } + +bitflags! { + #[derive(Copy, Clone, Debug, PartialEq, Eq)] + pub(super) struct NumericFlags: u8 { + /// `int` + const INT = 1 << 0; + /// `float` + const FLOAT = 1 << 1; + /// `complex` + const COMPLEX = 1 << 2; + } +} + +impl NumericFlags { + pub(super) fn seen_builtin_type(&mut self, name: &str) { + let flag: NumericFlags = match name { + "int" => NumericFlags::INT, + "float" => NumericFlags::FLOAT, + "complex" => NumericFlags::COMPLEX, + _ => { + return; + } + }; + self.insert(flag); + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum UnionKind { + /// E.g., `typing.Union[int, str]` + TypingUnion, + /// E.g., `int | str` + PEP604, +} + +/// Generate a [`Fix`] for two or more type expressions, e.g. `int | float | complex`. +fn generate_pep604_fix( + checker: &Checker, + nodes: Vec<&Expr>, + annotation: &Expr, + applicability: Applicability, +) -> Fix { + debug_assert!(nodes.len() >= 2, "At least two nodes required"); + + let new_expr = nodes + .into_iter() + .fold(None, |acc: Option<Expr>, right: &Expr| { + if let Some(left) = acc { + Some(Expr::BinOp(ExprBinOp { + left: Box::new(left), + op: Operator::BitOr, + right: Box::new(right.clone()), + range: TextRange::default(), + })) + } else { + Some(right.clone()) + } + }) + .unwrap(); + + Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(&new_expr), annotation.range()), + applicability, + ) +} diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/simple_defaults.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/simple_defaults.rs index 54b6bc8d7df81..c67b1c7815750 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/simple_defaults.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/simple_defaults.rs @@ -1,17 +1,14 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::{ - self as ast, Expr, Operator, ParameterWithDefault, Parameters, Stmt, UnaryOp, -}; -use ruff_python_semantic::{analyze::class::is_enumeration, ScopeKind, SemanticModel}; +use ruff_python_ast::{self as ast, Expr, Operator, Parameters, Stmt, UnaryOp}; +use ruff_python_semantic::{ScopeKind, SemanticModel, analyze::class::is_enumeration}; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; -use crate::importer::ImportRequest; use crate::rules::flake8_pyi::rules::TypingModule; -use crate::settings::types::PythonVersion; -use crate::Locator; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for typed function arguments in stubs with complex default values. @@ -43,13 +40,13 @@ use crate::Locator; /// /// ## References /// - [`flake8-pyi`](https://github.com/PyCQA/flake8-pyi/blob/main/ERRORCODES.md) -#[violation] -pub struct TypedArgumentDefaultInStub; +#[derive(ViolationMetadata)] +pub(crate) struct TypedArgumentDefaultInStub; impl AlwaysFixableViolation for TypedArgumentDefaultInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Only simple default values allowed for typed arguments") + "Only simple default values allowed for typed arguments".to_string() } fn fix_title(&self) -> String { @@ -89,13 +86,13 @@ impl AlwaysFixableViolation for TypedArgumentDefaultInStub { /// /// ## References /// - [`flake8-pyi`](https://github.com/PyCQA/flake8-pyi/blob/main/ERRORCODES.md) -#[violation] -pub struct ArgumentDefaultInStub; +#[derive(ViolationMetadata)] +pub(crate) struct ArgumentDefaultInStub; impl AlwaysFixableViolation for ArgumentDefaultInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Only simple default values allowed for arguments") + "Only simple default values allowed for arguments".to_string() } fn fix_title(&self) -> String { @@ -133,13 +130,13 @@ impl AlwaysFixableViolation for ArgumentDefaultInStub { /// /// ## References /// - [`flake8-pyi`](https://github.com/PyCQA/flake8-pyi/blob/main/ERRORCODES.md) -#[violation] -pub struct AssignmentDefaultInStub; +#[derive(ViolationMetadata)] +pub(crate) struct AssignmentDefaultInStub; impl AlwaysFixableViolation for AssignmentDefaultInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Only simple default values allowed for assignments") + "Only simple default values allowed for assignments".to_string() } fn fix_title(&self) -> String { @@ -147,14 +144,14 @@ impl AlwaysFixableViolation for AssignmentDefaultInStub { } } -/// ## What it does? +/// ## What it does /// Checks for unannotated assignments in stub (`.pyi`) files. /// /// ## Why is this bad? /// Stub files exist to provide type hints, and are never executed. As such, /// all assignments in stub files should be annotated with a type. -#[violation] -pub struct UnannotatedAssignmentInStub { +#[derive(ViolationMetadata)] +pub(crate) struct UnannotatedAssignmentInStub { name: String, } @@ -184,8 +181,8 @@ impl Violation for UnannotatedAssignmentInStub { /// ```pyi /// __all__: list[str] = ["foo", "bar"] /// ``` -#[violation] -pub struct UnassignedSpecialVariableInStub { +#[derive(ViolationMetadata)] +pub(crate) struct UnassignedSpecialVariableInStub { name: String, } @@ -193,7 +190,9 @@ impl Violation for UnassignedSpecialVariableInStub { #[derive_message_formats] fn message(&self) -> String { let UnassignedSpecialVariableInStub { name } = self; - format!("`{name}` in a stub file must have a value, as it has the same semantics as `{name}` at runtime") + format!( + "`{name}` in a stub file must have a value, as it has the same semantics as `{name}` at runtime" + ) } } @@ -220,8 +219,18 @@ impl Violation for UnassignedSpecialVariableInStub { /// /// Vector: TypeAlias = list[float] /// ``` -#[violation] -pub struct TypeAliasWithoutAnnotation { +/// +/// ## Availability +/// +/// Because this rule relies on the third-party `typing_extensions` module for Python versions +/// before 3.10, its diagnostic will not be emitted, and no fix will be offered, if +/// `typing_extensions` imports have been disabled by the [`lint.typing-extensions`] linter option. +/// +/// ## Options +/// +/// - `lint.typing-extensions` +#[derive(ViolationMetadata)] +pub(crate) struct TypeAliasWithoutAnnotation { module: TypingModule, name: String, value: String, @@ -425,6 +434,8 @@ fn is_valid_default_value_without_annotation(default: &Expr) -> bool { /// Returns `true` if an [`Expr`] appears to be `TypeVar`, `TypeVarTuple`, `NewType`, or `ParamSpec` /// call. +/// +/// See also [`ruff_python_semantic::analyze::typing::TypeVarLikeChecker::is_type_var_like_call`]. fn is_type_var_like_call(expr: &Expr, semantic: &SemanticModel) -> bool { let Expr::Call(ast::ExprCall { func, .. }) = expr else { return false; @@ -486,17 +497,12 @@ fn is_annotatable_type_alias(value: &Expr, semantic: &SemanticModel) -> bool { } /// PYI011 -pub(crate) fn typed_argument_simple_defaults(checker: &mut Checker, parameters: &Parameters) { - for ParameterWithDefault { - parameter, - default, - range: _, - } in parameters.iter_non_variadic_params() - { - let Some(default) = default else { +pub(crate) fn typed_argument_simple_defaults(checker: &Checker, parameters: &Parameters) { + for parameter in parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { continue; }; - if parameter.annotation.is_some() { + if parameter.annotation().is_some() { if !is_valid_default_value_with_annotation( default, true, @@ -510,24 +516,19 @@ pub(crate) fn typed_argument_simple_defaults(checker: &mut Checker, parameters: default.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } /// PYI014 -pub(crate) fn argument_simple_defaults(checker: &mut Checker, parameters: &Parameters) { - for ParameterWithDefault { - parameter, - default, - range: _, - } in parameters.iter_non_variadic_params() - { - let Some(default) = default else { +pub(crate) fn argument_simple_defaults(checker: &Checker, parameters: &Parameters) { + for parameter in parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { continue; }; - if parameter.annotation.is_none() { + if parameter.annotation().is_none() { if !is_valid_default_value_with_annotation( default, true, @@ -541,14 +542,14 @@ pub(crate) fn argument_simple_defaults(checker: &mut Checker, parameters: &Param default.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } /// PYI015 -pub(crate) fn assignment_default_in_stub(checker: &mut Checker, targets: &[Expr], value: &Expr) { +pub(crate) fn assignment_default_in_stub(checker: &Checker, targets: &[Expr], value: &Expr) { let [target] = targets else { return; }; @@ -573,12 +574,12 @@ pub(crate) fn assignment_default_in_stub(checker: &mut Checker, targets: &[Expr] "...".to_string(), value.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// PYI015 pub(crate) fn annotated_assignment_default_in_stub( - checker: &mut Checker, + checker: &Checker, target: &Expr, value: &Expr, annotation: &Expr, @@ -607,15 +608,11 @@ pub(crate) fn annotated_assignment_default_in_stub( "...".to_string(), value.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// PYI052 -pub(crate) fn unannotated_assignment_in_stub( - checker: &mut Checker, - targets: &[Expr], - value: &Expr, -) { +pub(crate) fn unannotated_assignment_in_stub(checker: &Checker, targets: &[Expr], value: &Expr) { let [target] = targets else { return; }; @@ -641,7 +638,7 @@ pub(crate) fn unannotated_assignment_in_stub( return; } } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnannotatedAssignmentInStub { name: id.to_string(), }, @@ -650,11 +647,7 @@ pub(crate) fn unannotated_assignment_in_stub( } /// PYI035 -pub(crate) fn unassigned_special_variable_in_stub( - checker: &mut Checker, - target: &Expr, - stmt: &Stmt, -) { +pub(crate) fn unassigned_special_variable_in_stub(checker: &Checker, target: &Expr, stmt: &Stmt) { let Expr::Name(ast::ExprName { id, .. }) = target else { return; }; @@ -663,7 +656,7 @@ pub(crate) fn unassigned_special_variable_in_stub( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnassignedSpecialVariableInStub { name: id.to_string(), }, @@ -672,7 +665,7 @@ pub(crate) fn unassigned_special_variable_in_stub( } /// PYI026 -pub(crate) fn type_alias_without_annotation(checker: &mut Checker, value: &Expr, targets: &[Expr]) { +pub(crate) fn type_alias_without_annotation(checker: &Checker, value: &Expr, targets: &[Expr]) { let [target] = targets else { return; }; @@ -685,12 +678,16 @@ pub(crate) fn type_alias_without_annotation(checker: &mut Checker, value: &Expr, return; } - let module = if checker.settings.target_version >= PythonVersion::Py310 { + let module = if checker.target_version() >= PythonVersion::PY310 { TypingModule::Typing } else { TypingModule::TypingExtensions }; + let Some(importer) = checker.typing_importer("TypeAlias", PythonVersion::PY310) else { + return; + }; + let mut diagnostic = Diagnostic::new( TypeAliasWithoutAnnotation { module, @@ -700,15 +697,11 @@ pub(crate) fn type_alias_without_annotation(checker: &mut Checker, value: &Expr, target.range(), ); diagnostic.try_set_fix(|| { - let (import_edit, binding) = checker.importer().get_or_import_symbol( - &ImportRequest::import(module.as_str(), "TypeAlias"), - target.start(), - checker.semantic(), - )?; + let (import_edit, binding) = importer.import(target.start())?; Ok(Fix::safe_edits( Edit::range_replacement(format!("{id}: {binding}"), target.range()), [import_edit], )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/str_or_repr_defined_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/str_or_repr_defined_in_stub.rs index ed50e59850afd..5d0870b5540a5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/str_or_repr_defined_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/str_or_repr_defined_in_stub.rs @@ -2,7 +2,7 @@ use ruff_python_ast as ast; use ruff_python_ast::Stmt; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility::is_abstract; @@ -23,8 +23,8 @@ use crate::fix::edits::delete_stmt; /// class Foo: /// def __repr__(self) -> str: ... /// ``` -#[violation] -pub struct StrOrReprDefinedInStub { +#[derive(ViolationMetadata)] +pub(crate) struct StrOrReprDefinedInStub { name: String, } @@ -42,7 +42,7 @@ impl AlwaysFixableViolation for StrOrReprDefinedInStub { } /// PYI029 -pub(crate) fn str_or_repr_defined_in_stub(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn str_or_repr_defined_in_stub(checker: &Checker, stmt: &Stmt) { let Stmt::FunctionDef(ast::StmtFunctionDef { name, decorator_list, @@ -94,5 +94,5 @@ pub(crate) fn str_or_repr_defined_in_stub(checker: &mut Checker, stmt: &Stmt) { diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_parent_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/string_or_bytes_too_long.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/string_or_bytes_too_long.rs index fdec385be88ec..e5098c4ca3418 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/string_or_bytes_too_long.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/string_or_bytes_too_long.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_ast::{self as ast, StringLike}; use ruff_python_semantic::SemanticModel; @@ -32,13 +32,13 @@ use crate::checkers::ast::Checker; /// ```pyi /// def foo(arg: str = ...) -> None: ... /// ``` -#[violation] -pub struct StringOrBytesTooLong; +#[derive(ViolationMetadata)] +pub(crate) struct StringOrBytesTooLong; impl AlwaysFixableViolation for StringOrBytesTooLong { #[derive_message_formats] fn message(&self) -> String { - format!("String and bytes literals longer than 50 characters are not permitted") + "String and bytes literals longer than 50 characters are not permitted".to_string() } fn fix_title(&self) -> String { @@ -47,7 +47,7 @@ impl AlwaysFixableViolation for StringOrBytesTooLong { } /// PYI053 -pub(crate) fn string_or_bytes_too_long(checker: &mut Checker, string: StringLike) { +pub(crate) fn string_or_bytes_too_long(checker: &Checker, string: StringLike) { let semantic = checker.semantic(); // Ignore docstrings. @@ -59,7 +59,7 @@ pub(crate) fn string_or_bytes_too_long(checker: &mut Checker, string: StringLike return; } - if semantic.in_annotation() { + if semantic.in_type_definition() | semantic.in_deferred_type_definition() { return; } @@ -77,7 +77,7 @@ pub(crate) fn string_or_bytes_too_long(checker: &mut Checker, string: StringLike "...".to_string(), string.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Count the number of visible characters in an f-string. This accounts for diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/stub_body_multiple_statements.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/stub_body_multiple_statements.rs index 608603d31654e..0d7f7728da3b5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/stub_body_multiple_statements.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/stub_body_multiple_statements.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::identifier::Identifier; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; +use ruff_python_ast::identifier::Identifier; use crate::checkers::ast::Checker; @@ -28,20 +28,20 @@ use crate::checkers::ast::Checker; /// ```pyi /// def function(): ... /// ``` -#[violation] -pub struct StubBodyMultipleStatements; +#[derive(ViolationMetadata)] +pub(crate) struct StubBodyMultipleStatements; impl Violation for StubBodyMultipleStatements { #[derive_message_formats] fn message(&self) -> String { - format!("Function body must contain exactly one statement") + "Function body must contain exactly one statement".to_string() } } /// PYI048 -pub(crate) fn stub_body_multiple_statements(checker: &mut Checker, stmt: &Stmt, body: &[Stmt]) { +pub(crate) fn stub_body_multiple_statements(checker: &Checker, stmt: &Stmt, body: &[Stmt]) { if body.len() > 1 { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StubBodyMultipleStatements, stmt.identifier(), )); diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/type_alias_naming.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/type_alias_naming.rs index 937b7ac5cd1cc..0454fe94911b8 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/type_alias_naming.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/type_alias_naming.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -21,8 +21,8 @@ use crate::checkers::ast::Checker; /// ```pyi /// TypeAliasName: TypeAlias = int /// ``` -#[violation] -pub struct SnakeCaseTypeAlias { +#[derive(ViolationMetadata)] +pub(crate) struct SnakeCaseTypeAlias { name: String, } @@ -60,8 +60,8 @@ impl Violation for SnakeCaseTypeAlias { /// /// ## References /// - [PEP 484: Type Aliases](https://peps.python.org/pep-0484/#type-aliases) -#[violation] -pub struct TSuffixedTypeAlias { +#[derive(ViolationMetadata)] +pub(crate) struct TSuffixedTypeAlias { name: String, } @@ -69,7 +69,9 @@ impl Violation for TSuffixedTypeAlias { #[derive_message_formats] fn message(&self) -> String { let Self { name } = self; - format!("Private type alias `{name}` should not be suffixed with `T` (the `T` suffix implies that an object is a `TypeVar`)") + format!( + "Private type alias `{name}` should not be suffixed with `T` (the `T` suffix implies that an object is a `TypeVar`)" + ) } } @@ -101,13 +103,13 @@ fn is_t_suffixed_type_alias(name: &str) -> bool { } /// PYI042 -pub(crate) fn snake_case_type_alias(checker: &mut Checker, target: &Expr) { +pub(crate) fn snake_case_type_alias(checker: &Checker, target: &Expr) { if let Expr::Name(ast::ExprName { id, range, .. }) = target { if !is_snake_case_type_alias(id) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SnakeCaseTypeAlias { name: id.to_string(), }, @@ -117,13 +119,13 @@ pub(crate) fn snake_case_type_alias(checker: &mut Checker, target: &Expr) { } /// PYI043 -pub(crate) fn t_suffixed_type_alias(checker: &mut Checker, target: &Expr) { +pub(crate) fn t_suffixed_type_alias(checker: &Checker, target: &Expr) { if let Expr::Name(ast::ExprName { id, range, .. }) = target { if !is_t_suffixed_type_alias(id) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TSuffixedTypeAlias { name: id.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/type_comment_in_stub.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/type_comment_in_stub.rs index 7207e3ebed190..67f09e1ecca0c 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/type_comment_in_stub.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/type_comment_in_stub.rs @@ -3,7 +3,7 @@ use std::sync::LazyLock; use regex::Regex; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use crate::Locator; @@ -26,13 +26,13 @@ use crate::Locator; /// ```pyi /// x: int = 1 /// ``` -#[violation] -pub struct TypeCommentInStub; +#[derive(ViolationMetadata)] +pub(crate) struct TypeCommentInStub; impl Violation for TypeCommentInStub { #[derive_message_formats] fn message(&self) -> String { - format!("Don't use type comments in stub file") + "Don't use type comments in stub file".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unaliased_collections_abc_set_import.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unaliased_collections_abc_set_import.rs index bb24ed01f0d8f..244f600abfa1f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unaliased_collections_abc_set_import.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unaliased_collections_abc_set_import.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Applicability, Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Imported; use ruff_python_semantic::{Binding, BindingKind, Scope}; use ruff_text_size::Ranged; @@ -40,21 +40,19 @@ use crate::renamer::Renamer; /// re-exported if they are included in `__all__`, use a "redundant" /// `import foo as foo` alias, or are imported via a `*` import. As such, the /// fix is marked as safe in more cases for `.pyi` files. -#[violation] -pub struct UnaliasedCollectionsAbcSetImport; +#[derive(ViolationMetadata)] +pub(crate) struct UnaliasedCollectionsAbcSetImport; impl Violation for UnaliasedCollectionsAbcSetImport { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!( - "Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin" - ) + "Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Alias `Set` to `AbstractSet`")) + Some("Alias `Set` to `AbstractSet`".to_string()) } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_literal_union.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_literal_union.rs index 0ea87fa88d71e..e3374dbe864a1 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_literal_union.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_literal_union.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::pep_604_union; use ruff_python_ast::{self as ast, Expr, ExprContext}; use ruff_python_semantic::analyze::typing::traverse_union; @@ -28,10 +28,26 @@ use crate::checkers::ast::Checker; /// field: Literal[1, 2] | str /// ``` /// +/// ## Fix safety +/// This fix is marked unsafe if it would delete any comments within the replacement range. +/// +/// An example to illustrate where comments are preserved and where they are not: +/// +/// ```pyi +/// from typing import Literal +/// +/// field: ( +/// # deleted comment +/// Literal["a", "b"] # deleted comment +/// # deleted comment +/// | Literal["c", "d"] # preserved comment +/// ) +/// ``` +/// /// ## References /// - [Python documentation: `typing.Literal`](https://docs.python.org/3/library/typing.html#typing.Literal) -#[violation] -pub struct UnnecessaryLiteralUnion { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLiteralUnion { members: Vec<String>, } @@ -47,12 +63,12 @@ impl Violation for UnnecessaryLiteralUnion { } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with a single `Literal`",)) + Some("Replace with a single `Literal`".to_string()) } } /// PYI030 -pub(crate) fn unnecessary_literal_union<'a>(checker: &mut Checker, expr: &'a Expr) { +pub(crate) fn unnecessary_literal_union<'a>(checker: &Checker, expr: &'a Expr) { let mut literal_exprs = Vec::new(); let mut other_exprs = Vec::new(); @@ -131,12 +147,8 @@ pub(crate) fn unnecessary_literal_union<'a>(checker: &mut Checker, expr: &'a Exp ctx: ExprContext::Load, }); - if other_exprs.is_empty() { - // if the union is only literals, we just replace the whole thing with a single literal - Fix::safe_edit(Edit::range_replacement( - checker.generator().expr(&literal), - expr.range(), - )) + let edit = if other_exprs.is_empty() { + Edit::range_replacement(checker.generator().expr(&literal), expr.range()) } else { let elts: Vec<Expr> = std::iter::once(literal) .chain(other_exprs.into_iter().cloned()) @@ -159,10 +171,15 @@ pub(crate) fn unnecessary_literal_union<'a>(checker: &mut Checker, expr: &'a Exp } else { checker.generator().expr(&pep_604_union(&elts)) }; + Edit::range_replacement(content, expr.range()) + }; - Fix::safe_edit(Edit::range_replacement(content, expr.range())) + if checker.comment_ranges().intersects(expr.range()) { + Fix::unsafe_edit(edit) + } else { + Fix::safe_edit(edit) } }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_type_union.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_type_union.rs index 1d4128bd563f5..3a4daa8e1626a 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_type_union.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_type_union.rs @@ -1,6 +1,6 @@ use ast::ExprContext; -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::pep_604_union; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr}; @@ -25,10 +25,16 @@ use crate::checkers::ast::Checker; /// ```pyi /// field: type[int | float] | str /// ``` -#[violation] -pub struct UnnecessaryTypeUnion { +/// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the type annotation contains comments. +/// +/// Note that while the fix may flatten nested unions into a single top-level union, +/// the semantics of the annotation will remain unchanged. +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryTypeUnion { members: Vec<Name>, - is_pep604_union: bool, + union_kind: UnionKind, } impl Violation for UnnecessaryTypeUnion { @@ -36,10 +42,9 @@ impl Violation for UnnecessaryTypeUnion { #[derive_message_formats] fn message(&self) -> String { - let union_str = if self.is_pep604_union { - format!("{}", self.members.join(" | ")) - } else { - format!("Union[{}]", self.members.join(", ")) + let union_str = match self.union_kind { + UnionKind::PEP604 => self.members.join(" | "), + UnionKind::TypingUnion => format!("Union[{}]", self.members.join(", ")), }; format!( @@ -48,12 +53,12 @@ impl Violation for UnnecessaryTypeUnion { } fn fix_title(&self) -> Option<String> { - Some(format!("Combine multiple `type` members")) + Some("Combine multiple `type` members".to_string()) } } /// PYI055 -pub(crate) fn unnecessary_type_union<'a>(checker: &mut Checker, union: &'a Expr) { +pub(crate) fn unnecessary_type_union<'a>(checker: &Checker, union: &'a Expr) { let semantic = checker.semantic(); // The `|` operator isn't always safe to allow to runtime-evaluated annotations. @@ -63,43 +68,90 @@ pub(crate) fn unnecessary_type_union<'a>(checker: &mut Checker, union: &'a Expr) // Check if `union` is a PEP604 union (e.g. `float | int`) or a `typing.Union[float, int]` let subscript = union.as_subscript_expr(); - if subscript.is_some_and(|subscript| !semantic.match_typing_expr(&subscript.value, "Union")) { - return; - } + let mut union_kind = match subscript { + Some(subscript) => { + if !semantic.match_typing_expr(&subscript.value, "Union") { + return; + } + UnionKind::TypingUnion + } + None => UnionKind::PEP604, + }; let mut type_exprs: Vec<&Expr> = Vec::new(); let mut other_exprs: Vec<&Expr> = Vec::new(); - let mut collect_type_exprs = |expr: &'a Expr, _parent: &'a Expr| match expr { - Expr::Subscript(ast::ExprSubscript { slice, value, .. }) => { - if semantic.match_builtin_expr(value, "type") { - type_exprs.push(slice); - } else { - other_exprs.push(expr); + let mut collect_type_exprs = |expr: &'a Expr, parent: &'a Expr| { + // If a PEP604-style union is used within a `typing.Union`, then the fix can + // use PEP604-style unions. + if matches!(parent, Expr::BinOp(_)) { + union_kind = UnionKind::PEP604; + } + match expr { + Expr::Subscript(ast::ExprSubscript { slice, value, .. }) => { + // The annotation `type[a, b]` is not valid since `type` accepts + // a single parameter. This likely is a confusion with `type[a | b]` or + // `type[Union[a, b]]`. Do not emit a diagnostic for invalid type + // annotations. + if !matches!(**slice, Expr::Tuple(_)) && semantic.match_builtin_expr(value, "type") + { + type_exprs.push(slice); + } else { + other_exprs.push(expr); + } } + _ => other_exprs.push(expr), } - _ => other_exprs.push(expr), }; traverse_union(&mut collect_type_exprs, semantic, union); - if type_exprs.len() > 1 { - let type_members: Vec<Name> = type_exprs - .clone() - .into_iter() - .map(|type_expr| Name::new(checker.locator().slice(type_expr))) - .collect(); - - let mut diagnostic = Diagnostic::new( - UnnecessaryTypeUnion { - members: type_members.clone(), - is_pep604_union: subscript.is_none(), - }, - union.range(), - ); - - if semantic.has_builtin_binding("type") { - let content = if let Some(subscript) = subscript { + // Return if zero or one `type` expressions are found. + if type_exprs.len() <= 1 { + return; + } + + let type_members: Vec<Name> = type_exprs + .iter() + .map(|type_expr| Name::new(checker.locator().slice(type_expr))) + .collect(); + + let mut diagnostic = Diagnostic::new( + UnnecessaryTypeUnion { + members: type_members.clone(), + union_kind, + }, + union.range(), + ); + + if semantic.has_builtin_binding("type") { + // Construct the content for the [`Fix`] based on if we encountered a PEP604 union. + let content = match union_kind { + UnionKind::PEP604 => { + let elts: Vec<Expr> = type_exprs.into_iter().cloned().collect(); + let types = Expr::Subscript(ast::ExprSubscript { + value: Box::new(Expr::Name(ast::ExprName { + id: Name::new_static("type"), + ctx: ExprContext::Load, + range: TextRange::default(), + })), + slice: Box::new(pep_604_union(&elts)), + ctx: ExprContext::Load, + range: TextRange::default(), + }); + + if other_exprs.is_empty() { + checker.generator().expr(&types) + } else { + let elts: Vec<Expr> = std::iter::once(types) + .chain(other_exprs.into_iter().cloned()) + .collect(); + checker.generator().expr(&pep_604_union(&elts)) + } + } + UnionKind::TypingUnion => { + // When subscript is None, it uses the previous match case. + let subscript = subscript.unwrap(); let types = &Expr::Subscript(ast::ExprSubscript { value: Box::new(Expr::Name(ast::ExprName { id: Name::new_static("type"), @@ -151,35 +203,29 @@ pub(crate) fn unnecessary_type_union<'a>(checker: &mut Checker, union: &'a Expr) checker.generator().expr(&union) } - } else { - let elts: Vec<Expr> = type_exprs.into_iter().cloned().collect(); - let types = Expr::Subscript(ast::ExprSubscript { - value: Box::new(Expr::Name(ast::ExprName { - id: Name::new_static("type"), - ctx: ExprContext::Load, - range: TextRange::default(), - })), - slice: Box::new(pep_604_union(&elts)), - ctx: ExprContext::Load, - range: TextRange::default(), - }); - - if other_exprs.is_empty() { - checker.generator().expr(&types) - } else { - let elts: Vec<Expr> = std::iter::once(types) - .chain(other_exprs.into_iter().cloned()) - .collect(); - checker.generator().expr(&pep_604_union(&elts)) - } - }; + } + }; - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - content, - union.range(), - ))); - } + // Mark [`Fix`] as unsafe when comments are in range. + let applicability = if checker.comment_ranges().intersects(union.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; - checker.diagnostics.push(diagnostic); + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement(content, union.range()), + applicability, + )); } + + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum UnionKind { + /// E.g., `typing.Union[int, str]` + TypingUnion, + /// E.g., `int | str` + PEP604, } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_platform.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_platform.rs index 8bb38d86431ac..34675e1dce76c 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_platform.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_platform.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,14 +40,14 @@ use crate::registry::Rule; /// ``` /// /// ## References -/// - [Typing stubs documentation: Version and Platform Checks](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct UnrecognizedPlatformCheck; +/// - [Typing documentation: Version and Platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct UnrecognizedPlatformCheck; impl Violation for UnrecognizedPlatformCheck { #[derive_message_formats] fn message(&self) -> String { - format!("Unrecognized `sys.platform` check") + "Unrecognized `sys.platform` check".to_string() } } @@ -74,9 +74,9 @@ impl Violation for UnrecognizedPlatformCheck { /// ``` /// /// ## References -/// - [Typing stubs documentation: Version and Platform Checks](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct UnrecognizedPlatformName { +/// - [Typing documentation: Version and Platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct UnrecognizedPlatformName { platform: String, } @@ -89,7 +89,7 @@ impl Violation for UnrecognizedPlatformName { } /// PYI007, PYI008 -pub(crate) fn unrecognized_platform(checker: &mut Checker, test: &Expr) { +pub(crate) fn unrecognized_platform(checker: &Checker, test: &Expr) { let Expr::Compare(ast::ExprCompare { left, ops, @@ -115,9 +115,7 @@ pub(crate) fn unrecognized_platform(checker: &mut Checker, test: &Expr) { // "in" might also make sense but we don't currently have one. if !matches!(op, CmpOp::Eq | CmpOp::NotEq) { if checker.enabled(Rule::UnrecognizedPlatformCheck) { - checker - .diagnostics - .push(Diagnostic::new(UnrecognizedPlatformCheck, test.range())); + checker.report_diagnostic(Diagnostic::new(UnrecognizedPlatformCheck, test.range())); } return; } @@ -127,7 +125,7 @@ pub(crate) fn unrecognized_platform(checker: &mut Checker, test: &Expr) { // This protects against typos. if checker.enabled(Rule::UnrecognizedPlatformName) { if !matches!(value.to_str(), "linux" | "win32" | "cygwin" | "darwin") { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnrecognizedPlatformName { platform: value.to_string(), }, @@ -137,9 +135,7 @@ pub(crate) fn unrecognized_platform(checker: &mut Checker, test: &Expr) { } } else { if checker.enabled(Rule::UnrecognizedPlatformCheck) { - checker - .diagnostics - .push(Diagnostic::new(UnrecognizedPlatformCheck, test.range())); + checker.report_diagnostic(Diagnostic::new(UnrecognizedPlatformCheck, test.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_version_info.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_version_info.rs index 96185b2f56584..7b474858d888a 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_version_info.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unrecognized_version_info.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::{self as ast, CmpOp, Expr, Int}; use ruff_text_size::Ranged; @@ -31,14 +31,14 @@ use crate::registry::Rule; /// ``` /// /// ## References -/// - [Typing stubs documentation: Version and Platform Checks](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct UnrecognizedVersionInfoCheck; +/// - [Typing documentation: Version and Platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct UnrecognizedVersionInfoCheck; impl Violation for UnrecognizedVersionInfoCheck { #[derive_message_formats] fn message(&self) -> String { - format!("Unrecognized `sys.version_info` check") + "Unrecognized `sys.version_info` check".to_string() } } @@ -70,14 +70,14 @@ impl Violation for UnrecognizedVersionInfoCheck { /// ``` /// /// ## References -/// - [Typing stubs documentation: Version and Platform Checks](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct PatchVersionComparison; +/// - [Typing documentation: Version and Platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct PatchVersionComparison; impl Violation for PatchVersionComparison { #[derive_message_formats] fn message(&self) -> String { - format!("Version comparison must use only major and minor version") + "Version comparison must use only major and minor version".to_string() } } @@ -106,9 +106,9 @@ impl Violation for PatchVersionComparison { /// ``` /// /// ## References -/// - [Typing stubs documentation: Version and Platform Checks](https://typing.readthedocs.io/en/latest/source/stubs.html#version-and-platform-checks) -#[violation] -pub struct WrongTupleLengthVersionComparison { +/// - [Typing documentation: Version and Platform checking](https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checks) +#[derive(ViolationMetadata)] +pub(crate) struct WrongTupleLengthVersionComparison { expected_length: usize, } @@ -121,7 +121,7 @@ impl Violation for WrongTupleLengthVersionComparison { } /// PYI003, PYI004, PYI005 -pub(crate) fn unrecognized_version_info(checker: &mut Checker, test: &Expr) { +pub(crate) fn unrecognized_version_info(checker: &Checker, test: &Expr) { let Expr::Compare(ast::ExprCompare { left, ops, @@ -148,15 +148,13 @@ pub(crate) fn unrecognized_version_info(checker: &mut Checker, test: &Expr) { version_check(checker, expected, test, *op, comparator); } else { if checker.enabled(Rule::UnrecognizedVersionInfoCheck) { - checker - .diagnostics - .push(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); + checker.report_diagnostic(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); } } } fn version_check( - checker: &mut Checker, + checker: &Checker, expected: ExpectedComparator, test: &Expr, op: CmpOp, @@ -167,8 +165,7 @@ fn version_check( if !is_int_constant(comparator) { if checker.enabled(Rule::UnrecognizedVersionInfoCheck) { checker - .diagnostics - .push(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); + .report_diagnostic(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); } } return; @@ -177,9 +174,7 @@ fn version_check( // Tuple comparison, e.g., `sys.version_info == (3, 4)`. let Expr::Tuple(tuple) = comparator else { if checker.enabled(Rule::UnrecognizedVersionInfoCheck) { - checker - .diagnostics - .push(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); + checker.report_diagnostic(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); } return; }; @@ -188,17 +183,13 @@ fn version_check( // All tuple elements must be integers, e.g., `sys.version_info == (3, 4)` instead of // `sys.version_info == (3.0, 4)`. if checker.enabled(Rule::UnrecognizedVersionInfoCheck) { - checker - .diagnostics - .push(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); + checker.report_diagnostic(Diagnostic::new(UnrecognizedVersionInfoCheck, test.range())); } } else if tuple.len() > 2 { // Must compare against major and minor version only, e.g., `sys.version_info == (3, 4)` // instead of `sys.version_info == (3, 4, 0)`. if checker.enabled(Rule::PatchVersionComparison) { - checker - .diagnostics - .push(Diagnostic::new(PatchVersionComparison, test.range())); + checker.report_diagnostic(Diagnostic::new(PatchVersionComparison, test.range())); } } @@ -211,7 +202,7 @@ fn version_check( }; if tuple.len() != expected_length { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( WrongTupleLengthVersionComparison { expected_length }, test.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unsupported_method_call_on_all.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unsupported_method_call_on_all.rs index 5697c0d0a4d59..f00b918155c61 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unsupported_method_call_on_all.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unsupported_method_call_on_all.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,8 +40,8 @@ use crate::checkers::ast::Checker; /// if sys.version_info >= (3, 10): /// __all__ += ["C"] /// ``` -#[violation] -pub struct UnsupportedMethodCallOnAll { +#[derive(ViolationMetadata)] +pub(crate) struct UnsupportedMethodCallOnAll { name: String, } @@ -49,12 +49,14 @@ impl Violation for UnsupportedMethodCallOnAll { #[derive_message_formats] fn message(&self) -> String { let UnsupportedMethodCallOnAll { name } = self; - format!("Calling `.{name}()` on `__all__` may not be supported by all type checkers (use `+=` instead)") + format!( + "Calling `.{name}()` on `__all__` may not be supported by all type checkers (use `+=` instead)" + ) } } /// PYI056 -pub(crate) fn unsupported_method_call_on_all(checker: &mut Checker, func: &Expr) { +pub(crate) fn unsupported_method_call_on_all(checker: &Checker, func: &Expr) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func else { return; }; @@ -67,7 +69,7 @@ pub(crate) fn unsupported_method_call_on_all(checker: &mut Checker, func: &Expr) if !is_unsupported_method(attr.as_str()) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnsupportedMethodCallOnAll { name: attr.to_string(), }, diff --git a/crates/ruff_linter/src/rules/flake8_pyi/rules/unused_private_type_definition.rs b/crates/ruff_linter/src/rules/flake8_pyi/rules/unused_private_type_definition.rs index 2a75d7e55cbef..03178a3a0a6f6 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/rules/unused_private_type_definition.rs +++ b/crates/ruff_linter/src/rules/flake8_pyi/rules/unused_private_type_definition.rs @@ -1,11 +1,12 @@ -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_semantic::{Scope, SemanticModel}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; +use crate::fix; /// ## What it does /// Checks for the presence of unused private `TypeVar`, `ParamSpec` or @@ -13,7 +14,8 @@ use crate::checkers::ast::Checker; /// /// ## Why is this bad? /// A private `TypeVar` that is defined but not used is likely a mistake. It -/// should either be used, made public, or removed to avoid confusion. +/// should either be used, made public, or removed to avoid confusion. A type +/// variable is considered "private" if its name starts with an underscore. /// /// ## Example /// ```pyi @@ -23,13 +25,19 @@ use crate::checkers::ast::Checker; /// _T = typing.TypeVar("_T") /// _Ts = typing_extensions.TypeVarTuple("_Ts") /// ``` -#[violation] -pub struct UnusedPrivateTypeVar { +/// +/// ## Fix safety +/// The fix is always marked as unsafe, as it would break your code if the type +/// variable is imported by another module. +#[derive(ViolationMetadata)] +pub(crate) struct UnusedPrivateTypeVar { type_var_like_name: String, type_var_like_kind: String, } impl Violation for UnusedPrivateTypeVar { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { let UnusedPrivateTypeVar { @@ -38,6 +46,16 @@ impl Violation for UnusedPrivateTypeVar { } = self; format!("Private {type_var_like_kind} `{type_var_like_name}` is never used") } + + fn fix_title(&self) -> Option<String> { + let UnusedPrivateTypeVar { + type_var_like_name, + type_var_like_kind, + } = self; + Some(format!( + "Remove unused private {type_var_like_kind} `{type_var_like_name}`" + )) + } } /// ## What it does @@ -67,8 +85,8 @@ impl Violation for UnusedPrivateTypeVar { /// /// def func(arg: _PrivateProtocol) -> None: ... /// ``` -#[violation] -pub struct UnusedPrivateProtocol { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedPrivateProtocol { name: String, } @@ -105,8 +123,8 @@ impl Violation for UnusedPrivateProtocol { /// /// def func(arg: _UsedTypeAlias) -> _UsedTypeAlias: ... /// ``` -#[violation] -pub struct UnusedPrivateTypeAlias { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedPrivateTypeAlias { name: String, } @@ -145,8 +163,8 @@ impl Violation for UnusedPrivateTypeAlias { /// /// def func(arg: _UsedPrivateTypedDict) -> _UsedPrivateTypedDict: ... /// ``` -#[violation] -pub struct UnusedPrivateTypedDict { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedPrivateTypedDict { name: String, } @@ -159,11 +177,7 @@ impl Violation for UnusedPrivateTypedDict { } /// PYI018 -pub(crate) fn unused_private_type_var( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_private_type_var(checker: &Checker, scope: &Scope) { for binding in scope .binding_ids() .map(|binding_id| checker.semantic().binding(binding_id)) @@ -178,7 +192,7 @@ pub(crate) fn unused_private_type_var( let Some(source) = binding.source else { continue; }; - let Stmt::Assign(ast::StmtAssign { targets, value, .. }) = + let stmt @ Stmt::Assign(ast::StmtAssign { targets, value, .. }) = checker.semantic().statement(source) else { continue; @@ -210,22 +224,26 @@ pub(crate) fn unused_private_type_var( continue; }; - diagnostics.push(Diagnostic::new( + let diagnostic = Diagnostic::new( UnusedPrivateTypeVar { type_var_like_name: id.to_string(), type_var_like_kind: type_var_like_kind.to_string(), }, binding.range(), - )); + ) + .with_fix(Fix::unsafe_edit(fix::edits::delete_stmt( + stmt, + None, + checker.locator(), + checker.indexer(), + ))); + + checker.report_diagnostic(diagnostic); } } /// PYI046 -pub(crate) fn unused_private_protocol( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_private_protocol(checker: &Checker, scope: &Scope) { for binding in scope .binding_ids() .map(|binding_id| checker.semantic().binding(binding_id)) @@ -253,7 +271,7 @@ pub(crate) fn unused_private_protocol( continue; } - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnusedPrivateProtocol { name: class_def.name.to_string(), }, @@ -263,11 +281,7 @@ pub(crate) fn unused_private_protocol( } /// PYI047 -pub(crate) fn unused_private_type_alias( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_private_type_alias(checker: &Checker, scope: &Scope) { let semantic = checker.semantic(); for binding in scope @@ -289,7 +303,7 @@ pub(crate) fn unused_private_type_alias( continue; }; - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnusedPrivateTypeAlias { name: alias_name.to_string(), }, @@ -319,11 +333,7 @@ fn extract_type_alias_name<'a>(stmt: &'a ast::Stmt, semantic: &SemanticModel) -> } /// PYI049 -pub(crate) fn unused_private_typed_dict( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_private_typed_dict(checker: &Checker, scope: &Scope) { let semantic = checker.semantic(); for binding in scope @@ -348,7 +358,7 @@ pub(crate) fn unused_private_typed_dict( continue; }; - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnusedPrivateTypedDict { name: class_name.to_string(), }, @@ -395,11 +405,7 @@ fn extract_typeddict_name<'a>(stmt: &'a Stmt, semantic: &SemanticModel) -> Optio }; let ast::ExprName { id, .. } = target.as_name_expr()?; let ast::ExprCall { func, .. } = value.as_call_expr()?; - if is_typeddict(func) { - Some(id) - } else { - None - } + if is_typeddict(func) { Some(id) } else { None } } _ => None, } diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.pyi.snap index 507a18c3ea903..d612aa2103381 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI001_PYI001.pyi.snap @@ -4,31 +4,29 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI001.pyi:3:5: PYI001 Name of private `TypeVar` must start with `_` | 1 | from typing import ParamSpec, TypeVar, TypeVarTuple -2 | +2 | 3 | T = TypeVar("T") # Error: TypeVars in stubs must start with _ | ^^^^^^^^^^^^ PYI001 -4 | +4 | 5 | TTuple = TypeVarTuple("TTuple") # Error: TypeVarTuples must also start with _ | PYI001.pyi:5:10: PYI001 Name of private `TypeVarTuple` must start with `_` | 3 | T = TypeVar("T") # Error: TypeVars in stubs must start with _ -4 | +4 | 5 | TTuple = TypeVarTuple("TTuple") # Error: TypeVarTuples must also start with _ | ^^^^^^^^^^^^^^^^^^^^^^ PYI001 -6 | +6 | 7 | P = ParamSpec("P") # Error: ParamSpecs must start with _ | PYI001.pyi:7:5: PYI001 Name of private `ParamSpec` must start with `_` | 5 | TTuple = TypeVarTuple("TTuple") # Error: TypeVarTuples must also start with _ -6 | +6 | 7 | P = ParamSpec("P") # Error: ParamSpecs must start with _ | ^^^^^^^^^^^^^^ PYI001 -8 | +8 | 9 | _T = TypeVar("_T") # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.pyi.snap index 06c726dff4cbe..7b018399cacde 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI002_PYI002.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI002.pyi:3:4: PYI002 `if` test must be a simple comparison against `sys.platform` or `sys.version_info` | 1 | import sys -2 | +2 | 3 | if sys.version == 'Python 2.7.10': ... # Y002 If test must be a simple comparison against sys.platform or sys.version_info | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI002 4 | if 'linux' == sys.platform: ... # Y002 If test must be a simple comparison against sys.platform or sys.version_info @@ -36,5 +36,3 @@ PYI002.pyi:6:4: PYI002 `if` test must be a simple comparison against `sys.platfo 6 | if sys.maxsize == 42: ... # Y002 If test must be a simple comparison against sys.platform or sys.version_info | ^^^^^^^^^^^^^^^^^ PYI002 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.pyi.snap index 192cfafc963f8..99096e74e8d98 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI003_PYI003.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI003.pyi:4:4: PYI003 Unrecognized `sys.version_info` check | 3 | if sys.version_info[0] == 2: ... -4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:' or 'if cond:' +4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:'… | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI003 5 | if sys.version_info[0.0] == 2: ... # Y003 Unrecognized sys.version_info check 6 | if sys.version_info[False] == 2: ... # Y003 Unrecognized sys.version_info check @@ -13,7 +13,7 @@ PYI003.pyi:4:4: PYI003 Unrecognized `sys.version_info` check PYI003.pyi:5:4: PYI003 Unrecognized `sys.version_info` check | 3 | if sys.version_info[0] == 2: ... -4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:' or 'if cond:' +4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:'… 5 | if sys.version_info[0.0] == 2: ... # Y003 Unrecognized sys.version_info check | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI003 6 | if sys.version_info[False] == 2: ... # Y003 Unrecognized sys.version_info check @@ -22,7 +22,7 @@ PYI003.pyi:5:4: PYI003 Unrecognized `sys.version_info` check PYI003.pyi:6:4: PYI003 Unrecognized `sys.version_info` check | -4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:' or 'if cond:' +4 | if sys.version_info[0] == True: ... # Y003 Unrecognized sys.version_info check # E712 comparison to True should be 'if cond is True:'… 5 | if sys.version_info[0.0] == 2: ... # Y003 Unrecognized sys.version_info check 6 | if sys.version_info[False] == 2: ... # Y003 Unrecognized sys.version_info check | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI003 @@ -169,5 +169,3 @@ PYI003.pyi:24:4: PYI003 Unrecognized `sys.version_info` check 25 | if sys.version_info >= (3, 4, 3): ... # Y004 Version comparison must use only major and minor version 26 | if sys.version_info == (3, 4): ... # Y006 Use only < and >= for version comparisons | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.pyi.snap index 8be6ef6e1bc7c..81182425c2c01 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI004_PYI004.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI004.pyi:4:4: PYI004 Version comparison must use only major and minor version | 2 | from sys import version_info -3 | +3 | 4 | if sys.version_info >= (3, 4, 3): ... # PYI004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI004 5 | if sys.version_info < (3, 4, 3): ... # PYI004 @@ -35,8 +35,6 @@ PYI004.pyi:7:4: PYI004 Version comparison must use only major and minor version 6 | if sys.version_info == (3, 4, 3): ... # PYI004 7 | if sys.version_info != (3, 4, 3): ... # PYI004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI004 -8 | +8 | 9 | if sys.version_info[0] == 2: ... | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.pyi.snap index 45c52d42c35f2..117c6849485bb 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI005_PYI005.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI005.pyi:4:4: PYI005 Version comparison must be against a length-1 tuple | 2 | from sys import platform, version_info -3 | +3 | 4 | if sys.version_info[:1] == (2, 7): ... # Y005 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI005 5 | if sys.version_info[:2] == (2,): ... # Y005 @@ -16,5 +16,3 @@ PYI005.pyi:5:4: PYI005 Version comparison must be against a length-2 tuple 5 | if sys.version_info[:2] == (2,): ... # Y005 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI005 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.py.snap index f0a4f44d2b294..93cd183f242cd 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.py.snap @@ -1,4 +1,76 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- +PYI006.py:8:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | + 6 | if sys.version_info >= (3, 9): ... # OK + 7 | + 8 | if sys.version_info == (3, 9): ... # OK + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 + 9 | +10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | +PYI006.py:10:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | + 8 | if sys.version_info == (3, 9): ... # OK + 9 | +10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +11 | +12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:12:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +11 | +12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +13 | +14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:14:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +13 | +14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +15 | +16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:16:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +15 | +16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:17:6: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +18 | +19 | if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:19:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +18 | +19 | if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 +20 | elif python_version == (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | + +PYI006.py:20:6: PYI006 Use `<` or `>=` for `sys.version_info` comparisons + | +19 | if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons +20 | elif python_version == (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 + | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.pyi.snap index 55abdd253b5ba..afe447cc76f5b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI006_PYI006.pyi.snap @@ -4,47 +4,47 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI006.pyi:8:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 6 | if sys.version_info >= (3, 9): ... # OK - 7 | + 7 | 8 | if sys.version_info == (3, 9): ... # OK | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 - 9 | + 9 | 10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | PYI006.pyi:10:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 8 | if sys.version_info == (3, 9): ... # OK - 9 | + 9 | 10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 -11 | +11 | 12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | PYI006.pyi:12:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 10 | if sys.version_info == (3, 9): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -11 | +11 | 12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 -13 | +13 | 14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | PYI006.pyi:14:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 12 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -13 | +13 | 14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 -15 | +15 | 16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | PYI006.pyi:16:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 14 | if sys.version_info <= (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -15 | +15 | 16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons @@ -55,14 +55,14 @@ PYI006.pyi:17:6: PYI006 Use `<` or `>=` for `sys.version_info` comparisons 16 | if sys.version_info > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons 17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 -18 | +18 | 19 | if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | PYI006.pyi:19:4: PYI006 Use `<` or `>=` for `sys.version_info` comparisons | 17 | elif sys.version_info > (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons -18 | +18 | 19 | if python_version > (3, 10): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI006 20 | elif python_version == (3, 11): ... # Error: PYI006 Use only `<` and `>=` for version info comparisons diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.pyi.snap index 91457d5fc01ab..bb46b48b79c4c 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI007_PYI007.pyi.snap @@ -4,29 +4,27 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI007.pyi:7:4: PYI007 Unrecognized `sys.platform` check | 5 | if sys.platform != "platform_name_2": ... # OK -6 | +6 | 7 | if sys.platform in ["linux"]: ... # Error: PYI007 Unrecognized sys.platform check | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI007 -8 | +8 | 9 | if sys.platform > 3: ... # Error: PYI007 Unrecognized sys.platform check | PYI007.pyi:9:4: PYI007 Unrecognized `sys.platform` check | 7 | if sys.platform in ["linux"]: ... # Error: PYI007 Unrecognized sys.platform check - 8 | + 8 | 9 | if sys.platform > 3: ... # Error: PYI007 Unrecognized sys.platform check | ^^^^^^^^^^^^^^^^ PYI007 -10 | +10 | 11 | if sys.platform == 10.12: ... # Error: PYI007 Unrecognized sys.platform check | PYI007.pyi:11:4: PYI007 Unrecognized `sys.platform` check | 9 | if sys.platform > 3: ... # Error: PYI007 Unrecognized sys.platform check -10 | +10 | 11 | if sys.platform == 10.12: ... # Error: PYI007 Unrecognized sys.platform check | ^^^^^^^^^^^^^^^^^^^^^ PYI007 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.pyi.snap index 43550f78a49f3..4e8588c7a3dfe 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI008_PYI008.pyi.snap @@ -4,11 +4,9 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI008.pyi:3:20: PYI008 Unrecognized platform `linus` | 1 | import sys -2 | +2 | 3 | if sys.platform == "linus": ... # Error: PYI008 Unrecognized platform `linus` | ^^^^^^^ PYI008 -4 | +4 | 5 | if sys.platform != "linux": ... # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.pyi.snap index d4c1347bf3c7a..48db875d89088 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI009_PYI009.pyi.snap @@ -7,7 +7,7 @@ PYI009.pyi:3:5: PYI009 [*] Empty body should contain `...`, not `pass` 2 | def foo(): 3 | pass # ERROR PYI009, since we're in a stub file | ^^^^ PYI009 -4 | +4 | 5 | class Bar: ... # OK | = help: Replace `pass` with `...` @@ -35,5 +35,3 @@ PYI009.pyi:8:5: PYI009 [*] Empty body should contain `...`, not `pass` 7 7 | class Foo: 8 |- pass # ERROR PYI009, since we're in a stub file 8 |+ ... # ERROR PYI009, since we're in a stub file - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.pyi.snap index 516ca749ad73b..a24482573d5d8 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI010_PYI010.pyi.snap @@ -6,7 +6,7 @@ PYI010.pyi:6:5: PYI010 [*] Function body must contain only `...` 5 | def buzz(): 6 | print("buzz") # ERROR PYI010 | ^^^^^^^^^^^^^ PYI010 -7 | +7 | 8 | def foo2(): | = help: Replace function body with `...` @@ -26,7 +26,7 @@ PYI010.pyi:9:5: PYI010 [*] Function body must contain only `...` 8 | def foo2(): 9 | 123 # ERROR PYI010 | ^^^ PYI010 -10 | +10 | 11 | def bizz(): | = help: Replace function body with `...` @@ -46,7 +46,7 @@ PYI010.pyi:12:5: PYI010 [*] Function body must contain only `...` 11 | def bizz(): 12 | x = 123 # ERROR PYI010 | ^^^^^^^ PYI010 -13 | +13 | 14 | def foo3(): | = help: Replace function body with `...` @@ -60,5 +60,3 @@ PYI010.pyi:12:5: PYI010 [*] Function body must contain only `...` 13 13 | 14 14 | def foo3(): 15 15 | pass # OK, pass is handled by another rule - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap index 6a68fe21f28fb..e8e0429c3a83c 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI011.pyi:10:14: PYI011 [*] Only simple default values allowed for typed arguments | @@ -453,5 +454,3 @@ PYI011.pyi:159:14: PYI011 [*] Only simple default values allowed for typed argum 160 |- + "", 159 |+ x: str = ..., 161 160 | ) -> None: ... - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.pyi.snap index 9b67fe2854108..580d853e1fa57 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI012_PYI012.pyi.snap @@ -7,7 +7,7 @@ PYI012.pyi:5:5: PYI012 [*] Class body must not contain `pass` 4 | value: int 5 | pass # PYI012 Class body must not contain `pass` | ^^^^ PYI012 -6 | +6 | 7 | class OneAttributeClassRev: | = help: Remove unnecessary `pass` @@ -42,10 +42,10 @@ PYI012.pyi:8:5: PYI012 [*] Class body must not contain `pass` PYI012.pyi:16:5: PYI012 [*] Class body must not contain `pass` | 14 | """ -15 | +15 | 16 | pass # PYI012 Class body must not contain `pass` | ^^^^ PYI012 -17 | +17 | 18 | class NonEmptyChild(Exception): | = help: Remove unnecessary `pass` @@ -65,7 +65,7 @@ PYI012.pyi:20:5: PYI012 [*] Class body must not contain `pass` 19 | value: int 20 | pass # PYI012 Class body must not contain `pass` | ^^^^ PYI012 -21 | +21 | 22 | class NonEmptyChild2(Exception): | = help: Remove unnecessary `pass` @@ -103,7 +103,7 @@ PYI012.pyi:28:5: PYI012 [*] Class body must not contain `pass` 27 | value: int 28 | pass # PYI012 Class body must not contain `pass` | ^^^^ PYI012 -29 | +29 | 30 | def __init__(): | = help: Remove unnecessary `pass` @@ -116,5 +116,3 @@ PYI012.pyi:28:5: PYI012 [*] Class body must not contain `pass` 29 28 | 30 29 | def __init__(): 31 30 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.py.snap index 5dfb8d8b4bdee..d76266722eb85 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.py.snap @@ -75,7 +75,7 @@ PYI013.py:13:5: PYI013 [*] Non-empty class body must not contain `...` PYI013.py:21:5: PYI013 [*] Non-empty class body must not contain `...` | 19 | """ -20 | +20 | 21 | ... | ^^^ PYI013 | @@ -132,7 +132,7 @@ PYI013.py:36:5: PYI013 [*] Non-empty class body must not contain `...` 35 | value: int 36 | ... | ^^^ PYI013 -37 | +37 | 38 | def __init__(): | = help: Remove unnecessary `...` @@ -145,5 +145,3 @@ PYI013.py:36:5: PYI013 [*] Non-empty class body must not contain `...` 37 36 | 38 37 | def __init__(): 39 38 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.pyi.snap index 83ac30ca4e468..3fc5a71eb42f3 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI013_PYI013.pyi.snap @@ -7,7 +7,7 @@ PYI013.pyi:5:5: PYI013 [*] Non-empty class body must not contain `...` 4 | value: int 5 | ... # Error | ^^^ PYI013 -6 | +6 | 7 | class OneAttributeClass2: | = help: Remove unnecessary `...` @@ -81,7 +81,7 @@ PYI013.pyi:17:5: PYI013 [*] Non-empty class body must not contain `...` 16 | ... 17 | ... # Error | ^^^ PYI013 -18 | +18 | 19 | class DocstringClass: | = help: Remove unnecessary `...` @@ -98,10 +98,10 @@ PYI013.pyi:17:5: PYI013 [*] Non-empty class body must not contain `...` PYI013.pyi:24:5: PYI013 [*] Non-empty class body must not contain `...` | 22 | """ -23 | +23 | 24 | ... # Error | ^^^ PYI013 -25 | +25 | 26 | class NonEmptyChild(Exception): | = help: Remove unnecessary `...` @@ -121,7 +121,7 @@ PYI013.pyi:28:5: PYI013 [*] Non-empty class body must not contain `...` 27 | value: int 28 | ... # Error | ^^^ PYI013 -29 | +29 | 30 | class NonEmptyChild2(Exception): | = help: Remove unnecessary `...` @@ -159,7 +159,7 @@ PYI013.pyi:36:5: PYI013 [*] Non-empty class body must not contain `...` 35 | value: int 36 | ... # Error | ^^^ PYI013 -37 | +37 | 38 | def __init__(): | = help: Remove unnecessary `...` @@ -172,5 +172,3 @@ PYI013.pyi:36:5: PYI013 [*] Non-empty class body must not contain `...` 37 36 | 38 37 | def __init__(): 39 38 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.pyi.snap index cdad97490f8b9..fdba744bdeccb 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI014_PYI014.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI014.pyi:3:7: PYI014 [*] Only simple default values allowed for arguments | @@ -311,5 +312,3 @@ PYI014.pyi:78:7: PYI014 [*] Only simple default values allowed for arguments 79 79 | ) -> None: ... 80 80 | def f23( 81 81 | x=True, # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.pyi.snap index 95ae4adb58ee0..120743179f50d 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI015_PYI015.pyi.snap @@ -215,7 +215,7 @@ PYI015.pyi:55:11: PYI015 [*] Only simple default values allowed for assignments 54 | field24 = b"foo" + b"bar" # Y015 Only simple default values are allowed for assignments 55 | field25 = 5 * 5 # Y015 Only simple default values are allowed for assignments | ^^^^^ PYI015 -56 | +56 | 57 | # We shouldn't emit Y015 within functions | = help: Replace default value with `...` @@ -229,5 +229,3 @@ PYI015.pyi:55:11: PYI015 [*] Only simple default values allowed for assignments 56 56 | 57 57 | # We shouldn't emit Y015 within functions 58 58 | def f(): - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.py.snap index d3ba1b4f1334b..3d671d859c533 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.py.snap @@ -6,7 +6,7 @@ PYI016.py:7:15: PYI016 [*] Duplicate union member `str` 6 | # Should emit for duplicate field types. 7 | field2: str | str # PYI016: Duplicate union member `str` | ^^^ PYI016 -8 | +8 | 9 | # Should emit for union types in arguments. | = help: Remove duplicate union member `str` @@ -126,7 +126,7 @@ PYI016.py:21:28: PYI016 [*] Duplicate union member `int` 20 | field5: str | int | str # PYI016: Duplicate union member `str` 21 | field6: int | bool | str | int # PYI016: Duplicate union member `int` | ^^^ PYI016 -22 | +22 | 23 | # Shouldn't emit for non-type unions. | = help: Remove duplicate union member `int` @@ -146,7 +146,7 @@ PYI016.py:27:22: PYI016 [*] Duplicate union member `int` 26 | # Should emit for strangely-bracketed unions. 27 | field8: int | (str | int) # PYI016: Duplicate union member `int` | ^^^ PYI016 -28 | +28 | 29 | # Should handle user brackets when fixing. | = help: Remove duplicate union member `int` @@ -156,7 +156,7 @@ PYI016.py:27:22: PYI016 [*] Duplicate union member `int` 25 25 | 26 26 | # Should emit for strangely-bracketed unions. 27 |-field8: int | (str | int) # PYI016: Duplicate union member `int` - 27 |+field8: int | (str) # PYI016: Duplicate union member `int` + 27 |+field8: int | str # PYI016: Duplicate union member `int` 28 28 | 29 29 | # Should handle user brackets when fixing. 30 30 | field9: int | (int | str) # PYI016: Duplicate union member `int` @@ -175,7 +175,7 @@ PYI016.py:30:16: PYI016 [*] Duplicate union member `int` 28 28 | 29 29 | # Should handle user brackets when fixing. 30 |-field9: int | (int | str) # PYI016: Duplicate union member `int` - 30 |+field9: int | (str) # PYI016: Duplicate union member `int` + 30 |+field9: int | str # PYI016: Duplicate union member `int` 31 31 | field10: (str | int) | str # PYI016: Duplicate union member `str` 32 32 | 33 33 | # Should emit for nested unions. @@ -186,7 +186,7 @@ PYI016.py:31:24: PYI016 [*] Duplicate union member `str` 30 | field9: int | (int | str) # PYI016: Duplicate union member `int` 31 | field10: (str | int) | str # PYI016: Duplicate union member `str` | ^^^ PYI016 -32 | +32 | 33 | # Should emit for nested unions. | = help: Remove duplicate union member `str` @@ -206,7 +206,7 @@ PYI016.py:34:21: PYI016 [*] Duplicate union member `int` 33 | # Should emit for nested unions. 34 | field11: dict[int | int, str] | ^^^ PYI016 -35 | +35 | 36 | # Should emit for unions with more than two cases | = help: Remove duplicate union member `int` @@ -235,7 +235,7 @@ PYI016.py:37:16: PYI016 [*] Duplicate union member `int` 35 35 | 36 36 | # Should emit for unions with more than two cases 37 |-field12: int | int | int # Error - 37 |+field12: int | int # Error + 37 |+field12: int # Error 38 38 | field13: int | int | int | int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent @@ -254,7 +254,7 @@ PYI016.py:37:22: PYI016 [*] Duplicate union member `int` 35 35 | 36 36 | # Should emit for unions with more than two cases 37 |-field12: int | int | int # Error - 37 |+field12: int | int # Error + 37 |+field12: int # Error 38 38 | field13: int | int | int | int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent @@ -265,7 +265,7 @@ PYI016.py:38:16: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -275,7 +275,7 @@ PYI016.py:38:16: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -286,7 +286,7 @@ PYI016.py:38:22: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -296,7 +296,7 @@ PYI016.py:38:22: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -307,7 +307,7 @@ PYI016.py:38:28: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -317,7 +317,7 @@ PYI016.py:38:28: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -327,7 +327,7 @@ PYI016.py:41:16: PYI016 [*] Duplicate union member `int` 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 | field14: int | int | str | int # Error | ^^^ PYI016 -42 | +42 | 43 | # Should emit for duplicate literal types; also covered by PYI030 | = help: Remove duplicate union member `int` @@ -337,7 +337,7 @@ PYI016.py:41:16: PYI016 [*] Duplicate union member `int` 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 |-field14: int | int | str | int # Error - 41 |+field14: int | str | int # Error + 41 |+field14: int | str # Error 42 42 | 43 43 | # Should emit for duplicate literal types; also covered by PYI030 44 44 | field15: typing.Literal[1] | typing.Literal[1] # Error @@ -347,7 +347,7 @@ PYI016.py:41:28: PYI016 [*] Duplicate union member `int` 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 | field14: int | int | str | int # Error | ^^^ PYI016 -42 | +42 | 43 | # Should emit for duplicate literal types; also covered by PYI030 | = help: Remove duplicate union member `int` @@ -357,7 +357,7 @@ PYI016.py:41:28: PYI016 [*] Duplicate union member `int` 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 |-field14: int | int | str | int # Error - 41 |+field14: int | int | str # Error + 41 |+field14: int | str # Error 42 42 | 43 43 | # Should emit for duplicate literal types; also covered by PYI030 44 44 | field15: typing.Literal[1] | typing.Literal[1] # Error @@ -367,7 +367,7 @@ PYI016.py:44:30: PYI016 [*] Duplicate union member `typing.Literal[1]` 43 | # Should emit for duplicate literal types; also covered by PYI030 44 | field15: typing.Literal[1] | typing.Literal[1] # Error | ^^^^^^^^^^^^^^^^^ PYI016 -45 | +45 | 46 | # Shouldn't emit if in new parent type | = help: Remove duplicate union member `typing.Literal[1]` @@ -382,12 +382,11 @@ PYI016.py:44:30: PYI016 [*] Duplicate union member `typing.Literal[1]` 46 46 | # Shouldn't emit if in new parent type 47 47 | field16: int | dict[int, str] # OK -PYI016.py:57:5: PYI016 Duplicate union member `set[int]` +PYI016.py:57:5: PYI016 [*] Duplicate union member `set[int]` | 55 | int # foo 56 | ], -57 | set[ - | _____^ +57 | / set[ 58 | | int # bar 59 | | ], | |_____^ PYI016 @@ -395,32 +394,69 @@ PYI016.py:57:5: PYI016 Duplicate union member `set[int]` | = help: Remove duplicate union member `set[int]` -PYI016.py:63:28: PYI016 Duplicate union member `int` +ℹ Unsafe fix +50 50 | field17: dict[int, int] # OK +51 51 | +52 52 | # Should emit in cases with newlines +53 |-field18: typing.Union[ +54 |- set[ +55 |- int # foo +56 |- ], +57 |- set[ +58 |- int # bar +59 |- ], +60 |-] # Error, newline and comment will not be emitted in message + 53 |+field18: set[int] # Error, newline and comment will not be emitted in message +61 54 | +62 55 | # Should emit in cases with `typing.Union` instead of `|` +63 56 | field19: typing.Union[int, int] # Error + +PYI016.py:63:28: PYI016 [*] Duplicate union member `int` | 62 | # Should emit in cases with `typing.Union` instead of `|` 63 | field19: typing.Union[int, int] # Error | ^^^ PYI016 -64 | +64 | 65 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` -PYI016.py:66:41: PYI016 Duplicate union member `int` +ℹ Safe fix +60 60 | ] # Error, newline and comment will not be emitted in message +61 61 | +62 62 | # Should emit in cases with `typing.Union` instead of `|` +63 |-field19: typing.Union[int, int] # Error + 63 |+field19: int # Error +64 64 | +65 65 | # Should emit in cases with nested `typing.Union` +66 66 | field20: typing.Union[int, typing.Union[int, str]] # Error + +PYI016.py:66:41: PYI016 [*] Duplicate union member `int` | 65 | # Should emit in cases with nested `typing.Union` 66 | field20: typing.Union[int, typing.Union[int, str]] # Error | ^^^ PYI016 -67 | +67 | 68 | # Should emit in cases with mixed `typing.Union` and `|` | = help: Remove duplicate union member `int` +ℹ Safe fix +63 63 | field19: typing.Union[int, int] # Error +64 64 | +65 65 | # Should emit in cases with nested `typing.Union` +66 |-field20: typing.Union[int, typing.Union[int, str]] # Error + 66 |+field20: typing.Union[int, str] # Error +67 67 | +68 68 | # Should emit in cases with mixed `typing.Union` and `|` +69 69 | field21: typing.Union[int, int | str] # Error + PYI016.py:69:28: PYI016 [*] Duplicate union member `int` | 68 | # Should emit in cases with mixed `typing.Union` and `|` 69 | field21: typing.Union[int, int | str] # Error | ^^^ PYI016 -70 | +70 | 71 | # Should emit only once in cases with multiple nested `typing.Union` | = help: Remove duplicate union member `int` @@ -430,90 +466,143 @@ PYI016.py:69:28: PYI016 [*] Duplicate union member `int` 67 67 | 68 68 | # Should emit in cases with mixed `typing.Union` and `|` 69 |-field21: typing.Union[int, int | str] # Error - 69 |+field21: typing.Union[int, str] # Error + 69 |+field21: int | str # Error 70 70 | 71 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error -PYI016.py:72:41: PYI016 Duplicate union member `int` +PYI016.py:72:41: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` -PYI016.py:72:59: PYI016 Duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + +PYI016.py:72:59: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` -PYI016.py:72:64: PYI016 Duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + +PYI016.py:72:64: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + PYI016.py:76:12: PYI016 [*] Duplicate union member `set[int]` | 74 | # Should emit in cases with newlines 75 | field23: set[ # foo 76 | int] | set[int] | ^^^^^^^^ PYI016 -77 | +77 | 78 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `set[int]` -ℹ Safe fix +ℹ Unsafe fix +72 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error 73 73 | 74 74 | # Should emit in cases with newlines -75 75 | field23: set[ # foo +75 |-field23: set[ # foo 76 |- int] | set[int] - 76 |+ int] -77 77 | -78 78 | # Should emit twice (once for each `int` in the nested union, both of which are -79 79 | # duplicates of the outer `int`), but not three times (which would indicate that + 75 |+field23: set[int] +77 76 | +78 77 | # Should emit twice (once for each `int` in the nested union, both of which are +79 78 | # duplicates of the outer `int`), but not three times (which would indicate that -PYI016.py:81:41: PYI016 Duplicate union member `int` +PYI016.py:81:41: PYI016 [*] Duplicate union member `int` | 79 | # duplicates of the outer `int`), but not three times (which would indicate that 80 | # we incorrectly re-checked the nested union). 81 | field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` | ^^^ PYI016 -82 | +82 | 83 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `int` -PYI016.py:81:46: PYI016 Duplicate union member `int` +ℹ Safe fix +78 78 | # Should emit twice (once for each `int` in the nested union, both of which are +79 79 | # duplicates of the outer `int`), but not three times (which would indicate that +80 80 | # we incorrectly re-checked the nested union). +81 |-field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` + 81 |+field24: int # PYI016: Duplicate union member `int` +82 82 | +83 83 | # Should emit twice (once for each `int` in the nested union, both of which are +84 84 | # duplicates of the outer `int`), but not three times (which would indicate that + +PYI016.py:81:46: PYI016 [*] Duplicate union member `int` | 79 | # duplicates of the outer `int`), but not three times (which would indicate that 80 | # we incorrectly re-checked the nested union). 81 | field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` | ^^^ PYI016 -82 | +82 | 83 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `int` +ℹ Safe fix +78 78 | # Should emit twice (once for each `int` in the nested union, both of which are +79 79 | # duplicates of the outer `int`), but not three times (which would indicate that +80 80 | # we incorrectly re-checked the nested union). +81 |-field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` + 81 |+field24: int # PYI016: Duplicate union member `int` +82 82 | +83 83 | # Should emit twice (once for each `int` in the nested union, both of which are +84 84 | # duplicates of the outer `int`), but not three times (which would indicate that + PYI016.py:86:28: PYI016 [*] Duplicate union member `int` | 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 | # we incorrectly re-checked the nested union). 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` | ^^^ PYI016 +87 | +88 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` @@ -522,7 +611,10 @@ PYI016.py:86:28: PYI016 [*] Duplicate union member `int` 84 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 85 | # we incorrectly re-checked the nested union). 86 |-field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` - 86 |+field25: typing.Union[int, int] # PYI016: Duplicate union member `int` + 86 |+field25: int # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` PYI016.py:86:34: PYI016 [*] Duplicate union member `int` | @@ -530,6 +622,8 @@ PYI016.py:86:34: PYI016 [*] Duplicate union member `int` 85 | # we incorrectly re-checked the nested union). 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` | ^^^ PYI016 +87 | +88 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` @@ -538,6 +632,286 @@ PYI016.py:86:34: PYI016 [*] Duplicate union member `int` 84 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 85 | # we incorrectly re-checked the nested union). 86 |-field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` - 86 |+field25: typing.Union[int, int] # PYI016: Duplicate union member `int` + 86 |+field25: int # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + +PYI016.py:89:41: PYI016 [*] Duplicate union member `int` + | +88 | # Should emit in cases with nested `typing.Union` +89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + | ^^^ PYI016 +90 | +91 | # Should emit in cases with nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +86 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 |-field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + 89 |+field26: int # PYI016: Duplicate union member `int` +90 90 | +91 91 | # Should emit in cases with nested `typing.Union` +92 92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + +PYI016.py:92:54: PYI016 [*] Duplicate union member `int` + | +91 | # Should emit in cases with nested `typing.Union` +92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + | ^^^ PYI016 +93 | +94 | # Should emit in cases with mixed `typing.Union` and `|` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` +90 90 | +91 91 | # Should emit in cases with nested `typing.Union` +92 |-field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + 92 |+field27: int # PYI016: Duplicate union member `int` +93 93 | +94 94 | # Should emit in cases with mixed `typing.Union` and `|` +95 95 | field28: typing.Union[int | int] # Error + +PYI016.py:95:29: PYI016 [*] Duplicate union member `int` + | +94 | # Should emit in cases with mixed `typing.Union` and `|` +95 | field28: typing.Union[int | int] # Error + | ^^^ PYI016 +96 | +97 | # Should emit twice in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +92 92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` +93 93 | +94 94 | # Should emit in cases with mixed `typing.Union` and `|` +95 |-field28: typing.Union[int | int] # Error + 95 |+field28: int # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + +PYI016.py:98:54: PYI016 [*] Duplicate union member `int` + | + 97 | # Should emit twice in cases with multiple nested `typing.Union` + 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + | ^^^ PYI016 + 99 | +100 | # Should emit once in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` +ℹ Safe fix +95 95 | field28: typing.Union[int | int] # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 |-field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + 98 |+field29: int # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +PYI016.py:98:59: PYI016 [*] Duplicate union member `int` + | + 97 | # Should emit twice in cases with multiple nested `typing.Union` + 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + | ^^^ PYI016 + 99 | +100 | # Should emit once in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +95 95 | field28: typing.Union[int | int] # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 |-field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + 98 |+field29: int # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +PYI016.py:101:54: PYI016 [*] Duplicate union member `int` + | +100 | # Should emit once in cases with multiple nested `typing.Union` +101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + | ^^^ PYI016 +102 | +103 | # Should emit once, and fix to `typing.Union[float, int]` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +98 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 |-field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + 101 |+field30: typing.Union[int, str] # Error +102 102 | +103 103 | # Should emit once, and fix to `typing.Union[float, int]` +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error + +PYI016.py:104:49: PYI016 [*] Duplicate union member `int` + | +103 | # Should emit once, and fix to `typing.Union[float, int]` +104 | field31: typing.Union[float, typing.Union[int | int]] # Error + | ^^^ PYI016 +105 | +106 | # Should emit once, and fix to `typing.Union[float, int]` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error +102 102 | +103 103 | # Should emit once, and fix to `typing.Union[float, int]` +104 |-field31: typing.Union[float, typing.Union[int | int]] # Error + 104 |+field31: float | int # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + +PYI016.py:107:49: PYI016 [*] Duplicate union member `int` + | +106 | # Should emit once, and fix to `typing.Union[float, int]` +107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + | ^^^ PYI016 +108 | +109 | # Test case for mixed union type fix + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 |-field32: typing.Union[float, typing.Union[int | int | int]] # Error + 107 |+field32: float | int # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +PYI016.py:107:55: PYI016 [*] Duplicate union member `int` + | +106 | # Should emit once, and fix to `typing.Union[float, int]` +107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + | ^^^ PYI016 +108 | +109 | # Test case for mixed union type fix + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 |-field32: typing.Union[float, typing.Union[int | int | int]] # Error + 107 |+field32: float | int # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +PYI016.py:110:42: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.py:110:62: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.py:110:68: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.py:113:61: PYI016 [*] Duplicate union member `list[int]` + | +112 | # Test case for mixed union type +113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + | ^^^^^^^^^ PYI016 +114 | +115 | field35: "int | str | int" # Error + | + = help: Remove duplicate union member `list[int]` + +ℹ Safe fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error +111 111 | +112 112 | # Test case for mixed union type +113 |-field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + 113 |+field34: typing.Union[list[int], str, bytes] # Error +114 114 | +115 115 | field35: "int | str | int" # Error +116 116 | + +PYI016.py:115:23: PYI016 [*] Duplicate union member `int` + | +113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error +114 | +115 | field35: "int | str | int" # Error + | ^^^ PYI016 + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error +114 114 | +115 |-field35: "int | str | int" # Error + 115 |+field35: "int | str" # Error +116 116 | +117 117 | +118 118 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.pyi.snap index 647791e92b21e..0f14b06acb8d6 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI016_PYI016.pyi.snap @@ -1,12 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI016.pyi:7:15: PYI016 [*] Duplicate union member `str` | 6 | # Should emit for duplicate field types. 7 | field2: str | str # PYI016: Duplicate union member `str` | ^^^ PYI016 -8 | +8 | 9 | # Should emit for union types in arguments. | = help: Remove duplicate union member `str` @@ -126,7 +127,7 @@ PYI016.pyi:21:28: PYI016 [*] Duplicate union member `int` 20 | field5: str | int | str # PYI016: Duplicate union member `str` 21 | field6: int | bool | str | int # PYI016: Duplicate union member `int` | ^^^ PYI016 -22 | +22 | 23 | # Shouldn't emit for non-type unions. | = help: Remove duplicate union member `int` @@ -146,7 +147,7 @@ PYI016.pyi:27:22: PYI016 [*] Duplicate union member `int` 26 | # Should emit for strangely-bracketed unions. 27 | field8: int | (str | int) # PYI016: Duplicate union member `int` | ^^^ PYI016 -28 | +28 | 29 | # Should handle user brackets when fixing. | = help: Remove duplicate union member `int` @@ -156,7 +157,7 @@ PYI016.pyi:27:22: PYI016 [*] Duplicate union member `int` 25 25 | 26 26 | # Should emit for strangely-bracketed unions. 27 |-field8: int | (str | int) # PYI016: Duplicate union member `int` - 27 |+field8: int | (str) # PYI016: Duplicate union member `int` + 27 |+field8: int | str # PYI016: Duplicate union member `int` 28 28 | 29 29 | # Should handle user brackets when fixing. 30 30 | field9: int | (int | str) # PYI016: Duplicate union member `int` @@ -175,7 +176,7 @@ PYI016.pyi:30:16: PYI016 [*] Duplicate union member `int` 28 28 | 29 29 | # Should handle user brackets when fixing. 30 |-field9: int | (int | str) # PYI016: Duplicate union member `int` - 30 |+field9: int | (str) # PYI016: Duplicate union member `int` + 30 |+field9: int | str # PYI016: Duplicate union member `int` 31 31 | field10: (str | int) | str # PYI016: Duplicate union member `str` 32 32 | 33 33 | # Should emit for nested unions. @@ -186,7 +187,7 @@ PYI016.pyi:31:24: PYI016 [*] Duplicate union member `str` 30 | field9: int | (int | str) # PYI016: Duplicate union member `int` 31 | field10: (str | int) | str # PYI016: Duplicate union member `str` | ^^^ PYI016 -32 | +32 | 33 | # Should emit for nested unions. | = help: Remove duplicate union member `str` @@ -206,7 +207,7 @@ PYI016.pyi:34:21: PYI016 [*] Duplicate union member `int` 33 | # Should emit for nested unions. 34 | field11: dict[int | int, str] | ^^^ PYI016 -35 | +35 | 36 | # Should emit for unions with more than two cases | = help: Remove duplicate union member `int` @@ -235,7 +236,7 @@ PYI016.pyi:37:16: PYI016 [*] Duplicate union member `int` 35 35 | 36 36 | # Should emit for unions with more than two cases 37 |-field12: int | int | int # Error - 37 |+field12: int | int # Error + 37 |+field12: int # Error 38 38 | field13: int | int | int | int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent @@ -254,7 +255,7 @@ PYI016.pyi:37:22: PYI016 [*] Duplicate union member `int` 35 35 | 36 36 | # Should emit for unions with more than two cases 37 |-field12: int | int | int # Error - 37 |+field12: int | int # Error + 37 |+field12: int # Error 38 38 | field13: int | int | int | int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent @@ -265,7 +266,7 @@ PYI016.pyi:38:16: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -275,7 +276,7 @@ PYI016.pyi:38:16: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -286,7 +287,7 @@ PYI016.pyi:38:22: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -296,7 +297,7 @@ PYI016.pyi:38:22: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -307,7 +308,7 @@ PYI016.pyi:38:28: PYI016 [*] Duplicate union member `int` 37 | field12: int | int | int # Error 38 | field13: int | int | int | int # Error | ^^^ PYI016 -39 | +39 | 40 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Remove duplicate union member `int` @@ -317,7 +318,7 @@ PYI016.pyi:38:28: PYI016 [*] Duplicate union member `int` 36 36 | # Should emit for unions with more than two cases 37 37 | field12: int | int | int # Error 38 |-field13: int | int | int | int # Error - 38 |+field13: int | int | int # Error + 38 |+field13: int # Error 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 41 | field14: int | int | str | int # Error @@ -327,7 +328,7 @@ PYI016.pyi:41:16: PYI016 [*] Duplicate union member `int` 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 | field14: int | int | str | int # Error | ^^^ PYI016 -42 | +42 | 43 | # Should emit for duplicate literal types; also covered by PYI030 | = help: Remove duplicate union member `int` @@ -337,7 +338,7 @@ PYI016.pyi:41:16: PYI016 [*] Duplicate union member `int` 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 |-field14: int | int | str | int # Error - 41 |+field14: int | str | int # Error + 41 |+field14: int | str # Error 42 42 | 43 43 | # Should emit for duplicate literal types; also covered by PYI030 44 44 | field15: typing.Literal[1] | typing.Literal[1] # Error @@ -347,7 +348,7 @@ PYI016.pyi:41:28: PYI016 [*] Duplicate union member `int` 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 | field14: int | int | str | int # Error | ^^^ PYI016 -42 | +42 | 43 | # Should emit for duplicate literal types; also covered by PYI030 | = help: Remove duplicate union member `int` @@ -357,7 +358,7 @@ PYI016.pyi:41:28: PYI016 [*] Duplicate union member `int` 39 39 | 40 40 | # Should emit for unions with more than two cases, even if not directly adjacent 41 |-field14: int | int | str | int # Error - 41 |+field14: int | int | str # Error + 41 |+field14: int | str # Error 42 42 | 43 43 | # Should emit for duplicate literal types; also covered by PYI030 44 44 | field15: typing.Literal[1] | typing.Literal[1] # Error @@ -367,7 +368,7 @@ PYI016.pyi:44:30: PYI016 [*] Duplicate union member `typing.Literal[1]` 43 | # Should emit for duplicate literal types; also covered by PYI030 44 | field15: typing.Literal[1] | typing.Literal[1] # Error | ^^^^^^^^^^^^^^^^^ PYI016 -45 | +45 | 46 | # Shouldn't emit if in new parent type | = help: Remove duplicate union member `typing.Literal[1]` @@ -382,12 +383,11 @@ PYI016.pyi:44:30: PYI016 [*] Duplicate union member `typing.Literal[1]` 46 46 | # Shouldn't emit if in new parent type 47 47 | field16: int | dict[int, str] # OK -PYI016.pyi:57:5: PYI016 Duplicate union member `set[int]` +PYI016.pyi:57:5: PYI016 [*] Duplicate union member `set[int]` | 55 | int # foo 56 | ], -57 | set[ - | _____^ +57 | / set[ 58 | | int # bar 59 | | ], | |_____^ PYI016 @@ -395,32 +395,69 @@ PYI016.pyi:57:5: PYI016 Duplicate union member `set[int]` | = help: Remove duplicate union member `set[int]` -PYI016.pyi:63:28: PYI016 Duplicate union member `int` +ℹ Unsafe fix +50 50 | field17: dict[int, int] # OK +51 51 | +52 52 | # Should emit in cases with newlines +53 |-field18: typing.Union[ +54 |- set[ +55 |- int # foo +56 |- ], +57 |- set[ +58 |- int # bar +59 |- ], +60 |-] # Error, newline and comment will not be emitted in message + 53 |+field18: set[int] # Error, newline and comment will not be emitted in message +61 54 | +62 55 | # Should emit in cases with `typing.Union` instead of `|` +63 56 | field19: typing.Union[int, int] # Error + +PYI016.pyi:63:28: PYI016 [*] Duplicate union member `int` | 62 | # Should emit in cases with `typing.Union` instead of `|` 63 | field19: typing.Union[int, int] # Error | ^^^ PYI016 -64 | +64 | 65 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` -PYI016.pyi:66:41: PYI016 Duplicate union member `int` +ℹ Safe fix +60 60 | ] # Error, newline and comment will not be emitted in message +61 61 | +62 62 | # Should emit in cases with `typing.Union` instead of `|` +63 |-field19: typing.Union[int, int] # Error + 63 |+field19: int # Error +64 64 | +65 65 | # Should emit in cases with nested `typing.Union` +66 66 | field20: typing.Union[int, typing.Union[int, str]] # Error + +PYI016.pyi:66:41: PYI016 [*] Duplicate union member `int` | 65 | # Should emit in cases with nested `typing.Union` 66 | field20: typing.Union[int, typing.Union[int, str]] # Error | ^^^ PYI016 -67 | +67 | 68 | # Should emit in cases with mixed `typing.Union` and `|` | = help: Remove duplicate union member `int` +ℹ Safe fix +63 63 | field19: typing.Union[int, int] # Error +64 64 | +65 65 | # Should emit in cases with nested `typing.Union` +66 |-field20: typing.Union[int, typing.Union[int, str]] # Error + 66 |+field20: typing.Union[int, str] # Error +67 67 | +68 68 | # Should emit in cases with mixed `typing.Union` and `|` +69 69 | field21: typing.Union[int, int | str] # Error + PYI016.pyi:69:28: PYI016 [*] Duplicate union member `int` | 68 | # Should emit in cases with mixed `typing.Union` and `|` 69 | field21: typing.Union[int, int | str] # Error | ^^^ PYI016 -70 | +70 | 71 | # Should emit only once in cases with multiple nested `typing.Union` | = help: Remove duplicate union member `int` @@ -430,90 +467,143 @@ PYI016.pyi:69:28: PYI016 [*] Duplicate union member `int` 67 67 | 68 68 | # Should emit in cases with mixed `typing.Union` and `|` 69 |-field21: typing.Union[int, int | str] # Error - 69 |+field21: typing.Union[int, str] # Error + 69 |+field21: int | str # Error 70 70 | 71 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error -PYI016.pyi:72:41: PYI016 Duplicate union member `int` +PYI016.pyi:72:41: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` -PYI016.pyi:72:59: PYI016 Duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + +PYI016.pyi:72:59: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` -PYI016.pyi:72:64: PYI016 Duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + +PYI016.pyi:72:64: PYI016 [*] Duplicate union member `int` | 71 | # Should emit only once in cases with multiple nested `typing.Union` 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error | ^^^ PYI016 -73 | +73 | 74 | # Should emit in cases with newlines | = help: Remove duplicate union member `int` +ℹ Safe fix +69 69 | field21: typing.Union[int, int | str] # Error +70 70 | +71 71 | # Should emit only once in cases with multiple nested `typing.Union` +72 |-field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error + 72 |+field22: int # Error +73 73 | +74 74 | # Should emit in cases with newlines +75 75 | field23: set[ # foo + PYI016.pyi:76:12: PYI016 [*] Duplicate union member `set[int]` | 74 | # Should emit in cases with newlines 75 | field23: set[ # foo 76 | int] | set[int] | ^^^^^^^^ PYI016 -77 | +77 | 78 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `set[int]` -ℹ Safe fix +ℹ Unsafe fix +72 72 | field22: typing.Union[int, typing.Union[int, typing.Union[int, int]]] # Error 73 73 | 74 74 | # Should emit in cases with newlines -75 75 | field23: set[ # foo +75 |-field23: set[ # foo 76 |- int] | set[int] - 76 |+ int] -77 77 | -78 78 | # Should emit twice (once for each `int` in the nested union, both of which are -79 79 | # duplicates of the outer `int`), but not three times (which would indicate that + 75 |+field23: set[int] +77 76 | +78 77 | # Should emit twice (once for each `int` in the nested union, both of which are +79 78 | # duplicates of the outer `int`), but not three times (which would indicate that -PYI016.pyi:81:41: PYI016 Duplicate union member `int` +PYI016.pyi:81:41: PYI016 [*] Duplicate union member `int` | 79 | # duplicates of the outer `int`), but not three times (which would indicate that 80 | # we incorrectly re-checked the nested union). 81 | field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` | ^^^ PYI016 -82 | +82 | 83 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `int` -PYI016.pyi:81:46: PYI016 Duplicate union member `int` +ℹ Safe fix +78 78 | # Should emit twice (once for each `int` in the nested union, both of which are +79 79 | # duplicates of the outer `int`), but not three times (which would indicate that +80 80 | # we incorrectly re-checked the nested union). +81 |-field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` + 81 |+field24: int # PYI016: Duplicate union member `int` +82 82 | +83 83 | # Should emit twice (once for each `int` in the nested union, both of which are +84 84 | # duplicates of the outer `int`), but not three times (which would indicate that + +PYI016.pyi:81:46: PYI016 [*] Duplicate union member `int` | 79 | # duplicates of the outer `int`), but not three times (which would indicate that 80 | # we incorrectly re-checked the nested union). 81 | field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` | ^^^ PYI016 -82 | +82 | 83 | # Should emit twice (once for each `int` in the nested union, both of which are | = help: Remove duplicate union member `int` +ℹ Safe fix +78 78 | # Should emit twice (once for each `int` in the nested union, both of which are +79 79 | # duplicates of the outer `int`), but not three times (which would indicate that +80 80 | # we incorrectly re-checked the nested union). +81 |-field24: typing.Union[int, typing.Union[int, int]] # PYI016: Duplicate union member `int` + 81 |+field24: int # PYI016: Duplicate union member `int` +82 82 | +83 83 | # Should emit twice (once for each `int` in the nested union, both of which are +84 84 | # duplicates of the outer `int`), but not three times (which would indicate that + PYI016.pyi:86:28: PYI016 [*] Duplicate union member `int` | 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 | # we incorrectly re-checked the nested union). 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` | ^^^ PYI016 +87 | +88 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` @@ -522,7 +612,10 @@ PYI016.pyi:86:28: PYI016 [*] Duplicate union member `int` 84 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 85 | # we incorrectly re-checked the nested union). 86 |-field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` - 86 |+field25: typing.Union[int, int] # PYI016: Duplicate union member `int` + 86 |+field25: int # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` PYI016.pyi:86:34: PYI016 [*] Duplicate union member `int` | @@ -530,6 +623,8 @@ PYI016.pyi:86:34: PYI016 [*] Duplicate union member `int` 85 | # we incorrectly re-checked the nested union). 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` | ^^^ PYI016 +87 | +88 | # Should emit in cases with nested `typing.Union` | = help: Remove duplicate union member `int` @@ -538,6 +633,262 @@ PYI016.pyi:86:34: PYI016 [*] Duplicate union member `int` 84 84 | # duplicates of the outer `int`), but not three times (which would indicate that 85 85 | # we incorrectly re-checked the nested union). 86 |-field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` - 86 |+field25: typing.Union[int, int] # PYI016: Duplicate union member `int` + 86 |+field25: int # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + +PYI016.pyi:89:41: PYI016 [*] Duplicate union member `int` + | +88 | # Should emit in cases with nested `typing.Union` +89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + | ^^^ PYI016 +90 | +91 | # Should emit in cases with nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +86 86 | field25: typing.Union[int, int | int] # PYI016: Duplicate union member `int` +87 87 | +88 88 | # Should emit in cases with nested `typing.Union` +89 |-field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` + 89 |+field26: int # PYI016: Duplicate union member `int` +90 90 | +91 91 | # Should emit in cases with nested `typing.Union` +92 92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + +PYI016.pyi:92:54: PYI016 [*] Duplicate union member `int` + | +91 | # Should emit in cases with nested `typing.Union` +92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + | ^^^ PYI016 +93 | +94 | # Should emit in cases with mixed `typing.Union` and `|` + | + = help: Remove duplicate union member `int` +ℹ Safe fix +89 89 | field26: typing.Union[typing.Union[int, int]] # PYI016: Duplicate union member `int` +90 90 | +91 91 | # Should emit in cases with nested `typing.Union` +92 |-field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` + 92 |+field27: int # PYI016: Duplicate union member `int` +93 93 | +94 94 | # Should emit in cases with mixed `typing.Union` and `|` +95 95 | field28: typing.Union[int | int] # Error + +PYI016.pyi:95:29: PYI016 [*] Duplicate union member `int` + | +94 | # Should emit in cases with mixed `typing.Union` and `|` +95 | field28: typing.Union[int | int] # Error + | ^^^ PYI016 +96 | +97 | # Should emit twice in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +92 92 | field27: typing.Union[typing.Union[typing.Union[int, int]]] # PYI016: Duplicate union member `int` +93 93 | +94 94 | # Should emit in cases with mixed `typing.Union` and `|` +95 |-field28: typing.Union[int | int] # Error + 95 |+field28: int # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + +PYI016.pyi:98:54: PYI016 [*] Duplicate union member `int` + | + 97 | # Should emit twice in cases with multiple nested `typing.Union` + 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + | ^^^ PYI016 + 99 | +100 | # Should emit once in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` +ℹ Safe fix +95 95 | field28: typing.Union[int | int] # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 |-field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + 98 |+field29: int # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +PYI016.pyi:98:59: PYI016 [*] Duplicate union member `int` + | + 97 | # Should emit twice in cases with multiple nested `typing.Union` + 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + | ^^^ PYI016 + 99 | +100 | # Should emit once in cases with multiple nested `typing.Union` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +95 95 | field28: typing.Union[int | int] # Error +96 96 | +97 97 | # Should emit twice in cases with multiple nested `typing.Union` +98 |-field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error + 98 |+field29: int # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + +PYI016.pyi:101:54: PYI016 [*] Duplicate union member `int` + | +100 | # Should emit once in cases with multiple nested `typing.Union` +101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + | ^^^ PYI016 +102 | +103 | # Should emit once, and fix to `typing.Union[float, int]` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +98 98 | field29: typing.Union[int, typing.Union[typing.Union[int, int]]] # Error +99 99 | +100 100 | # Should emit once in cases with multiple nested `typing.Union` +101 |-field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error + 101 |+field30: typing.Union[int, str] # Error +102 102 | +103 103 | # Should emit once, and fix to `typing.Union[float, int]` +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error + +PYI016.pyi:104:49: PYI016 [*] Duplicate union member `int` + | +103 | # Should emit once, and fix to `typing.Union[float, int]` +104 | field31: typing.Union[float, typing.Union[int | int]] # Error + | ^^^ PYI016 +105 | +106 | # Should emit once, and fix to `typing.Union[float, int]` + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +101 101 | field30: typing.Union[int, typing.Union[typing.Union[int, str]]] # Error +102 102 | +103 103 | # Should emit once, and fix to `typing.Union[float, int]` +104 |-field31: typing.Union[float, typing.Union[int | int]] # Error + 104 |+field31: float | int # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + +PYI016.pyi:107:49: PYI016 [*] Duplicate union member `int` + | +106 | # Should emit once, and fix to `typing.Union[float, int]` +107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + | ^^^ PYI016 +108 | +109 | # Test case for mixed union type fix + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 |-field32: typing.Union[float, typing.Union[int | int | int]] # Error + 107 |+field32: float | int # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +PYI016.pyi:107:55: PYI016 [*] Duplicate union member `int` + | +106 | # Should emit once, and fix to `typing.Union[float, int]` +107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error + | ^^^ PYI016 +108 | +109 | # Test case for mixed union type fix + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +104 104 | field31: typing.Union[float, typing.Union[int | int]] # Error +105 105 | +106 106 | # Should emit once, and fix to `typing.Union[float, int]` +107 |-field32: typing.Union[float, typing.Union[int | int | int]] # Error + 107 |+field32: float | int # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + +PYI016.pyi:110:42: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.pyi:110:62: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.pyi:110:68: PYI016 [*] Duplicate union member `int` + | +109 | # Test case for mixed union type fix +110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + | ^^^ PYI016 +111 | +112 | # Test case for mixed union type + | + = help: Remove duplicate union member `int` + +ℹ Safe fix +107 107 | field32: typing.Union[float, typing.Union[int | int | int]] # Error +108 108 | +109 109 | # Test case for mixed union type fix +110 |-field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error + 110 |+field33: int # Error +111 111 | +112 112 | # Test case for mixed union type +113 113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + +PYI016.pyi:113:61: PYI016 [*] Duplicate union member `list[int]` + | +112 | # Test case for mixed union type +113 | field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + | ^^^^^^^^^ PYI016 + | + = help: Remove duplicate union member `list[int]` + +ℹ Safe fix +110 110 | field33: typing.Union[typing.Union[int | int] | typing.Union[int | int]] # Error +111 111 | +112 112 | # Test case for mixed union type +113 |-field34: typing.Union[list[int], str] | typing.Union[bytes, list[int]] # Error + 113 |+field34: typing.Union[list[int], str, bytes] # Error diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.pyi.snap index 497a4e5cf622f..5bc3532babef1 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI017_PYI017.pyi.snap @@ -4,41 +4,39 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI017.pyi:4:1: PYI017 Stubs should not contain assignments to attributes or multiple targets | 2 | a = var # OK -3 | +3 | 4 | b = c = int # PYI017 | ^^^^^^^^^^^ PYI017 -5 | +5 | 6 | a.b = int # PYI017 | PYI017.pyi:6:1: PYI017 Stubs should not contain assignments to attributes or multiple targets | 4 | b = c = int # PYI017 -5 | +5 | 6 | a.b = int # PYI017 | ^^^^^^^^^ PYI017 -7 | +7 | 8 | d, e = int, str # PYI017 | PYI017.pyi:8:1: PYI017 Stubs should not contain assignments to attributes or multiple targets | 6 | a.b = int # PYI017 - 7 | + 7 | 8 | d, e = int, str # PYI017 | ^^^^^^^^^^^^^^^ PYI017 - 9 | + 9 | 10 | f, g, h = int, str, TypeVar("T") # PYI017 | PYI017.pyi:10:1: PYI017 Stubs should not contain assignments to attributes or multiple targets | 8 | d, e = int, str # PYI017 - 9 | + 9 | 10 | f, g, h = int, str, TypeVar("T") # PYI017 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI017 -11 | +11 | 12 | i: TypeAlias = int | str # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.py.snap index 9ca737a9209ca..19ab98788364a 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.py.snap @@ -1,17 +1,27 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI018.py:6:1: PYI018 Private TypeVar `_T` is never used +PYI018.py:6:1: PYI018 [*] Private TypeVar `_T` is never used | 4 | from typing_extensions import ParamSpec, TypeVarTuple -5 | +5 | 6 | _T = typing.TypeVar("_T") | ^^ PYI018 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") 8 | _P = ParamSpec("_P") | + = help: Remove unused private TypeVar `_T` -PYI018.py:7:1: PYI018 Private TypeVarTuple `_Ts` is never used +ℹ Unsafe fix +3 3 | from typing import TypeVar +4 4 | from typing_extensions import ParamSpec, TypeVarTuple +5 5 | +6 |-_T = typing.TypeVar("_T") +7 6 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 7 | _P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") + +PYI018.py:7:1: PYI018 [*] Private TypeVarTuple `_Ts` is never used | 6 | _T = typing.TypeVar("_T") 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") @@ -19,8 +29,18 @@ PYI018.py:7:1: PYI018 Private TypeVarTuple `_Ts` is never used 8 | _P = ParamSpec("_P") 9 | _P2 = typing.ParamSpec("_P2") | + = help: Remove unused private TypeVarTuple `_Ts` + +ℹ Unsafe fix +4 4 | from typing_extensions import ParamSpec, TypeVarTuple +5 5 | +6 6 | _T = typing.TypeVar("_T") +7 |-_Ts = typing_extensions.TypeVarTuple("_Ts") +8 7 | _P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") -PYI018.py:8:1: PYI018 Private ParamSpec `_P` is never used +PYI018.py:8:1: PYI018 [*] Private ParamSpec `_P` is never used | 6 | _T = typing.TypeVar("_T") 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") @@ -29,8 +49,18 @@ PYI018.py:8:1: PYI018 Private ParamSpec `_P` is never used 9 | _P2 = typing.ParamSpec("_P2") 10 | _Ts2 = TypeVarTuple("_Ts2") | + = help: Remove unused private ParamSpec `_P` + +ℹ Unsafe fix +5 5 | +6 6 | _T = typing.TypeVar("_T") +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 |-_P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") +11 10 | -PYI018.py:9:1: PYI018 Private ParamSpec `_P2` is never used +PYI018.py:9:1: PYI018 [*] Private ParamSpec `_P2` is never used | 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") 8 | _P = ParamSpec("_P") @@ -38,15 +68,33 @@ PYI018.py:9:1: PYI018 Private ParamSpec `_P2` is never used | ^^^ PYI018 10 | _Ts2 = TypeVarTuple("_Ts2") | + = help: Remove unused private ParamSpec `_P2` -PYI018.py:10:1: PYI018 Private TypeVarTuple `_Ts2` is never used +ℹ Unsafe fix +6 6 | _T = typing.TypeVar("_T") +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 8 | _P = ParamSpec("_P") +9 |-_P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") +11 10 | +12 11 | # OK + +PYI018.py:10:1: PYI018 [*] Private TypeVarTuple `_Ts2` is never used | 8 | _P = ParamSpec("_P") 9 | _P2 = typing.ParamSpec("_P2") 10 | _Ts2 = TypeVarTuple("_Ts2") | ^^^^ PYI018 -11 | +11 | 12 | # OK | + = help: Remove unused private TypeVarTuple `_Ts2` - +ℹ Unsafe fix +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 8 | _P = ParamSpec("_P") +9 9 | _P2 = typing.ParamSpec("_P2") +10 |-_Ts2 = TypeVarTuple("_Ts2") +11 10 | +12 11 | # OK +13 12 | _UsedTypeVar = TypeVar("_UsedTypeVar") diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.pyi.snap index 4585ae25babeb..a7913fbfa888e 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI018_PYI018.pyi.snap @@ -1,17 +1,27 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI018.pyi:6:1: PYI018 Private TypeVar `_T` is never used +PYI018.pyi:6:1: PYI018 [*] Private TypeVar `_T` is never used | 4 | from typing_extensions import ParamSpec, TypeVarTuple -5 | +5 | 6 | _T = typing.TypeVar("_T") | ^^ PYI018 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") 8 | _P = ParamSpec("_P") | + = help: Remove unused private TypeVar `_T` -PYI018.pyi:7:1: PYI018 Private TypeVarTuple `_Ts` is never used +ℹ Unsafe fix +3 3 | from typing import TypeVar +4 4 | from typing_extensions import ParamSpec, TypeVarTuple +5 5 | +6 |-_T = typing.TypeVar("_T") +7 6 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 7 | _P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") + +PYI018.pyi:7:1: PYI018 [*] Private TypeVarTuple `_Ts` is never used | 6 | _T = typing.TypeVar("_T") 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") @@ -19,8 +29,18 @@ PYI018.pyi:7:1: PYI018 Private TypeVarTuple `_Ts` is never used 8 | _P = ParamSpec("_P") 9 | _P2 = typing.ParamSpec("_P2") | + = help: Remove unused private TypeVarTuple `_Ts` + +ℹ Unsafe fix +4 4 | from typing_extensions import ParamSpec, TypeVarTuple +5 5 | +6 6 | _T = typing.TypeVar("_T") +7 |-_Ts = typing_extensions.TypeVarTuple("_Ts") +8 7 | _P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") -PYI018.pyi:8:1: PYI018 Private ParamSpec `_P` is never used +PYI018.pyi:8:1: PYI018 [*] Private ParamSpec `_P` is never used | 6 | _T = typing.TypeVar("_T") 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") @@ -29,8 +49,18 @@ PYI018.pyi:8:1: PYI018 Private ParamSpec `_P` is never used 9 | _P2 = typing.ParamSpec("_P2") 10 | _Ts2 = TypeVarTuple("_Ts2") | + = help: Remove unused private ParamSpec `_P` + +ℹ Unsafe fix +5 5 | +6 6 | _T = typing.TypeVar("_T") +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 |-_P = ParamSpec("_P") +9 8 | _P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") +11 10 | -PYI018.pyi:9:1: PYI018 Private ParamSpec `_P2` is never used +PYI018.pyi:9:1: PYI018 [*] Private ParamSpec `_P2` is never used | 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") 8 | _P = ParamSpec("_P") @@ -38,15 +68,33 @@ PYI018.pyi:9:1: PYI018 Private ParamSpec `_P2` is never used | ^^^ PYI018 10 | _Ts2 = TypeVarTuple("_Ts2") | + = help: Remove unused private ParamSpec `_P2` -PYI018.pyi:10:1: PYI018 Private TypeVarTuple `_Ts2` is never used +ℹ Unsafe fix +6 6 | _T = typing.TypeVar("_T") +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 8 | _P = ParamSpec("_P") +9 |-_P2 = typing.ParamSpec("_P2") +10 9 | _Ts2 = TypeVarTuple("_Ts2") +11 10 | +12 11 | # OK + +PYI018.pyi:10:1: PYI018 [*] Private TypeVarTuple `_Ts2` is never used | 8 | _P = ParamSpec("_P") 9 | _P2 = typing.ParamSpec("_P2") 10 | _Ts2 = TypeVarTuple("_Ts2") | ^^^^ PYI018 -11 | +11 | 12 | # OK | + = help: Remove unused private TypeVarTuple `_Ts2` - +ℹ Unsafe fix +7 7 | _Ts = typing_extensions.TypeVarTuple("_Ts") +8 8 | _P = ParamSpec("_P") +9 9 | _P2 = typing.ParamSpec("_P2") +10 |-_Ts2 = TypeVarTuple("_Ts2") +11 10 | +12 11 | # OK +13 12 | _UsedTypeVar = TypeVar("_UsedTypeVar") diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.py.snap deleted file mode 100644 index eaa6a4bcc533b..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.py.snap +++ /dev/null @@ -1,51 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs ---- -PYI019.py:7:62: PYI019 Methods like `__new__` should return `typing.Self` instead of a custom `TypeVar` - | -6 | class BadClass: -7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.py:10:54: PYI019 Methods like `bad_instance_method` should return `typing.Self` instead of a custom `TypeVar` - | -10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.py:14:54: PYI019 Methods like `bad_class_method` should return `typing.Self` instead of a custom `TypeVar` - | -13 | @classmethod -14 | def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.py:18:55: PYI019 Methods like `bad_posonly_class_method` should return `typing.Self` instead of a custom `TypeVar` - | -17 | @classmethod -18 | def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.py:39:63: PYI019 Methods like `__new__` should return `typing.Self` instead of a custom `TypeVar` - | -37 | # Python > 3.12 -38 | class PEP695BadDunderNew[T]: -39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 - | ^ PYI019 - | - -PYI019.py:42:46: PYI019 Methods like `generic_instance_method` should return `typing.Self` instead of a custom `TypeVar` - | -42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 - | ^ PYI019 - | - -PYI019.py:54:32: PYI019 Methods like `foo` should return `typing.Self` instead of a custom `TypeVar` - | -52 | # in the settings for this test: -53 | @foo_classmethod -54 | def foo[S](cls: type[S]) -> S: ... # PYI019 - | ^ PYI019 - | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.pyi.snap deleted file mode 100644 index b3ddd0801d1f1..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019.pyi.snap +++ /dev/null @@ -1,51 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs ---- -PYI019.pyi:7:62: PYI019 Methods like `__new__` should return `typing.Self` instead of a custom `TypeVar` - | -6 | class BadClass: -7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.pyi:10:54: PYI019 Methods like `bad_instance_method` should return `typing.Self` instead of a custom `TypeVar` - | -10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.pyi:14:54: PYI019 Methods like `bad_class_method` should return `typing.Self` instead of a custom `TypeVar` - | -13 | @classmethod -14 | def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.pyi:18:55: PYI019 Methods like `bad_posonly_class_method` should return `typing.Self` instead of a custom `TypeVar` - | -17 | @classmethod -18 | def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 - | ^^ PYI019 - | - -PYI019.pyi:39:63: PYI019 Methods like `__new__` should return `typing.Self` instead of a custom `TypeVar` - | -37 | # Python > 3.12 -38 | class PEP695BadDunderNew[T]: -39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 - | ^ PYI019 - | - -PYI019.pyi:42:46: PYI019 Methods like `generic_instance_method` should return `typing.Self` instead of a custom `TypeVar` - | -42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 - | ^ PYI019 - | - -PYI019.pyi:54:32: PYI019 Methods like `foo` should return `typing.Self` instead of a custom `TypeVar` - | -52 | # in the settings for this test: -53 | @foo_classmethod -54 | def foo[S](cls: type[S]) -> S: ... # PYI019 - | ^ PYI019 - | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.py.snap new file mode 100644 index 0000000000000..1bbfbef8e2c36 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.py.snap @@ -0,0 +1,692 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI019_0.py:7:16: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +6 | class BadClass: +7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +4 4 | _S2 = TypeVar("_S2", BadClass, GoodClass) +5 5 | +6 6 | class BadClass: +7 |- def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + 7 |+ def __new__(cls, *args: str, **kwargs: int) -> Self: ... # PYI019 +8 8 | +9 9 | +10 10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + +PYI019_0.py:10:28: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +7 7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 +8 8 | +9 9 | +10 |- def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + 10 |+ def bad_instance_method(self, arg: bytes) -> Self: ... # PYI019 +11 11 | +12 12 | +13 13 | @classmethod + +PYI019_0.py:14:25: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +13 | @classmethod +14 | def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +11 11 | +12 12 | +13 13 | @classmethod +14 |- def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + 14 |+ def bad_class_method(cls, arg: int) -> Self: ... # PYI019 +15 15 | +16 16 | +17 17 | @classmethod + +PYI019_0.py:18:33: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +17 | @classmethod +18 | def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +15 15 | +16 16 | +17 17 | @classmethod +18 |- def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + 18 |+ def bad_posonly_class_method(cls, /) -> Self: ... # PYI019 +19 19 | +20 20 | +21 21 | @classmethod + +PYI019_0.py:39:14: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +37 | # Python > 3.12 +38 | class PEP695BadDunderNew[T]: +39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +36 36 | +37 37 | # Python > 3.12 +38 38 | class PEP695BadDunderNew[T]: +39 |- def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + 39 |+ def __new__(cls, *args: Any, ** kwargs: Any) -> Self: ... # PYI019 +40 40 | +41 41 | +42 42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 + +PYI019_0.py:42:30: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +39 39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 +40 40 | +41 41 | +42 |- def generic_instance_method[S](self: S) -> S: ... # PYI019 + 42 |+ def generic_instance_method(self) -> Self: ... # PYI019 +43 43 | +44 44 | +45 45 | class PEP695GoodDunderNew[T]: + +PYI019_0.py:54:11: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +52 | # in the settings for this test: +53 | @foo_classmethod +54 | def foo[S](cls: type[S]) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +51 51 | # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` +52 52 | # in the settings for this test: +53 53 | @foo_classmethod +54 |- def foo[S](cls: type[S]) -> S: ... # PYI019 + 54 |+ def foo(cls) -> Self: ... # PYI019 +55 55 | +56 56 | +57 57 | _S695 = TypeVar("_S695", bound="PEP695Fix") + +PYI019_0.py:61:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +60 | class PEP695Fix: +61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +62 | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +58 58 | +59 59 | +60 60 | class PEP695Fix: +61 |- def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + 61 |+ def __new__(cls) -> Self: ... +62 62 | +63 63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 64 | + +PYI019_0.py:63:26: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... +62 | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +64 | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +60 60 | class PEP695Fix: +61 61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... +62 62 | +63 |- def __init_subclass__[S](cls: type[S]) -> S: ... + 63 |+ def __init_subclass__(cls) -> Self: ... +64 64 | +65 65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 66 | + +PYI019_0.py:65:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +66 | +67 | def __pos__[S](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +62 62 | +63 63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 64 | +65 |- def __neg__[S: PEP695Fix](self: S) -> S: ... + 65 |+ def __neg__(self) -> Self: ... +66 66 | +67 67 | def __pos__[S](self: S) -> S: ... +68 68 | + +PYI019_0.py:67:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 | +67 | def __pos__[S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^ PYI019 +68 | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +64 64 | +65 65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 66 | +67 |- def __pos__[S](self: S) -> S: ... + 67 |+ def __pos__(self) -> Self: ... +68 68 | +69 69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 70 | + +PYI019_0.py:69:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +67 | def __pos__[S](self: S) -> S: ... +68 | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +70 | +71 | def __sub__[S](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +66 66 | +67 67 | def __pos__[S](self: S) -> S: ... +68 68 | +69 |- def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + 69 |+ def __add__(self, other: Self) -> Self: ... +70 70 | +71 71 | def __sub__[S](self: S, other: S) -> S: ... +72 72 | + +PYI019_0.py:71:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 | +71 | def __sub__[S](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +72 | +73 | @classmethod + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +68 68 | +69 69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 70 | +71 |- def __sub__[S](self: S, other: S) -> S: ... + 71 |+ def __sub__(self, other: Self) -> Self: ... +72 72 | +73 73 | @classmethod +74 74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + +PYI019_0.py:74:27: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +73 | @classmethod +74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +75 | +76 | @classmethod + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +71 71 | def __sub__[S](self: S, other: S) -> S: ... +72 72 | +73 73 | @classmethod +74 |- def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + 74 |+ def class_method_bound(cls) -> Self: ... +75 75 | +76 76 | @classmethod +77 77 | def class_method_unbound[S](cls: type[S]) -> S: ... + +PYI019_0.py:77:29: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +76 | @classmethod +77 | def class_method_unbound[S](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +78 | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +74 74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... +75 75 | +76 76 | @classmethod +77 |- def class_method_unbound[S](cls: type[S]) -> S: ... + 77 |+ def class_method_unbound(cls) -> Self: ... +78 78 | +79 79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 80 | + +PYI019_0.py:79:30: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +77 | def class_method_unbound[S](cls: type[S]) -> S: ... +78 | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +80 | +81 | def instance_method_unbound[S](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +76 76 | @classmethod +77 77 | def class_method_unbound[S](cls: type[S]) -> S: ... +78 78 | +79 |- def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + 79 |+ def instance_method_bound(self) -> Self: ... +80 80 | +81 81 | def instance_method_unbound[S](self: S) -> S: ... +82 82 | + +PYI019_0.py:81:32: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 | +81 | def instance_method_unbound[S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^ PYI019 +82 | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +78 78 | +79 79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 80 | +81 |- def instance_method_unbound[S](self: S) -> S: ... + 81 |+ def instance_method_unbound(self) -> Self: ... +82 82 | +83 83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 84 | + +PYI019_0.py:83:53: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +81 | def instance_method_unbound[S](self: S) -> S: ... +82 | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +84 | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +80 80 | +81 81 | def instance_method_unbound[S](self: S) -> S: ... +82 82 | +83 |- def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + 83 |+ def instance_method_bound_with_another_parameter(self, other: Self) -> Self: ... +84 84 | +85 85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 86 | + +PYI019_0.py:85:55: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +86 | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +82 82 | +83 83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 84 | +85 |- def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + 85 |+ def instance_method_unbound_with_another_parameter(self, other: Self) -> Self: ... +86 86 | +87 87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 88 | + +PYI019_0.py:87:27: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +88 | +89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +84 84 | +85 85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 86 | +87 |- def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + 87 |+ def multiple_type_vars[*Ts, T](self, other: Self, /, *args: *Ts, a: T, b: list[T]) -> Self: ... +88 88 | +89 89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... +90 90 | + +PYI019_0.py:89:43: PYI019 [*] Use `Self` instead of custom TypeVar `_S695` + | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 | +89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S695` with `Self` + +ℹ Safe fix +86 86 | +87 87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 88 | +89 |- def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + 89 |+ def mixing_old_and_new_style_type_vars[T](self, a: T, b: T) -> Self: ... +90 90 | +91 91 | +92 92 | class InvalidButWeDoNotPanic: + +PYI019_0.py:94:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +92 | class InvalidButWeDoNotPanic: +93 | @classmethod +94 | def m[S](cls: type[S], /) -> S[int]: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +95 | def n(self: S) -> S[int]: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +91 91 | +92 92 | class InvalidButWeDoNotPanic: +93 93 | @classmethod +94 |- def m[S](cls: type[S], /) -> S[int]: ... + 94 |+ def m(cls, /) -> Self[int]: ... +95 95 | def n(self: S) -> S[int]: ... +96 96 | +97 97 | + +PYI019_0.py:114:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +112 | class SubscriptReturnType: +113 | @classmethod +114 | def m[S](cls: type[S]) -> type[S]: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +111 111 | +112 112 | class SubscriptReturnType: +113 113 | @classmethod +114 |- def m[S](cls: type[S]) -> type[S]: ... # PYI019 + 114 |+ def m(cls) -> type[Self]: ... # PYI019 +115 115 | +116 116 | +117 117 | class SelfNotUsedInReturnAnnotation: + +PYI019_0.py:118:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +117 | class SelfNotUsedInReturnAnnotation: +118 | def m[S](self: S, other: S) -> int: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +119 | @classmethod +120 | def n[S](cls: type[S], other: S) -> int: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +115 115 | +116 116 | +117 117 | class SelfNotUsedInReturnAnnotation: +118 |- def m[S](self: S, other: S) -> int: ... + 118 |+ def m(self, other: Self) -> int: ... +119 119 | @classmethod +120 120 | def n[S](cls: type[S], other: S) -> int: ... +121 121 | + +PYI019_0.py:120:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +118 | def m[S](self: S, other: S) -> int: ... +119 | @classmethod +120 | def n[S](cls: type[S], other: S) -> int: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +117 117 | class SelfNotUsedInReturnAnnotation: +118 118 | def m[S](self: S, other: S) -> int: ... +119 119 | @classmethod +120 |- def n[S](cls: type[S], other: S) -> int: ... + 120 |+ def n(cls, other: Self) -> int: ... +121 121 | +122 122 | +123 123 | class _NotATypeVar: ... + +PYI019_0.py:135:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +134 | class NoReturnAnnotations: +135 | def m[S](self: S, other: S): ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +136 | @classmethod +137 | def n[S](cls: type[S], other: S): ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +132 132 | +133 133 | +134 134 | class NoReturnAnnotations: +135 |- def m[S](self: S, other: S): ... + 135 |+ def m(self, other: Self): ... +136 136 | @classmethod +137 137 | def n[S](cls: type[S], other: S): ... +138 138 | + +PYI019_0.py:137:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +135 | def m[S](self: S, other: S): ... +136 | @classmethod +137 | def n[S](cls: type[S], other: S): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +138 | +139 | class MultipleBoundParameters: + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +134 134 | class NoReturnAnnotations: +135 135 | def m[S](self: S, other: S): ... +136 136 | @classmethod +137 |- def n[S](cls: type[S], other: S): ... + 137 |+ def n(cls, other: Self): ... +138 138 | +139 139 | class MultipleBoundParameters: +140 140 | def m[S: int, T: int](self: S, other: T) -> S: ... + +PYI019_0.py:140:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +139 | class MultipleBoundParameters: +140 | def m[S: int, T: int](self: S, other: T) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +141 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +137 137 | def n[S](cls: type[S], other: S): ... +138 138 | +139 139 | class MultipleBoundParameters: +140 |- def m[S: int, T: int](self: S, other: T) -> S: ... + 140 |+ def m[T: int](self, other: T) -> Self: ... +141 141 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... +142 142 | +143 143 | class MethodsWithBody: + +PYI019_0.py:141:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +139 | class MultipleBoundParameters: +140 | def m[S: int, T: int](self: S, other: T) -> S: ... +141 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +142 | +143 | class MethodsWithBody: + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +138 138 | +139 139 | class MultipleBoundParameters: +140 140 | def m[S: int, T: int](self: S, other: T) -> S: ... +141 |- def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + 141 |+ def n[T: (int, str)](self, other: T) -> Self: ... +142 142 | +143 143 | class MethodsWithBody: +144 144 | def m[S](self: S, other: S) -> S: + +PYI019_0.py:144:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +143 | class MethodsWithBody: +144 | def m[S](self: S, other: S) -> S: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +145 | x: S = other +146 | return x + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +141 141 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... +142 142 | +143 143 | class MethodsWithBody: +144 |- def m[S](self: S, other: S) -> S: +145 |- x: S = other + 144 |+ def m(self, other: Self) -> Self: + 145 |+ x: Self = other +146 146 | return x +147 147 | +148 148 | @classmethod + +PYI019_0.py:149:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +148 | @classmethod +149 | def n[S](cls: type[S], other: S) -> S: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +150 | x: type[S] = type(other) +151 | return x() + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +146 146 | return x +147 147 | +148 148 | @classmethod +149 |- def n[S](cls: type[S], other: S) -> S: +150 |- x: type[S] = type(other) + 149 |+ def n(cls, other: Self) -> Self: + 150 |+ x: type[Self] = type(other) +151 151 | return x() +152 152 | +153 153 | class StringizedReferencesCanBeFixed: + +PYI019_0.py:154:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +153 | class StringizedReferencesCanBeFixed: +154 | def m[S](self: S) -> S: + | ^^^^^^^^^^^^^^^^^ PYI019 +155 | x = cast("list[tuple[S, S]]", self) +156 | return x + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +151 151 | return x() +152 152 | +153 153 | class StringizedReferencesCanBeFixed: +154 |- def m[S](self: S) -> S: +155 |- x = cast("list[tuple[S, S]]", self) + 154 |+ def m(self) -> Self: + 155 |+ x = cast("list[tuple[Self, Self]]", self) +156 156 | return x +157 157 | +158 158 | class ButStrangeStringizedReferencesCannotBeFixed: + +PYI019_0.py:159:10: PYI019 Use `Self` instead of custom TypeVar `_T` + | +158 | class ButStrangeStringizedReferencesCannotBeFixed: +159 | def m[_T](self: _T) -> _T: + | ^^^^^^^^^^^^^^^^^^^^ PYI019 +160 | x = cast('list[_\x54]', self) +161 | return x + | + = help: Replace TypeVar `_T` with `Self` + +PYI019_0.py:164:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +163 | class DeletionsAreNotTouched: +164 | def m[S](self: S) -> S: + | ^^^^^^^^^^^^^^^^^ PYI019 +165 | # `S` is not a local variable here, and `del` can only be used with local variables, +166 | # so `del S` here is not actually a reference to the type variable `S`. + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +161 161 | return x +162 162 | +163 163 | class DeletionsAreNotTouched: +164 |- def m[S](self: S) -> S: + 164 |+ def m(self) -> Self: +165 165 | # `S` is not a local variable here, and `del` can only be used with local variables, +166 166 | # so `del S` here is not actually a reference to the type variable `S`. +167 167 | # This `del` statement is therefore not touched by the autofix (it raises `UnboundLocalError` + +PYI019_0.py:173:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +172 | class NamesShadowingTypeVarAreNotTouched: +173 | def m[S](self: S) -> S: + | ^^^^^^^^^^^^^^^^^ PYI019 +174 | type S = int +175 | print(S) # not a reference to the type variable, so not touched by the autofix + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +170 170 | return self +171 171 | +172 172 | class NamesShadowingTypeVarAreNotTouched: +173 |- def m[S](self: S) -> S: + 173 |+ def m(self) -> Self: +174 174 | type S = int +175 175 | print(S) # not a reference to the type variable, so not touched by the autofix +176 176 | return 42 diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.pyi.snap new file mode 100644 index 0000000000000..7c5b794bd5621 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_0.pyi.snap @@ -0,0 +1,684 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI019_0.pyi:7:16: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +6 | class BadClass: +7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +4 4 | _S2 = TypeVar("_S2", BadClass, GoodClass) +5 5 | +6 6 | class BadClass: +7 |- def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 + 7 |+ def __new__(cls, *args: str, **kwargs: int) -> Self: ... # PYI019 +8 8 | +9 9 | +10 10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + +PYI019_0.pyi:10:28: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +10 | def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +7 7 | def __new__(cls: type[_S], *args: str, **kwargs: int) -> _S: ... # PYI019 +8 8 | +9 9 | +10 |- def bad_instance_method(self: _S, arg: bytes) -> _S: ... # PYI019 + 10 |+ def bad_instance_method(self, arg: bytes) -> Self: ... # PYI019 +11 11 | +12 12 | +13 13 | @classmethod + +PYI019_0.pyi:14:25: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +13 | @classmethod +14 | def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +11 11 | +12 12 | +13 13 | @classmethod +14 |- def bad_class_method(cls: type[_S], arg: int) -> _S: ... # PYI019 + 14 |+ def bad_class_method(cls, arg: int) -> Self: ... # PYI019 +15 15 | +16 16 | +17 17 | @classmethod + +PYI019_0.pyi:18:33: PYI019 [*] Use `Self` instead of custom TypeVar `_S` + | +17 | @classmethod +18 | def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S` with `Self` + +ℹ Safe fix +15 15 | +16 16 | +17 17 | @classmethod +18 |- def bad_posonly_class_method(cls: type[_S], /) -> _S: ... # PYI019 + 18 |+ def bad_posonly_class_method(cls, /) -> Self: ... # PYI019 +19 19 | +20 20 | +21 21 | @classmethod + +PYI019_0.pyi:39:14: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +37 | # Python > 3.12 +38 | class PEP695BadDunderNew[T]: +39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +36 36 | +37 37 | # Python > 3.12 +38 38 | class PEP695BadDunderNew[T]: +39 |- def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 + 39 |+ def __new__(cls, *args: Any, ** kwargs: Any) -> Self: ... # PYI019 +40 40 | +41 41 | +42 42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 + +PYI019_0.pyi:42:30: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +42 | def generic_instance_method[S](self: S) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +39 39 | def __new__[S](cls: type[S], *args: Any, ** kwargs: Any) -> S: ... # PYI019 +40 40 | +41 41 | +42 |- def generic_instance_method[S](self: S) -> S: ... # PYI019 + 42 |+ def generic_instance_method(self) -> Self: ... # PYI019 +43 43 | +44 44 | +45 45 | class PEP695GoodDunderNew[T]: + +PYI019_0.pyi:54:11: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +52 | # in the settings for this test: +53 | @foo_classmethod +54 | def foo[S](cls: type[S]) -> S: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +51 51 | # due to `foo_classmethod being listed in `pep8_naming.classmethod-decorators` +52 52 | # in the settings for this test: +53 53 | @foo_classmethod +54 |- def foo[S](cls: type[S]) -> S: ... # PYI019 + 54 |+ def foo(cls) -> Self: ... # PYI019 +55 55 | +56 56 | +57 57 | _S695 = TypeVar("_S695", bound="PEP695Fix") + +PYI019_0.pyi:61:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +60 | class PEP695Fix: +61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +62 | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +58 58 | +59 59 | +60 60 | class PEP695Fix: +61 |- def __new__[S: PEP695Fix](cls: type[S]) -> S: ... + 61 |+ def __new__(cls) -> Self: ... +62 62 | +63 63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 64 | + +PYI019_0.pyi:63:26: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... +62 | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +64 | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +60 60 | class PEP695Fix: +61 61 | def __new__[S: PEP695Fix](cls: type[S]) -> S: ... +62 62 | +63 |- def __init_subclass__[S](cls: type[S]) -> S: ... + 63 |+ def __init_subclass__(cls) -> Self: ... +64 64 | +65 65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 66 | + +PYI019_0.pyi:65:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +66 | +67 | def __pos__[S](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +62 62 | +63 63 | def __init_subclass__[S](cls: type[S]) -> S: ... +64 64 | +65 |- def __neg__[S: PEP695Fix](self: S) -> S: ... + 65 |+ def __neg__(self) -> Self: ... +66 66 | +67 67 | def __pos__[S](self: S) -> S: ... +68 68 | + +PYI019_0.pyi:67:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 | +67 | def __pos__[S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^ PYI019 +68 | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +64 64 | +65 65 | def __neg__[S: PEP695Fix](self: S) -> S: ... +66 66 | +67 |- def __pos__[S](self: S) -> S: ... + 67 |+ def __pos__(self) -> Self: ... +68 68 | +69 69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 70 | + +PYI019_0.pyi:69:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +67 | def __pos__[S](self: S) -> S: ... +68 | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +70 | +71 | def __sub__[S](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +66 66 | +67 67 | def __pos__[S](self: S) -> S: ... +68 68 | +69 |- def __add__[S: PEP695Fix](self: S, other: S) -> S: ... + 69 |+ def __add__(self, other: Self) -> Self: ... +70 70 | +71 71 | def __sub__[S](self: S, other: S) -> S: ... +72 72 | + +PYI019_0.pyi:71:16: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 | +71 | def __sub__[S](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +72 | +73 | @classmethod + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +68 68 | +69 69 | def __add__[S: PEP695Fix](self: S, other: S) -> S: ... +70 70 | +71 |- def __sub__[S](self: S, other: S) -> S: ... + 71 |+ def __sub__(self, other: Self) -> Self: ... +72 72 | +73 73 | @classmethod +74 74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + +PYI019_0.pyi:74:27: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +73 | @classmethod +74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +75 | +76 | @classmethod + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +71 71 | def __sub__[S](self: S, other: S) -> S: ... +72 72 | +73 73 | @classmethod +74 |- def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... + 74 |+ def class_method_bound(cls) -> Self: ... +75 75 | +76 76 | @classmethod +77 77 | def class_method_unbound[S](cls: type[S]) -> S: ... + +PYI019_0.pyi:77:29: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +76 | @classmethod +77 | def class_method_unbound[S](cls: type[S]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +78 | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +74 74 | def class_method_bound[S: PEP695Fix](cls: type[S]) -> S: ... +75 75 | +76 76 | @classmethod +77 |- def class_method_unbound[S](cls: type[S]) -> S: ... + 77 |+ def class_method_unbound(cls) -> Self: ... +78 78 | +79 79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 80 | + +PYI019_0.pyi:79:30: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +77 | def class_method_unbound[S](cls: type[S]) -> S: ... +78 | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +80 | +81 | def instance_method_unbound[S](self: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +76 76 | @classmethod +77 77 | def class_method_unbound[S](cls: type[S]) -> S: ... +78 78 | +79 |- def instance_method_bound[S: PEP695Fix](self: S) -> S: ... + 79 |+ def instance_method_bound(self) -> Self: ... +80 80 | +81 81 | def instance_method_unbound[S](self: S) -> S: ... +82 82 | + +PYI019_0.pyi:81:32: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 | +81 | def instance_method_unbound[S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^ PYI019 +82 | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +78 78 | +79 79 | def instance_method_bound[S: PEP695Fix](self: S) -> S: ... +80 80 | +81 |- def instance_method_unbound[S](self: S) -> S: ... + 81 |+ def instance_method_unbound(self) -> Self: ... +82 82 | +83 83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 84 | + +PYI019_0.pyi:83:53: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +81 | def instance_method_unbound[S](self: S) -> S: ... +82 | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +84 | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +80 80 | +81 81 | def instance_method_unbound[S](self: S) -> S: ... +82 82 | +83 |- def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... + 83 |+ def instance_method_bound_with_another_parameter(self, other: Self) -> Self: ... +84 84 | +85 85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 86 | + +PYI019_0.pyi:85:55: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +86 | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +82 82 | +83 83 | def instance_method_bound_with_another_parameter[S: PEP695Fix](self: S, other: S) -> S: ... +84 84 | +85 |- def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... + 85 |+ def instance_method_unbound_with_another_parameter(self, other: Self) -> Self: ... +86 86 | +87 87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 88 | + +PYI019_0.pyi:87:27: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +88 | +89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +84 84 | +85 85 | def instance_method_unbound_with_another_parameter[S](self: S, other: S) -> S: ... +86 86 | +87 |- def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... + 87 |+ def multiple_type_vars[*Ts, T](self, other: Self, /, *args: *Ts, a: T, b: list[T]) -> Self: ... +88 88 | +89 89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... +90 90 | + +PYI019_0.pyi:89:43: PYI019 [*] Use `Self` instead of custom TypeVar `_S695` + | +87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 | +89 | def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `_S695` with `Self` + +ℹ Safe fix +86 86 | +87 87 | def multiple_type_vars[S, *Ts, T](self: S, other: S, /, *args: *Ts, a: T, b: list[T]) -> S: ... +88 88 | +89 |- def mixing_old_and_new_style_type_vars[T](self: _S695, a: T, b: T) -> _S695: ... + 89 |+ def mixing_old_and_new_style_type_vars[T](self, a: T, b: T) -> Self: ... +90 90 | +91 91 | +92 92 | class InvalidButWeDoNotPanic: + +PYI019_0.pyi:94:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +92 | class InvalidButWeDoNotPanic: +93 | @classmethod +94 | def m[S](cls: type[S], /) -> S[int]: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +95 | def n(self: S) -> S[int]: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +91 91 | +92 92 | class InvalidButWeDoNotPanic: +93 93 | @classmethod +94 |- def m[S](cls: type[S], /) -> S[int]: ... + 94 |+ def m(cls, /) -> Self[int]: ... +95 95 | def n(self: S) -> S[int]: ... +96 96 | +97 97 | + +PYI019_0.pyi:114:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +112 | class SubscriptReturnType: +113 | @classmethod +114 | def m[S](cls: type[S]) -> type[S]: ... # PYI019 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +111 111 | +112 112 | class SubscriptReturnType: +113 113 | @classmethod +114 |- def m[S](cls: type[S]) -> type[S]: ... # PYI019 + 114 |+ def m(cls) -> type[Self]: ... # PYI019 +115 115 | +116 116 | +117 117 | class PEP695TypeParameterAtTheVeryEndOfTheList: + +PYI019_0.pyi:118:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +117 | class PEP695TypeParameterAtTheVeryEndOfTheList: +118 | def f[T, S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +115 115 | +116 116 | +117 117 | class PEP695TypeParameterAtTheVeryEndOfTheList: +118 |- def f[T, S](self: S) -> S: ... + 118 |+ def f[T](self) -> Self: ... +119 119 | +120 120 | +121 121 | class PEP695Again: + +PYI019_0.pyi:122:26: PYI019 [*] Use `Self` instead of custom TypeVar `_S695` + | +121 | class PEP695Again: +122 | def mixing_and_nested[T](self: _S695, a: list[_S695], b: dict[_S695, str | T | set[_S695]]) -> _S695: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +123 | def also_uses_s695_but_should_not_be_edited(self, v: set[tuple[_S695]]) -> _S695: ... + | + = help: Replace TypeVar `_S695` with `Self` + +ℹ Safe fix +119 119 | +120 120 | +121 121 | class PEP695Again: +122 |- def mixing_and_nested[T](self: _S695, a: list[_S695], b: dict[_S695, str | T | set[_S695]]) -> _S695: ... + 122 |+ def mixing_and_nested[T](self, a: list[Self], b: dict[Self, str | T | set[Self]]) -> Self: ... +123 123 | def also_uses_s695_but_should_not_be_edited(self, v: set[tuple[_S695]]) -> _S695: ... +124 124 | +125 125 | @classmethod + +PYI019_0.pyi:126:29: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +125 | @classmethod +126 | def comment_in_fix_range[T, S]( + | _____________________________^ +127 | | cls: type[ # Lorem ipsum +128 | | S +129 | | ], +130 | | a: T, +131 | | b: tuple[S, T] +132 | | ) -> S: ... + | |__________^ PYI019 +133 | +134 | def comment_outside_fix_range[T, S]( + | + = help: Replace TypeVar `S` with `Self` + +ℹ Unsafe fix +123 123 | def also_uses_s695_but_should_not_be_edited(self, v: set[tuple[_S695]]) -> _S695: ... +124 124 | +125 125 | @classmethod +126 |- def comment_in_fix_range[T, S]( +127 |- cls: type[ # Lorem ipsum +128 |- S +129 |- ], + 126 |+ def comment_in_fix_range[T]( + 127 |+ cls, +130 128 | a: T, +131 |- b: tuple[S, T] +132 |- ) -> S: ... + 129 |+ b: tuple[Self, T] + 130 |+ ) -> Self: ... +133 131 | +134 132 | def comment_outside_fix_range[T, S]( +135 133 | self: S, + +PYI019_0.pyi:134:34: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +132 | ) -> S: ... +133 | +134 | def comment_outside_fix_range[T, S]( + | __________________________________^ +135 | | self: S, +136 | | a: T, +137 | | b: tuple[ +138 | | # Lorem ipsum +139 | | S, T +140 | | ] +141 | | ) -> S: ... + | |__________^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +131 131 | b: tuple[S, T] +132 132 | ) -> S: ... +133 133 | +134 |- def comment_outside_fix_range[T, S]( +135 |- self: S, + 134 |+ def comment_outside_fix_range[T]( + 135 |+ self, +136 136 | a: T, +137 137 | b: tuple[ +138 138 | # Lorem ipsum +139 |- S, T + 139 |+ Self, T +140 140 | ] +141 |- ) -> S: ... + 141 |+ ) -> Self: ... +142 142 | +143 143 | +144 144 | class SelfNotUsedInReturnAnnotation: + +PYI019_0.pyi:145:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +144 | class SelfNotUsedInReturnAnnotation: +145 | def m[S](self: S, other: S) -> int: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +146 | @classmethod +147 | def n[S](cls: type[S], other: S) -> int: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +142 142 | +143 143 | +144 144 | class SelfNotUsedInReturnAnnotation: +145 |- def m[S](self: S, other: S) -> int: ... + 145 |+ def m(self, other: Self) -> int: ... +146 146 | @classmethod +147 147 | def n[S](cls: type[S], other: S) -> int: ... +148 148 | + +PYI019_0.pyi:147:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +145 | def m[S](self: S, other: S) -> int: ... +146 | @classmethod +147 | def n[S](cls: type[S], other: S) -> int: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +144 144 | class SelfNotUsedInReturnAnnotation: +145 145 | def m[S](self: S, other: S) -> int: ... +146 146 | @classmethod +147 |- def n[S](cls: type[S], other: S) -> int: ... + 147 |+ def n(cls, other: Self) -> int: ... +148 148 | +149 149 | +150 150 | class _NotATypeVar: ... + +PYI019_0.pyi:161:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +160 | class NoReturnAnnotations: +161 | def m[S](self: S, other: S): ... + | ^^^^^^^^^^^^^^^^^^^^^^ PYI019 +162 | @classmethod +163 | def n[S](cls: type[S], other: S): ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +158 158 | def y(self: type[_NotATypeVar]) -> _NotATypeVar: ... +159 159 | +160 160 | class NoReturnAnnotations: +161 |- def m[S](self: S, other: S): ... + 161 |+ def m(self, other: Self): ... +162 162 | @classmethod +163 163 | def n[S](cls: type[S], other: S): ... +164 164 | + +PYI019_0.pyi:163:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +161 | def m[S](self: S, other: S): ... +162 | @classmethod +163 | def n[S](cls: type[S], other: S): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +164 | +165 | class MultipleBoundParameters: + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +160 160 | class NoReturnAnnotations: +161 161 | def m[S](self: S, other: S): ... +162 162 | @classmethod +163 |- def n[S](cls: type[S], other: S): ... + 163 |+ def n(cls, other: Self): ... +164 164 | +165 165 | class MultipleBoundParameters: +166 166 | def m[S: int, T: int](self: S, other: T) -> S: ... + +PYI019_0.pyi:166:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +165 | class MultipleBoundParameters: +166 | def m[S: int, T: int](self: S, other: T) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 +167 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +163 163 | def n[S](cls: type[S], other: S): ... +164 164 | +165 165 | class MultipleBoundParameters: +166 |- def m[S: int, T: int](self: S, other: T) -> S: ... + 166 |+ def m[T: int](self, other: T) -> Self: ... +167 167 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... +168 168 | +169 169 | + +PYI019_0.pyi:167:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +165 | class MultipleBoundParameters: +166 | def m[S: int, T: int](self: S, other: T) -> S: ... +167 | def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +164 164 | +165 165 | class MultipleBoundParameters: +166 166 | def m[S: int, T: int](self: S, other: T) -> S: ... +167 |- def n[T: (int, str), S: (int, str)](self: S, other: T) -> S: ... + 167 |+ def n[T: (int, str)](self, other: T) -> Self: ... +168 168 | +169 169 | +170 170 | MetaType = TypeVar("MetaType") diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_1.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_1.pyi.snap new file mode 100644 index 0000000000000..00a0b3b355326 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI019_PYI019_1.pyi.snap @@ -0,0 +1,17 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI019_1.pyi:4:10: PYI019 [*] Use `Self` instead of custom TypeVar `S` + | +3 | class F: +4 | def m[S](self: S) -> S: ... + | ^^^^^^^^^^^^^^^^^ PYI019 + | + = help: Replace TypeVar `S` with `Self` + +ℹ Safe fix +1 1 | import typing +2 2 | +3 3 | class F: +4 |- def m[S](self: S) -> S: ... + 4 |+ def m(self) -> typing.Self: ... diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.pyi.snap index f10bbc7b832d8..0512085eb1182 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI020_PYI020.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI020.pyi:7:10: PYI020 [*] Quoted annotations should not be included in stubs | 5 | import typing_extensions -6 | +6 | 7 | def f(x: "int"): ... # Y020 Quoted annotations should never be used in stubs | ^^^^^ PYI020 8 | def g(x: list["int"]): ... # Y020 Quoted annotations should never be used in stubs @@ -47,7 +47,7 @@ PYI020.pyi:9:26: PYI020 [*] Quoted annotations should not be included in stubs 8 | def g(x: list["int"]): ... # Y020 Quoted annotations should never be used in stubs 9 | _T = TypeVar("_T", bound="int") # Y020 Quoted annotations should never be used in stubs | ^^^^^ PYI020 -10 | +10 | 11 | def h(w: Literal["a", "b"], x: typing.Literal["c"], y: typing_extensions.Literal["d"], z: _T) -> _T: ... | = help: Remove quotes @@ -65,7 +65,7 @@ PYI020.pyi:9:26: PYI020 [*] Quoted annotations should not be included in stubs PYI020.pyi:13:12: PYI020 [*] Quoted annotations should not be included in stubs | 11 | def h(w: Literal["a", "b"], x: typing.Literal["c"], y: typing_extensions.Literal["d"], z: _T) -> _T: ... -12 | +12 | 13 | def j() -> "int": ... # Y020 Quoted annotations should never be used in stubs | ^^^^^ PYI020 14 | Alias: TypeAlias = list["int"] # Y020 Quoted annotations should never be used in stubs @@ -87,7 +87,7 @@ PYI020.pyi:14:25: PYI020 [*] Quoted annotations should not be included in stubs 13 | def j() -> "int": ... # Y020 Quoted annotations should never be used in stubs 14 | Alias: TypeAlias = list["int"] # Y020 Quoted annotations should never be used in stubs | ^^^^^ PYI020 -15 | +15 | 16 | class Child(list["int"]): # Y020 Quoted annotations should never be used in stubs | = help: Remove quotes @@ -105,7 +105,7 @@ PYI020.pyi:14:25: PYI020 [*] Quoted annotations should not be included in stubs PYI020.pyi:16:18: PYI020 [*] Quoted annotations should not be included in stubs | 14 | Alias: TypeAlias = list["int"] # Y020 Quoted annotations should never be used in stubs -15 | +15 | 16 | class Child(list["int"]): # Y020 Quoted annotations should never be used in stubs | ^^^^^ PYI020 17 | """Documented and guaranteed useful.""" # Y021 Docstrings should not be included in stubs @@ -169,7 +169,7 @@ PYI020.pyi:24:8: PYI020 [*] Quoted annotations should not be included in stubs 23 | else: 24 | f: "bytes" # Y020 Quoted annotations should never be used in stubs | ^^^^^^^ PYI020 -25 | +25 | 26 | # These two shouldn't trigger Y020 -- empty strings can't be "quoted annotations" | = help: Remove quotes @@ -183,5 +183,3 @@ PYI020.pyi:24:8: PYI020 [*] Quoted annotations should not be included in stubs 25 25 | 26 26 | # These two shouldn't trigger Y020 -- empty strings can't be "quoted annotations" 27 27 | k = "" # Y052 Need type annotation for "k" - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.pyi.snap index 618a3375266f7..a135eb377b657 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI021_PYI021.pyi.snap @@ -1,30 +1,104 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI021.pyi:1:1: PYI021 Docstrings should not be included in stubs +PYI021.pyi:1:1: PYI021 [*] Docstrings should not be included in stubs | 1 | """foo""" # ERROR PYI021 | ^^^^^^^^^ PYI021 -2 | +2 | 3 | def foo(): | + = help: Remove docstring -PYI021.pyi:4:5: PYI021 Docstrings should not be included in stubs +ℹ Unsafe fix +1 |-"""foo""" # ERROR PYI021 + 1 |+ # ERROR PYI021 +2 2 | +3 3 | def foo(): +4 4 | """foo""" # ERROR PYI021 + +PYI021.pyi:4:5: PYI021 [*] Docstrings should not be included in stubs | 3 | def foo(): 4 | """foo""" # ERROR PYI021 | ^^^^^^^^^ PYI021 -5 | +5 | 6 | class Bar: | + = help: Remove docstring + +ℹ Unsafe fix +1 1 | """foo""" # ERROR PYI021 +2 2 | +3 3 | def foo(): +4 |- """foo""" # ERROR PYI021 + 4 |+ ... # ERROR PYI021 +5 5 | +6 6 | class Bar: +7 7 | """bar""" # ERROR PYI021 -PYI021.pyi:7:5: PYI021 Docstrings should not be included in stubs +PYI021.pyi:7:5: PYI021 [*] Docstrings should not be included in stubs | 6 | class Bar: 7 | """bar""" # ERROR PYI021 | ^^^^^^^^^ PYI021 -8 | -9 | def bar(): +8 | +9 | class Qux: | + = help: Remove docstring + +ℹ Unsafe fix +4 4 | """foo""" # ERROR PYI021 +5 5 | +6 6 | class Bar: +7 |- """bar""" # ERROR PYI021 + 7 |+ ... # ERROR PYI021 +8 8 | +9 9 | class Qux: +10 10 | """qux""" # ERROR PYI021 + +PYI021.pyi:10:5: PYI021 [*] Docstrings should not be included in stubs + | + 9 | class Qux: +10 | """qux""" # ERROR PYI021 + | ^^^^^^^^^ PYI021 +11 | +12 | def __init__(self) -> None: ... + | + = help: Remove docstring + +ℹ Unsafe fix +7 7 | """bar""" # ERROR PYI021 +8 8 | +9 9 | class Qux: +10 |- """qux""" # ERROR PYI021 + 10 |+ # ERROR PYI021 +11 11 | +12 12 | def __init__(self) -> None: ... +13 13 | +PYI021.pyi:15:5: PYI021 [*] Docstrings should not be included in stubs + | +14 | class Baz: +15 | / """Multiline docstring +16 | | +17 | | Lorem ipsum dolor sit amet +18 | | """ + | |_______^ PYI021 +19 | +20 | def __init__(self) -> None: ... + | + = help: Remove docstring +ℹ Unsafe fix +12 12 | def __init__(self) -> None: ... +13 13 | +14 14 | class Baz: +15 |- """Multiline docstring +16 |- +17 |- Lorem ipsum dolor sit amet +18 |- """ + 15 |+ +19 16 | +20 17 | def __init__(self) -> None: ... +21 18 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.py.snap index 4f25453dce48b..98a5e1131ce63 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI024.py:3:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 1 | import collections -2 | +2 | 3 | person: collections.namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | ^^^^^^^^^^^^^^^^^^^^^^ PYI024 -4 | +4 | 5 | from collections import namedtuple | = help: Replace with `typing.NamedTuple` @@ -15,10 +15,10 @@ PYI024.py:3:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple PYI024.py:7:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 5 | from collections import namedtuple -6 | +6 | 7 | person: namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | ^^^^^^^^^^ PYI024 -8 | +8 | 9 | person = namedtuple( | = help: Replace with `typing.NamedTuple` @@ -26,12 +26,10 @@ PYI024.py:7:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple PYI024.py:9:10: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 7 | person: namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" - 8 | + 8 | 9 | person = namedtuple( | ^^^^^^^^^^ PYI024 10 | "Person", ["name", "age"] 11 | ) # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | = help: Replace with `typing.NamedTuple` - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.pyi.snap index 6c28b654a4f25..413264f767fb7 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI024_PYI024.pyi.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI024.pyi:3:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 1 | import collections -2 | +2 | 3 | person: collections.namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | ^^^^^^^^^^^^^^^^^^^^^^ PYI024 -4 | +4 | 5 | from collections import namedtuple | = help: Replace with `typing.NamedTuple` @@ -15,10 +15,10 @@ PYI024.pyi:3:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtupl PYI024.pyi:7:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 5 | from collections import namedtuple -6 | +6 | 7 | person: namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | ^^^^^^^^^^ PYI024 -8 | +8 | 9 | person = namedtuple( | = help: Replace with `typing.NamedTuple` @@ -26,12 +26,10 @@ PYI024.pyi:7:9: PYI024 Use `typing.NamedTuple` instead of `collections.namedtupl PYI024.pyi:9:10: PYI024 Use `typing.NamedTuple` instead of `collections.namedtuple` | 7 | person: namedtuple # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" - 8 | + 8 | 9 | person = namedtuple( | ^^^^^^^^^^ PYI024 10 | "Person", ["name", "age"] 11 | ) # Y024 Use "typing.NamedTuple" instead of "collections.namedtuple" | = help: Replace with `typing.NamedTuple` - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.py.snap index 3fd40be9ec54c..842c97c533fea 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.py.snap @@ -24,7 +24,7 @@ PYI025_1.py:14:51: PYI025 [*] Use `from collections.abc import Set as AbstractSe 13 | def f(): 14 | from collections.abc import Container, Sized, Set, ValuesView # PYI025 | ^^^ PYI025 -15 | +15 | 16 | GLOBAL: Set[int] = set() | = help: Alias `Set` to `AbstractSet` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.pyi.snap index 208551931e8c2..e5ca3811d2d83 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_1.pyi.snap @@ -6,7 +6,7 @@ PYI025_1.pyi:8:33: PYI025 [*] Use `from collections.abc import Set as AbstractSe 7 | def f(): 8 | from collections.abc import Set # PYI025 | ^^^ PYI025 - 9 | + 9 | 10 | def f(): | = help: Alias `Set` to `AbstractSet` @@ -26,7 +26,7 @@ PYI025_1.pyi:11:51: PYI025 [*] Use `from collections.abc import Set as AbstractS 10 | def f(): 11 | from collections.abc import Container, Sized, Set, ValuesView # PYI025 | ^^^ PYI025 -12 | +12 | 13 | def f(): | = help: Alias `Set` to `AbstractSet` @@ -79,10 +79,10 @@ PYI025_1.pyi:16:37: PYI025 [*] Use `from collections.abc import Set as AbstractS PYI025_1.pyi:33:29: PYI025 [*] Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin | 31 | print(Set) -32 | +32 | 33 | from collections.abc import Set | ^^^ PYI025 -34 | +34 | 35 | def f(): | = help: Alias `Set` to `AbstractSet` @@ -125,7 +125,7 @@ PYI025_1.pyi:44:33: PYI025 [*] Use `from collections.abc import Set as AbstractS 43 | """Test: nonlocal symbol renaming.""" 44 | from collections.abc import Set | ^^^ PYI025 -45 | +45 | 46 | def g(): | = help: Alias `Set` to `AbstractSet` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.py.snap index 1177dc90ecf8e..284fe290194ff 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI025_2.py:3:29: PYI025 [*] Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin | 1 | """Tests to ensure we correctly rename references inside `__all__`""" -2 | +2 | 3 | from collections.abc import Set | ^^^ PYI025 -4 | +4 | 5 | __all__ = ["Set"] | = help: Alias `Set` to `AbstractSet` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.pyi.snap index 41feeabda6cf0..88d1423db09ab 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_2.pyi.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI025_2.pyi:3:29: PYI025 [*] Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin | 1 | """Tests to ensure we correctly rename references inside `__all__`""" -2 | +2 | 3 | from collections.abc import Set | ^^^ PYI025 -4 | +4 | 5 | __all__ = ["Set"] | = help: Alias `Set` to `AbstractSet` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.py.snap index 008e68502946c..8e29eb17f31a0 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI025_3.py:6:36: PYI025 [*] Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin | 4 | """ -5 | +5 | 6 | from collections.abc import Set as Set # PYI025 triggered but fix is not marked as safe | ^^^ PYI025 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.pyi.snap index ae54570974134..8eb394f20c7c8 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI025_PYI025_3.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI025_3.pyi:6:36: PYI025 [*] Use `from collections.abc import Set as AbstractSet` to avoid confusion with the `set` builtin | 4 | """ -5 | +5 | 6 | from collections.abc import Set as Set # PYI025 triggered but fix is not marked as safe | ^^^ PYI025 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.pyi.snap index 91c4bbddd76ac..b59d96e3d2bfa 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI026_PYI026.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI026.pyi:3:1: PYI026 [*] Use `typing.TypeAlias` for type alias, e.g., `NewAny: TypeAlias = Any` | 1 | from typing import Literal, Any -2 | +2 | 3 | NewAny = Any | ^^^^^^ PYI026 4 | OptionalStr = typing.Optional[str] @@ -95,7 +95,7 @@ PYI026.pyi:7:1: PYI026 [*] Use `typing.TypeAlias` for type alias, e.g., `AliasNo 6 | IntOrStr = int | str 7 | AliasNone = None | ^^^^^^^^^ PYI026 -8 | +8 | 9 | NewAny: typing.TypeAlias = Any | = help: Add `TypeAlias` annotation @@ -119,7 +119,7 @@ PYI026.pyi:17:5: PYI026 [*] Use `typing.TypeAlias` for type alias, e.g., `FLAG_T 16 | class NotAnEnum: 17 | FLAG_THIS = None | ^^^^^^^^^ PYI026 -18 | +18 | 19 | # these are ok | = help: Add `TypeAlias` annotation diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.pyi.snap index 40bdd22441e1c..fee65011201af 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI029_PYI029.pyi.snap @@ -6,7 +6,7 @@ PYI029.pyi:10:9: PYI029 [*] Defining `__str__` in a stub is almost always redund 9 | class ShouldRemoveSingle: 10 | def __str__(self) -> builtins.str: ... # Error: PYI029 | ^^^^^^^ PYI029 -11 | +11 | 12 | class ShouldRemove: | = help: Remove definition of `__str__` @@ -45,7 +45,7 @@ PYI029.pyi:14:9: PYI029 [*] Defining `__str__` in a stub is almost always redund 13 | def __repr__(self) -> str: ... # Error: PYI029 14 | def __str__(self) -> builtins.str: ... # Error: PYI029 | ^^^^^^^ PYI029 -15 | +15 | 16 | class NoReturnSpecified: | = help: Remove definition of `__str__` @@ -58,5 +58,3 @@ PYI029.pyi:14:9: PYI029 [*] Defining `__str__` in a stub is almost always redund 15 14 | 16 15 | class NoReturnSpecified: 17 16 | def __str__(self): ... - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.py.snap index 82093c63aaa00..4e92aa20780f6 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.py.snap @@ -6,7 +6,7 @@ PYI030.py:9:9: PYI030 [*] Multiple literal members in a union. Use a single lite 8 | # Should emit for duplicate field types. 9 | field2: Literal[1] | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -10 | +10 | 11 | # Should emit for union types in arguments. | = help: Replace with a single `Literal` @@ -126,7 +126,7 @@ PYI030.py:25:9: PYI030 [*] Multiple literal members in a union. Use a single lit 24 | field5: Literal[1] | str | Literal[2] # Error 25 | field6: Literal[1] | bool | Literal[2] | str # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -26 | +26 | 27 | # Should emit for non-type unions. | = help: Replace with a single `Literal` @@ -146,7 +146,7 @@ PYI030.py:28:10: PYI030 [*] Multiple literal members in a union. Use a single li 27 | # Should emit for non-type unions. 28 | field7 = Literal[1] | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -29 | +29 | 30 | # Should emit for parenthesized unions. | = help: Replace with a single `Literal` @@ -166,7 +166,7 @@ PYI030.py:31:9: PYI030 [*] Multiple literal members in a union. Use a single lit 30 | # Should emit for parenthesized unions. 31 | field8: Literal[1] | (Literal[2] | str) # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -32 | +32 | 33 | # Should handle user parentheses when fixing. | = help: Replace with a single `Literal` @@ -206,7 +206,7 @@ PYI030.py:35:10: PYI030 [*] Multiple literal members in a union. Use a single li 34 | field9: Literal[1] | (Literal[2] | str) # Error 35 | field10: (Literal[1] | str) | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -36 | +36 | 37 | # Should emit for union in generic parent type. | = help: Replace with a single `Literal` @@ -226,7 +226,7 @@ PYI030.py:38:15: PYI030 [*] Multiple literal members in a union. Use a single li 37 | # Should emit for union in generic parent type. 38 | field11: dict[Literal[1] | Literal[2], str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -39 | +39 | 40 | # Should emit for unions with more than two cases | = help: Replace with a single `Literal` @@ -266,7 +266,7 @@ PYI030.py:42:10: PYI030 [*] Multiple literal members in a union. Use a single li 41 | field12: Literal[1] | Literal[2] | Literal[3] # Error 42 | field13: Literal[1] | Literal[2] | Literal[3] | Literal[4] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -43 | +43 | 44 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Replace with a single `Literal` @@ -286,7 +286,7 @@ PYI030.py:45:10: PYI030 [*] Multiple literal members in a union. Use a single li 44 | # Should emit for unions with more than two cases, even if not directly adjacent 45 | field14: Literal[1] | Literal[2] | str | Literal[3] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -46 | +46 | 47 | # Should emit for unions with mixed literal internal types | = help: Replace with a single `Literal` @@ -306,7 +306,7 @@ PYI030.py:48:10: PYI030 [*] Multiple literal members in a union. Use a single li 47 | # Should emit for unions with mixed literal internal types 48 | field15: Literal[1] | Literal["foo"] | Literal[True] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -49 | +49 | 50 | # Shouldn't emit for duplicate field types with same value; covered by Y016 | = help: Replace with a single `Literal` @@ -326,7 +326,7 @@ PYI030.py:51:10: PYI030 [*] Multiple literal members in a union. Use a single li 50 | # Shouldn't emit for duplicate field types with same value; covered by Y016 51 | field16: Literal[1] | Literal[1] # OK | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -52 | +52 | 53 | # Shouldn't emit if in new parent type | = help: Replace with a single `Literal` @@ -346,7 +346,7 @@ PYI030.py:60:10: PYI030 [*] Multiple literal members in a union. Use a single li 59 | # Should respect name of literal type used 60 | field19: typing.Literal[1] | typing.Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -61 | +61 | 62 | # Should emit in cases with newlines | = help: Replace with a single `Literal` @@ -372,12 +372,12 @@ PYI030.py:63:10: PYI030 [*] Multiple literal members in a union. Use a single li 67 | | Literal[2], 68 | | ] # Error, newline and comment will not be emitted in message | |_^ PYI030 -69 | +69 | 70 | # Should handle multiple unions with multiple members | = help: Replace with a single `Literal` -ℹ Safe fix +ℹ Unsafe fix 60 60 | field19: typing.Literal[1] | typing.Literal[2] # Error 61 61 | 62 62 | # Should emit in cases with newlines @@ -397,7 +397,7 @@ PYI030.py:71:10: PYI030 [*] Multiple literal members in a union. Use a single li 70 | # Should handle multiple unions with multiple members 71 | field21: Literal[1, 2] | Literal[3, 4] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -72 | +72 | 73 | # Should emit in cases with `typing.Union` instead of `|` | = help: Replace with a single `Literal` @@ -417,7 +417,7 @@ PYI030.py:74:10: PYI030 [*] Multiple literal members in a union. Use a single li 73 | # Should emit in cases with `typing.Union` instead of `|` 74 | field22: typing.Union[Literal[1], Literal[2]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -75 | +75 | 76 | # Should emit in cases with `typing_extensions.Literal` | = help: Replace with a single `Literal` @@ -437,7 +437,7 @@ PYI030.py:77:10: PYI030 [*] Multiple literal members in a union. Use a single li 76 | # Should emit in cases with `typing_extensions.Literal` 77 | field23: typing_extensions.Literal[1] | typing_extensions.Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -78 | +78 | 79 | # Should emit in cases with nested `typing.Union` | = help: Replace with a single `Literal` @@ -457,7 +457,7 @@ PYI030.py:80:10: PYI030 [*] Multiple literal members in a union. Use a single li 79 | # Should emit in cases with nested `typing.Union` 80 | field24: typing.Union[Literal[1], typing.Union[Literal[2], str]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -81 | +81 | 82 | # Should emit in cases with mixed `typing.Union` and `|` | = help: Replace with a single `Literal` @@ -477,7 +477,7 @@ PYI030.py:83:10: PYI030 [*] Multiple literal members in a union. Use a single li 82 | # Should emit in cases with mixed `typing.Union` and `|` 83 | field25: typing.Union[Literal[1], Literal[2] | str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -84 | +84 | 85 | # Should emit only once in cases with multiple nested `typing.Union` | = help: Replace with a single `Literal` @@ -497,7 +497,7 @@ PYI030.py:86:10: PYI030 [*] Multiple literal members in a union. Use a single li 85 | # Should emit only once in cases with multiple nested `typing.Union` 86 | field24: typing.Union[Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -87 | +87 | 88 | # Should use the first literal subscript attribute when fixing | = help: Replace with a single `Literal` @@ -517,7 +517,7 @@ PYI030.py:89:10: PYI030 [*] Multiple literal members in a union. Use a single li 88 | # Should use the first literal subscript attribute when fixing 89 | field25: typing.Union[typing_extensions.Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]], str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -90 | +90 | 91 | from typing import IO, Literal | = help: Replace with a single `Literal` @@ -535,9 +535,11 @@ PYI030.py:89:10: PYI030 [*] Multiple literal members in a union. Use a single li PYI030.py:93:16: PYI030 [*] Multiple literal members in a union. Use a single literal, e.g. `Literal["a", "b"]` | 91 | from typing import IO, Literal -92 | +92 | 93 | InlineOption = Literal["a"] | Literal["b"] | IO[str] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 +94 | +95 | # Should use unsafe fix when comments are deleted | = help: Replace with a single `Literal` @@ -547,3 +549,51 @@ PYI030.py:93:16: PYI030 [*] Multiple literal members in a union. Use a single li 92 92 | 93 |-InlineOption = Literal["a"] | Literal["b"] | IO[str] 93 |+InlineOption = Literal["a", "b"] | IO[str] +94 94 | +95 95 | # Should use unsafe fix when comments are deleted +96 96 | field26: ( + +PYI030.py:98:5: PYI030 [*] Multiple literal members in a union. Use a single literal, e.g. `Literal["a", "b", "c", "d"]` + | + 96 | field26: ( + 97 | # First comment + 98 | / Literal["a", "b"] + 99 | | # Second comment +100 | | | Literal["c", "d"] + | |_______________________^ PYI030 +101 | ) +102 | field27: ( + | + = help: Replace with a single `Literal` + +ℹ Unsafe fix +95 95 | # Should use unsafe fix when comments are deleted +96 96 | field26: ( +97 97 | # First comment +98 |- Literal["a", "b"] +99 |- # Second comment +100 |- | Literal["c", "d"] + 98 |+ Literal["a", "b", "c", "d"] +101 99 | ) +102 100 | field27: ( +103 101 | Literal["a", "b"] # First comment + +PYI030.py:103:5: PYI030 [*] Multiple literal members in a union. Use a single literal, e.g. `Literal["a", "b", "c", "d"]` + | +101 | ) +102 | field27: ( +103 | / Literal["a", "b"] # First comment +104 | | | Literal["c", "d"] # Second comment + | |_______________________^ PYI030 +105 | ) + | + = help: Replace with a single `Literal` + +ℹ Unsafe fix +100 100 | | Literal["c", "d"] +101 101 | ) +102 102 | field27: ( +103 |- Literal["a", "b"] # First comment +104 |- | Literal["c", "d"] # Second comment + 103 |+ Literal["a", "b", "c", "d"] # Second comment +105 104 | ) diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.pyi.snap index 7d49337d4cf41..d4788e5b032df 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI030_PYI030.pyi.snap @@ -6,7 +6,7 @@ PYI030.pyi:9:9: PYI030 [*] Multiple literal members in a union. Use a single lit 8 | # Should emit for duplicate field types. 9 | field2: Literal[1] | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -10 | +10 | 11 | # Should emit for union types in arguments. | = help: Replace with a single `Literal` @@ -126,7 +126,7 @@ PYI030.pyi:25:9: PYI030 [*] Multiple literal members in a union. Use a single li 24 | field5: Literal[1] | str | Literal[2] # Error 25 | field6: Literal[1] | bool | Literal[2] | str # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -26 | +26 | 27 | # Should emit for non-type unions. | = help: Replace with a single `Literal` @@ -146,7 +146,7 @@ PYI030.pyi:28:10: PYI030 [*] Multiple literal members in a union. Use a single l 27 | # Should emit for non-type unions. 28 | field7 = Literal[1] | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -29 | +29 | 30 | # Should emit for parenthesized unions. | = help: Replace with a single `Literal` @@ -166,7 +166,7 @@ PYI030.pyi:31:9: PYI030 [*] Multiple literal members in a union. Use a single li 30 | # Should emit for parenthesized unions. 31 | field8: Literal[1] | (Literal[2] | str) # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -32 | +32 | 33 | # Should handle user parentheses when fixing. | = help: Replace with a single `Literal` @@ -206,7 +206,7 @@ PYI030.pyi:35:10: PYI030 [*] Multiple literal members in a union. Use a single l 34 | field9: Literal[1] | (Literal[2] | str) # Error 35 | field10: (Literal[1] | str) | Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -36 | +36 | 37 | # Should emit for union in generic parent type. | = help: Replace with a single `Literal` @@ -226,7 +226,7 @@ PYI030.pyi:38:15: PYI030 [*] Multiple literal members in a union. Use a single l 37 | # Should emit for union in generic parent type. 38 | field11: dict[Literal[1] | Literal[2], str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -39 | +39 | 40 | # Should emit for unions with more than two cases | = help: Replace with a single `Literal` @@ -266,7 +266,7 @@ PYI030.pyi:42:10: PYI030 [*] Multiple literal members in a union. Use a single l 41 | field12: Literal[1] | Literal[2] | Literal[3] # Error 42 | field13: Literal[1] | Literal[2] | Literal[3] | Literal[4] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -43 | +43 | 44 | # Should emit for unions with more than two cases, even if not directly adjacent | = help: Replace with a single `Literal` @@ -286,7 +286,7 @@ PYI030.pyi:45:10: PYI030 [*] Multiple literal members in a union. Use a single l 44 | # Should emit for unions with more than two cases, even if not directly adjacent 45 | field14: Literal[1] | Literal[2] | str | Literal[3] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -46 | +46 | 47 | # Should emit for unions with mixed literal internal types | = help: Replace with a single `Literal` @@ -306,7 +306,7 @@ PYI030.pyi:48:10: PYI030 [*] Multiple literal members in a union. Use a single l 47 | # Should emit for unions with mixed literal internal types 48 | field15: Literal[1] | Literal["foo"] | Literal[True] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -49 | +49 | 50 | # Shouldn't emit for duplicate field types with same value; covered by Y016 | = help: Replace with a single `Literal` @@ -326,7 +326,7 @@ PYI030.pyi:51:10: PYI030 [*] Multiple literal members in a union. Use a single l 50 | # Shouldn't emit for duplicate field types with same value; covered by Y016 51 | field16: Literal[1] | Literal[1] # OK | ^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -52 | +52 | 53 | # Shouldn't emit if in new parent type | = help: Replace with a single `Literal` @@ -346,7 +346,7 @@ PYI030.pyi:60:10: PYI030 [*] Multiple literal members in a union. Use a single l 59 | # Should respect name of literal type used 60 | field19: typing.Literal[1] | typing.Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -61 | +61 | 62 | # Should emit in cases with newlines | = help: Replace with a single `Literal` @@ -372,12 +372,12 @@ PYI030.pyi:63:10: PYI030 [*] Multiple literal members in a union. Use a single l 67 | | Literal[2], 68 | | ] # Error, newline and comment will not be emitted in message | |_^ PYI030 -69 | +69 | 70 | # Should handle multiple unions with multiple members | = help: Replace with a single `Literal` -ℹ Safe fix +ℹ Unsafe fix 60 60 | field19: typing.Literal[1] | typing.Literal[2] # Error 61 61 | 62 62 | # Should emit in cases with newlines @@ -397,7 +397,7 @@ PYI030.pyi:71:10: PYI030 [*] Multiple literal members in a union. Use a single l 70 | # Should handle multiple unions with multiple members 71 | field21: Literal[1, 2] | Literal[3, 4] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -72 | +72 | 73 | # Should emit in cases with `typing.Union` instead of `|` | = help: Replace with a single `Literal` @@ -417,7 +417,7 @@ PYI030.pyi:74:10: PYI030 [*] Multiple literal members in a union. Use a single l 73 | # Should emit in cases with `typing.Union` instead of `|` 74 | field22: typing.Union[Literal[1], Literal[2]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -75 | +75 | 76 | # Should emit in cases with `typing_extensions.Literal` | = help: Replace with a single `Literal` @@ -437,7 +437,7 @@ PYI030.pyi:77:10: PYI030 [*] Multiple literal members in a union. Use a single l 76 | # Should emit in cases with `typing_extensions.Literal` 77 | field23: typing_extensions.Literal[1] | typing_extensions.Literal[2] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -78 | +78 | 79 | # Should emit in cases with nested `typing.Union` | = help: Replace with a single `Literal` @@ -457,7 +457,7 @@ PYI030.pyi:80:10: PYI030 [*] Multiple literal members in a union. Use a single l 79 | # Should emit in cases with nested `typing.Union` 80 | field24: typing.Union[Literal[1], typing.Union[Literal[2], str]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -81 | +81 | 82 | # Should emit in cases with mixed `typing.Union` and `|` | = help: Replace with a single `Literal` @@ -477,7 +477,7 @@ PYI030.pyi:83:10: PYI030 [*] Multiple literal members in a union. Use a single l 82 | # Should emit in cases with mixed `typing.Union` and `|` 83 | field25: typing.Union[Literal[1], Literal[2] | str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -84 | +84 | 85 | # Should emit only once in cases with multiple nested `typing.Union` | = help: Replace with a single `Literal` @@ -497,7 +497,7 @@ PYI030.pyi:86:10: PYI030 [*] Multiple literal members in a union. Use a single l 85 | # Should emit only once in cases with multiple nested `typing.Union` 86 | field24: typing.Union[Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]]] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 -87 | +87 | 88 | # Should use the first literal subscript attribute when fixing | = help: Replace with a single `Literal` @@ -517,6 +517,8 @@ PYI030.pyi:89:10: PYI030 [*] Multiple literal members in a union. Use a single l 88 | # Should use the first literal subscript attribute when fixing 89 | field25: typing.Union[typing_extensions.Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]], str] # Error | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI030 +90 | +91 | # Should use unsafe fix when comments are deleted | = help: Replace with a single `Literal` @@ -526,5 +528,51 @@ PYI030.pyi:89:10: PYI030 [*] Multiple literal members in a union. Use a single l 88 88 | # Should use the first literal subscript attribute when fixing 89 |-field25: typing.Union[typing_extensions.Literal[1], typing.Union[Literal[2], typing.Union[Literal[3], Literal[4]]], str] # Error 89 |+field25: typing.Union[typing_extensions.Literal[1, 2, 3, 4], str] # Error +90 90 | +91 91 | # Should use unsafe fix when comments are deleted +92 92 | field26: ( +PYI030.pyi:94:5: PYI030 [*] Multiple literal members in a union. Use a single literal, e.g. `Literal["a", "b", "c", "d"]` + | +92 | field26: ( +93 | # First comment +94 | / Literal["a", "b"] +95 | | # Second comment +96 | | | Literal["c", "d"] + | |_______________________^ PYI030 +97 | ) +98 | field27: ( + | + = help: Replace with a single `Literal` +ℹ Unsafe fix +91 91 | # Should use unsafe fix when comments are deleted +92 92 | field26: ( +93 93 | # First comment +94 |- Literal["a", "b"] +95 |- # Second comment +96 |- | Literal["c", "d"] + 94 |+ Literal["a", "b", "c", "d"] +97 95 | ) +98 96 | field27: ( +99 97 | Literal["a", "b"] # First comment + +PYI030.pyi:99:5: PYI030 [*] Multiple literal members in a union. Use a single literal, e.g. `Literal["a", "b", "c", "d"]` + | + 97 | ) + 98 | field27: ( + 99 | / Literal["a", "b"] # First comment +100 | | | Literal["c", "d"] # Second comment + | |_______________________^ PYI030 +101 | ) + | + = help: Replace with a single `Literal` + +ℹ Unsafe fix +96 96 | | Literal["c", "d"] +97 97 | ) +98 98 | field27: ( +99 |- Literal["a", "b"] # First comment +100 |- | Literal["c", "d"] # Second comment + 99 |+ Literal["a", "b", "c", "d"] # Second comment +101 100 | ) diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.py.snap index b6b3713235846..730106f00ea04 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI032.py:6:29: PYI032 [*] Prefer `object` to `Any` for the second parameter to `__eq__` | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.pyi.snap index 76cd8c068fa5d..3e18a528d006f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI032_PYI032.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI032.pyi:6:29: PYI032 [*] Prefer `object` to `Any` for the second parameter to `__eq__` | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.pyi.snap index 9e6ec217740cc..1908a7ab920e5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI033_PYI033.pyi.snap @@ -3,41 +3,41 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- PYI033.pyi:6:22: PYI033 Don't use type comments in stub file | -4 | from typing import TypeAlias -5 | -6 | A: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -7 | B: TypeAlias = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -8 | C: TypeAlias = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +4 | … import TypeAlias +5 | … +6 | …s = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +7 | …s = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: … +8 | …s = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") | PYI033.pyi:7:22: PYI033 Don't use type comments in stub file | -6 | A: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -7 | B: TypeAlias = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -8 | C: TypeAlias = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -9 | D: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +6 | …one # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +7 | …one # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +8 | …one #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +9 | …one # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") | PYI033.pyi:8:22: PYI033 Don't use type comments in stub file | - 6 | A: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - 7 | B: TypeAlias = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - 8 | C: TypeAlias = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 - 9 | D: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -10 | E: TypeAlias = None# type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + 6 | …s = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + 7 | …s = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x:… + 8 | …s = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 + 9 | …s = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +10 | …s = None# type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") | PYI033.pyi:9:22: PYI033 Don't use type comments in stub file | - 7 | B: TypeAlias = None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - 8 | C: TypeAlias = None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - 9 | D: TypeAlias = None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -10 | E: TypeAlias = None# type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -11 | F: TypeAlias = None#type:int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + 7 | … None # type: str # And here's an extra comment about why it's that type # Y033 Do not use type comments in stubs (e.g. use "x: in… + 8 | … None #type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + 9 | … None # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +10 | … None# type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +11 | … None#type:int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") | PYI033.pyi:10:20: PYI033 Don't use type comments in stub file @@ -55,35 +55,35 @@ PYI033.pyi:11:20: PYI033 Don't use type comments in stub file 10 | E: TypeAlias = None# type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") 11 | F: TypeAlias = None#type:int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -12 | +12 | 13 | def func( | PYI033.pyi:14:12: PYI033 Don't use type comments in stub file | -13 | def func( -14 | arg1, # type: dict[str, int] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -15 | arg2 # type: Sequence[bytes] # And here's some more info about this arg # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -16 | ): ... +13 | …func( +14 | …arg1, # type: dict[str, int] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +15 | …arg2 # type: Sequence[bytes] # And here's some more info about this arg # Y033 Do not use type comments in stubs (e.g. use "x: int… +16 | ….. | PYI033.pyi:15:11: PYI033 Don't use type comments in stub file | -13 | def func( -14 | arg1, # type: dict[str, int] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") -15 | arg2 # type: Sequence[bytes] # And here's some more info about this arg # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -16 | ): ... +13 | …unc( +14 | …rg1, # type: dict[str, int] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") +15 | …rg2 # type: Sequence[bytes] # And here's some more info about this arg # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +16 | …. | PYI033.pyi:19:29: PYI033 Don't use type comments in stub file | -18 | class Foo: -19 | Attr: TypeAlias = None # type: set[str] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -20 | -21 | G: TypeAlias = None # type: ignore +18 | … +19 | … None # type: set[str] # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 +20 | … +21 | …# type: ignore | PYI033.pyi:29:22: PYI033 Don't use type comments in stub file @@ -91,7 +91,7 @@ PYI033.pyi:29:22: PYI033 Don't use type comments in stub file 28 | # Whole line commented out # type: int 29 | M: TypeAlias = None # type: can't parse me! | ^^^^^^^^^^^^^^^^^^^^^^^ PYI033 -30 | +30 | 31 | class Bar: | @@ -102,5 +102,3 @@ PYI033.pyi:32:26: PYI033 Don't use type comments in stub file | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI033 33 | # This whole line is commented out and indented # type: str | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.py.snap index d1d2bb3c95f06..bb520776d6b94 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.py.snap @@ -1,108 +1,471 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI034.py:21:9: PYI034 `__new__` methods in classes like `Bad` usually return `self` at runtime +PYI034.py:21:9: PYI034 [*] `__new__` methods in classes like `Bad` usually return `self` at runtime | 19 | object 20 | ): # Y040 Do not inherit from "object" explicitly, as it is redundant in Python 3 21 | def __new__(cls, *args: Any, **kwargs: Any) -> Bad: | ^^^^^^^ PYI034 -22 | ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g. "def __new__(cls, *args: Any, **kwargs: Any) -> Self: ..." +22 | ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g.… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.py:36:9: PYI034 `__enter__` methods in classes like `Bad` usually return `self` at runtime +ℹ Unsafe fix +18 18 | class Bad( +19 19 | object +20 20 | ): # Y040 Do not inherit from "object" explicitly, as it is redundant in Python 3 +21 |- def __new__(cls, *args: Any, **kwargs: Any) -> Bad: + 21 |+ def __new__(cls, *args: Any, **kwargs: Any) -> typing.Self: +22 22 | ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g. "def __new__(cls, *args: Any, **kwargs: Any) -> Self: ..." +23 23 | +24 24 | def __repr__(self) -> str: + +PYI034.py:36:9: PYI034 [*] `__enter__` methods in classes like `Bad` usually return `self` at runtime | 34 | ... # Y032 Prefer "object" to "Any" for the second parameter in "__ne__" methods -35 | +35 | 36 | def __enter__(self) -> Bad: | ^^^^^^^^^ PYI034 -37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +33 33 | def __ne__(self, other: typing.Any) -> typing.Any: +34 34 | ... # Y032 Prefer "object" to "Any" for the second parameter in "__ne__" methods +35 35 | +36 |- def __enter__(self) -> Bad: + 36 |+ def __enter__(self) -> typing.Self: +37 37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +38 38 | +39 39 | async def __aenter__(self) -> Bad: -PYI034.py:39:15: PYI034 `__aenter__` methods in classes like `Bad` usually return `self` at runtime +PYI034.py:39:15: PYI034 [*] `__aenter__` methods in classes like `Bad` usually return `self` at runtime | -37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." -38 | +37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self… +38 | 39 | async def __aenter__(self) -> Bad: | ^^^^^^^^^^ PYI034 -40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Sel… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +36 36 | def __enter__(self) -> Bad: +37 37 | ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +38 38 | +39 |- async def __aenter__(self) -> Bad: + 39 |+ async def __aenter__(self) -> typing.Self: +40 40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +41 41 | +42 42 | def __iadd__(self, other: Bad) -> Bad: -PYI034.py:42:9: PYI034 `__iadd__` methods in classes like `Bad` usually return `self` at runtime +PYI034.py:42:9: PYI034 [*] `__iadd__` methods in classes like `Bad` usually return `self` at runtime | -40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." -41 | +40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Sel… +41 | 42 | def __iadd__(self, other: Bad) -> Bad: | ^^^^^^^^ PYI034 -43 | ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." +43 | ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self"… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.py:165:9: PYI034 `__iter__` methods in classes like `BadIterator1` usually return `self` at runtime +ℹ Unsafe fix +39 39 | async def __aenter__(self) -> Bad: +40 40 | ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +41 41 | +42 |- def __iadd__(self, other: Bad) -> Bad: + 42 |+ def __iadd__(self, other: Bad) -> typing.Self: +43 43 | ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." +44 44 | +45 45 | + +PYI034.py:165:9: PYI034 [*] `__iter__` methods in classes like `BadIterator1` usually return `self` at runtime | 164 | class BadIterator1(Iterator[int]): 165 | def __iter__(self) -> Iterator[int]: | ^^^^^^^^ PYI034 -166 | ... # Y034 "__iter__" methods in classes like "BadIterator1" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator1.__iter__", e.g. "def __iter__(self) -> Self: ..." +166 | ... # Y034 "__iter__" methods in classes like "BadIterator1" usually return "self" at runtime. Consider using "typing_extens… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +162 162 | +163 163 | +164 164 | class BadIterator1(Iterator[int]): +165 |- def __iter__(self) -> Iterator[int]: + 165 |+ def __iter__(self) -> typing.Self: +166 166 | ... # Y034 "__iter__" methods in classes like "BadIterator1" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator1.__iter__", e.g. "def __iter__(self) -> Self: ..." +167 167 | +168 168 | -PYI034.py:172:9: PYI034 `__iter__` methods in classes like `BadIterator2` usually return `self` at runtime +PYI034.py:172:9: PYI034 [*] `__iter__` methods in classes like `BadIterator2` usually return `self` at runtime | 170 | typing.Iterator[int] 171 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) 172 | def __iter__(self) -> Iterator[int]: | ^^^^^^^^ PYI034 -173 | ... # Y034 "__iter__" methods in classes like "BadIterator2" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator2.__iter__", e.g. "def __iter__(self) -> Self: ..." +173 | ... # Y034 "__iter__" methods in classes like "BadIterator2" usually return "self" at runtime. Consider using "typing_extens… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.py:179:9: PYI034 `__iter__` methods in classes like `BadIterator3` usually return `self` at runtime +ℹ Unsafe fix +169 169 | class BadIterator2( +170 170 | typing.Iterator[int] +171 171 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) +172 |- def __iter__(self) -> Iterator[int]: + 172 |+ def __iter__(self) -> typing.Self: +173 173 | ... # Y034 "__iter__" methods in classes like "BadIterator2" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator2.__iter__", e.g. "def __iter__(self) -> Self: ..." +174 174 | +175 175 | + +PYI034.py:179:9: PYI034 [*] `__iter__` methods in classes like `BadIterator3` usually return `self` at runtime | 177 | typing.Iterator[int] 178 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) 179 | def __iter__(self) -> collections.abc.Iterator[int]: | ^^^^^^^^ PYI034 -180 | ... # Y034 "__iter__" methods in classes like "BadIterator3" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator3.__iter__", e.g. "def __iter__(self) -> Self: ..." +180 | ... # Y034 "__iter__" methods in classes like "BadIterator3" usually return "self" at runtime. Consider using "typing_extens… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +176 176 | class BadIterator3( +177 177 | typing.Iterator[int] +178 178 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) +179 |- def __iter__(self) -> collections.abc.Iterator[int]: + 179 |+ def __iter__(self) -> typing.Self: +180 180 | ... # Y034 "__iter__" methods in classes like "BadIterator3" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator3.__iter__", e.g. "def __iter__(self) -> Self: ..." +181 181 | +182 182 | -PYI034.py:185:9: PYI034 `__iter__` methods in classes like `BadIterator4` usually return `self` at runtime +PYI034.py:185:9: PYI034 [*] `__iter__` methods in classes like `BadIterator4` usually return `self` at runtime | 183 | class BadIterator4(Iterator[int]): 184 | # Note: *Iterable*, not *Iterator*, returned! 185 | def __iter__(self) -> Iterable[int]: | ^^^^^^^^ PYI034 -186 | ... # Y034 "__iter__" methods in classes like "BadIterator4" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator4.__iter__", e.g. "def __iter__(self) -> Self: ..." +186 | ... # Y034 "__iter__" methods in classes like "BadIterator4" usually return "self" at runtime. Consider using "typing_extens… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.py:195:9: PYI034 `__aiter__` methods in classes like `BadAsyncIterator` usually return `self` at runtime +ℹ Unsafe fix +182 182 | +183 183 | class BadIterator4(Iterator[int]): +184 184 | # Note: *Iterable*, not *Iterator*, returned! +185 |- def __iter__(self) -> Iterable[int]: + 185 |+ def __iter__(self) -> typing.Self: +186 186 | ... # Y034 "__iter__" methods in classes like "BadIterator4" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator4.__iter__", e.g. "def __iter__(self) -> Self: ..." +187 187 | +188 188 | + +PYI034.py:195:9: PYI034 [*] `__aiter__` methods in classes like `BadAsyncIterator` usually return `self` at runtime | 194 | class BadAsyncIterator(collections.abc.AsyncIterator[str]): 195 | def __aiter__(self) -> typing.AsyncIterator[str]: | ^^^^^^^^^ PYI034 -196 | ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadAsyncIterator.__aiter__", e.g. "def __aiter__(self) -> Self: ..." # Y022 Use "collections.abc.AsyncIterator[T]" instead of "typing.AsyncIterator[T]" (PEP 585 syntax) +196 | ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_e… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +192 192 | +193 193 | +194 194 | class BadAsyncIterator(collections.abc.AsyncIterator[str]): +195 |- def __aiter__(self) -> typing.AsyncIterator[str]: + 195 |+ def __aiter__(self) -> typing.Self: +196 196 | ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadAsyncIterator.__aiter__", e.g. "def __aiter__(self) -> Self: ..." # Y022 Use "collections.abc.AsyncIterator[T]" instead of "typing.AsyncIterator[T]" (PEP 585 syntax) +197 197 | +198 198 | class SubclassOfBadIterator3(BadIterator3): -PYI034.py:199:9: PYI034 `__iter__` methods in classes like `SubclassOfBadIterator3` usually return `self` at runtime +PYI034.py:199:9: PYI034 [*] `__iter__` methods in classes like `SubclassOfBadIterator3` usually return `self` at runtime | 198 | class SubclassOfBadIterator3(BadIterator3): 199 | def __iter__(self) -> Iterator[int]: # Y034 | ^^^^^^^^ PYI034 200 | ... | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.py:203:9: PYI034 `__aiter__` methods in classes like `SubclassOfBadAsyncIterator` usually return `self` at runtime +ℹ Unsafe fix +196 196 | ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadAsyncIterator.__aiter__", e.g. "def __aiter__(self) -> Self: ..." # Y022 Use "collections.abc.AsyncIterator[T]" instead of "typing.AsyncIterator[T]" (PEP 585 syntax) +197 197 | +198 198 | class SubclassOfBadIterator3(BadIterator3): +199 |- def __iter__(self) -> Iterator[int]: # Y034 + 199 |+ def __iter__(self) -> typing.Self: # Y034 +200 200 | ... +201 201 | +202 202 | class SubclassOfBadAsyncIterator(BadAsyncIterator): + +PYI034.py:203:9: PYI034 [*] `__aiter__` methods in classes like `SubclassOfBadAsyncIterator` usually return `self` at runtime | 202 | class SubclassOfBadAsyncIterator(BadAsyncIterator): 203 | def __aiter__(self) -> collections.abc.AsyncIterator[str]: # Y034 | ^^^^^^^^^ PYI034 204 | ... | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +200 200 | ... +201 201 | +202 202 | class SubclassOfBadAsyncIterator(BadAsyncIterator): +203 |- def __aiter__(self) -> collections.abc.AsyncIterator[str]: # Y034 + 203 |+ def __aiter__(self) -> typing.Self: # Y034 +204 204 | ... +205 205 | +206 206 | class AsyncIteratorReturningAsyncIterable: + +PYI034.py:327:9: PYI034 [*] `__new__` methods in classes like `NonGeneric1` usually return `self` at runtime + | +326 | class NonGeneric1(tuple): +327 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + | ^^^^^^^ PYI034 +328 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... + | + = help: Use `Self` as return type + +ℹ Unsafe fix +324 324 | +325 325 | +326 326 | class NonGeneric1(tuple): +327 |- def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + 327 |+ def __new__(cls, *args, **kwargs) -> typing.Self: ... +328 328 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... +329 329 | +330 330 | class NonGeneric2(tuple): + +PYI034.py:328:9: PYI034 [*] `__enter__` methods in classes like `NonGeneric1` usually return `self` at runtime + | +326 | class NonGeneric1(tuple): +327 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... +328 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... + | ^^^^^^^^^ PYI034 +329 | +330 | class NonGeneric2(tuple): + | + = help: Use `Self` as return type + +ℹ Unsafe fix +325 325 | +326 326 | class NonGeneric1(tuple): +327 327 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... +328 |- def __enter__(self: NonGeneric1) -> NonGeneric1: ... + 328 |+ def __enter__(self) -> typing.Self: ... +329 329 | +330 330 | class NonGeneric2(tuple): +331 331 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + +PYI034.py:331:9: PYI034 [*] `__new__` methods in classes like `NonGeneric2` usually return `self` at runtime + | +330 | class NonGeneric2(tuple): +331 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + | ^^^^^^^ PYI034 +332 | +333 | class Generic1[T](list): + | + = help: Use `Self` as return type + +ℹ Unsafe fix +328 328 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... +329 329 | +330 330 | class NonGeneric2(tuple): +331 |- def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + 331 |+ def __new__(cls) -> typing.Self: ... +332 332 | +333 333 | class Generic1[T](list): +334 334 | def __new__(cls: type[Generic1]) -> Generic1: ... + +PYI034.py:334:9: PYI034 `__new__` methods in classes like `Generic1` usually return `self` at runtime + | +333 | class Generic1[T](list): +334 | def __new__(cls: type[Generic1]) -> Generic1: ... + | ^^^^^^^ PYI034 +335 | def __enter__(self: Generic1) -> Generic1: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +331 331 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... +332 332 | +333 333 | class Generic1[T](list): +334 |- def __new__(cls: type[Generic1]) -> Generic1: ... + 334 |+ def __new__(cls) -> typing.Self: ... +335 335 | def __enter__(self: Generic1) -> Generic1: ... +336 336 | +337 337 | + +PYI034.py:335:9: PYI034 `__enter__` methods in classes like `Generic1` usually return `self` at runtime + | +333 | class Generic1[T](list): +334 | def __new__(cls: type[Generic1]) -> Generic1: ... +335 | def __enter__(self: Generic1) -> Generic1: ... + | ^^^^^^^^^ PYI034 + | + = help: Use `Self` as return type + +ℹ Display-only fix +332 332 | +333 333 | class Generic1[T](list): +334 334 | def __new__(cls: type[Generic1]) -> Generic1: ... +335 |- def __enter__(self: Generic1) -> Generic1: ... + 335 |+ def __enter__(self) -> typing.Self: ... +336 336 | +337 337 | +338 338 | ### Correctness of typevar-likes are not verified. + +PYI034.py:345:9: PYI034 `__new__` methods in classes like `Generic2` usually return `self` at runtime + | +344 | class Generic2(Generic[T]): +345 | def __new__(cls: type[Generic2]) -> Generic2: ... + | ^^^^^^^ PYI034 +346 | def __enter__(self: Generic2) -> Generic2: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +342 342 | Ts = TypeVarTuple('foo') +343 343 | +344 344 | class Generic2(Generic[T]): +345 |- def __new__(cls: type[Generic2]) -> Generic2: ... + 345 |+ def __new__(cls) -> typing.Self: ... +346 346 | def __enter__(self: Generic2) -> Generic2: ... +347 347 | +348 348 | class Generic3(tuple[*Ts]): + +PYI034.py:346:9: PYI034 `__enter__` methods in classes like `Generic2` usually return `self` at runtime + | +344 | class Generic2(Generic[T]): +345 | def __new__(cls: type[Generic2]) -> Generic2: ... +346 | def __enter__(self: Generic2) -> Generic2: ... + | ^^^^^^^^^ PYI034 +347 | +348 | class Generic3(tuple[*Ts]): + | + = help: Use `Self` as return type + +ℹ Display-only fix +343 343 | +344 344 | class Generic2(Generic[T]): +345 345 | def __new__(cls: type[Generic2]) -> Generic2: ... +346 |- def __enter__(self: Generic2) -> Generic2: ... + 346 |+ def __enter__(self) -> typing.Self: ... +347 347 | +348 348 | class Generic3(tuple[*Ts]): +349 349 | def __new__(cls: type[Generic3]) -> Generic3: ... + +PYI034.py:349:9: PYI034 `__new__` methods in classes like `Generic3` usually return `self` at runtime + | +348 | class Generic3(tuple[*Ts]): +349 | def __new__(cls: type[Generic3]) -> Generic3: ... + | ^^^^^^^ PYI034 +350 | def __enter__(self: Generic3) -> Generic3: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +346 346 | def __enter__(self: Generic2) -> Generic2: ... +347 347 | +348 348 | class Generic3(tuple[*Ts]): +349 |- def __new__(cls: type[Generic3]) -> Generic3: ... + 349 |+ def __new__(cls) -> typing.Self: ... +350 350 | def __enter__(self: Generic3) -> Generic3: ... +351 351 | +352 352 | class Generic4(collections.abc.Callable[P, ...]): + +PYI034.py:350:9: PYI034 `__enter__` methods in classes like `Generic3` usually return `self` at runtime + | +348 | class Generic3(tuple[*Ts]): +349 | def __new__(cls: type[Generic3]) -> Generic3: ... +350 | def __enter__(self: Generic3) -> Generic3: ... + | ^^^^^^^^^ PYI034 +351 | +352 | class Generic4(collections.abc.Callable[P, ...]): + | + = help: Use `Self` as return type + +ℹ Display-only fix +347 347 | +348 348 | class Generic3(tuple[*Ts]): +349 349 | def __new__(cls: type[Generic3]) -> Generic3: ... +350 |- def __enter__(self: Generic3) -> Generic3: ... + 350 |+ def __enter__(self) -> typing.Self: ... +351 351 | +352 352 | class Generic4(collections.abc.Callable[P, ...]): +353 353 | def __new__(cls: type[Generic4]) -> Generic4: ... + +PYI034.py:353:9: PYI034 `__new__` methods in classes like `Generic4` usually return `self` at runtime + | +352 | class Generic4(collections.abc.Callable[P, ...]): +353 | def __new__(cls: type[Generic4]) -> Generic4: ... + | ^^^^^^^ PYI034 +354 | def __enter__(self: Generic4) -> Generic4: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +350 350 | def __enter__(self: Generic3) -> Generic3: ... +351 351 | +352 352 | class Generic4(collections.abc.Callable[P, ...]): +353 |- def __new__(cls: type[Generic4]) -> Generic4: ... + 353 |+ def __new__(cls) -> typing.Self: ... +354 354 | def __enter__(self: Generic4) -> Generic4: ... +355 355 | +356 356 | from some_module import PotentialTypeVar + +PYI034.py:354:9: PYI034 `__enter__` methods in classes like `Generic4` usually return `self` at runtime + | +352 | class Generic4(collections.abc.Callable[P, ...]): +353 | def __new__(cls: type[Generic4]) -> Generic4: ... +354 | def __enter__(self: Generic4) -> Generic4: ... + | ^^^^^^^^^ PYI034 +355 | +356 | from some_module import PotentialTypeVar + | + = help: Use `Self` as return type + +ℹ Display-only fix +351 351 | +352 352 | class Generic4(collections.abc.Callable[P, ...]): +353 353 | def __new__(cls: type[Generic4]) -> Generic4: ... +354 |- def __enter__(self: Generic4) -> Generic4: ... + 354 |+ def __enter__(self) -> typing.Self: ... +355 355 | +356 356 | from some_module import PotentialTypeVar +357 357 | + +PYI034.py:359:9: PYI034 [*] `__new__` methods in classes like `Generic5` usually return `self` at runtime + | +358 | class Generic5(list[PotentialTypeVar]): +359 | def __new__(cls: type[Generic5]) -> Generic5: ... + | ^^^^^^^ PYI034 +360 | def __enter__(self: Generic5) -> Generic5: ... + | + = help: Use `Self` as return type + +ℹ Unsafe fix +356 356 | from some_module import PotentialTypeVar +357 357 | +358 358 | class Generic5(list[PotentialTypeVar]): +359 |- def __new__(cls: type[Generic5]) -> Generic5: ... + 359 |+ def __new__(cls) -> typing.Self: ... +360 360 | def __enter__(self: Generic5) -> Generic5: ... +361 361 | + +PYI034.py:360:9: PYI034 [*] `__enter__` methods in classes like `Generic5` usually return `self` at runtime + | +358 | class Generic5(list[PotentialTypeVar]): +359 | def __new__(cls: type[Generic5]) -> Generic5: ... +360 | def __enter__(self: Generic5) -> Generic5: ... + | ^^^^^^^^^ PYI034 + | + = help: Use `Self` as return type + +ℹ Unsafe fix +357 357 | +358 358 | class Generic5(list[PotentialTypeVar]): +359 359 | def __new__(cls: type[Generic5]) -> Generic5: ... +360 |- def __enter__(self: Generic5) -> Generic5: ... + 360 |+ def __enter__(self) -> typing.Self: ... +361 361 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.pyi.snap index 6441209dd6cd4..49952c3ef7584 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI034_PYI034.pyi.snap @@ -1,51 +1,91 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI034.pyi:20:9: PYI034 `__new__` methods in classes like `Bad` usually return `self` at runtime +PYI034.pyi:20:9: PYI034 [*] `__new__` methods in classes like `Bad` usually return `self` at runtime | 18 | object 19 | ): # Y040 Do not inherit from "object" explicitly, as it is redundant in Python 3 20 | def __new__( | ^^^^^^^ PYI034 21 | cls, *args: Any, **kwargs: Any -22 | ) -> Bad: ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g. "def __new__(cls, *args: Any, **kwargs: Any) -> Self: ..." +22 | ) -> Bad: ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__"… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.pyi:35:9: PYI034 `__enter__` methods in classes like `Bad` usually return `self` at runtime +ℹ Unsafe fix +19 19 | ): # Y040 Do not inherit from "object" explicitly, as it is redundant in Python 3 +20 20 | def __new__( +21 21 | cls, *args: Any, **kwargs: Any +22 |- ) -> Bad: ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g. "def __new__(cls, *args: Any, **kwargs: Any) -> Self: ..." + 22 |+ ) -> typing.Self: ... # Y034 "__new__" methods usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__new__", e.g. "def __new__(cls, *args: Any, **kwargs: Any) -> Self: ..." +23 23 | def __repr__( +24 24 | self, +25 25 | ) -> str: ... # Y029 Defining __repr__ or __str__ in a stub is almost always redundant + +PYI034.pyi:35:9: PYI034 [*] `__enter__` methods in classes like `Bad` usually return `self` at runtime | 33 | self, other: typing.Any 34 | ) -> typing.Any: ... # Y032 Prefer "object" to "Any" for the second parameter in "__ne__" methods 35 | def __enter__( | ^^^^^^^^^ PYI034 36 | self, -37 | ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +37 | ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extension… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +34 34 | ) -> typing.Any: ... # Y032 Prefer "object" to "Any" for the second parameter in "__ne__" methods +35 35 | def __enter__( +36 36 | self, +37 |- ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." + 37 |+ ) -> typing.Self: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +38 38 | async def __aenter__( +39 39 | self, +40 40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." -PYI034.pyi:38:15: PYI034 `__aenter__` methods in classes like `Bad` usually return `self` at runtime +PYI034.pyi:38:15: PYI034 [*] `__aenter__` methods in classes like `Bad` usually return `self` at runtime | 36 | self, -37 | ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +37 | ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extension… 38 | async def __aenter__( | ^^^^^^^^^^ PYI034 39 | self, -40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensio… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +37 37 | ) -> Bad: ... # Y034 "__enter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__enter__", e.g. "def __enter__(self) -> Self: ..." +38 38 | async def __aenter__( +39 39 | self, +40 |- ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." + 40 |+ ) -> typing.Self: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +41 41 | def __iadd__( +42 42 | self, other: Bad +43 43 | ) -> Bad: ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." -PYI034.pyi:41:9: PYI034 `__iadd__` methods in classes like `Bad` usually return `self` at runtime +PYI034.pyi:41:9: PYI034 [*] `__iadd__` methods in classes like `Bad` usually return `self` at runtime | 39 | self, -40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensio… 41 | def __iadd__( | ^^^^^^^^ PYI034 42 | self, other: Bad -43 | ) -> Bad: ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." +43 | ) -> Bad: ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions… | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.pyi:104:9: PYI034 `__iter__` methods in classes like `BadIterator1` usually return `self` at runtime +ℹ Unsafe fix +40 40 | ) -> Bad: ... # Y034 "__aenter__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__aenter__", e.g. "async def __aenter__(self) -> Self: ..." +41 41 | def __iadd__( +42 42 | self, other: Bad +43 |- ) -> Bad: ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." + 43 |+ ) -> typing.Self: ... # Y034 "__iadd__" methods in classes like "Bad" usually return "self" at runtime. Consider using "typing_extensions.Self" in "Bad.__iadd__", e.g. "def __iadd__(self, other: Bad) -> Self: ..." +44 44 | +45 45 | class AlsoBad( +46 46 | int, builtins.object + +PYI034.pyi:104:9: PYI034 [*] `__iter__` methods in classes like `BadIterator1` usually return `self` at runtime | 103 | class BadIterator1(Iterator[int]): 104 | def __iter__( @@ -53,9 +93,21 @@ PYI034.pyi:104:9: PYI034 `__iter__` methods in classes like `BadIterator1` usual 105 | self, 106 | ) -> Iterator[ | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +103 103 | class BadIterator1(Iterator[int]): +104 104 | def __iter__( +105 105 | self, +106 |- ) -> Iterator[ +107 |- int +108 |- ]: ... # Y034 "__iter__" methods in classes like "BadIterator1" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator1.__iter__", e.g. "def __iter__(self) -> Self: ..." + 106 |+ ) -> typing.Self: ... # Y034 "__iter__" methods in classes like "BadIterator1" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator1.__iter__", e.g. "def __iter__(self) -> Self: ..." +109 107 | +110 108 | class BadIterator2( +111 109 | typing.Iterator[int] -PYI034.pyi:113:9: PYI034 `__iter__` methods in classes like `BadIterator2` usually return `self` at runtime +PYI034.pyi:113:9: PYI034 [*] `__iter__` methods in classes like `BadIterator2` usually return `self` at runtime | 111 | typing.Iterator[int] 112 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) @@ -64,9 +116,21 @@ PYI034.pyi:113:9: PYI034 `__iter__` methods in classes like `BadIterator2` usual 114 | self, 115 | ) -> Iterator[ | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.pyi:122:9: PYI034 `__iter__` methods in classes like `BadIterator3` usually return `self` at runtime +ℹ Unsafe fix +112 112 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) +113 113 | def __iter__( +114 114 | self, +115 |- ) -> Iterator[ +116 |- int +117 |- ]: ... # Y034 "__iter__" methods in classes like "BadIterator2" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator2.__iter__", e.g. "def __iter__(self) -> Self: ..." + 115 |+ ) -> typing.Self: ... # Y034 "__iter__" methods in classes like "BadIterator2" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator2.__iter__", e.g. "def __iter__(self) -> Self: ..." +118 116 | +119 117 | class BadIterator3( +120 118 | typing.Iterator[int] + +PYI034.pyi:122:9: PYI034 [*] `__iter__` methods in classes like `BadIterator3` usually return `self` at runtime | 120 | typing.Iterator[int] 121 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) @@ -75,9 +139,21 @@ PYI034.pyi:122:9: PYI034 `__iter__` methods in classes like `BadIterator3` usual 123 | self, 124 | ) -> collections.abc.Iterator[ | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +121 121 | ): # Y022 Use "collections.abc.Iterator[T]" instead of "typing.Iterator[T]" (PEP 585 syntax) +122 122 | def __iter__( +123 123 | self, +124 |- ) -> collections.abc.Iterator[ +125 |- int +126 |- ]: ... # Y034 "__iter__" methods in classes like "BadIterator3" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator3.__iter__", e.g. "def __iter__(self) -> Self: ..." + 124 |+ ) -> typing.Self: ... # Y034 "__iter__" methods in classes like "BadIterator3" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator3.__iter__", e.g. "def __iter__(self) -> Self: ..." +127 125 | +128 126 | class BadIterator4(Iterator[int]): +129 127 | # Note: *Iterable*, not *Iterator*, returned! -PYI034.pyi:130:9: PYI034 `__iter__` methods in classes like `BadIterator4` usually return `self` at runtime +PYI034.pyi:130:9: PYI034 [*] `__iter__` methods in classes like `BadIterator4` usually return `self` at runtime | 128 | class BadIterator4(Iterator[int]): 129 | # Note: *Iterable*, not *Iterator*, returned! @@ -86,9 +162,21 @@ PYI034.pyi:130:9: PYI034 `__iter__` methods in classes like `BadIterator4` usual 131 | self, 132 | ) -> Iterable[ | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type -PYI034.pyi:144:9: PYI034 `__aiter__` methods in classes like `BadAsyncIterator` usually return `self` at runtime +ℹ Unsafe fix +129 129 | # Note: *Iterable*, not *Iterator*, returned! +130 130 | def __iter__( +131 131 | self, +132 |- ) -> Iterable[ +133 |- int +134 |- ]: ... # Y034 "__iter__" methods in classes like "BadIterator4" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator4.__iter__", e.g. "def __iter__(self) -> Self: ..." + 132 |+ ) -> typing.Self: ... # Y034 "__iter__" methods in classes like "BadIterator4" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadIterator4.__iter__", e.g. "def __iter__(self) -> Self: ..." +135 133 | +136 134 | class IteratorReturningIterable: +137 135 | def __iter__( + +PYI034.pyi:144:9: PYI034 [*] `__aiter__` methods in classes like `BadAsyncIterator` usually return `self` at runtime | 143 | class BadAsyncIterator(collections.abc.AsyncIterator[str]): 144 | def __aiter__( @@ -96,6 +184,267 @@ PYI034.pyi:144:9: PYI034 `__aiter__` methods in classes like `BadAsyncIterator` 145 | self, 146 | ) -> typing.AsyncIterator[ | - = help: Consider using `typing_extensions.Self` as return type + = help: Use `Self` as return type + +ℹ Unsafe fix +143 143 | class BadAsyncIterator(collections.abc.AsyncIterator[str]): +144 144 | def __aiter__( +145 145 | self, +146 |- ) -> typing.AsyncIterator[ +147 |- str +148 |- ]: ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadAsyncIterator.__aiter__", e.g. "def __aiter__(self) -> Self: ..." # Y022 Use "collections.abc.AsyncIterator[T]" instead of "typing.AsyncIterator[T]" (PEP 585 syntax) + 146 |+ ) -> typing.Self: ... # Y034 "__aiter__" methods in classes like "BadAsyncIterator" usually return "self" at runtime. Consider using "typing_extensions.Self" in "BadAsyncIterator.__aiter__", e.g. "def __aiter__(self) -> Self: ..." # Y022 Use "collections.abc.AsyncIterator[T]" instead of "typing.AsyncIterator[T]" (PEP 585 syntax) +149 147 | +150 148 | class AsyncIteratorReturningAsyncIterable: +151 149 | def __aiter__( + +PYI034.pyi:221:9: PYI034 [*] `__new__` methods in classes like `NonGeneric1` usually return `self` at runtime + | +220 | class NonGeneric1(tuple): +221 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + | ^^^^^^^ PYI034 +222 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... + | + = help: Use `Self` as return type + +ℹ Unsafe fix +218 218 | +219 219 | +220 220 | class NonGeneric1(tuple): +221 |- def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... + 221 |+ def __new__(cls, *args, **kwargs) -> typing.Self: ... +222 222 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... +223 223 | +224 224 | class NonGeneric2(tuple): + +PYI034.pyi:222:9: PYI034 [*] `__enter__` methods in classes like `NonGeneric1` usually return `self` at runtime + | +220 | class NonGeneric1(tuple): +221 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... +222 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... + | ^^^^^^^^^ PYI034 +223 | +224 | class NonGeneric2(tuple): + | + = help: Use `Self` as return type +ℹ Unsafe fix +219 219 | +220 220 | class NonGeneric1(tuple): +221 221 | def __new__(cls: type[NonGeneric1], *args, **kwargs) -> NonGeneric1: ... +222 |- def __enter__(self: NonGeneric1) -> NonGeneric1: ... + 222 |+ def __enter__(self) -> typing.Self: ... +223 223 | +224 224 | class NonGeneric2(tuple): +225 225 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + +PYI034.pyi:225:9: PYI034 [*] `__new__` methods in classes like `NonGeneric2` usually return `self` at runtime + | +224 | class NonGeneric2(tuple): +225 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + | ^^^^^^^ PYI034 +226 | +227 | class Generic1[T](list): + | + = help: Use `Self` as return type + +ℹ Unsafe fix +222 222 | def __enter__(self: NonGeneric1) -> NonGeneric1: ... +223 223 | +224 224 | class NonGeneric2(tuple): +225 |- def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... + 225 |+ def __new__(cls) -> typing.Self: ... +226 226 | +227 227 | class Generic1[T](list): +228 228 | def __new__(cls: type[Generic1]) -> Generic1: ... + +PYI034.pyi:228:9: PYI034 `__new__` methods in classes like `Generic1` usually return `self` at runtime + | +227 | class Generic1[T](list): +228 | def __new__(cls: type[Generic1]) -> Generic1: ... + | ^^^^^^^ PYI034 +229 | def __enter__(self: Generic1) -> Generic1: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +225 225 | def __new__(cls: Type[NonGeneric2]) -> NonGeneric2: ... +226 226 | +227 227 | class Generic1[T](list): +228 |- def __new__(cls: type[Generic1]) -> Generic1: ... + 228 |+ def __new__(cls) -> typing.Self: ... +229 229 | def __enter__(self: Generic1) -> Generic1: ... +230 230 | +231 231 | + +PYI034.pyi:229:9: PYI034 `__enter__` methods in classes like `Generic1` usually return `self` at runtime + | +227 | class Generic1[T](list): +228 | def __new__(cls: type[Generic1]) -> Generic1: ... +229 | def __enter__(self: Generic1) -> Generic1: ... + | ^^^^^^^^^ PYI034 + | + = help: Use `Self` as return type + +ℹ Display-only fix +226 226 | +227 227 | class Generic1[T](list): +228 228 | def __new__(cls: type[Generic1]) -> Generic1: ... +229 |- def __enter__(self: Generic1) -> Generic1: ... + 229 |+ def __enter__(self) -> typing.Self: ... +230 230 | +231 231 | +232 232 | ### Correctness of typevar-likes are not verified. + +PYI034.pyi:239:9: PYI034 `__new__` methods in classes like `Generic2` usually return `self` at runtime + | +238 | class Generic2(Generic[T]): +239 | def __new__(cls: type[Generic2]) -> Generic2: ... + | ^^^^^^^ PYI034 +240 | def __enter__(self: Generic2) -> Generic2: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +236 236 | Ts = TypeVarTuple('foo') +237 237 | +238 238 | class Generic2(Generic[T]): +239 |- def __new__(cls: type[Generic2]) -> Generic2: ... + 239 |+ def __new__(cls) -> typing.Self: ... +240 240 | def __enter__(self: Generic2) -> Generic2: ... +241 241 | +242 242 | class Generic3(tuple[*Ts]): + +PYI034.pyi:240:9: PYI034 `__enter__` methods in classes like `Generic2` usually return `self` at runtime + | +238 | class Generic2(Generic[T]): +239 | def __new__(cls: type[Generic2]) -> Generic2: ... +240 | def __enter__(self: Generic2) -> Generic2: ... + | ^^^^^^^^^ PYI034 +241 | +242 | class Generic3(tuple[*Ts]): + | + = help: Use `Self` as return type + +ℹ Display-only fix +237 237 | +238 238 | class Generic2(Generic[T]): +239 239 | def __new__(cls: type[Generic2]) -> Generic2: ... +240 |- def __enter__(self: Generic2) -> Generic2: ... + 240 |+ def __enter__(self) -> typing.Self: ... +241 241 | +242 242 | class Generic3(tuple[*Ts]): +243 243 | def __new__(cls: type[Generic3]) -> Generic3: ... + +PYI034.pyi:243:9: PYI034 `__new__` methods in classes like `Generic3` usually return `self` at runtime + | +242 | class Generic3(tuple[*Ts]): +243 | def __new__(cls: type[Generic3]) -> Generic3: ... + | ^^^^^^^ PYI034 +244 | def __enter__(self: Generic3) -> Generic3: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +240 240 | def __enter__(self: Generic2) -> Generic2: ... +241 241 | +242 242 | class Generic3(tuple[*Ts]): +243 |- def __new__(cls: type[Generic3]) -> Generic3: ... + 243 |+ def __new__(cls) -> typing.Self: ... +244 244 | def __enter__(self: Generic3) -> Generic3: ... +245 245 | +246 246 | class Generic4(collections.abc.Callable[P, ...]): + +PYI034.pyi:244:9: PYI034 `__enter__` methods in classes like `Generic3` usually return `self` at runtime + | +242 | class Generic3(tuple[*Ts]): +243 | def __new__(cls: type[Generic3]) -> Generic3: ... +244 | def __enter__(self: Generic3) -> Generic3: ... + | ^^^^^^^^^ PYI034 +245 | +246 | class Generic4(collections.abc.Callable[P, ...]): + | + = help: Use `Self` as return type + +ℹ Display-only fix +241 241 | +242 242 | class Generic3(tuple[*Ts]): +243 243 | def __new__(cls: type[Generic3]) -> Generic3: ... +244 |- def __enter__(self: Generic3) -> Generic3: ... + 244 |+ def __enter__(self) -> typing.Self: ... +245 245 | +246 246 | class Generic4(collections.abc.Callable[P, ...]): +247 247 | def __new__(cls: type[Generic4]) -> Generic4: ... + +PYI034.pyi:247:9: PYI034 `__new__` methods in classes like `Generic4` usually return `self` at runtime + | +246 | class Generic4(collections.abc.Callable[P, ...]): +247 | def __new__(cls: type[Generic4]) -> Generic4: ... + | ^^^^^^^ PYI034 +248 | def __enter__(self: Generic4) -> Generic4: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +244 244 | def __enter__(self: Generic3) -> Generic3: ... +245 245 | +246 246 | class Generic4(collections.abc.Callable[P, ...]): +247 |- def __new__(cls: type[Generic4]) -> Generic4: ... + 247 |+ def __new__(cls) -> typing.Self: ... +248 248 | def __enter__(self: Generic4) -> Generic4: ... +249 249 | +250 250 | from some_module import PotentialTypeVar + +PYI034.pyi:248:9: PYI034 `__enter__` methods in classes like `Generic4` usually return `self` at runtime + | +246 | class Generic4(collections.abc.Callable[P, ...]): +247 | def __new__(cls: type[Generic4]) -> Generic4: ... +248 | def __enter__(self: Generic4) -> Generic4: ... + | ^^^^^^^^^ PYI034 +249 | +250 | from some_module import PotentialTypeVar + | + = help: Use `Self` as return type + +ℹ Display-only fix +245 245 | +246 246 | class Generic4(collections.abc.Callable[P, ...]): +247 247 | def __new__(cls: type[Generic4]) -> Generic4: ... +248 |- def __enter__(self: Generic4) -> Generic4: ... + 248 |+ def __enter__(self) -> typing.Self: ... +249 249 | +250 250 | from some_module import PotentialTypeVar +251 251 | + +PYI034.pyi:253:9: PYI034 `__new__` methods in classes like `Generic5` usually return `self` at runtime + | +252 | class Generic5(list[PotentialTypeVar]): +253 | def __new__(cls: type[Generic5]) -> Generic5: ... + | ^^^^^^^ PYI034 +254 | def __enter__(self: Generic5) -> Generic5: ... + | + = help: Use `Self` as return type + +ℹ Display-only fix +250 250 | from some_module import PotentialTypeVar +251 251 | +252 252 | class Generic5(list[PotentialTypeVar]): +253 |- def __new__(cls: type[Generic5]) -> Generic5: ... + 253 |+ def __new__(cls) -> typing.Self: ... +254 254 | def __enter__(self: Generic5) -> Generic5: ... + +PYI034.pyi:254:9: PYI034 `__enter__` methods in classes like `Generic5` usually return `self` at runtime + | +252 | class Generic5(list[PotentialTypeVar]): +253 | def __new__(cls: type[Generic5]) -> Generic5: ... +254 | def __enter__(self: Generic5) -> Generic5: ... + | ^^^^^^^^^ PYI034 + | + = help: Use `Self` as return type +ℹ Display-only fix +251 251 | +252 252 | class Generic5(list[PotentialTypeVar]): +253 253 | def __new__(cls: type[Generic5]) -> Generic5: ... +254 |- def __enter__(self: Generic5) -> Generic5: ... + 254 |+ def __enter__(self) -> typing.Self: ... diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.pyi.snap index 916bdb443a4c4..7a6209c383d22 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI035_PYI035.pyi.snap @@ -5,7 +5,7 @@ PYI035.pyi:1:1: PYI035 `__all__` in a stub file must have a value, as it has the | 1 | __all__: list[str] # Error: PYI035 | ^^^^^^^^^^^^^^^^^^ PYI035 -2 | +2 | 3 | __all__: list[str] = ["foo"] | @@ -24,8 +24,6 @@ PYI035.pyi:8:5: PYI035 `__slots__` in a stub file must have a value, as it has t 7 | __match_args__: tuple[str, ...] # Error: PYI035 8 | __slots__: tuple[str, ...] # Error: PYI035 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI035 - 9 | + 9 | 10 | class Bar: | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.py.snap index 2f3dc38a504bd..34e31a8ea7aa3 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.py.snap @@ -26,7 +26,7 @@ PYI036.py:55:24: PYI036 If there are no star-args, `__aexit__` should have at le 54 | def __exit__(self, *args: Any) -> None: ... # PYI036: Bad star-args annotation 55 | async def __aexit__(self) -> None: ... # PYI036: Missing args | ^^^^^^ PYI036 -56 | +56 | 57 | class BadTwo: | @@ -44,54 +44,54 @@ PYI036.py:59:48: PYI036 All keyword-only arguments in `__aexit__` must have a de 58 | def __exit__(self, typ, exc, tb, weird_extra_arg) -> None: ... # PYI036: Extra arg must have default 59 | async def __aexit__(self, typ, exc, tb, *, weird_extra_arg) -> None: ...# PYI036: Extra arg must have default | ^^^^^^^^^^^^^^^ PYI036 -60 | +60 | 61 | class BadThree: | PYI036.py:62:29: PYI036 The first argument in `__exit__` should be annotated with `object` or `type[BaseException] | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… | ^^^^^^^^^^^^^^^^^^^ PYI036 -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | PYI036.py:63:73: PYI036 The second argument in `__aexit__` should be annotated with `object` or `BaseException | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | ^^^^^^^^^^^^^ PYI036 -64 | +64 | 65 | class BadFour: | PYI036.py:63:94: PYI036 The third argument in `__aexit__` should be annotated with `object` or `types.TracebackType | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | ^^^^^^^^^^^^^ PYI036 -64 | +64 | 65 | class BadFour: | PYI036.py:66:111: PYI036 The third argument in `__exit__` should be annotated with `object` or `types.TracebackType | None` | -65 | class BadFour: -66 | def __exit__(self, typ: typing.Optional[type[BaseException]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation - | ^^^^^^^^^^^^^ PYI036 -67 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad annotation +65 | … +66 | …xception]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation + | ^^^^^^^^^^^^^ PYI036 +67 | …n] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad… | PYI036.py:67:101: PYI036 The third argument in `__aexit__` should be annotated with `object` or `types.TracebackType | None` | -65 | class BadFour: -66 | def __exit__(self, typ: typing.Optional[type[BaseException]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation -67 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad annotation - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI036 -68 | -69 | class BadFive: +65 | … +66 | …eption]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation +67 | … | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad a… + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI036 +68 | … +69 | … | PYI036.py:70:29: PYI036 The first argument in `__exit__` should be annotated with `object` or `type[BaseException] | None` @@ -99,7 +99,7 @@ PYI036.py:70:29: PYI036 The first argument in `__exit__` should be annotated wit 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation | ^^^^^^^^^^^^^^^^^^^^ PYI036 -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | PYI036.py:70:58: PYI036 [*] Star-args in `__exit__` should be annotated with `object` @@ -107,7 +107,7 @@ PYI036.py:70:58: PYI036 [*] Star-args in `__exit__` should be annotated with `ob 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation | ^^^^^^^^^ PYI036 -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | = help: Annotate star-args with `object` @@ -125,9 +125,9 @@ PYI036.py:71:74: PYI036 [*] Star-args in `__aexit__` should be annotated with `o | 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | ^^^ PYI036 -72 | +72 | 73 | class BadSix: | = help: Annotate star-args with `object` @@ -156,7 +156,7 @@ PYI036.py:75:48: PYI036 All keyword-only arguments in `__aexit__` must have a de 74 | def __exit__(self, typ, exc, tb, weird_extra_arg, extra_arg2 = None) -> None: ... # PYI036: Extra arg must have default 75 | async def __aexit__(self, typ, exc, tb, *, weird_extra_arg) -> None: ... # PYI036: kwargs must have default | ^^^^^^^^^^^^^^^ PYI036 -76 | +76 | 77 | class AllPositionalOnlyArgs: | @@ -174,7 +174,7 @@ PYI036.py:83:95: PYI036 The third argument in `__aexit__` should be annotated wi 82 | def __exit__(self, typ: type[Exception] | None, exc: BaseException | None, tb: TracebackType | None, /) -> None: ... 83 | async def __aexit__(self, typ: type[BaseException] | None, exc: BaseException | None, tb: TracebackType, /) -> None: ... | ^^^^^^^^^^^^^ PYI036 -84 | +84 | 85 | # Definitions not in a class scope can do whatever, we don't care | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.pyi.snap index 7f31ca0ccdf0b..116a7f499e80d 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI036_PYI036.pyi.snap @@ -26,7 +26,7 @@ PYI036.pyi:55:24: PYI036 If there are no star-args, `__aexit__` should have at l 54 | def __exit__(self, *args: Any) -> None: ... # PYI036: Bad star-args annotation 55 | async def __aexit__(self) -> None: ... # PYI036: Missing args | ^^^^^^ PYI036 -56 | +56 | 57 | class BadTwo: | @@ -44,7 +44,7 @@ PYI036.pyi:59:48: PYI036 All keyword-only arguments in `__aexit__` must have a d 58 | def __exit__(self, typ, exc, tb, weird_extra_arg) -> None: ... # PYI036: Extra arg must have default 59 | async def __aexit__(self, typ, exc, tb, *, weird_extra_arg1, weird_extra_arg2) -> None: ...# PYI036: kwargs must have default | ^^^^^^^^^^^^^^^^ PYI036 -60 | +60 | 61 | class BadThree: | @@ -54,54 +54,54 @@ PYI036.pyi:59:66: PYI036 All keyword-only arguments in `__aexit__` must have a d 58 | def __exit__(self, typ, exc, tb, weird_extra_arg) -> None: ... # PYI036: Extra arg must have default 59 | async def __aexit__(self, typ, exc, tb, *, weird_extra_arg1, weird_extra_arg2) -> None: ...# PYI036: kwargs must have default | ^^^^^^^^^^^^^^^^ PYI036 -60 | +60 | 61 | class BadThree: | PYI036.pyi:62:29: PYI036 The first argument in `__exit__` should be annotated with `object` or `type[BaseException] | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… | ^^^^^^^^^^^^^^^^^^^ PYI036 -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | PYI036.pyi:63:73: PYI036 The second argument in `__aexit__` should be annotated with `object` or `BaseException | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | ^^^^^^^^^^^^^ PYI036 -64 | +64 | 65 | class BadFour: | PYI036.pyi:63:94: PYI036 The third argument in `__aexit__` should be annotated with `object` or `types.TracebackType | None` | 61 | class BadThree: -62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg has bad annotation -63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI036: Second arg has bad annotation +62 | def __exit__(self, typ: type[BaseException], exc: BaseException | None, tb: TracebackType | None) -> None: ... # PYI036: First arg… +63 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException, __tb: TracebackType) -> bool | None: ... # PYI0… | ^^^^^^^^^^^^^ PYI036 -64 | +64 | 65 | class BadFour: | PYI036.pyi:66:111: PYI036 The third argument in `__exit__` should be annotated with `object` or `types.TracebackType | None` | -65 | class BadFour: -66 | def __exit__(self, typ: typing.Optional[type[BaseException]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation - | ^^^^^^^^^^^^^ PYI036 -67 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad annotation +65 | … +66 | …xception]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation + | ^^^^^^^^^^^^^ PYI036 +67 | …n] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad… | PYI036.pyi:67:101: PYI036 The third argument in `__aexit__` should be annotated with `object` or `types.TracebackType | None` | -65 | class BadFour: -66 | def __exit__(self, typ: typing.Optional[type[BaseException]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation -67 | async def __aexit__(self, __typ: type[BaseException] | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad annotation - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI036 -68 | -69 | class BadFive: +65 | … +66 | …eption]], exc: typing.Union[BaseException, None], tb: TracebackType) -> None: ... # PYI036: Third arg has bad annotation +67 | … | None, __exc: BaseException | None, __tb: typing.Union[TracebackType, None, int]) -> bool | None: ... # PYI036: Third arg has bad a… + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI036 +68 | … +69 | … | PYI036.pyi:70:29: PYI036 The first argument in `__exit__` should be annotated with `object` or `type[BaseException] | None` @@ -109,7 +109,7 @@ PYI036.pyi:70:29: PYI036 The first argument in `__exit__` should be annotated wi 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation | ^^^^^^^^^^^^^^^^^^^^ PYI036 -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | PYI036.pyi:70:58: PYI036 [*] Star-args in `__exit__` should be annotated with `object` @@ -117,7 +117,7 @@ PYI036.pyi:70:58: PYI036 [*] Star-args in `__exit__` should be annotated with `o 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation | ^^^^^^^^^ PYI036 -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | = help: Annotate star-args with `object` @@ -135,9 +135,9 @@ PYI036.pyi:71:74: PYI036 [*] Star-args in `__aexit__` should be annotated with ` | 69 | class BadFive: 70 | def __exit__(self, typ: BaseException | None, *args: list[str]) -> bool: ... # PYI036: Bad star-args annotation -71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotation +71 | async def __aexit__(self, /, typ: type[BaseException] | None, *args: Any) -> Awaitable[None]: ... # PYI036: Bad star-args annotati… | ^^^ PYI036 -72 | +72 | 73 | class BadSix: | = help: Annotate star-args with `object` @@ -182,7 +182,7 @@ PYI036.pyi:90:95: PYI036 The third argument in `__aexit__` should be annotated w 89 | def __exit__(self, typ: type[Exception] | None, exc: BaseException | None, tb: TracebackType | None, /) -> None: ... 90 | async def __aexit__(self, typ: type[BaseException] | None, exc: BaseException | None, tb: TracebackType, /) -> None: ... | ^^^^^^^^^^^^^ PYI036 -91 | +91 | 92 | # Definitions not in a class scope can do whatever, we don't care | @@ -192,7 +192,7 @@ PYI036.pyi:159:17: PYI036 Annotations for a three-argument `__exit__` overload ( 158 | @overload 159 | def __exit__(self, exc_typ: Exception, exc: Exception, tb: TracebackType) -> None: ... # PYI036 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI036 -160 | +160 | 161 | class UnacceptableOverload2: | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.py.snap index e1721adde5913..b4680e7da885a 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.py.snap @@ -1,50 +1,311 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- -PYI041.py:22:14: PYI041 Use `float` instead of `int | float` +PYI041.py:22:14: PYI041 [*] Use `float` instead of `int | float` | 22 | def f0(arg1: float | int) -> None: | ^^^^^^^^^^^ PYI041 23 | ... | + = help: Remove redundant type -PYI041.py:26:30: PYI041 Use `complex` instead of `float | complex` +ℹ Safe fix +19 19 | ... +20 20 | +21 21 | +22 |-def f0(arg1: float | int) -> None: + 22 |+def f0(arg1: float) -> None: +23 23 | ... +24 24 | +25 25 | + +PYI041.py:26:30: PYI041 [*] Use `complex` instead of `float | complex` | 26 | def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 27 | ... | + = help: Remove redundant type + +ℹ Safe fix +23 23 | ... +24 24 | +25 25 | +26 |-def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: + 26 |+def f1(arg1: float, *, arg2: list[str] | type[bool] | complex) -> None: +27 27 | ... +28 28 | +29 29 | -PYI041.py:30:28: PYI041 Use `float` instead of `int | float` +PYI041.py:30:28: PYI041 [*] Use `float` instead of `int | float` | 30 | def f2(arg1: int, /, arg2: int | int | float) -> None: | ^^^^^^^^^^^^^^^^^ PYI041 31 | ... | + = help: Remove redundant type + +ℹ Safe fix +27 27 | ... +28 28 | +29 29 | +30 |-def f2(arg1: int, /, arg2: int | int | float) -> None: + 30 |+def f2(arg1: int, /, arg2: float) -> None: +31 31 | ... +32 32 | +33 33 | + +PYI041.py:34:26: PYI041 [*] Use `float` instead of `int | float` + | +34 | def f3(arg1: int, *args: Union[int | int | float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +35 | ... + | + = help: Remove redundant type -PYI041.py:38:24: PYI041 Use `float` instead of `int | float` +ℹ Safe fix +31 31 | ... +32 32 | +33 33 | +34 |-def f3(arg1: int, *args: Union[int | int | float]) -> None: + 34 |+def f3(arg1: int, *args: float) -> None: +35 35 | ... +36 36 | +37 37 | + +PYI041.py:38:24: PYI041 [*] Use `float` instead of `int | float` | 38 | async def f4(**kwargs: int | int | float) -> None: | ^^^^^^^^^^^^^^^^^ PYI041 39 | ... | + = help: Remove redundant type + +ℹ Safe fix +35 35 | ... +36 36 | +37 37 | +38 |-async def f4(**kwargs: int | int | float) -> None: + 38 |+async def f4(**kwargs: float) -> None: +39 39 | ... +40 40 | +41 41 | -PYI041.py:46:24: PYI041 Use `complex` instead of `float | complex` +PYI041.py:42:26: PYI041 [*] Use `float` instead of `int | float` | -44 | ... -45 | -46 | def bad(self, arg: int | float | complex) -> None: - | ^^^^^^^^^^^^^^^^^^^^^ PYI041 -47 | ... +42 | def f5(arg1: int, *args: Union[int, int, float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^ PYI041 +43 | ... | + = help: Remove redundant type -PYI041.py:46:24: PYI041 Use `complex` instead of `int | complex` +ℹ Safe fix +39 39 | ... +40 40 | +41 41 | +42 |-def f5(arg1: int, *args: Union[int, int, float]) -> None: + 42 |+def f5(arg1: int, *args: float) -> None: +43 43 | ... +44 44 | +45 45 | + +PYI041.py:46:26: PYI041 [*] Use `float` instead of `int | float` + | +46 | def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +47 | ... + | + = help: Remove redundant type + +ℹ Safe fix +43 43 | ... +44 44 | +45 45 | +46 |-def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: + 46 |+def f6(arg1: int, *args: float) -> None: +47 47 | ... +48 48 | +49 49 | + +PYI041.py:50:26: PYI041 [*] Use `float` instead of `int | float` + | +50 | def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +51 | ... + | + = help: Remove redundant type + +ℹ Safe fix +47 47 | ... +48 48 | +49 49 | +50 |-def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: + 50 |+def f7(arg1: int, *args: float) -> None: +51 51 | ... +52 52 | +53 53 | + +PYI041.py:54:26: PYI041 [*] Use `float` instead of `int | float` + | +54 | def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +55 | ... + | + = help: Remove redundant type + +ℹ Safe fix +51 51 | ... +52 52 | +53 53 | +54 |-def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: + 54 |+def f8(arg1: int, *args: float) -> None: +55 55 | ... +56 56 | +57 57 | + +PYI041.py:59:10: PYI041 [*] Use `complex` instead of `int | float | complex` + | +58 | def f9( +59 | arg: Union[ # comment + | __________^ +60 | | float, # another +61 | | complex, int] + | |_____________________^ PYI041 +62 | ) -> None: +63 | ... | -44 | ... -45 | -46 | def bad(self, arg: int | float | complex) -> None: + = help: Remove redundant type + +ℹ Unsafe fix +56 56 | +57 57 | +58 58 | def f9( +59 |- arg: Union[ # comment +60 |- float, # another +61 |- complex, int] + 59 |+ arg: complex +62 60 | ) -> None: +63 61 | ... +64 62 | + +PYI041.py:67:9: PYI041 [*] Use `complex` instead of `int | float | complex` + | +65 | def f10( +66 | arg: ( +67 | / int | # comment +68 | | float | # another +69 | | complex + | |_______________^ PYI041 +70 | ) +71 | ) -> None: + | + = help: Remove redundant type + +ℹ Unsafe fix +64 64 | +65 65 | def f10( +66 66 | arg: ( +67 |- int | # comment +68 |- float | # another +69 67 | complex +70 68 | ) +71 69 | ) -> None: + +PYI041.py:79:24: PYI041 [*] Use `complex` instead of `int | float | complex` + | +77 | ... +78 | +79 | def bad(self, arg: int | float | complex) -> None: | ^^^^^^^^^^^^^^^^^^^^^ PYI041 -47 | ... +80 | ... + | + = help: Remove redundant type + +ℹ Safe fix +76 76 | def good(self, arg: int) -> None: +77 77 | ... +78 78 | +79 |- def bad(self, arg: int | float | complex) -> None: + 79 |+ def bad(self, arg: complex) -> None: +80 80 | ... +81 81 | +82 82 | def bad2(self, arg: int | Union[float, complex]) -> None: + +PYI041.py:82:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +80 | ... +81 | +82 | def bad2(self, arg: int | Union[float, complex]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +83 | ... | + = help: Remove redundant type +ℹ Safe fix +79 79 | def bad(self, arg: int | float | complex) -> None: +80 80 | ... +81 81 | +82 |- def bad2(self, arg: int | Union[float, complex]) -> None: + 82 |+ def bad2(self, arg: complex) -> None: +83 83 | ... +84 84 | +85 85 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: + +PYI041.py:85:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +83 | ... +84 | +85 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +86 | ... + | + = help: Remove redundant type + +ℹ Safe fix +82 82 | def bad2(self, arg: int | Union[float, complex]) -> None: +83 83 | ... +84 84 | +85 |- def bad3(self, arg: Union[Union[float, complex], int]) -> None: + 85 |+ def bad3(self, arg: complex) -> None: +86 86 | ... +87 87 | +88 88 | def bad4(self, arg: Union[float | complex, int]) -> None: + +PYI041.py:88:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +86 | ... +87 | +88 | def bad4(self, arg: Union[float | complex, int]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +89 | ... + | + = help: Remove redundant type + +ℹ Safe fix +85 85 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: +86 86 | ... +87 87 | +88 |- def bad4(self, arg: Union[float | complex, int]) -> None: + 88 |+ def bad4(self, arg: complex) -> None: +89 89 | ... +90 90 | +91 91 | def bad5(self, arg: int | (float | complex)) -> None: + +PYI041.py:91:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +89 | ... +90 | +91 | def bad5(self, arg: int | (float | complex)) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +92 | ... + | + = help: Remove redundant type +ℹ Safe fix +88 88 | def bad4(self, arg: Union[float | complex, int]) -> None: +89 89 | ... +90 90 | +91 |- def bad5(self, arg: int | (float | complex)) -> None: + 91 |+ def bad5(self, arg: complex) -> None: +92 92 | ... diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.pyi.snap index 914faa51566ad..dbf365cb5bdc7 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI041_PYI041.pyi.snap @@ -1,44 +1,306 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- -PYI041.pyi:21:14: PYI041 Use `float` instead of `int | float` +PYI041.pyi:21:14: PYI041 [*] Use `float` instead of `int | float` | 21 | def f0(arg1: float | int) -> None: ... # PYI041 | ^^^^^^^^^^^ PYI041 | + = help: Remove redundant type -PYI041.pyi:24:30: PYI041 Use `complex` instead of `float | complex` +ℹ Safe fix +18 18 | def good2(arg: int, arg2: int | bool) -> None: ... +19 19 | +20 20 | +21 |-def f0(arg1: float | int) -> None: ... # PYI041 + 21 |+def f0(arg1: float) -> None: ... # PYI041 +22 22 | +23 23 | +24 24 | def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: ... # PYI041 + +PYI041.pyi:24:30: PYI041 [*] Use `complex` instead of `float | complex` | 24 | def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: ... # PYI041 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 | + = help: Remove redundant type + +ℹ Safe fix +21 21 | def f0(arg1: float | int) -> None: ... # PYI041 +22 22 | +23 23 | +24 |-def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: ... # PYI041 + 24 |+def f1(arg1: float, *, arg2: list[str] | type[bool] | complex) -> None: ... # PYI041 +25 25 | +26 26 | +27 27 | def f2(arg1: int, /, arg2: int | int | float) -> None: ... # PYI041 -PYI041.pyi:27:28: PYI041 Use `float` instead of `int | float` +PYI041.pyi:27:28: PYI041 [*] Use `float` instead of `int | float` | 27 | def f2(arg1: int, /, arg2: int | int | float) -> None: ... # PYI041 | ^^^^^^^^^^^^^^^^^ PYI041 | + = help: Remove redundant type + +ℹ Safe fix +24 24 | def f1(arg1: float, *, arg2: float | list[str] | type[bool] | complex) -> None: ... # PYI041 +25 25 | +26 26 | +27 |-def f2(arg1: int, /, arg2: int | int | float) -> None: ... # PYI041 + 27 |+def f2(arg1: int, /, arg2: float) -> None: ... # PYI041 +28 28 | +29 29 | +30 30 | def f3(arg1: int, *args: Union[int | int | float]) -> None: ... # PYI041 + +PYI041.pyi:30:26: PYI041 [*] Use `float` instead of `int | float` + | +30 | def f3(arg1: int, *args: Union[int | int | float]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 + | + = help: Remove redundant type -PYI041.pyi:33:24: PYI041 Use `float` instead of `int | float` +ℹ Safe fix +27 27 | def f2(arg1: int, /, arg2: int | int | float) -> None: ... # PYI041 +28 28 | +29 29 | +30 |-def f3(arg1: int, *args: Union[int | int | float]) -> None: ... # PYI041 + 30 |+def f3(arg1: int, *args: float) -> None: ... # PYI041 +31 31 | +32 32 | +33 33 | async def f4(**kwargs: int | int | float) -> None: ... # PYI041 + +PYI041.pyi:33:24: PYI041 [*] Use `float` instead of `int | float` | 33 | async def f4(**kwargs: int | int | float) -> None: ... # PYI041 | ^^^^^^^^^^^^^^^^^ PYI041 +34 | +35 | def f5( | + = help: Remove redundant type + +ℹ Safe fix +30 30 | def f3(arg1: int, *args: Union[int | int | float]) -> None: ... # PYI041 +31 31 | +32 32 | +33 |-async def f4(**kwargs: int | int | float) -> None: ... # PYI041 + 33 |+async def f4(**kwargs: float) -> None: ... # PYI041 +34 34 | +35 35 | def f5( +36 36 | arg: Union[ # comment -PYI041.pyi:39:24: PYI041 Use `complex` instead of `float | complex` +PYI041.pyi:36:10: PYI041 [*] Use `complex` instead of `int | float | complex` | -37 | def good(self, arg: int) -> None: ... -38 | -39 | def bad(self, arg: int | float | complex) -> None: ... # PYI041 - | ^^^^^^^^^^^^^^^^^^^^^ PYI041 +35 | def f5( +36 | arg: Union[ # comment + | __________^ +37 | | float, # another +38 | | complex, int] + | |_____________________^ PYI041 +39 | ) -> None: ... # PYI041 | + = help: Remove redundant type -PYI041.pyi:39:24: PYI041 Use `complex` instead of `int | complex` +ℹ Unsafe fix +33 33 | async def f4(**kwargs: int | int | float) -> None: ... # PYI041 +34 34 | +35 35 | def f5( +36 |- arg: Union[ # comment +37 |- float, # another +38 |- complex, int] + 36 |+ arg: complex +39 37 | ) -> None: ... # PYI041 +40 38 | +41 39 | def f6( + +PYI041.pyi:43:9: PYI041 [*] Use `complex` instead of `int | float | complex` + | +41 | def f6( +42 | arg: ( +43 | / int | # comment +44 | | float | # another +45 | | complex + | |_______________^ PYI041 +46 | ) +47 | ) -> None: ... # PYI041 + | + = help: Remove redundant type + +ℹ Unsafe fix +40 40 | +41 41 | def f6( +42 42 | arg: ( +43 |- int | # comment +44 |- float | # another +45 43 | complex +46 44 | ) +47 45 | ) -> None: ... # PYI041 + +PYI041.pyi:49:26: PYI041 [*] Use `float` instead of `int | float` + | +47 | ) -> None: ... # PYI041 +48 | +49 | def f5(arg1: int, *args: Union[int, int, float]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^ PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +46 46 | ) +47 47 | ) -> None: ... # PYI041 +48 48 | +49 |-def f5(arg1: int, *args: Union[int, int, float]) -> None: ... # PYI041 + 49 |+def f5(arg1: int, *args: float) -> None: ... # PYI041 +50 50 | +51 51 | +52 52 | def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: ... # PYI041 + +PYI041.pyi:52:26: PYI041 [*] Use `float` instead of `int | float` + | +52 | def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +49 49 | def f5(arg1: int, *args: Union[int, int, float]) -> None: ... # PYI041 +50 50 | +51 51 | +52 |-def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: ... # PYI041 + 52 |+def f6(arg1: int, *args: float) -> None: ... # PYI041 +53 53 | +54 54 | +55 55 | def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: ... # PYI041 + +PYI041.pyi:55:26: PYI041 [*] Use `float` instead of `int | float` + | +55 | def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 | -37 | def good(self, arg: int) -> None: ... -38 | -39 | def bad(self, arg: int | float | complex) -> None: ... # PYI041 + = help: Remove redundant type + +ℹ Safe fix +52 52 | def f6(arg1: int, *args: Union[Union[int, int, float]]) -> None: ... # PYI041 +53 53 | +54 54 | +55 |-def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: ... # PYI041 + 55 |+def f7(arg1: int, *args: float) -> None: ... # PYI041 +56 56 | +57 57 | +58 58 | def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: ... # PYI041 + +PYI041.pyi:58:26: PYI041 [*] Use `float` instead of `int | float` + | +58 | def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +55 55 | def f7(arg1: int, *args: Union[Union[Union[int, int, float]]]) -> None: ... # PYI041 +56 56 | +57 57 | +58 |-def f8(arg1: int, *args: Union[Union[Union[int | int | float]]]) -> None: ... # PYI041 + 58 |+def f8(arg1: int, *args: float) -> None: ... # PYI041 +59 59 | +60 60 | +61 61 | class Foo: + +PYI041.pyi:64:24: PYI041 [*] Use `complex` instead of `int | float | complex` + | +62 | def good(self, arg: int) -> None: ... +63 | +64 | def bad(self, arg: int | float | complex) -> None: ... # PYI041 | ^^^^^^^^^^^^^^^^^^^^^ PYI041 +65 | +66 | def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +61 61 | class Foo: +62 62 | def good(self, arg: int) -> None: ... +63 63 | +64 |- def bad(self, arg: int | float | complex) -> None: ... # PYI041 + 64 |+ def bad(self, arg: complex) -> None: ... # PYI041 +65 65 | +66 66 | def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 +67 67 | + +PYI041.pyi:66:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +64 | def bad(self, arg: int | float | complex) -> None: ... # PYI041 +65 | +66 | def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +67 | +68 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 | + = help: Remove redundant type +ℹ Safe fix +63 63 | +64 64 | def bad(self, arg: int | float | complex) -> None: ... # PYI041 +65 65 | +66 |- def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 + 66 |+ def bad2(self, arg: complex) -> None: ... # PYI041 +67 67 | +68 68 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 +69 69 | + +PYI041.pyi:68:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +66 | def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 +67 | +68 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +69 | +70 | def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +65 65 | +66 66 | def bad2(self, arg: int | Union[float, complex]) -> None: ... # PYI041 +67 67 | +68 |- def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 + 68 |+ def bad3(self, arg: complex) -> None: ... # PYI041 +69 69 | +70 70 | def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 +71 71 | + +PYI041.pyi:70:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +68 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 +69 | +70 | def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI041 +71 | +72 | def bad5(self, arg: int | (float | complex)) -> None: ... # PYI041 + | + = help: Remove redundant type + +ℹ Safe fix +67 67 | +68 68 | def bad3(self, arg: Union[Union[float, complex], int]) -> None: ... # PYI041 +69 69 | +70 |- def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 + 70 |+ def bad4(self, arg: complex) -> None: ... # PYI041 +71 71 | +72 72 | def bad5(self, arg: int | (float | complex)) -> None: ... # PYI041 + +PYI041.pyi:72:25: PYI041 [*] Use `complex` instead of `int | float | complex` + | +70 | def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 +71 | +72 | def bad5(self, arg: int | (float | complex)) -> None: ... # PYI041 + | ^^^^^^^^^^^^^^^^^^^^^^^ PYI041 + | + = help: Remove redundant type +ℹ Safe fix +69 69 | +70 70 | def bad4(self, arg: Union[float | complex, int]) -> None: ... # PYI041 +71 71 | +72 |- def bad5(self, arg: int | (float | complex)) -> None: ... # PYI041 + 72 |+ def bad5(self, arg: complex) -> None: ... # PYI041 diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.py.snap index 539eb12d99a7f..f4b565480be92 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI042.py:10:1: PYI042 Type alias `just_literals_pipe_union` should be CamelCase | 8 | ) - 9 | + 9 | 10 | just_literals_pipe_union: TypeAlias = ( | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI042 11 | Literal[True] | Literal["idk"] @@ -14,7 +14,7 @@ PYI042.py:10:1: PYI042 Type alias `just_literals_pipe_union` should be CamelCase PYI042.py:19:1: PYI042 Type alias `snake_case_alias1` should be CamelCase | 17 | _PrivateAliasS2: TypeAlias = Annotated[str, "also okay"] -18 | +18 | 19 | snake_case_alias1: TypeAlias = str | int # PYI042, since not camel case | ^^^^^^^^^^^^^^^^^ PYI042 20 | _snake_case_alias2: TypeAlias = Literal["whatever"] # PYI042, since not camel case @@ -36,5 +36,3 @@ PYI042.py:27:6: PYI042 Type alias `foo_bar` should be CamelCase | ^^^^^^^ PYI042 28 | type FooBar = int | str | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.pyi.snap index 9d1d034c0018e..7e1457c68b024 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI042_PYI042.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI042.pyi:10:1: PYI042 Type alias `just_literals_pipe_union` should be CamelCase | 8 | ) - 9 | + 9 | 10 | just_literals_pipe_union: TypeAlias = ( | ^^^^^^^^^^^^^^^^^^^^^^^^ PYI042 11 | Literal[True] | Literal["idk"] @@ -14,7 +14,7 @@ PYI042.pyi:10:1: PYI042 Type alias `just_literals_pipe_union` should be CamelCas PYI042.pyi:19:1: PYI042 Type alias `snake_case_alias1` should be CamelCase | 17 | _PrivateAliasS2: TypeAlias = Annotated[str, "also okay"] -18 | +18 | 19 | snake_case_alias1: TypeAlias = str | int # PYI042, since not camel case | ^^^^^^^^^^^^^^^^^ PYI042 20 | _snake_case_alias2: TypeAlias = Literal["whatever"] # PYI042, since not camel case @@ -36,5 +36,3 @@ PYI042.pyi:27:6: PYI042 Type alias `foo_bar` should be CamelCase | ^^^^^^^ PYI042 28 | type FooBar = int | str | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.py.snap index 550ad122d17de..d9a02f87e47bc 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI043.py:10:1: PYI043 Private type alias `_PrivateAliasT` should not be suffixed with `T` (the `T` suffix implies that an object is a `TypeVar`) | 8 | ) - 9 | + 9 | 10 | _PrivateAliasT: TypeAlias = str | int # PYI043, since this ends in a T | ^^^^^^^^^^^^^^ PYI043 11 | _PrivateAliasT2: TypeAlias = typing.Any # PYI043, since this ends in a T @@ -37,5 +37,3 @@ PYI043.py:26:6: PYI043 Private type alias `_FooT` should not be suffixed with `T | ^^^^^ PYI043 27 | type Foo = str | int | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.pyi.snap index 80fb8b4c19182..81526e74634d8 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI043_PYI043.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI043.pyi:10:1: PYI043 Private type alias `_PrivateAliasT` should not be suffixed with `T` (the `T` suffix implies that an object is a `TypeVar`) | 8 | ) - 9 | + 9 | 10 | _PrivateAliasT: TypeAlias = str | int # PYI043, since this ends in a T | ^^^^^^^^^^^^^^ PYI043 11 | _PrivateAliasT2: TypeAlias = typing.Any # PYI043, since this ends in a T @@ -37,5 +37,3 @@ PYI043.pyi:26:6: PYI043 Private type alias `_FooT` should not be suffixed with ` | ^^^^^ PYI043 27 | type Foo = str | int | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.pyi.snap index 94fa6d7a63b8a..bb018c27edb74 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI044_PYI044.pyi.snap @@ -16,7 +16,7 @@ PYI044.pyi:3:1: PYI044 `from __future__ import annotations` has no effect in stu 2 | from __future__ import annotations # PYI044. 3 | from __future__ import annotations, with_statement # PYI044. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI044 -4 | +4 | 5 | # Good imports. | = help: Remove `from __future__ import annotations` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.py.snap index 54d350213456d..39967a4bbd26b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI045.py:12:27: PYI045 `__iter__` methods should return an `Iterator`, not an `Iterable` | @@ -56,5 +57,3 @@ PYI045.py:84:28: PYI045 `__aiter__` methods should return an `AsyncIterator`, no | ^^^^^^^^^^^^^^^^^^^^ PYI045 85 | ... | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.pyi.snap index 475a3f2d2a1a1..bca6451be568b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI045_PYI045.pyi.snap @@ -38,7 +38,7 @@ PYI045.pyi:25:27: PYI045 `__iter__` methods should return an `Iterator`, not an 24 | class IterableReturn: 25 | def __iter__(self) -> Iterable: ... # Error: PYI045 | ^^^^^^^^ PYI045 -26 | +26 | 27 | class IteratorReturn: | @@ -47,7 +47,7 @@ PYI045.pyi:46:28: PYI045 `__aiter__` methods should return an `AsyncIterator`, n 45 | class TypingAsyncIterableTReturn: 46 | def __aiter__(self) -> typing.AsyncIterable[int]: ... # Error: PYI045 | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI045 -47 | +47 | 48 | class TypingAsyncIterableReturn: | @@ -57,5 +57,3 @@ PYI045.pyi:49:28: PYI045 `__aiter__` methods should return an `AsyncIterator`, n 49 | def __aiter__(self) -> typing.AsyncIterable: ... # Error: PYI045 | ^^^^^^^^^^^^^^^^^^^^ PYI045 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.py.snap index 3787d04a3fe52..69f5b98235ea5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI046.py:5:7: PYI046 Private protocol `_Foo` is never used | @@ -21,5 +22,3 @@ PYI046.py:16:7: PYI046 Private protocol `_Baz` is never used | ^^^^ PYI046 17 | x: _T | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.pyi.snap index ce2f2d7bc5897..9cd85868ae671 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI046.pyi:5:7: PYI046 Private protocol `_Foo` is never used | @@ -21,5 +22,3 @@ PYI046.pyi:16:7: PYI046 Private protocol `_Baz` is never used | ^^^^ PYI046 17 | x: _T | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.py.snap index 73a6e051d15b5..3fda1b217df84 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.py.snap @@ -13,14 +13,14 @@ PYI047.py:7:1: PYI047 Private TypeAlias `_T` is never used 6 | _UnusedPrivateTypeAlias: TypeAlias = int | None 7 | _T: typing.TypeAlias = str | ^^ PYI047 -8 | +8 | 9 | # OK | PYI047.py:24:6: PYI047 Private TypeAlias `_UnusedPEP695` is never used | 22 | def func2(arg: _PrivateTypeAlias) -> None: ... -23 | +23 | 24 | type _UnusedPEP695 = int | ^^^^^^^^^^^^^ PYI047 25 | type _UnusedGeneric695[T] = list[T] @@ -31,8 +31,6 @@ PYI047.py:25:6: PYI047 Private TypeAlias `_UnusedGeneric695` is never used 24 | type _UnusedPEP695 = int 25 | type _UnusedGeneric695[T] = list[T] | ^^^^^^^^^^^^^^^^^ PYI047 -26 | +26 | 27 | type _UsedPEP695 = str | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.pyi.snap index 096a1dd558aa6..a27c276530049 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI047_PYI047.pyi.snap @@ -13,14 +13,14 @@ PYI047.pyi:7:1: PYI047 Private TypeAlias `_T` is never used 6 | _UnusedPrivateTypeAlias: TypeAlias = int | None 7 | _T: typing.TypeAlias = str | ^^ PYI047 -8 | +8 | 9 | # OK | PYI047.pyi:24:6: PYI047 Private TypeAlias `_UnusedPEP695` is never used | 22 | def func2(arg: _PrivateTypeAlias) -> None: ... -23 | +23 | 24 | type _UnusedPEP695 = int | ^^^^^^^^^^^^^ PYI047 25 | type _UnusedGeneric695[T] = list[T] @@ -31,8 +31,6 @@ PYI047.pyi:25:6: PYI047 Private TypeAlias `_UnusedGeneric695` is never used 24 | type _UnusedPEP695 = int 25 | type _UnusedGeneric695[T] = list[T] | ^^^^^^^^^^^^^^^^^ PYI047 -26 | +26 | 27 | type _UsedPEP695 = str | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.pyi.snap index adad4a83f7cc9..ffd683822afdf 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI048_PYI048.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI048.pyi:8:5: PYI048 Function body must contain exactly one statement | 6 | """oof""" # OK - 7 | + 7 | 8 | def oof(): # ERROR PYI048 | ^^^ PYI048 9 | """oof""" @@ -14,7 +14,7 @@ PYI048.pyi:8:5: PYI048 Function body must contain exactly one statement PYI048.pyi:12:5: PYI048 Function body must contain exactly one statement | 10 | print("foo") -11 | +11 | 12 | def foo(): # ERROR PYI048 | ^^^ PYI048 13 | """foo""" @@ -24,11 +24,9 @@ PYI048.pyi:12:5: PYI048 Function body must contain exactly one statement PYI048.pyi:17:5: PYI048 Function body must contain exactly one statement | 15 | print("foo") -16 | +16 | 17 | def buzz(): # ERROR PYI048 | ^^^^ PYI048 18 | print("fizz") 19 | print("buzz") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.py.snap index c50ecfef7c7b1..6c5b9a2542cb5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI049.py:5:7: PYI049 Private TypedDict `_UnusedTypedDict` is never used | @@ -21,5 +22,3 @@ PYI049.py:21:1: PYI049 Private TypedDict `_UnusedTypedDict3` is never used | ^^^^^^^^^^^^^^^^^ PYI049 22 | _UsedTypedDict3 = TypedDict("_UsedTypedDict3", {"bar": bytes}) | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.pyi.snap index 189b4bade5d8d..68cfc0c50ff83 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI049_PYI049.pyi.snap @@ -18,7 +18,7 @@ PYI049.pyi:10:7: PYI049 Private TypedDict `_UnusedTypedDict2` is never used PYI049.pyi:34:1: PYI049 Private TypedDict `_UnusedTypedDict3` is never used | 32 | bar: list[int] -33 | +33 | 34 | _UnusedTypedDict3 = TypedDict("_UnusedTypedDict3", {"foo": int}) | ^^^^^^^^^^^^^^^^^ PYI049 35 | _UsedTypedDict3 = TypedDict("_UsedTypedDict3", {"bar": bytes}) @@ -32,5 +32,3 @@ PYI049.pyi:43:11: PYI049 Private TypedDict `_UnusedTypeDict4` is never used | ^^^^^^^^^^^^^^^^ PYI049 44 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.py.snap index 10e43df19dda8..1ae425e4ba5a2 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI050.py:13:24: PYI050 Prefer `typing.Never` over `NoReturn` for argument annotations | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.pyi.snap index 6b8acaec8375f..194e7e0253e60 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI050_PYI050.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI050.pyi:6:24: PYI050 Prefer `typing.Never` over `NoReturn` for argument annotations | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.py.snap index 1e67d47c63e82..84850e38e7fe5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI051.py:4:18: PYI051 `Literal["foo"]` is redundant in a union with `str` | 2 | from typing import Literal, TypeAlias, Union -3 | +3 | 4 | A: str | Literal["foo"] | ^^^^^ PYI051 5 | B: TypeAlias = typing.Union[Literal[b"bar", b"foo"], bytes, str] @@ -36,6 +36,7 @@ PYI051.py:6:37: PYI051 `Literal[5]` is redundant in a union with `int` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] | ^ PYI051 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] | PYI051.py:6:67: PYI051 `Literal["foo"]` is redundant in a union with `str` @@ -45,6 +46,7 @@ PYI051.py:6:67: PYI051 `Literal["foo"]` is redundant in a union with `str` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] | ^^^^^ PYI051 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] | PYI051.py:7:37: PYI051 `Literal[b"str_bytes"]` is redundant in a union with `bytes` @@ -53,8 +55,8 @@ PYI051.py:7:37: PYI051 `Literal[b"str_bytes"]` is redundant in a union with `byt 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] | ^^^^^^^^^^^^ PYI051 -8 | -9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | PYI051.py:7:51: PYI051 `Literal[42]` is redundant in a union with `int` @@ -63,28 +65,55 @@ PYI051.py:7:51: PYI051 `Literal[42]` is redundant in a union with `int` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] | ^^ PYI051 -8 | -9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | -PYI051.py:9:31: PYI051 `Literal[1J]` is redundant in a union with `complex` +PYI051.py:8:76: PYI051 `Literal["foo"]` is redundant in a union with `str` | + 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] - 8 | - 9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... - | ^^ PYI051 -10 | -11 | # OK + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + | ^^^^^ PYI051 + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | -PYI051.py:9:53: PYI051 `Literal[3.14]` is redundant in a union with `float` +PYI051.py:9:81: PYI051 `Literal["foo"]` is redundant in a union with `str` | 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] - 8 | - 9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... - | ^^^^ PYI051 -10 | -11 | # OK + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] + | ^^^^^ PYI051 +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | +PYI051.py:10:69: PYI051 `Literal["foo"]` is redundant in a union with `str` + | + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] + | ^^^^^ PYI051 +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | +PYI051.py:12:31: PYI051 `Literal[1J]` is redundant in a union with `complex` + | +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | ^^ PYI051 +13 | +14 | # OK + | + +PYI051.py:12:53: PYI051 `Literal[3.14]` is redundant in a union with `float` + | +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | ^^^^ PYI051 +13 | +14 | # OK + | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.pyi.snap index b5da422a00a7f..cf1f213ca1f40 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI051_PYI051.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI051.pyi:4:18: PYI051 `Literal["foo"]` is redundant in a union with `str` | 2 | from typing import Literal, TypeAlias, Union -3 | +3 | 4 | A: str | Literal["foo"] | ^^^^^ PYI051 5 | B: TypeAlias = typing.Union[Literal[b"bar", b"foo"], bytes, str] @@ -36,6 +36,7 @@ PYI051.pyi:6:37: PYI051 `Literal[5]` is redundant in a union with `int` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] | ^ PYI051 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] | PYI051.pyi:6:67: PYI051 `Literal["foo"]` is redundant in a union with `str` @@ -45,6 +46,7 @@ PYI051.pyi:6:67: PYI051 `Literal["foo"]` is redundant in a union with `str` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] | ^^^^^ PYI051 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] | PYI051.pyi:7:37: PYI051 `Literal[b"str_bytes"]` is redundant in a union with `bytes` @@ -53,8 +55,8 @@ PYI051.pyi:7:37: PYI051 `Literal[b"str_bytes"]` is redundant in a union with `by 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] | ^^^^^^^^^^^^ PYI051 -8 | -9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | PYI051.pyi:7:51: PYI051 `Literal[42]` is redundant in a union with `int` @@ -63,28 +65,55 @@ PYI051.pyi:7:51: PYI051 `Literal[42]` is redundant in a union with `int` 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] | ^^ PYI051 -8 | -9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... +8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] +9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | -PYI051.pyi:9:31: PYI051 `Literal[1J]` is redundant in a union with `complex` +PYI051.pyi:8:76: PYI051 `Literal["foo"]` is redundant in a union with `str` | + 6 | C: TypeAlias = typing.Union[Literal[5], int, typing.Union[Literal["foo"], str]] 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] - 8 | - 9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... - | ^^ PYI051 -10 | -11 | # OK + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + | ^^^^^ PYI051 + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | -PYI051.pyi:9:53: PYI051 `Literal[3.14]` is redundant in a union with `float` +PYI051.pyi:9:81: PYI051 `Literal["foo"]` is redundant in a union with `str` | 7 | D: TypeAlias = typing.Union[Literal[b"str_bytes", 42], bytes, int] - 8 | - 9 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... - | ^^^^ PYI051 -10 | -11 | # OK + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] + | ^^^^^ PYI051 +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] | +PYI051.pyi:10:69: PYI051 `Literal["foo"]` is redundant in a union with `str` + | + 8 | E: TypeAlias = typing.Union[typing.Union[typing.Union[typing.Union[Literal["foo"], str]]]] + 9 | F: TypeAlias = typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] + | ^^^^^ PYI051 +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | +PYI051.pyi:12:31: PYI051 `Literal[1J]` is redundant in a union with `complex` + | +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | ^^ PYI051 +13 | +14 | # OK + | + +PYI051.pyi:12:53: PYI051 `Literal[3.14]` is redundant in a union with `float` + | +10 | G: typing.Union[str, typing.Union[typing.Union[typing.Union[Literal["foo"], int]]]] +11 | +12 | def func(x: complex | Literal[1J], y: Union[Literal[3.14], float]): ... + | ^^^^ PYI051 +13 | +14 | # OK + | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.pyi.snap index 0c39af3a9ff1e..210dcc1918337 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI052_PYI052.pyi.snap @@ -5,7 +5,7 @@ PYI052.pyi:14:10: PYI052 Need type annotation for `field5` | 12 | field43: int = -0xFFFFFFFF 13 | field44: int = -1234567890 -14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need type annotation for "field5" +14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need ty… | ^ PYI052 15 | field6 = 0 # Y052 Need type annotation for "field6" 16 | field7 = b"" # Y052 Need type annotation for "field7" @@ -14,7 +14,7 @@ PYI052.pyi:14:10: PYI052 Need type annotation for `field5` PYI052.pyi:15:10: PYI052 Need type annotation for `field6` | 13 | field44: int = -1234567890 -14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need type annotation for "field5" +14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need ty… 15 | field6 = 0 # Y052 Need type annotation for "field6" | ^ PYI052 16 | field7 = b"" # Y052 Need type annotation for "field7" @@ -23,7 +23,7 @@ PYI052.pyi:15:10: PYI052 Need type annotation for `field6` PYI052.pyi:16:10: PYI052 Need type annotation for `field7` | -14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need type annotation for "field5" +14 | field5 = 0 # type: int # Y033 Do not use type comments in stubs (e.g. use "x: int" instead of "x = ... # type: int") # Y052 Need ty… 15 | field6 = 0 # Y052 Need type annotation for "field6" 16 | field7 = b"" # Y052 Need type annotation for "field7" | ^^^ PYI052 @@ -137,5 +137,3 @@ PYI052.pyi:114:11: PYI052 Need type annotation for `WIZ` 114 | WIZ = 4 | ^ PYI052 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.pyi.snap index 501c5a310067b..c6cb6da87907d 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI053_PYI053.pyi.snap @@ -66,10 +66,10 @@ PYI053.pyi:25:16: PYI053 [*] String and bytes literals longer than 50 characters PYI053.pyi:30:12: PYI053 [*] String and bytes literals longer than 50 characters are not permitted | 28 | foo: str = "50 character stringggggggggggggggggggggggggggggggg" # OK -29 | +29 | 30 | bar: str = "51 character stringgggggggggggggggggggggggggggggggg" # Error: PYI053 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI053 -31 | +31 | 32 | baz: bytes = b"50 character byte stringgggggggggggggggggggggggggg" # OK | = help: Replace with `...` @@ -87,10 +87,10 @@ PYI053.pyi:30:12: PYI053 [*] String and bytes literals longer than 50 characters PYI053.pyi:34:14: PYI053 [*] String and bytes literals longer than 50 characters are not permitted | 32 | baz: bytes = b"50 character byte stringgggggggggggggggggggggggggg" # OK -33 | +33 | 34 | qux: bytes = b"51 character byte stringggggggggggggggggggggggggggg\xff" # Error: PYI053 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI053 -35 | +35 | 36 | ffoo: str = f"50 character stringggggggggggggggggggggggggggggggg" # OK | = help: Replace with `...` @@ -108,10 +108,10 @@ PYI053.pyi:34:14: PYI053 [*] String and bytes literals longer than 50 characters PYI053.pyi:38:13: PYI053 [*] String and bytes literals longer than 50 characters are not permitted | 36 | ffoo: str = f"50 character stringggggggggggggggggggggggggggggggg" # OK -37 | +37 | 38 | fbar: str = f"51 character stringgggggggggggggggggggggggggggggggg" # Error: PYI053 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI053 -39 | +39 | 40 | class Demo: | = help: Replace with `...` @@ -149,11 +149,11 @@ PYI053.pyi:64:5: PYI053 [*] String and bytes literals longer than 50 characters PYI053.pyi:68:13: PYI053 [*] String and bytes literals longer than 50 characters are not permitted | 66 | def not_a_deprecated_function() -> None: ... -67 | +67 | 68 | fbaz: str = f"51 character {foo} stringgggggggggggggggggggggggggg" # Error: PYI053 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI053 -69 | -70 | # see https://github.com/astral-sh/ruff/issues/12995 +69 | +70 | from typing import TypeAlias, Literal, Annotated | = help: Replace with `...` @@ -164,5 +164,5 @@ PYI053.pyi:68:13: PYI053 [*] String and bytes literals longer than 50 characters 68 |-fbaz: str = f"51 character {foo} stringgggggggggggggggggggggggggg" # Error: PYI053 68 |+fbaz: str = ... # Error: PYI053 69 69 | -70 70 | # see https://github.com/astral-sh/ruff/issues/12995 -71 71 | def foo(bar: typing.Literal["a", "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"]):... +70 70 | from typing import TypeAlias, Literal, Annotated +71 71 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.pyi.snap index 24457599a3ba0..ec99151e033f3 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI054_PYI054.pyi.snap @@ -25,7 +25,7 @@ PYI054.pyi:4:17: PYI054 [*] Numeric literals with a string representation longer 3 | field03: int = -0xFFFFFFFF 4 | field04: int = -0xFFFFFFFFF # Error: PYI054 | ^^^^^^^^^^^ PYI054 -5 | +5 | 6 | field05: int = 1234567890 | = help: Replace with `...` @@ -67,7 +67,7 @@ PYI054.pyi:10:17: PYI054 [*] Numeric literals with a string representation longe 9 | field08: int = -1234567801 10 | field09: int = -234_567_890 # Error: PYI054 | ^^^^^^^^^^^ PYI054 -11 | +11 | 12 | field10: float = 123.456789 | = help: Replace with `...` @@ -108,7 +108,7 @@ PYI054.pyi:15:19: PYI054 [*] Numeric literals with a string representation longe 14 | field12: float = -123.456789 15 | field13: float = -123.567_890 # Error: PYI054 | ^^^^^^^^^^^ PYI054 -16 | +16 | 17 | field14: complex = 1e1234567j | = help: Replace with `...` @@ -157,5 +157,3 @@ PYI054.pyi:20:20: PYI054 [*] Numeric literals with a string representation longe 19 19 | field16: complex = -1e1234567j 20 |-field17: complex = 1e123456789j # Error: PYI054 20 |+field17: complex = ... # Error: PYI054 - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.py.snap index e93e79a12d48a..e9dadd685d5b5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.py.snap @@ -1,90 +1,96 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI055.py:31:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty | str]`. +PYI055.py:34:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty | str]`. | -29 | def func(): -30 | # PYI055 -31 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +32 | def func(): +33 | # PYI055 +34 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -32 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +35 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +36 | z: Union[ # comment | = help: Combine multiple `type` members ℹ Safe fix -28 28 | -29 29 | def func(): -30 30 | # PYI055 -31 |- x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker - 31 |+ x: type[requests_mock.Mocker | httpretty | str] = requests_mock.Mocker -32 32 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker -33 33 | -34 34 | +31 31 | +32 32 | def func(): +33 33 | # PYI055 +34 |- x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker + 34 |+ x: type[requests_mock.Mocker | httpretty | str] = requests_mock.Mocker +35 35 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +36 36 | z: Union[ # comment +37 37 | type[requests_mock.Mocker], # another comment -PYI055.py:32:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. +PYI055.py:35:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. | -30 | # PYI055 -31 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker -32 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +33 | # PYI055 +34 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +35 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +36 | z: Union[ # comment +37 | type[requests_mock.Mocker], # another comment | = help: Combine multiple `type` members ℹ Safe fix -29 29 | def func(): -30 30 | # PYI055 -31 31 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker -32 |- y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker - 32 |+ y: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker -33 33 | -34 34 | -35 35 | def func(): +32 32 | def func(): +33 33 | # PYI055 +34 34 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +35 |- y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + 35 |+ y: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +36 36 | z: Union[ # comment +37 37 | type[requests_mock.Mocker], # another comment +38 38 | type[httpretty], type[str]] = requests_mock.Mocker -PYI055.py:39:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. +PYI055.py:36:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. | -38 | # PYI055 -39 | x: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +34 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +35 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +36 | z: Union[ # comment + | ________^ +37 | | type[requests_mock.Mocker], # another comment +38 | | type[httpretty], type[str]] = requests_mock.Mocker + | |___________________________________^ PYI055 | = help: Combine multiple `type` members -ℹ Safe fix -36 36 | from typing import Union as U -37 37 | -38 38 | # PYI055 -39 |- x: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker - 39 |+ x: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker -40 40 | -41 41 | -42 42 | def convert_union(union: UnionType) -> _T | None: +ℹ Unsafe fix +33 33 | # PYI055 +34 34 | x: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +35 35 | y: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +36 |- z: Union[ # comment +37 |- type[requests_mock.Mocker], # another comment +38 |- type[httpretty], type[str]] = requests_mock.Mocker + 36 |+ z: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +39 37 | +40 38 | +41 39 | def func(): -PYI055.py:44:9: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. +PYI055.py:45:8: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. | -42 | def convert_union(union: UnionType) -> _T | None: -43 | converters: tuple[ -44 | type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -45 | ] = union.__args__ -46 | ... +44 | # PYI055 +45 | x: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | = help: Combine multiple `type` members ℹ Safe fix -41 41 | -42 42 | def convert_union(union: UnionType) -> _T | None: -43 43 | converters: tuple[ -44 |- type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 - 44 |+ type[_T | Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 -45 45 | ] = union.__args__ -46 46 | ... +42 42 | from typing import Union as U +43 43 | +44 44 | # PYI055 +45 |- x: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + 45 |+ x: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +46 46 | 47 47 | +48 48 | def convert_union(union: UnionType) -> _T | None: -PYI055.py:50:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. +PYI055.py:50:9: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. | 48 | def convert_union(union: UnionType) -> _T | None: 49 | converters: tuple[ -50 | Union[type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T]], ... # PYI055 - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +50 | type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 51 | ] = union.__args__ 52 | ... | @@ -94,18 +100,18 @@ PYI055.py:50:15: PYI055 [*] Multiple `type` members in a union. Combine them int 47 47 | 48 48 | def convert_union(union: UnionType) -> _T | None: 49 49 | converters: tuple[ -50 |- Union[type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T]], ... # PYI055 - 50 |+ Union[type[_T | Converter[_T]] | Converter[_T] | Callable[[str], _T]], ... # PYI055 +50 |- type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 + 50 |+ type[_T | Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 51 51 | ] = union.__args__ 52 52 | ... 53 53 | -PYI055.py:56:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. +PYI055.py:56:9: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. | 54 | def convert_union(union: UnionType) -> _T | None: 55 | converters: tuple[ -56 | Union[type[_T] | type[Converter[_T]]] | Converter[_T] | Callable[[str], _T], ... # PYI055 - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +56 | Union[type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T]], ... # PYI055 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 57 | ] = union.__args__ 58 | ... | @@ -115,18 +121,18 @@ PYI055.py:56:15: PYI055 [*] Multiple `type` members in a union. Combine them int 53 53 | 54 54 | def convert_union(union: UnionType) -> _T | None: 55 55 | converters: tuple[ -56 |- Union[type[_T] | type[Converter[_T]]] | Converter[_T] | Callable[[str], _T], ... # PYI055 - 56 |+ Union[type[_T | Converter[_T]]] | Converter[_T] | Callable[[str], _T], ... # PYI055 +56 |- Union[type[_T] | type[Converter[_T]] | Converter[_T] | Callable[[str], _T]], ... # PYI055 + 56 |+ type[_T | Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 57 57 | ] = union.__args__ 58 58 | ... 59 59 | -PYI055.py:62:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. +PYI055.py:62:9: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. | 60 | def convert_union(union: UnionType) -> _T | None: 61 | converters: tuple[ -62 | Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +62 | Union[type[_T] | type[Converter[_T]]] | Converter[_T] | Callable[[str], _T], ... # PYI055 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 63 | ] = union.__args__ 64 | ... | @@ -136,9 +142,29 @@ PYI055.py:62:15: PYI055 [*] Multiple `type` members in a union. Combine them int 59 59 | 60 60 | def convert_union(union: UnionType) -> _T | None: 61 61 | converters: tuple[ -62 |- Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 - 62 |+ Union[type[_T | Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 +62 |- Union[type[_T] | type[Converter[_T]]] | Converter[_T] | Callable[[str], _T], ... # PYI055 + 62 |+ type[_T | Converter[_T]] | Converter[_T] | Callable[[str], _T], ... # PYI055 63 63 | ] = union.__args__ 64 64 | ... +65 65 | +PYI055.py:68:9: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[_T | Converter[_T]]`. + | +66 | def convert_union(union: UnionType) -> _T | None: +67 | converters: tuple[ +68 | Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +69 | ] = union.__args__ +70 | ... + | + = help: Combine multiple `type` members +ℹ Safe fix +65 65 | +66 66 | def convert_union(union: UnionType) -> _T | None: +67 67 | converters: tuple[ +68 |- Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 + 68 |+ type[_T | Converter[_T]] | str | Converter[_T] | Callable[[str], _T], ... # PYI055 +69 69 | ] = union.__args__ +70 70 | ... +71 71 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.pyi.snap index 0e41288be5073..30515dd2290f5 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.pyi.snap @@ -4,11 +4,11 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI055.pyi:4:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | str | complex]`. | 2 | from typing import Union -3 | -4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] +3 | +4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -5 | x: type[int] | type[str] | type[float] -6 | y: builtins.type[int] | type[str] | builtins.type[complex] +5 | t: type[int] | type[str] | type[float] +6 | u: builtins.type[int] | type[str] | builtins.type[complex] | = help: Combine multiple `type` members @@ -16,167 +16,260 @@ PYI055.pyi:4:4: PYI055 [*] Multiple `type` members in a union. Combine them into 1 1 | import builtins 2 2 | from typing import Union 3 3 | -4 |-w: builtins.type[int] | builtins.type[str] | builtins.type[complex] - 4 |+w: type[int | str | complex] -5 5 | x: type[int] | type[str] | type[float] -6 6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 7 | z: Union[type[float], type[complex]] +4 |-s: builtins.type[int] | builtins.type[str] | builtins.type[complex] + 4 |+s: type[int | str | complex] +5 5 | t: type[int] | type[str] | type[float] +6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 7 | v: Union[type[float], type[complex]] PYI055.pyi:5:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | str | float]`. | -4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -5 | x: type[int] | type[str] | type[float] +4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +5 | t: type[int] | type[str] | type[float] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 | z: Union[type[float], type[complex]] +6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 | v: Union[type[float], type[complex]] | = help: Combine multiple `type` members ℹ Safe fix 2 2 | from typing import Union 3 3 | -4 4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -5 |-x: type[int] | type[str] | type[float] - 5 |+x: type[int | str | float] -6 6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 7 | z: Union[type[float], type[complex]] -8 8 | z: Union[type[float, int], type[complex]] +4 4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +5 |-t: type[int] | type[str] | type[float] + 5 |+t: type[int | str | float] +6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 7 | v: Union[type[float], type[complex]] +8 8 | w: Union[type[Union[float, int]], type[complex]] PYI055.pyi:6:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | str | complex]`. | -4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -5 | x: type[int] | type[str] | type[float] -6 | y: builtins.type[int] | type[str] | builtins.type[complex] +4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +5 | t: type[int] | type[str] | type[float] +6 | u: builtins.type[int] | type[str] | builtins.type[complex] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -7 | z: Union[type[float], type[complex]] -8 | z: Union[type[float, int], type[complex]] +7 | v: Union[type[float], type[complex]] +8 | w: Union[type[Union[float, int]], type[complex]] | = help: Combine multiple `type` members ℹ Safe fix 3 3 | -4 4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -5 5 | x: type[int] | type[str] | type[float] -6 |-y: builtins.type[int] | type[str] | builtins.type[complex] - 6 |+y: type[int | str | complex] -7 7 | z: Union[type[float], type[complex]] -8 8 | z: Union[type[float, int], type[complex]] -9 9 | +4 4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +5 5 | t: type[int] | type[str] | type[float] +6 |-u: builtins.type[int] | type[str] | builtins.type[complex] + 6 |+u: type[int | str | complex] +7 7 | v: Union[type[float], type[complex]] +8 8 | w: Union[type[Union[float, int]], type[complex]] +9 9 | x: Union[Union[type[Union[float, int]], type[complex]]] PYI055.pyi:7:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, complex]]`. | -5 | x: type[int] | type[str] | type[float] -6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 | z: Union[type[float], type[complex]] +5 | t: type[int] | type[str] | type[float] +6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 | v: Union[type[float], type[complex]] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -8 | z: Union[type[float, int], type[complex]] +8 | w: Union[type[Union[float, int]], type[complex]] +9 | x: Union[Union[type[Union[float, int]], type[complex]]] | = help: Combine multiple `type` members ℹ Safe fix -4 4 | w: builtins.type[int] | builtins.type[str] | builtins.type[complex] -5 5 | x: type[int] | type[str] | type[float] -6 6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 |-z: Union[type[float], type[complex]] - 7 |+z: type[Union[float, complex]] -8 8 | z: Union[type[float, int], type[complex]] -9 9 | -10 10 | def func(arg: type[int] | str | type[float]) -> None: ... - -PYI055.pyi:8:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, int, complex]]`. - | - 6 | y: builtins.type[int] | type[str] | builtins.type[complex] - 7 | z: Union[type[float], type[complex]] - 8 | z: Union[type[float, int], type[complex]] - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 - 9 | -10 | def func(arg: type[int] | str | type[float]) -> None: ... +4 4 | s: builtins.type[int] | builtins.type[str] | builtins.type[complex] +5 5 | t: type[int] | type[str] | type[float] +6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 |-v: Union[type[float], type[complex]] + 7 |+v: type[Union[float, complex]] +8 8 | w: Union[type[Union[float, int]], type[complex]] +9 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] + +PYI055.pyi:8:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`. + | + 6 | u: builtins.type[int] | type[str] | builtins.type[complex] + 7 | v: Union[type[float], type[complex]] + 8 | w: Union[type[Union[float, int]], type[complex]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 + 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] + | + = help: Combine multiple `type` members + +ℹ Safe fix +5 5 | t: type[int] | type[str] | type[float] +6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 7 | v: Union[type[float], type[complex]] +8 |-w: Union[type[Union[float, int]], type[complex]] + 8 |+w: type[Union[Union[float, int], complex]] +9 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] + +PYI055.pyi:9:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`. + | + 7 | v: Union[type[float], type[complex]] + 8 | w: Union[type[Union[float, int]], type[complex]] + 9 | x: Union[Union[type[Union[float, int]], type[complex]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] + | + = help: Combine multiple `type` members + +ℹ Safe fix +6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] +7 7 | v: Union[type[float], type[complex]] +8 8 | w: Union[type[Union[float, int]], type[complex]] +9 |-x: Union[Union[type[Union[float, int]], type[complex]]] + 9 |+x: type[Union[Union[float, int], complex]] +10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] +12 12 | + +PYI055.pyi:10:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`. + | + 8 | w: Union[type[Union[float, int]], type[complex]] + 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] | = help: Combine multiple `type` members ℹ Safe fix -5 5 | x: type[int] | type[str] | type[float] -6 6 | y: builtins.type[int] | type[str] | builtins.type[complex] -7 7 | z: Union[type[float], type[complex]] -8 |-z: Union[type[float, int], type[complex]] - 8 |+z: type[Union[float, int, complex]] -9 9 | -10 10 | def func(arg: type[int] | str | type[float]) -> None: ... -11 11 | - -PYI055.pyi:10:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | float]`. - | - 8 | z: Union[type[float, int], type[complex]] - 9 | -10 | def func(arg: type[int] | str | type[float]) -> None: ... +7 7 | v: Union[type[float], type[complex]] +8 8 | w: Union[type[Union[float, int]], type[complex]] +9 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 |-y: Union[Union[Union[type[Union[float, int]], type[complex]]]] + 10 |+y: type[Union[Union[float, int], complex]] +11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] +12 12 | +13 13 | def func(arg: type[int] | str | type[float]) -> None: ... + +PYI055.pyi:11:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[complex, Union[float, int]]]`. + | + 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +12 | +13 | def func(arg: type[int] | str | type[float]) -> None: ... + | + = help: Combine multiple `type` members + +ℹ Safe fix +8 8 | w: Union[type[Union[float, int]], type[complex]] +9 9 | x: Union[Union[type[Union[float, int]], type[complex]]] +10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 |-z: Union[type[complex], Union[Union[type[Union[float, int]]]]] + 11 |+z: type[Union[complex, Union[float, int]]] +12 12 | +13 13 | def func(arg: type[int] | str | type[float]) -> None: ... +14 14 | + +PYI055.pyi:13:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | float]`. + | +11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] +12 | +13 | def func(arg: type[int] | str | type[float]) -> None: ... | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -11 | -12 | # OK +14 | +15 | # OK | = help: Combine multiple `type` members ℹ Safe fix -7 7 | z: Union[type[float], type[complex]] -8 8 | z: Union[type[float, int], type[complex]] -9 9 | -10 |-def func(arg: type[int] | str | type[float]) -> None: ... - 10 |+def func(arg: type[int | float] | str) -> None: ... -11 11 | -12 12 | # OK -13 13 | x: type[int, str, float] - -PYI055.pyi:20:7: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty]`. - | -19 | # OK -20 | item: type[requests_mock.Mocker] | type[httpretty] = requests_mock.Mocker +10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]] +11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]] +12 12 | +13 |-def func(arg: type[int] | str | type[float]) -> None: ... + 13 |+def func(arg: type[int | float] | str) -> None: ... +14 14 | +15 15 | # OK +16 16 | x: type[int | str | float] + +PYI055.pyi:23:7: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty]`. + | +22 | # PYI055 +23 | item: type[requests_mock.Mocker] | type[httpretty] = requests_mock.Mocker | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -21 | -22 | def func(): +24 | +25 | def func(): | = help: Combine multiple `type` members ℹ Safe fix -17 17 | def func(arg: type[int, float] | str) -> None: ... -18 18 | -19 19 | # OK -20 |-item: type[requests_mock.Mocker] | type[httpretty] = requests_mock.Mocker - 20 |+item: type[requests_mock.Mocker | httpretty] = requests_mock.Mocker +20 20 | def func(arg: type[int, float] | str) -> None: ... 21 21 | -22 22 | def func(): -23 23 | # PYI055 +22 22 | # PYI055 +23 |-item: type[requests_mock.Mocker] | type[httpretty] = requests_mock.Mocker + 23 |+item: type[requests_mock.Mocker | httpretty] = requests_mock.Mocker +24 24 | +25 25 | def func(): +26 26 | # PYI055 -PYI055.pyi:24:11: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty | str]`. +PYI055.pyi:27:11: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty | str]`. | -22 | def func(): -23 | # PYI055 -24 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +25 | def func(): +26 | # PYI055 +27 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 -25 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +28 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +29 | item3: Union[ # comment | = help: Combine multiple `type` members ℹ Safe fix -21 21 | -22 22 | def func(): -23 23 | # PYI055 -24 |- item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker - 24 |+ item: type[requests_mock.Mocker | httpretty | str] = requests_mock.Mocker -25 25 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +24 24 | +25 25 | def func(): +26 26 | # PYI055 +27 |- item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker + 27 |+ item: type[requests_mock.Mocker | httpretty | str] = requests_mock.Mocker +28 28 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +29 29 | item3: Union[ # comment +30 30 | type[requests_mock.Mocker], # another comment -PYI055.pyi:25:12: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. +PYI055.pyi:28:12: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. | -23 | # PYI055 -24 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker -25 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +26 | # PYI055 +27 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +28 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 +29 | item3: Union[ # comment +30 | type[requests_mock.Mocker], # another comment | = help: Combine multiple `type` members ℹ Safe fix -22 22 | def func(): -23 23 | # PYI055 -24 24 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker -25 |- item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker - 25 |+ item2: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +25 25 | def func(): +26 26 | # PYI055 +27 27 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +28 |- item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker + 28 |+ item2: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +29 29 | item3: Union[ # comment +30 30 | type[requests_mock.Mocker], # another comment +31 31 | type[httpretty], type[str]] = requests_mock.Mocker +PYI055.pyi:29:12: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[requests_mock.Mocker, httpretty, str]]`. + | +27 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +28 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +29 | item3: Union[ # comment + | ____________^ +30 | | type[requests_mock.Mocker], # another comment +31 | | type[httpretty], type[str]] = requests_mock.Mocker + | |___________________________________^ PYI055 + | + = help: Combine multiple `type` members +ℹ Unsafe fix +26 26 | # PYI055 +27 27 | item: type[requests_mock.Mocker] | type[httpretty] | type[str] = requests_mock.Mocker +28 28 | item2: Union[type[requests_mock.Mocker], type[httpretty], type[str]] = requests_mock.Mocker +29 |- item3: Union[ # comment +30 |- type[requests_mock.Mocker], # another comment +31 |- type[httpretty], type[str]] = requests_mock.Mocker + 29 |+ item3: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker +32 30 | +33 31 | +34 32 | # OK diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.py.snap index 850ee67d1f540..c8d9583e3de2a 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.py.snap @@ -25,8 +25,6 @@ PYI056.py:6:1: PYI056 Calling `.remove()` on `__all__` may not be supported by a 5 | __all__.extend(["E", "Foo"]) 6 | __all__.remove("A") | ^^^^^^^^^^^^^^ PYI056 -7 | +7 | 8 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.pyi.snap index fbc462d426c3d..7e7f78519ec6b 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI056_PYI056.pyi.snap @@ -25,8 +25,6 @@ PYI056.pyi:6:1: PYI056 Calling `.remove()` on `__all__` may not be supported by 5 | __all__.extend(["E", "Foo"]) 6 | __all__.remove("A") | ^^^^^^^^^^^^^^ PYI056 -7 | +7 | 8 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.py.snap index 918f1dbdc4c46..efdd939335c25 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.py.snap @@ -23,7 +23,7 @@ PYI057.py:5:29: PYI057 Do not use `collections.abc.ByteString`, which has unclea PYI057.py:8:4: PYI057 Do not use `typing.ByteString`, which has unclear semantics and is deprecated | 6 | from foo import ByteString - 7 | + 7 | 8 | a: typing.ByteString | ^^^^^^^^^^^^^^^^^ PYI057 9 | b: collections.abc.ByteString diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.pyi.snap index d1193d27594ec..f1c72b4ba9111 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI057_PYI057.pyi.snap @@ -23,7 +23,7 @@ PYI057.pyi:5:29: PYI057 Do not use `collections.abc.ByteString`, which has uncle PYI057.pyi:8:4: PYI057 Do not use `typing.ByteString`, which has unclear semantics and is deprecated | 6 | from foo import ByteString - 7 | + 7 | 8 | a: typing.ByteString | ^^^^^^^^^^^^^^^^^ PYI057 9 | b: collections.abc.ByteString diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.py.snap index 67a1ecba57303..db2ba3e2115ee 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- PYI058.py:5:13: PYI058 [*] Use `Iterator` as the return value for simple `__iter__` methods | @@ -159,6 +160,4 @@ PYI058.py:73:13: PYI058 [*] Use `AsyncIterator` as the return value for simple ` 73 |+ def __aiter__(self, /) -> collections.abc.AsyncIterator[str]: 74 74 | ... # PYI058 (Use `AsyncIterator`) 75 75 | -76 76 | - - +76 76 | diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.pyi.snap index 9da7931b514db..915b6958e0474 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI058_PYI058.pyi.snap @@ -6,7 +6,7 @@ PYI058.pyi:5:13: PYI058 [*] Use `Iterator` as the return value for simple `__ite 4 | class IteratorReturningSimpleGenerator1: 5 | def __iter__(self) -> Generator: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -6 | +6 | 7 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -28,7 +28,7 @@ PYI058.pyi:11:13: PYI058 [*] Use `Iterator` as the return value for simple `__it 10 | class IteratorReturningSimpleGenerator2: 11 | def __iter__(self) -> typing.Generator: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -12 | +12 | 13 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -48,7 +48,7 @@ PYI058.pyi:17:13: PYI058 [*] Use `Iterator` as the return value for simple `__it 16 | class IteratorReturningSimpleGenerator3: 17 | def __iter__(self) -> collections.abc.Generator: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -18 | +18 | 19 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -68,7 +68,7 @@ PYI058.pyi:24:13: PYI058 [*] Use `Iterator` as the return value for simple `__it 23 | class IteratorReturningSimpleGenerator4: 24 | def __iter__(self, /) -> collections.abc.Generator[str, Any, None]: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -25 | +25 | 26 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -88,7 +88,7 @@ PYI058.pyi:31:13: PYI058 [*] Use `Iterator` as the return value for simple `__it 30 | class IteratorReturningSimpleGenerator5: 31 | def __iter__(self, /) -> collections.abc.Generator[str, None, typing.Any]: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -32 | +32 | 33 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -108,7 +108,7 @@ PYI058.pyi:37:13: PYI058 [*] Use `Iterator` as the return value for simple `__it 36 | class IteratorReturningSimpleGenerator6: 37 | def __iter__(self, /) -> Generator[str, None, None]: ... # PYI058 (use `Iterator`) | ^^^^^^^^ PYI058 -38 | +38 | 39 | def scope(): | = help: Convert the return annotation of your `__iter__` method to `Iterator` @@ -133,7 +133,7 @@ PYI058.pyi:43:13: PYI058 [*] Use `AsyncIterator` as the return value for simple 42 | class AsyncIteratorReturningSimpleAsyncGenerator1: 43 | def __aiter__(self,) -> typing_extensions.AsyncGenerator: ... # PYI058 (Use `AsyncIterator`) | ^^^^^^^^^ PYI058 -44 | +44 | 45 | def scope(): | = help: Convert the return annotation of your `__aiter__` method to `AsyncIterator` @@ -172,7 +172,7 @@ PYI058.pyi:56:13: PYI058 [*] Use `AsyncIterator` as the return value for simple 55 | class AsyncIteratorReturningSimpleAsyncGenerator3: 56 | def __aiter__(self, /) -> collections.abc.AsyncGenerator[str, None]: ... # PYI058 (Use `AsyncIterator`) | ^^^^^^^^^ PYI058 -57 | +57 | 58 | def scope(): | = help: Convert the return annotation of your `__aiter__` method to `AsyncIterator` @@ -186,5 +186,3 @@ PYI058.pyi:56:13: PYI058 [*] Use `AsyncIterator` as the return value for simple 57 57 | 58 58 | def scope(): 59 59 | from typing import Iterator - - diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.py.snap index bcb28618ff3c8..bc91fb867cef4 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI059.py:8:17: PYI059 [*] `Generic[]` should always be the last base class | 6 | V = TypeVar('V') - 7 | + 7 | 8 | class LinkedList(Generic[T], Sized): # PYI059 | ^^^^^^^^^^^^^^^^^^^ PYI059 9 | def __init__(self) -> None: @@ -25,7 +25,7 @@ PYI059.py:8:17: PYI059 [*] `Generic[]` should always be the last base class PYI059.py:15:16: PYI059 [*] `Generic[]` should always be the last base class | 13 | self._items.append(item) -14 | +14 | 15 | class MyMapping( # PYI059 | ________________^ 16 | | t.Generic[K, V], diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.pyi.snap index eec9fa9f22c4c..275dd20dbaa08 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI059_PYI059.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI059.pyi:8:17: PYI059 [*] `Generic[]` should always be the last base class | 6 | V = TypeVar('V') - 7 | + 7 | 8 | class LinkedList(Generic[T], Sized): # PYI059 | ^^^^^^^^^^^^^^^^^^^ PYI059 9 | def __init__(self) -> None: ... @@ -25,7 +25,7 @@ PYI059.pyi:8:17: PYI059 [*] `Generic[]` should always be the last base class PYI059.pyi:12:16: PYI059 [*] `Generic[]` should always be the last base class | 10 | def push(self, item: T) -> None: ... -11 | +11 | 12 | class MyMapping( # PYI059 | ________________^ 13 | | t.Generic[K, V], diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.py.snap new file mode 100644 index 0000000000000..32cfb3f84c2e4 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.py.snap @@ -0,0 +1,435 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI061.py:4:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +4 | def func1(arg1: Literal[None]): + | ^^^^ PYI061 +5 | ... + | + = help: Replace with `None` + +ℹ Safe fix +1 1 | from typing import Literal, Union +2 2 | +3 3 | +4 |-def func1(arg1: Literal[None]): + 4 |+def func1(arg1: None): +5 5 | ... +6 6 | +7 7 | + +PYI061.py:8:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +8 | def func2(arg1: Literal[None] | int): + | ^^^^ PYI061 +9 | ... + | + = help: Replace with `None` + +ℹ Safe fix +5 5 | ... +6 6 | +7 7 | +8 |-def func2(arg1: Literal[None] | int): + 8 |+def func2(arg1: None | int): +9 9 | ... +10 10 | +11 11 | + +PYI061.py:12:24: PYI061 [*] Use `None` rather than `Literal[None]` + | +12 | def func3() -> Literal[None]: + | ^^^^ PYI061 +13 | ... + | + = help: Replace with `None` + +ℹ Safe fix +9 9 | ... +10 10 | +11 11 | +12 |-def func3() -> Literal[None]: + 12 |+def func3() -> None: +13 13 | ... +14 14 | +15 15 | + +PYI061.py:16:30: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +16 | def func4(arg1: Literal[int, None, float]): + | ^^^^ PYI061 +17 | ... + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +13 13 | ... +14 14 | +15 15 | +16 |-def func4(arg1: Literal[int, None, float]): + 16 |+def func4(arg1: Literal[int, float] | None): +17 17 | ... +18 18 | +19 19 | + +PYI061.py:20:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +20 | def func5(arg1: Literal[None, None]): + | ^^^^ PYI061 +21 | ... + | + = help: Replace with `None` + +ℹ Safe fix +17 17 | ... +18 18 | +19 19 | +20 |-def func5(arg1: Literal[None, None]): + 20 |+def func5(arg1: None): +21 21 | ... +22 22 | +23 23 | + +PYI061.py:20:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +20 | def func5(arg1: Literal[None, None]): + | ^^^^ PYI061 +21 | ... + | + = help: Replace with `None` + +ℹ Safe fix +17 17 | ... +18 18 | +19 19 | +20 |-def func5(arg1: Literal[None, None]): + 20 |+def func5(arg1: None): +21 21 | ... +22 22 | +23 23 | + +PYI061.py:26:5: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +24 | def func6(arg1: Literal[ +25 | "hello", +26 | None # Comment 1 + | ^^^^ PYI061 +27 | , "world" +28 | ]): + | + = help: Replace with `Literal[...] | None` + +ℹ Unsafe fix +21 21 | ... +22 22 | +23 23 | +24 |-def func6(arg1: Literal[ +25 |- "hello", +26 |- None # Comment 1 +27 |- , "world" +28 |- ]): + 24 |+def func6(arg1: Literal["hello", "world"] | None): +29 25 | ... +30 26 | +31 27 | + +PYI061.py:33:5: PYI061 [*] Use `None` rather than `Literal[None]` + | +32 | def func7(arg1: Literal[ +33 | None # Comment 1 + | ^^^^ PYI061 +34 | ]): +35 | ... + | + = help: Replace with `None` + +ℹ Unsafe fix +29 29 | ... +30 30 | +31 31 | +32 |-def func7(arg1: Literal[ +33 |- None # Comment 1 +34 |- ]): + 32 |+def func7(arg1: None): +35 33 | ... +36 34 | +37 35 | + +PYI061.py:38:25: PYI061 Use `None` rather than `Literal[None]` + | +38 | def func8(arg1: Literal[None] | None): + | ^^^^ PYI061 +39 | ... + | + = help: Replace with `None` + +PYI061.py:42:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +42 | def func9(arg1: Union[Literal[None], None]): + | ^^^^ PYI061 +43 | ... + | + = help: Replace with `None` + +ℹ Safe fix +39 39 | ... +40 40 | +41 41 | +42 |-def func9(arg1: Union[Literal[None], None]): + 42 |+def func9(arg1: Union[None, None]): +43 43 | ... +44 44 | +45 45 | + +PYI061.py:52:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +51 | # From flake8-pyi +52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | + = help: Replace with `None` + +ℹ Safe fix +49 49 | +50 50 | +51 51 | # From flake8-pyi +52 |-Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" + 52 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +53 53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +54 54 | +55 55 | ### + +PYI061.py:53:15: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +51 | # From flake8-pyi +52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" +53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | ^^^^ PYI061 +54 | +55 | ### + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +50 50 | +51 51 | # From flake8-pyi +52 52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" +53 |-Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + 53 |+Literal[True] | None # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +54 54 | +55 55 | ### +56 56 | # The following rules here are slightly subtle, + +PYI061.py:62:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | + = help: Replace with `None` + +ℹ Safe fix +59 59 | +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 |-Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + 62 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +63 63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply + +PYI061.py:62:15: PYI061 [*] Use `None` rather than `Literal[None]` + | +60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | + = help: Replace with `None` + +ℹ Safe fix +59 59 | +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 |-Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + 62 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +63 63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply + +PYI061.py:63:12: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | ^^^^ PYI061 +64 | +65 | # ... but if Y061 and Y062 both apply + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 |-Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + 63 |+Literal[1, "foo"] | None # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, + +PYI061.py:63:25: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | ^^^^ PYI061 +64 | +65 | # ... but if Y061 and Y062 both apply + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 |-Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + 63 |+Literal[1, "foo"] | None # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, + +PYI061.py:68:9: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +66 | # and there are no None members in the Literal[] slice, +67 | # only emit Y062: +68 | Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, +67 67 | # only emit Y062: +68 |-Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + 68 |+Literal[True, True] | None # Y062 Duplicate "Literal[]" member "True" +69 69 | +70 70 | +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.py:68:21: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +66 | # and there are no None members in the Literal[] slice, +67 | # only emit Y062: +68 | Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, +67 67 | # only emit Y062: +68 |-Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + 68 |+Literal[True, True] | None # Y062 Duplicate "Literal[]" member "True" +69 69 | +70 70 | +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.py:72:12: PYI061 Use `None` rather than `Literal[None]` + | +71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 | x: Literal[None] | None + | ^^^^ PYI061 +73 | y: None | Literal[None] +74 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.py:73:19: PYI061 Use `None` rather than `Literal[None]` + | +71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 | x: Literal[None] | None +73 | y: None | Literal[None] + | ^^^^ PYI061 +74 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.py:74:18: PYI061 [*] Use `None` rather than `Literal[None]` + | +72 | x: Literal[None] | None +73 | y: None | Literal[None] +74 | z: Union[Literal[None], None] + | ^^^^ PYI061 +75 | +76 | a: int | Literal[None] | None + | + = help: Replace with `None` + +ℹ Safe fix +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 72 | x: Literal[None] | None +73 73 | y: None | Literal[None] +74 |-z: Union[Literal[None], None] + 74 |+z: Union[None, None] +75 75 | +76 76 | a: int | Literal[None] | None +77 77 | b: None | Literal[None] | None + +PYI061.py:76:18: PYI061 Use `None` rather than `Literal[None]` + | +74 | z: Union[Literal[None], None] +75 | +76 | a: int | Literal[None] | None + | ^^^^ PYI061 +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None + | + = help: Replace with `None` + +PYI061.py:77:19: PYI061 Use `None` rather than `Literal[None]` + | +76 | a: int | Literal[None] | None +77 | b: None | Literal[None] | None + | ^^^^ PYI061 +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) + | + = help: Replace with `None` + +PYI061.py:78:20: PYI061 Use `None` rather than `Literal[None]` + | +76 | a: int | Literal[None] | None +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None + | ^^^^ PYI061 +79 | d: None | (Literal[None] | None) +80 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.py:79:20: PYI061 Use `None` rather than `Literal[None]` + | +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) + | ^^^^ PYI061 +80 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.py:80:28: PYI061 Use `None` rather than `Literal[None]` + | +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) +80 | e: None | ((None | Literal[None]) | None) | None + | ^^^^ PYI061 + | + = help: Replace with `None` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.pyi.snap new file mode 100644 index 0000000000000..6a48501c8dad8 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI061_PYI061.pyi.snap @@ -0,0 +1,304 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI061.pyi:4:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +4 | def func1(arg1: Literal[None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +1 1 | from typing import Literal, Union +2 2 | +3 3 | +4 |-def func1(arg1: Literal[None]): ... + 4 |+def func1(arg1: None): ... +5 5 | +6 6 | +7 7 | def func2(arg1: Literal[None] | int): ... + +PYI061.pyi:7:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +7 | def func2(arg1: Literal[None] | int): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +4 4 | def func1(arg1: Literal[None]): ... +5 5 | +6 6 | +7 |-def func2(arg1: Literal[None] | int): ... + 7 |+def func2(arg1: None | int): ... +8 8 | +9 9 | +10 10 | def func3() -> Literal[None]: ... + +PYI061.pyi:10:24: PYI061 [*] Use `None` rather than `Literal[None]` + | +10 | def func3() -> Literal[None]: ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +7 7 | def func2(arg1: Literal[None] | int): ... +8 8 | +9 9 | +10 |-def func3() -> Literal[None]: ... + 10 |+def func3() -> None: ... +11 11 | +12 12 | +13 13 | def func4(arg1: Literal[int, None, float]): ... + +PYI061.pyi:13:30: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +13 | def func4(arg1: Literal[int, None, float]): ... + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +10 10 | def func3() -> Literal[None]: ... +11 11 | +12 12 | +13 |-def func4(arg1: Literal[int, None, float]): ... + 13 |+def func4(arg1: Literal[int, float] | None): ... +14 14 | +15 15 | +16 16 | def func5(arg1: Literal[None, None]): ... + +PYI061.pyi:16:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +16 | def func5(arg1: Literal[None, None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +13 13 | def func4(arg1: Literal[int, None, float]): ... +14 14 | +15 15 | +16 |-def func5(arg1: Literal[None, None]): ... + 16 |+def func5(arg1: None): ... +17 17 | +18 18 | +19 19 | def func6(arg1: Literal[ + +PYI061.pyi:16:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +16 | def func5(arg1: Literal[None, None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +13 13 | def func4(arg1: Literal[int, None, float]): ... +14 14 | +15 15 | +16 |-def func5(arg1: Literal[None, None]): ... + 16 |+def func5(arg1: None): ... +17 17 | +18 18 | +19 19 | def func6(arg1: Literal[ + +PYI061.pyi:21:5: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +19 | def func6(arg1: Literal[ +20 | "hello", +21 | None # Comment 1 + | ^^^^ PYI061 +22 | , "world" +23 | ]): ... + | + = help: Replace with `Literal[...] | None` + +ℹ Unsafe fix +16 16 | def func5(arg1: Literal[None, None]): ... +17 17 | +18 18 | +19 |-def func6(arg1: Literal[ +20 |- "hello", +21 |- None # Comment 1 +22 |- , "world" +23 |-]): ... + 19 |+def func6(arg1: Literal["hello", "world"] | None): ... +24 20 | +25 21 | +26 22 | def func7(arg1: Literal[ + +PYI061.pyi:27:5: PYI061 [*] Use `None` rather than `Literal[None]` + | +26 | def func7(arg1: Literal[ +27 | None # Comment 1 + | ^^^^ PYI061 +28 | ]): ... + | + = help: Replace with `None` + +ℹ Unsafe fix +23 23 | ]): ... +24 24 | +25 25 | +26 |-def func7(arg1: Literal[ +27 |- None # Comment 1 +28 |-]): ... + 26 |+def func7(arg1: None): ... +29 27 | +30 28 | +31 29 | def func8(arg1: Literal[None] | None):... + +PYI061.pyi:31:25: PYI061 Use `None` rather than `Literal[None]` + | +31 | def func8(arg1: Literal[None] | None):... + | ^^^^ PYI061 + | + = help: Replace with `None` + +PYI061.pyi:34:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +34 | def func9(arg1: Union[Literal[None], None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +31 31 | def func8(arg1: Literal[None] | None):... +32 32 | +33 33 | +34 |-def func9(arg1: Union[Literal[None], None]): ... + 34 |+def func9(arg1: Union[None, None]): ... +35 35 | +36 36 | +37 37 | # OK + +PYI061.pyi:42:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +41 | # From flake8-pyi +42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | + = help: Replace with `None` + +ℹ Safe fix +39 39 | +40 40 | +41 41 | # From flake8-pyi +42 |-Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" + 42 |+None # PYI061 None inside "Literal[]" expression. Replace with "None" +43 43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +44 44 | +45 45 | + +PYI061.pyi:43:15: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +41 | # From flake8-pyi +42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" +43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +40 40 | +41 41 | # From flake8-pyi +42 42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" +43 |-Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + 43 |+Literal[True] | None # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +44 44 | +45 45 | +46 46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.pyi:47:12: PYI061 Use `None` rather than `Literal[None]` + | +46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 | x: Literal[None] | None + | ^^^^ PYI061 +48 | y: None | Literal[None] +49 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.pyi:48:19: PYI061 Use `None` rather than `Literal[None]` + | +46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 | x: Literal[None] | None +48 | y: None | Literal[None] + | ^^^^ PYI061 +49 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.pyi:49:18: PYI061 [*] Use `None` rather than `Literal[None]` + | +47 | x: Literal[None] | None +48 | y: None | Literal[None] +49 | z: Union[Literal[None], None] + | ^^^^ PYI061 +50 | +51 | a: int | Literal[None] | None + | + = help: Replace with `None` + +ℹ Safe fix +46 46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 47 | x: Literal[None] | None +48 48 | y: None | Literal[None] +49 |-z: Union[Literal[None], None] + 49 |+z: Union[None, None] +50 50 | +51 51 | a: int | Literal[None] | None +52 52 | b: None | Literal[None] | None + +PYI061.pyi:51:18: PYI061 Use `None` rather than `Literal[None]` + | +49 | z: Union[Literal[None], None] +50 | +51 | a: int | Literal[None] | None + | ^^^^ PYI061 +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None + | + = help: Replace with `None` + +PYI061.pyi:52:19: PYI061 Use `None` rather than `Literal[None]` + | +51 | a: int | Literal[None] | None +52 | b: None | Literal[None] | None + | ^^^^ PYI061 +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) + | + = help: Replace with `None` + +PYI061.pyi:53:20: PYI061 Use `None` rather than `Literal[None]` + | +51 | a: int | Literal[None] | None +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None + | ^^^^ PYI061 +54 | d: None | (Literal[None] | None) +55 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.pyi:54:20: PYI061 Use `None` rather than `Literal[None]` + | +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) + | ^^^^ PYI061 +55 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.pyi:55:28: PYI061 Use `None` rather than `Literal[None]` + | +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) +55 | e: None | ((None | Literal[None]) | None) | None + | ^^^^ PYI061 + | + = help: Replace with `None` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.py.snap index 2ed8215957160..6af025078bddf 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.py.snap @@ -1,57 +1,112 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI062.py:5:25: PYI062 Duplicate literal member `True` +PYI062.py:5:25: PYI062 [*] Duplicate literal member `True` | 3 | import typing_extensions -4 | +4 | 5 | x: Literal[True, False, True, False] # PYI062 twice here | ^^^^ PYI062 -6 | +6 | 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | + = help: Remove duplicates -PYI062.py:5:31: PYI062 Duplicate literal member `False` +ℹ Safe fix +2 2 | import typing as t +3 3 | import typing_extensions +4 4 | +5 |-x: Literal[True, False, True, False] # PYI062 twice here + 5 |+x: Literal[True, False] # PYI062 twice here +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | + +PYI062.py:5:31: PYI062 [*] Duplicate literal member `False` | 3 | import typing_extensions -4 | +4 | 5 | x: Literal[True, False, True, False] # PYI062 twice here | ^^^^^ PYI062 -6 | +6 | 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | + = help: Remove duplicates + +ℹ Safe fix +2 2 | import typing as t +3 3 | import typing_extensions +4 4 | +5 |-x: Literal[True, False, True, False] # PYI062 twice here + 5 |+x: Literal[True, False] # PYI062 twice here +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | -PYI062.py:7:45: PYI062 Duplicate literal member `1` +PYI062.py:7:45: PYI062 [*] Duplicate literal member `1` | 5 | x: Literal[True, False, True, False] # PYI062 twice here -6 | +6 | 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | ^ PYI062 -8 | +8 | 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal | + = help: Remove duplicates -PYI062.py:9:33: PYI062 Duplicate literal member `{1, 3, 5}` +ℹ Safe fix +4 4 | +5 5 | x: Literal[True, False, True, False] # PYI062 twice here +6 6 | +7 |-y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 + 7 |+y: Literal[1, print("hello"), 3, 4] # PYI062 on the last 1 +8 8 | +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | + +PYI062.py:9:33: PYI062 [*] Duplicate literal member `{1, 3, 5}` | 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 - 8 | + 8 | 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal | ^^^^^^^ PYI062 -10 | +10 | 11 | Literal[1, Literal[1]] # once | + = help: Remove duplicates + +ℹ Safe fix +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | +9 |-z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal + 9 |+z: Literal[{1, 3, 5}, "foobar"] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice -PYI062.py:11:20: PYI062 Duplicate literal member `1` +PYI062.py:11:20: PYI062 [*] Duplicate literal member `1` | 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal -10 | +10 | 11 | Literal[1, Literal[1]] # once | ^ PYI062 12 | Literal[1, 2, Literal[1, 2]] # twice 13 | Literal[1, Literal[1], Literal[1]] # twice | + = help: Remove duplicates -PYI062.py:12:23: PYI062 Duplicate literal member `1` +ℹ Safe fix +8 8 | +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 |-Literal[1, Literal[1]] # once + 11 |+Literal[1] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once + +PYI062.py:12:23: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -59,8 +114,19 @@ PYI062.py:12:23: PYI062 Duplicate literal member `1` 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once | + = help: Remove duplicates + +ℹ Safe fix +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 |-Literal[1, 2, Literal[1, 2]] # twice + 12 |+Literal[1, 2] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once -PYI062.py:12:26: PYI062 Duplicate literal member `2` +PYI062.py:12:26: PYI062 [*] Duplicate literal member `2` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -68,8 +134,19 @@ PYI062.py:12:26: PYI062 Duplicate literal member `2` 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once | + = help: Remove duplicates + +ℹ Safe fix +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 |-Literal[1, 2, Literal[1, 2]] # twice + 12 |+Literal[1, 2] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once -PYI062.py:13:20: PYI062 Duplicate literal member `1` +PYI062.py:13:20: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -78,8 +155,19 @@ PYI062.py:13:20: PYI062 Duplicate literal member `1` 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | + = help: Remove duplicates -PYI062.py:13:32: PYI062 Duplicate literal member `1` +ℹ Safe fix +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 |-Literal[1, Literal[1], Literal[1]] # twice + 13 |+Literal[1] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice + +PYI062.py:13:32: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -88,8 +176,19 @@ PYI062.py:13:32: PYI062 Duplicate literal member `1` 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | + = help: Remove duplicates + +ℹ Safe fix +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 |-Literal[1, Literal[1], Literal[1]] # twice + 13 |+Literal[1] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice -PYI062.py:14:32: PYI062 Duplicate literal member `2` +PYI062.py:14:32: PYI062 [*] Duplicate literal member `2` | 12 | Literal[1, 2, Literal[1, 2]] # twice 13 | Literal[1, Literal[1], Literal[1]] # twice @@ -98,41 +197,157 @@ PYI062.py:14:32: PYI062 Duplicate literal member `2` 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | + = help: Remove duplicates -PYI062.py:15:37: PYI062 Duplicate literal member `1` +ℹ Safe fix +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 |-Literal[1, Literal[2], Literal[2]] # once + 14 |+Literal[1, 2] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 17 | Literal[ + +PYI062.py:15:37: PYI062 [*] Duplicate literal member `1` | 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | ^ PYI062 16 | typing_extensions.Literal[1, 1, 1] # twice +17 | Literal[ | + = help: Remove duplicates + +ℹ Safe fix +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 |-t.Literal[1, t.Literal[2, t.Literal[1]]] # once + 15 |+t.Literal[1, 2] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 17 | Literal[ +18 18 | 1, # comment -PYI062.py:16:30: PYI062 Duplicate literal member `1` +PYI062.py:16:30: PYI062 [*] Duplicate literal member `1` | 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | ^ PYI062 -17 | -18 | # Ensure issue is only raised once, even on nested literals +17 | Literal[ +18 | 1, # comment | + = help: Remove duplicates -PYI062.py:16:33: PYI062 Duplicate literal member `1` +ℹ Safe fix +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 |-typing_extensions.Literal[1, 1, 1] # twice + 16 |+typing_extensions.Literal[1] # twice +17 17 | Literal[ +18 18 | 1, # comment +19 19 | Literal[ # another comment + +PYI062.py:16:33: PYI062 [*] Duplicate literal member `1` | 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | ^ PYI062 -17 | -18 | # Ensure issue is only raised once, even on nested literals +17 | Literal[ +18 | 1, # comment | + = help: Remove duplicates + +ℹ Safe fix +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 |-typing_extensions.Literal[1, 1, 1] # twice + 16 |+typing_extensions.Literal[1] # twice +17 17 | Literal[ +18 18 | 1, # comment +19 19 | Literal[ # another comment -PYI062.py:19:46: PYI062 Duplicate literal member `True` +PYI062.py:20:9: PYI062 [*] Duplicate literal member `1` + | +18 | 1, # comment +19 | Literal[ # another comment +20 | 1 + | ^ PYI062 +21 | ] +22 | ] # once | -18 | # Ensure issue is only raised once, even on nested literals -19 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + = help: Remove duplicates + +ℹ Unsafe fix +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 |-Literal[ +18 |- 1, # comment +19 |- Literal[ # another comment +20 |- 1 +21 |- ] +22 |-] # once + 17 |+Literal[1] # once +23 18 | +24 19 | # Ensure issue is only raised once, even on nested literals +25 20 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + +PYI062.py:25:46: PYI062 [*] Duplicate literal member `True` + | +24 | # Ensure issue is only raised once, even on nested literals +25 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 | ^^^^ PYI062 -20 | -21 | n: Literal["No", "duplicates", "here", 1, "1"] +26 | +27 | n: Literal["No", "duplicates", "here", 1, "1"] | + = help: Remove duplicates + +ℹ Safe fix +22 22 | ] # once +23 23 | +24 24 | # Ensure issue is only raised once, even on nested literals +25 |-MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + 25 |+MyType = Literal["foo", True, False, "bar"] # PYI062 +26 26 | +27 27 | n: Literal["No", "duplicates", "here", 1, "1"] +28 28 | + +PYI062.py:32:37: PYI062 [*] Duplicate literal member `1` + | +30 | # nested literals, all equivalent to `Literal[1]` +31 | Literal[Literal[1]] # no duplicate +32 | Literal[Literal[Literal[1], Literal[1]]] # once + | ^ PYI062 +33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + | + = help: Remove duplicates + +ℹ Safe fix +29 29 | +30 30 | # nested literals, all equivalent to `Literal[1]` +31 31 | Literal[Literal[1]] # no duplicate +32 |-Literal[Literal[Literal[1], Literal[1]]] # once + 32 |+Literal[1] # once +33 33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + +PYI062.py:33:45: PYI062 [*] Duplicate literal member `1` + | +31 | Literal[Literal[1]] # no duplicate +32 | Literal[Literal[Literal[1], Literal[1]]] # once +33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + | ^ PYI062 + | + = help: Remove duplicates + +ℹ Safe fix +30 30 | # nested literals, all equivalent to `Literal[1]` +31 31 | Literal[Literal[1]] # no duplicate +32 32 | Literal[Literal[Literal[1], Literal[1]]] # once +33 |-Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + 33 |+Literal[1] # once diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.pyi.snap index 069024753f74b..60d45bc3c7d79 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.pyi.snap @@ -1,57 +1,112 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI062.pyi:5:25: PYI062 Duplicate literal member `True` +PYI062.pyi:5:25: PYI062 [*] Duplicate literal member `True` | 3 | import typing_extensions -4 | -5 | x: Literal[True, False, True, False] # PY062 twice here +4 | +5 | x: Literal[True, False, True, False] # PYI062 twice here | ^^^^ PYI062 -6 | -7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PY062 on the last 1 +6 | +7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | + = help: Remove duplicates -PYI062.pyi:5:31: PYI062 Duplicate literal member `False` +ℹ Safe fix +2 2 | import typing as t +3 3 | import typing_extensions +4 4 | +5 |-x: Literal[True, False, True, False] # PYI062 twice here + 5 |+x: Literal[True, False] # PYI062 twice here +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | + +PYI062.pyi:5:31: PYI062 [*] Duplicate literal member `False` | 3 | import typing_extensions -4 | -5 | x: Literal[True, False, True, False] # PY062 twice here +4 | +5 | x: Literal[True, False, True, False] # PYI062 twice here | ^^^^^ PYI062 -6 | -7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PY062 on the last 1 +6 | +7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | + = help: Remove duplicates + +ℹ Safe fix +2 2 | import typing as t +3 3 | import typing_extensions +4 4 | +5 |-x: Literal[True, False, True, False] # PYI062 twice here + 5 |+x: Literal[True, False] # PYI062 twice here +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | -PYI062.pyi:7:45: PYI062 Duplicate literal member `1` +PYI062.pyi:7:45: PYI062 [*] Duplicate literal member `1` | -5 | x: Literal[True, False, True, False] # PY062 twice here -6 | -7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PY062 on the last 1 +5 | x: Literal[True, False, True, False] # PYI062 twice here +6 | +7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 | ^ PYI062 -8 | -9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PY062 on the set literal +8 | +9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal | + = help: Remove duplicates -PYI062.pyi:9:33: PYI062 Duplicate literal member `{1, 3, 5}` +ℹ Safe fix +4 4 | +5 5 | x: Literal[True, False, True, False] # PYI062 twice here +6 6 | +7 |-y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 + 7 |+y: Literal[1, print("hello"), 3, 4] # PYI062 on the last 1 +8 8 | +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | + +PYI062.pyi:9:33: PYI062 [*] Duplicate literal member `{1, 3, 5}` | - 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PY062 on the last 1 - 8 | - 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PY062 on the set literal + 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 + 8 | + 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal | ^^^^^^^ PYI062 -10 | +10 | 11 | Literal[1, Literal[1]] # once | + = help: Remove duplicates + +ℹ Safe fix +6 6 | +7 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]] # PYI062 on the last 1 +8 8 | +9 |-z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal + 9 |+z: Literal[{1, 3, 5}, "foobar"] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice -PYI062.pyi:11:20: PYI062 Duplicate literal member `1` +PYI062.pyi:11:20: PYI062 [*] Duplicate literal member `1` | - 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PY062 on the set literal -10 | + 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 | 11 | Literal[1, Literal[1]] # once | ^ PYI062 12 | Literal[1, 2, Literal[1, 2]] # twice 13 | Literal[1, Literal[1], Literal[1]] # twice | + = help: Remove duplicates -PYI062.pyi:12:23: PYI062 Duplicate literal member `1` +ℹ Safe fix +8 8 | +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 |-Literal[1, Literal[1]] # once + 11 |+Literal[1] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once + +PYI062.pyi:12:23: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -59,8 +114,19 @@ PYI062.pyi:12:23: PYI062 Duplicate literal member `1` 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once | + = help: Remove duplicates + +ℹ Safe fix +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 |-Literal[1, 2, Literal[1, 2]] # twice + 12 |+Literal[1, 2] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once -PYI062.pyi:12:26: PYI062 Duplicate literal member `2` +PYI062.pyi:12:26: PYI062 [*] Duplicate literal member `2` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -68,8 +134,19 @@ PYI062.pyi:12:26: PYI062 Duplicate literal member `2` 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once | + = help: Remove duplicates + +ℹ Safe fix +9 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}] # PYI062 on the set literal +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 |-Literal[1, 2, Literal[1, 2]] # twice + 12 |+Literal[1, 2] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once -PYI062.pyi:13:20: PYI062 Duplicate literal member `1` +PYI062.pyi:13:20: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -78,8 +155,19 @@ PYI062.pyi:13:20: PYI062 Duplicate literal member `1` 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | + = help: Remove duplicates -PYI062.pyi:13:32: PYI062 Duplicate literal member `1` +ℹ Safe fix +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 |-Literal[1, Literal[1], Literal[1]] # twice + 13 |+Literal[1] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice + +PYI062.pyi:13:32: PYI062 [*] Duplicate literal member `1` | 11 | Literal[1, Literal[1]] # once 12 | Literal[1, 2, Literal[1, 2]] # twice @@ -88,8 +176,19 @@ PYI062.pyi:13:32: PYI062 Duplicate literal member `1` 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | + = help: Remove duplicates + +ℹ Safe fix +10 10 | +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 |-Literal[1, Literal[1], Literal[1]] # twice + 13 |+Literal[1] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice -PYI062.pyi:14:32: PYI062 Duplicate literal member `2` +PYI062.pyi:14:32: PYI062 [*] Duplicate literal member `2` | 12 | Literal[1, 2, Literal[1, 2]] # twice 13 | Literal[1, Literal[1], Literal[1]] # twice @@ -98,41 +197,157 @@ PYI062.pyi:14:32: PYI062 Duplicate literal member `2` 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | + = help: Remove duplicates -PYI062.pyi:15:37: PYI062 Duplicate literal member `1` +ℹ Safe fix +11 11 | Literal[1, Literal[1]] # once +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 |-Literal[1, Literal[2], Literal[2]] # once + 14 |+Literal[1, 2] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 17 | Literal[ + +PYI062.pyi:15:37: PYI062 [*] Duplicate literal member `1` | 13 | Literal[1, Literal[1], Literal[1]] # twice 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once | ^ PYI062 16 | typing_extensions.Literal[1, 1, 1] # twice +17 | Literal[ | + = help: Remove duplicates + +ℹ Safe fix +12 12 | Literal[1, 2, Literal[1, 2]] # twice +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 |-t.Literal[1, t.Literal[2, t.Literal[1]]] # once + 15 |+t.Literal[1, 2] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 17 | Literal[ +18 18 | 1, # comment -PYI062.pyi:16:30: PYI062 Duplicate literal member `1` +PYI062.pyi:16:30: PYI062 [*] Duplicate literal member `1` | 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | ^ PYI062 -17 | -18 | # Ensure issue is only raised once, even on nested literals +17 | Literal[ +18 | 1, # comment | + = help: Remove duplicates -PYI062.pyi:16:33: PYI062 Duplicate literal member `1` +ℹ Safe fix +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 |-typing_extensions.Literal[1, 1, 1] # twice + 16 |+typing_extensions.Literal[1] # twice +17 17 | Literal[ +18 18 | 1, # comment +19 19 | Literal[ # another comment + +PYI062.pyi:16:33: PYI062 [*] Duplicate literal member `1` | 14 | Literal[1, Literal[2], Literal[2]] # once 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once 16 | typing_extensions.Literal[1, 1, 1] # twice | ^ PYI062 -17 | -18 | # Ensure issue is only raised once, even on nested literals +17 | Literal[ +18 | 1, # comment | + = help: Remove duplicates + +ℹ Safe fix +13 13 | Literal[1, Literal[1], Literal[1]] # twice +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 |-typing_extensions.Literal[1, 1, 1] # twice + 16 |+typing_extensions.Literal[1] # twice +17 17 | Literal[ +18 18 | 1, # comment +19 19 | Literal[ # another comment -PYI062.pyi:19:46: PYI062 Duplicate literal member `True` +PYI062.pyi:20:9: PYI062 [*] Duplicate literal member `1` + | +18 | 1, # comment +19 | Literal[ # another comment +20 | 1 + | ^ PYI062 +21 | ] +22 | ] # once | -18 | # Ensure issue is only raised once, even on nested literals -19 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + = help: Remove duplicates + +ℹ Unsafe fix +14 14 | Literal[1, Literal[2], Literal[2]] # once +15 15 | t.Literal[1, t.Literal[2, t.Literal[1]]] # once +16 16 | typing_extensions.Literal[1, 1, 1] # twice +17 |-Literal[ +18 |- 1, # comment +19 |- Literal[ # another comment +20 |- 1 +21 |- ] +22 |-] # once + 17 |+Literal[1] # once +23 18 | +24 19 | # Ensure issue is only raised once, even on nested literals +25 20 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + +PYI062.pyi:25:46: PYI062 [*] Duplicate literal member `True` + | +24 | # Ensure issue is only raised once, even on nested literals +25 | MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 | ^^^^ PYI062 -20 | -21 | n: Literal["No", "duplicates", "here", 1, "1"] +26 | +27 | n: Literal["No", "duplicates", "here", 1, "1"] | + = help: Remove duplicates + +ℹ Safe fix +22 22 | ] # once +23 23 | +24 24 | # Ensure issue is only raised once, even on nested literals +25 |-MyType = Literal["foo", Literal[True, False, True], "bar"] # PYI062 + 25 |+MyType = Literal["foo", True, False, "bar"] # PYI062 +26 26 | +27 27 | n: Literal["No", "duplicates", "here", 1, "1"] +28 28 | + +PYI062.pyi:32:37: PYI062 [*] Duplicate literal member `1` + | +30 | # nested literals, all equivalent to `Literal[1]` +31 | Literal[Literal[1]] # no duplicate +32 | Literal[Literal[Literal[1], Literal[1]]] # once + | ^ PYI062 +33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + | + = help: Remove duplicates + +ℹ Safe fix +29 29 | +30 30 | # nested literals, all equivalent to `Literal[1]` +31 31 | Literal[Literal[1]] # no duplicate +32 |-Literal[Literal[Literal[1], Literal[1]]] # once + 32 |+Literal[1] # once +33 33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + +PYI062.pyi:33:45: PYI062 [*] Duplicate literal member `1` + | +31 | Literal[Literal[1]] # no duplicate +32 | Literal[Literal[Literal[1], Literal[1]]] # once +33 | Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + | ^ PYI062 + | + = help: Remove duplicates + +ℹ Safe fix +30 30 | # nested literals, all equivalent to `Literal[1]` +31 31 | Literal[Literal[1]] # no duplicate +32 32 | Literal[Literal[Literal[1], Literal[1]]] # once +33 |-Literal[Literal[1], Literal[Literal[Literal[1]]]] # once + 33 |+Literal[1] # once diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.py.snap index 030bdd99cf00c..044005bebb802 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.py.snap @@ -1,10 +1,10 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI063.py:6:9: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:6:9: PYI063 Use PEP 570 syntax for positional-only parameters | 4 | from typing import Self -5 | +5 | 6 | def bad(__x: int) -> None: ... # PYI063 | ^^^ PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 @@ -12,7 +12,7 @@ PYI063.py:6:9: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:7:14: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:7:14: PYI063 Use PEP 570 syntax for positional-only parameters | 6 | def bad(__x: int) -> None: ... # PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 @@ -21,18 +21,18 @@ PYI063.py:7:14: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:8:15: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:8:15: PYI063 Use PEP 570 syntax for positional-only parameters | 6 | def bad(__x: int) -> None: ... # PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 8 | def still_bad(__x_: int) -> None: ... # PYI063 | ^^^^ PYI063 - 9 | + 9 | 10 | def no_args() -> None: ... | = help: Add `/` to function signature -PYI063.py:24:14: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:24:14: PYI063 Use PEP 570 syntax for positional-only parameters | 22 | def bad(__self) -> None: ... # PYI063 23 | @staticmethod @@ -43,7 +43,7 @@ PYI063.py:24:14: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:25:22: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:25:22: PYI063 Use PEP 570 syntax for positional-only parameters | 23 | @staticmethod 24 | def bad2(__self) -> None: ... # PYI063 @@ -54,7 +54,7 @@ PYI063.py:25:22: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:26:25: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:26:25: PYI063 Use PEP 570 syntax for positional-only parameters | 24 | def bad2(__self) -> None: ... # PYI063 25 | def bad3(__self, __x: int) -> None: ... # PYI063 @@ -65,7 +65,7 @@ PYI063.py:26:25: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:28:25: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:28:25: PYI063 Use PEP 570 syntax for positional-only parameters | 26 | def still_bad(self, __x_: int) -> None: ... # PYI063 27 | @staticmethod @@ -76,35 +76,35 @@ PYI063.py:28:25: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.py:30:23: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:30:23: PYI063 Use PEP 570 syntax for positional-only parameters | 28 | def this_is_bad_too(__x: int) -> None: ... # PYI063 29 | @classmethod 30 | def not_good(cls, __foo: int) -> None: ... # PYI063 | ^^^^^ PYI063 -31 | +31 | 32 | # The first non-self argument isn't positional-only, so logically the second can't be either: | = help: Add `/` to function signature -PYI063.py:52:23: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:52:23: PYI063 Use PEP 570 syntax for positional-only parameters | 50 | class Metaclass(type): 51 | @classmethod 52 | def __new__(mcls, __name: str, __bases: tuple[type, ...], __namespace: dict, **kwds) -> Self: ... # PYI063 | ^^^^^^ PYI063 -53 | +53 | 54 | class Metaclass2(type): | = help: Add `/` to function signature -PYI063.py:56:26: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.py:56:26: PYI063 Use PEP 570 syntax for positional-only parameters | 54 | class Metaclass2(type): 55 | @classmethod 56 | def __new__(metacls, __name: str, __bases: tuple[type, ...], __namespace: dict, **kwds) -> Self: ... # PYI063 | ^^^^^^ PYI063 -57 | +57 | 58 | class GoodMetaclass(type): | = help: Add `/` to function signature diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.pyi.snap index 8a943194f32f2..093baf963ab26 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI063_PYI063.pyi.snap @@ -1,10 +1,10 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs --- -PYI063.pyi:6:9: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:6:9: PYI063 Use PEP 570 syntax for positional-only parameters | 4 | from typing import Self -5 | +5 | 6 | def bad(__x: int) -> None: ... # PYI063 | ^^^ PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 @@ -12,7 +12,7 @@ PYI063.pyi:6:9: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:7:14: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:7:14: PYI063 Use PEP 570 syntax for positional-only parameters | 6 | def bad(__x: int) -> None: ... # PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 @@ -21,18 +21,18 @@ PYI063.pyi:7:14: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:8:15: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:8:15: PYI063 Use PEP 570 syntax for positional-only parameters | 6 | def bad(__x: int) -> None: ... # PYI063 7 | def also_bad(__x: int, __y: str) -> None: ... # PYI063 8 | def still_bad(__x_: int) -> None: ... # PYI063 | ^^^^ PYI063 - 9 | + 9 | 10 | def no_args() -> None: ... | = help: Add `/` to function signature -PYI063.pyi:24:14: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:24:14: PYI063 Use PEP 570 syntax for positional-only parameters | 22 | def bad(__self) -> None: ... # PYI063 23 | @staticmethod @@ -43,7 +43,7 @@ PYI063.pyi:24:14: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:25:22: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:25:22: PYI063 Use PEP 570 syntax for positional-only parameters | 23 | @staticmethod 24 | def bad2(__self) -> None: ... # PYI063 @@ -54,7 +54,7 @@ PYI063.pyi:25:22: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:26:25: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:26:25: PYI063 Use PEP 570 syntax for positional-only parameters | 24 | def bad2(__self) -> None: ... # PYI063 25 | def bad3(__self, __x: int) -> None: ... # PYI063 @@ -65,7 +65,7 @@ PYI063.pyi:26:25: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:28:25: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:28:25: PYI063 Use PEP 570 syntax for positional-only parameters | 26 | def still_bad(self, __x_: int) -> None: ... # PYI063 # TODO: doesn't get raised here 27 | @staticmethod @@ -76,35 +76,35 @@ PYI063.pyi:28:25: PYI063 Use PEP 570 syntax for positional-only arguments | = help: Add `/` to function signature -PYI063.pyi:30:23: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:30:23: PYI063 Use PEP 570 syntax for positional-only parameters | 28 | def this_is_bad_too(__x: int) -> None: ... # PYI063 29 | @classmethod 30 | def not_good(cls, __foo: int) -> None: ... # PYI063 | ^^^^^ PYI063 -31 | +31 | 32 | # The first non-self argument isn't positional-only, so logically the second can't be either: | = help: Add `/` to function signature -PYI063.pyi:52:23: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:52:23: PYI063 Use PEP 570 syntax for positional-only parameters | 50 | class Metaclass(type): 51 | @classmethod 52 | def __new__(mcls, __name: str, __bases: tuple[type, ...], __namespace: dict, **kwds) -> Self: ... # PYI063 | ^^^^^^ PYI063 -53 | +53 | 54 | class Metaclass2(type): | = help: Add `/` to function signature -PYI063.pyi:56:26: PYI063 Use PEP 570 syntax for positional-only arguments +PYI063.pyi:56:26: PYI063 Use PEP 570 syntax for positional-only parameters | 54 | class Metaclass2(type): 55 | @classmethod 56 | def __new__(metacls, __name: str, __bases: tuple[type, ...], __namespace: dict, **kwds) -> Self: ... # PYI063 | ^^^^^^ PYI063 -57 | +57 | 58 | class GoodMetaclass(type): | = help: Add `/` to function signature diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.py.snap index 4e441d5012a1f..f212abc18bb62 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI064.py:3:1: PYI064 [*] `Final[Literal[True]]` can be replaced with a bare `Final` | 1 | from typing import Final, Literal -2 | +2 | 3 | x: Final[Literal[True]] = True # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI064 4 | y: Final[Literal[None]] = None # PYI064 @@ -49,7 +49,7 @@ PYI064.py:5:1: PYI064 [*] `Final[Literal[...]]` can be replaced with a bare `Fin 6 | | "this is a really long literal, that won't be rendered in the issue text" 7 | | ]] = "this is a really long literal, that won't be rendered in the issue text" | |______________________________________________________________________________^ PYI064 -8 | +8 | 9 | # This should be fixable, and marked as safe | = help: Replace with `Final` @@ -71,7 +71,7 @@ PYI064.py:10:1: PYI064 [*] `Final[Literal[123]]` can be replaced with a bare `Fi 9 | # This should be fixable, and marked as safe 10 | w1: Final[Literal[123]] # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^ PYI064 -11 | +11 | 12 | # This should not be fixable | = help: Replace with `Final` @@ -91,7 +91,7 @@ PYI064.py:13:1: PYI064 `Final[Literal[123]]` can be replaced with a bare `Final` 12 | # This should not be fixable 13 | w2: Final[Literal[123]] = "random value" # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI064 -14 | +14 | 15 | n1: Final[Literal[True, False]] = True # No issue here | = help: Replace with `Final` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.pyi.snap index 2c25d8adc5f36..b02cfb5cc89b9 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI064_PYI064.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI064.pyi:3:1: PYI064 [*] `Final[Literal[True]]` can be replaced with a bare `Final` | 1 | from typing import Final, Literal -2 | +2 | 3 | x: Final[Literal[True]] # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^ PYI064 4 | y: Final[Literal[None]] = None # PYI064 @@ -46,7 +46,7 @@ PYI064.pyi:5:1: PYI064 [*] `Final[Literal[...]]` can be replaced with a bare `Fi 4 | y: Final[Literal[None]] = None # PYI064 5 | z: Final[Literal["this is a really long literal, that won't be rendered in the issue text"]] # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI064 -6 | +6 | 7 | # This should be fixable, and marked as safe | = help: Replace with `Final` @@ -66,7 +66,7 @@ PYI064.pyi:8:1: PYI064 [*] `Final[Literal[123]]` can be replaced with a bare `Fi 7 | # This should be fixable, and marked as safe 8 | w1: Final[Literal[123]] # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^ PYI064 - 9 | + 9 | 10 | # This should not be fixable | = help: Replace with `Final` @@ -86,7 +86,7 @@ PYI064.pyi:11:1: PYI064 `Final[Literal[123]]` can be replaced with a bare `Final 10 | # This should not be fixable 11 | w2: Final[Literal[123]] = "random value" # PYI064 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI064 -12 | +12 | 13 | n1: Final[Literal[True, False]] # No issue here | = help: Replace with `Final` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.pyi.snap index fbc165d7192ed..3d8cec865cbd9 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI066_PYI066.pyi.snap @@ -1,51 +1,52 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- -PYI066.pyi:3:4: PYI066 Use `>=` when using `if`-`else` with `sys.version_info` comparisons +PYI066.pyi:3:4: PYI066 Put branches for newer Python versions first when branching on `sys.version_info` comparisons | 1 | import sys -2 | -3 | if sys.version_info < (3, 10): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 10)" +2 | +3 | if sys.version_info < (3, 10): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if s… | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI066 4 | def foo(x): ... 5 | else: | -PYI066.pyi:8:4: PYI066 Use `>=` when using `if`-`else` with `sys.version_info` comparisons +PYI066.pyi:8:4: PYI066 Put branches for newer Python versions first when branching on `sys.version_info` comparisons | 6 | def foo(x, *, bar=True): ... - 7 | - 8 | if sys.version_info < (3, 8): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 8)" + 7 | + 8 | if sys.version_info < (3, 8): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if s… | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI066 9 | def bar(x): ... -10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 9)" +10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if… | -PYI066.pyi:10:6: PYI066 Use `>=` when using `if`-`else` with `sys.version_info` comparisons +PYI066.pyi:10:6: PYI066 Put branches for newer Python versions first when branching on `sys.version_info` comparisons | - 8 | if sys.version_info < (3, 8): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 8)" + 8 | if sys.version_info < (3, 8): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if s… 9 | def bar(x): ... -10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 9)" +10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if… | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI066 11 | def bar(x, *, bar=True): ... -12 | elif sys.version_info < (3, 11): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 10)" +12 | elif sys.version_info < (3, 11): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "i… | -PYI066.pyi:12:6: PYI066 Use `>=` when using `if`-`else` with `sys.version_info` comparisons +PYI066.pyi:12:6: PYI066 Put branches for newer Python versions first when branching on `sys.version_info` comparisons | -10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 9)" +10 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if… 11 | def bar(x, *, bar=True): ... -12 | elif sys.version_info < (3, 11): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 10)" +12 | elif sys.version_info < (3, 11): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "i… | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI066 13 | def bar(x, *, bar=True, baz=False): ... 14 | else: | -PYI066.pyi:20:6: PYI066 Use `>=` when using `if`-`else` with `sys.version_info` comparisons +PYI066.pyi:20:6: PYI066 Put branches for newer Python versions first when branching on `sys.version_info` comparisons | 18 | if sys.version_info >= (3, 5): 19 | ... -20 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if sys.version_info >= (3, 10)" +20 | elif sys.version_info < (3, 9): # Y066 When using if/else with sys.version_info, put the code for new Python versions first, e.g. "if… | ^^^^^^^^^^^^^^^^^^^^^^^^^ PYI066 21 | ... 22 | else: diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__preview__PYI044_PYI044.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__preview__PYI044_PYI044.pyi.snap index 5ddf8be331d38..4ae21763be417 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__preview__PYI044_PYI044.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__preview__PYI044_PYI044.pyi.snap @@ -23,7 +23,7 @@ PYI044.pyi:3:1: PYI044 [*] `from __future__ import annotations` has no effect in 2 | from __future__ import annotations # PYI044. 3 | from __future__ import annotations, with_statement # PYI044. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI044 -4 | +4 | 5 | # Good imports. | = help: Remove `from __future__ import annotations` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.py.snap index f0a4f44d2b294..5990d00bfebec 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.py.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.pyi.snap index 7c5cd3152327a..405375d03286f 100644 --- a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.pyi.snap +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI026_PYI026.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs PYI026.pyi:3:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g., `NewAny: TypeAlias = Any` | 1 | from typing import Literal, Any -2 | +2 | 3 | NewAny = Any | ^^^^^^ PYI026 4 | OptionalStr = typing.Optional[str] @@ -14,10 +14,10 @@ PYI026.pyi:3:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 |-NewAny = Any - 4 |+NewAny: typing_extensions.TypeAlias = Any + 4 |+NewAny: TypeAlias = Any 4 5 | OptionalStr = typing.Optional[str] 5 6 | Foo = Literal["foo"] 6 7 | IntOrStr = int | str @@ -34,11 +34,11 @@ PYI026.pyi:4:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 4 | NewAny = Any 4 |-OptionalStr = typing.Optional[str] - 5 |+OptionalStr: typing_extensions.TypeAlias = typing.Optional[str] + 5 |+OptionalStr: TypeAlias = typing.Optional[str] 5 6 | Foo = Literal["foo"] 6 7 | IntOrStr = int | str 7 8 | AliasNone = None @@ -56,12 +56,12 @@ PYI026.pyi:5:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 4 | NewAny = Any 4 5 | OptionalStr = typing.Optional[str] 5 |-Foo = Literal["foo"] - 6 |+Foo: typing_extensions.TypeAlias = Literal["foo"] + 6 |+Foo: TypeAlias = Literal["foo"] 6 7 | IntOrStr = int | str 7 8 | AliasNone = None 8 9 | @@ -78,13 +78,13 @@ PYI026.pyi:6:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 4 | NewAny = Any 4 5 | OptionalStr = typing.Optional[str] 5 6 | Foo = Literal["foo"] 6 |-IntOrStr = int | str - 7 |+IntOrStr: typing_extensions.TypeAlias = int | str + 7 |+IntOrStr: TypeAlias = int | str 7 8 | AliasNone = None 8 9 | 9 10 | NewAny: typing.TypeAlias = Any @@ -95,21 +95,21 @@ PYI026.pyi:7:1: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e.g 6 | IntOrStr = int | str 7 | AliasNone = None | ^^^^^^^^^ PYI026 -8 | +8 | 9 | NewAny: typing.TypeAlias = Any | = help: Add `TypeAlias` annotation ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 4 | NewAny = Any 4 5 | OptionalStr = typing.Optional[str] 5 6 | Foo = Literal["foo"] 6 7 | IntOrStr = int | str 7 |-AliasNone = None - 8 |+AliasNone: typing_extensions.TypeAlias = None + 8 |+AliasNone: TypeAlias = None 8 9 | 9 10 | NewAny: typing.TypeAlias = Any 10 11 | OptionalStr: TypeAlias = typing.Optional[str] @@ -119,14 +119,14 @@ PYI026.pyi:17:5: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e. 16 | class NotAnEnum: 17 | FLAG_THIS = None | ^^^^^^^^^ PYI026 -18 | +18 | 19 | # these are ok | = help: Add `TypeAlias` annotation ℹ Safe fix 1 1 | from typing import Literal, Any - 2 |+import typing_extensions + 2 |+from typing_extensions import TypeAlias 2 3 | 3 4 | NewAny = Any 4 5 | OptionalStr = typing.Optional[str] @@ -135,7 +135,7 @@ PYI026.pyi:17:5: PYI026 [*] Use `typing_extensions.TypeAlias` for type alias, e. 15 16 | 16 17 | class NotAnEnum: 17 |- FLAG_THIS = None - 18 |+ FLAG_THIS: typing_extensions.TypeAlias = None + 18 |+ FLAG_THIS: TypeAlias = None 18 19 | 19 20 | # these are ok 20 21 | from enum import Enum diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.py.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.py.snap new file mode 100644 index 0000000000000..bbee6e9da58cd --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.py.snap @@ -0,0 +1,477 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI061.py:4:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +4 | def func1(arg1: Literal[None]): + | ^^^^ PYI061 +5 | ... + | + = help: Replace with `None` + +ℹ Safe fix +1 1 | from typing import Literal, Union +2 2 | +3 3 | +4 |-def func1(arg1: Literal[None]): + 4 |+def func1(arg1: None): +5 5 | ... +6 6 | +7 7 | + +PYI061.py:8:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +8 | def func2(arg1: Literal[None] | int): + | ^^^^ PYI061 +9 | ... + | + = help: Replace with `None` + +ℹ Safe fix +5 5 | ... +6 6 | +7 7 | +8 |-def func2(arg1: Literal[None] | int): + 8 |+def func2(arg1: None | int): +9 9 | ... +10 10 | +11 11 | + +PYI061.py:12:24: PYI061 [*] Use `None` rather than `Literal[None]` + | +12 | def func3() -> Literal[None]: + | ^^^^ PYI061 +13 | ... + | + = help: Replace with `None` + +ℹ Safe fix +9 9 | ... +10 10 | +11 11 | +12 |-def func3() -> Literal[None]: + 12 |+def func3() -> None: +13 13 | ... +14 14 | +15 15 | + +PYI061.py:16:30: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +16 | def func4(arg1: Literal[int, None, float]): + | ^^^^ PYI061 +17 | ... + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +13 13 | ... +14 14 | +15 15 | +16 |-def func4(arg1: Literal[int, None, float]): + 16 |+def func4(arg1: Optional[Literal[int, float]]): +17 17 | ... +18 18 | +19 19 | + +PYI061.py:20:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +20 | def func5(arg1: Literal[None, None]): + | ^^^^ PYI061 +21 | ... + | + = help: Replace with `None` + +ℹ Safe fix +17 17 | ... +18 18 | +19 19 | +20 |-def func5(arg1: Literal[None, None]): + 20 |+def func5(arg1: None): +21 21 | ... +22 22 | +23 23 | + +PYI061.py:20:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +20 | def func5(arg1: Literal[None, None]): + | ^^^^ PYI061 +21 | ... + | + = help: Replace with `None` + +ℹ Safe fix +17 17 | ... +18 18 | +19 19 | +20 |-def func5(arg1: Literal[None, None]): + 20 |+def func5(arg1: None): +21 21 | ... +22 22 | +23 23 | + +PYI061.py:26:5: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +24 | def func6(arg1: Literal[ +25 | "hello", +26 | None # Comment 1 + | ^^^^ PYI061 +27 | , "world" +28 | ]): + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Unsafe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +21 21 | ... +22 22 | +23 23 | +24 |-def func6(arg1: Literal[ +25 |- "hello", +26 |- None # Comment 1 +27 |- , "world" +28 |- ]): + 24 |+def func6(arg1: Optional[Literal["hello", "world"]]): +29 25 | ... +30 26 | +31 27 | + +PYI061.py:33:5: PYI061 [*] Use `None` rather than `Literal[None]` + | +32 | def func7(arg1: Literal[ +33 | None # Comment 1 + | ^^^^ PYI061 +34 | ]): +35 | ... + | + = help: Replace with `None` + +ℹ Unsafe fix +29 29 | ... +30 30 | +31 31 | +32 |-def func7(arg1: Literal[ +33 |- None # Comment 1 +34 |- ]): + 32 |+def func7(arg1: None): +35 33 | ... +36 34 | +37 35 | + +PYI061.py:38:25: PYI061 Use `None` rather than `Literal[None]` + | +38 | def func8(arg1: Literal[None] | None): + | ^^^^ PYI061 +39 | ... + | + = help: Replace with `None` + +PYI061.py:42:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +42 | def func9(arg1: Union[Literal[None], None]): + | ^^^^ PYI061 +43 | ... + | + = help: Replace with `None` + +ℹ Safe fix +39 39 | ... +40 40 | +41 41 | +42 |-def func9(arg1: Union[Literal[None], None]): + 42 |+def func9(arg1: Union[None, None]): +43 43 | ... +44 44 | +45 45 | + +PYI061.py:52:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +51 | # From flake8-pyi +52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | + = help: Replace with `None` + +ℹ Safe fix +49 49 | +50 50 | +51 51 | # From flake8-pyi +52 |-Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" + 52 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +53 53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +54 54 | +55 55 | ### + +PYI061.py:53:15: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +51 | # From flake8-pyi +52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" +53 | Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | ^^^^ PYI061 +54 | +55 | ### + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +50 50 | +51 51 | # From flake8-pyi +52 52 | Literal[None] # Y061 None inside "Literal[]" expression. Replace with "None" +53 |-Literal[True, None] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + 53 |+Optional[Literal[True]] # Y061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +54 54 | +55 55 | ### +56 56 | # The following rules here are slightly subtle, + +PYI061.py:62:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | + = help: Replace with `None` + +ℹ Safe fix +59 59 | +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 |-Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + 62 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +63 63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply + +PYI061.py:62:15: PYI061 [*] Use `None` rather than `Literal[None]` + | +60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | + = help: Replace with `None` + +ℹ Safe fix +59 59 | +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 |-Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" + 62 |+None # Y061 None inside "Literal[]" expression. Replace with "None" +63 63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply + +PYI061.py:63:12: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | ^^^^ PYI061 +64 | +65 | # ... but if Y061 and Y062 both apply + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 |-Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + 63 |+Optional[Literal[1, "foo"]] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, + +PYI061.py:63:25: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +61 | # only emit Y061... +62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 | Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + | ^^^^ PYI061 +64 | +65 | # ... but if Y061 and Y062 both apply + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +60 60 | # If Y061 and Y062 both apply, but all the duplicate members are None, +61 61 | # only emit Y061... +62 62 | Literal[None, None] # Y061 None inside "Literal[]" expression. Replace with "None" +63 |-Literal[1, None, "foo", None] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" + 63 |+Optional[Literal[1, "foo"]] # Y061 None inside "Literal[]" expression. Replace with "Literal[1, 'foo'] | None" +64 64 | +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, + +PYI061.py:68:9: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +66 | # and there are no None members in the Literal[] slice, +67 | # only emit Y062: +68 | Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + | ^^^^ PYI061 + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, +67 67 | # only emit Y062: +68 |-Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + 68 |+Optional[Literal[True, True]] # Y062 Duplicate "Literal[]" member "True" +69 69 | +70 70 | +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.py:68:21: PYI061 [*] Use `Optional[Literal[...]]` rather than `Literal[None, ...]` + | +66 | # and there are no None members in the Literal[] slice, +67 | # only emit Y062: +68 | Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + | ^^^^ PYI061 + | + = help: Replace with `Optional[Literal[...]]` + +ℹ Safe fix +1 |-from typing import Literal, Union + 1 |+from typing import Literal, Union, Optional +2 2 | +3 3 | +4 4 | def func1(arg1: Literal[None]): +-------------------------------------------------------------------------------- +65 65 | # ... but if Y061 and Y062 both apply +66 66 | # and there are no None members in the Literal[] slice, +67 67 | # only emit Y062: +68 |-Literal[None, True, None, True] # Y062 Duplicate "Literal[]" member "True" + 68 |+Optional[Literal[True, True]] # Y062 Duplicate "Literal[]" member "True" +69 69 | +70 70 | +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.py:72:12: PYI061 Use `None` rather than `Literal[None]` + | +71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 | x: Literal[None] | None + | ^^^^ PYI061 +73 | y: None | Literal[None] +74 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.py:73:19: PYI061 Use `None` rather than `Literal[None]` + | +71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 | x: Literal[None] | None +73 | y: None | Literal[None] + | ^^^^ PYI061 +74 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.py:74:18: PYI061 [*] Use `None` rather than `Literal[None]` + | +72 | x: Literal[None] | None +73 | y: None | Literal[None] +74 | z: Union[Literal[None], None] + | ^^^^ PYI061 +75 | +76 | a: int | Literal[None] | None + | + = help: Replace with `None` + +ℹ Safe fix +71 71 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +72 72 | x: Literal[None] | None +73 73 | y: None | Literal[None] +74 |-z: Union[Literal[None], None] + 74 |+z: Union[None, None] +75 75 | +76 76 | a: int | Literal[None] | None +77 77 | b: None | Literal[None] | None + +PYI061.py:76:18: PYI061 Use `None` rather than `Literal[None]` + | +74 | z: Union[Literal[None], None] +75 | +76 | a: int | Literal[None] | None + | ^^^^ PYI061 +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None + | + = help: Replace with `None` + +PYI061.py:77:19: PYI061 Use `None` rather than `Literal[None]` + | +76 | a: int | Literal[None] | None +77 | b: None | Literal[None] | None + | ^^^^ PYI061 +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) + | + = help: Replace with `None` + +PYI061.py:78:20: PYI061 Use `None` rather than `Literal[None]` + | +76 | a: int | Literal[None] | None +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None + | ^^^^ PYI061 +79 | d: None | (Literal[None] | None) +80 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.py:79:20: PYI061 Use `None` rather than `Literal[None]` + | +77 | b: None | Literal[None] | None +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) + | ^^^^ PYI061 +80 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.py:80:28: PYI061 Use `None` rather than `Literal[None]` + | +78 | c: (None | Literal[None]) | None +79 | d: None | (Literal[None] | None) +80 | e: None | ((None | Literal[None]) | None) | None + | ^^^^ PYI061 + | + = help: Replace with `None` diff --git a/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.pyi.snap b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.pyi.snap new file mode 100644 index 0000000000000..6a48501c8dad8 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__py38_PYI061_PYI061.pyi.snap @@ -0,0 +1,304 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs +--- +PYI061.pyi:4:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +4 | def func1(arg1: Literal[None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +1 1 | from typing import Literal, Union +2 2 | +3 3 | +4 |-def func1(arg1: Literal[None]): ... + 4 |+def func1(arg1: None): ... +5 5 | +6 6 | +7 7 | def func2(arg1: Literal[None] | int): ... + +PYI061.pyi:7:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +7 | def func2(arg1: Literal[None] | int): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +4 4 | def func1(arg1: Literal[None]): ... +5 5 | +6 6 | +7 |-def func2(arg1: Literal[None] | int): ... + 7 |+def func2(arg1: None | int): ... +8 8 | +9 9 | +10 10 | def func3() -> Literal[None]: ... + +PYI061.pyi:10:24: PYI061 [*] Use `None` rather than `Literal[None]` + | +10 | def func3() -> Literal[None]: ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +7 7 | def func2(arg1: Literal[None] | int): ... +8 8 | +9 9 | +10 |-def func3() -> Literal[None]: ... + 10 |+def func3() -> None: ... +11 11 | +12 12 | +13 13 | def func4(arg1: Literal[int, None, float]): ... + +PYI061.pyi:13:30: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +13 | def func4(arg1: Literal[int, None, float]): ... + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +10 10 | def func3() -> Literal[None]: ... +11 11 | +12 12 | +13 |-def func4(arg1: Literal[int, None, float]): ... + 13 |+def func4(arg1: Literal[int, float] | None): ... +14 14 | +15 15 | +16 16 | def func5(arg1: Literal[None, None]): ... + +PYI061.pyi:16:25: PYI061 [*] Use `None` rather than `Literal[None]` + | +16 | def func5(arg1: Literal[None, None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +13 13 | def func4(arg1: Literal[int, None, float]): ... +14 14 | +15 15 | +16 |-def func5(arg1: Literal[None, None]): ... + 16 |+def func5(arg1: None): ... +17 17 | +18 18 | +19 19 | def func6(arg1: Literal[ + +PYI061.pyi:16:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +16 | def func5(arg1: Literal[None, None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +13 13 | def func4(arg1: Literal[int, None, float]): ... +14 14 | +15 15 | +16 |-def func5(arg1: Literal[None, None]): ... + 16 |+def func5(arg1: None): ... +17 17 | +18 18 | +19 19 | def func6(arg1: Literal[ + +PYI061.pyi:21:5: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +19 | def func6(arg1: Literal[ +20 | "hello", +21 | None # Comment 1 + | ^^^^ PYI061 +22 | , "world" +23 | ]): ... + | + = help: Replace with `Literal[...] | None` + +ℹ Unsafe fix +16 16 | def func5(arg1: Literal[None, None]): ... +17 17 | +18 18 | +19 |-def func6(arg1: Literal[ +20 |- "hello", +21 |- None # Comment 1 +22 |- , "world" +23 |-]): ... + 19 |+def func6(arg1: Literal["hello", "world"] | None): ... +24 20 | +25 21 | +26 22 | def func7(arg1: Literal[ + +PYI061.pyi:27:5: PYI061 [*] Use `None` rather than `Literal[None]` + | +26 | def func7(arg1: Literal[ +27 | None # Comment 1 + | ^^^^ PYI061 +28 | ]): ... + | + = help: Replace with `None` + +ℹ Unsafe fix +23 23 | ]): ... +24 24 | +25 25 | +26 |-def func7(arg1: Literal[ +27 |- None # Comment 1 +28 |-]): ... + 26 |+def func7(arg1: None): ... +29 27 | +30 28 | +31 29 | def func8(arg1: Literal[None] | None):... + +PYI061.pyi:31:25: PYI061 Use `None` rather than `Literal[None]` + | +31 | def func8(arg1: Literal[None] | None):... + | ^^^^ PYI061 + | + = help: Replace with `None` + +PYI061.pyi:34:31: PYI061 [*] Use `None` rather than `Literal[None]` + | +34 | def func9(arg1: Union[Literal[None], None]): ... + | ^^^^ PYI061 + | + = help: Replace with `None` + +ℹ Safe fix +31 31 | def func8(arg1: Literal[None] | None):... +32 32 | +33 33 | +34 |-def func9(arg1: Union[Literal[None], None]): ... + 34 |+def func9(arg1: Union[None, None]): ... +35 35 | +36 36 | +37 37 | # OK + +PYI061.pyi:42:9: PYI061 [*] Use `None` rather than `Literal[None]` + | +41 | # From flake8-pyi +42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" + | ^^^^ PYI061 +43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | + = help: Replace with `None` + +ℹ Safe fix +39 39 | +40 40 | +41 41 | # From flake8-pyi +42 |-Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" + 42 |+None # PYI061 None inside "Literal[]" expression. Replace with "None" +43 43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +44 44 | +45 45 | + +PYI061.pyi:43:15: PYI061 [*] Use `Literal[...] | None` rather than `Literal[None, ...]` + | +41 | # From flake8-pyi +42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" +43 | Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + | ^^^^ PYI061 + | + = help: Replace with `Literal[...] | None` + +ℹ Safe fix +40 40 | +41 41 | # From flake8-pyi +42 42 | Literal[None] # PYI061 None inside "Literal[]" expression. Replace with "None" +43 |-Literal[True, None] # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" + 43 |+Literal[True] | None # PYI061 None inside "Literal[]" expression. Replace with "Literal[True] | None" +44 44 | +45 45 | +46 46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 + +PYI061.pyi:47:12: PYI061 Use `None` rather than `Literal[None]` + | +46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 | x: Literal[None] | None + | ^^^^ PYI061 +48 | y: None | Literal[None] +49 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.pyi:48:19: PYI061 Use `None` rather than `Literal[None]` + | +46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 | x: Literal[None] | None +48 | y: None | Literal[None] + | ^^^^ PYI061 +49 | z: Union[Literal[None], None] + | + = help: Replace with `None` + +PYI061.pyi:49:18: PYI061 [*] Use `None` rather than `Literal[None]` + | +47 | x: Literal[None] | None +48 | y: None | Literal[None] +49 | z: Union[Literal[None], None] + | ^^^^ PYI061 +50 | +51 | a: int | Literal[None] | None + | + = help: Replace with `None` + +ℹ Safe fix +46 46 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +47 47 | x: Literal[None] | None +48 48 | y: None | Literal[None] +49 |-z: Union[Literal[None], None] + 49 |+z: Union[None, None] +50 50 | +51 51 | a: int | Literal[None] | None +52 52 | b: None | Literal[None] | None + +PYI061.pyi:51:18: PYI061 Use `None` rather than `Literal[None]` + | +49 | z: Union[Literal[None], None] +50 | +51 | a: int | Literal[None] | None + | ^^^^ PYI061 +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None + | + = help: Replace with `None` + +PYI061.pyi:52:19: PYI061 Use `None` rather than `Literal[None]` + | +51 | a: int | Literal[None] | None +52 | b: None | Literal[None] | None + | ^^^^ PYI061 +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) + | + = help: Replace with `None` + +PYI061.pyi:53:20: PYI061 Use `None` rather than `Literal[None]` + | +51 | a: int | Literal[None] | None +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None + | ^^^^ PYI061 +54 | d: None | (Literal[None] | None) +55 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.pyi:54:20: PYI061 Use `None` rather than `Literal[None]` + | +52 | b: None | Literal[None] | None +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) + | ^^^^ PYI061 +55 | e: None | ((None | Literal[None]) | None) | None + | + = help: Replace with `None` + +PYI061.pyi:55:28: PYI061 Use `None` rather than `Literal[None]` + | +53 | c: (None | Literal[None]) | None +54 | d: None | (Literal[None] | None) +55 | e: None | ((None | Literal[None]) | None) | None + | ^^^^ PYI061 + | + = help: Replace with `None` diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs index d6dae62dba6ed..7cb3486d0141d 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs @@ -18,6 +18,12 @@ mod tests { use super::settings::Settings; use super::types; + #[test_case( + Rule::PytestParameterWithDefaultArgument, + Path::new("is_pytest_test.py"), + Settings::default(), + "is_pytest_test" + )] #[test_case( Rule::PytestFixtureIncorrectParenthesesStyle, Path::new("PT001.py"), @@ -45,18 +51,6 @@ mod tests { Settings::default(), "PT003" )] - #[test_case( - Rule::PytestMissingFixtureNameUnderscore, - Path::new("PT004.py"), - Settings::default(), - "PT004" - )] - #[test_case( - Rule::PytestIncorrectFixtureNameUnderscore, - Path::new("PT005.py"), - Settings::default(), - "PT005" - )] #[test_case( Rule::PytestParametrizeNamesWrongType, Path::new("PT006.py"), @@ -287,6 +281,66 @@ mod tests { Settings::default(), "PT027_1" )] + #[test_case( + Rule::PytestParameterWithDefaultArgument, + Path::new("PT028.py"), + Settings::default(), + "PT028" + )] + #[test_case( + Rule::PytestWarnsWithoutWarning, + Path::new("PT029.py"), + Settings::default(), + "PT029" + )] + #[test_case( + Rule::PytestWarnsTooBroad, + Path::new("PT030.py"), + Settings::default(), + "PT030_default" + )] + #[test_case( + Rule::PytestWarnsTooBroad, + Path::new("PT030.py"), + Settings { + warns_extend_require_match_for: vec![IdentifierPattern::new("EncodingWarning").unwrap()], + ..Settings::default() + }, + "PT030_extend_broad_exceptions" + )] + #[test_case( + Rule::PytestWarnsTooBroad, + Path::new("PT030.py"), + Settings { + warns_require_match_for: vec![IdentifierPattern::new("EncodingWarning").unwrap()], + ..Settings::default() + }, + "PT030_replace_broad_exceptions" + )] + #[test_case( + Rule::PytestWarnsTooBroad, + Path::new("PT030.py"), + Settings { + warns_require_match_for: vec![IdentifierPattern::new("*").unwrap()], + ..Settings::default() + }, + "PT030_glob_all" + )] + #[test_case( + Rule::PytestWarnsTooBroad, + Path::new("PT030.py"), + Settings { + warns_require_match_for: vec![IdentifierPattern::new("foo.*").unwrap()], + ..Settings::default() + }, + "PT030_glob_prefix" + )] + #[test_case( + Rule::PytestWarnsWithMultipleStatements, + Path::new("PT031.py"), + Settings::default(), + "PT031" + )] fn test_pytest_style( rule_code: Rule, path: &Path, @@ -303,4 +357,23 @@ mod tests { assert_messages!(name, diagnostics); Ok(()) } + + /// This test ensure that PT006 and PT007 don't conflict when both of them suggest a fix that + /// edits `argvalues` for `pytest.mark.parametrize`. + #[test] + fn test_pytest_style_pt006_and_pt007() -> Result<()> { + let diagnostics = test_path( + Path::new("flake8_pytest_style") + .join(Path::new("PT006_and_PT007.py")) + .as_path(), + &settings::LinterSettings { + ..settings::LinterSettings::for_rules(vec![ + Rule::PytestParametrizeNamesWrongType, + Rule::PytestParametrizeValuesWrongType, + ]) + }, + )?; + assert_messages!("PT006_and_PT007", diagnostics); + Ok(()) + } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/assertion.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/assertion.rs index c5e83049cf9bd..0d5200dbeec3d 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/assertion.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/assertion.rs @@ -1,32 +1,34 @@ use std::borrow::Cow; +use std::iter; use anyhow::Result; -use anyhow::{bail, Context}; +use anyhow::{Context, bail}; use libcst_native::{ self, Assert, BooleanOp, CompoundStatement, Expression, ParenthesizedNode, SimpleStatementLine, SimpleWhitespace, SmallStatement, Statement, TrailingWhitespace, }; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::Truthiness; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{ - self as ast, Arguments, BoolOp, ExceptHandler, Expr, Keyword, Stmt, UnaryOp, + self as ast, AnyNodeRef, Arguments, BoolOp, ExceptHandler, Expr, Keyword, Stmt, UnaryOp, }; use ruff_python_ast::{visitor, whitespace}; use ruff_python_codegen::Stylist; +use ruff_python_semantic::{Binding, BindingKind}; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::helpers::negate; use crate::cst::matchers::match_indented_block; use crate::cst::matchers::match_module; use crate::fix::codemods::CodegenStylist; use crate::importer::ImportRequest; -use crate::Locator; use super::unittest_assert::UnittestAssert; @@ -58,15 +60,15 @@ use super::unittest_assert::UnittestAssert; /// assert not something /// assert not something_else /// ``` -#[violation] -pub struct PytestCompositeAssertion; +#[derive(ViolationMetadata)] +pub(crate) struct PytestCompositeAssertion; impl Violation for PytestCompositeAssertion { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Assertion should be broken down into multiple parts") + "Assertion should be broken down into multiple parts".to_string() } fn fix_title(&self) -> Option<String> { @@ -105,8 +107,8 @@ impl Violation for PytestCompositeAssertion { /// /// ## References /// - [`pytest` documentation: `pytest.raises`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) -#[violation] -pub struct PytestAssertInExcept { +#[derive(ViolationMetadata)] +pub(crate) struct PytestAssertInExcept { name: String, } @@ -144,15 +146,15 @@ impl Violation for PytestAssertInExcept { /// ... /// ``` /// -/// References +/// ## References /// - [`pytest` documentation: `pytest.fail`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fail) -#[violation] -pub struct PytestAssertAlwaysFalse; +#[derive(ViolationMetadata)] +pub(crate) struct PytestAssertAlwaysFalse; impl Violation for PytestAssertAlwaysFalse { #[derive_message_formats] fn message(&self) -> String { - format!("Assertion always fails, replace with `pytest.fail()`") + "Assertion always fails, replace with `pytest.fail()`".to_string() } } @@ -186,8 +188,8 @@ impl Violation for PytestAssertAlwaysFalse { /// ## References /// - [`pytest` documentation: Assertion introspection details](https://docs.pytest.org/en/7.1.x/how-to/assert.html#assertion-introspection-details) -#[violation] -pub struct PytestUnittestAssertion { +#[derive(ViolationMetadata)] +pub(crate) struct PytestUnittestAssertion { assertion: String, } @@ -208,23 +210,23 @@ impl Violation for PytestUnittestAssertion { /// Visitor that tracks assert statements and checks if they reference /// the exception name. -struct ExceptionHandlerVisitor<'a> { +struct ExceptionHandlerVisitor<'a, 'b> { exception_name: &'a str, current_assert: Option<&'a Stmt>, - errors: Vec<Diagnostic>, + checker: &'a Checker<'b>, } -impl<'a> ExceptionHandlerVisitor<'a> { - const fn new(exception_name: &'a str) -> Self { +impl<'a, 'b> ExceptionHandlerVisitor<'a, 'b> { + const fn new(checker: &'a Checker<'b>, exception_name: &'a str) -> Self { Self { exception_name, current_assert: None, - errors: Vec::new(), + checker, } } } -impl<'a> Visitor<'a> for ExceptionHandlerVisitor<'a> { +impl<'a> Visitor<'a> for ExceptionHandlerVisitor<'a, '_> { fn visit_stmt(&mut self, stmt: &'a Stmt) { match stmt { Stmt::Assert(_) => { @@ -241,7 +243,7 @@ impl<'a> Visitor<'a> for ExceptionHandlerVisitor<'a> { Expr::Name(ast::ExprName { id, .. }) => { if let Some(current_assert) = self.current_assert { if id.as_str() == self.exception_name { - self.errors.push(Diagnostic::new( + self.checker.report_diagnostic(Diagnostic::new( PytestAssertInExcept { name: id.to_string(), }, @@ -255,13 +257,12 @@ impl<'a> Visitor<'a> for ExceptionHandlerVisitor<'a> { } } -fn check_assert_in_except(name: &str, body: &[Stmt]) -> Vec<Diagnostic> { +fn check_assert_in_except(checker: &Checker, name: &str, body: &[Stmt]) { // Walk body to find assert statements that reference the exception name - let mut visitor = ExceptionHandlerVisitor::new(name); + let mut visitor = ExceptionHandlerVisitor::new(checker, name); for stmt in body { visitor.visit_stmt(stmt); } - visitor.errors } /// PT009 @@ -271,42 +272,43 @@ pub(crate) fn unittest_assertion( func: &Expr, args: &[Expr], keywords: &[Keyword], -) -> Option<Diagnostic> { - match func { - Expr::Attribute(ast::ExprAttribute { attr, .. }) => { - if let Ok(unittest_assert) = UnittestAssert::try_from(attr.as_str()) { - let mut diagnostic = Diagnostic::new( - PytestUnittestAssertion { - assertion: unittest_assert.to_string(), - }, - func.range(), - ); - // We're converting an expression to a statement, so avoid applying the fix if - // the assertion is part of a larger expression. - if checker.semantic().current_statement().is_expr_stmt() - && checker.semantic().current_expression_parent().is_none() - && !checker.comment_ranges().intersects(expr.range()) - { - if let Ok(stmt) = unittest_assert.generate_assert(args, keywords) { - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - checker.generator().stmt(&stmt), - parenthesized_range( - expr.into(), - checker.semantic().current_statement().into(), - checker.comment_ranges(), - checker.locator().contents(), - ) - .unwrap_or(expr.range()), - ))); - } - } - Some(diagnostic) - } else { - None - } +) { + let Expr::Attribute(ast::ExprAttribute { attr, .. }) = func else { + return; + }; + + let Ok(unittest_assert) = UnittestAssert::try_from(attr.as_str()) else { + return; + }; + + let mut diagnostic = Diagnostic::new( + PytestUnittestAssertion { + assertion: unittest_assert.to_string(), + }, + func.range(), + ); + + // We're converting an expression to a statement, so avoid applying the fix if + // the assertion is part of a larger expression. + if checker.semantic().current_statement().is_expr_stmt() + && checker.semantic().current_expression_parent().is_none() + && !checker.comment_ranges().intersects(expr.range()) + { + if let Ok(stmt) = unittest_assert.generate_assert(args, keywords) { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + checker.generator().stmt(&stmt), + parenthesized_range( + expr.into(), + checker.semantic().current_statement().into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or(expr.range()), + ))); } - _ => None, } + + checker.report_diagnostic(diagnostic); } /// ## What it does @@ -343,8 +345,8 @@ pub(crate) fn unittest_assertion( /// /// ## References /// - [`pytest` documentation: Assertions about expected exceptions](https://docs.pytest.org/en/latest/how-to/assert.html#assertions-about-expected-exceptions) -#[violation] -pub struct PytestUnittestRaisesAssertion { +#[derive(ViolationMetadata)] +pub(crate) struct PytestUnittestRaisesAssertion { assertion: String, } @@ -364,9 +366,96 @@ impl Violation for PytestUnittestRaisesAssertion { } /// PT027 -pub(crate) fn unittest_raises_assertion( +pub(crate) fn unittest_raises_assertion_call(checker: &Checker, call: &ast::ExprCall) { + // Bindings in `with` statements are handled by `unittest_raises_assertion_bindings`. + if let Stmt::With(ast::StmtWith { items, .. }) = checker.semantic().current_statement() { + let call_ref = AnyNodeRef::from(call); + + if items.iter().any(|item| { + AnyNodeRef::from(&item.context_expr).ptr_eq(call_ref) && item.optional_vars.is_some() + }) { + return; + } + } + + if let Some(diagnostic) = unittest_raises_assertion(call, vec![], checker) { + checker.report_diagnostic(diagnostic); + } +} + +/// PT027 +pub(crate) fn unittest_raises_assertion_binding( checker: &Checker, + binding: &Binding, +) -> Option<Diagnostic> { + if !matches!(binding.kind, BindingKind::WithItemVar) { + return None; + } + + let semantic = checker.semantic(); + + let Stmt::With(with) = binding.statement(semantic)? else { + return None; + }; + + let Expr::Call(call) = corresponding_context_expr(binding, with)? else { + return None; + }; + + let mut edits = vec![]; + + // Rewrite all references to `.exception` to `.value`: + // ```py + // # Before + // with self.assertRaises(Exception) as e: + // ... + // print(e.exception) + // + // # After + // with pytest.raises(Exception) as e: + // ... + // print(e.value) + // ``` + for reference_id in binding.references() { + let reference = semantic.reference(reference_id); + let node_id = reference.expression_id()?; + + let mut ancestors = semantic.expressions(node_id).skip(1); + + let Expr::Attribute(ast::ExprAttribute { attr, .. }) = ancestors.next()? else { + continue; + }; + + if attr.as_str() == "exception" { + edits.push(Edit::range_replacement("value".to_string(), attr.range)); + } + } + + unittest_raises_assertion(call, edits, checker) +} + +fn corresponding_context_expr<'a>(binding: &Binding, with: &'a ast::StmtWith) -> Option<&'a Expr> { + with.items.iter().find_map(|item| { + let Some(optional_var) = &item.optional_vars else { + return None; + }; + + let Expr::Name(name) = optional_var.as_ref() else { + return None; + }; + + if name.range == binding.range { + Some(&item.context_expr) + } else { + None + } + }) +} + +fn unittest_raises_assertion( call: &ast::ExprCall, + extra_edits: Vec<Edit>, + checker: &Checker, ) -> Option<Diagnostic> { let Expr::Attribute(ast::ExprAttribute { attr, .. }) = call.func.as_ref() else { return None; @@ -385,19 +474,25 @@ pub(crate) fn unittest_raises_assertion( }, call.func.range(), ); + if !checker .comment_ranges() .has_comments(call, checker.source()) { if let Some(args) = to_pytest_raises_args(checker, attr.as_str(), &call.arguments) { diagnostic.try_set_fix(|| { - let (import_edit, binding) = checker.importer().get_or_import_symbol( + let (import_pytest_raises, binding) = checker.importer().get_or_import_symbol( &ImportRequest::import("pytest", "raises"), call.func.start(), checker.semantic(), )?; - let edit = Edit::range_replacement(format!("{binding}({args})"), call.range()); - Ok(Fix::unsafe_edits(import_edit, [edit])) + let replace_call = + Edit::range_replacement(format!("{binding}({args})"), call.range()); + + Ok(Fix::unsafe_edits( + import_pytest_raises, + iter::once(replace_call).chain(extra_edits), + )) }); } } @@ -491,30 +586,22 @@ fn to_pytest_raises_args<'a>( } /// PT015 -pub(crate) fn assert_falsy(checker: &mut Checker, stmt: &Stmt, test: &Expr) { +pub(crate) fn assert_falsy(checker: &Checker, stmt: &Stmt, test: &Expr) { let truthiness = Truthiness::from_expr(test, |id| checker.semantic().has_builtin_binding(id)); - if matches!(truthiness, Truthiness::False | Truthiness::Falsey) { - checker - .diagnostics - .push(Diagnostic::new(PytestAssertAlwaysFalse, stmt.range())); + if truthiness.into_bool() == Some(false) { + checker.report_diagnostic(Diagnostic::new(PytestAssertAlwaysFalse, stmt.range())); } } /// PT017 -pub(crate) fn assert_in_exception_handler(checker: &mut Checker, handlers: &[ExceptHandler]) { - checker - .diagnostics - .extend(handlers.iter().flat_map(|handler| match handler { - ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { - name, body, .. - }) => { - if let Some(name) = name { - check_assert_in_except(name, body) - } else { - Vec::new() - } - } - })); +pub(crate) fn assert_in_exception_handler(checker: &Checker, handlers: &[ExceptHandler]) { + for handler in handlers { + let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { name, body, .. }) = + handler; + if let Some(name) = name { + check_assert_in_except(checker, name, body); + } + } } #[derive(Copy, Clone)] @@ -734,12 +821,7 @@ fn fix_composite_condition(stmt: &Stmt, locator: &Locator, stylist: &Stylist) -> } /// PT018 -pub(crate) fn composite_condition( - checker: &mut Checker, - stmt: &Stmt, - test: &Expr, - msg: Option<&Expr>, -) { +pub(crate) fn composite_condition(checker: &Checker, stmt: &Stmt, test: &Expr, msg: Option<&Expr>) { let composite = is_composite_condition(test); if matches!(composite, CompositionKind::Simple | CompositionKind::Mixed) { let mut diagnostic = Diagnostic::new(PytestCompositeAssertion, stmt.range()); @@ -755,6 +837,6 @@ pub(crate) fn composite_condition( .map(Fix::unsafe_edit) }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fail.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fail.rs index b23dd65b91511..7435e121840c6 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fail.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fail.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -45,35 +45,27 @@ use super::helpers::{is_empty_or_null_string, is_pytest_fail}; /// /// ## References /// - [`pytest` documentation: `pytest.fail`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fail) -#[violation] -pub struct PytestFailWithoutMessage; +#[derive(ViolationMetadata)] +pub(crate) struct PytestFailWithoutMessage; impl Violation for PytestFailWithoutMessage { #[derive_message_formats] fn message(&self) -> String { - format!("No message passed to `pytest.fail()`") + "No message passed to `pytest.fail()`".to_string() } } -pub(crate) fn fail_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn fail_call(checker: &Checker, call: &ast::ExprCall) { if is_pytest_fail(&call.func, checker.semantic()) { // Allow either `pytest.fail(reason="...")` (introduced in pytest 7.0) or // `pytest.fail(msg="...")` (deprecated in pytest 7.0) - let msg = call + if call .arguments - .find_argument("reason", 0) - .or_else(|| call.arguments.find_argument("msg", 0)); - - if let Some(msg) = msg { - if is_empty_or_null_string(msg) { - checker - .diagnostics - .push(Diagnostic::new(PytestFailWithoutMessage, call.func.range())); - } - } else { - checker - .diagnostics - .push(Diagnostic::new(PytestFailWithoutMessage, call.func.range())); + .find_argument_value("reason", 0) + .or_else(|| call.arguments.find_argument_value("msg", 0)) + .is_none_or(is_empty_or_null_string) + { + checker.report_diagnostic(Diagnostic::new(PytestFailWithoutMessage, call.func.range())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fixture.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fixture.rs index 95c31efbe85e9..3803100689a83 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fixture.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/fixture.rs @@ -1,25 +1,26 @@ use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::identifier::Identifier; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Decorator; +use ruff_python_ast::helpers::map_callable; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::Decorator; use ruff_python_ast::{self as ast, Expr, Parameters, Stmt}; -use ruff_python_semantic::analyze::visibility::is_abstract; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::visibility::is_abstract; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; use ruff_text_size::{TextLen, TextRange}; +use rustc_hash::FxHashSet; use crate::checkers::ast::Checker; use crate::fix::edits; use crate::registry::Rule; use super::helpers::{ - get_mark_decorators, is_pytest_fixture, is_pytest_yield_fixture, keyword_is_literal, - Parentheses, + Parentheses, get_mark_decorators, is_pytest_fixture, is_pytest_yield_fixture, + keyword_is_literal, }; /// ## What it does @@ -61,8 +62,8 @@ use super::helpers::{ /// /// ## References /// - [`pytest` documentation: API Reference: Fixtures](https://docs.pytest.org/en/latest/reference/reference.html#fixtures-api) -#[violation] -pub struct PytestFixtureIncorrectParenthesesStyle { +#[derive(ViolationMetadata)] +pub(crate) struct PytestFixtureIncorrectParenthesesStyle { expected: Parentheses, actual: Parentheses, } @@ -112,8 +113,8 @@ impl AlwaysFixableViolation for PytestFixtureIncorrectParenthesesStyle { /// /// ## References /// - [`pytest` documentation: `@pytest.fixture` functions](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fixture) -#[violation] -pub struct PytestFixturePositionalArgs { +#[derive(ViolationMetadata)] +pub(crate) struct PytestFixturePositionalArgs { function: String, } @@ -153,13 +154,13 @@ impl Violation for PytestFixturePositionalArgs { /// /// ## References /// - [`pytest` documentation: `@pytest.fixture` functions](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fixture) -#[violation] -pub struct PytestExtraneousScopeFunction; +#[derive(ViolationMetadata)] +pub(crate) struct PytestExtraneousScopeFunction; impl AlwaysFixableViolation for PytestExtraneousScopeFunction { #[derive_message_formats] fn message(&self) -> String { - format!("`scope='function'` is implied in `@pytest.fixture()`") + "`scope='function'` is implied in `@pytest.fixture()`".to_string() } fn fix_title(&self) -> String { @@ -167,8 +168,8 @@ impl AlwaysFixableViolation for PytestExtraneousScopeFunction { } } -/// ## Deprecation -/// Marking fixtures that do not return a value with an underscore +/// ## Removal +/// This rule has been removed because marking fixtures that do not return a value with an underscore /// isn't a practice recommended by the pytest community. /// /// ## What it does @@ -215,21 +216,23 @@ impl AlwaysFixableViolation for PytestExtraneousScopeFunction { /// /// ## References /// - [`pytest` documentation: `@pytest.fixture` functions](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fixture) -#[violation] -pub struct PytestMissingFixtureNameUnderscore { - function: String, -} +#[derive(ViolationMetadata)] +#[deprecated(note = "PT004 has been removed")] +pub(crate) struct PytestMissingFixtureNameUnderscore; +#[expect(deprecated)] impl Violation for PytestMissingFixtureNameUnderscore { - #[derive_message_formats] fn message(&self) -> String { - let PytestMissingFixtureNameUnderscore { function } = self; - format!("Fixture `{function}` does not return anything, add leading underscore") + unreachable!("PT004 has been removed"); + } + + fn message_formats() -> &'static [&'static str] { + &["Fixture `{function}` does not return anything, add leading underscore"] } } -/// ## Deprecation -/// Marking fixtures that do not return a value with an underscore +/// ## Removal +/// This rule has been removed because marking fixtures that do not return a value with an underscore /// isn't a practice recommended by the pytest community. /// /// ## What it does @@ -278,16 +281,18 @@ impl Violation for PytestMissingFixtureNameUnderscore { /// /// ## References /// - [`pytest` documentation: `@pytest.fixture` functions](https://docs.pytest.org/en/latest/reference/reference.html#pytest-fixture) -#[violation] -pub struct PytestIncorrectFixtureNameUnderscore { - function: String, -} +#[derive(ViolationMetadata)] +#[deprecated(note = "PT005 has been removed")] +pub(crate) struct PytestIncorrectFixtureNameUnderscore; +#[expect(deprecated)] impl Violation for PytestIncorrectFixtureNameUnderscore { - #[derive_message_formats] fn message(&self) -> String { - let PytestIncorrectFixtureNameUnderscore { function } = self; - format!("Fixture `{function}` returns a value, remove leading underscore") + unreachable!("PT005 has been removed"); + } + + fn message_formats() -> &'static [&'static str] { + &["Fixture `{function}` returns a value, remove leading underscore"] } } @@ -336,8 +341,8 @@ impl Violation for PytestIncorrectFixtureNameUnderscore { /// /// ## References /// - [`pytest` documentation: `pytest.mark.usefixtures`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-mark-usefixtures) -#[violation] -pub struct PytestFixtureParamWithoutValue { +#[derive(ViolationMetadata)] +pub(crate) struct PytestFixtureParamWithoutValue { name: String, } @@ -384,13 +389,13 @@ impl Violation for PytestFixtureParamWithoutValue { /// /// ## References /// - [`pytest` documentation: `yield_fixture` functions](https://docs.pytest.org/en/latest/yieldfixture.html) -#[violation] -pub struct PytestDeprecatedYieldFixture; +#[derive(ViolationMetadata)] +pub(crate) struct PytestDeprecatedYieldFixture; impl Violation for PytestDeprecatedYieldFixture { #[derive_message_formats] fn message(&self) -> String { - format!("`@pytest.yield_fixture` is deprecated, use `@pytest.fixture`") + "`@pytest.yield_fixture` is deprecated, use `@pytest.fixture`".to_string() } } @@ -443,13 +448,13 @@ impl Violation for PytestDeprecatedYieldFixture { /// ## References /// - [`pytest` documentation: Adding finalizers directly](https://docs.pytest.org/en/latest/how-to/fixtures.html#adding-finalizers-directly) /// - [`pytest` documentation: Factories as fixtures](https://docs.pytest.org/en/latest/how-to/fixtures.html#factories-as-fixtures) -#[violation] -pub struct PytestFixtureFinalizerCallback; +#[derive(ViolationMetadata)] +pub(crate) struct PytestFixtureFinalizerCallback; impl Violation for PytestFixtureFinalizerCallback { #[derive_message_formats] fn message(&self) -> String { - format!("Use `yield` instead of `request.addfinalizer`") + "Use `yield` instead of `request.addfinalizer`".to_string() } } /// ## What it does @@ -491,8 +496,8 @@ impl Violation for PytestFixtureFinalizerCallback { /// /// ## References /// - [`pytest` documentation: Teardown/Cleanup](https://docs.pytest.org/en/latest/how-to/fixtures.html#teardown-cleanup-aka-fixture-finalization) -#[violation] -pub struct PytestUselessYieldFixture { +#[derive(ViolationMetadata)] +pub(crate) struct PytestUselessYieldFixture { name: String, } @@ -548,13 +553,13 @@ impl AlwaysFixableViolation for PytestUselessYieldFixture { /// /// ## References /// - [`pytest` documentation: `pytest.mark.usefixtures`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-mark-usefixtures) -#[violation] -pub struct PytestErroneousUseFixturesOnFixture; +#[derive(ViolationMetadata)] +pub(crate) struct PytestErroneousUseFixturesOnFixture; impl AlwaysFixableViolation for PytestErroneousUseFixturesOnFixture { #[derive_message_formats] fn message(&self) -> String { - format!("`pytest.mark.usefixtures` has no effect on fixtures") + "`pytest.mark.usefixtures` has no effect on fixtures".to_string() } fn fix_title(&self) -> String { @@ -590,14 +595,14 @@ impl AlwaysFixableViolation for PytestErroneousUseFixturesOnFixture { /// ``` /// /// ## References -/// - [`pytest-asyncio`](https://pypi.org/project/pytest-asyncio/) -#[violation] -pub struct PytestUnnecessaryAsyncioMarkOnFixture; +/// - [PyPI: `pytest-asyncio`](https://pypi.org/project/pytest-asyncio/) +#[derive(ViolationMetadata)] +pub(crate) struct PytestUnnecessaryAsyncioMarkOnFixture; impl AlwaysFixableViolation for PytestUnnecessaryAsyncioMarkOnFixture { #[derive_message_formats] fn message(&self) -> String { - format!("`pytest.mark.asyncio` is unnecessary for fixtures") + "`pytest.mark.asyncio` is unnecessary for fixtures".to_string() } fn fix_title(&self) -> String { @@ -643,7 +648,7 @@ impl<'a> Visitor<'a> for SkipFunctionsVisitor<'a> { .is_some_and(|name| matches!(name.segments(), ["request", "addfinalizer"])) { self.addfinalizer_call = Some(expr); - }; + } visitor::walk_expr(self, expr); } _ => {} @@ -661,7 +666,7 @@ fn fixture_decorator<'a>( } fn pytest_fixture_parentheses( - checker: &mut Checker, + checker: &Checker, decorator: &Decorator, fix: Fix, expected: Parentheses, @@ -672,11 +677,11 @@ fn pytest_fixture_parentheses( decorator.range(), ); diagnostic.set_fix(fix); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// PT001, PT002, PT003 -fn check_fixture_decorator(checker: &mut Checker, func_name: &str, decorator: &Decorator) { +fn check_fixture_decorator(checker: &Checker, func_name: &str, decorator: &Decorator) { match &decorator.expression { Expr::Call(ast::ExprCall { func, @@ -701,7 +706,7 @@ fn check_fixture_decorator(checker: &mut Checker, func_name: &str, decorator: &D if checker.enabled(Rule::PytestFixturePositionalArgs) { if !arguments.args.is_empty() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PytestFixturePositionalArgs { function: func_name.to_string(), }, @@ -724,7 +729,7 @@ fn check_fixture_decorator(checker: &mut Checker, func_name: &str, decorator: &D ) .map(Fix::unsafe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -749,43 +754,14 @@ fn check_fixture_decorator(checker: &mut Checker, func_name: &str, decorator: &D } } -/// PT004, PT005, PT022 -fn check_fixture_returns( - checker: &mut Checker, - stmt: &Stmt, - name: &str, - body: &[Stmt], - returns: Option<&Expr>, -) { +/// PT022 +fn check_fixture_returns(checker: &Checker, name: &str, body: &[Stmt], returns: Option<&Expr>) { let mut visitor = SkipFunctionsVisitor::default(); for stmt in body { visitor.visit_stmt(stmt); } - if checker.enabled(Rule::PytestIncorrectFixtureNameUnderscore) - && visitor.has_return_with_value - && name.starts_with('_') - { - checker.diagnostics.push(Diagnostic::new( - PytestIncorrectFixtureNameUnderscore { - function: name.to_string(), - }, - stmt.identifier(), - )); - } else if checker.enabled(Rule::PytestMissingFixtureNameUnderscore) - && !visitor.has_return_with_value - && !visitor.has_yield_from - && !name.starts_with('_') - { - checker.diagnostics.push(Diagnostic::new( - PytestMissingFixtureNameUnderscore { - function: name.to_string(), - }, - stmt.identifier(), - )); - } - if checker.enabled(Rule::PytestUselessYieldFixture) { let Some(stmt) = body.last() else { return; @@ -828,16 +804,57 @@ fn check_fixture_returns( } else { diagnostic.set_fix(Fix::safe_edit(yield_edit)); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// PT019 -fn check_test_function_args(checker: &mut Checker, parameters: &Parameters) { +fn check_test_function_args(checker: &Checker, parameters: &Parameters, decorators: &[Decorator]) { + let mut named_parametrize = FxHashSet::default(); + for decorator in decorators.iter().filter(|decorator| { + UnqualifiedName::from_expr(map_callable(&decorator.expression)) + .is_some_and(|name| matches!(name.segments(), ["pytest", "mark", "parametrize"])) + }) { + let Some(call_expr) = decorator.expression.as_call_expr() else { + continue; + }; + let Some(first_arg) = call_expr.arguments.find_argument_value("argnames", 0) else { + continue; + }; + + match first_arg { + Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => { + named_parametrize.extend( + value + .to_str() + .split(',') + .map(str::trim) + .filter(|param| !param.is_empty() && param.starts_with('_')), + ); + } + + Expr::Name(_) => return, + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) + if elts.iter().any(Expr::is_name_expr) => + { + return; + } + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { + named_parametrize.extend( + elts.iter() + .filter_map(Expr::as_string_literal_expr) + .map(|param| param.value.to_str().trim()) + .filter(|param| !param.is_empty() && param.starts_with('_')), + ); + } + _ => {} + } + } + for parameter in parameters.iter_non_variadic_params() { - let name = ¶meter.parameter.name; - if name.starts_with('_') { - checker.diagnostics.push(Diagnostic::new( + let name = parameter.name(); + if name.starts_with('_') && !named_parametrize.contains(name.as_str()) { + checker.report_diagnostic(Diagnostic::new( PytestFixtureParamWithoutValue { name: name.to_string(), }, @@ -848,9 +865,9 @@ fn check_test_function_args(checker: &mut Checker, parameters: &Parameters) { } /// PT020 -fn check_fixture_decorator_name(checker: &mut Checker, decorator: &Decorator) { +fn check_fixture_decorator_name(checker: &Checker, decorator: &Decorator) { if is_pytest_yield_fixture(decorator, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PytestDeprecatedYieldFixture, decorator.range(), )); @@ -858,7 +875,7 @@ fn check_fixture_decorator_name(checker: &mut Checker, decorator: &Decorator) { } /// PT021 -fn check_fixture_addfinalizer(checker: &mut Checker, parameters: &Parameters, body: &[Stmt]) { +fn check_fixture_addfinalizer(checker: &Checker, parameters: &Parameters, body: &[Stmt]) { if !parameters.includes("request") { return; } @@ -870,7 +887,7 @@ fn check_fixture_addfinalizer(checker: &mut Checker, parameters: &Parameters, bo } if let Some(addfinalizer) = visitor.addfinalizer_call { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PytestFixtureFinalizerCallback, addfinalizer.range(), )); @@ -878,7 +895,7 @@ fn check_fixture_addfinalizer(checker: &mut Checker, parameters: &Parameters, bo } /// PT024, PT025 -fn check_fixture_marks(checker: &mut Checker, decorators: &[Decorator]) { +fn check_fixture_marks(checker: &Checker, decorators: &[Decorator]) { for (expr, marker) in get_mark_decorators(decorators) { if checker.enabled(Rule::PytestUnnecessaryAsyncioMarkOnFixture) { if marker == "asyncio" { @@ -886,7 +903,7 @@ fn check_fixture_marks(checker: &mut Checker, decorators: &[Decorator]) { Diagnostic::new(PytestUnnecessaryAsyncioMarkOnFixture, expr.range()); let range = checker.locator().full_lines_range(expr.range()); diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(range))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -896,15 +913,14 @@ fn check_fixture_marks(checker: &mut Checker, decorators: &[Decorator]) { Diagnostic::new(PytestErroneousUseFixturesOnFixture, expr.range()); let line_range = checker.locator().full_lines_range(expr.range()); diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(line_range))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } pub(crate) fn fixture( - checker: &mut Checker, - stmt: &Stmt, + checker: &Checker, name: &str, parameters: &Parameters, returns: Option<&Expr>, @@ -924,12 +940,10 @@ pub(crate) fn fixture( check_fixture_decorator_name(checker, decorator); } - if (checker.enabled(Rule::PytestMissingFixtureNameUnderscore) - || checker.enabled(Rule::PytestIncorrectFixtureNameUnderscore) - || checker.enabled(Rule::PytestUselessYieldFixture)) + if checker.enabled(Rule::PytestUselessYieldFixture) && !is_abstract(decorators, checker.semantic()) { - check_fixture_returns(checker, stmt, name, body, returns); + check_fixture_returns(checker, name, body, returns); } if checker.enabled(Rule::PytestFixtureFinalizerCallback) { @@ -944,6 +958,6 @@ pub(crate) fn fixture( } if checker.enabled(Rule::PytestFixtureParamWithoutValue) && name.starts_with("test_") { - check_test_function_args(checker, parameters); + check_test_function_args(checker, parameters, decorators); } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/helpers.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/helpers.rs index edbe837e2c1dd..7b886dd5cc653 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/helpers.rs @@ -1,10 +1,11 @@ -use std::fmt; - +use crate::checkers::ast::Checker; use ruff_python_ast::helpers::map_callable; use ruff_python_ast::name::UnqualifiedName; -use ruff_python_ast::{self as ast, Decorator, Expr, Keyword}; -use ruff_python_semantic::SemanticModel; +use ruff_python_ast::{self as ast, Decorator, Expr, ExprCall, Keyword, Stmt, StmtFunctionDef}; +use ruff_python_semantic::analyze::visibility; +use ruff_python_semantic::{ScopeKind, SemanticModel}; use ruff_python_trivia::PythonWhitespace; +use std::fmt; pub(super) fn get_mark_decorators( decorators: &[Decorator], @@ -38,14 +39,55 @@ pub(super) fn is_pytest_yield_fixture(decorator: &Decorator, semantic: &Semantic }) } -pub(super) fn is_pytest_parametrize(decorator: &Decorator, semantic: &SemanticModel) -> bool { +pub(super) fn is_pytest_parametrize(call: &ExprCall, semantic: &SemanticModel) -> bool { semantic - .resolve_qualified_name(map_callable(&decorator.expression)) + .resolve_qualified_name(&call.func) .is_some_and(|qualified_name| { matches!(qualified_name.segments(), ["pytest", "mark", "parametrize"]) }) } +/// Whether the currently checked `func` is likely to be a Pytest test. +/// +/// A normal Pytest test function is one whose name starts with `test` and is either: +/// +/// * Placed at module-level, or +/// * Placed within a class whose name starts with `Test` and does not have an `__init__` method. +/// +/// During test discovery, Pytest respects a few settings which we do not have access to. +/// This function is thus prone to both false positives and false negatives. +/// +/// References: +/// - [`pytest` documentation: Conventions for Python test discovery](https://docs.pytest.org/en/stable/explanation/goodpractices.html#conventions-for-python-test-discovery) +/// - [`pytest` documentation: Changing naming conventions](https://docs.pytest.org/en/stable/example/pythoncollection.html#changing-naming-conventions) +pub(crate) fn is_likely_pytest_test(func: &StmtFunctionDef, checker: &Checker) -> bool { + let semantic = checker.semantic(); + + if !func.name.starts_with("test") { + return false; + } + + if semantic.scope_id.is_global() { + return true; + } + + let ScopeKind::Class(class) = semantic.current_scope().kind else { + return false; + }; + + if !class.name.starts_with("Test") { + return false; + } + + class.body.iter().all(|stmt| { + let Stmt::FunctionDef(function) = stmt else { + return true; + }; + + !visibility::is_init(&function.name) + }) +} + pub(super) fn keyword_is_literal(keyword: &Keyword, literal: &str) -> bool { if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = &keyword.value { value == literal diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/imports.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/imports.rs index 3abf68cff1b7a..1b99c5c25dc3c 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/imports.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/imports.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -21,13 +21,13 @@ use ruff_text_size::Ranged; /// ```python /// import pytest /// ``` -#[violation] -pub struct PytestIncorrectPytestImport; +#[derive(ViolationMetadata)] +pub(crate) struct PytestIncorrectPytestImport; impl Violation for PytestIncorrectPytestImport { #[derive_message_formats] fn message(&self) -> String { - format!("Incorrect import of `pytest`; use `import pytest` instead") + "Incorrect import of `pytest`; use `import pytest` instead".to_string() } } @@ -59,7 +59,7 @@ pub(crate) fn import_from( // If level is not zero or module is none, return if level != 0 { return None; - }; + } if let Some(module) = module { if is_pytest_or_subpackage(module) { @@ -68,7 +68,7 @@ pub(crate) fn import_from( import_from.range(), )); } - }; + } None } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/marks.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/marks.rs index b814fac80a4af..458aa5d846fdf 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/marks.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/marks.rs @@ -1,13 +1,13 @@ use ruff_python_ast::{self as ast, Arguments, Decorator, Expr}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::registry::Rule; -use super::helpers::{get_mark_decorators, Parentheses}; +use super::helpers::{Parentheses, get_mark_decorators}; /// ## What it does /// Checks for argument-free `@pytest.mark.<marker>()` decorators with or @@ -49,8 +49,8 @@ use super::helpers::{get_mark_decorators, Parentheses}; /// /// ## References /// - [`pytest` documentation: Marks](https://docs.pytest.org/en/latest/reference/reference.html#marks) -#[violation] -pub struct PytestIncorrectMarkParenthesesStyle { +#[derive(ViolationMetadata)] +pub(crate) struct PytestIncorrectMarkParenthesesStyle { mark_name: String, expected_parens: Parentheses, actual_parens: Parentheses, @@ -104,14 +104,13 @@ impl AlwaysFixableViolation for PytestIncorrectMarkParenthesesStyle { /// /// ## References /// - [`pytest` documentation: `pytest.mark.usefixtures`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-mark-usefixtures) - -#[violation] -pub struct PytestUseFixturesWithoutParameters; +#[derive(ViolationMetadata)] +pub(crate) struct PytestUseFixturesWithoutParameters; impl AlwaysFixableViolation for PytestUseFixturesWithoutParameters { #[derive_message_formats] fn message(&self) -> String { - format!("Useless `pytest.mark.usefixtures` without parameters") + "Useless `pytest.mark.usefixtures` without parameters".to_string() } fn fix_title(&self) -> String { @@ -120,7 +119,7 @@ impl AlwaysFixableViolation for PytestUseFixturesWithoutParameters { } fn pytest_mark_parentheses( - checker: &mut Checker, + checker: &Checker, decorator: &Decorator, marker: &str, fix: Fix, @@ -136,10 +135,10 @@ fn pytest_mark_parentheses( decorator.range(), ); diagnostic.set_fix(fix); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } -fn check_mark_parentheses(checker: &mut Checker, decorator: &Decorator, marker: &str) { +fn check_mark_parentheses(checker: &Checker, decorator: &Decorator, marker: &str) { match &decorator.expression { Expr::Call(ast::ExprCall { func, @@ -185,7 +184,7 @@ fn check_mark_parentheses(checker: &mut Checker, decorator: &Decorator, marker: } } -fn check_useless_usefixtures(checker: &mut Checker, decorator: &Decorator, marker: &str) { +fn check_useless_usefixtures(checker: &Checker, decorator: &Decorator, marker: &str) { if marker != "usefixtures" { return; } @@ -207,10 +206,10 @@ fn check_useless_usefixtures(checker: &mut Checker, decorator: &Decorator, marke let mut diagnostic = Diagnostic::new(PytestUseFixturesWithoutParameters, decorator.range()); diagnostic.set_fix(Fix::unsafe_edit(Edit::range_deletion(decorator.range()))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } -pub(crate) fn marks(checker: &mut Checker, decorators: &[Decorator]) { +pub(crate) fn marks(checker: &Checker, decorators: &[Decorator]) { let enforce_parentheses = checker.enabled(Rule::PytestIncorrectMarkParenthesesStyle); let enforce_useless_usefixtures = checker.enabled(Rule::PytestUseFixturesWithoutParameters); diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/mod.rs index 783431e39677d..128a1c5b4ff4b 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/mod.rs @@ -6,6 +6,8 @@ pub(crate) use marks::*; pub(crate) use parametrize::*; pub(crate) use patch::*; pub(crate) use raises::*; +pub(crate) use test_functions::*; +pub(crate) use warns::*; mod assertion; mod fail; @@ -16,4 +18,6 @@ mod marks; mod parametrize; mod patch; mod raises; +mod test_functions; mod unittest_assert; +mod warns; diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/parametrize.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/parametrize.rs index 3b2a923b45e3d..cfe9351ab4243 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/parametrize.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/parametrize.rs @@ -1,11 +1,10 @@ use rustc_hash::{FxBuildHasher, FxHashMap}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_python_ast::AstNode; -use ruff_python_ast::{self as ast, Arguments, Decorator, Expr, ExprContext}; +use ruff_python_ast::{self as ast, Expr, ExprCall, ExprContext, StringLiteralFlags}; use ruff_python_codegen::Generator; use ruff_python_trivia::CommentRanges; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; @@ -66,8 +65,8 @@ use super::helpers::{is_pytest_parametrize, split_names}; /// /// ## References /// - [`pytest` documentation: How to parametrize fixtures and test functions](https://docs.pytest.org/en/latest/how-to/parametrize.html#pytest-mark-parametrize) -#[violation] -pub struct PytestParametrizeNamesWrongType { +#[derive(ViolationMetadata)] +pub(crate) struct PytestParametrizeNamesWrongType { single_argument: bool, expected: types::ParametrizeNameType, } @@ -93,7 +92,9 @@ impl Violation for PytestParametrizeNamesWrongType { } } }; - format!("Wrong type passed to first argument of `@pytest.mark.parametrize`; expected {expected_string}") + format!( + "Wrong type passed to first argument of `pytest.mark.parametrize`; expected {expected_string}" + ) } fn fix_title(&self) -> Option<String> { @@ -198,8 +199,8 @@ impl Violation for PytestParametrizeNamesWrongType { /// /// ## References /// - [`pytest` documentation: How to parametrize fixtures and test functions](https://docs.pytest.org/en/latest/how-to/parametrize.html#pytest-mark-parametrize) -#[violation] -pub struct PytestParametrizeValuesWrongType { +#[derive(ViolationMetadata)] +pub(crate) struct PytestParametrizeValuesWrongType { values: types::ParametrizeValuesType, row: types::ParametrizeValuesRowType, } @@ -210,7 +211,7 @@ impl Violation for PytestParametrizeValuesWrongType { #[derive_message_formats] fn message(&self) -> String { let PytestParametrizeValuesWrongType { values, row } = self; - format!("Wrong values type in `@pytest.mark.parametrize` expected `{values}` of `{row}`") + format!("Wrong values type in `pytest.mark.parametrize` expected `{values}` of `{row}`") } fn fix_title(&self) -> Option<String> { @@ -262,8 +263,8 @@ impl Violation for PytestParametrizeValuesWrongType { /// /// ## References /// - [`pytest` documentation: How to parametrize fixtures and test functions](https://docs.pytest.org/en/latest/how-to/parametrize.html#pytest-mark-parametrize) -#[violation] -pub struct PytestDuplicateParametrizeTestCases { +#[derive(ViolationMetadata)] +pub(crate) struct PytestDuplicateParametrizeTestCases { index: usize, } @@ -273,7 +274,7 @@ impl Violation for PytestDuplicateParametrizeTestCases { #[derive_message_formats] fn message(&self) -> String { let PytestDuplicateParametrizeTestCases { index } = self; - format!("Duplicate of test case at index {index} in `@pytest_mark.parametrize`") + format!("Duplicate of test case at index {index} in `pytest.mark.parametrize`") } fn fix_title(&self) -> Option<String> { @@ -281,7 +282,7 @@ impl Violation for PytestDuplicateParametrizeTestCases { } } -fn elts_to_csv(elts: &[Expr], generator: Generator) -> Option<String> { +fn elts_to_csv(elts: &[Expr], generator: Generator, flags: StringLiteralFlags) -> Option<String> { if !elts.iter().all(Expr::is_string_literal_expr) { return None; } @@ -299,7 +300,8 @@ fn elts_to_csv(elts: &[Expr], generator: Generator) -> Option<String> { acc }) .into_boxed_str(), - ..ast::StringLiteral::default() + range: TextRange::default(), + flags, }); Some(generator.expr(&node)) } @@ -317,23 +319,21 @@ fn elts_to_csv(elts: &[Expr], generator: Generator) -> Option<String> { /// /// This method assumes that the first argument is a string. fn get_parametrize_name_range( - decorator: &Decorator, + call: &ExprCall, expr: &Expr, comment_ranges: &CommentRanges, source: &str, ) -> Option<TextRange> { - decorator.expression.as_call_expr().and_then(|call| { - parenthesized_range( - expr.into(), - call.arguments.as_any_node_ref(), - comment_ranges, - source, - ) - }) + parenthesized_range( + expr.into(), + (&call.arguments).into(), + comment_ranges, + source, + ) } /// PT006 -fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { +fn check_names(checker: &Checker, call: &ExprCall, expr: &Expr, argvalues: &Expr) { let names_type = checker.settings.flake8_pytest_style.parametrize_names_type; match expr { @@ -343,7 +343,7 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { match names_type { types::ParametrizeNameType::Tuple => { let name_range = get_parametrize_name_range( - decorator, + call, expr, checker.comment_ranges(), checker.locator().contents(), @@ -361,8 +361,9 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { .iter() .map(|name| { Expr::from(ast::StringLiteral { - value: (*name).to_string().into_boxed_str(), - ..ast::StringLiteral::default() + value: Box::from(*name), + range: TextRange::default(), + flags: checker.default_string_flags(), }) }) .collect(), @@ -374,11 +375,11 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { format!("({})", checker.generator().expr(&node)), name_range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } types::ParametrizeNameType::List => { let name_range = get_parametrize_name_range( - decorator, + call, expr, checker.comment_ranges(), checker.locator().contents(), @@ -396,8 +397,9 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { .iter() .map(|name| { Expr::from(ast::StringLiteral { - value: (*name).to_string().into_boxed_str(), - ..ast::StringLiteral::default() + value: Box::from(*name), + range: TextRange::default(), + flags: checker.default_string_flags(), }) }) .collect(), @@ -408,7 +410,7 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { checker.generator().expr(&node), name_range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } types::ParametrizeNameType::Csv => {} } @@ -416,7 +418,7 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { } Expr::Tuple(ast::ExprTuple { elts, .. }) => { if elts.len() == 1 { - handle_single_name(checker, expr, &elts[0]); + handle_single_name(checker, expr, &elts[0], argvalues); } else { match names_type { types::ParametrizeNameType::Tuple => {} @@ -437,7 +439,7 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { checker.generator().expr(&node), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } types::ParametrizeNameType::Csv => { let mut diagnostic = Diagnostic::new( @@ -447,20 +449,22 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { }, expr.range(), ); - if let Some(content) = elts_to_csv(elts, checker.generator()) { + if let Some(content) = + elts_to_csv(elts, checker.generator(), checker.default_string_flags()) + { diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( content, expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - }; + } } Expr::List(ast::ExprList { elts, .. }) => { if elts.len() == 1 { - handle_single_name(checker, expr, &elts[0]); + handle_single_name(checker, expr, &elts[0], argvalues); } else { match names_type { types::ParametrizeNameType::List => {} @@ -482,7 +486,7 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { format!("({})", checker.generator().expr(&node)), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } types::ParametrizeNameType::Csv => { let mut diagnostic = Diagnostic::new( @@ -492,23 +496,25 @@ fn check_names(checker: &mut Checker, decorator: &Decorator, expr: &Expr) { }, expr.range(), ); - if let Some(content) = elts_to_csv(elts, checker.generator()) { + if let Some(content) = + elts_to_csv(elts, checker.generator(), checker.default_string_flags()) + { diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( content, expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - }; + } } _ => {} } } /// PT007 -fn check_values(checker: &mut Checker, names: &Expr, values: &Expr) { +fn check_values(checker: &Checker, names: &Expr, values: &Expr) { let values_type = checker.settings.flake8_pytest_style.parametrize_values_type; let values_row_type = checker @@ -564,7 +570,7 @@ fn check_values(checker: &mut Checker, names: &Expr, values: &Expr) { ); Fix::unsafe_edits(values_start, [values_end]) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } if is_multi_named { @@ -612,7 +618,7 @@ fn check_values(checker: &mut Checker, names: &Expr, values: &Expr) { Fix::unsafe_edits(values_start, [values_end]) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } if is_multi_named { @@ -644,7 +650,7 @@ fn trailing_comma(element: &Expr, source: &str, max_index: TextSize) -> TextSize } /// PT014 -fn check_duplicates(checker: &mut Checker, values: &Expr) { +fn check_duplicates(checker: &Checker, values: &Expr) { let (Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. })) = values else { @@ -673,32 +679,94 @@ fn check_duplicates(checker: &mut Checker, values: &Expr) { diagnostic.set_fix(Fix::unsafe_edit(Edit::range_deletion(deletion_range))); } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); }) .or_insert(index); prev = Some(element); } } -fn handle_single_name(checker: &mut Checker, expr: &Expr, value: &Expr) { +fn handle_single_name(checker: &Checker, argnames: &Expr, value: &Expr, argvalues: &Expr) { let mut diagnostic = Diagnostic::new( PytestParametrizeNamesWrongType { single_argument: true, expected: types::ParametrizeNameType::Csv, }, - expr.range(), + argnames.range(), ); + // If `argnames` and all items in `argvalues` are single-element sequences, + // they all should be unpacked. Here's an example: + // + // ```python + // @pytest.mark.parametrize(("x",), [(1,), (2,)]) + // def test_foo(x): + // assert isinstance(x, int) + // ``` + // + // The code above should be transformed into: + // + // ```python + // @pytest.mark.parametrize("x", [1, 2]) + // def test_foo(x): + // assert isinstance(x, int) + // ``` + // + // Only unpacking `argnames` would break the test: + // + // ```python + // @pytest.mark.parametrize("x", [(1,), (2,)]) + // def test_foo(x): + // assert isinstance(x, int) # fails because `x` is a tuple, not an int + // ``` + let argvalues_edits = unpack_single_element_items(checker, argvalues); + let argnames_edit = Edit::range_replacement(checker.generator().expr(value), argnames.range()); + let fix = if checker.comment_ranges().intersects(argnames_edit.range()) + || argvalues_edits + .iter() + .any(|edit| checker.comment_ranges().intersects(edit.range())) + { + Fix::unsafe_edits(argnames_edit, argvalues_edits) + } else { + Fix::safe_edits(argnames_edit, argvalues_edits) + }; + diagnostic.set_fix(fix); + checker.report_diagnostic(diagnostic); +} + +/// Generate [`Edit`]s to unpack single-element lists or tuples in the given [`Expr`]. +/// For instance, `[(1,) (2,)]` will be transformed into `[1, 2]`. +fn unpack_single_element_items(checker: &Checker, expr: &Expr) -> Vec<Edit> { + let (Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. })) = expr + else { + return vec![]; + }; + + let mut edits = Vec::with_capacity(elts.len()); + for value in elts { + let (Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. })) = + value + else { + return vec![]; + }; + + let [elt] = elts.as_slice() else { + return vec![]; + }; + + if matches!(elt, Expr::Starred(_)) { + return vec![]; + } - let node = value.clone(); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - checker.generator().expr(&node), - expr.range(), - ))); - checker.diagnostics.push(diagnostic); + edits.push(Edit::range_replacement( + checker.generator().expr(elt), + value.range(), + )); + } + edits } fn handle_value_rows( - checker: &mut Checker, + checker: &Checker, elts: &[Expr], values_type: types::ParametrizeValuesType, values_row_type: types::ParametrizeValuesRowType, @@ -745,7 +813,7 @@ fn handle_value_rows( let elt_end = Edit::replacement("]".into(), start, elt.end()); Fix::unsafe_edits(elt_start, [elt_end]) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } Expr::List(ast::ExprList { elts, .. }) => { @@ -789,7 +857,7 @@ fn handle_value_rows( ); Fix::unsafe_edits(elt_start, [elt_end]) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } _ => {} @@ -797,30 +865,30 @@ fn handle_value_rows( } } -pub(crate) fn parametrize(checker: &mut Checker, decorators: &[Decorator]) { - for decorator in decorators { - if is_pytest_parametrize(decorator, checker.semantic()) { - if let Expr::Call(ast::ExprCall { - arguments: Arguments { args, .. }, - .. - }) = &decorator.expression - { - if checker.enabled(Rule::PytestParametrizeNamesWrongType) { - if let [names, ..] = &**args { - check_names(checker, decorator, names); - } - } - if checker.enabled(Rule::PytestParametrizeValuesWrongType) { - if let [names, values, ..] = &**args { - check_values(checker, names, values); - } - } - if checker.enabled(Rule::PytestDuplicateParametrizeTestCases) { - if let [_, values, ..] = &**args { - check_duplicates(checker, values); - } - } - } +pub(crate) fn parametrize(checker: &Checker, call: &ExprCall) { + if !is_pytest_parametrize(call, checker.semantic()) { + return; + } + + if checker.enabled(Rule::PytestParametrizeNamesWrongType) { + let names = call.arguments.find_argument_value("argnames", 0); + let values = call.arguments.find_argument_value("argvalues", 1); + + if let (Some(names), Some(values)) = (names, values) { + check_names(checker, call, names, values); + } + } + if checker.enabled(Rule::PytestParametrizeValuesWrongType) { + let names = call.arguments.find_argument_value("argnames", 0); + let values = call.arguments.find_argument_value("argvalues", 1); + + if let (Some(names), Some(values)) = (names, values) { + check_values(checker, names, values); + } + } + if checker.enabled(Rule::PytestDuplicateParametrizeTestCases) { + if let Some(values) = call.arguments.find_argument_value("argvalues", 1) { + check_duplicates(checker, values); } } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/patch.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/patch.rs index 1b99eb9e21bbd..21876daa195ff 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/patch.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/patch.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; @@ -38,14 +38,14 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Python documentation: `unittest.mock.patch`](https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch) -/// - [`pytest-mock`](https://pypi.org/project/pytest-mock/) -#[violation] -pub struct PytestPatchWithLambda; +/// - [PyPI: `pytest-mock`](https://pypi.org/project/pytest-mock/) +#[derive(ViolationMetadata)] +pub(crate) struct PytestPatchWithLambda; impl Violation for PytestPatchWithLambda { #[derive_message_formats] fn message(&self) -> String { - format!("Use `return_value=` instead of patching with `lambda`") + "Use `return_value=` instead of patching with `lambda`".to_string() } } @@ -84,7 +84,7 @@ fn check_patch_call(call: &ast::ExprCall, index: usize) -> Option<Diagnostic> { range: _, } = call .arguments - .find_argument("new", index)? + .find_argument_value("new", index)? .as_lambda_expr()?; // Walk the lambda body. If the lambda uses the arguments, then it's valid. diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/raises.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/raises.rs index 96c76a2f8b368..791843e2719bb 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/raises.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/raises.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_compound_statement; use ruff_python_ast::{self as ast, Expr, Stmt, WithItem}; use ruff_python_semantic::SemanticModel; @@ -13,11 +13,16 @@ use super::helpers::is_empty_or_null_string; /// ## What it does /// Checks for `pytest.raises` context managers with multiple statements. /// +/// This rule allows `pytest.raises` bodies to contain `for` +/// loops with empty bodies (e.g., `pass` or `...` statements), to test +/// iterator behavior. +/// /// ## Why is this bad? /// When a `pytest.raises` is used as a context manager and contains multiple /// statements, it can lead to the test passing when it actually should fail. -/// To avoid this, a `pytest.raises` context manager should only contain -/// a single simple statement that raises the expected exception. +/// +/// A `pytest.raises` context manager should only contain a single simple +/// statement that raises the expected exception. /// /// ## Example /// ```python @@ -45,13 +50,13 @@ use super::helpers::is_empty_or_null_string; /// /// ## References /// - [`pytest` documentation: `pytest.raises`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) -#[violation] -pub struct PytestRaisesWithMultipleStatements; +#[derive(ViolationMetadata)] +pub(crate) struct PytestRaisesWithMultipleStatements; impl Violation for PytestRaisesWithMultipleStatements { #[derive_message_formats] fn message(&self) -> String { - format!("`pytest.raises()` block should contain a single simple statement") + "`pytest.raises()` block should contain a single simple statement".to_string() } } @@ -96,8 +101,8 @@ impl Violation for PytestRaisesWithMultipleStatements { /// /// ## References /// - [`pytest` documentation: `pytest.raises`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) -#[violation] -pub struct PytestRaisesTooBroad { +#[derive(ViolationMetadata)] +pub(crate) struct PytestRaisesTooBroad { exception: String, } @@ -141,17 +146,17 @@ impl Violation for PytestRaisesTooBroad { /// /// ## References /// - [`pytest` documentation: `pytest.raises`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) -#[violation] -pub struct PytestRaisesWithoutException; +#[derive(ViolationMetadata)] +pub(crate) struct PytestRaisesWithoutException; impl Violation for PytestRaisesWithoutException { #[derive_message_formats] fn message(&self) -> String { - format!("set the expected exception in `pytest.raises()`") + "Set the expected exception in `pytest.raises()`".to_string() } } -fn is_pytest_raises(func: &Expr, semantic: &SemanticModel) -> bool { +pub(crate) fn is_pytest_raises(func: &Expr, semantic: &SemanticModel) -> bool { semantic .resolve_qualified_name(func) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["pytest", "raises"])) @@ -165,11 +170,15 @@ const fn is_non_trivial_with_body(body: &[Stmt]) -> bool { } } -pub(crate) fn raises_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn raises_call(checker: &Checker, call: &ast::ExprCall) { if is_pytest_raises(&call.func, checker.semantic()) { if checker.enabled(Rule::PytestRaisesWithoutException) { - if call.arguments.is_empty() { - checker.diagnostics.push(Diagnostic::new( + if call + .arguments + .find_argument("expected_exception", 0) + .is_none() + { + checker.report_diagnostic(Diagnostic::new( PytestRaisesWithoutException, call.func.range(), )); @@ -177,26 +186,29 @@ pub(crate) fn raises_call(checker: &mut Checker, call: &ast::ExprCall) { } if checker.enabled(Rule::PytestRaisesTooBroad) { - let match_keyword = call.arguments.find_keyword("match"); - if let Some(exception) = call.arguments.args.first() { - if let Some(match_keyword) = match_keyword { - if is_empty_or_null_string(&match_keyword.value) { + // Pytest.raises has two overloads + // ```py + // with raises(expected_exception: type[E] | tuple[type[E], ...], *, match: str | Pattern[str] | None = ...) → RaisesContext[E] as excinfo + // with raises(expected_exception: type[E] | tuple[type[E], ...], func: Callable[[...], Any], *args: Any, **kwargs: Any) → ExceptionInfo[E] as excinfo + // ``` + // Don't raise this diagnostic if the call matches the second overload (has a second positional argument or an argument named `func`) + if call.arguments.find_argument("func", 1).is_none() { + if let Some(exception) = call.arguments.find_argument_value("expected_exception", 0) + { + if call + .arguments + .find_keyword("match") + .is_none_or(|k| is_empty_or_null_string(&k.value)) + { exception_needs_match(checker, exception); } - } else { - exception_needs_match(checker, exception); } } } } } -pub(crate) fn complex_raises( - checker: &mut Checker, - stmt: &Stmt, - items: &[WithItem], - body: &[Stmt], -) { +pub(crate) fn complex_raises(checker: &Checker, stmt: &Stmt, items: &[WithItem], body: &[Stmt]) { let raises_called = items.iter().any(|item| match &item.context_expr { Expr::Call(ast::ExprCall { func, .. }) => is_pytest_raises(func, checker.semantic()), _ => false, @@ -207,8 +219,14 @@ pub(crate) fn complex_raises( let is_too_complex = if let [stmt] = body { match stmt { Stmt::With(ast::StmtWith { body, .. }) => is_non_trivial_with_body(body), - // Allow function and class definitions to test decorators + // Allow function and class definitions to test decorators. Stmt::ClassDef(_) | Stmt::FunctionDef(_) => false, + // Allow empty `for` loops to test iterators. + Stmt::For(ast::StmtFor { body, .. }) => match &body[..] { + [Stmt::Pass(_)] => false, + [Stmt::Expr(ast::StmtExpr { value, .. })] => !value.is_ellipsis_literal_expr(), + _ => true, + }, stmt => is_compound_statement(stmt), } } else { @@ -216,7 +234,7 @@ pub(crate) fn complex_raises( }; if is_too_complex { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PytestRaisesWithMultipleStatements, stmt.range(), )); @@ -225,7 +243,7 @@ pub(crate) fn complex_raises( } /// PT011 -fn exception_needs_match(checker: &mut Checker, exception: &Expr) { +fn exception_needs_match(checker: &Checker, exception: &Expr) { if let Some(qualified_name) = checker .semantic() .resolve_qualified_name(exception) @@ -246,7 +264,7 @@ fn exception_needs_match(checker: &mut Checker, exception: &Expr) { .then_some(qualified_name) }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PytestRaisesTooBroad { exception: qualified_name, }, diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/test_functions.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/test_functions.rs new file mode 100644 index 0000000000000..d6d7c4e6cdb74 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/test_functions.rs @@ -0,0 +1,69 @@ +use crate::checkers::ast::Checker; +use crate::rules::flake8_pytest_style::rules::helpers::is_likely_pytest_test; +use ruff_diagnostics::{Diagnostic, Edit, Fix, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::StmtFunctionDef; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for parameters of test functions with default arguments. +/// +/// ## Why is this bad? +/// Such a parameter will always have the default value during the test +/// regardless of whether a fixture with the same name is defined. +/// +/// ## Example +/// +/// ```python +/// def test_foo(a=1): ... +/// ``` +/// +/// Use instead: +/// +/// ```python +/// def test_foo(a): ... +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe, as modifying a function signature can +/// change the behavior of the code. +/// +/// ## References +/// - [Original Pytest issue](https://github.com/pytest-dev/pytest/issues/12693) +#[derive(ViolationMetadata)] +pub(crate) struct PytestParameterWithDefaultArgument { + parameter_name: String, +} + +impl Violation for PytestParameterWithDefaultArgument { + #[derive_message_formats] + fn message(&self) -> String { + format!( + "Test function parameter `{}` has default argument", + self.parameter_name + ) + } + + fn fix_title(&self) -> Option<String> { + Some("Remove default argument".to_string()) + } +} + +/// PT028 +pub(crate) fn parameter_with_default_argument(checker: &Checker, function_def: &StmtFunctionDef) { + if !is_likely_pytest_test(function_def, checker) { + return; + } + + for parameter in function_def.parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { + continue; + }; + let parameter_name = parameter.name().to_string(); + let kind = PytestParameterWithDefaultArgument { parameter_name }; + let diagnostic = Diagnostic::new(kind, default.range()); + let edit = Edit::deletion(parameter.parameter.end(), parameter.end()); + let fix = Fix::display_only_edit(edit); + checker.report_diagnostic(diagnostic.with_fix(fix)); + } +} diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/unittest_assert.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/unittest_assert.rs index fce0ea72420b0..1ff51ccbd2517 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/unittest_assert.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/unittest_assert.rs @@ -1,4 +1,4 @@ -use anyhow::{anyhow, bail, Result}; +use anyhow::{Result, anyhow, bail}; use ruff_python_ast::name::Name; use ruff_python_ast::{ self as ast, Arguments, CmpOp, Expr, ExprContext, Identifier, Keyword, Stmt, UnaryOp, diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/rules/warns.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/warns.rs new file mode 100644 index 0000000000000..a0ccb4a52d673 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/rules/warns.rs @@ -0,0 +1,263 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::is_compound_statement; +use ruff_python_ast::{self as ast, Expr, Stmt, WithItem}; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::registry::Rule; + +use super::helpers::is_empty_or_null_string; + +/// ## What it does +/// Checks for `pytest.warns` context managers with multiple statements. +/// +/// This rule allows `pytest.warns` bodies to contain `for` +/// loops with empty bodies (e.g., `pass` or `...` statements), to test +/// iterator behavior. +/// +/// ## Why is this bad? +/// When `pytest.warns` is used as a context manager and contains multiple +/// statements, it can lead to the test passing when it should instead fail. +/// +/// A `pytest.warns` context manager should only contain a single +/// simple statement that triggers the expected warning. +/// +/// +/// ## Example +/// ```python +/// import pytest +/// +/// +/// def test_foo_warns(): +/// with pytest.warns(Warning): +/// setup() # False negative if setup triggers a warning but foo does not. +/// foo() +/// ``` +/// +/// Use instead: +/// ```python +/// import pytest +/// +/// +/// def test_foo_warns(): +/// setup() +/// with pytest.warns(Warning): +/// foo() +/// ``` +/// +/// ## References +/// - [`pytest` documentation: `pytest.warns`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-warns) +#[derive(ViolationMetadata)] +pub(crate) struct PytestWarnsWithMultipleStatements; + +impl Violation for PytestWarnsWithMultipleStatements { + #[derive_message_formats] + fn message(&self) -> String { + "`pytest.warns()` block should contain a single simple statement".to_string() + } +} + +/// ## What it does +/// Checks for `pytest.warns` calls without a `match` parameter. +/// +/// ## Why is this bad? +/// `pytest.warns(Warning)` will catch any `Warning` and may catch warnings that +/// are unrelated to the code under test. To avoid this, `pytest.warns` should +/// be called with a `match` parameter. The warning names that require a `match` +/// parameter can be configured via the +/// [`lint.flake8-pytest-style.warns-require-match-for`] and +/// [`lint.flake8-pytest-style.warns-extend-require-match-for`] settings. +/// +/// ## Example +/// ```python +/// import pytest +/// +/// +/// def test_foo(): +/// with pytest.warns(RuntimeWarning): +/// ... +/// +/// # empty string is also an error +/// with pytest.warns(RuntimeWarning, match=""): +/// ... +/// ``` +/// +/// Use instead: +/// ```python +/// import pytest +/// +/// +/// def test_foo(): +/// with pytest.warns(RuntimeWarning, match="expected message"): +/// ... +/// ``` +/// +/// ## Options +/// - `lint.flake8-pytest-style.warns-require-match-for` +/// - `lint.flake8-pytest-style.warns-extend-require-match-for` +/// +/// ## References +/// - [`pytest` documentation: `pytest.warns`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-warns) +#[derive(ViolationMetadata)] +pub(crate) struct PytestWarnsTooBroad { + warning: String, +} + +impl Violation for PytestWarnsTooBroad { + #[derive_message_formats] + fn message(&self) -> String { + let PytestWarnsTooBroad { warning } = self; + format!( + "`pytest.warns({warning})` is too broad, set the `match` parameter or use a more \ + specific warning" + ) + } +} + +/// ## What it does +/// Checks for `pytest.warns` calls without an expected warning. +/// +/// ## Why is this bad? +/// `pytest.warns` expects to receive an expected warning as its first +/// argument. If omitted, the `pytest.warns` call will fail at runtime. +/// +/// ## Example +/// ```python +/// import pytest +/// +/// +/// def test_foo(): +/// with pytest.warns(): +/// do_something() +/// ``` +/// +/// Use instead: +/// ```python +/// import pytest +/// +/// +/// def test_foo(): +/// with pytest.warns(SomeWarning): +/// do_something() +/// ``` +/// +/// ## References +/// - [`pytest` documentation: `pytest.warns`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-warns) +#[derive(ViolationMetadata)] +pub(crate) struct PytestWarnsWithoutWarning; + +impl Violation for PytestWarnsWithoutWarning { + #[derive_message_formats] + fn message(&self) -> String { + "Set the expected warning in `pytest.warns()`".to_string() + } +} + +pub(crate) fn is_pytest_warns(func: &Expr, semantic: &SemanticModel) -> bool { + semantic + .resolve_qualified_name(func) + .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["pytest", "warns"])) +} + +const fn is_non_trivial_with_body(body: &[Stmt]) -> bool { + if let [stmt] = body { + is_compound_statement(stmt) + } else { + true + } +} + +/// PT029, PT030 +pub(crate) fn warns_call(checker: &Checker, call: &ast::ExprCall) { + if is_pytest_warns(&call.func, checker.semantic()) { + if checker.enabled(Rule::PytestWarnsWithoutWarning) { + if call.arguments.is_empty() { + checker.report_diagnostic(Diagnostic::new( + PytestWarnsWithoutWarning, + call.func.range(), + )); + } + } + + if checker.enabled(Rule::PytestWarnsTooBroad) { + if let Some(warning) = call.arguments.find_argument_value("expected_warning", 0) { + if call + .arguments + .find_keyword("match") + .is_none_or(|k| is_empty_or_null_string(&k.value)) + { + warning_needs_match(checker, warning); + } + } + } + } +} + +/// PT031 +pub(crate) fn complex_warns(checker: &Checker, stmt: &Stmt, items: &[WithItem], body: &[Stmt]) { + let warns_called = items.iter().any(|item| match &item.context_expr { + Expr::Call(ast::ExprCall { func, .. }) => is_pytest_warns(func, checker.semantic()), + _ => false, + }); + + // Check body for `pytest.warns` context manager + if warns_called { + let is_too_complex = if let [stmt] = body { + match stmt { + Stmt::With(ast::StmtWith { body, .. }) => is_non_trivial_with_body(body), + // Allow function and class definitions to test decorators. + Stmt::ClassDef(_) | Stmt::FunctionDef(_) => false, + // Allow empty `for` loops to test iterators. + Stmt::For(ast::StmtFor { body, .. }) => match &body[..] { + [Stmt::Pass(_)] => false, + [Stmt::Expr(ast::StmtExpr { value, .. })] => !value.is_ellipsis_literal_expr(), + _ => true, + }, + stmt => is_compound_statement(stmt), + } + } else { + true + }; + + if is_too_complex { + checker.report_diagnostic(Diagnostic::new( + PytestWarnsWithMultipleStatements, + stmt.range(), + )); + } + } +} + +/// PT030 +fn warning_needs_match(checker: &Checker, warning: &Expr) { + if let Some(qualified_name) = + checker + .semantic() + .resolve_qualified_name(warning) + .and_then(|qualified_name| { + let qualified_name = qualified_name.to_string(); + checker + .settings + .flake8_pytest_style + .warns_require_match_for + .iter() + .chain( + &checker + .settings + .flake8_pytest_style + .warns_extend_require_match_for, + ) + .any(|pattern| pattern.matches(&qualified_name)) + .then_some(qualified_name) + }) + { + checker.report_diagnostic(Diagnostic::new( + PytestWarnsTooBroad { + warning: qualified_name, + }, + warning.range(), + )); + } +} diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/settings.rs b/crates/ruff_linter/src/rules/flake8_pytest_style/settings.rs index 582b9a5fe37eb..a52e06b356391 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/settings.rs @@ -24,6 +24,12 @@ pub fn default_broad_exceptions() -> Vec<IdentifierPattern> { .to_vec() } +pub fn default_broad_warnings() -> Vec<IdentifierPattern> { + ["Warning", "UserWarning", "DeprecationWarning"] + .map(|pattern| IdentifierPattern::new(pattern).expect("invalid default warning pattern")) + .to_vec() +} + #[derive(Debug, Clone, CacheKey)] pub struct Settings { pub fixture_parentheses: bool, @@ -33,6 +39,8 @@ pub struct Settings { pub raises_require_match_for: Vec<IdentifierPattern>, pub raises_extend_require_match_for: Vec<IdentifierPattern>, pub mark_parentheses: bool, + pub warns_require_match_for: Vec<IdentifierPattern>, + pub warns_extend_require_match_for: Vec<IdentifierPattern>, } impl Default for Settings { @@ -45,6 +53,8 @@ impl Default for Settings { raises_require_match_for: default_broad_exceptions(), raises_extend_require_match_for: vec![], mark_parentheses: false, + warns_require_match_for: default_broad_warnings(), + warns_extend_require_match_for: vec![], } } } @@ -73,6 +83,8 @@ impl fmt::Display for Settings { pub enum SettingsError { InvalidRaisesRequireMatchFor(glob::PatternError), InvalidRaisesExtendRequireMatchFor(glob::PatternError), + InvalidWarnsRequireMatchFor(glob::PatternError), + InvalidWarnsExtendRequireMatchFor(glob::PatternError), } impl fmt::Display for SettingsError { @@ -84,6 +96,12 @@ impl fmt::Display for SettingsError { SettingsError::InvalidRaisesExtendRequireMatchFor(err) => { write!(f, "invalid raises-extend-require-match-for pattern: {err}") } + SettingsError::InvalidWarnsRequireMatchFor(err) => { + write!(f, "invalid warns-require-match-for pattern: {err}") + } + SettingsError::InvalidWarnsExtendRequireMatchFor(err) => { + write!(f, "invalid warns-extend-require-match-for pattern: {err}") + } } } } @@ -93,6 +111,8 @@ impl Error for SettingsError { match self { SettingsError::InvalidRaisesRequireMatchFor(err) => Some(err), SettingsError::InvalidRaisesExtendRequireMatchFor(err) => Some(err), + SettingsError::InvalidWarnsRequireMatchFor(err) => Some(err), + SettingsError::InvalidWarnsExtendRequireMatchFor(err) => Some(err), } } } diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_default.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_default.snap index 62b6b322b3f6f..8bcf1ce60d196 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_default.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_default.snap @@ -23,7 +23,7 @@ PT001.py:14:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` PT001.py:24:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` | 24 | / @pytest.fixture( -25 | | +25 | | 26 | | ) | |_^ PT001 27 | def parentheses_no_params_multiline(): @@ -65,7 +65,7 @@ PT001.py:39:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` PT001.py:49:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` | 49 | / @fixture( -50 | | +50 | | 51 | | ) | |_^ PT001 52 | def imported_from_parentheses_no_params_multiline(): @@ -107,7 +107,7 @@ PT001.py:64:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` PT001.py:74:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()` | 74 | / @aliased( -75 | | +75 | | 76 | | ) | |_^ PT001 77 | def aliased_parentheses_no_params_multiline(): diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_parentheses.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_parentheses.snap index 05e4fcdcba6db..31ad575dede04 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_parentheses.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT001_parentheses.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT001.py:9:1: PT001 [*] Use `@pytest.fixture()` over `@pytest.fixture` | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT002.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT002.snap index 4185534912f91..bde3e57c91f97 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT002.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT002.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT002.py:14:1: PT002 Configuration for fixture `my_fixture` specified via positional args, use kwargs | @@ -16,5 +17,3 @@ PT002.py:19:1: PT002 Configuration for fixture `my_fixture` specified via positi 20 | def my_fixture(): # Error mixed 21 | return 0 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT003.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT003.snap index 1e7536acab7f0..f57950bcd4dd4 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT003.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT003.snap @@ -141,8 +141,7 @@ PT003.py:66:5: PT003 [*] `scope='function'` is implied in `@pytest.fixture()` | 64 | # another comment ,) 65 | -66 | scope=\ - | _____^ +66 | / scope=\ 67 | | "function" # some comment ), | |__________________^ PT003 68 | , @@ -160,5 +159,3 @@ PT003.py:66:5: PT003 [*] `scope='function'` is implied in `@pytest.fixture()` 70 66 | name2=name, name3="my_fixture", **kwargs 71 67 | ) 72 68 | def error_multiple_args(): - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT004.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT004.snap deleted file mode 100644 index 4617a063c5eec..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT004.snap +++ /dev/null @@ -1,21 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs ---- -PT004.py:51:5: PT004 Fixture `patch_something` does not return anything, add leading underscore - | -50 | @pytest.fixture() -51 | def patch_something(mocker): # Error simple - | ^^^^^^^^^^^^^^^ PT004 -52 | mocker.patch("some.thing") - | - -PT004.py:56:5: PT004 Fixture `activate_context` does not return anything, add leading underscore - | -55 | @pytest.fixture() -56 | def activate_context(): # Error with yield - | ^^^^^^^^^^^^^^^^ PT004 -57 | with context: -58 | yield - | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT005.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT005.snap deleted file mode 100644 index 40023ff641b44..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT005.snap +++ /dev/null @@ -1,30 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs ---- -PT005.py:41:5: PT005 Fixture `_my_fixture` returns a value, remove leading underscore - | -40 | @pytest.fixture() -41 | def _my_fixture(mocker): # Error with return - | ^^^^^^^^^^^ PT005 -42 | return 0 - | - -PT005.py:46:5: PT005 Fixture `_activate_context` returns a value, remove leading underscore - | -45 | @pytest.fixture() -46 | def _activate_context(): # Error with yield - | ^^^^^^^^^^^^^^^^^ PT005 -47 | with get_context() as context: -48 | yield context - | - -PT005.py:52:5: PT005 Fixture `_activate_context` returns a value, remove leading underscore - | -51 | @pytest.fixture() -52 | def _activate_context(): # Error with conditional yield from - | ^^^^^^^^^^^^^^^^^ PT005 -53 | if some_condition: -54 | with get_context() as context: - | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_and_PT007.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_and_PT007.snap new file mode 100644 index 0000000000000..53fcf3c33ab39 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_and_PT007.snap @@ -0,0 +1,59 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT006_and_PT007.py:3:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +1 | import pytest +2 | +3 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +4 | def test_PT006_and_PT007_do_not_conflict(param): +5 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +1 1 | import pytest +2 2 | +3 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 3 |+@pytest.mark.parametrize("param", [1, 2]) +4 4 | def test_PT006_and_PT007_do_not_conflict(param): +5 5 | ... + +PT006_and_PT007.py:3:39: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` + | +1 | import pytest +2 | +3 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^ PT007 +4 | def test_PT006_and_PT007_do_not_conflict(param): +5 | ... + | + = help: Use `list` of `tuple` for parameter values + +ℹ Unsafe fix +1 1 | import pytest +2 2 | +3 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 3 |+@pytest.mark.parametrize(("param",), [(1,), [2]]) +4 4 | def test_PT006_and_PT007_do_not_conflict(param): +5 5 | ... + +PT006_and_PT007.py:3:44: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` + | +1 | import pytest +2 | +3 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^ PT007 +4 | def test_PT006_and_PT007_do_not_conflict(param): +5 | ... + | + = help: Use `list` of `tuple` for parameter values + +ℹ Unsafe fix +1 1 | import pytest +2 2 | +3 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 3 |+@pytest.mark.parametrize(("param",), [[1], (2,)]) +4 4 | def test_PT006_and_PT007_do_not_conflict(param): +5 5 | ... diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_csv.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_csv.snap index be44a3102e42f..1d00aa145382c 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_csv.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_csv.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected a string of comma-separated values +PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected a string of comma-separated values | 24 | @pytest.mark.parametrize(("param1", "param2"), [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^ PT006 @@ -20,7 +20,7 @@ PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 26 26 | ... 27 27 | -PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 29 | @pytest.mark.parametrize(("param1",), [1, 2, 3]) | ^^^^^^^^^^^ PT006 @@ -39,7 +39,7 @@ PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 31 31 | ... 32 32 | -PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected a string of comma-separated values +PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected a string of comma-separated values | 34 | @pytest.mark.parametrize(["param1", "param2"], [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^ PT006 @@ -58,7 +58,7 @@ PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 36 36 | ... 37 37 | -PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 39 | @pytest.mark.parametrize(["param1"], [1, 2, 3]) | ^^^^^^^^^^ PT006 @@ -77,7 +77,7 @@ PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 41 41 | ... 42 42 | -PT006.py:44:26: PT006 Wrong type passed to first argument of `@pytest.mark.parametrize`; expected a string of comma-separated values +PT006.py:44:26: PT006 Wrong type passed to first argument of `pytest.mark.parametrize`; expected a string of comma-separated values | 44 | @pytest.mark.parametrize([some_expr, another_expr], [1, 2, 3]) | ^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -86,7 +86,7 @@ PT006.py:44:26: PT006 Wrong type passed to first argument of `@pytest.mark.param | = help: Use a string of comma-separated values for the first argument -PT006.py:49:26: PT006 Wrong type passed to first argument of `@pytest.mark.parametrize`; expected a string of comma-separated values +PT006.py:49:26: PT006 Wrong type passed to first argument of `pytest.mark.parametrize`; expected a string of comma-separated values | 49 | @pytest.mark.parametrize([some_expr, "param2"], [1, 2, 3]) | ^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -94,3 +94,166 @@ PT006.py:49:26: PT006 Wrong type passed to first argument of `@pytest.mark.param 51 | ... | = help: Use a string of comma-separated values for the first argument + +PT006.py:86:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +86 | @pytest.mark.parametrize(("param",), [(1,), (2,)]) + | ^^^^^^^^^^ PT006 +87 | def test_single_element_tuple(param): +88 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +83 83 | ... +84 84 | +85 85 | +86 |-@pytest.mark.parametrize(("param",), [(1,), (2,)]) + 86 |+@pytest.mark.parametrize("param", [1, 2]) +87 87 | def test_single_element_tuple(param): +88 88 | ... +89 89 | + +PT006.py:91:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +91 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +92 | def test_single_element_list(param): +93 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +88 88 | ... +89 89 | +90 90 | +91 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 91 |+@pytest.mark.parametrize("param", [1, 2]) +92 92 | def test_single_element_list(param): +93 93 | ... +94 94 | + +PT006.py:96:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +96 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +97 | def test_single_element_list(param): +98 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +93 93 | ... +94 94 | +95 95 | +96 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 96 |+@pytest.mark.parametrize("param", [1, 2]) +97 97 | def test_single_element_list(param): +98 98 | ... +99 99 | + +PT006.py:103:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +101 | # Unsafe fix +102 | @pytest.mark.parametrize( +103 | / ( +104 | | # comment +105 | | "param", +106 | | ), + | |_____^ PT006 +107 | [[1], [2]], +108 | ) + | + = help: Use a string for the first argument + +ℹ Unsafe fix +100 100 | +101 101 | # Unsafe fix +102 102 | @pytest.mark.parametrize( +103 |- ( +104 |- # comment +105 |- "param", +106 |- ), +107 |- [[1], [2]], + 103 |+ "param", + 104 |+ [1, 2], +108 105 | ) +109 106 | def test_comment_in_argnames(param): +110 107 | ... + +PT006.py:114:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +112 | # Unsafe fix +113 | @pytest.mark.parametrize( +114 | ("param",), + | ^^^^^^^^^^ PT006 +115 | [ +116 | ( + | + = help: Use a string for the first argument + +ℹ Unsafe fix +111 111 | +112 112 | # Unsafe fix +113 113 | @pytest.mark.parametrize( +114 |- ("param",), + 114 |+ "param", +115 115 | [ +116 |- ( +117 |- # comment +118 |- 1, +119 |- ), +120 |- (2,), + 116 |+ 1, + 117 |+ 2, +121 118 | ], +122 119 | ) +123 120 | def test_comment_in_argvalues(param): + +PT006.py:129:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +127 | # Safe fix +128 | @pytest.mark.parametrize( +129 | ("param",), + | ^^^^^^^^^^ PT006 +130 | [ +131 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +126 126 | +127 127 | # Safe fix +128 128 | @pytest.mark.parametrize( +129 |- ("param",), + 129 |+ "param", +130 130 | [ +131 |- (1,), + 131 |+ 1, +132 132 | # comment +133 |- (2,), + 133 |+ 2, +134 134 | ], +135 135 | ) +136 136 | def test_comment_between_argvalues_items(param): + +PT006.py:142:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 | @pytest.mark.parametrize( +142 | ("param",), + | ^^^^^^^^^^ PT006 +143 | [ +144 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +139 139 | +140 140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 141 | @pytest.mark.parametrize( +142 |- ("param",), + 142 |+ "param", +143 143 | [ +144 144 | (1,), +145 145 | (2, 3), diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_default.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_default.snap index 2942fa06d4dc9..78a833a98cf15 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_default.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_default.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 9 | @pytest.mark.parametrize("param1,param2", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^ PT006 @@ -20,7 +20,7 @@ PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.pa 11 11 | ... 12 12 | -PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 14 | @pytest.mark.parametrize(" param1, , param2 , ", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -39,7 +39,7 @@ PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 16 16 | ... 17 17 | -PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 19 | @pytest.mark.parametrize("param1,param2", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^ PT006 @@ -58,7 +58,7 @@ PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 21 21 | ... 22 22 | -PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 29 | @pytest.mark.parametrize(("param1",), [1, 2, 3]) | ^^^^^^^^^^^ PT006 @@ -77,7 +77,7 @@ PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 31 31 | ... 32 32 | -PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 34 | @pytest.mark.parametrize(["param1", "param2"], [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^ PT006 @@ -96,7 +96,7 @@ PT006.py:34:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 36 36 | ... 37 37 | -PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 39 | @pytest.mark.parametrize(["param1"], [1, 2, 3]) | ^^^^^^^^^^ PT006 @@ -115,7 +115,7 @@ PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 41 41 | ... 42 42 | -PT006.py:44:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:44:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 44 | @pytest.mark.parametrize([some_expr, another_expr], [1, 2, 3]) | ^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -134,7 +134,7 @@ PT006.py:44:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 46 46 | ... 47 47 | -PT006.py:49:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:49:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 49 | @pytest.mark.parametrize([some_expr, "param2"], [1, 2, 3]) | ^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -153,7 +153,7 @@ PT006.py:49:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 51 51 | ... 52 52 | -PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 54 | @pytest.mark.parametrize(("param1, " "param2, " "param3"), [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -172,7 +172,7 @@ PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 56 56 | ... 57 57 | -PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 59 | @pytest.mark.parametrize("param1, " "param2, " "param3", [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -191,7 +191,7 @@ PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 61 61 | ... 62 62 | -PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 64 | @pytest.mark.parametrize((("param1, " "param2, " "param3")), [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -210,7 +210,7 @@ PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 66 66 | ... 67 67 | -PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `tuple` +PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` | 69 | @pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^ PT006 @@ -227,3 +227,205 @@ PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 69 |+@pytest.mark.parametrize(("param1", "param2"), [(1, 2), (3, 4)]) 70 70 | def test_csv_with_parens(param1, param2): 71 71 | ... +72 72 | + +PT006.py:74:39: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` + | +74 | parametrize = pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) + | ^^^^^^^^^^^^^^^^^ PT006 +75 | +76 | @parametrize + | + = help: Use a `tuple` for the first argument + +ℹ Unsafe fix +71 71 | ... +72 72 | +73 73 | +74 |-parametrize = pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) + 74 |+parametrize = pytest.mark.parametrize(("param1", "param2"), [(1, 2), (3, 4)]) +75 75 | +76 76 | @parametrize +77 77 | def test_not_decorator(param1, param2): + +PT006.py:81:35: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `tuple` + | +81 | @pytest.mark.parametrize(argnames=("param1,param2"), argvalues=[(1, 2), (3, 4)]) + | ^^^^^^^^^^^^^^^^^ PT006 +82 | def test_keyword_arguments(param1, param2): +83 | ... + | + = help: Use a `tuple` for the first argument + +ℹ Unsafe fix +78 78 | ... +79 79 | +80 80 | +81 |-@pytest.mark.parametrize(argnames=("param1,param2"), argvalues=[(1, 2), (3, 4)]) + 81 |+@pytest.mark.parametrize(argnames=("param1", "param2"), argvalues=[(1, 2), (3, 4)]) +82 82 | def test_keyword_arguments(param1, param2): +83 83 | ... +84 84 | + +PT006.py:86:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +86 | @pytest.mark.parametrize(("param",), [(1,), (2,)]) + | ^^^^^^^^^^ PT006 +87 | def test_single_element_tuple(param): +88 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +83 83 | ... +84 84 | +85 85 | +86 |-@pytest.mark.parametrize(("param",), [(1,), (2,)]) + 86 |+@pytest.mark.parametrize("param", [1, 2]) +87 87 | def test_single_element_tuple(param): +88 88 | ... +89 89 | + +PT006.py:91:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +91 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +92 | def test_single_element_list(param): +93 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +88 88 | ... +89 89 | +90 90 | +91 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 91 |+@pytest.mark.parametrize("param", [1, 2]) +92 92 | def test_single_element_list(param): +93 93 | ... +94 94 | + +PT006.py:96:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +96 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +97 | def test_single_element_list(param): +98 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +93 93 | ... +94 94 | +95 95 | +96 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 96 |+@pytest.mark.parametrize("param", [1, 2]) +97 97 | def test_single_element_list(param): +98 98 | ... +99 99 | + +PT006.py:103:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +101 | # Unsafe fix +102 | @pytest.mark.parametrize( +103 | / ( +104 | | # comment +105 | | "param", +106 | | ), + | |_____^ PT006 +107 | [[1], [2]], +108 | ) + | + = help: Use a string for the first argument + +ℹ Unsafe fix +100 100 | +101 101 | # Unsafe fix +102 102 | @pytest.mark.parametrize( +103 |- ( +104 |- # comment +105 |- "param", +106 |- ), +107 |- [[1], [2]], + 103 |+ "param", + 104 |+ [1, 2], +108 105 | ) +109 106 | def test_comment_in_argnames(param): +110 107 | ... + +PT006.py:114:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +112 | # Unsafe fix +113 | @pytest.mark.parametrize( +114 | ("param",), + | ^^^^^^^^^^ PT006 +115 | [ +116 | ( + | + = help: Use a string for the first argument + +ℹ Unsafe fix +111 111 | +112 112 | # Unsafe fix +113 113 | @pytest.mark.parametrize( +114 |- ("param",), + 114 |+ "param", +115 115 | [ +116 |- ( +117 |- # comment +118 |- 1, +119 |- ), +120 |- (2,), + 116 |+ 1, + 117 |+ 2, +121 118 | ], +122 119 | ) +123 120 | def test_comment_in_argvalues(param): + +PT006.py:129:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +127 | # Safe fix +128 | @pytest.mark.parametrize( +129 | ("param",), + | ^^^^^^^^^^ PT006 +130 | [ +131 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +126 126 | +127 127 | # Safe fix +128 128 | @pytest.mark.parametrize( +129 |- ("param",), + 129 |+ "param", +130 130 | [ +131 |- (1,), + 131 |+ 1, +132 132 | # comment +133 |- (2,), + 133 |+ 2, +134 134 | ], +135 135 | ) +136 136 | def test_comment_between_argvalues_items(param): + +PT006.py:142:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 | @pytest.mark.parametrize( +142 | ("param",), + | ^^^^^^^^^^ PT006 +143 | [ +144 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +139 139 | +140 140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 141 | @pytest.mark.parametrize( +142 |- ("param",), + 142 |+ "param", +143 143 | [ +144 144 | (1,), +145 145 | (2, 3), diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_list.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_list.snap index b5c44886ca862..affd3540c95e2 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_list.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT006_list.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 9 | @pytest.mark.parametrize("param1,param2", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^ PT006 @@ -20,7 +20,7 @@ PT006.py:9:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.pa 11 11 | ... 12 12 | -PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 14 | @pytest.mark.parametrize(" param1, , param2 , ", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -39,7 +39,7 @@ PT006.py:14:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 16 16 | ... 17 17 | -PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 19 | @pytest.mark.parametrize("param1,param2", [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^ PT006 @@ -58,7 +58,7 @@ PT006.py:19:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 21 21 | ... 22 22 | -PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 24 | @pytest.mark.parametrize(("param1", "param2"), [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^^^^ PT006 @@ -77,7 +77,7 @@ PT006.py:24:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 26 26 | ... 27 27 | -PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 29 | @pytest.mark.parametrize(("param1",), [1, 2, 3]) | ^^^^^^^^^^^ PT006 @@ -96,7 +96,7 @@ PT006.py:29:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 31 31 | ... 32 32 | -PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `str` +PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` | 39 | @pytest.mark.parametrize(["param1"], [1, 2, 3]) | ^^^^^^^^^^ PT006 @@ -115,7 +115,7 @@ PT006.py:39:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 41 41 | ... 42 42 | -PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 54 | @pytest.mark.parametrize(("param1, " "param2, " "param3"), [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -134,7 +134,7 @@ PT006.py:54:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 56 56 | ... 57 57 | -PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 59 | @pytest.mark.parametrize("param1, " "param2, " "param3", [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -153,7 +153,7 @@ PT006.py:59:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 61 61 | ... 62 62 | -PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 64 | @pytest.mark.parametrize((("param1, " "param2, " "param3")), [(1, 2, 3), (4, 5, 6)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT006 @@ -172,7 +172,7 @@ PT006.py:64:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 66 66 | ... 67 67 | -PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.parametrize`; expected `list` +PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` | 69 | @pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) | ^^^^^^^^^^^^^^^^^ PT006 @@ -189,3 +189,205 @@ PT006.py:69:26: PT006 [*] Wrong type passed to first argument of `@pytest.mark.p 69 |+@pytest.mark.parametrize(["param1", "param2"], [(1, 2), (3, 4)]) 70 70 | def test_csv_with_parens(param1, param2): 71 71 | ... +72 72 | + +PT006.py:74:39: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` + | +74 | parametrize = pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) + | ^^^^^^^^^^^^^^^^^ PT006 +75 | +76 | @parametrize + | + = help: Use a `list` for the first argument + +ℹ Unsafe fix +71 71 | ... +72 72 | +73 73 | +74 |-parametrize = pytest.mark.parametrize(("param1,param2"), [(1, 2), (3, 4)]) + 74 |+parametrize = pytest.mark.parametrize(["param1", "param2"], [(1, 2), (3, 4)]) +75 75 | +76 76 | @parametrize +77 77 | def test_not_decorator(param1, param2): + +PT006.py:81:35: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `list` + | +81 | @pytest.mark.parametrize(argnames=("param1,param2"), argvalues=[(1, 2), (3, 4)]) + | ^^^^^^^^^^^^^^^^^ PT006 +82 | def test_keyword_arguments(param1, param2): +83 | ... + | + = help: Use a `list` for the first argument + +ℹ Unsafe fix +78 78 | ... +79 79 | +80 80 | +81 |-@pytest.mark.parametrize(argnames=("param1,param2"), argvalues=[(1, 2), (3, 4)]) + 81 |+@pytest.mark.parametrize(argnames=["param1", "param2"], argvalues=[(1, 2), (3, 4)]) +82 82 | def test_keyword_arguments(param1, param2): +83 83 | ... +84 84 | + +PT006.py:86:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +86 | @pytest.mark.parametrize(("param",), [(1,), (2,)]) + | ^^^^^^^^^^ PT006 +87 | def test_single_element_tuple(param): +88 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +83 83 | ... +84 84 | +85 85 | +86 |-@pytest.mark.parametrize(("param",), [(1,), (2,)]) + 86 |+@pytest.mark.parametrize("param", [1, 2]) +87 87 | def test_single_element_tuple(param): +88 88 | ... +89 89 | + +PT006.py:91:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +91 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +92 | def test_single_element_list(param): +93 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +88 88 | ... +89 89 | +90 90 | +91 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 91 |+@pytest.mark.parametrize("param", [1, 2]) +92 92 | def test_single_element_list(param): +93 93 | ... +94 94 | + +PT006.py:96:26: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +96 | @pytest.mark.parametrize(("param",), [[1], [2]]) + | ^^^^^^^^^^ PT006 +97 | def test_single_element_list(param): +98 | ... + | + = help: Use a string for the first argument + +ℹ Safe fix +93 93 | ... +94 94 | +95 95 | +96 |-@pytest.mark.parametrize(("param",), [[1], [2]]) + 96 |+@pytest.mark.parametrize("param", [1, 2]) +97 97 | def test_single_element_list(param): +98 98 | ... +99 99 | + +PT006.py:103:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +101 | # Unsafe fix +102 | @pytest.mark.parametrize( +103 | / ( +104 | | # comment +105 | | "param", +106 | | ), + | |_____^ PT006 +107 | [[1], [2]], +108 | ) + | + = help: Use a string for the first argument + +ℹ Unsafe fix +100 100 | +101 101 | # Unsafe fix +102 102 | @pytest.mark.parametrize( +103 |- ( +104 |- # comment +105 |- "param", +106 |- ), +107 |- [[1], [2]], + 103 |+ "param", + 104 |+ [1, 2], +108 105 | ) +109 106 | def test_comment_in_argnames(param): +110 107 | ... + +PT006.py:114:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +112 | # Unsafe fix +113 | @pytest.mark.parametrize( +114 | ("param",), + | ^^^^^^^^^^ PT006 +115 | [ +116 | ( + | + = help: Use a string for the first argument + +ℹ Unsafe fix +111 111 | +112 112 | # Unsafe fix +113 113 | @pytest.mark.parametrize( +114 |- ("param",), + 114 |+ "param", +115 115 | [ +116 |- ( +117 |- # comment +118 |- 1, +119 |- ), +120 |- (2,), + 116 |+ 1, + 117 |+ 2, +121 118 | ], +122 119 | ) +123 120 | def test_comment_in_argvalues(param): + +PT006.py:129:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +127 | # Safe fix +128 | @pytest.mark.parametrize( +129 | ("param",), + | ^^^^^^^^^^ PT006 +130 | [ +131 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +126 126 | +127 127 | # Safe fix +128 128 | @pytest.mark.parametrize( +129 |- ("param",), + 129 |+ "param", +130 130 | [ +131 |- (1,), + 131 |+ 1, +132 132 | # comment +133 |- (2,), + 133 |+ 2, +134 134 | ], +135 135 | ) +136 136 | def test_comment_between_argvalues_items(param): + +PT006.py:142:5: PT006 [*] Wrong type passed to first argument of `pytest.mark.parametrize`; expected `str` + | +140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 | @pytest.mark.parametrize( +142 | ("param",), + | ^^^^^^^^^^ PT006 +143 | [ +144 | (1,), + | + = help: Use a string for the first argument + +ℹ Safe fix +139 139 | +140 140 | # A fix should be suggested for `argnames`, but not for `argvalues`. +141 141 | @pytest.mark.parametrize( +142 |- ("param",), + 142 |+ "param", +143 143 | [ +144 144 | (1,), +145 145 | (2, 3), diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_lists.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_lists.snap index 1feb8b1d245d0..f3b1a2bb66efb 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_lists.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_lists.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT007.py:4:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:4:35: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 4 | @pytest.mark.parametrize("param", (1, 2)) | ^^^^^^ PT007 @@ -20,12 +20,11 @@ PT007.py:4:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 6 6 | ... 7 7 | -PT007.py:11:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:11:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 9 | @pytest.mark.parametrize( 10 | ("param1", "param2"), -11 | ( - | _____^ +11 | / ( 12 | | (1, 2), 13 | | (3, 4), 14 | | ), @@ -49,7 +48,7 @@ PT007.py:11:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 16 16 | def test_tuple_of_tuples(param1, param2): 17 17 | ... -PT007.py:12:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:12:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 10 | ("param1", "param2"), 11 | ( @@ -70,7 +69,7 @@ PT007.py:12:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 14 14 | ), 15 15 | ) -PT007.py:13:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:13:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 11 | ( 12 | (1, 2), @@ -91,12 +90,11 @@ PT007.py:13:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 15 15 | ) 16 16 | def test_tuple_of_tuples(param1, param2): -PT007.py:22:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:22:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 20 | @pytest.mark.parametrize( 21 | ("param1", "param2"), -22 | ( - | _____^ +22 | / ( 23 | | [1, 2], 24 | | [3, 4], 25 | | ), @@ -120,7 +118,7 @@ PT007.py:22:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 27 27 | def test_tuple_of_lists(param1, param2): 28 28 | ... -PT007.py:39:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:39:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 37 | ("param1", "param2"), 38 | [ @@ -141,7 +139,7 @@ PT007.py:39:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 41 41 | ], 42 42 | ) -PT007.py:40:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:40:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 38 | [ 39 | (1, 2), @@ -162,7 +160,7 @@ PT007.py:40:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 42 42 | ) 43 43 | def test_list_of_tuples(param1, param2): -PT007.py:81:38: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:81:38: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -182,7 +180,7 @@ PT007.py:81:38: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 83 83 | @pytest.mark.parametrize( 84 84 | "d", -PT007.py:81:39: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:81:39: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -202,7 +200,7 @@ PT007.py:81:39: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 83 83 | @pytest.mark.parametrize( 84 84 | "d", -PT007.py:81:47: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `list` +PT007.py:81:47: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_tuples.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_tuples.snap index 2ee341b846203..c3bb7dde901b2 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_tuples.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_list_of_tuples.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT007.py:4:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:4:35: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 4 | @pytest.mark.parametrize("param", (1, 2)) | ^^^^^^ PT007 @@ -20,12 +20,11 @@ PT007.py:4:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 6 6 | ... 7 7 | -PT007.py:11:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:11:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 9 | @pytest.mark.parametrize( 10 | ("param1", "param2"), -11 | ( - | _____^ +11 | / ( 12 | | (1, 2), 13 | | (3, 4), 14 | | ), @@ -49,12 +48,11 @@ PT007.py:11:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 16 16 | def test_tuple_of_tuples(param1, param2): 17 17 | ... -PT007.py:22:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:22:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 20 | @pytest.mark.parametrize( 21 | ("param1", "param2"), -22 | ( - | _____^ +22 | / ( 23 | | [1, 2], 24 | | [3, 4], 25 | | ), @@ -78,7 +76,7 @@ PT007.py:22:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 27 27 | def test_tuple_of_lists(param1, param2): 28 28 | ... -PT007.py:23:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:23:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 21 | ("param1", "param2"), 22 | ( @@ -99,7 +97,7 @@ PT007.py:23:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 25 25 | ), 26 26 | ) -PT007.py:24:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:24:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 22 | ( 23 | [1, 2], @@ -120,7 +118,7 @@ PT007.py:24:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 26 26 | ) 27 27 | def test_tuple_of_lists(param1, param2): -PT007.py:50:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:50:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 48 | ("param1", "param2"), 49 | [ @@ -141,7 +139,7 @@ PT007.py:50:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 52 52 | ], 53 53 | ) -PT007.py:51:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:51:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 49 | [ 50 | [1, 2], @@ -162,7 +160,7 @@ PT007.py:51:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 53 53 | ) 54 54 | def test_list_of_lists(param1, param2): -PT007.py:61:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:61:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 59 | "param1,param2", 60 | [ @@ -183,7 +181,7 @@ PT007.py:61:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 63 63 | ], 64 64 | ) -PT007.py:62:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:62:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 60 | [ 61 | [1, 2], @@ -204,7 +202,7 @@ PT007.py:62:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 64 64 | ) 65 65 | def test_csv_name_list_of_lists(param1, param2): -PT007.py:81:38: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple` +PT007.py:81:38: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `list` of `tuple` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_lists.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_lists.snap index 93a0b2954c463..48e4d90b11a78 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_lists.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_lists.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT007.py:12:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:12:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 10 | ("param1", "param2"), 11 | ( @@ -22,7 +22,7 @@ PT007.py:12:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 14 14 | ), 15 15 | ) -PT007.py:13:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:13:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 11 | ( 12 | (1, 2), @@ -43,7 +43,7 @@ PT007.py:13:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 15 15 | ) 16 16 | def test_tuple_of_tuples(param1, param2): -PT007.py:31:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:31:35: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 31 | @pytest.mark.parametrize("param", [1, 2]) | ^^^^^^ PT007 @@ -62,12 +62,11 @@ PT007.py:31:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 33 33 | ... 34 34 | -PT007.py:38:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:38:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 36 | @pytest.mark.parametrize( 37 | ("param1", "param2"), -38 | [ - | _____^ +38 | / [ 39 | | (1, 2), 40 | | (3, 4), 41 | | ], @@ -91,7 +90,7 @@ PT007.py:38:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 43 43 | def test_list_of_tuples(param1, param2): 44 44 | ... -PT007.py:39:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:39:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 37 | ("param1", "param2"), 38 | [ @@ -112,7 +111,7 @@ PT007.py:39:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 41 41 | ], 42 42 | ) -PT007.py:40:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:40:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 38 | [ 39 | (1, 2), @@ -133,12 +132,11 @@ PT007.py:40:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 42 42 | ) 43 43 | def test_list_of_tuples(param1, param2): -PT007.py:49:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:49:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 47 | @pytest.mark.parametrize( 48 | ("param1", "param2"), -49 | [ - | _____^ +49 | / [ 50 | | [1, 2], 51 | | [3, 4], 52 | | ], @@ -162,12 +160,11 @@ PT007.py:49:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 54 54 | def test_list_of_lists(param1, param2): 55 55 | ... -PT007.py:60:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:60:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 58 | @pytest.mark.parametrize( 59 | "param1,param2", -60 | [ - | _____^ +60 | / [ 61 | | [1, 2], 62 | | [3, 4], 63 | | ], @@ -191,12 +188,11 @@ PT007.py:60:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 65 65 | def test_csv_name_list_of_lists(param1, param2): 66 66 | ... -PT007.py:71:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:71:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 69 | @pytest.mark.parametrize( 70 | "param", -71 | [ - | _____^ +71 | / [ 72 | | [1, 2], 73 | | [3, 4], 74 | | ], @@ -220,7 +216,7 @@ PT007.py:71:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 76 76 | def test_single_list_of_lists(param): 77 77 | ... -PT007.py:80:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:80:31: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) | ^^^^^^ PT007 @@ -239,7 +235,7 @@ PT007.py:80:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 82 82 | @pytest.mark.parametrize("d", [3,]) 83 83 | @pytest.mark.parametrize( -PT007.py:81:39: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:81:39: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -259,7 +255,7 @@ PT007.py:81:39: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 83 83 | @pytest.mark.parametrize( 84 84 | "d", -PT007.py:81:47: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:81:47: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -279,7 +275,7 @@ PT007.py:81:47: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 83 83 | @pytest.mark.parametrize( 84 84 | "d", -PT007.py:82:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:82:31: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -300,7 +296,7 @@ PT007.py:82:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 84 84 | "d", 85 85 | [("3", "4")], -PT007.py:85:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:85:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 83 | @pytest.mark.parametrize( 84 | "d", @@ -321,7 +317,7 @@ PT007.py:85:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 87 87 | @pytest.mark.parametrize( 88 88 | "e", -PT007.py:89:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `list` +PT007.py:89:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `list` | 87 | @pytest.mark.parametrize( 88 | "e", diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_tuples.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_tuples.snap index 3d90a13b2eb9c..822c8869ec4ac 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_tuples.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT007_tuple_of_tuples.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT007.py:23:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:23:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 21 | ("param1", "param2"), 22 | ( @@ -22,7 +22,7 @@ PT007.py:23:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 25 25 | ), 26 26 | ) -PT007.py:24:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:24:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 22 | ( 23 | [1, 2], @@ -43,7 +43,7 @@ PT007.py:24:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 26 26 | ) 27 27 | def test_tuple_of_lists(param1, param2): -PT007.py:31:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:31:35: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 31 | @pytest.mark.parametrize("param", [1, 2]) | ^^^^^^ PT007 @@ -62,12 +62,11 @@ PT007.py:31:35: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 33 33 | ... 34 34 | -PT007.py:38:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:38:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 36 | @pytest.mark.parametrize( 37 | ("param1", "param2"), -38 | [ - | _____^ +38 | / [ 39 | | (1, 2), 40 | | (3, 4), 41 | | ], @@ -91,12 +90,11 @@ PT007.py:38:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 43 43 | def test_list_of_tuples(param1, param2): 44 44 | ... -PT007.py:49:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:49:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 47 | @pytest.mark.parametrize( 48 | ("param1", "param2"), -49 | [ - | _____^ +49 | / [ 50 | | [1, 2], 51 | | [3, 4], 52 | | ], @@ -120,7 +118,7 @@ PT007.py:49:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 54 54 | def test_list_of_lists(param1, param2): 55 55 | ... -PT007.py:50:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:50:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 48 | ("param1", "param2"), 49 | [ @@ -141,7 +139,7 @@ PT007.py:50:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 52 52 | ], 53 53 | ) -PT007.py:51:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:51:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 49 | [ 50 | [1, 2], @@ -162,12 +160,11 @@ PT007.py:51:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 53 53 | ) 54 54 | def test_list_of_lists(param1, param2): -PT007.py:60:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:60:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 58 | @pytest.mark.parametrize( 59 | "param1,param2", -60 | [ - | _____^ +60 | / [ 61 | | [1, 2], 62 | | [3, 4], 63 | | ], @@ -191,7 +188,7 @@ PT007.py:60:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 65 65 | def test_csv_name_list_of_lists(param1, param2): 66 66 | ... -PT007.py:61:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:61:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 59 | "param1,param2", 60 | [ @@ -212,7 +209,7 @@ PT007.py:61:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 63 63 | ], 64 64 | ) -PT007.py:62:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:62:9: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 60 | [ 61 | [1, 2], @@ -233,12 +230,11 @@ PT007.py:62:9: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 64 64 | ) 65 65 | def test_csv_name_list_of_lists(param1, param2): -PT007.py:71:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:71:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 69 | @pytest.mark.parametrize( 70 | "param", -71 | [ - | _____^ +71 | / [ 72 | | [1, 2], 73 | | [3, 4], 74 | | ], @@ -262,7 +258,7 @@ PT007.py:71:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 76 76 | def test_single_list_of_lists(param): 77 77 | ... -PT007.py:80:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:80:31: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 80 | @pytest.mark.parametrize("a", [1, 2]) | ^^^^^^ PT007 @@ -281,7 +277,7 @@ PT007.py:80:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 82 82 | @pytest.mark.parametrize("d", [3,]) 83 83 | @pytest.mark.parametrize( -PT007.py:82:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:82:31: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 80 | @pytest.mark.parametrize("a", [1, 2]) 81 | @pytest.mark.parametrize(("b", "c"), ((3, 4), (5, 6))) @@ -302,7 +298,7 @@ PT007.py:82:31: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expect 84 84 | "d", 85 85 | [("3", "4")], -PT007.py:85:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:85:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 83 | @pytest.mark.parametrize( 84 | "d", @@ -323,7 +319,7 @@ PT007.py:85:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expecte 87 87 | @pytest.mark.parametrize( 88 88 | "e", -PT007.py:89:5: PT007 [*] Wrong values type in `@pytest.mark.parametrize` expected `tuple` of `tuple` +PT007.py:89:5: PT007 [*] Wrong values type in `pytest.mark.parametrize` expected `tuple` of `tuple` | 87 | @pytest.mark.parametrize( 88 | "e", diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT008.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT008.snap index 9a09810de5527..7d366bf5c4896 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT008.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT008.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs PT008.py:35:1: PT008 Use `return_value=` instead of patching with `lambda` | 33 | # Error -34 | +34 | 35 | mocker.patch("module.name", lambda: None) | ^^^^^^^^^^^^ PT008 36 | module_mocker.patch("module.name", lambda: None) @@ -35,14 +35,14 @@ PT008.py:38:1: PT008 Use `return_value=` instead of patching with `lambda` 37 | mocker.patch.object(obj, "attr", lambda: None) 38 | module_mocker.patch.object(obj, "attr", lambda: None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PT008 -39 | +39 | 40 | mocker.patch("module.name", lambda x, y: None) | PT008.py:40:1: PT008 Use `return_value=` instead of patching with `lambda` | 38 | module_mocker.patch.object(obj, "attr", lambda: None) -39 | +39 | 40 | mocker.patch("module.name", lambda x, y: None) | ^^^^^^^^^^^^ PT008 41 | module_mocker.patch("module.name", lambda x, y: None) @@ -73,14 +73,14 @@ PT008.py:43:1: PT008 Use `return_value=` instead of patching with `lambda` 42 | mocker.patch.object(obj, "attr", lambda x, y: None) 43 | module_mocker.patch.object(obj, "attr", lambda x, y: None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PT008 -44 | +44 | 45 | mocker.patch("module.name", lambda *args, **kwargs: None) | PT008.py:45:1: PT008 Use `return_value=` instead of patching with `lambda` | 43 | module_mocker.patch.object(obj, "attr", lambda x, y: None) -44 | +44 | 45 | mocker.patch("module.name", lambda *args, **kwargs: None) | ^^^^^^^^^^^^ PT008 46 | module_mocker.patch("module.name", lambda *args, **kwargs: None) @@ -112,5 +112,3 @@ PT008.py:48:1: PT008 Use `return_value=` instead of patching with `lambda` 48 | module_mocker.patch.object(obj, "attr", lambda *args, **kwargs: None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PT008 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT009.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT009.snap index 572c08916f966..f77df5ab5cc0b 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT009.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT009.snap @@ -178,7 +178,7 @@ PT009.py:25:16: PT009 Use a regular `assert` instead of unittest-style `assertEq 24 | ) 25 | return self.assertEqual(True, False) # Error, unfixable | ^^^^^^^^^^^^^^^^ PT009 -26 | +26 | 27 | def test_assert_false(self): | = help: Replace `assertEqual(...)` with `assert ...` @@ -188,7 +188,7 @@ PT009.py:28:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 27 | def test_assert_false(self): 28 | self.assertFalse(True) # Error | ^^^^^^^^^^^^^^^^ PT009 -29 | +29 | 30 | def test_assert_equal(self): | = help: Replace `assertFalse(...)` with `assert ...` @@ -208,7 +208,7 @@ PT009.py:31:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 30 | def test_assert_equal(self): 31 | self.assertEqual(1, 2) # Error | ^^^^^^^^^^^^^^^^ PT009 -32 | +32 | 33 | def test_assert_not_equal(self): | = help: Replace `assertEqual(...)` with `assert ...` @@ -228,7 +228,7 @@ PT009.py:34:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 33 | def test_assert_not_equal(self): 34 | self.assertNotEqual(1, 1) # Error | ^^^^^^^^^^^^^^^^^^^ PT009 -35 | +35 | 36 | def test_assert_greater(self): | = help: Replace `assertNotEqual(...)` with `assert ...` @@ -248,7 +248,7 @@ PT009.py:37:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 36 | def test_assert_greater(self): 37 | self.assertGreater(1, 2) # Error | ^^^^^^^^^^^^^^^^^^ PT009 -38 | +38 | 39 | def test_assert_greater_equal(self): | = help: Replace `assertGreater(...)` with `assert ...` @@ -268,7 +268,7 @@ PT009.py:40:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 39 | def test_assert_greater_equal(self): 40 | self.assertGreaterEqual(1, 2) # Error | ^^^^^^^^^^^^^^^^^^^^^^^ PT009 -41 | +41 | 42 | def test_assert_less(self): | = help: Replace `assertGreaterEqual(...)` with `assert ...` @@ -288,7 +288,7 @@ PT009.py:43:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 42 | def test_assert_less(self): 43 | self.assertLess(2, 1) # Error | ^^^^^^^^^^^^^^^ PT009 -44 | +44 | 45 | def test_assert_less_equal(self): | = help: Replace `assertLess(...)` with `assert ...` @@ -308,7 +308,7 @@ PT009.py:46:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 45 | def test_assert_less_equal(self): 46 | self.assertLessEqual(1, 2) # Error | ^^^^^^^^^^^^^^^^^^^^ PT009 -47 | +47 | 48 | def test_assert_in(self): | = help: Replace `assertLessEqual(...)` with `assert ...` @@ -328,7 +328,7 @@ PT009.py:49:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 48 | def test_assert_in(self): 49 | self.assertIn(1, [2, 3]) # Error | ^^^^^^^^^^^^^ PT009 -50 | +50 | 51 | def test_assert_not_in(self): | = help: Replace `assertIn(...)` with `assert ...` @@ -348,7 +348,7 @@ PT009.py:52:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 51 | def test_assert_not_in(self): 52 | self.assertNotIn(2, [2, 3]) # Error | ^^^^^^^^^^^^^^^^ PT009 -53 | +53 | 54 | def test_assert_is_none(self): | = help: Replace `assertNotIn(...)` with `assert ...` @@ -368,7 +368,7 @@ PT009.py:55:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 54 | def test_assert_is_none(self): 55 | self.assertIsNone(0) # Error | ^^^^^^^^^^^^^^^^^ PT009 -56 | +56 | 57 | def test_assert_is_not_none(self): | = help: Replace `assertIsNone(...)` with `assert ...` @@ -388,7 +388,7 @@ PT009.py:58:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 57 | def test_assert_is_not_none(self): 58 | self.assertIsNotNone(0) # Error | ^^^^^^^^^^^^^^^^^^^^ PT009 -59 | +59 | 60 | def test_assert_is(self): | = help: Replace `assertIsNotNone(...)` with `assert ...` @@ -408,7 +408,7 @@ PT009.py:61:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 60 | def test_assert_is(self): 61 | self.assertIs([], []) # Error | ^^^^^^^^^^^^^ PT009 -62 | +62 | 63 | def test_assert_is_not(self): | = help: Replace `assertIs(...)` with `assert ...` @@ -428,7 +428,7 @@ PT009.py:64:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 63 | def test_assert_is_not(self): 64 | self.assertIsNot(1, 1) # Error | ^^^^^^^^^^^^^^^^ PT009 -65 | +65 | 66 | def test_assert_is_instance(self): | = help: Replace `assertIsNot(...)` with `assert ...` @@ -448,7 +448,7 @@ PT009.py:67:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 66 | def test_assert_is_instance(self): 67 | self.assertIsInstance(1, str) # Error | ^^^^^^^^^^^^^^^^^^^^^ PT009 -68 | +68 | 69 | def test_assert_is_not_instance(self): | = help: Replace `assertIsInstance(...)` with `assert ...` @@ -468,7 +468,7 @@ PT009.py:70:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 69 | def test_assert_is_not_instance(self): 70 | self.assertNotIsInstance(1, int) # Error | ^^^^^^^^^^^^^^^^^^^^^^^^ PT009 -71 | +71 | 72 | def test_assert_regex(self): | = help: Replace `assertNotIsInstance(...)` with `assert ...` @@ -488,7 +488,7 @@ PT009.py:73:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 72 | def test_assert_regex(self): 73 | self.assertRegex("abc", r"def") # Error | ^^^^^^^^^^^^^^^^ PT009 -74 | +74 | 75 | def test_assert_not_regex(self): | = help: Replace `assertRegex(...)` with `assert ...` @@ -498,7 +498,7 @@ PT009.py:73:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 71 71 | 72 72 | def test_assert_regex(self): 73 |- self.assertRegex("abc", r"def") # Error - 73 |+ assert re.search("def", "abc") # Error + 73 |+ assert re.search(r"def", "abc") # Error 74 74 | 75 75 | def test_assert_not_regex(self): 76 76 | self.assertNotRegex("abc", r"abc") # Error @@ -508,7 +508,7 @@ PT009.py:76:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 75 | def test_assert_not_regex(self): 76 | self.assertNotRegex("abc", r"abc") # Error | ^^^^^^^^^^^^^^^^^^^ PT009 -77 | +77 | 78 | def test_assert_regexp_matches(self): | = help: Replace `assertNotRegex(...)` with `assert ...` @@ -518,7 +518,7 @@ PT009.py:76:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 74 74 | 75 75 | def test_assert_not_regex(self): 76 |- self.assertNotRegex("abc", r"abc") # Error - 76 |+ assert not re.search("abc", "abc") # Error + 76 |+ assert not re.search(r"abc", "abc") # Error 77 77 | 78 78 | def test_assert_regexp_matches(self): 79 79 | self.assertRegexpMatches("abc", r"def") # Error @@ -528,7 +528,7 @@ PT009.py:79:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 78 | def test_assert_regexp_matches(self): 79 | self.assertRegexpMatches("abc", r"def") # Error | ^^^^^^^^^^^^^^^^^^^^^^^^ PT009 -80 | +80 | 81 | def test_assert_not_regexp_matches(self): | = help: Replace `assertRegexpMatches(...)` with `assert ...` @@ -538,7 +538,7 @@ PT009.py:79:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 77 77 | 78 78 | def test_assert_regexp_matches(self): 79 |- self.assertRegexpMatches("abc", r"def") # Error - 79 |+ assert re.search("def", "abc") # Error + 79 |+ assert re.search(r"def", "abc") # Error 80 80 | 81 81 | def test_assert_not_regexp_matches(self): 82 82 | self.assertNotRegex("abc", r"abc") # Error @@ -548,7 +548,7 @@ PT009.py:82:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 81 | def test_assert_not_regexp_matches(self): 82 | self.assertNotRegex("abc", r"abc") # Error | ^^^^^^^^^^^^^^^^^^^ PT009 -83 | +83 | 84 | def test_fail_if(self): | = help: Replace `assertNotRegex(...)` with `assert ...` @@ -558,7 +558,7 @@ PT009.py:82:9: PT009 [*] Use a regular `assert` instead of unittest-style `asser 80 80 | 81 81 | def test_assert_not_regexp_matches(self): 82 |- self.assertNotRegex("abc", r"abc") # Error - 82 |+ assert not re.search("abc", "abc") # Error + 82 |+ assert not re.search(r"abc", "abc") # Error 83 83 | 84 84 | def test_fail_if(self): 85 85 | self.failIf("abc") # Error @@ -568,7 +568,7 @@ PT009.py:85:9: PT009 [*] Use a regular `assert` instead of unittest-style `failI 84 | def test_fail_if(self): 85 | self.failIf("abc") # Error | ^^^^^^^^^^^ PT009 -86 | +86 | 87 | def test_fail_unless(self): | = help: Replace `failIf(...)` with `assert ...` @@ -588,7 +588,7 @@ PT009.py:88:9: PT009 [*] Use a regular `assert` instead of unittest-style `failU 87 | def test_fail_unless(self): 88 | self.failUnless("abc") # Error | ^^^^^^^^^^^^^^^ PT009 -89 | +89 | 90 | def test_fail_unless_equal(self): | = help: Replace `failUnless(...)` with `assert ...` @@ -608,7 +608,7 @@ PT009.py:91:9: PT009 [*] Use a regular `assert` instead of unittest-style `failU 90 | def test_fail_unless_equal(self): 91 | self.failUnlessEqual(1, 2) # Error | ^^^^^^^^^^^^^^^^^^^^ PT009 -92 | +92 | 93 | def test_fail_if_equal(self): | = help: Replace `failUnlessEqual(...)` with `assert ...` @@ -659,5 +659,3 @@ PT009.py:98:2: PT009 [*] Use a regular `assert` instead of unittest-style `asser 99 |- "piAx_piAy_beta[r][x][y] = {17}".format( 100 |- self.model.piAx_piAy_beta[r][x][y]))) 98 |+assert "piAx_piAy_beta[r][x][y] = {17}".format(self.model.piAx_piAy_beta[r][x][y]) - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT010.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT010.snap index b4a70fd896fd0..14e9e2e2a86c0 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT010.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT010.snap @@ -1,12 +1,11 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- -PT010.py:5:10: PT010 set the expected exception in `pytest.raises()` +PT010.py:5:10: PT010 Set the expected exception in `pytest.raises()` | 4 | def test_ok(): 5 | with pytest.raises(): | ^^^^^^^^^^^^^ PT010 6 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_default.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_default.snap index 3f83b28f699f9..7a4757d7ebeb3 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_default.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_default.snap @@ -1,47 +1,54 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT011.py:18:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:25:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -17 | def test_error_no_argument_given(): -18 | with pytest.raises(ValueError): +24 | def test_error_no_argument_given(): +25 | with pytest.raises(ValueError): | ^^^^^^^^^^ PT011 -19 | raise ValueError("Can't divide 1 by 0") +26 | raise ValueError("Can't divide 1 by 0") | -PT011.py:21:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:28:43: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -19 | raise ValueError("Can't divide 1 by 0") -20 | -21 | with pytest.raises(socket.error): +26 | raise ValueError("Can't divide 1 by 0") +27 | +28 | with pytest.raises(expected_exception=ValueError): + | ^^^^^^^^^^ PT011 +29 | raise ValueError("Can't divide 1 by 0") + | + +PT011.py:31:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception + | +29 | raise ValueError("Can't divide 1 by 0") +30 | +31 | with pytest.raises(socket.error): | ^^^^^^^^^^^^ PT011 -22 | raise ValueError("Can't divide 1 by 0") +32 | raise ValueError("Can't divide 1 by 0") | -PT011.py:32:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:42:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -31 | def test_error_match_is_empty(): -32 | with pytest.raises(ValueError, match=None): +41 | def test_error_match_is_empty(): +42 | with pytest.raises(ValueError, match=None): | ^^^^^^^^^^ PT011 -33 | raise ValueError("Can't divide 1 by 0") +43 | raise ValueError("Can't divide 1 by 0") | -PT011.py:35:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:45:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -33 | raise ValueError("Can't divide 1 by 0") -34 | -35 | with pytest.raises(ValueError, match=""): +43 | raise ValueError("Can't divide 1 by 0") +44 | +45 | with pytest.raises(ValueError, match=""): | ^^^^^^^^^^ PT011 -36 | raise ValueError("Can't divide 1 by 0") +46 | raise ValueError("Can't divide 1 by 0") | -PT011.py:38:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:48:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -36 | raise ValueError("Can't divide 1 by 0") -37 | -38 | with pytest.raises(ValueError, match=f""): +46 | raise ValueError("Can't divide 1 by 0") +47 | +48 | with pytest.raises(ValueError, match=f""): | ^^^^^^^^^^ PT011 -39 | raise ValueError("Can't divide 1 by 0") +49 | raise ValueError("Can't divide 1 by 0") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_extend_broad_exceptions.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_extend_broad_exceptions.snap index 9c0e5b1466d52..9e8020a9d7def 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_extend_broad_exceptions.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_extend_broad_exceptions.snap @@ -9,47 +9,54 @@ PT011.py:13:24: PT011 `pytest.raises(ZeroDivisionError)` is too broad, set the ` 14 | raise ZeroDivisionError("Can't divide by 0") | -PT011.py:18:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:25:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -17 | def test_error_no_argument_given(): -18 | with pytest.raises(ValueError): +24 | def test_error_no_argument_given(): +25 | with pytest.raises(ValueError): | ^^^^^^^^^^ PT011 -19 | raise ValueError("Can't divide 1 by 0") +26 | raise ValueError("Can't divide 1 by 0") | -PT011.py:21:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:28:43: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -19 | raise ValueError("Can't divide 1 by 0") -20 | -21 | with pytest.raises(socket.error): +26 | raise ValueError("Can't divide 1 by 0") +27 | +28 | with pytest.raises(expected_exception=ValueError): + | ^^^^^^^^^^ PT011 +29 | raise ValueError("Can't divide 1 by 0") + | + +PT011.py:31:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception + | +29 | raise ValueError("Can't divide 1 by 0") +30 | +31 | with pytest.raises(socket.error): | ^^^^^^^^^^^^ PT011 -22 | raise ValueError("Can't divide 1 by 0") +32 | raise ValueError("Can't divide 1 by 0") | -PT011.py:32:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:42:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -31 | def test_error_match_is_empty(): -32 | with pytest.raises(ValueError, match=None): +41 | def test_error_match_is_empty(): +42 | with pytest.raises(ValueError, match=None): | ^^^^^^^^^^ PT011 -33 | raise ValueError("Can't divide 1 by 0") +43 | raise ValueError("Can't divide 1 by 0") | -PT011.py:35:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:45:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -33 | raise ValueError("Can't divide 1 by 0") -34 | -35 | with pytest.raises(ValueError, match=""): +43 | raise ValueError("Can't divide 1 by 0") +44 | +45 | with pytest.raises(ValueError, match=""): | ^^^^^^^^^^ PT011 -36 | raise ValueError("Can't divide 1 by 0") +46 | raise ValueError("Can't divide 1 by 0") | -PT011.py:38:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:48:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -36 | raise ValueError("Can't divide 1 by 0") -37 | -38 | with pytest.raises(ValueError, match=f""): +46 | raise ValueError("Can't divide 1 by 0") +47 | +48 | with pytest.raises(ValueError, match=f""): | ^^^^^^^^^^ PT011 -39 | raise ValueError("Can't divide 1 by 0") +49 | raise ValueError("Can't divide 1 by 0") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_all.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_all.snap index 92dffb921ca33..d7d61cfe5117c 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_all.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_all.snap @@ -9,65 +9,72 @@ PT011.py:13:24: PT011 `pytest.raises(ZeroDivisionError)` is too broad, set the ` 14 | raise ZeroDivisionError("Can't divide by 0") | -PT011.py:18:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:25:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -17 | def test_error_no_argument_given(): -18 | with pytest.raises(ValueError): +24 | def test_error_no_argument_given(): +25 | with pytest.raises(ValueError): | ^^^^^^^^^^ PT011 -19 | raise ValueError("Can't divide 1 by 0") +26 | raise ValueError("Can't divide 1 by 0") | -PT011.py:21:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:28:43: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -19 | raise ValueError("Can't divide 1 by 0") -20 | -21 | with pytest.raises(socket.error): +26 | raise ValueError("Can't divide 1 by 0") +27 | +28 | with pytest.raises(expected_exception=ValueError): + | ^^^^^^^^^^ PT011 +29 | raise ValueError("Can't divide 1 by 0") + | + +PT011.py:31:24: PT011 `pytest.raises(socket.error)` is too broad, set the `match` parameter or use a more specific exception + | +29 | raise ValueError("Can't divide 1 by 0") +30 | +31 | with pytest.raises(socket.error): | ^^^^^^^^^^^^ PT011 -22 | raise ValueError("Can't divide 1 by 0") +32 | raise ValueError("Can't divide 1 by 0") | -PT011.py:24:24: PT011 `pytest.raises(pickle.PicklingError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:34:24: PT011 `pytest.raises(pickle.PicklingError)` is too broad, set the `match` parameter or use a more specific exception | -22 | raise ValueError("Can't divide 1 by 0") -23 | -24 | with pytest.raises(PicklingError): +32 | raise ValueError("Can't divide 1 by 0") +33 | +34 | with pytest.raises(PicklingError): | ^^^^^^^^^^^^^ PT011 -25 | raise PicklingError("Can't pickle") +35 | raise PicklingError("Can't pickle") | -PT011.py:27:24: PT011 `pytest.raises(pickle.UnpicklingError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:37:24: PT011 `pytest.raises(pickle.UnpicklingError)` is too broad, set the `match` parameter or use a more specific exception | -25 | raise PicklingError("Can't pickle") -26 | -27 | with pytest.raises(UnpicklingError): +35 | raise PicklingError("Can't pickle") +36 | +37 | with pytest.raises(UnpicklingError): | ^^^^^^^^^^^^^^^ PT011 -28 | raise UnpicklingError("Can't unpickle") +38 | raise UnpicklingError("Can't unpickle") | -PT011.py:32:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:42:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -31 | def test_error_match_is_empty(): -32 | with pytest.raises(ValueError, match=None): +41 | def test_error_match_is_empty(): +42 | with pytest.raises(ValueError, match=None): | ^^^^^^^^^^ PT011 -33 | raise ValueError("Can't divide 1 by 0") +43 | raise ValueError("Can't divide 1 by 0") | -PT011.py:35:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:45:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -33 | raise ValueError("Can't divide 1 by 0") -34 | -35 | with pytest.raises(ValueError, match=""): +43 | raise ValueError("Can't divide 1 by 0") +44 | +45 | with pytest.raises(ValueError, match=""): | ^^^^^^^^^^ PT011 -36 | raise ValueError("Can't divide 1 by 0") +46 | raise ValueError("Can't divide 1 by 0") | -PT011.py:38:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:48:24: PT011 `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception | -36 | raise ValueError("Can't divide 1 by 0") -37 | -38 | with pytest.raises(ValueError, match=f""): +46 | raise ValueError("Can't divide 1 by 0") +47 | +48 | with pytest.raises(ValueError, match=f""): | ^^^^^^^^^^ PT011 -39 | raise ValueError("Can't divide 1 by 0") +49 | raise ValueError("Can't divide 1 by 0") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_prefix.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_prefix.snap index bdc704d4e9e3d..21162e38df968 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_prefix.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_glob_prefix.snap @@ -1,22 +1,20 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs --- -PT011.py:24:24: PT011 `pytest.raises(pickle.PicklingError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:34:24: PT011 `pytest.raises(pickle.PicklingError)` is too broad, set the `match` parameter or use a more specific exception | -22 | raise ValueError("Can't divide 1 by 0") -23 | -24 | with pytest.raises(PicklingError): +32 | raise ValueError("Can't divide 1 by 0") +33 | +34 | with pytest.raises(PicklingError): | ^^^^^^^^^^^^^ PT011 -25 | raise PicklingError("Can't pickle") +35 | raise PicklingError("Can't pickle") | -PT011.py:27:24: PT011 `pytest.raises(pickle.UnpicklingError)` is too broad, set the `match` parameter or use a more specific exception +PT011.py:37:24: PT011 `pytest.raises(pickle.UnpicklingError)` is too broad, set the `match` parameter or use a more specific exception | -25 | raise PicklingError("Can't pickle") -26 | -27 | with pytest.raises(UnpicklingError): +35 | raise PicklingError("Can't pickle") +36 | +37 | with pytest.raises(UnpicklingError): | ^^^^^^^^^^^^^^^ PT011 -28 | raise UnpicklingError("Can't unpickle") +38 | raise UnpicklingError("Can't unpickle") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_replace_broad_exceptions.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_replace_broad_exceptions.snap index 9ffc1874a35e2..1fd3e1baddc0c 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_replace_broad_exceptions.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT011_replace_broad_exceptions.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT011.py:13:24: PT011 `pytest.raises(ZeroDivisionError)` is too broad, set the `match` parameter or use a more specific exception | @@ -8,5 +9,3 @@ PT011.py:13:24: PT011 `pytest.raises(ZeroDivisionError)` is too broad, set the ` | ^^^^^^^^^^^^^^^^^ PT011 14 | raise ZeroDivisionError("Can't divide by 0") | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT012.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT012.snap index 3a9d77b806fcf..43cf518d00187 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT012.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT012.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs PT012.py:42:5: PT012 `pytest.raises()` block should contain a single simple statement | 41 | def test_error_multiple_statements(): -42 | with pytest.raises(AttributeError): - | _____^ +42 | / with pytest.raises(AttributeError): 43 | | len([]) 44 | | [].size | |_______________^ PT012 @@ -14,60 +13,55 @@ PT012.py:42:5: PT012 `pytest.raises()` block should contain a single simple stat PT012.py:48:5: PT012 `pytest.raises()` block should contain a single simple statement | 47 | async def test_error_complex_statement(): -48 | with pytest.raises(AttributeError): - | _____^ +48 | / with pytest.raises(AttributeError): 49 | | if True: 50 | | [].size | |___________________^ PT012 -51 | +51 | 52 | with pytest.raises(AttributeError): | PT012.py:52:5: PT012 `pytest.raises()` block should contain a single simple statement | 50 | [].size -51 | -52 | with pytest.raises(AttributeError): - | _____^ +51 | +52 | / with pytest.raises(AttributeError): 53 | | for i in []: 54 | | [].size | |___________________^ PT012 -55 | +55 | 56 | with pytest.raises(AttributeError): | PT012.py:56:5: PT012 `pytest.raises()` block should contain a single simple statement | 54 | [].size -55 | -56 | with pytest.raises(AttributeError): - | _____^ +55 | +56 | / with pytest.raises(AttributeError): 57 | | async for i in []: 58 | | [].size | |___________________^ PT012 -59 | +59 | 60 | with pytest.raises(AttributeError): | PT012.py:60:5: PT012 `pytest.raises()` block should contain a single simple statement | 58 | [].size -59 | -60 | with pytest.raises(AttributeError): - | _____^ +59 | +60 | / with pytest.raises(AttributeError): 61 | | while True: 62 | | [].size | |___________________^ PT012 -63 | +63 | 64 | with pytest.raises(AttributeError): | PT012.py:64:5: PT012 `pytest.raises()` block should contain a single simple statement | 62 | [].size -63 | -64 | with pytest.raises(AttributeError): - | _____^ +63 | +64 | / with pytest.raises(AttributeError): 65 | | async with context_manager_under_test(): 66 | | if True: 67 | | raise Exception @@ -77,8 +71,7 @@ PT012.py:64:5: PT012 `pytest.raises()` block should contain a single simple stat PT012.py:71:5: PT012 `pytest.raises()` block should contain a single simple statement | 70 | def test_error_try(): -71 | with pytest.raises(AttributeError): - | _____^ +71 | / with pytest.raises(AttributeError): 72 | | try: 73 | | [].size 74 | | except: @@ -86,4 +79,48 @@ PT012.py:71:5: PT012 `pytest.raises()` block should contain a single simple stat | |_________________^ PT012 | +PT012.py:83:5: PT012 `pytest.raises()` block should contain a single simple statement + | +81 | ## Errors +82 | +83 | / with pytest.raises(RuntimeError): +84 | | for a in b: +85 | | print() + | |___________________^ PT012 +86 | +87 | with pytest.raises(RuntimeError): + | + +PT012.py:87:5: PT012 `pytest.raises()` block should contain a single simple statement + | +85 | print() +86 | +87 | / with pytest.raises(RuntimeError): +88 | | for a in b: +89 | | assert foo + | |______________________^ PT012 +90 | +91 | with pytest.raises(RuntimeError): + | + +PT012.py:91:5: PT012 `pytest.raises()` block should contain a single simple statement + | +89 | assert foo +90 | +91 | / with pytest.raises(RuntimeError): +92 | | async for a in b: +93 | | print() + | |___________________^ PT012 +94 | +95 | with pytest.raises(RuntimeError): + | +PT012.py:95:5: PT012 `pytest.raises()` block should contain a single simple statement + | +93 | print() +94 | +95 | / with pytest.raises(RuntimeError): +96 | | async for a in b: +97 | | assert foo + | |______________________^ PT012 + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT013.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT013.snap index 0202a8cb8fc8c..b4da53b5275bb 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT013.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT013.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs PT013.py:11:1: PT013 Incorrect import of `pytest`; use `import pytest` instead | 9 | # Error -10 | +10 | 11 | import pytest as other_name | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT013 12 | from pytest import fixture diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT014.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT014.snap index 92240183c3672..96b31adcdbab2 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT014.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT014.snap @@ -1,7 +1,8 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- -PT014.py:4:35: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:4:35: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 4 | @pytest.mark.parametrize("x", [1, 1, 2]) | ^ PT014 @@ -20,7 +21,7 @@ PT014.py:4:35: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.para 6 6 | ... 7 7 | -PT014.py:14:35: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:14:35: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 14 | @pytest.mark.parametrize("x", [a, a, b, b, b, c]) | ^ PT014 @@ -39,7 +40,7 @@ PT014.py:14:35: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.par 16 16 | ... 17 17 | -PT014.py:14:41: PT014 [*] Duplicate of test case at index 2 in `@pytest_mark.parametrize` +PT014.py:14:41: PT014 [*] Duplicate of test case at index 2 in `pytest.mark.parametrize` | 14 | @pytest.mark.parametrize("x", [a, a, b, b, b, c]) | ^ PT014 @@ -58,7 +59,7 @@ PT014.py:14:41: PT014 [*] Duplicate of test case at index 2 in `@pytest_mark.par 16 16 | ... 17 17 | -PT014.py:14:44: PT014 [*] Duplicate of test case at index 2 in `@pytest_mark.parametrize` +PT014.py:14:44: PT014 [*] Duplicate of test case at index 2 in `pytest.mark.parametrize` | 14 | @pytest.mark.parametrize("x", [a, a, b, b, b, c]) | ^ PT014 @@ -77,7 +78,7 @@ PT014.py:14:44: PT014 [*] Duplicate of test case at index 2 in `@pytest_mark.par 16 16 | ... 17 17 | -PT014.py:24:9: PT014 Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:24:9: PT014 Duplicate of test case at index 0 in `pytest.mark.parametrize` | 22 | (a, b), 23 | # comment @@ -88,7 +89,7 @@ PT014.py:24:9: PT014 Duplicate of test case at index 0 in `@pytest_mark.parametr | = help: Remove duplicate test case -PT014.py:32:39: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:32:39: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 32 | @pytest.mark.parametrize("x", [a, b, (a), c, ((a))]) | ^ PT014 @@ -107,7 +108,7 @@ PT014.py:32:39: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.par 34 34 | ... 35 35 | -PT014.py:32:48: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:32:48: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 32 | @pytest.mark.parametrize("x", [a, b, (a), c, ((a))]) | ^ PT014 @@ -126,7 +127,7 @@ PT014.py:32:48: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.par 34 34 | ... 35 35 | -PT014.py:42:10: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:42:10: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 40 | a, 41 | b, @@ -146,7 +147,7 @@ PT014.py:42:10: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.par 44 43 | ((a)), 45 44 | ], -PT014.py:44:11: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:44:11: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 42 | (a), 43 | c, @@ -166,7 +167,7 @@ PT014.py:44:11: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.par 46 45 | ) 47 46 | def test_error_parentheses_trailing_comma(x): -PT014.py:56:53: PT014 [*] Duplicate of test case at index 0 in `@pytest_mark.parametrize` +PT014.py:56:53: PT014 [*] Duplicate of test case at index 0 in `pytest.mark.parametrize` | 56 | @pytest.mark.parametrize('data, spec', [(1.0, 1.0), (1.0, 1.0)]) | ^^^^^^^^^^ PT014 diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT015.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT015.snap index 6bd15c3a121fa..152e292cc65f6 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT015.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT015.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT015.py:9:5: PT015 Assertion always fails, replace with `pytest.fail()` | @@ -166,5 +167,3 @@ PT015.py:25:5: PT015 Assertion always fails, replace with `pytest.fail()` 25 | assert tuple("") | ^^^^^^^^^^^^^^^^ PT015 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT016.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT016.snap index 4586ae4494ec9..ac5c1f3a368e7 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT016.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT016.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT016.py:19:5: PT016 No message passed to `pytest.fail()` | @@ -67,5 +68,3 @@ PT016.py:25:5: PT016 No message passed to `pytest.fail()` 25 | pytest.fail(reason=f"") | ^^^^^^^^^^^ PT016 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT017.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT017.snap index 3bfc17a4b28eb..588a3a8460c97 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT017.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT017.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT017.py:19:9: PT017 Found assertion on exception `e` in `except` block, use `pytest.raises()` instead | @@ -8,5 +9,3 @@ PT017.py:19:9: PT017 Found assertion on exception `e` in `except` block, use `py 19 | assert e.message, "blah blah" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT017 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT018.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT018.snap index cf96ebfbb180e..15ef642752227 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT018.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT018.snap @@ -158,8 +158,7 @@ PT018.py:21:5: PT018 [*] Assertion should be broken down into multiple parts | 19 | assert not (something or something_else) 20 | assert not (something or something_else or something_third) -21 | assert something and something_else == """error - | _____^ +21 | / assert something and something_else == """error 22 | | message 23 | | """ | |_______^ PT018 @@ -183,8 +182,7 @@ PT018.py:24:5: PT018 [*] Assertion should be broken down into multiple parts | 22 | message 23 | """ -24 | assert ( - | _____^ +24 | / assert ( 25 | | something 26 | | and something_else 27 | | == """error @@ -192,7 +190,7 @@ PT018.py:24:5: PT018 [*] Assertion should be broken down into multiple parts 29 | | """ 30 | | ) | |_____^ PT018 -31 | +31 | 32 | # recursive case | = help: Break down assertion into multiple parts @@ -236,7 +234,7 @@ PT018.py:34:5: PT018 [*] Assertion should be broken down into multiple parts 33 | assert not (a or not (b or c)) 34 | assert not (a or not (b and c)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT018 -35 | +35 | 36 | # detected, but no fix for messages | = help: Break down assertion into multiple parts @@ -327,7 +325,7 @@ PT018.py:49:5: PT018 Assertion should be broken down into multiple parts 48 | def test_multiline(): 49 | assert something and something_else; x = 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT018 -50 | +50 | 51 | x = 1; assert something and something_else | = help: Break down assertion into multiple parts @@ -335,10 +333,10 @@ PT018.py:49:5: PT018 Assertion should be broken down into multiple parts PT018.py:51:12: PT018 Assertion should be broken down into multiple parts | 49 | assert something and something_else; x = 1 -50 | +50 | 51 | x = 1; assert something and something_else | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PT018 -52 | +52 | 53 | x = 1; \ | = help: Break down assertion into multiple parts @@ -355,14 +353,13 @@ PT018.py:59:5: PT018 [*] Assertion should be broken down into multiple parts | 57 | # Regression test for: https://github.com/astral-sh/ruff/issues/7143 58 | def test_parenthesized_not(): -59 | assert not ( - | _____^ +59 | / assert not ( 60 | | self.find_graph_output(node.output[0]) 61 | | or self.find_graph_input(node.input[0]) 62 | | or self.find_graph_output(node.input[0]) 63 | | ) | |_____^ PT018 -64 | +64 | 65 | assert (not ( | = help: Break down assertion into multiple parts @@ -383,15 +380,14 @@ PT018.py:59:5: PT018 [*] Assertion should be broken down into multiple parts PT018.py:65:5: PT018 [*] Assertion should be broken down into multiple parts | 63 | ) -64 | -65 | assert (not ( - | _____^ +64 | +65 | / assert (not ( 66 | | self.find_graph_output(node.output[0]) 67 | | or self.find_graph_input(node.input[0]) 68 | | or self.find_graph_output(node.input[0]) 69 | | )) | |______^ PT018 -70 | +70 | 71 | assert (not self.find_graph_output(node.output[0]) or | = help: Break down assertion into multiple parts diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT019.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT019.snap index fefca3d13954c..2c2abc05e472f 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT019.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT019.snap @@ -15,4 +15,18 @@ PT019.py:13:17: PT019 Fixture `_fixture` without value is injected as parameter, 14 | pass | +PT019.py:31:24: PT019 Fixture `_bar` without value is injected as parameter, use `@pytest.mark.usefixtures` instead + | +30 | @pytest.mark.parametrize("_foo", [1, 2, 3]) +31 | def test_thingy2(_foo, _bar): # Error _bar is not defined in parametrize + | ^^^^ PT019 +32 | pass + | +PT019.py:39:24: PT019 Fixture `_bar` without value is injected as parameter, use `@pytest.mark.usefixtures` instead + | +38 | @pytest.mark.parametrize(("_foo"), [1, 2, 3]) +39 | def test_thingy4(_foo, _bar): # Error _bar is not defined in parametrize + | ^^^^ PT019 +40 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT020.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT020.snap index c75c178f95308..40b10db9ef84d 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT020.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT020.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT020.py:14:1: PT020 `@pytest.yield_fixture` is deprecated, use `@pytest.fixture` | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT021.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT021.snap index 2873de7aecb93..b406e3998ebed 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT021.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT021.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT021.py:49:5: PT021 Use `yield` instead of `request.addfinalizer` | @@ -19,5 +20,3 @@ PT021.py:56:5: PT021 Use `yield` instead of `request.addfinalizer` 57 | yield resource 58 | resource # prevent PT022 | - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT022.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT022.snap index 33378e77f0007..bacf1e21701b2 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT022.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT022.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT022.py:17:5: PT022 [*] No teardown in fixture `error`, use `return` instead of `yield` | @@ -60,5 +61,3 @@ PT022.py:43:5: PT022 [*] No teardown in fixture `error`, use `return` instead of 42 42 | resource = acquire_resource() 43 |- yield resource 43 |+ return resource - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_default.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_default.snap index 62aa7f5890622..8240fc440b392 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_default.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_default.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT023.py:46:1: PT023 [*] Use `@pytest.mark.foo` over `@pytest.mark.foo()` | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_parentheses.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_parentheses.snap index 57bf657ad295a..4021157c87f2c 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_parentheses.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT023_parentheses.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT023.py:12:1: PT023 [*] Use `@pytest.mark.foo()` over `@pytest.mark.foo` | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT024.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT024.snap index 29707b0e7335a..b8d8a2f677a98 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT024.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT024.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT024.py:14:1: PT024 [*] `pytest.mark.asyncio` is unnecessary for fixtures | @@ -73,5 +74,3 @@ PT024.py:33:1: PT024 [*] `pytest.mark.asyncio` is unnecessary for fixtures 33 |-@pytest.mark.asyncio 34 33 | async def my_fixture(): # Error after no parens 35 34 | return 0 - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT025.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT025.snap index ba4457e915e08..0463f18a8b273 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT025.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT025.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT025.py:9:1: PT025 [*] `pytest.mark.usefixtures` has no effect on fixtures | @@ -36,5 +37,3 @@ PT025.py:16:1: PT025 [*] `pytest.mark.usefixtures` has no effect on fixtures 16 |-@pytest.mark.usefixtures("a") 17 16 | def my_fixture(): # Error after 18 17 | return 0 - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT026.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT026.snap index 8fb8c8d7fe6c1..27461361c877b 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT026.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT026.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text --- PT026.py:19:1: PT026 [*] Useless `pytest.mark.usefixtures` without parameters | @@ -37,5 +38,3 @@ PT026.py:24:1: PT026 [*] Useless `pytest.mark.usefixtures` without parameters 24 |+ 25 25 | def test_error_no_parens(): 26 26 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_0.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_0.snap index 555cfdd5c772b..33e15bb5b08e1 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_0.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_0.snap @@ -53,7 +53,7 @@ PT027_0.py:8:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assert PT027_0.py:11:14: PT027 [*] Use `pytest.raises` instead of unittest-style `failUnlessRaises` | 9 | raise ValueError -10 | +10 | 11 | with self.failUnlessRaises(ValueError): | ^^^^^^^^^^^^^^^^^^^^^ PT027 12 | raise ValueError @@ -79,7 +79,7 @@ PT027_0.py:11:14: PT027 [*] Use `pytest.raises` instead of unittest-style `failU PT027_0.py:14:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaisesRegex` | 12 | raise ValueError -13 | +13 | 14 | with self.assertRaisesRegex(ValueError, "test"): | ^^^^^^^^^^^^^^^^^^^^^^ PT027 15 | raise ValueError("test") @@ -105,7 +105,7 @@ PT027_0.py:14:14: PT027 [*] Use `pytest.raises` instead of unittest-style `asser PT027_0.py:17:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaisesRegex` | 15 | raise ValueError("test") -16 | +16 | 17 | with self.assertRaisesRegex(ValueError, expected_regex="test"): | ^^^^^^^^^^^^^^^^^^^^^^ PT027 18 | raise ValueError("test") @@ -131,7 +131,7 @@ PT027_0.py:17:14: PT027 [*] Use `pytest.raises` instead of unittest-style `asser PT027_0.py:20:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaisesRegex` | 18 | raise ValueError("test") -19 | +19 | 20 | with self.assertRaisesRegex( | ^^^^^^^^^^^^^^^^^^^^^^ PT027 21 | expected_exception=ValueError, expected_regex="test" @@ -160,7 +160,7 @@ PT027_0.py:20:14: PT027 [*] Use `pytest.raises` instead of unittest-style `asser PT027_0.py:25:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaisesRegex` | 23 | raise ValueError("test") -24 | +24 | 25 | with self.assertRaisesRegex( | ^^^^^^^^^^^^^^^^^^^^^^ PT027 26 | expected_regex="test", expected_exception=ValueError @@ -189,7 +189,7 @@ PT027_0.py:25:14: PT027 [*] Use `pytest.raises` instead of unittest-style `asser PT027_0.py:30:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaisesRegexp` | 28 | raise ValueError("test") -29 | +29 | 30 | with self.assertRaisesRegexp(ValueError, "test"): | ^^^^^^^^^^^^^^^^^^^^^^^ PT027 31 | raise ValueError("test") @@ -224,7 +224,7 @@ PT027_0.py:34:14: PT027 Use `pytest.raises` instead of unittest-style `assertRai PT027_0.py:37:14: PT027 Use `pytest.raises` instead of unittest-style `assertRaises` | 35 | raise ValueError -36 | +36 | 37 | with self.assertRaises( | ^^^^^^^^^^^^^^^^^ PT027 38 | # comment @@ -235,8 +235,7 @@ PT027_0.py:37:14: PT027 Use `pytest.raises` instead of unittest-style `assertRai PT027_0.py:44:13: PT027 Use `pytest.raises` instead of unittest-style `assertRaises` | 43 | with ( -44 | self - | _____________^ +44 | / self 45 | | # comment 46 | | .assertRaises(ValueError) | |_________________________^ PT027 @@ -244,5 +243,3 @@ PT027_0.py:44:13: PT027 Use `pytest.raises` instead of unittest-style `assertRai 48 | raise ValueError | = help: Replace `assertRaises` with `pytest.raises` - - diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_1.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_1.snap index cc642fb5d8aa7..3b79a1afa313e 100644 --- a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_1.snap +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT027_1.snap @@ -17,5 +17,129 @@ PT027_1.py:11:14: PT027 [*] Use `pytest.raises` instead of unittest-style `asser 11 |- with self.assertRaises(ValueError): 11 |+ with pytest.raises(ValueError): 12 12 | raise ValueError +13 13 | +14 14 | def test_rewrite_references(self): +PT027_1.py:15:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaises` + | +14 | def test_rewrite_references(self): +15 | with self.assertRaises(ValueError) as e: + | ^^^^^^^^^^^^^^^^^ PT027 +16 | raise ValueError + | + = help: Replace `assertRaises` with `pytest.raises` + +ℹ Unsafe fix +12 12 | raise ValueError +13 13 | +14 14 | def test_rewrite_references(self): +15 |- with self.assertRaises(ValueError) as e: + 15 |+ with pytest.raises(ValueError) as e: +16 16 | raise ValueError +17 17 | +18 18 | print(e.foo) +19 |- print(e.exception) + 19 |+ print(e.value) +20 20 | +21 21 | def test_rewrite_references_multiple_items(self): +22 22 | with self.assertRaises(ValueError) as e1, \ + +PT027_1.py:22:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaises` + | +21 | def test_rewrite_references_multiple_items(self): +22 | with self.assertRaises(ValueError) as e1, \ + | ^^^^^^^^^^^^^^^^^ PT027 +23 | self.assertRaises(ValueError) as e2: +24 | raise ValueError + | + = help: Replace `assertRaises` with `pytest.raises` + +ℹ Unsafe fix +19 19 | print(e.exception) +20 20 | +21 21 | def test_rewrite_references_multiple_items(self): +22 |- with self.assertRaises(ValueError) as e1, \ + 22 |+ with pytest.raises(ValueError) as e1, \ +23 23 | self.assertRaises(ValueError) as e2: +24 24 | raise ValueError +25 25 | +26 26 | print(e1.foo) +27 |- print(e1.exception) + 27 |+ print(e1.value) +28 28 | +29 29 | print(e2.foo) +30 30 | print(e2.exception) + +PT027_1.py:23:13: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaises` + | +21 | def test_rewrite_references_multiple_items(self): +22 | with self.assertRaises(ValueError) as e1, \ +23 | self.assertRaises(ValueError) as e2: + | ^^^^^^^^^^^^^^^^^ PT027 +24 | raise ValueError + | + = help: Replace `assertRaises` with `pytest.raises` + +ℹ Unsafe fix +20 20 | +21 21 | def test_rewrite_references_multiple_items(self): +22 22 | with self.assertRaises(ValueError) as e1, \ +23 |- self.assertRaises(ValueError) as e2: + 23 |+ pytest.raises(ValueError) as e2: +24 24 | raise ValueError +25 25 | +26 26 | print(e1.foo) +27 27 | print(e1.exception) +28 28 | +29 29 | print(e2.foo) +30 |- print(e2.exception) + 30 |+ print(e2.value) +31 31 | +32 32 | def test_rewrite_references_multiple_items_nested(self): +33 33 | with self.assertRaises(ValueError) as e1, \ + +PT027_1.py:33:14: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaises` + | +32 | def test_rewrite_references_multiple_items_nested(self): +33 | with self.assertRaises(ValueError) as e1, \ + | ^^^^^^^^^^^^^^^^^ PT027 +34 | foo(self.assertRaises(ValueError)) as e2: +35 | raise ValueError + | + = help: Replace `assertRaises` with `pytest.raises` + +ℹ Unsafe fix +30 30 | print(e2.exception) +31 31 | +32 32 | def test_rewrite_references_multiple_items_nested(self): +33 |- with self.assertRaises(ValueError) as e1, \ + 33 |+ with pytest.raises(ValueError) as e1, \ +34 34 | foo(self.assertRaises(ValueError)) as e2: +35 35 | raise ValueError +36 36 | +37 37 | print(e1.foo) +38 |- print(e1.exception) + 38 |+ print(e1.value) +39 39 | +40 40 | print(e2.foo) +41 41 | print(e2.exception) + +PT027_1.py:34:17: PT027 [*] Use `pytest.raises` instead of unittest-style `assertRaises` + | +32 | def test_rewrite_references_multiple_items_nested(self): +33 | with self.assertRaises(ValueError) as e1, \ +34 | foo(self.assertRaises(ValueError)) as e2: + | ^^^^^^^^^^^^^^^^^ PT027 +35 | raise ValueError + | + = help: Replace `assertRaises` with `pytest.raises` +ℹ Unsafe fix +31 31 | +32 32 | def test_rewrite_references_multiple_items_nested(self): +33 33 | with self.assertRaises(ValueError) as e1, \ +34 |- foo(self.assertRaises(ValueError)) as e2: + 34 |+ foo(pytest.raises(ValueError)) as e2: +35 35 | raise ValueError +36 36 | +37 37 | print(e1.foo) diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT028.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT028.snap new file mode 100644 index 0000000000000..88b10b57c90f4 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT028.snap @@ -0,0 +1,224 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT028.py:3:16: PT028 Test function parameter `a` has default argument + | +1 | # Errors +2 | +3 | def test_foo(a=1): ... + | ^ PT028 +4 | def test_foo(a = 1): ... +5 | def test_foo(a = (1)): ... + | + = help: Remove default argument + +ℹ Display-only fix +1 1 | # Errors +2 2 | +3 |-def test_foo(a=1): ... + 3 |+def test_foo(a): ... +4 4 | def test_foo(a = 1): ... +5 5 | def test_foo(a = (1)): ... +6 6 | def test_foo(a: int=1): ... + +PT028.py:4:18: PT028 Test function parameter `a` has default argument + | +3 | def test_foo(a=1): ... +4 | def test_foo(a = 1): ... + | ^ PT028 +5 | def test_foo(a = (1)): ... +6 | def test_foo(a: int=1): ... + | + = help: Remove default argument + +ℹ Display-only fix +1 1 | # Errors +2 2 | +3 3 | def test_foo(a=1): ... +4 |-def test_foo(a = 1): ... + 4 |+def test_foo(a): ... +5 5 | def test_foo(a = (1)): ... +6 6 | def test_foo(a: int=1): ... +7 7 | def test_foo(a: int = 1): ... + +PT028.py:5:19: PT028 Test function parameter `a` has default argument + | +3 | def test_foo(a=1): ... +4 | def test_foo(a = 1): ... +5 | def test_foo(a = (1)): ... + | ^ PT028 +6 | def test_foo(a: int=1): ... +7 | def test_foo(a: int = 1): ... + | + = help: Remove default argument + +ℹ Display-only fix +2 2 | +3 3 | def test_foo(a=1): ... +4 4 | def test_foo(a = 1): ... +5 |-def test_foo(a = (1)): ... + 5 |+def test_foo(a): ... +6 6 | def test_foo(a: int=1): ... +7 7 | def test_foo(a: int = 1): ... +8 8 | def test_foo(a: (int) = 1): ... + +PT028.py:6:21: PT028 Test function parameter `a` has default argument + | +4 | def test_foo(a = 1): ... +5 | def test_foo(a = (1)): ... +6 | def test_foo(a: int=1): ... + | ^ PT028 +7 | def test_foo(a: int = 1): ... +8 | def test_foo(a: (int) = 1): ... + | + = help: Remove default argument + +ℹ Display-only fix +3 3 | def test_foo(a=1): ... +4 4 | def test_foo(a = 1): ... +5 5 | def test_foo(a = (1)): ... +6 |-def test_foo(a: int=1): ... + 6 |+def test_foo(a: int): ... +7 7 | def test_foo(a: int = 1): ... +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... + +PT028.py:7:23: PT028 Test function parameter `a` has default argument + | +5 | def test_foo(a = (1)): ... +6 | def test_foo(a: int=1): ... +7 | def test_foo(a: int = 1): ... + | ^ PT028 +8 | def test_foo(a: (int) = 1): ... +9 | def test_foo(a: int = (1)): ... + | + = help: Remove default argument + +ℹ Display-only fix +4 4 | def test_foo(a = 1): ... +5 5 | def test_foo(a = (1)): ... +6 6 | def test_foo(a: int=1): ... +7 |-def test_foo(a: int = 1): ... + 7 |+def test_foo(a: int): ... +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... +10 10 | def test_foo(a: (int) = (1)): ... + +PT028.py:8:25: PT028 Test function parameter `a` has default argument + | + 6 | def test_foo(a: int=1): ... + 7 | def test_foo(a: int = 1): ... + 8 | def test_foo(a: (int) = 1): ... + | ^ PT028 + 9 | def test_foo(a: int = (1)): ... +10 | def test_foo(a: (int) = (1)): ... + | + = help: Remove default argument + +ℹ Display-only fix +5 5 | def test_foo(a = (1)): ... +6 6 | def test_foo(a: int=1): ... +7 7 | def test_foo(a: int = 1): ... +8 |-def test_foo(a: (int) = 1): ... + 8 |+def test_foo(a: (int)): ... +9 9 | def test_foo(a: int = (1)): ... +10 10 | def test_foo(a: (int) = (1)): ... +11 11 | def test_foo(a=1, /, b=2, *, c=3): ... + +PT028.py:9:24: PT028 Test function parameter `a` has default argument + | + 7 | def test_foo(a: int = 1): ... + 8 | def test_foo(a: (int) = 1): ... + 9 | def test_foo(a: int = (1)): ... + | ^ PT028 +10 | def test_foo(a: (int) = (1)): ... +11 | def test_foo(a=1, /, b=2, *, c=3): ... + | + = help: Remove default argument + +ℹ Display-only fix +6 6 | def test_foo(a: int=1): ... +7 7 | def test_foo(a: int = 1): ... +8 8 | def test_foo(a: (int) = 1): ... +9 |-def test_foo(a: int = (1)): ... + 9 |+def test_foo(a: int): ... +10 10 | def test_foo(a: (int) = (1)): ... +11 11 | def test_foo(a=1, /, b=2, *, c=3): ... +12 12 | + +PT028.py:10:26: PT028 Test function parameter `a` has default argument + | + 8 | def test_foo(a: (int) = 1): ... + 9 | def test_foo(a: int = (1)): ... +10 | def test_foo(a: (int) = (1)): ... + | ^ PT028 +11 | def test_foo(a=1, /, b=2, *, c=3): ... + | + = help: Remove default argument + +ℹ Display-only fix +7 7 | def test_foo(a: int = 1): ... +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... +10 |-def test_foo(a: (int) = (1)): ... + 10 |+def test_foo(a: (int)): ... +11 11 | def test_foo(a=1, /, b=2, *, c=3): ... +12 12 | +13 13 | + +PT028.py:11:16: PT028 Test function parameter `a` has default argument + | + 9 | def test_foo(a: int = (1)): ... +10 | def test_foo(a: (int) = (1)): ... +11 | def test_foo(a=1, /, b=2, *, c=3): ... + | ^ PT028 + | + = help: Remove default argument + +ℹ Display-only fix +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... +10 10 | def test_foo(a: (int) = (1)): ... +11 |-def test_foo(a=1, /, b=2, *, c=3): ... + 11 |+def test_foo(a, /, b=2, *, c=3): ... +12 12 | +13 13 | +14 14 | # No errors + +PT028.py:11:24: PT028 Test function parameter `b` has default argument + | + 9 | def test_foo(a: int = (1)): ... +10 | def test_foo(a: (int) = (1)): ... +11 | def test_foo(a=1, /, b=2, *, c=3): ... + | ^ PT028 + | + = help: Remove default argument + +ℹ Display-only fix +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... +10 10 | def test_foo(a: (int) = (1)): ... +11 |-def test_foo(a=1, /, b=2, *, c=3): ... + 11 |+def test_foo(a=1, /, b, *, c=3): ... +12 12 | +13 13 | +14 14 | # No errors + +PT028.py:11:32: PT028 Test function parameter `c` has default argument + | + 9 | def test_foo(a: int = (1)): ... +10 | def test_foo(a: (int) = (1)): ... +11 | def test_foo(a=1, /, b=2, *, c=3): ... + | ^ PT028 + | + = help: Remove default argument + +ℹ Display-only fix +8 8 | def test_foo(a: (int) = 1): ... +9 9 | def test_foo(a: int = (1)): ... +10 10 | def test_foo(a: (int) = (1)): ... +11 |-def test_foo(a=1, /, b=2, *, c=3): ... + 11 |+def test_foo(a=1, /, b=2, *, c): ... +12 12 | +13 13 | +14 14 | # No errors diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT029.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT029.snap new file mode 100644 index 0000000000000..0806d2d4f5cbd --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT029.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT029.py:5:10: PT029 Set the expected warning in `pytest.warns()` + | +4 | def test_ok(): +5 | with pytest.warns(): + | ^^^^^^^^^^^^ PT029 +6 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_default.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_default.snap new file mode 100644 index 0000000000000..8e791ec77edd0 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_default.snap @@ -0,0 +1,45 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT030.py:16:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +15 | def test_error_no_argument_given(): +16 | with pytest.warns(UserWarning): + | ^^^^^^^^^^^ PT030 +17 | pass + | + +PT030.py:19:40: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +17 | pass +18 | +19 | with pytest.warns(expected_warning=UserWarning): + | ^^^^^^^^^^^ PT030 +20 | pass + | + +PT030.py:27:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +26 | def test_error_match_is_empty(): +27 | with pytest.warns(UserWarning, match=None): + | ^^^^^^^^^^^ PT030 +28 | pass + | + +PT030.py:30:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +28 | pass +29 | +30 | with pytest.warns(UserWarning, match=""): + | ^^^^^^^^^^^ PT030 +31 | pass + | + +PT030.py:33:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +31 | pass +32 | +33 | with pytest.warns(UserWarning, match=f""): + | ^^^^^^^^^^^ PT030 +34 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_extend_broad_exceptions.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_extend_broad_exceptions.snap new file mode 100644 index 0000000000000..7eaf4703e1f7a --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_extend_broad_exceptions.snap @@ -0,0 +1,53 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT030.py:11:23: PT030 `pytest.warns(EncodingWarning)` is too broad, set the `match` parameter or use a more specific warning + | +10 | def test_ok_different_error_from_config(): +11 | with pytest.warns(EncodingWarning): + | ^^^^^^^^^^^^^^^ PT030 +12 | pass + | + +PT030.py:16:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +15 | def test_error_no_argument_given(): +16 | with pytest.warns(UserWarning): + | ^^^^^^^^^^^ PT030 +17 | pass + | + +PT030.py:19:40: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +17 | pass +18 | +19 | with pytest.warns(expected_warning=UserWarning): + | ^^^^^^^^^^^ PT030 +20 | pass + | + +PT030.py:27:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +26 | def test_error_match_is_empty(): +27 | with pytest.warns(UserWarning, match=None): + | ^^^^^^^^^^^ PT030 +28 | pass + | + +PT030.py:30:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +28 | pass +29 | +30 | with pytest.warns(UserWarning, match=""): + | ^^^^^^^^^^^ PT030 +31 | pass + | + +PT030.py:33:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +31 | pass +32 | +33 | with pytest.warns(UserWarning, match=f""): + | ^^^^^^^^^^^ PT030 +34 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_all.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_all.snap new file mode 100644 index 0000000000000..11c8873f1ff6e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_all.snap @@ -0,0 +1,62 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT030.py:11:23: PT030 `pytest.warns(EncodingWarning)` is too broad, set the `match` parameter or use a more specific warning + | +10 | def test_ok_different_error_from_config(): +11 | with pytest.warns(EncodingWarning): + | ^^^^^^^^^^^^^^^ PT030 +12 | pass + | + +PT030.py:16:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +15 | def test_error_no_argument_given(): +16 | with pytest.warns(UserWarning): + | ^^^^^^^^^^^ PT030 +17 | pass + | + +PT030.py:19:40: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +17 | pass +18 | +19 | with pytest.warns(expected_warning=UserWarning): + | ^^^^^^^^^^^ PT030 +20 | pass + | + +PT030.py:22:23: PT030 `pytest.warns(foo.FooWarning)` is too broad, set the `match` parameter or use a more specific warning + | +20 | pass +21 | +22 | with pytest.warns(FooWarning): + | ^^^^^^^^^^ PT030 +23 | pass + | + +PT030.py:27:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +26 | def test_error_match_is_empty(): +27 | with pytest.warns(UserWarning, match=None): + | ^^^^^^^^^^^ PT030 +28 | pass + | + +PT030.py:30:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +28 | pass +29 | +30 | with pytest.warns(UserWarning, match=""): + | ^^^^^^^^^^^ PT030 +31 | pass + | + +PT030.py:33:23: PT030 `pytest.warns(UserWarning)` is too broad, set the `match` parameter or use a more specific warning + | +31 | pass +32 | +33 | with pytest.warns(UserWarning, match=f""): + | ^^^^^^^^^^^ PT030 +34 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_prefix.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_prefix.snap new file mode 100644 index 0000000000000..b939b1a658f6e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_glob_prefix.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT030.py:22:23: PT030 `pytest.warns(foo.FooWarning)` is too broad, set the `match` parameter or use a more specific warning + | +20 | pass +21 | +22 | with pytest.warns(FooWarning): + | ^^^^^^^^^^ PT030 +23 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_replace_broad_exceptions.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_replace_broad_exceptions.snap new file mode 100644 index 0000000000000..4268e3a690e80 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT030_replace_broad_exceptions.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +snapshot_kind: text +--- +PT030.py:11:23: PT030 `pytest.warns(EncodingWarning)` is too broad, set the `match` parameter or use a more specific warning + | +10 | def test_ok_different_error_from_config(): +11 | with pytest.warns(EncodingWarning): + | ^^^^^^^^^^^^^^^ PT030 +12 | pass + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT031.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT031.snap new file mode 100644 index 0000000000000..ebf9e8b2fccd2 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__PT031.snap @@ -0,0 +1,126 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +PT031.py:42:5: PT031 `pytest.warns()` block should contain a single simple statement + | +41 | def test_error_multiple_statements(): +42 | / with pytest.warns(UserWarning): +43 | | foo() +44 | | bar() + | |_____________^ PT031 + | + +PT031.py:48:5: PT031 `pytest.warns()` block should contain a single simple statement + | +47 | async def test_error_complex_statement(): +48 | / with pytest.warns(UserWarning): +49 | | if True: +50 | | foo() + | |_________________^ PT031 +51 | +52 | with pytest.warns(UserWarning): + | + +PT031.py:52:5: PT031 `pytest.warns()` block should contain a single simple statement + | +50 | foo() +51 | +52 | / with pytest.warns(UserWarning): +53 | | for i in []: +54 | | foo() + | |_________________^ PT031 +55 | +56 | with pytest.warns(UserWarning): + | + +PT031.py:56:5: PT031 `pytest.warns()` block should contain a single simple statement + | +54 | foo() +55 | +56 | / with pytest.warns(UserWarning): +57 | | async for i in []: +58 | | foo() + | |_________________^ PT031 +59 | +60 | with pytest.warns(UserWarning): + | + +PT031.py:60:5: PT031 `pytest.warns()` block should contain a single simple statement + | +58 | foo() +59 | +60 | / with pytest.warns(UserWarning): +61 | | while True: +62 | | foo() + | |_________________^ PT031 +63 | +64 | with pytest.warns(UserWarning): + | + +PT031.py:64:5: PT031 `pytest.warns()` block should contain a single simple statement + | +62 | foo() +63 | +64 | / with pytest.warns(UserWarning): +65 | | async with context_manager_under_test(): +66 | | if True: +67 | | foo() + | |_____________________^ PT031 + | + +PT031.py:71:5: PT031 `pytest.warns()` block should contain a single simple statement + | +70 | def test_error_try(): +71 | / with pytest.warns(UserWarning): +72 | | try: +73 | | foo() +74 | | except: +75 | | raise + | |_________________^ PT031 + | + +PT031.py:83:5: PT031 `pytest.warns()` block should contain a single simple statement + | +81 | ## Errors +82 | +83 | / with pytest.warns(RuntimeError): +84 | | for a in b: +85 | | print() + | |___________________^ PT031 +86 | +87 | with pytest.warns(RuntimeError): + | + +PT031.py:87:5: PT031 `pytest.warns()` block should contain a single simple statement + | +85 | print() +86 | +87 | / with pytest.warns(RuntimeError): +88 | | for a in b: +89 | | assert foo + | |______________________^ PT031 +90 | +91 | with pytest.warns(RuntimeError): + | + +PT031.py:91:5: PT031 `pytest.warns()` block should contain a single simple statement + | +89 | assert foo +90 | +91 | / with pytest.warns(RuntimeError): +92 | | async for a in b: +93 | | print() + | |___________________^ PT031 +94 | +95 | with pytest.warns(RuntimeError): + | + +PT031.py:95:5: PT031 `pytest.warns()` block should contain a single simple statement + | +93 | print() +94 | +95 | / with pytest.warns(RuntimeError): +96 | | async for a in b: +97 | | assert foo + | |______________________^ PT031 + | diff --git a/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__is_pytest_test.snap b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__is_pytest_test.snap new file mode 100644 index 0000000000000..66b3fc1395c8e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_pytest_style/snapshots/ruff_linter__rules__flake8_pytest_style__tests__is_pytest_test.snap @@ -0,0 +1,79 @@ +--- +source: crates/ruff_linter/src/rules/flake8_pytest_style/mod.rs +--- +is_pytest_test.py:3:27: PT028 Test function parameter `a` has default argument + | +1 | # Errors +2 | +3 | def test_this_is_a_test(a=1): ... + | ^ PT028 +4 | def testThisIsAlsoATest(a=1): ... + | + = help: Remove default argument + +ℹ Display-only fix +1 1 | # Errors +2 2 | +3 |-def test_this_is_a_test(a=1): ... + 3 |+def test_this_is_a_test(a): ... +4 4 | def testThisIsAlsoATest(a=1): ... +5 5 | +6 6 | class TestClass: + +is_pytest_test.py:4:27: PT028 Test function parameter `a` has default argument + | +3 | def test_this_is_a_test(a=1): ... +4 | def testThisIsAlsoATest(a=1): ... + | ^ PT028 +5 | +6 | class TestClass: + | + = help: Remove default argument + +ℹ Display-only fix +1 1 | # Errors +2 2 | +3 3 | def test_this_is_a_test(a=1): ... +4 |-def testThisIsAlsoATest(a=1): ... + 4 |+def testThisIsAlsoATest(a): ... +5 5 | +6 6 | class TestClass: +7 7 | def test_this_too_is_a_test(self, a=1): ... + +is_pytest_test.py:7:41: PT028 Test function parameter `a` has default argument + | +6 | class TestClass: +7 | def test_this_too_is_a_test(self, a=1): ... + | ^ PT028 +8 | def testAndOfCourseThis(self, a=1): ... + | + = help: Remove default argument + +ℹ Display-only fix +4 4 | def testThisIsAlsoATest(a=1): ... +5 5 | +6 6 | class TestClass: +7 |- def test_this_too_is_a_test(self, a=1): ... + 7 |+ def test_this_too_is_a_test(self, a): ... +8 8 | def testAndOfCourseThis(self, a=1): ... +9 9 | +10 10 | + +is_pytest_test.py:8:37: PT028 Test function parameter `a` has default argument + | +6 | class TestClass: +7 | def test_this_too_is_a_test(self, a=1): ... +8 | def testAndOfCourseThis(self, a=1): ... + | ^ PT028 + | + = help: Remove default argument + +ℹ Display-only fix +5 5 | +6 6 | class TestClass: +7 7 | def test_this_too_is_a_test(self, a=1): ... +8 |- def testAndOfCourseThis(self, a=1): ... + 8 |+ def testAndOfCourseThis(self, a): ... +9 9 | +10 10 | +11 11 | # No errors diff --git a/crates/ruff_linter/src/rules/flake8_quotes/mod.rs b/crates/ruff_linter/src/rules/flake8_quotes/mod.rs index 9025b10e67e55..a684391bcdf23 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_quotes/mod.rs @@ -12,9 +12,9 @@ mod tests { use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::settings::LinterSettings; use crate::test::test_path; + use ruff_python_ast::PythonVersion; use super::settings::Quote; @@ -62,7 +62,7 @@ mod tests { avoid_escape: true, }, ..LinterSettings::for_rule(Rule::AvoidableEscapedQuote) - .with_target_version(PythonVersion::Py311) + .with_target_version(PythonVersion::PY311) }, )?; assert_messages!(diagnostics); @@ -81,7 +81,7 @@ mod tests { avoid_escape: true, }, ..LinterSettings::for_rule(Rule::AvoidableEscapedQuote) - .with_target_version(PythonVersion::Py311) + .with_target_version(PythonVersion::PY311) }, )?; assert_messages!(diagnostics); diff --git a/crates/ruff_linter/src/rules/flake8_quotes/rules/avoidable_escaped_quote.rs b/crates/ruff_linter/src/rules/flake8_quotes/rules/avoidable_escaped_quote.rs index 70725a983574d..f1fc4c5a50abd 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/rules/avoidable_escaped_quote.rs +++ b/crates/ruff_linter/src/rules/flake8_quotes/rules/avoidable_escaped_quote.rs @@ -1,15 +1,14 @@ use flake8_quotes::helpers::{contains_escaped_quote, raw_contents, unescape_string}; use flake8_quotes::settings::Quote; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::visitor::{walk_f_string, Visitor}; -use ruff_python_ast::{self as ast, AnyStringFlags, StringFlags, StringLike}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::visitor::{Visitor, walk_f_string}; +use ruff_python_ast::{self as ast, AnyStringFlags, PythonVersion, StringFlags, StringLike}; use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::flake8_quotes; -use crate::settings::LinterSettings; -use crate::Locator; /// ## What it does /// Checks for strings that include escaped quotes, and suggests changing @@ -35,13 +34,13 @@ use crate::Locator; /// redundant. /// /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct AvoidableEscapedQuote; +#[derive(ViolationMetadata)] +pub(crate) struct AvoidableEscapedQuote; impl AlwaysFixableViolation for AvoidableEscapedQuote { #[derive_message_formats] fn message(&self) -> String { - format!("Change outer quotes to avoid escaping inner quotes") + "Change outer quotes to avoid escaping inner quotes".to_string() } fn fix_title(&self) -> String { @@ -50,7 +49,7 @@ impl AlwaysFixableViolation for AvoidableEscapedQuote { } /// Q003 -pub(crate) fn avoidable_escaped_quote(checker: &mut Checker, string_like: StringLike) { +pub(crate) fn avoidable_escaped_quote(checker: &Checker, string_like: StringLike) { if checker.semantic().in_pep_257_docstring() || checker.semantic().in_string_type_definition() // This rule has support for strings nested inside another f-strings but they're checked @@ -61,7 +60,7 @@ pub(crate) fn avoidable_escaped_quote(checker: &mut Checker, string_like: String return; } - let mut rule_checker = AvoidableEscapedQuoteChecker::new(checker.locator(), checker.settings); + let mut rule_checker = AvoidableEscapedQuoteChecker::new(checker, checker.target_version()); for part in string_like.parts() { match part { @@ -74,55 +73,45 @@ pub(crate) fn avoidable_escaped_quote(checker: &mut Checker, string_like: String ast::StringLikePart::FString(f_string) => rule_checker.visit_f_string(f_string), } } - - checker.diagnostics.extend(rule_checker.into_diagnostics()); } /// Checks for `Q003` violations using the [`Visitor`] implementation. -#[derive(Debug)] -struct AvoidableEscapedQuoteChecker<'a> { - locator: &'a Locator<'a>, +struct AvoidableEscapedQuoteChecker<'a, 'b> { + checker: &'a Checker<'b>, quotes_settings: &'a flake8_quotes::settings::Settings, supports_pep701: bool, - diagnostics: Vec<Diagnostic>, } -impl<'a> AvoidableEscapedQuoteChecker<'a> { - fn new(locator: &'a Locator<'a>, settings: &'a LinterSettings) -> Self { +impl<'a, 'b> AvoidableEscapedQuoteChecker<'a, 'b> { + fn new(checker: &'a Checker<'b>, target_version: PythonVersion) -> Self { Self { - locator, - quotes_settings: &settings.flake8_quotes, - supports_pep701: settings.target_version.supports_pep701(), - diagnostics: vec![], + checker, + quotes_settings: &checker.settings.flake8_quotes, + supports_pep701: target_version.supports_pep_701(), } } - - /// Consumes the checker and returns a vector of [`Diagnostic`] found during the visit. - fn into_diagnostics(self) -> Vec<Diagnostic> { - self.diagnostics - } } -impl Visitor<'_> for AvoidableEscapedQuoteChecker<'_> { - fn visit_string_literal(&mut self, string_literal: &'_ ast::StringLiteral) { +impl Visitor<'_> for AvoidableEscapedQuoteChecker<'_, '_> { + fn visit_string_literal(&mut self, string_literal: &ast::StringLiteral) { if let Some(diagnostic) = check_string_or_bytes( - self.locator, + self.checker.locator(), self.quotes_settings, string_literal.range(), AnyStringFlags::from(string_literal.flags), ) { - self.diagnostics.push(diagnostic); + self.checker.report_diagnostic(diagnostic); } } - fn visit_bytes_literal(&mut self, bytes_literal: &'_ ast::BytesLiteral) { + fn visit_bytes_literal(&mut self, bytes_literal: &ast::BytesLiteral) { if let Some(diagnostic) = check_string_or_bytes( - self.locator, + self.checker.locator(), self.quotes_settings, bytes_literal.range(), AnyStringFlags::from(bytes_literal.flags), ) { - self.diagnostics.push(diagnostic); + self.checker.report_diagnostic(diagnostic); } } @@ -195,8 +184,10 @@ impl Visitor<'_> for AvoidableEscapedQuoteChecker<'_> { .literals() .any(|literal| contains_quote(literal, opposite_quote_char)) { - if let Some(diagnostic) = check_f_string(self.locator, self.quotes_settings, f_string) { - self.diagnostics.push(diagnostic); + if let Some(diagnostic) = + check_f_string(self.checker.locator(), self.quotes_settings, f_string) + { + self.checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_quotes/rules/check_string_quotes.rs b/crates/ruff_linter/src/rules/flake8_quotes/rules/check_string_quotes.rs index 2ae1e4d575684..128bc327148b6 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/rules/check_string_quotes.rs +++ b/crates/ruff_linter/src/rules/flake8_quotes/rules/check_string_quotes.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::StringLike; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::registry::Rule; -use crate::Locator; use super::super::settings::Quote; @@ -36,8 +36,8 @@ use super::super::settings::Quote; /// redundant. /// /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct BadQuotesInlineString { +#[derive(ViolationMetadata)] +pub(crate) struct BadQuotesInlineString { preferred_quote: Quote, } @@ -46,19 +46,18 @@ impl Violation for BadQuotesInlineString { #[derive_message_formats] fn message(&self) -> String { - let BadQuotesInlineString { preferred_quote } = self; - match preferred_quote { - Quote::Double => format!("Single quotes found but double quotes preferred"), - Quote::Single => format!("Double quotes found but single quotes preferred"), + match self.preferred_quote { + Quote::Double => "Single quotes found but double quotes preferred".to_string(), + Quote::Single => "Double quotes found but single quotes preferred".to_string(), } } fn fix_title(&self) -> Option<String> { - let BadQuotesInlineString { preferred_quote } = self; - match preferred_quote { - Quote::Double => Some("Replace single quotes with double quotes".to_string()), - Quote::Single => Some("Replace double quotes with single quotes".to_string()), - } + let title = match self.preferred_quote { + Quote::Double => "Replace single quotes with double quotes", + Quote::Single => "Replace double quotes with single quotes", + }; + Some(title.to_string()) } } @@ -94,8 +93,8 @@ impl Violation for BadQuotesInlineString { /// redundant. /// /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct BadQuotesMultilineString { +#[derive(ViolationMetadata)] +pub(crate) struct BadQuotesMultilineString { preferred_quote: Quote, } @@ -104,8 +103,8 @@ impl AlwaysFixableViolation for BadQuotesMultilineString { fn message(&self) -> String { let BadQuotesMultilineString { preferred_quote } = self; match preferred_quote { - Quote::Double => format!("Single quote multiline found but double quotes preferred"), - Quote::Single => format!("Double quote multiline found but single quotes preferred"), + Quote::Double => "Single quote multiline found but double quotes preferred".to_string(), + Quote::Single => "Double quote multiline found but single quotes preferred".to_string(), } } @@ -149,8 +148,8 @@ impl AlwaysFixableViolation for BadQuotesMultilineString { /// redundant. /// /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct BadQuotesDocstring { +#[derive(ViolationMetadata)] +pub(crate) struct BadQuotesDocstring { preferred_quote: Quote, } @@ -159,16 +158,14 @@ impl Violation for BadQuotesDocstring { #[derive_message_formats] fn message(&self) -> String { - let BadQuotesDocstring { preferred_quote } = self; - match preferred_quote { - Quote::Double => format!("Single quote docstring found but double quotes preferred"), - Quote::Single => format!("Double quote docstring found but single quotes preferred"), + match self.preferred_quote { + Quote::Double => "Single quote docstring found but double quotes preferred".to_string(), + Quote::Single => "Double quote docstring found but single quotes preferred".to_string(), } } fn fix_title(&self) -> Option<String> { - let BadQuotesDocstring { preferred_quote } = self; - match preferred_quote { + match self.preferred_quote { Quote::Double => Some("Replace single quotes docstring with double quotes".to_string()), Quote::Single => Some("Replace double quotes docstring with single quotes".to_string()), } @@ -253,7 +250,7 @@ fn text_ends_at_quote(locator: &Locator, range: TextRange, quote: Quote) -> bool } /// Q002 -fn docstring(checker: &mut Checker, range: TextRange) { +fn docstring(checker: &Checker, range: TextRange) { let quotes_settings = &checker.settings.flake8_quotes; let locator = checker.locator(); @@ -264,7 +261,7 @@ fn docstring(checker: &mut Checker, range: TextRange) { { // Fixing this would result in a one-sided multi-line docstring, which would // introduce a syntax error. - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadQuotesDocstring { preferred_quote: quotes_settings.docstring_quotes, }, @@ -301,11 +298,11 @@ fn docstring(checker: &mut Checker, range: TextRange) { fixed_contents, range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Q000, Q001 -fn strings(checker: &mut Checker, sequence: &[TextRange]) { +fn strings(checker: &Checker, sequence: &[TextRange]) { let quotes_settings = &checker.settings.flake8_quotes; let locator = checker.locator(); @@ -376,7 +373,7 @@ fn strings(checker: &mut Checker, sequence: &[TextRange]) { fixed_contents, *range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else if trivia.last_quote_char != quotes_settings.inline_quotes.as_char() // If we're not using the preferred type, only allow use to avoid escapes. && !relax_quote @@ -394,7 +391,7 @@ fn strings(checker: &mut Checker, sequence: &[TextRange]) { // ```python // ''"assert" ' SAM macro definitions ''' // ``` - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadQuotesInlineString { preferred_quote: quotes_settings.inline_quotes, }, @@ -409,7 +406,7 @@ fn strings(checker: &mut Checker, sequence: &[TextRange]) { // ```python // ''"assert" ' SAM macro definitions ''' // ``` - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadQuotesInlineString { preferred_quote: quotes_settings.inline_quotes, }, @@ -436,13 +433,13 @@ fn strings(checker: &mut Checker, sequence: &[TextRange]) { fixed_contents, *range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } /// Generate `flake8-quote` diagnostics from a token stream. -pub(crate) fn check_string_quotes(checker: &mut Checker, string_like: StringLike) { +pub(crate) fn check_string_quotes(checker: &Checker, string_like: StringLike) { // Ignore if the string is part of a forward reference. For example, // `x: "Literal['foo', 'bar']"`. if checker.semantic().in_string_type_definition() { diff --git a/crates/ruff_linter/src/rules/flake8_quotes/rules/unnecessary_escaped_quote.rs b/crates/ruff_linter/src/rules/flake8_quotes/rules/unnecessary_escaped_quote.rs index 9fc68dc0463d7..df7aed1032af7 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/rules/unnecessary_escaped_quote.rs +++ b/crates/ruff_linter/src/rules/flake8_quotes/rules/unnecessary_escaped_quote.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, AnyStringFlags, StringFlags, StringLike}; use ruff_text_size::{Ranged, TextRange}; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; use super::super::helpers::{contains_escaped_quote, raw_contents, unescape_string}; @@ -31,13 +31,13 @@ use super::super::helpers::{contains_escaped_quote, raw_contents, unescape_strin /// redundant. /// /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct UnnecessaryEscapedQuote; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryEscapedQuote; impl AlwaysFixableViolation for UnnecessaryEscapedQuote { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary escape on inner quote character") + "Unnecessary escape on inner quote character".to_string() } fn fix_title(&self) -> String { @@ -46,7 +46,7 @@ impl AlwaysFixableViolation for UnnecessaryEscapedQuote { } /// Q004 -pub(crate) fn unnecessary_escaped_quote(checker: &mut Checker, string_like: StringLike) { +pub(crate) fn unnecessary_escaped_quote(checker: &Checker, string_like: StringLike) { if checker.semantic().in_pep_257_docstring() { return; } @@ -61,7 +61,7 @@ pub(crate) fn unnecessary_escaped_quote(checker: &mut Checker, string_like: Stri string_literal.range(), AnyStringFlags::from(string_literal.flags), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } ast::StringLikePart::Bytes(bytes_literal) => { @@ -70,12 +70,12 @@ pub(crate) fn unnecessary_escaped_quote(checker: &mut Checker, string_like: Stri bytes_literal.range(), AnyStringFlags::from(bytes_literal.flags), ) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } ast::StringLikePart::FString(f_string) => { if let Some(diagnostic) = check_f_string(locator, f_string) { - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -108,7 +108,9 @@ fn check_string_or_bytes( let mut diagnostic = Diagnostic::new(UnnecessaryEscapedQuote, range); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - flags.format_string_contents(&unescape_string(contents, opposite_quote_char)), + flags + .display_contents(&unescape_string(contents, opposite_quote_char)) + .to_string(), range, ))); Some(diagnostic) diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_docstring_doubles_all.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_docstring_doubles_all.py.snap index 6a87062097567..39a104d5b5a32 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_docstring_doubles_all.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_docstring_doubles_all.py.snap @@ -5,7 +5,7 @@ doubles_all.py:1:1: Q002 [*] Double quote docstring found but single quotes pref | 1 | """This is a docstring.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^ Q002 -2 | +2 | 3 | this_is_an_inline_string = "double quote string" | = help: Replace double quotes docstring with single quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_inline_doubles_all.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_inline_doubles_all.py.snap index 0ca50ac62e93a..617c8d4d99dce 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_inline_doubles_all.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_inline_doubles_all.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs doubles_all.py:3:28: Q000 [*] Double quotes found but single quotes preferred | 1 | """This is a docstring.""" -2 | +2 | 3 | this_is_an_inline_string = "double quote string" | ^^^^^^^^^^^^^^^^^^^^^ Q000 -4 | +4 | 5 | this_is_a_multiline_string = """ | = help: Replace double quotes with single quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_multiline_doubles_all.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_multiline_doubles_all.py.snap index ddffe1bb80a5f..2edceeb830840 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_multiline_doubles_all.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__only_multiline_doubles_all.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs doubles_all.py:5:30: Q001 [*] Double quote multiline found but single quotes preferred | 3 | this_is_an_inline_string = "double quote string" -4 | +4 | 5 | this_is_a_multiline_string = """ | ______________________________^ 6 | | double quote string diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles.py.snap index 771a4ddc2b45d..4f3a569bdedb2 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles.py.snap @@ -4,12 +4,12 @@ source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs docstring_doubles.py:5:1: Q001 [*] Double quote multiline found but single quotes preferred | 3 | """ -4 | +4 | 5 | / """ 6 | | this is not a docstring 7 | | """ | |___^ Q001 -8 | +8 | 9 | l = [] | = help: Replace double multiline quotes with single quotes @@ -30,13 +30,12 @@ docstring_doubles.py:5:1: Q001 [*] Double quote multiline found but single quote docstring_doubles.py:16:5: Q001 [*] Double quote multiline found but single quotes preferred | 14 | """ -15 | -16 | """ - | _____^ +15 | +16 | / """ 17 | | this is not a docstring 18 | | """ | |_______^ Q001 -19 | +19 | 20 | # The colon in the list indexing below is an edge case for the docstring scanner | = help: Replace double multiline quotes with single quotes @@ -81,13 +80,12 @@ docstring_doubles.py:21:21: Q001 [*] Double quote multiline found but single quo docstring_doubles.py:30:9: Q001 [*] Double quote multiline found but single quotes preferred | 28 | some_expression = 'hello world' -29 | -30 | """ - | _________^ +29 | +30 | / """ 31 | | this is not a docstring 32 | | """ | |___________^ Q001 -33 | +33 | 34 | if l: | = help: Replace double multiline quotes with single quotes @@ -108,8 +106,7 @@ docstring_doubles.py:30:9: Q001 [*] Double quote multiline found but single quot docstring_doubles.py:35:13: Q001 [*] Double quote multiline found but single quotes preferred | 34 | if l: -35 | """ - | _____________^ +35 | / """ 36 | | Looks like a docstring, but in reality it isn't - only modules, classes and functions 37 | | """ | |_______________^ Q001 @@ -127,5 +124,3 @@ docstring_doubles.py:35:13: Q001 [*] Double quote multiline found but single quo 37 |- """ 37 |+ ''' 38 38 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_class.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_class.py.snap index 5eb1e20892926..400d7ae38e61f 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_class.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_class.py.snap @@ -7,7 +7,7 @@ docstring_doubles_class.py:3:5: Q001 [*] Double quote multiline found but single 2 | """ Double quotes single line class docstring """ 3 | """ Not a docstring """ | ^^^^^^^^^^^^^^^^^^^^^^^ Q001 -4 | +4 | 5 | def foo(self, bar="""not a docstring"""): | = help: Replace double multiline quotes with single quotes @@ -24,7 +24,7 @@ docstring_doubles_class.py:3:5: Q001 [*] Double quote multiline found but single docstring_doubles_class.py:5:23: Q001 [*] Double quote multiline found but single quotes preferred | 3 | """ Not a docstring """ -4 | +4 | 5 | def foo(self, bar="""not a docstring"""): | ^^^^^^^^^^^^^^^^^^^^^ Q001 6 | """ Double quotes single line method docstring""" @@ -40,6 +40,4 @@ docstring_doubles_class.py:5:23: Q001 [*] Double quote multiline found but singl 5 |+ def foo(self, bar='''not a docstring'''): 6 6 | """ Double quotes single line method docstring""" 7 7 | pass -8 8 | - - +8 8 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_function.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_function.py.snap index b669528cd7451..c679542311244 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_function.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_function.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_doubles_function.py:3:5: Q001 [*] Double quote multiline found but single quotes preferred | @@ -101,6 +102,4 @@ docstring_doubles_function.py:22:5: Q001 [*] Double quote multiline found but si 22 |+ ''' not a docstring '''): 23 23 | pass 24 24 | -25 25 | - - +25 25 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_multiline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_multiline.py.snap index 058c60b92440b..f0a6a7feacf60 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_multiline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_multiline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_doubles_module_multiline.py:4:1: Q001 [*] Double quote multiline found but single quotes preferred | @@ -47,5 +48,3 @@ docstring_doubles_module_multiline.py:9:1: Q001 [*] Double quote multiline found 10 10 | this is not a docstring 11 |-""" 11 |+''' - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_singleline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_singleline.py.snap index 64f43441c8d3a..b4aa9a7b1fbd7 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_singleline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_doubles_module_singleline.py.snap @@ -6,7 +6,7 @@ docstring_doubles_module_singleline.py:2:1: Q001 [*] Double quote multiline foun 1 | """ Double quotes singleline module docstring """ 2 | """ this is not a docstring """ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q001 -3 | +3 | 4 | def foo(): | = help: Replace double multiline quotes with single quotes @@ -34,5 +34,3 @@ docstring_doubles_module_singleline.py:6:1: Q001 [*] Double quote multiline foun 5 5 | pass 6 |-""" this is not a docstring """ 6 |+''' this is not a docstring ''' - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles.py.snap index c1c2f2c821599..c73763820c4f3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles.py.snap @@ -7,7 +7,7 @@ docstring_singles.py:1:1: Q002 [*] Single quote docstring found but double quote 2 | | Single quotes multiline module docstring 3 | | ''' | |___^ Q002 -4 | +4 | 5 | ''' | = help: Replace single quotes docstring with double quotes @@ -26,12 +26,11 @@ docstring_singles.py:14:5: Q002 [*] Single quote docstring found but double quot | 12 | class params \t not a docstring 13 | ''')): -14 | ''' - | _____^ +14 | / ''' 15 | | Single quotes multiline class docstring 16 | | ''' | |_______^ Q002 -17 | +17 | 18 | ''' | = help: Replace single quotes docstring with double quotes @@ -53,12 +52,11 @@ docstring_singles.py:26:9: Q002 [*] Single quote docstring found but double quot | 24 | definitely not a docstring''', 25 | val=l[Cls():3]): -26 | ''' - | _________^ +26 | / ''' 27 | | Single quotes multiline function docstring 28 | | ''' | |___________^ Q002 -29 | +29 | 30 | some_expression = 'hello world' | = help: Replace single quotes docstring with double quotes @@ -74,6 +72,4 @@ docstring_singles.py:26:9: Q002 [*] Single quote docstring found but double quot 28 |+ """ 29 29 | 30 30 | some_expression = 'hello world' -31 31 | - - +31 31 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_class.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_class.py.snap index da70df063d6e5..b384b9e645f75 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_class.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_class.py.snap @@ -40,7 +40,7 @@ docstring_singles_class.py:6:9: Q002 [*] Single quote docstring found but double docstring_singles_class.py:9:29: Q002 [*] Single quote docstring found but double quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): ''' inline docstring '''; pass | ^^^^^^^^^^^^^^^^^^^^^^^^ Q002 | @@ -52,5 +52,3 @@ docstring_singles_class.py:9:29: Q002 [*] Single quote docstring found but doubl 8 8 | 9 |- class Nested(foo()[:]): ''' inline docstring '''; pass 9 |+ class Nested(foo()[:]): """ inline docstring """; pass - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_function.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_function.py.snap index cad7d15422ec7..5c0f5b436b45a 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_function.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_function.py.snap @@ -22,8 +22,7 @@ docstring_singles_function.py:2:5: Q002 [*] Single quote docstring found but dou docstring_singles_function.py:8:5: Q002 [*] Single quote docstring found but double quotes preferred | 7 | def foo2(): - 8 | ''' - | _____^ + 8 | / ''' 9 | | function without params, multiline docstring 10 | | ''' | |_______^ Q002 @@ -62,5 +61,3 @@ docstring_singles_function.py:27:5: Q002 [*] Single quote docstring found but do 28 28 | 29 29 | 30 30 | def double_inside_single(a): - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_1.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_1.py.snap index 6d3aeaab93d71..d231495a1133c 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_1.py.snap @@ -58,7 +58,7 @@ docstring_singles_mixed_quotes_class_var_1.py:6:37: Q002 [*] Single quote docstr docstring_singles_mixed_quotes_class_var_1.py:9:29: Q002 Single quote docstring found but double quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): ''"Start with empty string" ' and lint docstring safely'; pass | ^^ Q002 | @@ -67,7 +67,7 @@ docstring_singles_mixed_quotes_class_var_1.py:9:29: Q002 Single quote docstring docstring_singles_mixed_quotes_class_var_1.py:9:57: Q002 [*] Single quote docstring found but double quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): ''"Start with empty string" ' and lint docstring safely'; pass | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q002 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_2.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_2.py.snap index 60ecc511e3e13..1346b4f188a99 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_class_var_2.py.snap @@ -76,7 +76,7 @@ docstring_singles_mixed_quotes_class_var_2.py:6:44: Q002 [*] Single quote docstr docstring_singles_mixed_quotes_class_var_2.py:9:29: Q002 [*] Single quote docstring found but double quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): 'Do not'" start with empty string" ' and lint docstring safely'; pass | ^^^^^^^^ Q002 | @@ -92,7 +92,7 @@ docstring_singles_mixed_quotes_class_var_2.py:9:29: Q002 [*] Single quote docstr docstring_singles_mixed_quotes_class_var_2.py:9:64: Q002 [*] Single quote docstring found but double quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): 'Do not'" start with empty string" ' and lint docstring safely'; pass | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q002 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_1.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_1.py.snap index d8a027bcd0919..298bf7a6d184f 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_1.py.snap @@ -5,7 +5,7 @@ docstring_singles_mixed_quotes_module_singleline_var_1.py:1:1: Q002 Single quote | 1 | ''"Start with empty string" ' and lint docstring safely' | ^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace single quotes docstring with double quotes @@ -14,7 +14,7 @@ docstring_singles_mixed_quotes_module_singleline_var_1.py:1:29: Q002 [*] Single | 1 | ''"Start with empty string" ' and lint docstring safely' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace single quotes docstring with double quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_2.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_2.py.snap index 5ffafe0ffd2b6..1faa802f1bb57 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_mixed_quotes_module_singleline_var_2.py.snap @@ -5,7 +5,7 @@ docstring_singles_mixed_quotes_module_singleline_var_2.py:1:1: Q002 [*] Single q | 1 | 'Do not'" start with empty string" ' and lint docstring safely' | ^^^^^^^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace single quotes docstring with double quotes @@ -21,7 +21,7 @@ docstring_singles_mixed_quotes_module_singleline_var_2.py:1:36: Q002 [*] Single | 1 | 'Do not'" start with empty string" ' and lint docstring safely' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace single quotes docstring with double quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_multiline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_multiline.py.snap index 3924f21233c1f..85937832a7bb3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_multiline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_multiline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_singles_module_multiline.py:1:1: Q002 [*] Single quote docstring found but double quotes preferred | @@ -21,5 +22,3 @@ docstring_singles_module_multiline.py:1:1: Q002 [*] Single quote docstring found 4 4 | ''' 5 5 | this is not a docstring 6 6 | ''' - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_singleline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_singleline.py.snap index c1c3012212b24..061a26022396c 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_singleline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_doubles_over_docstring_singles_module_singleline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_singles_module_singleline.py:1:1: Q002 [*] Single quote docstring found but double quotes preferred | @@ -15,5 +16,3 @@ docstring_singles_module_singleline.py:1:1: Q002 [*] Single quote docstring foun 2 2 | ''' this is not a docstring ''' 3 3 | 4 4 | def foo(): - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles.py.snap index 8e031c7aab323..84c7afaab8abd 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles.py.snap @@ -7,7 +7,7 @@ docstring_doubles.py:1:1: Q002 [*] Double quote docstring found but single quote 2 | | Double quotes multiline module docstring 3 | | """ | |___^ Q002 -4 | +4 | 5 | """ | = help: Replace double quotes docstring with single quotes @@ -25,12 +25,11 @@ docstring_doubles.py:1:1: Q002 [*] Double quote docstring found but single quote docstring_doubles.py:12:5: Q002 [*] Double quote docstring found but single quotes preferred | 11 | class Cls: -12 | """ - | _____^ +12 | / """ 13 | | Double quotes multiline class docstring 14 | | """ | |_______^ Q002 -15 | +15 | 16 | """ | = help: Replace double quotes docstring with single quotes @@ -52,12 +51,11 @@ docstring_doubles.py:24:9: Q002 [*] Double quote docstring found but single quot | 22 | definitely not a docstring""", 23 | val=l[Cls():3]): -24 | """ - | _________^ +24 | / """ 25 | | Double quotes multiline function docstring 26 | | """ | |___________^ Q002 -27 | +27 | 28 | some_expression = 'hello world' | = help: Replace double quotes docstring with single quotes @@ -73,6 +71,4 @@ docstring_doubles.py:24:9: Q002 [*] Double quote docstring found but single quot 26 |+ ''' 27 27 | 28 28 | some_expression = 'hello world' -29 29 | - - +29 29 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_class.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_class.py.snap index 18e358b897580..e222557186f39 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_class.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_class.py.snap @@ -40,7 +40,7 @@ docstring_doubles_class.py:6:9: Q002 [*] Double quote docstring found but single docstring_doubles_class.py:9:29: Q002 [*] Double quote docstring found but single quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): """ inline docstring """; pass | ^^^^^^^^^^^^^^^^^^^^^^^^ Q002 | @@ -52,5 +52,3 @@ docstring_doubles_class.py:9:29: Q002 [*] Double quote docstring found but singl 8 8 | 9 |- class Nested(foo()[:]): """ inline docstring """; pass 9 |+ class Nested(foo()[:]): ''' inline docstring '''; pass - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_function.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_function.py.snap index 3758fc2a7bd1b..e33863957c4b6 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_function.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_function.py.snap @@ -22,8 +22,7 @@ docstring_doubles_function.py:2:5: Q002 [*] Double quote docstring found but sin docstring_doubles_function.py:8:5: Q002 [*] Double quote docstring found but single quotes preferred | 7 | def foo2(): - 8 | """ - | _____^ + 8 | / """ 9 | | function without params, multiline docstring 10 | | """ | |_______^ Q002 @@ -62,5 +61,3 @@ docstring_doubles_function.py:27:5: Q002 [*] Double quote docstring found but si 28 28 | 29 29 | 30 30 | def double_inside_single(a): - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_1.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_1.py.snap index 96ccdbd7f484f..34ed1310df5da 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_1.py.snap @@ -22,7 +22,7 @@ docstring_doubles_mixed_quotes_class_var_1.py:6:9: Q002 Double quote docstring f docstring_doubles_mixed_quotes_class_var_1.py:9:29: Q002 Double quote docstring found but single quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): ""'Start with empty string' ' and lint docstring safely'; pass | ^^ Q002 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_2.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_2.py.snap index e02c3c17c1e3e..a9b6c90379e0a 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_class_var_2.py.snap @@ -40,7 +40,7 @@ docstring_doubles_mixed_quotes_class_var_2.py:6:9: Q002 [*] Double quote docstri docstring_doubles_mixed_quotes_class_var_2.py:9:29: Q002 [*] Double quote docstring found but single quotes preferred | 7 | pass -8 | +8 | 9 | class Nested(foo()[:]): "Do not"' start with empty string' ' and lint docstring safely'; pass | ^^^^^^^^ Q002 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_1.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_1.py.snap index df92925a9bd38..e19a8dabb23bc 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_1.py.snap @@ -5,7 +5,7 @@ docstring_doubles_mixed_quotes_module_singleline_var_1.py:1:1: Q002 Double quote | 1 | ""'Start with empty string' ' and lint docstring safely' | ^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace double quotes docstring with single quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_2.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_2.py.snap index 31efd169aff73..81295100babcc 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_mixed_quotes_module_singleline_var_2.py.snap @@ -5,7 +5,7 @@ docstring_doubles_mixed_quotes_module_singleline_var_2.py:1:1: Q002 [*] Double q | 1 | "Do not"' start with empty string' ' and lint docstring safely' | ^^^^^^^^ Q002 -2 | +2 | 3 | def foo(): | = help: Replace double quotes docstring with single quotes diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_multiline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_multiline.py.snap index f66291915dcde..fd73229e290bb 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_multiline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_multiline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_doubles_module_multiline.py:1:1: Q002 [*] Double quote docstring found but single quotes preferred | @@ -21,5 +22,3 @@ docstring_doubles_module_multiline.py:1:1: Q002 [*] Double quote docstring found 4 4 | """ 5 5 | this is not a docstring 6 6 | """ - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_singleline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_singleline.py.snap index 025add5fdd0bc..c474d2eedb7fa 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_singleline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_doubles_module_singleline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_doubles_module_singleline.py:1:1: Q002 [*] Double quote docstring found but single quotes preferred | @@ -15,5 +16,3 @@ docstring_doubles_module_singleline.py:1:1: Q002 [*] Double quote docstring foun 2 2 | """ this is not a docstring """ 3 3 | 4 4 | def foo(): - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles.py.snap index 2a790da62fac4..43c7b6b7f8a7b 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles.py.snap @@ -4,12 +4,12 @@ source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs docstring_singles.py:5:1: Q001 [*] Single quote multiline found but double quotes preferred | 3 | ''' -4 | +4 | 5 | / ''' 6 | | this is not a docstring 7 | | ''' | |___^ Q001 -8 | +8 | 9 | l = [] | = help: Replace single multiline quotes with double quotes @@ -30,7 +30,7 @@ docstring_singles.py:5:1: Q001 [*] Single quote multiline found but double quote docstring_singles.py:11:21: Q001 [*] Single quote multiline found but double quotes preferred | 9 | l = [] -10 | +10 | 11 | class Cls(MakeKlass(''' | _____________________^ 12 | | class params \t not a docstring @@ -57,13 +57,12 @@ docstring_singles.py:11:21: Q001 [*] Single quote multiline found but double quo docstring_singles.py:18:5: Q001 [*] Single quote multiline found but double quotes preferred | 16 | ''' -17 | -18 | ''' - | _____^ +17 | +18 | / ''' 19 | | this is not a docstring 20 | | ''' | |_______^ Q001 -21 | +21 | 22 | # The colon in the list indexing below is an edge case for the docstring scanner | = help: Replace single multiline quotes with double quotes @@ -108,13 +107,12 @@ docstring_singles.py:23:21: Q001 [*] Single quote multiline found but double quo docstring_singles.py:32:9: Q001 [*] Single quote multiline found but double quotes preferred | 30 | some_expression = 'hello world' -31 | -32 | ''' - | _________^ +31 | +32 | / ''' 33 | | this is not a docstring 34 | | ''' | |___________^ Q001 -35 | +35 | 36 | if l: | = help: Replace single multiline quotes with double quotes @@ -135,8 +133,7 @@ docstring_singles.py:32:9: Q001 [*] Single quote multiline found but double quot docstring_singles.py:37:13: Q001 [*] Single quote multiline found but double quotes preferred | 36 | if l: -37 | ''' - | _____________^ +37 | / ''' 38 | | Looks like a docstring, but in reality it isn't - only modules, classes and functions 39 | | ''' | |_______________^ Q001 @@ -154,5 +151,3 @@ docstring_singles.py:37:13: Q001 [*] Single quote multiline found but double quo 39 |- ''' 39 |+ """ 40 40 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_class.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_class.py.snap index a3a5bcf66ec88..d94db3e564b7c 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_class.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_class.py.snap @@ -7,7 +7,7 @@ docstring_singles_class.py:3:5: Q001 [*] Single quote multiline found but double 2 | ''' Double quotes single line class docstring ''' 3 | ''' Not a docstring ''' | ^^^^^^^^^^^^^^^^^^^^^^^ Q001 -4 | +4 | 5 | def foo(self, bar='''not a docstring'''): | = help: Replace single multiline quotes with double quotes @@ -24,7 +24,7 @@ docstring_singles_class.py:3:5: Q001 [*] Single quote multiline found but double docstring_singles_class.py:5:23: Q001 [*] Single quote multiline found but double quotes preferred | 3 | ''' Not a docstring ''' -4 | +4 | 5 | def foo(self, bar='''not a docstring'''): | ^^^^^^^^^^^^^^^^^^^^^ Q001 6 | ''' Double quotes single line method docstring''' @@ -40,6 +40,4 @@ docstring_singles_class.py:5:23: Q001 [*] Single quote multiline found but doubl 5 |+ def foo(self, bar="""not a docstring"""): 6 6 | ''' Double quotes single line method docstring''' 7 7 | pass -8 8 | - - +8 8 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_function.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_function.py.snap index afede01c5e111..252740c4f48a4 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_function.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_function.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_singles_function.py:3:5: Q001 [*] Single quote multiline found but double quotes preferred | @@ -101,6 +102,4 @@ docstring_singles_function.py:22:5: Q001 [*] Single quote multiline found but do 22 |+ """ not a docstring """): 23 23 | pass 24 24 | -25 25 | - - +25 25 | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_multiline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_multiline.py.snap index 3cefd7eb4a27a..157f519253355 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_multiline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_multiline.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- docstring_singles_module_multiline.py:4:1: Q001 [*] Single quote multiline found but double quotes preferred | @@ -47,5 +48,3 @@ docstring_singles_module_multiline.py:9:1: Q001 [*] Single quote multiline found 10 10 | this is not a docstring 11 |-''' 11 |+""" - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_singleline.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_singleline.py.snap index f92fff71dba70..85b17d1d403bb 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_singleline.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_docstring_singles_over_docstring_singles_module_singleline.py.snap @@ -6,7 +6,7 @@ docstring_singles_module_singleline.py:2:1: Q001 [*] Single quote multiline foun 1 | ''' Double quotes singleline module docstring ''' 2 | ''' this is not a docstring ''' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q001 -3 | +3 | 4 | def foo(): | = help: Replace single multiline quotes with double quotes @@ -34,5 +34,3 @@ docstring_singles_module_singleline.py:6:1: Q001 [*] Single quote multiline foun 5 5 | pass 6 |-''' this is not a docstring ''' 6 |+""" this is not a docstring """ - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles.py.snap index 81b0fdf4da700..779e8c13794ae 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- singles.py:1:25: Q000 [*] Single quotes found but double quotes preferred | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped.py.snap index 4cc1920e73b72..a1099a8e0b323 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped.py.snap @@ -124,7 +124,7 @@ singles_escaped.py:33:1: Q003 [*] Change outer quotes to avoid escaping inner qu 32 | f"\"foo\" {f"foo"}" # Q003 33 | f"\"foo\" {f"\"foo\""} \"\"" # Q003 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q003 -34 | +34 | 35 | f"normal {f"nested"} normal" | = help: Change outer quotes to avoid escaping inner quotes @@ -145,7 +145,7 @@ singles_escaped.py:33:12: Q003 [*] Change outer quotes to avoid escaping inner q 32 | f"\"foo\" {f"foo"}" # Q003 33 | f"\"foo\" {f"\"foo\""} \"\"" # Q003 | ^^^^^^^^^^ Q003 -34 | +34 | 35 | f"normal {f"nested"} normal" | = help: Change outer quotes to avoid escaping inner quotes @@ -213,5 +213,3 @@ singles_escaped.py:39:1: Q003 [*] Change outer quotes to avoid escaping inner qu 38 38 | f"\"normal\" {f"\"nested\" {"other"} normal"} 'single quotes'" # Q003 39 |-f"\"normal\" {f"\"nested\" {"other"} 'single quotes'"} normal" # Q003 39 |+f'"normal" {f"\"nested\" {"other"} 'single quotes'"} normal' # Q003 - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_py311.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_py311.snap index e3d039ba634e7..0ca32efbb5702 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_py311.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_py311.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- singles_escaped.py:1:26: Q003 [*] Change outer quotes to avoid escaping inner quotes | @@ -76,5 +77,3 @@ singles_escaped.py:21:5: Q003 [*] Change outer quotes to avoid escaping inner qu 22 22 | ) 23 23 | 24 24 | # Nested f-strings (Python 3.12+) - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_unnecessary.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_unnecessary.py.snap index 5408f3962565a..71e3d38d97115 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_unnecessary.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_escaped_unnecessary.py.snap @@ -163,7 +163,7 @@ singles_escaped_unnecessary.py:33:1: Q004 [*] Unnecessary escape on inner quote 32 | f"\'foo\' {f"foo"}" # Q004 33 | f"\'foo\' {f"\'foo\'"} \'\'" # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -34 | +34 | 35 | f"normal {f"nested"} normal" | = help: Remove backslash @@ -184,7 +184,7 @@ singles_escaped_unnecessary.py:33:12: Q004 [*] Unnecessary escape on inner quote 32 | f"\'foo\' {f"foo"}" # Q004 33 | f"\'foo\' {f"\'foo\'"} \'\'" # Q004 | ^^^^^^^^^^ Q004 -34 | +34 | 35 | f"normal {f"nested"} normal" | = help: Remove backslash @@ -286,7 +286,7 @@ singles_escaped_unnecessary.py:39:1: Q004 [*] Unnecessary escape on inner quote 38 | f"\'normal\' {f"\'nested\' {"other"} normal"} 'single quotes'" # Q004 39 | f"\'normal\' {f"\'nested\' {"other"} 'single quotes'"} normal" # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -40 | +40 | 41 | # Make sure we do not unescape quotes | = help: Remove backslash @@ -307,7 +307,7 @@ singles_escaped_unnecessary.py:39:15: Q004 [*] Unnecessary escape on inner quote 38 | f"\'normal\' {f"\'nested\' {"other"} normal"} 'single quotes'" # Q004 39 | f"\'normal\' {f"\'nested\' {"other"} 'single quotes'"} normal" # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -40 | +40 | 41 | # Make sure we do not unescape quotes | = help: Remove backslash @@ -328,7 +328,7 @@ singles_escaped_unnecessary.py:43:26: Q004 [*] Unnecessary escape on inner quote 42 | this_is_fine = "This is an \\'escaped\\' quote" 43 | this_should_raise_Q004 = "This is an \\\'escaped\\\' quote with an extra backslash" # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -44 | +44 | 45 | # Invalid escapes in bytestrings are also triggered: | = help: Remove backslash diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_implicit.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_implicit.py.snap index e85c35c669cf9..a3e6dd40bf2d6 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_implicit.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_implicit.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- singles_implicit.py:2:5: Q000 [*] Single quotes found but double quotes preferred | @@ -135,5 +136,3 @@ singles_implicit.py:27:1: Q000 [*] Single quotes found but double quotes preferr 26 26 | 'This can use "single" quotes' 27 |-'But this needs to be changed' 27 |+"But this needs to be changed" - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_multiline_string.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_multiline_string.py.snap index 3fdadee4d83e4..d926ca1c410d2 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_multiline_string.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_multiline_string.py.snap @@ -8,7 +8,7 @@ singles_multiline_string.py:1:5: Q001 [*] Single quote multiline found but doubl 2 | | be 3 | | 'linted' ''' | |____________^ Q001 -4 | +4 | 5 | s = """ This 'should' | = help: Replace single multiline quotes with double quotes @@ -22,5 +22,3 @@ singles_multiline_string.py:1:5: Q001 [*] Single quote multiline found but doubl 4 4 | 5 5 | s = """ This 'should' 6 6 | 'not' be - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_noqa.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_noqa.py.snap index a5e579090a84a..81b913df5dcd3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_noqa.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_noqa.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_would_be_triple_quotes.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_would_be_triple_quotes.py.snap index 3c5b35cd44202..6d78f8e99267c 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_would_be_triple_quotes.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_would_be_triple_quotes.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- singles_would_be_triple_quotes.py:1:5: Q000 Single quotes found but double quotes preferred | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_wrapped.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_wrapped.py.snap index a5e579090a84a..81b913df5dcd3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_wrapped.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_doubles_over_singles_wrapped.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles.py.snap index 594f620909e59..6ff83707952a2 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- doubles.py:1:25: Q000 [*] Double quotes found but single quotes preferred | @@ -50,5 +51,3 @@ doubles.py:3:25: Q000 [*] Double quotes found but single quotes preferred 3 |-this_should_be_linted = f"double quote string" 3 |+this_should_be_linted = f'double quote string' 4 4 | this_should_be_linted = f"double {'quote'} string" - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped.py.snap index e93b1aab9a1b3..feff195fb7e75 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped.py.snap @@ -163,7 +163,7 @@ doubles_escaped.py:35:1: Q003 [*] Change outer quotes to avoid escaping inner qu 34 | f'\'foo\' {f'nested'}' # Q003 35 | f'\'foo\' {f'\'nested\''} \'\'' # Q003 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q003 -36 | +36 | 37 | f'normal {f'nested'} normal' | = help: Change outer quotes to avoid escaping inner quotes @@ -184,7 +184,7 @@ doubles_escaped.py:35:12: Q003 [*] Change outer quotes to avoid escaping inner q 34 | f'\'foo\' {f'nested'}' # Q003 35 | f'\'foo\' {f'\'nested\''} \'\'' # Q003 | ^^^^^^^^^^^^^ Q003 -36 | +36 | 37 | f'normal {f'nested'} normal' | = help: Change outer quotes to avoid escaping inner quotes @@ -252,5 +252,3 @@ doubles_escaped.py:41:1: Q003 [*] Change outer quotes to avoid escaping inner qu 40 40 | f'\'normal\' {f'\'nested\' {'other'} normal'} "double quotes"' # Q003 41 |-f'\'normal\' {f'\'nested\' {'other'} "double quotes"'} normal' # Q00l 41 |+f"'normal' {f'\'nested\' {'other'} "double quotes"'} normal" # Q00l - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_py311.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_py311.snap index 375eaacc4625e..f6768a4b6fde0 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_py311.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_py311.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- doubles_escaped.py:1:26: Q003 [*] Change outer quotes to avoid escaping inner quotes | @@ -115,5 +116,3 @@ doubles_escaped.py:23:5: Q003 [*] Change outer quotes to avoid escaping inner qu 24 24 | ) 25 25 | 26 26 | # Nested f-strings (Python 3.12+) - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_unnecessary.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_unnecessary.py.snap index 4e7c09e9cd981..3cf6da94bb002 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_unnecessary.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_escaped_unnecessary.py.snap @@ -204,7 +204,7 @@ doubles_escaped_unnecessary.py:35:1: Q004 [*] Unnecessary escape on inner quote 34 | f'\"foo\" {f'nested'}' # Q004 35 | f'\"foo\" {f'\"nested\"'} \"\"' # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -36 | +36 | 37 | f'normal {f'nested'} normal' | = help: Remove backslash @@ -225,7 +225,7 @@ doubles_escaped_unnecessary.py:35:12: Q004 [*] Unnecessary escape on inner quote 34 | f'\"foo\" {f'nested'}' # Q004 35 | f'\"foo\" {f'\"nested\"'} \"\"' # Q004 | ^^^^^^^^^^^^^ Q004 -36 | +36 | 37 | f'normal {f'nested'} normal' | = help: Remove backslash @@ -327,7 +327,7 @@ doubles_escaped_unnecessary.py:41:1: Q004 [*] Unnecessary escape on inner quote 40 | f'\"normal\" {f'\"nested\" {'other'} normal'} "double quotes"' # Q004 41 | f'\"normal\" {f'\"nested\" {'other'} "double quotes"'} normal' # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -42 | +42 | 43 | # Make sure we do not unescape quotes | = help: Remove backslash @@ -348,7 +348,7 @@ doubles_escaped_unnecessary.py:41:15: Q004 [*] Unnecessary escape on inner quote 40 | f'\"normal\" {f'\"nested\" {'other'} normal'} "double quotes"' # Q004 41 | f'\"normal\" {f'\"nested\" {'other'} "double quotes"'} normal' # Q004 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Q004 -42 | +42 | 43 | # Make sure we do not unescape quotes | = help: Remove backslash @@ -378,5 +378,3 @@ doubles_escaped_unnecessary.py:45:26: Q004 [*] Unnecessary escape on inner quote 44 44 | this_is_fine = 'This is an \\"escaped\\" quote' 45 |-this_should_raise_Q004 = 'This is an \\\"escaped\\\" quote with an extra backslash' 45 |+this_should_raise_Q004 = 'This is an \\"escaped\\" quote with an extra backslash' - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_implicit.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_implicit.py.snap index a44c07a17cf94..d5b4db8f2822f 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_implicit.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_implicit.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- doubles_implicit.py:2:5: Q000 [*] Double quotes found but single quotes preferred | @@ -135,5 +136,3 @@ doubles_implicit.py:27:1: Q000 [*] Double quotes found but single quotes preferr 26 26 | "This can use 'double' quotes" 27 |-"But this needs to be changed" 27 |+'But this needs to be changed' - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_multiline_string.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_multiline_string.py.snap index bb0ef317cba48..7d40683d00973 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_multiline_string.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_multiline_string.py.snap @@ -8,7 +8,7 @@ doubles_multiline_string.py:1:5: Q001 [*] Double quote multiline found but singl 2 | | be 3 | | "linted" """ | |____________^ Q001 -4 | +4 | 5 | s = ''' This "should" | = help: Replace double multiline quotes with single quotes @@ -22,5 +22,3 @@ doubles_multiline_string.py:1:5: Q001 [*] Double quote multiline found but singl 4 4 | 5 5 | s = ''' This "should" 6 6 | "not" be - - diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_noqa.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_noqa.py.snap index a5e579090a84a..81b913df5dcd3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_noqa.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_noqa.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_would_be_triple_quotes.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_would_be_triple_quotes.py.snap index 031164bad78ba..5d48f06a35675 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_would_be_triple_quotes.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_would_be_triple_quotes.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- doubles_would_be_triple_quotes.py:1:5: Q000 Double quotes found but single quotes preferred | diff --git a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_wrapped.py.snap b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_wrapped.py.snap index a5e579090a84a..81b913df5dcd3 100644 --- a/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_wrapped.py.snap +++ b/crates/ruff_linter/src/rules/flake8_quotes/snapshots/ruff_linter__rules__flake8_quotes__tests__require_singles_over_doubles_wrapped.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_quotes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_raise/rules/unnecessary_paren_on_raise_exception.rs b/crates/ruff_linter/src/rules/flake8_raise/rules/unnecessary_paren_on_raise_exception.rs index 0c9e2477fce26..36d8c996d656a 100644 --- a/crates/ruff_linter/src/rules/flake8_raise/rules/unnecessary_paren_on_raise_exception.rs +++ b/crates/ruff_linter/src/rules/flake8_raise/rules/unnecessary_paren_on_raise_exception.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::BindingKind; use ruff_text_size::Ranged; @@ -38,22 +38,22 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#the-raise-statement) -#[violation] -pub struct UnnecessaryParenOnRaiseException; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryParenOnRaiseException; impl AlwaysFixableViolation for UnnecessaryParenOnRaiseException { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary parentheses on raised exception") + "Unnecessary parentheses on raised exception".to_string() } fn fix_title(&self) -> String { - format!("Remove unnecessary parentheses") + "Remove unnecessary parentheses".to_string() } } /// RSE102 -pub(crate) fn unnecessary_paren_on_raise_exception(checker: &mut Checker, expr: &Expr) { +pub(crate) fn unnecessary_paren_on_raise_exception(checker: &Checker, expr: &Expr) { let Expr::Call(ast::ExprCall { func, arguments, @@ -141,7 +141,7 @@ pub(crate) fn unnecessary_paren_on_raise_exception(checker: &mut Checker, expr: )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_raise/snapshots/ruff_linter__rules__flake8_raise__tests__unnecessary-paren-on-raise-exception_RSE102.py.snap b/crates/ruff_linter/src/rules/flake8_raise/snapshots/ruff_linter__rules__flake8_raise__tests__unnecessary-paren-on-raise-exception_RSE102.py.snap index d0dd2b4084b53..80d7448df1fca 100644 --- a/crates/ruff_linter/src/rules/flake8_raise/snapshots/ruff_linter__rules__flake8_raise__tests__unnecessary-paren-on-raise-exception_RSE102.py.snap +++ b/crates/ruff_linter/src/rules/flake8_raise/snapshots/ruff_linter__rules__flake8_raise__tests__unnecessary-paren-on-raise-exception_RSE102.py.snap @@ -7,7 +7,7 @@ RSE102.py:5:21: RSE102 [*] Unnecessary parentheses on raised exception 4 | # RSE102 5 | raise ValueError() | ^^ RSE102 -6 | +6 | 7 | try: | = help: Remove unnecessary parentheses @@ -27,7 +27,7 @@ RSE102.py:13:16: RSE102 [*] Unnecessary parentheses on raised exception 12 | # RSE102 13 | raise TypeError() | ^^ RSE102 -14 | +14 | 15 | # RSE102 | = help: Remove unnecessary parentheses @@ -47,7 +47,7 @@ RSE102.py:16:17: RSE102 [*] Unnecessary parentheses on raised exception 15 | # RSE102 16 | raise TypeError () | ^^ RSE102 -17 | +17 | 18 | # RSE102 | = help: Remove unnecessary parentheses @@ -68,7 +68,7 @@ RSE102.py:20:5: RSE102 [*] Unnecessary parentheses on raised exception 19 | raise TypeError \ 20 | () | ^^ RSE102 -21 | +21 | 22 | # RSE102 | = help: Remove unnecessary parentheses @@ -89,7 +89,7 @@ RSE102.py:24:5: RSE102 [*] Unnecessary parentheses on raised exception 23 | raise TypeError \ 24 | (); | ^^ RSE102 -25 | +25 | 26 | # RSE102 | = help: Remove unnecessary parentheses @@ -109,10 +109,10 @@ RSE102.py:27:16: RSE102 [*] Unnecessary parentheses on raised exception 26 | # RSE102 27 | raise TypeError( | ________________^ -28 | | +28 | | 29 | | ) | |_^ RSE102 -30 | +30 | 31 | # RSE102 | = help: Remove unnecessary parentheses @@ -134,10 +134,10 @@ RSE102.py:32:19: RSE102 [*] Unnecessary parentheses on raised exception 31 | # RSE102 32 | raise (TypeError) ( | ___________________^ -33 | | +33 | | 34 | | ) | |_^ RSE102 -35 | +35 | 36 | # RSE102 | = help: Remove unnecessary parentheses @@ -162,7 +162,7 @@ RSE102.py:37:16: RSE102 [*] Unnecessary parentheses on raised exception 38 | | # Hello, world! 39 | | ) | |_^ RSE102 -40 | +40 | 41 | # OK | = help: Remove unnecessary parentheses @@ -184,7 +184,7 @@ RSE102.py:74:17: RSE102 [*] Unnecessary parentheses on raised exception 73 | # RSE102 74 | raise IndexError()from ZeroDivisionError | ^^ RSE102 -75 | +75 | 76 | raise IndexError()\ | = help: Remove unnecessary parentheses @@ -202,7 +202,7 @@ RSE102.py:74:17: RSE102 [*] Unnecessary parentheses on raised exception RSE102.py:76:17: RSE102 [*] Unnecessary parentheses on raised exception | 74 | raise IndexError()from ZeroDivisionError -75 | +75 | 76 | raise IndexError()\ | ^^ RSE102 77 | from ZeroDivisionError @@ -222,10 +222,10 @@ RSE102.py:76:17: RSE102 [*] Unnecessary parentheses on raised exception RSE102.py:79:17: RSE102 [*] Unnecessary parentheses on raised exception | 77 | from ZeroDivisionError -78 | +78 | 79 | raise IndexError() from ZeroDivisionError | ^^ RSE102 -80 | +80 | 81 | raise IndexError(); | = help: Remove unnecessary parentheses @@ -243,10 +243,10 @@ RSE102.py:79:17: RSE102 [*] Unnecessary parentheses on raised exception RSE102.py:81:17: RSE102 [*] Unnecessary parentheses on raised exception | 79 | raise IndexError() from ZeroDivisionError -80 | +80 | 81 | raise IndexError(); | ^^ RSE102 -82 | +82 | 83 | # RSE102 | = help: Remove unnecessary parentheses @@ -266,7 +266,7 @@ RSE102.py:84:10: RSE102 [*] Unnecessary parentheses on raised exception 83 | # RSE102 84 | raise Foo() | ^^ RSE102 -85 | +85 | 86 | # OK | = help: Remove unnecessary parentheses diff --git a/crates/ruff_linter/src/rules/flake8_return/mod.rs b/crates/ruff_linter/src/rules/flake8_return/mod.rs index 42eb65ff28043..8876e2b5a306d 100644 --- a/crates/ruff_linter/src/rules/flake8_return/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_return/mod.rs @@ -12,8 +12,8 @@ mod tests { use test_case::test_case; use crate::registry::Rule; - use crate::settings::types::PreviewMode; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; diff --git a/crates/ruff_linter/src/rules/flake8_return/rules/function.rs b/crates/ruff_linter/src/rules/flake8_return/rules/function.rs index 491de3e7e599d..b4b6d920d1794 100644 --- a/crates/ruff_linter/src/rules/flake8_return/rules/function.rs +++ b/crates/ruff_linter/src/rules/flake8_return/rules/function.rs @@ -4,7 +4,7 @@ use anyhow::Result; use ruff_diagnostics::{AlwaysFixableViolation, FixAvailability, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::{is_const_false, is_const_true}; use ruff_python_ast::stmt_if::elif_else_range; use ruff_python_ast::visitor::Visitor; @@ -12,18 +12,19 @@ use ruff_python_ast::whitespace::indentation; use ruff_python_ast::{self as ast, Decorator, ElifElseClause, Expr, Stmt}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; -use ruff_python_semantic::analyze::visibility::is_property; use ruff_python_semantic::SemanticModel; -use ruff_python_trivia::{is_python_whitespace, SimpleTokenKind, SimpleTokenizer}; +use ruff_python_semantic::analyze::visibility::is_property; +use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer, is_python_whitespace}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::edits; use crate::fix::edits::adjust_indentation; +use crate::preview::is_only_add_return_none_at_end_enabled; use crate::registry::{AsRule, Rule}; use crate::rules::flake8_return::helpers::end_of_last_statement; -use crate::Locator; use super::super::branch::Branch; use super::super::helpers::result_exists; @@ -54,15 +55,14 @@ use super::super::visitor::{ReturnVisitor, Stack}; /// return /// return /// ``` -#[violation] -pub struct UnnecessaryReturnNone; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryReturnNone; impl AlwaysFixableViolation for UnnecessaryReturnNone { #[derive_message_formats] fn message(&self) -> String { - format!( - "Do not explicitly `return None` in function if it is the only possible return value" - ) + "Do not explicitly `return None` in function if it is the only possible return value" + .to_string() } fn fix_title(&self) -> String { @@ -96,13 +96,13 @@ impl AlwaysFixableViolation for UnnecessaryReturnNone { /// return None /// return 1 /// ``` -#[violation] -pub struct ImplicitReturnValue; +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitReturnValue; impl AlwaysFixableViolation for ImplicitReturnValue { #[derive_message_formats] fn message(&self) -> String { - format!("Do not implicitly `return None` in function able to return non-`None` value") + "Do not implicitly `return None` in function able to return non-`None` value".to_string() } fn fix_title(&self) -> String { @@ -134,13 +134,14 @@ impl AlwaysFixableViolation for ImplicitReturnValue { /// return 1 /// return None /// ``` -#[violation] -pub struct ImplicitReturn; +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitReturn; impl AlwaysFixableViolation for ImplicitReturn { #[derive_message_formats] fn message(&self) -> String { - format!("Missing explicit `return` at the end of function able to return non-`None` value") + "Missing explicit `return` at the end of function able to return non-`None` value" + .to_string() } fn fix_title(&self) -> String { @@ -168,8 +169,8 @@ impl AlwaysFixableViolation for ImplicitReturn { /// def foo(): /// return 1 /// ``` -#[violation] -pub struct UnnecessaryAssign { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryAssign { name: String, } @@ -210,8 +211,8 @@ impl AlwaysFixableViolation for UnnecessaryAssign { /// return 1 /// return baz /// ``` -#[violation] -pub struct SuperfluousElseReturn { +#[derive(ViolationMetadata)] +pub(crate) struct SuperfluousElseReturn { branch: Branch, } @@ -254,8 +255,8 @@ impl Violation for SuperfluousElseReturn { /// raise Exception(bar) /// raise Exception(baz) /// ``` -#[violation] -pub struct SuperfluousElseRaise { +#[derive(ViolationMetadata)] +pub(crate) struct SuperfluousElseRaise { branch: Branch, } @@ -300,8 +301,8 @@ impl Violation for SuperfluousElseRaise { /// continue /// x = 0 /// ``` -#[violation] -pub struct SuperfluousElseContinue { +#[derive(ViolationMetadata)] +pub(crate) struct SuperfluousElseContinue { branch: Branch, } @@ -346,8 +347,8 @@ impl Violation for SuperfluousElseContinue { /// break /// x = 0 /// ``` -#[violation] -pub struct SuperfluousElseBreak { +#[derive(ViolationMetadata)] +pub(crate) struct SuperfluousElseBreak { branch: Branch, } @@ -366,7 +367,7 @@ impl Violation for SuperfluousElseBreak { } /// RET501 -fn unnecessary_return_none(checker: &mut Checker, decorator_list: &[Decorator], stack: &Stack) { +fn unnecessary_return_none(checker: &Checker, decorator_list: &[Decorator], stack: &Stack) { for stmt in &stack.returns { let Some(expr) = stmt.value.as_deref() else { continue; @@ -389,12 +390,12 @@ fn unnecessary_return_none(checker: &mut Checker, decorator_list: &[Decorator], "return".to_string(), stmt.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// RET502 -fn implicit_return_value(checker: &mut Checker, stack: &Stack) { +fn implicit_return_value(checker: &Checker, stack: &Stack) { for stmt in &stack.returns { if stmt.value.is_some() { continue; @@ -404,7 +405,7 @@ fn implicit_return_value(checker: &mut Checker, stack: &Stack) { "return None".to_string(), stmt.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -450,9 +451,10 @@ fn is_noreturn_func(func: &Expr, semantic: &SemanticModel) -> bool { }; semantic.match_typing_qualified_name(&qualified_name, "NoReturn") + || semantic.match_typing_qualified_name(&qualified_name, "Never") } -fn add_return_none(checker: &mut Checker, stmt: &Stmt, range: TextRange) { +fn add_return_none(checker: &Checker, stmt: &Stmt, range: TextRange) { let mut diagnostic = Diagnostic::new(ImplicitReturn, range); if let Some(indent) = indentation(checker.source(), stmt) { let mut content = String::new(); @@ -464,7 +466,7 @@ fn add_return_none(checker: &mut Checker, stmt: &Stmt, range: TextRange) { end_of_last_statement(stmt, checker.locator()), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns a list of all implicit returns in the given statement. @@ -544,14 +546,14 @@ fn implicit_returns<'a>(checker: &Checker, stmt: &'a Stmt) -> Vec<&'a Stmt> { } /// RET503 -fn implicit_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef, stmt: &Stmt) { +fn implicit_return(checker: &Checker, function_def: &ast::StmtFunctionDef, stmt: &Stmt) { let implicit_stmts = implicit_returns(checker, stmt); if implicit_stmts.is_empty() { return; } - if checker.settings.preview.is_enabled() { + if is_only_add_return_none_at_end_enabled(checker.settings) { add_return_none(checker, stmt, function_def.range()); } else { for implicit_stmt in implicit_stmts { @@ -561,7 +563,7 @@ fn implicit_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef, s } /// RET504 -fn unnecessary_assign(checker: &mut Checker, stack: &Stack) { +fn unnecessary_assign(checker: &Checker, stack: &Stack) { for (assign, return_, stmt) in &stack.assignment_return { // Identify, e.g., `return x`. let Some(value) = return_.value.as_ref() else { @@ -650,13 +652,13 @@ fn unnecessary_assign(checker: &mut Checker, stack: &Stack) { Ok(Fix::unsafe_edits(replace_assign, [delete_return])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// RET505, RET506, RET507, RET508 fn superfluous_else_node( - checker: &mut Checker, + checker: &Checker, if_elif_body: &[Stmt], elif_else: &ElifElseClause, ) -> bool { @@ -672,7 +674,7 @@ fn superfluous_else_node( elif_else_range(elif_else, checker.locator().contents()) .unwrap_or_else(|| elif_else.range()), ); - if checker.enabled(diagnostic.kind.rule()) { + if checker.enabled(diagnostic.rule()) { diagnostic.try_set_fix(|| { remove_else( elif_else, @@ -681,7 +683,7 @@ fn superfluous_else_node( checker.stylist(), ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } return true; } else if child.is_break_stmt() { @@ -690,7 +692,7 @@ fn superfluous_else_node( elif_else_range(elif_else, checker.locator().contents()) .unwrap_or_else(|| elif_else.range()), ); - if checker.enabled(diagnostic.kind.rule()) { + if checker.enabled(diagnostic.rule()) { diagnostic.try_set_fix(|| { remove_else( elif_else, @@ -700,7 +702,7 @@ fn superfluous_else_node( ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } return true; } else if child.is_raise_stmt() { @@ -709,7 +711,7 @@ fn superfluous_else_node( elif_else_range(elif_else, checker.locator().contents()) .unwrap_or_else(|| elif_else.range()), ); - if checker.enabled(diagnostic.kind.rule()) { + if checker.enabled(diagnostic.rule()) { diagnostic.try_set_fix(|| { remove_else( elif_else, @@ -719,7 +721,7 @@ fn superfluous_else_node( ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } return true; } else if child.is_continue_stmt() { @@ -728,7 +730,7 @@ fn superfluous_else_node( elif_else_range(elif_else, checker.locator().contents()) .unwrap_or_else(|| elif_else.range()), ); - if checker.enabled(diagnostic.kind.rule()) { + if checker.enabled(diagnostic.rule()) { diagnostic.try_set_fix(|| { remove_else( elif_else, @@ -738,7 +740,7 @@ fn superfluous_else_node( ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } return true; } @@ -747,14 +749,14 @@ fn superfluous_else_node( } /// RET505, RET506, RET507, RET508 -fn superfluous_elif_else(checker: &mut Checker, stack: &Stack) { +fn superfluous_elif_else(checker: &Checker, stack: &Stack) { for (if_elif_body, elif_else) in &stack.elifs_elses { superfluous_else_node(checker, if_elif_body, elif_else); } } /// Run all checks from the `flake8-return` plugin. -pub(crate) fn function(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn function(checker: &Checker, function_def: &ast::StmtFunctionDef) { let ast::StmtFunctionDef { decorator_list, returns, @@ -816,7 +818,7 @@ pub(crate) fn function(checker: &mut Checker, function_def: &ast::StmtFunctionDe } else { if checker.enabled(Rule::UnnecessaryReturnNone) { // Skip functions that have a return annotation that is not `None`. - if returns.as_deref().map_or(true, Expr::is_none_literal_expr) { + if returns.as_deref().is_none_or(Expr::is_none_literal_expr) { unnecessary_return_none(checker, decorator_list, &stack); } } diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET501_RET501.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET501_RET501.py.snap index 889492cab6623..0dcc8a8491d50 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET501_RET501.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET501_RET501.py.snap @@ -26,7 +26,7 @@ RET501.py:14:9: RET501 [*] Do not explicitly `return None` in function if it is 13 | print(f"{key} not found") 14 | return None | ^^^^^^^^^^^ RET501 -15 | +15 | 16 | @property | = help: Remove explicit `return None` diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET502_RET502.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET502_RET502.py.snap index 01d5a439dbaab..8006570b6d06f 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET502_RET502.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET502_RET502.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_return/mod.rs +snapshot_kind: text --- RET502.py:3:9: RET502 [*] Do not implicitly `return None` in function able to return non-`None` value | @@ -18,6 +19,4 @@ RET502.py:3:9: RET502 [*] Do not implicitly `return None` in function able to re 3 |+ return None # error 4 4 | return 1 5 5 | -6 6 | - - +6 6 | diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET503_RET503.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET503_RET503.py.snap index 38a77815302b1..af2cbb50470d3 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET503_RET503.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET503_RET503.py.snap @@ -5,8 +5,7 @@ RET503.py:21:5: RET503 [*] Missing explicit `return` at the end of function able | 19 | # if/elif/else 20 | def x(y): -21 | if not y: - | _____^ +21 | / if not y: 22 | | return 1 | |________________^ RET503 23 | # error @@ -45,7 +44,7 @@ RET503.py:28:9: RET503 [*] Missing explicit `return` at the end of function able RET503.py:37:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 35 | return 1 -36 | +36 | 37 | print() # error | ^^^^^^^ RET503 | @@ -64,8 +63,7 @@ RET503.py:42:5: RET503 [*] Missing explicit `return` at the end of function able | 40 | # for 41 | def x(y): -42 | for i in range(10): - | _____^ +42 | / for i in range(10): 43 | | if i > 10: 44 | | return i | |____________________^ RET503 @@ -140,8 +138,7 @@ RET503.py:83:5: RET503 [*] Missing explicit `return` at the end of function able | 81 | # last line in while loop 82 | def x(y): -83 | while i > 0: - | _____^ +83 | / while i > 0: 84 | | if y > 0: 85 | | return 1 86 | | y += 1 @@ -162,8 +159,7 @@ RET503.py:114:5: RET503 [*] Missing explicit `return` at the end of function abl | 112 | # return value within loop 113 | def bar1(x, y, z): -114 | for i in x: - | _____^ +114 | / for i in x: 115 | | if i > y: 116 | | break 117 | | return z @@ -183,8 +179,7 @@ RET503.py:114:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:121:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 120 | def bar3(x, y, z): -121 | for i in x: - | _____^ +121 | / for i in x: 122 | | if i > y: 123 | | if z: 124 | | break @@ -207,8 +202,7 @@ RET503.py:121:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:131:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 130 | def bar1(x, y, z): -131 | for i in x: - | _____^ +131 | / for i in x: 132 | | if i < y: 133 | | continue 134 | | return z @@ -228,8 +222,7 @@ RET503.py:131:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:138:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 137 | def bar3(x, y, z): -138 | for i in x: - | _____^ +138 | / for i in x: 139 | | if i < y: 140 | | if z: 141 | | continue @@ -252,9 +245,8 @@ RET503.py:138:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:275:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 273 | return False -274 | -275 | for value in values: - | _____^ +274 | +275 | / for value in values: 276 | | print(value) | |____________________^ RET503 | @@ -291,8 +283,7 @@ RET503.py:301:9: RET503 [*] Missing explicit `return` at the end of function abl | 299 | def end_of_statement(): 300 | def example(): -301 | if True: - | _________^ +301 | / if True: 302 | | return "" | |_____________________^ RET503 | @@ -310,8 +301,7 @@ RET503.py:301:9: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:306:9: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 305 | def example(): -306 | if True: - | _________^ +306 | / if True: 307 | | return "" | |_____________________^ RET503 | @@ -329,8 +319,7 @@ RET503.py:306:9: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:311:9: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 310 | def example(): -311 | if True: - | _________^ +311 | / if True: 312 | | return "" # type: ignore | |_____________________^ RET503 | @@ -348,8 +337,7 @@ RET503.py:311:9: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:316:9: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 315 | def example(): -316 | if True: - | _________^ +316 | / if True: 317 | | return "" ; | |_____________________^ RET503 | @@ -367,8 +355,7 @@ RET503.py:316:9: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:321:9: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 320 | def example(): -321 | if True: - | _________^ +321 | / if True: 322 | | return "" \ | |_____________________^ RET503 323 | ; # type: ignore @@ -402,71 +389,37 @@ RET503.py:329:5: RET503 [*] Missing explicit `return` at the end of function abl 332 333 | 333 334 | # function return type annotation NoReturn -RET503.py:339:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value +RET503.py:403:13: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -337 | if x == 5: -338 | return 5 -339 | bar() - | ^^^^^ RET503 - | - = help: Add explicit `return` statement - -ℹ Unsafe fix -337 337 | if x == 5: -338 338 | return 5 -339 339 | bar() - 340 |+ return None -340 341 | -341 342 | -342 343 | def foo(string: str) -> str: - -RET503.py:354:13: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -352 | return "third" -353 | case _: -354 | raises(string) - | ^^^^^^^^^^^^^^ RET503 +401 | else: +402 | with c: +403 | d + | ^ RET503 | = help: Add explicit `return` statement ℹ Unsafe fix -352 352 | return "third" -353 353 | case _: -354 354 | raises(string) - 355 |+ return None -355 356 | -356 357 | -357 358 | def foo() -> int: - -RET503.py:370:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -368 | if baz() > 3: -369 | return 1 -370 | bar() +401 401 | else: +402 402 | with c: +403 403 | d + 404 |+ return None +404 405 | +405 406 | +406 407 | + +RET503.py:418:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value + | +416 | if x == 5: +417 | return 5 +418 | bar() | ^^^^^ RET503 | = help: Add explicit `return` statement ℹ Unsafe fix -368 368 | if baz() > 3: -369 369 | return 1 -370 370 | bar() - 371 |+ return None -371 372 | -372 373 | -373 374 | def f(): - -RET503.py:378:13: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -376 | else: -377 | with c: -378 | d - | ^ RET503 - | - = help: Add explicit `return` statement - -ℹ Unsafe fix -376 376 | else: -377 377 | with c: -378 378 | d - 379 |+ return None +415 415 | abort() +416 416 | if x == 5: +417 417 | return 5 +418 |- bar() + 418 |+ bar() + 419 |+ return None diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET504_RET504.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET504_RET504.py.snap index 46ffb2df68b29..8cf3328508b5d 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET504_RET504.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET504_RET504.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_return/mod.rs +snapshot_kind: text --- RET504.py:6:12: RET504 [*] Unnecessary assignment to `a` before `return` statement | diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET505_RET505.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET505_RET505.py.snap index 08f4b537b3107..132296938a59a 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET505_RET505.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET505_RET505.py.snap @@ -368,7 +368,7 @@ RET505.py:207:5: RET505 [*] Unnecessary `else` after `return` statement 206 | return y 207 | else: | ^^^^ RET505 -208 | +208 | 209 | c = 3 | = help: Remove unnecessary `else` diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET506_RET506.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET506_RET506.py.snap index b526b1a6fb395..5a16ac0c71cf7 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET506_RET506.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET506_RET506.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_return/mod.rs +snapshot_kind: text --- RET506.py:8:5: RET506 [*] Unnecessary `elif` after `raise` statement | diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET507_RET507.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET507_RET507.py.snap index 6b8e47c961b3e..7481cae38490a 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET507_RET507.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET507_RET507.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_return/mod.rs +snapshot_kind: text --- RET507.py:8:9: RET507 [*] Unnecessary `elif` after `continue` statement | diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET508_RET508.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET508_RET508.py.snap index 072b97b754024..8d62c54ea09eb 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET508_RET508.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__RET508_RET508.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_return/mod.rs +snapshot_kind: text --- RET508.py:8:9: RET508 [*] Unnecessary `elif` after `break` statement | diff --git a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__preview__RET503_RET503.py.snap b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__preview__RET503_RET503.py.snap index 96478e899ab84..91c961e50974d 100644 --- a/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__preview__RET503_RET503.py.snap +++ b/crates/ruff_linter/src/rules/flake8_return/snapshots/ruff_linter__rules__flake8_return__tests__preview__RET503_RET503.py.snap @@ -46,7 +46,7 @@ RET503.py:33:1: RET503 [*] Missing explicit `return` at the end of function able 33 | / def x(y): 34 | | if not y: 35 | | return 1 -36 | | +36 | | 37 | | print() # error | |___________^ RET503 | @@ -256,7 +256,7 @@ RET503.py:271:1: RET503 [*] Missing explicit `return` at the end of function abl 271 | / def nested(values): 272 | | if not values: 273 | | return False -274 | | +274 | | 275 | | for value in values: 276 | | print(value) | |____________________^ RET503 @@ -297,8 +297,7 @@ RET503.py:287:1: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:300:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | 299 | def end_of_statement(): -300 | def example(): - | _____^ +300 | / def example(): 301 | | if True: 302 | | return "" | |_____________________^ RET503 @@ -316,8 +315,7 @@ RET503.py:300:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:305:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -305 | def example(): - | _____^ +305 | / def example(): 306 | | if True: 307 | | return "" | |_____________________^ RET503 @@ -335,8 +333,7 @@ RET503.py:305:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:310:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -310 | def example(): - | _____^ +310 | / def example(): 311 | | if True: 312 | | return "" # type: ignore | |_____________________^ RET503 @@ -354,8 +351,7 @@ RET503.py:310:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:315:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -315 | def example(): - | _____^ +315 | / def example(): 316 | | if True: 317 | | return "" ; | |_____________________^ RET503 @@ -373,8 +369,7 @@ RET503.py:315:5: RET503 [*] Missing explicit `return` at the end of function abl RET503.py:320:5: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -320 | def example(): - | _____^ +320 | / def example(): 321 | | if True: 322 | | return "" \ | |_____________________^ RET503 @@ -410,99 +405,45 @@ RET503.py:326:1: RET503 [*] Missing explicit `return` at the end of function abl 332 333 | 333 334 | # function return type annotation NoReturn -RET503.py:334:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value +RET503.py:398:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value | -333 | # function return type annotation NoReturn -334 | / def foo(x: int) -> int: -335 | | def bar() -> NoReturn: -336 | | abort() -337 | | if x == 5: -338 | | return 5 -339 | | bar() - | |_________^ RET503 - | - = help: Add explicit `return` statement - -ℹ Unsafe fix -337 337 | if x == 5: -338 338 | return 5 -339 339 | bar() - 340 |+ return None -340 341 | -341 342 | -342 343 | def foo(string: str) -> str: - -RET503.py:342:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -342 | / def foo(string: str) -> str: -343 | | def raises(value: str) -> NoReturn: -344 | | raise RuntimeError("something went wrong") -345 | | -346 | | match string: -347 | | case "a": -348 | | return "first" -349 | | case "b": -350 | | return "second" -351 | | case "c": -352 | | return "third" -353 | | case _: -354 | | raises(string) - | |__________________________^ RET503 +398 | / def f(): +399 | | if a: +400 | | return b +401 | | else: +402 | | with c: +403 | | d + | |_____________^ RET503 | = help: Add explicit `return` statement ℹ Unsafe fix -352 352 | return "third" -353 353 | case _: -354 354 | raises(string) - 355 |+ return None -355 356 | -356 357 | -357 358 | def foo() -> int: - -RET503.py:357:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -357 | / def foo() -> int: -358 | | def baz() -> int: -359 | | return 1 -360 | | -361 | | -362 | | def bar() -> NoReturn: -363 | | a = 1 + 2 -364 | | raise AssertionError("Very bad") -365 | | -366 | | -367 | | -368 | | if baz() > 3: -369 | | return 1 -370 | | bar() +401 401 | else: +402 402 | with c: +403 403 | d + 404 |+ return None +404 405 | +405 406 | +406 407 | + +RET503.py:413:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value + | +411 | # the semantic model hasn't yet seen `bar`'s declaration. +412 | # Supporting nested functions requires making this a deferred rule. +413 | / def foo(x: int) -> int: +414 | | def bar() -> NoReturn: +415 | | abort() +416 | | if x == 5: +417 | | return 5 +418 | | bar() | |_________^ RET503 | = help: Add explicit `return` statement ℹ Unsafe fix -368 368 | if baz() > 3: -369 369 | return 1 -370 370 | bar() - 371 |+ return None -371 372 | -372 373 | -373 374 | def f(): - -RET503.py:373:1: RET503 [*] Missing explicit `return` at the end of function able to return non-`None` value - | -373 | / def f(): -374 | | if a: -375 | | return b -376 | | else: -377 | | with c: -378 | | d - | |_____________^ RET503 - | - = help: Add explicit `return` statement - -ℹ Unsafe fix -376 376 | else: -377 377 | with c: -378 378 | d - 379 |+ return None +415 415 | abort() +416 416 | if x == 5: +417 417 | return 5 +418 |- bar() + 418 |+ bar() + 419 |+ return None diff --git a/crates/ruff_linter/src/rules/flake8_return/visitor.rs b/crates/ruff_linter/src/rules/flake8_return/visitor.rs index c88abc6676bd5..38ddae2af4ede 100644 --- a/crates/ruff_linter/src/rules/flake8_return/visitor.rs +++ b/crates/ruff_linter/src/rules/flake8_return/visitor.rs @@ -59,7 +59,7 @@ impl<'semantic, 'data> ReturnVisitor<'semantic, 'data> { } } -impl<'semantic, 'a> Visitor<'a> for ReturnVisitor<'semantic, 'a> { +impl<'a> Visitor<'a> for ReturnVisitor<'_, 'a> { fn visit_stmt(&mut self, stmt: &'a Stmt) { match stmt { Stmt::ClassDef(ast::StmtClassDef { decorator_list, .. }) => { diff --git a/crates/ruff_linter/src/rules/flake8_self/mod.rs b/crates/ruff_linter/src/rules/flake8_self/mod.rs index d870d85f9fcb1..a445b40bafaf1 100644 --- a/crates/ruff_linter/src/rules/flake8_self/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_self/mod.rs @@ -16,6 +16,7 @@ mod tests { use test_case::test_case; #[test_case(Rule::PrivateMemberAccess, Path::new("SLF001.py"))] + #[test_case(Rule::PrivateMemberAccess, Path::new("SLF001_1.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.as_ref(), path.to_string_lossy()); let diagnostics = test_path( diff --git a/crates/ruff_linter/src/rules/flake8_self/rules/private_member_access.rs b/crates/ruff_linter/src/rules/flake8_self/rules/private_member_access.rs index 31cec1cd48be0..5c3872d0fff67 100644 --- a/crates/ruff_linter/src/rules/flake8_self/rules/private_member_access.rs +++ b/crates/ruff_linter/src/rules/flake8_self/rules/private_member_access.rs @@ -1,11 +1,15 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::{is_dunder, is_sunder}; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{BindingKind, ScopeKind}; +use ruff_python_semantic::analyze::typing; +use ruff_python_semantic::analyze::typing::TypeChecker; +use ruff_python_semantic::{BindingKind, ScopeKind, SemanticModel}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; +use crate::rules::pylint::helpers::is_dunder_operator_method; /// ## What it does /// Checks for accesses on "private" class members. @@ -50,8 +54,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [_What is the meaning of single or double underscores before an object name?_](https://stackoverflow.com/questions/1301346/what-is-the-meaning-of-single-and-double-underscore-before-an-object-name) -#[violation] -pub struct PrivateMemberAccess { +#[derive(ViolationMetadata)] +pub(crate) struct PrivateMemberAccess { access: String, } @@ -64,32 +68,19 @@ impl Violation for PrivateMemberAccess { } /// SLF001 -pub(crate) fn private_member_access(checker: &mut Checker, expr: &Expr) { +pub(crate) fn private_member_access(checker: &Checker, expr: &Expr) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = expr else { return; }; - if checker.semantic().in_annotation() { - return; - } - - // Ignore non-private accesses. - if !attr.starts_with('_') { - return; - } + let semantic = checker.semantic(); + let current_scope = semantic.current_scope(); - // Ignore dunder accesses. - let is_dunder = attr.starts_with("__") && attr.ends_with("__"); - if is_dunder { + if semantic.in_annotation() { return; } - // Ignore sunder accesses. - let is_sunder = attr.starts_with('_') - && attr.ends_with('_') - && !attr.starts_with("__") - && !attr.ends_with("__"); - if is_sunder { + if !attr.starts_with('_') || is_dunder(attr) || is_sunder(attr) { return; } @@ -103,65 +94,14 @@ pub(crate) fn private_member_access(checker: &mut Checker, expr: &Expr) { } // Ignore accesses on instances within special methods (e.g., `__eq__`). - if let ScopeKind::Function(ast::StmtFunctionDef { name, .. }) = - checker.semantic().current_scope().kind - { - if matches!( - name.as_str(), - "__lt__" - | "__le__" - | "__eq__" - | "__ne__" - | "__gt__" - | "__ge__" - | "__add__" - | "__sub__" - | "__mul__" - | "__matmul__" - | "__truediv__" - | "__floordiv__" - | "__mod__" - | "__divmod__" - | "__pow__" - | "__lshift__" - | "__rshift__" - | "__and__" - | "__xor__" - | "__or__" - | "__radd__" - | "__rsub__" - | "__rmul__" - | "__rmatmul__" - | "__rtruediv__" - | "__rfloordiv__" - | "__rmod__" - | "__rdivmod__" - | "__rpow__" - | "__rlshift__" - | "__rrshift__" - | "__rand__" - | "__rxor__" - | "__ror__" - | "__iadd__" - | "__isub__" - | "__imul__" - | "__imatmul__" - | "__itruediv__" - | "__ifloordiv__" - | "__imod__" - | "__ipow__" - | "__ilshift__" - | "__irshift__" - | "__iand__" - | "__ixor__" - | "__ior__" - ) { + if let ScopeKind::Function(ast::StmtFunctionDef { name, .. }) = current_scope.kind { + if is_dunder_operator_method(name) { return; } } // Allow some documented private methods, like `os._exit()`. - if let Some(qualified_name) = checker.semantic().resolve_qualified_name(expr) { + if let Some(qualified_name) = semantic.resolve_qualified_name(expr) { if matches!(qualified_name.segments(), ["os", "_exit"]) { return; } @@ -185,31 +125,136 @@ pub(crate) fn private_member_access(checker: &mut Checker, expr: &Expr) { if let Expr::Name(name) = value.as_ref() { // Ignore accesses on class members from _within_ the class. - if checker - .semantic() + if semantic .resolve_name(name) .and_then(|id| { - if let BindingKind::ClassDefinition(scope) = checker.semantic().binding(id).kind { + if let BindingKind::ClassDefinition(scope) = semantic.binding(id).kind { Some(scope) } else { None } }) - .is_some_and(|scope| { - checker - .semantic() - .current_scope_ids() - .any(|parent| scope == parent) - }) + .is_some_and(|scope| semantic.current_scope_ids().any(|parent| scope == parent)) { return; } + + if is_same_class_instance(name, semantic) { + return; + } } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PrivateMemberAccess { access: attr.to_string(), }, expr.range(), )); } + +/// Check for the following cases: +/// +/// * Parameter annotation: +/// +/// ```python +/// class C[T]: +/// def f(self, other: C): ... +/// def f(self, other: C[...]): ... +/// def f(self, other: Annotated[C, ...]): ... +/// ``` +/// +/// * `super().__new__`/`cls` call: +/// +/// ```python +/// class C: +/// def __new__(cls): ... +/// instance = super().__new__(cls) +/// @classmethod +/// def m(cls): +/// instance = cls() +/// ``` +/// +/// This function is intentionally naive and does not handle more complex cases. +/// It is expected to be expanded overtime, possibly when type-aware APIs are available. +fn is_same_class_instance(name: &ast::ExprName, semantic: &SemanticModel) -> bool { + let Some(binding_id) = semantic.resolve_name(name) else { + return false; + }; + + let binding = semantic.binding(binding_id); + typing::check_type::<SameClassInstanceChecker>(binding, semantic) +} + +struct SameClassInstanceChecker; + +impl SameClassInstanceChecker { + /// Whether `name` resolves to a class which the semantic model is traversing. + fn is_current_class_name(name: &ast::ExprName, semantic: &SemanticModel) -> bool { + semantic.current_scopes().any(|scope| { + let ScopeKind::Class(class) = scope.kind else { + return false; + }; + + class.name.id == name.id + }) + } +} + +impl TypeChecker for SameClassInstanceChecker { + /// `C`, `C[T]`, `Annotated[C, ...]`, `Annotated[C[T], ...]` + fn match_annotation(annotation: &Expr, semantic: &SemanticModel) -> bool { + let Some(class_name) = find_class_name(annotation, semantic) else { + return false; + }; + + Self::is_current_class_name(class_name, semantic) + } + + /// `cls()`, `C()`, `C[T]()`, `super().__new__()` + fn match_initializer(initializer: &Expr, semantic: &SemanticModel) -> bool { + let Expr::Call(call) = initializer else { + return false; + }; + + match &*call.func { + Expr::Subscript(_) => Self::match_annotation(&call.func, semantic), + + Expr::Name(name) => { + matches!(&*name.id, "cls" | "mcs") || Self::is_current_class_name(name, semantic) + } + + Expr::Attribute(ast::ExprAttribute { value, attr, .. }) => { + let Expr::Call(ast::ExprCall { func, .. }) = &**value else { + return false; + }; + + let Expr::Name(ast::ExprName { id: func, .. }) = &**func else { + return false; + }; + + func == "super" && attr == "__new__" + } + + _ => false, + } + } +} + +/// Convert `Annotated[C[T], ...]` to `C` (and similar) to `C` recursively. +fn find_class_name<'a>(expr: &'a Expr, semantic: &'a SemanticModel) -> Option<&'a ast::ExprName> { + match expr { + Expr::Name(name) => Some(name), + Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { + if semantic.match_typing_expr(value, "Annotated") { + let [expr, ..] = &slice.as_tuple_expr()?.elts[..] else { + return None; + }; + + return find_class_name(expr, semantic); + } + + find_class_name(value, semantic) + } + _ => None, + } +} diff --git a/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__ignore_names.snap b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__ignore_names.snap index f3f61366349bc..343e864f3c12c 100644 --- a/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__ignore_names.snap +++ b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__ignore_names.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_self/mod.rs +snapshot_kind: text --- SLF001_extended.py:6:5: SLF001 Private member accessed: `_asdict` | @@ -14,5 +15,3 @@ SLF001_extended.py:10:5: SLF001 Private member accessed: `_bar` 10 | obj._bar # SLF001 | ^^^^^^^^ SLF001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001.py.snap b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001.py.snap index 2399883e42db4..edd0ef3dd2f7d 100644 --- a/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001.py.snap @@ -43,7 +43,7 @@ SLF001.py:43:12: SLF001 Private member accessed: `_private_thing` SLF001.py:62:7: SLF001 Private member accessed: `_private_thing` | 60 | foo = Foo() -61 | +61 | 62 | print(foo._private_thing) # SLF001 | ^^^^^^^^^^^^^^^^^^ SLF001 63 | print(foo.__really_private_thing) # SLF001 @@ -104,8 +104,6 @@ SLF001.py:68:7: SLF001 Private member accessed: `_private_thing__` 67 | print(foo()._private_thing) # SLF001 68 | print(foo()._private_thing__) # SLF001 | ^^^^^^^^^^^^^^^^^^^^^^ SLF001 -69 | +69 | 70 | print(foo.public_thing) | - - diff --git a/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001_1.py.snap b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001_1.py.snap new file mode 100644 index 0000000000000..ad933c0e8a896 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_self/snapshots/ruff_linter__rules__flake8_self__tests__private-member-access_SLF001_1.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/flake8_self/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/flake8_simplify/mod.rs b/crates/ruff_linter/src/rules/flake8_simplify/mod.rs index e2cf5dee0f9df..1041df4615c68 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/mod.rs @@ -9,8 +9,8 @@ mod tests { use test_case::test_case; use crate::registry::Rule; - use crate::settings::types::PreviewMode; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; @@ -29,7 +29,9 @@ mod tests { #[test_case(Rule::ReimplementedBuiltin, Path::new("SIM111.py"))] #[test_case(Rule::UncapitalizedEnvironmentVariables, Path::new("SIM112.py"))] #[test_case(Rule::EnumerateForLoop, Path::new("SIM113.py"))] + #[test_case(Rule::IfWithSameArms, Path::new("SIM114.py"))] #[test_case(Rule::OpenFileWithContextHandler, Path::new("SIM115.py"))] + #[test_case(Rule::IfElseBlockInsteadOfDictLookup, Path::new("SIM116.py"))] #[test_case(Rule::MultipleWithStatements, Path::new("SIM117.py"))] #[test_case(Rule::InDictKeys, Path::new("SIM118.py"))] #[test_case(Rule::NegateEqualOp, Path::new("SIM201.py"))] @@ -44,9 +46,8 @@ mod tests { #[test_case(Rule::ExprAndFalse, Path::new("SIM223.py"))] #[test_case(Rule::YodaConditions, Path::new("SIM300.py"))] #[test_case(Rule::IfElseBlockInsteadOfDictGet, Path::new("SIM401.py"))] + #[test_case(Rule::SplitStaticString, Path::new("SIM905.py"))] #[test_case(Rule::DictGetWithNoneDefault, Path::new("SIM910.py"))] - #[test_case(Rule::IfElseBlockInsteadOfDictLookup, Path::new("SIM116.py"))] - #[test_case(Rule::IfWithSameArms, Path::new("SIM114.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -58,6 +59,7 @@ mod tests { } #[test_case(Rule::IfElseBlockInsteadOfIfExp, Path::new("SIM108.py"))] + #[test_case(Rule::MultipleWithStatements, Path::new("SIM117.py"))] fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!( "preview__{}_{}", diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_bool_op.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_bool_op.rs index d61dd56bedd4d..76181cc76bddb 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_bool_op.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_bool_op.rs @@ -7,9 +7,9 @@ use ruff_python_ast::{self as ast, Arguments, BoolOp, CmpOp, Expr, ExprContext, use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::helpers::{contains_effect, Truthiness}; +use ruff_python_ast::helpers::{Truthiness, contains_effect}; use ruff_python_ast::name::Name; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_codegen::Generator; @@ -44,8 +44,8 @@ use crate::fix::edits::pad; /// /// ## References /// - [Python documentation: `isinstance`](https://docs.python.org/3/library/functions.html#isinstance) -#[violation] -pub struct DuplicateIsinstanceCall { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateIsinstanceCall { name: Option<String>, } @@ -54,18 +54,15 @@ impl Violation for DuplicateIsinstanceCall { #[derive_message_formats] fn message(&self) -> String { - let DuplicateIsinstanceCall { name } = self; - if let Some(name) = name { + if let Some(name) = &self.name { format!("Multiple `isinstance` calls for `{name}`, merge into a single call") } else { - format!("Multiple `isinstance` calls for expression, merge into a single call") + "Multiple `isinstance` calls for expression, merge into a single call".to_string() } } fn fix_title(&self) -> Option<String> { - let DuplicateIsinstanceCall { name } = self; - - Some(if let Some(name) = name { + Some(if let Some(name) = &self.name { format!("Merge `isinstance` calls for `{name}`") } else { "Merge `isinstance` calls".to_string() @@ -95,8 +92,8 @@ impl Violation for DuplicateIsinstanceCall { /// /// ## References /// - [Python documentation: Membership test operations](https://docs.python.org/3/reference/expressions.html#membership-test-operations) -#[violation] -pub struct CompareWithTuple { +#[derive(ViolationMetadata)] +pub(crate) struct CompareWithTuple { replacement: String, } @@ -128,8 +125,8 @@ impl AlwaysFixableViolation for CompareWithTuple { /// /// ## References /// - [Python documentation: Boolean operations](https://docs.python.org/3/reference/expressions.html#boolean-operations) -#[violation] -pub struct ExprAndNotExpr { +#[derive(ViolationMetadata)] +pub(crate) struct ExprAndNotExpr { name: String, } @@ -160,8 +157,8 @@ impl AlwaysFixableViolation for ExprAndNotExpr { /// /// ## References /// - [Python documentation: Boolean operations](https://docs.python.org/3/reference/expressions.html#boolean-operations) -#[violation] -pub struct ExprOrNotExpr { +#[derive(ViolationMetadata)] +pub(crate) struct ExprOrNotExpr { name: String, } @@ -212,8 +209,8 @@ pub(crate) enum ContentAround { /// /// a = x or [1] /// ``` -#[violation] -pub struct ExprOrTrue { +#[derive(ViolationMetadata)] +pub(crate) struct ExprOrTrue { expr: String, remove: ContentAround, } @@ -264,8 +261,8 @@ impl AlwaysFixableViolation for ExprOrTrue { /// /// a = x and [] /// ``` -#[violation] -pub struct ExprAndFalse { +#[derive(ViolationMetadata)] +pub(crate) struct ExprAndFalse { expr: String, remove: ContentAround, } @@ -328,7 +325,7 @@ fn isinstance_target<'a>(call: &'a Expr, semantic: &'a SemanticModel) -> Option< } /// SIM101 -pub(crate) fn duplicate_isinstance_call(checker: &mut Checker, expr: &Expr) { +pub(crate) fn duplicate_isinstance_call(checker: &Checker, expr: &Expr) { let Expr::BoolOp(ast::ExprBoolOp { op: BoolOp::Or, values, @@ -465,7 +462,7 @@ pub(crate) fn duplicate_isinstance_call(checker: &mut Checker, expr: &Expr) { expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -496,7 +493,7 @@ fn match_eq_target(expr: &Expr) -> Option<(&Name, &Expr)> { } /// SIM109 -pub(crate) fn compare_with_tuple(checker: &mut Checker, expr: &Expr) { +pub(crate) fn compare_with_tuple(checker: &Checker, expr: &Expr) { let Expr::BoolOp(ast::ExprBoolOp { op: BoolOp::Or, values, @@ -587,12 +584,12 @@ pub(crate) fn compare_with_tuple(checker: &mut Checker, expr: &Expr) { checker.generator().expr(&in_expr), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// SIM220 -pub(crate) fn expr_and_not_expr(checker: &mut Checker, expr: &Expr) { +pub(crate) fn expr_and_not_expr(checker: &Checker, expr: &Expr) { let Expr::BoolOp(ast::ExprBoolOp { op: BoolOp::And, values, @@ -642,14 +639,14 @@ pub(crate) fn expr_and_not_expr(checker: &mut Checker, expr: &Expr) { "False".to_string(), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } /// SIM221 -pub(crate) fn expr_or_not_expr(checker: &mut Checker, expr: &Expr) { +pub(crate) fn expr_or_not_expr(checker: &Checker, expr: &Expr) { let Expr::BoolOp(ast::ExprBoolOp { op: BoolOp::Or, values, @@ -699,7 +696,7 @@ pub(crate) fn expr_or_not_expr(checker: &mut Checker, expr: &Expr) { "True".to_string(), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -835,7 +832,11 @@ fn is_short_circuit( } /// SIM222 -pub(crate) fn expr_or_true(checker: &mut Checker, expr: &Expr) { +pub(crate) fn expr_or_true(checker: &Checker, expr: &Expr) { + if checker.semantic().in_string_type_definition() { + return; + } + if let Some((edit, remove)) = is_short_circuit(expr, BoolOp::Or, checker) { let mut diagnostic = Diagnostic::new( ExprOrTrue { @@ -845,12 +846,16 @@ pub(crate) fn expr_or_true(checker: &mut Checker, expr: &Expr) { edit.range(), ); diagnostic.set_fix(Fix::unsafe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// SIM223 -pub(crate) fn expr_and_false(checker: &mut Checker, expr: &Expr) { +pub(crate) fn expr_and_false(checker: &Checker, expr: &Expr) { + if checker.semantic().in_string_type_definition() { + return; + } + if let Some((edit, remove)) = is_short_circuit(expr, BoolOp::And, checker) { let mut diagnostic = Diagnostic::new( ExprAndFalse { @@ -860,6 +865,6 @@ pub(crate) fn expr_and_false(checker: &mut Checker, expr: &Expr) { edit.range(), ); diagnostic.set_fix(Fix::unsafe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_expr.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_expr.rs index 82ff84ed2acea..ab832240bd4f8 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_expr.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_expr.rs @@ -1,13 +1,11 @@ -use ruff_python_ast::{ - self as ast, str_prefix::StringLiteralPrefix, Arguments, Expr, StringLiteralFlags, -}; -use ruff_text_size::Ranged; +use ruff_python_ast::{self as ast, Arguments, Expr, str_prefix::StringLiteralPrefix}; +use ruff_text_size::{Ranged, TextRange}; use crate::fix::snippet::SourceCodeSnippet; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_semantic::analyze::typing::is_dict; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; +use ruff_python_semantic::analyze::typing::is_dict; use crate::checkers::ast::Checker; @@ -34,10 +32,16 @@ use crate::checkers::ast::Checker; /// os.environ["FOO"] /// ``` /// +/// ## Fix safety +/// +/// This fix is always marked as unsafe because automatically capitalizing environment variable names +/// can change program behavior in environments where the variable names are case-sensitive, such as most +/// Unix-like systems. +/// /// ## References /// - [Python documentation: `os.environ`](https://docs.python.org/3/library/os.html#os.environ) -#[violation] -pub struct UncapitalizedEnvironmentVariables { +#[derive(ViolationMetadata)] +pub(crate) struct UncapitalizedEnvironmentVariables { expected: SourceCodeSnippet, actual: SourceCodeSnippet, } @@ -51,7 +55,7 @@ impl Violation for UncapitalizedEnvironmentVariables { if let (Some(expected), Some(actual)) = (expected.full_display(), actual.full_display()) { format!("Use capitalized environment variable `{expected}` instead of `{actual}`") } else { - format!("Use capitalized environment variable") + "Use capitalized environment variable".to_string() } } @@ -86,8 +90,8 @@ impl Violation for UncapitalizedEnvironmentVariables { /// /// ## References /// - [Python documentation: `dict.get`](https://docs.python.org/3/library/stdtypes.html#dict.get) -#[violation] -pub struct DictGetWithNoneDefault { +#[derive(ViolationMetadata)] +pub(crate) struct DictGetWithNoneDefault { expected: SourceCodeSnippet, actual: SourceCodeSnippet, } @@ -99,7 +103,7 @@ impl AlwaysFixableViolation for DictGetWithNoneDefault { if let (Some(expected), Some(actual)) = (expected.full_display(), actual.full_display()) { format!("Use `{expected}` instead of `{actual}`") } else { - format!("Use `dict.get()` without default value") + "Use `dict.get()` without default value".to_string() } } @@ -123,7 +127,7 @@ fn is_lowercase_allowed(env_var: &str) -> bool { } /// SIM112 -pub(crate) fn use_capital_environment_variables(checker: &mut Checker, expr: &Expr) { +pub(crate) fn use_capital_environment_variables(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::OS) { return; } @@ -171,7 +175,7 @@ pub(crate) fn use_capital_environment_variables(checker: &mut Checker, expr: &Ex return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UncapitalizedEnvironmentVariables { expected: SourceCodeSnippet::new(capital_env_var), actual: SourceCodeSnippet::new(env_var.to_string()), @@ -180,7 +184,7 @@ pub(crate) fn use_capital_environment_variables(checker: &mut Checker, expr: &Ex )); } -fn check_os_environ_subscript(checker: &mut Checker, expr: &Expr) { +fn check_os_environ_subscript(checker: &Checker, expr: &Expr) { let Expr::Subscript(ast::ExprSubscript { value, slice, .. }) = expr else { return; }; @@ -220,25 +224,25 @@ fn check_os_environ_subscript(checker: &mut Checker, expr: &Expr) { ); let node = ast::StringLiteral { value: capital_env_var.into_boxed_str(), - flags: StringLiteralFlags::default().with_prefix({ + flags: checker.default_string_flags().with_prefix({ if env_var.is_unicode() { StringLiteralPrefix::Unicode } else { StringLiteralPrefix::Empty } }), - ..ast::StringLiteral::default() + range: TextRange::default(), }; let new_env_var = node.into(); diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( checker.generator().expr(&new_env_var), slice.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM910 -pub(crate) fn dict_get_with_none_default(checker: &mut Checker, expr: &Expr) { +pub(crate) fn dict_get_with_none_default(checker: &Checker, expr: &Expr) { let Expr::Call(ast::ExprCall { func, arguments: Arguments { args, keywords, .. }, @@ -305,5 +309,5 @@ pub(crate) fn dict_get_with_none_default(checker: &mut Checker, expr: &Expr) { expected, expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_ifexp.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_ifexp.rs index 2d54023f2649b..10746d0588c87 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_ifexp.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_ifexp.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, UnaryOp}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::{is_const_false, is_const_true}; use ruff_python_ast::name::Name; use ruff_python_ast::parenthesize::parenthesized_range; @@ -27,10 +27,17 @@ use crate::checkers::ast::Checker; /// bool(a) /// ``` /// +/// ## Fix safety +/// +/// This fix is marked as unsafe because it may change the program’s behavior if the condition does not +/// return a proper Boolean. While the fix will try to wrap non-boolean values in a call to bool, +/// custom implementations of comparison functions like `__eq__` can avoid the bool call and still +/// lead to altered behavior. Moreover, the fix may remove comments. +/// /// ## References /// - [Python documentation: Truth Value Testing](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) -#[violation] -pub struct IfExprWithTrueFalse { +#[derive(ViolationMetadata)] +pub(crate) struct IfExprWithTrueFalse { is_compare: bool, } @@ -39,21 +46,20 @@ impl Violation for IfExprWithTrueFalse { #[derive_message_formats] fn message(&self) -> String { - let IfExprWithTrueFalse { is_compare } = self; - if *is_compare { - format!("Remove unnecessary `True if ... else False`") + if self.is_compare { + "Remove unnecessary `True if ... else False`".to_string() } else { - format!("Use `bool(...)` instead of `True if ... else False`") + "Use `bool(...)` instead of `True if ... else False`".to_string() } } fn fix_title(&self) -> Option<String> { - let IfExprWithTrueFalse { is_compare } = self; - if *is_compare { - Some(format!("Remove unnecessary `True if ... else False`")) + let title = if self.is_compare { + "Remove unnecessary `True if ... else False`" } else { - Some(format!("Replace with `bool(...)")) - } + "Replace with `bool(...)" + }; + Some(title.to_string()) } } @@ -78,17 +84,17 @@ impl Violation for IfExprWithTrueFalse { /// /// ## References /// - [Python documentation: Truth Value Testing](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) -#[violation] -pub struct IfExprWithFalseTrue; +#[derive(ViolationMetadata)] +pub(crate) struct IfExprWithFalseTrue; impl AlwaysFixableViolation for IfExprWithFalseTrue { #[derive_message_formats] fn message(&self) -> String { - format!("Use `not ...` instead of `False if ... else True`") + "Use `not ...` instead of `False if ... else True`".to_string() } fn fix_title(&self) -> String { - format!("Replace with `not ...`") + "Replace with `not ...`".to_string() } } @@ -111,8 +117,8 @@ impl AlwaysFixableViolation for IfExprWithFalseTrue { /// /// ## References /// - [Python documentation: Truth Value Testing](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) -#[violation] -pub struct IfExprWithTwistedArms { +#[derive(ViolationMetadata)] +pub(crate) struct IfExprWithTwistedArms { expr_body: String, expr_else: String, } @@ -141,7 +147,7 @@ impl AlwaysFixableViolation for IfExprWithTwistedArms { /// SIM210 pub(crate) fn if_expr_with_true_false( - checker: &mut Checker, + checker: &Checker, expr: &Expr, test: &Expr, body: &Expr, @@ -196,13 +202,13 @@ pub(crate) fn if_expr_with_true_false( ), expr.range(), ))); - }; - checker.diagnostics.push(diagnostic); + } + checker.report_diagnostic(diagnostic); } /// SIM211 pub(crate) fn if_expr_with_false_true( - checker: &mut Checker, + checker: &Checker, expr: &Expr, test: &Expr, body: &Expr, @@ -224,12 +230,12 @@ pub(crate) fn if_expr_with_false_true( ), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM212 pub(crate) fn twisted_arms_in_ifexpr( - checker: &mut Checker, + checker: &Checker, expr: &Expr, test: &Expr, body: &Expr, @@ -278,5 +284,5 @@ pub(crate) fn twisted_arms_in_ifexpr( checker.generator().expr(&node3.into()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_unary_op.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_unary_op.rs index 02526e4509644..9667ebf2bfac1 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_unary_op.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_unary_op.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Arguments, CmpOp, Expr, ExprContext, Stmt, Un use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_semantic::ScopeKind; @@ -25,10 +25,15 @@ use crate::checkers::ast::Checker; /// a != b /// ``` /// +/// ## Fix safety +/// The fix is marked as unsafe, as it might change the behaviour +/// if `a` and/or `b` overrides `__eq__`/`__ne__` +/// in such a manner that they don't return booleans. +/// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) -#[violation] -pub struct NegateEqualOp { +#[derive(ViolationMetadata)] +pub(crate) struct NegateEqualOp { left: String, right: String, } @@ -62,10 +67,15 @@ impl AlwaysFixableViolation for NegateEqualOp { /// a == b /// ``` /// +/// ## Fix safety +/// The fix is marked as unsafe, as it might change the behaviour +/// if `a` and/or `b` overrides `__ne__`/`__eq__` +/// in such a manner that they don't return booleans. +/// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) -#[violation] -pub struct NegateNotEqualOp { +#[derive(ViolationMetadata)] +pub(crate) struct NegateNotEqualOp { left: String, right: String, } @@ -101,8 +111,8 @@ impl AlwaysFixableViolation for NegateNotEqualOp { /// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) -#[violation] -pub struct DoubleNegation { +#[derive(ViolationMetadata)] +pub(crate) struct DoubleNegation { expr: String, } @@ -134,12 +144,7 @@ fn is_exception_check(stmt: &Stmt) -> bool { } /// SIM201 -pub(crate) fn negation_with_equal_op( - checker: &mut Checker, - expr: &Expr, - op: UnaryOp, - operand: &Expr, -) { +pub(crate) fn negation_with_equal_op(checker: &Checker, expr: &Expr, op: UnaryOp, operand: &Expr) { if !matches!(op, UnaryOp::Not) { return; } @@ -181,16 +186,16 @@ pub(crate) fn negation_with_equal_op( comparators: comparators.clone(), range: TextRange::default(), }; - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( checker.generator().expr(&node.into()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM202 pub(crate) fn negation_with_not_equal_op( - checker: &mut Checker, + checker: &Checker, expr: &Expr, op: UnaryOp, operand: &Expr, @@ -236,15 +241,15 @@ pub(crate) fn negation_with_not_equal_op( comparators: comparators.clone(), range: TextRange::default(), }; - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( checker.generator().expr(&node.into()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM208 -pub(crate) fn double_negation(checker: &mut Checker, expr: &Expr, op: UnaryOp, operand: &Expr) { +pub(crate) fn double_negation(checker: &Checker, expr: &Expr, op: UnaryOp, operand: &Expr) { if !matches!(op, UnaryOp::Not) { return; } @@ -290,6 +295,6 @@ pub(crate) fn double_negation(checker: &mut Checker, expr: &Expr, op: UnaryOp, o checker.generator().expr(&node1.into()), expr.range(), ))); - }; - checker.diagnostics.push(diagnostic); + } + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_with.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_with.rs index 402baa83e0b24..0dca0aed22c2f 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_with.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/ast_with.rs @@ -1,17 +1,17 @@ +use anyhow::bail; use ast::Expr; -use log::error; use ruff_diagnostics::{Diagnostic, Fix}; use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Stmt, WithItem}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; +use super::fix_with; use crate::checkers::ast::Checker; use crate::fix::edits::fits; - -use super::fix_with; +use crate::preview::multiple_with_statements_fix_safe_enabled; /// ## What it does /// Checks for the unnecessary nesting of multiple consecutive context @@ -45,20 +45,26 @@ use super::fix_with; /// pass /// ``` /// +/// # Fix safety +/// +/// This fix is marked as always unsafe unless [preview] mode is enabled, in which case it is always +/// marked as safe. Note that the fix is unavailable if it would remove comments (in either case). +/// /// ## References /// - [Python documentation: The `with` statement](https://docs.python.org/3/reference/compound_stmts.html#the-with-statement) -#[violation] -pub struct MultipleWithStatements; +/// +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct MultipleWithStatements; impl Violation for MultipleWithStatements { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!( - "Use a single `with` statement with multiple contexts instead of nested `with` \ - statements" - ) + "Use a single `with` statement with multiple contexts instead of nested `with` \ + statements" + .to_string() } fn fix_title(&self) -> Option<String> { @@ -69,12 +75,14 @@ impl Violation for MultipleWithStatements { /// Returns a boolean indicating whether it's an async with statement, the items /// and body. fn next_with(body: &[Stmt]) -> Option<(bool, &[WithItem], &[Stmt])> { - let [Stmt::With(ast::StmtWith { - is_async, - items, - body, - .. - })] = body + let [ + Stmt::With(ast::StmtWith { + is_async, + items, + body, + .. + }), + ] = body else { return None; }; @@ -90,7 +98,7 @@ fn next_with(body: &[Stmt]) -> Option<(bool, &[WithItem], &[Stmt])> { /// with resource1(), resource2(): /// ... /// ``` -fn explicit_with_items(checker: &mut Checker, with_items: &[WithItem]) -> bool { +fn explicit_with_items(checker: &Checker, with_items: &[WithItem]) -> bool { let [with_item] = with_items else { return false; }; @@ -115,7 +123,7 @@ fn explicit_with_items(checker: &mut Checker, with_items: &[WithItem]) -> bool { /// SIM117 pub(crate) fn multiple_with_statements( - checker: &mut Checker, + checker: &Checker, with_stmt: &ast::StmtWith, with_parent: Option<&Stmt>, ) { @@ -171,27 +179,35 @@ pub(crate) fn multiple_with_statements( .comment_ranges() .intersects(TextRange::new(with_stmt.start(), with_stmt.body[0].start())) { - match fix_with::fix_multiple_with_statements( - checker.locator(), - checker.stylist(), - with_stmt, - ) { - Ok(edit) => { - if edit.content().map_or(true, |content| { - fits( - content, - with_stmt.into(), - checker.locator(), - checker.settings.pycodestyle.max_line_length, - checker.settings.tab_size, - ) - }) { - diagnostic.set_fix(Fix::unsafe_edit(edit)); + diagnostic.try_set_optional_fix(|| { + match fix_with::fix_multiple_with_statements( + checker.locator(), + checker.stylist(), + with_stmt, + ) { + Ok(edit) => { + if edit.content().is_none_or(|content| { + fits( + content, + with_stmt.into(), + checker.locator(), + checker.settings.pycodestyle.max_line_length, + checker.settings.tab_size, + ) + }) { + if multiple_with_statements_fix_safe_enabled(checker.settings) { + Ok(Some(Fix::safe_edit(edit))) + } else { + Ok(Some(Fix::unsafe_edit(edit))) + } + } else { + Ok(None) + } } + Err(err) => bail!("Failed to collapse `with`: {err}"), } - Err(err) => error!("Failed to fix nested with: {err}"), - } + }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/collapsible_if.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/collapsible_if.rs index 83cb7c2b191c6..3ba8c62775960 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/collapsible_if.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/collapsible_if.rs @@ -1,25 +1,24 @@ use std::borrow::Cow; -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use libcst_native::ParenthesizedNode; -use log::error; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::AnyNodeRef; -use ruff_python_ast::{self as ast, whitespace, ElifElseClause, Expr, Stmt}; +use ruff_python_ast::{self as ast, ElifElseClause, Expr, Stmt, whitespace}; use ruff_python_codegen::Stylist; use ruff_python_semantic::analyze::typing::{is_sys_version_block, is_type_checking_block}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::helpers::space; use crate::cst::matchers::{match_function_def, match_if, match_indented_block, match_statement}; use crate::fix::codemods::CodegenStylist; use crate::fix::edits::fits; -use crate::Locator; /// ## What it does /// Checks for nested `if` statements that can be collapsed into a single `if` @@ -46,15 +45,15 @@ use crate::Locator; /// ## References /// - [Python documentation: The `if` statement](https://docs.python.org/3/reference/compound_stmts.html#the-if-statement) /// - [Python documentation: Boolean operations](https://docs.python.org/3/reference/expressions.html#boolean-operations) -#[violation] -pub struct CollapsibleIf; +#[derive(ViolationMetadata)] +pub(crate) struct CollapsibleIf; impl Violation for CollapsibleIf { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use a single `if` statement instead of nested `if` statements") + "Use a single `if` statement instead of nested `if` statements".to_string() } fn fix_title(&self) -> Option<String> { @@ -64,7 +63,7 @@ impl Violation for CollapsibleIf { /// SIM102 pub(crate) fn nested_if_statements( - checker: &mut Checker, + checker: &Checker, stmt_if: &ast::StmtIf, parent: Option<&Stmt>, ) { @@ -118,24 +117,28 @@ pub(crate) fn nested_if_statements( nested_if.start(), nested_if.body()[0].start(), )) { - match collapse_nested_if(checker.locator(), checker.stylist(), nested_if) { - Ok(edit) => { - if edit.content().map_or(true, |content| { - fits( - content, - (&nested_if).into(), - checker.locator(), - checker.settings.pycodestyle.max_line_length, - checker.settings.tab_size, - ) - }) { - diagnostic.set_fix(Fix::unsafe_edit(edit)); + diagnostic.try_set_optional_fix(|| { + match collapse_nested_if(checker.locator(), checker.stylist(), nested_if) { + Ok(edit) => { + if edit.content().is_none_or(|content| { + fits( + content, + (&nested_if).into(), + checker.locator(), + checker.settings.pycodestyle.max_line_length, + checker.settings.tab_size, + ) + }) { + Ok(Some(Fix::unsafe_edit(edit))) + } else { + Ok(None) + } } + Err(err) => bail!("Failed to collapse `if`: {err}"), } - Err(err) => error!("Failed to fix nested if: {err}"), - } + }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Clone, Copy)] @@ -227,12 +230,14 @@ fn nested_if_body(stmt_if: &ast::StmtIf) -> Option<NestedIf> { /// ... /// ``` fn find_last_nested_if(body: &[Stmt]) -> Option<&Expr> { - let [Stmt::If(ast::StmtIf { - test, - body: inner_body, - elif_else_clauses, - .. - })] = body + let [ + Stmt::If(ast::StmtIf { + test, + body: inner_body, + elif_else_clauses, + .. + }), + ] = body else { return None; }; @@ -340,7 +345,7 @@ pub(super) fn collapse_nested_if( let outer_if = match_if(statement)?; let libcst_native::If { - body: libcst_native::Suite::IndentedBlock(ref mut outer_body), + body: libcst_native::Suite::IndentedBlock(outer_body), orelse: None, .. } = outer_if @@ -348,9 +353,11 @@ pub(super) fn collapse_nested_if( bail!("Expected outer if to have indented body and no else") }; - let [libcst_native::Statement::Compound(libcst_native::CompoundStatement::If( - inner_if @ libcst_native::If { orelse: None, .. }, - ))] = &mut *outer_body.body + let [ + libcst_native::Statement::Compound(libcst_native::CompoundStatement::If( + inner_if @ libcst_native::If { orelse: None, .. }, + )), + ] = &mut *outer_body.body else { bail!("Expected one inner if statement"); }; diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/enumerate_for_loop.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/enumerate_for_loop.rs index 03fc7b09f494f..07e45e6e82f36 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/enumerate_for_loop.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/enumerate_for_loop.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Expr, Int, Number, Operator, Stmt}; use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `enumerate`](https://docs.python.org/3/library/functions.html#enumerate) -#[violation] -pub struct EnumerateForLoop { +#[derive(ViolationMetadata)] +pub(crate) struct EnumerateForLoop { index: String, } @@ -48,7 +48,7 @@ impl Violation for EnumerateForLoop { } /// SIM113 -pub(crate) fn enumerate_for_loop(checker: &mut Checker, for_stmt: &ast::StmtFor) { +pub(crate) fn enumerate_for_loop(checker: &Checker, for_stmt: &ast::StmtFor) { // If the loop is async, abort. if for_stmt.is_async { return; @@ -145,7 +145,7 @@ pub(crate) fn enumerate_for_loop(checker: &mut Checker, for_stmt: &ast::StmtFor) }, stmt.range(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/fix_with.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/fix_with.rs index 008e9f1f2df1f..bf1f681d43979 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/fix_with.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/fix_with.rs @@ -1,4 +1,4 @@ -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use libcst_native::{CompoundStatement, Statement, Suite, With}; use ruff_diagnostics::Edit; @@ -8,9 +8,9 @@ use ruff_python_codegen::Stylist; use ruff_source_file::LineRanges; use ruff_text_size::Ranged; +use crate::Locator; use crate::cst::matchers::{match_function_def, match_indented_block, match_statement, match_with}; use crate::fix::codemods::CodegenStylist; -use crate::Locator; /// (SIM117) Convert `with a: with b:` to `with a, b:`. pub(crate) fn fix_multiple_with_statements( @@ -55,7 +55,7 @@ pub(crate) fn fix_multiple_with_statements( let outer_with = match_with(statement)?; let With { - body: Suite::IndentedBlock(ref mut outer_body), + body: Suite::IndentedBlock(outer_body), .. } = outer_with else { diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_get.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_get.rs index f14374dfa99c6..d65085aae951d 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_get.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_get.rs @@ -1,11 +1,13 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::{ self as ast, Arguments, CmpOp, ElifElseClause, Expr, ExprContext, Identifier, Stmt, }; -use ruff_python_semantic::analyze::typing::{is_sys_version_block, is_type_checking_block}; +use ruff_python_semantic::analyze::typing::{ + is_known_to_be_of_type_dict, is_sys_version_block, is_type_checking_block, +}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -48,8 +50,8 @@ use crate::fix::edits::fits; /// /// ## References /// - [Python documentation: Mapping Types](https://docs.python.org/3/library/stdtypes.html#mapping-types-dict) -#[violation] -pub struct IfElseBlockInsteadOfDictGet { +#[derive(ViolationMetadata)] +pub(crate) struct IfElseBlockInsteadOfDictGet { contents: String, } @@ -69,7 +71,7 @@ impl Violation for IfElseBlockInsteadOfDictGet { } /// SIM401 -pub(crate) fn if_else_block_instead_of_dict_get(checker: &mut Checker, stmt_if: &ast::StmtIf) { +pub(crate) fn if_else_block_instead_of_dict_get(checker: &Checker, stmt_if: &ast::StmtIf) { let ast::StmtIf { test, body, @@ -80,11 +82,13 @@ pub(crate) fn if_else_block_instead_of_dict_get(checker: &mut Checker, stmt_if: let [body_stmt] = body.as_slice() else { return; }; - let [ElifElseClause { - body: else_body, - test: None, - .. - }] = elif_else_clauses.as_slice() + let [ + ElifElseClause { + body: else_body, + test: None, + .. + }, + ] = elif_else_clauses.as_slice() else { return; }; @@ -113,18 +117,27 @@ pub(crate) fn if_else_block_instead_of_dict_get(checker: &mut Checker, stmt_if: let [orelse_var] = orelse_var.as_slice() else { return; }; + let Expr::Compare(ast::ExprCompare { left: test_key, ops, comparators: test_dict, range: _, - }) = test.as_ref() + }) = &**test else { return; }; let [test_dict] = &**test_dict else { return; }; + + if !test_dict + .as_name_expr() + .is_some_and(|dict_name| is_known_to_be_of_type_dict(checker.semantic(), dict_name)) + { + return; + } + let (expected_var, expected_value, default_var, default_value) = match ops[..] { [CmpOp::In] => (body_var, body_value, orelse_var, orelse_value.as_ref()), [CmpOp::NotIn] => (orelse_var, orelse_value, body_var, body_value.as_ref()), @@ -218,12 +231,12 @@ pub(crate) fn if_else_block_instead_of_dict_get(checker: &mut Checker, stmt_if: stmt_if.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM401 pub(crate) fn if_exp_instead_of_dict_get( - checker: &mut Checker, + checker: &Checker, expr: &Expr, test: &Expr, body: &Expr, @@ -307,5 +320,5 @@ pub(crate) fn if_exp_instead_of_dict_get( expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_lookup.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_lookup.rs index 76e2c571f94b0..b1b4a384f456d 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_lookup.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_dict_lookup.rs @@ -1,7 +1,7 @@ use rustc_hash::FxHashSet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableLiteral; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::{self as ast, CmpOp, ElifElseClause, Expr, Stmt}; @@ -30,17 +30,17 @@ use crate::checkers::ast::Checker; /// ```python /// return {1: "Hello", 2: "Goodbye"}.get(x, "Goodnight") /// ``` -#[violation] -pub struct IfElseBlockInsteadOfDictLookup; +#[derive(ViolationMetadata)] +pub(crate) struct IfElseBlockInsteadOfDictLookup; impl Violation for IfElseBlockInsteadOfDictLookup { #[derive_message_formats] fn message(&self) -> String { - format!("Use a dictionary instead of consecutive `if` statements") + "Use a dictionary instead of consecutive `if` statements".to_string() } } /// SIM116 -pub(crate) fn if_else_block_instead_of_dict_lookup(checker: &mut Checker, stmt_if: &ast::StmtIf) { +pub(crate) fn if_else_block_instead_of_dict_lookup(checker: &Checker, stmt_if: &ast::StmtIf) { // Throughout this rule: // * Each if or elif statement's test must consist of a constant equality check with the same variable. // * Each if or elif statement's body must consist of a single `return`. @@ -114,7 +114,7 @@ pub(crate) fn if_else_block_instead_of_dict_lookup(checker: &mut Checker, stmt_i contains_effect(value, |id| checker.semantic().has_builtin_binding(id)) }) { return; - }; + } } // `elif` Some(Expr::Compare(ast::ExprCompare { @@ -140,7 +140,7 @@ pub(crate) fn if_else_block_instead_of_dict_lookup(checker: &mut Checker, stmt_i contains_effect(value, |id| checker.semantic().has_builtin_binding(id)) }) { return; - }; + } // The `expr` was checked to be a literal above, so this is safe. literals.insert(literal_expr.into()); @@ -156,7 +156,7 @@ pub(crate) fn if_else_block_instead_of_dict_lookup(checker: &mut Checker, stmt_i return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( IfElseBlockInsteadOfDictLookup, stmt_if.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_if_exp.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_if_exp.rs index d113bd46c9efc..f8d8e7cd6d095 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_if_exp.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_else_block_instead_of_if_exp.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::{self as ast, BoolOp, ElifElseClause, Expr, Stmt}; @@ -8,6 +8,7 @@ use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::fix::edits::fits; +use crate::preview::is_simplify_ternary_to_binary_enabled; /// ## What it does /// Check for `if`-`else`-blocks that can be replaced with a ternary operator. @@ -47,12 +48,19 @@ use crate::fix::edits::fits; /// z = cond or other_cond /// ``` /// +/// ## Known issues +/// This is an opinionated style rule that may not always be to everyone's +/// taste, especially for code that makes use of complex `if` conditions. +/// Ternary operators can also make it harder to measure [code coverage] +/// with tools that use line profiling. +/// /// ## References /// - [Python documentation: Conditional expressions](https://docs.python.org/3/reference/expressions.html#conditional-expressions) /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct IfElseBlockInsteadOfIfExp { +/// [code coverage]: https://github.com/nedbat/coveragepy/issues/509 +#[derive(ViolationMetadata)] +pub(crate) struct IfElseBlockInsteadOfIfExp { /// The ternary or binary expression to replace the `if`-`else`-block. contents: String, /// Whether to use a binary or ternary assignment. @@ -82,7 +90,7 @@ impl Violation for IfElseBlockInsteadOfIfExp { } /// SIM108 -pub(crate) fn if_else_block_instead_of_if_exp(checker: &mut Checker, stmt_if: &ast::StmtIf) { +pub(crate) fn if_else_block_instead_of_if_exp(checker: &Checker, stmt_if: &ast::StmtIf) { let ast::StmtIf { test, body, @@ -91,27 +99,33 @@ pub(crate) fn if_else_block_instead_of_if_exp(checker: &mut Checker, stmt_if: &a } = stmt_if; // `test: None` to only match an `else` clause - let [ElifElseClause { - body: else_body, - test: None, - .. - }] = elif_else_clauses.as_slice() + let [ + ElifElseClause { + body: else_body, + test: None, + .. + }, + ] = elif_else_clauses.as_slice() else { return; }; - let [Stmt::Assign(ast::StmtAssign { - targets: body_targets, - value: body_value, - .. - })] = body.as_slice() + let [ + Stmt::Assign(ast::StmtAssign { + targets: body_targets, + value: body_value, + .. + }), + ] = body.as_slice() else { return; }; - let [Stmt::Assign(ast::StmtAssign { - targets: else_targets, - value: else_value, - .. - })] = else_body.as_slice() + let [ + Stmt::Assign(ast::StmtAssign { + targets: else_targets, + value: else_value, + .. + }), + ] = else_body.as_slice() else { return; }; @@ -173,39 +187,40 @@ pub(crate) fn if_else_block_instead_of_if_exp(checker: &mut Checker, stmt_if: &a // - If `test == not body_value` and preview enabled, replace with `target_var = body_value and else_value` // - If `not test == body_value` and preview enabled, replace with `target_var = body_value and else_value` // - Otherwise, replace with `target_var = body_value if test else else_value` - let (contents, assignment_kind) = - match (checker.settings.preview.is_enabled(), test, body_value) { - (true, test_node, body_node) - if ComparableExpr::from(test_node) == ComparableExpr::from(body_node) - && !contains_effect(test_node, |id| { - checker.semantic().has_builtin_binding(id) - }) => - { - let target_var = &body_target; - let binary = assignment_binary_or(target_var, body_value, else_value); - (checker.generator().stmt(&binary), AssignmentKind::Binary) - } - (true, test_node, body_node) - if (test_node.as_unary_op_expr().is_some_and(|op_expr| { - op_expr.op.is_not() - && ComparableExpr::from(&op_expr.operand) == ComparableExpr::from(body_node) - }) || body_node.as_unary_op_expr().is_some_and(|op_expr| { - op_expr.op.is_not() - && ComparableExpr::from(&op_expr.operand) == ComparableExpr::from(test_node) - })) && !contains_effect(test_node, |id| { - checker.semantic().has_builtin_binding(id) - }) => - { - let target_var = &body_target; - let binary = assignment_binary_and(target_var, body_value, else_value); - (checker.generator().stmt(&binary), AssignmentKind::Binary) - } - _ => { - let target_var = &body_target; - let ternary = assignment_ternary(target_var, body_value, test, else_value); - (checker.generator().stmt(&ternary), AssignmentKind::Ternary) - } - }; + let (contents, assignment_kind) = match ( + is_simplify_ternary_to_binary_enabled(checker.settings), + test, + body_value, + ) { + (true, test_node, body_node) + if ComparableExpr::from(test_node) == ComparableExpr::from(body_node) + && !contains_effect(test_node, |id| checker.semantic().has_builtin_binding(id)) => + { + let target_var = &body_target; + let binary = assignment_binary_or(target_var, body_value, else_value); + (checker.generator().stmt(&binary), AssignmentKind::Binary) + } + (true, test_node, body_node) + if (test_node.as_unary_op_expr().is_some_and(|op_expr| { + op_expr.op.is_not() + && ComparableExpr::from(&op_expr.operand) == ComparableExpr::from(body_node) + }) || body_node.as_unary_op_expr().is_some_and(|op_expr| { + op_expr.op.is_not() + && ComparableExpr::from(&op_expr.operand) == ComparableExpr::from(test_node) + })) && !contains_effect(test_node, |id| { + checker.semantic().has_builtin_binding(id) + }) => + { + let target_var = &body_target; + let binary = assignment_binary_and(target_var, body_value, else_value); + (checker.generator().stmt(&binary), AssignmentKind::Binary) + } + _ => { + let target_var = &body_target; + let ternary = assignment_ternary(target_var, body_value, test, else_value); + (checker.generator().stmt(&ternary), AssignmentKind::Ternary) + } + }; // Don't flag if the resulting expression would exceed the maximum line length. if !fits( @@ -234,7 +249,7 @@ pub(crate) fn if_else_block_instead_of_if_exp(checker: &mut Checker, stmt_if: &a stmt_if.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Clone, Copy, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_with_same_arms.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_with_same_arms.rs index 698961ab741cb..ab59e87955443 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/if_with_same_arms.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/if_with_same_arms.rs @@ -3,17 +3,17 @@ use std::borrow::Cow; use anyhow::Result; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableStmt; use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_python_ast::stmt_if::{if_elif_branches, IfElifBranch}; +use ruff_python_ast::stmt_if::{IfElifBranch, if_elif_branches}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_trivia::{CommentRanges, SimpleTokenKind, SimpleTokenizer}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for `if` branches with identical arm bodies. @@ -35,15 +35,15 @@ use crate::Locator; /// if x == 1 or x == 2: /// print("Hello") /// ``` -#[violation] -pub struct IfWithSameArms; +#[derive(ViolationMetadata)] +pub(crate) struct IfWithSameArms; impl Violation for IfWithSameArms { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Combine `if` branches using logical `or` operator") + "Combine `if` branches using logical `or` operator".to_string() } fn fix_title(&self) -> Option<String> { @@ -52,7 +52,7 @@ impl Violation for IfWithSameArms { } /// SIM114 -pub(crate) fn if_with_same_arms(checker: &mut Checker, stmt_if: &ast::StmtIf) { +pub(crate) fn if_with_same_arms(checker: &Checker, stmt_if: &ast::StmtIf) { let mut branches_iter = if_elif_branches(stmt_if).peekable(); while let Some(current_branch) = branches_iter.next() { let Some(following_branch) = branches_iter.peek() else { @@ -102,7 +102,7 @@ pub(crate) fn if_with_same_arms(checker: &mut Checker, stmt_if: &ast::StmtIf) { ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/key_in_dict.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/key_in_dict.rs index c49d99cf7ef29..9a2b32e7eaa21 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/key_in_dict.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/key_in_dict.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; use ruff_diagnostics::{Applicability, Edit}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::AnyNodeRef; +use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Arguments, CmpOp, Comprehension, Expr}; use ruff_python_semantic::analyze::typing; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; @@ -37,10 +37,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Mapping Types](https://docs.python.org/3/library/stdtypes.html#mapping-types-dict) -/// -/// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct InDictKeys { +#[derive(ViolationMetadata)] +pub(crate) struct InDictKeys { operator: String, } @@ -52,19 +50,12 @@ impl AlwaysFixableViolation for InDictKeys { } fn fix_title(&self) -> String { - let InDictKeys { operator: _ } = self; - format!("Remove `.keys()`") + "Remove `.keys()`".to_string() } } /// SIM118 -fn key_in_dict( - checker: &mut Checker, - left: &Expr, - right: &Expr, - operator: CmpOp, - parent: AnyNodeRef, -) { +fn key_in_dict(checker: &Checker, left: &Expr, right: &Expr, operator: CmpOp, parent: AnyNodeRef) { let Expr::Call(ast::ExprCall { func, arguments: Arguments { args, keywords, .. }, @@ -167,11 +158,11 @@ fn key_in_dict( )); } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// SIM118 in a `for` loop. -pub(crate) fn key_in_dict_for(checker: &mut Checker, for_stmt: &ast::StmtFor) { +pub(crate) fn key_in_dict_for(checker: &Checker, for_stmt: &ast::StmtFor) { key_in_dict( checker, &for_stmt.target, @@ -182,7 +173,7 @@ pub(crate) fn key_in_dict_for(checker: &mut Checker, for_stmt: &ast::StmtFor) { } /// SIM118 in a comprehension. -pub(crate) fn key_in_dict_comprehension(checker: &mut Checker, comprehension: &Comprehension) { +pub(crate) fn key_in_dict_comprehension(checker: &Checker, comprehension: &Comprehension) { key_in_dict( checker, &comprehension.target, @@ -193,7 +184,7 @@ pub(crate) fn key_in_dict_comprehension(checker: &mut Checker, comprehension: &C } /// SIM118 in a comparison. -pub(crate) fn key_in_dict_compare(checker: &mut Checker, compare: &ast::ExprCompare) { +pub(crate) fn key_in_dict_compare(checker: &Checker, compare: &ast::ExprCompare) { let [op] = &*compare.ops else { return; }; diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/mod.rs index b2aa7d5259732..1a28711cf805b 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/mod.rs @@ -14,6 +14,7 @@ pub(crate) use needless_bool::*; pub(crate) use open_file_with_context_handler::*; pub(crate) use reimplemented_builtin::*; pub(crate) use return_in_try_except_finally::*; +pub(crate) use split_static_string::*; pub(crate) use suppressible_exception::*; pub(crate) use yoda_conditions::*; pub(crate) use zip_dict_keys_and_values::*; @@ -35,6 +36,7 @@ mod needless_bool; mod open_file_with_context_handler; mod reimplemented_builtin; mod return_in_try_except_finally; +mod split_static_string; mod suppressible_exception; mod yoda_conditions; mod zip_dict_keys_and_values; diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/needless_bool.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/needless_bool.rs index b6dedfd098db1..427561c767c42 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/needless_bool.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/needless_bool.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_ast::traversal; use ruff_python_ast::{self as ast, Arguments, ElifElseClause, Expr, ExprContext, Stmt}; @@ -14,38 +14,49 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// ## Why is this bad? /// `if` statements that return `True` for a truthy condition and `False` for -/// a falsey condition can be replaced with boolean casts. +/// a falsy condition can be replaced with boolean casts. /// /// ## Example /// Given: /// ```python -/// if x > 0: -/// return True -/// else: -/// return False +/// def foo(x: int) -> bool: +/// if x > 0: +/// return True +/// else: +/// return False /// ``` /// /// Use instead: /// ```python -/// return x > 0 +/// def foo(x: int) -> bool: +/// return x > 0 /// ``` /// /// Or, given: /// ```python -/// if x > 0: -/// return True -/// return False +/// def foo(x: int) -> bool: +/// if x > 0: +/// return True +/// return False /// ``` /// /// Use instead: /// ```python -/// return x > 0 +/// def foo(x: int) -> bool: +/// return x > 0 /// ``` /// +/// ## Fix safety +/// +/// This fix is marked as unsafe because it may change the program’s behavior if the condition does not +/// return a proper Boolean. While the fix will try to wrap non-boolean values in a call to bool, +/// custom implementations of comparison functions like `__eq__` can avoid the bool call and still +/// lead to altered behavior. +/// /// ## References /// - [Python documentation: Truth Value Testing](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) -#[violation] -pub struct NeedlessBool { +#[derive(ViolationMetadata)] +pub(crate) struct NeedlessBool { condition: Option<SourceCodeSnippet>, negate: bool, } @@ -56,29 +67,29 @@ impl Violation for NeedlessBool { #[derive_message_formats] fn message(&self) -> String { let NeedlessBool { condition, negate } = self; - if let Some(condition) = condition.as_ref().and_then(SourceCodeSnippet::full_display) { format!("Return the condition `{condition}` directly") } else if *negate { - format!("Return the negated condition directly") + "Return the negated condition directly".to_string() } else { - format!("Return the condition directly") + "Return the condition directly".to_string() } } fn fix_title(&self) -> Option<String> { let NeedlessBool { condition, .. } = self; - - if let Some(condition) = condition.as_ref().and_then(SourceCodeSnippet::full_display) { - Some(format!("Replace with `return {condition}`")) - } else { - Some(format!("Inline condition")) - } + Some( + if let Some(condition) = condition.as_ref().and_then(SourceCodeSnippet::full_display) { + format!("Replace with `return {condition}`") + } else { + "Inline condition".to_string() + }, + ) } } /// SIM103 -pub(crate) fn needless_bool(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn needless_bool(checker: &Checker, stmt: &Stmt) { let Stmt::If(stmt_if) = stmt else { return }; let ast::StmtIf { test: if_test, @@ -96,11 +107,13 @@ pub(crate) fn needless_bool(checker: &mut Checker, stmt: &Stmt) { // else: // return False // ``` - [ElifElseClause { - body: else_body, - test: None, - .. - }] => ( + [ + ElifElseClause { + body: else_body, + test: None, + .. + }, + ] => ( if_test.as_ref(), if_body, else_body.as_slice(), @@ -113,15 +126,19 @@ pub(crate) fn needless_bool(checker: &mut Checker, stmt: &Stmt) { // elif x < 0: // return False // ``` - [.., ElifElseClause { - body: elif_body, - test: Some(elif_test), - range: elif_range, - }, ElifElseClause { - body: else_body, - test: None, - range: else_range, - }] => ( + [ + .., + ElifElseClause { + body: elif_body, + test: Some(elif_test), + range: elif_range, + }, + ElifElseClause { + body: else_body, + test: None, + range: else_range, + }, + ] => ( elif_test, elif_body, else_body.as_slice(), @@ -206,19 +223,45 @@ pub(crate) fn needless_bool(checker: &mut Checker, stmt: &Stmt) { } else { // If the return values are inverted, wrap the condition in a `not`. if inverted { - if let Expr::UnaryOp(ast::ExprUnaryOp { - op: ast::UnaryOp::Not, - operand, - .. - }) = if_test - { - Some((**operand).clone()) - } else { - Some(Expr::UnaryOp(ast::ExprUnaryOp { + match if_test { + Expr::UnaryOp(ast::ExprUnaryOp { + op: ast::UnaryOp::Not, + operand, + .. + }) => Some((**operand).clone()), + + Expr::Compare(ast::ExprCompare { + ops, + left, + comparators, + .. + }) if matches!( + ops.as_ref(), + [ast::CmpOp::Eq + | ast::CmpOp::NotEq + | ast::CmpOp::In + | ast::CmpOp::NotIn + | ast::CmpOp::Is + | ast::CmpOp::IsNot] + ) => + { + let ([op], [right]) = (ops.as_ref(), comparators.as_ref()) else { + unreachable!("Single comparison with multiple comparators"); + }; + + Some(Expr::Compare(ast::ExprCompare { + ops: Box::new([op.negate()]), + left: left.clone(), + comparators: Box::new([right.clone()]), + range: TextRange::default(), + })) + } + + _ => Some(Expr::UnaryOp(ast::ExprUnaryOp { op: ast::UnaryOp::Not, operand: Box::new(if_test.clone()), range: TextRange::default(), - })) + })), } } else if if_test.is_compare_expr() { // If the condition is a comparison, we can replace it with the condition, since we @@ -275,7 +318,7 @@ pub(crate) fn needless_bool(checker: &mut Checker, stmt: &Stmt) { range, ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Clone, Copy, PartialEq, Eq)] @@ -286,11 +329,7 @@ enum Bool { impl From<bool> for Bool { fn from(value: bool) -> Self { - if value { - Bool::True - } else { - Bool::False - } + if value { Bool::True } else { Bool::False } } } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/open_file_with_context_handler.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/open_file_with_context_handler.rs index f7aa76a35ac6e..e46086f1fc479 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/open_file_with_context_handler.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/open_file_with_context_handler.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::{ScopeKind, SemanticModel}; use ruff_text_size::Ranged; @@ -31,15 +31,15 @@ use crate::checkers::ast::Checker; /// ... /// ``` /// -/// # References +/// ## References /// - [Python documentation: `open`](https://docs.python.org/3/library/functions.html#open) -#[violation] -pub struct OpenFileWithContextHandler; +#[derive(ViolationMetadata)] +pub(crate) struct OpenFileWithContextHandler; impl Violation for OpenFileWithContextHandler { #[derive_message_formats] fn message(&self) -> String { - format!("Use a context manager for opening files") + "Use a context manager for opening files".to_string() } } @@ -114,6 +114,28 @@ fn match_exit_stack(semantic: &SemanticModel) -> bool { false } +/// Return `true` if the current expression is nested in a call to one of the +/// unittest context manager methods: `cls.enterClassContext()`, +/// `self.enterContext()`, or `self.enterAsyncContext()`. +fn match_unittest_context_methods(semantic: &SemanticModel) -> bool { + let Some(expr) = semantic.current_expression_parent() else { + return false; + }; + let Expr::Call(ast::ExprCall { func, .. }) = expr else { + return false; + }; + let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = func.as_ref() else { + return false; + }; + let Expr::Name(ast::ExprName { id, .. }) = value.as_ref() else { + return false; + }; + matches!( + (id.as_str(), attr.as_str()), + ("cls", "enterClassContext") | ("self", "enterContext" | "enterAsyncContext") + ) +} + /// Return `true` if the expression is a call to `open()`, /// or a call to some other standard-library function that opens a file. fn is_open_call(semantic: &SemanticModel, call: &ast::ExprCall) -> bool { @@ -197,7 +219,7 @@ fn is_immediately_closed(semantic: &SemanticModel) -> bool { } /// SIM115 -pub(crate) fn open_file_with_context_handler(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn open_file_with_context_handler(checker: &Checker, call: &ast::ExprCall) { let semantic = checker.semantic(); if !is_open_call(semantic, call) { @@ -214,6 +236,11 @@ pub(crate) fn open_file_with_context_handler(checker: &mut Checker, call: &ast:: return; } + // Ex) `return open("foo.txt")` + if semantic.current_statement().is_return_stmt() { + return; + } + // Ex) `with contextlib.ExitStack() as exit_stack: ...` if match_exit_stack(semantic) { return; @@ -224,6 +251,11 @@ pub(crate) fn open_file_with_context_handler(checker: &mut Checker, call: &ast:: return; } + // Ex) `self.enterContext(open("foo.txt"))` + if match_unittest_context_methods(semantic) { + return; + } + // Ex) `def __enter__(self): ...` if let ScopeKind::Function(ast::StmtFunctionDef { name, .. }) = &checker.semantic().current_scope().kind @@ -233,7 +265,7 @@ pub(crate) fn open_file_with_context_handler(checker: &mut Checker, call: &ast:: } } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( OpenFileWithContextHandler, call.func.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/reimplemented_builtin.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/reimplemented_builtin.rs index 4e10108dac6a3..4530751a69eb2 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/reimplemented_builtin.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/reimplemented_builtin.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::name::Name; use ruff_python_ast::traversal; @@ -34,11 +34,15 @@ use crate::line_width::LineWidthBuilder; /// return any(predicate(item) for item in iterable) /// ``` /// +/// # Fix safety +/// +/// This fix is always marked as unsafe because it might remove comments. +/// /// ## References /// - [Python documentation: `any`](https://docs.python.org/3/library/functions.html#any) /// - [Python documentation: `all`](https://docs.python.org/3/library/functions.html#all) -#[violation] -pub struct ReimplementedBuiltin { +#[derive(ViolationMetadata)] +pub(crate) struct ReimplementedBuiltin { replacement: String, } @@ -58,7 +62,7 @@ impl Violation for ReimplementedBuiltin { } /// SIM110, SIM111 -pub(crate) fn convert_for_loop_to_any_all(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn convert_for_loop_to_any_all(checker: &Checker, stmt: &Stmt) { if !checker.semantic().current_scope().kind.is_function() { return; } @@ -120,7 +124,7 @@ pub(crate) fn convert_for_loop_to_any_all(checker: &mut Checker, stmt: &Stmt) { terminal.stmt.end(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } // Replace with `all`. (false, true) => { @@ -212,7 +216,7 @@ pub(crate) fn convert_for_loop_to_any_all(checker: &mut Checker, stmt: &Stmt) { terminal.stmt.end(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } _ => {} } @@ -268,22 +272,26 @@ fn match_loop(stmt: &Stmt) -> Option<Loop> { // The loop itself should contain a single `if` statement, with a single `return` statement in // the body. - let [Stmt::If(ast::StmtIf { - body: nested_body, - test: nested_test, - elif_else_clauses: nested_elif_else_clauses, - range: _, - })] = body.as_slice() + let [ + Stmt::If(ast::StmtIf { + body: nested_body, + test: nested_test, + elif_else_clauses: nested_elif_else_clauses, + range: _, + }), + ] = body.as_slice() else { return None; }; if !nested_elif_else_clauses.is_empty() { return None; } - let [Stmt::Return(ast::StmtReturn { - value: Some(value), - range: _, - })] = nested_body.as_slice() + let [ + Stmt::Return(ast::StmtReturn { + value: Some(value), + range: _, + }), + ] = nested_body.as_slice() else { return None; }; @@ -315,10 +323,12 @@ fn match_else_return(stmt: &Stmt) -> Option<Terminal> { }; // The `else` block has to contain a single `return True` or `return False`. - let [Stmt::Return(ast::StmtReturn { - value: Some(next_value), - range: _, - })] = orelse.as_slice() + let [ + Stmt::Return(ast::StmtReturn { + value: Some(next_value), + range: _, + }), + ] = orelse.as_slice() else { return None; }; diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/return_in_try_except_finally.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/return_in_try_except_finally.rs index 055cd0548b399..b050859cec6a7 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/return_in_try_except_finally.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/return_in_try_except_finally.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,13 +40,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Defining Clean-up Actions](https://docs.python.org/3/tutorial/errors.html#defining-clean-up-actions) -#[violation] -pub struct ReturnInTryExceptFinally; +#[derive(ViolationMetadata)] +pub(crate) struct ReturnInTryExceptFinally; impl Violation for ReturnInTryExceptFinally { #[derive_message_formats] fn message(&self) -> String { - format!("Don't use `return` in `try`-`except` and `finally`") + "Don't use `return` in `try`-`except` and `finally`".to_string() } } @@ -56,7 +56,7 @@ fn find_return(stmts: &[Stmt]) -> Option<&Stmt> { /// SIM107 pub(crate) fn return_in_try_except_finally( - checker: &mut Checker, + checker: &Checker, body: &[Stmt], handlers: &[ExceptHandler], finalbody: &[Stmt], @@ -69,7 +69,7 @@ pub(crate) fn return_in_try_except_finally( if try_has_return || except_has_return { if let Some(finally_return) = find_return(finalbody) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ReturnInTryExceptFinally, finally_return.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/split_static_string.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/split_static_string.rs new file mode 100644 index 0000000000000..1e1d9aefca5a7 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/split_static_string.rs @@ -0,0 +1,268 @@ +use std::cmp::Ordering; + +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + Expr, ExprCall, ExprContext, ExprList, ExprUnaryOp, StringLiteral, StringLiteralFlags, + StringLiteralValue, UnaryOp, str::TripleQuotes, +}; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for static `str.split` calls that can be replaced with list literals. +/// +/// ## Why is this bad? +/// List literals are more readable and do not require the overhead of calling `str.split`. +/// +/// ## Example +/// ```python +/// "a,b,c,d".split(",") +/// ``` +/// +/// Use instead: +/// ```python +/// ["a", "b", "c", "d"] +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe for implicit string concatenations with comments interleaved +/// between segments, as comments may be removed. +/// +/// For example, the fix would be marked as unsafe in the following case: +/// ```python +/// ( +/// "a" # comment +/// "," # comment +/// "b" # comment +/// ).split(",") +/// ``` +/// +/// as this is converted to `["a", "b"]` without any of the comments. +/// +/// ## References +/// - [Python documentation: `str.split`](https://docs.python.org/3/library/stdtypes.html#str.split) +#[derive(ViolationMetadata)] +pub(crate) struct SplitStaticString; + +impl Violation for SplitStaticString { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Consider using a list literal instead of `str.split`".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Replace with list literal".to_string()) + } +} + +/// SIM905 +pub(crate) fn split_static_string( + checker: &Checker, + attr: &str, + call: &ExprCall, + str_value: &StringLiteralValue, +) { + let ExprCall { arguments, .. } = call; + + let maxsplit_arg = arguments.find_argument_value("maxsplit", 1); + let Some(maxsplit_value) = get_maxsplit_value(maxsplit_arg) else { + return; + }; + + // `split` vs `rsplit`. + let direction = if attr == "split" { + Direction::Left + } else { + Direction::Right + }; + + let sep_arg = arguments.find_argument_value("sep", 0); + let split_replacement = if let Some(sep) = sep_arg { + match sep { + Expr::NoneLiteral(_) => split_default(str_value, maxsplit_value, direction), + Expr::StringLiteral(sep_value) => { + let sep_value_str = sep_value.value.to_str(); + Some(split_sep( + str_value, + sep_value_str, + maxsplit_value, + direction, + )) + } + // Ignore names until type inference is available. + _ => { + return; + } + } + } else { + split_default(str_value, maxsplit_value, direction) + }; + + let mut diagnostic = Diagnostic::new(SplitStaticString, call.range()); + if let Some(ref replacement_expr) = split_replacement { + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(replacement_expr), call.range()), + // The fix does not preserve comments within implicit string concatenations. + if checker.comment_ranges().intersects(call.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + )); + } + checker.report_diagnostic(diagnostic); +} + +fn construct_replacement(elts: &[&str], flags: StringLiteralFlags) -> Expr { + Expr::List(ExprList { + elts: elts + .iter() + .map(|elt| { + Expr::from(StringLiteral { + value: Box::from(*elt), + range: TextRange::default(), + // intentionally omit the triple quote flag, if set, to avoid strange + // replacements like + // + // ```python + // """ + // itemA + // itemB + // itemC + // """.split() # -> ["""itemA""", """itemB""", """itemC"""] + // ``` + flags: flags.with_triple_quotes(TripleQuotes::No), + }) + }) + .collect(), + ctx: ExprContext::Load, + range: TextRange::default(), + }) +} + +fn split_default( + str_value: &StringLiteralValue, + max_split: i32, + direction: Direction, +) -> Option<Expr> { + // From the Python documentation: + // > If sep is not specified or is None, a different splitting algorithm is applied: runs of + // > consecutive whitespace are regarded as a single separator, and the result will contain + // > no empty strings at the start or end if the string has leading or trailing whitespace. + // > Consequently, splitting an empty string or a string consisting of just whitespace with + // > a None separator returns []. + // https://docs.python.org/3/library/stdtypes.html#str.split + let string_val = str_value.to_str(); + match max_split.cmp(&0) { + Ordering::Greater => { + // Autofix for `maxsplit` without separator not yet implemented, as + // `split_whitespace().remainder()` is not stable: + // https://doc.rust-lang.org/std/str/struct.SplitWhitespace.html#method.remainder + None + } + Ordering::Equal => { + // Behavior for maxsplit = 0 when sep is None: + // - If the string is empty or all whitespace, result is []. + // - Otherwise: + // - " x ".split(maxsplit=0) -> ['x '] + // - " x ".rsplit(maxsplit=0) -> [' x'] + // - "".split(maxsplit=0) -> [] + // - " ".split(maxsplit=0) -> [] + let processed_str = if direction == Direction::Left { + string_val.trim_start() + } else { + string_val.trim_end() + }; + let list_items: &[_] = if processed_str.is_empty() { + &[] + } else { + &[processed_str] + }; + Some(construct_replacement( + list_items, + str_value.first_literal_flags(), + )) + } + Ordering::Less => { + let list_items: Vec<&str> = string_val.split_whitespace().collect(); + Some(construct_replacement( + &list_items, + str_value.first_literal_flags(), + )) + } + } +} + +fn split_sep( + str_value: &StringLiteralValue, + sep_value: &str, + max_split: i32, + direction: Direction, +) -> Expr { + let value = str_value.to_str(); + let list_items: Vec<&str> = if let Ok(split_n) = usize::try_from(max_split) { + match direction { + Direction::Left => value.splitn(split_n + 1, sep_value).collect(), + Direction::Right => { + let mut items: Vec<&str> = value.rsplitn(split_n + 1, sep_value).collect(); + items.reverse(); + items + } + } + } else { + match direction { + Direction::Left => value.split(sep_value).collect(), + Direction::Right => { + let mut items: Vec<&str> = value.rsplit(sep_value).collect(); + items.reverse(); + items + } + } + }; + + construct_replacement(&list_items, str_value.first_literal_flags()) +} + +/// Returns the value of the `maxsplit` argument as an `i32`, if it is a numeric value. +fn get_maxsplit_value(arg: Option<&Expr>) -> Option<i32> { + if let Some(maxsplit) = arg { + match maxsplit { + // Negative number. + Expr::UnaryOp(ExprUnaryOp { + op: UnaryOp::USub, + operand, + .. + }) => { + match &**operand { + Expr::NumberLiteral(maxsplit_val) => maxsplit_val + .value + .as_int() + .and_then(ruff_python_ast::Int::as_i32) + .map(|f| -f), + // Ignore when `maxsplit` is not a numeric value. + _ => None, + } + } + // Positive number + Expr::NumberLiteral(maxsplit_val) => maxsplit_val + .value + .as_int() + .and_then(ruff_python_ast::Int::as_i32), + // Ignore when `maxsplit` is not a numeric value. + _ => None, + } + } else { + // Default value is -1 (no splits). + Some(-1) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum Direction { + Left, + Right, +} diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/suppressible_exception.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/suppressible_exception.rs index dde37f51358e8..c0a59746fd4d6 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/suppressible_exception.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/suppressible_exception.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; @@ -42,8 +42,8 @@ use crate::importer::ImportRequest; /// - [Python documentation: `contextlib.suppress`](https://docs.python.org/3/library/contextlib.html#contextlib.suppress) /// - [Python documentation: `try` statement](https://docs.python.org/3/reference/compound_stmts.html#the-try-statement) /// - [a simpler `try`/`except` (and why maybe shouldn't)](https://www.youtube.com/watch?v=MZAJ8qnC7mk) -#[violation] -pub struct SuppressibleException { +#[derive(ViolationMetadata)] +pub(crate) struct SuppressibleException { exception: String, } @@ -72,7 +72,7 @@ fn is_empty(body: &[Stmt]) -> bool { /// SIM105 pub(crate) fn suppressible_exception( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, try_body: &[Stmt], handlers: &[ExceptHandler], @@ -131,8 +131,6 @@ pub(crate) fn suppressible_exception( .has_comments(stmt, checker.source()) { diagnostic.try_set_fix(|| { - // let range = statement_range(stmt, checker.locator(), checker.indexer()); - let (import_edit, binding) = checker.importer().get_or_import_symbol( &ImportRequest::import("contextlib", "suppress"), stmt.start(), @@ -149,5 +147,5 @@ pub(crate) fn suppressible_exception( )) }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/yoda_conditions.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/yoda_conditions.rs index cade5e6c6e064..7f0760073d31b 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/yoda_conditions.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/yoda_conditions.rs @@ -4,18 +4,18 @@ use anyhow::Result; use libcst_native::CompOp; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr, UnaryOp}; use ruff_python_codegen::Stylist; use ruff_python_stdlib::str::{self}; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::helpers::or_space; use crate::cst::matchers::{match_comparison, transform_expression}; use crate::fix::edits::pad; use crate::fix::snippet::SourceCodeSnippet; -use crate::Locator; /// ## What it does /// Checks for conditions that position a constant on the left-hand side of the @@ -47,8 +47,8 @@ use crate::Locator; /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) /// - [Python documentation: Assignment statements](https://docs.python.org/3/reference/simple_stmts.html#assignment-statements) -#[violation] -pub struct YodaConditions { +#[derive(ViolationMetadata)] +pub(crate) struct YodaConditions { suggestion: Option<SourceCodeSnippet>, } @@ -57,7 +57,7 @@ impl Violation for YodaConditions { #[derive_message_formats] fn message(&self) -> String { - format!("Yoda condition detected") + "Yoda condition detected".to_string() } fn fix_title(&self) -> Option<String> { @@ -101,13 +101,13 @@ impl From<&Expr> for ConstantLikelihood { .map(ConstantLikelihood::from) .min() .unwrap_or(ConstantLikelihood::Definitely), - Expr::Dict(dict) => { - if dict.is_empty() { - ConstantLikelihood::Definitely - } else { - ConstantLikelihood::Probably - } - } + Expr::Dict(dict) => dict + .items + .iter() + .flat_map(|item| std::iter::once(&item.value).chain(item.key.as_ref())) + .map(ConstantLikelihood::from) + .min() + .unwrap_or(ConstantLikelihood::Definitely), Expr::BinOp(ast::ExprBinOp { left, right, .. }) => cmp::min( ConstantLikelihood::from(&**left), ConstantLikelihood::from(&**right), @@ -203,7 +203,7 @@ fn reverse_comparison(expr: &Expr, locator: &Locator, stylist: &Stylist) -> Resu /// SIM300 pub(crate) fn yoda_conditions( - checker: &mut Checker, + checker: &Checker, expr: &Expr, left: &Expr, ops: &[CmpOp], @@ -235,9 +235,9 @@ pub(crate) fn yoda_conditions( pad(suggestion, expr.range(), checker.locator()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( YodaConditions { suggestion: None }, expr.range(), )); diff --git a/crates/ruff_linter/src/rules/flake8_simplify/rules/zip_dict_keys_and_values.rs b/crates/ruff_linter/src/rules/flake8_simplify/rules/zip_dict_keys_and_values.rs index 2b296e03008ce..375276306a2e7 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/rules/zip_dict_keys_and_values.rs +++ b/crates/ruff_linter/src/rules/flake8_simplify/rules/zip_dict_keys_and_values.rs @@ -1,5 +1,5 @@ use ast::{ExprAttribute, ExprName, Identifier}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_text_size::Ranged; @@ -31,8 +31,8 @@ use ruff_python_semantic::analyze::typing::is_dict; /// /// ## References /// - [Python documentation: `dict.items`](https://docs.python.org/3/library/stdtypes.html#dict.items) -#[violation] -pub struct ZipDictKeysAndValues { +#[derive(ViolationMetadata)] +pub(crate) struct ZipDictKeysAndValues { expected: SourceCodeSnippet, actual: SourceCodeSnippet, } @@ -44,7 +44,7 @@ impl AlwaysFixableViolation for ZipDictKeysAndValues { if let (Some(expected), Some(actual)) = (expected.full_display(), actual.full_display()) { format!("Use `{expected}` instead of `{actual}`") } else { - format!("Use `dict.items()` instead of `zip(dict.keys(), dict.values())`") + "Use `dict.items()` instead of `zip(dict.keys(), dict.values())`".to_string() } } @@ -59,7 +59,7 @@ impl AlwaysFixableViolation for ZipDictKeysAndValues { } /// SIM911 -pub(crate) fn zip_dict_keys_and_values(checker: &mut Checker, expr: &ast::ExprCall) { +pub(crate) fn zip_dict_keys_and_values(checker: &Checker, expr: &ast::ExprCall) { let ast::ExprCall { func, arguments: Arguments { args, keywords, .. }, @@ -67,11 +67,13 @@ pub(crate) fn zip_dict_keys_and_values(checker: &mut Checker, expr: &ast::ExprCa } = expr; match &keywords[..] { [] => {} - [ast::Keyword { - arg: Some(name), .. - }] if name.as_str() == "strict" => {} + [ + ast::Keyword { + arg: Some(name), .. + }, + ] if name.as_str() == "strict" => {} _ => return, - }; + } let [arg1, arg2] = &args[..] else { return; }; @@ -113,7 +115,7 @@ pub(crate) fn zip_dict_keys_and_values(checker: &mut Checker, expr: &ast::ExprCa expected, expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } fn get_var_attr(expr: &Expr) -> Option<(&ExprName, &Identifier)> { diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM101_SIM101.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM101_SIM101.py.snap index 7fe5ffe88ba0b..68fe445fbb55a 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM101_SIM101.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM101_SIM101.py.snap @@ -19,7 +19,7 @@ SIM101.py:1:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sing SIM101.py:4:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 2 | pass -3 | +3 | 4 | if isinstance(a, (int, float)) or isinstance(a, bool): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 5 | pass @@ -39,7 +39,7 @@ SIM101.py:4:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sing SIM101.py:7:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 5 | pass -6 | +6 | 7 | if isinstance(a, int) or isinstance(a, float) or isinstance(b, bool): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 8 | pass @@ -59,7 +59,7 @@ SIM101.py:7:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sing SIM101.py:10:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 8 | pass - 9 | + 9 | 10 | if isinstance(b, bool) or isinstance(a, int) or isinstance(a, float): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 11 | pass @@ -79,7 +79,7 @@ SIM101.py:10:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sin SIM101.py:16:5: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 14 | pass -15 | +15 | 16 | if (isinstance(a, int) or isinstance(a, float)) and isinstance(b, bool): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 17 | pass @@ -99,7 +99,7 @@ SIM101.py:16:5: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sin SIM101.py:19:4: SIM101 [*] Multiple `isinstance` calls for expression, merge into a single call | 17 | pass -18 | +18 | 19 | if isinstance(a.b, int) or isinstance(a.b, float): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 20 | pass @@ -119,7 +119,7 @@ SIM101.py:19:4: SIM101 [*] Multiple `isinstance` calls for expression, merge int SIM101.py:22:4: SIM101 Multiple `isinstance` calls for expression, merge into a single call | 20 | pass -21 | +21 | 22 | if isinstance(a(), int) or isinstance(a(), float): # SIM101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 23 | pass @@ -129,7 +129,7 @@ SIM101.py:22:4: SIM101 Multiple `isinstance` calls for expression, merge into a SIM101.py:38:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 36 | pass -37 | +37 | 38 | if x or isinstance(a, int) or isinstance(a, float): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 39 | pass @@ -149,7 +149,7 @@ SIM101.py:38:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a sin SIM101.py:41:4: SIM101 [*] Multiple `isinstance` calls for `a`, merge into a single call | 39 | pass -40 | +40 | 41 | if x or y or isinstance(a, int) or isinstance(a, float) or z: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM101 42 | pass diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM102_SIM102.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM102_SIM102.py.snap index 480bd0fa4cc66..6d7178e3616f4 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM102_SIM102.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM102_SIM102.py.snap @@ -52,8 +52,7 @@ SIM102.py:8:5: SIM102 [*] Use a single `if` statement instead of nested `if` sta | 6 | # SIM102 7 | if a: - 8 | if b: - | _____^ + 8 | / if b: 9 | | if c: | |_____________^ SIM102 10 | d @@ -138,8 +137,7 @@ SIM102.py:51:5: SIM102 [*] Use a single `if` statement instead of nested `if` st | 49 | while x > 0: 50 | # SIM102 -51 | if y > 0: - | _____^ +51 | / if y > 0: 52 | | if z > 0: | |_________________^ SIM102 53 | """this @@ -212,8 +210,7 @@ SIM102.py:83:5: SIM102 [*] Use a single `if` statement instead of nested `if` st | 81 | while x > 0: 82 | # SIM102 -83 | if node.module: - | _____^ +83 | / if node.module: 84 | | if node.module == "multiprocessing" or node.module.startswith( 85 | | "multiprocessing." 86 | | ): @@ -284,8 +281,7 @@ SIM102.py:106:5: SIM102 [*] Use a single `if` statement instead of nested `if` s | 104 | # Regression test for https://github.com/apache/airflow/blob/145b16caaa43f0c42bffd97344df916c602cddde/airflow/configuration.py#L1161 105 | if a: -106 | if b: - | _____^ +106 | / if b: 107 | | if c: | |_____________^ SIM102 108 | print("if") @@ -310,8 +306,7 @@ SIM102.py:132:5: SIM102 [*] Use a single `if` statement instead of nested `if` s | 130 | if a: 131 | # SIM 102 -132 | if b: - | _____^ +132 | / if b: 133 | | if c: | |_____________^ SIM102 134 | print("foo") @@ -336,8 +331,7 @@ SIM102.py:165:5: SIM102 [*] Use a single `if` statement instead of nested `if` s | 163 | if a: 164 | pass -165 | elif b: - | _____^ +165 | / elif b: 166 | | if c: | |_____________^ SIM102 167 | d @@ -353,5 +347,3 @@ SIM102.py:165:5: SIM102 [*] Use a single `if` statement instead of nested `if` s 167 |- d 165 |+ elif b and c: 166 |+ d - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM103_SIM103.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM103_SIM103.py.snap index 1b44533abc17b..58286e133c344 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM103_SIM103.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM103_SIM103.py.snap @@ -5,8 +5,7 @@ SIM103.py:3:5: SIM103 [*] Return the condition `bool(a)` directly | 1 | def f(): 2 | # SIM103 -3 | if a: - | _____^ +3 | / if a: 4 | | return True 5 | | else: 6 | | return False @@ -30,8 +29,7 @@ SIM103.py:11:5: SIM103 [*] Return the condition `a == b` directly | 9 | def f(): 10 | # SIM103 -11 | if a == b: - | _____^ +11 | / if a == b: 12 | | return True 13 | | else: 14 | | return False @@ -56,8 +54,7 @@ SIM103.py:21:5: SIM103 [*] Return the condition `bool(b)` directly | 19 | if a: 20 | return 1 -21 | elif b: - | _____^ +21 | / elif b: 22 | | return True 23 | | else: 24 | | return False @@ -82,8 +79,7 @@ SIM103.py:32:9: SIM103 [*] Return the condition `bool(b)` directly | 30 | return 1 31 | else: -32 | if b: - | _________^ +32 | / if b: 33 | | return True 34 | | else: 35 | | return False @@ -108,8 +104,7 @@ SIM103.py:57:5: SIM103 [*] Return the condition `not a` directly | 55 | def f(): 56 | # SIM103 -57 | if a: - | _____^ +57 | / if a: 58 | | return False 59 | | else: 60 | | return True @@ -134,8 +129,7 @@ SIM103.py:83:5: SIM103 Return the condition directly | 81 | def bool(): 82 | return False -83 | if a: - | _____^ +83 | / if a: 84 | | return True 85 | | else: 86 | | return False @@ -147,8 +141,7 @@ SIM103.py:91:5: SIM103 [*] Return the condition `not (keys is not None and notic | 89 | def f(): 90 | # SIM103 -91 | if keys is not None and notice.key not in keys: - | _____^ +91 | / if keys is not None and notice.key not in keys: 92 | | return False 93 | | else: 94 | | return True @@ -173,8 +166,7 @@ SIM103.py:104:5: SIM103 [*] Return the condition `bool(a)` directly | 102 | def f(): 103 | # SIM103 -104 | if a: - | _____^ +104 | / if a: 105 | | return True 106 | | return False | |________________^ SIM103 @@ -197,8 +189,7 @@ SIM103.py:111:5: SIM103 [*] Return the condition `not a` directly | 109 | def f(): 110 | # SIM103 -111 | if a: - | _____^ +111 | / if a: 112 | | return False 113 | | return True | |_______________^ SIM103 @@ -220,8 +211,7 @@ SIM103.py:111:5: SIM103 [*] Return the condition `not a` directly SIM103.py:117:5: SIM103 [*] Return the condition `10 < a` directly | 116 | def f(): -117 | if not 10 < a: - | _____^ +117 | / if not 10 < a: 118 | | return False 119 | | return True | |_______________^ SIM103 @@ -243,8 +233,7 @@ SIM103.py:117:5: SIM103 [*] Return the condition `10 < a` directly SIM103.py:123:5: SIM103 [*] Return the condition `not 10 < a` directly | 122 | def f(): -123 | if 10 < a: - | _____^ +123 | / if 10 < a: 124 | | return False 125 | | return True | |_______________^ SIM103 @@ -259,3 +248,135 @@ SIM103.py:123:5: SIM103 [*] Return the condition `not 10 < a` directly 124 |- return False 125 |- return True 123 |+ return not 10 < a +126 124 | +127 125 | +128 126 | def f(): + +SIM103.py:129:5: SIM103 [*] Return the condition `10 not in a` directly + | +128 | def f(): +129 | / if 10 in a: +130 | | return False +131 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return 10 not in a` + +ℹ Unsafe fix +126 126 | +127 127 | +128 128 | def f(): +129 |- if 10 in a: +130 |- return False +131 |- return True + 129 |+ return 10 not in a +132 130 | +133 131 | +134 132 | def f(): + +SIM103.py:135:5: SIM103 [*] Return the condition `10 in a` directly + | +134 | def f(): +135 | / if 10 not in a: +136 | | return False +137 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return 10 in a` + +ℹ Unsafe fix +132 132 | +133 133 | +134 134 | def f(): +135 |- if 10 not in a: +136 |- return False +137 |- return True + 135 |+ return 10 in a +138 136 | +139 137 | +140 138 | def f(): + +SIM103.py:141:5: SIM103 [*] Return the condition `a is not 10` directly + | +140 | def f(): +141 | / if a is 10: +142 | | return False +143 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return a is not 10` + +ℹ Unsafe fix +138 138 | +139 139 | +140 140 | def f(): +141 |- if a is 10: +142 |- return False +143 |- return True + 141 |+ return a is not 10 +144 142 | +145 143 | +146 144 | def f(): + +SIM103.py:147:5: SIM103 [*] Return the condition `a is 10` directly + | +146 | def f(): +147 | / if a is not 10: +148 | | return False +149 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return a is 10` + +ℹ Unsafe fix +144 144 | +145 145 | +146 146 | def f(): +147 |- if a is not 10: +148 |- return False +149 |- return True + 147 |+ return a is 10 +150 148 | +151 149 | +152 150 | def f(): + +SIM103.py:153:5: SIM103 [*] Return the condition `a != 10` directly + | +152 | def f(): +153 | / if a == 10: +154 | | return False +155 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return a != 10` + +ℹ Unsafe fix +150 150 | +151 151 | +152 152 | def f(): +153 |- if a == 10: +154 |- return False +155 |- return True + 153 |+ return a != 10 +156 154 | +157 155 | +158 156 | def f(): + +SIM103.py:159:5: SIM103 [*] Return the condition `a == 10` directly + | +158 | def f(): +159 | / if a != 10: +160 | | return False +161 | | return True + | |_______________^ SIM103 + | + = help: Replace with `return a == 10` + +ℹ Unsafe fix +156 156 | +157 157 | +158 158 | def f(): +159 |- if a != 10: +160 |- return False +161 |- return True + 159 |+ return a == 10 diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_0.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_0.py.snap index dfd257b8a0ec9..da95917f8a763 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_0.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_0.py.snap @@ -36,7 +36,7 @@ SIM105_0.py:13:1: SIM105 [*] Use `contextlib.suppress(ValueError, OSError)` inst 15 | | except (ValueError, OSError): 16 | | pass | |________^ SIM105 -17 | +17 | 18 | # SIM105 | = help: Replace with `contextlib.suppress(ValueError, OSError)` @@ -67,7 +67,7 @@ SIM105_0.py:19:1: SIM105 [*] Use `contextlib.suppress(ValueError, OSError)` inst 21 | | except (ValueError, OSError) as e: 22 | | pass | |________^ SIM105 -23 | +23 | 24 | # SIM105 | = help: Replace with `contextlib.suppress(ValueError, OSError)` @@ -98,7 +98,7 @@ SIM105_0.py:25:1: SIM105 [*] Use `contextlib.suppress(Exception)` instead of `tr 27 | | except: 28 | | pass | |________^ SIM105 -29 | +29 | 30 | # SIM105 | = help: Replace with `contextlib.suppress(Exception)` @@ -129,7 +129,7 @@ SIM105_0.py:31:1: SIM105 [*] Use `contextlib.suppress(a.Error, b.Error)` instead 33 | | except (a.Error, b.Error): 34 | | pass | |________^ SIM105 -35 | +35 | 36 | # OK | = help: Replace with `contextlib.suppress(a.Error, b.Error)` @@ -156,8 +156,7 @@ SIM105_0.py:85:5: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `t | 83 | def with_ellipsis(): 84 | # OK -85 | try: - | _____^ +85 | / try: 86 | | foo() 87 | | except ValueError: 88 | | ... @@ -186,13 +185,12 @@ SIM105_0.py:85:5: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `t SIM105_0.py:100:5: SIM105 Use `contextlib.suppress(ValueError, OSError)` instead of `try`-`except`-`pass` | 99 | def with_comment(): -100 | try: - | _____^ +100 | / try: 101 | | foo() 102 | | except (ValueError, OSError): 103 | | pass # Trailing comment. | |____________^ SIM105 -104 | +104 | 105 | try: | = help: Replace with `contextlib.suppress(ValueError, OSError)` @@ -201,13 +199,12 @@ SIM105_0.py:117:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try | 115 | # Regression test for: https://github.com/astral-sh/ruff/issues/7123 116 | def write_models(directory, Models): -117 | try: - | _____^ +117 | / try: 118 | | os.makedirs(model_dir); 119 | | except OSError: 120 | | pass; | |____________^ SIM105 -121 | +121 | 122 | try: os.makedirs(model_dir); | = help: Replace with `contextlib.suppress(OSError)` @@ -233,13 +230,12 @@ SIM105_0.py:117:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try SIM105_0.py:122:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try`-`except`-`pass` | 120 | pass; -121 | -122 | try: os.makedirs(model_dir); - | _____^ +121 | +122 | / try: os.makedirs(model_dir); 123 | | except OSError: 124 | | pass; | |____________^ SIM105 -125 | +125 | 126 | try: os.makedirs(model_dir); | = help: Replace with `contextlib.suppress(OSError)` @@ -264,9 +260,8 @@ SIM105_0.py:122:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try SIM105_0.py:126:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try`-`except`-`pass` | 124 | pass; -125 | -126 | try: os.makedirs(model_dir); - | _____^ +125 | +126 | / try: os.makedirs(model_dir); 127 | | except OSError: 128 | | pass; \ | |____________^ SIM105 @@ -290,5 +285,3 @@ SIM105_0.py:126:5: SIM105 [*] Use `contextlib.suppress(OSError)` instead of `try 127 |+ with contextlib.suppress(OSError): os.makedirs(model_dir); 129 128 | \ 130 129 | # - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_1.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_1.py.snap index 65f4991e1752c..4b935dd0b7049 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM105_1.py:5:1: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `try`-`except`-`pass` | @@ -23,5 +24,3 @@ SIM105_1.py:5:1: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `tr 6 7 | math.sqrt(-1) 7 |-except ValueError: 8 |- pass - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_2.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_2.py.snap index 1963b91bc8c1f..ad20200273e42 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_2.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM105_2.py:10:1: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `try`-`except`-`pass` | @@ -21,5 +22,3 @@ SIM105_2.py:10:1: SIM105 [*] Use `contextlib.suppress(ValueError)` instead of `t 11 11 | foo() 12 |-except ValueError: 13 |- pass - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_3.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_3.py.snap index b2ba1e9f8748e..22cc4a2c59c6b 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_3.py.snap @@ -5,13 +5,10 @@ SIM105_3.py:10:5: SIM105 Use `contextlib.suppress(ValueError)` instead of `try`- | 8 | def bar(): 9 | # SIM105 -10 | try: - | _____^ +10 | / try: 11 | | foo() 12 | | except ValueError: 13 | | pass | |____________^ SIM105 | = help: Replace with `contextlib.suppress(ValueError)` - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_4.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_4.py.snap index 1389a2ce4fdbe..a292a320b6bc5 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_4.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM105_SIM105_4.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM105_4.py:2:1: SIM105 [*] Use `contextlib.suppress(ImportError)` instead of `try`-`except`-`pass` | @@ -18,5 +19,3 @@ SIM105_4.py:2:1: SIM105 [*] Use `contextlib.suppress(ImportError)` instead of `t 3 |+with contextlib.suppress(ImportError): 3 4 | from __builtin__ import bytes, str, open, super, range, zip, round, int, pow, object, input 4 |-except ImportError: pass - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM107_SIM107.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM107_SIM107.py.snap index c878e47f24bcf..8aa249ae1e863 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM107_SIM107.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM107_SIM107.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM107.py:9:9: SIM107 Don't use `return` in `try`-`except` and `finally` | @@ -8,5 +9,3 @@ SIM107.py:9:9: SIM107 Don't use `return` in `try`-`except` and `finally` 9 | return "3" | ^^^^^^^^^^ SIM107 | - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM108_SIM108.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM108_SIM108.py.snap index 12e9c96372b61..a18c5fdac5b1b 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM108_SIM108.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM108_SIM108.py.snap @@ -9,7 +9,7 @@ SIM108.py:2:1: SIM108 [*] Use ternary operator `b = c if a else d` instead of `i 4 | | else: 5 | | b = d | |_________^ SIM108 -6 | +6 | 7 | # OK | = help: Replace `if`-`else`-block with `b = c if a else d` @@ -29,8 +29,7 @@ SIM108.py:30:5: SIM108 [*] Use ternary operator `b = 1 if a else 2` instead of ` | 28 | pass 29 | else: -30 | if a: - | _____^ +30 | / if a: 31 | | b = 1 32 | | else: 33 | | b = 2 @@ -128,7 +127,7 @@ SIM108.py:141:1: SIM108 [*] Use ternary operator `z = cond if cond else other_co 143 | | else: 144 | | z = other_cond | |__________________^ SIM108 -145 | +145 | 146 | # SIM108 - should suggest | = help: Replace `if`-`else`-block with `z = cond if cond else other_cond` @@ -155,7 +154,7 @@ SIM108.py:148:1: SIM108 [*] Use ternary operator `z = cond if not cond else othe 150 | | else: 151 | | z = other_cond | |__________________^ SIM108 -152 | +152 | 153 | # SIM108 - should suggest | = help: Replace `if`-`else`-block with `z = cond if not cond else other_cond` @@ -182,7 +181,7 @@ SIM108.py:155:1: SIM108 [*] Use ternary operator `z = not cond if cond else othe 157 | | else: 158 | | z = other_cond | |__________________^ SIM108 -159 | +159 | 160 | # SIM108 does not suggest | = help: Replace `if`-`else`-block with `z = not cond if cond else other_cond` @@ -209,7 +208,7 @@ SIM108.py:167:1: SIM108 [*] Use ternary operator `z = 1 if True else other` inst 169 | | else: 170 | | z = other | |_____________^ SIM108 -171 | +171 | 172 | if False: | = help: Replace `if`-`else`-block with `z = 1 if True else other` @@ -227,16 +226,43 @@ SIM108.py:167:1: SIM108 [*] Use ternary operator `z = 1 if True else other` inst 172 169 | if False: 173 170 | z = 1 +SIM108.py:172:1: SIM108 [*] Use ternary operator `z = 1 if False else other` instead of `if`-`else`-block + | +170 | z = other +171 | +172 | / if False: +173 | | z = 1 +174 | | else: +175 | | z = other + | |_____________^ SIM108 +176 | +177 | if 1: + | + = help: Replace `if`-`else`-block with `z = 1 if False else other` + +ℹ Unsafe fix +169 169 | else: +170 170 | z = other +171 171 | +172 |-if False: +173 |- z = 1 +174 |-else: +175 |- z = other + 172 |+z = 1 if False else other +176 173 | +177 174 | if 1: +178 175 | z = True + SIM108.py:177:1: SIM108 [*] Use ternary operator `z = True if 1 else other` instead of `if`-`else`-block | 175 | z = other -176 | +176 | 177 | / if 1: 178 | | z = True 179 | | else: 180 | | z = other | |_____________^ SIM108 -181 | +181 | 182 | # SIM108 does not suggest a binary option in this | = help: Replace `if`-`else`-block with `z = True if 1 else other` @@ -263,7 +289,7 @@ SIM108.py:185:1: SIM108 [*] Use ternary operator `z = foo() if foo() else other` 187 | | else: 188 | | z = other | |_____________^ SIM108 -189 | +189 | 190 | # SIM108 does not suggest a binary option in this | = help: Replace `if`-`else`-block with `z = foo() if foo() else other` @@ -302,3 +328,55 @@ SIM108.py:193:1: SIM108 [*] Use ternary operator `z = not foo() if foo() else ot 195 |-else: 196 |- z = other 193 |+z = not foo() if foo() else other +197 194 | +198 195 | +199 196 | # These two cases double as tests for f-string quote preservation. The first + +SIM108.py:202:1: SIM108 [*] Use ternary operator `var = "str" if cond else f"{first}-{second}"` instead of `if`-`else`-block + | +200 | # f-string should preserve its double quotes, and the second should preserve +201 | # single quotes +202 | / if cond: +203 | | var = "str" +204 | | else: +205 | | var = f"{first}-{second}" + | |_____________________________^ SIM108 +206 | +207 | if cond: + | + = help: Replace `if`-`else`-block with `var = "str" if cond else f"{first}-{second}"` + +ℹ Unsafe fix +199 199 | # These two cases double as tests for f-string quote preservation. The first +200 200 | # f-string should preserve its double quotes, and the second should preserve +201 201 | # single quotes +202 |-if cond: +203 |- var = "str" +204 |-else: +205 |- var = f"{first}-{second}" + 202 |+var = "str" if cond else f"{first}-{second}" +206 203 | +207 204 | if cond: +208 205 | var = "str" + +SIM108.py:207:1: SIM108 [*] Use ternary operator `var = "str" if cond else f'{first}-{second}'` instead of `if`-`else`-block + | +205 | var = f"{first}-{second}" +206 | +207 | / if cond: +208 | | var = "str" +209 | | else: +210 | | var = f'{first}-{second}' + | |_____________________________^ SIM108 + | + = help: Replace `if`-`else`-block with `var = "str" if cond else f'{first}-{second}'` + +ℹ Unsafe fix +204 204 | else: +205 205 | var = f"{first}-{second}" +206 206 | +207 |-if cond: +208 |- var = "str" +209 |-else: +210 |- var = f'{first}-{second}' + 207 |+var = "str" if cond else f'{first}-{second}' diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM109_SIM109.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM109_SIM109.py.snap index 760f432942328..2b07ae1874998 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM109_SIM109.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM109_SIM109.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM109.py:2:4: SIM109 [*] Use `a in (b, c)` instead of multiple equality comparisons | @@ -74,5 +75,3 @@ SIM109.py:14:4: SIM109 [*] Use `a in (b, c)` instead of multiple equality compar 15 15 | d 16 16 | 17 17 | # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM110.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM110.py.snap index f23d9000363ee..a6899206252de 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM110.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM110.py.snap @@ -5,8 +5,7 @@ SIM110.py:3:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead o | 1 | def f(): 2 | # SIM110 -3 | for x in iterable: - | _____^ +3 | / for x in iterable: 4 | | if check(x): 5 | | return True 6 | | return False @@ -30,8 +29,7 @@ SIM110.py:25:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 23 | def f(): 24 | # SIM111 -25 | for x in iterable: - | _____^ +25 | / for x in iterable: 26 | | if check(x): 27 | | return False 28 | | return True @@ -56,8 +54,7 @@ SIM110.py:33:5: SIM110 [*] Use `return all(x.is_empty() for x in iterable)` inst | 31 | def f(): 32 | # SIM111 -33 | for x in iterable: - | _____^ +33 | / for x in iterable: 34 | | if not x.is_empty(): 35 | | return False 36 | | return True @@ -82,8 +79,7 @@ SIM110.py:55:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead | 53 | def f(): 54 | # SIM110 -55 | for x in iterable: - | _____^ +55 | / for x in iterable: 56 | | if check(x): 57 | | return True 58 | | else: @@ -110,8 +106,7 @@ SIM110.py:64:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 62 | def f(): 63 | # SIM111 -64 | for x in iterable: - | _____^ +64 | / for x in iterable: 65 | | if check(x): 66 | | return False 67 | | else: @@ -138,8 +133,7 @@ SIM110.py:73:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead | 71 | def f(): 72 | # SIM110 -73 | for x in iterable: - | _____^ +73 | / for x in iterable: 74 | | if check(x): 75 | | return True 76 | | else: @@ -167,8 +161,7 @@ SIM110.py:83:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 81 | def f(): 82 | # SIM111 -83 | for x in iterable: - | _____^ +83 | / for x in iterable: 84 | | if check(x): 85 | | return False 86 | | else: @@ -195,9 +188,8 @@ SIM110.py:83:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst SIM110.py:124:5: SIM110 Use `return any(check(x) for x in iterable)` instead of `for` loop | 122 | pass -123 | -124 | for x in iterable: - | _____^ +123 | +124 | / for x in iterable: 125 | | if check(x): 126 | | return True 127 | | return False @@ -208,9 +200,8 @@ SIM110.py:124:5: SIM110 Use `return any(check(x) for x in iterable)` instead of SIM110.py:134:5: SIM110 Use `return all(not check(x) for x in iterable)` instead of `for` loop | 132 | pass -133 | -134 | for x in iterable: - | _____^ +133 | +134 | / for x in iterable: 135 | | if check(x): 136 | | return False 137 | | return True @@ -221,8 +212,7 @@ SIM110.py:134:5: SIM110 Use `return all(not check(x) for x in iterable)` instead SIM110.py:144:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead of `for` loop | 143 | # SIM110 -144 | for x in iterable: - | _____^ +144 | / for x in iterable: 145 | | if check(x): 146 | | return True 147 | | return False @@ -246,8 +236,7 @@ SIM110.py:144:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead SIM110.py:154:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` instead of `for` loop | 153 | # SIM111 -154 | for x in iterable: - | _____^ +154 | / for x in iterable: 155 | | if check(x): 156 | | return False 157 | | return True @@ -272,8 +261,7 @@ SIM110.py:162:5: SIM110 [*] Use `return any(x.isdigit() for x in "012ß9💣2ℝ | 160 | def f(): 161 | # SIM110 -162 | for x in "012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ": - | _____^ +162 | / for x in "012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ": 163 | | if x.isdigit(): 164 | | return True 165 | | return False @@ -298,13 +286,12 @@ SIM110.py:184:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead | 182 | async def f(): 183 | # SIM110 -184 | for x in iterable: - | _____^ +184 | / for x in iterable: 185 | | if check(x): 186 | | return True 187 | | return False | |________________^ SIM110 -188 | +188 | 189 | async def f(): | = help: Replace with `return any(check(x) for x in iterable)` @@ -326,13 +313,12 @@ SIM110.py:191:5: SIM110 [*] Use `return any(check(x) for x in await iterable)` i | 189 | async def f(): 190 | # SIM110 -191 | for x in await iterable: - | _____^ +191 | / for x in await iterable: 192 | | if check(x): 193 | | return True 194 | | return False | |________________^ SIM110 -195 | +195 | 196 | def f(): | = help: Replace with `return any(check(x) for x in await iterable)` @@ -349,5 +335,3 @@ SIM110.py:191:5: SIM110 [*] Use `return any(check(x) for x in await iterable)` i 195 192 | 196 193 | def f(): 197 194 | # OK (can't turn this into any() because the yield would end up inside a genexp) - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM111.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM111.py.snap index 9b59955fe1eb6..82c86ffb8d423 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM111.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM110_SIM111.py.snap @@ -5,8 +5,7 @@ SIM111.py:3:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead o | 1 | def f(): 2 | # SIM110 -3 | for x in iterable: - | _____^ +3 | / for x in iterable: 4 | | if check(x): 5 | | return True 6 | | return False @@ -30,8 +29,7 @@ SIM111.py:25:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 23 | def f(): 24 | # SIM111 -25 | for x in iterable: - | _____^ +25 | / for x in iterable: 26 | | if check(x): 27 | | return False 28 | | return True @@ -56,8 +54,7 @@ SIM111.py:33:5: SIM110 [*] Use `return all(x.is_empty() for x in iterable)` inst | 31 | def f(): 32 | # SIM111 -33 | for x in iterable: - | _____^ +33 | / for x in iterable: 34 | | if not x.is_empty(): 35 | | return False 36 | | return True @@ -82,8 +79,7 @@ SIM111.py:55:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead | 53 | def f(): 54 | # SIM110 -55 | for x in iterable: - | _____^ +55 | / for x in iterable: 56 | | if check(x): 57 | | return True 58 | | else: @@ -110,8 +106,7 @@ SIM111.py:64:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 62 | def f(): 63 | # SIM111 -64 | for x in iterable: - | _____^ +64 | / for x in iterable: 65 | | if check(x): 66 | | return False 67 | | else: @@ -138,8 +133,7 @@ SIM111.py:73:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead | 71 | def f(): 72 | # SIM110 -73 | for x in iterable: - | _____^ +73 | / for x in iterable: 74 | | if check(x): 75 | | return True 76 | | else: @@ -167,8 +161,7 @@ SIM111.py:83:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst | 81 | def f(): 82 | # SIM111 -83 | for x in iterable: - | _____^ +83 | / for x in iterable: 84 | | if check(x): 85 | | return False 86 | | else: @@ -195,9 +188,8 @@ SIM111.py:83:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` inst SIM111.py:124:5: SIM110 Use `return any(check(x) for x in iterable)` instead of `for` loop | 122 | pass -123 | -124 | for x in iterable: - | _____^ +123 | +124 | / for x in iterable: 125 | | if check(x): 126 | | return True 127 | | return False @@ -208,9 +200,8 @@ SIM111.py:124:5: SIM110 Use `return any(check(x) for x in iterable)` instead of SIM111.py:134:5: SIM110 Use `return all(not check(x) for x in iterable)` instead of `for` loop | 132 | pass -133 | -134 | for x in iterable: - | _____^ +133 | +134 | / for x in iterable: 135 | | if check(x): 136 | | return False 137 | | return True @@ -221,8 +212,7 @@ SIM111.py:134:5: SIM110 Use `return all(not check(x) for x in iterable)` instead SIM111.py:144:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead of `for` loop | 143 | # SIM110 -144 | for x in iterable: - | _____^ +144 | / for x in iterable: 145 | | if check(x): 146 | | return True 147 | | return False @@ -246,8 +236,7 @@ SIM111.py:144:5: SIM110 [*] Use `return any(check(x) for x in iterable)` instead SIM111.py:154:5: SIM110 [*] Use `return all(not check(x) for x in iterable)` instead of `for` loop | 153 | # SIM111 -154 | for x in iterable: - | _____^ +154 | / for x in iterable: 155 | | if check(x): 156 | | return False 157 | | return True @@ -272,8 +261,7 @@ SIM111.py:162:5: SIM110 [*] Use `return all(x in y for x in iterable)` instead o | 160 | def f(): 161 | # SIM111 -162 | for x in iterable: - | _____^ +162 | / for x in iterable: 163 | | if x not in y: 164 | | return False 165 | | return True @@ -298,8 +286,7 @@ SIM111.py:170:5: SIM110 [*] Use `return all(x <= y for x in iterable)` instead o | 168 | def f(): 169 | # SIM111 -170 | for x in iterable: - | _____^ +170 | / for x in iterable: 171 | | if x > y: 172 | | return False 173 | | return True @@ -324,8 +311,7 @@ SIM111.py:178:5: SIM110 [*] Use `return all(not x.isdigit() for x in "012ß9💣 | 176 | def f(): 177 | # SIM111 -178 | for x in "012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9": - | _____^ +178 | / for x in "012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9": 179 | | if x.isdigit(): 180 | | return False 181 | | return True @@ -345,5 +331,3 @@ SIM111.py:178:5: SIM110 [*] Use `return all(not x.isdigit() for x in "012ß9💣 182 179 | 183 180 | 184 181 | def f(): - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM112_SIM112.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM112_SIM112.py.snap index fb82814e61b59..ac36a3bf67e63 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM112_SIM112.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM112_SIM112.py.snap @@ -6,7 +6,7 @@ SIM112.py:4:12: SIM112 [*] Use capitalized environment variable `FOO` instead of 3 | # Bad 4 | os.environ['foo'] | ^^^^^ SIM112 -5 | +5 | 6 | os.environ.get('foo') | = help: Replace `foo` with `FOO` @@ -24,10 +24,10 @@ SIM112.py:4:12: SIM112 [*] Use capitalized environment variable `FOO` instead of SIM112.py:6:16: SIM112 Use capitalized environment variable `FOO` instead of `foo` | 4 | os.environ['foo'] -5 | +5 | 6 | os.environ.get('foo') | ^^^^^ SIM112 -7 | +7 | 8 | os.environ.get('foo', 'bar') | = help: Replace `foo` with `FOO` @@ -35,10 +35,10 @@ SIM112.py:6:16: SIM112 Use capitalized environment variable `FOO` instead of `fo SIM112.py:8:16: SIM112 Use capitalized environment variable `FOO` instead of `foo` | 6 | os.environ.get('foo') - 7 | + 7 | 8 | os.environ.get('foo', 'bar') | ^^^^^ SIM112 - 9 | + 9 | 10 | os.getenv('foo') | = help: Replace `foo` with `FOO` @@ -46,10 +46,10 @@ SIM112.py:8:16: SIM112 Use capitalized environment variable `FOO` instead of `fo SIM112.py:10:11: SIM112 Use capitalized environment variable `FOO` instead of `foo` | 8 | os.environ.get('foo', 'bar') - 9 | + 9 | 10 | os.getenv('foo') | ^^^^^ SIM112 -11 | +11 | 12 | env = os.environ.get('foo') | = help: Replace `foo` with `FOO` @@ -57,10 +57,10 @@ SIM112.py:10:11: SIM112 Use capitalized environment variable `FOO` instead of `f SIM112.py:12:22: SIM112 Use capitalized environment variable `FOO` instead of `foo` | 10 | os.getenv('foo') -11 | +11 | 12 | env = os.environ.get('foo') | ^^^^^ SIM112 -13 | +13 | 14 | env = os.environ['foo'] | = help: Replace `foo` with `FOO` @@ -68,10 +68,10 @@ SIM112.py:12:22: SIM112 Use capitalized environment variable `FOO` instead of `f SIM112.py:14:18: SIM112 [*] Use capitalized environment variable `FOO` instead of `foo` | 12 | env = os.environ.get('foo') -13 | +13 | 14 | env = os.environ['foo'] | ^^^^^ SIM112 -15 | +15 | 16 | if env := os.environ.get('foo'): | = help: Replace `foo` with `FOO` @@ -89,7 +89,7 @@ SIM112.py:14:18: SIM112 [*] Use capitalized environment variable `FOO` instead o SIM112.py:16:26: SIM112 Use capitalized environment variable `FOO` instead of `foo` | 14 | env = os.environ['foo'] -15 | +15 | 16 | if env := os.environ.get('foo'): | ^^^^^ SIM112 17 | pass @@ -99,7 +99,7 @@ SIM112.py:16:26: SIM112 Use capitalized environment variable `FOO` instead of `f SIM112.py:19:22: SIM112 [*] Use capitalized environment variable `FOO` instead of `foo` | 17 | pass -18 | +18 | 19 | if env := os.environ['foo']: | ^^^^^ SIM112 20 | pass @@ -114,6 +114,4 @@ SIM112.py:19:22: SIM112 [*] Use capitalized environment variable `FOO` instead o 19 |+if env := os.environ['FOO']: 20 20 | pass 21 21 | -22 22 | - - +22 22 | diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM113_SIM113.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM113_SIM113.py.snap index b8cc349f0e83b..d58bcf8512e81 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM113_SIM113.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM113_SIM113.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +snapshot_kind: text --- SIM113.py:6:9: SIM113 Use `enumerate()` for index variable `idx` in `for` loop | @@ -43,5 +44,3 @@ SIM113.py:44:9: SIM113 Use `enumerate()` for index variable `idx` in `for` loop | ^^^^^^^^ SIM113 45 | h(x) | - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM114_SIM114.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM114_SIM114.py.snap index 8eb406515e97a..3e555ee5516be 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM114_SIM114.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM114_SIM114.py.snap @@ -9,7 +9,7 @@ SIM114.py:2:1: SIM114 [*] Combine `if` branches using logical `or` operator 4 | | elif c: 5 | | b | |_____^ SIM114 -6 | +6 | 7 | if a: # we preserve comments, too! | = help: Combine `if` branches @@ -27,13 +27,13 @@ SIM114.py:2:1: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:7:1: SIM114 [*] Combine `if` branches using logical `or` operator | 5 | b - 6 | + 6 | 7 | / if a: # we preserve comments, too! 8 | | b 9 | | elif c: # but not on the second branch 10 | | b | |_____^ SIM114 -11 | +11 | 12 | if x == 1: | = help: Combine `if` branches @@ -53,7 +53,7 @@ SIM114.py:7:1: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:12:1: SIM114 [*] Combine `if` branches using logical `or` operator | 10 | b -11 | +11 | 12 | / if x == 1: 13 | | for _ in range(20): 14 | | print("hello") @@ -61,7 +61,7 @@ SIM114.py:12:1: SIM114 [*] Combine `if` branches using logical `or` operator 16 | | for _ in range(20): 17 | | print("hello") | |______________________^ SIM114 -18 | +18 | 19 | if x == 1: | = help: Combine `if` branches @@ -82,7 +82,7 @@ SIM114.py:12:1: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:19:1: SIM114 [*] Combine `if` branches using logical `or` operator | 17 | print("hello") -18 | +18 | 19 | / if x == 1: 20 | | if True: 21 | | for _ in range(20): @@ -92,7 +92,7 @@ SIM114.py:19:1: SIM114 [*] Combine `if` branches using logical `or` operator 25 | | for _ in range(20): 26 | | print("hello") | |__________________________^ SIM114 -27 | +27 | 28 | if x == 1: | = help: Combine `if` branches @@ -114,7 +114,7 @@ SIM114.py:19:1: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:28:1: SIM114 [*] Combine `if` branches using logical `or` operator | 26 | print("hello") -27 | +27 | 28 | / if x == 1: 29 | | if True: 30 | | for _ in range(20): @@ -130,7 +130,7 @@ SIM114.py:28:1: SIM114 [*] Combine `if` branches using logical `or` operator 40 | | for _ in range(20): 41 | | print("hello") | |__________________________^ SIM114 -42 | +42 | 43 | if ( | = help: Combine `if` branches @@ -155,8 +155,7 @@ SIM114.py:28:1: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:29:5: SIM114 [*] Combine `if` branches using logical `or` operator | 28 | if x == 1: -29 | if True: - | _____^ +29 | / if True: 30 | | for _ in range(20): 31 | | print("hello") 32 | | elif False: @@ -185,15 +184,14 @@ SIM114.py:36:5: SIM114 [*] Combine `if` branches using logical `or` operator | 34 | print("hello") 35 | elif x == 2: -36 | if True: - | _____^ +36 | / if True: 37 | | for _ in range(20): 38 | | print("hello") 39 | | elif False: 40 | | for _ in range(20): 41 | | print("hello") | |__________________________^ SIM114 -42 | +42 | 43 | if ( | = help: Combine `if` branches @@ -214,7 +212,7 @@ SIM114.py:36:5: SIM114 [*] Combine `if` branches using logical `or` operator SIM114.py:43:1: SIM114 [*] Combine `if` branches using logical `or` operator | 41 | print("hello") -42 | +42 | 43 | / if ( 44 | | x == 1 45 | | and y == 2 @@ -235,7 +233,7 @@ SIM114.py:43:1: SIM114 [*] Combine `if` branches using logical `or` operator 60 | | elif 1 == 2: 61 | | pass | |________^ SIM114 -62 | +62 | 63 | if result.eofs == "O": | = help: Combine `if` branches @@ -332,8 +330,7 @@ SIM114.py:118:5: SIM114 [*] Combine `if` branches using logical `or` operator | 116 | a = True 117 | b = False -118 | if a > b: # end-of-line - | _____^ +118 | / if a > b: # end-of-line 119 | | return 3 120 | | elif a == b: 121 | | return 3 @@ -359,8 +356,7 @@ SIM114.py:122:5: SIM114 [*] Combine `if` branches using logical `or` operator | 120 | elif a == b: 121 | return 3 -122 | elif a < b: # end-of-line - | _____^ +122 | / elif a < b: # end-of-line 123 | | return 4 124 | | elif b is None: 125 | | return 4 @@ -384,8 +380,7 @@ SIM114.py:132:5: SIM114 [*] Combine `if` branches using logical `or` operator | 130 | a = True 131 | b = False -132 | if a > b: # end-of-line - | _____^ +132 | / if a > b: # end-of-line 133 | | return 3 134 | | elif a := 1: 135 | | return 3 diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM115_SIM115.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM115_SIM115.py.snap index 351d6aa3b1f1f..551ddd03158b6 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM115_SIM115.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM115_SIM115.py.snap @@ -56,14 +56,14 @@ SIM115.py:39:9: SIM115 Use a context manager for opening files 38 | with contextlib.ExitStack(): 39 | f = open("filename") | ^^^^ SIM115 -40 | +40 | 41 | # OK | SIM115.py:80:5: SIM115 Use a context manager for opening files | 78 | import fileinput -79 | +79 | 80 | f = tempfile.NamedTemporaryFile() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM115 81 | f = tempfile.TemporaryFile() @@ -304,7 +304,7 @@ SIM115.py:104:5: SIM115 Use a context manager for opening files 103 | f = fileinput.input("foo.txt") 104 | f = fileinput.FileInput("foo.txt") | ^^^^^^^^^^^^^^^^^^^ SIM115 -105 | +105 | 106 | with contextlib.suppress(Exception): | diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM116_SIM116.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM116_SIM116.py.snap index f1045b10c4c9c..844e1906b4b95 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM116_SIM116.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM116_SIM116.py.snap @@ -13,7 +13,7 @@ SIM116.py:5:1: SIM116 Use a dictionary instead of consecutive `if` statements 11 | | else: 12 | | return 42 | |_____________^ SIM116 -13 | +13 | 14 | # SIM116 | @@ -29,7 +29,7 @@ SIM116.py:15:1: SIM116 Use a dictionary instead of consecutive `if` statements 21 | | else: 22 | | return (10, 11, 12) | |_______________________^ SIM116 -23 | +23 | 24 | # SIM116 | @@ -43,7 +43,7 @@ SIM116.py:25:1: SIM116 Use a dictionary instead of consecutive `if` statements 29 | | elif a == 3: 30 | | return (7, 8, 9) | |____________________^ SIM116 -31 | +31 | 32 | # SIM116 | @@ -59,7 +59,7 @@ SIM116.py:33:1: SIM116 Use a dictionary instead of consecutive `if` statements 39 | | else: 40 | | return (10, 11, 12) | |_______________________^ SIM116 -41 | +41 | 42 | # SIM116 | @@ -73,7 +73,7 @@ SIM116.py:43:1: SIM116 Use a dictionary instead of consecutive `if` statements 47 | | elif a == b"three": 48 | | return 3 | |____________^ SIM116 -49 | +49 | 50 | # SIM116 | @@ -89,7 +89,7 @@ SIM116.py:51:1: SIM116 Use a dictionary instead of consecutive `if` statements 57 | | else: 58 | | return (10, 11, 12) | |_______________________^ SIM116 -59 | +59 | 60 | # OK | @@ -105,8 +105,6 @@ SIM116.py:79:1: SIM116 Use a dictionary instead of consecutive `if` statements 85 | | elif func_name == "move": 86 | | return "MV" | |_______________^ SIM116 -87 | +87 | 88 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM117_SIM117.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM117_SIM117.py.snap index 597f19d7fdce8..f88cc5274aa99 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM117_SIM117.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM117_SIM117.py.snap @@ -112,8 +112,7 @@ SIM117.py:53:5: SIM117 [*] Use a single `with` statement with multiple contexts | 51 | while True: 52 | # SIM117 -53 | with A() as a: - | _____^ +53 | / with A() as a: 54 | | with B() as b: | |______________________^ SIM117 55 | """this @@ -276,8 +275,7 @@ SIM117.py:106:5: SIM117 Use a single `with` statement with multiple contexts ins | 104 | # From issue #3025. 105 | async def main(): -106 | async with A() as a: # SIM117. - | _____^ +106 | / async with A() as a: # SIM117. 107 | | async with B() as b: | |____________________________^ SIM117 108 | print("async-inside!") @@ -339,5 +337,3 @@ SIM117.py:163:1: SIM117 [*] Use a single `with` statement with multiple contexts 165 |- pass 163 |+async with asyncio.timeout(1), A(), B(): 164 |+ pass - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM118_SIM118.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM118_SIM118.py.snap index 8acd4d438bc9e..28b8ed5313248 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM118_SIM118.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM118_SIM118.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs SIM118.py:3:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 1 | obj = {} -2 | +2 | 3 | key in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^ SIM118 -4 | +4 | 5 | key not in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -24,10 +24,10 @@ SIM118.py:3:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:5:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys()` | 3 | key in obj.keys() # SIM118 -4 | +4 | 5 | key not in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^ SIM118 -6 | +6 | 7 | foo["bar"] in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -45,10 +45,10 @@ SIM118.py:5:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys SIM118.py:7:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 5 | key not in obj.keys() # SIM118 -6 | +6 | 7 | foo["bar"] in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -8 | +8 | 9 | foo["bar"] not in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -66,10 +66,10 @@ SIM118.py:7:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:9:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys()` | 7 | foo["bar"] in obj.keys() # SIM118 - 8 | + 8 | 9 | foo["bar"] not in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -10 | +10 | 11 | foo['bar'] in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -87,10 +87,10 @@ SIM118.py:9:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys SIM118.py:11:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 9 | foo["bar"] not in obj.keys() # SIM118 -10 | +10 | 11 | foo['bar'] in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -12 | +12 | 13 | foo['bar'] not in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -108,10 +108,10 @@ SIM118.py:11:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:13:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys()` | 11 | foo['bar'] in obj.keys() # SIM118 -12 | +12 | 13 | foo['bar'] not in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -14 | +14 | 15 | foo() in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -129,10 +129,10 @@ SIM118.py:13:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.key SIM118.py:15:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 13 | foo['bar'] not in obj.keys() # SIM118 -14 | +14 | 15 | foo() in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^ SIM118 -16 | +16 | 17 | foo() not in obj.keys() # SIM118 | = help: Remove `.keys()` @@ -150,10 +150,10 @@ SIM118.py:15:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:17:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.keys()` | 15 | foo() in obj.keys() # SIM118 -16 | +16 | 17 | foo() not in obj.keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -18 | +18 | 19 | for key in obj.keys(): # SIM118 | = help: Remove `.keys()` @@ -171,7 +171,7 @@ SIM118.py:17:1: SIM118 [*] Use `key not in dict` instead of `key not in dict.key SIM118.py:19:5: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 17 | foo() not in obj.keys() # SIM118 -18 | +18 | 19 | for key in obj.keys(): # SIM118 | ^^^^^^^^^^^^^^^^^ SIM118 20 | pass @@ -191,10 +191,10 @@ SIM118.py:19:5: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:26:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 24 | del obj[key] -25 | +25 | 26 | [k for k in obj.keys()] # SIM118 | ^^^^^^^^^^^^^^^ SIM118 -27 | +27 | 28 | {k for k in obj.keys()} # SIM118 | = help: Remove `.keys()` @@ -212,10 +212,10 @@ SIM118.py:26:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:28:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 26 | [k for k in obj.keys()] # SIM118 -27 | +27 | 28 | {k for k in obj.keys()} # SIM118 | ^^^^^^^^^^^^^^^ SIM118 -29 | +29 | 30 | {k: k for k in obj.keys()} # SIM118 | = help: Remove `.keys()` @@ -233,10 +233,10 @@ SIM118.py:28:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:30:11: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 28 | {k for k in obj.keys()} # SIM118 -29 | +29 | 30 | {k: k for k in obj.keys()} # SIM118 | ^^^^^^^^^^^^^^^ SIM118 -31 | +31 | 32 | (k for k in obj.keys()) # SIM118 | = help: Remove `.keys()` @@ -254,10 +254,10 @@ SIM118.py:30:11: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:32:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 30 | {k: k for k in obj.keys()} # SIM118 -31 | +31 | 32 | (k for k in obj.keys()) # SIM118 | ^^^^^^^^^^^^^^^ SIM118 -33 | +33 | 34 | key in (obj or {}).keys() # SIM118 | = help: Remove `.keys()` @@ -275,10 +275,10 @@ SIM118.py:32:8: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:34:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 32 | (k for k in obj.keys()) # SIM118 -33 | +33 | 34 | key in (obj or {}).keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -35 | +35 | 36 | (key) in (obj or {}).keys() # SIM118 | = help: Remove `.keys()` @@ -296,10 +296,10 @@ SIM118.py:34:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` SIM118.py:36:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` | 34 | key in (obj or {}).keys() # SIM118 -35 | +35 | 36 | (key) in (obj or {}).keys() # SIM118 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM118 -37 | +37 | 38 | from typing import KeysView | = help: Remove `.keys()` @@ -360,7 +360,7 @@ SIM118.py:52:1: SIM118 [*] Use `key in dict` instead of `key in dict.keys()` 51 | (key in obj.keys())and foo 52 | key in (obj.keys())and foo | ^^^^^^^^^^^^^^^^^^^ SIM118 -53 | +53 | 54 | # Regression test for: https://github.com/astral-sh/ruff/issues/7200 | = help: Remove `.keys()` diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM201_SIM201.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM201_SIM201.py.snap index 7bc978ae96e5a..e3cceb1d69f90 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM201_SIM201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM201_SIM201.py.snap @@ -10,7 +10,7 @@ SIM201.py:2:4: SIM201 [*] Use `a != b` instead of `not a == b` | = help: Replace with `!=` operator -ℹ Safe fix +ℹ Unsafe fix 1 1 | # SIM201 2 |-if not a == b: 2 |+if a != b: @@ -27,7 +27,7 @@ SIM201.py:6:4: SIM201 [*] Use `a != b + c` instead of `not a == b + c` | = help: Replace with `!=` operator -ℹ Safe fix +ℹ Unsafe fix 3 3 | pass 4 4 | 5 5 | # SIM201 @@ -46,7 +46,7 @@ SIM201.py:10:4: SIM201 [*] Use `a + b != c` instead of `not a + b == c` | = help: Replace with `!=` operator -ℹ Safe fix +ℹ Unsafe fix 7 7 | pass 8 8 | 9 9 | # SIM201 @@ -55,5 +55,3 @@ SIM201.py:10:4: SIM201 [*] Use `a + b != c` instead of `not a + b == c` 11 11 | pass 12 12 | 13 13 | # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM202_SIM202.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM202_SIM202.py.snap index 46e9c368fa1b0..f32eb412b8577 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM202_SIM202.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM202_SIM202.py.snap @@ -10,7 +10,7 @@ SIM202.py:2:4: SIM202 [*] Use `a == b` instead of `not a != b` | = help: Replace with `==` operator -ℹ Safe fix +ℹ Unsafe fix 1 1 | # SIM202 2 |-if not a != b: 2 |+if a == b: @@ -27,7 +27,7 @@ SIM202.py:6:4: SIM202 [*] Use `a == b + c` instead of `not a != b + c` | = help: Replace with `==` operator -ℹ Safe fix +ℹ Unsafe fix 3 3 | pass 4 4 | 5 5 | # SIM202 @@ -46,7 +46,7 @@ SIM202.py:10:4: SIM202 [*] Use `a + b == c` instead of `not a + b != c` | = help: Replace with `==` operator -ℹ Safe fix +ℹ Unsafe fix 7 7 | pass 8 8 | 9 9 | # SIM202 @@ -55,5 +55,3 @@ SIM202.py:10:4: SIM202 [*] Use `a + b == c` instead of `not a + b != c` 11 11 | pass 12 12 | 13 13 | # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM208_SIM208.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM208_SIM208.py.snap index fa96fedd5098c..39455218cfba0 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM208_SIM208.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM208_SIM208.py.snap @@ -19,7 +19,7 @@ SIM208.py:1:4: SIM208 [*] Use `a` instead of `not (not a)` SIM208.py:4:4: SIM208 [*] Use `a == b` instead of `not (not a == b)` | 2 | pass -3 | +3 | 4 | if not (not (a == b)): # SIM208 | ^^^^^^^^^^^^^^^^^^ SIM208 5 | pass @@ -39,10 +39,10 @@ SIM208.py:4:4: SIM208 [*] Use `a == b` instead of `not (not a == b)` SIM208.py:16:5: SIM208 [*] Use `b` instead of `not (not b)` | 14 | pass -15 | +15 | 16 | a = not not b # SIM208 | ^^^^^^^^^ SIM208 -17 | +17 | 18 | f(not not a) # SIM208 | = help: Replace with `b` @@ -60,10 +60,10 @@ SIM208.py:16:5: SIM208 [*] Use `b` instead of `not (not b)` SIM208.py:18:3: SIM208 [*] Use `a` instead of `not (not a)` | 16 | a = not not b # SIM208 -17 | +17 | 18 | f(not not a) # SIM208 | ^^^^^^^^^ SIM208 -19 | +19 | 20 | if 1 + (not (not a)): # SIM208 | = help: Replace with `a` @@ -81,7 +81,7 @@ SIM208.py:18:3: SIM208 [*] Use `a` instead of `not (not a)` SIM208.py:20:9: SIM208 [*] Use `a` instead of `not (not a)` | 18 | f(not not a) # SIM208 -19 | +19 | 20 | if 1 + (not (not a)): # SIM208 | ^^^^^^^^^^^ SIM208 21 | pass @@ -95,5 +95,3 @@ SIM208.py:20:9: SIM208 [*] Use `a` instead of `not (not a)` 20 |-if 1 + (not (not a)): # SIM208 20 |+if 1 + (bool(a)): # SIM208 21 21 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM210_SIM210.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM210_SIM210.py.snap index 50c7b4ebe93d1..3ccfac277d956 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM210_SIM210.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM210_SIM210.py.snap @@ -5,7 +5,7 @@ SIM210.py:1:5: SIM210 [*] Use `bool(...)` instead of `True if ... else False` | 1 | a = True if b else False # SIM210 | ^^^^^^^^^^^^^^^^^^^^ SIM210 -2 | +2 | 3 | a = True if b != c else False # SIM210 | = help: Replace with `bool(...) @@ -20,10 +20,10 @@ SIM210.py:1:5: SIM210 [*] Use `bool(...)` instead of `True if ... else False` SIM210.py:3:5: SIM210 [*] Remove unnecessary `True if ... else False` | 1 | a = True if b else False # SIM210 -2 | +2 | 3 | a = True if b != c else False # SIM210 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM210 -4 | +4 | 5 | a = True if b + c else False # SIM210 | = help: Remove unnecessary `True if ... else False` @@ -40,10 +40,10 @@ SIM210.py:3:5: SIM210 [*] Remove unnecessary `True if ... else False` SIM210.py:5:5: SIM210 [*] Use `bool(...)` instead of `True if ... else False` | 3 | a = True if b != c else False # SIM210 -4 | +4 | 5 | a = True if b + c else False # SIM210 | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM210 -6 | +6 | 7 | a = False if b else True # OK | = help: Replace with `bool(...) @@ -61,7 +61,7 @@ SIM210.py:5:5: SIM210 [*] Use `bool(...)` instead of `True if ... else False` SIM210.py:15:9: SIM210 Use `bool(...)` instead of `True if ... else False` | 13 | return False -14 | +14 | 15 | a = True if b else False | ^^^^^^^^^^^^^^^^^^^^ SIM210 | @@ -85,5 +85,3 @@ SIM210.py:19:11: SIM210 [*] Remove unnecessary `True if ... else False` 20 |- psl.privatesuffix(src.netloc)) else False 19 |+samesld = (psl.privatesuffix(urlparse(response.url).netloc) == 20 |+ psl.privatesuffix(src.netloc)) - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM211_SIM211.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM211_SIM211.py.snap index 8e3650b7e5723..f064d0046f2b3 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM211_SIM211.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM211_SIM211.py.snap @@ -5,7 +5,7 @@ SIM211.py:1:5: SIM211 [*] Use `not ...` instead of `False if ... else True` | 1 | a = False if b else True # SIM211 | ^^^^^^^^^^^^^^^^^^^^ SIM211 -2 | +2 | 3 | a = False if b != c else True # SIM211 | = help: Replace with `not ...` @@ -20,10 +20,10 @@ SIM211.py:1:5: SIM211 [*] Use `not ...` instead of `False if ... else True` SIM211.py:3:5: SIM211 [*] Use `not ...` instead of `False if ... else True` | 1 | a = False if b else True # SIM211 -2 | +2 | 3 | a = False if b != c else True # SIM211 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM211 -4 | +4 | 5 | a = False if b + c else True # SIM211 | = help: Replace with `not ...` @@ -40,10 +40,10 @@ SIM211.py:3:5: SIM211 [*] Use `not ...` instead of `False if ... else True` SIM211.py:5:5: SIM211 [*] Use `not ...` instead of `False if ... else True` | 3 | a = False if b != c else True # SIM211 -4 | +4 | 5 | a = False if b + c else True # SIM211 | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM211 -6 | +6 | 7 | a = True if b else False # OK | = help: Replace with `not ...` @@ -56,5 +56,3 @@ SIM211.py:5:5: SIM211 [*] Use `not ...` instead of `False if ... else True` 5 |+a = not b + c # SIM211 6 6 | 7 7 | a = True if b else False # OK - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM212_SIM212.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM212_SIM212.py.snap index 35b8bc12a55e4..8696c8e69df49 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM212_SIM212.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM212_SIM212.py.snap @@ -5,7 +5,7 @@ SIM212.py:1:5: SIM212 [*] Use `a if a else b` instead of `b if not a else a` | 1 | c = b if not a else a # SIM212 | ^^^^^^^^^^^^^^^^^ SIM212 -2 | +2 | 3 | c = b + c if not a else a # SIM212 | = help: Replace with `a if a else b` @@ -20,10 +20,10 @@ SIM212.py:1:5: SIM212 [*] Use `a if a else b` instead of `b if not a else a` SIM212.py:3:5: SIM212 [*] Use `a if a else b + c` instead of `b + c if not a else a` | 1 | c = b if not a else a # SIM212 -2 | +2 | 3 | c = b + c if not a else a # SIM212 | ^^^^^^^^^^^^^^^^^^^^^ SIM212 -4 | +4 | 5 | c = b if not x else a # OK | = help: Replace with `a if a else b + c` @@ -35,6 +35,4 @@ SIM212.py:3:5: SIM212 [*] Use `a if a else b + c` instead of `b + c if not a els 3 |+c = a if a else b + c # SIM212 4 4 | 5 5 | c = b if not x else a # OK -6 6 | - - +6 6 | diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM220_SIM220.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM220_SIM220.py.snap index b0c23c954c721..a6a073846bd15 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM220_SIM220.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM220_SIM220.py.snap @@ -19,7 +19,7 @@ SIM220.py:1:4: SIM220 [*] Use `False` instead of `a and not a` SIM220.py:4:5: SIM220 [*] Use `False` instead of `a and not a` | 2 | pass -3 | +3 | 4 | if (a and not a) and b: | ^^^^^^^^^^^ SIM220 5 | pass @@ -39,7 +39,7 @@ SIM220.py:4:5: SIM220 [*] Use `False` instead of `a and not a` SIM220.py:7:5: SIM220 [*] Use `False` instead of `a and not a` | 5 | pass -6 | +6 | 7 | if (a and not a) or b: | ^^^^^^^^^^^ SIM220 8 | pass @@ -55,5 +55,3 @@ SIM220.py:7:5: SIM220 [*] Use `False` instead of `a and not a` 8 8 | pass 9 9 | 10 10 | if a: - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM221_SIM221.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM221_SIM221.py.snap index 038e5fcf64a24..d34af71f63f96 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM221_SIM221.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM221_SIM221.py.snap @@ -19,7 +19,7 @@ SIM221.py:1:4: SIM221 [*] Use `True` instead of `a or not a` SIM221.py:4:5: SIM221 [*] Use `True` instead of `a or not a` | 2 | pass -3 | +3 | 4 | if (a or not a) or b: | ^^^^^^^^^^ SIM221 5 | pass @@ -39,7 +39,7 @@ SIM221.py:4:5: SIM221 [*] Use `True` instead of `a or not a` SIM221.py:7:5: SIM221 [*] Use `True` instead of `a or not a` | 5 | pass -6 | +6 | 7 | if (a or not a) and b: | ^^^^^^^^^^ SIM221 8 | pass @@ -55,5 +55,3 @@ SIM221.py:7:5: SIM221 [*] Use `True` instead of `a or not a` 8 8 | pass 9 9 | 10 10 | if a: - - diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM222_SIM222.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM222_SIM222.py.snap index ddf4598e13b59..f011dba942268 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM222_SIM222.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM222_SIM222.py.snap @@ -19,7 +19,7 @@ SIM222.py:1:4: SIM222 [*] Use `True` instead of `... or True` SIM222.py:4:4: SIM222 [*] Use `True` instead of `... or True` | 2 | pass -3 | +3 | 4 | if (a or b) or True: # SIM222 | ^^^^^^^^^^^^^^^^ SIM222 5 | pass @@ -39,7 +39,7 @@ SIM222.py:4:4: SIM222 [*] Use `True` instead of `... or True` SIM222.py:7:10: SIM222 [*] Use `True` instead of `... or True` | 5 | pass -6 | +6 | 7 | if a or (b or True): # SIM222 | ^^^^^^^^^ SIM222 8 | pass @@ -59,7 +59,7 @@ SIM222.py:7:10: SIM222 [*] Use `True` instead of `... or True` SIM222.py:24:16: SIM222 [*] Use `True` instead of `True or ...` | 22 | pass -23 | +23 | 24 | if a or f() or True or g() or b: # SIM222 | ^^^^^^^^^^^^^^^^ SIM222 25 | pass @@ -79,7 +79,7 @@ SIM222.py:24:16: SIM222 [*] Use `True` instead of `True or ...` SIM222.py:27:4: SIM222 [*] Use `True` instead of `True or ...` | 25 | pass -26 | +26 | 27 | if True or f() or a or g() or b: # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 28 | pass @@ -99,7 +99,7 @@ SIM222.py:27:4: SIM222 [*] Use `True` instead of `True or ...` SIM222.py:30:4: SIM222 [*] Use `True` instead of `... or True or ...` | 28 | pass -29 | +29 | 30 | if a or True or f() or b or g(): # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 31 | pass @@ -120,7 +120,7 @@ SIM222.py:47:6: SIM222 [*] Use `True` instead of `... or True` | 47 | a or "" or True # SIM222 | ^^^^^^^^^^ SIM222 -48 | +48 | 49 | a or "foo" or True or "bar" # SIM222 | = help: Replace with `True` @@ -138,10 +138,10 @@ SIM222.py:47:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:49:6: SIM222 [*] Use `"foo"` instead of `"foo" or ...` | 47 | a or "" or True # SIM222 -48 | +48 | 49 | a or "foo" or True or "bar" # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^ SIM222 -50 | +50 | 51 | a or 0 or True # SIM222 | = help: Replace with `"foo"` @@ -159,10 +159,10 @@ SIM222.py:49:6: SIM222 [*] Use `"foo"` instead of `"foo" or ...` SIM222.py:51:6: SIM222 [*] Use `True` instead of `... or True` | 49 | a or "foo" or True or "bar" # SIM222 -50 | +50 | 51 | a or 0 or True # SIM222 | ^^^^^^^^^ SIM222 -52 | +52 | 53 | a or 1 or True or 2 # SIM222 | = help: Replace with `True` @@ -180,10 +180,10 @@ SIM222.py:51:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:53:6: SIM222 [*] Use `1` instead of `1 or ...` | 51 | a or 0 or True # SIM222 -52 | +52 | 53 | a or 1 or True or 2 # SIM222 | ^^^^^^^^^^^^^^ SIM222 -54 | +54 | 55 | a or 0.0 or True # SIM222 | = help: Replace with `1` @@ -201,10 +201,10 @@ SIM222.py:53:6: SIM222 [*] Use `1` instead of `1 or ...` SIM222.py:55:6: SIM222 [*] Use `True` instead of `... or True` | 53 | a or 1 or True or 2 # SIM222 -54 | +54 | 55 | a or 0.0 or True # SIM222 | ^^^^^^^^^^^ SIM222 -56 | +56 | 57 | a or 0.1 or True or 0.2 # SIM222 | = help: Replace with `True` @@ -222,10 +222,10 @@ SIM222.py:55:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:57:6: SIM222 [*] Use `0.1` instead of `0.1 or ...` | 55 | a or 0.0 or True # SIM222 -56 | +56 | 57 | a or 0.1 or True or 0.2 # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 -58 | +58 | 59 | a or [] or True # SIM222 | = help: Replace with `0.1` @@ -243,10 +243,10 @@ SIM222.py:57:6: SIM222 [*] Use `0.1` instead of `0.1 or ...` SIM222.py:59:6: SIM222 [*] Use `True` instead of `... or True` | 57 | a or 0.1 or True or 0.2 # SIM222 -58 | +58 | 59 | a or [] or True # SIM222 | ^^^^^^^^^^ SIM222 -60 | +60 | 61 | a or list([]) or True # SIM222 | = help: Replace with `True` @@ -264,10 +264,10 @@ SIM222.py:59:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:61:6: SIM222 [*] Use `True` instead of `... or True` | 59 | a or [] or True # SIM222 -60 | +60 | 61 | a or list([]) or True # SIM222 | ^^^^^^^^^^^^^^^^ SIM222 -62 | +62 | 63 | a or [1] or True or [2] # SIM222 | = help: Replace with `True` @@ -285,10 +285,10 @@ SIM222.py:61:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:63:6: SIM222 [*] Use `[1]` instead of `[1] or ...` | 61 | a or list([]) or True # SIM222 -62 | +62 | 63 | a or [1] or True or [2] # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 -64 | +64 | 65 | a or list([1]) or True or list([2]) # SIM222 | = help: Replace with `[1]` @@ -306,10 +306,10 @@ SIM222.py:63:6: SIM222 [*] Use `[1]` instead of `[1] or ...` SIM222.py:65:6: SIM222 [*] Use `list([1])` instead of `list([1]) or ...` | 63 | a or [1] or True or [2] # SIM222 -64 | +64 | 65 | a or list([1]) or True or list([2]) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -66 | +66 | 67 | a or {} or True # SIM222 | = help: Replace with `list([1])` @@ -327,10 +327,10 @@ SIM222.py:65:6: SIM222 [*] Use `list([1])` instead of `list([1]) or ...` SIM222.py:67:6: SIM222 [*] Use `True` instead of `... or True` | 65 | a or list([1]) or True or list([2]) # SIM222 -66 | +66 | 67 | a or {} or True # SIM222 | ^^^^^^^^^^ SIM222 -68 | +68 | 69 | a or dict() or True # SIM222 | = help: Replace with `True` @@ -348,10 +348,10 @@ SIM222.py:67:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:69:6: SIM222 [*] Use `True` instead of `... or True` | 67 | a or {} or True # SIM222 -68 | +68 | 69 | a or dict() or True # SIM222 | ^^^^^^^^^^^^^^ SIM222 -70 | +70 | 71 | a or {1: 1} or True or {2: 2} # SIM222 | = help: Replace with `True` @@ -369,10 +369,10 @@ SIM222.py:69:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:71:6: SIM222 [*] Use `{1: 1}` instead of `{1: 1} or ...` | 69 | a or dict() or True # SIM222 -70 | +70 | 71 | a or {1: 1} or True or {2: 2} # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -72 | +72 | 73 | a or dict({1: 1}) or True or dict({2: 2}) # SIM222 | = help: Replace with `{1: 1}` @@ -390,10 +390,10 @@ SIM222.py:71:6: SIM222 [*] Use `{1: 1}` instead of `{1: 1} or ...` SIM222.py:73:6: SIM222 [*] Use `dict({1: 1})` instead of `dict({1: 1}) or ...` | 71 | a or {1: 1} or True or {2: 2} # SIM222 -72 | +72 | 73 | a or dict({1: 1}) or True or dict({2: 2}) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -74 | +74 | 75 | a or set() or True # SIM222 | = help: Replace with `dict({1: 1})` @@ -411,10 +411,10 @@ SIM222.py:73:6: SIM222 [*] Use `dict({1: 1})` instead of `dict({1: 1}) or ...` SIM222.py:75:6: SIM222 [*] Use `True` instead of `... or True` | 73 | a or dict({1: 1}) or True or dict({2: 2}) # SIM222 -74 | +74 | 75 | a or set() or True # SIM222 | ^^^^^^^^^^^^^ SIM222 -76 | +76 | 77 | a or set(set()) or True # SIM222 | = help: Replace with `True` @@ -432,10 +432,10 @@ SIM222.py:75:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:77:6: SIM222 [*] Use `True` instead of `... or True` | 75 | a or set() or True # SIM222 -76 | +76 | 77 | a or set(set()) or True # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 -78 | +78 | 79 | a or {1} or True or {2} # SIM222 | = help: Replace with `True` @@ -453,10 +453,10 @@ SIM222.py:77:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:79:6: SIM222 [*] Use `{1}` instead of `{1} or ...` | 77 | a or set(set()) or True # SIM222 -78 | +78 | 79 | a or {1} or True or {2} # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 -80 | +80 | 81 | a or set({1}) or True or set({2}) # SIM222 | = help: Replace with `{1}` @@ -474,10 +474,10 @@ SIM222.py:79:6: SIM222 [*] Use `{1}` instead of `{1} or ...` SIM222.py:81:6: SIM222 [*] Use `set({1})` instead of `set({1}) or ...` | 79 | a or {1} or True or {2} # SIM222 -80 | +80 | 81 | a or set({1}) or True or set({2}) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -82 | +82 | 83 | a or () or True # SIM222 | = help: Replace with `set({1})` @@ -495,10 +495,10 @@ SIM222.py:81:6: SIM222 [*] Use `set({1})` instead of `set({1}) or ...` SIM222.py:83:6: SIM222 [*] Use `True` instead of `... or True` | 81 | a or set({1}) or True or set({2}) # SIM222 -82 | +82 | 83 | a or () or True # SIM222 | ^^^^^^^^^^ SIM222 -84 | +84 | 85 | a or tuple(()) or True # SIM222 | = help: Replace with `True` @@ -516,10 +516,10 @@ SIM222.py:83:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:85:6: SIM222 [*] Use `True` instead of `... or True` | 83 | a or () or True # SIM222 -84 | +84 | 85 | a or tuple(()) or True # SIM222 | ^^^^^^^^^^^^^^^^^ SIM222 -86 | +86 | 87 | a or (1,) or True or (2,) # SIM222 | = help: Replace with `True` @@ -537,10 +537,10 @@ SIM222.py:85:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:87:6: SIM222 [*] Use `(1,)` instead of `(1,) or ...` | 85 | a or tuple(()) or True # SIM222 -86 | +86 | 87 | a or (1,) or True or (2,) # SIM222 | ^^^^^^^^^^^^^^^^^^^^ SIM222 -88 | +88 | 89 | a or tuple((1,)) or True or tuple((2,)) # SIM222 | = help: Replace with `(1,)` @@ -558,10 +558,10 @@ SIM222.py:87:6: SIM222 [*] Use `(1,)` instead of `(1,) or ...` SIM222.py:89:6: SIM222 [*] Use `tuple((1,))` instead of `tuple((1,)) or ...` | 87 | a or (1,) or True or (2,) # SIM222 -88 | +88 | 89 | a or tuple((1,)) or True or tuple((2,)) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -90 | +90 | 91 | a or frozenset() or True # SIM222 | = help: Replace with `tuple((1,))` @@ -579,10 +579,10 @@ SIM222.py:89:6: SIM222 [*] Use `tuple((1,))` instead of `tuple((1,)) or ...` SIM222.py:91:6: SIM222 [*] Use `True` instead of `... or True` | 89 | a or tuple((1,)) or True or tuple((2,)) # SIM222 -90 | +90 | 91 | a or frozenset() or True # SIM222 | ^^^^^^^^^^^^^^^^^^^ SIM222 -92 | +92 | 93 | a or frozenset(frozenset()) or True # SIM222 | = help: Replace with `True` @@ -600,10 +600,10 @@ SIM222.py:91:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:93:6: SIM222 [*] Use `True` instead of `... or True` | 91 | a or frozenset() or True # SIM222 -92 | +92 | 93 | a or frozenset(frozenset()) or True # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -94 | +94 | 95 | a or frozenset({1}) or True or frozenset({2}) # SIM222 | = help: Replace with `True` @@ -621,10 +621,10 @@ SIM222.py:93:6: SIM222 [*] Use `True` instead of `... or True` SIM222.py:95:6: SIM222 [*] Use `frozenset({1})` instead of `frozenset({1}) or ...` | 93 | a or frozenset(frozenset()) or True # SIM222 -94 | +94 | 95 | a or frozenset({1}) or True or frozenset({2}) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -96 | +96 | 97 | a or frozenset(frozenset({1})) or True or frozenset(frozenset({2})) # SIM222 | = help: Replace with `frozenset({1})` @@ -642,7 +642,7 @@ SIM222.py:95:6: SIM222 [*] Use `frozenset({1})` instead of `frozenset({1}) or .. SIM222.py:97:6: SIM222 [*] Use `frozenset(frozenset({1}))` instead of `frozenset(frozenset({1})) or ...` | 95 | a or frozenset({1}) or True or frozenset({2}) # SIM222 -96 | +96 | 97 | a or frozenset(frozenset({1})) or True or frozenset(frozenset({2})) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM222 | @@ -661,10 +661,10 @@ SIM222.py:97:6: SIM222 [*] Use `frozenset(frozenset({1}))` instead of `frozenset SIM222.py:102:6: SIM222 [*] Use `True` instead of `... or True or ...` | 100 | # Inside test `a` is simplified. -101 | +101 | 102 | bool(a or [1] or True or [2]) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -103 | +103 | 104 | assert a or [1] or True or [2] # SIM222 | = help: Replace with `True` @@ -682,10 +682,10 @@ SIM222.py:102:6: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:104:8: SIM222 [*] Use `True` instead of `... or True or ...` | 102 | bool(a or [1] or True or [2]) # SIM222 -103 | +103 | 104 | assert a or [1] or True or [2] # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -105 | +105 | 106 | if (a or [1] or True or [2]) and (a or [1] or True or [2]): # SIM222 | = help: Replace with `True` @@ -703,7 +703,7 @@ SIM222.py:104:8: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:106:5: SIM222 [*] Use `True` instead of `... or True or ...` | 104 | assert a or [1] or True or [2] # SIM222 -105 | +105 | 106 | if (a or [1] or True or [2]) and (a or [1] or True or [2]): # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 107 | pass @@ -723,7 +723,7 @@ SIM222.py:106:5: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:106:35: SIM222 [*] Use `True` instead of `... or True or ...` | 104 | assert a or [1] or True or [2] # SIM222 -105 | +105 | 106 | if (a or [1] or True or [2]) and (a or [1] or True or [2]): # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 107 | pass @@ -743,10 +743,10 @@ SIM222.py:106:35: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:109:6: SIM222 [*] Use `True` instead of `... or True or ...` | 107 | pass -108 | +108 | 109 | 0 if a or [1] or True or [2] else 1 # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 -110 | +110 | 111 | while a or [1] or True or [2]: # SIM222 | = help: Replace with `True` @@ -764,7 +764,7 @@ SIM222.py:109:6: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:111:7: SIM222 [*] Use `True` instead of `... or True or ...` | 109 | 0 if a or [1] or True or [2] else 1 # SIM222 -110 | +110 | 111 | while a or [1] or True or [2]: # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM222 112 | pass @@ -948,10 +948,10 @@ SIM222.py:143:8: SIM222 [*] Use `True` instead of `... or True or ...` SIM222.py:148:6: SIM222 [*] Use `[1]` instead of `[1] or ...` | 146 | # Outside test `a` is not simplified. -147 | +147 | 148 | a or [1] or True or [2] # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 -149 | +149 | 150 | if (a or [1] or True or [2]) == (a or [1]): # SIM222 | = help: Replace with `[1]` @@ -969,7 +969,7 @@ SIM222.py:148:6: SIM222 [*] Use `[1]` instead of `[1] or ...` SIM222.py:150:10: SIM222 [*] Use `[1]` instead of `[1] or ...` | 148 | a or [1] or True or [2] # SIM222 -149 | +149 | 150 | if (a or [1] or True or [2]) == (a or [1]): # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 151 | pass @@ -989,7 +989,7 @@ SIM222.py:150:10: SIM222 [*] Use `[1]` instead of `[1] or ...` SIM222.py:153:11: SIM222 [*] Use `[1]` instead of `[1] or ...` | 151 | pass -152 | +152 | 153 | if f(a or [1] or True or [2]): # SIM222 | ^^^^^^^^^^^^^^^^^^ SIM222 154 | pass @@ -1060,5 +1060,5 @@ SIM222.py:168:7: SIM222 [*] Use `"bar"` instead of `... or "bar"` 168 |-print(f"{''}{''}" or "bar") 168 |+print("bar") 169 169 | print(f"{1}{''}" or "bar") - - +170 170 | +171 171 | diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM223_SIM223.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM223_SIM223.py.snap index 855b2091823cb..50e31f645ceb5 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM223_SIM223.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM223_SIM223.py.snap @@ -19,7 +19,7 @@ SIM223.py:1:4: SIM223 [*] Use `False` instead of `... and False` SIM223.py:4:4: SIM223 [*] Use `False` instead of `... and False` | 2 | pass -3 | +3 | 4 | if (a or b) and False: # SIM223 | ^^^^^^^^^^^^^^^^^^ SIM223 5 | pass @@ -39,7 +39,7 @@ SIM223.py:4:4: SIM223 [*] Use `False` instead of `... and False` SIM223.py:7:10: SIM223 [*] Use `False` instead of `... and False` | 5 | pass -6 | +6 | 7 | if a or (b and False): # SIM223 | ^^^^^^^^^^^ SIM223 8 | pass @@ -59,7 +59,7 @@ SIM223.py:7:10: SIM223 [*] Use `False` instead of `... and False` SIM223.py:19:18: SIM223 [*] Use `False` instead of `False and ...` | 17 | pass -18 | +18 | 19 | if a and f() and False and g() and b: # SIM223 | ^^^^^^^^^^^^^^^^^^^ SIM223 20 | pass @@ -79,7 +79,7 @@ SIM223.py:19:18: SIM223 [*] Use `False` instead of `False and ...` SIM223.py:22:4: SIM223 [*] Use `False` instead of `False and ...` | 20 | pass -21 | +21 | 22 | if False and f() and a and g() and b: # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 23 | pass @@ -99,7 +99,7 @@ SIM223.py:22:4: SIM223 [*] Use `False` instead of `False and ...` SIM223.py:25:4: SIM223 [*] Use `False` instead of `... and False and ...` | 23 | pass -24 | +24 | 25 | if a and False and f() and b and g(): # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 26 | pass @@ -120,7 +120,7 @@ SIM223.py:42:7: SIM223 [*] Use `""` instead of `"" and ...` | 42 | a and "" and False # SIM223 | ^^^^^^^^^^^^ SIM223 -43 | +43 | 44 | a and "foo" and False and "bar" # SIM223 | = help: Replace with `""` @@ -138,10 +138,10 @@ SIM223.py:42:7: SIM223 [*] Use `""` instead of `"" and ...` SIM223.py:44:7: SIM223 [*] Use `False` instead of `... and False and ...` | 42 | a and "" and False # SIM223 -43 | +43 | 44 | a and "foo" and False and "bar" # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -45 | +45 | 46 | a and 0 and False # SIM223 | = help: Replace with `False` @@ -159,10 +159,10 @@ SIM223.py:44:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:46:7: SIM223 [*] Use `0` instead of `0 and ...` | 44 | a and "foo" and False and "bar" # SIM223 -45 | +45 | 46 | a and 0 and False # SIM223 | ^^^^^^^^^^^ SIM223 -47 | +47 | 48 | a and 1 and False and 2 # SIM223 | = help: Replace with `0` @@ -180,10 +180,10 @@ SIM223.py:46:7: SIM223 [*] Use `0` instead of `0 and ...` SIM223.py:48:7: SIM223 [*] Use `False` instead of `... and False and ...` | 46 | a and 0 and False # SIM223 -47 | +47 | 48 | a and 1 and False and 2 # SIM223 | ^^^^^^^^^^^^^^^^^ SIM223 -49 | +49 | 50 | a and 0.0 and False # SIM223 | = help: Replace with `False` @@ -201,10 +201,10 @@ SIM223.py:48:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:50:7: SIM223 [*] Use `0.0` instead of `0.0 and ...` | 48 | a and 1 and False and 2 # SIM223 -49 | +49 | 50 | a and 0.0 and False # SIM223 | ^^^^^^^^^^^^^ SIM223 -51 | +51 | 52 | a and 0.1 and False and 0.2 # SIM223 | = help: Replace with `0.0` @@ -222,10 +222,10 @@ SIM223.py:50:7: SIM223 [*] Use `0.0` instead of `0.0 and ...` SIM223.py:52:7: SIM223 [*] Use `False` instead of `... and False and ...` | 50 | a and 0.0 and False # SIM223 -51 | +51 | 52 | a and 0.1 and False and 0.2 # SIM223 | ^^^^^^^^^^^^^^^^^^^^^ SIM223 -53 | +53 | 54 | a and [] and False # SIM223 | = help: Replace with `False` @@ -243,10 +243,10 @@ SIM223.py:52:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:54:7: SIM223 [*] Use `[]` instead of `[] and ...` | 52 | a and 0.1 and False and 0.2 # SIM223 -53 | +53 | 54 | a and [] and False # SIM223 | ^^^^^^^^^^^^ SIM223 -55 | +55 | 56 | a and list([]) and False # SIM223 | = help: Replace with `[]` @@ -264,10 +264,10 @@ SIM223.py:54:7: SIM223 [*] Use `[]` instead of `[] and ...` SIM223.py:56:7: SIM223 [*] Use `list([])` instead of `list([]) and ...` | 54 | a and [] and False # SIM223 -55 | +55 | 56 | a and list([]) and False # SIM223 | ^^^^^^^^^^^^^^^^^^ SIM223 -57 | +57 | 58 | a and [1] and False and [2] # SIM223 | = help: Replace with `list([])` @@ -285,10 +285,10 @@ SIM223.py:56:7: SIM223 [*] Use `list([])` instead of `list([]) and ...` SIM223.py:58:7: SIM223 [*] Use `False` instead of `... and False and ...` | 56 | a and list([]) and False # SIM223 -57 | +57 | 58 | a and [1] and False and [2] # SIM223 | ^^^^^^^^^^^^^^^^^^^^^ SIM223 -59 | +59 | 60 | a and list([1]) and False and list([2]) # SIM223 | = help: Replace with `False` @@ -306,10 +306,10 @@ SIM223.py:58:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:60:7: SIM223 [*] Use `False` instead of `... and False and ...` | 58 | a and [1] and False and [2] # SIM223 -59 | +59 | 60 | a and list([1]) and False and list([2]) # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -61 | +61 | 62 | a and {} and False # SIM223 | = help: Replace with `False` @@ -327,10 +327,10 @@ SIM223.py:60:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:62:7: SIM223 [*] Use `{}` instead of `{} and ...` | 60 | a and list([1]) and False and list([2]) # SIM223 -61 | +61 | 62 | a and {} and False # SIM223 | ^^^^^^^^^^^^ SIM223 -63 | +63 | 64 | a and dict() and False # SIM223 | = help: Replace with `{}` @@ -348,10 +348,10 @@ SIM223.py:62:7: SIM223 [*] Use `{}` instead of `{} and ...` SIM223.py:64:7: SIM223 [*] Use `dict()` instead of `dict() and ...` | 62 | a and {} and False # SIM223 -63 | +63 | 64 | a and dict() and False # SIM223 | ^^^^^^^^^^^^^^^^ SIM223 -65 | +65 | 66 | a and {1: 1} and False and {2: 2} # SIM223 | = help: Replace with `dict()` @@ -369,10 +369,10 @@ SIM223.py:64:7: SIM223 [*] Use `dict()` instead of `dict() and ...` SIM223.py:66:7: SIM223 [*] Use `False` instead of `... and False and ...` | 64 | a and dict() and False # SIM223 -65 | +65 | 66 | a and {1: 1} and False and {2: 2} # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -67 | +67 | 68 | a and dict({1: 1}) and False and dict({2: 2}) # SIM223 | = help: Replace with `False` @@ -390,10 +390,10 @@ SIM223.py:66:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:68:7: SIM223 [*] Use `False` instead of `... and False and ...` | 66 | a and {1: 1} and False and {2: 2} # SIM223 -67 | +67 | 68 | a and dict({1: 1}) and False and dict({2: 2}) # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -69 | +69 | 70 | a and set() and False # SIM223 | = help: Replace with `False` @@ -411,10 +411,10 @@ SIM223.py:68:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:70:7: SIM223 [*] Use `set()` instead of `set() and ...` | 68 | a and dict({1: 1}) and False and dict({2: 2}) # SIM223 -69 | +69 | 70 | a and set() and False # SIM223 | ^^^^^^^^^^^^^^^ SIM223 -71 | +71 | 72 | a and set(set()) and False # SIM223 | = help: Replace with `set()` @@ -432,10 +432,10 @@ SIM223.py:70:7: SIM223 [*] Use `set()` instead of `set() and ...` SIM223.py:72:7: SIM223 [*] Use `set(set())` instead of `set(set()) and ...` | 70 | a and set() and False # SIM223 -71 | +71 | 72 | a and set(set()) and False # SIM223 | ^^^^^^^^^^^^^^^^^^^^ SIM223 -73 | +73 | 74 | a and {1} and False and {2} # SIM223 | = help: Replace with `set(set())` @@ -453,10 +453,10 @@ SIM223.py:72:7: SIM223 [*] Use `set(set())` instead of `set(set()) and ...` SIM223.py:74:7: SIM223 [*] Use `False` instead of `... and False and ...` | 72 | a and set(set()) and False # SIM223 -73 | +73 | 74 | a and {1} and False and {2} # SIM223 | ^^^^^^^^^^^^^^^^^^^^^ SIM223 -75 | +75 | 76 | a and set({1}) and False and set({2}) # SIM223 | = help: Replace with `False` @@ -474,10 +474,10 @@ SIM223.py:74:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:76:7: SIM223 [*] Use `False` instead of `... and False and ...` | 74 | a and {1} and False and {2} # SIM223 -75 | +75 | 76 | a and set({1}) and False and set({2}) # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -77 | +77 | 78 | a and () and False # SIM222 | = help: Replace with `False` @@ -495,10 +495,10 @@ SIM223.py:76:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:78:7: SIM223 [*] Use `()` instead of `() and ...` | 76 | a and set({1}) and False and set({2}) # SIM223 -77 | +77 | 78 | a and () and False # SIM222 | ^^^^^^^^^^^^ SIM223 -79 | +79 | 80 | a and tuple(()) and False # SIM222 | = help: Replace with `()` @@ -516,10 +516,10 @@ SIM223.py:78:7: SIM223 [*] Use `()` instead of `() and ...` SIM223.py:80:7: SIM223 [*] Use `tuple(())` instead of `tuple(()) and ...` | 78 | a and () and False # SIM222 -79 | +79 | 80 | a and tuple(()) and False # SIM222 | ^^^^^^^^^^^^^^^^^^^ SIM223 -81 | +81 | 82 | a and (1,) and False and (2,) # SIM222 | = help: Replace with `tuple(())` @@ -537,10 +537,10 @@ SIM223.py:80:7: SIM223 [*] Use `tuple(())` instead of `tuple(()) and ...` SIM223.py:82:7: SIM223 [*] Use `False` instead of `... and False and ...` | 80 | a and tuple(()) and False # SIM222 -81 | +81 | 82 | a and (1,) and False and (2,) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -83 | +83 | 84 | a and tuple((1,)) and False and tuple((2,)) # SIM222 | = help: Replace with `False` @@ -558,10 +558,10 @@ SIM223.py:82:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:84:7: SIM223 [*] Use `False` instead of `... and False and ...` | 82 | a and (1,) and False and (2,) # SIM222 -83 | +83 | 84 | a and tuple((1,)) and False and tuple((2,)) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -85 | +85 | 86 | a and frozenset() and False # SIM222 | = help: Replace with `False` @@ -579,10 +579,10 @@ SIM223.py:84:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:86:7: SIM223 [*] Use `frozenset()` instead of `frozenset() and ...` | 84 | a and tuple((1,)) and False and tuple((2,)) # SIM222 -85 | +85 | 86 | a and frozenset() and False # SIM222 | ^^^^^^^^^^^^^^^^^^^^^ SIM223 -87 | +87 | 88 | a and frozenset(frozenset()) and False # SIM222 | = help: Replace with `frozenset()` @@ -600,10 +600,10 @@ SIM223.py:86:7: SIM223 [*] Use `frozenset()` instead of `frozenset() and ...` SIM223.py:88:7: SIM223 [*] Use `frozenset(frozenset())` instead of `frozenset(frozenset()) and ...` | 86 | a and frozenset() and False # SIM222 -87 | +87 | 88 | a and frozenset(frozenset()) and False # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -89 | +89 | 90 | a and frozenset({1}) and False and frozenset({2}) # SIM222 | = help: Replace with `frozenset(frozenset())` @@ -621,10 +621,10 @@ SIM223.py:88:7: SIM223 [*] Use `frozenset(frozenset())` instead of `frozenset(fr SIM223.py:90:7: SIM223 [*] Use `False` instead of `... and False and ...` | 88 | a and frozenset(frozenset()) and False # SIM222 -89 | +89 | 90 | a and frozenset({1}) and False and frozenset({2}) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -91 | +91 | 92 | a and frozenset(frozenset({1})) and False and frozenset(frozenset({2})) # SIM222 | = help: Replace with `False` @@ -642,7 +642,7 @@ SIM223.py:90:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:92:7: SIM223 [*] Use `False` instead of `... and False and ...` | 90 | a and frozenset({1}) and False and frozenset({2}) # SIM222 -91 | +91 | 92 | a and frozenset(frozenset({1})) and False and frozenset(frozenset({2})) # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 | @@ -661,10 +661,10 @@ SIM223.py:92:7: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:97:6: SIM223 [*] Use `False` instead of `... and False and ...` | 95 | # Inside test `a` is simplified. -96 | +96 | 97 | bool(a and [] and False and []) # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -98 | +98 | 99 | assert a and [] and False and [] # SIM223 | = help: Replace with `False` @@ -682,10 +682,10 @@ SIM223.py:97:6: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:99:8: SIM223 [*] Use `False` instead of `... and False and ...` | 97 | bool(a and [] and False and []) # SIM223 - 98 | + 98 | 99 | assert a and [] and False and [] # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -100 | +100 | 101 | if (a and [] and False and []) or (a and [] and False and []): # SIM223 | = help: Replace with `False` @@ -703,7 +703,7 @@ SIM223.py:99:8: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:101:5: SIM223 [*] Use `False` instead of `... and False and ...` | 99 | assert a and [] and False and [] # SIM223 -100 | +100 | 101 | if (a and [] and False and []) or (a and [] and False and []): # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 102 | pass @@ -723,7 +723,7 @@ SIM223.py:101:5: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:101:36: SIM223 [*] Use `False` instead of `... and False and ...` | 99 | assert a and [] and False and [] # SIM223 -100 | +100 | 101 | if (a and [] and False and []) or (a and [] and False and []): # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 102 | pass @@ -743,10 +743,10 @@ SIM223.py:101:36: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:104:6: SIM223 [*] Use `False` instead of `... and False and ...` | 102 | pass -103 | +103 | 104 | 0 if a and [] and False and [] else 1 # SIM222 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 -105 | +105 | 106 | while a and [] and False and []: # SIM223 | = help: Replace with `False` @@ -764,7 +764,7 @@ SIM223.py:104:6: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:106:7: SIM223 [*] Use `False` instead of `... and False and ...` | 104 | 0 if a and [] and False and [] else 1 # SIM222 -105 | +105 | 106 | while a and [] and False and []: # SIM223 | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM223 107 | pass @@ -948,10 +948,10 @@ SIM223.py:138:8: SIM223 [*] Use `False` instead of `... and False and ...` SIM223.py:143:7: SIM223 [*] Use `[]` instead of `[] and ...` | 141 | # Outside test `a` is not simplified. -142 | +142 | 143 | a and [] and False and [] # SIM223 | ^^^^^^^^^^^^^^^^^^^ SIM223 -144 | +144 | 145 | if (a and [] and False and []) == (a and []): # SIM223 | = help: Replace with `[]` @@ -969,7 +969,7 @@ SIM223.py:143:7: SIM223 [*] Use `[]` instead of `[] and ...` SIM223.py:145:11: SIM223 [*] Use `[]` instead of `[] and ...` | 143 | a and [] and False and [] # SIM223 -144 | +144 | 145 | if (a and [] and False and []) == (a and []): # SIM223 | ^^^^^^^^^^^^^^^^^^^ SIM223 146 | pass @@ -989,7 +989,7 @@ SIM223.py:145:11: SIM223 [*] Use `[]` instead of `[] and ...` SIM223.py:148:12: SIM223 [*] Use `[]` instead of `[] and ...` | 146 | pass -147 | +147 | 148 | if f(a and [] and False and []): # SIM223 | ^^^^^^^^^^^^^^^^^^^ SIM223 149 | pass @@ -1023,5 +1023,5 @@ SIM223.py:154:7: SIM223 [*] Use `f"{''}{''}"` instead of `f"{''}{''}" and ...` 154 |-print(f"{''}{''}" and "bar") 154 |+print(f"{''}{''}") 155 155 | print(f"{1}{''}" and "bar") - - +156 156 | +157 157 | diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM300_SIM300.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM300_SIM300.py.snap index 8af686ef8545f..47826242246c9 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM300_SIM300.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM300_SIM300.py.snap @@ -268,7 +268,7 @@ SIM300.py:14:1: SIM300 [*] Yoda condition detected 14 |+(number - 100) > 0 # SIM300 15 15 | B<A[0][0]or B 16 16 | B or(B)<A[0][0] -17 17 | +17 17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG SIM300.py:15:1: SIM300 [*] Yoda condition detected | @@ -277,6 +277,7 @@ SIM300.py:15:1: SIM300 [*] Yoda condition detected 15 | B<A[0][0]or B | ^^^^^^^^^ SIM300 16 | B or(B)<A[0][0] +17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG | = help: Rewrite as `A[0][0] > B` @@ -287,8 +288,8 @@ SIM300.py:15:1: SIM300 [*] Yoda condition detected 15 |-B<A[0][0]or B 15 |+A[0][0] > B or B 16 16 | B or(B)<A[0][0] -17 17 | -18 18 | # Errors in preview +17 17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG +18 18 | SIM300.py:16:5: SIM300 [*] Yoda condition detected | @@ -296,8 +297,7 @@ SIM300.py:16:5: SIM300 [*] Yoda condition detected 15 | B<A[0][0]or B 16 | B or(B)<A[0][0] | ^^^^^^^^^^^ SIM300 -17 | -18 | # Errors in preview +17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG | = help: Rewrite as `A[0][0] > (B)` @@ -307,46 +307,67 @@ SIM300.py:16:5: SIM300 [*] Yoda condition detected 15 15 | B<A[0][0]or B 16 |-B or(B)<A[0][0] 16 |+B or A[0][0] > (B) -17 17 | -18 18 | # Errors in preview -19 19 | ['upper'] == UPPER_LIST +17 17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG +18 18 | +19 19 | # Errors in preview -SIM300.py:19:1: SIM300 [*] Yoda condition detected +SIM300.py:17:1: SIM300 [*] Yoda condition detected | -18 | # Errors in preview -19 | ['upper'] == UPPER_LIST - | ^^^^^^^^^^^^^^^^^^^^^^^ SIM300 -20 | {} == DummyHandler.CONFIG +15 | B<A[0][0]or B +16 | B or(B)<A[0][0] +17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM300 +18 | +19 | # Errors in preview | - = help: Rewrite as `UPPER_LIST == ['upper']` + = help: Rewrite as `DummyHandler.CONFIG == {"non-empty-dict": "is-ok"}` ℹ Safe fix +14 14 | 0 < (number - 100) # SIM300 +15 15 | B<A[0][0]or B 16 16 | B or(B)<A[0][0] -17 17 | -18 18 | # Errors in preview -19 |-['upper'] == UPPER_LIST - 19 |+UPPER_LIST == ['upper'] -20 20 | {} == DummyHandler.CONFIG -21 21 | -22 22 | # Errors in stable +17 |-{"non-empty-dict": "is-ok"} == DummyHandler.CONFIG + 17 |+DummyHandler.CONFIG == {"non-empty-dict": "is-ok"} +18 18 | +19 19 | # Errors in preview +20 20 | ['upper'] == UPPER_LIST SIM300.py:20:1: SIM300 [*] Yoda condition detected | -18 | # Errors in preview -19 | ['upper'] == UPPER_LIST -20 | {} == DummyHandler.CONFIG +19 | # Errors in preview +20 | ['upper'] == UPPER_LIST + | ^^^^^^^^^^^^^^^^^^^^^^^ SIM300 +21 | {} == DummyHandler.CONFIG + | + = help: Rewrite as `UPPER_LIST == ['upper']` + +ℹ Safe fix +17 17 | {"non-empty-dict": "is-ok"} == DummyHandler.CONFIG +18 18 | +19 19 | # Errors in preview +20 |-['upper'] == UPPER_LIST + 20 |+UPPER_LIST == ['upper'] +21 21 | {} == DummyHandler.CONFIG +22 22 | +23 23 | # Errors in stable + +SIM300.py:21:1: SIM300 [*] Yoda condition detected + | +19 | # Errors in preview +20 | ['upper'] == UPPER_LIST +21 | {} == DummyHandler.CONFIG | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM300 -21 | -22 | # Errors in stable +22 | +23 | # Errors in stable | = help: Rewrite as `DummyHandler.CONFIG == {}` ℹ Safe fix -17 17 | -18 18 | # Errors in preview -19 19 | ['upper'] == UPPER_LIST -20 |-{} == DummyHandler.CONFIG - 20 |+DummyHandler.CONFIG == {} -21 21 | -22 22 | # Errors in stable -23 23 | UPPER_LIST == ['upper'] +18 18 | +19 19 | # Errors in preview +20 20 | ['upper'] == UPPER_LIST +21 |-{} == DummyHandler.CONFIG + 21 |+DummyHandler.CONFIG == {} +22 22 | +23 23 | # Errors in stable +24 24 | UPPER_LIST == ['upper'] diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM401_SIM401.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM401_SIM401.py.snap index 15ceaf67f67b6..a89ba6468dc17 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM401_SIM401.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM401_SIM401.py.snap @@ -1,202 +1,173 @@ --- source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs --- -SIM401.py:6:1: SIM401 [*] Use `var = a_dict.get(key, "default1")` instead of an `if` block +SIM401.py:8:1: SIM401 [*] Use `var = a_dict.get(key, "default1")` instead of an `if` block | - 5 | # SIM401 (pattern-1) - 6 | / if key in a_dict: - 7 | | var = a_dict[key] - 8 | | else: - 9 | | var = "default1" + 7 | # SIM401 (pattern-1) + 8 | / if key in a_dict: + 9 | | var = a_dict[key] +10 | | else: +11 | | var = "default1" | |____________________^ SIM401 -10 | -11 | # SIM401 (pattern-2) +12 | +13 | # SIM401 (pattern-2) | = help: Replace with `var = a_dict.get(key, "default1")` ℹ Unsafe fix -3 3 | ### -4 4 | -5 5 | # SIM401 (pattern-1) -6 |-if key in a_dict: -7 |- var = a_dict[key] -8 |-else: -9 |- var = "default1" - 6 |+var = a_dict.get(key, "default1") -10 7 | -11 8 | # SIM401 (pattern-2) -12 9 | if key not in a_dict: - -SIM401.py:12:1: SIM401 [*] Use `var = a_dict.get(key, "default2")` instead of an `if` block +5 5 | a_dict = {} +6 6 | +7 7 | # SIM401 (pattern-1) +8 |-if key in a_dict: +9 |- var = a_dict[key] +10 |-else: +11 |- var = "default1" + 8 |+var = a_dict.get(key, "default1") +12 9 | +13 10 | # SIM401 (pattern-2) +14 11 | if key not in a_dict: + +SIM401.py:14:1: SIM401 [*] Use `var = a_dict.get(key, "default2")` instead of an `if` block | -11 | # SIM401 (pattern-2) -12 | / if key not in a_dict: -13 | | var = "default2" -14 | | else: -15 | | var = a_dict[key] +13 | # SIM401 (pattern-2) +14 | / if key not in a_dict: +15 | | var = "default2" +16 | | else: +17 | | var = a_dict[key] | |_____________________^ SIM401 -16 | -17 | # OK (default contains effect) +18 | +19 | # OK (default contains effect) | = help: Replace with `var = a_dict.get(key, "default2")` ℹ Unsafe fix -9 9 | var = "default1" -10 10 | -11 11 | # SIM401 (pattern-2) -12 |-if key not in a_dict: -13 |- var = "default2" -14 |-else: -15 |- var = a_dict[key] - 12 |+var = a_dict.get(key, "default2") -16 13 | -17 14 | # OK (default contains effect) -18 15 | if key in a_dict: - -SIM401.py:24:1: SIM401 [*] Use `var = a_dict.get(keys[idx], "default")` instead of an `if` block +11 11 | var = "default1" +12 12 | +13 13 | # SIM401 (pattern-2) +14 |-if key not in a_dict: +15 |- var = "default2" +16 |-else: +17 |- var = a_dict[key] + 14 |+var = a_dict.get(key, "default2") +18 15 | +19 16 | # OK (default contains effect) +20 17 | if key in a_dict: + +SIM401.py:26:1: SIM401 [*] Use `var = a_dict.get(keys[idx], "default")` instead of an `if` block | -23 | # SIM401 (complex expression in key) -24 | / if keys[idx] in a_dict: -25 | | var = a_dict[keys[idx]] -26 | | else: -27 | | var = "default" +25 | # SIM401 (complex expression in key) +26 | / if keys[idx] in a_dict: +27 | | var = a_dict[keys[idx]] +28 | | else: +29 | | var = "default" | |___________________^ SIM401 -28 | -29 | # SIM401 (complex expression in dict) +30 | +31 | dicts = {"key": a_dict} | = help: Replace with `var = a_dict.get(keys[idx], "default")` ℹ Unsafe fix -21 21 | var = val1 + val2 -22 22 | -23 23 | # SIM401 (complex expression in key) -24 |-if keys[idx] in a_dict: -25 |- var = a_dict[keys[idx]] -26 |-else: -27 |- var = "default" - 24 |+var = a_dict.get(keys[idx], "default") -28 25 | -29 26 | # SIM401 (complex expression in dict) -30 27 | if key in dicts[idx]: - -SIM401.py:30:1: SIM401 [*] Use `var = dicts[idx].get(key, "default")` instead of an `if` block - | -29 | # SIM401 (complex expression in dict) -30 | / if key in dicts[idx]: -31 | | var = dicts[idx][key] -32 | | else: -33 | | var = "default" - | |___________________^ SIM401 -34 | -35 | # SIM401 (complex expression in var) - | - = help: Replace with `var = dicts[idx].get(key, "default")` - -ℹ Unsafe fix -27 27 | var = "default" -28 28 | -29 29 | # SIM401 (complex expression in dict) -30 |-if key in dicts[idx]: -31 |- var = dicts[idx][key] -32 |-else: -33 |- var = "default" - 30 |+var = dicts[idx].get(key, "default") -34 31 | -35 32 | # SIM401 (complex expression in var) -36 33 | if key in a_dict: - -SIM401.py:36:1: SIM401 [*] Use `vars[idx] = a_dict.get(key, "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789")` instead of an `if` block +23 23 | var = val1 + val2 +24 24 | +25 25 | # SIM401 (complex expression in key) +26 |-if keys[idx] in a_dict: +27 |- var = a_dict[keys[idx]] +28 |-else: +29 |- var = "default" + 26 |+var = a_dict.get(keys[idx], "default") +30 27 | +31 28 | dicts = {"key": a_dict} +32 29 | + +SIM401.py:40:1: SIM401 [*] Use `vars[idx] = a_dict.get(key, "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789")` instead of an `if` block | -35 | # SIM401 (complex expression in var) -36 | / if key in a_dict: -37 | | vars[idx] = a_dict[key] -38 | | else: -39 | | vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789" +39 | # SIM401 (complex expression in var) +40 | / if key in a_dict: +41 | | vars[idx] = a_dict[key] +42 | | else: +43 | | vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789" | |___________________________________________________________________________^ SIM401 -40 | -41 | # SIM401 +44 | +45 | # SIM401 | = help: Replace with `vars[idx] = a_dict.get(key, "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789")` ℹ Unsafe fix -33 33 | var = "default" -34 34 | -35 35 | # SIM401 (complex expression in var) -36 |-if key in a_dict: -37 |- vars[idx] = a_dict[key] -38 |-else: -39 |- vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789" - 36 |+vars[idx] = a_dict.get(key, "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789") -40 37 | -41 38 | # SIM401 -42 39 | if foo(): - -SIM401.py:45:5: SIM401 [*] Use `vars[idx] = a_dict.get(key, "default")` instead of an `if` block +37 37 | var = "default" +38 38 | +39 39 | # SIM401 (complex expression in var) +40 |-if key in a_dict: +41 |- vars[idx] = a_dict[key] +42 |-else: +43 |- vars[idx] = "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789" + 40 |+vars[idx] = a_dict.get(key, "defaultß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789ß9💣2ℝ6789") +44 41 | +45 42 | # SIM401 +46 43 | if foo(): + +SIM401.py:49:5: SIM401 [*] Use `vars[idx] = a_dict.get(key, "default")` instead of an `if` block | -43 | pass -44 | else: -45 | if key in a_dict: - | _____^ -46 | | vars[idx] = a_dict[key] -47 | | else: -48 | | vars[idx] = "default" +47 | pass +48 | else: +49 | / if key in a_dict: +50 | | vars[idx] = a_dict[key] +51 | | else: +52 | | vars[idx] = "default" | |_____________________________^ SIM401 -49 | -50 | ### +53 | +54 | ### | = help: Replace with `vars[idx] = a_dict.get(key, "default")` ℹ Unsafe fix -42 42 | if foo(): -43 43 | pass -44 44 | else: -45 |- if key in a_dict: -46 |- vars[idx] = a_dict[key] -47 |- else: -48 |- vars[idx] = "default" - 45 |+ vars[idx] = a_dict.get(key, "default") -49 46 | -50 47 | ### -51 48 | # Negative cases - -SIM401.py:123:7: SIM401 [*] Use `a_dict.get(key, "default3")` instead of an `if` block +46 46 | if foo(): +47 47 | pass +48 48 | else: +49 |- if key in a_dict: +50 |- vars[idx] = a_dict[key] +51 |- else: +52 |- vars[idx] = "default" + 49 |+ vars[idx] = a_dict.get(key, "default") +53 50 | +54 51 | ### +55 52 | # Negative cases + +SIM401.py:149:7: SIM401 [*] Use `a_dict.get(key, "default3")` instead of an `if` block | -122 | # SIM401 -123 | var = a_dict[key] if key in a_dict else "default3" +148 | # SIM401 +149 | var = a_dict[key] if key in a_dict else "default3" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM401 -124 | -125 | # SIM401 +150 | +151 | # SIM401 | = help: Replace with `a_dict.get(key, "default3")` ℹ Unsafe fix -120 120 | ### -121 121 | -122 122 | # SIM401 -123 |-var = a_dict[key] if key in a_dict else "default3" - 123 |+var = a_dict.get(key, "default3") -124 124 | -125 125 | # SIM401 -126 126 | var = "default-1" if key not in a_dict else a_dict[key] - -SIM401.py:126:7: SIM401 [*] Use `a_dict.get(key, "default-1")` instead of an `if` block +146 146 | ### +147 147 | +148 148 | # SIM401 +149 |-var = a_dict[key] if key in a_dict else "default3" + 149 |+var = a_dict.get(key, "default3") +150 150 | +151 151 | # SIM401 +152 152 | var = "default-1" if key not in a_dict else a_dict[key] + +SIM401.py:152:7: SIM401 [*] Use `a_dict.get(key, "default-1")` instead of an `if` block | -125 | # SIM401 -126 | var = "default-1" if key not in a_dict else a_dict[key] +151 | # SIM401 +152 | var = "default-1" if key not in a_dict else a_dict[key] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM401 -127 | -128 | # OK (default contains effect) +153 | +154 | # OK (default contains effect) | = help: Replace with `a_dict.get(key, "default-1")` ℹ Unsafe fix -123 123 | var = a_dict[key] if key in a_dict else "default3" -124 124 | -125 125 | # SIM401 -126 |-var = "default-1" if key not in a_dict else a_dict[key] - 126 |+var = a_dict.get(key, "default-1") -127 127 | -128 128 | # OK (default contains effect) -129 129 | var = a_dict[key] if key in a_dict else val1 + val2 - - +149 149 | var = a_dict[key] if key in a_dict else "default3" +150 150 | +151 151 | # SIM401 +152 |-var = "default-1" if key not in a_dict else a_dict[key] + 152 |+var = a_dict.get(key, "default-1") +153 153 | +154 154 | # OK (default contains effect) +155 155 | var = a_dict[key] if key in a_dict else val1 + val2 diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM905_SIM905.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM905_SIM905.py.snap new file mode 100644 index 0000000000000..ae93115007f43 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM905_SIM905.py.snap @@ -0,0 +1,1262 @@ +--- +source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +--- +SIM905.py:6:1: SIM905 [*] Consider using a list literal instead of `str.split` + | + 5 | # positives + 6 | / """ + 7 | | itemA + 8 | | itemB + 9 | | itemC +10 | | """.split() + | |___________^ SIM905 +11 | +12 | "a,b,c,d".split(",") + | + = help: Replace with list literal + +ℹ Safe fix +3 3 | no_sep = None +4 4 | +5 5 | # positives +6 |-""" +7 |- itemA +8 |- itemB +9 |- itemC +10 |-""".split() + 6 |+["itemA", "itemB", "itemC"] +11 7 | +12 8 | "a,b,c,d".split(",") +13 9 | "a,b,c,d".split(None) + +SIM905.py:12:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +10 | """.split() +11 | +12 | "a,b,c,d".split(",") + | ^^^^^^^^^^^^^^^^^^^^ SIM905 +13 | "a,b,c,d".split(None) +14 | "a,b,c,d".split(",", 1) + | + = help: Replace with list literal + +ℹ Safe fix +9 9 | itemC +10 10 | """.split() +11 11 | +12 |-"a,b,c,d".split(",") + 12 |+["a", "b", "c", "d"] +13 13 | "a,b,c,d".split(None) +14 14 | "a,b,c,d".split(",", 1) +15 15 | "a,b,c,d".split(None, 1) + +SIM905.py:13:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +12 | "a,b,c,d".split(",") +13 | "a,b,c,d".split(None) + | ^^^^^^^^^^^^^^^^^^^^^ SIM905 +14 | "a,b,c,d".split(",", 1) +15 | "a,b,c,d".split(None, 1) + | + = help: Replace with list literal + +ℹ Safe fix +10 10 | """.split() +11 11 | +12 12 | "a,b,c,d".split(",") +13 |-"a,b,c,d".split(None) + 13 |+["a,b,c,d"] +14 14 | "a,b,c,d".split(",", 1) +15 15 | "a,b,c,d".split(None, 1) +16 16 | "a,b,c,d".split(sep=",") + +SIM905.py:14:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +12 | "a,b,c,d".split(",") +13 | "a,b,c,d".split(None) +14 | "a,b,c,d".split(",", 1) + | ^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +15 | "a,b,c,d".split(None, 1) +16 | "a,b,c,d".split(sep=",") + | + = help: Replace with list literal + +ℹ Safe fix +11 11 | +12 12 | "a,b,c,d".split(",") +13 13 | "a,b,c,d".split(None) +14 |-"a,b,c,d".split(",", 1) + 14 |+["a", "b,c,d"] +15 15 | "a,b,c,d".split(None, 1) +16 16 | "a,b,c,d".split(sep=",") +17 17 | "a,b,c,d".split(sep=None) + +SIM905.py:15:1: SIM905 Consider using a list literal instead of `str.split` + | +13 | "a,b,c,d".split(None) +14 | "a,b,c,d".split(",", 1) +15 | "a,b,c,d".split(None, 1) + | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +16 | "a,b,c,d".split(sep=",") +17 | "a,b,c,d".split(sep=None) + | + = help: Replace with list literal + +SIM905.py:16:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +14 | "a,b,c,d".split(",", 1) +15 | "a,b,c,d".split(None, 1) +16 | "a,b,c,d".split(sep=",") + | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +17 | "a,b,c,d".split(sep=None) +18 | "a,b,c,d".split(sep=",", maxsplit=1) + | + = help: Replace with list literal + +ℹ Safe fix +13 13 | "a,b,c,d".split(None) +14 14 | "a,b,c,d".split(",", 1) +15 15 | "a,b,c,d".split(None, 1) +16 |-"a,b,c,d".split(sep=",") + 16 |+["a", "b", "c", "d"] +17 17 | "a,b,c,d".split(sep=None) +18 18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 19 | "a,b,c,d".split(sep=None, maxsplit=1) + +SIM905.py:17:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +15 | "a,b,c,d".split(None, 1) +16 | "a,b,c,d".split(sep=",") +17 | "a,b,c,d".split(sep=None) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 | "a,b,c,d".split(sep=None, maxsplit=1) + | + = help: Replace with list literal + +ℹ Safe fix +14 14 | "a,b,c,d".split(",", 1) +15 15 | "a,b,c,d".split(None, 1) +16 16 | "a,b,c,d".split(sep=",") +17 |-"a,b,c,d".split(sep=None) + 17 |+["a,b,c,d"] +18 18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 20 | "a,b,c,d".split(maxsplit=1, sep=",") + +SIM905.py:18:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +16 | "a,b,c,d".split(sep=",") +17 | "a,b,c,d".split(sep=None) +18 | "a,b,c,d".split(sep=",", maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 | "a,b,c,d".split(maxsplit=1, sep=",") + | + = help: Replace with list literal + +ℹ Safe fix +15 15 | "a,b,c,d".split(None, 1) +16 16 | "a,b,c,d".split(sep=",") +17 17 | "a,b,c,d".split(sep=None) +18 |-"a,b,c,d".split(sep=",", maxsplit=1) + 18 |+["a", "b,c,d"] +19 19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 20 | "a,b,c,d".split(maxsplit=1, sep=",") +21 21 | "a,b,c,d".split(maxsplit=1, sep=None) + +SIM905.py:19:1: SIM905 Consider using a list literal instead of `str.split` + | +17 | "a,b,c,d".split(sep=None) +18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 | "a,b,c,d".split(sep=None, maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +20 | "a,b,c,d".split(maxsplit=1, sep=",") +21 | "a,b,c,d".split(maxsplit=1, sep=None) + | + = help: Replace with list literal + +SIM905.py:20:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 | "a,b,c,d".split(maxsplit=1, sep=",") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +21 | "a,b,c,d".split(maxsplit=1, sep=None) +22 | "a,b,c,d".split(",", maxsplit=1) + | + = help: Replace with list literal + +ℹ Safe fix +17 17 | "a,b,c,d".split(sep=None) +18 18 | "a,b,c,d".split(sep=",", maxsplit=1) +19 19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 |-"a,b,c,d".split(maxsplit=1, sep=",") + 20 |+["a", "b,c,d"] +21 21 | "a,b,c,d".split(maxsplit=1, sep=None) +22 22 | "a,b,c,d".split(",", maxsplit=1) +23 23 | "a,b,c,d".split(None, maxsplit=1) + +SIM905.py:21:1: SIM905 Consider using a list literal instead of `str.split` + | +19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 | "a,b,c,d".split(maxsplit=1, sep=",") +21 | "a,b,c,d".split(maxsplit=1, sep=None) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +22 | "a,b,c,d".split(",", maxsplit=1) +23 | "a,b,c,d".split(None, maxsplit=1) + | + = help: Replace with list literal + +SIM905.py:22:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +20 | "a,b,c,d".split(maxsplit=1, sep=",") +21 | "a,b,c,d".split(maxsplit=1, sep=None) +22 | "a,b,c,d".split(",", maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +23 | "a,b,c,d".split(None, maxsplit=1) +24 | "a,b,c,d".split(maxsplit=1) + | + = help: Replace with list literal + +ℹ Safe fix +19 19 | "a,b,c,d".split(sep=None, maxsplit=1) +20 20 | "a,b,c,d".split(maxsplit=1, sep=",") +21 21 | "a,b,c,d".split(maxsplit=1, sep=None) +22 |-"a,b,c,d".split(",", maxsplit=1) + 22 |+["a", "b,c,d"] +23 23 | "a,b,c,d".split(None, maxsplit=1) +24 24 | "a,b,c,d".split(maxsplit=1) +25 25 | "a,b,c,d".split(maxsplit=1.0) + +SIM905.py:23:1: SIM905 Consider using a list literal instead of `str.split` + | +21 | "a,b,c,d".split(maxsplit=1, sep=None) +22 | "a,b,c,d".split(",", maxsplit=1) +23 | "a,b,c,d".split(None, maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +24 | "a,b,c,d".split(maxsplit=1) +25 | "a,b,c,d".split(maxsplit=1.0) + | + = help: Replace with list literal + +SIM905.py:24:1: SIM905 Consider using a list literal instead of `str.split` + | +22 | "a,b,c,d".split(",", maxsplit=1) +23 | "a,b,c,d".split(None, maxsplit=1) +24 | "a,b,c,d".split(maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +25 | "a,b,c,d".split(maxsplit=1.0) +26 | "a,b,c,d".split(maxsplit=1) + | + = help: Replace with list literal + +SIM905.py:26:1: SIM905 Consider using a list literal instead of `str.split` + | +24 | "a,b,c,d".split(maxsplit=1) +25 | "a,b,c,d".split(maxsplit=1.0) +26 | "a,b,c,d".split(maxsplit=1) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +27 | "a,b,c,d".split(maxsplit=0) +28 | "VERB AUX PRON ADP DET".split(" ") + | + = help: Replace with list literal + +SIM905.py:27:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +25 | "a,b,c,d".split(maxsplit=1.0) +26 | "a,b,c,d".split(maxsplit=1) +27 | "a,b,c,d".split(maxsplit=0) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +28 | "VERB AUX PRON ADP DET".split(" ") +29 | ' 1 2 3 '.split() + | + = help: Replace with list literal + +ℹ Safe fix +24 24 | "a,b,c,d".split(maxsplit=1) +25 25 | "a,b,c,d".split(maxsplit=1.0) +26 26 | "a,b,c,d".split(maxsplit=1) +27 |-"a,b,c,d".split(maxsplit=0) + 27 |+["a,b,c,d"] +28 28 | "VERB AUX PRON ADP DET".split(" ") +29 29 | ' 1 2 3 '.split() +30 30 | '1<>2<>3<4'.split('<>') + +SIM905.py:28:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +26 | "a,b,c,d".split(maxsplit=1) +27 | "a,b,c,d".split(maxsplit=0) +28 | "VERB AUX PRON ADP DET".split(" ") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +29 | ' 1 2 3 '.split() +30 | '1<>2<>3<4'.split('<>') + | + = help: Replace with list literal + +ℹ Safe fix +25 25 | "a,b,c,d".split(maxsplit=1.0) +26 26 | "a,b,c,d".split(maxsplit=1) +27 27 | "a,b,c,d".split(maxsplit=0) +28 |-"VERB AUX PRON ADP DET".split(" ") + 28 |+["VERB", "AUX", "PRON", "ADP", "DET"] +29 29 | ' 1 2 3 '.split() +30 30 | '1<>2<>3<4'.split('<>') +31 31 | + +SIM905.py:29:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +27 | "a,b,c,d".split(maxsplit=0) +28 | "VERB AUX PRON ADP DET".split(" ") +29 | ' 1 2 3 '.split() + | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +30 | '1<>2<>3<4'.split('<>') + | + = help: Replace with list literal + +ℹ Safe fix +26 26 | "a,b,c,d".split(maxsplit=1) +27 27 | "a,b,c,d".split(maxsplit=0) +28 28 | "VERB AUX PRON ADP DET".split(" ") +29 |-' 1 2 3 '.split() + 29 |+['1', '2', '3'] +30 30 | '1<>2<>3<4'.split('<>') +31 31 | +32 32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] + +SIM905.py:30:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +28 | "VERB AUX PRON ADP DET".split(" ") +29 | ' 1 2 3 '.split() +30 | '1<>2<>3<4'.split('<>') + | ^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +31 | +32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] + | + = help: Replace with list literal + +ℹ Safe fix +27 27 | "a,b,c,d".split(maxsplit=0) +28 28 | "VERB AUX PRON ADP DET".split(" ") +29 29 | ' 1 2 3 '.split() +30 |-'1<>2<>3<4'.split('<>') + 30 |+['1', '2', '3<4'] +31 31 | +32 32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +33 33 | "".split() # [] + +SIM905.py:32:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +30 | '1<>2<>3<4'.split('<>') +31 | +32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +33 | "".split() # [] +34 | """ + | + = help: Replace with list literal + +ℹ Safe fix +29 29 | ' 1 2 3 '.split() +30 30 | '1<>2<>3<4'.split('<>') +31 31 | +32 |-" a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] + 32 |+[" a", "a a", "a a "] # [" a", "a a", "a a "] +33 33 | "".split() # [] +34 34 | """ +35 35 | """.split() # [] + +SIM905.py:33:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +33 | "".split() # [] + | ^^^^^^^^^^ SIM905 +34 | """ +35 | """.split() # [] + | + = help: Replace with list literal + +ℹ Safe fix +30 30 | '1<>2<>3<4'.split('<>') +31 31 | +32 32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +33 |-"".split() # [] + 33 |+[] # [] +34 34 | """ +35 35 | """.split() # [] +36 36 | " ".split() # [] + +SIM905.py:34:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +33 | "".split() # [] +34 | / """ +35 | | """.split() # [] + | |___________^ SIM905 +36 | " ".split() # [] +37 | "/abc/".split() # ["/abc/"] + | + = help: Replace with list literal + +ℹ Safe fix +31 31 | +32 32 | " a*a a*a a ".split("*", -1) # [" a", "a a", "a a "] +33 33 | "".split() # [] +34 |-""" +35 |-""".split() # [] + 34 |+[] # [] +36 35 | " ".split() # [] +37 36 | "/abc/".split() # ["/abc/"] +38 37 | ("a,b,c" + +SIM905.py:36:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +34 | """ +35 | """.split() # [] +36 | " ".split() # [] + | ^^^^^^^^^^^^^^^^^ SIM905 +37 | "/abc/".split() # ["/abc/"] +38 | ("a,b,c" + | + = help: Replace with list literal + +ℹ Safe fix +33 33 | "".split() # [] +34 34 | """ +35 35 | """.split() # [] +36 |-" ".split() # [] + 36 |+[] # [] +37 37 | "/abc/".split() # ["/abc/"] +38 38 | ("a,b,c" +39 39 | # comment + +SIM905.py:37:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +35 | """.split() # [] +36 | " ".split() # [] +37 | "/abc/".split() # ["/abc/"] + | ^^^^^^^^^^^^^^^ SIM905 +38 | ("a,b,c" +39 | # comment + | + = help: Replace with list literal + +ℹ Safe fix +34 34 | """ +35 35 | """.split() # [] +36 36 | " ".split() # [] +37 |-"/abc/".split() # ["/abc/"] + 37 |+["/abc/"] # ["/abc/"] +38 38 | ("a,b,c" +39 39 | # comment +40 40 | .split() + +SIM905.py:38:2: SIM905 [*] Consider using a list literal instead of `str.split` + | +36 | " ".split() # [] +37 | "/abc/".split() # ["/abc/"] +38 | ("a,b,c" + | __^ +39 | | # comment +40 | | .split() + | |________^ SIM905 +41 | ) # ["a,b,c"] +42 | ("a,b,c" + | + = help: Replace with list literal + +ℹ Unsafe fix +35 35 | """.split() # [] +36 36 | " ".split() # [] +37 37 | "/abc/".split() # ["/abc/"] +38 |-("a,b,c" +39 |-# comment +40 |-.split() + 38 |+(["a,b,c"] +41 39 | ) # ["a,b,c"] +42 40 | ("a,b,c" +43 41 | # comment1 + +SIM905.py:42:2: SIM905 [*] Consider using a list literal instead of `str.split` + | +40 | .split() +41 | ) # ["a,b,c"] +42 | ("a,b,c" + | __^ +43 | | # comment1 +44 | | .split(",") + | |___________^ SIM905 +45 | ) # ["a", "b", "c"] +46 | ("a," + | + = help: Replace with list literal + +ℹ Unsafe fix +39 39 | # comment +40 40 | .split() +41 41 | ) # ["a,b,c"] +42 |-("a,b,c" +43 |-# comment1 +44 |-.split(",") + 42 |+(["a", "b", "c"] +45 43 | ) # ["a", "b", "c"] +46 44 | ("a," +47 45 | # comment + +SIM905.py:46:2: SIM905 [*] Consider using a list literal instead of `str.split` + | +44 | .split(",") +45 | ) # ["a", "b", "c"] +46 | ("a," + | __^ +47 | | # comment +48 | | "b," +49 | | "c" +50 | | .split(",") + | |___________^ SIM905 +51 | ) # ["a", "b", "c"] + | + = help: Replace with list literal + +ℹ Unsafe fix +43 43 | # comment1 +44 44 | .split(",") +45 45 | ) # ["a", "b", "c"] +46 |-("a," +47 |-# comment +48 |-"b," +49 |-"c" +50 |-.split(",") + 46 |+(["a", "b", "c"] +51 47 | ) # ["a", "b", "c"] +52 48 | +53 49 | "hello "\ + +SIM905.py:53:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +51 | ) # ["a", "b", "c"] +52 | +53 | / "hello "\ +54 | | "world".split() + | |___________________^ SIM905 +55 | # ["hello", "world"] + | + = help: Replace with list literal + +ℹ Safe fix +50 50 | .split(",") +51 51 | ) # ["a", "b", "c"] +52 52 | +53 |-"hello "\ +54 |- "world".split() + 53 |+["hello", "world"] +55 54 | # ["hello", "world"] +56 55 | +57 56 | # prefixes and isc + +SIM905.py:58:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +57 | # prefixes and isc +58 | u"a b".split() # [u"a", u"b"] + | ^^^^^^^^^^^^^^ SIM905 +59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 | ("a " "b").split() # ["a", "b"] + | + = help: Replace with list literal + +ℹ Safe fix +55 55 | # ["hello", "world"] +56 56 | +57 57 | # prefixes and isc +58 |-u"a b".split() # [u"a", u"b"] + 58 |+[u"a", u"b"] # [u"a", u"b"] +59 59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 60 | ("a " "b").split() # ["a", "b"] +61 61 | "a " "b".split() # ["a", "b"] + +SIM905.py:59:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +57 | # prefixes and isc +58 | u"a b".split() # [u"a", u"b"] +59 | r"a \n b".split() # [r"a", r"\n", r"b"] + | ^^^^^^^^^^^^^^^^^ SIM905 +60 | ("a " "b").split() # ["a", "b"] +61 | "a " "b".split() # ["a", "b"] + | + = help: Replace with list literal + +ℹ Safe fix +56 56 | +57 57 | # prefixes and isc +58 58 | u"a b".split() # [u"a", u"b"] +59 |-r"a \n b".split() # [r"a", r"\n", r"b"] + 59 |+[r"a", r"\n", r"b"] # [r"a", r"\n", r"b"] +60 60 | ("a " "b").split() # ["a", "b"] +61 61 | "a " "b".split() # ["a", "b"] +62 62 | u"a " "b".split() # [u"a", u"b"] + +SIM905.py:60:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +58 | u"a b".split() # [u"a", u"b"] +59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 | ("a " "b").split() # ["a", "b"] + | ^^^^^^^^^^^^^^^^^^ SIM905 +61 | "a " "b".split() # ["a", "b"] +62 | u"a " "b".split() # [u"a", u"b"] + | + = help: Replace with list literal + +ℹ Safe fix +57 57 | # prefixes and isc +58 58 | u"a b".split() # [u"a", u"b"] +59 59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 |-("a " "b").split() # ["a", "b"] + 60 |+["a", "b"] # ["a", "b"] +61 61 | "a " "b".split() # ["a", "b"] +62 62 | u"a " "b".split() # [u"a", u"b"] +63 63 | "a " u"b".split() # ["a", "b"] + +SIM905.py:61:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 | ("a " "b").split() # ["a", "b"] +61 | "a " "b".split() # ["a", "b"] + | ^^^^^^^^^^^^^^^^ SIM905 +62 | u"a " "b".split() # [u"a", u"b"] +63 | "a " u"b".split() # ["a", "b"] + | + = help: Replace with list literal + +ℹ Safe fix +58 58 | u"a b".split() # [u"a", u"b"] +59 59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 60 | ("a " "b").split() # ["a", "b"] +61 |-"a " "b".split() # ["a", "b"] + 61 |+["a", "b"] # ["a", "b"] +62 62 | u"a " "b".split() # [u"a", u"b"] +63 63 | "a " u"b".split() # ["a", "b"] +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] + +SIM905.py:62:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +60 | ("a " "b").split() # ["a", "b"] +61 | "a " "b".split() # ["a", "b"] +62 | u"a " "b".split() # [u"a", u"b"] + | ^^^^^^^^^^^^^^^^^ SIM905 +63 | "a " u"b".split() # ["a", "b"] +64 | u"a " r"\n".split() # [u"a", u"\\n"] + | + = help: Replace with list literal + +ℹ Safe fix +59 59 | r"a \n b".split() # [r"a", r"\n", r"b"] +60 60 | ("a " "b").split() # ["a", "b"] +61 61 | "a " "b".split() # ["a", "b"] +62 |-u"a " "b".split() # [u"a", u"b"] + 62 |+[u"a", u"b"] # [u"a", u"b"] +63 63 | "a " u"b".split() # ["a", "b"] +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 65 | r"\n " u"\n".split() # [r"\n"] + +SIM905.py:63:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +61 | "a " "b".split() # ["a", "b"] +62 | u"a " "b".split() # [u"a", u"b"] +63 | "a " u"b".split() # ["a", "b"] + | ^^^^^^^^^^^^^^^^^ SIM905 +64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 | r"\n " u"\n".split() # [r"\n"] + | + = help: Replace with list literal + +ℹ Safe fix +60 60 | ("a " "b").split() # ["a", "b"] +61 61 | "a " "b".split() # ["a", "b"] +62 62 | u"a " "b".split() # [u"a", u"b"] +63 |-"a " u"b".split() # ["a", "b"] + 63 |+["a", "b"] # ["a", "b"] +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 65 | r"\n " u"\n".split() # [r"\n"] +66 66 | r"\n " "\n".split() # [r"\n"] + +SIM905.py:64:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +62 | u"a " "b".split() # [u"a", u"b"] +63 | "a " u"b".split() # ["a", "b"] +64 | u"a " r"\n".split() # [u"a", u"\\n"] + | ^^^^^^^^^^^^^^^^^^^ SIM905 +65 | r"\n " u"\n".split() # [r"\n"] +66 | r"\n " "\n".split() # [r"\n"] + | + = help: Replace with list literal + +ℹ Safe fix +61 61 | "a " "b".split() # ["a", "b"] +62 62 | u"a " "b".split() # [u"a", u"b"] +63 63 | "a " u"b".split() # ["a", "b"] +64 |-u"a " r"\n".split() # [u"a", u"\\n"] + 64 |+[u"a", u"\\n"] # [u"a", u"\\n"] +65 65 | r"\n " u"\n".split() # [r"\n"] +66 66 | r"\n " "\n".split() # [r"\n"] +67 67 | "a " r"\n".split() # ["a", "\\n"] + +SIM905.py:65:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +63 | "a " u"b".split() # ["a", "b"] +64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 | r"\n " u"\n".split() # [r"\n"] + | ^^^^^^^^^^^^^^^^^^^^ SIM905 +66 | r"\n " "\n".split() # [r"\n"] +67 | "a " r"\n".split() # ["a", "\\n"] + | + = help: Replace with list literal + +ℹ Safe fix +62 62 | u"a " "b".split() # [u"a", u"b"] +63 63 | "a " u"b".split() # ["a", "b"] +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 |-r"\n " u"\n".split() # [r"\n"] + 65 |+[r"\n"] # [r"\n"] +66 66 | r"\n " "\n".split() # [r"\n"] +67 67 | "a " r"\n".split() # ["a", "\\n"] +68 68 | + +SIM905.py:66:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 | r"\n " u"\n".split() # [r"\n"] +66 | r"\n " "\n".split() # [r"\n"] + | ^^^^^^^^^^^^^^^^^^^ SIM905 +67 | "a " r"\n".split() # ["a", "\\n"] + | + = help: Replace with list literal + +ℹ Safe fix +63 63 | "a " u"b".split() # ["a", "b"] +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 65 | r"\n " u"\n".split() # [r"\n"] +66 |-r"\n " "\n".split() # [r"\n"] + 66 |+[r"\n"] # [r"\n"] +67 67 | "a " r"\n".split() # ["a", "\\n"] +68 68 | +69 69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] + +SIM905.py:67:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +65 | r"\n " u"\n".split() # [r"\n"] +66 | r"\n " "\n".split() # [r"\n"] +67 | "a " r"\n".split() # ["a", "\\n"] + | ^^^^^^^^^^^^^^^^^^ SIM905 +68 | +69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] + | + = help: Replace with list literal + +ℹ Safe fix +64 64 | u"a " r"\n".split() # [u"a", u"\\n"] +65 65 | r"\n " u"\n".split() # [r"\n"] +66 66 | r"\n " "\n".split() # [r"\n"] +67 |-"a " r"\n".split() # ["a", "\\n"] + 67 |+["a", "\\n"] # ["a", "\\n"] +68 68 | +69 69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] + +SIM905.py:69:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +67 | "a " r"\n".split() # ["a", "\\n"] +68 | +69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] + | + = help: Replace with list literal + +ℹ Safe fix +66 66 | r"\n " "\n".split() # [r"\n"] +67 67 | "a " r"\n".split() # ["a", "\\n"] +68 68 | +69 |-"a,b,c".split(',', maxsplit=0) # ["a,b,c"] + 69 |+["a,b,c"] # ["a,b,c"] +70 70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +72 72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + +SIM905.py:70:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + | + = help: Replace with list literal + +ℹ Safe fix +67 67 | "a " r"\n".split() # ["a", "\\n"] +68 68 | +69 69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 |-"a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] + 70 |+["a", "b", "c"] # ["a", "b", "c"] +71 71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +72 72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] +73 73 | + +SIM905.py:71:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + | + = help: Replace with list literal + +ℹ Safe fix +68 68 | +69 69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 |-"a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] + 71 |+["a", "b", "c"] # ["a", "b", "c"] +72 72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] +73 73 | +74 74 | # negatives + +SIM905.py:72:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +72 | "a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +73 | +74 | # negatives + | + = help: Replace with list literal + +ℹ Safe fix +69 69 | "a,b,c".split(',', maxsplit=0) # ["a,b,c"] +70 70 | "a,b,c".split(',', maxsplit=-1) # ["a", "b", "c"] +71 71 | "a,b,c".split(',', maxsplit=-2) # ["a", "b", "c"] +72 |-"a,b,c".split(',', maxsplit=-0) # ["a,b,c"] + 72 |+["a,b,c"] # ["a,b,c"] +73 73 | +74 74 | # negatives +75 75 | + +SIM905.py:103:1: SIM905 [*] Consider using a list literal instead of `str.split` + | +102 | # another positive demonstrating quote preservation +103 | / """ +104 | | "itemA" +105 | | 'itemB' +106 | | '''itemC''' +107 | | "'itemD'" +108 | | """.split() + | |___________^ SIM905 +109 | +110 | # https://github.com/astral-sh/ruff/issues/18042 + | + = help: Replace with list literal + +ℹ Safe fix +100 100 | +101 101 | +102 102 | # another positive demonstrating quote preservation +103 |-""" +104 |-"itemA" +105 |-'itemB' +106 |-'''itemC''' +107 |-"'itemD'" +108 |-""".split() + 103 |+['"itemA"', "'itemB'", "'''itemC'''", "\"'itemD'\""] +109 104 | +110 105 | # https://github.com/astral-sh/ruff/issues/18042 +111 106 | print("a,b".rsplit(",")) + +SIM905.py:111:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +110 | # https://github.com/astral-sh/ruff/issues/18042 +111 | print("a,b".rsplit(",")) + | ^^^^^^^^^^^^^^^^^ SIM905 +112 | print("a,b,c".rsplit(",", 1)) + | + = help: Replace with list literal + +ℹ Safe fix +108 108 | """.split() +109 109 | +110 110 | # https://github.com/astral-sh/ruff/issues/18042 +111 |-print("a,b".rsplit(",")) + 111 |+print(["a", "b"]) +112 112 | print("a,b,c".rsplit(",", 1)) +113 113 | +114 114 | # https://github.com/astral-sh/ruff/issues/18069 + +SIM905.py:112:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +110 | # https://github.com/astral-sh/ruff/issues/18042 +111 | print("a,b".rsplit(",")) +112 | print("a,b,c".rsplit(",", 1)) + | ^^^^^^^^^^^^^^^^^^^^^^ SIM905 +113 | +114 | # https://github.com/astral-sh/ruff/issues/18069 + | + = help: Replace with list literal + +ℹ Safe fix +109 109 | +110 110 | # https://github.com/astral-sh/ruff/issues/18042 +111 111 | print("a,b".rsplit(",")) +112 |-print("a,b,c".rsplit(",", 1)) + 112 |+print(["a,b", "c"]) +113 113 | +114 114 | # https://github.com/astral-sh/ruff/issues/18069 +115 115 | + +SIM905.py:116:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +114 | # https://github.com/astral-sh/ruff/issues/18069 +115 | +116 | print("".split(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^ SIM905 +117 | print("".split(sep=None, maxsplit=0)) +118 | print(" ".split(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +113 113 | +114 114 | # https://github.com/astral-sh/ruff/issues/18069 +115 115 | +116 |-print("".split(maxsplit=0)) + 116 |+print([]) +117 117 | print("".split(sep=None, maxsplit=0)) +118 118 | print(" ".split(maxsplit=0)) +119 119 | print(" ".split(sep=None, maxsplit=0)) + +SIM905.py:117:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +116 | print("".split(maxsplit=0)) +117 | print("".split(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +118 | print(" ".split(maxsplit=0)) +119 | print(" ".split(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +114 114 | # https://github.com/astral-sh/ruff/issues/18069 +115 115 | +116 116 | print("".split(maxsplit=0)) +117 |-print("".split(sep=None, maxsplit=0)) + 117 |+print([]) +118 118 | print(" ".split(maxsplit=0)) +119 119 | print(" ".split(sep=None, maxsplit=0)) +120 120 | print(" x ".split(maxsplit=0)) + +SIM905.py:118:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +116 | print("".split(maxsplit=0)) +117 | print("".split(sep=None, maxsplit=0)) +118 | print(" ".split(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^ SIM905 +119 | print(" ".split(sep=None, maxsplit=0)) +120 | print(" x ".split(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +115 115 | +116 116 | print("".split(maxsplit=0)) +117 117 | print("".split(sep=None, maxsplit=0)) +118 |-print(" ".split(maxsplit=0)) + 118 |+print([]) +119 119 | print(" ".split(sep=None, maxsplit=0)) +120 120 | print(" x ".split(maxsplit=0)) +121 121 | print(" x ".split(sep=None, maxsplit=0)) + +SIM905.py:119:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +117 | print("".split(sep=None, maxsplit=0)) +118 | print(" ".split(maxsplit=0)) +119 | print(" ".split(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +120 | print(" x ".split(maxsplit=0)) +121 | print(" x ".split(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +116 116 | print("".split(maxsplit=0)) +117 117 | print("".split(sep=None, maxsplit=0)) +118 118 | print(" ".split(maxsplit=0)) +119 |-print(" ".split(sep=None, maxsplit=0)) + 119 |+print([]) +120 120 | print(" x ".split(maxsplit=0)) +121 121 | print(" x ".split(sep=None, maxsplit=0)) +122 122 | print(" x ".split(maxsplit=0)) + +SIM905.py:120:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +118 | print(" ".split(maxsplit=0)) +119 | print(" ".split(sep=None, maxsplit=0)) +120 | print(" x ".split(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +121 | print(" x ".split(sep=None, maxsplit=0)) +122 | print(" x ".split(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +117 117 | print("".split(sep=None, maxsplit=0)) +118 118 | print(" ".split(maxsplit=0)) +119 119 | print(" ".split(sep=None, maxsplit=0)) +120 |-print(" x ".split(maxsplit=0)) + 120 |+print(["x "]) +121 121 | print(" x ".split(sep=None, maxsplit=0)) +122 122 | print(" x ".split(maxsplit=0)) +123 123 | print(" x ".split(sep=None, maxsplit=0)) + +SIM905.py:121:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +119 | print(" ".split(sep=None, maxsplit=0)) +120 | print(" x ".split(maxsplit=0)) +121 | print(" x ".split(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +122 | print(" x ".split(maxsplit=0)) +123 | print(" x ".split(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +118 118 | print(" ".split(maxsplit=0)) +119 119 | print(" ".split(sep=None, maxsplit=0)) +120 120 | print(" x ".split(maxsplit=0)) +121 |-print(" x ".split(sep=None, maxsplit=0)) + 121 |+print(["x "]) +122 122 | print(" x ".split(maxsplit=0)) +123 123 | print(" x ".split(sep=None, maxsplit=0)) +124 124 | print("".rsplit(maxsplit=0)) + +SIM905.py:122:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +120 | print(" x ".split(maxsplit=0)) +121 | print(" x ".split(sep=None, maxsplit=0)) +122 | print(" x ".split(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +123 | print(" x ".split(sep=None, maxsplit=0)) +124 | print("".rsplit(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +119 119 | print(" ".split(sep=None, maxsplit=0)) +120 120 | print(" x ".split(maxsplit=0)) +121 121 | print(" x ".split(sep=None, maxsplit=0)) +122 |-print(" x ".split(maxsplit=0)) + 122 |+print(["x "]) +123 123 | print(" x ".split(sep=None, maxsplit=0)) +124 124 | print("".rsplit(maxsplit=0)) +125 125 | print("".rsplit(sep=None, maxsplit=0)) + +SIM905.py:123:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +121 | print(" x ".split(sep=None, maxsplit=0)) +122 | print(" x ".split(maxsplit=0)) +123 | print(" x ".split(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +124 | print("".rsplit(maxsplit=0)) +125 | print("".rsplit(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +120 120 | print(" x ".split(maxsplit=0)) +121 121 | print(" x ".split(sep=None, maxsplit=0)) +122 122 | print(" x ".split(maxsplit=0)) +123 |-print(" x ".split(sep=None, maxsplit=0)) + 123 |+print(["x "]) +124 124 | print("".rsplit(maxsplit=0)) +125 125 | print("".rsplit(sep=None, maxsplit=0)) +126 126 | print(" ".rsplit(maxsplit=0)) + +SIM905.py:124:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +122 | print(" x ".split(maxsplit=0)) +123 | print(" x ".split(sep=None, maxsplit=0)) +124 | print("".rsplit(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^ SIM905 +125 | print("".rsplit(sep=None, maxsplit=0)) +126 | print(" ".rsplit(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +121 121 | print(" x ".split(sep=None, maxsplit=0)) +122 122 | print(" x ".split(maxsplit=0)) +123 123 | print(" x ".split(sep=None, maxsplit=0)) +124 |-print("".rsplit(maxsplit=0)) + 124 |+print([]) +125 125 | print("".rsplit(sep=None, maxsplit=0)) +126 126 | print(" ".rsplit(maxsplit=0)) +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) + +SIM905.py:125:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +123 | print(" x ".split(sep=None, maxsplit=0)) +124 | print("".rsplit(maxsplit=0)) +125 | print("".rsplit(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +126 | print(" ".rsplit(maxsplit=0)) +127 | print(" ".rsplit(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +122 122 | print(" x ".split(maxsplit=0)) +123 123 | print(" x ".split(sep=None, maxsplit=0)) +124 124 | print("".rsplit(maxsplit=0)) +125 |-print("".rsplit(sep=None, maxsplit=0)) + 125 |+print([]) +126 126 | print(" ".rsplit(maxsplit=0)) +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 128 | print(" x ".rsplit(maxsplit=0)) + +SIM905.py:126:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +124 | print("".rsplit(maxsplit=0)) +125 | print("".rsplit(sep=None, maxsplit=0)) +126 | print(" ".rsplit(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^ SIM905 +127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 | print(" x ".rsplit(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +123 123 | print(" x ".split(sep=None, maxsplit=0)) +124 124 | print("".rsplit(maxsplit=0)) +125 125 | print("".rsplit(sep=None, maxsplit=0)) +126 |-print(" ".rsplit(maxsplit=0)) + 126 |+print([]) +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 128 | print(" x ".rsplit(maxsplit=0)) +129 129 | print(" x ".rsplit(maxsplit=0)) + +SIM905.py:127:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +125 | print("".rsplit(sep=None, maxsplit=0)) +126 | print(" ".rsplit(maxsplit=0)) +127 | print(" ".rsplit(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +128 | print(" x ".rsplit(maxsplit=0)) +129 | print(" x ".rsplit(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +124 124 | print("".rsplit(maxsplit=0)) +125 125 | print("".rsplit(sep=None, maxsplit=0)) +126 126 | print(" ".rsplit(maxsplit=0)) +127 |-print(" ".rsplit(sep=None, maxsplit=0)) + 127 |+print([]) +128 128 | print(" x ".rsplit(maxsplit=0)) +129 129 | print(" x ".rsplit(maxsplit=0)) +130 130 | print(" x ".rsplit(sep=None, maxsplit=0)) + +SIM905.py:128:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +126 | print(" ".rsplit(maxsplit=0)) +127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 | print(" x ".rsplit(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +129 | print(" x ".rsplit(maxsplit=0)) +130 | print(" x ".rsplit(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +125 125 | print("".rsplit(sep=None, maxsplit=0)) +126 126 | print(" ".rsplit(maxsplit=0)) +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 |-print(" x ".rsplit(maxsplit=0)) + 128 |+print([" x"]) +129 129 | print(" x ".rsplit(maxsplit=0)) +130 130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 131 | print(" x ".rsplit(maxsplit=0)) + +SIM905.py:129:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 | print(" x ".rsplit(maxsplit=0)) +129 | print(" x ".rsplit(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 | print(" x ".rsplit(maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +126 126 | print(" ".rsplit(maxsplit=0)) +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 128 | print(" x ".rsplit(maxsplit=0)) +129 |-print(" x ".rsplit(maxsplit=0)) + 129 |+print([" x"]) +130 130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 131 | print(" x ".rsplit(maxsplit=0)) +132 132 | print(" x ".rsplit(sep=None, maxsplit=0)) + +SIM905.py:130:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +128 | print(" x ".rsplit(maxsplit=0)) +129 | print(" x ".rsplit(maxsplit=0)) +130 | print(" x ".rsplit(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +131 | print(" x ".rsplit(maxsplit=0)) +132 | print(" x ".rsplit(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +127 127 | print(" ".rsplit(sep=None, maxsplit=0)) +128 128 | print(" x ".rsplit(maxsplit=0)) +129 129 | print(" x ".rsplit(maxsplit=0)) +130 |-print(" x ".rsplit(sep=None, maxsplit=0)) + 130 |+print([" x"]) +131 131 | print(" x ".rsplit(maxsplit=0)) +132 132 | print(" x ".rsplit(sep=None, maxsplit=0)) + +SIM905.py:131:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +129 | print(" x ".rsplit(maxsplit=0)) +130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 | print(" x ".rsplit(maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 +132 | print(" x ".rsplit(sep=None, maxsplit=0)) + | + = help: Replace with list literal + +ℹ Safe fix +128 128 | print(" x ".rsplit(maxsplit=0)) +129 129 | print(" x ".rsplit(maxsplit=0)) +130 130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 |-print(" x ".rsplit(maxsplit=0)) + 131 |+print([" x"]) +132 132 | print(" x ".rsplit(sep=None, maxsplit=0)) + +SIM905.py:132:7: SIM905 [*] Consider using a list literal instead of `str.split` + | +130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 | print(" x ".rsplit(maxsplit=0)) +132 | print(" x ".rsplit(sep=None, maxsplit=0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SIM905 + | + = help: Replace with list literal + +ℹ Safe fix +129 129 | print(" x ".rsplit(maxsplit=0)) +130 130 | print(" x ".rsplit(sep=None, maxsplit=0)) +131 131 | print(" x ".rsplit(maxsplit=0)) +132 |-print(" x ".rsplit(sep=None, maxsplit=0)) + 132 |+print([" x"]) diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM910_SIM910.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM910_SIM910.py.snap index 1a312e520adc1..262e131eecd44 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM910_SIM910.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__SIM910_SIM910.py.snap @@ -6,7 +6,7 @@ SIM910.py:2:1: SIM910 [*] Use `{}.get(key)` instead of `{}.get(key, None)` 1 | # SIM910 2 | {}.get(key, None) | ^^^^^^^^^^^^^^^^^ SIM910 -3 | +3 | 4 | # SIM910 | = help: Replace `{}.get(key, None)` with `{}.get(key)` @@ -24,7 +24,7 @@ SIM910.py:5:1: SIM910 [*] Use `{}.get("key")` instead of `{}.get("key", None)` 4 | # SIM910 5 | {}.get("key", None) | ^^^^^^^^^^^^^^^^^^^ SIM910 -6 | +6 | 7 | # OK | = help: Replace `{}.get("key", None)` with `{}.get("key")` @@ -63,7 +63,7 @@ SIM910.py:24:5: SIM910 [*] Use `{}.get(key)` instead of `{}.get(key, None)` 23 | # SIM910 24 | a = {}.get(key, None) | ^^^^^^^^^^^^^^^^^ SIM910 -25 | +25 | 26 | # SIM910 | = help: Replace `{}.get(key, None)` with `{}.get(key)` @@ -83,7 +83,7 @@ SIM910.py:27:1: SIM910 [*] Use `({}).get(key)` instead of `({}).get(key, None)` 26 | # SIM910 27 | ({}).get(key, None) | ^^^^^^^^^^^^^^^^^^^ SIM910 -28 | +28 | 29 | # SIM910 | = help: Replace `({}).get(key, None)` with `({}).get(key)` @@ -104,7 +104,7 @@ SIM910.py:31:7: SIM910 [*] Use `ages.get("Cat")` instead of `ages.get("Cat", Non 30 | ages = {"Tom": 23, "Maria": 23, "Dog": 11} 31 | age = ages.get("Cat", None) | ^^^^^^^^^^^^^^^^^^^^^ SIM910 -32 | +32 | 33 | # OK | = help: Replace `ages.get("Cat", None)` with `ages.get("Cat")` @@ -125,7 +125,7 @@ SIM910.py:39:9: SIM910 [*] Use `kwargs.get('a')` instead of `kwargs.get('a', Non 38 | def foo(**kwargs): 39 | a = kwargs.get('a', None) | ^^^^^^^^^^^^^^^^^^^^^ SIM910 -40 | +40 | 41 | # SIM910 | = help: Replace `kwargs.get('a', None)` with `kwargs.get('a')` @@ -146,7 +146,7 @@ SIM910.py:43:9: SIM910 [*] Use `some_dict.get('a')` instead of `some_dict.get('a 42 | def foo(some_dict: dict): 43 | a = some_dict.get('a', None) | ^^^^^^^^^^^^^^^^^^^^^^^^ SIM910 -44 | +44 | 45 | # OK | = help: Replace `some_dict.get('a', None)` with `some_dict.get('a')` diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM108_SIM108.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM108_SIM108.py.snap index 0be8a6b7ca0a5..b4d70317ad555 100644 --- a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM108_SIM108.py.snap +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM108_SIM108.py.snap @@ -9,7 +9,7 @@ SIM108.py:2:1: SIM108 [*] Use ternary operator `b = c if a else d` instead of `i 4 | | else: 5 | | b = d | |_________^ SIM108 -6 | +6 | 7 | # OK | = help: Replace `if`-`else`-block with `b = c if a else d` @@ -29,8 +29,7 @@ SIM108.py:30:5: SIM108 [*] Use ternary operator `b = 1 if a else 2` instead of ` | 28 | pass 29 | else: -30 | if a: - | _____^ +30 | / if a: 31 | | b = 1 32 | | else: 33 | | b = 2 @@ -128,7 +127,7 @@ SIM108.py:141:1: SIM108 [*] Use binary operator `z = cond or other_cond` instead 143 | | else: 144 | | z = other_cond | |__________________^ SIM108 -145 | +145 | 146 | # SIM108 - should suggest | = help: Replace `if`-`else`-block with `z = cond or other_cond` @@ -155,7 +154,7 @@ SIM108.py:148:1: SIM108 [*] Use binary operator `z = cond and other_cond` instea 150 | | else: 151 | | z = other_cond | |__________________^ SIM108 -152 | +152 | 153 | # SIM108 - should suggest | = help: Replace `if`-`else`-block with `z = cond and other_cond` @@ -182,7 +181,7 @@ SIM108.py:155:1: SIM108 [*] Use binary operator `z = not cond and other_cond` in 157 | | else: 158 | | z = other_cond | |__________________^ SIM108 -159 | +159 | 160 | # SIM108 does not suggest | = help: Replace `if`-`else`-block with `z = not cond and other_cond` @@ -209,7 +208,7 @@ SIM108.py:167:1: SIM108 [*] Use ternary operator `z = 1 if True else other` inst 169 | | else: 170 | | z = other | |_____________^ SIM108 -171 | +171 | 172 | if False: | = help: Replace `if`-`else`-block with `z = 1 if True else other` @@ -227,16 +226,43 @@ SIM108.py:167:1: SIM108 [*] Use ternary operator `z = 1 if True else other` inst 172 169 | if False: 173 170 | z = 1 +SIM108.py:172:1: SIM108 [*] Use ternary operator `z = 1 if False else other` instead of `if`-`else`-block + | +170 | z = other +171 | +172 | / if False: +173 | | z = 1 +174 | | else: +175 | | z = other + | |_____________^ SIM108 +176 | +177 | if 1: + | + = help: Replace `if`-`else`-block with `z = 1 if False else other` + +ℹ Unsafe fix +169 169 | else: +170 170 | z = other +171 171 | +172 |-if False: +173 |- z = 1 +174 |-else: +175 |- z = other + 172 |+z = 1 if False else other +176 173 | +177 174 | if 1: +178 175 | z = True + SIM108.py:177:1: SIM108 [*] Use ternary operator `z = True if 1 else other` instead of `if`-`else`-block | 175 | z = other -176 | +176 | 177 | / if 1: 178 | | z = True 179 | | else: 180 | | z = other | |_____________^ SIM108 -181 | +181 | 182 | # SIM108 does not suggest a binary option in this | = help: Replace `if`-`else`-block with `z = True if 1 else other` @@ -263,7 +289,7 @@ SIM108.py:185:1: SIM108 [*] Use ternary operator `z = foo() if foo() else other` 187 | | else: 188 | | z = other | |_____________^ SIM108 -189 | +189 | 190 | # SIM108 does not suggest a binary option in this | = help: Replace `if`-`else`-block with `z = foo() if foo() else other` @@ -302,3 +328,55 @@ SIM108.py:193:1: SIM108 [*] Use ternary operator `z = not foo() if foo() else ot 195 |-else: 196 |- z = other 193 |+z = not foo() if foo() else other +197 194 | +198 195 | +199 196 | # These two cases double as tests for f-string quote preservation. The first + +SIM108.py:202:1: SIM108 [*] Use ternary operator `var = "str" if cond else f"{first}-{second}"` instead of `if`-`else`-block + | +200 | # f-string should preserve its double quotes, and the second should preserve +201 | # single quotes +202 | / if cond: +203 | | var = "str" +204 | | else: +205 | | var = f"{first}-{second}" + | |_____________________________^ SIM108 +206 | +207 | if cond: + | + = help: Replace `if`-`else`-block with `var = "str" if cond else f"{first}-{second}"` + +ℹ Unsafe fix +199 199 | # These two cases double as tests for f-string quote preservation. The first +200 200 | # f-string should preserve its double quotes, and the second should preserve +201 201 | # single quotes +202 |-if cond: +203 |- var = "str" +204 |-else: +205 |- var = f"{first}-{second}" + 202 |+var = "str" if cond else f"{first}-{second}" +206 203 | +207 204 | if cond: +208 205 | var = "str" + +SIM108.py:207:1: SIM108 [*] Use ternary operator `var = "str" if cond else f'{first}-{second}'` instead of `if`-`else`-block + | +205 | var = f"{first}-{second}" +206 | +207 | / if cond: +208 | | var = "str" +209 | | else: +210 | | var = f'{first}-{second}' + | |_____________________________^ SIM108 + | + = help: Replace `if`-`else`-block with `var = "str" if cond else f'{first}-{second}'` + +ℹ Unsafe fix +204 204 | else: +205 205 | var = f"{first}-{second}" +206 206 | +207 |-if cond: +208 |- var = "str" +209 |-else: +210 |- var = f'{first}-{second}' + 207 |+var = "str" if cond else f'{first}-{second}' diff --git a/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM117_SIM117.py.snap b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM117_SIM117.py.snap new file mode 100644 index 0000000000000..4928d2db7e51e --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_simplify/snapshots/ruff_linter__rules__flake8_simplify__tests__preview__SIM117_SIM117.py.snap @@ -0,0 +1,339 @@ +--- +source: crates/ruff_linter/src/rules/flake8_simplify/mod.rs +--- +SIM117.py:2:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +1 | # SIM117 +2 | / with A() as a: +3 | | with B() as b: + | |__________________^ SIM117 +4 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +1 1 | # SIM117 +2 |-with A() as a: +3 |- with B() as b: +4 |- print("hello") + 2 |+with A() as a, B() as b: + 3 |+ print("hello") +5 4 | +6 5 | # SIM117 +7 6 | with A(): + +SIM117.py:7:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | + 6 | # SIM117 + 7 | / with A(): + 8 | | with B(): + | |_____________^ SIM117 + 9 | with C(): +10 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +4 4 | print("hello") +5 5 | +6 6 | # SIM117 +7 |-with A(): +8 |- with B(): +9 |- with C(): +10 |- print("hello") + 7 |+with A(), B(): + 8 |+ with C(): + 9 |+ print("hello") +11 10 | +12 11 | # SIM117 +13 12 | with A() as a: + +SIM117.py:13:1: SIM117 Use a single `with` statement with multiple contexts instead of nested `with` statements + | +12 | # SIM117 +13 | / with A() as a: +14 | | # Unfixable due to placement of this comment. +15 | | with B() as b: + | |__________________^ SIM117 +16 | print("hello") + | + = help: Combine `with` statements + +SIM117.py:19:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +18 | # SIM117 +19 | / with A() as a: +20 | | with B() as b: + | |__________________^ SIM117 +21 | # Fixable due to placement of this comment. +22 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +16 16 | print("hello") +17 17 | +18 18 | # SIM117 +19 |-with A() as a: +20 |- with B() as b: +21 |- # Fixable due to placement of this comment. +22 |- print("hello") + 19 |+with A() as a, B() as b: + 20 |+ # Fixable due to placement of this comment. + 21 |+ print("hello") +23 22 | +24 23 | # OK +25 24 | with A() as a: + +SIM117.py:47:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +46 | # SIM117 +47 | / async with A() as a: +48 | | async with B() as b: + | |________________________^ SIM117 +49 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +44 44 | print("hello") +45 45 | +46 46 | # SIM117 +47 |-async with A() as a: +48 |- async with B() as b: +49 |- print("hello") + 47 |+async with A() as a, B() as b: + 48 |+ print("hello") +50 49 | +51 50 | while True: +52 51 | # SIM117 + +SIM117.py:53:5: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +51 | while True: +52 | # SIM117 +53 | / with A() as a: +54 | | with B() as b: + | |______________________^ SIM117 +55 | """this +56 | is valid""" + | + = help: Combine `with` statements + +ℹ Safe fix +50 50 | +51 51 | while True: +52 52 | # SIM117 +53 |- with A() as a: +54 |- with B() as b: +55 |- """this + 53 |+ with A() as a, B() as b: + 54 |+ """this +56 55 | is valid""" +57 56 | +58 |- """the indentation on + 57 |+ """the indentation on +59 58 | this line is significant""" +60 59 | +61 |- "this is" \ + 60 |+ "this is" \ +62 61 | "allowed too" +63 62 | +64 |- ("so is" + 63 |+ ("so is" +65 64 | "this for some reason") +66 65 | +67 66 | # SIM117 + +SIM117.py:68:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +67 | # SIM117 +68 | / with ( +69 | | A() as a, +70 | | B() as b, +71 | | ): +72 | | with C() as c: + | |__________________^ SIM117 +73 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +67 67 | # SIM117 +68 68 | with ( +69 69 | A() as a, +70 |- B() as b, + 70 |+ B() as b,C() as c +71 71 | ): +72 |- with C() as c: +73 |- print("hello") + 72 |+ print("hello") +74 73 | +75 74 | # SIM117 +76 75 | with A() as a: + +SIM117.py:76:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +75 | # SIM117 +76 | / with A() as a: +77 | | with ( +78 | | B() as b, +79 | | C() as c, +80 | | ): + | |______^ SIM117 +81 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +73 73 | print("hello") +74 74 | +75 75 | # SIM117 +76 |-with A() as a: +77 |- with ( +78 |- B() as b, +79 |- C() as c, +80 |- ): +81 |- print("hello") + 76 |+with ( + 77 |+ A() as a, B() as b, + 78 |+ C() as c, + 79 |+): + 80 |+ print("hello") +82 81 | +83 82 | # SIM117 +84 83 | with ( + +SIM117.py:84:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +83 | # SIM117 +84 | / with ( +85 | | A() as a, +86 | | B() as b, +87 | | ): +88 | | with ( +89 | | C() as c, +90 | | D() as d, +91 | | ): + | |______^ SIM117 +92 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +83 83 | # SIM117 +84 84 | with ( +85 85 | A() as a, +86 |- B() as b, + 86 |+ B() as b,C() as c, + 87 |+ D() as d, +87 88 | ): +88 |- with ( +89 |- C() as c, +90 |- D() as d, +91 |- ): +92 |- print("hello") + 89 |+ print("hello") +93 90 | +94 91 | # SIM117 (auto-fixable) +95 92 | with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as a: + +SIM117.py:95:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +94 | # SIM117 (auto-fixable) +95 | / with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as a: +96 | | with B("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as b: + | |__________________________________________________^ SIM117 +97 | print("hello") + | + = help: Combine `with` statements + +ℹ Safe fix +92 92 | print("hello") +93 93 | +94 94 | # SIM117 (auto-fixable) +95 |-with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as a: +96 |- with B("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as b: +97 |- print("hello") + 95 |+with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as a, B("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as b: + 96 |+ print("hello") +98 97 | +99 98 | # SIM117 (not auto-fixable too long) +100 99 | with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ890") as a: + +SIM117.py:100:1: SIM117 Use a single `with` statement with multiple contexts instead of nested `with` statements + | + 99 | # SIM117 (not auto-fixable too long) +100 | / with A("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ890") as a: +101 | | with B("01ß9💣2ℝ8901ß9💣2ℝ8901ß9💣2ℝ89") as b: + | |__________________________________________________^ SIM117 +102 | print("hello") + | + = help: Combine `with` statements + +SIM117.py:106:5: SIM117 Use a single `with` statement with multiple contexts instead of nested `with` statements + | +104 | # From issue #3025. +105 | async def main(): +106 | / async with A() as a: # SIM117. +107 | | async with B() as b: + | |____________________________^ SIM117 +108 | print("async-inside!") + | + = help: Combine `with` statements + +SIM117.py:126:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +125 | # SIM117 +126 | / with A() as a: +127 | | with B() as b: + | |__________________^ SIM117 +128 | type ListOrSet[T] = list[T] | set[T] + | + = help: Combine `with` statements + +ℹ Safe fix +123 123 | f(b2, c2, d2) +124 124 | +125 125 | # SIM117 +126 |-with A() as a: +127 |- with B() as b: +128 |- type ListOrSet[T] = list[T] | set[T] + 126 |+with A() as a, B() as b: + 127 |+ type ListOrSet[T] = list[T] | set[T] +129 128 | +130 |- class ClassA[T: str]: +131 |- def method1(self) -> T: +132 |- ... + 129 |+ class ClassA[T: str]: + 130 |+ def method1(self) -> T: + 131 |+ ... +133 132 | +134 |- f" something { my_dict["key"] } something else " + 133 |+ f" something { my_dict["key"] } something else " +135 134 | +136 |- f"foo {f"bar {x}"} baz" + 135 |+ f"foo {f"bar {x}"} baz" +137 136 | +138 137 | # Allow cascading for some statements. +139 138 | import anyio + +SIM117.py:163:1: SIM117 [*] Use a single `with` statement with multiple contexts instead of nested `with` statements + | +162 | # Do not suppress combination, if a context manager is already combined with another. +163 | / async with asyncio.timeout(1), A(): +164 | | async with B(): + | |___________________^ SIM117 +165 | pass + | + = help: Combine `with` statements + +ℹ Safe fix +160 160 | pass +161 161 | +162 162 | # Do not suppress combination, if a context manager is already combined with another. +163 |-async with asyncio.timeout(1), A(): +164 |- async with B(): +165 |- pass + 163 |+async with asyncio.timeout(1), A(), B(): + 164 |+ pass diff --git a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_namedtuple_subclass.rs b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_namedtuple_subclass.rs index dd84fd04dcfe5..1433439578286 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_namedtuple_subclass.rs +++ b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_namedtuple_subclass.rs @@ -1,8 +1,8 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, identifier::Identifier, Arguments, Expr, Stmt, StmtClassDef}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Arguments, Expr, Stmt, StmtClassDef, identifier::Identifier}; use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; @@ -46,8 +46,8 @@ use crate::rules::flake8_slots::rules::helpers::has_slots; /// /// ## References /// - [Python documentation: `__slots__`](https://docs.python.org/3/reference/datamodel.html#slots) -#[violation] -pub struct NoSlotsInNamedtupleSubclass(NamedTupleKind); +#[derive(ViolationMetadata)] +pub(crate) struct NoSlotsInNamedtupleSubclass(NamedTupleKind); impl Violation for NoSlotsInNamedtupleSubclass { #[derive_message_formats] @@ -74,17 +74,21 @@ impl fmt::Display for NamedTupleKind { /// SLOT002 pub(crate) fn no_slots_in_namedtuple_subclass( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, class: &StmtClassDef, ) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let Some(Arguments { args: bases, .. }) = class.arguments.as_deref() else { return; }; if let Some(namedtuple_kind) = namedtuple_base(bases, checker.semantic()) { if !has_slots(&class.body) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NoSlotsInNamedtupleSubclass(namedtuple_kind), stmt.identifier(), )); diff --git a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_str_subclass.rs b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_str_subclass.rs index 68a562738d029..c033850648820 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_str_subclass.rs +++ b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_str_subclass.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::{Arguments, Expr, Stmt, StmtClassDef}; -use ruff_python_semantic::{analyze::class::is_enumeration, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze::class::is_enumeration}; use crate::checkers::ast::Checker; use crate::rules::flake8_slots::rules::helpers::has_slots; @@ -38,18 +38,22 @@ use crate::rules::flake8_slots::rules::helpers::has_slots; /// /// ## References /// - [Python documentation: `__slots__`](https://docs.python.org/3/reference/datamodel.html#slots) -#[violation] -pub struct NoSlotsInStrSubclass; +#[derive(ViolationMetadata)] +pub(crate) struct NoSlotsInStrSubclass; impl Violation for NoSlotsInStrSubclass { #[derive_message_formats] fn message(&self) -> String { - format!("Subclasses of `str` should define `__slots__`") + "Subclasses of `str` should define `__slots__`".to_string() } } /// SLOT000 -pub(crate) fn no_slots_in_str_subclass(checker: &mut Checker, stmt: &Stmt, class: &StmtClassDef) { +pub(crate) fn no_slots_in_str_subclass(checker: &Checker, stmt: &Stmt, class: &StmtClassDef) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let Some(Arguments { args: bases, .. }) = class.arguments.as_deref() else { return; }; @@ -69,9 +73,7 @@ pub(crate) fn no_slots_in_str_subclass(checker: &mut Checker, stmt: &Stmt, class return; } - checker - .diagnostics - .push(Diagnostic::new(NoSlotsInStrSubclass, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new(NoSlotsInStrSubclass, stmt.identifier())); } /// Return `true` if the class is a subclass of `str`. diff --git a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_tuple_subclass.rs b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_tuple_subclass.rs index 45eca0949acc0..3c8b561843995 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_tuple_subclass.rs +++ b/crates/ruff_linter/src/rules/flake8_slots/rules/no_slots_in_tuple_subclass.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Arguments, Stmt, StmtClassDef}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::identifier::Identifier; @@ -39,18 +39,22 @@ use crate::rules::flake8_slots::rules::helpers::has_slots; /// /// ## References /// - [Python documentation: `__slots__`](https://docs.python.org/3/reference/datamodel.html#slots) -#[violation] -pub struct NoSlotsInTupleSubclass; +#[derive(ViolationMetadata)] +pub(crate) struct NoSlotsInTupleSubclass; impl Violation for NoSlotsInTupleSubclass { #[derive_message_formats] fn message(&self) -> String { - format!("Subclasses of `tuple` should define `__slots__`") + "Subclasses of `tuple` should define `__slots__`".to_string() } } /// SLOT001 -pub(crate) fn no_slots_in_tuple_subclass(checker: &mut Checker, stmt: &Stmt, class: &StmtClassDef) { +pub(crate) fn no_slots_in_tuple_subclass(checker: &Checker, stmt: &Stmt, class: &StmtClassDef) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let Some(Arguments { args: bases, .. }) = class.arguments.as_deref() else { return; }; @@ -62,9 +66,7 @@ pub(crate) fn no_slots_in_tuple_subclass(checker: &mut Checker, stmt: &Stmt, cla semantic.match_builtin_expr(base, "tuple") || semantic.match_typing_expr(base, "Tuple") }) { if !has_slots(&class.body) { - checker - .diagnostics - .push(Diagnostic::new(NoSlotsInTupleSubclass, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new(NoSlotsInTupleSubclass, stmt.identifier())); } } } diff --git a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT000_SLOT000.py.snap b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT000_SLOT000.py.snap index b98bc9ca9f055..46964ddadf53a 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT000_SLOT000.py.snap +++ b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT000_SLOT000.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_slots/mod.rs +snapshot_kind: text --- SLOT000.py:1:7: SLOT000 Subclasses of `str` should define `__slots__` | @@ -7,5 +8,3 @@ SLOT000.py:1:7: SLOT000 Subclasses of `str` should define `__slots__` | ^^^ SLOT000 2 | pass | - - diff --git a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT001_SLOT001.py.snap b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT001_SLOT001.py.snap index 78d730a75e481..d2566de0579df 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT001_SLOT001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT001_SLOT001.py.snap @@ -25,7 +25,7 @@ SLOT001.py:16:7: SLOT001 Subclasses of `tuple` should define `__slots__` SLOT001.py:26:7: SLOT001 Subclasses of `tuple` should define `__slots__` | 24 | import builtins -25 | +25 | 26 | class AlsoBad(builtins.tuple[int, int]): # SLOT001 | ^^^^^^^ SLOT001 27 | pass diff --git a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT002_SLOT002.py.snap b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT002_SLOT002.py.snap index d59497d98b52b..33bac57c22db7 100644 --- a/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT002_SLOT002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_slots/snapshots/ruff_linter__rules__flake8_slots__tests__SLOT002_SLOT002.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_slots/mod.rs +snapshot_kind: text --- SLOT002.py:6:7: SLOT002 Subclasses of `collections.namedtuple()` should define `__slots__` | diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_api.rs b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_api.rs index 625e7316a48c9..05cc14b992dfa 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_api.rs +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_api.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_text_size::Ranged; @@ -24,8 +24,8 @@ use crate::rules::flake8_tidy_imports::matchers::NameMatchPolicy; /// /// ## Options /// - `lint.flake8-tidy-imports.banned-api` -#[violation] -pub struct BannedApi { +#[derive(ViolationMetadata)] +pub(crate) struct BannedApi { name: String, message: String, } @@ -39,11 +39,11 @@ impl Violation for BannedApi { } /// TID251 -pub(crate) fn banned_api<T: Ranged>(checker: &mut Checker, policy: &NameMatchPolicy, node: &T) { +pub(crate) fn banned_api<T: Ranged>(checker: &Checker, policy: &NameMatchPolicy, node: &T) { let banned_api = &checker.settings.flake8_tidy_imports.banned_api; if let Some(banned_module) = policy.find(banned_api.keys().map(AsRef::as_ref)) { if let Some(reason) = banned_api.get(&banned_module) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BannedApi { name: banned_module, message: reason.msg.to_string(), @@ -55,7 +55,7 @@ pub(crate) fn banned_api<T: Ranged>(checker: &mut Checker, policy: &NameMatchPol } /// TID251 -pub(crate) fn banned_attribute_access(checker: &mut Checker, expr: &Expr) { +pub(crate) fn banned_attribute_access(checker: &Checker, expr: &Expr) { let banned_api = &checker.settings.flake8_tidy_imports.banned_api; if banned_api.is_empty() { return; @@ -71,7 +71,7 @@ pub(crate) fn banned_attribute_access(checker: &mut Checker, expr: &Expr) { }) }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BannedApi { name: banned_path.to_string(), message: ban.msg.to_string(), diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_module_level_imports.rs b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_module_level_imports.rs index 53b2601bea26e..cc6d47776d0c5 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_module_level_imports.rs +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/banned_module_level_imports.rs @@ -1,9 +1,12 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::resolve_imported_module_path; +use ruff_python_ast::{Alias, AnyNodeRef, Stmt, StmtImport, StmtImportFrom}; use ruff_text_size::Ranged; +use std::borrow::Cow; use crate::checkers::ast::Checker; -use crate::rules::flake8_tidy_imports::matchers::NameMatchPolicy; +use crate::rules::flake8_tidy_imports::matchers::{MatchName, MatchNameOrParent, NameMatchPolicy}; /// ## What it does /// Checks for module-level imports that should instead be imported lazily @@ -39,8 +42,8 @@ use crate::rules::flake8_tidy_imports::matchers::NameMatchPolicy; /// /// ## Options /// - `lint.flake8-tidy-imports.banned-module-level-imports` -#[violation] -pub struct BannedModuleLevelImports { +#[derive(ViolationMetadata)] +pub(crate) struct BannedModuleLevelImports { name: String, } @@ -53,28 +56,131 @@ impl Violation for BannedModuleLevelImports { } /// TID253 -pub(crate) fn banned_module_level_imports<T: Ranged>( - checker: &mut Checker, - policy: &NameMatchPolicy, - node: &T, -) { +pub(crate) fn banned_module_level_imports(checker: &Checker, stmt: &Stmt) { if !checker.semantic().at_top_level() { return; } - if let Some(banned_module) = policy.find( - checker - .settings - .flake8_tidy_imports - .banned_module_level_imports - .iter() - .map(AsRef::as_ref), - ) { - checker.diagnostics.push(Diagnostic::new( - BannedModuleLevelImports { - name: banned_module, - }, - node.range(), - )); + for (policy, node) in &BannedModuleImportPolicies::new(stmt, checker) { + if let Some(banned_module) = policy.find( + checker + .settings + .flake8_tidy_imports + .banned_module_level_imports(), + ) { + checker.report_diagnostic(Diagnostic::new( + BannedModuleLevelImports { + name: banned_module, + }, + node.range(), + )); + } + } +} + +pub(crate) enum BannedModuleImportPolicies<'a> { + Import(&'a StmtImport), + ImportFrom { + module: Option<Cow<'a, str>>, + node: &'a StmtImportFrom, + }, + NonImport, +} + +impl<'a> BannedModuleImportPolicies<'a> { + pub(crate) fn new(stmt: &'a Stmt, checker: &Checker) -> Self { + match stmt { + Stmt::Import(import) => Self::Import(import), + Stmt::ImportFrom(import @ StmtImportFrom { module, level, .. }) => { + let module = resolve_imported_module_path( + *level, + module.as_deref(), + checker.module.qualified_name(), + ); + + Self::ImportFrom { + module, + node: import, + } + } + _ => Self::NonImport, + } + } +} + +impl<'a> IntoIterator for &'a BannedModuleImportPolicies<'a> { + type Item = <Self::IntoIter as Iterator>::Item; + type IntoIter = BannedModuleImportPoliciesIter<'a>; + + fn into_iter(self) -> Self::IntoIter { + match self { + BannedModuleImportPolicies::Import(import) => { + BannedModuleImportPoliciesIter::Import(import.names.iter()) + } + BannedModuleImportPolicies::ImportFrom { module, node } => { + BannedModuleImportPoliciesIter::ImportFrom { + module: module.as_deref(), + names: node.names.iter(), + import: Some(node), + } + } + BannedModuleImportPolicies::NonImport => BannedModuleImportPoliciesIter::NonImport, + } + } +} + +pub(crate) enum BannedModuleImportPoliciesIter<'a> { + Import(std::slice::Iter<'a, Alias>), + ImportFrom { + module: Option<&'a str>, + names: std::slice::Iter<'a, Alias>, + import: Option<&'a StmtImportFrom>, + }, + NonImport, +} + +impl<'a> Iterator for BannedModuleImportPoliciesIter<'a> { + type Item = (NameMatchPolicy<'a>, AnyNodeRef<'a>); + + fn next(&mut self) -> Option<Self::Item> { + match self { + Self::Import(names) => { + let name = names.next()?; + Some(( + NameMatchPolicy::MatchNameOrParent(MatchNameOrParent { module: &name.name }), + name.into(), + )) + } + Self::ImportFrom { + module, + import, + names, + } => { + let module = module.as_ref()?; + + if let Some(import) = import.take() { + return Some(( + NameMatchPolicy::MatchNameOrParent(MatchNameOrParent { module }), + import.into(), + )); + } + + loop { + let alias = names.next()?; + if &alias.name == "*" { + continue; + } + + break Some(( + NameMatchPolicy::MatchName(MatchName { + module, + member: &alias.name, + }), + alias.into(), + )); + } + } + Self::NonImport => None, + } } } diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/relative_imports.rs b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/relative_imports.rs index 5aa6fbdcf9a31..de8dfa69fc3c9 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/relative_imports.rs +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/rules/relative_imports.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Identifier, Stmt}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::resolve_imported_module_path; use ruff_python_codegen::Generator; use ruff_python_stdlib::identifiers::is_identifier; @@ -45,8 +45,8 @@ use crate::rules::flake8_tidy_imports::settings::Strictness; /// - `lint.flake8-tidy-imports.ban-relative-imports` /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct RelativeImports { +#[derive(ViolationMetadata)] +pub(crate) struct RelativeImports { strictness: Strictness, } @@ -57,9 +57,9 @@ impl Violation for RelativeImports { fn message(&self) -> String { match self.strictness { Strictness::Parents => { - format!("Prefer absolute imports over relative imports from parent modules") + "Prefer absolute imports over relative imports from parent modules".to_string() } - Strictness::All => format!("Prefer absolute imports over relative imports"), + Strictness::All => "Prefer absolute imports over relative imports".to_string(), } } @@ -128,7 +128,7 @@ pub(crate) fn banned_relative_import( fix_banned_relative_import(stmt, level, module, module_path, checker.generator()) { diagnostic.set_fix(fix); - }; + } Some(diagnostic) } else { None diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/settings.rs b/crates/ruff_linter/src/rules/flake8_tidy_imports/settings.rs index fee7a12482cff..ad48449a1844c 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/settings.rs +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/settings.rs @@ -46,6 +46,12 @@ pub struct Settings { pub banned_module_level_imports: Vec<String>, } +impl Settings { + pub fn banned_module_level_imports(&self) -> impl Iterator<Item = &str> { + self.banned_module_level_imports.iter().map(AsRef::as_ref) + } +} + impl Display for Settings { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { display_settings! { diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_all_imports.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_all_imports.snap index ad07477233c5c..50282b2469002 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_all_imports.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_all_imports.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_tidy_imports/mod.rs +snapshot_kind: text --- TID252.py:7:1: TID252 Prefer absolute imports over relative imports | @@ -188,5 +189,3 @@ TID252.py:28:1: TID252 Prefer absolute imports over relative imports | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID252 | = help: Replace relative imports with absolute imports - - diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports.snap index b8b57e3da7b38..9a0db54c45ac0 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_tidy_imports/mod.rs +snapshot_kind: text --- TID252.py:9:1: TID252 Prefer absolute imports over relative imports from parent modules | @@ -143,5 +144,3 @@ TID252.py:28:1: TID252 Prefer absolute imports over relative imports from parent | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID252 | = help: Replace relative imports from parent modules with absolute imports - - diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports_package.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports_package.snap index 14a601b81f355..652c0975bc09a 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports_package.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__ban_parent_imports_package.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_tidy_imports/mod.rs application.py:5:1: TID252 Prefer absolute imports over relative imports from parent modules | 3 | import attrs -4 | +4 | 5 | from ....import unknown | ^^^^^^^^^^^^^^^^^^^^^^^ TID252 6 | from ..protocol import commands, definitions, responses @@ -128,5 +128,3 @@ application.py:10:1: TID252 [*] Prefer absolute imports over relative imports fr 9 9 | from . import logger, models 10 |-from ..protocol.UpperCaseModule import some_function 10 |+from my_package.sublib.protocol.UpperCaseModule import some_function - - diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api.snap index 9e54f524002ff..e74e8b7f3eb56 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api.snap @@ -6,27 +6,27 @@ TID251.py:2:8: TID251 `cgi` is banned: The cgi module is deprecated. 1 | ## Banned modules ## 2 | import cgi | ^^^ TID251 -3 | +3 | 4 | from cgi import * | TID251.py:4:1: TID251 `cgi` is banned: The cgi module is deprecated. | 2 | import cgi -3 | +3 | 4 | from cgi import * | ^^^^^^^^^^^^^^^^^ TID251 -5 | +5 | 6 | from cgi import a, b, c | TID251.py:6:1: TID251 `cgi` is banned: The cgi module is deprecated. | 4 | from cgi import * -5 | +5 | 6 | from cgi import a, b, c | ^^^^^^^^^^^^^^^^^^^^^^^ TID251 -7 | +7 | 8 | # banning a module also bans any submodules | @@ -35,37 +35,37 @@ TID251.py:9:8: TID251 `cgi` is banned: The cgi module is deprecated. 8 | # banning a module also bans any submodules 9 | import cgi.foo.bar | ^^^^^^^^^^^ TID251 -10 | +10 | 11 | from cgi.foo import bar | TID251.py:11:1: TID251 `cgi` is banned: The cgi module is deprecated. | 9 | import cgi.foo.bar -10 | +10 | 11 | from cgi.foo import bar | ^^^^^^^^^^^^^^^^^^^^^^^ TID251 -12 | +12 | 13 | from cgi.foo.bar import * | TID251.py:13:1: TID251 `cgi` is banned: The cgi module is deprecated. | 11 | from cgi.foo import bar -12 | +12 | 13 | from cgi.foo.bar import * | ^^^^^^^^^^^^^^^^^^^^^^^^^ TID251 -14 | +14 | 15 | ## Banned module members ## | TID251.py:17:20: TID251 `typing.TypedDict` is banned: Use typing_extensions.TypedDict instead. | 15 | ## Banned module members ## -16 | +16 | 17 | from typing import TypedDict | ^^^^^^^^^ TID251 -18 | +18 | 19 | import typing | @@ -74,17 +74,17 @@ TID251.py:22:1: TID251 `typing.TypedDict` is banned: Use typing_extensions.Typed 21 | # attribute access is checked 22 | typing.TypedDict | ^^^^^^^^^^^^^^^^ TID251 -23 | +23 | 24 | typing.TypedDict.anything | TID251.py:24:1: TID251 `typing.TypedDict` is banned: Use typing_extensions.TypedDict instead. | 22 | typing.TypedDict -23 | +23 | 24 | typing.TypedDict.anything | ^^^^^^^^^^^^^^^^ TID251 -25 | +25 | 26 | # function calls are checked | @@ -93,17 +93,17 @@ TID251.py:27:1: TID251 `typing.TypedDict` is banned: Use typing_extensions.Typed 26 | # function calls are checked 27 | typing.TypedDict() | ^^^^^^^^^^^^^^^^ TID251 -28 | +28 | 29 | typing.TypedDict.anything() | TID251.py:29:1: TID251 `typing.TypedDict` is banned: Use typing_extensions.TypedDict instead. | 27 | typing.TypedDict() -28 | +28 | 29 | typing.TypedDict.anything() | ^^^^^^^^^^^^^^^^ TID251 -30 | +30 | 31 | # import aliases are resolved | @@ -113,8 +113,6 @@ TID251.py:33:1: TID251 `typing.TypedDict` is banned: Use typing_extensions.Typed 32 | import typing as totally_not_typing 33 | totally_not_typing.TypedDict | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID251 -34 | +34 | 35 | # relative imports are respected | - - diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api_package.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api_package.snap index 14eb7a63459ff..47f5e3859705c 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api_package.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_api_package.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/flake8_tidy_imports/mod.rs application.py:3:8: TID251 `attrs` is banned: The attrs module is deprecated. | 1 | from typing import TYPE_CHECKING, Any, ClassVar -2 | +2 | 3 | import attrs | ^^^^^ TID251 -4 | +4 | 5 | from ....import unknown | @@ -27,5 +27,3 @@ application.py:10:1: TID251 `my_package.sublib.protocol` is banned: The protocol 10 | from ..protocol.UpperCaseModule import some_function | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID251 | - - diff --git a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_module_level_imports.snap b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_module_level_imports.snap index dbabca1e24af7..eb8c2d42a54d9 100644 --- a/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_module_level_imports.snap +++ b/crates/ruff_linter/src/rules/flake8_tidy_imports/snapshots/ruff_linter__rules__flake8_tidy_imports__tests__banned_module_level_imports.snap @@ -6,37 +6,37 @@ TID253.py:2:8: TID253 `torch` is banned at the module level 1 | ## Banned modules ## 2 | import torch | ^^^^^ TID253 -3 | +3 | 4 | from torch import * | TID253.py:4:1: TID253 `torch` is banned at the module level | 2 | import torch -3 | +3 | 4 | from torch import * | ^^^^^^^^^^^^^^^^^^^ TID253 -5 | +5 | 6 | from tensorflow import a, b, c | TID253.py:6:1: TID253 `tensorflow` is banned at the module level | 4 | from torch import * -5 | +5 | 6 | from tensorflow import a, b, c | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID253 -7 | +7 | 8 | import torch as torch_wearing_a_trenchcoat | TID253.py:8:8: TID253 `torch` is banned at the module level | 6 | from tensorflow import a, b, c - 7 | + 7 | 8 | import torch as torch_wearing_a_trenchcoat | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID253 - 9 | + 9 | 10 | # this should count as module level | @@ -45,7 +45,7 @@ TID253.py:11:15: TID253 `tensorflow` is banned at the module level 10 | # this should count as module level 11 | x = 1; import tensorflow | ^^^^^^^^^^ TID253 -12 | +12 | 13 | # banning a module also bans any submodules | @@ -54,28 +54,26 @@ TID253.py:14:8: TID253 `torch` is banned at the module level 13 | # banning a module also bans any submodules 14 | import torch.foo.bar | ^^^^^^^^^^^^^ TID253 -15 | +15 | 16 | from tensorflow.foo import bar | TID253.py:16:1: TID253 `tensorflow` is banned at the module level | 14 | import torch.foo.bar -15 | +15 | 16 | from tensorflow.foo import bar | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID253 -17 | +17 | 18 | from torch.foo.bar import * | TID253.py:18:1: TID253 `torch` is banned at the module level | 16 | from tensorflow.foo import bar -17 | +17 | 18 | from torch.foo.bar import * | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ TID253 -19 | +19 | 20 | # unlike TID251, inline imports are *not* banned | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/rules/todos.rs b/crates/ruff_linter/src/rules/flake8_todos/rules/todos.rs index 8a5492f1d3bc6..51459459d5f05 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/rules/todos.rs +++ b/crates/ruff_linter/src/rules/flake8_todos/rules/todos.rs @@ -3,12 +3,12 @@ use std::sync::LazyLock; use regex::RegexSet; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_text_size::{TextLen, TextRange, TextSize}; -use crate::directives::{TodoComment, TodoDirective, TodoDirectiveKind}; use crate::Locator; +use crate::directives::{TodoComment, TodoDirective, TodoDirectiveKind}; /// ## What it does /// Checks that a TODO comment is labelled with "TODO". @@ -29,8 +29,8 @@ use crate::Locator; /// ```python /// # TODO(ruff): this is now fixed! /// ``` -#[violation] -pub struct InvalidTodoTag { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidTodoTag { pub tag: String, } @@ -59,13 +59,14 @@ impl Violation for InvalidTodoTag { /// ```python /// # TODO(charlie): now an author is assigned /// ``` -#[violation] -pub struct MissingTodoAuthor; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTodoAuthor; impl Violation for MissingTodoAuthor { #[derive_message_formats] fn message(&self) -> String { - format!("Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...`") + "Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...`" + .to_string() } } @@ -90,16 +91,22 @@ impl Violation for MissingTodoAuthor { /// # TODO(charlie): this comment has a 3-digit issue code /// # 003 /// -/// # TODO(charlie): this comment has an issue code of (up to) 6 characters, then digits +/// # TODO(charlie): https://github.com/astral-sh/ruff/issues/3870 +/// # this comment has an issue link +/// +/// # TODO(charlie): #003 this comment has a 3-digit issue code +/// # with leading character `#` +/// +/// # TODO(charlie): this comment has an issue code (matches the regex `[A-Z]+\-?\d+`) /// # SIXCHR-003 /// ``` -#[violation] -pub struct MissingTodoLink; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTodoLink; impl Violation for MissingTodoLink { #[derive_message_formats] fn message(&self) -> String { - format!("Missing issue link on the line following this TODO") + "Missing issue link for this TODO".to_string() } } @@ -122,13 +129,13 @@ impl Violation for MissingTodoLink { /// ```python /// # TODO(charlie): colon fixed /// ``` -#[violation] -pub struct MissingTodoColon; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTodoColon; impl Violation for MissingTodoColon { #[derive_message_formats] fn message(&self) -> String { - format!("Missing colon in TODO") + "Missing colon in TODO".to_string() } } @@ -149,13 +156,13 @@ impl Violation for MissingTodoColon { /// ```python /// # TODO(charlie): fix some issue /// ``` -#[violation] -pub struct MissingTodoDescription; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTodoDescription; impl Violation for MissingTodoDescription { #[derive_message_formats] fn message(&self) -> String { - format!("Missing issue description after `TODO`") + "Missing issue description after `TODO`".to_string() } } @@ -176,8 +183,8 @@ impl Violation for MissingTodoDescription { /// ```python /// # TODO(charlie): this is capitalized /// ``` -#[violation] -pub struct InvalidTodoCapitalization { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidTodoCapitalization { tag: String, } @@ -213,21 +220,29 @@ impl AlwaysFixableViolation for InvalidTodoCapitalization { /// ```python /// # TODO(charlie): fix this /// ``` -#[violation] -pub struct MissingSpaceAfterTodoColon; +#[derive(ViolationMetadata)] +pub(crate) struct MissingSpaceAfterTodoColon; impl Violation for MissingSpaceAfterTodoColon { #[derive_message_formats] fn message(&self) -> String { - format!("Missing space after colon in TODO") + "Missing space after colon in TODO".to_string() } } -static ISSUE_LINK_REGEX_SET: LazyLock<RegexSet> = LazyLock::new(|| { +static ISSUE_LINK_OWN_LINE_REGEX_SET: LazyLock<RegexSet> = LazyLock::new(|| { RegexSet::new([ r"^#\s*(http|https)://.*", // issue link r"^#\s*\d+$", // issue code - like "003" - r"^#\s*[A-Z]{1,6}\-?\d+$", // issue code - like "TD003" + r"^#\s*[A-Z]+\-?\d+$", // issue code - like "TD003" + ]) + .unwrap() +}); + +static ISSUE_LINK_TODO_LINE_REGEX_SET: LazyLock<RegexSet> = LazyLock::new(|| { + RegexSet::new([ + r"\s*(http|https)://.*", // issue link + r"\s*#\d+.*", // issue code - like "#003" ]) .unwrap() }); @@ -256,6 +271,13 @@ pub(crate) fn todos( static_errors(diagnostics, content, range, directive); let mut has_issue_link = false; + // VSCode recommended links on same line are ok: + // `# TODO(dylan): #1234` + if ISSUE_LINK_TODO_LINE_REGEX_SET + .is_match(locator.slice(TextRange::new(directive.range.end(), range.end()))) + { + continue; + } let mut curr_range = range; for next_range in comment_ranges.iter().skip(range_index + 1).copied() { // Ensure that next_comment_range is in the same multiline comment "block" as @@ -273,11 +295,11 @@ pub(crate) fn todos( break; } - if ISSUE_LINK_REGEX_SET.is_match(next_comment) { + if ISSUE_LINK_OWN_LINE_REGEX_SET.is_match(next_comment) { has_issue_link = true; } - // If the next_comment isn't a tag or an issue, it's worthles in the context of this + // If the next_comment isn't a tag or an issue, it's worthless in the context of this // linter. We can increment here instead of waiting for the next iteration of the outer // loop. curr_range = next_range; diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-capitalization_TD006.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-capitalization_TD006.py.snap index 7e5c3c1482cf9..6b84c98c68116 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-capitalization_TD006.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-capitalization_TD006.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD006.py:5:3: TD006 [*] Invalid TODO capitalization: `ToDo` should be `TODO` | diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-tag_TD001.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-tag_TD001.py.snap index 1fec01f216f7f..1bc8754c51eb6 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-tag_TD001.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__invalid-todo-tag_TD001.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD001.py:7:3: TD001 Invalid TODO tag: `XXX` | @@ -26,5 +27,3 @@ TD001.py:9:9: TD001 Invalid TODO tag: `XXX` 9 | # foo # XXX: this isn't fine either | ^^^ TD001 | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-space-after-todo-colon_TD007.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-space-after-todo-colon_TD007.py.snap index f786677ceabe9..babe25d322cd5 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-space-after-todo-colon_TD007.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-space-after-todo-colon_TD007.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD007.py:5:3: TD007 Missing space after colon in TODO | @@ -49,5 +50,3 @@ TD007.py:9:9: TD007 Missing space after colon in TODO | ^^^^ TD007 10 | # TODO this colon doesn't terminate the tag, so don't check it. https://www.google.com | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-author_TD002.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-author_TD002.py.snap index 6c6e46881be65..5c941c0c12ea6 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-author_TD002.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-author_TD002.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD002.py:11:3: TD002 Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...` | @@ -37,5 +38,3 @@ TD002.py:14:9: TD002 Missing author in TODO; try: `# TODO(<author_name>): ...` o 14 | # foo # TODO: this doesn't either | ^^^^ TD002 | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-colon_TD004.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-colon_TD004.py.snap index 20174161336d2..6b10dd8618d0b 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-colon_TD004.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-colon_TD004.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD004.py:4:3: TD004 Missing colon in TODO | @@ -47,5 +48,3 @@ TD004.py:8:3: TD004 Missing colon in TODO 8 | # TODO this has a colon but it doesn't terminate the tag, so this should throw. https://www.google.com | ^^^^ TD004 | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-description_TD005.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-description_TD005.py.snap index c965f640e57c8..861fd96e8c69b 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-description_TD005.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-description_TD005.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs +snapshot_kind: text --- TD005.py:4:3: TD005 Missing issue description after `TODO` | @@ -37,5 +38,3 @@ TD005.py:7:9: TD005 Missing issue description after `TODO` 7 | # foo # TODO | ^^^^ TD005 | - - diff --git a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-link_TD003.py.snap b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-link_TD003.py.snap index cded21ee1236d..2b7e00d4c89d9 100644 --- a/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-link_TD003.py.snap +++ b/crates/ruff_linter/src/rules/flake8_todos/snapshots/ruff_linter__rules__flake8_todos__tests__missing-todo-link_TD003.py.snap @@ -1,50 +1,58 @@ --- source: crates/ruff_linter/src/rules/flake8_todos/mod.rs --- -TD003.py:9:3: TD003 Missing issue link on the line following this TODO +TD003.py:15:3: TD003 Missing issue link for this TODO | - 8 | # TDO003 - errors - 9 | # TODO: this comment has no +14 | # TDO003 - errors +15 | # TODO: this comment has no | ^^^^ TD003 -10 | # link after it +16 | # link after it | -TD003.py:12:3: TD003 Missing issue link on the line following this TODO +TD003.py:18:3: TD003 Missing issue link for this TODO | -10 | # link after it -11 | -12 | # TODO: here's a TODO with no link after it +16 | # link after it +17 | +18 | # TODO: here's a TODO with no link after it | ^^^^ TD003 -13 | def foo(x): -14 | return x +19 | def foo(x): +20 | return x | -TD003.py:25:3: TD003 Missing issue link on the line following this TODO +TD003.py:31:3: TD003 Missing issue link for this TODO | -23 | # TDO-3870 -24 | -25 | # TODO: here's a TODO without an issue link +29 | # TDO-3870 +30 | +31 | # TODO: here's a TODO without an issue link | ^^^^ TD003 -26 | # TODO: followed by a new TODO with an issue link -27 | # TDO-3870 +32 | # TODO: followed by a new TODO with an issue link +33 | # TDO-3870 | -TD003.py:29:9: TD003 Missing issue link on the line following this TODO +TD003.py:35:9: TD003 Missing issue link for this TODO | -27 | # TDO-3870 -28 | -29 | # foo # TODO: no link! +33 | # TDO-3870 +34 | +35 | # foo # TODO: no link! | ^^^^ TD003 -30 | -31 | # TODO: here's a TODO on the last line with no link +36 | +37 | # TODO: https://github.com/astral-sh/ruff/pull/9627 A todo with a link on the same line | -TD003.py:31:3: TD003 Missing issue link on the line following this TODO +TD003.py:41:3: TD003 Missing issue link for this TODO | -29 | # foo # TODO: no link! -30 | -31 | # TODO: here's a TODO on the last line with no link +39 | # TODO: #9627 A todo with a number on the same line +40 | +41 | # TODO: A todo with a random number, 5431 | ^^^^ TD003 +42 | +43 | # TODO: here's a TODO on the last line with no link | - +TD003.py:43:3: TD003 Missing issue link for this TODO + | +41 | # TODO: A todo with a random number, 5431 +42 | +43 | # TODO: here's a TODO on the last line with no link + | ^^^^ TD003 + | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/helpers.rs b/crates/ruff_linter/src/rules/flake8_type_checking/helpers.rs index cd86affbeff30..6c432cb8e2468 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/helpers.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/helpers.rs @@ -1,28 +1,31 @@ -use anyhow::Result; -use ast::visitor::source_order; -use ruff_python_ast::visitor::source_order::SourceOrderVisitor; use std::cmp::Reverse; use ruff_diagnostics::Edit; use ruff_python_ast::helpers::{map_callable, map_subscript}; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::{self as ast, Decorator, Expr}; +use ruff_python_ast::str::Quote; +use ruff_python_ast::visitor::transformer::{Transformer, walk_expr}; +use ruff_python_ast::{self as ast, Decorator, Expr, StringLiteralFlags}; use ruff_python_codegen::{Generator, Stylist}; +use ruff_python_parser::typing::parse_type_annotation; use ruff_python_semantic::{ - analyze, Binding, BindingKind, Modules, NodeId, ResolvedReference, ScopeKind, SemanticModel, + Binding, BindingKind, Modules, NodeId, ResolvedReference, ScopeKind, SemanticModel, analyze, }; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::rules::flake8_type_checking::settings::Settings; /// Returns `true` if the [`ResolvedReference`] is in a typing-only context _or_ a runtime-evaluated /// context (with quoting enabled). pub(crate) fn is_typing_reference(reference: &ResolvedReference, settings: &Settings) -> bool { reference.in_type_checking_block() - || reference.in_typing_only_annotation() - || reference.in_complex_string_type_definition() - || reference.in_simple_string_type_definition() - || (settings.quote_annotations && reference.in_runtime_evaluated_annotation()) + // if we're not in a type checking block, we necessarily need to be within a + // type definition to be considered a typing reference + || (reference.in_type_definition() + && (reference.in_typing_only_annotation() + || reference.in_string_type_definition() + || (settings.quote_annotations && reference.in_runtime_evaluated_annotation()))) } /// Returns `true` if the [`Binding`] represents a runtime-required import. @@ -96,12 +99,31 @@ fn runtime_required_decorators( } decorator_list.iter().any(|decorator| { + let expression = map_callable(&decorator.expression); semantic - .resolve_qualified_name(map_callable(&decorator.expression)) + // First try to resolve the qualified name normally for cases like: + // ```python + // from mymodule import app + // + // @app.get(...) + // def test(): ... + // ``` + .resolve_qualified_name(expression) + // If we can't resolve the name, then try resolving the assignment + // in order to support cases like: + // ```python + // from fastapi import FastAPI + // + // app = FastAPI() + // + // @app.get(...) + // def test(): ... + // ``` + .or_else(|| analyze::typing::resolve_assignment(expression, semantic)) .is_some_and(|qualified_name| { decorators .iter() - .any(|base_class| QualifiedName::from_dotted_name(base_class) == qualified_name) + .any(|decorator| QualifiedName::from_dotted_name(decorator) == qualified_name) }) }) } @@ -194,7 +216,7 @@ pub(crate) fn is_singledispatch_implementation( if attribute.attr.as_str() != "register" { return false; - }; + } let Some(id) = semantic.lookup_attribute(attribute.value.as_ref()) else { return false; @@ -219,15 +241,17 @@ pub(crate) fn is_singledispatch_implementation( /// This requires more than just wrapping the reference itself in quotes. For example: /// - When quoting `Series` in `Series[pd.Timestamp]`, we want `"Series[pd.Timestamp]"`. /// - When quoting `kubernetes` in `kubernetes.SecurityContext`, we want `"kubernetes.SecurityContext"`. -/// - When quoting `Series` in `Series["pd.Timestamp"]`, we want `"Series[pd.Timestamp]"`. (This is currently unsupported.) -/// - When quoting `Series` in `Series[Literal["pd.Timestamp"]]`, we want `"Series[Literal['pd.Timestamp']]"`. (This is currently unsupported.) +/// - When quoting `Series` in `Series["pd.Timestamp"]`, we want `"Series[pd.Timestamp]"`. +/// - When quoting `Series` in `Series[Literal["pd.Timestamp"]]`, we want `"Series[Literal['pd.Timestamp']]"`. /// /// In general, when expanding a component of a call chain, we want to quote the entire call chain. pub(crate) fn quote_annotation( node_id: NodeId, semantic: &SemanticModel, stylist: &Stylist, -) -> Result<Edit> { + locator: &Locator, + flags: StringLiteralFlags, +) -> Edit { let expr = semantic.expression(node_id).expect("Expression not found"); if let Some(parent_id) = semantic.parent_expression_id(node_id) { match semantic.expression(parent_id) { @@ -236,7 +260,7 @@ pub(crate) fn quote_annotation( // If we're quoting the value of a subscript, we need to quote the entire // expression. For example, when quoting `DataFrame` in `DataFrame[int]`, we // should generate `"DataFrame[int]"`. - return quote_annotation(parent_id, semantic, stylist); + return quote_annotation(parent_id, semantic, stylist, locator, flags); } } Some(Expr::Attribute(parent)) => { @@ -244,7 +268,7 @@ pub(crate) fn quote_annotation( // If we're quoting the value of an attribute, we need to quote the entire // expression. For example, when quoting `DataFrame` in `pd.DataFrame`, we // should generate `"pd.DataFrame"`. - return quote_annotation(parent_id, semantic, stylist); + return quote_annotation(parent_id, semantic, stylist, locator, flags); } } Some(Expr::Call(parent)) => { @@ -252,7 +276,7 @@ pub(crate) fn quote_annotation( // If we're quoting the function of a call, we need to quote the entire // expression. For example, when quoting `DataFrame` in `DataFrame()`, we // should generate `"DataFrame()"`. - return quote_annotation(parent_id, semantic, stylist); + return quote_annotation(parent_id, semantic, stylist, locator, flags); } } Some(Expr::BinOp(parent)) => { @@ -260,22 +284,35 @@ pub(crate) fn quote_annotation( // If we're quoting the left or right side of a binary operation, we need to // quote the entire expression. For example, when quoting `DataFrame` in // `DataFrame | Series`, we should generate `"DataFrame | Series"`. - return quote_annotation(parent_id, semantic, stylist); + return quote_annotation(parent_id, semantic, stylist, locator, flags); } } _ => {} } } - let quote = stylist.quote(); - let mut quote_annotator = QuoteAnnotator::new(semantic, stylist); - quote_annotator.visit_expr(expr); - let annotation = quote_annotator.into_annotation(); + quote_type_expression(expr, semantic, stylist, locator, flags) +} + +/// Wrap a type expression in quotes. +/// +/// This function assumes that the callee already expanded expression components +/// to the minimum acceptable range for quoting, i.e. the parent node may not be +/// a [`Expr::Subscript`], [`Expr::Attribute`], `[Expr::Call]` or `[Expr::BinOp]`. +/// +/// In most cases you want to call [`quote_annotation`] instead, which provides +/// that guarantee by expanding the expression before calling into this function. +pub(crate) fn quote_type_expression( + expr: &Expr, + semantic: &SemanticModel, + stylist: &Stylist, + locator: &Locator, + flags: StringLiteralFlags, +) -> Edit { + // Quote the entire expression. + let quote_annotator = QuoteAnnotator::new(semantic, stylist, locator, flags); - Ok(Edit::range_replacement( - format!("{quote}{annotation}{quote}"), - expr.range(), - )) + Edit::range_replacement(quote_annotator.into_annotation(expr), expr.range()) } /// Filter out any [`Edit`]s that are completely contained by any other [`Edit`]. @@ -298,110 +335,119 @@ pub(crate) fn filter_contained(edits: Vec<Edit>) -> Vec<Edit> { filtered } -#[derive(Copy, PartialEq, Clone)] -enum QuoteAnnotatorState { - Literal, - AnnotatedFirst, - AnnotatedRest, - Other, -} - pub(crate) struct QuoteAnnotator<'a> { - stylist: &'a Stylist<'a>, semantic: &'a SemanticModel<'a>, - state: Vec<QuoteAnnotatorState>, - annotation: String, + stylist: &'a Stylist<'a>, + locator: &'a Locator<'a>, + flags: StringLiteralFlags, } impl<'a> QuoteAnnotator<'a> { - fn new(semantic: &'a SemanticModel<'a>, stylist: &'a Stylist<'a>) -> Self { + fn new( + semantic: &'a SemanticModel<'a>, + stylist: &'a Stylist<'a>, + locator: &'a Locator<'a>, + flags: StringLiteralFlags, + ) -> Self { Self { - stylist, semantic, - state: Vec::new(), - annotation: String::new(), + stylist, + locator, + flags, } } - fn into_annotation(self) -> String { - self.annotation + fn into_annotation(self, expr: &Expr) -> String { + let mut expr_without_forward_references = expr.clone(); + self.visit_expr(&mut expr_without_forward_references); + let generator = Generator::from(self.stylist); + // we first generate the annotation with the inverse quote, so we can + // generate the string literal with the preferred quote + let subgenerator = Generator::new(self.stylist.indentation(), self.stylist.line_ending()); + let annotation = subgenerator.expr(&expr_without_forward_references); + generator.expr(&Expr::from(ast::StringLiteral { + range: TextRange::default(), + value: annotation.into_boxed_str(), + flags: self.flags, + })) } -} -impl<'a> source_order::SourceOrderVisitor<'a> for QuoteAnnotator<'a> { - fn visit_expr(&mut self, expr: &'a Expr) { - let generator = Generator::from(self.stylist); + fn visit_annotated_slice(&self, slice: &mut Expr) { + // we only want to walk the first tuple element if it exists, + // anything else should not be transformed + if let Expr::Tuple(ast::ExprTuple { elts, .. }) = slice { + if !elts.is_empty() { + self.visit_expr(&mut elts[0]); + // The outer annotation will use the preferred quote. + // As such, any quotes found in metadata elements inside an `Annotated` slice + // should use the opposite quote to the preferred quote. + for elt in elts.iter_mut().skip(1) { + QuoteRewriter::new(self.stylist).visit_expr(elt); + } + } + } + } +} +impl Transformer for QuoteAnnotator<'_> { + fn visit_expr(&self, expr: &mut Expr) { match expr { Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { - let value_expr = generator.expr(value); - self.annotation.push_str(&value_expr); - self.annotation.push('['); - if let Some(qualified_name) = self.semantic.resolve_qualified_name(value) { if self .semantic .match_typing_qualified_name(&qualified_name, "Literal") { - self.state.push(QuoteAnnotatorState::Literal); + // The outer annotation will use the preferred quote. + // As such, any quotes found inside a `Literal` slice + // should use the opposite quote to the preferred quote. + QuoteRewriter::new(self.stylist).visit_expr(slice); } else if self .semantic .match_typing_qualified_name(&qualified_name, "Annotated") { - self.state.push(QuoteAnnotatorState::AnnotatedFirst); + self.visit_annotated_slice(slice); } else { - self.state.push(QuoteAnnotatorState::Other); + self.visit_expr(slice); } } - - self.visit_expr(slice); - self.state.pop(); - self.annotation.push(']'); } - Expr::Tuple(ast::ExprTuple { elts, .. }) => { - let Some((first, remaining)) = elts.split_first() else { - return; - }; - self.visit_expr(first); - if let Some(last) = self.state.last_mut() { - if *last == QuoteAnnotatorState::AnnotatedFirst { - *last = QuoteAnnotatorState::AnnotatedRest; - } - } - for expr in remaining { - self.annotation.push_str(", "); + Expr::StringLiteral(literal) => { + // try to parse the forward reference and replace the string + // literal node with the parsed expression, if we fail to + // parse the forward reference, we just keep treating this + // like a regular string literal + if let Ok(annotation) = parse_type_annotation(literal, self.locator.contents()) { + *expr = annotation.expression().clone(); + // we need to visit the parsed expression too + // since it may contain forward references itself self.visit_expr(expr); } - self.state.pop(); - } - Expr::BinOp(ast::ExprBinOp { - left, op, right, .. - }) => { - debug_assert_eq!(*op, ast::Operator::BitOr); - self.visit_expr(left); - self.annotation.push_str(" | "); - self.visit_expr(right); } _ => { - let source = match self.state.last().copied() { - Some(QuoteAnnotatorState::Literal | QuoteAnnotatorState::AnnotatedRest) => { - let mut source = generator.expr(expr); - source = source.replace( - self.stylist.quote().as_char(), - &self.stylist.quote().opposite().as_char().to_string(), - ); - source - } - None - | Some(QuoteAnnotatorState::AnnotatedFirst | QuoteAnnotatorState::Other) => { - let mut source = generator.expr(expr); - source = source.replace(self.stylist.quote().as_char(), ""); - source = source.replace(self.stylist.quote().opposite().as_char(), ""); - source - } - }; - self.annotation.push_str(&source); + walk_expr(self, expr); } } } } + +/// A [`Transformer`] struct that rewrites all strings in an expression +/// to use a specified quotation style +#[derive(Debug)] +struct QuoteRewriter { + preferred_inner_quote: Quote, +} + +impl QuoteRewriter { + fn new(stylist: &Stylist) -> Self { + Self { + preferred_inner_quote: stylist.quote().opposite(), + } + } +} + +impl Transformer for QuoteRewriter { + fn visit_string_literal(&self, literal: &mut ast::StringLiteral) { + literal.flags = literal.flags.with_quote_style(self.preferred_inner_quote); + } +} diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/mod.rs b/crates/ruff_linter/src/rules/flake8_type_checking/mod.rs index ba57420f672a0..f5b777ec46b32 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/mod.rs @@ -10,35 +10,37 @@ mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::PythonVersion; use test_case::test_case; use crate::registry::{Linter, Rule}; use crate::test::{test_path, test_snippet}; use crate::{assert_messages, settings}; - #[test_case(Rule::EmptyTypeCheckingBlock, Path::new("TCH005.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_1.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_10.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_11.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_12.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_13.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_14.pyi"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_15.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_16.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_17.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_2.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_3.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_4.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_5.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_6.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_7.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_8.py"))] - #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TCH004_9.py"))] + #[test_case(Rule::EmptyTypeCheckingBlock, Path::new("TC005.py"))] + #[test_case(Rule::RuntimeCastValue, Path::new("TC006.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_1.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_10.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_11.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_12.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_13.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_14.pyi"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_15.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_16.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_17.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_2.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_3.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_4.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_5.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_6.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_7.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_8.py"))] + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("TC004_9.py"))] #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("quote.py"))] - #[test_case(Rule::RuntimeStringUnion, Path::new("TCH010_1.py"))] - #[test_case(Rule::RuntimeStringUnion, Path::new("TCH010_2.py"))] - #[test_case(Rule::TypingOnlyFirstPartyImport, Path::new("TCH001.py"))] - #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("TCH003.py"))] + #[test_case(Rule::RuntimeStringUnion, Path::new("TC010_1.py"))] + #[test_case(Rule::RuntimeStringUnion, Path::new("TC010_2.py"))] + #[test_case(Rule::TypingOnlyFirstPartyImport, Path::new("TC001.py"))] + #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("TC003.py"))] #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("init_var.py"))] #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("kw_only.py"))] #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("snapshot.py"))] @@ -46,7 +48,7 @@ mod tests { Rule::TypingOnlyStandardLibraryImport, Path::new("singledispatchmethod.py") )] - #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("TCH002.py"))] + #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("TC002.py"))] #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("quote.py"))] #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("singledispatch.py"))] #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("strict.py"))] @@ -62,6 +64,42 @@ mod tests { Ok(()) } + // we test these rules as a pair, since they're opposites of one another + // so we want to make sure their fixes are not going around in circles. + #[test_case(Rule::UnquotedTypeAlias, Path::new("TC007.py"))] + #[test_case(Rule::QuotedTypeAlias, Path::new("TC008.py"))] + #[test_case(Rule::QuotedTypeAlias, Path::new("TC008_typing_execution_context.py"))] + fn type_alias_rules(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!("{}_{}", rule_code.as_ref(), path.to_string_lossy()); + let diagnostics = test_path( + Path::new("flake8_type_checking").join(path).as_path(), + &settings::LinterSettings::for_rules(vec![ + Rule::UnquotedTypeAlias, + Rule::QuotedTypeAlias, + ]), + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case(Rule::QuotedTypeAlias, Path::new("TC008_union_syntax_pre_py310.py"))] + fn type_alias_rules_pre_py310(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "pre_py310_{}_{}", + rule_code.as_ref(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("flake8_type_checking").join(path).as_path(), + &settings::LinterSettings { + unresolved_target_version: PythonVersion::PY39.into(), + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("quote.py"))] #[test_case(Rule::TypingOnlyThirdPartyImport, Path::new("quote.py"))] #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("quote2.py"))] @@ -241,6 +279,33 @@ mod tests { Ok(()) } + #[test_case(Rule::RuntimeImportInTypeCheckingBlock, Path::new("module/app.py"))] + #[test_case(Rule::TypingOnlyStandardLibraryImport, Path::new("module/routes.py"))] + fn decorator_same_file(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!("{}_{}", rule_code.as_ref(), path.to_string_lossy()); + let diagnostics = test_path( + Path::new("flake8_type_checking").join(path).as_path(), + &settings::LinterSettings { + flake8_type_checking: super::settings::Settings { + runtime_required_decorators: vec![ + "fastapi.FastAPI.get".to_string(), + "fastapi.FastAPI.put".to_string(), + "module.app.AppContainer.app.get".to_string(), + "module.app.AppContainer.app.put".to_string(), + "module.app.app.get".to_string(), + "module.app.app.put".to_string(), + "module.app.app_container.app.get".to_string(), + "module.app.app_container.app.put".to_string(), + ], + ..Default::default() + }, + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test_case( r" from __future__ import annotations @@ -430,6 +495,29 @@ mod tests { ", "multiple_modules_different_types" )] + #[test_case( + r" + from __future__ import annotations + + from typing import TYPE_CHECKING, TypeAlias + if TYPE_CHECKING: + from foo import Foo # TC004 + + a: TypeAlias = Foo | None # OK + ", + "tc004_precedence_over_tc007" + )] + #[test_case( + r" + from __future__ import annotations + + from typing import TypeAlias + + a: TypeAlias = 'int | None' # TC008 + b: TypeAlias = 'int' | None # TC010 + ", + "tc010_precedence_over_tc008" + )] fn contents(contents: &str, snapshot: &str) { let diagnostics = test_snippet( contents, @@ -437,4 +525,56 @@ mod tests { ); assert_messages!(snapshot, diagnostics); } + + #[test_case( + r" + from __future__ import annotations + + TYPE_CHECKING = False + if TYPE_CHECKING: + from types import TracebackType + + def foo(tb: TracebackType): ... + ", + "github_issue_15681_regression_test" + )] + #[test_case( + r" + from __future__ import annotations + + import pathlib # TC003 + + TYPE_CHECKING = False + if TYPE_CHECKING: + from types import TracebackType + + def foo(tb: TracebackType) -> pathlib.Path: ... + ", + "github_issue_15681_fix_test" + )] + #[test_case( + r" + from __future__ import annotations + + TYPE_CHECKING = False + if TYPE_CHECKING: + from typing import Any, Literal, Never, Self + else: + def __getattr__(name: str): + pass + + __all__ = ['TYPE_CHECKING', 'Any', 'Literal', 'Never', 'Self'] + ", + "github_issue_16045" + )] + fn contents_preview(contents: &str, snapshot: &str) { + let diagnostics = test_snippet( + contents, + &settings::LinterSettings { + preview: settings::types::PreviewMode::Enabled, + ..settings::LinterSettings::for_rules(Linter::Flake8TypeChecking.rules()) + }, + ); + assert_messages!(snapshot, diagnostics); + } } diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/empty_type_checking_block.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/empty_type_checking_block.rs index 23d97b5c2d1ed..54da378b8ad17 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/rules/empty_type_checking_block.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/empty_type_checking_block.rs @@ -1,7 +1,7 @@ use ruff_python_ast as ast; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; @@ -31,23 +31,23 @@ use crate::fix; /// ``` /// /// ## References -/// - [PEP 535](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) -#[violation] -pub struct EmptyTypeCheckingBlock; +/// - [PEP 563: Runtime annotation resolution and `TYPE_CHECKING`](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) +#[derive(ViolationMetadata)] +pub(crate) struct EmptyTypeCheckingBlock; impl AlwaysFixableViolation for EmptyTypeCheckingBlock { #[derive_message_formats] fn message(&self) -> String { - format!("Found empty type-checking block") + "Found empty type-checking block".to_string() } fn fix_title(&self) -> String { - format!("Delete empty type-checking block") + "Delete empty type-checking block".to_string() } } -/// TCH005 -pub(crate) fn empty_type_checking_block(checker: &mut Checker, stmt: &ast::StmtIf) { +/// TC005 +pub(crate) fn empty_type_checking_block(checker: &Checker, stmt: &ast::StmtIf) { if !typing::is_type_checking_block(stmt, checker.semantic()) { return; } @@ -71,5 +71,5 @@ pub(crate) fn empty_type_checking_block(checker: &mut Checker, stmt: &ast::StmtI diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_parent_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/mod.rs index 1f94e927c46c6..5cefae4b2ec39 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/mod.rs @@ -1,9 +1,13 @@ pub(crate) use empty_type_checking_block::*; +pub(crate) use runtime_cast_value::*; pub(crate) use runtime_import_in_type_checking_block::*; pub(crate) use runtime_string_union::*; +pub(crate) use type_alias_quotes::*; pub(crate) use typing_only_runtime_import::*; mod empty_type_checking_block; +mod runtime_cast_value; mod runtime_import_in_type_checking_block; mod runtime_string_union; +mod type_alias_quotes; mod typing_only_runtime_import; diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_cast_value.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_cast_value.rs new file mode 100644 index 0000000000000..ec6ffee598b65 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_cast_value.rs @@ -0,0 +1,79 @@ +use ruff_python_ast::Expr; + +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::rules::flake8_type_checking::helpers::quote_type_expression; + +/// ## What it does +/// Checks for unquoted type expressions in `typing.cast()` calls. +/// +/// ## Why is this bad? +/// This rule helps enforce a consistent style across your codebase. +/// +/// It's often necessary to quote the first argument passed to `cast()`, +/// as type expressions can involve forward references, or references +/// to symbols which are only imported in `typing.TYPE_CHECKING` blocks. +/// This can lead to a visual inconsistency across different `cast()` calls, +/// where some type expressions are quoted but others are not. By enabling +/// this rule, you ensure that all type expressions passed to `cast()` are +/// quoted, enforcing stylistic consistency across all of your `cast()` calls. +/// +/// In some cases where `cast()` is used in a hot loop, this rule may also +/// help avoid overhead from repeatedly evaluating complex type expressions at +/// runtime. +/// +/// ## Example +/// ```python +/// from typing import cast +/// +/// x = cast(dict[str, int], foo) +/// ``` +/// +/// Use instead: +/// ```python +/// from typing import cast +/// +/// x = cast("dict[str, int]", foo) +/// ``` +/// +/// ## Fix safety +/// This fix is safe as long as the type expression doesn't span multiple +/// lines and includes comments on any of the lines apart from the last one. +#[derive(ViolationMetadata)] +pub(crate) struct RuntimeCastValue; + +impl AlwaysFixableViolation for RuntimeCastValue { + #[derive_message_formats] + fn message(&self) -> String { + "Add quotes to type expression in `typing.cast()`".to_string() + } + + fn fix_title(&self) -> String { + "Add quotes".to_string() + } +} + +/// TC006 +pub(crate) fn runtime_cast_value(checker: &Checker, type_expr: &Expr) { + if type_expr.is_string_literal_expr() { + return; + } + + let mut diagnostic = Diagnostic::new(RuntimeCastValue, type_expr.range()); + let edit = quote_type_expression( + type_expr, + checker.semantic(), + checker.stylist(), + checker.locator(), + checker.default_string_flags(), + ); + if checker.comment_ranges().intersects(type_expr.range()) { + diagnostic.set_fix(Fix::unsafe_edit(edit)); + } else { + diagnostic.set_fix(Fix::safe_edit(edit)); + } + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_import_in_type_checking_block.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_import_in_type_checking_block.rs index fda7243224fd5..dc3b337984665 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_import_in_type_checking_block.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_import_in_type_checking_block.rs @@ -4,8 +4,8 @@ use anyhow::Result; use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_semantic::{Imported, NodeId, Scope}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::{Imported, NodeId, Scope, ScopeId}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -16,11 +16,12 @@ use crate::rules::flake8_type_checking::helpers::{filter_contained, quote_annota use crate::rules::flake8_type_checking::imports::ImportBinding; /// ## What it does -/// Checks for runtime imports defined in a type-checking block. +/// Checks for imports that are required at runtime but are only defined in +/// type-checking blocks. /// /// ## Why is this bad? -/// The type-checking block is not executed at runtime, so the import will not -/// be available at runtime. +/// The type-checking block is not executed at runtime, so if the only definition +/// of a symbol is in a type-checking block, it will not be available at runtime. /// /// If [`lint.flake8-type-checking.quote-annotations`] is set to `true`, /// annotations will be wrapped in quotes if doing so would enable the @@ -51,9 +52,9 @@ use crate::rules::flake8_type_checking::imports::ImportBinding; /// - `lint.flake8-type-checking.quote-annotations` /// /// ## References -/// - [PEP 535](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) -#[violation] -pub struct RuntimeImportInTypeCheckingBlock { +/// - [PEP 563: Runtime annotation resolution and `TYPE_CHECKING`](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) +#[derive(ViolationMetadata)] +pub(crate) struct RuntimeImportInTypeCheckingBlock { qualified_name: String, strategy: Strategy, } @@ -96,15 +97,19 @@ enum Action { Ignore, } -/// TCH004 -pub(crate) fn runtime_import_in_type_checking_block( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +/// TC004 +pub(crate) fn runtime_import_in_type_checking_block(checker: &Checker, scope: &Scope) { // Collect all runtime imports by statement. let mut actions: FxHashMap<(NodeId, Action), Vec<ImportBinding>> = FxHashMap::default(); + // If we have a module-level __getattr__ method we don't necessarily know that the + // references in __all__ refer to typing-only imports, the __getattr__ might be + // able to handle that attribute access and return the correct thing at runtime. + let ignore_dunder_all_references = checker + .semantic() + .lookup_symbol_in_scope("__getattr__", ScopeId::global(), false) + .is_some(); + for binding_id in scope.binding_ids() { let binding = checker.semantic().binding(binding_id); @@ -118,10 +123,10 @@ pub(crate) fn runtime_import_in_type_checking_block( if binding.context.is_typing() && binding.references().any(|reference_id| { - checker - .semantic() - .reference(reference_id) - .in_runtime_context() + let reference = checker.semantic().reference(reference_id); + + reference.in_runtime_context() + && !(ignore_dunder_all_references && reference.in_dunder_all_definition()) }) { let Some(node_id) = binding.source else { @@ -151,6 +156,14 @@ pub(crate) fn runtime_import_in_type_checking_block( } else { // Determine whether the member should be fixed by moving the import out of the // type-checking block, or by quoting its references. + // TODO: We should check `reference.in_annotated_type_alias()` + // as well to match the behavior of the flake8 plugin + // although maybe the best way forward is to add an + // additional setting to configure whether quoting + // or moving the import is preferred for type aliases + // since some people will consistently use their + // type aliases at runtimes, while others won't, so + // the best solution is unclear. if checker.settings.flake8_type_checking.quote_annotations && binding.references().all(|reference_id| { let reference = checker.semantic().reference(reference_id); @@ -198,14 +211,14 @@ pub(crate) fn runtime_import_in_type_checking_block( if let Some(fix) = fix.as_ref() { diagnostic.set_fix(fix.clone()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } // Generate a diagnostic for every import, but share a fix across all imports within the same // statement (excluding those that are ignored). Action::Quote => { - let fix = quote_imports(checker, node_id, &imports).ok(); + let fix = quote_imports(checker, node_id, &imports); for ImportBinding { import, @@ -224,10 +237,8 @@ pub(crate) fn runtime_import_in_type_checking_block( if let Some(range) = parent_range { diagnostic.set_parent(range.start()); } - if let Some(fix) = fix.as_ref() { - diagnostic.set_fix(fix.clone()); - } - diagnostics.push(diagnostic); + diagnostic.set_fix(fix.clone()); + checker.report_diagnostic(diagnostic); } } @@ -251,7 +262,7 @@ pub(crate) fn runtime_import_in_type_checking_block( if let Some(range) = parent_range { diagnostic.set_parent(range.start()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -259,7 +270,7 @@ pub(crate) fn runtime_import_in_type_checking_block( } /// Generate a [`Fix`] to quote runtime usages for imports in a type-checking block. -fn quote_imports(checker: &Checker, node_id: NodeId, imports: &[ImportBinding]) -> Result<Fix> { +fn quote_imports(checker: &Checker, node_id: NodeId, imports: &[ImportBinding]) -> Fix { let quote_reference_edits = filter_contained( imports .iter() @@ -271,20 +282,22 @@ fn quote_imports(checker: &Checker, node_id: NodeId, imports: &[ImportBinding]) reference.expression_id()?, checker.semantic(), checker.stylist(), + checker.locator(), + checker.default_string_flags(), )) } else { None } }) }) - .collect::<Result<Vec<_>>>()?, + .collect::<Vec<_>>(), ); let mut rest = quote_reference_edits.into_iter(); let head = rest.next().expect("Expected at least one reference"); - Ok(Fix::unsafe_edits(head, rest).isolate(Checker::isolation( + Fix::unsafe_edits(head, rest).isolate(Checker::isolation( checker.semantic().parent_statement_id(node_id), - ))) + )) } /// Generate a [`Fix`] to remove runtime imports from a type-checking block. diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_string_union.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_string_union.rs index 7d63517a32ca3..d5142b6dbeb38 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_string_union.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/runtime_string_union.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::{Expr, Operator}; use ruff_text_size::Ranged; @@ -37,22 +37,22 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [PEP 535](https://peps.python.org/pep-0563/) -/// - [PEP 604](https://peps.python.org/pep-0604/) +/// - [PEP 563 - Postponed Evaluation of Annotations](https://peps.python.org/pep-0563/) +/// - [PEP 604 – Allow writing union types as `X | Y`](https://peps.python.org/pep-0604/) /// /// [PEP 604]: https://peps.python.org/pep-0604/ -#[violation] -pub struct RuntimeStringUnion; +#[derive(ViolationMetadata)] +pub(crate) struct RuntimeStringUnion; impl Violation for RuntimeStringUnion { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid string member in `X | Y`-style union type") + "Invalid string member in `X | Y`-style union type".to_string() } } -/// TCH006 -pub(crate) fn runtime_string_union(checker: &mut Checker, expr: &Expr) { +/// TC010 +pub(crate) fn runtime_string_union(checker: &Checker, expr: &Expr) { if !checker.semantic().in_type_definition() { return; } @@ -66,9 +66,7 @@ pub(crate) fn runtime_string_union(checker: &mut Checker, expr: &Expr) { traverse_op(expr, &mut strings); for string in strings { - checker - .diagnostics - .push(Diagnostic::new(RuntimeStringUnion, string.range())); + checker.report_diagnostic(Diagnostic::new(RuntimeStringUnion, string.range())); } } diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/type_alias_quotes.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/type_alias_quotes.rs new file mode 100644 index 0000000000000..3f0572aa63755 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/type_alias_quotes.rs @@ -0,0 +1,378 @@ +use ast::{ExprContext, Operator}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; +use ruff_python_ast::{Expr, Stmt}; +use ruff_python_semantic::{Binding, SemanticModel, TypingOnlyBindingsStatus}; +use ruff_python_stdlib::typing::{is_pep_593_generic_type, is_standard_library_literal}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::registry::Rule; +use crate::rules::flake8_type_checking::helpers::quote_type_expression; +use ruff_python_ast::PythonVersion; + +/// ## What it does +/// Checks if [PEP 613] explicit type aliases contain references to +/// symbols that are not available at runtime. +/// +/// ## Why is this bad? +/// Referencing type-checking only symbols results in a `NameError` at runtime. +/// +/// ## Example +/// ```python +/// from typing import TYPE_CHECKING, TypeAlias +/// +/// if TYPE_CHECKING: +/// from foo import Foo +/// OptFoo: TypeAlias = Foo | None +/// ``` +/// +/// Use instead: +/// ```python +/// from typing import TYPE_CHECKING, TypeAlias +/// +/// if TYPE_CHECKING: +/// from foo import Foo +/// OptFoo: TypeAlias = "Foo | None" +/// ``` +/// +/// ## Fix safety +/// This rule's fix is currently always marked as unsafe, since runtime +/// typing libraries may try to access/resolve the type alias in a way +/// that we can't statically determine during analysis and relies on the +/// type alias not containing any forward references. +/// +/// ## References +/// - [PEP 613 – Explicit Type Aliases](https://peps.python.org/pep-0613/) +/// +/// [PEP 613]: https://peps.python.org/pep-0613/ +#[derive(ViolationMetadata)] +pub(crate) struct UnquotedTypeAlias; + +impl Violation for UnquotedTypeAlias { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Add quotes to type alias".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Add quotes".to_string()) + } +} + +/// ## What it does +/// Checks for unnecessary quotes in [PEP 613] explicit type aliases +/// and [PEP 695] type statements. +/// +/// ## Why is this bad? +/// Unnecessary string forward references can lead to additional overhead +/// in runtime libraries making use of type hints. They can also have bad +/// interactions with other runtime uses like [PEP 604] type unions. +/// +/// PEP-613 type aliases are only flagged by the rule if Ruff can have high +/// confidence that the quotes are unnecessary. Specifically, any PEP-613 +/// type alias where the type expression on the right-hand side contains +/// subscripts or attribute accesses will not be flagged. This is because +/// type aliases can reference types that are, for example, generic in stub +/// files but not at runtime. That can mean that a type checker expects the +/// referenced type to be subscripted with type arguments despite the fact +/// that doing so would fail at runtime if the type alias value was not +/// quoted. Similarly, a type alias might need to reference a module-level +/// attribute that exists in a stub file but not at runtime, meaning that +/// the type alias value would need to be quoted to avoid a runtime error. +/// +/// ## Example +/// Given: +/// ```python +/// OptInt: TypeAlias = "int | None" +/// ``` +/// +/// Use instead: +/// ```python +/// OptInt: TypeAlias = int | None +/// ``` +/// +/// Given: +/// ```python +/// type OptInt = "int | None" +/// ``` +/// +/// Use instead: +/// ```python +/// type OptInt = int | None +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the type annotation contains comments. +/// +/// ## See also +/// This rule only applies to type aliases in non-stub files. For removing quotes in other +/// contexts or in stub files, see: +/// +/// - [`quoted-annotation-in-stub`][PYI020]: A rule that +/// removes all quoted annotations from stub files +/// - [`quoted-annotation`][UP037]: A rule that removes unnecessary quotes +/// from *annotations* in runtime files. +/// +/// ## References +/// - [PEP 613 – Explicit Type Aliases](https://peps.python.org/pep-0613/) +/// - [PEP 695: Generic Type Alias](https://peps.python.org/pep-0695/#generic-type-alias) +/// - [PEP 604 – Allow writing union types as `X | Y`](https://peps.python.org/pep-0604/) +/// +/// [PEP 604]: https://peps.python.org/pep-0604/ +/// [PEP 613]: https://peps.python.org/pep-0613/ +/// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias +/// [PYI020]: https://docs.astral.sh/ruff/rules/quoted-annotation-in-stub/ +/// [UP037]: https://docs.astral.sh/ruff/rules/quoted-annotation/ +#[derive(ViolationMetadata)] +pub(crate) struct QuotedTypeAlias; + +impl AlwaysFixableViolation for QuotedTypeAlias { + #[derive_message_formats] + fn message(&self) -> String { + "Remove quotes from type alias".to_string() + } + + fn fix_title(&self) -> String { + "Remove quotes".to_string() + } +} + +/// TC007 +pub(crate) fn unquoted_type_alias(checker: &Checker, binding: &Binding) { + if binding.context.is_typing() { + return; + } + + if !binding.is_annotated_type_alias() { + return; + } + + let Some(Stmt::AnnAssign(ast::StmtAnnAssign { + value: Some(expr), .. + })) = binding.statement(checker.semantic()) + else { + return; + }; + + let mut names = Vec::new(); + collect_typing_references(checker, expr, &mut names); + if names.is_empty() { + return; + } + + // We generate a diagnostic for every name that needs to be quoted + // but we currently emit a single shared fix that quotes the entire + // expression. + // + // Eventually we may try to be more clever and come up with the + // minimal set of subexpressions that need to be quoted. + let parent = expr.range().start(); + let edit = quote_type_expression( + expr, + checker.semantic(), + checker.stylist(), + checker.locator(), + checker.default_string_flags(), + ); + for name in names { + checker.report_diagnostic( + Diagnostic::new(UnquotedTypeAlias, name.range()) + .with_parent(parent) + .with_fix(Fix::unsafe_edit(edit.clone())), + ); + } +} + +/// Traverses the type expression and collects `[Expr::Name]` nodes that are +/// not available at runtime and thus need to be quoted, unless they would +/// become available through `[Rule::RuntimeImportInTypeCheckingBlock]`. +fn collect_typing_references<'a>( + checker: &Checker, + expr: &'a Expr, + names: &mut Vec<&'a ast::ExprName>, +) { + match expr { + Expr::BinOp(ast::ExprBinOp { left, right, .. }) => { + collect_typing_references(checker, left, names); + collect_typing_references(checker, right, names); + } + Expr::Starred(ast::ExprStarred { + value, + ctx: ExprContext::Load, + .. + }) + | Expr::Attribute(ast::ExprAttribute { value, .. }) => { + collect_typing_references(checker, value, names); + } + Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { + collect_typing_references(checker, value, names); + if let Some(qualified_name) = checker.semantic().resolve_qualified_name(value) { + if is_standard_library_literal(qualified_name.segments()) { + return; + } + if is_pep_593_generic_type(qualified_name.segments()) { + // First argument is a type (including forward references); the + // rest are arbitrary Python objects. + if let Expr::Tuple(ast::ExprTuple { elts, .. }) = slice.as_ref() { + let mut iter = elts.iter(); + if let Some(expr) = iter.next() { + collect_typing_references(checker, expr, names); + } + } + return; + } + } + collect_typing_references(checker, slice, names); + } + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { + for elt in elts { + collect_typing_references(checker, elt, names); + } + } + Expr::Name(name) => { + let Some(binding_id) = checker.semantic().resolve_name(name) else { + return; + }; + if checker + .semantic() + .simulate_runtime_load(name, TypingOnlyBindingsStatus::Disallowed) + .is_some() + { + return; + } + + // if TC004 is enabled we shouldn't emit a TC007 for a reference to + // a binding that would emit a TC004, otherwise the fixes will never + // stabilize and keep going in circles + if checker.enabled(Rule::RuntimeImportInTypeCheckingBlock) + && checker + .semantic() + .binding(binding_id) + .references() + .any(|id| checker.semantic().reference(id).in_runtime_context()) + { + return; + } + names.push(name); + } + _ => {} + } +} + +/// TC008 +pub(crate) fn quoted_type_alias( + checker: &Checker, + expr: &Expr, + annotation_expr: &ast::ExprStringLiteral, +) { + if checker.enabled(Rule::RuntimeStringUnion) { + // this should return a TC010 error instead + if let Some(Expr::BinOp(ast::ExprBinOp { + op: Operator::BitOr, + .. + })) = checker.semantic().current_expression_parent() + { + return; + } + } + + // explicit type aliases require some additional checks to avoid false positives + if checker.semantic().in_annotated_type_alias_value() + && quotes_are_unremovable(checker.semantic(), expr, checker.target_version()) + { + return; + } + + let range = annotation_expr.range(); + let mut diagnostic = Diagnostic::new(QuotedTypeAlias, range); + let edit = Edit::range_replacement(annotation_expr.value.to_string(), range); + if checker.comment_ranges().intersects(range) { + diagnostic.set_fix(Fix::unsafe_edit(edit)); + } else { + diagnostic.set_fix(Fix::safe_edit(edit)); + } + checker.report_diagnostic(diagnostic); +} + +/// Traverses the type expression and checks if the expression can safely +/// be unquoted +fn quotes_are_unremovable( + semantic: &SemanticModel, + expr: &Expr, + target_version: PythonVersion, +) -> bool { + match expr { + Expr::BinOp(ast::ExprBinOp { + left, right, op, .. + }) => { + match op { + Operator::BitOr => { + if target_version < PythonVersion::PY310 { + return true; + } + quotes_are_unremovable(semantic, left, target_version) + || quotes_are_unremovable(semantic, right, target_version) + } + // for now we'll treat uses of other operators as unremovable quotes + // since that would make it an invalid type expression anyways. We skip + // walking the nested non-type expressions from `typing.Annotated`, so + // we don't produce false negatives in this branch. + _ => true, + } + } + Expr::Starred(ast::ExprStarred { + value, + ctx: ExprContext::Load, + .. + }) => quotes_are_unremovable(semantic, value, target_version), + Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { + // for subscripts we don't know whether it's safe to do at runtime + // since the operation may only be available at type checking time. + // E.g. stubs only generics. + if !semantic.in_type_checking_block() { + return true; + } + if quotes_are_unremovable(semantic, value, target_version) { + return true; + } + // for `typing.Annotated`, only analyze the first argument, since the rest may + // contain arbitrary expressions. + if let Some(qualified_name) = semantic.resolve_qualified_name(value) { + if semantic.match_typing_qualified_name(&qualified_name, "Annotated") { + if let Expr::Tuple(ast::ExprTuple { elts, .. }) = slice.as_ref() { + return !elts.is_empty() + && quotes_are_unremovable(semantic, &elts[0], target_version); + } + return false; + } + } + quotes_are_unremovable(semantic, slice, target_version) + } + Expr::Attribute(ast::ExprAttribute { value, .. }) => { + // for attributes we also don't know whether it's safe + if !semantic.in_type_checking_block() { + return true; + } + quotes_are_unremovable(semantic, value, target_version) + } + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { + for elt in elts { + if quotes_are_unremovable(semantic, elt, target_version) { + return true; + } + } + false + } + Expr::Name(name) => { + semantic.resolve_name(name).is_some() + && semantic + .simulate_runtime_load(name, semantic.in_type_checking_block().into()) + .is_none() + } + _ => false, + } +} diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/rules/typing_only_runtime_import.rs b/crates/ruff_linter/src/rules/flake8_type_checking/rules/typing_only_runtime_import.rs index c51b515d03c6a..61aaa0f344a1b 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/rules/typing_only_runtime_import.rs +++ b/crates/ruff_linter/src/rules/flake8_type_checking/rules/typing_only_runtime_import.rs @@ -3,20 +3,22 @@ use std::borrow::Cow; use anyhow::Result; use rustc_hash::FxHashMap; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::{Binding, Imported, NodeId, Scope}; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::codes::Rule; use crate::fix; use crate::importer::ImportedMembers; +use crate::preview::is_full_path_match_source_strategy_enabled; use crate::rules::flake8_type_checking::helpers::{ filter_contained, is_typing_reference, quote_annotation, }; use crate::rules::flake8_type_checking::imports::ImportBinding; -use crate::rules::isort::{categorize, ImportSection, ImportType}; +use crate::rules::isort::categorize::MatchSourceStrategy; +use crate::rules::isort::{ImportSection, ImportType, categorize}; /// ## What it does /// Checks for first-party imports that are only used for type annotations, but @@ -63,16 +65,23 @@ use crate::rules::isort::{categorize, ImportSection, ImportType}; /// return len(sized) /// ``` /// +/// +/// ## Preview +/// When [preview](https://docs.astral.sh/ruff/preview/) is enabled, +/// the criterion for determining whether an import is first-party +/// is stricter, which could affect whether this lint is triggered vs [`TC001`](https://docs.astral.sh/ruff/rules/typing-only-third-party-import/). See [this FAQ section](https://docs.astral.sh/ruff/faq/#how-does-ruff-determine-which-of-my-imports-are-first-party-third-party-etc) for more details. +/// /// ## Options /// - `lint.flake8-type-checking.quote-annotations` /// - `lint.flake8-type-checking.runtime-evaluated-base-classes` /// - `lint.flake8-type-checking.runtime-evaluated-decorators` +/// - `lint.flake8-type-checking.strict` /// - `lint.typing-modules` /// /// ## References -/// - [PEP 536](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) -#[violation] -pub struct TypingOnlyFirstPartyImport { +/// - [PEP 563: Runtime annotation resolution and `TYPE_CHECKING`](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) +#[derive(ViolationMetadata)] +pub(crate) struct TypingOnlyFirstPartyImport { qualified_name: String, } @@ -137,16 +146,22 @@ impl Violation for TypingOnlyFirstPartyImport { /// return len(df) /// ``` /// +/// ## Preview +/// When [preview](https://docs.astral.sh/ruff/preview/) is enabled, +/// the criterion for determining whether an import is first-party +/// is stricter, which could affect whether this lint is triggered vs [`TC001`](https://docs.astral.sh/ruff/rules/typing-only-first-party-import/). See [this FAQ section](https://docs.astral.sh/ruff/faq/#how-does-ruff-determine-which-of-my-imports-are-first-party-third-party-etc) for more details. +/// /// ## Options /// - `lint.flake8-type-checking.quote-annotations` /// - `lint.flake8-type-checking.runtime-evaluated-base-classes` /// - `lint.flake8-type-checking.runtime-evaluated-decorators` +/// - `lint.flake8-type-checking.strict` /// - `lint.typing-modules` /// /// ## References -/// - [PEP 536](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) -#[violation] -pub struct TypingOnlyThirdPartyImport { +/// - [PEP 563: Runtime annotation resolution and `TYPE_CHECKING`](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) +#[derive(ViolationMetadata)] +pub(crate) struct TypingOnlyThirdPartyImport { qualified_name: String, } @@ -215,12 +230,13 @@ impl Violation for TypingOnlyThirdPartyImport { /// - `lint.flake8-type-checking.quote-annotations` /// - `lint.flake8-type-checking.runtime-evaluated-base-classes` /// - `lint.flake8-type-checking.runtime-evaluated-decorators` +/// - `lint.flake8-type-checking.strict` /// - `lint.typing-modules` /// /// ## References -/// - [PEP 536](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) -#[violation] -pub struct TypingOnlyStandardLibraryImport { +/// - [PEP 563: Runtime annotation resolution and `TYPE_CHECKING`](https://peps.python.org/pep-0563/#runtime-annotation-resolution-and-type-checking) +#[derive(ViolationMetadata)] +pub(crate) struct TypingOnlyStandardLibraryImport { qualified_name: String, } @@ -240,12 +256,11 @@ impl Violation for TypingOnlyStandardLibraryImport { } } -/// TCH001, TCH002, TCH003 +/// TC001, TC002, TC003 pub(crate) fn typing_only_runtime_import( checker: &Checker, scope: &Scope, runtime_imports: &[&Binding], - diagnostics: &mut Vec<Diagnostic>, ) { // Collect all typing-only imports by statement and import type. let mut errors_by_statement: FxHashMap<(NodeId, ImportType), Vec<ImportBinding>> = @@ -297,18 +312,28 @@ pub(crate) fn typing_only_runtime_import( continue; } + let source_name = import.source_name().join("."); + // Categorize the import, using coarse-grained categorization. + let match_source_strategy = + if is_full_path_match_source_strategy_enabled(checker.settings) { + MatchSourceStrategy::FullPath + } else { + MatchSourceStrategy::Root + }; + let import_type = match categorize( - &qualified_name.to_string(), + &source_name, qualified_name.is_unresolved_import(), &checker.settings.src, checker.package(), checker.settings.isort.detect_same_package, &checker.settings.isort.known_modules, - checker.settings.target_version, + checker.target_version(), checker.settings.isort.no_sections, &checker.settings.isort.section_order, &checker.settings.isort.default_section, + match_source_strategy, ) { ImportSection::Known(ImportType::LocalFolder | ImportType::FirstParty) => { ImportType::FirstParty @@ -368,17 +393,15 @@ pub(crate) fn typing_only_runtime_import( .. } in imports { - let mut diagnostic = Diagnostic::new( - diagnostic_for(import_type, import.qualified_name().to_string()), - range, - ); + let mut diagnostic = + diagnostic_for(import_type, import.qualified_name().to_string(), range); if let Some(range) = parent_range { diagnostic.set_parent(range.start()); } if let Some(fix) = fix.as_ref() { diagnostic.set_fix(fix.clone()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -392,14 +415,12 @@ pub(crate) fn typing_only_runtime_import( .. } in imports { - let mut diagnostic = Diagnostic::new( - diagnostic_for(import_type, import.qualified_name().to_string()), - range, - ); + let mut diagnostic = + diagnostic_for(import_type, import.qualified_name().to_string(), range); if let Some(range) = parent_range { diagnostic.set_parent(range.start()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -415,11 +436,17 @@ fn rule_for(import_type: ImportType) -> Rule { } /// Return the [`Diagnostic`] for the given import type. -fn diagnostic_for(import_type: ImportType, qualified_name: String) -> DiagnosticKind { +fn diagnostic_for(import_type: ImportType, qualified_name: String, range: TextRange) -> Diagnostic { match import_type { - ImportType::StandardLibrary => TypingOnlyStandardLibraryImport { qualified_name }.into(), - ImportType::ThirdParty => TypingOnlyThirdPartyImport { qualified_name }.into(), - ImportType::FirstParty => TypingOnlyFirstPartyImport { qualified_name }.into(), + ImportType::StandardLibrary => { + Diagnostic::new(TypingOnlyStandardLibraryImport { qualified_name }, range) + } + ImportType::ThirdParty => { + Diagnostic::new(TypingOnlyThirdPartyImport { qualified_name }, range) + } + ImportType::FirstParty => { + Diagnostic::new(TypingOnlyFirstPartyImport { qualified_name }, range) + } _ => unreachable!("Unexpected import type"), } } @@ -506,13 +533,15 @@ fn fix_imports(checker: &Checker, node_id: NodeId, imports: &[ImportBinding]) -> reference.expression_id()?, checker.semantic(), checker.stylist(), + checker.locator(), + checker.default_string_flags(), )) } else { None } }) }) - .collect::<Result<Vec<_>>>()?, + .collect::<Vec<_>>(), ); Ok(Fix::unsafe_edits( diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TC005.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TC005.py.snap new file mode 100644 index 0000000000000..5486cdfa4c8bc --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TC005.py.snap @@ -0,0 +1,79 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC005.py:4:5: TC005 [*] Found empty type-checking block + | +3 | if TYPE_CHECKING: +4 | pass # TC005 + | ^^^^ TC005 + | + = help: Delete empty type-checking block + +ℹ Safe fix +1 1 | from typing import TYPE_CHECKING, List +2 2 | +3 |-if TYPE_CHECKING: +4 |- pass # TC005 +5 3 | +6 4 | +7 5 | def example(): + +TC005.py:9:9: TC005 [*] Found empty type-checking block + | + 7 | def example(): + 8 | if TYPE_CHECKING: + 9 | pass # TC005 + | ^^^^ TC005 +10 | return + | + = help: Delete empty type-checking block + +ℹ Safe fix +5 5 | +6 6 | +7 7 | def example(): +8 |- if TYPE_CHECKING: +9 |- pass # TC005 +10 8 | return +11 9 | +12 10 | + +TC005.py:15:9: TC005 [*] Found empty type-checking block + | +13 | class Test: +14 | if TYPE_CHECKING: +15 | pass # TC005 + | ^^^^ TC005 +16 | x = 2 + | + = help: Delete empty type-checking block + +ℹ Safe fix +11 11 | +12 12 | +13 13 | class Test: +14 |- if TYPE_CHECKING: +15 |- pass # TC005 +16 14 | x = 2 +17 15 | +18 16 | + +TC005.py:31:5: TC005 [*] Found empty type-checking block + | +30 | if TYPE_CHECKING: +31 | pass # TC005 + | ^^^^ TC005 +32 | +33 | # https://github.com/astral-sh/ruff/issues/11368 + | + = help: Delete empty type-checking block + +ℹ Safe fix +27 27 | +28 28 | from typing_extensions import TYPE_CHECKING +29 29 | +30 |-if TYPE_CHECKING: +31 |- pass # TC005 +32 30 | +33 31 | # https://github.com/astral-sh/ruff/issues/11368 +34 32 | if TYPE_CHECKING: diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TCH005.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TCH005.py.snap deleted file mode 100644 index 8e6ff46d09dfe..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__empty-type-checking-block_TCH005.py.snap +++ /dev/null @@ -1,117 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH005.py:4:5: TCH005 [*] Found empty type-checking block - | -3 | if TYPE_CHECKING: -4 | pass # TCH005 - | ^^^^ TCH005 - | - = help: Delete empty type-checking block - -ℹ Safe fix -1 1 | from typing import TYPE_CHECKING, List -2 2 | -3 |-if TYPE_CHECKING: -4 |- pass # TCH005 -5 3 | -6 4 | -7 5 | if False: - -TCH005.py:8:5: TCH005 [*] Found empty type-checking block - | - 7 | if False: - 8 | pass # TCH005 - | ^^^^ TCH005 - 9 | -10 | if 0: - | - = help: Delete empty type-checking block - -ℹ Safe fix -4 4 | pass # TCH005 -5 5 | -6 6 | -7 |-if False: -8 |- pass # TCH005 -9 7 | -10 8 | if 0: -11 9 | pass # TCH005 - -TCH005.py:11:5: TCH005 [*] Found empty type-checking block - | -10 | if 0: -11 | pass # TCH005 - | ^^^^ TCH005 - | - = help: Delete empty type-checking block - -ℹ Safe fix -7 7 | if False: -8 8 | pass # TCH005 -9 9 | -10 |-if 0: -11 |- pass # TCH005 -12 10 | -13 11 | -14 12 | def example(): - -TCH005.py:16:9: TCH005 [*] Found empty type-checking block - | -14 | def example(): -15 | if TYPE_CHECKING: -16 | pass # TCH005 - | ^^^^ TCH005 -17 | return - | - = help: Delete empty type-checking block - -ℹ Safe fix -12 12 | -13 13 | -14 14 | def example(): -15 |- if TYPE_CHECKING: -16 |- pass # TCH005 -17 15 | return -18 16 | -19 17 | - -TCH005.py:22:9: TCH005 [*] Found empty type-checking block - | -20 | class Test: -21 | if TYPE_CHECKING: -22 | pass # TCH005 - | ^^^^ TCH005 -23 | x = 2 - | - = help: Delete empty type-checking block - -ℹ Safe fix -18 18 | -19 19 | -20 20 | class Test: -21 |- if TYPE_CHECKING: -22 |- pass # TCH005 -23 21 | x = 2 -24 22 | -25 23 | - -TCH005.py:45:5: TCH005 [*] Found empty type-checking block - | -44 | if TYPE_CHECKING: -45 | pass # TCH005 - | ^^^^ TCH005 -46 | -47 | # https://github.com/astral-sh/ruff/issues/11368 - | - = help: Delete empty type-checking block - -ℹ Safe fix -41 41 | -42 42 | from typing_extensions import TYPE_CHECKING -43 43 | -44 |-if TYPE_CHECKING: -45 |- pass # TCH005 -46 44 | -47 45 | # https://github.com/astral-sh/ruff/issues/11368 -48 46 | if TYPE_CHECKING: diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__exempt_modules.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__exempt_modules.snap index 1d292b3f73c5e..86813404430be 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__exempt_modules.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__exempt_modules.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -exempt_modules.py:14:12: TCH002 [*] Move third-party import `flask` into a type-checking block +exempt_modules.py:14:12: TC002 [*] Move third-party import `flask` into a type-checking block | 13 | def f(): 14 | import flask - | ^^^^^ TCH002 -15 | + | ^^^^^ TC002 +15 | 16 | x: flask | = help: Move into type-checking block @@ -26,5 +26,3 @@ exempt_modules.py:14:12: TCH002 [*] Move third-party import `flask` into a type- 14 |- import flask 15 18 | 16 19 | x: flask - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_15681_fix_test.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_15681_fix_test.snap new file mode 100644 index 0000000000000..86bb647a61114 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_15681_fix_test.snap @@ -0,0 +1,26 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +<filename>:4:8: TC003 [*] Move standard library import `pathlib` into a type-checking block + | +2 | from __future__ import annotations +3 | +4 | import pathlib # TC003 + | ^^^^^^^ TC003 +5 | +6 | TYPE_CHECKING = False + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | +2 2 | from __future__ import annotations +3 3 | +4 |-import pathlib # TC003 +5 4 | +6 5 | TYPE_CHECKING = False +7 6 | if TYPE_CHECKING: + 7 |+ import pathlib +8 8 | from types import TracebackType +9 9 | +10 10 | def foo(tb: TracebackType) -> pathlib.Path: ... diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_10.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_15681_regression_test.snap similarity index 100% rename from crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_10.py.snap rename to crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_15681_regression_test.snap diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_13.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_16045.snap similarity index 100% rename from crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_13.py.snap rename to crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__github_issue_16045.snap diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from.snap index 3e81c240c5c23..d289137f6e3fd 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from.snap @@ -1,11 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -<filename>:5:5: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +<filename>:5:5: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 4 | from pandas import ( 5 | DataFrame, # DataFrame - | ^^^^^^^^^ TCH002 + | ^^^^^^^^^ TC002 6 | Series, # Series 7 | ) | @@ -27,5 +28,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 8 13 | 9 14 | def f(x: DataFrame): 10 15 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from_type_checking_block.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from_type_checking_block.snap index 2d2a07add9d5e..2d61a1e9c93d5 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from_type_checking_block.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__import_from_type_checking_block.snap @@ -1,11 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -<filename>:7:5: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +<filename>:7:5: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 6 | from pandas import ( 7 | DataFrame, # DataFrame - | ^^^^^^^^^ TCH002 + | ^^^^^^^^^ TC002 8 | Series, # Series 9 | ) | @@ -26,5 +27,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 12 14 | import os 13 15 | 14 16 | def f(x: DataFrame): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_members.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_members.snap index 76bd56d43c612..718590d0fb862 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_members.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_members.snap @@ -1,11 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -<filename>:7:5: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +<filename>:7:5: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 6 | from pandas import ( 7 | DataFrame, # DataFrame - | ^^^^^^^^^ TCH002 + | ^^^^^^^^^ TC002 8 | Series, # Series 9 | ) | @@ -29,12 +30,12 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 11 13 | def f(x: DataFrame, y: Series): 12 14 | pass -<filename>:8:5: TCH002 [*] Move third-party import `pandas.Series` into a type-checking block +<filename>:8:5: TC002 [*] Move third-party import `pandas.Series` into a type-checking block | 6 | from pandas import ( 7 | DataFrame, # DataFrame 8 | Series, # Series - | ^^^^^^ TCH002 + | ^^^^^^ TC002 9 | ) | = help: Move into type-checking block @@ -56,5 +57,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 12 |+ 11 13 | def f(x: DataFrame, y: Series): 12 14 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_different_types.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_different_types.snap index 567f695f25eef..2e46ea78ae82e 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_different_types.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_different_types.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:8: TCH003 [*] Move standard library import `os` into a type-checking block +<filename>:6:8: TC003 [*] Move standard library import `os` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import os, pandas - | ^^ TCH003 -7 | + | ^^ TC003 +7 | 8 | def f(x: os, y: pandas): | = help: Move into type-checking block @@ -25,13 +25,13 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 8 11 | def f(x: os, y: pandas): 9 12 | pass -<filename>:6:12: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:12: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import os, pandas - | ^^^^^^ TCH002 -7 | + | ^^^^^^ TC002 +7 | 8 | def f(x: os, y: pandas): | = help: Move into type-checking block @@ -48,5 +48,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 7 10 | 8 11 | def f(x: os, y: pandas): 9 12 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_same_type.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_same_type.snap index 6814710f481d8..4b1eeaaeb92a2 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_same_type.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__multiple_modules_same_type.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:8: TCH003 [*] Move standard library import `os` into a type-checking block +<filename>:6:8: TC003 [*] Move standard library import `os` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import os, sys - | ^^ TCH003 -7 | + | ^^ TC003 +7 | 8 | def f(x: os, y: sys): | = help: Move into type-checking block @@ -24,13 +24,13 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 8 10 | def f(x: os, y: sys): 9 11 | pass -<filename>:6:12: TCH003 [*] Move standard library import `sys` into a type-checking block +<filename>:6:12: TC003 [*] Move standard library import `sys` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import os, sys - | ^^^ TCH003 -7 | + | ^^^ TC003 +7 | 8 | def f(x: os, y: sys): | = help: Move into type-checking block @@ -46,5 +46,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 |+ 8 10 | def f(x: os, y: sys): 9 11 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__no_typing_import.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__no_typing_import.snap index 3f9c1fb4f77a0..5b14c673f9d9a 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__no_typing_import.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__no_typing_import.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:4:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:4:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 2 | from __future__ import annotations -3 | +3 | 4 | import pandas as pd - | ^^ TCH002 -5 | + | ^^ TC002 +5 | 6 | def f(x: pd.DataFrame): | = help: Move into type-checking block @@ -24,5 +24,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 5 8 | 6 9 | def f(x: pd.DataFrame): 7 10 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__pre_py310_quoted-type-alias_TC008_union_syntax_pre_py310.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__pre_py310_quoted-type-alias_TC008_union_syntax_pre_py310.py.snap new file mode 100644 index 0000000000000..3d1c97799bc5c --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__pre_py310_quoted-type-alias_TC008_union_syntax_pre_py310.py.snap @@ -0,0 +1,40 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC008_union_syntax_pre_py310.py:10:20: TC008 [*] Remove quotes from type alias + | + 8 | if TYPE_CHECKING: + 9 | c: TypeAlias = 'int | None' # OK +10 | d: TypeAlias = 'Annotated[int, 1 | 2]' # TC008 + | ^^^^^^^^^^^^^^^^^^^^^^^ TC008 +11 | e: TypeAlias = 'Annotated[int, 1 + 2]' # TC008 +12 | f: TypeAlias = 'dict[str, int | None]' # OK + | + = help: Remove quotes + +ℹ Safe fix +7 7 | +8 8 | if TYPE_CHECKING: +9 9 | c: TypeAlias = 'int | None' # OK +10 |- d: TypeAlias = 'Annotated[int, 1 | 2]' # TC008 + 10 |+ d: TypeAlias = Annotated[int, 1 | 2] # TC008 +11 11 | e: TypeAlias = 'Annotated[int, 1 + 2]' # TC008 +12 12 | f: TypeAlias = 'dict[str, int | None]' # OK + +TC008_union_syntax_pre_py310.py:11:20: TC008 [*] Remove quotes from type alias + | + 9 | c: TypeAlias = 'int | None' # OK +10 | d: TypeAlias = 'Annotated[int, 1 | 2]' # TC008 +11 | e: TypeAlias = 'Annotated[int, 1 + 2]' # TC008 + | ^^^^^^^^^^^^^^^^^^^^^^^ TC008 +12 | f: TypeAlias = 'dict[str, int | None]' # OK + | + = help: Remove quotes + +ℹ Safe fix +8 8 | if TYPE_CHECKING: +9 9 | c: TypeAlias = 'int | None' # OK +10 10 | d: TypeAlias = 'Annotated[int, 1 | 2]' # TC008 +11 |- e: TypeAlias = 'Annotated[int, 1 + 2]' # TC008 + 11 |+ e: TypeAlias = Annotated[int, 1 + 2] # TC008 +12 12 | f: TypeAlias = 'dict[str, int | None]' # OK diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote.py.snap index de91616ce86fa..658646b7c2411 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -quote.py:57:28: TCH004 [*] Quote references to `pandas.DataFrame`. Import is in a type-checking block. +quote.py:57:28: TC004 [*] Quote references to `pandas.DataFrame`. Import is in a type-checking block. | 56 | if TYPE_CHECKING: 57 | from pandas import DataFrame - | ^^^^^^^^^ TCH004 -58 | + | ^^^^^^^^^ TC004 +58 | 59 | def func(value: DataFrame): | = help: Quote references @@ -19,4 +19,28 @@ quote.py:57:28: TCH004 [*] Quote references to `pandas.DataFrame`. Import is in 59 |+ def func(value: "DataFrame"): 60 60 | ... 61 61 | -62 62 | +62 62 | + +quote.py:110:28: TC004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. + | +109 | if TYPE_CHECKING: +110 | from pandas import DataFrame + | ^^^^^^^^^ TC004 +111 | +112 | x: TypeAlias = DataFrame | None + | + = help: Move out of type-checking block + +ℹ Unsafe fix + 1 |+from pandas import DataFrame +1 2 | def f(): +2 3 | from pandas import DataFrame +3 4 | +-------------------------------------------------------------------------------- +107 108 | from typing import TypeAlias, TYPE_CHECKING +108 109 | +109 110 | if TYPE_CHECKING: +110 |- from pandas import DataFrame + 111 |+ pass +111 112 | +112 113 | x: TypeAlias = DataFrame | None diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote2.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote3.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_runtime-import-in-type-checking-block_quote3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote.py.snap index cc72734ecf5e9..89ab3746f0602 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -quote.py:2:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:2:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 1 | def f(): 2 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -3 | + | ^^^^^^^^^ TC002 +3 | 4 | def baz() -> DataFrame: | = help: Move into type-checking block @@ -25,12 +25,12 @@ quote.py:2:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type 6 9 | 7 10 | -quote.py:9:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:9:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 8 | def f(): 9 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -10 | + | ^^^^^^^^^ TC002 +10 | 11 | def baz() -> DataFrame[int]: | = help: Move into type-checking block @@ -55,12 +55,12 @@ quote.py:9:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type 13 16 | 14 17 | -quote.py:16:22: TCH002 [*] Move third-party import `pandas` into a type-checking block +quote.py:16:22: TC002 [*] Move third-party import `pandas` into a type-checking block | 15 | def f(): 16 | import pandas as pd - | ^^ TCH002 -17 | + | ^^ TC002 +17 | 18 | def baz() -> pd.DataFrame: | = help: Move into type-checking block @@ -85,12 +85,12 @@ quote.py:16:22: TCH002 [*] Move third-party import `pandas` into a type-checking 20 23 | 21 24 | -quote.py:23:22: TCH002 [*] Move third-party import `pandas` into a type-checking block +quote.py:23:22: TC002 [*] Move third-party import `pandas` into a type-checking block | 22 | def f(): 23 | import pandas as pd - | ^^ TCH002 -24 | + | ^^ TC002 +24 | 25 | def baz() -> pd.DataFrame.Extra: | = help: Move into type-checking block @@ -115,12 +115,12 @@ quote.py:23:22: TCH002 [*] Move third-party import `pandas` into a type-checking 27 30 | 28 31 | -quote.py:30:22: TCH002 [*] Move third-party import `pandas` into a type-checking block +quote.py:30:22: TC002 [*] Move third-party import `pandas` into a type-checking block | 29 | def f(): 30 | import pandas as pd - | ^^ TCH002 -31 | + | ^^ TC002 +31 | 32 | def baz() -> pd.DataFrame | int: | = help: Move into type-checking block @@ -145,12 +145,12 @@ quote.py:30:22: TCH002 [*] Move third-party import `pandas` into a type-checking 34 37 | 35 38 | -quote.py:38:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:38:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 37 | def f(): 38 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -39 | + | ^^^^^^^^^ TC002 +39 | 40 | def baz() -> DataFrame(): | = help: Move into type-checking block @@ -175,13 +175,13 @@ quote.py:38:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a typ 42 45 | 43 46 | -quote.py:47:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:47:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 45 | from typing import Literal -46 | +46 | 47 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -48 | + | ^^^^^^^^^ TC002 +48 | 49 | def baz() -> DataFrame[Literal["int"]]: | = help: Move into type-checking block @@ -206,12 +206,12 @@ quote.py:47:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a typ 51 54 | 52 55 | -quote.py:64:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:64:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 63 | def f(): 64 | from pandas import DataFrame, Series - | ^^^^^^^^^ TCH002 -65 | + | ^^^^^^^^^ TC002 +65 | 66 | def baz() -> DataFrame | Series: | = help: Move into type-checking block @@ -236,12 +236,12 @@ quote.py:64:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a typ 68 71 | 69 72 | -quote.py:64:35: TCH002 [*] Move third-party import `pandas.Series` into a type-checking block +quote.py:64:35: TC002 [*] Move third-party import `pandas.Series` into a type-checking block | 63 | def f(): 64 | from pandas import DataFrame, Series - | ^^^^^^ TCH002 -65 | + | ^^^^^^ TC002 +65 | 66 | def baz() -> DataFrame | Series: | = help: Move into type-checking block @@ -266,12 +266,12 @@ quote.py:64:35: TCH002 [*] Move third-party import `pandas.Series` into a type-c 68 71 | 69 72 | -quote.py:71:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:71:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 70 | def f(): 71 | from pandas import DataFrame, Series - | ^^^^^^^^^ TCH002 -72 | + | ^^^^^^^^^ TC002 +72 | 73 | def baz() -> ( | = help: Move into type-checking block @@ -309,12 +309,12 @@ quote.py:71:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a typ 86 86 | 87 87 | -quote.py:71:35: TCH002 [*] Move third-party import `pandas.Series` into a type-checking block +quote.py:71:35: TC002 [*] Move third-party import `pandas.Series` into a type-checking block | 70 | def f(): 71 | from pandas import DataFrame, Series - | ^^^^^^ TCH002 -72 | + | ^^^^^^ TC002 +72 | 73 | def baz() -> ( | = help: Move into type-checking block @@ -352,12 +352,12 @@ quote.py:71:35: TCH002 [*] Move third-party import `pandas.Series` into a type-c 86 86 | 87 87 | -quote.py:89:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +quote.py:89:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 88 | def f(): 89 | from pandas import DataFrame, Series - | ^^^^^^^^^ TCH002 -90 | + | ^^^^^^^^^ TC002 +90 | 91 | def func(self) -> DataFrame | list[Series]: | = help: Move into type-checking block @@ -379,13 +379,15 @@ quote.py:89:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a typ 91 |- def func(self) -> DataFrame | list[Series]: 94 |+ def func(self) -> "DataFrame | list[Series]": 92 95 | pass +93 96 | +94 97 | -quote.py:89:35: TCH002 [*] Move third-party import `pandas.Series` into a type-checking block +quote.py:89:35: TC002 [*] Move third-party import `pandas.Series` into a type-checking block | 88 | def f(): 89 | from pandas import DataFrame, Series - | ^^^^^^ TCH002 -90 | + | ^^^^^^ TC002 +90 | 91 | def func(self) -> DataFrame | list[Series]: | = help: Move into type-checking block @@ -407,3 +409,5 @@ quote.py:89:35: TCH002 [*] Move third-party import `pandas.Series` into a type-c 91 |- def func(self) -> DataFrame | list[Series]: 94 |+ def func(self) -> "DataFrame | list[Series]": 92 95 | pass +93 96 | +94 97 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote2.py.snap index dc87bebfccda0..747fe681ccda5 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote2.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -quote2.py:2:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:2:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 1 | def f(): 2 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -3 | + | ^^^^^^^^^^^^^^^^ TC002 +3 | 4 | def test_remove_inner_quotes_double(self, user: AbstractBaseUser["int"]): | = help: Move into type-checking block @@ -25,12 +25,12 @@ quote2.py:2:44: TCH002 [*] Move third-party import `django.contrib.auth.models.A 6 9 | 7 10 | -quote2.py:9:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:9:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 8 | def f(): 9 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -10 | + | ^^^^^^^^^^^^^^^^ TC002 +10 | 11 | def test_remove_inner_quotes_single(self, user: AbstractBaseUser['int']): | = help: Move into type-checking block @@ -55,12 +55,12 @@ quote2.py:9:44: TCH002 [*] Move third-party import `django.contrib.auth.models.A 13 16 | 14 17 | -quote2.py:16:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:16:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 15 | def f(): 16 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -17 | + | ^^^^^^^^^^^^^^^^ TC002 +17 | 18 | def test_remove_inner_quotes_mixed(self, user: AbstractBaseUser['int', "str"]): | = help: Move into type-checking block @@ -85,13 +85,13 @@ quote2.py:16:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 20 23 | 21 24 | -quote2.py:25:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:25:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 23 | from typing import Annotated, Literal -24 | +24 | 25 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -26 | + | ^^^^^^^^^^^^^^^^ TC002 +26 | 27 | def test_literal_annotation_args_contain_quotes(self, type1: AbstractBaseUser[Literal["user", "admin"], Annotated["int", "1", 2]]): | = help: Move into type-checking block @@ -116,13 +116,13 @@ quote2.py:25:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 29 32 | 30 33 | -quote2.py:34:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:34:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 32 | from typing import Literal -33 | +33 | 34 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -35 | + | ^^^^^^^^^^^^^^^^ TC002 +35 | 36 | def test_union_contain_inner_quotes(self, type1: AbstractBaseUser["int" | Literal["int"]]): | = help: Move into type-checking block @@ -147,13 +147,13 @@ quote2.py:34:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 38 41 | 39 42 | -quote2.py:43:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:43:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 41 | from typing import Literal -42 | +42 | 43 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -44 | + | ^^^^^^^^^^^^^^^^ TC002 +44 | 45 | def test_inner_literal_mixed_quotes(user: AbstractBaseUser[Literal['user', "admin"]]): | = help: Move into type-checking block @@ -178,13 +178,13 @@ quote2.py:43:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 47 50 | 48 51 | -quote2.py:52:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:52:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 50 | from typing import Literal -51 | +51 | 52 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -53 | + | ^^^^^^^^^^^^^^^^ TC002 +53 | 54 | def test_inner_literal_single_quote(user: AbstractBaseUser[Literal['int'], str]): | = help: Move into type-checking block @@ -209,13 +209,13 @@ quote2.py:52:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 56 59 | 57 60 | -quote2.py:61:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:61:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 59 | from typing import Literal -60 | +60 | 61 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -62 | + | ^^^^^^^^^^^^^^^^ TC002 +62 | 63 | def test_mixed_quotes_literal(user: AbstractBaseUser[Literal['user'], "int"]): | = help: Move into type-checking block @@ -240,13 +240,13 @@ quote2.py:61:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 65 68 | 66 69 | -quote2.py:70:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote2.py:70:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 68 | from typing import Annotated, Literal -69 | +69 | 70 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -71 | + | ^^^^^^^^^^^^^^^^ TC002 +71 | 72 | def test_annotated_literal_mixed_quotes(user: AbstractBaseUser[Annotated[str, "max_length=20", Literal['user', "admin"]]]): | = help: Move into type-checking block diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote3.py.snap index 579cc74973b14..8e70e33c741eb 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quote_typing-only-third-party-import_quote3.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -quote3.py:4:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote3.py:4:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 2 | from typing import Literal, Union -3 | +3 | 4 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -5 | + | ^^^^^^^^^^^^^^^^ TC002 +5 | 6 | def test_union_literal_mixed_quotes(user: AbstractBaseUser[Union[Literal['active', "inactive"], str]]): | = help: Move into type-checking block @@ -28,13 +28,13 @@ quote3.py:4:44: TCH002 [*] Move third-party import `django.contrib.auth.models.A 8 11 | 9 12 | -quote3.py:13:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote3.py:13:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 11 | from typing import Callable, Literal -12 | +12 | 13 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -14 | + | ^^^^^^^^^^^^^^^^ TC002 +14 | 15 | def test_callable_literal_mixed_quotes(callable_fn: AbstractBaseUser[Callable[["int", Literal['admin', "user"]], 'bool']]): | = help: Move into type-checking block @@ -54,19 +54,19 @@ quote3.py:13:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 13 |- from django.contrib.auth.models import AbstractBaseUser 14 17 | 15 |- def test_callable_literal_mixed_quotes(callable_fn: AbstractBaseUser[Callable[["int", Literal['admin', "user"]], 'bool']]): - 18 |+ def test_callable_literal_mixed_quotes(callable_fn: 'AbstractBaseUser[Callable[[int, Literal[admin, user]], bool]]'): + 18 |+ def test_callable_literal_mixed_quotes(callable_fn: 'AbstractBaseUser[Callable[[int, Literal["admin", "user"]], bool]]'): 16 19 | pass 17 20 | 18 21 | -quote3.py:22:44: TCH002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block +quote3.py:22:44: TC002 [*] Move third-party import `django.contrib.auth.models.AbstractBaseUser` into a type-checking block | 20 | from typing import Annotated, Callable, Literal -21 | +21 | 22 | from django.contrib.auth.models import AbstractBaseUser - | ^^^^^^^^^^^^^^^^ TCH002 -23 | -24 | def test_callable_annotated_literal(callable_fn: AbstractBaseUser[Callable[[int, Annotated[str, Literal['active', "inactive"]]], bool]]): + | ^^^^^^^^^^^^^^^^ TC002 +23 | +24 | def test_callable_annotated_literal(callable_fn: AbstractBaseUser[Callable[[int, Annotated[str, Literal['active', "inactive"]]], b… | = help: Move into type-checking block @@ -85,18 +85,18 @@ quote3.py:22:44: TCH002 [*] Move third-party import `django.contrib.auth.models. 22 |- from django.contrib.auth.models import AbstractBaseUser 23 26 | 24 |- def test_callable_annotated_literal(callable_fn: AbstractBaseUser[Callable[[int, Annotated[str, Literal['active', "inactive"]]], bool]]): - 27 |+ def test_callable_annotated_literal(callable_fn: 'AbstractBaseUser[Callable[[int, Annotated[str, Literal[active, inactive]]], bool]]'): + 27 |+ def test_callable_annotated_literal(callable_fn: 'AbstractBaseUser[Callable[[int, Annotated[str, Literal["active", "inactive"]]], bool]]'): 25 28 | pass 26 29 | 27 30 | -quote3.py:31:37: TCH002 [*] Move third-party import `django.contrib.auth.models` into a type-checking block +quote3.py:31:37: TC002 [*] Move third-party import `django.contrib.auth.models` into a type-checking block | 29 | from typing import literal -30 | +30 | 31 | from django.contrib.auth import models - | ^^^^^^ TCH002 -32 | + | ^^^^^^ TC002 +32 | 33 | def test_attribute(arg: models.AbstractBaseUser["int"]): | = help: Move into type-checking block @@ -121,13 +121,13 @@ quote3.py:31:37: TCH002 [*] Move third-party import `django.contrib.auth.models` 35 38 | 36 39 | -quote3.py:40:37: TCH002 [*] Move third-party import `django.contrib.auth.models` into a type-checking block +quote3.py:40:37: TC002 [*] Move third-party import `django.contrib.auth.models` into a type-checking block | 38 | from typing import Literal -39 | +39 | 40 | from django.contrib.auth import models - | ^^^^^^ TCH002 -41 | + | ^^^^^^ TC002 +41 | 42 | def test_attribute_typing_literal(arg: models.AbstractBaseUser[Literal["admin"]]): | = help: Move into type-checking block @@ -149,4 +149,65 @@ quote3.py:40:37: TCH002 [*] Move third-party import `django.contrib.auth.models` 42 |- def test_attribute_typing_literal(arg: models.AbstractBaseUser[Literal["admin"]]): 45 |+ def test_attribute_typing_literal(arg: 'models.AbstractBaseUser[Literal["admin"]]'): 43 46 | pass -44 47 | +44 47 | +45 48 | + +quote3.py:59:29: TC002 [*] Move third-party import `third_party.Type` into a type-checking block + | +57 | def f(): +58 | from typing import Literal +59 | from third_party import Type + | ^^^^ TC002 +60 | +61 | def test_string_contains_opposite_quote(self, type1: Type[Literal["'"]], type2: Type[Literal["\'"]]): + | + = help: Move into type-checking block + +ℹ Unsafe fix + 1 |+from typing import TYPE_CHECKING + 2 |+ + 3 |+if TYPE_CHECKING: + 4 |+ from third_party import Type +1 5 | def f(): +2 6 | from typing import Literal, Union +3 7 | +-------------------------------------------------------------------------------- +56 60 | +57 61 | def f(): +58 62 | from typing import Literal +59 |- from third_party import Type +60 63 | +61 |- def test_string_contains_opposite_quote(self, type1: Type[Literal["'"]], type2: Type[Literal["\'"]]): + 64 |+ def test_string_contains_opposite_quote(self, type1: 'Type[Literal["\'"]]', type2: 'Type[Literal["\'"]]'): +62 65 | pass +63 66 | +64 67 | + +quote3.py:67:29: TC002 [*] Move third-party import `third_party.Type` into a type-checking block + | +65 | def f(): +66 | from typing import Literal +67 | from third_party import Type + | ^^^^ TC002 +68 | +69 | def test_quote_contains_backslash(self, type1: Type[Literal["\n"]], type2: Type[Literal["\""]]): + | + = help: Move into type-checking block + +ℹ Unsafe fix + 1 |+from typing import TYPE_CHECKING + 2 |+ + 3 |+if TYPE_CHECKING: + 4 |+ from third_party import Type +1 5 | def f(): +2 6 | from typing import Literal, Union +3 7 | +-------------------------------------------------------------------------------- +64 68 | +65 69 | def f(): +66 70 | from typing import Literal +67 |- from third_party import Type +68 71 | +69 |- def test_quote_contains_backslash(self, type1: Type[Literal["\n"]], type2: Type[Literal["\""]]): + 72 |+ def test_quote_contains_backslash(self, type1: 'Type[Literal["\\n"]]', type2: 'Type[Literal[\'"\']]'): +70 73 | pass diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008.py.snap new file mode 100644 index 0000000000000..626c985dbe4e9 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008.py.snap @@ -0,0 +1,420 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC008.py:15:16: TC008 [*] Remove quotes from type alias + | +13 | Bar = Foo +14 | +15 | a: TypeAlias = 'int' # TC008 + | ^^^^^ TC008 +16 | b: TypeAlias = 'Dict' # OK +17 | c: TypeAlias = 'Foo' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +12 12 | else: +13 13 | Bar = Foo +14 14 | +15 |-a: TypeAlias = 'int' # TC008 + 15 |+a: TypeAlias = int # TC008 +16 16 | b: TypeAlias = 'Dict' # OK +17 17 | c: TypeAlias = 'Foo' # TC008 +18 18 | d: TypeAlias = 'Foo[str]' # OK + +TC008.py:17:16: TC008 [*] Remove quotes from type alias + | +15 | a: TypeAlias = 'int' # TC008 +16 | b: TypeAlias = 'Dict' # OK +17 | c: TypeAlias = 'Foo' # TC008 + | ^^^^^ TC008 +18 | d: TypeAlias = 'Foo[str]' # OK +19 | e: TypeAlias = 'Foo.bar' # OK + | + = help: Remove quotes + +ℹ Safe fix +14 14 | +15 15 | a: TypeAlias = 'int' # TC008 +16 16 | b: TypeAlias = 'Dict' # OK +17 |-c: TypeAlias = 'Foo' # TC008 + 17 |+c: TypeAlias = Foo # TC008 +18 18 | d: TypeAlias = 'Foo[str]' # OK +19 19 | e: TypeAlias = 'Foo.bar' # OK +20 20 | f: TypeAlias = 'Foo | None' # TC008 + +TC008.py:20:16: TC008 [*] Remove quotes from type alias + | +18 | d: TypeAlias = 'Foo[str]' # OK +19 | e: TypeAlias = 'Foo.bar' # OK +20 | f: TypeAlias = 'Foo | None' # TC008 + | ^^^^^^^^^^^^ TC008 +21 | g: TypeAlias = 'OptStr' # OK +22 | h: TypeAlias = 'Bar' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +17 17 | c: TypeAlias = 'Foo' # TC008 +18 18 | d: TypeAlias = 'Foo[str]' # OK +19 19 | e: TypeAlias = 'Foo.bar' # OK +20 |-f: TypeAlias = 'Foo | None' # TC008 + 20 |+f: TypeAlias = Foo | None # TC008 +21 21 | g: TypeAlias = 'OptStr' # OK +22 22 | h: TypeAlias = 'Bar' # TC008 +23 23 | i: TypeAlias = Foo['str'] # TC008 + +TC008.py:22:16: TC008 [*] Remove quotes from type alias + | +20 | f: TypeAlias = 'Foo | None' # TC008 +21 | g: TypeAlias = 'OptStr' # OK +22 | h: TypeAlias = 'Bar' # TC008 + | ^^^^^ TC008 +23 | i: TypeAlias = Foo['str'] # TC008 +24 | j: TypeAlias = 'Baz' # OK + | + = help: Remove quotes + +ℹ Safe fix +19 19 | e: TypeAlias = 'Foo.bar' # OK +20 20 | f: TypeAlias = 'Foo | None' # TC008 +21 21 | g: TypeAlias = 'OptStr' # OK +22 |-h: TypeAlias = 'Bar' # TC008 + 22 |+h: TypeAlias = Bar # TC008 +23 23 | i: TypeAlias = Foo['str'] # TC008 +24 24 | j: TypeAlias = 'Baz' # OK +25 25 | k: TypeAlias = 'k | None' # OK + +TC008.py:23:20: TC008 [*] Remove quotes from type alias + | +21 | g: TypeAlias = 'OptStr' # OK +22 | h: TypeAlias = 'Bar' # TC008 +23 | i: TypeAlias = Foo['str'] # TC008 + | ^^^^^ TC008 +24 | j: TypeAlias = 'Baz' # OK +25 | k: TypeAlias = 'k | None' # OK + | + = help: Remove quotes + +ℹ Safe fix +20 20 | f: TypeAlias = 'Foo | None' # TC008 +21 21 | g: TypeAlias = 'OptStr' # OK +22 22 | h: TypeAlias = 'Bar' # TC008 +23 |-i: TypeAlias = Foo['str'] # TC008 + 23 |+i: TypeAlias = Foo[str] # TC008 +24 24 | j: TypeAlias = 'Baz' # OK +25 25 | k: TypeAlias = 'k | None' # OK +26 26 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + +TC008.py:26:16: TC008 [*] Remove quotes from type alias + | +24 | j: TypeAlias = 'Baz' # OK +25 | k: TypeAlias = 'k | None' # OK +26 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + | ^^^^^ TC008 +27 | m: TypeAlias = ('int' # TC008 +28 | | None) + | + = help: Remove quotes + +ℹ Safe fix +23 23 | i: TypeAlias = Foo['str'] # TC008 +24 24 | j: TypeAlias = 'Baz' # OK +25 25 | k: TypeAlias = 'k | None' # OK +26 |-l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + 26 |+l: TypeAlias = int | None # TC008 (because TC010 is not enabled) +27 27 | m: TypeAlias = ('int' # TC008 +28 28 | | None) +29 29 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + +TC008.py:27:17: TC008 [*] Remove quotes from type alias + | +25 | k: TypeAlias = 'k | None' # OK +26 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +27 | m: TypeAlias = ('int' # TC008 + | ^^^^^ TC008 +28 | | None) +29 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + | + = help: Remove quotes + +ℹ Safe fix +24 24 | j: TypeAlias = 'Baz' # OK +25 25 | k: TypeAlias = 'k | None' # OK +26 26 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +27 |-m: TypeAlias = ('int' # TC008 + 27 |+m: TypeAlias = (int # TC008 +28 28 | | None) +29 29 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) +30 30 | ' | None') + +TC008.py:29:17: TC008 [*] Remove quotes from type alias + | +27 | m: TypeAlias = ('int' # TC008 +28 | | None) +29 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + | _________________^ +30 | | ' | None') + | |_____________^ TC008 +31 | +32 | type B = 'Dict' # TC008 + | + = help: Remove quotes + +ℹ Unsafe fix +26 26 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +27 27 | m: TypeAlias = ('int' # TC008 +28 28 | | None) +29 |-n: TypeAlias = ('int' # TC008 (fix removes comment currently) +30 |- ' | None') + 29 |+n: TypeAlias = (int | None) +31 30 | +32 31 | type B = 'Dict' # TC008 +33 32 | type D = 'Foo[str]' # TC008 + +TC008.py:32:10: TC008 [*] Remove quotes from type alias + | +30 | ' | None') +31 | +32 | type B = 'Dict' # TC008 + | ^^^^^^ TC008 +33 | type D = 'Foo[str]' # TC008 +34 | type E = 'Foo.bar' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +29 29 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) +30 30 | ' | None') +31 31 | +32 |-type B = 'Dict' # TC008 + 32 |+type B = Dict # TC008 +33 33 | type D = 'Foo[str]' # TC008 +34 34 | type E = 'Foo.bar' # TC008 +35 35 | type G = 'OptStr' # TC008 + +TC008.py:33:10: TC008 [*] Remove quotes from type alias + | +32 | type B = 'Dict' # TC008 +33 | type D = 'Foo[str]' # TC008 + | ^^^^^^^^^^ TC008 +34 | type E = 'Foo.bar' # TC008 +35 | type G = 'OptStr' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +30 30 | ' | None') +31 31 | +32 32 | type B = 'Dict' # TC008 +33 |-type D = 'Foo[str]' # TC008 + 33 |+type D = Foo[str] # TC008 +34 34 | type E = 'Foo.bar' # TC008 +35 35 | type G = 'OptStr' # TC008 +36 36 | type I = Foo['str'] # TC008 + +TC008.py:34:10: TC008 [*] Remove quotes from type alias + | +32 | type B = 'Dict' # TC008 +33 | type D = 'Foo[str]' # TC008 +34 | type E = 'Foo.bar' # TC008 + | ^^^^^^^^^ TC008 +35 | type G = 'OptStr' # TC008 +36 | type I = Foo['str'] # TC008 + | + = help: Remove quotes + +ℹ Safe fix +31 31 | +32 32 | type B = 'Dict' # TC008 +33 33 | type D = 'Foo[str]' # TC008 +34 |-type E = 'Foo.bar' # TC008 + 34 |+type E = Foo.bar # TC008 +35 35 | type G = 'OptStr' # TC008 +36 36 | type I = Foo['str'] # TC008 +37 37 | type J = 'Baz' # TC008 + +TC008.py:35:10: TC008 [*] Remove quotes from type alias + | +33 | type D = 'Foo[str]' # TC008 +34 | type E = 'Foo.bar' # TC008 +35 | type G = 'OptStr' # TC008 + | ^^^^^^^^ TC008 +36 | type I = Foo['str'] # TC008 +37 | type J = 'Baz' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +32 32 | type B = 'Dict' # TC008 +33 33 | type D = 'Foo[str]' # TC008 +34 34 | type E = 'Foo.bar' # TC008 +35 |-type G = 'OptStr' # TC008 + 35 |+type G = OptStr # TC008 +36 36 | type I = Foo['str'] # TC008 +37 37 | type J = 'Baz' # TC008 +38 38 | type K = 'K | None' # TC008 + +TC008.py:36:14: TC008 [*] Remove quotes from type alias + | +34 | type E = 'Foo.bar' # TC008 +35 | type G = 'OptStr' # TC008 +36 | type I = Foo['str'] # TC008 + | ^^^^^ TC008 +37 | type J = 'Baz' # TC008 +38 | type K = 'K | None' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +33 33 | type D = 'Foo[str]' # TC008 +34 34 | type E = 'Foo.bar' # TC008 +35 35 | type G = 'OptStr' # TC008 +36 |-type I = Foo['str'] # TC008 + 36 |+type I = Foo[str] # TC008 +37 37 | type J = 'Baz' # TC008 +38 38 | type K = 'K | None' # TC008 +39 39 | type L = 'int' | None # TC008 (because TC010 is not enabled) + +TC008.py:37:10: TC008 [*] Remove quotes from type alias + | +35 | type G = 'OptStr' # TC008 +36 | type I = Foo['str'] # TC008 +37 | type J = 'Baz' # TC008 + | ^^^^^ TC008 +38 | type K = 'K | None' # TC008 +39 | type L = 'int' | None # TC008 (because TC010 is not enabled) + | + = help: Remove quotes + +ℹ Safe fix +34 34 | type E = 'Foo.bar' # TC008 +35 35 | type G = 'OptStr' # TC008 +36 36 | type I = Foo['str'] # TC008 +37 |-type J = 'Baz' # TC008 + 37 |+type J = Baz # TC008 +38 38 | type K = 'K | None' # TC008 +39 39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 40 | type M = ('int' # TC008 + +TC008.py:38:10: TC008 [*] Remove quotes from type alias + | +36 | type I = Foo['str'] # TC008 +37 | type J = 'Baz' # TC008 +38 | type K = 'K | None' # TC008 + | ^^^^^^^^^^ TC008 +39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 | type M = ('int' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +35 35 | type G = 'OptStr' # TC008 +36 36 | type I = Foo['str'] # TC008 +37 37 | type J = 'Baz' # TC008 +38 |-type K = 'K | None' # TC008 + 38 |+type K = K | None # TC008 +39 39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 40 | type M = ('int' # TC008 +41 41 | | None) + +TC008.py:39:10: TC008 [*] Remove quotes from type alias + | +37 | type J = 'Baz' # TC008 +38 | type K = 'K | None' # TC008 +39 | type L = 'int' | None # TC008 (because TC010 is not enabled) + | ^^^^^ TC008 +40 | type M = ('int' # TC008 +41 | | None) + | + = help: Remove quotes + +ℹ Safe fix +36 36 | type I = Foo['str'] # TC008 +37 37 | type J = 'Baz' # TC008 +38 38 | type K = 'K | None' # TC008 +39 |-type L = 'int' | None # TC008 (because TC010 is not enabled) + 39 |+type L = int | None # TC008 (because TC010 is not enabled) +40 40 | type M = ('int' # TC008 +41 41 | | None) +42 42 | type N = ('int' # TC008 (fix removes comment currently) + +TC008.py:40:11: TC008 [*] Remove quotes from type alias + | +38 | type K = 'K | None' # TC008 +39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 | type M = ('int' # TC008 + | ^^^^^ TC008 +41 | | None) +42 | type N = ('int' # TC008 (fix removes comment currently) + | + = help: Remove quotes + +ℹ Safe fix +37 37 | type J = 'Baz' # TC008 +38 38 | type K = 'K | None' # TC008 +39 39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 |-type M = ('int' # TC008 + 40 |+type M = (int # TC008 +41 41 | | None) +42 42 | type N = ('int' # TC008 (fix removes comment currently) +43 43 | ' | None') + +TC008.py:42:11: TC008 [*] Remove quotes from type alias + | +40 | type M = ('int' # TC008 +41 | | None) +42 | type N = ('int' # TC008 (fix removes comment currently) + | ___________^ +43 | | ' | None') + | |_____________^ TC008 + | + = help: Remove quotes + +ℹ Unsafe fix +39 39 | type L = 'int' | None # TC008 (because TC010 is not enabled) +40 40 | type M = ('int' # TC008 +41 41 | | None) +42 |-type N = ('int' # TC008 (fix removes comment currently) +43 |- ' | None') + 42 |+type N = (int | None) +44 43 | +45 44 | +46 45 | class Baz: + +TC008.py:48:14: TC008 [*] Remove quotes from type alias + | +46 | class Baz: +47 | a: TypeAlias = 'Baz' # OK +48 | type A = 'Baz' # TC008 + | ^^^^^ TC008 +49 | +50 | class Nested: + | + = help: Remove quotes + +ℹ Safe fix +45 45 | +46 46 | class Baz: +47 47 | a: TypeAlias = 'Baz' # OK +48 |- type A = 'Baz' # TC008 + 48 |+ type A = Baz # TC008 +49 49 | +50 50 | class Nested: +51 51 | a: TypeAlias = 'Baz' # OK + +TC008.py:52:18: TC008 [*] Remove quotes from type alias + | +50 | class Nested: +51 | a: TypeAlias = 'Baz' # OK +52 | type A = 'Baz' # TC008 + | ^^^^^ TC008 + | + = help: Remove quotes + +ℹ Safe fix +49 49 | +50 50 | class Nested: +51 51 | a: TypeAlias = 'Baz' # OK +52 |- type A = 'Baz' # TC008 + 52 |+ type A = Baz # TC008 diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008_typing_execution_context.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008_typing_execution_context.py.snap new file mode 100644 index 0000000000000..c3b71b50dea6b --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__quoted-type-alias_TC008_typing_execution_context.py.snap @@ -0,0 +1,254 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC008_typing_execution_context.py:13:20: TC008 [*] Remove quotes from type alias + | +11 | Bar: TypeAlias = Foo[int] +12 | +13 | a: TypeAlias = 'int' # TC008 + | ^^^^^ TC008 +14 | b: TypeAlias = 'Dict' # TC008 +15 | c: TypeAlias = 'Foo' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +10 10 | OptStr: TypeAlias = str | None +11 11 | Bar: TypeAlias = Foo[int] +12 12 | +13 |- a: TypeAlias = 'int' # TC008 + 13 |+ a: TypeAlias = int # TC008 +14 14 | b: TypeAlias = 'Dict' # TC008 +15 15 | c: TypeAlias = 'Foo' # TC008 +16 16 | d: TypeAlias = 'Foo[str]' # TC008 + +TC008_typing_execution_context.py:14:20: TC008 [*] Remove quotes from type alias + | +13 | a: TypeAlias = 'int' # TC008 +14 | b: TypeAlias = 'Dict' # TC008 + | ^^^^^^ TC008 +15 | c: TypeAlias = 'Foo' # TC008 +16 | d: TypeAlias = 'Foo[str]' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +11 11 | Bar: TypeAlias = Foo[int] +12 12 | +13 13 | a: TypeAlias = 'int' # TC008 +14 |- b: TypeAlias = 'Dict' # TC008 + 14 |+ b: TypeAlias = Dict # TC008 +15 15 | c: TypeAlias = 'Foo' # TC008 +16 16 | d: TypeAlias = 'Foo[str]' # TC008 +17 17 | e: TypeAlias = 'Foo.bar' # TC008 + +TC008_typing_execution_context.py:15:20: TC008 [*] Remove quotes from type alias + | +13 | a: TypeAlias = 'int' # TC008 +14 | b: TypeAlias = 'Dict' # TC008 +15 | c: TypeAlias = 'Foo' # TC008 + | ^^^^^ TC008 +16 | d: TypeAlias = 'Foo[str]' # TC008 +17 | e: TypeAlias = 'Foo.bar' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +12 12 | +13 13 | a: TypeAlias = 'int' # TC008 +14 14 | b: TypeAlias = 'Dict' # TC008 +15 |- c: TypeAlias = 'Foo' # TC008 + 15 |+ c: TypeAlias = Foo # TC008 +16 16 | d: TypeAlias = 'Foo[str]' # TC008 +17 17 | e: TypeAlias = 'Foo.bar' # TC008 +18 18 | f: TypeAlias = 'Foo | None' # TC008 + +TC008_typing_execution_context.py:16:20: TC008 [*] Remove quotes from type alias + | +14 | b: TypeAlias = 'Dict' # TC008 +15 | c: TypeAlias = 'Foo' # TC008 +16 | d: TypeAlias = 'Foo[str]' # TC008 + | ^^^^^^^^^^ TC008 +17 | e: TypeAlias = 'Foo.bar' # TC008 +18 | f: TypeAlias = 'Foo | None' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +13 13 | a: TypeAlias = 'int' # TC008 +14 14 | b: TypeAlias = 'Dict' # TC008 +15 15 | c: TypeAlias = 'Foo' # TC008 +16 |- d: TypeAlias = 'Foo[str]' # TC008 + 16 |+ d: TypeAlias = Foo[str] # TC008 +17 17 | e: TypeAlias = 'Foo.bar' # TC008 +18 18 | f: TypeAlias = 'Foo | None' # TC008 +19 19 | g: TypeAlias = 'OptStr' # TC008 + +TC008_typing_execution_context.py:17:20: TC008 [*] Remove quotes from type alias + | +15 | c: TypeAlias = 'Foo' # TC008 +16 | d: TypeAlias = 'Foo[str]' # TC008 +17 | e: TypeAlias = 'Foo.bar' # TC008 + | ^^^^^^^^^ TC008 +18 | f: TypeAlias = 'Foo | None' # TC008 +19 | g: TypeAlias = 'OptStr' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +14 14 | b: TypeAlias = 'Dict' # TC008 +15 15 | c: TypeAlias = 'Foo' # TC008 +16 16 | d: TypeAlias = 'Foo[str]' # TC008 +17 |- e: TypeAlias = 'Foo.bar' # TC008 + 17 |+ e: TypeAlias = Foo.bar # TC008 +18 18 | f: TypeAlias = 'Foo | None' # TC008 +19 19 | g: TypeAlias = 'OptStr' # TC008 +20 20 | h: TypeAlias = 'Bar' # TC008 + +TC008_typing_execution_context.py:18:20: TC008 [*] Remove quotes from type alias + | +16 | d: TypeAlias = 'Foo[str]' # TC008 +17 | e: TypeAlias = 'Foo.bar' # TC008 +18 | f: TypeAlias = 'Foo | None' # TC008 + | ^^^^^^^^^^^^ TC008 +19 | g: TypeAlias = 'OptStr' # TC008 +20 | h: TypeAlias = 'Bar' # TC008 + | + = help: Remove quotes + +ℹ Safe fix +15 15 | c: TypeAlias = 'Foo' # TC008 +16 16 | d: TypeAlias = 'Foo[str]' # TC008 +17 17 | e: TypeAlias = 'Foo.bar' # TC008 +18 |- f: TypeAlias = 'Foo | None' # TC008 + 18 |+ f: TypeAlias = Foo | None # TC008 +19 19 | g: TypeAlias = 'OptStr' # TC008 +20 20 | h: TypeAlias = 'Bar' # TC008 +21 21 | i: TypeAlias = Foo['str'] # TC008 + +TC008_typing_execution_context.py:19:20: TC008 [*] Remove quotes from type alias + | +17 | e: TypeAlias = 'Foo.bar' # TC008 +18 | f: TypeAlias = 'Foo | None' # TC008 +19 | g: TypeAlias = 'OptStr' # TC008 + | ^^^^^^^^ TC008 +20 | h: TypeAlias = 'Bar' # TC008 +21 | i: TypeAlias = Foo['str'] # TC008 + | + = help: Remove quotes + +ℹ Safe fix +16 16 | d: TypeAlias = 'Foo[str]' # TC008 +17 17 | e: TypeAlias = 'Foo.bar' # TC008 +18 18 | f: TypeAlias = 'Foo | None' # TC008 +19 |- g: TypeAlias = 'OptStr' # TC008 + 19 |+ g: TypeAlias = OptStr # TC008 +20 20 | h: TypeAlias = 'Bar' # TC008 +21 21 | i: TypeAlias = Foo['str'] # TC008 +22 22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) + +TC008_typing_execution_context.py:20:20: TC008 [*] Remove quotes from type alias + | +18 | f: TypeAlias = 'Foo | None' # TC008 +19 | g: TypeAlias = 'OptStr' # TC008 +20 | h: TypeAlias = 'Bar' # TC008 + | ^^^^^ TC008 +21 | i: TypeAlias = Foo['str'] # TC008 +22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) + | + = help: Remove quotes + +ℹ Safe fix +17 17 | e: TypeAlias = 'Foo.bar' # TC008 +18 18 | f: TypeAlias = 'Foo | None' # TC008 +19 19 | g: TypeAlias = 'OptStr' # TC008 +20 |- h: TypeAlias = 'Bar' # TC008 + 20 |+ h: TypeAlias = Bar # TC008 +21 21 | i: TypeAlias = Foo['str'] # TC008 +22 22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 23 | k: TypeAlias = 'k | None' # False negative in type checking block + +TC008_typing_execution_context.py:21:24: TC008 [*] Remove quotes from type alias + | +19 | g: TypeAlias = 'OptStr' # TC008 +20 | h: TypeAlias = 'Bar' # TC008 +21 | i: TypeAlias = Foo['str'] # TC008 + | ^^^^^ TC008 +22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 | k: TypeAlias = 'k | None' # False negative in type checking block + | + = help: Remove quotes + +ℹ Safe fix +18 18 | f: TypeAlias = 'Foo | None' # TC008 +19 19 | g: TypeAlias = 'OptStr' # TC008 +20 20 | h: TypeAlias = 'Bar' # TC008 +21 |- i: TypeAlias = Foo['str'] # TC008 + 21 |+ i: TypeAlias = Foo[str] # TC008 +22 22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 23 | k: TypeAlias = 'k | None' # False negative in type checking block +24 24 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + +TC008_typing_execution_context.py:24:20: TC008 [*] Remove quotes from type alias + | +22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 | k: TypeAlias = 'k | None' # False negative in type checking block +24 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + | ^^^^^ TC008 +25 | m: TypeAlias = ('int' # TC008 +26 | | None) + | + = help: Remove quotes + +ℹ Safe fix +21 21 | i: TypeAlias = Foo['str'] # TC008 +22 22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 23 | k: TypeAlias = 'k | None' # False negative in type checking block +24 |- l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) + 24 |+ l: TypeAlias = int | None # TC008 (because TC010 is not enabled) +25 25 | m: TypeAlias = ('int' # TC008 +26 26 | | None) +27 27 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + +TC008_typing_execution_context.py:25:21: TC008 [*] Remove quotes from type alias + | +23 | k: TypeAlias = 'k | None' # False negative in type checking block +24 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +25 | m: TypeAlias = ('int' # TC008 + | ^^^^^ TC008 +26 | | None) +27 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + | + = help: Remove quotes + +ℹ Safe fix +22 22 | j: TypeAlias = 'Baz' # OK (this would be treated as use before define) +23 23 | k: TypeAlias = 'k | None' # False negative in type checking block +24 24 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +25 |- m: TypeAlias = ('int' # TC008 + 25 |+ m: TypeAlias = (int # TC008 +26 26 | | None) +27 27 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) +28 28 | ' | None') + +TC008_typing_execution_context.py:27:21: TC008 [*] Remove quotes from type alias + | +25 | m: TypeAlias = ('int' # TC008 +26 | | None) +27 | n: TypeAlias = ('int' # TC008 (fix removes comment currently) + | _____________________^ +28 | | ' | None') + | |_________________^ TC008 + | + = help: Remove quotes + +ℹ Unsafe fix +24 24 | l: TypeAlias = 'int' | None # TC008 (because TC010 is not enabled) +25 25 | m: TypeAlias = ('int' # TC008 +26 26 | | None) +27 |- n: TypeAlias = ('int' # TC008 (fix removes comment currently) +28 |- ' | None') + 27 |+ n: TypeAlias = (int | None) +29 28 | +30 29 | +31 30 | class Baz: ... diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-cast-value_TC006.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-cast-value_TC006.py.snap new file mode 100644 index 0000000000000..f117c364f7eb5 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-cast-value_TC006.py.snap @@ -0,0 +1,248 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC006.py:4:10: TC006 [*] Add quotes to type expression in `typing.cast()` + | +2 | from typing import cast +3 | +4 | cast(int, 3.0) # TC006 + | ^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +1 1 | def f(): +2 2 | from typing import cast +3 3 | +4 |- cast(int, 3.0) # TC006 + 4 |+ cast("int", 3.0) # TC006 +5 5 | +6 6 | +7 7 | def f(): + +TC006.py:10:10: TC006 [*] Add quotes to type expression in `typing.cast()` + | + 8 | from typing import cast + 9 | +10 | cast(list[tuple[bool | float | int | str]], 3.0) # TC006 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +7 7 | def f(): +8 8 | from typing import cast +9 9 | +10 |- cast(list[tuple[bool | float | int | str]], 3.0) # TC006 + 10 |+ cast("list[tuple[bool | float | int | str]]", 3.0) # TC006 +11 11 | +12 12 | +13 13 | def f(): + +TC006.py:16:10: TC006 [*] Add quotes to type expression in `typing.cast()` + | +14 | from typing import Union, cast +15 | +16 | cast(list[tuple[Union[bool, float, int, str]]], 3.0) # TC006 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +13 13 | def f(): +14 14 | from typing import Union, cast +15 15 | +16 |- cast(list[tuple[Union[bool, float, int, str]]], 3.0) # TC006 + 16 |+ cast("list[tuple[Union[bool, float, int, str]]]", 3.0) # TC006 +17 17 | +18 18 | +19 19 | def f(): + +TC006.py:40:14: TC006 [*] Add quotes to type expression in `typing.cast()` + | +38 | from typing import cast as typecast +39 | +40 | typecast(int, 3.0) # TC006 + | ^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +37 37 | def f(): +38 38 | from typing import cast as typecast +39 39 | +40 |- typecast(int, 3.0) # TC006 + 40 |+ typecast("int", 3.0) # TC006 +41 41 | +42 42 | +43 43 | def f(): + +TC006.py:46:17: TC006 [*] Add quotes to type expression in `typing.cast()` + | +44 | import typing +45 | +46 | typing.cast(int, 3.0) # TC006 + | ^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +43 43 | def f(): +44 44 | import typing +45 45 | +46 |- typing.cast(int, 3.0) # TC006 + 46 |+ typing.cast("int", 3.0) # TC006 +47 47 | +48 48 | +49 49 | def f(): + +TC006.py:52:12: TC006 [*] Add quotes to type expression in `typing.cast()` + | +50 | import typing as t +51 | +52 | t.cast(t.Literal["3.0", '3'], 3.0) # TC006 + | ^^^^^^^^^^^^^^^^^^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +49 49 | def f(): +50 50 | import typing as t +51 51 | +52 |- t.cast(t.Literal["3.0", '3'], 3.0) # TC006 + 52 |+ t.cast("t.Literal['3.0', '3']", 3.0) # TC006 +53 53 | +54 54 | +55 55 | def f(): + +TC006.py:59:9: TC006 [*] Add quotes to type expression in `typing.cast()` + | +58 | cast( +59 | / int # TC006 (unsafe, because it will get rid of this comment) +60 | | | None, + | |______________^ TC006 +61 | 3.0 +62 | ) + | + = help: Add quotes + +ℹ Unsafe fix +56 56 | from typing import cast +57 57 | +58 58 | cast( +59 |- int # TC006 (unsafe, because it will get rid of this comment) +60 |- | None, + 59 |+ "int | None", +61 60 | 3.0 +62 61 | ) +63 62 | + +TC006.py:68:17: TC006 [*] Add quotes to type expression in `typing.cast()` + | +66 | # Regression test for #14554 +67 | import typing +68 | typing.cast(M-()) + | ^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +65 65 | def f(): +66 66 | # Regression test for #14554 +67 67 | import typing +68 |- typing.cast(M-()) + 68 |+ typing.cast("M - ()") +69 69 | +70 70 | +71 71 | def f(): + +TC006.py:75:10: TC006 [*] Add quotes to type expression in `typing.cast()` + | +73 | from typing import cast, Literal +74 | +75 | cast(Literal["A"], 'A') + | ^^^^^^^^^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +72 72 | # Simple case with Literal that should lead to nested quotes +73 73 | from typing import cast, Literal +74 74 | +75 |- cast(Literal["A"], 'A') + 75 |+ cast("Literal['A']", 'A') +76 76 | +77 77 | +78 78 | def f(): + +TC006.py:82:10: TC006 [*] Add quotes to type expression in `typing.cast()` + | +80 | from typing import cast, Annotated, Literal +81 | +82 | cast(list[Annotated["list['Literal[\"A\"]']", "Foo"]], ['A']) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +79 79 | # Really complex case with nested forward references +80 80 | from typing import cast, Annotated, Literal +81 81 | +82 |- cast(list[Annotated["list['Literal[\"A\"]']", "Foo"]], ['A']) + 82 |+ cast("list[Annotated[list[Literal['A']], 'Foo']]", ['A']) +83 83 | +84 84 | +85 85 | def f(): + +TC006.py:89:9: TC006 [*] Add quotes to type expression in `typing.cast()` + | +88 | cast( +89 | int # TC006 + | ^^^ TC006 +90 | , 6.0 +91 | ) + | + = help: Add quotes + +ℹ Safe fix +86 86 | from typing import cast +87 87 | +88 88 | cast( +89 |- int # TC006 + 89 |+ "int" # TC006 +90 90 | , 6.0 +91 91 | ) +92 92 | + +TC006.py:98:14: TC006 [*] Add quotes to type expression in `typing.cast()` + | +96 | from typing import cast +97 | +98 | cast(typ=int, val=3.0) # TC006 + | ^^^ TC006 +99 | cast(val=3.0, typ=int) # TC006 + | + = help: Add quotes + +ℹ Safe fix +95 95 | # Keyword arguments +96 96 | from typing import cast +97 97 | +98 |- cast(typ=int, val=3.0) # TC006 + 98 |+ cast(typ="int", val=3.0) # TC006 +99 99 | cast(val=3.0, typ=int) # TC006 + +TC006.py:99:23: TC006 [*] Add quotes to type expression in `typing.cast()` + | +98 | cast(typ=int, val=3.0) # TC006 +99 | cast(val=3.0, typ=int) # TC006 + | ^^^ TC006 + | + = help: Add quotes + +ℹ Safe fix +96 96 | from typing import cast +97 97 | +98 98 | cast(typ=int, val=3.0) # TC006 +99 |- cast(val=3.0, typ=int) # TC006 + 99 |+ cast(val=3.0, typ="int") # TC006 diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_1.py.snap new file mode 100644 index 0000000000000..9b4d1f4a7634c --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_1.py.snap @@ -0,0 +1,21 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- +TC004_1.py:4:26: TC004 [*] Move import `datetime.datetime` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from datetime import datetime + | ^^^^^^^^ TC004 +5 | x = datetime + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from datetime import datetime +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from datetime import datetime + 5 |+ pass +5 6 | x = datetime diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_10.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_10.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_10.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_11.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_11.py.snap new file mode 100644 index 0000000000000..b9858550b26a7 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_11.py.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC004_11.py:4:24: TC004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import List + | ^^^^ TC004 +5 | +6 | __all__ = ("List",) + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import List +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import List + 5 |+ pass +5 6 | +6 7 | __all__ = ("List",) diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_12.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_12.py.snap new file mode 100644 index 0000000000000..52ee66998cdd1 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_12.py.snap @@ -0,0 +1,24 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC004_12.py:6:33: TC004 [*] Move import `collections.abc.Callable` out of type-checking block. Import is used for more than type hinting. + | +5 | if TYPE_CHECKING: +6 | from collections.abc import Callable + | ^^^^^^^^ TC004 +7 | +8 | AnyCallable: TypeAlias = Callable[..., Any] + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from __future__ import annotations +2 2 | +3 3 | from typing import Any, TYPE_CHECKING, TypeAlias + 4 |+from collections.abc import Callable +4 5 | +5 6 | if TYPE_CHECKING: +6 |- from collections.abc import Callable + 7 |+ pass +7 8 | +8 9 | AnyCallable: TypeAlias = Callable[..., Any] diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_13.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_13.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_13.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_14.pyi.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_14.pyi.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_14.pyi.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_15.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_15.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_15.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_16.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_16.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_16.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_17.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_17.py.snap new file mode 100644 index 0000000000000..1dd9c839b7d4d --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_17.py.snap @@ -0,0 +1,24 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- +TC004_17.py:6:24: TC004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. + | +5 | if TYPE_CHECKING: +6 | from pandas import DataFrame + | ^^^^^^^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from __future__ import annotations +2 2 | +3 3 | from typing_extensions import TYPE_CHECKING + 4 |+from pandas import DataFrame +4 5 | +5 6 | if TYPE_CHECKING: +6 |- from pandas import DataFrame + 7 |+ pass +7 8 | +8 9 | +9 10 | def example() -> DataFrame: diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_2.py.snap new file mode 100644 index 0000000000000..135189e40d776 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_2.py.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- +TC004_2.py:4:26: TC004 [*] Move import `datetime.date` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from datetime import date + | ^^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from datetime import date +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from datetime import date + 5 |+ pass +5 6 | +6 7 | +7 8 | def example(): diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_3.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_3.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_4.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_4.py.snap new file mode 100644 index 0000000000000..7dfef5f3eb92a --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_4.py.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- +TC004_4.py:4:24: TC004 [*] Move import `typing.Any` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import Any + | ^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING, Type + 2 |+from typing import Any +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import Any + 5 |+ pass +5 6 | +6 7 | +7 8 | def example(*args: Any, **kwargs: Any): diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_5.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_5.py.snap new file mode 100644 index 0000000000000..39efab2ee5b3a --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_5.py.snap @@ -0,0 +1,60 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- +TC004_5.py:4:24: TC004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import List, Sequence, Set + | ^^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import List, Sequence, Set +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import List, Sequence, Set + 5 |+ pass +5 6 | +6 7 | +7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): + +TC004_5.py:4:30: TC004 [*] Move import `typing.Sequence` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import List, Sequence, Set + | ^^^^^^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import List, Sequence, Set +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import List, Sequence, Set + 5 |+ pass +5 6 | +6 7 | +7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): + +TC004_5.py:4:40: TC004 [*] Move import `typing.Set` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import List, Sequence, Set + | ^^^ TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import List, Sequence, Set +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import List, Sequence, Set + 5 |+ pass +5 6 | +6 7 | +7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_6.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_6.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_6.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_7.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_7.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_7.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_8.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_8.py.snap new file mode 100644 index 0000000000000..173cb5a2d6539 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_8.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_9.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_9.py.snap new file mode 100644 index 0000000000000..29514c37a1e78 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TC004_9.py.snap @@ -0,0 +1,44 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC004_9.py:4:24: TC004 [*] Move import `typing.Tuple` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import Tuple, List, Dict + | ^^^^^ TC004 +5 | +6 | x: Tuple + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import Tuple, List +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import Tuple, List, Dict + 5 |+ from typing import Dict +5 6 | +6 7 | x: Tuple +7 8 | + +TC004_9.py:4:31: TC004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. + | +3 | if TYPE_CHECKING: +4 | from typing import Tuple, List, Dict + | ^^^^ TC004 +5 | +6 | x: Tuple + | + = help: Move out of type-checking block + +ℹ Unsafe fix +1 1 | from typing import TYPE_CHECKING + 2 |+from typing import Tuple, List +2 3 | +3 4 | if TYPE_CHECKING: +4 |- from typing import Tuple, List, Dict + 5 |+ from typing import Dict +5 6 | +6 7 | x: Tuple +7 8 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_1.py.snap deleted file mode 100644 index b11905593b5aa..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_1.py.snap +++ /dev/null @@ -1,22 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_1.py:4:26: TCH004 [*] Move import `datetime.datetime` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from datetime import datetime - | ^^^^^^^^ TCH004 -5 | x = datetime - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from datetime import datetime -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from datetime import datetime - 5 |+ pass -5 6 | x = datetime - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_11.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_11.py.snap deleted file mode 100644 index 1c4e1df589f8c..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_11.py.snap +++ /dev/null @@ -1,24 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_11.py:4:24: TCH004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import List - | ^^^^ TCH004 -5 | -6 | __all__ = ("List",) - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import List -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import List - 5 |+ pass -5 6 | -6 7 | __all__ = ("List",) - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_12.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_12.py.snap deleted file mode 100644 index 8efe1fd384ac0..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_12.py.snap +++ /dev/null @@ -1,26 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_12.py:6:33: TCH004 [*] Move import `collections.abc.Callable` out of type-checking block. Import is used for more than type hinting. - | -5 | if TYPE_CHECKING: -6 | from collections.abc import Callable - | ^^^^^^^^ TCH004 -7 | -8 | AnyCallable: TypeAlias = Callable[..., Any] - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from __future__ import annotations -2 2 | -3 3 | from typing import Any, TYPE_CHECKING, TypeAlias - 4 |+from collections.abc import Callable -4 5 | -5 6 | if TYPE_CHECKING: -6 |- from collections.abc import Callable - 7 |+ pass -7 8 | -8 9 | AnyCallable: TypeAlias = Callable[..., Any] - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_15.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_15.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_15.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_16.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_16.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_16.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_17.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_17.py.snap deleted file mode 100644 index 785c4c1d2e6c4..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_17.py.snap +++ /dev/null @@ -1,25 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_17.py:6:24: TCH004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. - | -5 | if TYPE_CHECKING: -6 | from pandas import DataFrame - | ^^^^^^^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from __future__ import annotations -2 2 | -3 3 | from typing_extensions import TYPE_CHECKING - 4 |+from pandas import DataFrame -4 5 | -5 6 | if TYPE_CHECKING: -6 |- from pandas import DataFrame - 7 |+ pass -7 8 | -8 9 | -9 10 | def example() -> DataFrame: - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_2.py.snap deleted file mode 100644 index 7e49226762c46..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_2.py.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_2.py:4:26: TCH004 [*] Move import `datetime.date` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from datetime import date - | ^^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from datetime import date -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from datetime import date - 5 |+ pass -5 6 | -6 7 | -7 8 | def example(): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_3.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_3.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_4.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_4.py.snap deleted file mode 100644 index aa464d7840a11..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_4.py.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_4.py:4:24: TCH004 [*] Move import `typing.Any` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import Any - | ^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING, Type - 2 |+from typing import Any -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import Any - 5 |+ pass -5 6 | -6 7 | -7 8 | def example(*args: Any, **kwargs: Any): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_5.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_5.py.snap deleted file mode 100644 index ff1e64f7b5304..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_5.py.snap +++ /dev/null @@ -1,61 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_5.py:4:24: TCH004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import List, Sequence, Set - | ^^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import List, Sequence, Set -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import List, Sequence, Set - 5 |+ pass -5 6 | -6 7 | -7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): - -TCH004_5.py:4:30: TCH004 [*] Move import `typing.Sequence` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import List, Sequence, Set - | ^^^^^^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import List, Sequence, Set -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import List, Sequence, Set - 5 |+ pass -5 6 | -6 7 | -7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): - -TCH004_5.py:4:40: TCH004 [*] Move import `typing.Set` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import List, Sequence, Set - | ^^^ TCH004 - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import List, Sequence, Set -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import List, Sequence, Set - 5 |+ pass -5 6 | -6 7 | -7 8 | def example(a: List[int], /, b: Sequence[int], *, c: Set[int]): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_6.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_6.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_6.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_7.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_7.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_7.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_8.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_8.py.snap deleted file mode 100644 index 6c5ead27428ce..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_8.py.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_9.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_9.py.snap deleted file mode 100644 index 0c30f3a80053d..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_9.py.snap +++ /dev/null @@ -1,46 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH004_9.py:4:24: TCH004 [*] Move import `typing.Tuple` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import Tuple, List, Dict - | ^^^^^ TCH004 -5 | -6 | x: Tuple - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import Tuple, List -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import Tuple, List, Dict - 5 |+ from typing import Dict -5 6 | -6 7 | x: Tuple -7 8 | - -TCH004_9.py:4:31: TCH004 [*] Move import `typing.List` out of type-checking block. Import is used for more than type hinting. - | -3 | if TYPE_CHECKING: -4 | from typing import Tuple, List, Dict - | ^^^^ TCH004 -5 | -6 | x: Tuple - | - = help: Move out of type-checking block - -ℹ Unsafe fix -1 1 | from typing import TYPE_CHECKING - 2 |+from typing import Tuple, List -2 3 | -3 4 | if TYPE_CHECKING: -4 |- from typing import Tuple, List, Dict - 5 |+ from typing import Dict -5 6 | -6 7 | x: Tuple -7 8 | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_module__app.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_module__app.py.snap new file mode 100644 index 0000000000000..436e35992ba77 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_module__app.py.snap @@ -0,0 +1,47 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +app.py:9:12: TC004 [*] Move import `datetime` out of type-checking block. Import is used for more than type hinting. + | + 8 | if TYPE_CHECKING: + 9 | import datetime # TC004 + | ^^^^^^^^ TC004 +10 | from array import array # TC004 + | + = help: Move out of type-checking block + +ℹ Unsafe fix +4 4 | +5 5 | import fastapi +6 6 | from fastapi import FastAPI as Api + 7 |+import datetime +7 8 | +8 9 | if TYPE_CHECKING: +9 |- import datetime # TC004 +10 10 | from array import array # TC004 +11 11 | +12 12 | app = fastapi.FastAPI("First application") + +app.py:10:23: TC004 [*] Move import `array.array` out of type-checking block. Import is used for more than type hinting. + | + 8 | if TYPE_CHECKING: + 9 | import datetime # TC004 +10 | from array import array # TC004 + | ^^^^^ TC004 +11 | +12 | app = fastapi.FastAPI("First application") + | + = help: Move out of type-checking block + +ℹ Unsafe fix +4 4 | +5 5 | import fastapi +6 6 | from fastapi import FastAPI as Api + 7 |+from array import array +7 8 | +8 9 | if TYPE_CHECKING: +9 10 | import datetime # TC004 +10 |- from array import array # TC004 +11 11 | +12 12 | app = fastapi.FastAPI("First application") +13 13 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_quote.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_quote.py.snap index cc6b8d74f43b5..dbb418b692ac7 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_quote.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_quote.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -quote.py:57:28: TCH004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. +quote.py:57:28: TC004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. | 56 | if TYPE_CHECKING: 57 | from pandas import DataFrame - | ^^^^^^^^^ TCH004 -58 | + | ^^^^^^^^^ TC004 +58 | 59 | def func(value: DataFrame): | = help: Move out of type-checking block @@ -25,3 +25,27 @@ quote.py:57:28: TCH004 [*] Move import `pandas.DataFrame` out of type-checking b 58 59 | 59 60 | def func(value: DataFrame): 60 61 | ... + +quote.py:110:28: TC004 [*] Move import `pandas.DataFrame` out of type-checking block. Import is used for more than type hinting. + | +109 | if TYPE_CHECKING: +110 | from pandas import DataFrame + | ^^^^^^^^^ TC004 +111 | +112 | x: TypeAlias = DataFrame | None + | + = help: Move out of type-checking block + +ℹ Unsafe fix + 1 |+from pandas import DataFrame +1 2 | def f(): +2 3 | from pandas import DataFrame +3 4 | +-------------------------------------------------------------------------------- +107 108 | from typing import TypeAlias, TYPE_CHECKING +108 109 | +109 110 | if TYPE_CHECKING: +110 |- from pandas import DataFrame + 111 |+ pass +111 112 | +112 113 | x: TypeAlias = DataFrame | None diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_base_classes_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_base_classes_1.py.snap index e3174cb4546f4..70d301b0b5ab6 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_base_classes_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_base_classes_1.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -runtime_evaluated_base_classes_1.py:10:12: TCH004 [*] Move import `datetime` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_base_classes_1.py:10:12: TC004 [*] Move import `datetime` out of type-checking block. Import is used for more than type hinting. | 9 | if TYPE_CHECKING: -10 | import datetime # TCH004 - | ^^^^^^^^ TCH004 -11 | from array import array # TCH004 +10 | import datetime # TC004 + | ^^^^^^^^ TC004 +11 | from array import array # TC004 | = help: Move out of type-checking block @@ -17,19 +17,19 @@ runtime_evaluated_base_classes_1.py:10:12: TCH004 [*] Move import `datetime` out 8 |+import datetime 8 9 | 9 10 | if TYPE_CHECKING: -10 |- import datetime # TCH004 -11 11 | from array import array # TCH004 +10 |- import datetime # TC004 +11 11 | from array import array # TC004 12 12 | -13 13 | import pandas # TCH004 +13 13 | import pandas # TC004 -runtime_evaluated_base_classes_1.py:11:23: TCH004 [*] Move import `array.array` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_base_classes_1.py:11:23: TC004 [*] Move import `array.array` out of type-checking block. Import is used for more than type hinting. | 9 | if TYPE_CHECKING: -10 | import datetime # TCH004 -11 | from array import array # TCH004 - | ^^^^^ TCH004 -12 | -13 | import pandas # TCH004 +10 | import datetime # TC004 +11 | from array import array # TC004 + | ^^^^^ TC004 +12 | +13 | import pandas # TC004 | = help: Move out of type-checking block @@ -40,18 +40,18 @@ runtime_evaluated_base_classes_1.py:11:23: TCH004 [*] Move import `array.array` 8 |+from array import array 8 9 | 9 10 | if TYPE_CHECKING: -10 11 | import datetime # TCH004 -11 |- from array import array # TCH004 +10 11 | import datetime # TC004 +11 |- from array import array # TC004 12 12 | -13 13 | import pandas # TCH004 +13 13 | import pandas # TC004 14 14 | import pyproj -runtime_evaluated_base_classes_1.py:13:12: TCH004 [*] Move import `pandas` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_base_classes_1.py:13:12: TC004 [*] Move import `pandas` out of type-checking block. Import is used for more than type hinting. | -11 | from array import array # TCH004 -12 | -13 | import pandas # TCH004 - | ^^^^^^ TCH004 +11 | from array import array # TC004 +12 | +13 | import pandas # TC004 + | ^^^^^^ TC004 14 | import pyproj | = help: Move out of type-checking block @@ -63,12 +63,10 @@ runtime_evaluated_base_classes_1.py:13:12: TCH004 [*] Move import `pandas` out o 8 |+import pandas 8 9 | 9 10 | if TYPE_CHECKING: -10 11 | import datetime # TCH004 -11 12 | from array import array # TCH004 +10 11 | import datetime # TC004 +11 12 | from array import array # TC004 12 13 | -13 |- import pandas # TCH004 +13 |- import pandas # TC004 14 14 | import pyproj 15 15 | -16 16 | - - +16 16 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_decorators_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_decorators_1.py.snap index d229203c36788..bab0a4ba6372a 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_decorators_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_runtime_evaluated_decorators_1.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -runtime_evaluated_decorators_1.py:12:12: TCH004 [*] Move import `datetime` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_decorators_1.py:12:12: TC004 [*] Move import `datetime` out of type-checking block. Import is used for more than type hinting. | 11 | if TYPE_CHECKING: -12 | import datetime # TCH004 - | ^^^^^^^^ TCH004 -13 | from array import array # TCH004 +12 | import datetime # TC004 + | ^^^^^^^^ TC004 +13 | from array import array # TC004 | = help: Move out of type-checking block @@ -17,19 +17,19 @@ runtime_evaluated_decorators_1.py:12:12: TCH004 [*] Move import `datetime` out o 10 |+import datetime 10 11 | 11 12 | if TYPE_CHECKING: -12 |- import datetime # TCH004 -13 13 | from array import array # TCH004 +12 |- import datetime # TC004 +13 13 | from array import array # TC004 14 14 | -15 15 | import pandas # TCH004 +15 15 | import pandas # TC004 -runtime_evaluated_decorators_1.py:13:23: TCH004 [*] Move import `array.array` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_decorators_1.py:13:23: TC004 [*] Move import `array.array` out of type-checking block. Import is used for more than type hinting. | 11 | if TYPE_CHECKING: -12 | import datetime # TCH004 -13 | from array import array # TCH004 - | ^^^^^ TCH004 -14 | -15 | import pandas # TCH004 +12 | import datetime # TC004 +13 | from array import array # TC004 + | ^^^^^ TC004 +14 | +15 | import pandas # TC004 | = help: Move out of type-checking block @@ -40,18 +40,18 @@ runtime_evaluated_decorators_1.py:13:23: TCH004 [*] Move import `array.array` ou 10 |+from array import array 10 11 | 11 12 | if TYPE_CHECKING: -12 13 | import datetime # TCH004 -13 |- from array import array # TCH004 +12 13 | import datetime # TC004 +13 |- from array import array # TC004 14 14 | -15 15 | import pandas # TCH004 +15 15 | import pandas # TC004 16 16 | import pyproj -runtime_evaluated_decorators_1.py:15:12: TCH004 [*] Move import `pandas` out of type-checking block. Import is used for more than type hinting. +runtime_evaluated_decorators_1.py:15:12: TC004 [*] Move import `pandas` out of type-checking block. Import is used for more than type hinting. | -13 | from array import array # TCH004 -14 | -15 | import pandas # TCH004 - | ^^^^^^ TCH004 +13 | from array import array # TC004 +14 | +15 | import pandas # TC004 + | ^^^^^^ TC004 16 | import pyproj | = help: Move out of type-checking block @@ -63,12 +63,10 @@ runtime_evaluated_decorators_1.py:15:12: TCH004 [*] Move import `pandas` out of 10 |+import pandas 10 11 | 11 12 | if TYPE_CHECKING: -12 13 | import datetime # TCH004 -13 14 | from array import array # TCH004 +12 13 | import datetime # TC004 +13 14 | from array import array # TC004 14 15 | -15 |- import pandas # TCH004 +15 |- import pandas # TC004 16 16 | import pyproj 17 17 | -18 18 | - - +18 18 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_1.py.snap new file mode 100644 index 0000000000000..364d44103bdcb --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_1.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC010_1.py:18:30: TC010 Invalid string member in `X | Y`-style union type + | +16 | type A = Value["int" | str] # OK +17 | +18 | OldS = TypeVar('OldS', int | 'str', str) # TC010 + | ^^^^^ TC010 + | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_2.py.snap new file mode 100644 index 0000000000000..1e169cb50c493 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TC010_2.py.snap @@ -0,0 +1,39 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC010_2.py:4:4: TC010 Invalid string member in `X | Y`-style union type + | +4 | x: "int" | str # TC010 + | ^^^^^ TC010 +5 | x: ("int" | str) | "bool" # TC010 + | + +TC010_2.py:5:5: TC010 Invalid string member in `X | Y`-style union type + | +4 | x: "int" | str # TC010 +5 | x: ("int" | str) | "bool" # TC010 + | ^^^^^ TC010 + | + +TC010_2.py:5:20: TC010 Invalid string member in `X | Y`-style union type + | +4 | x: "int" | str # TC010 +5 | x: ("int" | str) | "bool" # TC010 + | ^^^^^^ TC010 + | + +TC010_2.py:12:20: TC010 Invalid string member in `X | Y`-style union type + | +12 | z: list[str, str | "int"] = [] # TC010 + | ^^^^^ TC010 +13 | +14 | type A = Value["int" | str] # OK + | + +TC010_2.py:16:30: TC010 Invalid string member in `X | Y`-style union type + | +14 | type A = Value["int" | str] # OK +15 | +16 | OldS = TypeVar('OldS', int | 'str', str) # TC010 + | ^^^^^ TC010 + | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_1.py.snap deleted file mode 100644 index bf78da6c607ae..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_1.py.snap +++ /dev/null @@ -1,12 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH010_1.py:18:30: TCH010 Invalid string member in `X | Y`-style union type - | -16 | type A = Value["int" | str] # OK -17 | -18 | OldS = TypeVar('OldS', int | 'str', str) # TCH010 - | ^^^^^ TCH010 - | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_2.py.snap deleted file mode 100644 index f03037ad82933..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-string-union_TCH010_2.py.snap +++ /dev/null @@ -1,41 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH010_2.py:4:4: TCH010 Invalid string member in `X | Y`-style union type - | -4 | x: "int" | str # TCH010 - | ^^^^^ TCH010 -5 | x: ("int" | str) | "bool" # TCH010 - | - -TCH010_2.py:5:5: TCH010 Invalid string member in `X | Y`-style union type - | -4 | x: "int" | str # TCH010 -5 | x: ("int" | str) | "bool" # TCH010 - | ^^^^^ TCH010 - | - -TCH010_2.py:5:20: TCH010 Invalid string member in `X | Y`-style union type - | -4 | x: "int" | str # TCH010 -5 | x: ("int" | str) | "bool" # TCH010 - | ^^^^^^ TCH010 - | - -TCH010_2.py:12:20: TCH010 Invalid string member in `X | Y`-style union type - | -12 | z: list[str, str | "int"] = [] # TCH010 - | ^^^^^ TCH010 -13 | -14 | type A = Value["int" | str] # OK - | - -TCH010_2.py:16:30: TCH010 Invalid string member in `X | Y`-style union type - | -14 | type A = Value["int" | str] # OK -15 | -16 | OldS = TypeVar('OldS', int | 'str', str) # TCH010 - | ^^^^^ TCH010 - | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_init_var.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_init_var.py.snap index 64ba87ffb395b..b5260d86db131 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_init_var.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_init_var.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -init_var.py:5:25: TCH003 [*] Move standard library import `dataclasses.FrozenInstanceError` into a type-checking block +init_var.py:5:25: TC003 [*] Move standard library import `dataclasses.FrozenInstanceError` into a type-checking block | 3 | from __future__ import annotations -4 | +4 | 5 | from dataclasses import FrozenInstanceError, InitVar, dataclass - | ^^^^^^^^^^^^^^^^^^^ TCH003 + | ^^^^^^^^^^^^^^^^^^^ TC003 6 | from pathlib import Path | = help: Move into type-checking block @@ -26,11 +26,11 @@ init_var.py:5:25: TCH003 [*] Move standard library import `dataclasses.FrozenIns 8 12 | 9 13 | @dataclass -init_var.py:6:21: TCH003 [*] Move standard library import `pathlib.Path` into a type-checking block +init_var.py:6:21: TC003 [*] Move standard library import `pathlib.Path` into a type-checking block | 5 | from dataclasses import FrozenInstanceError, InitVar, dataclass 6 | from pathlib import Path - | ^^^^ TCH003 + | ^^^^ TC003 | = help: Move into type-checking block @@ -46,5 +46,3 @@ init_var.py:6:21: TCH003 [*] Move standard library import `pathlib.Path` into a 7 10 | 8 11 | 9 12 | @dataclass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_kw_only.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_kw_only.py.snap index 478af5eba46b2..541a83ad172bf 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_kw_only.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-standard-library-import_kw_only.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -kw_only.py:5:45: TCH003 [*] Move standard library import `dataclasses.Field` into a type-checking block +kw_only.py:5:45: TC003 [*] Move standard library import `dataclasses.Field` into a type-checking block | 3 | from __future__ import annotations -4 | +4 | 5 | from dataclasses import KW_ONLY, dataclass, Field - | ^^^^^ TCH003 + | ^^^^^ TC003 | = help: Move into type-checking block diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-third-party-import_strict.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-third-party-import_strict.py.snap index 99d8f413bb163..d8451b6dfb301 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-third-party-import_strict.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__strict_typing-only-third-party-import_strict.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -strict.py:27:21: TCH002 [*] Move third-party import `pkg.A` into a type-checking block +strict.py:27:21: TC002 [*] Move third-party import `pkg.A` into a type-checking block | 25 | # In un-strict mode, this shouldn't raise an error, since `pkg` is used at runtime. 26 | import pkg 27 | from pkg import A - | ^ TCH002 -28 | + | ^ TC002 +28 | 29 | def test(value: A): | = help: Move into type-checking block @@ -30,13 +30,13 @@ strict.py:27:21: TCH002 [*] Move third-party import `pkg.A` into a type-checking 29 32 | def test(value: A): 30 33 | return pkg.B() -strict.py:35:21: TCH002 [*] Move third-party import `pkg.A` into a type-checking block +strict.py:35:21: TC002 [*] Move third-party import `pkg.A` into a type-checking block | 33 | def f(): 34 | # In un-strict mode, this shouldn't raise an error, since `pkg` is used at runtime. 35 | from pkg import A, B - | ^ TCH002 -36 | + | ^ TC002 +36 | 37 | def test(value: A): | = help: Move into type-checking block @@ -60,13 +60,13 @@ strict.py:35:21: TCH002 [*] Move third-party import `pkg.A` into a type-checking 37 41 | def test(value: A): 38 42 | return B() -strict.py:54:25: TCH002 [*] Move third-party import `pkg.bar.A` into a type-checking block +strict.py:54:25: TC002 [*] Move third-party import `pkg.bar.A` into a type-checking block | 52 | # In un-strict mode, this _should_ raise an error, since `pkg.bar` isn't used at runtime 53 | import pkg 54 | from pkg.bar import A - | ^ TCH002 -55 | + | ^ TC002 +55 | 56 | def test(value: A): | = help: Move into type-checking block @@ -89,12 +89,12 @@ strict.py:54:25: TCH002 [*] Move third-party import `pkg.bar.A` into a type-chec 56 59 | def test(value: A): 57 60 | return pkg.B() -strict.py:62:12: TCH002 [*] Move third-party import `pkg` into a type-checking block +strict.py:62:12: TC002 [*] Move third-party import `pkg` into a type-checking block | 60 | def f(): 61 | # In un-strict mode, this shouldn't raise an error, since `pkg.bar` is used at runtime. 62 | import pkg - | ^^^ TCH002 + | ^^^ TC002 63 | import pkg.bar as B | = help: Move into type-checking block @@ -117,12 +117,12 @@ strict.py:62:12: TCH002 [*] Move third-party import `pkg` into a type-checking b 64 67 | 65 68 | def test(value: pkg.A): -strict.py:71:23: TCH002 [*] Move third-party import `pkg.foo` into a type-checking block +strict.py:71:23: TC002 [*] Move third-party import `pkg.foo` into a type-checking block | 69 | def f(): 70 | # In un-strict mode, this shouldn't raise an error, since `pkg.foo.bar` is used at runtime. 71 | import pkg.foo as F - | ^ TCH002 + | ^ TC002 72 | import pkg.foo.bar as B | = help: Move into type-checking block @@ -145,12 +145,12 @@ strict.py:71:23: TCH002 [*] Move third-party import `pkg.foo` into a type-checki 73 76 | 74 77 | def test(value: F.Foo): -strict.py:80:12: TCH002 [*] Move third-party import `pkg` into a type-checking block +strict.py:80:12: TC002 [*] Move third-party import `pkg` into a type-checking block | 78 | def f(): 79 | # In un-strict mode, this shouldn't raise an error, since `pkg.foo.bar` is used at runtime. 80 | import pkg - | ^^^ TCH002 + | ^^^ TC002 81 | import pkg.foo.bar as B | = help: Move into type-checking block @@ -173,12 +173,12 @@ strict.py:80:12: TCH002 [*] Move third-party import `pkg` into a type-checking b 82 85 | 83 86 | def test(value: pkg.A): -strict.py:91:12: TCH002 [*] Move third-party import `pkg` into a type-checking block +strict.py:91:12: TC002 [*] Move third-party import `pkg` into a type-checking block | 89 | # Note that `pkg` is a prefix of `pkgfoo` which are both different modules. This is 90 | # testing the implementation. 91 | import pkg - | ^^^ TCH002 + | ^^^ TC002 92 | import pkgfoo.bar as B | = help: Move into type-checking block @@ -201,13 +201,13 @@ strict.py:91:12: TCH002 [*] Move third-party import `pkg` into a type-checking b 93 96 | 94 97 | def test(value: pkg.A): -strict.py:101:23: TCH002 [*] Move third-party import `pkg.foo` into a type-checking block +strict.py:101:23: TC002 [*] Move third-party import `pkg.foo` into a type-checking block | 99 | # In un-strict mode, this shouldn't raise an error, since `pkg` is used at runtime. 100 | import pkg.bar as B 101 | import pkg.foo as F - | ^ TCH002 -102 | + | ^ TC002 +102 | 103 | def test(value: F.Foo): | = help: Move into type-checking block @@ -229,5 +229,3 @@ strict.py:101:23: TCH002 [*] Move third-party import `pkg.foo` into a type-check 102 105 | 103 106 | def test(value: F.Foo): 104 107 | return B.Bar() - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc004_precedence_over_tc007.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc004_precedence_over_tc007.snap new file mode 100644 index 0000000000000..b4ae0f7ff9e1a --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc004_precedence_over_tc007.snap @@ -0,0 +1,24 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +<filename>:6:21: TC004 [*] Move import `foo.Foo` out of type-checking block. Import is used for more than type hinting. + | +4 | from typing import TYPE_CHECKING, TypeAlias +5 | if TYPE_CHECKING: +6 | from foo import Foo # TC004 + | ^^^ TC004 +7 | +8 | a: TypeAlias = Foo | None # OK + | + = help: Move out of type-checking block + +ℹ Unsafe fix +2 2 | from __future__ import annotations +3 3 | +4 4 | from typing import TYPE_CHECKING, TypeAlias + 5 |+from foo import Foo +5 6 | if TYPE_CHECKING: +6 |- from foo import Foo # TC004 + 7 |+ pass # TC004 +7 8 | +8 9 | a: TypeAlias = Foo | None # OK diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc010_precedence_over_tc008.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc010_precedence_over_tc008.snap new file mode 100644 index 0000000000000..3f7510c00fa32 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__tc010_precedence_over_tc008.snap @@ -0,0 +1,27 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +<filename>:6:16: TC008 [*] Remove quotes from type alias + | +4 | from typing import TypeAlias +5 | +6 | a: TypeAlias = 'int | None' # TC008 + | ^^^^^^^^^^^^ TC008 +7 | b: TypeAlias = 'int' | None # TC010 + | + = help: Remove quotes + +ℹ Safe fix +3 3 | +4 4 | from typing import TypeAlias +5 5 | +6 |-a: TypeAlias = 'int | None' # TC008 + 6 |+a: TypeAlias = int | None # TC008 +7 7 | b: TypeAlias = 'int' | None # TC010 + +<filename>:7:16: TC010 Invalid string member in `X | Y`-style union type + | +6 | a: TypeAlias = 'int | None' # TC008 +7 | b: TypeAlias = 'int' | None # TC010 + | ^^^^^ TC010 + | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_after_usage.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_after_usage.snap index da83b1545fffa..cdacd1ba29ac6 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_after_usage.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_after_usage.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import pandas as pd - | ^^ TCH002 -7 | + | ^^ TC002 +7 | 8 | def f(x: pd.DataFrame): | = help: Move into type-checking block @@ -23,6 +23,4 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 |+ 8 10 | def f(x: pd.DataFrame): 9 11 | pass -10 12 | - - +10 12 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_comment.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_comment.snap index 0cd80a368e5f1..ce5864c57dd46 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_comment.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_comment.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import pandas as pd - | ^^ TCH002 -7 | + | ^^ TC002 +7 | 8 | if TYPE_CHECKING: | = help: Move into type-checking block @@ -24,5 +24,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 10 10 | import os 11 11 | 12 12 | def f(x: pd.DataFrame): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_inline.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_inline.snap index c79f7c9e53dca..bafccc1d138f3 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_inline.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_inline.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import pandas as pd - | ^^ TCH002 -7 | + | ^^ TC002 +7 | 8 | if TYPE_CHECKING: import os | = help: Move into type-checking block @@ -23,5 +23,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 8 | 10 9 | def f(x: pd.DataFrame): 11 10 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_own_line.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_own_line.snap index bf141729eb56b..ac2f55bc5a11a 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_own_line.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__type_checking_block_own_line.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import pandas as pd - | ^^ TCH002 -7 | + | ^^ TC002 +7 | 8 | if TYPE_CHECKING: | = help: Move into type-checking block @@ -23,5 +23,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 9 | import os 10 10 | 11 11 | def f(x: pd.DataFrame): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TC001.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TC001.py.snap new file mode 100644 index 0000000000000..cc9d12d169811 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TC001.py.snap @@ -0,0 +1,32 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC001.py:20:19: TC001 [*] Move application import `.TYP001` into a type-checking block + | +19 | def f(): +20 | from . import TYP001 + | ^^^^^^ TC001 +21 | +22 | x: TYP001 + | + = help: Move into type-checking block + +ℹ Unsafe fix +2 2 | +3 3 | For typing-only import detection tests, see `TC002.py`. +4 4 | """ + 5 |+from typing import TYPE_CHECKING + 6 |+ + 7 |+if TYPE_CHECKING: + 8 |+ from . import TYP001 +5 9 | +6 10 | +7 11 | def f(): +-------------------------------------------------------------------------------- +17 21 | +18 22 | +19 23 | def f(): +20 |- from . import TYP001 +21 24 | +22 25 | x: TYP001 +23 26 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TCH001.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TCH001.py.snap deleted file mode 100644 index 2c086380af453..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-first-party-import_TCH001.py.snap +++ /dev/null @@ -1,34 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH001.py:20:19: TCH001 [*] Move application import `.TYP001` into a type-checking block - | -19 | def f(): -20 | from . import TYP001 - | ^^^^^^ TCH001 -21 | -22 | x: TYP001 - | - = help: Move into type-checking block - -ℹ Unsafe fix -2 2 | -3 3 | For typing-only import detection tests, see `TCH002.py`. -4 4 | """ - 5 |+from typing import TYPE_CHECKING - 6 |+ - 7 |+if TYPE_CHECKING: - 8 |+ from . import TYP001 -5 9 | -6 10 | -7 11 | def f(): --------------------------------------------------------------------------------- -17 21 | -18 22 | -19 23 | def f(): -20 |- from . import TYP001 -21 24 | -22 25 | x: TYP001 -23 26 | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TC003.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TC003.py.snap new file mode 100644 index 0000000000000..e7590ea5c254f --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TC003.py.snap @@ -0,0 +1,28 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC003.py:8:12: TC003 [*] Move standard library import `os` into a type-checking block + | + 7 | def f(): + 8 | import os + | ^^ TC003 + 9 | +10 | x: os + | + = help: Move into type-checking block + +ℹ Unsafe fix +2 2 | +3 3 | For typing-only import detection tests, see `TC002.py`. +4 4 | """ + 5 |+from typing import TYPE_CHECKING + 6 |+ + 7 |+if TYPE_CHECKING: + 8 |+ import os +5 9 | +6 10 | +7 11 | def f(): +8 |- import os +9 12 | +10 13 | x: os +11 14 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TCH003.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TCH003.py.snap deleted file mode 100644 index a5016892c3fb2..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_TCH003.py.snap +++ /dev/null @@ -1,30 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH003.py:8:12: TCH003 [*] Move standard library import `os` into a type-checking block - | - 7 | def f(): - 8 | import os - | ^^ TCH003 - 9 | -10 | x: os - | - = help: Move into type-checking block - -ℹ Unsafe fix -2 2 | -3 3 | For typing-only import detection tests, see `TCH002.py`. -4 4 | """ - 5 |+from typing import TYPE_CHECKING - 6 |+ - 7 |+if TYPE_CHECKING: - 8 |+ import os -5 9 | -6 10 | -7 11 | def f(): -8 |- import os -9 12 | -10 13 | x: os -11 14 | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_1.py.snap index ca63f50e1fc0b..98f48ef06a17c 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_1.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -exempt_type_checking_1.py:5:20: TCH003 [*] Move standard library import `typing.Final` into a type-checking block +exempt_type_checking_1.py:5:20: TC003 [*] Move standard library import `typing.Final` into a type-checking block | 3 | from __future__ import annotations -4 | +4 | 5 | from typing import Final - | ^^^^^ TCH003 -6 | + | ^^^^^ TC003 +6 | 7 | Const: Final[dict] = {} | = help: Move into type-checking block @@ -23,5 +23,3 @@ exempt_type_checking_1.py:5:20: TCH003 [*] Move standard library import `typing. 8 |+ from typing import Final 6 9 | 7 10 | Const: Final[dict] = {} - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_2.py.snap index 82d27250c6c6a..909e0d5530f97 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_2.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -exempt_type_checking_2.py:5:20: TCH003 [*] Move standard library import `typing.Final` into a type-checking block +exempt_type_checking_2.py:5:20: TC003 [*] Move standard library import `typing.Final` into a type-checking block | 3 | from __future__ import annotations -4 | +4 | 5 | from typing import Final, TYPE_CHECKING - | ^^^^^ TCH003 -6 | + | ^^^^^ TC003 +6 | 7 | Const: Final[dict] = {} | = help: Move into type-checking block @@ -23,5 +23,3 @@ exempt_type_checking_2.py:5:20: TCH003 [*] Move standard library import `typing. 8 |+ from typing import Final 6 9 | 7 10 | Const: Final[dict] = {} - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_3.py.snap index 18b9b569ecd34..afd7480adef73 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_exempt_type_checking_3.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -exempt_type_checking_3.py:5:20: TCH003 [*] Move standard library import `typing.Final` into a type-checking block +exempt_type_checking_3.py:5:20: TC003 [*] Move standard library import `typing.Final` into a type-checking block | 3 | from __future__ import annotations -4 | +4 | 5 | from typing import Final, Mapping - | ^^^^^ TCH003 -6 | + | ^^^^^ TC003 +6 | 7 | Const: Final[dict] = {} | = help: Move into type-checking block @@ -24,5 +24,3 @@ exempt_type_checking_3.py:5:20: TCH003 [*] Move standard library import `typing. 9 |+ from typing import Final 6 10 | 7 11 | Const: Final[dict] = {} - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_init_var.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_init_var.py.snap index 08a45c92e134c..11a40633dd6b1 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_init_var.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_init_var.py.snap @@ -1,11 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -init_var.py:6:21: TCH003 [*] Move standard library import `pathlib.Path` into a type-checking block +init_var.py:6:21: TC003 [*] Move standard library import `pathlib.Path` into a type-checking block | 5 | from dataclasses import FrozenInstanceError, InitVar, dataclass 6 | from pathlib import Path - | ^^^^ TCH003 + | ^^^^ TC003 | = help: Move into type-checking block @@ -21,5 +22,3 @@ init_var.py:6:21: TCH003 [*] Move standard library import `pathlib.Path` into a 7 10 | 8 11 | 9 12 | @dataclass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_kw_only.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_kw_only.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_kw_only.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_kw_only.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__direct.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__direct.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__direct.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__direct.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__import.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__import.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__import.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__import.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_14.pyi.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__routes.py.snap similarity index 100% rename from crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__runtime-import-in-type-checking-block_TCH004_14.pyi.snap rename to crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__routes.py.snap diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__undefined.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__undefined.py.snap index b7f049eaa86ff..89f0a91947d4a 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__undefined.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_module__undefined.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -undefined.py:3:29: TCH003 [*] Move standard library import `collections.abc.Sequence` into a type-checking block +undefined.py:3:29: TC003 [*] Move standard library import `collections.abc.Sequence` into a type-checking block | 1 | from __future__ import annotations -2 | +2 | 3 | from collections.abc import Sequence - | ^^^^^^^^ TCH003 + | ^^^^^^^^ TC003 | = help: Move into type-checking block @@ -21,5 +21,3 @@ undefined.py:3:29: TCH003 [*] Move standard library import `collections.abc.Sequ 4 7 | 5 8 | 6 9 | class Foo(MyBaseClass): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_3.py.snap index 7eb6ba98775d0..06d344ed01523 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_3.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -runtime_evaluated_base_classes_3.py:5:18: TCH003 [*] Move standard library import `uuid.UUID` into a type-checking block +runtime_evaluated_base_classes_3.py:5:18: TC003 [*] Move standard library import `uuid.UUID` into a type-checking block | 3 | import datetime 4 | import pathlib -5 | from uuid import UUID # TCH003 - | ^^^^ TCH003 -6 | +5 | from uuid import UUID # TC003 + | ^^^^ TC003 +6 | 7 | import pydantic | = help: Move into type-checking block @@ -16,7 +16,7 @@ runtime_evaluated_base_classes_3.py:5:18: TCH003 [*] Move standard library impor 2 2 | 3 3 | import datetime 4 4 | import pathlib -5 |-from uuid import UUID # TCH003 +5 |-from uuid import UUID # TC003 6 5 | 7 6 | import pydantic 8 7 | from pydantic import BaseModel @@ -27,5 +27,3 @@ runtime_evaluated_base_classes_3.py:5:18: TCH003 [*] Move standard library impor 9 12 | 10 13 | 11 14 | class A(pydantic.BaseModel): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_4.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_4.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_4.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_base_classes_4.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_decorators_3.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_decorators_3.py.snap index 618928099681a..bba4e32fee5ec 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_decorators_3.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_runtime_evaluated_decorators_3.py.snap @@ -1,12 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -runtime_evaluated_decorators_3.py:6:18: TCH003 [*] Move standard library import `uuid.UUID` into a type-checking block +runtime_evaluated_decorators_3.py:6:18: TC003 [*] Move standard library import `uuid.UUID` into a type-checking block | 4 | from array import array 5 | from dataclasses import dataclass -6 | from uuid import UUID # TCH003 - | ^^^^ TCH003 +6 | from uuid import UUID # TC003 + | ^^^^ TC003 7 | from collections.abc import Sequence 8 | from pydantic import validate_call | @@ -16,7 +17,7 @@ runtime_evaluated_decorators_3.py:6:18: TCH003 [*] Move standard library import 3 3 | import datetime 4 4 | from array import array 5 5 | from dataclasses import dataclass -6 |-from uuid import UUID # TCH003 +6 |-from uuid import UUID # TC003 7 6 | from collections.abc import Sequence 8 7 | from pydantic import validate_call 9 8 | @@ -29,5 +30,3 @@ runtime_evaluated_decorators_3.py:6:18: TCH003 [*] Move standard library import 12 15 | 13 16 | 14 17 | @attrs.define(auto_attribs=True) - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_singledispatchmethod.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_singledispatchmethod.py.snap index 53c691d795682..18e5d97933524 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_singledispatchmethod.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_singledispatchmethod.py.snap @@ -1,11 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- -singledispatchmethod.py:4:21: TCH003 [*] Move standard library import `pathlib.Path` into a type-checking block +singledispatchmethod.py:4:21: TC003 [*] Move standard library import `pathlib.Path` into a type-checking block | 3 | from collections.abc import MutableMapping, Mapping 4 | from pathlib import Path - | ^^^^ TCH003 + | ^^^^ TC003 5 | from functools import singledispatchmethod 6 | from typing import Union | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_snapshot.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_snapshot.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_snapshot.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-standard-library-import_snapshot.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TC002.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TC002.py.snap new file mode 100644 index 0000000000000..3b34f3141cd25 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TC002.py.snap @@ -0,0 +1,251 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC002.py:5:22: TC002 [*] Move third-party import `pandas` into a type-checking block + | +4 | def f(): +5 | import pandas as pd # TC002 + | ^^ TC002 +6 | +7 | x: pd.DataFrame + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ import pandas as pd +2 6 | +3 7 | +4 8 | def f(): +5 |- import pandas as pd # TC002 +6 9 | +7 10 | x: pd.DataFrame +8 11 | + +TC002.py:11:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block + | +10 | def f(): +11 | from pandas import DataFrame # TC002 + | ^^^^^^^^^ TC002 +12 | +13 | x: DataFrame + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ from pandas import DataFrame +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +8 12 | +9 13 | +10 14 | def f(): +11 |- from pandas import DataFrame # TC002 +12 15 | +13 16 | x: DataFrame +14 17 | + +TC002.py:17:37: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block + | +16 | def f(): +17 | from pandas import DataFrame as df # TC002 + | ^^ TC002 +18 | +19 | x: df + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ from pandas import DataFrame as df +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +14 18 | +15 19 | +16 20 | def f(): +17 |- from pandas import DataFrame as df # TC002 +18 21 | +19 22 | x: df +20 23 | + +TC002.py:23:22: TC002 [*] Move third-party import `pandas` into a type-checking block + | +22 | def f(): +23 | import pandas as pd # TC002 + | ^^ TC002 +24 | +25 | x: pd.DataFrame = 1 + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ import pandas as pd +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +20 24 | +21 25 | +22 26 | def f(): +23 |- import pandas as pd # TC002 +24 27 | +25 28 | x: pd.DataFrame = 1 +26 29 | + +TC002.py:29:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block + | +28 | def f(): +29 | from pandas import DataFrame # TC002 + | ^^^^^^^^^ TC002 +30 | +31 | x: DataFrame = 2 + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ from pandas import DataFrame +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +26 30 | +27 31 | +28 32 | def f(): +29 |- from pandas import DataFrame # TC002 +30 33 | +31 34 | x: DataFrame = 2 +32 35 | + +TC002.py:35:37: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block + | +34 | def f(): +35 | from pandas import DataFrame as df # TC002 + | ^^ TC002 +36 | +37 | x: df = 3 + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ from pandas import DataFrame as df +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +32 36 | +33 37 | +34 38 | def f(): +35 |- from pandas import DataFrame as df # TC002 +36 39 | +37 40 | x: df = 3 +38 41 | + +TC002.py:41:22: TC002 [*] Move third-party import `pandas` into a type-checking block + | +40 | def f(): +41 | import pandas as pd # TC002 + | ^^ TC002 +42 | +43 | x: "pd.DataFrame" = 1 + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ import pandas as pd +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +38 42 | +39 43 | +40 44 | def f(): +41 |- import pandas as pd # TC002 +42 45 | +43 46 | x: "pd.DataFrame" = 1 +44 47 | + +TC002.py:47:22: TC002 [*] Move third-party import `pandas` into a type-checking block + | +46 | def f(): +47 | import pandas as pd # TC002 + | ^^ TC002 +48 | +49 | x = dict["pd.DataFrame", "pd.DataFrame"] + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ import pandas as pd +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +44 48 | +45 49 | +46 50 | def f(): +47 |- import pandas as pd # TC002 +48 51 | +49 52 | x = dict["pd.DataFrame", "pd.DataFrame"] +50 53 | + +TC002.py:172:24: TC002 [*] Move third-party import `module.Member` into a type-checking block + | +170 | global Member +171 | +172 | from module import Member + | ^^^^^^ TC002 +173 | +174 | x: Member = 1 + | + = help: Move into type-checking block + +ℹ Unsafe fix +1 1 | """Tests to determine accurate detection of typing-only imports.""" + 2 |+from typing import TYPE_CHECKING + 3 |+ + 4 |+if TYPE_CHECKING: + 5 |+ from module import Member +2 6 | +3 7 | +4 8 | def f(): +-------------------------------------------------------------------------------- +169 173 | def f(): +170 174 | global Member +171 175 | +172 |- from module import Member +173 176 | +174 177 | x: Member = 1 +175 178 | diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TCH002.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TCH002.py.snap deleted file mode 100644 index 7d8365daa6ef9..0000000000000 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_TCH002.py.snap +++ /dev/null @@ -1,253 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs ---- -TCH002.py:5:22: TCH002 [*] Move third-party import `pandas` into a type-checking block - | -4 | def f(): -5 | import pandas as pd # TCH002 - | ^^ TCH002 -6 | -7 | x: pd.DataFrame - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ import pandas as pd -2 6 | -3 7 | -4 8 | def f(): -5 |- import pandas as pd # TCH002 -6 9 | -7 10 | x: pd.DataFrame -8 11 | - -TCH002.py:11:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block - | -10 | def f(): -11 | from pandas import DataFrame # TCH002 - | ^^^^^^^^^ TCH002 -12 | -13 | x: DataFrame - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ from pandas import DataFrame -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -8 12 | -9 13 | -10 14 | def f(): -11 |- from pandas import DataFrame # TCH002 -12 15 | -13 16 | x: DataFrame -14 17 | - -TCH002.py:17:37: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block - | -16 | def f(): -17 | from pandas import DataFrame as df # TCH002 - | ^^ TCH002 -18 | -19 | x: df - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ from pandas import DataFrame as df -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -14 18 | -15 19 | -16 20 | def f(): -17 |- from pandas import DataFrame as df # TCH002 -18 21 | -19 22 | x: df -20 23 | - -TCH002.py:23:22: TCH002 [*] Move third-party import `pandas` into a type-checking block - | -22 | def f(): -23 | import pandas as pd # TCH002 - | ^^ TCH002 -24 | -25 | x: pd.DataFrame = 1 - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ import pandas as pd -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -20 24 | -21 25 | -22 26 | def f(): -23 |- import pandas as pd # TCH002 -24 27 | -25 28 | x: pd.DataFrame = 1 -26 29 | - -TCH002.py:29:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block - | -28 | def f(): -29 | from pandas import DataFrame # TCH002 - | ^^^^^^^^^ TCH002 -30 | -31 | x: DataFrame = 2 - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ from pandas import DataFrame -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -26 30 | -27 31 | -28 32 | def f(): -29 |- from pandas import DataFrame # TCH002 -30 33 | -31 34 | x: DataFrame = 2 -32 35 | - -TCH002.py:35:37: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block - | -34 | def f(): -35 | from pandas import DataFrame as df # TCH002 - | ^^ TCH002 -36 | -37 | x: df = 3 - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ from pandas import DataFrame as df -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -32 36 | -33 37 | -34 38 | def f(): -35 |- from pandas import DataFrame as df # TCH002 -36 39 | -37 40 | x: df = 3 -38 41 | - -TCH002.py:41:22: TCH002 [*] Move third-party import `pandas` into a type-checking block - | -40 | def f(): -41 | import pandas as pd # TCH002 - | ^^ TCH002 -42 | -43 | x: "pd.DataFrame" = 1 - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ import pandas as pd -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -38 42 | -39 43 | -40 44 | def f(): -41 |- import pandas as pd # TCH002 -42 45 | -43 46 | x: "pd.DataFrame" = 1 -44 47 | - -TCH002.py:47:22: TCH002 [*] Move third-party import `pandas` into a type-checking block - | -46 | def f(): -47 | import pandas as pd # TCH002 - | ^^ TCH002 -48 | -49 | x = dict["pd.DataFrame", "pd.DataFrame"] - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ import pandas as pd -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -44 48 | -45 49 | -46 50 | def f(): -47 |- import pandas as pd # TCH002 -48 51 | -49 52 | x = dict["pd.DataFrame", "pd.DataFrame"] -50 53 | - -TCH002.py:172:24: TCH002 [*] Move third-party import `module.Member` into a type-checking block - | -170 | global Member -171 | -172 | from module import Member - | ^^^^^^ TCH002 -173 | -174 | x: Member = 1 - | - = help: Move into type-checking block - -ℹ Unsafe fix -1 1 | """Tests to determine accurate detection of typing-only imports.""" - 2 |+from typing import TYPE_CHECKING - 3 |+ - 4 |+if TYPE_CHECKING: - 5 |+ from module import Member -2 6 | -3 7 | -4 8 | def f(): --------------------------------------------------------------------------------- -169 173 | def f(): -170 174 | global Member -171 175 | -172 |- from module import Member -173 176 | -174 177 | x: Member = 1 -175 178 | - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_quote.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_quote.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_quote.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_quote.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_2.py.snap index fdefb73be5917..d52dd420f81f9 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_2.py.snap @@ -1,23 +1,23 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -runtime_evaluated_base_classes_2.py:3:21: TCH002 [*] Move third-party import `geopandas` into a type-checking block +runtime_evaluated_base_classes_2.py:3:21: TC002 [*] Move third-party import `geopandas` into a type-checking block | 1 | from __future__ import annotations -2 | -3 | import geopandas as gpd # TCH002 - | ^^^ TCH002 +2 | +3 | import geopandas as gpd # TC002 + | ^^^ TC002 4 | import pydantic -5 | import pyproj # TCH002 +5 | import pyproj # TC002 | = help: Move into type-checking block ℹ Unsafe fix 1 1 | from __future__ import annotations 2 2 | -3 |-import geopandas as gpd # TCH002 +3 |-import geopandas as gpd # TC002 4 3 | import pydantic -5 4 | import pyproj # TCH002 +5 4 | import pyproj # TC002 6 5 | from pydantic import BaseModel 7 6 | 8 7 | import numpy @@ -29,21 +29,21 @@ runtime_evaluated_base_classes_2.py:3:21: TCH002 [*] Move third-party import `ge 10 13 | 11 14 | class A(BaseModel): -runtime_evaluated_base_classes_2.py:5:8: TCH002 [*] Move third-party import `pyproj` into a type-checking block +runtime_evaluated_base_classes_2.py:5:8: TC002 [*] Move third-party import `pyproj` into a type-checking block | -3 | import geopandas as gpd # TCH002 +3 | import geopandas as gpd # TC002 4 | import pydantic -5 | import pyproj # TCH002 - | ^^^^^^ TCH002 +5 | import pyproj # TC002 + | ^^^^^^ TC002 6 | from pydantic import BaseModel | = help: Move into type-checking block ℹ Unsafe fix 2 2 | -3 3 | import geopandas as gpd # TCH002 +3 3 | import geopandas as gpd # TC002 4 4 | import pydantic -5 |-import pyproj # TCH002 +5 |-import pyproj # TC002 6 5 | from pydantic import BaseModel 7 6 | 8 7 | import numpy @@ -54,5 +54,3 @@ runtime_evaluated_base_classes_2.py:5:8: TCH002 [*] Move third-party import `pyp 9 12 | 10 13 | 11 14 | class A(BaseModel): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_5.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_5.py.snap index 6c5ead27428ce..173cb5a2d6539 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_5.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_base_classes_5.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_decorators_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_decorators_2.py.snap index 518edf55aac37..daf471f921697 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_decorators_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_runtime_evaluated_decorators_2.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -runtime_evaluated_decorators_2.py:10:8: TCH002 [*] Move third-party import `numpy` into a type-checking block +runtime_evaluated_decorators_2.py:10:8: TC002 [*] Move third-party import `numpy` into a type-checking block | 8 | from attrs import frozen - 9 | -10 | import numpy # TCH002 - | ^^^^^ TCH002 + 9 | +10 | import numpy # TC002 + | ^^^^^ TC002 | = help: Move into type-checking block @@ -14,7 +14,7 @@ runtime_evaluated_decorators_2.py:10:8: TCH002 [*] Move third-party import `nump 7 7 | import pyproj 8 8 | from attrs import frozen 9 9 | -10 |-import numpy # TCH002 +10 |-import numpy # TC002 10 |+from typing import TYPE_CHECKING 11 |+ 12 |+if TYPE_CHECKING: @@ -22,5 +22,3 @@ runtime_evaluated_decorators_2.py:10:8: TCH002 [*] Move third-party import `nump 11 14 | 12 15 | 13 16 | @attrs.define(auto_attribs=True) - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_singledispatch.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_singledispatch.py.snap index 10140525767a4..c226a6cfd13e3 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_singledispatch.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_singledispatch.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -singledispatch.py:12:20: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +singledispatch.py:12:20: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 10 | from numpy.typing import ArrayLike 11 | from scipy.sparse import spmatrix 12 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -13 | + | ^^^^^^^^^ TC002 +13 | 14 | if TYPE_CHECKING: | = help: Move into type-checking block diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_strict.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_strict.py.snap index f9d6240613db2..94b85230ae819 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_strict.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_strict.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -strict.py:54:25: TCH002 [*] Move third-party import `pkg.bar.A` into a type-checking block +strict.py:54:25: TC002 [*] Move third-party import `pkg.bar.A` into a type-checking block | 52 | # In un-strict mode, this _should_ raise an error, since `pkg.bar` isn't used at runtime 53 | import pkg 54 | from pkg.bar import A - | ^ TCH002 -55 | + | ^ TC002 +55 | 56 | def test(value: A): | = help: Move into type-checking block @@ -30,12 +30,12 @@ strict.py:54:25: TCH002 [*] Move third-party import `pkg.bar.A` into a type-chec 56 59 | def test(value: A): 57 60 | return pkg.B() -strict.py:91:12: TCH002 [*] Move third-party import `pkg` into a type-checking block +strict.py:91:12: TC002 [*] Move third-party import `pkg` into a type-checking block | 89 | # Note that `pkg` is a prefix of `pkgfoo` which are both different modules. This is 90 | # testing the implementation. 91 | import pkg - | ^^^ TCH002 + | ^^^ TC002 92 | import pkgfoo.bar as B | = help: Move into type-checking block @@ -57,5 +57,3 @@ strict.py:91:12: TCH002 [*] Move third-party import `pkg` into a type-checking b 92 95 | import pkgfoo.bar as B 93 96 | 94 97 | def test(value: pkg.A): - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_1.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_1.py.snap index 3e758fc6c110d..d02dab7f4a28e 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_1.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -typing_modules_1.py:7:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +typing_modules_1.py:7:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 6 | def func(): 7 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -8 | + | ^^^^^^^^^ TC002 +8 | 9 | df: DataFrame | = help: Move into type-checking block @@ -25,5 +25,3 @@ typing_modules_1.py:7:24: TCH002 [*] Move third-party import `pandas.DataFrame` 7 |- from pandas import DataFrame 8 11 | 9 12 | df: DataFrame - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_2.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_2.py.snap index 820be3f860f27..ba8a621fcce77 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing-only-third-party-import_typing_modules_2.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -typing_modules_2.py:7:24: TCH002 [*] Move third-party import `pandas.DataFrame` into a type-checking block +typing_modules_2.py:7:24: TC002 [*] Move third-party import `pandas.DataFrame` into a type-checking block | 6 | def func(): 7 | from pandas import DataFrame - | ^^^^^^^^^ TCH002 -8 | + | ^^^^^^^^^ TC002 +8 | 9 | df: DataFrame | = help: Move into type-checking block @@ -23,5 +23,3 @@ typing_modules_2.py:7:24: TCH002 [*] Move third-party import `pandas.DataFrame` 7 |- from pandas import DataFrame 8 10 | 9 11 | df: DataFrame - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_package_import.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_package_import.snap index d8f9298f51c31..4c00f741029c0 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_package_import.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_package_import.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:4:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:4:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 2 | from __future__ import annotations -3 | +3 | 4 | import pandas as pd - | ^^ TCH002 -5 | + | ^^ TC002 +5 | 6 | from typing import TYPE_CHECKING | = help: Move into type-checking block @@ -25,5 +25,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 |+ 8 10 | def f(x: pd.DataFrame): 9 11 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_usage.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_usage.snap index 03cb3c36feabd..d5353c093997c 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_usage.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_after_usage.snap @@ -1,15 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:4:18: TCH002 Move third-party import `pandas` into a type-checking block +<filename>:4:18: TC002 Move third-party import `pandas` into a type-checking block | 2 | from __future__ import annotations -3 | +3 | 4 | import pandas as pd - | ^^ TCH002 -5 | + | ^^ TC002 +5 | 6 | def f(x: pd.DataFrame): | = help: Move into type-checking block - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_before_package_import.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_before_package_import.snap index d939819ed6214..581f1bb10f6d5 100644 --- a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_before_package_import.snap +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__typing_import_before_package_import.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs --- -<filename>:6:18: TCH002 [*] Move third-party import `pandas` into a type-checking block +<filename>:6:18: TC002 [*] Move third-party import `pandas` into a type-checking block | 4 | from typing import TYPE_CHECKING -5 | +5 | 6 | import pandas as pd - | ^^ TCH002 -7 | + | ^^ TC002 +7 | 8 | def f(x: pd.DataFrame): | = help: Move into type-checking block @@ -23,5 +23,3 @@ source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs 9 |+ 8 10 | def f(x: pd.DataFrame): 9 11 | pass - - diff --git a/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__unquoted-type-alias_TC007.py.snap b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__unquoted-type-alias_TC007.py.snap new file mode 100644 index 0000000000000..5ce4bcc79fcf5 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_type_checking/snapshots/ruff_linter__rules__flake8_type_checking__tests__unquoted-type-alias_TC007.py.snap @@ -0,0 +1,192 @@ +--- +source: crates/ruff_linter/src/rules/flake8_type_checking/mod.rs +--- +TC007.py:15:16: TC007 [*] Add quotes to type alias + | +13 | a: TypeAlias = int # OK +14 | b: TypeAlias = Dict # OK +15 | c: TypeAlias = Foo # TC007 + | ^^^ TC007 +16 | d: TypeAlias = Foo | None # TC007 +17 | e: TypeAlias = OptStr # TC007 + | + = help: Add quotes + +ℹ Unsafe fix +12 12 | +13 13 | a: TypeAlias = int # OK +14 14 | b: TypeAlias = Dict # OK +15 |-c: TypeAlias = Foo # TC007 + 15 |+c: TypeAlias = "Foo" # TC007 +16 16 | d: TypeAlias = Foo | None # TC007 +17 17 | e: TypeAlias = OptStr # TC007 +18 18 | f: TypeAlias = Bar # TC007 + +TC007.py:16:16: TC007 [*] Add quotes to type alias + | +14 | b: TypeAlias = Dict # OK +15 | c: TypeAlias = Foo # TC007 +16 | d: TypeAlias = Foo | None # TC007 + | ^^^ TC007 +17 | e: TypeAlias = OptStr # TC007 +18 | f: TypeAlias = Bar # TC007 + | + = help: Add quotes + +ℹ Unsafe fix +13 13 | a: TypeAlias = int # OK +14 14 | b: TypeAlias = Dict # OK +15 15 | c: TypeAlias = Foo # TC007 +16 |-d: TypeAlias = Foo | None # TC007 + 16 |+d: TypeAlias = "Foo | None" # TC007 +17 17 | e: TypeAlias = OptStr # TC007 +18 18 | f: TypeAlias = Bar # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 + +TC007.py:17:16: TC007 [*] Add quotes to type alias + | +15 | c: TypeAlias = Foo # TC007 +16 | d: TypeAlias = Foo | None # TC007 +17 | e: TypeAlias = OptStr # TC007 + | ^^^^^^ TC007 +18 | f: TypeAlias = Bar # TC007 +19 | g: TypeAlias = Foo | Bar # TC007 x2 + | + = help: Add quotes + +ℹ Unsafe fix +14 14 | b: TypeAlias = Dict # OK +15 15 | c: TypeAlias = Foo # TC007 +16 16 | d: TypeAlias = Foo | None # TC007 +17 |-e: TypeAlias = OptStr # TC007 + 17 |+e: TypeAlias = "OptStr" # TC007 +18 18 | f: TypeAlias = Bar # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 + +TC007.py:18:16: TC007 [*] Add quotes to type alias + | +16 | d: TypeAlias = Foo | None # TC007 +17 | e: TypeAlias = OptStr # TC007 +18 | f: TypeAlias = Bar # TC007 + | ^^^ TC007 +19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 | h: TypeAlias = Foo[str] # TC007 + | + = help: Add quotes + +ℹ Unsafe fix +15 15 | c: TypeAlias = Foo # TC007 +16 16 | d: TypeAlias = Foo | None # TC007 +17 17 | e: TypeAlias = OptStr # TC007 +18 |-f: TypeAlias = Bar # TC007 + 18 |+f: TypeAlias = "Bar" # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 +21 21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) + +TC007.py:19:16: TC007 [*] Add quotes to type alias + | +17 | e: TypeAlias = OptStr # TC007 +18 | f: TypeAlias = Bar # TC007 +19 | g: TypeAlias = Foo | Bar # TC007 x2 + | ^^^ TC007 +20 | h: TypeAlias = Foo[str] # TC007 +21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) + | + = help: Add quotes + +ℹ Unsafe fix +16 16 | d: TypeAlias = Foo | None # TC007 +17 17 | e: TypeAlias = OptStr # TC007 +18 18 | f: TypeAlias = Bar # TC007 +19 |-g: TypeAlias = Foo | Bar # TC007 x2 + 19 |+g: TypeAlias = "Foo | Bar" # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 +21 21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 22 | Bar) + +TC007.py:19:22: TC007 [*] Add quotes to type alias + | +17 | e: TypeAlias = OptStr # TC007 +18 | f: TypeAlias = Bar # TC007 +19 | g: TypeAlias = Foo | Bar # TC007 x2 + | ^^^ TC007 +20 | h: TypeAlias = Foo[str] # TC007 +21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) + | + = help: Add quotes + +ℹ Unsafe fix +16 16 | d: TypeAlias = Foo | None # TC007 +17 17 | e: TypeAlias = OptStr # TC007 +18 18 | f: TypeAlias = Bar # TC007 +19 |-g: TypeAlias = Foo | Bar # TC007 x2 + 19 |+g: TypeAlias = "Foo | Bar" # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 +21 21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 22 | Bar) + +TC007.py:20:16: TC007 [*] Add quotes to type alias + | +18 | f: TypeAlias = Bar # TC007 +19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 | h: TypeAlias = Foo[str] # TC007 + | ^^^ TC007 +21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 | Bar) + | + = help: Add quotes + +ℹ Unsafe fix +17 17 | e: TypeAlias = OptStr # TC007 +18 18 | f: TypeAlias = Bar # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 |-h: TypeAlias = Foo[str] # TC007 + 20 |+h: TypeAlias = "Foo[str]" # TC007 +21 21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 22 | Bar) +23 23 | + +TC007.py:21:17: TC007 [*] Add quotes to type alias + | +19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 | h: TypeAlias = Foo[str] # TC007 +21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) + | ^^^ TC007 +22 | Bar) + | + = help: Add quotes + +ℹ Unsafe fix +18 18 | f: TypeAlias = Bar # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 +21 |-i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 |- Bar) + 21 |+i: TypeAlias = ("Foo | Bar") +23 22 | +24 23 | type C = Foo # OK +25 24 | type D = Foo | None # OK + +TC007.py:22:5: TC007 [*] Add quotes to type alias + | +20 | h: TypeAlias = Foo[str] # TC007 +21 | i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 | Bar) + | ^^^ TC007 +23 | +24 | type C = Foo # OK + | + = help: Add quotes + +ℹ Unsafe fix +18 18 | f: TypeAlias = Bar # TC007 +19 19 | g: TypeAlias = Foo | Bar # TC007 x2 +20 20 | h: TypeAlias = Foo[str] # TC007 +21 |-i: TypeAlias = (Foo | # TC007 x2 (fix removes comment currently) +22 |- Bar) + 21 |+i: TypeAlias = ("Foo | Bar") +23 22 | +24 23 | type C = Foo # OK +25 24 | type D = Foo | None # OK diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/rules/unused_arguments.rs b/crates/ruff_linter/src/rules/flake8_unused_arguments/rules/unused_arguments.rs index 6361f2d785644..d1216ba670d4d 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/rules/unused_arguments.rs +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/rules/unused_arguments.rs @@ -1,13 +1,11 @@ -use regex::Regex; use ruff_python_ast as ast; use ruff_python_ast::{Parameter, Parameters, Stmt, StmtExpr, StmtFunctionDef, StmtRaise}; -use ruff_diagnostics::DiagnosticKind; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::{function_type, visibility}; use ruff_python_semantic::{Scope, ScopeKind, SemanticModel}; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::registry::Rule; @@ -19,6 +17,10 @@ use crate::registry::Rule; /// An argument that is defined but not used is likely a mistake, and should /// be removed to avoid confusion. /// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// /// ## Example /// ```python /// def foo(bar, baz): @@ -30,8 +32,11 @@ use crate::registry::Rule; /// def foo(bar): /// return bar * 2 /// ``` -#[violation] -pub struct UnusedFunctionArgument { +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedFunctionArgument { name: String, } @@ -50,6 +55,10 @@ impl Violation for UnusedFunctionArgument { /// An argument that is defined but not used is likely a mistake, and should /// be removed to avoid confusion. /// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// /// ## Example /// ```python /// class Class: @@ -63,8 +72,11 @@ impl Violation for UnusedFunctionArgument { /// def foo(self, arg1): /// print(arg1) /// ``` -#[violation] -pub struct UnusedMethodArgument { +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedMethodArgument { name: String, } @@ -83,6 +95,10 @@ impl Violation for UnusedMethodArgument { /// An argument that is defined but not used is likely a mistake, and should /// be removed to avoid confusion. /// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// /// ## Example /// ```python /// class Class: @@ -98,8 +114,11 @@ impl Violation for UnusedMethodArgument { /// def foo(cls, arg1): /// print(arg1) /// ``` -#[violation] -pub struct UnusedClassMethodArgument { +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedClassMethodArgument { name: String, } @@ -118,6 +137,10 @@ impl Violation for UnusedClassMethodArgument { /// An argument that is defined but not used is likely a mistake, and should /// be removed to avoid confusion. /// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// /// ## Example /// ```python /// class Class: @@ -129,12 +152,15 @@ impl Violation for UnusedClassMethodArgument { /// Use instead: /// ```python /// class Class: -/// @static +/// @staticmethod /// def foo(arg1): /// print(arg1) /// ``` -#[violation] -pub struct UnusedStaticMethodArgument { +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedStaticMethodArgument { name: String, } @@ -154,6 +180,10 @@ impl Violation for UnusedStaticMethodArgument { /// An argument that is defined but not used is likely a mistake, and should /// be removed to avoid confusion. /// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// /// ## Example /// ```python /// my_list = [1, 2, 3, 4, 5] @@ -165,8 +195,11 @@ impl Violation for UnusedStaticMethodArgument { /// my_list = [1, 2, 3, 4, 5] /// squares = map(lambda x: x**2, my_list) /// ``` -#[violation] -pub struct UnusedLambdaArgument { +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedLambdaArgument { name: String, } @@ -189,13 +222,13 @@ enum Argumentable { } impl Argumentable { - fn check_for(self, name: String) -> DiagnosticKind { + fn check_for(self, name: String, range: TextRange) -> Diagnostic { match self { - Self::Function => UnusedFunctionArgument { name }.into(), - Self::Method => UnusedMethodArgument { name }.into(), - Self::ClassMethod => UnusedClassMethodArgument { name }.into(), - Self::StaticMethod => UnusedStaticMethodArgument { name }.into(), - Self::Lambda => UnusedLambdaArgument { name }.into(), + Self::Function => Diagnostic::new(UnusedFunctionArgument { name }, range), + Self::Method => Diagnostic::new(UnusedMethodArgument { name }, range), + Self::ClassMethod => Diagnostic::new(UnusedClassMethodArgument { name }, range), + Self::StaticMethod => Diagnostic::new(UnusedStaticMethodArgument { name }, range), + Self::Lambda => Diagnostic::new(UnusedLambdaArgument { name }, range), } } @@ -211,15 +244,11 @@ impl Argumentable { } /// Check a plain function for unused arguments. -fn function( - argumentable: Argumentable, - parameters: &Parameters, - scope: &Scope, - semantic: &SemanticModel, - dummy_variable_rgx: &Regex, - ignore_variadic_names: bool, - diagnostics: &mut Vec<Diagnostic>, -) { +fn function(argumentable: Argumentable, parameters: &Parameters, scope: &Scope, checker: &Checker) { + let ignore_variadic_names = checker + .settings + .flake8_unused_arguments + .ignore_variadic_names; let args = parameters .iter_non_variadic_params() .map(|parameter_with_default| ¶meter_with_default.parameter) @@ -237,26 +266,15 @@ fn function( .into_iter() .skip(usize::from(ignore_variadic_names)), ); - call( - argumentable, - args, - scope, - semantic, - dummy_variable_rgx, - diagnostics, - ); + call(argumentable, args, scope, checker); } /// Check a method for unused arguments. -fn method( - argumentable: Argumentable, - parameters: &Parameters, - scope: &Scope, - semantic: &SemanticModel, - dummy_variable_rgx: &Regex, - ignore_variadic_names: bool, - diagnostics: &mut Vec<Diagnostic>, -) { +fn method(argumentable: Argumentable, parameters: &Parameters, scope: &Scope, checker: &Checker) { + let ignore_variadic_names = checker + .settings + .flake8_unused_arguments + .ignore_variadic_names; let args = parameters .iter_non_variadic_params() .skip(1) @@ -275,40 +293,32 @@ fn method( .into_iter() .skip(usize::from(ignore_variadic_names)), ); - call( - argumentable, - args, - scope, - semantic, - dummy_variable_rgx, - diagnostics, - ); + call(argumentable, args, scope, checker); } fn call<'a>( argumentable: Argumentable, parameters: impl Iterator<Item = &'a Parameter>, scope: &Scope, - semantic: &SemanticModel, - dummy_variable_rgx: &Regex, - diagnostics: &mut Vec<Diagnostic>, + checker: &Checker, ) { - diagnostics.extend(parameters.filter_map(|arg| { - let binding = scope - .get(arg.name.as_str()) - .map(|binding_id| semantic.binding(binding_id))?; + let semantic = checker.semantic(); + let dummy_variable_rgx = &checker.settings.dummy_variable_rgx; + for arg in parameters { + let Some(binding) = scope + .get(arg.name()) + .map(|binding_id| semantic.binding(binding_id)) + else { + continue; + }; if binding.kind.is_argument() && binding.is_unused() - && !dummy_variable_rgx.is_match(arg.name.as_str()) + && !dummy_variable_rgx.is_match(arg.name()) { - Some(Diagnostic::new( - argumentable.check_for(arg.name.to_string()), - binding.range(), - )) - } else { - None + checker + .report_diagnostic(argumentable.check_for(arg.name.to_string(), binding.range())); } - })); + } } /// Returns `true` if a function appears to be a base class stub. In other @@ -324,7 +334,7 @@ fn call<'a>( /// /// [`is_stub`]: function_type::is_stub /// [`EM101`]: https://docs.astral.sh/ruff/rules/raw-string-in-exception/ -fn is_not_implemented_stub_with_variable( +pub(crate) fn is_not_implemented_stub_with_variable( function_def: &StmtFunctionDef, semantic: &SemanticModel, ) -> bool { @@ -334,10 +344,13 @@ fn is_not_implemented_stub_with_variable( _ => &function_def.body, }; - let [Stmt::Assign(ast::StmtAssign { targets, value, .. }), Stmt::Raise(StmtRaise { - exc: Some(exception), - .. - })] = statements + let [ + Stmt::Assign(ast::StmtAssign { targets, value, .. }), + Stmt::Raise(StmtRaise { + exc: Some(exception), + .. + }), + ] = statements else { return false; }; @@ -369,11 +382,7 @@ fn is_not_implemented_stub_with_variable( } /// ARG001, ARG002, ARG003, ARG004, ARG005 -pub(crate) fn unused_arguments( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_arguments(checker: &Checker, scope: &Scope) { if scope.uses_locals() { return; } @@ -405,18 +414,7 @@ pub(crate) fn unused_arguments( && !is_not_implemented_stub_with_variable(function_def, checker.semantic()) && !visibility::is_overload(decorator_list, checker.semantic()) { - function( - Argumentable::Function, - parameters, - scope, - checker.semantic(), - &checker.settings.dummy_variable_rgx, - checker - .settings - .flake8_unused_arguments - .ignore_variadic_names, - diagnostics, - ); + function(Argumentable::Function, parameters, scope, checker); } } function_type::FunctionType::Method => { @@ -425,24 +423,12 @@ pub(crate) fn unused_arguments( && !is_not_implemented_stub_with_variable(function_def, checker.semantic()) && (!visibility::is_magic(name) || visibility::is_init(name) - || visibility::is_new(name) || visibility::is_call(name)) && !visibility::is_abstract(decorator_list, checker.semantic()) && !visibility::is_override(decorator_list, checker.semantic()) && !visibility::is_overload(decorator_list, checker.semantic()) { - method( - Argumentable::Method, - parameters, - scope, - checker.semantic(), - &checker.settings.dummy_variable_rgx, - checker - .settings - .flake8_unused_arguments - .ignore_variadic_names, - diagnostics, - ); + method(Argumentable::Method, parameters, scope, checker); } } function_type::FunctionType::ClassMethod => { @@ -451,24 +437,12 @@ pub(crate) fn unused_arguments( && !is_not_implemented_stub_with_variable(function_def, checker.semantic()) && (!visibility::is_magic(name) || visibility::is_init(name) - || visibility::is_new(name) || visibility::is_call(name)) && !visibility::is_abstract(decorator_list, checker.semantic()) && !visibility::is_override(decorator_list, checker.semantic()) && !visibility::is_overload(decorator_list, checker.semantic()) { - method( - Argumentable::ClassMethod, - parameters, - scope, - checker.semantic(), - &checker.settings.dummy_variable_rgx, - checker - .settings - .flake8_unused_arguments - .ignore_variadic_names, - diagnostics, - ); + method(Argumentable::ClassMethod, parameters, scope, checker); } } function_type::FunctionType::StaticMethod => { @@ -477,24 +451,25 @@ pub(crate) fn unused_arguments( && !is_not_implemented_stub_with_variable(function_def, checker.semantic()) && (!visibility::is_magic(name) || visibility::is_init(name) - || visibility::is_new(name) || visibility::is_call(name)) && !visibility::is_abstract(decorator_list, checker.semantic()) && !visibility::is_override(decorator_list, checker.semantic()) && !visibility::is_overload(decorator_list, checker.semantic()) { - function( - Argumentable::StaticMethod, - parameters, - scope, - checker.semantic(), - &checker.settings.dummy_variable_rgx, - checker - .settings - .flake8_unused_arguments - .ignore_variadic_names, - diagnostics, - ); + function(Argumentable::StaticMethod, parameters, scope, checker); + } + } + function_type::FunctionType::NewMethod => { + if checker.enabled(Argumentable::StaticMethod.rule_code()) + && !function_type::is_stub(function_def, checker.semantic()) + && !is_not_implemented_stub_with_variable(function_def, checker.semantic()) + && !visibility::is_abstract(decorator_list, checker.semantic()) + && !visibility::is_override(decorator_list, checker.semantic()) + && !visibility::is_overload(decorator_list, checker.semantic()) + { + // we use `method()` here rather than `function()`, as although `__new__` is + // an implicit staticmethod, `__new__` methods must always have at least one parameter + method(Argumentable::StaticMethod, parameters, scope, checker); } } } @@ -502,18 +477,7 @@ pub(crate) fn unused_arguments( ScopeKind::Lambda(ast::ExprLambda { parameters, .. }) => { if let Some(parameters) = parameters { if checker.enabled(Argumentable::Lambda.rule_code()) { - function( - Argumentable::Lambda, - parameters, - scope, - checker.semantic(), - &checker.settings.dummy_variable_rgx, - checker - .settings - .flake8_unused_arguments - .ignore_variadic_names, - diagnostics, - ); + function(Argumentable::Lambda, parameters, scope, checker); } } } diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG001_ARG.py.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG001_ARG.py.snap index 0b65aed7a13d0..f53c64b064c69 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG001_ARG.py.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG001_ARG.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_unused_arguments/mod.rs +snapshot_kind: text --- ARG.py:9:7: ARG001 Unused function argument: `self` | diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG002_ARG.py.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG002_ARG.py.snap index d04530343580f..3e1e19260a46b 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG002_ARG.py.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG002_ARG.py.snap @@ -13,7 +13,7 @@ ARG.py:37:17: ARG002 Unused method argument: `x` ARG.py:40:20: ARG002 Unused method argument: `x` | 38 | print("Hello, world!") -39 | +39 | 40 | def f(self, /, x): | ^ ARG002 41 | print("Hello, world!") @@ -22,7 +22,7 @@ ARG.py:40:20: ARG002 Unused method argument: `x` ARG.py:43:16: ARG002 Unused method argument: `x` | 41 | print("Hello, world!") -42 | +42 | 43 | def f(cls, x): | ^ ARG002 44 | print("Hello, world!") @@ -31,7 +31,7 @@ ARG.py:43:16: ARG002 Unused method argument: `x` ARG.py:58:17: ARG002 Unused method argument: `x` | 56 | print("Hello, world!") -57 | +57 | 58 | def f(self, x): | ^ ARG002 59 | msg[0] = "..." @@ -41,7 +41,7 @@ ARG.py:58:17: ARG002 Unused method argument: `x` ARG.py:62:17: ARG002 Unused method argument: `x` | 60 | raise NotImplementedError(msg) -61 | +61 | 62 | def f(self, x): | ^ ARG002 63 | msg = "..." @@ -51,18 +51,18 @@ ARG.py:62:17: ARG002 Unused method argument: `x` ARG.py:66:17: ARG002 Unused method argument: `x` | 64 | raise NotImplementedError(foo) -65 | +65 | 66 | def f(self, x): | ^ ARG002 67 | msg = "..." 68 | raise NotImplementedError("must use msg") | -ARG.py:213:24: ARG002 Unused method argument: `x` +ARG.py:216:24: ARG002 Unused method argument: `x` | -211 | ### -212 | class C: -213 | def __init__(self, x) -> None: - | ^ ARG002 214 | print("Hello, world!") +215 | +216 | def __init__(self, x) -> None: + | ^ ARG002 +217 | print("Hello, world!") | diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG003_ARG.py.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG003_ARG.py.snap index 39f89b091be0b..c0187e8c67e48 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG003_ARG.py.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG003_ARG.py.snap @@ -8,5 +8,3 @@ ARG.py:47:16: ARG003 Unused class method argument: `x` | ^ ARG003 48 | print("Hello, world!") | - - diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG004_ARG.py.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG004_ARG.py.snap index b1b046fe91c76..da31a5449af9a 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG004_ARG.py.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG004_ARG.py.snap @@ -25,4 +25,11 @@ ARG.py:55:11: ARG004 Unused static method argument: `x` 56 | print("Hello, world!") | - +ARG.py:213:22: ARG004 Unused static method argument: `x` + | +211 | ### +212 | class C: +213 | def __new__(cls, x): + | ^ ARG004 +214 | print("Hello, world!") + | diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG005_ARG.py.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG005_ARG.py.snap index 3a8fb2cf56795..db2dbbab7851a 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG005_ARG.py.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ARG005_ARG.py.snap @@ -7,8 +7,6 @@ ARG.py:28:8: ARG005 Unused lambda argument: `x` 27 | ### 28 | lambda x: print("Hello, world!") | ^ ARG005 -29 | +29 | 30 | lambda: print("Hello, world!") | - - diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__enforce_variadic_names.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__enforce_variadic_names.snap index e8d246aa94a83..430bd44bb2d03 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__enforce_variadic_names.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__enforce_variadic_names.snap @@ -62,7 +62,7 @@ ignore_variadic_names.py:10:20: ARG002 Unused method argument: `b` ignore_variadic_names.py:13:17: ARG002 Unused method argument: `a` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^ ARG002 14 | print("Hello, world!") @@ -71,7 +71,7 @@ ignore_variadic_names.py:13:17: ARG002 Unused method argument: `a` ignore_variadic_names.py:13:20: ARG002 Unused method argument: `b` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^ ARG002 14 | print("Hello, world!") @@ -80,7 +80,7 @@ ignore_variadic_names.py:13:20: ARG002 Unused method argument: `b` ignore_variadic_names.py:13:24: ARG002 Unused method argument: `args` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^^^^ ARG002 14 | print("Hello, world!") @@ -89,10 +89,8 @@ ignore_variadic_names.py:13:24: ARG002 Unused method argument: `args` ignore_variadic_names.py:13:32: ARG002 Unused method argument: `kwargs` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^^^^^^ ARG002 14 | print("Hello, world!") | - - diff --git a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ignore_variadic_names.snap b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ignore_variadic_names.snap index d22cfbe1f5d94..16e2230d2c832 100644 --- a/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ignore_variadic_names.snap +++ b/crates/ruff_linter/src/rules/flake8_unused_arguments/snapshots/ruff_linter__rules__flake8_unused_arguments__tests__ignore_variadic_names.snap @@ -48,7 +48,7 @@ ignore_variadic_names.py:10:20: ARG002 Unused method argument: `b` ignore_variadic_names.py:13:17: ARG002 Unused method argument: `a` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^ ARG002 14 | print("Hello, world!") @@ -57,10 +57,8 @@ ignore_variadic_names.py:13:17: ARG002 Unused method argument: `a` ignore_variadic_names.py:13:20: ARG002 Unused method argument: `b` | 11 | print("Hello, world!") -12 | +12 | 13 | def f(self, a, b, *args, **kwargs): | ^ ARG002 14 | print("Hello, world!") | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs index 01b1ae356800e..fcb05b3f0923f 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs @@ -63,6 +63,9 @@ mod tests { #[test_case(Rule::OsPathGetctime, Path::new("PTH205.py"))] #[test_case(Rule::OsSepSplit, Path::new("PTH206.py"))] #[test_case(Rule::Glob, Path::new("PTH207.py"))] + #[test_case(Rule::OsListdir, Path::new("PTH208.py"))] + #[test_case(Rule::InvalidPathlibWithSuffix, Path::new("PTH210.py"))] + #[test_case(Rule::InvalidPathlibWithSuffix, Path::new("PTH210_1.py"))] fn rules_pypath(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/glob_rule.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/glob_rule.rs index 4a09654faafd7..64f514f9d540a 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/glob_rule.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/glob_rule.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does -/// Checks for the use of `glob` and `iglob`. +/// Checks for the use of `glob.glob()` and `glob.iglob()`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to @@ -12,37 +12,45 @@ use ruff_macros::{derive_message_formats, violation}; /// improve readability over their low-level counterparts (e.g., /// `glob.glob()`). /// -/// Note that `glob.glob` and `Path.glob` are not exact equivalents: +/// Note that `glob.glob()` and `Path.glob()` are not exact equivalents: /// -/// | | `glob` | `Path.glob` | -/// |-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| -/// | Hidden files | Excludes hidden files by default. From Python 3.11 onwards, the `include_hidden` keyword can be used to include hidden directories. | Includes hidden files by default. | -/// | Iterator | `iglob` returns an iterator. Under the hood, `glob` simply converts the iterator to a list. | `Path.glob` returns an iterator. | -/// | Working directory | `glob` takes a `root_dir` keyword to set the current working directory. | `Path.rglob` can be used to return the relative path. | -/// | Globstar (`**`) | `glob` requires the `recursive` flag to be set to `True` for the `**` pattern to match any files and zero or more directories, subdirectories, and symbolic links. | The `**` pattern in `Path.glob` means "this directory and all subdirectories, recursively". In other words, it enables recursive globbing. | +/// | | `glob`-module functions | `Path.glob()` | +/// |-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +/// | Hidden files | Hidden files are excluded by default. On Python 3.11+, the `include_hidden` keyword can be used to include hidden directories. | Includes hidden files by default. | +/// | Eagerness | `glob.iglob()` returns a lazy iterator. Under the hood, `glob.glob()` simply converts the iterator to a list. | `Path.glob()` returns a lazy iterator. | +/// | Working directory | `glob.glob()` and `glob.iglob()` take a `root_dir` keyword to set the current working directory. | `Path.rglob()` can be used to return the relative path. | +/// | Globstar (`**`) | The `recursive` flag must be set to `True` for the `**` pattern to match any files and zero or more directories, subdirectories, and symbolic links. | The `**` pattern in `Path.glob()` means "this directory and all subdirectories, recursively". In other words, it enables recursive globbing. | /// /// ## Example /// ```python /// import glob /// import os /// -/// glob.glob(os.path.join(path, "requirements*.txt")) +/// glob.glob(os.path.join("my_path", "requirements*.txt")) /// ``` /// /// Use instead: /// ```python /// from pathlib import Path /// -/// Path(path).glob("requirements*.txt") +/// Path("my_path").glob("requirements*.txt") /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.glob`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.glob) /// - [Python documentation: `Path.rglob`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.rglob) /// - [Python documentation: `glob.glob`](https://docs.python.org/3/library/glob.html#glob.glob) /// - [Python documentation: `glob.iglob`](https://docs.python.org/3/library/glob.html#glob.iglob) -#[violation] -pub struct Glob { +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) +/// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) +/// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) +#[derive(ViolationMetadata)] +pub(crate) struct Glob { pub function: String, } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/invalid_pathlib_with_suffix.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/invalid_pathlib_with_suffix.rs new file mode 100644 index 0000000000000..a3afa9374c1da --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/invalid_pathlib_with_suffix.rs @@ -0,0 +1,140 @@ +use crate::checkers::ast::Checker; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, StringFlags}; +use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for `pathlib.Path.with_suffix()` calls where +/// the given suffix does not have a leading dot +/// or the given suffix is a single dot `"."`. +/// +/// ## Why is this bad? +/// `Path.with_suffix()` will raise an error at runtime +/// if the given suffix is not prefixed with a dot +/// or it is a single dot `"."`. +/// +/// ## Example +/// +/// ```python +/// path.with_suffix("py") +/// ``` +/// +/// Use instead: +/// +/// ```python +/// path.with_suffix(".py") +/// ``` +/// +/// ## Known problems +/// This rule is likely to have false negatives, as Ruff can only emit the +/// lint if it can say for sure that a binding refers to a `Path` object at +/// runtime. Due to type inference limitations, Ruff is currently only +/// confident about this if it can see that the binding originates from a +/// function parameter annotated with `Path` or from a direct assignment to a +/// `Path()` constructor call. +/// +/// ## Fix safety +/// The fix for this rule adds a leading period to the string passed +/// to the `with_suffix()` call. This fix is marked as unsafe, as it +/// changes runtime behaviour: the call would previously always have +/// raised an exception, but no longer will. +/// +/// Moreover, it's impossible to determine if this is the correct fix +/// for a given situation (it's possible that the string was correct +/// but was being passed to the wrong method entirely, for example). +/// +/// No fix is offered if the suffix `"."` is given, since the intent is unclear. +#[derive(ViolationMetadata)] +pub(crate) struct InvalidPathlibWithSuffix { + // TODO: Since "." is a correct suffix in Python 3.14, + // we will need to update this rule and documentation + // once Ruff supports Python 3.14. + single_dot: bool, +} + +impl Violation for InvalidPathlibWithSuffix { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + if self.single_dot { + "Invalid suffix passed to `.with_suffix()`".to_string() + } else { + "Dotless suffix passed to `.with_suffix()`".to_string() + } + } + + fn fix_title(&self) -> Option<String> { + let title = if self.single_dot { + "Remove \".\" or extend to valid suffix" + } else { + "Add a leading dot" + }; + Some(title.to_string()) + } +} + +/// PTH210 +pub(crate) fn invalid_pathlib_with_suffix(checker: &Checker, call: &ast::ExprCall) { + let (func, arguments) = (&call.func, &call.arguments); + + if !is_path_with_suffix_call(checker.semantic(), func) { + return; + } + + if arguments.len() > 1 { + return; + } + + let Some(ast::Expr::StringLiteral(string)) = arguments.find_argument_value("suffix", 0) else { + return; + }; + + let string_value = string.value.to_str(); + + if string_value.is_empty() { + return; + } + + if string_value.starts_with('.') && string_value.len() > 1 { + return; + } + + let [first_part, ..] = string.value.as_slice() else { + return; + }; + + let single_dot = string_value == "."; + let mut diagnostic = Diagnostic::new(InvalidPathlibWithSuffix { single_dot }, call.range); + if !single_dot { + let after_leading_quote = string.start() + first_part.flags.opener_len(); + diagnostic.set_fix(Fix::unsafe_edit(Edit::insertion( + ".".to_string(), + after_leading_quote, + ))); + } + + checker.report_diagnostic(diagnostic); +} + +fn is_path_with_suffix_call(semantic: &SemanticModel, func: &ast::Expr) -> bool { + let ast::Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func else { + return false; + }; + + if attr != "with_suffix" { + return false; + } + + let ast::Expr::Name(name) = &**value else { + return false; + }; + let Some(binding) = semantic.only_binding(name).map(|id| semantic.binding(id)) else { + return false; + }; + + typing::is_pathlib_path(binding, semantic) +} diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/mod.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/mod.rs index 77b75be4840c4..f009855154a44 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/mod.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/mod.rs @@ -1,4 +1,5 @@ pub(crate) use glob_rule::*; +pub(crate) use invalid_pathlib_with_suffix::*; pub(crate) use os_path_getatime::*; pub(crate) use os_path_getctime::*; pub(crate) use os_path_getmtime::*; @@ -8,6 +9,7 @@ pub(crate) use path_constructor_current_directory::*; pub(crate) use replaceable_by_pathlib::*; mod glob_rule; +mod invalid_pathlib_with_suffix; mod os_path_getatime; mod os_path_getctime; mod os_path_getmtime; diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs index 965a35ab8cc0d..c9655d8944125 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getatime.rs @@ -1,21 +1,18 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `os.path.getatime`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. +/// the lower-level API offered by `os.path`. /// /// When possible, using `Path` object methods such as `Path.stat()` can -/// improve readability over the `os` module's counterparts (e.g., +/// improve readability over the `os.path` module's counterparts (e.g., /// `os.path.getatime()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// -/// ## Examples +/// ## Example /// ```python /// import os /// @@ -29,19 +26,24 @@ use ruff_macros::{derive_message_formats, violation}; /// Path(__file__).stat().st_atime /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.stat`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) /// - [Python documentation: `os.path.getatime`](https://docs.python.org/3/library/os.path.html#os.path.getatime) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathGetatime; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathGetatime; impl Violation for OsPathGetatime { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.getatime` should be replaced by `Path.stat().st_atime`") + "`os.path.getatime` should be replaced by `Path.stat().st_atime`".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getctime.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getctime.rs index d8b8e186e92a6..a7e2fdb58dc53 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getctime.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getctime.rs @@ -1,21 +1,18 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `os.path.getctime`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. +/// the lower-level API offered by `os.path`. /// /// When possible, using `Path` object methods such as `Path.stat()` can -/// improve readability over the `os` module's counterparts (e.g., +/// improve readability over the `os.path` module's counterparts (e.g., /// `os.path.getctime()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// -/// ## Examples +/// ## Example /// ```python /// import os /// @@ -29,19 +26,24 @@ use ruff_macros::{derive_message_formats, violation}; /// Path(__file__).stat().st_ctime /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.stat`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) /// - [Python documentation: `os.path.getctime`](https://docs.python.org/3/library/os.path.html#os.path.getctime) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathGetctime; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathGetctime; impl Violation for OsPathGetctime { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.getctime` should be replaced by `Path.stat().st_ctime`") + "`os.path.getctime` should be replaced by `Path.stat().st_ctime`".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getmtime.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getmtime.rs index 03f74e7b11b54..b9c84d0c3dcd5 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getmtime.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getmtime.rs @@ -1,21 +1,18 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `os.path.getmtime`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. +/// the lower-level API offered by `os.path`. /// /// When possible, using `Path` object methods such as `Path.stat()` can -/// improve readability over the `os` module's counterparts (e.g., +/// improve readability over the `os.path` module's counterparts (e.g., /// `os.path.getmtime()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// -/// ## Examples +/// ## Example /// ```python /// import os /// @@ -29,19 +26,24 @@ use ruff_macros::{derive_message_formats, violation}; /// Path(__file__).stat().st_mtime /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.stat`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) /// - [Python documentation: `os.path.getmtime`](https://docs.python.org/3/library/os.path.html#os.path.getmtime) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathGetmtime; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathGetmtime; impl Violation for OsPathGetmtime { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.getmtime` should be replaced by `Path.stat().st_mtime`") + "`os.path.getmtime` should be replaced by `Path.stat().st_mtime`".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getsize.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getsize.rs index 52721011d3f0c..829a5c4a721ed 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getsize.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_path_getsize.rs @@ -1,21 +1,18 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `os.path.getsize`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. +/// the lower-level API offered by `os.path`. /// /// When possible, using `Path` object methods such as `Path.stat()` can -/// improve readability over the `os` module's counterparts (e.g., +/// improve readability over the `os.path` module's counterparts (e.g., /// `os.path.getsize()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// -/// ## Examples +/// ## Example /// ```python /// import os /// @@ -29,19 +26,24 @@ use ruff_macros::{derive_message_formats, violation}; /// Path(__file__).stat().st_size /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.stat`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) /// - [Python documentation: `os.path.getsize`](https://docs.python.org/3/library/os.path.html#os.path.getsize) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathGetsize; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathGetsize; impl Violation for OsPathGetsize { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.getsize` should be replaced by `Path.stat().st_size`") + "`os.path.getsize` should be replaced by `Path.stat().st_size`".to_string() } } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_sep_split.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_sep_split.rs index c6dab7b57ea0d..27d74c80cbb8c 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_sep_split.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/os_sep_split.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprAttribute}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -42,18 +42,28 @@ use crate::checkers::ast::Checker; /// if any(part in blocklist for part in Path("my/file/path").parts): /// ... /// ``` -#[violation] -pub struct OsSepSplit; +/// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than working directly with strings, +/// especially on older versions of Python. +/// +/// ## References +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) +/// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) +/// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) +#[derive(ViolationMetadata)] +pub(crate) struct OsSepSplit; impl Violation for OsSepSplit { #[derive_message_formats] fn message(&self) -> String { - format!("Replace `.split(os.sep)` with `Path.parts`") + "Replace `.split(os.sep)` with `Path.parts`".to_string() } } /// PTH206 -pub(crate) fn os_sep_split(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn os_sep_split(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::OS) { return; } @@ -64,7 +74,7 @@ pub(crate) fn os_sep_split(checker: &mut Checker, call: &ast::ExprCall) { if attr.as_str() != "split" { return; - }; + } // Match `.split(os.sep)` or `.split(sep=os.sep)`, but avoid cases in which a `maxsplit` is // specified. @@ -72,7 +82,7 @@ pub(crate) fn os_sep_split(checker: &mut Checker, call: &ast::ExprCall) { return; } - let Some(sep) = call.arguments.find_argument("sep", 0) else { + let Some(sep) = call.arguments.find_argument_value("sep", 0) else { return; }; @@ -84,7 +94,5 @@ pub(crate) fn os_sep_split(checker: &mut Checker, call: &ast::ExprCall) { return; } - checker - .diagnostics - .push(Diagnostic::new(OsSepSplit, attr.range())); + checker.report_diagnostic(Diagnostic::new(OsSepSplit, attr.range())); } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/path_constructor_current_directory.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/path_constructor_current_directory.rs index 542c32dcc55de..e7c3a75fd4c29 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/path_constructor_current_directory.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/path_constructor_current_directory.rs @@ -1,8 +1,15 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, ExprCall}; +use std::ops::Range; + +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_ast::{Expr, ExprBinOp, ExprCall, Operator}; +use ruff_python_semantic::SemanticModel; +use ruff_python_trivia::CommentRanges; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for `pathlib.Path` objects that are initialized with the current @@ -28,13 +35,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path) -#[violation] -pub struct PathConstructorCurrentDirectory; +#[derive(ViolationMetadata)] +pub(crate) struct PathConstructorCurrentDirectory; impl AlwaysFixableViolation for PathConstructorCurrentDirectory { #[derive_message_formats] fn message(&self) -> String { - format!("Do not pass the current directory explicitly to `Path`") + "Do not pass the current directory explicitly to `Path`".to_string() } fn fix_title(&self) -> String { @@ -43,7 +50,17 @@ impl AlwaysFixableViolation for PathConstructorCurrentDirectory { } /// PTH201 -pub(crate) fn path_constructor_current_directory(checker: &mut Checker, expr: &Expr, func: &Expr) { +pub(crate) fn path_constructor_current_directory(checker: &Checker, call: &ExprCall) { + let applicability = |range| { + if checker.comment_ranges().intersects(range) { + Applicability::Unsafe + } else { + Applicability::Safe + } + }; + + let (func, arguments) = (&call.func, &call.arguments); + if !checker .semantic() .resolve_qualified_name(func) @@ -54,21 +71,69 @@ pub(crate) fn path_constructor_current_directory(checker: &mut Checker, expr: &E return; } - let Expr::Call(ExprCall { arguments, .. }) = expr else { + if !arguments.keywords.is_empty() { + return; + } + + let [Expr::StringLiteral(arg)] = &*arguments.args else { return; }; - if !arguments.keywords.is_empty() { + if !matches!(arg.value.to_str(), "" | ".") { return; } - let [Expr::StringLiteral(ast::ExprStringLiteral { value, range })] = &*arguments.args else { - return; + let mut diagnostic = Diagnostic::new(PathConstructorCurrentDirectory, arg.range()); + + match parent_and_next_path_fragment_range( + checker.semantic(), + checker.comment_ranges(), + checker.source(), + ) { + Some((parent_range, next_fragment_range)) => { + let next_fragment_expr = checker.locator().slice(next_fragment_range); + let call_expr = checker.locator().slice(call.range()); + + let relative_argument_range: Range<usize> = { + let range = arg.range() - call.start(); + range.start().into()..range.end().into() + }; + + let mut new_call_expr = call_expr.to_string(); + new_call_expr.replace_range(relative_argument_range, next_fragment_expr); + + let edit = Edit::range_replacement(new_call_expr, parent_range); + + diagnostic.set_fix(Fix::applicable_edit(edit, applicability(parent_range))); + } + None => diagnostic.try_set_fix(|| { + let edit = remove_argument(arg, arguments, Parentheses::Preserve, checker.source())?; + Ok(Fix::applicable_edit(edit, applicability(call.range()))) + }), + } + + checker.report_diagnostic(diagnostic); +} + +fn parent_and_next_path_fragment_range( + semantic: &SemanticModel, + comment_ranges: &CommentRanges, + source: &str, +) -> Option<(TextRange, TextRange)> { + let parent = semantic.current_expression_parent()?; + + let Expr::BinOp(parent @ ExprBinOp { op, right, .. }) = parent else { + return None; }; - if matches!(value.to_str(), "" | ".") { - let mut diagnostic = Diagnostic::new(PathConstructorCurrentDirectory, *range); - diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(*range))); - checker.diagnostics.push(diagnostic); + let range = right.range(); + + if !matches!(op, Operator::Div) { + return None; } + + Some(( + parent.range(), + parenthesized_range(right.into(), parent.into(), comment_ranges, source).unwrap_or(range), + )) } diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/replaceable_by_pathlib.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/replaceable_by_pathlib.rs index aa1db51279f61..22c62c06904f2 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/replaceable_by_pathlib.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/rules/replaceable_by_pathlib.rs @@ -1,7 +1,7 @@ -use ruff_diagnostics::{Diagnostic, DiagnosticKind}; +use ruff_diagnostics::Diagnostic; use ruff_python_ast::{self as ast, Expr, ExprBooleanLiteral, ExprCall}; -use ruff_python_semantic::analyze::typing; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -10,159 +10,304 @@ use crate::rules::flake8_use_pathlib::rules::{ Glob, OsPathGetatime, OsPathGetctime, OsPathGetmtime, OsPathGetsize, }; use crate::rules::flake8_use_pathlib::violations::{ - BuiltinOpen, Joiner, OsChmod, OsGetcwd, OsMakedirs, OsMkdir, OsPathAbspath, OsPathBasename, - OsPathDirname, OsPathExists, OsPathExpanduser, OsPathIsabs, OsPathIsdir, OsPathIsfile, - OsPathIslink, OsPathJoin, OsPathSamefile, OsPathSplitext, OsReadlink, OsRemove, OsRename, - OsReplace, OsRmdir, OsStat, OsUnlink, PyPath, + BuiltinOpen, Joiner, OsChmod, OsGetcwd, OsListdir, OsMakedirs, OsMkdir, OsPathAbspath, + OsPathBasename, OsPathDirname, OsPathExists, OsPathExpanduser, OsPathIsabs, OsPathIsdir, + OsPathIsfile, OsPathIslink, OsPathJoin, OsPathSamefile, OsPathSplitext, OsReadlink, OsRemove, + OsRename, OsReplace, OsRmdir, OsStat, OsUnlink, PyPath, }; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; + +pub(crate) fn replaceable_by_pathlib(checker: &Checker, call: &ExprCall) { + let Some(qualified_name) = checker.semantic().resolve_qualified_name(&call.func) else { + return; + }; -pub(crate) fn replaceable_by_pathlib(checker: &mut Checker, call: &ExprCall) { - if let Some(diagnostic_kind) = checker - .semantic() - .resolve_qualified_name(&call.func) - .and_then(|qualified_name| match qualified_name.segments() { - // PTH100 - ["os", "path", "abspath"] => Some(OsPathAbspath.into()), - // PTH101 - ["os", "chmod"] => Some(OsChmod.into()), - // PTH102 - ["os", "makedirs"] => Some(OsMakedirs.into()), - // PTH103 - ["os", "mkdir"] => Some(OsMkdir.into()), - // PTH104 - ["os", "rename"] => Some(OsRename.into()), - // PTH105 - ["os", "replace"] => Some(OsReplace.into()), - // PTH106 - ["os", "rmdir"] => Some(OsRmdir.into()), - // PTH107 - ["os", "remove"] => Some(OsRemove.into()), - // PTH108 - ["os", "unlink"] => Some(OsUnlink.into()), - // PTH109 - ["os", "getcwd"] => Some(OsGetcwd.into()), - ["os", "getcwdb"] => Some(OsGetcwd.into()), - // PTH110 - ["os", "path", "exists"] => Some(OsPathExists.into()), - // PTH111 - ["os", "path", "expanduser"] => Some(OsPathExpanduser.into()), - // PTH112 - ["os", "path", "isdir"] => Some(OsPathIsdir.into()), - // PTH113 - ["os", "path", "isfile"] => Some(OsPathIsfile.into()), - // PTH114 - ["os", "path", "islink"] => Some(OsPathIslink.into()), - // PTH116 - ["os", "stat"] => Some(OsStat.into()), - // PTH117 - ["os", "path", "isabs"] => Some(OsPathIsabs.into()), - // PTH118 - ["os", "path", "join"] => Some( - OsPathJoin { - module: "path".to_string(), - joiner: if call.arguments.args.iter().any(Expr::is_starred_expr) { - Joiner::Joinpath - } else { - Joiner::Slash - }, - } - .into(), - ), - ["os", "sep", "join"] => Some( - OsPathJoin { - module: "sep".to_string(), - joiner: if call.arguments.args.iter().any(Expr::is_starred_expr) { - Joiner::Joinpath - } else { - Joiner::Slash - }, - } - .into(), - ), - // PTH119 - ["os", "path", "basename"] => Some(OsPathBasename.into()), - // PTH120 - ["os", "path", "dirname"] => Some(OsPathDirname.into()), - // PTH121 - ["os", "path", "samefile"] => Some(OsPathSamefile.into()), - // PTH122 - ["os", "path", "splitext"] => Some(OsPathSplitext.into()), - // PTH202 - ["os", "path", "getsize"] => Some(OsPathGetsize.into()), - // PTH203 - ["os", "path", "getatime"] => Some(OsPathGetatime.into()), - // PTH204 - ["os", "path", "getmtime"] => Some(OsPathGetmtime.into()), - // PTH205 - ["os", "path", "getctime"] => Some(OsPathGetctime.into()), - // PTH123 - ["" | "builtin", "open"] => { - // `closefd` and `openener` are not supported by pathlib, so check if they are - // are set to non-default values. - // https://github.com/astral-sh/ruff/issues/7620 - // Signature as of Python 3.11 (https://docs.python.org/3/library/functions.html#open): - // ```text - // 0 1 2 3 4 5 - // open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, - // 6 7 - // closefd=True, opener=None) - // ^^^^ ^^^^ - // ``` - // For `pathlib` (https://docs.python.org/3/library/pathlib.html#pathlib.Path.open): - // ```text - // Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None) - // ``` - if call + let range = call.func.range(); + let diagnostic = match qualified_name.segments() { + // PTH100 + ["os", "path", "abspath"] => Diagnostic::new(OsPathAbspath, range), + // PTH101 + ["os", "chmod"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.chmod) + // ```text + // 0 1 2 3 + // os.chmod(path, mode, *, dir_fd=None, follow_symlinks=True) + // ``` + if call + .arguments + .find_argument_value("path", 0) + .is_some_and(|expr| is_file_descriptor(expr, checker.semantic())) + || is_argument_non_default(&call.arguments, "dir_fd", 2) + { + return; + } + Diagnostic::new(OsChmod, range) + } + // PTH102 + ["os", "makedirs"] => Diagnostic::new(OsMakedirs, range), + // PTH103 + ["os", "mkdir"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.mkdir) + // ```text + // 0 1 2 + // os.mkdir(path, mode=0o777, *, dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 2) { + return; + } + Diagnostic::new(OsMkdir, range) + } + // PTH104 + ["os", "rename"] => { + // `src_dir_fd` and `dst_dir_fd` are not supported by pathlib, so check if they are + // set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.rename) + // ```text + // 0 1 2 3 + // os.rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "src_dir_fd", 2) + || is_argument_non_default(&call.arguments, "dst_dir_fd", 3) + { + return; + } + Diagnostic::new(OsRename, range) + } + // PTH105 + ["os", "replace"] => { + // `src_dir_fd` and `dst_dir_fd` are not supported by pathlib, so check if they are + // set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.replace) + // ```text + // 0 1 2 3 + // os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "src_dir_fd", 2) + || is_argument_non_default(&call.arguments, "dst_dir_fd", 3) + { + return; + } + Diagnostic::new(OsReplace, range) + } + // PTH106 + ["os", "rmdir"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.rmdir) + // ```text + // 0 1 + // os.rmdir(path, *, dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 1) { + return; + } + Diagnostic::new(OsRmdir, range) + } + // PTH107 + ["os", "remove"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.remove) + // ```text + // 0 1 + // os.remove(path, *, dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 1) { + return; + } + Diagnostic::new(OsRemove, range) + } + // PTH108 + ["os", "unlink"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.unlink) + // ```text + // 0 1 + // os.unlink(path, *, dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 1) { + return; + } + Diagnostic::new(OsUnlink, range) + } + // PTH109 + ["os", "getcwd"] => Diagnostic::new(OsGetcwd, range), + ["os", "getcwdb"] => Diagnostic::new(OsGetcwd, range), + // PTH110 + ["os", "path", "exists"] => Diagnostic::new(OsPathExists, range), + // PTH111 + ["os", "path", "expanduser"] => Diagnostic::new(OsPathExpanduser, range), + // PTH112 + ["os", "path", "isdir"] => Diagnostic::new(OsPathIsdir, range), + // PTH113 + ["os", "path", "isfile"] => Diagnostic::new(OsPathIsfile, range), + // PTH114 + ["os", "path", "islink"] => Diagnostic::new(OsPathIslink, range), + // PTH116 + ["os", "stat"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.stat) + // ```text + // 0 1 2 + // os.stat(path, *, dir_fd=None, follow_symlinks=True) + // ``` + if call + .arguments + .find_argument_value("path", 0) + .is_some_and(|expr| is_file_descriptor(expr, checker.semantic())) + || is_argument_non_default(&call.arguments, "dir_fd", 1) + { + return; + } + Diagnostic::new(OsStat, range) + } + // PTH117 + ["os", "path", "isabs"] => Diagnostic::new(OsPathIsabs, range), + // PTH118 + ["os", "path", "join"] => Diagnostic::new( + OsPathJoin { + module: "path".to_string(), + joiner: if call.arguments.args.iter().any(Expr::is_starred_expr) { + Joiner::Joinpath + } else { + Joiner::Slash + }, + }, + range, + ), + ["os", "sep", "join"] => Diagnostic::new( + OsPathJoin { + module: "sep".to_string(), + joiner: if call.arguments.args.iter().any(Expr::is_starred_expr) { + Joiner::Joinpath + } else { + Joiner::Slash + }, + }, + range, + ), + // PTH119 + ["os", "path", "basename"] => Diagnostic::new(OsPathBasename, range), + // PTH120 + ["os", "path", "dirname"] => Diagnostic::new(OsPathDirname, range), + // PTH121 + ["os", "path", "samefile"] => Diagnostic::new(OsPathSamefile, range), + // PTH122 + ["os", "path", "splitext"] => Diagnostic::new(OsPathSplitext, range), + // PTH202 + ["os", "path", "getsize"] => Diagnostic::new(OsPathGetsize, range), + // PTH203 + ["os", "path", "getatime"] => Diagnostic::new(OsPathGetatime, range), + // PTH204 + ["os", "path", "getmtime"] => Diagnostic::new(OsPathGetmtime, range), + // PTH205 + ["os", "path", "getctime"] => Diagnostic::new(OsPathGetctime, range), + // PTH123 + ["" | "builtins", "open"] => { + // `closefd` and `opener` are not supported by pathlib, so check if they are + // are set to non-default values. + // https://github.com/astral-sh/ruff/issues/7620 + // Signature as of Python 3.11 (https://docs.python.org/3/library/functions.html#open): + // ```text + // 0 1 2 3 4 5 + // open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, + // 6 7 + // closefd=True, opener=None) + // ^^^^ ^^^^ + // ``` + // For `pathlib` (https://docs.python.org/3/library/pathlib.html#pathlib.Path.open): + // ```text + // Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None) + // ``` + if call + .arguments + .find_argument_value("closefd", 6) + .is_some_and(|expr| { + !matches!( + expr, + Expr::BooleanLiteral(ExprBooleanLiteral { value: true, .. }) + ) + }) + || is_argument_non_default(&call.arguments, "opener", 7) + || call .arguments - .find_argument("closefd", 6) - .is_some_and(|expr| { - !matches!( - expr, - Expr::BooleanLiteral(ExprBooleanLiteral { value: true, .. }) - ) - }) - || call - .arguments - .find_argument("opener", 7) - .is_some_and(|expr| !expr.is_none_literal_expr()) - || call - .arguments - .find_positional(0) - .is_some_and(|expr| is_file_descriptor(expr, checker.semantic())) - { - return None; - } - Some(BuiltinOpen.into()) + .find_argument_value("file", 0) + .is_some_and(|expr| is_file_descriptor(expr, checker.semantic())) + { + return; } - // PTH124 - ["py", "path", "local"] => Some(PyPath.into()), - // PTH207 - ["glob", "glob"] => Some( + Diagnostic::new(BuiltinOpen, range) + } + // PTH124 + ["py", "path", "local"] => Diagnostic::new(PyPath, range), + // PTH207 + ["glob", "glob"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/glob.html#glob.glob) + // ```text + // 0 1 2 3 4 + // glob.glob(pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 2) { + return; + } + + Diagnostic::new( Glob { function: "glob".to_string(), - } - .into(), - ), - ["glob", "iglob"] => Some( + }, + range, + ) + } + + ["glob", "iglob"] => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/glob.html#glob.iglob) + // ```text + // 0 1 2 3 4 + // glob.iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 2) { + return; + } + + Diagnostic::new( Glob { function: "iglob".to_string(), - } - .into(), - ), - // PTH115 - // Python 3.9+ - ["os", "readlink"] if checker.settings.target_version >= PythonVersion::Py39 => { - Some(OsReadlink.into()) + }, + range, + ) + } + // PTH115 + // Python 3.9+ + ["os", "readlink"] if checker.target_version() >= PythonVersion::PY39 => { + // `dir_fd` is not supported by pathlib, so check if it's set to non-default values. + // Signature as of Python 3.13 (https://docs.python.org/3/library/os.html#os.readlink) + // ```text + // 0 1 + // os.readlink(path, *, dir_fd=None) + // ``` + if is_argument_non_default(&call.arguments, "dir_fd", 1) { + return; } - _ => None, - }) - { - let diagnostic = Diagnostic::new::<DiagnosticKind>(diagnostic_kind, call.func.range()); - - if checker.enabled(diagnostic.kind.rule()) { - checker.diagnostics.push(diagnostic); + Diagnostic::new(OsReadlink, range) + } + // PTH208 + ["os", "listdir"] => { + if call + .arguments + .find_argument_value("path", 0) + .is_some_and(|expr| is_file_descriptor(expr, checker.semantic())) + { + return; + } + Diagnostic::new(OsListdir, range) } + _ => return, + }; + + if checker.enabled(diagnostic.rule()) { + checker.report_diagnostic(diagnostic); } } @@ -176,9 +321,9 @@ fn is_file_descriptor(expr: &Expr, semantic: &SemanticModel) -> bool { }) ) { return true; - }; + } - let Some(name) = expr.as_name_expr() else { + let Some(name) = get_name_expr(expr) else { return false; }; @@ -188,3 +333,18 @@ fn is_file_descriptor(expr: &Expr, semantic: &SemanticModel) -> bool { typing::is_int(binding, semantic) } + +fn get_name_expr(expr: &Expr) -> Option<&ast::ExprName> { + match expr { + Expr::Name(name) => Some(name), + Expr::Call(ast::ExprCall { func, .. }) => get_name_expr(func), + _ => None, + } +} + +/// Returns `true` if argument `name` is set to a non-default `None` value. +fn is_argument_non_default(arguments: &ast::Arguments, name: &str, position: usize) -> bool { + arguments + .find_argument_value(name, position) + .is_some_and(|expr| !expr.is_none_literal_expr()) +} diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_1.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_1.py.snap index d69400baf7c14..bea8d4778a18e 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_1.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_1.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs py_path_1.py:3:5: PTH124 `py.path` is in maintenance mode, use `pathlib` instead | 1 | import py -2 | +2 | 3 | p = py.path.local("../foo") | ^^^^^^^^^^^^^ PTH124 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_2.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_2.py.snap index a5f1a2cf926ec..f5b5e5c089e2f 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_2.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH124_py_path_2.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs py_path_2.py:3:5: PTH124 `py.path` is in maintenance mode, use `pathlib` instead | 1 | from py.path import local as path -2 | +2 | 3 | p = path("/foo") | ^^^^ PTH124 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH201_PTH201.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH201_PTH201.py.snap index 045e8c733ec8c..4165133a0177d 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH201_PTH201.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH201_PTH201.py.snap @@ -1,86 +1,327 @@ --- source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs --- -PTH201.py:5:10: PTH201 [*] Do not pass the current directory explicitly to `Path` +PTH201.py:6:10: PTH201 [*] Do not pass the current directory explicitly to `Path` | -4 | # match -5 | _ = Path(".") +5 | # match +6 | _ = Path(".") | ^^^ PTH201 -6 | _ = pth(".") -7 | _ = PurePath(".") +7 | _ = pth(".") +8 | _ = PurePath(".") | = help: Remove the current directory argument ℹ Safe fix -2 2 | from pathlib import Path as pth 3 3 | -4 4 | # match -5 |-_ = Path(".") - 5 |+_ = Path() -6 6 | _ = pth(".") -7 7 | _ = PurePath(".") -8 8 | _ = Path("") - -PTH201.py:6:9: PTH201 [*] Do not pass the current directory explicitly to `Path` +4 4 | +5 5 | # match +6 |-_ = Path(".") + 6 |+_ = Path() +7 7 | _ = pth(".") +8 8 | _ = PurePath(".") +9 9 | _ = Path("") + +PTH201.py:7:9: PTH201 [*] Do not pass the current directory explicitly to `Path` | -4 | # match -5 | _ = Path(".") -6 | _ = pth(".") +5 | # match +6 | _ = Path(".") +7 | _ = pth(".") | ^^^ PTH201 -7 | _ = PurePath(".") -8 | _ = Path("") +8 | _ = PurePath(".") +9 | _ = Path("") | = help: Remove the current directory argument ℹ Safe fix -3 3 | -4 4 | # match -5 5 | _ = Path(".") -6 |-_ = pth(".") - 6 |+_ = pth() -7 7 | _ = PurePath(".") -8 8 | _ = Path("") -9 9 | - -PTH201.py:7:14: PTH201 [*] Do not pass the current directory explicitly to `Path` +4 4 | +5 5 | # match +6 6 | _ = Path(".") +7 |-_ = pth(".") + 7 |+_ = pth() +8 8 | _ = PurePath(".") +9 9 | _ = Path("") +10 10 | + +PTH201.py:8:14: PTH201 [*] Do not pass the current directory explicitly to `Path` | -5 | _ = Path(".") -6 | _ = pth(".") -7 | _ = PurePath(".") +6 | _ = Path(".") +7 | _ = pth(".") +8 | _ = PurePath(".") | ^^^ PTH201 -8 | _ = Path("") +9 | _ = Path("") | = help: Remove the current directory argument ℹ Safe fix -4 4 | # match -5 5 | _ = Path(".") -6 6 | _ = pth(".") -7 |-_ = PurePath(".") - 7 |+_ = PurePath() -8 8 | _ = Path("") -9 9 | -10 10 | # no match - -PTH201.py:8:10: PTH201 [*] Do not pass the current directory explicitly to `Path` - | - 6 | _ = pth(".") - 7 | _ = PurePath(".") - 8 | _ = Path("") +5 5 | # match +6 6 | _ = Path(".") +7 7 | _ = pth(".") +8 |-_ = PurePath(".") + 8 |+_ = PurePath() +9 9 | _ = Path("") +10 10 | +11 11 | Path('', ) + +PTH201.py:9:10: PTH201 [*] Do not pass the current directory explicitly to `Path` + | + 7 | _ = pth(".") + 8 | _ = PurePath(".") + 9 | _ = Path("") | ^^ PTH201 - 9 | -10 | # no match +10 | +11 | Path('', ) + | + = help: Remove the current directory argument + +ℹ Safe fix +6 6 | _ = Path(".") +7 7 | _ = pth(".") +8 8 | _ = PurePath(".") +9 |-_ = Path("") + 9 |+_ = Path() +10 10 | +11 11 | Path('', ) +12 12 | + +PTH201.py:11:6: PTH201 [*] Do not pass the current directory explicitly to `Path` + | + 9 | _ = Path("") +10 | +11 | Path('', ) + | ^^ PTH201 +12 | +13 | Path( | = help: Remove the current directory argument ℹ Safe fix -5 5 | _ = Path(".") -6 6 | _ = pth(".") -7 7 | _ = PurePath(".") -8 |-_ = Path("") - 8 |+_ = Path() -9 9 | -10 10 | # no match -11 11 | _ = Path() +8 8 | _ = PurePath(".") +9 9 | _ = Path("") +10 10 | +11 |-Path('', ) + 11 |+Path() +12 12 | +13 13 | Path( +14 14 | '', + +PTH201.py:14:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +13 | Path( +14 | '', + | ^^ PTH201 +15 | ) + | + = help: Remove the current directory argument + +ℹ Safe fix +10 10 | +11 11 | Path('', ) +12 12 | +13 |-Path( +14 |- '', +15 |-) + 13 |+Path() +16 14 | +17 15 | Path( # Comment before argument +18 16 | '', + +PTH201.py:18:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +17 | Path( # Comment before argument +18 | '', + | ^^ PTH201 +19 | ) + | + = help: Remove the current directory argument + +ℹ Unsafe fix +14 14 | '', +15 15 | ) +16 16 | +17 |-Path( # Comment before argument +18 |- '', +19 |-) + 17 |+Path() +20 18 | +21 19 | Path( +22 20 | '', # EOL comment + +PTH201.py:22:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +21 | Path( +22 | '', # EOL comment + | ^^ PTH201 +23 | ) + | + = help: Remove the current directory argument + +ℹ Unsafe fix +18 18 | '', +19 19 | ) +20 20 | +21 |-Path( +22 |- '', # EOL comment +23 |-) + 21 |+Path() +24 22 | +25 23 | Path( +26 24 | '' # Comment in the middle of implicitly concatenated string + +PTH201.py:26:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +25 | Path( +26 | / '' # Comment in the middle of implicitly concatenated string +27 | | ".", + | |_______^ PTH201 +28 | ) + | + = help: Remove the current directory argument +ℹ Unsafe fix +22 22 | '', # EOL comment +23 23 | ) +24 24 | +25 |-Path( +26 |- '' # Comment in the middle of implicitly concatenated string +27 |- ".", +28 |-) + 25 |+Path() +29 26 | +30 27 | Path( +31 28 | '' # Comment before comma + +PTH201.py:31:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +30 | Path( +31 | '' # Comment before comma + | ^^ PTH201 +32 | , +33 | ) + | + = help: Remove the current directory argument + +ℹ Unsafe fix +27 27 | ".", +28 28 | ) +29 29 | +30 |-Path( +31 |- '' # Comment before comma +32 |- , +33 |-) + 30 |+Path() +34 31 | +35 32 | Path( +36 33 | '', + +PTH201.py:36:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +35 | Path( +36 | '', + | ^^ PTH201 +37 | ) / "bare" + | + = help: Remove the current directory argument + +ℹ Safe fix +33 33 | ) +34 34 | +35 35 | Path( +36 |- '', +37 |-) / "bare" + 36 |+ "bare", + 37 |+) +38 38 | +39 39 | Path( # Comment before argument +40 40 | '', + +PTH201.py:40:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +39 | Path( # Comment before argument +40 | '', + | ^^ PTH201 +41 | ) / ("parenthesized") + | + = help: Remove the current directory argument + +ℹ Unsafe fix +37 37 | ) / "bare" +38 38 | +39 39 | Path( # Comment before argument +40 |- '', +41 |-) / ("parenthesized") + 40 |+ ("parenthesized"), + 41 |+) +42 42 | +43 43 | Path( +44 44 | '', # EOL comment + +PTH201.py:44:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +43 | Path( +44 | '', # EOL comment + | ^^ PTH201 +45 | ) / ( ("double parenthesized" ) ) + | + = help: Remove the current directory argument + +ℹ Unsafe fix +41 41 | ) / ("parenthesized") +42 42 | +43 43 | Path( +44 |- '', # EOL comment +45 |-) / ( ("double parenthesized" ) ) + 44 |+ ( ("double parenthesized" ) ), # EOL comment + 45 |+) +46 46 | +47 47 | ( Path( +48 48 | '' # Comment in the middle of implicitly concatenated string + +PTH201.py:48:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +47 | ( Path( +48 | / '' # Comment in the middle of implicitly concatenated string +49 | | ".", + | |_______^ PTH201 +50 | ) )/ (("parenthesized path call") +51 | # Comment between closing parentheses + | + = help: Remove the current directory argument + +ℹ Unsafe fix +44 44 | '', # EOL comment +45 45 | ) / ( ("double parenthesized" ) ) +46 46 | +47 |-( Path( +48 |- '' # Comment in the middle of implicitly concatenated string +49 |- ".", +50 |-) )/ (("parenthesized path call") + 47 |+Path( + 48 |+ (("parenthesized path call") +51 49 | # Comment between closing parentheses + 50 |+), +52 51 | ) +53 52 | +54 53 | Path( + +PTH201.py:55:5: PTH201 [*] Do not pass the current directory explicitly to `Path` + | +54 | Path( +55 | '' # Comment before comma + | ^^ PTH201 +56 | , +57 | ) / "multiple" / ( + | + = help: Remove the current directory argument +ℹ Unsafe fix +52 52 | ) +53 53 | +54 54 | Path( +55 |- '' # Comment before comma + 55 |+ "multiple" # Comment before comma +56 56 | , +57 |-) / "multiple" / ( + 57 |+) / ( +58 58 | "frag" # Comment +59 59 | 'ment' +60 60 | ) diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH202_PTH202.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH202_PTH202.py.snap index 033a2d511e07c..4f2fd0ce76387 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH202_PTH202.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH202_PTH202.py.snap @@ -33,14 +33,14 @@ PTH202.py:9:1: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_si 8 | os.path.getsize(Path("filename")) 9 | os.path.getsize(__file__) | ^^^^^^^^^^^^^^^ PTH202 -10 | +10 | 11 | getsize("filename") | PTH202.py:11:1: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_size` | 9 | os.path.getsize(__file__) -10 | +10 | 11 | getsize("filename") | ^^^^^^^ PTH202 12 | getsize(b"filename") @@ -72,5 +72,3 @@ PTH202.py:14:1: PTH202 `os.path.getsize` should be replaced by `Path.stat().st_s 14 | getsize(__file__) | ^^^^^^^ PTH202 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH203_PTH203.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH203_PTH203.py.snap index db0681da91915..8851d9d32ab15 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH203_PTH203.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH203_PTH203.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs PTH203.py:5:1: PTH203 `os.path.getatime` should be replaced by `Path.stat().st_atime` | 3 | from os.path import getatime -4 | +4 | 5 | os.path.getatime("filename") | ^^^^^^^^^^^^^^^^ PTH203 6 | os.path.getatime(b"filename") @@ -50,5 +50,3 @@ PTH203.py:12:1: PTH203 `os.path.getatime` should be replaced by `Path.stat().st_ 12 | getatime(Path("filename")) | ^^^^^^^^ PTH203 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH204_PTH204.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH204_PTH204.py.snap index 1451bdb737981..b137cbd772ff7 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH204_PTH204.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH204_PTH204.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +snapshot_kind: text --- PTH204.py:6:1: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_mtime` | @@ -48,5 +49,3 @@ PTH204.py:13:1: PTH204 `os.path.getmtime` should be replaced by `Path.stat().st_ 13 | getmtime(Path("filename")) | ^^^^^^^^ PTH204 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH205_PTH205.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH205_PTH205.py.snap index 5afa0f483a63a..3edeac694e549 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH205_PTH205.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH205_PTH205.py.snap @@ -23,14 +23,14 @@ PTH205.py:8:1: PTH205 `os.path.getctime` should be replaced by `Path.stat().st_c 7 | os.path.getctime(b"filename") 8 | os.path.getctime(Path("filename")) | ^^^^^^^^^^^^^^^^ PTH205 - 9 | + 9 | 10 | getctime("filename") | PTH205.py:10:1: PTH205 `os.path.getctime` should be replaced by `Path.stat().st_ctime` | 8 | os.path.getctime(Path("filename")) - 9 | + 9 | 10 | getctime("filename") | ^^^^^^^^ PTH205 11 | getctime(b"filename") @@ -52,5 +52,3 @@ PTH205.py:12:1: PTH205 `os.path.getctime` should be replaced by `Path.stat().st_ 12 | getctime(Path("filename")) | ^^^^^^^^ PTH205 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH206_PTH206.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH206_PTH206.py.snap index 86aeedbfbce0d..70e6338726ba1 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH206_PTH206.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH206_PTH206.py.snap @@ -95,8 +95,6 @@ PTH206.py:17:30: PTH206 Replace `.split(os.sep)` with `Path.parts` 16 | file_name.split(os.sep) 17 | (os.path.abspath(file_name)).split(os.sep) | ^^^^^ PTH206 -18 | +18 | 19 | # OK | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH207_PTH207.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH207_PTH207.py.snap index fde2f146d9afc..ddcba2ba597ee 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH207_PTH207.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH207_PTH207.py.snap @@ -25,6 +25,6 @@ PTH207.py:11:1: PTH207 Replace `glob` with `Path.glob` or `Path.rglob` 10 | list(glob.iglob(os.path.join(extensions_dir, "ops", "autograd", "*.cpp"))) 11 | search("*.png") | ^^^^^^ PTH207 +12 | +13 | # if `dir_fd` is set, suppress the diagnostic | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH208_PTH208.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH208_PTH208.py.snap new file mode 100644 index 0000000000000..f8dfff97ec1ab --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH208_PTH208.py.snap @@ -0,0 +1,59 @@ +--- +source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +--- +PTH208.py:3:1: PTH208 Use `pathlib.Path.iterdir()` instead. + | +1 | import os +2 | +3 | os.listdir('.') + | ^^^^^^^^^^ PTH208 +4 | os.listdir(b'.') + | + +PTH208.py:4:1: PTH208 Use `pathlib.Path.iterdir()` instead. + | +3 | os.listdir('.') +4 | os.listdir(b'.') + | ^^^^^^^^^^ PTH208 +5 | +6 | string_path = '.' + | + +PTH208.py:7:1: PTH208 Use `pathlib.Path.iterdir()` instead. + | +6 | string_path = '.' +7 | os.listdir(string_path) + | ^^^^^^^^^^ PTH208 +8 | +9 | bytes_path = b'.' + | + +PTH208.py:10:1: PTH208 Use `pathlib.Path.iterdir()` instead. + | + 9 | bytes_path = b'.' +10 | os.listdir(bytes_path) + | ^^^^^^^^^^ PTH208 + | + +PTH208.py:16:1: PTH208 Use `pathlib.Path.iterdir()` instead. + | +15 | path_path = Path('.') +16 | os.listdir(path_path) + | ^^^^^^^^^^ PTH208 + | + +PTH208.py:19:4: PTH208 Use `pathlib.Path.iterdir()` instead. + | +19 | if os.listdir("dir"): + | ^^^^^^^^^^ PTH208 +20 | ... + | + +PTH208.py:22:14: PTH208 Use `pathlib.Path.iterdir()` instead. + | +20 | ... +21 | +22 | if "file" in os.listdir("dir"): + | ^^^^^^^^^^ PTH208 +23 | ... + | diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210.py.snap new file mode 100644 index 0000000000000..157a100789d57 --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210.py.snap @@ -0,0 +1,558 @@ +--- +source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +--- +PTH210.py:21:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +20 | ### Errors +21 | path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^ PTH210 +22 | path.with_suffix("py") +23 | path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:22:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +20 | ### Errors +21 | path.with_suffix(".") +22 | path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^ PTH210 +23 | path.with_suffix(r"s") +24 | path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +19 19 | +20 20 | ### Errors +21 21 | path.with_suffix(".") +22 |-path.with_suffix("py") + 22 |+path.with_suffix(".py") +23 23 | path.with_suffix(r"s") +24 24 | path.with_suffix(u'' "json") +25 25 | path.with_suffix(suffix="js") + +PTH210.py:23:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +21 | path.with_suffix(".") +22 | path.with_suffix("py") +23 | path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^ PTH210 +24 | path.with_suffix(u'' "json") +25 | path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +20 20 | ### Errors +21 21 | path.with_suffix(".") +22 22 | path.with_suffix("py") +23 |-path.with_suffix(r"s") + 23 |+path.with_suffix(r".s") +24 24 | path.with_suffix(u'' "json") +25 25 | path.with_suffix(suffix="js") +26 26 | + +PTH210.py:24:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +22 | path.with_suffix("py") +23 | path.with_suffix(r"s") +24 | path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +25 | path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +21 21 | path.with_suffix(".") +22 22 | path.with_suffix("py") +23 23 | path.with_suffix(r"s") +24 |-path.with_suffix(u'' "json") + 24 |+path.with_suffix(u'.' "json") +25 25 | path.with_suffix(suffix="js") +26 26 | +27 27 | posix_path.with_suffix(".") + +PTH210.py:25:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +23 | path.with_suffix(r"s") +24 | path.with_suffix(u'' "json") +25 | path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +26 | +27 | posix_path.with_suffix(".") + | + = help: Add a leading dot + +ℹ Unsafe fix +22 22 | path.with_suffix("py") +23 23 | path.with_suffix(r"s") +24 24 | path.with_suffix(u'' "json") +25 |-path.with_suffix(suffix="js") + 25 |+path.with_suffix(suffix=".js") +26 26 | +27 27 | posix_path.with_suffix(".") +28 28 | posix_path.with_suffix("py") + +PTH210.py:27:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +25 | path.with_suffix(suffix="js") +26 | +27 | posix_path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +28 | posix_path.with_suffix("py") +29 | posix_path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:28:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +27 | posix_path.with_suffix(".") +28 | posix_path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +29 | posix_path.with_suffix(r"s") +30 | posix_path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +25 25 | path.with_suffix(suffix="js") +26 26 | +27 27 | posix_path.with_suffix(".") +28 |-posix_path.with_suffix("py") + 28 |+posix_path.with_suffix(".py") +29 29 | posix_path.with_suffix(r"s") +30 30 | posix_path.with_suffix(u'' "json") +31 31 | posix_path.with_suffix(suffix="js") + +PTH210.py:29:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +27 | posix_path.with_suffix(".") +28 | posix_path.with_suffix("py") +29 | posix_path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +30 | posix_path.with_suffix(u'' "json") +31 | posix_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +26 26 | +27 27 | posix_path.with_suffix(".") +28 28 | posix_path.with_suffix("py") +29 |-posix_path.with_suffix(r"s") + 29 |+posix_path.with_suffix(r".s") +30 30 | posix_path.with_suffix(u'' "json") +31 31 | posix_path.with_suffix(suffix="js") +32 32 | + +PTH210.py:30:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +28 | posix_path.with_suffix("py") +29 | posix_path.with_suffix(r"s") +30 | posix_path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +31 | posix_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +27 27 | posix_path.with_suffix(".") +28 28 | posix_path.with_suffix("py") +29 29 | posix_path.with_suffix(r"s") +30 |-posix_path.with_suffix(u'' "json") + 30 |+posix_path.with_suffix(u'.' "json") +31 31 | posix_path.with_suffix(suffix="js") +32 32 | +33 33 | pure_path.with_suffix(".") + +PTH210.py:31:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +29 | posix_path.with_suffix(r"s") +30 | posix_path.with_suffix(u'' "json") +31 | posix_path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +32 | +33 | pure_path.with_suffix(".") + | + = help: Add a leading dot + +ℹ Unsafe fix +28 28 | posix_path.with_suffix("py") +29 29 | posix_path.with_suffix(r"s") +30 30 | posix_path.with_suffix(u'' "json") +31 |-posix_path.with_suffix(suffix="js") + 31 |+posix_path.with_suffix(suffix=".js") +32 32 | +33 33 | pure_path.with_suffix(".") +34 34 | pure_path.with_suffix("py") + +PTH210.py:33:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +31 | posix_path.with_suffix(suffix="js") +32 | +33 | pure_path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +34 | pure_path.with_suffix("py") +35 | pure_path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:34:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +33 | pure_path.with_suffix(".") +34 | pure_path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +35 | pure_path.with_suffix(r"s") +36 | pure_path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +31 31 | posix_path.with_suffix(suffix="js") +32 32 | +33 33 | pure_path.with_suffix(".") +34 |-pure_path.with_suffix("py") + 34 |+pure_path.with_suffix(".py") +35 35 | pure_path.with_suffix(r"s") +36 36 | pure_path.with_suffix(u'' "json") +37 37 | pure_path.with_suffix(suffix="js") + +PTH210.py:35:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +33 | pure_path.with_suffix(".") +34 | pure_path.with_suffix("py") +35 | pure_path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +36 | pure_path.with_suffix(u'' "json") +37 | pure_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +32 32 | +33 33 | pure_path.with_suffix(".") +34 34 | pure_path.with_suffix("py") +35 |-pure_path.with_suffix(r"s") + 35 |+pure_path.with_suffix(r".s") +36 36 | pure_path.with_suffix(u'' "json") +37 37 | pure_path.with_suffix(suffix="js") +38 38 | + +PTH210.py:36:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +34 | pure_path.with_suffix("py") +35 | pure_path.with_suffix(r"s") +36 | pure_path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +37 | pure_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +33 33 | pure_path.with_suffix(".") +34 34 | pure_path.with_suffix("py") +35 35 | pure_path.with_suffix(r"s") +36 |-pure_path.with_suffix(u'' "json") + 36 |+pure_path.with_suffix(u'.' "json") +37 37 | pure_path.with_suffix(suffix="js") +38 38 | +39 39 | pure_posix_path.with_suffix(".") + +PTH210.py:37:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +35 | pure_path.with_suffix(r"s") +36 | pure_path.with_suffix(u'' "json") +37 | pure_path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +38 | +39 | pure_posix_path.with_suffix(".") + | + = help: Add a leading dot + +ℹ Unsafe fix +34 34 | pure_path.with_suffix("py") +35 35 | pure_path.with_suffix(r"s") +36 36 | pure_path.with_suffix(u'' "json") +37 |-pure_path.with_suffix(suffix="js") + 37 |+pure_path.with_suffix(suffix=".js") +38 38 | +39 39 | pure_posix_path.with_suffix(".") +40 40 | pure_posix_path.with_suffix("py") + +PTH210.py:39:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +37 | pure_path.with_suffix(suffix="js") +38 | +39 | pure_posix_path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +40 | pure_posix_path.with_suffix("py") +41 | pure_posix_path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:40:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +39 | pure_posix_path.with_suffix(".") +40 | pure_posix_path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +41 | pure_posix_path.with_suffix(r"s") +42 | pure_posix_path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +37 37 | pure_path.with_suffix(suffix="js") +38 38 | +39 39 | pure_posix_path.with_suffix(".") +40 |-pure_posix_path.with_suffix("py") + 40 |+pure_posix_path.with_suffix(".py") +41 41 | pure_posix_path.with_suffix(r"s") +42 42 | pure_posix_path.with_suffix(u'' "json") +43 43 | pure_posix_path.with_suffix(suffix="js") + +PTH210.py:41:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +39 | pure_posix_path.with_suffix(".") +40 | pure_posix_path.with_suffix("py") +41 | pure_posix_path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +42 | pure_posix_path.with_suffix(u'' "json") +43 | pure_posix_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +38 38 | +39 39 | pure_posix_path.with_suffix(".") +40 40 | pure_posix_path.with_suffix("py") +41 |-pure_posix_path.with_suffix(r"s") + 41 |+pure_posix_path.with_suffix(r".s") +42 42 | pure_posix_path.with_suffix(u'' "json") +43 43 | pure_posix_path.with_suffix(suffix="js") +44 44 | + +PTH210.py:42:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +40 | pure_posix_path.with_suffix("py") +41 | pure_posix_path.with_suffix(r"s") +42 | pure_posix_path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +43 | pure_posix_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +39 39 | pure_posix_path.with_suffix(".") +40 40 | pure_posix_path.with_suffix("py") +41 41 | pure_posix_path.with_suffix(r"s") +42 |-pure_posix_path.with_suffix(u'' "json") + 42 |+pure_posix_path.with_suffix(u'.' "json") +43 43 | pure_posix_path.with_suffix(suffix="js") +44 44 | +45 45 | pure_windows_path.with_suffix(".") + +PTH210.py:43:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +41 | pure_posix_path.with_suffix(r"s") +42 | pure_posix_path.with_suffix(u'' "json") +43 | pure_posix_path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +44 | +45 | pure_windows_path.with_suffix(".") + | + = help: Add a leading dot + +ℹ Unsafe fix +40 40 | pure_posix_path.with_suffix("py") +41 41 | pure_posix_path.with_suffix(r"s") +42 42 | pure_posix_path.with_suffix(u'' "json") +43 |-pure_posix_path.with_suffix(suffix="js") + 43 |+pure_posix_path.with_suffix(suffix=".js") +44 44 | +45 45 | pure_windows_path.with_suffix(".") +46 46 | pure_windows_path.with_suffix("py") + +PTH210.py:45:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +43 | pure_posix_path.with_suffix(suffix="js") +44 | +45 | pure_windows_path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +46 | pure_windows_path.with_suffix("py") +47 | pure_windows_path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:46:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +45 | pure_windows_path.with_suffix(".") +46 | pure_windows_path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +47 | pure_windows_path.with_suffix(r"s") +48 | pure_windows_path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +43 43 | pure_posix_path.with_suffix(suffix="js") +44 44 | +45 45 | pure_windows_path.with_suffix(".") +46 |-pure_windows_path.with_suffix("py") + 46 |+pure_windows_path.with_suffix(".py") +47 47 | pure_windows_path.with_suffix(r"s") +48 48 | pure_windows_path.with_suffix(u'' "json") +49 49 | pure_windows_path.with_suffix(suffix="js") + +PTH210.py:47:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +45 | pure_windows_path.with_suffix(".") +46 | pure_windows_path.with_suffix("py") +47 | pure_windows_path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +48 | pure_windows_path.with_suffix(u'' "json") +49 | pure_windows_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +44 44 | +45 45 | pure_windows_path.with_suffix(".") +46 46 | pure_windows_path.with_suffix("py") +47 |-pure_windows_path.with_suffix(r"s") + 47 |+pure_windows_path.with_suffix(r".s") +48 48 | pure_windows_path.with_suffix(u'' "json") +49 49 | pure_windows_path.with_suffix(suffix="js") +50 50 | + +PTH210.py:48:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +46 | pure_windows_path.with_suffix("py") +47 | pure_windows_path.with_suffix(r"s") +48 | pure_windows_path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +49 | pure_windows_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +45 45 | pure_windows_path.with_suffix(".") +46 46 | pure_windows_path.with_suffix("py") +47 47 | pure_windows_path.with_suffix(r"s") +48 |-pure_windows_path.with_suffix(u'' "json") + 48 |+pure_windows_path.with_suffix(u'.' "json") +49 49 | pure_windows_path.with_suffix(suffix="js") +50 50 | +51 51 | windows_path.with_suffix(".") + +PTH210.py:49:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +47 | pure_windows_path.with_suffix(r"s") +48 | pure_windows_path.with_suffix(u'' "json") +49 | pure_windows_path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +50 | +51 | windows_path.with_suffix(".") + | + = help: Add a leading dot + +ℹ Unsafe fix +46 46 | pure_windows_path.with_suffix("py") +47 47 | pure_windows_path.with_suffix(r"s") +48 48 | pure_windows_path.with_suffix(u'' "json") +49 |-pure_windows_path.with_suffix(suffix="js") + 49 |+pure_windows_path.with_suffix(suffix=".js") +50 50 | +51 51 | windows_path.with_suffix(".") +52 52 | windows_path.with_suffix("py") + +PTH210.py:51:1: PTH210 Invalid suffix passed to `.with_suffix()` + | +49 | pure_windows_path.with_suffix(suffix="js") +50 | +51 | windows_path.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +52 | windows_path.with_suffix("py") +53 | windows_path.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210.py:52:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +51 | windows_path.with_suffix(".") +52 | windows_path.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +53 | windows_path.with_suffix(r"s") +54 | windows_path.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +49 49 | pure_windows_path.with_suffix(suffix="js") +50 50 | +51 51 | windows_path.with_suffix(".") +52 |-windows_path.with_suffix("py") + 52 |+windows_path.with_suffix(".py") +53 53 | windows_path.with_suffix(r"s") +54 54 | windows_path.with_suffix(u'' "json") +55 55 | windows_path.with_suffix(suffix="js") + +PTH210.py:53:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +51 | windows_path.with_suffix(".") +52 | windows_path.with_suffix("py") +53 | windows_path.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +54 | windows_path.with_suffix(u'' "json") +55 | windows_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +50 50 | +51 51 | windows_path.with_suffix(".") +52 52 | windows_path.with_suffix("py") +53 |-windows_path.with_suffix(r"s") + 53 |+windows_path.with_suffix(r".s") +54 54 | windows_path.with_suffix(u'' "json") +55 55 | windows_path.with_suffix(suffix="js") +56 56 | + +PTH210.py:54:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +52 | windows_path.with_suffix("py") +53 | windows_path.with_suffix(r"s") +54 | windows_path.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +55 | windows_path.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +51 51 | windows_path.with_suffix(".") +52 52 | windows_path.with_suffix("py") +53 53 | windows_path.with_suffix(r"s") +54 |-windows_path.with_suffix(u'' "json") + 54 |+windows_path.with_suffix(u'.' "json") +55 55 | windows_path.with_suffix(suffix="js") +56 56 | +57 57 | + +PTH210.py:55:1: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +53 | windows_path.with_suffix(r"s") +54 | windows_path.with_suffix(u'' "json") +55 | windows_path.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 + | + = help: Add a leading dot + +ℹ Unsafe fix +52 52 | windows_path.with_suffix("py") +53 53 | windows_path.with_suffix(r"s") +54 54 | windows_path.with_suffix(u'' "json") +55 |-windows_path.with_suffix(suffix="js") + 55 |+windows_path.with_suffix(suffix=".js") +56 56 | +57 57 | +58 58 | ### No errors diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210_1.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210_1.py.snap new file mode 100644 index 0000000000000..9778ac85a92dd --- /dev/null +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__PTH210_PTH210_1.py.snap @@ -0,0 +1,566 @@ +--- +source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +--- +PTH210_1.py:13:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +11 | def test_path(p: Path) -> None: +12 | ## Errors +13 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +14 | p.with_suffix("py") +15 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:14:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +12 | ## Errors +13 | p.with_suffix(".") +14 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +15 | p.with_suffix(r"s") +16 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +11 11 | def test_path(p: Path) -> None: +12 12 | ## Errors +13 13 | p.with_suffix(".") +14 |- p.with_suffix("py") + 14 |+ p.with_suffix(".py") +15 15 | p.with_suffix(r"s") +16 16 | p.with_suffix(u'' "json") +17 17 | p.with_suffix(suffix="js") + +PTH210_1.py:15:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +13 | p.with_suffix(".") +14 | p.with_suffix("py") +15 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +16 | p.with_suffix(u'' "json") +17 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +12 12 | ## Errors +13 13 | p.with_suffix(".") +14 14 | p.with_suffix("py") +15 |- p.with_suffix(r"s") + 15 |+ p.with_suffix(r".s") +16 16 | p.with_suffix(u'' "json") +17 17 | p.with_suffix(suffix="js") +18 18 | + +PTH210_1.py:16:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +14 | p.with_suffix("py") +15 | p.with_suffix(r"s") +16 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +17 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +13 13 | p.with_suffix(".") +14 14 | p.with_suffix("py") +15 15 | p.with_suffix(r"s") +16 |- p.with_suffix(u'' "json") + 16 |+ p.with_suffix(u'.' "json") +17 17 | p.with_suffix(suffix="js") +18 18 | +19 19 | ## No errors + +PTH210_1.py:17:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +15 | p.with_suffix(r"s") +16 | p.with_suffix(u'' "json") +17 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +18 | +19 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +14 14 | p.with_suffix("py") +15 15 | p.with_suffix(r"s") +16 16 | p.with_suffix(u'' "json") +17 |- p.with_suffix(suffix="js") + 17 |+ p.with_suffix(suffix=".js") +18 18 | +19 19 | ## No errors +20 20 | p.with_suffix() + +PTH210_1.py:31:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +29 | def test_posix_path(p: PosixPath) -> None: +30 | ## Errors +31 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +32 | p.with_suffix("py") +33 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:32:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +30 | ## Errors +31 | p.with_suffix(".") +32 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +33 | p.with_suffix(r"s") +34 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +29 29 | def test_posix_path(p: PosixPath) -> None: +30 30 | ## Errors +31 31 | p.with_suffix(".") +32 |- p.with_suffix("py") + 32 |+ p.with_suffix(".py") +33 33 | p.with_suffix(r"s") +34 34 | p.with_suffix(u'' "json") +35 35 | p.with_suffix(suffix="js") + +PTH210_1.py:33:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +31 | p.with_suffix(".") +32 | p.with_suffix("py") +33 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +34 | p.with_suffix(u'' "json") +35 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +30 30 | ## Errors +31 31 | p.with_suffix(".") +32 32 | p.with_suffix("py") +33 |- p.with_suffix(r"s") + 33 |+ p.with_suffix(r".s") +34 34 | p.with_suffix(u'' "json") +35 35 | p.with_suffix(suffix="js") +36 36 | + +PTH210_1.py:34:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +32 | p.with_suffix("py") +33 | p.with_suffix(r"s") +34 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +35 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +31 31 | p.with_suffix(".") +32 32 | p.with_suffix("py") +33 33 | p.with_suffix(r"s") +34 |- p.with_suffix(u'' "json") + 34 |+ p.with_suffix(u'.' "json") +35 35 | p.with_suffix(suffix="js") +36 36 | +37 37 | ## No errors + +PTH210_1.py:35:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +33 | p.with_suffix(r"s") +34 | p.with_suffix(u'' "json") +35 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +36 | +37 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +32 32 | p.with_suffix("py") +33 33 | p.with_suffix(r"s") +34 34 | p.with_suffix(u'' "json") +35 |- p.with_suffix(suffix="js") + 35 |+ p.with_suffix(suffix=".js") +36 36 | +37 37 | ## No errors +38 38 | p.with_suffix() + +PTH210_1.py:49:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +47 | def test_pure_path(p: PurePath) -> None: +48 | ## Errors +49 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +50 | p.with_suffix("py") +51 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:50:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +48 | ## Errors +49 | p.with_suffix(".") +50 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +51 | p.with_suffix(r"s") +52 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +47 47 | def test_pure_path(p: PurePath) -> None: +48 48 | ## Errors +49 49 | p.with_suffix(".") +50 |- p.with_suffix("py") + 50 |+ p.with_suffix(".py") +51 51 | p.with_suffix(r"s") +52 52 | p.with_suffix(u'' "json") +53 53 | p.with_suffix(suffix="js") + +PTH210_1.py:51:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +49 | p.with_suffix(".") +50 | p.with_suffix("py") +51 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +52 | p.with_suffix(u'' "json") +53 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +48 48 | ## Errors +49 49 | p.with_suffix(".") +50 50 | p.with_suffix("py") +51 |- p.with_suffix(r"s") + 51 |+ p.with_suffix(r".s") +52 52 | p.with_suffix(u'' "json") +53 53 | p.with_suffix(suffix="js") +54 54 | + +PTH210_1.py:52:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +50 | p.with_suffix("py") +51 | p.with_suffix(r"s") +52 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +53 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +49 49 | p.with_suffix(".") +50 50 | p.with_suffix("py") +51 51 | p.with_suffix(r"s") +52 |- p.with_suffix(u'' "json") + 52 |+ p.with_suffix(u'.' "json") +53 53 | p.with_suffix(suffix="js") +54 54 | +55 55 | ## No errors + +PTH210_1.py:53:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +51 | p.with_suffix(r"s") +52 | p.with_suffix(u'' "json") +53 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +54 | +55 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +50 50 | p.with_suffix("py") +51 51 | p.with_suffix(r"s") +52 52 | p.with_suffix(u'' "json") +53 |- p.with_suffix(suffix="js") + 53 |+ p.with_suffix(suffix=".js") +54 54 | +55 55 | ## No errors +56 56 | p.with_suffix() + +PTH210_1.py:67:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +65 | def test_pure_posix_path(p: PurePosixPath) -> None: +66 | ## Errors +67 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +68 | p.with_suffix("py") +69 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:68:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +66 | ## Errors +67 | p.with_suffix(".") +68 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +69 | p.with_suffix(r"s") +70 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +65 65 | def test_pure_posix_path(p: PurePosixPath) -> None: +66 66 | ## Errors +67 67 | p.with_suffix(".") +68 |- p.with_suffix("py") + 68 |+ p.with_suffix(".py") +69 69 | p.with_suffix(r"s") +70 70 | p.with_suffix(u'' "json") +71 71 | p.with_suffix(suffix="js") + +PTH210_1.py:69:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +67 | p.with_suffix(".") +68 | p.with_suffix("py") +69 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +70 | p.with_suffix(u'' "json") +71 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +66 66 | ## Errors +67 67 | p.with_suffix(".") +68 68 | p.with_suffix("py") +69 |- p.with_suffix(r"s") + 69 |+ p.with_suffix(r".s") +70 70 | p.with_suffix(u'' "json") +71 71 | p.with_suffix(suffix="js") +72 72 | + +PTH210_1.py:70:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +68 | p.with_suffix("py") +69 | p.with_suffix(r"s") +70 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +71 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +67 67 | p.with_suffix(".") +68 68 | p.with_suffix("py") +69 69 | p.with_suffix(r"s") +70 |- p.with_suffix(u'' "json") + 70 |+ p.with_suffix(u'.' "json") +71 71 | p.with_suffix(suffix="js") +72 72 | +73 73 | ## No errors + +PTH210_1.py:71:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +69 | p.with_suffix(r"s") +70 | p.with_suffix(u'' "json") +71 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +72 | +73 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +68 68 | p.with_suffix("py") +69 69 | p.with_suffix(r"s") +70 70 | p.with_suffix(u'' "json") +71 |- p.with_suffix(suffix="js") + 71 |+ p.with_suffix(suffix=".js") +72 72 | +73 73 | ## No errors +74 74 | p.with_suffix() + +PTH210_1.py:85:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +83 | def test_pure_windows_path(p: PureWindowsPath) -> None: +84 | ## Errors +85 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +86 | p.with_suffix("py") +87 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:86:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +84 | ## Errors +85 | p.with_suffix(".") +86 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +87 | p.with_suffix(r"s") +88 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +83 83 | def test_pure_windows_path(p: PureWindowsPath) -> None: +84 84 | ## Errors +85 85 | p.with_suffix(".") +86 |- p.with_suffix("py") + 86 |+ p.with_suffix(".py") +87 87 | p.with_suffix(r"s") +88 88 | p.with_suffix(u'' "json") +89 89 | p.with_suffix(suffix="js") + +PTH210_1.py:87:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +85 | p.with_suffix(".") +86 | p.with_suffix("py") +87 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +88 | p.with_suffix(u'' "json") +89 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +84 84 | ## Errors +85 85 | p.with_suffix(".") +86 86 | p.with_suffix("py") +87 |- p.with_suffix(r"s") + 87 |+ p.with_suffix(r".s") +88 88 | p.with_suffix(u'' "json") +89 89 | p.with_suffix(suffix="js") +90 90 | + +PTH210_1.py:88:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +86 | p.with_suffix("py") +87 | p.with_suffix(r"s") +88 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +89 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +85 85 | p.with_suffix(".") +86 86 | p.with_suffix("py") +87 87 | p.with_suffix(r"s") +88 |- p.with_suffix(u'' "json") + 88 |+ p.with_suffix(u'.' "json") +89 89 | p.with_suffix(suffix="js") +90 90 | +91 91 | ## No errors + +PTH210_1.py:89:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +87 | p.with_suffix(r"s") +88 | p.with_suffix(u'' "json") +89 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +90 | +91 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +86 86 | p.with_suffix("py") +87 87 | p.with_suffix(r"s") +88 88 | p.with_suffix(u'' "json") +89 |- p.with_suffix(suffix="js") + 89 |+ p.with_suffix(suffix=".js") +90 90 | +91 91 | ## No errors +92 92 | p.with_suffix() + +PTH210_1.py:103:5: PTH210 Invalid suffix passed to `.with_suffix()` + | +101 | def test_windows_path(p: WindowsPath) -> None: +102 | ## Errors +103 | p.with_suffix(".") + | ^^^^^^^^^^^^^^^^^^ PTH210 +104 | p.with_suffix("py") +105 | p.with_suffix(r"s") + | + = help: Remove "." or extend to valid suffix + +PTH210_1.py:104:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +102 | ## Errors +103 | p.with_suffix(".") +104 | p.with_suffix("py") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +105 | p.with_suffix(r"s") +106 | p.with_suffix(u'' "json") + | + = help: Add a leading dot + +ℹ Unsafe fix +101 101 | def test_windows_path(p: WindowsPath) -> None: +102 102 | ## Errors +103 103 | p.with_suffix(".") +104 |- p.with_suffix("py") + 104 |+ p.with_suffix(".py") +105 105 | p.with_suffix(r"s") +106 106 | p.with_suffix(u'' "json") +107 107 | p.with_suffix(suffix="js") + +PTH210_1.py:105:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +103 | p.with_suffix(".") +104 | p.with_suffix("py") +105 | p.with_suffix(r"s") + | ^^^^^^^^^^^^^^^^^^^ PTH210 +106 | p.with_suffix(u'' "json") +107 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +102 102 | ## Errors +103 103 | p.with_suffix(".") +104 104 | p.with_suffix("py") +105 |- p.with_suffix(r"s") + 105 |+ p.with_suffix(r".s") +106 106 | p.with_suffix(u'' "json") +107 107 | p.with_suffix(suffix="js") +108 108 | + +PTH210_1.py:106:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +104 | p.with_suffix("py") +105 | p.with_suffix(r"s") +106 | p.with_suffix(u'' "json") + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +107 | p.with_suffix(suffix="js") + | + = help: Add a leading dot + +ℹ Unsafe fix +103 103 | p.with_suffix(".") +104 104 | p.with_suffix("py") +105 105 | p.with_suffix(r"s") +106 |- p.with_suffix(u'' "json") + 106 |+ p.with_suffix(u'.' "json") +107 107 | p.with_suffix(suffix="js") +108 108 | +109 109 | ## No errors + +PTH210_1.py:107:5: PTH210 [*] Dotless suffix passed to `.with_suffix()` + | +105 | p.with_suffix(r"s") +106 | p.with_suffix(u'' "json") +107 | p.with_suffix(suffix="js") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PTH210 +108 | +109 | ## No errors + | + = help: Add a leading dot + +ℹ Unsafe fix +104 104 | p.with_suffix("py") +105 105 | p.with_suffix(r"s") +106 106 | p.with_suffix(u'' "json") +107 |- p.with_suffix(suffix="js") + 107 |+ p.with_suffix(suffix=".js") +108 108 | +109 109 | ## No errors +110 110 | p.with_suffix() diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__full_name.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__full_name.py.snap index ddcff48231649..63d515f0b3ac3 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__full_name.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__full_name.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs full_name.py:7:5: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()` | 5 | q = "bar" -6 | +6 | 7 | a = os.path.abspath(p) | ^^^^^^^^^^^^^^^ PTH100 8 | aa = os.chmod(p) @@ -295,7 +295,7 @@ full_name.py:37:1: PTH118 `os.sep.join()` should be replaced by `Path.joinpath() 36 | os.path.join(p, *q) 37 | os.sep.join(p, *q) | ^^^^^^^^^^^ PTH118 -38 | +38 | 39 | # https://github.com/astral-sh/ruff/issues/7620 | @@ -317,3 +317,33 @@ full_name.py:47:1: PTH123 `open()` should be replaced by `Path.open()` | ^^^^ PTH123 48 | open(p, 'r', - 1, None, None, None, False, opener) | + +full_name.py:65:1: PTH123 `open()` should be replaced by `Path.open()` + | +63 | open(f()) +64 | +65 | open(b"foo") + | ^^^^ PTH123 +66 | byte_str = b"bar" +67 | open(byte_str) + | + +full_name.py:67:1: PTH123 `open()` should be replaced by `Path.open()` + | +65 | open(b"foo") +66 | byte_str = b"bar" +67 | open(byte_str) + | ^^^^ PTH123 +68 | +69 | def bytes_str_func() -> bytes: + | + +full_name.py:71:1: PTH123 `open()` should be replaced by `Path.open()` + | +69 | def bytes_str_func() -> bytes: +70 | return b"foo" +71 | open(bytes_str_func()) + | ^^^^ PTH123 +72 | +73 | # https://github.com/astral-sh/ruff/issues/17693 + | diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_as.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_as.py.snap index 30ea651dac614..dcf8d8a659931 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_as.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_as.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs import_as.py:7:5: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()` | 5 | q = "bar" -6 | +6 | 7 | a = foo_p.abspath(p) | ^^^^^^^^^^^^^ PTH100 8 | aa = foo.chmod(p) @@ -246,5 +246,3 @@ import_as.py:31:1: PTH122 `os.path.splitext()` should be replaced by `Path.suffi 31 | foo_p.splitext(p) | ^^^^^^^^^^^^^^ PTH122 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from.py.snap index 7dcdd1a5c23c1..0cacb90179cd8 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs import_from.py:9:5: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()` | 7 | q = "bar" - 8 | + 8 | 9 | a = abspath(p) | ^^^^^^^ PTH100 10 | aa = chmod(p) @@ -268,4 +268,10 @@ import_from.py:36:1: PTH123 `open()` should be replaced by `Path.open()` | ^^^^ PTH123 | - +import_from.py:43:10: PTH123 `open()` should be replaced by `Path.open()` + | +41 | from builtins import open +42 | +43 | with open(p) as _: ... # Error + | ^^^^ PTH123 + | diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from_as.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from_as.py.snap index 759f682c6a0f3..7f9fc380f4b97 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from_as.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__import_from_as.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs import_from_as.py:14:5: PTH100 `os.path.abspath()` should be replaced by `Path.resolve()` | 12 | q = "bar" -13 | +13 | 14 | a = xabspath(p) | ^^^^^^^^ PTH100 15 | aa = xchmod(p) @@ -246,5 +246,3 @@ import_from_as.py:38:1: PTH122 `os.path.splitext()` should be replaced by `Path. 38 | xsplitext(p) | ^^^^^^^^^ PTH122 | - - diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__use_pathlib.py.snap b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__use_pathlib.py.snap index 10a495237c9b7..0839f70e26d54 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__use_pathlib.py.snap +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/snapshots/ruff_linter__rules__flake8_use_pathlib__tests__use_pathlib.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/flake8_use_pathlib/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/flake8_use_pathlib/violations.rs b/crates/ruff_linter/src/rules/flake8_use_pathlib/violations.rs index b0dfbaca3ddb2..22935ea28dc78 100644 --- a/crates/ruff_linter/src/rules/flake8_use_pathlib/violations.rs +++ b/crates/ruff_linter/src/rules/flake8_use_pathlib/violations.rs @@ -1,18 +1,15 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of `os.path.abspath`. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.resolve()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.resolve()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.abspath()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -27,20 +24,25 @@ use ruff_macros::{derive_message_formats, violation}; /// file_path = Path("../path/to/file").resolve() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.resolve`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.resolve) /// - [Python documentation: `os.path.abspath`](https://docs.python.org/3/library/os.path.html#os.path.abspath) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathAbspath; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathAbspath; impl Violation for OsPathAbspath { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.abspath()` should be replaced by `Path.resolve()`") + "`os.path.abspath()` should be replaced by `Path.resolve()`".to_string() } } @@ -53,9 +55,6 @@ impl Violation for OsPathAbspath { /// methods such as `Path.chmod()` can improve readability over the `os` /// module's counterparts (e.g., `os.chmod()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -70,20 +69,25 @@ impl Violation for OsPathAbspath { /// Path("file.py").chmod(0o444) /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.chmod`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.chmod) /// - [Python documentation: `os.chmod`](https://docs.python.org/3/library/os.html#os.chmod) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsChmod; +#[derive(ViolationMetadata)] +pub(crate) struct OsChmod; impl Violation for OsChmod { #[derive_message_formats] fn message(&self) -> String { - format!("`os.chmod()` should be replaced by `Path.chmod()`") + "`os.chmod()` should be replaced by `Path.chmod()`".to_string() } } @@ -96,9 +100,6 @@ impl Violation for OsChmod { /// methods such as `Path.mkdir(parents=True)` can improve readability over the /// `os` module's counterparts (e.g., `os.makedirs()`. /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -113,20 +114,25 @@ impl Violation for OsChmod { /// Path("./nested/directory/").mkdir(parents=True) /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.mkdir`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.mkdir) /// - [Python documentation: `os.makedirs`](https://docs.python.org/3/library/os.html#os.makedirs) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsMakedirs; +#[derive(ViolationMetadata)] +pub(crate) struct OsMakedirs; impl Violation for OsMakedirs { #[derive_message_formats] fn message(&self) -> String { - format!("`os.makedirs()` should be replaced by `Path.mkdir(parents=True)`") + "`os.makedirs()` should be replaced by `Path.mkdir(parents=True)`".to_string() } } @@ -139,9 +145,6 @@ impl Violation for OsMakedirs { /// methods such as `Path.mkdir()` can improve readability over the `os` /// module's counterparts (e.g., `os.mkdir()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -156,20 +159,25 @@ impl Violation for OsMakedirs { /// Path("./directory/").mkdir() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.mkdir`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.mkdir) /// - [Python documentation: `os.mkdir`](https://docs.python.org/3/library/os.html#os.mkdir) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsMkdir; +#[derive(ViolationMetadata)] +pub(crate) struct OsMkdir; impl Violation for OsMkdir { #[derive_message_formats] fn message(&self) -> String { - format!("`os.mkdir()` should be replaced by `Path.mkdir()`") + "`os.mkdir()` should be replaced by `Path.mkdir()`".to_string() } } @@ -182,9 +190,6 @@ impl Violation for OsMkdir { /// methods such as `Path.rename()` can improve readability over the `os` /// module's counterparts (e.g., `os.rename()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -199,20 +204,25 @@ impl Violation for OsMkdir { /// Path("old.py").rename("new.py") /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.rename`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.rename) /// - [Python documentation: `os.rename`](https://docs.python.org/3/library/os.html#os.rename) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsRename; +#[derive(ViolationMetadata)] +pub(crate) struct OsRename; impl Violation for OsRename { #[derive_message_formats] fn message(&self) -> String { - format!("`os.rename()` should be replaced by `Path.rename()`") + "`os.rename()` should be replaced by `Path.rename()`".to_string() } } @@ -242,20 +252,25 @@ impl Violation for OsRename { /// Path("old.py").replace("new.py") /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.replace`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.replace) /// - [Python documentation: `os.replace`](https://docs.python.org/3/library/os.html#os.replace) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsReplace; +#[derive(ViolationMetadata)] +pub(crate) struct OsReplace; impl Violation for OsReplace { #[derive_message_formats] fn message(&self) -> String { - format!("`os.replace()` should be replaced by `Path.replace()`") + "`os.replace()` should be replaced by `Path.replace()`".to_string() } } @@ -268,9 +283,6 @@ impl Violation for OsReplace { /// methods such as `Path.rmdir()` can improve readability over the `os` /// module's counterparts (e.g., `os.rmdir()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -285,20 +297,25 @@ impl Violation for OsReplace { /// Path("folder/").rmdir() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.rmdir`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.rmdir) /// - [Python documentation: `os.rmdir`](https://docs.python.org/3/library/os.html#os.rmdir) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsRmdir; +#[derive(ViolationMetadata)] +pub(crate) struct OsRmdir; impl Violation for OsRmdir { #[derive_message_formats] fn message(&self) -> String { - format!("`os.rmdir()` should be replaced by `Path.rmdir()`") + "`os.rmdir()` should be replaced by `Path.rmdir()`".to_string() } } @@ -311,9 +328,6 @@ impl Violation for OsRmdir { /// methods such as `Path.unlink()` can improve readability over the `os` /// module's counterparts (e.g., `os.remove()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -328,20 +342,25 @@ impl Violation for OsRmdir { /// Path("file.py").unlink() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.unlink`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.unlink) /// - [Python documentation: `os.remove`](https://docs.python.org/3/library/os.html#os.remove) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsRemove; +#[derive(ViolationMetadata)] +pub(crate) struct OsRemove; impl Violation for OsRemove { #[derive_message_formats] fn message(&self) -> String { - format!("`os.remove()` should be replaced by `Path.unlink()`") + "`os.remove()` should be replaced by `Path.unlink()`".to_string() } } @@ -354,9 +373,6 @@ impl Violation for OsRemove { /// methods such as `Path.unlink()` can improve readability over the `os` /// module's counterparts (e.g., `os.unlink()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -371,20 +387,25 @@ impl Violation for OsRemove { /// Path("file.py").unlink() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.unlink`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.unlink) /// - [Python documentation: `os.unlink`](https://docs.python.org/3/library/os.html#os.unlink) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsUnlink; +#[derive(ViolationMetadata)] +pub(crate) struct OsUnlink; impl Violation for OsUnlink { #[derive_message_formats] fn message(&self) -> String { - format!("`os.unlink()` should be replaced by `Path.unlink()`") + "`os.unlink()` should be replaced by `Path.unlink()`".to_string() } } @@ -397,9 +418,6 @@ impl Violation for OsUnlink { /// methods such as `Path.cwd()` can improve readability over the `os` /// module's counterparts (e.g., `os.getcwd()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -414,21 +432,26 @@ impl Violation for OsUnlink { /// cwd = Path.cwd() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.cwd`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.cwd) /// - [Python documentation: `os.getcwd`](https://docs.python.org/3/library/os.html#os.getcwd) /// - [Python documentation: `os.getcwdb`](https://docs.python.org/3/library/os.html#os.getcwdb) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsGetcwd; +#[derive(ViolationMetadata)] +pub(crate) struct OsGetcwd; impl Violation for OsGetcwd { #[derive_message_formats] fn message(&self) -> String { - format!("`os.getcwd()` should be replaced by `Path.cwd()`") + "`os.getcwd()` should be replaced by `Path.cwd()`".to_string() } } @@ -437,13 +460,10 @@ impl Violation for OsGetcwd { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.exists()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.exists()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.exists()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -458,20 +478,25 @@ impl Violation for OsGetcwd { /// Path("file.py").exists() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.exists`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.exists) /// - [Python documentation: `os.path.exists`](https://docs.python.org/3/library/os.path.html#os.path.exists) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathExists; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathExists; impl Violation for OsPathExists { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.exists()` should be replaced by `Path.exists()`") + "`os.path.exists()` should be replaced by `Path.exists()`".to_string() } } @@ -480,13 +505,10 @@ impl Violation for OsPathExists { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.expanduser()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.expanduser()` can improve readability over the `os.path` /// module's counterparts (e.g., as `os.path.expanduser()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -501,20 +523,25 @@ impl Violation for OsPathExists { /// Path("~/films/Monty Python").expanduser() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.expanduser`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.expanduser) /// - [Python documentation: `os.path.expanduser`](https://docs.python.org/3/library/os.path.html#os.path.expanduser) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathExpanduser; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathExpanduser; impl Violation for OsPathExpanduser { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.expanduser()` should be replaced by `Path.expanduser()`") + "`os.path.expanduser()` should be replaced by `Path.expanduser()`".to_string() } } @@ -523,13 +550,10 @@ impl Violation for OsPathExpanduser { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.is_dir()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.is_dir()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.isdir()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -544,20 +568,25 @@ impl Violation for OsPathExpanduser { /// Path("docs").is_dir() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.is_dir`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_dir) /// - [Python documentation: `os.path.isdir`](https://docs.python.org/3/library/os.path.html#os.path.isdir) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathIsdir; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathIsdir; impl Violation for OsPathIsdir { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.isdir()` should be replaced by `Path.is_dir()`") + "`os.path.isdir()` should be replaced by `Path.is_dir()`".to_string() } } @@ -566,13 +595,10 @@ impl Violation for OsPathIsdir { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.is_file()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.is_file()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.isfile()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -587,20 +613,25 @@ impl Violation for OsPathIsdir { /// Path("docs").is_file() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.is_file`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_file) /// - [Python documentation: `os.path.isfile`](https://docs.python.org/3/library/os.path.html#os.path.isfile) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathIsfile; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathIsfile; impl Violation for OsPathIsfile { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.isfile()` should be replaced by `Path.is_file()`") + "`os.path.isfile()` should be replaced by `Path.is_file()`".to_string() } } @@ -609,13 +640,10 @@ impl Violation for OsPathIsfile { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.is_symlink()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.is_symlink()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.islink()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -630,20 +658,25 @@ impl Violation for OsPathIsfile { /// Path("docs").is_symlink() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.is_symlink`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_symlink) /// - [Python documentation: `os.path.islink`](https://docs.python.org/3/library/os.path.html#os.path.islink) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathIslink; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathIslink; impl Violation for OsPathIslink { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.islink()` should be replaced by `Path.is_symlink()`") + "`os.path.islink()` should be replaced by `Path.is_symlink()`".to_string() } } @@ -656,9 +689,6 @@ impl Violation for OsPathIslink { /// methods such as `Path.readlink()` can improve readability over the `os` /// module's counterparts (e.g., `os.readlink()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -673,20 +703,25 @@ impl Violation for OsPathIslink { /// Path(file_name).readlink() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.readlink`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.readline) /// - [Python documentation: `os.readlink`](https://docs.python.org/3/library/os.html#os.readlink) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsReadlink; +#[derive(ViolationMetadata)] +pub(crate) struct OsReadlink; impl Violation for OsReadlink { #[derive_message_formats] fn message(&self) -> String { - format!("`os.readlink()` should be replaced by `Path.readlink()`") + "`os.readlink()` should be replaced by `Path.readlink()`".to_string() } } @@ -699,9 +734,6 @@ impl Violation for OsReadlink { /// methods such as `Path.stat()` can improve readability over the `os` /// module's counterparts (e.g., `os.path.stat()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -723,24 +755,28 @@ impl Violation for OsReadlink { /// group_name = file_path.group() /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.stat`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) /// - [Python documentation: `Path.group`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.group) /// - [Python documentation: `Path.owner`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.owner) /// - [Python documentation: `os.stat`](https://docs.python.org/3/library/os.html#os.stat) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsStat; +#[derive(ViolationMetadata)] +pub(crate) struct OsStat; impl Violation for OsStat { #[derive_message_formats] fn message(&self) -> String { - format!( - "`os.stat()` should be replaced by `Path.stat()`, `Path.owner()`, or `Path.group()`" - ) + "`os.stat()` should be replaced by `Path.stat()`, `Path.owner()`, or `Path.group()`" + .to_string() } } @@ -749,13 +785,10 @@ impl Violation for OsStat { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.is_absolute()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.is_absolute()` can improve readability over the `os.path` /// module's counterparts (e.g., as `os.path.isabs()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -772,20 +805,25 @@ impl Violation for OsStat { /// print("Absolute path!") /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `PurePath.is_absolute`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_absolute) /// - [Python documentation: `os.path.isabs`](https://docs.python.org/3/library/os.path.html#os.path.isabs) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathIsabs; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathIsabs; impl Violation for OsPathIsabs { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.isabs()` should be replaced by `Path.is_absolute()`") + "`os.path.isabs()` should be replaced by `Path.is_absolute()`".to_string() } } @@ -794,12 +832,9 @@ impl Violation for OsPathIsabs { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object +/// the lower-level API offered by `os.path`. When possible, using `Path` object /// methods such as `Path.joinpath()` or the `/` operator can improve -/// readability over the `os` module's counterparts (e.g., `os.path.join()`). -/// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. +/// readability over the `os.path` module's counterparts (e.g., `os.path.join()`). /// /// ## Examples /// ```python @@ -815,15 +850,20 @@ impl Violation for OsPathIsabs { /// Path(ROOT_PATH) / "folder" / "file.py" /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `PurePath.joinpath`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.joinpath) /// - [Python documentation: `os.path.join`](https://docs.python.org/3/library/os.path.html#os.path.join) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathJoin { +#[derive(ViolationMetadata)] +pub(crate) struct OsPathJoin { pub(crate) module: String, pub(crate) joiner: Joiner, } @@ -854,13 +894,10 @@ pub(crate) enum Joiner { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.name` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.name` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.basename()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -875,20 +912,25 @@ pub(crate) enum Joiner { /// Path(__file__).name /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `PurePath.name`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.name) /// - [Python documentation: `os.path.basename`](https://docs.python.org/3/library/os.path.html#os.path.basename) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathBasename; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathBasename; impl Violation for OsPathBasename { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.basename()` should be replaced by `Path.name`") + "`os.path.basename()` should be replaced by `Path.name`".to_string() } } @@ -897,13 +939,10 @@ impl Violation for OsPathBasename { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.parent` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.parent` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.dirname()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -918,20 +957,25 @@ impl Violation for OsPathBasename { /// Path(__file__).parent /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `PurePath.parent`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parent) /// - [Python documentation: `os.path.dirname`](https://docs.python.org/3/library/os.path.html#os.path.dirname) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathDirname; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathDirname; impl Violation for OsPathDirname { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.dirname()` should be replaced by `Path.parent`") + "`os.path.dirname()` should be replaced by `Path.parent`".to_string() } } @@ -940,13 +984,10 @@ impl Violation for OsPathDirname { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object -/// methods such as `Path.samefile()` can improve readability over the `os` +/// the lower-level API offered by `os.path`. When possible, using `Path` object +/// methods such as `Path.samefile()` can improve readability over the `os.path` /// module's counterparts (e.g., `os.path.samefile()`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -961,20 +1002,25 @@ impl Violation for OsPathDirname { /// Path("f1.py").samefile("f2.py") /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.samefile`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.samefile) /// - [Python documentation: `os.path.samefile`](https://docs.python.org/3/library/os.path.html#os.path.samefile) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathSamefile; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathSamefile; impl Violation for OsPathSamefile { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.samefile()` should be replaced by `Path.samefile()`") + "`os.path.samefile()` should be replaced by `Path.samefile()`".to_string() } } @@ -983,9 +1029,9 @@ impl Violation for OsPathSamefile { /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation, as compared to -/// the lower-level API offered by `os`. When possible, using `Path` object +/// the lower-level API offered by `os.path`. When possible, using `Path` object /// methods such as `Path.suffix` and `Path.stem` can improve readability over -/// the `os` module's counterparts (e.g., `os.path.splitext()`). +/// the `os.path` module's counterparts (e.g., `os.path.splitext()`). /// /// `os.path.splitext()` specifically returns a tuple of the file root and /// extension (e.g., given `splitext('/foo/bar.py')`, `os.path.splitext()` @@ -993,9 +1039,6 @@ impl Violation for OsPathSamefile { /// combination of `Path.suffix` (`".py"`), `Path.stem` (`"bar"`), and /// `Path.parent` (`"foo"`). /// -/// Note that `os` functions may be preferable if performance is a concern, -/// e.g., in hot loops. -/// /// ## Examples /// ```python /// import os @@ -1012,26 +1055,32 @@ impl Violation for OsPathSamefile { /// ext = path.suffix /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.suffix`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.suffix) /// - [Python documentation: `Path.suffixes`](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.suffixes) /// - [Python documentation: `os.path.splitext`](https://docs.python.org/3/library/os.path.html#os.path.splitext) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct OsPathSplitext; +#[derive(ViolationMetadata)] +pub(crate) struct OsPathSplitext; impl Violation for OsPathSplitext { #[derive_message_formats] fn message(&self) -> String { - format!("`os.path.splitext()` should be replaced by `Path.suffix`, `Path.stem`, and `Path.parent`") + "`os.path.splitext()` should be replaced by `Path.suffix`, `Path.stem`, and `Path.parent`" + .to_string() } } /// ## What it does -/// Checks for uses of the `open` builtin. +/// Checks for uses of the `open()` builtin. /// /// ## Why is this bad? /// `pathlib` offers a high-level API for path manipulation. When possible, @@ -1052,20 +1101,25 @@ impl Violation for OsPathSplitext { /// ... /// ``` /// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than working directly with strings, +/// especially on older versions of Python. +/// /// ## References /// - [Python documentation: `Path.open`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.open) /// - [Python documentation: `open`](https://docs.python.org/3/library/functions.html#open) -/// - [PEP 428](https://peps.python.org/pep-0428/) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) /// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) /// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) /// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) -#[violation] -pub struct BuiltinOpen; +#[derive(ViolationMetadata)] +pub(crate) struct BuiltinOpen; impl Violation for BuiltinOpen { #[derive_message_formats] fn message(&self) -> String { - format!("`open()` should be replaced by `Path.open()`") + "`open()` should be replaced by `Path.open()`".to_string() } } @@ -1094,12 +1148,70 @@ impl Violation for BuiltinOpen { /// ## References /// - [Python documentation: `Pathlib`](https://docs.python.org/3/library/pathlib.html) /// - [Path repository](https://github.com/jaraco/path) -#[violation] -pub struct PyPath; +#[derive(ViolationMetadata)] +pub(crate) struct PyPath; impl Violation for PyPath { #[derive_message_formats] fn message(&self) -> String { - format!("`py.path` is in maintenance mode, use `pathlib` instead") + "`py.path` is in maintenance mode, use `pathlib` instead".to_string() + } +} + +/// ## What it does +/// Checks for uses of `os.listdir`. +/// +/// ## Why is this bad? +/// `pathlib` offers a high-level API for path manipulation, as compared to +/// the lower-level API offered by `os`. When possible, using `pathlib`'s +/// `Path.iterdir()` can improve readability over `os.listdir()`. +/// +/// ## Example +/// +/// ```python +/// p = "." +/// for d in os.listdir(p): +/// ... +/// +/// if os.listdir(p): +/// ... +/// +/// if "file" in os.listdir(p): +/// ... +/// ``` +/// +/// Use instead: +/// +/// ```python +/// p = Path(".") +/// for d in p.iterdir(): +/// ... +/// +/// if any(p.iterdir()): +/// ... +/// +/// if (p / "file").exists(): +/// ... +/// ``` +/// +/// ## Known issues +/// While using `pathlib` can improve the readability and type safety of your code, +/// it can be less performant than the lower-level alternatives that work directly with strings, +/// especially on older versions of Python. +/// +/// ## References +/// - [Python documentation: `Path.iterdir`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.iterdir) +/// - [Python documentation: `os.listdir`](https://docs.python.org/3/library/os.html#os.listdir) +/// - [PEP 428 – The pathlib module – object-oriented filesystem paths](https://peps.python.org/pep-0428/) +/// - [Correspondence between `os` and `pathlib`](https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module) +/// - [Why you should be using pathlib](https://treyhunner.com/2018/12/why-you-should-be-using-pathlib/) +/// - [No really, pathlib is great](https://treyhunner.com/2019/01/no-really-pathlib-is-great/) +#[derive(ViolationMetadata)] +pub(crate) struct OsListdir; + +impl Violation for OsListdir { + #[derive_message_formats] + fn message(&self) -> String { + "Use `pathlib.Path.iterdir()` instead.".to_string() } } diff --git a/crates/ruff_linter/src/rules/flynt/helpers.rs b/crates/ruff_linter/src/rules/flynt/helpers.rs index 640f922d6faa2..a71b369b6987f 100644 --- a/crates/ruff_linter/src/rules/flynt/helpers.rs +++ b/crates/ruff_linter/src/rules/flynt/helpers.rs @@ -15,7 +15,7 @@ fn to_f_string_expression_element(inner: &Expr) -> ast::FStringElement { /// Convert a string to a [`ast::FStringElement::Literal`]. pub(super) fn to_f_string_literal_element(s: &str) -> ast::FStringElement { ast::FStringElement::Literal(ast::FStringLiteralElement { - value: s.to_string().into_boxed_str(), + value: Box::from(s), range: TextRange::default(), }) } diff --git a/crates/ruff_linter/src/rules/flynt/rules/static_join_to_fstring.rs b/crates/ruff_linter/src/rules/flynt/rules/static_join_to_fstring.rs index f3ba8369ca7e7..28f98da0b6c21 100644 --- a/crates/ruff_linter/src/rules/flynt/rules/static_join_to_fstring.rs +++ b/crates/ruff_linter/src/rules/flynt/rules/static_join_to_fstring.rs @@ -3,7 +3,7 @@ use itertools::Itertools; use crate::fix::edits::pad; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_text_size::{Ranged, TextRange}; @@ -28,10 +28,18 @@ use crate::rules::flynt::helpers; /// f"{foo} {bar}" /// ``` /// +/// # Fix safety +/// The fix is always marked unsafe because the evaluation of the f-string +/// expressions will default to calling the `__format__` method of each +/// object, whereas `str.join` expects each object to be an instance of +/// `str` and uses the corresponding string. Therefore it is possible for +/// the values of the resulting strings to differ, or for one expression +/// to raise an exception while the other does not. +/// /// ## References /// - [Python documentation: f-strings](https://docs.python.org/3/reference/lexical_analysis.html#f-strings) -#[violation] -pub struct StaticJoinToFString { +#[derive(ViolationMetadata)] +pub(crate) struct StaticJoinToFString { expression: SourceCodeSnippet, } @@ -42,7 +50,7 @@ impl AlwaysFixableViolation for StaticJoinToFString { if let Some(expression) = expression.full_display() { format!("Consider `{expression}` instead of string join") } else { - format!("Consider f-string instead of string join") + "Consider f-string instead of string join".to_string() } } @@ -51,7 +59,7 @@ impl AlwaysFixableViolation for StaticJoinToFString { if let Some(expression) = expression.full_display() { format!("Replace with `{expression}`") } else { - format!("Replace with f-string") + "Replace with f-string".to_string() } } } @@ -60,14 +68,20 @@ fn is_static_length(elts: &[Expr]) -> bool { elts.iter().all(|e| !e.is_starred_expr()) } -fn build_fstring(joiner: &str, joinees: &[Expr]) -> Option<Expr> { +/// Build an f-string consisting of `joinees` joined by `joiner` with `flags`. +fn build_fstring(joiner: &str, joinees: &[Expr], flags: FStringFlags) -> Option<Expr> { // If all elements are string constants, join them into a single string. if joinees.iter().all(Expr::is_string_literal_expr) { + let mut flags = None; let node = ast::StringLiteral { value: joinees .iter() .filter_map(|expr| { if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = expr { + if flags.is_none() { + // take the flags from the first Expr + flags = Some(value.first_literal_flags()); + } Some(value.to_str()) } else { None @@ -75,7 +89,8 @@ fn build_fstring(joiner: &str, joinees: &[Expr]) -> Option<Expr> { }) .join(joiner) .into_boxed_str(), - ..ast::StringLiteral::default() + flags: flags?, + range: TextRange::default(), }; return Some(node.into()); } @@ -98,13 +113,13 @@ fn build_fstring(joiner: &str, joinees: &[Expr]) -> Option<Expr> { let node = ast::FString { elements: f_string_elements.into(), range: TextRange::default(), - flags: FStringFlags::default(), + flags, }; Some(node.into()) } /// FLY002 -pub(crate) fn static_join_to_fstring(checker: &mut Checker, expr: &Expr, joiner: &str) { +pub(crate) fn static_join_to_fstring(checker: &Checker, expr: &Expr, joiner: &str) { let Expr::Call(ast::ExprCall { arguments: Arguments { args, keywords, .. }, .. @@ -131,7 +146,7 @@ pub(crate) fn static_join_to_fstring(checker: &mut Checker, expr: &Expr, joiner: // Try to build the fstring (internally checks whether e.g. the elements are // convertible to f-string elements). - let Some(new_expr) = build_fstring(joiner, joinees) else { + let Some(new_expr) = build_fstring(joiner, joinees, checker.default_fstring_flags()) else { return; }; @@ -147,5 +162,5 @@ pub(crate) fn static_join_to_fstring(checker: &mut Checker, expr: &Expr, joiner: pad(contents, expr.range(), checker.locator()), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/flynt/snapshots/ruff_linter__rules__flynt__tests__FLY002_FLY002.py.snap b/crates/ruff_linter/src/rules/flynt/snapshots/ruff_linter__rules__flynt__tests__FLY002_FLY002.py.snap index 5d531d603b2ab..9a1e06585cae8 100644 --- a/crates/ruff_linter/src/rules/flynt/snapshots/ruff_linter__rules__flynt__tests__FLY002_FLY002.py.snap +++ b/crates/ruff_linter/src/rules/flynt/snapshots/ruff_linter__rules__flynt__tests__FLY002_FLY002.py.snap @@ -110,7 +110,7 @@ FLY002.py:10:7: FLY002 [*] Consider `f"{secrets.token_urlsafe()}a{secrets.token_ 9 | ok5 = "a".join([random(), random()]) # OK (simple calls) 10 | ok6 = "a".join([secrets.token_urlsafe(), secrets.token_hex()]) # OK (attr calls) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FLY002 -11 | +11 | 12 | nok1 = "x".join({"4", "5", "yee"}) # Not OK (set) | = help: Replace with `f"{secrets.token_urlsafe()}a{secrets.token_hex()}"` @@ -140,5 +140,3 @@ FLY002.py:23:11: FLY002 [*] Consider `f"{url}{filename}"` instead of string join 22 22 | def create_file_public_url(url, filename): 23 |- return''.join([url, filename]) 23 |+ return f"{url}{filename}" - - diff --git a/crates/ruff_linter/src/rules/isort/block.rs b/crates/ruff_linter/src/rules/isort/block.rs index c982c01e1195f..1dfe96dc5172f 100644 --- a/crates/ruff_linter/src/rules/isort/block.rs +++ b/crates/ruff_linter/src/rules/isort/block.rs @@ -6,9 +6,9 @@ use ruff_python_ast::statement_visitor::StatementVisitor; use ruff_python_ast::{self as ast, ElifElseClause, ExceptHandler, MatchCase, Stmt}; use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::Locator; use crate::directives::IsortDirectives; use crate::rules::isort::helpers; -use crate::Locator; /// A block of imports within a Python module. #[derive(Debug, Default)] diff --git a/crates/ruff_linter/src/rules/isort/categorize.rs b/crates/ruff_linter/src/rules/isort/categorize.rs index 4c8212261115a..aee53af6579a4 100644 --- a/crates/ruff_linter/src/rules/isort/categorize.rs +++ b/crates/ruff_linter/src/rules/isort/categorize.rs @@ -1,19 +1,20 @@ use std::collections::BTreeMap; use std::fmt; +use std::fs; +use std::iter; use std::path::{Path, PathBuf}; -use std::{fs, iter}; use log::debug; use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet}; use serde::{Deserialize, Serialize}; use strum_macros::EnumIter; +use crate::package::PackageRoot; +use crate::warn_user_once; use ruff_macros::CacheKey; +use ruff_python_ast::PythonVersion; use ruff_python_stdlib::sys::is_known_standard_library; -use crate::settings::types::PythonVersion; -use crate::warn_user_once; - use super::types::{ImportBlock, Importable}; #[derive( @@ -79,27 +80,28 @@ enum Reason<'a> { Future, KnownStandardLibrary, SamePackage, - #[allow(dead_code)] + #[expect(dead_code)] SourceMatch(&'a Path), NoMatch, UserDefinedSection, NoSections, - #[allow(dead_code)] + #[expect(dead_code)] DisabledSection(&'a ImportSection), } -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn categorize<'a>( module_name: &str, is_relative: bool, src: &[PathBuf], - package: Option<&Path>, + package: Option<PackageRoot<'_>>, detect_same_package: bool, known_modules: &'a KnownModules, target_version: PythonVersion, no_sections: bool, section_order: &'a [ImportSection], default_section: &'a ImportSection, + match_source_strategy: MatchSourceStrategy, ) -> &'a ImportSection { let module_base = module_name.split('.').next().unwrap(); let (mut import_type, mut reason) = { @@ -117,7 +119,7 @@ pub(crate) fn categorize<'a>( ) } else if let Some((import_type, reason)) = known_modules.categorize(module_name) { (import_type, reason) - } else if is_known_standard_library(target_version.minor(), module_base) { + } else if is_known_standard_library(target_version.minor, module_base) { ( &ImportSection::Known(ImportType::StandardLibrary), Reason::KnownStandardLibrary, @@ -127,7 +129,7 @@ pub(crate) fn categorize<'a>( &ImportSection::Known(ImportType::FirstParty), Reason::SamePackage, ) - } else if let Some(src) = match_sources(src, module_base) { + } else if let Some(src) = match_sources(src, module_name, match_source_strategy) { ( &ImportSection::Known(ImportType::FirstParty), Reason::SourceMatch(src), @@ -146,44 +148,88 @@ pub(crate) fn categorize<'a>( reason = Reason::DisabledSection(import_type); import_type = default_section; } - debug!( - "Categorized '{}' as {:?} ({:?})", - module_name, import_type, reason - ); + debug!("Categorized '{module_name}' as {import_type:?} ({reason:?})"); import_type } -fn same_package(package: Option<&Path>, module_base: &str) -> bool { - package.is_some_and(|package| package.ends_with(module_base)) +fn same_package(package: Option<PackageRoot<'_>>, module_base: &str) -> bool { + package + .map(PackageRoot::path) + .is_some_and(|package| package.ends_with(module_base)) } -fn match_sources<'a>(paths: &'a [PathBuf], base: &str) -> Option<&'a Path> { - for path in paths { - if let Ok(metadata) = fs::metadata(path.join(base)) { - if metadata.is_dir() { - return Some(path); +/// Returns the source path with respect to which the module `name` +/// should be considered first party, or `None` if no path is found. +/// +/// The [`MatchSourceStrategy`] is the criterion used to decide whether +/// the module path matches a given source directory. +/// +/// # Examples +/// +/// - The module named `foo` will match `[SRC]` if `[SRC]/foo` is a directory, +/// no matter the strategy. +/// +/// - With `match_source_strategy == MatchSourceStrategy::Root`, the module +/// named `foo.baz` will match `[SRC]` if `[SRC]/foo` is a +/// directory or `[SRC]/foo.py` exists. +/// +/// - With `match_source_stratgy == MatchSourceStrategy::FullPath`, the module +/// named `foo.baz` will match `[SRC]` only if `[SRC]/foo/baz` is a directory, +/// or `[SRC]/foo/baz.py` exists or `[SRC]/foo/baz.pyi` exists. +fn match_sources<'a>( + paths: &'a [PathBuf], + name: &str, + match_source_strategy: MatchSourceStrategy, +) -> Option<&'a Path> { + match match_source_strategy { + MatchSourceStrategy::Root => { + let base = name.split('.').next()?; + for path in paths { + if let Ok(metadata) = fs::metadata(path.join(base)) { + if metadata.is_dir() { + return Some(path); + } + } + if let Ok(metadata) = fs::metadata(path.join(format!("{base}.py"))) { + if metadata.is_file() { + return Some(path); + } + } } + None } - if let Ok(metadata) = fs::metadata(path.join(format!("{base}.py"))) { - if metadata.is_file() { - return Some(path); + MatchSourceStrategy::FullPath => { + let relative_path: PathBuf = name.split('.').collect(); + relative_path.components().next()?; + for root in paths { + let candidate = root.join(&relative_path); + if candidate.is_dir() { + return Some(root); + } + if ["py", "pyi"] + .into_iter() + .any(|extension| candidate.with_extension(extension).is_file()) + { + return Some(root); + } } + None } } - None } -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn categorize_imports<'a>( block: ImportBlock<'a>, src: &[PathBuf], - package: Option<&Path>, + package: Option<PackageRoot<'_>>, detect_same_package: bool, known_modules: &'a KnownModules, target_version: PythonVersion, no_sections: bool, section_order: &'a [ImportSection], default_section: &'a ImportSection, + match_source_strategy: MatchSourceStrategy, ) -> BTreeMap<&'a ImportSection, ImportBlock<'a>> { let mut block_by_type: BTreeMap<&ImportSection, ImportBlock> = BTreeMap::default(); // Categorize `Stmt::Import`. @@ -199,6 +245,7 @@ pub(crate) fn categorize_imports<'a>( no_sections, section_order, default_section, + match_source_strategy, ); block_by_type .entry(import_type) @@ -219,6 +266,7 @@ pub(crate) fn categorize_imports<'a>( no_sections, section_order, default_section, + match_source_strategy, ); block_by_type .entry(classification) @@ -239,6 +287,7 @@ pub(crate) fn categorize_imports<'a>( no_sections, section_order, default_section, + match_source_strategy, ); block_by_type .entry(classification) @@ -259,6 +308,7 @@ pub(crate) fn categorize_imports<'a>( no_sections, section_order, default_section, + match_source_strategy, ); block_by_type .entry(classification) @@ -318,7 +368,9 @@ impl KnownModules { let mut seen = FxHashSet::with_capacity_and_hasher(known.len(), FxBuildHasher); for (module, _) in &known { if !seen.insert(module) { - warn_user_once!("One or more modules are part of multiple import sections, including: `{module}`"); + warn_user_once!( + "One or more modules are part of multiple import sections, including: `{module}`" + ); break; } } @@ -410,3 +462,463 @@ impl fmt::Display for KnownModules { Ok(()) } } + +/// Rule to determine whether a module path matches +/// a relative path from a source directory. +#[derive(Debug, Clone, Copy)] +pub(crate) enum MatchSourceStrategy { + /// Matches if first term in module path is found in file system + /// + /// # Example + /// Module is `foo.bar.baz` and `[SRC]/foo` exists + Root, + /// Matches only if full module path is reflected in file system + /// + /// # Example + /// Module is `foo.bar.baz` and `[SRC]/foo/bar/baz` exists + FullPath, +} + +#[cfg(test)] +mod tests { + use crate::rules::isort::categorize::{MatchSourceStrategy, match_sources}; + + use std::fs; + use std::path::{Path, PathBuf}; + use tempfile::tempdir; + + /// Helper function to create a file with parent directories + fn create_file<P: AsRef<Path>>(path: P) { + let path = path.as_ref(); + if let Some(parent) = path.parent() { + fs::create_dir_all(parent).unwrap(); + } + fs::write(path, "").unwrap(); + } + + /// Helper function to create a directory and all parent directories + fn create_dir<P: AsRef<Path>>(path: P) { + fs::create_dir_all(path).unwrap(); + } + + /// Tests a traditional Python package layout: + /// ``` + /// project/ + /// └── mypackage/ + /// ├── __init__.py + /// ├── module1.py + /// └── module2.py + /// ``` + #[test] + fn test_traditional_layout() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + // Create traditional layout + create_dir(project_dir.join("mypackage")); + create_file(project_dir.join("mypackage/__init__.py")); + create_file(project_dir.join("mypackage/module1.py")); + create_file(project_dir.join("mypackage/module2.py")); + + let paths = vec![project_dir.clone()]; + + // Test with Root strategy + + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.module1", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.nonexistent", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "nonexistent", MatchSourceStrategy::Root), + None + ); + + // Test with FullPath strategy + + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::FullPath), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.module1", MatchSourceStrategy::FullPath), + Some(project_dir.as_path()) + ); + + // Differs in behavior from [`MatchSourceStrategy::Root`] + assert_eq!( + match_sources( + &paths, + "mypackage.nonexistent", + MatchSourceStrategy::FullPath + ), + None + ); + } + + /// Tests a src-based Python package layout: + /// ``` + /// project/ + /// └── src/ + /// └── mypackage/ + /// ├── __init__.py + /// └── module1.py + /// ``` + #[test] + fn test_src_layout() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + let src_dir = project_dir.join("src"); + + // Create src layout + create_dir(src_dir.join("mypackage")); + create_file(src_dir.join("mypackage/__init__.py")); + create_file(src_dir.join("mypackage/module1.py")); + + let paths = vec![src_dir.clone()]; + + // Test with Root strategy + + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::Root), + Some(src_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.module1", MatchSourceStrategy::Root), + Some(src_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.nonexistent", MatchSourceStrategy::Root), + Some(src_dir.as_path()) + ); + + // Test with FullPath strategy + + assert_eq!( + match_sources(&paths, "mypackage.module1", MatchSourceStrategy::FullPath), + Some(src_dir.as_path()) + ); + + // Differs in behavior from [`MatchSourceStrategy::Root`] + assert_eq!( + match_sources( + &paths, + "mypackage.nonexistent", + MatchSourceStrategy::FullPath + ), + None + ); + } + + /// Tests a nested package layout: + /// ``` + /// project/ + /// └── mypackage/ + /// ├── __init__.py + /// ├── module1.py + /// └── subpackage/ + /// ├── __init__.py + /// └── module2.py + /// ``` + #[test] + fn test_nested_packages() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + // Create nested package layout + create_dir(project_dir.join("mypackage/subpackage")); + create_file(project_dir.join("mypackage/__init__.py")); + create_file(project_dir.join("mypackage/module1.py")); + create_file(project_dir.join("mypackage/subpackage/__init__.py")); + create_file(project_dir.join("mypackage/subpackage/module2.py")); + + let paths = vec![project_dir.clone()]; + + // Test with Root strategy + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "mypackage.subpackage", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + // Test with FullPath strategy + + assert_eq!( + match_sources( + &paths, + "mypackage.subpackage.module2", + MatchSourceStrategy::FullPath + ), + Some(project_dir.as_path()) + ); + + // Differs in behavior from [`MatchSourceStrategy::Root`] + assert_eq!( + match_sources( + &paths, + "mypackage.subpackage.nonexistent", + MatchSourceStrategy::FullPath + ), + None + ); + } + + /// Tests a namespace package layout (PEP 420): + /// ``` + /// project/ + /// └── namespace/ # No __init__.py (namespace package) + /// └── package1/ + /// ├── __init__.py + /// └── module1.py + /// ``` + #[test] + fn test_namespace_packages() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + // Create namespace package layout + create_dir(project_dir.join("namespace/package1")); + create_file(project_dir.join("namespace/package1/__init__.py")); + create_file(project_dir.join("namespace/package1/module1.py")); + + let paths = vec![project_dir.clone()]; + // Test with Root strategy + + assert_eq!( + match_sources(&paths, "namespace", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources(&paths, "namespace.package1", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources( + &paths, + "namespace.package2.module1", + MatchSourceStrategy::Root + ), + Some(project_dir.as_path()) + ); + + // Test with FullPath strategy + + assert_eq!( + match_sources(&paths, "namespace.package1", MatchSourceStrategy::FullPath), + Some(project_dir.as_path()) + ); + + assert_eq!( + match_sources( + &paths, + "namespace.package1.module1", + MatchSourceStrategy::FullPath + ), + Some(project_dir.as_path()) + ); + + // Differs in behavior from [`MatchSourceStrategy::Root`] + assert_eq!( + match_sources( + &paths, + "namespace.package2.module1", + MatchSourceStrategy::FullPath + ), + None + ); + } + + /// Tests a package with type stubs (.pyi files): + /// ``` + /// project/ + /// └── mypackage/ + /// ├── __init__.py + /// └── module1.pyi # Only .pyi file, no .py + /// ``` + #[test] + fn test_type_stubs() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + // Create package with type stub + create_dir(project_dir.join("mypackage")); + create_file(project_dir.join("mypackage/__init__.py")); + create_file(project_dir.join("mypackage/module1.pyi")); // Only create .pyi file, not .py + + // Test with FullPath strategy + let paths = vec![project_dir.clone()]; + + // Module "mypackage.module1" should match project_dir using .pyi file + assert_eq!( + match_sources(&paths, "mypackage.module1", MatchSourceStrategy::FullPath), + Some(project_dir.as_path()) + ); + } + + /// Tests a package with both a module and a directory having the same name: + /// ``` + /// project/ + /// └── mypackage/ + /// ├── __init__.py + /// ├── feature.py # Module with same name as directory + /// └── feature/ # Directory with same name as module + /// ├── __init__.py + /// └── submodule.py + /// ``` + #[test] + fn test_same_name_module_and_directory() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + // Create package with module and directory of the same name + create_dir(project_dir.join("mypackage/feature")); + create_file(project_dir.join("mypackage/__init__.py")); + create_file(project_dir.join("mypackage/feature.py")); // Module with same name as directory + create_file(project_dir.join("mypackage/feature/__init__.py")); + create_file(project_dir.join("mypackage/feature/submodule.py")); + + // Test with Root strategy + let paths = vec![project_dir.clone()]; + + // Module "mypackage.feature" should match project_dir (matches the file first) + assert_eq!( + match_sources(&paths, "mypackage.feature", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + + // Test with FullPath strategy + + // Module "mypackage.feature" should match project_dir + assert_eq!( + match_sources(&paths, "mypackage.feature", MatchSourceStrategy::FullPath), + Some(project_dir.as_path()) + ); + + // Module "mypackage.feature.submodule" should match project_dir + assert_eq!( + match_sources( + &paths, + "mypackage.feature.submodule", + MatchSourceStrategy::FullPath + ), + Some(project_dir.as_path()) + ); + } + + /// Tests multiple source directories with different packages: + /// ``` + /// project1/ + /// └── package1/ + /// ├── __init__.py + /// └── module1.py + /// + /// project2/ + /// └── package2/ + /// ├── __init__.py + /// └── module2.py + /// ``` + #[test] + fn test_multiple_source_paths() { + let temp_dir = tempdir().unwrap(); + let project1_dir = temp_dir.path().join("project1"); + let project2_dir = temp_dir.path().join("project2"); + + // Create files in project1 + create_dir(project1_dir.join("package1")); + create_file(project1_dir.join("package1/__init__.py")); + create_file(project1_dir.join("package1/module1.py")); + + // Create files in project2 + create_dir(project2_dir.join("package2")); + create_file(project2_dir.join("package2/__init__.py")); + create_file(project2_dir.join("package2/module2.py")); + + // Test with multiple paths in search order + let paths = vec![project1_dir.clone(), project2_dir.clone()]; + + // Module "package1" should match project1_dir + assert_eq!( + match_sources(&paths, "package1", MatchSourceStrategy::Root), + Some(project1_dir.as_path()) + ); + + // Module "package2" should match project2_dir + assert_eq!( + match_sources(&paths, "package2", MatchSourceStrategy::Root), + Some(project2_dir.as_path()) + ); + + // Try with reversed order to check search order + let paths_reversed = vec![project2_dir, project1_dir.clone()]; + + // Module "package1" should still match project1_dir + assert_eq!( + match_sources(&paths_reversed, "package1", MatchSourceStrategy::Root), + Some(project1_dir.as_path()) + ); + } + + /// Tests behavior with an empty module name + /// ``` + /// project/ + /// └── mypackage/ + /// ``` + /// + /// In theory this should never happen since we expect + /// module names to have been normalized by the time we + /// call `match_sources`. But it is worth noting that the + /// behavior is different depending on the [`MatchSourceStrategy`] + #[test] + fn test_empty_module_name() { + let temp_dir = tempdir().unwrap(); + let project_dir = temp_dir.path().join("project"); + + create_dir(project_dir.join("mypackage")); + + let paths = vec![project_dir.clone()]; + + assert_eq!( + match_sources(&paths, "", MatchSourceStrategy::Root), + Some(project_dir.as_path()) + ); + assert_eq!( + match_sources(&paths, "", MatchSourceStrategy::FullPath), + None + ); + } + + /// Tests behavior with an empty list of source paths + #[test] + fn test_empty_paths() { + let paths: Vec<PathBuf> = vec![]; + + // Empty paths should return None + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::Root), + None + ); + assert_eq!( + match_sources(&paths, "mypackage", MatchSourceStrategy::FullPath), + None + ); + } +} diff --git a/crates/ruff_linter/src/rules/isort/format.rs b/crates/ruff_linter/src/rules/isort/format.rs index 29639d27d5600..e7210cd8dabee 100644 --- a/crates/ruff_linter/src/rules/isort/format.rs +++ b/crates/ruff_linter/src/rules/isort/format.rs @@ -40,7 +40,7 @@ pub(crate) fn format_import( } /// Add an import-from statement to the [`RopeBuilder`]. -#[allow(clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] pub(crate) fn format_import_from( import_from: &ImportFromData, comments: &ImportFromCommentSet, diff --git a/crates/ruff_linter/src/rules/isort/helpers.rs b/crates/ruff_linter/src/rules/isort/helpers.rs index 1d2a93a65d882..f144a56993282 100644 --- a/crates/ruff_linter/src/rules/isort/helpers.rs +++ b/crates/ruff_linter/src/rules/isort/helpers.rs @@ -4,8 +4,8 @@ use ruff_python_trivia::PythonWhitespace; use ruff_source_file::UniversalNewlines; use ruff_text_size::Ranged; -use crate::rules::isort::types::TrailingComma; use crate::Locator; +use crate::rules::isort::types::TrailingComma; /// Return `true` if a `Stmt::ImportFrom` statement ends with a magic /// trailing comma. diff --git a/crates/ruff_linter/src/rules/isort/mod.rs b/crates/ruff_linter/src/rules/isort/mod.rs index 613284b34b8b5..1333ea6ce9030 100644 --- a/crates/ruff_linter/src/rules/isort/mod.rs +++ b/crates/ruff_linter/src/rules/isort/mod.rs @@ -1,12 +1,12 @@ //! Rules from [isort](https://pypi.org/project/isort/). -use std::path::{Path, PathBuf}; +use std::path::PathBuf; use annotate::annotate_imports; use block::{Block, Trailer}; pub(crate) use categorize::categorize; -use categorize::categorize_imports; pub use categorize::{ImportSection, ImportType}; +use categorize::{MatchSourceStrategy, categorize_imports}; use comments::Comment; use normalize::normalize_imports; use order::order_imports; @@ -17,9 +17,10 @@ use settings::Settings; use types::EitherImport::{Import, ImportFrom}; use types::{AliasData, ImportBlock, TrailingComma}; -use crate::line_width::{LineLength, LineWidthBuilder}; -use crate::settings::types::PythonVersion; use crate::Locator; +use crate::line_width::{LineLength, LineWidthBuilder}; +use crate::package::PackageRoot; +use ruff_python_ast::PythonVersion; mod annotate; pub(crate) mod block; @@ -62,7 +63,7 @@ pub(crate) enum AnnotatedImport<'a> { }, } -#[allow(clippy::too_many_arguments, clippy::fn_params_excessive_bools)] +#[expect(clippy::too_many_arguments)] pub(crate) fn format_imports( block: &Block, comments: Vec<Comment>, @@ -71,10 +72,11 @@ pub(crate) fn format_imports( indentation_width: LineWidthBuilder, stylist: &Stylist, src: &[PathBuf], - package: Option<&Path>, + package: Option<PackageRoot<'_>>, source_type: PySourceType, target_version: PythonVersion, settings: &Settings, + match_source_strategy: MatchSourceStrategy, tokens: &Tokens, ) -> String { let trailer = &block.trailer; @@ -102,6 +104,7 @@ pub(crate) fn format_imports( package, target_version, settings, + match_source_strategy, ); if !block_output.is_empty() && !output.is_empty() { @@ -148,16 +151,17 @@ pub(crate) fn format_imports( output } -#[allow(clippy::too_many_arguments, clippy::fn_params_excessive_bools)] +#[expect(clippy::too_many_arguments)] fn format_import_block( block: ImportBlock, line_length: LineLength, indentation_width: LineWidthBuilder, stylist: &Stylist, src: &[PathBuf], - package: Option<&Path>, + package: Option<PackageRoot<'_>>, target_version: PythonVersion, settings: &Settings, + match_source_strategy: MatchSourceStrategy, ) -> String { #[derive(Debug, Copy, Clone, PartialEq, Eq)] enum LineInsertion { @@ -168,7 +172,6 @@ fn format_import_block( Inserted, } - // Categorize by type (e.g., first-party vs. third-party). let mut block_by_type = categorize_imports( block, src, @@ -179,6 +182,7 @@ fn format_import_block( settings.no_sections, &settings.section_order, &settings.default_section, + match_source_strategy, ); let mut output = String::new(); @@ -854,6 +858,57 @@ mod tests { Ok(()) } + #[test_case(Path::new("this_this_from.py"))] + fn required_importfrom_with_useless_alias(path: &Path) -> Result<()> { + let snapshot = format!( + "required_importfrom_with_useless_alias_{}", + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("isort/required_imports").join(path).as_path(), + &LinterSettings { + src: vec![test_resource_path("fixtures/isort")], + isort: super::settings::Settings { + required_imports: BTreeSet::from_iter([NameImport::ImportFrom( + MemberNameImport::alias( + "module".to_string(), + "this".to_string(), + "this".to_string(), + ), + )]), + ..super::settings::Settings::default() + }, + ..LinterSettings::for_rules([Rule::MissingRequiredImport, Rule::UselessImportAlias]) + }, + )?; + + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case(Path::new("this_this.py"))] + fn required_import_with_useless_alias(path: &Path) -> Result<()> { + let snapshot = format!( + "required_import_with_useless_alias_{}", + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("isort/required_imports").join(path).as_path(), + &LinterSettings { + src: vec![test_resource_path("fixtures/isort")], + isort: super::settings::Settings { + required_imports: BTreeSet::from_iter([NameImport::Import( + ModuleNameImport::alias("this".to_string(), "this".to_string()), + )]), + ..super::settings::Settings::default() + }, + ..LinterSettings::for_rules([Rule::MissingRequiredImport, Rule::UselessImportAlias]) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test_case(Path::new("docstring.py"))] #[test_case(Path::new("docstring.pyi"))] #[test_case(Path::new("docstring_only.py"))] diff --git a/crates/ruff_linter/src/rules/isort/normalize.rs b/crates/ruff_linter/src/rules/isort/normalize.rs index f7f7bcabce9fb..b59113a11d052 100644 --- a/crates/ruff_linter/src/rules/isort/normalize.rs +++ b/crates/ruff_linter/src/rules/isort/normalize.rs @@ -1,6 +1,6 @@ +use super::AnnotatedImport; use super::settings::Settings; use super::types::{AliasData, ImportBlock, ImportFromData, TrailingComma}; -use super::AnnotatedImport; pub(crate) fn normalize_imports<'a>( imports: Vec<AnnotatedImport<'a>>, @@ -53,10 +53,9 @@ pub(crate) fn normalize_imports<'a>( } => { // Whether to track each member of the import as a separate entry. let isolate_aliases = settings.force_single_line - && module.map_or(true, |module| { - !settings.single_line_exclusions.contains(module) - }) - && !names.first().is_some_and(|alias| alias.name == "*"); + && module + .is_none_or(|module| !settings.single_line_exclusions.contains(module)) + && names.first().is_none_or(|alias| alias.name != "*"); // Insert comments on the statement itself. if isolate_aliases { diff --git a/crates/ruff_linter/src/rules/isort/order.rs b/crates/ruff_linter/src/rules/isort/order.rs index 6555101aad251..fca47f8775d24 100644 --- a/crates/ruff_linter/src/rules/isort/order.rs +++ b/crates/ruff_linter/src/rules/isort/order.rs @@ -54,7 +54,7 @@ pub(crate) fn order_imports<'a>( }, ); - let ordered_imports = if matches!(section, ImportSection::Known(ImportType::Future)) { + if matches!(section, ImportSection::Known(ImportType::Future)) { from_imports .sorted_by_cached_key(|(import_from, _, _, aliases)| { ModuleKey::from_module( @@ -140,7 +140,5 @@ pub(crate) fn order_imports<'a>( .chain(ordered_from_imports.into_iter().map(ImportFrom)) .collect() } - }; - - ordered_imports + } } diff --git a/crates/ruff_linter/src/rules/isort/rules/add_required_imports.rs b/crates/ruff_linter/src/rules/isort/rules/add_required_imports.rs index 9e1144c61e1ca..51162773c1df5 100644 --- a/crates/ruff_linter/src/rules/isort/rules/add_required_imports.rs +++ b/crates/ruff_linter/src/rules/isort/rules/add_required_imports.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_docstring_stmt; use ruff_python_ast::{self as ast, ModModule, PySourceType, Stmt}; use ruff_python_codegen::Stylist; @@ -7,9 +7,9 @@ use ruff_python_parser::Parsed; use ruff_python_semantic::{FutureImport, NameImport}; use ruff_text_size::{TextRange, TextSize}; +use crate::Locator; use crate::importer::Importer; use crate::settings::LinterSettings; -use crate::Locator; /// ## What it does /// Adds any required imports, as specified by the user, to the top of the @@ -37,8 +37,8 @@ use crate::Locator; /// /// ## Options /// - `lint.isort.required-imports` -#[violation] -pub struct MissingRequiredImport(pub String); +#[derive(ViolationMetadata)] +pub(crate) struct MissingRequiredImport(pub String); impl AlwaysFixableViolation for MissingRequiredImport { #[derive_message_formats] @@ -85,7 +85,6 @@ fn includes_import(stmt: &Stmt, target: &NameImport) -> bool { } } -#[allow(clippy::too_many_arguments)] fn add_required_import( required_import: &NameImport, parsed: &Parsed<ModModule>, diff --git a/crates/ruff_linter/src/rules/isort/rules/organize_imports.rs b/crates/ruff_linter/src/rules/isort/rules/organize_imports.rs index 8f9aebdc0cfc3..83c13f3f4a95e 100644 --- a/crates/ruff_linter/src/rules/isort/rules/organize_imports.rs +++ b/crates/ruff_linter/src/rules/isort/rules/organize_imports.rs @@ -1,24 +1,24 @@ -use std::path::Path; - use itertools::{EitherOrBoth, Itertools}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::whitespace::trailing_lines_end; -use ruff_python_ast::{PySourceType, Stmt}; +use ruff_python_ast::{PySourceType, PythonVersion, Stmt}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; use ruff_python_parser::Tokens; -use ruff_python_trivia::{leading_indentation, textwrap::indent, PythonWhitespace}; +use ruff_python_trivia::{PythonWhitespace, leading_indentation, textwrap::indent}; use ruff_source_file::{LineRanges, UniversalNewlines}; use ruff_text_size::{Ranged, TextRange}; -use crate::line_width::LineWidthBuilder; -use crate::settings::LinterSettings; -use crate::Locator; - use super::super::block::Block; use super::super::{comments, format_imports}; +use crate::Locator; +use crate::line_width::LineWidthBuilder; +use crate::package::PackageRoot; +use crate::preview::is_full_path_match_source_strategy_enabled; +use crate::rules::isort::categorize::MatchSourceStrategy; +use crate::settings::LinterSettings; /// ## What it does /// De-duplicates, groups, and sorts imports based on the provided `isort` settings. @@ -38,15 +38,22 @@ use super::super::{comments, format_imports}; /// import numpy as np /// import pandas /// ``` -#[violation] -pub struct UnsortedImports; +/// +/// ## Preview +/// When [`preview`](https://docs.astral.sh/ruff/preview/) mode is enabled, Ruff applies a stricter criterion +/// for determining whether an import should be classified as first-party. +/// Specifically, for an import of the form `import foo.bar.baz`, Ruff will +/// check that `foo/bar`, relative to a [user-specified `src`](https://docs.astral.sh/ruff/settings/#src) directory, contains either +/// the directory `baz` or else a file with the name `baz.py` or `baz.pyi`. +#[derive(ViolationMetadata)] +pub(crate) struct UnsortedImports; impl Violation for UnsortedImports { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Import block is un-sorted or un-formatted") + "Import block is un-sorted or un-formatted".to_string() } fn fix_title(&self) -> Option<String> { @@ -79,7 +86,7 @@ fn matches_ignoring_indentation(val1: &str, val2: &str) -> bool { }) } -#[allow(clippy::cast_sign_loss, clippy::too_many_arguments)] +#[expect(clippy::too_many_arguments)] /// I001 pub(crate) fn organize_imports( block: &Block, @@ -87,9 +94,10 @@ pub(crate) fn organize_imports( stylist: &Stylist, indexer: &Indexer, settings: &LinterSettings, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, source_type: PySourceType, tokens: &Tokens, + target_version: PythonVersion, ) -> Option<Diagnostic> { let indentation = locator.slice(extract_indentation_range(&block.imports, locator)); let indentation = leading_indentation(indentation); @@ -118,6 +126,12 @@ pub(crate) fn organize_imports( trailing_lines_end(block.imports.last().unwrap(), locator.contents()) }; + let match_source_strategy = if is_full_path_match_source_strategy_enabled(settings) { + MatchSourceStrategy::FullPath + } else { + MatchSourceStrategy::Root + }; + // Generate the sorted import block. let expected = format_imports( block, @@ -129,22 +143,22 @@ pub(crate) fn organize_imports( &settings.src, package, source_type, - settings.target_version, + target_version, &settings.isort, + match_source_strategy, tokens, ); // Expand the span the entire range, including leading and trailing space. - let range = TextRange::new(locator.line_start(range.start()), trailing_line_end); - let actual = locator.slice(range); + let fix_range = TextRange::new(locator.line_start(range.start()), trailing_line_end); + let actual = locator.slice(fix_range); if matches_ignoring_indentation(actual, &expected) { return None; } - let mut diagnostic = Diagnostic::new(UnsortedImports, range); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( indent(&expected, indentation).to_string(), - range, + fix_range, ))); Some(diagnostic) } diff --git a/crates/ruff_linter/src/rules/isort/settings.rs b/crates/ruff_linter/src/rules/isort/settings.rs index 7324be1f8da66..05a4dddf081ae 100644 --- a/crates/ruff_linter/src/rules/isort/settings.rs +++ b/crates/ruff_linter/src/rules/isort/settings.rs @@ -10,10 +10,10 @@ use serde::{Deserialize, Serialize}; use strum::IntoEnumIterator; use crate::display_settings; -use crate::rules::isort::categorize::KnownModules; use crate::rules::isort::ImportType; +use crate::rules::isort::categorize::KnownModules; use ruff_macros::CacheKey; -use ruff_python_semantic::NameImport; +use ruff_python_semantic::{Alias, MemberNameImport, ModuleNameImport, NameImport}; use super::categorize::ImportSection; @@ -45,7 +45,7 @@ impl Display for RelativeImportsOrder { } #[derive(Debug, Clone, CacheKey)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub struct Settings { pub required_imports: BTreeSet<NameImport>, pub combine_as_imports: bool, @@ -75,6 +75,29 @@ pub struct Settings { pub length_sort_straight: bool, } +impl Settings { + pub fn requires_module_import(&self, name: String, as_name: Option<String>) -> bool { + self.required_imports + .contains(&NameImport::Import(ModuleNameImport { + name: Alias { name, as_name }, + })) + } + pub fn requires_member_import( + &self, + module: Option<String>, + name: String, + as_name: Option<String>, + level: u32, + ) -> bool { + self.required_imports + .contains(&NameImport::ImportFrom(MemberNameImport { + module, + name: Alias { name, as_name }, + level, + })) + } +} + impl Default for Settings { fn default() -> Self { Self { diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__1_separate_subpackage_first_and_third_party_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__1_separate_subpackage_first_and_third_party_imports.py.snap index 68c6ab87ddf01..b040527eaf75f 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__1_separate_subpackage_first_and_third_party_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__1_separate_subpackage_first_and_third_party_imports.py.snap @@ -11,6 +11,7 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 6 | | import foo 7 | | import foo.bar 8 | | import foo.bar.baz + | |__________________^ I001 | = help: Organize imports @@ -29,5 +30,3 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 6 |-import foo 7 |-import foo.bar 8 |-import foo.bar.baz - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__2_separate_subpackage_first_and_third_party_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__2_separate_subpackage_first_and_third_party_imports.py.snap index 26039b8c93453..2ab59bd971b8e 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__2_separate_subpackage_first_and_third_party_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__2_separate_subpackage_first_and_third_party_imports.py.snap @@ -11,6 +11,7 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 6 | | import foo 7 | | import foo.bar 8 | | import foo.bar.baz + | |__________________^ I001 | = help: Organize imports @@ -28,5 +29,3 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 7 |-import foo.bar 8 |-import foo.bar.baz 10 |+from foo import bar, baz - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__add_newline_before_comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__add_newline_before_comments.py.snap index 95cca1454b583..9d1391be60254 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__add_newline_before_comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__add_newline_before_comments.py.snap @@ -10,6 +10,7 @@ add_newline_before_comments.py:1:1: I001 [*] Import block is un-sorted or un-for 5 | | # This is a comment, but it starts a new section, so we don't need to add a newline 6 | | # before it. 7 | | import leading_prefix + | |_____________________^ I001 | = help: Organize imports @@ -24,5 +25,3 @@ add_newline_before_comments.py:1:1: I001 [*] Import block is un-sorted or un-for 5 8 | # This is a comment, but it starts a new section, so we don't need to add a newline 6 9 | # before it. 7 10 | import leading_prefix - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__as_imports_comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__as_imports_comments.py.snap index 4866de74a682e..ce014c51f89cd 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__as_imports_comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__as_imports_comments.py.snap @@ -6,18 +6,19 @@ as_imports_comments.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from foo import ( # Comment on `foo` 2 | | Member as Alias, # Comment on `Alias` 3 | | ) - 4 | | + 4 | | 5 | | from bar import ( # Comment on `bar` 6 | | Member, # Comment on `Member` 7 | | ) - 8 | | + 8 | | 9 | | from baz import ( # Comment on `baz` 10 | | Member as Alias # Comment on `Alias` 11 | | ) -12 | | +12 | | 13 | | from bop import ( # Comment on `bop` 14 | | Member # Comment on `Member` 15 | | ) + | |_^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_sorted.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_sorted.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_sorted.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_sorted.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_unsorted.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_unsorted.py.snap index d9c75d398f75b..7caa0cade219a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_unsorted.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__bom_unsorted.py.snap @@ -3,9 +3,9 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- bom_unsorted.py:1:1: I001 [*] Import block is un-sorted or un-formatted | -1 | import foo - | _^ +1 | / import foo 2 | | import bar + | |__________^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__case_sensitive_case_sensitive.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__case_sensitive_case_sensitive.py.snap index 1374bd787f733..bcaa385eecf44 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__case_sensitive_case_sensitive.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__case_sensitive_case_sensitive.py.snap @@ -12,6 +12,7 @@ case_sensitive.py:1:1: I001 [*] Import block is un-sorted or un-formatted 7 | | import f 8 | | from g import a, B, c 9 | | from h import A, b, C + | |_____________________^ I001 | = help: Organize imports @@ -29,5 +30,3 @@ case_sensitive.py:1:1: I001 [*] Import block is un-sorted or un-formatted 9 |-from h import A, b, C 8 |+from g import B, a, c 9 |+from h import A, C, b - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__closest_to_furthest_relative_imports_order.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__closest_to_furthest_relative_imports_order.py.snap index 3c554a7eed595..61df2c9ece4be 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__closest_to_furthest_relative_imports_order.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__closest_to_furthest_relative_imports_order.py.snap @@ -6,6 +6,7 @@ relative_imports_order.py:1:1: I001 [*] Import block is un-sorted or un-formatte 1 | / from ... import a 2 | | from .. import b 3 | | from . import c + | |_______________^ I001 | = help: Organize imports @@ -15,5 +16,3 @@ relative_imports_order.py:1:1: I001 [*] Import block is un-sorted or un-formatte 1 3 | from ... import a 2 |-from .. import b 3 |-from . import c - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports.py.snap index 7888f59e11d85..e3ad645a87f83 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports.py.snap @@ -7,6 +7,7 @@ combine_as_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 | | from module import CONSTANT 3 | | from module import function 4 | | from module import function as f + | |________________________________^ I001 | = help: Organize imports @@ -16,5 +17,3 @@ combine_as_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 |-from module import CONSTANT 3 |-from module import function 4 3 | from module import function as f - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports_combine_as_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports_combine_as_imports.py.snap index 0ec3437a37641..938f2be5662ba 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports_combine_as_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_as_imports_combine_as_imports.py.snap @@ -7,6 +7,7 @@ combine_as_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 | | from module import CONSTANT 3 | | from module import function 4 | | from module import function as f + | |________________________________^ I001 | = help: Organize imports @@ -16,5 +17,3 @@ combine_as_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 3 |-from module import function 4 |-from module import function as f 1 |+from module import CONSTANT, Class as C, function, function as f - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_import_from.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_import_from.py.snap index b5783de363867..336030d66a7cf 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_import_from.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__combine_import_from.py.snap @@ -8,6 +8,7 @@ combine_import_from.py:1:1: I001 [*] Import block is un-sorted or un-formatted 3 | | from collections import Collection 4 | | from collections import ChainMap 5 | | from collections import MutableSequence, MutableMapping + | |_______________________________________________________^ I001 | = help: Organize imports @@ -25,5 +26,3 @@ combine_import_from.py:1:1: I001 [*] Import block is un-sorted or un-formatted 6 |+ MutableMapping, 7 |+ MutableSequence, 8 |+) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__comments.py.snap index 133ac942147ba..c2fab23c8aed5 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__comments.py.snap @@ -6,17 +6,17 @@ comments.py:3:1: I001 [*] Import block is un-sorted or un-formatted 1 | # Comment 1 2 | # Comment 2 3 | / import D - 4 | | + 4 | | 5 | | # Comment 3a 6 | | import C - 7 | | + 7 | | 8 | | # Comment 3b 9 | | import C -10 | | +10 | | 11 | | import B # Comment 4 -12 | | +12 | | 13 | | # Comment 5 -14 | | +14 | | 15 | | # Comment 6 16 | | from A import ( 17 | | a, # Comment 7 @@ -28,14 +28,15 @@ comments.py:3:1: I001 [*] Import block is un-sorted or un-formatted 23 | | b, # Comment 10 24 | | c, # Comment 11 25 | | ) -26 | | +26 | | 27 | | from D import a_long_name_to_force_multiple_lines # Comment 12 28 | | from D import another_long_name_to_force_multiple_lines # Comment 13 -29 | | +29 | | 30 | | from E import a # Comment 1 -31 | | +31 | | 32 | | from F import a # Comment 1 33 | | from F import b + | |_______________^ I001 | = help: Organize imports @@ -85,5 +86,3 @@ comments.py:3:1: I001 [*] Import block is un-sorted or un-formatted 23 |+ a, # Comment 1 24 |+ b, 25 |+) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__deduplicate_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__deduplicate_imports.py.snap index 4ec8ce1b51b52..330484dd87da3 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__deduplicate_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__deduplicate_imports.py.snap @@ -7,6 +7,7 @@ deduplicate_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 | | import os 3 | | import os as os1 4 | | import os as os2 + | |________________^ I001 | = help: Organize imports @@ -15,5 +16,3 @@ deduplicate_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 |-import os 3 2 | import os as os1 4 3 | import os as os2 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__default_section_can_map_to_user_defined_section_default_section_user_defined.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__default_section_can_map_to_user_defined_section_default_section_user_defined.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__default_section_can_map_to_user_defined_section_default_section_user_defined.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__default_section_can_map_to_user_defined_section_default_section_user_defined.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__detect_same_package.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__detect_same_package.snap index 25d20bc8a59bd..999de4a0c2c00 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__detect_same_package.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__detect_same_package.snap @@ -6,6 +6,7 @@ bar.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / import os 2 | | import pandas 3 | | import foo.baz + | |______________^ I001 | = help: Organize imports @@ -15,5 +16,3 @@ bar.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 3 | import pandas 4 |+ 3 5 | import foo.baz - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length.py.snap index e6ea05b4e429c..2a2ad9b3c582a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -fit_line_length.py:7:1: I001 [*] Import block is un-sorted or un-formatted +fit_line_length.py:7:5: I001 [*] Import block is un-sorted or un-formatted | 6 | if indented: 7 | / from line_with_88 import aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -12,6 +12,7 @@ fit_line_length.py:7:1: I001 [*] Import block is un-sorted or un-formatted 12 | | from line_with_93 import ( 13 | | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, 14 | | ) + | |_____^ I001 | = help: Organize imports @@ -38,5 +39,3 @@ fit_line_length.py:7:1: I001 [*] Import block is un-sorted or un-formatted 12 20 | from line_with_93 import ( 13 21 | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, 14 22 | ) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length_comment.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length_comment.py.snap index 5efdf7d3216fb..830674f1308f4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length_comment.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__fit_line_length_comment.py.snap @@ -11,6 +11,7 @@ fit_line_length_comment.py:1:1: I001 [*] Import block is un-sorted or un-formatt 6 | | from f import g # 012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ 7 | | # The next import doesn't fit on one line. 8 | | from h import i # 012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9 + | |_______________^ I001 | = help: Organize imports @@ -32,5 +33,3 @@ fit_line_length_comment.py:1:1: I001 [*] Import block is un-sorted or un-formatt 13 |+from h import ( 14 |+ i, # 012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9012ß9💣2ℝ9 15 |+) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_single_line_force_single_line.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_single_line_force_single_line.py.snap index b7fa34f0e2562..a13e203531154 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_single_line_force_single_line.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_single_line_force_single_line.py.snap @@ -11,25 +11,26 @@ force_single_line.py:1:1: I001 [*] Import block is un-sorted or un-formatted 6 | | from json import load 7 | | from json import loads as json_loads 8 | | from logging.handlers import StreamHandler, FileHandler - 9 | | + 9 | | 10 | | # comment 1 11 | | from third_party import lib1, lib2, \ 12 | | lib3, lib7, lib5, lib6 13 | | # comment 2 14 | | from third_party import lib4 -15 | | +15 | | 16 | | from foo import bar # comment 3 17 | | from foo2 import bar2 # comment 4 18 | | from foo3 import bar3, baz3 # comment 5 -19 | | +19 | | 20 | | # comment 6 21 | | from bar import ( 22 | | a, # comment 7 23 | | b, # comment 8 24 | | ) -25 | | +25 | | 26 | | # comment 9 27 | | from baz import * # comment 10 + | |_________________^ I001 | = help: Organize imports @@ -81,5 +82,3 @@ force_single_line.py:1:1: I001 [*] Import block is un-sorted or un-formatted 29 |+from third_party import lib5 30 |+from third_party import lib6 31 |+from third_party import lib7 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections.py.snap index 43ecebee2265d..6e4fabaa91e5c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections.py.snap @@ -10,12 +10,13 @@ force_sort_within_sections.py:1:1: I001 [*] Import block is un-sorted or un-form 5 | | from z import z1 6 | | import b as b1 # import_as 7 | | import z - 8 | | + 8 | | 9 | | from ..parent import * 10 | | from .my import fn 11 | | from . import my 12 | | from .my.nested import fn2 13 | | from ...grandparent import fn3 + | |______________________________^ I001 | = help: Organize imports @@ -39,5 +40,3 @@ force_sort_within_sections.py:1:1: I001 [*] Import block is un-sorted or un-form 11 |-from . import my 12 13 | from .my.nested import fn2 13 |-from ...grandparent import fn3 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections.py.snap index 412d6f38862d5..1df72338f5672 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections.py.snap @@ -10,12 +10,13 @@ force_sort_within_sections.py:1:1: I001 [*] Import block is un-sorted or un-form 5 | | from z import z1 6 | | import b as b1 # import_as 7 | | import z - 8 | | + 8 | | 9 | | from ..parent import * 10 | | from .my import fn 11 | | from . import my 12 | | from .my.nested import fn2 13 | | from ...grandparent import fn3 + | |______________________________^ I001 | = help: Organize imports @@ -40,5 +41,3 @@ force_sort_within_sections.py:1:1: I001 [*] Import block is un-sorted or un-form 11 |-from . import my 12 13 | from .my.nested import fn2 13 |-from ...grandparent import fn3 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_future.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_future.py.snap index 6864d488b75ed..269e175c0409b 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_future.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_future.py.snap @@ -5,6 +5,7 @@ force_sort_within_sections_future.py:1:1: I001 [*] Import block is un-sorted or | 1 | / import __future__ 2 | | from __future__ import annotations + | |__________________________________^ I001 | = help: Organize imports @@ -12,5 +13,3 @@ force_sort_within_sections_future.py:1:1: I001 [*] Import block is un-sorted or 1 |+from __future__ import annotations 1 2 | import __future__ 2 |-from __future__ import annotations - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_lines_between.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_lines_between.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_lines_between.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_lines_between.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_with_as_names.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_with_as_names.py.snap index b14f52ac659df..8ef755569c9c4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_with_as_names.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_sort_within_sections_force_sort_within_sections_with_as_names.py.snap @@ -8,6 +8,7 @@ force_sort_within_sections_with_as_names.py:1:1: I001 [*] Import block is un-sor 3 | | from datetime import timedelta 4 | | import datetime as dt 5 | | import datetime + | |_______________^ I001 | = help: Organize imports @@ -21,5 +22,3 @@ force_sort_within_sections_with_as_names.py:1:1: I001 [*] Import block is un-sor 3 |-from datetime import timedelta 4 |-import datetime as dt 5 |-import datetime - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top.py.snap index eccb76bc9efff..fbf675285ed6e 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top.py.snap @@ -9,7 +9,7 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 4 | | import lib1 5 | | import lib3 6 | | import lib4 - 7 | | + 7 | | 8 | | import foo 9 | | import z 10 | | from foo import bar @@ -21,11 +21,12 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 16 | | from lib5 import lib2 17 | | from lib4 import lib2 18 | | from lib5 import lib1 -19 | | +19 | | 20 | | import lib3.lib4 21 | | import lib3.lib4.lib5 22 | | from lib3.lib4 import foo 23 | | from lib3.lib4.lib5 import foo + | |______________________________^ I001 | = help: Organize imports @@ -63,5 +64,3 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 23 17 | from lib3.lib4.lib5 import foo 18 |+from lib4 import lib1, lib2 19 |+from lib5 import lib1, lib2 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top_force_to_top.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top_force_to_top.py.snap index eb5678616bfb2..901bb0dc67f2c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top_force_to_top.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_to_top_force_to_top.py.snap @@ -9,7 +9,7 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 4 | | import lib1 5 | | import lib3 6 | | import lib4 - 7 | | + 7 | | 8 | | import foo 9 | | import z 10 | | from foo import bar @@ -21,11 +21,12 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 16 | | from lib5 import lib2 17 | | from lib4 import lib2 18 | | from lib5 import lib1 -19 | | +19 | | 20 | | import lib3.lib4 21 | | import lib3.lib4.lib5 22 | | from lib3.lib4 import foo 23 | | from lib3.lib4.lib5 import foo + | |______________________________^ I001 | = help: Organize imports @@ -66,5 +67,3 @@ force_to_top.py:1:1: I001 [*] Import block is un-sorted or un-formatted 17 |+from lib2 import foo 23 18 | from lib3.lib4.lib5 import foo 19 |+from lib4 import lib1, lib2 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases.py.snap index e19ca4942bfb8..0d6e3303750b0 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases.py.snap @@ -6,6 +6,7 @@ force_wrap_aliases.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from .a import a1 as a1, a2 as a2 2 | | from .b import b1 as b1 3 | | from .c import c1 + | |_________________^ I001 | = help: Organize imports @@ -15,5 +16,3 @@ force_wrap_aliases.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 |+from .a import a2 as a2 2 3 | from .b import b1 as b1 3 4 | from .c import c1 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases_force_wrap_aliases.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases_force_wrap_aliases.py.snap index d59c8a13d1e20..04739f35ab42b 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases_force_wrap_aliases.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__force_wrap_aliases_force_wrap_aliases.py.snap @@ -6,6 +6,7 @@ force_wrap_aliases.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from .a import a1 as a1, a2 as a2 2 | | from .b import b1 as b1 3 | | from .c import c1 + | |_________________^ I001 | = help: Organize imports @@ -17,5 +18,3 @@ force_wrap_aliases.py:1:1: I001 [*] Import block is un-sorted or un-formatted 4 |+) 2 5 | from .b import b1 as b1 3 6 | from .c import c1 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__forced_separate.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__forced_separate.py.snap index ad410b015c2ec..e645e85d2ba36 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__forced_separate.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__forced_separate.py.snap @@ -11,6 +11,7 @@ forced_separate.py:3:1: I001 [*] Import block is un-sorted or un-formatted 6 | | from experiments.starry import * 7 | | from experiments.weird import varieties 8 | | from office_helper.assistants import entity_registry as er + | |__________________________________________________________^ I001 | = help: Organize imports @@ -26,5 +27,3 @@ forced_separate.py:3:1: I001 [*] Import block is un-sorted or un-formatted 6 9 | from experiments.starry import * 7 10 | from experiments.weird import varieties 8 |-from office_helper.assistants import entity_registry as er - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__from_first_from_first.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__from_first_from_first.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__from_first_from_first.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__from_first_from_first.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__future_from.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__future_from.py.snap index f3f5cd2a3574d..2481bb1775fbc 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__future_from.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__future_from.py.snap @@ -5,6 +5,7 @@ future_from.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import __future__ 2 | | from __future__ import annotations + | |__________________________________^ I001 | = help: Organize imports @@ -12,5 +13,3 @@ future_from.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 |+from __future__ import annotations 1 2 | import __future__ 2 |-from __future__ import annotations - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__glob_1_separate_subpackage_first_and_third_party_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__glob_1_separate_subpackage_first_and_third_party_imports.py.snap index 68c6ab87ddf01..b040527eaf75f 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__glob_1_separate_subpackage_first_and_third_party_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__glob_1_separate_subpackage_first_and_third_party_imports.py.snap @@ -11,6 +11,7 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 6 | | import foo 7 | | import foo.bar 8 | | import foo.bar.baz + | |__________________^ I001 | = help: Organize imports @@ -29,5 +30,3 @@ separate_subpackage_first_and_third_party_imports.py:1:1: I001 [*] Import block 6 |-import foo 7 |-import foo.bar 8 |-import foo.bar.baz - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__if_elif_else.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__if_elif_else.py.snap index 4a09c500c40be..3edbbf1dbd588 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__if_elif_else.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__if_elif_else.py.snap @@ -1,12 +1,13 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -if_elif_else.py:6:1: I001 [*] Import block is un-sorted or un-formatted +if_elif_else.py:6:5: I001 [*] Import block is un-sorted or un-formatted | 4 | from setuptools.command.sdist import sdist as _sdist 5 | else: 6 | / from setuptools.command.sdist import sdist as _sdist 7 | | from distutils.command.sdist import sdist as _sdist + | |_______________________________________________________^ I001 | = help: Organize imports @@ -17,5 +18,3 @@ if_elif_else.py:6:1: I001 [*] Import block is un-sorted or un-formatted 6 |+ from distutils.command.sdist import sdist as _sdist 6 7 | from setuptools.command.sdist import sdist as _sdist 7 |- from distutils.command.sdist import sdist as _sdist - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__import_from_after_import.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__import_from_after_import.py.snap index 09e2aa2a32542..b1d09d2b672b5 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__import_from_after_import.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__import_from_after_import.py.snap @@ -5,6 +5,7 @@ import_from_after_import.py:1:1: I001 [*] Import block is un-sorted or un-format | 1 | / from collections import Collection 2 | | import os + | |_________^ I001 | = help: Organize imports @@ -12,5 +13,3 @@ import_from_after_import.py:1:1: I001 [*] Import block is un-sorted or un-format 1 |+import os 1 2 | from collections import Collection 2 |-import os - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__inline_comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__inline_comments.py.snap index bc6a07f6581b5..03df06aaa5092 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__inline_comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__inline_comments.py.snap @@ -6,14 +6,15 @@ inline_comments.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from a.prometheus.metrics import ( # type:ignore[attr-defined] 2 | | TERMINAL_CURRENTLY_RUNNING_TOTAL, 3 | | ) - 4 | | + 4 | | 5 | | from b.prometheus.metrics import ( 6 | | TERMINAL_CURRENTLY_RUNNING_TOTAL, # type:ignore[attr-defined] 7 | | ) - 8 | | + 8 | | 9 | | from c.prometheus.metrics import TERMINAL_CURRENTLY_RUNNING_TOTAL # type:ignore[attr-defined] -10 | | +10 | | 11 | | from d.prometheus.metrics import TERMINAL_CURRENTLY_RUNNING_TOTAL, OTHER_RUNNING_TOTAL # type:ignore[attr-defined] + | |______________________________________________________________________________________^ I001 | = help: Organize imports @@ -36,5 +37,3 @@ inline_comments.py:1:1: I001 [*] Import block is un-sorted or un-formatted 11 |+ OTHER_RUNNING_TOTAL, 12 |+ TERMINAL_CURRENTLY_RUNNING_TOTAL, 13 |+) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.py.snap index 238cb6092207f..abd18b22f6d43 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.py.snap @@ -5,10 +5,9 @@ insert_empty_lines.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import a 2 | | import b -3 | | x = 1 - | |_^ I001 + | |________^ I001 +3 | x = 1 4 | import os -5 | import sys | = help: Organize imports @@ -26,10 +25,9 @@ insert_empty_lines.py:4:1: I001 [*] Import block is un-sorted or un-formatted 3 | x = 1 4 | / import os 5 | | import sys -6 | | def f(): - | |_^ I001 + | |__________^ I001 +6 | def f(): 7 | pass -8 | if True: | = help: Organize imports @@ -49,10 +47,8 @@ insert_empty_lines.py:14:1: I001 [*] Import block is un-sorted or un-formatted 13 | y = 1 14 | / import os 15 | | import sys -16 | | """Docstring""" - | |_^ I001 -17 | -18 | if True: + | |__________^ I001 +16 | """Docstring""" | = help: Organize imports @@ -67,12 +63,10 @@ insert_empty_lines.py:14:1: I001 [*] Import block is un-sorted or un-formatted insert_empty_lines.py:52:1: I001 [*] Import block is un-sorted or un-formatted | -52 | / import os -53 | | -54 | | # Comment goes here. - | |_^ I001 -55 | def f(): -56 | pass +52 | import os + | ^^^^^^^^^ I001 +53 | +54 | # Comment goes here. | = help: Organize imports @@ -84,5 +78,3 @@ insert_empty_lines.py:52:1: I001 [*] Import block is un-sorted or un-formatted 54 55 | # Comment goes here. 55 56 | def f(): 56 57 | pass - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.pyi.snap index a2e262e7e8e18..022f3c67cfd29 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__insert_empty_lines.pyi.snap @@ -5,10 +5,9 @@ insert_empty_lines.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import a 2 | | import b -3 | | x = 1 - | |_^ I001 + | |________^ I001 +3 | x = 1 4 | import os -5 | import sys | = help: Organize imports @@ -26,10 +25,9 @@ insert_empty_lines.pyi:4:1: I001 [*] Import block is un-sorted or un-formatted 3 | x = 1 4 | / import os 5 | | import sys -6 | | def f(): - | |_^ I001 + | |__________^ I001 +6 | def f(): 7 | pass -8 | if True: | = help: Organize imports @@ -48,10 +46,8 @@ insert_empty_lines.pyi:14:1: I001 [*] Import block is un-sorted or un-formatted 13 | y = 1 14 | / import os 15 | | import sys -16 | | """Docstring""" - | |_^ I001 -17 | -18 | if True: + | |__________^ I001 +16 | """Docstring""" | = help: Organize imports @@ -63,5 +59,3 @@ insert_empty_lines.pyi:14:1: I001 [*] Import block is un-sorted or un-formatted 16 17 | """Docstring""" 17 18 | 18 19 | if True: - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__isort_skip_file.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__isort_skip_file.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__isort_skip_file.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__isort_skip_file.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_closest_separate_local_folder_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_closest_separate_local_folder_imports.py.snap index 8eb419a4a4739..598f30f26c7a1 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_closest_separate_local_folder_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_closest_separate_local_folder_imports.py.snap @@ -10,6 +10,7 @@ separate_local_folder_imports.py:1:1: I001 [*] Import block is un-sorted or un-f 5 | | from . import leading_prefix 6 | | from .. import trailing_prefix 7 | | from ruff import check + | |______________________^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_separate_local_folder_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_separate_local_folder_imports.py.snap index 21ed77408c35c..261c27be50bb4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_separate_local_folder_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__known_local_folder_separate_local_folder_imports.py.snap @@ -10,6 +10,7 @@ separate_local_folder_imports.py:1:1: I001 [*] Import block is un-sorted or un-f 5 | | from . import leading_prefix 6 | | from .. import trailing_prefix 7 | | from ruff import check + | |______________________^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__leading_prefix.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__leading_prefix.py.snap index c84144c29ecf2..8197eb32fce86 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__leading_prefix.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__leading_prefix.py.snap @@ -7,7 +7,7 @@ leading_prefix.py:1:8: I001 Import block is un-sorted or un-formatted | ________^ 2 | | import os | |_________^ I001 -3 | +3 | 4 | if True: | = help: Organize imports @@ -19,7 +19,7 @@ leading_prefix.py:5:12: I001 Import block is un-sorted or un-formatted | ____________^ 6 | | import os | |_____________^ I001 -7 | +7 | 8 | if True: | = help: Organize imports @@ -30,7 +30,7 @@ leading_prefix.py:10:9: I001 Import block is un-sorted or un-formatted 9 | x = 1; \ 10 | import os | ^^^^^^^^^ I001 -11 | +11 | 12 | x = 1; \ | = help: Organize imports @@ -42,5 +42,3 @@ leading_prefix.py:13:1: I001 Import block is un-sorted or un-formatted | ^^^^^^^^^ I001 | = help: Organize imports - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_from_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_from_imports.py.snap index a2183e7de32c7..880421c107d90 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_from_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_from_imports.py.snap @@ -6,6 +6,7 @@ length_sort_from_imports.py:1:1: I001 [*] Import block is un-sorted or un-format 1 | / from mediuuuuuuuuuuum import a 2 | | from short import b 3 | | from loooooooooooooooooooooog import c + | |______________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ length_sort_from_imports.py:1:1: I001 [*] Import block is un-sorted or un-format 1 2 | from mediuuuuuuuuuuum import a 2 |-from short import b 3 3 | from loooooooooooooooooooooog import c - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_members.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_members.py.snap index d6cfc0e340920..386b16eb5963c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_members.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_members.py.snap @@ -14,6 +14,7 @@ length_sort_non_ascii_members.py:1:1: I001 [*] Import block is un-sorted or un-f 9 | | mediuuuuuum, 10 | | λοοοοοοοοοοοοοονγ, 11 | | ) + | |_^ I001 | = help: Organize imports @@ -33,5 +34,3 @@ length_sort_non_ascii_members.py:1:1: I001 [*] Import block is un-sorted or un-f 10 9 | λοοοοοοοοοοοοοονγ, 10 |+ looooooooooooooong, 11 11 | ) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_modules.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_modules.py.snap index e1d66bd9a7bb9..b6081a6564fba 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_modules.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_non_ascii_modules.py.snap @@ -12,6 +12,7 @@ length_sort_non_ascii_modules.py:1:1: I001 [*] Import block is un-sorted or un-f 7 | | import λοοοοοοοοοοοοοονγ 8 | | import μεδιυυυυυμ 9 | | import looooooooooooooong + | |_________________________^ I001 | = help: Organize imports @@ -28,5 +29,3 @@ length_sort_non_ascii_modules.py:1:1: I001 [*] Import block is un-sorted or un-f 7 8 | import λοοοοοοοοοοοοοονγ 8 |-import μεδιυυυυυμ 9 9 | import looooooooooooooong - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_and_from_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_and_from_imports.py.snap index 7acc627804180..040722c463daf 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_and_from_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_and_from_imports.py.snap @@ -9,6 +9,7 @@ length_sort_straight_and_from_imports.py:1:1: I001 [*] Import block is un-sorted 4 | | from looooooooooooooong import a 5 | | from mediuuuum import c 6 | | from short import b + | |___________________^ I001 | = help: Organize imports @@ -22,5 +23,3 @@ length_sort_straight_and_from_imports.py:1:1: I001 [*] Import block is un-sorted 5 5 | from mediuuuum import c 6 |-from short import b 6 |+from looooooooooooooong import a - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_imports.py.snap index 6c73af3a2a8fa..e78d25ef386a7 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_straight_imports.py.snap @@ -7,6 +7,7 @@ length_sort_straight_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 2 | | import short 3 | | import looooooooooooooooong 4 | | import mediuuuuuuma + | |___________________^ I001 | = help: Organize imports @@ -17,5 +18,3 @@ length_sort_straight_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 2 |-import short 3 4 | import looooooooooooooooong 4 |-import mediuuuuuuma - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_with_relative_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_with_relative_imports.py.snap index 20531ecd26d43..c8dc6b1e84c46 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_with_relative_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort__length_sort_with_relative_imports.py.snap @@ -10,6 +10,7 @@ length_sort_with_relative_imports.py:1:1: I001 [*] Import block is un-sorted or 5 | | from . import d 6 | | from .mediuuuum import a 7 | | from ......short import b + | |_________________________^ I001 | = help: Organize imports @@ -24,5 +25,3 @@ length_sort_with_relative_imports.py:1:1: I001 [*] Import block is un-sorted or 7 5 | from ......short import b 6 |+from ...mediuuuum import b 7 |+from ..looooooooooooooong import a - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_from_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_from_imports.py.snap index 35bdec18f120c..9d4e3641c26ae 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_from_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_from_imports.py.snap @@ -6,6 +6,7 @@ length_sort_from_imports.py:1:1: I001 [*] Import block is un-sorted or un-format 1 | / from mediuuuuuuuuuuum import a 2 | | from short import b 3 | | from loooooooooooooooooooooog import c + | |______________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ length_sort_from_imports.py:1:1: I001 [*] Import block is un-sorted or un-format 1 2 | from mediuuuuuuuuuuum import a 2 3 | from short import b 3 |-from loooooooooooooooooooooog import c - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_and_from_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_and_from_imports.py.snap index 3cd80a04effd9..ad3fedea0cd98 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_and_from_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_and_from_imports.py.snap @@ -9,6 +9,7 @@ length_sort_straight_and_from_imports.py:1:1: I001 [*] Import block is un-sorted 4 | | from looooooooooooooong import a 5 | | from mediuuuum import c 6 | | from short import b + | |___________________^ I001 | = help: Organize imports @@ -19,5 +20,3 @@ length_sort_straight_and_from_imports.py:1:1: I001 [*] Import block is un-sorted 3 3 | import looooooooooooooooong 4 4 | from looooooooooooooong import a 5 5 | from mediuuuum import c - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_imports.py.snap index 6c73af3a2a8fa..e78d25ef386a7 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__length_sort_straight__length_sort_straight_imports.py.snap @@ -7,6 +7,7 @@ length_sort_straight_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 2 | | import short 3 | | import looooooooooooooooong 4 | | import mediuuuuuuma + | |___________________^ I001 | = help: Organize imports @@ -17,5 +18,3 @@ length_sort_straight_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 2 |-import short 3 4 | import looooooooooooooooong 4 |-import mediuuuuuuma - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_crlf.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_crlf.py.snap index 07043dd802d27..0a5efd84888c3 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_crlf.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_crlf.py.snap @@ -3,9 +3,8 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- line_ending_crlf.py:1:1: I001 [*] Import block is un-sorted or un-formatted | -1 | / from long_module_name import member_one, member_two, member_three, member_four, member_five -2 | | - | |_^ I001 +1 | from long_module_name import member_one, member_two, member_three, member_four, member_five + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 | = help: Organize imports @@ -18,6 +17,4 @@ line_ending_crlf.py:1:1: I001 [*] Import block is un-sorted or un-formatted 5 |+ member_three, 6 |+ member_two, 7 |+) -2 8 | - - +2 8 | diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_lf.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_lf.py.snap index 757fdaa9803b2..37e4e42e78d3c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_lf.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__line_ending_lf.py.snap @@ -3,9 +3,8 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- line_ending_lf.py:1:1: I001 [*] Import block is un-sorted or un-formatted | -1 | / from long_module_name import member_one, member_two, member_three, member_four, member_five -2 | | - | |_^ I001 +1 | from long_module_name import member_one, member_two, member_three, member_four, member_five + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 | = help: Organize imports @@ -18,6 +17,4 @@ line_ending_lf.py:1:1: I001 [*] Import block is un-sorted or un-formatted 5 |+ member_three, 6 |+ member_two, 7 |+) -2 8 | - - +2 8 | diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports.pyi.snap index 3cb4eb573c315..da09ee62184b4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports.pyi.snap @@ -2,25 +2,19 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- lines_after_imports.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted - | - 1 | / from __future__ import annotations - 2 | | - 3 | | from typing import Any - 4 | | - 5 | | from requests import Session - 6 | | - 7 | | from my_first_party import my_first_party_object - 8 | | - 9 | | from . import my_local_folder_object -10 | | -11 | | -12 | | -13 | | class Thing(object): - | |_^ I001 -14 | name: str -15 | def __init__(self, name: str): - | - = help: Organize imports + | +1 | / from __future__ import annotations +2 | | +3 | | from typing import Any +4 | | +5 | | from requests import Session +6 | | +7 | | from my_first_party import my_first_party_object +8 | | +9 | | from . import my_local_folder_object + | |____________________________________^ I001 + | + = help: Organize imports ℹ Safe fix 2 2 | @@ -37,5 +31,3 @@ lines_after_imports.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted 12 9 | 13 10 | class Thing(object): 14 11 | name: str - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_class_after.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_class_after.py.snap index 8f5efb9988504..6327131ec02f2 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_class_after.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_class_after.py.snap @@ -4,18 +4,17 @@ source: crates/ruff_linter/src/rules/isort/mod.rs lines_after_imports_class_after.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations - 2 | | + 2 | | 3 | | from typing import Any - 4 | | + 4 | | 5 | | from requests import Session - 6 | | + 6 | | 7 | | from my_first_party import my_first_party_object - 8 | | + 8 | | 9 | | from . import my_local_folder_object -10 | | class Thing(object): - | |_^ I001 + | |____________________________________^ I001 +10 | class Thing(object): 11 | name: str -12 | def __init__(self, name: str): | = help: Organize imports @@ -34,5 +33,3 @@ lines_after_imports_class_after.py:1:1: I001 [*] Import block is un-sorted or un 10 11 | class Thing(object): 11 12 | name: str 12 13 | def __init__(self, name: str): - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_func_after.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_func_after.py.snap index 0f71f16f36243..8ae7c8f04a54a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_func_after.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_func_after.py.snap @@ -2,32 +2,19 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- lines_after_imports_func_after.py:1:1: I001 [*] Import block is un-sorted or un-formatted - | - 1 | / from __future__ import annotations - 2 | | - 3 | | from typing import Any - 4 | | - 5 | | from requests import Session - 6 | | - 7 | | from my_first_party import my_first_party_object - 8 | | - 9 | | from . import my_local_folder_object -10 | | -11 | | -12 | | -13 | | -14 | | -15 | | -16 | | -17 | | -18 | | -19 | | -20 | | -21 | | def main(): - | |_^ I001 -22 | my_local_folder_object.get() - | - = help: Organize imports + | +1 | / from __future__ import annotations +2 | | +3 | | from typing import Any +4 | | +5 | | from requests import Session +6 | | +7 | | from my_first_party import my_first_party_object +8 | | +9 | | from . import my_local_folder_object + | |____________________________________^ I001 + | + = help: Organize imports ℹ Safe fix 2 2 | @@ -51,5 +38,3 @@ lines_after_imports_func_after.py:1:1: I001 [*] Import block is un-sorted or un- 19 9 | 20 10 | 21 11 | def main(): - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports.pyi.snap index 3cb4eb573c315..da09ee62184b4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports.pyi.snap @@ -2,25 +2,19 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- lines_after_imports.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted - | - 1 | / from __future__ import annotations - 2 | | - 3 | | from typing import Any - 4 | | - 5 | | from requests import Session - 6 | | - 7 | | from my_first_party import my_first_party_object - 8 | | - 9 | | from . import my_local_folder_object -10 | | -11 | | -12 | | -13 | | class Thing(object): - | |_^ I001 -14 | name: str -15 | def __init__(self, name: str): - | - = help: Organize imports + | +1 | / from __future__ import annotations +2 | | +3 | | from typing import Any +4 | | +5 | | from requests import Session +6 | | +7 | | from my_first_party import my_first_party_object +8 | | +9 | | from . import my_local_folder_object + | |____________________________________^ I001 + | + = help: Organize imports ℹ Safe fix 2 2 | @@ -37,5 +31,3 @@ lines_after_imports.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted 12 9 | 13 10 | class Thing(object): 14 11 | name: str - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_class_after.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_class_after.py.snap index 747af3269a61a..2a56708ebaf07 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_class_after.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_class_after.py.snap @@ -4,18 +4,17 @@ source: crates/ruff_linter/src/rules/isort/mod.rs lines_after_imports_class_after.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations - 2 | | + 2 | | 3 | | from typing import Any - 4 | | + 4 | | 5 | | from requests import Session - 6 | | + 6 | | 7 | | from my_first_party import my_first_party_object - 8 | | + 8 | | 9 | | from . import my_local_folder_object -10 | | class Thing(object): - | |_^ I001 + | |____________________________________^ I001 +10 | class Thing(object): 11 | name: str -12 | def __init__(self, name: str): | = help: Organize imports @@ -35,5 +34,3 @@ lines_after_imports_class_after.py:1:1: I001 [*] Import block is un-sorted or un 10 12 | class Thing(object): 11 13 | name: str 12 14 | def __init__(self, name: str): - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_func_after.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_func_after.py.snap index ff312106a4d89..b7764817d28d7 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_func_after.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_func_after.py.snap @@ -2,32 +2,19 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- lines_after_imports_func_after.py:1:1: I001 [*] Import block is un-sorted or un-formatted - | - 1 | / from __future__ import annotations - 2 | | - 3 | | from typing import Any - 4 | | - 5 | | from requests import Session - 6 | | - 7 | | from my_first_party import my_first_party_object - 8 | | - 9 | | from . import my_local_folder_object -10 | | -11 | | -12 | | -13 | | -14 | | -15 | | -16 | | -17 | | -18 | | -19 | | -20 | | -21 | | def main(): - | |_^ I001 -22 | my_local_folder_object.get() - | - = help: Organize imports + | +1 | / from __future__ import annotations +2 | | +3 | | from typing import Any +4 | | +5 | | from requests import Session +6 | | +7 | | from my_first_party import my_first_party_object +8 | | +9 | | from . import my_local_folder_object + | |____________________________________^ I001 + | + = help: Organize imports ℹ Safe fix 2 2 | @@ -49,6 +36,4 @@ lines_after_imports_func_after.py:1:1: I001 [*] Import block is un-sorted or un- 17 |- 18 9 | 19 10 | -20 11 | - - +20 11 | diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_nothing_after.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_nothing_after.py.snap index 37d9fca223fe2..2765bd970cd19 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_nothing_after.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_after_imports_lines_after_imports_nothing_after.py.snap @@ -4,14 +4,15 @@ source: crates/ruff_linter/src/rules/isort/mod.rs lines_after_imports_nothing_after.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations -2 | | +2 | | 3 | | from typing import Any -4 | | +4 | | 5 | | from requests import Session -6 | | +6 | | 7 | | from my_first_party import my_first_party_object -8 | | +8 | | 9 | | from . import my_local_folder_object + | |____________________________________^ I001 | = help: Organize imports @@ -25,5 +26,3 @@ lines_after_imports_nothing_after.py:1:1: I001 [*] Import block is un-sorted or 6 |+from requests import Session 8 7 | 9 8 | from . import my_local_folder_object - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_between_typeslines_between_types.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_between_typeslines_between_types.py.snap index 09ff2aa19ea73..b76cee73ca684 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_between_typeslines_between_types.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__lines_between_typeslines_between_types.py.snap @@ -4,21 +4,22 @@ source: crates/ruff_linter/src/rules/isort/mod.rs lines_between_types.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations - 2 | | + 2 | | 3 | | import datetime 4 | | import json - 5 | | - 6 | | + 5 | | + 6 | | 7 | | from binascii import hexlify - 8 | | + 8 | | 9 | | import requests -10 | | -11 | | +10 | | +11 | | 12 | | from sanic import Sanic 13 | | from loguru import Logger -14 | | +14 | | 15 | | from . import config 16 | | from .data import Data + | |______________________^ I001 | = help: Organize imports @@ -32,5 +33,3 @@ lines_between_types.py:1:1: I001 [*] Import block is un-sorted or un-formatted 14 14 | 15 15 | from . import config 16 16 | from .data import Data - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__magic_trailing_comma.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__magic_trailing_comma.py.snap index 78c0456bcd7ff..f64501a356a99 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__magic_trailing_comma.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__magic_trailing_comma.py.snap @@ -10,7 +10,7 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 5 | | stdout, 6 | | exit, 7 | | ) - 8 | | + 8 | | 9 | | # No magic comma, this will be rolled into one line. 10 | | from os import ( 11 | | path, @@ -18,29 +18,30 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 13 | | execl, 14 | | execv 15 | | ) -16 | | +16 | | 17 | | from glob import ( 18 | | glob, 19 | | iglob, 20 | | escape, # Ends with a comment, should still treat as magic trailing comma. 21 | | ) -22 | | +22 | | 23 | | # These will be combined, but without a trailing comma. 24 | | from foo import bar 25 | | from foo import baz -26 | | +26 | | 27 | | # These will be combined, _with_ a trailing comma. 28 | | from module1 import member1 29 | | from module1 import ( 30 | | member2, 31 | | member3, 32 | | ) -33 | | +33 | | 34 | | # These will be combined, _with_ a trailing comma. 35 | | from module2 import member1, member2 36 | | from module2 import ( 37 | | member3, 38 | | ) + | |_^ I001 | = help: Organize imports @@ -97,5 +98,3 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 30 |+ member2, 37 31 | member3, 38 32 | ) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__match_case.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__match_case.py.snap index d3a6f45d7e73b..950f0b4016074 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__match_case.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__match_case.py.snap @@ -1,16 +1,15 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -match_case.py:3:1: I001 [*] Import block is un-sorted or un-formatted +match_case.py:3:9: I001 [*] Import block is un-sorted or un-formatted | 1 | match 1: 2 | case 1: 3 | / import sys 4 | | import os -5 | | case 2: - | |_^ I001 + | |_________________^ I001 +5 | case 2: 6 | import collections -7 | import abc | = help: Organize imports @@ -24,12 +23,13 @@ match_case.py:3:1: I001 [*] Import block is un-sorted or un-formatted 6 6 | import collections 7 7 | import abc -match_case.py:6:1: I001 [*] Import block is un-sorted or un-formatted +match_case.py:6:9: I001 [*] Import block is un-sorted or un-formatted | 4 | import os 5 | case 2: 6 | / import collections 7 | | import abc + | |__________________^ I001 | = help: Organize imports @@ -40,5 +40,3 @@ match_case.py:6:1: I001 [*] Import block is un-sorted or un-formatted 6 |+ import abc 6 7 | import collections 7 |- import abc - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__natural_order.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__natural_order.py.snap index dbfade412a569..219f80d8d4a52 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__natural_order.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__natural_order.py.snap @@ -19,6 +19,7 @@ natural_order.py:1:1: I001 [*] Import block is un-sorted or un-formatted 14 | | uint32, 15 | | uint64, 16 | | ) + | |_^ I001 | = help: Organize imports @@ -42,5 +43,3 @@ natural_order.py:1:1: I001 [*] Import block is un-sorted or un-formatted 14 14 | uint32, 15 15 | uint64, 16 16 | ) - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_detect_same_package.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_detect_same_package.snap index 391a603c79de1..679e8a9e8f82e 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_detect_same_package.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_detect_same_package.snap @@ -6,6 +6,7 @@ bar.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / import os 2 | | import pandas 3 | | import foo.baz + | |______________^ I001 | = help: Organize imports @@ -15,5 +16,3 @@ bar.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 |+ 3 3 | import foo.baz 4 |+import pandas - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py.snap index 4947f22fef3c7..5f032e7590a7a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py.snap @@ -4,14 +4,15 @@ source: crates/ruff_linter/src/rules/isort/mod.rs no_lines_before.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations -2 | | +2 | | 3 | | from typing import Any -4 | | +4 | | 5 | | from requests import Session -6 | | +6 | | 7 | | from my_first_party import my_first_party_object -8 | | +8 | | 9 | | from . import my_local_folder_object + | |____________________________________^ I001 | = help: Organize imports @@ -25,5 +26,3 @@ no_lines_before.py:1:1: I001 [*] Import block is un-sorted or un-formatted 6 |+from requests import Session 8 7 | 9 8 | from . import my_local_folder_object - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py_no_lines_before.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py_no_lines_before.py.snap index d85f8eb6c3754..10a2a6f8785cb 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py_no_lines_before.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before.py_no_lines_before.py.snap @@ -4,14 +4,15 @@ source: crates/ruff_linter/src/rules/isort/mod.rs no_lines_before.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations -2 | | +2 | | 3 | | from typing import Any -4 | | +4 | | 5 | | from requests import Session -6 | | +6 | | 7 | | from my_first_party import my_first_party_object -8 | | +8 | | 9 | | from . import my_local_folder_object + | |____________________________________^ I001 | = help: Organize imports @@ -26,5 +27,3 @@ no_lines_before.py:1:1: I001 [*] Import block is un-sorted or un-formatted 7 |-from my_first_party import my_first_party_object 8 |- 9 5 | from . import my_local_folder_object - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before_with_empty_sections.py_no_lines_before_with_empty_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before_with_empty_sections.py_no_lines_before_with_empty_sections.py.snap index 0e8d39e7ca878..68559bec6fa88 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before_with_empty_sections.py_no_lines_before_with_empty_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_lines_before_with_empty_sections.py_no_lines_before_with_empty_sections.py.snap @@ -6,6 +6,7 @@ no_lines_before_with_empty_sections.py:1:1: I001 [*] Import block is un-sorted o 1 | / from __future__ import annotations 2 | | from typing import Any 3 | | from . import my_local_folder_object + | |____________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ no_lines_before_with_empty_sections.py:1:1: I001 [*] Import block is un-sorted o 2 2 | from typing import Any 3 |+ 3 4 | from . import my_local_folder_object - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_reorder_within_section.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_reorder_within_section.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_reorder_within_section.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_reorder_within_section.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_sections_no_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_sections_no_sections.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_sections_no_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_sections_no_sections.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_standard_library_no_standard_library.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_standard_library_no_standard_library.py.snap index 8dfcfe5183d0b..b860573af39e0 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_standard_library_no_standard_library.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_standard_library_no_standard_library.py.snap @@ -4,14 +4,15 @@ source: crates/ruff_linter/src/rules/isort/mod.rs no_standard_library.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from __future__ import annotations -2 | | +2 | | 3 | | import os 4 | | import django.settings 5 | | from library import foo 6 | | import pytz -7 | | +7 | | 8 | | from . import local 9 | | import sys + | |__________^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_wrap_star.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_wrap_star.py.snap index c99b0fdb4e60a..5442ac6b7d999 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_wrap_star.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_wrap_star.py.snap @@ -3,12 +3,11 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- no_wrap_star.py:1:1: I001 [*] Import block is un-sorted or un-formatted | -1 | / from .subscription import * # type: ignore # some very long comment explaining why this needs a type ignore +1 | from .subscription import * # type: ignore # some very long comment explaining why this needs a type ignore + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 | = help: Organize imports ℹ Safe fix 1 |-from .subscription import * # type: ignore # some very long comment explaining why this needs a type ignore 1 |+from .subscription import * # type: ignore # some very long comment explaining why this needs a type ignore - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type.py.snap index d8b56617063ed..598956bdd612c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type.py.snap @@ -15,6 +15,7 @@ order_by_type.py:1:1: I001 [*] Import block is un-sorted or un-formatted 10 | | import FOO 11 | | import BAR 12 | | import bar + | |__________^ I001 | = help: Organize imports @@ -37,5 +38,3 @@ order_by_type.py:1:1: I001 [*] Import block is un-sorted or un-formatted 11 |+import foo 12 |+import StringIO 13 |+from module import BASIC, CONSTANT, Apple, Class, function - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_false_order_by_type.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_false_order_by_type.py.snap index e529a09b24d32..dcbca8a0d1d9b 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_false_order_by_type.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_false_order_by_type.py.snap @@ -15,6 +15,7 @@ order_by_type.py:1:1: I001 [*] Import block is un-sorted or un-formatted 10 | | import FOO 11 | | import BAR 12 | | import bar + | |__________^ I001 | = help: Organize imports @@ -36,5 +37,3 @@ order_by_type.py:1:1: I001 [*] Import block is un-sorted or un-formatted 11 |+import foo 12 |+import StringIO 13 |+from module import Apple, BASIC, Class, CONSTANT, function - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes.py.snap index 63462bfd800b8..cb2a44f98877b 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes.py.snap @@ -7,6 +7,7 @@ order_by_type_with_custom_classes.py:1:1: I001 [*] Import block is un-sorted or 2 | | from subprocess import N_CLASS, PIPE, Popen, STDOUT 3 | | from module import CLASS, Class, CONSTANT, function, BASIC, Apple 4 | | from torch.nn import SELU, AClass, A_CONSTANT + | |_____________________________________________^ I001 | = help: Organize imports @@ -20,5 +21,3 @@ order_by_type_with_custom_classes.py:1:1: I001 [*] Import block is un-sorted or 3 |+from module import BASIC, CLASS, CONSTANT, Apple, Class, function 4 |+from sklearn.svm import CONST, SVC, Klass, func 5 |+from torch.nn import A_CONSTANT, SELU, AClass - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes_order_by_type_with_custom_classes.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes_order_by_type_with_custom_classes.py.snap index 08c6f19ddeb7f..94aeabb4ad88c 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes_order_by_type_with_custom_classes.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_classes_order_by_type_with_custom_classes.py.snap @@ -7,6 +7,7 @@ order_by_type_with_custom_classes.py:1:1: I001 [*] Import block is un-sorted or 2 | | from subprocess import N_CLASS, PIPE, Popen, STDOUT 3 | | from module import CLASS, Class, CONSTANT, function, BASIC, Apple 4 | | from torch.nn import SELU, AClass, A_CONSTANT + | |_____________________________________________^ I001 | = help: Organize imports @@ -20,5 +21,3 @@ order_by_type_with_custom_classes.py:1:1: I001 [*] Import block is un-sorted or 3 |+from module import BASIC, CONSTANT, Apple, CLASS, Class, function 4 |+from sklearn.svm import CONST, Klass, SVC, func 5 |+from torch.nn import A_CONSTANT, AClass, SELU - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants.py.snap index d935e7728606f..b17298eedc434 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants.py.snap @@ -5,6 +5,7 @@ order_by_type_with_custom_constants.py:1:1: I001 [*] Import block is un-sorted o | 1 | / from sklearn.svm import XYZ, func, variable, Const, Klass, constant 2 | | from subprocess import First, var, func, Class, konst, A_constant, Last, STDOUT + | |_______________________________________________________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ order_by_type_with_custom_constants.py:1:1: I001 [*] Import block is un-sorted o 1 |+from subprocess import STDOUT, A_constant, Class, First, Last, func, konst, var 2 |+ 3 |+from sklearn.svm import XYZ, Const, Klass, constant, func, variable - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants_order_by_type_with_custom_constants.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants_order_by_type_with_custom_constants.py.snap index ce509d7bdce6a..4d696e30aed50 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants_order_by_type_with_custom_constants.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_constants_order_by_type_with_custom_constants.py.snap @@ -5,6 +5,7 @@ order_by_type_with_custom_constants.py:1:1: I001 [*] Import block is un-sorted o | 1 | / from sklearn.svm import XYZ, func, variable, Const, Klass, constant 2 | | from subprocess import First, var, func, Class, konst, A_constant, Last, STDOUT + | |_______________________________________________________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ order_by_type_with_custom_constants.py:1:1: I001 [*] Import block is un-sorted o 1 |+from subprocess import A_constant, First, konst, Last, STDOUT, Class, func, var 2 |+ 3 |+from sklearn.svm import Const, constant, XYZ, Klass, func, variable - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables.py.snap index 5285c77bf82a5..82ed0e2cfea78 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables.py.snap @@ -5,6 +5,7 @@ order_by_type_with_custom_variables.py:1:1: I001 [*] Import block is un-sorted o | 1 | / from sklearn.svm import VAR, Class, MyVar, CONST, abc 2 | | from subprocess import utils, var_ABC, Variable, Klass, CONSTANT, exe + | |_____________________________________________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ order_by_type_with_custom_variables.py:1:1: I001 [*] Import block is un-sorted o 1 |+from subprocess import CONSTANT, Klass, Variable, exe, utils, var_ABC 2 |+ 3 |+from sklearn.svm import CONST, VAR, Class, MyVar, abc - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables_order_by_type_with_custom_variables.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables_order_by_type_with_custom_variables.py.snap index ed6c44822c61b..d60ac428d1a79 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables_order_by_type_with_custom_variables.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_by_type_with_custom_variables_order_by_type_with_custom_variables.py.snap @@ -5,6 +5,7 @@ order_by_type_with_custom_variables.py:1:1: I001 [*] Import block is un-sorted o | 1 | / from sklearn.svm import VAR, Class, MyVar, CONST, abc 2 | | from subprocess import utils, var_ABC, Variable, Klass, CONSTANT, exe + | |_____________________________________________________________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ order_by_type_with_custom_variables.py:1:1: I001 [*] Import block is un-sorted o 1 |+from subprocess import CONSTANT, Klass, exe, utils, var_ABC, Variable 2 |+ 3 |+from sklearn.svm import CONST, Class, abc, MyVar, VAR - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_relative_imports_by_level.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_relative_imports_by_level.py.snap index f1aad7edc0a5f..78d9a2a789587 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_relative_imports_by_level.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__order_relative_imports_by_level.py.snap @@ -7,6 +7,7 @@ order_relative_imports_by_level.py:1:1: I001 [*] Import block is un-sorted or un 2 | | from ..a import a 3 | | from ..b import a 4 | | from .b import a + | |________________^ I001 | = help: Organize imports @@ -16,5 +17,3 @@ order_relative_imports_by_level.py:1:1: I001 [*] Import block is un-sorted or un 3 2 | from ..b import a 3 |+from .a import a 4 4 | from .b import a - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_comment_order.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_comment_order.py.snap index 375b252ccf4b0..576c3cda04ba5 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_comment_order.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_comment_order.py.snap @@ -14,6 +14,7 @@ preserve_comment_order.py:1:1: I001 [*] Import block is un-sorted or un-formatte 9 | | # EIEIO 10 | | from errno import EIO 11 | | import abc + | |__________^ I001 | = help: Organize imports @@ -29,5 +30,3 @@ preserve_comment_order.py:1:1: I001 [*] Import block is un-sorted or un-formatte 9 11 | # EIEIO 10 12 | from errno import EIO 11 |-import abc - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_import_star.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_import_star.py.snap index e44b824e4dc8b..289ceba1ac2af 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_import_star.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_import_star.py.snap @@ -9,6 +9,7 @@ preserve_import_star.py:1:1: I001 [*] Import block is un-sorted or un-formatted 4 | | from some_module import some_class # Aside 5 | | # Above 6 | | from some_module import * # Aside + | |_________________________^ I001 | = help: Organize imports @@ -24,5 +25,3 @@ preserve_import_star.py:1:1: I001 [*] Import block is un-sorted or un-formatted 5 |+from some_module import some_class # Aside 6 |+from some_other_module import * 7 |+from some_other_module import some_class - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_indentation.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_indentation.py.snap index d9117c89e61d0..2ecdea73ec410 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_indentation.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_indentation.py.snap @@ -1,15 +1,14 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -preserve_indentation.py:2:1: I001 [*] Import block is un-sorted or un-formatted +preserve_indentation.py:2:5: I001 [*] Import block is un-sorted or un-formatted | 1 | if True: 2 | / import sys 3 | | import os -4 | | else: - | |_^ I001 + | |_____________^ I001 +4 | else: 5 | import sys -6 | import os | = help: Organize imports @@ -22,12 +21,13 @@ preserve_indentation.py:2:1: I001 [*] Import block is un-sorted or un-formatted 5 5 | import sys 6 6 | import os -preserve_indentation.py:5:1: I001 [*] Import block is un-sorted or un-formatted +preserve_indentation.py:5:5: I001 [*] Import block is un-sorted or un-formatted | 3 | import os 4 | else: 5 | / import sys 6 | | import os + | |_____________^ I001 | = help: Organize imports @@ -38,5 +38,3 @@ preserve_indentation.py:5:1: I001 [*] Import block is un-sorted or un-formatted 5 |+ import os 5 6 | import sys 6 |- import os - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs_2.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs_2.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs_2.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__preserve_tabs_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__propagate_inline_comments_propagate_inline_comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__propagate_inline_comments_propagate_inline_comments.py.snap index 6346a04dd236c..40eb90e51bed7 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__propagate_inline_comments_propagate_inline_comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__propagate_inline_comments_propagate_inline_comments.py.snap @@ -7,6 +7,7 @@ propagate_inline_comments.py:1:1: I001 [*] Import block is un-sorted or un-forma 2 | | a_long_variable_name_that_causes_problems, 3 | | items, 4 | | ) + | |_^ I001 | = help: Organize imports @@ -16,5 +17,3 @@ propagate_inline_comments.py:1:1: I001 [*] Import block is un-sorted or un-forma 3 |- items, 4 3 | ) 4 |+from mypackage.subpackage import items # long comment that seems to be a problem - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__relative_imports_order.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__relative_imports_order.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__relative_imports_order.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__relative_imports_order.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__reorder_within_section.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__reorder_within_section.py.snap index 23d95af3545c5..eb3789a4fc229 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__reorder_within_section.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__reorder_within_section.py.snap @@ -5,6 +5,7 @@ reorder_within_section.py:1:1: I001 [*] Import block is un-sorted or un-formatte | 1 | / import sys 2 | | import os + | |_________^ I001 | = help: Organize imports @@ -12,5 +13,3 @@ reorder_within_section.py:1:1: I001 [*] Import block is un-sorted or un-formatte 1 |+import os 1 2 | import sys 2 |-import os - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comment.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comment.py.snap index 313ec7cbb467d..6cb60ee4536cf 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comment.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comment.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- comment.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comments_and_newlines.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comments_and_newlines.py.snap index c5d92854a2864..f7ba64f556eb9 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comments_and_newlines.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_comments_and_newlines.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- comments_and_newlines.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.py.snap index 4a513546859a8..d42aa75e7c1d6 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.pyi.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_only.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_only.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_only.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_only.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_continuation.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_continuation.py.snap index c48ef63610db9..29dd093d4a364 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_continuation.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_continuation.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring_with_continuation.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_semicolon.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_semicolon.py.snap index dfd35beb25140..2d76188cec246 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_semicolon.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_docstring_with_semicolon.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring_with_semicolon.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_empty.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_empty.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_empty.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_empty.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_existing_import.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_existing_import.py.snap index 12ff6dbd5cc02..b8f83954fba68 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_existing_import.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_existing_import.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- existing_import.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_multiline_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_multiline_docstring.py.snap index 18e6b94876b25..794cf1641d67a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_multiline_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_multiline_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- multiline_docstring.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_off.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_off.py.snap index 5107b912908db..4cf37432a7d3e 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_off.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_off.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- off.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_unused.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_unused.py.snap index 0d79276e0e4ff..4701571f2eaab 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_unused.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_unused.py.snap @@ -6,7 +6,7 @@ unused.py:5:8: F401 [*] `sys` imported but unused 4 | # Unused, _not_ marked as required. 5 | import sys | ^^^ F401 -6 | +6 | 7 | # Unused, _not_ marked as required (due to the alias). | = help: Remove unused import: `sys` @@ -25,7 +25,7 @@ unused.py:8:19: F401 [*] `pathlib` imported but unused 7 | # Unused, _not_ marked as required (due to the alias). 8 | import pathlib as non_alias | ^^^^^^^^^ F401 - 9 | + 9 | 10 | # Unused, marked as required. | = help: Remove unused import: `pathlib` diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comment.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comment.py.snap index ea3f16c36b1e7..e2fe2c526b89a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comment.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comment.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- comment.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comments_and_newlines.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comments_and_newlines.py.snap index 509094af63e6a..168812400c5ed 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comments_and_newlines.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_comments_and_newlines.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- comments_and_newlines.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.py.snap index 21c36c4e30461..00eff57da590a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.pyi.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_only.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_only.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_only.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_only.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_continuation.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_continuation.py.snap index 0a40adb35a58c..e68324b25f0ed 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_continuation.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_continuation.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring_with_continuation.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_semicolon.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_semicolon.py.snap index 3c61e64a8ba79..f6ff025e7c415 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_semicolon.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_docstring_with_semicolon.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring_with_semicolon.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_empty.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_empty.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_empty.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_empty.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_existing_import.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_existing_import.py.snap index 96e891413b4af..122d84425615a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_existing_import.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_existing_import.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- existing_import.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_multiline_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_multiline_docstring.py.snap index 6426ab3898496..8087f019db9e5 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_multiline_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_multiline_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- multiline_docstring.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_off.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_off.py.snap index 4387774dddd69..1a194ac0cf4df 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_off.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_alias_off.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- off.py:1:1: I002 [*] Missing required import: `from __future__ import annotations as _annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_useless_alias_this_this.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_useless_alias_this_this.py.snap new file mode 100644 index 0000000000000..c59adb4f32481 --- /dev/null +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_import_with_useless_alias_this_this.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text +--- +this_this.py:1:8: PLC0414 Required import does not rename original package. + | +1 | import this as this + | ^^^^^^^^^^^^ PLC0414 + | + = help: Change required import or disable rule. diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_importfrom_with_useless_alias_this_this_from.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_importfrom_with_useless_alias_this_this_from.py.snap new file mode 100644 index 0000000000000..50dbb294d55f6 --- /dev/null +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_importfrom_with_useless_alias_this_this_from.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text +--- +this_this_from.py:1:20: PLC0414 Required import does not rename original package. + | +1 | from module import this as this + | ^^^^^^^^^^^^ PLC0414 + | + = help: Change required import or disable rule. diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.py.snap index d65d89b7038d5..1ce65ad21ff5b 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring.py:1:1: I002 [*] Missing required import: `from __future__ import annotations` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.pyi.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring_only.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring_only.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring_only.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_docstring_only.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_empty.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_empty.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_empty.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__required_imports_empty.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__ruff_skip_file.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__ruff_skip_file.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__ruff_skip_file.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__ruff_skip_file.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__section_order_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__section_order_sections.py.snap index 8643ef2443362..81ba140cce065 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__section_order_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__section_order_sections.py.snap @@ -10,6 +10,7 @@ sections.py:1:1: I001 [*] Import block is un-sorted or un-formatted 5 | | import django.settings 6 | | from library import foo 7 | | from . import local + | |___________________^ I001 | = help: Organize imports @@ -26,5 +27,3 @@ sections.py:1:1: I001 [*] Import block is un-sorted or un-formatted 6 10 | from library import foo 11 |+ 7 12 | from . import local - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_main_first_party.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_main_first_party.py.snap index 404ad962cb670..2dee10681b7f4 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_main_first_party.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_main_first_party.py.snap @@ -2,20 +2,18 @@ source: crates/ruff_linter/src/rules/isort/mod.rs --- main_first_party.py:1:1: I001 [*] Import block is un-sorted or un-formatted - | - 1 | / import os - 2 | | - 3 | | import __main__ - 4 | | import third_party - 5 | | - 6 | | import first_party - 7 | | - 8 | | os.a - | |_^ I001 - 9 | third_party.a -10 | __main__.a - | - = help: Organize imports + | +1 | / import os +2 | | +3 | | import __main__ +4 | | import third_party +5 | | +6 | | import first_party + | |__________________^ I001 +7 | +8 | os.a + | + = help: Organize imports ℹ Safe fix 1 1 | import os @@ -27,5 +25,3 @@ main_first_party.py:1:1: I001 [*] Import block is un-sorted or un-formatted 6 6 | import first_party 7 7 | 8 8 | os.a - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_sections.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_sections.py.snap index 15572d6be1f65..3273e24cdb27f 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_sections.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sections_sections.py.snap @@ -10,6 +10,7 @@ sections.py:1:1: I001 [*] Import block is un-sorted or un-formatted 5 | | import django.settings 6 | | from library import foo 7 | | from . import local + | |___________________^ I001 | = help: Organize imports @@ -26,5 +27,3 @@ sections.py:1:1: I001 [*] Import block is un-sorted or un-formatted 7 9 | from . import local 10 |+ 11 |+import django.settings - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_first_party_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_first_party_imports.py.snap index e1f4b5298d973..65182f7e7ef89 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_first_party_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_first_party_imports.py.snap @@ -8,6 +8,7 @@ separate_first_party_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 3 | | import numpy as np 4 | | import os 5 | | from leading_prefix import Class + | |________________________________^ I001 | = help: Organize imports @@ -21,5 +22,3 @@ separate_first_party_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 3 |-import numpy as np 4 |-import os 5 7 | from leading_prefix import Class - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_future_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_future_imports.py.snap index 238a0b20f69e6..6efad32da6fdd 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_future_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_future_imports.py.snap @@ -6,6 +6,7 @@ separate_future_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatt 1 | / import sys 2 | | import os 3 | | from __future__ import annotations + | |__________________________________^ I001 | = help: Organize imports @@ -16,5 +17,3 @@ separate_future_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatt 2 |+ 3 |+import os 4 |+import sys - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_local_folder_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_local_folder_imports.py.snap index 88d2f3a1bcfa0..7ce3c297a0592 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_local_folder_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_local_folder_imports.py.snap @@ -10,6 +10,7 @@ separate_local_folder_imports.py:1:1: I001 [*] Import block is un-sorted or un-f 5 | | from . import leading_prefix 6 | | from .. import trailing_prefix 7 | | from ruff import check + | |______________________^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_third_party_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_third_party_imports.py.snap index 955c5421ff4ca..99559f624484a 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_third_party_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__separate_third_party_imports.py.snap @@ -7,6 +7,7 @@ separate_third_party_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 2 | | import sys 3 | | import numpy as np 4 | | import os + | |_________^ I001 | = help: Organize imports @@ -18,5 +19,3 @@ separate_third_party_imports.py:1:1: I001 [*] Import block is un-sorted or un-fo 3 4 | import numpy as np 4 |-import os 5 |+import pandas as pd - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__skip.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__skip.py.snap index acd83b5cbe271..0bc57eae37f62 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__skip.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__skip.py.snap @@ -1,16 +1,13 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -skip.py:20:1: I001 [*] Import block is un-sorted or un-formatted +skip.py:20:5: I001 [*] Import block is un-sorted or un-formatted | 18 | import sys 19 | import os # isort: skip 20 | / import collections 21 | | import abc -22 | | - | |_^ I001 -23 | -24 | def f(): + | |______________^ I001 | = help: Organize imports @@ -25,16 +22,13 @@ skip.py:20:1: I001 [*] Import block is un-sorted or un-formatted 23 23 | 24 24 | def f(): -skip.py:27:1: I001 [*] Import block is un-sorted or un-formatted +skip.py:27:5: I001 [*] Import block is un-sorted or un-formatted | 25 | import sys 26 | import os # isort:skip 27 | / import collections 28 | | import abc -29 | | - | |_^ I001 -30 | -31 | def f(): + | |______________^ I001 | = help: Organize imports @@ -49,11 +43,12 @@ skip.py:27:1: I001 [*] Import block is un-sorted or un-formatted 30 30 | 31 31 | def f(): -skip.py:34:1: I001 [*] Import block is un-sorted or un-formatted +skip.py:34:5: I001 [*] Import block is un-sorted or un-formatted | -32 | import sys; import os # isort:skip -33 | import sys; import os # isort:skip # isort:skip -34 | / import sys; import os +32 | import sys; import os # isort:skip +33 | import sys; import os # isort:skip # isort:skip +34 | import sys; import os + | ^^^^^^^^^^^^^^^^^^^^^ I001 | = help: Organize imports @@ -64,5 +59,3 @@ skip.py:34:1: I001 [*] Import block is un-sorted or un-formatted 34 |- import sys; import os 34 |+ import os 35 |+ import sys - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sort_similar_imports.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sort_similar_imports.py.snap index 588a1c9a97cbb..016fa99f05165 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sort_similar_imports.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__sort_similar_imports.py.snap @@ -18,17 +18,18 @@ sort_similar_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 13 | | from a import b as y 14 | | from b import C 15 | | from b import c as d -16 | | +16 | | 17 | | import A 18 | | import a 19 | | import b 20 | | import B -21 | | +21 | | 22 | | import x as y 23 | | import x as A 24 | | import x as Y 25 | | import x 26 | | import x as a + | |_____________^ I001 | = help: Organize imports @@ -73,5 +74,3 @@ sort_similar_imports.py:1:1: I001 [*] Import block is un-sorted or un-formatted 24 |-import x as Y 25 |-import x 26 |-import x as a - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split.py.snap index a729c4efd6eb4..5b1a0f8e17684 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs --- -split.py:15:1: I001 [*] Import block is un-sorted or un-formatted +split.py:15:5: I001 [*] Import block is un-sorted or un-formatted | 14 | if True: 15 | / import C 16 | | import A -17 | | - | |_^ I001 + | |____________^ I001 +17 | 18 | # isort: split | = help: Organize imports @@ -23,16 +23,13 @@ split.py:15:1: I001 [*] Import block is un-sorted or un-formatted 18 18 | # isort: split 19 19 | -split.py:20:1: I001 [*] Import block is un-sorted or un-formatted +split.py:20:5: I001 [*] Import block is un-sorted or un-formatted | 18 | # isort: split -19 | +19 | 20 | / import D 21 | | import B -22 | | - | |_^ I001 -23 | -24 | import e + | |____________^ I001 | = help: Organize imports @@ -50,9 +47,10 @@ split.py:20:1: I001 [*] Import block is un-sorted or un-formatted split.py:30:1: I001 [*] Import block is un-sorted or un-formatted | 28 | # isort: split -29 | +29 | 30 | / import d 31 | | import c + | |________^ I001 | = help: Organize imports @@ -63,5 +61,3 @@ split.py:30:1: I001 [*] Import block is un-sorted or un-formatted 30 |+import c 30 31 | import d 31 |-import c - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split_on_trailing_comma_magic_trailing_comma.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split_on_trailing_comma_magic_trailing_comma.py.snap index 87b842c9f89a7..bb9cd3eb1eed6 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split_on_trailing_comma_magic_trailing_comma.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__split_on_trailing_comma_magic_trailing_comma.py.snap @@ -10,7 +10,7 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 5 | | stdout, 6 | | exit, 7 | | ) - 8 | | + 8 | | 9 | | # No magic comma, this will be rolled into one line. 10 | | from os import ( 11 | | path, @@ -18,29 +18,30 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 13 | | execl, 14 | | execv 15 | | ) -16 | | +16 | | 17 | | from glob import ( 18 | | glob, 19 | | iglob, 20 | | escape, # Ends with a comment, should still treat as magic trailing comma. 21 | | ) -22 | | +22 | | 23 | | # These will be combined, but without a trailing comma. 24 | | from foo import bar 25 | | from foo import baz -26 | | +26 | | 27 | | # These will be combined, _with_ a trailing comma. 28 | | from module1 import member1 29 | | from module1 import ( 30 | | member2, 31 | | member3, 32 | | ) -33 | | +33 | | 34 | | # These will be combined, _with_ a trailing comma. 35 | | from module2 import member1, member2 36 | | from module2 import ( 37 | | member3, 38 | | ) + | |_^ I001 | = help: Organize imports @@ -91,5 +92,3 @@ magic_trailing_comma.py:2:1: I001 [*] Import block is un-sorted or un-formatted 37 |- member3, 38 |-) 19 |+from module2 import member1, member2, member3 - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__star_before_others.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__star_before_others.py.snap index 98fadba6e6dbe..0a1b4331c5e51 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__star_before_others.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__star_before_others.py.snap @@ -6,6 +6,7 @@ star_before_others.py:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from .logging import config_logging 2 | | from .settings import ENV 3 | | from .settings import * + | |_______________________^ I001 | = help: Organize imports @@ -14,5 +15,3 @@ star_before_others.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 |+from .settings import * 2 3 | from .settings import ENV 3 |-from .settings import * - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.py.snap index 6ce4357615da8..a10a6cbfdc1f2 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring.py:1:1: I002 [*] Missing required import: `import os` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.pyi.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.pyi.snap index 9c789cb79e5e0..9b7f926158821 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.pyi.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- docstring.pyi:1:1: I002 [*] Missing required import: `import os` ℹ Safe fix diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring_only.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring_only.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring_only.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_docstring_only.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_empty.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_empty.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_empty.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__straight_required_import_empty.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_comment.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_comment.py.snap index 8a1f7e61d3670..07f62b85f8c1e 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_comment.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_comment.py.snap @@ -4,18 +4,16 @@ source: crates/ruff_linter/src/rules/isort/mod.rs trailing_comment.py:8:1: I001 [*] Import block is un-sorted or un-formatted | 6 | pass - 7 | + 7 | 8 | / from mylib import ( 9 | | MyClient, 10 | | MyMgmtClient, 11 | | ); from foo import ( 12 | | bar 13 | | )# some comment -14 | | -15 | | pass | |_^ I001 -16 | -17 | from foo import ( +14 | +15 | pass | = help: Organize imports @@ -38,7 +36,7 @@ trailing_comment.py:8:1: I001 [*] Import block is un-sorted or un-formatted trailing_comment.py:17:1: I001 [*] Import block is un-sorted or un-formatted | 15 | pass -16 | +16 | 17 | / from foo import ( 18 | | bar 19 | | ) @@ -47,11 +45,9 @@ trailing_comment.py:17:1: I001 [*] Import block is un-sorted or un-formatted 22 | | MyMgmtClient, 23 | | # some comment 24 | | ) -25 | | -26 | | pass | |_^ I001 -27 | -28 | from mylib import ( +25 | +26 | pass | = help: Organize imports @@ -70,16 +66,14 @@ trailing_comment.py:17:1: I001 [*] Import block is un-sorted or un-formatted trailing_comment.py:35:1: I001 [*] Import block is un-sorted or un-formatted | 33 | pass -34 | +34 | 35 | / from mylib import ( 36 | | MyClient 37 | | # some comment 38 | | ) -39 | | -40 | | pass | |_^ I001 -41 | -42 | from mylib import ( +39 | +40 | pass | = help: Organize imports @@ -99,16 +93,14 @@ trailing_comment.py:35:1: I001 [*] Import block is un-sorted or un-formatted trailing_comment.py:42:1: I001 [*] Import block is un-sorted or un-formatted | 40 | pass -41 | +41 | 42 | / from mylib import ( 43 | | # some comment 44 | | MyClient 45 | | ) -46 | | -47 | | pass | |_^ I001 -48 | -49 | # a +46 | +47 | pass | = help: Organize imports @@ -133,6 +125,7 @@ trailing_comment.py:50:1: I001 [*] Import block is un-sorted or un-formatted 52 | | MyClient # d 53 | | # e 54 | | ) # f + | |_^ I001 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_suffix.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_suffix.py.snap index 3f86e235fed4e..df26c70eb1d62 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_suffix.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__trailing_suffix.py.snap @@ -6,7 +6,7 @@ trailing_suffix.py:1:1: I001 Import block is un-sorted or un-formatted 1 | / import sys 2 | | import os; x = 1 | |_________^ I001 -3 | +3 | 4 | if True: | = help: Organize imports @@ -14,11 +14,8 @@ trailing_suffix.py:1:1: I001 Import block is un-sorted or un-formatted trailing_suffix.py:5:5: I001 Import block is un-sorted or un-formatted | 4 | if True: -5 | import sys - | _____^ +5 | / import sys 6 | | import os; x = 1 | |_____________^ I001 | = help: Organize imports - - diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__two_space.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__two_space.py.snap index 3d7aa735039ba..2e68e28eca3af 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__two_space.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__two_space.py.snap @@ -11,9 +11,9 @@ two_space.py:2:1: I001 [*] Import block is un-sorted or un-formatted 6 | | nan, 7 | | pi, 8 | | ) - 9 | | -10 | | del sin, cos, tan, pi, nan | |_^ I001 + 9 | +10 | del sin, cos, tan, pi, nan | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__type_comments.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__type_comments.py.snap index ed369f0fd61f0..803f879dca459 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__type_comments.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__type_comments.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/isort/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__unicode.py.snap b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__unicode.py.snap index 0a6f035c6241d..e6b6c53fb98d0 100644 --- a/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__unicode.py.snap +++ b/crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__unicode.py.snap @@ -7,9 +7,9 @@ unicode.py:1:1: I001 [*] Import block is un-sorted or un-formatted 2 | | from numpy import pi as π 3 | | import numpy as ℂℇℊℋℌℍℎℐℑℒℓℕℤΩℨKÅℬℭℯℰℱℹℴ 4 | | import numpy as CƐgHHHhIILlNZΩZKÅBCeEFio -5 | | -6 | | h = 2 * π * ℏ - | |_^ I001 + | |________________________________________^ I001 +5 | +6 | h = 2 * π * ℏ | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/isort/sorting.rs b/crates/ruff_linter/src/rules/isort/sorting.rs index 829d743e4d01d..0db5d80423668 100644 --- a/crates/ruff_linter/src/rules/isort/sorting.rs +++ b/crates/ruff_linter/src/rules/isort/sorting.rs @@ -59,7 +59,7 @@ impl<'a> From<&'a str> for NatOrdStr<'a> { } } -impl<'a> From<String> for NatOrdStr<'a> { +impl From<String> for NatOrdStr<'_> { fn from(s: String) -> Self { NatOrdStr(Cow::Owned(s)) } diff --git a/crates/ruff_linter/src/rules/mccabe/rules/function_is_too_complex.rs b/crates/ruff_linter/src/rules/mccabe/rules/function_is_too_complex.rs index 463ef0a4f550f..ec5f371db74c8 100644 --- a/crates/ruff_linter/src/rules/mccabe/rules/function_is_too_complex.rs +++ b/crates/ruff_linter/src/rules/mccabe/rules/function_is_too_complex.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; /// ## What it does @@ -45,8 +45,8 @@ use ruff_python_ast::identifier::Identifier; /// /// ## Options /// - `lint.mccabe.max-complexity` -#[violation] -pub struct ComplexStructure { +#[derive(ViolationMetadata)] +pub(crate) struct ComplexStructure { name: String, complexity: usize, max_complexity: usize, diff --git a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_0.snap b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_0.snap index 92a113461e594..5bce1a36f6b72 100644 --- a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_0.snap +++ b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_0.snap @@ -155,7 +155,7 @@ C901.py:118:17: C901 `a` is too complex (1 > 0) C901.py:121:17: C901 `b` is too complex (2 > 0) | 119 | pass -120 | +120 | 121 | def b(self, data): | ^ C901 122 | if not args: @@ -173,7 +173,7 @@ C901.py:126:17: C901 `c` is too complex (1 > 0) C901.py:129:17: C901 `error` is too complex (1 > 0) | 127 | pass -128 | +128 | 129 | def error(self, message): | ^^^^^ C901 130 | pass @@ -182,7 +182,7 @@ C901.py:129:17: C901 `error` is too complex (1 > 0) C901.py:132:17: C901 `info` is too complex (1 > 0) | 130 | pass -131 | +131 | 132 | def info(self, message): | ^^^^ C901 133 | pass @@ -191,10 +191,8 @@ C901.py:132:17: C901 `info` is too complex (1 > 0) C901.py:135:17: C901 `exception` is too complex (1 > 0) | 133 | pass -134 | +134 | 135 | def exception(self): | ^^^^^^^^^ C901 136 | pass | - - diff --git a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_10.snap b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_10.snap index 59f3ea53f2dba..f41da3bb0af6d 100644 --- a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_10.snap +++ b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_10.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/mccabe/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_3.snap b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_3.snap index cd1c01d173bf5..397ba316a1fd4 100644 --- a/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_3.snap +++ b/crates/ruff_linter/src/rules/mccabe/snapshots/ruff_linter__rules__mccabe__tests__max_complexity_3.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/mccabe/mod.rs +snapshot_kind: text --- C901.py:73:5: C901 `try_else` is too complex (4 > 3) | @@ -19,5 +20,3 @@ C901.py:113:9: C901 `handle` is too complex (9 > 3) 114 | if args: 115 | return | - - diff --git a/crates/ruff_linter/src/rules/mod.rs b/crates/ruff_linter/src/rules/mod.rs index c9983ab416cc6..735864aecbb04 100644 --- a/crates/ruff_linter/src/rules/mod.rs +++ b/crates/ruff_linter/src/rules/mod.rs @@ -1,4 +1,3 @@ -#![allow(clippy::useless_format)] pub mod airflow; pub mod eradicate; pub mod fastapi; diff --git a/crates/ruff_linter/src/rules/numpy/helpers.rs b/crates/ruff_linter/src/rules/numpy/helpers.rs new file mode 100644 index 0000000000000..a2e5eb6a1502f --- /dev/null +++ b/crates/ruff_linter/src/rules/numpy/helpers.rs @@ -0,0 +1,104 @@ +use ruff_python_ast::Expr; +use ruff_python_ast::name::QualifiedName; +use ruff_python_ast::statement_visitor::StatementVisitor; +use ruff_python_ast::visitor::Visitor; +use ruff_python_ast::visitor::{walk_expr, walk_stmt}; +use ruff_python_ast::{Alias, Stmt, StmtImportFrom, statement_visitor}; +use ruff_python_semantic::SemanticModel; + +/// AST visitor that searches an AST tree for [`ast::StmtImportFrom`] nodes +/// that match a certain [`QualifiedName`]. +pub(crate) struct ImportSearcher<'a> { + module: &'a str, + name: &'a str, + pub found_import: bool, +} + +impl<'a> ImportSearcher<'a> { + pub(crate) fn new(module: &'a str, name: &'a str) -> Self { + Self { + module, + name, + found_import: false, + } + } +} +impl StatementVisitor<'_> for ImportSearcher<'_> { + fn visit_stmt(&mut self, stmt: &Stmt) { + if self.found_import { + return; + } + if let Stmt::ImportFrom(StmtImportFrom { module, names, .. }) = stmt { + if module.as_ref().is_some_and(|module| module == self.module) + && names.iter().any(|Alias { name, .. }| name == self.name) + { + self.found_import = true; + return; + } + } + statement_visitor::walk_stmt(self, stmt); + } + + fn visit_body(&mut self, body: &[ruff_python_ast::Stmt]) { + for stmt in body { + self.visit_stmt(stmt); + if self.found_import { + return; + } + } + } +} + +/// AST visitor that searches an AST tree for [`ast::ExprAttribute`] nodes +/// that match a certain [`QualifiedName`]. +pub(crate) struct AttributeSearcher<'a> { + attribute_to_find: QualifiedName<'a>, + semantic: &'a SemanticModel<'a>, + pub found_attribute: bool, +} + +impl<'a> AttributeSearcher<'a> { + pub(crate) fn new( + attribute_to_find: QualifiedName<'a>, + semantic: &'a SemanticModel<'a>, + ) -> Self { + Self { + attribute_to_find, + semantic, + found_attribute: false, + } + } +} + +impl Visitor<'_> for AttributeSearcher<'_> { + fn visit_expr(&mut self, expr: &'_ Expr) { + if self.found_attribute { + return; + } + if expr.is_attribute_expr() + && self + .semantic + .resolve_qualified_name(expr) + .is_some_and(|qualified_name| qualified_name == self.attribute_to_find) + { + self.found_attribute = true; + return; + } + walk_expr(self, expr); + } + + fn visit_stmt(&mut self, stmt: &ruff_python_ast::Stmt) { + if !self.found_attribute { + walk_stmt(self, stmt); + } + } + + fn visit_body(&mut self, body: &[ruff_python_ast::Stmt]) { + for stmt in body { + self.visit_stmt(stmt); + if self.found_attribute { + return; + } + } + } +} diff --git a/crates/ruff_linter/src/rules/numpy/mod.rs b/crates/ruff_linter/src/rules/numpy/mod.rs index fdf65ba09ef48..7a313eac2ecdf 100644 --- a/crates/ruff_linter/src/rules/numpy/mod.rs +++ b/crates/ruff_linter/src/rules/numpy/mod.rs @@ -1,4 +1,5 @@ //! NumPy-specific rules. +pub(crate) mod helpers; pub(crate) mod rules; #[cfg(test)] diff --git a/crates/ruff_linter/src/rules/numpy/rules/deprecated_function.rs b/crates/ruff_linter/src/rules/numpy/rules/deprecated_function.rs index 8a3d943a797ff..70a37fa4cc292 100644 --- a/crates/ruff_linter/src/rules/numpy/rules/deprecated_function.rs +++ b/crates/ruff_linter/src/rules/numpy/rules/deprecated_function.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -17,7 +17,7 @@ use crate::importer::ImportRequest; /// /// Prefer newer APIs over deprecated ones. /// -/// ## Examples +/// ## Example /// ```python /// import numpy as np /// @@ -30,8 +30,8 @@ use crate::importer::ImportRequest; /// /// np.all([True, False]) /// ``` -#[violation] -pub struct NumpyDeprecatedFunction { +#[derive(ViolationMetadata)] +pub(crate) struct NumpyDeprecatedFunction { existing: String, replacement: String, } @@ -55,7 +55,7 @@ impl Violation for NumpyDeprecatedFunction { } /// NPY003 -pub(crate) fn deprecated_function(checker: &mut Checker, expr: &Expr) { +pub(crate) fn deprecated_function(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::NUMPY) { return; } @@ -89,6 +89,6 @@ pub(crate) fn deprecated_function(checker: &mut Checker, expr: &Expr) { let replacement_edit = Edit::range_replacement(binding, expr.range()); Ok(Fix::safe_edits(import_edit, [replacement_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/numpy/rules/deprecated_type_alias.rs b/crates/ruff_linter/src/rules/numpy/rules/deprecated_type_alias.rs index 3d5dbef1f6e47..f1b527fa5c8f9 100644 --- a/crates/ruff_linter/src/rules/numpy/rules/deprecated_type_alias.rs +++ b/crates/ruff_linter/src/rules/numpy/rules/deprecated_type_alias.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -19,7 +19,7 @@ use crate::checkers::ast::Checker; /// Note, however, that `np.bool` and `np.long` were reintroduced in 2.0 with /// different semantics, and are thus omitted from this rule. /// -/// ## Examples +/// ## Example /// ```python /// import numpy as np /// @@ -30,8 +30,8 @@ use crate::checkers::ast::Checker; /// ```python /// int /// ``` -#[violation] -pub struct NumpyDeprecatedTypeAlias { +#[derive(ViolationMetadata)] +pub(crate) struct NumpyDeprecatedTypeAlias { type_name: String, } @@ -51,7 +51,7 @@ impl Violation for NumpyDeprecatedTypeAlias { } /// NPY001 -pub(crate) fn deprecated_type_alias(checker: &mut Checker, expr: &Expr) { +pub(crate) fn deprecated_type_alias(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::NUMPY) { return; } @@ -93,6 +93,6 @@ pub(crate) fn deprecated_type_alias(checker: &mut Checker, expr: &Expr) { let binding_edit = Edit::range_replacement(binding, expr.range()); Ok(Fix::safe_edits(binding_edit, import_edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/numpy/rules/legacy_random.rs b/crates/ruff_linter/src/rules/numpy/rules/legacy_random.rs index 13050db4abfc7..f32f617c72e33 100644 --- a/crates/ruff_linter/src/rules/numpy/rules/legacy_random.rs +++ b/crates/ruff_linter/src/rules/numpy/rules/legacy_random.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -28,7 +28,7 @@ use crate::checkers::ast::Checker; /// See the documentation on [Random Sampling] and [NEP 19] for further /// details. /// -/// ## Examples +/// ## Example /// ```python /// import numpy as np /// @@ -45,8 +45,8 @@ use crate::checkers::ast::Checker; /// [Legacy Random Generation]: https://numpy.org/doc/stable/reference/random/legacy.html#legacy /// [Random Sampling]: https://numpy.org/doc/stable/reference/random/index.html#random-quick-start /// [NEP 19]: https://numpy.org/neps/nep-0019-rng-policy.html -#[violation] -pub struct NumpyLegacyRandom { +#[derive(ViolationMetadata)] +pub(crate) struct NumpyLegacyRandom { method_name: String, } @@ -59,7 +59,7 @@ impl Violation for NumpyLegacyRandom { } /// NPY002 -pub(crate) fn legacy_random(checker: &mut Checker, expr: &Expr) { +pub(crate) fn legacy_random(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::NUMPY) { return; } @@ -137,7 +137,7 @@ pub(crate) fn legacy_random(checker: &mut Checker, expr: &Expr) { } }) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NumpyLegacyRandom { method_name: method_name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/numpy/rules/numpy_2_0_deprecation.rs b/crates/ruff_linter/src/rules/numpy/rules/numpy_2_0_deprecation.rs index ea219d08042f8..6b74f97d720ff 100644 --- a/crates/ruff_linter/src/rules/numpy/rules/numpy_2_0_deprecation.rs +++ b/crates/ruff_linter/src/rules/numpy/rules/numpy_2_0_deprecation.rs @@ -1,6 +1,7 @@ +use crate::rules::numpy::helpers::{AttributeSearcher, ImportSearcher}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::name::{QualifiedName, QualifiedNameBuilder}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::name::QualifiedNameBuilder; use ruff_python_ast::statement_visitor::StatementVisitor; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, Expr}; @@ -31,7 +32,7 @@ use crate::importer::ImportRequest; /// This rule flags all uses of removed members, along with automatic fixes for /// any backwards-compatible replacements. /// -/// ## Examples +/// ## Example /// ```python /// import numpy as np /// @@ -48,8 +49,8 @@ use crate::importer::ImportRequest; /// arr2 = [np.float64(1.5), np.float64(5.1)] /// np.round(arr2) /// ``` -#[violation] -pub struct Numpy2Deprecation { +#[derive(ViolationMetadata)] +pub(crate) struct Numpy2Deprecation { existing: String, migration_guide: Option<String>, code_action: Option<String>, @@ -156,7 +157,7 @@ enum Compatibility { } /// NPY201 -pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { +pub(crate) fn numpy_2_0_deprecation(checker: &Checker, expr: &Expr) { let semantic = checker.semantic(); if !semantic.seen_module(Modules::NUMPY) { @@ -268,13 +269,17 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { ["numpy", "deprecate"] => Replacement { existing: "deprecate", details: Details::Manual { - guideline: Some("Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`."), + guideline: Some( + "Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`.", + ), }, }, ["numpy", "deprecate_with_doc"] => Replacement { existing: "deprecate_with_doc", details: Details::Manual { - guideline: Some("Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`."), + guideline: Some( + "Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`.", + ), }, }, ["numpy", "disp"] => Replacement { @@ -292,14 +297,14 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { ["numpy", "find_common_type"] => Replacement { existing: "find_common_type", details: Details::Manual { - guideline: Some("Use `numpy.promote_types` or `numpy.result_type` instead. To achieve semantics for the `scalar_types` argument, use `numpy.result_type` and pass the Python values `0`, `0.0`, or `0j`."), + guideline: Some( + "Use `numpy.promote_types` or `numpy.result_type` instead. To achieve semantics for the `scalar_types` argument, use `numpy.result_type` and pass the Python values `0`, `0.0`, or `0j`.", + ), }, }, ["numpy", "get_array_wrap"] => Replacement { existing: "get_array_wrap", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", "float_"] => Replacement { existing: "float_", @@ -357,9 +362,7 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { }, ["numpy", "issctype"] => Replacement { existing: "issctype", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", "issubclass_"] => Replacement { existing: "issubclass_", @@ -385,9 +388,7 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { }, ["numpy", "maximum_sctype"] => Replacement { existing: "maximum_sctype", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", existing @ ("NaN" | "NAN")] => Replacement { existing, @@ -439,9 +440,7 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { }, ["numpy", "obj2sctype"] => Replacement { existing: "obj2sctype", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", "PINF"] => Replacement { existing: "PINF", @@ -493,15 +492,11 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { }, ["numpy", "sctype2char"] => Replacement { existing: "sctype2char", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", "sctypes"] => Replacement { existing: "sctypes", - details: Details::Manual { - guideline: None, - }, + details: Details::Manual { guideline: None }, }, ["numpy", "seterrobj"] => Replacement { existing: "seterrobj", @@ -705,8 +700,8 @@ pub(crate) fn numpy_2_0_deprecation(checker: &mut Checker, expr: &Expr) { Edit::range_replacement(python_expr.to_string(), expr.range()), )), Details::Manual { guideline: _ } => {} - }; - checker.diagnostics.push(diagnostic); + } + checker.report_diagnostic(diagnostic); } /// Ignore attempts to access a `numpy` member via its deprecated name @@ -822,57 +817,6 @@ fn try_block_contains_undeprecated_attribute( attribute_searcher.found_attribute } -/// AST visitor that searches an AST tree for [`ast::ExprAttribute`] nodes -/// that match a certain [`QualifiedName`]. -struct AttributeSearcher<'a> { - attribute_to_find: QualifiedName<'a>, - semantic: &'a SemanticModel<'a>, - found_attribute: bool, -} - -impl<'a> AttributeSearcher<'a> { - fn new(attribute_to_find: QualifiedName<'a>, semantic: &'a SemanticModel<'a>) -> Self { - Self { - attribute_to_find, - semantic, - found_attribute: false, - } - } -} - -impl Visitor<'_> for AttributeSearcher<'_> { - fn visit_expr(&mut self, expr: &'_ Expr) { - if self.found_attribute { - return; - } - if expr.is_attribute_expr() - && self - .semantic - .resolve_qualified_name(expr) - .is_some_and(|qualified_name| qualified_name == self.attribute_to_find) - { - self.found_attribute = true; - return; - } - ast::visitor::walk_expr(self, expr); - } - - fn visit_stmt(&mut self, stmt: &ruff_python_ast::Stmt) { - if !self.found_attribute { - ast::visitor::walk_stmt(self, stmt); - } - } - - fn visit_body(&mut self, body: &[ruff_python_ast::Stmt]) { - for stmt in body { - self.visit_stmt(stmt); - if self.found_attribute { - return; - } - } - } -} - /// Given an [`ast::StmtTry`] node, does the `try` branch of that node /// contain any [`ast::StmtImportFrom`] nodes that indicate the numpy /// member is being imported from the non-deprecated location? @@ -892,49 +836,3 @@ fn try_block_contains_undeprecated_import( import_searcher.visit_body(&try_node.body); import_searcher.found_import } - -/// AST visitor that searches an AST tree for [`ast::StmtImportFrom`] nodes -/// that match a certain [`QualifiedName`]. -struct ImportSearcher<'a> { - module: &'a str, - name: &'a str, - found_import: bool, -} - -impl<'a> ImportSearcher<'a> { - fn new(module: &'a str, name: &'a str) -> Self { - Self { - module, - name, - found_import: false, - } - } -} - -impl StatementVisitor<'_> for ImportSearcher<'_> { - fn visit_stmt(&mut self, stmt: &ast::Stmt) { - if self.found_import { - return; - } - if let ast::Stmt::ImportFrom(ast::StmtImportFrom { module, names, .. }) = stmt { - if module.as_ref().is_some_and(|module| module == self.module) - && names - .iter() - .any(|ast::Alias { name, .. }| name == self.name) - { - self.found_import = true; - return; - } - } - ast::statement_visitor::walk_stmt(self, stmt); - } - - fn visit_body(&mut self, body: &[ruff_python_ast::Stmt]) { - for stmt in body { - self.visit_stmt(stmt); - if self.found_import { - return; - } - } - } -} diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-function_NPY003.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-function_NPY003.py.snap index d857a69203f2f..879eb315a4038 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-function_NPY003.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-function_NPY003.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/numpy/mod.rs NPY003.py:4:5: NPY003 [*] `np.round_` is deprecated; use `np.round` instead | 2 | import numpy as np -3 | +3 | 4 | np.round_(np.random.rand(5, 5), 2) | ^^^^^^^^^ NPY003 5 | np.product(np.random.rand(5, 5)) @@ -105,7 +105,7 @@ NPY003.py:8:5: NPY003 [*] `np.alltrue` is deprecated; use `np.all` instead NPY003.py:14:5: NPY003 [*] `np.round_` is deprecated; use `np.round` instead | 12 | from numpy import round_, product, cumproduct, sometrue, alltrue -13 | +13 | 14 | round_(np.random.rand(5, 5), 2) | ^^^^^^ NPY003 15 | product(np.random.rand(5, 5)) @@ -221,5 +221,3 @@ NPY003.py:18:5: NPY003 [*] `np.alltrue` is deprecated; use `np.all` instead 17 18 | sometrue(np.random.rand(5, 5)) 18 |- alltrue(np.random.rand(5, 5)) 19 |+ all(np.random.rand(5, 5)) - - diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-type-alias_NPY001.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-type-alias_NPY001.py.snap index 6af2e8eac11cd..b26f49ebd01e1 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-type-alias_NPY001.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-deprecated-type-alias_NPY001.py.snap @@ -26,7 +26,7 @@ NPY001.py:7:1: NPY001 [*] Type alias `np.int` is deprecated, replace with builti 6 | npy.float 7 | npy.int | ^^^^^^^ NPY001 -8 | +8 | 9 | if dtype == np.object: | = help: Replace `np.int` with builtin type @@ -44,7 +44,7 @@ NPY001.py:7:1: NPY001 [*] Type alias `np.int` is deprecated, replace with builti NPY001.py:9:13: NPY001 [*] Type alias `np.object` is deprecated, replace with builtin type | 7 | npy.int - 8 | + 8 | 9 | if dtype == np.object: | ^^^^^^^^^ NPY001 10 | ... @@ -64,10 +64,10 @@ NPY001.py:9:13: NPY001 [*] Type alias `np.object` is deprecated, replace with bu NPY001.py:12:72: NPY001 [*] Type alias `np.int` is deprecated, replace with builtin type | 10 | ... -11 | +11 | 12 | result = result.select_dtypes([np.byte, np.ubyte, np.short, np.ushort, np.int, np.complex]) | ^^^^^^ NPY001 -13 | +13 | 14 | pdf = pd.DataFrame( | = help: Replace `np.int` with builtin type @@ -85,10 +85,10 @@ NPY001.py:12:72: NPY001 [*] Type alias `np.int` is deprecated, replace with buil NPY001.py:12:80: NPY001 [*] Type alias `np.complex` is deprecated, replace with builtin type | 10 | ... -11 | +11 | 12 | result = result.select_dtypes([np.byte, np.ubyte, np.short, np.ushort, np.int, np.complex]) | ^^^^^^^^^^ NPY001 -13 | +13 | 14 | pdf = pd.DataFrame( | = help: Replace `np.complex` with builtin type @@ -126,10 +126,10 @@ NPY001.py:17:11: NPY001 [*] Type alias `np.object` is deprecated, replace with b NPY001.py:20:16: NPY001 [*] Type alias `np.int` is deprecated, replace with builtin type | 18 | ) -19 | +19 | 20 | _ = arr.astype(np.int) | ^^^^^^ NPY001 -21 | +21 | 22 | # Regression test for: https://github.com/astral-sh/ruff/issues/6952 | = help: Replace `np.int` with builtin type @@ -147,7 +147,7 @@ NPY001.py:20:16: NPY001 [*] Type alias `np.int` is deprecated, replace with buil NPY001.py:25:1: NPY001 [*] Type alias `np.float` is deprecated, replace with builtin type | 23 | from numpy import float -24 | +24 | 25 | float(1) | ^^^^^ NPY001 | diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-legacy-random_NPY002.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-legacy-random_NPY002.py.snap index 270fa8fc67857..150b3490bec7d 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-legacy-random_NPY002.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy-legacy-random_NPY002.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/numpy/mod.rs NPY002.py:12:8: NPY002 Replace legacy `np.random.standard_normal` call with `np.random.Generator` | 10 | from numpy import random -11 | +11 | 12 | vals = random.standard_normal(10) | ^^^^^^^^^^^^^^^^^^^^^^ NPY002 13 | more_vals = random.standard_normal(10) @@ -22,7 +22,7 @@ NPY002.py:13:13: NPY002 Replace legacy `np.random.standard_normal` call with `np NPY002.py:18:1: NPY002 Replace legacy `np.random.seed` call with `np.random.Generator` | 16 | import numpy -17 | +17 | 18 | numpy.random.seed() | ^^^^^^^^^^^^^^^^^ NPY002 19 | numpy.random.get_state() @@ -514,5 +514,3 @@ NPY002.py:67:1: NPY002 Replace legacy `np.random.zipf` call with `np.random.Gene 67 | numpy.random.zipf() | ^^^^^^^^^^^^^^^^^ NPY002 | - - diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201.py.snap index 6941c9efc9aff..124a069953c59 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/numpy/mod.rs NPY201.py:4:5: NPY201 [*] `np.add_docstring` will be removed in NumPy 2.0. Use `numpy.lib.add_docstring` instead. | 2 | import numpy as np -3 | +3 | 4 | np.add_docstring | ^^^^^^^^^^^^^^^^ NPY201 -5 | +5 | 6 | np.add_newdoc | = help: Replace with `numpy.lib.add_docstring` @@ -26,10 +26,10 @@ NPY201.py:4:5: NPY201 [*] `np.add_docstring` will be removed in NumPy 2.0. Use ` NPY201.py:6:5: NPY201 [*] `np.add_newdoc` will be removed in NumPy 2.0. Use `numpy.lib.add_newdoc` instead. | 4 | np.add_docstring -5 | +5 | 6 | np.add_newdoc | ^^^^^^^^^^^^^ NPY201 -7 | +7 | 8 | np.add_newdoc_ufunc | = help: Replace with `numpy.lib.add_newdoc` @@ -50,30 +50,30 @@ NPY201.py:6:5: NPY201 [*] `np.add_newdoc` will be removed in NumPy 2.0. Use `num NPY201.py:8:5: NPY201 `np.add_newdoc_ufunc` will be removed in NumPy 2.0. `add_newdoc_ufunc` is an internal function. | 6 | np.add_newdoc - 7 | + 7 | 8 | np.add_newdoc_ufunc | ^^^^^^^^^^^^^^^^^^^ NPY201 - 9 | + 9 | 10 | np.asfarray([1,2,3]) | NPY201.py:10:5: NPY201 `np.asfarray` will be removed in NumPy 2.0. Use `np.asarray` with a `float` dtype instead. | 8 | np.add_newdoc_ufunc - 9 | + 9 | 10 | np.asfarray([1,2,3]) | ^^^^^^^^^^^ NPY201 -11 | +11 | 12 | np.byte_bounds(np.array([1,2,3])) | NPY201.py:12:5: NPY201 [*] `np.byte_bounds` will be removed in NumPy 2.0. Use `numpy.lib.array_utils.byte_bounds` on NumPy 2.0, or ignore this warning on earlier versions. | 10 | np.asfarray([1,2,3]) -11 | +11 | 12 | np.byte_bounds(np.array([1,2,3])) | ^^^^^^^^^^^^^^ NPY201 -13 | +13 | 14 | np.cast | = help: Replace with `numpy.lib.array_utils.byte_bounds` (requires NumPy 2.0 or greater) @@ -96,20 +96,20 @@ NPY201.py:12:5: NPY201 [*] `np.byte_bounds` will be removed in NumPy 2.0. Use `n NPY201.py:14:5: NPY201 `np.cast` will be removed in NumPy 2.0. Use `np.asarray(arr, dtype=dtype)` instead. | 12 | np.byte_bounds(np.array([1,2,3])) -13 | +13 | 14 | np.cast | ^^^^^^^ NPY201 -15 | +15 | 16 | np.cfloat(12+34j) | NPY201.py:16:5: NPY201 [*] `np.cfloat` will be removed in NumPy 2.0. Use `numpy.complex128` instead. | 14 | np.cast -15 | +15 | 16 | np.cfloat(12+34j) | ^^^^^^^^^ NPY201 -17 | +17 | 18 | np.clongfloat(12+34j) | = help: Replace with `numpy.complex128` @@ -127,10 +127,10 @@ NPY201.py:16:5: NPY201 [*] `np.cfloat` will be removed in NumPy 2.0. Use `numpy. NPY201.py:18:5: NPY201 [*] `np.clongfloat` will be removed in NumPy 2.0. Use `numpy.clongdouble` instead. | 16 | np.cfloat(12+34j) -17 | +17 | 18 | np.clongfloat(12+34j) | ^^^^^^^^^^^^^ NPY201 -19 | +19 | 20 | np.compat | = help: Replace with `numpy.clongdouble` @@ -148,20 +148,20 @@ NPY201.py:18:5: NPY201 [*] `np.clongfloat` will be removed in NumPy 2.0. Use `nu NPY201.py:20:5: NPY201 `np.compat` will be removed in NumPy 2.0. Python 2 is no longer supported. | 18 | np.clongfloat(12+34j) -19 | +19 | 20 | np.compat | ^^^^^^^^^ NPY201 -21 | +21 | 22 | np.complex_(12+34j) | NPY201.py:22:5: NPY201 [*] `np.complex_` will be removed in NumPy 2.0. Use `numpy.complex128` instead. | 20 | np.compat -21 | +21 | 22 | np.complex_(12+34j) | ^^^^^^^^^^^ NPY201 -23 | +23 | 24 | np.DataSource | = help: Replace with `numpy.complex128` @@ -179,10 +179,10 @@ NPY201.py:22:5: NPY201 [*] `np.complex_` will be removed in NumPy 2.0. Use `nump NPY201.py:24:5: NPY201 [*] `np.DataSource` will be removed in NumPy 2.0. Use `numpy.lib.npyio.DataSource` instead. | 22 | np.complex_(12+34j) -23 | +23 | 24 | np.DataSource | ^^^^^^^^^^^^^ NPY201 -25 | +25 | 26 | np.deprecate | = help: Replace with `numpy.lib.npyio.DataSource` @@ -205,70 +205,70 @@ NPY201.py:24:5: NPY201 [*] `np.DataSource` will be removed in NumPy 2.0. Use `nu NPY201.py:26:5: NPY201 `np.deprecate` will be removed in NumPy 2.0. Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`. | 24 | np.DataSource -25 | +25 | 26 | np.deprecate | ^^^^^^^^^^^^ NPY201 -27 | +27 | 28 | np.deprecate_with_doc | NPY201.py:28:5: NPY201 `np.deprecate_with_doc` will be removed in NumPy 2.0. Emit `DeprecationWarning` with `warnings.warn` directly, or use `typing.deprecated`. | 26 | np.deprecate -27 | +27 | 28 | np.deprecate_with_doc | ^^^^^^^^^^^^^^^^^^^^^ NPY201 -29 | +29 | 30 | np.disp(10) | NPY201.py:30:5: NPY201 `np.disp` will be removed in NumPy 2.0. Use a dedicated print function instead. | 28 | np.deprecate_with_doc -29 | +29 | 30 | np.disp(10) | ^^^^^^^ NPY201 -31 | +31 | 32 | np.fastCopyAndTranspose | NPY201.py:32:5: NPY201 `np.fastCopyAndTranspose` will be removed in NumPy 2.0. Use `arr.T.copy()` instead. | 30 | np.disp(10) -31 | +31 | 32 | np.fastCopyAndTranspose | ^^^^^^^^^^^^^^^^^^^^^^^ NPY201 -33 | +33 | 34 | np.find_common_type | NPY201.py:34:5: NPY201 `np.find_common_type` will be removed in NumPy 2.0. Use `numpy.promote_types` or `numpy.result_type` instead. To achieve semantics for the `scalar_types` argument, use `numpy.result_type` and pass the Python values `0`, `0.0`, or `0j`. | 32 | np.fastCopyAndTranspose -33 | +33 | 34 | np.find_common_type | ^^^^^^^^^^^^^^^^^^^ NPY201 -35 | +35 | 36 | np.get_array_wrap | NPY201.py:36:5: NPY201 `np.get_array_wrap` will be removed without replacement in NumPy 2.0 | 34 | np.find_common_type -35 | +35 | 36 | np.get_array_wrap | ^^^^^^^^^^^^^^^^^ NPY201 -37 | +37 | 38 | np.float_ | NPY201.py:38:5: NPY201 [*] `np.float_` will be removed in NumPy 2.0. Use `numpy.float64` instead. | 36 | np.get_array_wrap -37 | +37 | 38 | np.float_ | ^^^^^^^^^ NPY201 -39 | +39 | 40 | np.geterrobj | = help: Replace with `numpy.float64` @@ -286,20 +286,20 @@ NPY201.py:38:5: NPY201 [*] `np.float_` will be removed in NumPy 2.0. Use `numpy. NPY201.py:40:5: NPY201 `np.geterrobj` will be removed in NumPy 2.0. Use the `np.errstate` context manager instead. | 38 | np.float_ -39 | +39 | 40 | np.geterrobj | ^^^^^^^^^^^^ NPY201 -41 | +41 | 42 | np.Inf | NPY201.py:42:5: NPY201 [*] `np.Inf` will be removed in NumPy 2.0. Use `numpy.inf` instead. | 40 | np.geterrobj -41 | +41 | 42 | np.Inf | ^^^^^^ NPY201 -43 | +43 | 44 | np.Infinity | = help: Replace with `numpy.inf` @@ -317,10 +317,10 @@ NPY201.py:42:5: NPY201 [*] `np.Inf` will be removed in NumPy 2.0. Use `numpy.inf NPY201.py:44:5: NPY201 [*] `np.Infinity` will be removed in NumPy 2.0. Use `numpy.inf` instead. | 42 | np.Inf -43 | +43 | 44 | np.Infinity | ^^^^^^^^^^^ NPY201 -45 | +45 | 46 | np.infty | = help: Replace with `numpy.inf` @@ -338,10 +338,10 @@ NPY201.py:44:5: NPY201 [*] `np.Infinity` will be removed in NumPy 2.0. Use `nump NPY201.py:46:5: NPY201 [*] `np.infty` will be removed in NumPy 2.0. Use `numpy.inf` instead. | 44 | np.Infinity -45 | +45 | 46 | np.infty | ^^^^^^^^ NPY201 -47 | +47 | 48 | np.issctype | = help: Replace with `numpy.inf` @@ -359,20 +359,20 @@ NPY201.py:46:5: NPY201 [*] `np.infty` will be removed in NumPy 2.0. Use `numpy.i NPY201.py:48:5: NPY201 `np.issctype` will be removed without replacement in NumPy 2.0 | 46 | np.infty -47 | +47 | 48 | np.issctype | ^^^^^^^^^^^ NPY201 -49 | +49 | 50 | np.issubclass_(np.int32, np.integer) | NPY201.py:50:5: NPY201 [*] `np.issubclass_` will be removed in NumPy 2.0. Use `issubclass` instead. | 48 | np.issctype -49 | +49 | 50 | np.issubclass_(np.int32, np.integer) | ^^^^^^^^^^^^^^ NPY201 -51 | +51 | 52 | np.issubsctype | = help: Replace with `issubclass` @@ -390,10 +390,10 @@ NPY201.py:50:5: NPY201 [*] `np.issubclass_` will be removed in NumPy 2.0. Use `i NPY201.py:52:5: NPY201 [*] `np.issubsctype` will be removed in NumPy 2.0. Use `numpy.issubdtype` instead. | 50 | np.issubclass_(np.int32, np.integer) -51 | +51 | 52 | np.issubsctype | ^^^^^^^^^^^^^^ NPY201 -53 | +53 | 54 | np.mat | = help: Replace with `numpy.issubdtype` @@ -411,10 +411,10 @@ NPY201.py:52:5: NPY201 [*] `np.issubsctype` will be removed in NumPy 2.0. Use `n NPY201.py:54:5: NPY201 [*] `np.mat` will be removed in NumPy 2.0. Use `numpy.asmatrix` instead. | 52 | np.issubsctype -53 | +53 | 54 | np.mat | ^^^^^^ NPY201 -55 | +55 | 56 | np.maximum_sctype | = help: Replace with `numpy.asmatrix` @@ -432,20 +432,20 @@ NPY201.py:54:5: NPY201 [*] `np.mat` will be removed in NumPy 2.0. Use `numpy.asm NPY201.py:56:5: NPY201 `np.maximum_sctype` will be removed without replacement in NumPy 2.0 | 54 | np.mat -55 | +55 | 56 | np.maximum_sctype | ^^^^^^^^^^^^^^^^^ NPY201 -57 | +57 | 58 | np.NaN | NPY201.py:58:5: NPY201 [*] `np.NaN` will be removed in NumPy 2.0. Use `numpy.nan` instead. | 56 | np.maximum_sctype -57 | +57 | 58 | np.NaN | ^^^^^^ NPY201 -59 | +59 | 60 | np.nbytes[np.int64] | = help: Replace with `numpy.nan` @@ -463,20 +463,20 @@ NPY201.py:58:5: NPY201 [*] `np.NaN` will be removed in NumPy 2.0. Use `numpy.nan NPY201.py:60:5: NPY201 `np.nbytes` will be removed in NumPy 2.0. Use `np.dtype(<dtype>).itemsize` instead. | 58 | np.NaN -59 | +59 | 60 | np.nbytes[np.int64] | ^^^^^^^^^ NPY201 -61 | +61 | 62 | np.NINF | NPY201.py:62:5: NPY201 [*] `np.NINF` will be removed in NumPy 2.0. Use `-np.inf` instead. | 60 | np.nbytes[np.int64] -61 | +61 | 62 | np.NINF | ^^^^^^^ NPY201 -63 | +63 | 64 | np.NZERO | = help: Replace with `-np.inf` @@ -494,10 +494,10 @@ NPY201.py:62:5: NPY201 [*] `np.NINF` will be removed in NumPy 2.0. Use `-np.inf` NPY201.py:64:5: NPY201 [*] `np.NZERO` will be removed in NumPy 2.0. Use `-0.0` instead. | 62 | np.NINF -63 | +63 | 64 | np.NZERO | ^^^^^^^^ NPY201 -65 | +65 | 66 | np.longcomplex(12+34j) | = help: Replace with `-0.0` @@ -515,10 +515,10 @@ NPY201.py:64:5: NPY201 [*] `np.NZERO` will be removed in NumPy 2.0. Use `-0.0` i NPY201.py:66:5: NPY201 [*] `np.longcomplex` will be removed in NumPy 2.0. Use `numpy.clongdouble` instead. | 64 | np.NZERO -65 | +65 | 66 | np.longcomplex(12+34j) | ^^^^^^^^^^^^^^ NPY201 -67 | +67 | 68 | np.longfloat(12+34j) | = help: Replace with `numpy.clongdouble` @@ -536,10 +536,10 @@ NPY201.py:66:5: NPY201 [*] `np.longcomplex` will be removed in NumPy 2.0. Use `n NPY201.py:68:5: NPY201 [*] `np.longfloat` will be removed in NumPy 2.0. Use `numpy.longdouble` instead. | 66 | np.longcomplex(12+34j) -67 | +67 | 68 | np.longfloat(12+34j) | ^^^^^^^^^^^^ NPY201 -69 | +69 | 70 | np.lookfor | = help: Replace with `numpy.longdouble` @@ -557,20 +557,20 @@ NPY201.py:68:5: NPY201 [*] `np.longfloat` will be removed in NumPy 2.0. Use `num NPY201.py:70:5: NPY201 `np.lookfor` will be removed in NumPy 2.0. Search NumPy’s documentation directly. | 68 | np.longfloat(12+34j) -69 | +69 | 70 | np.lookfor | ^^^^^^^^^^ NPY201 -71 | +71 | 72 | np.NAN | NPY201.py:72:5: NPY201 [*] `np.NAN` will be removed in NumPy 2.0. Use `numpy.nan` instead. | 70 | np.lookfor -71 | +71 | 72 | np.NAN | ^^^^^^ NPY201 -73 | +73 | 74 | try: | = help: Replace with `numpy.nan` diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_2.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_2.py.snap index 56be229615aa6..9350fd8d19896 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_2.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_2.py.snap @@ -4,20 +4,20 @@ source: crates/ruff_linter/src/rules/numpy/mod.rs NPY201_2.py:4:5: NPY201 `np.obj2sctype` will be removed without replacement in NumPy 2.0 | 2 | import numpy as np -3 | +3 | 4 | np.obj2sctype(int) | ^^^^^^^^^^^^^ NPY201 -5 | +5 | 6 | np.PINF | NPY201_2.py:6:5: NPY201 [*] `np.PINF` will be removed in NumPy 2.0. Use `numpy.inf` instead. | 4 | np.obj2sctype(int) -5 | +5 | 6 | np.PINF | ^^^^^^^ NPY201 -7 | +7 | 8 | np.PZERO | = help: Replace with `numpy.inf` @@ -35,10 +35,10 @@ NPY201_2.py:6:5: NPY201 [*] `np.PINF` will be removed in NumPy 2.0. Use `numpy.i NPY201_2.py:8:5: NPY201 [*] `np.PZERO` will be removed in NumPy 2.0. Use `0.0` instead. | 6 | np.PINF - 7 | + 7 | 8 | np.PZERO | ^^^^^^^^ NPY201 - 9 | + 9 | 10 | np.recfromcsv | = help: Replace with `0.0` @@ -56,30 +56,30 @@ NPY201_2.py:8:5: NPY201 [*] `np.PZERO` will be removed in NumPy 2.0. Use `0.0` i NPY201_2.py:10:5: NPY201 `np.recfromcsv` will be removed in NumPy 2.0. Use `np.genfromtxt` with comma delimiter instead. | 8 | np.PZERO - 9 | + 9 | 10 | np.recfromcsv | ^^^^^^^^^^^^^ NPY201 -11 | +11 | 12 | np.recfromtxt | NPY201_2.py:12:5: NPY201 `np.recfromtxt` will be removed in NumPy 2.0. Use `np.genfromtxt` instead. | 10 | np.recfromcsv -11 | +11 | 12 | np.recfromtxt | ^^^^^^^^^^^^^ NPY201 -13 | +13 | 14 | np.round_(12.34) | NPY201_2.py:14:5: NPY201 [*] `np.round_` will be removed in NumPy 2.0. Use `numpy.round` instead. | 12 | np.recfromtxt -13 | +13 | 14 | np.round_(12.34) | ^^^^^^^^^ NPY201 -15 | +15 | 16 | np.safe_eval | = help: Replace with `numpy.round` @@ -97,10 +97,10 @@ NPY201_2.py:14:5: NPY201 [*] `np.round_` will be removed in NumPy 2.0. Use `nump NPY201_2.py:16:5: NPY201 [*] `np.safe_eval` will be removed in NumPy 2.0. Use `ast.literal_eval` instead. | 14 | np.round_(12.34) -15 | +15 | 16 | np.safe_eval | ^^^^^^^^^^^^ NPY201 -17 | +17 | 18 | np.sctype2char | = help: Replace with `ast.literal_eval` @@ -123,50 +123,50 @@ NPY201_2.py:16:5: NPY201 [*] `np.safe_eval` will be removed in NumPy 2.0. Use `a NPY201_2.py:18:5: NPY201 `np.sctype2char` will be removed without replacement in NumPy 2.0 | 16 | np.safe_eval -17 | +17 | 18 | np.sctype2char | ^^^^^^^^^^^^^^ NPY201 -19 | +19 | 20 | np.sctypes | NPY201_2.py:20:5: NPY201 `np.sctypes` will be removed without replacement in NumPy 2.0 | 18 | np.sctype2char -19 | +19 | 20 | np.sctypes | ^^^^^^^^^^ NPY201 -21 | +21 | 22 | np.seterrobj | NPY201_2.py:22:5: NPY201 `np.seterrobj` will be removed in NumPy 2.0. Use the `np.errstate` context manager instead. | 20 | np.sctypes -21 | +21 | 22 | np.seterrobj | ^^^^^^^^^^^^ NPY201 -23 | +23 | 24 | np.set_numeric_ops | NPY201_2.py:26:5: NPY201 `np.set_string_function` will be removed in NumPy 2.0. Use `np.set_printoptions` for custom printing of NumPy objects. | 24 | np.set_numeric_ops -25 | +25 | 26 | np.set_string_function | ^^^^^^^^^^^^^^^^^^^^^^ NPY201 -27 | +27 | 28 | np.singlecomplex(12+1j) | NPY201_2.py:28:5: NPY201 [*] `np.singlecomplex` will be removed in NumPy 2.0. Use `numpy.complex64` instead. | 26 | np.set_string_function -27 | +27 | 28 | np.singlecomplex(12+1j) | ^^^^^^^^^^^^^^^^ NPY201 -29 | +29 | 30 | np.string_("asdf") | = help: Replace with `numpy.complex64` @@ -184,10 +184,10 @@ NPY201_2.py:28:5: NPY201 [*] `np.singlecomplex` will be removed in NumPy 2.0. Us NPY201_2.py:30:5: NPY201 [*] `np.string_` will be removed in NumPy 2.0. Use `numpy.bytes_` instead. | 28 | np.singlecomplex(12+1j) -29 | +29 | 30 | np.string_("asdf") | ^^^^^^^^^^ NPY201 -31 | +31 | 32 | np.source | = help: Replace with `numpy.bytes_` @@ -205,10 +205,10 @@ NPY201_2.py:30:5: NPY201 [*] `np.string_` will be removed in NumPy 2.0. Use `num NPY201_2.py:32:5: NPY201 [*] `np.source` will be removed in NumPy 2.0. Use `inspect.getsource` instead. | 30 | np.string_("asdf") -31 | +31 | 32 | np.source | ^^^^^^^^^ NPY201 -33 | +33 | 34 | np.tracemalloc_domain | = help: Replace with `inspect.getsource` @@ -231,10 +231,10 @@ NPY201_2.py:32:5: NPY201 [*] `np.source` will be removed in NumPy 2.0. Use `insp NPY201_2.py:34:5: NPY201 [*] `np.tracemalloc_domain` will be removed in NumPy 2.0. Use `numpy.lib.tracemalloc_domain` instead. | 32 | np.source -33 | +33 | 34 | np.tracemalloc_domain | ^^^^^^^^^^^^^^^^^^^^^ NPY201 -35 | +35 | 36 | np.unicode_("asf") | = help: Replace with `numpy.lib.tracemalloc_domain` @@ -257,10 +257,10 @@ NPY201_2.py:34:5: NPY201 [*] `np.tracemalloc_domain` will be removed in NumPy 2. NPY201_2.py:36:5: NPY201 [*] `np.unicode_` will be removed in NumPy 2.0. Use `numpy.str_` instead. | 34 | np.tracemalloc_domain -35 | +35 | 36 | np.unicode_("asf") | ^^^^^^^^^^^ NPY201 -37 | +37 | 38 | np.who() | = help: Replace with `numpy.str_` @@ -278,20 +278,20 @@ NPY201_2.py:36:5: NPY201 [*] `np.unicode_` will be removed in NumPy 2.0. Use `nu NPY201_2.py:38:5: NPY201 `np.who` will be removed in NumPy 2.0. Use an IDE variable explorer or `locals()` instead. | 36 | np.unicode_("asf") -37 | +37 | 38 | np.who() | ^^^^^^ NPY201 -39 | +39 | 40 | np.row_stack(([1,2], [3,4])) | NPY201_2.py:40:5: NPY201 [*] `np.row_stack` will be removed in NumPy 2.0. Use `numpy.vstack` instead. | 38 | np.who() -39 | +39 | 40 | np.row_stack(([1,2], [3,4])) | ^^^^^^^^^^^^ NPY201 -41 | +41 | 42 | np.alltrue([True, True]) | = help: Replace with `numpy.vstack` @@ -309,10 +309,10 @@ NPY201_2.py:40:5: NPY201 [*] `np.row_stack` will be removed in NumPy 2.0. Use `n NPY201_2.py:42:5: NPY201 [*] `np.alltrue` will be removed in NumPy 2.0. Use `numpy.all` instead. | 40 | np.row_stack(([1,2], [3,4])) -41 | +41 | 42 | np.alltrue([True, True]) | ^^^^^^^^^^ NPY201 -43 | +43 | 44 | np.sometrue([True, False]) | = help: Replace with `numpy.all` @@ -330,10 +330,10 @@ NPY201_2.py:42:5: NPY201 [*] `np.alltrue` will be removed in NumPy 2.0. Use `num NPY201_2.py:44:5: NPY201 [*] `np.sometrue` will be removed in NumPy 2.0. Use `numpy.any` instead. | 42 | np.alltrue([True, True]) -43 | +43 | 44 | np.sometrue([True, False]) | ^^^^^^^^^^^ NPY201 -45 | +45 | 46 | np.cumproduct([1, 2, 3]) | = help: Replace with `numpy.any` @@ -351,10 +351,10 @@ NPY201_2.py:44:5: NPY201 [*] `np.sometrue` will be removed in NumPy 2.0. Use `nu NPY201_2.py:46:5: NPY201 [*] `np.cumproduct` will be removed in NumPy 2.0. Use `numpy.cumprod` instead. | 44 | np.sometrue([True, False]) -45 | +45 | 46 | np.cumproduct([1, 2, 3]) | ^^^^^^^^^^^^^ NPY201 -47 | +47 | 48 | np.product([1, 2, 3]) | = help: Replace with `numpy.cumprod` @@ -372,10 +372,10 @@ NPY201_2.py:46:5: NPY201 [*] `np.cumproduct` will be removed in NumPy 2.0. Use ` NPY201_2.py:48:5: NPY201 [*] `np.product` will be removed in NumPy 2.0. Use `numpy.prod` instead. | 46 | np.cumproduct([1, 2, 3]) -47 | +47 | 48 | np.product([1, 2, 3]) | ^^^^^^^^^^ NPY201 -49 | +49 | 50 | np.trapz([1, 2, 3]) | = help: Replace with `numpy.prod` @@ -393,10 +393,10 @@ NPY201_2.py:48:5: NPY201 [*] `np.product` will be removed in NumPy 2.0. Use `num NPY201_2.py:50:5: NPY201 [*] `np.trapz` will be removed in NumPy 2.0. Use `numpy.trapezoid` on NumPy 2.0, or ignore this warning on earlier versions. | 48 | np.product([1, 2, 3]) -49 | +49 | 50 | np.trapz([1, 2, 3]) | ^^^^^^^^ NPY201 -51 | +51 | 52 | np.in1d([1, 2], [1, 3, 5]) | = help: Replace with `numpy.trapezoid` (requires NumPy 2.0 or greater) @@ -414,10 +414,10 @@ NPY201_2.py:50:5: NPY201 [*] `np.trapz` will be removed in NumPy 2.0. Use `numpy NPY201_2.py:52:5: NPY201 [*] `np.in1d` will be removed in NumPy 2.0. Use `numpy.isin` instead. | 50 | np.trapz([1, 2, 3]) -51 | +51 | 52 | np.in1d([1, 2], [1, 3, 5]) | ^^^^^^^ NPY201 -53 | +53 | 54 | np.AxisError | = help: Replace with `numpy.isin` @@ -435,10 +435,10 @@ NPY201_2.py:52:5: NPY201 [*] `np.in1d` will be removed in NumPy 2.0. Use `numpy. NPY201_2.py:54:5: NPY201 [*] `np.AxisError` will be removed in NumPy 2.0. Use `numpy.exceptions.AxisError` instead. | 52 | np.in1d([1, 2], [1, 3, 5]) -53 | +53 | 54 | np.AxisError | ^^^^^^^^^^^^ NPY201 -55 | +55 | 56 | np.ComplexWarning | = help: Replace with `numpy.exceptions.AxisError` @@ -461,10 +461,10 @@ NPY201_2.py:54:5: NPY201 [*] `np.AxisError` will be removed in NumPy 2.0. Use `n NPY201_2.py:56:5: NPY201 [*] `np.ComplexWarning` will be removed in NumPy 2.0. Use `numpy.exceptions.ComplexWarning` instead. | 54 | np.AxisError -55 | +55 | 56 | np.ComplexWarning | ^^^^^^^^^^^^^^^^^ NPY201 -57 | +57 | 58 | np.compare_chararrays | = help: Replace with `numpy.exceptions.ComplexWarning` @@ -487,10 +487,10 @@ NPY201_2.py:56:5: NPY201 [*] `np.ComplexWarning` will be removed in NumPy 2.0. U NPY201_2.py:58:5: NPY201 [*] `np.compare_chararrays` will be removed in NumPy 2.0. Use `numpy.char.compare_chararrays` instead. | 56 | np.ComplexWarning -57 | +57 | 58 | np.compare_chararrays | ^^^^^^^^^^^^^^^^^^^^^ NPY201 -59 | +59 | 60 | try: | = help: Replace with `numpy.char.compare_chararrays` @@ -516,7 +516,7 @@ NPY201_2.py:63:9: NPY201 [*] `np.alltrue` will be removed in NumPy 2.0. Use `num 62 | except TypeError: 63 | np.alltrue([True, True]) # Should emit a warning here (`except TypeError`, not `except AttributeError`) | ^^^^^^^^^^ NPY201 -64 | +64 | 65 | try: | = help: Replace with `numpy.all` diff --git a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_3.py.snap b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_3.py.snap index 2ba8e85fa30d1..bcdea9554d9dd 100644 --- a/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_3.py.snap +++ b/crates/ruff_linter/src/rules/numpy/snapshots/ruff_linter__rules__numpy__tests__numpy2-deprecation_NPY201_3.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/numpy/mod.rs NPY201_3.py:4:5: NPY201 [*] `np.DTypePromotionError` will be removed in NumPy 2.0. Use `numpy.exceptions.DTypePromotionError` instead. | 2 | import numpy as np -3 | +3 | 4 | np.DTypePromotionError | ^^^^^^^^^^^^^^^^^^^^^^ NPY201 -5 | +5 | 6 | np.ModuleDeprecationWarning | = help: Replace with `numpy.exceptions.DTypePromotionError` @@ -26,10 +26,10 @@ NPY201_3.py:4:5: NPY201 [*] `np.DTypePromotionError` will be removed in NumPy 2. NPY201_3.py:6:5: NPY201 [*] `np.ModuleDeprecationWarning` will be removed in NumPy 2.0. Use `numpy.exceptions.ModuleDeprecationWarning` instead. | 4 | np.DTypePromotionError -5 | +5 | 6 | np.ModuleDeprecationWarning | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ NPY201 -7 | +7 | 8 | np.RankWarning | = help: Replace with `numpy.exceptions.ModuleDeprecationWarning` @@ -50,10 +50,10 @@ NPY201_3.py:6:5: NPY201 [*] `np.ModuleDeprecationWarning` will be removed in Num NPY201_3.py:8:5: NPY201 [*] `np.RankWarning` will be removed in NumPy 2.0. Use `numpy.exceptions.RankWarning` on NumPy 2.0, or ignore this warning on earlier versions. | 6 | np.ModuleDeprecationWarning - 7 | + 7 | 8 | np.RankWarning | ^^^^^^^^^^^^^^ NPY201 - 9 | + 9 | 10 | np.TooHardError | = help: Replace with `numpy.exceptions.RankWarning` (requires NumPy 2.0 or greater) @@ -76,10 +76,10 @@ NPY201_3.py:8:5: NPY201 [*] `np.RankWarning` will be removed in NumPy 2.0. Use ` NPY201_3.py:10:5: NPY201 [*] `np.TooHardError` will be removed in NumPy 2.0. Use `numpy.exceptions.TooHardError` instead. | 8 | np.RankWarning - 9 | + 9 | 10 | np.TooHardError | ^^^^^^^^^^^^^^^ NPY201 -11 | +11 | 12 | np.VisibleDeprecationWarning | = help: Replace with `numpy.exceptions.TooHardError` @@ -102,10 +102,10 @@ NPY201_3.py:10:5: NPY201 [*] `np.TooHardError` will be removed in NumPy 2.0. Use NPY201_3.py:12:5: NPY201 [*] `np.VisibleDeprecationWarning` will be removed in NumPy 2.0. Use `numpy.exceptions.VisibleDeprecationWarning` instead. | 10 | np.TooHardError -11 | +11 | 12 | np.VisibleDeprecationWarning | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NPY201 -13 | +13 | 14 | np.chararray | = help: Replace with `numpy.exceptions.VisibleDeprecationWarning` @@ -128,10 +128,10 @@ NPY201_3.py:12:5: NPY201 [*] `np.VisibleDeprecationWarning` will be removed in N NPY201_3.py:14:5: NPY201 [*] `np.chararray` will be removed in NumPy 2.0. Use `numpy.char.chararray` instead. | 12 | np.VisibleDeprecationWarning -13 | +13 | 14 | np.chararray | ^^^^^^^^^^^^ NPY201 -15 | +15 | 16 | np.format_parser | = help: Replace with `numpy.char.chararray` @@ -153,7 +153,7 @@ NPY201_3.py:14:5: NPY201 [*] `np.chararray` will be removed in NumPy 2.0. Use `n NPY201_3.py:16:5: NPY201 [*] `np.format_parser` will be removed in NumPy 2.0. Use `numpy.rec.format_parser` instead. | 14 | np.chararray -15 | +15 | 16 | np.format_parser | ^^^^^^^^^^^^^^^^ NPY201 | diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/assignment_to_df.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/assignment_to_df.rs index 20b81d76e7cc4..2d8e63f3c4fcb 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/assignment_to_df.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/assignment_to_df.rs @@ -1,14 +1,14 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does /// Checks for assignments to the variable `df`. /// /// ## Why is this bad? -/// Although `df` is a common variable name for a Pandas DataFrame, it's not a +/// Although `df` is a common variable name for a Pandas `DataFrame`, it's not a /// great variable name for production code, as it's non-descriptive and /// prone to name conflicts. /// @@ -27,13 +27,13 @@ use ruff_text_size::Ranged; /// /// animals = pd.read_csv("animals.csv") /// ``` -#[violation] -pub struct PandasDfVariableName; +#[derive(ViolationMetadata)] +pub(crate) struct PandasDfVariableName; impl Violation for PandasDfVariableName { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid using the generic variable name `df` for DataFrames") + "Avoid using the generic variable name `df` for DataFrames".to_string() } } diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/attr.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/attr.rs index 61af0d2c80df4..dc63d78a322af 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/attr.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/attr.rs @@ -1,10 +1,11 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; +use crate::rules::pandas_vet::helpers::{Resolution, test_expression}; /// ## What it does /// Checks for uses of `.values` on Pandas Series and Index objects. @@ -32,18 +33,22 @@ use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; /// /// ## References /// - [Pandas documentation: Accessing the values in a Series or Index](https://pandas.pydata.org/pandas-docs/stable/whatsnew/v0.24.0.html#accessing-the-values-in-a-series-or-index) -#[violation] -pub struct PandasUseOfDotValues; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotValues; impl Violation for PandasUseOfDotValues { #[derive_message_formats] fn message(&self) -> String { - format!("Use `.to_numpy()` instead of `.values`") + "Use `.to_numpy()` instead of `.values`".to_string() } } /// PD011 -pub(crate) fn attr(checker: &mut Checker, attribute: &ast::ExprAttribute) { +pub(crate) fn attr(checker: &Checker, attribute: &ast::ExprAttribute) { + if !checker.semantic().seen_module(Modules::PANDAS) { + return; + } + // Avoid, e.g., `x.values = y`. if !attribute.ctx.is_load() { return; @@ -72,7 +77,5 @@ pub(crate) fn attr(checker: &mut Checker, attribute: &ast::ExprAttribute) { return; } - checker - .diagnostics - .push(Diagnostic::new(PandasUseOfDotValues, attribute.range())); + checker.report_diagnostic(Diagnostic::new(PandasUseOfDotValues, attribute.range())); } diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/call.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/call.rs index 98788ed06f6c3..894fdf2b2c221 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/call.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/call.rs @@ -1,13 +1,14 @@ use ruff_python_ast::{self as ast, Expr}; +use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_diagnostics::{Diagnostic, DiagnosticKind}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::registry::Rule; -use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; +use crate::rules::pandas_vet::helpers::{Resolution, test_expression}; /// ## What it does /// Checks for uses of `.isnull` on Pandas objects. @@ -39,13 +40,13 @@ use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; /// ## References /// - [Pandas documentation: `isnull`](https://pandas.pydata.org/docs/reference/api/pandas.isnull.html#pandas.isnull) /// - [Pandas documentation: `isna`](https://pandas.pydata.org/docs/reference/api/pandas.isna.html#pandas.isna) -#[violation] -pub struct PandasUseOfDotIsNull; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotIsNull; impl Violation for PandasUseOfDotIsNull { #[derive_message_formats] fn message(&self) -> String { - format!("`.isna` is preferred to `.isnull`; functionality is equivalent") + "`.isna` is preferred to `.isnull`; functionality is equivalent".to_string() } } @@ -79,13 +80,13 @@ impl Violation for PandasUseOfDotIsNull { /// ## References /// - [Pandas documentation: `notnull`](https://pandas.pydata.org/docs/reference/api/pandas.notnull.html#pandas.notnull) /// - [Pandas documentation: `notna`](https://pandas.pydata.org/docs/reference/api/pandas.notna.html#pandas.notna) -#[violation] -pub struct PandasUseOfDotNotNull; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotNotNull; impl Violation for PandasUseOfDotNotNull { #[derive_message_formats] fn message(&self) -> String { - format!("`.notna` is preferred to `.notnull`; functionality is equivalent") + "`.notna` is preferred to `.notnull`; functionality is equivalent".to_string() } } @@ -115,15 +116,14 @@ impl Violation for PandasUseOfDotNotNull { /// ## References /// - [Pandas documentation: Reshaping and pivot tables](https://pandas.pydata.org/docs/user_guide/reshaping.html) /// - [Pandas documentation: `pivot_table`](https://pandas.pydata.org/docs/reference/api/pandas.pivot_table.html#pandas.pivot_table) -#[violation] -pub struct PandasUseOfDotPivotOrUnstack; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotPivotOrUnstack; impl Violation for PandasUseOfDotPivotOrUnstack { #[derive_message_formats] fn message(&self) -> String { - format!( - "`.pivot_table` is preferred to `.pivot` or `.unstack`; provides same functionality" - ) + "`.pivot_table` is preferred to `.pivot` or `.unstack`; provides same functionality" + .to_string() } } @@ -153,26 +153,32 @@ impl Violation for PandasUseOfDotPivotOrUnstack { /// ## References /// - [Pandas documentation: `melt`](https://pandas.pydata.org/docs/reference/api/pandas.melt.html) /// - [Pandas documentation: `stack`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.stack.html) -#[violation] -pub struct PandasUseOfDotStack; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotStack; impl Violation for PandasUseOfDotStack { #[derive_message_formats] fn message(&self) -> String { - format!("`.melt` is preferred to `.stack`; provides same functionality") + "`.melt` is preferred to `.stack`; provides same functionality".to_string() } } -pub(crate) fn call(checker: &mut Checker, func: &Expr) { +pub(crate) fn call(checker: &Checker, func: &Expr) { + if !checker.semantic().seen_module(Modules::PANDAS) { + return; + } + let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func else { return; }; - let violation: DiagnosticKind = match attr.as_str() { + + let range = func.range(); + let diagnostic = match attr.as_str() { "isnull" if checker.settings.rules.enabled(Rule::PandasUseOfDotIsNull) => { - PandasUseOfDotIsNull.into() + Diagnostic::new(PandasUseOfDotIsNull, range) } "notnull" if checker.settings.rules.enabled(Rule::PandasUseOfDotNotNull) => { - PandasUseOfDotNotNull.into() + Diagnostic::new(PandasUseOfDotNotNull, range) } "pivot" | "unstack" if checker @@ -180,10 +186,10 @@ pub(crate) fn call(checker: &mut Checker, func: &Expr) { .rules .enabled(Rule::PandasUseOfDotPivotOrUnstack) => { - PandasUseOfDotPivotOrUnstack.into() + Diagnostic::new(PandasUseOfDotPivotOrUnstack, range) } "stack" if checker.settings.rules.enabled(Rule::PandasUseOfDotStack) => { - PandasUseOfDotStack.into() + Diagnostic::new(PandasUseOfDotStack, range) } _ => return, }; @@ -196,7 +202,5 @@ pub(crate) fn call(checker: &mut Checker, func: &Expr) { return; } - checker - .diagnostics - .push(Diagnostic::new(violation, func.range())); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/inplace_argument.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/inplace_argument.rs index 2347f15878b3b..9afc5818a9839 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/inplace_argument.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/inplace_argument.rs @@ -1,14 +1,14 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Keyword, Stmt}; use ruff_python_trivia::CommentRanges; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; use crate::Locator; +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for `inplace=True` usages in `pandas` function and method @@ -33,16 +33,16 @@ use crate::Locator; /// ``` /// /// ## References -/// - [_Why You Should Probably Never Use pandas inplace=True_](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4) -#[violation] -pub struct PandasUseOfInplaceArgument; +/// - [_Why You Should Probably Never Use pandas `inplace=True`_](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4) +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfInplaceArgument; impl Violation for PandasUseOfInplaceArgument { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`inplace=True` should be avoided; it has inconsistent behavior") + "`inplace=True` should be avoided; it has inconsistent behavior".to_string() } fn fix_title(&self) -> Option<String> { @@ -51,7 +51,7 @@ impl Violation for PandasUseOfInplaceArgument { } /// PD002 -pub(crate) fn inplace_argument(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn inplace_argument(checker: &Checker, call: &ast::ExprCall) { // If the function was imported from another module, and it's _not_ Pandas, abort. if checker .semantic() @@ -100,7 +100,7 @@ pub(crate) fn inplace_argument(checker: &mut Checker, call: &ast::ExprCall) { } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } // Duplicate keywords is a syntax error, so we can stop here. diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/nunique_constant_series_check.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/nunique_constant_series_check.rs index 1c8f310442291..fefe0ed4a7e19 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/nunique_constant_series_check.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/nunique_constant_series_check.rs @@ -1,11 +1,12 @@ use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr, Int}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; +use crate::rules::pandas_vet::helpers::{Resolution, test_expression}; /// ## What it does /// Check for uses of `.nunique()` to check if a Pandas Series is constant @@ -50,24 +51,28 @@ use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; /// ## References /// - [Pandas Cookbook: "Constant Series"](https://pandas.pydata.org/docs/user_guide/cookbook.html#constant-series) /// - [Pandas documentation: `nunique`](https://pandas.pydata.org/docs/reference/api/pandas.Series.nunique.html) -#[violation] -pub struct PandasNuniqueConstantSeriesCheck; +#[derive(ViolationMetadata)] +pub(crate) struct PandasNuniqueConstantSeriesCheck; impl Violation for PandasNuniqueConstantSeriesCheck { #[derive_message_formats] fn message(&self) -> String { - format!("Using `series.nunique()` for checking that a series is constant is inefficient") + "Using `series.nunique()` for checking that a series is constant is inefficient".to_string() } } /// PD101 pub(crate) fn nunique_constant_series_check( - checker: &mut Checker, + checker: &Checker, expr: &Expr, left: &Expr, ops: &[CmpOp], comparators: &[Expr], ) { + if !checker.semantic().seen_module(Modules::PANDAS) { + return; + } + let ([op], [right]) = (ops, comparators) else { return; }; @@ -109,7 +114,7 @@ pub(crate) fn nunique_constant_series_check( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PandasNuniqueConstantSeriesCheck, expr.range(), )); diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/pd_merge.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/pd_merge.rs index 3c2c0eb381aef..e7cf969c38339 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/pd_merge.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/pd_merge.rs @@ -2,14 +2,15 @@ use ruff_python_ast::{self as ast, Expr}; use crate::checkers::ast::Checker; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; /// ## What it does /// Checks for uses of `pd.merge` on Pandas objects. /// /// ## Why is this bad? -/// In Pandas, the `.merge` method (exposed on, e.g., DataFrame objects) and +/// In Pandas, the `.merge` method (exposed on, e.g., `DataFrame` objects) and /// the `pd.merge` function (exposed on the Pandas module) are equivalent. /// /// For consistency, prefer calling `.merge` on an object over calling @@ -41,27 +42,28 @@ use ruff_text_size::Ranged; /// ## References /// - [Pandas documentation: `merge`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.merge.html#pandas.DataFrame.merge) /// - [Pandas documentation: `pd.merge`](https://pandas.pydata.org/docs/reference/api/pandas.merge.html#pandas.merge) -#[violation] -pub struct PandasUseOfPdMerge; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfPdMerge; impl Violation for PandasUseOfPdMerge { #[derive_message_formats] fn message(&self) -> String { - format!( - "Use `.merge` method instead of `pd.merge` function. They have equivalent \ + "Use `.merge` method instead of `pd.merge` function. They have equivalent \ functionality." - ) + .to_string() } } /// PD015 -pub(crate) fn use_of_pd_merge(checker: &mut Checker, func: &Expr) { +pub(crate) fn use_of_pd_merge(checker: &Checker, func: &Expr) { + if !checker.semantic().seen_module(Modules::PANDAS) { + return; + } + if let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = func { if let Expr::Name(ast::ExprName { id, .. }) = value.as_ref() { if id == "pd" && attr == "merge" { - checker - .diagnostics - .push(Diagnostic::new(PandasUseOfPdMerge, func.range())); + checker.report_diagnostic(Diagnostic::new(PandasUseOfPdMerge, func.range())); } } } diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/read_table.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/read_table.rs index e9ffb89aa962e..29c1c9bef28f1 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/read_table.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/read_table.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::Expr; use ruff_python_semantic::Modules; @@ -35,18 +35,18 @@ use crate::checkers::ast::Checker; /// ## References /// - [Pandas documentation: `read_csv`](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html#pandas.read_csv) /// - [Pandas documentation: `read_table`](https://pandas.pydata.org/docs/reference/api/pandas.read_table.html#pandas.read_table) -#[violation] -pub struct PandasUseOfDotReadTable; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotReadTable; impl Violation for PandasUseOfDotReadTable { #[derive_message_formats] fn message(&self) -> String { - format!("Use `.read_csv` instead of `.read_table` to read CSV files") + "Use `.read_csv` instead of `.read_table` to read CSV files".to_string() } } /// PD012 -pub(crate) fn use_of_read_table(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn use_of_read_table(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::PANDAS) { return; } @@ -63,8 +63,7 @@ pub(crate) fn use_of_read_table(checker: &mut Checker, call: &ast::ExprCall) { { if value == "," { checker - .diagnostics - .push(Diagnostic::new(PandasUseOfDotReadTable, call.func.range())); + .report_diagnostic(Diagnostic::new(PandasUseOfDotReadTable, call.func.range())); } } } diff --git a/crates/ruff_linter/src/rules/pandas_vet/rules/subscript.rs b/crates/ruff_linter/src/rules/pandas_vet/rules/subscript.rs index 149ffa00a1eef..11fa079ade00a 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/rules/subscript.rs +++ b/crates/ruff_linter/src/rules/pandas_vet/rules/subscript.rs @@ -1,13 +1,14 @@ use ruff_python_ast::{self as ast, Expr}; +use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_diagnostics::{Diagnostic, DiagnosticKind}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::registry::Rule; -use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; +use crate::rules::pandas_vet::helpers::{Resolution, test_expression}; /// ## What it does /// Checks for uses of `.ix` on Pandas objects. @@ -39,13 +40,13 @@ use crate::rules::pandas_vet::helpers::{test_expression, Resolution}; /// - [Pandas release notes: Deprecate `.ix`](https://pandas.pydata.org/pandas-docs/version/0.20/whatsnew.html#deprecate-ix) /// - [Pandas documentation: `loc`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.loc.html) /// - [Pandas documentation: `iloc`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.iloc.html) -#[violation] -pub struct PandasUseOfDotIx; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotIx; impl Violation for PandasUseOfDotIx { #[derive_message_formats] fn message(&self) -> String { - format!("`.ix` is deprecated; use more explicit `.loc` or `.iloc`") + "`.ix` is deprecated; use more explicit `.loc` or `.iloc`".to_string() } } @@ -53,7 +54,7 @@ impl Violation for PandasUseOfDotIx { /// Checks for uses of `.at` on Pandas objects. /// /// ## Why is this bad? -/// The `.at` method selects a single value from a DataFrame or Series based on +/// The `.at` method selects a single value from a `DataFrame` or Series based on /// a label index, and is slightly faster than using `.loc`. However, `.loc` is /// more idiomatic and versatile, as it can be used to select multiple values at /// once. @@ -81,13 +82,13 @@ impl Violation for PandasUseOfDotIx { /// ## References /// - [Pandas documentation: `loc`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.loc.html) /// - [Pandas documentation: `at`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.at.html) -#[violation] -pub struct PandasUseOfDotAt; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotAt; impl Violation for PandasUseOfDotAt { #[derive_message_formats] fn message(&self) -> String { - format!("Use `.loc` instead of `.at`. If speed is important, use NumPy.") + "Use `.loc` instead of `.at`. If speed is important, use NumPy.".to_string() } } @@ -95,7 +96,7 @@ impl Violation for PandasUseOfDotAt { /// Checks for uses of `.iat` on Pandas objects. /// /// ## Why is this bad? -/// The `.iat` method selects a single value from a DataFrame or Series based +/// The `.iat` method selects a single value from a `DataFrame` or Series based /// on an ordinal index, and is slightly faster than using `.iloc`. However, /// `.iloc` is more idiomatic and versatile, as it can be used to select /// multiple values at once. @@ -132,26 +133,36 @@ impl Violation for PandasUseOfDotAt { /// ## References /// - [Pandas documentation: `iloc`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.iloc.html) /// - [Pandas documentation: `iat`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.iat.html) -#[violation] -pub struct PandasUseOfDotIat; +#[derive(ViolationMetadata)] +pub(crate) struct PandasUseOfDotIat; impl Violation for PandasUseOfDotIat { #[derive_message_formats] fn message(&self) -> String { - format!("Use `.iloc` instead of `.iat`. If speed is important, use NumPy.") + "Use `.iloc` instead of `.iat`. If speed is important, use NumPy.".to_string() } } -pub(crate) fn subscript(checker: &mut Checker, value: &Expr, expr: &Expr) { +pub(crate) fn subscript(checker: &Checker, value: &Expr, expr: &Expr) { + if !checker.semantic().seen_module(Modules::PANDAS) { + return; + } + let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = value else { return; }; - let violation: DiagnosticKind = match attr.as_str() { - "ix" if checker.settings.rules.enabled(Rule::PandasUseOfDotIx) => PandasUseOfDotIx.into(), - "at" if checker.settings.rules.enabled(Rule::PandasUseOfDotAt) => PandasUseOfDotAt.into(), + let range = expr.range(); + + let diagnostic = match attr.as_str() { + "ix" if checker.settings.rules.enabled(Rule::PandasUseOfDotIx) => { + Diagnostic::new(PandasUseOfDotIx, range) + } + "at" if checker.settings.rules.enabled(Rule::PandasUseOfDotAt) => { + Diagnostic::new(PandasUseOfDotAt, range) + } "iat" if checker.settings.rules.enabled(Rule::PandasUseOfDotIat) => { - PandasUseOfDotIat.into() + Diagnostic::new(PandasUseOfDotIat, range) } _ => return, }; @@ -165,7 +176,5 @@ pub(crate) fn subscript(checker: &mut Checker, value: &Expr, expr: &Expr) { return; } - checker - .diagnostics - .push(Diagnostic::new(violation, expr.range())); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_PD002.py.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_PD002.py.snap index 4b95a1c29a686..1d9c8f3df547a 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_PD002.py.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_PD002.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs PD002.py:5:23: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | 3 | x = pd.DataFrame() -4 | +4 | 5 | x.drop(["a"], axis=1, inplace=True) | ^^^^^^^^^^^^ PD002 -6 | +6 | 7 | x.y.drop(["a"], axis=1, inplace=True) | = help: Assign to variable; remove `inplace` arg @@ -25,10 +25,10 @@ PD002.py:5:23: PD002 [*] `inplace=True` should be avoided; it has inconsistent b PD002.py:7:25: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | 5 | x.drop(["a"], axis=1, inplace=True) -6 | +6 | 7 | x.y.drop(["a"], axis=1, inplace=True) | ^^^^^^^^^^^^ PD002 -8 | +8 | 9 | x["y"].drop(["a"], axis=1, inplace=True) | = help: Assign to variable; remove `inplace` arg @@ -46,10 +46,10 @@ PD002.py:7:25: PD002 [*] `inplace=True` should be avoided; it has inconsistent b PD002.py:9:28: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | 7 | x.y.drop(["a"], axis=1, inplace=True) - 8 | + 8 | 9 | x["y"].drop(["a"], axis=1, inplace=True) | ^^^^^^^^^^^^ PD002 -10 | +10 | 11 | x.drop( | = help: Assign to variable; remove `inplace` arg @@ -110,7 +110,7 @@ PD002.py:19:9: PD002 [*] `inplace=True` should be avoided; it has inconsistent b PD002.py:24:33: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | 22 | ) -23 | +23 | 24 | x.drop(["a"], axis=1, **kwargs, inplace=True) | ^^^^^^^^^^^^ PD002 25 | x.drop(["a"], axis=1, inplace=True, **kwargs) @@ -143,7 +143,7 @@ PD002.py:26:25: PD002 `inplace=True` should be avoided; it has inconsistent beha 25 | x.drop(["a"], axis=1, inplace=True, **kwargs) 26 | f(x.drop(["a"], axis=1, inplace=True)) | ^^^^^^^^^^^^ PD002 -27 | +27 | 28 | x.apply(lambda x: x.sort_values("a", inplace=True)) | = help: Assign to variable; remove `inplace` arg @@ -151,7 +151,7 @@ PD002.py:26:25: PD002 `inplace=True` should be avoided; it has inconsistent beha PD002.py:28:38: PD002 `inplace=True` should be avoided; it has inconsistent behavior | 26 | f(x.drop(["a"], axis=1, inplace=True)) -27 | +27 | 28 | x.apply(lambda x: x.sort_values("a", inplace=True)) | ^^^^^^^^^^^^ PD002 29 | import torch @@ -161,10 +161,10 @@ PD002.py:28:38: PD002 `inplace=True` should be avoided; it has inconsistent beha PD002.py:33:24: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | 31 | torch.m.ReLU(inplace=True) # safe because this isn't a pandas call -32 | +32 | 33 | (x.drop(["a"], axis=1, inplace=True)) | ^^^^^^^^^^^^ PD002 -34 | +34 | 35 | # This method doesn't take exist in Pandas, so ignore it. | = help: Assign to variable; remove `inplace` arg @@ -178,5 +178,3 @@ PD002.py:33:24: PD002 [*] `inplace=True` should be avoided; it has inconsistent 34 34 | 35 35 | # This method doesn't take exist in Pandas, so ignore it. 36 36 | x.rotate_z(45, inplace=True) - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_fail.snap index f6335bd09177a..bca8d4d4697cb 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:23: PD002 [*] `inplace=True` should be avoided; it has inconsistent behavior | @@ -16,5 +17,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 3 3 | x = pd.DataFrame() 4 |-x.drop(["a"], axis=1, inplace=True) 4 |+x = x.drop(["a"], axis=1) - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD002_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_allows_other_calls.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_allows_other_calls.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_allows_other_calls.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_allows_other_calls.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_fail.snap index 19199f938057d..7026c453c9169 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:3:9: PD003 `.isna` is preferred to `.isnull`; functionality is equivalent | @@ -7,5 +8,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 3 | nulls = pd.isnull(val) | ^^^^^^^^^ PD003 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD003_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_fail.snap index e5ffb845c03dc..41259bba7f5a9 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:3:13: PD004 `.notna` is preferred to `.notnull`; functionality is equivalent | @@ -7,5 +8,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 3 | not_nulls = pd.notnull(val) | ^^^^^^^^^^ PD004 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD004_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_fail.snap index bcbd120c01921..a97967b0811f2 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:5: PD007 `.ix` is deprecated; use more explicit `.loc` or `.iloc` | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 4 | y = x.ix[[0, 2], "A"] | ^^^^^^^^^^^^^^^^^ PD007 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_iloc.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_iloc.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_iloc.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_iloc.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_loc.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_loc.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_loc.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD007_pass_loc.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_fail.snap index 40fae2d6b096e..f82d38b5f4d4d 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:9: PD008 Use `.loc` instead of `.at`. If speed is important, use NumPy. | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 4 | index = x.at[:, ["B", "A"]] | ^^^^^^^^^^^^^^^^^^^ PD008 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass_on_attr.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass_on_attr.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass_on_attr.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD008_pass_on_attr.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_fail.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_fail.snap index 1d6826d2509de..ed47bb5b65d3b 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_fail.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_fail.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:9: PD009 Use `.iloc` instead of `.iat`. If speed is important, use NumPy. | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 4 | index = x.iat[:, 1:3] | ^^^^^^^^^^^^^ PD009 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD009_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_fail_pivot.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_fail_pivot.snap index 894fbee4dc8e3..7b0ac4f67d6b5 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_fail_pivot.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_fail_pivot.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:9: PD010 `.pivot_table` is preferred to `.pivot` or `.unstack`; provides same functionality | @@ -10,5 +11,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 5 | x, 6 | index="foo", | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD010_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_fail_values.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_fail_values.snap index 94dd9fed94555..4fb2da08d632d 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_fail_values.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_fail_values.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:10: PD011 Use `.to_numpy()` instead of `.values` | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 4 | result = x.values | ^^^^^^^^ PD011 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_array.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_array.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_array.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_array.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_node_name.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_node_name.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_node_name.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_node_name.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_to_array.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_to_array.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_to_array.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_to_array.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_call.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_call.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_call.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_call.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_dict.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_dict.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_dict.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_dict.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_import.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_import.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_import.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_import.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_instance.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_instance.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_instance.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_instance.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_store.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_store.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_store.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_store.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_unbound.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_unbound.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_unbound.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD011_pass_values_unbound.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD012_pandas_use_of_dot_read_table.py.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD012_pandas_use_of_dot_read_table.py.snap index a9621cdd857c4..a9f1da574b807 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD012_pandas_use_of_dot_read_table.py.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD012_pandas_use_of_dot_read_table.py.snap @@ -35,8 +35,6 @@ pandas_use_of_dot_read_table.py:8:6: PD012 Use `.read_csv` instead of `.read_tab 7 | df = pd.read_table(filename, sep=",") 8 | df = pd.read_table(filename, sep=",", header=0) | ^^^^^^^^^^^^^ PD012 - 9 | + 9 | 10 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_fail_stack.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_fail_stack.snap index ccf015aa5c839..1d456bb8bd7a7 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_fail_stack.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_fail_stack.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:4:5: PD013 `.melt` is preferred to `.stack`; provides same functionality | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 4 | y = x.stack(level=-1, dropna=True) | ^^^^^^^ PD013 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_numpy.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_numpy.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_numpy.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_numpy.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_unbound.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_unbound.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_unbound.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD013_pass_unbound.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_fail_merge_on_pandas_object.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_fail_merge_on_pandas_object.snap index c8cf3ff541447..76036347016b0 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_fail_merge_on_pandas_object.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_fail_merge_on_pandas_object.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:5:1: PD015 Use `.merge` method instead of `pd.merge` function. They have equivalent functionality. | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 5 | pd.merge(x, y) | ^^^^^^^^ PD015 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe_with_multiple_args.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe_with_multiple_args.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe_with_multiple_args.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_merge_on_dataframe_with_multiple_args.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_other_pd_function.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_other_pd_function.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_other_pd_function.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD015_pass_other_pd_function.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD101_PD101.py.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD101_PD101.py.snap index 5df060ab23472..ec4c1808b5a88 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD101_PD101.py.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD101_PD101.py.snap @@ -115,8 +115,6 @@ PD101.py:18:1: PD101 Using `series.nunique()` for checking that a series is cons 17 | data.dropna().nunique() == 1 18 | data[data.notnull()].nunique() == 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PD101 -19 | +19 | 20 | # No violation of this rule | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_fail_df_var.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_fail_df_var.snap index 51b8ad12d9b08..ac07ab731dc5a 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_fail_df_var.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_fail_df_var.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- <filename>:3:1: PD901 Avoid using the generic variable name `df` for DataFrames | @@ -7,5 +8,3 @@ source: crates/ruff_linter/src/rules/pandas_vet/mod.rs 3 | df = pd.DataFrame() | ^^ PD901 | - - diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_df_param.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_df_param.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_df_param.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_df_param.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_non_df.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_non_df.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_non_df.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_non_df.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_part_df.snap b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_part_df.snap index 07173f8f1bf87..18e7a8619703f 100644 --- a/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_part_df.snap +++ b/crates/ruff_linter/src/rules/pandas_vet/snapshots/ruff_linter__rules__pandas_vet__tests__PD901_pass_part_df.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pandas_vet/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/helpers.rs b/crates/ruff_linter/src/rules/pep8_naming/helpers.rs index 41598653b37a8..5f291697592dd 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/helpers.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/helpers.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::{self as ast, Expr, Stmt}; -use ruff_python_semantic::{analyze, SemanticModel}; +use ruff_python_semantic::{SemanticModel, analyze}; use ruff_python_stdlib::str::{is_cased_lowercase, is_cased_uppercase}; pub(super) fn is_camelcase(name: &str) -> bool { @@ -121,8 +121,8 @@ pub(super) fn is_django_model_import(name: &str, stmt: &Stmt, semantic: &Semanti // Match against, e.g., `apps.get_model("zerver", "Attachment")`. if let Some(unqualified_name) = UnqualifiedName::from_expr(func.as_ref()) { if matches!(unqualified_name.segments(), [.., "get_model"]) { - if let Some(argument) = - arguments.find_argument("model_name", arguments.args.len().saturating_sub(1)) + if let Some(argument) = arguments + .find_argument_value("model_name", arguments.args.len().saturating_sub(1)) { if let Some(string_literal) = argument.as_string_literal_expr() { if string_literal.value.to_str() == name { @@ -141,7 +141,7 @@ pub(super) fn is_django_model_import(name: &str, stmt: &Stmt, semantic: &Semanti qualified_name.segments(), ["django", "utils", "module_loading", "import_string"] ) { - if let Some(argument) = arguments.find_argument("dotted_path", 0) { + if let Some(argument) = arguments.find_argument_value("dotted_path", 0) { if let Some(string_literal) = argument.as_string_literal_expr() { if let Some((.., model)) = string_literal.value.to_str().rsplit_once('.') { if model == name { diff --git a/crates/ruff_linter/src/rules/pep8_naming/mod.rs b/crates/ruff_linter/src/rules/pep8_naming/mod.rs index 12f9c364aac55..8e24e4492afd7 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/mod.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/mod.rs @@ -20,6 +20,7 @@ mod tests { #[test_case(Rule::InvalidClassName, Path::new("N801.py"))] #[test_case(Rule::InvalidFunctionName, Path::new("N802.py"))] #[test_case(Rule::InvalidArgumentName, Path::new("N803.py"))] + #[test_case(Rule::InvalidArgumentName, Path::new("N804.py"))] #[test_case(Rule::InvalidFirstArgumentNameForClassMethod, Path::new("N804.py"))] #[test_case(Rule::InvalidFirstArgumentNameForMethod, Path::new("N805.py"))] #[test_case(Rule::NonLowercaseVariableInFunction, Path::new("N806.py"))] diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs index 0ce8db355371b..6029af4f92020 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_acronym.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Alias, Stmt}; use ruff_python_stdlib::str::{self}; use ruff_text_size::Ranged; @@ -35,12 +35,14 @@ use crate::rules::pep8_naming::helpers; /// from example import MyClassName /// ``` /// -/// [PEP 8]: https://peps.python.org/pep-0008/ -/// /// ## Options /// - `lint.flake8-import-conventions.aliases` -#[violation] -pub struct CamelcaseImportedAsAcronym { +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// +/// [PEP 8]: https://peps.python.org/pep-0008/ +#[derive(ViolationMetadata)] +pub(crate) struct CamelcaseImportedAsAcronym { name: String, asname: String, } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs index f805bd2915e91..afdfbfc30706c 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_constant.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Alias, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_stdlib::str::{self}; use ruff_text_size::Ranged; @@ -30,9 +30,27 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import MyClassName /// ``` /// +/// ## Note +/// Identifiers consisting of a single uppercase character are ambiguous under +/// the rules of [PEP 8], which specifies `CamelCase` for classes and +/// `ALL_CAPS_SNAKE_CASE` for constants. Without a second character, it is not +/// possible to reliably guess whether the identifier is intended to be part +/// of a `CamelCase` string for a class or an `ALL_CAPS_SNAKE_CASE` string for +/// a constant, since both conventions will produce the same output when given +/// a single input character. Therefore, this lint rule does not apply to cases +/// where the alias for the imported identifier consists of a single uppercase +/// character. +/// +/// A common example of a single uppercase character being used for a class +/// name can be found in Django's `django.db.models.Q` class. +/// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ -#[violation] -pub struct CamelcaseImportedAsConstant { +#[derive(ViolationMetadata)] +pub(crate) struct CamelcaseImportedAsConstant { name: String, asname: String, } @@ -53,6 +71,9 @@ pub(crate) fn camelcase_imported_as_constant( stmt: &Stmt, ignore_names: &IgnoreNames, ) -> Option<Diagnostic> { + // Single-character names are ambiguous. It could be a class or a constant. + asname.chars().nth(1)?; + if helpers::is_camelcase(name) && !str::is_cased_lowercase(asname) && str::is_cased_uppercase(asname) diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs index 5a006d6260cc4..f91418315765a 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/camelcase_imported_as_lowercase.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Alias, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::rules::pep8_naming::helpers; @@ -29,9 +29,13 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import MyClassName /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ -#[violation] -pub struct CamelcaseImportedAsLowercase { +#[derive(ViolationMetadata)] +pub(crate) struct CamelcaseImportedAsLowercase { name: String, asname: String, } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs index 0f81043f60200..d4eb7ee32f835 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/constant_imported_as_non_constant.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Alias, Stmt}; use ruff_python_stdlib::str; use ruff_text_size::Ranged; -use crate::rules::pep8_naming::settings::IgnoreNames; +use crate::rules::pep8_naming::{helpers, settings::IgnoreNames}; /// ## What it does /// Checks for constant imports that are aliased to non-constant-style @@ -29,9 +29,26 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import CONSTANT_VALUE /// ``` /// +/// ## Note +/// Identifiers consisting of a single uppercase character are ambiguous under +/// the rules of [PEP 8], which specifies `CamelCase` for classes and +/// `ALL_CAPS_SNAKE_CASE` for constants. Without a second character, it is not +/// possible to reliably guess whether the identifier is intended to be part +/// of a `CamelCase` string for a class or an `ALL_CAPS_SNAKE_CASE` string for +/// a constant, since both conventions will produce the same output when given +/// a single input character. Therefore, this lint rule does not apply to cases +/// where the imported identifier consists of a single uppercase character. +/// +/// A common example of a single uppercase character being used for a class +/// name can be found in Django's `django.db.models.Q` class. +/// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ -#[violation] -pub struct ConstantImportedAsNonConstant { +#[derive(ViolationMetadata)] +pub(crate) struct ConstantImportedAsNonConstant { name: String, asname: String, } @@ -52,7 +69,13 @@ pub(crate) fn constant_imported_as_non_constant( stmt: &Stmt, ignore_names: &IgnoreNames, ) -> Option<Diagnostic> { - if str::is_cased_uppercase(name) && !str::is_cased_uppercase(asname) { + if str::is_cased_uppercase(name) + && !(str::is_cased_uppercase(asname) + // Single-character names are ambiguous. + // It could be a class or a constant, so allow it to be imported + // as `SCREAMING_SNAKE_CASE` *or* `CamelCase`. + || (name.chars().nth(1).is_none() && helpers::is_camelcase(asname))) + { // Ignore any explicitly-allowed names. if ignore_names.matches(name) || ignore_names.matches(asname) { return None; diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs index 5fd7846ccb067..37748188fd895 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/dunder_function_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility; use ruff_python_semantic::{Scope, ScopeKind}; @@ -31,14 +31,18 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ -#[violation] -pub struct DunderFunctionName; +#[derive(ViolationMetadata)] +pub(crate) struct DunderFunctionName; impl Violation for DunderFunctionName { #[derive_message_formats] fn message(&self) -> String { - format!("Function name should not start and end with `__`") + "Function name should not start and end with `__`".to_string() } } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs index 5cab715917152..52b46b46363f7 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/error_suffix_on_exception_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Arguments, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use crate::rules::pep8_naming::settings::IgnoreNames; @@ -28,9 +28,13 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// class ValidationError(Exception): ... /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#exception-names -#[violation] -pub struct ErrorSuffixOnExceptionName { +#[derive(ViolationMetadata)] +pub(crate) struct ErrorSuffixOnExceptionName { name: String, } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs index 5856a03f4ecb7..31b5fe7195240 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_argument_name.rs @@ -1,11 +1,12 @@ -use ruff_python_ast::Parameter; - use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ExprLambda, Parameters, StmtFunctionDef}; +use ruff_python_semantic::ScopeKind; +use ruff_python_semantic::analyze::visibility::is_override; use ruff_python_stdlib::str; use ruff_text_size::Ranged; -use crate::rules::pep8_naming::settings::IgnoreNames; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for argument names that do not follow the `snake_case` convention. @@ -15,12 +16,14 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// by underscores (also known as `snake_case`). /// /// > Function names should be lowercase, with words separated by underscores -/// as necessary to improve readability. +/// > as necessary to improve readability. /// > /// > Variable names follow the same convention as function names. /// > /// > mixedCase is allowed only in contexts where that’s already the -/// prevailing style (e.g. threading.py), to retain backwards compatibility. +/// > prevailing style (e.g. threading.py), to retain backwards compatibility. +/// +/// Methods decorated with `@typing.override` are ignored. /// /// ## Example /// ```python @@ -34,9 +37,14 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments -#[violation] -pub struct InvalidArgumentName { +/// [preview]: https://docs.astral.sh/ruff/preview/ +#[derive(ViolationMetadata)] +pub(crate) struct InvalidArgumentName { name: String, } @@ -49,22 +57,50 @@ impl Violation for InvalidArgumentName { } /// N803 -pub(crate) fn invalid_argument_name( - name: &str, - parameter: &Parameter, - ignore_names: &IgnoreNames, -) -> Option<Diagnostic> { - if !str::is_lowercase(name) { - // Ignore any explicitly-allowed names. +pub(crate) fn invalid_argument_name_function(checker: &Checker, function_def: &StmtFunctionDef) { + let semantic = checker.semantic(); + let scope = semantic.current_scope(); + + if matches!(scope.kind, ScopeKind::Class(_)) + && is_override(&function_def.decorator_list, semantic) + { + return; + } + + invalid_argument_name(checker, &function_def.parameters); +} + +/// N803 +pub(crate) fn invalid_argument_name_lambda(checker: &Checker, lambda: &ExprLambda) { + let Some(parameters) = &lambda.parameters else { + return; + }; + + invalid_argument_name(checker, parameters); +} + +/// N803 +fn invalid_argument_name(checker: &Checker, parameters: &Parameters) { + let ignore_names = &checker.settings.pep8_naming.ignore_names; + + for parameter in parameters { + let name = parameter.name().as_str(); + + if str::is_lowercase(name) { + continue; + } + if ignore_names.matches(name) { - return None; + continue; } - return Some(Diagnostic::new( + + let diagnostic = Diagnostic::new( InvalidArgumentName { name: name.to_string(), }, parameter.range(), - )); + ); + + checker.report_diagnostic(diagnostic); } - None } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs index edcccf663d98b..5db5bf0942a4c 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_class_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use crate::rules::pep8_naming::settings::IgnoreNames; @@ -34,9 +34,13 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// pass /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#class-names -#[violation] -pub struct InvalidClassName { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidClassName { name: String, } @@ -54,7 +58,7 @@ pub(crate) fn invalid_class_name( name: &str, ignore_names: &IgnoreNames, ) -> Option<Diagnostic> { - let stripped = name.strip_prefix('_').unwrap_or(name); + let stripped = name.trim_start_matches('_'); if !stripped.chars().next().is_some_and(char::is_uppercase) || stripped.contains('_') { // Ignore any explicitly-allowed names. if ignore_names.matches(name) { diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name.rs index 5f5cefadf4d46..e8f42a91903e1 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_first_argument_name.rs @@ -1,14 +1,14 @@ use anyhow::Result; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Fix, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Fix, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::ParameterWithDefault; use ruff_python_codegen::Stylist; -use ruff_python_semantic::analyze::class::is_metaclass; +use ruff_python_semantic::analyze::class::{IsMetaclass, is_metaclass}; use ruff_python_semantic::analyze::function_type; use ruff_python_semantic::{Scope, ScopeKind, SemanticModel}; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::registry::Rule; @@ -58,8 +58,8 @@ use crate::renamer::Renamer; /// - `lint.pep8-naming.extend-ignore-names` /// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments -#[violation] -pub struct InvalidFirstArgumentNameForMethod { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidFirstArgumentNameForMethod { argument_name: String, } @@ -69,7 +69,7 @@ impl Violation for InvalidFirstArgumentNameForMethod { #[derive_message_formats] fn message(&self) -> String { - format!("First argument of a method should be named `self`") + "First argument of a method should be named `self`".to_string() } fn fix_title(&self) -> Option<String> { @@ -82,6 +82,10 @@ impl Violation for InvalidFirstArgumentNameForMethod { /// Checks for class methods that use a name other than `cls` for their /// first argument. /// +/// The method `__new__` is exempted from this +/// check and the corresponding violation is caught by +/// [`bad-staticmethod-argument`][PLW0211]. +/// /// ## Why is this bad? /// [PEP 8] recommends the use of `cls` as the first argument for all class /// methods: @@ -124,9 +128,12 @@ impl Violation for InvalidFirstArgumentNameForMethod { /// - `lint.pep8-naming.extend-ignore-names` /// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments -#[violation] -pub struct InvalidFirstArgumentNameForClassMethod { +/// [PLW0211]: https://docs.astral.sh/ruff/rules/bad-staticmethod-argument/ +#[derive(ViolationMetadata)] +pub(crate) struct InvalidFirstArgumentNameForClassMethod { argument_name: String, + // Whether the method is `__new__` + is_new: bool, } impl Violation for InvalidFirstArgumentNameForClassMethod { @@ -134,12 +141,19 @@ impl Violation for InvalidFirstArgumentNameForClassMethod { ruff_diagnostics::FixAvailability::Sometimes; #[derive_message_formats] + // The first string below is what shows up in the documentation + // in the rule table, and it is the more common case. + #[expect(clippy::if_not_else)] fn message(&self) -> String { - format!("First argument of a class method should be named `cls`") + if !self.is_new { + "First argument of a class method should be named `cls`".to_string() + } else { + "First argument of `__new__` method should be named `cls`".to_string() + } } fn fix_title(&self) -> Option<String> { - let Self { argument_name } = self; + let Self { argument_name, .. } = self; Some(format!("Rename `{argument_name}` to `cls`")) } } @@ -153,10 +167,18 @@ enum FunctionType { } impl FunctionType { - fn diagnostic_kind(self, argument_name: String) -> DiagnosticKind { + fn diagnostic_kind(self, argument_name: String, range: TextRange) -> Diagnostic { match self { - Self::Method => InvalidFirstArgumentNameForMethod { argument_name }.into(), - Self::ClassMethod => InvalidFirstArgumentNameForClassMethod { argument_name }.into(), + Self::Method => { + Diagnostic::new(InvalidFirstArgumentNameForMethod { argument_name }, range) + } + Self::ClassMethod => Diagnostic::new( + InvalidFirstArgumentNameForClassMethod { + argument_name, + is_new: false, + }, + range, + ), } } @@ -176,11 +198,7 @@ impl FunctionType { } /// N804, N805 -pub(crate) fn invalid_first_argument_name( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn invalid_first_argument_name(checker: &Checker, scope: &Scope) { let ScopeKind::Function(ast::StmtFunctionDef { name, parameters, @@ -212,14 +230,16 @@ pub(crate) fn invalid_first_argument_name( function_type::FunctionType::Function | function_type::FunctionType::StaticMethod => { return; } - function_type::FunctionType::Method => { - if is_metaclass(parent, semantic) { - FunctionType::ClassMethod - } else { - FunctionType::Method - } - } + function_type::FunctionType::Method => match is_metaclass(parent, semantic) { + IsMetaclass::Yes => FunctionType::ClassMethod, + IsMetaclass::No => FunctionType::Method, + IsMetaclass::Maybe => return, + }, function_type::FunctionType::ClassMethod => FunctionType::ClassMethod, + // This violation is caught by `PLW0211` instead + function_type::FunctionType::NewMethod => { + return; + } }; if !checker.enabled(function_type.rule()) { return; @@ -246,10 +266,8 @@ pub(crate) fn invalid_first_argument_name( return; } - let mut diagnostic = Diagnostic::new( - function_type.diagnostic_kind(self_or_cls.name.to_string()), - self_or_cls.range(), - ); + let mut diagnostic = + function_type.diagnostic_kind(self_or_cls.name.to_string(), self_or_cls.range()); diagnostic.try_set_optional_fix(|| { rename_parameter( scope, @@ -260,7 +278,7 @@ pub(crate) fn invalid_first_argument_name( checker.stylist(), ) }); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Rename the first parameter to `self` or `cls`, if no other parameter has the target name. diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_function_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_function_name.rs index 0a10458f6d42f..d50b9866349ed 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_function_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_function_name.rs @@ -1,10 +1,10 @@ use ruff_python_ast::{Decorator, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; -use ruff_python_semantic::analyze::visibility; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::visibility; use ruff_python_stdlib::str; use crate::rules::pep8_naming::settings::IgnoreNames; @@ -42,8 +42,8 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// - `lint.pep8-naming.extend-ignore-names` /// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-variable-names -#[violation] -pub struct InvalidFunctionName { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidFunctionName { name: String, } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_module_name.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_module_name.rs index d525aa1d629cb..ccf651b723210 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_module_name.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/invalid_module_name.rs @@ -1,15 +1,15 @@ use std::ffi::OsStr; use std::path::Path; +use crate::package::PackageRoot; +use crate::rules::pep8_naming::settings::IgnoreNames; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::PySourceType; use ruff_python_stdlib::identifiers::{is_migration_name, is_module_name}; use ruff_python_stdlib::path::is_module_file; use ruff_text_size::TextRange; -use crate::rules::pep8_naming::settings::IgnoreNames; - /// ## What it does /// Checks for module names that do not follow the `snake_case` naming /// convention or are otherwise invalid. @@ -35,8 +35,8 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// - Instead of `ExampleModule`, use `example_module`. /// /// [PEP 8]: https://peps.python.org/pep-0008/#package-and-module-names -#[violation] -pub struct InvalidModuleName { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidModuleName { name: String, } @@ -51,7 +51,7 @@ impl Violation for InvalidModuleName { /// N999 pub(crate) fn invalid_module_name( path: &Path, - package: Option<&Path>, + package: Option<PackageRoot<'_>>, ignore_names: &IgnoreNames, ) -> Option<Diagnostic> { if !PySourceType::try_from_path(path).is_some_and(PySourceType::is_py_file_or_stub) { @@ -60,7 +60,7 @@ pub(crate) fn invalid_module_name( if let Some(package) = package { let module_name = if is_module_file(path) { - package.file_name().unwrap().to_string_lossy() + package.path().file_name().unwrap().to_string_lossy() } else { path.file_stem().unwrap().to_string_lossy() }; diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs index 097e0f394896f..d1372dfe0329e 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/lowercase_imported_as_non_lowercase.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Alias, Stmt}; use ruff_python_stdlib::str; use ruff_text_size::Ranged; @@ -28,9 +28,13 @@ use crate::rules::pep8_naming::settings::IgnoreNames; /// from example import myclassname /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/ -#[violation] -pub struct LowercaseImportedAsNonLowercase { +#[derive(ViolationMetadata)] +pub(crate) struct LowercaseImportedAsNonLowercase { name: String, asname: String, } diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs index 15b11ac894bd1..a1ebfac616179 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_class_scope.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -14,12 +14,12 @@ use crate::rules::pep8_naming::helpers; /// by underscores (also known as `snake_case`). /// /// > Function names should be lowercase, with words separated by underscores -/// as necessary to improve readability. +/// > as necessary to improve readability. /// > /// > Variable names follow the same convention as function names. /// > /// > mixedCase is allowed only in contexts where that’s already the -/// prevailing style (e.g. threading.py), to retain backwards compatibility. +/// > prevailing style (e.g. threading.py), to retain backwards compatibility. /// /// ## Example /// ```python @@ -35,9 +35,13 @@ use crate::rules::pep8_naming::helpers; /// another_variable = "world" /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments -#[violation] -pub struct MixedCaseVariableInClassScope { +#[derive(ViolationMetadata)] +pub(crate) struct MixedCaseVariableInClassScope { name: String, } @@ -51,7 +55,7 @@ impl Violation for MixedCaseVariableInClassScope { /// N815 pub(crate) fn mixed_case_variable_in_class_scope( - checker: &mut Checker, + checker: &Checker, expr: &Expr, name: &str, class_def: &ast::StmtClassDef, @@ -72,7 +76,7 @@ pub(crate) fn mixed_case_variable_in_class_scope( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( MixedCaseVariableInClassScope { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs index 383e7c260831a..fa2ee853ad722 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/mixed_case_variable_in_global_scope.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -16,21 +16,21 @@ use crate::rules::pep8_naming::helpers; /// /// > ### Global Variable Names /// > (Let’s hope that these variables are meant for use inside one module -/// only.) The conventions are about the same as those for functions. +/// > only.) The conventions are about the same as those for functions. /// > /// > Modules that are designed for use via from M import * should use the -/// __all__ mechanism to prevent exporting globals, or use the older -/// convention of prefixing such globals with an underscore (which you might -/// want to do to indicate these globals are “module non-public”). +/// > __all__ mechanism to prevent exporting globals, or use the older +/// > convention of prefixing such globals with an underscore (which you might +/// > want to do to indicate these globals are “module non-public”). /// > /// > ### Function and Variable Names /// > Function names should be lowercase, with words separated by underscores -/// as necessary to improve readability. +/// > as necessary to improve readability. /// > /// > Variable names follow the same convention as function names. /// > /// > mixedCase is allowed only in contexts where that’s already the prevailing -/// style (e.g. threading.py), to retain backwards compatibility. +/// > style (e.g. threading.py), to retain backwards compatibility. /// /// ## Example /// ```python @@ -46,9 +46,13 @@ use crate::rules::pep8_naming::helpers; /// yet_another_variable = "foo" /// ``` /// +/// ## Options +/// - `lint.pep8-naming.ignore-names` +/// - `lint.pep8-naming.extend-ignore-names` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#global-variable-names -#[violation] -pub struct MixedCaseVariableInGlobalScope { +#[derive(ViolationMetadata)] +pub(crate) struct MixedCaseVariableInGlobalScope { name: String, } @@ -61,7 +65,7 @@ impl Violation for MixedCaseVariableInGlobalScope { } /// N816 -pub(crate) fn mixed_case_variable_in_global_scope(checker: &mut Checker, expr: &Expr, name: &str) { +pub(crate) fn mixed_case_variable_in_global_scope(checker: &Checker, expr: &Expr, name: &str) { if !helpers::is_mixed_case(name) { return; } @@ -75,7 +79,7 @@ pub(crate) fn mixed_case_variable_in_global_scope(checker: &mut Checker, expr: & return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( MixedCaseVariableInGlobalScope { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pep8_naming/rules/non_lowercase_variable_in_function.rs b/crates/ruff_linter/src/rules/pep8_naming/rules/non_lowercase_variable_in_function.rs index be992b13af8ec..a0c495be275d3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/rules/non_lowercase_variable_in_function.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/rules/non_lowercase_variable_in_function.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_stdlib::str; use ruff_text_size::Ranged; @@ -38,8 +38,8 @@ use crate::rules::pep8_naming::helpers; /// - `lint.pep8-naming.extend-ignore-names` /// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-variable-names -#[violation] -pub struct NonLowercaseVariableInFunction { +#[derive(ViolationMetadata)] +pub(crate) struct NonLowercaseVariableInFunction { name: String, } @@ -52,7 +52,7 @@ impl Violation for NonLowercaseVariableInFunction { } /// N806 -pub(crate) fn non_lowercase_variable_in_function(checker: &mut Checker, expr: &Expr, name: &str) { +pub(crate) fn non_lowercase_variable_in_function(checker: &Checker, expr: &Expr, name: &str) { if str::is_lowercase(name) { return; } @@ -81,7 +81,7 @@ pub(crate) fn non_lowercase_variable_in_function(checker: &mut Checker, expr: &E return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonLowercaseVariableInFunction { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pep8_naming/settings.rs b/crates/ruff_linter/src/rules/pep8_naming/settings.rs index 9705b7cde05d5..accac6ef6cd5c 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/settings.rs +++ b/crates/ruff_linter/src/rules/pep8_naming/settings.rs @@ -102,7 +102,7 @@ impl IgnoreNames { ) -> Result<Self, SettingsError> { // If the user is not customizing the set of ignored names, use the default matcher, // which is hard-coded to avoid expensive regex matching. - if ignore_names.is_none() && extend_ignore_names.as_ref().map_or(true, Vec::is_empty) { + if ignore_names.is_none() && extend_ignore_names.as_ref().is_none_or(Vec::is_empty) { return Ok(IgnoreNames::Default); } diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N801_N801.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N801_N801.py.snap index 976d069204601..e24976a5fa91e 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N801_N801.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N801_N801.py.snap @@ -15,23 +15,41 @@ N801.py:5:7: N801 Class name `_bad` should use CapWords convention 6 | pass | -N801.py:9:7: N801 Class name `bad_class` should use CapWords convention +N801.py:9:7: N801 Class name `__bad` should use CapWords convention | - 9 | class bad_class: - | ^^^^^^^^^ N801 + 9 | class __bad: + | ^^^^^ N801 10 | pass | -N801.py:13:7: N801 Class name `Bad_Class` should use CapWords convention +N801.py:13:7: N801 Class name `bad_class` should use CapWords convention | -13 | class Bad_Class: +13 | class bad_class: | ^^^^^^^^^ N801 14 | pass | -N801.py:17:7: N801 Class name `BAD_CLASS` should use CapWords convention +N801.py:17:7: N801 Class name `Bad_Class` should use CapWords convention | -17 | class BAD_CLASS: +17 | class Bad_Class: | ^^^^^^^^^ N801 18 | pass | + +N801.py:20:7: N801 Class name `Bad__Class` should use CapWords convention + | +18 | pass +19 | +20 | class Bad__Class: + | ^^^^^^^^^^ N801 +21 | pass + | + +N801.py:23:7: N801 Class name `BAD_CLASS` should use CapWords convention + | +21 | pass +22 | +23 | class BAD_CLASS: + | ^^^^^^^^^ N801 +24 | pass + | diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N802_N802.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N802_N802.py.snap index 7e901545aa39c..f2e5311d5e39f 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N802_N802.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N802_N802.py.snap @@ -32,10 +32,8 @@ N802.py:16:5: N802 Function name `BAD_FUNC` should be lowercase N802.py:40:9: N802 Function name `testTest` should be lowercase | 38 | return super().tearDown() -39 | +39 | 40 | def testTest(self): | ^^^^^^^^ N802 41 | assert True | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N803.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N803.py.snap index cf7c5170e8f5a..d8f2c61cd671a 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N803.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N803.py.snap @@ -16,4 +16,22 @@ N803.py:6:28: N803 Argument name `A` should be lowercase 7 | return _, a, A | +N803.py:22:16: N803 Argument name `A` should be lowercase + | +21 | @override # Incorrect usage +22 | def func(_, a, A): ... + | ^ N803 + | +N803.py:25:21: N803 Argument name `A` should be lowercase + | +25 | func = lambda _, a, A: ... + | ^ N803 + | + +N803.py:29:42: N803 Argument name `A` should be lowercase + | +28 | class Extended(Class): +29 | method = override(lambda self, _, a, A: ...) # Incorrect usage + | ^ N803 + | diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N804.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N804.py.snap new file mode 100644 index 0000000000000..719c39c477ca1 --- /dev/null +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N803_N804.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N804_N804.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N804_N804.py.snap index ae7c7a8bc9c07..140631d9ff4c2 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N804_N804.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N804_N804.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N804.py:30:27: N804 [*] First argument of a class method should be named `cls` | 28 | ... -29 | +29 | 30 | def __init_subclass__(self, default_name, **kwargs): | ^^^^ N804 31 | ... @@ -71,7 +71,7 @@ N804.py:54:25: N804 First argument of a class method should be named `cls` N804.py:57:34: N804 First argument of a class method should be named `cls` | 55 | pass -56 | +56 | 57 | def cls_as_pos_only_argument(this, cls, /): | ^^^^ N804 58 | pass @@ -81,7 +81,7 @@ N804.py:57:34: N804 First argument of a class method should be named `cls` N804.py:60:33: N804 First argument of a class method should be named `cls` | 58 | pass -59 | +59 | 60 | def cls_as_kw_only_argument(this, *, cls): | ^^^^ N804 61 | pass @@ -91,7 +91,7 @@ N804.py:60:33: N804 First argument of a class method should be named `cls` N804.py:63:23: N804 First argument of a class method should be named `cls` | 61 | pass -62 | +62 | 63 | def cls_as_varags(this, *cls): | ^^^^ N804 64 | pass @@ -101,7 +101,7 @@ N804.py:63:23: N804 First argument of a class method should be named `cls` N804.py:66:23: N804 First argument of a class method should be named `cls` | 64 | pass -65 | +65 | 66 | def cls_as_kwargs(this, **cls): | ^^^^ N804 67 | pass @@ -135,7 +135,7 @@ N804.py:70:20: N804 [*] First argument of a class method should be named `cls` N804.py:74:20: N804 [*] First argument of a class method should be named `cls` | 72 | this -73 | +73 | 74 | def bad_method(this): | ^^^^ N804 75 | self = this diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N805_N805.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N805_N805.py.snap index da5c1b1686b17..89d578bc7f186 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N805_N805.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N805_N805.py.snap @@ -80,7 +80,7 @@ N805.py:34:15: N805 [*] First argument of a method should be named `self` N805.py:63:29: N805 [*] First argument of a method should be named `self` | 61 | pass -62 | +62 | 63 | def bad_method_pos_only(this, blah, /, something: str): | ^^^^ N805 64 | pass @@ -186,7 +186,7 @@ N805.py:98:26: N805 First argument of a method should be named `self` N805.py:101:35: N805 First argument of a method should be named `self` | 99 | pass -100 | +100 | 101 | def self_as_pos_only_argument(this, self, /): | ^^^^ N805 102 | pass @@ -196,7 +196,7 @@ N805.py:101:35: N805 First argument of a method should be named `self` N805.py:104:34: N805 First argument of a method should be named `self` | 102 | pass -103 | +103 | 104 | def self_as_kw_only_argument(this, *, self): | ^^^^ N805 105 | pass @@ -206,7 +206,7 @@ N805.py:104:34: N805 First argument of a method should be named `self` N805.py:107:24: N805 First argument of a method should be named `self` | 105 | pass -106 | +106 | 107 | def self_as_varags(this, *self): | ^^^^ N805 108 | pass @@ -216,7 +216,7 @@ N805.py:107:24: N805 First argument of a method should be named `self` N805.py:110:24: N805 First argument of a method should be named `self` | 108 | pass -109 | +109 | 110 | def self_as_kwargs(this, **self): | ^^^^ N805 111 | pass @@ -250,7 +250,7 @@ N805.py:115:20: N805 [*] First argument of a method should be named `self` N805.py:119:20: N805 [*] First argument of a method should be named `self` | 117 | this -118 | +118 | 119 | def bad_method(this): | ^^^^ N805 120 | self = this diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N806_N806.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N806_N806.py.snap index 1baa39c61040b..1dbb26dd54d28 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N806_N806.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N806_N806.py.snap @@ -32,7 +32,7 @@ N806.py:46:5: N806 Variable `Bad` in function should be lowercase N806.py:53:5: N806 Variable `Bad` in function should be lowercase | 51 | from django.utils.module_loading import import_string -52 | +52 | 53 | Bad = import_string("django.core.exceptions.ValidationError") # N806 | ^^^ N806 54 | ValidationError = import_string("django.core.exceptions.ValidationError") # OK @@ -41,7 +41,7 @@ N806.py:53:5: N806 Variable `Bad` in function should be lowercase N806.py:56:5: N806 Variable `Bad` in function should be lowercase | 54 | ValidationError = import_string("django.core.exceptions.ValidationError") # OK -55 | +55 | 56 | Bad = apps.get_model() # N806 | ^^^ N806 57 | Bad = apps.get_model(model_name="Stream") # N806 @@ -52,7 +52,7 @@ N806.py:57:5: N806 Variable `Bad` in function should be lowercase 56 | Bad = apps.get_model() # N806 57 | Bad = apps.get_model(model_name="Stream") # N806 | ^^^ N806 -58 | +58 | 59 | Address: Type = apps.get_model("zerver", variable) # OK | @@ -62,5 +62,3 @@ N806.py:60:5: N806 Variable `ValidationError` in function should be lowercase 60 | ValidationError = import_string(variable) # N806 | ^^^^^^^^^^^^^^^ N806 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N807_N807.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N807_N807.py.snap index a1fa93b9837c7..e6b7da8dbe052 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N807_N807.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N807_N807.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N807.py:1:5: N807 Function name should not start and end with `__` | @@ -15,5 +16,3 @@ N807.py:14:9: N807 Function name should not start and end with `__` | ^^^^^^^ N807 15 | pass | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N811_N811.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N811_N811.py.snap index 0221ec269ab88..c874ee2ad88e6 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N811_N811.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N811_N811.py.snap @@ -15,6 +15,7 @@ N811.py:2:17: N811 Constant `CONSTANT` imported as non-constant `constant` 2 | from mod import CONSTANT as constant | ^^^^^^^^^^^^^^^^^^^^ N811 3 | from mod import ANOTHER_CONSTANT as another_constant +4 | import mod.CON as c | N811.py:3:17: N811 Constant `ANOTHER_CONSTANT` imported as non-constant `another_constant` @@ -23,6 +24,25 @@ N811.py:3:17: N811 Constant `ANOTHER_CONSTANT` imported as non-constant `another 2 | from mod import CONSTANT as constant 3 | from mod import ANOTHER_CONSTANT as another_constant | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ N811 +4 | import mod.CON as c +5 | from mod import C as c | +N811.py:4:8: N811 Constant `CON` imported as non-constant `c` + | +2 | from mod import CONSTANT as constant +3 | from mod import ANOTHER_CONSTANT as another_constant +4 | import mod.CON as c + | ^^^^^^^^^^^^ N811 +5 | from mod import C as c + | +N811.py:5:17: N811 Constant `C` imported as non-constant `c` + | +3 | from mod import ANOTHER_CONSTANT as another_constant +4 | import mod.CON as c +5 | from mod import C as c + | ^^^^^^ N811 +6 | +7 | # These are all OK: + | diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N812_N812.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N812_N812.py.snap index 2efc0a3344e8d..3c82aa516722e 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N812_N812.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N812_N812.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N812.py:1:8: N812 Lowercase `lowercase` imported as non-lowercase `Lower` | @@ -24,5 +25,3 @@ N812.py:3:17: N812 Lowercase `another_lowercase` imported as non-lowercase `Anot 3 | from mod import another_lowercase as AnotherLowercase | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ N812 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N813_N813.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N813_N813.py.snap index d054e25e0edd2..b98af29bf0d82 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N813_N813.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N813_N813.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N813.py:1:8: N813 Camelcase `Camel` imported as lowercase `camel` | @@ -24,5 +25,3 @@ N813.py:3:17: N813 Camelcase `AnotherCamelCase` imported as lowercase `another_c 3 | from mod import AnotherCamelCase as another_camelcase | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ N813 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N814_N814.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N814_N814.py.snap index 30aef08f54aa8..ab73bb36f1836 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N814_N814.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N814_N814.py.snap @@ -23,6 +23,6 @@ N814.py:3:17: N814 Camelcase `AnotherCamelCase` imported as constant `ANOTHER_CA 2 | from mod import CamelCase as CAMELCASE 3 | from mod import AnotherCamelCase as ANOTHER_CAMELCASE | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ N814 +4 | +5 | # These are all OK: | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N815_N815.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N815_N815.py.snap index d507e8d1ca31f..1add3629579ca 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N815_N815.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N815_N815.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N815.py:9:5: N815 Variable `mixedCase` in class scope should not be mixedCase | @@ -30,5 +31,3 @@ N815.py:11:5: N815 Variable `mixed_Case` in class scope should not be mixedCase 12 | myObj1 = collections.namedtuple("MyObj1", ["a", "b"]) 13 | myObj2 = namedtuple("MyObj2", ["a", "b"]) | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N816_N816.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N816_N816.py.snap index 03281db7aca58..3f49a15856fc1 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N816_N816.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N816_N816.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N816.py:7:1: N816 Variable `mixedCase` in global scope should not be mixedCase | @@ -30,5 +31,3 @@ N816.py:9:1: N816 Variable `mixed_Case` in global scope should not be mixedCase 10 | myObj1 = collections.namedtuple("MyObj1", ["a", "b"]) 11 | myObj2 = namedtuple("MyObj2", ["a", "b"]) | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N817_N817.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N817_N817.py.snap index 63fa4b0f165ac..5d2eee85fe453 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N817_N817.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N817_N817.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N817.py:1:8: N817 CamelCase `CaMel` imported as acronym `CM` | diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N818_N818.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N818_N818.py.snap index 0ed5704b28c34..ce8fa628122a2 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N818_N818.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N818_N818.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- N818.py:9:7: N818 Exception name `C` should be named with an Error suffix | @@ -14,5 +15,3 @@ N818.py:17:7: N818 Exception name `E` should be named with an Error suffix | ^ N818 18 | pass | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE____init__.py.snap index d1796d8cb20cb..6bd42f3740e45 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- __init__.py:1:1: N999 Invalid module name: 'MODULE' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE__file.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE__file.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE__file.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__MODULE__file.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__flake9____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__flake9____init__.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__flake9____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__flake9____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__0001_initial.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__0001_initial.py.snap index b173f1cdd9bc3..84b2c0d8c4606 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__0001_initial.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__0001_initial.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- 0001_initial.py:1:1: N999 Invalid module name: '0001_initial' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__import.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__import.py.snap index ba4c79f6d565a..6515383d63d39 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__import.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__invalid_name__import.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- import.py:1:1: N999 Invalid module name: 'import' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces____init__.py.snap index 9a3176db8085a..b0c2fe5f67d16 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- __init__.py:1:1: N999 Invalid module name: 'mod with spaces' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces__file.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces__file.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces__file.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod with spaces__file.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod-with-dashes____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod-with-dashes____init__.py.snap index f9bd14831bf9f..2a8ef3bd532a2 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod-with-dashes____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__mod-with-dashes____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- __init__.py:1:1: N999 Invalid module name: 'mod-with-dashes' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__no_module__test.txt.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__no_module__test.txt.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__no_module__test.txt.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__no_module__test.txt.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____init__.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____main__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____main__.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____main__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____main__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____setup__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____setup__.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____setup__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name____setup__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.py.snap index 06a6465c6195d..85da15535d404 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- file-with-dashes.py:1:1: N999 Invalid module name: 'file-with-dashes' diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__N999_N999__module__valid_name__file-with-dashes.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__camelcase_imported_as_incorrect_convention.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__camelcase_imported_as_incorrect_convention.snap index 9eb17d9ae9c51..dfcf9d31f56f3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__camelcase_imported_as_incorrect_convention.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__camelcase_imported_as_incorrect_convention.snap @@ -29,7 +29,7 @@ N817.py:7:23: N817 CamelCase `ElementTree` imported as acronym `ET` 6 | import xml.etree.ElementTree as ET 7 | from xml.etree import ElementTree as ET | ^^^^^^^^^^^^^^^^^ N817 -8 | +8 | 9 | # Always an error (relative import) | diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__classmethod_decorators.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__classmethod_decorators.snap index b631ea179217b..6d28da75c6806 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__classmethod_decorators.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__classmethod_decorators.snap @@ -42,7 +42,7 @@ N805.py:11:30: N805 [*] First argument of a method should be named `self` N805.py:63:29: N805 [*] First argument of a method should be named `self` | 61 | pass -62 | +62 | 63 | def bad_method_pos_only(this, blah, /, something: str): | ^^^^ N805 64 | pass @@ -129,7 +129,7 @@ N805.py:98:26: N805 First argument of a method should be named `self` N805.py:101:35: N805 First argument of a method should be named `self` | 99 | pass -100 | +100 | 101 | def self_as_pos_only_argument(this, self, /): | ^^^^ N805 102 | pass @@ -139,7 +139,7 @@ N805.py:101:35: N805 First argument of a method should be named `self` N805.py:104:34: N805 First argument of a method should be named `self` | 102 | pass -103 | +103 | 104 | def self_as_kw_only_argument(this, *, self): | ^^^^ N805 105 | pass @@ -149,7 +149,7 @@ N805.py:104:34: N805 First argument of a method should be named `self` N805.py:107:24: N805 First argument of a method should be named `self` | 105 | pass -106 | +106 | 107 | def self_as_varags(this, *self): | ^^^^ N805 108 | pass @@ -159,7 +159,7 @@ N805.py:107:24: N805 First argument of a method should be named `self` N805.py:110:24: N805 First argument of a method should be named `self` | 108 | pass -109 | +109 | 110 | def self_as_kwargs(this, **self): | ^^^^ N805 111 | pass @@ -193,7 +193,7 @@ N805.py:115:20: N805 [*] First argument of a method should be named `self` N805.py:119:20: N805 [*] First argument of a method should be named `self` | 117 | this -118 | +118 | 119 | def bad_method(this): | ^^^^ N805 120 | self = this diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N801_N801.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N801_N801.py.snap index 9a910411def50..24d123032c205 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N801_N801.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N801_N801.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N801.py:4:7: N801 Class name `stillBad` should use CapWords convention | 2 | pass -3 | +3 | 4 | class stillBad: | ^^^^^^^^ N801 5 | pass @@ -13,7 +13,7 @@ N801.py:4:7: N801 Class name `stillBad` should use CapWords convention N801.py:10:7: N801 Class name `STILL_BAD` should use CapWords convention | 8 | pass - 9 | + 9 | 10 | class STILL_BAD: | ^^^^^^^^^ N801 11 | pass diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N802_N802.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N802_N802.py.snap index 516e7f5aee765..223636244b652 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N802_N802.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N802_N802.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N802.py:6:5: N802 Function name `stillBad` should be lowercase | 4 | pass -5 | +5 | 6 | def stillBad(): | ^^^^^^^^ N802 7 | pass @@ -13,10 +13,8 @@ N802.py:6:5: N802 Function name `stillBad` should be lowercase N802.py:13:9: N802 Function name `stillBad` should be lowercase | 11 | return super().tearDown() -12 | +12 | 13 | def stillBad(self): | ^^^^^^^^ N802 14 | return super().tearDown() | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N803_N803.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N803_N803.py.snap index fbe7f97113117..6eac6d5d8d4f8 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N803_N803.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N803_N803.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N803.py:4:16: N803 Argument name `stillBad` should be lowercase | 2 | return _, a, badAllowed -3 | +3 | 4 | def func(_, a, stillBad): | ^^^^^^^^ N803 5 | return _, a, stillBad @@ -13,10 +13,8 @@ N803.py:4:16: N803 Argument name `stillBad` should be lowercase N803.py:11:28: N803 Argument name `stillBad` should be lowercase | 9 | return _, a, badAllowed -10 | +10 | 11 | def method(self, _, a, stillBad): | ^^^^^^^^ N803 12 | return _, a, stillBad | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N804_N804.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N804_N804.py.snap index 678a2358c49ed..8afa86cd06c81 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N804_N804.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N804_N804.py.snap @@ -80,7 +80,7 @@ N804.py:18:20: N804 [*] First argument of a class method should be named `cls` N804.py:21:18: N804 [*] First argument of a class method should be named `cls` | 19 | pass -20 | +20 | 21 | def stillBad(self): | ^^^^ N804 22 | pass diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N805_N805.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N805_N805.py.snap index 0d5d100f42e22..f6ed863145a25 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N805_N805.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N805_N805.py.snap @@ -23,7 +23,7 @@ N805.py:7:20: N805 [*] First argument of a method should be named `self` N805.py:10:18: N805 [*] First argument of a method should be named `self` | 8 | pass - 9 | + 9 | 10 | def stillBad(this): | ^^^^ N805 11 | pass @@ -43,7 +43,7 @@ N805.py:10:18: N805 [*] First argument of a method should be named `self` N805.py:15:24: N805 [*] First argument of a method should be named `self` | 13 | if False: -14 | +14 | 15 | def badAllowed(this): | ^^^^ N805 16 | pass @@ -63,7 +63,7 @@ N805.py:15:24: N805 [*] First argument of a method should be named `self` N805.py:18:22: N805 [*] First argument of a method should be named `self` | 16 | pass -17 | +17 | 18 | def stillBad(this): | ^^^^ N805 19 | pass @@ -168,7 +168,7 @@ N805.py:55:20: N805 First argument of a method should be named `self` N805.py:58:18: N805 First argument of a method should be named `self` | 56 | pass -57 | +57 | 58 | def stillBad(this, blah, /, self, something: str): | ^^^^ N805 59 | pass diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N806_N806.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N806_N806.py.snap index 7c718b9c8fff0..d5a3d42215215 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N806_N806.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N806_N806.py.snap @@ -7,7 +7,7 @@ N806.py:3:5: N806 Variable `stillBad` in function should be lowercase 2 | badAllowed = 0 3 | stillBad = 0 | ^^^^^^^^ N806 -4 | +4 | 5 | BAD_ALLOWED = 0 | @@ -17,5 +17,3 @@ N806.py:6:5: N806 Variable `STILL_BAD` in function should be lowercase 6 | STILL_BAD = 0 | ^^^^^^^^^ N806 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N807_N807.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N807_N807.py.snap index 691b3ddbee05c..c5de6c4f1f33f 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N807_N807.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N807_N807.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N807.py:4:5: N807 Function name should not start and end with `__` | 2 | pass -3 | +3 | 4 | def __stillBad__(): | ^^^^^^^^^^^^ N807 5 | pass @@ -13,10 +13,8 @@ N807.py:4:5: N807 Function name should not start and end with `__` N807.py:12:9: N807 Function name should not start and end with `__` | 10 | pass -11 | +11 | 12 | def __stillBad__(): | ^^^^^^^^^^^^ N807 13 | pass | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N811_N811.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N811_N811.py.snap index 4c76ee9b84f96..bcd0ed596cdce 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N811_N811.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N811_N811.py.snap @@ -6,7 +6,7 @@ N811.py:2:8: N811 Constant `STILL_BAD` imported as non-constant `stillBad` 1 | import mod.BAD_ALLOWED as badAllowed 2 | import mod.STILL_BAD as stillBad | ^^^^^^^^^^^^^^^^^^^^^^^^^ N811 -3 | +3 | 4 | from mod import BAD_ALLOWED as badAllowed | @@ -16,5 +16,3 @@ N811.py:5:17: N811 Constant `STILL_BAD` imported as non-constant `stillBad` 5 | from mod import STILL_BAD as stillBad | ^^^^^^^^^^^^^^^^^^^^^ N811 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N812_N812.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N812_N812.py.snap index 5e40f3a2ac45a..d198c0546e9f1 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N812_N812.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N812_N812.py.snap @@ -6,7 +6,7 @@ N812.py:2:8: N812 Lowercase `stillbad` imported as non-lowercase `stillBad` 1 | import mod.badallowed as badAllowed 2 | import mod.stillbad as stillBad | ^^^^^^^^^^^^^^^^^^^^^^^^ N812 -3 | +3 | 4 | from mod import badallowed as BadAllowed | @@ -16,5 +16,3 @@ N812.py:5:17: N812 Lowercase `stillbad` imported as non-lowercase `StillBad` 5 | from mod import stillbad as StillBad | ^^^^^^^^^^^^^^^^^^^^ N812 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N813_N813.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N813_N813.py.snap index ce2bc77af7d13..021d450283983 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N813_N813.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N813_N813.py.snap @@ -6,7 +6,7 @@ N813.py:2:8: N813 Camelcase `stillBad` imported as lowercase `stillbad` 1 | import mod.BadAllowed as badallowed 2 | import mod.stillBad as stillbad | ^^^^^^^^^^^^^^^^^^^^^^^^ N813 -3 | +3 | 4 | from mod import BadAllowed as badallowed | @@ -15,7 +15,7 @@ N813.py:5:17: N813 Camelcase `StillBad` imported as lowercase `stillbad` 4 | from mod import BadAllowed as badallowed 5 | from mod import StillBad as stillbad | ^^^^^^^^^^^^^^^^^^^^ N813 -6 | +6 | 7 | from mod import BadAllowed as bad_allowed | @@ -25,5 +25,3 @@ N813.py:8:17: N813 Camelcase `StillBad` imported as lowercase `still_bad` 8 | from mod import StillBad as still_bad | ^^^^^^^^^^^^^^^^^^^^^ N813 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N814_N814.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N814_N814.py.snap index d134f3384d048..d5b4ef9e74828 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N814_N814.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N814_N814.py.snap @@ -6,7 +6,7 @@ N814.py:2:8: N814 Camelcase `StillBad` imported as constant `STILLBAD` 1 | import mod.BadAllowed as BADALLOWED 2 | import mod.StillBad as STILLBAD | ^^^^^^^^^^^^^^^^^^^^^^^^ N814 -3 | +3 | 4 | from mod import BadAllowed as BADALLOWED | @@ -15,7 +15,7 @@ N814.py:5:17: N814 Camelcase `StillBad` imported as constant `STILLBAD` 4 | from mod import BadAllowed as BADALLOWED 5 | from mod import StillBad as STILLBAD | ^^^^^^^^^^^^^^^^^^^^ N814 -6 | +6 | 7 | from mod import BadAllowed as BAD_ALLOWED | @@ -25,5 +25,3 @@ N814.py:8:17: N814 Camelcase `StillBad` imported as constant `STILL_BAD` 8 | from mod import StillBad as STILL_BAD | ^^^^^^^^^^^^^^^^^^^^^ N814 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N815_N815.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N815_N815.py.snap index 85aad3c0b3bde..6712a94c4e273 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N815_N815.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N815_N815.py.snap @@ -7,7 +7,7 @@ N815.py:3:5: N815 Variable `stillBad` in class scope should not be mixedCase 2 | badAllowed = 0 3 | stillBad = 0 | ^^^^^^^^ N815 -4 | +4 | 5 | _badAllowed = 0 | @@ -16,7 +16,7 @@ N815.py:6:5: N815 Variable `_stillBad` in class scope should not be mixedCase 5 | _badAllowed = 0 6 | _stillBad = 0 | ^^^^^^^^^ N815 -7 | +7 | 8 | bad_Allowed = 0 | @@ -25,7 +25,7 @@ N815.py:9:5: N815 Variable `still_Bad` in class scope should not be mixedCase 8 | bad_Allowed = 0 9 | still_Bad = 0 | ^^^^^^^^^ N815 -10 | +10 | 11 | class D(TypedDict): | @@ -35,7 +35,7 @@ N815.py:13:5: N815 Variable `stillBad` in class scope should not be mixedCase 12 | badAllowed: bool 13 | stillBad: bool | ^^^^^^^^ N815 -14 | +14 | 15 | _badAllowed: list | @@ -44,7 +44,7 @@ N815.py:16:5: N815 Variable `_stillBad` in class scope should not be mixedCase 15 | _badAllowed: list 16 | _stillBad: list | ^^^^^^^^^ N815 -17 | +17 | 18 | bad_Allowed: set | @@ -54,5 +54,3 @@ N815.py:19:5: N815 Variable `still_Bad` in class scope should not be mixedCase 19 | still_Bad: set | ^^^^^^^^^ N815 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N816_N816.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N816_N816.py.snap index 56f48fe0a7734..779cd8fd65c42 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N816_N816.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N816_N816.py.snap @@ -6,7 +6,7 @@ N816.py:2:1: N816 Variable `stillBad` in global scope should not be mixedCase 1 | badAllowed = 0 2 | stillBad = 0 | ^^^^^^^^ N816 -3 | +3 | 4 | _badAllowed = 0 | @@ -15,7 +15,7 @@ N816.py:5:1: N816 Variable `_stillBad` in global scope should not be mixedCase 4 | _badAllowed = 0 5 | _stillBad = 0 | ^^^^^^^^^ N816 -6 | +6 | 7 | bad_Allowed = 0 | @@ -25,5 +25,3 @@ N816.py:8:1: N816 Variable `still_Bad` in global scope should not be mixedCase 8 | still_Bad = 0 | ^^^^^^^^^ N816 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N817_N817.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N817_N817.py.snap index c746a3a0c2665..605e62924b170 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N817_N817.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N817_N817.py.snap @@ -6,7 +6,7 @@ N817.py:2:8: N817 CamelCase `StillBad` imported as acronym `SB` 1 | import mod.BadAllowed as BA 2 | import mod.StillBad as SB | ^^^^^^^^^^^^^^^^^^ N817 -3 | +3 | 4 | from mod import BadAllowed as BA | @@ -16,5 +16,3 @@ N817.py:5:17: N817 CamelCase `StillBad` imported as acronym `SB` 5 | from mod import StillBad as SB | ^^^^^^^^^^^^^^ N817 | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N818_N818.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N818_N818.py.snap index fc378dc639f2b..3a27ac47f09c5 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N818_N818.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N818_N818.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pep8_naming/mod.rs N818.py:4:7: N818 Exception name `StillBad` should be named with an Error suffix | 2 | pass -3 | +3 | 4 | class StillBad(Exception): | ^^^^^^^^ N818 5 | pass @@ -13,10 +13,8 @@ N818.py:4:7: N818 Exception name `StillBad` should be named with an Error suffix N818.py:10:7: N818 Exception name `StillBad` should be named with an Error suffix | 8 | pass - 9 | + 9 | 10 | class StillBad(AnotherError): | ^^^^^^^^ N818 11 | pass | - - diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N999_N999__badAllowed____init__.py.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N999_N999__badAllowed____init__.py.snap index 719c39c477ca1..da7b4877190e3 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N999_N999__badAllowed____init__.py.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__ignore_names_N999_N999__badAllowed____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pep8_naming/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__staticmethod_decorators.snap b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__staticmethod_decorators.snap index f253d2c666087..c1a6d0298a115 100644 --- a/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__staticmethod_decorators.snap +++ b/crates/ruff_linter/src/rules/pep8_naming/snapshots/ruff_linter__rules__pep8_naming__tests__staticmethod_decorators.snap @@ -80,7 +80,7 @@ N805.py:34:15: N805 [*] First argument of a method should be named `self` N805.py:63:29: N805 [*] First argument of a method should be named `self` | 61 | pass -62 | +62 | 63 | def bad_method_pos_only(this, blah, /, something: str): | ^^^^ N805 64 | pass @@ -167,7 +167,7 @@ N805.py:98:26: N805 First argument of a method should be named `self` N805.py:101:35: N805 First argument of a method should be named `self` | 99 | pass -100 | +100 | 101 | def self_as_pos_only_argument(this, self, /): | ^^^^ N805 102 | pass @@ -177,7 +177,7 @@ N805.py:101:35: N805 First argument of a method should be named `self` N805.py:104:34: N805 First argument of a method should be named `self` | 102 | pass -103 | +103 | 104 | def self_as_kw_only_argument(this, *, self): | ^^^^ N805 105 | pass @@ -187,7 +187,7 @@ N805.py:104:34: N805 First argument of a method should be named `self` N805.py:107:24: N805 First argument of a method should be named `self` | 105 | pass -106 | +106 | 107 | def self_as_varags(this, *self): | ^^^^ N805 108 | pass @@ -197,7 +197,7 @@ N805.py:107:24: N805 First argument of a method should be named `self` N805.py:110:24: N805 First argument of a method should be named `self` | 108 | pass -109 | +109 | 110 | def self_as_kwargs(this, **self): | ^^^^ N805 111 | pass @@ -231,7 +231,7 @@ N805.py:115:20: N805 [*] First argument of a method should be named `self` N805.py:119:20: N805 [*] First argument of a method should be named `self` | 117 | this -118 | +118 | 119 | def bad_method(this): | ^^^^ N805 120 | self = this diff --git a/crates/ruff_linter/src/rules/perflint/helpers.rs b/crates/ruff_linter/src/rules/perflint/helpers.rs new file mode 100644 index 0000000000000..271975246c14e --- /dev/null +++ b/crates/ruff_linter/src/rules/perflint/helpers.rs @@ -0,0 +1,98 @@ +use ruff_python_trivia::{ + BackwardsTokenizer, PythonWhitespace, SimpleToken, SimpleTokenKind, SimpleTokenizer, +}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; + +pub(super) fn comment_strings_in_range<'a>( + checker: &'a Checker, + range: TextRange, + ranges_to_ignore: &[TextRange], +) -> Vec<&'a str> { + checker + .comment_ranges() + .comments_in_range(range) + .iter() + // Ignore comments inside of the append or iterator, since these are preserved + .filter(|comment| { + !ranges_to_ignore + .iter() + .any(|to_ignore| to_ignore.contains_range(**comment)) + }) + .map(|range| checker.locator().slice(range).trim_whitespace_start()) + .collect() +} + +fn semicolon_before_and_after( + checker: &Checker, + statement: TextRange, +) -> (Option<SimpleToken>, Option<SimpleToken>) { + // determine whether there's a semicolon either before or after the binding statement. + // Since it's a binding statement, we can just check whether there's a semicolon immediately + // after the whitespace in front of or behind it + let mut after_tokenizer = + SimpleTokenizer::starts_at(statement.end(), checker.locator().contents()).skip_trivia(); + + let after_semicolon = if after_tokenizer + .next() + .is_some_and(|token| token.kind() == SimpleTokenKind::Semi) + { + after_tokenizer.next() + } else { + None + }; + + let semicolon_before = BackwardsTokenizer::up_to( + statement.start(), + checker.locator().contents(), + checker.comment_ranges(), + ) + .skip_trivia() + .next() + .filter(|token| token.kind() == SimpleTokenKind::Semi); + + (semicolon_before, after_semicolon) +} + +/// Finds the range necessary to delete a statement (including any semicolons around it). +/// Returns the range and whether there were multiple statements on the line +pub(super) fn statement_deletion_range( + checker: &Checker, + statement_range: TextRange, +) -> (TextRange, bool) { + let locator = checker.locator(); + // If the binding has multiple statements on its line, the fix would be substantially more complicated + let (semicolon_before, after_semicolon) = semicolon_before_and_after(checker, statement_range); + + // If there are multiple binding statements in one line, we don't want to accidentally delete them + // Instead, we just delete the binding statement and leave any comments where they are + + match (semicolon_before, after_semicolon) { + // ```python + // a = [] + // ``` + (None, None) => (locator.full_lines_range(statement_range), false), + + // ```python + // a = 1; b = [] + // ^^^^^^^^ + // a = 1; b = []; c = 3 + // ^^^^^^^^ + // ``` + (Some(semicolon_before), Some(_) | None) => ( + TextRange::new(semicolon_before.start(), statement_range.end()), + true, + ), + + // ```python + // a = []; b = 3 + // ^^^^^^^ + // ``` + (None, Some(after_semicolon)) => ( + TextRange::new(statement_range.start(), after_semicolon.start()), + true, + ), + } +} diff --git a/crates/ruff_linter/src/rules/perflint/mod.rs b/crates/ruff_linter/src/rules/perflint/mod.rs index 2d073e639e242..ceeebf171634f 100644 --- a/crates/ruff_linter/src/rules/perflint/mod.rs +++ b/crates/ruff_linter/src/rules/perflint/mod.rs @@ -1,17 +1,18 @@ //! Rules from [perflint](https://pypi.org/project/perflint/). +mod helpers; pub(crate) mod rules; - #[cfg(test)] mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::PythonVersion; use test_case::test_case; use crate::assert_messages; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; #[test_case(Rule::UnnecessaryListCast, Path::new("PERF101.py"))] @@ -24,7 +25,28 @@ mod tests { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( Path::new("perflint").join(path).as_path(), - &LinterSettings::for_rule(rule_code).with_target_version(PythonVersion::Py310), + &LinterSettings::for_rule(rule_code).with_target_version(PythonVersion::PY310), + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + // TODO: remove this test case when the fixes for `perf401` and `perf403` are stabilized + #[test_case(Rule::ManualDictComprehension, Path::new("PERF403.py"))] + #[test_case(Rule::ManualListComprehension, Path::new("PERF401.py"))] + fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "preview__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("perflint").join(path).as_path(), + &LinterSettings { + preview: PreviewMode::Enabled, + unresolved_target_version: PythonVersion::PY310.into(), + ..LinterSettings::for_rule(rule_code) + }, )?; assert_messages!(snapshot, diagnostics); Ok(()) diff --git a/crates/ruff_linter/src/rules/perflint/rules/incorrect_dict_iterator.rs b/crates/ruff_linter/src/rules/perflint/rules/incorrect_dict_iterator.rs index 6d7fc992c6c41..5343a0416bb6f 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/incorrect_dict_iterator.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/incorrect_dict_iterator.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::{Arguments, Expr}; use ruff_text_size::Ranged; @@ -43,8 +43,8 @@ use crate::fix::edits::pad; /// incorrect fix if the object in question does not duck-type as a mapping /// (e.g., if it is missing a `.keys()` or `.values()` method, or if those /// methods behave differently than they do on standard mapping types). -#[violation] -pub struct IncorrectDictIterator { +#[derive(ViolationMetadata)] +pub(crate) struct IncorrectDictIterator { subset: DictSubset, } @@ -62,7 +62,7 @@ impl AlwaysFixableViolation for IncorrectDictIterator { } /// PERF102 -pub(crate) fn incorrect_dict_iterator(checker: &mut Checker, stmt_for: &ast::StmtFor) { +pub(crate) fn incorrect_dict_iterator(checker: &Checker, stmt_for: &ast::StmtFor) { let Expr::Tuple(ast::ExprTuple { elts, .. }) = stmt_for.target.as_ref() else { return; }; @@ -115,7 +115,7 @@ pub(crate) fn incorrect_dict_iterator(checker: &mut Checker, stmt_for: &ast::Stm stmt_for.target.range(), ); diagnostic.set_fix(Fix::unsafe_edits(replace_attribute, [replace_target])); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } (false, true) => { // The value is unused, so replace with `dict.keys()`. @@ -135,7 +135,7 @@ pub(crate) fn incorrect_dict_iterator(checker: &mut Checker, stmt_for: &ast::Stm stmt_for.target.range(), ); diagnostic.set_fix(Fix::unsafe_edits(replace_attribute, [replace_target])); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/perflint/rules/manual_dict_comprehension.rs b/crates/ruff_linter/src/rules/perflint/rules/manual_dict_comprehension.rs index aa150e2db4866..ed0a9fd101a2c 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/manual_dict_comprehension.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/manual_dict_comprehension.rs @@ -1,11 +1,15 @@ -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::helpers::any_over_expr; -use ruff_python_ast::{self as ast, Expr, Stmt}; -use ruff_python_semantic::analyze::typing::is_dict; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + self as ast, Expr, Stmt, comparable::ComparableExpr, helpers::any_over_expr, +}; +use ruff_python_semantic::{Binding, analyze::typing::is_dict}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use crate::preview::is_fix_manual_dict_comprehension_enabled; +use crate::rules::perflint::helpers::{comment_strings_in_range, statement_deletion_range}; /// ## What it does /// Checks for `for` loops that can be replaced by a dictionary comprehension. @@ -41,30 +45,60 @@ use crate::checkers::ast::Checker; /// pairs = (("a", 1), ("b", 2)) /// result.update({x: y for x, y in pairs if y % 2}) /// ``` -#[violation] -pub struct ManualDictComprehension; +#[derive(ViolationMetadata)] +pub(crate) struct ManualDictComprehension { + fix_type: DictComprehensionType, + is_async: bool, +} impl Violation for ManualDictComprehension { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { - format!("Use a dictionary comprehension instead of a for-loop") + let modifier = if self.is_async { "an async" } else { "a" }; + + match self.fix_type { + DictComprehensionType::Comprehension => { + format!("Use a dictionary comprehension instead of {modifier} for-loop") + } + DictComprehensionType::Update => { + format!("Use `dict.update` instead of {modifier} for-loop") + } + } + } + fn fix_title(&self) -> Option<String> { + let modifier = if self.is_async { "async " } else { "" }; + match self.fix_type { + DictComprehensionType::Comprehension => Some(format!( + "Replace {modifier}for loop with dict comprehension" + )), + DictComprehensionType::Update => { + Some(format!("Replace {modifier}for loop with `dict.update`")) + } + } } } /// PERF403 -pub(crate) fn manual_dict_comprehension(checker: &mut Checker, target: &Expr, body: &[Stmt]) { +pub(crate) fn manual_dict_comprehension(checker: &Checker, for_stmt: &ast::StmtFor) { + let ast::StmtFor { body, target, .. } = for_stmt; + let body = body.as_slice(); + let target = target.as_ref(); let (stmt, if_test) = match body { // ```python // for idx, name in enumerate(names): // if idx % 2 == 0: // result[name] = idx // ``` - [Stmt::If(ast::StmtIf { - body, - elif_else_clauses, - test, - .. - })] => { + [ + Stmt::If(ast::StmtIf { + body, + elif_else_clauses, + test, + .. + }), + ] => { // TODO(charlie): If there's an `else` clause, verify that the `else` has the // same structure. if !elif_else_clauses.is_empty() { @@ -92,20 +126,46 @@ pub(crate) fn manual_dict_comprehension(checker: &mut Checker, target: &Expr, bo return; }; - let [Expr::Subscript(ast::ExprSubscript { - value: subscript_value, - slice, - .. - })] = targets.as_slice() + let [ + Expr::Subscript(ast::ExprSubscript { + value: subscript_value, + slice: key, + .. + }), + ] = targets.as_slice() else { return; }; + // If any references to a target variable are after the loop, + // then removing the loop would cause a NameError + let any_references_after_for_loop = |target: &Expr| { + let target_binding = checker + .semantic() + .bindings + .iter() + .find(|binding| target.range() == binding.range); + debug_assert!( + target_binding.is_some(), + "for-loop target binding must exist" + ); + + let Some(target_binding) = target_binding else { + // All uses of this function will early-return if this returns true, so this must early-return the rule + return true; + }; + + target_binding + .references() + .map(|reference| checker.semantic().reference(reference)) + .any(|other_reference| other_reference.start() > for_stmt.end()) + }; + match target { Expr::Tuple(tuple) => { if !tuple .iter() - .any(|element| ComparableExpr::from(slice) == ComparableExpr::from(element)) + .any(|element| ComparableExpr::from(key) == ComparableExpr::from(element)) { return; } @@ -115,14 +175,24 @@ pub(crate) fn manual_dict_comprehension(checker: &mut Checker, target: &Expr, bo { return; } + // Make sure none of the variables are used outside the for loop + if tuple.iter().any(any_references_after_for_loop) { + return; + } } Expr::Name(_) => { - if ComparableExpr::from(slice) != ComparableExpr::from(target) { + if ComparableExpr::from(key) != ComparableExpr::from(target) { return; } if ComparableExpr::from(value) != ComparableExpr::from(target) { return; } + + // We know that `target` contains an ExprName, but closures can't take `&impl Ranged`, + // so we pass `target` itself instead of the inner ExprName + if any_references_after_for_loop(target) { + return; + } } _ => return, } @@ -164,7 +234,242 @@ pub(crate) fn manual_dict_comprehension(checker: &mut Checker, target: &Expr, bo return; } - checker - .diagnostics - .push(Diagnostic::new(ManualDictComprehension, *range)); + if is_fix_manual_dict_comprehension_enabled(checker.settings) { + let binding_stmt = binding.statement(checker.semantic()); + let binding_value = binding_stmt.and_then(|binding_stmt| match binding_stmt { + ast::Stmt::AnnAssign(assign) => assign.value.as_deref(), + ast::Stmt::Assign(assign) => Some(&assign.value), + _ => None, + }); + + // If the variable is an empty dict literal, then we might be able to replace it with a full dict comprehension. + // otherwise, it has to be replaced with a `dict.update` + let binding_is_empty_dict = + binding_value.is_some_and(|binding_value| match binding_value { + // value = {} + Expr::Dict(dict_expr) => dict_expr.is_empty(), + // value = dict() + Expr::Call(call) => { + checker + .semantic() + .resolve_builtin_symbol(&call.func) + .is_some_and(|name| name == "dict") + && call.arguments.is_empty() + } + _ => false, + }); + + let assignment_in_same_statement = binding.source.is_some_and(|binding_source| { + let for_loop_parent = checker.semantic().current_statement_parent_id(); + let binding_parent = checker.semantic().parent_statement_id(binding_source); + for_loop_parent == binding_parent + }); + // If the binding is not a single name expression, it could be replaced with a dict comprehension, + // but not necessarily, so this needs to be manually fixed. This does not apply when using an update. + let binding_has_one_target = binding_stmt.is_some_and(|binding_stmt| match binding_stmt { + ast::Stmt::AnnAssign(_) => true, + ast::Stmt::Assign(assign) => assign.targets.len() == 1, + _ => false, + }); + // If the binding gets used in between the assignment and the for loop, a comprehension is no longer safe + + // If the binding is after the for loop, then it can't be fixed, and this check would panic, + // so we check that they are in the same statement first + let binding_unused_between = assignment_in_same_statement + && binding_stmt.is_some_and(|binding_stmt| { + let from_assign_to_loop = TextRange::new(binding_stmt.end(), for_stmt.start()); + // Test if there's any reference to the result dictionary between its definition and the for loop. + // If there's at least one, then it's been accessed in the middle somewhere, so it's not safe to change into a comprehension + !binding + .references() + .map(|ref_id| checker.semantic().reference(ref_id).range()) + .any(|text_range| from_assign_to_loop.contains_range(text_range)) + }); + // A dict update works in every context, while a dict comprehension only works when all the criteria are true + let fix_type = if binding_is_empty_dict + && assignment_in_same_statement + && binding_has_one_target + && binding_unused_between + { + DictComprehensionType::Comprehension + } else { + DictComprehensionType::Update + }; + + let mut diagnostic = Diagnostic::new( + ManualDictComprehension { + fix_type, + is_async: for_stmt.is_async, + }, + *range, + ); + diagnostic.try_set_optional_fix(|| { + Ok(convert_to_dict_comprehension( + fix_type, + binding, + for_stmt, + if_test.map(std::convert::AsRef::as_ref), + key.as_ref(), + value.as_ref(), + checker, + )) + }); + + checker.report_diagnostic(diagnostic); + } else { + checker.report_diagnostic(Diagnostic::new( + ManualDictComprehension { + fix_type: DictComprehensionType::Comprehension, + is_async: for_stmt.is_async, + }, + *range, + )); + } +} + +fn convert_to_dict_comprehension( + fix_type: DictComprehensionType, + binding: &Binding, + for_stmt: &ast::StmtFor, + if_test: Option<&ast::Expr>, + key: &Expr, + value: &Expr, + checker: &Checker, +) -> Option<Fix> { + let locator = checker.locator(); + + let if_str = match if_test { + Some(test) => { + // If the test is an assignment expression, + // we must parenthesize it when it appears + // inside the comprehension to avoid a syntax error. + // + // Notice that we do not need `any_over_expr` here, + // since if the assignment expression appears + // internally (e.g. as an operand in a boolean + // operation) then it will already be parenthesized. + if test.is_named_expr() { + format!(" if ({})", locator.slice(test.range())) + } else { + format!(" if {}", locator.slice(test.range())) + } + } + None => String::new(), + }; + + // if the loop target was an implicit tuple, add parentheses around it + // ```python + // for i in a, b: + // ... + // ``` + // becomes + // {... for i in (a, b)} + let iter_str = if let Expr::Tuple(ast::ExprTuple { + parenthesized: false, + .. + }) = &*for_stmt.iter + { + format!("({})", locator.slice(for_stmt.iter.range())) + } else { + locator.slice(for_stmt.iter.range()).to_string() + }; + + let target_str = locator.slice(for_stmt.target.range()); + let for_type = if for_stmt.is_async { + "async for" + } else { + "for" + }; + let elt_str = format!( + "{}: {}", + locator.slice(key.range()), + locator.slice(value.range()) + ); + + let comprehension_str = format!("{{{elt_str} {for_type} {target_str} in {iter_str}{if_str}}}"); + + let for_loop_inline_comments = comment_strings_in_range( + checker, + for_stmt.range, + &[key.range(), value.range(), for_stmt.iter.range()], + ); + + let newline = checker.stylist().line_ending().as_str(); + + let indent = locator.slice(TextRange::new( + locator.line_start(for_stmt.range.start()), + for_stmt.range.start(), + )); + + let variable_name = locator.slice(binding); + match fix_type { + DictComprehensionType::Update => { + let indentation = if for_loop_inline_comments.is_empty() { + String::new() + } else { + format!("{newline}{indent}") + }; + + let comprehension_body = format!("{variable_name}.update({comprehension_str})"); + + let text_to_replace = format!( + "{}{indentation}{comprehension_body}", + for_loop_inline_comments.join(&indentation) + ); + + Some(Fix::unsafe_edit(Edit::range_replacement( + text_to_replace, + for_stmt.range, + ))) + } + DictComprehensionType::Comprehension => { + let binding_stmt = binding.statement(checker.semantic()); + debug_assert!( + binding_stmt.is_some(), + "must be passed a binding with a statement" + ); + let binding_stmt = binding_stmt?; + + let binding_stmt_range = binding_stmt.range(); + + let annotations = match binding_stmt.as_ann_assign_stmt() { + Some(assign) => format!(": {}", locator.slice(assign.annotation.range())), + None => String::new(), + }; + + // If there are multiple binding statements in one line, we don't want to accidentally delete them + // Instead, we just delete the binding statement and leave any comments where they are + let (binding_stmt_deletion_range, binding_is_multiple_stmts) = + statement_deletion_range(checker, binding_stmt_range); + + let comments_to_move = if binding_is_multiple_stmts { + for_loop_inline_comments + } else { + let mut new_comments = + comment_strings_in_range(checker, binding_stmt_deletion_range, &[]); + new_comments.extend(for_loop_inline_comments); + new_comments + }; + + let indentation = if comments_to_move.is_empty() { + String::new() + } else { + format!("{newline}{indent}") + }; + let leading_comments = format!("{}{indentation}", comments_to_move.join(&indentation)); + + let comprehension_body = + format!("{leading_comments}{variable_name}{annotations} = {comprehension_str}"); + Some(Fix::unsafe_edits( + Edit::range_deletion(binding_stmt_deletion_range), + [Edit::range_replacement(comprehension_body, for_stmt.range)], + )) + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum DictComprehensionType { + Update, + Comprehension, } diff --git a/crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs b/crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs index cc3ced50830db..590628c39ff45 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs @@ -1,13 +1,18 @@ -use ruff_python_ast::{self as ast, Arguments, Expr, Stmt}; +use ruff_python_ast::{self as ast, Arguments, Expr}; -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::helpers::any_over_expr; -use ruff_python_semantic::analyze::typing::is_list; - -use crate::checkers::ast::Checker; +use crate::{ + checkers::ast::Checker, preview::is_fix_manual_list_comprehension_enabled, + rules::perflint::helpers::statement_deletion_range, +}; +use anyhow::{Result, anyhow}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use crate::rules::perflint::helpers::comment_strings_in_range; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::any_over_expr; +use ruff_python_semantic::{Binding, analyze::typing::is_list}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextRange}; /// ## What it does /// Checks for `for` loops that can be replaced by a list comprehension. /// @@ -43,25 +48,62 @@ use crate::checkers::ast::Checker; /// original = list(range(10000)) /// filtered.extend(x for x in original if x % 2) /// ``` -#[violation] -pub struct ManualListComprehension { +/// +/// Take care that if the original for-loop uses an assignment expression +/// as a conditional, such as `if match:=re.match("\d+","123")`, then +/// the corresponding comprehension must wrap the assignment +/// expression in parentheses to avoid a syntax error. +#[derive(ViolationMetadata)] +pub(crate) struct ManualListComprehension { is_async: bool, + comprehension_type: Option<ComprehensionType>, } impl Violation for ManualListComprehension { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { - let ManualListComprehension { is_async } = self; - match is_async { - false => format!("Use a list comprehension to create a transformed list"), - true => format!("Use an async list comprehension to create a transformed list"), + let ManualListComprehension { + is_async, + comprehension_type, + } = self; + let message_str = match comprehension_type { + Some(ComprehensionType::Extend) => { + if *is_async { + "`list.extend` with an async comprehension" + } else { + "`list.extend`" + } + } + Some(ComprehensionType::ListComprehension) | None => { + if *is_async { + "an async list comprehension" + } else { + "a list comprehension" + } + } + }; + format!("Use {message_str} to create a transformed list") + } + + fn fix_title(&self) -> Option<String> { + match self.comprehension_type? { + ComprehensionType::ListComprehension => { + Some("Replace for loop with list comprehension".to_string()) + } + ComprehensionType::Extend => Some("Replace for loop with list.extend".to_string()), } } } /// PERF401 -pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::StmtFor) { - let Expr::Name(ast::ExprName { id, .. }) = &*for_stmt.target else { +pub(crate) fn manual_list_comprehension(checker: &Checker, for_stmt: &ast::StmtFor) { + let Expr::Name(ast::ExprName { + id: for_stmt_target_id, + .. + }) = &*for_stmt.target + else { return; }; @@ -71,12 +113,14 @@ pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::S // if z: // filtered.append(x) // ``` - [Stmt::If(ast::StmtIf { - body, - elif_else_clauses, - test, - .. - })] => { + [ + ast::Stmt::If(ast::StmtIf { + body, + elif_else_clauses, + test, + .. + }), + ] => { if !elif_else_clauses.is_empty() { return; } @@ -93,7 +137,7 @@ pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::S _ => return, }; - let Stmt::Expr(ast::StmtExpr { value, .. }) = stmt else { + let ast::Stmt::Expr(ast::StmtExpr { value, .. }) = stmt else { return; }; @@ -119,7 +163,7 @@ pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::S return; }; - let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = func.as_ref() else { + let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = &**func else { return; }; @@ -127,46 +171,45 @@ pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::S return; } + // Avoid non-list values. + let Some(list_name) = value.as_name_expr() else { + return; + }; + // Ignore direct list copies (e.g., `for x in y: filtered.append(x)`), unless it's async, which // `manual-list-copy` doesn't cover. if !for_stmt.is_async { if if_test.is_none() { - if arg.as_name_expr().is_some_and(|arg| arg.id == *id) { + if arg + .as_name_expr() + .is_some_and(|arg| arg.id == *for_stmt_target_id) + { return; } } } - // Avoid, e.g., `for x in y: filtered[x].append(x * x)`. - if any_over_expr(value, &|expr| { - expr.as_name_expr().is_some_and(|expr| expr.id == *id) - }) { - return; - } - // Avoid, e.g., `for x in y: filtered.append(filtered[-1] * 2)`. if any_over_expr(arg, &|expr| { - ComparableExpr::from(expr) == ComparableExpr::from(value) + expr.as_name_expr() + .is_some_and(|expr| expr.id == list_name.id) }) { return; } - // Avoid non-list values. - let Some(name) = value.as_name_expr() else { - return; - }; - let Some(binding) = checker + let Some(list_binding) = checker .semantic() - .only_binding(name) + .only_binding(list_name) .map(|id| checker.semantic().binding(id)) else { return; }; - if !is_list(binding, checker.semantic()) { + + if !is_list(list_binding, checker.semantic()) { return; } - // Avoid if the value is used in the conditional test, e.g., + // Avoid if the list is used in the conditional test, e.g., // // ```python // for x in y: @@ -182,16 +225,283 @@ pub(crate) fn manual_list_comprehension(checker: &mut Checker, for_stmt: &ast::S // ``` if if_test.is_some_and(|test| { any_over_expr(test, &|expr| { - expr.as_name_expr().is_some_and(|expr| expr.id == name.id) + expr.as_name_expr() + .is_some_and(|expr| expr.id == list_name.id) }) }) { return; } - checker.diagnostics.push(Diagnostic::new( + // Avoid if the for-loop target is used outside the for loop, e.g., + // + // ```python + // for x in y: + // filtered.append(x) + // print(x) + // ``` + // + // If this were a comprehension, x would no longer have the correct scope: + // + // ```python + // filtered = [x for x in y] + // print(x) + // ``` + let target_binding = checker + .semantic() + .bindings + .iter() + .find(|binding| for_stmt.target.range() == binding.range) + .unwrap(); + // If any references to the loop target variable are after the loop, + // then converting it into a comprehension would cause a NameError + if target_binding + .references() + .map(|reference| checker.semantic().reference(reference)) + .any(|other_reference| for_stmt.end() < other_reference.start()) + { + return; + } + + let list_binding_stmt = list_binding.statement(checker.semantic()); + let list_binding_value = list_binding_stmt.and_then(|binding_stmt| match binding_stmt { + ast::Stmt::AnnAssign(assign) => assign.value.as_deref(), + ast::Stmt::Assign(assign) => Some(&assign.value), + _ => None, + }); + + // If the variable is an empty list literal, then we might be able to replace it with a full list comprehension + // otherwise, it has to be replaced with a `list.extend`. + let binding_is_empty_list = + list_binding_value.is_some_and(|binding_value| match binding_value { + // `value = []` + Expr::List(list_expr) => list_expr.is_empty(), + // `value = list()` + // This might be linted against, but turning it into a list comprehension will also remove it + Expr::Call(call) => { + checker + .semantic() + .resolve_builtin_symbol(&call.func) + .is_some_and(|name| name == "list") + && call.arguments.is_empty() + } + _ => false, + }); + + // If the for loop does not have the same parent element as the binding, then it cannot always be + // deleted and replaced with a list comprehension. This does not apply when using `extend`. + let assignment_in_same_statement = { + list_binding.source.is_some_and(|binding_source| { + let for_loop_parent = checker.semantic().current_statement_parent_id(); + let binding_parent = checker.semantic().parent_statement_id(binding_source); + for_loop_parent == binding_parent + }) + }; + + // If the binding is not a single name expression, it could be replaced with a list comprehension, + // but not necessarily, so this needs to be manually fixed. This does not apply when using an extend. + let binding_has_one_target = list_binding_stmt.is_some_and(|binding_stmt| match binding_stmt { + ast::Stmt::AnnAssign(_) => true, + ast::Stmt::Assign(assign) => assign.targets.len() == 1, + _ => false, + }); + + // If the binding gets used in between the assignment and the for loop, a list comprehension is no longer safe + + // If the binding is after the for loop, then it can't be fixed, and this check would panic, + // so we check that they are in the same statement first + let binding_unused_between = assignment_in_same_statement + && list_binding_stmt.is_some_and(|binding_stmt| { + let from_assign_to_loop = TextRange::new(binding_stmt.end(), for_stmt.start()); + // Test if there's any reference to the list symbol between its definition and the for loop. + // if there's at least one, then it's been accessed in the middle somewhere, so it's not safe to change into a list comprehension + !list_binding + .references() + .map(|ref_id| checker.semantic().reference(ref_id).range()) + .any(|text_range| from_assign_to_loop.contains_range(text_range)) + }); + + // A list extend works in every context, while a list comprehension only works when all the criteria are true + let comprehension_type = if binding_is_empty_list + && assignment_in_same_statement + && binding_has_one_target + && binding_unused_between + { + ComprehensionType::ListComprehension + } else { + ComprehensionType::Extend + }; + + let mut diagnostic = Diagnostic::new( ManualListComprehension { is_async: for_stmt.is_async, + comprehension_type: Some(comprehension_type), }, *range, + ); + + // TODO: once this fix is stabilized, change the rule to always fixable + if is_fix_manual_list_comprehension_enabled(checker.settings) { + diagnostic.try_set_fix(|| { + convert_to_list_extend( + comprehension_type, + list_binding, + for_stmt, + if_test.map(std::convert::AsRef::as_ref), + arg, + checker, + ) + }); + } + + checker.report_diagnostic(diagnostic); +} + +fn convert_to_list_extend( + fix_type: ComprehensionType, + binding: &Binding, + for_stmt: &ast::StmtFor, + if_test: Option<&ast::Expr>, + to_append: &Expr, + checker: &Checker, +) -> Result<Fix> { + let semantic = checker.semantic(); + let locator = checker.locator(); + let if_str = match if_test { + Some(test) => { + // If the test is an assignment expression, + // we must parenthesize it when it appears + // inside the comprehension to avoid a syntax error. + // + // Notice that we do not need `any_over_expr` here, + // since if the assignment expression appears + // internally (e.g. as an operand in a boolean + // operation) then it will already be parenthesized. + if test.is_named_expr() { + format!(" if ({})", locator.slice(test.range())) + } else { + format!(" if {}", locator.slice(test.range())) + } + } + None => String::new(), + }; + + // if the loop target was an implicit tuple, add parentheses around it + // ```python + // for i in a, b: + // ... + // ``` + // becomes + // [... for i in (a, b)] + let for_iter_str = if for_stmt + .iter + .as_ref() + .as_tuple_expr() + .is_some_and(|expr| !expr.parenthesized) + { + format!("({})", locator.slice(for_stmt.iter.range())) + } else { + locator.slice(for_stmt.iter.range()).to_string() + }; + + let for_type = if for_stmt.is_async { + "async for" + } else { + "for" + }; + let target_str = locator.slice(for_stmt.target.range()); + let elt_str = locator.slice(to_append); + let generator_str = format!("{elt_str} {for_type} {target_str} in {for_iter_str}{if_str}"); + + let variable_name = locator.slice(binding); + let for_loop_inline_comments = comment_strings_in_range( + checker, + for_stmt.range, + &[to_append.range(), for_stmt.iter.range()], + ); + + let newline = checker.stylist().line_ending().as_str(); + + let indent = locator.slice(TextRange::new( + locator.line_start(for_stmt.range.start()), + for_stmt.range.start(), )); + + match fix_type { + ComprehensionType::Extend => { + let generator_str = if for_stmt.is_async { + // generators do not implement __iter__, so `async for` requires the generator to be a list + format!("[{generator_str}]") + } else { + generator_str + }; + + let comprehension_body = format!("{variable_name}.extend({generator_str})"); + + let indentation = if for_loop_inline_comments.is_empty() { + String::new() + } else { + format!("{newline}{indent}") + }; + let text_to_replace = format!( + "{}{indentation}{comprehension_body}", + for_loop_inline_comments.join(&indentation) + ); + Ok(Fix::unsafe_edit(Edit::range_replacement( + text_to_replace, + for_stmt.range, + ))) + } + ComprehensionType::ListComprehension => { + let binding_stmt = binding.statement(semantic); + let binding_stmt_range = binding_stmt + .and_then(|stmt| match stmt { + ast::Stmt::AnnAssign(assign) => Some(assign.range), + ast::Stmt::Assign(assign) => Some(assign.range), + _ => None, + }) + .ok_or(anyhow!( + "Binding must have a statement to convert into a list comprehension" + ))?; + + // If there are multiple binding statements in one line, we don't want to accidentally delete them + // Instead, we just delete the binding statement and leave any comments where they are + let (binding_stmt_deletion_range, binding_is_multiple_stmts) = + statement_deletion_range(checker, binding_stmt_range); + + let annotations = match binding_stmt.and_then(|stmt| stmt.as_ann_assign_stmt()) { + Some(assign) => format!(": {}", locator.slice(assign.annotation.range())), + None => String::new(), + }; + + let comments_to_move = if binding_is_multiple_stmts { + for_loop_inline_comments + } else { + let mut new_comments = + comment_strings_in_range(checker, binding_stmt_deletion_range, &[]); + new_comments.extend(for_loop_inline_comments); + new_comments + }; + + let indentation = if comments_to_move.is_empty() { + String::new() + } else { + format!("{newline}{indent}") + }; + let leading_comments = format!("{}{indentation}", comments_to_move.join(&indentation)); + + let comprehension_body = + format!("{leading_comments}{variable_name}{annotations} = [{generator_str}]"); + + Ok(Fix::unsafe_edits( + Edit::range_deletion(binding_stmt_deletion_range), + [Edit::range_replacement(comprehension_body, for_stmt.range)], + )) + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum ComprehensionType { + Extend, + ListComprehension, } diff --git a/crates/ruff_linter/src/rules/perflint/rules/manual_list_copy.rs b/crates/ruff_linter/src/rules/perflint/rules/manual_list_copy.rs index 5b5843a9a9cc0..d42d78d0f61f8 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/manual_list_copy.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/manual_list_copy.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::{self as ast, Arguments, Expr, Stmt}; use ruff_python_semantic::analyze::typing::is_list; @@ -34,18 +34,18 @@ use crate::checkers::ast::Checker; /// original = list(range(10000)) /// filtered = list(original) /// ``` -#[violation] -pub struct ManualListCopy; +#[derive(ViolationMetadata)] +pub(crate) struct ManualListCopy; impl Violation for ManualListCopy { #[derive_message_formats] fn message(&self) -> String { - format!("Use `list` or `list.copy` to create a copy of a list") + "Use `list` or `list.copy` to create a copy of a list".to_string() } } /// PERF402 -pub(crate) fn manual_list_copy(checker: &mut Checker, for_stmt: &ast::StmtFor) { +pub(crate) fn manual_list_copy(checker: &Checker, for_stmt: &ast::StmtFor) { if for_stmt.is_async { return; } @@ -93,7 +93,7 @@ pub(crate) fn manual_list_copy(checker: &mut Checker, for_stmt: &ast::StmtFor) { } // Only flag direct list copies (e.g., `for x in y: filtered.append(x)`). - if !arg.as_name_expr().is_some_and(|arg| arg.id == *id) { + if arg.as_name_expr().is_none_or(|arg| arg.id != *id) { return; } @@ -119,7 +119,5 @@ pub(crate) fn manual_list_copy(checker: &mut Checker, for_stmt: &ast::StmtFor) { return; } - checker - .diagnostics - .push(Diagnostic::new(ManualListCopy, *range)); + checker.report_diagnostic(Diagnostic::new(ManualListCopy, *range)); } diff --git a/crates/ruff_linter/src/rules/perflint/rules/try_except_in_loop.rs b/crates/ruff_linter/src/rules/perflint/rules/try_except_in_loop.rs index 0fe6e87ce8798..49c4a29c635a0 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/try_except_in_loop.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/try_except_in_loop.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for uses of except handling via `try`-`except` within `for` and @@ -77,19 +77,19 @@ use crate::settings::types::PythonVersion; /// /// ## Options /// - `target-version` -#[violation] -pub struct TryExceptInLoop; +#[derive(ViolationMetadata)] +pub(crate) struct TryExceptInLoop; impl Violation for TryExceptInLoop { #[derive_message_formats] fn message(&self) -> String { - format!("`try`-`except` within a loop incurs performance overhead") + "`try`-`except` within a loop incurs performance overhead".to_string() } } /// PERF203 -pub(crate) fn try_except_in_loop(checker: &mut Checker, body: &[Stmt]) { - if checker.settings.target_version >= PythonVersion::Py311 { +pub(crate) fn try_except_in_loop(checker: &Checker, body: &[Stmt]) { + if checker.target_version() >= PythonVersion::PY311 { return; } @@ -107,9 +107,7 @@ pub(crate) fn try_except_in_loop(checker: &mut Checker, body: &[Stmt]) { return; } - checker - .diagnostics - .push(Diagnostic::new(TryExceptInLoop, handler.range())); + checker.report_diagnostic(Diagnostic::new(TryExceptInLoop, handler.range())); } /// Returns `true` if a `break` or `continue` statement is present in `body`. diff --git a/crates/ruff_linter/src/rules/perflint/rules/unnecessary_list_cast.rs b/crates/ruff_linter/src/rules/perflint/rules/unnecessary_list_cast.rs index d3fae55e3d566..19b2c0b08ad39 100644 --- a/crates/ruff_linter/src/rules/perflint/rules/unnecessary_list_cast.rs +++ b/crates/ruff_linter/src/rules/perflint/rules/unnecessary_list_cast.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Arguments, Expr, Stmt}; use ruff_python_semantic::analyze::typing::find_assigned_value; use ruff_text_size::TextRange; @@ -35,22 +35,22 @@ use crate::checkers::ast::Checker; /// for i in items: /// print(i) /// ``` -#[violation] -pub struct UnnecessaryListCast; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryListCast; impl AlwaysFixableViolation for UnnecessaryListCast { #[derive_message_formats] fn message(&self) -> String { - format!("Do not cast an iterable to `list` before iterating over it") + "Do not cast an iterable to `list` before iterating over it".to_string() } fn fix_title(&self) -> String { - format!("Remove `list()` cast") + "Remove `list()` cast".to_string() } } /// PERF101 -pub(crate) fn unnecessary_list_cast(checker: &mut Checker, iter: &Expr, body: &[Stmt]) { +pub(crate) fn unnecessary_list_cast(checker: &Checker, iter: &Expr, body: &[Stmt]) { let Expr::Call(ast::ExprCall { func, arguments: @@ -88,7 +88,7 @@ pub(crate) fn unnecessary_list_cast(checker: &mut Checker, iter: &Expr, body: &[ }) => { let mut diagnostic = Diagnostic::new(UnnecessaryListCast, *list_range); diagnostic.set_fix(remove_cast(*list_range, *iterable_range)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Expr::Name(ast::ExprName { id, @@ -116,7 +116,7 @@ pub(crate) fn unnecessary_list_cast(checker: &mut Checker, iter: &Expr, body: &[ let mut diagnostic = Diagnostic::new(UnnecessaryListCast, *list_range); diagnostic.set_fix(remove_cast(*list_range, *iterable_range)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } _ => {} diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF101_PERF101.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF101_PERF101.py.snap index bf33ecd3e3457..fd545e136452c 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF101_PERF101.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF101_PERF101.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/perflint/mod.rs PERF101.py:7:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 5 | foo_int = 123 -6 | +6 | 7 | for i in list(foo_tuple): # PERF101 | ^^^^^^^^^^^^^^^ PERF101 8 | pass @@ -24,7 +24,7 @@ PERF101.py:7:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:10:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 8 | pass - 9 | + 9 | 10 | for i in list(foo_list): # PERF101 | ^^^^^^^^^^^^^^ PERF101 11 | pass @@ -44,7 +44,7 @@ PERF101.py:10:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:13:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 11 | pass -12 | +12 | 13 | for i in list(foo_set): # PERF101 | ^^^^^^^^^^^^^ PERF101 14 | pass @@ -64,7 +64,7 @@ PERF101.py:13:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:16:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 14 | pass -15 | +15 | 16 | for i in list((1, 2, 3)): # PERF101 | ^^^^^^^^^^^^^^^ PERF101 17 | pass @@ -84,7 +84,7 @@ PERF101.py:16:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:19:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 17 | pass -18 | +18 | 19 | for i in list([1, 2, 3]): # PERF101 | ^^^^^^^^^^^^^^^ PERF101 20 | pass @@ -104,7 +104,7 @@ PERF101.py:19:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:22:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 20 | pass -21 | +21 | 22 | for i in list({1, 2, 3}): # PERF101 | ^^^^^^^^^^^^^^^ PERF101 23 | pass @@ -124,7 +124,7 @@ PERF101.py:22:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:25:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 23 | pass -24 | +24 | 25 | for i in list( | __________^ 26 | | { @@ -158,7 +158,7 @@ PERF101.py:25:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:34:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 32 | pass -33 | +33 | 34 | for i in list( # Comment | __________^ 35 | | {1, 2, 3} @@ -183,7 +183,7 @@ PERF101.py:34:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:57:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 55 | foo_list.append(i + 1) -56 | +56 | 57 | for i in list(foo_list): # PERF101 | ^^^^^^^^^^^^^^ PERF101 58 | # Make sure we match the correct list @@ -204,7 +204,7 @@ PERF101.py:57:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:69:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 67 | x, y, nested_tuple = (1, 2, (3, 4, 5)) -68 | +68 | 69 | for i in list(nested_tuple): # PERF101 | ^^^^^^^^^^^^^^^^^^ PERF101 70 | pass @@ -224,7 +224,7 @@ PERF101.py:69:10: PERF101 [*] Do not cast an iterable to `list` before iterating PERF101.py:86:10: PERF101 [*] Do not cast an iterable to `list` before iterating over it | 84 | import builtins -85 | +85 | 86 | for i in builtins.list(nested_tuple): # PERF101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PERF101 87 | pass diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF102_PERF102.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF102_PERF102.py.snap index f572521714595..8598ae0e0b363 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF102_PERF102.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF102_PERF102.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/perflint/mod.rs +snapshot_kind: text --- PERF102.py:5:21: PERF102 [*] When using only the values of a dict use the `values()` method | @@ -227,5 +228,3 @@ PERF102.py:106:16: PERF102 [*] When using only the keys of a dict use the `keys( 106 |- for(B,D)in A.items(): 106 |+ for B in A.keys(): 107 107 | if(C:=name_to_value.get(B.name)):A.run(B.set,C) - - diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF203_PERF203.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF203_PERF203.py.snap index e67fdafc2469f..f0cc3e1d1fcd4 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF203_PERF203.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF203_PERF203.py.snap @@ -5,12 +5,9 @@ PERF203.py:5:5: PERF203 `try`-`except` within a loop incurs performance overhead | 3 | try: 4 | print(f"{i}") -5 | except: - | _____^ +5 | / except: 6 | | print("error") | |______________________^ PERF203 -7 | +7 | 8 | # OK | - - diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF401_PERF401.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF401_PERF401.py.snap index ae0dcb8e5a10f..92d7d6df85ba4 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF401_PERF401.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF401_PERF401.py.snap @@ -8,6 +8,7 @@ PERF401.py:6:13: PERF401 Use a list comprehension to create a transformed list 6 | result.append(i) # PERF401 | ^^^^^^^^^^^^^^^^ PERF401 | + = help: Replace for loop with list comprehension PERF401.py:13:9: PERF401 Use a list comprehension to create a transformed list | @@ -16,6 +17,7 @@ PERF401.py:13:9: PERF401 Use a list comprehension to create a transformed list 13 | result.append(i * i) # PERF401 | ^^^^^^^^^^^^^^^^^^^^ PERF401 | + = help: Replace for loop with list comprehension PERF401.py:82:13: PERF401 Use an async list comprehension to create a transformed list | @@ -24,6 +26,7 @@ PERF401.py:82:13: PERF401 Use an async list comprehension to create a transforme 82 | result.append(i) # PERF401 | ^^^^^^^^^^^^^^^^ PERF401 | + = help: Replace for loop with list comprehension PERF401.py:89:9: PERF401 Use an async list comprehension to create a transformed list | @@ -32,3 +35,189 @@ PERF401.py:89:9: PERF401 Use an async list comprehension to create a transformed 89 | result.append(i) # PERF401 | ^^^^^^^^^^^^^^^^ PERF401 | + = help: Replace for loop with list comprehension + +PERF401.py:96:9: PERF401 Use `list.extend` with an async comprehension to create a transformed list + | +94 | result = [1, 2] +95 | async for i in items: +96 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +PERF401.py:102:9: PERF401 Use `list.extend` to create a transformed list + | +100 | result, _ = [1, 2, 3, 4], ... +101 | for i in range(10): +102 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +PERF401.py:111:17: PERF401 Use `list.extend` to create a transformed list + | +109 | # single-line comment 2 should be protected +110 | if i % 2: # single-line comment 3 should be protected +111 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +PERF401.py:119:13: PERF401 Use a list comprehension to create a transformed list + | +117 | # single-line comment 2 should be protected +118 | if i % 2: # single-line comment 3 should be protected +119 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:135:13: PERF401 Use a list comprehension to create a transformed list + | +133 | new_layers = [] +134 | for value in param: +135 | new_layers.append(value * 3) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:142:9: PERF401 Use a list comprehension to create a transformed list + | +140 | var = 1 +141 | for _ in range(10): +142 | result.append(var + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:149:9: PERF401 Use a list comprehension to create a transformed list + | +147 | tmp = 1; result = [] # comment should be protected +148 | for i in range(10): +149 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:156:9: PERF401 Use a list comprehension to create a transformed list + | +154 | result = []; tmp = 1 # comment should be protected +155 | for i in range(10): +156 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:162:9: PERF401 Use a list comprehension to create a transformed list + | +160 | result = [] # comment should be protected +161 | for i in range(10): +162 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:169:9: PERF401 Use `list.extend` to create a transformed list + | +167 | result.append(1) +168 | for i in range(10): +169 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +PERF401.py:189:9: PERF401 Use a list comprehension to create a transformed list + | +187 | result = [] +188 | for val in range(5): +189 | result.append(val * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^ PERF401 +190 | val = 1 +191 | print(val) + | + = help: Replace for loop with list comprehension + +PERF401.py:198:9: PERF401 Use a list comprehension to create a transformed list + | +196 | result = [] +197 | for i in i: +198 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:210:13: PERF401 Use a list comprehension to create a transformed list + | +208 | ): # Comment 3 +209 | if i % 2: # Comment 4 +210 | / result.append( +211 | | ( +212 | | i + 1, +213 | | # Comment 5 +214 | | 2, +215 | | ) +216 | | ) # PERF401 + | |_____________^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:222:9: PERF401 Use a list comprehension to create a transformed list + | +220 | result: list[int] = [] +221 | for i in range(10): +222 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +PERF401.py:229:9: PERF401 Use a list comprehension to create a transformed list + | +227 | result = [] +228 | for i in a, b: +229 | result.append(i[0] + i[1]) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PERF401 +230 | return result + | + = help: Replace for loop with list comprehension + +PERF401.py:239:9: PERF401 Use a list comprehension to create a transformed list + | +237 | print(a) +238 | for a in values: +239 | result.append(a + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 +240 | +241 | def f(): + | + = help: Replace for loop with list comprehension + +PERF401.py:245:13: PERF401 Use `list.extend` to create a transformed list + | +243 | def g(): +244 | for a in values: +245 | result.append(a + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 +246 | result = [] + | + = help: Replace for loop with list.extend + +PERF401.py:262:13: PERF401 Use a list comprehension to create a transformed list + | +260 | for i in range(5): +261 | if j := i: +262 | items.append(j) + | ^^^^^^^^^^^^^^^ PERF401 +263 | +264 | def f(): + | + = help: Replace for loop with list comprehension + +PERF401.py:268:9: PERF401 Use a list comprehension to create a transformed list + | +266 | result = list() # this should be replaced with a comprehension +267 | for i in values: +268 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF402_PERF402.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF402_PERF402.py.snap index 08bcfb4a0cd46..e064b13123d0d 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF402_PERF402.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF402_PERF402.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/perflint/mod.rs +snapshot_kind: text --- PERF402.py:5:9: PERF402 Use `list` or `list.copy` to create a copy of a list | @@ -8,5 +9,3 @@ PERF402.py:5:9: PERF402 Use `list` or `list.copy` to create a copy of a list 5 | result.append(i) # PERF402 | ^^^^^^^^^^^^^^^^ PERF402 | - - diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF403_PERF403.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF403_PERF403.py.snap index f0418ee5542ed..2615a1772d1b0 100644 --- a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF403_PERF403.py.snap +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF403_PERF403.py.snap @@ -8,6 +8,7 @@ PERF403.py:5:9: PERF403 Use a dictionary comprehension instead of a for-loop 5 | result[idx] = name # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension PERF403.py:13:13: PERF403 Use a dictionary comprehension instead of a for-loop | @@ -16,43 +17,114 @@ PERF403.py:13:13: PERF403 Use a dictionary comprehension instead of a for-loop 13 | result[idx] = name # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension -PERF403.py:31:13: PERF403 Use a dictionary comprehension instead of a for-loop +PERF403.py:33:13: PERF403 Use a dictionary comprehension instead of a for-loop | -29 | for idx, name in enumerate(fruit): -30 | if idx % 2: -31 | result[idx] = name # PERF403 +31 | for idx, name in enumerate(fruit): +32 | if idx % 2: +33 | result[idx] = name # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension -PERF403.py:61:13: PERF403 Use a dictionary comprehension instead of a for-loop +PERF403.py:63:13: PERF403 Use a dictionary comprehension instead of a for-loop | -59 | for idx, name in enumerate(fruit): -60 | if idx % 2: -61 | result[idx] = name # PERF403 +61 | for idx, name in enumerate(fruit): +62 | if idx % 2: +63 | result[idx] = name # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension -PERF403.py:76:9: PERF403 Use a dictionary comprehension instead of a for-loop +PERF403.py:78:9: PERF403 Use a dictionary comprehension instead of a for-loop | -74 | result = {} -75 | for name in fruit: -76 | result[name] = name # PERF403 +76 | result = {} +77 | for name in fruit: +78 | result[name] = name # PERF403 | ^^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension -PERF403.py:83:9: PERF403 Use a dictionary comprehension instead of a for-loop +PERF403.py:85:9: PERF403 Use a dictionary comprehension instead of a for-loop | -81 | result = {} -82 | for idx, name in enumerate(fruit): -83 | result[name] = idx # PERF403 +83 | result = {} +84 | for idx, name in enumerate(fruit): +85 | result[name] = idx # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension -PERF403.py:91:9: PERF403 Use a dictionary comprehension instead of a for-loop +PERF403.py:94:9: PERF403 Use a dictionary comprehension instead of a for-loop | -89 | result = SneakyDict() -90 | for idx, name in enumerate(fruit): -91 | result[name] = idx # PERF403 +92 | result = SneakyDict() +93 | for idx, name in enumerate(fruit): +94 | result[name] = idx # PERF403 | ^^^^^^^^^^^^^^^^^^ PERF403 | + = help: Replace for loop with dict comprehension + +PERF403.py:106:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +104 | ): +105 | # comment 3 +106 | / result[ +107 | | name # comment 4 +108 | | ] = idx # PERF403 + | |_______________^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:115:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +113 | a = 1; result = {}; b = 2 +114 | for idx, name in enumerate(fruit): +115 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:122:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +120 | result = {"kiwi": 3} +121 | for idx, name in enumerate(fruit): +122 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:129:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +127 | (_, result) = (None, {"kiwi": 3}) +128 | for idx, name in enumerate(fruit): +129 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:137:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +135 | print(len(result)) +136 | for idx, name in enumerate(fruit): +137 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:145:13: PERF403 Use a dictionary comprehension instead of a for-loop + | +143 | for idx, name in enumerate(fruit): +144 | if last_idx := idx % 3: +145 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +PERF403.py:153:9: PERF403 Use a dictionary comprehension instead of a for-loop + | +151 | result = {} +152 | for idx, name in indices, fruit: +153 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF401_PERF401.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF401_PERF401.py.snap new file mode 100644 index 0000000000000..35f6a6bd927d4 --- /dev/null +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF401_PERF401.py.snap @@ -0,0 +1,531 @@ +--- +source: crates/ruff_linter/src/rules/perflint/mod.rs +--- +PERF401.py:6:13: PERF401 [*] Use a list comprehension to create a transformed list + | +4 | for i in items: +5 | if i % 2: +6 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +1 1 | def f(): +2 2 | items = [1, 2, 3, 4] +3 |- result = [] +4 |- for i in items: +5 |- if i % 2: +6 |- result.append(i) # PERF401 + 3 |+ result = [i for i in items if i % 2] # PERF401 +7 4 | +8 5 | +9 6 | def f(): + +PERF401.py:13:9: PERF401 [*] Use a list comprehension to create a transformed list + | +11 | result = [] +12 | for i in items: +13 | result.append(i * i) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +8 8 | +9 9 | def f(): +10 10 | items = [1, 2, 3, 4] +11 |- result = [] +12 |- for i in items: +13 |- result.append(i * i) # PERF401 + 11 |+ result = [i * i for i in items] # PERF401 +14 12 | +15 13 | +16 14 | def f(): + +PERF401.py:82:13: PERF401 [*] Use an async list comprehension to create a transformed list + | +80 | async for i in items: +81 | if i % 2: +82 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +76 76 | +77 77 | async def f(): +78 78 | items = [1, 2, 3, 4] +79 |- result = [] +80 |- async for i in items: +81 |- if i % 2: +82 |- result.append(i) # PERF401 + 79 |+ result = [i async for i in items if i % 2] # PERF401 +83 80 | +84 81 | +85 82 | async def f(): + +PERF401.py:89:9: PERF401 [*] Use an async list comprehension to create a transformed list + | +87 | result = [] +88 | async for i in items: +89 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +84 84 | +85 85 | async def f(): +86 86 | items = [1, 2, 3, 4] +87 |- result = [] +88 |- async for i in items: +89 |- result.append(i) # PERF401 + 87 |+ result = [i async for i in items] # PERF401 +90 88 | +91 89 | +92 90 | async def f(): + +PERF401.py:96:9: PERF401 [*] Use `list.extend` with an async comprehension to create a transformed list + | +94 | result = [1, 2] +95 | async for i in items: +96 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +ℹ Unsafe fix +92 92 | async def f(): +93 93 | items = [1, 2, 3, 4] +94 94 | result = [1, 2] +95 |- async for i in items: +96 |- result.append(i) # PERF401 + 95 |+ result.extend([i async for i in items]) # PERF401 +97 96 | +98 97 | +99 98 | def f(): + +PERF401.py:102:9: PERF401 [*] Use `list.extend` to create a transformed list + | +100 | result, _ = [1, 2, 3, 4], ... +101 | for i in range(10): +102 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +ℹ Unsafe fix +98 98 | +99 99 | def f(): +100 100 | result, _ = [1, 2, 3, 4], ... +101 |- for i in range(10): +102 |- result.append(i * 2) # PERF401 + 101 |+ result.extend(i * 2 for i in range(10)) # PERF401 +103 102 | +104 103 | +105 104 | def f(): + +PERF401.py:111:17: PERF401 [*] Use `list.extend` to create a transformed list + | +109 | # single-line comment 2 should be protected +110 | if i % 2: # single-line comment 3 should be protected +111 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +ℹ Unsafe fix +105 105 | def f(): +106 106 | result = [] +107 107 | if True: +108 |- for i in range(10): # single-line comment 1 should be protected +109 |- # single-line comment 2 should be protected +110 |- if i % 2: # single-line comment 3 should be protected +111 |- result.append(i) # PERF401 + 108 |+ # single-line comment 1 should be protected + 109 |+ # single-line comment 2 should be protected + 110 |+ # single-line comment 3 should be protected + 111 |+ result.extend(i for i in range(10) if i % 2) # PERF401 +112 112 | +113 113 | +114 114 | def f(): + +PERF401.py:119:13: PERF401 [*] Use a list comprehension to create a transformed list + | +117 | # single-line comment 2 should be protected +118 | if i % 2: # single-line comment 3 should be protected +119 | result.append(i) # PERF401 + | ^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +112 112 | +113 113 | +114 114 | def f(): +115 |- result = [] # comment after assignment should be protected +116 |- for i in range(10): # single-line comment 1 should be protected +117 |- # single-line comment 2 should be protected +118 |- if i % 2: # single-line comment 3 should be protected +119 |- result.append(i) # PERF401 + 115 |+ # comment after assignment should be protected + 116 |+ # single-line comment 1 should be protected + 117 |+ # single-line comment 2 should be protected + 118 |+ # single-line comment 3 should be protected + 119 |+ result = [i for i in range(10) if i % 2] # PERF401 +120 120 | +121 121 | +122 122 | def f(): + +PERF401.py:135:13: PERF401 [*] Use a list comprehension to create a transformed list + | +133 | new_layers = [] +134 | for value in param: +135 | new_layers.append(value * 3) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +130 130 | # PERF401 +131 131 | # make sure the fix does not panic if there is no comments +132 132 | if param: +133 |- new_layers = [] +134 |- for value in param: +135 |- new_layers.append(value * 3) + 133 |+ new_layers = [value * 3 for value in param] +136 134 | +137 135 | +138 136 | def f(): + +PERF401.py:142:9: PERF401 [*] Use a list comprehension to create a transformed list + | +140 | var = 1 +141 | for _ in range(10): +142 | result.append(var + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +136 136 | +137 137 | +138 138 | def f(): +139 |- result = [] +140 139 | var = 1 +141 |- for _ in range(10): +142 |- result.append(var + 1) # PERF401 + 140 |+ result = [var + 1 for _ in range(10)] # PERF401 +143 141 | +144 142 | +145 143 | def f(): + +PERF401.py:149:9: PERF401 [*] Use a list comprehension to create a transformed list + | +147 | tmp = 1; result = [] # comment should be protected +148 | for i in range(10): +149 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +144 144 | +145 145 | def f(): +146 146 | # make sure that `tmp` is not deleted +147 |- tmp = 1; result = [] # comment should be protected +148 |- for i in range(10): +149 |- result.append(i + 1) # PERF401 + 147 |+ tmp = 1 # comment should be protected + 148 |+ result = [i + 1 for i in range(10)] # PERF401 +150 149 | +151 150 | +152 151 | def f(): + +PERF401.py:156:9: PERF401 [*] Use a list comprehension to create a transformed list + | +154 | result = []; tmp = 1 # comment should be protected +155 | for i in range(10): +156 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +151 151 | +152 152 | def f(): +153 153 | # make sure that `tmp` is not deleted +154 |- result = []; tmp = 1 # comment should be protected +155 |- for i in range(10): +156 |- result.append(i + 1) # PERF401 + 154 |+ tmp = 1 # comment should be protected + 155 |+ result = [i + 1 for i in range(10)] # PERF401 +157 156 | +158 157 | +159 158 | def f(): + +PERF401.py:162:9: PERF401 [*] Use a list comprehension to create a transformed list + | +160 | result = [] # comment should be protected +161 | for i in range(10): +162 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +157 157 | +158 158 | +159 159 | def f(): +160 |- result = [] # comment should be protected +161 |- for i in range(10): +162 |- result.append(i * 2) # PERF401 + 160 |+ # comment should be protected + 161 |+ result = [i * 2 for i in range(10)] # PERF401 +163 162 | +164 163 | +165 164 | def f(): + +PERF401.py:169:9: PERF401 [*] Use `list.extend` to create a transformed list + | +167 | result.append(1) +168 | for i in range(10): +169 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list.extend + +ℹ Unsafe fix +165 165 | def f(): +166 166 | result = [] +167 167 | result.append(1) +168 |- for i in range(10): +169 |- result.append(i * 2) # PERF401 + 168 |+ result.extend(i * 2 for i in range(10)) # PERF401 +170 169 | +171 170 | +172 171 | def f(): + +PERF401.py:189:9: PERF401 [*] Use a list comprehension to create a transformed list + | +187 | result = [] +188 | for val in range(5): +189 | result.append(val * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^ PERF401 +190 | val = 1 +191 | print(val) + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +184 184 | +185 185 | +186 186 | def f(): +187 |- result = [] +188 |- for val in range(5): +189 |- result.append(val * 2) # PERF401 + 187 |+ result = [val * 2 for val in range(5)] # PERF401 +190 188 | val = 1 +191 189 | print(val) +192 190 | + +PERF401.py:198:9: PERF401 [*] Use a list comprehension to create a transformed list + | +196 | result = [] +197 | for i in i: +198 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +193 193 | +194 194 | def f(): +195 195 | i = [1, 2, 3] +196 |- result = [] +197 |- for i in i: +198 |- result.append(i + 1) # PERF401 + 196 |+ result = [i + 1 for i in i] # PERF401 +199 197 | +200 198 | +201 199 | def f(): + +PERF401.py:210:13: PERF401 [*] Use a list comprehension to create a transformed list + | +208 | ): # Comment 3 +209 | if i % 2: # Comment 4 +210 | / result.append( +211 | | ( +212 | | i + 1, +213 | | # Comment 5 +214 | | 2, +215 | | ) +216 | | ) # PERF401 + | |_____________^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +199 199 | +200 200 | +201 201 | def f(): +202 |- result = [] +203 |- for i in range( # Comment 1 should not be duplicated + 202 |+ # Comment 3 + 203 |+ # Comment 4 + 204 |+ result = [( + 205 |+ i + 1, + 206 |+ # Comment 5 + 207 |+ 2, + 208 |+ ) for i in range( # Comment 1 should not be duplicated +204 209 | ( +205 210 | 2 # Comment 2 +206 211 | + 1 +207 212 | ) +208 |- ): # Comment 3 +209 |- if i % 2: # Comment 4 +210 |- result.append( +211 |- ( +212 |- i + 1, +213 |- # Comment 5 +214 |- 2, +215 |- ) +216 |- ) # PERF401 + 213 |+ ) if i % 2] # PERF401 +217 214 | +218 215 | +219 216 | def f(): + +PERF401.py:222:9: PERF401 [*] Use a list comprehension to create a transformed list + | +220 | result: list[int] = [] +221 | for i in range(10): +222 | result.append(i * 2) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +217 217 | +218 218 | +219 219 | def f(): +220 |- result: list[int] = [] +221 |- for i in range(10): +222 |- result.append(i * 2) # PERF401 + 220 |+ result: list[int] = [i * 2 for i in range(10)] # PERF401 +223 221 | +224 222 | +225 223 | def f(): + +PERF401.py:229:9: PERF401 [*] Use a list comprehension to create a transformed list + | +227 | result = [] +228 | for i in a, b: +229 | result.append(i[0] + i[1]) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PERF401 +230 | return result + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +224 224 | +225 225 | def f(): +226 226 | a, b = [1, 2, 3], [4, 5, 6] +227 |- result = [] +228 |- for i in a, b: +229 |- result.append(i[0] + i[1]) # PERF401 + 227 |+ result = [i[0] + i[1] for i in (a, b)] # PERF401 +230 228 | return result +231 229 | +232 230 | + +PERF401.py:239:9: PERF401 [*] Use a list comprehension to create a transformed list + | +237 | print(a) +238 | for a in values: +239 | result.append(a + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 +240 | +241 | def f(): + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +232 232 | +233 233 | def f(): +234 234 | values = [1, 2, 3] +235 |- result = [] +236 235 | for a in values: +237 236 | print(a) +238 |- for a in values: +239 |- result.append(a + 1) # PERF401 + 237 |+ result = [a + 1 for a in values] # PERF401 +240 238 | +241 239 | def f(): +242 240 | values = [1, 2, 3] + +PERF401.py:245:13: PERF401 [*] Use `list.extend` to create a transformed list + | +243 | def g(): +244 | for a in values: +245 | result.append(a + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 +246 | result = [] + | + = help: Replace for loop with list.extend + +ℹ Unsafe fix +241 241 | def f(): +242 242 | values = [1, 2, 3] +243 243 | def g(): +244 |- for a in values: +245 |- result.append(a + 1) # PERF401 + 244 |+ result.extend(a + 1 for a in values) # PERF401 +246 245 | result = [] +247 246 | +248 247 | def f(): + +PERF401.py:262:13: PERF401 [*] Use a list comprehension to create a transformed list + | +260 | for i in range(5): +261 | if j := i: +262 | items.append(j) + | ^^^^^^^^^^^^^^^ PERF401 +263 | +264 | def f(): + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +255 255 | # The fix here must parenthesize the walrus operator +256 256 | # https://github.com/astral-sh/ruff/issues/15047 +257 257 | def f(): +258 |- items = [] +259 258 | +260 |- for i in range(5): +261 |- if j := i: +262 |- items.append(j) + 259 |+ items = [j for i in range(5) if (j := i)] +263 260 | +264 261 | def f(): +265 262 | values = [1, 2, 3] + +PERF401.py:268:9: PERF401 [*] Use a list comprehension to create a transformed list + | +266 | result = list() # this should be replaced with a comprehension +267 | for i in values: +268 | result.append(i + 1) # PERF401 + | ^^^^^^^^^^^^^^^^^^^^ PERF401 + | + = help: Replace for loop with list comprehension + +ℹ Unsafe fix +263 263 | +264 264 | def f(): +265 265 | values = [1, 2, 3] +266 |- result = list() # this should be replaced with a comprehension +267 |- for i in values: +268 |- result.append(i + 1) # PERF401 + 266 |+ # this should be replaced with a comprehension + 267 |+ result = [i + 1 for i in values] # PERF401 diff --git a/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF403_PERF403.py.snap b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF403_PERF403.py.snap new file mode 100644 index 0000000000000..9e01e0db30b48 --- /dev/null +++ b/crates/ruff_linter/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__preview__PERF403_PERF403.py.snap @@ -0,0 +1,307 @@ +--- +source: crates/ruff_linter/src/rules/perflint/mod.rs +--- +PERF403.py:5:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +3 | result = {} +4 | for idx, name in enumerate(fruit): +5 | result[idx] = name # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +1 1 | def foo(): +2 2 | fruit = ["apple", "pear", "orange"] +3 |- result = {} +4 |- for idx, name in enumerate(fruit): +5 |- result[idx] = name # PERF403 + 3 |+ result = {idx: name for idx, name in enumerate(fruit)} # PERF403 +6 4 | +7 5 | +8 6 | def foo(): + +PERF403.py:13:13: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +11 | for idx, name in enumerate(fruit): +12 | if idx % 2: +13 | result[idx] = name # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +7 7 | +8 8 | def foo(): +9 9 | fruit = ["apple", "pear", "orange"] +10 |- result = {} +11 |- for idx, name in enumerate(fruit): +12 |- if idx % 2: +13 |- result[idx] = name # PERF403 + 10 |+ result = {idx: name for idx, name in enumerate(fruit) if idx % 2} # PERF403 +14 11 | +15 12 | +16 13 | def foo(): + +PERF403.py:33:13: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +31 | for idx, name in enumerate(fruit): +32 | if idx % 2: +33 | result[idx] = name # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +26 26 | +27 27 | +28 28 | def foo(): +29 |- result = {} +30 29 | fruit = ["apple", "pear", "orange"] +31 |- for idx, name in enumerate(fruit): +32 |- if idx % 2: +33 |- result[idx] = name # PERF403 + 30 |+ result = {idx: name for idx, name in enumerate(fruit) if idx % 2} # PERF403 +34 31 | +35 32 | +36 33 | def foo(): + +PERF403.py:63:13: PERF403 [*] Use `dict.update` instead of a for-loop + | +61 | for idx, name in enumerate(fruit): +62 | if idx % 2: +63 | result[idx] = name # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with `dict.update` + +ℹ Unsafe fix +58 58 | def foo(): +59 59 | result = {1: "banana"} +60 60 | fruit = ["apple", "pear", "orange"] +61 |- for idx, name in enumerate(fruit): +62 |- if idx % 2: +63 |- result[idx] = name # PERF403 + 61 |+ result.update({idx: name for idx, name in enumerate(fruit) if idx % 2}) # PERF403 +64 62 | +65 63 | +66 64 | def foo(): + +PERF403.py:78:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +76 | result = {} +77 | for name in fruit: +78 | result[name] = name # PERF403 + | ^^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +73 73 | +74 74 | def foo(): +75 75 | fruit = ["apple", "pear", "orange"] +76 |- result = {} +77 |- for name in fruit: +78 |- result[name] = name # PERF403 + 76 |+ result = {name: name for name in fruit} # PERF403 +79 77 | +80 78 | +81 79 | def foo(): + +PERF403.py:85:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +83 | result = {} +84 | for idx, name in enumerate(fruit): +85 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +80 80 | +81 81 | def foo(): +82 82 | fruit = ["apple", "pear", "orange"] +83 |- result = {} +84 |- for idx, name in enumerate(fruit): +85 |- result[name] = idx # PERF403 + 83 |+ result = {name: idx for idx, name in enumerate(fruit)} # PERF403 +86 84 | +87 85 | +88 86 | def foo(): + +PERF403.py:94:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +92 | result = SneakyDict() +93 | for idx, name in enumerate(fruit): +94 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +89 89 | from builtins import dict as SneakyDict +90 90 | +91 91 | fruit = ["apple", "pear", "orange"] +92 |- result = SneakyDict() +93 |- for idx, name in enumerate(fruit): +94 |- result[name] = idx # PERF403 + 92 |+ result = {name: idx for idx, name in enumerate(fruit)} # PERF403 +95 93 | +96 94 | +97 95 | def foo(): + +PERF403.py:106:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +104 | ): +105 | # comment 3 +106 | / result[ +107 | | name # comment 4 +108 | | ] = idx # PERF403 + | |_______________^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +96 96 | +97 97 | def foo(): +98 98 | fruit = ["apple", "pear", "orange"] +99 |- result: dict[str, int] = { +100 |- # comment 1 +101 |- } +102 |- for idx, name in enumerate( + 99 |+ # comment 1 + 100 |+ # comment 3 + 101 |+ # comment 4 + 102 |+ result: dict[str, int] = {name: idx for idx, name in enumerate( +103 103 | fruit # comment 2 +104 |- ): +105 |- # comment 3 +106 |- result[ +107 |- name # comment 4 +108 |- ] = idx # PERF403 + 104 |+ )} # PERF403 +109 105 | +110 106 | +111 107 | def foo(): + +PERF403.py:115:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +113 | a = 1; result = {}; b = 2 +114 | for idx, name in enumerate(fruit): +115 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +110 110 | +111 111 | def foo(): +112 112 | fruit = ["apple", "pear", "orange"] +113 |- a = 1; result = {}; b = 2 +114 |- for idx, name in enumerate(fruit): +115 |- result[name] = idx # PERF403 + 113 |+ a = 1; b = 2 + 114 |+ result = {name: idx for idx, name in enumerate(fruit)} # PERF403 +116 115 | +117 116 | +118 117 | def foo(): + +PERF403.py:122:9: PERF403 [*] Use `dict.update` instead of a for-loop + | +120 | result = {"kiwi": 3} +121 | for idx, name in enumerate(fruit): +122 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with `dict.update` + +ℹ Unsafe fix +118 118 | def foo(): +119 119 | fruit = ["apple", "pear", "orange"] +120 120 | result = {"kiwi": 3} +121 |- for idx, name in enumerate(fruit): +122 |- result[name] = idx # PERF403 + 121 |+ result.update({name: idx for idx, name in enumerate(fruit)}) # PERF403 +123 122 | +124 123 | +125 124 | def foo(): + +PERF403.py:129:9: PERF403 [*] Use `dict.update` instead of a for-loop + | +127 | (_, result) = (None, {"kiwi": 3}) +128 | for idx, name in enumerate(fruit): +129 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with `dict.update` + +ℹ Unsafe fix +125 125 | def foo(): +126 126 | fruit = ["apple", "pear", "orange"] +127 127 | (_, result) = (None, {"kiwi": 3}) +128 |- for idx, name in enumerate(fruit): +129 |- result[name] = idx # PERF403 + 128 |+ result.update({name: idx for idx, name in enumerate(fruit)}) # PERF403 +130 129 | +131 130 | +132 131 | def foo(): + +PERF403.py:137:9: PERF403 [*] Use `dict.update` instead of a for-loop + | +135 | print(len(result)) +136 | for idx, name in enumerate(fruit): +137 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with `dict.update` + +ℹ Unsafe fix +133 133 | fruit = ["apple", "pear", "orange"] +134 134 | result = {} +135 135 | print(len(result)) +136 |- for idx, name in enumerate(fruit): +137 |- result[name] = idx # PERF403 + 136 |+ result.update({name: idx for idx, name in enumerate(fruit)}) # PERF403 +138 137 | +139 138 | +140 139 | def foo(): + +PERF403.py:145:13: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +143 | for idx, name in enumerate(fruit): +144 | if last_idx := idx % 3: +145 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +139 139 | +140 140 | def foo(): +141 141 | fruit = ["apple", "pear", "orange"] +142 |- result = {} +143 |- for idx, name in enumerate(fruit): +144 |- if last_idx := idx % 3: +145 |- result[name] = idx # PERF403 + 142 |+ result = {name: idx for idx, name in enumerate(fruit) if (last_idx := idx % 3)} # PERF403 +146 143 | +147 144 | +148 145 | def foo(): + +PERF403.py:153:9: PERF403 [*] Use a dictionary comprehension instead of a for-loop + | +151 | result = {} +152 | for idx, name in indices, fruit: +153 | result[name] = idx # PERF403 + | ^^^^^^^^^^^^^^^^^^ PERF403 + | + = help: Replace for loop with dict comprehension + +ℹ Unsafe fix +148 148 | def foo(): +149 149 | fruit = ["apple", "pear", "orange"] +150 150 | indices = [0, 1, 2] +151 |- result = {} +152 |- for idx, name in indices, fruit: +153 |- result[name] = idx # PERF403 + 151 |+ result = {name: idx for idx, name in (indices, fruit)} # PERF403 diff --git a/crates/ruff_linter/src/rules/pycodestyle/mod.rs b/crates/ruff_linter/src/rules/pycodestyle/mod.rs index 9850b51d8944b..d69989bdc68cd 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/mod.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/mod.rs @@ -26,8 +26,8 @@ mod tests { #[test_case(Rule::AmbiguousClassName, Path::new("E742.py"))] #[test_case(Rule::AmbiguousFunctionName, Path::new("E743.py"))] #[test_case(Rule::AmbiguousVariableName, Path::new("E741.py"))] - // E741 has different behaviour for `.pyi` files in preview mode; - // this test case checks it still has the old behaviour in stable mode + // E741 is disapplied for `.pyi` files (see #13119 for rationale); + // this fixture tests that we emit no errors there #[test_case(Rule::AmbiguousVariableName, Path::new("E741.pyi"))] #[test_case(Rule::LambdaAssignment, Path::new("E731.py"))] #[test_case(Rule::BareExcept, Path::new("E722.py"))] @@ -43,6 +43,9 @@ mod tests { #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_0.py"))] #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_1.py"))] #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_2.py"))] + #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_3.py"))] + #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_4.py"))] + #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402_5.py"))] #[test_case(Rule::ModuleImportNotAtTopOfFile, Path::new("E402.ipynb"))] #[test_case(Rule::MultipleImportsOnOneLine, Path::new("E40.py"))] #[test_case(Rule::MultipleStatementsOnOneLineColon, Path::new("E70.py"))] @@ -78,8 +81,7 @@ mod tests { #[test_case(Rule::TooManyNewlinesAtEndOfFile, Path::new("W391_2.py"))] #[test_case(Rule::TooManyNewlinesAtEndOfFile, Path::new("W391_3.py"))] #[test_case(Rule::TooManyNewlinesAtEndOfFile, Path::new("W391_4.py"))] - // E741 has different behaviour for `.pyi` files in preview mode - #[test_case(Rule::AmbiguousVariableName, Path::new("E741.pyi"))] + #[test_case(Rule::TooManyNewlinesAtEndOfFile, Path::new("W391.ipynb"))] fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!( "preview__{}_{}", @@ -255,7 +257,9 @@ mod tests { lines_after_imports: isize, lines_between_types: usize, ) -> Result<()> { - let snapshot = format!("too_many_blank_lines_isort_compatibility-lines-after({lines_after_imports})-between({lines_between_types})"); + let snapshot = format!( + "too_many_blank_lines_isort_compatibility-lines-after({lines_after_imports})-between({lines_between_types})" + ); let diagnostics = test_path( Path::new("pycodestyle").join("E30_isort.py"), &settings::LinterSettings { diff --git a/crates/ruff_linter/src/rules/pycodestyle/overlong.rs b/crates/ruff_linter/src/rules/pycodestyle/overlong.rs index 691ea9dd231aa..56cfb25df9d28 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/overlong.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/overlong.rs @@ -1,6 +1,6 @@ use std::ops::Deref; -use ruff_python_trivia::{is_pragma_comment, CommentRanges}; +use ruff_python_trivia::{CommentRanges, is_pragma_comment}; use ruff_source_file::Line; use ruff_text_size::{TextLen, TextRange}; diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_class_name.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_class_name.rs index 0729cdab66743..b7648a50e4d33 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_class_name.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_class_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Identifier; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::rules::pycodestyle::helpers::is_ambiguous_name; @@ -24,8 +24,8 @@ use crate::rules::pycodestyle::helpers::is_ambiguous_name; /// ```python /// class Integer(object): ... /// ``` -#[violation] -pub struct AmbiguousClassName(pub String); +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousClassName(pub String); impl Violation for AmbiguousClassName { #[derive_message_formats] diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_function_name.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_function_name.rs index 6601929c9819e..15f276d9fcda9 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_function_name.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_function_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Identifier; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::rules::pycodestyle::helpers::is_ambiguous_name; @@ -24,8 +24,8 @@ use crate::rules::pycodestyle::helpers::is_ambiguous_name; /// ```python /// def long_name(x): ... /// ``` -#[violation] -pub struct AmbiguousFunctionName(pub String); +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousFunctionName(pub String); impl Violation for AmbiguousFunctionName { #[derive_message_formats] diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_variable_name.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_variable_name.rs index 1ad5e9de825b8..553fed76de8c7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_variable_name.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/ambiguous_variable_name.rs @@ -1,7 +1,7 @@ use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; use crate::rules::pycodestyle::helpers::is_ambiguous_name; @@ -9,6 +9,12 @@ use crate::rules::pycodestyle::helpers::is_ambiguous_name; /// ## What it does /// Checks for the use of the characters 'l', 'O', or 'I' as variable names. /// +/// Note: This rule is automatically disabled for all stub files +/// (files with `.pyi` extensions). The rule has little relevance for authors +/// of stubs: a well-written stub should aim to faithfully represent the +/// interface of the equivalent .py file as it exists at runtime, including any +/// ambiguously named variables in the runtime module. +/// /// ## Why is this bad? /// In some fonts, these characters are indistinguishable from the /// numerals one and zero. When tempted to use 'l', use 'L' instead. @@ -27,15 +33,8 @@ use crate::rules::pycodestyle::helpers::is_ambiguous_name; /// i = 42 /// ``` /// -/// ## Preview mode behavior for stub files -/// In [preview] mode, this rule is automatically disabled for all stub files -/// (files with `.pyi` extensions). The rule has little relevance for authors -/// of stubs: a well-written stub should aim to faithfully represent the -/// interface of the equivalent .py file as it exists at runtime, including any -/// ambiguously named variables in the runtime module. - -#[violation] -pub struct AmbiguousVariableName(pub String); +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousVariableName(pub String); impl Violation for AmbiguousVariableName { #[derive_message_formats] @@ -46,12 +45,12 @@ impl Violation for AmbiguousVariableName { } /// E741 -pub(crate) fn ambiguous_variable_name(checker: &mut Checker, name: &str, range: TextRange) { - if checker.settings.preview.is_enabled() && checker.source_type.is_stub() { +pub(crate) fn ambiguous_variable_name(checker: &Checker, name: &str, range: TextRange) { + if checker.source_type.is_stub() { return; } if is_ambiguous_name(name) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AmbiguousVariableName(name.to_string()), range, )); diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/bare_except.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/bare_except.rs index 3070ed2058ef5..a7f92225b344b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/bare_except.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/bare_except.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::except; use ruff_python_ast::{self as ast, ExceptHandler, Expr, Stmt}; @@ -44,13 +44,13 @@ use crate::Locator; /// ## References /// - [Python documentation: Exception hierarchy](https://docs.python.org/3/library/exceptions.html#exception-hierarchy) /// - [Google Python Style Guide: "Exceptions"](https://google.github.io/styleguide/pyguide.html#24-exceptions) -#[violation] -pub struct BareExcept; +#[derive(ViolationMetadata)] +pub(crate) struct BareExcept; impl Violation for BareExcept { #[derive_message_formats] fn message(&self) -> String { - format!("Do not use bare `except`") + "Do not use bare `except`".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/blank_lines.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/blank_lines.rs index f281ff13f8446..0e690f70d2a4a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/blank_lines.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/blank_lines.rs @@ -9,7 +9,7 @@ use ruff_diagnostics::AlwaysFixableViolation; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Edit; use ruff_diagnostics::Fix; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_notebook::CellOffsets; use ruff_python_ast::PySourceType; use ruff_python_codegen::Stylist; @@ -21,10 +21,10 @@ use ruff_source_file::{LineRanges, UniversalNewlines}; use ruff_text_size::TextRange; use ruff_text_size::TextSize; +use crate::Locator; use crate::checkers::logical_lines::expand_indent; use crate::line_width::IndentWidth; use crate::rules::pycodestyle::helpers::is_non_logical_token; -use crate::Locator; /// Number of blank lines around top level classes and functions. const BLANK_LINES_TOP_LEVEL: u32 = 2; @@ -61,11 +61,11 @@ const BLANK_LINES_NESTED_LEVEL: u32 = 1; /// them. That's why this rule is not enabled in typing stub files. /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E301.html) -/// - [Typing Style Guide](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines) -#[violation] -pub struct BlankLineBetweenMethods; +/// - [Typing Style Guide](https://typing.python.org/en/latest/source/stubs.html#blank-lines) +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineBetweenMethods; impl AlwaysFixableViolation for BlankLineBetweenMethods { #[derive_message_formats] @@ -114,11 +114,11 @@ impl AlwaysFixableViolation for BlankLineBetweenMethods { /// - `lint.isort.lines-after-imports` /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E302.html) -/// - [Typing Style Guide](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines) -#[violation] -pub struct BlankLinesTopLevel { +/// - [Typing Style Guide](https://typing.python.org/en/latest/source/stubs.html#blank-lines) +#[derive(ViolationMetadata)] +pub(crate) struct BlankLinesTopLevel { actual_blank_lines: u32, expected_blank_lines: u32, } @@ -181,11 +181,11 @@ impl AlwaysFixableViolation for BlankLinesTopLevel { /// - `lint.isort.lines-between-types` /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E303.html) -/// - [Typing Style Guide](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines) -#[violation] -pub struct TooManyBlankLines { +/// - [Typing Style Guide](https://typing.python.org/en/latest/source/stubs.html#blank-lines) +#[derive(ViolationMetadata)] +pub(crate) struct TooManyBlankLines { actual_blank_lines: u32, } @@ -228,10 +228,10 @@ impl AlwaysFixableViolation for TooManyBlankLines { /// ``` /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E304.html) -#[violation] -pub struct BlankLineAfterDecorator { +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineAfterDecorator { actual_blank_lines: u32, } @@ -278,11 +278,11 @@ impl AlwaysFixableViolation for BlankLineAfterDecorator { /// them. That's why this rule is not enabled in typing stub files. /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E305.html) -/// - [Typing Style Guide](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines) -#[violation] -pub struct BlankLinesAfterFunctionOrClass { +/// - [Typing Style Guide](https://typing.python.org/en/latest/source/stubs.html#blank-lines) +#[derive(ViolationMetadata)] +pub(crate) struct BlankLinesAfterFunctionOrClass { actual_blank_lines: u32, } @@ -332,16 +332,16 @@ impl AlwaysFixableViolation for BlankLinesAfterFunctionOrClass { /// them. That's why this rule is not enabled in typing stub files. /// /// ## References -/// - [PEP 8](https://peps.python.org/pep-0008/#blank-lines) +/// - [PEP 8: Blank Lines](https://peps.python.org/pep-0008/#blank-lines) /// - [Flake 8 rule](https://www.flake8rules.com/rules/E306.html) -/// - [Typing Style Guide](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines) -#[violation] -pub struct BlankLinesBeforeNestedDefinition; +/// - [Typing Style Guide](https://typing.python.org/en/latest/source/stubs.html#blank-lines) +#[derive(ViolationMetadata)] +pub(crate) struct BlankLinesBeforeNestedDefinition; impl AlwaysFixableViolation for BlankLinesBeforeNestedDefinition { #[derive_message_formats] fn message(&self) -> String { - format!("Expected 1 blank line before a nested definition, found 0") + "Expected 1 blank line before a nested definition, found 0".to_string() } fn fix_title(&self) -> String { @@ -420,7 +420,7 @@ impl<'a> LinePreprocessor<'a> { } } -impl<'a> Iterator for LinePreprocessor<'a> { +impl Iterator for LinePreprocessor<'_> { type Item = LogicalLineInfo; fn next(&mut self) -> Option<LogicalLineInfo> { @@ -818,7 +818,7 @@ impl<'a> BlankLinesChecker<'a> { } } - #[allow(clippy::nonminimal_bool)] + #[expect(clippy::nonminimal_bool)] fn check_line( &self, line: &LogicalLineInfo, diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/compound_statements.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/compound_statements.rs index 5c279b1c271a9..19c79cd78a8f2 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/compound_statements.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/compound_statements.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_notebook::CellOffsets; use ruff_python_ast::PySourceType; use ruff_python_index::Indexer; @@ -27,13 +27,13 @@ use crate::Locator; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations -#[violation] -pub struct MultipleStatementsOnOneLineColon; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleStatementsOnOneLineColon; impl Violation for MultipleStatementsOnOneLineColon { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple statements on one line (colon)") + "Multiple statements on one line (colon)".to_string() } } @@ -57,13 +57,13 @@ impl Violation for MultipleStatementsOnOneLineColon { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations -#[violation] -pub struct MultipleStatementsOnOneLineSemicolon; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleStatementsOnOneLineSemicolon; impl Violation for MultipleStatementsOnOneLineSemicolon { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple statements on one line (semicolon)") + "Multiple statements on one line (semicolon)".to_string() } } @@ -82,17 +82,17 @@ impl Violation for MultipleStatementsOnOneLineSemicolon { /// ```python /// do_four() /// ``` -#[violation] -pub struct UselessSemicolon; +#[derive(ViolationMetadata)] +pub(crate) struct UselessSemicolon; impl AlwaysFixableViolation for UselessSemicolon { #[derive_message_formats] fn message(&self) -> String { - format!("Statement ends with an unnecessary semicolon") + "Statement ends with an unnecessary semicolon".to_string() } fn fix_title(&self) -> String { - format!("Remove unnecessary semicolon") + "Remove unnecessary semicolon".to_string() } } @@ -307,7 +307,7 @@ pub(crate) fn compound_statements( match_ = Some(token.range()); } _ => {} - }; + } } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/doc_line_too_long.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/doc_line_too_long.rs index 5661f62036f66..f906523c5d9b0 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/doc_line_too_long.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/doc_line_too_long.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_source_file::Line; @@ -70,8 +70,8 @@ use crate::settings::LinterSettings; /// - `lint.pycodestyle.ignore-overlong-task-comments` /// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length -#[violation] -pub struct DocLineTooLong(usize, usize); +#[derive(ViolationMetadata)] +pub(crate) struct DocLineTooLong(usize, usize); impl Violation for DocLineTooLong { #[derive_message_formats] diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/errors.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/errors.rs index de26f88488904..cc2f79d70c19e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/errors.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/errors.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// This is not a regular diagnostic; instead, it's raised when a file cannot be read @@ -23,13 +23,15 @@ use ruff_macros::{derive_message_formats, violation}; /// ## References /// - [UNIX Permissions introduction](https://mason.gmu.edu/~montecin/UNIXpermiss.htm) /// - [Command Line Basics: Symbolic Links](https://www.digitalocean.com/community/tutorials/workflow-symbolic-links) -#[violation] +#[derive(ViolationMetadata)] pub struct IOError { pub message: String, } /// E902 impl Violation for IOError { + // The format message is used by the `derive_message_formats` macro. + #![allow(clippy::useless_format)] #[derive_message_formats] fn message(&self) -> String { let IOError { message } = self; @@ -37,8 +39,8 @@ impl Violation for IOError { } } -/// ## Deprecated -/// This rule has been deprecated and will be removed in a future release. Syntax errors will +/// ## Removed +/// This rule has been removed. Syntax errors will /// always be shown regardless of whether this rule is selected or not. /// /// ## What it does @@ -60,15 +62,17 @@ impl Violation for IOError { /// /// ## References /// - [Python documentation: Syntax Errors](https://docs.python.org/3/tutorial/errors.html#syntax-errors) -#[violation] -pub struct SyntaxError { - pub message: String, -} +#[derive(ViolationMetadata)] +#[deprecated(note = "E999 has been removed")] +pub(crate) struct SyntaxError; +#[expect(deprecated)] impl Violation for SyntaxError { - #[derive_message_formats] fn message(&self) -> String { - let SyntaxError { message } = self; - format!("SyntaxError: {message}") + unreachable!("E999 has been removed") + } + + fn message_formats() -> &'static [&'static str] { + &["SyntaxError"] } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/invalid_escape_sequence.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/invalid_escape_sequence.rs index d6ecc94b994b6..5ee72ffae14d7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/invalid_escape_sequence.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/invalid_escape_sequence.rs @@ -1,13 +1,13 @@ use memchr::memchr_iter; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{AnyStringFlags, FStringElement, StringLike, StringLikePart}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::edits::pad_start; -use crate::Locator; /// ## What it does /// Checks for invalid escape sequences. @@ -37,8 +37,8 @@ use crate::Locator; /// /// ## References /// - [Python documentation: String and Bytes literals](https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals) -#[violation] -pub struct InvalidEscapeSequence { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidEscapeSequence { ch: char, fix_title: FixTitle, } @@ -52,84 +52,83 @@ impl AlwaysFixableViolation for InvalidEscapeSequence { fn fix_title(&self) -> String { match self.fix_title { - FixTitle::AddBackslash => format!("Add backslash to escape sequence"), - FixTitle::UseRawStringLiteral => format!("Use a raw string literal"), + FixTitle::AddBackslash => "Add backslash to escape sequence".to_string(), + FixTitle::UseRawStringLiteral => "Use a raw string literal".to_string(), } } } /// W605 -pub(crate) fn invalid_escape_sequence(checker: &mut Checker, string_like: StringLike) { +pub(crate) fn invalid_escape_sequence(checker: &Checker, string_like: StringLike) { let locator = checker.locator(); for part in string_like.parts() { if part.flags().is_raw_string() { continue; } - match part { - StringLikePart::String(string_literal) => { - check( - &mut checker.diagnostics, - locator, - string_literal.start(), - string_literal.range(), - AnyStringFlags::from(string_literal.flags), - ); - } - StringLikePart::Bytes(bytes_literal) => { - check( - &mut checker.diagnostics, - locator, - bytes_literal.start(), - bytes_literal.range(), - AnyStringFlags::from(bytes_literal.flags), - ); + let state = match part { + StringLikePart::String(_) | StringLikePart::Bytes(_) => { + analyze_escape_chars(locator, part.range(), part.flags()) } StringLikePart::FString(f_string) => { let flags = AnyStringFlags::from(f_string.flags); + let mut escape_chars_state = EscapeCharsState::default(); + // Whether we suggest converting to a raw string or + // adding backslashes depends on the presence of valid + // escape characters in the entire f-string. Therefore, + // we must analyze escape characters in each f-string + // element before pushing a diagnostic and fix. for element in &f_string.elements { match element { FStringElement::Literal(literal) => { - check( - &mut checker.diagnostics, + escape_chars_state.update(analyze_escape_chars( locator, - f_string.start(), literal.range(), flags, - ); + )); } FStringElement::Expression(expression) => { let Some(format_spec) = expression.format_spec.as_ref() else { continue; }; for literal in format_spec.elements.literals() { - check( - &mut checker.diagnostics, + escape_chars_state.update(analyze_escape_chars( locator, - f_string.start(), literal.range(), flags, - ); + )); } } } } + escape_chars_state } - } + }; + check(checker, locator, part.start(), part.flags(), state); } } -fn check( - diagnostics: &mut Vec<Diagnostic>, +#[derive(Default)] +struct EscapeCharsState { + contains_valid_escape_sequence: bool, + invalid_escape_chars: Vec<InvalidEscapeChar>, +} + +impl EscapeCharsState { + fn update(&mut self, other: Self) { + self.contains_valid_escape_sequence |= other.contains_valid_escape_sequence; + self.invalid_escape_chars.extend(other.invalid_escape_chars); + } +} + +/// Traverses string, collects invalid escape characters, and flags if a valid +/// escape character is found. +fn analyze_escape_chars( locator: &Locator, - // Start position of the expression that contains the source range. This is used to generate - // the fix when the source range is part of the expression like in f-string which contains - // other f-string literal elements. - expr_start: TextSize, - // Range in the source code to perform the check on. + // Range in the source code to perform the analysis on. source_range: TextRange, flags: AnyStringFlags, -) { +) -> EscapeCharsState { let source = locator.slice(source_range); let mut contains_valid_escape_sequence = false; let mut invalid_escape_chars = Vec::new(); @@ -225,7 +224,31 @@ fn check( range, }); } + EscapeCharsState { + contains_valid_escape_sequence, + invalid_escape_chars, + } +} +/// Pushes a diagnostic and fix depending on escape characters seen so far. +/// +/// If we have not seen any valid escape characters, we convert to +/// a raw string. If we have seen valid escape characters, +/// we manually add backslashes to each invalid escape character found. +fn check( + checker: &Checker, + locator: &Locator, + // Start position of the expression that contains the source range. This is used to generate + // the fix when the source range is part of the expression like in f-string which contains + // other f-string literal elements. + expr_start: TextSize, + flags: AnyStringFlags, + escape_chars_state: EscapeCharsState, +) { + let EscapeCharsState { + contains_valid_escape_sequence, + invalid_escape_chars, + } = escape_chars_state; if contains_valid_escape_sequence { // Escape with backslash. for invalid_escape_char in &invalid_escape_chars { @@ -240,7 +263,7 @@ fn check( r"\".to_string(), invalid_escape_char.start() + TextSize::from(1), ))); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else { // Turn into raw string. @@ -273,7 +296,7 @@ fn check( ); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/lambda_assignment.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/lambda_assignment.rs index 37ef83a1a698e..0d252c1bc0d0e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/lambda_assignment.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/lambda_assignment.rs @@ -1,9 +1,10 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{ - self as ast, Expr, Identifier, Parameter, ParameterWithDefault, Parameters, Stmt, + self as ast, Expr, ExprEllipsisLiteral, ExprLambda, Identifier, Parameter, + ParameterWithDefault, Parameters, Stmt, }; -use ruff_python_codegen::Generator; use ruff_python_semantic::SemanticModel; use ruff_python_trivia::{has_leading_content, has_trailing_content, leading_indentation}; use ruff_source_file::UniversalNewlines; @@ -34,8 +35,8 @@ use crate::checkers::ast::Checker; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#programming-recommendations -#[violation] -pub struct LambdaAssignment { +#[derive(ViolationMetadata)] +pub(crate) struct LambdaAssignment { name: String, } @@ -44,7 +45,7 @@ impl Violation for LambdaAssignment { #[derive_message_formats] fn message(&self) -> String { - format!("Do not assign a `lambda` expression, use a `def`") + "Do not assign a `lambda` expression, use a `def`".to_string() } fn fix_title(&self) -> Option<String> { @@ -55,7 +56,7 @@ impl Violation for LambdaAssignment { /// E731 pub(crate) fn lambda_assignment( - checker: &mut Checker, + checker: &Checker, target: &Expr, value: &Expr, annotation: Option<&Expr>, @@ -65,10 +66,7 @@ pub(crate) fn lambda_assignment( return; }; - let Expr::Lambda(ast::ExprLambda { - parameters, body, .. - }) = value - else { + let Expr::Lambda(lambda) = value else { return; }; @@ -85,16 +83,9 @@ pub(crate) fn lambda_assignment( let first_line = checker.locator().line_str(stmt.start()); let indentation = leading_indentation(first_line); let mut indented = String::new(); - for (idx, line) in function( - id, - parameters.as_deref(), - body, - annotation, - checker.semantic(), - checker.generator(), - ) - .universal_newlines() - .enumerate() + for (idx, line) in function(id, lambda, annotation, checker) + .universal_newlines() + .enumerate() { if idx == 0 { indented.push_str(&line); @@ -139,7 +130,7 @@ pub(crate) fn lambda_assignment( } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Extract the argument types and return type from a `Callable` annotation. @@ -186,19 +177,21 @@ fn extract_types(annotation: &Expr, semantic: &SemanticModel) -> Option<(Vec<Exp /// Generate a function definition from a `lambda` expression. fn function( name: &str, - parameters: Option<&Parameters>, - body: &Expr, + lambda: &ExprLambda, annotation: Option<&Expr>, - semantic: &SemanticModel, - generator: Generator, + checker: &Checker, ) -> String { + // Use a dummy body. It gets replaced at the end with the actual body. + // This allows preserving the source formatting for the body. let body = Stmt::Return(ast::StmtReturn { - value: Some(Box::new(body.clone())), + value: Some(Box::new(Expr::EllipsisLiteral( + ExprEllipsisLiteral::default(), + ))), range: TextRange::default(), }); - let parameters = parameters.cloned().unwrap_or_default(); + let parameters = lambda.parameters.as_deref().cloned().unwrap_or_default(); if let Some(annotation) = annotation { - if let Some((arg_types, return_type)) = extract_types(annotation, semantic) { + if let Some((arg_types, return_type)) = extract_types(annotation, checker.semantic()) { // A `lambda` expression can only have positional-only and positional-or-keyword // arguments. The order is always positional-only first, then positional-or-keyword. let new_posonlyargs = parameters @@ -243,10 +236,12 @@ fn function( type_params: None, range: TextRange::default(), }); - return generator.stmt(&func); + let generated = checker.generator().stmt(&func); + + return replace_trailing_ellipsis_with_original_expr(generated, lambda, checker); } } - let func = Stmt::FunctionDef(ast::StmtFunctionDef { + let function = Stmt::FunctionDef(ast::StmtFunctionDef { is_async: false, name: Identifier::new(name.to_string(), TextRange::default()), parameters: Box::new(parameters), @@ -256,5 +251,32 @@ fn function( type_params: None, range: TextRange::default(), }); - generator.stmt(&func) + let generated = checker.generator().stmt(&function); + + replace_trailing_ellipsis_with_original_expr(generated, lambda, checker) +} + +fn replace_trailing_ellipsis_with_original_expr( + mut generated: String, + lambda: &ExprLambda, + checker: &Checker, +) -> String { + let original_expr_range = parenthesized_range( + (&lambda.body).into(), + lambda.into(), + checker.comment_ranges(), + checker.source(), + ) + .unwrap_or(lambda.body.range()); + + let original_expr_in_source = checker.locator().slice(original_expr_range); + + let placeholder_ellipsis_start = generated.rfind("...").unwrap(); + let placeholder_ellipsis_end = placeholder_ellipsis_start + "...".len(); + + generated.replace_range( + placeholder_ellipsis_start..placeholder_ellipsis_end, + original_expr_in_source, + ); + generated } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs index 54b1bf09fd15f..2cebe72cb239a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_source_file::Line; @@ -12,8 +12,8 @@ use crate::settings::LinterSettings; /// ## Why is this bad? /// Overlong lines can hurt readability. [PEP 8], for example, recommends /// limiting lines to 79 characters. By default, this rule enforces a limit -/// of 88 characters for compatibility with Black, though that limit is -/// configurable via the [`line-length`] setting. +/// of 88 characters for compatibility with Black and the Ruff formatter, +/// though that limit is configurable via the [`line-length`] setting. /// /// In the interest of pragmatism, this rule makes a few exceptions when /// determining whether a line is overlong. Namely, it: @@ -68,8 +68,8 @@ use crate::settings::LinterSettings; /// - `lint.pycodestyle.max-line-length` /// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length -#[violation] -pub struct LineTooLong(usize, usize); +#[derive(ViolationMetadata)] +pub(crate) struct LineTooLong(usize, usize); impl Violation for LineTooLong { #[derive_message_formats] diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/literal_comparisons.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/literal_comparisons.rs index 0ae56cdf44b13..b700451fbdc7d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/literal_comparisons.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/literal_comparisons.rs @@ -1,9 +1,9 @@ +use ruff_python_ast::parenthesize::parenthesized_range; use rustc_hash::FxHashMap; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers; -use ruff_python_ast::helpers::generate_comparison; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::{self, generate_comparison}; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_text_size::Ranged; @@ -57,25 +57,26 @@ impl EqCmpOp { /// /// [PEP 8]: https://peps.python.org/pep-0008/#programming-recommendations /// [this issue]: https://github.com/astral-sh/ruff/issues/4560 -#[violation] -pub struct NoneComparison(EqCmpOp); +#[derive(ViolationMetadata)] +pub(crate) struct NoneComparison(EqCmpOp); impl AlwaysFixableViolation for NoneComparison { #[derive_message_formats] fn message(&self) -> String { let NoneComparison(op) = self; match op { - EqCmpOp::Eq => format!("Comparison to `None` should be `cond is None`"), - EqCmpOp::NotEq => format!("Comparison to `None` should be `cond is not None`"), + EqCmpOp::Eq => "Comparison to `None` should be `cond is None`".to_string(), + EqCmpOp::NotEq => "Comparison to `None` should be `cond is not None`".to_string(), } } fn fix_title(&self) -> String { let NoneComparison(op) = self; - match op { - EqCmpOp::Eq => "Replace with `cond is None`".to_string(), - EqCmpOp::NotEq => "Replace with `cond is not None`".to_string(), - } + let title = match op { + EqCmpOp::Eq => "Replace with `cond is None`", + EqCmpOp::NotEq => "Replace with `cond is not None`", + }; + title.to_string() } } @@ -118,8 +119,8 @@ impl AlwaysFixableViolation for NoneComparison { /// /// [PEP 8]: https://peps.python.org/pep-0008/#programming-recommendations /// [this issue]: https://github.com/astral-sh/ruff/issues/4560 -#[violation] -pub struct TrueFalseComparison { +#[derive(ViolationMetadata)] +pub(crate) struct TrueFalseComparison { value: bool, op: EqCmpOp, cond: Option<SourceCodeSnippet>, @@ -169,8 +170,44 @@ impl AlwaysFixableViolation for TrueFalseComparison { } } +fn is_redundant_boolean_comparison(op: CmpOp, comparator: &Expr) -> Option<bool> { + let value = comparator.as_boolean_literal_expr()?.value; + match op { + CmpOp::Is | CmpOp::Eq => Some(value), + CmpOp::IsNot | CmpOp::NotEq => Some(!value), + _ => None, + } +} + +fn generate_redundant_comparison( + compare: &ast::ExprCompare, + comment_ranges: &ruff_python_trivia::CommentRanges, + source: &str, + comparator: &Expr, + kind: bool, + needs_wrap: bool, +) -> String { + let comparator_range = + parenthesized_range(comparator.into(), compare.into(), comment_ranges, source) + .unwrap_or(comparator.range()); + + let comparator_str = &source[comparator_range]; + + let result = if kind { + comparator_str.to_string() + } else { + format!("not {comparator_str}") + }; + + if needs_wrap { + format!("({result})") + } else { + result + } +} + /// E711, E712 -pub(crate) fn literal_comparisons(checker: &mut Checker, compare: &ast::ExprCompare) { +pub(crate) fn literal_comparisons(checker: &Checker, compare: &ast::ExprCompare) { // Mapping from (bad operator index) to (replacement operator). As we iterate // through the list of operators, we apply "dummy" fixes for each error, // then replace the entire expression at the end with one "real" fix, to @@ -274,6 +311,16 @@ pub(crate) fn literal_comparisons(checker: &mut Checker, compare: &ast::ExprComp if let Expr::BooleanLiteral(ast::ExprBooleanLiteral { value, .. }) = next { match op { EqCmpOp::Eq => { + if let Expr::BooleanLiteral(ast::ExprBooleanLiteral { + value: comparator_value, + .. + }) = comparator + { + if value == comparator_value { + continue; + } + } + let cond = if compare.ops.len() == 1 { Some(SourceCodeSnippet::from_str( checker.locator().slice(comparator), @@ -322,7 +369,6 @@ pub(crate) fn literal_comparisons(checker: &mut Checker, compare: &ast::ExprComp // TODO(charlie): Respect `noqa` directives. If one of the operators has a // `noqa`, but another doesn't, both will be removed here. if !bad_ops.is_empty() { - // Replace the entire comparison expression. let ops = compare .ops .iter() @@ -330,14 +376,53 @@ pub(crate) fn literal_comparisons(checker: &mut Checker, compare: &ast::ExprComp .map(|(idx, op)| bad_ops.get(&idx).unwrap_or(op)) .copied() .collect::<Vec<_>>(); - let content = generate_comparison( - &compare.left, - &ops, - &compare.comparators, - compare.into(), - checker.comment_ranges(), - checker.source(), - ); + + let comment_ranges = checker.comment_ranges(); + let source = checker.source(); + + let content = match (&*compare.ops, &*compare.comparators) { + ([op], [comparator]) => { + if let Some(kind) = is_redundant_boolean_comparison(*op, &compare.left) { + let needs_wrap = compare.left.range().start() != compare.range().start(); + generate_redundant_comparison( + compare, + comment_ranges, + source, + comparator, + kind, + needs_wrap, + ) + } else if let Some(kind) = is_redundant_boolean_comparison(*op, comparator) { + let needs_wrap = comparator.range().end() != compare.range().end(); + generate_redundant_comparison( + compare, + comment_ranges, + source, + &compare.left, + kind, + needs_wrap, + ) + } else { + generate_comparison( + &compare.left, + &ops, + &compare.comparators, + compare.into(), + comment_ranges, + source, + ) + } + } + _ => generate_comparison( + &compare.left, + &ops, + &compare.comparators, + compare.into(), + comment_ranges, + source, + ), + }; + for diagnostic in &mut diagnostics { diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( content.to_string(), @@ -346,5 +431,7 @@ pub(crate) fn literal_comparisons(checker: &mut Checker, compare: &ast::ExprComp } } - checker.diagnostics.extend(diagnostics); + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/extraneous_whitespace.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/extraneous_whitespace.rs index 3580c8dad16ca..046de04af01bc 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/extraneous_whitespace.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/extraneous_whitespace.rs @@ -2,7 +2,7 @@ use ruff_diagnostics::AlwaysFixableViolation; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Edit; use ruff_diagnostics::Fix; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::{Ranged, TextRange}; @@ -11,7 +11,7 @@ use crate::checkers::logical_lines::LogicalLinesContext; use super::{LogicalLine, Whitespace}; /// ## What it does -/// Checks for the use of extraneous whitespace after "(". +/// Checks for the use of extraneous whitespace after "(", "[" or "{". /// /// ## Why is this bad? /// [PEP 8] recommends the omission of whitespace in the following cases: @@ -31,8 +31,8 @@ use super::{LogicalLine, Whitespace}; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves -#[violation] -pub struct WhitespaceAfterOpenBracket { +#[derive(ViolationMetadata)] +pub(crate) struct WhitespaceAfterOpenBracket { symbol: char, } @@ -50,7 +50,7 @@ impl AlwaysFixableViolation for WhitespaceAfterOpenBracket { } /// ## What it does -/// Checks for the use of extraneous whitespace before ")". +/// Checks for the use of extraneous whitespace before ")", "]" or "}". /// /// ## Why is this bad? /// [PEP 8] recommends the omission of whitespace in the following cases: @@ -70,8 +70,8 @@ impl AlwaysFixableViolation for WhitespaceAfterOpenBracket { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves -#[violation] -pub struct WhitespaceBeforeCloseBracket { +#[derive(ViolationMetadata)] +pub(crate) struct WhitespaceBeforeCloseBracket { symbol: char, } @@ -107,8 +107,8 @@ impl AlwaysFixableViolation for WhitespaceBeforeCloseBracket { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves -#[violation] -pub struct WhitespaceBeforePunctuation { +#[derive(ViolationMetadata)] +pub(crate) struct WhitespaceBeforePunctuation { symbol: char, } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/indentation.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/indentation.rs index 612293ca17f2a..e9c828bd8f360 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/indentation.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/indentation.rs @@ -1,7 +1,8 @@ -use ruff_diagnostics::DiagnosticKind; +use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; +use ruff_text_size::TextRange; use super::LogicalLine; @@ -23,7 +24,6 @@ use super::LogicalLine; /// a = 1 /// ``` /// -/// /// ## Formatter compatibility /// We recommend against using this rule alongside the [formatter]. The /// formatter enforces consistent indentation, making the rule redundant. @@ -36,8 +36,8 @@ use super::LogicalLine; /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation /// [formatter]:https://docs.astral.sh/ruff/formatter/ -#[violation] -pub struct IndentationWithInvalidMultiple { +#[derive(ViolationMetadata)] +pub(crate) struct IndentationWithInvalidMultiple { indent_width: usize, } @@ -79,8 +79,8 @@ impl Violation for IndentationWithInvalidMultiple { /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation /// [formatter]:https://docs.astral.sh/ruff/formatter/ -#[violation] -pub struct IndentationWithInvalidMultipleComment { +#[derive(ViolationMetadata)] +pub(crate) struct IndentationWithInvalidMultipleComment { indent_width: usize, } @@ -112,13 +112,13 @@ impl Violation for IndentationWithInvalidMultipleComment { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation -#[violation] -pub struct NoIndentedBlock; +#[derive(ViolationMetadata)] +pub(crate) struct NoIndentedBlock; impl Violation for NoIndentedBlock { #[derive_message_formats] fn message(&self) -> String { - format!("Expected an indented block") + "Expected an indented block".to_string() } } @@ -144,13 +144,13 @@ impl Violation for NoIndentedBlock { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation -#[violation] -pub struct NoIndentedBlockComment; +#[derive(ViolationMetadata)] +pub(crate) struct NoIndentedBlockComment; impl Violation for NoIndentedBlockComment { #[derive_message_formats] fn message(&self) -> String { - format!("Expected an indented block (comment)") + "Expected an indented block (comment)".to_string() } } @@ -173,13 +173,13 @@ impl Violation for NoIndentedBlockComment { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation -#[violation] -pub struct UnexpectedIndentation; +#[derive(ViolationMetadata)] +pub(crate) struct UnexpectedIndentation; impl Violation for UnexpectedIndentation { #[derive_message_formats] fn message(&self) -> String { - format!("Unexpected indentation") + "Unexpected indentation".to_string() } } @@ -202,13 +202,13 @@ impl Violation for UnexpectedIndentation { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation -#[violation] -pub struct UnexpectedIndentationComment; +#[derive(ViolationMetadata)] +pub(crate) struct UnexpectedIndentationComment; impl Violation for UnexpectedIndentationComment { #[derive_message_formats] fn message(&self) -> String { - format!("Unexpected indentation (comment)") + "Unexpected indentation (comment)".to_string() } } @@ -232,20 +232,24 @@ impl Violation for UnexpectedIndentationComment { /// pass /// ``` /// +/// ## Formatter compatibility +/// We recommend against using this rule alongside the [formatter]. The +/// formatter enforces consistent indentation, making the rule redundant. +/// /// [PEP 8]: https://peps.python.org/pep-0008/#indentation -#[violation] -pub struct OverIndented { +/// [formatter]:https://docs.astral.sh/ruff/formatter/ +#[derive(ViolationMetadata)] +pub(crate) struct OverIndented { is_comment: bool, } impl Violation for OverIndented { #[derive_message_formats] fn message(&self) -> String { - let OverIndented { is_comment } = self; - if *is_comment { - format!("Over-indented (comment)") + if self.is_comment { + "Over-indented (comment)".to_string() } else { - format!("Over-indented") + "Over-indented".to_string() } } } @@ -258,18 +262,25 @@ pub(crate) fn indentation( indent_level: usize, prev_indent_level: Option<usize>, indent_size: usize, -) -> Vec<DiagnosticKind> { + range: TextRange, +) -> Vec<Diagnostic> { let mut diagnostics = vec![]; if indent_level % indent_size != 0 { diagnostics.push(if logical_line.is_comment_only() { - DiagnosticKind::from(IndentationWithInvalidMultipleComment { - indent_width: indent_size, - }) + Diagnostic::new( + IndentationWithInvalidMultipleComment { + indent_width: indent_size, + }, + range, + ) } else { - DiagnosticKind::from(IndentationWithInvalidMultiple { - indent_width: indent_size, - }) + Diagnostic::new( + IndentationWithInvalidMultiple { + indent_width: indent_size, + }, + range, + ) }); } let indent_expect = prev_logical_line @@ -278,29 +289,29 @@ pub(crate) fn indentation( if indent_expect && indent_level <= prev_indent_level.unwrap_or(0) { diagnostics.push(if logical_line.is_comment_only() { - DiagnosticKind::from(NoIndentedBlockComment) + Diagnostic::new(NoIndentedBlockComment, range) } else { - DiagnosticKind::from(NoIndentedBlock) + Diagnostic::new(NoIndentedBlock, range) }); } else if !indent_expect && prev_indent_level.is_some_and(|prev_indent_level| indent_level > prev_indent_level) { diagnostics.push(if logical_line.is_comment_only() { - DiagnosticKind::from(UnexpectedIndentationComment) + Diagnostic::new(UnexpectedIndentationComment, range) } else { - DiagnosticKind::from(UnexpectedIndentation) + Diagnostic::new(UnexpectedIndentation, range) }); } if indent_expect { let expected_indent_amount = if indent_char == '\t' { 8 } else { 4 }; let expected_indent_level = prev_indent_level.unwrap_or(0) + expected_indent_amount; if indent_level > expected_indent_level { - diagnostics.push( + diagnostics.push(Diagnostic::new( OverIndented { is_comment: logical_line.is_comment_only(), - } - .into(), - ); + }, + range, + )); } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace.rs index 0d714b5e88317..901d620300145 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::Edit; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::Ranged; @@ -23,8 +23,8 @@ use super::{DefinitionState, LogicalLine}; /// ```python /// a = (1, 2) /// ``` -#[violation] -pub struct MissingWhitespace { +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespace { token: TokenKind, } @@ -35,7 +35,7 @@ impl AlwaysFixableViolation for MissingWhitespace { } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_after_keyword.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_after_keyword.rs index a83ca53e66a95..d769462d37d77 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_after_keyword.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_after_keyword.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::Ranged; @@ -26,17 +26,17 @@ use crate::rules::pycodestyle::rules::logical_lines::LogicalLine; /// /// ## References /// - [Python documentation: Keywords](https://docs.python.org/3/reference/lexical_analysis.html#keywords) -#[violation] -pub struct MissingWhitespaceAfterKeyword; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAfterKeyword; impl AlwaysFixableViolation for MissingWhitespaceAfterKeyword { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace after keyword") + "Missing whitespace after keyword".to_string() } fn fix_title(&self) -> String { - format!("Added missing whitespace after keyword") + "Added missing whitespace after keyword".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs index 1f3236e315ac3..8538d4acf57a7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/missing_whitespace_around_operator.rs @@ -1,11 +1,11 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, DiagnosticKind, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; -use ruff_text_size::Ranged; +use ruff_text_size::{Ranged, TextRange}; use crate::checkers::logical_lines::LogicalLinesContext; use crate::rules::pycodestyle::helpers::is_non_logical_token; -use crate::rules::pycodestyle::rules::logical_lines::LogicalLine; +use crate::rules::pycodestyle::rules::logical_lines::{DefinitionState, LogicalLine}; /// ## What it does /// Checks for missing whitespace around all operators. @@ -28,17 +28,17 @@ use crate::rules::pycodestyle::rules::logical_lines::LogicalLine; /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves // E225 -#[violation] -pub struct MissingWhitespaceAroundOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAroundOperator; impl AlwaysFixableViolation for MissingWhitespaceAroundOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace around operator") + "Missing whitespace around operator".to_string() } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } @@ -61,17 +61,17 @@ impl AlwaysFixableViolation for MissingWhitespaceAroundOperator { /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves // E226 -#[violation] -pub struct MissingWhitespaceAroundArithmeticOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAroundArithmeticOperator; impl AlwaysFixableViolation for MissingWhitespaceAroundArithmeticOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace around arithmetic operator") + "Missing whitespace around arithmetic operator".to_string() } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } @@ -94,17 +94,17 @@ impl AlwaysFixableViolation for MissingWhitespaceAroundArithmeticOperator { /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves // E227 -#[violation] -pub struct MissingWhitespaceAroundBitwiseOrShiftOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAroundBitwiseOrShiftOperator; impl AlwaysFixableViolation for MissingWhitespaceAroundBitwiseOrShiftOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace around bitwise or shift operator") + "Missing whitespace around bitwise or shift operator".to_string() } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } @@ -127,17 +127,17 @@ impl AlwaysFixableViolation for MissingWhitespaceAroundBitwiseOrShiftOperator { /// /// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations // E228 -#[violation] -pub struct MissingWhitespaceAroundModuloOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAroundModuloOperator; impl AlwaysFixableViolation for MissingWhitespaceAroundModuloOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace around modulo operator") + "Missing whitespace around modulo operator".to_string() } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } @@ -146,6 +146,7 @@ pub(crate) fn missing_whitespace_around_operator( line: &LogicalLine, context: &mut LogicalLinesContext, ) { + let mut definition_state = DefinitionState::from_tokens(line.tokens()); let mut tokens = line.tokens().iter().peekable(); let first_token = tokens .by_ref() @@ -162,6 +163,8 @@ pub(crate) fn missing_whitespace_around_operator( while let Some(token) = tokens.next() { let kind = token.kind(); + definition_state.visit_token_kind(kind); + if is_non_logical_token(kind) { continue; } @@ -172,10 +175,13 @@ pub(crate) fn missing_whitespace_around_operator( TokenKind::Lpar | TokenKind::Lambda => parens += 1, TokenKind::Rpar => parens = parens.saturating_sub(1), _ => {} - }; + } - let needs_space = if kind == TokenKind::Equal && (parens > 0 || fstrings > 0) { + let needs_space = if kind == TokenKind::Equal + && (parens > 0 || fstrings > 0 || definition_state.in_type_params()) + { // Allow keyword args, defaults: foo(bar=None) and f-strings: f'{foo=}' + // Also ignore `foo[T=int]`, which is handled by E251. NeedsSpace::No } else if kind == TokenKind::Slash { // Tolerate the "/" operator in function definition @@ -239,41 +245,38 @@ pub(crate) fn missing_whitespace_around_operator( let has_leading_trivia = prev_token.end() < token.start() || is_non_logical_token(prev_token.kind()); - let has_trailing_trivia = tokens.peek().map_or(true, |next| { - token.end() < next.start() || is_non_logical_token(next.kind()) - }); + let has_trailing_trivia = tokens + .peek() + .is_none_or(|next| token.end() < next.start() || is_non_logical_token(next.kind())); match (has_leading_trivia, has_trailing_trivia) { // Operator with trailing but no leading space, enforce consistent spacing. (false, true) => { - let mut diagnostic = - Diagnostic::new(diagnostic_kind_for_operator(kind), token.range()); - diagnostic.set_fix(Fix::safe_edit(Edit::insertion( - " ".to_string(), - token.start(), - ))); - context.push_diagnostic(diagnostic); + context.push_diagnostic( + diagnostic_kind_for_operator(kind, token.range()).with_fix(Fix::safe_edit( + Edit::insertion(" ".to_string(), token.start()), + )), + ); } // Operator with leading but no trailing space, enforce consistent spacing. (true, false) => { - let mut diagnostic = - Diagnostic::new(diagnostic_kind_for_operator(kind), token.range()); - diagnostic.set_fix(Fix::safe_edit(Edit::insertion( - " ".to_string(), - token.end(), - ))); - context.push_diagnostic(diagnostic); + context.push_diagnostic( + diagnostic_kind_for_operator(kind, token.range()).with_fix(Fix::safe_edit( + Edit::insertion(" ".to_string(), token.end()), + )), + ); } // Operator with no space, require spaces if it is required by the operator. (false, false) => { if needs_space == NeedsSpace::Yes { - let mut diagnostic = - Diagnostic::new(diagnostic_kind_for_operator(kind), token.range()); - diagnostic.set_fix(Fix::safe_edits( - Edit::insertion(" ".to_string(), token.start()), - [Edit::insertion(" ".to_string(), token.end())], - )); - context.push_diagnostic(diagnostic); + context.push_diagnostic( + diagnostic_kind_for_operator(kind, token.range()).with_fix( + Fix::safe_edits( + Edit::insertion(" ".to_string(), token.start()), + [Edit::insertion(" ".to_string(), token.end())], + ), + ), + ); } } (true, true) => { @@ -311,15 +314,15 @@ impl From<bool> for NeedsSpace { } } -fn diagnostic_kind_for_operator(operator: TokenKind) -> DiagnosticKind { +fn diagnostic_kind_for_operator(operator: TokenKind, range: TextRange) -> Diagnostic { if operator == TokenKind::Percent { - DiagnosticKind::from(MissingWhitespaceAroundModuloOperator) + Diagnostic::new(MissingWhitespaceAroundModuloOperator, range) } else if operator.is_bitwise_or_shift() { - DiagnosticKind::from(MissingWhitespaceAroundBitwiseOrShiftOperator) + Diagnostic::new(MissingWhitespaceAroundBitwiseOrShiftOperator, range) } else if operator.is_arithmetic() { - DiagnosticKind::from(MissingWhitespaceAroundArithmeticOperator) + Diagnostic::new(MissingWhitespaceAroundArithmeticOperator, range) } else { - DiagnosticKind::from(MissingWhitespaceAroundOperator) + Diagnostic::new(MissingWhitespaceAroundOperator, range) } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/mod.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/mod.rs index 8dc69bf72c09e..9f5c033b9f0c3 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/mod.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/mod.rs @@ -18,8 +18,8 @@ pub(crate) use whitespace_around_named_parameter_equals::*; pub(crate) use whitespace_before_comment::*; pub(crate) use whitespace_before_parameters::*; -use crate::rules::pycodestyle::helpers::is_non_logical_token; use crate::Locator; +use crate::rules::pycodestyle::helpers::is_non_logical_token; mod extraneous_whitespace; mod indentation; @@ -37,18 +37,17 @@ bitflags! { #[derive(Default, Eq, PartialEq, Clone, Copy, Debug)] pub(crate) struct TokenFlags: u8 { /// Whether the logical line contains an operator. - const OPERATOR = 0b0000_0001; + const OPERATOR = 1 << 0; /// Whether the logical line contains a bracket. - const BRACKET = 0b0000_0010; + const BRACKET = 1 << 1; /// Whether the logical line contains a punctuation mark. - const PUNCTUATION = 0b0000_0100; + const PUNCTUATION = 1 << 2; /// Whether the logical line contains a keyword. - const KEYWORD = 0b0000_1000; + const KEYWORD = 1 << 3; /// Whether the logical line contains a comment. - const COMMENT = 0b0001_0000; - + const COMMENT = 1 << 4; /// Whether the logical line contains any non trivia token (no comment, newline, or in/dedent) - const NON_TRIVIA = 0b0010_0000; + const NON_TRIVIA = 1 << 5; } } @@ -103,7 +102,7 @@ impl<'a> IntoIterator for &'a LogicalLines<'a> { /// line breaks. /// /// ## Examples -/// This expression forms one logical line because because the array elements are parenthesized. +/// This expression forms one logical line because the array elements are parenthesized. /// /// ```python /// a = [ @@ -393,7 +392,6 @@ impl LogicalLinesBuilder { } // SAFETY: `LogicalLines::from_tokens` asserts that the file has less than `u32::MAX` tokens and each tokens is at least one character long - #[allow(clippy::cast_possible_truncation)] fn push_token(&mut self, kind: TokenKind, range: TextRange) { let line = &mut self.current_line; @@ -429,7 +427,7 @@ impl LogicalLinesBuilder { } // SAFETY: `LogicalLines::from_tokens` asserts that the file has less than `u32::MAX` tokens and each tokens is at least one character long - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] fn finish_line(&mut self) { let end = self.tokens.len() as u32; if self.current_line.tokens_start < end { @@ -481,7 +479,8 @@ struct Line { enum DefinitionState { InClass(TypeParamsState), InFunction(TypeParamsState), - NotInClassOrFunction, + InTypeAlias(TypeParamsState), + NotInDefinition, } impl DefinitionState { @@ -495,11 +494,12 @@ impl DefinitionState { TokenKind::Async if matches!(token_kinds.next(), Some(TokenKind::Def)) => { Self::InFunction(TypeParamsState::default()) } - _ => Self::NotInClassOrFunction, + TokenKind::Type => Self::InTypeAlias(TypeParamsState::default()), + _ => Self::NotInDefinition, }; return state; } - Self::NotInClassOrFunction + Self::NotInDefinition } const fn in_function_definition(self) -> bool { @@ -508,8 +508,10 @@ impl DefinitionState { const fn type_params_state(self) -> Option<TypeParamsState> { match self { - Self::InClass(state) | Self::InFunction(state) => Some(state), - Self::NotInClassOrFunction => None, + Self::InClass(state) | Self::InFunction(state) | Self::InTypeAlias(state) => { + Some(state) + } + Self::NotInDefinition => None, } } @@ -522,13 +524,13 @@ impl DefinitionState { fn visit_token_kind(&mut self, token_kind: TokenKind) { let type_params_state_mut = match self { - Self::InClass(type_params_state) | Self::InFunction(type_params_state) => { - type_params_state - } - Self::NotInClassOrFunction => return, + Self::InClass(type_params_state) + | Self::InFunction(type_params_state) + | Self::InTypeAlias(type_params_state) => type_params_state, + Self::NotInDefinition => return, }; match token_kind { - TokenKind::Lpar if type_params_state_mut.before_type_params() => { + TokenKind::Lpar | TokenKind::Equal if type_params_state_mut.before_type_params() => { *type_params_state_mut = TypeParamsState::TypeParamsEnded; } TokenKind::Lsqb => match type_params_state_mut { diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/redundant_backslash.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/redundant_backslash.rs index 68a8e11240ab7..e4c63e50b3127 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/redundant_backslash.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/redundant_backslash.rs @@ -1,12 +1,12 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_index::Indexer; use ruff_python_parser::TokenKind; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::checkers::logical_lines::LogicalLinesContext; use crate::Locator; +use crate::checkers::logical_lines::LogicalLinesContext; use super::LogicalLine; @@ -29,13 +29,13 @@ use super::LogicalLine; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length -#[violation] -pub struct RedundantBackslash; +#[derive(ViolationMetadata)] +pub(crate) struct RedundantBackslash; impl AlwaysFixableViolation for RedundantBackslash { #[derive_message_formats] fn message(&self) -> String { - format!("Redundant backslash") + "Redundant backslash".to_string() } fn fix_title(&self) -> String { diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs index a707d2fb4b22b..6fe485d76459e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::{Ranged, TextRange}; @@ -25,17 +25,17 @@ use super::{LogicalLine, Whitespace}; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct TabBeforeOperator; +#[derive(ViolationMetadata)] +pub(crate) struct TabBeforeOperator; impl AlwaysFixableViolation for TabBeforeOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Tab before operator") + "Tab before operator".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -57,17 +57,17 @@ impl AlwaysFixableViolation for TabBeforeOperator { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct MultipleSpacesBeforeOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleSpacesBeforeOperator; impl AlwaysFixableViolation for MultipleSpacesBeforeOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple spaces before operator") + "Multiple spaces before operator".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -89,17 +89,17 @@ impl AlwaysFixableViolation for MultipleSpacesBeforeOperator { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct TabAfterOperator; +#[derive(ViolationMetadata)] +pub(crate) struct TabAfterOperator; impl AlwaysFixableViolation for TabAfterOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Tab after operator") + "Tab after operator".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -121,17 +121,17 @@ impl AlwaysFixableViolation for TabAfterOperator { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct MultipleSpacesAfterOperator; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleSpacesAfterOperator; impl AlwaysFixableViolation for MultipleSpacesAfterOperator { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple spaces after operator") + "Multiple spaces after operator".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -151,17 +151,17 @@ impl AlwaysFixableViolation for MultipleSpacesAfterOperator { /// a = 4, 5 /// ``` /// -#[violation] -pub struct TabAfterComma; +#[derive(ViolationMetadata)] +pub(crate) struct TabAfterComma; impl AlwaysFixableViolation for TabAfterComma { #[derive_message_formats] fn message(&self) -> String { - format!("Tab after comma") + "Tab after comma".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -169,7 +169,8 @@ impl AlwaysFixableViolation for TabAfterComma { /// Checks for extraneous whitespace after a comma. /// /// ## Why is this bad? -/// According to the `black` code style, commas should be followed by a single space. +/// Consistency is good. This rule helps ensure you have a consistent +/// formatting style across your project. /// /// ## Example /// ```python @@ -180,17 +181,17 @@ impl AlwaysFixableViolation for TabAfterComma { /// ```python /// a = 4, 5 /// ``` -#[violation] -pub struct MultipleSpacesAfterComma; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleSpacesAfterComma; impl AlwaysFixableViolation for MultipleSpacesAfterComma { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple spaces after comma") + "Multiple spaces after comma".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_keywords.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_keywords.rs index 365060f41d0e5..5e0e183e24926 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_keywords.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_keywords.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::logical_lines::LogicalLinesContext; @@ -21,17 +21,17 @@ use super::{LogicalLine, Whitespace}; /// ```python /// True and False /// ``` -#[violation] -pub struct MultipleSpacesAfterKeyword; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleSpacesAfterKeyword; impl AlwaysFixableViolation for MultipleSpacesAfterKeyword { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple spaces after keyword") + "Multiple spaces after keyword".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -50,17 +50,17 @@ impl AlwaysFixableViolation for MultipleSpacesAfterKeyword { /// ```python /// True and False /// ``` -#[violation] -pub struct MultipleSpacesBeforeKeyword; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleSpacesBeforeKeyword; impl AlwaysFixableViolation for MultipleSpacesBeforeKeyword { #[derive_message_formats] fn message(&self) -> String { - format!("Multiple spaces before keyword") + "Multiple spaces before keyword".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -79,17 +79,17 @@ impl AlwaysFixableViolation for MultipleSpacesBeforeKeyword { /// ```python /// True and False /// ``` -#[violation] -pub struct TabAfterKeyword; +#[derive(ViolationMetadata)] +pub(crate) struct TabAfterKeyword; impl AlwaysFixableViolation for TabAfterKeyword { #[derive_message_formats] fn message(&self) -> String { - format!("Tab after keyword") + "Tab after keyword".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } @@ -108,17 +108,17 @@ impl AlwaysFixableViolation for TabAfterKeyword { /// ```python /// True and False /// ``` -#[violation] -pub struct TabBeforeKeyword; +#[derive(ViolationMetadata)] +pub(crate) struct TabBeforeKeyword; impl AlwaysFixableViolation for TabBeforeKeyword { #[derive_message_formats] fn message(&self) -> String { - format!("Tab before keyword") + "Tab before keyword".to_string() } fn fix_title(&self) -> String { - format!("Replace with single space") + "Replace with single space".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_named_parameter_equals.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_named_parameter_equals.rs index c9fd76e15bbfe..66d18bf2ca328 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_named_parameter_equals.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_around_named_parameter_equals.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -31,17 +31,17 @@ use crate::rules::pycodestyle::rules::logical_lines::{DefinitionState, LogicalLi /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct UnexpectedSpacesAroundKeywordParameterEquals; +#[derive(ViolationMetadata)] +pub(crate) struct UnexpectedSpacesAroundKeywordParameterEquals; impl AlwaysFixableViolation for UnexpectedSpacesAroundKeywordParameterEquals { #[derive_message_formats] fn message(&self) -> String { - format!("Unexpected spaces around keyword / parameter equals") + "Unexpected spaces around keyword / parameter equals".to_string() } fn fix_title(&self) -> String { - format!("Remove whitespace") + "Remove whitespace".to_string() } } @@ -70,17 +70,17 @@ impl AlwaysFixableViolation for UnexpectedSpacesAroundKeywordParameterEquals { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#whitespace-in-expressions-and-statements -#[violation] -pub struct MissingWhitespaceAroundParameterEquals; +#[derive(ViolationMetadata)] +pub(crate) struct MissingWhitespaceAroundParameterEquals; impl AlwaysFixableViolation for MissingWhitespaceAroundParameterEquals { #[derive_message_formats] fn message(&self) -> String { - format!("Missing whitespace around parameter equals") + "Missing whitespace around parameter equals".to_string() } fn fix_title(&self) -> String { - format!("Add missing whitespace") + "Add missing whitespace".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_comment.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_comment.rs index 19cfa0736def8..ee1bda94cf4a5 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_comment.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_comment.rs @@ -1,13 +1,13 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_python_trivia::PythonWhitespace; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::checkers::logical_lines::LogicalLinesContext; use crate::rules::pycodestyle::rules::logical_lines::LogicalLine; -use crate::Locator; /// ## What it does /// Checks if inline comments are separated by at least two spaces. @@ -30,17 +30,17 @@ use crate::Locator; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#comments -#[violation] -pub struct TooFewSpacesBeforeInlineComment; +#[derive(ViolationMetadata)] +pub(crate) struct TooFewSpacesBeforeInlineComment; impl AlwaysFixableViolation for TooFewSpacesBeforeInlineComment { #[derive_message_formats] fn message(&self) -> String { - format!("Insert at least two spaces before an inline comment") + "Insert at least two spaces before an inline comment".to_string() } fn fix_title(&self) -> String { - format!("Insert spaces") + "Insert spaces".to_string() } } @@ -66,17 +66,17 @@ impl AlwaysFixableViolation for TooFewSpacesBeforeInlineComment { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#comments -#[violation] -pub struct NoSpaceAfterInlineComment; +#[derive(ViolationMetadata)] +pub(crate) struct NoSpaceAfterInlineComment; impl AlwaysFixableViolation for NoSpaceAfterInlineComment { #[derive_message_formats] fn message(&self) -> String { - format!("Inline comment should start with `# `") + "Inline comment should start with `# `".to_string() } fn fix_title(&self) -> String { - format!("Format space") + "Format space".to_string() } } @@ -103,17 +103,17 @@ impl AlwaysFixableViolation for NoSpaceAfterInlineComment { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#comments -#[violation] -pub struct NoSpaceAfterBlockComment; +#[derive(ViolationMetadata)] +pub(crate) struct NoSpaceAfterBlockComment; impl AlwaysFixableViolation for NoSpaceAfterBlockComment { #[derive_message_formats] fn message(&self) -> String { - format!("Block comment should start with `# `") + "Block comment should start with `# `".to_string() } fn fix_title(&self) -> String { - format!("Format space") + "Format space".to_string() } } @@ -149,17 +149,17 @@ impl AlwaysFixableViolation for NoSpaceAfterBlockComment { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#comments -#[violation] -pub struct MultipleLeadingHashesForBlockComment; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleLeadingHashesForBlockComment; impl AlwaysFixableViolation for MultipleLeadingHashesForBlockComment { #[derive_message_formats] fn message(&self) -> String { - format!("Too many leading `#` before block comment") + "Too many leading `#` before block comment".to_string() } fn fix_title(&self) -> String { - format!("Remove leading `#`") + "Remove leading `#`".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_parameters.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_parameters.rs index 0f0dc8763e2a8..56aa36d50e29a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_parameters.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/whitespace_before_parameters.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::TokenKind; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -25,8 +25,8 @@ use crate::rules::pycodestyle::rules::logical_lines::LogicalLine; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#pet-peeves -#[violation] -pub struct WhitespaceBeforeParameters { +#[derive(ViolationMetadata)] +pub(crate) struct WhitespaceBeforeParameters { bracket: TokenKind, } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/missing_newline_at_end_of_file.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/missing_newline_at_end_of_file.rs index a4b7e158e9f91..8470ce9f9dc4a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/missing_newline_at_end_of_file.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/missing_newline_at_end_of_file.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_codegen::Stylist; use ruff_text_size::{TextLen, TextRange}; @@ -22,13 +22,13 @@ use crate::Locator; /// ```python /// spam(1)\n /// ``` -#[violation] -pub struct MissingNewlineAtEndOfFile; +#[derive(ViolationMetadata)] +pub(crate) struct MissingNewlineAtEndOfFile; impl AlwaysFixableViolation for MissingNewlineAtEndOfFile { #[derive_message_formats] fn message(&self) -> String { - format!("No newline at end of file") + "No newline at end of file".to_string() } fn fix_title(&self) -> String { diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/mixed_spaces_and_tabs.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/mixed_spaces_and_tabs.rs index 5d4a5c47be9e9..6d86ca97752b6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/mixed_spaces_and_tabs.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/mixed_spaces_and_tabs.rs @@ -1,7 +1,7 @@ use ruff_text_size::{TextLen, TextRange}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::leading_indentation; use ruff_source_file::Line; @@ -25,13 +25,13 @@ use ruff_source_file::Line; /// ```python /// if a == 0:\n a = 1\n b = 1 /// ``` -#[violation] -pub struct MixedSpacesAndTabs; +#[derive(ViolationMetadata)] +pub(crate) struct MixedSpacesAndTabs; impl Violation for MixedSpacesAndTabs { #[derive_message_formats] fn message(&self) -> String { - format!("Indentation contains mixed spaces and tabs") + "Indentation contains mixed spaces and tabs".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/module_import_not_at_top_of_file.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/module_import_not_at_top_of_file.rs index 6e923f12d8078..17d7a830aeac9 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/module_import_not_at_top_of_file.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/module_import_not_at_top_of_file.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{PySourceType, Stmt}; use ruff_text_size::Ranged; @@ -39,8 +39,8 @@ use crate::checkers::ast::Checker; /// For Jupyter notebooks, this rule checks for imports that are not at the top of a *cell*. /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct ModuleImportNotAtTopOfFile { +#[derive(ViolationMetadata)] +pub(crate) struct ModuleImportNotAtTopOfFile { source_type: PySourceType, } @@ -48,17 +48,17 @@ impl Violation for ModuleImportNotAtTopOfFile { #[derive_message_formats] fn message(&self) -> String { if self.source_type.is_ipynb() { - format!("Module level import not at top of cell") + "Module level import not at top of cell".to_string() } else { - format!("Module level import not at top of file") + "Module level import not at top of file".to_string() } } } /// E402 -pub(crate) fn module_import_not_at_top_of_file(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn module_import_not_at_top_of_file(checker: &Checker, stmt: &Stmt) { if checker.semantic().seen_import_boundary() && checker.semantic().at_top_level() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ModuleImportNotAtTopOfFile { source_type: checker.source_type, }, diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/multiple_imports_on_one_line.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/multiple_imports_on_one_line.rs index 85193ed1b9946..625b082e8b56f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/multiple_imports_on_one_line.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/multiple_imports_on_one_line.rs @@ -1,7 +1,7 @@ use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Alias, Stmt}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; @@ -9,8 +9,8 @@ use ruff_python_trivia::indentation_at_offset; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Check for multiple imports on one line. @@ -30,24 +30,24 @@ use crate::Locator; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct MultipleImportsOnOneLine; +#[derive(ViolationMetadata)] +pub(crate) struct MultipleImportsOnOneLine; impl Violation for MultipleImportsOnOneLine { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Multiple imports on one line") + "Multiple imports on one line".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Split imports")) + Some("Split imports".to_string()) } } /// E401 -pub(crate) fn multiple_imports_on_one_line(checker: &mut Checker, stmt: &Stmt, names: &[Alias]) { +pub(crate) fn multiple_imports_on_one_line(checker: &Checker, stmt: &Stmt, names: &[Alias]) { if names.len() > 1 { let mut diagnostic = Diagnostic::new(MultipleImportsOnOneLine, stmt.range()); diagnostic.set_fix(split_imports( @@ -57,7 +57,7 @@ pub(crate) fn multiple_imports_on_one_line(checker: &mut Checker, stmt: &Stmt, n checker.indexer(), checker.stylist(), )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/not_tests.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/not_tests.rs index 7a479ac83470f..60668db001952 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/not_tests.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/not_tests.rs @@ -1,6 +1,6 @@ use crate::fix::edits::pad; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::generate_comparison; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_text_size::Ranged; @@ -27,13 +27,13 @@ use crate::registry::Rule; /// if X.B not in Y: /// pass /// ``` -#[violation] -pub struct NotInTest; +#[derive(ViolationMetadata)] +pub(crate) struct NotInTest; impl AlwaysFixableViolation for NotInTest { #[derive_message_formats] fn message(&self) -> String { - format!("Test for membership should be `not in`") + "Test for membership should be `not in`".to_string() } fn fix_title(&self) -> String { @@ -63,13 +63,13 @@ impl AlwaysFixableViolation for NotInTest { /// ``` /// /// [PEP8]: https://peps.python.org/pep-0008/#programming-recommendations -#[violation] -pub struct NotIsTest; +#[derive(ViolationMetadata)] +pub(crate) struct NotIsTest; impl AlwaysFixableViolation for NotIsTest { #[derive_message_formats] fn message(&self) -> String { - format!("Test for object identity should be `is not`") + "Test for object identity should be `is not`".to_string() } fn fix_title(&self) -> String { @@ -78,7 +78,7 @@ impl AlwaysFixableViolation for NotIsTest { } /// E713, E714 -pub(crate) fn not_tests(checker: &mut Checker, unary_op: &ast::ExprUnaryOp) { +pub(crate) fn not_tests(checker: &Checker, unary_op: &ast::ExprUnaryOp) { if !unary_op.op.is_not() { return; } @@ -112,7 +112,7 @@ pub(crate) fn not_tests(checker: &mut Checker, unary_op: &ast::ExprUnaryOp) { ), unary_op.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } [CmpOp::Is] => { @@ -133,7 +133,7 @@ pub(crate) fn not_tests(checker: &mut Checker, unary_op: &ast::ExprUnaryOp) { ), unary_op.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } _ => {} diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/tab_indentation.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/tab_indentation.rs index 500072a918399..78daee9727c62 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/tab_indentation.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/tab_indentation.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_index::Indexer; use ruff_source_file::LineRanges; use ruff_text_size::{TextRange, TextSize}; @@ -22,13 +22,13 @@ use crate::Locator; /// /// [PEP 8]: https://peps.python.org/pep-0008/#tabs-or-spaces /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct TabIndentation; +#[derive(ViolationMetadata)] +pub(crate) struct TabIndentation; impl Violation for TabIndentation { #[derive_message_formats] fn message(&self) -> String { - format!("Indentation contains tabs") + "Indentation contains tabs".to_string() } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/too_many_newlines_at_end_of_file.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/too_many_newlines_at_end_of_file.rs index 49cac9e8da35b..602c232d52102 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/too_many_newlines_at_end_of_file.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/too_many_newlines_at_end_of_file.rs @@ -1,11 +1,18 @@ +use std::iter::Peekable; + +use itertools::Itertools; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_parser::{TokenKind, Tokens}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_notebook::CellOffsets; +use ruff_python_parser::{Token, TokenKind, Tokens}; use ruff_text_size::{Ranged, TextRange, TextSize}; /// ## What it does /// Checks for files with multiple trailing blank lines. /// +/// In the case of notebooks, this check is applied to +/// each cell separately. +/// /// ## Why is this bad? /// Trailing blank lines in a file are superfluous. /// @@ -20,56 +27,98 @@ use ruff_text_size::{Ranged, TextRange, TextSize}; /// ```python /// spam(1)\n /// ``` -#[violation] -pub struct TooManyNewlinesAtEndOfFile { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyNewlinesAtEndOfFile { num_trailing_newlines: u32, + in_notebook: bool, } impl AlwaysFixableViolation for TooManyNewlinesAtEndOfFile { #[derive_message_formats] fn message(&self) -> String { - let TooManyNewlinesAtEndOfFile { - num_trailing_newlines, - } = self; - + let domain = if self.in_notebook { "cell" } else { "file" }; // We expect a single trailing newline; so two trailing newlines is one too many, three // trailing newlines is two too many, etc. - if *num_trailing_newlines > 2 { - format!("Too many newlines at end of file") + if self.num_trailing_newlines > 2 { + format!("Too many newlines at end of {domain}") } else { - format!("Extra newline at end of file") + format!("Extra newline at end of {domain}") } } fn fix_title(&self) -> String { - let TooManyNewlinesAtEndOfFile { - num_trailing_newlines, - } = self; - if *num_trailing_newlines > 2 { - "Remove trailing newlines".to_string() + let title = if self.num_trailing_newlines > 2 { + "Remove trailing newlines" } else { - "Remove trailing newline".to_string() - } + "Remove trailing newline" + }; + title.to_string() } } /// W391 -pub(crate) fn too_many_newlines_at_end_of_file(diagnostics: &mut Vec<Diagnostic>, tokens: &Tokens) { - let mut num_trailing_newlines = 0u32; - let mut start: Option<TextSize> = None; - let mut end: Option<TextSize> = None; - - // Count the number of trailing newlines. - for token in tokens.iter().rev() { - match token.kind() { - TokenKind::NonLogicalNewline | TokenKind::Newline => { - if num_trailing_newlines == 0 { - end = Some(token.end()); +pub(crate) fn too_many_newlines_at_end_of_file( + diagnostics: &mut Vec<Diagnostic>, + tokens: &Tokens, + cell_offsets: Option<&CellOffsets>, +) { + let mut tokens_iter = tokens.iter().rev().peekable(); + + if let Some(cell_offsets) = cell_offsets { + diagnostics.extend(notebook_newline_diagnostics(tokens_iter, cell_offsets)); + } else if let Some(diagnostic) = newline_diagnostic(&mut tokens_iter, false) { + diagnostics.push(diagnostic); + } +} + +/// Collects trailing newline diagnostics for each cell +fn notebook_newline_diagnostics<'a>( + mut tokens_iter: Peekable<impl Iterator<Item = &'a Token>>, + cell_offsets: &CellOffsets, +) -> Vec<Diagnostic> { + let mut results = Vec::new(); + let offset_iter = cell_offsets.iter().rev(); + + // NB: When interpreting the below, recall that the iterators + // have been reversed. + for &offset in offset_iter { + // Advance to offset + tokens_iter + .peeking_take_while(|tok| tok.end() >= offset) + .for_each(drop); + + let Some(diagnostic) = newline_diagnostic(&mut tokens_iter, true) else { + continue; + }; + + results.push(diagnostic); + } + results +} + +/// Possible diagnostic, with fix, for too many newlines in cell or source file +fn newline_diagnostic<'a>( + tokens_iter: &mut Peekable<impl Iterator<Item = &'a Token>>, + in_notebook: bool, +) -> Option<Diagnostic> { + let mut num_trailing_newlines: u32 = 0; + let mut newline_range_start: Option<TextSize> = None; + let mut newline_range_end: Option<TextSize> = None; + + while let Some(next_token) = tokens_iter.peek() { + match next_token.kind() { + TokenKind::Newline | TokenKind::NonLogicalNewline => { + if newline_range_end.is_none() { + newline_range_end = Some(next_token.end()); } - start = Some(token.end()); + newline_range_start = Some(next_token.end()); + + tokens_iter.next(); num_trailing_newlines += 1; } - TokenKind::Dedent => continue, + TokenKind::Dedent => { + tokens_iter.next(); + } _ => { break; } @@ -77,19 +126,23 @@ pub(crate) fn too_many_newlines_at_end_of_file(diagnostics: &mut Vec<Diagnostic> } if num_trailing_newlines == 0 || num_trailing_newlines == 1 { - return; + return None; } - let range = match (start, end) { - (Some(start), Some(end)) => TextRange::new(start, end), - _ => return, - }; - let mut diagnostic = Diagnostic::new( - TooManyNewlinesAtEndOfFile { - num_trailing_newlines, - }, - range, - ); - diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(range))); - diagnostics.push(diagnostic); + let (start, end) = (match (newline_range_start, newline_range_end) { + (Some(s), Some(e)) => Some((s, e)), + _ => None, + })?; + + let diagnostic_range = TextRange::new(start, end); + Some( + Diagnostic::new( + TooManyNewlinesAtEndOfFile { + num_trailing_newlines, + in_notebook, + }, + diagnostic_range, + ) + .with_fix(Fix::safe_edit(Edit::range_deletion(diagnostic_range))), + ) } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/trailing_whitespace.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/trailing_whitespace.rs index 0124e1bf44cb8..3c1e8f9bfb49f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/trailing_whitespace.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/trailing_whitespace.rs @@ -1,12 +1,12 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_index::Indexer; use ruff_source_file::Line; use ruff_text_size::{TextLen, TextRange, TextSize}; +use crate::Locator; use crate::registry::Rule; use crate::settings::LinterSettings; -use crate::Locator; /// ## What it does /// Checks for superfluous trailing whitespace. @@ -26,13 +26,13 @@ use crate::Locator; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations -#[violation] -pub struct TrailingWhitespace; +#[derive(ViolationMetadata)] +pub(crate) struct TrailingWhitespace; impl AlwaysFixableViolation for TrailingWhitespace { #[derive_message_formats] fn message(&self) -> String { - format!("Trailing whitespace") + "Trailing whitespace".to_string() } fn fix_title(&self) -> String { @@ -58,13 +58,13 @@ impl AlwaysFixableViolation for TrailingWhitespace { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#other-recommendations -#[violation] -pub struct BlankLineWithWhitespace; +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineWithWhitespace; impl AlwaysFixableViolation for BlankLineWithWhitespace { #[derive_message_formats] fn message(&self) -> String { - format!("Blank line contains whitespace") + "Blank line contains whitespace".to_string() } fn fix_title(&self) -> String { diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/type_comparison.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/type_comparison.rs index 7e57b9cc8f93d..97440863b796c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/type_comparison.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/type_comparison.rs @@ -1,6 +1,6 @@ use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_python_semantic::SemanticModel; @@ -48,20 +48,19 @@ use crate::checkers::ast::Checker; /// if isinstance(obj, int): /// pass /// ``` -#[violation] -pub struct TypeComparison; +#[derive(ViolationMetadata)] +pub(crate) struct TypeComparison; impl Violation for TypeComparison { #[derive_message_formats] fn message(&self) -> String { - format!( - "Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks" - ) + "Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks" + .to_string() } } /// E721 -pub(crate) fn type_comparison(checker: &mut Checker, compare: &ast::ExprCompare) { +pub(crate) fn type_comparison(checker: &Checker, compare: &ast::ExprCompare) { for (left, right) in std::iter::once(&*compare.left) .chain(&compare.comparators) .tuple_windows() @@ -77,9 +76,7 @@ pub(crate) fn type_comparison(checker: &mut Checker, compare: &ast::ExprCompare) } // Disallow the comparison. - checker - .diagnostics - .push(Diagnostic::new(TypeComparison, compare.range())); + checker.report_diagnostic(Diagnostic::new(TypeComparison, compare.range())); } } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/whitespace_after_decorator.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/whitespace_after_decorator.rs index f820b5f1ecd4b..efb3ed22dcf8f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/whitespace_after_decorator.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/whitespace_after_decorator.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Decorator; use ruff_python_trivia::is_python_whitespace; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -30,13 +30,13 @@ use crate::checkers::ast::Checker; /// /// [PEP 8]: https://peps.python.org/pep-0008/#maximum-line-length -#[violation] -pub struct WhitespaceAfterDecorator; +#[derive(ViolationMetadata)] +pub(crate) struct WhitespaceAfterDecorator; impl AlwaysFixableViolation for WhitespaceAfterDecorator { #[derive_message_formats] fn message(&self) -> String { - format!("Whitespace after decorator") + "Whitespace after decorator".to_string() } fn fix_title(&self) -> String { @@ -45,7 +45,7 @@ impl AlwaysFixableViolation for WhitespaceAfterDecorator { } /// E204 -pub(crate) fn whitespace_after_decorator(checker: &mut Checker, decorator_list: &[Decorator]) { +pub(crate) fn whitespace_after_decorator(checker: &Checker, decorator_list: &[Decorator]) { for decorator in decorator_list { let decorator_text = checker.locator().slice(decorator); @@ -64,7 +64,7 @@ pub(crate) fn whitespace_after_decorator(checker: &mut Checker, decorator_list: let mut diagnostic = Diagnostic::new(WhitespaceAfterDecorator, range); diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(range))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E101_E101.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E101_E101.py.snap index cfd70d8a76f1a..08e2e86ba5693 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E101_E101.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E101_E101.py.snap @@ -7,7 +7,7 @@ E101.py:11:1: E101 Indentation contains mixed spaces and tabs 10 | # E101 11 | print("mixed starts with tab") | ^^^^^^ E101 -12 | +12 | 13 | def func_mixed_start_with_space(): | @@ -17,7 +17,7 @@ E101.py:15:1: E101 Indentation contains mixed spaces and tabs 14 | # E101 15 | print("mixed starts with space") | ^^^^^^^^^^^^^^^ E101 -16 | +16 | 17 | def xyz(): | @@ -28,5 +28,3 @@ E101.py:19:1: E101 Indentation contains mixed spaces and tabs 19 | print("xyz"); | ^^^^ E101 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E111_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E111_E11.py.snap index 97ce990df6d73..7410af0c31557 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E111_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E111_E11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E11.py:3:1: E111 Indentation is not a multiple of 4 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E112_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E112_E11.py.snap index 70373df6f6ddc..032451e9ba548 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E112_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E112_E11.py.snap @@ -6,7 +6,7 @@ E11.py:9:1: E112 Expected an indented block 7 | #: E112 8 | if False: 9 | print() - | E112 + | ^ E112 10 | #: E113 11 | print() | @@ -46,7 +46,7 @@ E11.py:45:1: E112 Expected an indented block 43 | #: E112 44 | if False: # 45 | print() - | E112 + | ^ E112 46 | #: 47 | if False: | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E113_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E113_E11.py.snap index 295b8830d3c2f..09150ce64f11a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E113_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E113_E11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E11.py:9:1: SyntaxError: Expected an indented block after `if` statement | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E114_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E114_E11.py.snap index 46722a22f4c40..2d9342697289c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E114_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E114_E11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E11.py:9:1: SyntaxError: Expected an indented block after `if` statement | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E115_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E115_E11.py.snap index e51700d1090cd..e0ce2a827cbe9 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E115_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E115_E11.py.snap @@ -36,7 +36,7 @@ E11.py:30:1: E115 Expected an indented block (comment) 28 | def start(self): 29 | if True: 30 | # try: - | E115 + | ^ E115 31 | # self.master.start() 32 | # except MasterExit: | @@ -46,7 +46,7 @@ E11.py:31:1: E115 Expected an indented block (comment) 29 | if True: 30 | # try: 31 | # self.master.start() - | E115 + | ^ E115 32 | # except MasterExit: 33 | # self.shutdown() | @@ -56,7 +56,7 @@ E11.py:32:1: E115 Expected an indented block (comment) 30 | # try: 31 | # self.master.start() 32 | # except MasterExit: - | E115 + | ^ E115 33 | # self.shutdown() 34 | # finally: | @@ -66,7 +66,7 @@ E11.py:33:1: E115 Expected an indented block (comment) 31 | # self.master.start() 32 | # except MasterExit: 33 | # self.shutdown() - | E115 + | ^ E115 34 | # finally: 35 | # sys.exit() | @@ -76,7 +76,7 @@ E11.py:34:1: E115 Expected an indented block (comment) 32 | # except MasterExit: 33 | # self.shutdown() 34 | # finally: - | E115 + | ^ E115 35 | # sys.exit() 36 | self.master.start() | @@ -86,7 +86,7 @@ E11.py:35:1: E115 Expected an indented block (comment) 33 | # self.shutdown() 34 | # finally: 35 | # sys.exit() - | E115 + | ^ E115 36 | self.master.start() 37 | #: E117 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E116_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E116_E11.py.snap index 5a378f63e5f4c..e968a2526dc31 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E116_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E116_E11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E11.py:9:1: SyntaxError: Expected an indented block after `if` statement | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E117_E11.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E117_E11.py.snap index 22ca83d0b0a07..73be2664e6191 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E117_E11.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E117_E11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E11.py:6:1: E117 Over-indented | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E201_E20.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E201_E20.py.snap index 4d0dbb264503b..0aea3ff5f73ce 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E201_E20.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E201_E20.py.snap @@ -129,7 +129,7 @@ E20.py:107:6: E201 [*] Whitespace after '[' 106 | #: E201:1:6 107 | spam[ ~ham] | ^ E201 -108 | +108 | 109 | #: Okay | = help: Remove whitespace before '[' @@ -169,7 +169,7 @@ E20.py:145:5: E201 [*] Whitespace after '[' 144 | #: E201:1:5 145 | ham[ : upper] | ^ E201 -146 | +146 | 147 | #: Okay | = help: Remove whitespace before '[' diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E202_E20.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E202_E20.py.snap index d4044ba4a51e2..23b47a9a9244a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E202_E20.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E202_E20.py.snap @@ -151,7 +151,7 @@ E20.py:172:12: E202 [*] Whitespace before ']' 171 | #: E202:1:12 172 | ham[upper : ] | ^ E202 -173 | +173 | 174 | #: E203:1:10 | = help: Remove whitespace before ']' diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E203_E20.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E203_E20.py.snap index 7422f4309a74f..bcac95a6e6ead 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E203_E20.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E203_E20.py.snap @@ -191,7 +191,7 @@ E20.py:126:16: E203 [*] Whitespace before ':' 125 | #: E203:1:19 126 | {lower + offset : upper + offset} | ^ E203 -127 | +127 | 128 | #: E203:1:19 | = help: Remove whitespace before ':' @@ -211,7 +211,7 @@ E20.py:129:19: E203 [*] Whitespace before ':' 128 | #: E203:1:19 129 | ham[lower + offset : upper + offset] | ^^ E203 -130 | +130 | 131 | #: Okay | = help: Remove whitespace before ':' @@ -231,7 +231,7 @@ E20.py:157:21: E203 [*] Whitespace before ':' 156 | #: E203:1:21 157 | ham[lower + offset : : upper + offset] | ^ E203 -158 | +158 | 159 | #: E203:1:20 | = help: Remove whitespace before ':' @@ -251,7 +251,7 @@ E20.py:160:20: E203 [*] Whitespace before ':' 159 | #: E203:1:20 160 | ham[lower + offset: :upper + offset] | ^ E203 -161 | +161 | 162 | #: E203:1:20 | = help: Remove whitespace before ':' @@ -271,7 +271,7 @@ E20.py:163:20: E203 [*] Whitespace before ':' 162 | #: E203:1:20 163 | ham[{lower + offset : upper + offset} : upper + offset] | ^ E203 -164 | +164 | 165 | #: Okay | = help: Remove whitespace before ':' @@ -291,7 +291,7 @@ E20.py:175:10: E203 [*] Whitespace before ':' 174 | #: E203:1:10 175 | ham[upper :] | ^^ E203 -176 | +176 | 177 | #: Okay | = help: Remove whitespace before ':' @@ -311,7 +311,7 @@ E20.py:181:14: E203 [*] Whitespace before ':' 180 | #: E203:1:13 181 | ham[lower + 1 :, "columnname"] | ^^ E203 -182 | +182 | 183 | #: Okay | = help: Remove whitespace before ':' @@ -331,7 +331,7 @@ E20.py:187:17: E203 [*] Whitespace before ':' 186 | #: E203:1:13 187 | f"{ham[lower + 1 :, "columnname"]}" | ^^ E203 -188 | +188 | 189 | #: Okay: https://github.com/astral-sh/ruff/issues/12023 | = help: Remove whitespace before ':' diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E204_E204.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E204_E204.py.snap index 050562950c21b..2ef347934b097 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E204_E204.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E204_E204.py.snap @@ -43,13 +43,12 @@ E204.py:25:6: E204 [*] Whitespace after decorator E204.py:31:2: E204 [*] Whitespace after decorator | -30 | # E204 -31 | @ \ - | __^ -32 | | foo - | |_^ E204 -33 | def baz(): -34 | print('baz') +30 | # E204 +31 | @ \ + | ^^ E204 +32 | foo +33 | def baz(): +34 | print('baz') | = help: Remove whitespace diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E211_E21.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E211_E21.py.snap index 6c115b53c2636..d3f2362f78ab0 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E211_E21.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E211_E21.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E21.py:2:5: E211 [*] Whitespace before '(' | @@ -141,5 +142,3 @@ E21.py:27:27: E211 [*] Whitespace before '(' 28 28 | if sys.argv[i] == "--name" : 29 29 | return sys.argv[i + 1] 30 30 | return None - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E221_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E221_E22.py.snap index 7df31ee2f5c3b..ed500ca29f87b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E221_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E221_E22.py.snap @@ -171,7 +171,7 @@ E22.py:19:14: E221 [*] Multiple spaces before operator E22.py:184:5: E221 [*] Multiple spaces before operator | 182 | #: -183 | +183 | 184 | if a == 1: | ^^ E221 185 | print(a) @@ -185,3 +185,5 @@ E22.py:184:5: E221 [*] Multiple spaces before operator 184 |-if a == 1: 184 |+if a == 1: 185 185 | print(a) +186 186 | +187 187 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E222_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E222_E22.py.snap index 71fad6ac8ac73..9b6879bfbec07 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E222_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E222_E22.py.snap @@ -108,7 +108,7 @@ E22.py:36:7: E222 [*] Multiple spaces after operator E22.py:184:9: E222 [*] Multiple spaces after operator | 182 | #: -183 | +183 | 184 | if a == 1: | ^^ E222 185 | print(a) @@ -122,3 +122,5 @@ E22.py:184:9: E222 [*] Multiple spaces after operator 184 |-if a == 1: 184 |+if a == 1: 185 185 | print(a) +186 186 | +187 187 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E223_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E223_E22.py.snap index 363c9b3855b6e..200f808881629 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E223_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E223_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:43:2: E223 [*] Tab before operator | @@ -19,6 +20,4 @@ E22.py:43:2: E223 [*] Tab before operator 43 |+a = 3 # aligned with tab 44 44 | #: 45 45 | -46 46 | - - +46 46 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E224_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E224_E22.py.snap index 4f268d558377e..0e9c6256e9ca6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E224_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E224_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:48:5: E224 [*] Tab after operator | @@ -19,6 +20,4 @@ E22.py:48:5: E224 [*] Tab after operator 48 |+a += 1 49 49 | b += 1000 50 50 | #: -51 51 | - - +51 51 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E225_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E225_E22.py.snap index 26ef6f3c70256..e6dbca24d840e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E225_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E225_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:54:11: E225 [*] Missing whitespace around operator | @@ -251,5 +252,3 @@ E22.py:96:2: E225 [*] Missing whitespace around operator 97 97 | #: E225 E226 98 98 | c = (a +b)*(a - b) 99 99 | #: E225 E226 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E226_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E226_E22.py.snap index 881986bcc5329..6e16928ddf246 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E226_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E226_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:60:7: E226 [*] Missing whitespace around arithmetic operator | @@ -543,5 +544,3 @@ E22.py:119:14: E226 [*] Missing whitespace around arithmetic operator 120 120 | #: E227 121 121 | _1kB = _1MB>>10 122 122 | #: E227 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E227_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E227_E22.py.snap index 8edf3984b36c8..c6c317e218421 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E227_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E227_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:72:13: E227 [*] Missing whitespace around bitwise or shift operator | @@ -168,5 +169,3 @@ E22.py:154:11: E227 [*] Missing whitespace around bitwise or shift operator 155 155 | print >> sys.stdout, "x is an integer." 156 156 | x = x / 2 - 1 157 157 | x = 1 @ 2 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E228_E22.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E228_E22.py.snap index fd9f368f63bea..c72a3b1ae211e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E228_E22.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E228_E22.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E22.py:131:6: E228 [*] Missing whitespace around modulo operator | @@ -62,5 +63,3 @@ E22.py:135:26: E228 [*] Missing whitespace around modulo operator 136 136 | #: 137 137 | 138 138 | #: Okay - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E231_E23.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E231_E23.py.snap index 5a05a709d79f7..8846098bcc9b5 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E231_E23.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E231_E23.py.snap @@ -106,7 +106,7 @@ E23.py:33:6: E231 [*] Missing whitespace after ',' 32 | # E231 33 | f"{(a,b)}" | ^ E231 -34 | +34 | 35 | # Okay because it's hard to differentiate between the usages of a colon in a f-string | = help: Add missing whitespace @@ -126,7 +126,7 @@ E23.py:47:37: E231 [*] Missing whitespace after ':' 46 | #: E231 47 | {len(f's3://{self.s3_bucket_name}/'):1} | ^ E231 -48 | +48 | 49 | #: Okay | = help: Add missing whitespace @@ -603,7 +603,7 @@ E23.py:112:6: E231 [*] Missing whitespace after ':' E23.py:116:18: E231 [*] Missing whitespace after ':' | 114 | pass -115 | +115 | 116 | class PEP696Bad[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]: | ^ E231 117 | def pep_696_bad_method[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]( @@ -624,7 +624,7 @@ E23.py:116:18: E231 [*] Missing whitespace after ':' E23.py:116:40: E231 [*] Missing whitespace after ':' | 114 | pass -115 | +115 | 116 | class PEP696Bad[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]: | ^ E231 117 | def pep_696_bad_method[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]( @@ -645,7 +645,7 @@ E23.py:116:40: E231 [*] Missing whitespace after ':' E23.py:116:70: E231 [*] Missing whitespace after ':' | 114 | pass -115 | +115 | 116 | class PEP696Bad[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]: | ^ E231 117 | def pep_696_bad_method[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes]( @@ -789,10 +789,10 @@ E23.py:121:10: E231 [*] Missing whitespace after ':' E23.py:125:32: E231 [*] Missing whitespace after ':' | 123 | pass -124 | +124 | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): | ^ E231 -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… 127 | pass | = help: Add missing whitespace @@ -810,10 +810,10 @@ E23.py:125:32: E231 [*] Missing whitespace after ':' E23.py:125:54: E231 [*] Missing whitespace after ':' | 123 | pass -124 | +124 | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): | ^ E231 -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… 127 | pass | = help: Add missing whitespace @@ -831,10 +831,10 @@ E23.py:125:54: E231 [*] Missing whitespace after ':' E23.py:125:84: E231 [*] Missing whitespace after ':' | 123 | pass -124 | +124 | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): | ^ E231 -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… 127 | pass | = help: Add missing whitespace @@ -852,7 +852,7 @@ E23.py:125:84: E231 [*] Missing whitespace after ':' E23.py:126:47: E231 [*] Missing whitespace after ':' | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… | ^ E231 127 | pass | @@ -871,7 +871,7 @@ E23.py:126:47: E231 [*] Missing whitespace after ':' E23.py:126:69: E231 [*] Missing whitespace after ':' | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… | ^ E231 127 | pass | @@ -890,7 +890,7 @@ E23.py:126:69: E231 [*] Missing whitespace after ':' E23.py:126:99: E231 [*] Missing whitespace after ':' | 125 | class PEP696BadWithEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](): -126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_dynamic[x::-1]): +126 | class IndentedPEP696BadWithNonEmptyBases[A:object="foo"[::-1], B:object =[[["foo", "bar"]]], C:object= bytes](object, something_d… | ^ E231 127 | pass | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E241_E24.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E241_E24.py.snap index dba2129ca812e..f649c7853022f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E241_E24.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E241_E24.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E24.py:2:8: E241 [*] Multiple spaces after comma | @@ -72,5 +73,3 @@ E24.py:13:18: E241 [*] Multiple spaces after comma 12 12 | ef, +h, 13 |- c, -d] 13 |+ c, -d] - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E242_E24.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E242_E24.py.snap index bf93c26308780..f62ba2da45a45 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E242_E24.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E242_E24.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E24.py:6:8: E242 [*] Tab after comma | @@ -21,5 +22,3 @@ E24.py:6:8: E242 [*] Tab after comma 7 7 | #: Okay 8 8 | b = (1, 20) # space before 20 9 9 | #: E241 E241 E241 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E251_E25.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E251_E25.py.snap index a87bcdff5586b..ae5584a4b38c7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E251_E25.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E251_E25.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E25.py:2:12: E251 [*] Unexpected spaces around keyword / parameter equals | @@ -231,5 +232,3 @@ E25.py:23:10: E251 [*] Unexpected spaces around keyword / parameter equals 24 24 | ) 25 25 | #: Okay 26 26 | foo(bar=(1 == 1)) - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E252_E25.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E252_E25.py.snap index 2fbc8575d72d6..5765ad2908399 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E252_E25.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E252_E25.py.snap @@ -278,7 +278,7 @@ E25.py:64:96: E252 [*] Missing whitespace around parameter equals E25.py:67:18: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -298,7 +298,7 @@ E25.py:67:18: E252 [*] Missing whitespace around parameter equals E25.py:67:18: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -318,7 +318,7 @@ E25.py:67:18: E252 [*] Missing whitespace around parameter equals E25.py:67:26: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -338,7 +338,7 @@ E25.py:67:26: E252 [*] Missing whitespace around parameter equals E25.py:67:33: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -358,7 +358,7 @@ E25.py:67:33: E252 [*] Missing whitespace around parameter equals E25.py:67:49: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -378,7 +378,7 @@ E25.py:67:49: E252 [*] Missing whitespace around parameter equals E25.py:67:49: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -398,7 +398,7 @@ E25.py:67:49: E252 [*] Missing whitespace around parameter equals E25.py:67:64: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -418,7 +418,7 @@ E25.py:67:64: E252 [*] Missing whitespace around parameter equals E25.py:67:64: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -438,7 +438,7 @@ E25.py:67:64: E252 [*] Missing whitespace around parameter equals E25.py:67:80: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass @@ -458,7 +458,7 @@ E25.py:67:80: E252 [*] Missing whitespace around parameter equals E25.py:67:96: E252 [*] Missing whitespace around parameter equals | 65 | pass -66 | +66 | 67 | class PEP696Bad[A=int, B =str, C= bool, D:object=int, E: object=str, F: object =bool, G: object= bytes]: | ^ E252 68 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E261_E26.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E261_E26.py.snap index d9b8a7679c0f4..c0199f8794419 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E261_E26.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E261_E26.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E26.py:2:5: E261 [*] Insert at least two spaces before an inline comment | @@ -18,5 +19,3 @@ E26.py:2:5: E261 [*] Insert at least two spaces before an inline comment 3 3 | #: E262:1:12 4 4 | x = x + 1 #Increment x 5 5 | #: E262:1:12 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E262_E26.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E262_E26.py.snap index 658391acdc36b..a20957b68dd70 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E262_E26.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E262_E26.py.snap @@ -91,7 +91,7 @@ E26.py:66:9: E262 [*] Inline comment should start with `# ` 65 | # (Two spaces) Ok for block comment 66 | a = 42 # (Two spaces) | ^^^^^^^^^^^^^^^ E262 -67 | +67 | 68 | #: E265:5:1 | = help: Format space @@ -109,10 +109,10 @@ E26.py:66:9: E262 [*] Inline comment should start with `# ` E26.py:84:8: E262 [*] Inline comment should start with `# ` | 82 | ## Foo -83 | +83 | 84 | a = 1 ## Foo | ^^^^^^ E262 -85 | +85 | 86 | a = 1 #:Foo | = help: Format space @@ -129,7 +129,7 @@ E26.py:84:8: E262 [*] Inline comment should start with `# ` E26.py:86:8: E262 [*] Inline comment should start with `# ` | 84 | a = 1 ## Foo -85 | +85 | 86 | a = 1 #:Foo | ^^^^^ E262 | @@ -141,5 +141,3 @@ E26.py:86:8: E262 [*] Inline comment should start with `# ` 85 85 | 86 |-a = 1 #:Foo 86 |+a = 1 #: Foo - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E265_E26.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E265_E26.py.snap index 92b25ccb212b6..d20b25b5c0cda 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E265_E26.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E265_E26.py.snap @@ -69,7 +69,7 @@ E26.py:32:1: E265 [*] Block comment should start with `# ` 31 | #: Okay 32 | #!/usr/bin/env python | ^^^^^^^^^^^^^^^^^^^^^ E265 -33 | +33 | 34 | pass # an inline comment | = help: Format space @@ -107,10 +107,10 @@ E26.py:73:1: E265 [*] Block comment should start with `# ` E26.py:78:1: E265 [*] Block comment should start with `# ` | 76 | #: Colon prefix is okay -77 | +77 | 78 | ###This is a variable ### | ^^^^^^^^^^^^^^^^^^^^^^^^^ E265 -79 | +79 | 80 | # We should strip the space, but preserve the hashes. | = help: Format space @@ -124,5 +124,3 @@ E26.py:78:1: E265 [*] Block comment should start with `# ` 79 79 | 80 80 | # We should strip the space, but preserve the hashes. 81 81 | #: E266:1:3 - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E266_E26.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E266_E26.py.snap index 4469e1b225d64..b32057f33758f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E266_E26.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E266_E26.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E26.py:19:5: E266 [*] Too many leading `#` before block comment | 17 | def how_it_feel(r): -18 | +18 | 19 | ### This is a variable ### | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E266 20 | a = 42 @@ -24,7 +24,7 @@ E26.py:19:5: E266 [*] Too many leading `#` before block comment E26.py:22:5: E266 [*] Too many leading `#` before block comment | 20 | a = 42 -21 | +21 | 22 | ### Of course it is unused | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E266 23 | return @@ -89,7 +89,7 @@ E26.py:82:1: E266 [*] Too many leading `#` before block comment 81 | #: E266:1:3 82 | ## Foo | ^^^^^^^ E266 -83 | +83 | 84 | a = 1 ## Foo | = help: Remove leading `#` @@ -102,6 +102,4 @@ E26.py:82:1: E266 [*] Too many leading `#` before block comment 82 |+# Foo 83 83 | 84 84 | a = 1 ## Foo -85 85 | - - +85 85 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E271_E27.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E271_E27.py.snap index ffd296ba6a802..71f1f1b6f348c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E271_E27.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E271_E27.py.snap @@ -195,7 +195,7 @@ E27.py:71:5: E271 [*] Multiple spaces after keyword 70 | #: E271 71 | type Number = int | ^^ E271 -72 | +72 | 73 | #: E273 | = help: Replace with single space diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E272_E27.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E272_E27.py.snap index c9f27f6f2a97c..f125dff9abf48 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E272_E27.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E272_E27.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E27.py:21:2: E272 [*] Multiple spaces before keyword | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E273_E27.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E273_E27.py.snap index ecdb9d3a290e7..c7ce1e345dd2e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E273_E27.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E273_E27.py.snap @@ -111,7 +111,7 @@ E27.py:74:5: E273 [*] Tab after keyword 73 | #: E273 74 | type Number = int | ^^^^ E273 -75 | +75 | 76 | #: E275 | = help: Replace with single space diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E274_E27.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E274_E27.py.snap index 062a61bebf50d..9df5f766a3cd4 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E274_E27.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E274_E27.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E27.py:29:2: E274 [*] Tab before keyword | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E275_E27.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E275_E27.py.snap index 0d0cc6d0dfe56..0504b5be5034f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E275_E27.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E275_E27.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E27.py:38:8: E275 [*] Missing whitespace after keyword | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30.py.snap index c224ebbeb7806..7c7fb044691c1 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.py:478:5: E301 [*] Expected 1 blank line, found 0 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30_syntax_error.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30_syntax_error.py.snap index 195fb4189a1d6..5e99bc6e15ecd 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E301_E30_syntax_error.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' | 2 | # parenthesis. -3 | +3 | 4 | def foo[T1, T2(): | ^ 5 | pass @@ -33,11 +33,11 @@ E30_syntax_error.py:15:5: E301 Expected 1 blank line, found 0 E30_syntax_error.py:18:11: SyntaxError: Expected ')', found newline | 16 | pass -17 | +17 | 18 | foo = Foo( | ^ -19 | -20 | +19 | +20 | 21 | def top( | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30.py.snap index e3fe5c1f337a7..5c422baa3d369 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30.py.snap @@ -46,7 +46,7 @@ E30.py:540:1: E302 [*] Expected 2 blank lines, found 0 E30.py:549:1: E302 [*] Expected 2 blank lines, found 1 | 547 | pass -548 | +548 | 549 | def b(): | ^^^ E302 550 | pass @@ -66,7 +66,7 @@ E30.py:549:1: E302 [*] Expected 2 blank lines, found 1 E30.py:560:1: E302 [*] Expected 2 blank lines, found 1 | 558 | # comment -559 | +559 | 560 | def b(): | ^^^ E302 561 | pass @@ -86,7 +86,7 @@ E30.py:560:1: E302 [*] Expected 2 blank lines, found 1 E30.py:569:1: E302 [*] Expected 2 blank lines, found 1 | 567 | pass -568 | +568 | 569 | async def b(): | ^^^^^ E302 570 | pass @@ -106,7 +106,7 @@ E30.py:569:1: E302 [*] Expected 2 blank lines, found 1 E30.py:578:1: E302 [*] Expected 2 blank lines, found 1 | 576 | pass -577 | +577 | 578 | async def x(y: int = 1): | ^^^^^ E302 579 | pass @@ -206,7 +206,7 @@ E30.py:624:1: E302 [*] Expected 2 blank lines, found 0 E30.py:634:1: E302 [*] Expected 2 blank lines, found 1 | 632 | def fn(a: str) -> str: ... -633 | +633 | 634 | def fn(a: int | str) -> int | str: | ^^^ E302 635 | ... diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_docstring.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_docstring.py.snap index 4fa4accc0cf4c..9e725801e05a2 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_docstring.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_docstring.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E302_first_line_docstring.py:3:1: E302 [*] Expected 2 blank lines, found 1 | 1 | """Test where the error is after the module's docstring.""" -2 | +2 | 3 | def fn(): | ^^^ E302 4 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_expression.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_expression.py.snap index 9cd8779d1b6f7..ecbe189c7679f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_expression.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_expression.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E302_first_line_expression.py:3:1: E302 [*] Expected 2 blank lines, found 1 | 1 | "Test where the first line is a comment, " + "and the rule violation follows it." -2 | +2 | 3 | def fn(): | ^^^ E302 4 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_function.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_function.py.snap index a847c86079c7a..cd03aac6573af 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_function.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_function.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E302_first_line_function.py:4:1: E302 [*] Expected 2 blank lines, found 1 | 2 | pass -3 | +3 | 4 | def fn2(): | ^^^ E302 5 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_statement.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_statement.py.snap index a4736c7dd4e63..ac0bdf5e2e893 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_statement.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E302_first_line_statement.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E302_first_line_statement.py:3:1: E302 [*] Expected 2 blank lines, found 1 | 1 | print("Test where the first line is a statement, and the rule violation follows it.") -2 | +2 | 3 | def fn(): | ^^^ E302 4 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30_syntax_error.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30_syntax_error.py.snap index 4f0249230cda0..88d95e3ee9a21 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E302_E30_syntax_error.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' | 2 | # parenthesis. -3 | +3 | 4 | def foo[T1, T2(): | ^ 5 | pass @@ -13,7 +13,7 @@ E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' E30_syntax_error.py:7:1: E302 Expected 2 blank lines, found 1 | 5 | pass -6 | +6 | 7 | def bar(): | ^^^ E302 8 | pass @@ -33,11 +33,11 @@ E30_syntax_error.py:13:18: SyntaxError: Expected ')', found newline E30_syntax_error.py:18:11: SyntaxError: Expected ')', found newline | 16 | pass -17 | +17 | 18 | foo = Foo( | ^ -19 | -20 | +19 | +20 | 21 | def top( | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30.py.snap index a5f47acd9e976..5e8f5f9e9ce6b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30.py.snap @@ -23,7 +23,7 @@ E30.py:644:5: E303 [*] Too many blank lines (2) | 644 | # arbitrary comment | ^^^^^^^^^^^^^^^^^^^ E303 -645 | +645 | 646 | def inner(): # E306 not expected (pycodestyle detects E306) | = help: Remove extraneous blank line(s) @@ -76,7 +76,7 @@ E30.py:676:1: E303 [*] Too many blank lines (3) | 676 | # comment | ^^^^^^^^^ E303 -677 | +677 | 678 | print() | = help: Remove extraneous blank line(s) @@ -110,7 +110,7 @@ E30.py:690:5: E303 [*] Too many blank lines (2) | 690 | # another comment | ^^^^^^^^^^^^^^^^^ E303 -691 | +691 | 692 | print() | = help: Remove extraneous blank line(s) @@ -198,7 +198,7 @@ E30.py:734:5: E303 [*] Too many blank lines (2) | 734 | # another comment | ^^^^^^^^^^^^^^^^^ E303 -735 | +735 | 736 | def test(self): pass | = help: Remove extraneous blank line(s) diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_comment.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_comment.py.snap index 0494356fb0a58..368a0521a34c5 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_comment.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_comment.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E303_first_line_comment.py:5:1: E303 [*] Too many blank lines (3) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_docstring.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_docstring.py.snap index d709f904ddbd6..d1994e7275b2a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_docstring.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_docstring.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E303_first_line_docstring.py:5:1: E303 [*] Too many blank lines (3) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_expression.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_expression.py.snap index d81f9098c5312..de3e3df25cb7b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_expression.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_expression.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E303_first_line_expression.py:5:1: E303 [*] Too many blank lines (3) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_statement.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_statement.py.snap index 7197d3e13338d..fef2b71f83921 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_statement.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E303_first_line_statement.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E303_first_line_statement.py:5:1: E303 [*] Too many blank lines (3) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30_syntax_error.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30_syntax_error.py.snap index cc3a491b98230..f268b987e1358 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E303_E30_syntax_error.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' | 2 | # parenthesis. -3 | +3 | 4 | def foo[T1, T2(): | ^ 5 | pass @@ -32,11 +32,11 @@ E30_syntax_error.py:13:18: SyntaxError: Expected ')', found newline E30_syntax_error.py:18:11: SyntaxError: Expected ')', found newline | 16 | pass -17 | +17 | 18 | foo = Foo( | ^ -19 | -20 | +19 | +20 | 21 | def top( | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E304_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E304_E30.py.snap index 2c53c6bbf7092..fe68174f76bd2 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E304_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E304_E30.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30.py:765:1: E304 [*] Blank lines found after function decorator (1) | 763 | @decorator -764 | +764 | 765 | def function(): | ^^^ E304 766 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30.py.snap index 275e9a19ef86c..482f2d428e03c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30.py.snap @@ -40,7 +40,7 @@ E30.py:809:1: E305 [*] Expected 2 blank lines after class or function definition E30.py:821:1: E305 [*] Expected 2 blank lines after class or function definition, found (1) | 819 | # another comment -820 | +820 | 821 | try: | ^^^ E305 822 | fn() @@ -79,7 +79,7 @@ E30.py:833:1: E305 [*] Expected 2 blank lines after class or function definition E30.py:846:1: E305 [*] Expected 2 blank lines after class or function definition, found (1) | 844 | blah, blah -845 | +845 | 846 | if __name__ == '__main__': | ^^ E305 847 | main() diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30_syntax_error.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30_syntax_error.py.snap index 8a63b25af3ab4..6d5796ccab8d3 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E305_E30_syntax_error.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' | 2 | # parenthesis. -3 | +3 | 4 | def foo[T1, T2(): | ^ 5 | pass @@ -23,7 +23,7 @@ E30_syntax_error.py:13:18: SyntaxError: Expected ')', found newline E30_syntax_error.py:18:1: E305 Expected 2 blank lines after class or function definition, found (1) | 16 | pass -17 | +17 | 18 | foo = Foo( | ^^^ E305 | @@ -32,11 +32,11 @@ E30_syntax_error.py:18:1: E305 Expected 2 blank lines after class or function de E30_syntax_error.py:18:11: SyntaxError: Expected ')', found newline | 16 | pass -17 | +17 | 18 | foo = Foo( | ^ -19 | -20 | +19 | +20 | 21 | def top( | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30.py.snap index 8f83acc86f9d3..6833baa68c285 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.py:854:5: E306 [*] Expected 1 blank line before a nested definition, found 0 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30_syntax_error.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30_syntax_error.py.snap index 726be4dd3dda9..226c3ad35a3f6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E306_E30_syntax_error.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_syntax_error.py:4:15: SyntaxError: Expected ']', found '(' | 2 | # parenthesis. -3 | +3 | 4 | def foo[T1, T2(): | ^ 5 | pass @@ -23,11 +23,11 @@ E30_syntax_error.py:13:18: SyntaxError: Expected ')', found newline E30_syntax_error.py:18:11: SyntaxError: Expected ')', found newline | 16 | pass -17 | +17 | 18 | foo = Foo( | ^ -19 | -20 | +19 | +20 | 21 | def top( | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E401_E40.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E401_E40.py.snap index 165907675e5bc..86b9b31306792 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E401_E40.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E401_E40.py.snap @@ -6,7 +6,7 @@ E40.py:2:1: E401 [*] Multiple imports on one line 1 | #: E401 2 | import os, sys | ^^^^^^^^^^^^^^ E401 -3 | +3 | 4 | #: Okay | = help: Split imports @@ -46,7 +46,7 @@ E40.py:66:1: E401 [*] Multiple imports on one line 65 | import re as regex, string # also with a comment! 66 | import re as regex, string; x = 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 -67 | +67 | 68 | x = 1; import re as regex, string | = help: Split imports @@ -64,7 +64,7 @@ E40.py:66:1: E401 [*] Multiple imports on one line E40.py:68:8: E401 [*] Multiple imports on one line | 66 | import re as regex, string; x = 1 -67 | +67 | 68 | x = 1; import re as regex, string | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 | @@ -85,7 +85,7 @@ E40.py:72:5: E401 [*] Multiple imports on one line 71 | def blah(): 72 | import datetime as dt, copy | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 -73 | +73 | 74 | def nested_and_tested(): | = help: Split imports @@ -106,7 +106,7 @@ E40.py:75:9: E401 [*] Multiple imports on one line 74 | def nested_and_tested(): 75 | import builtins, textwrap as tw | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 -76 | +76 | 77 | x = 1; import re as regex, string | = help: Split imports @@ -125,7 +125,7 @@ E40.py:75:9: E401 [*] Multiple imports on one line E40.py:77:16: E401 [*] Multiple imports on one line | 75 | import builtins, textwrap as tw -76 | +76 | 77 | x = 1; import re as regex, string | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 78 | import re as regex, string; x = 1 @@ -147,7 +147,7 @@ E40.py:78:9: E401 [*] Multiple imports on one line 77 | x = 1; import re as regex, string 78 | import re as regex, string; x = 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 -79 | +79 | 80 | if True: import re as regex, string | = help: Split imports @@ -164,7 +164,7 @@ E40.py:78:9: E401 [*] Multiple imports on one line E40.py:80:14: E401 [*] Multiple imports on one line | 78 | import re as regex, string; x = 1 -79 | +79 | 80 | if True: import re as regex, string | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E401 | @@ -176,5 +176,3 @@ E40.py:80:14: E401 [*] Multiple imports on one line 79 79 | 80 |- if True: import re as regex, string 80 |+ if True: import re as regex; import string - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E40.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E40.py.snap index 6d87474964664..bbf2e510a7bb6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E40.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E40.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E40.py:56:1: E402 Module level import not at top of file | 54 | VERSION = '1.2.3' -55 | +55 | 56 | import foo | ^^^^^^^^^^ E402 57 | #: E402 @@ -17,17 +17,17 @@ E40.py:58:1: E402 Module level import not at top of file 57 | #: E402 58 | import foo | ^^^^^^^^^^ E402 -59 | +59 | 60 | a = 1 | E40.py:62:1: E402 Module level import not at top of file | 60 | a = 1 -61 | +61 | 62 | import bar | ^^^^^^^^^^ E402 -63 | +63 | 64 | #: E401 | @@ -45,16 +45,14 @@ E40.py:66:1: E402 Module level import not at top of file 65 | import re as regex, string # also with a comment! 66 | import re as regex, string; x = 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E402 -67 | +67 | 68 | x = 1; import re as regex, string | E40.py:68:8: E402 Module level import not at top of file | 66 | import re as regex, string; x = 1 -67 | +67 | 68 | x = 1; import re as regex, string | ^^^^^^^^^^^^^^^^^^^^^^^^^^ E402 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402.ipynb.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402.ipynb.snap index 7c4447f71c60a..9cbf106ef958f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402.ipynb.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402.ipynb.snap @@ -4,17 +4,17 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E402.ipynb:9:1: E402 Module level import not at top of cell | 7 | os.path - 8 | + 8 | 9 | import pathlib | ^^^^^^^^^^^^^^ E402 -10 | +10 | 11 | import a | E402.ipynb:22:1: E402 Module level import not at top of cell | 20 | __some__magic = 1 -21 | +21 | 22 | import c | ^^^^^^^^ E402 23 | import ok @@ -24,6 +24,6 @@ E402.ipynb:30:1: E402 Module level import not at top of cell | 30 | import no_ok | ^^^^^^^^^^^^ E402 -31 | +31 | 32 | %%time | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_0.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_0.py.snap index 197644bcd690f..dff5430ecbf41 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_0.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_0.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E402_0.py:35:1: E402 Module level import not at top of file | 33 | __some__magic = 1 -34 | +34 | 35 | import h | ^^^^^^^^ E402 | @@ -12,7 +12,7 @@ E402_0.py:35:1: E402 Module level import not at top of file E402_0.py:45:1: E402 Module level import not at top of file | 43 | import j -44 | +44 | 45 | import k; import l | ^^^^^^^^ E402 | @@ -20,9 +20,7 @@ E402_0.py:45:1: E402 Module level import not at top of file E402_0.py:45:11: E402 Module level import not at top of file | 43 | import j -44 | +44 | 45 | import k; import l | ^^^^^^^^ E402 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_1.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_1.py.snap index 069d635ce46e1..a035c4d914b90 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_1.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_1.py.snap @@ -4,19 +4,17 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E402_1.py:5:1: E402 Module level import not at top of file | 3 | """Some other docstring.""" -4 | +4 | 5 | import b | ^^^^^^^^ E402 -6 | +6 | 7 | """Some other docstring.""" | E402_1.py:9:1: E402 Module level import not at top of file | 7 | """Some other docstring.""" -8 | +8 | 9 | import c | ^^^^^^^^ E402 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_2.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_2.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_2.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_3.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_3.py.snap new file mode 100644 index 0000000000000..e5d90e3bfab3c --- /dev/null +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_3.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_4.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_4.py.snap new file mode 100644 index 0000000000000..195339b45399d --- /dev/null +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_4.py.snap @@ -0,0 +1,3 @@ +--- +source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +--- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_5.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_5.py.snap new file mode 100644 index 0000000000000..81d49b4bba9f4 --- /dev/null +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E402_E402_5.py.snap @@ -0,0 +1,3 @@ +--- +source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +--- \ No newline at end of file diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501.py.snap index e4d4f16e242b8..b7eab7d0159f6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E501.py:5:89: E501 Line too long (123 > 88) | 3 | https://github.com/PyCQA/pycodestyle/pull/258/files#diff-841c622497a8033d10152bfdfb15b20b92437ecdea21a260944ea86b77b51533 -4 | +4 | 5 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 6 | """ @@ -49,11 +49,9 @@ E501.py:43:89: E501 Line too long (105 > 88) E501.py:83:89: E501 Line too long (147 > 88) | -81 | class Bar: -82 | """ -83 | This is a long sentence that ends with a shortened URL and, therefore, could easily be broken across multiple lines ([source](https://ruff.rs)) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -84 | """ +81 | … +82 | … +83 | … URL and, therefore, could easily be broken across multiple lines ([source](https://ruff.rs)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +84 | … | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_3.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_3.py.snap index a15f167fbed79..7166e26560e61 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_3.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E501_3.py:11:89: E501 Line too long (89 > 88) | @@ -7,5 +8,3 @@ E501_3.py:11:89: E501 Line too long (89 > 88) 11 | "shape:" + "shape:" + "shape:" + "shape:" + "shape:" + "shape:" + "shape:" + "shape:aaaa" # type: ignore | ^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_4.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_4.py.snap index 268c8156fcbd6..8af342273e06a 100644 Binary files a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_4.py.snap and b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E501_E501_4.py.snap differ diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E701_E70.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E701_E70.py.snap index ddb2fbd2b71a5..a4bf3aaaf16ec 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E701_E70.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E701_E70.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E70.py:2:5: E701 Multiple statements on one line (colon) | @@ -139,5 +140,3 @@ E70.py:59:12: E701 Multiple statements on one line (colon) 60 | #: 61 | class Foo: | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E702_E70.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E702_E70.py.snap index 56e7718289c28..d3232a1b9c218 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E702_E70.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E702_E70.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E70.py:6:10: E702 Multiple statements on one line (semicolon) | @@ -70,5 +71,3 @@ E70.py:65:4: E702 Multiple statements on one line (semicolon) 66 | #: E703:2:1 67 | 0\ | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E70.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E70.py.snap index 712fd8e14bddd..399f4bfbb5b5f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E70.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E70.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E70.py:10:13: E703 [*] Statement ends with an unnecessary semicolon | @@ -105,5 +106,3 @@ E70.py:71:4: E703 [*] Statement ends with an unnecessary semicolon 71 |+ 5 72 72 | #: 73 73 | with x(y) as z: ... - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E703.ipynb.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E703.ipynb.snap index 068f245637b5c..902265b169659 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E703.ipynb.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E703_E703.ipynb.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E703.ipynb:5:2: E703 [*] Statement ends with an unnecessary semicolon | @@ -42,5 +43,3 @@ E703.ipynb:9:6: E703 [*] Statement ends with an unnecessary semicolon 10 10 | # Semicolons with multiple expressions 11 11 | x; x; 12 12 | # Comments, newlines and whitespace - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E711_E711.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E711_E711.py.snap index ebb91bb228c00..133712eea9ead 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E711_E711.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E711_E711.py.snap @@ -168,7 +168,7 @@ E711.py:23:4: E711 [*] Comparison to `None` should be `cond is None` E711.py:26:9: E711 [*] Comparison to `None` should be `cond is None` | 24 | pass -25 | +25 | 26 | if x == None != None: | ^^^^ E711 27 | pass @@ -188,7 +188,7 @@ E711.py:26:9: E711 [*] Comparison to `None` should be `cond is None` E711.py:26:17: E711 [*] Comparison to `None` should be `cond is not None` | 24 | pass -25 | +25 | 26 | if x == None != None: | ^^^^ E711 27 | pass @@ -204,5 +204,3 @@ E711.py:26:17: E711 [*] Comparison to `None` should be `cond is not None` 27 27 | pass 28 28 | 29 29 | #: Okay - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E712_E712.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E712_E712.py.snap index 0c98438051b37..70d56f46d7cea 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E712_E712.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E712_E712.py.snap @@ -14,7 +14,7 @@ E712.py:2:4: E712 [*] Avoid equality comparisons to `True`; use `if res:` for tr ℹ Unsafe fix 1 1 | #: E712 2 |-if res == True: - 2 |+if res is True: + 2 |+if res: 3 3 | pass 4 4 | #: E712 5 5 | if res != False: @@ -35,7 +35,7 @@ E712.py:5:4: E712 [*] Avoid inequality comparisons to `False`; use `if res:` for 3 3 | pass 4 4 | #: E712 5 |-if res != False: - 5 |+if res is not False: + 5 |+if res: 6 6 | pass 7 7 | #: E712 8 8 | if True != res: @@ -56,7 +56,7 @@ E712.py:8:4: E712 [*] Avoid inequality comparisons to `True`; use `if not res:` 6 6 | pass 7 7 | #: E712 8 |-if True != res: - 8 |+if True is not res: + 8 |+if not res: 9 9 | pass 10 10 | #: E712 11 11 | if False == res: @@ -77,7 +77,7 @@ E712.py:11:4: E712 [*] Avoid equality comparisons to `False`; use `if not res:` 9 9 | pass 10 10 | #: E712 11 |-if False == res: - 11 |+if False is res: + 11 |+if not res: 12 12 | pass 13 13 | #: E712 14 14 | if res[1] == True: @@ -98,7 +98,7 @@ E712.py:14:4: E712 [*] Avoid equality comparisons to `True`; use `if res[1]:` fo 12 12 | pass 13 13 | #: E712 14 |-if res[1] == True: - 14 |+if res[1] is True: + 14 |+if res[1]: 15 15 | pass 16 16 | #: E712 17 17 | if res[1] != False: @@ -119,7 +119,7 @@ E712.py:17:4: E712 [*] Avoid inequality comparisons to `False`; use `if res[1]:` 15 15 | pass 16 16 | #: E712 17 |-if res[1] != False: - 17 |+if res[1] is not False: + 17 |+if res[1]: 18 18 | pass 19 19 | #: E712 20 20 | var = 1 if cond == True else -1 if cond == False else cond @@ -140,7 +140,7 @@ E712.py:20:12: E712 [*] Avoid equality comparisons to `True`; use `if cond:` for 18 18 | pass 19 19 | #: E712 20 |-var = 1 if cond == True else -1 if cond == False else cond - 20 |+var = 1 if cond is True else -1 if cond == False else cond + 20 |+var = 1 if cond else -1 if cond == False else cond 21 21 | #: E712 22 22 | if (True) == TrueElement or x == TrueElement: 23 23 | pass @@ -161,7 +161,7 @@ E712.py:20:36: E712 [*] Avoid equality comparisons to `False`; use `if not cond: 18 18 | pass 19 19 | #: E712 20 |-var = 1 if cond == True else -1 if cond == False else cond - 20 |+var = 1 if cond == True else -1 if cond is False else cond + 20 |+var = 1 if cond == True else -1 if not cond else cond 21 21 | #: E712 22 22 | if (True) == TrueElement or x == TrueElement: 23 23 | pass @@ -181,7 +181,7 @@ E712.py:22:4: E712 [*] Avoid equality comparisons to `True`; use `if TrueElement 20 20 | var = 1 if cond == True else -1 if cond == False else cond 21 21 | #: E712 22 |-if (True) == TrueElement or x == TrueElement: - 22 |+if (True) is TrueElement or x == TrueElement: + 22 |+if (TrueElement) or x == TrueElement: 23 23 | pass 24 24 | 25 25 | if res == True != False: @@ -189,7 +189,7 @@ E712.py:22:4: E712 [*] Avoid equality comparisons to `True`; use `if TrueElement E712.py:25:4: E712 [*] Avoid equality comparisons to `True` or `False` | 23 | pass -24 | +24 | 25 | if res == True != False: | ^^^^^^^^^^^^^^^^^^^^ E712 26 | pass @@ -209,7 +209,7 @@ E712.py:25:4: E712 [*] Avoid equality comparisons to `True` or `False` E712.py:25:4: E712 [*] Avoid equality comparisons to `True` or `False` | 23 | pass -24 | +24 | 25 | if res == True != False: | ^^^^^^^^^^^^^^^^^^^^ E712 26 | pass @@ -229,7 +229,7 @@ E712.py:25:4: E712 [*] Avoid equality comparisons to `True` or `False` E712.py:28:3: E712 [*] Avoid equality comparisons to `True`; use `if TrueElement:` for truth checks | 26 | pass -27 | +27 | 28 | if(True) == TrueElement or x == TrueElement: | ^^^^^^^^^^^^^^^^^^^^^ E712 29 | pass @@ -241,7 +241,7 @@ E712.py:28:3: E712 [*] Avoid equality comparisons to `True`; use `if TrueElement 26 26 | pass 27 27 | 28 |-if(True) == TrueElement or x == TrueElement: - 28 |+if(True) is TrueElement or x == TrueElement: + 28 |+if(TrueElement) or x == TrueElement: 29 29 | pass 30 30 | 31 31 | if (yield i) == True: @@ -249,7 +249,7 @@ E712.py:28:3: E712 [*] Avoid equality comparisons to `True`; use `if TrueElement E712.py:31:4: E712 [*] Avoid equality comparisons to `True`; use `if yield i:` for truth checks | 29 | pass -30 | +30 | 31 | if (yield i) == True: | ^^^^^^^^^^^^^^^^^ E712 32 | print("even") @@ -261,7 +261,24 @@ E712.py:31:4: E712 [*] Avoid equality comparisons to `True`; use `if yield i:` f 29 29 | pass 30 30 | 31 |-if (yield i) == True: - 31 |+if (yield i) is True: + 31 |+if (yield i): 32 32 | print("even") 33 33 | 34 34 | #: Okay + +E712.py:58:4: E712 [*] Avoid equality comparisons to `True`; use `if True:` for truth checks + | +57 | # https://github.com/astral-sh/ruff/issues/17582 +58 | if True == True: # No duplicated diagnostic + | ^^^^^^^^^^^^ E712 +59 | pass + | + = help: Replace with `True` + +ℹ Unsafe fix +55 55 | assert [42, not foo] in bar +56 56 | +57 57 | # https://github.com/astral-sh/ruff/issues/17582 +58 |-if True == True: # No duplicated diagnostic + 58 |+if True: # No duplicated diagnostic +59 59 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E713_E713.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E713_E713.py.snap index 44f8669d0f35b..845fa441d944b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E713_E713.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E713_E713.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E713.py:2:8: E713 [*] Test for membership should be `not in` | @@ -117,5 +118,3 @@ E713.py:40:12: E713 [*] Test for membership should be `not in` 39 39 | assert not (re.search(r"^.:\\Users\\[^\\]*\\Downloads\\.*") is None) 40 |-assert not('name' in request)or not request['name'] 40 |+assert 'name' not in request or not request['name'] - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E714_E714.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E714_E714.py.snap index fb009a75859a2..8b5df025351a6 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E714_E714.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E714_E714.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E714.py:2:8: E714 [*] Test for object identity should be `is not` | @@ -54,5 +55,3 @@ E714.py:39:13: E714 [*] Test for object identity should be `is not` 38 38 | assert [42, not foo] in bar 39 |-assert not (re.search(r"^.:\\Users\\[^\\]*\\Downloads\\.*") is None) 39 |+assert re.search(r"^.:\\Users\\[^\\]*\\Downloads\\.*") is not None - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E721_E721.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E721_E721.py.snap index 6d167b4801922..0e257342a926d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E721_E721.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E721_E721.py.snap @@ -144,14 +144,14 @@ E721.py:140:1: E721 Use `is` and `is not` for type comparisons, or `isinstance() 139 | #: E721 140 | dtype == float | ^^^^^^^^^^^^^^ E721 -141 | +141 | 142 | import builtins | E721.py:144:4: E721 Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks | 142 | import builtins -143 | +143 | 144 | if builtins.type(res) == memoryview: # E721 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E721 145 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E722_E722.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E722_E722.py.snap index 9de6888cf871e..48d10268e4171 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E722_E722.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E722_E722.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E722.py:4:1: E722 Do not use bare `except` | @@ -30,5 +31,3 @@ E722.py:16:1: E722 Do not use bare `except` 17 | pass 18 | #: Okay | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E731_E731.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E731_E731.py.snap index 32d034f1e76d7..775ca06ecbaab 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E731_E731.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E731_E731.py.snap @@ -186,7 +186,7 @@ E731.py:86:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:94:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 92 | from typing import Callable -93 | +93 | 94 | f: Callable[[], None] = lambda: None | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -206,7 +206,7 @@ E731.py:94:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:102:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 100 | from typing import Callable -101 | +101 | 102 | f: Callable[..., None] = lambda a, b: None | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -226,7 +226,7 @@ E731.py:102:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:110:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 108 | from typing import Callable -109 | +109 | 110 | f: Callable[[int], int] = lambda x: 2 * x | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -246,7 +246,7 @@ E731.py:110:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:119:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 117 | from collections.abc import Callable -118 | +118 | 119 | f: Callable[[str, int], str] = lambda a, b: a * b | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -266,7 +266,7 @@ E731.py:119:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:127:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 125 | from collections.abc import Callable -126 | +126 | 127 | f: Callable[[str, int], tuple[str, int]] = lambda a, b: (a, b) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -278,7 +278,7 @@ E731.py:127:5: E731 [*] Do not assign a `lambda` expression, use a `def` 126 126 | 127 |- f: Callable[[str, int], tuple[str, int]] = lambda a, b: (a, b) 127 |+ def f(a: str, b: int) -> tuple[str, int]: - 128 |+ return a, b + 128 |+ return (a, b) 128 129 | 129 130 | 130 131 | def scope(): @@ -286,7 +286,7 @@ E731.py:127:5: E731 [*] Do not assign a `lambda` expression, use a `def` E731.py:135:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 133 | from collections.abc import Callable -134 | +134 | 135 | f: Callable[[str, int, list[str]], list[str]] = lambda a, b, /, c: [*c, a * b] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 | @@ -346,9 +346,8 @@ E731.py:140:5: E731 Do not assign a `lambda` expression, use a `def` E731.py:147:5: E731 [*] Do not assign a `lambda` expression, use a `def` | 145 | # E731 -146 | -147 | f = lambda: ( - | _____^ +146 | +147 | / f = lambda: ( 148 | | i := 1, 149 | | ) | |_____^ E731 @@ -363,7 +362,103 @@ E731.py:147:5: E731 [*] Do not assign a `lambda` expression, use a `def` 148 |- i := 1, 149 |- ) 147 |+ def f(): - 148 |+ return (i := 1), -150 149 | -151 150 | -152 151 | from dataclasses import dataclass + 148 |+ return ( + 149 |+ i := 1, + 150 |+ ) +150 151 | +151 152 | +152 153 | from dataclasses import dataclass + +E731.py:163:1: E731 [*] Do not assign a `lambda` expression, use a `def` + | +161 | # Regression tests for: +162 | # * https://github.com/astral-sh/ruff/issues/7720 +163 | / x = lambda: """ +164 | | a +165 | | b +166 | | """ + | |___^ E731 +167 | +168 | # * https://github.com/astral-sh/ruff/issues/10277 + | + = help: Rewrite `x` as a `def` + +ℹ Unsafe fix +160 160 | +161 161 | # Regression tests for: +162 162 | # * https://github.com/astral-sh/ruff/issues/7720 +163 |-x = lambda: """ + 163 |+def x(): + 164 |+ return """ +164 165 | a +165 166 | b +166 167 | """ + +E731.py:169:1: E731 [*] Do not assign a `lambda` expression, use a `def` + | +168 | # * https://github.com/astral-sh/ruff/issues/10277 +169 | at_least_one_million = lambda _: _ >= 1_000_000 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E731 +170 | +171 | x = lambda: ( + | + = help: Rewrite `at_least_one_million` as a `def` + +ℹ Unsafe fix +166 166 | """ +167 167 | +168 168 | # * https://github.com/astral-sh/ruff/issues/10277 +169 |-at_least_one_million = lambda _: _ >= 1_000_000 + 169 |+def at_least_one_million(_): + 170 |+ return _ >= 1_000_000 +170 171 | +171 172 | x = lambda: ( +172 173 | # comment + +E731.py:171:1: E731 [*] Do not assign a `lambda` expression, use a `def` + | +169 | at_least_one_million = lambda _: _ >= 1_000_000 +170 | +171 | / x = lambda: ( +172 | | # comment +173 | | 5 + 10 +174 | | ) + | |_^ E731 +175 | +176 | x = lambda: ( + | + = help: Rewrite `x` as a `def` + +ℹ Unsafe fix +168 168 | # * https://github.com/astral-sh/ruff/issues/10277 +169 169 | at_least_one_million = lambda _: _ >= 1_000_000 +170 170 | +171 |-x = lambda: ( + 171 |+def x(): + 172 |+ return ( +172 173 | # comment +173 174 | 5 + 10 +174 175 | ) + +E731.py:176:1: E731 [*] Do not assign a `lambda` expression, use a `def` + | +174 | ) +175 | +176 | / x = lambda: ( +177 | | # comment +178 | | y := 10 +179 | | ) + | |_^ E731 + | + = help: Rewrite `x` as a `def` + +ℹ Unsafe fix +173 173 | 5 + 10 +174 174 | ) +175 175 | +176 |-x = lambda: ( + 176 |+def x(): + 177 |+ return ( +177 178 | # comment +178 179 | y := 10 +179 180 | ) diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.py.snap index ceea95df294bb..75db1277a61a7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E741.py:3:1: E741 Ambiguous variable name: `l` | 1 | from contextlib import contextmanager -2 | +2 | 3 | l = 0 | ^ E741 4 | I = 0 @@ -35,14 +35,14 @@ E741.py:6:1: E741 Ambiguous variable name: `l` 5 | O = 0 6 | l: int = 0 | ^ E741 -7 | +7 | 8 | a, l = 0, 1 | E741.py:8:4: E741 Ambiguous variable name: `l` | 6 | l: int = 0 - 7 | + 7 | 8 | a, l = 0, 1 | ^ E741 9 | [a, l] = 0, 1 @@ -73,14 +73,14 @@ E741.py:11:5: E741 Ambiguous variable name: `l` 10 | a, *l = 0, 1, 2 11 | a = l = 0 | ^ E741 -12 | +12 | 13 | o = 0 | E741.py:16:5: E741 Ambiguous variable name: `l` | 14 | i = 0 -15 | +15 | 16 | for l in range(3): | ^ E741 17 | pass @@ -114,7 +114,7 @@ E741.py:30:5: E741 Ambiguous variable name: `l` 29 | def f2(): 30 | l = 0 | ^ E741 -31 | +31 | 32 | def f3(): | @@ -132,7 +132,7 @@ E741.py:34:9: E741 Ambiguous variable name: `l` 33 | nonlocal l 34 | l = 1 | ^ E741 -35 | +35 | 36 | f3() | @@ -204,10 +204,8 @@ E741.py:71:22: E741 Ambiguous variable name: `l` E741.py:74:5: E741 Ambiguous variable name: `l` | 72 | pass -73 | +73 | 74 | if (l := 5) > 0: | ^ E741 75 | pass | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.pyi.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.pyi.snap index 79854e35dd9aa..6dcc4546f11f9 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.pyi.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E741_E741.pyi.snap @@ -1,211 +1,4 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs --- -E741.pyi:3:1: E741 Ambiguous variable name: `l` - | -1 | from contextlib import contextmanager -2 | -3 | l = 0 - | ^ E741 -4 | I = 0 -5 | O = 0 - | -E741.pyi:4:1: E741 Ambiguous variable name: `I` - | -3 | l = 0 -4 | I = 0 - | ^ E741 -5 | O = 0 -6 | l: int = 0 - | - -E741.pyi:5:1: E741 Ambiguous variable name: `O` - | -3 | l = 0 -4 | I = 0 -5 | O = 0 - | ^ E741 -6 | l: int = 0 - | - -E741.pyi:6:1: E741 Ambiguous variable name: `l` - | -4 | I = 0 -5 | O = 0 -6 | l: int = 0 - | ^ E741 -7 | -8 | a, l = 0, 1 - | - -E741.pyi:8:4: E741 Ambiguous variable name: `l` - | - 6 | l: int = 0 - 7 | - 8 | a, l = 0, 1 - | ^ E741 - 9 | [a, l] = 0, 1 -10 | a, *l = 0, 1, 2 - | - -E741.pyi:9:5: E741 Ambiguous variable name: `l` - | - 8 | a, l = 0, 1 - 9 | [a, l] = 0, 1 - | ^ E741 -10 | a, *l = 0, 1, 2 -11 | a = l = 0 - | - -E741.pyi:10:5: E741 Ambiguous variable name: `l` - | - 8 | a, l = 0, 1 - 9 | [a, l] = 0, 1 -10 | a, *l = 0, 1, 2 - | ^ E741 -11 | a = l = 0 - | - -E741.pyi:11:5: E741 Ambiguous variable name: `l` - | - 9 | [a, l] = 0, 1 -10 | a, *l = 0, 1, 2 -11 | a = l = 0 - | ^ E741 -12 | -13 | o = 0 - | - -E741.pyi:16:5: E741 Ambiguous variable name: `l` - | -14 | i = 0 -15 | -16 | for l in range(3): - | ^ E741 -17 | pass - | - -E741.pyi:20:8: E741 Ambiguous variable name: `l` - | -20 | for a, l in zip(range(3), range(3)): - | ^ E741 -21 | pass - | - -E741.pyi:25:12: E741 Ambiguous variable name: `l` - | -24 | def f1(): -25 | global l - | ^ E741 -26 | l = 0 - | - -E741.pyi:26:5: E741 Ambiguous variable name: `l` - | -24 | def f1(): -25 | global l -26 | l = 0 - | ^ E741 - | - -E741.pyi:30:5: E741 Ambiguous variable name: `l` - | -29 | def f2(): -30 | l = 0 - | ^ E741 -31 | -32 | def f3(): - | - -E741.pyi:33:18: E741 Ambiguous variable name: `l` - | -32 | def f3(): -33 | nonlocal l - | ^ E741 -34 | l = 1 - | - -E741.pyi:34:9: E741 Ambiguous variable name: `l` - | -32 | def f3(): -33 | nonlocal l -34 | l = 1 - | ^ E741 -35 | -36 | f3() - | - -E741.pyi:40:8: E741 Ambiguous variable name: `l` - | -40 | def f4(l, /, I): - | ^ E741 -41 | return l, I, O - | - -E741.pyi:40:14: E741 Ambiguous variable name: `I` - | -40 | def f4(l, /, I): - | ^ E741 -41 | return l, I, O - | - -E741.pyi:44:8: E741 Ambiguous variable name: `l` - | -44 | def f5(l=0, *, I=1): - | ^ E741 -45 | return l, I - | - -E741.pyi:44:16: E741 Ambiguous variable name: `I` - | -44 | def f5(l=0, *, I=1): - | ^ E741 -45 | return l, I - | - -E741.pyi:48:9: E741 Ambiguous variable name: `l` - | -48 | def f6(*l, **I): - | ^ E741 -49 | return l, I - | - -E741.pyi:48:14: E741 Ambiguous variable name: `I` - | -48 | def f6(*l, **I): - | ^ E741 -49 | return l, I - | - -E741.pyi:57:16: E741 Ambiguous variable name: `l` - | -57 | with ctx1() as l: - | ^ E741 -58 | pass - | - -E741.pyi:66:20: E741 Ambiguous variable name: `l` - | -66 | with ctx2() as (a, l): - | ^ E741 -67 | pass - | - -E741.pyi:71:22: E741 Ambiguous variable name: `l` - | -69 | try: -70 | pass -71 | except ValueError as l: - | ^ E741 -72 | pass - | - -E741.pyi:74:5: E741 Ambiguous variable name: `l` - | -72 | pass -73 | -74 | if (l := 5) > 0: - | ^ E741 -75 | pass - | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E742_E742.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E742_E742.py.snap index 6b4c1429be553..abfdba447eb39 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E742_E742.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E742_E742.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E742.py:1:7: E742 Ambiguous class name: `l` | @@ -21,5 +22,3 @@ E742.py:9:7: E742 Ambiguous class name: `O` | ^ E742 10 | pass | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E743_E743.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E743_E743.py.snap index 067cbe927f6df..0a80ad2cf8417 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E743_E743.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__E743_E743.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E743.py:1:5: E743 Ambiguous function name: `l` | @@ -22,5 +23,3 @@ E743.py:10:9: E743 Ambiguous function name: `O` | ^ E743 11 | pass | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W191_W19.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W191_W19.py.snap index a47fc90aff8bb..a8779f5429744 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W191_W19.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W191_W19.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- W19.py:1:1: W191 Indentation contains tabs | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W29.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W29.py.snap index f2e3a64a92a9d..caf6753099baa 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W29.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W29.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- W29.py:4:6: W291 [*] Trailing whitespace | @@ -63,5 +64,3 @@ W29.py:13:6: W291 [*] Trailing whitespace 14 14 | #: W191 W292 noeol 15 15 | if False: 16 16 | pass # indented with tabs - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W291.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W291.py.snap index 44f7a2f7aec58..0f59c043ac25a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W291.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W291_W291.py.snap @@ -19,7 +19,7 @@ W291.py:1:23: W291 [*] Trailing whitespace W291.py:4:24: W291 [*] Trailing whitespace | 2 | inside a multiline string''' -3 | +3 | 4 | f'''trailing whitespace | ^ W291 5 | inside a multiline f-string''' @@ -73,5 +73,3 @@ W291.py:14:10: W291 [*] Trailing whitespace 14 |- 1 + 2 14 |+ 1 + 2 15 15 | }' - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_0.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_0.py.snap index efd7799b3a5c5..93800dbe5bac3 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_0.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_0.py.snap @@ -5,7 +5,7 @@ W292_0.py:2:9: W292 [*] No newline at end of file | 1 | def fn() -> None: 2 | pass - | W292 + | ^ W292 | = help: Add trailing newline @@ -13,5 +13,3 @@ W292_0.py:2:9: W292 [*] No newline at end of file 1 1 | def fn() -> None: 2 |- pass 2 |+ pass - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_1.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_1.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_1.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_2.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_2.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_2.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_3.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_3.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_3.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W292_W292_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W29.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W29.py.snap index 7ff31152150c0..4818cd126bafa 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W29.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W29.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- W29.py:7:1: W293 [*] Blank line contains whitespace | @@ -21,5 +22,3 @@ W29.py:7:1: W293 [*] Blank line contains whitespace 8 8 | bang = 12 9 9 | #: W291:2:35 10 10 | '''multiline - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W293.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W293.py.snap index a8f5782d43578..f94b87354917f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W293.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W293_W293.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- W293.py:4:1: W293 [*] Blank line contains whitespace | @@ -80,5 +81,3 @@ W293.py:18:1: W293 [*] Blank line contains whitespace 18 |- 18 |+ 19 19 | inside a multiline string''' - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_0.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_0.py.snap index 9ce7ff2bca06e..8da92669c3fc3 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_0.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_0.py.snap @@ -6,7 +6,7 @@ W605_0.py:2:10: W605 [*] Invalid escape sequence: `\.` 1 | #: W605:1:10 2 | regex = '\.png$' | ^^ W605 -3 | +3 | 4 | #: W605:2:1 | = help: Use a raw string literal @@ -104,7 +104,7 @@ W605_0.py:28:12: W605 [*] Invalid escape sequence: `\.` 27 | #: W605:1:11 28 | return'\.png$' | ^^ W605 -29 | +29 | 30 | #: Okay | = help: Use a raw string literal @@ -122,10 +122,10 @@ W605_0.py:28:12: W605 [*] Invalid escape sequence: `\.` W605_0.py:45:12: W605 [*] Invalid escape sequence: `\_` | 43 | ''' # noqa -44 | +44 | 45 | regex = '\\\_' | ^^ W605 -46 | +46 | 47 | #: W605:1:7 | = help: Add backslash to escape sequence @@ -145,7 +145,7 @@ W605_0.py:48:6: W605 [*] Invalid escape sequence: `\ ` 47 | #: W605:1:7 48 | u'foo\ bar' | ^^ W605 -49 | +49 | 50 | #: W605:1:13 | = help: Use a raw string literal @@ -185,7 +185,7 @@ W605_0.py:57:6: W605 [*] Invalid escape sequence: `\.` 56 | #: W605:1:6 57 | "foo \. bar \t" | ^^ W605 -58 | +58 | 59 | #: W605:1:13 | = help: Add backslash to escape sequence diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_1.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_1.py.snap index ea0ced5b4fbb0..8d763a16a3516 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_1.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__W605_W605_1.py.snap @@ -6,7 +6,7 @@ W605_1.py:4:11: W605 [*] Invalid escape sequence: `\.` 3 | #: W605:1:10 4 | regex = f'\.png$' | ^^ W605 -5 | +5 | 6 | #: W605:2:1 | = help: Use a raw string literal @@ -103,7 +103,7 @@ W605_1.py:25:40: W605 [*] Invalid escape sequence: `\_` W605_1.py:43:13: W605 [*] Invalid escape sequence: `\_` | 41 | ''' # noqa -42 | +42 | 43 | regex = f'\\\_' | ^^ W605 44 | value = f'\{{1}}' @@ -209,7 +209,7 @@ W605_1.py:48:15: W605 [*] Invalid escape sequence: `\{` 47 | value = f"{f"\{1}"}" 48 | value = rf"{f"\{1}"}" | ^^ W605 -49 | +49 | 50 | # Okay | = help: Use a raw string literal @@ -242,6 +242,7 @@ W605_1.py:57:9: W605 [*] Invalid escape sequence: `\d` 57 |+rf"{{}}+-\d" 58 58 | f"\n{{}}+-\d+" 59 59 | f"\n{{}}�+-\d+" +60 60 | W605_1.py:58:11: W605 [*] Invalid escape sequence: `\d` | @@ -260,6 +261,8 @@ W605_1.py:58:11: W605 [*] Invalid escape sequence: `\d` 58 |-f"\n{{}}+-\d+" 58 |+f"\n{{}}+-\\d+" 59 59 | f"\n{{}}�+-\d+" +60 60 | +61 61 | # See https://github.com/astral-sh/ruff/issues/11491 W605_1.py:59:12: W605 [*] Invalid escape sequence: `\d` | @@ -267,6 +270,8 @@ W605_1.py:59:12: W605 [*] Invalid escape sequence: `\d` 58 | f"\n{{}}+-\d+" 59 | f"\n{{}}�+-\d+" | ^^ W605 +60 | +61 | # See https://github.com/astral-sh/ruff/issues/11491 | = help: Add backslash to escape sequence @@ -276,3 +281,42 @@ W605_1.py:59:12: W605 [*] Invalid escape sequence: `\d` 58 58 | f"\n{{}}+-\d+" 59 |-f"\n{{}}�+-\d+" 59 |+f"\n{{}}�+-\\d+" +60 60 | +61 61 | # See https://github.com/astral-sh/ruff/issues/11491 +62 62 | total = 10 + +W605_1.py:65:31: W605 [*] Invalid escape sequence: `\I` + | +63 | ok = 7 +64 | incomplete = 3 +65 | s = f"TOTAL: {total}\nOK: {ok}\INCOMPLETE: {incomplete}\n" + | ^^ W605 +66 | +67 | # Debug text (should trigger) + | + = help: Add backslash to escape sequence + +ℹ Safe fix +62 62 | total = 10 +63 63 | ok = 7 +64 64 | incomplete = 3 +65 |-s = f"TOTAL: {total}\nOK: {ok}\INCOMPLETE: {incomplete}\n" + 65 |+s = f"TOTAL: {total}\nOK: {ok}\\INCOMPLETE: {incomplete}\n" +66 66 | +67 67 | # Debug text (should trigger) +68 68 | t = f"{'\InHere'=}" + +W605_1.py:68:9: W605 [*] Invalid escape sequence: `\I` + | +67 | # Debug text (should trigger) +68 | t = f"{'\InHere'=}" + | ^^ W605 + | + = help: Use a raw string literal + +ℹ Safe fix +65 65 | s = f"TOTAL: {total}\nOK: {ok}\INCOMPLETE: {incomplete}\n" +66 66 | +67 67 | # Debug text (should trigger) +68 |-t = f"{'\InHere'=}" + 68 |+t = f"{r'\InHere'=}" diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_notebook.snap index b128dda953eff..b8baafb5cd5c5 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_notebook.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.ipynb:13:5: E301 [*] Expected 1 blank line, found 0 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_typing_stub.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E301_typing_stub.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_notebook.snap index eada536b020d9..3a2fa4505d5eb 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_notebook.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30.ipynb:21:1: E302 [*] Expected 2 blank lines, found 1 | 19 | pass -20 | +20 | 21 | def b(): | ^^^ E302 22 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_typing_stub.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E302_typing_stub.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_notebook.snap index ce20914578b92..2ccc9b5a562f4 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_notebook.snap @@ -5,7 +5,7 @@ E30.ipynb:29:5: E303 [*] Too many blank lines (2) | 29 | # arbitrary comment | ^^^^^^^^^^^^^^^^^^^ E303 -30 | +30 | 31 | def inner(): # E306 not expected (pycodestyle detects E306) | = help: Remove extraneous blank line(s) diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_typing_stub.snap index 520a83ea86ff2..b302d784da951 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E303_typing_stub.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.pyi:17:1: E303 [*] Too many blank lines (2) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_notebook.snap index 7e09f8d244ca7..39fbc5b80fd4f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_notebook.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30.ipynb:45:1: E304 [*] Blank lines found after function decorator (1) | 43 | @decorator -44 | +44 | 45 | def function(): | ^^^ E304 46 | pass diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_typing_stub.snap index 565eeed36e6a6..49ab3a32468fd 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E304_typing_stub.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.pyi:32:5: E304 [*] Blank lines found after function decorator (1) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_notebook.snap index 15dde40958e8c..ef27833ff30c4 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_notebook.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.ipynb:55:1: E305 [*] Expected 2 blank lines after class or function definition, found (1) | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_typing_stub.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E305_typing_stub.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_notebook.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_notebook.snap index 7f1131c23f394..a5675e1a55d07 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_notebook.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_notebook.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E30.ipynb:60:5: E306 [*] Expected 1 blank line before a nested definition, found 0 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_typing_stub.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_typing_stub.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_typing_stub.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_E306_typing_stub.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(-1)-between(0).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(-1)-between(0).snap index 7b01f96447d7e..fa3511086f504 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(-1)-between(0).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(-1)-between(0).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -27,10 +24,10 @@ E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 | 21 | abcd.foo() -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | ^^^ E302 -24 | +24 | 25 | if TYPE_CHECKING: | = help: Add missing blank line(s) @@ -44,18 +41,15 @@ E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 24 25 | 25 26 | if TYPE_CHECKING: -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -72,7 +66,7 @@ E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 | 33 | abcd.foo() -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 36 | ... @@ -91,7 +85,7 @@ E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 | 39 | from typing_extensions import TypeAlias -40 | +40 | 41 | def __call__2(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 42 | ... @@ -109,10 +103,10 @@ E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports @@ -126,7 +120,7 @@ E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:62:1: E302 [*] Expected 2 blank lines, found 1 | 60 | from typing import Any, Sequence -61 | +61 | 62 | class MissingCommand(TypeError): ... # noqa: N818 | ^^^^^ E302 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(0)-between(0).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(0)-between(0).snap index 92e7ce4e2e43f..e66c54a48da58 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(0)-between(0).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(0)-between(0).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -30,10 +27,10 @@ E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 | 21 | abcd.foo() -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | ^^^ E302 -24 | +24 | 25 | if TYPE_CHECKING: | = help: Add missing blank line(s) @@ -47,18 +44,15 @@ E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 24 25 | 25 26 | if TYPE_CHECKING: -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -75,7 +69,7 @@ E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 | 33 | abcd.foo() -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 36 | ... @@ -94,7 +88,7 @@ E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 | 39 | from typing_extensions import TypeAlias -40 | +40 | 41 | def __call__2(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 42 | ... @@ -112,10 +106,10 @@ E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(1)-between(1).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(1)-between(1).snap index 2e8fed4bd6c27..9434c2cc1147d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(1)-between(1).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(1)-between(1).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -29,10 +26,10 @@ E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 | 21 | abcd.foo() -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | ^^^ E302 -24 | +24 | 25 | if TYPE_CHECKING: | = help: Add missing blank line(s) @@ -46,18 +43,15 @@ E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 24 25 | 25 26 | if TYPE_CHECKING: -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -74,7 +68,7 @@ E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 | 33 | abcd.foo() -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 36 | ... @@ -93,7 +87,7 @@ E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 | 39 | from typing_extensions import TypeAlias -40 | +40 | 41 | def __call__2(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 42 | ... diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(4)-between(4).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(4)-between(4).snap index c24ef9e346b1d..1c6425457ef9b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(4)-between(4).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_top_level_isort_compatibility-lines-after(4)-between(4).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -49,10 +46,10 @@ E30_isort.py:8:1: E302 [*] Expected 4 blank lines, found 2 E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 | 21 | abcd.foo() -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | ^^^ E302 -24 | +24 | 25 | if TYPE_CHECKING: | = help: Add missing blank line(s) @@ -66,18 +63,15 @@ E30_isort.py:23:1: E302 [*] Expected 2 blank lines, found 1 24 25 | 25 26 | if TYPE_CHECKING: -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -94,7 +88,7 @@ E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 | 33 | abcd.foo() -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 36 | ... @@ -113,7 +107,7 @@ E30_isort.py:35:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 | 39 | from typing_extensions import TypeAlias -40 | +40 | 41 | def __call__2(self, name: str, *args: Any, **kwargs: Any) -> Any: | ^^^ E302 42 | ... @@ -131,10 +125,10 @@ E30_isort.py:41:1: E302 [*] Expected 2 blank lines, found 1 E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports @@ -150,7 +144,7 @@ E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:62:1: E302 [*] Expected 4 blank lines, found 1 | 60 | from typing import Any, Sequence -61 | +61 | 62 | class MissingCommand(TypeError): ... # noqa: N818 | ^^^^^ E302 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_typing_stub_isort.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_typing_stub_isort.snap index ea026fcf0733a..dc10a907bc68b 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_typing_stub_isort.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__blank_lines_typing_stub_isort.snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.pyi:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -97,7 +94,7 @@ E30_isort.pyi:21:5: E303 [*] Too many blank lines (2) | 21 | abcd.foo() | ^^^^ E303 -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | = help: Remove extraneous blank line(s) @@ -111,18 +108,15 @@ E30_isort.pyi:21:5: E303 [*] Too many blank lines (2) 22 21 | 23 22 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... -E30_isort.pyi:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.pyi:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -157,7 +151,7 @@ E30_isort.pyi:33:5: E303 [*] Too many blank lines (2) | 33 | abcd.foo() | ^^^^ E303 -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | = help: Remove extraneous blank line(s) @@ -255,7 +249,7 @@ E30_isort.pyi:60:1: E303 [*] Too many blank lines (2) | 60 | from typing import Any, Sequence | ^^^^ E303 -61 | +61 | 62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Remove extraneous blank line(s) diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__constant_literals.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__constant_literals.snap index 83478872dfd16..7adb6732e7bf3 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__constant_literals.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__constant_literals.snap @@ -122,7 +122,7 @@ constant_literals.py:14:4: E712 [*] Avoid equality comparisons to `False`; use ` 12 12 | if False is "abc": # F632 (fix, but leaves behind unfixable E712) 13 13 | pass 14 |-if False == None: # E711, E712 (fix) - 14 |+if False is None: # E711, E712 (fix) + 14 |+if not None: # E711, E712 (fix) 15 15 | pass 16 16 | if None == False: # E711, E712 (fix) 17 17 | pass @@ -143,7 +143,7 @@ constant_literals.py:14:13: E711 [*] Comparison to `None` should be `cond is Non 12 12 | if False is "abc": # F632 (fix, but leaves behind unfixable E712) 13 13 | pass 14 |-if False == None: # E711, E712 (fix) - 14 |+if False is None: # E711, E712 (fix) + 14 |+if not None: # E711, E712 (fix) 15 15 | pass 16 16 | if None == False: # E711, E712 (fix) 17 17 | pass @@ -163,7 +163,7 @@ constant_literals.py:16:4: E711 [*] Comparison to `None` should be `cond is None 14 14 | if False == None: # E711, E712 (fix) 15 15 | pass 16 |-if None == False: # E711, E712 (fix) - 16 |+if None is False: # E711, E712 (fix) + 16 |+if not None: # E711, E712 (fix) 17 17 | pass 18 18 | 19 19 | named_var = [] @@ -183,7 +183,7 @@ constant_literals.py:16:4: E712 [*] Avoid equality comparisons to `False`; use ` 14 14 | if False == None: # E711, E712 (fix) 15 15 | pass 16 |-if None == False: # E711, E712 (fix) - 16 |+if None is False: # E711, E712 (fix) + 16 |+if not None: # E711, E712 (fix) 17 17 | pass 18 18 | 19 19 | named_var = [] diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length.snap index 3b5726d319c2e..a5c5cd23e79a0 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length.snap @@ -13,17 +13,17 @@ W505.py:6:51: W505 Doc line too long (56 > 50) 5 | def f1(): 6 | """Here's a docstring that's also over the limit.""" | ^^^^^^ W505 -7 | +7 | 8 | x = 1 # Here's a comment that's over the limit, but it's not standalone. | W505.py:10:51: W505 Doc line too long (56 > 50) | 8 | x = 1 # Here's a comment that's over the limit, but it's not standalone. - 9 | + 9 | 10 | # Here's a standalone comment that's over the limit. | ^^^^^^ W505 -11 | +11 | 12 | x = 2 | @@ -32,7 +32,7 @@ W505.py:13:51: W505 Doc line too long (94 > 50) 12 | x = 2 13 | # Another standalone that is preceded by a newline and indent token and is over the limit. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 -14 | +14 | 15 | print("Here's a string that's over the limit, but it's not a docstring.") | @@ -45,7 +45,7 @@ W505.py:18:51: W505 Doc line too long (61 > 50) W505.py:24:51: W505 Doc line too long (82 > 50) | 22 | """Here's a multi-line docstring. -23 | +23 | 24 | It's over the limit on this line, which isn't the first line in the docstring. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 25 | """ @@ -54,7 +54,7 @@ W505.py:24:51: W505 Doc line too long (82 > 50) W505.py:31:51: W505 Doc line too long (85 > 50) | 29 | """Here's a multi-line docstring. -30 | +30 | 31 | It's over the limit on this line, which isn't the first line in the docstring.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length_with_utf_8.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length_with_utf_8.snap index a47212461f247..64f4347ec6a75 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length_with_utf_8.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__max_doc_length_with_utf_8.snap @@ -13,17 +13,17 @@ W505_utf_8.py:6:49: W505 Doc line too long (56 > 50) 5 | def f1(): 6 | """Here's a ß9💣2ℝing that's also over theß9💣2ℝ.""" | ^^^^^^ W505 -7 | +7 | 8 | x = 1 # Here's a comment that's over theß9💣2ℝ, but it's not standalone. | W505_utf_8.py:10:51: W505 Doc line too long (56 > 50) | 8 | x = 1 # Here's a comment that's over theß9💣2ℝ, but it's not standalone. - 9 | + 9 | 10 | # Here's a standalone comment that's over theß9💣2ℝ. | ^^^^^^ W505 -11 | +11 | 12 | x = 2 | @@ -32,7 +32,7 @@ W505_utf_8.py:13:51: W505 Doc line too long (94 > 50) 12 | x = 2 13 | # Another standalone that is preceded by a newline and indent token and is over theß9💣2ℝ. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 -14 | +14 | 15 | print("Here's a string that's over theß9💣2ℝ, but it's not a ß9💣2ℝing.") | @@ -45,7 +45,7 @@ W505_utf_8.py:18:50: W505 Doc line too long (61 > 50) W505_utf_8.py:24:50: W505 Doc line too long (82 > 50) | 22 | """Here's a multi-line ß9💣2ℝing. -23 | +23 | 24 | It's over theß9💣2ℝ on this line, which isn't the first line in the ß9💣2ℝing. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 25 | """ @@ -54,7 +54,7 @@ W505_utf_8.py:24:50: W505 Doc line too long (82 > 50) W505_utf_8.py:31:50: W505 Doc line too long (85 > 50) | 29 | """Here's a multi-line ß9💣2ℝing. -30 | +30 | 31 | It's over theß9💣2ℝ on this line, which isn't the first line in the ß9💣2ℝing.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ W505 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E502_E502.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E502_E502.py.snap index 6862f6161fdb1..fe398c0aa1c30 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E502_E502.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E502_E502.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E502.py:9:9: E502 [*] Redundant backslash | 7 | + 4 - 8 | + 8 | 9 | a = (3 -\ | ^ E502 10 | 2 + \ @@ -246,7 +246,7 @@ E502.py:61:9: E502 [*] Redundant backslash E502.py:82:12: E502 [*] Redundant backslash | 80 | "xyz" -81 | +81 | 82 | x = ("abc" \ | ^ E502 83 | "xyz") diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E741_E741.pyi.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E741_E741.pyi.snap deleted file mode 100644 index 6dcc4546f11f9..0000000000000 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__E741_E741.pyi.snap +++ /dev/null @@ -1,4 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pycodestyle/mod.rs ---- - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391.ipynb.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391.ipynb.snap new file mode 100644 index 0000000000000..898237e9b4839 --- /dev/null +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391.ipynb.snap @@ -0,0 +1,74 @@ +--- +source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +--- +W391.ipynb:5:1: W391 [*] Too many newlines at end of cell + | + 3 | # just a comment in this cell + 4 | # a comment and some newlines + 5 | / + 6 | | + 7 | | + | |__^ W391 + 8 | + 9 | 1 + 1 +10 | # a comment + | + = help: Remove trailing newlines + +ℹ Safe fix +3 3 | # just a comment in this cell +4 4 | # a comment and some newlines +5 5 | +6 |- +7 |- +8 |- +9 6 | 1 + 1 +10 7 | # a comment +11 8 | + +W391.ipynb:11:1: W391 [*] Too many newlines at end of cell + | + 9 | 1 + 1 +10 | # a comment +11 | / +12 | | +13 | | +14 | | + | |__^ W391 +15 | +16 | 1+1 + | + = help: Remove trailing newlines + +ℹ Safe fix +9 9 | 1 + 1 +10 10 | # a comment +11 11 | +12 |- +13 |- +14 |- +15 |- +16 12 | 1+1 +17 13 | +18 14 | + +W391.ipynb:17:1: W391 [*] Too many newlines at end of cell + | +16 | 1+1 +17 | / +18 | | +19 | | +20 | | + | |__^ W391 +21 | + | + = help: Remove trailing newlines + +ℹ Safe fix +15 15 | +16 16 | 1+1 +17 17 | +18 |- +19 |- +20 |- +21 |- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_0.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_0.py.snap index 643743f66be96..f6afa64ada9f7 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_0.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_0.py.snap @@ -5,7 +5,7 @@ W391_0.py:14:1: W391 [*] Extra newline at end of file | 12 | foo() 13 | bar() -14 | +14 | | ^ W391 | = help: Remove trailing newline diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_1.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_1.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_1.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_2.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_2.py.snap index 8ca9ecd0c1458..2bf80006545ba 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_2.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_2.py.snap @@ -5,10 +5,11 @@ W391_2.py:14:1: W391 [*] Too many newlines at end of file | 12 | foo() 13 | bar() -14 | / -15 | | -16 | | -17 | | +14 | / +15 | | +16 | | +17 | | + | |__^ W391 | = help: Remove trailing newlines diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_3.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_3.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_3.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_4.py.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_4.py.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_4.py.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__preview__W391_W391_4.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__shebang.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__shebang.snap index fa3897bebc056..bd5f7a287c52d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__shebang.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__shebang.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- shebang.py:3:1: E265 [*] Block comment should start with `# ` | @@ -17,5 +18,3 @@ shebang.py:3:1: E265 [*] Block comment should start with `# ` 3 |-#! 3 |+# ! 4 4 | #: - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_1.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_1.snap index 98ee4b6d01e73..2b5a0222b269d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_1.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_1.snap @@ -36,7 +36,7 @@ E501_2.py:10:7: E501 Line too long (7 > 6) 9 | # aa 10 | # aaa | ^ E501 -11 | +11 | 12 | if True: # noqa: E501 | @@ -47,5 +47,3 @@ E501_2.py:16:7: E501 Line too long (7 > 6) 16 | [1, 2] | ^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_2.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_2.snap index a1800fab20a61..bfc312b4dc544 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_2.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_2.snap @@ -65,7 +65,7 @@ E501_2.py:10:5: E501 Line too long (9 > 6) 9 | # aa 10 | # aaa | ^^^ E501 -11 | +11 | 12 | if True: # noqa: E501 | @@ -86,5 +86,3 @@ E501_2.py:16:6: E501 Line too long (8 > 6) 16 | [1, 2] | ^^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_4.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_4.snap index da581f2a64ea9..9930bcbee371e 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_4.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_4.snap @@ -85,7 +85,7 @@ E501_2.py:10:3: E501 Line too long (13 > 6) 9 | # aa 10 | # aaa | ^^^^^ E501 -11 | +11 | 12 | if True: # noqa: E501 | @@ -106,5 +106,3 @@ E501_2.py:16:4: E501 Line too long (10 > 6) 16 | [1, 2] | ^^^^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_8.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_8.snap index 8494868830b5a..2f3422d92f960 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_8.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__tab_size_8.snap @@ -85,7 +85,7 @@ E501_2.py:10:2: E501 Line too long (21 > 6) 9 | # aa 10 | # aaa | ^^^^^^^^^ E501 -11 | +11 | 12 | if True: # noqa: E501 | @@ -106,5 +106,3 @@ E501_2.py:16:2: E501 Line too long (14 > 6) 16 | [1, 2] | ^^^^^^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_false.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_false.snap index 6b373eafbf232..6dfc2c571a233 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_false.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_false.snap @@ -3,76 +3,74 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs --- E501_1.py:1:89: E501 Line too long (149 > 88) | -1 | # TODO: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -2 | # TODO(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -3 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +1 | …ask-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +2 | …figured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +3 | …sk-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:2:89: E501 Line too long (158 > 88) | -1 | # TODO: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -2 | # TODO(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -3 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -4 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +1 | …ags sometimes are longer than line-length so that you can easily find them with `git grep` +2 | …ed task-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +3 | …gs sometimes are longer than line-length so that you can easily find them with `git grep` +4 | …task-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:3:89: E501 Line too long (148 > 88) | -1 | # TODO: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -2 | # TODO(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -3 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -4 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -5 | # FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +1 | …ask-tags sometimes are longer than line-length so that you can easily find them with `git grep` +2 | …figured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +3 | …sk-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +4 | …ured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +5 | …task-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:4:89: E501 Line too long (155 > 88) | -2 | # TODO(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -3 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -4 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -5 | # FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -6 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +2 | …ured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +3 | …tags sometimes are longer than line-length so that you can easily find them with `git grep` +4 | …d task-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +5 | …k-tags sometimes are longer than line-length so that you can easily find them with `git grep` +6 | …-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:5:89: E501 Line too long (150 > 88) | -3 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -4 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -5 | # FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -6 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -7 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +3 | …k-tags sometimes are longer than line-length so that you can easily find them with `git grep` +4 | …red task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +5 | …ask-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +6 | …sk-tags sometimes are longer than line-length so that you can easily find them with `git grep` +7 | …ured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:6:89: E501 Line too long (149 > 88) | -4 | # TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -5 | # FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -6 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -7 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -8 | # FIXME(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +4 | …ured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +5 | …task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +6 | …ask-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +7 | …gured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +8 | …nfigured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:7:89: E501 Line too long (156 > 88) | -5 | # FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -6 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -7 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 -8 | # FIXME(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +5 | …-tags sometimes are longer than line-length so that you can easily find them with `git grep` +6 | …tags sometimes are longer than line-length so that you can easily find them with `git grep` +7 | …d task-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +8 | …ured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` | E501_1.py:8:89: E501 Line too long (159 > 88) | -6 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -7 | # FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` -8 | # FIXME(charlie): comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep` - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 +6 | …ags sometimes are longer than line-length so that you can easily find them with `git grep` +7 | … task-tags sometimes are longer than line-length so that you can easily find them with `git grep` +8 | …red task-tags sometimes are longer than line-length so that you can easily find them with `git grep` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ E501 | - - diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_true.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_true.snap index 6dcc4546f11f9..e5d90e3bfab3c 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_true.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__task_tags_true.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(-1)-between(0).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(-1)-between(0).snap index 8e0ac4d6f2f6e..8d895a4453fdb 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(-1)-between(0).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(-1)-between(0).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -44,7 +41,7 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) | 21 | abcd.foo() | ^^^^ E303 -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | = help: Remove extraneous blank line(s) @@ -58,18 +55,15 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) 22 21 | 23 22 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -104,7 +98,7 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) | 33 | abcd.foo() | ^^^^ E303 -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | = help: Remove extraneous blank line(s) @@ -120,10 +114,10 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(0)-between(0).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(0)-between(0).snap index 092f7ecbde343..2c2e5936b9d91 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(0)-between(0).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(0)-between(0).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -64,7 +61,7 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) | 21 | abcd.foo() | ^^^^ E303 -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | = help: Remove extraneous blank line(s) @@ -78,18 +75,15 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) 22 21 | 23 22 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -124,7 +118,7 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) | 33 | abcd.foo() | ^^^^ E303 -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | = help: Remove extraneous blank line(s) @@ -140,10 +134,10 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports @@ -157,7 +151,7 @@ E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted E30_isort.py:62:1: E303 [*] Too many blank lines (1) | 60 | from typing import Any, Sequence -61 | +61 | 62 | class MissingCommand(TypeError): ... # noqa: N818 | ^^^^^ E303 | diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(1)-between(1).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(1)-between(1).snap index 3ba9a6f5e8c21..1c152584a9c71 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(1)-between(1).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(1)-between(1).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -62,7 +59,7 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) | 21 | abcd.foo() | ^^^^ E303 -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | = help: Remove extraneous blank line(s) @@ -76,18 +73,15 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) 22 21 | 23 22 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -122,7 +116,7 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) | 33 | abcd.foo() | ^^^^ E303 -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | = help: Remove extraneous blank line(s) diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(4)-between(4).snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(4)-between(4).snap index b4ebcc11a63ce..c6db5e7df663d 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(4)-between(4).snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__too_many_blank_lines_isort_compatibility-lines-after(4)-between(4).snap @@ -4,14 +4,11 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs E30_isort.py:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / import json -2 | | -3 | | -4 | | +2 | | +3 | | +4 | | 5 | | from typing import Any, Sequence -6 | | -7 | | -8 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 + | |________________________________^ I001 | = help: Organize imports @@ -33,7 +30,7 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) | 21 | abcd.foo() | ^^^^ E303 -22 | +22 | 23 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... | = help: Remove extraneous blank line(s) @@ -47,18 +44,15 @@ E30_isort.py:21:5: E303 [*] Too many blank lines (2) 22 21 | 23 22 | def __init__(self, backend_module: str, backend_obj: str | None) -> None: ... -E30_isort.py:26:1: I001 [*] Import block is un-sorted or un-formatted +E30_isort.py:26:5: I001 [*] Import block is un-sorted or un-formatted | 25 | if TYPE_CHECKING: 26 | / import os -27 | | -28 | | -29 | | +27 | | +28 | | +29 | | 30 | | from typing_extensions import TypeAlias -31 | | - | |_^ I001 -32 | -33 | abcd.foo() + | |___________________________________________^ I001 | = help: Organize imports @@ -76,7 +70,7 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) | 33 | abcd.foo() | ^^^^ E303 -34 | +34 | 35 | def __call__(self, name: str, *args: Any, **kwargs: Any) -> Any: | = help: Remove extraneous blank line(s) @@ -92,10 +86,10 @@ E30_isort.py:33:5: E303 [*] Too many blank lines (2) E30_isort.py:60:1: I001 [*] Import block is un-sorted or un-formatted | -60 | / from typing import Any, Sequence -61 | | -62 | | class MissingCommand(TypeError): ... # noqa: N818 - | |_^ I001 +60 | from typing import Any, Sequence + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ I001 +61 | +62 | class MissingCommand(TypeError): ... # noqa: N818 | = help: Organize imports diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__w292_4.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__w292_4.snap index 8761934c7442c..31356cd79f95a 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__w292_4.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__w292_4.snap @@ -4,12 +4,10 @@ source: crates/ruff_linter/src/rules/pycodestyle/mod.rs W292_4.py:1:2: W292 [*] No newline at end of file | 1 | - | W292 + | ^ W292 | = help: Add trailing newline ℹ Safe fix 1 |- - 1 |+ - - + 1 |+ diff --git a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__white_space_syntax_error_compatibility.snap b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__white_space_syntax_error_compatibility.snap index 73c770d6cb3b3..8e10a8f07d8de 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__white_space_syntax_error_compatibility.snap +++ b/crates/ruff_linter/src/rules/pycodestyle/snapshots/ruff_linter__rules__pycodestyle__tests__white_space_syntax_error_compatibility.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pycodestyle/mod.rs +snapshot_kind: text --- E2_syntax_error.py:1:10: SyntaxError: Expected an expression | diff --git a/crates/ruff_linter/src/rules/pydoclint/mod.rs b/crates/ruff_linter/src/rules/pydoclint/mod.rs index 68565de689e19..af4131e427425 100644 --- a/crates/ruff_linter/src/rules/pydoclint/mod.rs +++ b/crates/ruff_linter/src/rules/pydoclint/mod.rs @@ -1,5 +1,6 @@ //! Rules from [pydoclint](https://pypi.org/project/pydoclint/). pub(crate) mod rules; +pub mod settings; #[cfg(test)] mod tests { @@ -15,6 +16,8 @@ mod tests { use crate::test::test_path; use crate::{assert_messages, settings}; + use super::settings::Settings; + #[test_case(Rule::DocstringMissingException, Path::new("DOC501.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.as_ref(), path.to_string_lossy()); @@ -37,7 +40,10 @@ mod tests { let diagnostics = test_path( Path::new("pydoclint").join(path).as_path(), &settings::LinterSettings { - pydocstyle: pydocstyle::settings::Settings::new(Some(Convention::Google), [], []), + pydocstyle: pydocstyle::settings::Settings { + convention: Some(Convention::Google), + ..pydocstyle::settings::Settings::default() + }, ..settings::LinterSettings::for_rule(rule_code) }, )?; @@ -56,7 +62,36 @@ mod tests { let diagnostics = test_path( Path::new("pydoclint").join(path).as_path(), &settings::LinterSettings { - pydocstyle: pydocstyle::settings::Settings::new(Some(Convention::Numpy), [], []), + pydocstyle: pydocstyle::settings::Settings { + convention: Some(Convention::Numpy), + ..pydocstyle::settings::Settings::default() + }, + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + + #[test_case(Rule::DocstringMissingReturns, Path::new("DOC201_google.py"))] + #[test_case(Rule::DocstringMissingYields, Path::new("DOC402_google.py"))] + #[test_case(Rule::DocstringMissingException, Path::new("DOC501_google.py"))] + fn rules_google_style_ignore_one_line(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "{}_{}_ignore_one_line", + rule_code.as_ref(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("pydoclint").join(path).as_path(), + &settings::LinterSettings { + pydoclint: Settings { + ignore_one_line_docstrings: true, + }, + pydocstyle: pydocstyle::settings::Settings { + convention: Some(Convention::Google), + ..pydocstyle::settings::Settings::default() + }, ..settings::LinterSettings::for_rule(rule_code) }, )?; diff --git a/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs b/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs index 1f75dbcb4b031..83acd9cde145e 100644 --- a/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs +++ b/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs @@ -1,33 +1,34 @@ use itertools::Itertools; use ruff_diagnostics::Diagnostic; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_callable; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::{self as ast, visitor, Expr, Stmt}; +use ruff_python_ast::{self as ast, Expr, Stmt, visitor}; use ruff_python_semantic::analyze::{function_type, visibility}; use ruff_python_semantic::{Definition, SemanticModel}; +use ruff_source_file::NewlineWithTrailingNewline; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; +use crate::docstrings::Docstring; use crate::docstrings::sections::{SectionContext, SectionContexts, SectionKind}; use crate::docstrings::styles::SectionStyle; -use crate::docstrings::Docstring; use crate::registry::Rule; use crate::rules::pydocstyle::settings::Convention; /// ## What it does -/// Checks for functions with explicit returns missing a "returns" section in -/// their docstring. +/// Checks for functions with `return` statements that do not have "Returns" +/// sections in their docstrings. /// /// ## Why is this bad? -/// Docstrings missing return sections are a sign of incomplete documentation -/// or refactors. +/// A missing "Returns" section is a sign of incomplete documentation. /// -/// This rule is not enforced for abstract methods, stubs functions, or -/// functions that only return `None`. +/// This rule is not enforced for abstract methods or functions that only return +/// `None`. It is also ignored for "stub functions": functions where the body only +/// consists of `pass`, `...`, `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -55,29 +56,30 @@ use crate::rules::pydocstyle::settings::Convention; /// """ /// return distance / time /// ``` -#[violation] -pub struct DocstringMissingReturns; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringMissingReturns; impl Violation for DocstringMissingReturns { #[derive_message_formats] fn message(&self) -> String { - format!("`return` is not documented in docstring") + "`return` is not documented in docstring".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Add a \"Returns\" section to the docstring")) + Some("Add a \"Returns\" section to the docstring".to_string()) } } /// ## What it does -/// Checks for function docstrings that have a "returns" section without -/// needing one. +/// Checks for function docstrings with unnecessary "Returns" sections. /// /// ## Why is this bad? -/// Functions without an explicit return should not have a returns section -/// in their docstrings. +/// A function without an explicit `return` statement should not have a +/// "Returns" section in its docstring. /// -/// This rule is not enforced for stub functions. +/// This rule is not enforced for abstract methods. It is also ignored for +/// "stub functions": functions where the body only consists of `pass`, `...`, +/// `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -105,30 +107,31 @@ impl Violation for DocstringMissingReturns { /// for _ in range(n): /// print("Hello!") /// ``` -#[violation] -pub struct DocstringExtraneousReturns; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringExtraneousReturns; impl Violation for DocstringExtraneousReturns { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring should not have a returns section because the function doesn't return anything") + "Docstring should not have a returns section because the function doesn't return anything" + .to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Remove the \"Returns\" section")) + Some("Remove the \"Returns\" section".to_string()) } } /// ## What it does -/// Checks for functions with yield statements missing a "yields" section in -/// their docstring. +/// Checks for functions with `yield` statements that do not have "Yields" sections in +/// their docstrings. /// /// ## Why is this bad? -/// Docstrings missing yields sections are a sign of incomplete documentation -/// or refactors. +/// A missing "Yields" section is a sign of incomplete documentation. /// -/// This rule is not enforced for abstract methods, stubs functions, or -/// functions that only yield `None`. +/// This rule is not enforced for abstract methods or functions that only yield `None`. +/// It is also ignored for "stub functions": functions where the body only consists +/// of `pass`, `...`, `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -156,29 +159,30 @@ impl Violation for DocstringExtraneousReturns { /// for i in range(1, n + 1): /// yield i /// ``` -#[violation] -pub struct DocstringMissingYields; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringMissingYields; impl Violation for DocstringMissingYields { #[derive_message_formats] fn message(&self) -> String { - format!("`yield` is not documented in docstring") + "`yield` is not documented in docstring".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Add a \"Yields\" section to the docstring")) + Some("Add a \"Yields\" section to the docstring".to_string()) } } /// ## What it does -/// Checks for function docstrings that have a "yields" section without -/// needing one. +/// Checks for function docstrings with unnecessary "Yields" sections. /// /// ## Why is this bad? -/// Functions which don't yield anything should not have a yields section -/// in their docstrings. +/// A function that doesn't yield anything should not have a "Yields" section +/// in its docstring. /// -/// This rule is not enforced for stub functions. +/// This rule is not enforced for abstract methods. It is also ignored for +/// "stub functions": functions where the body only consists of `pass`, `...`, +/// `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -206,30 +210,32 @@ impl Violation for DocstringMissingYields { /// for _ in range(n): /// print("Hello!") /// ``` -#[violation] -pub struct DocstringExtraneousYields; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringExtraneousYields; impl Violation for DocstringExtraneousYields { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring has a \"Yields\" section but the function doesn't yield anything") + "Docstring has a \"Yields\" section but the function doesn't yield anything".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Remove the \"Yields\" section")) + Some("Remove the \"Yields\" section".to_string()) } } /// ## What it does -/// Checks for function docstrings that do not include documentation for all -/// explicitly raised exceptions. +/// Checks for function docstrings that do not document all explicitly raised +/// exceptions. /// /// ## Why is this bad? -/// If a function raises an exception without documenting it in its docstring, -/// it can be misleading to users and/or a sign of incomplete documentation or -/// refactors. +/// A function should document all exceptions that are directly raised in some +/// circumstances. Failing to document an exception that could be raised +/// can be misleading to users and/or a sign of incomplete documentation. /// -/// This rule is not enforced for abstract methods and stubs functions. +/// This rule is not enforced for abstract methods. It is also ignored for +/// "stub functions": functions where the body only consists of `pass`, `...`, +/// `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -269,8 +275,8 @@ impl Violation for DocstringExtraneousYields { /// except ZeroDivisionError as exc: /// raise FasterThanLightError from exc /// ``` -#[violation] -pub struct DocstringMissingException { +#[derive(ViolationMetadata)] +pub(crate) struct DocstringMissingException { id: String, } @@ -288,14 +294,16 @@ impl Violation for DocstringMissingException { } /// ## What it does -/// Checks for function docstrings that include exceptions which are not -/// explicitly raised. +/// Checks for function docstrings that state that exceptions could be raised +/// even though they are not directly raised in the function body. /// /// ## Why is this bad? /// Some conventions prefer non-explicit exceptions be omitted from the /// docstring. /// -/// This rule is not enforced for stub functions. +/// This rule is not enforced for abstract methods. It is also ignored for +/// "stub functions": functions where the body only consists of `pass`, `...`, +/// `raise NotImplementedError`, or similar. /// /// ## Example /// ```python @@ -329,8 +337,13 @@ impl Violation for DocstringMissingException { /// """ /// return distance / time /// ``` -#[violation] -pub struct DocstringExtraneousException { +/// +/// ## Known issues +/// It may often be desirable to document *all* exceptions that a function +/// could possibly raise, even those which are not explicitly raised using +/// `raise` statements in the function body. +#[derive(ViolationMetadata)] +pub(crate) struct DocstringExtraneousException { ids: Vec<String>, } @@ -510,7 +523,7 @@ impl Ranged for YieldEntry { } } -#[allow(clippy::enum_variant_names)] +#[expect(clippy::enum_variant_names)] #[derive(Debug, Clone, Copy, PartialEq, Eq)] enum ReturnEntryKind { NotNone, @@ -781,7 +794,7 @@ impl<'a> GeneratorOrIteratorArguments<'a> { match self { Self::Unparameterized => true, Self::Single(_) => true, - Self::Several(elements) => elements.get(2).map_or(true, Expr::is_none_literal_expr), + Self::Several(elements) => elements.get(2).is_none_or(Expr::is_none_literal_expr), } } } @@ -793,16 +806,24 @@ fn generator_annotation_arguments<'a>( ) -> Option<GeneratorOrIteratorArguments<'a>> { let qualified_name = semantic.resolve_qualified_name(map_subscript(expr))?; match qualified_name.segments() { - ["typing" | "typing_extensions", "Iterable" | "AsyncIterable" | "Iterator" | "AsyncIterator"] - | ["collections", "abc", "Iterable" | "AsyncIterable" | "Iterator" | "AsyncIterator"] => { - match expr { - Expr::Subscript(ast::ExprSubscript { slice, .. }) => { - Some(GeneratorOrIteratorArguments::Single(slice)) - } - _ => Some(GeneratorOrIteratorArguments::Unparameterized), + [ + "typing" | "typing_extensions", + "Iterable" | "AsyncIterable" | "Iterator" | "AsyncIterator", + ] + | [ + "collections", + "abc", + "Iterable" | "AsyncIterable" | "Iterator" | "AsyncIterator", + ] => match expr { + Expr::Subscript(ast::ExprSubscript { slice, .. }) => { + Some(GeneratorOrIteratorArguments::Single(slice)) } - } - ["typing" | "typing_extensions", "Generator" | "AsyncGenerator"] + _ => Some(GeneratorOrIteratorArguments::Unparameterized), + }, + [ + "typing" | "typing_extensions", + "Generator" | "AsyncGenerator", + ] | ["collections", "abc", "Generator" | "AsyncGenerator"] => match expr { Expr::Subscript(ast::ExprSubscript { slice, .. }) => { if let Expr::Tuple(tuple) = &**slice { @@ -831,24 +852,38 @@ fn is_generator_function_annotated_as_returning_none( .is_some_and(GeneratorOrIteratorArguments::indicates_none_returned) } +fn is_one_line(docstring: &Docstring) -> bool { + let mut non_empty_line_count = 0; + for line in NewlineWithTrailingNewline::from(docstring.body().as_str()) { + if !line.trim().is_empty() { + non_empty_line_count += 1; + } + if non_empty_line_count > 1 { + return false; + } + } + true +} + /// DOC201, DOC202, DOC402, DOC403, DOC501, DOC502 pub(crate) fn check_docstring( - checker: &mut Checker, + checker: &Checker, definition: &Definition, docstring: &Docstring, section_contexts: &SectionContexts, convention: Option<Convention>, ) { - let mut diagnostics = Vec::new(); - // Only check function docstrings. let Some(function_def) = definition.as_function_def() else { return; }; + if checker.settings.pydoclint.ignore_one_line_docstrings && is_one_line(docstring) { + return; + } + let semantic = checker.semantic(); - // Ignore stubs. if function_type::is_stub(function_def, semantic) { return; } @@ -877,7 +912,7 @@ pub(crate) fn check_docstring( { let extra_property_decorators = checker.settings.pydocstyle.property_decorators(); if !definition.is_property(extra_property_decorators, semantic) { - if let Some(body_return) = body_entries.returns.first() { + if !body_entries.returns.is_empty() { match function_def.returns.as_deref() { Some(returns) => { // Ignore it if it's annotated as returning `None` @@ -890,9 +925,9 @@ pub(crate) fn check_docstring( semantic, ) { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DocstringMissingReturns, - body_return.range(), + docstring.range(), )); } } @@ -901,9 +936,9 @@ pub(crate) fn check_docstring( .iter() .any(|entry| !entry.is_none_return()) => { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( DocstringMissingReturns, - body_return.range(), + docstring.range(), )); } _ => {} @@ -916,19 +951,23 @@ pub(crate) fn check_docstring( // DOC402 if checker.enabled(Rule::DocstringMissingYields) { if !yields_documented(docstring, &docstring_sections, convention) { - if let Some(body_yield) = body_entries.yields.first() { + if !body_entries.yields.is_empty() { match function_def.returns.as_deref() { Some(returns) if !generator_annotation_arguments(returns, semantic).is_some_and( - |arguments| arguments.first().map_or(true, Expr::is_none_literal_expr), + |arguments| arguments.first().is_none_or(Expr::is_none_literal_expr), ) => { - diagnostics - .push(Diagnostic::new(DocstringMissingYields, body_yield.range())); + checker.report_diagnostic(Diagnostic::new( + DocstringMissingYields, + docstring.range(), + )); } None if body_entries.yields.iter().any(|entry| !entry.is_none_yield) => { - diagnostics - .push(Diagnostic::new(DocstringMissingYields, body_yield.range())); + checker.report_diagnostic(Diagnostic::new( + DocstringMissingYields, + docstring.range(), + )); } _ => {} } @@ -959,9 +998,9 @@ pub(crate) fn check_docstring( DocstringMissingException { id: (*name).to_string(), }, - body_raise.range(), + docstring.range(), ); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -971,24 +1010,22 @@ pub(crate) fn check_docstring( if !visibility::is_abstract(&function_def.decorator_list, semantic) { // DOC202 if checker.enabled(Rule::DocstringExtraneousReturns) { - if let Some(ref docstring_returns) = docstring_sections.returns { + if docstring_sections.returns.is_some() { if body_entries.returns.is_empty() || body_entries.returns.iter().all(ReturnEntry::is_implicit) { - let diagnostic = - Diagnostic::new(DocstringExtraneousReturns, docstring_returns.range()); - diagnostics.push(diagnostic); + let diagnostic = Diagnostic::new(DocstringExtraneousReturns, docstring.range()); + checker.report_diagnostic(diagnostic); } } } // DOC403 if checker.enabled(Rule::DocstringExtraneousYields) { - if let Some(docstring_yields) = docstring_sections.yields { + if docstring_sections.yields.is_some() { if body_entries.yields.is_empty() { - let diagnostic = - Diagnostic::new(DocstringExtraneousYields, docstring_yields.range()); - diagnostics.push(diagnostic); + let diagnostic = Diagnostic::new(DocstringExtraneousYields, docstring.range()); + checker.report_diagnostic(diagnostic); } } } @@ -1012,13 +1049,11 @@ pub(crate) fn check_docstring( DocstringExtraneousException { ids: extraneous_exceptions, }, - docstring_raises.range(), + docstring.range(), ); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } - - checker.diagnostics.extend(diagnostics); } diff --git a/crates/ruff_linter/src/rules/pydoclint/settings.rs b/crates/ruff_linter/src/rules/pydoclint/settings.rs new file mode 100644 index 0000000000000..d54e06c1c795e --- /dev/null +++ b/crates/ruff_linter/src/rules/pydoclint/settings.rs @@ -0,0 +1,21 @@ +//! Settings for the `pydoclint` plugin. + +use crate::display_settings; +use ruff_macros::CacheKey; +use std::fmt::{Display, Formatter}; + +#[derive(Debug, Clone, Default, CacheKey)] +pub struct Settings { + pub ignore_one_line_docstrings: bool, +} + +impl Display for Settings { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + display_settings! { + formatter = f, + namespace = "linter.pydoclint", + fields = [self.ignore_one_line_docstrings] + } + Ok(()) + } +} diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_google.py.snap index 58a44b6914d46..c8473308908cf 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_google.py.snap @@ -1,40 +1,67 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC502_google.py:16:1: DOC502 Raised exception is not explicitly raised: `FasterThanLightError` +DOC502_google.py:7:5: DOC502 Raised exception is not explicitly raised: `FasterThanLightError` | -14 | Speed as distance divided by time. -15 | -16 | / Raises: + 5 | # DOC502 + 6 | def calculate_speed(distance: float, time: float) -> float: + 7 | / """Calculate speed as distance divided by time. + 8 | | + 9 | | Args: +10 | | distance: Distance traveled. +11 | | time: Time spent traveling. +12 | | +13 | | Returns: +14 | | Speed as distance divided by time. +15 | | +16 | | Raises: 17 | | FasterThanLightError: If speed is greater than the speed of light. 18 | | """ - | |____^ DOC502 + | |_______^ DOC502 19 | return distance / time | = help: Remove `FasterThanLightError` from the docstring -DOC502_google.py:33:1: DOC502 Raised exceptions are not explicitly raised: `FasterThanLightError`, `DivisionByZero` +DOC502_google.py:24:5: DOC502 Raised exceptions are not explicitly raised: `FasterThanLightError`, `DivisionByZero` | -31 | Speed as distance divided by time. -32 | -33 | / Raises: +22 | # DOC502 +23 | def calculate_speed(distance: float, time: float) -> float: +24 | / """Calculate speed as distance divided by time. +25 | | +26 | | Args: +27 | | distance: Distance traveled. +28 | | time: Time spent traveling. +29 | | +30 | | Returns: +31 | | Speed as distance divided by time. +32 | | +33 | | Raises: 34 | | FasterThanLightError: If speed is greater than the speed of light. 35 | | DivisionByZero: Divide by zero. 36 | | """ - | |____^ DOC502 + | |_______^ DOC502 37 | return distance / time | = help: Remove `FasterThanLightError`, `DivisionByZero` from the docstring -DOC502_google.py:51:1: DOC502 Raised exception is not explicitly raised: `DivisionByZero` +DOC502_google.py:42:5: DOC502 Raised exception is not explicitly raised: `DivisionByZero` | -49 | Speed as distance divided by time. -50 | -51 | / Raises: +40 | # DOC502 +41 | def calculate_speed(distance: float, time: float) -> float: +42 | / """Calculate speed as distance divided by time. +43 | | +44 | | Args: +45 | | distance: Distance traveled. +46 | | time: Time spent traveling. +47 | | +48 | | Returns: +49 | | Speed as distance divided by time. +50 | | +51 | | Raises: 52 | | FasterThanLightError: If speed is greater than the speed of light. 53 | | DivisionByZero: Divide by zero. 54 | | """ - | |____^ DOC502 + | |_______^ DOC502 55 | try: 56 | return distance / time | diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_numpy.py.snap index 34a0964a08e31..b007d9536bc5c 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-exception_DOC502_numpy.py.snap @@ -1,48 +1,93 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC502_numpy.py:22:1: DOC502 Raised exception is not explicitly raised: `FasterThanLightError` +DOC502_numpy.py:7:5: DOC502 Raised exception is not explicitly raised: `FasterThanLightError` | -20 | Speed as distance divided by time. -21 | -22 | / Raises + 5 | # DOC502 + 6 | def calculate_speed(distance: float, time: float) -> float: + 7 | / """ + 8 | | Calculate speed as distance divided by time. + 9 | | +10 | | Parameters +11 | | ---------- +12 | | distance : float +13 | | Distance traveled. +14 | | time : float +15 | | Time spent traveling. +16 | | +17 | | Returns +18 | | ------- +19 | | float +20 | | Speed as distance divided by time. +21 | | +22 | | Raises 23 | | ------ 24 | | FasterThanLightError 25 | | If speed is greater than the speed of light. 26 | | """ - | |____^ DOC502 + | |_______^ DOC502 27 | return distance / time | = help: Remove `FasterThanLightError` from the docstring -DOC502_numpy.py:47:1: DOC502 Raised exceptions are not explicitly raised: `FasterThanLightError`, `DivisionByZero` +DOC502_numpy.py:32:5: DOC502 Raised exceptions are not explicitly raised: `FasterThanLightError`, `DivisionByZero` | -45 | Speed as distance divided by time. -46 | -47 | / Raises +30 | # DOC502 +31 | def calculate_speed(distance: float, time: float) -> float: +32 | / """ +33 | | Calculate speed as distance divided by time. +34 | | +35 | | Parameters +36 | | ---------- +37 | | distance : float +38 | | Distance traveled. +39 | | time : float +40 | | Time spent traveling. +41 | | +42 | | Returns +43 | | ------- +44 | | float +45 | | Speed as distance divided by time. +46 | | +47 | | Raises 48 | | ------ 49 | | FasterThanLightError 50 | | If speed is greater than the speed of light. 51 | | DivisionByZero 52 | | If attempting to divide by zero. 53 | | """ - | |____^ DOC502 + | |_______^ DOC502 54 | return distance / time | = help: Remove `FasterThanLightError`, `DivisionByZero` from the docstring -DOC502_numpy.py:74:1: DOC502 Raised exception is not explicitly raised: `DivisionByZero` +DOC502_numpy.py:59:5: DOC502 Raised exception is not explicitly raised: `DivisionByZero` | -72 | Speed as distance divided by time. -73 | -74 | / Raises +57 | # DOC502 +58 | def calculate_speed(distance: float, time: float) -> float: +59 | / """ +60 | | Calculate speed as distance divided by time. +61 | | +62 | | Parameters +63 | | ---------- +64 | | distance : float +65 | | Distance traveled. +66 | | time : float +67 | | Time spent traveling. +68 | | +69 | | Returns +70 | | ------- +71 | | float +72 | | Speed as distance divided by time. +73 | | +74 | | Raises 75 | | ------ 76 | | FasterThanLightError 77 | | If speed is greater than the speed of light. 78 | | DivisionByZero 79 | | If attempting to divide by zero. 80 | | """ - | |____^ DOC502 + | |_______^ DOC502 81 | try: 82 | return distance / time | diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap index ded71e7f05557..70beeffbc12e4 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap @@ -1,38 +1,52 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC202_google.py:20:1: DOC202 Docstring should not have a returns section because the function doesn't return anything +DOC202_google.py:14:5: DOC202 Docstring should not have a returns section because the function doesn't return anything | -18 | num (int): A number -19 | -20 | / Returns: +12 | # DOC202 +13 | def foo(num: int) -> str: +14 | / """ +15 | | Do something +16 | | +17 | | Args: +18 | | num (int): A number +19 | | +20 | | Returns: 21 | | str: A string 22 | | """ - | |____^ DOC202 + | |_______^ DOC202 23 | print('test') | = help: Remove the "Returns" section -DOC202_google.py:36:1: DOC202 Docstring should not have a returns section because the function doesn't return anything +DOC202_google.py:30:9: DOC202 Docstring should not have a returns section because the function doesn't return anything | -34 | num (int): A number -35 | -36 | / Returns: +28 | # DOC202 +29 | def foo(self) -> str: +30 | / """ +31 | | Do something +32 | | +33 | | Args: +34 | | num (int): A number +35 | | +36 | | Returns: 37 | | str: A string 38 | | """ - | |________^ DOC202 + | |___________^ DOC202 39 | print('test') | = help: Remove the "Returns" section -DOC202_google.py:82:1: DOC202 Docstring should not have a returns section because the function doesn't return anything +DOC202_google.py:80:5: DOC202 Docstring should not have a returns section because the function doesn't return anything | -80 | """Fooey things. -81 | -82 | / Returns: +78 | # DOC202 -- never explicitly returns anything, just short-circuits +79 | def foo(s: str, condition: bool): +80 | / """Fooey things. +81 | | +82 | | Returns: 83 | | None 84 | | """ - | |____^ DOC202 + | |_______^ DOC202 85 | if not condition: 86 | return | diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap index 4c1e3fffe4dd3..0bb06b9b99021 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap @@ -1,30 +1,46 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC202_numpy.py:24:1: DOC202 Docstring should not have a returns section because the function doesn't return anything +DOC202_numpy.py:16:5: DOC202 Docstring should not have a returns section because the function doesn't return anything | -22 | A number -23 | -24 | / Returns +14 | # DOC202 +15 | def foo(num: int) -> str: +16 | / """ +17 | | Do something +18 | | +19 | | Parameters +20 | | ---------- +21 | | num : int +22 | | A number +23 | | +24 | | Returns 25 | | ------- 26 | | str 27 | | A string 28 | | """ - | |____^ DOC202 + | |_______^ DOC202 29 | print('test') | = help: Remove the "Returns" section -DOC202_numpy.py:44:1: DOC202 Docstring should not have a returns section because the function doesn't return anything +DOC202_numpy.py:36:9: DOC202 Docstring should not have a returns section because the function doesn't return anything | -42 | A number -43 | -44 | / Returns +34 | # DOC202 +35 | def foo(self) -> str: +36 | / """ +37 | | Do something +38 | | +39 | | Parameters +40 | | ---------- +41 | | num : int +42 | | A number +43 | | +44 | | Returns 45 | | ------- 46 | | str 47 | | A string 48 | | """ - | |________^ DOC202 + | |___________^ DOC202 49 | print('test') | = help: Remove the "Returns" section diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_google.py.snap index 2c3c651b226ff..dccb259a11ed0 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_google.py.snap @@ -1,26 +1,38 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC403_google.py:20:1: DOC403 Docstring has a "Yields" section but the function doesn't yield anything +DOC403_google.py:14:5: DOC403 Docstring has a "Yields" section but the function doesn't yield anything | -18 | num (int): A number -19 | -20 | / Yields: +12 | # DOC403 +13 | def foo(num: int) -> str: +14 | / """ +15 | | Do something +16 | | +17 | | Args: +18 | | num (int): A number +19 | | +20 | | Yields: 21 | | str: A string 22 | | """ - | |____^ DOC403 + | |_______^ DOC403 23 | print('test') | = help: Remove the "Yields" section -DOC403_google.py:36:1: DOC403 Docstring has a "Yields" section but the function doesn't yield anything +DOC403_google.py:30:9: DOC403 Docstring has a "Yields" section but the function doesn't yield anything | -34 | num (int): A number -35 | -36 | / Yields: +28 | # DOC403 +29 | def foo(self) -> str: +30 | / """ +31 | | Do something +32 | | +33 | | Args: +34 | | num (int): A number +35 | | +36 | | Yields: 37 | | str: A string 38 | | """ - | |________^ DOC403 + | |___________^ DOC403 39 | print('test') | = help: Remove the "Yields" section diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_numpy.py.snap index aff49d2869d95..d87e8f4f27c40 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-extraneous-yields_DOC403_numpy.py.snap @@ -1,30 +1,46 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC403_numpy.py:24:1: DOC403 Docstring has a "Yields" section but the function doesn't yield anything +DOC403_numpy.py:16:5: DOC403 Docstring has a "Yields" section but the function doesn't yield anything | -22 | A number -23 | -24 | / Yields +14 | # DOC403 +15 | def foo(num: int) -> str: +16 | / """ +17 | | Do something +18 | | +19 | | Parameters +20 | | ---------- +21 | | num : int +22 | | A number +23 | | +24 | | Yields 25 | | ------- 26 | | str 27 | | A string 28 | | """ - | |____^ DOC403 + | |_______^ DOC403 29 | print('test') | = help: Remove the "Yields" section -DOC403_numpy.py:44:1: DOC403 Docstring has a "Yields" section but the function doesn't yield anything +DOC403_numpy.py:36:9: DOC403 Docstring has a "Yields" section but the function doesn't yield anything | -42 | A number -43 | -44 | / Yields +34 | # DOC403 +35 | def foo(self) -> str: +36 | / """ +37 | | Do something +38 | | +39 | | Parameters +40 | | ---------- +41 | | num : int +42 | | A number +43 | | +44 | | Yields 45 | | ------- 46 | | str 47 | | A string 48 | | """ - | |________^ DOC403 + | |___________^ DOC403 49 | print('test') | = help: Remove the "Yields" section diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501.py.snap index d3c56b22a3cc2..884a3b2f8627c 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py.snap index e8fbdff46c0e9..b30b47f6f7efc 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py.snap @@ -1,90 +1,159 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC501_google.py:46:15: DOC501 Raised exception `FasterThanLightError` missing from docstring +DOC501_google.py:34:5: DOC501 Raised exception `FasterThanLightError` missing from docstring | -44 | return distance / time -45 | except ZeroDivisionError as exc: -46 | raise FasterThanLightError from exc - | ^^^^^^^^^^^^^^^^^^^^ DOC501 +32 | # DOC501 +33 | def calculate_speed(distance: float, time: float) -> float: +34 | / """Calculate speed as distance divided by time. +35 | | +36 | | Args: +37 | | distance: Distance traveled. +38 | | time: Time spent traveling. +39 | | +40 | | Returns: +41 | | Speed as distance divided by time. +42 | | """ + | |_______^ DOC501 +43 | try: +44 | return distance / time | = help: Add `FasterThanLightError` to the docstring -DOC501_google.py:63:15: DOC501 Raised exception `FasterThanLightError` missing from docstring +DOC501_google.py:51:5: DOC501 Raised exception `ValueError` missing from docstring | -61 | return distance / time -62 | except ZeroDivisionError as exc: -63 | raise FasterThanLightError from exc - | ^^^^^^^^^^^^^^^^^^^^ DOC501 -64 | except: -65 | raise ValueError +49 | # DOC501 +50 | def calculate_speed(distance: float, time: float) -> float: +51 | / """Calculate speed as distance divided by time. +52 | | +53 | | Args: +54 | | distance: Distance traveled. +55 | | time: Time spent traveling. +56 | | +57 | | Returns: +58 | | Speed as distance divided by time. +59 | | """ + | |_______^ DOC501 +60 | try: +61 | return distance / time | - = help: Add `FasterThanLightError` to the docstring + = help: Add `ValueError` to the docstring -DOC501_google.py:65:15: DOC501 Raised exception `ValueError` missing from docstring +DOC501_google.py:51:5: DOC501 Raised exception `FasterThanLightError` missing from docstring | -63 | raise FasterThanLightError from exc -64 | except: -65 | raise ValueError - | ^^^^^^^^^^ DOC501 +49 | # DOC501 +50 | def calculate_speed(distance: float, time: float) -> float: +51 | / """Calculate speed as distance divided by time. +52 | | +53 | | Args: +54 | | distance: Distance traveled. +55 | | time: Time spent traveling. +56 | | +57 | | Returns: +58 | | Speed as distance divided by time. +59 | | """ + | |_______^ DOC501 +60 | try: +61 | return distance / time | - = help: Add `ValueError` to the docstring + = help: Add `FasterThanLightError` to the docstring -DOC501_google.py:115:11: DOC501 Raised exception `AnotherError` missing from docstring +DOC501_google.py:106:5: DOC501 Raised exception `AnotherError` missing from docstring | -113 | Speed as distance divided by time. -114 | """ -115 | raise AnotherError - | ^^^^^^^^^^^^ DOC501 +104 | # DOC501 +105 | def calculate_speed(distance: float, time: float) -> float: +106 | / """Calculate speed as distance divided by time. +107 | | +108 | | Args: +109 | | distance: Distance traveled. +110 | | time: Time spent traveling. +111 | | +112 | | Returns: +113 | | Speed as distance divided by time. +114 | | """ + | |_______^ DOC501 +115 | raise AnotherError | = help: Add `AnotherError` to the docstring -DOC501_google.py:129:11: DOC501 Raised exception `AnotherError` missing from docstring +DOC501_google.py:120:5: DOC501 Raised exception `AnotherError` missing from docstring | -127 | Speed as distance divided by time. -128 | """ -129 | raise AnotherError() - | ^^^^^^^^^^^^^^ DOC501 +118 | # DOC501 +119 | def calculate_speed(distance: float, time: float) -> float: +120 | / """Calculate speed as distance divided by time. +121 | | +122 | | Args: +123 | | distance: Distance traveled. +124 | | time: Time spent traveling. +125 | | +126 | | Returns: +127 | | Speed as distance divided by time. +128 | | """ + | |_______^ DOC501 +129 | raise AnotherError() | = help: Add `AnotherError` to the docstring -DOC501_google.py:139:11: DOC501 Raised exception `SomeError` missing from docstring +DOC501_google.py:134:5: DOC501 Raised exception `SomeError` missing from docstring | -137 | bar: Bar. -138 | """ -139 | raise something.SomeError - | ^^^^^^^^^^^^^^^^^^^ DOC501 +132 | # DOC501 +133 | def foo(bar: int): +134 | / """Foo. +135 | | +136 | | Args: +137 | | bar: Bar. +138 | | """ + | |_______^ DOC501 +139 | raise something.SomeError | = help: Add `SomeError` to the docstring -DOC501_google.py:213:9: DOC501 Raised exception `ZeroDivisionError` missing from docstring +DOC501_google.py:197:5: DOC501 Raised exception `ZeroDivisionError` missing from docstring | -211 | except ZeroDivisionError: -212 | print("Oh no, why would you divide something by zero?") -213 | raise - | ^^^^^ DOC501 -214 | except TypeError: -215 | print("Not a number? Shame on you!") +195 | # DOC501 +196 | def calculate_speed(distance: float, time: float) -> float: +197 | / """Calculate speed as distance divided by time. +198 | | +199 | | Args: +200 | | distance: Distance traveled. +201 | | time: Time spent traveling. +202 | | +203 | | Returns: +204 | | Speed as distance divided by time. +205 | | +206 | | Raises: +207 | | TypeError: if you didn't pass a number for both parameters +208 | | """ + | |_______^ DOC501 +209 | try: +210 | return distance / time | = help: Add `ZeroDivisionError` to the docstring -DOC501_google.py:244:15: DOC501 Raised exception `TypeError` missing from docstring +DOC501_google.py:238:5: DOC501 Raised exception `TypeError` missing from docstring | -242 | """ -243 | if True: -244 | raise TypeError # DOC501 - | ^^^^^^^^^ DOC501 -245 | else: -246 | raise TypeError # no DOC501 here because we already emitted a diagnostic for the earlier `raise TypeError` +237 | def foo(): +238 | / """Foo. +239 | | +240 | | Returns: +241 | | 42: int. +242 | | """ + | |_______^ DOC501 +243 | if True: +244 | raise TypeError # DOC501 | = help: Add `TypeError` to the docstring -DOC501_google.py:247:11: DOC501 Raised exception `ValueError` missing from docstring +DOC501_google.py:238:5: DOC501 Raised exception `ValueError` missing from docstring | -245 | else: -246 | raise TypeError # no DOC501 here because we already emitted a diagnostic for the earlier `raise TypeError` -247 | raise ValueError # DOC501 - | ^^^^^^^^^^ DOC501 -248 | return 42 +237 | def foo(): +238 | / """Foo. +239 | | +240 | | Returns: +241 | | 42: int. +242 | | """ + | |_______^ DOC501 +243 | if True: +244 | raise TypeError # DOC501 | = help: Add `ValueError` to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py_ignore_one_line.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py_ignore_one_line.snap new file mode 100644 index 0000000000000..b30b47f6f7efc --- /dev/null +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_google.py_ignore_one_line.snap @@ -0,0 +1,159 @@ +--- +source: crates/ruff_linter/src/rules/pydoclint/mod.rs +--- +DOC501_google.py:34:5: DOC501 Raised exception `FasterThanLightError` missing from docstring + | +32 | # DOC501 +33 | def calculate_speed(distance: float, time: float) -> float: +34 | / """Calculate speed as distance divided by time. +35 | | +36 | | Args: +37 | | distance: Distance traveled. +38 | | time: Time spent traveling. +39 | | +40 | | Returns: +41 | | Speed as distance divided by time. +42 | | """ + | |_______^ DOC501 +43 | try: +44 | return distance / time + | + = help: Add `FasterThanLightError` to the docstring + +DOC501_google.py:51:5: DOC501 Raised exception `ValueError` missing from docstring + | +49 | # DOC501 +50 | def calculate_speed(distance: float, time: float) -> float: +51 | / """Calculate speed as distance divided by time. +52 | | +53 | | Args: +54 | | distance: Distance traveled. +55 | | time: Time spent traveling. +56 | | +57 | | Returns: +58 | | Speed as distance divided by time. +59 | | """ + | |_______^ DOC501 +60 | try: +61 | return distance / time + | + = help: Add `ValueError` to the docstring + +DOC501_google.py:51:5: DOC501 Raised exception `FasterThanLightError` missing from docstring + | +49 | # DOC501 +50 | def calculate_speed(distance: float, time: float) -> float: +51 | / """Calculate speed as distance divided by time. +52 | | +53 | | Args: +54 | | distance: Distance traveled. +55 | | time: Time spent traveling. +56 | | +57 | | Returns: +58 | | Speed as distance divided by time. +59 | | """ + | |_______^ DOC501 +60 | try: +61 | return distance / time + | + = help: Add `FasterThanLightError` to the docstring + +DOC501_google.py:106:5: DOC501 Raised exception `AnotherError` missing from docstring + | +104 | # DOC501 +105 | def calculate_speed(distance: float, time: float) -> float: +106 | / """Calculate speed as distance divided by time. +107 | | +108 | | Args: +109 | | distance: Distance traveled. +110 | | time: Time spent traveling. +111 | | +112 | | Returns: +113 | | Speed as distance divided by time. +114 | | """ + | |_______^ DOC501 +115 | raise AnotherError + | + = help: Add `AnotherError` to the docstring + +DOC501_google.py:120:5: DOC501 Raised exception `AnotherError` missing from docstring + | +118 | # DOC501 +119 | def calculate_speed(distance: float, time: float) -> float: +120 | / """Calculate speed as distance divided by time. +121 | | +122 | | Args: +123 | | distance: Distance traveled. +124 | | time: Time spent traveling. +125 | | +126 | | Returns: +127 | | Speed as distance divided by time. +128 | | """ + | |_______^ DOC501 +129 | raise AnotherError() + | + = help: Add `AnotherError` to the docstring + +DOC501_google.py:134:5: DOC501 Raised exception `SomeError` missing from docstring + | +132 | # DOC501 +133 | def foo(bar: int): +134 | / """Foo. +135 | | +136 | | Args: +137 | | bar: Bar. +138 | | """ + | |_______^ DOC501 +139 | raise something.SomeError + | + = help: Add `SomeError` to the docstring + +DOC501_google.py:197:5: DOC501 Raised exception `ZeroDivisionError` missing from docstring + | +195 | # DOC501 +196 | def calculate_speed(distance: float, time: float) -> float: +197 | / """Calculate speed as distance divided by time. +198 | | +199 | | Args: +200 | | distance: Distance traveled. +201 | | time: Time spent traveling. +202 | | +203 | | Returns: +204 | | Speed as distance divided by time. +205 | | +206 | | Raises: +207 | | TypeError: if you didn't pass a number for both parameters +208 | | """ + | |_______^ DOC501 +209 | try: +210 | return distance / time + | + = help: Add `ZeroDivisionError` to the docstring + +DOC501_google.py:238:5: DOC501 Raised exception `TypeError` missing from docstring + | +237 | def foo(): +238 | / """Foo. +239 | | +240 | | Returns: +241 | | 42: int. +242 | | """ + | |_______^ DOC501 +243 | if True: +244 | raise TypeError # DOC501 + | + = help: Add `TypeError` to the docstring + +DOC501_google.py:238:5: DOC501 Raised exception `ValueError` missing from docstring + | +237 | def foo(): +238 | / """Foo. +239 | | +240 | | Returns: +241 | | 42: int. +242 | | """ + | |_______^ DOC501 +243 | if True: +244 | raise TypeError # DOC501 + | + = help: Add `ValueError` to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_numpy.py.snap index 3511ea7a6a317..1a53bef11f492 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-exception_DOC501_numpy.py.snap @@ -1,61 +1,140 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC501_numpy.py:53:15: DOC501 Raised exception `FasterThanLightError` missing from docstring +DOC501_numpy.py:35:5: DOC501 Raised exception `FasterThanLightError` missing from docstring | -51 | return distance / time -52 | except ZeroDivisionError as exc: -53 | raise FasterThanLightError from exc - | ^^^^^^^^^^^^^^^^^^^^ DOC501 +33 | # DOC501 +34 | def calculate_speed(distance: float, time: float) -> float: +35 | / """ +36 | | Calculate speed as distance divided by time. +37 | | +38 | | Parameters +39 | | ---------- +40 | | distance : float +41 | | Distance traveled. +42 | | time : float +43 | | Time spent traveling. +44 | | +45 | | Returns +46 | | ------- +47 | | float +48 | | Speed as distance divided by time. +49 | | """ + | |_______^ DOC501 +50 | try: +51 | return distance / time | = help: Add `FasterThanLightError` to the docstring -DOC501_numpy.py:76:15: DOC501 Raised exception `FasterThanLightError` missing from docstring +DOC501_numpy.py:58:5: DOC501 Raised exception `ValueError` missing from docstring | -74 | return distance / time -75 | except ZeroDivisionError as exc: -76 | raise FasterThanLightError from exc - | ^^^^^^^^^^^^^^^^^^^^ DOC501 -77 | except: -78 | raise ValueError +56 | # DOC501 +57 | def calculate_speed(distance: float, time: float) -> float: +58 | / """ +59 | | Calculate speed as distance divided by time. +60 | | +61 | | Parameters +62 | | ---------- +63 | | distance : float +64 | | Distance traveled. +65 | | time : float +66 | | Time spent traveling. +67 | | +68 | | Returns +69 | | ------- +70 | | float +71 | | Speed as distance divided by time. +72 | | """ + | |_______^ DOC501 +73 | try: +74 | return distance / time | - = help: Add `FasterThanLightError` to the docstring + = help: Add `ValueError` to the docstring -DOC501_numpy.py:78:15: DOC501 Raised exception `ValueError` missing from docstring +DOC501_numpy.py:58:5: DOC501 Raised exception `FasterThanLightError` missing from docstring | -76 | raise FasterThanLightError from exc -77 | except: -78 | raise ValueError - | ^^^^^^^^^^ DOC501 +56 | # DOC501 +57 | def calculate_speed(distance: float, time: float) -> float: +58 | / """ +59 | | Calculate speed as distance divided by time. +60 | | +61 | | Parameters +62 | | ---------- +63 | | distance : float +64 | | Distance traveled. +65 | | time : float +66 | | Time spent traveling. +67 | | +68 | | Returns +69 | | ------- +70 | | float +71 | | Speed as distance divided by time. +72 | | """ + | |_______^ DOC501 +73 | try: +74 | return distance / time | - = help: Add `ValueError` to the docstring + = help: Add `FasterThanLightError` to the docstring -DOC501_numpy.py:111:9: DOC501 Raised exception `TypeError` missing from docstring +DOC501_numpy.py:83:5: DOC501 Raised exception `TypeError` missing from docstring | -109 | except TypeError: -110 | print("Not a number? Shame on you!") -111 | raise - | ^^^^^ DOC501 + 81 | # DOC501 + 82 | def calculate_speed(distance: float, time: float) -> float: + 83 | / """Calculate speed as distance divided by time. + 84 | | + 85 | | ACalculate speed as distance divided by time. + 86 | | + 87 | | Parameters + 88 | | ---------- + 89 | | distance : float + 90 | | Distance traveled. + 91 | | time : float + 92 | | Time spent traveling. + 93 | | + 94 | | Returns + 95 | | ------- + 96 | | float + 97 | | Speed as distance divided by time. + 98 | | + 99 | | Raises +100 | | ------ +101 | | ZeroDivisionError +102 | | If attempting to divide by zero. +103 | | """ + | |_______^ DOC501 +104 | try: +105 | return distance / time | = help: Add `TypeError` to the docstring -DOC501_numpy.py:147:15: DOC501 Raised exception `TypeError` missing from docstring +DOC501_numpy.py:139:5: DOC501 Raised exception `TypeError` missing from docstring | -145 | """ -146 | if True: -147 | raise TypeError # DOC501 - | ^^^^^^^^^ DOC501 -148 | else: -149 | raise TypeError # no DOC501 here because we already emitted a diagnostic for the earlier `raise TypeError` +138 | def foo(): +139 | / """Foo. +140 | | +141 | | Returns +142 | | ------- +143 | | int +144 | | 42 +145 | | """ + | |_______^ DOC501 +146 | if True: +147 | raise TypeError # DOC501 | = help: Add `TypeError` to the docstring -DOC501_numpy.py:150:11: DOC501 Raised exception `ValueError` missing from docstring +DOC501_numpy.py:139:5: DOC501 Raised exception `ValueError` missing from docstring | -148 | else: -149 | raise TypeError # no DOC501 here because we already emitted a diagnostic for the earlier `raise TypeError` -150 | raise ValueError # DOC501 - | ^^^^^^^^^^ DOC501 -151 | return 42 +138 | def foo(): +139 | / """Foo. +140 | | +141 | | Returns +142 | | ------- +143 | | int +144 | | 42 +145 | | """ + | |_______^ DOC501 +146 | if True: +147 | raise TypeError # DOC501 | = help: Add `ValueError` to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py.snap index 6878a1bbe683d..d074c173669c6 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py.snap @@ -1,71 +1,96 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC201_google.py:9:5: DOC201 `return` is not documented in docstring +DOC201_google.py:3:5: DOC201 `return` is not documented in docstring | -7 | num (int): A number -8 | """ -9 | return 'test' - | ^^^^^^^^^^^^^ DOC201 +1 | # DOC201 +2 | def foo(num: int) -> str: +3 | / """ +4 | | Do something +5 | | +6 | | Args: +7 | | num (int): A number +8 | | """ + | |_______^ DOC201 +9 | return 'test' | = help: Add a "Returns" section to the docstring -DOC201_google.py:50:9: DOC201 `return` is not documented in docstring +DOC201_google.py:44:9: DOC201 `return` is not documented in docstring | -48 | num (int): A number -49 | """ -50 | return 'test' - | ^^^^^^^^^^^^^ DOC201 +42 | # DOC201 +43 | def bar(self) -> str: +44 | / """ +45 | | Do something +46 | | +47 | | Args: +48 | | num (int): A number +49 | | """ + | |___________^ DOC201 +50 | return 'test' | = help: Add a "Returns" section to the docstring -DOC201_google.py:71:9: DOC201 `return` is not documented in docstring +DOC201_google.py:70:9: DOC201 `return` is not documented in docstring | +68 | # DOC201 69 | def nested(): 70 | """Do something nested.""" + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC201 71 | return 5 - | ^^^^^^^^ DOC201 -72 | -73 | print("I never return") | = help: Add a "Returns" section to the docstring -DOC201_google.py:121:9: DOC201 `return` is not documented in docstring +DOC201_google.py:120:9: DOC201 `return` is not documented in docstring | +118 | @abc.abstractmethod 119 | def f(self): 120 | """Lorem ipsum.""" + | ^^^^^^^^^^^^^^^^^^ DOC201 121 | return True - | ^^^^^^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring -DOC201_google.py:184:9: DOC201 `return` is not documented in docstring +DOC201_google.py:178:5: DOC201 `return` is not documented in docstring | -182 | """ -183 | if x < 0: -184 | return None - | ^^^^^^^^^^^ DOC201 -185 | else: -186 | return x +176 | # DOC201 - non-early return explicit None +177 | def foo(x: int) -> int | None: +178 | / """A very helpful docstring. +179 | | +180 | | Args: +181 | | x (int): An integer. +182 | | """ + | |_______^ DOC201 +183 | if x < 0: +184 | return None | = help: Add a "Returns" section to the docstring -DOC201_google.py:197:9: DOC201 `return` is not documented in docstring +DOC201_google.py:191:5: DOC201 `return` is not documented in docstring | -195 | """ -196 | if x < 0: -197 | return None - | ^^^^^^^^^^^ DOC201 -198 | else: -199 | return x +189 | # DOC201 - non-early return explicit None w/o useful type annotations +190 | def foo(x): +191 | / """A very helpful docstring. +192 | | +193 | | Args: +194 | | x (int): An integer. +195 | | """ + | |_______^ DOC201 +196 | if x < 0: +197 | return None | = help: Add a "Returns" section to the docstring -DOC201_google.py:209:5: DOC201 `return` is not documented in docstring +DOC201_google.py:204:5: DOC201 `return` is not documented in docstring | -207 | s (str): A string. -208 | """ -209 | return None - | ^^^^^^^^^^^ DOC201 +202 | # DOC201 - only returns None, but return annotation is not None +203 | def foo(s: str) -> str | None: +204 | / """A very helpful docstring. +205 | | +206 | | Args: +207 | | s (str): A string. +208 | | """ + | |_______^ DOC201 +209 | return None | = help: Add a "Returns" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py_ignore_one_line.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py_ignore_one_line.snap new file mode 100644 index 0000000000000..87a9dd1aae47d --- /dev/null +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_google.py_ignore_one_line.snap @@ -0,0 +1,76 @@ +--- +source: crates/ruff_linter/src/rules/pydoclint/mod.rs +--- +DOC201_google.py:3:5: DOC201 `return` is not documented in docstring + | +1 | # DOC201 +2 | def foo(num: int) -> str: +3 | / """ +4 | | Do something +5 | | +6 | | Args: +7 | | num (int): A number +8 | | """ + | |_______^ DOC201 +9 | return 'test' + | + = help: Add a "Returns" section to the docstring + +DOC201_google.py:44:9: DOC201 `return` is not documented in docstring + | +42 | # DOC201 +43 | def bar(self) -> str: +44 | / """ +45 | | Do something +46 | | +47 | | Args: +48 | | num (int): A number +49 | | """ + | |___________^ DOC201 +50 | return 'test' + | + = help: Add a "Returns" section to the docstring + +DOC201_google.py:178:5: DOC201 `return` is not documented in docstring + | +176 | # DOC201 - non-early return explicit None +177 | def foo(x: int) -> int | None: +178 | / """A very helpful docstring. +179 | | +180 | | Args: +181 | | x (int): An integer. +182 | | """ + | |_______^ DOC201 +183 | if x < 0: +184 | return None + | + = help: Add a "Returns" section to the docstring + +DOC201_google.py:191:5: DOC201 `return` is not documented in docstring + | +189 | # DOC201 - non-early return explicit None w/o useful type annotations +190 | def foo(x): +191 | / """A very helpful docstring. +192 | | +193 | | Args: +194 | | x (int): An integer. +195 | | """ + | |_______^ DOC201 +196 | if x < 0: +197 | return None + | + = help: Add a "Returns" section to the docstring + +DOC201_google.py:204:5: DOC201 `return` is not documented in docstring + | +202 | # DOC201 - only returns None, but return annotation is not None +203 | def foo(s: str) -> str | None: +204 | / """A very helpful docstring. +205 | | +206 | | Args: +207 | | s (str): A string. +208 | | """ + | |_______^ DOC201 +209 | return None + | + = help: Add a "Returns" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_numpy.py.snap index 37429d74f9b7d..b1b707127557c 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-returns_DOC201_numpy.py.snap @@ -1,96 +1,138 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC201_numpy.py:11:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:3:5: DOC201 `return` is not documented in docstring | - 9 | A number -10 | """ -11 | return 'test' - | ^^^^^^^^^^^^^ DOC201 + 1 | # DOC201 + 2 | def foo(num: int) -> str: + 3 | / """ + 4 | | Do something + 5 | | + 6 | | Parameters + 7 | | ---------- + 8 | | num : int + 9 | | A number +10 | | """ + | |_______^ DOC201 +11 | return 'test' | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:62:9: DOC201 `return` is not documented in docstring +DOC201_numpy.py:54:9: DOC201 `return` is not documented in docstring | -60 | A number -61 | """ -62 | return 'test' - | ^^^^^^^^^^^^^ DOC201 +52 | # DOC201 +53 | def bar(self) -> str: +54 | / """ +55 | | Do something +56 | | +57 | | Parameters +58 | | ---------- +59 | | num : int +60 | | A number +61 | | """ + | |___________^ DOC201 +62 | return 'test' | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:87:9: DOC201 `return` is not documented in docstring +DOC201_numpy.py:86:9: DOC201 `return` is not documented in docstring | +84 | @abc.abstractmethod 85 | def f(self): 86 | """Lorem ipsum.""" + | ^^^^^^^^^^^^^^^^^^ DOC201 87 | return True - | ^^^^^^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:160:9: DOC201 `return` is not documented in docstring +DOC201_numpy.py:152:5: DOC201 `return` is not documented in docstring | -158 | """ -159 | if x < 0: -160 | return None - | ^^^^^^^^^^^ DOC201 -161 | else: -162 | return x +150 | # DOC201 - non-early return explicit None +151 | def foo(x: int) -> int | None: +152 | / """A very helpful docstring. +153 | | +154 | | Parameters +155 | | ---------- +156 | | x : int +157 | | An integer. +158 | | """ + | |_______^ DOC201 +159 | if x < 0: +160 | return None | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:175:9: DOC201 `return` is not documented in docstring +DOC201_numpy.py:167:5: DOC201 `return` is not documented in docstring | -173 | """ -174 | if x < 0: -175 | return None - | ^^^^^^^^^^^ DOC201 -176 | else: -177 | return x +165 | # DOC201 - non-early return explicit None w/o useful type annotations +166 | def foo(x): +167 | / """A very helpful docstring. +168 | | +169 | | Parameters +170 | | ---------- +171 | | x : int +172 | | An integer. +173 | | """ + | |_______^ DOC201 +174 | if x < 0: +175 | return None | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:189:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:182:5: DOC201 `return` is not documented in docstring | -187 | A string. -188 | """ -189 | return None - | ^^^^^^^^^^^ DOC201 +180 | # DOC201 - only returns None, but return annotation is not None +181 | def foo(s: str) -> str | None: +182 | / """A very helpful docstring. +183 | | +184 | | Parameters +185 | | ---------- +186 | | x : str +187 | | A string. +188 | | """ + | |_______^ DOC201 +189 | return None | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:195:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:194:5: DOC201 `return` is not documented in docstring | +192 | # DOC201 193 | def bar() -> int | None: 194 | """Bar-y method""" + | ^^^^^^^^^^^^^^^^^^ DOC201 195 | return - | ^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:222:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:220:5: DOC201 `return` is not documented in docstring | +218 | # indicates it could sometimes return `int` +219 | def generator_function_3() -> Generator[str, None, int | None]: 220 | """Generate some strings""" + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC201 221 | yield from "abc" 222 | return - | ^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:230:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:228:5: DOC201 `return` is not documented in docstring | +226 | # indicates it could sometimes return `int` +227 | def generator_function_4(): 228 | """Generate some strings""" + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC201 229 | yield from "abc" 230 | return 42 - | ^^^^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring -DOC201_numpy.py:236:5: DOC201 `return` is not documented in docstring +DOC201_numpy.py:235:5: DOC201 `return` is not documented in docstring | +233 | # DOC201 -- no `yield` expressions, so not a generator function 234 | def not_a_generator() -> Iterator[int]: 235 | """"No returns documented here, oh no""" + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC201 236 | return (x for x in range(42)) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC201 | = help: Add a "Returns" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py.snap index c3748cc435085..0f1e8d89884e9 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py.snap @@ -1,58 +1,76 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC402_google.py:9:5: DOC402 `yield` is not documented in docstring +DOC402_google.py:3:5: DOC402 `yield` is not documented in docstring | -7 | num (int): A number -8 | """ -9 | yield 'test' - | ^^^^^^^^^^^^ DOC402 +1 | # DOC402 +2 | def foo(num: int) -> str: +3 | / """ +4 | | Do something +5 | | +6 | | Args: +7 | | num (int): A number +8 | | """ + | |_______^ DOC402 +9 | yield 'test' | = help: Add a "Yields" section to the docstring -DOC402_google.py:50:9: DOC402 `yield` is not documented in docstring +DOC402_google.py:44:9: DOC402 `yield` is not documented in docstring | -48 | num (int): A number -49 | """ -50 | yield 'test' - | ^^^^^^^^^^^^ DOC402 +42 | # DOC402 +43 | def bar(self) -> str: +44 | / """ +45 | | Do something +46 | | +47 | | Args: +48 | | num (int): A number +49 | | """ + | |___________^ DOC402 +50 | yield 'test' | = help: Add a "Yields" section to the docstring -DOC402_google.py:59:9: DOC402 `yield` is not documented in docstring +DOC402_google.py:58:9: DOC402 `yield` is not documented in docstring | +56 | # DOC402 57 | def nested(): 58 | """Do something nested.""" + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ DOC402 59 | yield 5 - | ^^^^^^^ DOC402 -60 | -61 | print("I never yield") | = help: Add a "Yields" section to the docstring -DOC402_google.py:67:5: DOC402 `yield` is not documented in docstring +DOC402_google.py:66:5: DOC402 `yield` is not documented in docstring | +64 | # DOC402 65 | def test(): 66 | """Do something.""" + | ^^^^^^^^^^^^^^^^^^^ DOC402 67 | yield from range(10) - | ^^^^^^^^^^^^^^^^^^^^ DOC402 | = help: Add a "Yields" section to the docstring -DOC402_google.py:100:5: DOC402 `yield` is not documented in docstring +DOC402_google.py:97:5: DOC402 `yield` is not documented in docstring | - 98 | Do something - 99 | """ -100 | yield - | ^^^^^ DOC402 + 95 | # DOC402 + 96 | def foo() -> collections.abc.Generator[int | None, None, None]: + 97 | / """ + 98 | | Do something + 99 | | """ + | |_______^ DOC402 +100 | yield | = help: Add a "Yields" section to the docstring -DOC402_google.py:108:5: DOC402 `yield` is not documented in docstring +DOC402_google.py:105:5: DOC402 `yield` is not documented in docstring | -106 | Do something -107 | """ -108 | yield - | ^^^^^ DOC402 +103 | # DOC402 +104 | def bar() -> collections.abc.Iterator[int | None]: +105 | / """ +106 | | Do something +107 | | """ + | |_______^ DOC402 +108 | yield | = help: Add a "Yields" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py_ignore_one_line.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py_ignore_one_line.snap new file mode 100644 index 0000000000000..def7f04c9dc59 --- /dev/null +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_google.py_ignore_one_line.snap @@ -0,0 +1,32 @@ +--- +source: crates/ruff_linter/src/rules/pydoclint/mod.rs +--- +DOC402_google.py:3:5: DOC402 `yield` is not documented in docstring + | +1 | # DOC402 +2 | def foo(num: int) -> str: +3 | / """ +4 | | Do something +5 | | +6 | | Args: +7 | | num (int): A number +8 | | """ + | |_______^ DOC402 +9 | yield 'test' + | + = help: Add a "Yields" section to the docstring + +DOC402_google.py:44:9: DOC402 `yield` is not documented in docstring + | +42 | # DOC402 +43 | def bar(self) -> str: +44 | / """ +45 | | Do something +46 | | +47 | | Args: +48 | | num (int): A number +49 | | """ + | |___________^ DOC402 +50 | yield 'test' + | + = help: Add a "Yields" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_numpy.py.snap b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_numpy.py.snap index fdf4e18cef230..6089267205b36 100644 --- a/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_numpy.py.snap +++ b/crates/ruff_linter/src/rules/pydoclint/snapshots/ruff_linter__rules__pydoclint__tests__docstring-missing-yields_DOC402_numpy.py.snap @@ -1,68 +1,99 @@ --- source: crates/ruff_linter/src/rules/pydoclint/mod.rs --- -DOC402_numpy.py:11:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:3:5: DOC402 `yield` is not documented in docstring | - 9 | A number -10 | """ -11 | yield 'test' - | ^^^^^^^^^^^^ DOC402 + 1 | # DOC402 + 2 | def foo(num: int) -> str: + 3 | / """ + 4 | | Do something + 5 | | + 6 | | Parameters + 7 | | ---------- + 8 | | num : int + 9 | | A number +10 | | """ + | |_______^ DOC402 +11 | yield 'test' | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:62:9: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:54:9: DOC402 `yield` is not documented in docstring | -60 | A number -61 | """ -62 | yield 'test' - | ^^^^^^^^^^^^ DOC402 +52 | # DOC402 +53 | def bar(self) -> str: +54 | / """ +55 | | Do something +56 | | +57 | | Parameters +58 | | ---------- +59 | | num : int +60 | | A number +61 | | """ + | |___________^ DOC402 +62 | yield 'test' | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:89:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:86:5: DOC402 `yield` is not documented in docstring | -87 | Do something -88 | """ -89 | yield None - | ^^^^^^^^^^ DOC402 -90 | yield 1 +84 | # DOC402 +85 | def foo() -> typing.Generator[int | None, None, None]: +86 | / """ +87 | | Do something +88 | | """ + | |_______^ DOC402 +89 | yield None +90 | yield 1 | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:98:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:95:5: DOC402 `yield` is not documented in docstring | -96 | Do something -97 | """ -98 | yield None - | ^^^^^^^^^^ DOC402 +93 | # DOC402 +94 | def foo() -> typing.Generator[int, None, None]: +95 | / """ +96 | | Do something +97 | | """ + | |_______^ DOC402 +98 | yield None | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:122:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:119:5: DOC402 `yield` is not documented in docstring | -120 | Do something -121 | """ -122 | yield None - | ^^^^^^^^^^ DOC402 -123 | yield 1 +117 | # DOC402 +118 | def foo(): +119 | / """ +120 | | Do something +121 | | """ + | |_______^ DOC402 +122 | yield None +123 | yield 1 | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:131:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:128:5: DOC402 `yield` is not documented in docstring | -129 | Do something -130 | """ -131 | yield 1 - | ^^^^^^^ DOC402 -132 | yield +126 | # DOC402 +127 | def foo(): +128 | / """ +129 | | Do something +130 | | """ + | |_______^ DOC402 +131 | yield 1 +132 | yield | = help: Add a "Yields" section to the docstring -DOC402_numpy.py:140:5: DOC402 `yield` is not documented in docstring +DOC402_numpy.py:137:5: DOC402 `yield` is not documented in docstring | -138 | Do something -139 | """ -140 | yield - | ^^^^^ DOC402 +135 | # DOC402 +136 | def bar() -> typing.Iterator[int | None]: +137 | / """ +138 | | Do something +139 | | """ + | |_______^ DOC402 +140 | yield | = help: Add a "Yields" section to the docstring diff --git a/crates/ruff_linter/src/rules/pydocstyle/helpers.rs b/crates/ruff_linter/src/rules/pydocstyle/helpers.rs index d802afcc69d5c..fc785ac14eb65 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/helpers.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/helpers.rs @@ -6,9 +6,9 @@ use ruff_python_trivia::Cursor; use ruff_source_file::{Line, UniversalNewlines}; use ruff_text_size::{TextRange, TextSize}; +use crate::docstrings::Docstring; use crate::docstrings::sections::{SectionContexts, SectionKind}; use crate::docstrings::styles::SectionStyle; -use crate::docstrings::Docstring; use crate::rules::pydocstyle::settings::{Convention, Settings}; /// Return the index of the first logical line in a string. @@ -76,11 +76,9 @@ pub(crate) fn get_section_contexts<'a>( ) -> SectionContexts<'a> { match convention { Some(Convention::Google) => { - return SectionContexts::from_docstring(docstring, SectionStyle::Google); - } - Some(Convention::Numpy) => { - return SectionContexts::from_docstring(docstring, SectionStyle::Numpy); + SectionContexts::from_docstring(docstring, SectionStyle::Google) } + Some(Convention::Numpy) => SectionContexts::from_docstring(docstring, SectionStyle::Numpy), Some(Convention::Pep257) | None => { // There are some overlapping section names, between the Google and NumPy conventions // (e.g., "Returns", "Raises"). Break ties by checking for the presence of some of the @@ -121,7 +119,7 @@ pub(crate) fn get_section_contexts<'a>( Ordering::Greater => return google_sections, Ordering::Less => return numpy_sections, Ordering::Equal => {} - }; + } // 0 sections of either convention? Default to numpy if google_sections.len() == 0 { diff --git a/crates/ruff_linter/src/rules/pydocstyle/mod.rs b/crates/ruff_linter/src/rules/pydocstyle/mod.rs index 9f387fdebb087..08731c7868c55 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/mod.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/mod.rs @@ -12,46 +12,45 @@ mod tests { use crate::registry::Rule; + use super::settings::{Convention, Settings}; use crate::test::test_path; use crate::{assert_messages, settings}; - use super::settings::{Convention, Settings}; - - #[test_case(Rule::BlankLineAfterLastSection, Path::new("sections.py"))] + #[test_case(Rule::MissingBlankLineAfterLastSection, Path::new("sections.py"))] #[test_case(Rule::NoBlankLineAfterSection, Path::new("sections.py"))] - #[test_case(Rule::BlankLineAfterLastSection, Path::new("D413.py"))] - #[test_case(Rule::BlankLineAfterSummary, Path::new("D.py"))] + #[test_case(Rule::MissingBlankLineAfterLastSection, Path::new("D413.py"))] + #[test_case(Rule::MissingBlankLineAfterSummary, Path::new("D.py"))] #[test_case(Rule::NoBlankLineBeforeSection, Path::new("sections.py"))] - #[test_case(Rule::CapitalizeSectionName, Path::new("sections.py"))] - #[test_case(Rule::DashedUnderlineAfterSection, Path::new("sections.py"))] + #[test_case(Rule::NonCapitalizedSectionName, Path::new("sections.py"))] + #[test_case(Rule::MissingDashedUnderlineAfterSection, Path::new("sections.py"))] #[test_case(Rule::UndocumentedParam, Path::new("canonical_google_examples.py"))] #[test_case(Rule::UndocumentedParam, Path::new("canonical_numpy_examples.py"))] #[test_case(Rule::UndocumentedParam, Path::new("sections.py"))] - #[test_case(Rule::EndsInPeriod, Path::new("D.py"))] - #[test_case(Rule::EndsInPeriod, Path::new("D400.py"))] - #[test_case(Rule::EndsInPeriod, Path::new("D400_415.py"))] - #[test_case(Rule::EndsInPunctuation, Path::new("D.py"))] - #[test_case(Rule::EndsInPunctuation, Path::new("D400_415.py"))] - #[test_case(Rule::FirstLineCapitalized, Path::new("D.py"))] - #[test_case(Rule::FirstLineCapitalized, Path::new("D403.py"))] - #[test_case(Rule::FitsOnOneLine, Path::new("D.py"))] - #[test_case(Rule::IndentWithSpaces, Path::new("D.py"))] + #[test_case(Rule::MissingTrailingPeriod, Path::new("D.py"))] + #[test_case(Rule::MissingTrailingPeriod, Path::new("D400.py"))] + #[test_case(Rule::MissingTrailingPeriod, Path::new("D400_415.py"))] + #[test_case(Rule::MissingTerminalPunctuation, Path::new("D.py"))] + #[test_case(Rule::MissingTerminalPunctuation, Path::new("D400_415.py"))] + #[test_case(Rule::FirstWordUncapitalized, Path::new("D.py"))] + #[test_case(Rule::FirstWordUncapitalized, Path::new("D403.py"))] + #[test_case(Rule::UnnecessaryMultilineDocstring, Path::new("D.py"))] + #[test_case(Rule::DocstringTabIndentation, Path::new("D.py"))] #[test_case(Rule::UndocumentedMagicMethod, Path::new("D.py"))] #[test_case(Rule::MultiLineSummaryFirstLine, Path::new("D.py"))] #[test_case(Rule::MultiLineSummarySecondLine, Path::new("D.py"))] #[test_case(Rule::NewLineAfterLastParagraph, Path::new("D.py"))] - #[test_case(Rule::NewLineAfterSectionName, Path::new("sections.py"))] - #[test_case(Rule::NoBlankLineAfterFunction, Path::new("D.py"))] - #[test_case(Rule::FitsOnOneLine, Path::new("D200.py"))] - #[test_case(Rule::NoBlankLineAfterFunction, Path::new("D202.py"))] + #[test_case(Rule::MissingNewLineAfterSectionName, Path::new("sections.py"))] + #[test_case(Rule::BlankLineAfterFunction, Path::new("D.py"))] + #[test_case(Rule::UnnecessaryMultilineDocstring, Path::new("D200.py"))] + #[test_case(Rule::BlankLineAfterFunction, Path::new("D202.py"))] #[test_case(Rule::BlankLineBeforeClass, Path::new("D.py"))] - #[test_case(Rule::NoBlankLineBeforeFunction, Path::new("D.py"))] + #[test_case(Rule::BlankLineBeforeFunction, Path::new("D.py"))] #[test_case(Rule::BlankLinesBetweenHeaderAndContent, Path::new("sections.py"))] #[test_case(Rule::BlankLinesBetweenHeaderAndContent, Path::new("sphinx.py"))] #[test_case(Rule::OverIndentation, Path::new("D.py"))] #[test_case(Rule::OverIndentation, Path::new("D208.py"))] - #[test_case(Rule::NoSignature, Path::new("D.py"))] - #[test_case(Rule::NoSignature, Path::new("D402.py"))] + #[test_case(Rule::SignatureInDocstring, Path::new("D.py"))] + #[test_case(Rule::SignatureInDocstring, Path::new("D402.py"))] #[test_case(Rule::SurroundingWhitespace, Path::new("D.py"))] #[test_case(Rule::DocstringStartsWithThis, Path::new("D.py"))] #[test_case(Rule::UnderIndentation, Path::new("D.py"))] @@ -59,8 +58,8 @@ mod tests { #[test_case(Rule::EmptyDocstringSection, Path::new("sections.py"))] #[test_case(Rule::NonImperativeMood, Path::new("D401.py"))] #[test_case(Rule::NoBlankLineAfterSection, Path::new("D410.py"))] - #[test_case(Rule::OneBlankLineAfterClass, Path::new("D.py"))] - #[test_case(Rule::OneBlankLineBeforeClass, Path::new("D.py"))] + #[test_case(Rule::IncorrectBlankLineAfterClass, Path::new("D.py"))] + #[test_case(Rule::IncorrectBlankLineBeforeClass, Path::new("D.py"))] #[test_case(Rule::UndocumentedPublicClass, Path::new("D.py"))] #[test_case(Rule::UndocumentedPublicFunction, Path::new("D.py"))] #[test_case(Rule::UndocumentedPublicInit, Path::new("D.py"))] @@ -83,13 +82,13 @@ mod tests { #[test_case(Rule::UndocumentedPublicNestedClass, Path::new("D.py"))] #[test_case(Rule::UndocumentedPublicPackage, Path::new("D.py"))] #[test_case(Rule::UndocumentedPublicPackage, Path::new("D104/__init__.py"))] - #[test_case(Rule::SectionNameEndsInColon, Path::new("D.py"))] - #[test_case(Rule::SectionNotOverIndented, Path::new("sections.py"))] - #[test_case(Rule::SectionNotOverIndented, Path::new("D214_module.py"))] - #[test_case(Rule::SectionUnderlineNotOverIndented, Path::new("D215.py"))] - #[test_case(Rule::SectionUnderlineAfterName, Path::new("sections.py"))] - #[test_case(Rule::SectionUnderlineMatchesSectionLength, Path::new("sections.py"))] - #[test_case(Rule::SectionUnderlineNotOverIndented, Path::new("sections.py"))] + #[test_case(Rule::MissingSectionNameColon, Path::new("D.py"))] + #[test_case(Rule::OverindentedSection, Path::new("sections.py"))] + #[test_case(Rule::OverindentedSection, Path::new("D214_module.py"))] + #[test_case(Rule::OverindentedSectionUnderline, Path::new("D215.py"))] + #[test_case(Rule::MissingSectionUnderlineAfterName, Path::new("sections.py"))] + #[test_case(Rule::MismatchedSectionUnderlineLength, Path::new("sections.py"))] + #[test_case(Rule::OverindentedSectionUnderline, Path::new("sections.py"))] #[test_case(Rule::OverloadWithDocstring, Path::new("D.py"))] #[test_case(Rule::EscapeSequenceInDocstring, Path::new("D.py"))] #[test_case(Rule::EscapeSequenceInDocstring, Path::new("D301.py"))] @@ -100,11 +99,13 @@ mod tests { let diagnostics = test_path( Path::new("pydocstyle").join(path).as_path(), &settings::LinterSettings { - pydocstyle: Settings::new( - None, - ["functools.wraps".to_string()], - ["gi.repository.GObject.Property".to_string()], - ), + pydocstyle: Settings { + ignore_decorators: ["functools.wraps".to_string()].into_iter().collect(), + property_decorators: ["gi.repository.GObject.Property".to_string()] + .into_iter() + .collect(), + ..Settings::default() + }, ..settings::LinterSettings::for_rule(rule_code) }, )?; @@ -137,13 +138,46 @@ mod tests { Ok(()) } + #[test] + fn d417_unspecified_ignore_var_parameters() -> Result<()> { + let diagnostics = test_path( + Path::new("pydocstyle/D417.py"), + &settings::LinterSettings { + pydocstyle: Settings::default(), + ..settings::LinterSettings::for_rule(Rule::UndocumentedParam) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } + #[test] fn d417_google() -> Result<()> { let diagnostics = test_path( Path::new("pydocstyle/D417.py"), &settings::LinterSettings { // With explicit Google convention, we should flag every function. - pydocstyle: Settings::new(Some(Convention::Google), [], []), + pydocstyle: Settings { + convention: Some(Convention::Google), + ..Settings::default() + }, + ..settings::LinterSettings::for_rule(Rule::UndocumentedParam) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } + + #[test] + fn d417_google_ignore_var_parameters() -> Result<()> { + let diagnostics = test_path( + Path::new("pydocstyle/D417.py"), + &settings::LinterSettings { + pydocstyle: Settings { + convention: Some(Convention::Google), + ignore_var_parameters: true, + ..Settings::default() + }, ..settings::LinterSettings::for_rule(Rule::UndocumentedParam) }, )?; @@ -157,7 +191,10 @@ mod tests { Path::new("pydocstyle/D417.py"), &settings::LinterSettings { // With explicit numpy convention, we shouldn't flag anything. - pydocstyle: Settings::new(Some(Convention::Numpy), [], []), + pydocstyle: Settings { + convention: Some(Convention::Numpy), + ..Settings::default() + }, ..settings::LinterSettings::for_rule(Rule::UndocumentedParam) }, )?; @@ -171,7 +208,7 @@ mod tests { Path::new("pydocstyle/D209_D400.py"), &settings::LinterSettings::for_rules([ Rule::NewLineAfterLastParagraph, - Rule::EndsInPeriod, + Rule::MissingTrailingPeriod, ]), )?; assert_messages!(diagnostics); diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/backslashes.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/backslashes.rs index 46cf52b63deea..9c322699a101e 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/backslashes.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/backslashes.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -41,26 +41,25 @@ use crate::docstrings::Docstring; /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [Python documentation: String and Bytes literals](https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals) -#[violation] -pub struct EscapeSequenceInDocstring; +#[derive(ViolationMetadata)] +pub(crate) struct EscapeSequenceInDocstring; impl Violation for EscapeSequenceInDocstring { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!(r#"Use `r"""` if any backslashes in a docstring"#) + r#"Use `r"""` if any backslashes in a docstring"#.to_string() } fn fix_title(&self) -> Option<String> { - Some(format!(r#"Add `r` prefix"#)) + Some(r#"Add `r` prefix"#.to_string()) } } /// D301 -pub(crate) fn backslashes(checker: &mut Checker, docstring: &Docstring) { - // Docstring is already raw. - if docstring.leading_quote().contains(['r', 'R']) { +pub(crate) fn backslashes(checker: &Checker, docstring: &Docstring) { + if docstring.is_raw_string() { return; } @@ -99,14 +98,14 @@ pub(crate) fn backslashes(checker: &mut Checker, docstring: &Docstring) { if !matches!(*escaped_char, '\r' | '\n' | 'u' | 'U' | 'N') { let mut diagnostic = Diagnostic::new(EscapeSequenceInDocstring, docstring.range()); - if !docstring.leading_quote().contains(['u', 'U']) { - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - "r".to_owned() + docstring.contents, - docstring.range(), + if !docstring.is_u_string() { + diagnostic.set_fix(Fix::unsafe_edit(Edit::insertion( + "r".to_string(), + docstring.start(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); break; } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_after_summary.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_after_summary.rs index bbd9ee0ab6302..c39977a46ebf8 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_after_summary.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_after_summary.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::{UniversalNewlineIterator, UniversalNewlines}; use ruff_text_size::Ranged; @@ -40,19 +40,19 @@ use crate::docstrings::Docstring; /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct BlankLineAfterSummary { +#[derive(ViolationMetadata)] +pub(crate) struct MissingBlankLineAfterSummary { num_lines: usize, } -impl Violation for BlankLineAfterSummary { +impl Violation for MissingBlankLineAfterSummary { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - let BlankLineAfterSummary { num_lines } = self; + let MissingBlankLineAfterSummary { num_lines } = self; if *num_lines == 0 { - format!("1 blank line required between summary line and description") + "1 blank line required between summary line and description".to_string() } else { format!( "1 blank line required between summary line and description (found {num_lines})" @@ -66,10 +66,10 @@ impl Violation for BlankLineAfterSummary { } /// D205 -pub(crate) fn blank_after_summary(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn blank_after_summary(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); - if !docstring.triple_quoted() { + if !docstring.is_triple_quoted() { return; } @@ -85,7 +85,7 @@ pub(crate) fn blank_after_summary(checker: &mut Checker, docstring: &Docstring) } if lines_count > 1 && blanks_count != 1 { let mut diagnostic = Diagnostic::new( - BlankLineAfterSummary { + MissingBlankLineAfterSummary { num_lines: blanks_count, }, docstring.range(), @@ -118,6 +118,6 @@ pub(crate) fn blank_after_summary(checker: &mut Checker, docstring: &Docstring) blank_end, ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_class.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_class.rs index 1c9057550d419..b2a1d5ac45c3f 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_class.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_class.rs @@ -1,9 +1,9 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_trivia::{indentation_at_offset, PythonWhitespace}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_trivia::{PythonWhitespace, indentation_at_offset}; use ruff_source_file::{Line, LineRanges, UniversalNewlineIterator}; use ruff_text_size::Ranged; -use ruff_text_size::{TextLen, TextRange}; +use ruff_text_size::TextRange; use crate::checkers::ast::Checker; use crate::docstrings::Docstring; @@ -42,13 +42,13 @@ use crate::registry::Rule; /// - `lint.pydocstyle.convention` /// /// [D211]: https://docs.astral.sh/ruff/rules/blank-line-before-class -#[violation] -pub struct OneBlankLineBeforeClass; +#[derive(ViolationMetadata)] +pub(crate) struct IncorrectBlankLineBeforeClass; -impl AlwaysFixableViolation for OneBlankLineBeforeClass { +impl AlwaysFixableViolation for IncorrectBlankLineBeforeClass { #[derive_message_formats] fn message(&self) -> String { - format!("1 blank line required before class docstring") + "1 blank line required before class docstring".to_string() } fn fix_title(&self) -> String { @@ -94,13 +94,13 @@ impl AlwaysFixableViolation for OneBlankLineBeforeClass { /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct OneBlankLineAfterClass; +#[derive(ViolationMetadata)] +pub(crate) struct IncorrectBlankLineAfterClass; -impl AlwaysFixableViolation for OneBlankLineAfterClass { +impl AlwaysFixableViolation for IncorrectBlankLineAfterClass { #[derive_message_formats] fn message(&self) -> String { - format!("1 blank line required after class docstring") + "1 blank line required after class docstring".to_string() } fn fix_title(&self) -> String { @@ -140,14 +140,14 @@ impl AlwaysFixableViolation for OneBlankLineAfterClass { /// ## Options /// - `lint.pydocstyle.convention` /// -/// [D203]: https://docs.astral.sh/ruff/rules/one-blank-line-before-class -#[violation] -pub struct BlankLineBeforeClass; +/// [D203]: https://docs.astral.sh/ruff/rules/incorrect-blank-line-before-class +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineBeforeClass; impl AlwaysFixableViolation for BlankLineBeforeClass { #[derive_message_formats] fn message(&self) -> String { - format!("No blank lines allowed before class docstring") + "No blank lines allowed before class docstring".to_string() } fn fix_title(&self) -> String { @@ -156,7 +156,7 @@ impl AlwaysFixableViolation for BlankLineBeforeClass { } /// D203, D204, D211 -pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn blank_before_after_class(checker: &Checker, docstring: &Docstring) { let Some(class) = docstring.definition.as_class_def() else { return; }; @@ -170,7 +170,8 @@ pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstr return; } - if checker.enabled(Rule::OneBlankLineBeforeClass) || checker.enabled(Rule::BlankLineBeforeClass) + if checker.enabled(Rule::IncorrectBlankLineBeforeClass) + || checker.enabled(Rule::BlankLineBeforeClass) { let mut lines = UniversalNewlineIterator::with_offset( checker.locator().slice(between_range), @@ -196,26 +197,27 @@ pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstr // Delete the blank line before the class. diagnostic.set_fix(Fix::safe_edit(Edit::deletion( blank_lines_start, - docstring.start() - docstring.indentation.text_len(), + docstring.line_start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - if checker.enabled(Rule::OneBlankLineBeforeClass) { + if checker.enabled(Rule::IncorrectBlankLineBeforeClass) { if blank_lines_before != 1 { - let mut diagnostic = Diagnostic::new(OneBlankLineBeforeClass, docstring.range()); + let mut diagnostic = + Diagnostic::new(IncorrectBlankLineBeforeClass, docstring.range()); // Insert one blank line before the class. diagnostic.set_fix(Fix::safe_edit(Edit::replacement( checker.stylist().line_ending().to_string(), blank_lines_start, - docstring.start() - docstring.indentation.text_len(), + docstring.line_start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } - if checker.enabled(Rule::OneBlankLineAfterClass) { + if checker.enabled(Rule::IncorrectBlankLineAfterClass) { let class_after_docstring_range = TextRange::new(docstring.end(), class.end()); let class_after_docstring = checker.locator().slice(class_after_docstring_range); let mut lines = UniversalNewlineIterator::with_offset( @@ -242,7 +244,8 @@ pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstr if let Some(next_statement) = trailing.strip_prefix(';') { let indentation = indentation_at_offset(docstring.start(), checker.source()) .expect("Own line docstring must have indentation"); - let mut diagnostic = Diagnostic::new(OneBlankLineAfterClass, docstring.range()); + let mut diagnostic = + Diagnostic::new(IncorrectBlankLineAfterClass, docstring.range()); let line_ending = checker.stylist().line_ending().as_str(); // We have to trim the whitespace twice, once before the semicolon above and // once after the semicolon here, or we get invalid indents: @@ -256,7 +259,7 @@ pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstr replacement_start, first_line.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); return; } else if trailing.starts_with('#') { // Keep the end-of-line comment, start counting empty lines after it @@ -277,14 +280,14 @@ pub(crate) fn blank_before_after_class(checker: &mut Checker, docstring: &Docstr } if blank_lines_after != 1 { - let mut diagnostic = Diagnostic::new(OneBlankLineAfterClass, docstring.range()); + let mut diagnostic = Diagnostic::new(IncorrectBlankLineAfterClass, docstring.range()); // Insert a blank line before the class (replacing any existing lines). diagnostic.set_fix(Fix::safe_edit(Edit::replacement( checker.stylist().line_ending().to_string(), replacement_start, blank_lines_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_function.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_function.rs index 11027c562dee3..a5f0d10cbb1f6 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_function.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_function.rs @@ -2,11 +2,11 @@ use regex::Regex; use std::sync::LazyLock; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::PythonWhitespace; use ruff_source_file::{UniversalNewlineIterator, UniversalNewlines}; use ruff_text_size::Ranged; -use ruff_text_size::{TextLen, TextRange}; +use ruff_text_size::TextRange; use crate::checkers::ast::Checker; use crate::docstrings::Docstring; @@ -37,15 +37,15 @@ use crate::registry::Rule; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct NoBlankLineBeforeFunction { +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineBeforeFunction { num_lines: usize, } -impl AlwaysFixableViolation for NoBlankLineBeforeFunction { +impl AlwaysFixableViolation for BlankLineBeforeFunction { #[derive_message_formats] fn message(&self) -> String { - let NoBlankLineBeforeFunction { num_lines } = self; + let BlankLineBeforeFunction { num_lines } = self; format!("No blank lines allowed before function docstring (found {num_lines})") } @@ -81,15 +81,15 @@ impl AlwaysFixableViolation for NoBlankLineBeforeFunction { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct NoBlankLineAfterFunction { +#[derive(ViolationMetadata)] +pub(crate) struct BlankLineAfterFunction { num_lines: usize, } -impl AlwaysFixableViolation for NoBlankLineAfterFunction { +impl AlwaysFixableViolation for BlankLineAfterFunction { #[derive_message_formats] fn message(&self) -> String { - let NoBlankLineAfterFunction { num_lines } = self; + let BlankLineAfterFunction { num_lines } = self; format!("No blank lines allowed after function docstring (found {num_lines})") } @@ -102,12 +102,12 @@ static INNER_FUNCTION_OR_CLASS_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^\s+(?:(?:class|def|async def)\s|@)").unwrap()); /// D201, D202 -pub(crate) fn blank_before_after_function(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn blank_before_after_function(checker: &Checker, docstring: &Docstring) { let Some(function) = docstring.definition.as_function_def() else { return; }; - if checker.enabled(Rule::NoBlankLineBeforeFunction) { + if checker.enabled(Rule::BlankLineBeforeFunction) { let before = checker .locator() .slice(TextRange::new(function.start(), docstring.start())); @@ -127,7 +127,7 @@ pub(crate) fn blank_before_after_function(checker: &mut Checker, docstring: &Doc if blank_lines_before != 0 { let mut diagnostic = Diagnostic::new( - NoBlankLineBeforeFunction { + BlankLineBeforeFunction { num_lines: blank_lines_before, }, docstring.range(), @@ -135,13 +135,13 @@ pub(crate) fn blank_before_after_function(checker: &mut Checker, docstring: &Doc // Delete the blank line before the docstring. diagnostic.set_fix(Fix::safe_edit(Edit::deletion( blank_lines_start, - docstring.start() - docstring.indentation.text_len(), + docstring.line_start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - if checker.enabled(Rule::NoBlankLineAfterFunction) { + if checker.enabled(Rule::BlankLineAfterFunction) { let after = checker .locator() .slice(TextRange::new(docstring.end(), function.end())); @@ -181,7 +181,7 @@ pub(crate) fn blank_before_after_function(checker: &mut Checker, docstring: &Doc if blank_lines_after != 0 { let mut diagnostic = Diagnostic::new( - NoBlankLineAfterFunction { + BlankLineAfterFunction { num_lines: blank_lines_after, }, docstring.range(), @@ -191,7 +191,7 @@ pub(crate) fn blank_before_after_function(checker: &mut Checker, docstring: &Doc first_line_end, blank_lines_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/capitalized.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/capitalized.rs index 88f02716764d0..b8144df8c5a61 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/capitalized.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/capitalized.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use ruff_text_size::{TextLen, TextRange}; @@ -10,8 +10,8 @@ use crate::docstrings::Docstring; /// Checks for docstrings that do not start with a capital letter. /// /// ## Why is this bad? -/// The first character in a docstring should be capitalized for, grammatical -/// correctness and consistency. +/// The first non-whitespace character in a docstring should be +/// capitalized for grammatical correctness and consistency. /// /// ## Example /// ```python @@ -29,17 +29,17 @@ use crate::docstrings::Docstring; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct FirstLineCapitalized { +#[derive(ViolationMetadata)] +pub(crate) struct FirstWordUncapitalized { first_word: String, capitalized_word: String, } -impl AlwaysFixableViolation for FirstLineCapitalized { +impl AlwaysFixableViolation for FirstWordUncapitalized { #[derive_message_formats] fn message(&self) -> String { format!( - "First word of the first line should be capitalized: `{}` -> `{}`", + "First word of the docstring should be capitalized: `{}` -> `{}`", self.first_word, self.capitalized_word ) } @@ -53,20 +53,17 @@ impl AlwaysFixableViolation for FirstLineCapitalized { } /// D403 -pub(crate) fn capitalized(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn capitalized(checker: &Checker, docstring: &Docstring) { if docstring.definition.as_function_def().is_none() { return; } let body = docstring.body(); - let first_word = body.split_once(' ').map_or_else( - || { - // If the docstring is a single word, trim the punctuation marks because - // it makes the ASCII test below fail. - body.trim_end_matches(['.', '!', '?']) - }, - |(first_word, _)| first_word, - ); + let trim_start_body = body.trim_start(); + let first_word = trim_start_body + .find(char::is_whitespace) + .map_or(trim_start_body, |idx| &trim_start_body[..idx]) + .trim_end_matches(['.', '!', '?']); let mut first_word_chars = first_word.chars(); let Some(first_char) = first_word_chars.next() else { @@ -91,8 +88,10 @@ pub(crate) fn capitalized(checker: &mut Checker, docstring: &Docstring) { let capitalized_word = uppercase_first_char.to_string() + first_word_chars.as_str(); + let leading_whitespace_len = body.text_len() - trim_start_body.text_len(); + let mut diagnostic = Diagnostic::new( - FirstLineCapitalized { + FirstWordUncapitalized { first_word: first_word.to_string(), capitalized_word: capitalized_word.to_string(), }, @@ -101,8 +100,8 @@ pub(crate) fn capitalized(checker: &mut Checker, docstring: &Docstring) { diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( capitalized_word, - TextRange::at(body.start(), first_word.text_len()), + TextRange::at(body.start() + leading_whitespace_len, first_word.text_len()), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_period.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_period.rs index 7bf3583cf35c3..8e7ab735dfd83 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_period.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_period.rs @@ -2,13 +2,13 @@ use ruff_text_size::TextLen; use strum::IntoEnumIterator; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::{UniversalNewlineIterator, UniversalNewlines}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::docstrings::sections::SectionKind; use crate::docstrings::Docstring; +use crate::docstrings::sections::SectionKind; use crate::rules::pydocstyle::helpers::logical_line; @@ -44,17 +44,17 @@ use crate::rules::pydocstyle::helpers::logical_line; /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct EndsInPeriod; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTrailingPeriod; -impl Violation for EndsInPeriod { +impl Violation for MissingTrailingPeriod { /// `None` in the case a fix is never available or otherwise Some /// [`FixAvailability`] describing the available fix. const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("First line should end with a period") + "First line should end with a period".to_string() } fn fix_title(&self) -> Option<String> { @@ -63,7 +63,7 @@ impl Violation for EndsInPeriod { } /// D400 -pub(crate) fn ends_with_period(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn ends_with_period(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); if let Some(first_line) = body.trim().universal_newlines().next() { @@ -106,7 +106,7 @@ pub(crate) fn ends_with_period(checker: &mut Checker, docstring: &Docstring) { } if !trimmed.ends_with('.') { - let mut diagnostic = Diagnostic::new(EndsInPeriod, docstring.range()); + let mut diagnostic = Diagnostic::new(MissingTrailingPeriod, docstring.range()); // Best-effort fix: avoid adding a period after other punctuation marks. if !trimmed.ends_with([':', ';', '?', '!']) { diagnostic.set_fix(Fix::unsafe_edit(Edit::insertion( @@ -114,7 +114,7 @@ pub(crate) fn ends_with_period(checker: &mut Checker, docstring: &Docstring) { line.start() + trimmed.text_len(), ))); } - checker.diagnostics.push(diagnostic); - }; + checker.report_diagnostic(diagnostic); + } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_punctuation.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_punctuation.rs index 4b7ae2633e82e..2ed5734c45056 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_punctuation.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/ends_with_punctuation.rs @@ -2,13 +2,13 @@ use ruff_text_size::TextLen; use strum::IntoEnumIterator; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::{UniversalNewlineIterator, UniversalNewlines}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::docstrings::sections::SectionKind; use crate::docstrings::Docstring; +use crate::docstrings::sections::SectionKind; use crate::rules::pydocstyle::helpers::logical_line; @@ -43,17 +43,17 @@ use crate::rules::pydocstyle::helpers::logical_line; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct EndsInPunctuation; +#[derive(ViolationMetadata)] +pub(crate) struct MissingTerminalPunctuation; -impl Violation for EndsInPunctuation { +impl Violation for MissingTerminalPunctuation { /// `None` in the case a fix is never available or otherwise Some /// [`FixAvailability`] describing the available fix. const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("First line should end with a period, question mark, or exclamation point") + "First line should end with a period, question mark, or exclamation point".to_string() } fn fix_title(&self) -> Option<String> { @@ -62,7 +62,7 @@ impl Violation for EndsInPunctuation { } /// D415 -pub(crate) fn ends_with_punctuation(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn ends_with_punctuation(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); if let Some(first_line) = body.trim().universal_newlines().next() { @@ -105,7 +105,7 @@ pub(crate) fn ends_with_punctuation(checker: &mut Checker, docstring: &Docstring } if !trimmed.ends_with(['.', '!', '?']) { - let mut diagnostic = Diagnostic::new(EndsInPunctuation, docstring.range()); + let mut diagnostic = Diagnostic::new(MissingTerminalPunctuation, docstring.range()); // Best-effort fix: avoid adding a period after other punctuation marks. if !trimmed.ends_with([':', ';']) { diagnostic.set_fix(Fix::unsafe_edit(Edit::insertion( @@ -113,7 +113,7 @@ pub(crate) fn ends_with_punctuation(checker: &mut Checker, docstring: &Docstring line.start() + trimmed.text_len(), ))); } - checker.diagnostics.push(diagnostic); - }; + checker.report_diagnostic(diagnostic); + } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/if_needed.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/if_needed.rs index 1138b1d5fab46..2fb93a1f20724 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/if_needed.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/if_needed.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility::is_overload; @@ -66,23 +66,23 @@ use crate::docstrings::Docstring; /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [Python documentation: `typing.overload`](https://docs.python.org/3/library/typing.html#typing.overload) -#[violation] -pub struct OverloadWithDocstring; +#[derive(ViolationMetadata)] +pub(crate) struct OverloadWithDocstring; impl Violation for OverloadWithDocstring { #[derive_message_formats] fn message(&self) -> String { - format!("Function decorated with `@overload` shouldn't contain a docstring") + "Function decorated with `@overload` shouldn't contain a docstring".to_string() } } /// D418 -pub(crate) fn if_needed(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn if_needed(checker: &Checker, docstring: &Docstring) { let Some(function) = docstring.definition.as_function_def() else { return; }; if is_overload(&function.decorator_list, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( OverloadWithDocstring, function.identifier(), )); diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/indent.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/indent.rs index 63c43b770bdf3..c2796b71d72f1 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/indent.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/indent.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::docstrings::{clean_space, leading_space}; use ruff_source_file::{Line, NewlineWithTrailingNewline}; use ruff_text_size::{Ranged, TextSize}; @@ -10,6 +10,7 @@ use crate::checkers::ast::Checker; use crate::docstrings::Docstring; use crate::registry::Rule; +#[expect(clippy::tabs_in_doc_comments)] /// ## What it does /// Checks for docstrings that are indented with tabs. /// @@ -50,13 +51,13 @@ use crate::registry::Rule; /// /// [PEP 8]: https://peps.python.org/pep-0008/#tabs-or-spaces /// [formatter]: https://docs.astral.sh/ruff/formatter -#[violation] -pub struct IndentWithSpaces; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringTabIndentation; -impl Violation for IndentWithSpaces { +impl Violation for DocstringTabIndentation { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring should be indented with spaces, not tabs") + "Docstring should be indented with spaces, not tabs".to_string() } } @@ -98,13 +99,13 @@ impl Violation for IndentWithSpaces { /// /// [PEP 257]: https://peps.python.org/pep-0257/ /// [formatter]: https://docs.astral.sh/ruff/formatter/ -#[violation] -pub struct UnderIndentation; +#[derive(ViolationMetadata)] +pub(crate) struct UnderIndentation; impl AlwaysFixableViolation for UnderIndentation { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring is under-indented") + "Docstring is under-indented".to_string() } fn fix_title(&self) -> String { @@ -150,13 +151,13 @@ impl AlwaysFixableViolation for UnderIndentation { /// /// [PEP 257]: https://peps.python.org/pep-0257/ /// [formatter]:https://docs.astral.sh/ruff/formatter/ -#[violation] -pub struct OverIndentation; +#[derive(ViolationMetadata)] +pub(crate) struct OverIndentation; impl AlwaysFixableViolation for OverIndentation { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring is over-indented") + "Docstring is over-indented".to_string() } fn fix_title(&self) -> String { @@ -165,7 +166,7 @@ impl AlwaysFixableViolation for OverIndentation { } /// D206, D207, D208 -pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn indent(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); // Split the docstring into lines. @@ -178,8 +179,9 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { return; } - let mut has_seen_tab = docstring.indentation.contains('\t'); - let docstring_indent_size = docstring.indentation.chars().count(); + let docstring_indentation = docstring.compute_indentation(); + let mut has_seen_tab = docstring_indentation.contains('\t'); + let docstring_indent_size = docstring_indentation.chars().count(); // Lines, other than the last, that are over indented. let mut over_indented_lines = vec![]; @@ -225,10 +227,10 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { let mut diagnostic = Diagnostic::new(UnderIndentation, TextRange::empty(line.start())); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - clean_space(docstring.indentation), + clean_space(docstring_indentation), TextRange::at(line.start(), line_indent.text_len()), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -263,11 +265,9 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { current = lines.next(); } - if checker.enabled(Rule::IndentWithSpaces) { + if checker.enabled(Rule::DocstringTabIndentation) { if has_seen_tab { - checker - .diagnostics - .push(Diagnostic::new(IndentWithSpaces, docstring.range())); + checker.report_diagnostic(Diagnostic::new(DocstringTabIndentation, docstring.range())); } } @@ -276,7 +276,7 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { if let Some(smallest_over_indent_size) = smallest_over_indent_size { for line in over_indented_lines { let line_indent = leading_space(&line); - let indent = clean_space(docstring.indentation); + let indent = clean_space(docstring_indentation); // We report over-indentation on every line. This isn't great, but // enables the fix capability. @@ -311,7 +311,7 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { Edit::range_replacement(indent, range) }; diagnostic.set_fix(Fix::safe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -325,7 +325,7 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { if last_line_over_indent > 0 && is_indent_only { let mut diagnostic = Diagnostic::new(OverIndentation, TextRange::empty(last.start())); - let indent = clean_space(docstring.indentation); + let indent = clean_space(docstring_indentation); let range = TextRange::at(last.start(), line_indent.text_len()); let edit = if indent.is_empty() { Edit::range_deletion(range) @@ -333,7 +333,7 @@ pub(crate) fn indent(checker: &mut Checker, docstring: &Docstring) { Edit::range_replacement(indent, range) }; diagnostic.set_fix(Fix::safe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/multi_line_summary_start.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/multi_line_summary_start.rs index 8a4afc90e1c55..764fa3682706f 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/multi_line_summary_start.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/multi_line_summary_start.rs @@ -1,6 +1,8 @@ +use std::borrow::Cow; + use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::str::{is_triple_quote, leading_quote}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::str::is_triple_quote; use ruff_python_semantic::Definition; use ruff_source_file::{LineRanges, NewlineWithTrailingNewline, UniversalNewlineIterator}; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -48,15 +50,23 @@ use crate::registry::Rule; /// """ /// ``` /// +/// ## Options +/// - `lint.pydocstyle.convention` +/// +/// ## References +/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) +/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) +/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) +/// /// [D213]: https://docs.astral.sh/ruff/rules/multi-line-summary-second-line /// [PEP 257]: https://peps.python.org/pep-0257 -#[violation] -pub struct MultiLineSummaryFirstLine; +#[derive(ViolationMetadata)] +pub(crate) struct MultiLineSummaryFirstLine; impl AlwaysFixableViolation for MultiLineSummaryFirstLine { #[derive_message_formats] fn message(&self) -> String { - format!("Multi-line docstring summary should start at the first line") + "Multi-line docstring summary should start at the first line".to_string() } fn fix_title(&self) -> String { @@ -103,15 +113,23 @@ impl AlwaysFixableViolation for MultiLineSummaryFirstLine { /// """ /// ``` /// +/// ## Options +/// - `lint.pydocstyle.convention` +/// +/// ## References +/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) +/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) +/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) +/// /// [D212]: https://docs.astral.sh/ruff/rules/multi-line-summary-first-line /// [PEP 257]: https://peps.python.org/pep-0257 -#[violation] -pub struct MultiLineSummarySecondLine; +#[derive(ViolationMetadata)] +pub(crate) struct MultiLineSummarySecondLine; impl AlwaysFixableViolation for MultiLineSummarySecondLine { #[derive_message_formats] fn message(&self) -> String { - format!("Multi-line docstring summary should start at the second line") + "Multi-line docstring summary should start at the second line".to_string() } fn fix_title(&self) -> String { @@ -120,8 +138,7 @@ impl AlwaysFixableViolation for MultiLineSummarySecondLine { } /// D212, D213 -pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstring) { - let contents = docstring.contents; +pub(crate) fn multi_line_summary_start(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); if NewlineWithTrailingNewline::from(body.as_str()) @@ -129,8 +146,9 @@ pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstr .is_none() { return; - }; - let mut content_lines = UniversalNewlineIterator::with_offset(contents, docstring.start()); + } + let mut content_lines = + UniversalNewlineIterator::with_offset(docstring.contents(), docstring.start()); let Some(first_line) = content_lines.next() else { return; @@ -149,7 +167,7 @@ pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstr break; } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else if first_line.as_str().ends_with('\\') { // Ignore the edge case whether a single quoted string is multiple lines through an @@ -163,7 +181,7 @@ pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstr } else { if checker.enabled(Rule::MultiLineSummarySecondLine) { let mut diagnostic = Diagnostic::new(MultiLineSummarySecondLine, docstring.range()); - let mut indentation = String::from(docstring.indentation); + let mut indentation = Cow::Borrowed(docstring.compute_indentation()); let mut fixable = true; if !indentation.chars().all(char::is_whitespace) { fixable = false; @@ -177,23 +195,26 @@ pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstr .slice(TextRange::new(stmt_line_start, member.start())); if stmt_indentation.chars().all(char::is_whitespace) { + let indentation = indentation.to_mut(); indentation.clear(); indentation.push_str(stmt_indentation); indentation.push_str(checker.stylist().indentation()); fixable = true; } - }; + } } if fixable { - let prefix = leading_quote(contents).unwrap(); // Use replacement instead of insert to trim possible whitespace between leading // quote and text. let repl = format!( "{}{}{}", checker.stylist().line_ending().as_str(), indentation, - first_line.strip_prefix(prefix).unwrap().trim_start() + first_line + .strip_prefix(docstring.opener()) + .unwrap() + .trim_start() ); diagnostic.set_fix(Fix::safe_edit(Edit::replacement( @@ -202,7 +223,7 @@ pub(crate) fn multi_line_summary_start(checker: &mut Checker, docstring: &Docstr first_line.end(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/newline_after_last_paragraph.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/newline_after_last_paragraph.rs index 12b37da83bc8f..1da0e6b83c32e 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/newline_after_last_paragraph.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/newline_after_last_paragraph.rs @@ -1,7 +1,7 @@ use ruff_text_size::{TextLen, TextSize}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::docstrings::clean_space; use ruff_source_file::{NewlineWithTrailingNewline, UniversalNewlines}; use ruff_text_size::Ranged; @@ -43,13 +43,13 @@ use crate::docstrings::Docstring; /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct NewLineAfterLastParagraph; +#[derive(ViolationMetadata)] +pub(crate) struct NewLineAfterLastParagraph; impl AlwaysFixableViolation for NewLineAfterLastParagraph { #[derive_message_formats] fn message(&self) -> String { - format!("Multi-line docstring closing quotes should be on a separate line") + "Multi-line docstring closing quotes should be on a separate line".to_string() } fn fix_title(&self) -> String { @@ -58,11 +58,11 @@ impl AlwaysFixableViolation for NewLineAfterLastParagraph { } /// D209 -pub(crate) fn newline_after_last_paragraph(checker: &mut Checker, docstring: &Docstring) { - let contents = docstring.contents; +pub(crate) fn newline_after_last_paragraph(checker: &Checker, docstring: &Docstring) { + let contents = docstring.contents(); let body = docstring.body(); - if !docstring.triple_quoted() { + if !docstring.is_triple_quoted() { return; } @@ -92,14 +92,14 @@ pub(crate) fn newline_after_last_paragraph(checker: &mut Checker, docstring: &Do let content = format!( "{}{}", checker.stylist().line_ending().as_str(), - clean_space(docstring.indentation) + clean_space(docstring.compute_indentation()) ); diagnostic.set_fix(Fix::safe_edit(Edit::replacement( content, docstring.end() - num_trailing_quotes - num_trailing_spaces, docstring.end() - num_trailing_quotes, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } return; diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/no_signature.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/no_signature.rs index eda6bc959f7f4..87d6c96d006dd 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/no_signature.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/no_signature.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::UniversalNewlines; use ruff_text_size::Ranged; @@ -40,18 +40,18 @@ use crate::docstrings::Docstring; /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct NoSignature; +#[derive(ViolationMetadata)] +pub(crate) struct SignatureInDocstring; -impl Violation for NoSignature { +impl Violation for SignatureInDocstring { #[derive_message_formats] fn message(&self) -> String { - format!("First line should not be the function's signature") + "First line should not be the function's signature".to_string() } } /// D402 -pub(crate) fn no_signature(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn no_signature(checker: &Checker, docstring: &Docstring) { let Some(function) = docstring.definition.as_function_def() else { return; }; @@ -71,7 +71,7 @@ pub(crate) fn no_signature(checker: &mut Checker, docstring: &Docstring) { let preceded_by_word_boundary = first_line[..index] .chars() .next_back() - .map_or(true, |c| matches!(c, ' ' | '\t' | ';' | ',')); + .is_none_or(|c| matches!(c, ' ' | '\t' | ';' | ',')); if !preceded_by_word_boundary { return false; } @@ -86,8 +86,6 @@ pub(crate) fn no_signature(checker: &mut Checker, docstring: &Docstring) { true }) { - checker - .diagnostics - .push(Diagnostic::new(NoSignature, docstring.range())); + checker.report_diagnostic(Diagnostic::new(SignatureInDocstring, docstring.range())); } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/no_surrounding_whitespace.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/no_surrounding_whitespace.rs index 5c3043848869c..91d24db52a1ca 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/no_surrounding_whitespace.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/no_surrounding_whitespace.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::NewlineWithTrailingNewline; use ruff_text_size::Ranged; use ruff_text_size::{TextLen, TextRange}; @@ -31,15 +31,15 @@ use crate::rules::pydocstyle::helpers::ends_with_backslash; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct SurroundingWhitespace; +#[derive(ViolationMetadata)] +pub(crate) struct SurroundingWhitespace; impl Violation for SurroundingWhitespace { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("No whitespaces allowed surrounding docstring text") + "No whitespaces allowed surrounding docstring text".to_string() } fn fix_title(&self) -> Option<String> { @@ -48,7 +48,7 @@ impl Violation for SurroundingWhitespace { } /// D210 -pub(crate) fn no_surrounding_whitespace(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn no_surrounding_whitespace(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); let mut lines = NewlineWithTrailingNewline::from(body.as_str()); @@ -63,7 +63,7 @@ pub(crate) fn no_surrounding_whitespace(checker: &mut Checker, docstring: &Docst return; } let mut diagnostic = Diagnostic::new(SurroundingWhitespace, docstring.range()); - let quote = docstring.contents.chars().last().unwrap(); + let quote = docstring.quote_style().as_char(); // If removing whitespace would lead to an invalid string of quote // characters, avoid applying the fix. if !trimmed.ends_with(quote) && !trimmed.starts_with(quote) && !ends_with_backslash(trimmed) { @@ -72,5 +72,5 @@ pub(crate) fn no_surrounding_whitespace(checker: &mut Checker, docstring: &Docst TextRange::at(body.start(), line.text_len()), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/non_imperative_mood.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/non_imperative_mood.rs index 7be580cd1b496..e5c88bfb36dc7 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/non_imperative_mood.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/non_imperative_mood.rs @@ -3,7 +3,7 @@ use std::sync::LazyLock; use imperative::Mood; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::visibility::{is_property, is_test}; use ruff_source_file::UniversalNewlines; use ruff_text_size::Ranged; @@ -43,13 +43,15 @@ static MOOD: LazyLock<Mood> = LazyLock::new(Mood::new); /// /// ## Options /// - `lint.pydocstyle.convention` +/// - `lint.pydocstyle.property-decorators` +/// - `lint.pydocstyle.ignore-decorators` /// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct NonImperativeMood { +#[derive(ViolationMetadata)] +pub(crate) struct NonImperativeMood { first_line: String, } @@ -62,11 +64,7 @@ impl Violation for NonImperativeMood { } /// D401 -pub(crate) fn non_imperative_mood( - checker: &mut Checker, - docstring: &Docstring, - settings: &Settings, -) { +pub(crate) fn non_imperative_mood(checker: &Checker, docstring: &Docstring, settings: &Settings) { let Some(function) = docstring.definition.as_function_def() else { return; }; @@ -101,7 +99,7 @@ pub(crate) fn non_imperative_mood( } if matches!(MOOD.is_imperative(&first_word_norm), Some(false)) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonImperativeMood { first_line: first_line.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/not_empty.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/not_empty.rs index 9d3f8ec2e4d79..05dd97fac5d20 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/not_empty.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/not_empty.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -29,26 +29,24 @@ use crate::registry::Rule; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct EmptyDocstring; +#[derive(ViolationMetadata)] +pub(crate) struct EmptyDocstring; impl Violation for EmptyDocstring { #[derive_message_formats] fn message(&self) -> String { - format!("Docstring is empty") + "Docstring is empty".to_string() } } /// D419 -pub(crate) fn not_empty(checker: &mut Checker, docstring: &Docstring) -> bool { +pub(crate) fn not_empty(checker: &Checker, docstring: &Docstring) -> bool { if !docstring.body().trim().is_empty() { return true; } if checker.enabled(Rule::EmptyDocstring) { - checker - .diagnostics - .push(Diagnostic::new(EmptyDocstring, docstring.range())); + checker.report_diagnostic(Diagnostic::new(EmptyDocstring, docstring.range())); } false } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs index ba8d5d14c0a4a..5d941ab82a264 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility::{ - is_call, is_init, is_magic, is_new, is_overload, is_override, Visibility, + Visibility, is_call, is_init, is_magic, is_new, is_overload, is_override, }; use ruff_python_semantic::{Definition, Member, MemberKind, Module, ModuleKind}; use ruff_text_size::TextRange; @@ -61,13 +61,13 @@ use crate::registry::Rule; /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicModule; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicModule; impl Violation for UndocumentedPublicModule { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public module") + "Missing docstring in public module".to_string() } } @@ -144,13 +144,13 @@ impl Violation for UndocumentedPublicModule { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicClass; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicClass; impl Violation for UndocumentedPublicClass { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public class") + "Missing docstring in public class".to_string() } } @@ -226,13 +226,13 @@ impl Violation for UndocumentedPublicClass { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicMethod; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicMethod; impl Violation for UndocumentedPublicMethod { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public method") + "Missing docstring in public method".to_string() } } @@ -316,13 +316,13 @@ impl Violation for UndocumentedPublicMethod { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Python Docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicFunction; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicFunction; impl Violation for UndocumentedPublicFunction { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public function") + "Missing docstring in public function".to_string() } } @@ -359,13 +359,13 @@ impl Violation for UndocumentedPublicFunction { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Python Docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicPackage; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicPackage; impl Violation for UndocumentedPublicPackage { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public package") + "Missing docstring in public package".to_string() } } @@ -416,13 +416,13 @@ impl Violation for UndocumentedPublicPackage { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Python Docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) -#[violation] -pub struct UndocumentedMagicMethod; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedMagicMethod; impl Violation for UndocumentedMagicMethod { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in magic method") + "Missing docstring in magic method".to_string() } } @@ -471,13 +471,13 @@ impl Violation for UndocumentedMagicMethod { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Python Docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicNestedClass; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicNestedClass; impl Violation for UndocumentedPublicNestedClass { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in public nested class") + "Missing docstring in public nested class".to_string() } } @@ -519,19 +519,19 @@ impl Violation for UndocumentedPublicNestedClass { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Python Docstrings](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) -#[violation] -pub struct UndocumentedPublicInit; +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedPublicInit; impl Violation for UndocumentedPublicInit { #[derive_message_formats] fn message(&self) -> String { - format!("Missing docstring in `__init__`") + "Missing docstring in `__init__`".to_string() } } /// D100, D101, D102, D103, D104, D105, D106, D107 pub(crate) fn not_missing( - checker: &mut Checker, + checker: &Checker, definition: &Definition, visibility: Visibility, ) -> bool { @@ -552,7 +552,7 @@ pub(crate) fn not_missing( return true; } if checker.enabled(Rule::UndocumentedPublicModule) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicModule, TextRange::default(), )); @@ -564,7 +564,7 @@ pub(crate) fn not_missing( .. }) => { if checker.enabled(Rule::UndocumentedPublicPackage) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicPackage, TextRange::default(), )); @@ -576,9 +576,10 @@ pub(crate) fn not_missing( .. }) => { if checker.enabled(Rule::UndocumentedPublicClass) { - checker - .diagnostics - .push(Diagnostic::new(UndocumentedPublicClass, class.identifier())); + checker.report_diagnostic(Diagnostic::new( + UndocumentedPublicClass, + class.identifier(), + )); } false } @@ -587,7 +588,7 @@ pub(crate) fn not_missing( .. }) => { if checker.enabled(Rule::UndocumentedPublicNestedClass) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicNestedClass, function.identifier(), )); @@ -602,7 +603,7 @@ pub(crate) fn not_missing( true } else { if checker.enabled(Rule::UndocumentedPublicFunction) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicFunction, function.identifier(), )); @@ -620,7 +621,7 @@ pub(crate) fn not_missing( true } else if is_init(&function.name) { if checker.enabled(Rule::UndocumentedPublicInit) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicInit, function.identifier(), )); @@ -628,7 +629,7 @@ pub(crate) fn not_missing( true } else if is_new(&function.name) || is_call(&function.name) { if checker.enabled(Rule::UndocumentedPublicMethod) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicMethod, function.identifier(), )); @@ -636,7 +637,7 @@ pub(crate) fn not_missing( true } else if is_magic(&function.name) { if checker.enabled(Rule::UndocumentedMagicMethod) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedMagicMethod, function.identifier(), )); @@ -644,7 +645,7 @@ pub(crate) fn not_missing( true } else { if checker.enabled(Rule::UndocumentedPublicMethod) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedPublicMethod, function.identifier(), )); diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/one_liner.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/one_liner.rs index eac720d20b020..ebfb81b73de7d 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/one_liner.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/one_liner.rs @@ -1,6 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::str::{leading_quote, trailing_quote}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::NewlineWithTrailingNewline; use ruff_text_size::Ranged; @@ -28,19 +27,24 @@ use crate::docstrings::Docstring; /// """Return the mean of the given values.""" /// ``` /// +/// ## Fix safety +/// The fix is marked as unsafe because it could affect tools that parse docstrings, +/// documentation generators, or custom introspection utilities that rely on +/// specific docstring formatting. +/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct FitsOnOneLine; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryMultilineDocstring; -impl Violation for FitsOnOneLine { +impl Violation for UnnecessaryMultilineDocstring { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("One-line docstring should fit on one line") + "One-line docstring should fit on one line".to_string() } fn fix_title(&self) -> Option<String> { @@ -49,7 +53,7 @@ impl Violation for FitsOnOneLine { } /// D200 -pub(crate) fn one_liner(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn one_liner(checker: &Checker, docstring: &Docstring) { let mut line_count = 0; let mut non_empty_line_count = 0; for line in NewlineWithTrailingNewline::from(docstring.body().as_str()) { @@ -63,25 +67,27 @@ pub(crate) fn one_liner(checker: &mut Checker, docstring: &Docstring) { } if non_empty_line_count == 1 && line_count > 1 { - let mut diagnostic = Diagnostic::new(FitsOnOneLine, docstring.range()); - if let (Some(leading), Some(trailing)) = ( - leading_quote(docstring.contents), - trailing_quote(docstring.contents), - ) { - // If removing whitespace would lead to an invalid string of quote - // characters, avoid applying the fix. - let body = docstring.body(); - let trimmed = body.trim(); - if trimmed.chars().rev().take_while(|c| *c == '\\').count() % 2 == 0 - && !trimmed.ends_with(trailing.chars().last().unwrap()) - && !trimmed.starts_with(leading.chars().last().unwrap()) - { - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - format!("{leading}{trimmed}{trailing}"), - docstring.range(), - ))); - } + let mut diagnostic = Diagnostic::new(UnnecessaryMultilineDocstring, docstring.range()); + + // If removing whitespace would lead to an invalid string of quote + // characters, avoid applying the fix. + let body = docstring.body(); + let trimmed = body.trim(); + let quote_char = docstring.quote_style().as_char(); + if trimmed.chars().rev().take_while(|c| *c == '\\').count() % 2 == 0 + && !trimmed.ends_with(quote_char) + && !trimmed.starts_with(quote_char) + { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + format!( + "{leading}{trimmed}{trailing}", + leading = docstring.opener(), + trailing = docstring.closer() + ), + docstring.range(), + ))); } - checker.diagnostics.push(diagnostic); + + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs index f34dba528d85d..050a455f5dd52 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs @@ -5,19 +5,18 @@ use std::sync::LazyLock; use ruff_diagnostics::{AlwaysFixableViolation, Violation}; use ruff_diagnostics::{Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::docstrings::{clean_space, leading_space}; use ruff_python_ast::identifier::Identifier; -use ruff_python_ast::ParameterWithDefault; use ruff_python_semantic::analyze::visibility::is_staticmethod; use ruff_python_trivia::textwrap::dedent; use ruff_source_file::NewlineWithTrailingNewline; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; use crate::checkers::ast::Checker; +use crate::docstrings::Docstring; use crate::docstrings::sections::{SectionContext, SectionContexts, SectionKind}; use crate::docstrings::styles::SectionStyle; -use crate::docstrings::Docstring; use crate::registry::Rule; use crate::rules::pydocstyle::helpers::find_underline; use crate::rules::pydocstyle::settings::Convention; @@ -36,6 +35,9 @@ use crate::rules::pydocstyle::settings::Convention; /// indentation of the docstring's opening quotes, and the body should be /// indented one level further. /// +/// This rule is enabled when using the `numpy` and `google` conventions, and +/// disabled when using the `pep257` convention. +/// /// ## Example /// ```python /// def calculate_speed(distance: float, time: float) -> float: @@ -86,20 +88,20 @@ use crate::rules::pydocstyle::settings::Convention; /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct SectionNotOverIndented { +#[derive(ViolationMetadata)] +pub(crate) struct OverindentedSection { name: String, } -impl AlwaysFixableViolation for SectionNotOverIndented { +impl AlwaysFixableViolation for OverindentedSection { #[derive_message_formats] fn message(&self) -> String { - let SectionNotOverIndented { name } = self; + let OverindentedSection { name } = self; format!("Section is over-indented (\"{name}\")") } fn fix_title(&self) -> String { - let SectionNotOverIndented { name } = self; + let OverindentedSection { name } = self; format!("Remove over-indentation from \"{name}\"") } } @@ -189,20 +191,20 @@ impl AlwaysFixableViolation for SectionNotOverIndented { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct SectionUnderlineNotOverIndented { +#[derive(ViolationMetadata)] +pub(crate) struct OverindentedSectionUnderline { name: String, } -impl AlwaysFixableViolation for SectionUnderlineNotOverIndented { +impl AlwaysFixableViolation for OverindentedSectionUnderline { #[derive_message_formats] fn message(&self) -> String { - let SectionUnderlineNotOverIndented { name } = self; + let OverindentedSectionUnderline { name } = self; format!("Section underline is over-indented (\"{name}\")") } fn fix_title(&self) -> String { - let SectionUnderlineNotOverIndented { name } = self; + let OverindentedSectionUnderline { name } = self; format!("Remove over-indentation from \"{name}\" underline") } } @@ -219,6 +221,9 @@ impl AlwaysFixableViolation for SectionUnderlineNotOverIndented { /// a blank line, followed by a series of sections. Each section typically has /// a header and a body. /// +/// This rule is enabled when using the `numpy` and `google` conventions, and +/// disabled when using the `pep257` convention. +/// /// ## Example /// ```python /// def calculate_speed(distance: float, time: float) -> float: @@ -269,20 +274,20 @@ impl AlwaysFixableViolation for SectionUnderlineNotOverIndented { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct CapitalizeSectionName { +#[derive(ViolationMetadata)] +pub(crate) struct NonCapitalizedSectionName { name: String, } -impl AlwaysFixableViolation for CapitalizeSectionName { +impl AlwaysFixableViolation for NonCapitalizedSectionName { #[derive_message_formats] fn message(&self) -> String { - let CapitalizeSectionName { name } = self; + let NonCapitalizedSectionName { name } = self; format!("Section name should be properly capitalized (\"{name}\")") } fn fix_title(&self) -> String { - let CapitalizeSectionName { name } = self; + let NonCapitalizedSectionName { name } = self; format!("Capitalize \"{name}\"") } } @@ -367,20 +372,20 @@ impl AlwaysFixableViolation for CapitalizeSectionName { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct NewLineAfterSectionName { +#[derive(ViolationMetadata)] +pub(crate) struct MissingNewLineAfterSectionName { name: String, } -impl AlwaysFixableViolation for NewLineAfterSectionName { +impl AlwaysFixableViolation for MissingNewLineAfterSectionName { #[derive_message_formats] fn message(&self) -> String { - let NewLineAfterSectionName { name } = self; + let MissingNewLineAfterSectionName { name } = self; format!("Section name should end with a newline (\"{name}\")") } fn fix_title(&self) -> String { - let NewLineAfterSectionName { name } = self; + let MissingNewLineAfterSectionName { name } = self; format!("Add newline after \"{name}\"") } } @@ -470,20 +475,20 @@ impl AlwaysFixableViolation for NewLineAfterSectionName { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct DashedUnderlineAfterSection { +#[derive(ViolationMetadata)] +pub(crate) struct MissingDashedUnderlineAfterSection { name: String, } -impl AlwaysFixableViolation for DashedUnderlineAfterSection { +impl AlwaysFixableViolation for MissingDashedUnderlineAfterSection { #[derive_message_formats] fn message(&self) -> String { - let DashedUnderlineAfterSection { name } = self; + let MissingDashedUnderlineAfterSection { name } = self; format!("Missing dashed underline after section (\"{name}\")") } fn fix_title(&self) -> String { - let DashedUnderlineAfterSection { name } = self; + let MissingDashedUnderlineAfterSection { name } = self; format!("Add dashed line under \"{name}\"") } } @@ -576,20 +581,20 @@ impl AlwaysFixableViolation for DashedUnderlineAfterSection { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct SectionUnderlineAfterName { +#[derive(ViolationMetadata)] +pub(crate) struct MissingSectionUnderlineAfterName { name: String, } -impl AlwaysFixableViolation for SectionUnderlineAfterName { +impl AlwaysFixableViolation for MissingSectionUnderlineAfterName { #[derive_message_formats] fn message(&self) -> String { - let SectionUnderlineAfterName { name } = self; + let MissingSectionUnderlineAfterName { name } = self; format!("Section underline should be in the line following the section's name (\"{name}\")") } fn fix_title(&self) -> String { - let SectionUnderlineAfterName { name } = self; + let MissingSectionUnderlineAfterName { name } = self; format!("Add underline to \"{name}\"") } } @@ -680,20 +685,20 @@ impl AlwaysFixableViolation for SectionUnderlineAfterName { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct SectionUnderlineMatchesSectionLength { +#[derive(ViolationMetadata)] +pub(crate) struct MismatchedSectionUnderlineLength { name: String, } -impl AlwaysFixableViolation for SectionUnderlineMatchesSectionLength { +impl AlwaysFixableViolation for MismatchedSectionUnderlineLength { #[derive_message_formats] fn message(&self) -> String { - let SectionUnderlineMatchesSectionLength { name } = self; + let MismatchedSectionUnderlineLength { name } = self; format!("Section underline should match the length of its name (\"{name}\")") } fn fix_title(&self) -> String { - let SectionUnderlineMatchesSectionLength { name } = self; + let MismatchedSectionUnderlineLength { name } = self; format!("Adjust underline length to match \"{name}\"") } } @@ -777,8 +782,8 @@ impl AlwaysFixableViolation for SectionUnderlineMatchesSectionLength { /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct NoBlankLineAfterSection { +#[derive(ViolationMetadata)] +pub(crate) struct NoBlankLineAfterSection { name: String, } @@ -870,8 +875,8 @@ impl AlwaysFixableViolation for NoBlankLineAfterSection { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct NoBlankLineBeforeSection { +#[derive(ViolationMetadata)] +pub(crate) struct NoBlankLineBeforeSection { name: String, } @@ -965,20 +970,20 @@ impl AlwaysFixableViolation for NoBlankLineBeforeSection { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) -#[violation] -pub struct BlankLineAfterLastSection { +#[derive(ViolationMetadata)] +pub(crate) struct MissingBlankLineAfterLastSection { name: String, } -impl AlwaysFixableViolation for BlankLineAfterLastSection { +impl AlwaysFixableViolation for MissingBlankLineAfterLastSection { #[derive_message_formats] fn message(&self) -> String { - let BlankLineAfterLastSection { name } = self; + let MissingBlankLineAfterLastSection { name } = self; format!("Missing blank line after last section (\"{name}\")") } fn fix_title(&self) -> String { - let BlankLineAfterLastSection { name } = self; + let MissingBlankLineAfterLastSection { name } = self; format!("Add blank line after \"{name}\"") } } @@ -1049,16 +1054,13 @@ impl AlwaysFixableViolation for BlankLineAfterLastSection { /// raise FasterThanLightError from exc /// ``` /// -/// ## Options -/// - `lint.pydocstyle.convention` -/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct EmptyDocstringSection { +#[derive(ViolationMetadata)] +pub(crate) struct EmptyDocstringSection { name: String, } @@ -1134,20 +1136,20 @@ impl Violation for EmptyDocstringSection { /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [Google Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct SectionNameEndsInColon { +#[derive(ViolationMetadata)] +pub(crate) struct MissingSectionNameColon { name: String, } -impl AlwaysFixableViolation for SectionNameEndsInColon { +impl AlwaysFixableViolation for MissingSectionNameColon { #[derive_message_formats] fn message(&self) -> String { - let SectionNameEndsInColon { name } = self; + let MissingSectionNameColon { name } = self; format!("Section name should end with a colon (\"{name}\")") } fn fix_title(&self) -> String { - let SectionNameEndsInColon { name } = self; + let MissingSectionNameColon { name } = self; format!("Add colon to \"{name}\"") } } @@ -1165,6 +1167,7 @@ impl AlwaysFixableViolation for SectionNameEndsInColon { /// a blank line, followed by a series of sections, each with a section header /// and a section body. Function docstrings often include a section for /// function arguments; this rule is concerned with that section only. +/// Note that this rule only checks docstrings with an arguments (e.g. `Args`) section. /// /// This rule is enabled when using the `google` convention, and disabled when /// using the `pep257` and `numpy` conventions. @@ -1212,13 +1215,14 @@ impl AlwaysFixableViolation for SectionNameEndsInColon { /// /// ## Options /// - `lint.pydocstyle.convention` +/// - `lint.pydocstyle.ignore-var-parameters` /// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct UndocumentedParam { +#[derive(ViolationMetadata)] +pub(crate) struct UndocumentedParam { /// The name of the function being documented. definition: String, /// The names of the undocumented parameters. @@ -1294,16 +1298,13 @@ impl Violation for UndocumentedParam { /// raise FasterThanLightError from exc /// ``` /// -/// ## Options -/// - `lint.pydocstyle.convention` -/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html) /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) -#[violation] -pub struct BlankLinesBetweenHeaderAndContent { +#[derive(ViolationMetadata)] +pub(crate) struct BlankLinesBetweenHeaderAndContent { name: String, } @@ -1322,7 +1323,7 @@ impl AlwaysFixableViolation for BlankLinesBetweenHeaderAndContent { /// D212, D214, D215, D405, D406, D407, D408, D409, D410, D411, D412, D413, /// D414, D416, D417 pub(crate) fn sections( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, section_contexts: &SectionContexts, convention: Option<Convention>, @@ -1338,7 +1339,7 @@ pub(crate) fn sections( } fn blanks_and_section_underline( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, context: &SectionContext, style: SectionStyle, @@ -1360,9 +1361,9 @@ fn blanks_and_section_underline( if let Some(non_blank_line) = following_lines.next() { if let Some(dashed_line) = find_underline(&non_blank_line, '-') { if num_blank_lines_after_header > 0 { - if checker.enabled(Rule::SectionUnderlineAfterName) { + if checker.enabled(Rule::MissingSectionUnderlineAfterName) { let mut diagnostic = Diagnostic::new( - SectionUnderlineAfterName { + MissingSectionUnderlineAfterName { name: context.section_name().to_string(), }, dashed_line, @@ -1374,14 +1375,14 @@ fn blanks_and_section_underline( blank_lines_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if dashed_line.len().to_usize() != context.section_name().len() { - if checker.enabled(Rule::SectionUnderlineMatchesSectionLength) { + if checker.enabled(Rule::MismatchedSectionUnderlineLength) { let mut diagnostic = Diagnostic::new( - SectionUnderlineMatchesSectionLength { + MismatchedSectionUnderlineLength { name: context.section_name().to_string(), }, dashed_line, @@ -1393,15 +1394,16 @@ fn blanks_and_section_underline( dashed_line, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - if checker.enabled(Rule::SectionUnderlineNotOverIndented) { + if checker.enabled(Rule::OverindentedSectionUnderline) { let leading_space = leading_space(&non_blank_line); - if leading_space.len() > docstring.indentation.len() { + let docstring_indentation = docstring.compute_indentation(); + if leading_space.len() > docstring_indentation.len() { let mut diagnostic = Diagnostic::new( - SectionUnderlineNotOverIndented { + OverindentedSectionUnderline { name: context.section_name().to_string(), }, dashed_line, @@ -1412,14 +1414,14 @@ fn blanks_and_section_underline( blank_lines_end, leading_space.text_len() + TextSize::from(1), ); - let contents = clean_space(docstring.indentation); + let contents = clean_space(docstring_indentation); diagnostic.set_fix(Fix::safe_edit(if contents.is_empty() { Edit::range_deletion(range) } else { Edit::range_replacement(contents, range) })); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -1439,7 +1441,7 @@ fn blanks_and_section_underline( if following_lines.peek().is_none() { if checker.enabled(Rule::EmptyDocstringSection) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( EmptyDocstringSection { name: context.section_name().to_string(), }, @@ -1482,7 +1484,7 @@ fn blanks_and_section_underline( line_after_dashes.start(), blank_lines_after_dashes_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else { let mut diagnostic = Diagnostic::new( @@ -1496,13 +1498,13 @@ fn blanks_and_section_underline( line_after_dashes.start(), blank_lines_after_dashes_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } else { if checker.enabled(Rule::EmptyDocstringSection) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( EmptyDocstringSection { name: context.section_name().to_string(), }, @@ -1511,10 +1513,10 @@ fn blanks_and_section_underline( } } } else { - if style.is_numpy() && checker.enabled(Rule::DashedUnderlineAfterSection) { + if style.is_numpy() && checker.enabled(Rule::MissingDashedUnderlineAfterSection) { if let Some(equal_line) = find_underline(&non_blank_line, '=') { let mut diagnostic = Diagnostic::new( - DashedUnderlineAfterSection { + MissingDashedUnderlineAfterSection { name: context.section_name().to_string(), }, equal_line, @@ -1527,10 +1529,10 @@ fn blanks_and_section_underline( equal_line, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else { let mut diagnostic = Diagnostic::new( - DashedUnderlineAfterSection { + MissingDashedUnderlineAfterSection { name: context.section_name().to_string(), }, context.section_name_range(), @@ -1540,7 +1542,7 @@ fn blanks_and_section_underline( let content = format!( "{}{}{}", checker.stylist().line_ending().as_str(), - clean_space(docstring.indentation), + clean_space(docstring.compute_indentation()), "-".repeat(context.section_name().len()), ); diagnostic.set_fix(Fix::safe_edit(Edit::insertion( @@ -1548,7 +1550,7 @@ fn blanks_and_section_underline( context.summary_range().end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } if num_blank_lines_after_header > 0 { @@ -1588,7 +1590,7 @@ fn blanks_and_section_underline( context.following_range().start(), blank_lines_end, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else { let mut diagnostic = Diagnostic::new( @@ -1602,16 +1604,16 @@ fn blanks_and_section_underline( TextRange::new(context.following_range().start(), blank_lines_end); // Delete any blank lines between the header and content. diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(range))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } } } else { // Nothing but blank lines after the section header. - if style.is_numpy() && checker.enabled(Rule::DashedUnderlineAfterSection) { + if style.is_numpy() && checker.enabled(Rule::MissingDashedUnderlineAfterSection) { let mut diagnostic = Diagnostic::new( - DashedUnderlineAfterSection { + MissingDashedUnderlineAfterSection { name: context.section_name().to_string(), }, context.section_name_range(), @@ -1621,7 +1623,7 @@ fn blanks_and_section_underline( let content = format!( "{}{}{}", checker.stylist().line_ending().as_str(), - clean_space(docstring.indentation), + clean_space(docstring.compute_indentation()), "-".repeat(context.section_name().len()), ); diagnostic.set_fix(Fix::safe_edit(Edit::insertion( @@ -1629,10 +1631,10 @@ fn blanks_and_section_underline( context.summary_range().end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } if checker.enabled(Rule::EmptyDocstringSection) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( EmptyDocstringSection { name: context.section_name().to_string(), }, @@ -1643,18 +1645,18 @@ fn blanks_and_section_underline( } fn common_section( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, context: &SectionContext, next: Option<&SectionContext>, style: SectionStyle, ) { - if checker.enabled(Rule::CapitalizeSectionName) { + if checker.enabled(Rule::NonCapitalizedSectionName) { let capitalized_section_name = context.kind().as_str(); if context.section_name() != capitalized_section_name { let section_range = context.section_name_range(); let mut diagnostic = Diagnostic::new( - CapitalizeSectionName { + NonCapitalizedSectionName { name: context.section_name().to_string(), }, section_range, @@ -1665,30 +1667,31 @@ fn common_section( capitalized_section_name.to_string(), section_range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } - if checker.enabled(Rule::SectionNotOverIndented) { + if checker.enabled(Rule::OverindentedSection) { let leading_space = leading_space(context.summary_line()); - if leading_space.len() > docstring.indentation.len() { + let docstring_indentation = docstring.compute_indentation(); + if leading_space.len() > docstring_indentation.len() { let section_range = context.section_name_range(); let mut diagnostic = Diagnostic::new( - SectionNotOverIndented { + OverindentedSection { name: context.section_name().to_string(), }, section_range, ); // Replace the existing indentation with whitespace of the appropriate length. - let content = clean_space(docstring.indentation); + let content = clean_space(docstring_indentation); let fix_range = TextRange::at(context.start(), leading_space.text_len()); diagnostic.set_fix(Fix::safe_edit(if content.is_empty() { Edit::range_deletion(fix_range) } else { Edit::range_replacement(content, fix_range) })); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -1714,13 +1717,13 @@ fn common_section( line_end.to_string(), next.start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } else { // The first blank line is the line containing the closing triple quotes, so we need at // least two. - if checker.enabled(Rule::BlankLineAfterLastSection) { + if checker.enabled(Rule::MissingBlankLineAfterLastSection) { let num_blank_lines = context .following_lines() .rev() @@ -1738,7 +1741,7 @@ fn common_section( format!( "{}{}", line_end.repeat(2 - num_blank_lines), - docstring.indentation + docstring.compute_indentation() ), context.end() - del_len, context.end(), @@ -1746,13 +1749,13 @@ fn common_section( let section_range = context.section_name_range(); let mut diagnostic = Diagnostic::new( - BlankLineAfterLastSection { + MissingBlankLineAfterLastSection { name: context.section_name().to_string(), }, section_range, ); diagnostic.set_fix(Fix::safe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -1774,14 +1777,14 @@ fn common_section( line_end.to_string(), context.start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } blanks_and_section_underline(checker, docstring, context, style); } -fn missing_args(checker: &mut Checker, docstring: &Docstring, docstrings_args: &FxHashSet<String>) { +fn missing_args(checker: &Checker, docstring: &Docstring, docstrings_args: &FxHashSet<String>) { let Some(function) = docstring.definition.as_function_def() else { return; }; @@ -1790,11 +1793,7 @@ fn missing_args(checker: &mut Checker, docstring: &Docstring, docstrings_args: & let mut missing_arg_names: FxHashSet<String> = FxHashSet::default(); // If this is a non-static method, skip `cls` or `self`. - for ParameterWithDefault { - parameter, - default: _, - range: _, - } in function + for parameter in function .parameters .iter_non_variadic_params() .skip(usize::from( @@ -1802,7 +1801,7 @@ fn missing_args(checker: &mut Checker, docstring: &Docstring, docstrings_args: & && !is_staticmethod(&function.decorator_list, checker.semantic()), )) { - let arg_name = parameter.name.as_str(); + let arg_name = parameter.name().as_str(); if !arg_name.starts_with('_') && !docstrings_args.contains(arg_name) { missing_arg_names.insert(arg_name.to_string()); } @@ -1810,31 +1809,33 @@ fn missing_args(checker: &mut Checker, docstring: &Docstring, docstrings_args: & // Check specifically for `vararg` and `kwarg`, which can be prefixed with a // single or double star, respectively. - if let Some(arg) = function.parameters.vararg.as_ref() { - let arg_name = arg.name.as_str(); - let starred_arg_name = format!("*{arg_name}"); - if !arg_name.starts_with('_') - && !docstrings_args.contains(arg_name) - && !docstrings_args.contains(&starred_arg_name) - { - missing_arg_names.insert(starred_arg_name); + if !checker.settings.pydocstyle.ignore_var_parameters() { + if let Some(arg) = function.parameters.vararg.as_ref() { + let arg_name = arg.name.as_str(); + let starred_arg_name = format!("*{arg_name}"); + if !arg_name.starts_with('_') + && !docstrings_args.contains(arg_name) + && !docstrings_args.contains(&starred_arg_name) + { + missing_arg_names.insert(starred_arg_name); + } } - } - if let Some(arg) = function.parameters.kwarg.as_ref() { - let arg_name = arg.name.as_str(); - let starred_arg_name = format!("**{arg_name}"); - if !arg_name.starts_with('_') - && !docstrings_args.contains(arg_name) - && !docstrings_args.contains(&starred_arg_name) - { - missing_arg_names.insert(starred_arg_name); + if let Some(arg) = function.parameters.kwarg.as_ref() { + let arg_name = arg.name.as_str(); + let starred_arg_name = format!("**{arg_name}"); + if !arg_name.starts_with('_') + && !docstrings_args.contains(arg_name) + && !docstrings_args.contains(&starred_arg_name) + { + missing_arg_names.insert(starred_arg_name); + } } } if !missing_arg_names.is_empty() { if let Some(definition) = docstring.definition.name() { let names = missing_arg_names.into_iter().sorted().collect(); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndocumentedParam { definition: definition.to_string(), names, @@ -1871,7 +1872,7 @@ fn args_section(context: &SectionContext) -> FxHashSet<String> { // Reformat each section. let mut args_sections: Vec<String> = vec![]; for line in args_content.trim().lines() { - if line.chars().next().map_or(true, char::is_whitespace) { + if line.chars().next().is_none_or(char::is_whitespace) { // This is a continuation of the documentation for the previous parameter, // because it starts with whitespace. if let Some(last) = args_sections.last_mut() { @@ -1901,7 +1902,7 @@ fn args_section(context: &SectionContext) -> FxHashSet<String> { .collect::<FxHashSet<String>>() } -fn parameters_section(checker: &mut Checker, docstring: &Docstring, context: &SectionContext) { +fn parameters_section(checker: &Checker, docstring: &Docstring, context: &SectionContext) { // Collect the list of arguments documented in the docstring. let mut docstring_args: FxHashSet<String> = FxHashSet::default(); let section_level_indent = leading_space(context.summary_line()); @@ -1943,19 +1944,19 @@ fn parameters_section(checker: &mut Checker, docstring: &Docstring, context: &Se } fn numpy_section( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, context: &SectionContext, next: Option<&SectionContext>, ) { common_section(checker, docstring, context, next, SectionStyle::Numpy); - if checker.enabled(Rule::NewLineAfterSectionName) { + if checker.enabled(Rule::MissingNewLineAfterSectionName) { let suffix = context.summary_after_section_name(); if !suffix.is_empty() { let mut diagnostic = Diagnostic::new( - NewLineAfterSectionName { + MissingNewLineAfterSectionName { name: context.section_name().to_string(), }, context.section_name_range(), @@ -1966,7 +1967,7 @@ fn numpy_section( suffix.text_len(), )))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -1978,18 +1979,18 @@ fn numpy_section( } fn google_section( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, context: &SectionContext, next: Option<&SectionContext>, ) { common_section(checker, docstring, context, next, SectionStyle::Google); - if checker.enabled(Rule::SectionNameEndsInColon) { + if checker.enabled(Rule::MissingSectionNameColon) { let suffix = context.summary_after_section_name(); if suffix != ":" { let mut diagnostic = Diagnostic::new( - SectionNameEndsInColon { + MissingSectionNameColon { name: context.section_name().to_string(), }, context.section_name_range(), @@ -2000,13 +2001,13 @@ fn google_section( ":".to_string(), TextRange::at(section_name_range.end(), suffix.text_len()), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } fn parse_numpy_sections( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, section_contexts: &SectionContexts, ) { @@ -2017,7 +2018,7 @@ fn parse_numpy_sections( } fn parse_google_sections( - checker: &mut Checker, + checker: &Checker, docstring: &Docstring, section_contexts: &SectionContexts, ) { diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/starts_with_this.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/starts_with_this.rs index 2d9034a2b0991..47274f78884b9 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/starts_with_this.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/starts_with_this.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -39,18 +39,18 @@ use crate::rules::pydocstyle::helpers::normalize_word; /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// /// [PEP 257]: https://peps.python.org/pep-0257/ -#[violation] -pub struct DocstringStartsWithThis; +#[derive(ViolationMetadata)] +pub(crate) struct DocstringStartsWithThis; impl Violation for DocstringStartsWithThis { #[derive_message_formats] fn message(&self) -> String { - format!(r#"First word of the docstring should not be "This""#) + r#"First word of the docstring should not be "This""#.to_string() } } /// D404 -pub(crate) fn starts_with_this(checker: &mut Checker, docstring: &Docstring) { +pub(crate) fn starts_with_this(checker: &Checker, docstring: &Docstring) { let body = docstring.body(); let trimmed = body.trim(); @@ -64,7 +64,5 @@ pub(crate) fn starts_with_this(checker: &mut Checker, docstring: &Docstring) { if normalize_word(first_word) != "this" { return; } - checker - .diagnostics - .push(Diagnostic::new(DocstringStartsWithThis, docstring.range())); + checker.report_diagnostic(Diagnostic::new(DocstringStartsWithThis, docstring.range())); } diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/triple_quotes.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/triple_quotes.rs index 6504771099fef..8bd77b9b73ac5 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/triple_quotes.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/triple_quotes.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::str::Quote; use ruff_text_size::Ranged; @@ -37,8 +37,8 @@ use crate::docstrings::Docstring; /// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) /// /// [formatter]: https://docs.astral.sh/ruff/formatter/ -#[violation] -pub struct TripleSingleQuotes { +#[derive(ViolationMetadata)] +pub(crate) struct TripleSingleQuotes { expected_quote: Quote, } @@ -47,27 +47,25 @@ impl Violation for TripleSingleQuotes { #[derive_message_formats] fn message(&self) -> String { - let TripleSingleQuotes { expected_quote } = self; - match expected_quote { - Quote::Double => format!(r#"Use triple double quotes `"""`"#), - Quote::Single => format!(r"Use triple single quotes `'''`"), + match self.expected_quote { + Quote::Double => r#"Use triple double quotes `"""`"#.to_string(), + Quote::Single => r"Use triple single quotes `'''`".to_string(), } } fn fix_title(&self) -> Option<String> { - let TripleSingleQuotes { expected_quote } = self; - Some(match expected_quote { - Quote::Double => format!("Convert to triple double quotes"), - Quote::Single => format!("Convert to triple single quotes"), - }) + let title = match self.expected_quote { + Quote::Double => "Convert to triple double quotes", + Quote::Single => "Convert to triple single quotes", + }; + Some(title.to_string()) } } /// D300 -pub(crate) fn triple_quotes(checker: &mut Checker, docstring: &Docstring) { - let leading_quote = docstring.leading_quote(); - - let prefixes = leading_quote.trim_end_matches(['\'', '"']).to_owned(); +pub(crate) fn triple_quotes(checker: &Checker, docstring: &Docstring) { + let opener = docstring.opener(); + let prefixes = docstring.prefix_str(); let expected_quote = if docstring.body().contains("\"\"\"") { if docstring.body().contains("\'\'\'") { @@ -80,7 +78,7 @@ pub(crate) fn triple_quotes(checker: &mut Checker, docstring: &Docstring) { match expected_quote { Quote::Single => { - if !leading_quote.ends_with("'''") { + if !opener.ends_with("'''") { let mut diagnostic = Diagnostic::new(TripleSingleQuotes { expected_quote }, docstring.range()); @@ -92,11 +90,11 @@ pub(crate) fn triple_quotes(checker: &mut Checker, docstring: &Docstring) { ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } Quote::Double => { - if !leading_quote.ends_with("\"\"\"") { + if !opener.ends_with("\"\"\"") { let mut diagnostic = Diagnostic::new(TripleSingleQuotes { expected_quote }, docstring.range()); @@ -108,7 +106,7 @@ pub(crate) fn triple_quotes(checker: &mut Checker, docstring: &Docstring) { ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pydocstyle/settings.rs b/crates/ruff_linter/src/rules/pydocstyle/settings.rs index c8b05ba3c5012..48e1e36bdb874 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/settings.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/settings.rs @@ -28,47 +28,47 @@ impl Convention { pub const fn rules_to_be_ignored(self) -> &'static [Rule] { match self { Convention::Google => &[ - Rule::OneBlankLineBeforeClass, - Rule::OneBlankLineAfterClass, + Rule::IncorrectBlankLineBeforeClass, + Rule::IncorrectBlankLineAfterClass, Rule::MultiLineSummarySecondLine, - Rule::SectionUnderlineNotOverIndented, - Rule::EndsInPeriod, + Rule::OverindentedSectionUnderline, + Rule::MissingTrailingPeriod, Rule::NonImperativeMood, Rule::DocstringStartsWithThis, - Rule::NewLineAfterSectionName, - Rule::DashedUnderlineAfterSection, - Rule::SectionUnderlineAfterName, - Rule::SectionUnderlineMatchesSectionLength, - Rule::BlankLineAfterLastSection, + Rule::MissingNewLineAfterSectionName, + Rule::MissingDashedUnderlineAfterSection, + Rule::MissingSectionUnderlineAfterName, + Rule::MismatchedSectionUnderlineLength, + Rule::MissingBlankLineAfterLastSection, ], Convention::Numpy => &[ Rule::UndocumentedPublicInit, - Rule::OneBlankLineBeforeClass, + Rule::IncorrectBlankLineBeforeClass, Rule::MultiLineSummaryFirstLine, Rule::MultiLineSummarySecondLine, - Rule::NoSignature, - Rule::BlankLineAfterLastSection, - Rule::EndsInPunctuation, - Rule::SectionNameEndsInColon, + Rule::SignatureInDocstring, + Rule::MissingBlankLineAfterLastSection, + Rule::MissingTerminalPunctuation, + Rule::MissingSectionNameColon, Rule::UndocumentedParam, ], Convention::Pep257 => &[ - Rule::OneBlankLineBeforeClass, + Rule::IncorrectBlankLineBeforeClass, Rule::MultiLineSummaryFirstLine, Rule::MultiLineSummarySecondLine, - Rule::SectionNotOverIndented, - Rule::SectionUnderlineNotOverIndented, + Rule::OverindentedSection, + Rule::OverindentedSectionUnderline, Rule::DocstringStartsWithThis, - Rule::CapitalizeSectionName, - Rule::NewLineAfterSectionName, - Rule::DashedUnderlineAfterSection, - Rule::SectionUnderlineAfterName, - Rule::SectionUnderlineMatchesSectionLength, + Rule::NonCapitalizedSectionName, + Rule::MissingNewLineAfterSectionName, + Rule::MissingDashedUnderlineAfterSection, + Rule::MissingSectionUnderlineAfterName, + Rule::MismatchedSectionUnderlineLength, Rule::NoBlankLineAfterSection, Rule::NoBlankLineBeforeSection, - Rule::BlankLineAfterLastSection, - Rule::EndsInPunctuation, - Rule::SectionNameEndsInColon, + Rule::MissingBlankLineAfterLastSection, + Rule::MissingTerminalPunctuation, + Rule::MissingSectionNameColon, Rule::UndocumentedParam, ], } @@ -87,25 +87,13 @@ impl fmt::Display for Convention { #[derive(Debug, Clone, Default, CacheKey)] pub struct Settings { - convention: Option<Convention>, - ignore_decorators: BTreeSet<String>, - property_decorators: BTreeSet<String>, + pub convention: Option<Convention>, + pub ignore_decorators: BTreeSet<String>, + pub property_decorators: BTreeSet<String>, + pub ignore_var_parameters: bool, } impl Settings { - #[must_use] - pub fn new( - convention: Option<Convention>, - ignore_decorators: impl IntoIterator<Item = String>, - property_decorators: impl IntoIterator<Item = String>, - ) -> Self { - Self { - convention, - ignore_decorators: ignore_decorators.into_iter().collect(), - property_decorators: property_decorators.into_iter().collect(), - } - } - pub fn convention(&self) -> Option<Convention> { self.convention } @@ -117,6 +105,10 @@ impl Settings { pub fn property_decorators(&self) -> DecoratorIterator { DecoratorIterator::new(&self.property_decorators) } + + pub fn ignore_var_parameters(&self) -> bool { + self.ignore_var_parameters + } } impl fmt::Display for Settings { @@ -127,7 +119,8 @@ impl fmt::Display for Settings { fields = [ self.convention | optional, self.ignore_decorators | set, - self.property_decorators | set + self.property_decorators | set, + self.ignore_var_parameters ] } Ok(()) diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D.py.snap index 6f91c05384df3..9c1041221efce 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:1:1: D100 Missing docstring in public module diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D100.ipynb.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D100.ipynb.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D100.ipynb.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100_D100.ipynb.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated___no_pkg_priv.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated___no_pkg_priv.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated___no_pkg_priv.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated___no_pkg_priv.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg__D100_pub.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg__D100_pub.py.snap index 0d611a61a2af4..ba3592fc30fd8 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg__D100_pub.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg__D100_pub.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D100_pub.py:1:1: D100 Missing docstring in public module diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg___priv__no_D100_priv.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg___priv__no_D100_priv.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg___priv__no_D100_priv.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D100__unrelated__pkg___priv__no_D100_priv.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D101_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D101_D.py.snap index dcfc126666c56..c8cf6f9ab7532 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D101_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D101_D.py.snap @@ -5,8 +5,6 @@ D.py:15:7: D101 Missing docstring in public class | 15 | class class_: | ^^^^^^ D101 -16 | +16 | 17 | expect('meta', 'D419: Docstring is empty') | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_D.py.snap index 541ef0be67956..5528751f71507 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:23:9: D102 Missing docstring in public method | @@ -42,5 +43,3 @@ D.py:659:9: D102 Missing docstring in public method | ^^^^^^^^^^^^^ D102 660 | pass | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_setter.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_setter.py.snap index 522d7c43ee1a0..7a9a4a2c1303b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_setter.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D102_setter.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- setter.py:16:9: D102 Missing docstring in public method | @@ -8,5 +9,3 @@ setter.py:16:9: D102 Missing docstring in public method | ^^^ D102 17 | pass | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D103_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D103_D.py.snap index 28944e8e097ec..3d9711e70311b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D103_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D103_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:400:5: D103 Missing docstring in public function | @@ -7,5 +8,3 @@ D.py:400:5: D103 Missing docstring in public function 400 | def oneliner_d102(): return | ^^^^^^^^^^^^^ D103 | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D104____init__.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D104____init__.py.snap index 5885932f5bacb..25f47b66c0ac3 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D104____init__.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D104_D104____init__.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- __init__.py:1:1: D104 Missing docstring in public package diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D105_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D105_D.py.snap index bc2595c1be4f0..4b8945a3c2ac8 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D105_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D105_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:64:9: D105 Missing docstring in magic method | @@ -8,5 +9,3 @@ D.py:64:9: D105 Missing docstring in magic method | ^^^^^^^ D105 65 | pass | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D106_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D106_D.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D106_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D106_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D107_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D107_D.py.snap index f1e639bedda6b..6fd782e2cee72 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D107_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D107_D.py.snap @@ -12,10 +12,8 @@ D.py:60:9: D107 Missing docstring in `__init__` D.py:534:9: D107 Missing docstring in `__init__` | 532 | """ -533 | +533 | 534 | def __init__(self, x): | ^^^^^^^^ D107 535 | pass | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D.py.snap index 85ada6d00fdb2..da2a88322f367 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D.py.snap @@ -5,8 +5,7 @@ D.py:129:5: D200 [*] One-line docstring should fit on one line | 127 | @expect('D212: Multi-line docstring summary should start at the first line') 128 | def asdlkfasd(): -129 | """ - | _____^ +129 | / """ 130 | | Wrong. 131 | | """ | |_______^ D200 @@ -29,9 +28,8 @@ D.py:597:5: D200 [*] One-line docstring should fit on one line | 595 | @expect('D212: Multi-line docstring summary should start at the first line') 596 | def one_liner(): -597 | """ - | _____^ -598 | | +597 | / """ +598 | | 599 | | Wrong.""" | |_____________^ D200 | @@ -53,9 +51,8 @@ D.py:606:5: D200 [*] One-line docstring should fit on one line | 604 | @expect('D212: Multi-line docstring summary should start at the first line') 605 | def one_liner(): -606 | r"""Wrong. - | _____^ -607 | | +606 | / r"""Wrong. +607 | | 608 | | """ | |_______^ D200 | @@ -77,9 +74,8 @@ D.py:615:5: D200 One-line docstring should fit on one line | 613 | @expect('D212: Multi-line docstring summary should start at the first line') 614 | def one_liner(): -615 | """Wrong." - | _____^ -616 | | +615 | / """Wrong." +616 | | 617 | | """ | |_______^ D200 | @@ -89,9 +85,8 @@ D.py:624:5: D200 One-line docstring should fit on one line | 622 | @expect('D212: Multi-line docstring summary should start at the first line') 623 | def one_liner(): -624 | """ - | _____^ -625 | | +624 | / """ +625 | | 626 | | "Wrong.""" | |______________^ D200 | @@ -100,13 +95,10 @@ D.py:624:5: D200 One-line docstring should fit on one line D.py:645:5: D200 One-line docstring should fit on one line | 644 | def single_line_docstring_with_an_escaped_backslash(): -645 | "\ - | _____^ +645 | / "\ 646 | | " | |_____^ D200 -647 | +647 | 648 | class StatementOnSameLineAsDocstring: | = help: Reformat to one line - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D200.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D200.py.snap index 9cae5fd5f9deb..5a77be745414f 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D200.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D200_D200.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D200.py:2:5: D200 One-line docstring should fit on one line | 1 | def func(): -2 | """\ - | _____^ +2 | / """\ 3 | | """ | |_______^ D200 | @@ -14,8 +13,7 @@ D200.py:2:5: D200 One-line docstring should fit on one line D200.py:7:5: D200 [*] One-line docstring should fit on one line | 6 | def func(): -7 | """\\ - | _____^ +7 | / """\\ 8 | | """ | |_______^ D200 | @@ -35,11 +33,8 @@ D200.py:7:5: D200 [*] One-line docstring should fit on one line D200.py:12:5: D200 One-line docstring should fit on one line | 11 | def func(): -12 | """\ \ - | _____^ +12 | / """\ \ 13 | | """ | |_______^ D200 | = help: Reformat to one line - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D201_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D201_D.py.snap index 977ac47b9d93c..b22486d55a9db 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D201_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D201_D.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D.py:137:5: D201 [*] No blank lines allowed before function docstring (found 1) | 135 | def leading_space(): -136 | +136 | 137 | """Leading space.""" | ^^^^^^^^^^^^^^^^^^^^ D201 | @@ -22,10 +22,10 @@ D.py:137:5: D201 [*] No blank lines allowed before function docstring (found 1) D.py:151:5: D201 [*] No blank lines allowed before function docstring (found 1) | 149 | def trailing_and_leading_space(): -150 | +150 | 151 | """Trailing and leading space.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D201 -152 | +152 | 153 | pass | = help: Remove blank line(s) before function docstring @@ -42,10 +42,9 @@ D.py:151:5: D201 [*] No blank lines allowed before function docstring (found 1) D.py:546:5: D201 [*] No blank lines allowed before function docstring (found 1) | 544 | def multiline_leading_space(): -545 | -546 | """Leading space. - | _____^ -547 | | +545 | +546 | / """Leading space. +547 | | 548 | | More content. 549 | | """ | |_______^ D201 @@ -64,14 +63,13 @@ D.py:546:5: D201 [*] No blank lines allowed before function docstring (found 1) D.py:568:5: D201 [*] No blank lines allowed before function docstring (found 1) | 566 | def multiline_trailing_and_leading_space(): -567 | -568 | """Trailing and leading space. - | _____^ -569 | | +567 | +568 | / """Trailing and leading space. +569 | | 570 | | More content. 571 | | """ | |_______^ D201 -572 | +572 | 573 | pass | = help: Remove blank line(s) before function docstring @@ -84,5 +82,3 @@ D.py:568:5: D201 [*] No blank lines allowed before function docstring (found 1) 568 567 | """Trailing and leading space. 569 568 | 570 569 | More content. - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D.py.snap index 8a67b2b1762d9..8852a6a690f66 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D.py.snap @@ -7,7 +7,7 @@ D.py:142:5: D202 [*] No blank lines allowed after function docstring (found 1) 141 | def trailing_space(): 142 | """Leading space.""" | ^^^^^^^^^^^^^^^^^^^^ D202 -143 | +143 | 144 | pass | = help: Remove blank line(s) after function docstring @@ -24,10 +24,10 @@ D.py:142:5: D202 [*] No blank lines allowed after function docstring (found 1) D.py:151:5: D202 [*] No blank lines allowed after function docstring (found 1) | 149 | def trailing_and_leading_space(): -150 | +150 | 151 | """Trailing and leading space.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D202 -152 | +152 | 153 | pass | = help: Remove blank line(s) after function docstring @@ -45,13 +45,12 @@ D.py:555:5: D202 [*] No blank lines allowed after function docstring (found 1) | 553 | @expect('D213: Multi-line docstring summary should start at the second line') 554 | def multiline_trailing_space(): -555 | """Leading space. - | _____^ -556 | | +555 | / """Leading space. +556 | | 557 | | More content. 558 | | """ | |_______^ D202 -559 | +559 | 560 | pass | = help: Remove blank line(s) after function docstring @@ -68,14 +67,13 @@ D.py:555:5: D202 [*] No blank lines allowed after function docstring (found 1) D.py:568:5: D202 [*] No blank lines allowed after function docstring (found 1) | 566 | def multiline_trailing_and_leading_space(): -567 | -568 | """Trailing and leading space. - | _____^ -569 | | +567 | +568 | / """Trailing and leading space. +569 | | 570 | | More content. 571 | | """ | |_______^ D202 -572 | +572 | 573 | pass | = help: Remove blank line(s) after function docstring @@ -87,6 +85,4 @@ D.py:568:5: D202 [*] No blank lines allowed after function docstring (found 1) 572 |- 573 572 | pass 574 573 | -575 574 | - - +575 574 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D202.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D202.py.snap index 90e915d1022aa..5d400736ed4a2 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D202.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D202_D202.py.snap @@ -45,7 +45,7 @@ D202.py:80:5: D202 [*] No blank lines allowed after function docstring (found 1) 79 | def outer(): 80 | """This is a docstring.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^ D202 -81 | +81 | 82 | # This is a comment. | = help: Remove blank line(s) after function docstring @@ -58,5 +58,3 @@ D202.py:80:5: D202 [*] No blank lines allowed after function docstring (found 1) 82 81 | # This is a comment. 83 82 | 84 83 | def inner(): - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D203_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D203_D.py.snap index 3ef6f3205fec5..741f6b8bb2b2a 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D203_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D203_D.py.snap @@ -40,16 +40,15 @@ D.py:526:5: D203 [*] 1 blank line required before class docstring | 524 | # parameters as functions for Google / Numpy conventions. 525 | class Blah: # noqa: D203,D213 -526 | """A Blah. - | _____^ -527 | | +526 | / """A Blah. +527 | | 528 | | Parameters 529 | | ---------- 530 | | x : int -531 | | +531 | | 532 | | """ | |_______^ D203 -533 | +533 | 534 | def __init__(self, x): | = help: Insert 1 blank line before class docstring @@ -117,5 +116,3 @@ D.py:658:5: D203 [*] 1 blank line required before class docstring 658 659 | "After this docstring there's a comment." # priorities=1 659 660 | def sort_services(self): 660 661 | pass - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D204_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D204_D.py.snap index 425f22147bb85..8f7d860a3cfe1 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D204_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D204_D.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D.py:181:5: D204 [*] 1 blank line required after class docstring | 179 | class TrailingSpace: -180 | +180 | 181 | """TrailingSpace.""" | ^^^^^^^^^^^^^^^^^^^^ D204 182 | pass @@ -97,6 +97,4 @@ D.py:658:5: D204 [*] 1 blank line required after class docstring 659 |+ 659 660 | def sort_services(self): 660 661 | pass -661 662 | - - +661 662 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D205_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D205_D.py.snap index 290cd8a05fccd..3c6ca2058018a 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D205_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D205_D.py.snap @@ -5,10 +5,9 @@ D.py:200:5: D205 1 blank line required between summary line and description | 198 | @expect('D213: Multi-line docstring summary should start at the second line') 199 | def multi_line_zero_separating_blanks(): -200 | """Summary. - | _____^ +200 | / """Summary. 201 | | Description. -202 | | +202 | | 203 | | """ | |_______^ D205 | @@ -18,12 +17,11 @@ D.py:210:5: D205 [*] 1 blank line required between summary line and description | 208 | @expect('D213: Multi-line docstring summary should start at the second line') 209 | def multi_line_two_separating_blanks(): -210 | """Summary. - | _____^ -211 | | -212 | | +210 | / """Summary. +211 | | +212 | | 213 | | Description. -214 | | +214 | | 215 | | """ | |_______^ D205 | @@ -37,5 +35,3 @@ D.py:210:5: D205 [*] 1 blank line required between summary line and description 213 212 | Description. 214 213 | 215 214 | """ - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D206_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D206_D.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D206_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D206_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D207_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D207_D.py.snap index d70f30883a4a4..e06aa71405ab2 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D207_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D207_D.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D.py:232:1: D207 [*] Docstring is under-indented | 230 | """Summary. -231 | +231 | 232 | Description. - | D207 -233 | + | ^ D207 +233 | 234 | """ | = help: Increase indentation @@ -25,9 +25,9 @@ D.py:232:1: D207 [*] Docstring is under-indented D.py:244:1: D207 [*] Docstring is under-indented | 242 | Description. -243 | +243 | 244 | """ - | D207 + | ^ D207 | = help: Increase indentation @@ -44,9 +44,9 @@ D.py:244:1: D207 [*] Docstring is under-indented D.py:440:1: D207 [*] Docstring is under-indented | 438 | def docstring_start_in_same_line(): """First Line. -439 | +439 | 440 | Second Line - | D207 + | ^ D207 441 | """ | = help: Increase indentation @@ -65,7 +65,7 @@ D.py:441:1: D207 [*] Docstring is under-indented | 440 | Second Line 441 | """ - | D207 + | ^ D207 | = help: Increase indentation @@ -78,5 +78,3 @@ D.py:441:1: D207 [*] Docstring is under-indented 442 442 | 443 443 | 444 444 | def function_with_lambda_arg(x=lambda y: y): - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D.py.snap index 5048d030c7dcd..c3ba66a565115 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D.py:252:1: D208 [*] Docstring is over-indented | 250 | """Summary. -251 | +251 | 252 | Description. - | D208 -253 | + | ^ D208 +253 | 254 | """ | = help: Remove over-indentation @@ -25,9 +25,9 @@ D.py:252:1: D208 [*] Docstring is over-indented D.py:264:1: D208 [*] Docstring is over-indented | 262 | Description. -263 | +263 | 264 | """ - | D208 + | ^ D208 | = help: Remove over-indentation @@ -44,10 +44,10 @@ D.py:264:1: D208 [*] Docstring is over-indented D.py:272:1: D208 [*] Docstring is over-indented | 270 | """Summary. -271 | +271 | 272 | Description. - | D208 -273 | + | ^ D208 +273 | 274 | """ | = help: Remove over-indentation @@ -65,9 +65,9 @@ D.py:272:1: D208 [*] Docstring is over-indented D.py:673:1: D208 [*] Docstring is over-indented | 671 | """Summary. -672 | +672 | 673 | This is overindented - | D208 + | ^ D208 674 | And so is this, but it we should preserve the extra space on this line relative 675 | to the one before | @@ -87,7 +87,7 @@ D.py:674:1: D208 [*] Docstring is over-indented | 673 | This is overindented 674 | And so is this, but it we should preserve the extra space on this line relative - | D208 + | ^ D208 675 | to the one before 676 | """ | @@ -108,7 +108,7 @@ D.py:675:1: D208 [*] Docstring is over-indented 673 | This is overindented 674 | And so is this, but it we should preserve the extra space on this line relative 675 | to the one before - | D208 + | ^ D208 676 | """ | = help: Remove over-indentation @@ -126,9 +126,9 @@ D.py:675:1: D208 [*] Docstring is over-indented D.py:682:1: D208 [*] Docstring is over-indented | 680 | """Summary. -681 | +681 | 682 | This is overindented - | D208 + | ^ D208 683 | And so is this, but it we should preserve the extra space on this line relative 684 | to the one before | @@ -148,7 +148,7 @@ D.py:683:1: D208 [*] Docstring is over-indented | 682 | This is overindented 683 | And so is this, but it we should preserve the extra space on this line relative - | D208 + | ^ D208 684 | to the one before 685 | This is also overindented | @@ -169,7 +169,7 @@ D.py:684:1: D208 [*] Docstring is over-indented 682 | This is overindented 683 | And so is this, but it we should preserve the extra space on this line relative 684 | to the one before - | D208 + | ^ D208 685 | This is also overindented 686 | And so is this, but it we should preserve the extra space on this line relative | @@ -190,7 +190,7 @@ D.py:685:1: D208 [*] Docstring is over-indented 683 | And so is this, but it we should preserve the extra space on this line relative 684 | to the one before 685 | This is also overindented - | D208 + | ^ D208 686 | And so is this, but it we should preserve the extra space on this line relative 687 | to the one before | @@ -211,7 +211,7 @@ D.py:686:1: D208 [*] Docstring is over-indented 684 | to the one before 685 | This is also overindented 686 | And so is this, but it we should preserve the extra space on this line relative - | D208 + | ^ D208 687 | to the one before 688 | """ | @@ -232,7 +232,7 @@ D.py:687:1: D208 [*] Docstring is over-indented 685 | This is also overindented 686 | And so is this, but it we should preserve the extra space on this line relative 687 | to the one before - | D208 + | ^ D208 688 | """ | = help: Remove over-indentation @@ -250,9 +250,9 @@ D.py:687:1: D208 [*] Docstring is over-indented D.py:695:1: D208 [*] Docstring is over-indented | 693 | """Summary. -694 | +694 | 695 | This is overindented - | D208 + | ^ D208 696 | And so is this, but it we should preserve the extra space on this line relative 697 | to the one before | @@ -272,7 +272,7 @@ D.py:696:1: D208 [*] Docstring is over-indented | 695 | This is overindented 696 | And so is this, but it we should preserve the extra space on this line relative - | D208 + | ^ D208 697 | to the one before 698 | And the relative indent here should be preserved too | @@ -293,7 +293,7 @@ D.py:697:1: D208 [*] Docstring is over-indented 695 | This is overindented 696 | And so is this, but it we should preserve the extra space on this line relative 697 | to the one before - | D208 + | ^ D208 698 | And the relative indent here should be preserved too 699 | """ | @@ -314,7 +314,7 @@ D.py:698:1: D208 [*] Docstring is over-indented 696 | And so is this, but it we should preserve the extra space on this line relative 697 | to the one before 698 | And the relative indent here should be preserved too - | D208 + | ^ D208 699 | """ | = help: Remove over-indentation @@ -332,9 +332,9 @@ D.py:698:1: D208 [*] Docstring is over-indented D.py:704:1: D208 [*] Docstring is over-indented | 702 | """Summary. -703 | +703 | 704 | This is overindented - | D208 + | ^ D208 705 | And so is this, but it we should preserve the extra space on this line relative 706 | This is overindented | @@ -354,7 +354,7 @@ D.py:705:1: D208 [*] Docstring is over-indented | 704 | This is overindented 705 | And so is this, but it we should preserve the extra space on this line relative - | D208 + | ^ D208 706 | This is overindented 707 | This is overindented | @@ -375,7 +375,7 @@ D.py:706:1: D208 [*] Docstring is over-indented 704 | This is overindented 705 | And so is this, but it we should preserve the extra space on this line relative 706 | This is overindented - | D208 + | ^ D208 707 | This is overindented 708 | """ | @@ -396,7 +396,7 @@ D.py:707:1: D208 [*] Docstring is over-indented 705 | And so is this, but it we should preserve the extra space on this line relative 706 | This is overindented 707 | This is overindented - | D208 + | ^ D208 708 | """ | = help: Remove over-indentation @@ -414,9 +414,9 @@ D.py:707:1: D208 [*] Docstring is over-indented D.py:723:1: D208 [*] Docstring is over-indented | 721 | """There's a non-breaking space (2-bytes) after 3 spaces (https://github.com/astral-sh/ruff/issues/9080). -722 | +722 | 723 |     Returns: - | D208 + | ^ D208 724 | """ | = help: Remove over-indentation @@ -428,5 +428,3 @@ D.py:723:1: D208 [*] Docstring is over-indented 723 |-     Returns: 723 |+ Returns: 724 724 | """ - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D208.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D208.py.snap index a2b5aad6540b8..afcfd6d347cf0 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D208.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D208_D208.py.snap @@ -5,7 +5,7 @@ D208.py:2:1: D208 [*] Docstring is over-indented | 1 | """ 2 | Author - | D208 + | ^ D208 3 | """ | = help: Remove over-indentation @@ -23,7 +23,7 @@ D208.py:8:1: D208 [*] Docstring is over-indented 6 | class Platform: 7 | """ Remove sampler 8 | Args: - | D208 + | ^ D208 9 |     Returns: 10 | """ | @@ -44,7 +44,7 @@ D208.py:9:1: D208 [*] Docstring is over-indented 7 | """ Remove sampler 8 | Args: 9 |     Returns: - | D208 + | ^ D208 10 | """ | = help: Remove over-indentation @@ -64,7 +64,7 @@ D208.py:10:1: D208 [*] Docstring is over-indented 8 | Args: 9 |     Returns: 10 | """ - | D208 + | ^ D208 | = help: Remove over-indentation @@ -83,7 +83,7 @@ D208.py:24:1: D208 [*] Docstring is over-indented 22 | Args: 23 | Returns: 24 | """ - | D208 + | ^ D208 | = help: Remove over-indentation @@ -102,7 +102,7 @@ D208.py:29:1: D208 [*] Docstring is over-indented 27 | class Platform: 28 | """All lines are over indented including the last containing the closing quotes 29 | Args: - | D208 + | ^ D208 30 | Returns: 31 | """ | @@ -123,7 +123,7 @@ D208.py:30:1: D208 [*] Docstring is over-indented 28 | """All lines are over indented including the last containing the closing quotes 29 | Args: 30 | Returns: - | D208 + | ^ D208 31 | """ | = help: Remove over-indentation @@ -143,8 +143,8 @@ D208.py:31:1: D208 [*] Docstring is over-indented 29 | Args: 30 | Returns: 31 | """ - | D208 -32 | + | ^ D208 +32 | 33 | class Platform: | = help: Remove over-indentation @@ -164,7 +164,7 @@ D208.py:35:1: D208 [*] Docstring is over-indented 33 | class Platform: 34 | """All lines are over indented including the last 35 | Args: - | D208 + | ^ D208 36 | Returns""" | = help: Remove over-indentation @@ -184,8 +184,8 @@ D208.py:36:1: D208 [*] Docstring is over-indented 34 | """All lines are over indented including the last 35 | Args: 36 | Returns""" - | D208 -37 | + | ^ D208 +37 | 38 | # OK: This doesn't get flagged because it is accepted when the closing quotes are on a separate line (see next test). Raises D209 | = help: Remove over-indentation diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D209_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D209_D.py.snap index 97495aa3191e7..abaf49d7afb2e 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D209_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D209_D.py.snap @@ -5,9 +5,8 @@ D.py:281:5: D209 [*] Multi-line docstring closing quotes should be on a separate | 279 | @expect('D213: Multi-line docstring summary should start at the second line') 280 | def asdfljdf24(): -281 | """Summary. - | _____^ -282 | | +281 | / """Summary. +282 | | 283 | | Description.""" | |___________________^ D209 | @@ -28,9 +27,8 @@ D.py:588:5: D209 [*] Multi-line docstring closing quotes should be on a separate | 586 | @expect('D213: Multi-line docstring summary should start at the second line') 587 | def asdfljdjgf24(): -588 | """Summary. - | _____^ -589 | | +588 | / """Summary. +589 | | 590 | | Description. """ | |_____________________^ D209 | @@ -46,5 +44,3 @@ D.py:588:5: D209 [*] Multi-line docstring closing quotes should be on a separate 591 592 | 592 593 | 593 594 | @expect('D200: One-line docstring should fit on one line with quotes ' - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D210_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D210_D.py.snap index 29b6fe31604c9..a964004890030 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D210_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D210_D.py.snap @@ -43,9 +43,8 @@ D.py:299:5: D210 [*] No whitespaces allowed surrounding docstring text | 297 | @expect('D213: Multi-line docstring summary should start at the second line') 298 | def multiline(): -299 | """ Whitespace at the beginning. - | _____^ -300 | | +299 | / """ Whitespace at the beginning. +300 | | 301 | | This is the end. 302 | | """ | |_______^ D210 @@ -70,5 +69,3 @@ D.py:581:5: D210 No whitespaces allowed surrounding docstring text | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D210 | = help: Trim surrounding whitespace - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D211_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D211_D.py.snap index f89dc69584eeb..affb5b409ec57 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D211_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D211_D.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D.py:170:5: D211 [*] No blank lines allowed before class docstring | 168 | class WithLeadingSpace: -169 | +169 | 170 | """With leading space.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^ D211 | @@ -22,7 +22,7 @@ D.py:170:5: D211 [*] No blank lines allowed before class docstring D.py:181:5: D211 [*] No blank lines allowed before class docstring | 179 | class TrailingSpace: -180 | +180 | 181 | """TrailingSpace.""" | ^^^^^^^^^^^^^^^^^^^^ D211 182 | pass @@ -36,6 +36,4 @@ D.py:181:5: D211 [*] No blank lines allowed before class docstring 180 |- 181 180 | """TrailingSpace.""" 182 181 | pass -183 182 | - - +183 182 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D212_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D212_D.py.snap index c37abb9572d59..5e8b8881c2f45 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D212_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D212_D.py.snap @@ -5,8 +5,7 @@ D.py:129:5: D212 [*] Multi-line docstring summary should start at the first line | 127 | @expect('D212: Multi-line docstring summary should start at the first line') 128 | def asdlkfasd(): -129 | """ - | _____^ +129 | / """ 130 | | Wrong. 131 | | """ | |_______^ D212 @@ -28,9 +27,8 @@ D.py:597:5: D212 [*] Multi-line docstring summary should start at the first line | 595 | @expect('D212: Multi-line docstring summary should start at the first line') 596 | def one_liner(): -597 | """ - | _____^ -598 | | +597 | / """ +598 | | 599 | | Wrong.""" | |_____________^ D212 | @@ -52,9 +50,8 @@ D.py:624:5: D212 [*] Multi-line docstring summary should start at the first line | 622 | @expect('D212: Multi-line docstring summary should start at the first line') 623 | def one_liner(): -624 | """ - | _____^ -625 | | +624 | / """ +625 | | 626 | | "Wrong.""" | |______________^ D212 | @@ -71,5 +68,3 @@ D.py:624:5: D212 [*] Multi-line docstring summary should start at the first line 627 625 | 628 626 | 629 627 | @expect('D404: First word of the docstring should not be "This"') - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D213_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D213_D.py.snap index 0253bc44cd427..66aa330b5a8e2 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D213_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D213_D.py.snap @@ -5,10 +5,9 @@ D.py:200:5: D213 [*] Multi-line docstring summary should start at the second lin | 198 | @expect('D213: Multi-line docstring summary should start at the second line') 199 | def multi_line_zero_separating_blanks(): -200 | """Summary. - | _____^ +200 | / """Summary. 201 | | Description. -202 | | +202 | | 203 | | """ | |_______^ D213 | @@ -29,12 +28,11 @@ D.py:210:5: D213 [*] Multi-line docstring summary should start at the second lin | 208 | @expect('D213: Multi-line docstring summary should start at the second line') 209 | def multi_line_two_separating_blanks(): -210 | """Summary. - | _____^ -211 | | -212 | | +210 | / """Summary. +211 | | +212 | | 213 | | Description. -214 | | +214 | | 215 | | """ | |_______^ D213 | @@ -55,11 +53,10 @@ D.py:220:5: D213 [*] Multi-line docstring summary should start at the second lin | 218 | @expect('D213: Multi-line docstring summary should start at the second line') 219 | def multi_line_one_separating_blanks(): -220 | """Summary. - | _____^ -221 | | +220 | / """Summary. +221 | | 222 | | Description. -223 | | +223 | | 224 | | """ | |_______^ D213 | @@ -80,11 +77,10 @@ D.py:230:5: D213 [*] Multi-line docstring summary should start at the second lin | 228 | @expect('D213: Multi-line docstring summary should start at the second line') 229 | def asdfsdf(): -230 | """Summary. - | _____^ -231 | | +230 | / """Summary. +231 | | 232 | | Description. -233 | | +233 | | 234 | | """ | |_______^ D213 | @@ -105,11 +101,10 @@ D.py:240:5: D213 [*] Multi-line docstring summary should start at the second lin | 238 | @expect('D213: Multi-line docstring summary should start at the second line') 239 | def asdsdfsdffsdf(): -240 | """Summary. - | _____^ -241 | | +240 | / """Summary. +241 | | 242 | | Description. -243 | | +243 | | 244 | | """ | |___^ D213 | @@ -130,11 +125,10 @@ D.py:250:5: D213 [*] Multi-line docstring summary should start at the second lin | 248 | @expect('D213: Multi-line docstring summary should start at the second line') 249 | def asdfsdsdf24(): -250 | """Summary. - | _____^ -251 | | +250 | / """Summary. +251 | | 252 | | Description. -253 | | +253 | | 254 | | """ | |_______^ D213 | @@ -155,11 +149,10 @@ D.py:260:5: D213 [*] Multi-line docstring summary should start at the second lin | 258 | @expect('D213: Multi-line docstring summary should start at the second line') 259 | def asdfsdsdfsdf24(): -260 | """Summary. - | _____^ -261 | | +260 | / """Summary. +261 | | 262 | | Description. -263 | | +263 | | 264 | | """ | |___________^ D213 | @@ -180,11 +173,10 @@ D.py:270:5: D213 [*] Multi-line docstring summary should start at the second lin | 268 | @expect('D213: Multi-line docstring summary should start at the second line') 269 | def asdfsdfsdsdsdfsdf24(): -270 | """Summary. - | _____^ -271 | | +270 | / """Summary. +271 | | 272 | | Description. -273 | | +273 | | 274 | | """ | |_______^ D213 | @@ -205,9 +197,8 @@ D.py:281:5: D213 [*] Multi-line docstring summary should start at the second lin | 279 | @expect('D213: Multi-line docstring summary should start at the second line') 280 | def asdfljdf24(): -281 | """Summary. - | _____^ -282 | | +281 | / """Summary. +282 | | 283 | | Description.""" | |___________________^ D213 | @@ -228,9 +219,8 @@ D.py:299:5: D213 [*] Multi-line docstring summary should start at the second lin | 297 | @expect('D213: Multi-line docstring summary should start at the second line') 298 | def multiline(): -299 | """ Whitespace at the beginning. - | _____^ -300 | | +299 | / """ Whitespace at the beginning. +300 | | 301 | | This is the end. 302 | | """ | |_______^ D213 @@ -252,9 +242,8 @@ D.py:343:5: D213 [*] Multi-line docstring summary should start at the second lin | 341 | @expect('D213: Multi-line docstring summary should start at the second line') 342 | def exceptions_of_D301(): -343 | """Exclude some backslashes from D301. - | _____^ -344 | | +343 | / """Exclude some backslashes from D301. +344 | | 345 | | In particular, line continuations \ 346 | | and unicode literals \u0394 and \N{GREEK CAPITAL LETTER DELTA}. 347 | | They are considered to be intentionally unescaped. @@ -278,9 +267,8 @@ D.py:383:5: D213 [*] Multi-line docstring summary should start at the second lin | 381 | @expect('D213: Multi-line docstring summary should start at the second line') 382 | def new_209(): -383 | """First line. - | _____^ -384 | | +383 | / """First line. +384 | | 385 | | More lines. 386 | | """ | |_______^ D213 @@ -303,11 +291,10 @@ D.py:392:5: D213 [*] Multi-line docstring summary should start at the second lin | 390 | @expect('D213: Multi-line docstring summary should start at the second line') 391 | def old_209(): -392 | """One liner. - | _____^ -393 | | +392 | / """One liner. +393 | | 394 | | Multi-line comments. OK to have extra blank line -395 | | +395 | | 396 | | """ | |_______^ D213 | @@ -330,7 +317,7 @@ D.py:438:37: D213 [*] Multi-line docstring summary should start at the second li 437 | @expect('D213: Multi-line docstring summary should start at the second line') 438 | def docstring_start_in_same_line(): """First Line. | _____________________________________^ -439 | | +439 | | 440 | | Second Line 441 | | """ | |_______^ D213 @@ -352,11 +339,10 @@ D.py:450:5: D213 [*] Multi-line docstring summary should start at the second lin | 448 | @expect('D213: Multi-line docstring summary should start at the second line') 449 | def a_following_valid_function(x=None): -450 | """Check for a bug where the previous function caused an assertion. - | _____^ -451 | | +450 | / """Check for a bug where the previous function caused an assertion. +451 | | 452 | | The assertion was caused in the next function, so this one is necessary. -453 | | +453 | | 454 | | """ | |_______^ D213 | @@ -377,16 +363,15 @@ D.py:526:5: D213 [*] Multi-line docstring summary should start at the second lin | 524 | # parameters as functions for Google / Numpy conventions. 525 | class Blah: # noqa: D203,D213 -526 | """A Blah. - | _____^ -527 | | +526 | / """A Blah. +527 | | 528 | | Parameters 529 | | ---------- 530 | | x : int -531 | | +531 | | 532 | | """ | |_______^ D213 -533 | +533 | 534 | def __init__(self, x): | = help: Insert line break and indentation after opening quotes @@ -405,10 +390,9 @@ D.py:526:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:546:5: D213 [*] Multi-line docstring summary should start at the second line | 544 | def multiline_leading_space(): -545 | -546 | """Leading space. - | _____^ -547 | | +545 | +546 | / """Leading space. +547 | | 548 | | More content. 549 | | """ | |_______^ D213 @@ -430,13 +414,12 @@ D.py:555:5: D213 [*] Multi-line docstring summary should start at the second lin | 553 | @expect('D213: Multi-line docstring summary should start at the second line') 554 | def multiline_trailing_space(): -555 | """Leading space. - | _____^ -556 | | +555 | / """Leading space. +556 | | 557 | | More content. 558 | | """ | |_______^ D213 -559 | +559 | 560 | pass | = help: Insert line break and indentation after opening quotes @@ -455,14 +438,13 @@ D.py:555:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:568:5: D213 [*] Multi-line docstring summary should start at the second line | 566 | def multiline_trailing_and_leading_space(): -567 | -568 | """Trailing and leading space. - | _____^ -569 | | +567 | +568 | / """Trailing and leading space. +569 | | 570 | | More content. 571 | | """ | |_______^ D213 -572 | +572 | 573 | pass | = help: Insert line break and indentation after opening quotes @@ -482,9 +464,8 @@ D.py:588:5: D213 [*] Multi-line docstring summary should start at the second lin | 586 | @expect('D213: Multi-line docstring summary should start at the second line') 587 | def asdfljdjgf24(): -588 | """Summary. - | _____^ -589 | | +588 | / """Summary. +589 | | 590 | | Description. """ | |_____________________^ D213 | @@ -505,9 +486,8 @@ D.py:606:5: D213 [*] Multi-line docstring summary should start at the second lin | 604 | @expect('D212: Multi-line docstring summary should start at the first line') 605 | def one_liner(): -606 | r"""Wrong. - | _____^ -607 | | +606 | / r"""Wrong. +607 | | 608 | | """ | |_______^ D213 | @@ -528,9 +508,8 @@ D.py:615:5: D213 [*] Multi-line docstring summary should start at the second lin | 613 | @expect('D212: Multi-line docstring summary should start at the first line') 614 | def one_liner(): -615 | """Wrong." - | _____^ -616 | | +615 | / """Wrong." +616 | | 617 | | """ | |_______^ D213 | @@ -550,9 +529,8 @@ D.py:615:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:671:5: D213 [*] Multi-line docstring summary should start at the second line | 670 | def retain_extra_whitespace(): -671 | """Summary. - | _____^ -672 | | +671 | / """Summary. +672 | | 673 | | This is overindented 674 | | And so is this, but it we should preserve the extra space on this line relative 675 | | to the one before @@ -575,9 +553,8 @@ D.py:671:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:680:5: D213 [*] Multi-line docstring summary should start at the second line | 679 | def retain_extra_whitespace_multiple(): -680 | """Summary. - | _____^ -681 | | +680 | / """Summary. +681 | | 682 | | This is overindented 683 | | And so is this, but it we should preserve the extra space on this line relative 684 | | to the one before @@ -603,16 +580,15 @@ D.py:680:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:693:5: D213 [*] Multi-line docstring summary should start at the second line | 692 | def retain_extra_whitespace_deeper(): -693 | """Summary. - | _____^ -694 | | +693 | / """Summary. +694 | | 695 | | This is overindented 696 | | And so is this, but it we should preserve the extra space on this line relative 697 | | to the one before 698 | | And the relative indent here should be preserved too 699 | | """ | |_______^ D213 -700 | +700 | 701 | def retain_extra_whitespace_followed_by_same_offset(): | = help: Insert line break and indentation after opening quotes @@ -631,9 +607,8 @@ D.py:693:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:702:5: D213 [*] Multi-line docstring summary should start at the second line | 701 | def retain_extra_whitespace_followed_by_same_offset(): -702 | """Summary. - | _____^ -703 | | +702 | / """Summary. +703 | | 704 | | This is overindented 705 | | And so is this, but it we should preserve the extra space on this line relative 706 | | This is overindented @@ -657,9 +632,8 @@ D.py:702:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:712:5: D213 [*] Multi-line docstring summary should start at the second line | 711 | def retain_extra_whitespace_not_overindented(): -712 | """Summary. - | _____^ -713 | | +712 | / """Summary. +713 | | 714 | | This is not overindented 715 | | This is overindented, but since one line is not overindented this should not raise 716 | | And so is this, but it we should preserve the extra space on this line relative @@ -682,9 +656,8 @@ D.py:712:5: D213 [*] Multi-line docstring summary should start at the second lin D.py:721:5: D213 [*] Multi-line docstring summary should start at the second line | 720 | def inconsistent_indent_byte_size(): -721 | """There's a non-breaking space (2-bytes) after 3 spaces (https://github.com/astral-sh/ruff/issues/9080). - | _____^ -722 | | +721 | / """There's a non-breaking space (2-bytes) after 3 spaces (https://github.com/astral-sh/ruff/issues/9080). +722 | | 723 | |     Returns: 724 | | """ | |_______^ D213 @@ -701,5 +674,3 @@ D.py:721:5: D213 [*] Multi-line docstring summary should start at the second lin 722 723 | 723 724 |     Returns: 724 725 | """ - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_D214_module.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_D214_module.py.snap index c95abffdad67b..dc344a0cc0918 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_D214_module.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_D214_module.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D214_module.py:3:5: D214 [*] Section is over-indented ("Returns") | 1 | """A module docstring with D214 violations -2 | +2 | 3 | Returns | ^^^^^^^ D214 4 | ----- @@ -24,7 +24,7 @@ D214_module.py:3:5: D214 [*] Section is over-indented ("Returns") D214_module.py:7:5: D214 [*] Section is over-indented ("Args") | 5 | valid returns -6 | +6 | 7 | Args | ^^^^ D214 8 | ----- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_sections.py.snap index 89f47fa2c67b6..371f690de1874 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D214_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:146:9: D214 [*] Section is over-indented ("Returns") | 144 | """Toggle the gizmo. -145 | +145 | 146 | Returns | ^^^^^^^ D214 147 | ------- @@ -25,7 +25,7 @@ sections.py:146:9: D214 [*] Section is over-indented ("Returns") sections.py:563:9: D214 [*] Section is over-indented ("Returns") | 561 | Here's a note. -562 | +562 | 563 | Returns: | ^^^^^^^ D214 564 | """ diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_D215.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_D215.py.snap index b93074fda8c98..eba14e8fcb762 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_D215.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_D215.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D215.py:3:5: D215 [*] Section underline is over-indented ("TODO") | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_sections.py.snap index afbd747fbd769..c3c2adcd329c8 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D215_sections.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- sections.py:159:9: D215 [*] Section underline is over-indented ("Returns") | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D.py.snap index 7f14c7fe4c8ca..23ef16355041c 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D.py.snap @@ -99,11 +99,10 @@ D.py:328:5: D300 [*] Use triple double quotes `"""` D.py:645:5: D300 [*] Use triple double quotes `"""` | 644 | def single_line_docstring_with_an_escaped_backslash(): -645 | "\ - | _____^ +645 | / "\ 646 | | " | |_____^ D300 -647 | +647 | 648 | class StatementOnSameLineAsDocstring: | = help: Convert to triple double quotes @@ -181,8 +180,7 @@ D.py:658:5: D300 [*] Use triple double quotes `"""` D.py:664:5: D300 [*] Use triple double quotes `"""` | 663 | def newline_after_closing_quote(self): -664 | "We enforce a newline after the closing quote for a multi-line docstring \ - | _____^ +664 | / "We enforce a newline after the closing quote for a multi-line docstring \ 665 | | but continuations shouldn't be considered multi-line" | |_________________________________________________________^ D300 | @@ -198,6 +196,4 @@ D.py:664:5: D300 [*] Use triple double quotes `"""` 665 |+ but continuations shouldn't be considered multi-line""" 666 666 | 667 667 | -668 668 | - - +668 668 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D300.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D300.py.snap index 2e3fedcf3d496..81fcb9d3f3653 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D300.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D300_D300.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D300.py:6:5: D300 Use triple double quotes `"""` | @@ -26,5 +27,3 @@ D300.py:10:5: D300 [*] Use triple double quotes `"""` 11 11 | 12 12 | 13 13 | # OK - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D.py.snap index 8c21aeac86c68..9da29e5fbc152 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:333:5: D301 [*] Use `r"""` if any backslashes in a docstring | @@ -19,5 +20,3 @@ D.py:333:5: D301 [*] Use `r"""` if any backslashes in a docstring 334 334 | 335 335 | 336 336 | @expect('D301: Use r""" if any backslashes in a docstring') - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D301.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D301.py.snap index 2d729186933d7..ffd336a556550 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D301.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D301_D301.py.snap @@ -28,8 +28,7 @@ D301.py:37:5: D301 Use `r"""` if any backslashes in a docstring D301.py:93:5: D301 [*] Use `r"""` if any backslashes in a docstring | 92 | def should_add_raw_for_single_double_quote_escape(): -93 | """ - | _____^ +93 | / """ 94 | | This is single quote escape \". 95 | | """ | |_______^ D301 @@ -49,8 +48,7 @@ D301.py:93:5: D301 [*] Use `r"""` if any backslashes in a docstring D301.py:99:5: D301 [*] Use `r"""` if any backslashes in a docstring | 98 | def should_add_raw_for_single_single_quote_escape(): - 99 | ''' - | _____^ + 99 | / ''' 100 | | This is single quote escape \'. 101 | | ''' | |_______^ D301 diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D.py.snap index 9953a0c2ef192..f61fcc94b928f 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D.py.snap @@ -244,9 +244,8 @@ D.py:615:5: D400 [*] First line should end with a period | 613 | @expect('D212: Multi-line docstring summary should start at the first line') 614 | def one_liner(): -615 | """Wrong." - | _____^ -616 | | +615 | / """Wrong." +616 | | 617 | | """ | |_______^ D400 | @@ -266,7 +265,7 @@ D.py:639:17: D400 [*] First line should end with a period | 639 | class SameLine: """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D400 -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | = help: Add period @@ -284,7 +283,7 @@ D.py:639:17: D400 [*] First line should end with a period D.py:641:18: D400 [*] First line should end with a period | 639 | class SameLine: """This is a docstring on the same line""" -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D400 | @@ -303,8 +302,7 @@ D.py:641:18: D400 [*] First line should end with a period D.py:664:5: D400 [*] First line should end with a period | 663 | def newline_after_closing_quote(self): -664 | "We enforce a newline after the closing quote for a multi-line docstring \ - | _____^ +664 | / "We enforce a newline after the closing quote for a multi-line docstring \ 665 | | but continuations shouldn't be considered multi-line" | |_________________________________________________________^ D400 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400.py.snap index f7a9059cce9bd..752bf81900d2e 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400.py.snap @@ -40,8 +40,7 @@ D400.py:7:5: D400 [*] First line should end with a period D400.py:12:5: D400 [*] First line should end with a period | 11 | def f(): -12 | """ - | _____^ +12 | / """ 13 | | Here's a line without a period, 14 | | but here's the next line 15 | | """ @@ -82,8 +81,7 @@ D400.py:20:5: D400 [*] First line should end with a period D400.py:25:5: D400 [*] First line should end with a period | 24 | def f(): -25 | """ - | _____^ +25 | / """ 26 | | Here's a line without a period, 27 | | but here's the next line""" | |_______________________________^ D400 @@ -104,8 +102,7 @@ D400.py:25:5: D400 [*] First line should end with a period D400.py:32:5: D400 [*] First line should end with a period | 31 | def f(): -32 | """ - | _____^ +32 | / """ 33 | | Here's a line without a period, 34 | | but here's the next line with trailing space """ | |____________________________________________________^ D400 @@ -164,8 +161,7 @@ D400.py:44:5: D400 [*] First line should end with a period D400.py:49:5: D400 [*] First line should end with a period | 48 | def f(): -49 | r""" - | _____^ +49 | / r""" 50 | | Here's a line without a period, 51 | | but here's the next line 52 | | """ @@ -206,8 +202,7 @@ D400.py:57:5: D400 [*] First line should end with a period D400.py:62:5: D400 [*] First line should end with a period | 61 | def f(): -62 | r""" - | _____^ +62 | / r""" 63 | | Here's a line without a period, 64 | | but here's the next line""" | |_______________________________^ D400 @@ -228,8 +223,7 @@ D400.py:62:5: D400 [*] First line should end with a period D400.py:69:5: D400 [*] First line should end with a period | 68 | def f(): -69 | r""" - | _____^ +69 | / r""" 70 | | Here's a line without a period, 71 | | but here's the next line with trailing space """ | |____________________________________________________^ D400 @@ -250,11 +244,10 @@ D400.py:69:5: D400 [*] First line should end with a period D400.py:97:5: D400 [*] First line should end with a period | 96 | def f(): - 97 | """ - | _____^ + 97 | / """ 98 | | My example 99 | | ========== -100 | | +100 | | 101 | | My example explanation 102 | | """ | |_______^ D400 @@ -270,5 +263,3 @@ D400.py:97:5: D400 [*] First line should end with a period 99 99 | ========== 100 100 | 101 101 | My example explanation - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400_415.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400_415.py.snap index d4dd5303ed636..de2d6b0996480 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400_415.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D400_D400_415.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D400_415.py:2:5: D400 First line should end with a period | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D401_D401.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D401_D401.py.snap index b172f391a82e6..d649ee60dc961 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D401_D401.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D401_D401.py.snap @@ -18,11 +18,10 @@ D401.py:14:5: D401 First line of docstring should be in imperative mood: "Constr D401.py:18:5: D401 First line of docstring should be in imperative mood: "Constructor for a boa." | 17 | def bad_sdgfsdg23245777(): -18 | """ - | _____^ -19 | | +18 | / """ +19 | | 20 | | Constructor for a boa. -21 | | +21 | | 22 | | """ | |_______^ D401 | @@ -32,7 +31,7 @@ D401.py:26:5: D401 First line of docstring should be in imperative mood: "Runs s 25 | def bad_run_something(): 26 | """Runs something""" | ^^^^^^^^^^^^^^^^^^^^ D401 -27 | +27 | 28 | def bad_nested(): | @@ -41,15 +40,14 @@ D401.py:29:9: D401 First line of docstring should be in imperative mood: "Runs o 28 | def bad_nested(): 29 | """Runs other things, nested""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D401 -30 | +30 | 31 | bad_nested() | D401.py:35:5: D401 First line of docstring should be in imperative mood: "Writes a logical line that" | 34 | def multi_line(): -35 | """Writes a logical line that - | _____^ +35 | / """Writes a logical line that 36 | | extends to two physical lines. 37 | | """ | |_______^ D401 @@ -60,8 +58,6 @@ D401.py:74:9: D401 First line of docstring should be in imperative mood: "This m 73 | def bad_method(self): 74 | """This method docstring should be written in imperative mood.""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D401 -75 | +75 | 76 | @property | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D.py.snap index d2a3fedef845c..be6c3676b7f81 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:378:5: D402 First line should not be the function's signature | @@ -8,5 +9,3 @@ D.py:378:5: D402 First line should not be the function's signature 378 | """Signature: foobar().""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^ D402 | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D402.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D402.py.snap index ce5ec50a89880..1c23d91dc91d7 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D402.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D402_D402.py.snap @@ -6,7 +6,7 @@ D402.py:2:5: D402 First line should not be the function's signature 1 | def foo(): 2 | """Returns foo().""" | ^^^^^^^^^^^^^^^^^^^^ D402 -3 | +3 | 4 | def foo(): | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D403.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D403.py.snap index 07a0589fb11fc..201b1f68a55d5 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D403.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D403_D403.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs --- -D403.py:2:5: D403 [*] First word of the first line should be capitalized: `this` -> `This` +D403.py:2:5: D403 [*] First word of the docstring should be capitalized: `this` -> `This` | 1 | def bad_function(): 2 | """this docstring is not capitalized""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D403 -3 | +3 | 4 | def good_function(): | = help: Capitalize `this` to `This` @@ -19,12 +19,12 @@ D403.py:2:5: D403 [*] First word of the first line should be capitalized: `this` 4 4 | def good_function(): 5 5 | """This docstring is capitalized.""" -D403.py:30:5: D403 [*] First word of the first line should be capitalized: `singleword` -> `Singleword` +D403.py:30:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` | 29 | def single_word(): 30 | """singleword.""" | ^^^^^^^^^^^^^^^^^ D403 -31 | +31 | 32 | def single_word_no_dot(): | = help: Capitalize `singleword` to `Singleword` @@ -39,11 +39,13 @@ D403.py:30:5: D403 [*] First word of the first line should be capitalized: `sing 32 32 | def single_word_no_dot(): 33 33 | """singleword""" -D403.py:33:5: D403 [*] First word of the first line should be capitalized: `singleword` -> `Singleword` +D403.py:33:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` | 32 | def single_word_no_dot(): 33 | """singleword""" | ^^^^^^^^^^^^^^^^ D403 +34 | +35 | def first_word_lots_of_whitespace(): | = help: Capitalize `singleword` to `Singleword` @@ -53,3 +55,213 @@ D403.py:33:5: D403 [*] First word of the first line should be capitalized: `sing 32 32 | def single_word_no_dot(): 33 |- """singleword""" 33 |+ """Singleword""" +34 34 | +35 35 | def first_word_lots_of_whitespace(): +36 36 | """ + +D403.py:36:5: D403 [*] First word of the docstring should be capitalized: `here` -> `Here` + | +35 | def first_word_lots_of_whitespace(): +36 | / """ +37 | | +38 | | +39 | | +40 | | here is the start of my docstring! +41 | | +42 | | What do you think? +43 | | """ + | |_______^ D403 +44 | +45 | def single_word_newline(): + | + = help: Capitalize `here` to `Here` + +ℹ Safe fix +37 37 | +38 38 | +39 39 | +40 |- here is the start of my docstring! + 40 |+ Here is the start of my docstring! +41 41 | +42 42 | What do you think? +43 43 | """ + +D403.py:46:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +45 | def single_word_newline(): +46 | / """singleword +47 | | +48 | | """ + | |_______^ D403 +49 | +50 | def single_word_dot_newline(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +43 43 | """ +44 44 | +45 45 | def single_word_newline(): +46 |- """singleword + 46 |+ """Singleword +47 47 | +48 48 | """ +49 49 | + +D403.py:51:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +50 | def single_word_dot_newline(): +51 | / """singleword. +52 | | +53 | | """ + | |_______^ D403 +54 | +55 | def single_word_second_line(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +48 48 | """ +49 49 | +50 50 | def single_word_dot_newline(): +51 |- """singleword. + 51 |+ """Singleword. +52 52 | +53 53 | """ +54 54 | + +D403.py:56:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +55 | def single_word_second_line(): +56 | / """ +57 | | singleword +58 | | """ + | |_______^ D403 +59 | +60 | def single_word_dot_second_line(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +54 54 | +55 55 | def single_word_second_line(): +56 56 | """ +57 |- singleword + 57 |+ Singleword +58 58 | """ +59 59 | +60 60 | def single_word_dot_second_line(): + +D403.py:61:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +60 | def single_word_dot_second_line(): +61 | / """ +62 | | singleword. +63 | | """ + | |_______^ D403 +64 | +65 | def single_word_then_more_text(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +59 59 | +60 60 | def single_word_dot_second_line(): +61 61 | """ +62 |- singleword. + 62 |+ Singleword. +63 63 | """ +64 64 | +65 65 | def single_word_then_more_text(): + +D403.py:66:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +65 | def single_word_then_more_text(): +66 | / """singleword +67 | | +68 | | This is more text. +69 | | """ + | |_______^ D403 +70 | +71 | def single_word_dot_then_more_text(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +63 63 | """ +64 64 | +65 65 | def single_word_then_more_text(): +66 |- """singleword + 66 |+ """Singleword +67 67 | +68 68 | This is more text. +69 69 | """ + +D403.py:72:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +71 | def single_word_dot_then_more_text(): +72 | / """singleword. +73 | | +74 | | This is more text. +75 | | """ + | |_______^ D403 +76 | +77 | def single_word_second_line_then_more_text(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +69 69 | """ +70 70 | +71 71 | def single_word_dot_then_more_text(): +72 |- """singleword. + 72 |+ """Singleword. +73 73 | +74 74 | This is more text. +75 75 | """ + +D403.py:78:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +77 | def single_word_second_line_then_more_text(): +78 | / """ +79 | | singleword +80 | | +81 | | This is more text. +82 | | """ + | |_______^ D403 +83 | +84 | def single_word_dot_second_line_then_more_text(): + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +76 76 | +77 77 | def single_word_second_line_then_more_text(): +78 78 | """ +79 |- singleword + 79 |+ Singleword +80 80 | +81 81 | This is more text. +82 82 | """ + +D403.py:85:5: D403 [*] First word of the docstring should be capitalized: `singleword` -> `Singleword` + | +84 | def single_word_dot_second_line_then_more_text(): +85 | / """ +86 | | singleword. +87 | | +88 | | This is more text. +89 | | """ + | |_______^ D403 + | + = help: Capitalize `singleword` to `Singleword` + +ℹ Safe fix +83 83 | +84 84 | def single_word_dot_second_line_then_more_text(): +85 85 | """ +86 |- singleword. + 86 |+ Singleword. +87 87 | +88 88 | This is more text. +89 89 | """ diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D404_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D404_D.py.snap index 4f75df8c0fc7f..dec763cf08b64 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D404_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D404_D.py.snap @@ -21,16 +21,14 @@ D.py:639:17: D404 First word of the docstring should not be "This" | 639 | class SameLine: """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D404 -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | D.py:641:18: D404 First word of the docstring should not be "This" | 639 | class SameLine: """This is a docstring on the same line""" -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D404 | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D405_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D405_sections.py.snap index 2aff3caaa0427..840beb1830d34 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D405_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D405_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:19:5: D405 [*] Section name should be properly capitalized ("returns") | 17 | """Toggle the gizmo. -18 | +18 | 19 | returns | ^^^^^^^ D405 20 | ------- @@ -25,7 +25,7 @@ sections.py:19:5: D405 [*] Section name should be properly capitalized ("returns sections.py:218:5: D405 [*] Section name should be properly capitalized ("Short summary") | 216 | """Toggle the gizmo. -217 | +217 | 218 | Short summary | ^^^^^^^^^^^^^ D405 219 | ------------- @@ -41,3 +41,24 @@ sections.py:218:5: D405 [*] Section name should be properly capitalized ("Short 219 219 | ------------- 220 220 | 221 221 | This is the function's description, which will also specify what it + +sections.py:573:5: D405 [*] Section name should be properly capitalized ("returns") + | +571 | arg: Here's a note. +572 | +573 | returns: + | ^^^^^^^ D405 +574 | Here's another note. +575 | """ + | + = help: Capitalize "returns" + +ℹ Safe fix +570 570 | Args: +571 571 | arg: Here's a note. +572 572 | +573 |- returns: + 573 |+ Returns: +574 574 | Here's another note. +575 575 | """ +576 576 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D406_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D406_sections.py.snap index b64a36dc51e68..d5914e8da677d 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D406_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D406_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:32:5: D406 [*] Section name should end with a newline ("Returns") | 30 | """Toggle the gizmo. -31 | +31 | 32 | Returns: | ^^^^^^^ D406 33 | ------- @@ -42,23 +42,23 @@ sections.py:227:5: D406 [*] Section name should end with a newline ("Raises") 229 229 | 230 230 | """ -sections.py:590:5: D406 [*] Section name should end with a newline ("Parameters") +sections.py:601:5: D406 [*] Section name should end with a newline ("Parameters") | -588 | """Test that lower case subsection header is valid even if it has the same name as section kind. -589 | -590 | Parameters: +599 | """Test that lower case subsection header is valid even if it has the same name as section kind. +600 | +601 | Parameters: | ^^^^^^^^^^ D406 -591 | ---------- -592 | parameters: +602 | ---------- +603 | parameters: | = help: Add newline after "Parameters" ℹ Safe fix -587 587 | def test_lowercase_sub_section_header_should_be_valid(parameters: list[str], value: int): # noqa: D213 -588 588 | """Test that lower case subsection header is valid even if it has the same name as section kind. -589 589 | -590 |- Parameters: - 590 |+ Parameters -591 591 | ---------- -592 592 | parameters: -593 593 | A list of string parameters +598 598 | def test_lowercase_sub_section_header_should_be_valid(parameters: list[str], value: int): # noqa: D213 +599 599 | """Test that lower case subsection header is valid even if it has the same name as section kind. +600 600 | +601 |- Parameters: + 601 |+ Parameters +602 602 | ---------- +603 603 | parameters: +604 604 | A list of string parameters diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D407_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D407_sections.py.snap index 0ee65c75af467..767809f849287 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D407_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D407_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:44:5: D407 [*] Missing dashed underline after section ("Returns") | 42 | """Toggle the gizmo. -43 | +43 | 44 | Returns | ^^^^^^^ D407 45 | A value of some sort. @@ -23,10 +23,10 @@ sections.py:44:5: D407 [*] Missing dashed underline after section ("Returns") sections.py:56:5: D407 [*] Missing dashed underline after section ("Returns") | 54 | """Toggle the gizmo. -55 | +55 | 56 | Returns | ^^^^^^^ D407 -57 | +57 | 58 | """ | = help: Add dashed line under "Returns" @@ -43,7 +43,7 @@ sections.py:56:5: D407 [*] Missing dashed underline after section ("Returns") sections.py:67:5: D407 [*] Missing dashed underline after section ("Returns") | 65 | """Toggle the gizmo. -66 | +66 | 67 | Returns""" | ^^^^^^^ D407 | @@ -117,22 +117,22 @@ sections.py:530:5: D407 [*] Missing dashed underline after section ("Parameters" 532 532 | 533 533 | -sections.py:602:4: D407 [*] Missing dashed underline after section ("Parameters") +sections.py:613:4: D407 [*] Missing dashed underline after section ("Parameters") | -600 | """Test that lower case subsection header is valid even if it is of a different kind. -601 | -602 | Parameters +611 | """Test that lower case subsection header is valid even if it is of a different kind. +612 | +613 | Parameters | ^^^^^^^^^^ D407 -603 | -‐----------------- -604 | returns: +614 | -‐----------------- +615 | returns: | = help: Add dashed line under "Parameters" ℹ Safe fix -600 600 | """Test that lower case subsection header is valid even if it is of a different kind. -601 601 | -602 602 | Parameters - 603 |+ ---------- -603 604 | -‐----------------- -604 605 | returns: -605 606 | some value +611 611 | """Test that lower case subsection header is valid even if it is of a different kind. +612 612 | +613 613 | Parameters + 614 |+ ---------- +614 615 | -‐----------------- +615 616 | returns: +616 617 | some value diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D408_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D408_sections.py.snap index 38bec4612b427..2bb4847569e0b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D408_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D408_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:98:5: D408 [*] Section underline should be in the line following the section's name ("Returns") | 96 | Returns -97 | +97 | 98 | ------- | ^^^^^^^ D408 99 | A value of some sort. diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D409_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D409_sections.py.snap index 1b59fad56deee..a456360e576df 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D409_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D409_sections.py.snap @@ -40,22 +40,22 @@ sections.py:225:5: D409 [*] Section underline should match the length of its nam 227 227 | Raises: 228 228 | My attention. -sections.py:578:5: D409 [*] Section underline should match the length of its name ("Other Parameters") +sections.py:589:5: D409 [*] Section underline should match the length of its name ("Other Parameters") | -577 | Other Parameters -578 | ---------- +588 | Other Parameters +589 | ---------- | ^^^^^^^^^^ D409 -579 | other_parameters: -580 | A dictionary of string attributes +590 | other_parameters: +591 | A dictionary of string attributes | = help: Adjust underline length to match "Other Parameters" ℹ Safe fix -575 575 | A dictionary of string attributes -576 576 | -577 577 | Other Parameters -578 |- ---------- - 578 |+ ---------------- -579 579 | other_parameters: -580 580 | A dictionary of string attributes -581 581 | parameters: +586 586 | A dictionary of string attributes +587 587 | +588 588 | Other Parameters +589 |- ---------- + 589 |+ ---------------- +590 590 | other_parameters: +591 591 | A dictionary of string attributes +592 592 | parameters: diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_D410.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_D410.py.snap index 2f7b0e4f92977..f95ac4dd1f4fb 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_D410.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_D410.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D410.py:4:5: D410 [*] Missing blank line after section ("Parameters") | 2 | """Showcase function. -3 | +3 | 4 | Parameters | ^^^^^^^^^^ D410 5 | ---------- @@ -24,7 +24,7 @@ D410.py:4:5: D410 [*] Missing blank line after section ("Parameters") D410.py:21:5: D410 [*] Missing blank line after section ("Parameters") | 19 | """Showcase function. -20 | +20 | 21 | Parameters | ^^^^^^^^^^ D410 22 | ---------- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_sections.py.snap index e8c466e1387ca..389391bb4665c 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D410_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:78:5: D410 [*] Missing blank line after section ("Returns") | 76 | """Toggle the gizmo. -77 | +77 | 78 | Returns | ^^^^^^^ D410 79 | ------- @@ -24,7 +24,7 @@ sections.py:78:5: D410 [*] Missing blank line after section ("Returns") sections.py:224:5: D410 [*] Missing blank line after section ("Returns") | 222 | returns. -223 | +223 | 224 | Returns | ^^^^^^^ D410 225 | ------ diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D411_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D411_sections.py.snap index b516028f32fe3..c893a2e05946d 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D411_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D411_sections.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- sections.py:80:5: D411 [*] Missing blank line before section ("Yields") | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sections.py.snap index a6461d2987661..6616be7a6ec69 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:218:5: D412 [*] No blank lines allowed between a section header and its content ("Short summary") | 216 | """Toggle the gizmo. -217 | +217 | 218 | Short summary | ^^^^^^^^^^^^^ D412 219 | ------------- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sphinx.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sphinx.py.snap index 8c9f7c45dccad..5abbab23db95a 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sphinx.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D412_sphinx.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- sphinx.py:13:5: D412 [*] No blank lines allowed between a section header and its content ("Example") | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_D413.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_D413.py.snap index a2a831d93e752..d1339c1a8a46c 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_D413.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_D413.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D413.py:7:1: D413 [*] Missing blank line after last section ("Returns") | 5 | with a hanging indent -6 | +6 | 7 | Returns: | ^^^^^^^ D413 8 | the value @@ -24,7 +24,7 @@ D413.py:7:1: D413 [*] Missing blank line after last section ("Returns") D413.py:19:5: D413 [*] Missing blank line after last section ("Returns") | 17 | with a hanging indent -18 | +18 | 19 | Returns: | ^^^^^^^ D413 20 | the value @@ -44,7 +44,7 @@ D413.py:19:5: D413 [*] Missing blank line after last section ("Returns") D413.py:58:5: D413 [*] Missing blank line after last section ("Returns") | 56 | with a hanging indent -57 | +57 | 58 | Returns: | ^^^^^^^ D413 59 | the value""" @@ -66,7 +66,7 @@ D413.py:58:5: D413 [*] Missing blank line after last section ("Returns") D413.py:69:5: D413 [*] Missing blank line after last section ("Returns") | 67 | with a hanging indent -68 | +68 | 69 | Returns: | ^^^^^^^ D413 70 | the value diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_sections.py.snap index 223c7c38218af..c8e9fd19ae22e 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D413_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:67:5: D413 [*] Missing blank line after last section ("Returns") | 65 | """Toggle the gizmo. -66 | +66 | 67 | Returns""" | ^^^^^^^ D413 | @@ -25,7 +25,7 @@ sections.py:67:5: D413 [*] Missing blank line after last section ("Returns") sections.py:122:5: D413 [*] Missing blank line after last section ("Returns") | 120 | """Toggle the gizmo. -121 | +121 | 122 | Returns | ^^^^^^^ D413 123 | ------- @@ -45,7 +45,7 @@ sections.py:122:5: D413 [*] Missing blank line after last section ("Returns") sections.py:172:5: D413 [*] Missing blank line after last section ("Returns") | 170 | """Toggle the gizmo. -171 | +171 | 172 | Returns | ^^^^^^^ D413 173 | ------- @@ -65,7 +65,7 @@ sections.py:172:5: D413 [*] Missing blank line after last section ("Returns") sections.py:521:5: D413 [*] Missing blank line after last section ("Parameters") | 519 | """Equal length equals should be replaced with dashes. -520 | +520 | 521 | Parameters | ^^^^^^^^^^ D413 522 | ========== @@ -85,7 +85,7 @@ sections.py:521:5: D413 [*] Missing blank line after last section ("Parameters") sections.py:529:5: D413 [*] Missing blank line after last section ("Parameters") | 527 | """Here, the length of equals is not the same. -528 | +528 | 529 | Parameters | ^^^^^^^^^^ D413 530 | =========== @@ -105,7 +105,7 @@ sections.py:529:5: D413 [*] Missing blank line after last section ("Parameters") sections.py:550:5: D413 [*] Missing blank line after last section ("Args") | 548 | """Below, `returns:` should _not_ be considered a section header. -549 | +549 | 550 | Args: | ^^^^ D413 551 | Here's a note. @@ -124,7 +124,7 @@ sections.py:550:5: D413 [*] Missing blank line after last section ("Args") sections.py:563:9: D413 [*] Missing blank line after last section ("Returns") | 561 | Here's a note. -562 | +562 | 563 | Returns: | ^^^^^^^ D413 564 | """ @@ -140,22 +140,42 @@ sections.py:563:9: D413 [*] Missing blank line after last section ("Returns") 565 566 | 566 567 | -sections.py:590:5: D413 [*] Missing blank line after last section ("Parameters") +sections.py:573:5: D413 [*] Missing blank line after last section ("returns") | -588 | """Test that lower case subsection header is valid even if it has the same name as section kind. -589 | -590 | Parameters: +571 | arg: Here's a note. +572 | +573 | returns: + | ^^^^^^^ D413 +574 | Here's another note. +575 | """ + | + = help: Add blank line after "returns" + +ℹ Safe fix +572 572 | +573 573 | returns: +574 574 | Here's another note. + 575 |+ +575 576 | """ +576 577 | +577 578 | + +sections.py:601:5: D413 [*] Missing blank line after last section ("Parameters") + | +599 | """Test that lower case subsection header is valid even if it has the same name as section kind. +600 | +601 | Parameters: | ^^^^^^^^^^ D413 -591 | ---------- -592 | parameters: +602 | ---------- +603 | parameters: | = help: Add blank line after "Parameters" ℹ Safe fix -593 593 | A list of string parameters -594 594 | value: -595 595 | Some value - 596 |+ -596 597 | """ -597 598 | -598 599 | +604 604 | A list of string parameters +605 605 | value: +606 606 | Some value + 607 |+ +607 608 | """ +608 609 | +609 610 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D414_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D414_sections.py.snap index b4a8317bd9295..c4cfd3cd33ba3 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D414_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D414_sections.py.snap @@ -4,17 +4,17 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:56:5: D414 Section has no content ("Returns") | 54 | """Toggle the gizmo. -55 | +55 | 56 | Returns | ^^^^^^^ D414 -57 | +57 | 58 | """ | sections.py:67:5: D414 Section has no content ("Returns") | 65 | """Toggle the gizmo. -66 | +66 | 67 | Returns""" | ^^^^^^^ D414 | @@ -22,7 +22,7 @@ sections.py:67:5: D414 Section has no content ("Returns") sections.py:78:5: D414 Section has no content ("Returns") | 76 | """Toggle the gizmo. -77 | +77 | 78 | Returns | ^^^^^^^ D414 79 | ------- @@ -41,7 +41,7 @@ sections.py:80:5: D414 Section has no content ("Yields") sections.py:172:5: D414 Section has no content ("Returns") | 170 | """Toggle the gizmo. -171 | +171 | 172 | Returns | ^^^^^^^ D414 173 | ------- @@ -51,17 +51,17 @@ sections.py:172:5: D414 Section has no content ("Returns") sections.py:266:5: D414 Section has no content ("Returns") | 264 | note: A random string. -265 | +265 | 266 | Returns: | ^^^^^^^ D414 -267 | +267 | 268 | Raises: | sections.py:563:9: D414 Section has no content ("Returns") | 561 | Here's a note. -562 | +562 | 563 | Returns: | ^^^^^^^ D414 564 | """ diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D.py.snap index c563e9541455a..83922317dc2cd 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D.py.snap @@ -236,9 +236,8 @@ D.py:615:5: D415 [*] First line should end with a period, question mark, or excl | 613 | @expect('D212: Multi-line docstring summary should start at the first line') 614 | def one_liner(): -615 | """Wrong." - | _____^ -616 | | +615 | / """Wrong." +616 | | 617 | | """ | |_______^ D415 | @@ -258,7 +257,7 @@ D.py:639:17: D415 [*] First line should end with a period, question mark, or exc | 639 | class SameLine: """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D415 -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | = help: Add closing punctuation @@ -276,7 +275,7 @@ D.py:639:17: D415 [*] First line should end with a period, question mark, or exc D.py:641:18: D415 [*] First line should end with a period, question mark, or exclamation point | 639 | class SameLine: """This is a docstring on the same line""" -640 | +640 | 641 | def same_line(): """This is a docstring on the same line""" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ D415 | @@ -295,8 +294,7 @@ D.py:641:18: D415 [*] First line should end with a period, question mark, or exc D.py:664:5: D415 [*] First line should end with a period, question mark, or exclamation point | 663 | def newline_after_closing_quote(self): -664 | "We enforce a newline after the closing quote for a multi-line docstring \ - | _____^ +664 | / "We enforce a newline after the closing quote for a multi-line docstring \ 665 | | but continuations shouldn't be considered multi-line" | |_________________________________________________________^ D415 | @@ -310,6 +308,4 @@ D.py:664:5: D415 [*] First line should end with a period, question mark, or excl 665 |+ but continuations shouldn't be considered multi-line." 666 666 | 667 667 | -668 668 | - - +668 668 | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D400_415.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D400_415.py.snap index e59a2755af6ce..2fdb5bc6c2d75 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D400_415.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D415_D400_415.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D400_415.py:11:5: D415 First line should end with a period, question mark, or exclamation point | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D416_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D416_D.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D416_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D416_D.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_google_examples.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_google_examples.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_google_examples.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_google_examples.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_numpy_examples.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_numpy_examples.py.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_numpy_examples.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_canonical_numpy_examples.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_sections.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_sections.py.snap index 1ea30245856fa..17d957fa2befb 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_sections.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D417_sections.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs sections.py:292:9: D417 Missing argument description in the docstring for `bar`: `y` | 290 | x = 1 -291 | +291 | 292 | def bar(y=2): # noqa: D207, D213, D406, D407 | ^^^ D417 293 | """Nested function test for docstrings. @@ -99,5 +99,3 @@ sections.py:498:9: D417 Missing argument description in the docstring for `test_ | ^^^^^^^^^^^^^^^^^^^^^ D417 499 | """Reproducing issue #437. | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D418_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D418_D.py.snap index 984c3d6a0fbd2..515371cb79e4b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D418_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D418_D.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- D.py:34:9: D418 Function decorated with `@overload` shouldn't contain a docstring | @@ -27,5 +28,3 @@ D.py:110:5: D418 Function decorated with `@overload` shouldn't contain a docstri 111 | """Foo bar documentation.""" 112 | ... | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D419_D.py.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D419_D.py.snap index 0a2310b792861..18f659a0c5c96 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D419_D.py.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__D419_D.py.snap @@ -6,7 +6,7 @@ D.py:20:9: D419 Docstring is empty 19 | class meta: 20 | """""" | ^^^^^^ D419 -21 | +21 | 22 | @expect('D102: Missing docstring in public method') | @@ -27,5 +27,3 @@ D.py:80:9: D419 Docstring is empty 80 | '' | ^^ D419 | - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__all.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__all.snap index 8ab522d0216b3..4c659e417bafb 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__all.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__all.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- all.py:1:1: D100 Missing docstring in public module all.py:1:5: D103 Missing docstring in public function diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__bom.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__bom.snap index bf80e65243b0c..503c830dd1d16 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__bom.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__bom.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- bom.py:1:1: D300 [*] Use triple double quotes `"""` | @@ -11,5 +12,3 @@ bom.py:1:1: D300 [*] Use triple double quotes `"""` ℹ Safe fix 1 |-''' SAM macro definitions ''' 1 |+""" SAM macro definitions """ - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d209_d400.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d209_d400.snap index 02a19f057d2c5..00b6e1887d546 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d209_d400.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d209_d400.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/pydocstyle/mod.rs D209_D400.py:2:5: D209 [*] Multi-line docstring closing quotes should be on a separate line | 1 | def lorem(): -2 | """lorem ipsum dolor sit amet consectetur adipiscing elit - | _____^ +2 | / """lorem ipsum dolor sit amet consectetur adipiscing elit 3 | | sed do eiusmod tempor incididunt ut labore et dolore magna aliqua""" | |________________________________________________________________________^ D209 | @@ -21,8 +20,7 @@ D209_D400.py:2:5: D209 [*] Multi-line docstring closing quotes should be on a se D209_D400.py:2:5: D400 [*] First line should end with a period | 1 | def lorem(): -2 | """lorem ipsum dolor sit amet consectetur adipiscing elit - | _____^ +2 | / """lorem ipsum dolor sit amet consectetur adipiscing elit 3 | | sed do eiusmod tempor incididunt ut labore et dolore magna aliqua""" | |________________________________________________________________________^ D400 | @@ -33,5 +31,3 @@ D209_D400.py:2:5: D400 [*] First line should end with a period 2 2 | """lorem ipsum dolor sit amet consectetur adipiscing elit 3 |- sed do eiusmod tempor incididunt ut labore et dolore magna aliqua""" 3 |+ sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.""" - - diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google.snap index 71117e0c97538..f99e5d73fb9ca 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google.snap @@ -72,4 +72,20 @@ D417.py:155:5: D417 Missing argument description in the docstring for `select_da 157 | args: tuple, | +D417.py:172:5: D417 Missing argument description in the docstring for `f`: `**kwargs` + | +170 | """ +171 | +172 | def f(x, *args, **kwargs): + | ^ D417 +173 | """Do something. + | +D417.py:199:5: D417 Missing argument description in the docstring for `should_fail`: `Args` + | +198 | # undocumented argument with the same name as a section +199 | def should_fail(payload, Args): + | ^^^^^^^^^^^ D417 +200 | """ +201 | Send a message. + | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google_ignore_var_parameters.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google_ignore_var_parameters.snap new file mode 100644 index 0000000000000..d09b599a0995e --- /dev/null +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_google_ignore_var_parameters.snap @@ -0,0 +1,75 @@ +--- +source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +--- +D417.py:1:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +1 | def f(x, y, z): + | ^ D417 +2 | """Do something. + | + +D417.py:14:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +14 | def f(x, y, z): + | ^ D417 +15 | """Do something. + | + +D417.py:27:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +27 | def f(x, y, z): + | ^ D417 +28 | """Do something. + | + +D417.py:39:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +39 | def f(x, y, z): + | ^ D417 +40 | """Do something. + | + +D417.py:52:5: D417 Missing argument description in the docstring for `f`: `y` + | +52 | def f(x, y, z): + | ^ D417 +53 | """Do something. + | + +D417.py:65:5: D417 Missing argument description in the docstring for `f`: `y` + | +65 | def f(x, y, z): + | ^ D417 +66 | """Do something. + | + +D417.py:77:5: D417 Missing argument description in the docstring for `f`: `y` + | +77 | def f(x, y, z): + | ^ D417 +78 | """Do something. + | + +D417.py:98:5: D417 Missing argument description in the docstring for `f`: `x` + | +98 | def f(x, *args, **kwargs): + | ^ D417 +99 | """Do something. + | + +D417.py:155:5: D417 Missing argument description in the docstring for `select_data`: `auto_save` + | +155 | def select_data( + | ^^^^^^^^^^^ D417 +156 | query: str, +157 | args: tuple, + | + +D417.py:199:5: D417 Missing argument description in the docstring for `should_fail`: `Args` + | +198 | # undocumented argument with the same name as a section +199 | def should_fail(payload, Args): + | ^^^^^^^^^^^ D417 +200 | """ +201 | Send a message. + | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_numpy.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_numpy.snap index 724d6e7d20ae3..b9a217857b62b 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_numpy.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_numpy.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified.snap index 71117e0c97538..f99e5d73fb9ca 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified.snap +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified.snap @@ -72,4 +72,20 @@ D417.py:155:5: D417 Missing argument description in the docstring for `select_da 157 | args: tuple, | +D417.py:172:5: D417 Missing argument description in the docstring for `f`: `**kwargs` + | +170 | """ +171 | +172 | def f(x, *args, **kwargs): + | ^ D417 +173 | """Do something. + | +D417.py:199:5: D417 Missing argument description in the docstring for `should_fail`: `Args` + | +198 | # undocumented argument with the same name as a section +199 | def should_fail(payload, Args): + | ^^^^^^^^^^^ D417 +200 | """ +201 | Send a message. + | diff --git a/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified_ignore_var_parameters.snap b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified_ignore_var_parameters.snap new file mode 100644 index 0000000000000..f99e5d73fb9ca --- /dev/null +++ b/crates/ruff_linter/src/rules/pydocstyle/snapshots/ruff_linter__rules__pydocstyle__tests__d417_unspecified_ignore_var_parameters.snap @@ -0,0 +1,91 @@ +--- +source: crates/ruff_linter/src/rules/pydocstyle/mod.rs +--- +D417.py:1:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +1 | def f(x, y, z): + | ^ D417 +2 | """Do something. + | + +D417.py:14:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +14 | def f(x, y, z): + | ^ D417 +15 | """Do something. + | + +D417.py:27:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +27 | def f(x, y, z): + | ^ D417 +28 | """Do something. + | + +D417.py:39:5: D417 Missing argument descriptions in the docstring for `f`: `y`, `z` + | +39 | def f(x, y, z): + | ^ D417 +40 | """Do something. + | + +D417.py:52:5: D417 Missing argument description in the docstring for `f`: `y` + | +52 | def f(x, y, z): + | ^ D417 +53 | """Do something. + | + +D417.py:65:5: D417 Missing argument description in the docstring for `f`: `y` + | +65 | def f(x, y, z): + | ^ D417 +66 | """Do something. + | + +D417.py:77:5: D417 Missing argument description in the docstring for `f`: `y` + | +77 | def f(x, y, z): + | ^ D417 +78 | """Do something. + | + +D417.py:98:5: D417 Missing argument description in the docstring for `f`: `x` + | +98 | def f(x, *args, **kwargs): + | ^ D417 +99 | """Do something. + | + +D417.py:108:5: D417 Missing argument description in the docstring for `f`: `*args` + | +108 | def f(x, *args, **kwargs): + | ^ D417 +109 | """Do something. + | + +D417.py:155:5: D417 Missing argument description in the docstring for `select_data`: `auto_save` + | +155 | def select_data( + | ^^^^^^^^^^^ D417 +156 | query: str, +157 | args: tuple, + | + +D417.py:172:5: D417 Missing argument description in the docstring for `f`: `**kwargs` + | +170 | """ +171 | +172 | def f(x, *args, **kwargs): + | ^ D417 +173 | """Do something. + | + +D417.py:199:5: D417 Missing argument description in the docstring for `should_fail`: `Args` + | +198 | # undocumented argument with the same name as a section +199 | def should_fail(payload, Args): + | ^^^^^^^^^^^ D417 +200 | """ +201 | Send a message. + | diff --git a/crates/ruff_linter/src/rules/pyflakes/cformat.rs b/crates/ruff_linter/src/rules/pyflakes/cformat.rs index 9fccc4788484a..311241b0ac53c 100644 --- a/crates/ruff_linter/src/rules/pyflakes/cformat.rs +++ b/crates/ruff_linter/src/rules/pyflakes/cformat.rs @@ -36,7 +36,7 @@ impl From<&CFormatString> for CFormatSummary { None => { num_positional += 1; } - }; + } if min_field_width == &Some(CFormatQuantity::FromValuesTuple) { num_positional += 1; starred = true; diff --git a/crates/ruff_linter/src/rules/pyflakes/fixes.rs b/crates/ruff_linter/src/rules/pyflakes/fixes.rs index ed80041587e03..d71a8cb468209 100644 --- a/crates/ruff_linter/src/rules/pyflakes/fixes.rs +++ b/crates/ruff_linter/src/rules/pyflakes/fixes.rs @@ -2,13 +2,14 @@ use anyhow::{Context, Ok, Result}; use ruff_diagnostics::Edit; use ruff_python_ast as ast; +use ruff_python_ast::Expr; use ruff_python_codegen::Stylist; use ruff_python_semantic::Binding; use ruff_python_trivia::{BackwardsTokenizer, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::Ranged; -use crate::cst::matchers::{match_call_mut, match_dict, transform_expression}; use crate::Locator; +use crate::cst::matchers::{match_call_mut, match_dict, transform_expression}; /// Generate a [`Edit`] to remove unused keys from format dict. pub(super) fn remove_unused_format_arguments_from_dict( @@ -69,6 +70,18 @@ pub(crate) fn remove_unused_positional_arguments_from_format_call( locator: &Locator, stylist: &Stylist, ) -> Result<Edit> { + // If we're removing _all_ arguments, we can remove the entire call. + // + // For example, `"Hello".format(", world!")` -> `"Hello"`, as opposed to `"Hello".format()`. + if unused_arguments.len() == call.arguments.len() { + if let Expr::Attribute(attribute) = &*call.func { + return Ok(Edit::range_replacement( + locator.slice(&*attribute.value).to_string(), + call.range(), + )); + } + } + let source_code = locator.slice(call); transform_expression(source_code, stylist, |mut expression| { let call = match_call_mut(&mut expression)?; @@ -81,7 +94,12 @@ pub(crate) fn remove_unused_positional_arguments_from_format_call( !is_unused }); - Ok(expression) + // If there are no arguments left, remove the parentheses. + if call.args.is_empty() { + Ok((*call.func).clone()) + } else { + Ok(expression) + } }) .map(|output| Edit::range_replacement(output, call.range())) } diff --git a/crates/ruff_linter/src/rules/pyflakes/format.rs b/crates/ruff_linter/src/rules/pyflakes/format.rs index f53d7acfa1b66..e19f58f627924 100644 --- a/crates/ruff_linter/src/rules/pyflakes/format.rs +++ b/crates/ruff_linter/src/rules/pyflakes/format.rs @@ -55,7 +55,7 @@ impl TryFrom<&str> for FormatSummary { FieldType::Auto => autos.push(autos.len()), FieldType::Index(i) => indices.push(i), FieldType::Keyword(k) => keywords.push(Name::from(k)), - }; + } let nested = FormatString::from_str(format_spec)?; for nested_part in nested.format_parts { @@ -67,7 +67,7 @@ impl TryFrom<&str> for FormatSummary { FieldType::Auto => autos.push(autos.len()), FieldType::Index(i) => indices.push(i), FieldType::Keyword(k) => keywords.push(Name::from(k)), - }; + } has_nested_parts = true; } } diff --git a/crates/ruff_linter/src/rules/pyflakes/mod.rs b/crates/ruff_linter/src/rules/pyflakes/mod.rs index c01397206f2be..ffd50bf540f3f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/mod.rs +++ b/crates/ruff_linter/src/rules/pyflakes/mod.rs @@ -11,6 +11,7 @@ mod tests { use anyhow::Result; use regex::Regex; + use ruff_python_parser::ParseOptions; use rustc_hash::FxHashMap; use test_case::test_case; @@ -20,15 +21,16 @@ mod tests { use ruff_python_trivia::textwrap::dedent; use ruff_text_size::Ranged; + use crate::Locator; use crate::linter::check_path; - use crate::registry::{AsRule, Linter, Rule}; + use crate::message::Message; + use crate::registry::{Linter, Rule}; use crate::rules::isort; use crate::rules::pyflakes; use crate::settings::types::PreviewMode; - use crate::settings::{flags, LinterSettings}; + use crate::settings::{LinterSettings, flags}; use crate::source_kind::SourceKind; use crate::test::{test_contents, test_path, test_snippet}; - use crate::Locator; use crate::{assert_messages, directives}; #[test_case(Rule::UnusedImport, Path::new("F401_0.py"))] @@ -55,6 +57,8 @@ mod tests { #[test_case(Rule::UnusedImport, Path::new("F401_21.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_22.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_23.py"))] + #[test_case(Rule::UnusedImport, Path::new("F401_32.py"))] + #[test_case(Rule::UnusedImport, Path::new("F401_34.py"))] #[test_case(Rule::ImportShadowedByLoopVar, Path::new("F402.py"))] #[test_case(Rule::ImportShadowedByLoopVar, Path::new("F402.ipynb"))] #[test_case(Rule::UndefinedLocalWithImportStar, Path::new("F403.py"))] @@ -95,6 +99,7 @@ mod tests { #[test_case(Rule::ReturnOutsideFunction, Path::new("F706.py"))] #[test_case(Rule::DefaultExceptNotLast, Path::new("F707.py"))] #[test_case(Rule::ForwardAnnotationSyntaxError, Path::new("F722.py"))] + #[test_case(Rule::ForwardAnnotationSyntaxError, Path::new("F722_1.py"))] #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_0.py"))] #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_1.py"))] #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_2.py"))] @@ -127,6 +132,7 @@ mod tests { #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_29.pyi"))] #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_30.py"))] #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_31.py"))] + #[test_case(Rule::RedefinedWhileUnused, Path::new("F811_32.py"))] #[test_case(Rule::UndefinedName, Path::new("F821_0.py"))] #[test_case(Rule::UndefinedName, Path::new("F821_1.py"))] #[test_case(Rule::UndefinedName, Path::new("F821_2.py"))] @@ -159,6 +165,9 @@ mod tests { #[test_case(Rule::UndefinedName, Path::new("F821_26.pyi"))] #[test_case(Rule::UndefinedName, Path::new("F821_27.py"))] #[test_case(Rule::UndefinedName, Path::new("F821_28.py"))] + #[test_case(Rule::UndefinedName, Path::new("F821_30.py"))] + #[test_case(Rule::UndefinedName, Path::new("F821_31.py"))] + #[test_case(Rule::UndefinedName, Path::new("F821_32.pyi"))] #[test_case(Rule::UndefinedExport, Path::new("F822_0.py"))] #[test_case(Rule::UndefinedExport, Path::new("F822_0.pyi"))] #[test_case(Rule::UndefinedExport, Path::new("F822_1.py"))] @@ -170,7 +179,6 @@ mod tests { #[test_case(Rule::UnusedVariable, Path::new("F841_1.py"))] #[test_case(Rule::UnusedVariable, Path::new("F841_2.py"))] #[test_case(Rule::UnusedVariable, Path::new("F841_3.py"))] - #[test_case(Rule::UnusedVariable, Path::new("F841_4.py"))] #[test_case(Rule::UnusedAnnotation, Path::new("F842.py"))] #[test_case(Rule::RaiseNotImplemented, Path::new("F901.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { @@ -211,14 +219,13 @@ mod tests { let diagnostics = test_snippet( "PythonFinalizationError", &LinterSettings { - target_version: crate::settings::types::PythonVersion::Py312, + unresolved_target_version: ruff_python_ast::PythonVersion::PY312.into(), ..LinterSettings::for_rule(Rule::UndefinedName) }, ); assert_messages!(diagnostics); } - #[test_case(Rule::UnusedVariable, Path::new("F841_4.py"))] #[test_case(Rule::UnusedImport, Path::new("__init__.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_24/__init__.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_25__all_nonempty/__init__.py"))] @@ -282,6 +289,35 @@ mod tests { assert_messages!(snapshot, diagnostics); } + // Regression test for https://github.com/astral-sh/ruff/issues/12897 + #[test_case(Rule::UnusedImport, Path::new("F401_33/__init__.py"))] + fn f401_preview_local_init_import(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "preview__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let settings = LinterSettings { + preview: PreviewMode::Enabled, + isort: isort::settings::Settings { + // Like `f401_preview_first_party_submodule`, this test requires the input module to + // be first-party + known_modules: isort::categorize::KnownModules::new( + vec!["F401_*".parse()?], + vec![], + vec![], + vec![], + FxHashMap::default(), + ), + ..isort::settings::Settings::default() + }, + ..LinterSettings::for_rule(rule_code) + }; + let diagnostics = test_path(Path::new("pyflakes").join(path).as_path(), &settings)?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test_case(Rule::UnusedImport, Path::new("F401_24/__init__.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_25__all_nonempty/__init__.py"))] #[test_case(Rule::UnusedImport, Path::new("F401_26__all_empty/__init__.py"))] @@ -325,6 +361,7 @@ mod tests { assert_messages!(snapshot, diagnostics); Ok(()) } + #[test_case(Rule::UnusedImport, Path::new("F401_31.py"))] fn f401_allowed_unused_imports_option(rule_code: Rule, path: &Path) -> Result<()> { let diagnostics = test_path( @@ -707,8 +744,12 @@ mod tests { let source_type = PySourceType::default(); let source_kind = SourceKind::Python(contents.to_string()); let settings = LinterSettings::for_rules(Linter::Pyflakes.rules()); - let parsed = - ruff_python_parser::parse_unchecked_source(source_kind.source_code(), source_type); + let target_version = settings.unresolved_target_version; + let options = + ParseOptions::from(source_type).with_target_version(target_version.parser_version()); + let parsed = ruff_python_parser::parse_unchecked(source_kind.source_code(), options) + .try_into_module() + .expect("PySourceType always parses into a module"); let locator = Locator::new(&contents); let stylist = Stylist::from_tokens(parsed.tokens(), locator.contents()); let indexer = Indexer::from_tokens(parsed.tokens(), locator.contents()); @@ -718,7 +759,7 @@ mod tests { &locator, &indexer, ); - let mut diagnostics = check_path( + let mut messages = check_path( Path::new("<filename>"), None, &locator, @@ -730,11 +771,12 @@ mod tests { &source_kind, source_type, &parsed, + target_version, ); - diagnostics.sort_by_key(Ranged::start); - let actual = diagnostics + messages.sort_by_key(Ranged::start); + let actual = messages .iter() - .map(|diagnostic| diagnostic.kind.rule()) + .filter_map(Message::to_rule) .collect::<Vec<_>>(); assert_eq!(actual, expected); } @@ -2652,7 +2694,7 @@ lambda: fu import foo.baz as foo foo ", - &[Rule::RedefinedWhileUnused], + &[Rule::UnusedImport, Rule::RedefinedWhileUnused], ); } @@ -2702,13 +2744,13 @@ lambda: fu #[test] fn unused_package_with_submodule_import() { - // When a package and its submodule are imported, only report once. + // When a package and its submodule are imported, report both. flakes( r" import fu import fu.bar ", - &[Rule::UnusedImport], + &[Rule::UnusedImport, Rule::UnusedImport], ); } @@ -3082,7 +3124,7 @@ lambda: fu #[test] fn redefined_by_gen_exp() { - // Re-using a global name as the loop variable for a generator + // Reusing a global name as the loop variable for a generator // expression results in a redefinition warning. flakes( "import fu; (1 for fu in range(1))", @@ -4221,4 +4263,22 @@ lambda: fu &[], ); } + + #[test] + fn gh_issue_17196_regression_test() { + flakes( + r#" + from typing import Annotated + + def type_annotations_from_tuple(): + annos = (str, "foo", "bar") + return Annotated[annos] + + def type_annotations_from_filtered_tuple(): + annos = (str, None, "foo", None, "bar") + return Annotated[tuple([a for a in annos if a is not None])] + "#, + &[], + ); + } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/assert_tuple.rs b/crates/ruff_linter/src/rules/pyflakes/rules/assert_tuple.rs index e8af1828afc08..a25322fb0f988 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/assert_tuple.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/assert_tuple.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -27,23 +27,21 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `assert` statement](https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement) -#[violation] -pub struct AssertTuple; +#[derive(ViolationMetadata)] +pub(crate) struct AssertTuple; impl Violation for AssertTuple { #[derive_message_formats] fn message(&self) -> String { - format!("Assert test is a non-empty tuple, which is always `True`") + "Assert test is a non-empty tuple, which is always `True`".to_string() } } /// F631 -pub(crate) fn assert_tuple(checker: &mut Checker, stmt: &Stmt, test: &Expr) { +pub(crate) fn assert_tuple(checker: &Checker, stmt: &Stmt, test: &Expr) { if let Expr::Tuple(tuple) = &test { if !tuple.is_empty() { - checker - .diagnostics - .push(Diagnostic::new(AssertTuple, stmt.range())); + checker.report_diagnostic(Diagnostic::new(AssertTuple, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/break_outside_loop.rs b/crates/ruff_linter/src/rules/pyflakes/rules/break_outside_loop.rs index 0765f117dd118..ba0e7b99ab479 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/break_outside_loop.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/break_outside_loop.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -19,13 +19,13 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Python documentation: `break`](https://docs.python.org/3/reference/simple_stmts.html#the-break-statement) -#[violation] -pub struct BreakOutsideLoop; +#[derive(ViolationMetadata)] +pub(crate) struct BreakOutsideLoop; impl Violation for BreakOutsideLoop { #[derive_message_formats] fn message(&self) -> String { - format!("`break` outside loop") + "`break` outside loop".to_string() } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/continue_outside_loop.rs b/crates/ruff_linter/src/rules/pyflakes/rules/continue_outside_loop.rs index 894295a01b55f..dc4b842241121 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/continue_outside_loop.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/continue_outside_loop.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; /// ## What it does @@ -19,13 +19,13 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Python documentation: `continue`](https://docs.python.org/3/reference/simple_stmts.html#the-continue-statement) -#[violation] -pub struct ContinueOutsideLoop; +#[derive(ViolationMetadata)] +pub(crate) struct ContinueOutsideLoop; impl Violation for ContinueOutsideLoop { #[derive_message_formats] fn message(&self) -> String { - format!("`continue` not properly in loop") + "`continue` not properly in loop".to_string() } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/default_except_not_last.rs b/crates/ruff_linter/src/rules/pyflakes/rules/default_except_not_last.rs index da3cccab4c3f5..a9bf5919e4099 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/default_except_not_last.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/default_except_not_last.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::except; use ruff_python_ast::{self as ast, ExceptHandler}; @@ -43,13 +43,13 @@ use crate::Locator; /// /// ## References /// - [Python documentation: `except` clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) -#[violation] -pub struct DefaultExceptNotLast; +#[derive(ViolationMetadata)] +pub(crate) struct DefaultExceptNotLast; impl Violation for DefaultExceptNotLast { #[derive_message_formats] fn message(&self) -> String { - format!("An `except` block as not the last exception handler") + "An `except` block as not the last exception handler".to_string() } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/f_string_missing_placeholders.rs b/crates/ruff_linter/src/rules/pyflakes/rules/f_string_missing_placeholders.rs index 9a6decf6c7b17..df0a6d3b11c17 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/f_string_missing_placeholders.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/f_string_missing_placeholders.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for f-strings that do not contain any placeholder expressions. @@ -52,14 +52,14 @@ use crate::Locator; /// See [#10885](https://github.com/astral-sh/ruff/issues/10885) for more. /// /// ## References -/// - [PEP 498](https://www.python.org/dev/peps/pep-0498/) -#[violation] -pub struct FStringMissingPlaceholders; +/// - [PEP 498 – Literal String Interpolation](https://peps.python.org/pep-0498/) +#[derive(ViolationMetadata)] +pub(crate) struct FStringMissingPlaceholders; impl AlwaysFixableViolation for FStringMissingPlaceholders { #[derive_message_formats] fn message(&self) -> String { - format!("f-string without any placeholders") + "f-string without any placeholders".to_string() } fn fix_title(&self) -> String { @@ -68,7 +68,7 @@ impl AlwaysFixableViolation for FStringMissingPlaceholders { } /// F541 -pub(crate) fn f_string_missing_placeholders(checker: &mut Checker, expr: &ast::ExprFString) { +pub(crate) fn f_string_missing_placeholders(checker: &Checker, expr: &ast::ExprFString) { if expr.value.f_strings().any(|f_string| { f_string .elements @@ -97,7 +97,7 @@ pub(crate) fn f_string_missing_placeholders(checker: &mut Checker, expr: &ast::E f_string.range(), checker.locator(), )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/forward_annotation_syntax_error.rs b/crates/ruff_linter/src/rules/pyflakes/rules/forward_annotation_syntax_error.rs index 7e0405111f50c..3208461cd2a2d 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/forward_annotation_syntax_error.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/forward_annotation_syntax_error.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for forward annotations that include invalid syntax. @@ -21,16 +21,16 @@ use ruff_macros::{derive_message_formats, violation}; /// ``` /// /// ## References -/// - [PEP 563](https://www.python.org/dev/peps/pep-0563/) -#[violation] -pub struct ForwardAnnotationSyntaxError { - pub body: String, +/// - [PEP 563 – Postponed Evaluation of Annotations](https://peps.python.org/pep-0563/) +#[derive(ViolationMetadata)] +pub(crate) struct ForwardAnnotationSyntaxError { + pub parse_error: String, } impl Violation for ForwardAnnotationSyntaxError { #[derive_message_formats] fn message(&self) -> String { - let ForwardAnnotationSyntaxError { body } = self; - format!("Syntax error in forward annotation: `{body}`") + let ForwardAnnotationSyntaxError { parse_error } = self; + format!("Syntax error in forward annotation: {parse_error}") } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/future_feature_not_defined.rs b/crates/ruff_linter/src/rules/pyflakes/rules/future_feature_not_defined.rs index 18af0d3e303ad..7c4adce1d4255 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/future_feature_not_defined.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/future_feature_not_defined.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Alias; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_stdlib::future::is_feature_name; use ruff_text_size::Ranged; @@ -17,8 +17,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `__future__`](https://docs.python.org/3/library/__future__.html) -#[violation] -pub struct FutureFeatureNotDefined { +#[derive(ViolationMetadata)] +pub(crate) struct FutureFeatureNotDefined { name: String, } @@ -30,12 +30,12 @@ impl Violation for FutureFeatureNotDefined { } } -pub(crate) fn future_feature_not_defined(checker: &mut Checker, alias: &Alias) { +pub(crate) fn future_feature_not_defined(checker: &Checker, alias: &Alias) { if is_feature_name(&alias.name) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( FutureFeatureNotDefined { name: alias.name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/if_tuple.rs b/crates/ruff_linter/src/rules/pyflakes/rules/if_tuple.rs index 2d97e68d07f77..c6c74f978d095 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/if_tuple.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/if_tuple.rs @@ -1,14 +1,14 @@ use ruff_python_ast::{Expr, StmtIf}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::stmt_if::if_elif_branches; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; /// ## What it does -/// Checks for `if statements that use non-empty tuples as test conditions. +/// Checks for `if` statements that use non-empty tuples as test conditions. /// /// ## Why is this bad? /// Non-empty tuples are always `True`, so an `if` statement with a non-empty @@ -28,18 +28,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `if` statement](https://docs.python.org/3/reference/compound_stmts.html#the-if-statement) -#[violation] -pub struct IfTuple; +#[derive(ViolationMetadata)] +pub(crate) struct IfTuple; impl Violation for IfTuple { #[derive_message_formats] fn message(&self) -> String { - format!("If test is a tuple, which is always `True`") + "If test is a tuple, which is always `True`".to_string() } } /// F634 -pub(crate) fn if_tuple(checker: &mut Checker, stmt_if: &StmtIf) { +pub(crate) fn if_tuple(checker: &Checker, stmt_if: &StmtIf) { for branch in if_elif_branches(stmt_if) { let Expr::Tuple(tuple) = &branch.test else { continue; @@ -47,8 +47,6 @@ pub(crate) fn if_tuple(checker: &mut Checker, stmt_if: &StmtIf) { if tuple.is_empty() { continue; } - checker - .diagnostics - .push(Diagnostic::new(IfTuple, branch.test.range())); + checker.report_diagnostic(Diagnostic::new(IfTuple, branch.test.range())); } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/imports.rs b/crates/ruff_linter/src/rules/pyflakes/rules/imports.rs index bbd92f9adeead..34756acafb021 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/imports.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/imports.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::SourceRow; /// ## What it does @@ -29,8 +29,8 @@ use ruff_source_file::SourceRow; /// for filename in files: /// print(filename) /// ``` -#[violation] -pub struct ImportShadowedByLoopVar { +#[derive(ViolationMetadata)] +pub(crate) struct ImportShadowedByLoopVar { pub(crate) name: String, pub(crate) row: SourceRow, } @@ -70,8 +70,8 @@ impl Violation for ImportShadowedByLoopVar { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct UndefinedLocalWithImportStar { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedLocalWithImportStar { pub(crate) name: String, } @@ -108,13 +108,13 @@ impl Violation for UndefinedLocalWithImportStar { /// /// ## References /// - [Python documentation: Future statements](https://docs.python.org/3/reference/simple_stmts.html#future) -#[violation] -pub struct LateFutureImport; +#[derive(ViolationMetadata)] +pub(crate) struct LateFutureImport; impl Violation for LateFutureImport { #[derive_message_formats] fn message(&self) -> String { - format!("`from __future__` imports must occur at the beginning of the file") + "`from __future__` imports must occur at the beginning of the file".to_string() } } @@ -152,8 +152,8 @@ impl Violation for LateFutureImport { /// def area(radius): /// return pi * radius**2 /// ``` -#[violation] -pub struct UndefinedLocalWithImportStarUsage { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedLocalWithImportStarUsage { pub(crate) name: String, } @@ -193,8 +193,8 @@ impl Violation for UndefinedLocalWithImportStarUsage { /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct UndefinedLocalWithNestedImportStarUsage { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedLocalWithNestedImportStarUsage { pub(crate) name: String, } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/invalid_literal_comparisons.rs b/crates/ruff_linter/src/rules/pyflakes/rules/invalid_literal_comparisons.rs index cd10455d43a3c..5a0417a1574b8 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/invalid_literal_comparisons.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/invalid_literal_comparisons.rs @@ -1,7 +1,7 @@ -use log::error; +use anyhow::{Error, bail}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers; use ruff_python_ast::{CmpOp, Expr}; use ruff_python_parser::{TokenKind, Tokens}; @@ -50,33 +50,32 @@ use crate::checkers::ast::Checker; /// - [Python documentation: Identity comparisons](https://docs.python.org/3/reference/expressions.html#is-not) /// - [Python documentation: Value comparisons](https://docs.python.org/3/reference/expressions.html#value-comparisons) /// - [_Why does Python log a SyntaxWarning for ‘is’ with literals?_ by Adam Johnson](https://adamj.eu/tech/2020/01/21/why-does-python-3-8-syntaxwarning-for-is-literal/) -#[violation] -pub struct IsLiteral { +#[derive(ViolationMetadata)] +pub(crate) struct IsLiteral { cmp_op: IsCmpOp, } impl AlwaysFixableViolation for IsLiteral { #[derive_message_formats] fn message(&self) -> String { - let IsLiteral { cmp_op } = self; - match cmp_op { - IsCmpOp::Is => format!("Use `==` to compare constant literals"), - IsCmpOp::IsNot => format!("Use `!=` to compare constant literals"), + match self.cmp_op { + IsCmpOp::Is => "Use `==` to compare constant literals".to_string(), + IsCmpOp::IsNot => "Use `!=` to compare constant literals".to_string(), } } fn fix_title(&self) -> String { - let IsLiteral { cmp_op } = self; - match cmp_op { - IsCmpOp::Is => "Replace `is` with `==`".to_string(), - IsCmpOp::IsNot => "Replace `is not` with `!=`".to_string(), - } + let title = match self.cmp_op { + IsCmpOp::Is => "Replace `is` with `==`", + IsCmpOp::IsNot => "Replace `is not` with `!=`", + }; + title.to_string() } } /// F632 pub(crate) fn invalid_literal_comparison( - checker: &mut Checker, + checker: &Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr], @@ -95,25 +94,30 @@ pub(crate) fn invalid_literal_comparison( if lazy_located.is_none() { lazy_located = Some(locate_cmp_ops(expr, checker.tokens())); } - if let Some(located_op) = lazy_located.as_ref().and_then(|located| located.get(index)) { - assert_eq!(located_op.op, *op); - if let Some(content) = match located_op.op { - CmpOp::Is => Some("==".to_string()), - CmpOp::IsNot => Some("!=".to_string()), - node => { - error!("Failed to fix invalid comparison: {node:?}"); - None + diagnostic.try_set_optional_fix(|| { + if let Some(located_op) = + lazy_located.as_ref().and_then(|located| located.get(index)) + { + assert_eq!(located_op.op, *op); + if let Ok(content) = match located_op.op { + CmpOp::Is => Ok::<String, Error>("==".to_string()), + CmpOp::IsNot => Ok("!=".to_string()), + node => { + bail!("Failed to fix invalid comparison: {node:?}") + } + } { + Ok(Some(Fix::safe_edit(Edit::range_replacement( + content, + located_op.range, + )))) + } else { + Ok(None) } - } { - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - content, - located_op.range, - ))); + } else { + bail!("Failed to fix invalid comparison due to missing op") } - } else { - error!("Failed to fix invalid comparison due to missing op"); - } - checker.diagnostics.push(diagnostic); + }); + checker.report_diagnostic(diagnostic); } left = right; } @@ -242,7 +246,7 @@ mod tests { use ruff_python_parser::parse_expression; use ruff_text_size::TextSize; - use super::{locate_cmp_ops, LocatedCmpOp}; + use super::{LocatedCmpOp, locate_cmp_ops}; fn extract_cmp_op_locations(source: &str) -> Result<Vec<LocatedCmpOp>> { let parsed = parse_expression(source)?; diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/invalid_print_syntax.rs b/crates/ruff_linter/src/rules/pyflakes/rules/invalid_print_syntax.rs index dabdebb27d259..ea5e0d3e794ac 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/invalid_print_syntax.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/invalid_print_syntax.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_text_size::Ranged; @@ -46,21 +46,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `print`](https://docs.python.org/3/library/functions.html#print) -#[violation] -pub struct InvalidPrintSyntax; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidPrintSyntax; impl Violation for InvalidPrintSyntax { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `>>` is invalid with `print` function") + "Use of `>>` is invalid with `print` function".to_string() } } /// F633 -pub(crate) fn invalid_print_syntax(checker: &mut Checker, left: &Expr) { +pub(crate) fn invalid_print_syntax(checker: &Checker, left: &Expr) { if checker.semantic().match_builtin_expr(left, "print") { - checker - .diagnostics - .push(Diagnostic::new(InvalidPrintSyntax, left.range())); + checker.report_diagnostic(Diagnostic::new(InvalidPrintSyntax, left.range())); } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/raise_not_implemented.rs b/crates/ruff_linter/src/rules/pyflakes/rules/raise_not_implemented.rs index a8c061958a07f..84fd99decc9a9 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/raise_not_implemented.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/raise_not_implemented.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -34,15 +34,15 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `NotImplemented`](https://docs.python.org/3/library/constants.html#NotImplemented) /// - [Python documentation: `NotImplementedError`](https://docs.python.org/3/library/exceptions.html#NotImplementedError) -#[violation] -pub struct RaiseNotImplemented; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseNotImplemented; impl Violation for RaiseNotImplemented { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`raise NotImplemented` should be `raise NotImplementedError`") + "`raise NotImplemented` should be `raise NotImplementedError`".to_string() } fn fix_title(&self) -> Option<String> { @@ -70,7 +70,7 @@ fn match_not_implemented(expr: &Expr) -> Option<&Expr> { } /// F901 -pub(crate) fn raise_not_implemented(checker: &mut Checker, expr: &Expr) { +pub(crate) fn raise_not_implemented(checker: &Checker, expr: &Expr) { let Some(expr) = match_not_implemented(expr) else { return; }; @@ -86,5 +86,5 @@ pub(crate) fn raise_not_implemented(checker: &mut Checker, expr: &Expr) { import_edit, )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/redefined_while_unused.rs b/crates/ruff_linter/src/rules/pyflakes/rules/redefined_while_unused.rs index f65090d328b6d..d46c3c78026b6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/redefined_while_unused.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/redefined_while_unused.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::SourceRow; /// ## What it does @@ -22,8 +22,8 @@ use ruff_source_file::SourceRow; /// import foo /// import bar /// ``` -#[violation] -pub struct RedefinedWhileUnused { +#[derive(ViolationMetadata)] +pub(crate) struct RedefinedWhileUnused { pub name: String, pub row: SourceRow, } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/repeated_keys.rs b/crates/ruff_linter/src/rules/pyflakes/rules/repeated_keys.rs index 06ef03d97f4f6..0beeb7293fcc9 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/repeated_keys.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/repeated_keys.rs @@ -1,8 +1,9 @@ use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet}; +use std::collections::hash_map::Entry; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::comparable::ComparableExpr; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::comparable::{ComparableExpr, HashableExpr}; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -39,11 +40,18 @@ use crate::registry::Rule; /// foo["baz"] # 2 /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because removing a repeated dictionary key +/// may delete comments that are attached to the removed key-value pair. This can also change +/// the program's behavior if the value expressions have side effects. +/// /// ## References /// - [Python documentation: Dictionaries](https://docs.python.org/3/tutorial/datastructures.html#dictionaries) -#[violation] -pub struct MultiValueRepeatedKeyLiteral { +#[derive(ViolationMetadata)] +pub(crate) struct MultiValueRepeatedKeyLiteral { name: SourceCodeSnippet, + existing: SourceCodeSnippet, } impl Violation for MultiValueRepeatedKeyLiteral { @@ -51,21 +59,29 @@ impl Violation for MultiValueRepeatedKeyLiteral { #[derive_message_formats] fn message(&self) -> String { - let MultiValueRepeatedKeyLiteral { name } = self; - if let Some(name) = name.full_display() { - format!("Dictionary key literal `{name}` repeated") - } else { - format!("Dictionary key literal repeated") + match (self.name.full_display(), self.existing.full_display()) { + (Some(name), None) => { + format!("Dictionary key literal `{name}` repeated") + } + (Some(name), Some(existing)) => { + if name == existing { + format!("Dictionary key literal `{name}` repeated") + } else { + format!( + "Dictionary key literal `{name}` repeated (`{name}` hashes to the same value as `{existing}`)" + ) + } + } + _ => "Dictionary key literal repeated".to_string(), } } fn fix_title(&self) -> Option<String> { - let MultiValueRepeatedKeyLiteral { name } = self; - if let Some(name) = name.full_display() { - Some(format!("Remove repeated key literal `{name}`")) - } else { - Some(format!("Remove repeated key literal")) - } + let title = match self.name.full_display() { + Some(name) => format!("Remove repeated key literal `{name}`"), + None => "Remove repeated key literal".to_string(), + }; + Some(title) } } @@ -96,10 +112,16 @@ impl Violation for MultiValueRepeatedKeyLiteral { /// foo[baz] # 2 /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because removing a repeated dictionary key +/// may delete comments that are attached to the removed key-value pair. This can also change +/// the program's behavior if the value expressions have side effects. +/// /// ## References /// - [Python documentation: Dictionaries](https://docs.python.org/3/tutorial/datastructures.html#dictionaries) -#[violation] -pub struct MultiValueRepeatedKeyVariable { +#[derive(ViolationMetadata)] +pub(crate) struct MultiValueRepeatedKeyVariable { name: SourceCodeSnippet, } @@ -108,28 +130,26 @@ impl Violation for MultiValueRepeatedKeyVariable { #[derive_message_formats] fn message(&self) -> String { - let MultiValueRepeatedKeyVariable { name } = self; - if let Some(name) = name.full_display() { + if let Some(name) = self.name.full_display() { format!("Dictionary key `{name}` repeated") } else { - format!("Dictionary key repeated") + "Dictionary key repeated".to_string() } } fn fix_title(&self) -> Option<String> { - let MultiValueRepeatedKeyVariable { name } = self; - if let Some(name) = name.full_display() { - Some(format!("Remove repeated key `{name}`")) - } else { - Some(format!("Remove repeated key")) - } + let title = match self.name.full_display() { + Some(name) => format!("Remove repeated key `{name}`"), + None => "Remove repeated key".to_string(), + }; + Some(title) } } /// F601, F602 -pub(crate) fn repeated_keys(checker: &mut Checker, dict: &ast::ExprDict) { +pub(crate) fn repeated_keys(checker: &Checker, dict: &ast::ExprDict) { // Generate a map from key to (index, value). - let mut seen: FxHashMap<ComparableExpr, FxHashSet<ComparableExpr>> = + let mut seen: FxHashMap<HashableExpr, (&Expr, FxHashSet<ComparableExpr>)> = FxHashMap::with_capacity_and_hasher(dict.len(), FxBuildHasher); // Detect duplicate keys. @@ -138,86 +158,92 @@ pub(crate) fn repeated_keys(checker: &mut Checker, dict: &ast::ExprDict) { continue; }; - let comparable_key = ComparableExpr::from(key); + let comparable_key = HashableExpr::from(key); let comparable_value = ComparableExpr::from(value); - let Some(seen_values) = seen.get_mut(&comparable_key) else { - seen.insert(comparable_key, FxHashSet::from_iter([comparable_value])); - continue; - }; - - match key { - Expr::StringLiteral(_) - | Expr::BytesLiteral(_) - | Expr::NumberLiteral(_) - | Expr::BooleanLiteral(_) - | Expr::NoneLiteral(_) - | Expr::EllipsisLiteral(_) - | Expr::Tuple(_) - | Expr::FString(_) => { - if checker.enabled(Rule::MultiValueRepeatedKeyLiteral) { - let mut diagnostic = Diagnostic::new( - MultiValueRepeatedKeyLiteral { - name: SourceCodeSnippet::from_str(checker.locator().slice(key)), - }, - key.range(), - ); - if !seen_values.insert(comparable_value) { - diagnostic.set_fix(Fix::unsafe_edit(Edit::deletion( - parenthesized_range( - dict.value(i - 1).into(), - dict.into(), - checker.comment_ranges(), - checker.locator().contents(), - ) - .unwrap_or_else(|| dict.value(i - 1).range()) - .end(), - parenthesized_range( - dict.value(i).into(), - dict.into(), - checker.comment_ranges(), - checker.locator().contents(), - ) - .unwrap_or_else(|| dict.value(i).range()) - .end(), - ))); - } - checker.diagnostics.push(diagnostic); - } + match seen.entry(comparable_key) { + Entry::Vacant(entry) => { + entry.insert((key, FxHashSet::from_iter([comparable_value]))); } - Expr::Name(_) => { - if checker.enabled(Rule::MultiValueRepeatedKeyVariable) { - let mut diagnostic = Diagnostic::new( - MultiValueRepeatedKeyVariable { - name: SourceCodeSnippet::from_str(checker.locator().slice(key)), - }, - key.range(), - ); - let comparable_value: ComparableExpr = dict.value(i).into(); - if !seen_values.insert(comparable_value) { - diagnostic.set_fix(Fix::unsafe_edit(Edit::deletion( - parenthesized_range( - dict.value(i - 1).into(), - dict.into(), - checker.comment_ranges(), - checker.locator().contents(), - ) - .unwrap_or_else(|| dict.value(i - 1).range()) - .end(), - parenthesized_range( - dict.value(i).into(), - dict.into(), - checker.comment_ranges(), - checker.locator().contents(), - ) - .unwrap_or_else(|| dict.value(i).range()) - .end(), - ))); + Entry::Occupied(mut entry) => { + let (seen_key, seen_values) = entry.get_mut(); + match key { + Expr::StringLiteral(_) + | Expr::BytesLiteral(_) + | Expr::NumberLiteral(_) + | Expr::BooleanLiteral(_) + | Expr::NoneLiteral(_) + | Expr::EllipsisLiteral(_) + | Expr::Tuple(_) + | Expr::FString(_) => { + if checker.enabled(Rule::MultiValueRepeatedKeyLiteral) { + let mut diagnostic = Diagnostic::new( + MultiValueRepeatedKeyLiteral { + name: SourceCodeSnippet::from_str(checker.locator().slice(key)), + existing: SourceCodeSnippet::from_str( + checker.locator().slice(*seen_key), + ), + }, + key.range(), + ); + if !seen_values.insert(comparable_value) { + diagnostic.set_fix(Fix::unsafe_edit(Edit::deletion( + parenthesized_range( + dict.value(i - 1).into(), + dict.into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or_else(|| dict.value(i - 1).range()) + .end(), + parenthesized_range( + dict.value(i).into(), + dict.into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or_else(|| dict.value(i).range()) + .end(), + ))); + } + checker.report_diagnostic(diagnostic); + } + } + Expr::Name(_) => { + if checker.enabled(Rule::MultiValueRepeatedKeyVariable) { + let mut diagnostic = Diagnostic::new( + MultiValueRepeatedKeyVariable { + name: SourceCodeSnippet::from_str(checker.locator().slice(key)), + }, + key.range(), + ); + let comparable_value: ComparableExpr = dict.value(i).into(); + if !seen_values.insert(comparable_value) { + diagnostic.set_fix(Fix::unsafe_edit(Edit::deletion( + parenthesized_range( + dict.value(i - 1).into(), + dict.into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or_else(|| dict.value(i - 1).range()) + .end(), + parenthesized_range( + dict.value(i).into(), + dict.into(), + checker.comment_ranges(), + checker.locator().contents(), + ) + .unwrap_or_else(|| dict.value(i).range()) + .end(), + ))); + } + checker.report_diagnostic(diagnostic); + } } - checker.diagnostics.push(diagnostic); + _ => {} } } - _ => {} } } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/return_outside_function.rs b/crates/ruff_linter/src/rules/pyflakes/rules/return_outside_function.rs index 4398d5afad06d..c4c8eb0c32877 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/return_outside_function.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/return_outside_function.rs @@ -1,11 +1,5 @@ -use ruff_python_ast::Stmt; - -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_semantic::ScopeKind; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; +use ruff_diagnostics::Violation; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for `return` statements outside of functions. @@ -22,23 +16,12 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `return`](https://docs.python.org/3/reference/simple_stmts.html#the-return-statement) -#[violation] -pub struct ReturnOutsideFunction; +#[derive(ViolationMetadata)] +pub(crate) struct ReturnOutsideFunction; impl Violation for ReturnOutsideFunction { #[derive_message_formats] fn message(&self) -> String { - format!("`return` statement outside of a function/method") - } -} - -pub(crate) fn return_outside_function(checker: &mut Checker, stmt: &Stmt) { - if matches!( - checker.semantic().current_scope().kind, - ScopeKind::Class(_) | ScopeKind::Module - ) { - checker - .diagnostics - .push(Diagnostic::new(ReturnOutsideFunction, stmt.range())); + "`return` statement outside of a function/method".to_string() } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/starred_expressions.rs b/crates/ruff_linter/src/rules/pyflakes/rules/starred_expressions.rs index 50903a026e96c..fb7e04f20b0da 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/starred_expressions.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/starred_expressions.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use ruff_text_size::TextRange; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for the use of too many expressions in starred assignment statements. @@ -13,13 +13,16 @@ use ruff_macros::{derive_message_formats, violation}; /// In Python 3, no more than 1 << 8 assignments are allowed before a starred /// expression, and no more than 1 << 24 expressions are allowed after a starred /// expression. -#[violation] -pub struct ExpressionsInStarAssignment; +/// +/// ## References +/// - [PEP 3132 – Extended Iterable Unpacking](https://peps.python.org/pep-3132/) +#[derive(ViolationMetadata)] +pub(crate) struct ExpressionsInStarAssignment; impl Violation for ExpressionsInStarAssignment { #[derive_message_formats] fn message(&self) -> String { - format!("Too many expressions in star-unpacking assignment") + "Too many expressions in star-unpacking assignment".to_string() } } @@ -38,14 +41,14 @@ impl Violation for ExpressionsInStarAssignment { /// ``` /// /// ## References -/// - [PEP 3132](https://peps.python.org/pep-3132/) -#[violation] -pub struct MultipleStarredExpressions; +/// - [PEP 3132 – Extended Iterable Unpacking](https://peps.python.org/pep-3132/) +#[derive(ViolationMetadata)] +pub(crate) struct MultipleStarredExpressions; impl Violation for MultipleStarredExpressions { #[derive_message_formats] fn message(&self) -> String { - format!("Two starred expressions in assignment") + "Two starred expressions in assignment".to_string() } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/strings.rs b/crates/ruff_linter/src/rules/pyflakes/rules/strings.rs index acbfd5ef14849..4dde25b703129 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/strings.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/strings.rs @@ -3,7 +3,7 @@ use std::string::ToString; use rustc_hash::FxHashSet; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr, Keyword}; use ruff_text_size::{Ranged, TextRange}; @@ -36,8 +36,8 @@ use super::super::format::FormatSummary; /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatInvalidFormat { +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatInvalidFormat { pub(crate) message: String, } @@ -75,13 +75,13 @@ impl Violation for PercentFormatInvalidFormat { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatExpectedMapping; +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatExpectedMapping; impl Violation for PercentFormatExpectedMapping { #[derive_message_formats] fn message(&self) -> String { - format!("`%`-format string expected mapping but got sequence") + "`%`-format string expected mapping but got sequence".to_string() } } @@ -111,13 +111,13 @@ impl Violation for PercentFormatExpectedMapping { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatExpectedSequence; +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatExpectedSequence; impl Violation for PercentFormatExpectedSequence { #[derive_message_formats] fn message(&self) -> String { - format!("`%`-format string expected sequence but got mapping") + "`%`-format string expected sequence but got mapping".to_string() } } @@ -140,8 +140,8 @@ impl Violation for PercentFormatExpectedSequence { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatExtraNamedArguments { +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatExtraNamedArguments { missing: Vec<String>, } @@ -180,8 +180,8 @@ impl AlwaysFixableViolation for PercentFormatExtraNamedArguments { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatMissingArgument { +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatMissingArgument { missing: Vec<String>, } @@ -220,13 +220,13 @@ impl Violation for PercentFormatMissingArgument { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatMixedPositionalAndNamed; +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatMixedPositionalAndNamed; impl Violation for PercentFormatMixedPositionalAndNamed { #[derive_message_formats] fn message(&self) -> String { - format!("`%`-format string has mixed positional and named placeholders") + "`%`-format string has mixed positional and named placeholders".to_string() } } @@ -250,8 +250,8 @@ impl Violation for PercentFormatMixedPositionalAndNamed { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatPositionalCountMismatch { +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatPositionalCountMismatch { wanted: usize, got: usize, } @@ -288,13 +288,13 @@ impl Violation for PercentFormatPositionalCountMismatch { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatStarRequiresSequence; +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatStarRequiresSequence; impl Violation for PercentFormatStarRequiresSequence { #[derive_message_formats] fn message(&self) -> String { - format!("`%`-format string `*` specifier requires sequence") + "`%`-format string `*` specifier requires sequence".to_string() } } @@ -318,8 +318,8 @@ impl Violation for PercentFormatStarRequiresSequence { /// /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) -#[violation] -pub struct PercentFormatUnsupportedFormatCharacter { +#[derive(ViolationMetadata)] +pub(crate) struct PercentFormatUnsupportedFormatCharacter { pub(crate) char: char, } @@ -349,8 +349,8 @@ impl Violation for PercentFormatUnsupportedFormatCharacter { /// /// ## References /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct StringDotFormatInvalidFormat { +#[derive(ViolationMetadata)] +pub(crate) struct StringDotFormatInvalidFormat { pub(crate) message: String, } @@ -381,8 +381,8 @@ impl Violation for StringDotFormatInvalidFormat { /// /// ## References /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct StringDotFormatExtraNamedArguments { +#[derive(ViolationMetadata)] +pub(crate) struct StringDotFormatExtraNamedArguments { missing: Vec<Name>, } @@ -422,8 +422,8 @@ impl Violation for StringDotFormatExtraNamedArguments { /// /// ## References /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct StringDotFormatExtraPositionalArguments { +#[derive(ViolationMetadata)] +pub(crate) struct StringDotFormatExtraPositionalArguments { missing: Vec<String>, } @@ -465,8 +465,8 @@ impl Violation for StringDotFormatExtraPositionalArguments { /// /// ## References /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct StringDotFormatMissingArguments { +#[derive(ViolationMetadata)] +pub(crate) struct StringDotFormatMissingArguments { missing: Vec<String>, } @@ -503,13 +503,13 @@ impl Violation for StringDotFormatMissingArguments { /// /// ## References /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct StringDotFormatMixingAutomatic; +#[derive(ViolationMetadata)] +pub(crate) struct StringDotFormatMixingAutomatic; impl Violation for StringDotFormatMixingAutomatic { #[derive_message_formats] fn message(&self) -> String { - format!("`.format` string mixes automatic and manual numbering") + "`.format` string mixes automatic and manual numbering".to_string() } } @@ -525,7 +525,7 @@ fn has_star_args(args: &[Expr]) -> bool { /// F502 pub(crate) fn percent_format_expected_mapping( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, @@ -538,9 +538,9 @@ pub(crate) fn percent_format_expected_mapping( | Expr::Set(_) | Expr::ListComp(_) | Expr::SetComp(_) - | Expr::Generator(_) => checker - .diagnostics - .push(Diagnostic::new(PercentFormatExpectedMapping, location)), + | Expr::Generator(_) => { + checker.report_diagnostic(Diagnostic::new(PercentFormatExpectedMapping, location)); + } _ => {} } } @@ -548,21 +548,19 @@ pub(crate) fn percent_format_expected_mapping( /// F503 pub(crate) fn percent_format_expected_sequence( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, ) { if summary.num_positional > 1 && matches!(right, Expr::Dict(_) | Expr::DictComp(_)) { - checker - .diagnostics - .push(Diagnostic::new(PercentFormatExpectedSequence, location)); + checker.report_diagnostic(Diagnostic::new(PercentFormatExpectedSequence, location)); } } /// F504 pub(crate) fn percent_format_extra_named_arguments( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, @@ -615,12 +613,12 @@ pub(crate) fn percent_format_extra_named_arguments( )?; Ok(Fix::safe_edit(edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// F505 pub(crate) fn percent_format_missing_arguments( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, @@ -656,7 +654,7 @@ pub(crate) fn percent_format_missing_arguments( .collect(); if !missing.is_empty() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PercentFormatMissingArgument { missing: missing.iter().map(|&s| s.clone()).collect(), }, @@ -667,12 +665,12 @@ pub(crate) fn percent_format_missing_arguments( /// F506 pub(crate) fn percent_format_mixed_positional_and_named( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, location: TextRange, ) { if !(summary.num_positional == 0 || summary.keywords.is_empty()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PercentFormatMixedPositionalAndNamed, location, )); @@ -681,7 +679,7 @@ pub(crate) fn percent_format_mixed_positional_and_named( /// F507 pub(crate) fn percent_format_positional_count_mismatch( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, @@ -700,7 +698,7 @@ pub(crate) fn percent_format_positional_count_mismatch( } if found != summary.num_positional { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( PercentFormatPositionalCountMismatch { wanted: summary.num_positional, got: found, @@ -713,7 +711,7 @@ pub(crate) fn percent_format_positional_count_mismatch( /// F508 pub(crate) fn percent_format_star_requires_sequence( - checker: &mut Checker, + checker: &Checker, summary: &CFormatSummary, right: &Expr, location: TextRange, @@ -721,8 +719,7 @@ pub(crate) fn percent_format_star_requires_sequence( if summary.starred { match right { Expr::Dict(_) | Expr::DictComp(_) => checker - .diagnostics - .push(Diagnostic::new(PercentFormatStarRequiresSequence, location)), + .report_diagnostic(Diagnostic::new(PercentFormatStarRequiresSequence, location)), _ => {} } } @@ -730,7 +727,7 @@ pub(crate) fn percent_format_star_requires_sequence( /// F522 pub(crate) fn string_dot_format_extra_named_arguments( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary, keywords: &[Keyword], @@ -774,12 +771,12 @@ pub(crate) fn string_dot_format_extra_named_arguments( )?; Ok(Fix::safe_edit(edit)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// F523 pub(crate) fn string_dot_format_extra_positional_arguments( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary, args: &[Expr], @@ -844,12 +841,12 @@ pub(crate) fn string_dot_format_extra_positional_arguments( }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// F524 pub(crate) fn string_dot_format_missing_argument( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary, args: &[Expr], @@ -883,7 +880,7 @@ pub(crate) fn string_dot_format_missing_argument( .collect(); if !missing.is_empty() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StringDotFormatMissingArguments { missing }, call.range(), )); @@ -892,12 +889,12 @@ pub(crate) fn string_dot_format_missing_argument( /// F525 pub(crate) fn string_dot_format_mixing_automatic( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary, ) { if !(summary.autos.is_empty() || summary.indices.is_empty()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( StringDotFormatMixingAutomatic, call.range(), )); diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_export.rs b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_export.rs index a922c43b3efd1..a7ba8f3b5d9a7 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_export.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_export.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for undefined names in `__all__`. @@ -38,8 +38,8 @@ use ruff_macros::{derive_message_formats, violation}; /// - [Python documentation: `__all__`](https://docs.python.org/3/tutorial/modules.html#importing-from-a-package) /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct UndefinedExport { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedExport { pub name: String, } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_local.rs b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_local.rs index c727464f8bda2..25093d9ea0f37 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_local.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_local.rs @@ -1,7 +1,8 @@ use std::string::ToString; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::BindingKind::SubmoduleImport; use ruff_python_semantic::{Scope, ScopeId}; use ruff_text_size::Ranged; @@ -32,8 +33,8 @@ use crate::checkers::ast::Checker; /// global x /// x += 1 /// ``` -#[violation] -pub struct UndefinedLocal { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedLocal { name: String, } @@ -46,12 +47,7 @@ impl Violation for UndefinedLocal { } /// F823 -pub(crate) fn undefined_local( - checker: &Checker, - scope_id: ScopeId, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn undefined_local(checker: &Checker, scope_id: ScopeId, scope: &Scope) { if scope.kind.is_function() { for (name, binding_id) in scope.bindings() { // If the variable shadows a binding in a parent scope... @@ -61,13 +57,18 @@ pub(crate) fn undefined_local( if let Some(range) = shadowed.references().find_map(|reference_id| { let reference = checker.semantic().reference(reference_id); if reference.scope_id() == scope_id { - Some(reference.range()) + // FIXME: ignore submodules + if let SubmoduleImport(..) = shadowed.kind { + None + } else { + Some(reference.range()) + } } else { None } }) { // Then it's probably an error. - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UndefinedLocal { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_name.rs b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_name.rs index 0c46c14a44a21..d21d72e267043 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/undefined_name.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/undefined_name.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for uses of undefined names. @@ -25,8 +25,8 @@ use ruff_macros::{derive_message_formats, violation}; /// /// ## References /// - [Python documentation: Naming and binding](https://docs.python.org/3/reference/executionmodel.html#naming-and-binding) -#[violation] -pub struct UndefinedName { +#[derive(ViolationMetadata)] +pub(crate) struct UndefinedName { pub(crate) name: String, pub(crate) minor_version_builtin_added: Option<u8>, } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/unused_annotation.rs b/crates/ruff_linter/src/rules/pyflakes/rules/unused_annotation.rs index ad5e383db692f..1494650747316 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/unused_annotation.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/unused_annotation.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Scope; use ruff_text_size::Ranged; @@ -19,9 +19,9 @@ use crate::checkers::ast::Checker; /// ``` /// /// ## References -/// - [PEP 484](https://peps.python.org/pep-0484/) -#[violation] -pub struct UnusedAnnotation { +/// - [PEP 484 – Type Hints](https://peps.python.org/pep-0484/) +#[derive(ViolationMetadata)] +pub(crate) struct UnusedAnnotation { name: String, } @@ -34,11 +34,7 @@ impl Violation for UnusedAnnotation { } /// F842 -pub(crate) fn unused_annotation( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn unused_annotation(checker: &Checker, scope: &Scope) { for (name, range) in scope.bindings().filter_map(|(name, binding_id)| { let binding = checker.semantic().binding(binding_id); if binding.kind.is_annotation() @@ -50,6 +46,6 @@ pub(crate) fn unused_annotation( None } }) { - diagnostics.push(Diagnostic::new(UnusedAnnotation { name }, range)); + checker.report_diagnostic(Diagnostic::new(UnusedAnnotation { name }, range)); } } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/unused_import.rs b/crates/ruff_linter/src/rules/pyflakes/rules/unused_import.rs index 3f6efbba07aaa..1f97bac5f9efa 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/unused_import.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/unused_import.rs @@ -1,21 +1,27 @@ use std::borrow::Cow; use std::iter; +use unicode_normalization::UnicodeNormalization; -use anyhow::{anyhow, bail, Result}; -use std::collections::BTreeMap; +use anyhow::{Result, anyhow, bail}; +use std::collections::{BTreeMap, HashSet}; use ruff_diagnostics::{Applicability, Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::{self as ast, Stmt}; use ruff_python_semantic::{ - AnyImport, BindingKind, Exceptions, Imported, NodeId, Scope, SemanticModel, SubmoduleImport, + AnyImport, BindingKind, Exceptions, Imported, NodeId, Scope, ScopeId, SemanticModel, + SubmoduleImport, }; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::fix; +use crate::preview::{ + is_dunder_init_fix_unused_import_enabled, is_full_path_match_source_strategy_enabled, +}; use crate::registry::Rule; +use crate::rules::isort::categorize::MatchSourceStrategy; use crate::rules::{isort, isort::ImportSection, isort::ImportType}; /// ## What it does @@ -86,15 +92,21 @@ use crate::rules::{isort, isort::ImportSection, isort::ImportType}; /// print("numpy is not installed") /// ``` /// +/// ## Preview +/// When [preview](https://docs.astral.sh/ruff/preview/) is enabled, +/// the criterion for determining whether an import is first-party +/// is stricter, which could affect the suggested fix. See [this FAQ section](https://docs.astral.sh/ruff/faq/#how-does-ruff-determine-which-of-my-imports-are-first-party-third-party-etc) for more details. +/// /// ## Options /// - `lint.ignore-init-module-imports` +/// - `lint.pyflakes.allowed-unused-imports` /// /// ## References /// - [Python documentation: `import`](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement) /// - [Python documentation: `importlib.util.find_spec`](https://docs.python.org/3/library/importlib.html#importlib.util.find_spec) -/// - [Typing documentation: interface conventions](https://typing.readthedocs.io/en/latest/source/libraries.html#library-interface-public-and-private-symbols) -#[violation] -pub struct UnusedImport { +/// - [Typing documentation: interface conventions](https://typing.python.org/en/latest/source/libraries.html#library-interface-public-and-private-symbols) +#[derive(ViolationMetadata)] +pub(crate) struct UnusedImport { /// Qualified name of the import name: String, /// Unqualified name of the import @@ -147,12 +159,12 @@ impl Violation for UnusedImport { submodule_import: true, } => { return Some(format!( - "Use an explicit re-export: `import {parent} as {parent}; import {binding}`", - parent = binding - .split('.') - .next() - .expect("Expected all submodule imports to contain a '.'") - )) + "Use an explicit re-export: `import {parent} as {parent}; import {binding}`", + parent = binding + .split('.') + .next() + .expect("Expected all submodule imports to contain a '.'") + )); } UnusedImportContext::DunderInitFirstParty { dunder_all_count: DunderAllCount::One, @@ -168,7 +180,7 @@ impl Violation for UnusedImport { .split('.') .next() .expect("Expected all submodule imports to contain a '.'") - )) + )); } UnusedImportContext::DunderInitFirstParty { dunder_all_count: DunderAllCount::Many, @@ -219,18 +231,24 @@ enum UnusedImportContext { } fn is_first_party(import: &AnyImport, checker: &Checker) -> bool { - let qualified_name = import.qualified_name(); + let source_name = import.source_name().join("."); + let match_source_strategy = if is_full_path_match_source_strategy_enabled(checker.settings) { + MatchSourceStrategy::FullPath + } else { + MatchSourceStrategy::Root + }; let category = isort::categorize( - &qualified_name.to_string(), - qualified_name.is_unresolved_import(), + &source_name, + import.qualified_name().is_unresolved_import(), &checker.settings.src, checker.package(), checker.settings.isort.detect_same_package, &checker.settings.isort.known_modules, - checker.settings.target_version, + checker.target_version(), checker.settings.isort.no_sections, &checker.settings.isort.section_order, &checker.settings.isort.default_section, + match_source_strategy, ); matches! { category, @@ -271,85 +289,106 @@ fn find_dunder_all_exprs<'a>(semantic: &'a SemanticModel) -> Vec<&'a ast::Expr> /// ¬__init__.py ∧ stdlib → safe, remove /// ¬__init__.py ∧ 3rdpty → safe, remove /// -pub(crate) fn unused_import(checker: &Checker, scope: &Scope, diagnostics: &mut Vec<Diagnostic>) { +pub(crate) fn unused_import(checker: &Checker, scope: &Scope) { // Collect all unused imports by statement. let mut unused: BTreeMap<(NodeId, Exceptions), Vec<ImportBinding>> = BTreeMap::default(); let mut ignored: BTreeMap<(NodeId, Exceptions), Vec<ImportBinding>> = BTreeMap::default(); + let mut already_checked_imports: HashSet<&str> = HashSet::new(); for binding_id in scope.binding_ids() { - let binding = checker.semantic().binding(binding_id); - - if binding.is_used() - || binding.is_explicit_export() - || binding.is_nonlocal() - || binding.is_global() - { - continue; - } + let top_binding = checker.semantic().binding(binding_id); - let Some(import) = binding.as_any_import() else { + let Some(_) = top_binding.as_any_import() else { continue; }; - let Some(node_id) = binding.source else { - continue; - }; - - let name = binding.name(checker.source()); + let binding_name = top_binding + .name(checker.source()) + .split('.') + .next() + .unwrap_or(""); - // If an import is marked as required, avoid treating it as unused, regardless of whether - // it was _actually_ used. - if checker - .settings - .isort - .required_imports - .iter() - .any(|required_import| required_import.matches(name, &import)) + for binding in scope + .get_all(&binding_name.nfkc().collect::<String>()) + .map(|binding_id| checker.semantic().binding(binding_id)) { - continue; - } + let name = binding.name(checker.source()); - // If an import was marked as allowed, avoid treating it as unused. - if checker - .settings - .pyflakes - .allowed_unused_imports - .iter() - .any(|allowed_unused_import| { - let allowed_unused_import = QualifiedName::from_dotted_name(allowed_unused_import); - import.qualified_name().starts_with(&allowed_unused_import) - }) - { - continue; - } + if already_checked_imports.contains(&name) { + continue; + } + { + already_checked_imports.insert(name); + } - let import = ImportBinding { - name, - import, - range: binding.range(), - parent_range: binding.parent_range(checker.semantic()), - }; + if binding.is_used() + || binding.is_explicit_export() + || binding.is_nonlocal() + || binding.is_global() + { + continue; + } - if checker.rule_is_ignored(Rule::UnusedImport, import.start()) - || import.parent_range.is_some_and(|parent_range| { - checker.rule_is_ignored(Rule::UnusedImport, parent_range.start()) - }) - { - ignored - .entry((node_id, binding.exceptions)) - .or_default() - .push(import); - } else { - unused - .entry((node_id, binding.exceptions)) - .or_default() - .push(import); + let Some(import) = binding.as_any_import() else { + continue; + }; + + let Some(stmt_id) = binding.source else { + continue; + }; + + // If an import is marked as required, avoid treating it as unused, regardless of whether + // it was _actually_ used. + if checker + .settings + .isort + .required_imports + .iter() + .any(|required_import| required_import.matches(name, &import)) + { + continue; + } + + // If an import was marked as allowed, avoid treating it as unused. + if checker.settings.pyflakes.allowed_unused_imports.iter().any( + |allowed_unused_import| { + let allowed_unused_import = + QualifiedName::from_dotted_name(allowed_unused_import); + import.qualified_name().starts_with(&allowed_unused_import) + }, + ) { + continue; + } + + let import = ImportBinding { + name, + import, + range: binding.range(), + parent_range: binding.parent_range(checker.semantic()), + scope: binding.scope, + }; + + if checker.rule_is_ignored(Rule::UnusedImport, import.start()) + || import.parent_range.is_some_and(|parent_range| { + checker.rule_is_ignored(Rule::UnusedImport, parent_range.start()) + }) + { + ignored + .entry((stmt_id, binding.exceptions)) + .or_default() + .push(import); + } else { + unused + .entry((stmt_id, binding.exceptions)) + .or_default() + .push(import); + } } } let in_init = checker.path().ends_with("__init__.py"); let fix_init = !checker.settings.ignore_init_module_imports; - let preview_mode = checker.settings.preview.is_enabled(); + let preview_mode = is_dunder_init_fix_unused_import_enabled(checker.settings); let dunder_all_exprs = find_dunder_all_exprs(checker.semantic()); // Generate a diagnostic for every import, but share fixes across all imports within the same @@ -365,7 +404,10 @@ pub(crate) fn unused_import(checker: &Checker, scope: &Scope, diagnostics: &mut .map(|binding| { let context = if in_except_handler { UnusedImportContext::ExceptHandler - } else if in_init && is_first_party(&binding.import, checker) { + } else if in_init + && binding.scope.is_global() + && is_first_party(&binding.import, checker) + { UnusedImportContext::DunderInitFirstParty { dunder_all_count: DunderAllCount::from(dunder_all_exprs.len()), submodule_import: binding.import.is_submodule_import(), @@ -423,7 +465,7 @@ pub(crate) fn unused_import(checker: &Checker, scope: &Scope, diagnostics: &mut diagnostic.set_fix(fix.clone()); } } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -444,7 +486,7 @@ pub(crate) fn unused_import(checker: &Checker, scope: &Scope, diagnostics: &mut if let Some(range) = binding.parent_range { diagnostic.set_parent(range.start()); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -459,9 +501,11 @@ struct ImportBinding<'a> { range: TextRange, /// The range of the import's parent statement. parent_range: Option<TextRange>, + /// The [`ScopeId`] of the scope in which the [`ImportBinding`] was defined. + scope: ScopeId, } -impl<'a> ImportBinding<'a> { +impl ImportBinding<'_> { /// The symbol that is stored in the outer scope as a result of this import. /// /// For example: diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/unused_variable.rs b/crates/ruff_linter/src/rules/pyflakes/rules/unused_variable.rs index 1bd813f65a54c..2305eaf043b1f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/unused_variable.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/unused_variable.rs @@ -1,12 +1,12 @@ use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Stmt}; use ruff_python_parser::{TokenKind, Tokens}; -use ruff_python_semantic::{Binding, Scope}; +use ruff_python_semantic::Binding; use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::checkers::ast::Checker; @@ -23,9 +23,6 @@ use crate::fix::edits::delete_stmt; /// prefixed with an underscore, or some other value that adheres to the /// [`lint.dummy-variable-rgx`] pattern. /// -/// Under [preview mode](https://docs.astral.sh/ruff/preview), this rule also -/// triggers on unused unpacked assignments (for example, `x, y = foo()`). -/// /// ## Example /// ```python /// def foo(): @@ -41,10 +38,15 @@ use crate::fix::edits::delete_stmt; /// return x /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because removing an unused variable assignment may +/// delete comments that are attached to the assignment. +/// /// ## Options /// - `lint.dummy-variable-rgx` -#[violation] -pub struct UnusedVariable { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedVariable { pub name: String, } @@ -249,47 +251,19 @@ fn remove_unused_variable(binding: &Binding, checker: &Checker) -> Option<Fix> { } /// F841 -pub(crate) fn unused_variable(checker: &Checker, scope: &Scope, diagnostics: &mut Vec<Diagnostic>) { - if scope.uses_locals() && scope.kind.is_function() { +pub(crate) fn unused_variable(checker: &Checker, name: &str, binding: &Binding) { + if binding.is_unpacked_assignment() { return; } - for (name, binding) in scope - .bindings() - .map(|(name, binding_id)| (name, checker.semantic().binding(binding_id))) - .filter_map(|(name, binding)| { - if (binding.kind.is_assignment() - || binding.kind.is_named_expr_assignment() - || binding.kind.is_with_item_var()) - // Stabilization depends on resolving https://github.com/astral-sh/ruff/issues/8884 - && (!binding.is_unpacked_assignment() || checker.settings.preview.is_enabled()) - && binding.is_unused() - && !binding.is_nonlocal() - && !binding.is_global() - && !checker.settings.dummy_variable_rgx.is_match(name) - && !matches!( - name, - "__tracebackhide__" - | "__traceback_info__" - | "__traceback_supplement__" - | "__debuggerskip__" - ) - { - return Some((name, binding)); - } - - None - }) - { - let mut diagnostic = Diagnostic::new( - UnusedVariable { - name: name.to_string(), - }, - binding.range(), - ); - if let Some(fix) = remove_unused_variable(binding, checker) { - diagnostic.set_fix(fix); - } - diagnostics.push(diagnostic); + let mut diagnostic = Diagnostic::new( + UnusedVariable { + name: name.to_string(), + }, + binding.range(), + ); + if let Some(fix) = remove_unused_variable(binding, checker) { + diagnostic.set_fix(fix); } + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyflakes/rules/yield_outside_function.rs b/crates/ruff_linter/src/rules/pyflakes/rules/yield_outside_function.rs index 4fa5d3e8d0bd3..22d3a4e8099dd 100644 --- a/crates/ruff_linter/src/rules/pyflakes/rules/yield_outside_function.rs +++ b/crates/ruff_linter/src/rules/pyflakes/rules/yield_outside_function.rs @@ -1,14 +1,11 @@ use std::fmt; -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::Expr; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; +use ruff_diagnostics::Violation; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_parser::semantic_errors::YieldOutsideFunctionKind; #[derive(Debug, PartialEq, Eq)] -enum DeferralKeyword { +pub(crate) enum DeferralKeyword { Yield, YieldFrom, Await, @@ -24,6 +21,16 @@ impl fmt::Display for DeferralKeyword { } } +impl From<YieldOutsideFunctionKind> for DeferralKeyword { + fn from(value: YieldOutsideFunctionKind) -> Self { + match value { + YieldOutsideFunctionKind::Yield => Self::Yield, + YieldOutsideFunctionKind::YieldFrom => Self::YieldFrom, + YieldOutsideFunctionKind::Await => Self::Await, + } + } +} + /// ## What it does /// Checks for `yield`, `yield from`, and `await` usages outside of functions. /// @@ -31,24 +38,33 @@ impl fmt::Display for DeferralKeyword { /// The use of `yield`, `yield from`, or `await` outside of a function will /// raise a `SyntaxError`. /// -/// As an exception, `await` is allowed at the top level of a Jupyter notebook -/// (see: [autoawait]). -/// /// ## Example /// ```python /// class Foo: /// yield 1 /// ``` /// +/// ## Notebook behavior +/// As an exception, `await` is allowed at the top level of a Jupyter notebook +/// (see: [autoawait]). +/// /// ## References /// - [Python documentation: `yield`](https://docs.python.org/3/reference/simple_stmts.html#the-yield-statement) /// /// [autoawait]: https://ipython.readthedocs.io/en/stable/interactive/autoawait.html -#[violation] -pub struct YieldOutsideFunction { +#[derive(ViolationMetadata)] +pub(crate) struct YieldOutsideFunction { keyword: DeferralKeyword, } +impl YieldOutsideFunction { + pub(crate) fn new(keyword: impl Into<DeferralKeyword>) -> Self { + Self { + keyword: keyword.into(), + } + } +} + impl Violation for YieldOutsideFunction { #[derive_message_formats] fn message(&self) -> String { @@ -56,30 +72,3 @@ impl Violation for YieldOutsideFunction { format!("`{keyword}` statement outside of a function") } } - -/// F704 -pub(crate) fn yield_outside_function(checker: &mut Checker, expr: &Expr) { - let scope = checker.semantic().current_scope(); - if scope.kind.is_module() || scope.kind.is_class() { - let keyword = match expr { - Expr::Yield(_) => DeferralKeyword::Yield, - Expr::YieldFrom(_) => DeferralKeyword::YieldFrom, - Expr::Await(_) => DeferralKeyword::Await, - _ => return, - }; - - // `await` is allowed at the top level of a Jupyter notebook. - // See: https://ipython.readthedocs.io/en/stable/interactive/autoawait.html. - if scope.kind.is_module() - && checker.source_type.is_ipynb() - && keyword == DeferralKeyword::Await - { - return; - } - - checker.diagnostics.push(Diagnostic::new( - YieldOutsideFunction { keyword }, - expr.range(), - )); - } -} diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_0.py.snap index 433865de23481..879fe8013b676 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_0.py.snap @@ -39,6 +39,46 @@ F401_0.py:6:5: F401 [*] `collections.OrderedDict` imported but unused 8 7 | ) 9 8 | import multiprocessing.pool +F401_0.py:10:8: F401 [*] `multiprocessing.process` imported but unused + | + 8 | ) + 9 | import multiprocessing.pool +10 | import multiprocessing.process + | ^^^^^^^^^^^^^^^^^^^^^^^ F401 +11 | import logging.config +12 | import logging.handlers + | + = help: Remove unused import: `multiprocessing.process` + +ℹ Safe fix +7 7 | namedtuple, +8 8 | ) +9 9 | import multiprocessing.pool +10 |-import multiprocessing.process +11 10 | import logging.config +12 11 | import logging.handlers +13 12 | from typing import ( + +F401_0.py:11:8: F401 [*] `logging.config` imported but unused + | + 9 | import multiprocessing.pool +10 | import multiprocessing.process +11 | import logging.config + | ^^^^^^^^^^^^^^ F401 +12 | import logging.handlers +13 | from typing import ( + | + = help: Remove unused import: `logging.config` + +ℹ Safe fix +8 8 | ) +9 9 | import multiprocessing.pool +10 10 | import multiprocessing.process +11 |-import logging.config +12 11 | import logging.handlers +13 12 | from typing import ( +14 13 | TYPE_CHECKING, + F401_0.py:12:8: F401 [*] `logging.handlers` imported but unused | 10 | import multiprocessing.process @@ -83,7 +123,7 @@ F401_0.py:33:12: F401 [*] `importlib` imported but unused 32 | import shelve 33 | import importlib | ^^^^^^^^^ F401 -34 | +34 | 35 | if TYPE_CHECKING: | = help: Remove unused import: `importlib` @@ -103,7 +143,7 @@ F401_0.py:37:12: F401 [*] `pathlib` imported but unused 36 | """Hello, world!""" 37 | import pathlib | ^^^^^^^ F401 -38 | +38 | 39 | z = 1 | = help: Remove unused import: `pathlib` @@ -178,7 +218,7 @@ F401_0.py:99:8: F401 [*] `foo.bar.baz` imported but unused 98 | import foo.bar as bop 99 | import foo.bar.baz | ^^^^^^^^^^^ F401 -100 | +100 | 101 | print(bop.baz.read_csv("test.csv")) | = help: Remove unused import: `foo.bar.baz` @@ -198,7 +238,7 @@ F401_0.py:105:12: F401 [*] `a1` imported but unused 104 | if TYPE_CHECKING: 105 | import a1 | ^^ F401 -106 | +106 | 107 | import a2 | = help: Remove unused import: `a1` @@ -215,7 +255,7 @@ F401_0.py:105:12: F401 [*] `a1` imported but unused F401_0.py:107:12: F401 [*] `a2` imported but unused | 105 | import a1 -106 | +106 | 107 | import a2 | ^^ F401 | @@ -236,7 +276,7 @@ F401_0.py:112:16: F401 [*] `b1` imported but unused 111 | case 0,: 112 | import b1 | ^^ F401 -113 | +113 | 114 | import b2 | = help: Remove unused import: `b1` @@ -253,7 +293,7 @@ F401_0.py:112:16: F401 [*] `b1` imported but unused F401_0.py:114:16: F401 [*] `b2` imported but unused | 112 | import b1 -113 | +113 | 114 | import b2 | ^^ F401 | @@ -282,5 +322,3 @@ F401_0.py:122:1: F401 [*] `datameta_client_lib.model_helpers.noqa` imported but 120 120 | 121 |-from datameta_client_lib.model_helpers import ( 122 |-noqa ) - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_1.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_10.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_10.py.snap index 213cd18b0a3cc..55ff498a0534d 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_10.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_10.py.snap @@ -7,7 +7,7 @@ F401_10.py:6:16: F401 `orjson` imported but unused; consider using `importlib.ut 5 | try: 6 | import orjson | ^^^^^^ F401 -7 | +7 | 8 | return True | = help: Remove unused import: `orjson` @@ -18,9 +18,7 @@ F401_10.py:15:16: F401 `orjson` imported but unused; consider using `importlib.u 14 | try: 15 | import orjson | ^^^^^^ F401 -16 | +16 | 17 | return True | = help: Remove unused import: `orjson` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_11.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_11.py.snap index 39c9b95a011e2..88d251d0fa2de 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_11.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_11.py:4:27: F401 [*] `pathlib.PurePath` imported but unused | @@ -18,5 +19,3 @@ F401_11.py:4:27: F401 [*] `pathlib.PurePath` imported but unused 5 5 | 6 6 | 7 7 | x: """List['Path']""" = [] - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_12.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_12.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_12.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_12.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_13.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_13.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_13.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_13.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_14.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_14.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_14.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_14.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_15.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_15.py.snap index cd5526e8f4fde..e868e4a4661de 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_15.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_15.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_15.py:5:25: F401 [*] `pathlib.Path` imported but unused | @@ -18,5 +19,3 @@ F401_15.py:5:25: F401 [*] `pathlib.Path` imported but unused 6 6 | 7 7 | 8 8 | class Foo: - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_16.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_16.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_16.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_16.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_17.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_17.py.snap index caf5d2c6767c3..24a1dc4ff184d 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_17.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_17.py.snap @@ -6,7 +6,7 @@ F401_17.py:12:27: F401 [*] `threading.Thread` imported but unused 11 | def fn(thread: Thread): 12 | from threading import Thread | ^^^^^^ F401 -13 | +13 | 14 | # The `Thread` on the left-hand side should resolve to the `Thread` imported at the | = help: Remove unused import: `threading.Thread` @@ -25,7 +25,7 @@ F401_17.py:20:27: F401 [*] `threading.Thread` imported but unused 19 | def fn(thread: Thread): 20 | from threading import Thread | ^^^^^^ F401 -21 | +21 | 22 | # The `Thread` on the left-hand side should resolve to the `Thread` imported at the | = help: Remove unused import: `threading.Thread` @@ -38,5 +38,3 @@ F401_17.py:20:27: F401 [*] `threading.Thread` imported but unused 21 20 | 22 21 | # The `Thread` on the left-hand side should resolve to the `Thread` imported at the 23 22 | # top level. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_18.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_18.py.snap index 33647bd2bf029..031fe90e78400 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_18.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_18.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_18.py:5:12: F401 [*] `__future__` imported but unused | @@ -18,5 +19,3 @@ F401_18.py:5:12: F401 [*] `__future__` imported but unused 6 6 | 7 7 | 8 8 | def f(): - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_19.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_19.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_19.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_19.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_2.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_2.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_2.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_20.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_20.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_20.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_20.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_21.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_21.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_21.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_21.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_22.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_22.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_22.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_22.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_23.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_23.py.snap index afde9e550a87d..5fabeda173566 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_23.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_23.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_23.py:4:16: F401 [*] `re.RegexFlag` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_3.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_3.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_3.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_32.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_32.py.snap new file mode 100644 index 0000000000000..a487e4ddb80cf --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_32.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_34.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_34.py.snap new file mode 100644 index 0000000000000..519e21f21a11d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_34.py.snap @@ -0,0 +1,41 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +--- +F401_34.py:45:24: F401 [*] `typing.Union` imported but unused + | +43 | # expressions either!) +44 | def f(): +45 | from typing import Union + | ^^^^^ F401 +46 | +47 | from typing_extensions import TypeAliasType + | + = help: Remove unused import: `typing.Union` + +ℹ Safe fix +42 42 | # expressions (and type checkers probably wouldn't understand them as type +43 43 | # expressions either!) +44 44 | def f(): +45 |- from typing import Union +46 45 | +47 46 | from typing_extensions import TypeAliasType +48 47 | + +F401_34.py:58:24: F401 [*] `typing.Union` imported but unused + | +57 | def f(): +58 | from typing import Union + | ^^^^^ F401 +59 | +60 | from typing_extensions import TypeAliasType + | + = help: Remove unused import: `typing.Union` + +ℹ Safe fix +55 55 | +56 56 | +57 57 | def f(): +58 |- from typing import Union +59 58 | +60 59 | from typing_extensions import TypeAliasType +61 60 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_4.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_4.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_4.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_4.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_5.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_5.py.snap index e4317c5d195e7..5fe20fdee4e96 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_5.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_5.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_5.py:2:17: F401 [*] `a.b.c` imported but unused | @@ -67,5 +68,3 @@ F401_5.py:5:15: F401 [*] `j.k` imported but unused 3 3 | from d.e import f as g 4 4 | import h.i 5 |-import j.k as l - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_6.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_6.py.snap index d0db5ee40d5df..24dbe932b4c5a 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_6.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_6.py.snap @@ -6,7 +6,7 @@ F401_6.py:7:25: F401 [*] `.background.BackgroundTasks` imported but unused 6 | # F401 `background.BackgroundTasks` imported but unused 7 | from .background import BackgroundTasks | ^^^^^^^^^^^^^^^ F401 -8 | +8 | 9 | # F401 `datastructures.UploadFile` imported but unused | = help: Remove unused import: `.background.BackgroundTasks` @@ -25,7 +25,7 @@ F401_6.py:10:43: F401 [*] `.datastructures.UploadFile` imported but unused 9 | # F401 `datastructures.UploadFile` imported but unused 10 | from .datastructures import UploadFile as FileUpload | ^^^^^^^^^^ F401 -11 | +11 | 12 | # OK | = help: Remove unused import: `.datastructures.UploadFile` @@ -44,7 +44,7 @@ F401_6.py:16:8: F401 [*] `background` imported but unused 15 | # F401 `background` imported but unused 16 | import background | ^^^^^^^^^^ F401 -17 | +17 | 18 | # F401 `datastructures` imported but unused | = help: Remove unused import: `background` @@ -71,5 +71,3 @@ F401_6.py:19:26: F401 [*] `datastructures` imported but unused 17 17 | 18 18 | # F401 `datastructures` imported but unused 19 |-import datastructures as structures - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_7.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_7.py.snap index cb4ec75028592..0b27d19ff6208 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_7.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_7.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_7.py:30:5: F401 [*] `typing.Union` imported but unused | @@ -49,5 +50,3 @@ F401_7.py:66:31: F401 [*] `typing.AwaitableGenerator` imported but unused 64 64 | 65 65 | # This should mark F501 as unused. 66 |-from typing import Awaitable, AwaitableGenerator # noqa: F501 - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_8.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_8.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_8.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_8.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_9.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_9.py.snap index c7071cc24fbfa..5c8875f802395 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_9.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_F401_9.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_9.py:4:22: F401 [*] `foo.baz` imported but unused | @@ -15,5 +16,3 @@ F401_9.py:4:22: F401 [*] `foo.baz` imported but unused 3 3 | __all__ = ("bar",) 4 |-from foo import bar, baz 4 |+from foo import bar - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_24____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_24____init__.py.snap index 019ddc0195896..895939cdf68f6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_24____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_24____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 [*] `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_25__all_nonempty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_25__all_nonempty____init__.py.snap index 2d1d54e3488e5..419a8ae236db4 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_25__all_nonempty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_25__all_nonempty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 [*] `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_26__all_empty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_26__all_empty____init__.py.snap index 0fa48cf5f179e..165f850183797 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_26__all_empty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_26__all_empty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_27__all_mistyped____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_27__all_mistyped____init__.py.snap index a4f1d557bdef4..b20f2f1cf70df 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_27__all_mistyped____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_27__all_mistyped____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_28__all_multiple____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_28__all_multiple____init__.py.snap index daeee1984e4aa..6cde57d135f50 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_28__all_multiple____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_28__all_multiple____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_29__all_conditional____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_29__all_conditional____init__.py.snap index 392a58cf7aa16..be576ca11c1f0 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_29__all_conditional____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_29__all_conditional____init__.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs __init__.py:8:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import @@ -25,10 +25,10 @@ __init__.py:8:15: F401 [*] `.unused` imported but unused; consider removing, add __init__.py:8:44: F401 [*] `.renamed` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_30.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_30.py.snap index 7b42b5f341833..f65dc78b598ef 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_30.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_deprecated_option_F401_30.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F401_30.py:6:19: F401 [*] `.main.MaμToMan` imported but unused | 4 | """ -5 | +5 | 6 | from .main import MaµToMan | ^^^^^^^^ F401 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_24____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_24____init__.py.snap index 02a82d9ec05d2..52c0e6801fd4e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_24____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_24____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_25__all_nonempty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_25__all_nonempty____init__.py.snap index 16f8364dd65aa..ccac7c81c582b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_25__all_nonempty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_25__all_nonempty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_26__all_empty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_26__all_empty____init__.py.snap index d01839e564728..c6f6913969d47 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_26__all_empty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_26__all_empty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_27__all_mistyped____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_27__all_mistyped____init__.py.snap index c665795df9447..17856067e6c4b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_27__all_mistyped____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_27__all_mistyped____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_28__all_multiple____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_28__all_multiple____init__.py.snap index 219539886e329..0ba97b9289d1e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_28__all_multiple____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_28__all_multiple____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_29__all_conditional____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_29__all_conditional____init__.py.snap index 0100397db388f..57c17bb0c551c 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_29__all_conditional____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F401_stable_F401_29__all_conditional____init__.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs __init__.py:8:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import @@ -15,10 +15,10 @@ __init__.py:8:15: F401 `.unused` imported but unused; consider removing, adding __init__.py:8:44: F401 `.renamed` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.ipynb.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.ipynb.snap index cbb1ce305a800..3681a82bf45c6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.ipynb.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.ipynb.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F402.ipynb:3:5: F402 Import `os` from cell 1, line 1 shadowed by loop variable | @@ -19,5 +20,3 @@ F402.ipynb:5:5: F402 Import `path` from cell 1, line 2 shadowed by loop variable | ^^^^ F402 6 | pass | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.py.snap index acf46aff98ba0..b6c04ece22bfb 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F402_F402.py.snap @@ -11,10 +11,8 @@ F402.py:5:5: F402 Import `os` from line 1 shadowed by loop variable F402.py:8:5: F402 Import `path` from line 2 shadowed by loop variable | 6 | pass -7 | +7 | 8 | for path in range(3): | ^^^^ F402 9 | pass | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F403_F403.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F403_F403.py.snap index c9432addf2e33..954899e12a603 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F403_F403.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F403_F403.py.snap @@ -13,8 +13,6 @@ F403.py:2:1: F403 `from F634 import *` used; unable to detect undefined names 1 | from F634 import * 2 | from F634 import * # noqa: E501 | ^^^^^^^^^^^^^^^^^^ F403 -3 | +3 | 4 | from F634 import * # noqa | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_0.py.snap index 6934119f5b95a..0e5776e9b3eca 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_0.py.snap @@ -4,11 +4,9 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F404_0.py:6:1: F404 `from __future__` imports must occur at the beginning of the file | 4 | from collections import namedtuple -5 | +5 | 6 | from __future__ import print_function | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F404 -7 | +7 | 8 | import __future__ | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_1.py.snap index c9fbd78db83dd..533b95b9a7530 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F404_F404_1.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F404_1.py:5:1: F404 `from __future__` imports must occur at the beginning of the file | 3 | """Non-docstring""" -4 | +4 | 5 | from __future__ import absolute_import | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F404 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F405_F405.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F405_F405.py.snap index 5c73ac384d32c..566ebc15bbb7b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F405_F405.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F405_F405.py.snap @@ -11,7 +11,7 @@ F405.py:5:11: F405 `name` may be undefined, or defined from star imports F405.py:11:12: F405 `a` may be undefined, or defined from star imports | 9 | print(name) -10 | +10 | 11 | __all__ = ['a'] | ^^^ F405 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F406_F406.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F406_F406.py.snap index 5263bb2eb57d8..4b7e774e133e0 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F406_F406.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F406_F406.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F406.py:5:5: F406 `from F634 import *` only allowed at module level | @@ -14,5 +15,3 @@ F406.py:9:5: F406 `from F634 import *` only allowed at module level 9 | from F634 import * | ^^^^^^^^^^^^^^^^^^ F406 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F407_F407.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F407_F407.py.snap index c791c147bb221..faf0e89f0142c 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F407_F407.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F407_F407.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F407.py:2:24: F407 Future feature `non_existent_feature` is not defined | @@ -7,5 +8,3 @@ F407.py:2:24: F407 Future feature `non_existent_feature` is not defined 2 | from __future__ import non_existent_feature | ^^^^^^^^^^^^^^^^^^^^ F407 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F501_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F501_F50x.py.snap index 225b34a0878d8..e08ce6e14b2b5 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F501_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F501_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:1:1: F501 `%`-format string has invalid format string: incomplete format | @@ -8,5 +9,3 @@ F50x.py:1:1: F501 `%`-format string has invalid format string: incomplete format 2 | '%s %(foo)s' % {'foo': 'bar'} # F506 3 | '%(foo)s %s' % {'foo': 'bar'} # F506 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F502.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F502.py.snap index 1fd7af4900703..be81d392b12ad 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F502.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F502.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F502.py:6:1: F502 `%`-format string expected mapping but got sequence | @@ -67,5 +68,3 @@ F502.py:13:1: F502 `%`-format string expected mapping but got sequence 13 | "%(bob)s" % {"bob" for _ in range(1)} # F202 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F502 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F50x.py.snap index c82bf8b4acbfc..d95359d029404 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F502_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:9:1: F502 `%`-format string expected mapping but got sequence | @@ -10,5 +11,3 @@ F50x.py:9:1: F502 `%`-format string expected mapping but got sequence 10 | '%s %s' % {'k': 'v'} # F503 11 | '%(bar)*s' % {'bar': 'baz'} # F506, F508 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F503.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F503.py.snap index e568cd7e709ec..f143255f41b04 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F503.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F503.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F503.py:17:1: F503 `%`-format string expected sequence but got mapping | @@ -30,5 +31,3 @@ F503.py:23:1: F503 `%`-format string expected sequence but got mapping 24 | "%s %s" % ["bob" for _ in range(1)] 25 | "%s %s" % ("bob" for _ in range(1)) | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F50x.py.snap index cdd18e4d9ef22..a09a97f4a53a6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F503_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:10:1: F503 `%`-format string expected sequence but got mapping | @@ -9,5 +10,3 @@ F50x.py:10:1: F503 `%`-format string expected sequence but got mapping | ^^^^^^^^^^^^^^^^^^^^ F503 11 | '%(bar)*s' % {'bar': 'baz'} # F506, F508 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F504.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F504.py.snap index a04af93d12ad3..270e0e25a5957 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F504.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F504.py.snap @@ -7,7 +7,7 @@ F504.py:3:1: F504 [*] `%`-format string has unused named argument(s): b 2 | a = "wrong" 3 | "%(a)s %(c)s" % {a: "?", "b": "!"} # F504 ("b" not used) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F504 -4 | +4 | 5 | hidden = {"a": "!"} | = help: Remove extra named arguments: b @@ -24,7 +24,7 @@ F504.py:3:1: F504 [*] `%`-format string has unused named argument(s): b F504.py:8:1: F504 [*] `%`-format string has unused named argument(s): b | 6 | "%(a)s %(c)s" % {"x": 1, **hidden} # Ok (cannot see through splat) -7 | +7 | 8 | "%(a)s" % {"a": 1, r"b": "!"} # F504 ("b" not used) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F504 9 | "%(a)s" % {'a': 1, u"b": "!"} # F504 ("b" not used) @@ -46,7 +46,7 @@ F504.py:9:1: F504 [*] `%`-format string has unused named argument(s): b 8 | "%(a)s" % {"a": 1, r"b": "!"} # F504 ("b" not used) 9 | "%(a)s" % {'a': 1, u"b": "!"} # F504 ("b" not used) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F504 -10 | +10 | 11 | '' % {'a''b' : ''} # F504 ("ab" not used) | = help: Remove extra named arguments: b @@ -64,10 +64,10 @@ F504.py:9:1: F504 [*] `%`-format string has unused named argument(s): b F504.py:11:1: F504 [*] `%`-format string has unused named argument(s): ab | 9 | "%(a)s" % {'a': 1, u"b": "!"} # F504 ("b" not used) -10 | +10 | 11 | '' % {'a''b' : ''} # F504 ("ab" not used) | ^^^^^^^^^^^^^^^^^^ F504 -12 | +12 | 13 | # https://github.com/astral-sh/ruff/issues/4899 | = help: Remove extra named arguments: ab @@ -99,5 +99,3 @@ F504.py:14:1: F504 [*] `%`-format string has unused named argument(s): test1, te 15 |- 'test1': '', 16 |- 'test2': '', 15 |+ 17 16 | } - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F50x.py.snap index 8bcd33a080e3e..9aeabf56360f5 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F504_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:8:1: F504 [*] `%`-format string has unused named argument(s): baz | @@ -21,5 +22,3 @@ F50x.py:8:1: F504 [*] `%`-format string has unused named argument(s): baz 9 9 | '%(bar)s' % (1, 2, 3) # F502 10 10 | '%s %s' % {'k': 'v'} # F503 11 11 | '%(bar)*s' % {'bar': 'baz'} # F506, F508 - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F504.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F504.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F504.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F504.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F50x.py.snap index e1d10c37910bc..af45048c882e7 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F505_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:7:1: F505 `%`-format string is missing argument(s) for placeholder(s): bar | @@ -10,5 +11,3 @@ F50x.py:7:1: F505 `%`-format string is missing argument(s) for placeholder(s): b 8 | '%(bar)s' % {'bar': 1, 'baz': 2} # F504 9 | '%(bar)s' % (1, 2, 3) # F502 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F506_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F506_F50x.py.snap index 7a92ee2c30a46..8014d22098227 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F506_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F506_F50x.py.snap @@ -26,8 +26,6 @@ F50x.py:11:1: F506 `%`-format string has mixed positional and named placeholders 10 | '%s %s' % {'k': 'v'} # F503 11 | '%(bar)*s' % {'bar': 'baz'} # F506, F508 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ F506 -12 | +12 | 13 | # ok: single %s with mapping | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F507_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F507_F50x.py.snap index a78447db5e272..6b7efd75fe774 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F507_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F507_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:5:1: F507 `%`-format string has 2 placeholder(s) but 1 substitution(s) | @@ -20,5 +21,3 @@ F50x.py:6:1: F507 `%`-format string has 2 placeholder(s) but 3 substitution(s) 7 | '%(bar)s' % {} # F505 8 | '%(bar)s' % {'bar': 1, 'baz': 2} # F504 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F508_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F508_F50x.py.snap index add7bb3122b0b..b4415123436ed 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F508_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F508_F50x.py.snap @@ -7,8 +7,6 @@ F50x.py:11:1: F508 `%`-format string `*` specifier requires sequence 10 | '%s %s' % {'k': 'v'} # F503 11 | '%(bar)*s' % {'bar': 'baz'} # F506, F508 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ F508 -12 | +12 | 13 | # ok: single %s with mapping | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F509_F50x.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F509_F50x.py.snap index e1eeb3f4c223d..fa405f0915a09 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F509_F50x.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F509_F50x.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F50x.py:4:1: F509 `%`-format string has unsupported format character `j` | @@ -10,5 +11,3 @@ F50x.py:4:1: F509 `%`-format string has unsupported format character `j` 5 | '%s %s' % (1,) # F507 6 | '%s %s' % (1, 2, 3) # F507 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F521_F521.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F521_F521.py.snap index 56d4add051c8d..c9f840f58a885 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F521_F521.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F521_F521.py.snap @@ -63,8 +63,6 @@ F521.py:9:1: F521 `.format` call has invalid format string: Empty attribute in f 8 | "{foo..}".format(foo=1) 9 | "{foo..bar}".format(foo=1) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ F521 -10 | +10 | 11 | # The following are all "good" uses of .format | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F522_F522.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F522_F522.py.snap index 5e33645d06379..4548b23df1866 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F522_F522.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F522_F522.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F522.py:1:1: F522 [*] `.format` call has unused named argument(s): bar | @@ -72,5 +73,3 @@ F522.py:5:2: F522 [*] `.format` call has unused named argument(s): x 5 5 | ('' 6 |- .format(x=2)) # F522 6 |+ .format()) # F522 - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F523_F523.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F523_F523.py.snap index 48ecf84655537..5b882fb4c6dfe 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F523_F523.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F523_F523.py.snap @@ -77,7 +77,7 @@ F523.py:7:1: F523 `.format` call has unused arguments at position(s): 0, 3 6 | "{0}{2}".format(1, 2) # F523, # F524 7 | "{1.arg[1]!r:0{2['arg']}{1}}".format(1, 2, 3, 4) # F523 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F523 -8 | +8 | 9 | # With no indexes | = help: Remove extra positional arguments at position(s): 0, 3 @@ -129,7 +129,7 @@ F523.py:13:1: F523 [*] `.format` call has unused arguments at position(s): 2 12 | "{:{}}".format(1, 2) # No issues 13 | "{:{}}".format(1, 2, 3) # F523 | ^^^^^^^^^^^^^^^^^^^^^^^ F523 -14 | +14 | 15 | # With *args | = help: Remove extra positional arguments at position(s): 2 @@ -150,7 +150,7 @@ F523.py:19:1: F523 `.format` call has unused arguments at position(s): 2 18 | "{0}{1}".format(1, 2, *args) # No issues 19 | "{0}{1}".format(1, 2, 3, *args) # F523 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F523 -20 | +20 | 21 | # With nested quotes | = help: Remove extra positional arguments at position(s): 2 @@ -201,7 +201,7 @@ F523.py:24:1: F523 [*] `.format` call has unused arguments at position(s): 2 23 | "\"\"{1}{0}".format(1, 2, 3) # F523 24 | '""{1}{0}'.format(1, 2, 3) # F523 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ F523 -25 | +25 | 26 | # With modified indexes | = help: Remove extra positional arguments at position(s): 2 @@ -242,7 +242,7 @@ F523.py:29:1: F523 `.format` call has unused arguments at position(s): 0 28 | "{1}{3}".format(1, 2, 3, 4) # F523, # F524 29 | "{1} {8}".format(0, 1) # F523, # F524 | ^^^^^^^^^^^^^^^^^^^^^^ F523 -30 | +30 | 31 | # Multiline | = help: Remove extra positional arguments at position(s): 0 @@ -254,14 +254,51 @@ F523.py:32:2: F523 [*] `.format` call has unused arguments at position(s): 0 | __^ 33 | | .format(2)) | |__________^ F523 +34 | +35 | # Removing the final argument. | = help: Remove extra positional arguments at position(s): 0 ℹ Safe fix +29 29 | "{1} {8}".format(0, 1) # F523, # F524 30 30 | 31 31 | # Multiline -32 32 | ('' +32 |-('' 33 |-.format(2)) - 33 |+.format()) + 32 |+('') +34 33 | +35 34 | # Removing the final argument. +36 35 | "Hello".format("world") +F523.py:36:1: F523 [*] `.format` call has unused arguments at position(s): 0 + | +35 | # Removing the final argument. +36 | "Hello".format("world") + | ^^^^^^^^^^^^^^^^^^^^^^^ F523 +37 | "Hello".format("world", key="value") + | + = help: Remove extra positional arguments at position(s): 0 + +ℹ Safe fix +33 33 | .format(2)) +34 34 | +35 35 | # Removing the final argument. +36 |-"Hello".format("world") + 36 |+"Hello" +37 37 | "Hello".format("world", key="value") +F523.py:37:1: F523 [*] `.format` call has unused arguments at position(s): 0 + | +35 | # Removing the final argument. +36 | "Hello".format("world") +37 | "Hello".format("world", key="value") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F523 + | + = help: Remove extra positional arguments at position(s): 0 + +ℹ Safe fix +34 34 | +35 35 | # Removing the final argument. +36 36 | "Hello".format("world") +37 |-"Hello".format("world", key="value") + 37 |+"Hello".format(key="value") diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F524_F524.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F524_F524.py.snap index f93219db64ff6..c7b28c0dfa942 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F524_F524.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F524_F524.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F524.py:1:1: F524 `.format` call is missing argument(s) for placeholder(s): 1 | @@ -64,5 +65,3 @@ F524.py:7:1: F524 `.format` call is missing argument(s) for placeholder(s): 8 7 | "{1} {8}".format(0, 1) | ^^^^^^^^^^^^^^^^^^^^^^ F524 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F525_F525.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F525_F525.py.snap index c8f6727c68274..c4d45bde61216 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F525_F525.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F525_F525.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F525.py:1:1: F525 `.format` string mixes automatic and manual numbering | @@ -14,5 +15,3 @@ F525.py:2:1: F525 `.format` string mixes automatic and manual numbering 2 | "{0} {}".format(1, 2) # F523, F525 | ^^^^^^^^^^^^^^^^^^^^^ F525 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F541_F541.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F541_F541.py.snap index ab3ce59d46ec8..a7938d42abdb0 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F541_F541.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F541_F541.py.snap @@ -153,7 +153,7 @@ F541.py:19:5: F541 [*] f-string without any placeholders 18 | ) 19 | g = f"" | ^^^ F541 -20 | +20 | 21 | # OK | = help: Remove extraneous `f` prefix @@ -173,7 +173,7 @@ F541.py:25:13: F541 [*] f-string without any placeholders 24 | # Error 25 | h = "x" "y" f"z" | ^^^^ F541 -26 | +26 | 27 | v = 23.234234 | = help: Remove extraneous `f` prefix @@ -408,5 +408,3 @@ F541.py:44:1: F541 [*] f-string without any placeholders 43 43 | f"{v:{f"0.2f"}}" 44 |-f"\{{x}}" 44 |+"\{x}" - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F601_F601.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F601_F601.py.snap index ace4761b43cbd..b16b7bea64547 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F601_F601.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F601_F601.py.snap @@ -23,7 +23,18 @@ F601.py:6:5: F601 Dictionary key literal `("a", "b")` repeated | = help: Remove repeated key literal `("a", "b")` -F601.py:9:5: F601 Dictionary key literal `1` repeated +F601.py:8:5: F601 Dictionary key literal `1` repeated (`1` hashes to the same value as `1.0`) + | + 6 | ("a", "b"): 4, + 7 | 1.0: 2, + 8 | 1: 0, + | ^ F601 + 9 | 1: 3, +10 | b"123": 1, + | + = help: Remove repeated key literal `1` + +F601.py:9:5: F601 Dictionary key literal `1` repeated (`1` hashes to the same value as `1.0`) | 7 | 1.0: 2, 8 | 1: 0, @@ -234,7 +245,7 @@ F601.py:45:5: F601 [*] Dictionary key literal `"a"` repeated F601.py:49:14: F601 [*] Dictionary key literal `"a"` repeated | 47 | } -48 | +48 | 49 | x = {"a": 1, "a": 1} | ^^^ F601 50 | x = {"a": 1, "b": 2, "a": 1} @@ -256,7 +267,7 @@ F601.py:50:22: F601 [*] Dictionary key literal `"a"` repeated 49 | x = {"a": 1, "a": 1} 50 | x = {"a": 1, "b": 2, "a": 1} | ^^^ F601 -51 | +51 | 52 | x = { | = help: Remove repeated key literal `"a"` @@ -286,7 +297,7 @@ F601.py:58:19: F601 [*] Dictionary key literal `"x"` repeated 57 | # Regression test for: https://github.com/astral-sh/ruff/issues/4897 58 | t={"x":"test123", "x":("test123")} | ^^^ F601 -59 | +59 | 60 | t={"x":("test123"), "x":"test123"} | = help: Remove repeated key literal `"x"` @@ -299,13 +310,16 @@ F601.py:58:19: F601 [*] Dictionary key literal `"x"` repeated 58 |+t={"x":"test123"} 59 59 | 60 60 | t={"x":("test123"), "x":"test123"} +61 61 | F601.py:60:21: F601 [*] Dictionary key literal `"x"` repeated | 58 | t={"x":"test123", "x":("test123")} -59 | +59 | 60 | t={"x":("test123"), "x":"test123"} | ^^^ F601 +61 | +62 | # Regression test for: https://github.com/astral-sh/ruff/issues/12772 | = help: Remove repeated key literal `"x"` @@ -315,5 +329,49 @@ F601.py:60:21: F601 [*] Dictionary key literal `"x"` repeated 59 59 | 60 |-t={"x":("test123"), "x":"test123"} 60 |+t={"x":("test123")} +61 61 | +62 62 | # Regression test for: https://github.com/astral-sh/ruff/issues/12772 +63 63 | x = { + +F601.py:65:5: F601 Dictionary key literal `1` repeated + | +63 | x = { +64 | 1: "abc", +65 | 1: "def", + | ^ F601 +66 | True: "ghi", +67 | 0: "foo", + | + = help: Remove repeated key literal `1` +F601.py:66:5: F601 Dictionary key literal `True` repeated (`True` hashes to the same value as `1`) + | +64 | 1: "abc", +65 | 1: "def", +66 | True: "ghi", + | ^^^^ F601 +67 | 0: "foo", +68 | 0: "bar", + | + = help: Remove repeated key literal `True` +F601.py:68:5: F601 Dictionary key literal `0` repeated + | +66 | True: "ghi", +67 | 0: "foo", +68 | 0: "bar", + | ^ F601 +69 | False: "baz", +70 | } + | + = help: Remove repeated key literal `0` + +F601.py:69:5: F601 Dictionary key literal `False` repeated (`False` hashes to the same value as `0`) + | +67 | 0: "foo", +68 | 0: "bar", +69 | False: "baz", + | ^^^^^ F601 +70 | } + | + = help: Remove repeated key literal `False` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F602_F602.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F602_F602.py.snap index c092beeb97607..6fe76f9fd026f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F602_F602.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F602_F602.py.snap @@ -212,7 +212,7 @@ F602.py:41:5: F602 Dictionary key `a` repeated F602.py:44:12: F602 [*] Dictionary key `a` repeated | 42 | } -43 | +43 | 44 | x = {a: 1, a: 1} | ^ F602 45 | x = {a: 1, b: 2, a: 1} @@ -241,5 +241,3 @@ F602.py:45:18: F602 [*] Dictionary key `a` repeated 44 44 | x = {a: 1, a: 1} 45 |-x = {a: 1, b: 2, a: 1} 45 |+x = {a: 1, b: 2} - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F622_F622.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F622_F622.py.snap index b014fae36a880..a99d31d8a4020 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F622_F622.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F622_F622.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F622.py:1:1: F622 Two starred expressions in assignment | @@ -8,5 +9,3 @@ F622.py:1:1: F622 Two starred expressions in assignment 2 | *a, b, c = (1, 2, 3) 3 | a, b, *c = (1, 2, 3) | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F631_F631.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F631_F631.py.snap index dea3b048ee0d1..1a7624182d7ed 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F631_F631.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F631_F631.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F631.py:1:1: F631 Assert test is a non-empty tuple, which is always `True` | @@ -17,5 +18,3 @@ F631.py:2:1: F631 Assert test is a non-empty tuple, which is always `True` 3 | assert () 4 | assert True | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F632_F632.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F632_F632.py.snap index a20f5d5c45f5f..0bf2cf432b361 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F632_F632.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F632_F632.py.snap @@ -19,7 +19,7 @@ F632.py:1:4: F632 [*] Use `==` to compare constant literals F632.py:4:4: F632 [*] Use `!=` to compare constant literals | 2 | pass -3 | +3 | 4 | if 123 is not y: | ^^^^^^^^^^^^ F632 5 | pass @@ -39,7 +39,7 @@ F632.py:4:4: F632 [*] Use `!=` to compare constant literals F632.py:7:4: F632 [*] Use `!=` to compare constant literals | 5 | pass -6 | +6 | 7 | if 123 is \ | ____^ 8 | | not y: @@ -62,7 +62,7 @@ F632.py:7:4: F632 [*] Use `!=` to compare constant literals F632.py:11:4: F632 [*] Use `==` to compare constant literals | 9 | pass -10 | +10 | 11 | if "123" is x < 3: | ^^^^^^^^^^^^^^ F632 12 | pass @@ -82,7 +82,7 @@ F632.py:11:4: F632 [*] Use `==` to compare constant literals F632.py:14:4: F632 [*] Use `==` to compare constant literals | 12 | pass -13 | +13 | 14 | if "123" != x is 3: | ^^^^^^^^^^^^^^^ F632 15 | pass @@ -102,7 +102,7 @@ F632.py:14:4: F632 [*] Use `==` to compare constant literals F632.py:17:4: F632 [*] Use `==` to compare constant literals | 15 | pass -16 | +16 | 17 | if ("123" != x) is 3: | ^^^^^^^^^^^^^^^^^ F632 18 | pass @@ -122,7 +122,7 @@ F632.py:17:4: F632 [*] Use `==` to compare constant literals F632.py:20:14: F632 [*] Use `==` to compare constant literals | 18 | pass -19 | +19 | 20 | if "123" != (x is 3): | ^^^^^^ F632 21 | pass @@ -142,12 +142,12 @@ F632.py:20:14: F632 [*] Use `==` to compare constant literals F632.py:23:2: F632 [*] Use `!=` to compare constant literals | 21 | pass -22 | +22 | 23 | {2 is | __^ 24 | | not ''} | |______^ F632 -25 | +25 | 26 | {2 is | = help: Replace `is not` with `!=` @@ -166,12 +166,12 @@ F632.py:23:2: F632 [*] Use `!=` to compare constant literals F632.py:26:2: F632 [*] Use `!=` to compare constant literals | 24 | not ''} -25 | +25 | 26 | {2 is | __^ 27 | | not ''} | |_______^ F632 -28 | +28 | 29 | # Regression test for | = help: Replace `is not` with `!=` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F633_F633.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F633_F633.py.snap index 5fbf56d084805..1399617c01a3c 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F633_F633.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F633_F633.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F633.py:4:1: F633 Use of `>>` is invalid with `print` function | 2 | import sys -3 | +3 | 4 | print >> sys.stderr, "Hello" | ^^^^^ F633 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F634_F634.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F634_F634.py.snap index 428488bbe6f8d..ce4f4be9aafdf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F634_F634.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F634_F634.py.snap @@ -11,7 +11,7 @@ F634.py:1:4: F634 If test is a tuple, which is always `True` F634.py:4:4: F634 If test is a tuple, which is always `True` | 2 | pass -3 | +3 | 4 | if (3, 4): | ^^^^^^ F634 5 | pass @@ -27,5 +27,3 @@ F634.py:12:10: F634 If test is a tuple, which is always `True` 13 | pass 14 | elif (): | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F701_F701.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F701_F701.py.snap index 008343d91449e..775b955209440 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F701_F701.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F701_F701.py.snap @@ -7,14 +7,14 @@ F701.py:4:5: F701 `break` outside loop 3 | else: 4 | break | ^^^^^ F701 -5 | +5 | 6 | i = 0 | F701.py:16:5: F701 `break` outside loop | 14 | break -15 | +15 | 16 | break | ^^^^^ F701 | @@ -31,5 +31,3 @@ F701.py:23:1: F701 `break` outside loop 23 | break | ^^^^^ F701 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F702_F702.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F702_F702.py.snap index 4ef5ce2669f71..89f8fd3cc0886 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F702_F702.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F702_F702.py.snap @@ -7,14 +7,14 @@ F702.py:4:5: F702 `continue` not properly in loop 3 | else: 4 | continue | ^^^^^^^^ F702 -5 | +5 | 6 | i = 0 | F702.py:16:5: F702 `continue` not properly in loop | 14 | continue -15 | +15 | 16 | continue | ^^^^^^^^ F702 | @@ -31,5 +31,3 @@ F702.py:23:1: F702 `continue` not properly in loop 23 | continue | ^^^^^^^^ F702 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F704_F704.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F704_F704.py.snap index 57efd26c39f81..4afdfc8bb6de6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F704_F704.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F704_F704.py.snap @@ -30,6 +30,6 @@ F704.py:11:1: F704 `await` statement outside of a function 10 | yield from 3 11 | await f() | ^^^^^^^^^ F704 +12 | +13 | def _(): | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F706_F706.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F706_F706.py.snap index 921cc6b28a548..c6f545f5aff5e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F706_F706.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F706_F706.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F706.py:6:5: F706 `return` statement outside of a function/method | @@ -13,5 +14,3 @@ F706.py:9:1: F706 `return` statement outside of a function/method 9 | return 3 | ^^^^^^^^ F706 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F707_F707.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F707_F707.py.snap index 72bbed1abcbce..7cb4461bd3e45 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F707_F707.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F707_F707.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F707.py:3:1: F707 An `except` block as not the last exception handler | @@ -30,5 +31,3 @@ F707.py:19:1: F707 An `except` block as not the last exception handler 20 | pass 21 | except ValueError: | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722.py.snap index 500f1ca7295aa..54646f4ff37d1 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722.py.snap @@ -1,17 +1,69 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs --- -F722.py:9:12: F722 Syntax error in forward annotation: `///` +F722.py:9:12: F722 Syntax error in forward annotation: Expected an expression | 9 | def g() -> "///": | ^^^^^ F722 10 | pass | -F722.py:13:4: F722 Syntax error in forward annotation: `List[int]☃` +F722.py:13:4: F722 Syntax error in forward annotation: Got unexpected token ☃ | 13 | X: """List[int]"""'☃' = [] | ^^^^^^^^^^^^^^^^^^ F722 +14 | +15 | # Type annotations with triple quotes can contain newlines and indentation | +F722.py:30:11: F722 Syntax error in forward annotation: Unexpected token at the end of an expression + | +28 | """ +29 | +30 | invalid1: """ + | ___________^ +31 | | int | +32 | | str) +33 | | """ + | |___^ F722 +34 | +35 | invalid2: """ + | + +F722.py:35:11: F722 Syntax error in forward annotation: Unexpected token at the end of an expression + | +33 | """ +34 | +35 | invalid2: """ + | ___________^ +36 | | int) | +37 | | str +38 | | """ + | |___^ F722 +39 | invalid3: """ +40 | ((int) + | +F722.py:39:11: F722 Syntax error in forward annotation: unexpected EOF while parsing + | +37 | str +38 | """ +39 | invalid3: """ + | ___________^ +40 | | ((int) +41 | | """ + | |___^ F722 +42 | invalid4: """ +43 | (int + | + +F722.py:42:11: F722 Syntax error in forward annotation: unexpected EOF while parsing + | +40 | ((int) +41 | """ +42 | invalid4: """ + | ___________^ +43 | | (int +44 | | """ + | |___^ F722 + | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722_1.py.snap new file mode 100644 index 0000000000000..1fd4f43abd0a5 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F722_F722_1.py.snap @@ -0,0 +1,28 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +--- +F722_1.py:8:22: F722 Syntax error in forward annotation: Unexpected token at the end of an expression + | +6 | @no_type_check +7 | class C: +8 | def f(self, arg: "this isn't python") -> "this isn't python either": + | ^^^^^^^^^^^^^^^^^^^ F722 +9 | x: "this also isn't python" = 1 + | + +F722_1.py:8:46: F722 Syntax error in forward annotation: Unexpected token at the end of an expression + | +6 | @no_type_check +7 | class C: +8 | def f(self, arg: "this isn't python") -> "this isn't python either": + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ F722 +9 | x: "this also isn't python" = 1 + | + +F722_1.py:9:12: F722 Syntax error in forward annotation: Unexpected token at the end of an expression + | +7 | class C: +8 | def f(self, arg: "this isn't python") -> "this isn't python either": +9 | x: "this also isn't python" = 1 + | ^^^^^^^^^^^^^^^^^^^^^^^^ F722 + | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_0.py.snap index 009ba794b77b6..8b084ccac65e7 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_0.py:10:5: F811 Redefinition of unused `bar` from line 6 | @@ -8,5 +9,3 @@ F811_0.py:10:5: F811 Redefinition of unused `bar` from line 6 11 | pass | = help: Remove definition: `bar` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_1.py.snap index 19db1b0eddce7..7c96ecba03ea3 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_1.py:1:25: F811 Redefinition of unused `FU` from line 1 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_10.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_10.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_10.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_10.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_11.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_11.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_11.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_11.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_12.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_12.py.snap index 0d490baf57807..cd7495ada0547 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_12.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_12.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_12.py:6:20: F811 Redefinition of unused `mixer` from line 2 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_13.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_13.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_13.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_13.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_14.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_14.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_14.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_14.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_15.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_15.py.snap index 7f9b7cca18fee..eb43408a7c688 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_15.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_15.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_15.py:4:5: F811 Redefinition of unused `fu` from line 1 | @@ -8,5 +9,3 @@ F811_15.py:4:5: F811 Redefinition of unused `fu` from line 1 5 | pass | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_16.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_16.py.snap index ace7efc109b4e..af91808f2d760 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_16.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_16.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_16.py:8:13: F811 Redefinition of unused `fu` from line 3 | @@ -10,5 +11,3 @@ F811_16.py:8:13: F811 Redefinition of unused `fu` from line 3 9 | pass | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_17.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_17.py.snap index b2e62e8597fb6..367f5873a091f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_17.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_17.py.snap @@ -6,7 +6,7 @@ F811_17.py:6:12: F811 [*] Redefinition of unused `fu` from line 2 5 | def bar(): 6 | import fu | ^^ F811 -7 | +7 | 8 | def baz(): | = help: Remove definition: `fu` @@ -28,5 +28,3 @@ F811_17.py:9:13: F811 Redefinition of unused `fu` from line 6 10 | pass | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_18.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_18.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_18.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_18.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_19.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_19.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_19.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_19.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_2.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_2.py.snap index ce01b9cd148c8..3dcdb002cb871 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_2.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_2.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_2.py:1:34: F811 Redefinition of unused `FU` from line 1 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_20.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_20.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_20.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_20.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_21.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_21.py.snap index 6d0405c66f566..8432ce531c910 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_21.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_21.py.snap @@ -12,14 +12,13 @@ F811_21.py:32:5: F811 [*] Redefinition of unused `Sequence` from line 26 = help: Remove definition: `Sequence` ℹ Safe fix +27 27 | ) +28 28 | 29 29 | # This should ignore the first error. -30 30 | from typing import ( -31 31 | List, # noqa: F811 +30 |-from typing import ( +31 |- List, # noqa: F811 32 |- Sequence, 33 |-) - 32 |+ ) -34 33 | -35 34 | # This should ignore both errors. -36 35 | from typing import ( # noqa - - +34 30 | +35 31 | # This should ignore both errors. +36 32 | from typing import ( # noqa diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_22.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_22.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_22.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_22.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_23.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_23.py.snap index 4d77d04b236e2..b503ae6f3b9ec 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_23.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_23.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_23.py:4:15: F811 Redefinition of unused `foo` from line 3 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_24.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_24.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_24.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_24.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_25.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_25.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_25.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_25.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_26.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_26.py.snap index a51c892a97937..91cacac98d4f2 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_26.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_26.py.snap @@ -4,11 +4,9 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F811_26.py:5:9: F811 Redefinition of unused `func` from line 2 | 3 | pass -4 | +4 | 5 | def func(self): | ^^^^ F811 6 | pass | = help: Remove definition: `func` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_27.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_27.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_27.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_27.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_28.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_28.py.snap index 51c91bc474062..69b2869a43dea 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_28.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_28.py.snap @@ -6,7 +6,7 @@ F811_28.py:4:22: F811 Redefinition of unused `datetime` from line 3 3 | import datetime 4 | from datetime import datetime | ^^^^^^^^ F811 -5 | +5 | 6 | datetime(1, 2, 3) | = help: Remove definition: `datetime` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_29.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_29.pyi.snap index 0a7ee144e4415..b67239e5d446e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_29.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_29.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F811_29.pyi:8:1: F811 Redefinition of unused `Bar` from line 3 | 6 | Bar: int # OK -7 | +7 | 8 | Bar = 1 # F811 | ^^^ F811 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_3.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_3.py.snap index 7e749b088747a..430522582f9da 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_3.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_3.py:1:12: F811 Redefinition of unused `fu` from line 1 | @@ -7,5 +8,3 @@ F811_3.py:1:12: F811 Redefinition of unused `fu` from line 1 | ^^ F811 | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_30.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_30.py.snap index e785583128b93..b2955d60750cd 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_30.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_30.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F811_30.py:12:9: F811 Redefinition of unused `bar` from line 10 | 10 | bar = foo -11 | +11 | 12 | def bar(self) -> None: | ^^^ F811 13 | """Bar.""" @@ -14,7 +14,7 @@ F811_30.py:12:9: F811 Redefinition of unused `bar` from line 10 F811_30.py:21:5: F811 Redefinition of unused `baz` from line 18 | 19 | """Baz.""" -20 | +20 | 21 | baz = 1 | ^^^ F811 | @@ -23,7 +23,7 @@ F811_30.py:21:5: F811 Redefinition of unused `baz` from line 18 F811_30.py:29:12: F811 Redefinition of unused `foo` from line 26 | 27 | """Foo.""" -28 | +28 | 29 | bar = (foo := 1) | ^^^ F811 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_31.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_31.py.snap index 75de2fbbce7df..bb4eb97b10a44 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_31.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_31.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F811_31.py:19:29: F811 Redefinition of unused `baz` from line 17 | 17 | baz = None -18 | +18 | 19 | from some_module import baz | ^^^ F811 20 | except ImportError: diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_32.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_32.py.snap new file mode 100644 index 0000000000000..8424433dd2b8c --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_32.py.snap @@ -0,0 +1,21 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +--- +F811_32.py:5:5: F811 [*] Redefinition of unused `List` from line 4 + | +3 | from typing import ( +4 | List, +5 | List, + | ^^^^ F811 +6 | ) + | + = help: Remove definition: `List` + +ℹ Safe fix +2 2 | +3 3 | from typing import ( +4 4 | List, +5 |- List, +6 5 | ) +7 6 | +8 7 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_4.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_4.py.snap index 0c7c2a4523d79..dfccff053412e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_4.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_4.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_4.py:1:12: F811 Redefinition of unused `fu` from line 1 | @@ -7,5 +8,3 @@ F811_4.py:1:12: F811 Redefinition of unused `fu` from line 1 | ^^ F811 | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_5.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_5.py.snap index b21d2c3508948..0a44f240a57f5 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_5.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_5.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_5.py:1:13: F811 Redefinition of unused `fu` from line 1 | @@ -7,5 +8,3 @@ F811_5.py:1:13: F811 Redefinition of unused `fu` from line 1 | ^^ F811 | = help: Remove definition: `fu` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_6.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_6.py.snap index 92fc67263100e..5c2de08fd98d2 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_6.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_6.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_6.py:6:12: F811 [*] Redefinition of unused `os` from line 5 | @@ -17,5 +18,3 @@ F811_6.py:6:12: F811 [*] Redefinition of unused `os` from line 5 5 5 | import os 6 |- import os 7 6 | os.path - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_7.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_7.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_7.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_7.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_8.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_8.py.snap index 07e8aeb1e6324..186d426ff2fc8 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_8.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_8.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F811_8.py:5:12: F811 [*] Redefinition of unused `os` from line 4 | @@ -20,5 +21,3 @@ F811_8.py:5:12: F811 [*] Redefinition of unused `os` from line 4 6 5 | except: 7 6 | pass 8 7 | os.path - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_9.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_9.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_9.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F811_F811_9.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_0.py.snap index 1f6ee4d23c877..ad83ffe0ac579 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_0.py.snap @@ -32,10 +32,10 @@ F821_0.py:21:12: F821 Undefined name `numeric_string` F821_0.py:58:5: F821 Undefined name `Bar` | 56 | y: int = 1 -57 | +57 | 58 | x: "Bar" = 1 | ^^^ F821 -59 | +59 | 60 | [first] = ["yup"] | @@ -80,7 +80,7 @@ F821_0.py:93:14: F821 Undefined name `B` 92 | C = f'{A:{B}}' 93 | C = f'{A:{f"{B}"}}' | ^ F821 -94 | +94 | 95 | from typing import Annotated, Literal | @@ -113,5 +113,3 @@ F821_0.py:123:22: F821 Undefined name `bar` 124 | 123, 125 | ] | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_1.py.snap index d928a611589ab..388a7b77a3892 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_1.py:11:11: F821 Undefined name `Model` | @@ -28,5 +29,3 @@ F821_1.py:30:12: F821 Undefined name `Model` 30 | x = Match["Model"] | ^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_10.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_10.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_10.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_10.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.py.snap index a2604bd8b8b1c..fe57c5320d2db 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_11.py:18:28: F821 Undefined name `os` | @@ -14,5 +15,3 @@ F821_11.py:23:14: F821 Undefined name `Baz` 23 | f(Callable[["Baz"], None]) | ^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.pyi.snap index 0dc17e91619cb..9716d11d9013a 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_11.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_11.pyi:15:28: F821 Undefined name `os` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_12.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_12.py.snap index 1cb1eca885482..d2b5a37fd294b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_12.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_12.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_12.py:20:28: F821 Undefined name `os` | @@ -14,5 +15,3 @@ F821_12.py:25:14: F821 Undefined name `Baz` 25 | f(Callable[["Baz"], None]) | ^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_13.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_13.py.snap index a82c199902ed2..d156dc3ea9207 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_13.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_13.py.snap @@ -4,9 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F821_13.py:8:19: F821 Undefined name `List` | 6 | Y: ForwardRef("List[int]") -7 | +7 | 8 | Z = TypeVar("X", "List[int]", "int") | ^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_14.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_14.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_14.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_14.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_15.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_15.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_15.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_15.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_16.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_16.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_16.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_16.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_17.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_17.py.snap index ad2011d46ce42..ad86315cccf85 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_17.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_17.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F821_17.py:16:12: F821 Undefined name `DoesNotExist` | 14 | # Types used in aliased assignment must exist -15 | +15 | 16 | type Foo = DoesNotExist # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 17 | type Foo = list[DoesNotExist] # F821: Undefined name `DoesNotExist` @@ -15,7 +15,7 @@ F821_17.py:17:17: F821 Undefined name `DoesNotExist` 16 | type Foo = DoesNotExist # F821: Undefined name `DoesNotExist` 17 | type Foo = list[DoesNotExist] # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 -18 | +18 | 19 | # Type parameters do not escape alias scopes | @@ -24,17 +24,17 @@ F821_17.py:22:1: F821 Undefined name `T` 21 | type Foo[T] = T 22 | T # F821: Undefined name `T` - not accessible afterward alias scope | ^ F821 -23 | +23 | 24 | # Type parameters in functions | F821_17.py:39:17: F821 Undefined name `T` | 37 | from some_library import some_decorator -38 | +38 | 39 | @some_decorator(T) # F821: Undefined name `T` - not accessible in decorators | ^ F821 -40 | +40 | 41 | def foo[T](t: T) -> None: ... | @@ -50,7 +50,7 @@ F821_17.py:64:17: F821 Undefined name `T` 63 | from some_library import some_decorator 64 | @some_decorator(T) # F821: Undefined name `T` - not accessible in decorators | ^ F821 -65 | +65 | 66 | class Foo[T](list[T]): ... | @@ -59,14 +59,14 @@ F821_17.py:67:1: F821 Undefined name `T` 66 | class Foo[T](list[T]): ... 67 | T # F821: Undefined name `T` - not accessible after class scope | ^ F821 -68 | +68 | 69 | # Types specified in bounds should exist | F821_17.py:71:13: F821 Undefined name `DoesNotExist` | 69 | # Types specified in bounds should exist -70 | +70 | 71 | type Foo[T: DoesNotExist] = T # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 72 | def foo[T: DoesNotExist](t: T) -> T: return t # F821: Undefined name `DoesNotExist` @@ -87,14 +87,14 @@ F821_17.py:73:14: F821 Undefined name `DoesNotExist` 72 | def foo[T: DoesNotExist](t: T) -> T: return t # F821: Undefined name `DoesNotExist` 73 | class Foo[T: DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 -74 | +74 | 75 | type Foo[T: (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | F821_17.py:75:14: F821 Undefined name `DoesNotExist1` | 73 | class Foo[T: DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` -74 | +74 | 75 | type Foo[T: (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 76 | def foo[T: (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` @@ -104,7 +104,7 @@ F821_17.py:75:14: F821 Undefined name `DoesNotExist1` F821_17.py:75:29: F821 Undefined name `DoesNotExist2` | 73 | class Foo[T: DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` -74 | +74 | 75 | type Foo[T: (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 76 | def foo[T: (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` @@ -133,7 +133,7 @@ F821_17.py:77:15: F821 Undefined name `DoesNotExist1` 76 | def foo[T: (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` 77 | class Foo[T: (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -78 | +78 | 79 | # Same in defaults | @@ -143,14 +143,14 @@ F821_17.py:77:30: F821 Undefined name `DoesNotExist2` 76 | def foo[T: (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` 77 | class Foo[T: (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -78 | +78 | 79 | # Same in defaults | F821_17.py:81:14: F821 Undefined name `DoesNotExist` | 79 | # Same in defaults -80 | +80 | 81 | type Foo[T = DoesNotExist] = T # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 82 | def foo[T = DoesNotExist](t: T) -> T: return t # F821: Undefined name `DoesNotExist` @@ -171,34 +171,34 @@ F821_17.py:83:15: F821 Undefined name `DoesNotExist` 82 | def foo[T = DoesNotExist](t: T) -> T: return t # F821: Undefined name `DoesNotExist` 83 | class Foo[T = DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` | ^^^^^^^^^^^^ F821 -84 | +84 | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | F821_17.py:85:15: F821 Undefined name `DoesNotExist1` | 83 | class Foo[T = DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` -84 | +84 | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | F821_17.py:85:30: F821 Undefined name `DoesNotExist2` | 83 | class Foo[T = DoesNotExist](list[T]): ... # F821: Undefined name `DoesNotExist` -84 | +84 | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | F821_17.py:86:14: F821 Undefined name `DoesNotExist1` | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… | ^^^^^^^^^^^^^ F821 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | @@ -206,7 +206,7 @@ F821_17.py:86:14: F821 Undefined name `DoesNotExist1` F821_17.py:86:29: F821 Undefined name `DoesNotExist2` | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… | ^^^^^^^^^^^^^ F821 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | @@ -214,27 +214,27 @@ F821_17.py:86:29: F821 Undefined name `DoesNotExist2` F821_17.py:87:16: F821 Undefined name `DoesNotExist1` | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -88 | +88 | 89 | # Type parameters in nested classes | F821_17.py:87:31: F821 Undefined name `DoesNotExist2` | 85 | type Foo[T = (DoesNotExist1, DoesNotExist2)] = T # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` -86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` +86 | def foo[T = (DoesNotExist1, DoesNotExist2)](t: T) -> T: return t # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist… 87 | class Foo[T = (DoesNotExist1, DoesNotExist2)](list[T]): ... # F821: Undefined name `DoesNotExist1`, Undefined name `DoesNotExist2` | ^^^^^^^^^^^^^ F821 -88 | +88 | 89 | # Type parameters in nested classes | F821_17.py:102:52: F821 Undefined name `t` | 100 | return x -101 | +101 | 102 | def cannot_access_parent_variable(self, x: t) -> t: # F821: Undefined name `T` | ^ F821 103 | t # F821: Undefined name `t` @@ -244,7 +244,7 @@ F821_17.py:102:52: F821 Undefined name `t` F821_17.py:102:58: F821 Undefined name `t` | 100 | return x -101 | +101 | 102 | def cannot_access_parent_variable(self, x: t) -> t: # F821: Undefined name `T` | ^ F821 103 | t # F821: Undefined name `t` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_18.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_18.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_18.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_18.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_19.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_19.py.snap index 0461eeea1b703..65844fc9f61b6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_19.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_19.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_19.py:21:7: F821 Undefined name `y` | @@ -8,5 +9,3 @@ F821_19.py:21:7: F821 Undefined name `y` 21 | print(y) | ^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_2.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_2.py.snap index 2915f54728629..643cc2a4cb27f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_2.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_2.py.snap @@ -6,8 +6,6 @@ F821_2.py:5:13: F821 Undefined name `Model` 4 | # F821 Undefined name `Model` 5 | x: Literal["Model"] | ^^^^^ F821 -6 | +6 | 7 | from typing_extensions import Literal | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_20.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_20.py.snap index 143f82be67d7c..f791abbfcc668 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_20.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_20.py.snap @@ -4,11 +4,9 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F821_20.py:3:24: F821 Undefined name `Record` | 1 | """Test lazy evaluation of type alias values.""" -2 | +2 | 3 | type RecordCallback[R: Record] = Callable[[R], None] | ^^^^^^ F821 -4 | +4 | 5 | from collections.abc import Callable | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_21.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_21.py.snap index 40c911247ef23..dd8c65c6086e0 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_21.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_21.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_21.py:4:1: F821 Undefined name `display` | @@ -7,5 +8,3 @@ F821_21.py:4:1: F821 Undefined name `display` 4 | display(x) | ^^^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_22.ipynb.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_22.ipynb.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_22.ipynb.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_22.ipynb.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_23.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_23.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_23.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_23.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_24.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_24.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_24.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_24.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_25.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_25.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_25.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_25.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.py.snap index 1da3d5fe060a2..0fe9ae3d00d7e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_26.py:9:33: F821 Undefined name `CStr` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.pyi.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_26.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_27.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_27.py.snap index b0ef6067d4274..eb74e0d2aa377 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_27.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_27.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_27.py:30:11: F821 Undefined name `foo` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_28.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_28.py.snap index e8464267070eb..56103d85adb4a 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_28.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_28.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F821_28.py:9:7: F821 Undefined name `𝒟` | 7 | print(C == 𝑪 == 𝒞 == 𝓒 == 𝕮) -8 | +8 | 9 | print(𝒟) # F821 | ^ F821 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_29.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_29.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_29.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_29.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_3.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_3.py.snap index 294e4122987fd..2f06a91e4cac5 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_3.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_3.py.snap @@ -7,7 +7,7 @@ F821_3.py:11:10: F821 Undefined name `key` 10 | # F821 Undefined name `value` 11 | x: dict["key", "value"] | ^^^ F821 -12 | +12 | 13 | # OK | @@ -17,8 +17,6 @@ F821_3.py:11:17: F821 Undefined name `value` 10 | # F821 Undefined name `value` 11 | x: dict["key", "value"] | ^^^^^ F821 -12 | +12 | 13 | # OK | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_30.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_30.py.snap new file mode 100644 index 0000000000000..d39ce19805628 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_30.py.snap @@ -0,0 +1,50 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text +--- +F821_30.py:13:18: F821 Undefined name `qux` + | +11 | multiple: TypedDict[{ +12 | "bar": str, +13 | "baz": list["qux"], + | ^^^ F821 +14 | }] + | + +F821_30.py:19:19: F821 Undefined name `dolor` + | +17 | nested: TypedDict[ +18 | "lorem": TypedDict[{ +19 | "ipsum": "dolor" + | ^^^^^ F821 +20 | }], +21 | "sit": Literal["amet"] + | + +F821_30.py:26:31: F821 Undefined name `adipiscing` + | +24 | # Error at `adipiscing`, `eiusmod`, `tempor` +25 | unpack: TypedDict[{ +26 | "consectetur": Annotated["adipiscing", "elit"] + | ^^^^^^^^^^ F821 +27 | **{"sed do": str, int: "eiusmod", **tempor} +28 | }] + | + +F821_30.py:27:29: F821 Undefined name `eiusmod` + | +25 | unpack: TypedDict[{ +26 | "consectetur": Annotated["adipiscing", "elit"] +27 | **{"sed do": str, int: "eiusmod", **tempor} + | ^^^^^^^ F821 +28 | }] + | + +F821_30.py:27:41: F821 Undefined name `tempor` + | +25 | unpack: TypedDict[{ +26 | "consectetur": Annotated["adipiscing", "elit"] +27 | **{"sed do": str, int: "eiusmod", **tempor} + | ^^^^^^ F821 +28 | }] + | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_31.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_31.py.snap new file mode 100644 index 0000000000000..c2a81320152a6 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_31.py.snap @@ -0,0 +1,53 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text +--- +F821_31.py:8:23: F821 Undefined name `B` + | +6 | @typing.no_type_check +7 | class C: +8 | def f(self, arg: "B") -> "S": + | ^ F821 +9 | x: "B" = 1 + | + +F821_31.py:8:31: F821 Undefined name `S` + | +6 | @typing.no_type_check +7 | class C: +8 | def f(self, arg: "B") -> "S": + | ^ F821 +9 | x: "B" = 1 + | + +F821_31.py:9:13: F821 Undefined name `B` + | +7 | class C: +8 | def f(self, arg: "B") -> "S": +9 | x: "B" = 1 + | ^ F821 + | + +F821_31.py:15:13: F821 Undefined name `A` + | +14 | @typing.no_type_check +15 | def f(arg: "A") -> "R": + | ^ F821 +16 | x: "A" = 1 + | + +F821_31.py:15:21: F821 Undefined name `R` + | +14 | @typing.no_type_check +15 | def f(arg: "A") -> "R": + | ^ F821 +16 | x: "A" = 1 + | + +F821_31.py:16:9: F821 Undefined name `A` + | +14 | @typing.no_type_check +15 | def f(arg: "A") -> "R": +16 | x: "A" = 1 + | ^ F821 + | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_32.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_32.pyi.snap new file mode 100644 index 0000000000000..d0b409f39ee0b --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_32.pyi.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_4.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_4.py.snap index 5b6a6bd2ee5e3..9077bbc312e4f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_4.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_4.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F821_4.py:4:11: F821 Undefined name `Model` | 2 | from typing import List -3 | +3 | 4 | _ = List["Model"] | ^^^^^ F821 | @@ -12,7 +12,7 @@ F821_4.py:4:11: F821 Undefined name `Model` F821_4.py:9:12: F821 Undefined name `Model` | 7 | from typing import List as IList -8 | +8 | 9 | _ = IList["Model"] | ^^^^^ F821 | @@ -20,7 +20,7 @@ F821_4.py:9:12: F821 Undefined name `Model` F821_4.py:14:16: F821 Undefined name `Model` | 12 | from collections.abc import ItemsView -13 | +13 | 14 | _ = ItemsView["Model"] | ^^^^^ F821 | @@ -28,7 +28,7 @@ F821_4.py:14:16: F821 Undefined name `Model` F821_4.py:19:32: F821 Undefined name `Model` | 17 | import collections.abc -18 | +18 | 19 | _ = collections.abc.ItemsView["Model"] | ^^^^^ F821 | @@ -36,9 +36,7 @@ F821_4.py:19:32: F821 Undefined name `Model` F821_4.py:24:20: F821 Undefined name `Model` | 22 | from collections import abc -23 | +23 | 24 | _ = abc.ItemsView["Model"] | ^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.py.snap index 59855f49c51be..bbd010418566d 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_5.py:5:31: F821 Undefined name `InnerClass` | @@ -8,5 +9,3 @@ F821_5.py:5:31: F821 Undefined name `InnerClass` | ^^^^^^^^^^ F821 6 | pass | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.pyi.snap index ff1ac3037e00c..a7d89331022aa 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_5.pyi.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_5.pyi:4:27: F821 Undefined name `InnerClass` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_6.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_6.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_6.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_6.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_7.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_7.py.snap index 2285bc9e54c39..727e8cd87a9c2 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_7.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_7.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_7.py:11:22: F821 Undefined name `Undefined` | @@ -26,5 +27,3 @@ F821_7.py:13:22: F821 Undefined name `Undefined` 13 | _ = DefaultNamedArg("Undefined", "some_prop_name") | ^^^^^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_8.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_8.pyi.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_8.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_8.pyi.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_9.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_9.py.snap index b7a4023568975..976d74866a401 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_9.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F821_F821_9.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F821_9.py:22:20: F821 Undefined name `captured` | @@ -8,5 +9,3 @@ F821_9.py:22:20: F821 Undefined name `captured` 22 | return captured # F821 | ^^^^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.py.snap index 78dfd63657048..10d1e6f4e0145 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F822_0.py:3:17: F822 Undefined name `b` in `__all__` | 1 | a = 1 -2 | +2 | 3 | __all__ = ["a", "b"] | ^^^ F822 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.pyi.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.pyi.snap index d74b6e8936d56..4810ad460815b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.pyi.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_0.pyi.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F822_0.pyi:4:22: F822 Undefined name `c` in `__all__` | 2 | b: int # Considered a binding in a `.pyi` stub file, not in a `.py` runtime file -3 | +3 | 4 | __all__ = ["a", "b", "c"] # c is flagged as missing; b is not | ^^^ F822 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1.py.snap index d65deed9e78a3..5486326ac9707 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F822_1.py:3:22: F822 Undefined name `b` in `__all__` | 1 | a = 1 -2 | +2 | 3 | __all__ = list(["a", "b"]) | ^^^ F822 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1b.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1b.py.snap index 5b9ea3fdb51bf..a52632a6a8593 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1b.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_1b.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs F822_1b.py:4:31: F822 Undefined name `b` in `__all__` | 2 | a = 1 -3 | +3 | 4 | __all__ = builtins.list(["a", "b"]) | ^^^ F822 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_2.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_2.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_2.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_3.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_3.py.snap index 5d572ea096297..ffc2b35cf8cc4 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_3.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F822_F822_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F822_3.py:12:5: F822 Undefined name `ExponentialFamily` in `__all__` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F823_F823.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F823_F823.py.snap index f881e67454462..75fd12222ab32 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F823_F823.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F823_F823.py.snap @@ -30,7 +30,7 @@ F823.py:48:11: F823 Local variable `sys` referenced before assignment 47 | def main(): 48 | print(sys.argv) | ^^^ F823 -49 | +49 | 50 | try: | @@ -39,8 +39,6 @@ F823.py:62:11: F823 Local variable `sys` referenced before assignment 61 | def main(): 62 | print(sys.argv) | ^^^ F823 -63 | +63 | 64 | for sys in range(5): | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_0.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_0.py.snap index 7e1b2458bfa3f..a8a860e83ced6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_0.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_0.py.snap @@ -63,7 +63,7 @@ F841_0.py:21:6: F841 [*] Local variable `a` is assigned to but never used 20 | foo = (1, 2) 21 | (a, b) = (1, 2) | ^ F841 -22 | +22 | 23 | bar = (1, 2) | = help: Remove assignment to unused variable `a` @@ -84,7 +84,7 @@ F841_0.py:21:9: F841 [*] Local variable `b` is assigned to but never used 20 | foo = (1, 2) 21 | (a, b) = (1, 2) | ^ F841 -22 | +22 | 23 | bar = (1, 2) | = help: Remove assignment to unused variable `b` @@ -102,7 +102,7 @@ F841_0.py:21:9: F841 [*] Local variable `b` is assigned to but never used F841_0.py:26:14: F841 [*] Local variable `baz` is assigned to but never used | 24 | (c, d) = bar -25 | +25 | 26 | (x, y) = baz = bar | ^^^ F841 | @@ -124,7 +124,7 @@ F841_0.py:51:9: F841 [*] Local variable `b` is assigned to but never used 50 | # F841 51 | b = 1 | ^ F841 -52 | +52 | 53 | def d(): | = help: Remove assignment to unused variable `b` @@ -205,7 +205,7 @@ F841_0.py:115:5: F841 [*] Local variable `Baz` is assigned to but never used 114 | Bar = enum.Enum("Bar", "A B") 115 | Baz = enum.Enum("Baz", "A B") | ^^^ F841 -116 | +116 | 117 | match x: | = help: Remove assignment to unused variable `Baz` @@ -238,5 +238,3 @@ F841_0.py:127:21: F841 Local variable `value` is assigned to but never used 128 | print(key) | = help: Remove assignment to unused variable `value` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_1.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_1.py.snap index 9cb0b013fd00e..e82e2bb4e0d40 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_1.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F841_1.py:6:5: F841 [*] Local variable `x` is assigned to but never used | @@ -132,5 +133,3 @@ F841_1.py:24:18: F841 [*] Local variable `y` is assigned to but never used 23 23 | def f(): 24 |- (a, b) = (x, y) = 1, 2 # this triggers F841 on everything 24 |+ (a, b) = (x, _y) = 1, 2 # this triggers F841 on everything - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_2.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_2.py.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_2.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_3.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_3.py.snap index 8b60f4da8a24c..c3250b84513cc 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_3.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_3.py.snap @@ -25,7 +25,7 @@ F841_3.py:6:5: F841 [*] Local variable `y` is assigned to but never used 5 | x = 1 6 | y = 2 | ^ F841 -7 | +7 | 8 | z = 3 | = help: Remove assignment to unused variable `y` @@ -63,7 +63,7 @@ F841_3.py:14:5: F841 [*] Local variable `y` is assigned to but never used 13 | x: int = 1 14 | y: int = 2 | ^ F841 -15 | +15 | 16 | z: int = 3 | = help: Remove assignment to unused variable `y` @@ -99,7 +99,7 @@ F841_3.py:21:19: F841 [*] Local variable `x1` is assigned to but never used F841_3.py:27:20: F841 [*] Local variable `x3` is assigned to but never used | 25 | pass -26 | +26 | 27 | with (foo() as x3, foo() as y3, foo() as z3): | ^^ F841 28 | pass @@ -119,7 +119,7 @@ F841_3.py:27:20: F841 [*] Local variable `x3` is assigned to but never used F841_3.py:27:33: F841 [*] Local variable `y3` is assigned to but never used | 25 | pass -26 | +26 | 27 | with (foo() as x3, foo() as y3, foo() as z3): | ^^ F841 28 | pass @@ -139,7 +139,7 @@ F841_3.py:27:33: F841 [*] Local variable `y3` is assigned to but never used F841_3.py:27:46: F841 [*] Local variable `z3` is assigned to but never used | 25 | pass -26 | +26 | 27 | with (foo() as x3, foo() as y3, foo() as z3): | ^^ F841 28 | pass @@ -298,7 +298,7 @@ F841_3.py:50:5: F841 [*] Local variable `x` is assigned to but never used F841_3.py:56:5: F841 [*] Local variable `y` is assigned to but never used | 54 | ) -55 | +55 | 56 | y = \ | ^ F841 57 | a() if a is not None else b @@ -342,7 +342,7 @@ F841_3.py:61:5: F841 [*] Local variable `x` is assigned to but never used F841_3.py:67:5: F841 [*] Local variable `y` is assigned to but never used | 65 | ) -66 | +66 | 67 | y = \ | ^ F841 68 | a if a is not None else b @@ -665,7 +665,7 @@ F841_3.py:165:5: F841 [*] Local variable `x` is assigned to but never used 164 | def f(): 165 | x = 1 | ^ F841 -166 | +166 | 167 | y = 2 | = help: Remove assignment to unused variable `x` @@ -682,7 +682,7 @@ F841_3.py:165:5: F841 [*] Local variable `x` is assigned to but never used F841_3.py:167:5: F841 [*] Local variable `y` is assigned to but never used | 165 | x = 1 -166 | +166 | 167 | y = 2 | ^ F841 | @@ -712,5 +712,3 @@ F841_3.py:173:6: F841 [*] Local variable `x` is assigned to but never used 172 172 | ((x)) = foo() 173 |- (x) = (y.z) = foo() 173 |+ (y.z) = foo() - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_4.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_4.py.snap deleted file mode 100644 index f5f7f03e018d6..0000000000000 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F841_F841_4.py.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pyflakes/mod.rs ---- -F841_4.py:12:5: F841 [*] Local variable `a` is assigned to but never used - | -11 | def bar(): -12 | a = foo() - | ^ F841 -13 | b, c = foo() - | - = help: Remove assignment to unused variable `a` - -ℹ Unsafe fix -9 9 | -10 10 | -11 11 | def bar(): -12 |- a = foo() - 12 |+ foo() -13 13 | b, c = foo() -14 14 | -15 15 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F842_F842.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F842_F842.py.snap index 815af1b008884..5f6e6dbd9d4e4 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F842_F842.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F842_F842.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F842.py:2:5: F842 Local variable `name` is annotated but never used | @@ -16,5 +17,3 @@ F842.py:3:5: F842 Local variable `age` is annotated but never used 3 | age: int | ^^^ F842 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F901_F901.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F901_F901.py.snap index 33261837366b8..3e25ce03fa001 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F901_F901.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__F901_F901.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F901.py:2:11: F901 [*] `raise NotImplemented` should be `raise NotImplementedError` | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__augmented_assignment_after_del.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__augmented_assignment_after_del.snap index 809ec335a383b..18501498a29b3 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__augmented_assignment_after_del.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__augmented_assignment_after_del.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:10:5: F821 Undefined name `x` | @@ -17,5 +18,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs | ^ F841 | = help: Remove assignment to unused variable `x` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_builtins.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_builtins.snap index d574ec930498e..cf1be266bc91e 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_builtins.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_builtins.snap @@ -1,10 +1,9 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- builtins.py:1:1: F821 Undefined name `_` | 1 | _("Translations") | ^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_typing_modules.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_typing_modules.snap index f708d1ddae05d..ff0ffaecb31d2 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_typing_modules.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__default_typing_modules.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- typing_modules.py:6:36: F821 Undefined name `db` | @@ -7,5 +8,3 @@ typing_modules.py:6:36: F821 Undefined name `db` | ^^ F821 7 | y = Optional["Class"] | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_global_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_global_scope.snap index 2ac6d0d48702d..9d08e6b818306 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_global_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_global_scope.snap @@ -6,7 +6,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 4 | def f(): 5 | import os | ^^ F401 -6 | +6 | 7 | # Despite this `del`, `import os` in `f` should still be flagged as shadowing an unused | = help: Remove unused import: `os` @@ -20,5 +20,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 6 6 | 7 7 | # Despite this `del`, `import os` in `f` should still be flagged as shadowing an unused 8 8 | # import. (This is a false negative, but is consistent with Pyflakes.) - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_local_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_local_scope.snap index a419b0ee52fdd..f2a3fb29b29dc 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_local_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_global_import_in_local_scope.snap @@ -5,7 +5,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs | 2 | import os | ^^ F401 -3 | +3 | 4 | def f(): | = help: Remove unused import: `os` @@ -22,7 +22,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 4 | def f(): 5 | import os | ^^ F811 -6 | +6 | 7 | # Despite this `del`, `import os` in `f` should still be flagged as shadowing an unused | = help: Remove definition: `os` @@ -35,5 +35,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 6 5 | 7 6 | # Despite this `del`, `import os` in `f` should still be flagged as shadowing an unused 8 7 | # import. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_import_shadow_in_local_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_import_shadow_in_local_scope.snap index 9dfb6527c7f9b..38f194e1575f7 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_import_shadow_in_local_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_import_shadow_in_local_scope.snap @@ -5,7 +5,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs | 2 | import os | ^^ F401 -3 | +3 | 4 | def f(): | = help: Remove unused import: `os` @@ -25,5 +25,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 6 | print(os) | = help: Remove definition: `os` - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_local_import_in_local_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_local_import_in_local_scope.snap index df130cc6e8937..2177b874a1916 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_local_import_in_local_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__del_shadowed_local_import_in_local_scope.snap @@ -7,7 +7,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 3 | import os 4 | import os | ^^ F811 -5 | +5 | 6 | # Despite this `del`, `import os` should still be flagged as shadowing an unused | = help: Remove definition: `os` @@ -20,5 +20,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 5 4 | 6 5 | # Despite this `del`, `import os` should still be flagged as shadowing an unused 7 6 | # import. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__double_del.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__double_del.snap index b397846c0df99..4f3cf22aa7d63 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__double_del.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__double_del.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:5:9: F821 Undefined name `x` | @@ -8,5 +9,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 5 | del x | ^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extend_immutable_calls.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extend_immutable_calls.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extend_immutable_calls.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extend_immutable_calls.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_builtins.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_builtins.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_builtins.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_builtins.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_typing_modules.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_typing_modules.snap index b8eec450b4757..585455e718ba9 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_typing_modules.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__extra_typing_modules.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- typing_modules.py:7:15: F821 Undefined name `Class` | @@ -7,5 +8,3 @@ typing_modules.py:7:15: F821 Undefined name `Class` 7 | y = Optional["Class"] | ^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_allowed_unused_imports_option.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_allowed_unused_imports_option.snap index be1af3465c0eb..3d331d7884028 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_allowed_unused_imports_option.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_allowed_unused_imports_option.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- F401_31.py:12:33: F401 [*] `hvplot.pandas_alias.scatter_matrix` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_dunder_all.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_dunder_all.snap index 0d7b4c45059e9..b20246f56c2f2 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_dunder_all.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_dunder_all.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:2:8: F401 [*] `submodule.a` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_no_dunder_all.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_no_dunder_all.snap index 07dbda1e721dc..55922fe49de12 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_no_dunder_all.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f401_preview_first_party_submodule_no_dunder_all.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:1:8: F401 `submodule.a` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f821_with_builtin_added_on_new_py_version_but_old_target_version_specified.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f821_with_builtin_added_on_new_py_version_but_old_target_version_specified.snap index 1421f07c75e11..3fce3fa99edbe 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f821_with_builtin_added_on_new_py_version_but_old_target_version_specified.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f821_with_builtin_added_on_new_py_version_but_old_target_version_specified.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:1:1: F821 Undefined name `PythonFinalizationError`. Consider specifying `requires-python = ">= 3.13"` or `tool.ruff.target-version = "py313"` in your `pyproject.toml` file. | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f841_dummy_variable_rgx.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f841_dummy_variable_rgx.snap index 360b3028862ec..c87dbb04b6263 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f841_dummy_variable_rgx.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__f841_dummy_variable_rgx.snap @@ -44,7 +44,7 @@ F841_0.py:21:6: F841 Local variable `a` is assigned to but never used 20 | foo = (1, 2) 21 | (a, b) = (1, 2) | ^ F841 -22 | +22 | 23 | bar = (1, 2) | = help: Remove assignment to unused variable `a` @@ -55,7 +55,7 @@ F841_0.py:21:9: F841 Local variable `b` is assigned to but never used 20 | foo = (1, 2) 21 | (a, b) = (1, 2) | ^ F841 -22 | +22 | 23 | bar = (1, 2) | = help: Remove assignment to unused variable `b` @@ -63,7 +63,7 @@ F841_0.py:21:9: F841 Local variable `b` is assigned to but never used F841_0.py:26:14: F841 [*] Local variable `baz` is assigned to but never used | 24 | (c, d) = bar -25 | +25 | 26 | (x, y) = baz = bar | ^^^ F841 | @@ -141,7 +141,7 @@ F841_0.py:51:9: F841 [*] Local variable `b` is assigned to but never used 50 | # F841 51 | b = 1 | ^ F841 -52 | +52 | 53 | def d(): | = help: Remove assignment to unused variable `b` @@ -222,7 +222,7 @@ F841_0.py:115:5: F841 [*] Local variable `Baz` is assigned to but never used 114 | Bar = enum.Enum("Bar", "A B") 115 | Baz = enum.Enum("Baz", "A B") | ^^^ F841 -116 | +116 | 117 | match x: | = help: Remove assignment to unused variable `Baz` @@ -273,5 +273,3 @@ F841_0.py:152:25: F841 [*] Local variable `_` is assigned to but never used 152 |- except Exception as _: 152 |+ except Exception: 153 153 | pass - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__future_annotations.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__future_annotations.snap index 5a15b089872bd..8b35fbaf54779 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__future_annotations.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__future_annotations.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- future_annotations.py:8:5: F401 [*] `models.Nut` imported but unused | @@ -27,5 +28,3 @@ future_annotations.py:26:19: F821 Undefined name `Bar` | ^^^ F821 27 | return cls(x=0, y=0) | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__init.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__init.snap index cd22f8384785c..4153aa879f3c0 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__init.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__init.snap @@ -5,7 +5,7 @@ __init__.py:1:8: F401 `os` imported but unused | 1 | import os | ^^ F401 -2 | +2 | 3 | print(__path__) | = help: Remove unused import: `os` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_multiple_unbinds_from_module_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_multiple_unbinds_from_module_scope.snap index 8963cbc2ec14e..96e7e24ad0755 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_multiple_unbinds_from_module_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_multiple_unbinds_from_module_scope.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:7:26: F841 [*] Local variable `x` is assigned to but never used | @@ -40,5 +41,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 13 13 | pass 14 14 | 15 15 | # This should resolve to the `x` in `x = 1`. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_class_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_class_scope.snap index 30714ade296db..a138818982ec1 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_class_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_class_scope.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:8:30: F841 [*] Local variable `x` is assigned to but never used | @@ -28,5 +29,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 13 | print(x) | ^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_module_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_module_scope.snap index 1a45bebe8c475..cc283ed4cf038 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_module_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_module_scope.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:7:26: F841 [*] Local variable `x` is assigned to but never used | @@ -20,5 +21,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 8 8 | pass 9 9 | 10 10 | # This should resolve to the `x` in `x = 1`. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_nested_module_scope.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_nested_module_scope.snap index f2885ba2b58cd..759d5b357488f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_nested_module_scope.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__load_after_unbind_from_nested_module_scope.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:7:26: F841 [*] Local variable `x` is assigned to but never used | @@ -40,5 +41,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 14 14 | pass 15 15 | 16 16 | # This should resolve to the `x` in `x = 1`. - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__multi_statement_lines.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__multi_statement_lines.snap index c2e289a7ef4d0..2a79871a80fa6 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__multi_statement_lines.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__multi_statement_lines.snap @@ -24,7 +24,7 @@ multi_statement_lines.py:3:12: F401 [*] `foo2` imported but unused 2 | import foo1; x = 1 3 | import foo2; x = 1 | ^^^^ F401 -4 | +4 | 5 | if True: | = help: Remove unused import: `foo2` @@ -102,7 +102,7 @@ multi_statement_lines.py:19:17: F401 [*] `foo6` imported but unused 18 | x = 1; \ 19 | import foo6 | ^^^^ F401 -20 | +20 | 21 | if True: | = help: Remove unused import: `foo6` @@ -124,7 +124,7 @@ multi_statement_lines.py:23:18: F401 [*] `foo7` imported but unused 22 | x = 1 \ 23 | ; import foo7 | ^^^^ F401 -24 | +24 | 25 | if True: | = help: Remove unused import: `foo7` @@ -164,7 +164,7 @@ multi_statement_lines.py:27:23: F401 [*] `foo9` imported but unused 26 | x = 1; import foo8; x = 1 27 | x = 1; import foo9; x = 1 | ^^^^ F401 -28 | +28 | 29 | if True: | = help: Remove unused import: `foo9` @@ -225,7 +225,7 @@ multi_statement_lines.py:42:16: F401 [*] `foo12` imported but unused 41 | \ 42 | import foo12 | ^^^^^ F401 -43 | +43 | 44 | if True: | = help: Remove unused import: `foo12` @@ -269,7 +269,7 @@ multi_statement_lines.py:53:12: F401 [*] `foo14` imported but unused 52 | # \ 53 | import foo14 | ^^^^^ F401 -54 | +54 | 55 | # Continuation, but not as the last content in the file. | = help: Remove unused import: `foo14` @@ -289,7 +289,7 @@ multi_statement_lines.py:57:8: F401 [*] `foo15` imported but unused 56 | x = 1; \ 57 | import foo15 | ^^^^^ F401 -58 | +58 | 59 | # Continuation, followed by end-of-file. (Removing `import foo` would cause a syntax | = help: Remove unused import: `foo15` @@ -320,6 +320,4 @@ multi_statement_lines.py:62:8: F401 [*] `foo16` imported but unused 60 60 | # error.) 61 |-x = 1; \ 62 |-import foo16 - 61 |+x = 1; - - + 61 |+x = 1; diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__nested_relative_typing_module.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__nested_relative_typing_module.snap index def4b156ebec2..b6285d774ff30 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__nested_relative_typing_module.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__nested_relative_typing_module.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- baz.py:26:17: F821 Undefined name `foo` | @@ -14,5 +15,3 @@ baz.py:33:17: F821 Undefined name `foo` 33 | x: Literal["foo"] | ^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_24____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_24____init__.py.snap index 1c7ce2e8a7a8b..ebd332ca01229 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_24____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_24____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 [*] `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_25__all_nonempty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_25__all_nonempty____init__.py.snap index cb3e3848d5a93..6b4906ee54d3f 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_25__all_nonempty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_25__all_nonempty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:19:8: F401 [*] `sys` imported but unused | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_26__all_empty____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_26__all_empty____init__.py.snap index 6c393f0fbfce9..60d58e3597c38 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_26__all_empty____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_26__all_empty____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_27__all_mistyped____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_27__all_mistyped____init__.py.snap index c665795df9447..17856067e6c4b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_27__all_mistyped____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_27__all_mistyped____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_28__all_multiple____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_28__all_multiple____init__.py.snap index a77b95641d619..0a5fcedf8c469 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_28__all_multiple____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_28__all_multiple____init__.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- __init__.py:5:15: F401 [*] `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_29__all_conditional____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_29__all_conditional____init__.py.snap index 0100397db388f..57c17bb0c551c 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_29__all_conditional____init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_29__all_conditional____init__.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs __init__.py:8:15: F401 `.unused` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import @@ -15,10 +15,10 @@ __init__.py:8:15: F401 `.unused` imported but unused; consider removing, adding __init__.py:8:44: F401 `.renamed` imported but unused; consider removing, adding to `__all__`, or using a redundant alias | 6 | import sys - 7 | + 7 | 8 | from . import unused, exported, renamed as bees | ^^^^ F401 - 9 | + 9 | 10 | if sys.version_info > (3, 9): | = help: Remove unused import diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_33____init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_33____init__.py.snap new file mode 100644 index 0000000000000..d17deaa8387c3 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401_F401_33____init__.py.snap @@ -0,0 +1,19 @@ +--- +source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text +--- +__init__.py:8:35: F401 [*] `F401_33.other.Ham` imported but unused + | +6 | class Spam: +7 | def __init__(self) -> None: +8 | from F401_33.other import Ham + | ^^^ F401 + | + = help: Remove unused import: `F401_33.other.Ham` + +ℹ Unsafe fix +5 5 | +6 6 | class Spam: +7 7 | def __init__(self) -> None: +8 |- from F401_33.other import Ham + 8 |+ pass diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401___init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401___init__.py.snap index 3f4855817c4b1..a6ec69a4a586a 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401___init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F401___init__.py.snap @@ -5,7 +5,7 @@ __init__.py:1:8: F401 [*] `os` imported but unused | 1 | import os | ^^ F401 -2 | +2 | 3 | print(__path__) | = help: Remove unused import: `os` diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F822___init__.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F822___init__.py.snap index d9761fcd786ee..40b04dfafd39b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F822___init__.py.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F822___init__.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs __init__.py:5:12: F822 Undefined name `a` in `__all__` | 3 | print(__path__) -4 | +4 | 5 | __all__ = ["a", "b", "c"] | ^^^ F822 | @@ -12,7 +12,7 @@ __init__.py:5:12: F822 Undefined name `a` in `__all__` __init__.py:5:17: F822 Undefined name `b` in `__all__` | 3 | print(__path__) -4 | +4 | 5 | __all__ = ["a", "b", "c"] | ^^^ F822 | @@ -20,7 +20,7 @@ __init__.py:5:17: F822 Undefined name `b` in `__all__` __init__.py:5:22: F822 Undefined name `c` in `__all__` | 3 | print(__path__) -4 | +4 | 5 | __all__ = ["a", "b", "c"] | ^^^ F822 | diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F841_F841_4.py.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F841_F841_4.py.snap deleted file mode 100644 index 661343dd141da..0000000000000 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__preview__F841_F841_4.py.snap +++ /dev/null @@ -1,61 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pyflakes/mod.rs ---- -F841_4.py:12:5: F841 [*] Local variable `a` is assigned to but never used - | -11 | def bar(): -12 | a = foo() - | ^ F841 -13 | b, c = foo() - | - = help: Remove assignment to unused variable `a` - -ℹ Unsafe fix -9 9 | -10 10 | -11 11 | def bar(): -12 |- a = foo() - 12 |+ foo() -13 13 | b, c = foo() -14 14 | -15 15 | - -F841_4.py:13:5: F841 [*] Local variable `b` is assigned to but never used - | -11 | def bar(): -12 | a = foo() -13 | b, c = foo() - | ^ F841 - | - = help: Remove assignment to unused variable `b` - -ℹ Unsafe fix -10 10 | -11 11 | def bar(): -12 12 | a = foo() -13 |- b, c = foo() - 13 |+ _b, c = foo() -14 14 | -15 15 | -16 16 | def baz(): - -F841_4.py:13:8: F841 [*] Local variable `c` is assigned to but never used - | -11 | def bar(): -12 | a = foo() -13 | b, c = foo() - | ^ F841 - | - = help: Remove assignment to unused variable `c` - -ℹ Unsafe fix -10 10 | -11 11 | def bar(): -12 12 | a = foo() -13 |- b, c = foo() - 13 |+ b, _c = foo() -14 14 | -15 15 | -16 16 | def baz(): - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_double_shadowing_except.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_double_shadowing_except.snap index 45cdf09182aca..6e9134a85404d 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_double_shadowing_except.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_double_shadowing_except.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:7:26: F841 [*] Local variable `x` is assigned to but never used | @@ -41,5 +42,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 10 10 | pass 11 11 | 12 12 | # No error here, though it should arguably be an F821 error. `x` will - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_shadowing_except.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_shadowing_except.snap index 32d67c366975e..1a04064c1b5f3 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_shadowing_except.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_body_after_shadowing_except.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- <filename>:7:25: F841 [*] Local variable `x` is assigned to but never used | @@ -20,5 +21,3 @@ source: crates/ruff_linter/src/rules/pyflakes/mod.rs 8 8 | pass 9 9 | 10 10 | # No error here, though it should arguably be an F821 error. `x` will - - diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_if_else_after_shadowing_except.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_if_else_after_shadowing_except.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_if_else_after_shadowing_except.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_if_else_after_shadowing_except.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_try_else_after_shadowing_except.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_try_else_after_shadowing_except.snap index d0b409f39ee0b..a487e4ddb80cf 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_try_else_after_shadowing_except.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__print_in_try_else_after_shadowing_except.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__relative_typing_module.snap b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__relative_typing_module.snap index d7f395ddde1b5..0b9f6a767287b 100644 --- a/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__relative_typing_module.snap +++ b/crates/ruff_linter/src/rules/pyflakes/snapshots/ruff_linter__rules__pyflakes__tests__relative_typing_module.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyflakes/mod.rs +snapshot_kind: text --- bar.py:26:17: F821 Undefined name `foo` | @@ -7,5 +8,3 @@ bar.py:26:17: F821 Undefined name `foo` 26 | x: Literal["foo"] | ^^^ F821 | - - diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/mod.rs b/crates/ruff_linter/src/rules/pygrep_hooks/mod.rs index 52df6929af6a2..adc4e91fa6367 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/mod.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/mod.rs @@ -10,7 +10,6 @@ mod tests { use crate::registry::Rule; - use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; @@ -30,22 +29,4 @@ mod tests { assert_messages!(snapshot, diagnostics); Ok(()) } - - #[test_case(Rule::BlanketNOQA, Path::new("PGH004_2.py"))] - fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { - let snapshot = format!( - "preview__{}_{}", - rule_code.noqa_code(), - path.to_string_lossy() - ); - let diagnostics = test_path( - Path::new("pygrep_hooks").join(path).as_path(), - &settings::LinterSettings { - preview: PreviewMode::Enabled, - ..settings::LinterSettings::for_rule(rule_code) - }, - )?; - assert_messages!(snapshot, diagnostics); - Ok(()) - } } diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_noqa.rs b/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_noqa.rs index a79a07b9e2087..39682ff734973 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_noqa.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_noqa.rs @@ -1,11 +1,10 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::Cursor; use ruff_text_size::{Ranged, TextRange}; -use crate::noqa::{Directive, FileNoqaDirectives, NoqaDirectives, ParsedFileExemption}; -use crate::settings::types::PreviewMode; use crate::Locator; +use crate::noqa::{self, Directive, FileNoqaDirectives, NoqaDirectives}; /// ## What it does /// Check for `noqa` annotations that suppress all diagnostics, as opposed to @@ -18,9 +17,6 @@ use crate::Locator; /// maintain, as the annotation does not clarify which diagnostics are intended /// to be suppressed. /// -/// In [preview], this rule also checks for blanket file-level annotations (e.g., -/// `# ruff: noqa`, as opposed to `# ruff: noqa: F401`). -/// /// ## Example /// ```python /// from .base import * # noqa @@ -41,12 +37,9 @@ use crate::Locator; /// /// ## References /// - [Ruff documentation](https://docs.astral.sh/ruff/configuration/#error-suppression) -/// -/// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct BlanketNOQA { +#[derive(ViolationMetadata)] +pub(crate) struct BlanketNOQA { missing_colon: bool, - space_before_colon: bool, file_exemption: bool, } @@ -57,34 +50,22 @@ impl Violation for BlanketNOQA { fn message(&self) -> String { let BlanketNOQA { missing_colon, - space_before_colon, file_exemption, } = self; - // This awkward branching is necessary to ensure that the generic message is picked up by // `derive_message_formats`. - if !missing_colon && !space_before_colon && !file_exemption { - format!("Use specific rule codes when using `noqa`") + if !missing_colon && !file_exemption { + "Use specific rule codes when using `noqa`".to_string() } else if *file_exemption { - format!("Use specific rule codes when using `ruff: noqa`") - } else if *missing_colon { - format!("Use a colon when specifying `noqa` rule codes") + "Use specific rule codes when using `ruff: noqa`".to_string() } else { - format!("Do not add spaces between `noqa` and its colon") + "Use a colon when specifying `noqa` rule codes".to_string() } } fn fix_title(&self) -> Option<String> { - let BlanketNOQA { - missing_colon, - space_before_colon, - .. - } = self; - - if *missing_colon { + if self.missing_colon { Some("Add missing colon".to_string()) - } else if *space_before_colon { - Some("Remove space(s) before colon".to_string()) } else { None } @@ -97,20 +78,16 @@ pub(crate) fn blanket_noqa( noqa_directives: &NoqaDirectives, locator: &Locator, file_noqa_directives: &FileNoqaDirectives, - preview: PreviewMode, ) { - if preview.is_enabled() { - for line in file_noqa_directives.lines() { - if let ParsedFileExemption::All = line.parsed_file_exemption { - diagnostics.push(Diagnostic::new( - BlanketNOQA { - missing_colon: false, - space_before_colon: false, - file_exemption: true, - }, - line.range(), - )); - } + for line in file_noqa_directives.lines() { + if let Directive::All(_) = line.parsed_file_exemption { + diagnostics.push(Diagnostic::new( + BlanketNOQA { + missing_colon: false, + file_exemption: true, + }, + line.range(), + )); } } @@ -123,22 +100,7 @@ pub(crate) fn blanket_noqa( let mut cursor = Cursor::new(&line[noqa_end.to_usize()..]); cursor.eat_while(char::is_whitespace); - // Check for extraneous spaces before the colon. - // Ex) `# noqa : F401` - if cursor.first() == ':' { - let start = all.end(); - let end = start + cursor.token_len(); - let mut diagnostic = Diagnostic::new( - BlanketNOQA { - missing_colon: false, - space_before_colon: true, - file_exemption: false, - }, - TextRange::new(all.start(), end), - ); - diagnostic.set_fix(Fix::unsafe_edit(Edit::deletion(start, end))); - diagnostics.push(diagnostic); - } else if Directive::lex_code(cursor.chars().as_str()).is_some() { + if noqa::lex_codes(cursor.chars().as_str()).is_ok_and(|codes| !codes.is_empty()) { // Check for a missing colon. // Ex) `# noqa F401` let start = all.end(); @@ -146,7 +108,6 @@ pub(crate) fn blanket_noqa( let mut diagnostic = Diagnostic::new( BlanketNOQA { missing_colon: true, - space_before_colon: false, file_exemption: false, }, TextRange::new(all.start(), end), @@ -158,7 +119,6 @@ pub(crate) fn blanket_noqa( diagnostics.push(Diagnostic::new( BlanketNOQA { missing_colon: false, - space_before_colon: false, file_exemption: false, }, all.range(), diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_type_ignore.rs b/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_type_ignore.rs index 7995415492a49..6117169fd4aa6 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_type_ignore.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/rules/blanket_type_ignore.rs @@ -1,11 +1,11 @@ use std::sync::LazyLock; -use anyhow::{anyhow, Result}; +use anyhow::{Result, anyhow}; use memchr::memchr_iter; use regex::Regex; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_text_size::TextSize; @@ -40,13 +40,13 @@ use crate::Locator; /// [tool.mypy] /// enable_error_code = ["ignore-without-code"] /// ``` -#[violation] -pub struct BlanketTypeIgnore; +#[derive(ViolationMetadata)] +pub(crate) struct BlanketTypeIgnore; impl Violation for BlanketTypeIgnore { #[derive_message_formats] fn message(&self) -> String { - format!("Use specific rule codes when ignoring type issues") + "Use specific rule codes when ignoring type issues".to_string() } } diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/rules/deprecated_log_warn.rs b/crates/ruff_linter/src/rules/pygrep_hooks/rules/deprecated_log_warn.rs index ec9754414456b..5c23b05bc1b09 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/rules/deprecated_log_warn.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/rules/deprecated_log_warn.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## Removed /// This rule is identical to [G010] which should be used instead. @@ -32,8 +32,8 @@ use ruff_macros::{derive_message_formats, violation}; /// - [Python documentation: `logger.Logger.warning`](https://docs.python.org/3/library/logging.html#logging.Logger.warning) /// /// [G010]: https://docs.astral.sh/ruff/rules/logging-warn/ -#[violation] -pub struct DeprecatedLogWarn; +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedLogWarn; /// PGH002 impl Violation for DeprecatedLogWarn { @@ -41,10 +41,10 @@ impl Violation for DeprecatedLogWarn { #[derive_message_formats] fn message(&self) -> String { - format!("`warn` is deprecated in favor of `warning`") + "`warn` is deprecated in favor of `warning`".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `warning`")) + Some("Replace with `warning`".to_string()) } } diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/rules/invalid_mock_access.rs b/crates/ruff_linter/src/rules/pygrep_hooks/rules/invalid_mock_access.rs index 06b513485a3d0..79527c586fee2 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/rules/invalid_mock_access.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/rules/invalid_mock_access.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -32,8 +32,8 @@ enum Reason { /// ```python /// my_mock.assert_called() /// ``` -#[violation] -pub struct InvalidMockAccess { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidMockAccess { reason: Reason, } @@ -49,7 +49,7 @@ impl Violation for InvalidMockAccess { } /// PGH005 -pub(crate) fn uncalled_mock_method(checker: &mut Checker, expr: &Expr) { +pub(crate) fn uncalled_mock_method(checker: &Checker, expr: &Expr) { if let Expr::Attribute(ast::ExprAttribute { attr, .. }) = expr { if matches!( attr.as_str(), @@ -61,7 +61,7 @@ pub(crate) fn uncalled_mock_method(checker: &mut Checker, expr: &Expr) { | "assert_has_calls" | "assert_not_called" ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidMockAccess { reason: Reason::UncalledMethod(attr.to_string()), }, @@ -72,7 +72,7 @@ pub(crate) fn uncalled_mock_method(checker: &mut Checker, expr: &Expr) { } /// PGH005 -pub(crate) fn non_existent_mock_method(checker: &mut Checker, test: &Expr) { +pub(crate) fn non_existent_mock_method(checker: &Checker, test: &Expr) { let attr = match test { Expr::Attribute(ast::ExprAttribute { attr, .. }) => attr, Expr::Call(ast::ExprCall { func, .. }) => match func.as_ref() { @@ -90,7 +90,7 @@ pub(crate) fn non_existent_mock_method(checker: &mut Checker, test: &Expr) { | "has_calls" | "not_called" ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidMockAccess { reason: Reason::NonExistentMethod(attr.to_string()), }, diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/rules/no_eval.rs b/crates/ruff_linter/src/rules/pygrep_hooks/rules/no_eval.rs index 4acfd491214b0..192bd50d06f4d 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/rules/no_eval.rs +++ b/crates/ruff_linter/src/rules/pygrep_hooks/rules/no_eval.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## Removed /// This rule is identical to [S307] which should be used instead. @@ -29,13 +29,13 @@ use ruff_macros::{derive_message_formats, violation}; /// - [_Eval really is dangerous_ by Ned Batchelder](https://nedbatchelder.com/blog/201206/eval_really_is_dangerous.html) /// /// [S307]: https://docs.astral.sh/ruff/rules/suspicious-eval-usage/ -#[violation] -pub struct Eval; +#[derive(ViolationMetadata)] +pub(crate) struct Eval; /// PGH001 impl Violation for Eval { #[derive_message_formats] fn message(&self) -> String { - format!("No builtin `eval()` allowed") + "No builtin `eval()` allowed".to_string() } } diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_0.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_0.py.snap index 249a541990c91..20b023cd3d1ea 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_0.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_0.py.snap @@ -33,8 +33,6 @@ PGH003_0.py:4:25: PGH003 Use specific rule codes when ignoring type issues 3 | x = 1 # type: ignore[attr-defined] # type: ignore 4 | x = 1 # type: ignoreme # type: ignore | ^^^^^^^^^^^^^^ PGH003 -5 | +5 | 6 | x = 1 | - - diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_1.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_1.py.snap index 891fbef531520..3050506086a0a 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_1.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH003_PGH003_1.py.snap @@ -23,8 +23,6 @@ PGH003_1.py:3:41: PGH003 Use specific rule codes when ignoring type issues 2 | x = 1 # pyright:ignore 3 | x = 1 # pyright: ignore[attr-defined] # pyright: ignore | ^^^^^^^^^^^^^^^^^ PGH003 -4 | +4 | 5 | x = 1 | - - diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_0.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_0.py.snap index 5c4e0772479d1..1b812d166f4da 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_0.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_0.py.snap @@ -34,7 +34,7 @@ PGH004_0.py:18:8: PGH004 [*] Use a colon when specifying `noqa` rule codes 17 | # PGH004 18 | x = 2 # noqa X100 | ^^^^^^^ PGH004 -19 | +19 | 20 | # PGH004 | = help: Add missing colon @@ -54,7 +54,7 @@ PGH004_0.py:21:8: PGH004 [*] Use a colon when specifying `noqa` rule codes 20 | # PGH004 21 | x = 2 # noqa X100, X200 | ^^^^^^^ PGH004 -22 | +22 | 23 | # PGH004 | = help: Add missing colon @@ -68,58 +68,3 @@ PGH004_0.py:21:8: PGH004 [*] Use a colon when specifying `noqa` rule codes 22 22 | 23 23 | # PGH004 24 24 | x = 2 # noqa : X300 - -PGH004_0.py:24:8: PGH004 [*] Do not add spaces between `noqa` and its colon - | -23 | # PGH004 -24 | x = 2 # noqa : X300 - | ^^^^^^^ PGH004 -25 | -26 | # PGH004 - | - = help: Remove space(s) before colon - -ℹ Unsafe fix -21 21 | x = 2 # noqa X100, X200 -22 22 | -23 23 | # PGH004 -24 |-x = 2 # noqa : X300 - 24 |+x = 2 # noqa: X300 -25 25 | -26 26 | # PGH004 -27 27 | x = 2 # noqa : X400 - -PGH004_0.py:27:8: PGH004 [*] Do not add spaces between `noqa` and its colon - | -26 | # PGH004 -27 | x = 2 # noqa : X400 - | ^^^^^^^^ PGH004 -28 | -29 | # PGH004 - | - = help: Remove space(s) before colon - -ℹ Unsafe fix -24 24 | x = 2 # noqa : X300 -25 25 | -26 26 | # PGH004 -27 |-x = 2 # noqa : X400 - 27 |+x = 2 # noqa: X400 -28 28 | -29 29 | # PGH004 -30 30 | x = 2 # noqa :X500 - -PGH004_0.py:30:8: PGH004 [*] Do not add spaces between `noqa` and its colon - | -29 | # PGH004 -30 | x = 2 # noqa :X500 - | ^^^^^^^ PGH004 - | - = help: Remove space(s) before colon - -ℹ Unsafe fix -27 27 | x = 2 # noqa : X400 -28 28 | -29 29 | # PGH004 -30 |-x = 2 # noqa :X500 - 30 |+x = 2 # noqa:X500 diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_1.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_1.py.snap index 34c02426953b0..a4aee355b85cc 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_1.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pygrep_hooks/mod.rs +snapshot_kind: text --- PGH004_1.py:1:1: PGH004 Use specific rule codes when using `noqa` | diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_2.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_2.py.snap index e2b9bdf292282..6c93b8a1083f8 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_2.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_2.py.snap @@ -8,3 +8,18 @@ PGH004_2.py:1:1: PGH004 Use specific rule codes when using `noqa` 2 | # ruff : noqa 3 | # ruff: noqa: F401 | + +PGH004_2.py:2:1: PGH004 Use specific rule codes when using `ruff: noqa` + | +1 | # noqa +2 | # ruff : noqa + | ^^^^^^^^^^^^^ PGH004 +3 | # ruff: noqa: F401 + | + +PGH004_2.py:6:1: PGH004 Use specific rule codes when using `ruff: noqa` + | +6 | # flake8: noqa + | ^^^^^^^^^^^^^^ PGH004 +7 | import math as m + | diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_3.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_3.py.snap index d5e81ab92031e..8bbce8e2cd9c5 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_3.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH004_PGH004_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pygrep_hooks/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH005_PGH005_0.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH005_PGH005_0.py.snap index 4172207cee02a..1d8c3f41fff02 100644 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH005_PGH005_0.py.snap +++ b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__PGH005_PGH005_0.py.snap @@ -85,8 +85,6 @@ PGH005_0.py:10:1: PGH005 Mock method should be called: `assert_called_once_with` 9 | my_mock.assert_called_once_with 10 | MyMock.assert_called_once_with | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PGH005 -11 | +11 | 12 | # OK | - - diff --git a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__preview__PGH004_PGH004_2.py.snap b/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__preview__PGH004_PGH004_2.py.snap deleted file mode 100644 index 6c93b8a1083f8..0000000000000 --- a/crates/ruff_linter/src/rules/pygrep_hooks/snapshots/ruff_linter__rules__pygrep_hooks__tests__preview__PGH004_PGH004_2.py.snap +++ /dev/null @@ -1,25 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pygrep_hooks/mod.rs ---- -PGH004_2.py:1:1: PGH004 Use specific rule codes when using `noqa` - | -1 | # noqa - | ^^^^^^ PGH004 -2 | # ruff : noqa -3 | # ruff: noqa: F401 - | - -PGH004_2.py:2:1: PGH004 Use specific rule codes when using `ruff: noqa` - | -1 | # noqa -2 | # ruff : noqa - | ^^^^^^^^^^^^^ PGH004 -3 | # ruff: noqa: F401 - | - -PGH004_2.py:6:1: PGH004 Use specific rule codes when using `ruff: noqa` - | -6 | # flake8: noqa - | ^^^^^^^^^^^^^^ PGH004 -7 | import math as m - | diff --git a/crates/ruff_linter/src/rules/pylint/helpers.rs b/crates/ruff_linter/src/rules/pylint/helpers.rs index 6091a9a6ca60e..056d27b6024f4 100644 --- a/crates/ruff_linter/src/rules/pylint/helpers.rs +++ b/crates/ruff_linter/src/rules/pylint/helpers.rs @@ -1,6 +1,6 @@ use ruff_python_ast as ast; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::{visitor, Arguments, Expr, Stmt}; +use ruff_python_ast::{Arguments, Expr, Stmt, visitor}; use ruff_python_semantic::analyze::function_type; use ruff_python_semantic::{ScopeKind, SemanticModel}; use ruff_text_size::TextRange; @@ -10,7 +10,7 @@ use crate::settings::LinterSettings; /// Returns the value of the `name` parameter to, e.g., a `TypeVar` constructor. pub(super) fn type_param_name(arguments: &Arguments) -> Option<&str> { // Handle both `TypeVar("T")` and `TypeVar(name="T")`. - let name_param = arguments.find_argument("name", 0)?; + let name_param = arguments.find_argument_value("name", 0)?; if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = &name_param { Some(value.to_str()) } else { @@ -113,7 +113,7 @@ impl SequenceIndexVisitor<'_> { } } -impl<'a> Visitor<'_> for SequenceIndexVisitor<'a> { +impl Visitor<'_> for SequenceIndexVisitor<'_> { fn visit_stmt(&mut self, stmt: &Stmt) { if self.modified { return; @@ -166,16 +166,68 @@ impl<'a> Visitor<'_> for SequenceIndexVisitor<'a> { } } -/// Returns `true` if a method is a known dunder method. -pub(super) fn is_known_dunder_method(method: &str) -> bool { +pub(crate) fn is_dunder_operator_method(method: &str) -> bool { matches!( method, - "__abs__" + "__lt__" + | "__le__" + | "__eq__" + | "__ne__" + | "__gt__" + | "__ge__" | "__add__" + | "__sub__" + | "__mul__" + | "__matmul__" + | "__truediv__" + | "__floordiv__" + | "__mod__" + | "__divmod__" + | "__pow__" + | "__lshift__" + | "__rshift__" + | "__and__" + | "__xor__" + | "__or__" + | "__radd__" + | "__rsub__" + | "__rmul__" + | "__rmatmul__" + | "__rtruediv__" + | "__rfloordiv__" + | "__rmod__" + | "__rdivmod__" + | "__rpow__" + | "__rlshift__" + | "__rrshift__" + | "__rand__" + | "__rxor__" + | "__ror__" + | "__iadd__" + | "__isub__" + | "__imul__" + | "__imatmul__" + | "__itruediv__" + | "__ifloordiv__" + | "__imod__" + | "__ipow__" + | "__ilshift__" + | "__irshift__" + | "__iand__" + | "__ixor__" + | "__ior__" + ) +} + +/// Returns `true` if a method is a known dunder method. +pub(super) fn is_known_dunder_method(method: &str) -> bool { + is_dunder_operator_method(method) + || matches!( + method, + "__abs__" | "__aenter__" | "__aexit__" | "__aiter__" - | "__and__" | "__anext__" | "__attrs_init__" | "__attrs_post_init__" @@ -198,17 +250,13 @@ pub(super) fn is_known_dunder_method(method: &str) -> bool { | "__delitem__" | "__dict__" | "__dir__" - | "__divmod__" | "__doc__" | "__enter__" - | "__eq__" | "__exit__" | "__float__" | "__floor__" - | "__floordiv__" | "__format__" | "__fspath__" - | "__ge__" | "__get__" | "__getattr__" | "__getattribute__" @@ -216,70 +264,33 @@ pub(super) fn is_known_dunder_method(method: &str) -> bool { | "__getnewargs__" | "__getnewargs_ex__" | "__getstate__" - | "__gt__" | "__hash__" | "__html__" - | "__iadd__" - | "__iand__" - | "__ifloordiv__" - | "__ilshift__" - | "__imatmul__" - | "__imod__" - | "__imul__" | "__index__" | "__init__" | "__init_subclass__" | "__instancecheck__" | "__int__" | "__invert__" - | "__ior__" - | "__ipow__" - | "__irshift__" - | "__isub__" | "__iter__" - | "__itruediv__" - | "__ixor__" - | "__le__" | "__len__" | "__length_hint__" - | "__lshift__" - | "__lt__" - | "__matmul__" | "__missing__" - | "__mod__" | "__module__" | "__mro_entries__" - | "__mul__" - | "__ne__" | "__neg__" | "__new__" | "__next__" - | "__or__" | "__pos__" | "__post_init__" - | "__pow__" | "__prepare__" - | "__radd__" - | "__rand__" - | "__rdivmod__" | "__reduce__" | "__reduce_ex__" | "__release_buffer__" + | "__replace__" | "__repr__" | "__reversed__" - | "__rfloordiv__" - | "__rlshift__" - | "__rmatmul__" - | "__rmod__" - | "__rmul__" - | "__ror__" | "__round__" - | "__rpow__" - | "__rrshift__" - | "__rshift__" - | "__rsub__" - | "__rtruediv__" - | "__rxor__" | "__set__" | "__set_name__" | "__setattr__" @@ -287,21 +298,20 @@ pub(super) fn is_known_dunder_method(method: &str) -> bool { | "__setstate__" | "__sizeof__" | "__str__" - | "__sub__" | "__subclasscheck__" | "__subclasses__" | "__subclasshook__" - | "__truediv__" | "__trunc__" | "__weakref__" - | "__xor__" // Overridable sunder names from the `Enum` class. // See: https://docs.python.org/3/library/enum.html#supported-sunder-names + | "_add_alias_" + | "_add_value_alias_" | "_name_" | "_value_" | "_missing_" | "_ignore_" | "_order_" | "_generate_next_value_" - ) + ) } diff --git a/crates/ruff_linter/src/rules/pylint/mod.rs b/crates/ruff_linter/src/rules/pylint/mod.rs index e4fec38d4573d..67dbdd0683938 100644 --- a/crates/ruff_linter/src/rules/pylint/mod.rs +++ b/crates/ruff_linter/src/rules/pylint/mod.rs @@ -1,5 +1,5 @@ //! Rules from [Pylint](https://pypi.org/project/pylint/). -mod helpers; +pub(crate) mod helpers; pub(crate) mod rules; pub mod settings; @@ -9,15 +9,16 @@ mod tests { use anyhow::Result; use regex::Regex; + use ruff_python_ast::PythonVersion; use rustc_hash::FxHashSet; use test_case::test_case; use crate::registry::Rule; - use crate::rules::pylint; + use crate::rules::{flake8_tidy_imports, pylint}; use crate::assert_messages; - use crate::settings::types::PythonVersion; use crate::settings::LinterSettings; + use crate::settings::types::PreviewMode; use crate::test::test_path; #[test_case(Rule::SingledispatchMethod, Path::new("singledispatch_method.py"))] @@ -27,6 +28,7 @@ mod tests { )] #[test_case(Rule::AssertOnStringLiteral, Path::new("assert_on_string_literal.py"))] #[test_case(Rule::AwaitOutsideAsync, Path::new("await_outside_async.py"))] + #[test_case(Rule::AwaitOutsideAsync, Path::new("await_outside_async.ipynb"))] #[test_case(Rule::BadOpenMode, Path::new("bad_open_mode.py"))] #[test_case( Rule::BadStringFormatCharacter, @@ -62,6 +64,10 @@ mod tests { #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_10.py"))] #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_11.py"))] #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_12.py"))] + #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_13.py"))] + #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_14.py"))] + #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_15.py"))] + #[test_case(Rule::SysExitAlias, Path::new("sys_exit_alias_16.py"))] #[test_case(Rule::ContinueInFinally, Path::new("continue_in_finally.py"))] #[test_case(Rule::GlobalStatement, Path::new("global_statement.py"))] #[test_case( @@ -104,6 +110,7 @@ mod tests { Rule::InvalidCharacterBackspace, Path::new("invalid_characters_syntax_error.py") )] + #[test_case(Rule::ShallowCopyEnviron, Path::new("shallow_copy_environ.py"))] #[test_case(Rule::InvalidEnvvarDefault, Path::new("invalid_envvar_default.py"))] #[test_case(Rule::InvalidEnvvarValue, Path::new("invalid_envvar_value.py"))] #[test_case(Rule::IterationOverSet, Path::new("iteration_over_set.py"))] @@ -116,6 +123,10 @@ mod tests { Path::new("named_expr_without_context.py") )] #[test_case(Rule::NonlocalAndGlobal, Path::new("nonlocal_and_global.py"))] + #[test_case( + Rule::RedefinedSlotsInSubclass, + Path::new("redefined_slots_in_subclass.py") + )] #[test_case(Rule::NonlocalWithoutBinding, Path::new("nonlocal_without_binding.py"))] #[test_case(Rule::NonSlotAssignment, Path::new("non_slot_assignment.py"))] #[test_case(Rule::PropertyWithParameters, Path::new("property_with_parameters.py"))] @@ -159,6 +170,7 @@ mod tests { #[test_case(Rule::UselessImportAlias, Path::new("import_aliasing.py"))] #[test_case(Rule::UselessReturn, Path::new("useless_return.py"))] #[test_case(Rule::UselessWithLock, Path::new("useless_with_lock.py"))] + #[test_case(Rule::UnreachableCode, Path::new("unreachable.py"))] #[test_case( Rule::YieldFromInAsyncFunction, Path::new("yield_from_in_async_function.py") @@ -218,6 +230,7 @@ mod tests { Rule::BadStaticmethodArgument, Path::new("bad_staticmethod_argument.py") )] + #[test_case(Rule::LenTest, Path::new("len_as_condition.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -241,7 +254,7 @@ mod tests { let diagnostics = test_path( Path::new("pylint/continue_in_finally.py"), &LinterSettings::for_rule(Rule::ContinueInFinally) - .with_target_version(PythonVersion::Py37), + .with_target_version(PythonVersion::PY37), )?; assert_messages!(diagnostics); Ok(()) @@ -403,4 +416,28 @@ mod tests { assert_messages!(diagnostics); Ok(()) } + + #[test] + fn import_outside_top_level_with_banned() -> Result<()> { + let diagnostics = test_path( + Path::new("pylint/import_outside_top_level_with_banned.py"), + &LinterSettings { + preview: PreviewMode::Enabled, + flake8_tidy_imports: flake8_tidy_imports::settings::Settings { + banned_module_level_imports: vec![ + "foo_banned".to_string(), + "pkg_banned".to_string(), + "pkg.bar_banned".to_string(), + ], + ..Default::default() + }, + ..LinterSettings::for_rules(vec![ + Rule::BannedModuleLevelImports, + Rule::ImportOutsideTopLevel, + ]) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/and_or_ternary.rs b/crates/ruff_linter/src/rules/pylint/rules/and_or_ternary.rs index c13ea44495764..8baf775f86bc8 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/and_or_ternary.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/and_or_ternary.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::violation; +use ruff_macros::ViolationMetadata; /// ## Removal /// This rule was removed from Ruff because it was common for it to introduce behavioral changes. @@ -27,8 +27,8 @@ use ruff_macros::violation; /// x, y = 1, 2 /// maximum = x if x >= y else y /// ``` -#[violation] -pub struct AndOrTernary; +#[derive(ViolationMetadata)] +pub(crate) struct AndOrTernary; /// PLR1706 impl Violation for AndOrTernary { diff --git a/crates/ruff_linter/src/rules/pylint/rules/assert_on_string_literal.rs b/crates/ruff_linter/src/rules/pylint/rules/assert_on_string_literal.rs index 5f0801731f695..2673a57bae089 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/assert_on_string_literal.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/assert_on_string_literal.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -25,28 +25,31 @@ enum Kind { /// ```python /// assert "always true" /// ``` -#[violation] -pub struct AssertOnStringLiteral { +#[derive(ViolationMetadata)] +pub(crate) struct AssertOnStringLiteral { kind: Kind, } impl Violation for AssertOnStringLiteral { #[derive_message_formats] fn message(&self) -> String { - let AssertOnStringLiteral { kind } = self; - match kind { - Kind::Empty => format!("Asserting on an empty string literal will never pass"), - Kind::NonEmpty => format!("Asserting on a non-empty string literal will always pass"), - Kind::Unknown => format!("Asserting on a string literal may have unintended results"), + match self.kind { + Kind::Empty => "Asserting on an empty string literal will never pass".to_string(), + Kind::NonEmpty => { + "Asserting on a non-empty string literal will always pass".to_string() + } + Kind::Unknown => { + "Asserting on a string literal may have unintended results".to_string() + } } } } /// PLW0129 -pub(crate) fn assert_on_string_literal(checker: &mut Checker, test: &Expr) { +pub(crate) fn assert_on_string_literal(checker: &Checker, test: &Expr) { match test { Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AssertOnStringLiteral { kind: if value.is_empty() { Kind::Empty @@ -58,7 +61,7 @@ pub(crate) fn assert_on_string_literal(checker: &mut Checker, test: &Expr) { )); } Expr::BytesLiteral(ast::ExprBytesLiteral { value, .. }) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AssertOnStringLiteral { kind: if value.is_empty() { Kind::Empty @@ -97,7 +100,7 @@ pub(crate) fn assert_on_string_literal(checker: &mut Checker, test: &Expr) { } else { Kind::Unknown }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( AssertOnStringLiteral { kind }, test.range(), )); diff --git a/crates/ruff_linter/src/rules/pylint/rules/await_outside_async.rs b/crates/ruff_linter/src/rules/pylint/rules/await_outside_async.rs index 636ea35953b07..9c768195b9493 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/await_outside_async.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/await_outside_async.rs @@ -1,16 +1,11 @@ -use ruff_python_ast::Expr; - -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; +use ruff_diagnostics::Violation; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does -/// Checks for uses of `await` outside of `async` functions. +/// Checks for uses of `await` outside `async` functions. /// /// ## Why is this bad? -/// Using `await` outside of an `async` function is a syntax error. +/// Using `await` outside an `async` function is a syntax error. /// /// ## Example /// ```python @@ -30,24 +25,21 @@ use crate::checkers::ast::Checker; /// await asyncio.sleep(1) /// ``` /// +/// ## Notebook behavior +/// As an exception, `await` is allowed at the top level of a Jupyter notebook +/// (see: [autoawait]). +/// /// ## References /// - [Python documentation: Await expression](https://docs.python.org/3/reference/expressions.html#await) -/// - [PEP 492](https://peps.python.org/pep-0492/#await-expression) -#[violation] -pub struct AwaitOutsideAsync; +/// - [PEP 492: Await Expression](https://peps.python.org/pep-0492/#await-expression) +/// +/// [autoawait]: https://ipython.readthedocs.io/en/stable/interactive/autoawait.html +#[derive(ViolationMetadata)] +pub(crate) struct AwaitOutsideAsync; impl Violation for AwaitOutsideAsync { #[derive_message_formats] fn message(&self) -> String { - format!("`await` should be used within an async function") - } -} - -/// PLE1142 -pub(crate) fn await_outside_async(checker: &mut Checker, expr: &Expr) { - if !checker.semantic().in_async_context() { - checker - .diagnostics - .push(Diagnostic::new(AwaitOutsideAsync, expr.range())); + "`await` should be used within an async function".to_string() } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs index 95dc16ab9cd6f..e833be1c7d03e 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility; @@ -42,8 +42,8 @@ use crate::rules::pylint::helpers::is_known_dunder_method; /// /// ## Options /// - `lint.pylint.allow-dunder-method-names` -#[violation] -pub struct BadDunderMethodName { +#[derive(ViolationMetadata)] +pub(crate) struct BadDunderMethodName { name: String, } @@ -56,7 +56,11 @@ impl Violation for BadDunderMethodName { } /// PLW3201 -pub(crate) fn bad_dunder_method_name(checker: &mut Checker, method: &ast::StmtFunctionDef) { +pub(crate) fn bad_dunder_method_name(checker: &Checker, method: &ast::StmtFunctionDef) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } // If the name isn't a dunder, skip it. if !method.name.starts_with('_') || !method.name.ends_with('_') { return; @@ -78,7 +82,7 @@ pub(crate) fn bad_dunder_method_name(checker: &mut Checker, method: &ast::StmtFu return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadDunderMethodName { name: method.name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_open_mode.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_open_mode.rs index 0b66cab8cef06..d9900cea2a696 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_open_mode.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_open_mode.rs @@ -1,9 +1,8 @@ -use bitflags::bitflags; - use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::SemanticModel; +use ruff_python_stdlib::open_mode::OpenMode; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -36,8 +35,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `open`](https://docs.python.org/3/library/functions.html#open) -#[violation] -pub struct BadOpenMode { +#[derive(ViolationMetadata)] +pub(crate) struct BadOpenMode { mode: String, } @@ -50,7 +49,7 @@ impl Violation for BadOpenMode { } /// PLW1501 -pub(crate) fn bad_open_mode(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn bad_open_mode(checker: &Checker, call: &ast::ExprCall) { let Some(kind) = is_open(call.func.as_ref(), checker.semantic()) else { return; }; @@ -59,15 +58,15 @@ pub(crate) fn bad_open_mode(checker: &mut Checker, call: &ast::ExprCall) { return; }; - let ast::Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = mode else { + let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = mode else { return; }; - if is_valid_mode(value) { + if OpenMode::from_chars(value.chars()).is_ok() { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadOpenMode { mode: value.to_string(), }, @@ -108,87 +107,7 @@ fn is_open(func: &Expr, semantic: &SemanticModel) -> Option<Kind> { /// Returns the mode argument, if present. fn extract_mode(call: &ast::ExprCall, kind: Kind) -> Option<&Expr> { match kind { - Kind::Builtin => call.arguments.find_argument("mode", 1), - Kind::Pathlib => call.arguments.find_argument("mode", 0), - } -} - -bitflags! { - #[derive(Copy, Clone, Debug, PartialEq, Eq)] - pub(super) struct OpenMode: u8 { - /// `r` - const READ = 0b0001; - /// `w` - const WRITE = 0b0010; - /// `a` - const APPEND = 0b0100; - /// `x` - const CREATE = 0b1000; - /// `b` - const BINARY = 0b10000; - /// `t` - const TEXT = 0b10_0000; - /// `+` - const PLUS = 0b100_0000; - /// `U` - const UNIVERSAL_NEWLINES = 0b1000_0000; - - } -} - -impl TryFrom<char> for OpenMode { - type Error = (); - - fn try_from(value: char) -> Result<Self, Self::Error> { - match value { - 'r' => Ok(Self::READ), - 'w' => Ok(Self::WRITE), - 'a' => Ok(Self::APPEND), - 'x' => Ok(Self::CREATE), - 'b' => Ok(Self::BINARY), - 't' => Ok(Self::TEXT), - '+' => Ok(Self::PLUS), - 'U' => Ok(Self::UNIVERSAL_NEWLINES), - _ => Err(()), - } + Kind::Builtin => call.arguments.find_argument_value("mode", 1), + Kind::Pathlib => call.arguments.find_argument_value("mode", 0), } } - -/// Returns `true` if the open mode is valid. -fn is_valid_mode(mode: &ast::StringLiteralValue) -> bool { - // Flag duplicates and invalid characters. - let mut flags = OpenMode::empty(); - for char in mode.chars() { - let Ok(flag) = OpenMode::try_from(char) else { - return false; - }; - if flags.intersects(flag) { - return false; - } - flags.insert(flag); - } - - // Both text and binary mode cannot be set at the same time. - if flags.contains(OpenMode::TEXT | OpenMode::BINARY) { - return false; - } - - // The `U` mode is only valid with `r`. - if flags.contains(OpenMode::UNIVERSAL_NEWLINES) - && flags.intersects(OpenMode::WRITE | OpenMode::APPEND | OpenMode::CREATE) - { - return false; - } - - // Otherwise, reading, writing, creating, and appending are mutually exclusive. - [ - OpenMode::READ | OpenMode::UNIVERSAL_NEWLINES, - OpenMode::WRITE, - OpenMode::CREATE, - OpenMode::APPEND, - ] - .into_iter() - .filter(|flag| flags.intersects(*flag)) - .count() - == 1 -} diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_staticmethod_argument.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_staticmethod_argument.rs index 05974be70239b..937b5846eaafa 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_staticmethod_argument.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_staticmethod_argument.rs @@ -1,15 +1,17 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::ParameterWithDefault; -use ruff_python_semantic::analyze::function_type; use ruff_python_semantic::Scope; +use ruff_python_semantic::analyze::function_type; +use ruff_python_semantic::analyze::function_type::FunctionType; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; /// ## What it does /// Checks for static methods that use `self` or `cls` as their first argument. +/// This rule also applies to `__new__` methods, which are implicitly static. /// /// ## Why is this bad? /// [PEP 8] recommends the use of `self` and `cls` as the first arguments for @@ -34,8 +36,8 @@ use crate::checkers::ast::Checker; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#function-and-method-arguments -#[violation] -pub struct BadStaticmethodArgument { +#[derive(ViolationMetadata)] +pub(crate) struct BadStaticmethodArgument { argument_name: String, } @@ -48,11 +50,7 @@ impl Violation for BadStaticmethodArgument { } /// PLW0211 -pub(crate) fn bad_staticmethod_argument( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn bad_staticmethod_argument(checker: &Checker, scope: &Scope) { let Some(func) = scope.kind.as_function() else { return; }; @@ -76,8 +74,12 @@ pub(crate) fn bad_staticmethod_argument( &checker.settings.pep8_naming.classmethod_decorators, &checker.settings.pep8_naming.staticmethod_decorators, ); - if !matches!(type_, function_type::FunctionType::StaticMethod) { - return; + + match type_ { + FunctionType::StaticMethod | FunctionType::NewMethod => {} + FunctionType::Function | FunctionType::Method | FunctionType::ClassMethod => { + return; + } } let Some(ParameterWithDefault { @@ -99,7 +101,7 @@ pub(crate) fn bad_staticmethod_argument( _ => return, } - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadStaticmethodArgument { argument_name: self_or_cls.name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_str_strip_call.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_str_strip_call.rs index 77d375c03faa5..94e700223ec18 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_str_strip_call.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_str_strip_call.rs @@ -4,11 +4,13 @@ use ruff_python_ast::{self as ast, Expr}; use rustc_hash::FxHashSet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks duplicate characters in `str.strip` calls. @@ -45,8 +47,8 @@ use crate::settings::types::PythonVersion; /// /// ## References /// - [Python documentation: `str.strip`](https://docs.python.org/3/library/stdtypes.html?highlight=strip#str.strip) -#[violation] -pub struct BadStrStripCall { +#[derive(ViolationMetadata)] +pub(crate) struct BadStrStripCall { strip: StripKind, removal: Option<RemovalKind>, } @@ -65,6 +67,34 @@ impl Violation for BadStrStripCall { } } +#[derive(Debug, PartialEq, Eq, Copy, Clone)] +pub(crate) enum ValueKind { + String, + Bytes, +} + +impl ValueKind { + fn from(expr: &Expr, semantic: &SemanticModel) -> Option<Self> { + match expr { + Expr::StringLiteral(_) => Some(Self::String), + Expr::BytesLiteral(_) => Some(Self::Bytes), + Expr::Name(name) => { + let binding_id = semantic.only_binding(name)?; + let binding = semantic.binding(binding_id); + + if typing::is_string(binding, semantic) { + Some(Self::String) + } else if typing::is_bytes(binding, semantic) { + Some(Self::Bytes) + } else { + None + } + } + _ => None, + } + } +} + #[derive(Debug, PartialEq, Eq, Copy, Clone)] pub(crate) enum StripKind { Strip, @@ -120,52 +150,68 @@ impl fmt::Display for RemovalKind { } } -/// Return `true` if a string contains duplicate characters, taking into account -/// escapes. -fn has_duplicates(s: &ast::StringLiteralValue) -> bool { - let mut escaped = false; +fn string_has_duplicate_char(string: &ast::StringLiteralValue) -> bool { + has_duplicate(string.chars()) +} + +fn bytes_has_duplicate_char(bytes: &ast::BytesLiteralValue) -> bool { + has_duplicate(bytes.bytes().map(char::from)) +} + +/// Return true if a string or byte sequence has a duplicate. +fn has_duplicate(mut chars: impl Iterator<Item = char>) -> bool { let mut seen = FxHashSet::default(); - for ch in s.chars() { - if escaped { - escaped = false; - let pair = format!("\\{ch}"); - if !seen.insert(pair) { - return true; - } - } else if ch == '\\' { - escaped = true; - } else if !seen.insert(ch.to_string()) { - return true; - } - } - false + + chars.any(|char| !seen.insert(char)) } /// PLE1310 -pub(crate) fn bad_str_strip_call(checker: &mut Checker, func: &Expr, args: &[Expr]) { - if let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func { - if matches!( - value.as_ref(), - Expr::StringLiteral(_) | Expr::BytesLiteral(_) - ) { - if let Some(strip) = StripKind::from_str(attr.as_str()) { - if let Some(arg) = args.first() { - if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = &arg { - if has_duplicates(value) { - let removal = if checker.settings.target_version >= PythonVersion::Py39 - { - RemovalKind::for_strip(strip) - } else { - None - }; - checker.diagnostics.push(Diagnostic::new( - BadStrStripCall { strip, removal }, - arg.range(), - )); - } - } - } - } +pub(crate) fn bad_str_strip_call(checker: &Checker, call: &ast::ExprCall) { + let (func, arguments) = (&call.func, &call.arguments); + + let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = func.as_ref() else { + return; + }; + + let Some(strip) = StripKind::from_str(attr.as_str()) else { + return; + }; + + if !arguments.keywords.is_empty() { + return; + } + + let [arg] = arguments.args.as_ref() else { + return; + }; + + let value = &**value; + + let Some(value_kind) = ValueKind::from(value, checker.semantic()) else { + return; + }; + + let duplicated = match arg { + Expr::StringLiteral(string) if value_kind == ValueKind::String => { + string_has_duplicate_char(&string.value) + } + Expr::BytesLiteral(bytes) if value_kind == ValueKind::Bytes => { + bytes_has_duplicate_char(&bytes.value) } + _ => return, + }; + + if !duplicated { + return; } + + let removal = if checker.target_version() >= PythonVersion::PY39 { + RemovalKind::for_strip(strip) + } else { + None + }; + + let diagnostic = Diagnostic::new(BadStrStripCall { strip, removal }, arg.range()); + + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_character.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_character.rs index 334f8d2330db4..6d853115ca957 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_character.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_character.rs @@ -1,7 +1,7 @@ use std::str::FromStr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprStringLiteral, StringFlags, StringLiteral}; use ruff_python_literal::{ cformat::{CFormatErrorType, CFormatString}, @@ -26,8 +26,8 @@ use crate::checkers::ast::Checker; /// /// print("{:z}".format("1")) /// ``` -#[violation] -pub struct BadStringFormatCharacter { +#[derive(ViolationMetadata)] +pub(crate) struct BadStringFormatCharacter { format_char: char, } @@ -41,7 +41,7 @@ impl Violation for BadStringFormatCharacter { /// PLE1300 /// Ex) `"{:z}".format("1")` -pub(crate) fn call(checker: &mut Checker, string: &str, range: TextRange) { +pub(crate) fn call(checker: &Checker, string: &str, range: TextRange) { if let Ok(format_string) = FormatString::from_str(string) { for part in &format_string.format_parts { let FormatPart::Field { format_spec, .. } = part else { @@ -50,7 +50,7 @@ pub(crate) fn call(checker: &mut Checker, string: &str, range: TextRange) { match FormatSpec::parse(format_spec) { Err(FormatSpecError::InvalidFormatType) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadStringFormatCharacter { // The format type character is always the last one. // More info in the official spec: @@ -70,7 +70,7 @@ pub(crate) fn call(checker: &mut Checker, string: &str, range: TextRange) { if let Err(FormatSpecError::InvalidFormatType) = FormatSpec::parse(&format_spec) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadStringFormatCharacter { // The format type character is always the last one. // More info in the official spec: @@ -89,7 +89,7 @@ pub(crate) fn call(checker: &mut Checker, string: &str, range: TextRange) { /// PLE1300 /// Ex) `"%z" % "1"` -pub(crate) fn percent(checker: &mut Checker, expr: &Expr, format_string: &ExprStringLiteral) { +pub(crate) fn percent(checker: &Checker, expr: &Expr, format_string: &ExprStringLiteral) { for StringLiteral { value: _, range, @@ -103,11 +103,11 @@ pub(crate) fn percent(checker: &mut Checker, expr: &Expr, format_string: &ExprSt // Parse the format string (e.g. `"%s"`) into a list of `PercentFormat`. if let Err(format_error) = CFormatString::from_str(string) { if let CFormatErrorType::UnsupportedFormatChar(format_char) = format_error.typ { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BadStringFormatCharacter { format_char }, expr.range(), )); } - }; + } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_type.rs b/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_type.rs index 29036937d0946..e11c9e7f4f449 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_type.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bad_string_format_type.rs @@ -6,7 +6,7 @@ use ruff_text_size::Ranged; use rustc_hash::FxHashMap; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; use crate::checkers::ast::Checker; @@ -27,13 +27,13 @@ use crate::checkers::ast::Checker; /// ```python /// print("%d" % 1) /// ``` -#[violation] -pub struct BadStringFormatType; +#[derive(ViolationMetadata)] +pub(crate) struct BadStringFormatType; impl Violation for BadStringFormatType { #[derive_message_formats] fn message(&self) -> String { - format!("Format type does not match argument type") + "Format type does not match argument type".to_string() } } @@ -211,7 +211,7 @@ fn is_valid_dict(formats: &[CFormatStrOrBytes<String>], items: &[ast::DictItem]) /// PLE1307 pub(crate) fn bad_string_format_type( - checker: &mut Checker, + checker: &Checker, bin_op: &ast::ExprBinOp, format_string: &ast::ExprStringLiteral, ) { @@ -230,7 +230,7 @@ pub(crate) fn bad_string_format_type( // Parse the format string (e.g. `"%s"`) into a list of `PercentFormat`. if let Ok(format_string) = CFormatString::from_str(string) { format_strings.push(format_string); - }; + } } // Parse the parameters. @@ -240,8 +240,6 @@ pub(crate) fn bad_string_format_type( _ => is_valid_constant(&format_strings, &bin_op.right), }; if !is_valid { - checker - .diagnostics - .push(Diagnostic::new(BadStringFormatType, bin_op.range())); + checker.report_diagnostic(Diagnostic::new(BadStringFormatType, bin_op.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/bidirectional_unicode.rs b/crates/ruff_linter/src/rules/pylint/rules/bidirectional_unicode.rs index 68ce969d50789..9231d9b812a12 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/bidirectional_unicode.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/bidirectional_unicode.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::Line; const BIDI_UNICODE: [char; 10] = [ @@ -13,7 +13,7 @@ const BIDI_UNICODE: [char; 10] = [ '\u{2068}', //{FIRST STRONG ISOLATE} '\u{2069}', //{POP DIRECTIONAL ISOLATE} // The following was part of PEP 672: - // https://www.python.org/dev/peps/pep-0672/ + // https://peps.python.org/pep-0672/ // so the list above might not be complete '\u{200F}', //{RIGHT-TO-LEFT MARK} // We don't use @@ -40,14 +40,14 @@ const BIDI_UNICODE: [char; 10] = [ /// ``` /// /// ## References -/// - [PEP 672](https://peps.python.org/pep-0672/#bidirectional-text) -#[violation] -pub struct BidirectionalUnicode; +/// - [PEP 672: Bidirectional Text](https://peps.python.org/pep-0672/#bidirectional-text) +#[derive(ViolationMetadata)] +pub(crate) struct BidirectionalUnicode; impl Violation for BidirectionalUnicode { #[derive_message_formats] fn message(&self) -> String { - format!("Contains control characters that can permit obfuscated code") + "Contains control characters that can permit obfuscated code".to_string() } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/binary_op_exception.rs b/crates/ruff_linter/src/rules/pylint/rules/binary_op_exception.rs index 9870895c3fed9..1b1ad85c100f8 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/binary_op_exception.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/binary_op_exception.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -46,24 +46,25 @@ impl From<&ast::BoolOp> for BoolOp { /// except (A, B): /// pass /// ``` -#[violation] -pub struct BinaryOpException { +#[derive(ViolationMetadata)] +pub(crate) struct BinaryOpException { op: BoolOp, } impl Violation for BinaryOpException { #[derive_message_formats] fn message(&self) -> String { - let BinaryOpException { op } = self; - match op { - BoolOp::And => format!("Exception to catch is the result of a binary `and` operation"), - BoolOp::Or => format!("Exception to catch is the result of a binary `or` operation"), + match self.op { + BoolOp::And => { + "Exception to catch is the result of a binary `and` operation".to_string() + } + BoolOp::Or => "Exception to catch is the result of a binary `or` operation".to_string(), } } } /// PLW0711 -pub(crate) fn binary_op_exception(checker: &mut Checker, except_handler: &ExceptHandler) { +pub(crate) fn binary_op_exception(checker: &Checker, except_handler: &ExceptHandler) { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, .. }) = except_handler; @@ -75,7 +76,7 @@ pub(crate) fn binary_op_exception(checker: &mut Checker, except_handler: &Except return; }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( BinaryOpException { op: op.into() }, type_.range(), )); diff --git a/crates/ruff_linter/src/rules/pylint/rules/boolean_chained_comparison.rs b/crates/ruff_linter/src/rules/pylint/rules/boolean_chained_comparison.rs index 7759b55b739a0..f3affe97f75b5 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/boolean_chained_comparison.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/boolean_chained_comparison.rs @@ -1,8 +1,9 @@ use itertools::Itertools; -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{ - name::Name, parenthesize::parenthesized_range, BoolOp, CmpOp, Expr, ExprBoolOp, ExprCompare, + BoolOp, CmpOp, Expr, ExprBoolOp, ExprCompare, + parenthesize::{parentheses_iterator, parenthesized_range}, }; use ruff_text_size::{Ranged, TextRange}; @@ -33,26 +34,22 @@ use crate::checkers::ast::Checker; /// if a < b < c: /// pass /// ``` -#[violation] -pub struct BooleanChainedComparison { - variable: Name, -} - -impl Violation for BooleanChainedComparison { - const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; +#[derive(ViolationMetadata)] +pub(crate) struct BooleanChainedComparison; +impl AlwaysFixableViolation for BooleanChainedComparison { #[derive_message_formats] fn message(&self) -> String { - format!("Contains chained boolean comparison that can be simplified") + "Contains chained boolean comparison that can be simplified".to_string() } - fn fix_title(&self) -> Option<String> { - Some("Use a single compare expression".to_string()) + fn fix_title(&self) -> String { + "Use a single compare expression".to_string() } } /// PLR1716 -pub(crate) fn boolean_chained_comparison(checker: &mut Checker, expr_bool_op: &ExprBoolOp) { +pub(crate) fn boolean_chained_comparison(checker: &Checker, expr_bool_op: &ExprBoolOp) { // early exit for non `and` boolean operations if expr_bool_op.op != BoolOp::And { return; @@ -66,11 +63,11 @@ pub(crate) fn boolean_chained_comparison(checker: &mut Checker, expr_bool_op: &E let locator = checker.locator(); let comment_ranges = checker.comment_ranges(); - // retrieve all compare statements from expression + // retrieve all compare expressions from boolean expression let compare_expressions = expr_bool_op .values .iter() - .map(|stmt| stmt.as_compare_expr().unwrap()); + .map(|expr| expr.as_compare_expr().unwrap()); let diagnostics = compare_expressions .tuple_windows() @@ -78,7 +75,7 @@ pub(crate) fn boolean_chained_comparison(checker: &mut Checker, expr_bool_op: &E are_compare_expr_simplifiable(left_compare, right_compare) }) .filter_map(|(left_compare, right_compare)| { - let Expr::Name(left_compare_right) = left_compare.comparators.first()? else { + let Expr::Name(left_compare_right) = left_compare.comparators.last()? else { return None; }; @@ -90,65 +87,93 @@ pub(crate) fn boolean_chained_comparison(checker: &mut Checker, expr_bool_op: &E return None; } - let left_has_paren = parenthesized_range( + let left_paren_count = parentheses_iterator( left_compare.into(), - expr_bool_op.into(), + Some(expr_bool_op.into()), comment_ranges, locator.contents(), ) - .is_some(); + .count(); - let right_has_paren = parenthesized_range( + let right_paren_count = parentheses_iterator( right_compare.into(), - expr_bool_op.into(), + Some(expr_bool_op.into()), + comment_ranges, + locator.contents(), + ) + .count(); + + // Create the edit that removes the comparison operator + + // In `a<(b) and ((b))<c`, we need to handle the + // parentheses when specifying the fix range. + let left_compare_right_range = parenthesized_range( + left_compare_right.into(), + left_compare.into(), comment_ranges, locator.contents(), ) - .is_some(); - - // Do not offer a fix if there are any parentheses - // TODO: We can support a fix here, we just need to be careful to balance the - // parentheses which requires a more sophisticated edit - let fix = if left_has_paren || right_has_paren { - None - } else { - let edit = Edit::range_replacement( - left_compare_right.id().to_string(), - TextRange::new(left_compare_right.start(), right_compare_left.end()), - ); - Some(Fix::safe_edit(edit)) + .unwrap_or(left_compare_right.range()); + let right_compare_left_range = parenthesized_range( + right_compare_left.into(), + right_compare.into(), + comment_ranges, + locator.contents(), + ) + .unwrap_or(right_compare_left.range()); + let edit = Edit::range_replacement( + locator.slice(left_compare_right_range).to_string(), + TextRange::new( + left_compare_right_range.start(), + right_compare_left_range.end(), + ), + ); + + // Balance left and right parentheses + let fix = match left_paren_count.cmp(&right_paren_count) { + std::cmp::Ordering::Less => { + let balance_parens_edit = Edit::insertion( + "(".repeat(right_paren_count - left_paren_count), + left_compare.start(), + ); + Fix::safe_edits(edit, [balance_parens_edit]) + } + std::cmp::Ordering::Equal => Fix::safe_edit(edit), + std::cmp::Ordering::Greater => { + let balance_parens_edit = Edit::insertion( + ")".repeat(left_paren_count - right_paren_count), + right_compare.end(), + ); + Fix::safe_edits(edit, [balance_parens_edit]) + } }; let mut diagnostic = Diagnostic::new( - BooleanChainedComparison { - variable: left_compare_right.id().clone(), - }, + BooleanChainedComparison, TextRange::new(left_compare.start(), right_compare.end()), ); - if let Some(fix) = fix { - diagnostic.set_fix(fix); - } + diagnostic.set_fix(fix); Some(diagnostic) }); - checker.diagnostics.extend(diagnostics); + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } /// Checks whether two compare expressions are simplifiable fn are_compare_expr_simplifiable(left: &ExprCompare, right: &ExprCompare) -> bool { - let [left_operator] = &*left.ops else { - return false; - }; - - let [right_operator] = &*right.ops else { - return false; - }; - - matches!( - (left_operator, right_operator), - (CmpOp::Lt | CmpOp::LtE, CmpOp::Lt | CmpOp::LtE) - | (CmpOp::Gt | CmpOp::GtE, CmpOp::Gt | CmpOp::GtE) - ) + left.ops + .iter() + .chain(right.ops.iter()) + .tuple_windows::<(_, _)>() + .all(|(left_operator, right_operator)| { + matches!( + (left_operator, right_operator), + (CmpOp::Lt | CmpOp::LtE, CmpOp::Lt | CmpOp::LtE) + | (CmpOp::Gt | CmpOp::GtE, CmpOp::Gt | CmpOp::GtE) + ) + }) } diff --git a/crates/ruff_linter/src/rules/pylint/rules/collapsible_else_if.rs b/crates/ruff_linter/src/rules/pylint/rules/collapsible_else_if.rs index 6c55fd405dfb0..aab8ae7935e52 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/collapsible_else_if.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/collapsible_else_if.rs @@ -2,16 +2,16 @@ use anyhow::Result; use ast::whitespace::indentation; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, ElifElseClause, Stmt}; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::edits::adjust_indentation; -use crate::Locator; /// ## What it does /// Checks for `else` blocks that consist of a single `if` statement. @@ -45,15 +45,15 @@ use crate::Locator; /// /// ## References /// - [Python documentation: `if` Statements](https://docs.python.org/3/tutorial/controlflow.html#if-statements) -#[violation] -pub struct CollapsibleElseIf; +#[derive(ViolationMetadata)] +pub(crate) struct CollapsibleElseIf; impl Violation for CollapsibleElseIf { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `elif` instead of `else` then `if`, to reduce indentation") + "Use `elif` instead of `else` then `if`, to reduce indentation".to_string() } fn fix_title(&self) -> Option<String> { @@ -62,7 +62,7 @@ impl Violation for CollapsibleElseIf { } /// PLR5501 -pub(crate) fn collapsible_else_if(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn collapsible_else_if(checker: &Checker, stmt: &Stmt) { let Stmt::If(ast::StmtIf { elif_else_clauses, .. }) = stmt @@ -95,7 +95,7 @@ pub(crate) fn collapsible_else_if(checker: &mut Checker, stmt: &Stmt) { checker.stylist(), ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Generate [`Fix`] to convert an `else` block to an `elif` block. diff --git a/crates/ruff_linter/src/rules/pylint/rules/compare_to_empty_string.rs b/crates/ruff_linter/src/rules/pylint/rules/compare_to_empty_string.rs index db7d246ec6166..2dc495ff90511 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/compare_to_empty_string.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/compare_to_empty_string.rs @@ -3,7 +3,7 @@ use itertools::Itertools; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,8 +40,8 @@ use crate::checkers::ast::Checker; /// - [Python documentation: Truth Value Testing](https://docs.python.org/3/library/stdtypes.html#truth-value-testing) /// /// [#4282]: https://github.com/astral-sh/ruff/issues/4282 -#[violation] -pub struct CompareToEmptyString { +#[derive(ViolationMetadata)] +pub(crate) struct CompareToEmptyString { existing: String, replacement: String, } @@ -59,7 +59,7 @@ impl Violation for CompareToEmptyString { /// PLC1901 pub(crate) fn compare_to_empty_string( - checker: &mut Checker, + checker: &Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr], @@ -89,7 +89,7 @@ pub(crate) fn compare_to_empty_string( let expr = checker.generator().expr(rhs); let existing = format!("{literal} {op} {expr}"); let replacement = format!("{}{expr}", op.into_unary()); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CompareToEmptyString { existing, replacement, @@ -107,7 +107,7 @@ pub(crate) fn compare_to_empty_string( let literal = checker.generator().expr(rhs); let existing = format!("{expr} {op} {literal}"); let replacement = format!("{}{expr}", op.into_unary()); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( CompareToEmptyString { existing, replacement, diff --git a/crates/ruff_linter/src/rules/pylint/rules/comparison_of_constant.rs b/crates/ruff_linter/src/rules/pylint/rules/comparison_of_constant.rs index f55906a324988..2d3662e04a633 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/comparison_of_constant.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/comparison_of_constant.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{CmpOp, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -27,8 +27,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) -#[violation] -pub struct ComparisonOfConstant { +#[derive(ViolationMetadata)] +pub(crate) struct ComparisonOfConstant { left_constant: String, op: CmpOp, right_constant: String, @@ -51,7 +51,7 @@ impl Violation for ComparisonOfConstant { /// PLR0133 pub(crate) fn comparison_of_constant( - checker: &mut Checker, + checker: &Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr], @@ -71,7 +71,7 @@ pub(crate) fn comparison_of_constant( left.range(), ); - checker.diagnostics.push(diagnostic); - }; + checker.report_diagnostic(diagnostic); + } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/comparison_with_itself.rs b/crates/ruff_linter/src/rules/pylint/rules/comparison_with_itself.rs index 2984fb6d9beb7..24538dcd51659 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/comparison_with_itself.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/comparison_with_itself.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use crate::fix::snippet::SourceCodeSnippet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{CmpOp, Expr}; use ruff_text_size::Ranged; @@ -30,26 +30,25 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) -#[violation] -pub struct ComparisonWithItself { +#[derive(ViolationMetadata)] +pub(crate) struct ComparisonWithItself { actual: SourceCodeSnippet, } impl Violation for ComparisonWithItself { #[derive_message_formats] fn message(&self) -> String { - let ComparisonWithItself { actual } = self; - if let Some(actual) = actual.full_display() { + if let Some(actual) = self.actual.full_display() { format!("Name compared with itself, consider replacing `{actual}`") } else { - format!("Name compared with itself") + "Name compared with itself".to_string() } } } /// PLR0124 pub(crate) fn comparison_with_itself( - checker: &mut Checker, + checker: &Checker, left: &Expr, ops: &[CmpOp], comparators: &[Expr], @@ -68,7 +67,7 @@ pub(crate) fn comparison_with_itself( op, checker.locator().slice(right) ); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ComparisonWithItself { actual: SourceCodeSnippet::new(actual), }, @@ -116,7 +115,7 @@ pub(crate) fn comparison_with_itself( op, checker.locator().slice(right) ); - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ComparisonWithItself { actual: SourceCodeSnippet::new(actual), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/continue_in_finally.rs b/crates/ruff_linter/src/rules/pylint/rules/continue_in_finally.rs index e1b2ef94be44c..67637df202c6a 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/continue_in_finally.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/continue_in_finally.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -36,22 +36,20 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `target-version` -#[violation] -pub struct ContinueInFinally; +#[derive(ViolationMetadata)] +pub(crate) struct ContinueInFinally; impl Violation for ContinueInFinally { #[derive_message_formats] fn message(&self) -> String { - format!("`continue` not supported inside `finally` clause") + "`continue` not supported inside `finally` clause".to_string() } } -fn traverse_body(checker: &mut Checker, body: &[Stmt]) { +fn traverse_body(checker: &Checker, body: &[Stmt]) { for stmt in body { if stmt.is_continue_stmt() { - checker - .diagnostics - .push(Diagnostic::new(ContinueInFinally, stmt.range())); + checker.report_diagnostic(Diagnostic::new(ContinueInFinally, stmt.range())); } match stmt { @@ -86,6 +84,6 @@ fn traverse_body(checker: &mut Checker, body: &[Stmt]) { } /// PLE0116 -pub(crate) fn continue_in_finally(checker: &mut Checker, body: &[Stmt]) { +pub(crate) fn continue_in_finally(checker: &Checker, body: &[Stmt]) { traverse_body(checker, body); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/dict_index_missing_items.rs b/crates/ruff_linter/src/rules/pylint/rules/dict_index_missing_items.rs index bdedf21f58c54..0f6eb1150eba5 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/dict_index_missing_items.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/dict_index_missing_items.rs @@ -1,14 +1,13 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::{ - self as ast, + self as ast, Expr, ExprContext, visitor::{self, Visitor}, - Expr, ExprContext, }; +use ruff_python_semantic::SemanticModel; use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; use ruff_python_semantic::analyze::typing::is_dict; -use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -47,18 +46,18 @@ use crate::checkers::ast::Checker; /// print(f"{instrument}: {section}") /// ``` -#[violation] -pub struct DictIndexMissingItems; +#[derive(ViolationMetadata)] +pub(crate) struct DictIndexMissingItems; impl Violation for DictIndexMissingItems { #[derive_message_formats] fn message(&self) -> String { - format!("Extracting value from dictionary without calling `.items()`") + "Extracting value from dictionary without calling `.items()`".to_string() } } /// PLC0206 -pub(crate) fn dict_index_missing_items(checker: &mut Checker, stmt_for: &ast::StmtFor) { +pub(crate) fn dict_index_missing_items(checker: &Checker, stmt_for: &ast::StmtFor) { let ast::StmtFor { target, iter, body, .. } = stmt_for; @@ -88,7 +87,7 @@ pub(crate) fn dict_index_missing_items(checker: &mut Checker, stmt_for: &ast::St if has_violation { let diagnostic = Diagnostic::new(DictIndexMissingItems, stmt_for.range()); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/dict_iter_missing_items.rs b/crates/ruff_linter/src/rules/pylint/rules/dict_iter_missing_items.rs index 1fa2fe15d938b..ce1deda04205b 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/dict_iter_missing_items.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/dict_iter_missing_items.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, Stmt}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::typing::is_dict; use ruff_python_semantic::{Binding, SemanticModel}; use ruff_text_size::Ranged; @@ -33,6 +33,7 @@ use crate::checkers::ast::Checker; /// /// for city, population in data.items(): /// print(f"{city} has population {population}.") +/// ``` /// /// ## Known problems /// If the dictionary key is a tuple, e.g.: @@ -49,29 +50,29 @@ use crate::checkers::ast::Checker; /// /// ## Fix safety /// Due to the known problem with tuple keys, this fix is unsafe. -#[violation] -pub struct DictIterMissingItems; +#[derive(ViolationMetadata)] +pub(crate) struct DictIterMissingItems; impl AlwaysFixableViolation for DictIterMissingItems { #[derive_message_formats] fn message(&self) -> String { - format!("Unpacking a dictionary in iteration without calling `.items()`") + "Unpacking a dictionary in iteration without calling `.items()`".to_string() } fn fix_title(&self) -> String { - format!("Add a call to `.items()`") + "Add a call to `.items()`".to_string() } } /// PLE1141 -pub(crate) fn dict_iter_missing_items(checker: &mut Checker, target: &Expr, iter: &Expr) { +pub(crate) fn dict_iter_missing_items(checker: &Checker, target: &Expr, iter: &Expr) { let Expr::Tuple(tuple) = target else { return; }; if tuple.len() != 2 { return; - }; + } let Expr::Name(name) = iter else { return; @@ -98,7 +99,7 @@ pub(crate) fn dict_iter_missing_items(checker: &mut Checker, target: &Expr, iter format!("{}.items()", name.id), iter.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns true if the binding is a dictionary where each key is a tuple with two elements. diff --git a/crates/ruff_linter/src/rules/pylint/rules/duplicate_bases.rs b/crates/ruff_linter/src/rules/pylint/rules/duplicate_bases.rs index 506f53b9d5209..22f456723eba9 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/duplicate_bases.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/duplicate_bases.rs @@ -2,11 +2,11 @@ use ruff_python_ast::{self as ast, Arguments, Expr}; use rustc_hash::{FxBuildHasher, FxHashSet}; use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for duplicate base classes in class definitions. @@ -36,8 +36,8 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// /// ## References /// - [Python documentation: Class definitions](https://docs.python.org/3/reference/compound_stmts.html#class-definitions) -#[violation] -pub struct DuplicateBases { +#[derive(ViolationMetadata)] +pub(crate) struct DuplicateBases { base: String, class: String, } @@ -57,7 +57,7 @@ impl Violation for DuplicateBases { } /// PLE0241 -pub(crate) fn duplicate_bases(checker: &mut Checker, name: &str, arguments: Option<&Arguments>) { +pub(crate) fn duplicate_bases(checker: &Checker, name: &str, arguments: Option<&Arguments>) { let Some(arguments) = arguments else { return; }; @@ -83,7 +83,7 @@ pub(crate) fn duplicate_bases(checker: &mut Checker, name: &str, arguments: Opti ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/empty_comment.rs b/crates/ruff_linter/src/rules/pylint/rules/empty_comment.rs index 873d6c9096028..b47833050f2d4 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/empty_comment.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/empty_comment.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_trivia::{is_python_whitespace, CommentRanges}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_trivia::{CommentRanges, is_python_whitespace}; use ruff_source_file::LineRanges; use ruff_text_size::{TextRange, TextSize}; @@ -27,19 +27,19 @@ use crate::Locator; /// /// ## References /// - [Pylint documentation](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html) -#[violation] -pub struct EmptyComment; +#[derive(ViolationMetadata)] +pub(crate) struct EmptyComment; impl Violation for EmptyComment { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; #[derive_message_formats] fn message(&self) -> String { - format!("Line with empty comment") + "Line with empty comment".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Delete the empty comment")) + Some("Delete the empty comment".to_string()) } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/eq_without_hash.rs b/crates/ruff_linter/src/rules/pylint/rules/eq_without_hash.rs index 23c9999e8ebb1..48627534e8152 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/eq_without_hash.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/eq_without_hash.rs @@ -1,8 +1,13 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; - -use ruff_python_ast::{self as ast, Expr, Stmt}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + Expr, ExprName, Identifier, StmtAnnAssign, StmtAssign, StmtClassDef, StmtFunctionDef, +}; +use ruff_python_semantic::analyze::class::{ + ClassMemberBoundness, ClassMemberKind, any_member_declaration, +}; use ruff_text_size::Ranged; +use std::ops::BitOr; use crate::checkers::ast::Checker; @@ -11,14 +16,13 @@ use crate::checkers::ast::Checker; /// /// ## Why is this bad? /// A class that implements `__eq__` but not `__hash__` will have its hash -/// method implicitly set to `None`. This will cause the class to be -/// unhashable, will in turn cause issues when using the class as a key in a -/// dictionary or a member of a set. -/// -/// ## Known problems -/// Does not check for `__hash__` implementations in superclasses. +/// method implicitly set to `None`, regardless of if a super class defines +/// `__hash__`. This will cause the class to be unhashable, will in turn +/// cause issues when using the class as a key in a dictionary or a member +/// of a set. /// /// ## Example +/// /// ```python /// class Person: /// def __init__(self): @@ -29,6 +33,7 @@ use crate::checkers::ast::Checker; /// ``` /// /// Use instead: +/// /// ```python /// class Person: /// def __init__(self): @@ -40,58 +45,164 @@ use crate::checkers::ast::Checker; /// def __hash__(self): /// return hash(self.name) /// ``` -#[violation] -pub struct EqWithoutHash; +/// +/// This issue is particularly tricky with inheritance. Even if a parent class correctly implements +/// both `__eq__` and `__hash__`, overriding `__eq__` in a child class without also implementing +/// `__hash__` will make the child class unhashable: +/// +/// ```python +/// class Person: +/// def __init__(self): +/// self.name = "monty" +/// +/// def __eq__(self, other): +/// return isinstance(other, Person) and other.name == self.name +/// +/// def __hash__(self): +/// return hash(self.name) +/// +/// +/// class Developer(Person): +/// def __init__(self): +/// super().__init__() +/// self.language = "python" +/// +/// def __eq__(self, other): +/// return ( +/// super().__eq__(other) +/// and isinstance(other, Developer) +/// and self.language == other.language +/// ) +/// +/// +/// hash(Developer()) # TypeError: unhashable type: 'Developer' +/// ``` +/// +/// One way to fix this is to retain the implementation of `__hash__` from the parent class: +/// +/// ```python +/// class Developer(Person): +/// def __init__(self): +/// super().__init__() +/// self.language = "python" +/// +/// def __eq__(self, other): +/// return ( +/// super().__eq__(other) +/// and isinstance(other, Developer) +/// and self.language == other.language +/// ) +/// +/// __hash__ = Person.__hash__ +/// ``` +/// +/// ## References +/// - [Python documentation: `object.__hash__`](https://docs.python.org/3/reference/datamodel.html#object.__hash__) +/// - [Python glossary: hashable](https://docs.python.org/3/glossary.html#term-hashable) +#[derive(ViolationMetadata)] +pub(crate) struct EqWithoutHash; impl Violation for EqWithoutHash { #[derive_message_formats] fn message(&self) -> String { - format!("Object does not implement `__hash__` method") + "Object does not implement `__hash__` method".to_string() } } /// W1641 -pub(crate) fn object_without_hash_method( - checker: &mut Checker, - ast::StmtClassDef { name, body, .. }: &ast::StmtClassDef, -) { - if has_eq_without_hash(body) { - checker - .diagnostics - .push(Diagnostic::new(EqWithoutHash, name.range())); +pub(crate) fn object_without_hash_method(checker: &Checker, class: &StmtClassDef) { + if checker.source_type.is_stub() { + return; } + let eq_hash = EqHash::from_class(class); + if matches!( + eq_hash, + EqHash { + eq: HasMethod::Yes | HasMethod::Maybe, + hash: HasMethod::No + } + ) { + let diagnostic = Diagnostic::new(EqWithoutHash, class.name.range()); + checker.report_diagnostic(diagnostic); + } +} + +#[derive(Debug)] +struct EqHash { + hash: HasMethod, + eq: HasMethod, } -fn has_eq_without_hash(body: &[Stmt]) -> bool { - let mut has_hash = false; - let mut has_eq = false; - for statement in body { - match statement { - Stmt::Assign(ast::StmtAssign { targets, .. }) => { - let [Expr::Name(ast::ExprName { id, .. })] = targets.as_slice() else { - continue; - }; - - // Check if `__hash__` was explicitly set, as in: - // ```python - // class Class(SuperClass): - // def __eq__(self, other): - // return True - // - // __hash__ = SuperClass.__hash__ - // ``` - - if id == "__hash__" { - has_hash = true; +impl EqHash { + fn from_class(class: &StmtClassDef) -> Self { + let (mut has_eq, mut has_hash) = (HasMethod::No, HasMethod::No); + + any_member_declaration(class, &mut |declaration| { + let id = match declaration.kind() { + ClassMemberKind::Assign(StmtAssign { targets, .. }) => { + let [Expr::Name(ExprName { id, .. })] = &targets[..] else { + return false; + }; + + id } - } - Stmt::FunctionDef(ast::StmtFunctionDef { name, .. }) => match name.as_str() { - "__hash__" => has_hash = true, - "__eq__" => has_eq = true, + ClassMemberKind::AnnAssign(StmtAnnAssign { target, .. }) => { + let Expr::Name(ExprName { id, .. }) = target.as_ref() else { + return false; + }; + + id + } + ClassMemberKind::FunctionDef(StmtFunctionDef { + name: Identifier { id, .. }, + .. + }) => id.as_str(), + }; + + match id { + "__eq__" => has_eq = has_eq | declaration.boundness().into(), + "__hash__" => has_hash = has_hash | declaration.boundness().into(), _ => {} - }, - _ => {} + } + + !has_eq.is_no() && !has_hash.is_no() + }); + + Self { + eq: has_eq, + hash: has_hash, + } + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq, is_macro::Is, Default)] +enum HasMethod { + /// There is no assignment or declaration. + #[default] + No, + /// The assignment or declaration is placed directly within the class body. + Yes, + /// The assignment or declaration is placed within an intermediate block + /// (`if`/`elif`/`else`, `for`/`else`, `while`/`else`, `with`, `case`, `try`/`except`). + Maybe, +} + +impl From<ClassMemberBoundness> for HasMethod { + fn from(value: ClassMemberBoundness) -> Self { + match value { + ClassMemberBoundness::PossiblyUnbound => Self::Maybe, + ClassMemberBoundness::Bound => Self::Yes, + } + } +} + +impl BitOr<HasMethod> for HasMethod { + type Output = Self; + + fn bitor(self, rhs: Self) -> Self::Output { + match (self, rhs) { + (HasMethod::No, _) => rhs, + (_, _) => self, } } - has_eq && !has_hash } diff --git a/crates/ruff_linter/src/rules/pylint/rules/global_at_module_level.rs b/crates/ruff_linter/src/rules/pylint/rules/global_at_module_level.rs index 89d7cca946c45..0a897c16f07da 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/global_at_module_level.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/global_at_module_level.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; use ruff_text_size::Ranged; @@ -14,21 +14,19 @@ use crate::checkers::ast::Checker; /// /// At the module level, all names are global by default, so the `global` /// keyword is redundant. -#[violation] -pub struct GlobalAtModuleLevel; +#[derive(ViolationMetadata)] +pub(crate) struct GlobalAtModuleLevel; impl Violation for GlobalAtModuleLevel { #[derive_message_formats] fn message(&self) -> String { - format!("`global` at module level is redundant") + "`global` at module level is redundant".to_string() } } /// PLW0604 -pub(crate) fn global_at_module_level(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn global_at_module_level(checker: &Checker, stmt: &Stmt) { if checker.semantic().current_scope().kind.is_module() { - checker - .diagnostics - .push(Diagnostic::new(GlobalAtModuleLevel, stmt.range())); + checker.report_diagnostic(Diagnostic::new(GlobalAtModuleLevel, stmt.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/global_statement.rs b/crates/ruff_linter/src/rules/pylint/rules/global_statement.rs index c359cf4511d83..11d7d5e41efda 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/global_statement.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/global_statement.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -31,15 +31,16 @@ use crate::checkers::ast::Checker; /// /// /// def foo(): +/// var = 10 /// print(var) -/// return 10 +/// return var /// /// /// var = foo() /// print(var) /// ``` -#[violation] -pub struct GlobalStatement { +#[derive(ViolationMetadata)] +pub(crate) struct GlobalStatement { name: String, } @@ -52,9 +53,9 @@ impl Violation for GlobalStatement { } /// PLW0603 -pub(crate) fn global_statement(checker: &mut Checker, name: &str) { +pub(crate) fn global_statement(checker: &Checker, name: &str) { if let Some(range) = checker.semantic().global(name) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( GlobalStatement { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/global_variable_not_assigned.rs b/crates/ruff_linter/src/rules/pylint/rules/global_variable_not_assigned.rs index 34857086de693..3caa1476f06fb 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/global_variable_not_assigned.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/global_variable_not_assigned.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for `global` variables that are not assigned a value in the current @@ -35,8 +35,8 @@ use ruff_macros::{derive_message_formats, violation}; /// /// ## References /// - [Python documentation: The `global` statement](https://docs.python.org/3/reference/simple_stmts.html#the-global-statement) -#[violation] -pub struct GlobalVariableNotAssigned { +#[derive(ViolationMetadata)] +pub(crate) struct GlobalVariableNotAssigned { pub name: String, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/if_stmt_min_max.rs b/crates/ruff_linter/src/rules/pylint/rules/if_stmt_min_max.rs index f83280dc28912..a47be005e0319 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/if_stmt_min_max.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/if_stmt_min_max.rs @@ -1,5 +1,5 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, CmpOp, Stmt}; @@ -29,11 +29,24 @@ use crate::fix::snippet::SourceCodeSnippet; /// highest_score = max(highest_score, score) /// ``` /// +/// ## Fix safety +/// This fix is marked unsafe if it would delete any comments within the replacement range. +/// +/// An example to illustrate where comments are preserved and where they are not: +/// +/// ```py +/// a, b = 0, 10 +/// +/// if a >= b: # deleted comment +/// # deleted comment +/// a = b # preserved comment +/// ``` +/// /// ## References -/// - [Python documentation: max function](https://docs.python.org/3/library/functions.html#max) -/// - [Python documentation: min function](https://docs.python.org/3/library/functions.html#min) -#[violation] -pub struct IfStmtMinMax { +/// - [Python documentation: `max`](https://docs.python.org/3/library/functions.html#max) +/// - [Python documentation: `min`](https://docs.python.org/3/library/functions.html#min) +#[derive(ViolationMetadata)] +pub(crate) struct IfStmtMinMax { min_max: MinMax, replacement: SourceCodeSnippet, } @@ -68,7 +81,7 @@ impl Violation for IfStmtMinMax { } /// R1730, R1731 -pub(crate) fn if_stmt_min_max(checker: &mut Checker, stmt_if: &ast::StmtIf) { +pub(crate) fn if_stmt_min_max(checker: &Checker, stmt_if: &ast::StmtIf) { let ast::StmtIf { test, body, @@ -80,11 +93,13 @@ pub(crate) fn if_stmt_min_max(checker: &mut Checker, stmt_if: &ast::StmtIf) { return; } - let [body @ Stmt::Assign(ast::StmtAssign { - targets: body_targets, - value: body_value, - .. - })] = body.as_slice() + let [ + body @ Stmt::Assign(ast::StmtAssign { + targets: body_targets, + value: body_value, + .. + }), + ] = body.as_slice() else { return; }; @@ -106,52 +121,44 @@ pub(crate) fn if_stmt_min_max(checker: &mut Checker, stmt_if: &ast::StmtIf) { let [op] = &**ops else { return; }; - let [right] = &**comparators else { return; }; - let left_cmp = ComparableExpr::from(left); - let body_target_cmp = ComparableExpr::from(body_target); - let right_cmp = ComparableExpr::from(right); - let body_value_cmp = ComparableExpr::from(body_value); - - let left_is_target = left_cmp == body_target_cmp; - let right_is_target = right_cmp == body_target_cmp; - let left_is_value = left_cmp == body_value_cmp; - let right_is_value = right_cmp == body_value_cmp; - - // Determine whether to use `min()` or `max()`, and whether to flip the - // order of the arguments, which is relevant for breaking ties. - // Also ensure that we understand the operation we're trying to do, - // by checking both sides of the comparison and assignment. - let (min_max, flip_args) = match ( - left_is_target, - right_is_target, - left_is_value, - right_is_value, - ) { - (true, false, false, true) => match op { - CmpOp::Lt => (MinMax::Max, true), - CmpOp::LtE => (MinMax::Max, false), - CmpOp::Gt => (MinMax::Min, true), - CmpOp::GtE => (MinMax::Min, false), + // extract helpful info from expression of the form + // `if cmp_left op cmp_right: target = assignment_value` + let cmp_left = ComparableExpr::from(left); + let cmp_right = ComparableExpr::from(right); + let target = ComparableExpr::from(body_target); + let assignment_value = ComparableExpr::from(body_value); + + // Ex): if a < b: a = b + let (min_max, flip_args) = if cmp_left == target && cmp_right == assignment_value { + match op { + CmpOp::Lt => (MinMax::Max, false), + CmpOp::LtE => (MinMax::Max, true), + CmpOp::Gt => (MinMax::Min, false), + CmpOp::GtE => (MinMax::Min, true), _ => return, - }, - (false, true, true, false) => match op { + } + } + // Ex): `if a < b: b = a` + else if cmp_left == assignment_value && cmp_right == target { + match op { CmpOp::Lt => (MinMax::Min, true), CmpOp::LtE => (MinMax::Min, false), CmpOp::Gt => (MinMax::Max, true), CmpOp::GtE => (MinMax::Max, false), _ => return, - }, - _ => return, + } + } else { + return; }; let (arg1, arg2) = if flip_args { - (left.as_ref(), right) + (right, &**left) } else { - (right, left.as_ref()) + (&**left, right) }; let replacement = format!( @@ -177,14 +184,21 @@ pub(crate) fn if_stmt_min_max(checker: &mut Checker, stmt_if: &ast::StmtIf) { stmt_if.range(), ); + let range_replacement = stmt_if.range(); + let applicability = if checker.comment_ranges().intersects(range_replacement) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + if checker.semantic().has_builtin_binding(min_max.as_str()) { - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - replacement, - stmt_if.range(), - ))); + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement(replacement, range_replacement), + applicability, + )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/pylint/rules/import_outside_top_level.rs b/crates/ruff_linter/src/rules/pylint/rules/import_outside_top_level.rs index 3cfcdd128b048..a5dbffb4204da 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/import_outside_top_level.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/import_outside_top_level.rs @@ -1,9 +1,12 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; +use crate::rules::flake8_tidy_imports::rules::BannedModuleImportPolicies; +use crate::{ + checkers::ast::Checker, codes::Rule, rules::flake8_tidy_imports::matchers::NameMatchPolicy, +}; /// ## What it does /// Checks for `import` statements outside of a module's top-level scope, such @@ -42,21 +45,55 @@ use crate::checkers::ast::Checker; /// ``` /// /// [PEP 8]: https://peps.python.org/pep-0008/#imports -#[violation] -pub struct ImportOutsideTopLevel; +#[derive(ViolationMetadata)] +pub(crate) struct ImportOutsideTopLevel; impl Violation for ImportOutsideTopLevel { #[derive_message_formats] fn message(&self) -> String { - format!("`import` should be at the top-level of a file") + "`import` should be at the top-level of a file".to_string() } } /// C0415 -pub(crate) fn import_outside_top_level(checker: &mut Checker, stmt: &Stmt) { - if !checker.semantic().current_scope().kind.is_module() { - checker - .diagnostics - .push(Diagnostic::new(ImportOutsideTopLevel, stmt.range())); +pub(crate) fn import_outside_top_level(checker: &Checker, stmt: &Stmt) { + if checker.semantic().current_scope().kind.is_module() { + // "Top-level" imports are allowed + return; } + + // Check if any of the non-top-level imports are banned by TID253 + // before emitting the diagnostic to avoid conflicts. + if checker.enabled(Rule::BannedModuleLevelImports) { + let mut all_aliases_banned = true; + let mut has_alias = false; + for (policy, node) in &BannedModuleImportPolicies::new(stmt, checker) { + if node.is_alias() { + has_alias = true; + all_aliases_banned &= is_banned_module_level_import(&policy, checker); + } + // If the entire import is banned + else if is_banned_module_level_import(&policy, checker) { + return; + } + } + + if has_alias && all_aliases_banned { + return; + } + } + + // Emit the diagnostic + checker.report_diagnostic(Diagnostic::new(ImportOutsideTopLevel, stmt.range())); +} + +fn is_banned_module_level_import(policy: &NameMatchPolicy, checker: &Checker) -> bool { + policy + .find( + checker + .settings + .flake8_tidy_imports + .banned_module_level_imports(), + ) + .is_some() } diff --git a/crates/ruff_linter/src/rules/pylint/rules/import_private_name.rs b/crates/ruff_linter/src/rules/pylint/rules/import_private_name.rs index 1081530d0a9ff..b465fdd54b4fe 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/import_private_name.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/import_private_name.rs @@ -3,12 +3,13 @@ use std::borrow::Cow; use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; use ruff_python_semantic::{FromImport, Import, Imported, ResolvedReference, Scope}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; +use crate::package::PackageRoot; /// ## What it does /// Checks for import statements that import a private name (a name starting @@ -46,10 +47,10 @@ use crate::checkers::ast::Checker; /// - [PEP 8: Naming Conventions](https://peps.python.org/pep-0008/#naming-conventions) /// - [Semantic Versioning](https://semver.org/) /// -/// [PEP 8]: https://www.python.org/dev/peps/pep-0008/ -/// [PEP 420]: https://www.python.org/dev/peps/pep-0420/ -#[violation] -pub struct ImportPrivateName { +/// [PEP 8]: https://peps.python.org/pep-0008/ +/// [PEP 420]: https://peps.python.org/pep-0420/ +#[derive(ViolationMetadata)] +pub(crate) struct ImportPrivateName { name: String, module: Option<String>, } @@ -68,11 +69,7 @@ impl Violation for ImportPrivateName { } /// PLC2701 -pub(crate) fn import_private_name( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn import_private_name(checker: &Checker, scope: &Scope) { for binding_id in scope.binding_ids() { let binding = checker.semantic().binding(binding_id); let Some(import) = binding.as_any_import() else { @@ -106,6 +103,7 @@ pub(crate) fn import_private_name( // Ex) `from foo import _bar` within `foo/baz.py` if checker .package() + .map(PackageRoot::path) .is_some_and(|path| path.ends_with(root_module)) { continue; @@ -138,7 +136,7 @@ pub(crate) fn import_private_name( } else { None }; - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( ImportPrivateName { name, module }, binding.range(), )); @@ -149,12 +147,11 @@ pub(crate) fn import_private_name( fn is_typing(reference: &ResolvedReference) -> bool { reference.in_type_checking_block() || reference.in_typing_only_annotation() - || reference.in_complex_string_type_definition() - || reference.in_simple_string_type_definition() + || reference.in_string_type_definition() || reference.in_runtime_evaluated_annotation() } -#[allow(clippy::struct_field_names)] +#[expect(clippy::struct_field_names)] struct ImportInfo<'a> { module_name: &'a [&'a str], member_name: Cow<'a, str>, diff --git a/crates/ruff_linter/src/rules/pylint/rules/import_self.rs b/crates/ruff_linter/src/rules/pylint/rules/import_self.rs index 072285eabf690..c20b16c20c64d 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/import_self.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/import_self.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Alias; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::resolve_imported_module_path; use ruff_text_size::Ranged; @@ -9,7 +9,8 @@ use ruff_text_size::Ranged; /// Checks for import statements that import the current module. /// /// ## Why is this bad? -/// Importing a module from itself is a circular dependency. +/// Importing a module from itself is a circular dependency and results +/// in an `ImportError` exception. /// /// ## Example /// @@ -20,8 +21,8 @@ use ruff_text_size::Ranged; /// /// def foo(): ... /// ``` -#[violation] -pub struct ImportSelf { +#[derive(ViolationMetadata)] +pub(crate) struct ImportSelf { name: String, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_all_format.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_all_format.rs index cd258c35e94a0..a5a364f8ac381 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_all_format.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_all_format.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Binding; use ruff_text_size::Ranged; @@ -25,13 +25,13 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Python documentation: The `import` statement](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement) -#[violation] -pub struct InvalidAllFormat; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidAllFormat; impl Violation for InvalidAllFormat { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid format for `__all__`, must be `tuple` or `list`") + "Invalid format for `__all__`, must be `tuple` or `list`".to_string() } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_all_object.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_all_object.rs index ce3be45884125..40536e2602986 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_all_object.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_all_object.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Binding; use ruff_text_size::Ranged; @@ -25,13 +25,13 @@ use ruff_text_size::Ranged; /// /// ## References /// - [Python documentation: The `import` statement](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement) -#[violation] -pub struct InvalidAllObject; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidAllObject; impl Violation for InvalidAllObject { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid object in `__all__`, must contain only strings") + "Invalid object in `__all__`, must contain only strings".to_string() } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_bool_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_bool_return.rs index d85365eb18049..4f0d0442eb5fc 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_bool_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_bool_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -34,18 +34,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__bool__` method](https://docs.python.org/3/reference/datamodel.html#object.__bool__) -#[violation] -pub struct InvalidBoolReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidBoolReturnType; impl Violation for InvalidBoolReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__bool__` does not return `bool`") + "`__bool__` does not return `bool`".to_string() } } /// PLE0304 -pub(crate) fn invalid_bool_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_bool_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__bool__" { return; } @@ -68,7 +68,7 @@ pub(crate) fn invalid_bool_return(checker: &mut Checker, function_def: &ast::Stm // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidBoolReturnType, function_def.identifier(), )); @@ -88,15 +88,11 @@ pub(crate) fn invalid_bool_return(checker: &mut Checker, function_def: &ast::Stm ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::Number(NumberLike::Bool)) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidBoolReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidBoolReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidBoolReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidBoolReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_bytes_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_bytes_return.rs index 8287fbb16f086..deb5d58cdc187 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_bytes_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_bytes_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -34,18 +34,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__bytes__` method](https://docs.python.org/3/reference/datamodel.html#object.__bytes__) -#[violation] -pub struct InvalidBytesReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidBytesReturnType; impl Violation for InvalidBytesReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__bytes__` does not return `bytes`") + "`__bytes__` does not return `bytes`".to_string() } } /// PLE0308 -pub(crate) fn invalid_bytes_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_bytes_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__bytes__" { return; } @@ -68,7 +68,7 @@ pub(crate) fn invalid_bytes_return(checker: &mut Checker, function_def: &ast::St // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidBytesReturnType, function_def.identifier(), )); @@ -87,15 +87,11 @@ pub(crate) fn invalid_bytes_return(checker: &mut Checker, function_def: &ast::St ResolvedPythonType::from(value), ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::Bytes) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidBytesReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidBytesReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidBytesReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidBytesReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_default.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_default.rs index 1378162b9cf57..a6984b817ff82 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_default.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_default.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; use ruff_python_semantic::Modules; +use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -32,18 +32,18 @@ use crate::checkers::ast::Checker; /// /// int(os.getenv("FOO", "1")) /// ``` -#[violation] -pub struct InvalidEnvvarDefault; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidEnvvarDefault; impl Violation for InvalidEnvvarDefault { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid type for environment variable default; expected `str` or `None`") + "Invalid type for environment variable default; expected `str` or `None`".to_string() } } /// PLW1508 -pub(crate) fn invalid_envvar_default(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn invalid_envvar_default(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::OS) { return; } @@ -51,10 +51,15 @@ pub(crate) fn invalid_envvar_default(checker: &mut Checker, call: &ast::ExprCall if checker .semantic() .resolve_qualified_name(&call.func) - .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["os", "getenv"])) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["os", "getenv"] | ["os", "environ", "get"] + ) + }) { // Find the `default` argument, if it exists. - let Some(expr) = call.arguments.find_argument("default", 1) else { + let Some(expr) = call.arguments.find_argument_value("default", 1) else { return; }; @@ -65,8 +70,6 @@ pub(crate) fn invalid_envvar_default(checker: &mut Checker, call: &ast::ExprCall ) { return; } - checker - .diagnostics - .push(Diagnostic::new(InvalidEnvvarDefault, expr.range())); + checker.report_diagnostic(Diagnostic::new(InvalidEnvvarDefault, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_value.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_value.rs index d174137bbc667..68d2999270442 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_value.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_value.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; use ruff_python_semantic::Modules; +use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -25,18 +25,18 @@ use crate::checkers::ast::Checker; /// ```python /// os.getenv("1") /// ``` -#[violation] -pub struct InvalidEnvvarValue; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidEnvvarValue; impl Violation for InvalidEnvvarValue { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid type for initial `os.getenv` argument; expected `str`") + "Invalid type for initial `os.getenv` argument; expected `str`".to_string() } } /// PLE1507 -pub(crate) fn invalid_envvar_value(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn invalid_envvar_value(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::OS) { return; } @@ -47,7 +47,7 @@ pub(crate) fn invalid_envvar_value(checker: &mut Checker, call: &ast::ExprCall) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["os", "getenv"])) { // Find the `key` argument, if it exists. - let Some(expr) = call.arguments.find_argument("key", 0) else { + let Some(expr) = call.arguments.find_argument_value("key", 0) else { return; }; @@ -58,8 +58,6 @@ pub(crate) fn invalid_envvar_value(checker: &mut Checker, call: &ast::ExprCall) return; } - checker - .diagnostics - .push(Diagnostic::new(InvalidEnvvarValue, expr.range())); + checker.report_diagnostic(Diagnostic::new(InvalidEnvvarValue, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_hash_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_hash_return.rs index 187ec300c5e27..89fff4d2bbd06 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_hash_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_hash_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -38,18 +38,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__hash__` method](https://docs.python.org/3/reference/datamodel.html#object.__hash__) -#[violation] -pub struct InvalidHashReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidHashReturnType; impl Violation for InvalidHashReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__hash__` does not return an integer") + "`__hash__` does not return an integer".to_string() } } /// E0309 -pub(crate) fn invalid_hash_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_hash_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__hash__" { return; } @@ -72,7 +72,7 @@ pub(crate) fn invalid_hash_return(checker: &mut Checker, function_def: &ast::Stm // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidHashReturnType, function_def.identifier(), )); @@ -92,15 +92,11 @@ pub(crate) fn invalid_hash_return(checker: &mut Checker, function_def: &ast::Stm ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidHashReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidHashReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidHashReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidHashReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_index_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_index_return.rs index eea1bafa770dd..cd3f64a16b0b8 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_index_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_index_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -19,7 +19,7 @@ use crate::checkers::ast::Checker; /// type may cause unexpected behavior. /// /// Note: `bool` is a subclass of `int`, so it's technically valid for `__index__` to -/// return `True` or `False`. However, a DeprecationWarning (`DeprecationWarning: +/// return `True` or `False`. However, a `DeprecationWarning` (`DeprecationWarning: /// __index__ returned non-int (type bool)`) for such cases was already introduced, /// thus this is a conscious difference between the original pylint rule and the /// current ruff implementation. @@ -40,18 +40,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__index__` method](https://docs.python.org/3/reference/datamodel.html#object.__index__) -#[violation] -pub struct InvalidIndexReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidIndexReturnType; impl Violation for InvalidIndexReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__index__` does not return an integer") + "`__index__` does not return an integer".to_string() } } /// E0305 -pub(crate) fn invalid_index_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_index_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__index__" { return; } @@ -74,7 +74,7 @@ pub(crate) fn invalid_index_return(checker: &mut Checker, function_def: &ast::St // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidIndexReturnType, function_def.identifier(), )); @@ -94,15 +94,11 @@ pub(crate) fn invalid_index_return(checker: &mut Checker, function_def: &ast::St ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidIndexReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidIndexReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidIndexReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidIndexReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_length_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_length_return.rs index 6b8b21f477136..bfe11d45e6efc 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_length_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_length_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -39,18 +39,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__len__` method](https://docs.python.org/3/reference/datamodel.html#object.__len__) -#[violation] -pub struct InvalidLengthReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidLengthReturnType; impl Violation for InvalidLengthReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__len__` does not return a non-negative integer") + "`__len__` does not return a non-negative integer".to_string() } } /// E0303 -pub(crate) fn invalid_length_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_length_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__len__" { return; } @@ -73,7 +73,7 @@ pub(crate) fn invalid_length_return(checker: &mut Checker, function_def: &ast::S // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidLengthReturnType, function_def.identifier(), )); @@ -95,15 +95,11 @@ pub(crate) fn invalid_length_return(checker: &mut Checker, function_def: &ast::S | ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidLengthReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidLengthReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidLengthReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidLengthReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_str_return.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_str_return.rs index 2614b40dbbf65..5e07f2bfd702a 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_str_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_str_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -34,18 +34,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `__str__` method](https://docs.python.org/3/reference/datamodel.html#object.__str__) -#[violation] -pub struct InvalidStrReturnType; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidStrReturnType; impl Violation for InvalidStrReturnType { #[derive_message_formats] fn message(&self) -> String { - format!("`__str__` does not return `str`") + "`__str__` does not return `str`".to_string() } } /// E0307 -pub(crate) fn invalid_str_return(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn invalid_str_return(checker: &Checker, function_def: &ast::StmtFunctionDef) { if function_def.name.as_str() != "__str__" { return; } @@ -68,7 +68,7 @@ pub(crate) fn invalid_str_return(checker: &mut Checker, function_def: &ast::Stmt // If there are no return statements, add a diagnostic. if terminal == Terminal::Implicit { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidStrReturnType, function_def.identifier(), )); @@ -87,15 +87,11 @@ pub(crate) fn invalid_str_return(checker: &mut Checker, function_def: &ast::Stmt ResolvedPythonType::from(value), ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::String) ) { - checker - .diagnostics - .push(Diagnostic::new(InvalidStrReturnType, value.range())); + checker.report_diagnostic(Diagnostic::new(InvalidStrReturnType, value.range())); } } else { // Disallow implicit `None`. - checker - .diagnostics - .push(Diagnostic::new(InvalidStrReturnType, stmt.range())); + checker.report_diagnostic(Diagnostic::new(InvalidStrReturnType, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/invalid_string_characters.rs b/crates/ruff_linter/src/rules/pylint/rules/invalid_string_characters.rs index 621eb028c74cb..f2753483994bc 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/invalid_string_characters.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/invalid_string_characters.rs @@ -1,9 +1,7 @@ -use ruff_diagnostics::AlwaysFixableViolation; -use ruff_diagnostics::Edit; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_parser::TokenKind; -use ruff_text_size::{TextLen, TextRange, TextSize}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_parser::{Token, TokenKind}; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; use crate::Locator; @@ -26,17 +24,19 @@ use crate::Locator; /// ```python /// x = "\b" /// ``` -#[violation] -pub struct InvalidCharacterBackspace; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidCharacterBackspace; + +impl Violation for InvalidCharacterBackspace { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for InvalidCharacterBackspace { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid unescaped character backspace, use \"\\b\" instead") + "Invalid unescaped character backspace, use \"\\b\" instead".to_string() } - fn fix_title(&self) -> String { - "Replace with escape sequence".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with escape sequence".to_string()) } } @@ -59,17 +59,19 @@ impl AlwaysFixableViolation for InvalidCharacterBackspace { /// ```python /// x = "\x1a" /// ``` -#[violation] -pub struct InvalidCharacterSub; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidCharacterSub; + +impl Violation for InvalidCharacterSub { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for InvalidCharacterSub { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid unescaped character SUB, use \"\\x1A\" instead") + "Invalid unescaped character SUB, use \"\\x1A\" instead".to_string() } - fn fix_title(&self) -> String { - "Replace with escape sequence".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with escape sequence".to_string()) } } @@ -92,17 +94,19 @@ impl AlwaysFixableViolation for InvalidCharacterSub { /// ```python /// x = "\x1b" /// ``` -#[violation] -pub struct InvalidCharacterEsc; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidCharacterEsc; + +impl Violation for InvalidCharacterEsc { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for InvalidCharacterEsc { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid unescaped character ESC, use \"\\x1B\" instead") + "Invalid unescaped character ESC, use \"\\x1B\" instead".to_string() } - fn fix_title(&self) -> String { - "Replace with escape sequence".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with escape sequence".to_string()) } } @@ -125,17 +129,19 @@ impl AlwaysFixableViolation for InvalidCharacterEsc { /// ```python /// x = "\0" /// ``` -#[violation] -pub struct InvalidCharacterNul; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidCharacterNul; + +impl Violation for InvalidCharacterNul { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for InvalidCharacterNul { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid unescaped character NUL, use \"\\0\" instead") + "Invalid unescaped character NUL, use \"\\0\" instead".to_string() } - fn fix_title(&self) -> String { - "Replace with escape sequence".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with escape sequence".to_string()) } } @@ -157,52 +163,58 @@ impl AlwaysFixableViolation for InvalidCharacterNul { /// ```python /// x = "Dear Sir\u200b/\u200bMadam" # zero width space /// ``` -#[violation] -pub struct InvalidCharacterZeroWidthSpace; +#[derive(ViolationMetadata)] +pub(crate) struct InvalidCharacterZeroWidthSpace; + +impl Violation for InvalidCharacterZeroWidthSpace { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for InvalidCharacterZeroWidthSpace { #[derive_message_formats] fn message(&self) -> String { - format!("Invalid unescaped character zero-width-space, use \"\\u200B\" instead") + "Invalid unescaped character zero-width-space, use \"\\u200B\" instead".to_string() } - fn fix_title(&self) -> String { - "Replace with escape sequence".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with escape sequence".to_string()) } } /// PLE2510, PLE2512, PLE2513, PLE2514, PLE2515 pub(crate) fn invalid_string_characters( diagnostics: &mut Vec<Diagnostic>, - token: TokenKind, - range: TextRange, + token: &Token, locator: &Locator, ) { - let text = match token { + let text = match token.kind() { // We can't use the `value` field since it's decoded and e.g. for f-strings removed a curly // brace that escaped another curly brace, which would gives us wrong column information. - TokenKind::String | TokenKind::FStringMiddle => locator.slice(range), + TokenKind::String | TokenKind::FStringMiddle => locator.slice(token), _ => return, }; for (column, match_) in text.match_indices(&['\x08', '\x1A', '\x1B', '\0', '\u{200b}']) { + let location = token.start() + TextSize::try_from(column).unwrap(); let c = match_.chars().next().unwrap(); - let (replacement, rule): (&str, DiagnosticKind) = match c { - '\x08' => ("\\b", InvalidCharacterBackspace.into()), - '\x1A' => ("\\x1A", InvalidCharacterSub.into()), - '\x1B' => ("\\x1B", InvalidCharacterEsc.into()), - '\0' => ("\\0", InvalidCharacterNul.into()), - '\u{200b}' => ("\\u200b", InvalidCharacterZeroWidthSpace.into()), + let range = TextRange::at(location, c.text_len()); + let (replacement, mut diagnostic) = match c { + '\x08' => ("\\b", Diagnostic::new(InvalidCharacterBackspace, range)), + '\x1A' => ("\\x1A", Diagnostic::new(InvalidCharacterSub, range)), + '\x1B' => ("\\x1B", Diagnostic::new(InvalidCharacterEsc, range)), + '\0' => ("\\0", Diagnostic::new(InvalidCharacterNul, range)), + '\u{200b}' => ( + "\\u200b", + Diagnostic::new(InvalidCharacterZeroWidthSpace, range), + ), _ => { continue; } }; - let location = range.start() + TextSize::try_from(column).unwrap(); - let range = TextRange::at(location, c.text_len()); + if !token.unwrap_string_flags().is_raw_string() { + let edit = Edit::range_replacement(replacement.to_string(), range); + diagnostic.set_fix(Fix::safe_edit(edit)); + } - diagnostics.push(Diagnostic::new(rule, range).with_fix(Fix::safe_edit( - Edit::range_replacement(replacement.to_string(), range), - ))); + diagnostics.push(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/iteration_over_set.rs b/crates/ruff_linter/src/rules/pylint/rules/iteration_over_set.rs index 0abc2d89b0e5a..f3511e25b1bdb 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/iteration_over_set.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/iteration_over_set.rs @@ -1,8 +1,10 @@ +use rustc_hash::{FxBuildHasher, FxHashSet}; + use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{comparable::ComparableExpr, Expr}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Expr; +use ruff_python_ast::comparable::HashableExpr; use ruff_text_size::Ranged; -use rustc_hash::{FxBuildHasher, FxHashSet}; use crate::checkers::ast::Checker; @@ -28,22 +30,22 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `set`](https://docs.python.org/3/library/stdtypes.html#set) -#[violation] -pub struct IterationOverSet; +#[derive(ViolationMetadata)] +pub(crate) struct IterationOverSet; impl AlwaysFixableViolation for IterationOverSet { #[derive_message_formats] fn message(&self) -> String { - format!("Use a sequence type instead of a `set` when iterating over values") + "Use a sequence type instead of a `set` when iterating over values".to_string() } fn fix_title(&self) -> String { - format!("Convert to `tuple`") + "Convert to `tuple`".to_string() } } /// PLC0208 -pub(crate) fn iteration_over_set(checker: &mut Checker, expr: &Expr) { +pub(crate) fn iteration_over_set(checker: &Checker, expr: &Expr) { let Expr::Set(set) = expr else { return; }; @@ -54,8 +56,7 @@ pub(crate) fn iteration_over_set(checker: &mut Checker, expr: &Expr) { let mut seen_values = FxHashSet::with_capacity_and_hasher(set.len(), FxBuildHasher); for value in set { - let comparable_value = ComparableExpr::from(value); - if !seen_values.insert(comparable_value) { + if !seen_values.insert(HashableExpr::from(value)) { // if the set contains a duplicate literal value, early exit. // rule `B033` can catch that. return; @@ -73,5 +74,5 @@ pub(crate) fn iteration_over_set(checker: &mut Checker, expr: &Expr) { }; diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(tuple, expr.range()))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/len_test.rs b/crates/ruff_linter/src/rules/pylint/rules/len_test.rs new file mode 100644 index 0000000000000..9aaa1177deb95 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/rules/len_test.rs @@ -0,0 +1,193 @@ +use crate::checkers::ast::Checker; +use crate::fix::snippet::SourceCodeSnippet; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, ExprCall}; +use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; +use ruff_python_semantic::analyze::typing::find_binding_value; +use ruff_python_semantic::{BindingId, SemanticModel}; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for `len` calls on sequences in a boolean test context. +/// +/// ## Why is this bad? +/// Empty sequences are considered false in a boolean context. +/// You can either remove the call to `len` +/// or compare the length against a scalar. +/// +/// ## Example +/// ```python +/// fruits = ["orange", "apple"] +/// vegetables = [] +/// +/// if len(fruits): +/// print(fruits) +/// +/// if not len(vegetables): +/// print(vegetables) +/// ``` +/// +/// Use instead: +/// ```python +/// fruits = ["orange", "apple"] +/// vegetables = [] +/// +/// if fruits: +/// print(fruits) +/// +/// if not vegetables: +/// print(vegetables) +/// ``` +/// +/// ## References +/// [PEP 8: Programming Recommendations](https://peps.python.org/pep-0008/#programming-recommendations) +#[derive(ViolationMetadata)] +pub(crate) struct LenTest { + expression: SourceCodeSnippet, +} + +impl AlwaysFixableViolation for LenTest { + #[derive_message_formats] + fn message(&self) -> String { + if let Some(expression) = self.expression.full_display() { + format!("`len({expression})` used as condition without comparison") + } else { + "`len(SEQUENCE)` used as condition without comparison".to_string() + } + } + + fn fix_title(&self) -> String { + "Remove `len`".to_string() + } +} + +/// PLC1802 +pub(crate) fn len_test(checker: &Checker, call: &ExprCall) { + let ExprCall { + func, arguments, .. + } = call; + let semantic = checker.semantic(); + + if !semantic.in_boolean_test() { + return; + } + + if !semantic.match_builtin_expr(func, "len") { + return; + } + + // Single argument and no keyword arguments + let [argument] = &*arguments.args else { return }; + if !arguments.keywords.is_empty() { + return; + } + + // Simple inferred sequence type (e.g., list, set, dict, tuple, string, bytes, varargs, kwargs). + if !is_sequence(argument, semantic) && !is_indirect_sequence(argument, semantic) { + return; + } + + let replacement = checker.locator().slice(argument.range()).to_string(); + + checker.report_diagnostic( + Diagnostic::new( + LenTest { + expression: SourceCodeSnippet::new(replacement.clone()), + }, + call.range(), + ) + .with_fix(Fix::safe_edit(Edit::range_replacement( + replacement, + call.range(), + ))), + ); +} + +fn is_indirect_sequence(expr: &Expr, semantic: &SemanticModel) -> bool { + let Expr::Name(ast::ExprName { id: name, .. }) = expr else { + return false; + }; + + let scope = semantic.current_scope(); + let bindings: Vec<BindingId> = scope.get_all(name).collect(); + let [binding_id] = bindings.as_slice() else { + return false; + }; + + let binding = semantic.binding(*binding_id); + + // Attempt to find the binding's value + let Some(binding_value) = find_binding_value(binding, semantic) else { + // If the binding is not an argument, return false + if !binding.kind.is_argument() { + return false; + } + + // Attempt to retrieve the function definition statement + let Some(function) = binding + .statement(semantic) + .and_then(|statement| statement.as_function_def_stmt()) + else { + return false; + }; + + // If not find in non-default params, it must be varargs or kwargs + return function.parameters.find(name).is_none(); + }; + + // If `binding_value` is found, check if it is a sequence + is_sequence(binding_value, semantic) +} + +fn is_sequence(expr: &Expr, semantic: &SemanticModel) -> bool { + // Check if the expression type is a direct sequence match (dict, list, set, tuple, string or bytes) + if matches!( + ResolvedPythonType::from(expr), + ResolvedPythonType::Atom( + PythonType::Dict + | PythonType::List + | PythonType::Set + | PythonType::Tuple + | PythonType::String + | PythonType::Bytes + ) + ) { + return true; + } + + // Check if the expression is a function call to a built-in sequence constructor + let Some(ExprCall { func, .. }) = expr.as_call_expr() else { + return false; + }; + + // Match against specific built-in constructors that return sequences + semantic.resolve_builtin_symbol(func).is_some_and(|func| { + matches!( + func, + "chr" + | "format" + | "input" + | "repr" + | "str" + | "list" + | "dir" + | "locals" + | "globals" + | "vars" + | "dict" + | "set" + | "frozenset" + | "tuple" + | "range" + | "bin" + | "bytes" + | "bytearray" + | "hex" + | "memoryview" + | "oct" + | "ascii" + | "sorted" + ) + }) +} diff --git a/crates/ruff_linter/src/rules/pylint/rules/literal_membership.rs b/crates/ruff_linter/src/rules/pylint/rules/literal_membership.rs index 7d0031ab06548..10777dbd12950 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/literal_membership.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/literal_membership.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; @@ -31,22 +31,22 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [What’s New In Python 3.2](https://docs.python.org/3/whatsnew/3.2.html#optimizations) -#[violation] -pub struct LiteralMembership; +#[derive(ViolationMetadata)] +pub(crate) struct LiteralMembership; impl AlwaysFixableViolation for LiteralMembership { #[derive_message_formats] fn message(&self) -> String { - format!("Use a set literal when testing for membership") + "Use a set literal when testing for membership".to_string() } fn fix_title(&self) -> String { - format!("Convert to `set`") + "Convert to `set`".to_string() } } /// PLR6201 -pub(crate) fn literal_membership(checker: &mut Checker, compare: &ast::ExprCompare) { +pub(crate) fn literal_membership(checker: &Checker, compare: &ast::ExprCompare) { let [op] = &*compare.ops else { return; }; @@ -65,6 +65,11 @@ pub(crate) fn literal_membership(checker: &mut Checker, compare: &ast::ExprCompa _ => return, }; + // Skip empty collections (#15729). + if elts.is_empty() { + return; + } + // If `left`, or any of the elements in `right`, are known to _not_ be hashable, return. if std::iter::once(compare.left.as_ref()) .chain(elts) @@ -105,5 +110,5 @@ pub(crate) fn literal_membership(checker: &mut Checker, compare: &ast::ExprCompa right.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/load_before_global_declaration.rs b/crates/ruff_linter/src/rules/pylint/rules/load_before_global_declaration.rs index 3545bf6a8674c..7041ae8875609 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/load_before_global_declaration.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/load_before_global_declaration.rs @@ -1,11 +1,6 @@ -use ruff_python_ast::Expr; - -use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::Violation; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_source_file::SourceRow; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; /// ## What it does /// Checks for uses of names that are declared as `global` prior to the @@ -14,7 +9,7 @@ use crate::checkers::ast::Checker; /// ## Why is this bad? /// The `global` declaration applies to the entire scope. Using a name that's /// declared as `global` in a given scope prior to the relevant `global` -/// declaration is a syntax error. +/// declaration is a `SyntaxError`. /// /// ## Example /// ```python @@ -40,10 +35,10 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: The `global` statement](https://docs.python.org/3/reference/simple_stmts.html#the-global-statement) -#[violation] -pub struct LoadBeforeGlobalDeclaration { - name: String, - row: SourceRow, +#[derive(ViolationMetadata)] +pub(crate) struct LoadBeforeGlobalDeclaration { + pub(crate) name: String, + pub(crate) row: SourceRow, } impl Violation for LoadBeforeGlobalDeclaration { @@ -53,18 +48,3 @@ impl Violation for LoadBeforeGlobalDeclaration { format!("Name `{name}` is used prior to global declaration on {row}") } } - -/// PLE0118 -pub(crate) fn load_before_global_declaration(checker: &mut Checker, name: &str, expr: &Expr) { - if let Some(stmt) = checker.semantic().global(name) { - if expr.start() < stmt.start() { - checker.diagnostics.push(Diagnostic::new( - LoadBeforeGlobalDeclaration { - name: name.to_string(), - row: checker.compute_source_row(stmt.start()), - }, - expr.range(), - )); - } - } -} diff --git a/crates/ruff_linter/src/rules/pylint/rules/logging.rs b/crates/ruff_linter/src/rules/pylint/rules/logging.rs index 36ad2af0fd551..80ba1fdddd564 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/logging.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/logging.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::analyze::logging; use ruff_python_stdlib::logging::LoggingLevel; @@ -36,13 +36,13 @@ use crate::rules::pyflakes::cformat::CFormatSummary; /// logging.error("%s error occurred: %s", type(e), e) /// raise /// ``` -#[violation] -pub struct LoggingTooFewArgs; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingTooFewArgs; impl Violation for LoggingTooFewArgs { #[derive_message_formats] fn message(&self) -> String { - format!("Not enough arguments for `logging` format string") + "Not enough arguments for `logging` format string".to_string() } } @@ -73,19 +73,19 @@ impl Violation for LoggingTooFewArgs { /// logging.error("%s error occurred: %s", type(e), e) /// raise /// ``` -#[violation] -pub struct LoggingTooManyArgs; +#[derive(ViolationMetadata)] +pub(crate) struct LoggingTooManyArgs; impl Violation for LoggingTooManyArgs { #[derive_message_formats] fn message(&self) -> String { - format!("Too many arguments for `logging` format string") + "Too many arguments for `logging` format string".to_string() } } /// PLE1205 /// PLE1206 -pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn logging_call(checker: &Checker, call: &ast::ExprCall) { // If there are any starred arguments, abort. if call.arguments.args.iter().any(Expr::is_starred_expr) { return; @@ -105,7 +105,7 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { Expr::Attribute(ast::ExprAttribute { attr, .. }) => { if LoggingLevel::from_attribute(attr).is_none() { return; - }; + } if !logging::is_logger_candidate( &call.func, checker.semantic(), @@ -126,10 +126,10 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { }; if LoggingLevel::from_attribute(attribute).is_none() { return; - }; + } } _ => return, - }; + } let Some(Expr::StringLiteral(ast::ExprStringLiteral { value, .. })) = call.arguments.find_positional(0) @@ -154,17 +154,13 @@ pub(crate) fn logging_call(checker: &mut Checker, call: &ast::ExprCall) { if checker.enabled(Rule::LoggingTooManyArgs) { if summary.num_positional < num_message_args { - checker - .diagnostics - .push(Diagnostic::new(LoggingTooManyArgs, call.func.range())); + checker.report_diagnostic(Diagnostic::new(LoggingTooManyArgs, call.func.range())); } } if checker.enabled(Rule::LoggingTooFewArgs) { if num_message_args > 0 && num_keywords == 0 && summary.num_positional > num_message_args { - checker - .diagnostics - .push(Diagnostic::new(LoggingTooFewArgs, call.func.range())); + checker.report_diagnostic(Diagnostic::new(LoggingTooFewArgs, call.func.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/magic_value_comparison.rs b/crates/ruff_linter/src/rules/pylint/rules/magic_value_comparison.rs index 2ae14884f7f84..96cfe2d3d3ae8 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/magic_value_comparison.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/magic_value_comparison.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{self as ast, Expr, Int, LiteralExpressionRef, UnaryOp}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -41,9 +41,12 @@ use crate::rules::pylint::settings::ConstantType; /// return price /// ``` /// +/// ## Options +/// - `lint.pylint.allow-magic-value-types` +/// /// [PEP 8]: https://peps.python.org/pep-0008/#constants -#[violation] -pub struct MagicValueComparison { +#[derive(ViolationMetadata)] +pub(crate) struct MagicValueComparison { value: String, } @@ -86,7 +89,7 @@ fn is_magic_value(literal_expr: LiteralExpressionRef, allowed_types: &[ConstantT !matches!(value.to_str(), "" | "__main__") } LiteralExpressionRef::NumberLiteral(ast::ExprNumberLiteral { value, .. }) => match value { - #[allow(clippy::float_cmp)] + #[expect(clippy::float_cmp)] ast::Number::Float(value) => !(*value == 0.0 || *value == 1.0), ast::Number::Int(value) => !matches!(*value, Int::ZERO | Int::ONE), ast::Number::Complex { .. } => true, @@ -96,7 +99,7 @@ fn is_magic_value(literal_expr: LiteralExpressionRef, allowed_types: &[ConstantT } /// PLR2004 -pub(crate) fn magic_value_comparison(checker: &mut Checker, left: &Expr, comparators: &[Expr]) { +pub(crate) fn magic_value_comparison(checker: &Checker, left: &Expr, comparators: &[Expr]) { for (left, right) in std::iter::once(left).chain(comparators).tuple_windows() { // If both of the comparators are literals, skip rule for the whole expression. // R0133: comparison-of-constants @@ -108,7 +111,7 @@ pub(crate) fn magic_value_comparison(checker: &mut Checker, left: &Expr, compara for comparison_expr in std::iter::once(left).chain(comparators) { if let Some(value) = as_literal(comparison_expr) { if is_magic_value(value, &checker.settings.pylint.allow_magic_value_types) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( MagicValueComparison { value: checker.locator().slice(comparison_expr).to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/manual_import_from.rs b/crates/ruff_linter/src/rules/pylint/rules/manual_import_from.rs index 001a6098cddff..0d4db4219a7c4 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/manual_import_from.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/manual_import_from.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Alias, Identifier, Stmt}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -25,8 +25,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Submodules](https://docs.python.org/3/reference/import.html#submodules) -#[violation] -pub struct ManualFromImport { +#[derive(ViolationMetadata)] +pub(crate) struct ManualFromImport { module: String, name: String, } @@ -47,12 +47,7 @@ impl Violation for ManualFromImport { } /// PLR0402 -pub(crate) fn manual_from_import( - checker: &mut Checker, - stmt: &Stmt, - alias: &Alias, - names: &[Alias], -) { +pub(crate) fn manual_from_import(checker: &Checker, stmt: &Stmt, alias: &Alias, names: &[Alias]) { let Some(asname) = &alias.asname else { return; }; @@ -86,5 +81,5 @@ pub(crate) fn manual_from_import( stmt.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/misplaced_bare_raise.rs b/crates/ruff_linter/src/rules/pylint/rules/misplaced_bare_raise.rs index 4f2787e57b52b..7191e4149cb1d 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/misplaced_bare_raise.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/misplaced_bare_raise.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; @@ -40,18 +40,18 @@ use crate::rules::pylint::helpers::in_dunder_method; /// if obj is None: /// raise ValueError("`obj` cannot be `None`") /// ``` -#[violation] -pub struct MisplacedBareRaise; +#[derive(ViolationMetadata)] +pub(crate) struct MisplacedBareRaise; impl Violation for MisplacedBareRaise { #[derive_message_formats] fn message(&self) -> String { - format!("Bare `raise` statement is not inside an exception handler") + "Bare `raise` statement is not inside an exception handler".to_string() } } /// PLE0704 -pub(crate) fn misplaced_bare_raise(checker: &mut Checker, raise: &ast::StmtRaise) { +pub(crate) fn misplaced_bare_raise(checker: &Checker, raise: &ast::StmtRaise) { if raise.exc.is_some() { return; } @@ -64,7 +64,5 @@ pub(crate) fn misplaced_bare_raise(checker: &mut Checker, raise: &ast::StmtRaise return; } - checker - .diagnostics - .push(Diagnostic::new(MisplacedBareRaise, raise.range())); + checker.report_diagnostic(Diagnostic::new(MisplacedBareRaise, raise.range())); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/mod.rs b/crates/ruff_linter/src/rules/pylint/rules/mod.rs index 753c7d9a439d9..3ddc469656fc4 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/mod.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/mod.rs @@ -39,6 +39,7 @@ pub(crate) use invalid_length_return::*; pub(crate) use invalid_str_return::*; pub(crate) use invalid_string_characters::*; pub(crate) use iteration_over_set::*; +pub(crate) use len_test::*; pub(crate) use literal_membership::*; pub(crate) use load_before_global_declaration::*; pub(crate) use logging::*; @@ -62,12 +63,14 @@ pub(crate) use property_with_parameters::*; pub(crate) use redeclared_assigned_name::*; pub(crate) use redefined_argument_from_local::*; pub(crate) use redefined_loop_name::*; +pub(crate) use redefined_slots_in_subclass::*; pub(crate) use repeated_equality_comparison::*; pub(crate) use repeated_isinstance_calls::*; pub(crate) use repeated_keyword_argument::*; pub(crate) use return_in_init::*; pub(crate) use self_assigning_variable::*; pub(crate) use self_or_cls_assignment::*; +pub(crate) use shallow_copy_environ::*; pub(crate) use single_string_slots::*; pub(crate) use singledispatch_method::*; pub(crate) use singledispatchmethod_function::*; @@ -93,6 +96,8 @@ pub(crate) use unnecessary_direct_lambda_call::*; pub(crate) use unnecessary_dunder_call::*; pub(crate) use unnecessary_lambda::*; pub(crate) use unnecessary_list_index_lookup::*; +#[cfg(any(feature = "test-rules", test))] +pub(crate) use unreachable::*; pub(crate) use unspecified_encoding::*; pub(crate) use useless_else_on_loop::*; pub(crate) use useless_exception_statement::*; @@ -143,6 +148,7 @@ mod invalid_length_return; mod invalid_str_return; mod invalid_string_characters; mod iteration_over_set; +mod len_test; mod literal_membership; mod load_before_global_declaration; mod logging; @@ -166,12 +172,14 @@ mod property_with_parameters; mod redeclared_assigned_name; mod redefined_argument_from_local; mod redefined_loop_name; +mod redefined_slots_in_subclass; mod repeated_equality_comparison; mod repeated_isinstance_calls; mod repeated_keyword_argument; mod return_in_init; mod self_assigning_variable; mod self_or_cls_assignment; +mod shallow_copy_environ; mod single_string_slots; mod singledispatch_method; mod singledispatchmethod_function; @@ -197,6 +205,8 @@ mod unnecessary_direct_lambda_call; mod unnecessary_dunder_call; mod unnecessary_lambda; mod unnecessary_list_index_lookup; +#[cfg(any(feature = "test-rules", test))] +mod unreachable; mod unspecified_encoding; mod useless_else_on_loop; mod useless_exception_statement; diff --git a/crates/ruff_linter/src/rules/pylint/rules/modified_iterating_set.rs b/crates/ruff_linter/src/rules/pylint/rules/modified_iterating_set.rs index ad2ef7e8d9903..a2647678cae30 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/modified_iterating_set.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/modified_iterating_set.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_body; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr, StmtFor}; @@ -38,10 +38,15 @@ use crate::checkers::ast::Checker; /// nums.add(num + 5) /// ``` /// +/// ## Fix safety +/// This fix is always unsafe because it changes the program’s behavior. Replacing the +/// original set with a copy during iteration allows code that would previously raise a +/// `RuntimeError` to run without error. +/// /// ## References /// - [Python documentation: `set`](https://docs.python.org/3/library/stdtypes.html#set) -#[violation] -pub struct ModifiedIteratingSet { +#[derive(ViolationMetadata)] +pub(crate) struct ModifiedIteratingSet { name: Name, } @@ -59,7 +64,7 @@ impl AlwaysFixableViolation for ModifiedIteratingSet { } /// PLE4703 -pub(crate) fn modified_iterating_set(checker: &mut Checker, for_stmt: &StmtFor) { +pub(crate) fn modified_iterating_set(checker: &Checker, for_stmt: &StmtFor) { let Some(name) = for_stmt.iter.as_name_expr() else { return; }; @@ -102,7 +107,7 @@ pub(crate) fn modified_iterating_set(checker: &mut Checker, for_stmt: &StmtFor) format!("{}.copy()", checker.locator().slice(name)), name.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/named_expr_without_context.rs b/crates/ruff_linter/src/rules/pylint/rules/named_expr_without_context.rs index 5f6ddbe6c396c..df784953ae70c 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/named_expr_without_context.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/named_expr_without_context.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -24,21 +24,19 @@ use crate::checkers::ast::Checker; /// ```python /// a = 42 /// ``` -#[violation] -pub struct NamedExprWithoutContext; +#[derive(ViolationMetadata)] +pub(crate) struct NamedExprWithoutContext; impl Violation for NamedExprWithoutContext { #[derive_message_formats] fn message(&self) -> String { - format!("Named expression used without context") + "Named expression used without context".to_string() } } /// PLW0131 -pub(crate) fn named_expr_without_context(checker: &mut Checker, value: &Expr) { +pub(crate) fn named_expr_without_context(checker: &Checker, value: &Expr) { if let Expr::Named(ast::ExprNamed { range, .. }) = value { - checker - .diagnostics - .push(Diagnostic::new(NamedExprWithoutContext, *range)); + checker.report_diagnostic(Diagnostic::new(NamedExprWithoutContext, *range)); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/nan_comparison.rs b/crates/ruff_linter/src/rules/pylint/rules/nan_comparison.rs index 4329a69f906e8..31f2dceeb6e0b 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/nan_comparison.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/nan_comparison.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; @@ -31,35 +31,48 @@ use crate::checkers::ast::Checker; /// pass /// ``` /// -#[violation] -pub struct NanComparison { +#[derive(ViolationMetadata)] +pub(crate) struct NanComparison { nan: Nan, } impl Violation for NanComparison { #[derive_message_formats] fn message(&self) -> String { - let NanComparison { nan } = self; - match nan { - Nan::Math => format!("Comparing against a NaN value; use `math.isnan` instead"), - Nan::NumPy => format!("Comparing against a NaN value; use `np.isnan` instead"), + match self.nan { + Nan::Math => "Comparing against a NaN value; use `math.isnan` instead".to_string(), + Nan::NumPy => "Comparing against a NaN value; use `np.isnan` instead".to_string(), } } } /// PLW0177 -pub(crate) fn nan_comparison(checker: &mut Checker, left: &Expr, comparators: &[Expr]) { - for expr in std::iter::once(left).chain(comparators) { +pub(crate) fn nan_comparison(checker: &Checker, left: &Expr, comparators: &[Expr]) { + nan_comparison_impl(checker, std::iter::once(left).chain(comparators)); +} + +/// PLW0177 +pub(crate) fn nan_comparison_match(checker: &Checker, cases: &[ast::MatchCase]) { + nan_comparison_impl( + checker, + cases + .iter() + .filter_map(|case| case.pattern.as_match_value().map(|pattern| &*pattern.value)), + ); +} + +fn nan_comparison_impl<'a>(checker: &Checker, comparators: impl Iterator<Item = &'a Expr>) { + for expr in comparators { if let Some(qualified_name) = checker.semantic().resolve_qualified_name(expr) { match qualified_name.segments() { ["numpy", "nan" | "NAN" | "NaN"] => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NanComparison { nan: Nan::NumPy }, expr.range(), )); } ["math", "nan"] => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NanComparison { nan: Nan::Math }, expr.range(), )); @@ -69,7 +82,7 @@ pub(crate) fn nan_comparison(checker: &mut Checker, left: &Expr, comparators: &[ } if is_nan_float(expr, checker.semantic()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NanComparison { nan: Nan::Math }, expr.range(), )); diff --git a/crates/ruff_linter/src/rules/pylint/rules/nested_min_max.rs b/crates/ruff_linter/src/rules/pylint/rules/nested_min_max.rs index c6799864ba6bc..b4e11ca833714 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/nested_min_max.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/nested_min_max.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Arguments, Expr, Keyword}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; @@ -21,6 +21,7 @@ pub(crate) enum MinMax { /// readability. /// /// ## Example +/// /// ```python /// minimum = min(1, 2, min(3, 4, 5)) /// maximum = max(1, 2, max(3, 4, 5)) @@ -28,17 +29,31 @@ pub(crate) enum MinMax { /// ``` /// /// Use instead: +/// /// ```python /// minimum = min(1, 2, 3, 4, 5) /// maximum = max(1, 2, 3, 4, 5) /// diff = maximum - minimum /// ``` /// +/// ## Fix safety +/// +/// This fix is always unsafe and may change the program's behavior for types without full +/// equivalence relations, such as float comparisons involving `NaN`. +/// +/// ```python +/// print(min(2.0, min(float("nan"), 1.0))) # before fix: 2.0 +/// print(min(2.0, float("nan"), 1.0)) # after fix: 1.0 +/// +/// print(max(1.0, max(float("nan"), 2.0))) # before fix: 1.0 +/// print(max(1.0, float("nan"), 2.0)) # after fix: 2.0 +/// ``` +/// /// ## References /// - [Python documentation: `min`](https://docs.python.org/3/library/functions.html#min) /// - [Python documentation: `max`](https://docs.python.org/3/library/functions.html#max) -#[violation] -pub struct NestedMinMax { +#[derive(ViolationMetadata)] +pub(crate) struct NestedMinMax { func: MinMax, } @@ -128,7 +143,7 @@ fn collect_nested_args(min_max: MinMax, args: &[Expr], semantic: &SemanticModel) /// PLW3301 pub(crate) fn nested_min_max( - checker: &mut Checker, + checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr], @@ -173,6 +188,6 @@ pub(crate) fn nested_min_max( expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/no_method_decorator.rs b/crates/ruff_linter/src/rules/pylint/rules/no_method_decorator.rs index dc01fb788f9ee..6fae8631fe90a 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/no_method_decorator.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/no_method_decorator.rs @@ -1,7 +1,7 @@ use std::collections::HashMap; -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, DiagnosticKind, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_trivia::indentation_at_offset; @@ -32,17 +32,17 @@ use crate::fix; /// @classmethod /// def bar(cls): ... /// ``` -#[violation] -pub struct NoClassmethodDecorator; +#[derive(ViolationMetadata)] +pub(crate) struct NoClassmethodDecorator; impl AlwaysFixableViolation for NoClassmethodDecorator { #[derive_message_formats] fn message(&self) -> String { - format!("Class method defined without decorator") + "Class method defined without decorator".to_string() } fn fix_title(&self) -> String { - format!("Add @classmethod decorator") + "Add @classmethod decorator".to_string() } } @@ -68,17 +68,17 @@ impl AlwaysFixableViolation for NoClassmethodDecorator { /// @staticmethod /// def bar(arg1, arg2): ... /// ``` -#[violation] -pub struct NoStaticmethodDecorator; +#[derive(ViolationMetadata)] +pub(crate) struct NoStaticmethodDecorator; impl AlwaysFixableViolation for NoStaticmethodDecorator { #[derive_message_formats] fn message(&self) -> String { - format!("Static method defined without decorator") + "Static method defined without decorator".to_string() } fn fix_title(&self) -> String { - format!("Add @staticmethod decorator") + "Add @staticmethod decorator".to_string() } } @@ -88,25 +88,25 @@ enum MethodType { } /// PLR0202 -pub(crate) fn no_classmethod_decorator(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn no_classmethod_decorator(checker: &Checker, stmt: &Stmt) { get_undecorated_methods(checker, stmt, &MethodType::Classmethod); } /// PLR0203 -pub(crate) fn no_staticmethod_decorator(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn no_staticmethod_decorator(checker: &Checker, stmt: &Stmt) { get_undecorated_methods(checker, stmt, &MethodType::Staticmethod); } -fn get_undecorated_methods(checker: &mut Checker, class_stmt: &Stmt, method_type: &MethodType) { +fn get_undecorated_methods(checker: &Checker, class_stmt: &Stmt, method_type: &MethodType) { let Stmt::ClassDef(class_def) = class_stmt else { return; }; let mut explicit_decorator_calls: HashMap<Name, &Stmt> = HashMap::default(); - let (method_name, diagnostic_type): (&str, DiagnosticKind) = match method_type { - MethodType::Classmethod => ("classmethod", NoClassmethodDecorator.into()), - MethodType::Staticmethod => ("staticmethod", NoStaticmethodDecorator.into()), + let method_name = match method_type { + MethodType::Classmethod => "classmethod", + MethodType::Staticmethod => "staticmethod", }; // gather all explicit *method calls @@ -135,16 +135,16 @@ fn get_undecorated_methods(checker: &mut Checker, class_stmt: &Stmt, method_type if target_name == *id { explicit_decorator_calls.insert(id.clone(), stmt); } - }; + } } } } - }; + } } if explicit_decorator_calls.is_empty() { return; - }; + } for stmt in &class_def.body { if let Stmt::FunctionDef(ast::StmtFunctionDef { @@ -170,10 +170,11 @@ fn get_undecorated_methods(checker: &mut Checker, class_stmt: &Stmt, method_type continue; } - let mut diagnostic = Diagnostic::new( - diagnostic_type.clone(), - TextRange::new(stmt.range().start(), stmt.range().start()), - ); + let range = TextRange::new(stmt.range().start(), stmt.range().start()); + let mut diagnostic = match method_type { + MethodType::Classmethod => Diagnostic::new(NoClassmethodDecorator, range), + MethodType::Staticmethod => Diagnostic::new(NoStaticmethodDecorator, range), + }; let indentation = indentation_at_offset(stmt.range().start(), checker.source()); @@ -191,12 +192,12 @@ fn get_undecorated_methods(checker: &mut Checker, class_stmt: &Stmt, method_type checker.indexer(), )], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } None => { continue; } - }; - }; + } + } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/no_self_use.rs b/crates/ruff_linter/src/rules/pylint/rules/no_self_use.rs index 62c11b83c0310..e81857a6fe934 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/no_self_use.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/no_self_use.rs @@ -1,13 +1,14 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::{ - analyze::{function_type, visibility}, Scope, ScopeId, ScopeKind, + analyze::{function_type, visibility}, }; use crate::checkers::ast::Checker; +use crate::rules::flake8_unused_arguments::rules::is_not_implemented_stub_with_variable; /// ## What it does /// Checks for the presence of unused `self` parameter in methods definitions. @@ -28,8 +29,17 @@ use crate::checkers::ast::Checker; /// def greeting(): /// print("Greetings friend!") /// ``` -#[violation] -pub struct NoSelfUse { +/// +/// or +/// +/// ```python +/// class Person: +/// @staticmethod +/// def greeting(): +/// print("Greetings friend!") +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct NoSelfUse { method_name: String, } @@ -42,12 +52,7 @@ impl Violation for NoSelfUse { } /// PLR6301 -pub(crate) fn no_self_use( - checker: &Checker, - scope_id: ScopeId, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn no_self_use(checker: &Checker, scope_id: ScopeId, scope: &Scope) { let semantic = checker.semantic(); let Some(parent) = semantic.first_non_type_parent_scope(scope) else { @@ -88,22 +93,17 @@ pub(crate) fn no_self_use( || visibility::is_overload(decorator_list, semantic) || visibility::is_property(decorator_list, extra_property_decorators, semantic) || visibility::is_validator(decorator_list, semantic) + || is_not_implemented_stub_with_variable(func, semantic) { return; } // Identify the `self` parameter. - let Some(parameter) = parameters - .posonlyargs - .iter() - .chain(¶meters.args) - .next() - .map(|param| ¶m.parameter) - else { + let Some(parameter) = parameters.posonlyargs.iter().chain(¶meters.args).next() else { return; }; - if parameter.name.as_str() != "self" { + if parameter.name() != "self" { return; } @@ -126,7 +126,7 @@ pub(crate) fn no_self_use( .map(|binding_id| semantic.binding(binding_id)) .is_some_and(|binding| binding.kind.is_argument() && binding.is_unused()) { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NoSelfUse { method_name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/non_ascii_module_import.rs b/crates/ruff_linter/src/rules/pylint/rules/non_ascii_module_import.rs index a34fcf0cda37d..cfb983e90d4cc 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/non_ascii_module_import.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/non_ascii_module_import.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Alias; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -29,8 +29,8 @@ use crate::checkers::ast::Checker; /// ``` /// /// [PEP 672]: https://peps.python.org/pep-0672/ -#[violation] -pub struct NonAsciiImportName { +#[derive(ViolationMetadata)] +pub(crate) struct NonAsciiImportName { name: String, kind: Kind, } @@ -63,13 +63,13 @@ enum Kind { } /// PLC2403 -pub(crate) fn non_ascii_module_import(checker: &mut Checker, alias: &Alias) { +pub(crate) fn non_ascii_module_import(checker: &Checker, alias: &Alias) { if let Some(asname) = &alias.asname { if asname.as_str().is_ascii() { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonAsciiImportName { name: asname.to_string(), kind: Kind::Aliased, @@ -81,7 +81,7 @@ pub(crate) fn non_ascii_module_import(checker: &mut Checker, alias: &Alias) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonAsciiImportName { name: alias.name.to_string(), kind: Kind::Unaliased, diff --git a/crates/ruff_linter/src/rules/pylint/rules/non_ascii_name.rs b/crates/ruff_linter/src/rules/pylint/rules/non_ascii_name.rs index ea5a862646759..fbc6f2b14cf9f 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/non_ascii_name.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/non_ascii_name.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::{Binding, BindingKind}; use ruff_text_size::Ranged; @@ -25,8 +25,8 @@ use crate::Locator; /// ``` /// /// [PEP 672]: https://peps.python.org/pep-0672/ -#[violation] -pub struct NonAsciiName { +#[derive(ViolationMetadata)] +pub(crate) struct NonAsciiName { name: String, kind: Kind, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/non_augmented_assignment.rs b/crates/ruff_linter/src/rules/pylint/rules/non_augmented_assignment.rs index a0b2ccf3bb0b7..567a5b509eddf 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/non_augmented_assignment.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/non_augmented_assignment.rs @@ -1,10 +1,10 @@ -use ast::{Expr, StmtAugAssign}; +use ast::Expr; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::Operator; -use ruff_python_codegen::Generator; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_ast::{ExprBinOp, ExprRef, Operator}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -16,7 +16,7 @@ use crate::checkers::ast::Checker; /// ## Why is this bad? /// If the right-hand side of an assignment statement consists of a binary /// operation in which one operand is the same as the assignment target, -/// it can be rewritten as an augmented assignment. For example, `x = x + 1 +/// it can be rewritten as an augmented assignment. For example, `x = x + 1` /// can be rewritten as `x += 1`. /// /// When performing such an operation, an augmented assignment is more concise @@ -68,8 +68,8 @@ use crate::checkers::ast::Checker; /// foo += [2] /// assert (foo, bar) == ([1, 2], [1, 2]) /// ``` -#[violation] -pub struct NonAugmentedAssignment { +#[derive(ViolationMetadata)] +pub(crate) struct NonAugmentedAssignment { operator: AugmentedOperator, } @@ -86,7 +86,7 @@ impl AlwaysFixableViolation for NonAugmentedAssignment { } /// PLR6104 -pub(crate) fn non_augmented_assignment(checker: &mut Checker, assign: &ast::StmtAssign) { +pub(crate) fn non_augmented_assignment(checker: &Checker, assign: &ast::StmtAssign) { // Ignore multiple assignment targets. let [target] = assign.targets.as_slice() else { return; @@ -103,13 +103,14 @@ pub(crate) fn non_augmented_assignment(checker: &mut Checker, assign: &ast::Stmt if ComparableExpr::from(target) == ComparableExpr::from(&value.left) { let mut diagnostic = Diagnostic::new(NonAugmentedAssignment { operator }, assign.range()); diagnostic.set_fix(Fix::unsafe_edit(augmented_assignment( - checker.generator(), + checker, target, - value.op, + operator, &value.right, - assign.range(), + value, + assign.range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); return; } @@ -121,13 +122,14 @@ pub(crate) fn non_augmented_assignment(checker: &mut Checker, assign: &ast::Stmt { let mut diagnostic = Diagnostic::new(NonAugmentedAssignment { operator }, assign.range()); diagnostic.set_fix(Fix::unsafe_edit(augmented_assignment( - checker.generator(), + checker, target, - value.op, + operator, &value.left, - assign.range(), + value, + assign.range, ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -135,21 +137,30 @@ pub(crate) fn non_augmented_assignment(checker: &mut Checker, assign: &ast::Stmt /// /// For example, given `x = x + 1`, the fix would be `x += 1`. fn augmented_assignment( - generator: Generator, + checker: &Checker, target: &Expr, - operator: Operator, + operator: AugmentedOperator, right_operand: &Expr, + original_expr: &ExprBinOp, range: TextRange, ) -> Edit { - Edit::range_replacement( - generator.stmt(&ast::Stmt::AugAssign(StmtAugAssign { - range: TextRange::default(), - target: Box::new(target.clone()), - op: operator, - value: Box::new(right_operand.clone()), - })), - range, - ) + let locator = checker.locator(); + + let right_operand_ref = ExprRef::from(right_operand); + let parent = original_expr.into(); + let comment_ranges = checker.comment_ranges(); + let source = checker.source(); + + let right_operand_range = + parenthesized_range(right_operand_ref, parent, comment_ranges, source) + .unwrap_or(right_operand.range()); + let right_operand_expr = locator.slice(right_operand_range); + + let target_expr = locator.slice(target); + + let new_content = format!("{target_expr} {operator} {right_operand_expr}"); + + Edit::range_replacement(new_content, range) } #[derive(Debug, Clone, Copy, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/pylint/rules/non_slot_assignment.rs b/crates/ruff_linter/src/rules/pylint/rules/non_slot_assignment.rs index 3e2d8a7bc9e52..76a831efdf840 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/non_slot_assignment.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/non_slot_assignment.rs @@ -1,7 +1,7 @@ use rustc_hash::FxHashSet; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::{Ranged, TextRange}; @@ -46,8 +46,8 @@ use crate::checkers::ast::Checker; /// def setup(self): /// pass /// ``` -#[violation] -pub struct NonSlotAssignment { +#[derive(ViolationMetadata)] +pub(crate) struct NonSlotAssignment { name: String, } @@ -60,7 +60,7 @@ impl Violation for NonSlotAssignment { } /// PLE0237 -pub(crate) fn non_slot_assignment(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn non_slot_assignment(checker: &Checker, class_def: &ast::StmtClassDef) { let semantic = checker.semantic(); // If the class inherits from another class (aside from `object`), then it's possible that @@ -74,7 +74,7 @@ pub(crate) fn non_slot_assignment(checker: &mut Checker, class_def: &ast::StmtCl } for attribute in is_attributes_not_in_slots(&class_def.body) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonSlotAssignment { name: attribute.name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/nonlocal_and_global.rs b/crates/ruff_linter/src/rules/pylint/rules/nonlocal_and_global.rs index 6d7d25736a025..737c1fd092459 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/nonlocal_and_global.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/nonlocal_and_global.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use crate::checkers::ast::Checker; @@ -40,8 +40,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: The `global` statement](https://docs.python.org/3/reference/simple_stmts.html#the-global-statement) /// - [Python documentation: The `nonlocal` statement](https://docs.python.org/3/reference/simple_stmts.html#nonlocal) -#[violation] -pub struct NonlocalAndGlobal { +#[derive(ViolationMetadata)] +pub(crate) struct NonlocalAndGlobal { pub(crate) name: String, } @@ -54,12 +54,12 @@ impl Violation for NonlocalAndGlobal { } /// E115 -pub(crate) fn nonlocal_and_global(checker: &mut Checker, nonlocal: &ast::StmtNonlocal) { +pub(crate) fn nonlocal_and_global(checker: &Checker, nonlocal: &ast::StmtNonlocal) { // Determine whether any of the newly declared `nonlocal` variables are already declared as // `global`. for name in &nonlocal.names { if let Some(global) = checker.semantic().global(name) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( NonlocalAndGlobal { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/nonlocal_without_binding.rs b/crates/ruff_linter/src/rules/pylint/rules/nonlocal_without_binding.rs index d29ef9bf441bd..08106e7b1b3b0 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/nonlocal_without_binding.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/nonlocal_without_binding.rs @@ -1,15 +1,16 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for `nonlocal` names without bindings. /// /// ## Why is this bad? /// `nonlocal` names must be bound to a name in an outer scope. +/// Violating this rule leads to a `SyntaxError` at runtime. /// /// ## Example /// ```python -/// class Foo: +/// def foo(): /// def get_bar(self): /// nonlocal bar /// ... @@ -17,7 +18,7 @@ use ruff_macros::{derive_message_formats, violation}; /// /// Use instead: /// ```python -/// class Foo: +/// def foo(): /// bar = 1 /// /// def get_bar(self): @@ -27,9 +28,9 @@ use ruff_macros::{derive_message_formats, violation}; /// /// ## References /// - [Python documentation: The `nonlocal` statement](https://docs.python.org/3/reference/simple_stmts.html#nonlocal) -/// - [PEP 3104](https://peps.python.org/pep-3104/) -#[violation] -pub struct NonlocalWithoutBinding { +/// - [PEP 3104 – Access to Names in Outer Scopes](https://peps.python.org/pep-3104/) +#[derive(ViolationMetadata)] +pub(crate) struct NonlocalWithoutBinding { pub(crate) name: String, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/potential_index_error.rs b/crates/ruff_linter/src/rules/pylint/rules/potential_index_error.rs index e22cb4e5f4265..816fa6e5ca902 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/potential_index_error.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/potential_index_error.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -18,18 +18,18 @@ use crate::checkers::ast::Checker; /// ```python /// print([0, 1, 2][3]) /// ``` -#[violation] -pub struct PotentialIndexError; +#[derive(ViolationMetadata)] +pub(crate) struct PotentialIndexError; impl Violation for PotentialIndexError { #[derive_message_formats] fn message(&self) -> String { - format!("Expression is likely to raise `IndexError`") + "Expression is likely to raise `IndexError`".to_string() } } /// PLE0643 -pub(crate) fn potential_index_error(checker: &mut Checker, value: &Expr, slice: &Expr) { +pub(crate) fn potential_index_error(checker: &Checker, value: &Expr, slice: &Expr) { // Determine the length of the sequence. let length = match value { Expr::Tuple(ast::ExprTuple { elts, .. }) | Expr::List(ast::ExprList { elts, .. }) => { @@ -65,9 +65,7 @@ pub(crate) fn potential_index_error(checker: &mut Checker, value: &Expr, slice: // Emit a diagnostic if the index is out of bounds. If the index can't be represented as an // `i64`, but the length _can_, then the index is definitely out of bounds. - if index.map_or(true, |index| index >= length || index < -length) { - checker - .diagnostics - .push(Diagnostic::new(PotentialIndexError, slice.range())); + if index.is_none_or(|index| index >= length || index < -length) { + checker.report_diagnostic(Diagnostic::new(PotentialIndexError, slice.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/property_with_parameters.rs b/crates/ruff_linter/src/rules/pylint/rules/property_with_parameters.rs index 347866764ac6e..262fea2342aad 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/property_with_parameters.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/property_with_parameters.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{identifier::Identifier, Decorator, Parameters, Stmt}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Decorator, Parameters, Stmt, identifier::Identifier}; use ruff_python_semantic::analyze::visibility::is_property; use crate::checkers::ast::Checker; @@ -34,19 +34,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `property`](https://docs.python.org/3/library/functions.html#property) -#[violation] -pub struct PropertyWithParameters; +#[derive(ViolationMetadata)] +pub(crate) struct PropertyWithParameters; impl Violation for PropertyWithParameters { #[derive_message_formats] fn message(&self) -> String { - format!("Cannot have defined parameters for properties") + "Cannot have defined parameters for properties".to_string() } } /// PLR0206 pub(crate) fn property_with_parameters( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, decorator_list: &[Decorator], parameters: &Parameters, @@ -57,8 +57,6 @@ pub(crate) fn property_with_parameters( let semantic = checker.semantic(); let extra_property_decorators = checker.settings.pydocstyle.property_decorators(); if is_property(decorator_list, extra_property_decorators, semantic) { - checker - .diagnostics - .push(Diagnostic::new(PropertyWithParameters, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new(PropertyWithParameters, stmt.identifier())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/redeclared_assigned_name.rs b/crates/ruff_linter/src/rules/pylint/rules/redeclared_assigned_name.rs index a2380e59d4c9d..d63b1a58065e6 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/redeclared_assigned_name.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/redeclared_assigned_name.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_text_size::Ranged; @@ -28,8 +28,8 @@ use crate::checkers::ast::Checker; /// print(a) # 3 /// ``` /// -#[violation] -pub struct RedeclaredAssignedName { +#[derive(ViolationMetadata)] +pub(crate) struct RedeclaredAssignedName { name: String, } @@ -42,7 +42,7 @@ impl Violation for RedeclaredAssignedName { } /// PLW0128 -pub(crate) fn redeclared_assigned_name(checker: &mut Checker, targets: &Vec<Expr>) { +pub(crate) fn redeclared_assigned_name(checker: &Checker, targets: &Vec<Expr>) { let mut names: Vec<Name> = Vec::new(); for target in targets { @@ -50,7 +50,7 @@ pub(crate) fn redeclared_assigned_name(checker: &mut Checker, targets: &Vec<Expr } } -fn check_expr(checker: &mut Checker, expr: &Expr, names: &mut Vec<Name>) { +fn check_expr(checker: &Checker, expr: &Expr, names: &mut Vec<Name>) { match expr { Expr::Tuple(tuple) => { for target in tuple { @@ -63,7 +63,7 @@ fn check_expr(checker: &mut Checker, expr: &Expr, names: &mut Vec<Name>) { return; } if names.contains(id) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RedeclaredAssignedName { name: id.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/redefined_argument_from_local.rs b/crates/ruff_linter/src/rules/pylint/rules/redefined_argument_from_local.rs index ce3be6512500a..1c9ea795dd653 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/redefined_argument_from_local.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/redefined_argument_from_local.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for variables defined in `for`, `try`, `with` statements @@ -29,8 +29,8 @@ use ruff_macros::{derive_message_formats, violation}; /// ## References /// - [Pylint documentation](https://pylint.readthedocs.io/en/latest/user_guide/messages/refactor/redefined-argument-from-local.html) -#[violation] -pub struct RedefinedArgumentFromLocal { +#[derive(ViolationMetadata)] +pub(crate) struct RedefinedArgumentFromLocal { pub(crate) name: String, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/redefined_loop_name.rs b/crates/ruff_linter/src/rules/pylint/rules/redefined_loop_name.rs index 3ca8936641686..3d46e8b768d61 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/redefined_loop_name.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/redefined_loop_name.rs @@ -4,9 +4,9 @@ use regex::Regex; use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, Stmt, WithItem}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; @@ -48,8 +48,8 @@ use crate::checkers::ast::Checker; /// f = path2.open() /// print(f.readline()) # prints a line from path2 /// ``` -#[violation] -pub struct RedefinedLoopName { +#[derive(ViolationMetadata)] +pub(crate) struct RedefinedLoopName { name: String, outer_kind: OuterBindingKind, inner_kind: InnerBindingKind, @@ -144,7 +144,7 @@ struct InnerForWithAssignTargetsVisitor<'a, 'b> { assignment_targets: Vec<ExprWithInnerBindingKind<'a>>, } -impl<'a, 'b> StatementVisitor<'b> for InnerForWithAssignTargetsVisitor<'a, 'b> { +impl<'b> StatementVisitor<'b> for InnerForWithAssignTargetsVisitor<'_, 'b> { fn visit_stmt(&mut self, stmt: &'b Stmt) { // Collect target expressions. match stmt { @@ -338,7 +338,7 @@ fn assignment_targets_from_assign_targets<'a>( } /// PLW2901 -pub(crate) fn redefined_loop_name(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn redefined_loop_name(checker: &Checker, stmt: &Stmt) { let (outer_assignment_targets, inner_assignment_targets) = match stmt { Stmt::With(ast::StmtWith { items, body, .. }) => { let outer_assignment_targets: Vec<ExprWithOuterBindingKind> = @@ -379,15 +379,13 @@ pub(crate) fn redefined_loop_name(checker: &mut Checker, stmt: &Stmt) { _ => panic!("redefined_loop_name called on Statement that is not a `With` or `For`"), }; - let mut diagnostics = Vec::new(); - for outer_assignment_target in &outer_assignment_targets { for inner_assignment_target in &inner_assignment_targets { // Compare the targets structurally. if ComparableExpr::from(outer_assignment_target.expr) .eq(&(ComparableExpr::from(inner_assignment_target.expr))) { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RedefinedLoopName { name: checker.generator().expr(outer_assignment_target.expr), outer_kind: outer_assignment_target.binding_kind, @@ -398,6 +396,4 @@ pub(crate) fn redefined_loop_name(checker: &mut Checker, stmt: &Stmt) { } } } - - checker.diagnostics.extend(diagnostics); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/redefined_slots_in_subclass.rs b/crates/ruff_linter/src/rules/pylint/rules/redefined_slots_in_subclass.rs new file mode 100644 index 0000000000000..675045a73db93 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/rules/redefined_slots_in_subclass.rs @@ -0,0 +1,202 @@ +use std::hash::Hash; + +use ruff_python_semantic::analyze::class::iter_super_class; +use rustc_hash::FxHashSet; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, Stmt}; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for a re-defined slot in a subclass. +/// +/// ## Why is this bad? +/// If a class defines a slot also defined in a base class, the +/// instance variable defined by the base class slot is inaccessible +/// (except by retrieving its descriptor directly from the base class). +/// +/// ## Example +/// ```python +/// class Base: +/// __slots__ = ("a", "b") +/// +/// +/// class Subclass(Base): +/// __slots__ = ("a", "d") # slot "a" redefined +/// ``` +/// +/// Use instead: +/// ```python +/// class Base: +/// __slots__ = ("a", "b") +/// +/// +/// class Subclass(Base): +/// __slots__ = "d" +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct RedefinedSlotsInSubclass { + base: String, + slot_name: String, +} + +impl Violation for RedefinedSlotsInSubclass { + #[derive_message_formats] + fn message(&self) -> String { + let RedefinedSlotsInSubclass { base, slot_name } = self; + format!("Slot `{slot_name}` redefined from base class `{base}`") + } +} + +// PLW0244 +pub(crate) fn redefined_slots_in_subclass(checker: &Checker, class_def: &ast::StmtClassDef) { + // Early return if this is not a subclass + if class_def.bases().is_empty() { + return; + } + + let ast::StmtClassDef { body, .. } = class_def; + let class_slots = slots_members(body); + + // If there are no slots, we're safe + if class_slots.is_empty() { + return; + } + + for slot in class_slots { + check_super_slots(checker, class_def, &slot); + } +} + +#[derive(Clone, Debug)] +struct Slot<'a> { + name: &'a str, + range: TextRange, +} + +impl std::cmp::PartialEq for Slot<'_> { + // We will only ever be comparing slots + // within a class and with the slots of + // a super class. In that context, we + // want to compare names and not ranges. + fn eq(&self, other: &Self) -> bool { + self.name == other.name + } +} + +impl std::cmp::Eq for Slot<'_> {} + +impl Hash for Slot<'_> { + fn hash<H: std::hash::Hasher>(&self, state: &mut H) { + self.name.hash(state); + } +} + +impl Ranged for Slot<'_> { + fn range(&self) -> TextRange { + self.range + } +} + +fn check_super_slots(checker: &Checker, class_def: &ast::StmtClassDef, slot: &Slot) { + for super_class in iter_super_class(class_def, checker.semantic()).skip(1) { + if slots_members(&super_class.body).contains(slot) { + checker.report_diagnostic(Diagnostic::new( + RedefinedSlotsInSubclass { + base: super_class.name.to_string(), + slot_name: slot.name.to_string(), + }, + slot.range(), + )); + } + } +} + +fn slots_members(body: &[Stmt]) -> FxHashSet<Slot> { + let mut members = FxHashSet::default(); + for stmt in body { + match stmt { + // Ex) `__slots__ = ("name",)` + Stmt::Assign(ast::StmtAssign { targets, value, .. }) => { + let [Expr::Name(ast::ExprName { id, .. })] = targets.as_slice() else { + continue; + }; + + if id == "__slots__" { + members.extend(slots_attributes(value)); + } + } + + // Ex) `__slots__: Tuple[str, ...] = ("name",)` + Stmt::AnnAssign(ast::StmtAnnAssign { + target, + value: Some(value), + .. + }) => { + let Expr::Name(ast::ExprName { id, .. }) = target.as_ref() else { + continue; + }; + + if id == "__slots__" { + members.extend(slots_attributes(value)); + } + } + + // Ex) `__slots__ += ("name",)` + Stmt::AugAssign(ast::StmtAugAssign { target, value, .. }) => { + let Expr::Name(ast::ExprName { id, .. }) = target.as_ref() else { + continue; + }; + + if id == "__slots__" { + members.extend(slots_attributes(value)); + } + } + _ => {} + } + } + members +} + +fn slots_attributes(expr: &Expr) -> impl Iterator<Item = Slot> { + // Ex) `__slots__ = ("name",)` + let elts_iter = match expr { + Expr::Tuple(ast::ExprTuple { elts, .. }) + | Expr::List(ast::ExprList { elts, .. }) + | Expr::Set(ast::ExprSet { elts, .. }) => Some(elts.iter().filter_map(|elt| match elt { + Expr::StringLiteral(ast::ExprStringLiteral { value, range }) => Some(Slot { + name: value.to_str(), + range: *range, + }), + _ => None, + })), + _ => None, + }; + + // Ex) `__slots__ = {"name": ...}` + let keys_iter = match expr { + Expr::Dict(ast::ExprDict { .. }) => Some( + expr.as_dict_expr() + .unwrap() + .iter_keys() + .filter_map(|key| match key { + Some(Expr::StringLiteral(ast::ExprStringLiteral { value, range })) => { + Some(Slot { + name: value.to_str(), + range: *range, + }) + } + _ => None, + }), + ), + _ => None, + }; + + elts_iter + .into_iter() + .flatten() + .chain(keys_iter.into_iter().flatten()) +} diff --git a/crates/ruff_linter/src/rules/pylint/rules/repeated_equality_comparison.rs b/crates/ruff_linter/src/rules/pylint/rules/repeated_equality_comparison.rs index e20a15a2447ee..3a7f4c7805390 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/repeated_equality_comparison.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/repeated_equality_comparison.rs @@ -3,22 +3,25 @@ use rustc_hash::{FxBuildHasher, FxHashMap}; use ast::ExprContext; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_ast::hashable::HashableExpr; use ruff_python_ast::helpers::{any_over_expr, contains_effect}; use ruff_python_ast::{self as ast, BoolOp, CmpOp, Expr}; use ruff_python_semantic::SemanticModel; -use ruff_text_size::{Ranged, TextRange, TextSize}; +use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; -use crate::Locator; /// ## What it does -/// Checks for repeated equality comparisons that can rewritten as a membership +/// Checks for repeated equality comparisons that can be rewritten as a membership /// test. /// +/// This rule will try to determine if the values are hashable +/// and the fix will use a `set` if they are. If unable to determine, the fix +/// will use a `tuple` and suggest the use of a `set`. +/// /// ## Why is this bad? /// To check if a variable is equal to one of many values, it is common to /// write a series of equality comparisons (e.g., @@ -43,35 +46,41 @@ use crate::Locator; /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) /// - [Python documentation: Membership test operations](https://docs.python.org/3/reference/expressions.html#membership-test-operations) /// - [Python documentation: `set`](https://docs.python.org/3/library/stdtypes.html#set) -#[violation] -pub struct RepeatedEqualityComparison { +#[derive(ViolationMetadata)] +pub(crate) struct RepeatedEqualityComparison { expression: SourceCodeSnippet, + all_hashable: bool, } impl AlwaysFixableViolation for RepeatedEqualityComparison { #[derive_message_formats] fn message(&self) -> String { - let RepeatedEqualityComparison { expression } = self; - if let Some(expression) = expression.full_display() { - format!( - "Consider merging multiple comparisons: `{expression}`. Use a `set` if the elements are hashable." - ) - } else { - format!( + match (self.expression.full_display(), self.all_hashable) { + (Some(expression), false) => { + format!( + "Consider merging multiple comparisons: `{expression}`. Use a `set` if the elements are hashable." + ) + } + (Some(expression), true) => { + format!("Consider merging multiple comparisons: `{expression}`.") + } + (None, false) => { "Consider merging multiple comparisons. Use a `set` if the elements are hashable." - ) + .to_string() + } + (None, true) => "Consider merging multiple comparisons.".to_string(), } } fn fix_title(&self) -> String { - format!("Merge multiple comparisons") + "Merge multiple comparisons".to_string() } } /// PLR1714 -pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast::ExprBoolOp) { +pub(crate) fn repeated_equality_comparison(checker: &Checker, bool_op: &ast::ExprBoolOp) { // Map from expression hash to (starting offset, number of comparisons, list - let mut value_to_comparators: FxHashMap<HashableExpr, (TextSize, Vec<&Expr>, Vec<usize>)> = + let mut value_to_comparators: FxHashMap<ComparableExpr, (&Expr, Vec<&Expr>, Vec<usize>)> = FxHashMap::with_capacity_and_hasher(bool_op.values.len() * 2, FxBuildHasher); for (i, value) in bool_op.values.iter().enumerate() { @@ -82,7 +91,7 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: if matches!(left, Expr::Name(_) | Expr::Attribute(_)) { let (_, left_matches, index_matches) = value_to_comparators .entry(left.into()) - .or_insert_with(|| (left.start(), Vec::new(), Vec::new())); + .or_insert_with(|| (left, Vec::new(), Vec::new())); left_matches.push(right); index_matches.push(i); } @@ -90,15 +99,15 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: if matches!(right, Expr::Name(_) | Expr::Attribute(_)) { let (_, right_matches, index_matches) = value_to_comparators .entry(right.into()) - .or_insert_with(|| (right.start(), Vec::new(), Vec::new())); + .or_insert_with(|| (right, Vec::new(), Vec::new())); right_matches.push(left); index_matches.push(i); } } - for (value, (_, comparators, indices)) in value_to_comparators - .iter() - .sorted_by_key(|(_, (start, _, _))| *start) + for (expr, comparators, indices) in value_to_comparators + .into_values() + .sorted_by_key(|(expr, _, _)| expr.start()) { // If there's only one comparison, there's nothing to merge. if comparators.len() == 1 { @@ -112,9 +121,9 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: if last.is_some_and(|last| last + 1 == *index) { let (indices, comparators) = sequences.last_mut().unwrap(); indices.push(*index); - comparators.push(*comparator); + comparators.push(comparator); } else { - sequences.push((vec![*index], vec![*comparator])); + sequences.push((vec![*index], vec![comparator])); } last = Some(*index); } @@ -124,14 +133,22 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: continue; } + // if we can determine that all the values are hashable, we can use a set + // TODO: improve with type inference + let all_hashable = comparators + .iter() + .all(|comparator| comparator.is_literal_expr()); + let mut diagnostic = Diagnostic::new( RepeatedEqualityComparison { expression: SourceCodeSnippet::new(merged_membership_test( - value.as_expr(), + expr, bool_op.op, &comparators, checker.locator(), + all_hashable, )), + all_hashable, }, bool_op.range(), ); @@ -143,22 +160,31 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: let before = bool_op.values.iter().take(*first).cloned(); let after = bool_op.values.iter().skip(last + 1).cloned(); + let comparator = if all_hashable { + Expr::Set(ast::ExprSet { + elts: comparators.iter().copied().cloned().collect(), + range: TextRange::default(), + }) + } else { + Expr::Tuple(ast::ExprTuple { + elts: comparators.iter().copied().cloned().collect(), + range: TextRange::default(), + ctx: ExprContext::Load, + parenthesized: true, + }) + }; + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( checker.generator().expr(&Expr::BoolOp(ast::ExprBoolOp { op: bool_op.op, values: before .chain(std::iter::once(Expr::Compare(ast::ExprCompare { - left: Box::new(value.as_expr().clone()), + left: Box::new(expr.clone()), ops: match bool_op.op { BoolOp::Or => Box::from([CmpOp::In]), BoolOp::And => Box::from([CmpOp::NotIn]), }, - comparators: Box::from([Expr::Tuple(ast::ExprTuple { - elts: comparators.iter().copied().cloned().collect(), - range: TextRange::default(), - ctx: ExprContext::Load, - parenthesized: true, - })]), + comparators: Box::from([comparator]), range: bool_op.range(), }))) .chain(after) @@ -168,7 +194,7 @@ pub(crate) fn repeated_equality_comparison(checker: &mut Checker, bool_op: &ast: bool_op.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -234,11 +260,13 @@ fn to_allowed_value<'a>( } /// Generate a string like `obj in (a, b, c)` or `obj not in (a, b, c)`. +/// If `all_hashable` is `true`, the string will use a set instead of a tuple. fn merged_membership_test( left: &Expr, op: BoolOp, comparators: &[&Expr], locator: &Locator, + all_hashable: bool, ) -> String { let op = match op { BoolOp::Or => "in", @@ -249,5 +277,10 @@ fn merged_membership_test( .iter() .map(|comparator| locator.slice(comparator)) .join(", "); + + if all_hashable { + return format!("{left} {op} {{{members}}}",); + } + format!("{left} {op} ({members})",) } diff --git a/crates/ruff_linter/src/rules/pylint/rules/repeated_isinstance_calls.rs b/crates/ruff_linter/src/rules/pylint/rules/repeated_isinstance_calls.rs index d628461836fdb..dda289e3e432c 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/repeated_isinstance_calls.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/repeated_isinstance_calls.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::AlwaysFixableViolation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::fix::snippet::SourceCodeSnippet; @@ -48,8 +48,8 @@ use crate::fix::snippet::SourceCodeSnippet; /// - [Python documentation: `isinstance`](https://docs.python.org/3/library/functions.html#isinstance) /// /// [SIM101]: https://docs.astral.sh/ruff/rules/duplicate-isinstance-call/ -#[violation] -pub struct RepeatedIsinstanceCalls { +#[derive(ViolationMetadata)] +pub(crate) struct RepeatedIsinstanceCalls { expression: SourceCodeSnippet, } @@ -57,20 +57,18 @@ pub struct RepeatedIsinstanceCalls { impl AlwaysFixableViolation for RepeatedIsinstanceCalls { #[derive_message_formats] fn message(&self) -> String { - let RepeatedIsinstanceCalls { expression } = self; - if let Some(expression) = expression.full_display() { + if let Some(expression) = self.expression.full_display() { format!("Merge `isinstance` calls: `{expression}`") } else { - format!("Merge `isinstance` calls") + "Merge `isinstance` calls".to_string() } } fn fix_title(&self) -> String { - let RepeatedIsinstanceCalls { expression } = self; - if let Some(expression) = expression.full_display() { + if let Some(expression) = self.expression.full_display() { format!("Replace with `{expression}`") } else { - format!("Replace with merged `isinstance` call") + "Replace with merged `isinstance` call".to_string() } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/repeated_keyword_argument.rs b/crates/ruff_linter/src/rules/pylint/rules/repeated_keyword_argument.rs index 3c2b54f74c05d..80fb83c9113c7 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/repeated_keyword_argument.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/repeated_keyword_argument.rs @@ -1,7 +1,7 @@ use rustc_hash::{FxBuildHasher, FxHashSet}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprCall, ExprStringLiteral}; use ruff_text_size::Ranged; @@ -22,8 +22,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Argument](https://docs.python.org/3/glossary.html#term-argument) -#[violation] -pub struct RepeatedKeywordArgument { +#[derive(ViolationMetadata)] +pub(crate) struct RepeatedKeywordArgument { duplicate_keyword: String, } @@ -35,7 +35,7 @@ impl Violation for RepeatedKeywordArgument { } } -pub(crate) fn repeated_keyword_argument(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn repeated_keyword_argument(checker: &Checker, call: &ExprCall) { let ExprCall { arguments, .. } = call; let mut seen = FxHashSet::with_capacity_and_hasher(arguments.keywords.len(), FxBuildHasher); @@ -44,7 +44,7 @@ pub(crate) fn repeated_keyword_argument(checker: &mut Checker, call: &ExprCall) if let Some(id) = &keyword.arg { // Ex) `func(a=1, a=2)` if !seen.insert(id.as_str()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RepeatedKeywordArgument { duplicate_keyword: id.to_string(), }, @@ -56,7 +56,7 @@ pub(crate) fn repeated_keyword_argument(checker: &mut Checker, call: &ExprCall) for key in dict.iter_keys().flatten() { if let Expr::StringLiteral(ExprStringLiteral { value, .. }) = key { if !seen.insert(value.to_str()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( RepeatedKeywordArgument { duplicate_keyword: value.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/return_in_init.rs b/crates/ruff_linter/src/rules/pylint/rules/return_in_init.rs index 52e3ecfc5f063..11f05ca9f37c7 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/return_in_init.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/return_in_init.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; @@ -34,18 +34,18 @@ use crate::rules::pylint::helpers::in_dunder_method; /// /// ## References /// - [CodeQL: `py-explicit-return-in-init`](https://codeql.github.com/codeql-query-help/python/py-explicit-return-in-init/) -#[violation] -pub struct ReturnInInit; +#[derive(ViolationMetadata)] +pub(crate) struct ReturnInInit; impl Violation for ReturnInInit { #[derive_message_formats] fn message(&self) -> String { - format!("Explicit return in `__init__`") + "Explicit return in `__init__`".to_string() } } /// PLE0101 -pub(crate) fn return_in_init(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn return_in_init(checker: &Checker, stmt: &Stmt) { if let Stmt::Return(ast::StmtReturn { value, range: _ }) = stmt { if let Some(expr) = value { if expr.is_none_literal_expr() { @@ -59,8 +59,6 @@ pub(crate) fn return_in_init(checker: &mut Checker, stmt: &Stmt) { } if in_dunder_method("__init__", checker.semantic(), checker.settings) { - checker - .diagnostics - .push(Diagnostic::new(ReturnInInit, stmt.range())); + checker.report_diagnostic(Diagnostic::new(ReturnInInit, stmt.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/self_assigning_variable.rs b/crates/ruff_linter/src/rules/pylint/rules/self_assigning_variable.rs index b90cdc80d5826..d5d9117bb8a59 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/self_assigning_variable.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/self_assigning_variable.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{self as ast, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -23,8 +23,8 @@ use crate::checkers::ast::Checker; /// ```python /// country = "Poland" /// ``` -#[violation] -pub struct SelfAssigningVariable { +#[derive(ViolationMetadata)] +pub(crate) struct SelfAssigningVariable { name: String, } @@ -37,7 +37,7 @@ impl Violation for SelfAssigningVariable { } /// PLW0127 -pub(crate) fn self_assignment(checker: &mut Checker, assign: &ast::StmtAssign) { +pub(crate) fn self_assignment(checker: &Checker, assign: &ast::StmtAssign) { // Assignments in class bodies are attributes (e.g., `x = x` assigns `x` to `self.x`, and thus // is not a self-assignment). if checker.semantic().current_scope().kind.is_class() { @@ -50,12 +50,12 @@ pub(crate) fn self_assignment(checker: &mut Checker, assign: &ast::StmtAssign) { .chain(std::iter::once(assign.value.as_ref())) .tuple_combinations() { - visit_assignments(left, right, &mut checker.diagnostics); + visit_assignments(checker, left, right); } } /// PLW0127 -pub(crate) fn self_annotated_assignment(checker: &mut Checker, assign: &ast::StmtAnnAssign) { +pub(crate) fn self_annotated_assignment(checker: &Checker, assign: &ast::StmtAnnAssign) { let Some(value) = assign.value.as_ref() else { return; }; @@ -66,20 +66,20 @@ pub(crate) fn self_annotated_assignment(checker: &mut Checker, assign: &ast::Stm return; } - visit_assignments(&assign.target, value, &mut checker.diagnostics); + visit_assignments(checker, &assign.target, value); } -fn visit_assignments(left: &Expr, right: &Expr, diagnostics: &mut Vec<Diagnostic>) { +fn visit_assignments(checker: &Checker, left: &Expr, right: &Expr) { match (left, right) { (Expr::Tuple(lhs), Expr::Tuple(rhs)) if lhs.len() == rhs.len() => lhs .iter() .zip(rhs) - .for_each(|(lhs_elem, rhs_elem)| visit_assignments(lhs_elem, rhs_elem, diagnostics)), + .for_each(|(lhs_elem, rhs_elem)| visit_assignments(checker, lhs_elem, rhs_elem)), ( Expr::Name(ast::ExprName { id: lhs_name, .. }), Expr::Name(ast::ExprName { id: rhs_name, .. }), ) if lhs_name == rhs_name => { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SelfAssigningVariable { name: lhs_name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs b/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs index 7f3c1a4b9fa94..aead8c0939a6f 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, ParameterWithDefault}; -use ruff_python_semantic::analyze::function_type::{self as function_type, FunctionType}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::ScopeKind; +use ruff_python_semantic::analyze::function_type::{self as function_type, FunctionType}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -10,6 +10,9 @@ use crate::checkers::ast::Checker; /// ## What it does /// Checks for assignment of `self` and `cls` in instance and class methods respectively. /// +/// This check also applies to `__new__` even though this is technically +/// a static method. +/// /// ## Why is this bad? /// The identifiers `self` and `cls` are conventional in Python for the first parameter of instance /// methods and class methods, respectively. Assigning new values to these variables can be @@ -42,8 +45,8 @@ use crate::checkers::ast::Checker; /// supercls = cls.__mro__[-1] /// return supercls /// ``` -#[violation] -pub struct SelfOrClsAssignment { +#[derive(ViolationMetadata)] +pub(crate) struct SelfOrClsAssignment { method_type: MethodType, } @@ -64,7 +67,7 @@ impl Violation for SelfOrClsAssignment { } /// PLW0127 -pub(crate) fn self_or_cls_assignment(checker: &mut Checker, target: &Expr) { +pub(crate) fn self_or_cls_assignment(checker: &Checker, target: &Expr) { let ScopeKind::Function(ast::StmtFunctionDef { name, decorator_list, @@ -82,10 +85,7 @@ pub(crate) fn self_or_cls_assignment(checker: &mut Checker, target: &Expr) { return; }; - let Some(ParameterWithDefault { - parameter: self_or_cls, - .. - }) = parameters + let Some(self_or_cls) = parameters .posonlyargs .first() .or_else(|| parameters.args.first()) @@ -102,21 +102,22 @@ pub(crate) fn self_or_cls_assignment(checker: &mut Checker, target: &Expr) { &checker.settings.pep8_naming.staticmethod_decorators, ); - let method_type = match (function_type, self_or_cls.name.as_str()) { - (FunctionType::Method { .. }, "self") => MethodType::Instance, - (FunctionType::ClassMethod { .. }, "cls") => MethodType::Class, + let method_type = match (function_type, self_or_cls.name().as_str()) { + (FunctionType::Method, "self") => MethodType::Instance, + (FunctionType::ClassMethod, "cls") => MethodType::Class, + (FunctionType::NewMethod, "cls") => MethodType::New, _ => return, }; check_expr(checker, target, method_type); } -fn check_expr(checker: &mut Checker, target: &Expr, method_type: MethodType) { +fn check_expr(checker: &Checker, target: &Expr, method_type: MethodType) { match target { Expr::Name(_) => { if let Expr::Name(ast::ExprName { id, .. }) = target { if id.as_str() == method_type.arg_name() { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( SelfOrClsAssignment { method_type }, target.range(), )); @@ -137,6 +138,7 @@ fn check_expr(checker: &mut Checker, target: &Expr, method_type: MethodType) { enum MethodType { Instance, Class, + New, } impl MethodType { @@ -144,6 +146,7 @@ impl MethodType { match self { MethodType::Instance => "self", MethodType::Class => "cls", + MethodType::New => "cls", } } } @@ -153,6 +156,7 @@ impl std::fmt::Display for MethodType { match self { MethodType::Instance => f.write_str("instance"), MethodType::Class => f.write_str("class"), + MethodType::New => f.write_str("`__new__`"), } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/shallow_copy_environ.rs b/crates/ruff_linter/src/rules/pylint/rules/shallow_copy_environ.rs new file mode 100644 index 0000000000000..46c3b821c8b5e --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/rules/shallow_copy_environ.rs @@ -0,0 +1,97 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast}; +use ruff_python_semantic::Modules; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Check for shallow `os.environ` copies. +/// +/// ## Why is this bad? +/// `os.environ` is not a `dict` object, but rather, a proxy object. As such, mutating a shallow +/// copy of `os.environ` will also mutate the original object. +/// +/// See [BPO 15373] for more information. +/// +/// ## Example +/// ```python +/// import copy +/// import os +/// +/// env = copy.copy(os.environ) +/// ``` +/// +/// Use instead: +/// ```python +/// import os +/// +/// env = os.environ.copy() +/// ``` +/// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because replacing a shallow copy with a deep copy can lead +/// to unintended side effects. If the program modifies the shallow copy at some point, changing it +/// to a deep copy may prevent those modifications from affecting the original data, potentially +/// altering the program's behavior. +/// +/// ## References +/// - [Python documentation: `copy` — Shallow and deep copy operations](https://docs.python.org/3/library/copy.html) +/// - [Python documentation: `os.environ`](https://docs.python.org/3/library/os.html#os.environ) +/// +/// [BPO 15373]: https://bugs.python.org/issue15373 +#[derive(ViolationMetadata)] +pub(crate) struct ShallowCopyEnviron; + +impl AlwaysFixableViolation for ShallowCopyEnviron { + #[derive_message_formats] + fn message(&self) -> String { + "Shallow copy of `os.environ` via `copy.copy(os.environ)`".to_string() + } + + fn fix_title(&self) -> String { + "Replace with `os.environ.copy()`".to_string() + } +} + +/// PLW1507 +pub(crate) fn shallow_copy_environ(checker: &Checker, call: &ast::ExprCall) { + if !(checker.semantic().seen_module(Modules::OS) + && checker.semantic().seen_module(Modules::COPY)) + { + return; + } + + if !checker + .semantic() + .resolve_qualified_name(&call.func) + .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["copy", "copy"])) + { + return; + } + + if !call.arguments.keywords.is_empty() { + return; + } + + let [arg] = call.arguments.args.as_ref() else { + return; + }; + + if !checker + .semantic() + .resolve_qualified_name(arg) + .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["os", "environ"])) + { + return; + } + + let mut diagnostic = Diagnostic::new(ShallowCopyEnviron, call.range()); + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + format!("{}.copy()", checker.locator().slice(arg)), + call.range(), + ))); + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/pylint/rules/single_string_slots.rs b/crates/ruff_linter/src/rules/pylint/rules/single_string_slots.rs index fac31d5a66658..83c28bc452674 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/single_string_slots.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/single_string_slots.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt, StmtClassDef}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use crate::checkers::ast::Checker; @@ -47,18 +47,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `__slots__`](https://docs.python.org/3/reference/datamodel.html#slots) -#[violation] -pub struct SingleStringSlots; +#[derive(ViolationMetadata)] +pub(crate) struct SingleStringSlots; impl Violation for SingleStringSlots { #[derive_message_formats] fn message(&self) -> String { - format!("Class `__slots__` should be a non-string iterable") + "Class `__slots__` should be a non-string iterable".to_string() } } /// PLC0205 -pub(crate) fn single_string_slots(checker: &mut Checker, class: &StmtClassDef) { +pub(crate) fn single_string_slots(checker: &Checker, class: &StmtClassDef) { for stmt in &class.body { match stmt { Stmt::Assign(ast::StmtAssign { targets, value, .. }) => { @@ -66,9 +66,10 @@ pub(crate) fn single_string_slots(checker: &mut Checker, class: &StmtClassDef) { if let Expr::Name(ast::ExprName { id, .. }) = target { if id.as_str() == "__slots__" { if matches!(value.as_ref(), Expr::StringLiteral(_) | Expr::FString(_)) { - checker - .diagnostics - .push(Diagnostic::new(SingleStringSlots, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new( + SingleStringSlots, + stmt.identifier(), + )); } } } @@ -82,9 +83,10 @@ pub(crate) fn single_string_slots(checker: &mut Checker, class: &StmtClassDef) { if let Expr::Name(ast::ExprName { id, .. }) = target.as_ref() { if id.as_str() == "__slots__" { if matches!(value.as_ref(), Expr::StringLiteral(_) | Expr::FString(_)) { - checker - .diagnostics - .push(Diagnostic::new(SingleStringSlots, stmt.identifier())); + checker.report_diagnostic(Diagnostic::new( + SingleStringSlots, + stmt.identifier(), + )); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/singledispatch_method.rs b/crates/ruff_linter/src/rules/pylint/rules/singledispatch_method.rs index 70cc8c9d20124..adf728ec82951 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/singledispatch_method.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/singledispatch_method.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_semantic::analyze::function_type; use ruff_python_semantic::Scope; +use ruff_python_semantic::analyze::function_type; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -42,15 +42,15 @@ use crate::importer::ImportRequest; /// ## Fix safety /// This rule's fix is marked as unsafe, as migrating from `@singledispatch` to /// `@singledispatchmethod` may change the behavior of the code. -#[violation] -pub struct SingledispatchMethod; +#[derive(ViolationMetadata)] +pub(crate) struct SingledispatchMethod; impl Violation for SingledispatchMethod { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`@singledispatch` decorator should not be used on methods") + "`@singledispatch` decorator should not be used on methods".to_string() } fn fix_title(&self) -> Option<String> { @@ -59,11 +59,7 @@ impl Violation for SingledispatchMethod { } /// E1519 -pub(crate) fn singledispatch_method( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn singledispatch_method(checker: &Checker, scope: &Scope) { let Some(func) = scope.kind.as_function() else { return; }; @@ -115,7 +111,7 @@ pub(crate) fn singledispatch_method( [import_edit], )) }); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs b/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs index a810cb6031560..c8cacdf7e5541 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; -use ruff_python_semantic::analyze::function_type; use ruff_python_semantic::Scope; +use ruff_python_semantic::analyze::function_type; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -40,15 +40,15 @@ use crate::importer::ImportRequest; /// ## Fix safety /// This rule's fix is marked as unsafe, as migrating from `@singledispatchmethod` to /// `@singledispatch` may change the behavior of the code. -#[violation] -pub struct SingledispatchmethodFunction; +#[derive(ViolationMetadata)] +pub(crate) struct SingledispatchmethodFunction; impl Violation for SingledispatchmethodFunction { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`@singledispatchmethod` decorator should not be used on non-method functions") + "`@singledispatchmethod` decorator should not be used on non-method functions".to_string() } fn fix_title(&self) -> Option<String> { @@ -57,11 +57,7 @@ impl Violation for SingledispatchmethodFunction { } /// E1520 -pub(crate) fn singledispatchmethod_function( - checker: &Checker, - scope: &Scope, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn singledispatchmethod_function(checker: &Checker, scope: &Scope) { let Some(func) = scope.kind.as_function() else { return; }; @@ -111,7 +107,7 @@ pub(crate) fn singledispatchmethod_function( [import_edit], )) }); - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/subprocess_popen_preexec_fn.rs b/crates/ruff_linter/src/rules/pylint/rules/subprocess_popen_preexec_fn.rs index 1815d8e66b518..3a06bac852fc5 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/subprocess_popen_preexec_fn.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/subprocess_popen_preexec_fn.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_python_semantic::Modules; @@ -39,18 +39,18 @@ use crate::checkers::ast::Checker; /// - [Why `preexec_fn` in `subprocess.Popen` may lead to deadlock?](https://discuss.python.org/t/why-preexec-fn-in-subprocess-popen-may-lead-to-deadlock/16908/2) /// /// [targeted for deprecation]: https://github.com/python/cpython/issues/82616 -#[violation] -pub struct SubprocessPopenPreexecFn; +#[derive(ViolationMetadata)] +pub(crate) struct SubprocessPopenPreexecFn; impl Violation for SubprocessPopenPreexecFn { #[derive_message_formats] fn message(&self) -> String { - format!("`preexec_fn` argument is unsafe when using threads") + "`preexec_fn` argument is unsafe when using threads".to_string() } } /// PLW1509 -pub(crate) fn subprocess_popen_preexec_fn(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn subprocess_popen_preexec_fn(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::SUBPROCESS) { return; } @@ -65,9 +65,7 @@ pub(crate) fn subprocess_popen_preexec_fn(checker: &mut Checker, call: &ast::Exp .find_keyword("preexec_fn") .filter(|keyword| !keyword.value.is_none_literal_expr()) { - checker - .diagnostics - .push(Diagnostic::new(SubprocessPopenPreexecFn, keyword.range())); + checker.report_diagnostic(Diagnostic::new(SubprocessPopenPreexecFn, keyword.range())); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/subprocess_run_without_check.rs b/crates/ruff_linter/src/rules/pylint/rules/subprocess_run_without_check.rs index d6b3fccf795c1..e3ec7b6e0a8a7 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/subprocess_run_without_check.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/subprocess_run_without_check.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -45,13 +45,13 @@ use crate::fix::edits::add_argument; /// /// ## References /// - [Python documentation: `subprocess.run`](https://docs.python.org/3/library/subprocess.html#subprocess.run) -#[violation] -pub struct SubprocessRunWithoutCheck; +#[derive(ViolationMetadata)] +pub(crate) struct SubprocessRunWithoutCheck; impl AlwaysFixableViolation for SubprocessRunWithoutCheck { #[derive_message_formats] fn message(&self) -> String { - format!("`subprocess.run` without explicit `check` argument") + "`subprocess.run` without explicit `check` argument".to_string() } fn fix_title(&self) -> String { @@ -60,7 +60,7 @@ impl AlwaysFixableViolation for SubprocessRunWithoutCheck { } /// PLW1510 -pub(crate) fn subprocess_run_without_check(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn subprocess_run_without_check(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::SUBPROCESS) { return; } @@ -91,7 +91,7 @@ pub(crate) fn subprocess_run_without_check(checker: &mut Checker, call: &ast::Ex Applicability::Safe }, )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/super_without_brackets.rs b/crates/ruff_linter/src/rules/pylint/rules/super_without_brackets.rs index d98271f5afce3..e8ca774a345e6 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/super_without_brackets.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/super_without_brackets.rs @@ -1,8 +1,8 @@ use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{analyze::function_type, ScopeKind}; +use ruff_python_semantic::{ScopeKind, analyze::function_type}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -46,13 +46,13 @@ use crate::checkers::ast::Checker; /// original_speak = super().speak() # Correct: `super().speak()` /// return f"{original_speak} But as a dog, it barks!" /// ``` -#[violation] -pub struct SuperWithoutBrackets; +#[derive(ViolationMetadata)] +pub(crate) struct SuperWithoutBrackets; impl AlwaysFixableViolation for SuperWithoutBrackets { #[derive_message_formats] fn message(&self) -> String { - format!("`super` call is missing parentheses") + "`super` call is missing parentheses".to_string() } fn fix_title(&self) -> String { @@ -61,7 +61,7 @@ impl AlwaysFixableViolation for SuperWithoutBrackets { } /// PLW0245 -pub(crate) fn super_without_brackets(checker: &mut Checker, func: &Expr) { +pub(crate) fn super_without_brackets(checker: &Checker, func: &Expr) { // The call must be to `super` (without parentheses). let Expr::Attribute(ast::ExprAttribute { value, .. }) = func else { return; @@ -101,9 +101,9 @@ pub(crate) fn super_without_brackets(checker: &mut Checker, func: &Expr) { ); if !matches!( classification, - function_type::FunctionType::Method { .. } - | function_type::FunctionType::ClassMethod { .. } - | function_type::FunctionType::StaticMethod { .. } + function_type::FunctionType::Method + | function_type::FunctionType::ClassMethod + | function_type::FunctionType::StaticMethod ) { return; } @@ -115,5 +115,5 @@ pub(crate) fn super_without_brackets(checker: &mut Checker, func: &Expr) { value.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/sys_exit_alias.rs b/crates/ruff_linter/src/rules/pylint/rules/sys_exit_alias.rs index e50cab524eff6..997faa5314964 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/sys_exit_alias.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/sys_exit_alias.rs @@ -1,10 +1,10 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::Expr; -use ruff_text_size::Ranged; - use crate::checkers::ast::Checker; use crate::importer::ImportRequest; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; + +use ruff_python_ast::ExprCall; +use ruff_text_size::Ranged; /// ## What it does /// Checks for uses of the `exit()` and `quit()`. @@ -19,6 +19,20 @@ use crate::importer::ImportRequest; /// Prefer `sys.exit()`, as the `sys` module is guaranteed to exist in all /// contexts. /// +/// ## Fix safety +/// This fix is always unsafe. When replacing `exit` or `quit` with `sys.exit`, +/// the behavior can change in the following ways: +/// +/// 1. If the code runs in an environment where the `site` module is not imported +/// (e.g., with `python -S`), the original code would raise a `NameError`, while +/// the fixed code would execute normally. +/// +/// 2. `site.exit` and `sys.exit` handle tuple arguments differently. `site.exit` +/// treats tuples as regular objects and always returns exit code 1, while `sys.exit` +/// interprets tuple contents to determine the exit code: an empty tuple () results in +/// exit code 0, and a single-element tuple like (2,) uses that element's value (2) as +/// the exit code. +/// /// ## Example /// ```python /// if __name__ == "__main__": @@ -35,8 +49,8 @@ use crate::importer::ImportRequest; /// /// ## References /// - [Python documentation: Constants added by the `site` module](https://docs.python.org/3/library/constants.html#constants-added-by-the-site-module) -#[violation] -pub struct SysExitAlias { +#[derive(ViolationMetadata)] +pub(crate) struct SysExitAlias { name: String, } @@ -56,8 +70,8 @@ impl Violation for SysExitAlias { } /// PLR1722 -pub(crate) fn sys_exit_alias(checker: &mut Checker, func: &Expr) { - let Some(builtin) = checker.semantic().resolve_builtin_symbol(func) else { +pub(crate) fn sys_exit_alias(checker: &Checker, call: &ExprCall) { + let Some(builtin) = checker.semantic().resolve_builtin_symbol(&call.func) else { return; }; if !matches!(builtin, "exit" | "quit") { @@ -67,16 +81,35 @@ pub(crate) fn sys_exit_alias(checker: &mut Checker, func: &Expr) { SysExitAlias { name: builtin.to_string(), }, - func.range(), + call.func.range(), ); + + let has_star_kwargs = call + .arguments + .keywords + .iter() + .any(|kwarg| kwarg.arg.is_none()); + // only one optional argument allowed, and we can't convert **kwargs + if call.arguments.len() > 1 || has_star_kwargs { + checker.report_diagnostic(diagnostic); + return; + } + diagnostic.try_set_fix(|| { let (import_edit, binding) = checker.importer().get_or_import_symbol( &ImportRequest::import("sys", "exit"), - func.start(), + call.func.start(), checker.semantic(), )?; - let reference_edit = Edit::range_replacement(binding, func.range()); - Ok(Fix::unsafe_edits(import_edit, [reference_edit])) + let reference_edit = Edit::range_replacement(binding, call.func.range()); + let mut edits = vec![reference_edit]; + if let Some(kwarg) = call.arguments.find_keyword("code") { + edits.push(Edit::range_replacement( + checker.source()[kwarg.value.range()].to_string(), + kwarg.range, + )); + } + Ok(Fix::unsafe_edits(import_edit, edits)) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_arguments.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_arguments.rs index 9b331571fb6cf..8c368935616c6 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_arguments.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_arguments.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::{function_type, visibility}; @@ -43,8 +43,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-args` -#[violation] -pub struct TooManyArguments { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyArguments { c_args: usize, max_args: usize, } @@ -58,18 +58,17 @@ impl Violation for TooManyArguments { } /// PLR0913 -pub(crate) fn too_many_arguments(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn too_many_arguments(checker: &Checker, function_def: &ast::StmtFunctionDef) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let semantic = checker.semantic(); let num_arguments = function_def .parameters .iter_non_variadic_params() - .filter(|arg| { - !checker - .settings - .dummy_variable_rgx - .is_match(&arg.parameter.name) - }) + .filter(|param| !checker.settings.dummy_variable_rgx.is_match(param.name())) .count(); if num_arguments <= checker.settings.pylint.max_args { @@ -94,7 +93,9 @@ pub(crate) fn too_many_arguments(checker: &mut Checker, function_def: &ast::Stmt &checker.settings.pep8_naming.classmethod_decorators, &checker.settings.pep8_naming.staticmethod_decorators, ), - function_type::FunctionType::Method | function_type::FunctionType::ClassMethod + function_type::FunctionType::Method + | function_type::FunctionType::ClassMethod + | function_type::FunctionType::NewMethod ) { // If so, we need to subtract one from the number of positional arguments, since the first // argument is always `self` or `cls`. @@ -107,7 +108,7 @@ pub(crate) fn too_many_arguments(checker: &mut Checker, function_def: &ast::Stmt return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyArguments { c_args: num_arguments, max_args: checker.settings.pylint.max_args, diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_boolean_expressions.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_boolean_expressions.rs index 152a335f99cf6..225d53aee6fdb 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_boolean_expressions.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_boolean_expressions.rs @@ -1,6 +1,6 @@ use ast::{Expr, StmtIf}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; @@ -25,8 +25,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-bool-expr` -#[violation] -pub struct TooManyBooleanExpressions { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyBooleanExpressions { expressions: usize, max_expressions: usize, } @@ -43,11 +43,11 @@ impl Violation for TooManyBooleanExpressions { } /// PLR0916 -pub(crate) fn too_many_boolean_expressions(checker: &mut Checker, stmt: &StmtIf) { +pub(crate) fn too_many_boolean_expressions(checker: &Checker, stmt: &StmtIf) { if let Some(bool_op) = stmt.test.as_bool_op_expr() { let expressions = count_bools(bool_op); if expressions > checker.settings.pylint.max_bool_expr { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyBooleanExpressions { expressions, max_expressions: checker.settings.pylint.max_bool_expr, @@ -61,7 +61,7 @@ pub(crate) fn too_many_boolean_expressions(checker: &mut Checker, stmt: &StmtIf) if let Some(bool_op) = elif.test.as_ref().and_then(Expr::as_bool_op_expr) { let expressions = count_bools(bool_op); if expressions > checker.settings.pylint.max_bool_expr { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyBooleanExpressions { expressions, max_expressions: checker.settings.pylint.max_bool_expr, diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_branches.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_branches.rs index e2b76a4101ff8..73cddc644c096 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_branches.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_branches.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; /// ## What it does @@ -142,8 +142,8 @@ use ruff_python_ast::identifier::Identifier; /// /// ## Options /// - `lint.pylint.max-branches` -#[violation] -pub struct TooManyBranches { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyBranches { branches: usize, max_branches: usize, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_locals.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_locals.rs index 2f4a4c6d6ed0f..c0bdcaffff3e5 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_locals.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_locals.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::{Scope, ScopeKind}; @@ -19,8 +19,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-locals` -#[violation] -pub struct TooManyLocals { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyLocals { current_amount: usize, max_amount: usize, } @@ -37,7 +37,7 @@ impl Violation for TooManyLocals { } /// PLR0914 -pub(crate) fn too_many_locals(checker: &Checker, scope: &Scope, diagnostics: &mut Vec<Diagnostic>) { +pub(crate) fn too_many_locals(checker: &Checker, scope: &Scope) { let num_locals = scope .binding_ids() .filter(|id| { @@ -47,13 +47,13 @@ pub(crate) fn too_many_locals(checker: &Checker, scope: &Scope, diagnostics: &mu .count(); if num_locals > checker.settings.pylint.max_locals { if let ScopeKind::Function(func) = scope.kind { - diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyLocals { current_amount: num_locals, max_amount: checker.settings.pylint.max_locals, }, func.identifier(), )); - }; + } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_nested_blocks.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_nested_blocks.rs index 3d406f047ffeb..e5546784620d9 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_nested_blocks.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_nested_blocks.rs @@ -1,6 +1,6 @@ use ast::ExceptHandler; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::Ranged; @@ -18,8 +18,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-nested-blocks` -#[violation] -pub struct TooManyNestedBlocks { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyNestedBlocks { nested_blocks: usize, max_nested_blocks: usize, } @@ -36,7 +36,7 @@ impl Violation for TooManyNestedBlocks { } /// PLR1702 -pub(crate) fn too_many_nested_blocks(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn too_many_nested_blocks(checker: &Checker, stmt: &Stmt) { // Only enforce nesting within functions or methods. if !checker.semantic().current_scope().kind.is_function() { return; @@ -74,7 +74,7 @@ pub(crate) fn too_many_nested_blocks(checker: &mut Checker, stmt: &Stmt) { return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyNestedBlocks { nested_blocks: count, max_nested_blocks, diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_positional_arguments.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_positional_arguments.rs index da30e224b806b..79e05dae553f9 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_positional_arguments.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_positional_arguments.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, identifier::Identifier}; use ruff_python_semantic::analyze::{function_type, visibility}; @@ -41,8 +41,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-positional-args` -#[violation] -pub struct TooManyPositionalArguments { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyPositionalArguments { c_pos: usize, max_pos: usize, } @@ -57,9 +57,13 @@ impl Violation for TooManyPositionalArguments { /// PLR0917 pub(crate) fn too_many_positional_arguments( - checker: &mut Checker, + checker: &Checker, function_def: &ast::StmtFunctionDef, ) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let semantic = checker.semantic(); // Count the number of positional arguments. @@ -68,12 +72,7 @@ pub(crate) fn too_many_positional_arguments( .posonlyargs .iter() .chain(&function_def.parameters.args) - .filter(|param| { - !checker - .settings - .dummy_variable_rgx - .is_match(¶m.parameter.name) - }) + .filter(|param| !checker.settings.dummy_variable_rgx.is_match(param.name())) .count(); if num_positional_args <= checker.settings.pylint.max_positional_args { @@ -98,7 +97,9 @@ pub(crate) fn too_many_positional_arguments( &checker.settings.pep8_naming.classmethod_decorators, &checker.settings.pep8_naming.staticmethod_decorators, ), - function_type::FunctionType::Method | function_type::FunctionType::ClassMethod + function_type::FunctionType::Method + | function_type::FunctionType::ClassMethod + | function_type::FunctionType::NewMethod ) { // If so, we need to subtract one from the number of positional arguments, since the first // argument is always `self` or `cls`. @@ -111,7 +112,7 @@ pub(crate) fn too_many_positional_arguments( return; } - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyPositionalArguments { c_pos: num_positional_args, max_pos: checker.settings.pylint.max_positional_args, diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_public_methods.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_public_methods.rs index 26fca2d0786dc..5853ad0264c37 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_public_methods.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_public_methods.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::analyze::visibility::{self, Visibility::Public}; use ruff_text_size::Ranged; @@ -82,8 +82,8 @@ use crate::checkers::ast::Checker; /// /// ## Options /// - `lint.pylint.max-public-methods` -#[violation] -pub struct TooManyPublicMethods { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyPublicMethods { methods: usize, max_methods: usize, } @@ -101,21 +101,27 @@ impl Violation for TooManyPublicMethods { /// R0904 pub(crate) fn too_many_public_methods( - checker: &mut Checker, + checker: &Checker, class_def: &ast::StmtClassDef, max_methods: usize, ) { + // https://github.com/astral-sh/ruff/issues/14535 + if checker.source_type.is_stub() { + return; + } let methods = class_def .body .iter() .filter(|stmt| { - stmt.as_function_def_stmt() - .is_some_and(|node| matches!(visibility::method_visibility(node), Public)) + stmt.as_function_def_stmt().is_some_and(|node| { + matches!(visibility::method_visibility(node), Public) + && !visibility::is_overload(&node.decorator_list, checker.semantic()) + }) }) .count(); if methods > max_methods { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TooManyPublicMethods { methods, max_methods, diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_return_statements.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_return_statements.rs index 5e6e34dba86b0..7c7f85d417b2c 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_return_statements.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_return_statements.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::Visitor; @@ -51,8 +51,8 @@ use ruff_python_ast::visitor::Visitor; /// /// ## Options /// - `lint.pylint.max-returns` -#[violation] -pub struct TooManyReturnStatements { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyReturnStatements { returns: usize, max_returns: usize, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/too_many_statements.rs b/crates/ruff_linter/src/rules/pylint/rules/too_many_statements.rs index 3ab6f9fb15d1b..2ec7c7b3d3cb3 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/too_many_statements.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/too_many_statements.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; /// ## What it does @@ -45,8 +45,8 @@ use ruff_python_ast::identifier::Identifier; /// /// ## Options /// - `lint.pylint.max-statements` -#[violation] -pub struct TooManyStatements { +#[derive(ViolationMetadata)] +pub(crate) struct TooManyStatements { statements: usize, max_statements: usize, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/type_bivariance.rs b/crates/ruff_linter/src/rules/pylint/rules/type_bivariance.rs index 2fd82e175d751..5801e86688766 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/type_bivariance.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/type_bivariance.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -53,8 +53,8 @@ use crate::rules::pylint::helpers::type_param_name; /// - [Python documentation: `typing` — Support for type hints](https://docs.python.org/3/library/typing.html) /// - [PEP 483 – The Theory of Type Hints: Covariance and Contravariance](https://peps.python.org/pep-0483/#covariance-and-contravariance) /// - [PEP 484 – Type Hints: Covariance and contravariance](https://peps.python.org/pep-0484/#covariance-and-contravariance) -#[violation] -pub struct TypeBivariance { +#[derive(ViolationMetadata)] +pub(crate) struct TypeBivariance { kind: VarKind, param_name: Option<String>, } @@ -73,7 +73,7 @@ impl Violation for TypeBivariance { } /// PLC0131 -pub(crate) fn type_bivariance(checker: &mut Checker, value: &Expr) { +pub(crate) fn type_bivariance(checker: &Checker, value: &Expr) { // If the typing modules were never imported, we'll never match below. if !checker.semantic().seen_typing() { return; @@ -124,7 +124,7 @@ pub(crate) fn type_bivariance(checker: &mut Checker, value: &Expr) { return; }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TypeBivariance { kind, param_name: type_param_name(arguments).map(ToString::to_string), diff --git a/crates/ruff_linter/src/rules/pylint/rules/type_name_incorrect_variance.rs b/crates/ruff_linter/src/rules/pylint/rules/type_name_incorrect_variance.rs index 75a86035d398d..08efd64b7de6b 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/type_name_incorrect_variance.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/type_name_incorrect_variance.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_const_true; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -41,9 +41,9 @@ use crate::rules::pylint::helpers::type_param_name; /// - [PEP 483 – The Theory of Type Hints: Covariance and Contravariance](https://peps.python.org/pep-0483/#covariance-and-contravariance) /// - [PEP 484 – Type Hints: Covariance and contravariance](https://peps.python.org/pep-0484/#covariance-and-contravariance) /// -/// [PEP 484]: https://www.python.org/dev/peps/pep-0484/ -#[violation] -pub struct TypeNameIncorrectVariance { +/// [PEP 484]: https://peps.python.org/pep-0484/ +#[derive(ViolationMetadata)] +pub(crate) struct TypeNameIncorrectVariance { kind: VarKind, param_name: String, variance: VarVariance, @@ -59,12 +59,14 @@ impl Violation for TypeNameIncorrectVariance { variance, replacement_name, } = self; - format!("`{kind}` name \"{param_name}\" does not reflect its {variance}; consider renaming it to \"{replacement_name}\"") + format!( + "`{kind}` name \"{param_name}\" does not reflect its {variance}; consider renaming it to \"{replacement_name}\"" + ) } } /// PLC0105 -pub(crate) fn type_name_incorrect_variance(checker: &mut Checker, value: &Expr) { +pub(crate) fn type_name_incorrect_variance(checker: &Checker, value: &Expr) { // If the typing modules were never imported, we'll never match below. if !checker.semantic().seen_typing() { return; @@ -126,7 +128,7 @@ pub(crate) fn type_name_incorrect_variance(checker: &mut Checker, value: &Expr) VarVariance::Invariance => name_root.to_string(), }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TypeNameIncorrectVariance { kind, param_name: param_name.to_string(), @@ -140,9 +142,9 @@ pub(crate) fn type_name_incorrect_variance(checker: &mut Checker, value: &Expr) /// Returns `true` if the parameter name does not match its type variance. fn mismatch(param_name: &str, covariant: Option<&Expr>, contravariant: Option<&Expr>) -> bool { if param_name.ends_with("_co") { - covariant.map_or(true, |covariant| !is_const_true(covariant)) + covariant.is_none_or(|covariant| !is_const_true(covariant)) } else if param_name.ends_with("_contra") { - contravariant.map_or(true, |contravariant| !is_const_true(contravariant)) + contravariant.is_none_or(|contravariant| !is_const_true(contravariant)) } else { covariant.is_some_and(is_const_true) || contravariant.is_some_and(is_const_true) } diff --git a/crates/ruff_linter/src/rules/pylint/rules/type_param_name_mismatch.rs b/crates/ruff_linter/src/rules/pylint/rules/type_param_name_mismatch.rs index 805f98e97c676..722590a517f6f 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/type_param_name_mismatch.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/type_param_name_mismatch.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -38,8 +38,8 @@ use crate::rules::pylint::helpers::type_param_name; /// - [PEP 484 – Type Hints: Generics](https://peps.python.org/pep-0484/#generics) /// /// [PEP 484]:https://peps.python.org/pep-0484/#generics -#[violation] -pub struct TypeParamNameMismatch { +#[derive(ViolationMetadata)] +pub(crate) struct TypeParamNameMismatch { kind: VarKind, var_name: String, param_name: String, @@ -58,7 +58,7 @@ impl Violation for TypeParamNameMismatch { } /// PLC0132 -pub(crate) fn type_param_name_mismatch(checker: &mut Checker, value: &Expr, targets: &[Expr]) { +pub(crate) fn type_param_name_mismatch(checker: &Checker, value: &Expr, targets: &[Expr]) { // If the typing modules were never imported, we'll never match below. if !checker.semantic().seen_typing() { return; @@ -119,7 +119,7 @@ pub(crate) fn type_param_name_mismatch(checker: &mut Checker, value: &Expr, targ return; }; - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( TypeParamNameMismatch { kind, var_name: var_name.to_string(), diff --git a/crates/ruff_linter/src/rules/pylint/rules/unexpected_special_method_signature.rs b/crates/ruff_linter/src/rules/pylint/rules/unexpected_special_method_signature.rs index 09182ef38461e..0dfb437aeec53 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unexpected_special_method_signature.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unexpected_special_method_signature.rs @@ -3,7 +3,7 @@ use std::cmp::Ordering; use ruff_python_ast::{Decorator, Parameters, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_semantic::analyze::visibility::is_staticmethod; @@ -23,10 +23,8 @@ impl ExpectedParams { | "__neg__" | "__pos__" | "__abs__" | "__invert__" | "__complex__" | "__int__" | "__float__" | "__index__" | "__trunc__" | "__floor__" | "__ceil__" | "__enter__" | "__aenter__" | "__getnewargs_ex__" | "__getnewargs__" | "__getstate__" - | "__reduce__" | "__copy__" | "__unicode__" | "__nonzero__" | "__await__" - | "__aiter__" | "__anext__" | "__fspath__" | "__subclasses__" => { - Some(ExpectedParams::Fixed(0)) - } + | "__reduce__" | "__copy__" | "__await__" | "__aiter__" | "__anext__" + | "__fspath__" | "__subclasses__" | "__next__" => Some(ExpectedParams::Fixed(0)), "__format__" | "__lt__" | "__le__" | "__eq__" | "__ne__" | "__gt__" | "__ge__" | "__getattr__" | "__getattribute__" | "__delattr__" | "__delete__" | "__instancecheck__" | "__subclasscheck__" | "__getitem__" | "__missing__" @@ -37,8 +35,9 @@ impl ExpectedParams { | "__rpow__" | "__rlshift__" | "__rrshift__" | "__rand__" | "__rxor__" | "__ror__" | "__iadd__" | "__isub__" | "__imul__" | "__itruediv__" | "__ifloordiv__" | "__imod__" | "__ilshift__" | "__irshift__" | "__iand__" | "__ixor__" | "__ior__" - | "__ipow__" | "__setstate__" | "__reduce_ex__" | "__deepcopy__" | "__cmp__" - | "__matmul__" | "__rmatmul__" | "__imatmul__" | "__div__" => { + | "__ipow__" | "__setstate__" | "__reduce_ex__" | "__deepcopy__" | "__matmul__" + | "__rmatmul__" | "__imatmul__" | "__buffer__" | "__class_getitem__" + | "__mro_entries__" | "__release_buffer__" | "__subclasshook__" => { Some(ExpectedParams::Fixed(1)) } "__setattr__" | "__get__" | "__set__" | "__setitem__" | "__set_name__" => { @@ -110,8 +109,8 @@ impl ExpectedParams { /// /// ## References /// - [Python documentation: Data model](https://docs.python.org/3/reference/datamodel.html) -#[violation] -pub struct UnexpectedSpecialMethodSignature { +#[derive(ViolationMetadata)] +pub(crate) struct UnexpectedSpecialMethodSignature { method_name: String, expected_params: ExpectedParams, actual_params: usize, @@ -137,7 +136,7 @@ impl Violation for UnexpectedSpecialMethodSignature { /// PLE0302 pub(crate) fn unexpected_special_method_signature( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, name: &str, decorator_list: &[Decorator], @@ -147,11 +146,8 @@ pub(crate) fn unexpected_special_method_signature( return; } - // Ignore methods with positional-only or keyword-only parameters, or variadic parameters. - if !parameters.posonlyargs.is_empty() - || !parameters.kwonlyargs.is_empty() - || parameters.kwarg.is_some() - { + // Ignore methods with keyword-only parameters or variadic parameters. + if !parameters.kwonlyargs.is_empty() || parameters.kwarg.is_some() { return; } @@ -160,10 +156,11 @@ pub(crate) fn unexpected_special_method_signature( return; } - let actual_params = parameters.args.len(); + let actual_params = parameters.args.len() + parameters.posonlyargs.len(); let mandatory_params = parameters .args .iter() + .chain(parameters.posonlyargs.iter()) .filter(|arg| arg.default.is_none()) .count(); @@ -189,7 +186,7 @@ pub(crate) fn unexpected_special_method_signature( }; if !valid_signature { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnexpectedSpecialMethodSignature { method_name: name.to_owned(), expected_params, diff --git a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dict_index_lookup.rs b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dict_index_lookup.rs index f6929ae9dc54c..46e2485c65264 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dict_index_lookup.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dict_index_lookup.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, Expr, StmtFor}; use ruff_text_size::Ranged; @@ -30,22 +30,22 @@ use crate::rules::pylint::helpers::SequenceIndexVisitor; /// for fruit_name, fruit_count in FRUITS.items(): /// print(fruit_count) /// ``` -#[violation] -pub struct UnnecessaryDictIndexLookup; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDictIndexLookup; impl AlwaysFixableViolation for UnnecessaryDictIndexLookup { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary lookup of dictionary value by key") + "Unnecessary lookup of dictionary value by key".to_string() } fn fix_title(&self) -> String { - format!("Use existing variable") + "Use existing variable".to_string() } } /// PLR1733 -pub(crate) fn unnecessary_dict_index_lookup(checker: &mut Checker, stmt_for: &StmtFor) { +pub(crate) fn unnecessary_dict_index_lookup(checker: &Checker, stmt_for: &StmtFor) { let Some((dict_name, index_name, value_name)) = dict_items(&stmt_for.iter, &stmt_for.target) else { return; @@ -64,12 +64,12 @@ pub(crate) fn unnecessary_dict_index_lookup(checker: &mut Checker, stmt_for: &St Edit::range_replacement(value_name.id.to_string(), range), [noop(index_name), noop(value_name)], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// PLR1733 -pub(crate) fn unnecessary_dict_index_lookup_comprehension(checker: &mut Checker, expr: &Expr) { +pub(crate) fn unnecessary_dict_index_lookup_comprehension(checker: &Checker, expr: &Expr) { let (Expr::Generator(ast::ExprGenerator { elt, generators, .. }) @@ -109,7 +109,7 @@ pub(crate) fn unnecessary_dict_index_lookup_comprehension(checker: &mut Checker, Edit::range_replacement(value_name.id.to_string(), range), [noop(index_name), noop(value_name)], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_direct_lambda_call.rs b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_direct_lambda_call.rs index 510f8292effcd..bf4cb4afc141e 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_direct_lambda_call.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_direct_lambda_call.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -25,21 +25,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Lambdas](https://docs.python.org/3/reference/expressions.html#lambda) -#[violation] -pub struct UnnecessaryDirectLambdaCall; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDirectLambdaCall; impl Violation for UnnecessaryDirectLambdaCall { #[derive_message_formats] fn message(&self) -> String { - format!("Lambda expression called directly. Execute the expression inline instead.") + "Lambda expression called directly. Execute the expression inline instead.".to_string() } } /// PLC3002 -pub(crate) fn unnecessary_direct_lambda_call(checker: &mut Checker, expr: &Expr, func: &Expr) { +pub(crate) fn unnecessary_direct_lambda_call(checker: &Checker, expr: &Expr, func: &Expr) { if let Expr::Lambda(_) = func { - checker - .diagnostics - .push(Diagnostic::new(UnnecessaryDirectLambdaCall, expr.range())); + checker.report_diagnostic(Diagnostic::new(UnnecessaryDirectLambdaCall, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dunder_call.rs b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dunder_call.rs index 73bd449aa84fb..8295e7d6af39d 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dunder_call.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_dunder_call.rs @@ -1,12 +1,12 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, Stmt}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, OperatorPrecedence, Stmt}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::rules::pylint::helpers::is_known_dunder_method; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for explicit use of dunder methods, like `__str__` and `__add__`. @@ -15,6 +15,34 @@ use crate::settings::types::PythonVersion; /// Dunder names are not meant to be called explicitly and, in most cases, can /// be replaced with builtins or operators. /// +/// ## Fix safety +/// This fix is always unsafe. When replacing dunder method calls with operators +/// or builtins, the behavior can change in the following ways: +/// +/// 1. Types may implement only a subset of related dunder methods. Calling a +/// missing dunder method directly returns `NotImplemented`, but using the +/// equivalent operator raises a `TypeError`. +/// ```python +/// class C: pass +/// c = C() +/// c.__gt__(1) # before fix: NotImplemented +/// c > 1 # after fix: raises TypeError +/// ``` +/// 2. Instance-assigned dunder methods are ignored by operators and builtins. +/// ```python +/// class C: pass +/// c = C() +/// c.__bool__ = lambda: False +/// c.__bool__() # before fix: False +/// bool(c) # after fix: True +/// ``` +/// +/// 3. Even with built-in types, behavior can differ. +/// ```python +/// (1).__gt__(1.0) # before fix: NotImplemented +/// 1 > 1.0 # after fix: False +/// ``` +/// /// ## Example /// ```python /// three = (3.0).__str__() @@ -35,8 +63,8 @@ use crate::settings::types::PythonVersion; /// return x > 2 /// ``` /// -#[violation] -pub struct UnnecessaryDunderCall { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDunderCall { method: String, replacement: Option<String>, } @@ -65,7 +93,7 @@ impl Violation for UnnecessaryDunderCall { } /// PLC2801 -pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_dunder_call(checker: &Checker, call: &ast::ExprCall) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = call.func.as_ref() else { return; }; @@ -76,7 +104,7 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal } // If this is an allowed dunder method, abort. - if allowed_dunder_constants(attr, checker.settings.target_version) { + if allowed_dunder_constants(attr, checker.target_version()) { return; } @@ -107,7 +135,9 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal return; } - let mut fixed: Option<String> = None; + // If a fix is available, we'll store the text of the fixed expression here + // along with the precedence of the resulting expression. + let mut fixed: Option<(String, OperatorPrecedence)> = None; let mut title: Option<String> = None; if let Some(dunder) = DunderReplacement::from_method(attr) { @@ -116,37 +146,52 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal if !checker.semantic().has_builtin_binding(replacement) { return; } - fixed = Some(format!( - "{}({})", - replacement, - checker.locator().slice(value.as_ref()), + fixed = Some(( + format!( + "{}({})", + replacement, + checker.locator().slice(value.as_ref()), + ), + OperatorPrecedence::CallAttribute, )); title = Some(message.to_string()); } - ([arg], DunderReplacement::Operator(replacement, message)) => { + ([arg], DunderReplacement::Operator(replacement, message, precedence)) => { let value_slice = checker.locator().slice(value.as_ref()); let arg_slice = checker.locator().slice(arg); - if can_be_represented_without_parentheses(arg) { + if OperatorPrecedence::from_expr(arg) > precedence { // if it's something that can reasonably be removed from parentheses, // we'll do that. - fixed = Some(format!("{value_slice} {replacement} {arg_slice}")); + fixed = Some(( + format!("{value_slice} {replacement} {arg_slice}"), + precedence, + )); } else { - fixed = Some(format!("{value_slice} {replacement} ({arg_slice})")); + fixed = Some(( + format!("{value_slice} {replacement} ({arg_slice})"), + precedence, + )); } title = Some(message.to_string()); } - ([arg], DunderReplacement::ROperator(replacement, message)) => { + ([arg], DunderReplacement::ROperator(replacement, message, precedence)) => { let value_slice = checker.locator().slice(value.as_ref()); let arg_slice = checker.locator().slice(arg); - if arg.is_attribute_expr() || arg.is_name_expr() || arg.is_literal_expr() { + if OperatorPrecedence::from_expr(arg) > precedence { // if it's something that can reasonably be removed from parentheses, // we'll do that. - fixed = Some(format!("{arg_slice} {replacement} {value_slice}")); + fixed = Some(( + format!("{arg_slice} {replacement} {value_slice}"), + precedence, + )); } else { - fixed = Some(format!("({arg_slice}) {replacement} {value_slice}")); + fixed = Some(( + format!("({arg_slice}) {replacement} {value_slice}"), + precedence, + )); } title = Some(message.to_string()); } @@ -165,16 +210,23 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal call.range(), ); - if let Some(mut fixed) = fixed { - // by the looks of it, we don't need to wrap the expression in parens if - // it's the only argument to a call expression. - // being in any other kind of expression though, we *will* add parens. - // e.g. `print(a.__add__(3))` -> `print(a + 3)` instead of `print((a + 3))` - // a multiplication expression example: `x = 2 * a.__add__(3)` -> `x = 2 * (a + 3)` - let wrap_in_paren = checker - .semantic() - .current_expression_parent() - .is_some_and(|parent| !can_be_represented_without_parentheses(parent)); + if let Some((mut fixed, precedence)) = fixed { + let dunder = DunderReplacement::from_method(attr); + + // We never need to wrap builtin functions in extra parens + // since function calls have high precedence + let wrap_in_paren = (!matches!(dunder, Some(DunderReplacement::Builtin(_,_)))) + // If parent expression has higher precedence then the new replacement, + // it would associate with either the left operand (e.g. naive change from `a * b.__add__(c)` + // becomes `a * b + c` which is incorrect) or the right operand (e.g. naive change from + // `a.__add__(b).attr` becomes `a + b.attr` which is also incorrect). + // This rule doesn't apply to function calls despite them having higher + // precedence than any of our replacement, since they already wrap around + // our expression e.g. `print(a.__add__(3))` -> `print(a + 3)` + && checker + .semantic() + .current_expression_parent() + .is_some_and(|parent| !parent.is_call_expr() && OperatorPrecedence::from_expr(parent) > precedence); if wrap_in_paren { fixed = format!("({fixed})"); @@ -184,9 +236,9 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal fixed, call.range(), ))); - }; + } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Return `true` if this is a dunder method that is allowed to be called explicitly. @@ -224,7 +276,7 @@ fn allowed_dunder_constants(dunder_method: &str, target_version: PythonVersion) return true; } - if target_version < PythonVersion::Py310 && matches!(dunder_method, "__aiter__" | "__anext__") { + if target_version < PythonVersion::PY310 && matches!(dunder_method, "__aiter__" | "__anext__") { return true; } @@ -234,9 +286,9 @@ fn allowed_dunder_constants(dunder_method: &str, target_version: PythonVersion) #[derive(Debug, Copy, Clone)] enum DunderReplacement { /// A dunder method that is an operator. - Operator(&'static str, &'static str), + Operator(&'static str, &'static str, OperatorPrecedence), /// A dunder method that is a right-side operator. - ROperator(&'static str, &'static str), + ROperator(&'static str, &'static str, OperatorPrecedence), /// A dunder method that is a builtin. Builtin(&'static str, &'static str), /// A dunder method that is a message only. @@ -246,48 +298,212 @@ enum DunderReplacement { impl DunderReplacement { fn from_method(dunder_method: &str) -> Option<Self> { match dunder_method { - "__add__" => Some(Self::Operator("+", "Use `+` operator")), - "__and__" => Some(Self::Operator("&", "Use `&` operator")), - "__contains__" => Some(Self::Operator("in", "Use `in` operator")), - "__eq__" => Some(Self::Operator("==", "Use `==` operator")), - "__floordiv__" => Some(Self::Operator("//", "Use `//` operator")), - "__ge__" => Some(Self::Operator(">=", "Use `>=` operator")), - "__gt__" => Some(Self::Operator(">", "Use `>` operator")), - "__iadd__" => Some(Self::Operator("+=", "Use `+=` operator")), - "__iand__" => Some(Self::Operator("&=", "Use `&=` operator")), - "__ifloordiv__" => Some(Self::Operator("//=", "Use `//=` operator")), - "__ilshift__" => Some(Self::Operator("<<=", "Use `<<=` operator")), - "__imod__" => Some(Self::Operator("%=", "Use `%=` operator")), - "__imul__" => Some(Self::Operator("*=", "Use `*=` operator")), - "__ior__" => Some(Self::Operator("|=", "Use `|=` operator")), - "__ipow__" => Some(Self::Operator("**=", "Use `**=` operator")), - "__irshift__" => Some(Self::Operator(">>=", "Use `>>=` operator")), - "__isub__" => Some(Self::Operator("-=", "Use `-=` operator")), - "__itruediv__" => Some(Self::Operator("/=", "Use `/=` operator")), - "__ixor__" => Some(Self::Operator("^=", "Use `^=` operator")), - "__le__" => Some(Self::Operator("<=", "Use `<=` operator")), - "__lshift__" => Some(Self::Operator("<<", "Use `<<` operator")), - "__lt__" => Some(Self::Operator("<", "Use `<` operator")), - "__mod__" => Some(Self::Operator("%", "Use `%` operator")), - "__mul__" => Some(Self::Operator("*", "Use `*` operator")), - "__ne__" => Some(Self::Operator("!=", "Use `!=` operator")), - "__or__" => Some(Self::Operator("|", "Use `|` operator")), - "__rshift__" => Some(Self::Operator(">>", "Use `>>` operator")), - "__sub__" => Some(Self::Operator("-", "Use `-` operator")), - "__truediv__" => Some(Self::Operator("/", "Use `/` operator")), - "__xor__" => Some(Self::Operator("^", "Use `^` operator")), - - "__radd__" => Some(Self::ROperator("+", "Use `+` operator")), - "__rand__" => Some(Self::ROperator("&", "Use `&` operator")), - "__rfloordiv__" => Some(Self::ROperator("//", "Use `//` operator")), - "__rlshift__" => Some(Self::ROperator("<<", "Use `<<` operator")), - "__rmod__" => Some(Self::ROperator("%", "Use `%` operator")), - "__rmul__" => Some(Self::ROperator("*", "Use `*` operator")), - "__ror__" => Some(Self::ROperator("|", "Use `|` operator")), - "__rrshift__" => Some(Self::ROperator(">>", "Use `>>` operator")), - "__rsub__" => Some(Self::ROperator("-", "Use `-` operator")), - "__rtruediv__" => Some(Self::ROperator("/", "Use `/` operator")), - "__rxor__" => Some(Self::ROperator("^", "Use `^` operator")), + "__add__" => Some(Self::Operator( + "+", + "Use `+` operator", + OperatorPrecedence::AddSub, + )), + "__and__" => Some(Self::Operator( + "&", + "Use `&` operator", + OperatorPrecedence::BitAnd, + )), + "__contains__" => Some(Self::ROperator( + "in", + "Use `in` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__eq__" => Some(Self::Operator( + "==", + "Use `==` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__floordiv__" => Some(Self::Operator( + "//", + "Use `//` operator", + OperatorPrecedence::MulDivRemain, + )), + "__ge__" => Some(Self::Operator( + ">=", + "Use `>=` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__gt__" => Some(Self::Operator( + ">", + "Use `>` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__iadd__" => Some(Self::Operator( + "+=", + "Use `+=` operator", + OperatorPrecedence::Assign, + )), + "__iand__" => Some(Self::Operator( + "&=", + "Use `&=` operator", + OperatorPrecedence::Assign, + )), + "__ifloordiv__" => Some(Self::Operator( + "//=", + "Use `//=` operator", + OperatorPrecedence::Assign, + )), + "__ilshift__" => Some(Self::Operator( + "<<=", + "Use `<<=` operator", + OperatorPrecedence::Assign, + )), + "__imod__" => Some(Self::Operator( + "%=", + "Use `%=` operator", + OperatorPrecedence::Assign, + )), + "__imul__" => Some(Self::Operator( + "*=", + "Use `*=` operator", + OperatorPrecedence::Assign, + )), + "__ior__" => Some(Self::Operator( + "|=", + "Use `|=` operator", + OperatorPrecedence::Assign, + )), + "__ipow__" => Some(Self::Operator( + "**=", + "Use `**=` operator", + OperatorPrecedence::Assign, + )), + "__irshift__" => Some(Self::Operator( + ">>=", + "Use `>>=` operator", + OperatorPrecedence::Assign, + )), + "__isub__" => Some(Self::Operator( + "-=", + "Use `-=` operator", + OperatorPrecedence::Assign, + )), + "__itruediv__" => Some(Self::Operator( + "/=", + "Use `/=` operator", + OperatorPrecedence::Assign, + )), + "__ixor__" => Some(Self::Operator( + "^=", + "Use `^=` operator", + OperatorPrecedence::Assign, + )), + "__le__" => Some(Self::Operator( + "<=", + "Use `<=` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__lshift__" => Some(Self::Operator( + "<<", + "Use `<<` operator", + OperatorPrecedence::LeftRightShift, + )), + "__lt__" => Some(Self::Operator( + "<", + "Use `<` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__mod__" => Some(Self::Operator( + "%", + "Use `%` operator", + OperatorPrecedence::MulDivRemain, + )), + "__mul__" => Some(Self::Operator( + "*", + "Use `*` operator", + OperatorPrecedence::MulDivRemain, + )), + "__ne__" => Some(Self::Operator( + "!=", + "Use `!=` operator", + OperatorPrecedence::ComparisonsMembershipIdentity, + )), + "__or__" => Some(Self::Operator( + "|", + "Use `|` operator", + OperatorPrecedence::BitOr, + )), + "__rshift__" => Some(Self::Operator( + ">>", + "Use `>>` operator", + OperatorPrecedence::LeftRightShift, + )), + "__sub__" => Some(Self::Operator( + "-", + "Use `-` operator", + OperatorPrecedence::AddSub, + )), + "__truediv__" => Some(Self::Operator( + "/", + "Use `/` operator", + OperatorPrecedence::MulDivRemain, + )), + "__xor__" => Some(Self::Operator( + "^", + "Use `^` operator", + OperatorPrecedence::BitXor, + )), + + "__radd__" => Some(Self::ROperator( + "+", + "Use `+` operator", + OperatorPrecedence::AddSub, + )), + "__rand__" => Some(Self::ROperator( + "&", + "Use `&` operator", + OperatorPrecedence::BitAnd, + )), + "__rfloordiv__" => Some(Self::ROperator( + "//", + "Use `//` operator", + OperatorPrecedence::MulDivRemain, + )), + "__rlshift__" => Some(Self::ROperator( + "<<", + "Use `<<` operator", + OperatorPrecedence::LeftRightShift, + )), + "__rmod__" => Some(Self::ROperator( + "%", + "Use `%` operator", + OperatorPrecedence::MulDivRemain, + )), + "__rmul__" => Some(Self::ROperator( + "*", + "Use `*` operator", + OperatorPrecedence::MulDivRemain, + )), + "__ror__" => Some(Self::ROperator( + "|", + "Use `|` operator", + OperatorPrecedence::BitOr, + )), + "__rrshift__" => Some(Self::ROperator( + ">>", + "Use `>>` operator", + OperatorPrecedence::LeftRightShift, + )), + "__rsub__" => Some(Self::ROperator( + "-", + "Use `-` operator", + OperatorPrecedence::AddSub, + )), + "__rtruediv__" => Some(Self::ROperator( + "/", + "Use `/` operator", + OperatorPrecedence::MulDivRemain, + )), + "__rxor__" => Some(Self::ROperator( + "^", + "Use `^` operator", + OperatorPrecedence::BitXor, + )), "__aiter__" => Some(Self::Builtin("aiter", "Use `aiter()` builtin")), "__anext__" => Some(Self::Builtin("anext", "Use `anext()` builtin")), @@ -384,24 +600,3 @@ fn in_dunder_method_definition(semantic: &SemanticModel) -> bool { func_def.name.starts_with("__") && func_def.name.ends_with("__") }) } - -/// Returns `true` if the [`Expr`] can be represented without parentheses. -fn can_be_represented_without_parentheses(expr: &Expr) -> bool { - expr.is_attribute_expr() - || expr.is_name_expr() - || expr.is_literal_expr() - || expr.is_call_expr() - || expr.is_lambda_expr() - || expr.is_if_expr() - || expr.is_generator_expr() - || expr.is_subscript_expr() - || expr.is_starred_expr() - || expr.is_slice_expr() - || expr.is_dict_expr() - || expr.is_dict_comp_expr() - || expr.is_list_expr() - || expr.is_list_comp_expr() - || expr.is_tuple_expr() - || expr.is_set_comp_expr() - || expr.is_set_expr() -} diff --git a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_lambda.rs b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_lambda.rs index e42b176829bde..f677f7a80f253 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_lambda.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_lambda.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::Visitor; -use ruff_python_ast::{self as ast, visitor, Expr, ExprLambda, Parameter, ParameterWithDefault}; +use ruff_python_ast::{self as ast, Expr, ExprLambda, Parameter, ParameterWithDefault, visitor}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -43,13 +43,13 @@ use crate::checkers::ast::Checker; /// breaking change for callers that execute the lambda by passing arguments by /// name, as in: `foo(x=1, y=2)`. Since `func` does not define the arguments /// `x` and `y`, unlike the lambda, the call would raise a `TypeError`. -#[violation] -pub struct UnnecessaryLambda; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryLambda; impl AlwaysFixableViolation for UnnecessaryLambda { #[derive_message_formats] fn message(&self) -> String { - format!("Lambda may be unnecessary; consider inlining inner function") + "Lambda may be unnecessary; consider inlining inner function".to_string() } fn fix_title(&self) -> String { @@ -58,7 +58,7 @@ impl AlwaysFixableViolation for UnnecessaryLambda { } /// PLW0108 -pub(crate) fn unnecessary_lambda(checker: &mut Checker, lambda: &ExprLambda) { +pub(crate) fn unnecessary_lambda(checker: &Checker, lambda: &ExprLambda) { let ExprLambda { parameters, body, @@ -215,7 +215,7 @@ pub(crate) fn unnecessary_lambda(checker: &mut Checker, lambda: &ExprLambda) { ), Applicability::Unsafe, )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Identify all `Expr::Name` nodes in an AST. diff --git a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_list_index_lookup.rs b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_list_index_lookup.rs index 21540b1655d81..493a648b2eaf8 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unnecessary_list_index_lookup.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unnecessary_list_index_lookup.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, Expr, Int, Number, StmtFor}; use ruff_python_semantic::SemanticModel; @@ -31,22 +31,22 @@ use crate::rules::pylint::helpers::SequenceIndexVisitor; /// for index, letter in enumerate(letters): /// print(letter) /// ``` -#[violation] -pub struct UnnecessaryListIndexLookup; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryListIndexLookup; impl AlwaysFixableViolation for UnnecessaryListIndexLookup { #[derive_message_formats] fn message(&self) -> String { - format!("List index lookup in `enumerate()` loop") + "List index lookup in `enumerate()` loop".to_string() } fn fix_title(&self) -> String { - format!("Use the loop variable directly") + "Use the loop variable directly".to_string() } } /// PLR1736 -pub(crate) fn unnecessary_list_index_lookup(checker: &mut Checker, stmt_for: &StmtFor) { +pub(crate) fn unnecessary_list_index_lookup(checker: &Checker, stmt_for: &StmtFor) { let Some((sequence, index_name, value_name)) = enumerate_items(&stmt_for.iter, &stmt_for.target, checker.semantic()) else { @@ -66,12 +66,12 @@ pub(crate) fn unnecessary_list_index_lookup(checker: &mut Checker, stmt_for: &St Edit::range_replacement(value_name.id.to_string(), range), [noop(index_name), noop(value_name)], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// PLR1736 -pub(crate) fn unnecessary_list_index_lookup_comprehension(checker: &mut Checker, expr: &Expr) { +pub(crate) fn unnecessary_list_index_lookup_comprehension(checker: &Checker, expr: &Expr) { let (Expr::Generator(ast::ExprGenerator { elt, generators, .. }) @@ -110,7 +110,7 @@ pub(crate) fn unnecessary_list_index_lookup_comprehension(checker: &mut Checker, Edit::range_replacement(value_name.id.to_string(), range), [noop(index_name), noop(value_name)], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -152,15 +152,18 @@ fn enumerate_items<'a>( }; // If the `enumerate` call has a non-zero `start`, don't omit. - if !arguments.find_argument("start", 1).map_or(true, |expr| { - matches!( - expr, - Expr::NumberLiteral(ast::ExprNumberLiteral { - value: Number::Int(Int::ZERO), - .. - }) - ) - }) { + if !arguments + .find_argument_value("start", 1) + .is_none_or(|expr| { + matches!( + expr, + Expr::NumberLiteral(ast::ExprNumberLiteral { + value: Number::Int(Int::ZERO), + .. + }) + ) + }) + { return None; } diff --git a/crates/ruff_linter/src/rules/pylint/rules/unreachable.rs b/crates/ruff_linter/src/rules/pylint/rules/unreachable.rs new file mode 100644 index 0000000000000..a93fec919de7b --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/rules/unreachable.rs @@ -0,0 +1,106 @@ +use std::collections::HashSet; + +use itertools::Itertools; +use ruff_python_ast::{Identifier, Stmt}; +use ruff_python_semantic::cfg::graph::{BlockId, Condition, ControlFlowGraph, build_cfg}; +use ruff_text_size::TextRange; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for unreachable code. +/// +/// ## Why is this bad? +/// Unreachable code can be a maintenance burden without ever being used. +/// +/// ## Example +/// ```python +/// def function(): +/// if False: +/// return "unreachable" +/// return "reachable" +/// ``` +/// +/// Use instead: +/// ```python +/// def function(): +/// return "reachable" +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct UnreachableCode { + name: String, +} + +impl Violation for UnreachableCode { + #[derive_message_formats] + fn message(&self) -> String { + let UnreachableCode { name } = self; + format!("Unreachable code in `{name}`") + } +} + +pub(crate) fn in_function(checker: &Checker, name: &Identifier, body: &[Stmt]) { + let cfg = build_cfg(body); + let reachable = reachable(&cfg); + + let mut blocks = (0..cfg.num_blocks()) + .map(BlockId::from_usize) + .filter(|block| !cfg.stmts(*block).is_empty()) + .sorted_by_key(|block| cfg.range(*block).start()) + .peekable(); + + // Advance past leading reachable blocks + while blocks.next_if(|block| reachable.contains(block)).is_some() {} + + while let Some(start_block) = blocks.next() { + // Advance to next reachable block + let mut end_block = start_block; + while let Some(next_block) = blocks.next_if(|block| !reachable.contains(block)) { + end_block = next_block; + } + let start = cfg.range(start_block).start(); + let end = cfg.range(end_block).end(); + + checker.report_diagnostic(Diagnostic::new( + UnreachableCode { + name: name.to_string(), + }, + TextRange::new(start, end), + )); + } +} + +/// Returns set of block indices reachable from entry block +fn reachable(cfg: &ControlFlowGraph) -> HashSet<BlockId> { + let mut reachable = HashSet::with_capacity(cfg.num_blocks()); + let mut stack = Vec::new(); + + stack.push(cfg.initial()); + + while let Some(block) = stack.pop() { + if reachable.insert(block) { + stack.extend( + cfg.outgoing(block) + // Traverse edges that are statically known to be possible to cross. + .filter_targets_by_conditions(|cond| matches!(taken(cond), Some(true) | None)), + ); + } + } + + reachable +} + +/// Determines if `condition` is taken. +/// +/// Returns `Some(true)` if the condition is always true, e.g. `if True`, same +/// with `Some(false)` if it's never taken. If it can't be determined it returns +/// `None`, e.g. `if i == 100`. +#[expect(clippy::unnecessary_wraps)] +fn taken(condition: &Condition) -> Option<bool> { + match condition { + Condition::Always => Some(true), + } +} diff --git a/crates/ruff_linter/src/rules/pylint/rules/unspecified_encoding.rs b/crates/ruff_linter/src/rules/pylint/rules/unspecified_encoding.rs index a8a5ac69f61dd..5a114bed48ba2 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/unspecified_encoding.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/unspecified_encoding.rs @@ -1,9 +1,9 @@ use std::fmt::{Display, Formatter}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::{self as ast, Expr, StringLiteralFlags}; +use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::SemanticModel; use ruff_text_size::{Ranged, TextRange}; @@ -24,10 +24,21 @@ use crate::fix::edits::add_argument; /// encoding. [PEP 597] recommends the use of `encoding="utf-8"` as a default, /// and suggests that it may become the default in future versions of Python. /// -/// If a local-specific encoding is intended, use `encoding="local"` on +/// If a locale-specific encoding is intended, use `encoding="locale"` on /// Python 3.10 and later, or `locale.getpreferredencoding()` on earlier versions, /// to make the encoding explicit. /// +/// ## Fix safety +/// This fix is always unsafe and may change the program's behavior. It forces +/// `encoding="utf-8"` as the default, regardless of the platform’s actual default +/// encoding, which may cause `UnicodeDecodeError` on non-UTF-8 systems. +/// ```python +/// with open("test.txt") as f: +/// print(f.read()) # before fix (on UTF-8 systems): 你好，世界！ +/// with open("test.txt", encoding="utf-8") as f: +/// print(f.read()) # after fix (on Windows): UnicodeDecodeError +/// ``` +/// /// ## Example /// ```python /// open("file.txt") @@ -42,8 +53,8 @@ use crate::fix::edits::add_argument; /// - [Python documentation: `open`](https://docs.python.org/3/library/functions.html#open) /// /// [PEP 597]: https://peps.python.org/pep-0597/ -#[violation] -pub struct UnspecifiedEncoding { +#[derive(ViolationMetadata)] +pub(crate) struct UnspecifiedEncoding { function_name: String, mode: ModeArgument, } @@ -67,12 +78,12 @@ impl AlwaysFixableViolation for UnspecifiedEncoding { } fn fix_title(&self) -> String { - format!("Add explicit `encoding` argument") + "Add explicit `encoding` argument".to_string() } } /// PLW1514 -pub(crate) fn unspecified_encoding(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unspecified_encoding(checker: &Checker, call: &ast::ExprCall) { let Some((function_name, mode)) = Callee::try_from_call_expression(call, checker.semantic()) .filter(|segments| is_violation(call, segments)) .map(|segments| (segments.to_string(), segments.mode_argument())) @@ -88,7 +99,7 @@ pub(crate) fn unspecified_encoding(checker: &mut Checker, call: &ast::ExprCall) call.func.range(), ); diagnostic.set_fix(generate_keyword_fix(checker, call)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Represents the path of the function or method being called. @@ -130,9 +141,10 @@ impl<'a> Callee<'a> { match self { Callee::Qualified(qualified_name) => match qualified_name.segments() { ["" | "codecs" | "_io", "open"] => ModeArgument::Supported, - ["tempfile", "TemporaryFile" | "NamedTemporaryFile" | "SpooledTemporaryFile"] => { - ModeArgument::Supported - } + [ + "tempfile", + "TemporaryFile" | "NamedTemporaryFile" | "SpooledTemporaryFile", + ] => ModeArgument::Supported, ["io" | "_io", "TextIOWrapper"] => ModeArgument::Unsupported, _ => ModeArgument::Unsupported, }, @@ -158,16 +170,11 @@ fn generate_keyword_fix(checker: &Checker, call: &ast::ExprCall) -> Fix { Fix::unsafe_edit(add_argument( &format!( "encoding={}", - checker - .generator() - .expr(&Expr::StringLiteral(ast::ExprStringLiteral { - value: ast::StringLiteralValue::single(ast::StringLiteral { - value: "utf-8".to_string().into_boxed_str(), - flags: StringLiteralFlags::default(), - range: TextRange::default(), - }), - range: TextRange::default(), - })) + checker.generator().expr(&Expr::from(ast::StringLiteral { + value: Box::from("utf-8"), + flags: checker.default_string_flags(), + range: TextRange::default(), + })) ), &call.arguments, checker.comment_ranges(), @@ -203,19 +210,31 @@ fn is_violation(call: &ast::ExprCall, qualified_name: &Callee) -> bool { match qualified_name { Callee::Qualified(qualified_name) => match qualified_name.segments() { ["" | "codecs" | "_io", "open"] => { - if let Some(mode_arg) = call.arguments.find_argument("mode", 1) { + if let Some(mode_arg) = call.arguments.find_argument_value("mode", 1) { if is_binary_mode(mode_arg).unwrap_or(true) { // binary mode or unknown mode is no violation return false; } } + + let encoding_param_pos = match qualified_name.segments() { + // The `encoding` parameter position for `codecs.open` + ["codecs", _] => 2, + // The `encoding` parameter position for `_io.open` and the builtin `open` + _ => 3, + }; + // else mode not specified, defaults to text mode - call.arguments.find_argument("encoding", 3).is_none() + call.arguments + .find_argument_value("encoding", encoding_param_pos) + .is_none() } - ["tempfile", tempfile_class @ ("TemporaryFile" | "NamedTemporaryFile" | "SpooledTemporaryFile")] => - { + [ + "tempfile", + tempfile_class @ ("TemporaryFile" | "NamedTemporaryFile" | "SpooledTemporaryFile"), + ] => { let mode_pos = usize::from(*tempfile_class == "SpooledTemporaryFile"); - if let Some(mode_arg) = call.arguments.find_argument("mode", mode_pos) { + if let Some(mode_arg) = call.arguments.find_argument_value("mode", mode_pos) { if is_binary_mode(mode_arg).unwrap_or(true) { // binary mode or unknown mode is no violation return false; @@ -225,27 +244,27 @@ fn is_violation(call: &ast::ExprCall, qualified_name: &Callee) -> bool { return false; } call.arguments - .find_argument("encoding", mode_pos + 2) + .find_argument_value("encoding", mode_pos + 2) .is_none() } ["io" | "_io", "TextIOWrapper"] => { - call.arguments.find_argument("encoding", 1).is_none() + call.arguments.find_argument_value("encoding", 1).is_none() } _ => false, }, Callee::Pathlib(attr) => match *attr { "open" => { - if let Some(mode_arg) = call.arguments.find_argument("mode", 0) { + if let Some(mode_arg) = call.arguments.find_argument_value("mode", 0) { if is_binary_mode(mode_arg).unwrap_or(true) { // binary mode or unknown mode is no violation return false; } } // else mode not specified, defaults to text mode - call.arguments.find_argument("encoding", 2).is_none() + call.arguments.find_argument_value("encoding", 2).is_none() } - "read_text" => call.arguments.find_argument("encoding", 0).is_none(), - "write_text" => call.arguments.find_argument("encoding", 1).is_none(), + "read_text" => call.arguments.find_argument_value("encoding", 0).is_none(), + "write_text" => call.arguments.find_argument_value("encoding", 1).is_none(), _ => false, }, } diff --git a/crates/ruff_linter/src/rules/pylint/rules/useless_else_on_loop.rs b/crates/ruff_linter/src/rules/pylint/rules/useless_else_on_loop.rs index 13bee17799c8c..c2df2dfc6179e 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/useless_else_on_loop.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/useless_else_on_loop.rs @@ -2,7 +2,7 @@ use anyhow::Result; use ast::whitespace::indentation; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier; use ruff_python_ast::{self as ast, ExceptHandler, MatchCase, Stmt}; use ruff_python_codegen::Stylist; @@ -10,9 +10,9 @@ use ruff_python_index::Indexer; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::edits::adjust_indentation; -use crate::Locator; /// ## What it does /// Checks for `else` clauses on loops without a `break` statement. @@ -46,16 +46,15 @@ use crate::Locator; /// /// ## References /// - [Python documentation: `break` and `continue` Statements, and `else` Clauses on Loops](https://docs.python.org/3/tutorial/controlflow.html#break-and-continue-statements-and-else-clauses-on-loops) -#[violation] -pub struct UselessElseOnLoop; +#[derive(ViolationMetadata)] +pub(crate) struct UselessElseOnLoop; impl Violation for UselessElseOnLoop { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { - format!( - "`else` clause on loop without a `break` statement; remove the `else` and dedent its contents" - ) + "`else` clause on loop without a `break` statement; remove the `else` and dedent its contents".to_string() } fn fix_title(&self) -> Option<String> { @@ -64,12 +63,7 @@ impl Violation for UselessElseOnLoop { } /// PLW0120 -pub(crate) fn useless_else_on_loop( - checker: &mut Checker, - stmt: &Stmt, - body: &[Stmt], - orelse: &[Stmt], -) { +pub(crate) fn useless_else_on_loop(checker: &Checker, stmt: &Stmt, body: &[Stmt], orelse: &[Stmt]) { if orelse.is_empty() || loop_exits_early(body) { return; } @@ -87,7 +81,7 @@ pub(crate) fn useless_else_on_loop( checker.stylist(), ) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns `true` if the given body contains a `break` statement. diff --git a/crates/ruff_linter/src/rules/pylint/rules/useless_exception_statement.rs b/crates/ruff_linter/src/rules/pylint/rules/useless_exception_statement.rs index 52ec3af23dc95..389628325ffca 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/useless_exception_statement.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/useless_exception_statement.rs @@ -1,12 +1,12 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::SemanticModel; use ruff_python_stdlib::builtins; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for an exception that is not raised. @@ -33,35 +33,35 @@ use crate::settings::types::PythonVersion; /// ## Fix safety /// This rule's fix is marked as unsafe, as converting a useless exception /// statement to a `raise` statement will change the program's behavior. -#[violation] -pub struct UselessExceptionStatement; +#[derive(ViolationMetadata)] +pub(crate) struct UselessExceptionStatement; impl Violation for UselessExceptionStatement { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Missing `raise` statement on exception") + "Missing `raise` statement on exception".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Add `raise` keyword")) + Some("Add `raise` keyword".to_string()) } } /// PLW0133 -pub(crate) fn useless_exception_statement(checker: &mut Checker, expr: &ast::StmtExpr) { +pub(crate) fn useless_exception_statement(checker: &Checker, expr: &ast::StmtExpr) { let Expr::Call(ast::ExprCall { func, .. }) = expr.value.as_ref() else { return; }; - if is_builtin_exception(func, checker.semantic(), checker.settings.target_version) { + if is_builtin_exception(func, checker.semantic(), checker.target_version()) { let mut diagnostic = Diagnostic::new(UselessExceptionStatement, expr.range()); diagnostic.set_fix(Fix::unsafe_edit(Edit::insertion( "raise ".to_string(), expr.start(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -75,6 +75,6 @@ fn is_builtin_exception( .resolve_qualified_name(expr) .is_some_and(|qualified_name| { matches!(qualified_name.segments(), ["" | "builtins", name] - if builtins::is_exception(name, target_version.minor())) + if builtins::is_exception(name, target_version.minor)) }) } diff --git a/crates/ruff_linter/src/rules/pylint/rules/useless_import_alias.rs b/crates/ruff_linter/src/rules/pylint/rules/useless_import_alias.rs index f86314a3a24fd..683682ba4b5c6 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/useless_import_alias.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/useless_import_alias.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Alias; -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -12,6 +12,11 @@ use crate::checkers::ast::Checker; /// ## Why is this bad? /// The import alias is redundant and should be removed to avoid confusion. /// +/// ## Fix safety +/// This fix is marked as always unsafe because the user may be intentionally +/// re-exporting the import. While statements like `import numpy as numpy` +/// appear redundant, they can have semantic meaning in certain contexts. +/// /// ## Example /// ```python /// import numpy as numpy @@ -21,36 +26,103 @@ use crate::checkers::ast::Checker; /// ```python /// import numpy as np /// ``` -#[violation] -pub struct UselessImportAlias; +/// +/// or +/// +/// ```python +/// import numpy +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct UselessImportAlias { + required_import_conflict: bool, +} + +impl Violation for UselessImportAlias { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for UselessImportAlias { #[derive_message_formats] fn message(&self) -> String { - format!("Import alias does not rename original package") + #[expect(clippy::if_not_else)] + if !self.required_import_conflict { + "Import alias does not rename original package".to_string() + } else { + "Required import does not rename original package.".to_string() + } } - fn fix_title(&self) -> String { - "Remove import alias".to_string() + fn fix_title(&self) -> Option<String> { + if self.required_import_conflict { + Some("Change required import or disable rule.".to_string()) + } else { + Some("Remove import alias".to_string()) + } } } /// PLC0414 -pub(crate) fn useless_import_alias(checker: &mut Checker, alias: &Alias) { +pub(crate) fn useless_import_alias(checker: &Checker, alias: &Alias) { let Some(asname) = &alias.asname else { return; }; - if alias.name.contains('.') { + if alias.name.as_str() != asname.as_str() { return; } + // A required import with a useless alias causes an infinite loop. + // See https://github.com/astral-sh/ruff/issues/14283 + let required_import_conflict = checker + .settings + .isort + .requires_module_import(alias.name.to_string(), Some(asname.to_string())); + let mut diagnostic = Diagnostic::new( + UselessImportAlias { + required_import_conflict, + }, + alias.range(), + ); + if !required_import_conflict { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + asname.to_string(), + alias.range(), + ))); + } + + checker.report_diagnostic(diagnostic); +} + +/// PLC0414 +pub(crate) fn useless_import_from_alias( + checker: &Checker, + alias: &Alias, + module: Option<&str>, + level: u32, +) { + let Some(asname) = &alias.asname else { + return; + }; if alias.name.as_str() != asname.as_str() { return; } - - let mut diagnostic = Diagnostic::new(UselessImportAlias, alias.range()); - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - asname.to_string(), + // A required import with a useless alias causes an infinite loop. + // See https://github.com/astral-sh/ruff/issues/14283 + let required_import_conflict = checker.settings.isort.requires_member_import( + module.map(str::to_string), + alias.name.to_string(), + Some(asname.to_string()), + level, + ); + let mut diagnostic = Diagnostic::new( + UselessImportAlias { + required_import_conflict, + }, alias.range(), - ))); - checker.diagnostics.push(diagnostic); + ); + + if !required_import_conflict { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + asname.to_string(), + alias.range(), + ))); + } + + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/useless_return.rs b/crates/ruff_linter/src/rules/pylint/rules/useless_return.rs index 6d51bbd4e0d5a..da0479e7deb3b 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/useless_return.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/useless_return.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::ReturnStatementVisitor; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, Expr, Stmt}; @@ -28,29 +28,29 @@ use crate::fix; /// def f(): /// print(5) /// ``` -#[violation] -pub struct UselessReturn; +#[derive(ViolationMetadata)] +pub(crate) struct UselessReturn; impl AlwaysFixableViolation for UselessReturn { #[derive_message_formats] fn message(&self) -> String { - format!("Useless `return` statement at end of function") + "Useless `return` statement at end of function".to_string() } fn fix_title(&self) -> String { - format!("Remove useless `return` statement") + "Remove useless `return` statement".to_string() } } /// PLR1711 pub(crate) fn useless_return( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, body: &[Stmt], returns: Option<&Expr>, ) { // Skip functions that have a return annotation that is not `None`. - if !returns.map_or(true, Expr::is_none_literal_expr) { + if !returns.is_none_or(Expr::is_none_literal_expr) { return; } @@ -82,10 +82,10 @@ pub(crate) fn useless_return( // Verify that the return statement is either bare or returns `None`. if !value .as_ref() - .map_or(true, |expr| expr.is_none_literal_expr()) + .is_none_or(|expr| expr.is_none_literal_expr()) { return; - }; + } // Finally: verify that there are no _other_ return statements in the function. let mut visitor = ReturnStatementVisitor::default(); @@ -99,5 +99,5 @@ pub(crate) fn useless_return( diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pylint/rules/useless_with_lock.rs b/crates/ruff_linter/src/rules/pylint/rules/useless_with_lock.rs index 3abb3a493485c..98db5eb04a9f7 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/useless_with_lock.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/useless_with_lock.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -47,18 +47,18 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `Lock Objects`](https://docs.python.org/3/library/threading.html#lock-objects) -#[violation] -pub struct UselessWithLock; +#[derive(ViolationMetadata)] +pub(crate) struct UselessWithLock; impl Violation for UselessWithLock { #[derive_message_formats] fn message(&self) -> String { - format!("Threading lock directly created in `with` statement has no effect") + "Threading lock directly created in `with` statement has no effect".to_string() } } /// PLW2101 -pub(crate) fn useless_with_lock(checker: &mut Checker, with: &ast::StmtWith) { +pub(crate) fn useless_with_lock(checker: &Checker, with: &ast::StmtWith) { for item in &with.items { let Some(call) = item.context_expr.as_call_expr() else { continue; @@ -80,8 +80,6 @@ pub(crate) fn useless_with_lock(checker: &mut Checker, with: &ast::StmtWith) { return; } - checker - .diagnostics - .push(Diagnostic::new(UselessWithLock, call.range())); + checker.report_diagnostic(Diagnostic::new(UselessWithLock, call.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/yield_from_in_async_function.rs b/crates/ruff_linter/src/rules/pylint/rules/yield_from_in_async_function.rs index 9567dfc7fc072..ab76bb65ec53e 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/yield_from_in_async_function.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/yield_from_in_async_function.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_python_semantic::ScopeKind; use ruff_text_size::Ranged; @@ -27,24 +27,22 @@ use crate::checkers::ast::Checker; /// async for number in [1, 2, 3, 4, 5]: /// yield number /// ``` -#[violation] -pub struct YieldFromInAsyncFunction; +#[derive(ViolationMetadata)] +pub(crate) struct YieldFromInAsyncFunction; impl Violation for YieldFromInAsyncFunction { #[derive_message_formats] fn message(&self) -> String { - format!("`yield from` statement in async function; use `async for` instead") + "`yield from` statement in async function; use `async for` instead".to_string() } } /// PLE1700 -pub(crate) fn yield_from_in_async_function(checker: &mut Checker, expr: &ast::ExprYieldFrom) { +pub(crate) fn yield_from_in_async_function(checker: &Checker, expr: &ast::ExprYieldFrom) { if matches!( checker.semantic().current_scope().kind, ScopeKind::Function(ast::StmtFunctionDef { is_async: true, .. }) ) { - checker - .diagnostics - .push(Diagnostic::new(YieldFromInAsyncFunction, expr.range())); + checker.report_diagnostic(Diagnostic::new(YieldFromInAsyncFunction, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/rules/yield_in_init.rs b/crates/ruff_linter/src/rules/pylint/rules/yield_in_init.rs index 1e98e5d81d7eb..a6979c769cc11 100644 --- a/crates/ruff_linter/src/rules/pylint/rules/yield_in_init.rs +++ b/crates/ruff_linter/src/rules/pylint/rules/yield_in_init.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -28,21 +28,19 @@ use crate::rules::pylint::helpers::in_dunder_method; /// /// ## References /// - [CodeQL: `py-init-method-is-generator`](https://codeql.github.com/codeql-query-help/python/py-init-method-is-generator/) -#[violation] -pub struct YieldInInit; +#[derive(ViolationMetadata)] +pub(crate) struct YieldInInit; impl Violation for YieldInInit { #[derive_message_formats] fn message(&self) -> String { - format!("`__init__` method is a generator") + "`__init__` method is a generator".to_string() } } /// PLE0100 -pub(crate) fn yield_in_init(checker: &mut Checker, expr: &Expr) { +pub(crate) fn yield_in_init(checker: &Checker, expr: &Expr) { if in_dunder_method("__init__", checker.semantic(), checker.settings) { - checker - .diagnostics - .push(Diagnostic::new(YieldInInit, expr.range())); + checker.report_diagnostic(Diagnostic::new(YieldInInit, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0105_type_name_incorrect_variance.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0105_type_name_incorrect_variance.py.snap index c65895174f3ac..c83f17fe22cb7 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0105_type_name_incorrect_variance.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0105_type_name_incorrect_variance.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs type_name_incorrect_variance.py:5:5: PLC0105 `TypeVar` name "T" does not reflect its covariance; consider renaming it to "T_co" | 3 | # Errors. -4 | +4 | 5 | T = TypeVar("T", covariant=True) | ^^^^^^^ PLC0105 6 | T = TypeVar("T", covariant=True, contravariant=False) @@ -75,14 +75,14 @@ type_name_incorrect_variance.py:12:5: PLC0105 `ParamSpec` name "P" does not refl 11 | P = ParamSpec("P", contravariant=True) 12 | P = ParamSpec("P", covariant=False, contravariant=True) | ^^^^^^^^^ PLC0105 -13 | +13 | 14 | T_co = TypeVar("T_co") | type_name_incorrect_variance.py:14:8: PLC0105 `TypeVar` name "T_co" does not reflect its invariance; consider renaming it to "T" | 12 | P = ParamSpec("P", covariant=False, contravariant=True) -13 | +13 | 14 | T_co = TypeVar("T_co") | ^^^^^^^ PLC0105 15 | T_co = TypeVar("T_co", covariant=False) @@ -193,14 +193,14 @@ type_name_incorrect_variance.py:25:8: PLC0105 `ParamSpec` name "P_co" does not r 24 | P_co = ParamSpec("P_co", contravariant=True) 25 | P_co = ParamSpec("P_co", covariant=False, contravariant=True) | ^^^^^^^^^ PLC0105 -26 | +26 | 27 | T_contra = TypeVar("T_contra") | type_name_incorrect_variance.py:27:12: PLC0105 `TypeVar` name "T_contra" does not reflect its invariance; consider renaming it to "T" | 25 | P_co = ParamSpec("P_co", covariant=False, contravariant=True) -26 | +26 | 27 | T_contra = TypeVar("T_contra") | ^^^^^^^ PLC0105 28 | T_contra = TypeVar("T_contra", covariant=False) @@ -311,8 +311,6 @@ type_name_incorrect_variance.py:38:12: PLC0105 `ParamSpec` name "P_contra" does 37 | P_contra = ParamSpec("P_contra", covariant=True) 38 | P_contra = ParamSpec("P_contra", covariant=True, contravariant=False) | ^^^^^^^^^ PLC0105 -39 | +39 | 40 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0131_type_bivariance.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0131_type_bivariance.py.snap index a1307834a0e60..f639f50c42407 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0131_type_bivariance.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0131_type_bivariance.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs type_bivariance.py:5:5: PLC0131 `TypeVar` "T" cannot be both covariant and contravariant | 3 | # Errors. -4 | +4 | 5 | T = TypeVar("T", covariant=True, contravariant=True) | ^^^^^^^ PLC0131 6 | T = TypeVar(name="T", covariant=True, contravariant=True) @@ -15,14 +15,14 @@ type_bivariance.py:6:5: PLC0131 `TypeVar` "T" cannot be both covariant and contr 5 | T = TypeVar("T", covariant=True, contravariant=True) 6 | T = TypeVar(name="T", covariant=True, contravariant=True) | ^^^^^^^ PLC0131 -7 | +7 | 8 | T = ParamSpec("T", covariant=True, contravariant=True) | type_bivariance.py:8:5: PLC0131 `ParamSpec` "T" cannot be both covariant and contravariant | 6 | T = TypeVar(name="T", covariant=True, contravariant=True) -7 | +7 | 8 | T = ParamSpec("T", covariant=True, contravariant=True) | ^^^^^^^^^ PLC0131 9 | T = ParamSpec(name="T", covariant=True, contravariant=True) @@ -33,8 +33,6 @@ type_bivariance.py:9:5: PLC0131 `ParamSpec` "T" cannot be both covariant and con 8 | T = ParamSpec("T", covariant=True, contravariant=True) 9 | T = ParamSpec(name="T", covariant=True, contravariant=True) | ^^^^^^^^^ PLC0131 -10 | +10 | 11 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0132_type_param_name_mismatch.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0132_type_param_name_mismatch.py.snap index 0a02aed58364c..f2d9025bfeade 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0132_type_param_name_mismatch.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0132_type_param_name_mismatch.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs type_param_name_mismatch.py:5:5: PLC0132 `TypeVar` name `T` does not match assigned variable name `X` | 3 | # Errors. -4 | +4 | 5 | X = TypeVar("T") | ^^^^^^^^^^^^ PLC0132 6 | X = TypeVar(name="T") @@ -15,14 +15,14 @@ type_param_name_mismatch.py:6:5: PLC0132 `TypeVar` name `T` does not match assig 5 | X = TypeVar("T") 6 | X = TypeVar(name="T") | ^^^^^^^^^^^^^^^^^ PLC0132 -7 | +7 | 8 | Y = ParamSpec("T") | type_param_name_mismatch.py:8:5: PLC0132 `ParamSpec` name `T` does not match assigned variable name `Y` | 6 | X = TypeVar(name="T") -7 | +7 | 8 | Y = ParamSpec("T") | ^^^^^^^^^^^^^^ PLC0132 9 | Y = ParamSpec(name="T") @@ -33,14 +33,14 @@ type_param_name_mismatch.py:9:5: PLC0132 `ParamSpec` name `T` does not match ass 8 | Y = ParamSpec("T") 9 | Y = ParamSpec(name="T") | ^^^^^^^^^^^^^^^^^^^ PLC0132 -10 | +10 | 11 | Z = NewType("T", int) | type_param_name_mismatch.py:11:5: PLC0132 `NewType` name `T` does not match assigned variable name `Z` | 9 | Y = ParamSpec(name="T") -10 | +10 | 11 | Z = NewType("T", int) | ^^^^^^^^^^^^^^^^^ PLC0132 12 | Z = NewType(name="T", tp=int) @@ -51,14 +51,14 @@ type_param_name_mismatch.py:12:5: PLC0132 `NewType` name `T` does not match assi 11 | Z = NewType("T", int) 12 | Z = NewType(name="T", tp=int) | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0132 -13 | +13 | 14 | Ws = TypeVarTuple("Ts") | type_param_name_mismatch.py:14:6: PLC0132 `TypeVarTuple` name `Ts` does not match assigned variable name `Ws` | 12 | Z = NewType(name="T", tp=int) -13 | +13 | 14 | Ws = TypeVarTuple("Ts") | ^^^^^^^^^^^^^^^^^^ PLC0132 15 | Ws = TypeVarTuple(name="Ts") @@ -69,8 +69,6 @@ type_param_name_mismatch.py:15:6: PLC0132 `TypeVarTuple` name `Ts` does not matc 14 | Ws = TypeVarTuple("Ts") 15 | Ws = TypeVarTuple(name="Ts") | ^^^^^^^^^^^^^^^^^^^^^^^ PLC0132 -16 | +16 | 17 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0205_single_string_slots.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0205_single_string_slots.py.snap index f3c8693a68f72..eeb9f628e5fa5 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0205_single_string_slots.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0205_single_string_slots.py.snap @@ -7,7 +7,7 @@ single_string_slots.py:3:5: PLC0205 Class `__slots__` should be a non-string ite 2 | class Foo: 3 | __slots__ = "bar" | ^^^^^^^^^^^^^^^^^ PLC0205 -4 | +4 | 5 | def __init__(self, bar): | @@ -16,7 +16,7 @@ single_string_slots.py:10:5: PLC0205 Class `__slots__` should be a non-string it 9 | class Foo: 10 | __slots__: str = "bar" | ^^^^^^^^^^^^^^^^^^^^^^ PLC0205 -11 | +11 | 12 | def __init__(self, bar): | @@ -25,8 +25,6 @@ single_string_slots.py:17:5: PLC0205 Class `__slots__` should be a non-string it 16 | class Foo: 17 | __slots__: str = f"bar" | ^^^^^^^^^^^^^^^^^^^^^^^ PLC0205 -18 | +18 | 19 | def __init__(self, bar): | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0206_dict_index_missing_items.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0206_dict_index_missing_items.py.snap index 49e59491f1f25..a2f87d2e5d357 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0206_dict_index_missing_items.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0206_dict_index_missing_items.py.snap @@ -7,61 +7,61 @@ dict_index_missing_items.py:9:1: PLC0206 Extracting value from dictionary withou 9 | / for instrument in ORCHESTRA: 10 | | print(f"{instrument}: {ORCHESTRA[instrument]}") | |___________________________________________________^ PLC0206 -11 | +11 | 12 | for instrument in ORCHESTRA: | dict_index_missing_items.py:12:1: PLC0206 Extracting value from dictionary without calling `.items()` | 10 | print(f"{instrument}: {ORCHESTRA[instrument]}") -11 | +11 | 12 | / for instrument in ORCHESTRA: 13 | | ORCHESTRA[instrument] | |_________________________^ PLC0206 -14 | +14 | 15 | for instrument in ORCHESTRA.keys(): | dict_index_missing_items.py:15:1: PLC0206 Extracting value from dictionary without calling `.items()` | 13 | ORCHESTRA[instrument] -14 | +14 | 15 | / for instrument in ORCHESTRA.keys(): 16 | | print(f"{instrument}: {ORCHESTRA[instrument]}") | |___________________________________________________^ PLC0206 -17 | +17 | 18 | for instrument in ORCHESTRA.keys(): | dict_index_missing_items.py:18:1: PLC0206 Extracting value from dictionary without calling `.items()` | 16 | print(f"{instrument}: {ORCHESTRA[instrument]}") -17 | +17 | 18 | / for instrument in ORCHESTRA.keys(): 19 | | ORCHESTRA[instrument] | |_________________________^ PLC0206 -20 | +20 | 21 | for instrument in (temp_orchestra := {"violin": "strings", "oboe": "woodwind"}): | dict_index_missing_items.py:21:1: PLC0206 Extracting value from dictionary without calling `.items()` | 19 | ORCHESTRA[instrument] -20 | +20 | 21 | / for instrument in (temp_orchestra := {"violin": "strings", "oboe": "woodwind"}): 22 | | print(f"{instrument}: {temp_orchestra[instrument]}") | |________________________________________________________^ PLC0206 -23 | +23 | 24 | for instrument in (temp_orchestra := {"violin": "strings", "oboe": "woodwind"}): | dict_index_missing_items.py:24:1: PLC0206 Extracting value from dictionary without calling `.items()` | 22 | print(f"{instrument}: {temp_orchestra[instrument]}") -23 | +23 | 24 | / for instrument in (temp_orchestra := {"violin": "strings", "oboe": "woodwind"}): 25 | | temp_orchestra[instrument] | |______________________________^ PLC0206 -26 | +26 | 27 | # # OK | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0208_iteration_over_set.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0208_iteration_over_set.py.snap index 68b9aa856d41c..952670e665756 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0208_iteration_over_set.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0208_iteration_over_set.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs iteration_over_set.py:3:13: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 1 | # Errors -2 | +2 | 3 | for item in {1}: | ^^^ PLC0208 4 | print(f"I can count to {item}!") @@ -23,7 +23,7 @@ iteration_over_set.py:3:13: PLC0208 [*] Use a sequence type instead of a `set` w iteration_over_set.py:6:13: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 4 | print(f"I can count to {item}!") -5 | +5 | 6 | for item in {"apples", "lemons", "water"}: # flags in-line set literals | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0208 7 | print(f"I like {item}.") @@ -43,7 +43,7 @@ iteration_over_set.py:6:13: PLC0208 [*] Use a sequence type instead of a `set` w iteration_over_set.py:9:13: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 7 | print(f"I like {item}.") - 8 | + 8 | 9 | for item in {1,}: | ^^^^ PLC0208 10 | print(f"I can count to {item}!") @@ -63,7 +63,7 @@ iteration_over_set.py:9:13: PLC0208 [*] Use a sequence type instead of a `set` w iteration_over_set.py:12:13: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 10 | print(f"I can count to {item}!") -11 | +11 | 12 | for item in { | _____________^ 13 | | "apples", "lemons", "water" @@ -89,10 +89,10 @@ iteration_over_set.py:12:13: PLC0208 [*] Use a sequence type instead of a `set` iteration_over_set.py:17:28: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 15 | print(f"I like {item}.") -16 | +16 | 17 | numbers_list = [i for i in {1, 2, 3}] # flags sets in list comprehensions | ^^^^^^^^^ PLC0208 -18 | +18 | 19 | numbers_set = {i for i in {1, 2, 3}} # flags sets in set comprehensions | = help: Convert to `tuple` @@ -110,10 +110,10 @@ iteration_over_set.py:17:28: PLC0208 [*] Use a sequence type instead of a `set` iteration_over_set.py:19:27: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 17 | numbers_list = [i for i in {1, 2, 3}] # flags sets in list comprehensions -18 | +18 | 19 | numbers_set = {i for i in {1, 2, 3}} # flags sets in set comprehensions | ^^^^^^^^^ PLC0208 -20 | +20 | 21 | numbers_dict = {str(i): i for i in {1, 2, 3}} # flags sets in dict comprehensions | = help: Convert to `tuple` @@ -131,10 +131,10 @@ iteration_over_set.py:19:27: PLC0208 [*] Use a sequence type instead of a `set` iteration_over_set.py:21:36: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 19 | numbers_set = {i for i in {1, 2, 3}} # flags sets in set comprehensions -20 | +20 | 21 | numbers_dict = {str(i): i for i in {1, 2, 3}} # flags sets in dict comprehensions | ^^^^^^^^^ PLC0208 -22 | +22 | 23 | numbers_gen = (i for i in {1, 2, 3}) # flags sets in generator expressions | = help: Convert to `tuple` @@ -152,10 +152,10 @@ iteration_over_set.py:21:36: PLC0208 [*] Use a sequence type instead of a `set` iteration_over_set.py:23:27: PLC0208 [*] Use a sequence type instead of a `set` when iterating over values | 21 | numbers_dict = {str(i): i for i in {1, 2, 3}} # flags sets in dict comprehensions -22 | +22 | 23 | numbers_gen = (i for i in {1, 2, 3}) # flags sets in generator expressions | ^^^^^^^^^ PLC0208 -24 | +24 | 25 | # Non-errors | = help: Convert to `tuple` @@ -168,6 +168,4 @@ iteration_over_set.py:23:27: PLC0208 [*] Use a sequence type instead of a `set` 23 |+numbers_gen = (i for i in (1, 2, 3)) # flags sets in generator expressions 24 24 | 25 25 | # Non-errors -26 26 | - - +26 26 | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0414_import_aliasing.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0414_import_aliasing.py.snap index ac761dd336862..483c266aa673a 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0414_import_aliasing.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0414_import_aliasing.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs import_aliasing.py:6:8: PLC0414 [*] Import alias does not rename original package | 4 | # 2. consider-using-from-import -5 | +5 | 6 | import collections as collections # [useless-import-alias] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0414 7 | from collections import OrderedDict as OrderedDict # [useless-import-alias] @@ -167,5 +167,3 @@ import_aliasing.py:25:21: PLC0414 [*] Import alias does not rename original pack 26 26 | from foo.bar import foobar as foo 27 27 | from .foo.bar import f as foobar 28 28 | from ............a import b # [relative-beyond-top-level] - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0415_import_outside_top_level.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0415_import_outside_top_level.py.snap index c61579d43d1d9..36490ce904468 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0415_import_outside_top_level.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0415_import_outside_top_level.py.snap @@ -62,7 +62,7 @@ import_outside_top_level.py:19:5: PLC0415 `import` should be at the top-level of 18 | class ClassWithImports: 19 | import tokenize # [import-outside-toplevel] | ^^^^^^^^^^^^^^^ PLC0415 -20 | +20 | 21 | def __init__(self): | @@ -72,5 +72,3 @@ import_outside_top_level.py:22:9: PLC0415 `import` should be at the top-level of 22 | import trace # [import-outside-toplevel] | ^^^^^^^^^^^^ PLC0415 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1802_len_as_condition.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1802_len_as_condition.py.snap new file mode 100644 index 0000000000000..2b64669ae4f89 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1802_len_as_condition.py.snap @@ -0,0 +1,470 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +len_as_condition.py:1:4: PLC1802 [*] `len('TEST')` used as condition without comparison + | +1 | if len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +2 | pass + | + = help: Remove `len` + +ℹ Safe fix +1 |-if len('TEST'): # [PLC1802] + 1 |+if 'TEST': # [PLC1802] +2 2 | pass +3 3 | +4 4 | if not len('TEST'): # [PLC1802] + +len_as_condition.py:4:8: PLC1802 [*] `len('TEST')` used as condition without comparison + | +2 | pass +3 | +4 | if not len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +5 | pass + | + = help: Remove `len` + +ℹ Safe fix +1 1 | if len('TEST'): # [PLC1802] +2 2 | pass +3 3 | +4 |-if not len('TEST'): # [PLC1802] + 4 |+if not 'TEST': # [PLC1802] +5 5 | pass +6 6 | +7 7 | z = [] + +len_as_condition.py:8:10: PLC1802 [*] `len(['T', 'E', 'S', 'T'])` used as condition without comparison + | +7 | z = [] +8 | if z and len(['T', 'E', 'S', 'T']): # [PLC1802] + | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLC1802 +9 | pass + | + = help: Remove `len` + +ℹ Safe fix +5 5 | pass +6 6 | +7 7 | z = [] +8 |-if z and len(['T', 'E', 'S', 'T']): # [PLC1802] + 8 |+if z and ['T', 'E', 'S', 'T']: # [PLC1802] +9 9 | pass +10 10 | +11 11 | if True or len('TEST'): # [PLC1802] + +len_as_condition.py:11:12: PLC1802 [*] `len('TEST')` used as condition without comparison + | + 9 | pass +10 | +11 | if True or len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +12 | pass + | + = help: Remove `len` + +ℹ Safe fix +8 8 | if z and len(['T', 'E', 'S', 'T']): # [PLC1802] +9 9 | pass +10 10 | +11 |-if True or len('TEST'): # [PLC1802] + 11 |+if True or 'TEST': # [PLC1802] +12 12 | pass +13 13 | +14 14 | if len('TEST') == 0: # Should be fine + +len_as_condition.py:53:6: PLC1802 [*] `len('TEST')` used as condition without comparison + | +51 | if z: +52 | pass +53 | elif len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +54 | pass + | + = help: Remove `len` + +ℹ Safe fix +50 50 | +51 51 | if z: +52 52 | pass +53 |-elif len('TEST'): # [PLC1802] + 53 |+elif 'TEST': # [PLC1802] +54 54 | pass +55 55 | +56 56 | if z: + +len_as_condition.py:58:10: PLC1802 [*] `len('TEST')` used as condition without comparison + | +56 | if z: +57 | pass +58 | elif not len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +59 | pass + | + = help: Remove `len` + +ℹ Safe fix +55 55 | +56 56 | if z: +57 57 | pass +58 |-elif not len('TEST'): # [PLC1802] + 58 |+elif not 'TEST': # [PLC1802] +59 59 | pass +60 60 | +61 61 | while len('TEST'): # [PLC1802] + +len_as_condition.py:61:7: PLC1802 [*] `len('TEST')` used as condition without comparison + | +59 | pass +60 | +61 | while len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +62 | pass + | + = help: Remove `len` + +ℹ Safe fix +58 58 | elif not len('TEST'): # [PLC1802] +59 59 | pass +60 60 | +61 |-while len('TEST'): # [PLC1802] + 61 |+while 'TEST': # [PLC1802] +62 62 | pass +63 63 | +64 64 | while not len('TEST'): # [PLC1802] + +len_as_condition.py:64:11: PLC1802 [*] `len('TEST')` used as condition without comparison + | +62 | pass +63 | +64 | while not len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +65 | pass + | + = help: Remove `len` + +ℹ Safe fix +61 61 | while len('TEST'): # [PLC1802] +62 62 | pass +63 63 | +64 |-while not len('TEST'): # [PLC1802] + 64 |+while not 'TEST': # [PLC1802] +65 65 | pass +66 66 | +67 67 | while z and len('TEST'): # [PLC1802] + +len_as_condition.py:67:13: PLC1802 [*] `len('TEST')` used as condition without comparison + | +65 | pass +66 | +67 | while z and len('TEST'): # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +68 | pass + | + = help: Remove `len` + +ℹ Safe fix +64 64 | while not len('TEST'): # [PLC1802] +65 65 | pass +66 66 | +67 |-while z and len('TEST'): # [PLC1802] + 67 |+while z and 'TEST': # [PLC1802] +68 68 | pass +69 69 | +70 70 | while not len('TEST') and z: # [PLC1802] + +len_as_condition.py:70:11: PLC1802 [*] `len('TEST')` used as condition without comparison + | +68 | pass +69 | +70 | while not len('TEST') and z: # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +71 | pass + | + = help: Remove `len` + +ℹ Safe fix +67 67 | while z and len('TEST'): # [PLC1802] +68 68 | pass +69 69 | +70 |-while not len('TEST') and z: # [PLC1802] + 70 |+while not 'TEST' and z: # [PLC1802] +71 71 | pass +72 72 | +73 73 | assert len('TEST') > 0 # Should be fine + +len_as_condition.py:93:12: PLC1802 [*] `len(args)` used as condition without comparison + | +92 | def github_issue_1331_v2(*args): +93 | assert len(args), args # [PLC1802] + | ^^^^^^^^^ PLC1802 +94 | +95 | def github_issue_1331_v3(*args): + | + = help: Remove `len` + +ℹ Safe fix +90 90 | assert False, len(args) # Should be fine +91 91 | +92 92 | def github_issue_1331_v2(*args): +93 |- assert len(args), args # [PLC1802] + 93 |+ assert args, args # [PLC1802] +94 94 | +95 95 | def github_issue_1331_v3(*args): +96 96 | assert len(args) or z, args # [PLC1802] + +len_as_condition.py:96:12: PLC1802 [*] `len(args)` used as condition without comparison + | +95 | def github_issue_1331_v3(*args): +96 | assert len(args) or z, args # [PLC1802] + | ^^^^^^^^^ PLC1802 +97 | +98 | def github_issue_1331_v4(*args): + | + = help: Remove `len` + +ℹ Safe fix +93 93 | assert len(args), args # [PLC1802] +94 94 | +95 95 | def github_issue_1331_v3(*args): +96 |- assert len(args) or z, args # [PLC1802] + 96 |+ assert args or z, args # [PLC1802] +97 97 | +98 98 | def github_issue_1331_v4(*args): +99 99 | assert z and len(args), args # [PLC1802] + +len_as_condition.py:99:18: PLC1802 [*] `len(args)` used as condition without comparison + | + 98 | def github_issue_1331_v4(*args): + 99 | assert z and len(args), args # [PLC1802] + | ^^^^^^^^^ PLC1802 +100 | +101 | def github_issue_1331_v5(**args): + | + = help: Remove `len` + +ℹ Safe fix +96 96 | assert len(args) or z, args # [PLC1802] +97 97 | +98 98 | def github_issue_1331_v4(*args): +99 |- assert z and len(args), args # [PLC1802] + 99 |+ assert z and args, args # [PLC1802] +100 100 | +101 101 | def github_issue_1331_v5(**args): +102 102 | assert z and len(args), args # [PLC1802] + +len_as_condition.py:102:18: PLC1802 [*] `len(args)` used as condition without comparison + | +101 | def github_issue_1331_v5(**args): +102 | assert z and len(args), args # [PLC1802] + | ^^^^^^^^^ PLC1802 +103 | +104 | b = bool(len(z)) # [PLC1802] + | + = help: Remove `len` + +ℹ Safe fix +99 99 | assert z and len(args), args # [PLC1802] +100 100 | +101 101 | def github_issue_1331_v5(**args): +102 |- assert z and len(args), args # [PLC1802] + 102 |+ assert z and args, args # [PLC1802] +103 103 | +104 104 | b = bool(len(z)) # [PLC1802] +105 105 | c = bool(len('TEST') or 42) # [PLC1802] + +len_as_condition.py:104:10: PLC1802 [*] `len(z)` used as condition without comparison + | +102 | assert z and len(args), args # [PLC1802] +103 | +104 | b = bool(len(z)) # [PLC1802] + | ^^^^^^ PLC1802 +105 | c = bool(len('TEST') or 42) # [PLC1802] + | + = help: Remove `len` + +ℹ Safe fix +101 101 | def github_issue_1331_v5(**args): +102 102 | assert z and len(args), args # [PLC1802] +103 103 | +104 |-b = bool(len(z)) # [PLC1802] + 104 |+b = bool(z) # [PLC1802] +105 105 | c = bool(len('TEST') or 42) # [PLC1802] +106 106 | +107 107 | def github_issue_1879(): + +len_as_condition.py:105:10: PLC1802 [*] `len('TEST')` used as condition without comparison + | +104 | b = bool(len(z)) # [PLC1802] +105 | c = bool(len('TEST') or 42) # [PLC1802] + | ^^^^^^^^^^^ PLC1802 +106 | +107 | def github_issue_1879(): + | + = help: Remove `len` + +ℹ Safe fix +102 102 | assert z and len(args), args # [PLC1802] +103 103 | +104 104 | b = bool(len(z)) # [PLC1802] +105 |-c = bool(len('TEST') or 42) # [PLC1802] + 105 |+c = bool('TEST' or 42) # [PLC1802] +106 106 | +107 107 | def github_issue_1879(): +108 108 | + +len_as_condition.py:126:12: PLC1802 [*] `len(range(0))` used as condition without comparison + | +124 | assert len(ClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +125 | assert len(ChildClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +126 | assert len(range(0)) # [PLC1802] + | ^^^^^^^^^^^^^ PLC1802 +127 | assert len([t + 1 for t in []]) # [PLC1802] +128 | # assert len(u + 1 for u in []) generator has no len + | + = help: Remove `len` + +ℹ Safe fix +123 123 | assert len(ChildClassWithBool()) +124 124 | assert len(ClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +125 125 | assert len(ChildClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +126 |- assert len(range(0)) # [PLC1802] + 126 |+ assert range(0) # [PLC1802] +127 127 | assert len([t + 1 for t in []]) # [PLC1802] +128 128 | # assert len(u + 1 for u in []) generator has no len +129 129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] + +len_as_condition.py:127:12: PLC1802 [*] `len([t + 1 for t in []])` used as condition without comparison + | +125 | assert len(ChildClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +126 | assert len(range(0)) # [PLC1802] +127 | assert len([t + 1 for t in []]) # [PLC1802] + | ^^^^^^^^^^^^^^^^^^^^^^^^ PLC1802 +128 | # assert len(u + 1 for u in []) generator has no len +129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] + | + = help: Remove `len` + +ℹ Safe fix +124 124 | assert len(ClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +125 125 | assert len(ChildClassWithoutBool()) # unintuitive?, in pylint: [PLC1802] +126 126 | assert len(range(0)) # [PLC1802] +127 |- assert len([t + 1 for t in []]) # [PLC1802] + 127 |+ assert [t + 1 for t in []] # [PLC1802] +128 128 | # assert len(u + 1 for u in []) generator has no len +129 129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] +130 130 | assert len(set((w + 1) for w in set())) # [PLC1802] + +len_as_condition.py:129:12: PLC1802 [*] `len({"1":(v + 1) for v in {}})` used as condition without comparison + | +127 | assert len([t + 1 for t in []]) # [PLC1802] +128 | # assert len(u + 1 for u in []) generator has no len +129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC1802 +130 | assert len(set((w + 1) for w in set())) # [PLC1802] + | + = help: Remove `len` + +ℹ Safe fix +126 126 | assert len(range(0)) # [PLC1802] +127 127 | assert len([t + 1 for t in []]) # [PLC1802] +128 128 | # assert len(u + 1 for u in []) generator has no len +129 |- assert len({"1":(v + 1) for v in {}}) # [PLC1802] + 129 |+ assert {"1":(v + 1) for v in {}} # [PLC1802] +130 130 | assert len(set((w + 1) for w in set())) # [PLC1802] +131 131 | +132 132 | + +len_as_condition.py:130:12: PLC1802 [*] `len(set((w + 1) for w in set()))` used as condition without comparison + | +128 | # assert len(u + 1 for u in []) generator has no len +129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] +130 | assert len(set((w + 1) for w in set())) # [PLC1802] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC1802 + | + = help: Remove `len` + +ℹ Safe fix +127 127 | assert len([t + 1 for t in []]) # [PLC1802] +128 128 | # assert len(u + 1 for u in []) generator has no len +129 129 | assert len({"1":(v + 1) for v in {}}) # [PLC1802] +130 |- assert len(set((w + 1) for w in set())) # [PLC1802] + 130 |+ assert set((w + 1) for w in set()) # [PLC1802] +131 131 | +132 132 | +133 133 | import numpy + +len_as_condition.py:214:8: PLC1802 [*] `len(x)` used as condition without comparison + | +212 | def inner(x:int): +213 | return x+1 +214 | if len(x): # [PLC1802] + | ^^^^^^ PLC1802 +215 | print(x) + | + = help: Remove `len` + +ℹ Safe fix +211 211 | x = [1,2,3] +212 212 | def inner(x:int): +213 213 | return x+1 +214 |- if len(x): # [PLC1802] + 214 |+ if x: # [PLC1802] +215 215 | print(x) +216 216 | +217 217 | def redefined(): + +len_as_condition.py:233:8: PLC1802 [*] `len(x)` used as condition without comparison + | +231 | if False: +232 | x = [1, 2, 3] +233 | if len(x): # [PLC1802] should be fine + | ^^^^^^ PLC1802 +234 | print(x) + | + = help: Remove `len` + +ℹ Safe fix +230 230 | def j(): +231 231 | if False: +232 232 | x = [1, 2, 3] +233 |- if len(x): # [PLC1802] should be fine + 233 |+ if x: # [PLC1802] should be fine +234 234 | print(x) +235 235 | +236 236 | # regression tests for https://github.com/astral-sh/ruff/issues/14690 + +len_as_condition.py:237:6: PLC1802 [*] `len(ascii(1))` used as condition without comparison + | +236 | # regression tests for https://github.com/astral-sh/ruff/issues/14690 +237 | bool(len(ascii(1))) + | ^^^^^^^^^^^^^ PLC1802 +238 | bool(len(sorted(""))) + | + = help: Remove `len` + +ℹ Safe fix +234 234 | print(x) +235 235 | +236 236 | # regression tests for https://github.com/astral-sh/ruff/issues/14690 +237 |-bool(len(ascii(1))) + 237 |+bool(ascii(1)) +238 238 | bool(len(sorted(""))) + +len_as_condition.py:238:6: PLC1802 [*] `len(sorted(""))` used as condition without comparison + | +236 | # regression tests for https://github.com/astral-sh/ruff/issues/14690 +237 | bool(len(ascii(1))) +238 | bool(len(sorted(""))) + | ^^^^^^^^^^^^^^^ PLC1802 + | + = help: Remove `len` + +ℹ Safe fix +235 235 | +236 236 | # regression tests for https://github.com/astral-sh/ruff/issues/14690 +237 237 | bool(len(ascii(1))) +238 |-bool(len(sorted(""))) + 238 |+bool(sorted("")) diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1901_compare_to_empty_string.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1901_compare_to_empty_string.py.snap index 3db68b79bc19c..fefbd85ebcbcd 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1901_compare_to_empty_string.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC1901_compare_to_empty_string.py.snap @@ -20,7 +20,7 @@ compare_to_empty_string.py:7:24: PLC1901 `x == ""` can be simplified to `not x` compare_to_empty_string.py:10:17: PLC1901 `y is not ""` can be simplified to `y` as an empty string is falsey | 8 | print("x is an empty string") - 9 | + 9 | 10 | if y is not "" or y != "": | ^^ PLC1901 11 | print("y is not an empty string") @@ -29,7 +29,7 @@ compare_to_empty_string.py:10:17: PLC1901 `y is not ""` can be simplified to `y` compare_to_empty_string.py:10:28: PLC1901 `y != ""` can be simplified to `y` as an empty string is falsey | 8 | print("x is an empty string") - 9 | + 9 | 10 | if y is not "" or y != "": | ^^ PLC1901 11 | print("y is not an empty string") @@ -38,10 +38,8 @@ compare_to_empty_string.py:10:28: PLC1901 `y != ""` can be simplified to `y` as compare_to_empty_string.py:13:8: PLC1901 `"" != z` can be simplified to `z` as an empty string is falsey | 11 | print("y is not an empty string") -12 | +12 | 13 | if "" != z: | ^^ PLC1901 14 | print("z is an empty string") | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2401_non_ascii_name.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2401_non_ascii_name.py.snap index 7c7ac5e96ebaf..7cae6936b6b16 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2401_non_ascii_name.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2401_non_ascii_name.py.snap @@ -25,7 +25,7 @@ non_ascii_name.py:3:1: PLC2401 Variable name `ápple_count` contains a non-ASCII 2 | ápple_count += 2 # C2401 3 | ápple_count = 3 # C2401 | ^^^^^^^^^^^ PLC2401 -4 | +4 | 5 | (ápple_count for ápple_count in y) | = help: Rename the variable using ASCII characters @@ -33,7 +33,7 @@ non_ascii_name.py:3:1: PLC2401 Variable name `ápple_count` contains a non-ASCII non_ascii_name.py:5:18: PLC2401 Variable name `ápple_count` contains a non-ASCII character | 3 | ápple_count = 3 # C2401 -4 | +4 | 5 | (ápple_count for ápple_count in y) | ^^^^^^^^^^^ PLC2401 | @@ -77,10 +77,10 @@ non_ascii_name.py:18:10: PLC2401 Variable name `ápple_count` contains a non-ASC non_ascii_name.py:21:1: PLC2401 Annotation name `ápple_count` contains a non-ASCII character | 19 | pass -20 | +20 | 21 | ápple_count: int | ^^^^^^^^^^^ PLC2401 -22 | +22 | 23 | try: | = help: Rename the variable using ASCII characters diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2403_non_ascii_module_import.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2403_non_ascii_module_import.py.snap index 6d8a7c610b873..c6f20b25ba441 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2403_non_ascii_module_import.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2403_non_ascii_module_import.py.snap @@ -12,7 +12,7 @@ non_ascii_module_import.py:1:29: PLC2403 Module alias `łos` contains a non-ASCI non_ascii_module_import.py:4:24: PLC2403 Module alias `łos` contains a non-ASCII character | 2 | from os.path import join as los # OK -3 | +3 | 4 | import os.path.join as łos # Error | ^^^ PLC2403 5 | import os.path.join as los # OK @@ -22,7 +22,7 @@ non_ascii_module_import.py:4:24: PLC2403 Module alias `łos` contains a non-ASCI non_ascii_module_import.py:7:8: PLC2403 Module name `os.path.łos` contains a non-ASCII character | 5 | import os.path.join as los # OK -6 | +6 | 7 | import os.path.łos # Error (recommend an ASCII alias) | ^^^^^^^^^^^ PLC2403 8 | import os.path.los # OK @@ -32,7 +32,7 @@ non_ascii_module_import.py:7:8: PLC2403 Module name `os.path.łos` contains a no non_ascii_module_import.py:10:21: PLC2403 Module name `łos` contains a non-ASCII character | 8 | import os.path.los # OK - 9 | + 9 | 10 | from os.path import łos # Error (recommend an ASCII alias) | ^^^ PLC2403 11 | from os.path import los # OK diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2701_import_private_name__submodule____main__.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2701_import_private_name__submodule____main__.py.snap index 1132b30cc9848..2946c74128c5d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2701_import_private_name__submodule____main__.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2701_import_private_name__submodule____main__.py.snap @@ -65,8 +65,6 @@ __main__.py:8:24: PLC2701 Private name import `_ddd` from external module `bbb.c 7 | import _aaa 8 | import bbb.ccc._ddd as eee # Panicked in https://github.com/astral-sh/ruff/pull/5920 | ^^^ PLC2701 - 9 | + 9 | 10 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2801_unnecessary_dunder_call.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2801_unnecessary_dunder_call.py.snap index 48923d03a102d..4d897e73d97b6 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2801_unnecessary_dunder_call.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC2801_unnecessary_dunder_call.py.snap @@ -729,7 +729,7 @@ unnecessary_dunder_call.py:46:6: PLC2801 [*] Unnecessary dunder call to `__add__ 45 | x = (-a).__add__(3) # PLC2801 46 | x = -(-a).__add__(3) # PLC2801 | ^^^^^^^^^^^^^^^ PLC2801 -47 | +47 | 48 | # Calls | = help: Use `+` operator @@ -749,337 +749,456 @@ unnecessary_dunder_call.py:49:7: PLC2801 Unnecessary dunder call to `__call__` 48 | # Calls 49 | print(a.__call__()) # PLC2801 (no fix, intentional) | ^^^^^^^^^^^^ PLC2801 -50 | -51 | # Lambda expressions +50 | +51 | class Foo: | -unnecessary_dunder_call.py:52:16: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. +unnecessary_dunder_call.py:63:1: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. | -51 | # Lambda expressions -52 | blah = lambda: a.__add__(1) # PLC2801 +62 | foo = Foo(1) +63 | foo.__add__(2).get_v() # PLC2801 + | ^^^^^^^^^^^^^^ PLC2801 + | + = help: Use `+` operator + +ℹ Unsafe fix +60 60 | return self.v +61 61 | +62 62 | foo = Foo(1) +63 |-foo.__add__(2).get_v() # PLC2801 + 63 |+(foo + 2).get_v() # PLC2801 +64 64 | +65 65 | +66 66 | # Lambda expressions + +unnecessary_dunder_call.py:67:16: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +66 | # Lambda expressions +67 | blah = lambda: a.__add__(1) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -53 | -54 | # If expressions +68 | +69 | # If expressions | = help: Use `+` operator ℹ Unsafe fix -49 49 | print(a.__call__()) # PLC2801 (no fix, intentional) -50 50 | -51 51 | # Lambda expressions -52 |-blah = lambda: a.__add__(1) # PLC2801 - 52 |+blah = lambda: a + 1 # PLC2801 -53 53 | -54 54 | # If expressions -55 55 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 - -unnecessary_dunder_call.py:55:7: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -54 | # If expressions -55 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 +64 64 | +65 65 | +66 66 | # Lambda expressions +67 |-blah = lambda: a.__add__(1) # PLC2801 + 67 |+blah = lambda: a + 1 # PLC2801 +68 68 | +69 69 | # If expressions +70 70 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 + +unnecessary_dunder_call.py:70:7: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +69 | # If expressions +70 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -56 | -57 | # Dict/Set/List/Tuple +71 | +72 | # Dict/Set/List/Tuple | = help: Use `+` operator ℹ Unsafe fix -52 52 | blah = lambda: a.__add__(1) # PLC2801 -53 53 | -54 54 | # If expressions -55 |-print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 - 55 |+print(a + 1 if a > 0 else a.__sub__(1)) # PLC2801 -56 56 | -57 57 | # Dict/Set/List/Tuple -58 58 | print({"a": a.__add__(1)}) # PLC2801 - -unnecessary_dunder_call.py:55:34: PLC2801 [*] Unnecessary dunder call to `__sub__`. Use `-` operator. - | -54 | # If expressions -55 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 +67 67 | blah = lambda: a.__add__(1) # PLC2801 +68 68 | +69 69 | # If expressions +70 |-print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 + 70 |+print(a + 1 if a > 0 else a.__sub__(1)) # PLC2801 +71 71 | +72 72 | # Dict/Set/List/Tuple +73 73 | print({"a": a.__add__(1)}) # PLC2801 + +unnecessary_dunder_call.py:70:34: PLC2801 [*] Unnecessary dunder call to `__sub__`. Use `-` operator. + | +69 | # If expressions +70 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -56 | -57 | # Dict/Set/List/Tuple +71 | +72 | # Dict/Set/List/Tuple | = help: Use `-` operator ℹ Unsafe fix -52 52 | blah = lambda: a.__add__(1) # PLC2801 -53 53 | -54 54 | # If expressions -55 |-print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 - 55 |+print(a.__add__(1) if a > 0 else a - 1) # PLC2801 -56 56 | -57 57 | # Dict/Set/List/Tuple -58 58 | print({"a": a.__add__(1)}) # PLC2801 - -unnecessary_dunder_call.py:58:13: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -57 | # Dict/Set/List/Tuple -58 | print({"a": a.__add__(1)}) # PLC2801 +67 67 | blah = lambda: a.__add__(1) # PLC2801 +68 68 | +69 69 | # If expressions +70 |-print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 + 70 |+print(a.__add__(1) if a > 0 else a - 1) # PLC2801 +71 71 | +72 72 | # Dict/Set/List/Tuple +73 73 | print({"a": a.__add__(1)}) # PLC2801 + +unnecessary_dunder_call.py:73:13: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +72 | # Dict/Set/List/Tuple +73 | print({"a": a.__add__(1)}) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -59 | print({a.__add__(1)}) # PLC2801 -60 | print([a.__add__(1)]) # PLC2801 +74 | print({a.__add__(1)}) # PLC2801 +75 | print([a.__add__(1)]) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -55 55 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 -56 56 | -57 57 | # Dict/Set/List/Tuple -58 |-print({"a": a.__add__(1)}) # PLC2801 - 58 |+print({"a": a + 1}) # PLC2801 -59 59 | print({a.__add__(1)}) # PLC2801 -60 60 | print([a.__add__(1)]) # PLC2801 -61 61 | print((a.__add__(1),)) # PLC2801 - -unnecessary_dunder_call.py:59:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -57 | # Dict/Set/List/Tuple -58 | print({"a": a.__add__(1)}) # PLC2801 -59 | print({a.__add__(1)}) # PLC2801 +70 70 | print(a.__add__(1) if a > 0 else a.__sub__(1)) # PLC2801 +71 71 | +72 72 | # Dict/Set/List/Tuple +73 |-print({"a": a.__add__(1)}) # PLC2801 + 73 |+print({"a": (a + 1)}) # PLC2801 +74 74 | print({a.__add__(1)}) # PLC2801 +75 75 | print([a.__add__(1)]) # PLC2801 +76 76 | print((a.__add__(1),)) # PLC2801 + +unnecessary_dunder_call.py:74:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +72 | # Dict/Set/List/Tuple +73 | print({"a": a.__add__(1)}) # PLC2801 +74 | print({a.__add__(1)}) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -60 | print([a.__add__(1)]) # PLC2801 -61 | print((a.__add__(1),)) # PLC2801 +75 | print([a.__add__(1)]) # PLC2801 +76 | print((a.__add__(1),)) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -56 56 | -57 57 | # Dict/Set/List/Tuple -58 58 | print({"a": a.__add__(1)}) # PLC2801 -59 |-print({a.__add__(1)}) # PLC2801 - 59 |+print({a + 1}) # PLC2801 -60 60 | print([a.__add__(1)]) # PLC2801 -61 61 | print((a.__add__(1),)) # PLC2801 -62 62 | - -unnecessary_dunder_call.py:60:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -58 | print({"a": a.__add__(1)}) # PLC2801 -59 | print({a.__add__(1)}) # PLC2801 -60 | print([a.__add__(1)]) # PLC2801 +71 71 | +72 72 | # Dict/Set/List/Tuple +73 73 | print({"a": a.__add__(1)}) # PLC2801 +74 |-print({a.__add__(1)}) # PLC2801 + 74 |+print({(a + 1)}) # PLC2801 +75 75 | print([a.__add__(1)]) # PLC2801 +76 76 | print((a.__add__(1),)) # PLC2801 +77 77 | + +unnecessary_dunder_call.py:75:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +73 | print({"a": a.__add__(1)}) # PLC2801 +74 | print({a.__add__(1)}) # PLC2801 +75 | print([a.__add__(1)]) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -61 | print((a.__add__(1),)) # PLC2801 +76 | print((a.__add__(1),)) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -57 57 | # Dict/Set/List/Tuple -58 58 | print({"a": a.__add__(1)}) # PLC2801 -59 59 | print({a.__add__(1)}) # PLC2801 -60 |-print([a.__add__(1)]) # PLC2801 - 60 |+print([a + 1]) # PLC2801 -61 61 | print((a.__add__(1),)) # PLC2801 -62 62 | -63 63 | # Comprehension variants - -unnecessary_dunder_call.py:61:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -59 | print({a.__add__(1)}) # PLC2801 -60 | print([a.__add__(1)]) # PLC2801 -61 | print((a.__add__(1),)) # PLC2801 +72 72 | # Dict/Set/List/Tuple +73 73 | print({"a": a.__add__(1)}) # PLC2801 +74 74 | print({a.__add__(1)}) # PLC2801 +75 |-print([a.__add__(1)]) # PLC2801 + 75 |+print([(a + 1)]) # PLC2801 +76 76 | print((a.__add__(1),)) # PLC2801 +77 77 | +78 78 | # Comprehension variants + +unnecessary_dunder_call.py:76:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +74 | print({a.__add__(1)}) # PLC2801 +75 | print([a.__add__(1)]) # PLC2801 +76 | print((a.__add__(1),)) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -62 | -63 | # Comprehension variants +77 | +78 | # Comprehension variants | = help: Use `+` operator ℹ Unsafe fix -58 58 | print({"a": a.__add__(1)}) # PLC2801 -59 59 | print({a.__add__(1)}) # PLC2801 -60 60 | print([a.__add__(1)]) # PLC2801 -61 |-print((a.__add__(1),)) # PLC2801 - 61 |+print((a + 1,)) # PLC2801 -62 62 | -63 63 | # Comprehension variants -64 64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 - -unnecessary_dunder_call.py:64:11: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -63 | # Comprehension variants -64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +73 73 | print({"a": a.__add__(1)}) # PLC2801 +74 74 | print({a.__add__(1)}) # PLC2801 +75 75 | print([a.__add__(1)]) # PLC2801 +76 |-print((a.__add__(1),)) # PLC2801 + 76 |+print(((a + 1),)) # PLC2801 +77 77 | +78 78 | # Comprehension variants +79 79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 + +unnecessary_dunder_call.py:79:11: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +78 | # Comprehension variants +79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 | print([i.__add__(1) for i in range(5)]) # PLC2801 +80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 | print([i.__add__(1) for i in range(5)]) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -61 61 | print((a.__add__(1),)) # PLC2801 -62 62 | -63 63 | # Comprehension variants -64 |-print({i: i.__add__(1) for i in range(5)}) # PLC2801 - 64 |+print({i: i + 1 for i in range(5)}) # PLC2801 -65 65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 66 | print([i.__add__(1) for i in range(5)]) # PLC2801 -67 67 | print((i.__add__(1) for i in range(5))) # PLC2801 - -unnecessary_dunder_call.py:65:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -63 | # Comprehension variants -64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 -65 | print({i.__add__(1) for i in range(5)}) # PLC2801 +76 76 | print((a.__add__(1),)) # PLC2801 +77 77 | +78 78 | # Comprehension variants +79 |-print({i: i.__add__(1) for i in range(5)}) # PLC2801 + 79 |+print({i: (i + 1) for i in range(5)}) # PLC2801 +80 80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 81 | print([i.__add__(1) for i in range(5)]) # PLC2801 +82 82 | print((i.__add__(1) for i in range(5))) # PLC2801 + +unnecessary_dunder_call.py:80:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +78 | # Comprehension variants +79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +80 | print({i.__add__(1) for i in range(5)}) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -66 | print([i.__add__(1) for i in range(5)]) # PLC2801 -67 | print((i.__add__(1) for i in range(5))) # PLC2801 +81 | print([i.__add__(1) for i in range(5)]) # PLC2801 +82 | print((i.__add__(1) for i in range(5))) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -62 62 | -63 63 | # Comprehension variants -64 64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 -65 |-print({i.__add__(1) for i in range(5)}) # PLC2801 - 65 |+print({i + 1 for i in range(5)}) # PLC2801 -66 66 | print([i.__add__(1) for i in range(5)]) # PLC2801 -67 67 | print((i.__add__(1) for i in range(5))) # PLC2801 -68 68 | - -unnecessary_dunder_call.py:66:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 -65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 | print([i.__add__(1) for i in range(5)]) # PLC2801 +77 77 | +78 78 | # Comprehension variants +79 79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +80 |-print({i.__add__(1) for i in range(5)}) # PLC2801 + 80 |+print({(i + 1) for i in range(5)}) # PLC2801 +81 81 | print([i.__add__(1) for i in range(5)]) # PLC2801 +82 82 | print((i.__add__(1) for i in range(5))) # PLC2801 +83 83 | + +unnecessary_dunder_call.py:81:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 | print([i.__add__(1) for i in range(5)]) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -67 | print((i.__add__(1) for i in range(5))) # PLC2801 +82 | print((i.__add__(1) for i in range(5))) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -63 63 | # Comprehension variants -64 64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 -65 65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 |-print([i.__add__(1) for i in range(5)]) # PLC2801 - 66 |+print([i + 1 for i in range(5)]) # PLC2801 -67 67 | print((i.__add__(1) for i in range(5))) # PLC2801 -68 68 | -69 69 | # Generators - -unnecessary_dunder_call.py:67:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 | print([i.__add__(1) for i in range(5)]) # PLC2801 -67 | print((i.__add__(1) for i in range(5))) # PLC2801 +78 78 | # Comprehension variants +79 79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +80 80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 |-print([i.__add__(1) for i in range(5)]) # PLC2801 + 81 |+print([(i + 1) for i in range(5)]) # PLC2801 +82 82 | print((i.__add__(1) for i in range(5))) # PLC2801 +83 83 | +84 84 | # Generators + +unnecessary_dunder_call.py:82:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 | print([i.__add__(1) for i in range(5)]) # PLC2801 +82 | print((i.__add__(1) for i in range(5))) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -68 | -69 | # Generators +83 | +84 | # Generators | = help: Use `+` operator ℹ Unsafe fix -64 64 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 -65 65 | print({i.__add__(1) for i in range(5)}) # PLC2801 -66 66 | print([i.__add__(1) for i in range(5)]) # PLC2801 -67 |-print((i.__add__(1) for i in range(5))) # PLC2801 - 67 |+print((i + 1 for i in range(5))) # PLC2801 -68 68 | -69 69 | # Generators -70 70 | gen = (i.__add__(1) for i in range(5)) # PLC2801 - -unnecessary_dunder_call.py:70:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -69 | # Generators -70 | gen = (i.__add__(1) for i in range(5)) # PLC2801 +79 79 | print({i: i.__add__(1) for i in range(5)}) # PLC2801 +80 80 | print({i.__add__(1) for i in range(5)}) # PLC2801 +81 81 | print([i.__add__(1) for i in range(5)]) # PLC2801 +82 |-print((i.__add__(1) for i in range(5))) # PLC2801 + 82 |+print(((i + 1) for i in range(5))) # PLC2801 +83 83 | +84 84 | # Generators +85 85 | gen = (i.__add__(1) for i in range(5)) # PLC2801 + +unnecessary_dunder_call.py:85:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +84 | # Generators +85 | gen = (i.__add__(1) for i in range(5)) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -71 | print(next(gen)) +86 | print(next(gen)) | = help: Use `+` operator ℹ Unsafe fix -67 67 | print((i.__add__(1) for i in range(5))) # PLC2801 -68 68 | -69 69 | # Generators -70 |-gen = (i.__add__(1) for i in range(5)) # PLC2801 - 70 |+gen = (i + 1 for i in range(5)) # PLC2801 -71 71 | print(next(gen)) -72 72 | -73 73 | # Subscripts - -unnecessary_dunder_call.py:74:13: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -73 | # Subscripts -74 | print({"a": a.__add__(1)}["a"]) # PLC2801 +82 82 | print((i.__add__(1) for i in range(5))) # PLC2801 +83 83 | +84 84 | # Generators +85 |-gen = (i.__add__(1) for i in range(5)) # PLC2801 + 85 |+gen = ((i + 1) for i in range(5)) # PLC2801 +86 86 | print(next(gen)) +87 87 | +88 88 | # Subscripts + +unnecessary_dunder_call.py:89:13: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +88 | # Subscripts +89 | print({"a": a.__add__(1)}["a"]) # PLC2801 | ^^^^^^^^^^^^ PLC2801 -75 | -76 | # Starred +90 | # https://github.com/astral-sh/ruff/issues/15745 +91 | print("x".__add__("y")[0]) # PLC2801 | = help: Use `+` operator ℹ Unsafe fix -71 71 | print(next(gen)) -72 72 | -73 73 | # Subscripts -74 |-print({"a": a.__add__(1)}["a"]) # PLC2801 - 74 |+print({"a": a + 1}["a"]) # PLC2801 -75 75 | -76 76 | # Starred -77 77 | print(*[a.__add__(1)]) # PLC2801 - -unnecessary_dunder_call.py:77:9: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -76 | # Starred -77 | print(*[a.__add__(1)]) # PLC2801 - | ^^^^^^^^^^^^ PLC2801 -78 | -79 | # Slices +86 86 | print(next(gen)) +87 87 | +88 88 | # Subscripts +89 |-print({"a": a.__add__(1)}["a"]) # PLC2801 + 89 |+print({"a": (a + 1)}["a"]) # PLC2801 +90 90 | # https://github.com/astral-sh/ruff/issues/15745 +91 91 | print("x".__add__("y")[0]) # PLC2801 +92 92 | + +unnecessary_dunder_call.py:91:7: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +89 | print({"a": a.__add__(1)}["a"]) # PLC2801 +90 | # https://github.com/astral-sh/ruff/issues/15745 +91 | print("x".__add__("y")[0]) # PLC2801 + | ^^^^^^^^^^^^^^^^ PLC2801 +92 | +93 | # Starred | = help: Use `+` operator ℹ Unsafe fix -74 74 | print({"a": a.__add__(1)}["a"]) # PLC2801 -75 75 | -76 76 | # Starred -77 |-print(*[a.__add__(1)]) # PLC2801 - 77 |+print(*[a + 1]) # PLC2801 -78 78 | -79 79 | # Slices -80 80 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 - -unnecessary_dunder_call.py:80:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. - | -79 | # Slices -80 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 - | ^^^^^^^^^^^^ PLC2801 +88 88 | # Subscripts +89 89 | print({"a": a.__add__(1)}["a"]) # PLC2801 +90 90 | # https://github.com/astral-sh/ruff/issues/15745 +91 |-print("x".__add__("y")[0]) # PLC2801 + 91 |+print(("x" + "y")[0]) # PLC2801 +92 92 | +93 93 | # Starred +94 94 | print(*[a.__add__(1)]) # PLC2801 + +unnecessary_dunder_call.py:94:9: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +93 | # Starred +94 | print(*[a.__add__(1)]) # PLC2801 + | ^^^^^^^^^^^^ PLC2801 +95 | +96 | list1 = [1, 2, 3] | = help: Use `+` operator ℹ Unsafe fix -77 77 | print(*[a.__add__(1)]) # PLC2801 -78 78 | -79 79 | # Slices -80 |-print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 - 80 |+print([a + 1, a.__sub__(1)][0:1]) # PLC2801 -81 81 | -82 82 | -83 83 | class Thing: +91 91 | print("x".__add__("y")[0]) # PLC2801 +92 92 | +93 93 | # Starred +94 |-print(*[a.__add__(1)]) # PLC2801 + 94 |+print(*[(a + 1)]) # PLC2801 +95 95 | +96 96 | list1 = [1, 2, 3] +97 97 | list2 = [4, 5, 6] + +unnecessary_dunder_call.py:98:9: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | + 96 | list1 = [1, 2, 3] + 97 | list2 = [4, 5, 6] + 98 | print([*list1.__add__(list2)]) # PLC2801 + | ^^^^^^^^^^^^^^^^^^^^ PLC2801 + 99 | +100 | # Slices + | + = help: Use `+` operator -unnecessary_dunder_call.py:80:22: PLC2801 [*] Unnecessary dunder call to `__sub__`. Use `-` operator. - | -79 | # Slices -80 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 - | ^^^^^^^^^^^^ PLC2801 - | - = help: Use `-` operator +ℹ Unsafe fix +95 95 | +96 96 | list1 = [1, 2, 3] +97 97 | list2 = [4, 5, 6] +98 |-print([*list1.__add__(list2)]) # PLC2801 + 98 |+print([*list1 + list2]) # PLC2801 +99 99 | +100 100 | # Slices +101 101 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 + +unnecessary_dunder_call.py:101:8: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +100 | # Slices +101 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 + | ^^^^^^^^^^^^ PLC2801 +102 | +103 | # Attribute access + | + = help: Use `+` operator ℹ Unsafe fix -77 77 | print(*[a.__add__(1)]) # PLC2801 -78 78 | -79 79 | # Slices -80 |-print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 - 80 |+print([a.__add__(1), a - 1][0:1]) # PLC2801 -81 81 | -82 82 | -83 83 | class Thing: +98 98 | print([*list1.__add__(list2)]) # PLC2801 +99 99 | +100 100 | # Slices +101 |-print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 + 101 |+print([(a + 1), a.__sub__(1)][0:1]) # PLC2801 +102 102 | +103 103 | # Attribute access +104 104 | # https://github.com/astral-sh/ruff/issues/15745 + +unnecessary_dunder_call.py:101:22: PLC2801 [*] Unnecessary dunder call to `__sub__`. Use `-` operator. + | +100 | # Slices +101 | print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 + | ^^^^^^^^^^^^ PLC2801 +102 | +103 | # Attribute access + | + = help: Use `-` operator -unnecessary_dunder_call.py:92:16: PLC2801 Unnecessary dunder call to `__getattribute__`. Access attribute directly or use getattr built-in function. - | -91 | def do_thing(self, item): -92 | return object.__getattribute__(self, item) # PLC2801 - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC2801 -93 | -94 | def use_descriptor(self, item): - | - = help: Access attribute directly or use getattr built-in function +ℹ Unsafe fix +98 98 | print([*list1.__add__(list2)]) # PLC2801 +99 99 | +100 100 | # Slices +101 |-print([a.__add__(1), a.__sub__(1)][0:1]) # PLC2801 + 101 |+print([a.__add__(1), (a - 1)][0:1]) # PLC2801 +102 102 | +103 103 | # Attribute access +104 104 | # https://github.com/astral-sh/ruff/issues/15745 + +unnecessary_dunder_call.py:105:7: PLC2801 [*] Unnecessary dunder call to `__add__`. Use `+` operator. + | +103 | # Attribute access +104 | # https://github.com/astral-sh/ruff/issues/15745 +105 | print(1j.__add__(1.0).real) # PLC2801 + | ^^^^^^^^^^^^^^^ PLC2801 +106 | +107 | class Thing: + | + = help: Use `+` operator +ℹ Unsafe fix +102 102 | +103 103 | # Attribute access +104 104 | # https://github.com/astral-sh/ruff/issues/15745 +105 |-print(1j.__add__(1.0).real) # PLC2801 + 105 |+print((1j + 1.0).real) # PLC2801 +106 106 | +107 107 | class Thing: +108 108 | def __init__(self, stuff: Any) -> None: + +unnecessary_dunder_call.py:116:16: PLC2801 Unnecessary dunder call to `__getattribute__`. Access attribute directly or use getattr built-in function. + | +115 | def do_thing(self, item): +116 | return object.__getattribute__(self, item) # PLC2801 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC2801 +117 | +118 | def use_descriptor(self, item): + | + = help: Access attribute directly or use getattr built-in function + +unnecessary_dunder_call.py:128:1: PLC2801 [*] Unnecessary dunder call to `__contains__`. Use `in` operator. + | +126 | blah = dict[{"a": 1}.__delitem__("a")] # OK +127 | +128 | "abc".__contains__("a") + | ^^^^^^^^^^^^^^^^^^^^^^^ PLC2801 +129 | +130 | # https://github.com/astral-sh/ruff/issues/14597 + | + = help: Use `in` operator +ℹ Unsafe fix +125 125 | +126 126 | blah = dict[{"a": 1}.__delitem__("a")] # OK +127 127 | +128 |-"abc".__contains__("a") + 128 |+"a" in "abc" +129 129 | +130 130 | # https://github.com/astral-sh/ruff/issues/14597 +131 131 | assert "abc".__str__() == "abc" + +unnecessary_dunder_call.py:131:8: PLC2801 [*] Unnecessary dunder call to `__str__`. Use `str()` builtin. + | +130 | # https://github.com/astral-sh/ruff/issues/14597 +131 | assert "abc".__str__() == "abc" + | ^^^^^^^^^^^^^^^ PLC2801 + | + = help: Use `str()` builtin + +ℹ Unsafe fix +128 128 | "abc".__contains__("a") +129 129 | +130 130 | # https://github.com/astral-sh/ruff/issues/14597 +131 |-assert "abc".__str__() == "abc" + 131 |+assert str("abc") == "abc" diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC3002_unnecessary_direct_lambda_call.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC3002_unnecessary_direct_lambda_call.py.snap index d7a4c18d211d1..d80235c4b6432 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC3002_unnecessary_direct_lambda_call.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLC3002_unnecessary_direct_lambda_call.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs unnecessary_direct_lambda_call.py:4:5: PLC3002 Lambda expression called directly. Execute the expression inline instead. | 2 | # pylint: disable=undefined-variable, line-too-long -3 | +3 | 4 | y = (lambda x: x**2 + 2*x + 1)(a) # [unnecessary-direct-lambda-call] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC3002 5 | y = max((lambda x: x**2)(a), (lambda x: x+1)(a)) # [unnecessary-direct-lambda-call,unnecessary-direct-lambda-call] @@ -23,5 +23,3 @@ unnecessary_direct_lambda_call.py:5:30: PLC3002 Lambda expression called directl 5 | y = max((lambda x: x**2)(a), (lambda x: x+1)(a)) # [unnecessary-direct-lambda-call,unnecessary-direct-lambda-call] | ^^^^^^^^^^^^^^^^^^ PLC3002 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0100_yield_in_init.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0100_yield_in_init.py.snap index a554c0200bfbe..7fefeeb11b8e6 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0100_yield_in_init.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0100_yield_in_init.py.snap @@ -15,8 +15,6 @@ yield_in_init.py:14:9: PLE0100 `__init__` method is a generator 13 | def __init__(self): 14 | yield from self.gen() | ^^^^^^^^^^^^^^^^^^^^^ PLE0100 -15 | +15 | 16 | def gen(self): | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0101_return_in_init.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0101_return_in_init.py.snap index c4866362ec190..79ae8f1ae639e 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0101_return_in_init.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0101_return_in_init.py.snap @@ -7,7 +7,7 @@ return_in_init.py:14:9: PLE0101 Explicit return in `__init__` 13 | def __init__(self): 14 | return 3 | ^^^^^^^^ PLE0101 -15 | +15 | 16 | def gen(self): | @@ -16,8 +16,6 @@ return_in_init.py:22:9: PLE0101 Explicit return in `__init__` 21 | def __init__(self): 22 | return 1 | ^^^^^^^^ PLE0101 -23 | +23 | 24 | class MyClass2: | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0115_nonlocal_and_global.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0115_nonlocal_and_global.py.snap index 9ea0e9ace3249..9bcbce8cfff32 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0115_nonlocal_and_global.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0115_nonlocal_and_global.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- nonlocal_and_global.py:7:12: PLE0115 Name `counter` is both `nonlocal` and `global` | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0116_continue_in_finally.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0116_continue_in_finally.py.snap index 6c123427ab2b8..d87d6848ea039 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0116_continue_in_finally.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0116_continue_in_finally.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0117_nonlocal_without_binding.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0117_nonlocal_without_binding.py.snap index 6628e255a96f9..4e375e6b6abb1 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0117_nonlocal_without_binding.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0117_nonlocal_without_binding.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- nonlocal_without_binding.py:5:14: PLE0117 Nonlocal name `x` found without binding | @@ -21,5 +22,3 @@ nonlocal_without_binding.py:19:18: PLE0117 Nonlocal name `y` found without bindi 19 | nonlocal y | ^ PLE0117 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0118_load_before_global_declaration.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0118_load_before_global_declaration.py.snap index b754822615a50..adabada987380 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0118_load_before_global_declaration.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0118_load_before_global_declaration.py.snap @@ -7,17 +7,17 @@ load_before_global_declaration.py:5:11: PLE0118 Name `x` is used prior to global 4 | def f(): 5 | print(x) | ^ PLE0118 -6 | +6 | 7 | global x | load_before_global_declaration.py:15:11: PLE0118 Name `x` is used prior to global declaration on line 17 | 13 | global x -14 | +14 | 15 | print(x) | ^ PLE0118 -16 | +16 | 17 | global x | @@ -26,17 +26,17 @@ load_before_global_declaration.py:23:11: PLE0118 Name `x` is used prior to globa 22 | def f(): 23 | print(x) | ^ PLE0118 -24 | +24 | 25 | global x, y | load_before_global_declaration.py:33:11: PLE0118 Name `x` is used prior to global declaration on line 35 | 31 | global x, y -32 | +32 | 33 | print(x) | ^ PLE0118 -34 | +34 | 35 | global x, y | @@ -45,17 +45,17 @@ load_before_global_declaration.py:41:5: PLE0118 Name `x` is used prior to global 40 | def f(): 41 | x = 1 | ^ PLE0118 -42 | +42 | 43 | global x | load_before_global_declaration.py:51:5: PLE0118 Name `x` is used prior to global declaration on line 53 | 49 | global x -50 | +50 | 51 | x = 1 | ^ PLE0118 -52 | +52 | 53 | global x | @@ -64,17 +64,17 @@ load_before_global_declaration.py:59:9: PLE0118 Name `x` is used prior to global 58 | def f(): 59 | del x | ^ PLE0118 -60 | +60 | 61 | global x, y | load_before_global_declaration.py:69:9: PLE0118 Name `x` is used prior to global declaration on line 71 | 67 | global x, y -68 | +68 | 69 | del x | ^ PLE0118 -70 | +70 | 71 | global x, y | @@ -83,17 +83,17 @@ load_before_global_declaration.py:77:9: PLE0118 Name `x` is used prior to global 76 | def f(): 77 | del x | ^ PLE0118 -78 | +78 | 79 | global x | load_before_global_declaration.py:87:9: PLE0118 Name `x` is used prior to global declaration on line 89 | 85 | global x -86 | +86 | 87 | del x | ^ PLE0118 -88 | +88 | 89 | global x | @@ -102,17 +102,17 @@ load_before_global_declaration.py:95:9: PLE0118 Name `x` is used prior to global 94 | def f(): 95 | del x | ^ PLE0118 -96 | +96 | 97 | global x, y | load_before_global_declaration.py:105:9: PLE0118 Name `x` is used prior to global declaration on line 107 | 103 | global x, y -104 | +104 | 105 | del x | ^ PLE0118 -106 | +106 | 107 | global x, y | @@ -124,4 +124,10 @@ load_before_global_declaration.py:113:14: PLE0118 Name `x` is used prior to glob 114 | global x | - +load_before_global_declaration.py:162:1: PLE0118 Name `x` is used prior to global declaration on line 163 + | +161 | # surprisingly still an error, global in module scope +162 | x = None + | ^ PLE0118 +163 | global x + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0237_non_slot_assignment.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0237_non_slot_assignment.py.snap index 6b0fc3d4a2b77..f053c56e66dab 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0237_non_slot_assignment.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0237_non_slot_assignment.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- non_slot_assignment.py:6:9: PLE0237 Attribute `surname` is not defined in class's `__slots__` | @@ -27,5 +28,3 @@ non_slot_assignment.py:42:9: PLE0237 Attribute `middle_name` is not defined in c | ^^^^^^^^^^^^^^^^ PLE0237 43 | self.setup() | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0241_duplicate_bases.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0241_duplicate_bases.py.snap index f939250ceb6f3..ca3062908ba7d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0241_duplicate_bases.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0241_duplicate_bases.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- duplicate_bases.py:13:13: PLE0241 [*] Duplicate base `A` for class `F1` | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0302_unexpected_special_method_signature.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0302_unexpected_special_method_signature.py.snap index 54467d8adab53..c97826b90fa66 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0302_unexpected_special_method_signature.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0302_unexpected_special_method_signature.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs unexpected_special_method_signature.py:5:9: PLE0302 The special method `__bool__` expects 1 parameter, 2 were given | 3 | ... -4 | +4 | 5 | def __bool__(self, x): # too many mandatory args | ^^^^^^^^ PLE0302 6 | ... @@ -21,7 +21,7 @@ unexpected_special_method_signature.py:19:9: PLE0302 The special method `__bool_ unexpected_special_method_signature.py:32:9: PLE0302 The special method `__eq__` expects 2 parameters, 1 was given | 30 | ... -31 | +31 | 32 | def __eq__(self): # too few mandatory args | ^^^^^^ PLE0302 33 | ... @@ -30,7 +30,7 @@ unexpected_special_method_signature.py:32:9: PLE0302 The special method `__eq__` unexpected_special_method_signature.py:35:9: PLE0302 The special method `__eq__` expects 2 parameters, 3 were given | 33 | ... -34 | +34 | 35 | def __eq__(self, other, other_other): # too many mandatory args | ^^^^^^ PLE0302 36 | ... @@ -39,7 +39,7 @@ unexpected_special_method_signature.py:35:9: PLE0302 The special method `__eq__` unexpected_special_method_signature.py:44:9: PLE0302 The special method `__round__` expects between 1 and 2 parameters, 3 were given | 42 | ... -43 | +43 | 44 | def __round__(self, x, y): # disallow 2 args | ^^^^^^^^^ PLE0302 45 | ... @@ -48,7 +48,7 @@ unexpected_special_method_signature.py:44:9: PLE0302 The special method `__round unexpected_special_method_signature.py:47:9: PLE0302 The special method `__round__` expects between 1 and 2 parameters, 4 were given | 45 | ... -46 | +46 | 47 | def __round__(self, x, y, z=2): # disallow 3 args even when one is optional | ^^^^^^^^^ PLE0302 48 | ... @@ -57,7 +57,7 @@ unexpected_special_method_signature.py:47:9: PLE0302 The special method `__round unexpected_special_method_signature.py:56:9: PLE0302 The special method `__eq__` expects 2 parameters, 3 were given | 54 | ... -55 | +55 | 56 | def __eq__(self, x, y, *args): # too many args with *args | ^^^^^^ PLE0302 57 | ... @@ -66,10 +66,80 @@ unexpected_special_method_signature.py:56:9: PLE0302 The special method `__eq__` unexpected_special_method_signature.py:65:9: PLE0302 The special method `__round__` expects between 1 and 2 parameters, 3 were given | 63 | ... -64 | +64 | 65 | def __round__(self, x, y, *args): # disallow 2 args | ^^^^^^^^^ PLE0302 66 | ... | +unexpected_special_method_signature.py:89:9: PLE0302 The special method `__next__` expects 1 parameter, 2 were given + | +87 | ... +88 | +89 | def __next__(self, x): # #16217 assert special method is linted, expects 1 parameter + | ^^^^^^^^ PLE0302 +90 | ... + | + +unexpected_special_method_signature.py:92:9: PLE0302 The special method `__buffer__` expects 2 parameters, 1 was given + | +90 | ... +91 | +92 | def __buffer__(self): # #16217 assert special method is linted, expects 2 parameters + | ^^^^^^^^^^ PLE0302 +93 | ... + | + +unexpected_special_method_signature.py:95:9: PLE0302 The special method `__class_getitem__` expects 2 parameters, 1 was given + | +93 | ... +94 | +95 | def __class_getitem__(self): # #16217 assert special method is linted, expects 2 parameters + | ^^^^^^^^^^^^^^^^^ PLE0302 +96 | ... + | + +unexpected_special_method_signature.py:98:9: PLE0302 The special method `__mro_entries__` expects 2 parameters, 1 was given + | +96 | ... +97 | +98 | def __mro_entries__(self): # #16217 assert special method is linted, expects 2 parameters + | ^^^^^^^^^^^^^^^ PLE0302 +99 | ... + | + +unexpected_special_method_signature.py:101:9: PLE0302 The special method `__release_buffer__` expects 2 parameters, 1 was given + | + 99 | ... +100 | +101 | def __release_buffer__(self): # #16217 assert special method is linted, expects 2 parameters + | ^^^^^^^^^^^^^^^^^^ PLE0302 +102 | ... + | + +unexpected_special_method_signature.py:104:9: PLE0302 The special method `__subclasshook__` expects 2 parameters, 1 was given + | +102 | ... +103 | +104 | def __subclasshook__(self): # #16217 assert special method is linted, expects 2 parameters + | ^^^^^^^^^^^^^^^^ PLE0302 +105 | ... + | + +unexpected_special_method_signature.py:107:9: PLE0302 The special method `__setattr__` expects 3 parameters, 2 were given + | +105 | ... +106 | +107 | def __setattr__(self, /, name): # #16217 assert positional-only special method is linted, expects 3 parameters + | ^^^^^^^^^^^ PLE0302 +108 | ... + | +unexpected_special_method_signature.py:110:9: PLE0302 The special method `__setitem__` expects 3 parameters, 4 were given + | +108 | ... +109 | +110 | def __setitem__(self, key, /, value, extra_value): # #16217 assert positional-only special method is linted, expects 3 parameters + | ^^^^^^^^^^^ PLE0302 +111 | ... + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0303_invalid_return_type_length.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0303_invalid_return_type_length.py.snap index e0bf2309a22bd..f7a85c61e5c69 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0303_invalid_return_type_length.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0303_invalid_return_type_length.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_return_type_length.py:6:16: PLE0303 `__len__` does not return a non-negative integer | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0304_invalid_return_type_bool.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0304_invalid_return_type_bool.py.snap index b28107c0851d8..4f156b0611503 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0304_invalid_return_type_bool.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0304_invalid_return_type_bool.py.snap @@ -7,7 +7,7 @@ invalid_return_type_bool.py:5:16: PLE0304 `__bool__` does not return `bool` 4 | def __bool__(self): 5 | return 3.05 # [invalid-bool-return] | ^^^^ PLE0304 -6 | +6 | 7 | class Int: | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0305_invalid_return_type_index.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0305_invalid_return_type_index.py.snap index 367f15b8b77f8..92964417da050 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0305_invalid_return_type_index.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0305_invalid_return_type_index.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_return_type_index.py:8:16: PLE0305 `__index__` does not return an integer | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0307_invalid_return_type_str.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0307_invalid_return_type_str.py.snap index 11d861490743e..31fe3edc92fd6 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0307_invalid_return_type_str.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0307_invalid_return_type_str.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_return_type_str.py:6:16: PLE0307 `__str__` does not return `str` | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0308_invalid_return_type_bytes.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0308_invalid_return_type_bytes.py.snap index 64e182cc0ac70..3f2c76c929211 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0308_invalid_return_type_bytes.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0308_invalid_return_type_bytes.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_return_type_bytes.py:6:16: PLE0308 `__bytes__` does not return `bytes` | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0309_invalid_return_type_hash.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0309_invalid_return_type_hash.py.snap index cffa2bcfc47d9..23f61bc9dc58f 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0309_invalid_return_type_hash.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0309_invalid_return_type_hash.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_return_type_hash.py:6:16: PLE0309 `__hash__` does not return an integer | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0604_invalid_all_object.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0604_invalid_all_object.py.snap index 520ac1d0834db..775afaf683ffe 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0604_invalid_all_object.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0604_invalid_all_object.py.snap @@ -12,9 +12,7 @@ invalid_all_object.py:1:1: PLE0604 Invalid object in `__all__`, must contain onl invalid_all_object.py:7:1: PLE0604 Invalid object in `__all__`, must contain only strings | 5 | ) -6 | +6 | 7 | __all__ = list([None, "Fruit", "Worm"]) # [invalid-all-object] | ^^^^^^^ PLE0604 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0605_invalid_all_format.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0605_invalid_all_format.py.snap index 1768e87240d17..f2ae393351f2d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0605_invalid_all_format.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0605_invalid_all_format.py.snap @@ -5,128 +5,126 @@ invalid_all_format.py:1:1: PLE0605 Invalid format for `__all__`, must be `tuple` | 1 | __all__ = "CONST" # [invalid-all-format] | ^^^^^^^ PLE0605 -2 | +2 | 3 | __all__ = ["Hello"] + {"world"} # [invalid-all-format] | invalid_all_format.py:3:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 1 | __all__ = "CONST" # [invalid-all-format] -2 | +2 | 3 | __all__ = ["Hello"] + {"world"} # [invalid-all-format] | ^^^^^^^ PLE0605 -4 | +4 | 5 | __all__ += {"world"} # [invalid-all-format] | invalid_all_format.py:5:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 3 | __all__ = ["Hello"] + {"world"} # [invalid-all-format] -4 | +4 | 5 | __all__ += {"world"} # [invalid-all-format] | ^^^^^^^ PLE0605 -6 | +6 | 7 | __all__ = {"world"} + ["Hello"] # [invalid-all-format] | invalid_all_format.py:7:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 5 | __all__ += {"world"} # [invalid-all-format] -6 | +6 | 7 | __all__ = {"world"} + ["Hello"] # [invalid-all-format] | ^^^^^^^ PLE0605 -8 | +8 | 9 | __all__ = {"world"} + list(["Hello"]) # [invalid-all-format] | invalid_all_format.py:9:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 7 | __all__ = {"world"} + ["Hello"] # [invalid-all-format] - 8 | + 8 | 9 | __all__ = {"world"} + list(["Hello"]) # [invalid-all-format] | ^^^^^^^ PLE0605 -10 | +10 | 11 | __all__ = list(["Hello"]) + {"world"} # [invalid-all-format] | invalid_all_format.py:11:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 9 | __all__ = {"world"} + list(["Hello"]) # [invalid-all-format] -10 | +10 | 11 | __all__ = list(["Hello"]) + {"world"} # [invalid-all-format] | ^^^^^^^ PLE0605 -12 | +12 | 13 | __all__ = (x for x in ["Hello", "world"]) # [invalid-all-format] | invalid_all_format.py:13:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 11 | __all__ = list(["Hello"]) + {"world"} # [invalid-all-format] -12 | +12 | 13 | __all__ = (x for x in ["Hello", "world"]) # [invalid-all-format] | ^^^^^^^ PLE0605 -14 | +14 | 15 | __all__ = {x for x in ["Hello", "world"]} # [invalid-all-format] | invalid_all_format.py:15:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 13 | __all__ = (x for x in ["Hello", "world"]) # [invalid-all-format] -14 | +14 | 15 | __all__ = {x for x in ["Hello", "world"]} # [invalid-all-format] | ^^^^^^^ PLE0605 -16 | +16 | 17 | __all__ = foo # [invalid-all-format] | invalid_all_format.py:17:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 15 | __all__ = {x for x in ["Hello", "world"]} # [invalid-all-format] -16 | +16 | 17 | __all__ = foo # [invalid-all-format] | ^^^^^^^ PLE0605 -18 | +18 | 19 | __all__ = foo.bar # [invalid-all-format] | invalid_all_format.py:19:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 17 | __all__ = foo # [invalid-all-format] -18 | +18 | 19 | __all__ = foo.bar # [invalid-all-format] | ^^^^^^^ PLE0605 -20 | +20 | 21 | __all__ = foo["bar"] # [invalid-all-format] | invalid_all_format.py:21:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 19 | __all__ = foo.bar # [invalid-all-format] -20 | +20 | 21 | __all__ = foo["bar"] # [invalid-all-format] | ^^^^^^^ PLE0605 -22 | +22 | 23 | __all__ = (foo := bar) # [invalid-all-format] | invalid_all_format.py:23:1: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 21 | __all__ = foo["bar"] # [invalid-all-format] -22 | +22 | 23 | __all__ = (foo := bar) # [invalid-all-format] | ^^^^^^^ PLE0605 -24 | +24 | 25 | __all__ = ["Hello"] | invalid_all_format.py:23:12: PLE0605 Invalid format for `__all__`, must be `tuple` or `list` | 21 | __all__ = foo["bar"] # [invalid-all-format] -22 | +22 | 23 | __all__ = (foo := bar) # [invalid-all-format] | ^^^ PLE0605 -24 | +24 | 25 | __all__ = ["Hello"] | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0643_potential_index_error.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0643_potential_index_error.py.snap index 4c90ee3f58eaa..78dcba4f7737f 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0643_potential_index_error.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0643_potential_index_error.py.snap @@ -33,6 +33,6 @@ potential_index_error.py:4:17: PLE0643 Expression is likely to raise `IndexError 3 | print([1, 2, 3][999999999999999999999999999999999999999999]) # PLE0643 4 | print([1, 2, 3][-999999999999999999999999999999999999999999]) # PLE0643 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE0643 -5 | +5 | 6 | print([1, 2, 3][2]) # OK | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0704_misplaced_bare_raise.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0704_misplaced_bare_raise.py.snap index ce61e96b9c39e..560e9029f0e60 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0704_misplaced_bare_raise.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0704_misplaced_bare_raise.py.snap @@ -25,7 +25,7 @@ misplaced_bare_raise.py:41:5: PLE0704 Bare `raise` statement is not inside an ex 40 | def g(): 41 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 -42 | +42 | 43 | def h(): | @@ -45,17 +45,17 @@ misplaced_bare_raise.py:50:5: PLE0704 Bare `raise` statement is not inside an ex 49 | pass 50 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 -51 | +51 | 52 | raise # [misplaced-bare-raise] | misplaced_bare_raise.py:52:1: PLE0704 Bare `raise` statement is not inside an exception handler | 50 | raise # [misplaced-bare-raise] -51 | +51 | 52 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 -53 | +53 | 54 | try: | @@ -65,7 +65,7 @@ misplaced_bare_raise.py:58:9: PLE0704 Bare `raise` statement is not inside an ex 57 | def i(): 58 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 -59 | +59 | 60 | try: | @@ -75,7 +75,7 @@ misplaced_bare_raise.py:64:9: PLE0704 Bare `raise` statement is not inside an ex 63 | class C: 64 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 -65 | +65 | 66 | try: | @@ -86,5 +86,3 @@ misplaced_bare_raise.py:71:5: PLE0704 Bare `raise` statement is not inside an ex 71 | raise # [misplaced-bare-raise] | ^^^^^ PLE0704 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1132_repeated_keyword_argument.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1132_repeated_keyword_argument.py.snap index 2e669058dccff..702fb4f4c9a9e 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1132_repeated_keyword_argument.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1132_repeated_keyword_argument.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- repeated_keyword_argument.py:16:21: PLE1132 Repeated keyword argument: `c` | @@ -76,5 +77,3 @@ repeated_keyword_argument.py:20:30: PLE1132 Repeated keyword argument: `c` 20 | func(a=11, b=21, **{"c": 31, "c": 32}) | ^^^ PLE1132 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1141_dict_iter_missing_items.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1141_dict_iter_missing_items.py.snap index db90e1a686e01..c99492114a6bf 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1141_dict_iter_missing_items.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1141_dict_iter_missing_items.py.snap @@ -23,7 +23,7 @@ dict_iter_missing_items.py:13:13: PLE1141 [*] Unpacking a dictionary in iteratio dict_iter_missing_items.py:16:13: PLE1141 [*] Unpacking a dictionary in iteration without calling `.items()` | 14 | pass -15 | +15 | 16 | for k, v in d_tuple_incorrect_tuple: | ^^^^^^^^^^^^^^^^^^^^^^^ PLE1141 17 | pass diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.ipynb.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.ipynb.snap new file mode 100644 index 0000000000000..40456044395f4 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.ipynb.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text +--- +await_outside_async.ipynb:9:5: PLE1142 `await` should be used within an async function + | +8 | def foo(): +9 | await asyncio.sleep(1) # # [await-outside-async] + | ^^^^^^^^^^^^^^^^^^^^^^ PLE1142 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.py.snap index a1f4507c82974..05e0044833166 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1142_await_outside_async.py.snap @@ -1,19 +1,86 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs --- -await_outside_async.py:12:11: PLE1142 `await` should be used within an async function +await_outside_async.py:15:11: PLE1142 `await` should be used within an async function | -11 | def not_async(): -12 | print(await nested()) # [await-outside-async] +14 | def not_async(): +15 | print(await nested()) # [await-outside-async] | ^^^^^^^^^^^^^^ PLE1142 | -await_outside_async.py:25:9: PLE1142 `await` should be used within an async function +await_outside_async.py:29:9: PLE1142 `await` should be used within an async function | -23 | async def func2(): -24 | def inner_func(): -25 | await asyncio.sleep(1) # [await-outside-async] +27 | async def func2(): +28 | def inner_func(): +29 | await asyncio.sleep(1) # [await-outside-async] | ^^^^^^^^^^^^^^^^^^^^^^ PLE1142 | +await_outside_async.py:38:5: PLE1142 `await` should be used within an async function + | +37 | def async_for_loop(): +38 | / async for x in foo(): +39 | | pass + | |____________^ PLE1142 + | +await_outside_async.py:43:5: PLE1142 `await` should be used within an async function + | +42 | def async_with(): +43 | / async with foo(): +44 | | pass + | |____________^ PLE1142 + | + +await_outside_async.py:54:6: PLE1142 `await` should be used within an async function + | +52 | # See: https://github.com/astral-sh/ruff/issues/14167 +53 | def async_for_list_comprehension_elt(): +54 | [await x for x in foo()] + | ^^^^^^^ PLE1142 + | + +await_outside_async.py:59:8: PLE1142 `await` should be used within an async function + | +57 | # See: https://github.com/astral-sh/ruff/issues/14167 +58 | def async_for_list_comprehension(): +59 | [x async for x in foo()] + | ^^^^^^^^^^^^^^^^^^^^ PLE1142 + | + +await_outside_async.py:64:17: PLE1142 `await` should be used within an async function + | +62 | # See: https://github.com/astral-sh/ruff/issues/14167 +63 | def await_generator_iter(): +64 | (x for x in await foo()) + | ^^^^^^^^^^^ PLE1142 + | + +await_outside_async.py:74:17: PLE1142 `await` should be used within an async function + | +72 | # See: https://github.com/astral-sh/ruff/issues/14167 +73 | def async_for_list_comprehension_target(): +74 | [x for x in await foo()] + | ^^^^^^^^^^^ PLE1142 + | + +await_outside_async.py:78:6: PLE1142 `await` should be used within an async function + | +77 | def async_for_dictionary_comprehension_key(): +78 | {await x: y for x, y in foo()} + | ^^^^^^^ PLE1142 + | + +await_outside_async.py:82:9: PLE1142 `await` should be used within an async function + | +81 | def async_for_dictionary_comprehension_value(): +82 | {y: await x for x, y in foo()} + | ^^^^^^^ PLE1142 + | + +await_outside_async.py:86:11: PLE1142 `await` should be used within an async function + | +85 | def async_for_dict_comprehension(): +86 | {x: y async for x, y in foo()} + | ^^^^^^^^^^^^^^^^^^^^^^^ PLE1142 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1205_logging_too_many_args.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1205_logging_too_many_args.py.snap index f202189a23a82..d905356f3dc09 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1205_logging_too_many_args.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1205_logging_too_many_args.py.snap @@ -4,41 +4,39 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs logging_too_many_args.py:3:1: PLE1205 Too many arguments for `logging` format string | 1 | import logging -2 | +2 | 3 | logging.warning("Hello %s", "World!", "again") # [logging-too-many-args] | ^^^^^^^^^^^^^^^ PLE1205 -4 | +4 | 5 | logging.warning("Hello %s", "World!", "again", something="else") | logging_too_many_args.py:5:1: PLE1205 Too many arguments for `logging` format string | 3 | logging.warning("Hello %s", "World!", "again") # [logging-too-many-args] -4 | +4 | 5 | logging.warning("Hello %s", "World!", "again", something="else") | ^^^^^^^^^^^^^^^ PLE1205 -6 | +6 | 7 | logging.warning("Hello %s", "World!") | logging_too_many_args.py:29:1: PLE1205 Too many arguments for `logging` format string | 27 | from logging import info, error, warning -28 | +28 | 29 | warning("Hello %s", "World!", "again") # [logging-too-many-args] | ^^^^^^^ PLE1205 -30 | +30 | 31 | warning("Hello %s", "World!", "again", something="else") | logging_too_many_args.py:31:1: PLE1205 Too many arguments for `logging` format string | 29 | warning("Hello %s", "World!", "again") # [logging-too-many-args] -30 | +30 | 31 | warning("Hello %s", "World!", "again", something="else") | ^^^^^^^ PLE1205 -32 | +32 | 33 | warning("Hello %s", "World!") | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1206_logging_too_few_args.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1206_logging_too_few_args.py.snap index abaec32b88bd9..0961e1b05ff2d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1206_logging_too_few_args.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1206_logging_too_few_args.py.snap @@ -4,21 +4,19 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs logging_too_few_args.py:3:1: PLE1206 Not enough arguments for `logging` format string | 1 | import logging -2 | +2 | 3 | logging.warning("Hello %s %s", "World!") # [logging-too-few-args] | ^^^^^^^^^^^^^^^ PLE1206 -4 | +4 | 5 | # do not handle calls with kwargs (like pylint) | logging_too_few_args.py:33:1: PLE1206 Not enough arguments for `logging` format string | 31 | from logging import error, info, warning -32 | +32 | 33 | warning("Hello %s %s", "World!") # [logging-too-few-args] | ^^^^^^^ PLE1206 -34 | +34 | 35 | # do not handle calls with kwargs (like pylint) | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1300_bad_string_format_character.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1300_bad_string_format_character.py.snap index e0443ba9bd15e..aed97848eeab8 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1300_bad_string_format_character.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1300_bad_string_format_character.py.snap @@ -4,50 +4,50 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs bad_string_format_character.py:5:1: PLE1300 Unsupported format character 'z' | 3 | ## Old style formatting -4 | +4 | 5 | "%s %z" % ("hello", "world") # [bad-format-character] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1300 -6 | +6 | 7 | "%s" "%z" % ("hello", "world") # [bad-format-character] | bad_string_format_character.py:7:1: PLE1300 Unsupported format character 'z' | 5 | "%s %z" % ("hello", "world") # [bad-format-character] -6 | +6 | 7 | "%s" "%z" % ("hello", "world") # [bad-format-character] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1300 -8 | +8 | 9 | """%s %z""" % ("hello", "world") # [bad-format-character] | bad_string_format_character.py:9:1: PLE1300 Unsupported format character 'z' | 7 | "%s" "%z" % ("hello", "world") # [bad-format-character] - 8 | + 8 | 9 | """%s %z""" % ("hello", "world") # [bad-format-character] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1300 -10 | +10 | 11 | """%s""" """%z""" % ("hello", "world") # [bad-format-character] | bad_string_format_character.py:11:1: PLE1300 Unsupported format character 'z' | 9 | """%s %z""" % ("hello", "world") # [bad-format-character] -10 | +10 | 11 | """%s""" """%z""" % ("hello", "world") # [bad-format-character] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1300 -12 | +12 | 13 | ## New style formatting | bad_string_format_character.py:15:1: PLE1300 Unsupported format character 'y' | 13 | ## New style formatting -14 | +14 | 15 | "{:s} {:y}".format("hello", "world") # [bad-format-character] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1300 -16 | +16 | 17 | "{:*^30s}".format("centered") # OK | @@ -60,5 +60,3 @@ bad_string_format_character.py:19:1: PLE1300 Unsupported format character 'y' 20 | "{0:.{prec}g}".format(1.23, prec=15) # OK (cannot validate after nested placeholder) 21 | "{0:.{foo}{bar}{foobar}y}".format(...) # OK (cannot validate after nested placeholders) | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1307_bad_string_format_type.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1307_bad_string_format_type.py.snap index cd3e86e327b1d..971f3addb6b40 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1307_bad_string_format_type.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1307_bad_string_format_type.py.snap @@ -6,24 +6,24 @@ bad_string_format_type.py:2:7: PLE1307 Format type does not match argument type 1 | # Errors 2 | print("foo %(foo)d bar %(bar)d" % {"foo": "1", "bar": "2"}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1307 -3 | +3 | 4 | "foo %e bar %s" % ("1", 2) | bad_string_format_type.py:4:1: PLE1307 Format type does not match argument type | 2 | print("foo %(foo)d bar %(bar)d" % {"foo": "1", "bar": "2"}) -3 | +3 | 4 | "foo %e bar %s" % ("1", 2) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1307 -5 | +5 | 6 | "%d" % "1" | bad_string_format_type.py:6:1: PLE1307 Format type does not match argument type | 4 | "foo %e bar %s" % ("1", 2) -5 | +5 | 6 | "%d" % "1" | ^^^^^^^^^^ PLE1307 7 | "%o" % "1" @@ -124,8 +124,6 @@ bad_string_format_type.py:16:1: PLE1307 Format type does not match argument type 15 | "%d" % ((1, 2, 3),) 16 | "%d" % (1 if x > 0 else []) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1307 -17 | +17 | 18 | # False negatives | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1310_bad_str_strip_call.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1310_bad_str_strip_call.py.snap index 7f97ef8dfa579..a3d6f646c0127 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1310_bad_str_strip_call.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1310_bad_str_strip_call.py.snap @@ -6,7 +6,7 @@ bad_str_strip_call.py:2:21: PLE1310 String `strip` call contains duplicate chara 1 | # PLE1310 2 | "Hello World".strip("Hello") | ^^^^^^^ PLE1310 -3 | +3 | 4 | # PLE1310 | @@ -15,7 +15,7 @@ bad_str_strip_call.py:5:21: PLE1310 String `strip` call contains duplicate chara 4 | # PLE1310 5 | "Hello World".strip("Hello") | ^^^^^^^ PLE1310 -6 | +6 | 7 | # PLE1310 | @@ -24,7 +24,7 @@ bad_str_strip_call.py:8:21: PLE1310 String `strip` call contains duplicate chara 7 | # PLE1310 8 | "Hello World".strip(u"Hello") | ^^^^^^^^ PLE1310 - 9 | + 9 | 10 | # PLE1310 | @@ -33,7 +33,7 @@ bad_str_strip_call.py:11:21: PLE1310 String `strip` call contains duplicate char 10 | # PLE1310 11 | "Hello World".strip(r"Hello") | ^^^^^^^^ PLE1310 -12 | +12 | 13 | # PLE1310 | @@ -42,7 +42,7 @@ bad_str_strip_call.py:14:21: PLE1310 String `strip` call contains duplicate char 13 | # PLE1310 14 | "Hello World".strip("Hello\t") | ^^^^^^^^^ PLE1310 -15 | +15 | 16 | # PLE1310 | @@ -51,7 +51,7 @@ bad_str_strip_call.py:17:21: PLE1310 String `strip` call contains duplicate char 16 | # PLE1310 17 | "Hello World".strip(r"Hello\t") | ^^^^^^^^^^ PLE1310 -18 | +18 | 19 | # PLE1310 | @@ -60,7 +60,7 @@ bad_str_strip_call.py:20:21: PLE1310 String `strip` call contains duplicate char 19 | # PLE1310 20 | "Hello World".strip("Hello\\") | ^^^^^^^^^ PLE1310 -21 | +21 | 22 | # PLE1310 | @@ -69,7 +69,7 @@ bad_str_strip_call.py:23:21: PLE1310 String `strip` call contains duplicate char 22 | # PLE1310 23 | "Hello World".strip(r"Hello\\") | ^^^^^^^^^^ PLE1310 -24 | +24 | 25 | # PLE1310 | @@ -78,7 +78,7 @@ bad_str_strip_call.py:26:21: PLE1310 String `strip` call contains duplicate char 25 | # PLE1310 26 | "Hello World".strip("🤣🤣🤣🤣🙃👀😀") | ^^^^^^^^^^^^^^^^ PLE1310 -27 | +27 | 28 | # PLE1310 | @@ -86,8 +86,7 @@ bad_str_strip_call.py:30:5: PLE1310 String `strip` call contains duplicate chara | 28 | # PLE1310 29 | "Hello World".strip( -30 | """ - | _____^ +30 | / """ 31 | | there are a lot of characters to strip 32 | | """ | |___^ PLE1310 @@ -102,7 +101,7 @@ bad_str_strip_call.py:36:21: PLE1310 String `strip` call contains duplicate char 37 | | "string of characters to strip " \ 38 | | "please?") | |_____________________________^ PLE1310 -39 | +39 | 40 | # PLE1310 | @@ -110,8 +109,7 @@ bad_str_strip_call.py:42:5: PLE1310 String `strip` call contains duplicate chara | 40 | # PLE1310 41 | "Hello World".strip( -42 | "can we get a long " - | _____^ +42 | / "can we get a long " 43 | | "string of characters to strip " 44 | | "please?" | |_____________^ PLE1310 @@ -122,8 +120,7 @@ bad_str_strip_call.py:49:5: PLE1310 String `strip` call contains duplicate chara | 47 | # PLE1310 48 | "Hello World".strip( -49 | "can \t we get a long" - | _____^ +49 | / "can \t we get a long" 50 | | "string \t of characters to strip" 51 | | "please?" | |_____________^ PLE1310 @@ -135,7 +132,7 @@ bad_str_strip_call.py:61:11: PLE1310 String `strip` call contains duplicate char 60 | # PLE1310 61 | u''.strip('http://') | ^^^^^^^^^ PLE1310 -62 | +62 | 63 | # PLE1310 | @@ -144,17 +141,70 @@ bad_str_strip_call.py:64:12: PLE1310 String `lstrip` call contains duplicate cha 63 | # PLE1310 64 | u''.lstrip('http://') | ^^^^^^^^^ PLE1310 -65 | +65 | 66 | # PLE1310 | bad_str_strip_call.py:67:12: PLE1310 String `rstrip` call contains duplicate characters (did you mean `removesuffix`?) | 66 | # PLE1310 -67 | b''.rstrip('http://') - | ^^^^^^^^^ PLE1310 -68 | +67 | b''.rstrip(b'http://') + | ^^^^^^^^^^ PLE1310 +68 | 69 | # OK | +bad_str_strip_call.py:79:10: PLE1310 String `strip` call contains duplicate characters + | +78 | # Errors: Multiple backslashes +79 | ''.strip('\\b\\x09') + | ^^^^^^^^^^ PLE1310 +80 | ''.strip(r'\b\x09') +81 | ''.strip('\\\x5C') + | + +bad_str_strip_call.py:80:10: PLE1310 String `strip` call contains duplicate characters + | +78 | # Errors: Multiple backslashes +79 | ''.strip('\\b\\x09') +80 | ''.strip(r'\b\x09') + | ^^^^^^^^^ PLE1310 +81 | ''.strip('\\\x5C') + | + +bad_str_strip_call.py:81:10: PLE1310 String `strip` call contains duplicate characters + | +79 | ''.strip('\\b\\x09') +80 | ''.strip(r'\b\x09') +81 | ''.strip('\\\x5C') + | ^^^^^^^^ PLE1310 +82 | +83 | # Errors: Type inference + | +bad_str_strip_call.py:85:9: PLE1310 String `strip` call contains duplicate characters + | +83 | # Errors: Type inference +84 | b = b'' +85 | b.strip(b'//') + | ^^^^^ PLE1310 +86 | +87 | # Errors: Type inference (preview) + | + +bad_str_strip_call.py:89:12: PLE1310 String `rstrip` call contains duplicate characters (did you mean `removesuffix`?) + | +87 | # Errors: Type inference (preview) +88 | foo: str = ""; bar: bytes = b"" +89 | foo.rstrip("//") + | ^^^^ PLE1310 +90 | bar.lstrip(b"//") + | + +bad_str_strip_call.py:90:12: PLE1310 String `lstrip` call contains duplicate characters (did you mean `removeprefix`?) + | +88 | foo: str = ""; bar: bytes = b"" +89 | foo.rstrip("//") +90 | bar.lstrip(b"//") + | ^^^^^ PLE1310 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1507_invalid_envvar_value.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1507_invalid_envvar_value.py.snap index 8bf3f89edbdcb..79e29de638f50 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1507_invalid_envvar_value.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1507_invalid_envvar_value.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs invalid_envvar_value.py:3:11: PLE1507 Invalid type for initial `os.getenv` argument; expected `str` | 1 | import os -2 | +2 | 3 | os.getenv(1) # [invalid-envvar-value] | ^ PLE1507 4 | os.getenv("a") @@ -47,8 +47,6 @@ invalid_envvar_value.py:14:11: PLE1507 Invalid type for initial `os.getenv` argu 13 | os.getenv("PATH_TEST" if using_clear_path else "PATH_ORIG") 14 | os.getenv(1 if using_clear_path else "PATH_ORIG") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1507 -15 | +15 | 16 | AA = "aa" | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1519_singledispatch_method.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1519_singledispatch_method.py.snap index caa3e35b7c10e..4ec3382c4b1cd 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1519_singledispatch_method.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1519_singledispatch_method.py.snap @@ -24,7 +24,7 @@ singledispatch_method.py:10:5: PLE1519 [*] `@singledispatch` decorator should no singledispatch_method.py:15:5: PLE1519 [*] `@singledispatch` decorator should not be used on methods | 13 | pass -14 | +14 | 15 | @singledispatch # [singledispatch-method] | ^^^^^^^^^^^^^^^ PLE1519 16 | def move(self, position): @@ -45,7 +45,7 @@ singledispatch_method.py:15:5: PLE1519 [*] `@singledispatch` decorator should no singledispatch_method.py:23:5: PLE1519 [*] `@singledispatch` decorator should not be used on methods | 21 | pass -22 | +22 | 23 | @singledispatch # [singledispatch-method] | ^^^^^^^^^^^^^^^ PLE1519 24 | @staticmethod diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap index 1507083e5817f..36b591bc45c42 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- singledispatchmethod_function.py:4:1: PLE1520 [*] `@singledispatchmethod` decorator should not be used on non-method functions | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1700_yield_from_in_async_function.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1700_yield_from_in_async_function.py.snap index 8ead784695ee7..c57a96cd09d35 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1700_yield_from_in_async_function.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE1700_yield_from_in_async_function.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- yield_from_in_async_function.py:7:5: PLE1700 `yield from` statement in async function; use `async for` instead | @@ -8,5 +9,3 @@ yield_from_in_async_function.py:7:5: PLE1700 `yield from` statement in async fun 7 | yield from l | ^^^^^^^^^^^^ PLE1700 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2502_bidirectional_unicode.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2502_bidirectional_unicode.py.snap index 76de26797cee0..8d11a86388ed4 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2502_bidirectional_unicode.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2502_bidirectional_unicode.py.snap @@ -3,41 +3,39 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs --- bidirectional_unicode.py:2:1: PLE2502 Contains control characters that can permit obfuscated code | -1 | # E2502 -2 | / print("שלום‬") -3 | | - | |_^ PLE2502 -4 | # E2502 -5 | example = "x‏" * 100 # "‏x" is assigned +1 | # E2502 +2 | print("שלום") + | ^^^^^^^^^^^^^ PLE2502 +3 | +4 | # E2502 +5 | example = "x‏" * 100 # "‏x" is assigned | bidirectional_unicode.py:5:1: PLE2502 Contains control characters that can permit obfuscated code | -4 | # E2502 -5 | / example = "x‏" * 100 # "‏x" is assigned -6 | | - | |_^ PLE2502 -7 | # E2502 -8 | if access_level != "none‮⁦": # Check if admin ⁩⁦' and access_level != 'user +4 | # E2502 +5 | example = "x‏" * 100 # "‏x" is assigned + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE2502 +6 | +7 | # E2502 +8 | if access_level != "none": # Check if admin ' and access_level != 'user | bidirectional_unicode.py:8:1: PLE2502 Contains control characters that can permit obfuscated code | -7 | # E2502 -8 | / if access_level != "none‮⁦": # Check if admin ⁩⁦' and access_level != 'user -9 | | print("You are an admin.") - | |_^ PLE2502 +7 | # E2502 +8 | if access_level != "none": # Check if admin ' and access_level != 'user + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE2502 +9 | print("You are an admin.") | bidirectional_unicode.py:14:1: PLE2502 Contains control characters that can permit obfuscated code | -12 | # E2502 -13 | def subtract_funds(account: str, amount: int): -14 | / """Subtract funds from bank account then ⁧""" -15 | | return - | |_^ PLE2502 -16 | bank[account] -= amount -17 | return +12 | # E2502 +13 | def subtract_funds(account: str, amount: int): +14 | """Subtract funds from bank account then """ + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE2502 +15 | return +16 | bank[account] -= amount +17 | return | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters.py.snap index 3f23d12764d77..46b9cb6a3fcc5 100644 Binary files a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters.py.snap and b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters.py.snap differ diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters_syntax_error.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters_syntax_error.py.snap index ac7bb4abc9589..55449038ed237 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters_syntax_error.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2510_invalid_characters_syntax_error.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- invalid_characters_syntax_error.py:5:6: PLE2510 Invalid unescaped character backspace, use "\b" instead | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2512_invalid_characters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2512_invalid_characters.py.snap index 3ef59bd9291bd..88630ccb7a5a9 100644 Binary files a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2512_invalid_characters.py.snap and b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2512_invalid_characters.py.snap differ diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2513_invalid_characters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2513_invalid_characters.py.snap index 993c89041e59f..eefd991446f13 100644 Binary files a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2513_invalid_characters.py.snap and b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2513_invalid_characters.py.snap differ diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2514_invalid_characters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2514_invalid_characters.py.snap index 3ab1a52ec4958..a06d6f645f090 100644 Binary files a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2514_invalid_characters.py.snap and b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2514_invalid_characters.py.snap differ diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2515_invalid_characters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2515_invalid_characters.py.snap index bf097d02f2cec..5b50a43e0589e 100644 Binary files a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2515_invalid_characters.py.snap and b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE2515_invalid_characters.py.snap differ diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE4703_modified_iterating_set.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE4703_modified_iterating_set.py.snap index 0af466fe72d09..d7d35b39f0657 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE4703_modified_iterating_set.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLE4703_modified_iterating_set.py.snap @@ -7,7 +7,7 @@ modified_iterating_set.py:4:1: PLE4703 [*] Iterated set `nums` is modified withi 4 | / for num in nums: 5 | | nums.add(num + 1) | |_____________________^ PLE4703 -6 | +6 | 7 | animals = {"dog", "cat", "cow"} | = help: Iterate over a copy of `nums` @@ -28,7 +28,7 @@ modified_iterating_set.py:8:1: PLE4703 [*] Iterated set `animals` is modified wi 8 | / for animal in animals: 9 | | animals.pop("cow") | |______________________^ PLE4703 -10 | +10 | 11 | fruits = {"apple", "orange", "grape"} | = help: Iterate over a copy of `animals` @@ -49,7 +49,7 @@ modified_iterating_set.py:12:1: PLE4703 [*] Iterated set `fruits` is modified wi 12 | / for fruit in fruits: 13 | | fruits.clear() | |__________________^ PLE4703 -14 | +14 | 15 | planets = {"mercury", "venus", "earth"} | = help: Iterate over a copy of `fruits` @@ -70,7 +70,7 @@ modified_iterating_set.py:16:1: PLE4703 [*] Iterated set `planets` is modified w 16 | / for planet in planets: 17 | | planets.discard("mercury") | |______________________________^ PLE4703 -18 | +18 | 19 | colors = {"red", "green", "blue"} | = help: Iterate over a copy of `planets` @@ -91,7 +91,7 @@ modified_iterating_set.py:20:1: PLE4703 [*] Iterated set `colors` is modified wi 20 | / for color in colors: 21 | | colors.remove("red") | |________________________^ PLE4703 -22 | +22 | 23 | odds = {1, 3, 5} | = help: Iterate over a copy of `colors` @@ -113,7 +113,7 @@ modified_iterating_set.py:24:1: PLE4703 [*] Iterated set `odds` is modified with 25 | | if num > 1: 26 | | odds.add(num + 1) | |_________________________^ PLE4703 -27 | +27 | 28 | # OK | = help: Iterate over a copy of `odds` diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0124_comparison_with_itself.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0124_comparison_with_itself.py.snap index 457daa38d51f2..6812c32fb405f 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0124_comparison_with_itself.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0124_comparison_with_itself.py.snap @@ -6,118 +6,116 @@ comparison_with_itself.py:2:1: PLR0124 Name compared with itself, consider repla 1 | # Errors. 2 | foo == foo | ^^^ PLR0124 -3 | +3 | 4 | foo != foo | comparison_with_itself.py:4:1: PLR0124 Name compared with itself, consider replacing `foo != foo` | 2 | foo == foo -3 | +3 | 4 | foo != foo | ^^^ PLR0124 -5 | +5 | 6 | foo > foo | comparison_with_itself.py:6:1: PLR0124 Name compared with itself, consider replacing `foo > foo` | 4 | foo != foo -5 | +5 | 6 | foo > foo | ^^^ PLR0124 -7 | +7 | 8 | foo >= foo | comparison_with_itself.py:8:1: PLR0124 Name compared with itself, consider replacing `foo >= foo` | 6 | foo > foo - 7 | + 7 | 8 | foo >= foo | ^^^ PLR0124 - 9 | + 9 | 10 | foo < foo | comparison_with_itself.py:10:1: PLR0124 Name compared with itself, consider replacing `foo < foo` | 8 | foo >= foo - 9 | + 9 | 10 | foo < foo | ^^^ PLR0124 -11 | +11 | 12 | foo <= foo | comparison_with_itself.py:12:1: PLR0124 Name compared with itself, consider replacing `foo <= foo` | 10 | foo < foo -11 | +11 | 12 | foo <= foo | ^^^ PLR0124 -13 | +13 | 14 | foo is foo | comparison_with_itself.py:14:1: PLR0124 Name compared with itself, consider replacing `foo is foo` | 12 | foo <= foo -13 | +13 | 14 | foo is foo | ^^^ PLR0124 -15 | +15 | 16 | foo is not foo | comparison_with_itself.py:16:1: PLR0124 Name compared with itself, consider replacing `foo is not foo` | 14 | foo is foo -15 | +15 | 16 | foo is not foo | ^^^ PLR0124 -17 | +17 | 18 | foo in foo | comparison_with_itself.py:18:1: PLR0124 Name compared with itself, consider replacing `foo in foo` | 16 | foo is not foo -17 | +17 | 18 | foo in foo | ^^^ PLR0124 -19 | +19 | 20 | foo not in foo | comparison_with_itself.py:20:1: PLR0124 Name compared with itself, consider replacing `foo not in foo` | 18 | foo in foo -19 | +19 | 20 | foo not in foo | ^^^ PLR0124 -21 | +21 | 22 | id(foo) == id(foo) | comparison_with_itself.py:22:1: PLR0124 Name compared with itself, consider replacing `id(foo) == id(foo)` | 20 | foo not in foo -21 | +21 | 22 | id(foo) == id(foo) | ^^^^^^^ PLR0124 -23 | +23 | 24 | len(foo) == len(foo) | comparison_with_itself.py:24:1: PLR0124 Name compared with itself, consider replacing `len(foo) == len(foo)` | 22 | id(foo) == id(foo) -23 | +23 | 24 | len(foo) == len(foo) | ^^^^^^^^ PLR0124 -25 | +25 | 26 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0133_comparison_of_constant.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0133_comparison_of_constant.py.snap index 29f4192415b22..30bcc7a4f85c9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0133_comparison_of_constant.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0133_comparison_of_constant.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs comparison_of_constant.py:3:4: PLR0133 Two constants compared in a comparison, consider replacing `100 == 100` | 1 | """Check that magic values are not used in comparisons""" -2 | +2 | 3 | if 100 == 100: # [comparison-of-constants] | ^^^ PLR0133 4 | pass @@ -13,7 +13,7 @@ comparison_of_constant.py:3:4: PLR0133 Two constants compared in a comparison, c comparison_of_constant.py:6:4: PLR0133 Two constants compared in a comparison, consider replacing `1 == 3` | 4 | pass -5 | +5 | 6 | if 1 == 3: # [comparison-of-constants] | ^ PLR0133 7 | pass @@ -22,7 +22,7 @@ comparison_of_constant.py:6:4: PLR0133 Two constants compared in a comparison, c comparison_of_constant.py:9:4: PLR0133 Two constants compared in a comparison, consider replacing `1 != 3` | 7 | pass - 8 | + 8 | 9 | if 1 != 3: # [comparison-of-constants] | ^ PLR0133 10 | pass @@ -39,7 +39,7 @@ comparison_of_constant.py:13:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:23:4: PLR0133 Two constants compared in a comparison, consider replacing `1 > 0` | 21 | pass -22 | +22 | 23 | if 1 > 0: # [comparison-of-constants] | ^ PLR0133 24 | pass @@ -48,7 +48,7 @@ comparison_of_constant.py:23:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:29:4: PLR0133 Two constants compared in a comparison, consider replacing `1 >= 0` | 27 | pass -28 | +28 | 29 | if 1 >= 0: # [comparison-of-constants] | ^ PLR0133 30 | pass @@ -57,7 +57,7 @@ comparison_of_constant.py:29:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:35:4: PLR0133 Two constants compared in a comparison, consider replacing `1 < 0` | 33 | pass -34 | +34 | 35 | if 1 < 0: # [comparison-of-constants] | ^ PLR0133 36 | pass @@ -66,7 +66,7 @@ comparison_of_constant.py:35:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:41:4: PLR0133 Two constants compared in a comparison, consider replacing `1 <= 0` | 39 | pass -40 | +40 | 41 | if 1 <= 0: # [comparison-of-constants] | ^ PLR0133 42 | pass @@ -75,7 +75,7 @@ comparison_of_constant.py:41:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:51:4: PLR0133 Two constants compared in a comparison, consider replacing `"hello" == ""` | 49 | pass -50 | +50 | 51 | if "hello" == "": # [comparison-of-constants] | ^^^^^^^ PLR0133 52 | pass @@ -84,10 +84,8 @@ comparison_of_constant.py:51:4: PLR0133 Two constants compared in a comparison, comparison_of_constant.py:58:4: PLR0133 Two constants compared in a comparison, consider replacing `True == False` | 56 | pass -57 | +57 | 58 | if True == False: # [comparison-of-constants] | ^^^^ PLR0133 59 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0202_no_method_decorator.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0202_no_method_decorator.py.snap index 8824f3dd57915..b59cccfa4c0ba 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0202_no_method_decorator.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0202_no_method_decorator.py.snap @@ -4,9 +4,9 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs no_method_decorator.py:9:5: PLR0202 [*] Class method defined without decorator | 7 | self.color = color - 8 | + 8 | 9 | def pick_colors(cls, *args): # [no-classmethod-decorator] - | PLR0202 + | ^ PLR0202 10 | """classmethod to pick fruit colors""" 11 | cls.COLORS = args | @@ -30,7 +30,7 @@ no_method_decorator.py:22:5: PLR0202 [*] Class method defined without decorator | 21 | class Class: 22 | def class_method(cls): - | PLR0202 + | ^ PLR0202 23 | pass | = help: Add @classmethod decorator diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0203_no_method_decorator.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0203_no_method_decorator.py.snap index c4f9d811b4552..49579ff4addf9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0203_no_method_decorator.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0203_no_method_decorator.py.snap @@ -4,9 +4,9 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs no_method_decorator.py:15:5: PLR0203 [*] Static method defined without decorator | 13 | pick_colors = classmethod(pick_colors) -14 | +14 | 15 | def pick_one_color(): # [no-staticmethod-decorator] - | PLR0203 + | ^ PLR0203 16 | """staticmethod to pick one fruit color""" 17 | return choice(Fruit.COLORS) | @@ -29,9 +29,9 @@ no_method_decorator.py:15:5: PLR0203 [*] Static method defined without decorator no_method_decorator.py:27:5: PLR0203 [*] Static method defined without decorator | 25 | class_method = classmethod(class_method);another_statement -26 | +26 | 27 | def static_method(): - | PLR0203 + | ^ PLR0203 28 | pass | = help: Add @staticmethod decorator diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0206_property_with_parameters.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0206_property_with_parameters.py.snap index ada975adc5a78..3c8afe856c1b2 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0206_property_with_parameters.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0206_property_with_parameters.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- property_with_parameters.py:7:9: PLR0206 Cannot have defined parameters for properties | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0402_import_aliasing.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0402_import_aliasing.py.snap index 75384428f6ca1..944d71a06ccd5 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0402_import_aliasing.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0402_import_aliasing.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- import_aliasing.py:9:8: PLR0402 [*] Use `from os import path` in lieu of alias | @@ -53,5 +54,3 @@ import_aliasing.py:12:8: PLR0402 Use `from foo.bar import foobar` in lieu of ali 14 | import os as OS | = help: Replace with `from foo.bar import foobar` - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0911_too_many_return_statements.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0911_too_many_return_statements.py.snap index 9348c8d85f9e1..7db77dee353c2 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0911_too_many_return_statements.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0911_too_many_return_statements.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_return_statements.py:4:5: PLR0911 Too many return statements (11 > 6) | @@ -10,5 +11,3 @@ too_many_return_statements.py:4:5: PLR0911 Too many return statements (11 > 6) 5 | if arg == 1: 6 | return 1 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0912_too_many_branches.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0912_too_many_branches.py.snap index cc4a6a40f2e15..ab698ec5d0229 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0912_too_many_branches.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0912_too_many_branches.py.snap @@ -13,7 +13,7 @@ too_many_branches.py:8:5: PLR0912 Too many branches (13 > 12) too_many_branches.py:80:5: PLR0912 Too many branches (13 > 12) | 78 | pass -79 | +79 | 80 | def with_statement_wrong(): | ^^^^^^^^^^^^^^^^^^^^ PLR0912 81 | """statements inside the with statement should get counted""" diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0913_too_many_arguments.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0913_too_many_arguments.py.snap index a66df27fbd252..fcdbc52e19782 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0913_too_many_arguments.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0913_too_many_arguments.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_arguments.py:1:5: PLR0913 Too many arguments in function definition (8 > 5) | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0915_too_many_statements.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0915_too_many_statements.py.snap index 00d55f6846741..f3d12f984a950 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0915_too_many_statements.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0915_too_many_statements.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_statements.py:5:11: PLR0915 Too many statements (51 > 50) | @@ -8,5 +9,3 @@ too_many_statements.py:5:11: PLR0915 Too many statements (51 > 50) 6 | print() 7 | print() | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0917_too_many_positional_arguments.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0917_too_many_positional_arguments.py.snap index 52182d288aaf0..43145d416a9c1 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0917_too_many_positional_arguments.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0917_too_many_positional_arguments.py.snap @@ -25,7 +25,7 @@ too_many_positional_arguments.py:29:5: PLR0917 Too many positional arguments (6/ too_many_positional_arguments.py:43:9: PLR0917 Too many positional arguments (6/5) | 41 | pass -42 | +42 | 43 | def f(self, a, b, c, d, e, g): # Too many positional arguments (6/5) | ^ PLR0917 44 | pass diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1702_too_many_nested_blocks.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1702_too_many_nested_blocks.py.snap index c3df6b5ec638d..5897b38a4bbcb 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1702_too_many_nested_blocks.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1702_too_many_nested_blocks.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs too_many_nested_blocks.py:2:5: PLR1702 Too many nested blocks (6 > 5) | 1 | def correct_fruits(fruits) -> bool: - 2 | if len(fruits) > 1: # PLR1702 - | _____^ + 2 | / if len(fruits) > 1: # PLR1702 3 | | if "apple" in fruits: 4 | | if "orange" in fruits: 5 | | count = fruits["orange"] @@ -16,5 +15,3 @@ too_many_nested_blocks.py:2:5: PLR1702 Too many nested blocks (6 > 5) | |_______________________________________^ PLR1702 10 | return False | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1704_redefined_argument_from_local.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1704_redefined_argument_from_local.py.snap index 246e255ce8db8..19a226391e299 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1704_redefined_argument_from_local.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1704_redefined_argument_from_local.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- redefined_argument_from_local.py:41:9: PLR1704 Redefining argument with the local name `a` | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1711_useless_return.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1711_useless_return.py.snap index cf914458f4c8b..42779605bbb41 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1711_useless_return.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1711_useless_return.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- useless_return.py:6:5: PLR1711 [*] Useless `return` statement at end of function | @@ -105,5 +106,3 @@ useless_return.py:60:9: PLR1711 [*] Useless `return` statement at end of functio 58 58 | def get(self, key: str) -> None: 59 59 | print(f"{key} not found") 60 |- return None - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1714_repeated_equality_comparison.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1714_repeated_equality_comparison.py.snap index 0c02246b06b19..8c988f02f717d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1714_repeated_equality_comparison.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1714_repeated_equality_comparison.py.snap @@ -1,12 +1,12 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs --- -repeated_equality_comparison.py:2:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:2:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b"}`. | 1 | # Errors. 2 | foo == "a" or foo == "b" | ^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -3 | +3 | 4 | foo != "a" and foo != "b" | = help: Merge multiple comparisons @@ -14,18 +14,18 @@ repeated_equality_comparison.py:2:1: PLR1714 [*] Consider merging multiple compa ℹ Unsafe fix 1 1 | # Errors. 2 |-foo == "a" or foo == "b" - 2 |+foo in ("a", "b") + 2 |+foo in {"a", "b"} 3 3 | 4 4 | foo != "a" and foo != "b" 5 5 | -repeated_equality_comparison.py:4:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in ("a", "b")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:4:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in {"a", "b"}`. | 2 | foo == "a" or foo == "b" -3 | +3 | 4 | foo != "a" and foo != "b" | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -5 | +5 | 6 | foo == "a" or foo == "b" or foo == "c" | = help: Merge multiple comparisons @@ -35,18 +35,18 @@ repeated_equality_comparison.py:4:1: PLR1714 [*] Consider merging multiple compa 2 2 | foo == "a" or foo == "b" 3 3 | 4 |-foo != "a" and foo != "b" - 4 |+foo not in ("a", "b") + 4 |+foo not in {"a", "b"} 5 5 | 6 6 | foo == "a" or foo == "b" or foo == "c" 7 7 | -repeated_equality_comparison.py:6:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:6:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b", "c"}`. | 4 | foo != "a" and foo != "b" -5 | +5 | 6 | foo == "a" or foo == "b" or foo == "c" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -7 | +7 | 8 | foo != "a" and foo != "b" and foo != "c" | = help: Merge multiple comparisons @@ -56,18 +56,18 @@ repeated_equality_comparison.py:6:1: PLR1714 [*] Consider merging multiple compa 4 4 | foo != "a" and foo != "b" 5 5 | 6 |-foo == "a" or foo == "b" or foo == "c" - 6 |+foo in ("a", "b", "c") + 6 |+foo in {"a", "b", "c"} 7 7 | 8 8 | foo != "a" and foo != "b" and foo != "c" 9 9 | -repeated_equality_comparison.py:8:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:8:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in {"a", "b", "c"}`. | 6 | foo == "a" or foo == "b" or foo == "c" - 7 | + 7 | 8 | foo != "a" and foo != "b" and foo != "c" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 - 9 | + 9 | 10 | foo == a or foo == "b" or foo == 3 # Mixed types. | = help: Merge multiple comparisons @@ -77,7 +77,7 @@ repeated_equality_comparison.py:8:1: PLR1714 [*] Consider merging multiple compa 6 6 | foo == "a" or foo == "b" or foo == "c" 7 7 | 8 |-foo != "a" and foo != "b" and foo != "c" - 8 |+foo not in ("a", "b", "c") + 8 |+foo not in {"a", "b", "c"} 9 9 | 10 10 | foo == a or foo == "b" or foo == 3 # Mixed types. 11 11 | @@ -85,10 +85,10 @@ repeated_equality_comparison.py:8:1: PLR1714 [*] Consider merging multiple compa repeated_equality_comparison.py:10:1: PLR1714 [*] Consider merging multiple comparisons: `foo in (a, "b", 3)`. Use a `set` if the elements are hashable. | 8 | foo != "a" and foo != "b" and foo != "c" - 9 | + 9 | 10 | foo == a or foo == "b" or foo == 3 # Mixed types. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -11 | +11 | 12 | "a" == foo or "b" == foo or "c" == foo | = help: Merge multiple comparisons @@ -103,13 +103,13 @@ repeated_equality_comparison.py:10:1: PLR1714 [*] Consider merging multiple comp 12 12 | "a" == foo or "b" == foo or "c" == foo 13 13 | -repeated_equality_comparison.py:12:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:12:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b", "c"}`. | 10 | foo == a or foo == "b" or foo == 3 # Mixed types. -11 | +11 | 12 | "a" == foo or "b" == foo or "c" == foo | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -13 | +13 | 14 | "a" != foo and "b" != foo and "c" != foo | = help: Merge multiple comparisons @@ -119,18 +119,18 @@ repeated_equality_comparison.py:12:1: PLR1714 [*] Consider merging multiple comp 10 10 | foo == a or foo == "b" or foo == 3 # Mixed types. 11 11 | 12 |-"a" == foo or "b" == foo or "c" == foo - 12 |+foo in ("a", "b", "c") + 12 |+foo in {"a", "b", "c"} 13 13 | 14 14 | "a" != foo and "b" != foo and "c" != foo 15 15 | -repeated_equality_comparison.py:14:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:14:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in {"a", "b", "c"}`. | 12 | "a" == foo or "b" == foo or "c" == foo -13 | +13 | 14 | "a" != foo and "b" != foo and "c" != foo | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -15 | +15 | 16 | "a" == foo or foo == "b" or "c" == foo | = help: Merge multiple comparisons @@ -140,18 +140,18 @@ repeated_equality_comparison.py:14:1: PLR1714 [*] Consider merging multiple comp 12 12 | "a" == foo or "b" == foo or "c" == foo 13 13 | 14 |-"a" != foo and "b" != foo and "c" != foo - 14 |+foo not in ("a", "b", "c") + 14 |+foo not in {"a", "b", "c"} 15 15 | 16 16 | "a" == foo or foo == "b" or "c" == foo 17 17 | -repeated_equality_comparison.py:16:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:16:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b", "c"}`. | 14 | "a" != foo and "b" != foo and "c" != foo -15 | +15 | 16 | "a" == foo or foo == "b" or "c" == foo | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -17 | +17 | 18 | foo == bar or baz == foo or qux == foo | = help: Merge multiple comparisons @@ -161,7 +161,7 @@ repeated_equality_comparison.py:16:1: PLR1714 [*] Consider merging multiple comp 14 14 | "a" != foo and "b" != foo and "c" != foo 15 15 | 16 |-"a" == foo or foo == "b" or "c" == foo - 16 |+foo in ("a", "b", "c") + 16 |+foo in {"a", "b", "c"} 17 17 | 18 18 | foo == bar or baz == foo or qux == foo 19 19 | @@ -169,10 +169,10 @@ repeated_equality_comparison.py:16:1: PLR1714 [*] Consider merging multiple comp repeated_equality_comparison.py:18:1: PLR1714 [*] Consider merging multiple comparisons: `foo in (bar, baz, qux)`. Use a `set` if the elements are hashable. | 16 | "a" == foo or foo == "b" or "c" == foo -17 | +17 | 18 | foo == bar or baz == foo or qux == foo | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -19 | +19 | 20 | foo == "a" or "b" == foo or foo == "c" | = help: Merge multiple comparisons @@ -187,13 +187,13 @@ repeated_equality_comparison.py:18:1: PLR1714 [*] Consider merging multiple comp 20 20 | foo == "a" or "b" == foo or foo == "c" 21 21 | -repeated_equality_comparison.py:20:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:20:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b", "c"}`. | 18 | foo == bar or baz == foo or qux == foo -19 | +19 | 20 | foo == "a" or "b" == foo or foo == "c" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -21 | +21 | 22 | foo != "a" and "b" != foo and foo != "c" | = help: Merge multiple comparisons @@ -203,18 +203,18 @@ repeated_equality_comparison.py:20:1: PLR1714 [*] Consider merging multiple comp 18 18 | foo == bar or baz == foo or qux == foo 19 19 | 20 |-foo == "a" or "b" == foo or foo == "c" - 20 |+foo in ("a", "b", "c") + 20 |+foo in {"a", "b", "c"} 21 21 | 22 22 | foo != "a" and "b" != foo and foo != "c" 23 23 | -repeated_equality_comparison.py:22:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in ("a", "b", "c")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:22:1: PLR1714 [*] Consider merging multiple comparisons: `foo not in {"a", "b", "c"}`. | 20 | foo == "a" or "b" == foo or foo == "c" -21 | +21 | 22 | foo != "a" and "b" != foo and foo != "c" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -23 | +23 | 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets | = help: Merge multiple comparisons @@ -224,18 +224,18 @@ repeated_equality_comparison.py:22:1: PLR1714 [*] Consider merging multiple comp 20 20 | foo == "a" or "b" == foo or foo == "c" 21 21 | 22 |-foo != "a" and "b" != foo and foo != "c" - 22 |+foo not in ("a", "b", "c") + 22 |+foo not in {"a", "b", "c"} 23 23 | 24 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets 25 25 | -repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b"}`. | 22 | foo != "a" and "b" != foo and foo != "c" -23 | +23 | 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -25 | +25 | 26 | foo.bar == "a" or foo.bar == "b" # Attributes. | = help: Merge multiple comparisons @@ -245,18 +245,18 @@ repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comp 22 22 | foo != "a" and "b" != foo and foo != "c" 23 23 | 24 |-foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets - 24 |+foo in ("a", "b") or "c" == bar or "d" == bar # Multiple targets + 24 |+foo in {"a", "b"} or "c" == bar or "d" == bar # Multiple targets 25 25 | 26 26 | foo.bar == "a" or foo.bar == "b" # Attributes. 27 27 | -repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comparisons: `bar in ("c", "d")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comparisons: `bar in {"c", "d"}`. | 22 | foo != "a" and "b" != foo and foo != "c" -23 | +23 | 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -25 | +25 | 26 | foo.bar == "a" or foo.bar == "b" # Attributes. | = help: Merge multiple comparisons @@ -266,18 +266,18 @@ repeated_equality_comparison.py:24:1: PLR1714 [*] Consider merging multiple comp 22 22 | foo != "a" and "b" != foo and foo != "c" 23 23 | 24 |-foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets - 24 |+foo == "a" or foo == "b" or bar in ("c", "d") # Multiple targets + 24 |+foo == "a" or foo == "b" or bar in {"c", "d"} # Multiple targets 25 25 | 26 26 | foo.bar == "a" or foo.bar == "b" # Attributes. 27 27 | -repeated_equality_comparison.py:26:1: PLR1714 [*] Consider merging multiple comparisons: `foo.bar in ("a", "b")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:26:1: PLR1714 [*] Consider merging multiple comparisons: `foo.bar in {"a", "b"}`. | 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets -25 | +25 | 26 | foo.bar == "a" or foo.bar == "b" # Attributes. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -27 | +27 | 28 | # OK | = help: Merge multiple comparisons @@ -287,18 +287,18 @@ repeated_equality_comparison.py:26:1: PLR1714 [*] Consider merging multiple comp 24 24 | foo == "a" or foo == "b" or "c" == bar or "d" == bar # Multiple targets 25 25 | 26 |-foo.bar == "a" or foo.bar == "b" # Attributes. - 26 |+foo.bar in ("a", "b") # Attributes. + 26 |+foo.bar in {"a", "b"} # Attributes. 27 27 | 28 28 | # OK 29 29 | foo == "a" and foo == "b" and foo == "c" # `and` mixed with `==`. -repeated_equality_comparison.py:61:16: PLR1714 [*] Consider merging multiple comparisons: `bar in ("c", "d")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:61:16: PLR1714 [*] Consider merging multiple comparisons: `bar in {"c", "d"}`. | 59 | foo == "a" or "c" == bar or foo == "b" or "d" == bar # Multiple targets -60 | +60 | 61 | foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -62 | +62 | 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets | = help: Merge multiple comparisons @@ -308,18 +308,18 @@ repeated_equality_comparison.py:61:16: PLR1714 [*] Consider merging multiple com 59 59 | foo == "a" or "c" == bar or foo == "b" or "d" == bar # Multiple targets 60 60 | 61 |-foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets - 61 |+foo == "a" or (bar in ("c", "d")) or foo == "b" # Multiple targets + 61 |+foo == "a" or (bar in {"c", "d"}) or foo == "b" # Multiple targets 62 62 | 63 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets 64 64 | -repeated_equality_comparison.py:63:1: PLR1714 [*] Consider merging multiple comparisons: `foo in ("a", "b")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:63:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {"a", "b"}`. | 61 | foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets -62 | +62 | 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -64 | +64 | 65 | foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets | = help: Merge multiple comparisons @@ -329,18 +329,18 @@ repeated_equality_comparison.py:63:1: PLR1714 [*] Consider merging multiple comp 61 61 | foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets 62 62 | 63 |-foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets - 63 |+foo in ("a", "b") or "c" != bar and "d" != bar # Multiple targets + 63 |+foo in {"a", "b"} or "c" != bar and "d" != bar # Multiple targets 64 64 | 65 65 | foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets 66 66 | -repeated_equality_comparison.py:63:29: PLR1714 [*] Consider merging multiple comparisons: `bar not in ("c", "d")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:63:29: PLR1714 [*] Consider merging multiple comparisons: `bar not in {"c", "d"}`. | 61 | foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets -62 | +62 | 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -64 | +64 | 65 | foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets | = help: Merge multiple comparisons @@ -350,18 +350,18 @@ repeated_equality_comparison.py:63:29: PLR1714 [*] Consider merging multiple com 61 61 | foo == "a" or ("c" == bar or "d" == bar) or foo == "b" # Multiple targets 62 62 | 63 |-foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets - 63 |+foo == "a" or foo == "b" or bar not in ("c", "d") # Multiple targets + 63 |+foo == "a" or foo == "b" or bar not in {"c", "d"} # Multiple targets 64 64 | 65 65 | foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets 66 66 | -repeated_equality_comparison.py:65:16: PLR1714 [*] Consider merging multiple comparisons: `bar not in ("c", "d")`. Use a `set` if the elements are hashable. +repeated_equality_comparison.py:65:16: PLR1714 [*] Consider merging multiple comparisons: `bar not in {"c", "d"}`. | 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets -64 | +64 | 65 | foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 -66 | +66 | 67 | foo == "a" and "c" != bar or foo == "b" and "d" != bar # Multiple targets | = help: Merge multiple comparisons @@ -371,6 +371,85 @@ repeated_equality_comparison.py:65:16: PLR1714 [*] Consider merging multiple com 63 63 | foo == "a" or foo == "b" or "c" != bar and "d" != bar # Multiple targets 64 64 | 65 |-foo == "a" or ("c" != bar and "d" != bar) or foo == "b" # Multiple targets - 65 |+foo == "a" or (bar not in ("c", "d")) or foo == "b" # Multiple targets + 65 |+foo == "a" or (bar not in {"c", "d"}) or foo == "b" # Multiple targets 66 66 | 67 67 | foo == "a" and "c" != bar or foo == "b" and "d" != bar # Multiple targets +68 68 | + +repeated_equality_comparison.py:69:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {1, True}`. + | +67 | foo == "a" and "c" != bar or foo == "b" and "d" != bar # Multiple targets +68 | +69 | foo == 1 or foo == True # Different types, same hashed value + | ^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 +70 | +71 | foo == 1 or foo == 1.0 # Different types, same hashed value + | + = help: Merge multiple comparisons + +ℹ Unsafe fix +66 66 | +67 67 | foo == "a" and "c" != bar or foo == "b" and "d" != bar # Multiple targets +68 68 | +69 |-foo == 1 or foo == True # Different types, same hashed value + 69 |+foo in {1, True} # Different types, same hashed value +70 70 | +71 71 | foo == 1 or foo == 1.0 # Different types, same hashed value +72 72 | + +repeated_equality_comparison.py:71:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {1, 1.0}`. + | +69 | foo == 1 or foo == True # Different types, same hashed value +70 | +71 | foo == 1 or foo == 1.0 # Different types, same hashed value + | ^^^^^^^^^^^^^^^^^^^^^^ PLR1714 +72 | +73 | foo == False or foo == 0 # Different types, same hashed value + | + = help: Merge multiple comparisons + +ℹ Unsafe fix +68 68 | +69 69 | foo == 1 or foo == True # Different types, same hashed value +70 70 | +71 |-foo == 1 or foo == 1.0 # Different types, same hashed value + 71 |+foo in {1, 1.0} # Different types, same hashed value +72 72 | +73 73 | foo == False or foo == 0 # Different types, same hashed value +74 74 | + +repeated_equality_comparison.py:73:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {False, 0}`. + | +71 | foo == 1 or foo == 1.0 # Different types, same hashed value +72 | +73 | foo == False or foo == 0 # Different types, same hashed value + | ^^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 +74 | +75 | foo == 0.0 or foo == 0j # Different types, same hashed value + | + = help: Merge multiple comparisons + +ℹ Unsafe fix +70 70 | +71 71 | foo == 1 or foo == 1.0 # Different types, same hashed value +72 72 | +73 |-foo == False or foo == 0 # Different types, same hashed value + 73 |+foo in {False, 0} # Different types, same hashed value +74 74 | +75 75 | foo == 0.0 or foo == 0j # Different types, same hashed value + +repeated_equality_comparison.py:75:1: PLR1714 [*] Consider merging multiple comparisons: `foo in {0.0, 0j}`. + | +73 | foo == False or foo == 0 # Different types, same hashed value +74 | +75 | foo == 0.0 or foo == 0j # Different types, same hashed value + | ^^^^^^^^^^^^^^^^^^^^^^^ PLR1714 + | + = help: Merge multiple comparisons + +ℹ Unsafe fix +72 72 | +73 73 | foo == False or foo == 0 # Different types, same hashed value +74 74 | +75 |-foo == 0.0 or foo == 0j # Different types, same hashed value + 75 |+foo in {0.0, 0j} # Different types, same hashed value diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1716_boolean_chained_comparison.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1716_boolean_chained_comparison.py.snap index 46f98755a10eb..649554548fadd 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1716_boolean_chained_comparison.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1716_boolean_chained_comparison.py.snap @@ -261,53 +261,234 @@ boolean_chained_comparison.py:73:24: PLR1716 [*] Contains chained boolean compar 75 75 | 76 76 | # ------------ -boolean_chained_comparison.py:124:2: PLR1716 Contains chained boolean comparison that can be simplified +boolean_chained_comparison.py:123:2: PLR1716 [*] Contains chained boolean comparison that can be simplified | -123 | # Unfixable due to parentheses. -124 | (a < b) and b < c +122 | # fixes will balance parentheses +123 | (a < b) and b < c | ^^^^^^^^^^^^^^^^ PLR1716 -125 | a < b and (b < c) -126 | ((a < b) and b < c) +124 | a < b and (b < c) +125 | ((a < b) and b < c) | = help: Use a single compare expression -boolean_chained_comparison.py:125:1: PLR1716 Contains chained boolean comparison that can be simplified +ℹ Safe fix +120 120 | pass +121 121 | +122 122 | # fixes will balance parentheses +123 |-(a < b) and b < c + 123 |+(a < b < c) +124 124 | a < b and (b < c) +125 125 | ((a < b) and b < c) +126 126 | (a < b) and (b < c) + +boolean_chained_comparison.py:124:1: PLR1716 [*] Contains chained boolean comparison that can be simplified | -123 | # Unfixable due to parentheses. -124 | (a < b) and b < c -125 | a < b and (b < c) +122 | # fixes will balance parentheses +123 | (a < b) and b < c +124 | a < b and (b < c) | ^^^^^^^^^^^^^^^^ PLR1716 -126 | ((a < b) and b < c) -127 | (a < b) and (b < c) +125 | ((a < b) and b < c) +126 | (a < b) and (b < c) | = help: Use a single compare expression -boolean_chained_comparison.py:126:3: PLR1716 Contains chained boolean comparison that can be simplified +ℹ Safe fix +121 121 | +122 122 | # fixes will balance parentheses +123 123 | (a < b) and b < c +124 |-a < b and (b < c) + 124 |+(a < b < c) +125 125 | ((a < b) and b < c) +126 126 | (a < b) and (b < c) +127 127 | (((a < b))) and (b < c) + +boolean_chained_comparison.py:125:3: PLR1716 [*] Contains chained boolean comparison that can be simplified | -124 | (a < b) and b < c -125 | a < b and (b < c) -126 | ((a < b) and b < c) +123 | (a < b) and b < c +124 | a < b and (b < c) +125 | ((a < b) and b < c) | ^^^^^^^^^^^^^^^^ PLR1716 -127 | (a < b) and (b < c) -128 | (((a < b))) and (b < c) +126 | (a < b) and (b < c) +127 | (((a < b))) and (b < c) | = help: Use a single compare expression -boolean_chained_comparison.py:127:2: PLR1716 Contains chained boolean comparison that can be simplified +ℹ Safe fix +122 122 | # fixes will balance parentheses +123 123 | (a < b) and b < c +124 124 | a < b and (b < c) +125 |-((a < b) and b < c) + 125 |+((a < b < c)) +126 126 | (a < b) and (b < c) +127 127 | (((a < b))) and (b < c) +128 128 | + +boolean_chained_comparison.py:126:2: PLR1716 [*] Contains chained boolean comparison that can be simplified | -125 | a < b and (b < c) -126 | ((a < b) and b < c) -127 | (a < b) and (b < c) +124 | a < b and (b < c) +125 | ((a < b) and b < c) +126 | (a < b) and (b < c) | ^^^^^^^^^^^^^^^^^ PLR1716 -128 | (((a < b))) and (b < c) +127 | (((a < b))) and (b < c) | = help: Use a single compare expression -boolean_chained_comparison.py:128:4: PLR1716 Contains chained boolean comparison that can be simplified +ℹ Safe fix +123 123 | (a < b) and b < c +124 124 | a < b and (b < c) +125 125 | ((a < b) and b < c) +126 |-(a < b) and (b < c) + 126 |+(a < b < c) +127 127 | (((a < b))) and (b < c) +128 128 | +129 129 | (a<b) and b<c and ((c<d)) + +boolean_chained_comparison.py:127:4: PLR1716 [*] Contains chained boolean comparison that can be simplified | -126 | ((a < b) and b < c) -127 | (a < b) and (b < c) -128 | (((a < b))) and (b < c) +125 | ((a < b) and b < c) +126 | (a < b) and (b < c) +127 | (((a < b))) and (b < c) | ^^^^^^^^^^^^^^^^^^^ PLR1716 +128 | +129 | (a<b) and b<c and ((c<d)) + | + = help: Use a single compare expression + +ℹ Safe fix +124 124 | a < b and (b < c) +125 125 | ((a < b) and b < c) +126 126 | (a < b) and (b < c) +127 |-(((a < b))) and (b < c) + 127 |+(((a < b < c))) +128 128 | +129 129 | (a<b) and b<c and ((c<d)) +130 130 | + +boolean_chained_comparison.py:129:2: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +127 | (((a < b))) and (b < c) +128 | +129 | (a<b) and b<c and ((c<d)) + | ^^^^^^^^^^^^ PLR1716 +130 | +131 | # should error and fix + | + = help: Use a single compare expression + +ℹ Safe fix +126 126 | (a < b) and (b < c) +127 127 | (((a < b))) and (b < c) +128 128 | +129 |-(a<b) and b<c and ((c<d)) + 129 |+(a<b<c) and ((c<d)) +130 130 | +131 131 | # should error and fix +132 132 | a<b<c and c<d + +boolean_chained_comparison.py:129:11: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +127 | (((a < b))) and (b < c) +128 | +129 | (a<b) and b<c and ((c<d)) + | ^^^^^^^^^^^^^ PLR1716 +130 | +131 | # should error and fix + | + = help: Use a single compare expression + +ℹ Safe fix +126 126 | (a < b) and (b < c) +127 127 | (((a < b))) and (b < c) +128 128 | +129 |-(a<b) and b<c and ((c<d)) + 129 |+(a<b) and ((b<c<d)) +130 130 | +131 131 | # should error and fix +132 132 | a<b<c and c<d + +boolean_chained_comparison.py:132:1: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +131 | # should error and fix +132 | a<b<c and c<d + | ^^^^^^^^^^^^^ PLR1716 +133 | +134 | # more involved examples (all should error and fix) + | + = help: Use a single compare expression + +ℹ Safe fix +129 129 | (a<b) and b<c and ((c<d)) +130 130 | +131 131 | # should error and fix +132 |-a<b<c and c<d + 132 |+a<b<c<d +133 133 | +134 134 | # more involved examples (all should error and fix) +135 135 | a < ( # sneaky comment + +boolean_chained_comparison.py:135:1: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +134 | # more involved examples (all should error and fix) +135 | / a < ( # sneaky comment +136 | | b +137 | | # more comments +138 | | ) and b < c + | |___________^ PLR1716 +139 | +140 | ( | = help: Use a single compare expression + +ℹ Safe fix +135 135 | a < ( # sneaky comment +136 136 | b +137 137 | # more comments +138 |-) and b < c + 138 |+) < c +139 139 | +140 140 | ( +141 141 | a + +boolean_chained_comparison.py:141:5: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +140 | ( +141 | / a +142 | | <b +143 | | # hmmm... +144 | | <c +145 | | and ((c<d)) + | |_____________^ PLR1716 +146 | ) + | + = help: Use a single compare expression + +ℹ Safe fix +138 138 | ) and b < c +139 139 | +140 140 | ( +141 |- a + 141 |+ ((a +142 142 | <b +143 143 | # hmmm... +144 |- <c +145 |- and ((c<d)) + 144 |+ <c<d)) +146 145 | ) +147 146 | +148 147 | a < (b) and (((b)) < c) + +boolean_chained_comparison.py:148:1: PLR1716 [*] Contains chained boolean comparison that can be simplified + | +146 | ) +147 | +148 | a < (b) and (((b)) < c) + | ^^^^^^^^^^^^^^^^^^^^^^ PLR1716 + | + = help: Use a single compare expression + +ℹ Safe fix +145 145 | and ((c<d)) +146 146 | ) +147 147 | +148 |-a < (b) and (((b)) < c) + 148 |+(a < (b) < c) diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_0.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_0.py.snap index 290c2cc893219..022ee5888c3d8 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_0.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_0.py:1:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | @@ -73,5 +74,3 @@ sys_exit_alias_0.py:7:5: PLR1722 [*] Use `sys.exit()` instead of `quit` 6 7 | exit(2) 7 |- quit(2) 8 |+ sys.exit(2) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_1.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_1.py.snap index f2124e8dedb5d..986e16f9b216d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_1.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_1.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_1.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | import sys -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 4 | quit(0) @@ -79,7 +79,7 @@ sys_exit_alias_1.py:9:5: PLR1722 [*] Use `sys.exit()` instead of `quit` sys_exit_alias_1.py:15:5: PLR1722 Use `sys.exit()` instead of `exit` | 13 | sys = 1 -14 | +14 | 15 | exit(1) | ^^^^ PLR1722 16 | quit(1) @@ -93,5 +93,3 @@ sys_exit_alias_1.py:16:5: PLR1722 Use `sys.exit()` instead of `quit` | ^^^^ PLR1722 | = help: Replace `quit` with `sys.exit()` - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_10.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_10.py.snap index 9328cd82d4b1b..d8bfe3033e4a4 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_10.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_10.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_10.py:8:5: PLR1722 Use `sys.exit()` instead of `exit` | @@ -8,5 +9,3 @@ sys_exit_alias_10.py:8:5: PLR1722 Use `sys.exit()` instead of `exit` | ^^^^ PLR1722 | = help: Replace `exit` with `sys.exit()` - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_11.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_11.py.snap index 4f537fcd13484..3475c756f2b8f 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_11.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_11.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_11.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | from sys import * -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 | @@ -16,5 +16,3 @@ sys_exit_alias_11.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` 2 3 | 3 |-exit(0) 4 |+sys.exit(0) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_12.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_12.py.snap index 8221f82db5848..081f770791f0b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_12.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_12.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_12.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | import os \ -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 | @@ -16,5 +16,3 @@ sys_exit_alias_12.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` 2 2 | 3 |-exit(0) 3 |+sys.exit(0) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_13.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_13.py.snap new file mode 100644 index 0000000000000..ecca433ff993a --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_13.py.snap @@ -0,0 +1,15 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +sys_exit_alias_13.py:1:1: PLR1722 [*] Use `sys.exit()` instead of `exit` + | +1 | exit(code=2) + | ^^^^ PLR1722 + | + = help: Replace `exit` with `sys.exit()` + +ℹ Unsafe fix +1 |-exit(code=2) + 1 |+import sys + 2 |+sys.exit(2) +2 3 | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_14.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_14.py.snap new file mode 100644 index 0000000000000..208d3ee4f78a5 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_14.py.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +sys_exit_alias_14.py:2:1: PLR1722 Use `sys.exit()` instead of `exit` + | +1 | code = {"code": 2} +2 | exit(**code) + | ^^^^ PLR1722 + | + = help: Replace `exit` with `sys.exit()` diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_15.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_15.py.snap new file mode 100644 index 0000000000000..f0c8b0d054537 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_15.py.snap @@ -0,0 +1,21 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +sys_exit_alias_15.py:6:1: PLR1722 [*] Use `sys.exit()` instead of `exit` + | +4 | else: +5 | code = 1 +6 | exit(code) + | ^^^^ PLR1722 + | + = help: Replace `exit` with `sys.exit()` + +ℹ Unsafe fix + 1 |+import sys +1 2 | success = True +2 3 | if success: +3 4 | code = 0 +4 5 | else: +5 6 | code = 1 +6 |-exit(code) + 7 |+sys.exit(code) diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_16.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_16.py.snap new file mode 100644 index 0000000000000..1e8b7d377f303 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_16.py.snap @@ -0,0 +1,81 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +sys_exit_alias_16.py:3:5: PLR1722 [*] Use `sys.exit()` instead of `exit` + | +1 | def test_case_1(): +2 | # comments preserved with a positional argument +3 | exit( # comment + | ^^^^ PLR1722 +4 | 1, # 2 +5 | ) # 3 + | + = help: Replace `exit` with `sys.exit()` + +ℹ Unsafe fix + 1 |+import sys +1 2 | def test_case_1(): +2 3 | # comments preserved with a positional argument +3 |- exit( # comment + 4 |+ sys.exit( # comment +4 5 | 1, # 2 +5 6 | ) # 3 +6 7 | + +sys_exit_alias_16.py:10:5: PLR1722 [*] Use `sys.exit()` instead of `exit` + | + 8 | def test_case_2(): + 9 | # comments preserved with a single keyword argument +10 | exit( # comment + | ^^^^ PLR1722 +11 | code=1, # 2 +12 | ) # 3 + | + = help: Replace `exit` with `sys.exit()` + +ℹ Unsafe fix + 1 |+import sys +1 2 | def test_case_1(): +2 3 | # comments preserved with a positional argument +3 4 | exit( # comment +-------------------------------------------------------------------------------- +7 8 | +8 9 | def test_case_2(): +9 10 | # comments preserved with a single keyword argument +10 |- exit( # comment +11 |- code=1, # 2 + 11 |+ sys.exit( # comment + 12 |+ 1, # 2 +12 13 | ) # 3 +13 14 | +14 15 | + +sys_exit_alias_16.py:17:5: PLR1722 Use `sys.exit()` instead of `exit` + | +15 | def test_case_3(): +16 | # no diagnostic for multiple arguments +17 | exit(2, 3, 4) + | ^^^^ PLR1722 + | + = help: Replace `exit` with `sys.exit()` + +sys_exit_alias_16.py:23:5: PLR1722 [*] Use `sys.exit()` instead of `exit` + | +21 | # this should now be fixable +22 | codes = [1] +23 | exit(*codes) + | ^^^^ PLR1722 + | + = help: Replace `exit` with `sys.exit()` + +ℹ Unsafe fix + 1 |+import sys +1 2 | def test_case_1(): +2 3 | # comments preserved with a positional argument +3 4 | exit( # comment +-------------------------------------------------------------------------------- +20 21 | def test_case_4(): +21 22 | # this should now be fixable +22 23 | codes = [1] +23 |- exit(*codes) + 24 |+ sys.exit(*codes) diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_2.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_2.py.snap index d5faaa92dafae..fa77515597857 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_2.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_2.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_2.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | import sys as sys2 -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 4 | quit(0) @@ -70,5 +70,3 @@ sys_exit_alias_2.py:9:5: PLR1722 [*] Use `sys.exit()` instead of `quit` 8 8 | exit(1) 9 |- quit(1) 9 |+ sys2.exit(1) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_3.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_3.py.snap index c7faa956b3164..43e4361fe2310 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_3.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_3.py:4:1: PLR1722 [*] Use `sys.exit()` instead of `quit` | @@ -45,5 +46,3 @@ sys_exit_alias_3.py:16:5: PLR1722 Use `sys.exit()` instead of `quit` | ^^^^ PLR1722 | = help: Replace `quit` with `sys.exit()` - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_4.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_4.py.snap index 9a41754444964..5f17881fe8d0f 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_4.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_4.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_4.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | from sys import exit as exit2 -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 4 | quit(0) @@ -70,5 +70,3 @@ sys_exit_alias_4.py:9:5: PLR1722 [*] Use `sys.exit()` instead of `quit` 8 8 | exit(1) 9 |- quit(1) 9 |+ exit2(1) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_5.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_5.py.snap index 8a6bbc5f3eadd..99a789f9efbf9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_5.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_5.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs sys_exit_alias_5.py:3:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | 1 | from sys import * -2 | +2 | 3 | exit(0) | ^^^^ PLR1722 4 | quit(0) @@ -83,5 +83,3 @@ sys_exit_alias_5.py:9:5: PLR1722 [*] Use `sys.exit()` instead of `quit` 8 9 | exit(1) 9 |- quit(1) 10 |+ sys.exit(1) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_6.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_6.py.snap index 87119e06653e7..bff2c47eec8dd 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_6.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_6.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_6.py:1:1: PLR1722 [*] Use `sys.exit()` instead of `exit` | @@ -33,5 +34,3 @@ sys_exit_alias_6.py:2:1: PLR1722 [*] Use `sys.exit()` instead of `quit` 3 4 | 4 5 | 5 6 | def exit(e): - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_7.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_7.py.snap index 4c32e7cc3a49e..072845bb2e11c 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_7.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_7.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_7.py:2:5: PLR1722 [*] Use `sys.exit()` instead of `exit` | @@ -17,5 +18,3 @@ sys_exit_alias_7.py:2:5: PLR1722 [*] Use `sys.exit()` instead of `exit` 3 4 | 4 5 | 5 6 | import functools - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_8.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_8.py.snap index 1423a41dba204..337821b7d4410 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_8.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_8.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_8.py:5:5: PLR1722 [*] Use `sys.exit()` instead of `exit` | @@ -15,5 +16,3 @@ sys_exit_alias_8.py:5:5: PLR1722 [*] Use `sys.exit()` instead of `exit` 2 2 | 3 3 | 4 4 | def main(): - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_9.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_9.py.snap index 23107f606658f..019462ca2604b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_9.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1722_sys_exit_alias_9.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- sys_exit_alias_9.py:2:5: PLR1722 [*] Use `sys.exit()` instead of `exit` | @@ -17,5 +18,3 @@ sys_exit_alias_9.py:2:5: PLR1722 [*] Use `sys.exit()` instead of `exit` 3 4 | 4 5 | 5 6 | from sys import argv - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1730_if_stmt_min_max.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1730_if_stmt_min_max.py.snap index 52baee302a31d..89aec8775ee6c 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1730_if_stmt_min_max.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1730_if_stmt_min_max.py.snap @@ -1,486 +1,780 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs --- -if_stmt_min_max.py:8:1: PLR1730 [*] Replace `if` statement with `value = max(value, 10)` +if_stmt_min_max.py:21:1: PLR1730 [*] Replace `if` statement with `a = min(b, a)` | - 7 | # Positive - 8 | / if value < 10: # [max-instead-of-if] - 9 | | value = 10 - | |______________^ PLR1730 -10 | -11 | if value <= 10: # [max-instead-of-if] +20 | # case 1: a = min(b, a) +21 | / if a >= b: +22 | | a = b + | |_________^ PLR1730 +23 | +24 | # case 2: a = max(b, a) | - = help: Replace with `value = max(value, 10)` + = help: Replace with `a = min(b, a)` ℹ Safe fix -5 5 | value3 = 3 -6 6 | -7 7 | # Positive -8 |-if value < 10: # [max-instead-of-if] -9 |- value = 10 - 8 |+value = max(value, 10) -10 9 | -11 10 | if value <= 10: # [max-instead-of-if] -12 11 | value = 10 - -if_stmt_min_max.py:11:1: PLR1730 [*] Replace `if` statement with `value = max(10, value)` - | - 9 | value = 10 -10 | -11 | / if value <= 10: # [max-instead-of-if] -12 | | value = 10 - | |______________^ PLR1730 -13 | -14 | if value < value2: # [max-instead-of-if] +18 18 | a, b = [], [] +19 19 | +20 20 | # case 1: a = min(b, a) +21 |-if a >= b: +22 |- a = b + 21 |+a = min(b, a) +23 22 | +24 23 | # case 2: a = max(b, a) +25 24 | if a <= b: + +if_stmt_min_max.py:25:1: PLR1730 [*] Replace `if` statement with `a = max(b, a)` | - = help: Replace with `value = max(10, value)` - -ℹ Safe fix -8 8 | if value < 10: # [max-instead-of-if] -9 9 | value = 10 -10 10 | -11 |-if value <= 10: # [max-instead-of-if] -12 |- value = 10 - 11 |+value = max(10, value) -13 12 | -14 13 | if value < value2: # [max-instead-of-if] -15 14 | value = value2 - -if_stmt_min_max.py:14:1: PLR1730 [*] Replace `if` statement with `value = max(value, value2)` - | -12 | value = 10 -13 | -14 | / if value < value2: # [max-instead-of-if] -15 | | value = value2 - | |__________________^ PLR1730 -16 | -17 | if value > 10: # [min-instead-of-if] +24 | # case 2: a = max(b, a) +25 | / if a <= b: +26 | | a = b + | |_________^ PLR1730 +27 | +28 | # case 3: b = min(a, b) | - = help: Replace with `value = max(value, value2)` + = help: Replace with `a = max(b, a)` ℹ Safe fix -11 11 | if value <= 10: # [max-instead-of-if] -12 12 | value = 10 -13 13 | -14 |-if value < value2: # [max-instead-of-if] -15 |- value = value2 - 14 |+value = max(value, value2) -16 15 | -17 16 | if value > 10: # [min-instead-of-if] -18 17 | value = 10 - -if_stmt_min_max.py:17:1: PLR1730 [*] Replace `if` statement with `value = min(value, 10)` - | -15 | value = value2 -16 | -17 | / if value > 10: # [min-instead-of-if] -18 | | value = 10 - | |______________^ PLR1730 -19 | -20 | if value >= 10: # [min-instead-of-if] +22 22 | a = b +23 23 | +24 24 | # case 2: a = max(b, a) +25 |-if a <= b: +26 |- a = b + 25 |+a = max(b, a) +27 26 | +28 27 | # case 3: b = min(a, b) +29 28 | if a <= b: + +if_stmt_min_max.py:29:1: PLR1730 [*] Replace `if` statement with `b = min(a, b)` | - = help: Replace with `value = min(value, 10)` - -ℹ Safe fix -14 14 | if value < value2: # [max-instead-of-if] -15 15 | value = value2 -16 16 | -17 |-if value > 10: # [min-instead-of-if] -18 |- value = 10 - 17 |+value = min(value, 10) -19 18 | -20 19 | if value >= 10: # [min-instead-of-if] -21 20 | value = 10 - -if_stmt_min_max.py:20:1: PLR1730 [*] Replace `if` statement with `value = min(10, value)` - | -18 | value = 10 -19 | -20 | / if value >= 10: # [min-instead-of-if] -21 | | value = 10 - | |______________^ PLR1730 -22 | -23 | if value > value2: # [min-instead-of-if] +28 | # case 3: b = min(a, b) +29 | / if a <= b: +30 | | b = a + | |_________^ PLR1730 +31 | +32 | # case 4: b = max(a, b) | - = help: Replace with `value = min(10, value)` + = help: Replace with `b = min(a, b)` ℹ Safe fix -17 17 | if value > 10: # [min-instead-of-if] -18 18 | value = 10 -19 19 | -20 |-if value >= 10: # [min-instead-of-if] -21 |- value = 10 - 20 |+value = min(10, value) -22 21 | -23 22 | if value > value2: # [min-instead-of-if] -24 23 | value = value2 - -if_stmt_min_max.py:23:1: PLR1730 [*] Replace `if` statement with `value = min(value, value2)` - | -21 | value = 10 -22 | -23 | / if value > value2: # [min-instead-of-if] -24 | | value = value2 - | |__________________^ PLR1730 +26 26 | a = b +27 27 | +28 28 | # case 3: b = min(a, b) +29 |-if a <= b: +30 |- b = a + 29 |+b = min(a, b) +31 30 | +32 31 | # case 4: b = max(a, b) +33 32 | if a >= b: + +if_stmt_min_max.py:33:1: PLR1730 [*] Replace `if` statement with `b = max(a, b)` | - = help: Replace with `value = min(value, value2)` - -ℹ Safe fix -20 20 | if value >= 10: # [min-instead-of-if] -21 21 | value = 10 -22 22 | -23 |-if value > value2: # [min-instead-of-if] -24 |- value = value2 - 23 |+value = min(value, value2) -25 24 | -26 25 | -27 26 | class A: - -if_stmt_min_max.py:33:1: PLR1730 [*] Replace `if` statement with `A1.value = max(A1.value, 10)` - | -32 | A1 = A() -33 | / if A1.value < 10: # [max-instead-of-if] -34 | | A1.value = 10 - | |_________________^ PLR1730 -35 | -36 | if A1.value > 10: # [min-instead-of-if] +32 | # case 4: b = max(a, b) +33 | / if a >= b: +34 | | b = a + | |_________^ PLR1730 +35 | +36 | # case 5: a = min(a, b) | - = help: Replace with `A1.value = max(A1.value, 10)` + = help: Replace with `b = max(a, b)` ℹ Safe fix -30 30 | +30 30 | b = a 31 31 | -32 32 | A1 = A() -33 |-if A1.value < 10: # [max-instead-of-if] -34 |- A1.value = 10 - 33 |+A1.value = max(A1.value, 10) +32 32 | # case 4: b = max(a, b) +33 |-if a >= b: +34 |- b = a + 33 |+b = max(a, b) 35 34 | -36 35 | if A1.value > 10: # [min-instead-of-if] -37 36 | A1.value = 10 +36 35 | # case 5: a = min(a, b) +37 36 | if a > b: -if_stmt_min_max.py:36:1: PLR1730 [*] Replace `if` statement with `A1.value = min(A1.value, 10)` +if_stmt_min_max.py:37:1: PLR1730 [*] Replace `if` statement with `a = min(a, b)` | -34 | A1.value = 10 -35 | -36 | / if A1.value > 10: # [min-instead-of-if] -37 | | A1.value = 10 - | |_________________^ PLR1730 +36 | # case 5: a = min(a, b) +37 | / if a > b: +38 | | a = b + | |_________^ PLR1730 +39 | +40 | # case 6: a = max(a, b) | - = help: Replace with `A1.value = min(A1.value, 10)` + = help: Replace with `a = min(a, b)` ℹ Safe fix -33 33 | if A1.value < 10: # [max-instead-of-if] -34 34 | A1.value = 10 +34 34 | b = a 35 35 | -36 |-if A1.value > 10: # [min-instead-of-if] -37 |- A1.value = 10 - 36 |+A1.value = min(A1.value, 10) -38 37 | +36 36 | # case 5: a = min(a, b) +37 |-if a > b: +38 |- a = b + 37 |+a = min(a, b) 39 38 | -40 39 | class AA: +40 39 | # case 6: a = max(a, b) +41 40 | if a < b: -if_stmt_min_max.py:60:1: PLR1730 [*] Replace `if` statement with `A2 = max(A2, A1)` +if_stmt_min_max.py:41:1: PLR1730 [*] Replace `if` statement with `a = max(a, b)` | -58 | A2 = AA(3) -59 | -60 | / if A2 < A1: # [max-instead-of-if] -61 | | A2 = A1 - | |___________^ PLR1730 -62 | -63 | if A2 <= A1: # [max-instead-of-if] +40 | # case 6: a = max(a, b) +41 | / if a < b: +42 | | a = b + | |_________^ PLR1730 +43 | +44 | # case 7: b = min(b, a) | - = help: Replace with `A2 = max(A2, A1)` + = help: Replace with `a = max(a, b)` ℹ Safe fix -57 57 | A1 = AA(0) -58 58 | A2 = AA(3) -59 59 | -60 |-if A2 < A1: # [max-instead-of-if] -61 |- A2 = A1 - 60 |+A2 = max(A2, A1) -62 61 | -63 62 | if A2 <= A1: # [max-instead-of-if] -64 63 | A2 = A1 - -if_stmt_min_max.py:63:1: PLR1730 [*] Replace `if` statement with `A2 = max(A1, A2)` - | -61 | A2 = A1 -62 | -63 | / if A2 <= A1: # [max-instead-of-if] -64 | | A2 = A1 - | |___________^ PLR1730 -65 | -66 | if A2 > A1: # [min-instead-of-if] - | - = help: Replace with `A2 = max(A1, A2)` +38 38 | a = b +39 39 | +40 40 | # case 6: a = max(a, b) +41 |-if a < b: +42 |- a = b + 41 |+a = max(a, b) +43 42 | +44 43 | # case 7: b = min(b, a) +45 44 | if a < b: + +if_stmt_min_max.py:45:1: PLR1730 [*] Replace `if` statement with `b = min(b, a)` + | +44 | # case 7: b = min(b, a) +45 | / if a < b: +46 | | b = a + | |_________^ PLR1730 +47 | +48 | # case 8: b = max(b, a) + | + = help: Replace with `b = min(b, a)` + +ℹ Safe fix +42 42 | a = b +43 43 | +44 44 | # case 7: b = min(b, a) +45 |-if a < b: +46 |- b = a + 45 |+b = min(b, a) +47 46 | +48 47 | # case 8: b = max(b, a) +49 48 | if a > b: + +if_stmt_min_max.py:49:1: PLR1730 [*] Replace `if` statement with `b = max(b, a)` + | +48 | # case 8: b = max(b, a) +49 | / if a > b: +50 | | b = a + | |_________^ PLR1730 + | + = help: Replace with `b = max(b, a)` ℹ Safe fix -60 60 | if A2 < A1: # [max-instead-of-if] -61 61 | A2 = A1 -62 62 | -63 |-if A2 <= A1: # [max-instead-of-if] -64 |- A2 = A1 - 63 |+A2 = max(A1, A2) +46 46 | b = a +47 47 | +48 48 | # case 8: b = max(b, a) +49 |-if a > b: +50 |- b = a + 49 |+b = max(b, a) +51 50 | +52 51 | +53 52 | # test cases with assigned variables and primitives + +if_stmt_min_max.py:59:1: PLR1730 [*] Replace `if` statement with `value = max(value, 10)` + | +58 | # base case 6: value = max(value, 10) +59 | / if value < 10: +60 | | value = 10 + | |______________^ PLR1730 +61 | +62 | # base case 2: value = max(10, value) + | + = help: Replace with `value = max(value, 10)` + +ℹ Safe fix +56 56 | value3 = 3 +57 57 | +58 58 | # base case 6: value = max(value, 10) +59 |-if value < 10: +60 |- value = 10 + 59 |+value = max(value, 10) +61 60 | +62 61 | # base case 2: value = max(10, value) +63 62 | if value <= 10: + +if_stmt_min_max.py:63:1: PLR1730 [*] Replace `if` statement with `value = max(10, value)` + | +62 | # base case 2: value = max(10, value) +63 | / if value <= 10: +64 | | value = 10 + | |______________^ PLR1730 +65 | +66 | # base case 6: value = max(value, value2) + | + = help: Replace with `value = max(10, value)` + +ℹ Safe fix +60 60 | value = 10 +61 61 | +62 62 | # base case 2: value = max(10, value) +63 |-if value <= 10: +64 |- value = 10 + 63 |+value = max(10, value) 65 64 | -66 65 | if A2 > A1: # [min-instead-of-if] -67 66 | A2 = A1 +66 65 | # base case 6: value = max(value, value2) +67 66 | if value < value2: -if_stmt_min_max.py:66:1: PLR1730 [*] Replace `if` statement with `A2 = min(A2, A1)` +if_stmt_min_max.py:67:1: PLR1730 [*] Replace `if` statement with `value = max(value, value2)` | -64 | A2 = A1 -65 | -66 | / if A2 > A1: # [min-instead-of-if] -67 | | A2 = A1 - | |___________^ PLR1730 -68 | -69 | if A2 >= A1: # [min-instead-of-if] +66 | # base case 6: value = max(value, value2) +67 | / if value < value2: +68 | | value = value2 + | |__________________^ PLR1730 +69 | +70 | # base case 5: value = min(value, 10) | - = help: Replace with `A2 = min(A2, A1)` + = help: Replace with `value = max(value, value2)` ℹ Safe fix -63 63 | if A2 <= A1: # [max-instead-of-if] -64 64 | A2 = A1 +64 64 | value = 10 65 65 | -66 |-if A2 > A1: # [min-instead-of-if] -67 |- A2 = A1 - 66 |+A2 = min(A2, A1) -68 67 | -69 68 | if A2 >= A1: # [min-instead-of-if] -70 69 | A2 = A1 +66 66 | # base case 6: value = max(value, value2) +67 |-if value < value2: +68 |- value = value2 + 67 |+value = max(value, value2) +69 68 | +70 69 | # base case 5: value = min(value, 10) +71 70 | if value > 10: + +if_stmt_min_max.py:71:1: PLR1730 [*] Replace `if` statement with `value = min(value, 10)` + | +70 | # base case 5: value = min(value, 10) +71 | / if value > 10: +72 | | value = 10 + | |______________^ PLR1730 +73 | +74 | # base case 1: value = min(10, value) + | + = help: Replace with `value = min(value, 10)` + +ℹ Safe fix +68 68 | value = value2 +69 69 | +70 70 | # base case 5: value = min(value, 10) +71 |-if value > 10: +72 |- value = 10 + 71 |+value = min(value, 10) +73 72 | +74 73 | # base case 1: value = min(10, value) +75 74 | if value >= 10: + +if_stmt_min_max.py:75:1: PLR1730 [*] Replace `if` statement with `value = min(10, value)` + | +74 | # base case 1: value = min(10, value) +75 | / if value >= 10: +76 | | value = 10 + | |______________^ PLR1730 +77 | +78 | # base case 5: value = min(value, value2) + | + = help: Replace with `value = min(10, value)` + +ℹ Safe fix +72 72 | value = 10 +73 73 | +74 74 | # base case 1: value = min(10, value) +75 |-if value >= 10: +76 |- value = 10 + 75 |+value = min(10, value) +77 76 | +78 77 | # base case 5: value = min(value, value2) +79 78 | if value > value2: + +if_stmt_min_max.py:79:1: PLR1730 [*] Replace `if` statement with `value = min(value, value2)` + | +78 | # base case 5: value = min(value, value2) +79 | / if value > value2: +80 | | value = value2 + | |__________________^ PLR1730 + | + = help: Replace with `value = min(value, value2)` -if_stmt_min_max.py:69:1: PLR1730 [*] Replace `if` statement with `A2 = min(A1, A2)` +ℹ Safe fix +76 76 | value = 10 +77 77 | +78 78 | # base case 5: value = min(value, value2) +79 |-if value > value2: +80 |- value = value2 + 79 |+value = min(value, value2) +81 80 | +82 81 | +83 82 | # cases with calls + +if_stmt_min_max.py:92:1: PLR1730 [*] Replace `if` statement with `A1.value = max(A1.value, 10)` | -67 | A2 = A1 -68 | -69 | / if A2 >= A1: # [min-instead-of-if] -70 | | A2 = A1 - | |___________^ PLR1730 -71 | -72 | # Negative +92 | / if A1.value < 10: +93 | | A1.value = 10 + | |_________________^ PLR1730 +94 | +95 | if A1.value > 10: | - = help: Replace with `A2 = min(A1, A2)` + = help: Replace with `A1.value = max(A1.value, 10)` ℹ Safe fix -66 66 | if A2 > A1: # [min-instead-of-if] -67 67 | A2 = A1 -68 68 | -69 |-if A2 >= A1: # [min-instead-of-if] -70 |- A2 = A1 - 69 |+A2 = min(A1, A2) -71 70 | -72 71 | # Negative -73 72 | if value < 10: - -if_stmt_min_max.py:132:1: PLR1730 [*] Replace `if` statement with `min` call - | -131 | # Parenthesized expressions -132 | / if value.attr > 3: -133 | | ( -134 | | value. -135 | | attr -136 | | ) = 3 +89 89 | A1 = A() +90 90 | +91 91 | +92 |-if A1.value < 10: +93 |- A1.value = 10 + 92 |+A1.value = max(A1.value, 10) +94 93 | +95 94 | if A1.value > 10: +96 95 | A1.value = 10 + +if_stmt_min_max.py:95:1: PLR1730 [*] Replace `if` statement with `A1.value = min(A1.value, 10)` + | +93 | A1.value = 10 +94 | +95 | / if A1.value > 10: +96 | | A1.value = 10 + | |_________________^ PLR1730 + | + = help: Replace with `A1.value = min(A1.value, 10)` + +ℹ Safe fix +92 92 | if A1.value < 10: +93 93 | A1.value = 10 +94 94 | +95 |-if A1.value > 10: +96 |- A1.value = 10 + 95 |+A1.value = min(A1.value, 10) +97 96 | +98 97 | +99 98 | class AA: + +if_stmt_min_max.py:119:1: PLR1730 [*] Replace `if` statement with `A2 = max(A2, A1)` + | +117 | A2 = AA(3) +118 | +119 | / if A2 < A1: # [max-instead-of-if] +120 | | A2 = A1 + | |___________^ PLR1730 +121 | +122 | if A2 <= A1: # [max-instead-of-if] + | + = help: Replace with `A2 = max(A2, A1)` + +ℹ Unsafe fix +116 116 | A1 = AA(0) +117 117 | A2 = AA(3) +118 118 | +119 |-if A2 < A1: # [max-instead-of-if] +120 |- A2 = A1 + 119 |+A2 = max(A2, A1) +121 120 | +122 121 | if A2 <= A1: # [max-instead-of-if] +123 122 | A2 = A1 + +if_stmt_min_max.py:122:1: PLR1730 [*] Replace `if` statement with `A2 = max(A1, A2)` + | +120 | A2 = A1 +121 | +122 | / if A2 <= A1: # [max-instead-of-if] +123 | | A2 = A1 + | |___________^ PLR1730 +124 | +125 | if A2 > A1: # [min-instead-of-if] + | + = help: Replace with `A2 = max(A1, A2)` + +ℹ Unsafe fix +119 119 | if A2 < A1: # [max-instead-of-if] +120 120 | A2 = A1 +121 121 | +122 |-if A2 <= A1: # [max-instead-of-if] +123 |- A2 = A1 + 122 |+A2 = max(A1, A2) +124 123 | +125 124 | if A2 > A1: # [min-instead-of-if] +126 125 | A2 = A1 + +if_stmt_min_max.py:125:1: PLR1730 [*] Replace `if` statement with `A2 = min(A2, A1)` + | +123 | A2 = A1 +124 | +125 | / if A2 > A1: # [min-instead-of-if] +126 | | A2 = A1 + | |___________^ PLR1730 +127 | +128 | if A2 >= A1: # [min-instead-of-if] + | + = help: Replace with `A2 = min(A2, A1)` + +ℹ Unsafe fix +122 122 | if A2 <= A1: # [max-instead-of-if] +123 123 | A2 = A1 +124 124 | +125 |-if A2 > A1: # [min-instead-of-if] +126 |- A2 = A1 + 125 |+A2 = min(A2, A1) +127 126 | +128 127 | if A2 >= A1: # [min-instead-of-if] +129 128 | A2 = A1 + +if_stmt_min_max.py:128:1: PLR1730 [*] Replace `if` statement with `A2 = min(A1, A2)` + | +126 | A2 = A1 +127 | +128 | / if A2 >= A1: # [min-instead-of-if] +129 | | A2 = A1 + | |___________^ PLR1730 +130 | +131 | # Negative + | + = help: Replace with `A2 = min(A1, A2)` + +ℹ Unsafe fix +125 125 | if A2 > A1: # [min-instead-of-if] +126 126 | A2 = A1 +127 127 | +128 |-if A2 >= A1: # [min-instead-of-if] +129 |- A2 = A1 + 128 |+A2 = min(A1, A2) +130 129 | +131 130 | # Negative +132 131 | if value < 10: + +if_stmt_min_max.py:191:1: PLR1730 [*] Replace `if` statement with `min` call + | +190 | # Parenthesized expressions +191 | / if value.attr > 3: +192 | | ( +193 | | value. +194 | | attr +195 | | ) = 3 | |_________^ PLR1730 -137 | -138 | class Foo: +196 | +197 | class Foo: | = help: Replace with `min` call ℹ Safe fix -129 129 | value = 2 -130 130 | -131 131 | # Parenthesized expressions -132 |-if value.attr > 3: -133 |- ( - 132 |+( -134 133 | value. -135 134 | attr -136 |- ) = 3 - 135 |+ ) = min(value.attr, 3) -137 136 | -138 137 | class Foo: -139 138 | _min = 0 - -if_stmt_min_max.py:143:9: PLR1730 [*] Replace `if` statement with `self._min = min(value, self._min)` - | -142 | def foo(self, value) -> None: -143 | if value < self._min: - | _________^ -144 | | self._min = value +188 188 | value = 2 +189 189 | +190 190 | # Parenthesized expressions +191 |-if value.attr > 3: +192 |- ( + 191 |+( +193 192 | value. +194 193 | attr +195 |- ) = 3 + 194 |+ ) = min(value.attr, 3) +196 195 | +197 196 | class Foo: +198 197 | _min = 0 + +if_stmt_min_max.py:202:9: PLR1730 [*] Replace `if` statement with `self._min = min(self._min, value)` + | +201 | def foo(self, value) -> None: +202 | / if value < self._min: +203 | | self._min = value | |_____________________________^ PLR1730 -145 | if value > self._max: -146 | self._max = value +204 | if value > self._max: +205 | self._max = value | - = help: Replace with `self._min = min(value, self._min)` + = help: Replace with `self._min = min(self._min, value)` ℹ Safe fix -140 140 | _max = 0 -141 141 | -142 142 | def foo(self, value) -> None: -143 |- if value < self._min: -144 |- self._min = value - 143 |+ self._min = min(value, self._min) -145 144 | if value > self._max: -146 145 | self._max = value -147 146 | - -if_stmt_min_max.py:145:9: PLR1730 [*] Replace `if` statement with `self._max = max(value, self._max)` - | -143 | if value < self._min: -144 | self._min = value -145 | if value > self._max: - | _________^ -146 | | self._max = value +199 199 | _max = 0 +200 200 | +201 201 | def foo(self, value) -> None: +202 |- if value < self._min: +203 |- self._min = value + 202 |+ self._min = min(self._min, value) +204 203 | if value > self._max: +205 204 | self._max = value +206 205 | + +if_stmt_min_max.py:204:9: PLR1730 [*] Replace `if` statement with `self._max = max(self._max, value)` + | +202 | if value < self._min: +203 | self._min = value +204 | / if value > self._max: +205 | | self._max = value | |_____________________________^ PLR1730 -147 | -148 | if self._min < value: +206 | +207 | if self._min < value: | - = help: Replace with `self._max = max(value, self._max)` + = help: Replace with `self._max = max(self._max, value)` ℹ Safe fix -142 142 | def foo(self, value) -> None: -143 143 | if value < self._min: -144 144 | self._min = value -145 |- if value > self._max: -146 |- self._max = value - 145 |+ self._max = max(value, self._max) -147 146 | -148 147 | if self._min < value: -149 148 | self._min = value - -if_stmt_min_max.py:148:9: PLR1730 [*] Replace `if` statement with `self._min = max(self._min, value)` - | -146 | self._max = value -147 | -148 | if self._min < value: - | _________^ -149 | | self._min = value +201 201 | def foo(self, value) -> None: +202 202 | if value < self._min: +203 203 | self._min = value +204 |- if value > self._max: +205 |- self._max = value + 204 |+ self._max = max(self._max, value) +206 205 | +207 206 | if self._min < value: +208 207 | self._min = value + +if_stmt_min_max.py:207:9: PLR1730 [*] Replace `if` statement with `self._min = max(self._min, value)` + | +205 | self._max = value +206 | +207 | / if self._min < value: +208 | | self._min = value | |_____________________________^ PLR1730 -150 | if self._max > value: -151 | self._max = value +209 | if self._max > value: +210 | self._max = value | = help: Replace with `self._min = max(self._min, value)` ℹ Safe fix -145 145 | if value > self._max: -146 146 | self._max = value -147 147 | -148 |- if self._min < value: -149 |- self._min = value - 148 |+ self._min = max(self._min, value) -150 149 | if self._max > value: -151 150 | self._max = value -152 151 | - -if_stmt_min_max.py:150:9: PLR1730 [*] Replace `if` statement with `self._max = min(self._max, value)` - | -148 | if self._min < value: -149 | self._min = value -150 | if self._max > value: - | _________^ -151 | | self._max = value +204 204 | if value > self._max: +205 205 | self._max = value +206 206 | +207 |- if self._min < value: +208 |- self._min = value + 207 |+ self._min = max(self._min, value) +209 208 | if self._max > value: +210 209 | self._max = value +211 210 | + +if_stmt_min_max.py:209:9: PLR1730 [*] Replace `if` statement with `self._max = min(self._max, value)` + | +207 | if self._min < value: +208 | self._min = value +209 | / if self._max > value: +210 | | self._max = value | |_____________________________^ PLR1730 -152 | -153 | if value <= self._min: +211 | +212 | if value <= self._min: | = help: Replace with `self._max = min(self._max, value)` ℹ Safe fix -147 147 | -148 148 | if self._min < value: -149 149 | self._min = value -150 |- if self._max > value: -151 |- self._max = value - 150 |+ self._max = min(self._max, value) -152 151 | -153 152 | if value <= self._min: -154 153 | self._min = value - -if_stmt_min_max.py:153:9: PLR1730 [*] Replace `if` statement with `self._min = min(self._min, value)` - | -151 | self._max = value -152 | -153 | if value <= self._min: - | _________^ -154 | | self._min = value +206 206 | +207 207 | if self._min < value: +208 208 | self._min = value +209 |- if self._max > value: +210 |- self._max = value + 209 |+ self._max = min(self._max, value) +211 210 | +212 211 | if value <= self._min: +213 212 | self._min = value + +if_stmt_min_max.py:212:9: PLR1730 [*] Replace `if` statement with `self._min = min(value, self._min)` + | +210 | self._max = value +211 | +212 | / if value <= self._min: +213 | | self._min = value | |_____________________________^ PLR1730 -155 | if value >= self._max: -156 | self._max = value +214 | if value >= self._max: +215 | self._max = value | - = help: Replace with `self._min = min(self._min, value)` + = help: Replace with `self._min = min(value, self._min)` ℹ Safe fix -150 150 | if self._max > value: -151 151 | self._max = value -152 152 | -153 |- if value <= self._min: -154 |- self._min = value - 153 |+ self._min = min(self._min, value) -155 154 | if value >= self._max: -156 155 | self._max = value -157 156 | - -if_stmt_min_max.py:155:9: PLR1730 [*] Replace `if` statement with `self._max = max(self._max, value)` - | -153 | if value <= self._min: -154 | self._min = value -155 | if value >= self._max: - | _________^ -156 | | self._max = value +209 209 | if self._max > value: +210 210 | self._max = value +211 211 | +212 |- if value <= self._min: +213 |- self._min = value + 212 |+ self._min = min(value, self._min) +214 213 | if value >= self._max: +215 214 | self._max = value +216 215 | + +if_stmt_min_max.py:214:9: PLR1730 [*] Replace `if` statement with `self._max = max(value, self._max)` + | +212 | if value <= self._min: +213 | self._min = value +214 | / if value >= self._max: +215 | | self._max = value | |_____________________________^ PLR1730 -157 | -158 | if self._min <= value: +216 | +217 | if self._min <= value: | - = help: Replace with `self._max = max(self._max, value)` + = help: Replace with `self._max = max(value, self._max)` ℹ Safe fix -152 152 | -153 153 | if value <= self._min: -154 154 | self._min = value -155 |- if value >= self._max: -156 |- self._max = value - 155 |+ self._max = max(self._max, value) -157 156 | -158 157 | if self._min <= value: -159 158 | self._min = value - -if_stmt_min_max.py:158:9: PLR1730 [*] Replace `if` statement with `self._min = max(value, self._min)` - | -156 | self._max = value -157 | -158 | if self._min <= value: - | _________^ -159 | | self._min = value +211 211 | +212 212 | if value <= self._min: +213 213 | self._min = value +214 |- if value >= self._max: +215 |- self._max = value + 214 |+ self._max = max(value, self._max) +216 215 | +217 216 | if self._min <= value: +218 217 | self._min = value + +if_stmt_min_max.py:217:9: PLR1730 [*] Replace `if` statement with `self._min = max(value, self._min)` + | +215 | self._max = value +216 | +217 | / if self._min <= value: +218 | | self._min = value | |_____________________________^ PLR1730 -160 | if self._max >= value: -161 | self._max = value +219 | if self._max >= value: +220 | self._max = value | = help: Replace with `self._min = max(value, self._min)` ℹ Safe fix -155 155 | if value >= self._max: -156 156 | self._max = value -157 157 | -158 |- if self._min <= value: -159 |- self._min = value - 158 |+ self._min = max(value, self._min) -160 159 | if self._max >= value: -161 160 | self._max = value - -if_stmt_min_max.py:160:9: PLR1730 [*] Replace `if` statement with `self._max = min(value, self._max)` - | -158 | if self._min <= value: -159 | self._min = value -160 | if self._max >= value: - | _________^ -161 | | self._max = value +214 214 | if value >= self._max: +215 215 | self._max = value +216 216 | +217 |- if self._min <= value: +218 |- self._min = value + 217 |+ self._min = max(value, self._min) +219 218 | if self._max >= value: +220 219 | self._max = value +221 220 | + +if_stmt_min_max.py:219:9: PLR1730 [*] Replace `if` statement with `self._max = min(value, self._max)` + | +217 | if self._min <= value: +218 | self._min = value +219 | / if self._max >= value: +220 | | self._max = value | |_____________________________^ PLR1730 | = help: Replace with `self._max = min(value, self._max)` ℹ Safe fix -157 157 | -158 158 | if self._min <= value: -159 159 | self._min = value -160 |- if self._max >= value: -161 |- self._max = value - 160 |+ self._max = min(value, self._max) +216 216 | +217 217 | if self._min <= value: +218 218 | self._min = value +219 |- if self._max >= value: +220 |- self._max = value + 219 |+ self._max = min(value, self._max) +221 220 | +222 221 | +223 222 | counter = {"a": 0, "b": 0} + +if_stmt_min_max.py:226:1: PLR1730 [*] Replace `if` statement with `counter["a"] = max(counter["b"], counter["a"])` + | +225 | # base case 2: counter["a"] = max(counter["b"], counter["a"]) +226 | / if counter["a"] <= counter["b"]: +227 | | counter["a"] = counter["b"] + | |_______________________________^ PLR1730 +228 | +229 | # case 3: counter["b"] = min(counter["a"], counter["b"]) + | + = help: Replace with `counter["a"] = max(counter["b"], counter["a"])` + +ℹ Safe fix +223 223 | counter = {"a": 0, "b": 0} +224 224 | +225 225 | # base case 2: counter["a"] = max(counter["b"], counter["a"]) +226 |-if counter["a"] <= counter["b"]: +227 |- counter["a"] = counter["b"] + 226 |+counter["a"] = max(counter["b"], counter["a"]) +228 227 | +229 228 | # case 3: counter["b"] = min(counter["a"], counter["b"]) +230 229 | if counter["a"] <= counter["b"]: + +if_stmt_min_max.py:230:1: PLR1730 [*] Replace `if` statement with `counter["b"] = min(counter["a"], counter["b"])` + | +229 | # case 3: counter["b"] = min(counter["a"], counter["b"]) +230 | / if counter["a"] <= counter["b"]: +231 | | counter["b"] = counter["a"] + | |_______________________________^ PLR1730 +232 | +233 | # case 5: counter["a"] = min(counter["a"], counter["b"]) + | + = help: Replace with `counter["b"] = min(counter["a"], counter["b"])` + +ℹ Safe fix +227 227 | counter["a"] = counter["b"] +228 228 | +229 229 | # case 3: counter["b"] = min(counter["a"], counter["b"]) +230 |-if counter["a"] <= counter["b"]: +231 |- counter["b"] = counter["a"] + 230 |+counter["b"] = min(counter["a"], counter["b"]) +232 231 | +233 232 | # case 5: counter["a"] = min(counter["a"], counter["b"]) +234 233 | if counter["a"] > counter["b"]: + +if_stmt_min_max.py:234:1: PLR1730 [*] Replace `if` statement with `counter["b"] = max(counter["b"], counter["a"])` + | +233 | # case 5: counter["a"] = min(counter["a"], counter["b"]) +234 | / if counter["a"] > counter["b"]: +235 | | counter["b"] = counter["a"] + | |_______________________________^ PLR1730 +236 | +237 | # case 8: counter["a"] = max(counter["b"], counter["a"]) + | + = help: Replace with `counter["b"] = max(counter["b"], counter["a"])` + +ℹ Safe fix +231 231 | counter["b"] = counter["a"] +232 232 | +233 233 | # case 5: counter["a"] = min(counter["a"], counter["b"]) +234 |-if counter["a"] > counter["b"]: +235 |- counter["b"] = counter["a"] + 234 |+counter["b"] = max(counter["b"], counter["a"]) +236 235 | +237 236 | # case 8: counter["a"] = max(counter["b"], counter["a"]) +238 237 | if counter["a"] > counter["b"]: + +if_stmt_min_max.py:238:1: PLR1730 [*] Replace `if` statement with `counter["b"] = max(counter["b"], counter["a"])` + | +237 | # case 8: counter["a"] = max(counter["b"], counter["a"]) +238 | / if counter["a"] > counter["b"]: +239 | | counter["b"] = counter["a"] + | |_______________________________^ PLR1730 +240 | +241 | # https://github.com/astral-sh/ruff/issues/17311 + | + = help: Replace with `counter["b"] = max(counter["b"], counter["a"])` + +ℹ Safe fix +235 235 | counter["b"] = counter["a"] +236 236 | +237 237 | # case 8: counter["a"] = max(counter["b"], counter["a"]) +238 |-if counter["a"] > counter["b"]: +239 |- counter["b"] = counter["a"] + 238 |+counter["b"] = max(counter["b"], counter["a"]) +240 239 | +241 240 | # https://github.com/astral-sh/ruff/issues/17311 +242 241 | + +if_stmt_min_max.py:245:1: PLR1730 [*] Replace `if` statement with `a = min(b, a)` + | +243 | # fix marked unsafe as delete comments +244 | a, b = [], [] +245 | / if a >= b: +246 | | # very important comment +247 | | a = b + | |_________^ PLR1730 +248 | +249 | # fix marked safe as preserve comments + | + = help: Replace with `a = min(b, a)` + +ℹ Unsafe fix +242 242 | +243 243 | # fix marked unsafe as delete comments +244 244 | a, b = [], [] +245 |-if a >= b: +246 |- # very important comment +247 |- a = b + 245 |+a = min(b, a) +248 246 | +249 247 | # fix marked safe as preserve comments +250 248 | if a >= b: + +if_stmt_min_max.py:250:1: PLR1730 [*] Replace `if` statement with `a = min(b, a)` + | +249 | # fix marked safe as preserve comments +250 | / if a >= b: +251 | | a = b # very important comment + | |_________^ PLR1730 + | + = help: Replace with `a = min(b, a)` + +ℹ Safe fix +247 247 | a = b +248 248 | +249 249 | # fix marked safe as preserve comments +250 |-if a >= b: +251 |- a = b # very important comment + 250 |+a = min(b, a) # very important comment diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1733_unnecessary_dict_index_lookup.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1733_unnecessary_dict_index_lookup.py.snap index 44ae274800dc8..44822f1e92ec5 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1733_unnecessary_dict_index_lookup.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1733_unnecessary_dict_index_lookup.py.snap @@ -47,7 +47,7 @@ unnecessary_dict_index_lookup.py:6:18: PLR1733 [*] Unnecessary lookup of diction 5 | {FRUITS[fruit_name] for fruit_name, fruit_count in FRUITS.items()} # PLR1733 6 | {fruit_name: FRUITS[fruit_name] for fruit_name, fruit_count in FRUITS.items()} # PLR1733 | ^^^^^^^^^^^^^^^^^^ PLR1733 -7 | +7 | 8 | for fruit_name, fruit_count in FRUITS.items(): | = help: Use existing variable diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1736_unnecessary_list_index_lookup.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1736_unnecessary_list_index_lookup.py.snap index ff398797f4bae..af6f0edc2651a 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1736_unnecessary_list_index_lookup.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR1736_unnecessary_list_index_lookup.py.snap @@ -47,7 +47,7 @@ unnecessary_list_index_lookup.py:9:14: PLR1736 [*] List index lookup in `enumera 8 | {letters[index] for index, letter in enumerate(letters)} # PLR1736 9 | {letter: letters[index] for index, letter in enumerate(letters)} # PLR1736 | ^^^^^^^^^^^^^^ PLR1736 -10 | +10 | 11 | for index, letter in enumerate(letters): | = help: Use the loop variable directly @@ -108,7 +108,7 @@ unnecessary_list_index_lookup.py:14:16: PLR1736 [*] List index lookup in `enumer 13 | blah = letters[index] # PLR1736 14 | assert letters[index] == "d" # PLR1736 | ^^^^^^^^^^^^^^ PLR1736 -15 | +15 | 16 | for index, letter in builtins.enumerate(letters): | = help: Use the loop variable directly @@ -188,7 +188,7 @@ unnecessary_list_index_lookup.py:74:15: PLR1736 [*] List index lookup in `enumer 73 | for index, list_item in enumerate(some_list, start=0): 74 | print(some_list[index]) | ^^^^^^^^^^^^^^^^ PLR1736 -75 | +75 | 76 | # PLR1736 | = help: Use the loop variable directly diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2004_magic_value_comparison.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2004_magic_value_comparison.py.snap index 2f292d9d9a950..d5b501687f5d0 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2004_magic_value_comparison.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2004_magic_value_comparison.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs magic_value_comparison.py:5:4: PLR2004 Magic value used in comparison, consider replacing `10` with a constant variable | 3 | user_input = 10 -4 | +4 | 5 | if 10 > user_input: # [magic-value-comparison] | ^^ PLR2004 6 | pass @@ -13,7 +13,7 @@ magic_value_comparison.py:5:4: PLR2004 Magic value used in comparison, consider magic_value_comparison.py:47:12: PLR2004 Magic value used in comparison, consider replacing `2` with a constant variable | 45 | pass -46 | +46 | 47 | if argc != 2: # [magic-value-comparison] | ^ PLR2004 48 | pass @@ -22,7 +22,7 @@ magic_value_comparison.py:47:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:50:12: PLR2004 Magic value used in comparison, consider replacing `-2` with a constant variable | 48 | pass -49 | +49 | 50 | if argc != -2: # [magic-value-comparison] | ^^ PLR2004 51 | pass @@ -31,7 +31,7 @@ magic_value_comparison.py:50:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:53:12: PLR2004 Magic value used in comparison, consider replacing `+2` with a constant variable | 51 | pass -52 | +52 | 53 | if argc != +2: # [magic-value-comparison] | ^^ PLR2004 54 | pass @@ -40,7 +40,7 @@ magic_value_comparison.py:53:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:56:12: PLR2004 Magic value used in comparison, consider replacing `-2.0` with a constant variable | 54 | pass -55 | +55 | 56 | if argc != -2.0: # [magic-value-comparison] | ^^^^ PLR2004 57 | pass @@ -49,7 +49,7 @@ magic_value_comparison.py:56:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:59:12: PLR2004 Magic value used in comparison, consider replacing `+2.0` with a constant variable | 57 | pass -58 | +58 | 59 | if argc != +2.0: # [magic-value-comparison] | ^^^^ PLR2004 60 | pass @@ -58,7 +58,7 @@ magic_value_comparison.py:59:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:80:21: PLR2004 Magic value used in comparison, consider replacing `3.141592653589793238` with a constant variable | 78 | pi_estimation = 3.14 -79 | +79 | 80 | if pi_estimation == 3.141592653589793238: # [magic-value-comparison] | ^^^^^^^^^^^^^^^^^^^^ PLR2004 81 | pass @@ -67,10 +67,8 @@ magic_value_comparison.py:80:21: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:86:21: PLR2004 Magic value used in comparison, consider replacing `0x3` with a constant variable | 84 | pass -85 | +85 | 86 | if pi_estimation == 0x3: # [magic-value-comparison] | ^^^ PLR2004 87 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2044_empty_comment.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2044_empty_comment.py.snap index 94bb9acab3d1c..5b1a959bda5d9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2044_empty_comment.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2044_empty_comment.py.snap @@ -45,7 +45,7 @@ empty_comment.py:5:9: PLR2044 [*] Line with empty comment 4 | # 5 | # | ^ PLR2044 -6 | +6 | 7 | # this non-empty comment has trailing whitespace and is OK | = help: Delete the empty comment @@ -80,7 +80,7 @@ empty_comment.py:18:11: PLR2044 [*] Line with empty comment empty_comment.py:44:1: PLR2044 [*] Line with empty comment | 42 | # These should be removed, despite being an empty "block comment". -43 | +43 | 44 | # | ^ PLR2044 45 | # @@ -101,7 +101,7 @@ empty_comment.py:45:1: PLR2044 [*] Line with empty comment 44 | # 45 | # | ^ PLR2044 -46 | +46 | 47 | # These should also be removed. | = help: Delete the empty comment @@ -129,5 +129,3 @@ empty_comment.py:58:2: PLR2044 [*] Line with empty comment 57 57 | α = 1 58 |-α# 58 |+α - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR5501_collapsible_else_if.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR5501_collapsible_else_if.py.snap index d5b95a89eaa68..44b4747fc265b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR5501_collapsible_else_if.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR5501_collapsible_else_if.py.snap @@ -5,8 +5,7 @@ collapsible_else_if.py:37:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 35 | if 1: 36 | pass -37 | else: - | _____^ +37 | / else: 38 | | if 2: | |________^ PLR5501 39 | pass @@ -30,8 +29,7 @@ collapsible_else_if.py:45:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 43 | if 1: 44 | pass -45 | else: - | _____^ +45 | / else: 46 | | if 2: | |________^ PLR5501 47 | pass @@ -59,8 +57,7 @@ collapsible_else_if.py:55:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 53 | if 1: 54 | pass -55 | else: - | _____^ +55 | / else: 56 | | # inner comment 57 | | if 2: | |________^ PLR5501 @@ -91,8 +88,7 @@ collapsible_else_if.py:69:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 67 | elif True: 68 | print(2) -69 | else: - | _____^ +69 | / else: 70 | | if True: | |________^ PLR5501 71 | print(3) @@ -120,8 +116,7 @@ collapsible_else_if.py:79:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 77 | if 1: 78 | pass -79 | else: - | _____^ +79 | / else: 80 | | if 2: pass | |________^ PLR5501 81 | else: pass @@ -145,8 +140,7 @@ collapsible_else_if.py:87:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 85 | if 1: 86 | pass -87 | else: - | _____^ +87 | / else: 88 | | if 2: pass | |________^ PLR5501 89 | else: @@ -172,8 +166,7 @@ collapsible_else_if.py:96:5: PLR5501 [*] Use `elif` instead of `else` then `if`, | 94 | if 1: 95 | pass -96 | else: - | _____^ +96 | / else: 97 | | if 2: | |________^ PLR5501 98 | pass @@ -200,8 +193,7 @@ collapsible_else_if.py:105:5: PLR5501 [*] Use `elif` instead of `else` then `if` | 103 | if 1: 104 | pass -105 | else: - | _____^ +105 | / else: 106 | | # inner comment which happens 107 | | # to be longer than one line 108 | | if 2: @@ -235,8 +227,7 @@ collapsible_else_if.py:117:5: PLR5501 [*] Use `elif` instead of `else` then `if` | 115 | if 1: 116 | pass -117 | else: - | _____^ +117 | / else: 118 | | # inner comment which happens to be overly indented 119 | | if 2: | |________^ PLR5501 @@ -267,8 +258,7 @@ collapsible_else_if.py:128:5: PLR5501 [*] Use `elif` instead of `else` then `if` | 126 | if 1: 127 | pass -128 | else: - | _____^ +128 | / else: 129 | | # inner comment which happens to be under indented 130 | | if 2: | |________^ PLR5501 @@ -299,8 +289,7 @@ collapsible_else_if.py:139:5: PLR5501 [*] Use `elif` instead of `else` then `if` | 137 | if 1: 138 | pass -139 | else: - | _____^ +139 | / else: 140 | | # inner comment which has mixed 141 | | # indentation levels 142 | | # which is pretty weird diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6104_non_augmented_assignment.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6104_non_augmented_assignment.py.snap index a676c83cb8bae..9de292825ba33 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6104_non_augmented_assignment.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6104_non_augmented_assignment.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs non_augmented_assignment.py:16:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly | 14 | mat1, mat2 = None, None -15 | +15 | 16 | some_string = some_string + "a very long end of string" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 17 | index = index - 1 @@ -268,7 +268,7 @@ non_augmented_assignment.py:29:1: PLR6104 [*] Use `&=` to perform an augmented a 27 27 | to_cube = to_cube**to_cube 28 28 | timeDiffSeconds = timeDiffSeconds % 60 29 |-flags = flags & 0x1 - 29 |+flags &= 1 + 29 |+flags &= 0x1 30 30 | flags = flags | 0x1 31 31 | flags = flags ^ 0x1 32 32 | flags = flags << 1 @@ -289,7 +289,7 @@ non_augmented_assignment.py:30:1: PLR6104 [*] Use `|=` to perform an augmented a 28 28 | timeDiffSeconds = timeDiffSeconds % 60 29 29 | flags = flags & 0x1 30 |-flags = flags | 0x1 - 30 |+flags |= 1 + 30 |+flags |= 0x1 31 31 | flags = flags ^ 0x1 32 32 | flags = flags << 1 33 33 | flags = flags >> 1 @@ -310,7 +310,7 @@ non_augmented_assignment.py:31:1: PLR6104 [*] Use `^=` to perform an augmented a 29 29 | flags = flags & 0x1 30 30 | flags = flags | 0x1 31 |-flags = flags ^ 0x1 - 31 |+flags ^= 1 + 31 |+flags ^= 0x1 32 32 | flags = flags << 1 33 33 | flags = flags >> 1 34 34 | mat1 = mat1 @ mat2 @@ -383,7 +383,7 @@ non_augmented_assignment.py:35:1: PLR6104 [*] Use `+=` to perform an augmented a 34 | mat1 = mat1 @ mat2 35 | a_list[1] = a_list[1] + 1 | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 -36 | +36 | 37 | a_list[0:2] = a_list[0:2] * 3 | = help: Replace with augmented assignment @@ -401,7 +401,7 @@ non_augmented_assignment.py:35:1: PLR6104 [*] Use `+=` to perform an augmented a non_augmented_assignment.py:37:1: PLR6104 [*] Use `*=` to perform an augmented assignment directly | 35 | a_list[1] = a_list[1] + 1 -36 | +36 | 37 | a_list[0:2] = a_list[0:2] * 3 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 38 | a_list[:2] = a_list[:2] * 3 @@ -465,7 +465,7 @@ non_augmented_assignment.py:40:1: PLR6104 [*] Use `*=` to perform an augmented a 39 | a_list[1:] = a_list[1:] * 3 40 | a_list[:] = a_list[:] * 3 | ^^^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 -41 | +41 | 42 | index = index * (index + 10) | = help: Replace with augmented assignment @@ -483,7 +483,7 @@ non_augmented_assignment.py:40:1: PLR6104 [*] Use `*=` to perform an augmented a non_augmented_assignment.py:42:1: PLR6104 [*] Use `*=` to perform an augmented assignment directly | 40 | a_list[:] = a_list[:] * 3 -41 | +41 | 42 | index = index * (index + 10) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 | @@ -494,7 +494,7 @@ non_augmented_assignment.py:42:1: PLR6104 [*] Use `*=` to perform an augmented a 40 40 | a_list[:] = a_list[:] * 3 41 41 | 42 |-index = index * (index + 10) - 42 |+index *= index + 10 + 42 |+index *= (index + 10) 43 43 | 44 44 | 45 45 | class T: @@ -523,8 +523,6 @@ non_augmented_assignment.py:51:1: PLR6104 [*] Use `+=` to perform an augmented a 50 | obj = T() 51 | obj.a = obj.a + 1 | ^^^^^^^^^^^^^^^^^ PLR6104 -52 | -53 | # OK | = help: Replace with augmented assignment @@ -535,5 +533,213 @@ non_augmented_assignment.py:51:1: PLR6104 [*] Use `+=` to perform an augmented a 51 |-obj.a = obj.a + 1 51 |+obj.a += 1 52 52 | -53 53 | # OK -54 54 | a_list[0] = a_list[:] * 3 +53 53 | +54 54 | a = a+-1 + +non_augmented_assignment.py:54:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +54 | a = a+-1 + | ^^^^^^^^ PLR6104 +55 | +56 | # Regression tests for https://github.com/astral-sh/ruff/issues/11672 + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +51 51 | obj.a = obj.a + 1 +52 52 | +53 53 | +54 |-a = a+-1 + 54 |+a += -1 +55 55 | +56 56 | # Regression tests for https://github.com/astral-sh/ruff/issues/11672 +57 57 | test = 0x5 + +non_augmented_assignment.py:58:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +56 | # Regression tests for https://github.com/astral-sh/ruff/issues/11672 +57 | test = 0x5 +58 | test = test + 0xBA + | ^^^^^^^^^^^^^^^^^^ PLR6104 +59 | +60 | test2 = b"" + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +55 55 | +56 56 | # Regression tests for https://github.com/astral-sh/ruff/issues/11672 +57 57 | test = 0x5 +58 |-test = test + 0xBA + 58 |+test += 0xBA +59 59 | +60 60 | test2 = b"" +61 61 | test2 = test2 + b"\000" + +non_augmented_assignment.py:61:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +60 | test2 = b"" +61 | test2 = test2 + b"\000" + | ^^^^^^^^^^^^^^^^^^^^^^^ PLR6104 +62 | +63 | test3 = "" + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +58 58 | test = test + 0xBA +59 59 | +60 60 | test2 = b"" +61 |-test2 = test2 + b"\000" + 61 |+test2 += b"\000" +62 62 | +63 63 | test3 = "" +64 64 | test3 = test3 + ( a := R"" + +non_augmented_assignment.py:64:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +63 | test3 = "" +64 | / test3 = test3 + ( a := R"" +65 | | f"oo" ) + | |__________________________________^ PLR6104 +66 | +67 | test4 = [] + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +61 61 | test2 = test2 + b"\000" +62 62 | +63 63 | test3 = "" +64 |-test3 = test3 + ( a := R"" + 64 |+test3 += ( a := R"" +65 65 | f"oo" ) +66 66 | +67 67 | test4 = [] + +non_augmented_assignment.py:68:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +67 | test4 = [] +68 | / test4 = test4 + ( e +69 | | for e in +70 | | range(10) +71 | | ) + | |___________________^ PLR6104 +72 | +73 | test5 = test5 + ( + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +65 65 | f"oo" ) +66 66 | +67 67 | test4 = [] +68 |-test4 = test4 + ( e + 68 |+test4 += ( e +69 69 | for e in +70 70 | range(10) +71 71 | ) + +non_augmented_assignment.py:73:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +71 | ) +72 | +73 | / test5 = test5 + ( +74 | | 4 +75 | | * +76 | | 10 +77 | | ) + | |_^ PLR6104 +78 | +79 | test6 = test6 + \ + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +70 70 | range(10) +71 71 | ) +72 72 | +73 |-test5 = test5 + ( + 73 |+test5 += ( +74 74 | 4 +75 75 | * +76 76 | 10 + +non_augmented_assignment.py:79:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +77 | ) +78 | +79 | / test6 = test6 + \ +80 | | ( +81 | | 4 +82 | | * +83 | | 10 +84 | | ) + | |_________^ PLR6104 +85 | +86 | test7 = \ + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +76 76 | 10 +77 77 | ) +78 78 | +79 |-test6 = test6 + \ +80 |- ( + 79 |+test6 += ( +81 80 | 4 +82 81 | * +83 82 | 10 + +non_augmented_assignment.py:86:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +84 | ) +85 | +86 | / test7 = \ +87 | | 100 \ +88 | | + test7 + | |___________^ PLR6104 +89 | +90 | test8 = \ + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +83 83 | 10 +84 84 | ) +85 85 | +86 |-test7 = \ +87 |- 100 \ +88 |- + test7 + 86 |+test7 += 100 +89 87 | +90 88 | test8 = \ +91 89 | 886 \ + +non_augmented_assignment.py:90:1: PLR6104 [*] Use `+=` to perform an augmented assignment directly + | +88 | + test7 +89 | +90 | / test8 = \ +91 | | 886 \ +92 | | + \ +93 | | \ +94 | | test8 + | |_________^ PLR6104 + | + = help: Replace with augmented assignment + +ℹ Unsafe fix +87 87 | 100 \ +88 88 | + test7 +89 89 | +90 |-test8 = \ +91 |- 886 \ +92 |- + \ +93 |- \ +94 |- test8 + 90 |+test8 += 886 +95 91 | +96 92 | +97 93 | # OK diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6201_literal_membership.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6201_literal_membership.py.snap index 98cd73be366af..273ce58e09004 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6201_literal_membership.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6201_literal_membership.py.snap @@ -72,7 +72,7 @@ literal_membership.py:9:70: PLR6201 [*] Use a set literal when testing for membe 8 | "cherry" in fruits 9 | _ = {key: value for key, value in {"a": 1, "b": 2}.items() if key in ("a", "b")} | ^^^^^^^^^^ PLR6201 -10 | +10 | 11 | # OK | = help: Convert to `set` diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6301_no_self_use.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6301_no_self_use.py.snap index fe3f47b21f7e5..74818fdb391cc 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6301_no_self_use.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR6301_no_self_use.py.snap @@ -12,7 +12,7 @@ no_self_use.py:7:9: PLR6301 Method `developer_greeting` could be a function, cla no_self_use.py:10:9: PLR6301 Method `greeting_1` could be a function, class method, or static method | 8 | print(f"Greetings {name}!") - 9 | + 9 | 10 | def greeting_1(self): # [no-self-use] | ^^^^^^^^^^ PLR6301 11 | print("Hello!") @@ -21,7 +21,7 @@ no_self_use.py:10:9: PLR6301 Method `greeting_1` could be a function, class meth no_self_use.py:13:9: PLR6301 Method `greeting_2` could be a function, class method, or static method | 11 | print("Hello!") -12 | +12 | 13 | def greeting_2(self): # [no-self-use] | ^^^^^^^^^^ PLR6301 14 | print("Hi!") @@ -35,3 +35,43 @@ no_self_use.py:103:9: PLR6301 Method `validate_y` could be a function, class met 104 | if value <= 0: 105 | raise ValueError("y must be a positive integer") | + +no_self_use.py:128:9: PLR6301 Method `non_simple_assignment` could be a function, class method, or static method + | +126 | # Errors +127 | +128 | def non_simple_assignment(self): + | ^^^^^^^^^^^^^^^^^^^^^ PLR6301 +129 | msg = foo = "" +130 | raise NotImplementedError(msg) + | + +no_self_use.py:132:9: PLR6301 Method `non_simple_assignment_2` could be a function, class method, or static method + | +130 | raise NotImplementedError(msg) +131 | +132 | def non_simple_assignment_2(self): + | ^^^^^^^^^^^^^^^^^^^^^^^ PLR6301 +133 | msg[0] = "" +134 | raise NotImplementedError(msg) + | + +no_self_use.py:136:9: PLR6301 Method `unused_message` could be a function, class method, or static method + | +134 | raise NotImplementedError(msg) +135 | +136 | def unused_message(self): + | ^^^^^^^^^^^^^^ PLR6301 +137 | msg = "" +138 | raise NotImplementedError("") + | + +no_self_use.py:140:9: PLR6301 Method `unused_message_2` could be a function, class method, or static method + | +138 | raise NotImplementedError("") +139 | +140 | def unused_message_2(self, x): + | ^^^^^^^^^^^^^^^^ PLR6301 +141 | msg = "" +142 | raise NotImplementedError(x) + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0101_unreachable.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0101_unreachable.py.snap new file mode 100644 index 0000000000000..832f1db331d2a --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0101_unreachable.py.snap @@ -0,0 +1,34 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +unreachable.py:18:5: PLW0101 Unreachable code in `after_return` + | +16 | def after_return(): +17 | return 1 +18 | / print("unreachable") +19 | | print("and this") + | |_____________________^ PLW0101 +20 | +21 | def after_raise(): + | + +unreachable.py:23:5: PLW0101 Unreachable code in `after_raise` + | +21 | def after_raise(): +22 | raise ValueError +23 | / print("unreachable") +24 | | print("and this") + | |_____________________^ PLW0101 +25 | +26 | def multiple_returns(): + | + +unreachable.py:28:5: PLW0101 Unreachable code in `multiple_returns` + | +26 | def multiple_returns(): +27 | return 1 +28 | / print("unreachable") +29 | | return 2 +30 | | print("unreachable range should include above return") + | |__________________________________________________________^ PLW0101 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0108_unnecessary_lambda.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0108_unnecessary_lambda.py.snap index 74af7a647f7b6..e4e25f27e649d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0108_unnecessary_lambda.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0108_unnecessary_lambda.py.snap @@ -21,7 +21,7 @@ unnecessary_lambda.py:2:5: PLW0108 [*] Lambda may be unnecessary; consider inlin 1 | _ = lambda: print() # [unnecessary-lambda] 2 | _ = lambda x, y: min(x, y) # [unnecessary-lambda] | ^^^^^^^^^^^^^^^^^^^^^^ PLW0108 -3 | +3 | 4 | _ = lambda *args: f(*args) # [unnecessary-lambda] | = help: Inline function call @@ -37,7 +37,7 @@ unnecessary_lambda.py:2:5: PLW0108 [*] Lambda may be unnecessary; consider inlin unnecessary_lambda.py:4:5: PLW0108 [*] Lambda may be unnecessary; consider inlining inner function | 2 | _ = lambda x, y: min(x, y) # [unnecessary-lambda] -3 | +3 | 4 | _ = lambda *args: f(*args) # [unnecessary-lambda] | ^^^^^^^^^^^^^^^^^^^^^^ PLW0108 5 | _ = lambda **kwargs: f(**kwargs) # [unnecessary-lambda] @@ -101,7 +101,7 @@ unnecessary_lambda.py:7:5: PLW0108 [*] Lambda may be unnecessary; consider inlin 6 | _ = lambda *args, **kwargs: f(*args, **kwargs) # [unnecessary-lambda] 7 | _ = lambda x, y, z, *args, **kwargs: f(x, y, z, *args, **kwargs) # [unnecessary-lambda] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0108 -8 | +8 | 9 | _ = lambda x: f(lambda x: x)(x) # [unnecessary-lambda] | = help: Inline function call @@ -119,7 +119,7 @@ unnecessary_lambda.py:7:5: PLW0108 [*] Lambda may be unnecessary; consider inlin unnecessary_lambda.py:9:5: PLW0108 [*] Lambda may be unnecessary; consider inlining inner function | 7 | _ = lambda x, y, z, *args, **kwargs: f(x, y, z, *args, **kwargs) # [unnecessary-lambda] - 8 | + 8 | 9 | _ = lambda x: f(lambda x: x)(x) # [unnecessary-lambda] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0108 10 | _ = lambda x, y: f(lambda x, y: x + y)(x, y) # [unnecessary-lambda] @@ -141,7 +141,7 @@ unnecessary_lambda.py:10:5: PLW0108 [*] Lambda may be unnecessary; consider inli 9 | _ = lambda x: f(lambda x: x)(x) # [unnecessary-lambda] 10 | _ = lambda x, y: f(lambda x, y: x + y)(x, y) # [unnecessary-lambda] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0108 -11 | +11 | 12 | # default value in lambda parameters | = help: Inline function call diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0120_useless_else_on_loop.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0120_useless_else_on_loop.py.snap index ea72439be9eb0..0a03d7a4c441b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0120_useless_else_on_loop.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0120_useless_else_on_loop.py.snap @@ -48,7 +48,7 @@ useless_else_on_loop.py:18:5: PLW0120 [*] `else` clause on loop without a `break useless_else_on_loop.py:30:1: PLW0120 [*] `else` clause on loop without a `break` statement; remove the `else` and dedent its contents | 28 | break -29 | +29 | 30 | else: # [useless-else-on-loop] | ^^^^ PLW0120 31 | print("or else!") @@ -183,5 +183,3 @@ useless_else_on_loop.py:144:5: PLW0120 [*] `else` clause on loop without a `brea 145 |+ print("fat chance") 146 |+ for j in range(10): 147 |+ break - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0127_self_assigning_variable.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0127_self_assigning_variable.py.snap index 882bd21a0a030..e1489cb2ab472 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0127_self_assigning_variable.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0127_self_assigning_variable.py.snap @@ -394,7 +394,7 @@ self_assigning_variable.py:28:2: PLW0127 Self-assignment of variable `foo` 27 | (foo, bar) = (foo, bar) = baz 28 | (foo, bar) = baz = (foo, bar) = 1 | ^^^ PLW0127 -29 | +29 | 30 | # Non-errors. | @@ -404,8 +404,6 @@ self_assigning_variable.py:28:7: PLW0127 Self-assignment of variable `bar` 27 | (foo, bar) = (foo, bar) = baz 28 | (foo, bar) = baz = (foo, bar) = 1 | ^^^ PLW0127 -29 | +29 | 30 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0128_redeclared_assigned_name.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0128_redeclared_assigned_name.py.snap index eda5b8ea9f353..c3f54bdf9b68d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0128_redeclared_assigned_name.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0128_redeclared_assigned_name.py.snap @@ -42,7 +42,7 @@ redeclared_assigned_name.py:4:23: PLW0128 Redeclared variable `FIRST` in assignm 3 | FIRST, (FIRST, SECOND, (THIRD, FIRST)) = (1, (1, 2)) # PLW0128 4 | FIRST, SECOND, THIRD, FIRST, SECOND = (1, 2, 3, 4) # PLW0128 | ^^^^^ PLW0128 -5 | +5 | 6 | FIRST, SECOND, _, _, _ignored = (1, 2, 3, 4, 5) # OK | @@ -52,8 +52,6 @@ redeclared_assigned_name.py:4:30: PLW0128 Redeclared variable `SECOND` in assign 3 | FIRST, (FIRST, SECOND, (THIRD, FIRST)) = (1, (1, 2)) # PLW0128 4 | FIRST, SECOND, THIRD, FIRST, SECOND = (1, 2, 3, 4) # PLW0128 | ^^^^^^ PLW0128 -5 | +5 | 6 | FIRST, SECOND, _, _, _ignored = (1, 2, 3, 4, 5) # OK | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0129_assert_on_string_literal.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0129_assert_on_string_literal.py.snap index 6b87dcf58cf2c..120302d3dfacb 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0129_assert_on_string_literal.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0129_assert_on_string_literal.py.snap @@ -24,7 +24,7 @@ assert_on_string_literal.py:14:12: PLW0129 Asserting on a non-empty string liter 13 | except: 14 | assert "bad again" # [assert-on-string-literal] | ^^^^^^^^^^^ PLW0129 -15 | +15 | 16 | a = 12 | @@ -95,5 +95,3 @@ assert_on_string_literal.py:23:8: PLW0129 Asserting on a non-empty string litera | ^^^^^^^^^^^^^ PLW0129 24 | assert 12, "ok here" | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0131_named_expr_without_context.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0131_named_expr_without_context.py.snap index 9a3730761bea7..ae0e8efbf1682 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0131_named_expr_without_context.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0131_named_expr_without_context.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- named_expr_without_context.py:2:2: PLW0131 Named expression used without context | @@ -24,5 +25,3 @@ named_expr_without_context.py:8:6: PLW0131 Named expression used without context 8 | (c := 1) | ^^^^^^ PLW0131 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0133_useless_exception_statement.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0133_useless_exception_statement.py.snap index ab1a7935b8b6f..9df03f09946cc 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0133_useless_exception_statement.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0133_useless_exception_statement.py.snap @@ -85,7 +85,7 @@ useless_exception_statement.py:34:9: PLW0133 [*] Missing `raise` statement on ex 33 | def inner(): 34 | IndexError("This is an exception") # PLW0133 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0133 -35 | +35 | 36 | inner() | = help: Add `raise` keyword @@ -217,10 +217,10 @@ useless_exception_statement.py:71:5: PLW0133 [*] Missing `raise` statement on ex useless_exception_statement.py:126:1: PLW0133 [*] Missing `raise` statement on exception | 124 | import builtins -125 | +125 | 126 | builtins.TypeError("still an exception even though it's an Attribute") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0133 -127 | +127 | 128 | PythonFinalizationError("Added in Python 3.13") | = help: Add `raise` keyword @@ -237,7 +237,7 @@ useless_exception_statement.py:126:1: PLW0133 [*] Missing `raise` statement on e useless_exception_statement.py:128:1: PLW0133 [*] Missing `raise` statement on exception | 126 | builtins.TypeError("still an exception even though it's an Attribute") -127 | +127 | 128 | PythonFinalizationError("Added in Python 3.13") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0133 | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0177_nan_comparison.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0177_nan_comparison.py.snap index a4f659c5668e6..a9c4292f14771 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0177_nan_comparison.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0177_nan_comparison.py.snap @@ -88,3 +88,22 @@ nan_comparison.py:53:9: PLW0177 Comparing against a NaN value; use `math.isnan` | ^^^^^^^^^^^^^^^^^^^^^ PLW0177 54 | pass | + +nan_comparison.py:59:10: PLW0177 Comparing against a NaN value; use `np.isnan` instead + | +57 | match number: +58 | # Errors +59 | case np.nan: ... + | ^^^^^^ PLW0177 +60 | case math.nan: ... + | + +nan_comparison.py:60:10: PLW0177 Comparing against a NaN value; use `math.isnan` instead + | +58 | # Errors +59 | case np.nan: ... +60 | case math.nan: ... + | ^^^^^^^^ PLW0177 +61 | +62 | # No errors + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0211_bad_staticmethod_argument.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0211_bad_staticmethod_argument.py.snap index add63e311b094..9a18d7a33df55 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0211_bad_staticmethod_argument.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0211_bad_staticmethod_argument.py.snap @@ -26,3 +26,12 @@ bad_staticmethod_argument.py:19:15: PLW0211 First argument of a static method sh | ^^^^ PLW0211 20 | pass | + +bad_staticmethod_argument.py:55:17: PLW0211 First argument of a static method should not be named `self` + | +53 | # `self` but not with `cls` as first argument - see above). +54 | class Foo: +55 | def __new__(self, x, y, z): # [bad-staticmethod-argument] + | ^^^^ PLW0211 +56 | pass + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0244_redefined_slots_in_subclass.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0244_redefined_slots_in_subclass.py.snap new file mode 100644 index 0000000000000..8077c6868df13 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0244_redefined_slots_in_subclass.py.snap @@ -0,0 +1,34 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +redefined_slots_in_subclass.py:6:18: PLW0244 Slot `a` redefined from base class `Base` + | +5 | class Subclass(Base): +6 | __slots__ = ("a", "d") # [redefined-slots-in-subclass] + | ^^^ PLW0244 +7 | +8 | class Grandparent: + | + +redefined_slots_in_subclass.py:17:23: PLW0244 Slot `a` redefined from base class `Grandparent` + | +16 | class Child(Parent): +17 | __slots__ = ("c", "a") + | ^^^ PLW0244 +18 | +19 | class AnotherBase: + | + +redefined_slots_in_subclass.py:23:18: PLW0244 Slot `a` redefined from base class `AnotherBase` + | +22 | class AnotherChild(AnotherBase): +23 | __slots__ = ["a","b","e","f"] + | ^^^ PLW0244 + | + +redefined_slots_in_subclass.py:23:22: PLW0244 Slot `b` redefined from base class `AnotherBase` + | +22 | class AnotherChild(AnotherBase): +23 | __slots__ = ["a","b","e","f"] + | ^^^ PLW0244 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0245_super_without_brackets.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0245_super_without_brackets.py.snap index d2abe86131b9d..b52fb9601fee0 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0245_super_without_brackets.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0245_super_without_brackets.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- super_without_brackets.py:10:26: PLW0245 [*] `super` call is missing parentheses | @@ -19,6 +20,4 @@ super_without_brackets.py:10:26: PLW0245 [*] `super` call is missing parentheses 10 |+ original_speak = super().speak() # PLW0245 11 11 | return f"{original_speak} But as a dog, it barks!" 12 12 | -13 13 | - - +13 13 | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0406_import_self__module.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0406_import_self__module.py.snap index e2be6465689fe..7ac51eba2dbb3 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0406_import_self__module.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0406_import_self__module.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- module.py:1:8: PLW0406 Module `import_self.module` imports itself | @@ -24,5 +25,3 @@ module.py:3:15: PLW0406 Module `import_self.module` imports itself 3 | from . import module | ^^^^^^ PLW0406 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0602_global_variable_not_assigned.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0602_global_variable_not_assigned.py.snap index 61b98b457e680..3ba04a3cecd88 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0602_global_variable_not_assigned.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0602_global_variable_not_assigned.py.snap @@ -14,8 +14,6 @@ global_variable_not_assigned.py:9:12: PLW0602 Using global for `X` but no assign 8 | def f(): 9 | global X | ^ PLW0602 -10 | +10 | 11 | print(X) | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0603_global_statement.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0603_global_statement.py.snap index ad189b3ebbd6c..30959b0b116d5 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0603_global_statement.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0603_global_statement.py.snap @@ -55,7 +55,7 @@ global_statement.py:50:12: PLW0603 Using the global statement to update `CONSTAN 49 | """Function assigns should only throw a global statement error""" 50 | global CONSTANT # [global-statement] | ^^^^^^^^ PLW0603 -51 | +51 | 52 | def CONSTANT(): | @@ -65,7 +65,7 @@ global_statement.py:60:12: PLW0603 Using the global statement to update `FUNC` i 59 | """Overriding a function should only throw a global statement error""" 60 | global FUNC # [global-statement] | ^^^^ PLW0603 -61 | +61 | 62 | def FUNC(): | @@ -75,7 +75,7 @@ global_statement.py:70:12: PLW0603 Using the global statement to update `CLASS` 69 | """Overriding a class should only throw a global statement error""" 70 | global CLASS # [global-statement] | ^^^^^ PLW0603 -71 | +71 | 72 | class CLASS: | @@ -98,5 +98,3 @@ global_statement.py:80:12: PLW0603 Using the global statement to update `CONSTAN 81 | CONSTANT = 1 82 | CONSTANT = 2 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0604_global_at_module_level.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0604_global_at_module_level.py.snap index 75c9b9db2aa9a..7ca2dd0b69fe4 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0604_global_at_module_level.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0604_global_at_module_level.py.snap @@ -5,7 +5,7 @@ global_at_module_level.py:1:1: PLW0604 `global` at module level is redundant | 1 | global price # W0604 | ^^^^^^^^^^^^ PLW0604 -2 | +2 | 3 | price = 25 | @@ -14,8 +14,6 @@ global_at_module_level.py:6:5: PLW0604 `global` at module level is redundant 5 | if True: 6 | global X # W0604 | ^^^^^^^^ PLW0604 -7 | +7 | 8 | def no_error(): | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap index 315998894e2c3..e7521e397783c 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap @@ -61,7 +61,7 @@ self_or_cls_assignment.py:10:16: PLW0642 Reassigned `cls` variable in class meth 9 | blah, (cls, blah2) = "apple", ("orange", "banana") # PLW0642 10 | blah, [cls, blah2] = "apple", ("orange", "banana") # PLW0642 | ^^^ PLW0642 -11 | +11 | 12 | @classmethod | = help: Consider using a different variable name @@ -72,7 +72,7 @@ self_or_cls_assignment.py:14:9: PLW0642 Reassigned `cls` variable in class metho 13 | def add_fruits(cls, fruits, /) -> None: 14 | cls = fruits # PLW0642 | ^^^ PLW0642 -15 | +15 | 16 | def print_color(self) -> None: | = help: Consider using a different variable name @@ -136,7 +136,7 @@ self_or_cls_assignment.py:23:16: PLW0642 Reassigned `self` variable in instance 22 | blah, (self, blah2) = "apple", ("orange", "banana") # PLW0642 23 | blah, [self, blah2] = "apple", ("orange", "banana") # PLW0642 | ^^^^ PLW0642 -24 | +24 | 25 | def print_color(self, color, /) -> None: | = help: Consider using a different variable name @@ -146,7 +146,16 @@ self_or_cls_assignment.py:26:9: PLW0642 Reassigned `self` variable in instance m 25 | def print_color(self, color, /) -> None: 26 | self = color | ^^^^ PLW0642 -27 | +27 | 28 | def ok(self) -> None: | = help: Consider using a different variable name + +self_or_cls_assignment.py:50:9: PLW0642 Reassigned `cls` variable in `__new__` method + | +48 | class Foo: +49 | def __new__(cls): +50 | cls = "apple" # PLW0642 + | ^^^ PLW0642 + | + = help: Consider using a different variable name diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0711_binary_op_exception.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0711_binary_op_exception.py.snap index e8300c00e3b3d..d0f7bf9c11d2b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0711_binary_op_exception.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0711_binary_op_exception.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- binary_op_exception.py:3:8: PLW0711 Exception to catch is the result of a binary `or` operation | @@ -18,5 +19,3 @@ binary_op_exception.py:8:8: PLW0711 Exception to catch is the result of a binary | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW0711 9 | print(e) | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1501_bad_open_mode.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1501_bad_open_mode.py.snap index b029ad5b015d6..6c19b91ebe449 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1501_bad_open_mode.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1501_bad_open_mode.py.snap @@ -106,7 +106,7 @@ bad_open_mode.py:34:25: PLW1501 `rwx` is not a valid mode for `open` 33 | pathlib.Path(NAME).open(mode="rwx") # [bad-open-mode] 34 | pathlib.Path(NAME).open("rwx", encoding="utf-8") # [bad-open-mode] | ^^^^^ PLW1501 -35 | +35 | 36 | import builtins | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1507_shallow_copy_environ.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1507_shallow_copy_environ.py.snap new file mode 100644 index 0000000000000..45472379ba8b0 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1507_shallow_copy_environ.py.snap @@ -0,0 +1,38 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +shallow_copy_environ.py:4:14: PLW1507 [*] Shallow copy of `os.environ` via `copy.copy(os.environ)` + | +2 | import os +3 | +4 | copied_env = copy.copy(os.environ) # [shallow-copy-environ] + | ^^^^^^^^^^^^^^^^^^^^^ PLW1507 + | + = help: Replace with `os.environ.copy()` + +ℹ Unsafe fix +1 1 | import copy +2 2 | import os +3 3 | +4 |-copied_env = copy.copy(os.environ) # [shallow-copy-environ] + 4 |+copied_env = os.environ.copy() # [shallow-copy-environ] +5 5 | +6 6 | +7 7 | # Test case where the proposed fix is wrong, i.e., unsafe fix + +shallow_copy_environ.py:11:7: PLW1507 [*] Shallow copy of `os.environ` via `copy.copy(os.environ)` + | +10 | os.environ["X"] = "0" +11 | env = copy.copy(os.environ) + | ^^^^^^^^^^^^^^^^^^^^^ PLW1507 +12 | os.environ["X"] = "1" + | + = help: Replace with `os.environ.copy()` + +ℹ Unsafe fix +8 8 | # Ref: https://github.com/astral-sh/ruff/issues/16274#event-16423475135 +9 9 | +10 10 | os.environ["X"] = "0" +11 |-env = copy.copy(os.environ) + 11 |+env = os.environ.copy() +12 12 | os.environ["X"] = "1" diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1508_invalid_envvar_default.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1508_invalid_envvar_default.py.snap index 9490733158b2a..0ad2917d0ca3b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1508_invalid_envvar_default.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1508_invalid_envvar_default.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs invalid_envvar_default.py:3:29: PLW1508 Invalid type for environment variable default; expected `str` or `None` | 1 | import os -2 | +2 | 3 | tempVar = os.getenv("TEST", 12) # [invalid-envvar-default] | ^^ PLW1508 4 | goodVar = os.getenv("TESTING", None) @@ -47,6 +47,16 @@ invalid_envvar_default.py:14:17: PLW1508 Invalid type for environment variable d 13 | os.getenv("AA", "GOOD" if Z else "BAR") 14 | os.getenv("AA", 1 if Z else "BAR") # [invalid-envvar-default] | ^^^^^^^^^^^^^^^^^ PLW1508 +15 | os.environ.get("TEST", 12) # [invalid-envvar-default] +16 | os.environ.get("TEST", "AA" * 12) | - +invalid_envvar_default.py:15:24: PLW1508 Invalid type for environment variable default; expected `str` or `None` + | +13 | os.getenv("AA", "GOOD" if Z else "BAR") +14 | os.getenv("AA", 1 if Z else "BAR") # [invalid-envvar-default] +15 | os.environ.get("TEST", 12) # [invalid-envvar-default] + | ^^ PLW1508 +16 | os.environ.get("TEST", "AA" * 12) +17 | os.environ.get("TEST", 13 * "AA") + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1509_subprocess_popen_preexec_fn.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1509_subprocess_popen_preexec_fn.py.snap index fd540da0f60e6..9918c300e9cf0 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1509_subprocess_popen_preexec_fn.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1509_subprocess_popen_preexec_fn.py.snap @@ -35,8 +35,6 @@ subprocess_popen_preexec_fn.py:12:26: PLW1509 `preexec_fn` argument is unsafe wh 11 | subprocess.Popen(preexec_fn=lambda: print("Hello, world!")) 12 | subprocess.Popen(["ls"], preexec_fn=lambda: print("Hello, world!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW1509 -13 | +13 | 14 | # Non-errors. | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1510_subprocess_run_without_check.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1510_subprocess_run_without_check.py.snap index 7419c16569584..7e6539ec04c0b 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1510_subprocess_run_without_check.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1510_subprocess_run_without_check.py.snap @@ -69,7 +69,7 @@ subprocess_run_without_check.py:10:1: PLW1510 [*] `subprocess.run` without expli 9 | ) 10 | subprocess.run(["ls"], **kwargs) | ^^^^^^^^^^^^^^ PLW1510 -11 | +11 | 12 | # Non-errors. | = help: Add explicit `check=False` @@ -83,5 +83,3 @@ subprocess_run_without_check.py:10:1: PLW1510 [*] `subprocess.run` without expli 11 11 | 12 12 | # Non-errors. 13 13 | subprocess.run("ls", check=True) - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1514_unspecified_encoding.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1514_unspecified_encoding.py.snap index 9b6ebb6c85814..cc91be3fd94ae 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1514_unspecified_encoding.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1514_unspecified_encoding.py.snap @@ -131,7 +131,7 @@ unspecified_encoding.py:14:1: PLW1514 [*] `tempfile.SpooledTemporaryFile` in tex 13 | codecs.open("test.txt") 14 | tempfile.SpooledTemporaryFile(0, "w") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW1514 -15 | +15 | 16 | # Non-errors. | = help: Add explicit `encoding` argument @@ -149,7 +149,7 @@ unspecified_encoding.py:14:1: PLW1514 [*] `tempfile.SpooledTemporaryFile` in tex unspecified_encoding.py:46:1: PLW1514 [*] `open` in text mode without explicit `encoding` argument | 44 | tempfile.SpooledTemporaryFile(0, ) -45 | +45 | 46 | open("test.txt",) | ^^^^ PLW1514 47 | open() @@ -295,7 +295,7 @@ unspecified_encoding.py:59:1: PLW1514 [*] `open` in text mode without explicit ` unspecified_encoding.py:64:1: PLW1514 [*] `open` in text mode without explicit `encoding` argument | 62 | ) -63 | +63 | 64 | open((("test.txt")),) | ^^^^ PLW1514 65 | open( @@ -421,7 +421,7 @@ unspecified_encoding.py:80:1: PLW1514 [*] `pathlib.Path(...).write_text` without 79 | text = Path("foo.txt").read_text() 80 | Path("foo.txt").write_text(text) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW1514 -81 | +81 | 82 | # Non-errors. | = help: Add explicit `encoding` argument diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1641_eq_without_hash.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1641_eq_without_hash.py.snap index 416ed719027a4..572aabdcbaf8d 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1641_eq_without_hash.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1641_eq_without_hash.py.snap @@ -1,12 +1,132 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs --- -eq_without_hash.py:1:7: PLW1641 Object does not implement `__hash__` method +eq_without_hash.py:3:7: PLW1641 Object does not implement `__hash__` method | -1 | class Person: # [eq-without-hash] +1 | ### Errors +2 | +3 | class Person: | ^^^^^^ PLW1641 -2 | def __init__(self): -3 | self.name = "monty" +4 | def __init__(self): +5 | self.name = "monty" | +eq_without_hash.py:11:7: PLW1641 Object does not implement `__hash__` method + | +11 | class MaybeEqIf: + | ^^^^^^^^^ PLW1641 +12 | if ...: +13 | def __eq__(self, other): ... + | +eq_without_hash.py:16:7: PLW1641 Object does not implement `__hash__` method + | +16 | class MaybeEqElif: + | ^^^^^^^^^^^ PLW1641 +17 | if ...: +18 | ... + | + +eq_without_hash.py:23:7: PLW1641 Object does not implement `__hash__` method + | +23 | class MaybeEqElse: + | ^^^^^^^^^^^ PLW1641 +24 | if ...: +25 | ... + | + +eq_without_hash.py:30:7: PLW1641 Object does not implement `__hash__` method + | +30 | class MaybeEqWith: + | ^^^^^^^^^^^ PLW1641 +31 | with ...: +32 | def __eq__(self, other): ... + | + +eq_without_hash.py:35:7: PLW1641 Object does not implement `__hash__` method + | +35 | class MaybeEqFor: + | ^^^^^^^^^^ PLW1641 +36 | for _ in ...: +37 | def __eq__(self, other): ... + | + +eq_without_hash.py:40:7: PLW1641 Object does not implement `__hash__` method + | +40 | class MaybeEqForElse: + | ^^^^^^^^^^^^^^ PLW1641 +41 | for _ in ...: +42 | ... + | + +eq_without_hash.py:47:7: PLW1641 Object does not implement `__hash__` method + | +47 | class MaybeEqWhile: + | ^^^^^^^^^^^^ PLW1641 +48 | while ...: +49 | def __eq__(self, other): ... + | + +eq_without_hash.py:52:7: PLW1641 Object does not implement `__hash__` method + | +52 | class MaybeEqWhileElse: + | ^^^^^^^^^^^^^^^^ PLW1641 +53 | while ...: +54 | ... + | + +eq_without_hash.py:59:7: PLW1641 Object does not implement `__hash__` method + | +59 | class MaybeEqTry: + | ^^^^^^^^^^ PLW1641 +60 | try: +61 | def __eq__(self, other): ... + | + +eq_without_hash.py:66:7: PLW1641 Object does not implement `__hash__` method + | +66 | class MaybeEqTryExcept: + | ^^^^^^^^^^^^^^^^ PLW1641 +67 | try: +68 | ... + | + +eq_without_hash.py:73:7: PLW1641 Object does not implement `__hash__` method + | +73 | class MaybeEqTryExceptElse: + | ^^^^^^^^^^^^^^^^^^^^ PLW1641 +74 | try: +75 | ... + | + +eq_without_hash.py:82:7: PLW1641 Object does not implement `__hash__` method + | +82 | class MaybeEqTryFinally: + | ^^^^^^^^^^^^^^^^^ PLW1641 +83 | try: +84 | ... + | + +eq_without_hash.py:89:7: PLW1641 Object does not implement `__hash__` method + | +89 | class MaybeEqMatchCase: + | ^^^^^^^^^^^^^^^^ PLW1641 +90 | match ...: +91 | case int(): + | + +eq_without_hash.py:95:7: PLW1641 Object does not implement `__hash__` method + | +95 | class MaybeEqMatchCaseWildcard: + | ^^^^^^^^^^^^^^^^^^^^^^^^ PLW1641 +96 | match ...: +97 | case int(): ... + | + +eq_without_hash.py:102:7: PLW1641 Object does not implement `__hash__` method + | +102 | class MaybeEqDeeplyNested: + | ^^^^^^^^^^^^^^^^^^^ PLW1641 +103 | if ...: +104 | ... + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2101_useless_with_lock.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2101_useless_with_lock.py.snap index 0715c3e5d83d9..8f42ef34e9eb9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2101_useless_with_lock.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2101_useless_with_lock.py.snap @@ -11,7 +11,7 @@ useless_with_lock.py:5:6: PLW2101 Threading lock directly created in `with` stat useless_with_lock.py:8:6: PLW2101 Threading lock directly created in `with` statement has no effect | 6 | ... -7 | +7 | 8 | with Lock(): # [useless-with-lock] | ^^^^^^ PLW2101 9 | ... @@ -20,7 +20,7 @@ useless_with_lock.py:8:6: PLW2101 Threading lock directly created in `with` stat useless_with_lock.py:11:6: PLW2101 Threading lock directly created in `with` statement has no effect | 9 | ... -10 | +10 | 11 | with threading.Lock() as this_shouldnt_matter: # [useless-with-lock] | ^^^^^^^^^^^^^^^^ PLW2101 12 | ... @@ -29,7 +29,7 @@ useless_with_lock.py:11:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:14:6: PLW2101 Threading lock directly created in `with` statement has no effect | 12 | ... -13 | +13 | 14 | with threading.RLock(): # [useless-with-lock] | ^^^^^^^^^^^^^^^^^ PLW2101 15 | ... @@ -38,7 +38,7 @@ useless_with_lock.py:14:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:17:6: PLW2101 Threading lock directly created in `with` statement has no effect | 15 | ... -16 | +16 | 17 | with RLock(): # [useless-with-lock] | ^^^^^^^ PLW2101 18 | ... @@ -47,7 +47,7 @@ useless_with_lock.py:17:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:20:6: PLW2101 Threading lock directly created in `with` statement has no effect | 18 | ... -19 | +19 | 20 | with threading.Condition(): # [useless-with-lock] | ^^^^^^^^^^^^^^^^^^^^^ PLW2101 21 | ... @@ -56,7 +56,7 @@ useless_with_lock.py:20:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:23:6: PLW2101 Threading lock directly created in `with` statement has no effect | 21 | ... -22 | +22 | 23 | with Condition(): # [useless-with-lock] | ^^^^^^^^^^^ PLW2101 24 | ... @@ -65,7 +65,7 @@ useless_with_lock.py:23:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:26:6: PLW2101 Threading lock directly created in `with` statement has no effect | 24 | ... -25 | +25 | 26 | with threading.Semaphore(): # [useless-with-lock] | ^^^^^^^^^^^^^^^^^^^^^ PLW2101 27 | ... @@ -74,7 +74,7 @@ useless_with_lock.py:26:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:29:6: PLW2101 Threading lock directly created in `with` statement has no effect | 27 | ... -28 | +28 | 29 | with Semaphore(): # [useless-with-lock] | ^^^^^^^^^^^ PLW2101 30 | ... @@ -83,7 +83,7 @@ useless_with_lock.py:29:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:32:6: PLW2101 Threading lock directly created in `with` statement has no effect | 30 | ... -31 | +31 | 32 | with threading.BoundedSemaphore(): # [useless-with-lock] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW2101 33 | ... @@ -92,10 +92,8 @@ useless_with_lock.py:32:6: PLW2101 Threading lock directly created in `with` sta useless_with_lock.py:35:6: PLW2101 Threading lock directly created in `with` statement has no effect | 33 | ... -34 | +34 | 35 | with BoundedSemaphore(): # [useless-with-lock] | ^^^^^^^^^^^^^^^^^^ PLW2101 36 | ... | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2901_redefined_loop_name.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2901_redefined_loop_name.py.snap index ee9c609b64c86..8bb2aff29ee95 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2901_redefined_loop_name.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW2901_redefined_loop_name.py.snap @@ -89,7 +89,7 @@ redefined_loop_name.py:67:5: PLW2901 `for` loop variable `i` overwritten by assi 66 | i = typing.cast(int, i) 67 | i = 5 # error | ^ PLW2901 -68 | +68 | 69 | # For -> augmented assignment | @@ -99,7 +99,7 @@ redefined_loop_name.py:71:5: PLW2901 `for` loop variable `i` overwritten by assi 70 | for i in []: 71 | i += 5 # error | ^ PLW2901 -72 | +72 | 73 | # For -> annotated assignment | @@ -109,7 +109,7 @@ redefined_loop_name.py:75:5: PLW2901 `for` loop variable `i` overwritten by assi 74 | for i in []: 75 | i: int = 5 # error | ^ PLW2901 -76 | +76 | 77 | # For -> annotated assignment without value | @@ -182,7 +182,7 @@ redefined_loop_name.py:137:13: PLW2901 `for` loop variable `i` overwritten by as 136 | for i in []: # no error 137 | i = 2 # error | ^ PLW2901 -138 | +138 | 139 | # For -> class definition -> for -> for | @@ -248,5 +248,3 @@ redefined_loop_name.py:180:5: PLW2901 `for` loop variable `a.i` overwritten by a 180 | a.i = 2 # error | ^^^ PLW2901 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap index a98abee052372..407fa4b92dc55 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap @@ -12,7 +12,7 @@ bad_dunder_method_name.py:5:9: PLW3201 Dunder method `_init_` has no special mea bad_dunder_method_name.py:8:9: PLW3201 Dunder method `__hello__` has no special meaning in Python 3 | 6 | pass -7 | +7 | 8 | def __hello__(self): # [bad-dunder-name] | ^^^^^^^^^ PLW3201 9 | print("hello") @@ -21,7 +21,7 @@ bad_dunder_method_name.py:8:9: PLW3201 Dunder method `__hello__` has no special bad_dunder_method_name.py:11:9: PLW3201 Dunder method `__init_` has no special meaning in Python 3 | 9 | print("hello") -10 | +10 | 11 | def __init_(self): # [bad-dunder-name] | ^^^^^^^ PLW3201 12 | # author likely unintentionally misspelled the correct init dunder. @@ -31,7 +31,7 @@ bad_dunder_method_name.py:11:9: PLW3201 Dunder method `__init_` has no special m bad_dunder_method_name.py:15:9: PLW3201 Dunder method `_init_` has no special meaning in Python 3 | 13 | pass -14 | +14 | 15 | def _init_(self): # [bad-dunder-name] | ^^^^^^ PLW3201 16 | # author likely unintentionally misspelled the correct init dunder. @@ -41,7 +41,7 @@ bad_dunder_method_name.py:15:9: PLW3201 Dunder method `_init_` has no special me bad_dunder_method_name.py:19:9: PLW3201 Dunder method `___neg__` has no special meaning in Python 3 | 17 | pass -18 | +18 | 19 | def ___neg__(self): # [bad-dunder-name] | ^^^^^^^^ PLW3201 20 | # author likely accidentally added an additional `_` @@ -51,7 +51,7 @@ bad_dunder_method_name.py:19:9: PLW3201 Dunder method `___neg__` has no special bad_dunder_method_name.py:23:9: PLW3201 Dunder method `__inv__` has no special meaning in Python 3 | 21 | pass -22 | +22 | 23 | def __inv__(self): # [bad-dunder-name] | ^^^^^^^ PLW3201 24 | # author likely meant to call the invert dunder method diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3301_nested_min_max.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3301_nested_min_max.py.snap index ab395e0472909..af86b45d1d4c9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3301_nested_min_max.py.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3301_nested_min_max.py.snap @@ -147,7 +147,7 @@ nested_min_max.py:9:1: PLW3301 [*] Nested `max` calls can be flattened 8 | max(1, max(2, max(3, 4))) 9 | max(1, foo("a", "b"), max(3, 4)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW3301 -10 | +10 | 11 | # These should not trigger; we do not flag cases with keyword args. | = help: Flatten nested `max` calls @@ -168,7 +168,7 @@ nested_min_max.py:15:1: PLW3301 [*] Nested `min` calls can be flattened 14 | # This will still trigger, to merge the calls without keyword args. 15 | min(1, min(2, 3, key=test), min(4, 5)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW3301 -16 | +16 | 17 | # Don't provide a fix if there are comments within the call. | = help: Flatten nested `min` calls @@ -191,7 +191,7 @@ nested_min_max.py:18:1: PLW3301 Nested `min` calls can be flattened 20 | | min(2, 3), 21 | | ) | |_^ PLW3301 -22 | +22 | 23 | # Handle iterable expressions. | = help: Flatten nested `min` calls @@ -263,7 +263,7 @@ nested_min_max.py:27:1: PLW3301 [*] Nested `max` calls can be flattened 26 | max(1, max(a)) 27 | max(1, max(i for i in range(10))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLW3301 -28 | +28 | 29 | tuples_list = [ | = help: Flatten nested `max` calls @@ -283,7 +283,7 @@ nested_min_max.py:41:1: PLW3301 [*] Nested `max` calls can be flattened 40 | # Starred argument should be copied as it is. 41 | max(1, max(*a)) | ^^^^^^^^^^^^^^^ PLW3301 -42 | +42 | 43 | import builtins | = help: Flatten nested `max` calls @@ -325,7 +325,7 @@ nested_min_max.py:48:16: PLW3301 [*] Nested `max` calls can be flattened 50 | | len("Done!"), 51 | | ) | |_^ PLW3301 -52 | +52 | 53 | # OK | = help: Flatten nested `max` calls diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__allow_magic_value_types.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__allow_magic_value_types.snap index 31a4c8eda0b9b..6d6a223c1121c 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__allow_magic_value_types.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__allow_magic_value_types.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pylint/mod.rs magic_value_comparison.py:56:12: PLR2004 Magic value used in comparison, consider replacing `-2.0` with a constant variable | 54 | pass -55 | +55 | 56 | if argc != -2.0: # [magic-value-comparison] | ^^^^ PLR2004 57 | pass @@ -13,7 +13,7 @@ magic_value_comparison.py:56:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:59:12: PLR2004 Magic value used in comparison, consider replacing `+2.0` with a constant variable | 57 | pass -58 | +58 | 59 | if argc != +2.0: # [magic-value-comparison] | ^^^^ PLR2004 60 | pass @@ -22,7 +22,7 @@ magic_value_comparison.py:59:12: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:74:22: PLR2004 Magic value used in comparison, consider replacing `"Hunter2"` with a constant variable | 72 | pass -73 | +73 | 74 | if input_password == "Hunter2": # correct | ^^^^^^^^^ PLR2004 75 | pass @@ -31,7 +31,7 @@ magic_value_comparison.py:74:22: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:80:21: PLR2004 Magic value used in comparison, consider replacing `3.141592653589793238` with a constant variable | 78 | pi_estimation = 3.14 -79 | +79 | 80 | if pi_estimation == 3.141592653589793238: # [magic-value-comparison] | ^^^^^^^^^^^^^^^^^^^^ PLR2004 81 | pass @@ -40,10 +40,8 @@ magic_value_comparison.py:80:21: PLR2004 Magic value used in comparison, conside magic_value_comparison.py:92:18: PLR2004 Magic value used in comparison, consider replacing `b"something"` with a constant variable | 90 | user_input = b"Hello, There!" -91 | +91 | 92 | if user_input == b"something": # correct | ^^^^^^^^^^^^ PLR2004 93 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__continue_in_finally.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__continue_in_finally.snap index 8b0ac4063f2d2..2391a6f9d4bf9 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__continue_in_finally.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__continue_in_finally.snap @@ -7,7 +7,7 @@ continue_in_finally.py:5:9: PLE0116 `continue` not supported inside `finally` cl 4 | finally: 5 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -6 | +6 | 7 | while True: | @@ -26,7 +26,7 @@ continue_in_finally.py:26:17: PLE0116 `continue` not supported inside `finally` 25 | case "aa": 26 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -27 | +27 | 28 | while True: | @@ -36,7 +36,7 @@ continue_in_finally.py:33:13: PLE0116 `continue` not supported inside `finally` 32 | with "aa" as f: 33 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -34 | +34 | 35 | while True: | @@ -55,7 +55,7 @@ continue_in_finally.py:41:9: PLE0116 `continue` not supported inside `finally` c 40 | continue # [continue-in-finally] 41 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -42 | +42 | 43 | def test(): | @@ -73,7 +73,7 @@ continue_in_finally.py:56:9: PLE0116 `continue` not supported inside `finally` c 55 | finally: 56 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -57 | +57 | 58 | def test(): | @@ -83,7 +83,7 @@ continue_in_finally.py:69:9: PLE0116 `continue` not supported inside `finally` c 68 | continue 69 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -70 | +70 | 71 | while True: | @@ -93,7 +93,7 @@ continue_in_finally.py:74:13: PLE0116 `continue` not supported inside `finally` 73 | else: 74 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 -75 | +75 | 76 | def test(): | @@ -124,5 +124,3 @@ continue_in_finally.py:95:17: PLE0116 `continue` not supported inside `finally` 95 | continue # [continue-in-finally] | ^^^^^^^^ PLE0116 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__import_outside_top_level_with_banned.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__import_outside_top_level_with_banned.snap new file mode 100644 index 0000000000000..ede65043dd988 --- /dev/null +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__import_outside_top_level_with_banned.snap @@ -0,0 +1,94 @@ +--- +source: crates/ruff_linter/src/rules/pylint/mod.rs +--- +import_outside_top_level_with_banned.py:9:5: PLC0415 `import` should be at the top-level of a file + | + 8 | def import_in_function(): + 9 | import symtable # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^ PLC0415 +10 | import os, sys # [import-outside-toplevel] +11 | import time as thyme # [import-outside-toplevel] + | + +import_outside_top_level_with_banned.py:10:5: PLC0415 `import` should be at the top-level of a file + | + 8 | def import_in_function(): + 9 | import symtable # [import-outside-toplevel] +10 | import os, sys # [import-outside-toplevel] + | ^^^^^^^^^^^^^^ PLC0415 +11 | import time as thyme # [import-outside-toplevel] +12 | import random as rand, socket as sock # [import-outside-toplevel] + | + +import_outside_top_level_with_banned.py:11:5: PLC0415 `import` should be at the top-level of a file + | + 9 | import symtable # [import-outside-toplevel] +10 | import os, sys # [import-outside-toplevel] +11 | import time as thyme # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^ PLC0415 +12 | import random as rand, socket as sock # [import-outside-toplevel] +13 | from collections import defaultdict # [import-outside-toplevel] + | + +import_outside_top_level_with_banned.py:12:5: PLC0415 `import` should be at the top-level of a file + | +10 | import os, sys # [import-outside-toplevel] +11 | import time as thyme # [import-outside-toplevel] +12 | import random as rand, socket as sock # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0415 +13 | from collections import defaultdict # [import-outside-toplevel] +14 | from math import sin as sign, cos as cosplay # [import-outside-toplevel] + | + +import_outside_top_level_with_banned.py:13:5: PLC0415 `import` should be at the top-level of a file + | +11 | import time as thyme # [import-outside-toplevel] +12 | import random as rand, socket as sock # [import-outside-toplevel] +13 | from collections import defaultdict # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0415 +14 | from math import sin as sign, cos as cosplay # [import-outside-toplevel] + | + +import_outside_top_level_with_banned.py:14:5: PLC0415 `import` should be at the top-level of a file + | +12 | import random as rand, socket as sock # [import-outside-toplevel] +13 | from collections import defaultdict # [import-outside-toplevel] +14 | from math import sin as sign, cos as cosplay # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0415 +15 | +16 | # these should be allowed due to TID253 top-level ban + | + +import_outside_top_level_with_banned.py:24:5: PLC0415 `import` should be at the top-level of a file + | +23 | # this should still trigger an error due to multiple imports +24 | from pkg import foo_allowed, bar_banned # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0415 +25 | +26 | class ClassWithImports: + | + +import_outside_top_level_with_banned.py:27:5: PLC0415 `import` should be at the top-level of a file + | +26 | class ClassWithImports: +27 | import tokenize # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^ PLC0415 +28 | +29 | def __init__(self): + | + +import_outside_top_level_with_banned.py:30:9: PLC0415 `import` should be at the top-level of a file + | +29 | def __init__(self): +30 | import trace # [import-outside-toplevel] + | ^^^^^^^^^^^^ PLC0415 +31 | +32 | # these should be allowed due to TID253 top-level ban + | + +import_outside_top_level_with_banned.py:40:9: PLC0415 `import` should be at the top-level of a file + | +39 | # this should still trigger an error due to multiple imports +40 | from pkg import foo_allowed, bar_banned # [import-outside-toplevel] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLC0415 + | diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args.snap index 440f2dafeb402..bdc4b307ea6b5 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_arguments_params.py:3:5: PLR0913 Too many arguments in function definition (6 > 4) | @@ -18,5 +19,3 @@ too_many_arguments_params.py:9:5: PLR0913 Too many arguments in function definit | ^ PLR0913 10 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args_with_dummy_variables.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args_with_dummy_variables.snap index 865d4d0abd262..6f978e80245a4 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args_with_dummy_variables.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_args_with_dummy_variables.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_arguments_params.py:9:5: PLR0913 Too many arguments in function definition (6 > 5) | @@ -9,5 +10,3 @@ too_many_arguments_params.py:9:5: PLR0913 Too many arguments in function definit | ^ PLR0913 10 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_boolean_expressions.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_boolean_expressions.snap index 141ee9e4c5c2b..3bab1afdea29a 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_boolean_expressions.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_boolean_expressions.snap @@ -168,7 +168,7 @@ too_many_boolean_expressions.py:43:6: PLR0916 Too many Boolean expressions (22 > 43 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR0916 44 | ... -45 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w: +45 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and … | too_many_boolean_expressions.py:45:6: PLR0916 Too many Boolean expressions (23 > 5) @@ -178,7 +178,7 @@ too_many_boolean_expressions.py:45:6: PLR0916 Too many Boolean expressions (23 > 45 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR0916 46 | ... -47 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x: +47 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and … | too_many_boolean_expressions.py:47:6: PLR0916 Too many Boolean expressions (24 > 5) @@ -188,7 +188,7 @@ too_many_boolean_expressions.py:47:6: PLR0916 Too many Boolean expressions (24 > 47 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR0916 48 | ... -49 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x and y: +49 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x and … | too_many_boolean_expressions.py:49:6: PLR0916 Too many Boolean expressions (25 > 5) @@ -198,7 +198,7 @@ too_many_boolean_expressions.py:49:6: PLR0916 Too many Boolean expressions (25 > 49 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x and y: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PLR0916 50 | ... -51 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x and y and z: +51 | elif (a and b) and c and d and e and f and g and h and i and j and k and l and m and n and o and p and q and r and s and t and u and v and w and x and y and … | too_many_boolean_expressions.py:51:6: PLR0916 Too many Boolean expressions (26 > 5) @@ -210,5 +210,3 @@ too_many_boolean_expressions.py:51:6: PLR0916 Too many Boolean expressions (26 > 52 | ... 53 | else: | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_branches.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_branches.snap index e35b9cad8ea54..bcfd72f36acff 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_branches.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_branches.snap @@ -12,11 +12,9 @@ too_many_branches_params.py:6:5: PLR0912 Too many branches (2 > 1) too_many_branches_params.py:15:9: PLR0912 Too many branches (2 > 1) | 13 | return -14 | +14 | 15 | def i(x): | ^ PLR0912 16 | if x: 17 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_positional_args.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_positional_args.snap index ae8e6bf796914..fd65b9bb84964 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_positional_args.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_positional_args.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_positional_params.py:3:5: PLR0917 Too many positional arguments (7/4) | @@ -18,5 +19,3 @@ too_many_positional_params.py:9:5: PLR0917 Too many positional arguments (7/4) | ^ PLR0917 10 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_return_statements.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_return_statements.snap index 974b8b80016d8..36c4a29056125 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_return_statements.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_return_statements.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_return_statements_params.py:1:5: PLR0911 Too many return statements (2 > 1) | @@ -8,5 +9,3 @@ too_many_return_statements_params.py:1:5: PLR0911 Too many return statements (2 2 | if x == 1: 3 | return | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_statements.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_statements.snap index 017e2b2b8b539..9b524750b69bb 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_statements.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__max_statements.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_statements_params.py:6:5: PLR0915 Too many statements (2 > 1) | @@ -8,5 +9,3 @@ too_many_statements_params.py:6:5: PLR0915 Too many statements (2 > 1) 7 | def g(x): 8 | pass | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_locals.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_locals.snap index 99a0f2a9602b6..65eacdcd81959 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_locals.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_locals.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs +snapshot_kind: text --- too_many_locals.py:20:5: PLR0914 Too many local variables (16/15) | @@ -8,5 +9,3 @@ too_many_locals.py:20:5: PLR0914 Too many local variables (16/15) 21 | first = 1 22 | second = 2 | - - diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_public_methods.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_public_methods.snap index f86c673e9b3fc..6eff6362b5e89 100644 --- a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_public_methods.snap +++ b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__too_many_public_methods.snap @@ -1,46 +1,42 @@ --- source: crates/ruff_linter/src/rules/pylint/mod.rs --- -too_many_public_methods.py:1:1: PLR0904 Too many public methods (10 > 7) +too_many_public_methods.py:4:1: PLR0904 Too many public methods (10 > 7) | - 1 | / class Everything: - 2 | | foo = 1 - 3 | | - 4 | | def __init__(self): - 5 | | pass - 6 | | - 7 | | def _private(self): + 4 | / class Everything: + 5 | | foo = 1 + 6 | | + 7 | | def __init__(self): 8 | | pass - 9 | | -10 | | def method1(self): + 9 | | +10 | | def _private(self): 11 | | pass -12 | | -13 | | def method2(self): +12 | | +13 | | def method1(self): 14 | | pass -15 | | -16 | | def method3(self): +15 | | +16 | | def method2(self): 17 | | pass -18 | | -19 | | def method4(self): +18 | | +19 | | def method3(self): 20 | | pass -21 | | -22 | | def method5(self): +21 | | +22 | | def method4(self): 23 | | pass -24 | | -25 | | def method6(self): +24 | | +25 | | def method5(self): 26 | | pass -27 | | -28 | | def method7(self): +27 | | +28 | | def method6(self): 29 | | pass -30 | | -31 | | def method8(self): +30 | | +31 | | def method7(self): 32 | | pass -33 | | -34 | | def method9(self): +33 | | +34 | | def method8(self): 35 | | pass +36 | | +37 | | def method9(self): +38 | | pass | |____________^ PLR0904 -36 | -37 | class Small: | - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/mod.rs b/crates/ruff_linter/src/rules/pyupgrade/mod.rs index bb13c8ecbe33d..dfaf0ece7a312 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/mod.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/mod.rs @@ -10,11 +10,12 @@ mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::PythonVersion; use test_case::test_case; use crate::registry::Rule; use crate::rules::pyupgrade; - use crate::settings::types::{PreviewMode, PythonVersion}; + use crate::settings::types::PreviewMode; use crate::test::test_path; use crate::{assert_messages, settings}; @@ -35,11 +36,14 @@ mod tests { #[test_case(Rule::LRUCacheWithMaxsizeNone, Path::new("UP033_1.py"))] #[test_case(Rule::LRUCacheWithoutParameters, Path::new("UP011.py"))] #[test_case(Rule::NativeLiterals, Path::new("UP018.py"))] + #[test_case(Rule::NativeLiterals, Path::new("UP018_CR.py"))] + #[test_case(Rule::NativeLiterals, Path::new("UP018_LF.py"))] #[test_case(Rule::NonPEP585Annotation, Path::new("UP006_0.py"))] #[test_case(Rule::NonPEP585Annotation, Path::new("UP006_1.py"))] #[test_case(Rule::NonPEP585Annotation, Path::new("UP006_2.py"))] #[test_case(Rule::NonPEP585Annotation, Path::new("UP006_3.py"))] - #[test_case(Rule::NonPEP604Annotation, Path::new("UP007.py"))] + #[test_case(Rule::NonPEP604AnnotationUnion, Path::new("UP007.py"))] + #[test_case(Rule::NonPEP604AnnotationUnion, Path::new("UP045.py"))] #[test_case(Rule::NonPEP604Isinstance, Path::new("UP038.py"))] #[test_case(Rule::OSErrorAlias, Path::new("UP024_0.py"))] #[test_case(Rule::OSErrorAlias, Path::new("UP024_1.py"))] @@ -57,6 +61,7 @@ mod tests { #[test_case(Rule::PrintfStringFormatting, Path::new("UP031_1.py"))] #[test_case(Rule::QuotedAnnotation, Path::new("UP037_0.py"))] #[test_case(Rule::QuotedAnnotation, Path::new("UP037_1.py"))] + #[test_case(Rule::QuotedAnnotation, Path::new("UP037_2.pyi"))] #[test_case(Rule::RedundantOpenModes, Path::new("UP015.py"))] #[test_case(Rule::RedundantOpenModes, Path::new("UP015_1.py"))] #[test_case(Rule::ReplaceStdoutStderr, Path::new("UP022.py"))] @@ -77,19 +82,35 @@ mod tests { #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_8.py"))] #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_9.py"))] #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_10.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_other_other.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_other_utf8.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_utf8_other.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_utf8_utf8.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_utf8_utf8_other.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_utf8_code_other.py"))] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_code_utf8_utf8.py"))] + #[test_case( + Rule::UTF8EncodingDeclaration, + Path::new("UP009_hashbang_utf8_other.py") + )] + #[test_case(Rule::UTF8EncodingDeclaration, Path::new("UP009_many_empty_lines.py"))] #[test_case(Rule::UnicodeKindPrefix, Path::new("UP025.py"))] #[test_case(Rule::UnnecessaryBuiltinImport, Path::new("UP029.py"))] #[test_case(Rule::UnnecessaryClassParentheses, Path::new("UP039.py"))] #[test_case(Rule::UnnecessaryDefaultTypeArgs, Path::new("UP043.py"))] #[test_case(Rule::UnnecessaryEncodeUTF8, Path::new("UP012.py"))] #[test_case(Rule::UnnecessaryFutureImport, Path::new("UP010.py"))] - #[test_case(Rule::UnpackedListComprehension, Path::new("UP027.py"))] #[test_case(Rule::UselessMetaclassType, Path::new("UP001.py"))] #[test_case(Rule::UselessObjectInheritance, Path::new("UP004.py"))] #[test_case(Rule::YieldInForLoop, Path::new("UP028_0.py"))] #[test_case(Rule::YieldInForLoop, Path::new("UP028_1.py"))] #[test_case(Rule::NonPEP695TypeAlias, Path::new("UP040.py"))] #[test_case(Rule::NonPEP695TypeAlias, Path::new("UP040.pyi"))] + #[test_case(Rule::NonPEP695GenericClass, Path::new("UP046_0.py"))] + #[test_case(Rule::NonPEP695GenericClass, Path::new("UP046_1.py"))] + #[test_case(Rule::NonPEP695GenericFunction, Path::new("UP047.py"))] + #[test_case(Rule::PrivateTypeParameter, Path::new("UP049_0.py"))] + #[test_case(Rule::PrivateTypeParameter, Path::new("UP049_1.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = path.to_string_lossy().to_string(); let diagnostics = test_path( @@ -100,13 +121,13 @@ mod tests { Ok(()) } - #[test_case(Rule::PrintfStringFormatting, Path::new("UP031_0.py"))] - fn preview(rule_code: Rule, path: &Path) -> Result<()> { + #[test] + fn up007_preview() -> Result<()> { let diagnostics = test_path( - Path::new("pyupgrade").join(path), + Path::new("pyupgrade/UP045.py"), &settings::LinterSettings { preview: PreviewMode::Enabled, - ..settings::LinterSettings::for_rule(rule_code) + ..settings::LinterSettings::for_rule(Rule::NonPEP604AnnotationUnion) }, )?; assert_messages!(diagnostics); @@ -118,7 +139,7 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/UP041.py"), &settings::LinterSettings { - target_version: PythonVersion::Py310, + unresolved_target_version: PythonVersion::PY310.into(), ..settings::LinterSettings::for_rule(Rule::TimeoutErrorAlias) }, )?; @@ -131,7 +152,7 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/UP040.py"), &settings::LinterSettings { - target_version: PythonVersion::Py311, + unresolved_target_version: PythonVersion::PY311.into(), ..settings::LinterSettings::for_rule(Rule::NonPEP695TypeAlias) }, )?; @@ -147,7 +168,7 @@ mod tests { pyupgrade: pyupgrade::settings::Settings { keep_runtime_typing: true, }, - target_version: PythonVersion::Py37, + unresolved_target_version: PythonVersion::PY37.into(), ..settings::LinterSettings::for_rule(Rule::NonPEP585Annotation) }, )?; @@ -163,7 +184,7 @@ mod tests { pyupgrade: pyupgrade::settings::Settings { keep_runtime_typing: true, }, - target_version: PythonVersion::Py310, + unresolved_target_version: PythonVersion::PY310.into(), ..settings::LinterSettings::for_rule(Rule::NonPEP585Annotation) }, )?; @@ -176,7 +197,7 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/future_annotations.py"), &settings::LinterSettings { - target_version: PythonVersion::Py37, + unresolved_target_version: PythonVersion::PY37.into(), ..settings::LinterSettings::for_rule(Rule::NonPEP585Annotation) }, )?; @@ -189,7 +210,7 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/future_annotations.py"), &settings::LinterSettings { - target_version: PythonVersion::Py310, + unresolved_target_version: PythonVersion::PY310.into(), ..settings::LinterSettings::for_rule(Rule::NonPEP585Annotation) }, )?; @@ -202,8 +223,11 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/future_annotations.py"), &settings::LinterSettings { - target_version: PythonVersion::Py37, - ..settings::LinterSettings::for_rule(Rule::NonPEP604Annotation) + unresolved_target_version: PythonVersion::PY37.into(), + ..settings::LinterSettings::for_rules([ + Rule::NonPEP604AnnotationUnion, + Rule::NonPEP604AnnotationOptional, + ]) }, )?; assert_messages!(diagnostics); @@ -215,8 +239,11 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/future_annotations.py"), &settings::LinterSettings { - target_version: PythonVersion::Py310, - ..settings::LinterSettings::for_rule(Rule::NonPEP604Annotation) + unresolved_target_version: PythonVersion::PY310.into(), + ..settings::LinterSettings::for_rules([ + Rule::NonPEP604AnnotationUnion, + Rule::NonPEP604AnnotationOptional, + ]) }, )?; assert_messages!(diagnostics); @@ -228,11 +255,24 @@ mod tests { let diagnostics = test_path( Path::new("pyupgrade/UP017.py"), &settings::LinterSettings { - target_version: PythonVersion::Py311, + unresolved_target_version: PythonVersion::PY311.into(), ..settings::LinterSettings::for_rule(Rule::DatetimeTimezoneUTC) }, )?; assert_messages!(diagnostics); Ok(()) } + + #[test] + fn unpack_pep_646_py311() -> Result<()> { + let diagnostics = test_path( + Path::new("pyupgrade/UP044.py"), + &settings::LinterSettings { + unresolved_target_version: PythonVersion::PY311.into(), + ..settings::LinterSettings::for_rule(Rule::NonPEP646Unpack) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/convert_named_tuple_functional_to_class.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/convert_named_tuple_functional_to_class.rs index 9044bda474bd6..806caa561f57e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/convert_named_tuple_functional_to_class.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/convert_named_tuple_functional_to_class.rs @@ -1,13 +1,14 @@ use log::debug; -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_dunder; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, Identifier, Keyword, Stmt}; use ruff_python_codegen::Generator; use ruff_python_semantic::SemanticModel; use ruff_python_stdlib::identifiers::is_identifier; +use ruff_python_trivia::CommentRanges; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; @@ -41,10 +42,15 @@ use crate::checkers::ast::Checker; /// b: str /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as unsafe if there are any comments within the +/// range of the `NamedTuple` definition, as these will be dropped by the +/// autofix. +/// /// ## References /// - [Python documentation: `typing.NamedTuple`](https://docs.python.org/3/library/typing.html#typing.NamedTuple) -#[violation] -pub struct ConvertNamedTupleFunctionalToClass { +#[derive(ViolationMetadata)] +pub(crate) struct ConvertNamedTupleFunctionalToClass { name: String, } @@ -66,7 +72,7 @@ impl Violation for ConvertNamedTupleFunctionalToClass { /// UP014 pub(crate) fn convert_named_tuple_functional_to_class( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, targets: &[Expr], value: &Expr, @@ -121,9 +127,10 @@ pub(crate) fn convert_named_tuple_functional_to_class( fields, base_class, checker.generator(), + checker.comment_ranges(), )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Return the typename, args, keywords, and base class. @@ -241,9 +248,17 @@ fn convert_to_class( body: Vec<Stmt>, base_class: &Expr, generator: Generator, + comment_ranges: &CommentRanges, ) -> Fix { - Fix::safe_edit(Edit::range_replacement( - generator.stmt(&create_class_def_stmt(typename, body, base_class)), - stmt.range(), - )) + Fix::applicable_edit( + Edit::range_replacement( + generator.stmt(&create_class_def_stmt(typename, body, base_class)), + stmt.range(), + ), + if comment_ranges.intersects(stmt.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + ) } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/convert_typed_dict_functional_to_class.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/convert_typed_dict_functional_to_class.rs index c00e8757996f0..5341d4d67ccd3 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/convert_typed_dict_functional_to_class.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/convert_typed_dict_functional_to_class.rs @@ -1,10 +1,10 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers::is_dunder; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr, ExprContext, Identifier, Keyword, Stmt}; use ruff_python_codegen::Generator; use ruff_python_semantic::SemanticModel; use ruff_python_stdlib::identifiers::is_identifier; +use ruff_python_trivia::CommentRanges; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; @@ -14,12 +14,22 @@ use crate::checkers::ast::Checker; /// Checks for `TypedDict` declarations that use functional syntax. /// /// ## Why is this bad? -/// `TypedDict` subclasses can be defined either through a functional syntax +/// `TypedDict` types can be defined either through a functional syntax /// (`Foo = TypedDict(...)`) or a class syntax (`class Foo(TypedDict): ...`). /// /// The class syntax is more readable and generally preferred over the /// functional syntax. /// +/// Nonetheless, there are some situations in which it is impossible to use +/// the class-based syntax. This rule will not apply to those cases. Namely, +/// it is impossible to use the class-based syntax if any `TypedDict` fields are: +/// - Not valid [python identifiers] (for example, `@x`) +/// - [Python keywords] such as `in` +/// - [Private names] such as `__id` that would undergo [name mangling] at runtime +/// if the class-based syntax was used +/// - [Dunder names] such as `__int__` that can confuse type checkers if they're used +/// with the class-based syntax. +/// /// ## Example /// ```python /// from typing import TypedDict @@ -37,10 +47,21 @@ use crate::checkers::ast::Checker; /// b: str /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as unsafe if there are any comments within the +/// range of the `TypedDict` definition, as these will be dropped by the +/// autofix. +/// /// ## References /// - [Python documentation: `typing.TypedDict`](https://docs.python.org/3/library/typing.html#typing.TypedDict) -#[violation] -pub struct ConvertTypedDictFunctionalToClass { +/// +/// [Private names]: https://docs.python.org/3/tutorial/classes.html#private-variables +/// [name mangling]: https://docs.python.org/3/reference/expressions.html#private-name-mangling +/// [python identifiers]: https://docs.python.org/3/reference/lexical_analysis.html#identifiers +/// [Python keywords]: https://docs.python.org/3/reference/lexical_analysis.html#keywords +/// [Dunder names]: https://docs.python.org/3/reference/lexical_analysis.html#reserved-classes-of-identifiers +#[derive(ViolationMetadata)] +pub(crate) struct ConvertTypedDictFunctionalToClass { name: String, } @@ -61,7 +82,7 @@ impl Violation for ConvertTypedDictFunctionalToClass { /// UP013 pub(crate) fn convert_typed_dict_functional_to_class( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, targets: &[Expr], value: &Expr, @@ -91,9 +112,10 @@ pub(crate) fn convert_typed_dict_functional_to_class( total_keyword, base_class, checker.generator(), + checker.comment_ranges(), )); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Return the class name, arguments, keywords and base class for a `TypedDict` @@ -178,7 +200,10 @@ fn fields_from_dict_literal(items: &[ast::DictItem]) -> Option<Vec<Stmt>> { if !is_identifier(field.to_str()) { return None; } - if is_dunder(field.to_str()) { + // Converting TypedDict to class-based syntax is not safe if fields contain + // private or dunder names, because private names will be mangled and dunder + // names can confuse type checkers. + if field.to_str().starts_with("__") { return None; } Some(create_field_assignment_stmt(field.to_str(), value)) @@ -265,14 +290,22 @@ fn convert_to_class( total_keyword: Option<&Keyword>, base_class: &Expr, generator: Generator, + comment_ranges: &CommentRanges, ) -> Fix { - Fix::safe_edit(Edit::range_replacement( - generator.stmt(&create_class_def_stmt( - class_name, - body, - total_keyword, - base_class, - )), - stmt.range(), - )) + Fix::applicable_edit( + Edit::range_replacement( + generator.stmt(&create_class_def_stmt( + class_name, + body, + total_keyword, + base_class, + )), + stmt.range(), + ), + if comment_ranges.intersects(stmt.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + ) } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/datetime_utc_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/datetime_utc_alias.rs index 8af75bc012f1a..18706eb0fe5e0 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/datetime_utc_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/datetime_utc_alias.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -33,15 +33,15 @@ use crate::importer::ImportRequest; /// /// ## References /// - [Python documentation: `datetime.UTC`](https://docs.python.org/3/library/datetime.html#datetime.UTC) -#[violation] -pub struct DatetimeTimezoneUTC; +#[derive(ViolationMetadata)] +pub(crate) struct DatetimeTimezoneUTC; impl Violation for DatetimeTimezoneUTC { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `datetime.UTC` alias") + "Use `datetime.UTC` alias".to_string() } fn fix_title(&self) -> Option<String> { @@ -50,7 +50,7 @@ impl Violation for DatetimeTimezoneUTC { } /// UP017 -pub(crate) fn datetime_utc_alias(checker: &mut Checker, expr: &Expr) { +pub(crate) fn datetime_utc_alias(checker: &Checker, expr: &Expr) { if checker .semantic() .resolve_qualified_name(expr) @@ -68,6 +68,6 @@ pub(crate) fn datetime_utc_alias(checker: &mut Checker, expr: &Expr) { let reference_edit = Edit::range_replacement(binding, expr.range()); Ok(Fix::safe_edits(import_edit, [reference_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_c_element_tree.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_c_element_tree.rs index a5dd1825c7ff7..8d20eb816b14d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_c_element_tree.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_c_element_tree.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::Ranged; @@ -24,13 +24,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `xml.etree.ElementTree`](https://docs.python.org/3/library/xml.etree.elementtree.html) -#[violation] -pub struct DeprecatedCElementTree; +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedCElementTree; impl AlwaysFixableViolation for DeprecatedCElementTree { #[derive_message_formats] fn message(&self) -> String { - format!("`cElementTree` is deprecated, use `ElementTree`") + "`cElementTree` is deprecated, use `ElementTree`".to_string() } fn fix_title(&self) -> String { @@ -38,7 +38,7 @@ impl AlwaysFixableViolation for DeprecatedCElementTree { } } -fn add_check_for_node<T>(checker: &mut Checker, node: &T) +fn add_check_for_node<T>(checker: &Checker, node: &T) where T: Ranged, { @@ -48,11 +48,11 @@ where contents.replacen("cElementTree", "ElementTree", 1), node.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// UP023 -pub(crate) fn deprecated_c_element_tree(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn deprecated_c_element_tree(checker: &Checker, stmt: &Stmt) { match stmt { Stmt::Import(ast::StmtImport { names, range: _ }) => { // Ex) `import xml.etree.cElementTree as ET` diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_import.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_import.rs index afea8339ca5c9..4f3f0075299f1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_import.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_import.rs @@ -1,17 +1,17 @@ use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::whitespace::indentation; use ruff_python_ast::{Alias, StmtImportFrom}; use ruff_python_codegen::Stylist; use ruff_python_parser::Tokens; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::pyupgrade::fixes; -use crate::settings::types::PythonVersion; -use crate::Locator; +use ruff_python_ast::PythonVersion; /// An import was moved and renamed as part of a deprecation. /// For example, `typing.AbstractSet` was moved to `collections.abc.Set`. @@ -60,8 +60,8 @@ enum Deprecation { /// ```python /// from collections.abc import Sequence /// ``` -#[violation] -pub struct DeprecatedImport { +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedImport { deprecation: Deprecation, } @@ -308,7 +308,9 @@ const TYPING_EXTENSIONS_TO_TYPING_310: &[&str] = &[ "TypeGuard", "get_args", "get_origin", - "is_typeddict", + // Introduced in Python 3.10, but `typing_extensions` equivalent + // also checks for `typing_extensions.TypedDict` in addition to `typing.TypedDict`. + // "is_typeddict", ]; // Python 3.11+ @@ -382,13 +384,14 @@ const TYPING_EXTENSIONS_TO_TYPING_313: &[&str] = &[ // Introduced in Python 3.8, but typing_extensions // backports features and bugfixes from py313: "Protocol", - "TypedDict", "runtime_checkable", // Introduced in earlier Python versions, // but typing_extensions backports PEP-696: "ParamSpec", "TypeVar", "TypeVarTuple", + // `typing_extensions` backports PEP 728 (TypedDict with Typed Extra Items) + // "TypedDict", ]; // Members of `typing_extensions` that were moved to `types`. @@ -429,7 +432,7 @@ impl<'a> ImportReplacer<'a> { fn with_renames(&self) -> Vec<WithRename> { let mut operations = vec![]; if self.module == "typing" { - if self.version >= PythonVersion::Py39 { + if self.version >= PythonVersion::PY39 { for member in &self.import_from_stmt.names { if let Some(target) = TYPING_TO_RENAME_PY39.iter().find_map(|(name, target)| { if &member.name == *name { @@ -467,7 +470,7 @@ impl<'a> ImportReplacer<'a> { "typing_extensions" => { // `typing_extensions` to `collections.abc` let mut typing_extensions_to_collections_abc = vec![]; - if self.version >= PythonVersion::Py312 { + if self.version >= PythonVersion::PY312 { typing_extensions_to_collections_abc .extend(TYPING_EXTENSIONS_TO_COLLECTIONS_ABC_312); } @@ -479,7 +482,7 @@ impl<'a> ImportReplacer<'a> { // `typing_extensions` to `warnings` let mut typing_extensions_to_warnings = vec![]; - if self.version >= PythonVersion::Py313 { + if self.version >= PythonVersion::PY313 { typing_extensions_to_warnings.extend(TYPING_EXTENSIONS_TO_WARNINGS_313); } if let Some(operation) = @@ -490,10 +493,10 @@ impl<'a> ImportReplacer<'a> { // `typing_extensions` to `types` let mut typing_extensions_to_types = vec![]; - if self.version >= PythonVersion::Py312 { + if self.version >= PythonVersion::PY312 { typing_extensions_to_types.extend(TYPING_EXTENSIONS_TO_TYPES_312); } - if self.version >= PythonVersion::Py313 { + if self.version >= PythonVersion::PY313 { typing_extensions_to_types.extend(TYPING_EXTENSIONS_TO_TYPES_313); } if let Some(operation) = self.try_replace(&typing_extensions_to_types, "types") { @@ -502,25 +505,25 @@ impl<'a> ImportReplacer<'a> { // `typing_extensions` to `typing` let mut typing_extensions_to_typing = TYPING_EXTENSIONS_TO_TYPING.to_vec(); - if self.version >= PythonVersion::Py37 { + if self.version >= PythonVersion::PY37 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_37); } - if self.version >= PythonVersion::Py38 { + if self.version >= PythonVersion::PY38 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_38); } - if self.version >= PythonVersion::Py39 { + if self.version >= PythonVersion::PY39 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_39); } - if self.version >= PythonVersion::Py310 { + if self.version >= PythonVersion::PY310 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_310); } - if self.version >= PythonVersion::Py311 { + if self.version >= PythonVersion::PY311 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_311); } - if self.version >= PythonVersion::Py312 { + if self.version >= PythonVersion::PY312 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_312); } - if self.version >= PythonVersion::Py313 { + if self.version >= PythonVersion::PY313 { typing_extensions_to_typing.extend(TYPING_EXTENSIONS_TO_TYPING_313); } if let Some(operation) = self.try_replace(&typing_extensions_to_typing, "typing") { @@ -529,10 +532,10 @@ impl<'a> ImportReplacer<'a> { } "mypy_extensions" => { let mut mypy_extensions_to_typing = vec![]; - if self.version >= PythonVersion::Py37 { + if self.version >= PythonVersion::PY37 { mypy_extensions_to_typing.extend(MYPY_EXTENSIONS_TO_TYPING_37); } - if self.version >= PythonVersion::Py38 { + if self.version >= PythonVersion::PY38 { mypy_extensions_to_typing.extend(MYPY_EXTENSIONS_TO_TYPING_38); } if let Some(operation) = self.try_replace(&mypy_extensions_to_typing, "typing") { @@ -542,10 +545,10 @@ impl<'a> ImportReplacer<'a> { "typing" => { // `typing` to `collections.abc` let mut typing_to_collections_abc = vec![]; - if self.version >= PythonVersion::Py39 { + if self.version >= PythonVersion::PY39 { typing_to_collections_abc.extend(TYPING_TO_COLLECTIONS_ABC_39); } - if self.version >= PythonVersion::Py310 { + if self.version >= PythonVersion::PY310 { typing_to_collections_abc.extend(TYPING_TO_COLLECTIONS_ABC_310); } if let Some(operation) = @@ -556,7 +559,7 @@ impl<'a> ImportReplacer<'a> { // `typing` to `collections` let mut typing_to_collections = vec![]; - if self.version >= PythonVersion::Py39 { + if self.version >= PythonVersion::PY39 { typing_to_collections.extend(TYPING_TO_COLLECTIONS_39); } if let Some(operation) = self.try_replace(&typing_to_collections, "collections") { @@ -565,19 +568,19 @@ impl<'a> ImportReplacer<'a> { // `typing` to `re` let mut typing_to_re = vec![]; - if self.version >= PythonVersion::Py39 { + if self.version >= PythonVersion::PY39 { typing_to_re.extend(TYPING_TO_RE_39); } if let Some(operation) = self.try_replace(&typing_to_re, "re") { operations.push(operation); } } - "typing.re" if self.version >= PythonVersion::Py39 => { + "typing.re" if self.version >= PythonVersion::PY39 => { if let Some(operation) = self.try_replace(TYPING_RE_TO_RE_39, "re") { operations.push(operation); } } - "backports.strenum" if self.version >= PythonVersion::Py311 => { + "backports.strenum" if self.version >= PythonVersion::PY311 => { if let Some(operation) = self.try_replace(BACKPORTS_STR_ENUM_TO_ENUM_311, "enum") { operations.push(operation); } @@ -693,7 +696,7 @@ impl<'a> ImportReplacer<'a> { } /// UP035 -pub(crate) fn deprecated_import(checker: &mut Checker, import_from_stmt: &StmtImportFrom) { +pub(crate) fn deprecated_import(checker: &Checker, import_from_stmt: &StmtImportFrom) { // Avoid relative and star imports. if import_from_stmt.level > 0 { return; @@ -719,7 +722,7 @@ pub(crate) fn deprecated_import(checker: &mut Checker, import_from_stmt: &StmtIm checker.locator(), checker.stylist(), checker.tokens(), - checker.settings.target_version, + checker.target_version(), ); for (operation, fix) in fixer.without_renames() { @@ -735,7 +738,7 @@ pub(crate) fn deprecated_import(checker: &mut Checker, import_from_stmt: &StmtIm import_from_stmt.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } for operation in fixer.with_renames() { @@ -745,6 +748,6 @@ pub(crate) fn deprecated_import(checker: &mut Checker, import_from_stmt: &StmtIm }, import_from_stmt.range(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_mock_import.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_mock_import.rs index 0b878fd6ae9f2..0a2a81b80aced 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_mock_import.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_mock_import.rs @@ -3,10 +3,10 @@ use libcst_native::{ AsName, AssignTargetExpression, Attribute, Dot, Expression, Import, ImportAlias, ImportFrom, ImportNames, Name, NameOrAttribute, ParenthesizableWhitespace, }; -use log::error; +use log::debug; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::UnqualifiedName; use ruff_python_ast::whitespace::indentation; use ruff_python_ast::{self as ast, Stmt}; @@ -14,10 +14,10 @@ use ruff_python_codegen::Stylist; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::matchers::{match_import, match_import_from, match_statement}; use crate::fix::codemods::CodegenStylist; -use crate::Locator; #[derive(Debug, PartialEq, Eq, Copy, Clone)] pub(crate) enum MockReference { @@ -47,15 +47,15 @@ pub(crate) enum MockReference { /// ## References /// - [Python documentation: `unittest.mock`](https://docs.python.org/3/library/unittest.mock.html) /// - [PyPI: `mock`](https://pypi.org/project/mock/) -#[violation] -pub struct DeprecatedMockImport { +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedMockImport { reference_type: MockReference, } impl AlwaysFixableViolation for DeprecatedMockImport { #[derive_message_formats] fn message(&self) -> String { - format!("`mock` is deprecated, use `unittest.mock`") + "`mock` is deprecated, use `unittest.mock`".to_string() } fn fix_title(&self) -> String { @@ -250,7 +250,7 @@ fn format_import_from( } /// UP026 -pub(crate) fn deprecated_mock_attribute(checker: &mut Checker, attribute: &ast::ExprAttribute) { +pub(crate) fn deprecated_mock_attribute(checker: &Checker, attribute: &ast::ExprAttribute) { if !checker.semantic().seen_module(Modules::MOCK) { return; } @@ -268,12 +268,12 @@ pub(crate) fn deprecated_mock_attribute(checker: &mut Checker, attribute: &ast:: "mock".to_string(), attribute.value.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } /// UP026 -pub(crate) fn deprecated_mock_import(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn deprecated_mock_import(checker: &Checker, stmt: &Stmt) { match stmt { Stmt::Import(ast::StmtImport { names, range: _ }) => { // Find all `mock` imports. @@ -286,7 +286,7 @@ pub(crate) fn deprecated_mock_import(checker: &mut Checker, stmt: &Stmt) { match format_import(stmt, indent, checker.locator(), checker.stylist()) { Ok(content) => Some(content), Err(e) => { - error!("Failed to rewrite `mock` import: {e}"); + debug!("Failed to rewrite `mock` import: {e}"); None } } @@ -309,7 +309,7 @@ pub(crate) fn deprecated_mock_import(checker: &mut Checker, stmt: &Stmt) { stmt.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -337,7 +337,7 @@ pub(crate) fn deprecated_mock_import(checker: &mut Checker, stmt: &Stmt) { .map(Fix::safe_edit) }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } _ => (), diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_unittest_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_unittest_alias.rs index 431ef71b90fac..294f155c19a97 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_unittest_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/deprecated_unittest_alias.rs @@ -3,7 +3,7 @@ use rustc_hash::FxHashMap; use std::sync::LazyLock; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -38,8 +38,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python 3.11 documentation: Deprecated aliases](https://docs.python.org/3.11/library/unittest.html#deprecated-aliases) -#[violation] -pub struct DeprecatedUnittestAlias { +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedUnittestAlias { alias: String, target: String, } @@ -78,7 +78,7 @@ static DEPRECATED_ALIASES: LazyLock<FxHashMap<&'static str, &'static str>> = Laz }); /// UP005 -pub(crate) fn deprecated_unittest_alias(checker: &mut Checker, expr: &Expr) { +pub(crate) fn deprecated_unittest_alias(checker: &Checker, expr: &Expr) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = expr else { return; }; @@ -102,5 +102,5 @@ pub(crate) fn deprecated_unittest_alias(checker: &mut Checker, expr: &Expr) { format!("self.{target}"), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/extraneous_parentheses.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/extraneous_parentheses.rs index a46441056ff03..e50b6fb812d66 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/extraneous_parentheses.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/extraneous_parentheses.rs @@ -1,7 +1,7 @@ use std::slice::Iter; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_parser::{Token, TokenKind, Tokens}; use ruff_text_size::{Ranged, TextRange}; @@ -23,13 +23,13 @@ use crate::Locator; /// ```python /// print("Hello, world") /// ``` -#[violation] -pub struct ExtraneousParentheses; +#[derive(ViolationMetadata)] +pub(crate) struct ExtraneousParentheses; impl AlwaysFixableViolation for ExtraneousParentheses { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid extraneous parentheses") + "Avoid extraneous parentheses".to_string() } fn fix_title(&self) -> String { diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/f_strings.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/f_strings.rs index 9259d08236e69..413672ce57694 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/f_strings.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/f_strings.rs @@ -4,7 +4,7 @@ use anyhow::{Context, Result}; use rustc_hash::{FxHashMap, FxHashSet}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::str::{leading_quote, trailing_quote}; use ruff_python_ast::{self as ast, Expr, Keyword}; @@ -15,10 +15,10 @@ use ruff_python_parser::TokenKind; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::pyflakes::format::FormatSummary; use crate::rules::pyupgrade::helpers::{curly_escape, curly_unescape}; -use crate::Locator; /// ## What it does /// Checks for `str.format` calls that can be replaced with f-strings. @@ -39,15 +39,15 @@ use crate::Locator; /// /// ## References /// - [Python documentation: f-strings](https://docs.python.org/3/reference/lexical_analysis.html#f-strings) -#[violation] -pub struct FString; +#[derive(ViolationMetadata)] +pub(crate) struct FString; impl Violation for FString { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use f-string instead of `format` call") + "Use f-string instead of `format` call".to_string() } fn fix_title(&self) -> Option<String> { @@ -391,7 +391,7 @@ impl FStringConversion { } /// UP032 -pub(crate) fn f_strings(checker: &mut Checker, call: &ast::ExprCall, summary: &FormatSummary) { +pub(crate) fn f_strings(checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary) { if summary.has_nested_parts { return; } @@ -493,7 +493,7 @@ pub(crate) fn f_strings(checker: &mut Checker, call: &ast::ExprCall, summary: &F checker .semantic() .resolve_qualified_name(call.func.as_ref()) - .map_or(false, |qualified_name| { + .is_some_and(|qualified_name| { matches!( qualified_name.segments(), ["django", "utils", "translation", "gettext" | "gettext_lazy"] @@ -527,6 +527,6 @@ pub(crate) fn f_strings(checker: &mut Checker, call: &ast::ExprCall, summary: &F call.range(), ))); } - }; - checker.diagnostics.push(diagnostic); + } + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/format_literals.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/format_literals.rs index c3955b4ae0630..ed9536786eefe 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/format_literals.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/format_literals.rs @@ -1,22 +1,22 @@ use std::sync::LazyLock; -use anyhow::{anyhow, Result}; +use anyhow::{Result, anyhow}; use libcst_native::{Arg, Expression}; use regex::Regex; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_codegen::Stylist; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::matchers::{ match_attribute, match_call_mut, match_expression, transform_expression_text, }; use crate::fix::codemods::CodegenStylist; use crate::rules::pyflakes::format::FormatSummary; -use crate::Locator; /// ## What it does /// Checks for unnecessary positional indices in format strings. @@ -39,18 +39,22 @@ use crate::Locator; /// "{}, {}".format("Hello", "World") # "Hello, World" /// ``` /// +/// This fix is marked as unsafe because: +/// - Comments attached to arguments are not moved, which can cause comments to mismatch the actual arguments. +/// - If arguments have side effects (e.g., print), reordering may change program behavior. +/// /// ## References /// - [Python documentation: Format String Syntax](https://docs.python.org/3/library/string.html#format-string-syntax) /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct FormatLiterals; +#[derive(ViolationMetadata)] +pub(crate) struct FormatLiterals; impl Violation for FormatLiterals { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use implicit references for positional format fields") + "Use implicit references for positional format fields".to_string() } fn fix_title(&self) -> Option<String> { @@ -59,11 +63,7 @@ impl Violation for FormatLiterals { } /// UP030 -pub(crate) fn format_literals( - checker: &mut Checker, - call: &ast::ExprCall, - summary: &FormatSummary, -) { +pub(crate) fn format_literals(checker: &Checker, call: &ast::ExprCall, summary: &FormatSummary) { // The format we expect is, e.g.: `"{0} {1}".format(...)` if summary.has_nested_parts { return; @@ -117,7 +117,7 @@ pub(crate) fn format_literals( generate_call(call, arguments, checker.locator(), checker.stylist()) .map(|suggestion| Fix::unsafe_edit(Edit::range_replacement(suggestion, call.range()))) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns true if the indices are sequential. diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_with_maxsize_none.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_with_maxsize_none.rs index febb7f59820c8..42531ff4c5f31 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_with_maxsize_none.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_with_maxsize_none.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Arguments, Decorator, Expr, Keyword}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; use crate::importer::ImportRequest; @@ -40,13 +40,13 @@ use crate::importer::ImportRequest; /// /// ## References /// - [Python documentation: `@functools.cache`](https://docs.python.org/3/library/functools.html#functools.cache) -#[violation] -pub struct LRUCacheWithMaxsizeNone; +#[derive(ViolationMetadata)] +pub(crate) struct LRUCacheWithMaxsizeNone; impl AlwaysFixableViolation for LRUCacheWithMaxsizeNone { #[derive_message_formats] fn message(&self) -> String { - format!("Use `@functools.cache` instead of `@functools.lru_cache(maxsize=None)`") + "Use `@functools.cache` instead of `@functools.lru_cache(maxsize=None)`".to_string() } fn fix_title(&self) -> String { @@ -55,7 +55,7 @@ impl AlwaysFixableViolation for LRUCacheWithMaxsizeNone { } /// UP033 -pub(crate) fn lru_cache_with_maxsize_none(checker: &mut Checker, decorator_list: &[Decorator]) { +pub(crate) fn lru_cache_with_maxsize_none(checker: &Checker, decorator_list: &[Decorator]) { for decorator in decorator_list { let Expr::Call(ast::ExprCall { func, @@ -101,7 +101,7 @@ pub(crate) fn lru_cache_with_maxsize_none(checker: &mut Checker, decorator_list: Edit::range_replacement(binding, decorator.expression.range()); Ok(Fix::safe_edits(import_edit, [reference_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_without_parameters.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_without_parameters.rs index 48f1cf49c8676..6fe2319a3c36d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_without_parameters.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/lru_cache_without_parameters.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Decorator, Expr}; use ruff_text_size::{Ranged, TextRange}; @@ -38,13 +38,13 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `@functools.lru_cache`](https://docs.python.org/3/library/functools.html#functools.lru_cache) /// - [Let lru_cache be used as a decorator with no arguments](https://github.com/python/cpython/issues/80953) -#[violation] -pub struct LRUCacheWithoutParameters; +#[derive(ViolationMetadata)] +pub(crate) struct LRUCacheWithoutParameters; impl AlwaysFixableViolation for LRUCacheWithoutParameters { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary parentheses to `functools.lru_cache`") + "Unnecessary parentheses to `functools.lru_cache`".to_string() } fn fix_title(&self) -> String { @@ -53,7 +53,7 @@ impl AlwaysFixableViolation for LRUCacheWithoutParameters { } /// UP011 -pub(crate) fn lru_cache_without_parameters(checker: &mut Checker, decorator_list: &[Decorator]) { +pub(crate) fn lru_cache_without_parameters(checker: &Checker, decorator_list: &[Decorator]) { for decorator in decorator_list { let Expr::Call(ast::ExprCall { func, @@ -79,7 +79,7 @@ pub(crate) fn lru_cache_without_parameters(checker: &mut Checker, decorator_list TextRange::new(func.end(), decorator.end()), ); diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(arguments.range()))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/mod.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/mod.rs index a3dbd706bf516..c8f5f1b04b496 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/mod.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/mod.rs @@ -11,9 +11,11 @@ pub(crate) use format_literals::*; pub(crate) use lru_cache_with_maxsize_none::*; pub(crate) use lru_cache_without_parameters::*; pub(crate) use native_literals::*; +pub(crate) use non_pep646_unpack::*; pub(crate) use open_alias::*; pub(crate) use os_error_alias::*; pub(crate) use outdated_version_block::*; +pub(crate) use pep695::*; pub(crate) use printf_string_formatting::*; pub(crate) use quoted_annotation::*; pub(crate) use redundant_open_modes::*; @@ -35,7 +37,6 @@ pub(crate) use unpacked_list_comprehension::*; pub(crate) use use_pep585_annotation::*; pub(crate) use use_pep604_annotation::*; pub(crate) use use_pep604_isinstance::*; -pub(crate) use use_pep695_type_alias::*; pub(crate) use useless_metaclass_type::*; pub(crate) use useless_object_inheritance::*; pub(crate) use yield_in_for_loop::*; @@ -53,9 +54,11 @@ mod format_literals; mod lru_cache_with_maxsize_none; mod lru_cache_without_parameters; mod native_literals; +mod non_pep646_unpack; mod open_alias; mod os_error_alias; mod outdated_version_block; +pub(crate) mod pep695; mod printf_string_formatting; mod quoted_annotation; mod redundant_open_modes; @@ -77,7 +80,6 @@ mod unpacked_list_comprehension; mod use_pep585_annotation; mod use_pep604_annotation; mod use_pep604_isinstance; -mod use_pep695_type_alias; mod useless_metaclass_type; mod useless_object_inheritance; mod yield_in_for_loop; diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/native_literals.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/native_literals.rs index e916c9d50c833..fbca70791fc19 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/native_literals.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/native_literals.rs @@ -1,9 +1,10 @@ use std::fmt; use std::str::FromStr; -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, Int, LiteralExpressionRef, UnaryOp}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, Int, LiteralExpressionRef, OperatorPrecedence, UnaryOp}; +use ruff_source_file::find_newline; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -33,10 +34,20 @@ impl FromStr for LiteralType { } impl LiteralType { - fn as_zero_value_expr(self) -> Expr { + fn as_zero_value_expr(self, checker: &Checker) -> Expr { match self { - LiteralType::Str => ast::ExprStringLiteral::default().into(), - LiteralType::Bytes => ast::ExprBytesLiteral::default().into(), + LiteralType::Str => ast::StringLiteral { + value: Box::default(), + range: TextRange::default(), + flags: checker.default_string_flags(), + } + .into(), + LiteralType::Bytes => ast::BytesLiteral { + value: Box::default(), + range: TextRange::default(), + flags: checker.default_bytes_flags(), + } + .into(), LiteralType::Int => ast::ExprNumberLiteral { value: ast::Number::Int(Int::from(0u8)), range: TextRange::default(), @@ -103,14 +114,17 @@ impl fmt::Display for LiteralType { /// "foo" /// ``` /// +/// ## Fix safety +/// The fix is marked as unsafe if it might remove comments. +/// /// ## References /// - [Python documentation: `str`](https://docs.python.org/3/library/stdtypes.html#str) /// - [Python documentation: `bytes`](https://docs.python.org/3/library/stdtypes.html#bytes) /// - [Python documentation: `int`](https://docs.python.org/3/library/functions.html#int) /// - [Python documentation: `float`](https://docs.python.org/3/library/functions.html#float) /// - [Python documentation: `bool`](https://docs.python.org/3/library/functions.html#bool) -#[violation] -pub struct NativeLiterals { +#[derive(ViolationMetadata)] +pub(crate) struct NativeLiterals { literal_type: LiteralType, } @@ -135,7 +149,7 @@ impl AlwaysFixableViolation for NativeLiterals { /// UP018 pub(crate) fn native_literals( - checker: &mut Checker, + checker: &Checker, call: &ast::ExprCall, parent_expr: Option<&ast::Expr>, ) { @@ -147,13 +161,14 @@ pub(crate) fn native_literals( keywords, range: _, }, - range: _, + range: call_range, } = call; if !keywords.is_empty() || args.len() > 1 { return; } + let tokens = checker.tokens(); let semantic = checker.semantic(); let Some(builtin) = semantic.resolve_builtin_symbol(func) else { @@ -186,21 +201,21 @@ pub(crate) fn native_literals( return; } - let expr = literal_type.as_zero_value_expr(); + let expr = literal_type.as_zero_value_expr(checker); let content = checker.generator().expr(&expr); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( content, call.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Some(arg) => { - let literal_expr = if let Some(literal_expr) = arg.as_literal_expr() { + let (has_unary_op, literal_expr) = if let Some(literal_expr) = arg.as_literal_expr() { // Skip implicit concatenated strings. if literal_expr.is_implicit_concatenated() { return; } - literal_expr + (false, literal_expr) } else if let Expr::UnaryOp(ast::ExprUnaryOp { op: UnaryOp::UAdd | UnaryOp::USub, operand, @@ -211,7 +226,7 @@ pub(crate) fn native_literals( .as_literal_expr() .filter(|expr| matches!(expr, LiteralExpressionRef::NumberLiteral(_))) { - literal_expr + (true, literal_expr) } else { // Only allow unary operators for numbers. return; @@ -230,21 +245,54 @@ pub(crate) fn native_literals( let arg_code = checker.locator().slice(arg); - // Attribute access on an integer requires the integer to be parenthesized to disambiguate from a float - // Ex) `(7).denominator` is valid but `7.denominator` is not - // Note that floats do not have this problem - // Ex) `(1.0).real` is valid and `1.0.real` is too - let content = match (parent_expr, literal_type) { - (Some(Expr::Attribute(_)), LiteralType::Int) => format!("({arg_code})"), + let mut needs_space = false; + // Look for the `Rpar` token of the call expression and check if there is a keyword token right + // next to it without any space separating them. Without this check, the fix for this + // rule would create a syntax error. + // Ex) `bool(True)and None` no space between `)` and the keyword `and`. + // + // Subtract 1 from the end of the range to include `Rpar` token in the slice. + if let [paren_token, next_token, ..] = tokens.after(call_range.sub_end(1.into()).end()) + { + needs_space = next_token.kind().is_keyword() + && paren_token.range().end() == next_token.range().start(); + } + + let mut content = match (parent_expr, literal_type, has_unary_op) { + // Expressions including newlines must be parenthesised to be valid syntax + (_, _, true) if find_newline(arg_code).is_some() => format!("({arg_code})"), + + // Attribute access on an integer requires the integer to be parenthesized to disambiguate from a float + // Ex) `(7).denominator` is valid but `7.denominator` is not + // Note that floats do not have this problem + // Ex) `(1.0).real` is valid and `1.0.real` is too + (Some(Expr::Attribute(_)), LiteralType::Int, _) => format!("({arg_code})"), + + (Some(parent), _, _) => { + if OperatorPrecedence::from(parent) > OperatorPrecedence::from(arg) { + format!("({arg_code})") + } else { + arg_code.to_string() + } + } + _ => arg_code.to_string(), }; - let mut diagnostic = Diagnostic::new(NativeLiterals { literal_type }, call.range()); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - content, - call.range(), - ))); - checker.diagnostics.push(diagnostic); + if needs_space { + content.push(' '); + } + + let applicability = if checker.comment_ranges().intersects(call.range) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + let edit = Edit::range_replacement(content, call.range()); + let fix = Fix::applicable_edit(edit, applicability); + + let diagnostic = Diagnostic::new(NativeLiterals { literal_type }, call.range()); + checker.report_diagnostic(diagnostic.with_fix(fix)); } } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/non_pep646_unpack.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/non_pep646_unpack.rs new file mode 100644 index 0000000000000..de022c51ccd44 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/non_pep646_unpack.rs @@ -0,0 +1,148 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprSubscript, PythonVersion}; +use ruff_python_semantic::SemanticModel; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for uses of `Unpack[]` on Python 3.11 and above, and suggests +/// using `*` instead. +/// +/// ## Why is this bad? +/// [PEP 646] introduced a new syntax for unpacking sequences based on the `*` +/// operator. This syntax is more concise and readable than the previous +/// `Unpack[]` syntax. +/// +/// ## Example +/// ```python +/// from typing import Unpack +/// +/// +/// def foo(*args: Unpack[tuple[int, ...]]) -> None: +/// pass +/// ``` +/// +/// Use instead: +/// ```python +/// def foo(*args: *tuple[int, ...]) -> None: +/// pass +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe, as `Unpack[T]` and `*T` are considered +/// different values when introspecting types at runtime. However, in most cases, +/// the fix should be safe to apply. +/// +/// [PEP 646]: https://peps.python.org/pep-0646/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP646Unpack; + +impl Violation for NonPEP646Unpack { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; + + #[derive_message_formats] + fn message(&self) -> String { + "Use `*` for unpacking".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Convert to `*` for unpacking".to_string()) + } +} + +/// UP044 +pub(crate) fn use_pep646_unpack(checker: &Checker, expr: &ExprSubscript) { + if checker.target_version() < PythonVersion::PY311 { + return; + } + + if !checker.semantic().seen_typing() { + return; + } + + let ExprSubscript { + range, + value, + slice, + .. + } = expr; + + // Skip semantically invalid subscript calls (e.g. `Unpack[str | num]`). + if !(slice.is_name_expr() || slice.is_subscript_expr() || slice.is_attribute_expr()) { + return; + } + + if !checker.semantic().match_typing_expr(value, "Unpack") { + return; + } + + // Determine whether we're in a valid context for a star expression. + // + // Star expressions are only allowed in two places: + // - Subscript indexes (e.g., `Generic[DType, *Shape]`). + // - Variadic positional arguments (e.g., `def f(*args: *int)`). + // + // See: <https://peps.python.org/pep-0646/#grammar-changes> + if !in_subscript_index(expr, checker.semantic()) && !in_vararg(expr, checker.semantic()) { + return; + } + + let mut diagnostic = Diagnostic::new(NonPEP646Unpack, *range); + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + format!("*{}", checker.locator().slice(slice.as_ref())), + *range, + ))); + checker.report_diagnostic(diagnostic); +} + +/// Determine whether the [`ExprSubscript`] is in a subscript index (e.g., `Generic[Unpack[int]]`). +fn in_subscript_index(expr: &ExprSubscript, semantic: &SemanticModel) -> bool { + let parent = semantic + .current_expressions() + .skip(1) + .find_map(|expr| expr.as_subscript_expr()); + + let Some(parent) = parent else { + return false; + }; + + // E.g., `Generic[Unpack[int]]`. + if parent + .slice + .as_subscript_expr() + .is_some_and(|slice| slice == expr) + { + return true; + } + + // E.g., `Generic[DType, Unpack[int]]`. + if parent.slice.as_tuple_expr().is_some_and(|slice| { + slice + .elts + .iter() + .any(|elt| elt.as_subscript_expr().is_some_and(|elt| elt == expr)) + }) { + return true; + } + + false +} + +/// Determine whether the [`ExprSubscript`] is attached to a variadic argument in a function +/// definition (e.g., `def f(*args: Unpack[int])`). +fn in_vararg(expr: &ExprSubscript, semantic: &SemanticModel) -> bool { + let parent = semantic.current_statement().as_function_def_stmt(); + + let Some(parent) = parent else { + return false; + }; + + parent + .parameters + .vararg + .as_ref() + .and_then(|vararg| vararg.annotation()) + .and_then(Expr::as_subscript_expr) + == Some(expr) +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/open_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/open_alias.rs index eb8e0bbb0a6cb..f67a777d247cd 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/open_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/open_alias.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -29,15 +29,15 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `io.open`](https://docs.python.org/3/library/io.html#io.open) -#[violation] -pub struct OpenAlias; +#[derive(ViolationMetadata)] +pub(crate) struct OpenAlias; impl Violation for OpenAlias { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use builtin `open`") + "Use builtin `open`".to_string() } fn fix_title(&self) -> Option<String> { @@ -46,7 +46,7 @@ impl Violation for OpenAlias { } /// UP020 -pub(crate) fn open_alias(checker: &mut Checker, expr: &Expr, func: &Expr) { +pub(crate) fn open_alias(checker: &Checker, expr: &Expr, func: &Expr) { if checker .semantic() .resolve_qualified_name(func) @@ -64,6 +64,6 @@ pub(crate) fn open_alias(checker: &mut Checker, expr: &Expr, func: &Expr) { import_edit, )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/os_error_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/os_error_alias.rs index 6fa5d99a774e4..bd86250758439 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/os_error_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/os_error_alias.rs @@ -3,7 +3,7 @@ use ruff_text_size::{Ranged, TextRange}; use crate::fix::edits::pad; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::{Name, UnqualifiedName}; use ruff_python_semantic::SemanticModel; @@ -34,15 +34,15 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -#[violation] -pub struct OSErrorAlias { +#[derive(ViolationMetadata)] +pub(crate) struct OSErrorAlias { name: Option<String>, } impl AlwaysFixableViolation for OSErrorAlias { #[derive_message_formats] fn message(&self) -> String { - format!("Replace aliased errors with `OSError`") + "Replace aliased errors with `OSError`".to_string() } fn fix_title(&self) -> String { @@ -64,13 +64,13 @@ fn is_alias(expr: &Expr, semantic: &SemanticModel) -> bool { [ "" | "builtins", "EnvironmentError" | "IOError" | "WindowsError" - ] | ["mmap" | "select" | "socket" | "os", "error"] + ] | ["mmap" | "resource" | "select" | "socket" | "os", "error"] ) }) } /// Create a [`Diagnostic`] for a single target, like an [`Expr::Name`]. -fn atom_diagnostic(checker: &mut Checker, target: &Expr) { +fn atom_diagnostic(checker: &Checker, target: &Expr) { let mut diagnostic = Diagnostic::new( OSErrorAlias { name: UnqualifiedName::from_expr(target).map(|name| name.to_string()), @@ -88,11 +88,11 @@ fn atom_diagnostic(checker: &mut Checker, target: &Expr) { import_edit, )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Create a [`Diagnostic`] for a tuple of expressions. -fn tuple_diagnostic(checker: &mut Checker, tuple: &ast::ExprTuple, aliases: &[&Expr]) { +fn tuple_diagnostic(checker: &Checker, tuple: &ast::ExprTuple, aliases: &[&Expr]) { let mut diagnostic = Diagnostic::new(OSErrorAlias { name: None }, tuple.range()); let semantic = checker.semantic(); if semantic.has_builtin_binding("OSError") { @@ -138,11 +138,11 @@ fn tuple_diagnostic(checker: &mut Checker, tuple: &ast::ExprTuple, aliases: &[&E tuple.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// UP024 -pub(crate) fn os_error_alias_handlers(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn os_error_alias_handlers(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, .. }) = handler; let Some(expr) = type_.as_ref() else { @@ -172,14 +172,14 @@ pub(crate) fn os_error_alias_handlers(checker: &mut Checker, handlers: &[ExceptH } /// UP024 -pub(crate) fn os_error_alias_call(checker: &mut Checker, func: &Expr) { +pub(crate) fn os_error_alias_call(checker: &Checker, func: &Expr) { if is_alias(func, checker.semantic()) { atom_diagnostic(checker, func); } } /// UP024 -pub(crate) fn os_error_alias_raise(checker: &mut Checker, expr: &Expr) { +pub(crate) fn os_error_alias_raise(checker: &Checker, expr: &Expr) { if matches!(expr, Expr::Name(_) | Expr::Attribute(_)) { if is_alias(expr, checker.semantic()) { atom_diagnostic(checker, expr); diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/outdated_version_block.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/outdated_version_block.rs index c4894db891b2c..51af61887f917 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/outdated_version_block.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/outdated_version_block.rs @@ -3,9 +3,9 @@ use std::cmp::Ordering; use anyhow::Result; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_subscript; -use ruff_python_ast::stmt_if::{if_elif_branches, BranchKind, IfElifBranch}; +use ruff_python_ast::stmt_if::{BranchKind, IfElifBranch, if_elif_branches}; use ruff_python_ast::whitespace::indentation; use ruff_python_ast::{self as ast, CmpOp, ElifElseClause, Expr, Int, StmtIf}; use ruff_source_file::LineRanges; @@ -13,7 +13,7 @@ use ruff_text_size::{Ranged, TextLen, TextRange}; use crate::checkers::ast::Checker; use crate::fix::edits::{adjust_indentation, delete_stmt}; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for conditional blocks gated on `sys.version_info` comparisons @@ -44,10 +44,14 @@ use crate::settings::types::PythonVersion; /// ## Options /// - `target-version` /// +/// ## Fix safety +/// This rule's fix is marked as unsafe because it will remove all code, +/// comments, and annotations within unreachable version blocks. +/// /// ## References /// - [Python documentation: `sys.version_info`](https://docs.python.org/3/library/sys.html#sys.version_info) -#[violation] -pub struct OutdatedVersionBlock { +#[derive(ViolationMetadata)] +pub(crate) struct OutdatedVersionBlock { reason: Reason, } @@ -56,18 +60,16 @@ impl Violation for OutdatedVersionBlock { #[derive_message_formats] fn message(&self) -> String { - let OutdatedVersionBlock { reason } = self; - match reason { + match self.reason { Reason::AlwaysFalse | Reason::AlwaysTrue => { - format!("Version block is outdated for minimum Python version") + "Version block is outdated for minimum Python version".to_string() } - Reason::Invalid => format!("Version specifier is invalid"), + Reason::Invalid => "Version specifier is invalid".to_string(), } } fn fix_title(&self) -> Option<String> { - let OutdatedVersionBlock { reason } = self; - match reason { + match self.reason { Reason::AlwaysFalse | Reason::AlwaysTrue => { Some("Remove outdated version block".to_string()) } @@ -84,7 +86,7 @@ enum Reason { } /// UP036 -pub(crate) fn outdated_version_block(checker: &mut Checker, stmt_if: &StmtIf) { +pub(crate) fn outdated_version_block(checker: &Checker, stmt_if: &StmtIf) { for branch in if_elif_branches(stmt_if) { let Expr::Compare(ast::ExprCompare { left, @@ -117,7 +119,7 @@ pub(crate) fn outdated_version_block(checker: &mut Checker, stmt_if: &StmtIf) { let Some(version) = extract_version(elts) else { return; }; - let target = checker.settings.target_version; + let target = checker.target_version(); match version_always_less_than( &version, target, @@ -144,10 +146,10 @@ pub(crate) fn outdated_version_block(checker: &mut Checker, stmt_if: &StmtIf) { } { diagnostic.set_fix(fix); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Err(_) => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( OutdatedVersionBlock { reason: Reason::Invalid, }, @@ -185,7 +187,7 @@ pub(crate) fn outdated_version_block(checker: &mut Checker, stmt_if: &StmtIf) { if let Some(fix) = fix_always_true_branch(checker, stmt_if, &branch) { diagnostic.set_fix(fix); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Reason::AlwaysFalse => { let mut diagnostic = @@ -193,10 +195,10 @@ pub(crate) fn outdated_version_block(checker: &mut Checker, stmt_if: &StmtIf) { if let Some(fix) = fix_always_false_branch(checker, stmt_if, &branch) { diagnostic.set_fix(fix); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Reason::Invalid => { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( OutdatedVersionBlock { reason: Reason::Invalid, }, @@ -238,14 +240,27 @@ fn version_always_less_than( return Err(anyhow::anyhow!("invalid minor version: {if_minor}")); }; + let if_micro = match check_version_iter.next() { + None => None, + Some(micro) => match micro.as_u8() { + Some(micro) => Some(micro), + None => anyhow::bail!("invalid micro version: {micro}"), + }, + }; + Ok(if or_equal { // Ex) `sys.version_info <= 3.8`. If Python 3.8 is the minimum supported version, // the condition won't always evaluate to `false`, so we want to return `false`. if_minor < py_minor } else { - // Ex) `sys.version_info < 3.8`. If Python 3.8 is the minimum supported version, - // the condition _will_ always evaluate to `false`, so we want to return `true`. - if_minor <= py_minor + if let Some(if_micro) = if_micro { + // Ex) `sys.version_info < 3.8.3` + if_minor < py_minor || if_minor == py_minor && if_micro == 0 + } else { + // Ex) `sys.version_info < 3.8`. If Python 3.8 is the minimum supported version, + // the condition _will_ always evaluate to `false`, so we want to return `true`. + if_minor <= py_minor + } }) } } @@ -368,7 +383,7 @@ fn fix_always_false_branch( /// if sys.version_info >= (3, 8): ... /// ``` fn fix_always_true_branch( - checker: &mut Checker, + checker: &Checker, stmt_if: &StmtIf, branch: &IfElifBranch, ) -> Option<Fix> { @@ -445,17 +460,17 @@ mod tests { use super::*; - #[test_case(PythonVersion::Py37, & [2], true, true; "compare-2.0")] - #[test_case(PythonVersion::Py37, & [2, 0], true, true; "compare-2.0-whole")] - #[test_case(PythonVersion::Py37, & [3], true, true; "compare-3.0")] - #[test_case(PythonVersion::Py37, & [3, 0], true, true; "compare-3.0-whole")] - #[test_case(PythonVersion::Py37, & [3, 1], true, true; "compare-3.1")] - #[test_case(PythonVersion::Py37, & [3, 5], true, true; "compare-3.5")] - #[test_case(PythonVersion::Py37, & [3, 7], true, false; "compare-3.7")] - #[test_case(PythonVersion::Py37, & [3, 7], false, true; "compare-3.7-not-equal")] - #[test_case(PythonVersion::Py37, & [3, 8], false, false; "compare-3.8")] - #[test_case(PythonVersion::Py310, & [3, 9], true, true; "compare-3.9")] - #[test_case(PythonVersion::Py310, & [3, 11], true, false; "compare-3.11")] + #[test_case(PythonVersion::PY37, & [2], true, true; "compare-2.0")] + #[test_case(PythonVersion::PY37, & [2, 0], true, true; "compare-2.0-whole")] + #[test_case(PythonVersion::PY37, & [3], true, true; "compare-3.0")] + #[test_case(PythonVersion::PY37, & [3, 0], true, true; "compare-3.0-whole")] + #[test_case(PythonVersion::PY37, & [3, 1], true, true; "compare-3.1")] + #[test_case(PythonVersion::PY37, & [3, 5], true, true; "compare-3.5")] + #[test_case(PythonVersion::PY37, & [3, 7], true, false; "compare-3.7")] + #[test_case(PythonVersion::PY37, & [3, 7], false, true; "compare-3.7-not-equal")] + #[test_case(PythonVersion::PY37, & [3, 8], false, false; "compare-3.8")] + #[test_case(PythonVersion::PY310, & [3, 9], true, true; "compare-3.9")] + #[test_case(PythonVersion::PY310, & [3, 11], true, false; "compare-3.11")] fn test_compare_version( version: PythonVersion, target_versions: &[u8], diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/mod.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/mod.rs new file mode 100644 index 0000000000000..fc6a242c8584c --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/mod.rs @@ -0,0 +1,393 @@ +//! Shared code for [`non_pep695_type_alias`] (UP040), +//! [`non_pep695_generic_class`] (UP046), and [`non_pep695_generic_function`] +//! (UP047) + +use std::fmt::Display; + +use itertools::Itertools; +use ruff_python_ast::{ + self as ast, Arguments, Expr, ExprCall, ExprName, ExprSubscript, Identifier, Stmt, StmtAssign, + TypeParam, TypeParamParamSpec, TypeParamTypeVar, TypeParamTypeVarTuple, + name::Name, + visitor::{self, Visitor}, +}; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::{Ranged, TextRange}; + +pub(crate) use non_pep695_generic_class::*; +pub(crate) use non_pep695_generic_function::*; +pub(crate) use non_pep695_type_alias::*; +pub(crate) use private_type_parameter::*; + +use crate::checkers::ast::Checker; + +mod non_pep695_generic_class; +mod non_pep695_generic_function; +mod non_pep695_type_alias; +mod private_type_parameter; + +#[derive(Debug)] +pub(crate) enum TypeVarRestriction<'a> { + /// A type variable with a bound, e.g., `TypeVar("T", bound=int)`. + Bound(&'a Expr), + /// A type variable with constraints, e.g., `TypeVar("T", int, str)`. + Constraint(Vec<&'a Expr>), + /// `AnyStr` is a special case: the only public `TypeVar` defined in the standard library, + /// and thus the only one that we recognise when imported from another module. + AnyStr, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub(crate) enum TypeParamKind { + TypeVar, + TypeVarTuple, + ParamSpec, +} + +#[derive(Debug)] +pub(crate) struct TypeVar<'a> { + pub(crate) name: &'a str, + pub(crate) restriction: Option<TypeVarRestriction<'a>>, + pub(crate) kind: TypeParamKind, + pub(crate) default: Option<&'a Expr>, +} + +/// Wrapper for formatting a sequence of [`TypeVar`]s for use as a generic type parameter (e.g. `[T, +/// *Ts, **P]`). See [`DisplayTypeVar`] for further details. +pub(crate) struct DisplayTypeVars<'a> { + pub(crate) type_vars: &'a [TypeVar<'a>], + pub(crate) source: &'a str, +} + +impl Display for DisplayTypeVars<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let nvars = self.type_vars.len(); + if nvars == 0 { + return Ok(()); + } + f.write_str("[")?; + for (i, tv) in self.type_vars.iter().enumerate() { + write!(f, "{}", tv.display(self.source))?; + if i < nvars - 1 { + f.write_str(", ")?; + } + } + f.write_str("]")?; + + Ok(()) + } +} + +/// Used for displaying `type_var`. `source` is the whole file, which will be sliced to recover the +/// `TypeVarRestriction` values for generic bounds and constraints. +pub(crate) struct DisplayTypeVar<'a> { + type_var: &'a TypeVar<'a>, + source: &'a str, +} + +impl TypeVar<'_> { + fn display<'a>(&'a self, source: &'a str) -> DisplayTypeVar<'a> { + DisplayTypeVar { + type_var: self, + source, + } + } +} + +impl Display for DisplayTypeVar<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self.type_var.kind { + TypeParamKind::TypeVar => {} + TypeParamKind::TypeVarTuple => f.write_str("*")?, + TypeParamKind::ParamSpec => f.write_str("**")?, + } + f.write_str(self.type_var.name)?; + if let Some(restriction) = &self.type_var.restriction { + f.write_str(": ")?; + match restriction { + TypeVarRestriction::Bound(bound) => { + f.write_str(&self.source[bound.range()])?; + } + TypeVarRestriction::AnyStr => f.write_str("(bytes, str)")?, + TypeVarRestriction::Constraint(vec) => { + let len = vec.len(); + f.write_str("(")?; + for (i, v) in vec.iter().enumerate() { + f.write_str(&self.source[v.range()])?; + if i < len - 1 { + f.write_str(", ")?; + } + } + f.write_str(")")?; + } + } + } + + Ok(()) + } +} + +impl<'a> From<&'a TypeVar<'a>> for TypeParam { + fn from( + TypeVar { + name, + restriction, + kind, + default: _, // TODO(brent) see below + }: &'a TypeVar<'a>, + ) -> Self { + match kind { + TypeParamKind::TypeVar => { + TypeParam::TypeVar(TypeParamTypeVar { + range: TextRange::default(), + name: Identifier::new(*name, TextRange::default()), + bound: match restriction { + Some(TypeVarRestriction::Bound(bound)) => Some(Box::new((*bound).clone())), + Some(TypeVarRestriction::Constraint(constraints)) => { + Some(Box::new(Expr::Tuple(ast::ExprTuple { + range: TextRange::default(), + elts: constraints.iter().map(|expr| (*expr).clone()).collect(), + ctx: ast::ExprContext::Load, + parenthesized: true, + }))) + } + Some(TypeVarRestriction::AnyStr) => { + Some(Box::new(Expr::Tuple(ast::ExprTuple { + range: TextRange::default(), + elts: vec![ + Expr::Name(ExprName { + range: TextRange::default(), + id: Name::from("str"), + ctx: ast::ExprContext::Load, + }), + Expr::Name(ExprName { + range: TextRange::default(), + id: Name::from("bytes"), + ctx: ast::ExprContext::Load, + }), + ], + ctx: ast::ExprContext::Load, + parenthesized: true, + }))) + } + None => None, + }, + // We don't handle defaults here yet. Should perhaps be a different rule since + // defaults are only valid in 3.13+. + default: None, + }) + } + TypeParamKind::TypeVarTuple => TypeParam::TypeVarTuple(TypeParamTypeVarTuple { + range: TextRange::default(), + name: Identifier::new(*name, TextRange::default()), + default: None, + }), + TypeParamKind::ParamSpec => TypeParam::ParamSpec(TypeParamParamSpec { + range: TextRange::default(), + name: Identifier::new(*name, TextRange::default()), + default: None, + }), + } + } +} + +impl<'a> From<&'a TypeParam> for TypeVar<'a> { + fn from(param: &'a TypeParam) -> Self { + let (kind, restriction) = match param { + TypeParam::TypeVarTuple(_) => (TypeParamKind::TypeVarTuple, None), + TypeParam::ParamSpec(_) => (TypeParamKind::ParamSpec, None), + + TypeParam::TypeVar(param) => { + let restriction = match param.bound.as_deref() { + None => None, + Some(Expr::Tuple(constraints)) => Some(TypeVarRestriction::Constraint( + constraints.elts.iter().collect::<Vec<_>>(), + )), + Some(bound) => Some(TypeVarRestriction::Bound(bound)), + }; + + (TypeParamKind::TypeVar, restriction) + } + }; + + Self { + name: param.name(), + kind, + restriction, + default: param.default(), + } + } +} + +struct TypeVarReferenceVisitor<'a> { + vars: Vec<TypeVar<'a>>, + semantic: &'a SemanticModel<'a>, + /// Tracks whether any non-TypeVars have been seen to avoid replacing generic parameters when an + /// unknown `TypeVar` is encountered. + any_skipped: bool, +} + +/// Recursively collects the names of type variable references present in an expression. +impl<'a> Visitor<'a> for TypeVarReferenceVisitor<'a> { + fn visit_expr(&mut self, expr: &'a Expr) { + // special case for typing.AnyStr, which is a commonly-imported type variable in the + // standard library with the definition: + // + // ```python + // AnyStr = TypeVar('AnyStr', bytes, str) + // ``` + // + // As of 01/2025, this line hasn't been modified in 8 years, so hopefully there won't be + // much to keep updated here. See + // https://github.com/python/cpython/blob/383af395af828f40d9543ee0a8fdc5cc011d43db/Lib/typing.py#L2806 + // + // to replace AnyStr with an annotation like [AnyStr: (bytes, str)], we also have to make + // sure that `bytes` and `str` have their builtin values and have not been shadowed + if self.semantic.match_typing_expr(expr, "AnyStr") + && self.semantic.has_builtin_binding("bytes") + && self.semantic.has_builtin_binding("str") + { + self.vars.push(TypeVar { + name: "AnyStr", + restriction: Some(TypeVarRestriction::AnyStr), + kind: TypeParamKind::TypeVar, + default: None, + }); + return; + } + + match expr { + Expr::Name(name) if name.ctx.is_load() => { + if let Some(var) = expr_name_to_type_var(self.semantic, name) { + self.vars.push(var); + } else { + self.any_skipped = true; + } + } + _ => visitor::walk_expr(self, expr), + } + } +} + +pub(crate) fn expr_name_to_type_var<'a>( + semantic: &'a SemanticModel, + name: &'a ExprName, +) -> Option<TypeVar<'a>> { + let StmtAssign { value, .. } = semantic + .lookup_symbol(name.id.as_str()) + .and_then(|binding_id| semantic.binding(binding_id).source) + .map(|node_id| semantic.statement(node_id))? + .as_assign_stmt()?; + + match value.as_ref() { + Expr::Subscript(ExprSubscript { + value: subscript_value, + .. + }) => { + if semantic.match_typing_expr(subscript_value, "TypeVar") { + return Some(TypeVar { + name: &name.id, + restriction: None, + kind: TypeParamKind::TypeVar, + default: None, + }); + } + } + Expr::Call(ExprCall { + func, arguments, .. + }) => { + let kind = if semantic.match_typing_expr(func, "TypeVar") { + TypeParamKind::TypeVar + } else if semantic.match_typing_expr(func, "TypeVarTuple") { + TypeParamKind::TypeVarTuple + } else if semantic.match_typing_expr(func, "ParamSpec") { + TypeParamKind::ParamSpec + } else { + return None; + }; + + if arguments + .args + .first() + .is_some_and(Expr::is_string_literal_expr) + { + // TODO(brent) `default` was added in PEP 696 and Python 3.13 but can't be used in + // generic type parameters before that + // + // ```python + // T = TypeVar("T", default=Any, bound=str) + // class slice(Generic[T]): ... + // ``` + // + // becomes + // + // ```python + // class slice[T: str = Any]: ... + // ``` + let default = arguments + .find_keyword("default") + .map(|default| &default.value); + let restriction = if let Some(bound) = arguments.find_keyword("bound") { + Some(TypeVarRestriction::Bound(&bound.value)) + } else if arguments.args.len() > 1 { + Some(TypeVarRestriction::Constraint( + arguments.args.iter().skip(1).collect(), + )) + } else { + None + }; + + return Some(TypeVar { + name: &name.id, + restriction, + kind, + default, + }); + } + } + _ => {} + } + None +} + +/// Check if the current statement is nested within another [`StmtClassDef`] or [`StmtFunctionDef`]. +fn in_nested_context(checker: &Checker) -> bool { + checker + .semantic() + .current_statements() + .skip(1) // skip the immediate parent, we only call this within a class or function + .any(|stmt| matches!(stmt, Stmt::ClassDef(_) | Stmt::FunctionDef(_))) +} + +/// Deduplicate `vars`, returning `None` if `vars` is empty or any duplicates are found. +fn check_type_vars(vars: Vec<TypeVar<'_>>) -> Option<Vec<TypeVar<'_>>> { + if vars.is_empty() { + return None; + } + + // If any type variables were not unique, just bail out here. this is a runtime error and we + // can't predict what the user wanted. also bail out if any Python 3.13+ default values are + // found on the type parameters + (vars + .iter() + .unique_by(|tvar| tvar.name) + .filter(|tvar| tvar.default.is_none()) + .count() + == vars.len()) + .then_some(vars) +} + +/// Search `class_bases` for a `typing.Generic` base class. Returns the `Generic` expression (if +/// any), along with its index in the class's bases tuple. +pub(crate) fn find_generic<'a>( + class_bases: &'a Arguments, + semantic: &SemanticModel, +) -> Option<(usize, &'a ExprSubscript)> { + class_bases.args.iter().enumerate().find_map(|(idx, expr)| { + expr.as_subscript_expr().and_then(|sub_expr| { + semantic + .match_typing_expr(&sub_expr.value, "Generic") + .then_some((idx, sub_expr)) + }) + }) +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_class.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_class.rs new file mode 100644 index 0000000000000..ae8b83e6981ce --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_class.rs @@ -0,0 +1,214 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::visitor::Visitor; +use ruff_python_ast::{ExprSubscript, StmtClassDef}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; +use ruff_python_ast::PythonVersion; + +use super::{ + DisplayTypeVars, TypeVarReferenceVisitor, check_type_vars, find_generic, in_nested_context, +}; + +/// ## What it does +/// +/// Checks for use of standalone type variables and parameter specifications in generic classes. +/// +/// ## Why is this bad? +/// +/// Special type parameter syntax was introduced in Python 3.12 by [PEP 695] for defining generic +/// classes. This syntax is easier to read and provides cleaner support for generics. +/// +/// ## Known problems +/// +/// The rule currently skips generic classes nested inside of other functions or classes. It also +/// skips type parameters with the `default` argument introduced in [PEP 696] and implemented in +/// Python 3.13. +/// +/// This rule can only offer a fix if all of the generic types in the class definition are defined +/// in the current module. For external type parameters, a diagnostic is emitted without a suggested +/// fix. +/// +/// Not all type checkers fully support PEP 695 yet, so even valid fixes suggested by this rule may +/// cause type checking to fail. +/// +/// ## Fix safety +/// +/// This fix is marked as unsafe, as [PEP 695] uses inferred variance for type parameters, instead +/// of the `covariant` and `contravariant` keywords used by `TypeVar` variables. As such, replacing +/// a `TypeVar` variable with an inline type parameter may change its variance. +/// +/// ## Example +/// +/// ```python +/// from typing import TypeVar +/// +/// T = TypeVar("T") +/// +/// +/// class GenericClass(Generic[T]): +/// var: T +/// ``` +/// +/// Use instead: +/// +/// ```python +/// class GenericClass[T]: +/// var: T +/// ``` +/// +/// ## See also +/// +/// This rule replaces standalone type variables in classes but doesn't remove +/// the corresponding type variables even if they are unused after the fix. See +/// [`unused-private-type-var`][PYI018] for a rule to clean up unused +/// private type variables. +/// +/// This rule will not rename private type variables to remove leading underscores, even though the +/// new type parameters are restricted in scope to their associated class. See +/// [`private-type-parameter`][UP049] for a rule to update these names. +/// +/// This rule will correctly handle classes with multiple base classes, as long as the single +/// `Generic` base class is at the end of the argument list, as checked by +/// [`generic-not-last-base-class`][PYI059]. If a `Generic` base class is +/// found outside of the last position, a diagnostic is emitted without a suggested fix. +/// +/// This rule only applies to generic classes and does not include generic functions. See +/// [`non-pep695-generic-function`][UP047] for the function version. +/// +/// [PEP 695]: https://peps.python.org/pep-0695/ +/// [PEP 696]: https://peps.python.org/pep-0696/ +/// [PYI018]: https://docs.astral.sh/ruff/rules/unused-private-type-var/ +/// [PYI059]: https://docs.astral.sh/ruff/rules/generic-not-last-base-class/ +/// [UP047]: https://docs.astral.sh/ruff/rules/non-pep695-generic-function/ +/// [UP049]: https://docs.astral.sh/ruff/rules/private-type-parameter/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP695GenericClass { + name: String, +} + +impl Violation for NonPEP695GenericClass { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + let NonPEP695GenericClass { name } = self; + format!("Generic class `{name}` uses `Generic` subclass instead of type parameters") + } + + fn fix_title(&self) -> Option<String> { + Some("Use type parameters".to_string()) + } +} + +/// UP046 +pub(crate) fn non_pep695_generic_class(checker: &Checker, class_def: &StmtClassDef) { + // PEP-695 syntax is only available on Python 3.12+ + if checker.target_version() < PythonVersion::PY312 { + return; + } + + // don't try to handle generic classes inside other functions or classes + if in_nested_context(checker) { + return; + } + + let StmtClassDef { + name, + type_params, + arguments, + .. + } = class_def; + + // it's a runtime error to mix type_params and Generic, so bail out early if we see existing + // type_params + if type_params.is_some() { + return; + } + + let Some(arguments) = arguments.as_ref() else { + return; + }; + + let Some((generic_idx, generic_expr @ ExprSubscript { slice, range, .. })) = + find_generic(arguments, checker.semantic()) + else { + return; + }; + + let mut diagnostic = Diagnostic::new( + NonPEP695GenericClass { + name: name.to_string(), + }, + *range, + ); + + // only handle the case where Generic is at the end of the argument list, in line with PYI059 + // (generic-not-last-base-class). If it comes elsewhere, it results in a runtime error. In stubs + // it's not *strictly* necessary for `Generic` to come last in the bases tuple, but it would + // cause more complication for us to handle stubs specially, and probably isn't worth the + // bother. we still offer a diagnostic here but not a fix + // + // because `find_generic` also finds the *first* Generic argument, this has the additional + // benefit of bailing out with a diagnostic if multiple Generic arguments are present + if generic_idx != arguments.len() - 1 { + checker.report_diagnostic(diagnostic); + return; + } + + let mut visitor = TypeVarReferenceVisitor { + vars: vec![], + semantic: checker.semantic(), + any_skipped: false, + }; + visitor.visit_expr(slice); + + // if any of the parameters have been skipped, this indicates that we could not resolve the type + // to a `TypeVar`, `TypeVarTuple`, or `ParamSpec`, and thus our fix would remove it from the + // signature incorrectly. We can still offer the diagnostic created above without a Fix. For + // example, + // + // ```python + // from somewhere import SomethingElse + // + // T = TypeVar("T") + // + // class Class(Generic[T, SomethingElse]): ... + // ``` + // + // should not be converted to + // + // ```python + // class Class[T]: ... + // ``` + // + // just because we can't confirm that `SomethingElse` is a `TypeVar` + if !visitor.any_skipped { + let Some(type_vars) = check_type_vars(visitor.vars) else { + return; + }; + + // build the fix as a String to avoid removing comments from the entire function body + let type_params = DisplayTypeVars { + type_vars: &type_vars, + source: checker.source(), + }; + + diagnostic.try_set_fix(|| { + let removal_edit = remove_argument( + generic_expr, + arguments, + Parentheses::Remove, + checker.source(), + )?; + Ok(Fix::unsafe_edits( + Edit::insertion(type_params.to_string(), name.end()), + [removal_edit], + )) + }); + } + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_function.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_function.rs new file mode 100644 index 0000000000000..e75cea226d39f --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_generic_function.rs @@ -0,0 +1,178 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::StmtFunctionDef; +use ruff_python_ast::visitor::Visitor; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; +use ruff_python_ast::PythonVersion; + +use super::{DisplayTypeVars, TypeVarReferenceVisitor, check_type_vars, in_nested_context}; + +/// ## What it does +/// +/// Checks for use of standalone type variables and parameter specifications in generic functions. +/// +/// ## Why is this bad? +/// +/// Special type parameter syntax was introduced in Python 3.12 by [PEP 695] for defining generic +/// functions. This syntax is easier to read and provides cleaner support for generics. +/// +/// ## Known problems +/// +/// The rule currently skips generic functions nested inside of other functions or classes and those +/// with type parameters containing the `default` argument introduced in [PEP 696] and implemented +/// in Python 3.13. +/// +/// Not all type checkers fully support PEP 695 yet, so even valid fixes suggested by this rule may +/// cause type checking to fail. +/// +/// ## Fix safety +/// +/// This fix is marked unsafe, as [PEP 695] uses inferred variance for type parameters, instead of +/// the `covariant` and `contravariant` keywords used by `TypeVar` variables. As such, replacing a +/// `TypeVar` variable with an inline type parameter may change its variance. +/// +/// Additionally, if the rule cannot determine whether a parameter annotation corresponds to a type +/// variable (e.g. for a type imported from another module), it will not add the type to the generic +/// type parameter list. This causes the function to have a mix of old-style type variables and +/// new-style generic type parameters, which will be rejected by type checkers. +/// +/// ## Example +/// +/// ```python +/// from typing import TypeVar +/// +/// T = TypeVar("T") +/// +/// +/// def generic_function(var: T) -> T: +/// return var +/// ``` +/// +/// Use instead: +/// +/// ```python +/// def generic_function[T](var: T) -> T: +/// return var +/// ``` +/// +/// ## See also +/// +/// This rule replaces standalone type variables in function signatures but doesn't remove +/// the corresponding type variables even if they are unused after the fix. See +/// [`unused-private-type-var`][PYI018] for a rule to clean up unused +/// private type variables. +/// +/// This rule will not rename private type variables to remove leading underscores, even though the +/// new type parameters are restricted in scope to their associated function. See +/// [`private-type-parameter`][UP049] for a rule to update these names. +/// +/// This rule only applies to generic functions and does not include generic classes. See +/// [`non-pep695-generic-class`][UP046] for the class version. +/// +/// [PEP 695]: https://peps.python.org/pep-0695/ +/// [PEP 696]: https://peps.python.org/pep-0696/ +/// [PYI018]: https://docs.astral.sh/ruff/rules/unused-private-type-var/ +/// [UP046]: https://docs.astral.sh/ruff/rules/non-pep695-generic-class/ +/// [UP049]: https://docs.astral.sh/ruff/rules/private-type-parameter/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP695GenericFunction { + name: String, +} + +impl Violation for NonPEP695GenericFunction { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; + + #[derive_message_formats] + fn message(&self) -> String { + let NonPEP695GenericFunction { name } = self; + format!("Generic function `{name}` should use type parameters") + } + + fn fix_title(&self) -> Option<String> { + Some("Use type parameters".to_string()) + } +} + +/// UP047 +pub(crate) fn non_pep695_generic_function(checker: &Checker, function_def: &StmtFunctionDef) { + // PEP-695 syntax is only available on Python 3.12+ + if checker.target_version() < PythonVersion::PY312 { + return; + } + + // don't try to handle generic functions inside other functions or classes + if in_nested_context(checker) { + return; + } + + let StmtFunctionDef { + name, + type_params, + parameters, + .. + } = function_def; + + // TODO(brent) handle methods, for now return early in a class body. For example, an additional + // generic parameter on the method needs to be handled separately from one already on the class + // + // ```python + // T = TypeVar("T") + // S = TypeVar("S") + // + // class Foo(Generic[T]): + // def bar(self, x: T, y: S) -> S: ... + // + // + // class Foo[T]: + // def bar[S](self, x: T, y: S) -> S: ... + // ``` + if checker.semantic().current_scope().kind.is_class() { + return; + } + + // invalid to mix old-style and new-style generics + if type_params.is_some() { + return; + } + + let mut type_vars = Vec::new(); + for parameter in parameters { + if let Some(annotation) = parameter.annotation() { + let vars = { + let mut visitor = TypeVarReferenceVisitor { + vars: vec![], + semantic: checker.semantic(), + any_skipped: false, + }; + visitor.visit_expr(annotation); + visitor.vars + }; + type_vars.extend(vars); + } + } + + let Some(type_vars) = check_type_vars(type_vars) else { + return; + }; + + // build the fix as a String to avoid removing comments from the entire function body + let type_params = DisplayTypeVars { + type_vars: &type_vars, + source: checker.source(), + }; + + checker.report_diagnostic( + Diagnostic::new( + NonPEP695GenericFunction { + name: name.to_string(), + }, + TextRange::new(name.start(), parameters.end()), + ) + .with_fix(Fix::unsafe_edit(Edit::insertion( + type_params.to_string(), + name.end(), + ))), + ); +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_type_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_type_alias.rs new file mode 100644 index 0000000000000..9ebe7c326c118 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_type_alias.rs @@ -0,0 +1,298 @@ +use itertools::Itertools; + +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::name::Name; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_ast::visitor::Visitor; +use ruff_python_ast::{Expr, ExprCall, ExprName, Keyword, StmtAnnAssign, StmtAssign, StmtRef}; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; +use ruff_python_ast::PythonVersion; + +use super::{ + DisplayTypeVars, TypeParamKind, TypeVar, TypeVarReferenceVisitor, expr_name_to_type_var, +}; + +/// ## What it does +/// Checks for use of `TypeAlias` annotations and `TypeAliasType` assignments +/// for declaring type aliases. +/// +/// ## Why is this bad? +/// The `type` keyword was introduced in Python 3.12 by [PEP 695] for defining +/// type aliases. The `type` keyword is easier to read and provides cleaner +/// support for generics. +/// +/// ## Known problems +/// [PEP 695] uses inferred variance for type parameters, instead of the +/// `covariant` and `contravariant` keywords used by `TypeVar` variables. As +/// such, rewriting a type alias using a PEP-695 `type` statement may change +/// the variance of the alias's type parameters. +/// +/// Unlike type aliases that use simple assignments, definitions created using +/// [PEP 695] `type` statements cannot be used as drop-in replacements at +/// runtime for the value on the right-hand side of the statement. This means +/// that while for some simple old-style type aliases you can use them as the +/// second argument to an `isinstance()` call (for example), doing the same +/// with a [PEP 695] `type` statement will always raise `TypeError` at +/// runtime. +/// +/// ## Example +/// ```python +/// ListOfInt: TypeAlias = list[int] +/// PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) +/// ``` +/// +/// Use instead: +/// ```python +/// type ListOfInt = list[int] +/// type PositiveInt = Annotated[int, Gt(0)] +/// ``` +/// +/// ## Fix safety +/// +/// This fix is marked unsafe for `TypeAlias` assignments outside of stub files because of the +/// runtime behavior around `isinstance()` calls noted above. The fix is also unsafe for +/// `TypeAliasType` assignments if there are any comments in the replacement range that would be +/// deleted. +/// +/// ## See also +/// +/// This rule only applies to `TypeAlias`es and `TypeAliasType`s. See +/// [`non-pep695-generic-class`][UP046] and [`non-pep695-generic-function`][UP047] for similar +/// transformations for generic classes and functions. +/// +/// This rule replaces standalone type variables in aliases but doesn't remove the corresponding +/// type variables even if they are unused after the fix. See [`unused-private-type-var`][PYI018] +/// for a rule to clean up unused private type variables. +/// +/// This rule will not rename private type variables to remove leading underscores, even though the +/// new type parameters are restricted in scope to their associated aliases. See +/// [`private-type-parameter`][UP049] for a rule to update these names. +/// +/// [PEP 695]: https://peps.python.org/pep-0695/ +/// [PYI018]: https://docs.astral.sh/ruff/rules/unused-private-type-var/ +/// [UP046]: https://docs.astral.sh/ruff/rules/non-pep695-generic-class/ +/// [UP047]: https://docs.astral.sh/ruff/rules/non-pep695-generic-function/ +/// [UP049]: https://docs.astral.sh/ruff/rules/private-type-parameter/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP695TypeAlias { + name: String, + type_alias_kind: TypeAliasKind, +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum TypeAliasKind { + TypeAlias, + TypeAliasType, +} + +impl Violation for NonPEP695TypeAlias { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; + + #[derive_message_formats] + fn message(&self) -> String { + let NonPEP695TypeAlias { + name, + type_alias_kind, + } = self; + let type_alias_method = match type_alias_kind { + TypeAliasKind::TypeAlias => "`TypeAlias` annotation", + TypeAliasKind::TypeAliasType => "`TypeAliasType` assignment", + }; + format!("Type alias `{name}` uses {type_alias_method} instead of the `type` keyword") + } + + fn fix_title(&self) -> Option<String> { + Some("Use the `type` keyword".to_string()) + } +} + +/// UP040 +pub(crate) fn non_pep695_type_alias_type(checker: &Checker, stmt: &StmtAssign) { + if checker.target_version() < PythonVersion::PY312 { + return; + } + + let StmtAssign { targets, value, .. } = stmt; + + let Expr::Call(ExprCall { + func, arguments, .. + }) = value.as_ref() + else { + return; + }; + + let [Expr::Name(target_name)] = targets.as_slice() else { + return; + }; + + let [Expr::StringLiteral(name), value] = arguments.args.as_ref() else { + return; + }; + + if &name.value != target_name.id.as_str() { + return; + } + + let type_params = match arguments.keywords.as_ref() { + [] => &[], + [ + Keyword { + arg: Some(name), + value: Expr::Tuple(type_params), + .. + }, + ] if name.as_str() == "type_params" => type_params.elts.as_slice(), + _ => return, + }; + + if !checker + .semantic() + .match_typing_expr(func.as_ref(), "TypeAliasType") + { + return; + } + + let Some(vars) = type_params + .iter() + .map(|expr| { + expr.as_name_expr().map(|name| { + expr_name_to_type_var(checker.semantic(), name).unwrap_or(TypeVar { + name: &name.id, + restriction: None, + kind: TypeParamKind::TypeVar, + default: None, + }) + }) + }) + .collect::<Option<Vec<_>>>() + else { + return; + }; + + checker.report_diagnostic(create_diagnostic( + checker, + stmt.into(), + &target_name.id, + value, + &vars, + TypeAliasKind::TypeAliasType, + )); +} + +/// UP040 +pub(crate) fn non_pep695_type_alias(checker: &Checker, stmt: &StmtAnnAssign) { + if checker.target_version() < PythonVersion::PY312 { + return; + } + + let StmtAnnAssign { + target, + annotation, + value, + .. + } = stmt; + + if !checker + .semantic() + .match_typing_expr(annotation, "TypeAlias") + { + return; + } + + let Expr::Name(ExprName { id: name, .. }) = target.as_ref() else { + return; + }; + + let Some(value) = value else { + return; + }; + + let vars = { + let mut visitor = TypeVarReferenceVisitor { + vars: vec![], + semantic: checker.semantic(), + any_skipped: false, + }; + visitor.visit_expr(value); + visitor.vars + }; + + // Type variables must be unique; filter while preserving order. + let vars = vars + .into_iter() + .unique_by(|tvar| tvar.name) + .collect::<Vec<_>>(); + + // TODO(brent) handle `default` arg for Python 3.13+ + if vars.iter().any(|tv| tv.default.is_some()) { + return; + } + + checker.report_diagnostic(create_diagnostic( + checker, + stmt.into(), + name, + value, + &vars, + TypeAliasKind::TypeAlias, + )); +} + +/// Generate a [`Diagnostic`] for a non-PEP 695 type alias or type alias type. +fn create_diagnostic( + checker: &Checker, + stmt: StmtRef, + name: &Name, + value: &Expr, + type_vars: &[TypeVar], + type_alias_kind: TypeAliasKind, +) -> Diagnostic { + let source = checker.source(); + let comment_ranges = checker.comment_ranges(); + + let range_with_parentheses = + parenthesized_range(value.into(), stmt.into(), comment_ranges, source) + .unwrap_or(value.range()); + + let content = format!( + "type {name}{type_params} = {value}", + type_params = DisplayTypeVars { type_vars, source }, + value = &source[range_with_parentheses] + ); + let edit = Edit::range_replacement(content, stmt.range()); + + let applicability = + if type_alias_kind == TypeAliasKind::TypeAlias && !checker.source_type.is_stub() { + // The fix is always unsafe in non-stubs + // because new-style aliases have different runtime behavior. + // See https://github.com/astral-sh/ruff/issues/6434 + Applicability::Unsafe + } else { + // In stub files, or in non-stub files for `TypeAliasType` assignments, + // the fix is only unsafe if it would delete comments. + // + // it would be easier to check for comments in the whole `stmt.range`, but because + // `create_diagnostic` uses the full source text of `value`, comments within `value` are + // actually preserved. thus, we have to check for comments in `stmt` but outside of `value` + let pre_value = TextRange::new(stmt.start(), range_with_parentheses.start()); + let post_value = TextRange::new(range_with_parentheses.end(), stmt.end()); + + if comment_ranges.intersects(pre_value) || comment_ranges.intersects(post_value) { + Applicability::Unsafe + } else { + Applicability::Safe + } + }; + + Diagnostic::new( + NonPEP695TypeAlias { + name: name.to_string(), + type_alias_kind, + }, + stmt.range(), + ) + .with_fix(Fix::applicable_edit(edit, applicability)) +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/private_type_parameter.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/private_type_parameter.rs new file mode 100644 index 0000000000000..0a5635c68d2ac --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/pep695/private_type_parameter.rs @@ -0,0 +1,168 @@ +use ruff_diagnostics::{Applicability, Diagnostic, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Stmt; +use ruff_python_semantic::Binding; +use ruff_python_stdlib::identifiers::is_identifier; +use ruff_text_size::Ranged; + +use crate::{ + checkers::ast::Checker, + renamer::{Renamer, ShadowedKind}, +}; + +/// ## What it does +/// +/// Checks for use of [PEP 695] type parameters with leading underscores in generic classes and +/// functions. +/// +/// ## Why is this bad? +/// +/// [PEP 695] type parameters are already restricted in scope to the class or function in which they +/// appear, so leading underscores just hurt readability without the usual privacy benefits. +/// +/// However, neither a diagnostic nor a fix will be emitted for "sunder" (`_T_`) or "dunder" +/// (`__T__`) type parameter names as these are not considered private. +/// +/// ## Example +/// +/// ```python +/// class GenericClass[_T]: +/// var: _T +/// +/// +/// def generic_function[_T](var: _T) -> list[_T]: +/// return var[0] +/// ``` +/// +/// Use instead: +/// +/// ```python +/// class GenericClass[T]: +/// var: T +/// +/// +/// def generic_function[T](var: T) -> list[T]: +/// return var[0] +/// ``` +/// +/// ## Fix availability +/// +/// If the name without an underscore would shadow a builtin or another variable, would be a +/// keyword, or would otherwise be an invalid identifier, a fix will not be available. In these +/// situations, you can consider using a trailing underscore or a different name entirely to satisfy +/// the lint rule. +/// +/// ## See also +/// +/// This rule renames private [PEP 695] type parameters but doesn't convert pre-[PEP 695] generics +/// to the new format. See [`non-pep695-generic-function`][UP047] and +/// [`non-pep695-generic-class`][UP046] for rules that will make this transformation. +/// Those rules do not remove unused type variables after their changes, +/// so you may also want to consider enabling [`unused-private-type-var`][PYI018] to complete +/// the transition to [PEP 695] generics. +/// +/// [PEP 695]: https://peps.python.org/pep-0695/ +/// [UP047]: https://docs.astral.sh/ruff/rules/non-pep695-generic-function +/// [UP046]: https://docs.astral.sh/ruff/rules/non-pep695-generic-class +/// [PYI018]: https://docs.astral.sh/ruff/rules/unused-private-type-var +#[derive(ViolationMetadata)] +pub(crate) struct PrivateTypeParameter { + kind: ParamKind, +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum ParamKind { + Class, + Function, +} + +impl ParamKind { + const fn as_str(self) -> &'static str { + match self { + ParamKind::Class => "class", + ParamKind::Function => "function", + } + } +} + +impl Violation for PrivateTypeParameter { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] + fn message(&self) -> String { + format!( + "Generic {} uses private type parameters", + self.kind.as_str() + ) + } + + fn fix_title(&self) -> Option<String> { + Some("Rename type parameter to remove leading underscores".to_string()) + } +} + +/// UP049 +pub(crate) fn private_type_parameter(checker: &Checker, binding: &Binding) -> Option<Diagnostic> { + let semantic = checker.semantic(); + let stmt = binding.statement(semantic)?; + if !binding.kind.is_type_param() { + return None; + } + + let kind = match stmt { + Stmt::FunctionDef(_) => ParamKind::Function, + Stmt::ClassDef(_) => ParamKind::Class, + _ => return None, + }; + + let old_name = binding.name(checker.source()); + + if !old_name.starts_with('_') { + return None; + } + + // Sunder `_T_`, dunder `__T__`, and all all-under `_` or `__` cases should all be skipped, as + // these are not "private" names + if old_name.ends_with('_') { + return None; + } + + let mut diagnostic = Diagnostic::new(PrivateTypeParameter { kind }, binding.range); + + let new_name = old_name.trim_start_matches('_'); + + // if the new name would shadow another variable, keyword, or builtin, emit a diagnostic without + // a suggested fix + if ShadowedKind::new(binding, new_name, checker).shadows_any() { + return Some(diagnostic); + } + + if !is_identifier(new_name) { + return Some(diagnostic); + } + + let source = checker.source(); + + diagnostic.try_set_fix(|| { + let (first, rest) = Renamer::rename( + old_name, + new_name, + &semantic.scopes[binding.scope], + semantic, + checker.stylist(), + )?; + + let applicability = if binding + .references() + .any(|id| &source[semantic.reference(id).range()] != old_name) + { + Applicability::DisplayOnly + } else { + Applicability::Safe + }; + + let fix_isolation = Checker::isolation(binding.source); + Ok(Fix::applicable_edits(first, rest, applicability).isolate(fix_isolation)) + }); + + Some(diagnostic) +} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/printf_string_formatting.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/printf_string_formatting.rs index 9dc930cc1b9d6..6f4d3a91b6270 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/printf_string_formatting.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/printf_string_formatting.rs @@ -1,9 +1,10 @@ use std::borrow::Cow; +use std::fmt::Write; use std::str::FromStr; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, whitespace::indentation, AnyStringFlags, Expr, StringFlags}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, AnyStringFlags, Expr, StringFlags, whitespace::indentation}; use ruff_python_codegen::Stylist; use ruff_python_literal::cformat::{ CConversionFlags, CFormatPart, CFormatPrecision, CFormatQuantity, CFormatString, @@ -13,9 +14,9 @@ use ruff_python_stdlib::identifiers::is_identifier; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::pyupgrade::helpers::curly_escape; -use crate::Locator; /// ## What it does /// Checks for `printf`-style string formatting, and offers to replace it with @@ -73,15 +74,15 @@ use crate::Locator; /// ## References /// - [Python documentation: `printf`-style String Formatting](https://docs.python.org/3/library/stdtypes.html#old-string-formatting) /// - [Python documentation: `str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) -#[violation] -pub struct PrintfStringFormatting; +#[derive(ViolationMetadata)] +pub(crate) struct PrintfStringFormatting; impl Violation for PrintfStringFormatting { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use format specifiers instead of percent format") + "Use format specifiers instead of percent format".to_string() } fn fix_title(&self) -> Option<String> { @@ -302,7 +303,7 @@ fn clean_params_dictionary(right: &Expr, locator: &Locator, stylist: &Stylist) - /// [`Expr`] can be converted. fn convertible(format_string: &CFormatString, params: &Expr) -> bool { for (.., format_part) in format_string.iter() { - let CFormatPart::Spec(ref fmt) = format_part else { + let CFormatPart::Spec(fmt) = format_part else { continue; }; @@ -361,7 +362,7 @@ fn convertible(format_string: &CFormatString, params: &Expr) -> bool { /// UP031 pub(crate) fn printf_string_formatting( - checker: &mut Checker, + checker: &Checker, bin_op: &ast::ExprBinOp, string_expr: &ast::ExprStringLiteral, ) { @@ -384,17 +385,13 @@ pub(crate) fn printf_string_formatting( return; }; if !convertible(&format_string, right) { - if checker.settings.preview.is_enabled() { - checker - .diagnostics - .push(Diagnostic::new(PrintfStringFormatting, string_expr.range())); - } + checker.report_diagnostic(Diagnostic::new(PrintfStringFormatting, string_expr.range())); return; } // Count the number of positional and keyword arguments. for (.., format_part) in format_string.iter() { - let CFormatPart::Spec(ref fmt) = format_part else { + let CFormatPart::Spec(fmt) = format_part else { continue; }; if fmt.mapping_key.is_none() { @@ -407,7 +404,9 @@ pub(crate) fn printf_string_formatting( // Convert the `%`-format string to a `.format` string. format_strings.push(( string_literal.range(), - flags.format_string_contents(&percent_to_format(&format_string)), + flags + .display_contents(&percent_to_format(&format_string)) + .to_string(), )); } @@ -447,11 +446,10 @@ pub(crate) fn printf_string_formatting( let Some(params_string) = clean_params_dictionary(right, checker.locator(), checker.stylist()) else { - if checker.settings.preview.is_enabled() { - checker - .diagnostics - .push(Diagnostic::new(PrintfStringFormatting, string_expr.range())); - } + checker.report_diagnostic(Diagnostic::new( + PrintfStringFormatting, + string_expr.range(), + )); return; }; Cow::Owned(params_string) @@ -504,14 +502,14 @@ pub(crate) fn printf_string_formatting( } // Add the `.format` call. - contents.push_str(&format!(".format{params_string}")); + let _ = write!(&mut contents, ".format{params_string}"); let mut diagnostic = Diagnostic::new(PrintfStringFormatting, bin_op.range()); diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( contents, bin_op.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[cfg(test)] diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/quoted_annotation.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/quoted_annotation.rs index a738b67286c5c..c5dcd45264cc1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/quoted_annotation.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/quoted_annotation.rs @@ -1,9 +1,12 @@ -use ruff_text_size::TextRange; - -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_python_parser::TokenKind; +use ruff_text_size::{TextLen, TextRange, TextSize}; use crate::checkers::ast::Checker; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Stmt; +use ruff_python_semantic::SemanticModel; +use ruff_source_file::LineRanges; /// ## What it does /// Checks for the presence of unnecessary quotes in type annotations. @@ -54,16 +57,25 @@ use crate::checkers::ast::Checker; /// bar: Bar /// ``` /// +/// ## See also +/// - [`quoted-annotation-in-stub`][PYI020]: A rule that +/// removes all quoted annotations from stub files +/// - [`quoted-type-alias`][TC008]: A rule that removes unnecessary quotes +/// from type aliases. +/// /// ## References -/// - [PEP 563](https://peps.python.org/pep-0563/) +/// - [PEP 563 – Postponed Evaluation of Annotations](https://peps.python.org/pep-0563/) /// - [Python documentation: `__future__`](https://docs.python.org/3/library/__future__.html#module-__future__) -#[violation] -pub struct QuotedAnnotation; +/// +/// [PYI020]: https://docs.astral.sh/ruff/rules/quoted-annotation-in-stub/ +/// [TC008]: https://docs.astral.sh/ruff/rules/quoted-type-alias/ +#[derive(ViolationMetadata)] +pub(crate) struct QuotedAnnotation; impl AlwaysFixableViolation for QuotedAnnotation { #[derive_message_formats] fn message(&self) -> String { - format!("Remove quotes from type annotation") + "Remove quotes from type annotation".to_string() } fn fix_title(&self) -> String { @@ -72,11 +84,37 @@ impl AlwaysFixableViolation for QuotedAnnotation { } /// UP037 -pub(crate) fn quoted_annotation(checker: &mut Checker, annotation: &str, range: TextRange) { - let mut diagnostic = Diagnostic::new(QuotedAnnotation, range); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - annotation.to_string(), - range, - ))); - checker.diagnostics.push(diagnostic); +pub(crate) fn quoted_annotation(checker: &Checker, annotation: &str, range: TextRange) { + let diagnostic = Diagnostic::new(QuotedAnnotation, range); + + let placeholder_range = TextRange::up_to(annotation.text_len()); + let spans_multiple_lines = annotation.contains_line_break(placeholder_range); + + let last_token_is_comment = checker + .tokens() + // The actual last token will always be a logical newline, + // so we check the second to last + .get(checker.tokens().len().saturating_sub(2)) + .is_some_and(|tok| tok.kind() == TokenKind::Comment); + + let new_content = match (spans_multiple_lines, last_token_is_comment) { + (_, false) if in_parameter_annotation(range.start(), checker.semantic()) => { + annotation.to_string() + } + (false, false) => annotation.to_string(), + (true, false) => format!("({annotation})"), + (_, true) => format!("({annotation}\n)"), + }; + let edit = Edit::range_replacement(new_content, range); + let fix = Fix::safe_edit(edit); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +fn in_parameter_annotation(offset: TextSize, semantic: &SemanticModel) -> bool { + let Stmt::FunctionDef(stmt) = semantic.current_statement() else { + return false; + }; + + stmt.parameters.range.contains(offset) } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/redundant_open_modes.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/redundant_open_modes.rs index 3939d3e321a51..cdefd53e24bf3 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/redundant_open_modes.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/redundant_open_modes.rs @@ -1,20 +1,18 @@ -use std::str::FromStr; - -use anyhow::{anyhow, Result}; - +use anyhow::Result; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_parser::{TokenKind, Tokens}; +use ruff_python_stdlib::open_mode::OpenMode; use ruff_text_size::{Ranged, TextSize}; use crate::checkers::ast::Checker; /// ## What it does -/// Checks for redundant `open` mode parameters. +/// Checks for redundant `open` mode arguments. /// /// ## Why is this bad? -/// Redundant `open` mode parameters are unnecessary and should be removed to +/// Redundant `open` mode arguments are unnecessary and should be removed to /// avoid confusion. /// /// ## Example @@ -31,36 +29,34 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `open`](https://docs.python.org/3/library/functions.html#open) -#[violation] -pub struct RedundantOpenModes { - replacement: Option<String>, +#[derive(ViolationMetadata)] +pub(crate) struct RedundantOpenModes { + replacement: String, } impl AlwaysFixableViolation for RedundantOpenModes { #[derive_message_formats] fn message(&self) -> String { let RedundantOpenModes { replacement } = self; - match replacement { - None => format!("Unnecessary open mode parameters"), - Some(replacement) => { - format!("Unnecessary open mode parameters, use \"{replacement}\"") - } + if replacement.is_empty() { + "Unnecessary mode argument".to_string() + } else { + format!("Unnecessary modes, use `{replacement}`") } } fn fix_title(&self) -> String { let RedundantOpenModes { replacement } = self; - match replacement { - None => "Remove open mode parameters".to_string(), - Some(replacement) => { - format!("Replace with \"{replacement}\"") - } + if replacement.is_empty() { + "Remove mode argument".to_string() + } else { + format!("Replace with `{replacement}`") } } } /// UP015 -pub(crate) fn redundant_open_modes(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn redundant_open_modes(checker: &Checker, call: &ast::ExprCall) { if !checker .semantic() .resolve_qualified_name(&call.func) @@ -74,124 +70,63 @@ pub(crate) fn redundant_open_modes(checker: &mut Checker, call: &ast::ExprCall) return; } - match call.arguments.find_argument("mode", 1) { - None => { - if !call.arguments.is_empty() { - if let Some(keyword) = call.arguments.find_keyword("mode") { - if let Expr::StringLiteral(ast::ExprStringLiteral { - value: mode_param_value, - .. - }) = &keyword.value - { - if let Ok(mode) = OpenMode::from_str(mode_param_value.to_str()) { - checker.diagnostics.push(create_diagnostic( - call, - &keyword.value, - mode.replacement_value(), - checker.tokens(), - )); - } - } - } - } - } - Some(mode_param) => { - if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = &mode_param { - if let Ok(mode) = OpenMode::from_str(value.to_str()) { - checker.diagnostics.push(create_diagnostic( - call, - mode_param, - mode.replacement_value(), - checker.tokens(), - )); - } - } - } - } -} - -#[derive(Debug, Copy, Clone)] -enum OpenMode { - U, - Ur, - Ub, - RUb, - R, - Rt, - Wt, -} - -impl FromStr for OpenMode { - type Err = anyhow::Error; - - fn from_str(string: &str) -> Result<Self, Self::Err> { - match string { - "U" => Ok(Self::U), - "Ur" => Ok(Self::Ur), - "Ub" => Ok(Self::Ub), - "rUb" => Ok(Self::RUb), - "r" => Ok(Self::R), - "rt" => Ok(Self::Rt), - "wt" => Ok(Self::Wt), - _ => Err(anyhow!("Unknown open mode: {}", string)), - } - } -} - -impl OpenMode { - fn replacement_value(self) -> Option<&'static str> { - match self { - Self::U => None, - Self::Ur => None, - Self::Ub => Some("\"rb\""), - Self::RUb => Some("\"rb\""), - Self::R => None, - Self::Rt => None, - Self::Wt => Some("\"w\""), - } + let Some(mode_arg) = call.arguments.find_argument_value("mode", 1) else { + return; + }; + let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = &mode_arg else { + return; + }; + let Ok(mode) = OpenMode::from_chars(value.chars()) else { + return; + }; + let reduced = mode.reduce(); + if reduced != mode { + checker.report_diagnostic(create_diagnostic(call, mode_arg, reduced, checker)); } } fn create_diagnostic( call: &ast::ExprCall, - mode_param: &Expr, - replacement_value: Option<&str>, - tokens: &Tokens, + mode_arg: &Expr, + mode: OpenMode, + checker: &Checker, ) -> Diagnostic { let mut diagnostic = Diagnostic::new( RedundantOpenModes { - replacement: replacement_value.map(ToString::to_string), + replacement: mode.to_string(), }, - call.range(), + mode_arg.range(), ); - if let Some(content) = replacement_value { + if mode.is_empty() { + diagnostic.try_set_fix(|| { + create_remove_argument_fix(call, mode_arg, checker.tokens()).map(Fix::safe_edit) + }); + } else { + let stylist = checker.stylist(); diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - content.to_string(), - mode_param.range(), + format!("{}{mode}{}", stylist.quote(), stylist.quote()), + mode_arg.range(), ))); - } else { - diagnostic - .try_set_fix(|| create_remove_param_fix(call, mode_param, tokens).map(Fix::safe_edit)); } diagnostic } -fn create_remove_param_fix( +fn create_remove_argument_fix( call: &ast::ExprCall, - mode_param: &Expr, + mode_arg: &Expr, tokens: &Tokens, ) -> Result<Edit> { - // Find the last comma before mode_param and create a deletion fix - // starting from the comma and ending after mode_param. + // Find the last comma before mode_arg and create a deletion fix + // starting from the comma and ending after mode_arg. let mut fix_start: Option<TextSize> = None; let mut fix_end: Option<TextSize> = None; let mut is_first_arg: bool = false; let mut delete_first_arg: bool = false; for token in tokens.in_range(call.range()) { - if token.start() == mode_param.start() { + if token.start() == mode_arg.start() { if is_first_arg { delete_first_arg = true; continue; diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_stdout_stderr.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_stdout_stderr.rs index ec5ee0d2d5823..fea862a3b98f5 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_stdout_stderr.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_stdout_stderr.rs @@ -1,13 +1,13 @@ use anyhow::Result; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Keyword}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for uses of `subprocess.run` that send `stdout` and `stderr` to a @@ -33,18 +33,24 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// subprocess.run(["foo"], capture_output=True) /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because replacing `stdout=subprocess.PIPE` and +/// `stderr=subprocess.PIPE` with `capture_output=True` may delete comments attached +/// to the original arguments. +/// /// ## References /// - [Python 3.7 release notes](https://docs.python.org/3/whatsnew/3.7.html#subprocess) /// - [Python documentation: `subprocess.run`](https://docs.python.org/3/library/subprocess.html#subprocess.run) -#[violation] -pub struct ReplaceStdoutStderr; +#[derive(ViolationMetadata)] +pub(crate) struct ReplaceStdoutStderr; impl Violation for ReplaceStdoutStderr { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE`") + "Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE`".to_string() } fn fix_title(&self) -> Option<String> { @@ -53,7 +59,7 @@ impl Violation for ReplaceStdoutStderr { } /// UP022 -pub(crate) fn replace_stdout_stderr(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn replace_stdout_stderr(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::SUBPROCESS) { return; } @@ -93,7 +99,7 @@ pub(crate) fn replace_stdout_stderr(checker: &mut Checker, call: &ast::ExprCall) diagnostic .try_set_fix(|| generate_fix(stdout, stderr, call, checker.locator().contents())); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_str_enum.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_str_enum.rs index a5c9daaa63ed6..bb48ba16c763e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_str_enum.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_str_enum.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::identifier::Identifier; use ruff_text_size::Ranged; @@ -77,8 +77,8 @@ use crate::importer::ImportRequest; /// /// [breaking change]: https://blog.pecar.me/python-enum -#[violation] -pub struct ReplaceStrEnum { +#[derive(ViolationMetadata)] +pub(crate) struct ReplaceStrEnum { name: String, } @@ -97,7 +97,7 @@ impl Violation for ReplaceStrEnum { } /// UP042 -pub(crate) fn replace_str_enum(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn replace_str_enum(checker: &Checker, class_def: &ast::StmtClassDef) { let Some(arguments) = class_def.arguments.as_deref() else { // class does not inherit anything, exit early return; @@ -124,7 +124,7 @@ pub(crate) fn replace_str_enum(checker: &mut Checker, class_def: &ast::StmtClass // If the class does not inherit both `str` and `enum.Enum`, exit early. if !inherits_str || !inherits_enum { return; - }; + } let mut diagnostic = Diagnostic::new( ReplaceStrEnum { @@ -154,5 +154,5 @@ pub(crate) fn replace_str_enum(checker: &mut Checker, class_def: &ast::StmtClass }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_universal_newlines.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_universal_newlines.rs index 6638ae1086dae..ab1a8b8281315 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/replace_universal_newlines.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/replace_universal_newlines.rs @@ -1,11 +1,11 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for uses of `subprocess.run` that set the `universal_newlines` @@ -34,13 +34,13 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// ## References /// - [Python 3.7 release notes](https://docs.python.org/3/whatsnew/3.7.html#subprocess) /// - [Python documentation: `subprocess.run`](https://docs.python.org/3/library/subprocess.html#subprocess.run) -#[violation] -pub struct ReplaceUniversalNewlines; +#[derive(ViolationMetadata)] +pub(crate) struct ReplaceUniversalNewlines; impl AlwaysFixableViolation for ReplaceUniversalNewlines { #[derive_message_formats] fn message(&self) -> String { - format!("`universal_newlines` is deprecated, use `text`") + "`universal_newlines` is deprecated, use `text`".to_string() } fn fix_title(&self) -> String { @@ -49,7 +49,7 @@ impl AlwaysFixableViolation for ReplaceUniversalNewlines { } /// UP021 -pub(crate) fn replace_universal_newlines(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn replace_universal_newlines(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().seen_module(Modules::SUBPROCESS) { return; } @@ -85,6 +85,6 @@ pub(crate) fn replace_universal_newlines(checker: &mut Checker, call: &ast::Expr arg.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/super_call_with_parameters.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/super_call_with_parameters.rs index 06fb6ee050381..a1794219edff7 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/super_call_with_parameters.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/super_call_with_parameters.rs @@ -1,6 +1,6 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, Parameter, ParameterWithDefault, Stmt}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::{Ranged, TextSize}; use crate::checkers::ast::Checker; @@ -40,16 +40,21 @@ use crate::checkers::ast::Checker; /// super().foo() /// ``` /// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe because removing the arguments from a call +/// may delete comments that are attached to the arguments. +/// /// ## References /// - [Python documentation: `super`](https://docs.python.org/3/library/functions.html#super) /// - [super/MRO, Python's most misunderstood feature.](https://www.youtube.com/watch?v=X1PQ7zzltz4) -#[violation] -pub struct SuperCallWithParameters; +#[derive(ViolationMetadata)] +pub(crate) struct SuperCallWithParameters; impl AlwaysFixableViolation for SuperCallWithParameters { #[derive_message_formats] fn message(&self) -> String { - format!("Use `super()` instead of `super(__class__, self)`") + "Use `super()` instead of `super(__class__, self)`".to_string() } fn fix_title(&self) -> String { @@ -58,7 +63,7 @@ impl AlwaysFixableViolation for SuperCallWithParameters { } /// UP008 -pub(crate) fn super_call_with_parameters(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn super_call_with_parameters(checker: &Checker, call: &ast::ExprCall) { // Only bother going through the super check at all if we're in a `super` call. // (We check this in `super_args` too, so this is just an optimization.) if !is_super_call_with_arguments(call) { @@ -90,13 +95,7 @@ pub(crate) fn super_call_with_parameters(checker: &mut Checker, call: &ast::Expr }; // Extract the name of the first argument to the enclosing function. - let Some(ParameterWithDefault { - parameter: Parameter { - name: parent_arg, .. - }, - .. - }) = parent_parameters.args.first() - else { + let Some(parent_arg) = parent_parameters.args.first() else { return; }; @@ -122,7 +121,7 @@ pub(crate) fn super_call_with_parameters(checker: &mut Checker, call: &ast::Expr return; }; - if !(first_arg_id == parent_name.as_str() && second_arg_id == parent_arg.as_str()) { + if !(first_arg_id == parent_name.as_str() && second_arg_id == parent_arg.name().as_str()) { return; } @@ -145,7 +144,7 @@ pub(crate) fn super_call_with_parameters(checker: &mut Checker, call: &ast::Expr .resolve_qualified_name(func) .is_some_and(|name| name.segments() == ["dataclasses", "dataclass"]) { - arguments.find_keyword("slots").map_or(false, |keyword| { + arguments.find_keyword("slots").is_some_and(|keyword| { matches!( keyword.value, Expr::BooleanLiteral(ast::ExprBooleanLiteral { value: true, .. }) @@ -163,7 +162,7 @@ pub(crate) fn super_call_with_parameters(checker: &mut Checker, call: &ast::Expr call.arguments.start() + TextSize::new(1), call.arguments.end() - TextSize::new(1), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns `true` if a call is an argumented `super` invocation. diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/timeout_error_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/timeout_error_alias.rs index 4f5c421471c7e..e00eddf688f0a 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/timeout_error_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/timeout_error_alias.rs @@ -3,12 +3,12 @@ use ruff_text_size::{Ranged, TextRange}; use crate::fix::edits::pad; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::{Name, UnqualifiedName}; use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for uses of exceptions that alias `TimeoutError`. @@ -37,15 +37,15 @@ use crate::settings::types::PythonVersion; /// /// ## References /// - [Python documentation: `TimeoutError`](https://docs.python.org/3/library/exceptions.html#TimeoutError) -#[violation] -pub struct TimeoutErrorAlias { +#[derive(ViolationMetadata)] +pub(crate) struct TimeoutErrorAlias { name: Option<String>, } impl AlwaysFixableViolation for TimeoutErrorAlias { #[derive_message_formats] fn message(&self) -> String { - format!("Replace aliased errors with `TimeoutError`") + "Replace aliased errors with `TimeoutError`".to_string() } fn fix_title(&self) -> String { @@ -62,7 +62,7 @@ fn is_alias(expr: &Expr, semantic: &SemanticModel, target_version: PythonVersion semantic .resolve_qualified_name(expr) .is_some_and(|qualified_name| { - if target_version >= PythonVersion::Py311 { + if target_version >= PythonVersion::PY311 { matches!( qualified_name.segments(), ["socket", "timeout"] | ["asyncio", "TimeoutError"] @@ -73,7 +73,7 @@ fn is_alias(expr: &Expr, semantic: &SemanticModel, target_version: PythonVersion // fix in Python <3.10. We add an assert to make this assumption // explicit. assert!( - target_version >= PythonVersion::Py310, + target_version >= PythonVersion::PY310, "lint should only be used for Python 3.10+", ); matches!(qualified_name.segments(), ["socket", "timeout"]) @@ -82,7 +82,7 @@ fn is_alias(expr: &Expr, semantic: &SemanticModel, target_version: PythonVersion } /// Create a [`Diagnostic`] for a single target, like an [`Expr::Name`]. -fn atom_diagnostic(checker: &mut Checker, target: &Expr) { +fn atom_diagnostic(checker: &Checker, target: &Expr) { let mut diagnostic = Diagnostic::new( TimeoutErrorAlias { name: UnqualifiedName::from_expr(target).map(|name| name.to_string()), @@ -100,11 +100,11 @@ fn atom_diagnostic(checker: &mut Checker, target: &Expr) { import_edit, )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Create a [`Diagnostic`] for a tuple of expressions. -fn tuple_diagnostic(checker: &mut Checker, tuple: &ast::ExprTuple, aliases: &[&Expr]) { +fn tuple_diagnostic(checker: &Checker, tuple: &ast::ExprTuple, aliases: &[&Expr]) { let mut diagnostic = Diagnostic::new(TimeoutErrorAlias { name: None }, tuple.range()); let semantic = checker.semantic(); if semantic.has_builtin_binding("TimeoutError") { @@ -150,11 +150,11 @@ fn tuple_diagnostic(checker: &mut Checker, tuple: &ast::ExprTuple, aliases: &[&E tuple.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// UP041 -pub(crate) fn timeout_error_alias_handlers(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn timeout_error_alias_handlers(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { type_, .. }) = handler; let Some(expr) = type_.as_ref() else { @@ -162,7 +162,7 @@ pub(crate) fn timeout_error_alias_handlers(checker: &mut Checker, handlers: &[Ex }; match expr.as_ref() { Expr::Name(_) | Expr::Attribute(_) => { - if is_alias(expr, checker.semantic(), checker.settings.target_version) { + if is_alias(expr, checker.semantic(), checker.target_version()) { atom_diagnostic(checker, expr); } } @@ -170,7 +170,7 @@ pub(crate) fn timeout_error_alias_handlers(checker: &mut Checker, handlers: &[Ex // List of aliases to replace with `TimeoutError`. let mut aliases: Vec<&Expr> = vec![]; for element in tuple { - if is_alias(element, checker.semantic(), checker.settings.target_version) { + if is_alias(element, checker.semantic(), checker.target_version()) { aliases.push(element); } } @@ -184,16 +184,16 @@ pub(crate) fn timeout_error_alias_handlers(checker: &mut Checker, handlers: &[Ex } /// UP041 -pub(crate) fn timeout_error_alias_call(checker: &mut Checker, func: &Expr) { - if is_alias(func, checker.semantic(), checker.settings.target_version) { +pub(crate) fn timeout_error_alias_call(checker: &Checker, func: &Expr) { + if is_alias(func, checker.semantic(), checker.target_version()) { atom_diagnostic(checker, func); } } /// UP041 -pub(crate) fn timeout_error_alias_raise(checker: &mut Checker, expr: &Expr) { +pub(crate) fn timeout_error_alias_raise(checker: &Checker, expr: &Expr) { if matches!(expr, Expr::Name(_) | Expr::Attribute(_)) { - if is_alias(expr, checker.semantic(), checker.settings.target_version) { + if is_alias(expr, checker.semantic(), checker.target_version()) { atom_diagnostic(checker, expr); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/type_of_primitive.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/type_of_primitive.rs index 5ab47cb0c9c2d..210afe3967436 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/type_of_primitive.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/type_of_primitive.rs @@ -2,7 +2,7 @@ use ruff_python_ast::Expr; use crate::fix::edits::pad; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -30,8 +30,8 @@ use super::super::types::Primitive; /// ## References /// - [Python documentation: `type()`](https://docs.python.org/3/library/functions.html#type) /// - [Python documentation: Built-in types](https://docs.python.org/3/library/stdtypes.html) -#[violation] -pub struct TypeOfPrimitive { +#[derive(ViolationMetadata)] +pub(crate) struct TypeOfPrimitive { primitive: Primitive, } @@ -54,7 +54,7 @@ impl Violation for TypeOfPrimitive { } /// UP003 -pub(crate) fn type_of_primitive(checker: &mut Checker, expr: &Expr, func: &Expr, args: &[Expr]) { +pub(crate) fn type_of_primitive(checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr]) { let [arg] = args else { return; }; @@ -73,5 +73,5 @@ pub(crate) fn type_of_primitive(checker: &mut Checker, expr: &Expr, func: &Expr, expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/typing_text_str_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/typing_text_str_alias.rs index ffb432c458e61..37f8258bec9d6 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/typing_text_str_alias.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/typing_text_str_alias.rs @@ -1,7 +1,7 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -29,15 +29,15 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `typing.Text`](https://docs.python.org/3/library/typing.html#typing.Text) -#[violation] -pub struct TypingTextStrAlias; +#[derive(ViolationMetadata)] +pub(crate) struct TypingTextStrAlias; impl Violation for TypingTextStrAlias { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`typing.Text` is deprecated, use `str`") + "`typing.Text` is deprecated, use `str`".to_string() } fn fix_title(&self) -> Option<String> { @@ -46,7 +46,7 @@ impl Violation for TypingTextStrAlias { } /// UP019 -pub(crate) fn typing_text_str_alias(checker: &mut Checker, expr: &Expr) { +pub(crate) fn typing_text_str_alias(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::TYPING) { return; } @@ -68,6 +68,6 @@ pub(crate) fn typing_text_str_alias(checker: &mut Checker, expr: &Expr) { import_edit, )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unicode_kind_prefix.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unicode_kind_prefix.rs index a7949350939a0..e3af44207b1b0 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unicode_kind_prefix.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unicode_kind_prefix.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::StringLiteral; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -24,13 +24,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Unicode HOWTO](https://docs.python.org/3/howto/unicode.html) -#[violation] -pub struct UnicodeKindPrefix; +#[derive(ViolationMetadata)] +pub(crate) struct UnicodeKindPrefix; impl AlwaysFixableViolation for UnicodeKindPrefix { #[derive_message_formats] fn message(&self) -> String { - format!("Remove unicode literals from strings") + "Remove unicode literals from strings".to_string() } fn fix_title(&self) -> String { @@ -39,13 +39,13 @@ impl AlwaysFixableViolation for UnicodeKindPrefix { } /// UP025 -pub(crate) fn unicode_kind_prefix(checker: &mut Checker, string: &StringLiteral) { +pub(crate) fn unicode_kind_prefix(checker: &Checker, string: &StringLiteral) { if string.flags.prefix().is_unicode() { let mut diagnostic = Diagnostic::new(UnicodeKindPrefix, string.range); diagnostic.set_fix(Fix::safe_edit(Edit::range_deletion(TextRange::at( string.start(), TextSize::from(1), )))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_builtin_import.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_builtin_import.rs index ccb7d12c353c6..7496586c70d4e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_builtin_import.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_builtin_import.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{Alias, Stmt}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -29,8 +29,8 @@ use crate::fix; /// /// ## References /// - [Python documentation: The Python Standard Library](https://docs.python.org/3/library/index.html) -#[violation] -pub struct UnnecessaryBuiltinImport { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryBuiltinImport { pub names: Vec<String>, } @@ -54,7 +54,7 @@ impl AlwaysFixableViolation for UnnecessaryBuiltinImport { /// UP029 pub(crate) fn unnecessary_builtin_import( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, module: &str, names: &[Alias], @@ -138,5 +138,5 @@ pub(crate) fn unnecessary_builtin_import( checker.semantic().current_statement_parent_id(), ))) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_class_parentheses.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_class_parentheses.rs index fdb3612d2b62f..4896205762472 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_class_parentheses.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_class_parentheses.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast}; use ruff_text_size::Ranged; @@ -13,7 +13,7 @@ use crate::checkers::ast::Checker; /// If a class definition doesn't have any bases, the parentheses are /// unnecessary. /// -/// ## Examples +/// ## Example /// ```python /// class Foo(): /// ... @@ -24,13 +24,13 @@ use crate::checkers::ast::Checker; /// class Foo: /// ... /// ``` -#[violation] -pub struct UnnecessaryClassParentheses; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryClassParentheses; impl AlwaysFixableViolation for UnnecessaryClassParentheses { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary parentheses after class definition") + "Unnecessary parentheses after class definition".to_string() } fn fix_title(&self) -> String { @@ -39,7 +39,7 @@ impl AlwaysFixableViolation for UnnecessaryClassParentheses { } /// UP039 -pub(crate) fn unnecessary_class_parentheses(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn unnecessary_class_parentheses(checker: &Checker, class_def: &ast::StmtClassDef) { let Some(arguments) = class_def.arguments.as_deref() else { return; }; @@ -53,5 +53,5 @@ pub(crate) fn unnecessary_class_parentheses(checker: &mut Checker, class_def: &a arguments.start(), arguments.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_coding_comment.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_coding_comment.rs index d8ded816db5e2..e81a2d0f7c87a 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_coding_comment.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_coding_comment.rs @@ -1,13 +1,13 @@ +use std::iter::FusedIterator; use std::sync::LazyLock; use regex::Regex; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_index::Indexer; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_source_file::LineRanges; -use ruff_text_size::{Ranged, TextRange}; +use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::Locator; @@ -30,13 +30,13 @@ use crate::Locator; /// ``` /// /// [PEP 3120]: https://peps.python.org/pep-3120/ -#[violation] -pub struct UTF8EncodingDeclaration; +#[derive(ViolationMetadata)] +pub(crate) struct UTF8EncodingDeclaration; impl AlwaysFixableViolation for UTF8EncodingDeclaration { #[derive_message_formats] fn message(&self) -> String { - format!("UTF-8 encoding declaration is unnecessary") + "UTF-8 encoding declaration is unnecessary".to_string() } fn fix_title(&self) -> String { @@ -46,57 +46,134 @@ impl AlwaysFixableViolation for UTF8EncodingDeclaration { // Regex from PEP263. static CODING_COMMENT_REGEX: LazyLock<Regex> = - LazyLock::new(|| Regex::new(r"^[ \t\f]*#.*?coding[:=][ \t]*utf-?8").unwrap()); + LazyLock::new(|| Regex::new(r"^[ \t\f]*#.*?coding[:=][ \t]*(?<name>[-_.a-zA-Z0-9]+)").unwrap()); + +#[derive(Debug)] +enum CodingComment { + /// A UTF-8 encoding declaration. + UTF8(CodingCommentRange), + /// A declaration for any non utf8 encoding + OtherEncoding, + /// Any other comment + NoEncoding, +} + +#[derive(Debug)] +struct CodingCommentRange { + comment: TextRange, + line: TextRange, +} /// UP009 pub(crate) fn unnecessary_coding_comment( diagnostics: &mut Vec<Diagnostic>, locator: &Locator, - indexer: &Indexer, comment_ranges: &CommentRanges, ) { - // The coding comment must be on one of the first two lines. Since each comment spans at least - // one line, we only need to check the first two comments at most. - for comment_range in comment_ranges.iter().take(2) { + let mut iter = CodingCommentIterator::new(locator, comment_ranges) + .skip_while(|comment| matches!(comment, CodingComment::NoEncoding)); + + let Some(CodingComment::UTF8(range)) = iter.next() else { + return; + }; + + let line_index = locator.count_lines(TextRange::up_to(range.comment.start())); + + // Comment must be on the first or second line + if line_index > 1 { + return; + } + + // ```python + // # -*- coding: utf-8 -*- + // # -*- coding: latin-1 -*- + // ``` + // or + // ```python + // # -*- coding: utf-8 -*- + // # comment + // # -*- coding: latin-1 -*- + // ``` + if matches!( + (iter.next(), iter.next()), + (Some(CodingComment::OtherEncoding), _) + | ( + Some(CodingComment::NoEncoding), + Some(CodingComment::OtherEncoding) + ) + ) { + return; + } + + let fix = Fix::safe_edit(Edit::range_deletion(range.line)); + let diagnostic = Diagnostic::new(UTF8EncodingDeclaration, range.comment); + + diagnostics.push(diagnostic.with_fix(fix)); +} + +struct CodingCommentIterator<'a> { + /// End offset of the last comment trivia or `None` if there + /// was any non-comment comment since the iterator started (e.g. a print statement) + last_trivia_end: Option<TextSize>, + locator: &'a Locator<'a>, + comments: std::slice::Iter<'a, TextRange>, +} + +impl<'a> CodingCommentIterator<'a> { + fn new(locator: &'a Locator<'a>, comments: &'a CommentRanges) -> Self { + Self { + last_trivia_end: Some(locator.bom_start_offset()), + locator, + comments: comments.iter(), + } + } +} + +impl Iterator for CodingCommentIterator<'_> { + type Item = CodingComment; + + fn next(&mut self) -> Option<Self::Item> { + let comment = self.comments.next()?; + let line_range = self.locator.full_line_range(comment.start()); + // If leading content is not whitespace then it's not a valid coding comment e.g. - // ``` + // ```py // print(x) # coding=utf8 // ``` - let line_range = locator.full_line_range(comment_range.start()); - if !locator - .slice(TextRange::new(line_range.start(), comment_range.start())) - .trim() - .is_empty() - { - continue; + // or + // ```python + // print(test) + // # -*- coding: utf-8 -*- + // ``` + let last_trivia_end = self.last_trivia_end.take()?; + let before_hash_sign = self + .locator + .slice(TextRange::new(last_trivia_end, comment.start())); + + if !before_hash_sign.trim().is_empty() { + return None; } - // If the line is after a continuation then it's not a valid coding comment e.g. - // ``` - // x = 1 \ - // # coding=utf8 - // x = 2 - // ``` - if indexer - .preceded_by_continuations(line_range.start(), locator.contents()) - .is_some() + self.last_trivia_end = Some(comment.end()); + + let result = if let Some(parts_of_interest) = + CODING_COMMENT_REGEX.captures(self.locator.slice(line_range)) { - continue; - } + let coding_name = parts_of_interest.name("name").unwrap(); - if CODING_COMMENT_REGEX.is_match(locator.slice(line_range)) { - #[allow(deprecated)] - let index = locator.compute_line_index(line_range.start()); - if index.to_zero_indexed() > 1 { - continue; + match coding_name.as_str() { + "utf8" | "utf-8" => CodingComment::UTF8(CodingCommentRange { + comment: comment.range(), + line: line_range, + }), + _ => CodingComment::OtherEncoding, } + } else { + CodingComment::NoEncoding + }; - let mut diagnostic = Diagnostic::new(UTF8EncodingDeclaration, *comment_range); - diagnostic.set_fix(Fix::safe_edit(Edit::deletion( - line_range.start(), - line_range.end(), - ))); - diagnostics.push(diagnostic); - } + Some(result) } } + +impl FusedIterator for CodingCommentIterator<'_> {} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_default_type_args.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_default_type_args.rs index 4ef77fbc30f71..9e0eafe8015fa 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_default_type_args.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_default_type_args.rs @@ -1,22 +1,26 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; /// ## What it does -/// Checks for unnecessary default type arguments. +/// Checks for unnecessary default type arguments for `Generator` and +/// `AsyncGenerator` on Python 3.13+. /// /// ## Why is this bad? /// Python 3.13 introduced the ability for type parameters to specify default -/// values. As such, the default type arguments for some types in the standard -/// library (e.g., Generator, AsyncGenerator) are now optional. +/// values. Following this change, several standard-library classes were +/// updated to add default values for some of their type parameters. For +/// example, `Generator[int]` is now equivalent to +/// `Generator[int, None, None]`, as the second and third type parameters of +/// `Generator` now default to `None`. /// -/// Omitting type parameters that match the default values can make the code +/// Omitting type arguments that match the default values can make the code /// more concise and easier to read. /// -/// ## Examples +/// ## Example /// /// ```python /// from collections.abc import Generator, AsyncGenerator @@ -44,28 +48,33 @@ use crate::checkers::ast::Checker; /// yield 42 /// ``` /// -/// ## References +/// ## Fix safety +/// This rule's fix is marked as safe, unless the type annotation contains comments. +/// +/// ## Options +/// - `target-version` /// +/// ## References /// - [PEP 696 – Type Defaults for Type Parameters](https://peps.python.org/pep-0696/) -/// - [Annotating generators and coroutines](https://docs.python.org/3.13/library/typing.html#annotating-generators-and-coroutines) -/// - [typing.Generator](https://docs.python.org/3.13/library/typing.html#typing.Generator) -/// - [typing.AsyncGenerator](https://docs.python.org/3.13/library/typing.html#typing.AsyncGenerator) -#[violation] -pub struct UnnecessaryDefaultTypeArgs; +/// - [Annotating generators and coroutines](https://docs.python.org/3/library/typing.html#annotating-generators-and-coroutines) +/// - [Python documentation: `typing.Generator`](https://docs.python.org/3/library/typing.html#typing.Generator) +/// - [Python documentation: `typing.AsyncGenerator`](https://docs.python.org/3/library/typing.html#typing.AsyncGenerator) +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryDefaultTypeArgs; impl AlwaysFixableViolation for UnnecessaryDefaultTypeArgs { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary default type arguments") + "Unnecessary default type arguments".to_string() } fn fix_title(&self) -> String { - format!("Remove default type arguments") + "Remove default type arguments".to_string() } } /// UP043 -pub(crate) fn unnecessary_default_type_args(checker: &mut Checker, expr: &Expr) { +pub(crate) fn unnecessary_default_type_args(checker: &Checker, expr: &Expr) { let Expr::Subscript(ast::ExprSubscript { value, slice, .. }) = expr else { return; }; @@ -94,27 +103,40 @@ pub(crate) fn unnecessary_default_type_args(checker: &mut Checker, expr: &Expr) } let mut diagnostic = Diagnostic::new(UnnecessaryDefaultTypeArgs, expr.range()); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - checker - .generator() - .expr(&Expr::Subscript(ast::ExprSubscript { - value: value.clone(), - slice: Box::new(if let [elt] = valid_elts.as_slice() { - elt.clone() - } else { - Expr::Tuple(ast::ExprTuple { - elts: valid_elts, - ctx: ast::ExprContext::Load, - range: TextRange::default(), - parenthesized: true, - }) - }), - ctx: ast::ExprContext::Load, - range: TextRange::default(), - })), - expr.range(), - ))); - checker.diagnostics.push(diagnostic); + + let applicability = if checker + .comment_ranges() + .has_comments(expr, checker.source()) + { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement( + checker + .generator() + .expr(&Expr::Subscript(ast::ExprSubscript { + value: value.clone(), + slice: Box::new(if let [elt] = valid_elts.as_slice() { + elt.clone() + } else { + Expr::Tuple(ast::ExprTuple { + elts: valid_elts, + ctx: ast::ExprContext::Load, + range: TextRange::default(), + parenthesized: true, + }) + }), + ctx: ast::ExprContext::Load, + range: TextRange::default(), + })), + expr.range(), + ), + applicability, + )); + checker.report_diagnostic(diagnostic); } /// Trim trailing `None` literals from the given elements. diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_encode_utf8.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_encode_utf8.rs index 1b7b672e7f5be..038ec258719d9 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_encode_utf8.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_encode_utf8.rs @@ -1,12 +1,14 @@ +use std::fmt::Write as _; + use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr, Keyword}; use ruff_python_parser::{TokenKind, Tokens}; use ruff_text_size::{Ranged, TextRange}; -use crate::checkers::ast::Checker; -use crate::fix::edits::{pad, remove_argument, Parentheses}; use crate::Locator; +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, pad, remove_argument}; /// ## What it does /// Checks for unnecessary calls to `encode` as UTF-8. @@ -27,8 +29,8 @@ use crate::Locator; /// /// ## References /// - [Python documentation: `str.encode`](https://docs.python.org/3/library/stdtypes.html#str.encode) -#[violation] -pub struct UnnecessaryEncodeUTF8 { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryEncodeUTF8 { reason: Reason, } @@ -36,8 +38,10 @@ impl AlwaysFixableViolation for UnnecessaryEncodeUTF8 { #[derive_message_formats] fn message(&self) -> String { match self.reason { - Reason::BytesLiteral => format!("Unnecessary call to `encode` as UTF-8"), - Reason::DefaultArgument => format!("Unnecessary UTF-8 `encoding` argument to `encode`"), + Reason::BytesLiteral => "Unnecessary call to `encode` as UTF-8".to_string(), + Reason::DefaultArgument => { + "Unnecessary UTF-8 `encoding` argument to `encode`".to_string() + } } } @@ -127,10 +131,11 @@ fn replace_with_bytes_literal(locator: &Locator, call: &ast::ExprCall, tokens: & TokenKind::String => { replacement.push_str(locator.slice(TextRange::new(prev, token.start()))); let string = locator.slice(token); - replacement.push_str(&format!( + let _ = write!( + &mut replacement, "b{}", &string.trim_start_matches('u').trim_start_matches('U') - )); + ); } _ => { replacement.push_str(locator.slice(TextRange::new(prev, token.end()))); @@ -146,7 +151,7 @@ fn replace_with_bytes_literal(locator: &Locator, call: &ast::ExprCall, tokens: & } /// UP012 -pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn unnecessary_encode_utf8(checker: &Checker, call: &ast::ExprCall) { let Some(variable) = match_encoded_variable(&call.func) else { return; }; @@ -167,7 +172,7 @@ pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCal call, checker.tokens(), )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else if let EncodingArg::Keyword(kwarg) = encoding_arg { // Ex) Convert `"unicode text©".encode(encoding="utf-8")` to // `"unicode text©".encode()`. @@ -186,7 +191,7 @@ pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCal ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else if let EncodingArg::Positional(arg) = encoding_arg { // Ex) Convert `"unicode text©".encode("utf-8")` to `"unicode text©".encode()`. let mut diagnostic = Diagnostic::new( @@ -204,7 +209,7 @@ pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCal ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -229,7 +234,7 @@ pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCal ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } else if let EncodingArg::Positional(arg) = encoding_arg { // Ex) Convert `f"unicode text©".encode("utf-8")` to `f"unicode text©".encode()`. let mut diagnostic = Diagnostic::new( @@ -247,7 +252,7 @@ pub(crate) fn unnecessary_encode_utf8(checker: &mut Checker, call: &ast::ExprCal ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_future_import.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_future_import.rs index c713a04673d31..50ef3d89f5e84 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_future_import.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unnecessary_future_import.rs @@ -2,7 +2,7 @@ use itertools::Itertools; use ruff_python_ast::{Alias, Stmt}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -35,8 +35,8 @@ use crate::fix; /// /// ## References /// - [Python documentation: `__future__` — Future statement definitions](https://docs.python.org/3/library/__future__.html) -#[violation] -pub struct UnnecessaryFutureImport { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryFutureImport { pub names: Vec<String>, } @@ -82,7 +82,7 @@ const PY37_PLUS_REMOVE_FUTURES: &[&str] = &[ ]; /// UP010 -pub(crate) fn unnecessary_future_import(checker: &mut Checker, stmt: &Stmt, names: &[Alias]) { +pub(crate) fn unnecessary_future_import(checker: &Checker, stmt: &Stmt, names: &[Alias]) { let mut unused_imports: Vec<&Alias> = vec![]; for alias in names { if alias.asname.is_some() { @@ -127,5 +127,5 @@ pub(crate) fn unnecessary_future_import(checker: &mut Checker, stmt: &Stmt, name checker.semantic().current_statement_parent_id(), ))) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/unpacked_list_comprehension.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/unpacked_list_comprehension.rs index 2101c6437dd3b..5c8d28ec462f2 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/unpacked_list_comprehension.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/unpacked_list_comprehension.rs @@ -1,13 +1,7 @@ -use ruff_python_ast::{self as ast, Expr}; +use ruff_diagnostics::Violation; +use ruff_macros::ViolationMetadata; -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers::any_over_expr; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; - -/// ## Deprecation +/// ## Removed /// There's no [evidence](https://github.com/astral-sh/ruff/issues/12754) that generators are /// meaningfully faster than list comprehensions when combined with unpacking. /// @@ -32,58 +26,15 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: Generator expressions](https://docs.python.org/3/reference/expressions.html#generator-expressions) /// - [Python documentation: List comprehensions](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions) -#[violation] -pub struct UnpackedListComprehension; +#[derive(ViolationMetadata)] +pub(crate) struct UnpackedListComprehension; -impl AlwaysFixableViolation for UnpackedListComprehension { - #[derive_message_formats] +impl Violation for UnpackedListComprehension { fn message(&self) -> String { - format!("Replace unpacked list comprehension with a generator expression") + unreachable!("UP027 has been removed") } - fn fix_title(&self) -> String { - "Replace with generator expression".to_string() + fn message_formats() -> &'static [&'static str] { + &["Replace unpacked list comprehension with a generator expression"] } } - -/// UP027 -pub(crate) fn unpacked_list_comprehension(checker: &mut Checker, targets: &[Expr], value: &Expr) { - let Some(target) = targets.first() else { - return; - }; - - if !target.is_tuple_expr() { - return; - } - - let Expr::ListComp(ast::ExprListComp { - elt, - generators, - range: _, - }) = value - else { - return; - }; - - if generators.iter().any(|generator| generator.is_async) || contains_await(elt) { - return; - } - - let mut diagnostic = Diagnostic::new(UnpackedListComprehension, value.range()); - let existing = checker.locator().slice(value); - - let mut content = String::with_capacity(existing.len()); - content.push('('); - content.push_str(&existing[1..existing.len() - 1]); - content.push(')'); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - content, - value.range(), - ))); - checker.diagnostics.push(diagnostic); -} - -/// Return `true` if the [`Expr`] contains an `await` expression. -fn contains_await(expr: &Expr) -> bool { - any_over_expr(expr, &Expr::is_await_expr) -} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep585_annotation.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep585_annotation.rs index d44a182dc5155..e2a0cea9f7e01 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep585_annotation.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep585_annotation.rs @@ -1,14 +1,14 @@ use ruff_python_ast::Expr; use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::UnqualifiedName; use ruff_python_semantic::analyze::typing::ModuleMember; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::importer::ImportRequest; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; /// ## What it does /// Checks for the use of generics that can be replaced with standard library @@ -54,8 +54,8 @@ use crate::settings::types::PythonVersion; /// - `lint.pyupgrade.keep-runtime-typing` /// /// [PEP 585]: https://peps.python.org/pep-0585/ -#[violation] -pub struct NonPEP585Annotation { +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP585Annotation { from: String, to: String, } @@ -76,11 +76,7 @@ impl Violation for NonPEP585Annotation { } /// UP006 -pub(crate) fn use_pep585_annotation( - checker: &mut Checker, - expr: &Expr, - replacement: &ModuleMember, -) { +pub(crate) fn use_pep585_annotation(checker: &Checker, expr: &Expr, replacement: &ModuleMember) { let Some(from) = UnqualifiedName::from_expr(expr) else { return; }; @@ -102,7 +98,7 @@ pub(crate) fn use_pep585_annotation( checker.semantic(), )?; let binding_edit = Edit::range_replacement(binding, expr.range()); - let applicability = if checker.settings.target_version >= PythonVersion::Py310 { + let applicability = if checker.target_version() >= PythonVersion::PY310 { Applicability::Safe } else { Applicability::Unsafe @@ -126,7 +122,7 @@ pub(crate) fn use_pep585_annotation( Ok(Fix::applicable_edits( import_edit, [reference_edit], - if checker.settings.target_version >= PythonVersion::Py310 { + if checker.target_version() >= PythonVersion::PY310 { Applicability::Safe } else { Applicability::Unsafe @@ -136,5 +132,5 @@ pub(crate) fn use_pep585_annotation( } } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_annotation.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_annotation.rs index d46167028da67..7f5071badbb33 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_annotation.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_annotation.rs @@ -1,13 +1,15 @@ use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::PythonVersion; use ruff_python_ast::helpers::{pep_604_optional, pep_604_union}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::analyze::typing::Pep604Operator; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; +use crate::codes::Rule; use crate::fix::edits::pad; -use crate::settings::types::PythonVersion; +use crate::preview::is_defer_optional_to_up045_enabled; /// ## What it does /// Check for type annotations that can be rewritten based on [PEP 604] syntax. @@ -37,6 +39,10 @@ use crate::settings::types::PythonVersion; /// foo: int | str = 1 /// ``` /// +/// ## Preview +/// In preview mode, this rule only checks for usages of `typing.Union`, +/// while `UP045` checks for `typing.Optional`. +/// /// ## Fix safety /// This rule's fix is marked as unsafe, as it may lead to runtime errors when /// alongside libraries that rely on runtime type annotations, like Pydantic, @@ -49,15 +55,15 @@ use crate::settings::types::PythonVersion; /// - `lint.pyupgrade.keep-runtime-typing` /// /// [PEP 604]: https://peps.python.org/pep-0604/ -#[violation] -pub struct NonPEP604Annotation; +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP604AnnotationUnion; -impl Violation for NonPEP604Annotation { +impl Violation for NonPEP604AnnotationUnion { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `X | Y` for type annotations") + "Use `X | Y` for type annotations".to_string() } fn fix_title(&self) -> Option<String> { @@ -65,9 +71,65 @@ impl Violation for NonPEP604Annotation { } } -/// UP007 -pub(crate) fn use_pep604_annotation( - checker: &mut Checker, +/// ## What it does +/// Check for `typing.Optional` annotations that can be rewritten based on [PEP 604] syntax. +/// +/// ## Why is this bad? +/// [PEP 604] introduced a new syntax for union type annotations based on the +/// `|` operator. This syntax is more concise and readable than the previous +/// `typing.Optional` syntax. +/// +/// This rule is enabled when targeting Python 3.10 or later (see: +/// [`target-version`]). By default, it's _also_ enabled for earlier Python +/// versions if `from __future__ import annotations` is present, as +/// `__future__` annotations are not evaluated at runtime. If your code relies +/// on runtime type annotations (either directly or via a library like +/// Pydantic), you can disable this behavior for Python versions prior to 3.10 +/// by setting [`lint.pyupgrade.keep-runtime-typing`] to `true`. +/// +/// ## Example +/// ```python +/// from typing import Optional +/// +/// foo: Optional[int] = None +/// ``` +/// +/// Use instead: +/// ```python +/// foo: int | None = None +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe, as it may lead to runtime errors when +/// alongside libraries that rely on runtime type annotations, like Pydantic, +/// on Python versions prior to Python 3.10. It may also lead to runtime errors +/// in unusual and likely incorrect type annotations where the type does not +/// support the `|` operator. +/// +/// ## Options +/// - `target-version` +/// - `lint.pyupgrade.keep-runtime-typing` +/// +/// [PEP 604]: https://peps.python.org/pep-0604/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP604AnnotationOptional; + +impl Violation for NonPEP604AnnotationOptional { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Use `X | None` for type annotations".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Convert to `X | None`".to_string()) + } +} + +/// UP007, UP045 +pub(crate) fn non_pep604_annotation( + checker: &Checker, expr: &Expr, slice: &Expr, operator: Pep604Operator, @@ -78,7 +140,7 @@ pub(crate) fn use_pep604_annotation( && !checker.semantic().in_complex_string_type_definition() && is_allowed_value(slice); - let applicability = if checker.settings.target_version >= PythonVersion::Py310 { + let applicability = if checker.target_version() >= PythonVersion::PY310 { Applicability::Safe } else { Applicability::Unsafe @@ -86,7 +148,22 @@ pub(crate) fn use_pep604_annotation( match operator { Pep604Operator::Optional => { - let mut diagnostic = Diagnostic::new(NonPEP604Annotation, expr.range()); + let (rule, mut diagnostic) = if is_defer_optional_to_up045_enabled(checker.settings) { + ( + Rule::NonPEP604AnnotationOptional, + Diagnostic::new(NonPEP604AnnotationOptional, expr.range()), + ) + } else { + ( + Rule::NonPEP604AnnotationUnion, + Diagnostic::new(NonPEP604AnnotationUnion, expr.range()), + ) + }; + + if !checker.enabled(rule) { + return; + } + if fixable { match slice { Expr::Tuple(_) => { @@ -107,10 +184,14 @@ pub(crate) fn use_pep604_annotation( } } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } Pep604Operator::Union => { - let mut diagnostic = Diagnostic::new(NonPEP604Annotation, expr.range()); + if !checker.enabled(Rule::NonPEP604AnnotationUnion) { + return; + } + + let mut diagnostic = Diagnostic::new(NonPEP604AnnotationUnion, expr.range()); if fixable { match slice { Expr::Slice(_) => { @@ -145,7 +226,7 @@ pub(crate) fn use_pep604_annotation( } } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_isinstance.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_isinstance.rs index 92db5e57b1e5f..4060deccda9be 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_isinstance.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep604_isinstance.rs @@ -1,9 +1,9 @@ use std::fmt; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::helpers::pep_604_union; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; +use ruff_python_ast::helpers::pep_604_union; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -33,6 +33,12 @@ impl CallKind { } } +/// ## Deprecation +/// This rule was deprecated as using [PEP 604] syntax in `isinstance` and `issubclass` calls +/// isn't recommended practice, and it incorrectly suggests that other typing syntaxes like [PEP 695] +/// would be supported by `isinstance` and `issubclass`. Using the [PEP 604] syntax +/// is also slightly slower. +/// /// ## What it does /// Checks for uses of `isinstance` and `issubclass` that take a tuple /// of types for comparison. @@ -64,8 +70,9 @@ impl CallKind { /// - [Python documentation: `issubclass`](https://docs.python.org/3/library/functions.html#issubclass) /// /// [PEP 604]: https://peps.python.org/pep-0604/ -#[violation] -pub struct NonPEP604Isinstance { +/// [PEP 695]: https://peps.python.org/pep-0695/ +#[derive(ViolationMetadata)] +pub(crate) struct NonPEP604Isinstance { kind: CallKind, } @@ -81,12 +88,7 @@ impl AlwaysFixableViolation for NonPEP604Isinstance { } /// UP038 -pub(crate) fn use_pep604_isinstance( - checker: &mut Checker, - expr: &Expr, - func: &Expr, - args: &[Expr], -) { +pub(crate) fn use_pep604_isinstance(checker: &Checker, expr: &Expr, func: &Expr, args: &[Expr]) { let Some(types) = args.get(1) else { return; }; @@ -107,7 +109,7 @@ pub(crate) fn use_pep604_isinstance( let Some(kind) = CallKind::from_name(builtin_function_name) else { return; }; - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new(NonPEP604Isinstance { kind }, expr.range()).with_fix(Fix::unsafe_edit( Edit::range_replacement( checker.generator().expr(&pep_604_union(&tuple.elts)), diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep695_type_alias.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep695_type_alias.rs deleted file mode 100644 index dc3072ff08396..0000000000000 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/use_pep695_type_alias.rs +++ /dev/null @@ -1,370 +0,0 @@ -use itertools::Itertools; - -use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::name::Name; -use ruff_python_ast::{ - self as ast, - visitor::{self, Visitor}, - Expr, ExprCall, ExprName, ExprSubscript, Identifier, Keyword, Stmt, StmtAnnAssign, StmtAssign, - StmtTypeAlias, TypeParam, TypeParamTypeVar, -}; -use ruff_python_codegen::Generator; -use ruff_python_semantic::SemanticModel; -use ruff_text_size::{Ranged, TextRange}; - -use crate::checkers::ast::Checker; -use crate::settings::types::PythonVersion; - -/// ## What it does -/// Checks for use of `TypeAlias` annotations and `TypeAliasType` assignments -/// for declaring type aliases. -/// -/// ## Why is this bad? -/// The `type` keyword was introduced in Python 3.12 by [PEP 695] for defining -/// type aliases. The `type` keyword is easier to read and provides cleaner -/// support for generics. -/// -/// ## Known problems -/// [PEP 695] uses inferred variance for type parameters, instead of the -/// `covariant` and `contravariant` keywords used by `TypeParam` variables. As -/// such, rewriting a `TypeParam` variable to a `type` alias may change its -/// variance. -/// -/// Unlike `TypeParam` variables, [PEP 695]-style `type` aliases cannot be used -/// at runtime. For example, calling `isinstance` on a `type` alias will throw -/// a `TypeError`. As such, rewriting a `TypeParam` via the `type` keyword will -/// cause issues for parameters that are used for such runtime checks. -/// -/// ## Example -/// ```python -/// ListOfInt: TypeAlias = list[int] -/// PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) -/// ``` -/// -/// Use instead: -/// ```python -/// type ListOfInt = list[int] -/// type PositiveInt = Annotated[int, Gt(0)] -/// ``` -/// -/// [PEP 695]: https://peps.python.org/pep-0695/ -#[violation] -pub struct NonPEP695TypeAlias { - name: String, - type_alias_kind: TypeAliasKind, -} - -#[derive(Debug, Copy, Clone, PartialEq, Eq)] -enum TypeAliasKind { - TypeAlias, - TypeAliasType, -} - -impl Violation for NonPEP695TypeAlias { - const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; - - #[derive_message_formats] - fn message(&self) -> String { - let NonPEP695TypeAlias { - name, - type_alias_kind, - } = self; - let type_alias_method = match type_alias_kind { - TypeAliasKind::TypeAlias => "`TypeAlias` annotation", - TypeAliasKind::TypeAliasType => "`TypeAliasType` assignment", - }; - format!("Type alias `{name}` uses {type_alias_method} instead of the `type` keyword") - } - - fn fix_title(&self) -> Option<String> { - Some("Use the `type` keyword".to_string()) - } -} - -/// UP040 -pub(crate) fn non_pep695_type_alias_type(checker: &mut Checker, stmt: &StmtAssign) { - if checker.settings.target_version < PythonVersion::Py312 { - return; - } - - let StmtAssign { targets, value, .. } = stmt; - - let Expr::Call(ExprCall { - func, arguments, .. - }) = value.as_ref() - else { - return; - }; - - let [Expr::Name(target_name)] = targets.as_slice() else { - return; - }; - - let [Expr::StringLiteral(name), value] = arguments.args.as_ref() else { - return; - }; - - if &name.value != target_name.id.as_str() { - return; - } - - let type_params = match arguments.keywords.as_ref() { - [] => &[], - [Keyword { - arg: Some(name), - value: Expr::Tuple(type_params), - .. - }] if name.as_str() == "type_params" => type_params.elts.as_slice(), - _ => return, - }; - - if !checker - .semantic() - .match_typing_expr(func.as_ref(), "TypeAliasType") - { - return; - } - - let Some(vars) = type_params - .iter() - .map(|expr| { - expr.as_name_expr().map(|name| { - expr_name_to_type_var(checker.semantic(), name).unwrap_or(TypeVar { - name, - restriction: None, - }) - }) - }) - .collect::<Option<Vec<_>>>() - else { - return; - }; - - checker.diagnostics.push(create_diagnostic( - checker.generator(), - stmt.range(), - target_name.id.clone(), - value, - &vars, - Applicability::Safe, - TypeAliasKind::TypeAliasType, - )); -} - -/// UP040 -pub(crate) fn non_pep695_type_alias(checker: &mut Checker, stmt: &StmtAnnAssign) { - if checker.settings.target_version < PythonVersion::Py312 { - return; - } - - let StmtAnnAssign { - target, - annotation, - value, - .. - } = stmt; - - if !checker - .semantic() - .match_typing_expr(annotation, "TypeAlias") - { - return; - } - - let Expr::Name(ExprName { id: name, .. }) = target.as_ref() else { - return; - }; - - let Some(value) = value else { - return; - }; - - // TODO(zanie): We should check for generic type variables used in the value and define them - // as type params instead - let vars = { - let mut visitor = TypeVarReferenceVisitor { - vars: vec![], - semantic: checker.semantic(), - }; - visitor.visit_expr(value); - visitor.vars - }; - - // Type variables must be unique; filter while preserving order. - let vars = vars - .into_iter() - .unique_by(|TypeVar { name, .. }| name.id.as_str()) - .collect::<Vec<_>>(); - - checker.diagnostics.push(create_diagnostic( - checker.generator(), - stmt.range(), - name.clone(), - value, - &vars, - // The fix is only safe in a type stub because new-style aliases have different runtime behavior - // See https://github.com/astral-sh/ruff/issues/6434 - if checker.source_type.is_stub() { - Applicability::Safe - } else { - Applicability::Unsafe - }, - TypeAliasKind::TypeAlias, - )); -} - -/// Generate a [`Diagnostic`] for a non-PEP 695 type alias or type alias type. -fn create_diagnostic( - generator: Generator, - stmt_range: TextRange, - name: Name, - value: &Expr, - vars: &[TypeVar], - applicability: Applicability, - type_alias_kind: TypeAliasKind, -) -> Diagnostic { - let type_params = if vars.is_empty() { - None - } else { - Some(ast::TypeParams { - range: TextRange::default(), - type_params: vars - .iter() - .map(|TypeVar { name, restriction }| { - TypeParam::TypeVar(TypeParamTypeVar { - range: TextRange::default(), - name: Identifier::new(name.id.clone(), TextRange::default()), - bound: match restriction { - Some(TypeVarRestriction::Bound(bound)) => { - Some(Box::new((*bound).clone())) - } - Some(TypeVarRestriction::Constraint(constraints)) => { - Some(Box::new(Expr::Tuple(ast::ExprTuple { - range: TextRange::default(), - elts: constraints.iter().map(|expr| (*expr).clone()).collect(), - ctx: ast::ExprContext::Load, - parenthesized: true, - }))) - } - None => None, - }, - // We don't handle defaults here yet. Should perhaps be a different rule since - // defaults are only valid in 3.13+. - default: None, - }) - }) - .collect(), - }) - }; - - Diagnostic::new( - NonPEP695TypeAlias { - name: name.to_string(), - type_alias_kind, - }, - stmt_range, - ) - .with_fix(Fix::applicable_edit( - Edit::range_replacement( - generator.stmt(&Stmt::from(StmtTypeAlias { - range: TextRange::default(), - name: Box::new(Expr::Name(ExprName { - range: TextRange::default(), - id: name, - ctx: ast::ExprContext::Load, - })), - type_params, - value: Box::new(value.clone()), - })), - stmt_range, - ), - applicability, - )) -} - -#[derive(Debug)] -enum TypeVarRestriction<'a> { - /// A type variable with a bound, e.g., `TypeVar("T", bound=int)`. - Bound(&'a Expr), - /// A type variable with constraints, e.g., `TypeVar("T", int, str)`. - Constraint(Vec<&'a Expr>), -} - -#[derive(Debug)] -struct TypeVar<'a> { - name: &'a ExprName, - restriction: Option<TypeVarRestriction<'a>>, -} - -struct TypeVarReferenceVisitor<'a> { - vars: Vec<TypeVar<'a>>, - semantic: &'a SemanticModel<'a>, -} - -/// Recursively collects the names of type variable references present in an expression. -impl<'a> Visitor<'a> for TypeVarReferenceVisitor<'a> { - fn visit_expr(&mut self, expr: &'a Expr) { - match expr { - Expr::Name(name) if name.ctx.is_load() => { - self.vars.extend(expr_name_to_type_var(self.semantic, name)); - } - _ => visitor::walk_expr(self, expr), - } - } -} - -fn expr_name_to_type_var<'a>( - semantic: &'a SemanticModel, - name: &'a ExprName, -) -> Option<TypeVar<'a>> { - let Some(Stmt::Assign(StmtAssign { value, .. })) = semantic - .lookup_symbol(name.id.as_str()) - .and_then(|binding_id| { - semantic - .binding(binding_id) - .source - .map(|node_id| semantic.statement(node_id)) - }) - else { - return None; - }; - - match value.as_ref() { - Expr::Subscript(ExprSubscript { - value: ref subscript_value, - .. - }) => { - if semantic.match_typing_expr(subscript_value, "TypeVar") { - return Some(TypeVar { - name, - restriction: None, - }); - } - } - Expr::Call(ExprCall { - func, arguments, .. - }) => { - if semantic.match_typing_expr(func, "TypeVar") - && arguments - .args - .first() - .is_some_and(Expr::is_string_literal_expr) - { - let restriction = if let Some(bound) = arguments.find_keyword("bound") { - Some(TypeVarRestriction::Bound(&bound.value)) - } else if arguments.args.len() > 1 { - Some(TypeVarRestriction::Constraint( - arguments.args.iter().skip(1).collect(), - )) - } else { - None - }; - - return Some(TypeVar { name, restriction }); - } - } - _ => {} - } - None -} diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/useless_metaclass_type.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/useless_metaclass_type.rs index 21d4b67448055..eae3cd4389194 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/useless_metaclass_type.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/useless_metaclass_type.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -27,14 +27,14 @@ use crate::fix; /// ``` /// /// ## References -/// - [PEP 3115](https://www.python.org/dev/peps/pep-3115/) -#[violation] -pub struct UselessMetaclassType; +/// - [PEP 3115 – Metaclasses in Python 3000](https://peps.python.org/pep-3115/) +#[derive(ViolationMetadata)] +pub(crate) struct UselessMetaclassType; impl AlwaysFixableViolation for UselessMetaclassType { #[derive_message_formats] fn message(&self) -> String { - format!("`__metaclass__ = type` is implied") + "`__metaclass__ = type` is implied".to_string() } fn fix_title(&self) -> String { @@ -44,7 +44,7 @@ impl AlwaysFixableViolation for UselessMetaclassType { /// UP001 pub(crate) fn useless_metaclass_type( - checker: &mut Checker, + checker: &Checker, stmt: &Stmt, value: &Expr, targets: &[Expr], @@ -69,5 +69,5 @@ pub(crate) fn useless_metaclass_type( diagnostic.set_fix(Fix::safe_edit(edit).isolate(Checker::isolation( checker.semantic().current_statement_parent_id(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/useless_object_inheritance.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/useless_object_inheritance.rs index 2b02baeaa2aa3..ecc0defe39a0f 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/useless_object_inheritance.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/useless_object_inheritance.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; /// ## What it does /// Checks for classes that inherit from `object`. @@ -26,9 +26,9 @@ use crate::fix::edits::{remove_argument, Parentheses}; /// ``` /// /// ## References -/// - [PEP 3115](https://www.python.org/dev/peps/pep-3115/) -#[violation] -pub struct UselessObjectInheritance { +/// - [PEP 3115 – Metaclasses in Python 3000](https://peps.python.org/pep-3115/) +#[derive(ViolationMetadata)] +pub(crate) struct UselessObjectInheritance { name: String, } @@ -45,7 +45,7 @@ impl AlwaysFixableViolation for UselessObjectInheritance { } /// UP004 -pub(crate) fn useless_object_inheritance(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn useless_object_inheritance(checker: &Checker, class_def: &ast::StmtClassDef) { let Some(arguments) = class_def.arguments.as_deref() else { return; }; @@ -70,6 +70,6 @@ pub(crate) fn useless_object_inheritance(checker: &mut Checker, class_def: &ast: ) .map(Fix::safe_edit) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/pyupgrade/rules/yield_in_for_loop.rs b/crates/ruff_linter/src/rules/pyupgrade/rules/yield_in_for_loop.rs index 5a66d937c3e97..46c7ef8e2bdbb 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/rules/yield_in_for_loop.rs +++ b/crates/ruff_linter/src/rules/pyupgrade/rules/yield_in_for_loop.rs @@ -1,5 +1,5 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::Ranged; @@ -17,11 +17,19 @@ use crate::checkers::ast::Checker; /// ```python /// for x in foo: /// yield x +/// +/// global y +/// for y in foo: +/// yield y /// ``` /// /// Use instead: /// ```python /// yield from foo +/// +/// for _element in foo: +/// y = _element +/// yield y /// ``` /// /// ## Fix safety @@ -31,28 +39,33 @@ use crate::checkers::ast::Checker; /// to a `yield from` could lead to an attribute error if the underlying /// generator does not implement the `send` method. /// +/// Additionally, if at least one target is `global` or `nonlocal`, +/// no fix will be offered. +/// /// In most cases, however, the fix is safe, and such a modification should have /// no effect on the behavior of the program. /// /// ## References /// - [Python documentation: The `yield` statement](https://docs.python.org/3/reference/simple_stmts.html#the-yield-statement) -/// - [PEP 380](https://peps.python.org/pep-0380/) -#[violation] -pub struct YieldInForLoop; +/// - [PEP 380 – Syntax for Delegating to a Subgenerator](https://peps.python.org/pep-0380/) +#[derive(ViolationMetadata)] +pub(crate) struct YieldInForLoop; + +impl Violation for YieldInForLoop { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; -impl AlwaysFixableViolation for YieldInForLoop { #[derive_message_formats] fn message(&self) -> String { - format!("Replace `yield` over `for` loop with `yield from`") + "Replace `yield` over `for` loop with `yield from`".to_string() } - fn fix_title(&self) -> String { - "Replace with `yield from`".to_string() + fn fix_title(&self) -> Option<String> { + Some("Replace with `yield from`".to_string()) } } /// UP028 -pub(crate) fn yield_in_for_loop(checker: &mut Checker, stmt_for: &ast::StmtFor) { +pub(crate) fn yield_in_for_loop(checker: &Checker, stmt_for: &ast::StmtFor) { // Intentionally omit async contexts. if checker.semantic().in_async_context() { return; @@ -114,6 +127,7 @@ pub(crate) fn yield_in_for_loop(checker: &mut Checker, stmt_for: &ast::StmtFor) } let mut diagnostic = Diagnostic::new(YieldInForLoop, stmt_for.range()); + let contents = checker.locator().slice( parenthesized_range( iter.as_ref().into(), @@ -123,12 +137,29 @@ pub(crate) fn yield_in_for_loop(checker: &mut Checker, stmt_for: &ast::StmtFor) ) .unwrap_or(iter.range()), ); - let contents = format!("yield from {contents}"); - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( - contents, - stmt_for.range(), - ))); - checker.diagnostics.push(diagnostic); + let contents = if iter.as_tuple_expr().is_some_and(|it| !it.parenthesized) { + format!("yield from ({contents})") + } else { + format!("yield from {contents}") + }; + + if !collect_names(value).any(|name| { + let semantic = checker.semantic(); + let mut bindings = semantic.current_scope().get_all(name.id.as_str()); + + bindings.any(|id| { + let binding = semantic.binding(id); + + binding.is_global() || binding.is_nonlocal() + }) + }) { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + contents, + stmt_for.range(), + ))); + } + + checker.report_diagnostic(diagnostic); } /// Return `true` if the two expressions are equivalent, and both consistent solely @@ -149,7 +180,7 @@ fn is_same_expr(left: &Expr, right: &Expr) -> bool { /// Collect all named variables in an expression consisting solely of tuples and /// names. -fn collect_names<'a>(expr: &'a Expr) -> Box<dyn Iterator<Item = &ast::ExprName> + 'a> { +fn collect_names<'a>(expr: &'a Expr) -> Box<dyn Iterator<Item = &'a ast::ExprName> + 'a> { Box::new( expr.as_name_expr().into_iter().chain( expr.as_tuple_expr() diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP001.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP001.py.snap index 1b1e0774ee5de..e0964e0a049ce 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP001.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP001.py.snap @@ -22,7 +22,7 @@ UP001.py:6:5: UP001 [*] `__metaclass__ = type` is implied 5 | class B: 6 | __metaclass__ = type | ^^^^^^^^^^^^^^^^^^^^ UP001 -7 | +7 | 8 | def __init__(self) -> None: | = help: Remove `__metaclass__ = type` @@ -35,5 +35,3 @@ UP001.py:6:5: UP001 [*] `__metaclass__ = type` is implied 7 6 | 8 7 | def __init__(self) -> None: 9 8 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP003.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP003.py.snap index 4ea8ce149125c..d11e176201752 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP003.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP003.py.snap @@ -81,7 +81,7 @@ UP003.py:5:1: UP003 [*] Use `complex` instead of `type(...)` 4 | type(0.0) 5 | type(0j) | ^^^^^^^^ UP003 -6 | +6 | 7 | # OK | = help: Replace `type(...)` with `complex` @@ -110,5 +110,3 @@ UP003.py:14:29: UP003 [*] Use `str` instead of `type(...)` 13 13 | # Regression test for: https://github.com/astral-sh/ruff/issues/7455#issuecomment-1722459841 14 |-assert isinstance(fullname, type("")is not True) 14 |+assert isinstance(fullname, str is not True) - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP004.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP004.py.snap index 0c4b87c5d9dbf..7c4eabfa7bd7d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP004.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP004.py.snap @@ -493,7 +493,7 @@ UP004.py:146:9: UP004 [*] Class `A` inherits from `object` UP004.py:159:15: UP004 [*] Class `Unusual` inherits from `object` | 157 | import builtins -158 | +158 | 159 | class Unusual(builtins.object): | ^^^^^^^^^^^^^^^ UP004 160 | ... diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP005.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP005.py.snap index 21d08d5d28243..9f6ddec478e15 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP005.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP005.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP005.py:6:9: UP005 [*] `assertEquals` is deprecated, use `assertEqual` | @@ -76,5 +77,3 @@ UP005.py:10:9: UP005 [*] `assertNotRegexpMatches` is deprecated, use `assertNotR 9 9 | self.failUnlessAlmostEqual(1, 1.1) 10 |- self.assertNotRegexpMatches("a", "b") 10 |+ self.assertNotRegex("a", "b") - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_0.py.snap index 283b6f1b0c1a4..58bd2d2497f7f 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP006_0.py:4:10: UP006 [*] Use `list` instead of `typing.List` for type annotation | @@ -280,5 +281,3 @@ UP006_0.py:65:10: UP006 [*] Use `collections.defaultdict` instead of `typing.Def 65 |-def f(x: typing.DefaultDict[str, str]) -> None: 66 |+def f(x: defaultdict[str, str]) -> None: 66 67 | ... - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_1.py.snap index 23d2e79f9a43f..f262fe049805a 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP006_1.py:9:10: UP006 [*] Use `collections.defaultdict` instead of `typing.DefaultDict` for type annotation | @@ -16,5 +17,3 @@ UP006_1.py:9:10: UP006 [*] Use `collections.defaultdict` instead of `typing.Defa 9 |-def f(x: typing.DefaultDict[str, str]) -> None: 9 |+def f(x: defaultdict[str, str]) -> None: 10 10 | ... - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_2.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_2.py.snap index a290ac1b56b1e..adc1afe1efe07 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_2.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_2.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP006_2.py:7:10: UP006 Use `collections.defaultdict` instead of `typing.DefaultDict` for type annotation | @@ -8,5 +9,3 @@ UP006_2.py:7:10: UP006 Use `collections.defaultdict` instead of `typing.DefaultD 8 | ... | = help: Replace with `collections.defaultdict` - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_3.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_3.py.snap index 6e49fa82351ff..b9d64a074baed 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_3.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP006_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP006_3.py:7:11: UP006 [*] Use `collections.defaultdict` instead of `typing.DefaultDict` for type annotation | @@ -16,5 +17,3 @@ UP006_3.py:7:11: UP006 [*] Use `collections.defaultdict` instead of `typing.Defa 7 |-def f(x: "typing.DefaultDict[str, str]") -> None: 7 |+def f(x: "defaultdict[str, str]") -> None: 8 8 | ... - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP007.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP007.py.snap index a607401c39adf..a2b50cedc1115 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP007.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP007.py.snap @@ -1,434 +1,316 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs --- -UP007.py:6:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:5:10: UP007 [*] Use `X | Y` for type annotations | -6 | def f(x: Optional[str]) -> None: - | ^^^^^^^^^^^^^ UP007 -7 | ... +5 | def f(x: Union[str, int, Union[float, bytes]]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +6 | ... | = help: Convert to `X | Y` ℹ Safe fix -3 3 | from typing import Union +2 2 | from typing import Union +3 3 | 4 4 | -5 5 | -6 |-def f(x: Optional[str]) -> None: - 6 |+def f(x: str | None) -> None: -7 7 | ... +5 |-def f(x: Union[str, int, Union[float, bytes]]) -> None: + 5 |+def f(x: str | int | Union[float, bytes]) -> None: +6 6 | ... +7 7 | 8 8 | -9 9 | -UP007.py:10:10: UP007 [*] Use `X | Y` for type annotations - | -10 | def f(x: typing.Optional[str]) -> None: - | ^^^^^^^^^^^^^^^^^^^^ UP007 -11 | ... - | - = help: Convert to `X | Y` +UP007.py:5:26: UP007 [*] Use `X | Y` for type annotations + | +5 | def f(x: Union[str, int, Union[float, bytes]]) -> None: + | ^^^^^^^^^^^^^^^^^^^ UP007 +6 | ... + | + = help: Convert to `X | Y` ℹ Safe fix -7 7 | ... -8 8 | -9 9 | -10 |-def f(x: typing.Optional[str]) -> None: - 10 |+def f(x: str | None) -> None: -11 11 | ... -12 12 | -13 13 | +2 2 | from typing import Union +3 3 | +4 4 | +5 |-def f(x: Union[str, int, Union[float, bytes]]) -> None: + 5 |+def f(x: Union[str, int, float | bytes]) -> None: +6 6 | ... +7 7 | +8 8 | -UP007.py:14:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:9:10: UP007 [*] Use `X | Y` for type annotations | -14 | def f(x: Union[str, int, Union[float, bytes]]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 -15 | ... + 9 | def f(x: typing.Union[str, int]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^ UP007 +10 | ... | = help: Convert to `X | Y` ℹ Safe fix -11 11 | ... +6 6 | ... +7 7 | +8 8 | +9 |-def f(x: typing.Union[str, int]) -> None: + 9 |+def f(x: str | int) -> None: +10 10 | ... +11 11 | 12 12 | -13 13 | -14 |-def f(x: Union[str, int, Union[float, bytes]]) -> None: - 14 |+def f(x: str | int | Union[float, bytes]) -> None: -15 15 | ... -16 16 | -17 17 | -UP007.py:14:26: UP007 [*] Use `X | Y` for type annotations +UP007.py:13:10: UP007 [*] Use `X | Y` for type annotations | -14 | def f(x: Union[str, int, Union[float, bytes]]) -> None: - | ^^^^^^^^^^^^^^^^^^^ UP007 -15 | ... +13 | def f(x: typing.Union[(str, int)]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +14 | ... | = help: Convert to `X | Y` ℹ Safe fix -11 11 | ... +10 10 | ... +11 11 | 12 12 | -13 13 | -14 |-def f(x: Union[str, int, Union[float, bytes]]) -> None: - 14 |+def f(x: Union[str, int, float | bytes]) -> None: -15 15 | ... +13 |-def f(x: typing.Union[(str, int)]) -> None: + 13 |+def f(x: str | int) -> None: +14 14 | ... +15 15 | 16 16 | -17 17 | -UP007.py:18:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:17:10: UP007 [*] Use `X | Y` for type annotations | -18 | def f(x: typing.Union[str, int]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^ UP007 -19 | ... +17 | def f(x: typing.Union[(str, int), float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +18 | ... | = help: Convert to `X | Y` ℹ Safe fix -15 15 | ... +14 14 | ... +15 15 | 16 16 | -17 17 | -18 |-def f(x: typing.Union[str, int]) -> None: - 18 |+def f(x: str | int) -> None: -19 19 | ... +17 |-def f(x: typing.Union[(str, int), float]) -> None: + 17 |+def f(x: str | int | float) -> None: +18 18 | ... +19 19 | 20 20 | -21 21 | -UP007.py:22:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:21:10: UP007 [*] Use `X | Y` for type annotations | -22 | def f(x: typing.Union[(str, int)]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^^^ UP007 -23 | ... +21 | def f(x: typing.Union[(int,)]) -> None: + | ^^^^^^^^^^^^^^^^^^^^ UP007 +22 | ... | = help: Convert to `X | Y` ℹ Safe fix -19 19 | ... +18 18 | ... +19 19 | 20 20 | -21 21 | -22 |-def f(x: typing.Union[(str, int)]) -> None: - 22 |+def f(x: str | int) -> None: -23 23 | ... +21 |-def f(x: typing.Union[(int,)]) -> None: + 21 |+def f(x: int) -> None: +22 22 | ... +23 23 | 24 24 | -25 25 | -UP007.py:26:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:25:10: UP007 [*] Use `X | Y` for type annotations | -26 | def f(x: typing.Union[(str, int), float]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 -27 | ... +25 | def f(x: typing.Union[()]) -> None: + | ^^^^^^^^^^^^^^^^ UP007 +26 | ... | = help: Convert to `X | Y` ℹ Safe fix -23 23 | ... +22 22 | ... +23 23 | 24 24 | -25 25 | -26 |-def f(x: typing.Union[(str, int), float]) -> None: - 26 |+def f(x: str | int | float) -> None: -27 27 | ... +25 |-def f(x: typing.Union[()]) -> None: + 25 |+def f(x: ()) -> None: +26 26 | ... +27 27 | 28 28 | -29 29 | -UP007.py:30:10: UP007 [*] Use `X | Y` for type annotations +UP007.py:29:11: UP007 [*] Use `X | Y` for type annotations | -30 | def f(x: typing.Union[(int,)]) -> None: - | ^^^^^^^^^^^^^^^^^^^^ UP007 -31 | ... +29 | def f(x: "Union[str, int, Union[float, bytes]]") -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +30 | ... | = help: Convert to `X | Y` ℹ Safe fix -27 27 | ... +26 26 | ... +27 27 | 28 28 | -29 29 | -30 |-def f(x: typing.Union[(int,)]) -> None: - 30 |+def f(x: int) -> None: -31 31 | ... -32 32 | -33 33 | - -UP007.py:34:10: UP007 [*] Use `X | Y` for type annotations - | -34 | def f(x: typing.Union[()]) -> None: - | ^^^^^^^^^^^^^^^^ UP007 -35 | ... - | - = help: Convert to `X | Y` - -ℹ Safe fix -31 31 | ... +29 |-def f(x: "Union[str, int, Union[float, bytes]]") -> None: + 29 |+def f(x: "str | int | Union[float, bytes]") -> None: +30 30 | ... +31 31 | 32 32 | -33 33 | -34 |-def f(x: typing.Union[()]) -> None: - 34 |+def f(x: ()) -> None: -35 35 | ... -36 36 | -37 37 | - -UP007.py:38:11: UP007 [*] Use `X | Y` for type annotations - | -38 | def f(x: "Union[str, int, Union[float, bytes]]") -> None: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 -39 | ... - | - = help: Convert to `X | Y` - -ℹ Safe fix -35 35 | ... -36 36 | -37 37 | -38 |-def f(x: "Union[str, int, Union[float, bytes]]") -> None: - 38 |+def f(x: "str | int | Union[float, bytes]") -> None: -39 39 | ... -40 40 | -41 41 | -UP007.py:38:27: UP007 [*] Use `X | Y` for type annotations +UP007.py:29:27: UP007 [*] Use `X | Y` for type annotations | -38 | def f(x: "Union[str, int, Union[float, bytes]]") -> None: +29 | def f(x: "Union[str, int, Union[float, bytes]]") -> None: | ^^^^^^^^^^^^^^^^^^^ UP007 -39 | ... +30 | ... | = help: Convert to `X | Y` ℹ Safe fix -35 35 | ... -36 36 | -37 37 | -38 |-def f(x: "Union[str, int, Union[float, bytes]]") -> None: - 38 |+def f(x: "Union[str, int, float | bytes]") -> None: -39 39 | ... -40 40 | -41 41 | +26 26 | ... +27 27 | +28 28 | +29 |-def f(x: "Union[str, int, Union[float, bytes]]") -> None: + 29 |+def f(x: "Union[str, int, float | bytes]") -> None: +30 30 | ... +31 31 | +32 32 | -UP007.py:42:11: UP007 [*] Use `X | Y` for type annotations +UP007.py:33:11: UP007 [*] Use `X | Y` for type annotations | -42 | def f(x: "typing.Union[str, int]") -> None: +33 | def f(x: "typing.Union[str, int]") -> None: | ^^^^^^^^^^^^^^^^^^^^^^ UP007 -43 | ... - | - = help: Convert to `X | Y` - -ℹ Safe fix -39 39 | ... -40 40 | -41 41 | -42 |-def f(x: "typing.Union[str, int]") -> None: - 42 |+def f(x: "str | int") -> None: -43 43 | ... -44 44 | -45 45 | - -UP007.py:55:8: UP007 [*] Use `X | Y` for type annotations - | -54 | def f() -> None: -55 | x: Optional[str] - | ^^^^^^^^^^^^^ UP007 -56 | x = Optional[str] +34 | ... | = help: Convert to `X | Y` ℹ Safe fix -52 52 | -53 53 | -54 54 | def f() -> None: -55 |- x: Optional[str] - 55 |+ x: str | None -56 56 | x = Optional[str] -57 57 | -58 58 | x = Union[str, int] - -UP007.py:56:9: UP007 Use `X | Y` for type annotations - | -54 | def f() -> None: -55 | x: Optional[str] -56 | x = Optional[str] - | ^^^^^^^^^^^^^ UP007 -57 | -58 | x = Union[str, int] - | - = help: Convert to `X | Y` +30 30 | ... +31 31 | +32 32 | +33 |-def f(x: "typing.Union[str, int]") -> None: + 33 |+def f(x: "str | int") -> None: +34 34 | ... +35 35 | +36 36 | -UP007.py:58:9: UP007 Use `X | Y` for type annotations +UP007.py:46:9: UP007 Use `X | Y` for type annotations | -56 | x = Optional[str] -57 | -58 | x = Union[str, int] +45 | def f() -> None: +46 | x = Union[str, int] | ^^^^^^^^^^^^^^^ UP007 -59 | x = Union["str", "int"] -60 | x: Union[str, int] +47 | x = Union["str", "int"] +48 | x: Union[str, int] | = help: Convert to `X | Y` -UP007.py:60:8: UP007 [*] Use `X | Y` for type annotations +UP007.py:48:8: UP007 [*] Use `X | Y` for type annotations | -58 | x = Union[str, int] -59 | x = Union["str", "int"] -60 | x: Union[str, int] +46 | x = Union[str, int] +47 | x = Union["str", "int"] +48 | x: Union[str, int] | ^^^^^^^^^^^^^^^ UP007 -61 | x: Union["str", "int"] +49 | x: Union["str", "int"] | = help: Convert to `X | Y` ℹ Safe fix -57 57 | -58 58 | x = Union[str, int] -59 59 | x = Union["str", "int"] -60 |- x: Union[str, int] - 60 |+ x: str | int -61 61 | x: Union["str", "int"] -62 62 | -63 63 | - -UP007.py:61:8: UP007 [*] Use `X | Y` for type annotations - | -59 | x = Union["str", "int"] -60 | x: Union[str, int] -61 | x: Union["str", "int"] +45 45 | def f() -> None: +46 46 | x = Union[str, int] +47 47 | x = Union["str", "int"] +48 |- x: Union[str, int] + 48 |+ x: str | int +49 49 | x: Union["str", "int"] +50 50 | +51 51 | + +UP007.py:49:8: UP007 [*] Use `X | Y` for type annotations + | +47 | x = Union["str", "int"] +48 | x: Union[str, int] +49 | x: Union["str", "int"] | ^^^^^^^^^^^^^^^^^^^ UP007 | = help: Convert to `X | Y` ℹ Safe fix -58 58 | x = Union[str, int] -59 59 | x = Union["str", "int"] -60 60 | x: Union[str, int] -61 |- x: Union["str", "int"] - 61 |+ x: "str" | "int" -62 62 | -63 63 | -64 64 | def f(x: Union[int : float]) -> None: - -UP007.py:64:10: UP007 Use `X | Y` for type annotations - | -64 | def f(x: Union[int : float]) -> None: +46 46 | x = Union[str, int] +47 47 | x = Union["str", "int"] +48 48 | x: Union[str, int] +49 |- x: Union["str", "int"] + 49 |+ x: "str" | "int" +50 50 | +51 51 | +52 52 | def f(x: Union[int : float]) -> None: + +UP007.py:52:10: UP007 Use `X | Y` for type annotations + | +52 | def f(x: Union[int : float]) -> None: | ^^^^^^^^^^^^^^^^^^ UP007 -65 | ... +53 | ... | = help: Convert to `X | Y` -UP007.py:68:10: UP007 Use `X | Y` for type annotations +UP007.py:56:10: UP007 Use `X | Y` for type annotations | -68 | def f(x: Union[str, int : float]) -> None: +56 | def f(x: Union[str, int : float]) -> None: | ^^^^^^^^^^^^^^^^^^^^^^^ UP007 -69 | ... +57 | ... | = help: Convert to `X | Y` -UP007.py:72:10: UP007 Use `X | Y` for type annotations +UP007.py:60:10: UP007 Use `X | Y` for type annotations | -72 | def f(x: Union[x := int]) -> None: +60 | def f(x: Union[x := int]) -> None: | ^^^^^^^^^^^^^^^ UP007 -73 | ... +61 | ... | = help: Convert to `X | Y` -UP007.py:76:10: UP007 Use `X | Y` for type annotations +UP007.py:64:10: UP007 Use `X | Y` for type annotations | -76 | def f(x: Union[str, x := int]) -> None: +64 | def f(x: Union[str, x := int]) -> None: | ^^^^^^^^^^^^^^^^^^^^ UP007 -77 | ... +65 | ... | = help: Convert to `X | Y` -UP007.py:80:10: UP007 Use `X | Y` for type annotations +UP007.py:68:10: UP007 Use `X | Y` for type annotations | -80 | def f(x: Union[lambda: int]) -> None: +68 | def f(x: Union[lambda: int]) -> None: | ^^^^^^^^^^^^^^^^^^ UP007 -81 | ... +69 | ... | = help: Convert to `X | Y` -UP007.py:84:10: UP007 Use `X | Y` for type annotations +UP007.py:72:10: UP007 Use `X | Y` for type annotations | -84 | def f(x: Union[str, lambda: int]) -> None: +72 | def f(x: Union[str, lambda: int]) -> None: | ^^^^^^^^^^^^^^^^^^^^^^^ UP007 -85 | ... +73 | ... | = help: Convert to `X | Y` -UP007.py:88:10: UP007 Use `X | Y` for type annotations +UP007.py:83:10: UP007 [*] Use `X | Y` for type annotations | -88 | def f(x: Optional[int : float]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^ UP007 -89 | ... +82 | # Regression test for: https://github.com/astral-sh/ruff/issues/8609 +83 | def f(x: Union[int, str, bytes]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^ UP007 +84 | ... | = help: Convert to `X | Y` -UP007.py:92:10: UP007 Use `X | Y` for type annotations - | -92 | def f(x: Optional[str, int : float]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 -93 | ... - | - = help: Convert to `X | Y` +ℹ Safe fix +80 80 | +81 81 | +82 82 | # Regression test for: https://github.com/astral-sh/ruff/issues/8609 +83 |-def f(x: Union[int, str, bytes]) -> None: + 83 |+def f(x: int | str | bytes) -> None: +84 84 | ... +85 85 | +86 86 | -UP007.py:96:10: UP007 Use `X | Y` for type annotations +UP007.py:91:26: UP007 [*] Use `X | Y` for type annotations | -96 | def f(x: Optional[int, float]) -> None: - | ^^^^^^^^^^^^^^^^^^^^ UP007 -97 | ... +89 | ... +90 | +91 | def myfunc(param: "tuple[Union[int, 'AClass', None], str]"): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +92 | print(param) | = help: Convert to `X | Y` -UP007.py:102:28: UP007 [*] Use `X | Y` for type annotations - | -100 | # Regression test for: https://github.com/astral-sh/ruff/issues/7131 -101 | class ServiceRefOrValue: -102 | service_specification: Optional[ - | ____________________________^ -103 | | list[ServiceSpecificationRef] -104 | | | list[ServiceSpecification] -105 | | ] = None - | |_____^ UP007 - | - = help: Convert to `X | Y` - -ℹ Safe fix -99 99 | -100 100 | # Regression test for: https://github.com/astral-sh/ruff/issues/7131 -101 101 | class ServiceRefOrValue: -102 |- service_specification: Optional[ -103 |- list[ServiceSpecificationRef] -104 |- | list[ServiceSpecification] -105 |- ] = None - 102 |+ service_specification: list[ServiceSpecificationRef] | list[ServiceSpecification] | None = None -106 103 | -107 104 | -108 105 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 - -UP007.py:110:28: UP007 [*] Use `X | Y` for type annotations - | -108 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 -109 | class ServiceRefOrValue: -110 | service_specification: Optional[str]is not True = None - | ^^^^^^^^^^^^^ UP007 - | - = help: Convert to `X | Y` - -ℹ Safe fix -107 107 | -108 108 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 -109 109 | class ServiceRefOrValue: -110 |- service_specification: Optional[str]is not True = None - 110 |+ service_specification: str | None is not True = None -111 111 | -112 112 | -113 113 | # Regression test for: https://github.com/astral-sh/ruff/issues/7452 - -UP007.py:120:10: UP007 [*] Use `X | Y` for type annotations - | -119 | # Regression test for: https://github.com/astral-sh/ruff/issues/8609 -120 | def f(x: Union[int, str, bytes]) -> None: - | ^^^^^^^^^^^^^^^^^^^^^^ UP007 -121 | ... - | - = help: Convert to `X | Y` - ℹ Safe fix -117 117 | -118 118 | -119 119 | # Regression test for: https://github.com/astral-sh/ruff/issues/8609 -120 |-def f(x: Union[int, str, bytes]) -> None: - 120 |+def f(x: int | str | bytes) -> None: -121 121 | ... - - +88 88 | class AClass: +89 89 | ... +90 90 | +91 |-def myfunc(param: "tuple[Union[int, 'AClass', None], str]"): + 91 |+def myfunc(param: "tuple[int | 'AClass' | None, str]"): +92 92 | print(param) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP008.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP008.py.snap index da6e68284da36..45c029d2d08aa 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP008.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP008.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP008.py:17:23: UP008 [*] Use `super()` instead of `super(__class__, self)` | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_0.py.snap index c4e69c7ea1376..496c05b80457a 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_0.py.snap @@ -5,7 +5,7 @@ UP009_0.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary | 1 | # coding=utf8 | ^^^^^^^^^^^^^ UP009 -2 | +2 | 3 | print("Hello world") | = help: Remove unnecessary coding comment @@ -14,5 +14,3 @@ UP009_0.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary 1 |-# coding=utf8 2 1 | 3 2 | print("Hello world") - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_1.py.snap index b1b25e0d3299f..5b64115e35584 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_1.py.snap @@ -6,7 +6,7 @@ UP009_1.py:2:1: UP009 [*] UTF-8 encoding declaration is unnecessary 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- | ^^^^^^^^^^^^^^^^^^^^^^^ UP009 -3 | +3 | 4 | print('Hello world') | = help: Remove unnecessary coding comment @@ -16,5 +16,3 @@ UP009_1.py:2:1: UP009 [*] UTF-8 encoding declaration is unnecessary 2 |-# -*- coding: utf-8 -*- 3 2 | 4 3 | print('Hello world') - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_10.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_10.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_10.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_10.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_2.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_2.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_2.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_3.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_3.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_3.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_4.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_4.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_4.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_4.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_5.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_5.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_5.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_5.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_6.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_6.py.snap index 01bbf87c0012d..b588ce12d9d90 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_6.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_6.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP009_6.py:1:2: UP009 [*] UTF-8 encoding declaration is unnecessary | @@ -14,5 +15,3 @@ UP009_6.py:1:2: UP009 [*] UTF-8 encoding declaration is unnecessary 2 1 | print("Hello world") 3 2 | 4 3 | """ - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_7.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_7.py.snap index 8439a0715cb29..ee89c5f61a5d5 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_7.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_7.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP009_7.py:1:2: UP009 [*] UTF-8 encoding declaration is unnecessary | @@ -14,5 +15,3 @@ UP009_7.py:1:2: UP009 [*] UTF-8 encoding declaration is unnecessary 2 1 | print("Hello world") 3 2 | 4 3 | """ - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_8.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_8.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_8.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_8.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_9.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_9.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_9.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_9.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_code_utf8_utf8.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_code_utf8_utf8.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_code_utf8_utf8.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_hashbang_utf8_other.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_hashbang_utf8_other.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_hashbang_utf8_other.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_many_empty_lines.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_many_empty_lines.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_many_empty_lines.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_other.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_other.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_other.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_utf8.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_utf8.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_other_utf8.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_code_other.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_code_other.py.snap new file mode 100644 index 0000000000000..ac9c9e5a45287 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_code_other.py.snap @@ -0,0 +1,17 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP009_utf8_code_other.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary + | +1 | # -*- coding: utf8 -*- + | ^^^^^^^^^^^^^^^^^^^^^^ UP009 +2 | print("the following is not a coding comment") +3 | # -*- coding: ascii -*- + | + = help: Remove unnecessary coding comment + +ℹ Safe fix +1 |-# -*- coding: utf8 -*- +2 1 | print("the following is not a coding comment") +3 2 | # -*- coding: ascii -*- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_other.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_other.py.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_other.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8.py.snap new file mode 100644 index 0000000000000..71358de177a9c --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8.py.snap @@ -0,0 +1,15 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP009_utf8_utf8.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary + | +1 | # -*- coding: utf-8 -*- + | ^^^^^^^^^^^^^^^^^^^^^^^ UP009 +2 | # -*- coding: utf-8 -*- + | + = help: Remove unnecessary coding comment + +ℹ Safe fix +1 1 | # -*- coding: utf-8 -*- +2 |-# -*- coding: utf-8 -*- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8_other.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8_other.py.snap new file mode 100644 index 0000000000000..42a521a4b0622 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP009_utf8_utf8_other.py.snap @@ -0,0 +1,17 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP009_utf8_utf8_other.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary + | +1 | # -*- coding: utf-8 -*- + | ^^^^^^^^^^^^^^^^^^^^^^^ UP009 +2 | # -*- coding: utf-8 -*- +3 | # -*- coding: ascii -*- + | + = help: Remove unnecessary coding comment + +ℹ Safe fix +1 1 | # -*- coding: utf-8 -*- +2 |-# -*- coding: utf-8 -*- +3 2 | # -*- coding: ascii -*- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP010.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP010.py.snap index d72c8e2fbbd25..89d50cf2f49f8 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP010.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP010.py.snap @@ -97,7 +97,7 @@ UP010.py:6:1: UP010 [*] Unnecessary `__future__` import `generators` for target 5 | from __future__ import print_function, generator_stop 6 | from __future__ import invalid_module, generators | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP010 -7 | +7 | 8 | if True: | = help: Remove unnecessary `__future__` import @@ -136,7 +136,7 @@ UP010.py:10:5: UP010 [*] Unnecessary `__future__` import `generators` for target 9 | from __future__ import generator_stop 10 | from __future__ import generators | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP010 -11 | +11 | 12 | if True: | = help: Remove unnecessary `__future__` import @@ -181,5 +181,3 @@ UP010.py:14:5: UP010 [*] Unnecessary `__future__` import `generators` for target 13 13 | from __future__ import generator_stop 14 |- from __future__ import invalid_module, generators 14 |+ from __future__ import invalid_module - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP011.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP011.py.snap index e672749216748..7fb2e270ca022 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP011.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP011.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP011.py:5:21: UP011 [*] Unnecessary parentheses to `functools.lru_cache` | @@ -77,5 +78,3 @@ UP011.py:21:21: UP011 [*] Unnecessary parentheses to `functools.lru_cache` 22 22 | @other_decorator 23 23 | def fixme(): 24 24 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP012.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP012.py.snap index f19df78488866..99b2f05d6e28e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP012.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP012.py.snap @@ -129,7 +129,7 @@ UP012.py:8:1: UP012 [*] Unnecessary call to `encode` as UTF-8 7 | "foo".encode(encoding="utf-8") # b"foo" 8 | / """ 9 | | Lorem -10 | | +10 | | 11 | | Ipsum 12 | | """.encode( 13 | | "utf-8" @@ -161,8 +161,7 @@ UP012.py:16:5: UP012 [*] Unnecessary call to `encode` as UTF-8 | 14 | ) 15 | ( -16 | "Lorem " - | _____^ +16 | / "Lorem " 17 | | "Ipsum".encode() | |____________________^ UP012 18 | ) @@ -186,8 +185,7 @@ UP012.py:20:5: UP012 [*] Unnecessary call to `encode` as UTF-8 | 18 | ) 19 | ( -20 | "Lorem " # Comment - | _____^ +20 | / "Lorem " # Comment 21 | | "Ipsum".encode() # Comment | |____________________^ UP012 22 | ) @@ -255,7 +253,7 @@ UP012.py:36:1: UP012 [*] Unnecessary UTF-8 `encoding` argument to `encode` 37 | | "utf-8", 38 | | ) | |_^ UP012 -39 | +39 | 40 | # `encode` with custom args and kwargs should not be processed. | = help: Remove unnecessary `encoding` argument @@ -298,7 +296,7 @@ UP012.py:55:1: UP012 [*] Unnecessary UTF-8 `encoding` argument to `encode` 54 | "unicode text©".encode() 55 | "unicode text©".encode(encoding="UTF8") # "unicode text©".encode() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP012 -56 | +56 | 57 | r"foo\o".encode("utf-8") # br"foo\o" | = help: Remove unnecessary `encoding` argument @@ -316,7 +314,7 @@ UP012.py:55:1: UP012 [*] Unnecessary UTF-8 `encoding` argument to `encode` UP012.py:57:1: UP012 [*] Unnecessary call to `encode` as UTF-8 | 55 | "unicode text©".encode(encoding="UTF8") # "unicode text©".encode() -56 | +56 | 57 | r"foo\o".encode("utf-8") # br"foo\o" | ^^^^^^^^^^^^^^^^^^^^^^^^ UP012 58 | u"foo".encode("utf-8") # b"foo" @@ -401,7 +399,7 @@ UP012.py:61:7: UP012 [*] Unnecessary call to `encode` as UTF-8 60 | U"foo".encode("utf-8") # b"foo" 61 | print("foo".encode()) # print(b"foo") | ^^^^^^^^^^^^^^ UP012 -62 | +62 | 63 | # `encode` on parenthesized strings. | = help: Rewrite as bytes literal @@ -424,7 +422,7 @@ UP012.py:64:1: UP012 [*] Unnecessary call to `encode` as UTF-8 66 | | "def" 67 | | ).encode() | |__________^ UP012 -68 | +68 | 69 | (( | = help: Rewrite as bytes literal @@ -446,13 +444,13 @@ UP012.py:64:1: UP012 [*] Unnecessary call to `encode` as UTF-8 UP012.py:69:1: UP012 [*] Unnecessary call to `encode` as UTF-8 | 67 | ).encode() -68 | +68 | 69 | / (( 70 | | "abc" 71 | | "def" 72 | | )).encode() | |___________^ UP012 -73 | +73 | 74 | (f"foo{bar}").encode("utf-8") | = help: Rewrite as bytes literal @@ -474,7 +472,7 @@ UP012.py:69:1: UP012 [*] Unnecessary call to `encode` as UTF-8 UP012.py:74:1: UP012 [*] Unnecessary UTF-8 `encoding` argument to `encode` | 72 | )).encode() -73 | +73 | 74 | (f"foo{bar}").encode("utf-8") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP012 75 | (f"foo{bar}").encode(encoding="utf-8") @@ -557,7 +555,7 @@ UP012.py:82:17: UP012 [*] Unnecessary call to `encode` as UTF-8 81 | def _match_ignore(line): 82 | input=stdin and'\n'.encode()or None | ^^^^^^^^^^^^^ UP012 -83 | +83 | 84 | # Not a valid type annotation but this test shouldn't result in a panic. | = help: Rewrite as bytes literal diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP013.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP013.py.snap index d03ec38c485f4..f428a3a4d7e82 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP013.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP013.py.snap @@ -6,7 +6,7 @@ UP013.py:5:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class sy 4 | # dict literal 5 | MyType = TypedDict("MyType", {"a": int, "b": str}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -6 | +6 | 7 | # dict call | = help: Convert `MyType` to class syntax @@ -28,7 +28,7 @@ UP013.py:8:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class sy 7 | # dict call 8 | MyType = TypedDict("MyType", dict(a=int, b=str)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 - 9 | + 9 | 10 | # kwargs | = help: Convert `MyType` to class syntax @@ -50,7 +50,7 @@ UP013.py:11:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 10 | # kwargs 11 | MyType = TypedDict("MyType", a=int, b=str) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -12 | +12 | 13 | # Empty TypedDict | = help: Convert `MyType` to class syntax @@ -72,7 +72,7 @@ UP013.py:14:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 13 | # Empty TypedDict 14 | MyType = TypedDict("MyType") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -15 | +15 | 16 | # Literal values | = help: Convert `MyType` to class syntax @@ -114,7 +114,7 @@ UP013.py:18:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 17 | MyType = TypedDict("MyType", {"a": "hello"}) 18 | MyType = TypedDict("MyType", a="hello") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -19 | +19 | 20 | # NotRequired | = help: Convert `MyType` to class syntax @@ -135,7 +135,7 @@ UP013.py:21:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 20 | # NotRequired 21 | MyType = TypedDict("MyType", {"a": NotRequired[dict]}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -22 | +22 | 23 | # total | = help: Convert `MyType` to class syntax @@ -156,7 +156,7 @@ UP013.py:24:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 23 | # total 24 | MyType = TypedDict("MyType", {"x": int, "y": int}, total=False) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -25 | +25 | 26 | # using Literal type | = help: Convert `MyType` to class syntax @@ -178,7 +178,7 @@ UP013.py:27:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 26 | # using Literal type 27 | MyType = TypedDict("MyType", {"key": Literal["value"]}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -28 | +28 | 29 | # using namespace TypedDict | = help: Convert `MyType` to class syntax @@ -199,7 +199,7 @@ UP013.py:30:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 29 | # using namespace TypedDict 30 | MyType = typing.TypedDict("MyType", {"key": int}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -31 | +31 | 32 | # invalid identifiers (OK) | = help: Convert `MyType` to class syntax @@ -220,7 +220,7 @@ UP013.py:40:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 39 | # Empty dict literal 40 | MyType = TypedDict("MyType", {}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 -41 | +41 | 42 | # Empty dict call | = help: Convert `MyType` to class syntax @@ -241,6 +241,8 @@ UP013.py:43:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 42 | # Empty dict call 43 | MyType = TypedDict("MyType", dict()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP013 +44 | +45 | # Unsafe fix if comments are present | = help: Convert `MyType` to class syntax @@ -251,5 +253,31 @@ UP013.py:43:1: UP013 [*] Convert `MyType` from `TypedDict` functional to class s 43 |-MyType = TypedDict("MyType", dict()) 43 |+class MyType(TypedDict): 44 |+ pass +44 45 | +45 46 | # Unsafe fix if comments are present +46 47 | X = TypedDict("X", { +UP013.py:46:1: UP013 [*] Convert `X` from `TypedDict` functional to class syntax + | +45 | # Unsafe fix if comments are present +46 | / X = TypedDict("X", { +47 | | "some_config": int, # important +48 | | }) + | |__^ UP013 +49 | +50 | # Private names should not be reported (OK) + | + = help: Convert `X` to class syntax +ℹ Unsafe fix +43 43 | MyType = TypedDict("MyType", dict()) +44 44 | +45 45 | # Unsafe fix if comments are present +46 |-X = TypedDict("X", { +47 |- "some_config": int, # important +48 |-}) + 46 |+class X(TypedDict): + 47 |+ some_config: int +49 48 | +50 49 | # Private names should not be reported (OK) +51 50 | WithPrivate = TypedDict("WithPrivate", {"__x": int}) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP014.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP014.py.snap index 71ce3308f55a5..24aec45ab885e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP014.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP014.py.snap @@ -6,7 +6,7 @@ UP014.py:5:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class s 4 | # with complex annotations 5 | MyType = NamedTuple("MyType", [("a", int), ("b", tuple[str, ...])]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP014 -6 | +6 | 7 | # with namespace | = help: Convert `MyType` to class syntax @@ -28,7 +28,7 @@ UP014.py:8:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class s 7 | # with namespace 8 | MyType = typing.NamedTuple("MyType", [("a", int), ("b", str)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP014 - 9 | + 9 | 10 | # invalid identifiers (OK) | = help: Convert `MyType` to class syntax @@ -50,7 +50,7 @@ UP014.py:14:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class 13 | # no fields 14 | MyType = typing.NamedTuple("MyType") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP014 -15 | +15 | 16 | # empty fields | = help: Convert `MyType` to class syntax @@ -71,7 +71,7 @@ UP014.py:17:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class 16 | # empty fields 17 | MyType = typing.NamedTuple("MyType", []) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP014 -18 | +18 | 19 | # keywords | = help: Convert `MyType` to class syntax @@ -92,7 +92,7 @@ UP014.py:20:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class 19 | # keywords 20 | MyType = typing.NamedTuple("MyType", a=int, b=tuple[str, ...]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP014 -21 | +21 | 22 | # unfixable | = help: Convert `MyType` to class syntax @@ -109,4 +109,23 @@ UP014.py:20:1: UP014 [*] Convert `MyType` from `NamedTuple` functional to class 22 24 | # unfixable 23 25 | MyType = typing.NamedTuple("MyType", [("a", int)], [("b", str)]) +UP014.py:36:1: UP014 [*] Convert `X` from `NamedTuple` functional to class syntax + | +35 | # Unsafe fix if comments are present +36 | / X = NamedTuple("X", [ +37 | | ("some_config", int), # important +38 | | ]) + | |__^ UP014 + | + = help: Convert `X` to class syntax +ℹ Unsafe fix +33 33 | ) +34 34 | +35 35 | # Unsafe fix if comments are present +36 |-X = NamedTuple("X", [ +37 |- ("some_config", int), # important +38 |-]) + 36 |+class X(NamedTuple): + 37 |+ some_config: int +39 38 | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015.py.snap index 054bc00ec8c73..b265b7e8030fc 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs --- -UP015.py:1:1: UP015 [*] Unnecessary open mode parameters +UP015.py:1:13: UP015 [*] Unnecessary mode argument | 1 | open("foo", "U") - | ^^^^^^^^^^^^^^^^ UP015 + | ^^^ UP015 2 | open("foo", "Ur") 3 | open("foo", "Ub") | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 1 |-open("foo", "U") @@ -17,15 +17,15 @@ UP015.py:1:1: UP015 [*] Unnecessary open mode parameters 3 3 | open("foo", "Ub") 4 4 | open("foo", "rUb") -UP015.py:2:1: UP015 [*] Unnecessary open mode parameters +UP015.py:2:13: UP015 [*] Unnecessary mode argument | 1 | open("foo", "U") 2 | open("foo", "Ur") - | ^^^^^^^^^^^^^^^^^ UP015 + | ^^^^ UP015 3 | open("foo", "Ub") 4 | open("foo", "rUb") | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 1 1 | open("foo", "U") @@ -35,16 +35,16 @@ UP015.py:2:1: UP015 [*] Unnecessary open mode parameters 4 4 | open("foo", "rUb") 5 5 | open("foo", "r") -UP015.py:3:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" +UP015.py:3:13: UP015 [*] Unnecessary modes, use `rb` | 1 | open("foo", "U") 2 | open("foo", "Ur") 3 | open("foo", "Ub") - | ^^^^^^^^^^^^^^^^^ UP015 + | ^^^^ UP015 4 | open("foo", "rUb") 5 | open("foo", "r") | - = help: Replace with ""rb"" + = help: Replace with `rb` ℹ Safe fix 1 1 | open("foo", "U") @@ -55,16 +55,16 @@ UP015.py:3:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" 5 5 | open("foo", "r") 6 6 | open("foo", "rt") -UP015.py:4:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" +UP015.py:4:13: UP015 [*] Unnecessary modes, use `rb` | 2 | open("foo", "Ur") 3 | open("foo", "Ub") 4 | open("foo", "rUb") - | ^^^^^^^^^^^^^^^^^^ UP015 + | ^^^^^ UP015 5 | open("foo", "r") 6 | open("foo", "rt") | - = help: Replace with ""rb"" + = help: Replace with `rb` ℹ Safe fix 1 1 | open("foo", "U") @@ -76,16 +76,16 @@ UP015.py:4:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" 6 6 | open("foo", "rt") 7 7 | open("f", "r", encoding="UTF-8") -UP015.py:5:1: UP015 [*] Unnecessary open mode parameters +UP015.py:5:13: UP015 [*] Unnecessary mode argument | 3 | open("foo", "Ub") 4 | open("foo", "rUb") 5 | open("foo", "r") - | ^^^^^^^^^^^^^^^^ UP015 + | ^^^ UP015 6 | open("foo", "rt") 7 | open("f", "r", encoding="UTF-8") | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 2 2 | open("foo", "Ur") @@ -97,16 +97,16 @@ UP015.py:5:1: UP015 [*] Unnecessary open mode parameters 7 7 | open("f", "r", encoding="UTF-8") 8 8 | open("f", "wt") -UP015.py:6:1: UP015 [*] Unnecessary open mode parameters +UP015.py:6:13: UP015 [*] Unnecessary mode argument | 4 | open("foo", "rUb") 5 | open("foo", "r") 6 | open("foo", "rt") - | ^^^^^^^^^^^^^^^^^ UP015 + | ^^^^ UP015 7 | open("f", "r", encoding="UTF-8") 8 | open("f", "wt") | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 3 3 | open("foo", "Ub") @@ -116,17 +116,18 @@ UP015.py:6:1: UP015 [*] Unnecessary open mode parameters 6 |+open("foo") 7 7 | open("f", "r", encoding="UTF-8") 8 8 | open("f", "wt") -9 9 | +9 9 | open("f", "tw") -UP015.py:7:1: UP015 [*] Unnecessary open mode parameters +UP015.py:7:11: UP015 [*] Unnecessary mode argument | 5 | open("foo", "r") 6 | open("foo", "rt") 7 | open("f", "r", encoding="UTF-8") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 + | ^^^ UP015 8 | open("f", "wt") +9 | open("f", "tw") | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 4 4 | open("foo", "rUb") @@ -135,19 +136,18 @@ UP015.py:7:1: UP015 [*] Unnecessary open mode parameters 7 |-open("f", "r", encoding="UTF-8") 7 |+open("f", encoding="UTF-8") 8 8 | open("f", "wt") -9 9 | -10 10 | with open("foo", "U") as f: +9 9 | open("f", "tw") +10 10 | -UP015.py:8:1: UP015 [*] Unnecessary open mode parameters, use ""w"" - | - 6 | open("foo", "rt") - 7 | open("f", "r", encoding="UTF-8") - 8 | open("f", "wt") - | ^^^^^^^^^^^^^^^ UP015 - 9 | -10 | with open("foo", "U") as f: - | - = help: Replace with ""w"" +UP015.py:8:11: UP015 [*] Unnecessary modes, use `w` + | +6 | open("foo", "rt") +7 | open("f", "r", encoding="UTF-8") +8 | open("f", "wt") + | ^^^^ UP015 +9 | open("f", "tw") + | + = help: Replace with `w` ℹ Safe fix 5 5 | open("foo", "r") @@ -155,799 +155,828 @@ UP015.py:8:1: UP015 [*] Unnecessary open mode parameters, use ""w"" 7 7 | open("f", "r", encoding="UTF-8") 8 |-open("f", "wt") 8 |+open("f", "w") -9 9 | -10 10 | with open("foo", "U") as f: -11 11 | pass +9 9 | open("f", "tw") +10 10 | +11 11 | with open("foo", "U") as f: -UP015.py:10:6: UP015 [*] Unnecessary open mode parameters +UP015.py:9:11: UP015 [*] Unnecessary modes, use `w` | + 7 | open("f", "r", encoding="UTF-8") 8 | open("f", "wt") - 9 | -10 | with open("foo", "U") as f: - | ^^^^^^^^^^^^^^^^ UP015 -11 | pass -12 | with open("foo", "Ur") as f: + 9 | open("f", "tw") + | ^^^^ UP015 +10 | +11 | with open("foo", "U") as f: | - = help: Remove open mode parameters + = help: Replace with `w` ℹ Safe fix +6 6 | open("foo", "rt") 7 7 | open("f", "r", encoding="UTF-8") 8 8 | open("f", "wt") -9 9 | -10 |-with open("foo", "U") as f: - 10 |+with open("foo") as f: -11 11 | pass -12 12 | with open("foo", "Ur") as f: -13 13 | pass - -UP015.py:12:6: UP015 [*] Unnecessary open mode parameters - | -10 | with open("foo", "U") as f: -11 | pass -12 | with open("foo", "Ur") as f: - | ^^^^^^^^^^^^^^^^^ UP015 -13 | pass -14 | with open("foo", "Ub") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -9 9 | -10 10 | with open("foo", "U") as f: -11 11 | pass -12 |-with open("foo", "Ur") as f: - 12 |+with open("foo") as f: -13 13 | pass -14 14 | with open("foo", "Ub") as f: -15 15 | pass - -UP015.py:14:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -12 | with open("foo", "Ur") as f: -13 | pass -14 | with open("foo", "Ub") as f: - | ^^^^^^^^^^^^^^^^^ UP015 -15 | pass -16 | with open("foo", "rUb") as f: - | - = help: Replace with ""rb"" - -ℹ Safe fix -11 11 | pass -12 12 | with open("foo", "Ur") as f: -13 13 | pass -14 |-with open("foo", "Ub") as f: - 14 |+with open("foo", "rb") as f: -15 15 | pass -16 16 | with open("foo", "rUb") as f: -17 17 | pass - -UP015.py:16:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -14 | with open("foo", "Ub") as f: -15 | pass -16 | with open("foo", "rUb") as f: - | ^^^^^^^^^^^^^^^^^^ UP015 -17 | pass -18 | with open("foo", "r") as f: - | - = help: Replace with ""rb"" - -ℹ Safe fix -13 13 | pass -14 14 | with open("foo", "Ub") as f: -15 15 | pass -16 |-with open("foo", "rUb") as f: - 16 |+with open("foo", "rb") as f: -17 17 | pass -18 18 | with open("foo", "r") as f: -19 19 | pass - -UP015.py:18:6: UP015 [*] Unnecessary open mode parameters - | -16 | with open("foo", "rUb") as f: -17 | pass -18 | with open("foo", "r") as f: - | ^^^^^^^^^^^^^^^^ UP015 -19 | pass -20 | with open("foo", "rt") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -15 15 | pass -16 16 | with open("foo", "rUb") as f: -17 17 | pass -18 |-with open("foo", "r") as f: - 18 |+with open("foo") as f: -19 19 | pass -20 20 | with open("foo", "rt") as f: -21 21 | pass - -UP015.py:20:6: UP015 [*] Unnecessary open mode parameters - | -18 | with open("foo", "r") as f: -19 | pass -20 | with open("foo", "rt") as f: - | ^^^^^^^^^^^^^^^^^ UP015 -21 | pass -22 | with open("foo", "r", encoding="UTF-8") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -17 17 | pass -18 18 | with open("foo", "r") as f: -19 19 | pass -20 |-with open("foo", "rt") as f: - 20 |+with open("foo") as f: -21 21 | pass -22 22 | with open("foo", "r", encoding="UTF-8") as f: -23 23 | pass - -UP015.py:22:6: UP015 [*] Unnecessary open mode parameters - | -20 | with open("foo", "rt") as f: -21 | pass -22 | with open("foo", "r", encoding="UTF-8") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -23 | pass -24 | with open("foo", "wt") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -19 19 | pass -20 20 | with open("foo", "rt") as f: -21 21 | pass -22 |-with open("foo", "r", encoding="UTF-8") as f: - 22 |+with open("foo", encoding="UTF-8") as f: -23 23 | pass -24 24 | with open("foo", "wt") as f: -25 25 | pass - -UP015.py:24:6: UP015 [*] Unnecessary open mode parameters, use ""w"" - | -22 | with open("foo", "r", encoding="UTF-8") as f: -23 | pass -24 | with open("foo", "wt") as f: - | ^^^^^^^^^^^^^^^^^ UP015 -25 | pass - | - = help: Replace with ""w"" - -ℹ Safe fix -21 21 | pass -22 22 | with open("foo", "r", encoding="UTF-8") as f: -23 23 | pass -24 |-with open("foo", "wt") as f: - 24 |+with open("foo", "w") as f: -25 25 | pass -26 26 | -27 27 | open(f("a", "b", "c"), "U") - -UP015.py:27:1: UP015 [*] Unnecessary open mode parameters - | -25 | pass -26 | -27 | open(f("a", "b", "c"), "U") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -28 | open(f("a", "b", "c"), "Ub") - | - = help: Remove open mode parameters - -ℹ Safe fix -24 24 | with open("foo", "wt") as f: -25 25 | pass -26 26 | -27 |-open(f("a", "b", "c"), "U") - 27 |+open(f("a", "b", "c")) -28 28 | open(f("a", "b", "c"), "Ub") -29 29 | -30 30 | with open(f("a", "b", "c"), "U") as f: - -UP015.py:28:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -27 | open(f("a", "b", "c"), "U") -28 | open(f("a", "b", "c"), "Ub") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -29 | -30 | with open(f("a", "b", "c"), "U") as f: - | - = help: Replace with ""rb"" - -ℹ Safe fix -25 25 | pass -26 26 | -27 27 | open(f("a", "b", "c"), "U") -28 |-open(f("a", "b", "c"), "Ub") - 28 |+open(f("a", "b", "c"), "rb") -29 29 | -30 30 | with open(f("a", "b", "c"), "U") as f: -31 31 | pass - -UP015.py:30:6: UP015 [*] Unnecessary open mode parameters - | -28 | open(f("a", "b", "c"), "Ub") -29 | -30 | with open(f("a", "b", "c"), "U") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -31 | pass -32 | with open(f("a", "b", "c"), "Ub") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -27 27 | open(f("a", "b", "c"), "U") -28 28 | open(f("a", "b", "c"), "Ub") -29 29 | -30 |-with open(f("a", "b", "c"), "U") as f: - 30 |+with open(f("a", "b", "c")) as f: -31 31 | pass -32 32 | with open(f("a", "b", "c"), "Ub") as f: -33 33 | pass - -UP015.py:32:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -30 | with open(f("a", "b", "c"), "U") as f: -31 | pass -32 | with open(f("a", "b", "c"), "Ub") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -33 | pass - | - = help: Replace with ""rb"" - -ℹ Safe fix -29 29 | -30 30 | with open(f("a", "b", "c"), "U") as f: -31 31 | pass -32 |-with open(f("a", "b", "c"), "Ub") as f: - 32 |+with open(f("a", "b", "c"), "rb") as f: -33 33 | pass -34 34 | -35 35 | with open("foo", "U") as fa, open("bar", "U") as fb: - -UP015.py:35:6: UP015 [*] Unnecessary open mode parameters - | -33 | pass -34 | -35 | with open("foo", "U") as fa, open("bar", "U") as fb: - | ^^^^^^^^^^^^^^^^ UP015 -36 | pass -37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - | - = help: Remove open mode parameters - -ℹ Safe fix -32 32 | with open(f("a", "b", "c"), "Ub") as f: -33 33 | pass -34 34 | -35 |-with open("foo", "U") as fa, open("bar", "U") as fb: - 35 |+with open("foo") as fa, open("bar", "U") as fb: -36 36 | pass -37 37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: -38 38 | pass - -UP015.py:35:30: UP015 [*] Unnecessary open mode parameters - | -33 | pass -34 | -35 | with open("foo", "U") as fa, open("bar", "U") as fb: - | ^^^^^^^^^^^^^^^^ UP015 -36 | pass -37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - | - = help: Remove open mode parameters - -ℹ Safe fix -32 32 | with open(f("a", "b", "c"), "Ub") as f: -33 33 | pass -34 34 | -35 |-with open("foo", "U") as fa, open("bar", "U") as fb: - 35 |+with open("foo", "U") as fa, open("bar") as fb: -36 36 | pass -37 37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: -38 38 | pass - -UP015.py:37:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -35 | with open("foo", "U") as fa, open("bar", "U") as fb: -36 | pass -37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - | ^^^^^^^^^^^^^^^^^ UP015 -38 | pass - | - = help: Replace with ""rb"" - -ℹ Safe fix -34 34 | -35 35 | with open("foo", "U") as fa, open("bar", "U") as fb: -36 36 | pass -37 |-with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - 37 |+with open("foo", "rb") as fa, open("bar", "Ub") as fb: -38 38 | pass -39 39 | -40 40 | open("foo", mode="U") - -UP015.py:37:31: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -35 | with open("foo", "U") as fa, open("bar", "U") as fb: -36 | pass -37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - | ^^^^^^^^^^^^^^^^^ UP015 -38 | pass - | - = help: Replace with ""rb"" - -ℹ Safe fix -34 34 | -35 35 | with open("foo", "U") as fa, open("bar", "U") as fb: -36 36 | pass -37 |-with open("foo", "Ub") as fa, open("bar", "Ub") as fb: - 37 |+with open("foo", "Ub") as fa, open("bar", "rb") as fb: -38 38 | pass -39 39 | -40 40 | open("foo", mode="U") +9 |-open("f", "tw") + 9 |+open("f", "w") +10 10 | +11 11 | with open("foo", "U") as f: +12 12 | pass -UP015.py:40:1: UP015 [*] Unnecessary open mode parameters +UP015.py:11:18: UP015 [*] Unnecessary mode argument | -38 | pass -39 | -40 | open("foo", mode="U") - | ^^^^^^^^^^^^^^^^^^^^^ UP015 -41 | open(name="foo", mode="U") -42 | open(mode="U", name="foo") - | - = help: Remove open mode parameters - -ℹ Safe fix -37 37 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: -38 38 | pass -39 39 | -40 |-open("foo", mode="U") - 40 |+open("foo") -41 41 | open(name="foo", mode="U") -42 42 | open(mode="U", name="foo") -43 43 | - -UP015.py:41:1: UP015 [*] Unnecessary open mode parameters + 9 | open("f", "tw") +10 | +11 | with open("foo", "U") as f: + | ^^^ UP015 +12 | pass +13 | with open("foo", "Ur") as f: | -40 | open("foo", mode="U") -41 | open(name="foo", mode="U") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -42 | open(mode="U", name="foo") - | - = help: Remove open mode parameters - -ℹ Safe fix -38 38 | pass -39 39 | -40 40 | open("foo", mode="U") -41 |-open(name="foo", mode="U") - 41 |+open(name="foo") -42 42 | open(mode="U", name="foo") -43 43 | -44 44 | with open("foo", mode="U") as f: - -UP015.py:42:1: UP015 [*] Unnecessary open mode parameters - | -40 | open("foo", mode="U") -41 | open(name="foo", mode="U") -42 | open(mode="U", name="foo") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -43 | -44 | with open("foo", mode="U") as f: - | - = help: Remove open mode parameters + = help: Remove mode argument -ℹ Safe fix -39 39 | -40 40 | open("foo", mode="U") -41 41 | open(name="foo", mode="U") -42 |-open(mode="U", name="foo") - 42 |+open(name="foo") -43 43 | -44 44 | with open("foo", mode="U") as f: -45 45 | pass - -UP015.py:44:6: UP015 [*] Unnecessary open mode parameters - | -42 | open(mode="U", name="foo") -43 | -44 | with open("foo", mode="U") as f: - | ^^^^^^^^^^^^^^^^^^^^^ UP015 -45 | pass -46 | with open(name="foo", mode="U") as f: - | - = help: Remove open mode parameters +ℹ Safe fix +8 8 | open("f", "wt") +9 9 | open("f", "tw") +10 10 | +11 |-with open("foo", "U") as f: + 11 |+with open("foo") as f: +12 12 | pass +13 13 | with open("foo", "Ur") as f: +14 14 | pass + +UP015.py:13:18: UP015 [*] Unnecessary mode argument + | +11 | with open("foo", "U") as f: +12 | pass +13 | with open("foo", "Ur") as f: + | ^^^^ UP015 +14 | pass +15 | with open("foo", "Ub") as f: + | + = help: Remove mode argument + +ℹ Safe fix +10 10 | +11 11 | with open("foo", "U") as f: +12 12 | pass +13 |-with open("foo", "Ur") as f: + 13 |+with open("foo") as f: +14 14 | pass +15 15 | with open("foo", "Ub") as f: +16 16 | pass + +UP015.py:15:18: UP015 [*] Unnecessary modes, use `rb` + | +13 | with open("foo", "Ur") as f: +14 | pass +15 | with open("foo", "Ub") as f: + | ^^^^ UP015 +16 | pass +17 | with open("foo", "rUb") as f: + | + = help: Replace with `rb` + +ℹ Safe fix +12 12 | pass +13 13 | with open("foo", "Ur") as f: +14 14 | pass +15 |-with open("foo", "Ub") as f: + 15 |+with open("foo", "rb") as f: +16 16 | pass +17 17 | with open("foo", "rUb") as f: +18 18 | pass + +UP015.py:17:18: UP015 [*] Unnecessary modes, use `rb` + | +15 | with open("foo", "Ub") as f: +16 | pass +17 | with open("foo", "rUb") as f: + | ^^^^^ UP015 +18 | pass +19 | with open("foo", "r") as f: + | + = help: Replace with `rb` + +ℹ Safe fix +14 14 | pass +15 15 | with open("foo", "Ub") as f: +16 16 | pass +17 |-with open("foo", "rUb") as f: + 17 |+with open("foo", "rb") as f: +18 18 | pass +19 19 | with open("foo", "r") as f: +20 20 | pass + +UP015.py:19:18: UP015 [*] Unnecessary mode argument + | +17 | with open("foo", "rUb") as f: +18 | pass +19 | with open("foo", "r") as f: + | ^^^ UP015 +20 | pass +21 | with open("foo", "rt") as f: + | + = help: Remove mode argument + +ℹ Safe fix +16 16 | pass +17 17 | with open("foo", "rUb") as f: +18 18 | pass +19 |-with open("foo", "r") as f: + 19 |+with open("foo") as f: +20 20 | pass +21 21 | with open("foo", "rt") as f: +22 22 | pass + +UP015.py:21:18: UP015 [*] Unnecessary mode argument + | +19 | with open("foo", "r") as f: +20 | pass +21 | with open("foo", "rt") as f: + | ^^^^ UP015 +22 | pass +23 | with open("foo", "r", encoding="UTF-8") as f: + | + = help: Remove mode argument + +ℹ Safe fix +18 18 | pass +19 19 | with open("foo", "r") as f: +20 20 | pass +21 |-with open("foo", "rt") as f: + 21 |+with open("foo") as f: +22 22 | pass +23 23 | with open("foo", "r", encoding="UTF-8") as f: +24 24 | pass + +UP015.py:23:18: UP015 [*] Unnecessary mode argument + | +21 | with open("foo", "rt") as f: +22 | pass +23 | with open("foo", "r", encoding="UTF-8") as f: + | ^^^ UP015 +24 | pass +25 | with open("foo", "wt") as f: + | + = help: Remove mode argument + +ℹ Safe fix +20 20 | pass +21 21 | with open("foo", "rt") as f: +22 22 | pass +23 |-with open("foo", "r", encoding="UTF-8") as f: + 23 |+with open("foo", encoding="UTF-8") as f: +24 24 | pass +25 25 | with open("foo", "wt") as f: +26 26 | pass + +UP015.py:25:18: UP015 [*] Unnecessary modes, use `w` + | +23 | with open("foo", "r", encoding="UTF-8") as f: +24 | pass +25 | with open("foo", "wt") as f: + | ^^^^ UP015 +26 | pass + | + = help: Replace with `w` + +ℹ Safe fix +22 22 | pass +23 23 | with open("foo", "r", encoding="UTF-8") as f: +24 24 | pass +25 |-with open("foo", "wt") as f: + 25 |+with open("foo", "w") as f: +26 26 | pass +27 27 | +28 28 | open(f("a", "b", "c"), "U") + +UP015.py:28:24: UP015 [*] Unnecessary mode argument + | +26 | pass +27 | +28 | open(f("a", "b", "c"), "U") + | ^^^ UP015 +29 | open(f("a", "b", "c"), "Ub") + | + = help: Remove mode argument + +ℹ Safe fix +25 25 | with open("foo", "wt") as f: +26 26 | pass +27 27 | +28 |-open(f("a", "b", "c"), "U") + 28 |+open(f("a", "b", "c")) +29 29 | open(f("a", "b", "c"), "Ub") +30 30 | +31 31 | with open(f("a", "b", "c"), "U") as f: + +UP015.py:29:24: UP015 [*] Unnecessary modes, use `rb` + | +28 | open(f("a", "b", "c"), "U") +29 | open(f("a", "b", "c"), "Ub") + | ^^^^ UP015 +30 | +31 | with open(f("a", "b", "c"), "U") as f: + | + = help: Replace with `rb` + +ℹ Safe fix +26 26 | pass +27 27 | +28 28 | open(f("a", "b", "c"), "U") +29 |-open(f("a", "b", "c"), "Ub") + 29 |+open(f("a", "b", "c"), "rb") +30 30 | +31 31 | with open(f("a", "b", "c"), "U") as f: +32 32 | pass + +UP015.py:31:29: UP015 [*] Unnecessary mode argument + | +29 | open(f("a", "b", "c"), "Ub") +30 | +31 | with open(f("a", "b", "c"), "U") as f: + | ^^^ UP015 +32 | pass +33 | with open(f("a", "b", "c"), "Ub") as f: + | + = help: Remove mode argument + +ℹ Safe fix +28 28 | open(f("a", "b", "c"), "U") +29 29 | open(f("a", "b", "c"), "Ub") +30 30 | +31 |-with open(f("a", "b", "c"), "U") as f: + 31 |+with open(f("a", "b", "c")) as f: +32 32 | pass +33 33 | with open(f("a", "b", "c"), "Ub") as f: +34 34 | pass + +UP015.py:33:29: UP015 [*] Unnecessary modes, use `rb` + | +31 | with open(f("a", "b", "c"), "U") as f: +32 | pass +33 | with open(f("a", "b", "c"), "Ub") as f: + | ^^^^ UP015 +34 | pass + | + = help: Replace with `rb` + +ℹ Safe fix +30 30 | +31 31 | with open(f("a", "b", "c"), "U") as f: +32 32 | pass +33 |-with open(f("a", "b", "c"), "Ub") as f: + 33 |+with open(f("a", "b", "c"), "rb") as f: +34 34 | pass +35 35 | +36 36 | with open("foo", "U") as fa, open("bar", "U") as fb: + +UP015.py:36:18: UP015 [*] Unnecessary mode argument + | +34 | pass +35 | +36 | with open("foo", "U") as fa, open("bar", "U") as fb: + | ^^^ UP015 +37 | pass +38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + | + = help: Remove mode argument + +ℹ Safe fix +33 33 | with open(f("a", "b", "c"), "Ub") as f: +34 34 | pass +35 35 | +36 |-with open("foo", "U") as fa, open("bar", "U") as fb: + 36 |+with open("foo") as fa, open("bar", "U") as fb: +37 37 | pass +38 38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: +39 39 | pass -ℹ Safe fix -41 41 | open(name="foo", mode="U") -42 42 | open(mode="U", name="foo") -43 43 | -44 |-with open("foo", mode="U") as f: - 44 |+with open("foo") as f: -45 45 | pass -46 46 | with open(name="foo", mode="U") as f: -47 47 | pass - -UP015.py:46:6: UP015 [*] Unnecessary open mode parameters +UP015.py:36:42: UP015 [*] Unnecessary mode argument | -44 | with open("foo", mode="U") as f: -45 | pass -46 | with open(name="foo", mode="U") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -47 | pass -48 | with open(mode="U", name="foo") as f: - | - = help: Remove open mode parameters - -ℹ Safe fix -43 43 | -44 44 | with open("foo", mode="U") as f: -45 45 | pass -46 |-with open(name="foo", mode="U") as f: - 46 |+with open(name="foo") as f: -47 47 | pass -48 48 | with open(mode="U", name="foo") as f: -49 49 | pass - -UP015.py:48:6: UP015 [*] Unnecessary open mode parameters - | -46 | with open(name="foo", mode="U") as f: -47 | pass -48 | with open(mode="U", name="foo") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -49 | pass - | - = help: Remove open mode parameters - -ℹ Safe fix -45 45 | pass -46 46 | with open(name="foo", mode="U") as f: -47 47 | pass -48 |-with open(mode="U", name="foo") as f: - 48 |+with open(name="foo") as f: -49 49 | pass -50 50 | -51 51 | open("foo", mode="Ub") - -UP015.py:51:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -49 | pass -50 | -51 | open("foo", mode="Ub") - | ^^^^^^^^^^^^^^^^^^^^^^ UP015 -52 | open(name="foo", mode="Ub") -53 | open(mode="Ub", name="foo") - | - = help: Replace with ""rb"" - -ℹ Safe fix -48 48 | with open(mode="U", name="foo") as f: -49 49 | pass -50 50 | -51 |-open("foo", mode="Ub") - 51 |+open("foo", mode="rb") -52 52 | open(name="foo", mode="Ub") -53 53 | open(mode="Ub", name="foo") -54 54 | - -UP015.py:52:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -51 | open("foo", mode="Ub") -52 | open(name="foo", mode="Ub") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -53 | open(mode="Ub", name="foo") - | - = help: Replace with ""rb"" - -ℹ Safe fix -49 49 | pass -50 50 | -51 51 | open("foo", mode="Ub") -52 |-open(name="foo", mode="Ub") - 52 |+open(name="foo", mode="rb") -53 53 | open(mode="Ub", name="foo") -54 54 | -55 55 | with open("foo", mode="Ub") as f: - -UP015.py:53:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -51 | open("foo", mode="Ub") -52 | open(name="foo", mode="Ub") -53 | open(mode="Ub", name="foo") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -54 | -55 | with open("foo", mode="Ub") as f: - | - = help: Replace with ""rb"" - -ℹ Safe fix -50 50 | -51 51 | open("foo", mode="Ub") -52 52 | open(name="foo", mode="Ub") -53 |-open(mode="Ub", name="foo") - 53 |+open(mode="rb", name="foo") -54 54 | -55 55 | with open("foo", mode="Ub") as f: -56 56 | pass - -UP015.py:55:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -53 | open(mode="Ub", name="foo") -54 | -55 | with open("foo", mode="Ub") as f: - | ^^^^^^^^^^^^^^^^^^^^^^ UP015 -56 | pass -57 | with open(name="foo", mode="Ub") as f: +34 | pass +35 | +36 | with open("foo", "U") as fa, open("bar", "U") as fb: + | ^^^ UP015 +37 | pass +38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + | + = help: Remove mode argument + +ℹ Safe fix +33 33 | with open(f("a", "b", "c"), "Ub") as f: +34 34 | pass +35 35 | +36 |-with open("foo", "U") as fa, open("bar", "U") as fb: + 36 |+with open("foo", "U") as fa, open("bar") as fb: +37 37 | pass +38 38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: +39 39 | pass + +UP015.py:38:18: UP015 [*] Unnecessary modes, use `rb` | - = help: Replace with ""rb"" - -ℹ Safe fix -52 52 | open(name="foo", mode="Ub") -53 53 | open(mode="Ub", name="foo") -54 54 | -55 |-with open("foo", mode="Ub") as f: - 55 |+with open("foo", mode="rb") as f: -56 56 | pass -57 57 | with open(name="foo", mode="Ub") as f: -58 58 | pass - -UP015.py:57:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -55 | with open("foo", mode="Ub") as f: -56 | pass -57 | with open(name="foo", mode="Ub") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -58 | pass -59 | with open(mode="Ub", name="foo") as f: - | - = help: Replace with ""rb"" - -ℹ Safe fix -54 54 | -55 55 | with open("foo", mode="Ub") as f: -56 56 | pass -57 |-with open(name="foo", mode="Ub") as f: - 57 |+with open(name="foo", mode="rb") as f: -58 58 | pass -59 59 | with open(mode="Ub", name="foo") as f: -60 60 | pass - -UP015.py:59:6: UP015 [*] Unnecessary open mode parameters, use ""rb"" +36 | with open("foo", "U") as fa, open("bar", "U") as fb: +37 | pass +38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + | ^^^^ UP015 +39 | pass + | + = help: Replace with `rb` + +ℹ Safe fix +35 35 | +36 36 | with open("foo", "U") as fa, open("bar", "U") as fb: +37 37 | pass +38 |-with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + 38 |+with open("foo", "rb") as fa, open("bar", "Ub") as fb: +39 39 | pass +40 40 | +41 41 | open("foo", mode="U") + +UP015.py:38:43: UP015 [*] Unnecessary modes, use `rb` | -57 | with open(name="foo", mode="Ub") as f: -58 | pass -59 | with open(mode="Ub", name="foo") as f: - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -60 | pass +36 | with open("foo", "U") as fa, open("bar", "U") as fb: +37 | pass +38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + | ^^^^ UP015 +39 | pass | - = help: Replace with ""rb"" - -ℹ Safe fix -56 56 | pass -57 57 | with open(name="foo", mode="Ub") as f: -58 58 | pass -59 |-with open(mode="Ub", name="foo") as f: - 59 |+with open(mode="rb", name="foo") as f: -60 60 | pass -61 61 | -62 62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + = help: Replace with `rb` + +ℹ Safe fix +35 35 | +36 36 | with open("foo", "U") as fa, open("bar", "U") as fb: +37 37 | pass +38 |-with open("foo", "Ub") as fa, open("bar", "Ub") as fb: + 38 |+with open("foo", "Ub") as fa, open("bar", "rb") as fb: +39 39 | pass +40 40 | +41 41 | open("foo", mode="U") -UP015.py:62:1: UP015 [*] Unnecessary open mode parameters +UP015.py:41:18: UP015 [*] Unnecessary mode argument | -60 | pass -61 | -62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) - | - = help: Remove open mode parameters - -ℹ Safe fix -59 59 | with open(mode="Ub", name="foo") as f: -60 60 | pass -61 61 | -62 |-open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - 62 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - -UP015.py:63:1: UP015 [*] Unnecessary open mode parameters +39 | pass +40 | +41 | open("foo", mode="U") + | ^^^ UP015 +42 | open(name="foo", mode="U") +43 | open(mode="U", name="foo") | -62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | - = help: Remove open mode parameters - -ℹ Safe fix -60 60 | pass -61 61 | -62 62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 |-open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') - 63 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 66 | + = help: Remove mode argument + +ℹ Safe fix +38 38 | with open("foo", "Ub") as fa, open("bar", "Ub") as fb: +39 39 | pass +40 40 | +41 |-open("foo", mode="U") + 41 |+open("foo") +42 42 | open(name="foo", mode="U") +43 43 | open(mode="U", name="foo") +44 44 | -UP015.py:64:1: UP015 [*] Unnecessary open mode parameters +UP015.py:42:23: UP015 [*] Unnecessary mode argument | -62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +41 | open("foo", mode="U") +42 | open(name="foo", mode="U") + | ^^^ UP015 +43 | open(mode="U", name="foo") | - = help: Remove open mode parameters + = help: Remove mode argument -ℹ Safe fix -61 61 | -62 62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 |-open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) - 64 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -65 65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 66 | -67 67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +ℹ Safe fix +39 39 | pass +40 40 | +41 41 | open("foo", mode="U") +42 |-open(name="foo", mode="U") + 42 |+open(name="foo") +43 43 | open(mode="U", name="foo") +44 44 | +45 45 | with open("foo", mode="U") as f: + +UP015.py:43:11: UP015 [*] Unnecessary mode argument + | +41 | open("foo", mode="U") +42 | open(name="foo", mode="U") +43 | open(mode="U", name="foo") + | ^^^ UP015 +44 | +45 | with open("foo", mode="U") as f: + | + = help: Remove mode argument -UP015.py:65:1: UP015 [*] Unnecessary open mode parameters +ℹ Safe fix +40 40 | +41 41 | open("foo", mode="U") +42 42 | open(name="foo", mode="U") +43 |-open(mode="U", name="foo") + 43 |+open(name="foo") +44 44 | +45 45 | with open("foo", mode="U") as f: +46 46 | pass + +UP015.py:45:23: UP015 [*] Unnecessary mode argument | -63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -66 | -67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +43 | open(mode="U", name="foo") +44 | +45 | with open("foo", mode="U") as f: + | ^^^ UP015 +46 | pass +47 | with open(name="foo", mode="U") as f: + | + = help: Remove mode argument + +ℹ Safe fix +42 42 | open(name="foo", mode="U") +43 43 | open(mode="U", name="foo") +44 44 | +45 |-with open("foo", mode="U") as f: + 45 |+with open("foo") as f: +46 46 | pass +47 47 | with open(name="foo", mode="U") as f: +48 48 | pass + +UP015.py:47:28: UP015 [*] Unnecessary mode argument + | +45 | with open("foo", mode="U") as f: +46 | pass +47 | with open(name="foo", mode="U") as f: + | ^^^ UP015 +48 | pass +49 | with open(mode="U", name="foo") as f: + | + = help: Remove mode argument + +ℹ Safe fix +44 44 | +45 45 | with open("foo", mode="U") as f: +46 46 | pass +47 |-with open(name="foo", mode="U") as f: + 47 |+with open(name="foo") as f: +48 48 | pass +49 49 | with open(mode="U", name="foo") as f: +50 50 | pass + +UP015.py:49:16: UP015 [*] Unnecessary mode argument + | +47 | with open(name="foo", mode="U") as f: +48 | pass +49 | with open(mode="U", name="foo") as f: + | ^^^ UP015 +50 | pass + | + = help: Remove mode argument + +ℹ Safe fix +46 46 | pass +47 47 | with open(name="foo", mode="U") as f: +48 48 | pass +49 |-with open(mode="U", name="foo") as f: + 49 |+with open(name="foo") as f: +50 50 | pass +51 51 | +52 52 | open("foo", mode="Ub") + +UP015.py:52:18: UP015 [*] Unnecessary modes, use `rb` + | +50 | pass +51 | +52 | open("foo", mode="Ub") + | ^^^^ UP015 +53 | open(name="foo", mode="Ub") +54 | open(mode="Ub", name="foo") + | + = help: Replace with `rb` + +ℹ Safe fix +49 49 | with open(mode="U", name="foo") as f: +50 50 | pass +51 51 | +52 |-open("foo", mode="Ub") + 52 |+open("foo", mode="rb") +53 53 | open(name="foo", mode="Ub") +54 54 | open(mode="Ub", name="foo") +55 55 | + +UP015.py:53:23: UP015 [*] Unnecessary modes, use `rb` + | +52 | open("foo", mode="Ub") +53 | open(name="foo", mode="Ub") + | ^^^^ UP015 +54 | open(mode="Ub", name="foo") + | + = help: Replace with `rb` + +ℹ Safe fix +50 50 | pass +51 51 | +52 52 | open("foo", mode="Ub") +53 |-open(name="foo", mode="Ub") + 53 |+open(name="foo", mode="rb") +54 54 | open(mode="Ub", name="foo") +55 55 | +56 56 | with open("foo", mode="Ub") as f: + +UP015.py:54:11: UP015 [*] Unnecessary modes, use `rb` + | +52 | open("foo", mode="Ub") +53 | open(name="foo", mode="Ub") +54 | open(mode="Ub", name="foo") + | ^^^^ UP015 +55 | +56 | with open("foo", mode="Ub") as f: | - = help: Remove open mode parameters + = help: Replace with `rb` + +ℹ Safe fix +51 51 | +52 52 | open("foo", mode="Ub") +53 53 | open(name="foo", mode="Ub") +54 |-open(mode="Ub", name="foo") + 54 |+open(mode="rb", name="foo") +55 55 | +56 56 | with open("foo", mode="Ub") as f: +57 57 | pass -ℹ Safe fix -62 62 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -63 63 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') -64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 |-open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - 65 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 66 | -67 67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') - -UP015.py:67:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 | -67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +UP015.py:56:23: UP015 [*] Unnecessary modes, use `rb` + | +54 | open(mode="Ub", name="foo") +55 | +56 | with open("foo", mode="Ub") as f: + | ^^^^ UP015 +57 | pass +58 | with open(name="foo", mode="Ub") as f: | - = help: Replace with ""rb"" + = help: Replace with `rb` + +ℹ Safe fix +53 53 | open(name="foo", mode="Ub") +54 54 | open(mode="Ub", name="foo") +55 55 | +56 |-with open("foo", mode="Ub") as f: + 56 |+with open("foo", mode="rb") as f: +57 57 | pass +58 58 | with open(name="foo", mode="Ub") as f: +59 59 | pass -ℹ Safe fix -64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) -65 65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 66 | -67 |-open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - 67 |+open(file="foo", mode="rb", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) -70 70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - -UP015.py:68:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" +UP015.py:58:28: UP015 [*] Unnecessary modes, use `rb` + | +56 | with open("foo", mode="Ub") as f: +57 | pass +58 | with open(name="foo", mode="Ub") as f: + | ^^^^ UP015 +59 | pass +60 | with open(mode="Ub", name="foo") as f: + | + = help: Replace with `rb` + +ℹ Safe fix +55 55 | +56 56 | with open("foo", mode="Ub") as f: +57 57 | pass +58 |-with open(name="foo", mode="Ub") as f: + 58 |+with open(name="foo", mode="rb") as f: +59 59 | pass +60 60 | with open(mode="Ub", name="foo") as f: +61 61 | pass + +UP015.py:60:16: UP015 [*] Unnecessary modes, use `rb` | -67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) -70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +58 | with open(name="foo", mode="Ub") as f: +59 | pass +60 | with open(mode="Ub", name="foo") as f: + | ^^^^ UP015 +61 | pass | - = help: Replace with ""rb"" - -ℹ Safe fix -65 65 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -66 66 | -67 67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 |-open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') - 68 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode="rb") -69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) -70 70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -71 71 | + = help: Replace with `rb` + +ℹ Safe fix +57 57 | pass +58 58 | with open(name="foo", mode="Ub") as f: +59 59 | pass +60 |-with open(mode="Ub", name="foo") as f: + 60 |+with open(mode="rb", name="foo") as f: +61 61 | pass +62 62 | +63 63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -UP015.py:69:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" +UP015.py:63:23: UP015 [*] Unnecessary mode argument | -67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | - = help: Replace with ""rb"" - -ℹ Safe fix -66 66 | -67 67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 |-open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) - 69 |+open(file="foo", buffering=-1, encoding=None, errors=None, mode="rb", newline=None, closefd=True, opener=None) -70 70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -71 71 | -72 72 | open = 1 - -UP015.py:70:1: UP015 [*] Unnecessary open mode parameters, use ""rb"" - | -68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) -70 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -71 | -72 | open = 1 - | - = help: Replace with ""rb"" - -ℹ Safe fix -67 67 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -68 68 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') -69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) -70 |-open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) - 70 |+open(mode="rb", file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -71 71 | -72 72 | open = 1 -73 73 | open("foo", "U") +61 | pass +62 | +63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | ^^^ UP015 +64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) + | + = help: Remove mode argument + +ℹ Safe fix +60 60 | with open(mode="Ub", name="foo") as f: +61 61 | pass +62 62 | +63 |-open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + 63 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) -UP015.py:85:1: UP015 [*] Unnecessary open mode parameters +UP015.py:64:106: UP015 [*] Unnecessary mode argument | -83 | import aiofiles -84 | -85 | aiofiles.open("foo", "U") - | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -86 | aiofiles.open("foo", "r") -87 | aiofiles.open("foo", mode="r") +63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') + | ^^^ UP015 +65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix -82 82 | -83 83 | import aiofiles -84 84 | -85 |-aiofiles.open("foo", "U") - 85 |+aiofiles.open("foo") -86 86 | aiofiles.open("foo", "r") -87 87 | aiofiles.open("foo", mode="r") +61 61 | pass +62 62 | +63 63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 |-open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') + 64 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +65 65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 67 | -UP015.py:86:1: UP015 [*] Unnecessary open mode parameters +UP015.py:65:65: UP015 [*] Unnecessary mode argument | -85 | aiofiles.open("foo", "U") -86 | aiofiles.open("foo", "r") - | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 -87 | aiofiles.open("foo", mode="r") +63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) + | ^^^ UP015 +66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix -83 83 | import aiofiles -84 84 | -85 85 | aiofiles.open("foo", "U") -86 |-aiofiles.open("foo", "r") - 86 |+aiofiles.open("foo") -87 87 | aiofiles.open("foo", mode="r") - -UP015.py:87:1: UP015 [*] Unnecessary open mode parameters - | -85 | aiofiles.open("foo", "U") -86 | aiofiles.open("foo", "r") -87 | aiofiles.open("foo", mode="r") - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP015 - | - = help: Remove open mode parameters - +62 62 | +63 63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 |-open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) + 65 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +66 66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 67 | +68 68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + +UP015.py:66:11: UP015 [*] Unnecessary mode argument + | +64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | ^^^ UP015 +67 | +68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | + = help: Remove mode argument + +ℹ Safe fix +63 63 | open(file="foo", mode='U', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +64 64 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='U') +65 65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 |-open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + 66 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 67 | +68 68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') + +UP015.py:68:23: UP015 [*] Unnecessary modes, use `rb` + | +66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 | +68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | ^^^^ UP015 +69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) + | + = help: Replace with `rb` + ℹ Safe fix -84 84 | -85 85 | aiofiles.open("foo", "U") -86 86 | aiofiles.open("foo", "r") -87 |-aiofiles.open("foo", mode="r") - 87 |+aiofiles.open("foo") +65 65 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='U', newline=None, closefd=True, opener=None) +66 66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 67 | +68 |-open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + 68 |+open(file="foo", mode="rb", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +71 71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + +UP015.py:69:106: UP015 [*] Unnecessary modes, use `rb` + | +68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') + | ^^^^ UP015 +70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | + = help: Replace with `rb` + +ℹ Safe fix +66 66 | open(mode='U', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +67 67 | +68 68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 |-open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') + 69 |+open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode="rb") +70 70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +71 71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +72 72 | + +UP015.py:70:65: UP015 [*] Unnecessary modes, use `rb` + | +68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) + | ^^^^ UP015 +71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | + = help: Replace with `rb` + +ℹ Safe fix +67 67 | +68 68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 |-open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) + 70 |+open(file="foo", buffering=-1, encoding=None, errors=None, mode="rb", newline=None, closefd=True, opener=None) +71 71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +72 72 | +73 73 | import aiofiles + +UP015.py:71:11: UP015 [*] Unnecessary modes, use `rb` + | +69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +71 | open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + | ^^^^ UP015 +72 | +73 | import aiofiles + | + = help: Replace with `rb` + +ℹ Safe fix +68 68 | open(file="foo", mode='Ub', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +69 69 | open(file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, mode='Ub') +70 70 | open(file="foo", buffering=-1, encoding=None, errors=None, mode='Ub', newline=None, closefd=True, opener=None) +71 |-open(mode='Ub', file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) + 71 |+open(mode="rb", file="foo", buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None) +72 72 | +73 73 | import aiofiles +74 74 | + +UP015.py:75:22: UP015 [*] Unnecessary mode argument + | +73 | import aiofiles +74 | +75 | aiofiles.open("foo", "U") + | ^^^ UP015 +76 | aiofiles.open("foo", "r") +77 | aiofiles.open("foo", mode="r") + | + = help: Remove mode argument + +ℹ Safe fix +72 72 | +73 73 | import aiofiles +74 74 | +75 |-aiofiles.open("foo", "U") + 75 |+aiofiles.open("foo") +76 76 | aiofiles.open("foo", "r") +77 77 | aiofiles.open("foo", mode="r") +78 78 | + +UP015.py:76:22: UP015 [*] Unnecessary mode argument + | +75 | aiofiles.open("foo", "U") +76 | aiofiles.open("foo", "r") + | ^^^ UP015 +77 | aiofiles.open("foo", mode="r") + | + = help: Remove mode argument + +ℹ Safe fix +73 73 | import aiofiles +74 74 | +75 75 | aiofiles.open("foo", "U") +76 |-aiofiles.open("foo", "r") + 76 |+aiofiles.open("foo") +77 77 | aiofiles.open("foo", mode="r") +78 78 | +79 79 | open("foo", "r+") + +UP015.py:77:27: UP015 [*] Unnecessary mode argument + | +75 | aiofiles.open("foo", "U") +76 | aiofiles.open("foo", "r") +77 | aiofiles.open("foo", mode="r") + | ^^^ UP015 +78 | +79 | open("foo", "r+") + | + = help: Remove mode argument + +ℹ Safe fix +74 74 | +75 75 | aiofiles.open("foo", "U") +76 76 | aiofiles.open("foo", "r") +77 |-aiofiles.open("foo", mode="r") + 77 |+aiofiles.open("foo") +78 78 | +79 79 | open("foo", "r+") +80 80 | open("foo", "rb") diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015_1.py.snap index 03a9caacb8921..a3f9d68f6cb43 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP015_1.py.snap @@ -1,14 +1,14 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs --- -UP015_1.py:3:5: UP015 [*] Unnecessary open mode parameters +UP015_1.py:3:17: UP015 [*] Unnecessary mode argument | 1 | # Not a valid type annotation but this test shouldn't result in a panic. 2 | # Refer: https://github.com/astral-sh/ruff/issues/11736 3 | x: 'open("foo", "r")' - | ^^^^^^^^^^^^^^^^ UP015 + | ^^^ UP015 | - = help: Remove open mode parameters + = help: Remove mode argument ℹ Safe fix 1 1 | # Not a valid type annotation but this test shouldn't result in a panic. diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018.py.snap index a0a1f44188172..d57eac6e12bae 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018.py.snap @@ -284,7 +284,7 @@ UP018.py:52:1: UP018 [*] Unnecessary `bool` call (rewrite as a literal) 51 | bool(True) 52 | bool(False) | ^^^^^^^^^^^ UP018 -53 | +53 | 54 | # These become a literal but retain parentheses | = help: Replace with boolean literal @@ -304,7 +304,7 @@ UP018.py:55:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) 54 | # These become a literal but retain parentheses 55 | int(1).denominator | ^^^^^^ UP018 -56 | +56 | 57 | # These too are literals in spirit | = help: Replace with integer literal @@ -358,6 +358,7 @@ UP018.py:59:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) 59 |+-1 60 60 | float(+1.0) 61 61 | float(-1.0) +62 62 | UP018.py:60:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) | @@ -376,6 +377,8 @@ UP018.py:60:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) 60 |-float(+1.0) 60 |++1.0 61 61 | float(-1.0) +62 62 | +63 63 | UP018.py:61:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) | @@ -392,5 +395,302 @@ UP018.py:61:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) 60 60 | float(+1.0) 61 |-float(-1.0) 61 |+-1.0 +62 62 | +63 63 | +64 64 | # https://github.com/astral-sh/ruff/issues/15859 +UP018.py:65:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +64 | # https://github.com/astral-sh/ruff/issues/15859 +65 | int(-1) ** 0 # (-1) ** 0 + | ^^^^^^^ UP018 +66 | 2 ** int(-1) # 2 ** -1 + | + = help: Replace with integer literal + +ℹ Safe fix +62 62 | +63 63 | +64 64 | # https://github.com/astral-sh/ruff/issues/15859 +65 |-int(-1) ** 0 # (-1) ** 0 + 65 |+(-1) ** 0 # (-1) ** 0 +66 66 | 2 ** int(-1) # 2 ** -1 +67 67 | +68 68 | int(-1)[0] # (-1)[0] + +UP018.py:66:6: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +64 | # https://github.com/astral-sh/ruff/issues/15859 +65 | int(-1) ** 0 # (-1) ** 0 +66 | 2 ** int(-1) # 2 ** -1 + | ^^^^^^^ UP018 +67 | +68 | int(-1)[0] # (-1)[0] + | + = help: Replace with integer literal + +ℹ Safe fix +63 63 | +64 64 | # https://github.com/astral-sh/ruff/issues/15859 +65 65 | int(-1) ** 0 # (-1) ** 0 +66 |-2 ** int(-1) # 2 ** -1 + 66 |+2 ** (-1) # 2 ** -1 +67 67 | +68 68 | int(-1)[0] # (-1)[0] +69 69 | 2[int(-1)] # 2[-1] + +UP018.py:68:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +66 | 2 ** int(-1) # 2 ** -1 +67 | +68 | int(-1)[0] # (-1)[0] + | ^^^^^^^ UP018 +69 | 2[int(-1)] # 2[-1] + | + = help: Replace with integer literal + +ℹ Safe fix +65 65 | int(-1) ** 0 # (-1) ** 0 +66 66 | 2 ** int(-1) # 2 ** -1 +67 67 | +68 |-int(-1)[0] # (-1)[0] + 68 |+(-1)[0] # (-1)[0] +69 69 | 2[int(-1)] # 2[-1] +70 70 | +71 71 | int(-1)(0) # (-1)(0) + +UP018.py:69:3: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +68 | int(-1)[0] # (-1)[0] +69 | 2[int(-1)] # 2[-1] + | ^^^^^^^ UP018 +70 | +71 | int(-1)(0) # (-1)(0) + | + = help: Replace with integer literal + +ℹ Safe fix +66 66 | 2 ** int(-1) # 2 ** -1 +67 67 | +68 68 | int(-1)[0] # (-1)[0] +69 |-2[int(-1)] # 2[-1] + 69 |+2[(-1)] # 2[-1] +70 70 | +71 71 | int(-1)(0) # (-1)(0) +72 72 | 2(int(-1)) # 2(-1) + +UP018.py:71:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +69 | 2[int(-1)] # 2[-1] +70 | +71 | int(-1)(0) # (-1)(0) + | ^^^^^^^ UP018 +72 | 2(int(-1)) # 2(-1) + | + = help: Replace with integer literal + +ℹ Safe fix +68 68 | int(-1)[0] # (-1)[0] +69 69 | 2[int(-1)] # 2[-1] +70 70 | +71 |-int(-1)(0) # (-1)(0) + 71 |+(-1)(0) # (-1)(0) +72 72 | 2(int(-1)) # 2(-1) +73 73 | +74 74 | float(-1.0).foo # (-1.0).foo + +UP018.py:72:3: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +71 | int(-1)(0) # (-1)(0) +72 | 2(int(-1)) # 2(-1) + | ^^^^^^^ UP018 +73 | +74 | float(-1.0).foo # (-1.0).foo + | + = help: Replace with integer literal + +ℹ Safe fix +69 69 | 2[int(-1)] # 2[-1] +70 70 | +71 71 | int(-1)(0) # (-1)(0) +72 |-2(int(-1)) # 2(-1) + 72 |+2((-1)) # 2(-1) +73 73 | +74 74 | float(-1.0).foo # (-1.0).foo +75 75 | + +UP018.py:74:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) + | +72 | 2(int(-1)) # 2(-1) +73 | +74 | float(-1.0).foo # (-1.0).foo + | ^^^^^^^^^^^ UP018 +75 | +76 | await int(-1) # await (-1) + | + = help: Replace with float literal + +ℹ Safe fix +71 71 | int(-1)(0) # (-1)(0) +72 72 | 2(int(-1)) # 2(-1) +73 73 | +74 |-float(-1.0).foo # (-1.0).foo + 74 |+(-1.0).foo # (-1.0).foo +75 75 | +76 76 | await int(-1) # await (-1) +77 77 | + +UP018.py:76:7: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +74 | float(-1.0).foo # (-1.0).foo +75 | +76 | await int(-1) # await (-1) + | ^^^^^^^ UP018 + | + = help: Replace with integer literal + +ℹ Safe fix +73 73 | +74 74 | float(-1.0).foo # (-1.0).foo +75 75 | +76 |-await int(-1) # await (-1) + 76 |+await (-1) # await (-1) +77 77 | +78 78 | +79 79 | int(+1) ** 0 + +UP018.py:79:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +79 | int(+1) ** 0 + | ^^^^^^^ UP018 +80 | float(+1.0)() + | + = help: Replace with integer literal + +ℹ Safe fix +76 76 | await int(-1) # await (-1) +77 77 | +78 78 | +79 |-int(+1) ** 0 + 79 |+(+1) ** 0 +80 80 | float(+1.0)() +81 81 | +82 82 | + +UP018.py:80:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) + | +79 | int(+1) ** 0 +80 | float(+1.0)() + | ^^^^^^^^^^^ UP018 + | + = help: Replace with float literal + +ℹ Safe fix +77 77 | +78 78 | +79 79 | int(+1) ** 0 +80 |-float(+1.0)() + 80 |+(+1.0)() +81 81 | +82 82 | +83 83 | str( + +UP018.py:83:1: UP018 [*] Unnecessary `str` call (rewrite as a literal) + | +83 | / str( +84 | | '''Lorem +85 | | ipsum''' # Comment +86 | | ).foo + | |_^ UP018 +87 | +88 | # https://github.com/astral-sh/ruff/issues/17606 + | + = help: Replace with string literal + +ℹ Unsafe fix +80 80 | float(+1.0)() +81 81 | +82 82 | +83 |-str( +84 |- '''Lorem +85 |- ipsum''' # Comment +86 |-).foo + 83 |+'''Lorem + 84 |+ ipsum'''.foo +87 85 | +88 86 | # https://github.com/astral-sh/ruff/issues/17606 +89 87 | bool(True)and None + +UP018.py:89:1: UP018 [*] Unnecessary `bool` call (rewrite as a literal) + | +88 | # https://github.com/astral-sh/ruff/issues/17606 +89 | bool(True)and None + | ^^^^^^^^^^ UP018 +90 | int(1)and None +91 | float(1.)and None + | + = help: Replace with boolean literal +ℹ Safe fix +86 86 | ).foo +87 87 | +88 88 | # https://github.com/astral-sh/ruff/issues/17606 +89 |-bool(True)and None + 89 |+True and None +90 90 | int(1)and None +91 91 | float(1.)and None +92 92 | bool(True)and() + +UP018.py:90:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +88 | # https://github.com/astral-sh/ruff/issues/17606 +89 | bool(True)and None +90 | int(1)and None + | ^^^^^^ UP018 +91 | float(1.)and None +92 | bool(True)and() + | + = help: Replace with integer literal + +ℹ Safe fix +87 87 | +88 88 | # https://github.com/astral-sh/ruff/issues/17606 +89 89 | bool(True)and None +90 |-int(1)and None + 90 |+1 and None +91 91 | float(1.)and None +92 92 | bool(True)and() + +UP018.py:91:1: UP018 [*] Unnecessary `float` call (rewrite as a literal) + | +89 | bool(True)and None +90 | int(1)and None +91 | float(1.)and None + | ^^^^^^^^^ UP018 +92 | bool(True)and() + | + = help: Replace with float literal + +ℹ Safe fix +88 88 | # https://github.com/astral-sh/ruff/issues/17606 +89 89 | bool(True)and None +90 90 | int(1)and None +91 |-float(1.)and None + 91 |+1. and None +92 92 | bool(True)and() + +UP018.py:92:1: UP018 [*] Unnecessary `bool` call (rewrite as a literal) + | +90 | int(1)and None +91 | float(1.)and None +92 | bool(True)and() + | ^^^^^^^^^^ UP018 + | + = help: Replace with boolean literal + +ℹ Safe fix +89 89 | bool(True)and None +90 90 | int(1)and None +91 91 | float(1.)and None +92 |-bool(True)and() + 92 |+True and() diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_CR.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_CR.py.snap new file mode 100644 index 0000000000000..6dae74bfe53b6 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_CR.py.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +--- +UP018_CR.py:2:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +1 | # Keep parenthesis around preserved CR int(- 1) int(+ 1) + | ^^^^^^^^^^^ UP018 + | + = help: Replace with integer literal + +ℹ Safe fix +1 1 | # Keep parenthesis around preserved CR 2 |-int(- 2 |+(- 3 3 | 1) 4 4 | int(+ 5 5 | 1) + +UP018_CR.py:4:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +2 | int(- 1) int(+ 1) + | ^^^^^^^^^^^ UP018 + | + = help: Replace with integer literal + +ℹ Safe fix +1 1 | # Keep parenthesis around preserved CR 2 2 | int(- 3 3 | 1) 4 |-int(+ 4 |+(+ 5 5 | 1) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_LF.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_LF.py.snap new file mode 100644 index 0000000000000..d3a530d273c71 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP018_LF.py.snap @@ -0,0 +1,41 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +--- +UP018_LF.py:3:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +1 | # Keep parentheses around preserved \n +2 | +3 | / int(- +4 | | 1) + | |______^ UP018 +5 | +6 | int(+ + | + = help: Replace with integer literal + +ℹ Safe fix +1 1 | # Keep parentheses around preserved \n +2 2 | +3 |-int(- + 3 |+(- +4 4 | 1) +5 5 | +6 6 | int(+ + +UP018_LF.py:6:1: UP018 [*] Unnecessary `int` call (rewrite as a literal) + | +4 | 1) +5 | +6 | / int(+ +7 | | 1) + | |______^ UP018 + | + = help: Replace with integer literal + +ℹ Safe fix +3 3 | int(- +4 4 | 1) +5 5 | +6 |-int(+ + 6 |+(+ +7 7 | 1) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP019.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP019.py.snap index 389ee5e9736a5..7d61f428e1b87 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP019.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP019.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP019.py:7:22: UP019 [*] `typing.Text` is deprecated, use `str` | @@ -70,5 +71,3 @@ UP019.py:19:29: UP019 [*] `typing.Text` is deprecated, use `str` 19 |-def print_fourth_word(word: Goodbye) -> None: 19 |+def print_fourth_word(word: str) -> None: 20 20 | print(word) - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP020.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP020.py.snap index d8d5ed3948468..314d5aa499460 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP020.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP020.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP020.py:3:6: UP020 [*] Use builtin `open` | 1 | import io -2 | +2 | 3 | with io.open("f.txt", mode="r", buffering=-1, **kwargs) as f: | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP020 4 | print(f.read()) @@ -23,7 +23,7 @@ UP020.py:3:6: UP020 [*] Use builtin `open` UP020.py:8:6: UP020 [*] Use builtin `open` | 6 | from io import open -7 | +7 | 8 | with open("f.txt") as f: | ^^^^^^^^^^^^^ UP020 9 | print(f.read()) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP021.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP021.py.snap index 128a9c9d7396a..9d7e2095ad06b 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP021.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP021.py.snap @@ -47,7 +47,7 @@ UP021.py:7:14: UP021 [*] `universal_newlines` is deprecated, use `text` 6 | subprocess.run(["foo"], universal_newlines=True, text=True) 7 | run(["foo"], universal_newlines=True, check=False) | ^^^^^^^^^^^^^^^^^^ UP021 -8 | +8 | 9 | # OK | = help: Replace with `text` keyword argument @@ -61,5 +61,3 @@ UP021.py:7:14: UP021 [*] `universal_newlines` is deprecated, use `text` 8 8 | 9 9 | # OK 10 10 | subprocess.run(["foo"], check=True) - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP022.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP022.py.snap index c6680d1ce5277..990936ee28c3b 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP022.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP022.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP022.py:4:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 2 | import subprocess -3 | +3 | 4 | output = run(["foo"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP022 -5 | +5 | 6 | output = subprocess.run(["foo"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) | = help: Replace with `capture_output` keyword argument @@ -25,10 +25,10 @@ UP022.py:4:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stde UP022.py:6:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 4 | output = run(["foo"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) -5 | +5 | 6 | output = subprocess.run(["foo"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP022 -7 | +7 | 8 | output = subprocess.run(stdout=subprocess.PIPE, args=["foo"], stderr=subprocess.PIPE) | = help: Replace with `capture_output` keyword argument @@ -46,10 +46,10 @@ UP022.py:6:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stde UP022.py:8:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 6 | output = subprocess.run(["foo"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) - 7 | + 7 | 8 | output = subprocess.run(stdout=subprocess.PIPE, args=["foo"], stderr=subprocess.PIPE) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP022 - 9 | + 9 | 10 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -67,13 +67,13 @@ UP022.py:8:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stde UP022.py:10:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 8 | output = subprocess.run(stdout=subprocess.PIPE, args=["foo"], stderr=subprocess.PIPE) - 9 | + 9 | 10 | output = subprocess.run( | __________^ 11 | | ["foo"], stdout=subprocess.PIPE, check=True, stderr=subprocess.PIPE 12 | | ) | |_^ UP022 -13 | +13 | 14 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -91,13 +91,13 @@ UP022.py:10:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `std UP022.py:14:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 12 | ) -13 | +13 | 14 | output = subprocess.run( | __________^ 15 | | ["foo"], stderr=subprocess.PIPE, check=True, stdout=subprocess.PIPE 16 | | ) | |_^ UP022 -17 | +17 | 18 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -115,7 +115,7 @@ UP022.py:14:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `std UP022.py:18:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 16 | ) -17 | +17 | 18 | output = subprocess.run( | __________^ 19 | | ["foo"], @@ -127,7 +127,7 @@ UP022.py:18:10: UP022 [*] Prefer `capture_output` over sending `stdout` and `std 25 | | close_fds=True, 26 | | ) | |_^ UP022 -27 | +27 | 28 | if output: | = help: Replace with `capture_output` keyword argument @@ -157,7 +157,7 @@ UP022.py:29:14: UP022 [*] Prefer `capture_output` over sending `stdout` and `std 35 | | encoding="utf-8", 36 | | ) | |_____^ UP022 -37 | +37 | 38 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -177,13 +177,13 @@ UP022.py:29:14: UP022 [*] Prefer `capture_output` over sending `stdout` and `std UP022.py:38:10: UP022 Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 36 | ) -37 | +37 | 38 | output = subprocess.run( | __________^ 39 | | ["foo"], stdout=subprocess.PIPE, capture_output=True, stderr=subprocess.PIPE 40 | | ) | |_^ UP022 -41 | +41 | 42 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -191,13 +191,13 @@ UP022.py:38:10: UP022 Prefer `capture_output` over sending `stdout` and `stderr` UP022.py:42:10: UP022 Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 40 | ) -41 | +41 | 42 | output = subprocess.run( | __________^ 43 | | ["foo"], stdout=subprocess.PIPE, capture_output=False, stderr=subprocess.PIPE 44 | | ) | |_^ UP022 -45 | +45 | 46 | output = subprocess.run( | = help: Replace with `capture_output` keyword argument @@ -205,15 +205,13 @@ UP022.py:42:10: UP022 Prefer `capture_output` over sending `stdout` and `stderr` UP022.py:46:10: UP022 Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` | 44 | ) -45 | +45 | 46 | output = subprocess.run( | __________^ 47 | | ["foo"], capture_output=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE 48 | | ) | |_^ UP022 -49 | +49 | 50 | # OK | = help: Replace with `capture_output` keyword argument - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP023.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP023.py.snap index 2f5d2cb75b5af..33e1699fe35b1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP023.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP023.py.snap @@ -24,7 +24,7 @@ UP023.py:3:8: UP023 [*] `cElementTree` is deprecated, use `ElementTree` 2 | from xml.etree.cElementTree import XML, Element, SubElement 3 | import xml.etree.cElementTree as ET | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP023 -4 | +4 | 5 | # Weird spacing should not cause issues. | = help: Replace with `ElementTree` @@ -63,7 +63,7 @@ UP023.py:7:11: UP023 [*] `cElementTree` is deprecated, use `ElementTree` 6 | from xml.etree.cElementTree import XML 7 | import xml.etree.cElementTree as ET | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP023 -8 | +8 | 9 | # Multi line imports should also work fine. | = help: Replace with `ElementTree` @@ -128,7 +128,7 @@ UP023.py:17:27: UP023 [*] `cElementTree` is deprecated, use `ElementTree` 16 | import xml.etree.cElementTree as ET 17 | from xml.etree import cElementTree as CET | ^^^^^^^^^^^^^^^^^^^ UP023 -18 | +18 | 19 | from xml.etree import cElementTree as ET | = help: Replace with `ElementTree` @@ -146,10 +146,10 @@ UP023.py:17:27: UP023 [*] `cElementTree` is deprecated, use `ElementTree` UP023.py:19:23: UP023 [*] `cElementTree` is deprecated, use `ElementTree` | 17 | from xml.etree import cElementTree as CET -18 | +18 | 19 | from xml.etree import cElementTree as ET | ^^^^^^^^^^^^^^^^^^ UP023 -20 | +20 | 21 | import contextlib, xml.etree.cElementTree as ET | = help: Replace with `ElementTree` @@ -167,10 +167,10 @@ UP023.py:19:23: UP023 [*] `cElementTree` is deprecated, use `ElementTree` UP023.py:21:20: UP023 [*] `cElementTree` is deprecated, use `ElementTree` | 19 | from xml.etree import cElementTree as ET -20 | +20 | 21 | import contextlib, xml.etree.cElementTree as ET | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP023 -22 | +22 | 23 | # This should fix the second, but not the first invocation. | = help: Replace with `ElementTree` @@ -190,7 +190,7 @@ UP023.py:24:32: UP023 [*] `cElementTree` is deprecated, use `ElementTree` 23 | # This should fix the second, but not the first invocation. 24 | import xml.etree.cElementTree, xml.etree.cElementTree as ET | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP023 -25 | +25 | 26 | # The below items should NOT be changed. | = help: Replace with `ElementTree` @@ -204,5 +204,3 @@ UP023.py:24:32: UP023 [*] `cElementTree` is deprecated, use `ElementTree` 25 25 | 26 26 | # The below items should NOT be changed. 27 27 | import xml.etree.cElementTree - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_0.py.snap index bb7879fbc7c06..70898be69cd3f 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP024_0.py:6:8: UP024 [*] Replace aliased errors with `OSError` | @@ -301,5 +302,3 @@ UP024_0.py:114:8: UP024 [*] Replace aliased errors with `OSError` 114 |-except os.error: 114 |+except OSError: 115 115 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_1.py.snap index d0a723a1b9f67..202e701dc75ab 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP024_1.py:5:8: UP024 [*] Replace aliased errors with `OSError` | @@ -68,5 +69,3 @@ UP024_1.py:12:8: UP024 [*] Replace aliased errors with `OSError` 16 |-): 12 |+except OSError: 17 13 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_2.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_2.py.snap index eecdf5fea5e17..7a05ae711be00 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_2.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_2.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP024_2.py:10:7: UP024 [*] Replace aliased errors with `OSError` | 8 | # Testing the modules - 9 | import socket, mmap, select + 9 | import socket, mmap, select, resource 10 | raise socket.error | ^^^^^^^^^^^^ UP024 11 | raise mmap.error @@ -15,32 +15,33 @@ UP024_2.py:10:7: UP024 [*] Replace aliased errors with `OSError` ℹ Safe fix 7 7 | 8 8 | # Testing the modules -9 9 | import socket, mmap, select +9 9 | import socket, mmap, select, resource 10 |-raise socket.error 10 |+raise OSError 11 11 | raise mmap.error 12 12 | raise select.error -13 13 | +13 13 | raise resource.error UP024_2.py:11:7: UP024 [*] Replace aliased errors with `OSError` | - 9 | import socket, mmap, select + 9 | import socket, mmap, select, resource 10 | raise socket.error 11 | raise mmap.error | ^^^^^^^^^^ UP024 12 | raise select.error +13 | raise resource.error | = help: Replace `mmap.error` with builtin `OSError` ℹ Safe fix 8 8 | # Testing the modules -9 9 | import socket, mmap, select +9 9 | import socket, mmap, select, resource 10 10 | raise socket.error 11 |-raise mmap.error 11 |+raise OSError 12 12 | raise select.error -13 13 | -14 14 | raise socket.error() +13 13 | raise resource.error +14 14 | UP024_2.py:12:7: UP024 [*] Replace aliased errors with `OSError` | @@ -48,357 +49,416 @@ UP024_2.py:12:7: UP024 [*] Replace aliased errors with `OSError` 11 | raise mmap.error 12 | raise select.error | ^^^^^^^^^^^^ UP024 -13 | -14 | raise socket.error() +13 | raise resource.error | = help: Replace `select.error` with builtin `OSError` ℹ Safe fix -9 9 | import socket, mmap, select +9 9 | import socket, mmap, select, resource 10 10 | raise socket.error 11 11 | raise mmap.error 12 |-raise select.error 12 |+raise OSError -13 13 | -14 14 | raise socket.error() -15 15 | raise mmap.error(1) +13 13 | raise resource.error +14 14 | +15 15 | raise socket.error() -UP024_2.py:14:7: UP024 [*] Replace aliased errors with `OSError` +UP024_2.py:13:7: UP024 [*] Replace aliased errors with `OSError` | +11 | raise mmap.error 12 | raise select.error -13 | -14 | raise socket.error() - | ^^^^^^^^^^^^ UP024 -15 | raise mmap.error(1) -16 | raise select.error(1, 2) +13 | raise resource.error + | ^^^^^^^^^^^^^^ UP024 +14 | +15 | raise socket.error() | - = help: Replace `socket.error` with builtin `OSError` + = help: Replace `resource.error` with builtin `OSError` ℹ Safe fix +10 10 | raise socket.error 11 11 | raise mmap.error 12 12 | raise select.error -13 13 | -14 |-raise socket.error() - 14 |+raise OSError() -15 15 | raise mmap.error(1) -16 16 | raise select.error(1, 2) -17 17 | +13 |-raise resource.error + 13 |+raise OSError +14 14 | +15 15 | raise socket.error() +16 16 | raise mmap.error(1) UP024_2.py:15:7: UP024 [*] Replace aliased errors with `OSError` | -14 | raise socket.error() -15 | raise mmap.error(1) - | ^^^^^^^^^^ UP024 -16 | raise select.error(1, 2) +13 | raise resource.error +14 | +15 | raise socket.error() + | ^^^^^^^^^^^^ UP024 +16 | raise mmap.error(1) +17 | raise select.error(1, 2) | - = help: Replace `mmap.error` with builtin `OSError` + = help: Replace `socket.error` with builtin `OSError` ℹ Safe fix 12 12 | raise select.error -13 13 | -14 14 | raise socket.error() -15 |-raise mmap.error(1) - 15 |+raise OSError(1) -16 16 | raise select.error(1, 2) -17 17 | -18 18 | raise socket.error( +13 13 | raise resource.error +14 14 | +15 |-raise socket.error() + 15 |+raise OSError() +16 16 | raise mmap.error(1) +17 17 | raise select.error(1, 2) +18 18 | raise resource.error(1, "strerror", "filename") UP024_2.py:16:7: UP024 [*] Replace aliased errors with `OSError` | -14 | raise socket.error() -15 | raise mmap.error(1) -16 | raise select.error(1, 2) +15 | raise socket.error() +16 | raise mmap.error(1) + | ^^^^^^^^^^ UP024 +17 | raise select.error(1, 2) +18 | raise resource.error(1, "strerror", "filename") + | + = help: Replace `mmap.error` with builtin `OSError` + +ℹ Safe fix +13 13 | raise resource.error +14 14 | +15 15 | raise socket.error() +16 |-raise mmap.error(1) + 16 |+raise OSError(1) +17 17 | raise select.error(1, 2) +18 18 | raise resource.error(1, "strerror", "filename") +19 19 | + +UP024_2.py:17:7: UP024 [*] Replace aliased errors with `OSError` + | +15 | raise socket.error() +16 | raise mmap.error(1) +17 | raise select.error(1, 2) | ^^^^^^^^^^^^ UP024 -17 | -18 | raise socket.error( +18 | raise resource.error(1, "strerror", "filename") | = help: Replace `select.error` with builtin `OSError` ℹ Safe fix -13 13 | -14 14 | raise socket.error() -15 15 | raise mmap.error(1) -16 |-raise select.error(1, 2) - 16 |+raise OSError(1, 2) -17 17 | -18 18 | raise socket.error( -19 19 | 1, +14 14 | +15 15 | raise socket.error() +16 16 | raise mmap.error(1) +17 |-raise select.error(1, 2) + 17 |+raise OSError(1, 2) +18 18 | raise resource.error(1, "strerror", "filename") +19 19 | +20 20 | raise socket.error( UP024_2.py:18:7: UP024 [*] Replace aliased errors with `OSError` | -16 | raise select.error(1, 2) -17 | -18 | raise socket.error( +16 | raise mmap.error(1) +17 | raise select.error(1, 2) +18 | raise resource.error(1, "strerror", "filename") + | ^^^^^^^^^^^^^^ UP024 +19 | +20 | raise socket.error( + | + = help: Replace `resource.error` with builtin `OSError` + +ℹ Safe fix +15 15 | raise socket.error() +16 16 | raise mmap.error(1) +17 17 | raise select.error(1, 2) +18 |-raise resource.error(1, "strerror", "filename") + 18 |+raise OSError(1, "strerror", "filename") +19 19 | +20 20 | raise socket.error( +21 21 | 1, + +UP024_2.py:20:7: UP024 [*] Replace aliased errors with `OSError` + | +18 | raise resource.error(1, "strerror", "filename") +19 | +20 | raise socket.error( | ^^^^^^^^^^^^ UP024 -19 | 1, -20 | 2, +21 | 1, +22 | 2, | = help: Replace `socket.error` with builtin `OSError` ℹ Safe fix -15 15 | raise mmap.error(1) -16 16 | raise select.error(1, 2) -17 17 | -18 |-raise socket.error( - 18 |+raise OSError( -19 19 | 1, -20 20 | 2, -21 21 | 3, - -UP024_2.py:25:7: UP024 [*] Replace aliased errors with `OSError` - | -24 | from mmap import error -25 | raise error +17 17 | raise select.error(1, 2) +18 18 | raise resource.error(1, "strerror", "filename") +19 19 | +20 |-raise socket.error( + 20 |+raise OSError( +21 21 | 1, +22 22 | 2, +23 23 | 3, + +UP024_2.py:27:7: UP024 [*] Replace aliased errors with `OSError` + | +26 | from mmap import error +27 | raise error | ^^^^^ UP024 -26 | -27 | from socket import error +28 | +29 | from socket import error | = help: Replace `error` with builtin `OSError` ℹ Safe fix -22 22 | ) -23 23 | -24 24 | from mmap import error -25 |-raise error - 25 |+raise OSError -26 26 | -27 27 | from socket import error -28 28 | raise error(1) - -UP024_2.py:28:7: UP024 [*] Replace aliased errors with `OSError` - | -27 | from socket import error -28 | raise error(1) +24 24 | ) +25 25 | +26 26 | from mmap import error +27 |-raise error + 27 |+raise OSError +28 28 | +29 29 | from socket import error +30 30 | raise error(1) + +UP024_2.py:30:7: UP024 [*] Replace aliased errors with `OSError` + | +29 | from socket import error +30 | raise error(1) | ^^^^^ UP024 -29 | -30 | from select import error +31 | +32 | from select import error | = help: Replace `error` with builtin `OSError` ℹ Safe fix -25 25 | raise error -26 26 | -27 27 | from socket import error -28 |-raise error(1) - 28 |+raise OSError(1) -29 29 | -30 30 | from select import error -31 31 | raise error(1, 2) - -UP024_2.py:31:7: UP024 [*] Replace aliased errors with `OSError` - | -30 | from select import error -31 | raise error(1, 2) +27 27 | raise error +28 28 | +29 29 | from socket import error +30 |-raise error(1) + 30 |+raise OSError(1) +31 31 | +32 32 | from select import error +33 33 | raise error(1, 2) + +UP024_2.py:33:7: UP024 [*] Replace aliased errors with `OSError` + | +32 | from select import error +33 | raise error(1, 2) + | ^^^^^ UP024 +34 | +35 | from resource import error + | + = help: Replace `error` with builtin `OSError` + +ℹ Safe fix +30 30 | raise error(1) +31 31 | +32 32 | from select import error +33 |-raise error(1, 2) + 33 |+raise OSError(1, 2) +34 34 | +35 35 | from resource import error +36 36 | raise error(1, "strerror", "filename") + +UP024_2.py:36:7: UP024 [*] Replace aliased errors with `OSError` + | +35 | from resource import error +36 | raise error(1, "strerror", "filename") | ^^^^^ UP024 -32 | -33 | # Testing the names +37 | +38 | # Testing the names | = help: Replace `error` with builtin `OSError` ℹ Safe fix -28 28 | raise error(1) -29 29 | -30 30 | from select import error -31 |-raise error(1, 2) - 31 |+raise OSError(1, 2) -32 32 | -33 33 | # Testing the names -34 34 | raise EnvironmentError - -UP024_2.py:34:7: UP024 [*] Replace aliased errors with `OSError` - | -33 | # Testing the names -34 | raise EnvironmentError +33 33 | raise error(1, 2) +34 34 | +35 35 | from resource import error +36 |-raise error(1, "strerror", "filename") + 36 |+raise OSError(1, "strerror", "filename") +37 37 | +38 38 | # Testing the names +39 39 | raise EnvironmentError + +UP024_2.py:39:7: UP024 [*] Replace aliased errors with `OSError` + | +38 | # Testing the names +39 | raise EnvironmentError | ^^^^^^^^^^^^^^^^ UP024 -35 | raise IOError -36 | raise WindowsError +40 | raise IOError +41 | raise WindowsError | = help: Replace `EnvironmentError` with builtin `OSError` ℹ Safe fix -31 31 | raise error(1, 2) -32 32 | -33 33 | # Testing the names -34 |-raise EnvironmentError - 34 |+raise OSError -35 35 | raise IOError -36 36 | raise WindowsError +36 36 | raise error(1, "strerror", "filename") 37 37 | +38 38 | # Testing the names +39 |-raise EnvironmentError + 39 |+raise OSError +40 40 | raise IOError +41 41 | raise WindowsError +42 42 | -UP024_2.py:35:7: UP024 [*] Replace aliased errors with `OSError` +UP024_2.py:40:7: UP024 [*] Replace aliased errors with `OSError` | -33 | # Testing the names -34 | raise EnvironmentError -35 | raise IOError +38 | # Testing the names +39 | raise EnvironmentError +40 | raise IOError | ^^^^^^^ UP024 -36 | raise WindowsError +41 | raise WindowsError | = help: Replace `IOError` with builtin `OSError` ℹ Safe fix -32 32 | -33 33 | # Testing the names -34 34 | raise EnvironmentError -35 |-raise IOError - 35 |+raise OSError -36 36 | raise WindowsError 37 37 | -38 38 | raise EnvironmentError() - -UP024_2.py:36:7: UP024 [*] Replace aliased errors with `OSError` - | -34 | raise EnvironmentError -35 | raise IOError -36 | raise WindowsError +38 38 | # Testing the names +39 39 | raise EnvironmentError +40 |-raise IOError + 40 |+raise OSError +41 41 | raise WindowsError +42 42 | +43 43 | raise EnvironmentError() + +UP024_2.py:41:7: UP024 [*] Replace aliased errors with `OSError` + | +39 | raise EnvironmentError +40 | raise IOError +41 | raise WindowsError | ^^^^^^^^^^^^ UP024 -37 | -38 | raise EnvironmentError() +42 | +43 | raise EnvironmentError() | = help: Replace `WindowsError` with builtin `OSError` ℹ Safe fix -33 33 | # Testing the names -34 34 | raise EnvironmentError -35 35 | raise IOError -36 |-raise WindowsError - 36 |+raise OSError -37 37 | -38 38 | raise EnvironmentError() -39 39 | raise IOError(1) - -UP024_2.py:38:7: UP024 [*] Replace aliased errors with `OSError` - | -36 | raise WindowsError -37 | -38 | raise EnvironmentError() +38 38 | # Testing the names +39 39 | raise EnvironmentError +40 40 | raise IOError +41 |-raise WindowsError + 41 |+raise OSError +42 42 | +43 43 | raise EnvironmentError() +44 44 | raise IOError(1) + +UP024_2.py:43:7: UP024 [*] Replace aliased errors with `OSError` + | +41 | raise WindowsError +42 | +43 | raise EnvironmentError() | ^^^^^^^^^^^^^^^^ UP024 -39 | raise IOError(1) -40 | raise WindowsError(1, 2) +44 | raise IOError(1) +45 | raise WindowsError(1, 2) | = help: Replace `EnvironmentError` with builtin `OSError` ℹ Safe fix -35 35 | raise IOError -36 36 | raise WindowsError -37 37 | -38 |-raise EnvironmentError() - 38 |+raise OSError() -39 39 | raise IOError(1) -40 40 | raise WindowsError(1, 2) -41 41 | - -UP024_2.py:39:7: UP024 [*] Replace aliased errors with `OSError` - | -38 | raise EnvironmentError() -39 | raise IOError(1) +40 40 | raise IOError +41 41 | raise WindowsError +42 42 | +43 |-raise EnvironmentError() + 43 |+raise OSError() +44 44 | raise IOError(1) +45 45 | raise WindowsError(1, 2) +46 46 | + +UP024_2.py:44:7: UP024 [*] Replace aliased errors with `OSError` + | +43 | raise EnvironmentError() +44 | raise IOError(1) | ^^^^^^^ UP024 -40 | raise WindowsError(1, 2) +45 | raise WindowsError(1, 2) | = help: Replace `IOError` with builtin `OSError` ℹ Safe fix -36 36 | raise WindowsError -37 37 | -38 38 | raise EnvironmentError() -39 |-raise IOError(1) - 39 |+raise OSError(1) -40 40 | raise WindowsError(1, 2) -41 41 | -42 42 | raise EnvironmentError( - -UP024_2.py:40:7: UP024 [*] Replace aliased errors with `OSError` - | -38 | raise EnvironmentError() -39 | raise IOError(1) -40 | raise WindowsError(1, 2) +41 41 | raise WindowsError +42 42 | +43 43 | raise EnvironmentError() +44 |-raise IOError(1) + 44 |+raise OSError(1) +45 45 | raise WindowsError(1, 2) +46 46 | +47 47 | raise EnvironmentError( + +UP024_2.py:45:7: UP024 [*] Replace aliased errors with `OSError` + | +43 | raise EnvironmentError() +44 | raise IOError(1) +45 | raise WindowsError(1, 2) | ^^^^^^^^^^^^ UP024 -41 | -42 | raise EnvironmentError( +46 | +47 | raise EnvironmentError( | = help: Replace `WindowsError` with builtin `OSError` ℹ Safe fix -37 37 | -38 38 | raise EnvironmentError() -39 39 | raise IOError(1) -40 |-raise WindowsError(1, 2) - 40 |+raise OSError(1, 2) -41 41 | -42 42 | raise EnvironmentError( -43 43 | 1, - -UP024_2.py:42:7: UP024 [*] Replace aliased errors with `OSError` - | -40 | raise WindowsError(1, 2) -41 | -42 | raise EnvironmentError( +42 42 | +43 43 | raise EnvironmentError() +44 44 | raise IOError(1) +45 |-raise WindowsError(1, 2) + 45 |+raise OSError(1, 2) +46 46 | +47 47 | raise EnvironmentError( +48 48 | 1, + +UP024_2.py:47:7: UP024 [*] Replace aliased errors with `OSError` + | +45 | raise WindowsError(1, 2) +46 | +47 | raise EnvironmentError( | ^^^^^^^^^^^^^^^^ UP024 -43 | 1, -44 | 2, +48 | 1, +49 | 2, | = help: Replace `EnvironmentError` with builtin `OSError` ℹ Safe fix -39 39 | raise IOError(1) -40 40 | raise WindowsError(1, 2) -41 41 | -42 |-raise EnvironmentError( - 42 |+raise OSError( -43 43 | 1, -44 44 | 2, -45 45 | 3, - -UP024_2.py:48:7: UP024 [*] Replace aliased errors with `OSError` - | -46 | ) -47 | -48 | raise WindowsError +44 44 | raise IOError(1) +45 45 | raise WindowsError(1, 2) +46 46 | +47 |-raise EnvironmentError( + 47 |+raise OSError( +48 48 | 1, +49 49 | 2, +50 50 | 3, + +UP024_2.py:53:7: UP024 [*] Replace aliased errors with `OSError` + | +51 | ) +52 | +53 | raise WindowsError | ^^^^^^^^^^^^ UP024 -49 | raise EnvironmentError(1) -50 | raise IOError(1, 2) +54 | raise EnvironmentError(1) +55 | raise IOError(1, 2) | = help: Replace `WindowsError` with builtin `OSError` ℹ Safe fix -45 45 | 3, -46 46 | ) -47 47 | -48 |-raise WindowsError - 48 |+raise OSError -49 49 | raise EnvironmentError(1) -50 50 | raise IOError(1, 2) - -UP024_2.py:49:7: UP024 [*] Replace aliased errors with `OSError` - | -48 | raise WindowsError -49 | raise EnvironmentError(1) +50 50 | 3, +51 51 | ) +52 52 | +53 |-raise WindowsError + 53 |+raise OSError +54 54 | raise EnvironmentError(1) +55 55 | raise IOError(1, 2) + +UP024_2.py:54:7: UP024 [*] Replace aliased errors with `OSError` + | +53 | raise WindowsError +54 | raise EnvironmentError(1) | ^^^^^^^^^^^^^^^^ UP024 -50 | raise IOError(1, 2) +55 | raise IOError(1, 2) | = help: Replace `EnvironmentError` with builtin `OSError` ℹ Safe fix -46 46 | ) -47 47 | -48 48 | raise WindowsError -49 |-raise EnvironmentError(1) - 49 |+raise OSError(1) -50 50 | raise IOError(1, 2) - -UP024_2.py:50:7: UP024 [*] Replace aliased errors with `OSError` - | -48 | raise WindowsError -49 | raise EnvironmentError(1) -50 | raise IOError(1, 2) +51 51 | ) +52 52 | +53 53 | raise WindowsError +54 |-raise EnvironmentError(1) + 54 |+raise OSError(1) +55 55 | raise IOError(1, 2) + +UP024_2.py:55:7: UP024 [*] Replace aliased errors with `OSError` + | +53 | raise WindowsError +54 | raise EnvironmentError(1) +55 | raise IOError(1, 2) | ^^^^^^^ UP024 | = help: Replace `IOError` with builtin `OSError` ℹ Safe fix -47 47 | -48 48 | raise WindowsError -49 49 | raise EnvironmentError(1) -50 |-raise IOError(1, 2) - 50 |+raise OSError(1, 2) - - +52 52 | +53 53 | raise WindowsError +54 54 | raise EnvironmentError(1) +55 |-raise IOError(1, 2) + 55 |+raise OSError(1, 2) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_3.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_3.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_3.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_4.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_4.py.snap index 40f6fbea4b00a..c3ea530f1d8b1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_4.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP024_4.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP024_4.py:9:8: UP024 [*] Replace aliased errors with `OSError` | @@ -18,5 +19,3 @@ UP024_4.py:9:8: UP024 [*] Replace aliased errors with `OSError` 9 |-except (socket.error, exceptions.OperationalError): 9 |+except (OSError, exceptions.OperationalError): 10 10 | return HttpResponseServerError("cache: cannot connect to broker.") - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP025.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP025.py.snap index e5cd73cc97314..916977bfed2f4 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP025.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP025.py.snap @@ -5,7 +5,7 @@ UP025.py:1:1: UP025 [*] Remove unicode literals from strings | 1 | u"Hello" | ^^^^^^^^ UP025 -2 | +2 | 3 | x = u"Hello" # UP025 | = help: Remove unicode prefix @@ -20,10 +20,10 @@ UP025.py:1:1: UP025 [*] Remove unicode literals from strings UP025.py:3:5: UP025 [*] Remove unicode literals from strings | 1 | u"Hello" -2 | +2 | 3 | x = u"Hello" # UP025 | ^^^^^^^^ UP025 -4 | +4 | 5 | u'world' # UP025 | = help: Remove unicode prefix @@ -40,10 +40,10 @@ UP025.py:3:5: UP025 [*] Remove unicode literals from strings UP025.py:5:1: UP025 [*] Remove unicode literals from strings | 3 | x = u"Hello" # UP025 -4 | +4 | 5 | u'world' # UP025 | ^^^^^^^^ UP025 -6 | +6 | 7 | print(u"Hello") # UP025 | = help: Remove unicode prefix @@ -61,10 +61,10 @@ UP025.py:5:1: UP025 [*] Remove unicode literals from strings UP025.py:7:7: UP025 [*] Remove unicode literals from strings | 5 | u'world' # UP025 -6 | +6 | 7 | print(u"Hello") # UP025 | ^^^^^^^^ UP025 -8 | +8 | 9 | print(u'world') # UP025 | = help: Remove unicode prefix @@ -82,10 +82,10 @@ UP025.py:7:7: UP025 [*] Remove unicode literals from strings UP025.py:9:7: UP025 [*] Remove unicode literals from strings | 7 | print(u"Hello") # UP025 - 8 | + 8 | 9 | print(u'world') # UP025 | ^^^^^^^^ UP025 -10 | +10 | 11 | import foo | = help: Remove unicode prefix @@ -103,10 +103,10 @@ UP025.py:9:7: UP025 [*] Remove unicode literals from strings UP025.py:13:5: UP025 [*] Remove unicode literals from strings | 11 | import foo -12 | +12 | 13 | foo(u"Hello", U"world", a=u"Hello", b=u"world") # UP025 | ^^^^^^^^ UP025 -14 | +14 | 15 | # Retain quotes when fixing. | = help: Remove unicode prefix @@ -124,10 +124,10 @@ UP025.py:13:5: UP025 [*] Remove unicode literals from strings UP025.py:13:15: UP025 [*] Remove unicode literals from strings | 11 | import foo -12 | +12 | 13 | foo(u"Hello", U"world", a=u"Hello", b=u"world") # UP025 | ^^^^^^^^ UP025 -14 | +14 | 15 | # Retain quotes when fixing. | = help: Remove unicode prefix @@ -145,10 +145,10 @@ UP025.py:13:15: UP025 [*] Remove unicode literals from strings UP025.py:13:27: UP025 [*] Remove unicode literals from strings | 11 | import foo -12 | +12 | 13 | foo(u"Hello", U"world", a=u"Hello", b=u"world") # UP025 | ^^^^^^^^ UP025 -14 | +14 | 15 | # Retain quotes when fixing. | = help: Remove unicode prefix @@ -166,10 +166,10 @@ UP025.py:13:27: UP025 [*] Remove unicode literals from strings UP025.py:13:39: UP025 [*] Remove unicode literals from strings | 11 | import foo -12 | +12 | 13 | foo(u"Hello", U"world", a=u"Hello", b=u"world") # UP025 | ^^^^^^^^ UP025 -14 | +14 | 15 | # Retain quotes when fixing. | = help: Remove unicode prefix @@ -251,7 +251,7 @@ UP025.py:19:5: UP025 [*] Remove unicode literals from strings 18 | x = u'''hello''' # UP025 19 | x = u'Hello "World"' # UP025 | ^^^^^^^^^^^^^^^^ UP025 -20 | +20 | 21 | u = "Hello" # OK | = help: Remove unicode prefix @@ -269,7 +269,7 @@ UP025.py:19:5: UP025 [*] Remove unicode literals from strings UP025.py:27:7: UP025 [*] Remove unicode literals from strings | 25 | return"Hello" # OK -26 | +26 | 27 | f"foo"u"bar" # OK | ^^^^^^ UP025 28 | f"foo" u"bar" # OK @@ -298,5 +298,3 @@ UP025.py:28:8: UP025 [*] Remove unicode literals from strings 27 27 | f"foo"u"bar" # OK 28 |-f"foo" u"bar" # OK 28 |+f"foo" "bar" # OK - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP026.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP026.py.snap index 56d9e70f2cb27..83ef343e8ecc1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP026.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP026.py.snap @@ -7,7 +7,7 @@ UP026.py:3:12: UP026 [*] `mock` is deprecated, use `unittest.mock` 2 | if True: 3 | import mock | ^^^^ UP026 -4 | +4 | 5 | # Error (`from unittest import mock`) | = help: Import from `unittest.mock` instead @@ -27,7 +27,7 @@ UP026.py:7:12: UP026 [*] `mock` is deprecated, use `unittest.mock` 6 | if True: 7 | import mock, sys | ^^^^ UP026 -8 | +8 | 9 | # Error (`from unittest.mock import *`) | = help: Import from `unittest.mock` instead @@ -49,7 +49,7 @@ UP026.py:11:5: UP026 [*] `mock` is deprecated, use `unittest.mock` 10 | if True: 11 | from mock import * | ^^^^^^^^^^^^^^^^^^ UP026 -12 | +12 | 13 | # Error (`from unittest import mock`) | = help: Import from `unittest.mock` instead @@ -69,7 +69,7 @@ UP026.py:14:8: UP026 [*] `mock` is deprecated, use `unittest.mock` 13 | # Error (`from unittest import mock`) 14 | import mock.mock | ^^^^^^^^^ UP026 -15 | +15 | 16 | # Error (`from unittest import mock`) | = help: Import from `unittest.mock` instead @@ -89,7 +89,7 @@ UP026.py:17:20: UP026 [*] `mock` is deprecated, use `unittest.mock` 16 | # Error (`from unittest import mock`) 17 | import contextlib, mock, sys | ^^^^ UP026 -18 | +18 | 19 | # Error (`from unittest import mock`) | = help: Import from `unittest.mock` instead @@ -130,7 +130,7 @@ UP026.py:24:1: UP026 [*] `mock` is deprecated, use `unittest.mock` 23 | # Error (`from unittest import mock`) 24 | from mock import mock | ^^^^^^^^^^^^^^^^^^^^^ UP026 -25 | +25 | 26 | # Error (keep trailing comma) | = help: Import from `unittest.mock` instead @@ -187,7 +187,7 @@ UP026.py:33:1: UP026 [*] `mock` is deprecated, use `unittest.mock` 37 | | mock, 38 | | ) | |_^ UP026 -39 | +39 | 40 | # Error (avoid trailing comma) | = help: Import from `unittest.mock` instead @@ -299,7 +299,7 @@ UP026.py:54:1: UP026 [*] `mock` is deprecated, use `unittest.mock` 53 | from mock import mock, a, b, c 54 | from mock import a, b, c, mock | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP026 -55 | +55 | 56 | if True: | = help: Import from `unittest.mock` instead @@ -319,15 +319,14 @@ UP026.py:58:9: UP026 [*] `mock` is deprecated, use `unittest.mock` | 56 | if True: 57 | if False: -58 | from mock import ( - | _________^ +58 | / from mock import ( 59 | | mock, 60 | | a, 61 | | b, 62 | | c 63 | | ) | |_________^ UP026 -64 | +64 | 65 | # OK | = help: Import from `unittest.mock` instead @@ -353,7 +352,7 @@ UP026.py:69:8: UP026 [*] `mock` is deprecated, use `unittest.mock` 68 | # Error (`from unittest import mock`) 69 | import mock, mock | ^^^^ UP026 -70 | +70 | 71 | # Error (`from unittest import mock as foo`) | = help: Import from `unittest.mock` instead @@ -374,7 +373,7 @@ UP026.py:69:14: UP026 [*] `mock` is deprecated, use `unittest.mock` 68 | # Error (`from unittest import mock`) 69 | import mock, mock | ^^^^ UP026 -70 | +70 | 71 | # Error (`from unittest import mock as foo`) | = help: Import from `unittest.mock` instead @@ -395,7 +394,7 @@ UP026.py:72:8: UP026 [*] `mock` is deprecated, use `unittest.mock` 71 | # Error (`from unittest import mock as foo`) 72 | import mock as foo | ^^^^^^^^^^^ UP026 -73 | +73 | 74 | # Error (`from unittest import mock as foo`) | = help: Import from `unittest.mock` instead @@ -415,7 +414,7 @@ UP026.py:75:1: UP026 [*] `mock` is deprecated, use `unittest.mock` 74 | # Error (`from unittest import mock as foo`) 75 | from mock import mock as foo | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP026 -76 | +76 | 77 | if True: | = help: Import from `unittest.mock` instead @@ -436,7 +435,7 @@ UP026.py:79:12: UP026 [*] `mock` is deprecated, use `unittest.mock` 78 | # This should yield multiple, aliased imports. 79 | import mock as foo, mock as bar, mock | ^^^^^^^^^^^ UP026 -80 | +80 | 81 | # This should yield multiple, aliased imports, and preserve `os`. | = help: Import from `unittest.mock` instead @@ -459,7 +458,7 @@ UP026.py:79:25: UP026 [*] `mock` is deprecated, use `unittest.mock` 78 | # This should yield multiple, aliased imports. 79 | import mock as foo, mock as bar, mock | ^^^^^^^^^^^ UP026 -80 | +80 | 81 | # This should yield multiple, aliased imports, and preserve `os`. | = help: Import from `unittest.mock` instead @@ -482,7 +481,7 @@ UP026.py:79:38: UP026 [*] `mock` is deprecated, use `unittest.mock` 78 | # This should yield multiple, aliased imports. 79 | import mock as foo, mock as bar, mock | ^^^^ UP026 -80 | +80 | 81 | # This should yield multiple, aliased imports, and preserve `os`. | = help: Import from `unittest.mock` instead @@ -504,7 +503,7 @@ UP026.py:82:12: UP026 [*] `mock` is deprecated, use `unittest.mock` 81 | # This should yield multiple, aliased imports, and preserve `os`. 82 | import mock as foo, mock as bar, mock, os | ^^^^^^^^^^^ UP026 -83 | +83 | 84 | if True: | = help: Import from `unittest.mock` instead @@ -527,7 +526,7 @@ UP026.py:82:25: UP026 [*] `mock` is deprecated, use `unittest.mock` 81 | # This should yield multiple, aliased imports, and preserve `os`. 82 | import mock as foo, mock as bar, mock, os | ^^^^^^^^^^^ UP026 -83 | +83 | 84 | if True: | = help: Import from `unittest.mock` instead @@ -550,7 +549,7 @@ UP026.py:82:38: UP026 [*] `mock` is deprecated, use `unittest.mock` 81 | # This should yield multiple, aliased imports, and preserve `os`. 82 | import mock as foo, mock as bar, mock, os | ^^^^ UP026 -83 | +83 | 84 | if True: | = help: Import from `unittest.mock` instead @@ -603,5 +602,3 @@ UP026.py:93:5: UP026 [*] `mock` is deprecated, use `unittest.mock` 92 92 | # Error (`mock.Mock()`). 93 |-x = mock.mock.Mock() 93 |+x = mock.Mock() - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP027.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP027.py.snap deleted file mode 100644 index c177a26b81e2b..0000000000000 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP027.py.snap +++ /dev/null @@ -1,112 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pyupgrade/mod.rs ---- -UP027.py:2:17: UP027 [*] Replace unpacked list comprehension with a generator expression - | -1 | # Should change -2 | foo, bar, baz = [fn(x) for x in items] - | ^^^^^^^^^^^^^^^^^^^^^^ UP027 -3 | -4 | foo, bar, baz =[fn(x) for x in items] - | - = help: Replace with generator expression - -ℹ Safe fix -1 1 | # Should change -2 |-foo, bar, baz = [fn(x) for x in items] - 2 |+foo, bar, baz = (fn(x) for x in items) -3 3 | -4 4 | foo, bar, baz =[fn(x) for x in items] -5 5 | - -UP027.py:4:16: UP027 [*] Replace unpacked list comprehension with a generator expression - | -2 | foo, bar, baz = [fn(x) for x in items] -3 | -4 | foo, bar, baz =[fn(x) for x in items] - | ^^^^^^^^^^^^^^^^^^^^^^ UP027 -5 | -6 | foo, bar, baz = [fn(x) for x in items] - | - = help: Replace with generator expression - -ℹ Safe fix -1 1 | # Should change -2 2 | foo, bar, baz = [fn(x) for x in items] -3 3 | -4 |-foo, bar, baz =[fn(x) for x in items] - 4 |+foo, bar, baz =(fn(x) for x in items) -5 5 | -6 6 | foo, bar, baz = [fn(x) for x in items] -7 7 | - -UP027.py:6:26: UP027 [*] Replace unpacked list comprehension with a generator expression - | -4 | foo, bar, baz =[fn(x) for x in items] -5 | -6 | foo, bar, baz = [fn(x) for x in items] - | ^^^^^^^^^^^^^^^^^^^^^^ UP027 -7 | -8 | foo, bar, baz = [[i for i in fn(x)] for x in items] - | - = help: Replace with generator expression - -ℹ Safe fix -3 3 | -4 4 | foo, bar, baz =[fn(x) for x in items] -5 5 | -6 |-foo, bar, baz = [fn(x) for x in items] - 6 |+foo, bar, baz = (fn(x) for x in items) -7 7 | -8 8 | foo, bar, baz = [[i for i in fn(x)] for x in items] -9 9 | - -UP027.py:8:17: UP027 [*] Replace unpacked list comprehension with a generator expression - | - 6 | foo, bar, baz = [fn(x) for x in items] - 7 | - 8 | foo, bar, baz = [[i for i in fn(x)] for x in items] - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP027 - 9 | -10 | foo, bar, baz = [ - | - = help: Replace with generator expression - -ℹ Safe fix -5 5 | -6 6 | foo, bar, baz = [fn(x) for x in items] -7 7 | -8 |-foo, bar, baz = [[i for i in fn(x)] for x in items] - 8 |+foo, bar, baz = ([i for i in fn(x)] for x in items) -9 9 | -10 10 | foo, bar, baz = [ -11 11 | fn(x) - -UP027.py:10:17: UP027 [*] Replace unpacked list comprehension with a generator expression - | - 8 | foo, bar, baz = [[i for i in fn(x)] for x in items] - 9 | -10 | foo, bar, baz = [ - | _________________^ -11 | | fn(x) -12 | | for x in items -13 | | ] - | |_^ UP027 -14 | -15 | # Should not change - | - = help: Replace with generator expression - -ℹ Safe fix -7 7 | -8 8 | foo, bar, baz = [[i for i in fn(x)] for x in items] -9 9 | -10 |-foo, bar, baz = [ - 10 |+foo, bar, baz = ( -11 11 | fn(x) -12 12 | for x in items -13 |-] - 13 |+) -14 14 | -15 15 | # Should not change -16 16 | foo = [fn(x) for x in items] diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP028_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP028_0.py.snap index b3c29c378c90a..2f00cdcfdad24 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP028_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP028_0.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP028_0.py:2:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 1 | def f(): -2 | for x in y: - | _____^ +2 | / for x in y: 3 | | yield x | |_______________^ UP028 | @@ -23,8 +22,7 @@ UP028_0.py:2:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:7:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 6 | def g(): -7 | for x, y in z: - | _____^ +7 | / for x, y in z: 8 | | yield (x, y) | |____________________^ UP028 | @@ -44,8 +42,7 @@ UP028_0.py:7:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:12:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 11 | def h(): -12 | for x in [1, 2, 3]: - | _____^ +12 | / for x in [1, 2, 3]: 13 | | yield x | |_______________^ UP028 | @@ -65,8 +62,7 @@ UP028_0.py:12:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:17:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 16 | def i(): -17 | for x in {x for x in y}: - | _____^ +17 | / for x in {x for x in y}: 18 | | yield x | |_______________^ UP028 | @@ -86,8 +82,7 @@ UP028_0.py:17:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:22:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 21 | def j(): -22 | for x in (1, 2, 3): - | _____^ +22 | / for x in (1, 2, 3): 23 | | yield x | |_______________^ UP028 | @@ -107,8 +102,7 @@ UP028_0.py:22:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:27:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 26 | def k(): -27 | for x, y in {3: "x", 6: "y"}: - | _____^ +27 | / for x, y in {3: "x", 6: "y"}: 28 | | yield x, y | |__________________^ UP028 | @@ -129,8 +123,7 @@ UP028_0.py:33:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 31 | def f(): # Comment one\n' 32 | # Comment two\n' -33 | for x, y in { # Comment three\n' - | _____^ +33 | / for x, y in { # Comment three\n' 34 | | 3: "x", # Comment four\n' 35 | | # Comment five\n' 36 | | 6: "y", # Comment six\n' @@ -162,8 +155,7 @@ UP028_0.py:33:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:44:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 43 | def f(): -44 | for x, y in [{3: (3, [44, "long ss"]), 6: "y"}]: - | _____^ +44 | / for x, y in [{3: (3, [44, "long ss"]), 6: "y"}]: 45 | | yield x, y | |__________________^ UP028 | @@ -183,11 +175,10 @@ UP028_0.py:44:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:49:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 48 | def f(): -49 | for x, y in z(): - | _____^ +49 | / for x, y in z(): 50 | | yield x, y | |__________________^ UP028 -51 | +51 | 52 | def f(): | = help: Replace with `yield from` @@ -207,8 +198,7 @@ UP028_0.py:55:9: UP028 [*] Replace `yield` over `for` loop with `yield from` | 53 | def func(): 54 | # This comment is preserved\n' -55 | for x, y in z(): # Comment one\n' - | _________^ +55 | / for x, y in z(): # Comment one\n' 56 | | # Comment two\n' 57 | | yield x, y # Comment three\n' | |______________________^ UP028 @@ -233,8 +223,7 @@ UP028_0.py:67:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 65 | for x in y: 66 | yield x -67 | for z in x: - | _____^ +67 | / for z in x: 68 | | yield z | |_______________^ UP028 | @@ -254,8 +243,7 @@ UP028_0.py:67:5: UP028 [*] Replace `yield` over `for` loop with `yield from` UP028_0.py:72:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 71 | def f(): -72 | for x, y in z(): - | _____^ +72 | / for x, y in z(): 73 | | yield x, y | |__________________^ UP028 74 | x = 1 @@ -277,8 +265,7 @@ UP028_0.py:79:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 77 | # Regression test for: https://github.com/astral-sh/ruff/issues/7103 78 | def _serve_method(fn): -79 | for h in ( - | _____^ +79 | / for h in ( 80 | | TaggedText.from_file(args.input) 81 | | .markup(highlight=args.region) 82 | | ): @@ -306,8 +293,7 @@ UP028_0.py:97:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 95 | # UP028: The exception binding is not a reference to the loop variable 96 | def f(): - 97 | for x in (1, 2, 3): - | _____^ + 97 | / for x in (1, 2, 3): 98 | | yield x | |_______________^ UP028 99 | # Shadowing with an `except` @@ -330,8 +316,7 @@ UP028_0.py:108:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 106 | # UP028: The context binding is not a reference to the loop variable 107 | def f(): -108 | for x in (1, 2, 3): - | _____^ +108 | / for x in (1, 2, 3): 109 | | yield x | |_______________^ UP028 110 | # Shadowing with `with` @@ -354,8 +339,7 @@ UP028_0.py:118:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 116 | # UP028: The type annotation binding is not a reference to the loop variable 117 | def f(): -118 | for x in (1, 2, 3): - | _____^ +118 | / for x in (1, 2, 3): 119 | | yield x | |_______________^ UP028 120 | # Shadowing with a type annotation @@ -378,8 +362,7 @@ UP028_0.py:134:5: UP028 [*] Replace `yield` over `for` loop with `yield from` | 132 | # UP028: The exception bindings are not a reference to the loop variable 133 | def f(): -134 | for x in (1, 2, 3): - | _____^ +134 | / for x in (1, 2, 3): 135 | | yield x | |_______________^ UP028 136 | # Shadowing with multiple `except` blocks @@ -397,3 +380,46 @@ UP028_0.py:134:5: UP028 [*] Replace `yield` over `for` loop with `yield from` 136 135 | # Shadowing with multiple `except` blocks 137 136 | try: 138 137 | pass + +UP028_0.py:170:5: UP028 [*] Replace `yield` over `for` loop with `yield from` + | +168 | # https://github.com/astral-sh/ruff/issues/15540 +169 | def f(): +170 | / for a in 1,: +171 | | yield a + | |_______________^ UP028 + | + = help: Replace with `yield from` + +ℹ Unsafe fix +167 167 | +168 168 | # https://github.com/astral-sh/ruff/issues/15540 +169 169 | def f(): +170 |- for a in 1,: +171 |- yield a + 170 |+ yield from (1,) +172 171 | +173 172 | +174 173 | SOME_GLOBAL = None + +UP028_0.py:179:5: UP028 Replace `yield` over `for` loop with `yield from` + | +177 | global SOME_GLOBAL +178 | +179 | / for SOME_GLOBAL in iterable: +180 | | yield SOME_GLOBAL + | |_________________________^ UP028 +181 | +182 | some_non_local = None + | + = help: Replace with `yield from` + +UP028_0.py:187:9: UP028 Replace `yield` over `for` loop with `yield from` + | +185 | nonlocal some_non_local +186 | +187 | / for some_non_local in iterable: +188 | | yield some_non_local + | |________________________________^ UP028 + | + = help: Replace with `yield from` diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP029.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP029.py.snap index 5dcbd5e6c95e8..67f4c5ab7ff5f 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP029.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP029.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP029.py:1:1: UP029 [*] Unnecessary builtin import: `*` | @@ -74,5 +75,3 @@ UP029.py:5:1: UP029 [*] Unnecessary builtin import: `open` 6 5 | import io 7 6 | import six 8 7 | import six.moves - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_0.py.snap index 936bfd6887969..1f17a77cef01e 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_0.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP030_0.py:3:1: UP030 [*] Use implicit references for positional format fields | 1 | # Invalid calls; errors expected. -2 | +2 | 3 | "{0}" "{1}" "{2}".format(1, 2, 3) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -4 | +4 | 5 | "a {3} complicated {1} string with {0} {2}".format( | = help: Remove explicit positional indices @@ -24,12 +24,12 @@ UP030_0.py:3:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:5:1: UP030 [*] Use implicit references for positional format fields | 3 | "{0}" "{1}" "{2}".format(1, 2, 3) -4 | +4 | 5 | / "a {3} complicated {1} string with {0} {2}".format( 6 | | "first", "second", "third", "fourth" 7 | | ) | |_^ UP030 -8 | +8 | 9 | '{0}'.format(1) | = help: Remove explicit positional indices @@ -49,10 +49,10 @@ UP030_0.py:5:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:9:1: UP030 [*] Use implicit references for positional format fields | 7 | ) - 8 | + 8 | 9 | '{0}'.format(1) | ^^^^^^^^^^^^^^^ UP030 -10 | +10 | 11 | '{0:x}'.format(30) | = help: Remove explicit positional indices @@ -70,10 +70,10 @@ UP030_0.py:9:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:11:1: UP030 [*] Use implicit references for positional format fields | 9 | '{0}'.format(1) -10 | +10 | 11 | '{0:x}'.format(30) | ^^^^^^^^^^^^^^^^^^ UP030 -12 | +12 | 13 | x = '{0}'.format(1) | = help: Remove explicit positional indices @@ -91,10 +91,10 @@ UP030_0.py:11:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:13:5: UP030 [*] Use implicit references for positional format fields | 11 | '{0:x}'.format(30) -12 | +12 | 13 | x = '{0}'.format(1) | ^^^^^^^^^^^^^^^ UP030 -14 | +14 | 15 | '''{0}\n{1}\n'''.format(1, 2) | = help: Remove explicit positional indices @@ -112,10 +112,10 @@ UP030_0.py:13:5: UP030 [*] Use implicit references for positional format fields UP030_0.py:15:1: UP030 [*] Use implicit references for positional format fields | 13 | x = '{0}'.format(1) -14 | +14 | 15 | '''{0}\n{1}\n'''.format(1, 2) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -16 | +16 | 17 | x = "foo {0}" \ | = help: Remove explicit positional indices @@ -133,12 +133,12 @@ UP030_0.py:15:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:17:5: UP030 [*] Use implicit references for positional format fields | 15 | '''{0}\n{1}\n'''.format(1, 2) -16 | +16 | 17 | x = "foo {0}" \ | _____^ 18 | | "bar {1}".format(1, 2) | |__________________________^ UP030 -19 | +19 | 20 | ("{0}").format(1) | = help: Remove explicit positional indices @@ -158,10 +158,10 @@ UP030_0.py:17:5: UP030 [*] Use implicit references for positional format fields UP030_0.py:20:1: UP030 [*] Use implicit references for positional format fields | 18 | "bar {1}".format(1, 2) -19 | +19 | 20 | ("{0}").format(1) | ^^^^^^^^^^^^^^^^^ UP030 -21 | +21 | 22 | "\N{snowman} {0}".format(1) | = help: Remove explicit positional indices @@ -179,10 +179,10 @@ UP030_0.py:20:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:22:1: UP030 [*] Use implicit references for positional format fields | 20 | ("{0}").format(1) -21 | +21 | 22 | "\N{snowman} {0}".format(1) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -23 | +23 | 24 | print( | = help: Remove explicit positional indices @@ -200,8 +200,7 @@ UP030_0.py:22:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:25:5: UP030 [*] Use implicit references for positional format fields | 24 | print( -25 | 'foo{0}' - | _____^ +25 | / 'foo{0}' 26 | | 'bar{1}'.format(1, 2) | |_________________________^ UP030 27 | ) @@ -223,8 +222,7 @@ UP030_0.py:25:5: UP030 [*] Use implicit references for positional format fields UP030_0.py:30:5: UP030 [*] Use implicit references for positional format fields | 29 | print( -30 | 'foo{0}' # ohai\n" - | _____^ +30 | / 'foo{0}' # ohai\n" 31 | | 'bar{1}'.format(1, 2) | |_________________________^ UP030 32 | ) @@ -246,10 +244,10 @@ UP030_0.py:30:5: UP030 [*] Use implicit references for positional format fields UP030_0.py:34:1: UP030 Use implicit references for positional format fields | 32 | ) -33 | +33 | 34 | '{' '0}'.format(1) | ^^^^^^^^^^^^^^^^^^ UP030 -35 | +35 | 36 | args = list(range(10)) | = help: Remove explicit positional indices @@ -257,10 +255,10 @@ UP030_0.py:34:1: UP030 Use implicit references for positional format fields UP030_0.py:39:1: UP030 [*] Use implicit references for positional format fields | 37 | kwargs = {x: x for x in range(10)} -38 | +38 | 39 | "{0}".format(*args) | ^^^^^^^^^^^^^^^^^^^ UP030 -40 | +40 | 41 | "{0}".format(**kwargs) | = help: Remove explicit positional indices @@ -278,10 +276,10 @@ UP030_0.py:39:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:41:1: UP030 [*] Use implicit references for positional format fields | 39 | "{0}".format(*args) -40 | +40 | 41 | "{0}".format(**kwargs) | ^^^^^^^^^^^^^^^^^^^^^^ UP030 -42 | +42 | 43 | "{0}_{1}".format(*args) | = help: Remove explicit positional indices @@ -299,10 +297,10 @@ UP030_0.py:41:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:43:1: UP030 [*] Use implicit references for positional format fields | 41 | "{0}".format(**kwargs) -42 | +42 | 43 | "{0}_{1}".format(*args) | ^^^^^^^^^^^^^^^^^^^^^^^ UP030 -44 | +44 | 45 | "{0}_{1}".format(1, *args) | = help: Remove explicit positional indices @@ -320,10 +318,10 @@ UP030_0.py:43:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:45:1: UP030 [*] Use implicit references for positional format fields | 43 | "{0}_{1}".format(*args) -44 | +44 | 45 | "{0}_{1}".format(1, *args) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -46 | +46 | 47 | "{0}_{1}".format(1, 2, *args) | = help: Remove explicit positional indices @@ -341,10 +339,10 @@ UP030_0.py:45:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:47:1: UP030 [*] Use implicit references for positional format fields | 45 | "{0}_{1}".format(1, *args) -46 | +46 | 47 | "{0}_{1}".format(1, 2, *args) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -48 | +48 | 49 | "{0}_{1}".format(*args, 1, 2) | = help: Remove explicit positional indices @@ -362,10 +360,10 @@ UP030_0.py:47:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:49:1: UP030 [*] Use implicit references for positional format fields | 47 | "{0}_{1}".format(1, 2, *args) -48 | +48 | 49 | "{0}_{1}".format(*args, 1, 2) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -50 | +50 | 51 | "{0}_{1}_{2}".format(1, **kwargs) | = help: Remove explicit positional indices @@ -383,10 +381,10 @@ UP030_0.py:49:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:51:1: UP030 [*] Use implicit references for positional format fields | 49 | "{0}_{1}".format(*args, 1, 2) -50 | +50 | 51 | "{0}_{1}_{2}".format(1, **kwargs) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -52 | +52 | 53 | "{0}_{1}_{2}".format(1, 2, **kwargs) | = help: Remove explicit positional indices @@ -404,10 +402,10 @@ UP030_0.py:51:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:53:1: UP030 [*] Use implicit references for positional format fields | 51 | "{0}_{1}_{2}".format(1, **kwargs) -52 | +52 | 53 | "{0}_{1}_{2}".format(1, 2, **kwargs) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -54 | +54 | 55 | "{0}_{1}_{2}".format(1, 2, 3, **kwargs) | = help: Remove explicit positional indices @@ -425,10 +423,10 @@ UP030_0.py:53:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:55:1: UP030 [*] Use implicit references for positional format fields | 53 | "{0}_{1}_{2}".format(1, 2, **kwargs) -54 | +54 | 55 | "{0}_{1}_{2}".format(1, 2, 3, **kwargs) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -56 | +56 | 57 | "{0}_{1}_{2}".format(1, 2, 3, *args, **kwargs) | = help: Remove explicit positional indices @@ -446,10 +444,10 @@ UP030_0.py:55:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:57:1: UP030 [*] Use implicit references for positional format fields | 55 | "{0}_{1}_{2}".format(1, 2, 3, **kwargs) -56 | +56 | 57 | "{0}_{1}_{2}".format(1, 2, 3, *args, **kwargs) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -58 | +58 | 59 | "{1}_{0}".format(1, 2, *args) | = help: Remove explicit positional indices @@ -467,10 +465,10 @@ UP030_0.py:57:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:59:1: UP030 [*] Use implicit references for positional format fields | 57 | "{0}_{1}_{2}".format(1, 2, 3, *args, **kwargs) -58 | +58 | 59 | "{1}_{0}".format(1, 2, *args) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP030 -60 | +60 | 61 | "{1}_{0}".format(1, 2) | = help: Remove explicit positional indices @@ -487,7 +485,7 @@ UP030_0.py:59:1: UP030 [*] Use implicit references for positional format fields UP030_0.py:61:1: UP030 [*] Use implicit references for positional format fields | 59 | "{1}_{0}".format(1, 2, *args) -60 | +60 | 61 | "{1}_{0}".format(1, 2) | ^^^^^^^^^^^^^^^^^^^^^^ UP030 | @@ -499,5 +497,3 @@ UP030_0.py:61:1: UP030 [*] Use implicit references for positional format fields 60 60 | 61 |-"{1}_{0}".format(1, 2) 61 |+"{}_{}".format(2, 1) - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_1.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP030_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_0.py.snap index 2b72d13959042..129a49cc93db9 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_0.py.snap @@ -6,7 +6,7 @@ UP031_0.py:4:7: UP031 [*] Use format specifiers instead of percent format 3 | # UP031 4 | print('%s %s' % (a, b)) | ^^^^^^^^^^^^^^^^ UP031 -5 | +5 | 6 | print('%s%s' % (a, b)) | = help: Replace with format specifiers @@ -24,10 +24,10 @@ UP031_0.py:4:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:6:7: UP031 [*] Use format specifiers instead of percent format | 4 | print('%s %s' % (a, b)) -5 | +5 | 6 | print('%s%s' % (a, b)) | ^^^^^^^^^^^^^^^ UP031 -7 | +7 | 8 | print("trivial" % ()) | = help: Replace with format specifiers @@ -45,10 +45,10 @@ UP031_0.py:6:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:8:7: UP031 [*] Use format specifiers instead of percent format | 6 | print('%s%s' % (a, b)) - 7 | + 7 | 8 | print("trivial" % ()) | ^^^^^^^^^^^^^^ UP031 - 9 | + 9 | 10 | print("%s" % ("simple",)) | = help: Replace with format specifiers @@ -66,10 +66,10 @@ UP031_0.py:8:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:10:7: UP031 [*] Use format specifiers instead of percent format | 8 | print("trivial" % ()) - 9 | + 9 | 10 | print("%s" % ("simple",)) | ^^^^^^^^^^^^^^^^^^ UP031 -11 | +11 | 12 | print("%s" % ("%s" % ("nested",),)) | = help: Replace with format specifiers @@ -87,10 +87,10 @@ UP031_0.py:10:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:12:7: UP031 [*] Use format specifiers instead of percent format | 10 | print("%s" % ("simple",)) -11 | +11 | 12 | print("%s" % ("%s" % ("nested",),)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -13 | +13 | 14 | print("%s%% percent" % (15,)) | = help: Replace with format specifiers @@ -108,10 +108,10 @@ UP031_0.py:12:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:12:15: UP031 [*] Use format specifiers instead of percent format | 10 | print("%s" % ("simple",)) -11 | +11 | 12 | print("%s" % ("%s" % ("nested",),)) | ^^^^^^^^^^^^^^^^^^ UP031 -13 | +13 | 14 | print("%s%% percent" % (15,)) | = help: Replace with format specifiers @@ -129,10 +129,10 @@ UP031_0.py:12:15: UP031 [*] Use format specifiers instead of percent format UP031_0.py:14:7: UP031 [*] Use format specifiers instead of percent format | 12 | print("%s" % ("%s" % ("nested",),)) -13 | +13 | 14 | print("%s%% percent" % (15,)) | ^^^^^^^^^^^^^^^^^^^^^^ UP031 -15 | +15 | 16 | print("%f" % (15,)) | = help: Replace with format specifiers @@ -150,10 +150,10 @@ UP031_0.py:14:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:16:7: UP031 [*] Use format specifiers instead of percent format | 14 | print("%s%% percent" % (15,)) -15 | +15 | 16 | print("%f" % (15,)) | ^^^^^^^^^^^^ UP031 -17 | +17 | 18 | print("%.f" % (15,)) | = help: Replace with format specifiers @@ -171,10 +171,10 @@ UP031_0.py:16:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:18:7: UP031 [*] Use format specifiers instead of percent format | 16 | print("%f" % (15,)) -17 | +17 | 18 | print("%.f" % (15,)) | ^^^^^^^^^^^^^ UP031 -19 | +19 | 20 | print("%.3f" % (15,)) | = help: Replace with format specifiers @@ -192,10 +192,10 @@ UP031_0.py:18:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:20:7: UP031 [*] Use format specifiers instead of percent format | 18 | print("%.f" % (15,)) -19 | +19 | 20 | print("%.3f" % (15,)) | ^^^^^^^^^^^^^^ UP031 -21 | +21 | 22 | print("%3f" % (15,)) | = help: Replace with format specifiers @@ -213,10 +213,10 @@ UP031_0.py:20:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:22:7: UP031 [*] Use format specifiers instead of percent format | 20 | print("%.3f" % (15,)) -21 | +21 | 22 | print("%3f" % (15,)) | ^^^^^^^^^^^^^ UP031 -23 | +23 | 24 | print("%-5f" % (5,)) | = help: Replace with format specifiers @@ -234,10 +234,10 @@ UP031_0.py:22:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:24:7: UP031 [*] Use format specifiers instead of percent format | 22 | print("%3f" % (15,)) -23 | +23 | 24 | print("%-5f" % (5,)) | ^^^^^^^^^^^^^ UP031 -25 | +25 | 26 | print("%9f" % (5,)) | = help: Replace with format specifiers @@ -255,10 +255,10 @@ UP031_0.py:24:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:26:7: UP031 [*] Use format specifiers instead of percent format | 24 | print("%-5f" % (5,)) -25 | +25 | 26 | print("%9f" % (5,)) | ^^^^^^^^^^^^ UP031 -27 | +27 | 28 | print("%#o" % (123,)) | = help: Replace with format specifiers @@ -276,10 +276,10 @@ UP031_0.py:26:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:28:7: UP031 [*] Use format specifiers instead of percent format | 26 | print("%9f" % (5,)) -27 | +27 | 28 | print("%#o" % (123,)) | ^^^^^^^^^^^^^^ UP031 -29 | +29 | 30 | print("brace {} %s" % (1,)) | = help: Replace with format specifiers @@ -297,10 +297,10 @@ UP031_0.py:28:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:30:7: UP031 [*] Use format specifiers instead of percent format | 28 | print("%#o" % (123,)) -29 | +29 | 30 | print("brace {} %s" % (1,)) | ^^^^^^^^^^^^^^^^^^^^ UP031 -31 | +31 | 32 | print(( | = help: Replace with format specifiers @@ -318,8 +318,7 @@ UP031_0.py:30:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:33:5: UP031 [*] Use format specifiers instead of percent format | 32 | print(( -33 | "foo %s " - | _____^ +33 | / "foo %s " 34 | | "bar %s" % (x, y) | |_____________________^ UP031 35 | )) @@ -341,8 +340,7 @@ UP031_0.py:33:5: UP031 [*] Use format specifiers instead of percent format UP031_0.py:38:3: UP031 [*] Use format specifiers instead of percent format | 37 | print( -38 | "%s" % ( - | ___^ +38 | / "%s" % ( 39 | | "trailing comma", 40 | | ) | |_________^ UP031 @@ -363,10 +361,10 @@ UP031_0.py:38:3: UP031 [*] Use format specifiers instead of percent format UP031_0.py:43:7: UP031 [*] Use format specifiers instead of percent format | 41 | ) -42 | +42 | 43 | print("foo %s " % (x,)) | ^^^^^^^^^^^^^^^^ UP031 -44 | +44 | 45 | print("%(k)s" % {"k": "v"}) | = help: Replace with format specifiers @@ -384,10 +382,10 @@ UP031_0.py:43:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:45:7: UP031 [*] Use format specifiers instead of percent format | 43 | print("foo %s " % (x,)) -44 | +44 | 45 | print("%(k)s" % {"k": "v"}) | ^^^^^^^^^^^^^^^^^^^^ UP031 -46 | +46 | 47 | print("%(k)s" % { | = help: Replace with format specifiers @@ -405,14 +403,14 @@ UP031_0.py:45:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:47:7: UP031 [*] Use format specifiers instead of percent format | 45 | print("%(k)s" % {"k": "v"}) -46 | +46 | 47 | print("%(k)s" % { | _______^ 48 | | "k": "v", 49 | | "i": "j" 50 | | }) | |_^ UP031 -51 | +51 | 52 | print("%(to_list)s" % {"to_list": []}) | = help: Replace with format specifiers @@ -436,10 +434,10 @@ UP031_0.py:47:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:52:7: UP031 [*] Use format specifiers instead of percent format | 50 | }) -51 | +51 | 52 | print("%(to_list)s" % {"to_list": []}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -53 | +53 | 54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) | = help: Replace with format specifiers @@ -457,10 +455,10 @@ UP031_0.py:52:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:54:7: UP031 [*] Use format specifiers instead of percent format | 52 | print("%(to_list)s" % {"to_list": []}) -53 | +53 | 54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -55 | +55 | 56 | print("%(ab)s" % {"a" "b": 1}) | = help: Replace with format specifiers @@ -478,10 +476,10 @@ UP031_0.py:54:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:56:7: UP031 [*] Use format specifiers instead of percent format | 54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) -55 | +55 | 56 | print("%(ab)s" % {"a" "b": 1}) | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -57 | +57 | 58 | print("%(a)s" % {"a" : 1}) | = help: Replace with format specifiers @@ -499,7 +497,7 @@ UP031_0.py:56:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:58:7: UP031 [*] Use format specifiers instead of percent format | 56 | print("%(ab)s" % {"a" "b": 1}) -57 | +57 | 58 | print("%(a)s" % {"a" : 1}) | ^^^^^^^^^^^^^^^^^^^^^ UP031 | @@ -518,8 +516,7 @@ UP031_0.py:58:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:62:5: UP031 [*] Use format specifiers instead of percent format | 61 | print( -62 | "foo %(foo)s " - | _____^ +62 | / "foo %(foo)s " 63 | | "bar %(bar)s" % {"foo": x, "bar": y} | |________________________________________^ UP031 64 | ) @@ -542,8 +539,7 @@ UP031_0.py:68:5: UP031 [*] Use format specifiers instead of percent format | 66 | bar = {"bar": y} 67 | print( -68 | "foo %(foo)s " - | _____^ +68 | / "foo %(foo)s " 69 | | "bar %(bar)s" % {"foo": x, **bar} | |_____________________________________^ UP031 70 | ) @@ -565,10 +561,10 @@ UP031_0.py:68:5: UP031 [*] Use format specifiers instead of percent format UP031_0.py:72:7: UP031 [*] Use format specifiers instead of percent format | 70 | ) -71 | +71 | 72 | print("%s \N{snowman}" % (a,)) | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -73 | +73 | 74 | print("%(foo)s \N{snowman}" % {"foo": 1}) | = help: Replace with format specifiers @@ -586,10 +582,10 @@ UP031_0.py:72:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:74:7: UP031 [*] Use format specifiers instead of percent format | 72 | print("%s \N{snowman}" % (a,)) -73 | +73 | 74 | print("%(foo)s \N{snowman}" % {"foo": 1}) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -75 | +75 | 76 | print(("foo %s " "bar %s") % (x, y)) | = help: Replace with format specifiers @@ -607,10 +603,10 @@ UP031_0.py:74:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:76:7: UP031 [*] Use format specifiers instead of percent format | 74 | print("%(foo)s \N{snowman}" % {"foo": 1}) -75 | +75 | 76 | print(("foo %s " "bar %s") % (x, y)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -77 | +77 | 78 | # Single-value expressions | = help: Replace with format specifiers @@ -776,7 +772,7 @@ UP031_0.py:86:7: UP031 [*] Use format specifiers instead of percent format 85 | print('Hello %(arg)s' % bar.baz) 86 | print('Hello %(arg)s' % bar['bop']) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -87 | +87 | 88 | # Hanging modulos | = help: Replace with format specifiers @@ -799,7 +795,7 @@ UP031_0.py:89:1: UP031 [*] Use format specifiers instead of percent format 91 | | "bar %s" 92 | | ) % (x, y) | |__________^ UP031 -93 | +93 | 94 | ( | = help: Replace with format specifiers @@ -821,13 +817,13 @@ UP031_0.py:89:1: UP031 [*] Use format specifiers instead of percent format UP031_0.py:94:1: UP031 [*] Use format specifiers instead of percent format | 92 | ) % (x, y) -93 | +93 | 94 | / ( 95 | | "foo %(foo)s " 96 | | "bar %(bar)s" 97 | | ) % {"foo": x, "bar": y} | |________________________^ UP031 -98 | +98 | 99 | ( | = help: Replace with format specifiers @@ -849,8 +845,7 @@ UP031_0.py:94:1: UP031 [*] Use format specifiers instead of percent format UP031_0.py:100:5: UP031 [*] Use format specifiers instead of percent format | 99 | ( -100 | """foo %s""" - | _____^ +100 | / """foo %s""" 101 | | % (x,) | |__________^ UP031 102 | ) @@ -871,8 +866,7 @@ UP031_0.py:100:5: UP031 [*] Use format specifiers instead of percent format UP031_0.py:105:5: UP031 [*] Use format specifiers instead of percent format | 104 | ( -105 | """ - | _____^ +105 | / """ 106 | | foo %s 107 | | """ 108 | | % (x,) @@ -897,7 +891,7 @@ UP031_0.py:105:5: UP031 [*] Use format specifiers instead of percent format UP031_0.py:111:1: UP031 [*] Use format specifiers instead of percent format | 109 | ) -110 | +110 | 111 | / "%s" % ( 112 | | x, # comment 113 | | ) @@ -919,12 +913,12 @@ UP031_0.py:116:8: UP031 [*] Use format specifiers instead of percent format | 116 | path = "%s-%s-%s.pem" % ( | ________^ -117 | | safe_domain_name(cn), # common name, which should be filename safe because it is IDNA-encoded, but in case of a malformed cert make sure it's ok to use as a filename +117 | | safe_domain_name(cn), # common name, which should be filename safe because it is IDNA-encoded, but in case of a malformed cert ma… 118 | | cert.not_valid_after.date().isoformat().replace("-", ""), # expiration date 119 | | hexlify(cert.fingerprint(hashes.SHA256())).decode("ascii")[0:8], # fingerprint prefix 120 | | ) | |_^ UP031 -121 | +121 | 122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) | = help: Replace with format specifiers @@ -944,7 +938,7 @@ UP031_0.py:123:1: UP031 [*] Use format specifiers instead of percent format 122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) 123 | 'Hello %s' % bar | ^^^^^^^^^^^^^^^^ UP031 -124 | +124 | 125 | 'Hello %s' % bar.baz | = help: Replace with format specifiers @@ -962,10 +956,10 @@ UP031_0.py:123:1: UP031 [*] Use format specifiers instead of percent format UP031_0.py:125:1: UP031 [*] Use format specifiers instead of percent format | 123 | 'Hello %s' % bar -124 | +124 | 125 | 'Hello %s' % bar.baz | ^^^^^^^^^^^^^^^^^^^^ UP031 -126 | +126 | 127 | 'Hello %s' % bar['bop'] | = help: Replace with format specifiers @@ -983,10 +977,10 @@ UP031_0.py:125:1: UP031 [*] Use format specifiers instead of percent format UP031_0.py:127:1: UP031 [*] Use format specifiers instead of percent format | 125 | 'Hello %s' % bar.baz -126 | +126 | 127 | 'Hello %s' % bar['bop'] | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -128 | +128 | 129 | # Not a valid type annotation but this test shouldn't result in a panic. | = help: Replace with format specifiers @@ -1007,7 +1001,7 @@ UP031_0.py:131:5: UP031 [*] Use format specifiers instead of percent format 130 | # Refer: https://github.com/astral-sh/ruff/issues/11736 131 | x: "'%s + %s' % (1, 2)" | ^^^^^^^^^^^^^^^^^^ UP031 -132 | +132 | 133 | # See: https://github.com/astral-sh/ruff/issues/12421 | = help: Replace with format specifiers @@ -1110,7 +1104,7 @@ UP031_0.py:138:7: UP031 [*] Use format specifiers instead of percent format 137 | print("%.00002X" % 1) 138 | print("%.20X" % 1) | ^^^^^^^^^^^ UP031 -139 | +139 | 140 | print("%2X" % 1) | = help: Replace with format specifiers @@ -1128,7 +1122,7 @@ UP031_0.py:138:7: UP031 [*] Use format specifiers instead of percent format UP031_0.py:140:7: UP031 [*] Use format specifiers instead of percent format | 138 | print("%.20X" % 1) -139 | +139 | 140 | print("%2X" % 1) | ^^^^^^^^^ UP031 141 | print("%02X" % 1) @@ -1150,7 +1144,7 @@ UP031_0.py:141:7: UP031 [*] Use format specifiers instead of percent format 140 | print("%2X" % 1) 141 | print("%02X" % 1) | ^^^^^^^^^^ UP031 -142 | +142 | 143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) | = help: Replace with format specifiers @@ -1163,4 +1157,156 @@ UP031_0.py:141:7: UP031 [*] Use format specifiers instead of percent format 141 |+print("{:02X}".format(1)) 142 142 | 143 143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) -144 144 | +144 144 | + +UP031_0.py:145:1: UP031 Use format specifiers instead of percent format + | +143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) +144 | +145 | "%d.%d" % (a, b) + | ^^^^^^^ UP031 +146 | +147 | "%*s" % (5, "hi") + | + = help: Replace with format specifiers + +UP031_0.py:147:1: UP031 Use format specifiers instead of percent format + | +145 | "%d.%d" % (a, b) +146 | +147 | "%*s" % (5, "hi") + | ^^^^^ UP031 +148 | +149 | "%d" % (flt,) + | + = help: Replace with format specifiers + +UP031_0.py:149:1: UP031 Use format specifiers instead of percent format + | +147 | "%*s" % (5, "hi") +148 | +149 | "%d" % (flt,) + | ^^^^ UP031 +150 | +151 | "%c" % (some_string,) + | + = help: Replace with format specifiers + +UP031_0.py:151:1: UP031 Use format specifiers instead of percent format + | +149 | "%d" % (flt,) +150 | +151 | "%c" % (some_string,) + | ^^^^ UP031 +152 | +153 | "%.2r" % (1.25) + | + = help: Replace with format specifiers + +UP031_0.py:153:1: UP031 Use format specifiers instead of percent format + | +151 | "%c" % (some_string,) +152 | +153 | "%.2r" % (1.25) + | ^^^^^^ UP031 +154 | +155 | "%.*s" % (5, "hi") + | + = help: Replace with format specifiers + +UP031_0.py:155:1: UP031 Use format specifiers instead of percent format + | +153 | "%.2r" % (1.25) +154 | +155 | "%.*s" % (5, "hi") + | ^^^^^^ UP031 +156 | +157 | "%i" % (flt,) + | + = help: Replace with format specifiers + +UP031_0.py:157:1: UP031 Use format specifiers instead of percent format + | +155 | "%.*s" % (5, "hi") +156 | +157 | "%i" % (flt,) + | ^^^^ UP031 +158 | +159 | "%()s" % {"": "empty"} + | + = help: Replace with format specifiers + +UP031_0.py:159:1: UP031 Use format specifiers instead of percent format + | +157 | "%i" % (flt,) +158 | +159 | "%()s" % {"": "empty"} + | ^^^^^^ UP031 +160 | +161 | "%s" % {"k": "v"} + | + = help: Replace with format specifiers + +UP031_0.py:161:1: UP031 Use format specifiers instead of percent format + | +159 | "%()s" % {"": "empty"} +160 | +161 | "%s" % {"k": "v"} + | ^^^^ UP031 +162 | +163 | "%()s" % {"": "bar"} + | + = help: Replace with format specifiers + +UP031_0.py:163:1: UP031 Use format specifiers instead of percent format + | +161 | "%s" % {"k": "v"} +162 | +163 | "%()s" % {"": "bar"} + | ^^^^^^ UP031 +164 | +165 | "%(1)s" % {"1": "bar"} + | + = help: Replace with format specifiers + +UP031_0.py:165:1: UP031 Use format specifiers instead of percent format + | +163 | "%()s" % {"": "bar"} +164 | +165 | "%(1)s" % {"1": "bar"} + | ^^^^^^^ UP031 +166 | +167 | "%(a)s" % {"a": 1, "a": 2} + | + = help: Replace with format specifiers + +UP031_0.py:167:1: UP031 Use format specifiers instead of percent format + | +165 | "%(1)s" % {"1": "bar"} +166 | +167 | "%(a)s" % {"a": 1, "a": 2} + | ^^^^^^^ UP031 +168 | +169 | "%(1)s" % {1: 2, "1": 2} + | + = help: Replace with format specifiers + +UP031_0.py:169:1: UP031 Use format specifiers instead of percent format + | +167 | "%(a)s" % {"a": 1, "a": 2} +168 | +169 | "%(1)s" % {1: 2, "1": 2} + | ^^^^^^^ UP031 +170 | +171 | "%(and)s" % {"and": 2} + | + = help: Replace with format specifiers + +UP031_0.py:171:1: UP031 Use format specifiers instead of percent format + | +169 | "%(1)s" % {1: 2, "1": 2} +170 | +171 | "%(and)s" % {"and": 2} + | ^^^^^^^^^ UP031 + | + = help: Replace with format specifiers diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_1.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP031_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_0.py.snap index 487e05372715f..51bd88cd7f65d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_0.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP032_0.py:5:1: UP032 [*] Use f-string instead of `format` call | 3 | ### -4 | +4 | 5 | "{} {}".format(a, b) | ^^^^^^^^^^^^^^^^^^^^ UP032 -6 | +6 | 7 | "{1} {0}".format(a, b) | = help: Convert to f-string @@ -25,10 +25,10 @@ UP032_0.py:5:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:7:1: UP032 [*] Use f-string instead of `format` call | 5 | "{} {}".format(a, b) -6 | +6 | 7 | "{1} {0}".format(a, b) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 -8 | +8 | 9 | "{0} {1} {0}".format(a, b) | = help: Convert to f-string @@ -46,10 +46,10 @@ UP032_0.py:7:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:9:1: UP032 [*] Use f-string instead of `format` call | 7 | "{1} {0}".format(a, b) - 8 | + 8 | 9 | "{0} {1} {0}".format(a, b) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -10 | +10 | 11 | "{x.y}".format(x=z) | = help: Convert to f-string @@ -67,10 +67,10 @@ UP032_0.py:9:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:11:1: UP032 [*] Use f-string instead of `format` call | 9 | "{0} {1} {0}".format(a, b) -10 | +10 | 11 | "{x.y}".format(x=z) | ^^^^^^^^^^^^^^^^^^^ UP032 -12 | +12 | 13 | "{x} {y} {x}".format(x=a, y=b) | = help: Convert to f-string @@ -88,10 +88,10 @@ UP032_0.py:11:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:13:1: UP032 [*] Use f-string instead of `format` call | 11 | "{x.y}".format(x=z) -12 | +12 | 13 | "{x} {y} {x}".format(x=a, y=b) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -14 | +14 | 15 | "{.x} {.y}".format(a, b) | = help: Convert to f-string @@ -109,10 +109,10 @@ UP032_0.py:13:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:15:1: UP032 [*] Use f-string instead of `format` call | 13 | "{x} {y} {x}".format(x=a, y=b) -14 | +14 | 15 | "{.x} {.y}".format(a, b) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -16 | +16 | 17 | "{} {}".format(a.b, c.d) | = help: Convert to f-string @@ -130,10 +130,10 @@ UP032_0.py:15:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:17:1: UP032 [*] Use f-string instead of `format` call | 15 | "{.x} {.y}".format(a, b) -16 | +16 | 17 | "{} {}".format(a.b, c.d) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -18 | +18 | 19 | "{}".format(a()) | = help: Convert to f-string @@ -151,10 +151,10 @@ UP032_0.py:17:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:19:1: UP032 [*] Use f-string instead of `format` call | 17 | "{} {}".format(a.b, c.d) -18 | +18 | 19 | "{}".format(a()) | ^^^^^^^^^^^^^^^^ UP032 -20 | +20 | 21 | "{}".format(a.b()) | = help: Convert to f-string @@ -172,10 +172,10 @@ UP032_0.py:19:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:21:1: UP032 [*] Use f-string instead of `format` call | 19 | "{}".format(a()) -20 | +20 | 21 | "{}".format(a.b()) | ^^^^^^^^^^^^^^^^^^ UP032 -22 | +22 | 23 | "{}".format(a.b().c()) | = help: Convert to f-string @@ -193,10 +193,10 @@ UP032_0.py:21:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:23:1: UP032 [*] Use f-string instead of `format` call | 21 | "{}".format(a.b()) -22 | +22 | 23 | "{}".format(a.b().c()) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 -24 | +24 | 25 | "hello {}!".format(name) | = help: Convert to f-string @@ -214,10 +214,10 @@ UP032_0.py:23:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:25:1: UP032 [*] Use f-string instead of `format` call | 23 | "{}".format(a.b().c()) -24 | +24 | 25 | "hello {}!".format(name) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -26 | +26 | 27 | "{}{b}{}".format(a, c, b=b) | = help: Convert to f-string @@ -235,10 +235,10 @@ UP032_0.py:25:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:27:1: UP032 [*] Use f-string instead of `format` call | 25 | "hello {}!".format(name) -26 | +26 | 27 | "{}{b}{}".format(a, c, b=b) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -28 | +28 | 29 | "{}".format(0x0) | = help: Convert to f-string @@ -256,10 +256,10 @@ UP032_0.py:27:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:29:1: UP032 [*] Use f-string instead of `format` call | 27 | "{}{b}{}".format(a, c, b=b) -28 | +28 | 29 | "{}".format(0x0) | ^^^^^^^^^^^^^^^^ UP032 -30 | +30 | 31 | "{} {}".format(a, b) | = help: Convert to f-string @@ -277,10 +277,10 @@ UP032_0.py:29:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:31:1: UP032 [*] Use f-string instead of `format` call | 29 | "{}".format(0x0) -30 | +30 | 31 | "{} {}".format(a, b) | ^^^^^^^^^^^^^^^^^^^^ UP032 -32 | +32 | 33 | """{} {}""".format(a, b) | = help: Convert to f-string @@ -298,10 +298,10 @@ UP032_0.py:31:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:33:1: UP032 [*] Use f-string instead of `format` call | 31 | "{} {}".format(a, b) -32 | +32 | 33 | """{} {}""".format(a, b) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -34 | +34 | 35 | "foo{}".format(1) | = help: Convert to f-string @@ -319,10 +319,10 @@ UP032_0.py:33:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:35:1: UP032 [*] Use f-string instead of `format` call | 33 | """{} {}""".format(a, b) -34 | +34 | 35 | "foo{}".format(1) | ^^^^^^^^^^^^^^^^^ UP032 -36 | +36 | 37 | r"foo{}".format(1) | = help: Convert to f-string @@ -340,10 +340,10 @@ UP032_0.py:35:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:37:1: UP032 [*] Use f-string instead of `format` call | 35 | "foo{}".format(1) -36 | +36 | 37 | r"foo{}".format(1) | ^^^^^^^^^^^^^^^^^^ UP032 -38 | +38 | 39 | x = "{a}".format(a=1) | = help: Convert to f-string @@ -361,10 +361,10 @@ UP032_0.py:37:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:39:5: UP032 [*] Use f-string instead of `format` call | 37 | r"foo{}".format(1) -38 | +38 | 39 | x = "{a}".format(a=1) | ^^^^^^^^^^^^^^^^^ UP032 -40 | +40 | 41 | print("foo {} ".format(x)) | = help: Convert to f-string @@ -382,10 +382,10 @@ UP032_0.py:39:5: UP032 [*] Use f-string instead of `format` call UP032_0.py:41:7: UP032 [*] Use f-string instead of `format` call | 39 | x = "{a}".format(a=1) -40 | +40 | 41 | print("foo {} ".format(x)) | ^^^^^^^^^^^^^^^^^^^ UP032 -42 | +42 | 43 | "{a[b]}".format(a=a) | = help: Convert to f-string @@ -403,10 +403,10 @@ UP032_0.py:41:7: UP032 [*] Use f-string instead of `format` call UP032_0.py:43:1: UP032 [*] Use f-string instead of `format` call | 41 | print("foo {} ".format(x)) -42 | +42 | 43 | "{a[b]}".format(a=a) | ^^^^^^^^^^^^^^^^^^^^ UP032 -44 | +44 | 45 | "{a.a[b]}".format(a=a) | = help: Convert to f-string @@ -424,10 +424,10 @@ UP032_0.py:43:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:45:1: UP032 [*] Use f-string instead of `format` call | 43 | "{a[b]}".format(a=a) -44 | +44 | 45 | "{a.a[b]}".format(a=a) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 -46 | +46 | 47 | "{}{{}}{}".format(escaped, y) | = help: Convert to f-string @@ -445,10 +445,10 @@ UP032_0.py:45:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:47:1: UP032 [*] Use f-string instead of `format` call | 45 | "{a.a[b]}".format(a=a) -46 | +46 | 47 | "{}{{}}{}".format(escaped, y) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -48 | +48 | 49 | "{}".format(a) | = help: Convert to f-string @@ -466,10 +466,10 @@ UP032_0.py:47:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:49:1: UP032 [*] Use f-string instead of `format` call | 47 | "{}{{}}{}".format(escaped, y) -48 | +48 | 49 | "{}".format(a) | ^^^^^^^^^^^^^^ UP032 -50 | +50 | 51 | '({}={{0!e}})'.format(a) | = help: Convert to f-string @@ -487,10 +487,10 @@ UP032_0.py:49:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:51:1: UP032 [*] Use f-string instead of `format` call | 49 | "{}".format(a) -50 | +50 | 51 | '({}={{0!e}})'.format(a) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -52 | +52 | 53 | "{[b]}".format(a) | = help: Convert to f-string @@ -508,10 +508,10 @@ UP032_0.py:51:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:53:1: UP032 [*] Use f-string instead of `format` call | 51 | '({}={{0!e}})'.format(a) -52 | +52 | 53 | "{[b]}".format(a) | ^^^^^^^^^^^^^^^^^ UP032 -54 | +54 | 55 | '{[b]}'.format(a) | = help: Convert to f-string @@ -529,10 +529,10 @@ UP032_0.py:53:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:55:1: UP032 [*] Use f-string instead of `format` call | 53 | "{[b]}".format(a) -54 | +54 | 55 | '{[b]}'.format(a) | ^^^^^^^^^^^^^^^^^ UP032 -56 | +56 | 57 | """{[b]}""".format(a) | = help: Convert to f-string @@ -550,10 +550,10 @@ UP032_0.py:55:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:57:1: UP032 [*] Use f-string instead of `format` call | 55 | '{[b]}'.format(a) -56 | +56 | 57 | """{[b]}""".format(a) | ^^^^^^^^^^^^^^^^^^^^^ UP032 -58 | +58 | 59 | '''{[b]}'''.format(a) | = help: Convert to f-string @@ -571,10 +571,10 @@ UP032_0.py:57:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:59:1: UP032 [*] Use f-string instead of `format` call | 57 | """{[b]}""".format(a) -58 | +58 | 59 | '''{[b]}'''.format(a) | ^^^^^^^^^^^^^^^^^^^^^ UP032 -60 | +60 | 61 | "{}".format( | = help: Convert to f-string @@ -592,12 +592,12 @@ UP032_0.py:59:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:61:1: UP032 [*] Use f-string instead of `format` call | 59 | '''{[b]}'''.format(a) -60 | +60 | 61 | / "{}".format( 62 | | 1 63 | | ) | |_^ UP032 -64 | +64 | 65 | "123456789 {}".format( | = help: Convert to f-string @@ -617,12 +617,12 @@ UP032_0.py:61:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:65:1: UP032 [*] Use f-string instead of `format` call | 63 | ) -64 | +64 | 65 | / "123456789 {}".format( 66 | | 1111111111111111111111111111111111111111111111111111111111111111111111111, 67 | | ) | |_^ UP032 -68 | +68 | 69 | """ | = help: Convert to f-string @@ -642,12 +642,12 @@ UP032_0.py:65:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:69:1: UP032 [*] Use f-string instead of `format` call | 67 | ) -68 | +68 | 69 | / """ 70 | | {} 71 | | """.format(1) | |_____________^ UP032 -72 | +72 | 73 | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = """ | = help: Convert to f-string @@ -668,7 +668,7 @@ UP032_0.py:69:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:73:85: UP032 [*] Use f-string instead of `format` call | 71 | """.format(1) -72 | +72 | 73 | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = """ | _____________________________________________________________________________________^ 74 | | {} @@ -676,7 +676,7 @@ UP032_0.py:73:85: UP032 [*] Use f-string instead of `format` call 76 | | 111111 77 | | ) | |_^ UP032 -78 | +78 | 79 | "{a}" "{b}".format(a=1, b=1) | = help: Convert to f-string @@ -700,10 +700,10 @@ UP032_0.py:73:85: UP032 [*] Use f-string instead of `format` call UP032_0.py:79:1: UP032 [*] Use f-string instead of `format` call | 77 | ) -78 | +78 | 79 | "{a}" "{b}".format(a=1, b=1) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -80 | +80 | 81 | ( | = help: Convert to f-string @@ -721,13 +721,13 @@ UP032_0.py:79:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:81:1: UP032 [*] Use f-string instead of `format` call | 79 | "{a}" "{b}".format(a=1, b=1) -80 | +80 | 81 | / ( 82 | | "{a}" 83 | | "{b}" 84 | | ).format(a=1, b=1) | |__________________^ UP032 -85 | +85 | 86 | ( | = help: Convert to f-string @@ -749,7 +749,7 @@ UP032_0.py:81:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:86:1: UP032 [*] Use f-string instead of `format` call | 84 | ).format(a=1, b=1) -85 | +85 | 86 | / ( 87 | | "{a}" 88 | | "" @@ -757,7 +757,7 @@ UP032_0.py:86:1: UP032 [*] Use f-string instead of `format` call 90 | | "" 91 | | ).format(a=1, b=1) | |__________________^ UP032 -92 | +92 | 93 | ( | = help: Convert to f-string @@ -781,8 +781,7 @@ UP032_0.py:86:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:94:5: UP032 [*] Use f-string instead of `format` call | 93 | ( - 94 | ( - | _____^ + 94 | / ( 95 | | # comment 96 | | "{a}" 97 | | # comment @@ -815,7 +814,7 @@ UP032_0.py:94:5: UP032 [*] Use f-string instead of `format` call UP032_0.py:104:1: UP032 [*] Use f-string instead of `format` call | 102 | ) -103 | +103 | 104 | / ( 105 | | "{a}" 106 | | "b" @@ -930,7 +929,7 @@ UP032_0.py:129:1: UP032 [*] Use f-string instead of `format` call | 129 | "{}".format(1 * 2) | ^^^^^^^^^^^^^^^^^^ UP032 -130 | +130 | 131 | ### | = help: Convert to f-string @@ -948,12 +947,12 @@ UP032_0.py:129:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:160:1: UP032 [*] Use f-string instead of `format` call | 158 | r'"\N{snowman} {}".format(a)' -159 | +159 | 160 | / "123456789 {}".format( 161 | | 11111111111111111111111111111111111111111111111111111111111111111111111111, 162 | | ) | |_^ UP032 -163 | +163 | 164 | """ | = help: Convert to f-string @@ -973,7 +972,7 @@ UP032_0.py:160:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:164:1: UP032 [*] Use f-string instead of `format` call | 162 | ) -163 | +163 | 164 | / """ 165 | | {} 166 | | {} @@ -984,7 +983,7 @@ UP032_0.py:164:1: UP032 [*] Use f-string instead of `format` call 171 | | 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111, 172 | | ) | |_^ UP032 -173 | +173 | 174 | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = """{} | = help: Convert to f-string @@ -1013,14 +1012,14 @@ UP032_0.py:164:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:174:84: UP032 [*] Use f-string instead of `format` call | 172 | ) -173 | +173 | 174 | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = """{} | ____________________________________________________________________________________^ 175 | | """.format( 176 | | 111111 177 | | ) | |_^ UP032 -178 | +178 | 179 | "{}".format( | = help: Convert to f-string @@ -1042,7 +1041,7 @@ UP032_0.py:174:84: UP032 [*] Use f-string instead of `format` call UP032_0.py:202:1: UP032 Use f-string instead of `format` call | 200 | "{}".format(**c) -201 | +201 | 202 | / "{}".format( 203 | | 1 # comment 204 | | ) @@ -1056,7 +1055,7 @@ UP032_0.py:209:1: UP032 [*] Use f-string instead of `format` call 208 | # existing line length, so it's fine. 209 | "<Customer: {}, {}, {}, {}, {}>".format(self.internal_ids, self.external_ids, self.properties, self.tags, self.others) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -210 | +210 | 211 | # When fixing, trim the trailing empty string. | = help: Convert to f-string @@ -1078,7 +1077,7 @@ UP032_0.py:212:18: UP032 [*] Use f-string instead of `format` call | __________________^ 213 | | "".format(new_dict, d)) | |_______________________________________^ UP032 -214 | +214 | 215 | # When fixing, trim the trailing empty string. | = help: Convert to f-string @@ -1101,7 +1100,7 @@ UP032_0.py:216:18: UP032 [*] Use f-string instead of `format` call | __________________^ 217 | | .format(new_dict, d)) | |_____________________________________^ UP032 -218 | +218 | 219 | raise ValueError( | = help: Convert to f-string @@ -1121,8 +1120,7 @@ UP032_0.py:216:18: UP032 [*] Use f-string instead of `format` call UP032_0.py:220:5: UP032 [*] Use f-string instead of `format` call | 219 | raise ValueError( -220 | "Conflicting configuration dicts: {!r} {!r}" - | _____^ +220 | / "Conflicting configuration dicts: {!r} {!r}" 221 | | "".format(new_dict, d) | |__________________________^ UP032 222 | ) @@ -1143,11 +1141,10 @@ UP032_0.py:220:5: UP032 [*] Use f-string instead of `format` call UP032_0.py:225:5: UP032 [*] Use f-string instead of `format` call | 224 | raise ValueError( -225 | "Conflicting configuration dicts: {!r} {!r}" - | _____^ +225 | / "Conflicting configuration dicts: {!r} {!r}" 226 | | "".format(new_dict, d) | |__________________________^ UP032 -227 | +227 | 228 | ) | = help: Convert to f-string @@ -1171,7 +1168,7 @@ UP032_0.py:231:1: UP032 [*] Use f-string instead of `format` call 233 | | "{{}}" 234 | | ).format(a) | |___________^ UP032 -235 | +235 | 236 | ("{}" "{{}}").format(a) | = help: Convert to f-string @@ -1192,7 +1189,7 @@ UP032_0.py:231:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:236:1: UP032 [*] Use f-string instead of `format` call | 234 | ).format(a) -235 | +235 | 236 | ("{}" "{{}}").format(a) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 | @@ -1216,7 +1213,7 @@ UP032_0.py:240:1: UP032 [*] Use f-string instead of `format` call 242 | | "{{{}}}" 243 | | ).format(a, b) | |______________^ UP032 -244 | +244 | 245 | ("{}" "{{{}}}").format(a, b) | = help: Convert to f-string @@ -1238,10 +1235,10 @@ UP032_0.py:240:1: UP032 [*] Use f-string instead of `format` call UP032_0.py:245:1: UP032 [*] Use f-string instead of `format` call | 243 | ).format(a, b) -244 | +244 | 245 | ("{}" "{{{}}}").format(a, b) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -246 | +246 | 247 | # The dictionary should be parenthesized. | = help: Convert to f-string @@ -1261,7 +1258,7 @@ UP032_0.py:248:1: UP032 [*] Use f-string instead of `format` call 247 | # The dictionary should be parenthesized. 248 | "{}".format({0: 1}[0]) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 -249 | +249 | 250 | # The dictionary should be parenthesized. | = help: Convert to f-string @@ -1281,7 +1278,7 @@ UP032_0.py:251:1: UP032 [*] Use f-string instead of `format` call 250 | # The dictionary should be parenthesized. 251 | "{}".format({0: 1}.bar) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 -252 | +252 | 253 | # The dictionary should be parenthesized. | = help: Convert to f-string @@ -1301,7 +1298,7 @@ UP032_0.py:254:1: UP032 [*] Use f-string instead of `format` call 253 | # The dictionary should be parenthesized. 254 | "{}".format({0: 1}()) | ^^^^^^^^^^^^^^^^^^^^^ UP032 -255 | +255 | 256 | # The string shouldn't be converted, since it would require repeating the function call. | = help: Convert to f-string @@ -1321,7 +1318,7 @@ UP032_0.py:261:1: UP032 [*] Use f-string instead of `format` call 260 | # The string _should_ be converted, since the function call is repeated in the arguments. 261 | "{0} {1}".format(foo(), foo()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -262 | +262 | 263 | # The call should be removed, but the string itself should remain. | = help: Convert to f-string @@ -1341,7 +1338,7 @@ UP032_0.py:264:1: UP032 [*] Use f-string instead of `format` call 263 | # The call should be removed, but the string itself should remain. 264 | ''.format(self.project) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 -265 | +265 | 266 | # The call should be removed, but the string itself should remain. | = help: Convert to f-string @@ -1361,7 +1358,7 @@ UP032_0.py:267:1: UP032 [*] Use f-string instead of `format` call 266 | # The call should be removed, but the string itself should remain. 267 | "".format(self.project) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 -268 | +268 | 269 | # Not a valid type annotation but this test shouldn't result in a panic. | = help: Convert to f-string diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_1.py.snap index 221526314e6fb..dbb0955b48878 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP032_1.py:1:1: UP032 [*] Use f-string instead of `format` call | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_2.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_2.py.snap index 7ad4096da6182..2789248a3c1a5 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_2.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_2.py.snap @@ -44,7 +44,7 @@ UP032_2.py:4:1: UP032 [*] Use f-string instead of `format` call 3 | "{0.real}".format(1) 4 | "{a.real}".format(a=1) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 -5 | +5 | 6 | "{.real}".format(1.0) | = help: Convert to f-string @@ -62,7 +62,7 @@ UP032_2.py:4:1: UP032 [*] Use f-string instead of `format` call UP032_2.py:6:1: UP032 [*] Use f-string instead of `format` call | 4 | "{a.real}".format(a=1) -5 | +5 | 6 | "{.real}".format(1.0) | ^^^^^^^^^^^^^^^^^^^^^ UP032 7 | "{0.real}".format(1.0) @@ -105,7 +105,7 @@ UP032_2.py:8:1: UP032 [*] Use f-string instead of `format` call 7 | "{0.real}".format(1.0) 8 | "{a.real}".format(a=1.0) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP032 - 9 | + 9 | 10 | "{.real}".format(1j) | = help: Convert to f-string @@ -123,7 +123,7 @@ UP032_2.py:8:1: UP032 [*] Use f-string instead of `format` call UP032_2.py:10:1: UP032 [*] Use f-string instead of `format` call | 8 | "{a.real}".format(a=1.0) - 9 | + 9 | 10 | "{.real}".format(1j) | ^^^^^^^^^^^^^^^^^^^^ UP032 11 | "{0.real}".format(1j) @@ -166,7 +166,7 @@ UP032_2.py:12:1: UP032 [*] Use f-string instead of `format` call 11 | "{0.real}".format(1j) 12 | "{a.real}".format(a=1j) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 -13 | +13 | 14 | "{.real}".format(0b01) | = help: Convert to f-string @@ -184,7 +184,7 @@ UP032_2.py:12:1: UP032 [*] Use f-string instead of `format` call UP032_2.py:14:1: UP032 [*] Use f-string instead of `format` call | 12 | "{a.real}".format(a=1j) -13 | +13 | 14 | "{.real}".format(0b01) | ^^^^^^^^^^^^^^^^^^^^^^ UP032 15 | "{0.real}".format(0b01) @@ -227,7 +227,7 @@ UP032_2.py:16:1: UP032 [*] Use f-string instead of `format` call 15 | "{0.real}".format(0b01) 16 | "{a.real}".format(a=0b01) | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -17 | +17 | 18 | "{}".format(1 + 2) | = help: Convert to f-string @@ -245,7 +245,7 @@ UP032_2.py:16:1: UP032 [*] Use f-string instead of `format` call UP032_2.py:18:1: UP032 [*] Use f-string instead of `format` call | 16 | "{a.real}".format(a=0b01) -17 | +17 | 18 | "{}".format(1 + 2) | ^^^^^^^^^^^^^^^^^^ UP032 19 | "{}".format([1, 2]) @@ -330,7 +330,7 @@ UP032_2.py:22:1: UP032 [*] Use f-string instead of `format` call 21 | "{}".format({1: 2, 3: 4}) 22 | "{}".format((i for i in range(2))) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP032 -23 | +23 | 24 | "{.real}".format(1 + 2) | = help: Convert to f-string @@ -348,7 +348,7 @@ UP032_2.py:22:1: UP032 [*] Use f-string instead of `format` call UP032_2.py:24:1: UP032 [*] Use f-string instead of `format` call | 22 | "{}".format((i for i in range(2))) -23 | +23 | 24 | "{.real}".format(1 + 2) | ^^^^^^^^^^^^^^^^^^^^^^^ UP032 25 | "{.real}".format([1, 2]) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_3.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_3.py.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_3.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP032_3.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_0.py.snap index 8d6d1475d226c..bef261b87eb76 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP033_0.py:4:21: UP033 [*] Use `@functools.cache` instead of `@functools.lru_cache(maxsize=None)` | @@ -58,5 +59,3 @@ UP033_0.py:15:21: UP033 [*] Use `@functools.cache` instead of `@functools.lru_ca 16 16 | @other_decorator 17 17 | def fixme(): 18 18 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_1.py.snap index 5b106d25411d2..5cf350c7e02a7 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP033_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP033_1.py:4:11: UP033 [*] Use `@functools.cache` instead of `@functools.lru_cache(maxsize=None)` | @@ -71,5 +72,3 @@ UP033_1.py:15:11: UP033 [*] Use `@functools.cache` instead of `@functools.lru_ca 16 16 | @other_decorator 17 17 | def fixme(): 18 18 | pass - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP034.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP034.py.snap index 52e90884c17da..4c93c84778067 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP034.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP034.py.snap @@ -6,7 +6,7 @@ UP034.py:2:7: UP034 [*] Avoid extraneous parentheses 1 | # UP034 2 | print(("foo")) | ^^^^^^^ UP034 -3 | +3 | 4 | # UP034 | = help: Remove extraneous parentheses @@ -24,7 +24,7 @@ UP034.py:5:7: UP034 [*] Avoid extraneous parentheses 4 | # UP034 5 | print(("hell((goodybe))o")) | ^^^^^^^^^^^^^^^^^^^^ UP034 -6 | +6 | 7 | # UP034 | = help: Remove extraneous parentheses @@ -44,7 +44,7 @@ UP034.py:8:7: UP034 [*] Avoid extraneous parentheses 7 | # UP034 8 | print((("foo"))) | ^^^^^^^^^ UP034 - 9 | + 9 | 10 | # UP034 | = help: Remove extraneous parentheses @@ -64,7 +64,7 @@ UP034.py:11:7: UP034 [*] Avoid extraneous parentheses 10 | # UP034 11 | print((((1)))) | ^^^^^^^ UP034 -12 | +12 | 13 | # UP034 | = help: Remove extraneous parentheses @@ -84,7 +84,7 @@ UP034.py:14:7: UP034 [*] Avoid extraneous parentheses 13 | # UP034 14 | print(("foo{}".format(1))) | ^^^^^^^^^^^^^^^^^^^ UP034 -15 | +15 | 16 | # UP034 | = help: Remove extraneous parentheses @@ -123,8 +123,7 @@ UP034.py:23:5: UP034 [*] Avoid extraneous parentheses | 21 | # UP034 22 | print( -23 | ( - | _____^ +23 | / ( 24 | | "foo" 25 | | ) | |_____^ UP034 @@ -151,7 +150,7 @@ UP034.py:30:13: UP034 [*] Avoid extraneous parentheses 29 | def f(): 30 | x = int(((yield 1))) | ^^^^^^^^^^^ UP034 -31 | +31 | 32 | # UP034 | = help: Remove extraneous parentheses @@ -191,7 +190,7 @@ UP034.py:39:7: UP034 [*] Avoid extraneous parentheses 38 | # UP034 39 | print((x for x in range(3))) | ^^^^^^^^^^^^^^^^^^^^^ UP034 -40 | +40 | 41 | # OK | = help: Remove extraneous parentheses @@ -205,5 +204,3 @@ UP034.py:39:7: UP034 [*] Avoid extraneous parentheses 40 40 | 41 41 | # OK 42 42 | print("foo") - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP035.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP035.py.snap index e83b5d88e3ec8..fb3b19b94aef7 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP035.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP035.py.snap @@ -6,7 +6,7 @@ UP035.py:2:1: UP035 [*] Import from `collections.abc` instead: `Mapping` 1 | # UP035 2 | from collections import Mapping | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -3 | +3 | 4 | from collections import Mapping as MAP | = help: Import from `collections.abc` @@ -22,10 +22,10 @@ UP035.py:2:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:4:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 2 | from collections import Mapping -3 | +3 | 4 | from collections import Mapping as MAP | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -5 | +5 | 6 | from collections import Mapping, Sequence | = help: Import from `collections.abc` @@ -43,10 +43,10 @@ UP035.py:4:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:6:1: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Sequence` | 4 | from collections import Mapping as MAP -5 | +5 | 6 | from collections import Mapping, Sequence | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -7 | +7 | 8 | from collections import Counter, Mapping | = help: Import from `collections.abc` @@ -64,10 +64,10 @@ UP035.py:6:1: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Seque UP035.py:8:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 6 | from collections import Mapping, Sequence - 7 | + 7 | 8 | from collections import Counter, Mapping | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 - 9 | + 9 | 10 | from collections import (Counter, Mapping) | = help: Import from `collections.abc` @@ -86,10 +86,10 @@ UP035.py:8:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:10:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 8 | from collections import Counter, Mapping - 9 | + 9 | 10 | from collections import (Counter, Mapping) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -11 | +11 | 12 | from collections import (Counter, | = help: Import from `collections.abc` @@ -108,11 +108,11 @@ UP035.py:10:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:12:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 10 | from collections import (Counter, Mapping) -11 | +11 | 12 | / from collections import (Counter, 13 | | Mapping) | |_________________________________^ UP035 -14 | +14 | 15 | from collections import Counter, \ | = help: Import from `collections.abc` @@ -132,11 +132,11 @@ UP035.py:12:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:15:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 13 | Mapping) -14 | +14 | 15 | / from collections import Counter, \ 16 | | Mapping | |________________________________^ UP035 -17 | +17 | 18 | from collections import Counter, Mapping, Sequence | = help: Import from `collections.abc` @@ -156,10 +156,10 @@ UP035.py:15:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:18:1: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Sequence` | 16 | Mapping -17 | +17 | 18 | from collections import Counter, Mapping, Sequence | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -19 | +19 | 20 | from collections import Mapping as mapping, Counter | = help: Import from `collections.abc` @@ -178,10 +178,10 @@ UP035.py:18:1: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Sequ UP035.py:20:1: UP035 [*] Import from `collections.abc` instead: `Mapping` | 18 | from collections import Counter, Mapping, Sequence -19 | +19 | 20 | from collections import Mapping as mapping, Counter | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -21 | +21 | 22 | if True: | = help: Import from `collections.abc` @@ -202,7 +202,7 @@ UP035.py:23:5: UP035 [*] Import from `collections.abc` instead: `Mapping` 22 | if True: 23 | from collections import Mapping, Counter | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -24 | +24 | 25 | if True: | = help: Import from `collections.abc` @@ -224,7 +224,7 @@ UP035.py:28:5: UP035 [*] Import from `collections.abc` instead: `Mapping` 27 | pass 28 | from collections import Mapping, Counter | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -29 | +29 | 30 | if True: from collections import Mapping | = help: Import from `collections.abc` @@ -243,10 +243,10 @@ UP035.py:28:5: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:30:10: UP035 [*] Import from `collections.abc` instead: `Mapping` | 28 | from collections import Mapping, Counter -29 | +29 | 30 | if True: from collections import Mapping | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -31 | +31 | 32 | import os | = help: Import from `collections.abc` @@ -284,15 +284,14 @@ UP035.py:33:1: UP035 [*] Import from `collections.abc` instead: `Mapping` UP035.py:37:5: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Callable` | 36 | if True: -37 | from collections import ( - | _____^ +37 | / from collections import ( 38 | | Mapping, 39 | | Callable, 40 | | Bad, 41 | | Good, 42 | | ) | |_____^ UP035 -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | = help: Import from `collections.abc` @@ -314,10 +313,10 @@ UP035.py:37:5: UP035 [*] Import from `collections.abc` instead: `Mapping`, `Call UP035.py:44:1: UP035 [*] Import from `collections.abc` instead: `Callable` | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | = help: Import from `collections.abc` @@ -336,10 +335,10 @@ UP035.py:44:1: UP035 [*] Import from `collections.abc` instead: `Callable` UP035.py:44:1: UP035 [*] Import from `collections` instead: `OrderedDict` | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | = help: Import from `collections` @@ -358,10 +357,10 @@ UP035.py:44:1: UP035 [*] Import from `collections` instead: `OrderedDict` UP035.py:44:1: UP035 [*] Import from `re` instead: `Match`, `Pattern` | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | = help: Import from `re` @@ -380,42 +379,42 @@ UP035.py:44:1: UP035 [*] Import from `re` instead: `Match`, `Pattern` UP035.py:44:1: UP035 `typing.List` is deprecated, use `list` instead | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | UP035.py:44:1: UP035 `typing.AbstractSet` is deprecated, use `collections.abc.Set` instead | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | UP035.py:44:1: UP035 `typing.ContextManager` is deprecated, use `contextlib.AbstractContextManager` instead | 42 | ) -43 | +43 | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -45 | +45 | 46 | if True: from collections import ( | UP035.py:46:10: UP035 Import from `collections.abc` instead: `Mapping` | 44 | from typing import Callable, Match, Pattern, List, OrderedDict, AbstractSet, ContextManager -45 | +45 | 46 | if True: from collections import ( | __________^ 47 | | Mapping, Counter) | |_____________________^ UP035 -48 | +48 | 49 | # Bad imports from PYI027 that are now handled by PYI022 (UP035) | = help: Import from `collections.abc` @@ -1000,7 +999,7 @@ UP035.py:84:1: UP035 [*] Import from `typing` instead: `SupportsIndex` 83 | # UP035 on py312+ only 84 | from typing_extensions import SupportsIndex | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -85 | +85 | 86 | # UP035 on py312+ only | = help: Import from `typing` @@ -1020,7 +1019,7 @@ UP035.py:87:1: UP035 [*] Import from `typing` instead: `NamedTuple` 86 | # UP035 on py312+ only 87 | from typing_extensions import NamedTuple | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -88 | +88 | 89 | # UP035 on py312+ only: `typing_extensions` supports `frozen_default` (backported from 3.12). | = help: Import from `typing` @@ -1040,7 +1039,7 @@ UP035.py:90:1: UP035 [*] Import from `typing` instead: `dataclass_transform` 89 | # UP035 on py312+ only: `typing_extensions` supports `frozen_default` (backported from 3.12). 90 | from typing_extensions import dataclass_transform | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -91 | +91 | 92 | # UP035 | = help: Import from `typing` @@ -1060,7 +1059,7 @@ UP035.py:93:1: UP035 [*] Import from `enum` instead: `StrEnum` 92 | # UP035 93 | from backports.strenum import StrEnum | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -94 | +94 | 95 | # UP035 | = help: Import from `enum` @@ -1080,7 +1079,7 @@ UP035.py:96:1: UP035 [*] Import from `typing` instead: `override` 95 | # UP035 96 | from typing_extensions import override | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -97 | +97 | 98 | # UP035 | = help: Import from `typing` @@ -1100,7 +1099,7 @@ UP035.py:99:1: UP035 [*] Import from `collections.abc` instead: `Buffer` 98 | # UP035 99 | from typing_extensions import Buffer | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -100 | +100 | 101 | # UP035 | = help: Import from `collections.abc` @@ -1120,7 +1119,7 @@ UP035.py:102:1: UP035 [*] Import from `types` instead: `get_original_bases` 101 | # UP035 102 | from typing_extensions import get_original_bases | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -103 | +103 | 104 | # UP035 on py313+ only | = help: Import from `types` @@ -1140,7 +1139,7 @@ UP035.py:105:1: UP035 [*] Import from `typing` instead: `TypeVar` 104 | # UP035 on py313+ only 105 | from typing_extensions import TypeVar | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -106 | +106 | 107 | # UP035 on py313+ only | = help: Import from `typing` @@ -1160,7 +1159,7 @@ UP035.py:108:1: UP035 [*] Import from `types` instead: `CapsuleType` 107 | # UP035 on py313+ only 108 | from typing_extensions import CapsuleType | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 -109 | +109 | 110 | # UP035 on py313+ only | = help: Import from `types` @@ -1189,3 +1188,6 @@ UP035.py:111:1: UP035 [*] Import from `warnings` instead: `deprecated` 110 110 | # UP035 on py313+ only 111 |-from typing_extensions import deprecated 111 |+from warnings import deprecated +112 112 | +113 113 | +114 114 | # https://github.com/astral-sh/ruff/issues/15780 diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_0.py.snap index fbfadc12583c0..497f7bec514d3 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_0.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP036_0.py:3:4: UP036 [*] Version block is outdated for minimum Python version | 1 | import sys -2 | +2 | 3 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 4 | print("py2") @@ -27,7 +27,7 @@ UP036_0.py:3:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:8:4: UP036 [*] Version block is outdated for minimum Python version | 6 | print("py3") - 7 | + 7 | 8 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 9 | if True: @@ -54,7 +54,7 @@ UP036_0.py:8:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:16:4: UP036 [*] Version block is outdated for minimum Python version | 14 | print("py3") -15 | +15 | 16 | if sys.version_info < (3,0): print("PY2!") | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 17 | else: print("PY3!") @@ -98,7 +98,7 @@ UP036_0.py:20:8: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:25:4: UP036 [*] Version block is outdated for minimum Python version | 23 | print("PY3") -24 | +24 | 25 | if sys.version_info < (3,0): print(1 if True else 3) | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 26 | else: @@ -121,7 +121,7 @@ UP036_0.py:25:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:29:4: UP036 [*] Version block is outdated for minimum Python version | 27 | print("py3") -28 | +28 | 29 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 30 | def f(): @@ -150,7 +150,7 @@ UP036_0.py:29:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:37:4: UP036 [*] Version block is outdated for minimum Python version | 35 | print("This the next") -36 | +36 | 37 | if sys.version_info > (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 38 | print("py3") @@ -174,7 +174,7 @@ UP036_0.py:37:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:45:4: UP036 [*] Version block is outdated for minimum Python version | 43 | x = 1 -44 | +44 | 45 | if sys.version_info > (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 46 | print("py3") @@ -198,7 +198,7 @@ UP036_0.py:45:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:53:4: UP036 [*] Version block is outdated for minimum Python version | 51 | x = 1 -52 | +52 | 53 | if sys.version_info > (3,0): print("py3") | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 54 | else: print("py2") @@ -219,7 +219,7 @@ UP036_0.py:53:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:56:4: UP036 [*] Version block is outdated for minimum Python version | 54 | else: print("py2") -55 | +55 | 56 | if sys.version_info > (3,): | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 57 | print("py3") @@ -266,7 +266,7 @@ UP036_0.py:62:8: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:67:4: UP036 [*] Version block is outdated for minimum Python version | 65 | print("py2") -66 | +66 | 67 | if sys.version_info < (3,): | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 68 | print("py2") @@ -316,7 +316,7 @@ UP036_0.py:73:8: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:86:8: UP036 [*] Version block is outdated for minimum Python version | 84 | pass -85 | +85 | 86 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 87 | def f(py2): @@ -366,7 +366,7 @@ UP036_0.py:97:8: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:104:4: UP036 [*] Version block is outdated for minimum Python version | 102 | # comment -103 | +103 | 104 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 105 | def f(): @@ -422,7 +422,7 @@ UP036_0.py:122:8: UP036 [*] Version block is outdated for minimum Python version 121 | if True: 122 | if sys.version_info > (3,): print(3) | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 -123 | +123 | 124 | if True: | = help: Remove outdated version block @@ -549,7 +549,7 @@ UP036_0.py:150:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:163:4: UP036 [*] Version block is outdated for minimum Python version | 161 | "this for some reason") -162 | +162 | 163 | if sys.version_info > (3, 0): expected_error = \ | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 164 | [] @@ -569,10 +569,10 @@ UP036_0.py:163:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:166:4: UP036 [*] Version block is outdated for minimum Python version | 164 | [] -165 | +165 | 166 | if sys.version_info > (3, 0): expected_error = [] | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 -167 | +167 | 168 | if sys.version_info > (3, 0): \ | = help: Remove outdated version block @@ -590,7 +590,7 @@ UP036_0.py:166:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:168:4: UP036 [*] Version block is outdated for minimum Python version | 166 | if sys.version_info > (3, 0): expected_error = [] -167 | +167 | 168 | if sys.version_info > (3, 0): \ | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 169 | expected_error = [] @@ -632,7 +632,7 @@ UP036_0.py:176:8: UP036 [*] Version block is outdated for minimum Python version 175 | if True: 176 | if sys.version_info > (3, 0): expected_error = [] | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 -177 | +177 | 178 | if True: | = help: Remove outdated version block @@ -668,7 +668,7 @@ UP036_0.py:179:8: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:182:4: UP036 [*] Version block is outdated for minimum Python version | 180 | expected_error = [] -181 | +181 | 182 | if sys.version_info < (3,13): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 183 | print("py3") @@ -688,7 +688,7 @@ UP036_0.py:182:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:191:24: UP036 Version specifier is invalid | 189 | print("py3") -190 | +190 | 191 | if sys.version_info == 10000000: | ^^^^^^^^ UP036 192 | print("py3") @@ -697,7 +697,7 @@ UP036_0.py:191:24: UP036 Version specifier is invalid UP036_0.py:194:23: UP036 Version specifier is invalid | 192 | print("py3") -193 | +193 | 194 | if sys.version_info < (3,10000000): | ^^^^^^^^^^^^ UP036 195 | print("py3") @@ -706,7 +706,7 @@ UP036_0.py:194:23: UP036 Version specifier is invalid UP036_0.py:197:24: UP036 Version specifier is invalid | 195 | print("py3") -196 | +196 | 197 | if sys.version_info <= (3,10000000): | ^^^^^^^^^^^^ UP036 198 | print("py3") @@ -715,7 +715,7 @@ UP036_0.py:197:24: UP036 Version specifier is invalid UP036_0.py:203:4: UP036 [*] Version block is outdated for minimum Python version | 201 | print("py3") -202 | +202 | 203 | if sys.version_info >= (3,13): | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 204 | print("py3") @@ -756,7 +756,7 @@ UP036_0.py:207:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:210:4: UP036 [*] Version block is outdated for minimum Python version | 208 | print("py3") -209 | +209 | 210 | if sys.version_info[:3] >= (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 211 | print("py3") @@ -777,7 +777,7 @@ UP036_0.py:210:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:219:4: UP036 [*] Version block is outdated for minimum Python version | 217 | print("py3") -218 | +218 | 219 | if sys.version_info > (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 220 | f"this is\ @@ -807,7 +807,7 @@ UP036_0.py:219:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:229:4: UP036 [*] Version block is outdated for minimum Python version | 227 | allowed too" -228 | +228 | 229 | if sys.version_info[0] == 3: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 230 | print("py3") @@ -828,7 +828,7 @@ UP036_0.py:229:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:232:4: UP036 [*] Version block is outdated for minimum Python version | 230 | print("py3") -231 | +231 | 232 | if sys.version_info[0] <= 3: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 233 | print("py3") @@ -849,7 +849,7 @@ UP036_0.py:232:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:235:4: UP036 [*] Version block is outdated for minimum Python version | 233 | print("py3") -234 | +234 | 235 | if sys.version_info[0] < 3: | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 236 | print("py3") @@ -869,7 +869,7 @@ UP036_0.py:235:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:238:4: UP036 [*] Version block is outdated for minimum Python version | 236 | print("py3") -237 | +237 | 238 | if sys.version_info[0] >= 3: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 239 | print("py3") @@ -890,7 +890,7 @@ UP036_0.py:238:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:241:4: UP036 [*] Version block is outdated for minimum Python version | 239 | print("py3") -240 | +240 | 241 | if sys.version_info[0] > 3: | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 242 | print("py3") @@ -910,7 +910,7 @@ UP036_0.py:241:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:244:4: UP036 [*] Version block is outdated for minimum Python version | 242 | print("py3") -243 | +243 | 244 | if sys.version_info[0] == 2: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 245 | print("py3") @@ -930,7 +930,7 @@ UP036_0.py:244:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:247:4: UP036 [*] Version block is outdated for minimum Python version | 245 | print("py3") -246 | +246 | 247 | if sys.version_info[0] <= 2: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 248 | print("py3") @@ -950,7 +950,7 @@ UP036_0.py:247:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:250:4: UP036 [*] Version block is outdated for minimum Python version | 248 | print("py3") -249 | +249 | 250 | if sys.version_info[0] < 2: | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 251 | print("py3") @@ -970,7 +970,7 @@ UP036_0.py:250:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:253:4: UP036 [*] Version block is outdated for minimum Python version | 251 | print("py3") -252 | +252 | 253 | if sys.version_info[0] >= 2: | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 254 | print("py3") @@ -991,7 +991,7 @@ UP036_0.py:253:4: UP036 [*] Version block is outdated for minimum Python version UP036_0.py:256:4: UP036 [*] Version block is outdated for minimum Python version | 254 | print("py3") -255 | +255 | 256 | if sys.version_info[0] > 2: | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 257 | print("py3") diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_1.py.snap index e89393c5a4a1a..a7619f082514b 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_1.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP036_1.py:3:4: UP036 [*] Version block is outdated for minimum Python version | 1 | import sys -2 | +2 | 3 | if sys.version_info == 2: | ^^^^^^^^^^^^^^^^^^^^^ UP036 4 | 2 @@ -27,7 +27,7 @@ UP036_1.py:3:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:8:4: UP036 [*] Version block is outdated for minimum Python version | 6 | 3 - 7 | + 7 | 8 | if sys.version_info < (3,): | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 9 | 2 @@ -51,7 +51,7 @@ UP036_1.py:8:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:13:4: UP036 [*] Version block is outdated for minimum Python version | 11 | 3 -12 | +12 | 13 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 14 | 2 @@ -75,7 +75,7 @@ UP036_1.py:13:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:18:4: UP036 [*] Version block is outdated for minimum Python version | 16 | 3 -17 | +17 | 18 | if sys.version_info == 3: | ^^^^^^^^^^^^^^^^^^^^^ UP036 19 | 3 @@ -99,7 +99,7 @@ UP036_1.py:18:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:23:4: UP036 [*] Version block is outdated for minimum Python version | 21 | 2 -22 | +22 | 23 | if sys.version_info > (3,): | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 24 | 3 @@ -123,7 +123,7 @@ UP036_1.py:23:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:28:4: UP036 [*] Version block is outdated for minimum Python version | 26 | 2 -27 | +27 | 28 | if sys.version_info >= (3,): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 29 | 3 @@ -147,7 +147,7 @@ UP036_1.py:28:4: UP036 [*] Version block is outdated for minimum Python version UP036_1.py:35:4: UP036 [*] Version block is outdated for minimum Python version | 33 | from sys import version_info -34 | +34 | 35 | if version_info > (3,): | ^^^^^^^^^^^^^^^^^^^ UP036 36 | 3 @@ -291,5 +291,3 @@ UP036_1.py:75:10: UP036 [*] Version block is outdated for minimum Python version 75 |- elif sys.version_info > (3,): 75 |+ else: 76 76 | print(3) - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_2.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_2.py.snap index 0a280dc5054e9..b5d6a7e33a5e9 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_2.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_2.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP036_2.py:4:4: UP036 [*] Version block is outdated for minimum Python version | 2 | from sys import version_info -3 | +3 | 4 | if sys.version_info > (3, 5): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 5 | 3+6 @@ -28,7 +28,7 @@ UP036_2.py:4:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:9:4: UP036 [*] Version block is outdated for minimum Python version | 7 | 3-5 - 8 | + 8 | 9 | if version_info > (3, 5): | ^^^^^^^^^^^^^^^^^^^^^ UP036 10 | 3+6 @@ -52,7 +52,7 @@ UP036_2.py:9:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:14:4: UP036 [*] Version block is outdated for minimum Python version | 12 | 3-5 -13 | +13 | 14 | if sys.version_info >= (3,6): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 15 | 3+6 @@ -76,7 +76,7 @@ UP036_2.py:14:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:19:4: UP036 [*] Version block is outdated for minimum Python version | 17 | 3-5 -18 | +18 | 19 | if version_info >= (3,6): | ^^^^^^^^^^^^^^^^^^^^^ UP036 20 | 3+6 @@ -100,7 +100,7 @@ UP036_2.py:19:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:24:4: UP036 [*] Version block is outdated for minimum Python version | 22 | 3-5 -23 | +23 | 24 | if sys.version_info < (3,6): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 25 | 3-5 @@ -124,7 +124,7 @@ UP036_2.py:24:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:29:4: UP036 [*] Version block is outdated for minimum Python version | 27 | 3+6 -28 | +28 | 29 | if sys.version_info <= (3,5): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 30 | 3-5 @@ -148,7 +148,7 @@ UP036_2.py:29:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:34:4: UP036 [*] Version block is outdated for minimum Python version | 32 | 3+6 -33 | +33 | 34 | if sys.version_info <= (3, 5): | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 35 | 3-5 @@ -172,7 +172,7 @@ UP036_2.py:34:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:39:4: UP036 [*] Version block is outdated for minimum Python version | 37 | 3+6 -38 | +38 | 39 | if sys.version_info >= (3, 5): | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 40 | pass @@ -193,7 +193,7 @@ UP036_2.py:39:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:42:4: UP036 [*] Version block is outdated for minimum Python version | 40 | pass -41 | +41 | 42 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 43 | pass @@ -233,7 +233,7 @@ UP036_2.py:46:8: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:49:4: UP036 [*] Version block is outdated for minimum Python version | 47 | pass -48 | +48 | 49 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 50 | pass @@ -256,7 +256,7 @@ UP036_2.py:49:4: UP036 [*] Version block is outdated for minimum Python version UP036_2.py:54:4: UP036 [*] Version block is outdated for minimum Python version | 52 | pass -53 | +53 | 54 | if sys.version_info > (3,): | ^^^^^^^^^^^^^^^^^^^^^^^ UP036 55 | pass @@ -276,5 +276,3 @@ UP036_2.py:54:4: UP036 [*] Version block is outdated for minimum Python version 58 55 | 59 56 | if sys.version_info[0] > "2": 60 57 | 3 - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_3.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_3.py.snap index d22d368074431..8b68445648682 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_3.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_3.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP036_3.py:3:15: UP036 [*] Version block is outdated for minimum Python version | 1 | import sys -2 | +2 | 3 | if sys.version_info < (3,0): | ^^^^^^^^^^^^^^^^^^^^^^^^ UP036 4 | print("py2") @@ -74,5 +74,3 @@ UP036_3.py:23:15: UP036 [*] Version block is outdated for minimum Python version 23 |-if sys.version_info < (3,0): print("PY2!") 24 |-else : print("PY3!") 23 |+print("PY3!") - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_4.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_4.py.snap index db21eecad496d..fb13811cfe183 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_4.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_4.py.snap @@ -87,7 +87,7 @@ UP036_4.py:24:10: UP036 [*] Version block is outdated for minimum Python version UP036_4.py:27:8: UP036 [*] Version block is outdated for minimum Python version | 25 | cmd = [sys.executable, "-m", "test.regrtest"] -26 | +26 | 27 | if sys.version_info < (3, 3): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 28 | cmd = [sys.executable, "-m", "test.regrtest"] @@ -128,7 +128,7 @@ UP036_4.py:32:10: UP036 [*] Version block is outdated for minimum Python version UP036_4.py:37:8: UP036 [*] Version block is outdated for minimum Python version | 35 | cmd = [sys.executable, "-m", "test", "-j0"] -36 | +36 | 37 | if sys.version_info < (3, 3): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 38 | cmd = [sys.executable, "-m", "test.regrtest"] @@ -152,7 +152,7 @@ UP036_4.py:37:8: UP036 [*] Version block is outdated for minimum Python version UP036_4.py:42:8: UP036 [*] Version block is outdated for minimum Python version | 40 | cmd = [sys.executable, "-m", "test", "-j0"] -41 | +41 | 42 | if sys.version_info < (3, 3): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 43 | cmd = [sys.executable, "-m", "test.regrtest"] @@ -169,5 +169,3 @@ UP036_4.py:42:8: UP036 [*] Version block is outdated for minimum Python version 44 |- elif foo: 42 |+ if foo: 45 43 | cmd = [sys.executable, "-m", "test", "-j0"] - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_5.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_5.py.snap index 5a121f09e4d72..efd113261f901 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_5.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP036_5.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP036_5.py:3:4: UP036 [*] Version block is outdated for minimum Python version | 1 | import sys -2 | +2 | 3 | if sys.version_info < (3, 8): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 -4 | +4 | 5 | def a(): | = help: Remove outdated version block @@ -34,7 +34,7 @@ UP036_5.py:3:4: UP036 [*] Version block is outdated for minimum Python version UP036_5.py:18:4: UP036 [*] Version block is outdated for minimum Python version | 16 | import sys -17 | +17 | 18 | if sys.version_info < (3, 8): | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 19 | pass @@ -66,5 +66,94 @@ UP036_5.py:18:4: UP036 [*] Version block is outdated for minimum Python version 23 |+ else: 24 |+ print(3) 25 |+ return None +31 26 | +32 27 | +33 28 | # https://github.com/astral-sh/ruff/issues/16082 +UP036_5.py:36:4: UP036 [*] Version block is outdated for minimum Python version + | +35 | ## Errors +36 | if sys.version_info < (3, 12, 0): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 +37 | print() + | + = help: Remove outdated version block +ℹ Unsafe fix +33 33 | # https://github.com/astral-sh/ruff/issues/16082 +34 34 | +35 35 | ## Errors +36 |-if sys.version_info < (3, 12, 0): +37 |- print() +38 36 | +39 37 | if sys.version_info <= (3, 12, 0): +40 38 | print() + +UP036_5.py:39:4: UP036 [*] Version block is outdated for minimum Python version + | +37 | print() +38 | +39 | if sys.version_info <= (3, 12, 0): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 +40 | print() + | + = help: Remove outdated version block + +ℹ Unsafe fix +36 36 | if sys.version_info < (3, 12, 0): +37 37 | print() +38 38 | +39 |-if sys.version_info <= (3, 12, 0): +40 |- print() +41 39 | +42 40 | if sys.version_info < (3, 12, 11): +43 41 | print() + +UP036_5.py:42:4: UP036 [*] Version block is outdated for minimum Python version + | +40 | print() +41 | +42 | if sys.version_info < (3, 12, 11): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 +43 | print() + | + = help: Remove outdated version block + +ℹ Unsafe fix +39 39 | if sys.version_info <= (3, 12, 0): +40 40 | print() +41 41 | +42 |-if sys.version_info < (3, 12, 11): +43 |- print() +44 42 | +45 43 | if sys.version_info < (3, 13, 0): +46 44 | print() + +UP036_5.py:45:4: UP036 [*] Version block is outdated for minimum Python version + | +43 | print() +44 | +45 | if sys.version_info < (3, 13, 0): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP036 +46 | print() + | + = help: Remove outdated version block + +ℹ Unsafe fix +42 42 | if sys.version_info < (3, 12, 11): +43 43 | print() +44 44 | +45 |-if sys.version_info < (3, 13, 0): +46 |- print() +47 45 | +48 46 | if sys.version_info <= (3, 13, 100000): +49 47 | print() + +UP036_5.py:48:24: UP036 Version specifier is invalid + | +46 | print() +47 | +48 | if sys.version_info <= (3, 13, 100000): + | ^^^^^^^^^^^^^^^ UP036 +49 | print() + | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_0.py.snap index 4b4eb9e71624c..2549736148d1b 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_0.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_0.py.snap @@ -113,7 +113,7 @@ UP037_0.py:30:10: UP037 [*] Remove quotes from type annotation | 30 | x: Tuple["MyClass"] | ^^^^^^^^^ UP037 -31 | +31 | 32 | x: Callable[["MyClass"], None] | = help: Remove quotes @@ -131,7 +131,7 @@ UP037_0.py:30:10: UP037 [*] Remove quotes from type annotation UP037_0.py:32:14: UP037 [*] Remove quotes from type annotation | 30 | x: Tuple["MyClass"] -31 | +31 | 32 | x: Callable[["MyClass"], None] | ^^^^^^^^^ UP037 | @@ -205,7 +205,7 @@ UP037_0.py:47:14: UP037 [*] Remove quotes from type annotation | 47 | x: Annotated["str", "metadata"] | ^^^^^ UP037 -48 | +48 | 49 | x: Arg("str", "name") | = help: Remove quotes @@ -223,10 +223,10 @@ UP037_0.py:47:14: UP037 [*] Remove quotes from type annotation UP037_0.py:49:8: UP037 [*] Remove quotes from type annotation | 47 | x: Annotated["str", "metadata"] -48 | +48 | 49 | x: Arg("str", "name") | ^^^^^ UP037 -50 | +50 | 51 | x: DefaultArg("str", "name") | = help: Remove quotes @@ -244,10 +244,10 @@ UP037_0.py:49:8: UP037 [*] Remove quotes from type annotation UP037_0.py:51:15: UP037 [*] Remove quotes from type annotation | 49 | x: Arg("str", "name") -50 | +50 | 51 | x: DefaultArg("str", "name") | ^^^^^ UP037 -52 | +52 | 53 | x: NamedArg("str", "name") | = help: Remove quotes @@ -265,10 +265,10 @@ UP037_0.py:51:15: UP037 [*] Remove quotes from type annotation UP037_0.py:53:13: UP037 [*] Remove quotes from type annotation | 51 | x: DefaultArg("str", "name") -52 | +52 | 53 | x: NamedArg("str", "name") | ^^^^^ UP037 -54 | +54 | 55 | x: DefaultNamedArg("str", "name") | = help: Remove quotes @@ -286,10 +286,10 @@ UP037_0.py:53:13: UP037 [*] Remove quotes from type annotation UP037_0.py:55:20: UP037 [*] Remove quotes from type annotation | 53 | x: NamedArg("str", "name") -54 | +54 | 55 | x: DefaultNamedArg("str", "name") | ^^^^^ UP037 -56 | +56 | 57 | x: DefaultNamedArg("str", name="name") | = help: Remove quotes @@ -307,10 +307,10 @@ UP037_0.py:55:20: UP037 [*] Remove quotes from type annotation UP037_0.py:57:20: UP037 [*] Remove quotes from type annotation | 55 | x: DefaultNamedArg("str", "name") -56 | +56 | 57 | x: DefaultNamedArg("str", name="name") | ^^^^^ UP037 -58 | +58 | 59 | x: VarArg("str") | = help: Remove quotes @@ -328,10 +328,10 @@ UP037_0.py:57:20: UP037 [*] Remove quotes from type annotation UP037_0.py:59:11: UP037 [*] Remove quotes from type annotation | 57 | x: DefaultNamedArg("str", name="name") -58 | +58 | 59 | x: VarArg("str") | ^^^^^ UP037 -60 | +60 | 61 | x: List[List[List["MyClass"]]] | = help: Remove quotes @@ -349,10 +349,10 @@ UP037_0.py:59:11: UP037 [*] Remove quotes from type annotation UP037_0.py:61:19: UP037 [*] Remove quotes from type annotation | 59 | x: VarArg("str") -60 | +60 | 61 | x: List[List[List["MyClass"]]] | ^^^^^^^^^ UP037 -62 | +62 | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) | = help: Remove quotes @@ -370,10 +370,10 @@ UP037_0.py:61:19: UP037 [*] Remove quotes from type annotation UP037_0.py:63:29: UP037 [*] Remove quotes from type annotation | 61 | x: List[List[List["MyClass"]]] -62 | +62 | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | = help: Remove quotes @@ -391,10 +391,10 @@ UP037_0.py:63:29: UP037 [*] Remove quotes from type annotation UP037_0.py:63:45: UP037 [*] Remove quotes from type annotation | 61 | x: List[List[List["MyClass"]]] -62 | +62 | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | = help: Remove quotes @@ -412,10 +412,10 @@ UP037_0.py:63:45: UP037 [*] Remove quotes from type annotation UP037_0.py:65:29: UP037 [*] Remove quotes from type annotation | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | = help: Remove quotes @@ -433,10 +433,10 @@ UP037_0.py:65:29: UP037 [*] Remove quotes from type annotation UP037_0.py:65:36: UP037 [*] Remove quotes from type annotation | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | = help: Remove quotes @@ -454,10 +454,10 @@ UP037_0.py:65:36: UP037 [*] Remove quotes from type annotation UP037_0.py:65:45: UP037 [*] Remove quotes from type annotation | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | = help: Remove quotes @@ -475,10 +475,10 @@ UP037_0.py:65:45: UP037 [*] Remove quotes from type annotation UP037_0.py:65:52: UP037 [*] Remove quotes from type annotation | 63 | x: NamedTuple("X", [("foo", "int"), ("bar", "str")]) -64 | +64 | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) | ^^^^^ UP037 -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | = help: Remove quotes @@ -496,10 +496,10 @@ UP037_0.py:65:52: UP037 [*] Remove quotes from type annotation UP037_0.py:67:24: UP037 [*] Remove quotes from type annotation | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | ^^^ UP037 -68 | +68 | 69 | X: MyCallable("X") | = help: Remove quotes @@ -517,10 +517,10 @@ UP037_0.py:67:24: UP037 [*] Remove quotes from type annotation UP037_0.py:67:38: UP037 [*] Remove quotes from type annotation | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | ^^^^^ UP037 -68 | +68 | 69 | X: MyCallable("X") | = help: Remove quotes @@ -538,10 +538,10 @@ UP037_0.py:67:38: UP037 [*] Remove quotes from type annotation UP037_0.py:67:45: UP037 [*] Remove quotes from type annotation | 65 | x: NamedTuple("X", fields=[("foo", "int"), ("bar", "str")]) -66 | +66 | 67 | x: NamedTuple(typename="X", fields=[("foo", "int")]) | ^^^^^ UP037 -68 | +68 | 69 | X: MyCallable("X") | = help: Remove quotes @@ -554,4 +554,72 @@ UP037_0.py:67:45: UP037 [*] Remove quotes from type annotation 67 |+x: NamedTuple(typename="X", fields=[("foo", int)]) 68 68 | 69 69 | X: MyCallable("X") -70 70 | +70 70 | + +UP037_0.py:112:12: UP037 [*] Remove quotes from type annotation + | +110 | # Handle end of line comment in string annotation +111 | # See https://github.com/astral-sh/ruff/issues/15816 +112 | def f() -> "Literal[0]#": + | ^^^^^^^^^^^^^ UP037 +113 | return 0 + | + = help: Remove quotes + +ℹ Safe fix +109 109 | +110 110 | # Handle end of line comment in string annotation +111 111 | # See https://github.com/astral-sh/ruff/issues/15816 +112 |-def f() -> "Literal[0]#": + 112 |+def f() -> (Literal[0]# + 113 |+): +113 114 | return 0 +114 115 | +115 116 | def g(x: "Literal['abc']#") -> None: + +UP037_0.py:115:10: UP037 [*] Remove quotes from type annotation + | +113 | return 0 +114 | +115 | def g(x: "Literal['abc']#") -> None: + | ^^^^^^^^^^^^^^^^^ UP037 +116 | return + | + = help: Remove quotes + +ℹ Safe fix +112 112 | def f() -> "Literal[0]#": +113 113 | return 0 +114 114 | +115 |-def g(x: "Literal['abc']#") -> None: + 115 |+def g(x: (Literal['abc']# + 116 |+)) -> None: +116 117 | return +117 118 | +118 119 | def f() -> """Literal[0] + +UP037_0.py:118:12: UP037 [*] Remove quotes from type annotation + | +116 | return +117 | +118 | def f() -> """Literal[0] + | ____________^ +119 | | # +120 | | +121 | | """: + | |_______^ UP037 +122 | return 0 + | + = help: Remove quotes + +ℹ Safe fix +115 115 | def g(x: "Literal['abc']#") -> None: +116 116 | return +117 117 | +118 |-def f() -> """Literal[0] + 118 |+def f() -> (Literal[0] +119 119 | # +120 120 | +121 |- """: + 121 |+ ): +122 122 | return 0 diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_1.py.snap index 57379b20edbb2..63db5a46b1572 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_1.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP037_1.py:9:8: UP037 [*] Remove quotes from type annotation | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_2.pyi.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_2.pyi.snap new file mode 100644 index 0000000000000..dd66f98b5180f --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP037_2.pyi.snap @@ -0,0 +1,232 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +--- +UP037_2.pyi:3:14: UP037 [*] Remove quotes from type annotation + | +1 | # https://github.com/astral-sh/ruff/issues/7102 +2 | +3 | def f(a: Foo['SingleLine # Comment']): ... + | ^^^^^^^^^^^^^^^^^^^^^^^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +1 1 | # https://github.com/astral-sh/ruff/issues/7102 +2 2 | +3 |-def f(a: Foo['SingleLine # Comment']): ... + 3 |+def f(a: Foo[(SingleLine # Comment + 4 |+)]): ... +4 5 | +5 6 | +6 7 | def f(a: Foo['''Bar[ + +UP037_2.pyi:6:14: UP037 [*] Remove quotes from type annotation + | +6 | def f(a: Foo['''Bar[ + | ______________^ +7 | | Multi | +8 | | Line]''']): ... + | |____________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +3 3 | def f(a: Foo['SingleLine # Comment']): ... +4 4 | +5 5 | +6 |-def f(a: Foo['''Bar[ + 6 |+def f(a: Foo[Bar[ +7 7 | Multi | +8 |- Line]''']): ... + 8 |+ Line]]): ... +9 9 | +10 10 | +11 11 | def f(a: Foo['''Bar[ + +UP037_2.pyi:11:14: UP037 [*] Remove quotes from type annotation + | +11 | def f(a: Foo['''Bar[ + | ______________^ +12 | | Multi | +13 | | Line # Comment +14 | | ]''']): ... + | |____^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +8 8 | Line]''']): ... +9 9 | +10 10 | +11 |-def f(a: Foo['''Bar[ + 11 |+def f(a: Foo[Bar[ +12 12 | Multi | +13 13 | Line # Comment +14 |-]''']): ... + 14 |+]]): ... +15 15 | +16 16 | +17 17 | def f(a: Foo['''Bar[ + +UP037_2.pyi:17:14: UP037 [*] Remove quotes from type annotation + | +17 | def f(a: Foo['''Bar[ + | ______________^ +18 | | Multi | +19 | | Line] # Comment''']): ... + | |_______________________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +14 14 | ]''']): ... +15 15 | +16 16 | +17 |-def f(a: Foo['''Bar[ + 17 |+def f(a: Foo[(Bar[ +18 18 | Multi | +19 |- Line] # Comment''']): ... + 19 |+ Line] # Comment + 20 |+)]): ... +20 21 | +21 22 | +22 23 | def f(a: Foo[''' + +UP037_2.pyi:22:14: UP037 [*] Remove quotes from type annotation + | +22 | def f(a: Foo[''' + | ______________^ +23 | | Bar[ +24 | | Multi | +25 | | Line] # Comment''']): ... + | |_______________________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +19 19 | Line] # Comment''']): ... +20 20 | +21 21 | +22 |-def f(a: Foo[''' + 22 |+def f(a: Foo[( +23 23 | Bar[ +24 24 | Multi | +25 |- Line] # Comment''']): ... + 25 |+ Line] # Comment + 26 |+)]): ... +26 27 | +27 28 | +28 29 | def f(a: '''list[int] + +UP037_2.pyi:28:10: UP037 [*] Remove quotes from type annotation + | +28 | def f(a: '''list[int] + | __________^ +29 | | ''' = []): ... + | |_______^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +25 25 | Line] # Comment''']): ... +26 26 | +27 27 | +28 |-def f(a: '''list[int] +29 |- ''' = []): ... + 28 |+def f(a: list[int] + 29 |+ = []): ... +30 30 | +31 31 | +32 32 | a: '''\\ + +UP037_2.pyi:32:4: UP037 [*] Remove quotes from type annotation + | +32 | a: '''\\ + | ____^ +33 | | list[int]''' = [42] + | |____________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +29 29 | ''' = []): ... +30 30 | +31 31 | +32 |-a: '''\\ +33 |-list[int]''' = [42] + 32 |+a: (\ + 33 |+list[int]) = [42] +34 34 | +35 35 | +36 36 | def f(a: ''' + +UP037_2.pyi:36:10: UP037 [*] Remove quotes from type annotation + | +36 | def f(a: ''' + | __________^ +37 | | list[int] +38 | | ''' = []): ... + | |_______^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +33 33 | list[int]''' = [42] +34 34 | +35 35 | +36 |-def f(a: ''' + 36 |+def f(a: +37 37 | list[int] +38 |- ''' = []): ... + 38 |+ = []): ... +39 39 | +40 40 | +41 41 | def f(a: Foo[''' + +UP037_2.pyi:41:14: UP037 [*] Remove quotes from type annotation + | +41 | def f(a: Foo[''' + | ______________^ +42 | | Bar +43 | | [ +44 | | Multi | +45 | | Line +46 | | ] # Comment''']): ... + | |___________________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +38 38 | ''' = []): ... +39 39 | +40 40 | +41 |-def f(a: Foo[''' + 41 |+def f(a: Foo[( +42 42 | Bar +43 43 | [ +44 44 | Multi | +45 45 | Line +46 |- ] # Comment''']): ... + 46 |+ ] # Comment + 47 |+)]): ... +47 48 | +48 49 | +49 50 | a: '''list + +UP037_2.pyi:49:4: UP037 [*] Remove quotes from type annotation + | +49 | a: '''list + | ____^ +50 | | [int]''' = [42] + | |________^ UP037 + | + = help: Remove quotes + +ℹ Safe fix +46 46 | ] # Comment''']): ... +47 47 | +48 48 | +49 |-a: '''list +50 |-[int]''' = [42] + 49 |+a: (list + 50 |+[int]) = [42] diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP038.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP038.py.snap index 7a5117ab07aad..83bd5dbd1f050 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP038.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP038.py.snap @@ -21,7 +21,7 @@ UP038.py:2:1: UP038 [*] Use `X | Y` in `issubclass` call instead of `(X, Y)` 1 | isinstance(1, (int, float)) # UP038 2 | issubclass("yes", (int, float, str)) # UP038 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP038 -3 | +3 | 4 | isinstance(1, int) # OK | = help: Convert to `X | Y` @@ -33,5 +33,3 @@ UP038.py:2:1: UP038 [*] Use `X | Y` in `issubclass` call instead of `(X, Y)` 3 3 | 4 4 | isinstance(1, int) # OK 5 5 | issubclass("yes", int) # OK - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP039.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP039.py.snap index ff6299b6e9079..66a8284139383 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP039.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP039.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP039.py:2:8: UP039 [*] Unnecessary parentheses after class definition | @@ -93,5 +94,3 @@ UP039.py:21:8: UP039 [*] Unnecessary parentheses after class definition 22 22 | pass 23 23 | 24 24 | # OK - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.py.snap index 03c7ea34d3bb6..1c5818c218f29 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.py.snap @@ -11,7 +11,7 @@ UP040.py:5:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of th = help: Use the `type` keyword ℹ Unsafe fix -2 2 | from typing import TypeAlias +2 2 | from typing import Any, TypeAlias 3 3 | 4 4 | # UP040 5 |-x: typing.TypeAlias = int @@ -26,7 +26,7 @@ UP040.py:6:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of th 5 | x: typing.TypeAlias = int 6 | x: TypeAlias = int | ^^^^^^^^^^^^^^^^^^ UP040 -7 | +7 | 8 | # UP040 simple generic | = help: Use the `type` keyword @@ -47,7 +47,7 @@ UP040.py:10:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 9 | T = typing.TypeVar["T"] 10 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -11 | +11 | 12 | # UP040 call style generic | = help: Use the `type` keyword @@ -68,7 +68,7 @@ UP040.py:14:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 13 | T = typing.TypeVar("T") 14 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -15 | +15 | 16 | # UP040 bounded generic | = help: Use the `type` keyword @@ -89,7 +89,7 @@ UP040.py:18:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 17 | T = typing.TypeVar("T", bound=int) 18 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -19 | +19 | 20 | # UP040 constrained generic | = help: Use the `type` keyword @@ -110,7 +110,7 @@ UP040.py:22:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 21 | T = typing.TypeVar("T", int, str) 22 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -23 | +23 | 24 | # UP040 contravariant generic | = help: Use the `type` keyword @@ -131,7 +131,7 @@ UP040.py:26:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 25 | T = typing.TypeVar("T", contravariant=True) 26 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -27 | +27 | 28 | # UP040 covariant generic | = help: Use the `type` keyword @@ -152,7 +152,7 @@ UP040.py:30:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 29 | T = typing.TypeVar("T", covariant=True) 30 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -31 | +31 | 32 | # UP040 in class scope | = help: Use the `type` keyword @@ -173,7 +173,7 @@ UP040.py:36:5: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 35 | # reference to global variable 36 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -37 | +37 | 38 | # reference to class variable | = help: Use the `type` keyword @@ -194,7 +194,7 @@ UP040.py:40:5: UP040 [*] Type alias `y` uses `TypeAlias` annotation instead of t 39 | TCLS = typing.TypeVar["TCLS"] 40 | y: typing.TypeAlias = list[TCLS] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -41 | +41 | 42 | # UP040 won't add generics in fix | = help: Use the `type` keyword @@ -215,8 +215,8 @@ UP040.py:44:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 43 | T = typing.TypeVar(*args) 44 | x: typing.TypeAlias = list[T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -45 | -46 | # OK +45 | +46 | # `default` should be skipped for now, added in Python 3.13 | = help: Use the `type` keyword @@ -227,135 +227,263 @@ UP040.py:44:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 44 |-x: typing.TypeAlias = list[T] 44 |+type x = list[T] 45 45 | -46 46 | # OK -47 47 | x: TypeAlias +46 46 | # `default` should be skipped for now, added in Python 3.13 +47 47 | T = typing.TypeVar("T", default=Any) -UP040.py:53:1: UP040 [*] Type alias `Decorator` uses `TypeAlias` annotation instead of the `type` keyword +UP040.py:57:1: UP040 [*] Type alias `Decorator` uses `TypeAlias` annotation instead of the `type` keyword | -51 | # type alias. -52 | T = typing.TypeVar["T"] -53 | Decorator: TypeAlias = typing.Callable[[T], T] +55 | # type alias. +56 | T = typing.TypeVar["T"] +57 | Decorator: TypeAlias = typing.Callable[[T], T] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 | = help: Use the `type` keyword ℹ Unsafe fix -50 50 | # Ensure that "T" appears only once in the type parameters for the modernized -51 51 | # type alias. -52 52 | T = typing.TypeVar["T"] -53 |-Decorator: TypeAlias = typing.Callable[[T], T] - 53 |+type Decorator[T] = typing.Callable[[T], T] -54 54 | -55 55 | -56 56 | from typing import TypeVar, Annotated, TypeAliasType - -UP040.py:63:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword +54 54 | # Ensure that "T" appears only once in the type parameters for the modernized +55 55 | # type alias. +56 56 | T = typing.TypeVar["T"] +57 |-Decorator: TypeAlias = typing.Callable[[T], T] + 57 |+type Decorator[T] = typing.Callable[[T], T] +58 58 | +59 59 | +60 60 | from typing import TypeVar, Annotated, TypeAliasType + +UP040.py:67:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword | -61 | # https://github.com/astral-sh/ruff/issues/11422 -62 | T = TypeVar("T") -63 | / PositiveList = TypeAliasType( -64 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) -65 | | ) +65 | # https://github.com/astral-sh/ruff/issues/11422 +66 | T = TypeVar("T") +67 | / PositiveList = TypeAliasType( +68 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +69 | | ) | |_^ UP040 -66 | -67 | # Bound +70 | +71 | # Bound | = help: Use the `type` keyword ℹ Safe fix -60 60 | -61 61 | # https://github.com/astral-sh/ruff/issues/11422 -62 62 | T = TypeVar("T") -63 |-PositiveList = TypeAliasType( -64 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) -65 |-) - 63 |+type PositiveList[T] = list[Annotated[T, Gt(0)]] -66 64 | -67 65 | # Bound -68 66 | T = TypeVar("T", bound=SupportGt) - -UP040.py:69:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword +64 64 | +65 65 | # https://github.com/astral-sh/ruff/issues/11422 +66 66 | T = TypeVar("T") +67 |-PositiveList = TypeAliasType( +68 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +69 |-) + 67 |+type PositiveList[T] = list[Annotated[T, Gt(0)]] +70 68 | +71 69 | # Bound +72 70 | T = TypeVar("T", bound=SupportGt) + +UP040.py:73:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword | -67 | # Bound -68 | T = TypeVar("T", bound=SupportGt) -69 | / PositiveList = TypeAliasType( -70 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) -71 | | ) +71 | # Bound +72 | T = TypeVar("T", bound=SupportGt) +73 | / PositiveList = TypeAliasType( +74 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +75 | | ) | |_^ UP040 -72 | -73 | # Multiple bounds +76 | +77 | # Multiple bounds | = help: Use the `type` keyword ℹ Safe fix -66 66 | -67 67 | # Bound -68 68 | T = TypeVar("T", bound=SupportGt) -69 |-PositiveList = TypeAliasType( -70 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) -71 |-) - 69 |+type PositiveList[T: SupportGt] = list[Annotated[T, Gt(0)]] -72 70 | -73 71 | # Multiple bounds -74 72 | T1 = TypeVar("T1", bound=SupportGt) - -UP040.py:77:1: UP040 [*] Type alias `Tuple3` uses `TypeAliasType` assignment instead of the `type` keyword +70 70 | +71 71 | # Bound +72 72 | T = TypeVar("T", bound=SupportGt) +73 |-PositiveList = TypeAliasType( +74 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +75 |-) + 73 |+type PositiveList[T: SupportGt] = list[Annotated[T, Gt(0)]] +76 74 | +77 75 | # Multiple bounds +78 76 | T1 = TypeVar("T1", bound=SupportGt) + +UP040.py:81:1: UP040 [*] Type alias `Tuple3` uses `TypeAliasType` assignment instead of the `type` keyword | -75 | T2 = TypeVar("T2") -76 | T3 = TypeVar("T3") -77 | Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) +79 | T2 = TypeVar("T2") +80 | T3 = TypeVar("T3") +81 | Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -78 | -79 | # No type_params +82 | +83 | # No type_params | = help: Use the `type` keyword ℹ Safe fix -74 74 | T1 = TypeVar("T1", bound=SupportGt) -75 75 | T2 = TypeVar("T2") -76 76 | T3 = TypeVar("T3") -77 |-Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) - 77 |+type Tuple3[T1: SupportGt, T2, T3] = tuple[T1, T2, T3] -78 78 | -79 79 | # No type_params -80 80 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) - -UP040.py:80:1: UP040 [*] Type alias `PositiveInt` uses `TypeAliasType` assignment instead of the `type` keyword +78 78 | T1 = TypeVar("T1", bound=SupportGt) +79 79 | T2 = TypeVar("T2") +80 80 | T3 = TypeVar("T3") +81 |-Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) + 81 |+type Tuple3[T1: SupportGt, T2, T3] = tuple[T1, T2, T3] +82 82 | +83 83 | # No type_params +84 84 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) + +UP040.py:84:1: UP040 [*] Type alias `PositiveInt` uses `TypeAliasType` assignment instead of the `type` keyword | -79 | # No type_params -80 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) +83 | # No type_params +84 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -81 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) +85 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) | = help: Use the `type` keyword ℹ Safe fix -77 77 | Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) -78 78 | -79 79 | # No type_params -80 |-PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) - 80 |+type PositiveInt = Annotated[int, Gt(0)] -81 81 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) +81 81 | Tuple3 = TypeAliasType("Tuple3", tuple[T1, T2, T3], type_params=(T1, T2, T3)) 82 82 | -83 83 | # OK: Other name - -UP040.py:81:1: UP040 [*] Type alias `PositiveInt` uses `TypeAliasType` assignment instead of the `type` keyword +83 83 | # No type_params +84 |-PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) + 84 |+type PositiveInt = Annotated[int, Gt(0)] +85 85 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) +86 86 | +87 87 | # OK: Other name + +UP040.py:85:1: UP040 [*] Type alias `PositiveInt` uses `TypeAliasType` assignment instead of the `type` keyword | -79 | # No type_params -80 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) -81 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) +83 | # No type_params +84 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) +85 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP040 -82 | -83 | # OK: Other name +86 | +87 | # OK: Other name | = help: Use the `type` keyword ℹ Safe fix -78 78 | -79 79 | # No type_params -80 80 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) -81 |-PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) - 81 |+type PositiveInt = Annotated[int, Gt(0)] 82 82 | -83 83 | # OK: Other name -84 84 | T = TypeVar("T", bound=SupportGt) +83 83 | # No type_params +84 84 | PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)]) +85 |-PositiveInt = TypeAliasType("PositiveInt", Annotated[int, Gt(0)], type_params=()) + 85 |+type PositiveInt = Annotated[int, Gt(0)] +86 86 | +87 87 | # OK: Other name +88 88 | T = TypeVar("T", bound=SupportGt) + +UP040.py:99:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword + | + 97 | # unsafe fix if comments within the fix + 98 | T = TypeVar("T") + 99 | / PositiveList = TypeAliasType( # eaten comment +100 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +101 | | ) + | |_^ UP040 +102 | +103 | T = TypeVar("T") + | + = help: Use the `type` keyword + +ℹ Unsafe fix +96 96 | +97 97 | # unsafe fix if comments within the fix +98 98 | T = TypeVar("T") +99 |-PositiveList = TypeAliasType( # eaten comment +100 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +101 |-) + 99 |+type PositiveList[T] = list[Annotated[T, Gt(0)]] +102 100 | +103 101 | T = TypeVar("T") +104 102 | PositiveList = TypeAliasType( + +UP040.py:104:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword + | +103 | T = TypeVar("T") +104 | / PositiveList = TypeAliasType( +105 | | "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +106 | | ) # this comment should be okay + | |_^ UP040 + | + = help: Use the `type` keyword + +ℹ Safe fix +101 101 | ) +102 102 | +103 103 | T = TypeVar("T") +104 |-PositiveList = TypeAliasType( +105 |- "PositiveList", list[Annotated[T, Gt(0)]], type_params=(T,) +106 |-) # this comment should be okay + 104 |+type PositiveList[T] = list[Annotated[T, Gt(0)]] # this comment should be okay +107 105 | +108 106 | +109 107 | # this comment will actually be preserved because it's inside the "value" part + +UP040.py:111:1: UP040 [*] Type alias `PositiveList` uses `TypeAliasType` assignment instead of the `type` keyword + | +109 | # this comment will actually be preserved because it's inside the "value" part +110 | T = TypeVar("T") +111 | / PositiveList = TypeAliasType( +112 | | "PositiveList", list[ +113 | | Annotated[T, Gt(0)], # preserved comment +114 | | ], type_params=(T,) +115 | | ) + | |_^ UP040 +116 | +117 | T: TypeAlias = ( + | + = help: Use the `type` keyword + +ℹ Safe fix +108 108 | +109 109 | # this comment will actually be preserved because it's inside the "value" part +110 110 | T = TypeVar("T") +111 |-PositiveList = TypeAliasType( +112 |- "PositiveList", list[ + 111 |+type PositiveList[T] = list[ +113 112 | Annotated[T, Gt(0)], # preserved comment +114 |- ], type_params=(T,) +115 |-) + 113 |+ ] +116 114 | +117 115 | T: TypeAlias = ( +118 116 | int + +UP040.py:117:1: UP040 [*] Type alias `T` uses `TypeAlias` annotation instead of the `type` keyword + | +115 | ) +116 | +117 | / T: TypeAlias = ( +118 | | int +119 | | | str +120 | | ) + | |_^ UP040 +121 | +122 | T: TypeAlias = ( # comment0 + | + = help: Use the `type` keyword + +ℹ Unsafe fix +114 114 | ], type_params=(T,) +115 115 | ) +116 116 | +117 |-T: TypeAlias = ( + 117 |+type T = ( +118 118 | int +119 119 | | str +120 120 | ) + +UP040.py:122:1: UP040 [*] Type alias `T` uses `TypeAlias` annotation instead of the `type` keyword + | +120 | ) +121 | +122 | / T: TypeAlias = ( # comment0 +123 | | # comment1 +124 | | int # comment2 +125 | | # comment3 +126 | | | # comment4 +127 | | # comment5 +128 | | str # comment6 +129 | | # comment7 +130 | | ) # comment8 + | |_^ UP040 + | + = help: Use the `type` keyword + +ℹ Unsafe fix +119 119 | | str +120 120 | ) +121 121 | +122 |-T: TypeAlias = ( # comment0 + 122 |+type T = ( # comment0 +123 123 | # comment1 +124 124 | int # comment2 +125 125 | # comment3 diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.pyi.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.pyi.snap index 9615265f86bc3..713270889626b 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.pyi.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP040.pyi.snap @@ -18,6 +18,8 @@ UP040.pyi:6:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 6 |-x: typing.TypeAlias = int 6 |+type x = int 7 7 | x: TypeAlias = int +8 8 | +9 9 | UP040.pyi:7:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of the `type` keyword | @@ -34,5 +36,56 @@ UP040.pyi:7:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of t 6 6 | x: typing.TypeAlias = int 7 |-x: TypeAlias = int 7 |+type x = int +8 8 | +9 9 | +10 10 | # comments in the value are preserved +UP040.pyi:11:1: UP040 [*] Type alias `x` uses `TypeAlias` annotation instead of the `type` keyword + | +10 | # comments in the value are preserved +11 | / x: TypeAlias = tuple[ +12 | | int, # preserved +13 | | float, +14 | | ] + | |_^ UP040 +15 | +16 | T: TypeAlias = ( # comment0 + | + = help: Use the `type` keyword +ℹ Safe fix +8 8 | +9 9 | +10 10 | # comments in the value are preserved +11 |-x: TypeAlias = tuple[ + 11 |+type x = tuple[ +12 12 | int, # preserved +13 13 | float, +14 14 | ] + +UP040.pyi:16:1: UP040 [*] Type alias `T` uses `TypeAlias` annotation instead of the `type` keyword + | +14 | ] +15 | +16 | / T: TypeAlias = ( # comment0 +17 | | # comment1 +18 | | int # comment2 +19 | | # comment3 +20 | | | # comment4 +21 | | # comment5 +22 | | str # comment6 +23 | | # comment7 +24 | | ) # comment8 + | |_^ UP040 + | + = help: Use the `type` keyword + +ℹ Safe fix +13 13 | float, +14 14 | ] +15 15 | +16 |-T: TypeAlias = ( # comment0 + 16 |+type T = ( # comment0 +17 17 | # comment1 +18 18 | int # comment2 +19 19 | # comment3 diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP041.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP041.py.snap index 68f66dc6de38f..563ec5fd39b8d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP041.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP041.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP041.py:5:8: UP041 [*] Replace aliased errors with `TimeoutError` | @@ -140,5 +141,3 @@ UP041.py:42:8: UP041 [*] Replace aliased errors with `TimeoutError` 43 43 | pass 44 44 | 45 45 | # These should not change - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP042.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP042.py.snap index e7bff6e26969f..59de11c1764db 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP042.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP042.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP042.py:4:7: UP042 [*] Class A inherits from both `str` and `enum.Enum` | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP043.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP043.py.snap index 65243085cce44..dda6bd47ee0a2 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP043.py.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP043.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP043.py:4:15: UP043 [*] Unnecessary default type arguments | @@ -107,3 +108,28 @@ UP043.py:51:21: UP043 [*] Unnecessary default type arguments 51 |-async def func() -> AsyncGenerator[str, None]: 51 |+async def func() -> AsyncGenerator[str]: 52 52 | yield "hello" +53 53 | +54 54 | + +UP043.py:55:21: UP043 [*] Unnecessary default type arguments + | +55 | async def func() -> AsyncGenerator[ # type: ignore + | _____________________^ +56 | | str, +57 | | None +58 | | ]: + | |_^ UP043 +59 | yield "hello" + | + = help: Remove default type arguments + +ℹ Unsafe fix +52 52 | yield "hello" +53 53 | +54 54 | +55 |-async def func() -> AsyncGenerator[ # type: ignore +56 |- str, +57 |- None +58 |-]: + 55 |+async def func() -> AsyncGenerator[str]: +59 56 | yield "hello" diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP045.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP045.py.snap new file mode 100644 index 0000000000000..357987139526a --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP045.py.snap @@ -0,0 +1,151 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP045.py:5:10: UP007 [*] Use `X | Y` for type annotations + | +5 | def f(x: Optional[str]) -> None: + | ^^^^^^^^^^^^^ UP007 +6 | ... + | + = help: Convert to `X | Y` + +ℹ Safe fix +2 2 | from typing import Optional +3 3 | +4 4 | +5 |-def f(x: Optional[str]) -> None: + 5 |+def f(x: str | None) -> None: +6 6 | ... +7 7 | +8 8 | + +UP045.py:9:10: UP007 [*] Use `X | Y` for type annotations + | + 9 | def f(x: typing.Optional[str]) -> None: + | ^^^^^^^^^^^^^^^^^^^^ UP007 +10 | ... + | + = help: Convert to `X | Y` + +ℹ Safe fix +6 6 | ... +7 7 | +8 8 | +9 |-def f(x: typing.Optional[str]) -> None: + 9 |+def f(x: str | None) -> None: +10 10 | ... +11 11 | +12 12 | + +UP045.py:14:8: UP007 [*] Use `X | Y` for type annotations + | +13 | def f() -> None: +14 | x: Optional[str] + | ^^^^^^^^^^^^^ UP007 +15 | x = Optional[str] + | + = help: Convert to `X | Y` + +ℹ Safe fix +11 11 | +12 12 | +13 13 | def f() -> None: +14 |- x: Optional[str] + 14 |+ x: str | None +15 15 | x = Optional[str] +16 16 | +17 17 | + +UP045.py:15:9: UP007 Use `X | Y` for type annotations + | +13 | def f() -> None: +14 | x: Optional[str] +15 | x = Optional[str] + | ^^^^^^^^^^^^^ UP007 + | + = help: Convert to `X | Y` + +UP045.py:18:15: UP007 [*] Use `X | Y` for type annotations + | +18 | def f(x: list[Optional[int]]) -> None: + | ^^^^^^^^^^^^^ UP007 +19 | ... + | + = help: Convert to `X | Y` + +ℹ Safe fix +15 15 | x = Optional[str] +16 16 | +17 17 | +18 |-def f(x: list[Optional[int]]) -> None: + 18 |+def f(x: list[int | None]) -> None: +19 19 | ... +20 20 | +21 21 | + +UP045.py:22:10: UP007 Use `X | Y` for type annotations + | +22 | def f(x: Optional[int : float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^ UP007 +23 | ... + | + = help: Convert to `X | Y` + +UP045.py:26:10: UP007 Use `X | Y` for type annotations + | +26 | def f(x: Optional[str, int : float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 +27 | ... + | + = help: Convert to `X | Y` + +UP045.py:30:10: UP007 Use `X | Y` for type annotations + | +30 | def f(x: Optional[int, float]) -> None: + | ^^^^^^^^^^^^^^^^^^^^ UP007 +31 | ... + | + = help: Convert to `X | Y` + +UP045.py:36:28: UP007 [*] Use `X | Y` for type annotations + | +34 | # Regression test for: https://github.com/astral-sh/ruff/issues/7131 +35 | class ServiceRefOrValue: +36 | service_specification: Optional[ + | ____________________________^ +37 | | list[ServiceSpecificationRef] +38 | | | list[ServiceSpecification] +39 | | ] = None + | |_____^ UP007 + | + = help: Convert to `X | Y` + +ℹ Safe fix +33 33 | +34 34 | # Regression test for: https://github.com/astral-sh/ruff/issues/7131 +35 35 | class ServiceRefOrValue: +36 |- service_specification: Optional[ +37 |- list[ServiceSpecificationRef] +38 |- | list[ServiceSpecification] +39 |- ] = None + 36 |+ service_specification: list[ServiceSpecificationRef] | list[ServiceSpecification] | None = None +40 37 | +41 38 | +42 39 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 + +UP045.py:44:28: UP007 [*] Use `X | Y` for type annotations + | +42 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 +43 | class ServiceRefOrValue: +44 | service_specification: Optional[str]is not True = None + | ^^^^^^^^^^^^^ UP007 + | + = help: Convert to `X | Y` + +ℹ Safe fix +41 41 | +42 42 | # Regression test for: https://github.com/astral-sh/ruff/issues/7201 +43 43 | class ServiceRefOrValue: +44 |- service_specification: Optional[str]is not True = None + 44 |+ service_specification: str | None is not True = None diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_0.py.snap new file mode 100644 index 0000000000000..c15a773704cd2 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_0.py.snap @@ -0,0 +1,279 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP046_0.py:11:9: UP046 [*] Generic class `A` uses `Generic` subclass instead of type parameters + | +11 | class A(Generic[T]): + | ^^^^^^^^^^ UP046 +12 | # Comments in a class body are preserved +13 | var: T + | + = help: Use type parameters + +ℹ Unsafe fix +8 8 | P = ParamSpec("P") +9 9 | +10 10 | +11 |-class A(Generic[T]): + 11 |+class A[T: float]: +12 12 | # Comments in a class body are preserved +13 13 | var: T +14 14 | + +UP046_0.py:16:9: UP046 [*] Generic class `B` uses `Generic` subclass instead of type parameters + | +16 | class B(Generic[*Ts]): + | ^^^^^^^^^^^^ UP046 +17 | var: tuple[*Ts] + | + = help: Use type parameters + +ℹ Unsafe fix +13 13 | var: T +14 14 | +15 15 | +16 |-class B(Generic[*Ts]): + 16 |+class B[*Ts]: +17 17 | var: tuple[*Ts] +18 18 | +19 19 | + +UP046_0.py:20:9: UP046 [*] Generic class `C` uses `Generic` subclass instead of type parameters + | +20 | class C(Generic[P]): + | ^^^^^^^^^^ UP046 +21 | var: P + | + = help: Use type parameters + +ℹ Unsafe fix +17 17 | var: tuple[*Ts] +18 18 | +19 19 | +20 |-class C(Generic[P]): + 20 |+class C[**P]: +21 21 | var: P +22 22 | +23 23 | + +UP046_0.py:24:19: UP046 [*] Generic class `Constrained` uses `Generic` subclass instead of type parameters + | +24 | class Constrained(Generic[S]): + | ^^^^^^^^^^ UP046 +25 | var: S + | + = help: Use type parameters + +ℹ Unsafe fix +21 21 | var: P +22 22 | +23 23 | +24 |-class Constrained(Generic[S]): + 24 |+class Constrained[S: (str, bytes)]: +25 25 | var: S +26 26 | +27 27 | + +UP046_0.py:30:20: UP046 Generic class `ExternalType` uses `Generic` subclass instead of type parameters + | +28 | # This case gets a diagnostic but not a fix because we can't look up the bounds +29 | # or constraints on the TypeVar imported from another module +30 | class ExternalType(Generic[T, SupportsRichComparisonT]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP046 +31 | var: T +32 | compare: SupportsRichComparisonT + | + = help: Use type parameters + +UP046_0.py:37:13: UP046 [*] Generic class `MyStr` uses `Generic` subclass instead of type parameters + | +35 | # typing.AnyStr is a common external type variable, so treat it specially as a +36 | # known TypeVar +37 | class MyStr(Generic[AnyStr]): + | ^^^^^^^^^^^^^^^ UP046 +38 | s: AnyStr + | + = help: Use type parameters + +ℹ Unsafe fix +34 34 | +35 35 | # typing.AnyStr is a common external type variable, so treat it specially as a +36 36 | # known TypeVar +37 |-class MyStr(Generic[AnyStr]): + 37 |+class MyStr[AnyStr: (bytes, str)]: +38 38 | s: AnyStr +39 39 | +40 40 | + +UP046_0.py:41:24: UP046 [*] Generic class `MultipleGenerics` uses `Generic` subclass instead of type parameters + | +41 | class MultipleGenerics(Generic[S, T, *Ts, P]): + | ^^^^^^^^^^^^^^^^^^^^^ UP046 +42 | var: S +43 | typ: T + | + = help: Use type parameters + +ℹ Unsafe fix +38 38 | s: AnyStr +39 39 | +40 40 | +41 |-class MultipleGenerics(Generic[S, T, *Ts, P]): + 41 |+class MultipleGenerics[S: (str, bytes), T: float, *Ts, **P]: +42 42 | var: S +43 43 | typ: T +44 44 | tup: tuple[*Ts] + +UP046_0.py:48:33: UP046 [*] Generic class `MultipleBaseClasses` uses `Generic` subclass instead of type parameters + | +48 | class MultipleBaseClasses(list, Generic[T]): + | ^^^^^^^^^^ UP046 +49 | var: T + | + = help: Use type parameters + +ℹ Unsafe fix +45 45 | pep: P +46 46 | +47 47 | +48 |-class MultipleBaseClasses(list, Generic[T]): + 48 |+class MultipleBaseClasses[T: float](list): +49 49 | var: T +50 50 | +51 51 | + +UP046_0.py:62:44: UP046 [*] Generic class `MoreBaseClasses` uses `Generic` subclass instead of type parameters + | +62 | class MoreBaseClasses(Base1, Base2, Base3, Generic[T]): + | ^^^^^^^^^^ UP046 +63 | var: T + | + = help: Use type parameters + +ℹ Unsafe fix +59 59 | class Base3: ... +60 60 | +61 61 | +62 |-class MoreBaseClasses(Base1, Base2, Base3, Generic[T]): + 62 |+class MoreBaseClasses[T: float](Base1, Base2, Base3): +63 63 | var: T +64 64 | +65 65 | + +UP046_0.py:66:52: UP046 [*] Generic class `MultipleBaseAndGenerics` uses `Generic` subclass instead of type parameters + | +66 | class MultipleBaseAndGenerics(Base1, Base2, Base3, Generic[S, T, *Ts, P]): + | ^^^^^^^^^^^^^^^^^^^^^ UP046 +67 | var: S +68 | typ: T + | + = help: Use type parameters + +ℹ Unsafe fix +63 63 | var: T +64 64 | +65 65 | +66 |-class MultipleBaseAndGenerics(Base1, Base2, Base3, Generic[S, T, *Ts, P]): + 66 |+class MultipleBaseAndGenerics[S: (str, bytes), T: float, *Ts, **P](Base1, Base2, Base3): +67 67 | var: S +68 68 | typ: T +69 69 | tup: tuple[*Ts] + +UP046_0.py:73:9: UP046 [*] Generic class `A` uses `Generic` subclass instead of type parameters + | +73 | class A(Generic[T]): ... + | ^^^^^^^^^^ UP046 + | + = help: Use type parameters + +ℹ Unsafe fix +70 70 | pep: P +71 71 | +72 72 | +73 |-class A(Generic[T]): ... + 73 |+class A[T: float]: ... +74 74 | +75 75 | +76 76 | class B(A[S], Generic[S]): + +UP046_0.py:76:15: UP046 [*] Generic class `B` uses `Generic` subclass instead of type parameters + | +76 | class B(A[S], Generic[S]): + | ^^^^^^^^^^ UP046 +77 | var: S + | + = help: Use type parameters + +ℹ Unsafe fix +73 73 | class A(Generic[T]): ... +74 74 | +75 75 | +76 |-class B(A[S], Generic[S]): + 76 |+class B[S: (str, bytes)](A[S]): +77 77 | var: S +78 78 | +79 79 | + +UP046_0.py:80:15: UP046 [*] Generic class `C` uses `Generic` subclass instead of type parameters + | +80 | class C(A[S], Generic[S, T]): + | ^^^^^^^^^^^^^ UP046 +81 | var: tuple[S, T] + | + = help: Use type parameters + +ℹ Unsafe fix +77 77 | var: S +78 78 | +79 79 | +80 |-class C(A[S], Generic[S, T]): + 80 |+class C[S: (str, bytes), T: float](A[S]): +81 81 | var: tuple[S, T] +82 82 | +83 83 | + +UP046_0.py:84:17: UP046 [*] Generic class `D` uses `Generic` subclass instead of type parameters + | +84 | class D(A[int], Generic[T]): + | ^^^^^^^^^^ UP046 +85 | var: T + | + = help: Use type parameters + +ℹ Unsafe fix +81 81 | var: tuple[S, T] +82 82 | +83 83 | +84 |-class D(A[int], Generic[T]): + 84 |+class D[T: float](A[int]): +85 85 | var: T +86 86 | +87 87 | + +UP046_0.py:88:15: UP046 Generic class `NotLast` uses `Generic` subclass instead of type parameters + | +88 | class NotLast(Generic[T], Base1): + | ^^^^^^^^^^ UP046 +89 | var: T + | + = help: Use type parameters + +UP046_0.py:92:23: UP046 Generic class `Sandwich` uses `Generic` subclass instead of type parameters + | +92 | class Sandwich(Base1, Generic[T], Base2): + | ^^^^^^^^^^ UP046 +93 | var: T + | + = help: Use type parameters + +UP046_0.py:98:23: UP046 Generic class `TooManyGenerics` uses `Generic` subclass instead of type parameters + | + 96 | # runtime `TypeError` to inherit from `Generic` multiple times, but we still + 97 | # emit a diagnostic + 98 | class TooManyGenerics(Generic[T], Generic[S]): + | ^^^^^^^^^^ UP046 + 99 | var: T +100 | var: S + | + = help: Use type parameters diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_1.py.snap new file mode 100644 index 0000000000000..95de85d97b991 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP046_1.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP046_1.py:11:14: UP046 Generic class `BadStr` uses `Generic` subclass instead of type parameters + | +11 | class BadStr(Generic[AnyStr]): + | ^^^^^^^^^^^^^^^ UP046 +12 | var: AnyStr + | + = help: Use type parameters diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP047.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP047.py.snap new file mode 100644 index 0000000000000..fd3dde6026e33 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP047.py.snap @@ -0,0 +1,119 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP047.py:12:5: UP047 [*] Generic function `f` should use type parameters + | +12 | def f(t: T) -> T: + | ^^^^^^^ UP047 +13 | return t + | + = help: Use type parameters + +ℹ Unsafe fix +9 9 | P = ParamSpec("P") +10 10 | +11 11 | +12 |-def f(t: T) -> T: + 12 |+def f[T: float](t: T) -> T: +13 13 | return t +14 14 | +15 15 | + +UP047.py:16:5: UP047 [*] Generic function `g` should use type parameters + | +16 | def g(ts: tuple[*Ts]) -> tuple[*Ts]: + | ^^^^^^^^^^^^^^^^^ UP047 +17 | return ts + | + = help: Use type parameters + +ℹ Unsafe fix +13 13 | return t +14 14 | +15 15 | +16 |-def g(ts: tuple[*Ts]) -> tuple[*Ts]: + 16 |+def g[*Ts](ts: tuple[*Ts]) -> tuple[*Ts]: +17 17 | return ts +18 18 | +19 19 | + +UP047.py:20:5: UP047 [*] Generic function `h` should use type parameters + | +20 | def h( + | _____^ +21 | | p: Callable[P, T], +22 | | # Comment in the middle of a parameter list should be preserved +23 | | another_param, +24 | | and_another, +25 | | ) -> Callable[P, T]: + | |_^ UP047 +26 | return p + | + = help: Use type parameters + +ℹ Unsafe fix +17 17 | return ts +18 18 | +19 19 | +20 |-def h( + 20 |+def h[**P, T: float]( +21 21 | p: Callable[P, T], +22 22 | # Comment in the middle of a parameter list should be preserved +23 23 | another_param, + +UP047.py:29:5: UP047 [*] Generic function `i` should use type parameters + | +29 | def i(s: S) -> S: + | ^^^^^^^ UP047 +30 | return s + | + = help: Use type parameters + +ℹ Unsafe fix +26 26 | return p +27 27 | +28 28 | +29 |-def i(s: S) -> S: + 29 |+def i[S: (str, bytes)](s: S) -> S: +30 30 | return s +31 31 | +32 32 | + +UP047.py:39:5: UP047 [*] Generic function `broken_fix` should use type parameters + | +37 | # TypeVars with the new-style generic syntax and will be rejected by type +38 | # checkers +39 | def broken_fix(okay: T, bad: Something) -> tuple[T, Something]: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP047 +40 | return (okay, bad) + | + = help: Use type parameters + +ℹ Unsafe fix +36 36 | # generic type parameter. This leads to code that mixes old-style standalone +37 37 | # TypeVars with the new-style generic syntax and will be rejected by type +38 38 | # checkers +39 |-def broken_fix(okay: T, bad: Something) -> tuple[T, Something]: + 39 |+def broken_fix[T: float](okay: T, bad: Something) -> tuple[T, Something]: +40 40 | return (okay, bad) +41 41 | +42 42 | + +UP047.py:43:5: UP047 [*] Generic function `any_str_param` should use type parameters + | +43 | def any_str_param(s: AnyStr) -> AnyStr: + | ^^^^^^^^^^^^^^^^^^^^^^^^ UP047 +44 | return s + | + = help: Use type parameters + +ℹ Unsafe fix +40 40 | return (okay, bad) +41 41 | +42 42 | +43 |-def any_str_param(s: AnyStr) -> AnyStr: + 43 |+def any_str_param[AnyStr: (bytes, str)](s: AnyStr) -> AnyStr: +44 44 | return s +45 45 | +46 46 | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_0.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_0.py.snap new file mode 100644 index 0000000000000..087b5f1566fe0 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_0.py.snap @@ -0,0 +1,109 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +--- +UP049_0.py:2:15: UP049 [*] Generic class uses private type parameters + | +1 | # simple case, replace _T in signature and body +2 | class Generic[_T]: + | ^^ UP049 +3 | buf: list[_T] + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +1 1 | # simple case, replace _T in signature and body +2 |-class Generic[_T]: +3 |- buf: list[_T] + 2 |+class Generic[T]: + 3 |+ buf: list[T] +4 4 | +5 |- def append(self, t: _T): + 5 |+ def append(self, t: T): +6 6 | self.buf.append(t) +7 7 | +8 8 | + +UP049_0.py:10:12: UP049 [*] Generic function uses private type parameters + | + 9 | # simple case, replace _T in signature and body +10 | def second[_T](var: tuple[_T]) -> _T: + | ^^ UP049 +11 | y: _T = var[1] +12 | return y + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +7 7 | +8 8 | +9 9 | # simple case, replace _T in signature and body +10 |-def second[_T](var: tuple[_T]) -> _T: +11 |- y: _T = var[1] + 10 |+def second[T](var: tuple[T]) -> T: + 11 |+ y: T = var[1] +12 12 | return y +13 13 | +14 14 | + +UP049_0.py:17:5: UP049 [*] Generic function uses private type parameters + | +15 | # one diagnostic for each variable, comments are preserved +16 | def many_generics[ +17 | _T, # first generic + | ^^ UP049 +18 | _U, # second generic +19 | ](args): + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +14 14 | +15 15 | # one diagnostic for each variable, comments are preserved +16 16 | def many_generics[ +17 |- _T, # first generic + 17 |+ T, # first generic +18 18 | _U, # second generic +19 19 | ](args): +20 20 | return args + +UP049_0.py:18:5: UP049 [*] Generic function uses private type parameters + | +16 | def many_generics[ +17 | _T, # first generic +18 | _U, # second generic + | ^^ UP049 +19 | ](args): +20 | return args + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +15 15 | # one diagnostic for each variable, comments are preserved +16 16 | def many_generics[ +17 17 | _T, # first generic +18 |- _U, # second generic + 18 |+ U, # second generic +19 19 | ](args): +20 20 | return args +21 21 | + +UP049_0.py:27:7: UP049 [*] Generic function uses private type parameters + | +27 | def f[_T](v): + | ^^ UP049 +28 | cast("_T", v) +29 | cast("Literal['_T']") + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +24 24 | from typing import Literal, cast +25 25 | +26 26 | +27 |-def f[_T](v): +28 |- cast("_T", v) + 27 |+def f[T](v): + 28 |+ cast("T", v) +29 29 | cast("Literal['_T']") +30 |- cast("list[_T]", v) + 30 |+ cast("list[T]", v) diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_1.py.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_1.py.snap new file mode 100644 index 0000000000000..16b8dbd70a11b --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__UP049_1.py.snap @@ -0,0 +1,351 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +--- +UP049_1.py:2:11: UP049 [*] Generic class uses private type parameters + | +1 | # bound +2 | class Foo[_T: str]: + | ^^ UP049 +3 | var: _T + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +1 1 | # bound +2 |-class Foo[_T: str]: +3 |- var: _T + 2 |+class Foo[T: str]: + 3 |+ var: T +4 4 | +5 5 | +6 6 | # constraint + +UP049_1.py:7:11: UP049 [*] Generic class uses private type parameters + | +6 | # constraint +7 | class Foo[_T: (str, bytes)]: + | ^^ UP049 +8 | var: _T + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +4 4 | +5 5 | +6 6 | # constraint +7 |-class Foo[_T: (str, bytes)]: +8 |- var: _T + 7 |+class Foo[T: (str, bytes)]: + 8 |+ var: T +9 9 | +10 10 | +11 11 | # python 3.13+ default + +UP049_1.py:12:11: UP049 [*] Generic class uses private type parameters + | +11 | # python 3.13+ default +12 | class Foo[_T = int]: + | ^^ UP049 +13 | var: _T + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +9 9 | +10 10 | +11 11 | # python 3.13+ default +12 |-class Foo[_T = int]: +13 |- var: _T + 12 |+class Foo[T = int]: + 13 |+ var: T +14 14 | +15 15 | +16 16 | # tuple + +UP049_1.py:17:12: UP049 [*] Generic class uses private type parameters + | +16 | # tuple +17 | class Foo[*_Ts]: + | ^^^ UP049 +18 | var: tuple[*_Ts] + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +14 14 | +15 15 | +16 16 | # tuple +17 |-class Foo[*_Ts]: +18 |- var: tuple[*_Ts] + 17 |+class Foo[*Ts]: + 18 |+ var: tuple[*Ts] +19 19 | +20 20 | +21 21 | # paramspec + +UP049_1.py:22:11: UP049 [*] Generic class uses private type parameters + | +21 | # paramspec +22 | class C[**_P]: + | ^^ UP049 +23 | var: _P + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +19 19 | +20 20 | +21 21 | # paramspec +22 |-class C[**_P]: +23 |- var: _P + 22 |+class C[**P]: + 23 |+ var: P +24 24 | +25 25 | +26 26 | from typing import Callable + +UP049_1.py:31:18: UP049 [*] Generic class uses private type parameters + | +29 | # each of these will get a separate diagnostic, but at least they'll all get +30 | # fixed +31 | class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + | ^^ UP049 +32 | @staticmethod +33 | def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +28 28 | +29 29 | # each of these will get a separate diagnostic, but at least they'll all get +30 30 | # fixed +31 |-class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + 31 |+class Everything[T, _U: str, _V: (int, float), *_W, **_X]: +32 32 | @staticmethod +33 |- def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + 33 |+ def transform(t: T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, T] | None: +34 34 | return None +35 35 | +36 36 | + +UP049_1.py:31:22: UP049 [*] Generic class uses private type parameters + | +29 | # each of these will get a separate diagnostic, but at least they'll all get +30 | # fixed +31 | class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + | ^^ UP049 +32 | @staticmethod +33 | def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +28 28 | +29 29 | # each of these will get a separate diagnostic, but at least they'll all get +30 30 | # fixed +31 |-class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + 31 |+class Everything[_T, U: str, _V: (int, float), *_W, **_X]: +32 32 | @staticmethod +33 |- def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + 33 |+ def transform(t: _T, u: U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: +34 34 | return None +35 35 | +36 36 | + +UP049_1.py:31:31: UP049 [*] Generic class uses private type parameters + | +29 | # each of these will get a separate diagnostic, but at least they'll all get +30 | # fixed +31 | class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + | ^^ UP049 +32 | @staticmethod +33 | def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +28 28 | +29 29 | # each of these will get a separate diagnostic, but at least they'll all get +30 30 | # fixed +31 |-class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + 31 |+class Everything[_T, _U: str, V: (int, float), *_W, **_X]: +32 32 | @staticmethod +33 |- def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + 33 |+ def transform(t: _T, u: _U, v: V) -> tuple[*_W] | Callable[_X, _T] | None: +34 34 | return None +35 35 | +36 36 | + +UP049_1.py:31:50: UP049 [*] Generic class uses private type parameters + | +29 | # each of these will get a separate diagnostic, but at least they'll all get +30 | # fixed +31 | class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + | ^^ UP049 +32 | @staticmethod +33 | def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +28 28 | +29 29 | # each of these will get a separate diagnostic, but at least they'll all get +30 30 | # fixed +31 |-class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + 31 |+class Everything[_T, _U: str, _V: (int, float), *W, **_X]: +32 32 | @staticmethod +33 |- def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + 33 |+ def transform(t: _T, u: _U, v: _V) -> tuple[*W] | Callable[_X, _T] | None: +34 34 | return None +35 35 | +36 36 | + +UP049_1.py:31:56: UP049 [*] Generic class uses private type parameters + | +29 | # each of these will get a separate diagnostic, but at least they'll all get +30 | # fixed +31 | class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + | ^^ UP049 +32 | @staticmethod +33 | def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + | + = help: Rename type parameter to remove leading underscores + +ℹ Safe fix +28 28 | +29 29 | # each of these will get a separate diagnostic, but at least they'll all get +30 30 | # fixed +31 |-class Everything[_T, _U: str, _V: (int, float), *_W, **_X]: + 31 |+class Everything[_T, _U: str, _V: (int, float), *_W, **X]: +32 32 | @staticmethod +33 |- def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[_X, _T] | None: + 33 |+ def transform(t: _T, u: _U, v: _V) -> tuple[*_W] | Callable[X, _T] | None: +34 34 | return None +35 35 | +36 36 | + +UP049_1.py:39:9: UP049 Generic class uses private type parameters + | +37 | # this should not be fixed because the new name is a keyword, but we still +38 | # offer a diagnostic +39 | class F[_async]: ... + | ^^^^^^ UP049 + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:47:25: UP049 Generic class uses private type parameters + | +45 | type X = int +46 | +47 | class ScopeConflict[_X]: + | ^^ UP049 +48 | var: _X +49 | x: X + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:64:9: UP049 Generic class uses private type parameters + | +64 | class C[_0]: ... + | ^^ UP049 + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:67:12: UP049 Generic class uses private type parameters + | +67 | class C[T, _T]: ... + | ^^ UP049 +68 | class C[_T, T]: ... + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:68:9: UP049 Generic class uses private type parameters + | +67 | class C[T, _T]: ... +68 | class C[_T, T]: ... + | ^^ UP049 + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:71:9: UP049 Generic class uses private type parameters + | +71 | class C[_T]: + | ^^ UP049 +72 | v1 = cast(_T, ...) +73 | v2 = cast('_T', ...) + | + = help: Rename type parameter to remove leading underscores + +ℹ Display-only fix +68 68 | class C[_T, T]: ... +69 69 | +70 70 | +71 |-class C[_T]: +72 |- v1 = cast(_T, ...) +73 |- v2 = cast('_T', ...) +74 |- v3 = cast("\u005fT", ...) + 71 |+class C[T]: + 72 |+ v1 = cast(T, ...) + 73 |+ v2 = cast('T', ...) + 74 |+ v3 = cast(T, ...) +75 75 | +76 76 | def _(self): +77 |- v1 = cast(_T, ...) +78 |- v2 = cast('_T', ...) +79 |- v3 = cast("\u005fT", ...) + 77 |+ v1 = cast(T, ...) + 78 |+ v2 = cast('T', ...) + 79 |+ v3 = cast(T, ...) +80 80 | +81 81 | +82 82 | class C[_T]: + +UP049_1.py:82:9: UP049 Generic class uses private type parameters + | +82 | class C[_T]: + | ^^ UP049 +83 | v = cast('Literal[\'foo\'] | _T', ...) + | + = help: Rename type parameter to remove leading underscores + +ℹ Display-only fix +79 79 | v3 = cast("\u005fT", ...) +80 80 | +81 81 | +82 |-class C[_T]: +83 |- v = cast('Literal[\'foo\'] | _T', ...) + 82 |+class C[T]: + 83 |+ v = cast(T, ...) +84 84 | +85 85 | +86 86 | ## Name collision + +UP049_1.py:88:11: UP049 Generic function uses private type parameters + | +86 | ## Name collision +87 | class C[T]: +88 | def f[_T](self): # No fix, collides with `T` from outer scope + | ^^ UP049 +89 | v1 = cast(_T, ...) +90 | v2 = cast('_T', ...) + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:94:9: UP049 Generic class uses private type parameters + | +93 | # Unfixable as the new name collides with a variable visible from one of the inner scopes +94 | class C[_T]: + | ^^ UP049 +95 | T = 42 + | + = help: Rename type parameter to remove leading underscores + +UP049_1.py:102:9: UP049 Generic class uses private type parameters + | +101 | # Unfixable as the new name collides with a variable visible from one of the inner scopes +102 | class C[_T]: + | ^^ UP049 +103 | def f[T](self): +104 | v1 = cast(_T, ...) + | + = help: Rename type parameter to remove leading underscores diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__async_timeout_error_alias_not_applied_py310.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__async_timeout_error_alias_not_applied_py310.snap index 3197391b53919..3e307f7aa2168 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__async_timeout_error_alias_not_applied_py310.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__async_timeout_error_alias_not_applied_py310.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- UP041.py:10:8: UP041 [*] Replace aliased errors with `TimeoutError` | @@ -80,5 +81,3 @@ UP041.py:34:8: UP041 [*] Replace aliased errors with `TimeoutError` 35 35 | pass 36 36 | 37 37 | # First should change, second should not - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__datetime_utc_alias_py311.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__datetime_utc_alias_py311.snap index 9cea3d7563066..b236c324f19d5 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__datetime_utc_alias_py311.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__datetime_utc_alias_py311.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/pyupgrade/mod.rs UP017.py:10:11: UP017 [*] Use `datetime.UTC` alias | 8 | from datetime import timezone - 9 | + 9 | 10 | print(timezone.utc) | ^^^^^^^^^^^^ UP017 | @@ -28,7 +28,7 @@ UP017.py:10:11: UP017 [*] Use `datetime.UTC` alias UP017.py:16:11: UP017 [*] Use `datetime.UTC` alias | 14 | from datetime import timezone as tz -15 | +15 | 16 | print(tz.utc) | ^^^^^^ UP017 | @@ -52,7 +52,7 @@ UP017.py:16:11: UP017 [*] Use `datetime.UTC` alias UP017.py:22:11: UP017 [*] Use `datetime.UTC` alias | 20 | import datetime -21 | +21 | 22 | print(datetime.timezone.utc) | ^^^^^^^^^^^^^^^^^^^^^ UP017 | @@ -71,7 +71,7 @@ UP017.py:22:11: UP017 [*] Use `datetime.UTC` alias UP017.py:28:11: UP017 [*] Use `datetime.UTC` alias | 26 | import datetime as dt -27 | +27 | 28 | print(dt.timezone.utc) | ^^^^^^^^^^^^^^^ UP017 | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p310.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p310.snap index dc9d6c6a7f0f3..eb69749335369 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p310.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p310.snap @@ -43,7 +43,7 @@ future_annotations.py:35:9: UP006 [*] Use `list` instead of `List` for type anno future_annotations.py:42:27: UP006 [*] Use `list` instead of `List` for type annotation | 40 | x: Optional[int] = None -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | ^^^^ UP006 | @@ -59,7 +59,7 @@ future_annotations.py:42:27: UP006 [*] Use `list` instead of `List` for type ann future_annotations.py:42:38: UP006 [*] Use `list` instead of `List` for type annotation | 40 | x: Optional[int] = None -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | ^^^^ UP006 | @@ -71,5 +71,3 @@ future_annotations.py:42:38: UP006 [*] Use `list` instead of `List` for type ann 41 41 | 42 |-MyList: TypeAlias = Union[List[int], List[str]] 42 |+MyList: TypeAlias = Union[List[int], list[str]] - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p37.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p37.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p37.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_keep_runtime_typing_p37.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_p37.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_p37.snap index 71eba348b3fa9..afe64ea69a3f1 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_p37.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_p37.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- future_annotations.py:34:18: UP006 [*] Use `list` instead of `List` for type annotation | @@ -19,5 +20,3 @@ future_annotations.py:34:18: UP006 [*] Use `list` instead of `List` for type ann 35 35 | y = List[int]() 36 36 | y.append(x) 37 37 | return y - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_py310.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_py310.snap index dc9d6c6a7f0f3..eb69749335369 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_py310.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_585_py310.snap @@ -43,7 +43,7 @@ future_annotations.py:35:9: UP006 [*] Use `list` instead of `List` for type anno future_annotations.py:42:27: UP006 [*] Use `list` instead of `List` for type annotation | 40 | x: Optional[int] = None -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | ^^^^ UP006 | @@ -59,7 +59,7 @@ future_annotations.py:42:27: UP006 [*] Use `list` instead of `List` for type ann future_annotations.py:42:38: UP006 [*] Use `list` instead of `List` for type annotation | 40 | x: Optional[int] = None -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | ^^^^ UP006 | @@ -71,5 +71,3 @@ future_annotations.py:42:38: UP006 [*] Use `list` instead of `List` for type ann 41 41 | 42 |-MyList: TypeAlias = Union[List[int], List[str]] 42 |+MyList: TypeAlias = Union[List[int], list[str]] - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_p37.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_p37.snap index 442d20f7a5476..525b392e7c156 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_p37.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_p37.snap @@ -5,7 +5,7 @@ future_annotations.py:40:4: UP007 [*] Use `X | Y` for type annotations | 40 | x: Optional[int] = None | ^^^^^^^^^^^^^ UP007 -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | = help: Convert to `X | Y` @@ -18,5 +18,3 @@ future_annotations.py:40:4: UP007 [*] Use `X | Y` for type annotations 40 |+x: int | None = None 41 41 | 42 42 | MyList: TypeAlias = Union[List[int], List[str]] - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_py310.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_py310.snap index 386e009dfa9cb..f88a3b32fb327 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_py310.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__future_annotations_pep_604_py310.snap @@ -5,7 +5,7 @@ future_annotations.py:40:4: UP007 [*] Use `X | Y` for type annotations | 40 | x: Optional[int] = None | ^^^^^^^^^^^^^ UP007 -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | = help: Convert to `X | Y` @@ -22,7 +22,7 @@ future_annotations.py:40:4: UP007 [*] Use `X | Y` for type annotations future_annotations.py:42:21: UP007 [*] Use `X | Y` for type annotations | 40 | x: Optional[int] = None -41 | +41 | 42 | MyList: TypeAlias = Union[List[int], List[str]] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP007 | @@ -34,5 +34,3 @@ future_annotations.py:42:21: UP007 [*] Use `X | Y` for type annotations 41 41 | 42 |-MyList: TypeAlias = Union[List[int], List[str]] 42 |+MyList: TypeAlias = List[int] | List[str] - - diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__non_pep695_type_alias_not_applied_py311.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__non_pep695_type_alias_not_applied_py311.snap index 2bacb5d540775..c996a51d3844d 100644 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__non_pep695_type_alias_not_applied_py311.snap +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__non_pep695_type_alias_not_applied_py311.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__preview.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__preview.snap deleted file mode 100644 index 79c32ccea26e8..0000000000000 --- a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__preview.snap +++ /dev/null @@ -1,1318 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/pyupgrade/mod.rs ---- -UP031_0.py:4:7: UP031 [*] Use format specifiers instead of percent format - | -3 | # UP031 -4 | print('%s %s' % (a, b)) - | ^^^^^^^^^^^^^^^^ UP031 -5 | -6 | print('%s%s' % (a, b)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -1 1 | a, b, x, y = 1, 2, 3, 4 -2 2 | -3 3 | # UP031 -4 |-print('%s %s' % (a, b)) - 4 |+print('{} {}'.format(a, b)) -5 5 | -6 6 | print('%s%s' % (a, b)) -7 7 | - -UP031_0.py:6:7: UP031 [*] Use format specifiers instead of percent format - | -4 | print('%s %s' % (a, b)) -5 | -6 | print('%s%s' % (a, b)) - | ^^^^^^^^^^^^^^^ UP031 -7 | -8 | print("trivial" % ()) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -3 3 | # UP031 -4 4 | print('%s %s' % (a, b)) -5 5 | -6 |-print('%s%s' % (a, b)) - 6 |+print('{}{}'.format(a, b)) -7 7 | -8 8 | print("trivial" % ()) -9 9 | - -UP031_0.py:8:7: UP031 [*] Use format specifiers instead of percent format - | - 6 | print('%s%s' % (a, b)) - 7 | - 8 | print("trivial" % ()) - | ^^^^^^^^^^^^^^ UP031 - 9 | -10 | print("%s" % ("simple",)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -5 5 | -6 6 | print('%s%s' % (a, b)) -7 7 | -8 |-print("trivial" % ()) - 8 |+print("trivial".format()) -9 9 | -10 10 | print("%s" % ("simple",)) -11 11 | - -UP031_0.py:10:7: UP031 [*] Use format specifiers instead of percent format - | - 8 | print("trivial" % ()) - 9 | -10 | print("%s" % ("simple",)) - | ^^^^^^^^^^^^^^^^^^ UP031 -11 | -12 | print("%s" % ("%s" % ("nested",),)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -7 7 | -8 8 | print("trivial" % ()) -9 9 | -10 |-print("%s" % ("simple",)) - 10 |+print("{}".format("simple")) -11 11 | -12 12 | print("%s" % ("%s" % ("nested",),)) -13 13 | - -UP031_0.py:12:7: UP031 [*] Use format specifiers instead of percent format - | -10 | print("%s" % ("simple",)) -11 | -12 | print("%s" % ("%s" % ("nested",),)) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -13 | -14 | print("%s%% percent" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -9 9 | -10 10 | print("%s" % ("simple",)) -11 11 | -12 |-print("%s" % ("%s" % ("nested",),)) - 12 |+print("{}".format("%s" % ("nested",))) -13 13 | -14 14 | print("%s%% percent" % (15,)) -15 15 | - -UP031_0.py:12:15: UP031 [*] Use format specifiers instead of percent format - | -10 | print("%s" % ("simple",)) -11 | -12 | print("%s" % ("%s" % ("nested",),)) - | ^^^^^^^^^^^^^^^^^^ UP031 -13 | -14 | print("%s%% percent" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -9 9 | -10 10 | print("%s" % ("simple",)) -11 11 | -12 |-print("%s" % ("%s" % ("nested",),)) - 12 |+print("%s" % ("{}".format("nested"),)) -13 13 | -14 14 | print("%s%% percent" % (15,)) -15 15 | - -UP031_0.py:14:7: UP031 [*] Use format specifiers instead of percent format - | -12 | print("%s" % ("%s" % ("nested",),)) -13 | -14 | print("%s%% percent" % (15,)) - | ^^^^^^^^^^^^^^^^^^^^^^ UP031 -15 | -16 | print("%f" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -11 11 | -12 12 | print("%s" % ("%s" % ("nested",),)) -13 13 | -14 |-print("%s%% percent" % (15,)) - 14 |+print("{}% percent".format(15)) -15 15 | -16 16 | print("%f" % (15,)) -17 17 | - -UP031_0.py:16:7: UP031 [*] Use format specifiers instead of percent format - | -14 | print("%s%% percent" % (15,)) -15 | -16 | print("%f" % (15,)) - | ^^^^^^^^^^^^ UP031 -17 | -18 | print("%.f" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -13 13 | -14 14 | print("%s%% percent" % (15,)) -15 15 | -16 |-print("%f" % (15,)) - 16 |+print("{:f}".format(15)) -17 17 | -18 18 | print("%.f" % (15,)) -19 19 | - -UP031_0.py:18:7: UP031 [*] Use format specifiers instead of percent format - | -16 | print("%f" % (15,)) -17 | -18 | print("%.f" % (15,)) - | ^^^^^^^^^^^^^ UP031 -19 | -20 | print("%.3f" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -15 15 | -16 16 | print("%f" % (15,)) -17 17 | -18 |-print("%.f" % (15,)) - 18 |+print("{:.0f}".format(15)) -19 19 | -20 20 | print("%.3f" % (15,)) -21 21 | - -UP031_0.py:20:7: UP031 [*] Use format specifiers instead of percent format - | -18 | print("%.f" % (15,)) -19 | -20 | print("%.3f" % (15,)) - | ^^^^^^^^^^^^^^ UP031 -21 | -22 | print("%3f" % (15,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -17 17 | -18 18 | print("%.f" % (15,)) -19 19 | -20 |-print("%.3f" % (15,)) - 20 |+print("{:.3f}".format(15)) -21 21 | -22 22 | print("%3f" % (15,)) -23 23 | - -UP031_0.py:22:7: UP031 [*] Use format specifiers instead of percent format - | -20 | print("%.3f" % (15,)) -21 | -22 | print("%3f" % (15,)) - | ^^^^^^^^^^^^^ UP031 -23 | -24 | print("%-5f" % (5,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -19 19 | -20 20 | print("%.3f" % (15,)) -21 21 | -22 |-print("%3f" % (15,)) - 22 |+print("{:3f}".format(15)) -23 23 | -24 24 | print("%-5f" % (5,)) -25 25 | - -UP031_0.py:24:7: UP031 [*] Use format specifiers instead of percent format - | -22 | print("%3f" % (15,)) -23 | -24 | print("%-5f" % (5,)) - | ^^^^^^^^^^^^^ UP031 -25 | -26 | print("%9f" % (5,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -21 21 | -22 22 | print("%3f" % (15,)) -23 23 | -24 |-print("%-5f" % (5,)) - 24 |+print("{:<5f}".format(5)) -25 25 | -26 26 | print("%9f" % (5,)) -27 27 | - -UP031_0.py:26:7: UP031 [*] Use format specifiers instead of percent format - | -24 | print("%-5f" % (5,)) -25 | -26 | print("%9f" % (5,)) - | ^^^^^^^^^^^^ UP031 -27 | -28 | print("%#o" % (123,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -23 23 | -24 24 | print("%-5f" % (5,)) -25 25 | -26 |-print("%9f" % (5,)) - 26 |+print("{:9f}".format(5)) -27 27 | -28 28 | print("%#o" % (123,)) -29 29 | - -UP031_0.py:28:7: UP031 [*] Use format specifiers instead of percent format - | -26 | print("%9f" % (5,)) -27 | -28 | print("%#o" % (123,)) - | ^^^^^^^^^^^^^^ UP031 -29 | -30 | print("brace {} %s" % (1,)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -25 25 | -26 26 | print("%9f" % (5,)) -27 27 | -28 |-print("%#o" % (123,)) - 28 |+print("{:#o}".format(123)) -29 29 | -30 30 | print("brace {} %s" % (1,)) -31 31 | - -UP031_0.py:30:7: UP031 [*] Use format specifiers instead of percent format - | -28 | print("%#o" % (123,)) -29 | -30 | print("brace {} %s" % (1,)) - | ^^^^^^^^^^^^^^^^^^^^ UP031 -31 | -32 | print(( - | - = help: Replace with format specifiers - -ℹ Unsafe fix -27 27 | -28 28 | print("%#o" % (123,)) -29 29 | -30 |-print("brace {} %s" % (1,)) - 30 |+print("brace {{}} {}".format(1)) -31 31 | -32 32 | print(( -33 33 | "foo %s " - -UP031_0.py:33:5: UP031 [*] Use format specifiers instead of percent format - | -32 | print(( -33 | "foo %s " - | _____^ -34 | | "bar %s" % (x, y) - | |_____________________^ UP031 -35 | )) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -30 30 | print("brace {} %s" % (1,)) -31 31 | -32 32 | print(( -33 |- "foo %s " -34 |- "bar %s" % (x, y) - 33 |+ "foo {} " - 34 |+ "bar {}".format(x, y) -35 35 | )) -36 36 | -37 37 | print( - -UP031_0.py:38:3: UP031 [*] Use format specifiers instead of percent format - | -37 | print( -38 | "%s" % ( - | ___^ -39 | | "trailing comma", -40 | | ) - | |_________^ UP031 -41 | ) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -35 35 | )) -36 36 | -37 37 | print( -38 |- "%s" % ( - 38 |+ "{}".format( -39 39 | "trailing comma", -40 40 | ) -41 41 | ) - -UP031_0.py:43:7: UP031 [*] Use format specifiers instead of percent format - | -41 | ) -42 | -43 | print("foo %s " % (x,)) - | ^^^^^^^^^^^^^^^^ UP031 -44 | -45 | print("%(k)s" % {"k": "v"}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -40 40 | ) -41 41 | ) -42 42 | -43 |-print("foo %s " % (x,)) - 43 |+print("foo {} ".format(x)) -44 44 | -45 45 | print("%(k)s" % {"k": "v"}) -46 46 | - -UP031_0.py:45:7: UP031 [*] Use format specifiers instead of percent format - | -43 | print("foo %s " % (x,)) -44 | -45 | print("%(k)s" % {"k": "v"}) - | ^^^^^^^^^^^^^^^^^^^^ UP031 -46 | -47 | print("%(k)s" % { - | - = help: Replace with format specifiers - -ℹ Unsafe fix -42 42 | -43 43 | print("foo %s " % (x,)) -44 44 | -45 |-print("%(k)s" % {"k": "v"}) - 45 |+print("{k}".format(k="v")) -46 46 | -47 47 | print("%(k)s" % { -48 48 | "k": "v", - -UP031_0.py:47:7: UP031 [*] Use format specifiers instead of percent format - | -45 | print("%(k)s" % {"k": "v"}) -46 | -47 | print("%(k)s" % { - | _______^ -48 | | "k": "v", -49 | | "i": "j" -50 | | }) - | |_^ UP031 -51 | -52 | print("%(to_list)s" % {"to_list": []}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -44 44 | -45 45 | print("%(k)s" % {"k": "v"}) -46 46 | -47 |-print("%(k)s" % { -48 |- "k": "v", -49 |- "i": "j" -50 |-}) - 47 |+print("{k}".format( - 48 |+ k="v", - 49 |+ i="j", - 50 |+)) -51 51 | -52 52 | print("%(to_list)s" % {"to_list": []}) -53 53 | - -UP031_0.py:52:7: UP031 [*] Use format specifiers instead of percent format - | -50 | }) -51 | -52 | print("%(to_list)s" % {"to_list": []}) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -53 | -54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -49 49 | "i": "j" -50 50 | }) -51 51 | -52 |-print("%(to_list)s" % {"to_list": []}) - 52 |+print("{to_list}".format(to_list=[])) -53 53 | -54 54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) -55 55 | - -UP031_0.py:54:7: UP031 [*] Use format specifiers instead of percent format - | -52 | print("%(to_list)s" % {"to_list": []}) -53 | -54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -55 | -56 | print("%(ab)s" % {"a" "b": 1}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -51 51 | -52 52 | print("%(to_list)s" % {"to_list": []}) -53 53 | -54 |-print("%(k)s" % {"k": "v", "i": 1, "j": []}) - 54 |+print("{k}".format(k="v", i=1, j=[])) -55 55 | -56 56 | print("%(ab)s" % {"a" "b": 1}) -57 57 | - -UP031_0.py:56:7: UP031 [*] Use format specifiers instead of percent format - | -54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) -55 | -56 | print("%(ab)s" % {"a" "b": 1}) - | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -57 | -58 | print("%(a)s" % {"a" : 1}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -53 53 | -54 54 | print("%(k)s" % {"k": "v", "i": 1, "j": []}) -55 55 | -56 |-print("%(ab)s" % {"a" "b": 1}) - 56 |+print("{ab}".format(ab=1)) -57 57 | -58 58 | print("%(a)s" % {"a" : 1}) -59 59 | - -UP031_0.py:58:7: UP031 [*] Use format specifiers instead of percent format - | -56 | print("%(ab)s" % {"a" "b": 1}) -57 | -58 | print("%(a)s" % {"a" : 1}) - | ^^^^^^^^^^^^^^^^^^^^^ UP031 - | - = help: Replace with format specifiers - -ℹ Unsafe fix -55 55 | -56 56 | print("%(ab)s" % {"a" "b": 1}) -57 57 | -58 |-print("%(a)s" % {"a" : 1}) - 58 |+print("{a}".format(a=1)) -59 59 | -60 60 | -61 61 | print( - -UP031_0.py:62:5: UP031 [*] Use format specifiers instead of percent format - | -61 | print( -62 | "foo %(foo)s " - | _____^ -63 | | "bar %(bar)s" % {"foo": x, "bar": y} - | |________________________________________^ UP031 -64 | ) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -59 59 | -60 60 | -61 61 | print( -62 |- "foo %(foo)s " -63 |- "bar %(bar)s" % {"foo": x, "bar": y} - 62 |+ "foo {foo} " - 63 |+ "bar {bar}".format(foo=x, bar=y) -64 64 | ) -65 65 | -66 66 | bar = {"bar": y} - -UP031_0.py:68:5: UP031 [*] Use format specifiers instead of percent format - | -66 | bar = {"bar": y} -67 | print( -68 | "foo %(foo)s " - | _____^ -69 | | "bar %(bar)s" % {"foo": x, **bar} - | |_____________________________________^ UP031 -70 | ) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -65 65 | -66 66 | bar = {"bar": y} -67 67 | print( -68 |- "foo %(foo)s " -69 |- "bar %(bar)s" % {"foo": x, **bar} - 68 |+ "foo {foo} " - 69 |+ "bar {bar}".format(foo=x, **bar) -70 70 | ) -71 71 | -72 72 | print("%s \N{snowman}" % (a,)) - -UP031_0.py:72:7: UP031 [*] Use format specifiers instead of percent format - | -70 | ) -71 | -72 | print("%s \N{snowman}" % (a,)) - | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -73 | -74 | print("%(foo)s \N{snowman}" % {"foo": 1}) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -69 69 | "bar %(bar)s" % {"foo": x, **bar} -70 70 | ) -71 71 | -72 |-print("%s \N{snowman}" % (a,)) - 72 |+print("{} \N{snowman}".format(a)) -73 73 | -74 74 | print("%(foo)s \N{snowman}" % {"foo": 1}) -75 75 | - -UP031_0.py:74:7: UP031 [*] Use format specifiers instead of percent format - | -72 | print("%s \N{snowman}" % (a,)) -73 | -74 | print("%(foo)s \N{snowman}" % {"foo": 1}) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -75 | -76 | print(("foo %s " "bar %s") % (x, y)) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -71 71 | -72 72 | print("%s \N{snowman}" % (a,)) -73 73 | -74 |-print("%(foo)s \N{snowman}" % {"foo": 1}) - 74 |+print("{foo} \N{snowman}".format(foo=1)) -75 75 | -76 76 | print(("foo %s " "bar %s") % (x, y)) -77 77 | - -UP031_0.py:76:7: UP031 [*] Use format specifiers instead of percent format - | -74 | print("%(foo)s \N{snowman}" % {"foo": 1}) -75 | -76 | print(("foo %s " "bar %s") % (x, y)) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -77 | -78 | # Single-value expressions - | - = help: Replace with format specifiers - -ℹ Unsafe fix -73 73 | -74 74 | print("%(foo)s \N{snowman}" % {"foo": 1}) -75 75 | -76 |-print(("foo %s " "bar %s") % (x, y)) - 76 |+print(("foo {} " "bar {}").format(x, y)) -77 77 | -78 78 | # Single-value expressions -79 79 | print('Hello %s' % "World") - -UP031_0.py:79:7: UP031 [*] Use format specifiers instead of percent format - | -78 | # Single-value expressions -79 | print('Hello %s' % "World") - | ^^^^^^^^^^^^^^^^^^^^ UP031 -80 | print('Hello %s' % f"World") -81 | print('Hello %s (%s)' % bar) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -76 76 | print(("foo %s " "bar %s") % (x, y)) -77 77 | -78 78 | # Single-value expressions -79 |-print('Hello %s' % "World") - 79 |+print('Hello {}'.format("World")) -80 80 | print('Hello %s' % f"World") -81 81 | print('Hello %s (%s)' % bar) -82 82 | print('Hello %s (%s)' % bar.baz) - -UP031_0.py:80:7: UP031 [*] Use format specifiers instead of percent format - | -78 | # Single-value expressions -79 | print('Hello %s' % "World") -80 | print('Hello %s' % f"World") - | ^^^^^^^^^^^^^^^^^^^^^ UP031 -81 | print('Hello %s (%s)' % bar) -82 | print('Hello %s (%s)' % bar.baz) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -77 77 | -78 78 | # Single-value expressions -79 79 | print('Hello %s' % "World") -80 |-print('Hello %s' % f"World") - 80 |+print('Hello {}'.format(f"World")) -81 81 | print('Hello %s (%s)' % bar) -82 82 | print('Hello %s (%s)' % bar.baz) -83 83 | print('Hello %s (%s)' % bar['bop']) - -UP031_0.py:81:7: UP031 [*] Use format specifiers instead of percent format - | -79 | print('Hello %s' % "World") -80 | print('Hello %s' % f"World") -81 | print('Hello %s (%s)' % bar) - | ^^^^^^^^^^^^^^^^^^^^^ UP031 -82 | print('Hello %s (%s)' % bar.baz) -83 | print('Hello %s (%s)' % bar['bop']) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -78 78 | # Single-value expressions -79 79 | print('Hello %s' % "World") -80 80 | print('Hello %s' % f"World") -81 |-print('Hello %s (%s)' % bar) - 81 |+print('Hello {} ({})'.format(*bar)) -82 82 | print('Hello %s (%s)' % bar.baz) -83 83 | print('Hello %s (%s)' % bar['bop']) -84 84 | print('Hello %(arg)s' % bar) - -UP031_0.py:82:7: UP031 [*] Use format specifiers instead of percent format - | -80 | print('Hello %s' % f"World") -81 | print('Hello %s (%s)' % bar) -82 | print('Hello %s (%s)' % bar.baz) - | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -83 | print('Hello %s (%s)' % bar['bop']) -84 | print('Hello %(arg)s' % bar) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -79 79 | print('Hello %s' % "World") -80 80 | print('Hello %s' % f"World") -81 81 | print('Hello %s (%s)' % bar) -82 |-print('Hello %s (%s)' % bar.baz) - 82 |+print('Hello {} ({})'.format(*bar.baz)) -83 83 | print('Hello %s (%s)' % bar['bop']) -84 84 | print('Hello %(arg)s' % bar) -85 85 | print('Hello %(arg)s' % bar.baz) - -UP031_0.py:83:7: UP031 [*] Use format specifiers instead of percent format - | -81 | print('Hello %s (%s)' % bar) -82 | print('Hello %s (%s)' % bar.baz) -83 | print('Hello %s (%s)' % bar['bop']) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -84 | print('Hello %(arg)s' % bar) -85 | print('Hello %(arg)s' % bar.baz) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -80 80 | print('Hello %s' % f"World") -81 81 | print('Hello %s (%s)' % bar) -82 82 | print('Hello %s (%s)' % bar.baz) -83 |-print('Hello %s (%s)' % bar['bop']) - 83 |+print('Hello {} ({})'.format(*bar['bop'])) -84 84 | print('Hello %(arg)s' % bar) -85 85 | print('Hello %(arg)s' % bar.baz) -86 86 | print('Hello %(arg)s' % bar['bop']) - -UP031_0.py:84:7: UP031 [*] Use format specifiers instead of percent format - | -82 | print('Hello %s (%s)' % bar.baz) -83 | print('Hello %s (%s)' % bar['bop']) -84 | print('Hello %(arg)s' % bar) - | ^^^^^^^^^^^^^^^^^^^^^ UP031 -85 | print('Hello %(arg)s' % bar.baz) -86 | print('Hello %(arg)s' % bar['bop']) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -81 81 | print('Hello %s (%s)' % bar) -82 82 | print('Hello %s (%s)' % bar.baz) -83 83 | print('Hello %s (%s)' % bar['bop']) -84 |-print('Hello %(arg)s' % bar) - 84 |+print('Hello {arg}'.format(**bar)) -85 85 | print('Hello %(arg)s' % bar.baz) -86 86 | print('Hello %(arg)s' % bar['bop']) -87 87 | - -UP031_0.py:85:7: UP031 [*] Use format specifiers instead of percent format - | -83 | print('Hello %s (%s)' % bar['bop']) -84 | print('Hello %(arg)s' % bar) -85 | print('Hello %(arg)s' % bar.baz) - | ^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -86 | print('Hello %(arg)s' % bar['bop']) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -82 82 | print('Hello %s (%s)' % bar.baz) -83 83 | print('Hello %s (%s)' % bar['bop']) -84 84 | print('Hello %(arg)s' % bar) -85 |-print('Hello %(arg)s' % bar.baz) - 85 |+print('Hello {arg}'.format(**bar.baz)) -86 86 | print('Hello %(arg)s' % bar['bop']) -87 87 | -88 88 | # Hanging modulos - -UP031_0.py:86:7: UP031 [*] Use format specifiers instead of percent format - | -84 | print('Hello %(arg)s' % bar) -85 | print('Hello %(arg)s' % bar.baz) -86 | print('Hello %(arg)s' % bar['bop']) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP031 -87 | -88 | # Hanging modulos - | - = help: Replace with format specifiers - -ℹ Unsafe fix -83 83 | print('Hello %s (%s)' % bar['bop']) -84 84 | print('Hello %(arg)s' % bar) -85 85 | print('Hello %(arg)s' % bar.baz) -86 |-print('Hello %(arg)s' % bar['bop']) - 86 |+print('Hello {arg}'.format(**bar['bop'])) -87 87 | -88 88 | # Hanging modulos -89 89 | ( - -UP031_0.py:89:1: UP031 [*] Use format specifiers instead of percent format - | -88 | # Hanging modulos -89 | / ( -90 | | "foo %s " -91 | | "bar %s" -92 | | ) % (x, y) - | |__________^ UP031 -93 | -94 | ( - | - = help: Replace with format specifiers - -ℹ Unsafe fix -87 87 | -88 88 | # Hanging modulos -89 89 | ( -90 |- "foo %s " -91 |- "bar %s" -92 |-) % (x, y) - 90 |+ "foo {} " - 91 |+ "bar {}" - 92 |+).format(x, y) -93 93 | -94 94 | ( -95 95 | "foo %(foo)s " - -UP031_0.py:94:1: UP031 [*] Use format specifiers instead of percent format - | -92 | ) % (x, y) -93 | -94 | / ( -95 | | "foo %(foo)s " -96 | | "bar %(bar)s" -97 | | ) % {"foo": x, "bar": y} - | |________________________^ UP031 -98 | -99 | ( - | - = help: Replace with format specifiers - -ℹ Unsafe fix -92 92 | ) % (x, y) -93 93 | -94 94 | ( -95 |- "foo %(foo)s " -96 |- "bar %(bar)s" -97 |-) % {"foo": x, "bar": y} - 95 |+ "foo {foo} " - 96 |+ "bar {bar}" - 97 |+).format(foo=x, bar=y) -98 98 | -99 99 | ( -100 100 | """foo %s""" - -UP031_0.py:100:5: UP031 [*] Use format specifiers instead of percent format - | - 99 | ( -100 | """foo %s""" - | _____^ -101 | | % (x,) - | |__________^ UP031 -102 | ) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -97 97 | ) % {"foo": x, "bar": y} -98 98 | -99 99 | ( -100 |- """foo %s""" -101 |- % (x,) - 100 |+ """foo {}""".format(x) -102 101 | ) -103 102 | -104 103 | ( - -UP031_0.py:105:5: UP031 [*] Use format specifiers instead of percent format - | -104 | ( -105 | """ - | _____^ -106 | | foo %s -107 | | """ -108 | | % (x,) - | |__________^ UP031 -109 | ) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -103 103 | -104 104 | ( -105 105 | """ -106 |- foo %s -107 |- """ -108 |- % (x,) - 106 |+ foo {} - 107 |+ """.format(x) -109 108 | ) -110 109 | -111 110 | "%s" % ( - -UP031_0.py:111:1: UP031 [*] Use format specifiers instead of percent format - | -109 | ) -110 | -111 | / "%s" % ( -112 | | x, # comment -113 | | ) - | |_^ UP031 - | - = help: Replace with format specifiers - -ℹ Unsafe fix -108 108 | % (x,) -109 109 | ) -110 110 | -111 |-"%s" % ( - 111 |+"{}".format( -112 112 | x, # comment -113 113 | ) -114 114 | - -UP031_0.py:116:8: UP031 [*] Use format specifiers instead of percent format - | -116 | path = "%s-%s-%s.pem" % ( - | ________^ -117 | | safe_domain_name(cn), # common name, which should be filename safe because it is IDNA-encoded, but in case of a malformed cert make sure it's ok to use as a filename -118 | | cert.not_valid_after.date().isoformat().replace("-", ""), # expiration date -119 | | hexlify(cert.fingerprint(hashes.SHA256())).decode("ascii")[0:8], # fingerprint prefix -120 | | ) - | |_^ UP031 -121 | -122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -113 113 | ) -114 114 | -115 115 | -116 |-path = "%s-%s-%s.pem" % ( - 116 |+path = "{}-{}-{}.pem".format( -117 117 | safe_domain_name(cn), # common name, which should be filename safe because it is IDNA-encoded, but in case of a malformed cert make sure it's ok to use as a filename -118 118 | cert.not_valid_after.date().isoformat().replace("-", ""), # expiration date -119 119 | hexlify(cert.fingerprint(hashes.SHA256())).decode("ascii")[0:8], # fingerprint prefix - -UP031_0.py:123:1: UP031 [*] Use format specifiers instead of percent format - | -122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) -123 | 'Hello %s' % bar - | ^^^^^^^^^^^^^^^^ UP031 -124 | -125 | 'Hello %s' % bar.baz - | - = help: Replace with format specifiers - -ℹ Unsafe fix -120 120 | ) -121 121 | -122 122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) -123 |-'Hello %s' % bar - 123 |+'Hello {}'.format(bar) -124 124 | -125 125 | 'Hello %s' % bar.baz -126 126 | - -UP031_0.py:125:1: UP031 [*] Use format specifiers instead of percent format - | -123 | 'Hello %s' % bar -124 | -125 | 'Hello %s' % bar.baz - | ^^^^^^^^^^^^^^^^^^^^ UP031 -126 | -127 | 'Hello %s' % bar['bop'] - | - = help: Replace with format specifiers - -ℹ Unsafe fix -122 122 | # UP031 (no longer false negatives; now offer potentially unsafe fixes) -123 123 | 'Hello %s' % bar -124 124 | -125 |-'Hello %s' % bar.baz - 125 |+'Hello {}'.format(bar.baz) -126 126 | -127 127 | 'Hello %s' % bar['bop'] -128 128 | - -UP031_0.py:127:1: UP031 [*] Use format specifiers instead of percent format - | -125 | 'Hello %s' % bar.baz -126 | -127 | 'Hello %s' % bar['bop'] - | ^^^^^^^^^^^^^^^^^^^^^^^ UP031 -128 | -129 | # Not a valid type annotation but this test shouldn't result in a panic. - | - = help: Replace with format specifiers - -ℹ Unsafe fix -124 124 | -125 125 | 'Hello %s' % bar.baz -126 126 | -127 |-'Hello %s' % bar['bop'] - 127 |+'Hello {}'.format(bar['bop']) -128 128 | -129 129 | # Not a valid type annotation but this test shouldn't result in a panic. -130 130 | # Refer: https://github.com/astral-sh/ruff/issues/11736 - -UP031_0.py:131:5: UP031 [*] Use format specifiers instead of percent format - | -129 | # Not a valid type annotation but this test shouldn't result in a panic. -130 | # Refer: https://github.com/astral-sh/ruff/issues/11736 -131 | x: "'%s + %s' % (1, 2)" - | ^^^^^^^^^^^^^^^^^^ UP031 -132 | -133 | # See: https://github.com/astral-sh/ruff/issues/12421 - | - = help: Replace with format specifiers - -ℹ Unsafe fix -128 128 | -129 129 | # Not a valid type annotation but this test shouldn't result in a panic. -130 130 | # Refer: https://github.com/astral-sh/ruff/issues/11736 -131 |-x: "'%s + %s' % (1, 2)" - 131 |+x: "'{} + {}'.format(1, 2)" -132 132 | -133 133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 134 | print("%.2X" % 1) - -UP031_0.py:134:7: UP031 [*] Use format specifiers instead of percent format - | -133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 | print("%.2X" % 1) - | ^^^^^^^^^^ UP031 -135 | print("%.02X" % 1) -136 | print("%02X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -131 131 | x: "'%s + %s' % (1, 2)" -132 132 | -133 133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 |-print("%.2X" % 1) - 134 |+print("{:02X}".format(1)) -135 135 | print("%.02X" % 1) -136 136 | print("%02X" % 1) -137 137 | print("%.00002X" % 1) - -UP031_0.py:135:7: UP031 [*] Use format specifiers instead of percent format - | -133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 | print("%.2X" % 1) -135 | print("%.02X" % 1) - | ^^^^^^^^^^^ UP031 -136 | print("%02X" % 1) -137 | print("%.00002X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -132 132 | -133 133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 134 | print("%.2X" % 1) -135 |-print("%.02X" % 1) - 135 |+print("{:02X}".format(1)) -136 136 | print("%02X" % 1) -137 137 | print("%.00002X" % 1) -138 138 | print("%.20X" % 1) - -UP031_0.py:136:7: UP031 [*] Use format specifiers instead of percent format - | -134 | print("%.2X" % 1) -135 | print("%.02X" % 1) -136 | print("%02X" % 1) - | ^^^^^^^^^^ UP031 -137 | print("%.00002X" % 1) -138 | print("%.20X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -133 133 | # See: https://github.com/astral-sh/ruff/issues/12421 -134 134 | print("%.2X" % 1) -135 135 | print("%.02X" % 1) -136 |-print("%02X" % 1) - 136 |+print("{:02X}".format(1)) -137 137 | print("%.00002X" % 1) -138 138 | print("%.20X" % 1) -139 139 | - -UP031_0.py:137:7: UP031 [*] Use format specifiers instead of percent format - | -135 | print("%.02X" % 1) -136 | print("%02X" % 1) -137 | print("%.00002X" % 1) - | ^^^^^^^^^^^^^^ UP031 -138 | print("%.20X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -134 134 | print("%.2X" % 1) -135 135 | print("%.02X" % 1) -136 136 | print("%02X" % 1) -137 |-print("%.00002X" % 1) - 137 |+print("{:02X}".format(1)) -138 138 | print("%.20X" % 1) -139 139 | -140 140 | print("%2X" % 1) - -UP031_0.py:138:7: UP031 [*] Use format specifiers instead of percent format - | -136 | print("%02X" % 1) -137 | print("%.00002X" % 1) -138 | print("%.20X" % 1) - | ^^^^^^^^^^^ UP031 -139 | -140 | print("%2X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -135 135 | print("%.02X" % 1) -136 136 | print("%02X" % 1) -137 137 | print("%.00002X" % 1) -138 |-print("%.20X" % 1) - 138 |+print("{:020X}".format(1)) -139 139 | -140 140 | print("%2X" % 1) -141 141 | print("%02X" % 1) - -UP031_0.py:140:7: UP031 [*] Use format specifiers instead of percent format - | -138 | print("%.20X" % 1) -139 | -140 | print("%2X" % 1) - | ^^^^^^^^^ UP031 -141 | print("%02X" % 1) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -137 137 | print("%.00002X" % 1) -138 138 | print("%.20X" % 1) -139 139 | -140 |-print("%2X" % 1) - 140 |+print("{:2X}".format(1)) -141 141 | print("%02X" % 1) -142 142 | -143 143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) - -UP031_0.py:141:7: UP031 [*] Use format specifiers instead of percent format - | -140 | print("%2X" % 1) -141 | print("%02X" % 1) - | ^^^^^^^^^^ UP031 -142 | -143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) - | - = help: Replace with format specifiers - -ℹ Unsafe fix -138 138 | print("%.20X" % 1) -139 139 | -140 140 | print("%2X" % 1) -141 |-print("%02X" % 1) - 141 |+print("{:02X}".format(1)) -142 142 | -143 143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) -144 144 | - -UP031_0.py:145:1: UP031 Use format specifiers instead of percent format - | -143 | # UP031 (no longer false negatives, but offer no fix because of more complex syntax) -144 | -145 | "%d.%d" % (a, b) - | ^^^^^^^ UP031 -146 | -147 | "%*s" % (5, "hi") - | - = help: Replace with format specifiers - -UP031_0.py:147:1: UP031 Use format specifiers instead of percent format - | -145 | "%d.%d" % (a, b) -146 | -147 | "%*s" % (5, "hi") - | ^^^^^ UP031 -148 | -149 | "%d" % (flt,) - | - = help: Replace with format specifiers - -UP031_0.py:149:1: UP031 Use format specifiers instead of percent format - | -147 | "%*s" % (5, "hi") -148 | -149 | "%d" % (flt,) - | ^^^^ UP031 -150 | -151 | "%c" % (some_string,) - | - = help: Replace with format specifiers - -UP031_0.py:151:1: UP031 Use format specifiers instead of percent format - | -149 | "%d" % (flt,) -150 | -151 | "%c" % (some_string,) - | ^^^^ UP031 -152 | -153 | "%.2r" % (1.25) - | - = help: Replace with format specifiers - -UP031_0.py:153:1: UP031 Use format specifiers instead of percent format - | -151 | "%c" % (some_string,) -152 | -153 | "%.2r" % (1.25) - | ^^^^^^ UP031 -154 | -155 | "%.*s" % (5, "hi") - | - = help: Replace with format specifiers - -UP031_0.py:155:1: UP031 Use format specifiers instead of percent format - | -153 | "%.2r" % (1.25) -154 | -155 | "%.*s" % (5, "hi") - | ^^^^^^ UP031 -156 | -157 | "%i" % (flt,) - | - = help: Replace with format specifiers - -UP031_0.py:157:1: UP031 Use format specifiers instead of percent format - | -155 | "%.*s" % (5, "hi") -156 | -157 | "%i" % (flt,) - | ^^^^ UP031 -158 | -159 | "%()s" % {"": "empty"} - | - = help: Replace with format specifiers - -UP031_0.py:159:1: UP031 Use format specifiers instead of percent format - | -157 | "%i" % (flt,) -158 | -159 | "%()s" % {"": "empty"} - | ^^^^^^ UP031 -160 | -161 | "%s" % {"k": "v"} - | - = help: Replace with format specifiers - -UP031_0.py:161:1: UP031 Use format specifiers instead of percent format - | -159 | "%()s" % {"": "empty"} -160 | -161 | "%s" % {"k": "v"} - | ^^^^ UP031 -162 | -163 | "%()s" % {"": "bar"} - | - = help: Replace with format specifiers - -UP031_0.py:163:1: UP031 Use format specifiers instead of percent format - | -161 | "%s" % {"k": "v"} -162 | -163 | "%()s" % {"": "bar"} - | ^^^^^^ UP031 -164 | -165 | "%(1)s" % {"1": "bar"} - | - = help: Replace with format specifiers - -UP031_0.py:165:1: UP031 Use format specifiers instead of percent format - | -163 | "%()s" % {"": "bar"} -164 | -165 | "%(1)s" % {"1": "bar"} - | ^^^^^^^ UP031 -166 | -167 | "%(a)s" % {"a": 1, "a": 2} - | - = help: Replace with format specifiers - -UP031_0.py:167:1: UP031 Use format specifiers instead of percent format - | -165 | "%(1)s" % {"1": "bar"} -166 | -167 | "%(a)s" % {"a": 1, "a": 2} - | ^^^^^^^ UP031 -168 | -169 | "%(1)s" % {1: 2, "1": 2} - | - = help: Replace with format specifiers - -UP031_0.py:169:1: UP031 Use format specifiers instead of percent format - | -167 | "%(a)s" % {"a": 1, "a": 2} -168 | -169 | "%(1)s" % {1: 2, "1": 2} - | ^^^^^^^ UP031 -170 | -171 | "%(and)s" % {"and": 2} - | - = help: Replace with format specifiers - -UP031_0.py:171:1: UP031 Use format specifiers instead of percent format - | -169 | "%(1)s" % {1: 2, "1": 2} -170 | -171 | "%(and)s" % {"and": 2} - | ^^^^^^^^^ UP031 - | - = help: Replace with format specifiers diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__unpack_pep_646_py311.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__unpack_pep_646_py311.snap new file mode 100644 index 0000000000000..3407035b9a1b4 --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__unpack_pep_646_py311.snap @@ -0,0 +1,93 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- +UP044.py:6:17: UP044 [*] Use `*` for unpacking + | +6 | class C(Generic[Unpack[Shape]]): + | ^^^^^^^^^^^^^ UP044 +7 | pass + | + = help: Convert to `*` for unpacking + +ℹ Unsafe fix +3 3 | Shape = TypeVarTuple("Shape") +4 4 | +5 5 | +6 |-class C(Generic[Unpack[Shape]]): + 6 |+class C(Generic[*Shape]): +7 7 | pass +8 8 | +9 9 | + +UP044.py:10:17: UP044 [*] Use `*` for unpacking + | +10 | class D(Generic[Unpack[Shape]]): + | ^^^^^^^^^^^^^ UP044 +11 | pass + | + = help: Convert to `*` for unpacking + +ℹ Unsafe fix +7 7 | pass +8 8 | +9 9 | +10 |-class D(Generic[Unpack[Shape]]): + 10 |+class D(Generic[*Shape]): +11 11 | pass +12 12 | +13 13 | + +UP044.py:14:14: UP044 [*] Use `*` for unpacking + | +14 | def f(*args: Unpack[tuple[int, ...]]): + | ^^^^^^^^^^^^^^^^^^^^^^^ UP044 +15 | pass + | + = help: Convert to `*` for unpacking + +ℹ Unsafe fix +11 11 | pass +12 12 | +13 13 | +14 |-def f(*args: Unpack[tuple[int, ...]]): + 14 |+def f(*args: *tuple[int, ...]): +15 15 | pass +16 16 | +17 17 | + +UP044.py:18:14: UP044 [*] Use `*` for unpacking + | +18 | def f(*args: Unpack[other.Type]): + | ^^^^^^^^^^^^^^^^^^ UP044 +19 | pass + | + = help: Convert to `*` for unpacking + +ℹ Unsafe fix +15 15 | pass +16 16 | +17 17 | +18 |-def f(*args: Unpack[other.Type]): + 18 |+def f(*args: *other.Type): +19 19 | pass +20 20 | +21 21 | + +UP044.py:22:27: UP044 [*] Use `*` for unpacking + | +22 | def f(*args: Generic[int, Unpack[int]]): + | ^^^^^^^^^^^ UP044 +23 | pass + | + = help: Convert to `*` for unpacking + +ℹ Unsafe fix +19 19 | pass +20 20 | +21 21 | +22 |-def f(*args: Generic[int, Unpack[int]]): + 22 |+def f(*args: Generic[int, *int]): +23 23 | pass +24 24 | +25 25 | diff --git a/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__up007_preview.snap b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__up007_preview.snap new file mode 100644 index 0000000000000..c996a51d3844d --- /dev/null +++ b/crates/ruff_linter/src/rules/pyupgrade/snapshots/ruff_linter__rules__pyupgrade__tests__up007_preview.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/pyupgrade/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/refurb/helpers.rs b/crates/ruff_linter/src/rules/refurb/helpers.rs index ff07354ddebd6..54ca98a586e2f 100644 --- a/crates/ruff_linter/src/rules/refurb/helpers.rs +++ b/crates/ruff_linter/src/rules/refurb/helpers.rs @@ -1,10 +1,12 @@ +use ruff_diagnostics::{Applicability, Edit, Fix}; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr}; use ruff_python_codegen::Generator; use ruff_python_semantic::{BindingId, ResolvedReference, SemanticModel}; use ruff_text_size::{Ranged, TextRange}; -use crate::settings::types::PythonVersion; +use crate::checkers::ast::Checker; +use ruff_python_ast::PythonVersion; /// Format a code snippet to call `name.method()`. pub(super) fn generate_method_call(name: Name, method: &str, generator: Generator) -> String { @@ -39,31 +41,45 @@ pub(super) fn generate_method_call(name: Name, method: &str, generator: Generato generator.stmt(&stmt.into()) } -/// Format a code snippet comparing `name` to `None` (e.g., `name is None`). -pub(super) fn generate_none_identity_comparison( - name: Name, +/// Returns a fix that replace `range` with +/// a generated `a is None`/`a is not None` check. +pub(super) fn replace_with_identity_check( + left: &Expr, + range: TextRange, negate: bool, - generator: Generator, -) -> String { - // Construct `name`. - let var = ast::ExprName { - id: name, - ctx: ast::ExprContext::Load, - range: TextRange::default(), - }; - // Construct `name is None` or `name is not None`. + checker: &Checker, +) -> Fix { + let (semantic, generator) = (checker.semantic(), checker.generator()); + let op = if negate { ast::CmpOp::IsNot } else { ast::CmpOp::Is }; - let compare = ast::ExprCompare { - left: Box::new(var.into()), - ops: Box::from([op]), - comparators: Box::from([ast::Expr::NoneLiteral(ast::ExprNoneLiteral::default())]), + + let new_expr = Expr::Compare(ast::ExprCompare { + left: left.clone().into(), + ops: [op].into(), + comparators: [ast::ExprNoneLiteral::default().into()].into(), range: TextRange::default(), + }); + + let new_content = generator.expr(&new_expr); + let new_content = if semantic.current_expression_parent().is_some() { + format!("({new_content})") + } else { + new_content }; - generator.expr(&compare.into()) + + let applicability = if checker.comment_ranges().intersects(range) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + let edit = Edit::range_replacement(new_content, range); + + Fix::applicable_edit(edit, applicability) } // Helpers for read-whole-file and write-whole-file @@ -106,7 +122,7 @@ pub(super) struct FileOpen<'a> { pub(super) reference: &'a ResolvedReference, } -impl<'a> FileOpen<'a> { +impl FileOpen<'_> { /// Determine whether an expression is a reference to the file handle, by comparing /// their ranges. If two expressions have the same range, they must be the same expression. pub(super) fn is_ref(&self, expr: &Expr) -> bool { @@ -244,7 +260,7 @@ fn match_open_keywords( if read_mode { // newline is only valid for write_text return None; - } else if target_version < PythonVersion::Py310 { + } else if target_version < PythonVersion::PY310 { // `pathlib` doesn't support `newline` until Python 3.10. return None; } @@ -267,18 +283,16 @@ fn match_open_keywords( // All other keywords cannot be directly forwarded. _ => return None, - }; + } } Some((result, mode)) } /// Match open mode to see if it is supported. fn match_open_mode(mode: &Expr) -> Option<OpenMode> { - let ast::ExprStringLiteral { value, .. } = mode.as_string_literal_expr()?; - if value.is_implicit_concatenated() { - return None; - } - match value.to_str() { + let mode = mode.as_string_literal_expr()?.as_single_part_string()?; + + match &*mode.value { "r" => Some(OpenMode::ReadText), "rb" => Some(OpenMode::ReadBytes), "w" => Some(OpenMode::WriteText), diff --git a/crates/ruff_linter/src/rules/refurb/mod.rs b/crates/ruff_linter/src/rules/refurb/mod.rs index 640773c3e72fb..d841bcafe1cb7 100644 --- a/crates/ruff_linter/src/rules/refurb/mod.rs +++ b/crates/ruff_linter/src/rules/refurb/mod.rs @@ -8,10 +8,10 @@ mod tests { use std::path::Path; use anyhow::Result; + use ruff_python_ast::PythonVersion; use test_case::test_case; use crate::registry::Rule; - use crate::settings::types::PythonVersion; use crate::test::test_path; use crate::{assert_messages, settings}; @@ -19,6 +19,7 @@ mod tests { #[test_case(Rule::RepeatedAppend, Path::new("FURB113.py"))] #[test_case(Rule::IfExpInsteadOfOrOperator, Path::new("FURB110.py"))] #[test_case(Rule::ReimplementedOperator, Path::new("FURB118.py"))] + #[test_case(Rule::ForLoopWrites, Path::new("FURB122.py"))] #[test_case(Rule::ReadlinesInFor, Path::new("FURB129.py"))] #[test_case(Rule::DeleteFullSlice, Path::new("FURB131.py"))] #[test_case(Rule::CheckAndRemoveFromSet, Path::new("FURB132.py"))] @@ -48,6 +49,8 @@ mod tests { #[test_case(Rule::FStringNumberFormat, Path::new("FURB116.py"))] #[test_case(Rule::SortedMinMax, Path::new("FURB192.py"))] #[test_case(Rule::SliceToRemovePrefixOrSuffix, Path::new("FURB188.py"))] + #[test_case(Rule::SubclassBuiltin, Path::new("FURB189.py"))] + #[test_case(Rule::FromisoformatReplaceZ, Path::new("FURB162.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -58,12 +61,41 @@ mod tests { Ok(()) } + #[test_case(Rule::ReadlinesInFor, Path::new("FURB129.py"))] + fn preview(rule_code: Rule, path: &Path) -> Result<()> { + let snapshot = format!( + "preview__{}_{}", + rule_code.noqa_code(), + path.to_string_lossy() + ); + let diagnostics = test_path( + Path::new("refurb").join(path).as_path(), + &settings::LinterSettings { + preview: settings::types::PreviewMode::Enabled, + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } + #[test] fn write_whole_file_python_39() -> Result<()> { let diagnostics = test_path( Path::new("refurb/FURB103.py"), &settings::LinterSettings::for_rule(Rule::WriteWholeFile) - .with_target_version(PythonVersion::Py39), + .with_target_version(PythonVersion::PY39), + )?; + assert_messages!(diagnostics); + Ok(()) + } + + #[test] + fn fstring_number_format_python_311() -> Result<()> { + let diagnostics = test_path( + Path::new("refurb/FURB116.py"), + &settings::LinterSettings::for_rule(Rule::FStringNumberFormat) + .with_target_version(PythonVersion::PY311), )?; assert_messages!(diagnostics); Ok(()) diff --git a/crates/ruff_linter/src/rules/refurb/rules/bit_count.rs b/crates/ruff_linter/src/rules/refurb/rules/bit_count.rs index 35f85b3c56077..04a112ab8930e 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/bit_count.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/bit_count.rs @@ -1,10 +1,12 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::PythonVersion; use ruff_python_ast::{self as ast, Expr, ExprAttribute, ExprCall}; +use ruff_python_semantic::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; use ruff_text_size::Ranged; +use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; -use crate::{checkers::ast::Checker, settings::types::PythonVersion}; /// ## What it does /// Checks for uses of `bin(...).count("1")` to perform a population count. @@ -26,13 +28,18 @@ use crate::{checkers::ast::Checker, settings::types::PythonVersion}; /// y = 0b1111011.bit_count() /// ``` /// +/// ## Fix safety +/// This rule's fix is marked as unsafe unless the argument to `bin` can be inferred as +/// an instance of a type that implements the `__index__` and `bit_count` methods because this can +/// change the exception raised at runtime for an invalid argument. +/// /// ## Options /// - `target-version` /// /// ## References /// - [Python documentation:`int.bit_count`](https://docs.python.org/3/library/stdtypes.html#int.bit_count) -#[violation] -pub struct BitCount { +#[derive(ViolationMetadata)] +pub(crate) struct BitCount { existing: SourceCodeSnippet, replacement: SourceCodeSnippet, } @@ -50,15 +57,15 @@ impl AlwaysFixableViolation for BitCount { if let Some(replacement) = replacement.full_display() { format!("Replace with `{replacement}`") } else { - format!("Replace with `.bit_count()`") + "Replace with `.bit_count()`".to_string() } } } /// FURB161 -pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn bit_count(checker: &Checker, call: &ExprCall) { // `int.bit_count()` was added in Python 3.10 - if checker.settings.target_version < PythonVersion::Py310 { + if checker.target_version() < PythonVersion::PY310 { return; } @@ -73,7 +80,7 @@ pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { if !call.arguments.keywords.is_empty() { return; - }; + } let [arg] = &*call.arguments.args else { return; }; @@ -99,7 +106,7 @@ pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { if !arguments.keywords.is_empty() { return; - }; + } let [arg] = &*arguments.args else { return; }; @@ -109,6 +116,10 @@ pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { return; } + // If is a starred expression, it returns. + if arg.is_starred_expr() { + return; + } // Extract, e.g., `x` in `bin(x)`. let literal_text = checker.locator().slice(arg); @@ -158,6 +169,14 @@ pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { | Expr::Subscript(_) => false, }; + // check if the fix is safe or not + let applicability: Applicability = match ResolvedPythonType::from(arg) { + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer | NumberLike::Bool)) => { + Applicability::Safe + } + _ => Applicability::Unsafe, + }; + let replacement = if parenthesize { format!("({literal_text}).bit_count()") } else { @@ -171,11 +190,10 @@ pub(crate) fn bit_count(checker: &mut Checker, call: &ExprCall) { }, call.range(), ); + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement(replacement, call.range()), + applicability, + )); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - replacement, - call.range(), - ))); - - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/check_and_remove_from_set.rs b/crates/ruff_linter/src/rules/refurb/rules/check_and_remove_from_set.rs index ffa8761b4a6d9..bb2c1bb5b9304 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/check_and_remove_from_set.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/check_and_remove_from_set.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::{self as ast, CmpOp, Expr, Stmt}; @@ -39,8 +39,8 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// ## References /// - [Python documentation: `set.discard()`](https://docs.python.org/3/library/stdtypes.html?highlight=list#frozenset.discard) -#[violation] -pub struct CheckAndRemoveFromSet { +#[derive(ViolationMetadata)] +pub(crate) struct CheckAndRemoveFromSet { element: SourceCodeSnippet, set: String, } @@ -67,7 +67,7 @@ impl AlwaysFixableViolation for CheckAndRemoveFromSet { } /// FURB132 -pub(crate) fn check_and_remove_from_set(checker: &mut Checker, if_stmt: &ast::StmtIf) { +pub(crate) fn check_and_remove_from_set(checker: &Checker, if_stmt: &ast::StmtIf) { // In order to fit the profile, we need if without else clauses and with only one statement in its body. if if_stmt.body.len() != 1 || !if_stmt.elif_else_clauses.is_empty() { return; @@ -102,7 +102,7 @@ pub(crate) fn check_and_remove_from_set(checker: &mut Checker, if_stmt: &ast::St .is_some_and(|binding| is_set(binding, checker.semantic())) { return; - }; + } let mut diagnostic = Diagnostic::new( CheckAndRemoveFromSet { @@ -116,7 +116,7 @@ pub(crate) fn check_and_remove_from_set(checker: &mut Checker, if_stmt: &ast::St if_stmt.start(), if_stmt.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } fn compare(lhs: &ComparableExpr, rhs: &ComparableExpr) -> bool { @@ -161,7 +161,7 @@ fn match_remove(if_stmt: &ast::StmtIf) -> Option<(&Expr, &ast::ExprName)> { .. } = attr.as_attribute_expr()?; - let Expr::Name(ref set @ ast::ExprName { .. }) = receiver.as_ref() else { + let Expr::Name(set @ ast::ExprName { .. }) = receiver.as_ref() else { return None; }; diff --git a/crates/ruff_linter/src/rules/refurb/rules/delete_full_slice.rs b/crates/ruff_linter/src/rules/refurb/rules/delete_full_slice.rs index 21c21f282192f..fca68546a2160 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/delete_full_slice.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/delete_full_slice.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::analyze::typing::{is_dict, is_list}; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing::{is_dict, is_list}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -43,15 +43,15 @@ use crate::rules::refurb::helpers::generate_method_call; /// ## References /// - [Python documentation: Mutable Sequence Types](https://docs.python.org/3/library/stdtypes.html?highlight=list#mutable-sequence-types) /// - [Python documentation: `dict.clear()`](https://docs.python.org/3/library/stdtypes.html?highlight=list#dict.clear) -#[violation] -pub struct DeleteFullSlice; +#[derive(ViolationMetadata)] +pub(crate) struct DeleteFullSlice; impl Violation for DeleteFullSlice { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `clear` over deleting a full slice") + "Prefer `clear` over deleting a full slice".to_string() } fn fix_title(&self) -> Option<String> { @@ -60,7 +60,7 @@ impl Violation for DeleteFullSlice { } /// FURB131 -pub(crate) fn delete_full_slice(checker: &mut Checker, delete: &ast::StmtDelete) { +pub(crate) fn delete_full_slice(checker: &Checker, delete: &ast::StmtDelete) { for target in &delete.targets { let Some(name) = match_full_slice(target, checker.semantic()) else { continue; @@ -78,7 +78,7 @@ pub(crate) fn delete_full_slice(checker: &mut Checker, delete: &ast::StmtDelete) ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/for_loop_set_mutations.rs b/crates/ruff_linter/src/rules/refurb/rules/for_loop_set_mutations.rs index b019c6bd3c6a5..2a32c4240ee2a 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/for_loop_set_mutations.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/for_loop_set_mutations.rs @@ -1,10 +1,12 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, Stmt, StmtFor}; use ruff_python_semantic::analyze::typing; use crate::checkers::ast::Checker; +use super::helpers::parenthesize_loop_iter_if_necessary; + /// ## What it does /// Checks for code that updates a set with the contents of an iterable by /// using a `for` loop to call `.add()` or `.discard()` on each element @@ -34,10 +36,14 @@ use crate::checkers::ast::Checker; /// s.difference_update((1, 2, 3)) /// ``` /// +/// ## Fix safety +/// The fix will be marked as unsafe if applying the fix would delete any comments. +/// Otherwise, it is marked as safe. +/// /// ## References /// - [Python documentation: `set`](https://docs.python.org/3/library/stdtypes.html#set) -#[violation] -pub struct ForLoopSetMutations { +#[derive(ViolationMetadata)] +pub(crate) struct ForLoopSetMutations { method_name: &'static str, batch_method_name: &'static str, } @@ -53,8 +59,8 @@ impl AlwaysFixableViolation for ForLoopSetMutations { } } -// FURB142 -pub(crate) fn for_loop_set_mutations(checker: &mut Checker, for_stmt: &StmtFor) { +/// FURB142 +pub(crate) fn for_loop_set_mutations(checker: &Checker, for_stmt: &StmtFor) { if !for_stmt.orelse.is_empty() { return; } @@ -94,34 +100,41 @@ pub(crate) fn for_loop_set_mutations(checker: &mut Checker, for_stmt: &StmtFor) return; }; + let locator = checker.locator(); let content = match (for_stmt.target.as_ref(), arg) { (Expr::Name(for_target), Expr::Name(arg)) if for_target.id == arg.id => { format!( "{}.{batch_method_name}({})", set.id, - checker.locator().slice(for_stmt.iter.as_ref()) + parenthesize_loop_iter_if_necessary(for_stmt, checker), ) } (for_target, arg) => format!( "{}.{batch_method_name}({} for {} in {})", set.id, - checker.locator().slice(arg), - checker.locator().slice(for_target), - checker.locator().slice(for_stmt.iter.as_ref()) + locator.slice(arg), + locator.slice(for_target), + parenthesize_loop_iter_if_necessary(for_stmt, checker), ), }; - checker.diagnostics.push( - Diagnostic::new( - ForLoopSetMutations { - method_name, - batch_method_name, - }, - for_stmt.range, - ) - .with_fix(Fix::safe_edit(Edit::range_replacement( - content, - for_stmt.range, - ))), + let applicability = if checker.comment_ranges().intersects(for_stmt.range) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + let fix = Fix::applicable_edit( + Edit::range_replacement(content, for_stmt.range), + applicability, + ); + + let diagnostic = Diagnostic::new( + ForLoopSetMutations { + method_name, + batch_method_name, + }, + for_stmt.range, ); + + checker.report_diagnostic(diagnostic.with_fix(fix)); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/for_loop_writes.rs b/crates/ruff_linter/src/rules/refurb/rules/for_loop_writes.rs new file mode 100644 index 0000000000000..991d5e29bc31c --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/rules/for_loop_writes.rs @@ -0,0 +1,248 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprList, ExprName, ExprTuple, Stmt, StmtFor}; +use ruff_python_semantic::analyze::typing; +use ruff_python_semantic::{Binding, ScopeId, SemanticModel, TypingOnlyBindingsStatus}; +use ruff_text_size::{Ranged, TextRange, TextSize}; + +use crate::checkers::ast::Checker; + +use super::helpers::parenthesize_loop_iter_if_necessary; + +/// ## What it does +/// Checks for the use of `IOBase.write` in a for loop. +/// +/// ## Why is this bad? +/// When writing a batch of elements, it's more idiomatic to use a single method call to +/// `IOBase.writelines`, rather than write elements one by one. +/// +/// ## Example +/// ```python +/// with Path("file").open("w") as f: +/// for line in lines: +/// f.write(line) +/// +/// with Path("file").open("wb") as f: +/// for line in lines: +/// f.write(line.encode()) +/// ``` +/// +/// Use instead: +/// ```python +/// with Path("file").open("w") as f: +/// f.writelines(lines) +/// +/// with Path("file").open("wb") as f: +/// f.writelines(line.encode() for line in lines) +/// ``` +/// +/// ## References +/// - [Python documentation: `io.IOBase.writelines`](https://docs.python.org/3/library/io.html#io.IOBase.writelines) +#[derive(ViolationMetadata)] +pub(crate) struct ForLoopWrites { + name: String, +} + +impl AlwaysFixableViolation for ForLoopWrites { + #[derive_message_formats] + fn message(&self) -> String { + format!("Use of `{}.write` in a for loop", self.name) + } + + fn fix_title(&self) -> String { + format!("Replace with `{}.writelines`", self.name) + } +} + +/// FURB122 +pub(crate) fn for_loop_writes_binding(checker: &Checker, binding: &Binding) -> Option<Diagnostic> { + if !binding.kind.is_loop_var() { + return None; + } + + let semantic = checker.semantic(); + + let for_stmt = binding.statement(semantic)?.as_for_stmt()?; + + if for_stmt.is_async { + return None; + } + + let binding_names = binding_names(&for_stmt.target); + + if !binding_names.first()?.range().contains_range(binding.range) { + return None; + } + + for_loop_writes(checker, for_stmt, binding.scope, &binding_names) +} + +/// FURB122 +pub(crate) fn for_loop_writes_stmt(checker: &Checker, for_stmt: &StmtFor) { + // Loops with bindings are handled later. + if !binding_names(&for_stmt.target).is_empty() { + return; + } + + let scope_id = checker.semantic().scope_id; + + if let Some(diagnostic) = for_loop_writes(checker, for_stmt, scope_id, &[]) { + checker.report_diagnostic(diagnostic); + } +} + +/// Find the names in a `for` loop target +/// that are assigned to during iteration. +/// +/// ```python +/// for ((), [(a,), [[b]]], c.d, e[f], *[*g]) in h: +/// # ^ ^ ^ +/// ... +/// ``` +fn binding_names(for_target: &Expr) -> Vec<&ExprName> { + fn collect_names<'a>(expr: &'a Expr, names: &mut Vec<&'a ExprName>) { + match expr { + Expr::Name(name) => names.push(name), + + Expr::Starred(starred) => collect_names(&starred.value, names), + + Expr::List(ExprList { elts, .. }) | Expr::Tuple(ExprTuple { elts, .. }) => elts + .iter() + .for_each(|element| collect_names(element, names)), + + _ => {} + } + } + + let mut names = vec![]; + collect_names(for_target, &mut names); + names +} + +/// FURB122 +fn for_loop_writes( + checker: &Checker, + for_stmt: &StmtFor, + scope_id: ScopeId, + binding_names: &[&ExprName], +) -> Option<Diagnostic> { + if !for_stmt.orelse.is_empty() { + return None; + } + let [Stmt::Expr(stmt_expr)] = for_stmt.body.as_slice() else { + return None; + }; + + let call_expr = stmt_expr.value.as_call_expr()?; + let expr_attr = call_expr.func.as_attribute_expr()?; + + if &expr_attr.attr != "write" { + return None; + } + + if !call_expr.arguments.keywords.is_empty() { + return None; + } + let [write_arg] = call_expr.arguments.args.as_ref() else { + return None; + }; + + let io_object_name = expr_attr.value.as_name_expr()?; + + let semantic = checker.semantic(); + + // Determine whether `f` in `f.write()` was bound to a file object. + let binding = semantic.binding(semantic.resolve_name(io_object_name)?); + if !typing::is_io_base(binding, semantic) { + return None; + } + + if loop_variables_are_used_outside_loop(binding_names, for_stmt.range, semantic, scope_id) { + return None; + } + + let locator = checker.locator(); + let content = match (for_stmt.target.as_ref(), write_arg) { + (Expr::Name(for_target), Expr::Name(write_arg)) if for_target.id == write_arg.id => { + format!( + "{}.writelines({})", + locator.slice(io_object_name), + parenthesize_loop_iter_if_necessary(for_stmt, checker), + ) + } + (for_target, write_arg) => { + format!( + "{}.writelines({} for {} in {})", + locator.slice(io_object_name), + locator.slice(write_arg), + locator.slice(for_target), + parenthesize_loop_iter_if_necessary(for_stmt, checker), + ) + } + }; + + let applicability = if checker.comment_ranges().intersects(for_stmt.range) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + let fix = Fix::applicable_edit( + Edit::range_replacement(content, for_stmt.range), + applicability, + ); + + let diagnostic = Diagnostic::new( + ForLoopWrites { + name: io_object_name.id.to_string(), + }, + for_stmt.range, + ); + + Some(diagnostic.with_fix(fix)) +} + +fn loop_variables_are_used_outside_loop( + binding_names: &[&ExprName], + loop_range: TextRange, + semantic: &SemanticModel, + scope_id: ScopeId, +) -> bool { + let find_binding_id = |name: &ExprName, offset: TextSize| { + semantic.simulate_runtime_load_at_location_in_scope( + name.id.as_str(), + TextRange::at(offset, 0.into()), + scope_id, + TypingOnlyBindingsStatus::Disallowed, + ) + }; + + // If the load simulation succeeds at the position right before the loop, + // that binding is shadowed. + // ```python + // a = 1 + // for a in b: ... + // # ^ Load here + // ``` + let name_overwrites_outer = + |name: &ExprName| find_binding_id(name, loop_range.start()).is_some(); + + let name_is_used_later = |name: &ExprName| { + let Some(binding_id) = find_binding_id(name, loop_range.end()) else { + return false; + }; + + for reference_id in semantic.binding(binding_id).references() { + let reference = semantic.reference(reference_id); + + if !loop_range.contains_range(reference.range()) { + return true; + } + } + + false + }; + + binding_names + .iter() + .any(|name| name_overwrites_outer(name) || name_is_used_later(name)) +} diff --git a/crates/ruff_linter/src/rules/refurb/rules/fromisoformat_replace_z.rs b/crates/ruff_linter/src/rules/refurb/rules/fromisoformat_replace_z.rs new file mode 100644 index 0000000000000..6ff1f6caefd25 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/rules/fromisoformat_replace_z.rs @@ -0,0 +1,281 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_ast::{ + Expr, ExprAttribute, ExprBinOp, ExprCall, ExprStringLiteral, ExprSubscript, ExprUnaryOp, + Number, Operator, PythonVersion, UnaryOp, +}; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for `datetime.fromisoformat()` calls +/// where the only argument is an inline replacement +/// of `Z` with a zero offset timezone. +/// +/// ## Why is this bad? +/// On Python 3.11 and later, `datetime.fromisoformat()` can handle most [ISO 8601][iso-8601] +/// formats including ones affixed with `Z`, so such an operation is unnecessary. +/// +/// More information on unsupported formats +/// can be found in [the official documentation][fromisoformat]. +/// +/// ## Example +/// +/// ```python +/// from datetime import datetime +/// +/// +/// date = "2025-01-01T00:00:00Z" +/// +/// datetime.fromisoformat(date.replace("Z", "+00:00")) +/// datetime.fromisoformat(date[:-1] + "-00") +/// datetime.fromisoformat(date.strip("Z", "-0000")) +/// datetime.fromisoformat(date.rstrip("Z", "-00:00")) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// from datetime import datetime +/// +/// +/// date = "2025-01-01T00:00:00Z" +/// +/// datetime.fromisoformat(date) +/// ``` +/// +/// ## Fix safety +/// The fix is always marked as unsafe, +/// as it might change the program's behaviour. +/// +/// For example, working code might become non-working: +/// +/// ```python +/// d = "Z2025-01-01T00:00:00Z" # Note the leading `Z` +/// +/// datetime.fromisoformat(d.strip("Z") + "+00:00") # Fine +/// datetime.fromisoformat(d) # Runtime error +/// ``` +/// +/// ## References +/// * [What’s New In Python 3.11 § `datetime`](https://docs.python.org/3/whatsnew/3.11.html#datetime) +/// * [`fromisoformat`](https://docs.python.org/3/library/datetime.html#datetime.date.fromisoformat) +/// +/// [iso-8601]: https://www.iso.org/obp/ui/#iso:std:iso:8601 +/// [fromisoformat]: https://docs.python.org/3/library/datetime.html#datetime.date.fromisoformat +#[derive(ViolationMetadata)] +pub(crate) struct FromisoformatReplaceZ; + +impl AlwaysFixableViolation for FromisoformatReplaceZ { + #[derive_message_formats] + fn message(&self) -> String { + r#"Unnecessary timezone replacement with zero offset"#.to_string() + } + + fn fix_title(&self) -> String { + "Remove `.replace()` call".to_string() + } +} + +/// FURB162 +pub(crate) fn fromisoformat_replace_z(checker: &Checker, call: &ExprCall) { + if checker.target_version() < PythonVersion::PY311 { + return; + } + + let (func, arguments) = (&*call.func, &call.arguments); + + if !arguments.keywords.is_empty() { + return; + } + + let [argument] = &*arguments.args else { + return; + }; + + if !func_is_fromisoformat(func, checker.semantic()) { + return; + } + + let Some(replace_time_zone) = ReplaceTimeZone::from_expr(argument) else { + return; + }; + + if !is_zero_offset_timezone(replace_time_zone.zero_offset.value.to_str()) { + return; + } + + let value_full_range = parenthesized_range( + replace_time_zone.date.into(), + replace_time_zone.parent.into(), + checker.comment_ranges(), + checker.source(), + ) + .unwrap_or(replace_time_zone.date.range()); + + let range_to_remove = TextRange::new(value_full_range.end(), argument.end()); + + let diagnostic = Diagnostic::new(FromisoformatReplaceZ, argument.range()); + let fix = Fix::unsafe_edit(Edit::range_deletion(range_to_remove)); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +fn func_is_fromisoformat(func: &Expr, semantic: &SemanticModel) -> bool { + semantic + .resolve_qualified_name(func) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["datetime", "datetime", "fromisoformat"] + ) + }) +} + +/// A `datetime.replace` call that replaces the timezone with a zero offset. +struct ReplaceTimeZone<'a> { + /// The date expression + date: &'a Expr, + /// The `date` expression's parent. + parent: &'a Expr, + /// The zero offset string literal + zero_offset: &'a ExprStringLiteral, +} + +impl<'a> ReplaceTimeZone<'a> { + fn from_expr(expr: &'a Expr) -> Option<Self> { + match expr { + Expr::Call(call) => Self::from_call(call), + Expr::BinOp(bin_op) => Self::from_bin_op(bin_op), + _ => None, + } + } + + /// Returns `Some` if the call expression is a call to `str.replace` and matches `date.replace("Z", "+00:00")` + fn from_call(call: &'a ExprCall) -> Option<Self> { + let arguments = &call.arguments; + + if !arguments.keywords.is_empty() { + return None; + } + + let ExprAttribute { value, attr, .. } = call.func.as_attribute_expr()?; + + if attr != "replace" { + return None; + } + + let [z, Expr::StringLiteral(zero_offset)] = &*arguments.args else { + return None; + }; + + if !is_upper_case_z_string(z) { + return None; + } + + Some(Self { + date: &**value, + parent: &*call.func, + zero_offset, + }) + } + + /// Returns `Some` for binary expressions matching `date[:-1] + "-00"` or + /// `date.strip("Z") + "+00"` + fn from_bin_op(bin_op: &'a ExprBinOp) -> Option<Self> { + let ExprBinOp { + left, op, right, .. + } = bin_op; + + if *op != Operator::Add { + return None; + } + + let (date, parent) = match &**left { + Expr::Call(call) => strip_z_date(call)?, + Expr::Subscript(subscript) => (slice_minus_1_date(subscript)?, &**left), + _ => return None, + }; + + Some(Self { + date, + parent, + zero_offset: right.as_string_literal_expr()?, + }) + } +} + +/// Returns `Some` if `call` is a call to `date.strip("Z")`. +/// +/// It returns the value of the `date` argument and its parent. +fn strip_z_date(call: &ExprCall) -> Option<(&Expr, &Expr)> { + let ExprCall { + func, arguments, .. + } = call; + + let Expr::Attribute(ExprAttribute { value, attr, .. }) = &**func else { + return None; + }; + + if !matches!(attr.as_str(), "strip" | "rstrip") { + return None; + } + + if !arguments.keywords.is_empty() { + return None; + } + + let [z] = &*arguments.args else { + return None; + }; + + if !is_upper_case_z_string(z) { + return None; + } + + Some((value, func)) +} + +/// Returns `Some` if this is a subscript with the form `date[:-1] + "-00"`. +fn slice_minus_1_date(subscript: &ExprSubscript) -> Option<&Expr> { + let ExprSubscript { value, slice, .. } = subscript; + let slice = slice.as_slice_expr()?; + + if slice.lower.is_some() || slice.step.is_some() { + return None; + } + + let Some(ExprUnaryOp { + operand, + op: UnaryOp::USub, + .. + }) = slice.upper.as_ref()?.as_unary_op_expr() + else { + return None; + }; + + let Number::Int(int) = &operand.as_number_literal_expr()?.value else { + return None; + }; + + if *int != 1 { + return None; + } + + Some(value) +} + +fn is_upper_case_z_string(expr: &Expr) -> bool { + expr.as_string_literal_expr() + .is_some_and(|string| string.value.to_str() == "Z") +} + +fn is_zero_offset_timezone(value: &str) -> bool { + matches!( + value, + "+00:00" | "+0000" | "+00" | "-00:00" | "-0000" | "-00" + ) +} diff --git a/crates/ruff_linter/src/rules/refurb/rules/fstring_number_format.rs b/crates/ruff_linter/src/rules/refurb/rules/fstring_number_format.rs index 11f057396905d..42d12254f34cd 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/fstring_number_format.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/fstring_number_format.rs @@ -1,6 +1,7 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, ExprCall}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, ExprCall, Number, PythonVersion, UnaryOp}; +use ruff_source_file::find_newline; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -24,8 +25,13 @@ use crate::fix::snippet::SourceCodeSnippet; /// ```python /// print(f"{1337:b}") /// ``` -#[violation] -pub struct FStringNumberFormat { +/// +/// ## Fix safety +/// The fix is only marked as safe for integer literals, all other cases +/// are display-only, as they may change the runtime behaviour of the program +/// or introduce syntax errors. +#[derive(ViolationMetadata)] +pub(crate) struct FStringNumberFormat { replacement: Option<SourceCodeSnippet>, base: Base, } @@ -49,20 +55,20 @@ impl Violation for FStringNumberFormat { } fn fix_title(&self) -> Option<String> { - let FStringNumberFormat { replacement, .. } = self; - if let Some(display) = replacement + if let Some(display) = self + .replacement .as_ref() .and_then(SourceCodeSnippet::full_display) { Some(format!("Replace with `{display}`")) } else { - Some(format!("Replace with f-string")) + Some("Replace with f-string".to_string()) } } } /// FURB116 -pub(crate) fn fstring_number_format(checker: &mut Checker, subscript: &ast::ExprSubscript) { +pub(crate) fn fstring_number_format(checker: &Checker, subscript: &ast::ExprSubscript) { // The slice must be exactly `[2:]`. let Expr::Slice(ast::ExprSlice { lower: Some(lower), @@ -110,21 +116,35 @@ pub(crate) fn fstring_number_format(checker: &mut Checker, subscript: &ast::Expr return; }; - // Generate a replacement, if possible. - let replacement = if matches!( + // float and complex numbers are false positives, ignore them. + if matches!( arg, - Expr::NumberLiteral(_) | Expr::Name(_) | Expr::Attribute(_) + Expr::NumberLiteral(ast::ExprNumberLiteral { + value: Number::Float(_) | Number::Complex { .. }, + .. + }) ) { - let inner_source = checker.locator().slice(arg); + return; + } - let quote = checker.stylist().quote(); - let shorthand = base.shorthand(); + let maybe_number = if let Some(maybe_number) = arg + .as_unary_op_expr() + .filter(|unary_expr| unary_expr.op == UnaryOp::UAdd) + .map(|unary_expr| &unary_expr.operand) + { + maybe_number + } else { + arg + }; - Some(format!("f{quote}{{{inner_source}:{shorthand}}}{quote}")) + let applicability = if matches!(maybe_number, Expr::NumberLiteral(_)) { + Applicability::Safe } else { - None + Applicability::DisplayOnly }; + let replacement = try_create_replacement(checker, arg, base); + let mut diagnostic = Diagnostic::new( FStringNumberFormat { replacement: replacement.as_deref().map(SourceCodeSnippet::from_str), @@ -134,13 +154,52 @@ pub(crate) fn fstring_number_format(checker: &mut Checker, subscript: &ast::Expr ); if let Some(replacement) = replacement { - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - replacement, - subscript.range(), - ))); + let edit = Edit::range_replacement(replacement, subscript.range()); + diagnostic.set_fix(Fix::applicable_edit(edit, applicability)); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); +} + +/// Generate a replacement, if possible. +fn try_create_replacement(checker: &Checker, arg: &Expr, base: Base) -> Option<String> { + if !matches!( + arg, + Expr::NumberLiteral(_) | Expr::Name(_) | Expr::Attribute(_) | Expr::UnaryOp(_) + ) { + return None; + } + + let inner_source = checker.locator().slice(arg); + + // On Python 3.11 and earlier, trying to replace an `arg` that contains a backslash + // would create a `SyntaxError` in the f-string. + if checker.target_version() <= PythonVersion::PY311 && inner_source.contains('\\') { + return None; + } + + // On Python 3.11 and earlier, trying to replace an `arg` that spans multiple lines + // would create a `SyntaxError` in the f-string. + if checker.target_version() <= PythonVersion::PY311 && find_newline(inner_source).is_some() { + return None; + } + + let quote = checker.stylist().quote(); + let shorthand = base.shorthand(); + + // If the `arg` contains double quotes we need to create the f-string with single quotes + // to avoid a `SyntaxError` in Python 3.11 and earlier. + if checker.target_version() <= PythonVersion::PY311 && inner_source.contains(quote.as_str()) { + return None; + } + + // If the `arg` contains a brace add an space before it to avoid a `SyntaxError` + // in the f-string. + if inner_source.starts_with('{') { + Some(format!("f{quote}{{ {inner_source}:{shorthand}}}{quote}")) + } else { + Some(format!("f{quote}{{{inner_source}:{shorthand}}}{quote}")) + } } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/refurb/rules/hardcoded_string_charset.rs b/crates/ruff_linter/src/rules/refurb/rules/hardcoded_string_charset.rs index 11db4cbccb129..38e95d0cb9f3b 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/hardcoded_string_charset.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/hardcoded_string_charset.rs @@ -1,8 +1,8 @@ use crate::checkers::ast::Checker; use crate::importer::ImportRequest; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{CmpOp, Expr, ExprCompare, ExprStringLiteral}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::ExprStringLiteral; use ruff_text_size::TextRange; /// ## What it does @@ -27,15 +27,15 @@ use ruff_text_size::TextRange; /// /// ## References /// - [Python documentation: String constants](https://docs.python.org/3/library/string.html#string-constants) -#[violation] -pub struct HardcodedStringCharset { +#[derive(ViolationMetadata)] +pub(crate) struct HardcodedStringCharset { name: &'static str, } impl AlwaysFixableViolation for HardcodedStringCharset { #[derive_message_formats] fn message(&self) -> String { - format!("Use of hardcoded string charset") + "Use of hardcoded string charset".to_string() } fn fix_title(&self) -> String { @@ -44,6 +44,19 @@ impl AlwaysFixableViolation for HardcodedStringCharset { } } +/// FURB156 +pub(crate) fn hardcoded_string_charset_literal(checker: &Checker, expr: &ExprStringLiteral) { + // if the string literal is a docstring, the rule is not applied + if checker.semantic().in_pep_257_docstring() { + return; + } + + if let Some(charset) = check_charset_exact(expr.value.to_str().as_bytes()) { + push_diagnostic(checker, expr.range, charset); + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq)] struct NamedCharset { name: &'static str, bytes: &'static [u8], @@ -51,7 +64,7 @@ struct NamedCharset { } /// Represents the set of ascii characters in form of a bitset. -#[derive(Copy, Clone, Eq, PartialEq)] +#[derive(Debug, Copy, Clone, Eq, PartialEq)] struct AsciiCharSet(u128); impl AsciiCharSet { @@ -108,21 +121,13 @@ const KNOWN_NAMED_CHARSETS: [NamedCharset; 9] = [ NamedCharset::new("whitespace", b" \t\n\r\x0b\x0c"), ]; -fn check_charset_as_set(bytes: &[u8]) -> Option<&NamedCharset> { - let ascii_char_set = AsciiCharSet::from_bytes(bytes)?; - - KNOWN_NAMED_CHARSETS - .iter() - .find(|&charset| charset.ascii_char_set == ascii_char_set) -} - fn check_charset_exact(bytes: &[u8]) -> Option<&NamedCharset> { KNOWN_NAMED_CHARSETS .iter() .find(|&charset| charset.bytes == bytes) } -fn push_diagnostic(checker: &mut Checker, range: TextRange, charset: &NamedCharset) { +fn push_diagnostic(checker: &Checker, range: TextRange, charset: &NamedCharset) { let name = charset.name; let mut diagnostic = Diagnostic::new(HardcodedStringCharset { name }, range); diagnostic.try_set_fix(|| { @@ -136,36 +141,5 @@ fn push_diagnostic(checker: &mut Checker, range: TextRange, charset: &NamedChars [edit], )) }); - checker.diagnostics.push(diagnostic); -} - -/// FURB156 -pub(crate) fn hardcoded_string_charset_comparison(checker: &mut Checker, compare: &ExprCompare) { - let ( - [CmpOp::In | CmpOp::NotIn], - [Expr::StringLiteral(string_literal @ ExprStringLiteral { value, .. })], - ) = (compare.ops.as_ref(), compare.comparators.as_ref()) - else { - return; - }; - - let bytes = value.to_str().as_bytes(); - - let Some(charset) = check_charset_as_set(bytes) else { - return; - }; - - // In this case the diagnostic will be emitted via string_literal check. - if charset.bytes == bytes { - return; - } - - push_diagnostic(checker, string_literal.range, charset); -} - -/// FURB156 -pub(crate) fn hardcoded_string_charset_literal(checker: &mut Checker, expr: &ExprStringLiteral) { - if let Some(charset) = check_charset_exact(expr.value.to_str().as_bytes()) { - push_diagnostic(checker, expr.range, charset); - } + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/hashlib_digest_hex.rs b/crates/ruff_linter/src/rules/refurb/rules/hashlib_digest_hex.rs index 6f210e60827c7..688799396d06a 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/hashlib_digest_hex.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/hashlib_digest_hex.rs @@ -1,6 +1,7 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprAttribute, ExprCall}; +use ruff_python_semantic::Modules; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -27,22 +28,17 @@ use crate::checkers::ast::Checker; /// hashed = sha512(b"some data").hexdigest() /// ``` /// -/// ## Fix safety -/// This rule's fix is marked as unsafe, as the target of the `.digest()` call -/// could be a user-defined class that implements a `.hex()` method, rather -/// than a hashlib hash object. -/// /// ## References /// - [Python documentation: `hashlib`](https://docs.python.org/3/library/hashlib.html) -#[violation] -pub struct HashlibDigestHex; +#[derive(ViolationMetadata)] +pub(crate) struct HashlibDigestHex; impl Violation for HashlibDigestHex { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use of hashlib's `.digest().hex()`") + "Use of hashlib's `.digest().hex()`".to_string() } fn fix_title(&self) -> Option<String> { @@ -51,7 +47,11 @@ impl Violation for HashlibDigestHex { } /// FURB181 -pub(crate) fn hashlib_digest_hex(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn hashlib_digest_hex(checker: &Checker, call: &ExprCall) { + if !checker.semantic().seen_module(Modules::HASHLIB) { + return; + } + if !call.arguments.is_empty() { return; } @@ -105,18 +105,17 @@ pub(crate) fn hashlib_digest_hex(checker: &mut Checker, call: &ExprCall) { | "sha3_512" | "shake_128" | "shake_256" - | "_Hash" ] ) }) { let mut diagnostic = Diagnostic::new(HashlibDigestHex, call.range()); if arguments.is_empty() { - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( ".hexdigest".to_string(), TextRange::new(value.end(), call.func.end()), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/helpers.rs b/crates/ruff_linter/src/rules/refurb/rules/helpers.rs new file mode 100644 index 0000000000000..8f66b92c46d78 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/rules/helpers.rs @@ -0,0 +1,40 @@ +use std::borrow::Cow; + +use ruff_python_ast::{self as ast, parenthesize::parenthesized_range}; + +use crate::checkers::ast::Checker; + +/// A helper function that extracts the `iter` from a [`ast::StmtFor`] node and, +/// if the `iter` is an unparenthesized tuple, adds parentheses: +/// +/// - `for x in z: ...` -> `"x"` +/// - `for (x, y) in z: ...` -> `"(x, y)"` +/// - `for [x, y] in z: ...` -> `"[x, y]"` +/// - `for x, y in z: ...` -> `"(x, y)"` # <-- Parentheses added only for this example +pub(super) fn parenthesize_loop_iter_if_necessary<'a>( + for_stmt: &'a ast::StmtFor, + checker: &'a Checker, +) -> Cow<'a, str> { + let locator = checker.locator(); + let iter = for_stmt.iter.as_ref(); + + let original_parenthesized_range = parenthesized_range( + iter.into(), + for_stmt.into(), + checker.comment_ranges(), + checker.source(), + ); + + if let Some(range) = original_parenthesized_range { + return Cow::Borrowed(locator.slice(range)); + } + + let iter_in_source = locator.slice(iter); + + match iter { + ast::Expr::Tuple(tuple) if !tuple.parenthesized => { + Cow::Owned(format!("({iter_in_source})")) + } + _ => Cow::Borrowed(iter_in_source), + } +} diff --git a/crates/ruff_linter/src/rules/refurb/rules/if_exp_instead_of_or_operator.rs b/crates/ruff_linter/src/rules/refurb/rules/if_exp_instead_of_or_operator.rs index 4b09aa6ebb3b8..bce08c481d536 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/if_exp_instead_of_or_operator.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/if_exp_instead_of_or_operator.rs @@ -1,17 +1,17 @@ use std::borrow::Cow; use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; +use ruff_python_ast::Expr; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_python_ast::Expr; use ruff_python_trivia::CommentRanges; use ruff_text_size::Ranged; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for ternary `if` expressions that can be replaced with the `or` @@ -38,24 +38,24 @@ use crate::Locator; /// For example, `foo` will be called twice in `foo() if foo() else bar()` /// (assuming `foo()` returns a truthy value), but only once in /// `foo() or bar()`. -#[violation] -pub struct IfExpInsteadOfOrOperator; +#[derive(ViolationMetadata)] +pub(crate) struct IfExpInsteadOfOrOperator; impl Violation for IfExpInsteadOfOrOperator { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Replace ternary `if` expression with `or` operator") + "Replace ternary `if` expression with `or` operator".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `or` operator")) + Some("Replace with `or` operator".to_string()) } } /// FURB110 -pub(crate) fn if_exp_instead_of_or_operator(checker: &mut Checker, if_expr: &ast::ExprIf) { +pub(crate) fn if_exp_instead_of_or_operator(checker: &Checker, if_expr: &ast::ExprIf) { let ast::ExprIf { test, body, @@ -86,7 +86,7 @@ pub(crate) fn if_exp_instead_of_or_operator(checker: &mut Checker, if_expr: &ast }, )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Parenthesize an expression for use in an `or` operator (e.g., parenthesize `x` in `x or y`), diff --git a/crates/ruff_linter/src/rules/refurb/rules/if_expr_min_max.rs b/crates/ruff_linter/src/rules/refurb/rules/if_expr_min_max.rs index 1c25a17e871cd..2d1c664b5abb7 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/if_expr_min_max.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/if_expr_min_max.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_text_size::Ranged; @@ -30,8 +30,8 @@ use crate::fix::snippet::SourceCodeSnippet; /// ## References /// - [Python documentation: `min`](https://docs.python.org/3.11/library/functions.html#min) /// - [Python documentation: `max`](https://docs.python.org/3.11/library/functions.html#max) -#[violation] -pub struct IfExprMinMax { +#[derive(ViolationMetadata)] +pub(crate) struct IfExprMinMax { min_max: MinMax, expression: SourceCodeSnippet, replacement: SourceCodeSnippet, @@ -76,7 +76,7 @@ impl Violation for IfExprMinMax { } /// FURB136 -pub(crate) fn if_expr_min_max(checker: &mut Checker, if_exp: &ast::ExprIf) { +pub(crate) fn if_expr_min_max(checker: &Checker, if_exp: &ast::ExprIf) { let Expr::Compare(ast::ExprCompare { left, ops, @@ -146,7 +146,7 @@ pub(crate) fn if_expr_min_max(checker: &mut Checker, if_exp: &ast::ExprIf) { ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/refurb/rules/implicit_cwd.rs b/crates/ruff_linter/src/rules/refurb/rules/implicit_cwd.rs index f3183d37d043c..8191b5baa0e88 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/implicit_cwd.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/implicit_cwd.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprAttribute, ExprCall}; use ruff_text_size::Ranged; @@ -25,15 +25,15 @@ use crate::{checkers::ast::Checker, importer::ImportRequest}; /// ## References /// - [Python documentation: `Path.cwd`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.cwd) -#[violation] -pub struct ImplicitCwd; +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitCwd; impl Violation for ImplicitCwd { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups") + "Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups".to_string() } fn fix_title(&self) -> Option<String> { @@ -42,7 +42,7 @@ impl Violation for ImplicitCwd { } /// FURB177 -pub(crate) fn no_implicit_cwd(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn no_implicit_cwd(checker: &Checker, call: &ExprCall) { if !call.arguments.is_empty() { return; } @@ -102,5 +102,5 @@ pub(crate) fn no_implicit_cwd(checker: &mut Checker, call: &ExprCall) { )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/int_on_sliced_str.rs b/crates/ruff_linter/src/rules/refurb/rules/int_on_sliced_str.rs index a27e969381987..559decd68c380 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/int_on_sliced_str.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/int_on_sliced_str.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Expr, ExprCall, Identifier}; use ruff_text_size::Ranged; @@ -47,8 +47,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `int`](https://docs.python.org/3/library/functions.html#int) -#[violation] -pub struct IntOnSlicedStr { +#[derive(ViolationMetadata)] +pub(crate) struct IntOnSlicedStr { base: u8, } @@ -60,11 +60,11 @@ impl AlwaysFixableViolation for IntOnSlicedStr { } fn fix_title(&self) -> String { - format!("Replace with `base=0`") + "Replace with `base=0`".to_string() } } -pub(crate) fn int_on_sliced_str(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn int_on_sliced_str(checker: &Checker, call: &ExprCall) { // Verify that the function is `int`. if !checker.semantic().match_builtin_expr(&call.func, "int") { return; @@ -106,12 +106,12 @@ pub(crate) fn int_on_sliced_str(checker: &mut Checker, call: &ExprCall) { if expr_slice.upper.is_some() || expr_slice.step.is_some() { return; } - if !expr_slice + if expr_slice .lower .as_ref() .and_then(|expr| expr.as_number_literal_expr()) .and_then(|expr| expr.value.as_int()) - .is_some_and(|expr| expr.as_u8() == Some(2)) + .is_none_or(|expr| expr.as_u8() != Some(2)) { return; } @@ -124,5 +124,5 @@ pub(crate) fn int_on_sliced_str(checker: &mut Checker, call: &ExprCall) { ), [Edit::range_replacement("0".to_string(), base.range())], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/isinstance_type_none.rs b/crates/ruff_linter/src/rules/refurb/rules/isinstance_type_none.rs index 7fe233b55459d..74cd1d22861e1 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/isinstance_type_none.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/isinstance_type_none.rs @@ -1,12 +1,10 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Operator}; - -use ruff_macros::{derive_message_formats, violation}; -use ruff_text_size::Ranged; +use ruff_python_semantic::SemanticModel; use crate::checkers::ast::Checker; -use crate::fix::edits::pad; -use crate::rules::refurb::helpers::generate_none_identity_comparison; +use crate::rules::refurb::helpers::replace_with_identity_check; /// ## What it does /// Checks for uses of `isinstance` that check if an object is of type `None`. @@ -25,20 +23,23 @@ use crate::rules::refurb::helpers::generate_none_identity_comparison; /// obj is None /// ``` /// +/// ## Fix safety +/// The fix will be marked as unsafe if there are any comments within the call. +/// /// ## References /// - [Python documentation: `isinstance`](https://docs.python.org/3/library/functions.html#isinstance) /// - [Python documentation: `None`](https://docs.python.org/3/library/constants.html#None) /// - [Python documentation: `type`](https://docs.python.org/3/library/functions.html#type) /// - [Python documentation: Identity comparisons](https://docs.python.org/3/reference/expressions.html#is-not) -#[violation] -pub struct IsinstanceTypeNone; +#[derive(ViolationMetadata)] +pub(crate) struct IsinstanceTypeNone; impl Violation for IsinstanceTypeNone { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `is` operator over `isinstance` to check if an object is `None`") + "Prefer `is` operator over `isinstance` to check if an object is `None`".to_string() } fn fix_title(&self) -> Option<String> { @@ -47,38 +48,36 @@ impl Violation for IsinstanceTypeNone { } /// FURB168 -pub(crate) fn isinstance_type_none(checker: &mut Checker, call: &ast::ExprCall) { - let Some(types) = call.arguments.find_positional(1) else { +pub(crate) fn isinstance_type_none(checker: &Checker, call: &ast::ExprCall) { + let semantic = checker.semantic(); + let (func, arguments) = (&call.func, &call.arguments); + + if !arguments.keywords.is_empty() { + return; + } + + let [expr, types] = arguments.args.as_ref() else { return; }; - if !checker - .semantic() - .match_builtin_expr(&call.func, "isinstance") - { + + if !semantic.match_builtin_expr(func, "isinstance") { return; } - if is_none(types) { - let Some(Expr::Name(ast::ExprName { - id: object_name, .. - })) = call.arguments.find_positional(0) - else { - return; - }; - let mut diagnostic = Diagnostic::new(IsinstanceTypeNone, call.range()); - let replacement = - generate_none_identity_comparison(object_name.clone(), false, checker.generator()); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - pad(replacement, call.range(), checker.locator()), - call.range(), - ))); - checker.diagnostics.push(diagnostic); + + if !is_none(types, semantic) { + return; } + + let fix = replace_with_identity_check(expr, call.range, false, checker); + let diagnostic = Diagnostic::new(IsinstanceTypeNone, call.range); + + checker.report_diagnostic(diagnostic.with_fix(fix)); } /// Returns `true` if the given expression is equivalent to checking if the /// object type is `None` when used with the `isinstance` builtin. -fn is_none(expr: &Expr) -> bool { - fn inner(expr: &Expr, in_union_context: bool) -> bool { +fn is_none(expr: &Expr, semantic: &SemanticModel) -> bool { + fn inner(expr: &Expr, in_union_context: bool, semantic: &SemanticModel) -> bool { match expr { // Ex) `None` // Note: `isinstance` only accepts `None` as a type when used with @@ -88,17 +87,20 @@ fn is_none(expr: &Expr) -> bool { // Ex) `type(None)` Expr::Call(ast::ExprCall { func, arguments, .. - }) if arguments.len() == 1 => { - if let Expr::Name(ast::ExprName { id, .. }) = func.as_ref() { - if id.as_str() == "type" { - return matches!(arguments.args.first(), Some(Expr::NoneLiteral(_))); - } + }) => { + if !semantic.match_builtin_expr(func, "type") { + return false; } - false + + if !arguments.keywords.is_empty() { + return false; + } + + matches!(arguments.args.as_ref(), [Expr::NoneLiteral(_)]) } // Ex) `(type(None),)` - Expr::Tuple(tuple) => tuple.iter().all(|element| inner(element, false)), + Expr::Tuple(tuple) => tuple.iter().all(|element| inner(element, false, semantic)), // Ex) `type(None) | type(None)` Expr::BinOp(ast::ExprBinOp { @@ -106,11 +108,32 @@ fn is_none(expr: &Expr) -> bool { op: Operator::BitOr, right, .. - }) => inner(left, true) && inner(right, true), + }) => { + // `None | None` is a `TypeError` at runtime + if left.is_none_literal_expr() && right.is_none_literal_expr() { + return false; + } + + inner(left, true, semantic) && inner(right, true, semantic) + } + + // Ex) `Union[None, ...]` + Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { + if !semantic.match_typing_expr(value, "Union") { + return false; + } + + match slice.as_ref() { + Expr::Tuple(ast::ExprTuple { elts, .. }) => { + elts.iter().all(|element| inner(element, true, semantic)) + } + slice => inner(slice, true, semantic), + } + } // Otherwise, return false. _ => false, } } - inner(expr, false) + inner(expr, false, semantic) } diff --git a/crates/ruff_linter/src/rules/refurb/rules/list_reverse_copy.rs b/crates/ruff_linter/src/rules/refurb/rules/list_reverse_copy.rs index 0f1346fce9ecd..93efd089f0fc1 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/list_reverse_copy.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/list_reverse_copy.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{ Expr, ExprCall, ExprName, ExprSlice, ExprSubscript, ExprUnaryOp, Int, StmtAssign, UnaryOp, }; -use ruff_python_semantic::analyze::typing; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::typing; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -46,8 +46,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: More on Lists](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) -#[violation] -pub struct ListReverseCopy { +#[derive(ViolationMetadata)] +pub(crate) struct ListReverseCopy { name: String, } @@ -65,7 +65,7 @@ impl AlwaysFixableViolation for ListReverseCopy { } /// FURB187 -pub(crate) fn list_assign_reversed(checker: &mut Checker, assign: &StmtAssign) { +pub(crate) fn list_assign_reversed(checker: &Checker, assign: &StmtAssign) { let [Expr::Name(target_expr)] = assign.targets.as_slice() else { return; }; @@ -89,7 +89,7 @@ pub(crate) fn list_assign_reversed(checker: &mut Checker, assign: &StmtAssign) { return; } - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new( ListReverseCopy { name: target_expr.id.to_string(), @@ -119,7 +119,7 @@ fn peel_lists(expr: &Expr) -> &Expr { return expr; } - if !func.as_name_expr().is_some_and(|name| name.id == "list") { + if func.as_name_expr().is_none_or(|name| name.id != "list") { return expr; } @@ -175,14 +175,14 @@ fn extract_name_from_sliced_reversed(expr: &Expr) -> Option<&ExprName> { else { return None; }; - if !operand + if operand .as_number_literal_expr() .and_then(|num| num.value.as_int()) .and_then(Int::as_u8) - .is_some_and(|value| value == 1) + .is_none_or(|value| value != 1) { return None; - }; + } value.as_name_expr() } diff --git a/crates/ruff_linter/src/rules/refurb/rules/math_constant.rs b/crates/ruff_linter/src/rules/refurb/rules/math_constant.rs index 6ec50d7c68a12..b3a0f3bf63a7b 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/math_constant.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/math_constant.rs @@ -1,7 +1,7 @@ use anyhow::Result; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Number}; use ruff_text_size::Ranged; @@ -27,8 +27,8 @@ use crate::importer::ImportRequest; /// /// ## References /// - [Python documentation: `math` constants](https://docs.python.org/3/library/math.html#constants) -#[violation] -pub struct MathConstant { +#[derive(ViolationMetadata)] +pub(crate) struct MathConstant { literal: String, constant: &'static str, } @@ -49,7 +49,7 @@ impl Violation for MathConstant { } /// FURB152 -pub(crate) fn math_constant(checker: &mut Checker, literal: &ast::ExprNumberLiteral) { +pub(crate) fn math_constant(checker: &Checker, literal: &ast::ExprNumberLiteral) { let Number::Float(value) = literal.value else { return; }; @@ -63,7 +63,7 @@ pub(crate) fn math_constant(checker: &mut Checker, literal: &ast::ExprNumberLite literal.range(), ); diagnostic.try_set_fix(|| convert_to_constant(literal, constant.name(), checker)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -105,7 +105,7 @@ enum Constant { } impl Constant { - #[allow(clippy::approx_constant)] + #[expect(clippy::approx_constant)] fn from_value(value: f64) -> Option<Self> { if (3.14..3.15).contains(&value) { matches_constant(std::f64::consts::PI, value).then_some(Self::Pi) diff --git a/crates/ruff_linter/src/rules/refurb/rules/metaclass_abcmeta.rs b/crates/ruff_linter/src/rules/refurb/rules/metaclass_abcmeta.rs index 5982cdca7fd6d..e71c3e68a2451 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/metaclass_abcmeta.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/metaclass_abcmeta.rs @@ -1,7 +1,7 @@ use itertools::Itertools; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::StmtClassDef; use ruff_text_size::{Ranged, TextRange}; @@ -34,22 +34,22 @@ use crate::importer::ImportRequest; /// ## References /// - [Python documentation: `abc.ABC`](https://docs.python.org/3/library/abc.html#abc.ABC) /// - [Python documentation: `abc.ABCMeta`](https://docs.python.org/3/library/abc.html#abc.ABCMeta) -#[violation] -pub struct MetaClassABCMeta; +#[derive(ViolationMetadata)] +pub(crate) struct MetaClassABCMeta; impl AlwaysFixableViolation for MetaClassABCMeta { #[derive_message_formats] fn message(&self) -> String { - format!("Use of `metaclass=abc.ABCMeta` to define abstract base class") + "Use of `metaclass=abc.ABCMeta` to define abstract base class".to_string() } fn fix_title(&self) -> String { - format!("Replace with `abc.ABC`") + "Replace with `abc.ABC`".to_string() } } /// FURB180 -pub(crate) fn metaclass_abcmeta(checker: &mut Checker, class_def: &StmtClassDef) { +pub(crate) fn metaclass_abcmeta(checker: &Checker, class_def: &StmtClassDef) { // Identify the `metaclass` keyword. let Some((position, keyword)) = class_def.keywords().iter().find_position(|&keyword| { keyword @@ -100,5 +100,5 @@ pub(crate) fn metaclass_abcmeta(checker: &mut Checker, class_def: &StmtClassDef) }) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/mod.rs b/crates/ruff_linter/src/rules/refurb/rules/mod.rs index e71ded4315d23..a0c573dc6c8b9 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/mod.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/mod.rs @@ -2,6 +2,8 @@ pub(crate) use bit_count::*; pub(crate) use check_and_remove_from_set::*; pub(crate) use delete_full_slice::*; pub(crate) use for_loop_set_mutations::*; +pub(crate) use for_loop_writes::*; +pub(crate) use fromisoformat_replace_z::*; pub(crate) use fstring_number_format::*; pub(crate) use hardcoded_string_charset::*; pub(crate) use hashlib_digest_hex::*; @@ -26,6 +28,7 @@ pub(crate) use single_item_membership_test::*; pub(crate) use slice_copy::*; pub(crate) use slice_to_remove_prefix_or_suffix::*; pub(crate) use sorted_min_max::*; +pub(crate) use subclass_builtin::*; pub(crate) use type_none_comparison::*; pub(crate) use unnecessary_enumerate::*; pub(crate) use unnecessary_from_float::*; @@ -36,9 +39,12 @@ mod bit_count; mod check_and_remove_from_set; mod delete_full_slice; mod for_loop_set_mutations; +mod for_loop_writes; +mod fromisoformat_replace_z; mod fstring_number_format; mod hardcoded_string_charset; mod hashlib_digest_hex; +mod helpers; mod if_exp_instead_of_or_operator; mod if_expr_min_max; mod implicit_cwd; @@ -60,6 +66,7 @@ mod single_item_membership_test; mod slice_copy; mod slice_to_remove_prefix_or_suffix; mod sorted_min_max; +mod subclass_builtin; mod type_none_comparison; mod unnecessary_enumerate; mod unnecessary_from_float; diff --git a/crates/ruff_linter/src/rules/refurb/rules/print_empty_string.rs b/crates/ruff_linter/src/rules/refurb/rules/print_empty_string.rs index e076f9a9989cb..b20beda23a2d7 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/print_empty_string.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/print_empty_string.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::{self as ast, Expr}; use ruff_python_codegen::Generator; @@ -32,8 +32,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `print`](https://docs.python.org/3/library/functions.html#print) -#[violation] -pub struct PrintEmptyString { +#[derive(ViolationMetadata)] +pub(crate) struct PrintEmptyString { reason: Reason, } @@ -52,26 +52,25 @@ impl Violation for PrintEmptyString { #[derive_message_formats] fn message(&self) -> String { - let PrintEmptyString { reason } = self; - match reason { - Reason::EmptyArgument => format!("Unnecessary empty string passed to `print`"), - Reason::UselessSeparator => format!("Unnecessary separator passed to `print`"), - Reason::Both => format!("Unnecessary empty string and separator passed to `print`"), + match self.reason { + Reason::EmptyArgument => "Unnecessary empty string passed to `print`".to_string(), + Reason::UselessSeparator => "Unnecessary separator passed to `print`".to_string(), + Reason::Both => "Unnecessary empty string and separator passed to `print`".to_string(), } } fn fix_title(&self) -> Option<String> { - let PrintEmptyString { reason } = self; - match reason { - Reason::EmptyArgument => Some("Remove empty string".to_string()), - Reason::UselessSeparator => Some("Remove separator".to_string()), - Reason::Both => Some("Remove empty string and separator".to_string()), - } + let title = match self.reason { + Reason::EmptyArgument => "Remove empty string", + Reason::UselessSeparator => "Remove separator", + Reason::Both => "Remove empty string and separator", + }; + Some(title.to_string()) } } /// FURB105 -pub(crate) fn print_empty_string(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn print_empty_string(checker: &Checker, call: &ast::ExprCall) { if !checker.semantic().match_builtin_expr(&call.func, "print") { return; } @@ -97,7 +96,7 @@ pub(crate) fn print_empty_string(checker: &mut Checker, call: &ast::ExprCall) { .into_fix(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } [arg] if arg.is_starred_expr() => { @@ -125,7 +124,7 @@ pub(crate) fn print_empty_string(checker: &mut Checker, call: &ast::ExprCall) { .into_fix(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -145,7 +144,7 @@ pub(crate) fn print_empty_string(checker: &mut Checker, call: &ast::ExprCall) { let empty_separator = call .arguments .find_keyword("sep") - .map_or(false, |keyword| is_empty_string(&keyword.value)); + .is_some_and(|keyword| is_empty_string(&keyword.value)); if !empty_separator { return; } @@ -187,7 +186,7 @@ pub(crate) fn print_empty_string(checker: &mut Checker, call: &ast::ExprCall) { .into_fix(), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/read_whole_file.rs b/crates/ruff_linter/src/rules/refurb/rules/read_whole_file.rs index b0c2424a552d5..806be8f883c35 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/read_whole_file.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/read_whole_file.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::{self, Visitor}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_codegen::Generator; @@ -8,7 +8,7 @@ use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; -use super::super::helpers::{find_file_opens, FileOpen}; +use super::super::helpers::{FileOpen, find_file_opens}; /// ## What it does /// Checks for uses of `open` and `read` that can be replaced by `pathlib` @@ -35,8 +35,8 @@ use super::super::helpers::{find_file_opens, FileOpen}; /// ## References /// - [Python documentation: `Path.read_bytes`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.read_bytes) /// - [Python documentation: `Path.read_text`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.read_text) -#[violation] -pub struct ReadWholeFile { +#[derive(ViolationMetadata)] +pub(crate) struct ReadWholeFile { filename: SourceCodeSnippet, suggestion: SourceCodeSnippet, } @@ -51,67 +51,39 @@ impl Violation for ReadWholeFile { } /// FURB101 -pub(crate) fn read_whole_file(checker: &mut Checker, with: &ast::StmtWith) { +pub(crate) fn read_whole_file(checker: &Checker, with: &ast::StmtWith) { // `async` check here is more of a precaution. if with.is_async { return; } // First we go through all the items in the statement and find all `open` operations. - let candidates = find_file_opens( - with, - checker.semantic(), - true, - checker.settings.target_version, - ); + let candidates = find_file_opens(with, checker.semantic(), true, checker.target_version()); if candidates.is_empty() { return; } // Then we need to match each `open` operation with exactly one `read` call. - let matches = { - let mut matcher = ReadMatcher::new(candidates); - visitor::walk_body(&mut matcher, &with.body); - matcher.into_matches() - }; - - // All the matched operations should be reported. - let diagnostics: Vec<Diagnostic> = matches - .iter() - .map(|open| { - Diagnostic::new( - ReadWholeFile { - filename: SourceCodeSnippet::from_str(&checker.generator().expr(open.filename)), - suggestion: make_suggestion(open, checker.generator()), - }, - open.item.range(), - ) - }) - .collect(); - checker.diagnostics.extend(diagnostics); + let mut matcher = ReadMatcher::new(checker, candidates); + visitor::walk_body(&mut matcher, &with.body); } /// AST visitor that matches `open` operations with the corresponding `read` calls. -#[derive(Debug)] -struct ReadMatcher<'a> { +struct ReadMatcher<'a, 'b> { + checker: &'a Checker<'b>, candidates: Vec<FileOpen<'a>>, - matches: Vec<FileOpen<'a>>, } -impl<'a> ReadMatcher<'a> { - fn new(candidates: Vec<FileOpen<'a>>) -> Self { +impl<'a, 'b> ReadMatcher<'a, 'b> { + fn new(checker: &'a Checker<'b>, candidates: Vec<FileOpen<'a>>) -> Self { Self { + checker, candidates, - matches: vec![], } } - - fn into_matches(self) -> Vec<FileOpen<'a>> { - self.matches - } } -impl<'a> Visitor<'a> for ReadMatcher<'a> { +impl<'a> Visitor<'a> for ReadMatcher<'a, '_> { fn visit_expr(&mut self, expr: &'a Expr) { if let Some(read_from) = match_read_call(expr) { if let Some(open) = self @@ -119,7 +91,16 @@ impl<'a> Visitor<'a> for ReadMatcher<'a> { .iter() .position(|open| open.is_ref(read_from)) { - self.matches.push(self.candidates.remove(open)); + let open = self.candidates.remove(open); + self.checker.report_diagnostic(Diagnostic::new( + ReadWholeFile { + filename: SourceCodeSnippet::from_str( + &self.checker.generator().expr(open.filename), + ), + suggestion: make_suggestion(&open, self.checker.generator()), + }, + open.item.range(), + )); } return; } diff --git a/crates/ruff_linter/src/rules/refurb/rules/readlines_in_for.rs b/crates/ruff_linter/src/rules/refurb/rules/readlines_in_for.rs index e548b499844df..a8ac3d1f5bf96 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/readlines_in_for.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/readlines_in_for.rs @@ -1,5 +1,6 @@ +use crate::preview::is_readlines_in_for_fix_safe_enabled; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{Comprehension, Expr, StmtFor}; use ruff_python_semantic::analyze::typing; use ruff_python_semantic::analyze::typing::is_io_base_expr; @@ -31,13 +32,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `io.IOBase.readlines`](https://docs.python.org/3/library/io.html#io.IOBase.readlines) -#[violation] +#[derive(ViolationMetadata)] pub(crate) struct ReadlinesInFor; impl AlwaysFixableViolation for ReadlinesInFor { #[derive_message_formats] fn message(&self) -> String { - format!("Instead of calling `readlines()`, iterate over file object directly") + "Instead of calling `readlines()`, iterate over file object directly".to_string() } fn fix_title(&self) -> String { @@ -46,16 +47,16 @@ impl AlwaysFixableViolation for ReadlinesInFor { } /// FURB129 -pub(crate) fn readlines_in_for(checker: &mut Checker, for_stmt: &StmtFor) { +pub(crate) fn readlines_in_for(checker: &Checker, for_stmt: &StmtFor) { readlines_in_iter(checker, for_stmt.iter.as_ref()); } /// FURB129 -pub(crate) fn readlines_in_comprehension(checker: &mut Checker, comprehension: &Comprehension) { +pub(crate) fn readlines_in_comprehension(checker: &Checker, comprehension: &Comprehension) { readlines_in_iter(checker, &comprehension.iter); } -fn readlines_in_iter(checker: &mut Checker, iter_expr: &Expr) { +fn readlines_in_iter(checker: &Checker, iter_expr: &Expr) { let Expr::Call(expr_call) = iter_expr else { return; }; @@ -85,8 +86,14 @@ fn readlines_in_iter(checker: &mut Checker, iter_expr: &Expr) { } let mut diagnostic = Diagnostic::new(ReadlinesInFor, expr_call.range()); - diagnostic.set_fix(Fix::unsafe_edit(Edit::range_deletion( - expr_call.range().add_start(expr_attr.value.range().len()), - ))); - checker.diagnostics.push(diagnostic); + diagnostic.set_fix(if is_readlines_in_for_fix_safe_enabled(checker.settings) { + Fix::safe_edit(Edit::range_deletion( + expr_call.range().add_start(expr_attr.value.range().len()), + )) + } else { + Fix::unsafe_edit(Edit::range_deletion( + expr_call.range().add_start(expr_attr.value.range().len()), + )) + }); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/refurb/rules/redundant_log_base.rs b/crates/ruff_linter/src/rules/refurb/rules/redundant_log_base.rs index 447a6ef704737..445215aa90b5c 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/redundant_log_base.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/redundant_log_base.rs @@ -1,6 +1,6 @@ use anyhow::Result; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, Number}; use ruff_text_size::Ranged; @@ -41,8 +41,8 @@ use crate::importer::ImportRequest; /// - [Python documentation: `math.log2`](https://docs.python.org/3/library/math.html#math.log2) /// - [Python documentation: `math.log10`](https://docs.python.org/3/library/math.html#math.log10) /// - [Python documentation: `math.e`](https://docs.python.org/3/library/math.html#math.e) -#[violation] -pub struct RedundantLogBase { +#[derive(ViolationMetadata)] +pub(crate) struct RedundantLogBase { base: Base, arg: String, } @@ -65,7 +65,7 @@ impl Violation for RedundantLogBase { } /// FURB163 -pub(crate) fn redundant_log_base(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn redundant_log_base(checker: &Checker, call: &ast::ExprCall) { if !call.arguments.keywords.is_empty() { return; } @@ -104,7 +104,7 @@ pub(crate) fn redundant_log_base(checker: &mut Checker, call: &ast::ExprCall) { call.range(), ); diagnostic.try_set_fix(|| generate_fix(checker, call, base, arg)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Clone, Copy, PartialEq, Eq)] @@ -129,7 +129,7 @@ fn is_number_literal(expr: &Expr, value: i8) -> bool { if let Number::Int(number) = &number_literal.value { return number.as_i8().is_some_and(|number| number == value); } else if let Number::Float(number) = number_literal.value { - #[allow(clippy::float_cmp)] + #[expect(clippy::float_cmp)] return number == f64::from(value); } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/regex_flag_alias.rs b/crates/ruff_linter/src/rules/refurb/rules/regex_flag_alias.rs index f04768b0a3162..1c76b1c19697c 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/regex_flag_alias.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/regex_flag_alias.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Expr; use ruff_python_semantic::Modules; use ruff_text_size::Ranged; @@ -32,8 +32,8 @@ use crate::importer::ImportRequest; /// ... /// ``` /// -#[violation] -pub struct RegexFlagAlias { +#[derive(ViolationMetadata)] +pub(crate) struct RegexFlagAlias { flag: RegexFlag, } @@ -51,7 +51,7 @@ impl AlwaysFixableViolation for RegexFlagAlias { } /// FURB167 -pub(crate) fn regex_flag_alias(checker: &mut Checker, expr: &Expr) { +pub(crate) fn regex_flag_alias(checker: &Checker, expr: &Expr) { if !checker.semantic().seen_module(Modules::RE) { return; } @@ -86,7 +86,7 @@ pub(crate) fn regex_flag_alias(checker: &mut Checker, expr: &Expr) { [edit], )) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Clone, Copy, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/refurb/rules/reimplemented_operator.rs b/crates/ruff_linter/src/rules/refurb/rules/reimplemented_operator.rs index 2a56ce706ef40..751f0093781a5 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/reimplemented_operator.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/reimplemented_operator.rs @@ -5,16 +5,16 @@ use anyhow::Result; use itertools::Itertools; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::{self as ast, Expr, ExprSlice, ExprSubscript, ExprTuple, Parameters, Stmt}; use ruff_python_semantic::SemanticModel; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::importer::{ImportRequest, Importer}; -use crate::Locator; /// ## What it does /// Checks for lambda expressions and function definitions that can be replaced with a function from @@ -22,7 +22,7 @@ use crate::Locator; /// /// ## Why is this bad? /// The `operator` module provides functions that implement the same functionality as the -/// corresponding operators. For example, `operator.add` is equivalent to `lambda x, y: x + y`. +/// corresponding operators. For example, `operator.add` is often equivalent to `lambda x, y: x + y`. /// Using the functions from the `operator` module is more concise and communicates the intent of /// the code more clearly. /// @@ -44,12 +44,32 @@ use crate::Locator; /// ``` /// /// ## Fix safety -/// This fix is usually safe, but if the lambda is called with keyword arguments, e.g., -/// `add = lambda x, y: x + y; add(x=1, y=2)`, replacing the lambda with an operator function, e.g., -/// `operator.add`, will cause the call to raise a `TypeError`, as functions in `operator` do not allow -/// keyword arguments. -#[violation] -pub struct ReimplementedOperator { +/// The fix offered by this rule is always marked as unsafe. While the changes the fix would make +/// would rarely break your code, there are two ways in which functions from the `operator` module +/// differ from user-defined functions. It would be non-trivial for Ruff to detect whether or not +/// these differences would matter in a specific situation where Ruff is emitting a diagnostic for +/// this rule. +/// +/// The first difference is that `operator` functions cannot be called with keyword arguments, but +/// most user-defined functions can. If an `add` function is defined as `add = lambda x, y: x + y`, +/// replacing this function with `operator.add` will cause the later call to raise `TypeError` if +/// the function is later called with keyword arguments, e.g. `add(x=1, y=2)`. +/// +/// The second difference is that user-defined functions are [descriptors], but this is not true of +/// the functions defined in the `operator` module. Practically speaking, this means that defining +/// a function in a class body (either by using a `def` statement or assigning a `lambda` function +/// to a variable) is a valid way of defining an instance method on that class; monkeypatching a +/// user-defined function onto a class after the class has been created also has the same effect. +/// The same is not true of an `operator` function: assigning an `operator` function to a variable +/// in a class body or monkeypatching one onto a class will not create a valid instance method. +/// Ruff will refrain from emitting diagnostics for this rule on function definitions in class +/// bodies; however, it does not currently have sophisticated enough type inference to avoid +/// emitting this diagnostic if a user-defined function is being monkeypatched onto a class after +/// the class has been constructed. +/// +/// [descriptors]: https://docs.python.org/3/howto/descriptor.html +#[derive(ViolationMetadata)] +pub(crate) struct ReimplementedOperator { operator: Operator, target: FunctionLikeKind, } @@ -60,14 +80,7 @@ impl Violation for ReimplementedOperator { #[derive_message_formats] fn message(&self) -> String { let ReimplementedOperator { operator, target } = self; - match target { - FunctionLikeKind::Function => { - format!("Use `operator.{operator}` instead of defining a function") - } - FunctionLikeKind::Lambda => { - format!("Use `operator.{operator}` instead of defining a lambda") - } - } + format!("Use `operator.{operator}` instead of defining a {target}") } fn fix_title(&self) -> Option<String> { @@ -77,12 +90,18 @@ impl Violation for ReimplementedOperator { } /// FURB118 -pub(crate) fn reimplemented_operator(checker: &mut Checker, target: &FunctionLike) { +pub(crate) fn reimplemented_operator(checker: &Checker, target: &FunctionLike) { // Ignore methods. - if target.kind() == FunctionLikeKind::Function { - if checker.semantic().current_scope().kind.is_class() { - return; - } + // Methods can be defined via a `def` statement in a class scope, + // or via a lambda appearing on the right-hand side of an assignment in a class scope. + if checker.semantic().current_scope().kind.is_class() + && (target.is_function_def() + || checker + .semantic() + .current_statements() + .any(|stmt| matches!(stmt, Stmt::AnnAssign(_) | Stmt::Assign(_)))) + { + return; } let Some(params) = target.parameters() else { @@ -101,7 +120,7 @@ pub(crate) fn reimplemented_operator(checker: &mut Checker, target: &FunctionLik target.range(), ); diagnostic.try_set_optional_fix(|| fix); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Candidate for lambda expression or function definition consisting of a return statement. @@ -141,6 +160,10 @@ impl FunctionLike<'_> { } } + const fn is_function_def(&self) -> bool { + matches!(self, Self::Function(_)) + } + /// Return the body of the function-like node. /// /// If the node is a function definition that consists of more than a single return statement, @@ -250,7 +273,7 @@ fn itemgetter_op(expr: &ExprSubscript, params: &Parameters, locator: &Locator) - // The argument to the lambda must match the subscripted value, as in: `lambda x: x[1]`. if !is_same_expression(arg, &expr.value) { return None; - }; + } // The subscripted expression can't contain references to the argument, as in: `lambda x: x[x]`. if any_over_expr(expr.slice.as_ref(), &|expr| is_same_expression(arg, expr)) { @@ -327,12 +350,27 @@ fn get_operator(expr: &Expr, params: &Parameters, locator: &Locator) -> Option<O } } -#[derive(Debug, PartialEq, Eq)] +#[derive(Debug, PartialEq, Eq, Copy, Clone)] enum FunctionLikeKind { Lambda, Function, } +impl FunctionLikeKind { + const fn as_str(self) -> &'static str { + match self { + Self::Lambda => "lambda", + Self::Function => "function", + } + } +} + +impl Display for FunctionLikeKind { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} + /// Return the name of the `operator` implemented by the given unary expression. fn unary_op(expr: &ast::ExprUnaryOp, params: &Parameters) -> Option<&'static str> { let [arg] = params.args.as_slice() else { @@ -418,11 +456,11 @@ fn match_arguments( /// Returns `true` if the given argument is the "same" as the given expression. For example, if /// the argument has a default, it is not considered the same as any expression; if both match the /// same name, they are considered the same. -fn is_same_expression(arg: &ast::ParameterWithDefault, expr: &Expr) -> bool { - if arg.default.is_some() { +fn is_same_expression(param: &ast::ParameterWithDefault, expr: &Expr) -> bool { + if param.default.is_some() { false } else if let Expr::Name(name) = expr { - name.id == arg.parameter.name.as_str() + name.id == param.name().as_str() } else { false } diff --git a/crates/ruff_linter/src/rules/refurb/rules/reimplemented_starmap.rs b/crates/ruff_linter/src/rules/refurb/rules/reimplemented_starmap.rs index 8c92005e195c6..17ec6df052f51 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/reimplemented_starmap.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/reimplemented_starmap.rs @@ -1,6 +1,6 @@ -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::helpers::any_over_expr; use ruff_python_ast::name::Name; @@ -29,18 +29,7 @@ use crate::importer::ImportRequest; /// /// ## Example /// ```python -/// scores = [85, 100, 60] -/// passing_scores = [60, 80, 70] -/// -/// -/// def passed_test(score: int, passing_score: int) -> bool: -/// return score >= passing_score -/// -/// -/// passed_all_tests = all( -/// passed_test(score, passing_score) -/// for score, passing_score in zip(scores, passing_scores) -/// ) +/// all(predicate(a, b) for a, b in some_iterable) /// ``` /// /// Use instead: @@ -48,15 +37,7 @@ use crate::importer::ImportRequest; /// from itertools import starmap /// /// -/// scores = [85, 100, 60] -/// passing_scores = [60, 80, 70] -/// -/// -/// def passed_test(score: int, passing_score: int) -> bool: -/// return score >= passing_score -/// -/// -/// passed_all_tests = all(starmap(passed_test, zip(scores, passing_scores))) +/// all(starmap(predicate, some_iterable)) /// ``` /// /// ## References @@ -64,26 +45,26 @@ use crate::importer::ImportRequest; /// /// [PEP 709]: https://peps.python.org/pep-0709/ /// [#7771]: https://github.com/astral-sh/ruff/issues/7771 -#[violation] -pub struct ReimplementedStarmap; +#[derive(ViolationMetadata)] +pub(crate) struct ReimplementedStarmap; impl Violation for ReimplementedStarmap { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `itertools.starmap` instead of the generator") + "Use `itertools.starmap` instead of the generator".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `itertools.starmap`")) + Some("Replace with `itertools.starmap`".to_string()) } } /// FURB140 -pub(crate) fn reimplemented_starmap(checker: &mut Checker, target: &StarmapCandidate) { +pub(crate) fn reimplemented_starmap(checker: &Checker, target: &StarmapCandidate) { // Generator should have exactly one comprehension. - let [comprehension @ ast::Comprehension { .. }] = target.generators() else { + let [comprehension] = target.generators() else { return; }; @@ -175,7 +156,7 @@ pub(crate) fn reimplemented_starmap(checker: &mut Checker, target: &StarmapCandi ); Ok(Fix::safe_edits(import_edit, [main_edit])) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// An enum for a node that can be considered a candidate for replacement with `starmap`. diff --git a/crates/ruff_linter/src/rules/refurb/rules/repeated_append.rs b/crates/ruff_linter/src/rules/refurb/rules/repeated_append.rs index 1489932e9f4ed..ed1f940e31a53 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/repeated_append.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/repeated_append.rs @@ -2,7 +2,7 @@ use rustc_hash::FxHashMap; use ast::traversal; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::traversal::EnclosingSuite; use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_codegen::Generator; @@ -44,8 +44,8 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// ## References /// - [Python documentation: More on Lists](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) -#[violation] -pub struct RepeatedAppend { +#[derive(ViolationMetadata)] +pub(crate) struct RepeatedAppend { name: String, replacement: SourceCodeSnippet, } @@ -76,7 +76,7 @@ impl Violation for RepeatedAppend { } /// FURB113 -pub(crate) fn repeated_append(checker: &mut Checker, stmt: &Stmt) { +pub(crate) fn repeated_append(checker: &Checker, stmt: &Stmt) { let Some(appends) = match_consecutive_appends(stmt, checker.semantic()) else { return; }; @@ -86,48 +86,42 @@ pub(crate) fn repeated_append(checker: &mut Checker, stmt: &Stmt) { return; } - // group borrows from checker, so we can't directly push into checker.diagnostics - let diagnostics: Vec<Diagnostic> = group_appends(appends) - .iter() - .filter_map(|group| { - // Groups with just one element are fine, and shouldn't be replaced by `extend`. - if group.appends.len() <= 1 { - return None; - } - - let replacement = make_suggestion(group, checker.generator()); - - let mut diagnostic = Diagnostic::new( - RepeatedAppend { - name: group.name().to_string(), - replacement: SourceCodeSnippet::new(replacement.clone()), - }, - group.range(), - ); - - // We only suggest a fix when all appends in a group are clumped together. If they're - // non-consecutive, fixing them is much more difficult. - // - // Avoid fixing if there are comments in between the appends: - // - // ```python - // a.append(1) - // # comment - // a.append(2) - // ``` - if group.is_consecutive && !checker.comment_ranges().intersects(group.range()) { - diagnostic.set_fix(Fix::unsafe_edit(Edit::replacement( - replacement, - group.start(), - group.end(), - ))); - } + for group in group_appends(appends) { + // Groups with just one element are fine, and shouldn't be replaced by `extend`. + if group.appends.len() <= 1 { + continue; + } - Some(diagnostic) - }) - .collect(); + let replacement = make_suggestion(&group, checker.generator()); + + let mut diagnostic = Diagnostic::new( + RepeatedAppend { + name: group.name().to_string(), + replacement: SourceCodeSnippet::new(replacement.clone()), + }, + group.range(), + ); + + // We only suggest a fix when all appends in a group are clumped together. If they're + // non-consecutive, fixing them is much more difficult. + // + // Avoid fixing if there are comments in between the appends: + // + // ```python + // a.append(1) + // # comment + // a.append(2) + // ``` + if group.is_consecutive && !checker.comment_ranges().intersects(group.range()) { + diagnostic.set_fix(Fix::unsafe_edit(Edit::replacement( + replacement, + group.start(), + group.end(), + ))); + } - checker.diagnostics.extend(diagnostics); + checker.report_diagnostic(diagnostic); + } } #[derive(Debug, Clone)] @@ -332,9 +326,11 @@ fn make_suggestion(group: &AppendGroup, generator: Generator) -> String { assert!(!appends.is_empty()); let first = appends.first().unwrap(); - assert!(appends - .iter() - .all(|append| append.binding.source == first.binding.source)); + assert!( + appends + .iter() + .all(|append| append.binding.source == first.binding.source) + ); // Here we construct `var.extend((elt1, elt2, ..., eltN)) // diff --git a/crates/ruff_linter/src/rules/refurb/rules/repeated_global.rs b/crates/ruff_linter/src/rules/refurb/rules/repeated_global.rs index 2e1deb0065d65..8f2ecfe18dcf7 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/repeated_global.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/repeated_global.rs @@ -1,7 +1,7 @@ use itertools::Itertools; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Stmt; use ruff_text_size::Ranged; @@ -36,8 +36,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: the `global` statement](https://docs.python.org/3/reference/simple_stmts.html#the-global-statement) /// - [Python documentation: the `nonlocal` statement](https://docs.python.org/3/reference/simple_stmts.html#the-nonlocal-statement) -#[violation] -pub struct RepeatedGlobal { +#[derive(ViolationMetadata)] +pub(crate) struct RepeatedGlobal { global_kind: GlobalKind, } @@ -53,7 +53,7 @@ impl AlwaysFixableViolation for RepeatedGlobal { } /// FURB154 -pub(crate) fn repeated_global(checker: &mut Checker, mut suite: &[Stmt]) { +pub(crate) fn repeated_global(checker: &Checker, mut suite: &[Stmt]) { while let Some(idx) = suite .iter() .position(|stmt| GlobalKind::from_stmt(stmt).is_some()) @@ -74,7 +74,7 @@ pub(crate) fn repeated_global(checker: &mut Checker, mut suite: &[Stmt]) { // diagnostic. if let [first, .., last] = globals_sequence { let range = first.range().cover(last.range()); - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new(RepeatedGlobal { global_kind }, range).with_fix(Fix::safe_edit( Edit::range_replacement( format!( diff --git a/crates/ruff_linter/src/rules/refurb/rules/single_item_membership_test.rs b/crates/ruff_linter/src/rules/refurb/rules/single_item_membership_test.rs index 4185cf3760543..a2d2cacbcf744 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/single_item_membership_test.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/single_item_membership_test.rs @@ -1,5 +1,5 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::generate_comparison; use ruff_python_ast::{self as ast, CmpOp, Expr, ExprStringLiteral}; use ruff_text_size::Ranged; @@ -25,11 +25,20 @@ use crate::fix::edits::pad; /// 1 == 1 /// ``` /// +/// ## Fix safety +/// +/// When the right-hand side is a string, the fix is marked as unsafe. +/// This is because `c in "a"` is true both when `c` is `"a"` and when `c` is the empty string, +/// so the fix can change the behavior of your program in these cases. +/// +/// Additionally, if there are comments within the fix's range, +/// it will also be marked as unsafe. +/// /// ## References /// - [Python documentation: Comparisons](https://docs.python.org/3/reference/expressions.html#comparisons) /// - [Python documentation: Membership test operations](https://docs.python.org/3/reference/expressions.html#membership-test-operations) -#[violation] -pub struct SingleItemMembershipTest { +#[derive(ViolationMetadata)] +pub(crate) struct SingleItemMembershipTest { membership_test: MembershipTest, } @@ -38,7 +47,7 @@ impl Violation for SingleItemMembershipTest { #[derive_message_formats] fn message(&self) -> String { - format!("Membership test against single-item container") + "Membership test against single-item container".to_string() } fn fix_title(&self) -> Option<String> { @@ -52,7 +61,7 @@ impl Violation for SingleItemMembershipTest { /// FURB171 pub(crate) fn single_item_membership_test( - checker: &mut Checker, + checker: &Checker, expr: &Expr, left: &Expr, ops: &[CmpOp], @@ -74,9 +83,9 @@ pub(crate) fn single_item_membership_test( return; }; - let mut diagnostic = - Diagnostic::new(SingleItemMembershipTest { membership_test }, expr.range()); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + let diagnostic = Diagnostic::new(SingleItemMembershipTest { membership_test }, expr.range()); + + let edit = Edit::range_replacement( pad( generate_comparison( left, @@ -90,8 +99,18 @@ pub(crate) fn single_item_membership_test( checker.locator(), ), expr.range(), - ))); - checker.diagnostics.push(diagnostic); + ); + + let applicability = + if right.is_string_literal_expr() || checker.comment_ranges().intersects(expr.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + let fix = Fix::applicable_edit(edit, applicability); + + checker.report_diagnostic(diagnostic.with_fix(fix)); } /// Return the single item wrapped in `Some` if the expression contains a single diff --git a/crates/ruff_linter/src/rules/refurb/rules/slice_copy.rs b/crates/ruff_linter/src/rules/refurb/rules/slice_copy.rs index 776623bfd293e..f8e6d1d502b42 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/slice_copy.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/slice_copy.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::analyze::typing::is_list; @@ -36,15 +36,15 @@ use crate::rules::refurb::helpers::generate_method_call; /// /// ## References /// - [Python documentation: Mutable Sequence Types](https://docs.python.org/3/library/stdtypes.html#mutable-sequence-types) -#[violation] -pub struct SliceCopy; +#[derive(ViolationMetadata)] +pub(crate) struct SliceCopy; impl Violation for SliceCopy { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `copy` method over slicing") + "Prefer `copy` method over slicing".to_string() } fn fix_title(&self) -> Option<String> { @@ -53,7 +53,7 @@ impl Violation for SliceCopy { } /// FURB145 -pub(crate) fn slice_copy(checker: &mut Checker, subscript: &ast::ExprSubscript) { +pub(crate) fn slice_copy(checker: &Checker, subscript: &ast::ExprSubscript) { if subscript.ctx.is_store() || subscript.ctx.is_del() { return; } @@ -68,7 +68,7 @@ pub(crate) fn slice_copy(checker: &mut Checker, subscript: &ast::ExprSubscript) subscript.start(), subscript.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Matches `obj[:]` where `obj` is a list. diff --git a/crates/ruff_linter/src/rules/refurb/rules/slice_to_remove_prefix_or_suffix.rs b/crates/ruff_linter/src/rules/refurb/rules/slice_to_remove_prefix_or_suffix.rs index 7322a00636df7..6ede511238e2b 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/slice_to_remove_prefix_or_suffix.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/slice_to_remove_prefix_or_suffix.rs @@ -1,43 +1,44 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast as ast; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, PythonVersion}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; use crate::Locator; -use crate::{checkers::ast::Checker, settings::types::PythonVersion}; +use crate::checkers::ast::Checker; /// ## What it does -/// Checks for the removal of a prefix or suffix from a string by assigning -/// the string to a slice after checking `.startswith()` or `.endswith()`, respectively. +/// Checks for code that could be written more idiomatically using +/// [`str.removeprefix()`](https://docs.python.org/3/library/stdtypes.html#str.removeprefix) +/// or [`str.removesuffix()`](https://docs.python.org/3/library/stdtypes.html#str.removesuffix). +/// +/// Specifically, the rule flags code that conditionally removes a prefix or suffix +/// using a slice operation following an `if` test that uses `str.startswith()` or `str.endswith()`. +/// +/// The rule is only applied if your project targets Python 3.9 or later. /// /// ## Why is this bad? -/// The methods [`str.removeprefix`](https://docs.python.org/3/library/stdtypes.html#str.removeprefix) -/// and [`str.removesuffix`](https://docs.python.org/3/library/stdtypes.html#str.removesuffix), -/// introduced in Python 3.9, have the same behavior -/// and are more readable and efficient. +/// The methods [`str.removeprefix()`](https://docs.python.org/3/library/stdtypes.html#str.removeprefix) +/// and [`str.removesuffix()`](https://docs.python.org/3/library/stdtypes.html#str.removesuffix), +/// introduced in Python 3.9, have the same behavior while being more readable and efficient. /// /// ## Example /// ```python -/// filename[:-4] if filename.endswith(".txt") else filename -/// ``` +/// def example(filename: str, text: str): +/// filename = filename[:-4] if filename.endswith(".txt") else filename /// -/// ```python -/// if text.startswith("pre"): -/// text = text[3:] +/// if text.startswith("pre"): +/// text = text[3:] /// ``` /// /// Use instead: /// ```python -/// filename = filename.removesuffix(".txt") +/// def example(filename: str, text: str): +/// filename = filename.removesuffix(".txt") +/// text = text.removeprefix("pre") /// ``` -/// -/// ```python -/// text = text.removeprefix("pre") -/// ``` -#[violation] -pub struct SliceToRemovePrefixOrSuffix { - string: String, +#[derive(ViolationMetadata)] +pub(crate) struct SliceToRemovePrefixOrSuffix { affix_kind: AffixKind, stmt_or_expression: StmtOrExpr, } @@ -47,10 +48,10 @@ impl AlwaysFixableViolation for SliceToRemovePrefixOrSuffix { fn message(&self) -> String { match self.affix_kind { AffixKind::StartsWith => { - format!("Prefer `removeprefix` over conditionally replacing with slice.") + "Prefer `str.removeprefix()` over conditionally replacing with slice.".to_string() } AffixKind::EndsWith => { - format!("Prefer `removesuffix` over conditionally replacing with slice.") + "Prefer `str.removesuffix()` over conditionally replacing with slice.".to_string() } } } @@ -67,8 +68,8 @@ impl AlwaysFixableViolation for SliceToRemovePrefixOrSuffix { } /// FURB188 -pub(crate) fn slice_to_remove_affix_expr(checker: &mut Checker, if_expr: &ast::ExprIf) { - if checker.settings.target_version < PythonVersion::Py39 { +pub(crate) fn slice_to_remove_affix_expr(checker: &Checker, if_expr: &ast::ExprIf) { + if checker.target_version() < PythonVersion::PY39 { return; } @@ -80,7 +81,6 @@ pub(crate) fn slice_to_remove_affix_expr(checker: &mut Checker, if_expr: &ast::E let mut diagnostic = Diagnostic::new( SliceToRemovePrefixOrSuffix { affix_kind: kind, - string: checker.locator().slice(text).to_string(), stmt_or_expression: StmtOrExpr::Expression, }, if_expr.range, @@ -93,14 +93,14 @@ pub(crate) fn slice_to_remove_affix_expr(checker: &mut Checker, if_expr: &ast::E if_expr.start(), if_expr.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } /// FURB188 -pub(crate) fn slice_to_remove_affix_stmt(checker: &mut Checker, if_stmt: &ast::StmtIf) { - if checker.settings.target_version < PythonVersion::Py39 { +pub(crate) fn slice_to_remove_affix_stmt(checker: &Checker, if_stmt: &ast::StmtIf) { + if checker.target_version() < PythonVersion::PY39 { return; } if let Some(removal_data) = affix_removal_data_stmt(if_stmt) { @@ -111,7 +111,6 @@ pub(crate) fn slice_to_remove_affix_stmt(checker: &mut Checker, if_stmt: &ast::S let mut diagnostic = Diagnostic::new( SliceToRemovePrefixOrSuffix { affix_kind: kind, - string: checker.locator().slice(text).to_string(), stmt_or_expression: StmtOrExpr::Statement, }, if_stmt.range, @@ -128,7 +127,7 @@ pub(crate) fn slice_to_remove_affix_stmt(checker: &mut Checker, if_stmt: &ast::S if_stmt.start(), if_stmt.end(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -185,7 +184,7 @@ fn affix_removal_data_stmt(if_stmt: &ast::StmtIf) -> Option<RemoveAffixData> { // ``` if !elif_else_clauses.is_empty() { return None; - }; + } // Cannot safely transform, e.g., // ```python @@ -266,7 +265,7 @@ fn affix_removal_data<'a>( }) { return None; - }; + } let compr_test_expr = ast::comparable::ComparableExpr::from( &test.as_call_expr()?.func.as_attribute_expr()?.value, @@ -366,7 +365,7 @@ fn affix_matches_slice_bound(data: &RemoveAffixData, semantic: &SemanticModel) - range: _, value: string_val, }), - ) => operand.as_number_literal_expr().is_some_and( + ) if operand.is_number_literal_expr() => operand.as_number_literal_expr().is_some_and( |ast::ExprNumberLiteral { value, .. }| { // Only support prefix removal for size at most `u32::MAX` value diff --git a/crates/ruff_linter/src/rules/refurb/rules/sorted_min_max.rs b/crates/ruff_linter/src/rules/refurb/rules/sorted_min_max.rs index 34bdc914c1ffd..2eb3834aa67b2 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/sorted_min_max.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/sorted_min_max.rs @@ -3,7 +3,7 @@ use ruff_diagnostics::Edit; use ruff_diagnostics::Fix; use ruff_diagnostics::FixAvailability; use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::Number; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; @@ -42,13 +42,13 @@ use crate::checkers::ast::Checker; /// the same key. However, `min(data, key=itemgetter(0))` will return the _first_ /// "minimum" element in the list in the same scenario. /// -/// AS such, this rule's fix is marked as unsafe when the `reverse` keyword is used. +/// As such, this rule's fix is marked as unsafe when the `reverse` keyword is used. /// /// ## References /// - [Python documentation: `min`](https://docs.python.org/3/library/functions.html#min) /// - [Python documentation: `max`](https://docs.python.org/3/library/functions.html#max) -#[violation] -pub struct SortedMinMax { +#[derive(ViolationMetadata)] +pub(crate) struct SortedMinMax { min_max: MinMax, } @@ -57,28 +57,29 @@ impl Violation for SortedMinMax { #[derive_message_formats] fn message(&self) -> String { - let Self { min_max } = self; - match min_max { + match self.min_max { MinMax::Min => { - format!("Prefer `min` over `sorted()` to compute the minimum value in a sequence") + "Prefer `min` over `sorted()` to compute the minimum value in a sequence" + .to_string() } MinMax::Max => { - format!("Prefer `max` over `sorted()` to compute the maximum value in a sequence") + "Prefer `max` over `sorted()` to compute the maximum value in a sequence" + .to_string() } } } fn fix_title(&self) -> Option<String> { - let Self { min_max } = self; - match min_max { - MinMax::Min => Some("Replace with `min`".to_string()), - MinMax::Max => Some("Replace with `max`".to_string()), - } + let title = match self.min_max { + MinMax::Min => "Replace with `min`", + MinMax::Max => "Replace with `max`", + }; + Some(title.to_string()) } } /// FURB192 -pub(crate) fn sorted_min_max(checker: &mut Checker, subscript: &ast::ExprSubscript) { +pub(crate) fn sorted_min_max(checker: &Checker, subscript: &ast::ExprSubscript) { if subscript.ctx.is_store() || subscript.ctx.is_del() { return; } @@ -200,7 +201,7 @@ pub(crate) fn sorted_min_max(checker: &mut Checker, subscript: &ast::ExprSubscri }); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/refurb/rules/subclass_builtin.rs b/crates/ruff_linter/src/rules/refurb/rules/subclass_builtin.rs new file mode 100644 index 0000000000000..9f72b42f74124 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/rules/subclass_builtin.rs @@ -0,0 +1,151 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Arguments, StmtClassDef, helpers::map_subscript}; +use ruff_text_size::Ranged; + +use crate::{checkers::ast::Checker, importer::ImportRequest}; + +/// ## What it does +/// Checks for subclasses of `dict`, `list` or `str`. +/// +/// ## Why is this bad? +/// Built-in types don't consistently use their own dunder methods. For example, +/// `dict.__init__` and `dict.update()` bypass `__setitem__`, making inheritance unreliable. +/// +/// Use the `UserDict`, `UserList`, and `UserString` objects from the `collections` module +/// instead. +/// +/// ## Example +/// +/// ```python +/// class UppercaseDict(dict): +/// def __setitem__(self, key, value): +/// super().__setitem__(key.upper(), value) +/// +/// +/// d = UppercaseDict({"a": 1, "b": 2}) # Bypasses __setitem__ +/// print(d) # {'a': 1, 'b': 2} +/// ``` +/// +/// Use instead: +/// +/// ```python +/// from collections import UserDict +/// +/// +/// class UppercaseDict(UserDict): +/// def __setitem__(self, key, value): +/// super().__setitem__(key.upper(), value) +/// +/// +/// d = UppercaseDict({"a": 1, "b": 2}) # Uses __setitem__ +/// print(d) # {'A': 1, 'B': 2} +/// ``` +/// +/// ## Fix safety +/// This fix is marked as unsafe because `isinstance()` checks for `dict`, +/// `list`, and `str` types will fail when using the corresponding User class. +/// If you need to pass custom `dict` or `list` objects to code you don't +/// control, ignore this check. If you do control the code, consider using +/// the following type checks instead: +/// +/// * `dict` -> `collections.abc.MutableMapping` +/// * `list` -> `collections.abc.MutableSequence` +/// * `str` -> No such conversion exists +/// +/// ## References +/// +/// - [Python documentation: `collections`](https://docs.python.org/3/library/collections.html) +#[derive(ViolationMetadata)] +pub(crate) struct SubclassBuiltin { + subclass: String, + replacement: String, +} + +impl AlwaysFixableViolation for SubclassBuiltin { + #[derive_message_formats] + fn message(&self) -> String { + let SubclassBuiltin { + subclass, + replacement, + } = self; + format!( + "Subclassing `{subclass}` can be error prone, use `collections.{replacement}` instead" + ) + } + + fn fix_title(&self) -> String { + let SubclassBuiltin { replacement, .. } = self; + format!("Replace with `collections.{replacement}`") + } +} + +/// FURB189 +pub(crate) fn subclass_builtin(checker: &Checker, class: &StmtClassDef) { + let Some(Arguments { args: bases, .. }) = class.arguments.as_deref() else { + return; + }; + + // Expect only one base class else return + let [base] = &**bases else { + return; + }; + + // Check if the base class is a subscript expression so that only the name expr + // is checked and modified. + let base_expr = map_subscript(base); + + let Some(symbol) = checker.semantic().resolve_builtin_symbol(base_expr) else { + return; + }; + + let Some(supported_builtin) = SupportedBuiltins::from_symbol(symbol) else { + return; + }; + + let user_symbol = supported_builtin.user_symbol(); + + let mut diagnostic = Diagnostic::new( + SubclassBuiltin { + subclass: symbol.to_string(), + replacement: user_symbol.to_string(), + }, + base_expr.range(), + ); + diagnostic.try_set_fix(|| { + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import_from("collections", user_symbol), + base.start(), + checker.semantic(), + )?; + let other_edit = Edit::range_replacement(binding, base_expr.range()); + Ok(Fix::unsafe_edits(import_edit, [other_edit])) + }); + checker.report_diagnostic(diagnostic); +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum SupportedBuiltins { + Str, + List, + Dict, +} + +impl SupportedBuiltins { + fn from_symbol(value: &str) -> Option<SupportedBuiltins> { + match value { + "str" => Some(Self::Str), + "dict" => Some(Self::Dict), + "list" => Some(Self::List), + _ => None, + } + } + + const fn user_symbol(self) -> &'static str { + match self { + SupportedBuiltins::Dict => "UserDict", + SupportedBuiltins::List => "UserList", + SupportedBuiltins::Str => "UserString", + } + } +} diff --git a/crates/ruff_linter/src/rules/refurb/rules/type_none_comparison.rs b/crates/ruff_linter/src/rules/refurb/rules/type_none_comparison.rs index 6f714b99c6f4e..e3abea331979f 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/type_none_comparison.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/type_none_comparison.rs @@ -1,17 +1,13 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::name::Name; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, CmpOp, Expr}; use ruff_python_semantic::SemanticModel; -use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::fix::edits::pad; -use crate::rules::refurb::helpers::generate_none_identity_comparison; +use crate::rules::refurb::helpers::replace_with_identity_check; /// ## What it does -/// Checks for uses of `type` that compare the type of an object to the type of -/// `None`. +/// Checks for uses of `type` that compare the type of an object to the type of `None`. /// /// ## Why is this bad? /// There is only ever one instance of `None`, so it is more efficient and @@ -27,53 +23,45 @@ use crate::rules::refurb::helpers::generate_none_identity_comparison; /// obj is None /// ``` /// +/// ## Fix safety +/// If the fix might remove comments, it will be marked as unsafe. +/// /// ## References /// - [Python documentation: `isinstance`](https://docs.python.org/3/library/functions.html#isinstance) /// - [Python documentation: `None`](https://docs.python.org/3/library/constants.html#None) /// - [Python documentation: `type`](https://docs.python.org/3/library/functions.html#type) /// - [Python documentation: Identity comparisons](https://docs.python.org/3/reference/expressions.html#is-not) -#[violation] -pub struct TypeNoneComparison { - object: Name, - comparison: Comparison, +#[derive(ViolationMetadata)] +pub(crate) struct TypeNoneComparison { + replacement: IdentityCheck, } -impl Violation for TypeNoneComparison { - const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; - +impl AlwaysFixableViolation for TypeNoneComparison { #[derive_message_formats] fn message(&self) -> String { - let TypeNoneComparison { object, .. } = self; - format!("Compare the identities of `{object}` and `None` instead of their respective types") + format!( + "When checking against `None`, use `{}` instead of comparison with `type(None)`", + self.replacement.op() + ) } - fn fix_title(&self) -> Option<String> { - let TypeNoneComparison { object, comparison } = self; - match comparison { - Comparison::Is | Comparison::Eq => Some(format!("Replace with `{object} is None`")), - Comparison::IsNot | Comparison::NotEq => { - Some(format!("Replace with `{object} is not None`")) - } - } + fn fix_title(&self) -> String { + format!("Replace with `{} None`", self.replacement.op()) } } /// FURB169 -pub(crate) fn type_none_comparison(checker: &mut Checker, compare: &ast::ExprCompare) { +pub(crate) fn type_none_comparison(checker: &Checker, compare: &ast::ExprCompare) { let ([op], [right]) = (&*compare.ops, &*compare.comparators) else { return; }; - // Ensure that the comparison is an identity or equality test. - let comparison = match op { - CmpOp::Is => Comparison::Is, - CmpOp::IsNot => Comparison::IsNot, - CmpOp::Eq => Comparison::Eq, - CmpOp::NotEq => Comparison::NotEq, + let replacement = match op { + CmpOp::Is | CmpOp::Eq => IdentityCheck::Is, + CmpOp::IsNot | CmpOp::NotEq => IdentityCheck::IsNot, _ => return, }; - // Get the objects whose types are being compared. let Some(left_arg) = type_call_arg(&compare.left, checker.semantic()) else { return; }; @@ -81,48 +69,18 @@ pub(crate) fn type_none_comparison(checker: &mut Checker, compare: &ast::ExprCom return; }; - // If one of the objects is `None`, get the other object; else, return. - let other_arg = match ( - left_arg.is_none_literal_expr(), - right_arg.is_none_literal_expr(), - ) { - (true, false) => right_arg, - (false, true) => left_arg, - // If both are `None`, just pick one. - (true, true) => left_arg, + let other_arg = match (left_arg, right_arg) { + (Expr::NoneLiteral(_), _) => right_arg, + (_, Expr::NoneLiteral(_)) => left_arg, _ => return, }; - // Get the name of the other object (or `None` if both were `None`). - let other_arg_name = match other_arg { - Expr::Name(ast::ExprName { id, .. }) => id.clone(), - Expr::NoneLiteral { .. } => Name::new_static("None"), - _ => return, - }; + let diagnostic = Diagnostic::new(TypeNoneComparison { replacement }, compare.range); - let mut diagnostic = Diagnostic::new( - TypeNoneComparison { - object: other_arg_name.clone(), - comparison, - }, - compare.range(), - ); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - pad( - match comparison { - Comparison::Is | Comparison::Eq => { - generate_none_identity_comparison(other_arg_name, false, checker.generator()) - } - Comparison::IsNot | Comparison::NotEq => { - generate_none_identity_comparison(other_arg_name, true, checker.generator()) - } - }, - compare.range(), - checker.locator(), - ), - compare.range(), - ))); - checker.diagnostics.push(diagnostic); + let negate = replacement == IdentityCheck::IsNot; + let fix = replace_with_identity_check(other_arg, compare.range, negate, checker); + + checker.report_diagnostic(diagnostic.with_fix(fix)); } /// Returns the object passed to the function, if the expression is a call to @@ -143,9 +101,16 @@ fn type_call_arg<'a>(expr: &'a Expr, semantic: &'a SemanticModel) -> Option<&'a } #[derive(Debug, Clone, Copy, PartialEq, Eq)] -enum Comparison { +enum IdentityCheck { Is, IsNot, - Eq, - NotEq, +} + +impl IdentityCheck { + fn op(self) -> CmpOp { + match self { + Self::Is => CmpOp::Is, + Self::IsNot => CmpOp::IsNot, + } + } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/unnecessary_enumerate.rs b/crates/ruff_linter/src/rules/refurb/rules/unnecessary_enumerate.rs index 5455233b8fec0..36cd8b137aff5 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/unnecessary_enumerate.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/unnecessary_enumerate.rs @@ -1,7 +1,7 @@ use std::fmt; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::name::Name; use ruff_python_ast::{Arguments, Expr, Int}; @@ -57,8 +57,8 @@ use crate::fix::edits::pad; /// - [Python documentation: `enumerate`](https://docs.python.org/3/library/functions.html#enumerate) /// - [Python documentation: `range`](https://docs.python.org/3/library/stdtypes.html#range) /// - [Python documentation: `len`](https://docs.python.org/3/library/functions.html#len) -#[violation] -pub struct UnnecessaryEnumerate { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryEnumerate { subset: EnumerateSubset, } @@ -67,28 +67,27 @@ impl Violation for UnnecessaryEnumerate { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryEnumerate { subset } = self; - match subset { + match self.subset { EnumerateSubset::Indices => { - format!("`enumerate` value is unused, use `for x in range(len(y))` instead") + "`enumerate` value is unused, use `for x in range(len(y))` instead".to_string() } EnumerateSubset::Values => { - format!("`enumerate` index is unused, use `for x in y` instead") + "`enumerate` index is unused, use `for x in y` instead".to_string() } } } fn fix_title(&self) -> Option<String> { - let UnnecessaryEnumerate { subset } = self; - match subset { - EnumerateSubset::Indices => Some("Replace with `range(len(...))`".to_string()), - EnumerateSubset::Values => Some("Remove `enumerate`".to_string()), - } + let title = match self.subset { + EnumerateSubset::Indices => "Replace with `range(len(...))`", + EnumerateSubset::Values => "Remove `enumerate`", + }; + Some(title.to_string()) } } /// FURB148 -pub(crate) fn unnecessary_enumerate(checker: &mut Checker, stmt_for: &ast::StmtFor) { +pub(crate) fn unnecessary_enumerate(checker: &Checker, stmt_for: &ast::StmtFor) { // Check the for statement is of the form `for x, y in func(...)`. let Expr::Tuple(ast::ExprTuple { elts, .. }) = stmt_for.target.as_ref() else { return; @@ -145,7 +144,7 @@ pub(crate) fn unnecessary_enumerate(checker: &mut Checker, stmt_for: &ast::StmtF ); diagnostic.set_fix(Fix::unsafe_edits(replace_iter, [replace_target])); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } (false, true) => { // Ensure the sequence object works with `len`. If it doesn't, the @@ -179,8 +178,8 @@ pub(crate) fn unnecessary_enumerate(checker: &mut Checker, stmt_for: &ast::StmtF { // If the `start` argument is set to something other than the `range` default, // there's no clear fix. - let start = arguments.find_argument("start", 1); - if start.map_or(true, |start| { + let start = arguments.find_argument_value("start", 1); + if start.is_none_or(|start| { matches!( start, Expr::NumberLiteral(ast::ExprNumberLiteral { @@ -206,7 +205,7 @@ pub(crate) fn unnecessary_enumerate(checker: &mut Checker, stmt_for: &ast::StmtF diagnostic.set_fix(Fix::unsafe_edits(replace_iter, [replace_target])); } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/refurb/rules/unnecessary_from_float.rs b/crates/ruff_linter/src/rules/refurb/rules/unnecessary_from_float.rs index f37f6f25a473f..549608ca16086 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/unnecessary_from_float.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/unnecessary_from_float.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprCall}; use ruff_text_size::Ranged; @@ -15,7 +15,7 @@ use crate::checkers::ast::Checker; /// the use of `from_float` and `from_decimal` methods is unnecessary, and /// should be avoided in favor of the more concise constructor syntax. /// -/// ## Examples +/// ## Example /// ```python /// Decimal.from_float(4.2) /// Decimal.from_float(float("inf")) @@ -34,8 +34,8 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `decimal`](https://docs.python.org/3/library/decimal.html) /// - [Python documentation: `fractions`](https://docs.python.org/3/library/fractions.html) -#[violation] -pub struct UnnecessaryFromFloat { +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryFromFloat { method_name: MethodName, constructor: Constructor, } @@ -59,7 +59,7 @@ impl Violation for UnnecessaryFromFloat { } /// FURB164 -pub(crate) fn unnecessary_from_float(checker: &mut Checker, call: &ExprCall) { +pub(crate) fn unnecessary_from_float(checker: &Checker, call: &ExprCall) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = &*call.func else { return; }; @@ -109,14 +109,14 @@ pub(crate) fn unnecessary_from_float(checker: &mut Checker, call: &ExprCall) { 'short_circuit: { if !matches!(constructor, Constructor::Decimal) { break 'short_circuit; - }; + } if !(method_name == MethodName::FromFloat) { break 'short_circuit; - }; + } let Some(value) = (match method_name { - MethodName::FromFloat => call.arguments.find_argument("f", 0), - MethodName::FromDecimal => call.arguments.find_argument("dec", 0), + MethodName::FromFloat => call.arguments.find_argument_value("f", 0), + MethodName::FromDecimal => call.arguments.find_argument_value("dec", 0), }) else { return; }; @@ -131,9 +131,9 @@ pub(crate) fn unnecessary_from_float(checker: &mut Checker, call: &ExprCall) { }; // Must have exactly one argument, which is a string literal. - if arguments.keywords.len() != 0 { + if !arguments.keywords.is_empty() { break 'short_circuit; - }; + } let [float] = arguments.args.as_ref() else { break 'short_circuit; }; @@ -150,20 +150,20 @@ pub(crate) fn unnecessary_from_float(checker: &mut Checker, call: &ExprCall) { // Must be a call to the `float` builtin. if !semantic.match_builtin_expr(func, "float") { break 'short_circuit; - }; + } let replacement = checker.locator().slice(float).to_string(); diagnostic.set_fix(Fix::safe_edits( edit, [Edit::range_replacement(replacement, call.range())], )); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); return; } diagnostic.set_fix(Fix::safe_edit(edit)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } #[derive(Debug, Copy, Clone, PartialEq, Eq)] diff --git a/crates/ruff_linter/src/rules/refurb/rules/verbose_decimal_constructor.rs b/crates/ruff_linter/src/rules/refurb/rules/verbose_decimal_constructor.rs index 952e396070c5f..a37996e60cb6a 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/verbose_decimal_constructor.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/verbose_decimal_constructor.rs @@ -1,8 +1,9 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; use ruff_python_trivia::PythonWhitespace; use ruff_text_size::Ranged; +use std::borrow::Cow; use crate::checkers::ast::Checker; @@ -36,8 +37,8 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `decimal`](https://docs.python.org/3/library/decimal.html) -#[violation] -pub struct VerboseDecimalConstructor { +#[derive(ViolationMetadata)] +pub(crate) struct VerboseDecimalConstructor { replacement: String, } @@ -46,7 +47,7 @@ impl Violation for VerboseDecimalConstructor { #[derive_message_formats] fn message(&self) -> String { - format!("Verbose expression in `Decimal` constructor") + "Verbose expression in `Decimal` constructor".to_string() } fn fix_title(&self) -> Option<String> { @@ -56,7 +57,7 @@ impl Violation for VerboseDecimalConstructor { } /// FURB157 -pub(crate) fn verbose_decimal_constructor(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn verbose_decimal_constructor(checker: &Checker, call: &ast::ExprCall) { if !checker .semantic() .resolve_qualified_name(&call.func) @@ -66,7 +67,7 @@ pub(crate) fn verbose_decimal_constructor(checker: &mut Checker, call: &ast::Exp } // Decimal accepts arguments of the form: `Decimal(value='0', context=None)` - let Some(value) = call.arguments.find_argument("value", 0) else { + let Some(value) = call.arguments.find_argument_value("value", 0) else { return; }; @@ -75,27 +76,48 @@ pub(crate) fn verbose_decimal_constructor(checker: &mut Checker, call: &ast::Exp value: str_literal, .. }) => { // Parse the inner string as an integer. - let trimmed = str_literal.to_str().trim_whitespace(); - + // + // For reference, a string argument to `Decimal` is parsed in CPython + // using this regex: + // https://github.com/python/cpython/blob/ac556a2ad1213b8bb81372fe6fb762f5fcb076de/Lib/_pydecimal.py#L6060-L6077 + // _after_ trimming whitespace from the string and removing all occurrences of "_". + let mut trimmed = Cow::from(str_literal.to_str().trim_whitespace()); + if memchr::memchr(b'_', trimmed.as_bytes()).is_some() { + trimmed = Cow::from(trimmed.replace('_', "")); + } // Extract the unary sign, if any. let (unary, rest) = if let Some(trimmed) = trimmed.strip_prefix('+') { - ("+", trimmed) + ("+", Cow::from(trimmed)) } else if let Some(trimmed) = trimmed.strip_prefix('-') { - ("-", trimmed) + ("-", Cow::from(trimmed)) } else { ("", trimmed) }; + // Early return if we now have an empty string + // or a very long string: + if (rest.len() > PYTHONINTMAXSTRDIGITS) || (rest.is_empty()) { + return; + } + // Skip leading zeros. let rest = rest.trim_start_matches('0'); // Verify that the rest of the string is a valid integer. - if !rest.chars().all(|c| c.is_ascii_digit()) { + if !rest.bytes().all(|c| c.is_ascii_digit()) { return; - }; + } // If all the characters are zeros, then the value is zero. - let rest = if rest.is_empty() { "0" } else { rest }; + let rest = match (unary, rest.is_empty()) { + // `Decimal("-0")` is not the same as `Decimal("0")` + // so we return early. + ("-", true) => { + return; + } + (_, true) => "0", + _ => rest, + }; let replacement = format!("{unary}{rest}"); let mut diagnostic = Diagnostic::new( @@ -118,26 +140,50 @@ pub(crate) fn verbose_decimal_constructor(checker: &mut Checker, call: &ast::Exp // Must be a call to the `float` builtin. if !checker.semantic().match_builtin_expr(func, "float") { return; - }; + } // Must have exactly one argument, which is a string literal. - if arguments.keywords.len() != 0 { + if !arguments.keywords.is_empty() { return; - }; + } let [float] = arguments.args.as_ref() else { return; }; let Some(float) = float.as_string_literal_expr() else { return; }; - if !matches!( - float.value.to_str().to_lowercase().as_str(), - "inf" | "-inf" | "infinity" | "-infinity" | "nan" - ) { + + let trimmed = float.value.to_str().trim(); + let mut matches_non_finite_keyword = false; + for non_finite_keyword in [ + "inf", + "+inf", + "-inf", + "infinity", + "+infinity", + "-infinity", + "nan", + "+nan", + "-nan", + ] { + if trimmed.eq_ignore_ascii_case(non_finite_keyword) { + matches_non_finite_keyword = true; + break; + } + } + if !matches_non_finite_keyword { return; } - let replacement = checker.locator().slice(float).to_string(); + let mut replacement = checker.locator().slice(float).to_string(); + // `Decimal(float("-nan")) == Decimal("nan")` + if trimmed.eq_ignore_ascii_case("-nan") { + // Here we do not attempt to remove just the '-' character. + // It may have been encoded (e.g. as '\N{hyphen-minus}') + // in the original source slice, and the added complexity + // does not make sense for this edge case. + replacement = "\"nan\"".to_string(); + } let mut diagnostic = Diagnostic::new( VerboseDecimalConstructor { replacement: replacement.clone(), @@ -157,5 +203,13 @@ pub(crate) fn verbose_decimal_constructor(checker: &mut Checker, call: &ast::Exp } }; - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } + +// ```console +// $ python +// >>> import sys +// >>> sys.int_info.str_digits_check_threshold +// 640 +// ``` +const PYTHONINTMAXSTRDIGITS: usize = 640; diff --git a/crates/ruff_linter/src/rules/refurb/rules/write_whole_file.rs b/crates/ruff_linter/src/rules/refurb/rules/write_whole_file.rs index b9993e2b34432..5605918c69739 100644 --- a/crates/ruff_linter/src/rules/refurb/rules/write_whole_file.rs +++ b/crates/ruff_linter/src/rules/refurb/rules/write_whole_file.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::relocate::relocate_expr; use ruff_python_ast::visitor::{self, Visitor}; use ruff_python_ast::{self as ast, Expr, Stmt}; @@ -9,7 +9,7 @@ use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; -use super::super::helpers::{find_file_opens, FileOpen}; +use super::super::helpers::{FileOpen, find_file_opens}; /// ## What it does /// Checks for uses of `open` and `write` that can be replaced by `pathlib` @@ -36,8 +36,8 @@ use super::super::helpers::{find_file_opens, FileOpen}; /// ## References /// - [Python documentation: `Path.write_bytes`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_bytes) /// - [Python documentation: `Path.write_text`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_text) -#[violation] -pub struct WriteWholeFile { +#[derive(ViolationMetadata)] +pub(crate) struct WriteWholeFile { filename: SourceCodeSnippet, suggestion: SourceCodeSnippet, } @@ -52,72 +52,41 @@ impl Violation for WriteWholeFile { } /// FURB103 -pub(crate) fn write_whole_file(checker: &mut Checker, with: &ast::StmtWith) { +pub(crate) fn write_whole_file(checker: &Checker, with: &ast::StmtWith) { // `async` check here is more of a precaution. if with.is_async { return; } // First we go through all the items in the statement and find all `open` operations. - let candidates = find_file_opens( - with, - checker.semantic(), - false, - checker.settings.target_version, - ); + let candidates = find_file_opens(with, checker.semantic(), false, checker.target_version()); if candidates.is_empty() { return; } // Then we need to match each `open` operation with exactly one `write` call. - let (matches, contents) = { - let mut matcher = WriteMatcher::new(candidates); - visitor::walk_body(&mut matcher, &with.body); - matcher.finish() - }; - - // All the matched operations should be reported. - let diagnostics: Vec<Diagnostic> = matches - .iter() - .zip(contents) - .map(|(open, content)| { - Diagnostic::new( - WriteWholeFile { - filename: SourceCodeSnippet::from_str(&checker.generator().expr(open.filename)), - suggestion: make_suggestion(open, content, checker.generator()), - }, - open.item.range(), - ) - }) - .collect(); - checker.diagnostics.extend(diagnostics); + let mut matcher = WriteMatcher::new(checker, candidates); + visitor::walk_body(&mut matcher, &with.body); } /// AST visitor that matches `open` operations with the corresponding `write` calls. -#[derive(Debug)] -struct WriteMatcher<'a> { +struct WriteMatcher<'a, 'b> { + checker: &'a Checker<'b>, candidates: Vec<FileOpen<'a>>, - matches: Vec<FileOpen<'a>>, - contents: Vec<&'a Expr>, loop_counter: u32, } -impl<'a> WriteMatcher<'a> { - fn new(candidates: Vec<FileOpen<'a>>) -> Self { +impl<'a, 'b> WriteMatcher<'a, 'b> { + fn new(checker: &'a Checker<'b>, candidates: Vec<FileOpen<'a>>) -> Self { Self { + checker, candidates, - matches: vec![], - contents: vec![], loop_counter: 0, } } - - fn finish(self) -> (Vec<FileOpen<'a>>, Vec<&'a Expr>) { - (self.matches, self.contents) - } } -impl<'a> Visitor<'a> for WriteMatcher<'a> { +impl<'a> Visitor<'a> for WriteMatcher<'a, '_> { fn visit_stmt(&mut self, stmt: &'a Stmt) { if matches!(stmt, ast::Stmt::While(_) | ast::Stmt::For(_)) { self.loop_counter += 1; @@ -136,8 +105,16 @@ impl<'a> Visitor<'a> for WriteMatcher<'a> { .position(|open| open.is_ref(write_to)) { if self.loop_counter == 0 { - self.matches.push(self.candidates.remove(open)); - self.contents.push(content); + let open = self.candidates.remove(open); + self.checker.report_diagnostic(Diagnostic::new( + WriteWholeFile { + filename: SourceCodeSnippet::from_str( + &self.checker.generator().expr(open.filename), + ), + suggestion: make_suggestion(&open, content, self.checker.generator()), + }, + open.item.range(), + )); } else { self.candidates.remove(open); } diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB101_FURB101.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB101_FURB101.py.snap index b3db05568d87f..7e1899006c664 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB101_FURB101.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB101_FURB101.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB101.py:12:6: FURB101 `open` and `read` should be replaced by `Path("file.txt").read_text()` | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB103_FURB103.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB103_FURB103.py.snap index 7a25e911648aa..81a420fbc80b7 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB103_FURB103.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB103_FURB103.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB103.py:12:6: FURB103 `open` and `write` should be replaced by `Path("file.txt").write_text("test")` | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB105_FURB105.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB105_FURB105.py.snap index fc552a58e7e0e..f4db6c7a569d4 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB105_FURB105.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB105_FURB105.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB105.py:3:1: FURB105 [*] Unnecessary empty string passed to `print` | 1 | # Errors. -2 | +2 | 3 | print("") | ^^^^^^^^^ FURB105 4 | print("", sep=",") @@ -361,7 +361,7 @@ FURB105.py:21:1: FURB105 [*] Unnecessary separator passed to `print` 20 | print(sep="\t") 21 | print(sep=print(1)) | ^^^^^^^^^^^^^^^^^^^ FURB105 -22 | +22 | 23 | # OK. | = help: Remove separator diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB110_FURB110.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB110_FURB110.py.snap index 29e977193e329..cea81dcdd4c3c 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB110_FURB110.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB110_FURB110.py.snap @@ -5,7 +5,7 @@ FURB110.py:1:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 1 | z = x if x else y # FURB110 | ^^^^^^^^^^^^^ FURB110 -2 | +2 | 3 | z = x \ | = help: Replace with `or` operator @@ -20,12 +20,12 @@ FURB110.py:1:5: FURB110 [*] Replace ternary `if` expression with `or` operator FURB110.py:3:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 1 | z = x if x else y # FURB110 -2 | +2 | 3 | z = x \ | _____^ 4 | | if x else y # FURB110 | |_______________^ FURB110 -5 | +5 | 6 | z = x if x \ | = help: Replace with `or` operator @@ -43,13 +43,13 @@ FURB110.py:3:5: FURB110 [*] Replace ternary `if` expression with `or` operator FURB110.py:6:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 4 | if x else y # FURB110 - 5 | + 5 | 6 | z = x if x \ | _____^ 7 | | else \ 8 | | y # FURB110 | |_________^ FURB110 - 9 | + 9 | 10 | z = x() if x() else y() # FURB110 | = help: Replace with `or` operator @@ -69,10 +69,10 @@ FURB110.py:6:5: FURB110 [*] Replace ternary `if` expression with `or` operator FURB110.py:10:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 8 | y # FURB110 - 9 | + 9 | 10 | z = x() if x() else y() # FURB110 | ^^^^^^^^^^^^^^^^^^^ FURB110 -11 | +11 | 12 | # FURB110 | = help: Replace with `or` operator @@ -99,7 +99,7 @@ FURB110.py:13:5: FURB110 [*] Replace ternary `if` expression with `or` operator 18 | | y 19 | | ) | |_^ FURB110 -20 | +20 | 21 | # FURB110 | = help: Replace with `or` operator @@ -122,8 +122,7 @@ FURB110.py:23:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 21 | # FURB110 22 | z = ( -23 | x if ( - | _____^ +23 | / x if ( 24 | | # Test for x. 25 | | x 26 | | ) else ( @@ -153,8 +152,7 @@ FURB110.py:34:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 32 | # FURB110 33 | z = ( -34 | x if - | _____^ +34 | / x if 35 | | # If true, use x. 36 | | x 37 | | # Otherwise, use y. @@ -184,8 +182,7 @@ FURB110.py:44:5: FURB110 [*] Replace ternary `if` expression with `or` operator | 42 | # FURB110 43 | z = ( -44 | x - | _____^ +44 | / x 45 | | if x 46 | | else y 47 | | if y > 0 diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB113_FURB113.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB113_FURB113.py.snap index 07e89d33ac934..401cf40ff61e0 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB113_FURB113.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB113_FURB113.py.snap @@ -155,8 +155,7 @@ FURB113.py:69:5: FURB113 [*] Use `nums.extend((1, 2))` instead of repeatedly cal | 67 | if True: 68 | # FURB113 -69 | nums.append(1) - | _____^ +69 | / nums.append(1) 70 | | nums.append(2) | |__________________^ FURB113 | @@ -177,8 +176,7 @@ FURB113.py:75:5: FURB113 [*] Use `nums.extend((1, 2))` instead of repeatedly cal | 73 | if True: 74 | # FURB113 -75 | nums.append(1) - | _____^ +75 | / nums.append(1) 76 | | nums.append(2) | |__________________^ FURB113 77 | pass @@ -200,8 +198,7 @@ FURB113.py:82:5: FURB113 Use `nums.extend((1, 2, 3))` instead of repeatedly call | 80 | if True: 81 | # FURB113 -82 | nums.append(1) - | _____^ +82 | / nums.append(1) 83 | | nums2.append(1) 84 | | nums.append(2) 85 | | nums.append(3) @@ -213,8 +210,7 @@ FURB113.py:90:5: FURB113 [*] Use `x.extend((1, 2))` instead of repeatedly callin | 88 | def yes_one(x: list[int]): 89 | # FURB113 -90 | x.append(1) - | _____^ +90 | / x.append(1) 91 | | x.append(2) | |_______________^ FURB113 | @@ -235,8 +231,7 @@ FURB113.py:96:5: FURB113 [*] Use `x.extend((1, 2))` instead of repeatedly callin | 94 | def yes_two(x: List[int]): 95 | # FURB113 -96 | x.append(1) - | _____^ +96 | / x.append(1) 97 | | x.append(2) | |_______________^ FURB113 | @@ -257,8 +252,7 @@ FURB113.py:102:5: FURB113 [*] Use `x.extend((1, 2))` instead of repeatedly calli | 100 | def yes_three(*, x: list[int]): 101 | # FURB113 -102 | x.append(1) - | _____^ +102 | / x.append(1) 103 | | x.append(2) | |_______________^ FURB113 | @@ -279,8 +273,7 @@ FURB113.py:108:5: FURB113 [*] Use `x.extend((1, 2))` instead of repeatedly calli | 106 | def yes_four(x: list[int], /): 107 | # FURB113 -108 | x.append(1) - | _____^ +108 | / x.append(1) 109 | | x.append(2) | |_______________^ FURB113 | @@ -301,8 +294,7 @@ FURB113.py:114:5: FURB113 Use `x.extend((1, 2, 3))` instead of repeatedly callin | 112 | def yes_five(x: list[int], y: list[int]): 113 | # FURB113 -114 | x.append(1) - | _____^ +114 | / x.append(1) 115 | | x.append(2) 116 | | y.append(1) 117 | | x.append(3) @@ -314,8 +306,7 @@ FURB113.py:122:5: FURB113 [*] Use `x.extend((1, 2))` instead of repeatedly calli | 120 | def yes_six(x: list): 121 | # FURB113 -122 | x.append(1) - | _____^ +122 | / x.append(1) 123 | | x.append(2) | |_______________^ FURB113 | @@ -336,8 +327,7 @@ FURB113.py:128:5: FURB113 Use `nums.extend((1, 2, 3))` instead of repeatedly cal | 126 | if True: 127 | # FURB113 -128 | nums.append(1) - | _____^ +128 | / nums.append(1) 129 | | # comment 130 | | nums.append(2) 131 | | # comment @@ -345,5 +335,3 @@ FURB113.py:128:5: FURB113 Use `nums.extend((1, 2, 3))` instead of repeatedly cal | |__________________^ FURB113 | = help: Replace with `nums.extend((1, 2, 3))` - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB116_FURB116.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB116_FURB116.py.snap index 02e102a7ba6fb..c39547d551468 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB116_FURB116.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB116_FURB116.py.snap @@ -1,144 +1,288 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs --- -FURB116.py:6:7: FURB116 [*] Replace `oct` call with `f"{num:o}"` - | -4 | return num -5 | -6 | print(oct(num)[2:]) # FURB116 - | ^^^^^^^^^^^^ FURB116 -7 | print(hex(num)[2:]) # FURB116 -8 | print(bin(num)[2:]) # FURB116 - | - = help: Replace with `f"{num:o}"` +FURB116.py:9:7: FURB116 Replace `oct` call with `f"{num:o}"` + | + 7 | return num + 8 | + 9 | print(oct(num)[2:]) # FURB116 + | ^^^^^^^^^^^^ FURB116 +10 | print(hex(num)[2:]) # FURB116 +11 | print(bin(num)[2:]) # FURB116 + | + = help: Replace with `f"{num:o}"` -ℹ Safe fix -3 3 | def return_num() -> int: -4 4 | return num -5 5 | -6 |-print(oct(num)[2:]) # FURB116 - 6 |+print(f"{num:o}") # FURB116 -7 7 | print(hex(num)[2:]) # FURB116 -8 8 | print(bin(num)[2:]) # FURB116 -9 9 | - -FURB116.py:7:7: FURB116 [*] Replace `hex` call with `f"{num:x}"` - | -6 | print(oct(num)[2:]) # FURB116 -7 | print(hex(num)[2:]) # FURB116 - | ^^^^^^^^^^^^ FURB116 -8 | print(bin(num)[2:]) # FURB116 - | - = help: Replace with `f"{num:x}"` +ℹ Display-only fix +6 6 | def return_num() -> int: +7 7 | return num +8 8 | +9 |-print(oct(num)[2:]) # FURB116 + 9 |+print(f"{num:o}") # FURB116 +10 10 | print(hex(num)[2:]) # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | -ℹ Safe fix -4 4 | return num -5 5 | -6 6 | print(oct(num)[2:]) # FURB116 -7 |-print(hex(num)[2:]) # FURB116 - 7 |+print(f"{num:x}") # FURB116 -8 8 | print(bin(num)[2:]) # FURB116 -9 9 | -10 10 | print(oct(1337)[2:]) # FURB116 - -FURB116.py:8:7: FURB116 [*] Replace `bin` call with `f"{num:b}"` - | - 6 | print(oct(num)[2:]) # FURB116 - 7 | print(hex(num)[2:]) # FURB116 - 8 | print(bin(num)[2:]) # FURB116 +FURB116.py:10:7: FURB116 Replace `hex` call with `f"{num:x}"` + | + 9 | print(oct(num)[2:]) # FURB116 +10 | print(hex(num)[2:]) # FURB116 | ^^^^^^^^^^^^ FURB116 - 9 | -10 | print(oct(1337)[2:]) # FURB116 +11 | print(bin(num)[2:]) # FURB116 + | + = help: Replace with `f"{num:x}"` + +ℹ Display-only fix +7 7 | return num +8 8 | +9 9 | print(oct(num)[2:]) # FURB116 +10 |-print(hex(num)[2:]) # FURB116 + 10 |+print(f"{num:x}") # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 + +FURB116.py:11:7: FURB116 Replace `bin` call with `f"{num:b}"` + | + 9 | print(oct(num)[2:]) # FURB116 +10 | print(hex(num)[2:]) # FURB116 +11 | print(bin(num)[2:]) # FURB116 + | ^^^^^^^^^^^^ FURB116 +12 | +13 | print(oct(1337)[2:]) # FURB116 | = help: Replace with `f"{num:b}"` -ℹ Safe fix -5 5 | -6 6 | print(oct(num)[2:]) # FURB116 -7 7 | print(hex(num)[2:]) # FURB116 -8 |-print(bin(num)[2:]) # FURB116 - 8 |+print(f"{num:b}") # FURB116 -9 9 | -10 10 | print(oct(1337)[2:]) # FURB116 -11 11 | print(hex(1337)[2:]) # FURB116 - -FURB116.py:10:7: FURB116 [*] Replace `oct` call with `f"{1337:o}"` - | - 8 | print(bin(num)[2:]) # FURB116 - 9 | -10 | print(oct(1337)[2:]) # FURB116 +ℹ Display-only fix +8 8 | +9 9 | print(oct(num)[2:]) # FURB116 +10 10 | print(hex(num)[2:]) # FURB116 +11 |-print(bin(num)[2:]) # FURB116 + 11 |+print(f"{num:b}") # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 + +FURB116.py:13:7: FURB116 [*] Replace `oct` call with `f"{1337:o}"` + | +11 | print(bin(num)[2:]) # FURB116 +12 | +13 | print(oct(1337)[2:]) # FURB116 | ^^^^^^^^^^^^^ FURB116 -11 | print(hex(1337)[2:]) # FURB116 -12 | print(bin(1337)[2:]) # FURB116 +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 | = help: Replace with `f"{1337:o}"` ℹ Safe fix -7 7 | print(hex(num)[2:]) # FURB116 -8 8 | print(bin(num)[2:]) # FURB116 -9 9 | -10 |-print(oct(1337)[2:]) # FURB116 - 10 |+print(f"{1337:o}") # FURB116 -11 11 | print(hex(1337)[2:]) # FURB116 -12 12 | print(bin(1337)[2:]) # FURB116 -13 13 | - -FURB116.py:11:7: FURB116 [*] Replace `hex` call with `f"{1337:x}"` - | -10 | print(oct(1337)[2:]) # FURB116 -11 | print(hex(1337)[2:]) # FURB116 +10 10 | print(hex(num)[2:]) # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 |-print(oct(1337)[2:]) # FURB116 + 13 |+print(f"{1337:o}") # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 + +FURB116.py:14:7: FURB116 [*] Replace `hex` call with `f"{1337:x}"` + | +13 | print(oct(1337)[2:]) # FURB116 +14 | print(hex(1337)[2:]) # FURB116 | ^^^^^^^^^^^^^ FURB116 -12 | print(bin(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 +16 | print(bin(+1337)[2:]) # FURB116 | = help: Replace with `f"{1337:x}"` ℹ Safe fix -8 8 | print(bin(num)[2:]) # FURB116 -9 9 | -10 10 | print(oct(1337)[2:]) # FURB116 -11 |-print(hex(1337)[2:]) # FURB116 - 11 |+print(f"{1337:x}") # FURB116 -12 12 | print(bin(1337)[2:]) # FURB116 -13 13 | -14 14 | print(bin(return_num())[2:]) # FURB116 (no autofix) - -FURB116.py:12:7: FURB116 [*] Replace `bin` call with `f"{1337:b}"` - | -10 | print(oct(1337)[2:]) # FURB116 -11 | print(hex(1337)[2:]) # FURB116 -12 | print(bin(1337)[2:]) # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 |-print(hex(1337)[2:]) # FURB116 + 14 |+print(f"{1337:x}") # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 +17 17 | + +FURB116.py:15:7: FURB116 [*] Replace `bin` call with `f"{1337:b}"` + | +13 | print(oct(1337)[2:]) # FURB116 +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 | ^^^^^^^^^^^^^ FURB116 -13 | -14 | print(bin(return_num())[2:]) # FURB116 (no autofix) +16 | print(bin(+1337)[2:]) # FURB116 | = help: Replace with `f"{1337:b}"` ℹ Safe fix -9 9 | -10 10 | print(oct(1337)[2:]) # FURB116 -11 11 | print(hex(1337)[2:]) # FURB116 -12 |-print(bin(1337)[2:]) # FURB116 - 12 |+print(f"{1337:b}") # FURB116 -13 13 | -14 14 | print(bin(return_num())[2:]) # FURB116 (no autofix) -15 15 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) - -FURB116.py:14:7: FURB116 Replace `bin` call with f-string - | -12 | print(bin(1337)[2:]) # FURB116 -13 | -14 | print(bin(return_num())[2:]) # FURB116 (no autofix) +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 |-print(bin(1337)[2:]) # FURB116 + 15 |+print(f"{1337:b}") # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 +17 17 | +18 18 | print(bin(return_num())[2:]) # FURB116 (no autofix) + +FURB116.py:16:7: FURB116 [*] Replace `bin` call with `f"{+1337:b}"` + | +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 +16 | print(bin(+1337)[2:]) # FURB116 + | ^^^^^^^^^^^^^^ FURB116 +17 | +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) + | + = help: Replace with `f"{+1337:b}"` + +ℹ Safe fix +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 |-print(bin(+1337)[2:]) # FURB116 + 16 |+print(f"{+1337:b}") # FURB116 +17 17 | +18 18 | print(bin(return_num())[2:]) # FURB116 (no autofix) +19 19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) + +FURB116.py:18:7: FURB116 Replace `bin` call with f-string + | +16 | print(bin(+1337)[2:]) # FURB116 +17 | +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) | ^^^^^^^^^^^^^^^^^^^^^ FURB116 -15 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) +19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) | = help: Replace with f-string -FURB116.py:15:7: FURB116 Replace `bin` call with f-string +FURB116.py:19:7: FURB116 Replace `bin` call with f-string | -14 | print(bin(return_num())[2:]) # FURB116 (no autofix) -15 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) +19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) | ^^^^^^^^^^^^^^^^^^^^^^ FURB116 -16 | -17 | ## invalid +20 | +21 | ## invalid | = help: Replace with f-string + +FURB116.py:32:7: FURB116 Replace `bin` call with `f"{d:b}"` + | +30 | d = datetime.datetime.now(tz=datetime.UTC) +31 | # autofix is display-only +32 | print(bin(d)[2:]) + | ^^^^^^^^^^ FURB116 +33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 | print(bin(len("xyz").numerator)[2:]) + | + = help: Replace with `f"{d:b}"` + +ℹ Display-only fix +29 29 | +30 30 | d = datetime.datetime.now(tz=datetime.UTC) +31 31 | # autofix is display-only +32 |-print(bin(d)[2:]) + 32 |+print(f"{d:b}") +33 33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 34 | print(bin(len("xyz").numerator)[2:]) +35 35 | + +FURB116.py:34:7: FURB116 Replace `bin` call with `f"{len("xyz").numerator:b}"` + | +32 | print(bin(d)[2:]) +33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 | print(bin(len("xyz").numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +35 | +36 | # autofix is display-only + | + = help: Replace with `f"{len("xyz").numerator:b}"` + +ℹ Display-only fix +31 31 | # autofix is display-only +32 32 | print(bin(d)[2:]) +33 33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 |-print(bin(len("xyz").numerator)[2:]) + 34 |+print(f"{len("xyz").numerator:b}") +35 35 | +36 36 | # autofix is display-only +37 37 | print(bin({0: 1}[0].numerator)[2:]) + +FURB116.py:37:7: FURB116 Replace `bin` call with `f"{ {0: 1}[0].numerator:b}"` + | +36 | # autofix is display-only +37 | print(bin({0: 1}[0].numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) + | + = help: Replace with `f"{ {0: 1}[0].numerator:b}"` + +ℹ Display-only fix +34 34 | print(bin(len("xyz").numerator)[2:]) +35 35 | +36 36 | # autofix is display-only +37 |-print(bin({0: 1}[0].numerator)[2:]) + 37 |+print(f"{ {0: 1}[0].numerator:b}") +38 38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 39 | print(bin(ord("\\").numerator)[2:]) +40 40 | print(hex(sys + +FURB116.py:39:7: FURB116 Replace `bin` call with `f"{ord("\\").numerator:b}"` + | +37 | print(bin({0: 1}[0].numerator)[2:]) +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +40 | print(hex(sys +41 | .maxunicode)[2:]) + | + = help: Replace with `f"{ord("\\").numerator:b}"` + +ℹ Display-only fix +36 36 | # autofix is display-only +37 37 | print(bin({0: 1}[0].numerator)[2:]) +38 38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 |-print(bin(ord("\\").numerator)[2:]) + 39 |+print(f"{ord("\\").numerator:b}") +40 40 | print(hex(sys +41 41 | .maxunicode)[2:]) +42 42 | + +FURB116.py:40:7: FURB116 Replace `hex` call with f-string + | +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) +40 | print(hex(sys + | _______^ +41 | | .maxunicode)[2:]) + | |________________^ FURB116 +42 | +43 | # for negatives numbers autofix is display-only + | + = help: Replace with f-string + +ℹ Display-only fix +37 37 | print(bin({0: 1}[0].numerator)[2:]) +38 38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 39 | print(bin(ord("\\").numerator)[2:]) +40 |-print(hex(sys +41 |-.maxunicode)[2:]) + 40 |+print(f"{sys + 41 |+.maxunicode:x}") +42 42 | +43 43 | # for negatives numbers autofix is display-only +44 44 | print(bin(-1)[2:]) + +FURB116.py:44:7: FURB116 Replace `bin` call with `f"{-1:b}"` + | +43 | # for negatives numbers autofix is display-only +44 | print(bin(-1)[2:]) + | ^^^^^^^^^^^ FURB116 + | + = help: Replace with `f"{-1:b}"` + +ℹ Display-only fix +41 41 | .maxunicode)[2:]) +42 42 | +43 43 | # for negatives numbers autofix is display-only +44 |-print(bin(-1)[2:]) + 44 |+print(f"{-1:b}") diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB118_FURB118.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB118_FURB118.py.snap index 97bf4e8b85d42..f2efa2fbb203c 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB118_FURB118.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB118_FURB118.py.snap @@ -68,7 +68,7 @@ FURB118.py:5:10: FURB118 [*] Use `operator.neg` instead of defining a lambda 4 | op_pos = lambda x: +x 5 | op_neg = lambda x: -x | ^^^^^^^^^^^^ FURB118 -6 | +6 | 7 | op_add = lambda x, y: x + y | = help: Replace with `operator.neg` @@ -88,7 +88,7 @@ FURB118.py:5:10: FURB118 [*] Use `operator.neg` instead of defining a lambda FURB118.py:7:10: FURB118 [*] Use `operator.add` instead of defining a lambda | 5 | op_neg = lambda x: -x -6 | +6 | 7 | op_add = lambda x, y: x + y | ^^^^^^^^^^^^^^^^^^ FURB118 8 | op_sub = lambda x, y: x - y @@ -410,7 +410,7 @@ FURB118.py:19:15: FURB118 [*] Use `operator.floordiv` instead of defining a lamb 18 | op_bitand = lambda x, y: x & y 19 | op_floordiv = lambda x, y: x // y | ^^^^^^^^^^^^^^^^^^^ FURB118 -20 | +20 | 21 | op_eq = lambda x, y: x == y | = help: Replace with `operator.floordiv` @@ -434,7 +434,7 @@ FURB118.py:19:15: FURB118 [*] Use `operator.floordiv` instead of defining a lamb FURB118.py:21:9: FURB118 [*] Use `operator.eq` instead of defining a lambda | 19 | op_floordiv = lambda x, y: x // y -20 | +20 | 21 | op_eq = lambda x, y: x == y | ^^^^^^^^^^^^^^^^^^^ FURB118 22 | op_ne = lambda x, y: x != y @@ -879,7 +879,7 @@ FURB118.py:89:17: FURB118 [*] Use `operator.itemgetter((1, slice(None)))` instea 88 | op_itemgetter = lambda x: x[:, 1] 89 | op_itemgetter = lambda x: x[1, :] | ^^^^^^^^^^^^^^^^^ FURB118 -90 | +90 | 91 | # With a slice, trivia is dropped | = help: Replace with `operator.itemgetter((1, slice(None)))` @@ -905,7 +905,7 @@ FURB118.py:92:17: FURB118 [*] Use `operator.itemgetter((1, slice(None)))` instea 91 | # With a slice, trivia is dropped 92 | op_itemgetter = lambda x: x[1, :] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB118 -93 | +93 | 94 | # Without a slice, trivia is retained | = help: Replace with `operator.itemgetter((1, slice(None)))` @@ -946,3 +946,64 @@ FURB118.py:95:17: FURB118 [*] Use `operator.itemgetter((1, 2))` instead 94 95 | # Without a slice, trivia is retained 95 |-op_itemgetter = lambda x: x[1, 2] 96 |+op_itemgetter = operator.itemgetter((1, 2)) +96 97 | +97 98 | +98 99 | # All methods in classes are ignored, even those defined using lambdas: + +FURB118.py:129:14: FURB118 [*] Use `operator.itemgetter(slice(-2, None))` instead of defining a lambda + | +127 | "slicer, expected", +128 | [ +129 | (lambda x: x[-2:], "foo"), + | ^^^^^^^^^^^^^^^^ FURB118 +130 | (lambda x: x[-5:-3], "bar"), +131 | ], + | + = help: Replace with `operator.itemgetter(slice(-2, None))` + +ℹ Unsafe fix +111 111 | # Lambdas wrapped in function calls could also still be method definitions! +112 112 | # To avoid false positives, we shouldn't flag any of these either: +113 113 | from typing import final, override, no_type_check + 114 |+import operator +114 115 | +115 116 | +116 117 | class Foo: +-------------------------------------------------------------------------------- +126 127 | @pytest.mark.parametrize( +127 128 | "slicer, expected", +128 129 | [ +129 |- (lambda x: x[-2:], "foo"), + 130 |+ (operator.itemgetter(slice(-2, None)), "foo"), +130 131 | (lambda x: x[-5:-3], "bar"), +131 132 | ], +132 133 | ) + +FURB118.py:130:14: FURB118 [*] Use `operator.itemgetter(slice(-5, -3))` instead of defining a lambda + | +128 | [ +129 | (lambda x: x[-2:], "foo"), +130 | (lambda x: x[-5:-3], "bar"), + | ^^^^^^^^^^^^^^^^^^ FURB118 +131 | ], +132 | ) + | + = help: Replace with `operator.itemgetter(slice(-5, -3))` + +ℹ Unsafe fix +111 111 | # Lambdas wrapped in function calls could also still be method definitions! +112 112 | # To avoid false positives, we shouldn't flag any of these either: +113 113 | from typing import final, override, no_type_check + 114 |+import operator +114 115 | +115 116 | +116 117 | class Foo: +-------------------------------------------------------------------------------- +127 128 | "slicer, expected", +128 129 | [ +129 130 | (lambda x: x[-2:], "foo"), +130 |- (lambda x: x[-5:-3], "bar"), + 131 |+ (operator.itemgetter(slice(-5, -3)), "bar"), +131 132 | ], +132 133 | ) +133 134 | def test_inlet_asset_alias_extra_slice(self, slicer, expected): diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB122_FURB122.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB122_FURB122.py.snap new file mode 100644 index 0000000000000..693030678e3d0 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB122_FURB122.py.snap @@ -0,0 +1,309 @@ +--- +source: crates/ruff_linter/src/rules/refurb/mod.rs +--- +FURB122.py:10:9: FURB122 [*] Use of `f.write` in a for loop + | + 8 | def _(): + 9 | with open("file", "w") as f: +10 | / for line in lines: +11 | | f.write(line) + | |_________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +7 7 | +8 8 | def _(): +9 9 | with open("file", "w") as f: +10 |- for line in lines: +11 |- f.write(line) + 10 |+ f.writelines(lines) +12 11 | +13 12 | +14 13 | def _(): + +FURB122.py:17:9: FURB122 [*] Use of `f.write` in a for loop + | +15 | other_line = "other line" +16 | with Path("file").open("w") as f: +17 | / for line in lines: +18 | | f.write(other_line) + | |_______________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +14 14 | def _(): +15 15 | other_line = "other line" +16 16 | with Path("file").open("w") as f: +17 |- for line in lines: +18 |- f.write(other_line) + 17 |+ f.writelines(other_line for line in lines) +19 18 | +20 19 | +21 20 | def _(): + +FURB122.py:23:9: FURB122 [*] Use of `f.write` in a for loop + | +21 | def _(): +22 | with Path("file").open("w") as f: +23 | / for line in lines: +24 | | f.write(line) + | |_________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +20 20 | +21 21 | def _(): +22 22 | with Path("file").open("w") as f: +23 |- for line in lines: +24 |- f.write(line) + 23 |+ f.writelines(lines) +25 24 | +26 25 | +27 26 | def _(): + +FURB122.py:29:9: FURB122 [*] Use of `f.write` in a for loop + | +27 | def _(): +28 | with Path("file").open("wb") as f: +29 | / for line in lines: +30 | | f.write(line.encode()) + | |__________________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +26 26 | +27 27 | def _(): +28 28 | with Path("file").open("wb") as f: +29 |- for line in lines: +30 |- f.write(line.encode()) + 29 |+ f.writelines(line.encode() for line in lines) +31 30 | +32 31 | +33 32 | def _(): + +FURB122.py:35:9: FURB122 [*] Use of `f.write` in a for loop + | +33 | def _(): +34 | with Path("file").open("w") as f: +35 | / for line in lines: +36 | | f.write(line.upper()) + | |_________________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +32 32 | +33 33 | def _(): +34 34 | with Path("file").open("w") as f: +35 |- for line in lines: +36 |- f.write(line.upper()) + 35 |+ f.writelines(line.upper() for line in lines) +37 36 | +38 37 | +39 38 | def _(): + +FURB122.py:43:9: FURB122 [*] Use of `f.write` in a for loop + | +41 | pass +42 | +43 | / for line in lines: +44 | | f.write(line) + | |_________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +40 40 | with Path("file").open("w") as f: +41 41 | pass +42 42 | +43 |- for line in lines: +44 |- f.write(line) + 43 |+ f.writelines(lines) +45 44 | +46 45 | +47 46 | def _(): + +FURB122.py:50:9: FURB122 [*] Use of `f.write` in a for loop + | +48 | # Offer unsafe fix if it would delete comments +49 | with open("file","w") as f: +50 | / for line in lines: +51 | | # a really important comment +52 | | f.write(line) + | |_________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Unsafe fix +47 47 | def _(): +48 48 | # Offer unsafe fix if it would delete comments +49 49 | with open("file","w") as f: +50 |- for line in lines: +51 |- # a really important comment +52 |- f.write(line) + 50 |+ f.writelines(lines) +53 51 | +54 52 | +55 53 | def _(): + +FURB122.py:57:9: FURB122 [*] Use of `f.write` in a for loop + | +55 | def _(): +56 | with open("file", "w") as f: +57 | / for () in a: +58 | | f.write(()) + | |_______________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +54 54 | +55 55 | def _(): +56 56 | with open("file", "w") as f: +57 |- for () in a: +58 |- f.write(()) + 57 |+ f.writelines(() for () in a) +59 58 | +60 59 | +61 60 | def _(): + +FURB122.py:63:9: FURB122 [*] Use of `f.write` in a for loop + | +61 | def _(): +62 | with open("file", "w") as f: +63 | / for a, b, c in d: +64 | | f.write((a, b)) + | |___________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +60 60 | +61 61 | def _(): +62 62 | with open("file", "w") as f: +63 |- for a, b, c in d: +64 |- f.write((a, b)) + 63 |+ f.writelines((a, b) for a, b, c in d) +65 64 | +66 65 | +67 66 | def _(): + +FURB122.py:69:9: FURB122 [*] Use of `f.write` in a for loop + | +67 | def _(): +68 | with open("file", "w") as f: +69 | / for [(), [a.b], (c,)] in d: +70 | | f.write(()) + | |_______________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +66 66 | +67 67 | def _(): +68 68 | with open("file", "w") as f: +69 |- for [(), [a.b], (c,)] in d: +70 |- f.write(()) + 69 |+ f.writelines(() for [(), [a.b], (c,)] in d) +71 70 | +72 71 | +73 72 | def _(): + +FURB122.py:75:9: FURB122 [*] Use of `f.write` in a for loop + | +73 | def _(): +74 | with open("file", "w") as f: +75 | / for [([([a[b]],)],), [], (c[d],)] in e: +76 | | f.write(()) + | |_______________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Safe fix +72 72 | +73 73 | def _(): +74 74 | with open("file", "w") as f: +75 |- for [([([a[b]],)],), [], (c[d],)] in e: +76 |- f.write(()) + 75 |+ f.writelines(() for [([([a[b]],)],), [], (c[d],)] in e) +77 76 | +78 77 | +79 78 | def _(): + +FURB122.py:82:9: FURB122 [*] Use of `f.write` in a for loop + | +80 | # https://github.com/astral-sh/ruff/issues/15936 +81 | with open("file", "w") as f: +82 | / for char in "a", "b": +83 | | f.write(char) + | |_________________________^ FURB122 +84 | +85 | def _(): + | + = help: Replace with `f.writelines` + +ℹ Safe fix +79 79 | def _(): +80 80 | # https://github.com/astral-sh/ruff/issues/15936 +81 81 | with open("file", "w") as f: +82 |- for char in "a", "b": +83 |- f.write(char) + 82 |+ f.writelines(("a", "b")) +84 83 | +85 84 | def _(): +86 85 | # https://github.com/astral-sh/ruff/issues/15936 + +FURB122.py:88:9: FURB122 [*] Use of `f.write` in a for loop + | +86 | # https://github.com/astral-sh/ruff/issues/15936 +87 | with open("file", "w") as f: +88 | / for char in "a", "b": +89 | | f.write(f"{char}") + | |______________________________^ FURB122 +90 | +91 | def _(): + | + = help: Replace with `f.writelines` + +ℹ Safe fix +85 85 | def _(): +86 86 | # https://github.com/astral-sh/ruff/issues/15936 +87 87 | with open("file", "w") as f: +88 |- for char in "a", "b": +89 |- f.write(f"{char}") + 88 |+ f.writelines(f"{char}" for char in ("a", "b")) +90 89 | +91 90 | def _(): +92 91 | with open("file", "w") as f: + +FURB122.py:93:9: FURB122 [*] Use of `f.write` in a for loop + | +91 | def _(): +92 | with open("file", "w") as f: +93 | / for char in ( +94 | | "a", # Comment +95 | | "b" +96 | | ): +97 | | f.write(f"{char}") + | |______________________________^ FURB122 + | + = help: Replace with `f.writelines` + +ℹ Unsafe fix +90 90 | +91 91 | def _(): +92 92 | with open("file", "w") as f: +93 |- for char in ( + 93 |+ f.writelines(f"{char}" for char in ( +94 94 | "a", # Comment +95 95 | "b" +96 |- ): +97 |- f.write(f"{char}") + 96 |+ )) +98 97 | +99 98 | +100 99 | # OK diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB129_FURB129.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB129_FURB129.py.snap index 655f8d69591d4..c11b60c272766 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB129_FURB129.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB129_FURB129.py.snap @@ -69,7 +69,7 @@ FURB129.py:11:49: FURB129 [*] Instead of calling `readlines()`, iterate over fil 10 | b = {line.upper() for line in f.readlines()} 11 | c = {line.lower(): line.upper() for line in f.readlines()} | ^^^^^^^^^^^^^ FURB129 -12 | +12 | 13 | with Path("FURB129.py").open() as f: | = help: Remove `readlines()` @@ -106,7 +106,7 @@ FURB129.py:14:18: FURB129 [*] Instead of calling `readlines()`, iterate over fil FURB129.py:17:14: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly | 15 | pass -16 | +16 | 17 | for _line in open("FURB129.py").readlines(): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB129 18 | pass @@ -126,7 +126,7 @@ FURB129.py:17:14: FURB129 [*] Instead of calling `readlines()`, iterate over fil FURB129.py:20:14: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly | 18 | pass -19 | +19 | 20 | for _line in Path("FURB129.py").open().readlines(): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB129 21 | pass diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB131_FURB131.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB131_FURB131.py.snap index fcd3ecd84eb12..8928bc8483956 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB131_FURB131.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB131_FURB131.py.snap @@ -135,7 +135,7 @@ FURB131.py:48:5: FURB131 [*] Prefer `clear` over deleting a full slice 47 | # FURB131 48 | del x[:] | ^^^^^^^^ FURB131 -49 | +49 | 50 | x = 1 | = help: Replace with `clear()` @@ -156,7 +156,7 @@ FURB131.py:58:1: FURB131 [*] Prefer `clear` over deleting a full slice 57 | # FURB131 58 | del sneaky[:] | ^^^^^^^^^^^^^ FURB131 -59 | +59 | 60 | # these should not | = help: Replace with `clear()` diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB132_FURB132.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB132_FURB132.py.snap index ac600b20be6ae..4f3f51660f907 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB132_FURB132.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB132_FURB132.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB132.py:12:1: FURB132 [*] Use `s.discard("x")` instead of check and `remove` | @@ -80,5 +81,3 @@ FURB132.py:32:1: FURB132 [*] Use `s.discard(f"{var}:{var}")` instead of check an 34 33 | 35 34 | 36 35 | def identity(x): - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB136_FURB136.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB136_FURB136.py.snap index bf698bafbfe3f..91386ad5284a3 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB136_FURB136.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB136_FURB136.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB136.py:4:1: FURB136 [*] Replace `x if x > y else y` with `max(y, x)` | 2 | y = 2 -3 | +3 | 4 | x if x > y else y # FURB136 | ^^^^^^^^^^^^^^^^^ FURB136 -5 | +5 | 6 | x if x >= y else y # FURB136 | = help: Replace with `max(y, x)` @@ -25,10 +25,10 @@ FURB136.py:4:1: FURB136 [*] Replace `x if x > y else y` with `max(y, x)` FURB136.py:6:1: FURB136 [*] Replace `x if x >= y else y` with `max(x, y)` | 4 | x if x > y else y # FURB136 -5 | +5 | 6 | x if x >= y else y # FURB136 | ^^^^^^^^^^^^^^^^^^ FURB136 -7 | +7 | 8 | x if x < y else y # FURB136 | = help: Replace with `max(x, y)` @@ -46,10 +46,10 @@ FURB136.py:6:1: FURB136 [*] Replace `x if x >= y else y` with `max(x, y)` FURB136.py:8:1: FURB136 [*] Replace `x if x < y else y` with `min(y, x)` | 6 | x if x >= y else y # FURB136 - 7 | + 7 | 8 | x if x < y else y # FURB136 | ^^^^^^^^^^^^^^^^^ FURB136 - 9 | + 9 | 10 | x if x <= y else y # FURB136 | = help: Replace with `min(y, x)` @@ -67,10 +67,10 @@ FURB136.py:8:1: FURB136 [*] Replace `x if x < y else y` with `min(y, x)` FURB136.py:10:1: FURB136 [*] Replace `x if x <= y else y` with `min(x, y)` | 8 | x if x < y else y # FURB136 - 9 | + 9 | 10 | x if x <= y else y # FURB136 | ^^^^^^^^^^^^^^^^^^ FURB136 -11 | +11 | 12 | y if x > y else x # FURB136 | = help: Replace with `min(x, y)` @@ -88,10 +88,10 @@ FURB136.py:10:1: FURB136 [*] Replace `x if x <= y else y` with `min(x, y)` FURB136.py:12:1: FURB136 [*] Replace `y if x > y else x` with `min(x, y)` | 10 | x if x <= y else y # FURB136 -11 | +11 | 12 | y if x > y else x # FURB136 | ^^^^^^^^^^^^^^^^^ FURB136 -13 | +13 | 14 | y if x >= y else x # FURB136 | = help: Replace with `min(x, y)` @@ -109,10 +109,10 @@ FURB136.py:12:1: FURB136 [*] Replace `y if x > y else x` with `min(x, y)` FURB136.py:14:1: FURB136 [*] Replace `y if x >= y else x` with `min(y, x)` | 12 | y if x > y else x # FURB136 -13 | +13 | 14 | y if x >= y else x # FURB136 | ^^^^^^^^^^^^^^^^^^ FURB136 -15 | +15 | 16 | y if x < y else x # FURB136 | = help: Replace with `min(y, x)` @@ -130,10 +130,10 @@ FURB136.py:14:1: FURB136 [*] Replace `y if x >= y else x` with `min(y, x)` FURB136.py:16:1: FURB136 [*] Replace `y if x < y else x` with `max(x, y)` | 14 | y if x >= y else x # FURB136 -15 | +15 | 16 | y if x < y else x # FURB136 | ^^^^^^^^^^^^^^^^^ FURB136 -17 | +17 | 18 | y if x <= y else x # FURB136 | = help: Replace with `max(x, y)` @@ -151,10 +151,10 @@ FURB136.py:16:1: FURB136 [*] Replace `y if x < y else x` with `max(x, y)` FURB136.py:18:1: FURB136 [*] Replace `y if x <= y else x` with `max(y, x)` | 16 | y if x < y else x # FURB136 -17 | +17 | 18 | y if x <= y else x # FURB136 | ^^^^^^^^^^^^^^^^^^ FURB136 -19 | +19 | 20 | x + y if x > y else y # OK | = help: Replace with `max(y, x)` @@ -172,7 +172,7 @@ FURB136.py:18:1: FURB136 [*] Replace `y if x <= y else x` with `max(y, x)` FURB136.py:22:1: FURB136 [*] Replace `if` expression with `max(y, x)` | 20 | x + y if x > y else y # OK -21 | +21 | 22 | / x if ( 23 | | x 24 | | > y @@ -190,5 +190,3 @@ FURB136.py:22:1: FURB136 [*] Replace `if` expression with `max(y, x)` 24 |- > y 25 |-) else y # FURB136 22 |+max(y, x) # FURB136 - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB140_FURB140.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB140_FURB140.py.snap index 5fc72a0bc02b2..7748edac5afc3 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB140_FURB140.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB140_FURB140.py.snap @@ -6,7 +6,7 @@ FURB140.py:7:1: FURB140 [*] Use `itertools.starmap` instead of the generator 6 | # FURB140 7 | [print(x, y) for x, y in zipped()] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -8 | +8 | 9 | # FURB140 | = help: Replace with `itertools.starmap` @@ -30,7 +30,7 @@ FURB140.py:10:1: FURB140 [*] Use `itertools.starmap` instead of the generator 9 | # FURB140 10 | (print(x, y) for x, y in zipped()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -11 | +11 | 12 | # FURB140 | = help: Replace with `itertools.starmap` @@ -78,7 +78,7 @@ FURB140.py:19:1: FURB140 [*] Use `itertools.starmap` instead of the generator 18 | # FURB140 19 | [print(x, y) for x, y in zipped()] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -20 | +20 | 21 | # FURB140 | = help: Replace with `itertools.starmap` @@ -98,7 +98,7 @@ FURB140.py:22:1: FURB140 [*] Use `itertools.starmap` instead of the generator 21 | # FURB140 22 | (print(x, y) for x, y in zipped()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -23 | +23 | 24 | # FURB140 | = help: Replace with `itertools.starmap` @@ -118,7 +118,7 @@ FURB140.py:25:1: FURB140 [*] Use `itertools.starmap` instead of the generator 24 | # FURB140 25 | {print(x, y) for x, y in zipped()} | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -26 | +26 | 27 | # FURB140 (check it still flags starred arguments). | = help: Replace with `itertools.starmap` @@ -180,7 +180,7 @@ FURB140.py:31:1: FURB140 [*] Use `itertools.starmap` instead of the generator 30 | (foo(*t) for t in [(85, 60), (100, 80)]) 31 | {foo(*t) for t in [(85, 60), (100, 80)]} | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB140 -32 | +32 | 33 | # Non-errors. | = help: Replace with `itertools.starmap` @@ -193,6 +193,4 @@ FURB140.py:31:1: FURB140 [*] Use `itertools.starmap` instead of the generator 31 |+set(sm(foo, [(85, 60), (100, 80)])) 32 32 | 33 33 | # Non-errors. -34 34 | - - +34 34 | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB142_FURB142.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB142_FURB142.py.snap index cd781a8bbe030..8f655fa8ee54d 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB142_FURB142.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB142_FURB142.py.snap @@ -4,11 +4,11 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB142.py:5:1: FURB142 [*] Use of `set.add()` in a for loop | 3 | s = set() -4 | +4 | 5 | / for x in [1, 2, 3]: 6 | | s.add(x) | |____________^ FURB142 -7 | +7 | 8 | for x in {1, 2, 3}: | = help: Replace with `.update()` @@ -27,11 +27,11 @@ FURB142.py:5:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:8:1: FURB142 [*] Use of `set.add()` in a for loop | 6 | s.add(x) - 7 | + 7 | 8 | / for x in {1, 2, 3}: 9 | | s.add(x) | |____________^ FURB142 -10 | +10 | 11 | for x in (1, 2, 3): | = help: Replace with `.update()` @@ -50,11 +50,11 @@ FURB142.py:8:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:11:1: FURB142 [*] Use of `set.add()` in a for loop | 9 | s.add(x) -10 | +10 | 11 | / for x in (1, 2, 3): 12 | | s.add(x) | |____________^ FURB142 -13 | +13 | 14 | for x in (1, 2, 3): | = help: Replace with `.update()` @@ -73,11 +73,11 @@ FURB142.py:11:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:14:1: FURB142 [*] Use of `set.discard()` in a for loop | 12 | s.add(x) -13 | +13 | 14 | / for x in (1, 2, 3): 15 | | s.discard(x) | |________________^ FURB142 -16 | +16 | 17 | for x in (1, 2, 3): | = help: Replace with `.difference_update()` @@ -96,11 +96,11 @@ FURB142.py:14:1: FURB142 [*] Use of `set.discard()` in a for loop FURB142.py:17:1: FURB142 [*] Use of `set.add()` in a for loop | 15 | s.discard(x) -16 | +16 | 17 | / for x in (1, 2, 3): 18 | | s.add(x + 1) | |________________^ FURB142 -19 | +19 | 20 | for x, y in ((1, 2), (3, 4)): | = help: Replace with `.update()` @@ -119,11 +119,11 @@ FURB142.py:17:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:20:1: FURB142 [*] Use of `set.add()` in a for loop | 18 | s.add(x + 1) -19 | +19 | 20 | / for x, y in ((1, 2), (3, 4)): 21 | | s.add((x, y)) | |_________________^ FURB142 -22 | +22 | 23 | num = 123 | = help: Replace with `.update()` @@ -142,11 +142,11 @@ FURB142.py:20:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:25:1: FURB142 [*] Use of `set.add()` in a for loop | 23 | num = 123 -24 | +24 | 25 | / for x in (1, 2, 3): 26 | | s.add(num) | |______________^ FURB142 -27 | +27 | 28 | for x in (1, 2, 3): | = help: Replace with `.update()` @@ -165,11 +165,11 @@ FURB142.py:25:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:28:1: FURB142 [*] Use of `set.add()` in a for loop | 26 | s.add(num) -27 | +27 | 28 | / for x in (1, 2, 3): 29 | | s.add((num, x)) | |___________________^ FURB142 -30 | +30 | 31 | for x in (1, 2, 3): | = help: Replace with `.update()` @@ -188,12 +188,12 @@ FURB142.py:28:1: FURB142 [*] Use of `set.add()` in a for loop FURB142.py:31:1: FURB142 [*] Use of `set.add()` in a for loop | 29 | s.add((num, x)) -30 | +30 | 31 | / for x in (1, 2, 3): 32 | | s.add(x + num) | |__________________^ FURB142 -33 | -34 | # False negative +33 | +34 | # https://github.com/astral-sh/ruff/issues/15936 | = help: Replace with `.update()` @@ -205,5 +205,78 @@ FURB142.py:31:1: FURB142 [*] Use of `set.add()` in a for loop 32 |- s.add(x + num) 31 |+s.update(x + num for x in (1, 2, 3)) 33 32 | -34 33 | # False negative -35 34 | +34 33 | # https://github.com/astral-sh/ruff/issues/15936 +35 34 | for x in 1, 2, 3: + +FURB142.py:35:1: FURB142 [*] Use of `set.add()` in a for loop + | +34 | # https://github.com/astral-sh/ruff/issues/15936 +35 | / for x in 1, 2, 3: +36 | | s.add(x) + | |____________^ FURB142 +37 | +38 | for x in 1, 2, 3: + | + = help: Replace with `.update()` + +ℹ Safe fix +32 32 | s.add(x + num) +33 33 | +34 34 | # https://github.com/astral-sh/ruff/issues/15936 +35 |-for x in 1, 2, 3: +36 |- s.add(x) + 35 |+s.update((1, 2, 3)) +37 36 | +38 37 | for x in 1, 2, 3: +39 38 | s.add(f"{x}") + +FURB142.py:38:1: FURB142 [*] Use of `set.add()` in a for loop + | +36 | s.add(x) +37 | +38 | / for x in 1, 2, 3: +39 | | s.add(f"{x}") + | |_________________^ FURB142 +40 | +41 | for x in ( + | + = help: Replace with `.update()` + +ℹ Safe fix +35 35 | for x in 1, 2, 3: +36 36 | s.add(x) +37 37 | +38 |-for x in 1, 2, 3: +39 |- s.add(f"{x}") + 38 |+s.update(f"{x}" for x in (1, 2, 3)) +40 39 | +41 40 | for x in ( +42 41 | 1, # Comment + +FURB142.py:41:1: FURB142 [*] Use of `set.add()` in a for loop + | +39 | s.add(f"{x}") +40 | +41 | / for x in ( +42 | | 1, # Comment +43 | | 2, 3 +44 | | ): +45 | | s.add(f"{x}") + | |_________________^ FURB142 + | + = help: Replace with `.update()` + +ℹ Unsafe fix +38 38 | for x in 1, 2, 3: +39 39 | s.add(f"{x}") +40 40 | +41 |-for x in ( + 41 |+s.update(f"{x}" for x in ( +42 42 | 1, # Comment +43 43 | 2, 3 +44 |-): +45 |- s.add(f"{x}") + 44 |+)) +46 45 | +47 46 | +48 47 | # False negative diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB145_FURB145.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB145_FURB145.py.snap index 388dfb2488cc0..176f2c59e5328 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB145_FURB145.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB145_FURB145.py.snap @@ -110,7 +110,7 @@ FURB145.py:9:7: FURB145 [*] Prefer `copy` method over slicing 8 | l[:] 9 | print(l[:]) | ^^^^ FURB145 -10 | +10 | 11 | # False negatives. | = help: Replace with `copy()` @@ -124,5 +124,3 @@ FURB145.py:9:7: FURB145 [*] Prefer `copy` method over slicing 10 10 | 11 11 | # False negatives. 12 12 | aa = a[:] # Type inference. - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB148_FURB148.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB148_FURB148.py.snap index 3cb94bc16bd50..a6b220ffee519 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB148_FURB148.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB148_FURB148.py.snap @@ -23,7 +23,7 @@ FURB148.py:14:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:17:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 15 | print(index) -16 | +16 | 17 | for index, _ in enumerate(books, start=0): | ^^^^^^^^^ FURB148 18 | print(index) @@ -43,7 +43,7 @@ FURB148.py:17:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:20:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 18 | print(index) -19 | +19 | 20 | for index, _ in enumerate(books, 0): | ^^^^^^^^^ FURB148 21 | print(index) @@ -63,7 +63,7 @@ FURB148.py:20:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:23:17: FURB148 `enumerate` value is unused, use `for x in range(len(y))` instead | 21 | print(index) -22 | +22 | 23 | for index, _ in enumerate(books, start=1): | ^^^^^^^^^ FURB148 24 | print(index) @@ -73,7 +73,7 @@ FURB148.py:23:17: FURB148 `enumerate` value is unused, use `for x in range(len(y FURB148.py:26:17: FURB148 `enumerate` value is unused, use `for x in range(len(y))` instead | 24 | print(index) -25 | +25 | 26 | for index, _ in enumerate(books, 1): | ^^^^^^^^^ FURB148 27 | print(index) @@ -83,7 +83,7 @@ FURB148.py:26:17: FURB148 `enumerate` value is unused, use `for x in range(len(y FURB148.py:29:17: FURB148 `enumerate` value is unused, use `for x in range(len(y))` instead | 27 | print(index) -28 | +28 | 29 | for index, _ in enumerate(books, start=x): | ^^^^^^^^^ FURB148 30 | print(book) @@ -93,7 +93,7 @@ FURB148.py:29:17: FURB148 `enumerate` value is unused, use `for x in range(len(y FURB148.py:32:17: FURB148 `enumerate` value is unused, use `for x in range(len(y))` instead | 30 | print(book) -31 | +31 | 32 | for index, _ in enumerate(books, x): | ^^^^^^^^^ FURB148 33 | print(book) @@ -103,7 +103,7 @@ FURB148.py:32:17: FURB148 `enumerate` value is unused, use `for x in range(len(y FURB148.py:35:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 33 | print(book) -34 | +34 | 35 | for _, book in enumerate(books): | ^^^^^^^^^ FURB148 36 | print(book) @@ -123,7 +123,7 @@ FURB148.py:35:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:38:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 36 | print(book) -37 | +37 | 38 | for _, book in enumerate(books, start=0): | ^^^^^^^^^ FURB148 39 | print(book) @@ -143,7 +143,7 @@ FURB148.py:38:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:41:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 39 | print(book) -40 | +40 | 41 | for _, book in enumerate(books, 0): | ^^^^^^^^^ FURB148 42 | print(book) @@ -163,7 +163,7 @@ FURB148.py:41:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:44:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 42 | print(book) -43 | +43 | 44 | for _, book in enumerate(books, start=1): | ^^^^^^^^^ FURB148 45 | print(book) @@ -183,7 +183,7 @@ FURB148.py:44:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:47:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 45 | print(book) -46 | +46 | 47 | for _, book in enumerate(books, 1): | ^^^^^^^^^ FURB148 48 | print(book) @@ -203,7 +203,7 @@ FURB148.py:47:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:50:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 48 | print(book) -49 | +49 | 50 | for _, book in enumerate(books, start=x): | ^^^^^^^^^ FURB148 51 | print(book) @@ -223,7 +223,7 @@ FURB148.py:50:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:53:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 51 | print(book) -52 | +52 | 53 | for _, book in enumerate(books, x): | ^^^^^^^^^ FURB148 54 | print(book) @@ -243,7 +243,7 @@ FURB148.py:53:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:56:22: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 54 | print(book) -55 | +55 | 56 | for index, (_, _) in enumerate(books): | ^^^^^^^^^ FURB148 57 | print(index) @@ -263,7 +263,7 @@ FURB148.py:56:22: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:59:21: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 57 | print(index) -58 | +58 | 59 | for (_, _), book in enumerate(books): | ^^^^^^^^^ FURB148 60 | print(book) @@ -283,7 +283,7 @@ FURB148.py:59:21: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:62:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 60 | print(book) -61 | +61 | 62 | for(index, _)in enumerate(books): | ^^^^^^^^^ FURB148 63 | print(index) @@ -303,7 +303,7 @@ FURB148.py:62:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:65:18: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 63 | print(index) -64 | +64 | 65 | for(index), _ in enumerate(books): | ^^^^^^^^^ FURB148 66 | print(index) @@ -323,7 +323,7 @@ FURB148.py:65:18: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:68:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 66 | print(index) -67 | +67 | 68 | for index, _ in enumerate(books_and_authors): | ^^^^^^^^^ FURB148 69 | print(index) @@ -343,7 +343,7 @@ FURB148.py:68:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:71:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 69 | print(index) -70 | +70 | 71 | for _, book in enumerate(books_and_authors): | ^^^^^^^^^ FURB148 72 | print(book) @@ -363,7 +363,7 @@ FURB148.py:71:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:74:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 72 | print(book) -73 | +73 | 74 | for index, _ in enumerate(books_set): | ^^^^^^^^^ FURB148 75 | print(index) @@ -383,7 +383,7 @@ FURB148.py:74:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:77:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 75 | print(index) -76 | +76 | 77 | for _, book in enumerate(books_set): | ^^^^^^^^^ FURB148 78 | print(book) @@ -403,7 +403,7 @@ FURB148.py:77:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst FURB148.py:80:17: FURB148 [*] `enumerate` value is unused, use `for x in range(len(y))` instead | 78 | print(book) -79 | +79 | 80 | for index, _ in enumerate(books_tuple): | ^^^^^^^^^ FURB148 81 | print(index) @@ -423,7 +423,7 @@ FURB148.py:80:17: FURB148 [*] `enumerate` value is unused, use `for x in range(l FURB148.py:83:16: FURB148 [*] `enumerate` index is unused, use `for x in y` instead | 81 | print(index) -82 | +82 | 83 | for _, book in enumerate(books_tuple): | ^^^^^^^^^ FURB148 84 | print(book) @@ -439,5 +439,3 @@ FURB148.py:83:16: FURB148 [*] `enumerate` index is unused, use `for x in y` inst 84 84 | print(book) 85 85 | 86 86 | # OK - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB152_FURB152.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB152_FURB152.py.snap index 9933f51589ab9..c51afdd85aee0 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB152_FURB152.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB152_FURB152.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB152.py:3:5: FURB152 [*] Replace `3.14` with `math.pi` | 1 | r = 3.1 # OK -2 | +2 | 3 | A = 3.14 * r ** 2 # FURB152 | ^^^^ FURB152 -4 | +4 | 5 | C = 6.28 * r # FURB152 | = help: Use `math.pi` @@ -25,10 +25,10 @@ FURB152.py:3:5: FURB152 [*] Replace `3.14` with `math.pi` FURB152.py:5:5: FURB152 [*] Replace `6.28` with `math.tau` | 3 | A = 3.14 * r ** 2 # FURB152 -4 | +4 | 5 | C = 6.28 * r # FURB152 | ^^^^ FURB152 -6 | +6 | 7 | e = 2.71 # FURB152 | = help: Use `math.tau` @@ -48,10 +48,10 @@ FURB152.py:5:5: FURB152 [*] Replace `6.28` with `math.tau` FURB152.py:7:5: FURB152 [*] Replace `2.71` with `math.e` | 5 | C = 6.28 * r # FURB152 -6 | +6 | 7 | e = 2.71 # FURB152 | ^^^^ FURB152 -8 | +8 | 9 | r = 3.15 # OK | = help: Use `math.e` @@ -73,10 +73,10 @@ FURB152.py:7:5: FURB152 [*] Replace `2.71` with `math.e` FURB152.py:11:5: FURB152 [*] Replace `3.141` with `math.pi` | 9 | r = 3.15 # OK -10 | +10 | 11 | r = 3.141 # FURB152 | ^^^^^ FURB152 -12 | +12 | 13 | r = 3.142 # FURB152 | = help: Use `math.pi` @@ -99,10 +99,10 @@ FURB152.py:11:5: FURB152 [*] Replace `3.141` with `math.pi` FURB152.py:13:5: FURB152 [*] Replace `3.142` with `math.pi` | 11 | r = 3.141 # FURB152 -12 | +12 | 13 | r = 3.142 # FURB152 | ^^^^^ FURB152 -14 | +14 | 15 | r = 3.1415 # FURB152 | = help: Use `math.pi` @@ -125,10 +125,10 @@ FURB152.py:13:5: FURB152 [*] Replace `3.142` with `math.pi` FURB152.py:15:5: FURB152 [*] Replace `3.1415` with `math.pi` | 13 | r = 3.142 # FURB152 -14 | +14 | 15 | r = 3.1415 # FURB152 | ^^^^^^ FURB152 -16 | +16 | 17 | r = 3.1416 # FURB152 | = help: Use `math.pi` @@ -151,10 +151,10 @@ FURB152.py:15:5: FURB152 [*] Replace `3.1415` with `math.pi` FURB152.py:17:5: FURB152 [*] Replace `3.1416` with `math.pi` | 15 | r = 3.1415 # FURB152 -16 | +16 | 17 | r = 3.1416 # FURB152 | ^^^^^^ FURB152 -18 | +18 | 19 | r = 3.141592 # FURB152 | = help: Use `math.pi` @@ -177,10 +177,10 @@ FURB152.py:17:5: FURB152 [*] Replace `3.1416` with `math.pi` FURB152.py:19:5: FURB152 [*] Replace `3.141592` with `math.pi` | 17 | r = 3.1416 # FURB152 -18 | +18 | 19 | r = 3.141592 # FURB152 | ^^^^^^^^ FURB152 -20 | +20 | 21 | r = 3.141593 # FURB152 | = help: Use `math.pi` @@ -203,10 +203,10 @@ FURB152.py:19:5: FURB152 [*] Replace `3.141592` with `math.pi` FURB152.py:21:5: FURB152 [*] Replace `3.141593` with `math.pi` | 19 | r = 3.141592 # FURB152 -20 | +20 | 21 | r = 3.141593 # FURB152 | ^^^^^^^^ FURB152 -22 | +22 | 23 | r = 3.14159265 # FURB152 | = help: Use `math.pi` @@ -229,10 +229,10 @@ FURB152.py:21:5: FURB152 [*] Replace `3.141593` with `math.pi` FURB152.py:23:5: FURB152 [*] Replace `3.14159265` with `math.pi` | 21 | r = 3.141593 # FURB152 -22 | +22 | 23 | r = 3.14159265 # FURB152 | ^^^^^^^^^^ FURB152 -24 | +24 | 25 | r = 3.141592653589793238462643383279 # FURB152 | = help: Use `math.pi` @@ -255,10 +255,10 @@ FURB152.py:23:5: FURB152 [*] Replace `3.14159265` with `math.pi` FURB152.py:25:5: FURB152 [*] Replace `3.141592653589793238462643383279` with `math.pi` | 23 | r = 3.14159265 # FURB152 -24 | +24 | 25 | r = 3.141592653589793238462643383279 # FURB152 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB152 -26 | +26 | 27 | r = 3.14159266 # OK | = help: Use `math.pi` @@ -281,10 +281,10 @@ FURB152.py:25:5: FURB152 [*] Replace `3.141592653589793238462643383279` with `ma FURB152.py:31:5: FURB152 [*] Replace `2.718` with `math.e` | 29 | e = 2.7 # OK -30 | +30 | 31 | e = 2.718 # FURB152 | ^^^^^ FURB152 -32 | +32 | 33 | e = 2.7182 # FURB152 | = help: Use `math.e` @@ -307,10 +307,10 @@ FURB152.py:31:5: FURB152 [*] Replace `2.718` with `math.e` FURB152.py:33:5: FURB152 [*] Replace `2.7182` with `math.e` | 31 | e = 2.718 # FURB152 -32 | +32 | 33 | e = 2.7182 # FURB152 | ^^^^^^ FURB152 -34 | +34 | 35 | e = 2.7183 # FURB152 | = help: Use `math.e` @@ -333,10 +333,10 @@ FURB152.py:33:5: FURB152 [*] Replace `2.7182` with `math.e` FURB152.py:35:5: FURB152 [*] Replace `2.7183` with `math.e` | 33 | e = 2.7182 # FURB152 -34 | +34 | 35 | e = 2.7183 # FURB152 | ^^^^^^ FURB152 -36 | +36 | 37 | e = 2.719 # OK | = help: Use `math.e` @@ -359,7 +359,7 @@ FURB152.py:35:5: FURB152 [*] Replace `2.7183` with `math.e` FURB152.py:45:5: FURB152 [*] Replace `2.7182000000000001` with `math.e` | 43 | e = 2.718200000000001 # OK -44 | +44 | 45 | e = 2.7182000000000001 # FURB152 | ^^^^^^^^^^^^^^^^^^ FURB152 | @@ -376,5 +376,3 @@ FURB152.py:45:5: FURB152 [*] Replace `2.7182000000000001` with `math.e` 44 45 | 45 |-e = 2.7182000000000001 # FURB152 46 |+e = math.e # FURB152 - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB154_FURB154.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB154_FURB154.py.snap index a935e1ae3c4fe..cb55d4165e94b 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB154_FURB154.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB154_FURB154.py.snap @@ -4,8 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB154.py:4:5: FURB154 [*] Use of repeated consecutive `global` | 3 | def f1(): -4 | global x - | _____^ +4 | / global x 5 | | global y | |____________^ FURB154 | @@ -25,8 +24,7 @@ FURB154.py:4:5: FURB154 [*] Use of repeated consecutive `global` FURB154.py:9:5: FURB154 [*] Use of repeated consecutive `global` | 8 | def f3(): - 9 | global x - | _____^ + 9 | / global x 10 | | global y 11 | | global z | |____________^ FURB154 @@ -48,8 +46,7 @@ FURB154.py:9:5: FURB154 [*] Use of repeated consecutive `global` FURB154.py:15:5: FURB154 [*] Use of repeated consecutive `global` | 14 | def f4(): -15 | global x - | _____^ +15 | / global x 16 | | global y | |____________^ FURB154 17 | pass @@ -72,8 +69,7 @@ FURB154.py:18:5: FURB154 [*] Use of repeated consecutive `global` | 16 | global y 17 | pass -18 | global x - | _____^ +18 | / global x 19 | | global y | |____________^ FURB154 | @@ -93,11 +89,10 @@ FURB154.py:18:5: FURB154 [*] Use of repeated consecutive `global` FURB154.py:26:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 25 | def inner(): -26 | nonlocal x - | _________^ +26 | / nonlocal x 27 | | nonlocal y | |__________________^ FURB154 -28 | +28 | 29 | def inner2(): | = help: Merge `nonlocal` statements @@ -116,12 +111,11 @@ FURB154.py:26:9: FURB154 [*] Use of repeated consecutive `nonlocal` FURB154.py:30:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 29 | def inner2(): -30 | nonlocal x - | _________^ +30 | / nonlocal x 31 | | nonlocal y 32 | | nonlocal z | |__________________^ FURB154 -33 | +33 | 34 | def inner3(): | = help: Merge `nonlocal` statements @@ -141,8 +135,7 @@ FURB154.py:30:9: FURB154 [*] Use of repeated consecutive `nonlocal` FURB154.py:35:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 34 | def inner3(): -35 | nonlocal x - | _________^ +35 | / nonlocal x 36 | | nonlocal y | |__________________^ FURB154 37 | pass @@ -165,8 +158,7 @@ FURB154.py:38:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 36 | nonlocal y 37 | pass -38 | nonlocal x - | _________^ +38 | / nonlocal x 39 | | nonlocal y | |__________________^ FURB154 | @@ -186,8 +178,7 @@ FURB154.py:38:9: FURB154 [*] Use of repeated consecutive `nonlocal` FURB154.py:46:9: FURB154 [*] Use of repeated consecutive `global` | 45 | def inner(): -46 | global w - | _________^ +46 | / global w 47 | | global x | |________________^ FURB154 48 | nonlocal y @@ -210,11 +201,10 @@ FURB154.py:48:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 46 | global w 47 | global x -48 | nonlocal y - | _________^ +48 | / nonlocal y 49 | | nonlocal z | |__________________^ FURB154 -50 | +50 | 51 | def inner2(): | = help: Merge `nonlocal` statements @@ -234,8 +224,7 @@ FURB154.py:53:9: FURB154 [*] Use of repeated consecutive `nonlocal` | 51 | def inner2(): 52 | global x -53 | nonlocal y - | _________^ +53 | / nonlocal y 54 | | nonlocal z | |__________________^ FURB154 | @@ -255,8 +244,7 @@ FURB154.py:53:9: FURB154 [*] Use of repeated consecutive `nonlocal` FURB154.py:58:5: FURB154 [*] Use of repeated consecutive `global` | 57 | def f6(): -58 | global x, y, z - | _____^ +58 | / global x, y, z 59 | | global a, b, c 60 | | global d, e, f | |__________________^ FURB154 diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB156_FURB156.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB156_FURB156.py.snap index 9d94466532651..2041d7694f934 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB156_FURB156.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB156_FURB156.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB156.py:3:5: FURB156 [*] Use of hardcoded string charset | 1 | # Errors -2 | +2 | 3 | _ = "0123456789" | ^^^^^^^^^^^^ FURB156 4 | _ = "01234567" @@ -165,7 +165,7 @@ FURB156.py:9:5: FURB156 [*] Use of hardcoded string charset 10 |+_ = string.punctuation 10 11 | _ = " \t\n\r\v\f" 11 12 | -12 13 | _ = "" in "1234567890" +12 13 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' FURB156.py:10:5: FURB156 [*] Use of hardcoded string charset | @@ -173,8 +173,8 @@ FURB156.py:10:5: FURB156 [*] Use of hardcoded string charset 9 | _ = r"""!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~""" 10 | _ = " \t\n\r\v\f" | ^^^^^^^^^^^^^ FURB156 -11 | -12 | _ = "" in "1234567890" +11 | +12 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' | = help: Replace hardcoded charset with `string.whitespace` @@ -191,19 +191,19 @@ FURB156.py:10:5: FURB156 [*] Use of hardcoded string charset 10 |-_ = " \t\n\r\v\f" 11 |+_ = string.whitespace 11 12 | -12 13 | _ = "" in "1234567890" -13 14 | _ = "" in "12345670" +12 13 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' +13 14 | _ = ( -FURB156.py:12:11: FURB156 [*] Use of hardcoded string charset +FURB156.py:12:5: FURB156 [*] Use of hardcoded string charset | 10 | _ = " \t\n\r\v\f" -11 | -12 | _ = "" in "1234567890" - | ^^^^^^^^^^^^ FURB156 -13 | _ = "" in "12345670" -14 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' +11 | +12 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB156 +13 | _ = ( +14 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' | - = help: Replace hardcoded charset with `string.digits` + = help: Replace hardcoded charset with `string.printable` ℹ Safe fix 1 1 | # Errors @@ -215,75 +215,21 @@ FURB156.py:12:11: FURB156 [*] Use of hardcoded string charset 9 10 | _ = r"""!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~""" 10 11 | _ = " \t\n\r\v\f" 11 12 | -12 |-_ = "" in "1234567890" - 13 |+_ = "" in string.digits -13 14 | _ = "" in "12345670" -14 15 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' -15 16 | _ = ( - -FURB156.py:13:11: FURB156 [*] Use of hardcoded string charset - | -12 | _ = "" in "1234567890" -13 | _ = "" in "12345670" - | ^^^^^^^^^^ FURB156 -14 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' -15 | _ = ( - | - = help: Replace hardcoded charset with `string.octdigits` - -ℹ Safe fix -1 1 | # Errors - 2 |+import string -2 3 | -3 4 | _ = "0123456789" -4 5 | _ = "01234567" --------------------------------------------------------------------------------- -10 11 | _ = " \t\n\r\v\f" -11 12 | -12 13 | _ = "" in "1234567890" -13 |-_ = "" in "12345670" - 14 |+_ = "" in string.octdigits -14 15 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' -15 16 | _ = ( -16 17 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' +12 |-_ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' + 13 |+_ = string.printable +13 14 | _ = ( +14 15 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' +15 16 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" FURB156.py:14:5: FURB156 [*] Use of hardcoded string charset | -12 | _ = "" in "1234567890" -13 | _ = "" in "12345670" -14 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB156 -15 | _ = ( -16 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' - | - = help: Replace hardcoded charset with `string.printable` - -ℹ Safe fix -1 1 | # Errors - 2 |+import string -2 3 | -3 4 | _ = "0123456789" -4 5 | _ = "01234567" --------------------------------------------------------------------------------- -11 12 | -12 13 | _ = "" in "1234567890" -13 14 | _ = "" in "12345670" -14 |-_ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' - 15 |+_ = string.printable -15 16 | _ = ( -16 17 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' -17 18 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" - -FURB156.py:16:5: FURB156 [*] Use of hardcoded string charset - | -14 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' -15 | _ = ( -16 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' - | _____^ -17 | | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" +12 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' +13 | _ = ( +14 | / '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' +15 | | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" | |________________________________________________^ FURB156 -18 | ) -19 | _ = id("0123" +16 | ) +17 | _ = id("0123" | = help: Replace hardcoded charset with `string.printable` @@ -294,27 +240,27 @@ FURB156.py:16:5: FURB156 [*] Use of hardcoded string charset 3 4 | _ = "0123456789" 4 5 | _ = "01234567" -------------------------------------------------------------------------------- -13 14 | _ = "" in "12345670" -14 15 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' -15 16 | _ = ( -16 |- '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' -17 |- "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" - 17 |+ string.printable -18 18 | ) -19 19 | _ = id("0123" -20 20 | "4567" - -FURB156.py:19:8: FURB156 [*] Use of hardcoded string charset +11 12 | +12 13 | _ = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c' +13 14 | _ = ( +14 |- '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' +15 |- "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" + 15 |+ string.printable +16 16 | ) +17 17 | _ = id("0123" +18 18 | "4567" + +FURB156.py:17:8: FURB156 [*] Use of hardcoded string charset | -17 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" -18 | ) -19 | _ = id("0123" +15 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" +16 | ) +17 | _ = id("0123" | ________^ -20 | | "4567" -21 | | "89") +18 | | "4567" +19 | | "89") | |___________^ FURB156 -22 | _ = "" in ("123" -23 | "456" +20 | +21 | _ = ( | = help: Replace hardcoded charset with `string.digits` @@ -325,93 +271,23 @@ FURB156.py:19:8: FURB156 [*] Use of hardcoded string charset 3 4 | _ = "0123456789" 4 5 | _ = "01234567" -------------------------------------------------------------------------------- -16 17 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' -17 18 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" -18 19 | ) -19 |-_ = id("0123" -20 |- "4567" -21 |- "89") - 20 |+_ = id(string.digits) -22 21 | _ = "" in ("123" -23 22 | "456" -24 23 | "789" - -FURB156.py:22:12: FURB156 [*] Use of hardcoded string charset - | -20 | "4567" -21 | "89") -22 | _ = "" in ("123" - | ____________^ -23 | | "456" -24 | | "789" -25 | | "0") - | |______________^ FURB156 -26 | -27 | _ = "" in ( # comment - | - = help: Replace hardcoded charset with `string.digits` - -ℹ Safe fix -1 1 | # Errors - 2 |+import string -2 3 | -3 4 | _ = "0123456789" -4 5 | _ = "01234567" --------------------------------------------------------------------------------- -19 20 | _ = id("0123" -20 21 | "4567" -21 22 | "89") -22 |-_ = "" in ("123" -23 |- "456" -24 |- "789" -25 |- "0") - 23 |+_ = "" in (string.digits) -26 24 | -27 25 | _ = "" in ( # comment -28 26 | "123" - -FURB156.py:28:5: FURB156 [*] Use of hardcoded string charset - | -27 | _ = "" in ( # comment -28 | "123" - | _____^ -29 | | "456" -30 | | "789" -31 | | "0") - | |_______^ FURB156 +14 15 | '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&' +15 16 | "'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c" +16 17 | ) +17 |-_ = id("0123" +18 |- "4567" +19 |- "89") + 18 |+_ = id(string.digits) +20 19 | +21 20 | _ = ( +22 21 | "0123456789" + +FURB156.py:22:5: FURB156 [*] Use of hardcoded string charset | - = help: Replace hardcoded charset with `string.digits` - -ℹ Safe fix -1 1 | # Errors - 2 |+import string -2 3 | -3 4 | _ = "0123456789" -4 5 | _ = "01234567" --------------------------------------------------------------------------------- -25 26 | "0") -26 27 | -27 28 | _ = "" in ( # comment -28 |- "123" -29 |- "456" -30 |- "789" -31 |- "0") - 29 |+ string.digits) -32 30 | -33 31 | -34 32 | _ = "" in ( - -FURB156.py:35:5: FURB156 [*] Use of hardcoded string charset - | -34 | _ = "" in ( -35 | "123" - | _____^ -36 | | "456" # inline comment -37 | | "789" -38 | | "0") - | |_______^ FURB156 -39 | -40 | _ = ( +21 | _ = ( +22 | "0123456789" + | ^^^^^^^^^^^^ FURB156 +23 | ).capitalize() | = help: Replace hardcoded charset with `string.digits` @@ -422,24 +298,22 @@ FURB156.py:35:5: FURB156 [*] Use of hardcoded string charset 3 4 | _ = "0123456789" 4 5 | _ = "01234567" -------------------------------------------------------------------------------- -32 33 | -33 34 | -34 35 | _ = "" in ( -35 |- "123" -36 |- "456" # inline comment -37 |- "789" -38 |- "0") - 36 |+ string.digits) -39 37 | -40 38 | _ = ( -41 39 | "0123456789" - -FURB156.py:41:5: FURB156 [*] Use of hardcoded string charset +19 20 | "89") +20 21 | +21 22 | _ = ( +22 |- "0123456789" + 23 |+ string.digits +23 24 | ).capitalize() +24 25 | +25 26 | _ = ( + +FURB156.py:26:5: FURB156 [*] Use of hardcoded string charset | -40 | _ = ( -41 | "0123456789" +25 | _ = ( +26 | "0123456789" | ^^^^^^^^^^^^ FURB156 -42 | ).capitalize() +27 | # with comment +28 | ).capitalize() | = help: Replace hardcoded charset with `string.digits` @@ -450,22 +324,22 @@ FURB156.py:41:5: FURB156 [*] Use of hardcoded string charset 3 4 | _ = "0123456789" 4 5 | _ = "01234567" -------------------------------------------------------------------------------- -38 39 | "0") -39 40 | -40 41 | _ = ( -41 |- "0123456789" - 42 |+ string.digits -42 43 | ).capitalize() -43 44 | -44 45 | _ = ( - -FURB156.py:45:5: FURB156 [*] Use of hardcoded string charset +23 24 | ).capitalize() +24 25 | +25 26 | _ = ( +26 |- "0123456789" + 27 |+ string.digits +27 28 | # with comment +28 29 | ).capitalize() +29 30 | + +FURB156.py:31:6: FURB156 [*] Use of hardcoded string charset | -44 | _ = ( -45 | "0123456789" - | ^^^^^^^^^^^^ FURB156 -46 | # with comment -47 | ).capitalize() +30 | # example with augmented assignment +31 | _ += "0123456789" + | ^^^^^^^^^^^^ FURB156 +32 | +33 | # OK | = help: Replace hardcoded charset with `string.digits` @@ -476,11 +350,11 @@ FURB156.py:45:5: FURB156 [*] Use of hardcoded string charset 3 4 | _ = "0123456789" 4 5 | _ = "01234567" -------------------------------------------------------------------------------- -42 43 | ).capitalize() -43 44 | -44 45 | _ = ( -45 |- "0123456789" - 46 |+ string.digits -46 47 | # with comment -47 48 | ).capitalize() -48 49 | +28 29 | ).capitalize() +29 30 | +30 31 | # example with augmented assignment +31 |-_ += "0123456789" + 32 |+_ += string.digits +32 33 | +33 34 | # OK +34 35 | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB157_FURB157.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB157_FURB157.py.snap index ef8680e3666d0..fec07e794388e 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB157_FURB157.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB157_FURB157.py.snap @@ -152,7 +152,7 @@ FURB157.py:12:17: FURB157 [*] Verbose expression in `Decimal` constructor 11 | Decimal(float("nan")) 12 | decimal.Decimal("0") | ^^^ FURB157 -13 | +13 | 14 | # OK | = help: Replace with `0` @@ -166,3 +166,390 @@ FURB157.py:12:17: FURB157 [*] Verbose expression in `Decimal` constructor 13 13 | 14 14 | # OK 15 15 | Decimal(0) + +FURB157.py:23:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +22 | # Errors +23 | Decimal("1_000") + | ^^^^^^^ FURB157 +24 | Decimal("__1____000") + | + = help: Replace with `1000` + +ℹ Safe fix +20 20 | # See https://github.com/astral-sh/ruff/issues/13807 +21 21 | +22 22 | # Errors +23 |-Decimal("1_000") + 23 |+Decimal(1000) +24 24 | Decimal("__1____000") +25 25 | +26 26 | # Ok + +FURB157.py:24:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +22 | # Errors +23 | Decimal("1_000") +24 | Decimal("__1____000") + | ^^^^^^^^^^^^ FURB157 +25 | +26 | # Ok + | + = help: Replace with `1000` + +ℹ Safe fix +21 21 | +22 22 | # Errors +23 23 | Decimal("1_000") +24 |-Decimal("__1____000") + 24 |+Decimal(1000) +25 25 | +26 26 | # Ok +27 27 | Decimal("2e-4") + +FURB157.py:48:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +46 | # Non-finite variants +47 | # https://github.com/astral-sh/ruff/issues/14587 +48 | Decimal(float(" nan ")) # Decimal(" nan ") + | ^^^^^^^^^^^^^^ FURB157 +49 | Decimal(float(" +nan ")) # Decimal(" +nan ") +50 | # In this one case, " -nan ", the fix has to be + | + = help: Replace with `" nan "` + +ℹ Safe fix +45 45 | +46 46 | # Non-finite variants +47 47 | # https://github.com/astral-sh/ruff/issues/14587 +48 |-Decimal(float(" nan ")) # Decimal(" nan ") + 48 |+Decimal(" nan ") # Decimal(" nan ") +49 49 | Decimal(float(" +nan ")) # Decimal(" +nan ") +50 50 | # In this one case, " -nan ", the fix has to be +51 51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` + +FURB157.py:49:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +47 | # https://github.com/astral-sh/ruff/issues/14587 +48 | Decimal(float(" nan ")) # Decimal(" nan ") +49 | Decimal(float(" +nan ")) # Decimal(" +nan ") + | ^^^^^^^^^^^^^^^ FURB157 +50 | # In this one case, " -nan ", the fix has to be +51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` + | + = help: Replace with `" +nan "` + +ℹ Safe fix +46 46 | # Non-finite variants +47 47 | # https://github.com/astral-sh/ruff/issues/14587 +48 48 | Decimal(float(" nan ")) # Decimal(" nan ") +49 |-Decimal(float(" +nan ")) # Decimal(" +nan ") + 49 |+Decimal(" +nan ") # Decimal(" +nan ") +50 50 | # In this one case, " -nan ", the fix has to be +51 51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 52 | Decimal(float(" -nan ")) # Decimal("nan") + +FURB157.py:52:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +50 | # In this one case, " -nan ", the fix has to be +51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 | Decimal(float(" -nan ")) # Decimal("nan") + | ^^^^^^^^^^^^^^^ FURB157 +53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 | Decimal(float(" +inf ")) # Decimal(" +inf ") + | + = help: Replace with `"nan"` + +ℹ Safe fix +49 49 | Decimal(float(" +nan ")) # Decimal(" +nan ") +50 50 | # In this one case, " -nan ", the fix has to be +51 51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 |-Decimal(float(" -nan ")) # Decimal("nan") + 52 |+Decimal("nan") # Decimal("nan") +53 53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") + +FURB157.py:53:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 | Decimal(float(" -nan ")) # Decimal("nan") +53 | Decimal(float(" inf ")) # Decimal(" inf ") + | ^^^^^^^^^^^^^^ FURB157 +54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 | Decimal(float(" -inf ")) # Decimal(" -inf ") + | + = help: Replace with `" inf "` + +ℹ Safe fix +50 50 | # In this one case, " -nan ", the fix has to be +51 51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 52 | Decimal(float(" -nan ")) # Decimal("nan") +53 |-Decimal(float(" inf ")) # Decimal(" inf ") + 53 |+Decimal(" inf ") # Decimal(" inf ") +54 54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 56 | Decimal(float(" infinity ")) # Decimal(" infinity ") + +FURB157.py:54:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +52 | Decimal(float(" -nan ")) # Decimal("nan") +53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 | Decimal(float(" +inf ")) # Decimal(" +inf ") + | ^^^^^^^^^^^^^^^ FURB157 +55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 | Decimal(float(" infinity ")) # Decimal(" infinity ") + | + = help: Replace with `" +inf "` + +ℹ Safe fix +51 51 | # `Decimal(" nan ")`` because `Decimal("-nan") != Decimal(float("-nan"))` +52 52 | Decimal(float(" -nan ")) # Decimal("nan") +53 53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 |-Decimal(float(" +inf ")) # Decimal(" +inf ") + 54 |+Decimal(" +inf ") # Decimal(" +inf ") +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") + +FURB157.py:55:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 | Decimal(float(" -inf ")) # Decimal(" -inf ") + | ^^^^^^^^^^^^^^^ FURB157 +56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") + | + = help: Replace with `" -inf "` + +ℹ Safe fix +52 52 | Decimal(float(" -nan ")) # Decimal("nan") +53 53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 |-Decimal(float(" -inf ")) # Decimal(" -inf ") + 55 |+Decimal(" -inf ") # Decimal(" -inf ") +56 56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") +58 58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") + +FURB157.py:56:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 | Decimal(float(" infinity ")) # Decimal(" infinity ") + | ^^^^^^^^^^^^^^^^^^^ FURB157 +57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") +58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") + | + = help: Replace with `" infinity "` + +ℹ Safe fix +53 53 | Decimal(float(" inf ")) # Decimal(" inf ") +54 54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 |-Decimal(float(" infinity ")) # Decimal(" infinity ") + 56 |+Decimal(" infinity ") # Decimal(" infinity ") +57 57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") +58 58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") +59 59 | + +FURB157.py:57:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") + | ^^^^^^^^^^^^^^^^^^^^ FURB157 +58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") + | + = help: Replace with `" +infinity "` + +ℹ Safe fix +54 54 | Decimal(float(" +inf ")) # Decimal(" +inf ") +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 |-Decimal(float(" +infinity ")) # Decimal(" +infinity ") + 57 |+Decimal(" +infinity ") # Decimal(" +infinity ") +58 58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") +59 59 | +60 60 | # Escape sequence handling in "-nan" case + +FURB157.py:58:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") +58 | Decimal(float(" -infinity ")) # Decimal(" -infinity ") + | ^^^^^^^^^^^^^^^^^^^^ FURB157 +59 | +60 | # Escape sequence handling in "-nan" case + | + = help: Replace with `" -infinity "` + +ℹ Safe fix +55 55 | Decimal(float(" -inf ")) # Decimal(" -inf ") +56 56 | Decimal(float(" infinity ")) # Decimal(" infinity ") +57 57 | Decimal(float(" +infinity ")) # Decimal(" +infinity ") +58 |-Decimal(float(" -infinity ")) # Decimal(" -infinity ") + 58 |+Decimal(" -infinity ") # Decimal(" -infinity ") +59 59 | +60 60 | # Escape sequence handling in "-nan" case +61 61 | # Here we do not bother respecting the original whitespace + +FURB157.py:64:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +62 | # and other trivia when offering a fix. +63 | # https://github.com/astral-sh/ruff/issues/16771 +64 | Decimal(float("\x2dnan")) + | ^^^^^^^^^^^^^^^^ FURB157 +65 | Decimal(float("\x20\x2dnan")) +66 | Decimal(float("\x20\u002dnan")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +61 61 | # Here we do not bother respecting the original whitespace +62 62 | # and other trivia when offering a fix. +63 63 | # https://github.com/astral-sh/ruff/issues/16771 +64 |-Decimal(float("\x2dnan")) + 64 |+Decimal("nan") +65 65 | Decimal(float("\x20\x2dnan")) +66 66 | Decimal(float("\x20\u002dnan")) +67 67 | Decimal(float("\x20\U0000002dnan")) + +FURB157.py:65:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +63 | # https://github.com/astral-sh/ruff/issues/16771 +64 | Decimal(float("\x2dnan")) +65 | Decimal(float("\x20\x2dnan")) + | ^^^^^^^^^^^^^^^^^^^^ FURB157 +66 | Decimal(float("\x20\u002dnan")) +67 | Decimal(float("\x20\U0000002dnan")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +62 62 | # and other trivia when offering a fix. +63 63 | # https://github.com/astral-sh/ruff/issues/16771 +64 64 | Decimal(float("\x2dnan")) +65 |-Decimal(float("\x20\x2dnan")) + 65 |+Decimal("nan") +66 66 | Decimal(float("\x20\u002dnan")) +67 67 | Decimal(float("\x20\U0000002dnan")) +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) + +FURB157.py:66:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +64 | Decimal(float("\x2dnan")) +65 | Decimal(float("\x20\x2dnan")) +66 | Decimal(float("\x20\u002dnan")) + | ^^^^^^^^^^^^^^^^^^^^^^ FURB157 +67 | Decimal(float("\x20\U0000002dnan")) +68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +63 63 | # https://github.com/astral-sh/ruff/issues/16771 +64 64 | Decimal(float("\x2dnan")) +65 65 | Decimal(float("\x20\x2dnan")) +66 |-Decimal(float("\x20\u002dnan")) + 66 |+Decimal("nan") +67 67 | Decimal(float("\x20\U0000002dnan")) +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) + +FURB157.py:67:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +65 | Decimal(float("\x20\x2dnan")) +66 | Decimal(float("\x20\u002dnan")) +67 | Decimal(float("\x20\U0000002dnan")) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB157 +68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +64 64 | Decimal(float("\x2dnan")) +65 65 | Decimal(float("\x20\x2dnan")) +66 66 | Decimal(float("\x20\u002dnan")) +67 |-Decimal(float("\x20\U0000002dnan")) + 67 |+Decimal("nan") +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 70 | Decimal(float(" -" "nan")) + +FURB157.py:68:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +66 | Decimal(float("\x20\u002dnan")) +67 | Decimal(float("\x20\U0000002dnan")) +68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB157 +69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 | Decimal(float(" -" "nan")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +65 65 | Decimal(float("\x20\x2dnan")) +66 66 | Decimal(float("\x20\u002dnan")) +67 67 | Decimal(float("\x20\U0000002dnan")) +68 |-Decimal(float("\N{space}\N{hyPHen-MINus}nan")) + 68 |+Decimal("nan") +69 69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 70 | Decimal(float(" -" "nan")) +71 71 | Decimal(float("-nAn")) + +FURB157.py:69:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +67 | Decimal(float("\x20\U0000002dnan")) +68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB157 +70 | Decimal(float(" -" "nan")) +71 | Decimal(float("-nAn")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +66 66 | Decimal(float("\x20\u002dnan")) +67 67 | Decimal(float("\x20\U0000002dnan")) +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 |-Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) + 69 |+Decimal("nan") +70 70 | Decimal(float(" -" "nan")) +71 71 | Decimal(float("-nAn")) + +FURB157.py:70:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 | Decimal(float(" -" "nan")) + | ^^^^^^^^^^^^^^^^^^^ FURB157 +71 | Decimal(float("-nAn")) + | + = help: Replace with `"nan"` + +ℹ Safe fix +67 67 | Decimal(float("\x20\U0000002dnan")) +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 |-Decimal(float(" -" "nan")) + 70 |+Decimal("nan") +71 71 | Decimal(float("-nAn")) + +FURB157.py:71:9: FURB157 [*] Verbose expression in `Decimal` constructor + | +69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 | Decimal(float(" -" "nan")) +71 | Decimal(float("-nAn")) + | ^^^^^^^^^^^^^ FURB157 + | + = help: Replace with `"nan"` + +ℹ Safe fix +68 68 | Decimal(float("\N{space}\N{hyPHen-MINus}nan")) +69 69 | Decimal(float("\x20\N{character tabulation}\N{hyphen-minus}nan")) +70 70 | Decimal(float(" -" "nan")) +71 |-Decimal(float("-nAn")) + 71 |+Decimal("nan") diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB161_FURB161.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB161_FURB161.py.snap index 0085558579ae4..2bff822228477 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB161_FURB161.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB161_FURB161.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB161.py:6:9: FURB161 [*] Use of `bin(x).count('1')` | 4 | return 10 -5 | +5 | 6 | count = bin(x).count("1") # FURB161 | ^^^^^^^^^^^^^^^^^ FURB161 7 | count = bin(10).count("1") # FURB161 @@ -12,7 +12,7 @@ FURB161.py:6:9: FURB161 [*] Use of `bin(x).count('1')` | = help: Replace with `(x).bit_count()` -ℹ Safe fix +ℹ Unsafe fix 3 3 | def ten() -> int: 4 4 | return 10 5 5 | @@ -137,7 +137,7 @@ FURB161.py:12:9: FURB161 [*] Use of `bin(ten()).count('1')` | = help: Replace with `ten().bit_count()` -ℹ Safe fix +ℹ Unsafe fix 9 9 | count = bin(0xA).count("1") # FURB161 10 10 | count = bin(0o12).count("1") # FURB161 11 11 | count = bin(0x10 + 0x1000).count("1") # FURB161 @@ -145,7 +145,7 @@ FURB161.py:12:9: FURB161 [*] Use of `bin(ten()).count('1')` 12 |+count = ten().bit_count() # FURB161 13 13 | count = bin((10)).count("1") # FURB161 14 14 | count = bin("10" "15").count("1") # FURB161 -15 15 | +15 15 | count = bin("123").count("1") # FURB161 FURB161.py:13:9: FURB161 [*] Use of `bin(10).count('1')` | @@ -154,6 +154,7 @@ FURB161.py:13:9: FURB161 [*] Use of `bin(10).count('1')` 13 | count = bin((10)).count("1") # FURB161 | ^^^^^^^^^^^^^^^^^^^^ FURB161 14 | count = bin("10" "15").count("1") # FURB161 +15 | count = bin("123").count("1") # FURB161 | = help: Replace with `(10).bit_count()` @@ -164,8 +165,8 @@ FURB161.py:13:9: FURB161 [*] Use of `bin(10).count('1')` 13 |-count = bin((10)).count("1") # FURB161 13 |+count = (10).bit_count() # FURB161 14 14 | count = bin("10" "15").count("1") # FURB161 -15 15 | -16 16 | count = x.bit_count() # OK +15 15 | count = bin("123").count("1") # FURB161 +16 16 | FURB161.py:14:9: FURB161 [*] Use of `bin("10" "15").count('1')` | @@ -173,19 +174,37 @@ FURB161.py:14:9: FURB161 [*] Use of `bin("10" "15").count('1')` 13 | count = bin((10)).count("1") # FURB161 14 | count = bin("10" "15").count("1") # FURB161 | ^^^^^^^^^^^^^^^^^^^^^^^^^ FURB161 -15 | -16 | count = x.bit_count() # OK +15 | count = bin("123").count("1") # FURB161 | = help: Replace with `("10" "15").bit_count()` -ℹ Safe fix +ℹ Unsafe fix 11 11 | count = bin(0x10 + 0x1000).count("1") # FURB161 12 12 | count = bin(ten()).count("1") # FURB161 13 13 | count = bin((10)).count("1") # FURB161 14 |-count = bin("10" "15").count("1") # FURB161 14 |+count = ("10" "15").bit_count() # FURB161 -15 15 | -16 16 | count = x.bit_count() # OK -17 17 | count = (10).bit_count() # OK +15 15 | count = bin("123").count("1") # FURB161 +16 16 | +17 17 | count = x.bit_count() # OK +FURB161.py:15:9: FURB161 [*] Use of `bin("123").count('1')` + | +13 | count = bin((10)).count("1") # FURB161 +14 | count = bin("10" "15").count("1") # FURB161 +15 | count = bin("123").count("1") # FURB161 + | ^^^^^^^^^^^^^^^^^^^^^ FURB161 +16 | +17 | count = x.bit_count() # OK + | + = help: Replace with `"123".bit_count()` +ℹ Unsafe fix +12 12 | count = bin(ten()).count("1") # FURB161 +13 13 | count = bin((10)).count("1") # FURB161 +14 14 | count = bin("10" "15").count("1") # FURB161 +15 |-count = bin("123").count("1") # FURB161 + 15 |+count = "123".bit_count() # FURB161 +16 16 | +17 17 | count = x.bit_count() # OK +18 18 | count = (10).bit_count() # OK diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB162_FURB162.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB162_FURB162.py.snap new file mode 100644 index 0000000000000..43ab280fcf5be --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB162_FURB162.py.snap @@ -0,0 +1,241 @@ +--- +source: crates/ruff_linter/src/rules/refurb/mod.rs +--- +FURB162.py:8:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | +6 | ### Errors +7 | +8 | datetime.fromisoformat(date.replace("Z", "+00:00")) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB162 +9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +5 5 | +6 6 | ### Errors +7 7 | +8 |-datetime.fromisoformat(date.replace("Z", "+00:00")) + 8 |+datetime.fromisoformat(date) +9 9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) +10 10 | +11 11 | datetime.fromisoformat(date[:-1] + "-00") + +FURB162.py:9:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | + 8 | datetime.fromisoformat(date.replace("Z", "+00:00")) + 9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB162 +10 | +11 | datetime.fromisoformat(date[:-1] + "-00") + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +6 6 | ### Errors +7 7 | +8 8 | datetime.fromisoformat(date.replace("Z", "+00:00")) +9 |-datetime.fromisoformat(date.replace("Z", "-00:" "00")) + 9 |+datetime.fromisoformat(date) +10 10 | +11 11 | datetime.fromisoformat(date[:-1] + "-00") +12 12 | datetime.fromisoformat(date[:-1:] + "-0000") + +FURB162.py:11:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | + 9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) +10 | +11 | datetime.fromisoformat(date[:-1] + "-00") + | ^^^^^^^^^^^^^^^^^ FURB162 +12 | datetime.fromisoformat(date[:-1:] + "-0000") + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +8 8 | datetime.fromisoformat(date.replace("Z", "+00:00")) +9 9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) +10 10 | +11 |-datetime.fromisoformat(date[:-1] + "-00") + 11 |+datetime.fromisoformat(date) +12 12 | datetime.fromisoformat(date[:-1:] + "-0000") +13 13 | +14 14 | datetime.fromisoformat(date.strip("Z") + """+0""" + +FURB162.py:12:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | +11 | datetime.fromisoformat(date[:-1] + "-00") +12 | datetime.fromisoformat(date[:-1:] + "-0000") + | ^^^^^^^^^^^^^^^^^^^^ FURB162 +13 | +14 | datetime.fromisoformat(date.strip("Z") + """+0""" + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +9 9 | datetime.fromisoformat(date.replace("Z", "-00:" "00")) +10 10 | +11 11 | datetime.fromisoformat(date[:-1] + "-00") +12 |-datetime.fromisoformat(date[:-1:] + "-0000") + 12 |+datetime.fromisoformat(date) +13 13 | +14 14 | datetime.fromisoformat(date.strip("Z") + """+0""" +15 15 | """0""") + +FURB162.py:14:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | +12 | datetime.fromisoformat(date[:-1:] + "-0000") +13 | +14 | datetime.fromisoformat(date.strip("Z") + """+0""" + | ________________________^ +15 | | """0""") + | |________________________________________________^ FURB162 +16 | datetime.fromisoformat(date.rstrip("Z") + "+\x30\60" '\u0030\N{DIGIT ZERO}') + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +11 11 | datetime.fromisoformat(date[:-1] + "-00") +12 12 | datetime.fromisoformat(date[:-1:] + "-0000") +13 13 | +14 |-datetime.fromisoformat(date.strip("Z") + """+0""" +15 |- """0""") + 14 |+datetime.fromisoformat(date) +16 15 | datetime.fromisoformat(date.rstrip("Z") + "+\x30\60" '\u0030\N{DIGIT ZERO}') +17 16 | +18 17 | datetime.fromisoformat( + +FURB162.py:16:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | +14 | datetime.fromisoformat(date.strip("Z") + """+0""" +15 | """0""") +16 | datetime.fromisoformat(date.rstrip("Z") + "+\x30\60" '\u0030\N{DIGIT ZERO}') + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB162 +17 | +18 | datetime.fromisoformat( + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +13 13 | +14 14 | datetime.fromisoformat(date.strip("Z") + """+0""" +15 15 | """0""") +16 |-datetime.fromisoformat(date.rstrip("Z") + "+\x30\60" '\u0030\N{DIGIT ZERO}') + 16 |+datetime.fromisoformat(date) +17 17 | +18 18 | datetime.fromisoformat( +19 19 | # Preserved + +FURB162.py:20:5: FURB162 [*] Unnecessary timezone replacement with zero offset + | +18 | datetime.fromisoformat( +19 | # Preserved +20 | / ( # Preserved +21 | | date +22 | | ).replace("Z", "+00") + | |_________________________^ FURB162 +23 | ) + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +19 19 | # Preserved +20 20 | ( # Preserved +21 21 | date +22 |- ).replace("Z", "+00") + 22 |+ ) +23 23 | ) +24 24 | +25 25 | datetime.fromisoformat( + +FURB162.py:26:5: FURB162 [*] Unnecessary timezone replacement with zero offset + | +25 | datetime.fromisoformat( +26 | / (date +27 | | # Preserved +28 | | ) +29 | | . +30 | | rstrip("Z" +31 | | # Unsafe +32 | | ) + "-00" # Preserved + | |________________________^ FURB162 +33 | ) + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +25 25 | datetime.fromisoformat( +26 26 | (date +27 27 | # Preserved +28 |- ) +29 |- . +30 |- rstrip("Z" +31 |- # Unsafe +32 |- ) + "-00" # Preserved + 28 |+ ) # Preserved +33 29 | ) +34 30 | +35 31 | datetime.fromisoformat( + +FURB162.py:36:5: FURB162 [*] Unnecessary timezone replacement with zero offset + | +35 | datetime.fromisoformat( +36 | / ( # Preserved +37 | | date +38 | | ).strip("Z") + "+0000" + | |__________________________^ FURB162 +39 | ) + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +35 35 | datetime.fromisoformat( +36 36 | ( # Preserved +37 37 | date +38 |- ).strip("Z") + "+0000" + 38 |+ ) +39 39 | ) +40 40 | +41 41 | datetime.fromisoformat( + +FURB162.py:42:5: FURB162 [*] Unnecessary timezone replacement with zero offset + | +41 | datetime.fromisoformat( +42 | / (date +43 | | # Preserved +44 | | ) +45 | | [ # Unsafe +46 | | :-1 +47 | | ] + "-00" + | |_____________^ FURB162 +48 | ) + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +42 42 | (date +43 43 | # Preserved +44 44 | ) +45 |- [ # Unsafe +46 |- :-1 +47 |- ] + "-00" +48 45 | ) +49 46 | +50 47 | + +FURB162.py:52:24: FURB162 [*] Unnecessary timezone replacement with zero offset + | +51 | # Edge case +52 | datetime.fromisoformat("Z2025-01-01T00:00:00Z".strip("Z") + "+00:00") + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB162 + | + = help: Remove `.replace()` call + +ℹ Unsafe fix +49 49 | +50 50 | +51 51 | # Edge case +52 |-datetime.fromisoformat("Z2025-01-01T00:00:00Z".strip("Z") + "+00:00") + 52 |+datetime.fromisoformat("Z2025-01-01T00:00:00Z") +53 53 | +54 54 | +55 55 | ### No errors diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB163_FURB163.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB163_FURB163.py.snap index c305821cc9a85..0985c7f1c9117 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB163_FURB163.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB163_FURB163.py.snap @@ -152,7 +152,7 @@ FURB163.py:12:1: FURB163 [*] Prefer `math.log10(1)` over `math.log` with a redun 11 | math.log(1, 2.0) 12 | math.log(1, 10.0) | ^^^^^^^^^^^^^^^^^ FURB163 -13 | +13 | 14 | # OK | = help: Replace with `math.log10(1)` diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB164_FURB164.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB164_FURB164.py.snap index 04340e219c219..e15af106a498f 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB164_FURB164.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB164_FURB164.py.snap @@ -341,7 +341,7 @@ FURB164.py:22:5: FURB164 [*] Verbose method `from_float` in `Decimal` constructi 21 | _ = Decimal.from_float(float("-Infinity")) 22 | _ = Decimal.from_float(float("nan")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB164 -23 | +23 | 24 | # OK | = help: Replace with `Decimal` constructor diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB166_FURB166.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB166_FURB166.py.snap index c78dbdb22cad2..162b036f6a115 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB166_FURB166.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB166_FURB166.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB166.py:3:5: FURB166 [*] Use of `int` with explicit `base=2` after removing prefix | 1 | # Errors -2 | +2 | 3 | _ = int("0b1010"[2:], 2) | ^^^^^^^^^^^^^^^^^^^^ FURB166 4 | _ = int("0o777"[2:], 8) @@ -46,7 +46,7 @@ FURB166.py:5:5: FURB166 [*] Use of `int` with explicit `base=16` after removing 4 | _ = int("0o777"[2:], 8) 5 | _ = int("0xFFFF"[2:], 16) | ^^^^^^^^^^^^^^^^^^^^^ FURB166 -6 | +6 | 7 | b = "0b11" | = help: Replace with `base=0` @@ -66,7 +66,7 @@ FURB166.py:8:5: FURB166 [*] Use of `int` with explicit `base=2` after removing p 7 | b = "0b11" 8 | _ = int(b[2:], 2) | ^^^^^^^^^^^^^ FURB166 - 9 | + 9 | 10 | _ = int("0xFFFF"[2:], base=16) | = help: Replace with `base=0` @@ -84,10 +84,10 @@ FURB166.py:8:5: FURB166 [*] Use of `int` with explicit `base=2` after removing p FURB166.py:10:5: FURB166 [*] Use of `int` with explicit `base=16` after removing prefix | 8 | _ = int(b[2:], 2) - 9 | + 9 | 10 | _ = int("0xFFFF"[2:], base=16) | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB166 -11 | +11 | 12 | _ = int(b"0xFFFF"[2:], 16) | = help: Replace with `base=0` @@ -105,7 +105,7 @@ FURB166.py:10:5: FURB166 [*] Use of `int` with explicit `base=16` after removing FURB166.py:12:5: FURB166 [*] Use of `int` with explicit `base=16` after removing prefix | 10 | _ = int("0xFFFF"[2:], base=16) -11 | +11 | 12 | _ = int(b"0xFFFF"[2:], 16) | ^^^^^^^^^^^^^^^^^^^^^^ FURB166 | @@ -125,7 +125,7 @@ FURB166.py:19:5: FURB166 [*] Use of `int` with explicit `base=16` after removing | 19 | _ = int(get_str()[2:], 16) | ^^^^^^^^^^^^^^^^^^^^^^ FURB166 -20 | +20 | 21 | # OK | = help: Replace with `base=0` diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB167_FURB167.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB167_FURB167.py.snap index a95fff1e098b8..a34ef22a7a676 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB167_FURB167.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB167_FURB167.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB167.py:13:42: FURB167 [*] Use of regular expression alias `re.I` | @@ -41,5 +42,3 @@ FURB167.py:21:39: FURB167 [*] Use of regular expression alias `re.I` 21 |- if match("^hello", "hello world", I): 22 |+ if match("^hello", "hello world", re.IGNORECASE): 22 23 | pass - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB168_FURB168.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB168_FURB168.py.snap index 88aa3efb4ea4a..c9b6165ff5a6e 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB168_FURB168.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB168_FURB168.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB168.py:5:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 3 | # Errors. -4 | +4 | 5 | if isinstance(foo, type(None)): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 6 | pass @@ -19,14 +19,14 @@ FURB168.py:5:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if a 5 |+if foo is None: 6 6 | pass 7 7 | -8 8 | if isinstance(foo, (type(None))): +8 8 | if isinstance(foo and bar, type(None)): FURB168.py:8:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 6 | pass -7 | -8 | if isinstance(foo, (type(None))): - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +7 | +8 | if isinstance(foo and bar, type(None)): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 9 | pass | = help: Replace with `is` operator @@ -35,8 +35,8 @@ FURB168.py:8:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if a 5 5 | if isinstance(foo, type(None)): 6 6 | pass 7 7 | -8 |-if isinstance(foo, (type(None))): - 8 |+if foo is None: +8 |-if isinstance(foo and bar, type(None)): + 8 |+if (foo and bar) is None: 9 9 | pass 10 10 | 11 11 | if isinstance(foo, (type(None), type(None), type(None))): @@ -44,7 +44,7 @@ FURB168.py:8:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if a FURB168.py:11:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 9 | pass -10 | +10 | 11 | if isinstance(foo, (type(None), type(None), type(None))): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 12 | pass @@ -52,21 +52,21 @@ FURB168.py:11:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if = help: Replace with `is` operator ℹ Safe fix -8 8 | if isinstance(foo, (type(None))): +8 8 | if isinstance(foo and bar, type(None)): 9 9 | pass 10 10 | 11 |-if isinstance(foo, (type(None), type(None), type(None))): 11 |+if foo is None: 12 12 | pass 13 13 | -14 14 | if isinstance(foo, None | None): +14 14 | if isinstance(foo, type(None)) is True: FURB168.py:14:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 12 | pass -13 | -14 | if isinstance(foo, None | None): - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +13 | +14 | if isinstance(foo, type(None)) is True: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 15 | pass | = help: Replace with `is` operator @@ -75,28 +75,28 @@ FURB168.py:14:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if 11 11 | if isinstance(foo, (type(None), type(None), type(None))): 12 12 | pass 13 13 | -14 |-if isinstance(foo, None | None): - 14 |+if foo is None: +14 |-if isinstance(foo, type(None)) is True: + 14 |+if (foo is None) is True: 15 15 | pass 16 16 | -17 17 | if isinstance(foo, (None | None)): +17 17 | if -isinstance(foo, type(None)): -FURB168.py:17:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` +FURB168.py:17:5: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 15 | pass -16 | -17 | if isinstance(foo, (None | None)): - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +16 | +17 | if -isinstance(foo, type(None)): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 18 | pass | = help: Replace with `is` operator ℹ Safe fix -14 14 | if isinstance(foo, None | None): +14 14 | if isinstance(foo, type(None)) is True: 15 15 | pass 16 16 | -17 |-if isinstance(foo, (None | None)): - 17 |+if foo is None: +17 |-if -isinstance(foo, type(None)): + 17 |+if -(foo is None): 18 18 | pass 19 19 | 20 20 | if isinstance(foo, None | type(None)): @@ -104,7 +104,7 @@ FURB168.py:17:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if FURB168.py:20:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 18 | pass -19 | +19 | 20 | if isinstance(foo, None | type(None)): | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 21 | pass @@ -112,21 +112,21 @@ FURB168.py:20:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if = help: Replace with `is` operator ℹ Safe fix -17 17 | if isinstance(foo, (None | None)): +17 17 | if -isinstance(foo, type(None)): 18 18 | pass 19 19 | 20 |-if isinstance(foo, None | type(None)): 20 |+if foo is None: 21 21 | pass 22 22 | -23 23 | if isinstance(foo, (None | type(None))): +23 23 | if isinstance(foo, type(None) | type(None)): FURB168.py:23:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` | 21 | pass -22 | -23 | if isinstance(foo, (None | type(None))): - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +22 | +23 | if isinstance(foo, type(None) | type(None)): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 24 | pass | = help: Replace with `is` operator @@ -135,7 +135,7 @@ FURB168.py:23:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if 20 20 | if isinstance(foo, None | type(None)): 21 21 | pass 22 22 | -23 |-if isinstance(foo, (None | type(None))): +23 |-if isinstance(foo, type(None) | type(None)): 23 |+if foo is None: 24 24 | pass 25 25 | @@ -158,6 +158,64 @@ FURB168.py:27:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if 27 |+if foo is None: 28 28 | pass 29 29 | -30 30 | +30 30 | if isinstance( +FURB168.py:38:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` + | +36 | from typing import Union +37 | +38 | if isinstance(foo, Union[None]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +39 | ... + | + = help: Replace with `is` operator +ℹ Safe fix +35 35 | +36 36 | from typing import Union +37 37 | +38 |-if isinstance(foo, Union[None]): + 38 |+if foo is None: +39 39 | ... +40 40 | +41 41 | if isinstance(foo, Union[None, None]): + +FURB168.py:41:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` + | +39 | ... +40 | +41 | if isinstance(foo, Union[None, None]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +42 | ... + | + = help: Replace with `is` operator + +ℹ Safe fix +38 38 | if isinstance(foo, Union[None]): +39 39 | ... +40 40 | +41 |-if isinstance(foo, Union[None, None]): + 41 |+if foo is None: +42 42 | ... +43 43 | +44 44 | if isinstance(foo, Union[None, type(None)]): + +FURB168.py:44:4: FURB168 [*] Prefer `is` operator over `isinstance` to check if an object is `None` + | +42 | ... +43 | +44 | if isinstance(foo, Union[None, type(None)]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB168 +45 | ... + | + = help: Replace with `is` operator + +ℹ Safe fix +41 41 | if isinstance(foo, Union[None, None]): +42 42 | ... +43 43 | +44 |-if isinstance(foo, Union[None, type(None)]): + 44 |+if foo is None: +45 45 | ... +46 46 | +47 47 | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB169_FURB169.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB169_FURB169.py.snap index ee9ee14f36ef1..4a711ebcfca17 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB169_FURB169.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB169_FURB169.py.snap @@ -1,16 +1,16 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs --- -FURB169.py:5:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:5:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 3 | # Error. -4 | +4 | 5 | type(foo) is type(None) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -6 | +6 | 7 | type(None) is type(foo) | - = help: Replace with `foo is None` + = help: Replace with `is None` ℹ Safe fix 2 2 | @@ -22,16 +22,16 @@ FURB169.py:5:1: FURB169 [*] Compare the identities of `foo` and `None` instead o 7 7 | type(None) is type(foo) 8 8 | -FURB169.py:7:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:7:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 5 | type(foo) is type(None) -6 | +6 | 7 | type(None) is type(foo) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -8 | +8 | 9 | type(None) is type(None) | - = help: Replace with `foo is None` + = help: Replace with `is None` ℹ Safe fix 4 4 | @@ -43,16 +43,16 @@ FURB169.py:7:1: FURB169 [*] Compare the identities of `foo` and `None` instead o 9 9 | type(None) is type(None) 10 10 | -FURB169.py:9:1: FURB169 [*] Compare the identities of `None` and `None` instead of their respective types +FURB169.py:9:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 7 | type(None) is type(foo) - 8 | + 8 | 9 | type(None) is type(None) | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -10 | +10 | 11 | type(foo) is not type(None) | - = help: Replace with `None is None` + = help: Replace with `is None` ℹ Safe fix 6 6 | @@ -64,16 +64,16 @@ FURB169.py:9:1: FURB169 [*] Compare the identities of `None` and `None` instead 11 11 | type(foo) is not type(None) 12 12 | -FURB169.py:11:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:11:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 9 | type(None) is type(None) -10 | +10 | 11 | type(foo) is not type(None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -12 | +12 | 13 | type(None) is not type(foo) | - = help: Replace with `foo is not None` + = help: Replace with `is not None` ℹ Safe fix 8 8 | @@ -85,16 +85,16 @@ FURB169.py:11:1: FURB169 [*] Compare the identities of `foo` and `None` instead 13 13 | type(None) is not type(foo) 14 14 | -FURB169.py:13:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:13:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 11 | type(foo) is not type(None) -12 | +12 | 13 | type(None) is not type(foo) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -14 | +14 | 15 | type(None) is not type(None) | - = help: Replace with `foo is not None` + = help: Replace with `is not None` ℹ Safe fix 10 10 | @@ -106,16 +106,16 @@ FURB169.py:13:1: FURB169 [*] Compare the identities of `foo` and `None` instead 15 15 | type(None) is not type(None) 16 16 | -FURB169.py:15:1: FURB169 [*] Compare the identities of `None` and `None` instead of their respective types +FURB169.py:15:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 13 | type(None) is not type(foo) -14 | +14 | 15 | type(None) is not type(None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -16 | +16 | 17 | type(foo) == type(None) | - = help: Replace with `None is not None` + = help: Replace with `is not None` ℹ Safe fix 12 12 | @@ -127,16 +127,16 @@ FURB169.py:15:1: FURB169 [*] Compare the identities of `None` and `None` instead 17 17 | type(foo) == type(None) 18 18 | -FURB169.py:17:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:17:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 15 | type(None) is not type(None) -16 | +16 | 17 | type(foo) == type(None) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -18 | +18 | 19 | type(None) == type(foo) | - = help: Replace with `foo is None` + = help: Replace with `is None` ℹ Safe fix 14 14 | @@ -148,16 +148,16 @@ FURB169.py:17:1: FURB169 [*] Compare the identities of `foo` and `None` instead 19 19 | type(None) == type(foo) 20 20 | -FURB169.py:19:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:19:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 17 | type(foo) == type(None) -18 | +18 | 19 | type(None) == type(foo) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -20 | +20 | 21 | type(None) == type(None) | - = help: Replace with `foo is None` + = help: Replace with `is None` ℹ Safe fix 16 16 | @@ -169,16 +169,16 @@ FURB169.py:19:1: FURB169 [*] Compare the identities of `foo` and `None` instead 21 21 | type(None) == type(None) 22 22 | -FURB169.py:21:1: FURB169 [*] Compare the identities of `None` and `None` instead of their respective types +FURB169.py:21:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` | 19 | type(None) == type(foo) -20 | +20 | 21 | type(None) == type(None) | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -22 | +22 | 23 | type(foo) != type(None) | - = help: Replace with `None is None` + = help: Replace with `is None` ℹ Safe fix 18 18 | @@ -190,16 +190,16 @@ FURB169.py:21:1: FURB169 [*] Compare the identities of `None` and `None` instead 23 23 | type(foo) != type(None) 24 24 | -FURB169.py:23:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:23:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 21 | type(None) == type(None) -22 | +22 | 23 | type(foo) != type(None) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -24 | +24 | 25 | type(None) != type(foo) | - = help: Replace with `foo is not None` + = help: Replace with `is not None` ℹ Safe fix 20 20 | @@ -211,16 +211,16 @@ FURB169.py:23:1: FURB169 [*] Compare the identities of `foo` and `None` instead 25 25 | type(None) != type(foo) 26 26 | -FURB169.py:25:1: FURB169 [*] Compare the identities of `foo` and `None` instead of their respective types +FURB169.py:25:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 23 | type(foo) != type(None) -24 | +24 | 25 | type(None) != type(foo) | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -26 | +26 | 27 | type(None) != type(None) | - = help: Replace with `foo is not None` + = help: Replace with `is not None` ℹ Safe fix 22 22 | @@ -232,16 +232,16 @@ FURB169.py:25:1: FURB169 [*] Compare the identities of `foo` and `None` instead 27 27 | type(None) != type(None) 28 28 | -FURB169.py:27:1: FURB169 [*] Compare the identities of `None` and `None` instead of their respective types +FURB169.py:27:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` | 25 | type(None) != type(foo) -26 | +26 | 27 | type(None) != type(None) | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB169 -28 | -29 | # Ok. +28 | +29 | type(a.b) is type(None) | - = help: Replace with `None is not None` + = help: Replace with `is not None` ℹ Safe fix 24 24 | @@ -250,7 +250,103 @@ FURB169.py:27:1: FURB169 [*] Compare the identities of `None` and `None` instead 27 |-type(None) != type(None) 27 |+None is not None 28 28 | -29 29 | # Ok. +29 29 | type(a.b) is type(None) 30 30 | +FURB169.py:29:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` + | +27 | type(None) != type(None) +28 | +29 | type(a.b) is type(None) + | ^^^^^^^^^^^^^^^^^^^^^^^ FURB169 +30 | +31 | type( + | + = help: Replace with `is None` + +ℹ Safe fix +26 26 | +27 27 | type(None) != type(None) +28 28 | +29 |-type(a.b) is type(None) + 29 |+a.b is None +30 30 | +31 31 | type( +32 32 | a( + +FURB169.py:31:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` + | +29 | type(a.b) is type(None) +30 | +31 | / type( +32 | | a( +33 | | # Comment +34 | | ) +35 | | ) != type(None) + | |_______________^ FURB169 +36 | +37 | type( + | + = help: Replace with `is not None` +ℹ Unsafe fix +28 28 | +29 29 | type(a.b) is type(None) +30 30 | +31 |-type( +32 |- a( +33 |- # Comment +34 |- ) +35 |-) != type(None) + 31 |+a() is not None +36 32 | +37 33 | type( +38 34 | a := 1 + +FURB169.py:37:1: FURB169 [*] When checking against `None`, use `is` instead of comparison with `type(None)` + | +35 | ) != type(None) +36 | +37 | / type( +38 | | a := 1 +39 | | ) == type(None) + | |_______________^ FURB169 +40 | +41 | type( + | + = help: Replace with `is None` + +ℹ Safe fix +34 34 | ) +35 35 | ) != type(None) +36 36 | +37 |-type( +38 |- a := 1 +39 |-) == type(None) + 37 |+(a := 1) is None +40 38 | +41 39 | type( +42 40 | a for a in range(0) + +FURB169.py:41:1: FURB169 [*] When checking against `None`, use `is not` instead of comparison with `type(None)` + | +39 | ) == type(None) +40 | +41 | / type( +42 | | a for a in range(0) +43 | | ) is not type(None) + | |___________________^ FURB169 + | + = help: Replace with `is not None` + +ℹ Safe fix +38 38 | a := 1 +39 39 | ) == type(None) +40 40 | +41 |-type( +42 |- a for a in range(0) +43 |-) is not type(None) + 41 |+(a for a in range(0)) is not None +44 42 | +45 43 | +46 44 | # Ok. diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB171_FURB171.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB171_FURB171.py.snap index 2b29e1e40aa51..e4af1c0427817 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB171_FURB171.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB171_FURB171.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB171.py:3:4: FURB171 [*] Membership test against single-item container | 1 | # Errors. -2 | +2 | 3 | if 1 in (1,): | ^^^^^^^^^ FURB171 4 | print("Single-element tuple") @@ -23,7 +23,7 @@ FURB171.py:3:4: FURB171 [*] Membership test against single-item container FURB171.py:6:4: FURB171 [*] Membership test against single-item container | 4 | print("Single-element tuple") -5 | +5 | 6 | if 1 in [1]: | ^^^^^^^^ FURB171 7 | print("Single-element list") @@ -43,7 +43,7 @@ FURB171.py:6:4: FURB171 [*] Membership test against single-item container FURB171.py:9:4: FURB171 [*] Membership test against single-item container | 7 | print("Single-element list") - 8 | + 8 | 9 | if 1 in {1}: | ^^^^^^^^ FURB171 10 | print("Single-element set") @@ -63,14 +63,14 @@ FURB171.py:9:4: FURB171 [*] Membership test against single-item container FURB171.py:12:4: FURB171 [*] Membership test against single-item container | 10 | print("Single-element set") -11 | +11 | 12 | if "a" in "a": | ^^^^^^^^^^ FURB171 13 | print("Single-element string") | = help: Convert to equality test -ℹ Safe fix +ℹ Unsafe fix 9 9 | if 1 in {1}: 10 10 | print("Single-element set") 11 11 | @@ -83,7 +83,7 @@ FURB171.py:12:4: FURB171 [*] Membership test against single-item container FURB171.py:15:4: FURB171 [*] Membership test against single-item container | 13 | print("Single-element string") -14 | +14 | 15 | if 1 not in (1,): | ^^^^^^^^^^^^^ FURB171 16 | print("Check `not in` membership test") @@ -103,7 +103,7 @@ FURB171.py:15:4: FURB171 [*] Membership test against single-item container FURB171.py:18:8: FURB171 [*] Membership test against single-item container | 16 | print("Check `not in` membership test") -17 | +17 | 18 | if not 1 in (1,): | ^^^^^^^^^ FURB171 19 | print("Check the negated membership test") @@ -120,4 +120,233 @@ FURB171.py:18:8: FURB171 [*] Membership test against single-item container 20 20 | 21 21 | # Non-errors. +FURB171.py:52:5: FURB171 [*] Membership test against single-item container + | +51 | # https://github.com/astral-sh/ruff/issues/10063 +52 | _ = a in ( + | _____^ +53 | | # Foo +54 | | b, +55 | | ) + | |_^ FURB171 +56 | +57 | _ = a in ( # Foo1 + | + = help: Convert to equality test + +ℹ Unsafe fix +49 49 | +50 50 | +51 51 | # https://github.com/astral-sh/ruff/issues/10063 +52 |-_ = a in ( +53 |- # Foo +54 |- b, +55 |-) + 52 |+_ = a == b +56 53 | +57 54 | _ = a in ( # Foo1 +58 55 | ( # Foo2 + +FURB171.py:57:5: FURB171 [*] Membership test against single-item container + | +55 | ) +56 | +57 | _ = a in ( # Foo1 + | _____^ +58 | | ( # Foo2 +59 | | # Foo3 +60 | | ( # Tuple +61 | | ( # Bar +62 | | (b +63 | | # Bar +64 | | ) +65 | | ) +66 | | # Foo4 +67 | | # Foo5 +68 | | , +69 | | ) +70 | | # Foo6 +71 | | ) +72 | | ) + | |_^ FURB171 +73 | +74 | foo = ( + | + = help: Convert to equality test + +ℹ Unsafe fix +54 54 | b, +55 55 | ) +56 56 | +57 |-_ = a in ( # Foo1 +58 |- ( # Foo2 +59 |- # Foo3 +60 |- ( # Tuple +61 |- ( # Bar + 57 |+_ = a == ( # Bar +62 58 | (b +63 59 | # Bar +64 60 | ) +65 61 | ) +66 |- # Foo4 +67 |- # Foo5 +68 |- , +69 |- ) +70 |- # Foo6 +71 |- ) +72 |-) +73 62 | +74 63 | foo = ( +75 64 | lorem() + +FURB171.py:77:28: FURB171 [*] Membership test against single-item container + | +75 | lorem() +76 | .ipsum() +77 | .dolor(lambda sit: sit in ( + | ____________________________^ +78 | | # Foo1 +79 | | # Foo2 +80 | | amet, +81 | | )) + | |_________^ FURB171 +82 | ) + | + = help: Convert to equality test + +ℹ Unsafe fix +74 74 | foo = ( +75 75 | lorem() +76 76 | .ipsum() +77 |- .dolor(lambda sit: sit in ( +78 |- # Foo1 +79 |- # Foo2 +80 |- amet, +81 |- )) + 77 |+ .dolor(lambda sit: sit == amet) +82 78 | ) +83 79 | +84 80 | foo = ( + +FURB171.py:87:28: FURB171 [*] Membership test against single-item container + | +85 | lorem() +86 | .ipsum() +87 | .dolor(lambda sit: sit in ( + | ____________________________^ +88 | | ( +89 | | # Foo1 +90 | | # Foo2 +91 | | amet +92 | | ), +93 | | )) + | |_________^ FURB171 +94 | ) + | + = help: Convert to equality test + +ℹ Unsafe fix +84 84 | foo = ( +85 85 | lorem() +86 86 | .ipsum() +87 |- .dolor(lambda sit: sit in ( +88 |- ( + 87 |+ .dolor(lambda sit: sit == ( +89 88 | # Foo1 +90 89 | # Foo2 +91 90 | amet +92 |- ), +93 |- )) + 91 |+ )) +94 92 | ) +95 93 | +96 94 | foo = lorem() \ + +FURB171.py:98:24: FURB171 [*] Membership test against single-item container + | + 96 | foo = lorem() \ + 97 | .ipsum() \ + 98 | .dolor(lambda sit: sit in ( + | ________________________^ + 99 | | # Foo1 +100 | | # Foo2 +101 | | amet, +102 | | )) + | |_____^ FURB171 +103 | +104 | def _(): + | + = help: Convert to equality test + +ℹ Unsafe fix +95 95 | +96 96 | foo = lorem() \ +97 97 | .ipsum() \ +98 |- .dolor(lambda sit: sit in ( +99 |- # Foo1 +100 |- # Foo2 +101 |- amet, +102 |- )) + 98 |+ .dolor(lambda sit: sit == amet) +103 99 | +104 100 | def _(): +105 101 | if foo not \ + +FURB171.py:105:8: FURB171 [*] Membership test against single-item container + | +104 | def _(): +105 | if foo not \ + | ________^ +106 | | in [ +107 | | # Before +108 | | bar +109 | | # After +110 | | ]: ... + | |_____^ FURB171 +111 | +112 | def _(): + | + = help: Convert to inequality test + +ℹ Unsafe fix +102 102 | )) +103 103 | +104 104 | def _(): +105 |- if foo not \ +106 |- in [ +107 |- # Before +108 |- bar +109 |- # After +110 |- ]: ... + 105 |+ if foo != bar: ... +111 106 | +112 107 | def _(): +113 108 | if foo not \ + +FURB171.py:113:8: FURB171 [*] Membership test against single-item container + | +112 | def _(): +113 | if foo not \ + | ________^ +114 | | in [ +115 | | # Before +116 | | bar +117 | | # After +118 | | ] and \ + | |_____^ FURB171 +119 | 0 < 1: ... + | + = help: Convert to inequality test +ℹ Unsafe fix +110 110 | ]: ... +111 111 | +112 112 | def _(): +113 |- if foo not \ +114 |- in [ +115 |- # Before +116 |- bar +117 |- # After +118 |- ] and \ + 113 |+ if foo != bar and \ +119 114 | 0 < 1: ... diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB177_FURB177.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB177_FURB177.py.snap index a7034cc35a81e..567479ed72a7b 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB177_FURB177.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB177_FURB177.py.snap @@ -26,7 +26,7 @@ FURB177.py:6:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for curr 5 | _ = Path().resolve() 6 | _ = pathlib.Path().resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 -7 | +7 | 8 | _ = Path("").resolve() | = help: Replace `Path().resolve()` with `Path.cwd()` @@ -44,7 +44,7 @@ FURB177.py:6:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for curr FURB177.py:8:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups | 6 | _ = pathlib.Path().resolve() -7 | +7 | 8 | _ = Path("").resolve() | ^^^^^^^^^^^^^^^^^^ FURB177 9 | _ = pathlib.Path("").resolve() @@ -66,7 +66,7 @@ FURB177.py:9:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for curr 8 | _ = Path("").resolve() 9 | _ = pathlib.Path("").resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 -10 | +10 | 11 | _ = Path(".").resolve() | = help: Replace `Path().resolve()` with `Path.cwd()` @@ -84,7 +84,7 @@ FURB177.py:9:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for curr FURB177.py:11:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups | 9 | _ = pathlib.Path("").resolve() -10 | +10 | 11 | _ = Path(".").resolve() | ^^^^^^^^^^^^^^^^^^^ FURB177 12 | _ = pathlib.Path(".").resolve() @@ -106,7 +106,7 @@ FURB177.py:12:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for cur 11 | _ = Path(".").resolve() 12 | _ = pathlib.Path(".").resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 -13 | +13 | 14 | _ = Path("", **kwargs).resolve() | = help: Replace `Path().resolve()` with `Path.cwd()` @@ -124,7 +124,7 @@ FURB177.py:12:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for cur FURB177.py:14:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups | 12 | _ = pathlib.Path(".").resolve() -13 | +13 | 14 | _ = Path("", **kwargs).resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 15 | _ = pathlib.Path("", **kwargs).resolve() @@ -146,7 +146,7 @@ FURB177.py:15:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for cur 14 | _ = Path("", **kwargs).resolve() 15 | _ = pathlib.Path("", **kwargs).resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 -16 | +16 | 17 | _ = Path(".", **kwargs).resolve() | = help: Replace `Path().resolve()` with `Path.cwd()` @@ -164,7 +164,7 @@ FURB177.py:15:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for cur FURB177.py:17:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups | 15 | _ = pathlib.Path("", **kwargs).resolve() -16 | +16 | 17 | _ = Path(".", **kwargs).resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 18 | _ = pathlib.Path(".", **kwargs).resolve() @@ -186,7 +186,7 @@ FURB177.py:18:5: FURB177 [*] Prefer `Path.cwd()` over `Path().resolve()` for cur 17 | _ = Path(".", **kwargs).resolve() 18 | _ = pathlib.Path(".", **kwargs).resolve() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB177 -19 | +19 | 20 | # OK | = help: Replace `Path().resolve()` with `Path.cwd()` diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB180_FURB180.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB180_FURB180.py.snap index 0d683880efd9d..45df8c8e53cea 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB180_FURB180.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB180_FURB180.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB180.py:7:10: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class | 5 | # Errors -6 | +6 | 7 | class A0(metaclass=abc.ABCMeta): | ^^^^^^^^^^^^^^^^^^^^^ FURB180 8 | @abstractmethod @@ -76,6 +76,4 @@ FURB180.py:31:34: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract 31 |+class A3(B0, abc.ABC, before_metaclass=1): 32 32 | pass 33 33 | -34 34 | - - +34 34 | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB181_FURB181.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB181_FURB181.py.snap index cca7645c90adf..82cea760eaea9 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB181_FURB181.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB181_FURB181.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB181.py:19:1: FURB181 [*] Use of hashlib's `.digest().hex()` | 17 | # these will match -18 | +18 | 19 | blake2b().digest().hex() | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB181 20 | blake2s().digest().hex() @@ -12,7 +12,7 @@ FURB181.py:19:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 16 16 | 17 17 | # these will match 18 18 | @@ -32,7 +32,7 @@ FURB181.py:20:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 17 17 | # these will match 18 18 | 19 19 | blake2b().digest().hex() @@ -53,7 +53,7 @@ FURB181.py:21:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 18 18 | 19 19 | blake2b().digest().hex() 20 20 | blake2s().digest().hex() @@ -74,7 +74,7 @@ FURB181.py:22:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 19 19 | blake2b().digest().hex() 20 20 | blake2s().digest().hex() 21 21 | md5().digest().hex() @@ -95,7 +95,7 @@ FURB181.py:23:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 20 20 | blake2s().digest().hex() 21 21 | md5().digest().hex() 22 22 | sha1().digest().hex() @@ -116,7 +116,7 @@ FURB181.py:24:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 21 21 | md5().digest().hex() 22 22 | sha1().digest().hex() 23 23 | sha224().digest().hex() @@ -137,7 +137,7 @@ FURB181.py:25:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 22 22 | sha1().digest().hex() 23 23 | sha224().digest().hex() 24 24 | sha256().digest().hex() @@ -158,7 +158,7 @@ FURB181.py:26:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 23 23 | sha224().digest().hex() 24 24 | sha256().digest().hex() 25 25 | sha384().digest().hex() @@ -179,7 +179,7 @@ FURB181.py:27:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 24 24 | sha256().digest().hex() 25 25 | sha384().digest().hex() 26 26 | sha3_224().digest().hex() @@ -200,7 +200,7 @@ FURB181.py:28:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 25 25 | sha384().digest().hex() 26 26 | sha3_224().digest().hex() 27 27 | sha3_256().digest().hex() @@ -221,7 +221,7 @@ FURB181.py:29:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 26 26 | sha3_224().digest().hex() 27 27 | sha3_256().digest().hex() 28 28 | sha3_384().digest().hex() @@ -242,7 +242,7 @@ FURB181.py:30:1: FURB181 [*] Use of hashlib's `.digest().hex()` | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 27 27 | sha3_256().digest().hex() 28 28 | sha3_384().digest().hex() 29 29 | sha3_512().digest().hex() @@ -268,7 +268,7 @@ FURB181.py:32:1: FURB181 Use of hashlib's `.digest().hex()` 31 | shake_128().digest(10).hex() 32 | shake_256().digest(10).hex() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB181 -33 | +33 | 34 | hashlib.sha256().digest().hex() | = help: Replace with `.hexdigest()` @@ -276,15 +276,15 @@ FURB181.py:32:1: FURB181 Use of hashlib's `.digest().hex()` FURB181.py:34:1: FURB181 [*] Use of hashlib's `.digest().hex()` | 32 | shake_256().digest(10).hex() -33 | +33 | 34 | hashlib.sha256().digest().hex() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB181 -35 | +35 | 36 | sha256(b"text").digest().hex() | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 31 31 | shake_128().digest(10).hex() 32 32 | shake_256().digest(10).hex() 33 33 | @@ -297,15 +297,15 @@ FURB181.py:34:1: FURB181 [*] Use of hashlib's `.digest().hex()` FURB181.py:36:1: FURB181 [*] Use of hashlib's `.digest().hex()` | 34 | hashlib.sha256().digest().hex() -35 | +35 | 36 | sha256(b"text").digest().hex() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB181 -37 | +37 | 38 | hash_algo().digest().hex() | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 33 33 | 34 34 | hashlib.sha256().digest().hex() 35 35 | @@ -318,15 +318,15 @@ FURB181.py:36:1: FURB181 [*] Use of hashlib's `.digest().hex()` FURB181.py:38:1: FURB181 [*] Use of hashlib's `.digest().hex()` | 36 | sha256(b"text").digest().hex() -37 | +37 | 38 | hash_algo().digest().hex() | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB181 -39 | +39 | 40 | # not yet supported | = help: Replace with `.hexdigest()` -ℹ Unsafe fix +ℹ Safe fix 35 35 | 36 36 | sha256(b"text").digest().hex() 37 37 | @@ -335,5 +335,3 @@ FURB181.py:38:1: FURB181 [*] Use of hashlib's `.digest().hex()` 39 39 | 40 40 | # not yet supported 41 41 | h = sha256() - - diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB187_FURB187.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB187_FURB187.py.snap index e4d08fd9eefbc..8da31baa69909 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB187_FURB187.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB187_FURB187.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB187.py:6:5: FURB187 [*] Use of assignment of `reversed` on list `l` | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB188_FURB188.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB188_FURB188.py.snap index ddcc3676ac252..70966a24be310 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB188_FURB188.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB188_FURB188.py.snap @@ -1,14 +1,13 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs --- -FURB188.py:7:5: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:7:5: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 6 | def remove_extension_via_slice(filename: str) -> str: - 7 | if filename.endswith(".txt"): - | _____^ + 7 | / if filename.endswith(".txt"): 8 | | filename = filename[:-4] | |________________________________^ FURB188 - 9 | + 9 | 10 | return filename | = help: Use removesuffix instead of assignment conditional upon endswith. @@ -24,14 +23,13 @@ FURB188.py:7:5: FURB188 [*] Prefer `removesuffix` over conditionally replacing w 10 9 | return filename 11 10 | -FURB188.py:14:5: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:14:5: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 13 | def remove_extension_via_slice_len(filename: str, extension: str) -> str: -14 | if filename.endswith(extension): - | _____^ +14 | / if filename.endswith(extension): 15 | | filename = filename[:-len(extension)] | |_____________________________________________^ FURB188 -16 | +16 | 17 | return filename | = help: Use removesuffix instead of assignment conditional upon endswith. @@ -47,7 +45,7 @@ FURB188.py:14:5: FURB188 [*] Prefer `removesuffix` over conditionally replacing 17 16 | return filename 18 17 | -FURB188.py:21:12: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:21:12: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 20 | def remove_extension_via_ternary(filename: str) -> str: 21 | return filename[:-4] if filename.endswith(".txt") else filename @@ -65,7 +63,7 @@ FURB188.py:21:12: FURB188 [*] Prefer `removesuffix` over conditionally replacing 23 23 | 24 24 | def remove_extension_via_ternary_with_len(filename: str, extension: str) -> str: -FURB188.py:25:12: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:25:12: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 24 | def remove_extension_via_ternary_with_len(filename: str, extension: str) -> str: 25 | return filename[:-len(extension)] if filename.endswith(extension) else filename @@ -83,7 +81,7 @@ FURB188.py:25:12: FURB188 [*] Prefer `removesuffix` over conditionally replacing 27 27 | 28 28 | def remove_prefix(filename: str) -> str: -FURB188.py:29:12: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:29:12: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 28 | def remove_prefix(filename: str) -> str: 29 | return filename[4:] if filename.startswith("abc-") else filename @@ -101,7 +99,7 @@ FURB188.py:29:12: FURB188 [*] Prefer `removeprefix` over conditionally replacing 31 31 | 32 32 | def remove_prefix_via_len(filename: str, prefix: str) -> str: -FURB188.py:33:12: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:33:12: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 32 | def remove_prefix_via_len(filename: str, prefix: str) -> str: 33 | return filename[len(prefix):] if filename.startswith(prefix) else filename @@ -119,13 +117,13 @@ FURB188.py:33:12: FURB188 [*] Prefer `removeprefix` over conditionally replacing 35 35 | 36 36 | # these should not -FURB188.py:146:9: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:146:9: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 144 | SUFFIX = "suffix" -145 | +145 | 146 | x = foo.bar.baz[:-len(SUFFIX)] if foo.bar.baz.endswith(SUFFIX) else foo.bar.baz | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB188 -147 | +147 | 148 | def remove_prefix_comparable_literal_expr() -> None: | = help: Use removesuffix instead of ternary expression conditional upon endswith. @@ -140,12 +138,12 @@ FURB188.py:146:9: FURB188 [*] Prefer `removesuffix` over conditionally replacing 148 148 | def remove_prefix_comparable_literal_expr() -> None: 149 149 | return ("abc" "def")[3:] if ("abc" "def").startswith("abc") else "abc" "def" -FURB188.py:149:12: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:149:12: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 148 | def remove_prefix_comparable_literal_expr() -> None: 149 | return ("abc" "def")[3:] if ("abc" "def").startswith("abc") else "abc" "def" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB188 -150 | +150 | 151 | def shadow_builtins(filename: str, extension: str) -> None: | = help: Use removeprefix instead of ternary expression conditional upon startswith. @@ -160,13 +158,13 @@ FURB188.py:149:12: FURB188 [*] Prefer `removeprefix` over conditionally replacin 151 151 | def shadow_builtins(filename: str, extension: str) -> None: 152 152 | from builtins import len as builtins_len -FURB188.py:154:12: FURB188 [*] Prefer `removesuffix` over conditionally replacing with slice. +FURB188.py:154:12: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. | 152 | from builtins import len as builtins_len -153 | +153 | 154 | return filename[:-builtins_len(extension)] if filename.endswith(extension) else filename | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB188 -155 | +155 | 156 | def okay_steps(): | = help: Use removesuffix instead of ternary expression conditional upon endswith. @@ -181,12 +179,11 @@ FURB188.py:154:12: FURB188 [*] Prefer `removesuffix` over conditionally replacin 156 156 | def okay_steps(): 157 157 | text = "!x!y!z" -FURB188.py:158:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:158:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 156 | def okay_steps(): 157 | text = "!x!y!z" -158 | if text.startswith("!"): - | _____^ +158 | / if text.startswith("!"): 159 | | text = text[1::1] | |_________________________^ FURB188 160 | if text.startswith("!"): @@ -205,12 +202,11 @@ FURB188.py:158:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 161 160 | text = text[1::True] 162 161 | if text.startswith("!"): -FURB188.py:160:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:160:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 158 | if text.startswith("!"): 159 | text = text[1::1] -160 | if text.startswith("!"): - | _____^ +160 | / if text.startswith("!"): 161 | | text = text[1::True] | |____________________________^ FURB188 162 | if text.startswith("!"): @@ -229,12 +225,11 @@ FURB188.py:160:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 163 162 | text = text[1::None] 164 163 | print(text) -FURB188.py:162:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:162:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 160 | if text.startswith("!"): 161 | text = text[1::True] -162 | if text.startswith("!"): - | _____^ +162 | / if text.startswith("!"): 163 | | text = text[1::None] | |____________________________^ FURB188 164 | print(text) @@ -252,12 +247,11 @@ FURB188.py:162:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 165 164 | 166 165 | -FURB188.py:183:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:183:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 181 | # with fix `text = text.removeprefix("ř")` 182 | text = "řetězec" -183 | if text.startswith("ř"): - | _____^ +183 | / if text.startswith("ř"): 184 | | text = text[1:] | |_______________________^ FURB188 | @@ -274,12 +268,11 @@ FURB188.py:183:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 186 185 | 187 186 | def handle_surrogates(): -FURB188.py:190:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:190:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 188 | # should be linted 189 | text = "\ud800\udc00heythere" -190 | if text.startswith("\ud800\udc00"): - | _____^ +190 | / if text.startswith("\ud800\udc00"): 191 | | text = text[2:] | |_______________________^ FURB188 192 | text = "\U00010000heythere" @@ -298,12 +291,11 @@ FURB188.py:190:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 193 192 | if text.startswith("\U00010000"): 194 193 | text = text[1:] -FURB188.py:193:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing with slice. +FURB188.py:193:5: FURB188 [*] Prefer `str.removeprefix()` over conditionally replacing with slice. | 191 | text = text[2:] 192 | text = "\U00010000heythere" -193 | if text.startswith("\U00010000"): - | _____^ +193 | / if text.startswith("\U00010000"): 194 | | text = text[1:] | |_______________________^ FURB188 195 | @@ -321,3 +313,23 @@ FURB188.py:193:5: FURB188 [*] Prefer `removeprefix` over conditionally replacing 195 194 | 196 195 | # should not be linted 197 196 | text = "\ud800\udc00heythere" + +FURB188.py:205:5: FURB188 [*] Prefer `str.removesuffix()` over conditionally replacing with slice. + | +203 | def func(): +204 | a = "sjdfaskldjfakljklfoo" +205 | / if a.endswith("foo"): +206 | | a = a[: -len("foo")] + | |____________________________^ FURB188 +207 | print(a) + | + = help: Use removesuffix instead of assignment conditional upon endswith. + +ℹ Safe fix +202 202 | # https://github.com/astral-sh/ruff/issues/16231 +203 203 | def func(): +204 204 | a = "sjdfaskldjfakljklfoo" +205 |- if a.endswith("foo"): +206 |- a = a[: -len("foo")] + 205 |+ a = a.removesuffix("foo") +207 206 | print(a) diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB189_FURB189.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB189_FURB189.py.snap new file mode 100644 index 0000000000000..9fc4626b5a694 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB189_FURB189.py.snap @@ -0,0 +1,125 @@ +--- +source: crates/ruff_linter/src/rules/refurb/mod.rs +--- +FURB189.py:17:9: FURB189 [*] Subclassing `dict` can be error prone, use `collections.UserDict` instead + | +16 | # positives +17 | class D(dict): + | ^^^^ FURB189 +18 | pass + | + = help: Replace with `collections.UserDict` + +ℹ Unsafe fix +1 1 | # setup +2 2 | from enum import Enum, EnumMeta +3 |-from collections import UserList as UL + 3 |+from collections import UserList as UL, UserDict +4 4 | +5 5 | class SetOnceMappingMixin: +6 6 | __slots__ = () +-------------------------------------------------------------------------------- +14 14 | pass +15 15 | +16 16 | # positives +17 |-class D(dict): + 17 |+class D(UserDict): +18 18 | pass +19 19 | +20 20 | class L(list): + +FURB189.py:20:9: FURB189 [*] Subclassing `list` can be error prone, use `collections.UserList` instead + | +18 | pass +19 | +20 | class L(list): + | ^^^^ FURB189 +21 | pass + | + = help: Replace with `collections.UserList` + +ℹ Unsafe fix +17 17 | class D(dict): +18 18 | pass +19 19 | +20 |-class L(list): + 20 |+class L(UL): +21 21 | pass +22 22 | +23 23 | class S(str): + +FURB189.py:23:9: FURB189 [*] Subclassing `str` can be error prone, use `collections.UserString` instead + | +21 | pass +22 | +23 | class S(str): + | ^^^ FURB189 +24 | pass + | + = help: Replace with `collections.UserString` + +ℹ Unsafe fix +1 1 | # setup +2 2 | from enum import Enum, EnumMeta +3 |-from collections import UserList as UL + 3 |+from collections import UserList as UL, UserString +4 4 | +5 5 | class SetOnceMappingMixin: +6 6 | __slots__ = () +-------------------------------------------------------------------------------- +20 20 | class L(list): +21 21 | pass +22 22 | +23 |-class S(str): + 23 |+class S(UserString): +24 24 | pass +25 25 | +26 26 | class SubscriptDict(dict[str, str]): + +FURB189.py:26:21: FURB189 [*] Subclassing `dict` can be error prone, use `collections.UserDict` instead + | +24 | pass +25 | +26 | class SubscriptDict(dict[str, str]): + | ^^^^ FURB189 +27 | pass + | + = help: Replace with `collections.UserDict` + +ℹ Unsafe fix +1 1 | # setup +2 2 | from enum import Enum, EnumMeta +3 |-from collections import UserList as UL + 3 |+from collections import UserList as UL, UserDict +4 4 | +5 5 | class SetOnceMappingMixin: +6 6 | __slots__ = () +-------------------------------------------------------------------------------- +23 23 | class S(str): +24 24 | pass +25 25 | +26 |-class SubscriptDict(dict[str, str]): + 26 |+class SubscriptDict(UserDict[str, str]): +27 27 | pass +28 28 | +29 29 | class SubscriptList(list[str]): + +FURB189.py:29:21: FURB189 [*] Subclassing `list` can be error prone, use `collections.UserList` instead + | +27 | pass +28 | +29 | class SubscriptList(list[str]): + | ^^^^ FURB189 +30 | pass + | + = help: Replace with `collections.UserList` + +ℹ Unsafe fix +26 26 | class SubscriptDict(dict[str, str]): +27 27 | pass +28 28 | +29 |-class SubscriptList(list[str]): + 29 |+class SubscriptList(UL[str]): +30 30 | pass +31 31 | +32 32 | # currently not detected diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB192_FURB192.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB192_FURB192.py.snap index 2d962a82b9581..fdec3718d9f27 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB192_FURB192.py.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB192_FURB192.py.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/rules/refurb/mod.rs FURB192.py:3:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 1 | # Errors -2 | +2 | 3 | sorted(l)[0] | ^^^^^^^^^^^^ FURB192 -4 | +4 | 5 | sorted(l)[-1] | = help: Replace with `min` @@ -24,10 +24,10 @@ FURB192.py:3:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum FURB192.py:5:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum value in a sequence | 3 | sorted(l)[0] -4 | +4 | 5 | sorted(l)[-1] | ^^^^^^^^^^^^^ FURB192 -6 | +6 | 7 | sorted(l, reverse=False)[-1] | = help: Replace with `max` @@ -45,10 +45,10 @@ FURB192.py:5:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum FURB192.py:7:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum value in a sequence | 5 | sorted(l)[-1] -6 | +6 | 7 | sorted(l, reverse=False)[-1] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -8 | +8 | 9 | sorted(l, key=lambda x: x)[0] | = help: Replace with `max` @@ -66,10 +66,10 @@ FURB192.py:7:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum FURB192.py:9:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 7 | sorted(l, reverse=False)[-1] - 8 | + 8 | 9 | sorted(l, key=lambda x: x)[0] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -10 | +10 | 11 | sorted(l, key=key_fn)[0] | = help: Replace with `min` @@ -87,10 +87,10 @@ FURB192.py:9:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum FURB192.py:11:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 9 | sorted(l, key=lambda x: x)[0] -10 | +10 | 11 | sorted(l, key=key_fn)[0] | ^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -12 | +12 | 13 | sorted([1, 2, 3])[0] | = help: Replace with `min` @@ -108,10 +108,10 @@ FURB192.py:11:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum FURB192.py:13:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 11 | sorted(l, key=key_fn)[0] -12 | +12 | 13 | sorted([1, 2, 3])[0] | ^^^^^^^^^^^^^^^^^^^^ FURB192 -14 | +14 | 15 | # Unsafe | = help: Replace with `min` @@ -129,10 +129,10 @@ FURB192.py:13:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum FURB192.py:17:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 15 | # Unsafe -16 | +16 | 17 | sorted(l, key=key_fn, reverse=True)[-1] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -18 | +18 | 19 | sorted(l, reverse=True)[0] | = help: Replace with `min` @@ -150,10 +150,10 @@ FURB192.py:17:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum FURB192.py:19:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum value in a sequence | 17 | sorted(l, key=key_fn, reverse=True)[-1] -18 | +18 | 19 | sorted(l, reverse=True)[0] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -20 | +20 | 21 | sorted(l, reverse=True)[-1] | = help: Replace with `max` @@ -171,10 +171,10 @@ FURB192.py:19:1: FURB192 [*] Prefer `max` over `sorted()` to compute the maximum FURB192.py:21:1: FURB192 [*] Prefer `min` over `sorted()` to compute the minimum value in a sequence | 19 | sorted(l, reverse=True)[0] -20 | +20 | 21 | sorted(l, reverse=True)[-1] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB192 -22 | +22 | 23 | # Non-errors | = help: Replace with `min` diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__fstring_number_format_python_311.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__fstring_number_format_python_311.snap new file mode 100644 index 0000000000000..37b1e3aea601a --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__fstring_number_format_python_311.snap @@ -0,0 +1,256 @@ +--- +source: crates/ruff_linter/src/rules/refurb/mod.rs +--- +FURB116.py:9:7: FURB116 Replace `oct` call with `f"{num:o}"` + | + 7 | return num + 8 | + 9 | print(oct(num)[2:]) # FURB116 + | ^^^^^^^^^^^^ FURB116 +10 | print(hex(num)[2:]) # FURB116 +11 | print(bin(num)[2:]) # FURB116 + | + = help: Replace with `f"{num:o}"` + +ℹ Display-only fix +6 6 | def return_num() -> int: +7 7 | return num +8 8 | +9 |-print(oct(num)[2:]) # FURB116 + 9 |+print(f"{num:o}") # FURB116 +10 10 | print(hex(num)[2:]) # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | + +FURB116.py:10:7: FURB116 Replace `hex` call with `f"{num:x}"` + | + 9 | print(oct(num)[2:]) # FURB116 +10 | print(hex(num)[2:]) # FURB116 + | ^^^^^^^^^^^^ FURB116 +11 | print(bin(num)[2:]) # FURB116 + | + = help: Replace with `f"{num:x}"` + +ℹ Display-only fix +7 7 | return num +8 8 | +9 9 | print(oct(num)[2:]) # FURB116 +10 |-print(hex(num)[2:]) # FURB116 + 10 |+print(f"{num:x}") # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 + +FURB116.py:11:7: FURB116 Replace `bin` call with `f"{num:b}"` + | + 9 | print(oct(num)[2:]) # FURB116 +10 | print(hex(num)[2:]) # FURB116 +11 | print(bin(num)[2:]) # FURB116 + | ^^^^^^^^^^^^ FURB116 +12 | +13 | print(oct(1337)[2:]) # FURB116 + | + = help: Replace with `f"{num:b}"` + +ℹ Display-only fix +8 8 | +9 9 | print(oct(num)[2:]) # FURB116 +10 10 | print(hex(num)[2:]) # FURB116 +11 |-print(bin(num)[2:]) # FURB116 + 11 |+print(f"{num:b}") # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 + +FURB116.py:13:7: FURB116 [*] Replace `oct` call with `f"{1337:o}"` + | +11 | print(bin(num)[2:]) # FURB116 +12 | +13 | print(oct(1337)[2:]) # FURB116 + | ^^^^^^^^^^^^^ FURB116 +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 + | + = help: Replace with `f"{1337:o}"` + +ℹ Safe fix +10 10 | print(hex(num)[2:]) # FURB116 +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 |-print(oct(1337)[2:]) # FURB116 + 13 |+print(f"{1337:o}") # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 + +FURB116.py:14:7: FURB116 [*] Replace `hex` call with `f"{1337:x}"` + | +13 | print(oct(1337)[2:]) # FURB116 +14 | print(hex(1337)[2:]) # FURB116 + | ^^^^^^^^^^^^^ FURB116 +15 | print(bin(1337)[2:]) # FURB116 +16 | print(bin(+1337)[2:]) # FURB116 + | + = help: Replace with `f"{1337:x}"` + +ℹ Safe fix +11 11 | print(bin(num)[2:]) # FURB116 +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 |-print(hex(1337)[2:]) # FURB116 + 14 |+print(f"{1337:x}") # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 +17 17 | + +FURB116.py:15:7: FURB116 [*] Replace `bin` call with `f"{1337:b}"` + | +13 | print(oct(1337)[2:]) # FURB116 +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 + | ^^^^^^^^^^^^^ FURB116 +16 | print(bin(+1337)[2:]) # FURB116 + | + = help: Replace with `f"{1337:b}"` + +ℹ Safe fix +12 12 | +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 |-print(bin(1337)[2:]) # FURB116 + 15 |+print(f"{1337:b}") # FURB116 +16 16 | print(bin(+1337)[2:]) # FURB116 +17 17 | +18 18 | print(bin(return_num())[2:]) # FURB116 (no autofix) + +FURB116.py:16:7: FURB116 [*] Replace `bin` call with `f"{+1337:b}"` + | +14 | print(hex(1337)[2:]) # FURB116 +15 | print(bin(1337)[2:]) # FURB116 +16 | print(bin(+1337)[2:]) # FURB116 + | ^^^^^^^^^^^^^^ FURB116 +17 | +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) + | + = help: Replace with `f"{+1337:b}"` + +ℹ Safe fix +13 13 | print(oct(1337)[2:]) # FURB116 +14 14 | print(hex(1337)[2:]) # FURB116 +15 15 | print(bin(1337)[2:]) # FURB116 +16 |-print(bin(+1337)[2:]) # FURB116 + 16 |+print(f"{+1337:b}") # FURB116 +17 17 | +18 18 | print(bin(return_num())[2:]) # FURB116 (no autofix) +19 19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) + +FURB116.py:18:7: FURB116 Replace `bin` call with f-string + | +16 | print(bin(+1337)[2:]) # FURB116 +17 | +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) + | ^^^^^^^^^^^^^^^^^^^^^ FURB116 +19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) + | + = help: Replace with f-string + +FURB116.py:19:7: FURB116 Replace `bin` call with f-string + | +18 | print(bin(return_num())[2:]) # FURB116 (no autofix) +19 | print(bin(int(f"{num}"))[2:]) # FURB116 (no autofix) + | ^^^^^^^^^^^^^^^^^^^^^^ FURB116 +20 | +21 | ## invalid + | + = help: Replace with f-string + +FURB116.py:32:7: FURB116 Replace `bin` call with `f"{d:b}"` + | +30 | d = datetime.datetime.now(tz=datetime.UTC) +31 | # autofix is display-only +32 | print(bin(d)[2:]) + | ^^^^^^^^^^ FURB116 +33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 | print(bin(len("xyz").numerator)[2:]) + | + = help: Replace with `f"{d:b}"` + +ℹ Display-only fix +29 29 | +30 30 | d = datetime.datetime.now(tz=datetime.UTC) +31 31 | # autofix is display-only +32 |-print(bin(d)[2:]) + 32 |+print(f"{d:b}") +33 33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 34 | print(bin(len("xyz").numerator)[2:]) +35 35 | + +FURB116.py:34:7: FURB116 Replace `bin` call with f-string + | +32 | print(bin(d)[2:]) +33 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +34 | print(bin(len("xyz").numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +35 | +36 | # autofix is display-only + | + = help: Replace with f-string + +FURB116.py:37:7: FURB116 Replace `bin` call with `f"{ {0: 1}[0].numerator:b}"` + | +36 | # autofix is display-only +37 | print(bin({0: 1}[0].numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) + | + = help: Replace with `f"{ {0: 1}[0].numerator:b}"` + +ℹ Display-only fix +34 34 | print(bin(len("xyz").numerator)[2:]) +35 35 | +36 36 | # autofix is display-only +37 |-print(bin({0: 1}[0].numerator)[2:]) + 37 |+print(f"{ {0: 1}[0].numerator:b}") +38 38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 39 | print(bin(ord("\\").numerator)[2:]) +40 40 | print(hex(sys + +FURB116.py:39:7: FURB116 Replace `bin` call with f-string + | +37 | print(bin({0: 1}[0].numerator)[2:]) +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB116 +40 | print(hex(sys +41 | .maxunicode)[2:]) + | + = help: Replace with f-string + +FURB116.py:40:7: FURB116 Replace `hex` call with f-string + | +38 | # no autofix for Python 3.11 and earlier, as it introduces a syntax error +39 | print(bin(ord("\\").numerator)[2:]) +40 | print(hex(sys + | _______^ +41 | | .maxunicode)[2:]) + | |________________^ FURB116 +42 | +43 | # for negatives numbers autofix is display-only + | + = help: Replace with f-string + +FURB116.py:44:7: FURB116 Replace `bin` call with `f"{-1:b}"` + | +43 | # for negatives numbers autofix is display-only +44 | print(bin(-1)[2:]) + | ^^^^^^^^^^^ FURB116 + | + = help: Replace with `f"{-1:b}"` + +ℹ Display-only fix +41 41 | .maxunicode)[2:]) +42 42 | +43 43 | # for negatives numbers autofix is display-only +44 |-print(bin(-1)[2:]) + 44 |+print(f"{-1:b}") diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__preview__FURB129_FURB129.py.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__preview__FURB129_FURB129.py.snap new file mode 100644 index 0000000000000..f0fdde19a8835 --- /dev/null +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__preview__FURB129_FURB129.py.snap @@ -0,0 +1,243 @@ +--- +source: crates/ruff_linter/src/rules/refurb/mod.rs +--- +FURB129.py:7:18: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +5 | # Errors +6 | with open("FURB129.py") as f: +7 | for _line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +8 | pass +9 | a = [line.lower() for line in f.readlines()] + | + = help: Remove `readlines()` + +ℹ Safe fix +4 4 | +5 5 | # Errors +6 6 | with open("FURB129.py") as f: +7 |- for _line in f.readlines(): + 7 |+ for _line in f: +8 8 | pass +9 9 | a = [line.lower() for line in f.readlines()] +10 10 | b = {line.upper() for line in f.readlines()} + +FURB129.py:9:35: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | + 7 | for _line in f.readlines(): + 8 | pass + 9 | a = [line.lower() for line in f.readlines()] + | ^^^^^^^^^^^^^ FURB129 +10 | b = {line.upper() for line in f.readlines()} +11 | c = {line.lower(): line.upper() for line in f.readlines()} + | + = help: Remove `readlines()` + +ℹ Safe fix +6 6 | with open("FURB129.py") as f: +7 7 | for _line in f.readlines(): +8 8 | pass +9 |- a = [line.lower() for line in f.readlines()] + 9 |+ a = [line.lower() for line in f] +10 10 | b = {line.upper() for line in f.readlines()} +11 11 | c = {line.lower(): line.upper() for line in f.readlines()} +12 12 | + +FURB129.py:10:35: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | + 8 | pass + 9 | a = [line.lower() for line in f.readlines()] +10 | b = {line.upper() for line in f.readlines()} + | ^^^^^^^^^^^^^ FURB129 +11 | c = {line.lower(): line.upper() for line in f.readlines()} + | + = help: Remove `readlines()` + +ℹ Safe fix +7 7 | for _line in f.readlines(): +8 8 | pass +9 9 | a = [line.lower() for line in f.readlines()] +10 |- b = {line.upper() for line in f.readlines()} + 10 |+ b = {line.upper() for line in f} +11 11 | c = {line.lower(): line.upper() for line in f.readlines()} +12 12 | +13 13 | with Path("FURB129.py").open() as f: + +FURB129.py:11:49: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | + 9 | a = [line.lower() for line in f.readlines()] +10 | b = {line.upper() for line in f.readlines()} +11 | c = {line.lower(): line.upper() for line in f.readlines()} + | ^^^^^^^^^^^^^ FURB129 +12 | +13 | with Path("FURB129.py").open() as f: + | + = help: Remove `readlines()` + +ℹ Safe fix +8 8 | pass +9 9 | a = [line.lower() for line in f.readlines()] +10 10 | b = {line.upper() for line in f.readlines()} +11 |- c = {line.lower(): line.upper() for line in f.readlines()} + 11 |+ c = {line.lower(): line.upper() for line in f} +12 12 | +13 13 | with Path("FURB129.py").open() as f: +14 14 | for _line in f.readlines(): + +FURB129.py:14:18: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +13 | with Path("FURB129.py").open() as f: +14 | for _line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +15 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +11 11 | c = {line.lower(): line.upper() for line in f.readlines()} +12 12 | +13 13 | with Path("FURB129.py").open() as f: +14 |- for _line in f.readlines(): + 14 |+ for _line in f: +15 15 | pass +16 16 | +17 17 | for _line in open("FURB129.py").readlines(): + +FURB129.py:17:14: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +15 | pass +16 | +17 | for _line in open("FURB129.py").readlines(): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB129 +18 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +14 14 | for _line in f.readlines(): +15 15 | pass +16 16 | +17 |-for _line in open("FURB129.py").readlines(): + 17 |+for _line in open("FURB129.py"): +18 18 | pass +19 19 | +20 20 | for _line in Path("FURB129.py").open().readlines(): + +FURB129.py:20:14: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +18 | pass +19 | +20 | for _line in Path("FURB129.py").open().readlines(): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FURB129 +21 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +17 17 | for _line in open("FURB129.py").readlines(): +18 18 | pass +19 19 | +20 |-for _line in Path("FURB129.py").open().readlines(): + 20 |+for _line in Path("FURB129.py").open(): +21 21 | pass +22 22 | +23 23 | + +FURB129.py:26:18: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +24 | def func(): +25 | f = Path("FURB129.py").open() +26 | for _line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +27 | pass +28 | f.close() + | + = help: Remove `readlines()` + +ℹ Safe fix +23 23 | +24 24 | def func(): +25 25 | f = Path("FURB129.py").open() +26 |- for _line in f.readlines(): + 26 |+ for _line in f: +27 27 | pass +28 28 | f.close() +29 29 | + +FURB129.py:32:18: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +31 | def func(f: io.BytesIO): +32 | for _line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +33 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +29 29 | +30 30 | +31 31 | def func(f: io.BytesIO): +32 |- for _line in f.readlines(): + 32 |+ for _line in f: +33 33 | pass +34 34 | +35 35 | + +FURB129.py:38:22: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +36 | def func(): +37 | with (open("FURB129.py") as f, foo as bar): +38 | for _line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +39 | pass +40 | for _line in bar.readlines(): + | + = help: Remove `readlines()` + +ℹ Safe fix +35 35 | +36 36 | def func(): +37 37 | with (open("FURB129.py") as f, foo as bar): +38 |- for _line in f.readlines(): + 38 |+ for _line in f: +39 39 | pass +40 40 | for _line in bar.readlines(): +41 41 | pass + +FURB129.py:48:17: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +47 | with builtins.open("FURB129.py") as f: +48 | for line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +49 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +45 45 | +46 46 | +47 47 | with builtins.open("FURB129.py") as f: +48 |- for line in f.readlines(): + 48 |+ for line in f: +49 49 | pass +50 50 | +51 51 | + +FURB129.py:56:17: FURB129 [*] Instead of calling `readlines()`, iterate over file object directly + | +55 | with o("FURB129.py") as f: +56 | for line in f.readlines(): + | ^^^^^^^^^^^^^ FURB129 +57 | pass + | + = help: Remove `readlines()` + +ℹ Safe fix +53 53 | +54 54 | +55 55 | with o("FURB129.py") as f: +56 |- for line in f.readlines(): + 56 |+ for line in f: +57 57 | pass +58 58 | +59 59 | diff --git a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__write_whole_file_python_39.snap b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__write_whole_file_python_39.snap index 445a83eda69ae..9a82d01f8ebf1 100644 --- a/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__write_whole_file_python_39.snap +++ b/crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__write_whole_file_python_39.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/refurb/mod.rs +snapshot_kind: text --- FURB103.py:12:6: FURB103 `open` and `write` should be replaced by `Path("file.txt").write_text("test")` | diff --git a/crates/ruff_linter/src/rules/ruff/mod.rs b/crates/ruff_linter/src/rules/ruff/mod.rs index 84b7fd0d8ff7d..242a6f2d0e06e 100644 --- a/crates/ruff_linter/src/rules/ruff/mod.rs +++ b/crates/ruff_linter/src/rules/ruff/mod.rs @@ -10,31 +10,46 @@ mod tests { use std::path::Path; use anyhow::Result; + use regex::Regex; + use ruff_python_ast::PythonVersion; + use ruff_source_file::SourceFileBuilder; use rustc_hash::FxHashSet; use test_case::test_case; - use ruff_source_file::SourceFileBuilder; - use crate::pyproject_toml::lint_pyproject_toml; use crate::registry::Rule; - use crate::settings::types::{ - CompiledPerFileIgnoreList, PerFileIgnore, PreviewMode, PythonVersion, - }; use crate::settings::LinterSettings; + use crate::settings::types::{CompiledPerFileIgnoreList, PerFileIgnore, PreviewMode}; use crate::test::{test_path, test_resource_path}; use crate::{assert_messages, settings}; - #[test_case(Rule::AsyncioDanglingTask, Path::new("RUF006.py"))] #[test_case(Rule::CollectionLiteralConcatenation, Path::new("RUF005.py"))] - #[test_case(Rule::ExplicitFStringTypeConversion, Path::new("RUF010.py"))] + #[test_case(Rule::AsyncioDanglingTask, Path::new("RUF006.py"))] + #[test_case(Rule::ZipInsteadOfPairwise, Path::new("RUF007.py"))] + #[test_case(Rule::MutableDataclassDefault, Path::new("RUF008.py"))] + #[test_case(Rule::MutableDataclassDefault, Path::new("RUF008_attrs.py"))] + #[test_case(Rule::MutableDataclassDefault, Path::new("RUF008_deferred.py"))] #[test_case(Rule::FunctionCallInDataclassDefaultArgument, Path::new("RUF009.py"))] + #[test_case( + Rule::FunctionCallInDataclassDefaultArgument, + Path::new("RUF009_attrs.py") + )] + #[test_case( + Rule::FunctionCallInDataclassDefaultArgument, + Path::new("RUF009_attrs_auto_attribs.py") + )] + #[test_case( + Rule::FunctionCallInDataclassDefaultArgument, + Path::new("RUF009_deferred.py") + )] + #[test_case(Rule::ExplicitFStringTypeConversion, Path::new("RUF010.py"))] + #[test_case(Rule::MutableClassDefault, Path::new("RUF012.py"))] + #[test_case(Rule::MutableClassDefault, Path::new("RUF012_deferred.py"))] #[test_case(Rule::ImplicitOptional, Path::new("RUF013_0.py"))] #[test_case(Rule::ImplicitOptional, Path::new("RUF013_1.py"))] #[test_case(Rule::ImplicitOptional, Path::new("RUF013_2.py"))] #[test_case(Rule::ImplicitOptional, Path::new("RUF013_3.py"))] - #[test_case(Rule::MutableClassDefault, Path::new("RUF012.py"))] - #[test_case(Rule::MutableDataclassDefault, Path::new("RUF008.py"))] - #[test_case(Rule::ZipInsteadOfPairwise, Path::new("RUF007.py"))] + #[test_case(Rule::ImplicitOptional, Path::new("RUF013_4.py"))] #[test_case( Rule::UnnecessaryIterableAllocationForFirstElement, Path::new("RUF015.py") @@ -58,9 +73,36 @@ mod tests { #[test_case(Rule::AssertWithPrintMessage, Path::new("RUF030.py"))] #[test_case(Rule::IncorrectlyParenthesizedTupleInSubscript, Path::new("RUF031.py"))] #[test_case(Rule::DecimalFromFloatLiteral, Path::new("RUF032.py"))] - #[test_case(Rule::UselessIfElse, Path::new("RUF034.py"))] - #[test_case(Rule::RedirectedNOQA, Path::new("RUF101.py"))] #[test_case(Rule::PostInitDefault, Path::new("RUF033.py"))] + #[test_case(Rule::UselessIfElse, Path::new("RUF034.py"))] + #[test_case(Rule::NoneNotAtEndOfUnion, Path::new("RUF036.py"))] + #[test_case(Rule::NoneNotAtEndOfUnion, Path::new("RUF036.pyi"))] + #[test_case(Rule::UnnecessaryEmptyIterableWithinDequeCall, Path::new("RUF037.py"))] + #[test_case(Rule::RedundantBoolLiteral, Path::new("RUF038.py"))] + #[test_case(Rule::RedundantBoolLiteral, Path::new("RUF038.pyi"))] + #[test_case(Rule::InvalidAssertMessageLiteralArgument, Path::new("RUF040.py"))] + #[test_case(Rule::UnnecessaryNestedLiteral, Path::new("RUF041.py"))] + #[test_case(Rule::UnnecessaryNestedLiteral, Path::new("RUF041.pyi"))] + #[test_case(Rule::UnnecessaryCastToInt, Path::new("RUF046.py"))] + #[test_case(Rule::UnnecessaryCastToInt, Path::new("RUF046_CR.py"))] + #[test_case(Rule::UnnecessaryCastToInt, Path::new("RUF046_LF.py"))] + #[test_case(Rule::NeedlessElse, Path::new("RUF047_if.py"))] + #[test_case(Rule::NeedlessElse, Path::new("RUF047_for.py"))] + #[test_case(Rule::NeedlessElse, Path::new("RUF047_while.py"))] + #[test_case(Rule::NeedlessElse, Path::new("RUF047_try.py"))] + #[test_case(Rule::MapIntVersionParsing, Path::new("RUF048.py"))] + #[test_case(Rule::MapIntVersionParsing, Path::new("RUF048_1.py"))] + #[test_case(Rule::IfKeyInDictDel, Path::new("RUF051.py"))] + #[test_case(Rule::UsedDummyVariable, Path::new("RUF052.py"))] + #[test_case(Rule::FalsyDictGetFallback, Path::new("RUF056.py"))] + #[test_case(Rule::UnusedUnpackedVariable, Path::new("RUF059_0.py"))] + #[test_case(Rule::UnusedUnpackedVariable, Path::new("RUF059_1.py"))] + #[test_case(Rule::UnusedUnpackedVariable, Path::new("RUF059_2.py"))] + #[test_case(Rule::UnusedUnpackedVariable, Path::new("RUF059_3.py"))] + #[test_case(Rule::InEmptyCollection, Path::new("RUF060.py"))] + #[test_case(Rule::RedirectedNOQA, Path::new("RUF101_0.py"))] + #[test_case(Rule::RedirectedNOQA, Path::new("RUF101_1.py"))] + #[test_case(Rule::InvalidRuleCode, Path::new("RUF102.py"))] fn rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let diagnostics = test_path( @@ -94,7 +136,7 @@ mod tests { ruff: super::settings::Settings { parenthesize_tuple_in_subscript: false, }, - target_version: PythonVersion::Py310, + unresolved_target_version: PythonVersion::PY310.into(), ..LinterSettings::for_rule(Rule::IncorrectlyParenthesizedTupleInSubscript) }, )?; @@ -113,7 +155,7 @@ mod tests { let diagnostics = test_path( Path::new("ruff").join(path).as_path(), &settings::LinterSettings::for_rule(Rule::ImplicitOptional) - .with_target_version(PythonVersion::Py39), + .with_target_version(PythonVersion::PY39), )?; assert_messages!(snapshot, diagnostics); Ok(()) @@ -276,6 +318,50 @@ mod tests { Ok(()) } + #[test] + fn ruff_noqa_filedirective_unused() -> Result<()> { + let diagnostics = test_path( + Path::new("ruff/RUF100_6.py"), + &settings::LinterSettings { + preview: PreviewMode::Enabled, + ..settings::LinterSettings::for_rules(vec![Rule::UnusedNOQA]) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } + + #[test] + fn ruff_noqa_filedirective_unused_last_of_many() -> Result<()> { + let diagnostics = test_path( + Path::new("ruff/RUF100_7.py"), + &settings::LinterSettings { + preview: PreviewMode::Enabled, + ..settings::LinterSettings::for_rules(vec![ + Rule::UnusedNOQA, + Rule::FStringMissingPlaceholders, + Rule::LineTooLong, + Rule::UnusedVariable, + ]) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } + + #[test] + fn invalid_rule_code_external_rules() -> Result<()> { + let diagnostics = test_path( + Path::new("ruff/RUF102.py"), + &settings::LinterSettings { + external: vec!["V".to_string()], + ..settings::LinterSettings::for_rule(Rule::InvalidRuleCode) + }, + )?; + assert_messages!(diagnostics); + Ok(()) + } + #[test] fn ruff_per_file_ignores() -> Result<()> { let diagnostics = test_path( @@ -356,7 +442,7 @@ mod tests { fn redirects() -> Result<()> { let diagnostics = test_path( Path::new("ruff/redirects.py"), - &settings::LinterSettings::for_rules(vec![Rule::NonPEP604Annotation]), + &settings::LinterSettings::for_rule(Rule::NonPEP604AnnotationUnion), )?; assert_messages!(diagnostics); Ok(()) @@ -365,7 +451,8 @@ mod tests { #[test_case(Rule::InvalidPyprojectToml, Path::new("bleach"))] #[test_case(Rule::InvalidPyprojectToml, Path::new("invalid_author"))] #[test_case(Rule::InvalidPyprojectToml, Path::new("maturin"))] - #[test_case(Rule::InvalidPyprojectToml, Path::new("maturin_gh_1615"))] + #[test_case(Rule::InvalidPyprojectToml, Path::new("various_invalid"))] + #[test_case(Rule::InvalidPyprojectToml, Path::new("pep639"))] fn invalid_pyproject_toml(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy()); let path = test_resource_path("fixtures") @@ -383,7 +470,20 @@ mod tests { Ok(()) } - #[test_case(Rule::ZipInsteadOfPairwise, Path::new("RUF007.py"))] + #[test_case(Rule::UnrawRePattern, Path::new("RUF039.py"))] + #[test_case(Rule::UnrawRePattern, Path::new("RUF039_concat.py"))] + #[test_case(Rule::UnnecessaryRegularExpression, Path::new("RUF055_0.py"))] + #[test_case(Rule::UnnecessaryRegularExpression, Path::new("RUF055_1.py"))] + #[test_case(Rule::UnnecessaryRegularExpression, Path::new("RUF055_2.py"))] + #[test_case(Rule::PytestRaisesAmbiguousPattern, Path::new("RUF043.py"))] + #[test_case(Rule::UnnecessaryRound, Path::new("RUF057.py"))] + #[test_case(Rule::DataclassEnum, Path::new("RUF049.py"))] + #[test_case(Rule::StarmapZip, Path::new("RUF058_0.py"))] + #[test_case(Rule::StarmapZip, Path::new("RUF058_1.py"))] + #[test_case(Rule::ClassWithMixedTypeVars, Path::new("RUF053.py"))] + #[test_case(Rule::IndentedFormFeed, Path::new("RUF054.py"))] + #[test_case(Rule::ImplicitClassVarInDataclass, Path::new("RUF045.py"))] + #[test_case(Rule::CollectionLiteralConcatenation, Path::new("RUF005_slices.py"))] fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { let snapshot = format!( "preview__{}_{}", @@ -400,4 +500,32 @@ mod tests { assert_messages!(snapshot, diagnostics); Ok(()) } + + #[test_case(Rule::UsedDummyVariable, Path::new("RUF052.py"), r"^_+", 1)] + #[test_case(Rule::UsedDummyVariable, Path::new("RUF052.py"), r"", 2)] + fn custom_regexp_preset( + rule_code: Rule, + path: &Path, + regex_pattern: &str, + id: u8, + ) -> Result<()> { + // Compile the regex from the pattern string + let regex = Regex::new(regex_pattern).unwrap(); + + let snapshot = format!( + "custom_dummy_var_regexp_preset__{}_{}_{}", + rule_code.noqa_code(), + path.to_string_lossy(), + id, + ); + let diagnostics = test_path( + Path::new("ruff").join(path).as_path(), + &settings::LinterSettings { + dummy_variable_rgx: regex, + ..settings::LinterSettings::for_rule(rule_code) + }, + )?; + assert_messages!(snapshot, diagnostics); + Ok(()) + } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/ambiguous_unicode_character.rs b/crates/ruff_linter/src/rules/ruff/rules/ambiguous_unicode_character.rs index 5464c9d39c636..9cb21628c5f11 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/ambiguous_unicode_character.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/ambiguous_unicode_character.rs @@ -2,17 +2,18 @@ use std::fmt; use bitflags::bitflags; -use ruff_diagnostics::{Diagnostic, DiagnosticKind, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, StringLike}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::Locator; use crate::checkers::ast::Checker; +use crate::preview::is_unicode_to_unicode_confusables_enabled; use crate::registry::AsRule; -use crate::rules::ruff::rules::confusables::confusable; use crate::rules::ruff::rules::Context; +use crate::rules::ruff::rules::confusables::confusable; use crate::settings::LinterSettings; -use crate::Locator; /// ## What it does /// Checks for ambiguous Unicode characters in strings. @@ -46,8 +47,8 @@ use crate::Locator; /// - `lint.allowed-confusables` /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct AmbiguousUnicodeCharacterString { +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousUnicodeCharacterString { confusable: char, representant: char, } @@ -99,8 +100,8 @@ impl Violation for AmbiguousUnicodeCharacterString { /// - `lint.allowed-confusables` /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct AmbiguousUnicodeCharacterDocstring { +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousUnicodeCharacterDocstring { confusable: char, representant: char, } @@ -152,8 +153,8 @@ impl Violation for AmbiguousUnicodeCharacterDocstring { /// - `lint.allowed-confusables` /// /// [preview]: https://docs.astral.sh/ruff/preview/ -#[violation] -pub struct AmbiguousUnicodeCharacterComment { +#[derive(ViolationMetadata)] +pub(crate) struct AmbiguousUnicodeCharacterComment { confusable: char, representant: char, } @@ -185,8 +186,14 @@ pub(crate) fn ambiguous_unicode_character_comment( } /// RUF001, RUF002 -pub(crate) fn ambiguous_unicode_character_string(checker: &mut Checker, string_like: StringLike) { - let context = if checker.semantic().in_pep_257_docstring() { +pub(crate) fn ambiguous_unicode_character_string(checker: &Checker, string_like: StringLike) { + let semantic = checker.semantic(); + + if semantic.in_string_type_definition() { + return; + } + + let context = if semantic.in_pep_257_docstring() { Context::Docstring } else { Context::String @@ -196,25 +203,33 @@ pub(crate) fn ambiguous_unicode_character_string(checker: &mut Checker, string_l match part { ast::StringLikePart::String(string_literal) => { let text = checker.locator().slice(string_literal); + let mut diagnostics = Vec::new(); ambiguous_unicode_character( - &mut checker.diagnostics, + &mut diagnostics, text, string_literal.range(), context, checker.settings, ); + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } ast::StringLikePart::Bytes(_) => {} ast::StringLikePart::FString(f_string) => { for literal in f_string.elements.literals() { let text = checker.locator().slice(literal); + let mut diagnostics = Vec::new(); ambiguous_unicode_character( - &mut checker.diagnostics, + &mut diagnostics, text, literal.range(), context, checker.settings, ); + for diagnostic in diagnostics { + checker.report_diagnostic(diagnostic); + } } } } @@ -254,9 +269,9 @@ fn ambiguous_unicode_character( // Check if the boundary character is itself an ambiguous unicode character, in which // case, it's always included as a diagnostic. if !current_char.is_ascii() { - if let Some(representant) = confusable(current_char as u32) - .filter(|representant| settings.preview.is_enabled() || representant.is_ascii()) - { + if let Some(representant) = confusable(current_char as u32).filter(|representant| { + is_unicode_to_unicode_confusables_enabled(settings) || representant.is_ascii() + }) { let candidate = Candidate::new( TextSize::try_from(relative_offset).unwrap() + range.start(), current_char, @@ -270,9 +285,9 @@ fn ambiguous_unicode_character( } else if current_char.is_ascii() { // The current word contains at least one ASCII character. word_flags |= WordFlags::ASCII; - } else if let Some(representant) = confusable(current_char as u32) - .filter(|representant| settings.preview.is_enabled() || representant.is_ascii()) - { + } else if let Some(representant) = confusable(current_char as u32).filter(|representant| { + is_unicode_to_unicode_confusables_enabled(settings) || representant.is_ascii() + }) { // The current word contains an ambiguous unicode character. word_candidates.push(Candidate::new( TextSize::try_from(relative_offset).unwrap() + range.start(), @@ -302,9 +317,9 @@ bitflags! { #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)] pub struct WordFlags: u8 { /// The word contains at least one ASCII character (like `B`). - const ASCII = 0b0000_0001; + const ASCII = 1 << 0; /// The word contains at least one unambiguous unicode character (like `β`). - const UNAMBIGUOUS_UNICODE = 0b0000_0010; + const UNAMBIGUOUS_UNICODE = 1 << 1; } } @@ -344,27 +359,30 @@ impl Candidate { fn into_diagnostic(self, context: Context, settings: &LinterSettings) -> Option<Diagnostic> { if !settings.allowed_confusables.contains(&self.confusable) { let char_range = TextRange::at(self.offset, self.confusable.text_len()); - let diagnostic = Diagnostic::new::<DiagnosticKind>( - match context { - Context::String => AmbiguousUnicodeCharacterString { + let diagnostic = match context { + Context::String => Diagnostic::new( + AmbiguousUnicodeCharacterString { confusable: self.confusable, representant: self.representant, - } - .into(), - Context::Docstring => AmbiguousUnicodeCharacterDocstring { + }, + char_range, + ), + Context::Docstring => Diagnostic::new( + AmbiguousUnicodeCharacterDocstring { confusable: self.confusable, representant: self.representant, - } - .into(), - Context::Comment => AmbiguousUnicodeCharacterComment { + }, + char_range, + ), + Context::Comment => Diagnostic::new( + AmbiguousUnicodeCharacterComment { confusable: self.confusable, representant: self.representant, - } - .into(), - }, - char_range, - ); - if settings.rules.enabled(diagnostic.kind.rule()) { + }, + char_range, + ), + }; + if settings.rules.enabled(diagnostic.rule()) { return Some(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/assert_with_print_message.rs b/crates/ruff_linter/src/rules/ruff/rules/assert_with_print_message.rs index cf5b80f004846..d11d854384f7a 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/assert_with_print_message.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/assert_with_print_message.rs @@ -2,7 +2,7 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_text_size::{Ranged, TextRange}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use crate::checkers::ast::Checker; @@ -10,13 +10,15 @@ use crate::checkers::ast::Checker; /// Checks for uses of `assert expression, print(message)`. /// /// ## Why is this bad? -/// The return value of the second expression is used as the contents of the -/// `AssertionError` raised by the `assert` statement. Using a `print` expression -/// in this context will output the message to `stdout`, before raising an -/// empty `AssertionError(None)`. +/// If an `assert x, y` assertion fails, the Python interpreter raises an +/// `AssertionError`, and the evaluated value of `y` is used as the contents of +/// that assertion error. The `print` function always returns `None`, however, +/// so the evaluated value of a call to `print` will always be `None`. /// -/// Instead, remove the `print` and pass the message directly as the second -/// expression, allowing `stderr` to capture the message in a well-formatted context. +/// Using a `print` call in this context will therefore output the message to +/// `stdout`, before raising an empty `AssertionError(None)`. Instead, remove +/// the `print` and pass the message directly as the second expression, +/// allowing `stderr` to capture the message in a well-formatted context. /// /// ## Example /// ```python @@ -35,13 +37,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `assert`](https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement) -#[violation] -pub struct AssertWithPrintMessage; +#[derive(ViolationMetadata)] +pub(crate) struct AssertWithPrintMessage; impl AlwaysFixableViolation for AssertWithPrintMessage { #[derive_message_formats] fn message(&self) -> String { - format!("`print()` expression in `assert` statement is likely unintentional") + "`print()` call in `assert` statement is likely unintentional".to_string() } fn fix_title(&self) -> String { @@ -53,7 +55,7 @@ impl AlwaysFixableViolation for AssertWithPrintMessage { /// /// Checks if the `msg` argument to an `assert` statement is a `print` call, and if so, /// replace the message with the arguments to the `print` call. -pub(crate) fn assert_with_print_message(checker: &mut Checker, stmt: &ast::StmtAssert) { +pub(crate) fn assert_with_print_message(checker: &Checker, stmt: &ast::StmtAssert) { if let Some(Expr::Call(call)) = stmt.msg.as_deref() { // We have to check that the print call is a call to the built-in `print` function let semantic = checker.semantic(); @@ -64,7 +66,7 @@ pub(crate) fn assert_with_print_message(checker: &mut Checker, stmt: &ast::StmtA diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( checker.generator().stmt(&Stmt::Assert(ast::StmtAssert { test: stmt.test.clone(), - msg: print_arguments::to_expr(&call.arguments).map(Box::new), + msg: print_arguments::to_expr(&call.arguments, checker).map(Box::new), range: TextRange::default(), })), // We have to replace the entire statement, @@ -72,7 +74,7 @@ pub(crate) fn assert_with_print_message(checker: &mut Checker, stmt: &ast::StmtA // will cease to exist. stmt.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -87,12 +89,14 @@ pub(crate) fn assert_with_print_message(checker: &mut Checker, stmt: &ast::StmtA mod print_arguments { use itertools::Itertools; use ruff_python_ast::{ - Arguments, ConversionFlag, Expr, ExprFString, ExprStringLiteral, FString, FStringElement, - FStringElements, FStringExpressionElement, FStringFlags, FStringLiteralElement, - FStringValue, StringLiteral, StringLiteralFlags, StringLiteralValue, + Arguments, ConversionFlag, Expr, ExprFString, FString, FStringElement, FStringElements, + FStringExpressionElement, FStringFlags, FStringLiteralElement, FStringValue, StringLiteral, + StringLiteralFlags, }; use ruff_text_size::TextRange; + use crate::checkers::ast::Checker; + /// Converts an expression to a list of `FStringElement`s. /// /// Three cases are handled: @@ -138,12 +142,13 @@ mod print_arguments { /// literals. fn fstring_elements_to_string_literals<'a>( mut elements: impl ExactSizeIterator<Item = &'a FStringElement>, + flags: StringLiteralFlags, ) -> Option<Vec<StringLiteral>> { elements.try_fold(Vec::with_capacity(elements.len()), |mut acc, element| { if let FStringElement::Literal(literal) = element { acc.push(StringLiteral { value: literal.value.clone(), - flags: StringLiteralFlags::default(), + flags, range: TextRange::default(), }); Some(acc) @@ -160,6 +165,7 @@ mod print_arguments { fn args_to_string_literal_expr<'a>( args: impl ExactSizeIterator<Item = &'a Vec<FStringElement>>, sep: impl ExactSizeIterator<Item = &'a FStringElement>, + flags: StringLiteralFlags, ) -> Option<Expr> { // If there are no arguments, short-circuit and return `None` if args.len() == 0 { @@ -172,8 +178,8 @@ mod print_arguments { // of a concatenated string literal. (e.g. "text", "text" "text") The `sep` will // be inserted only between the outer Vecs. let (Some(sep), Some(args)) = ( - fstring_elements_to_string_literals(sep), - args.map(|arg| fstring_elements_to_string_literals(arg.iter())) + fstring_elements_to_string_literals(sep, flags), + args.map(|arg| fstring_elements_to_string_literals(arg.iter(), flags)) .collect::<Option<Vec<_>>>(), ) else { // If any of the arguments are not string literals, return None @@ -197,13 +203,10 @@ mod print_arguments { }) .join(&sep_string); - Some(Expr::StringLiteral(ExprStringLiteral { + Some(Expr::from(StringLiteral { + value: combined_string.into(), + flags, range: TextRange::default(), - value: StringLiteralValue::single(StringLiteral { - value: combined_string.into(), - flags: StringLiteralFlags::default(), - range: TextRange::default(), - }), })) } @@ -220,6 +223,7 @@ mod print_arguments { fn args_to_fstring_expr( mut args: impl ExactSizeIterator<Item = Vec<FStringElement>>, sep: impl ExactSizeIterator<Item = FStringElement>, + flags: FStringFlags, ) -> Option<Expr> { // If there are no arguments, short-circuit and return `None` let first_arg = args.next()?; @@ -234,7 +238,7 @@ mod print_arguments { Some(Expr::FString(ExprFString { value: FStringValue::single(FString { elements: FStringElements::from(fstring_elements), - flags: FStringFlags::default(), + flags, range: TextRange::default(), }), range: TextRange::default(), @@ -254,7 +258,7 @@ mod print_arguments { /// - [`Some`]<[`Expr::StringLiteral`]> if all arguments including `sep` are string literals. /// - [`Some`]<[`Expr::FString`]> if any of the arguments are not string literals. /// - [`None`] if the `print` contains no positional arguments at all. - pub(super) fn to_expr(arguments: &Arguments) -> Option<Expr> { + pub(super) fn to_expr(arguments: &Arguments, checker: &Checker) -> Option<Expr> { // Convert the `sep` argument into `FStringElement`s let sep = arguments .find_keyword("sep") @@ -284,7 +288,13 @@ mod print_arguments { // Attempt to convert the `sep` and `args` arguments to a string literal, // falling back to an f-string if the arguments are not all string literals. - args_to_string_literal_expr(args.iter(), sep.iter()) - .or_else(|| args_to_fstring_expr(args.into_iter(), sep.into_iter())) + args_to_string_literal_expr(args.iter(), sep.iter(), checker.default_string_flags()) + .or_else(|| { + args_to_fstring_expr( + args.into_iter(), + sep.into_iter(), + checker.default_fstring_flags(), + ) + }) } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/assignment_in_assert.rs b/crates/ruff_linter/src/rules/ruff/rules/assignment_in_assert.rs index 05761fe9967df..2674f43198c0f 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/assignment_in_assert.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/assignment_in_assert.rs @@ -1,7 +1,6 @@ -use ruff_python_ast::Expr; - use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::Binding; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -20,34 +19,63 @@ use crate::checkers::ast::Checker; /// which may result in unexpected behavior (e.g., undefined variable /// accesses). /// -/// ## Examples +/// ## Example /// ```python /// assert (x := 0) == 0 +/// print(x) /// ``` /// /// Use instead: /// ```python /// x = 0 /// assert x == 0 +/// print(x) +/// ``` +/// +/// The rule avoids flagging named expressions that define variables which are +/// only referenced from inside `assert` statements; the following will not +/// trigger the rule: +/// ```python +/// assert (x := y**2) > 42, f"Expected >42 but got {x}" +/// ``` +/// +/// Nor will this: +/// ```python +/// assert (x := y**2) > 42 +/// assert x < 1_000_000 /// ``` /// /// ## References /// - [Python documentation: `-O`](https://docs.python.org/3/using/cmdline.html#cmdoption-O) -#[violation] -pub struct AssignmentInAssert; +#[derive(ViolationMetadata)] +pub(crate) struct AssignmentInAssert; impl Violation for AssignmentInAssert { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid assignment expressions in `assert` statements") + "Avoid assignment expressions in `assert` statements".to_string() } } /// RUF018 -pub(crate) fn assignment_in_assert(checker: &mut Checker, value: &Expr) { - if checker.semantic().current_statement().is_assert_stmt() { - checker - .diagnostics - .push(Diagnostic::new(AssignmentInAssert, value.range())); +pub(crate) fn assignment_in_assert(checker: &Checker, binding: &Binding) -> Option<Diagnostic> { + if !binding.in_assert_statement() { + return None; + } + + let semantic = checker.semantic(); + + let parent_expression = binding.expression(semantic)?.as_named_expr()?; + + if binding + .references() + .all(|reference| semantic.reference(reference).in_assert_statement()) + { + return None; } + + Some(Diagnostic::new( + AssignmentInAssert, + parent_expression.range(), + )) } diff --git a/crates/ruff_linter/src/rules/ruff/rules/asyncio_dangling_task.rs b/crates/ruff_linter/src/rules/ruff/rules/asyncio_dangling_task.rs index 8613f44e250bc..e69ba982af560 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/asyncio_dangling_task.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/asyncio_dangling_task.rs @@ -2,11 +2,13 @@ use std::fmt; use ast::Stmt; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{analyze::typing, Scope, SemanticModel}; +use ruff_python_semantic::{Scope, SemanticModel, analyze::typing}; use ruff_text_size::Ranged; +use crate::checkers::ast::Checker; + /// ## What it does /// Checks for `asyncio.create_task` and `asyncio.ensure_future` calls /// that do not store a reference to the returned result. @@ -50,8 +52,8 @@ use ruff_text_size::Ranged; /// ## References /// - [_The Heisenbug lurking in your async code_](https://textual.textualize.io/blog/2023/02/11/the-heisenbug-lurking-in-your-async-code/) /// - [The Python Standard Library](https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task) -#[violation] -pub struct AsyncioDanglingTask { +#[derive(ViolationMetadata)] +pub(crate) struct AsyncioDanglingTask { expr: String, method: Method, } @@ -116,11 +118,8 @@ pub(crate) fn asyncio_dangling_task(expr: &Expr, semantic: &SemanticModel) -> Op } /// RUF006 -pub(crate) fn asyncio_dangling_binding( - scope: &Scope, - semantic: &SemanticModel, - diagnostics: &mut Vec<Diagnostic>, -) { +pub(crate) fn asyncio_dangling_binding(scope: &Scope, checker: &Checker) { + let semantic = checker.semantic(); for binding_id in scope.binding_ids() { // If the binding itself is used, or it's not an assignment, skip it. let binding = semantic.binding(binding_id); @@ -165,7 +164,7 @@ pub(crate) fn asyncio_dangling_binding( }; if let Some(diagnostic) = diagnostic { - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/class_with_mixed_type_vars.rs b/crates/ruff_linter/src/rules/ruff/rules/class_with_mixed_type_vars.rs new file mode 100644 index 0000000000000..08568f2afbd08 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/class_with_mixed_type_vars.rs @@ -0,0 +1,247 @@ +use rustc_hash::FxHashSet; +use std::iter; + +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + Arguments, Expr, ExprStarred, ExprSubscript, ExprTuple, StmtClassDef, TypeParams, +}; +use ruff_python_semantic::SemanticModel; + +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; +use crate::rules::pyupgrade::rules::pep695::{ + DisplayTypeVars, TypeParamKind, TypeVar, expr_name_to_type_var, find_generic, +}; +use ruff_python_ast::PythonVersion; + +/// ## What it does +/// Checks for classes that have [PEP 695] [type parameter lists] +/// while also inheriting from `typing.Generic` or `typing_extensions.Generic`. +/// +/// ## Why is this bad? +/// Such classes cause errors at runtime: +/// +/// ```python +/// from typing import Generic, TypeVar +/// +/// U = TypeVar("U") +/// +/// # TypeError: Cannot inherit from Generic[...] multiple times. +/// class C[T](Generic[U]): ... +/// ``` +/// +/// ## Example +/// +/// ```python +/// from typing import Generic, ParamSpec, TypeVar, TypeVarTuple +/// +/// U = TypeVar("U") +/// P = ParamSpec("P") +/// Ts = TypeVarTuple("Ts") +/// +/// +/// class C[T](Generic[U, P, *Ts]): ... +/// ``` +/// +/// Use instead: +/// +/// ```python +/// class C[T, U, **P, *Ts]: ... +/// ``` +/// +/// ## Fix safety +/// As the fix changes runtime behaviour, it is always marked as unsafe. +/// Additionally, comments within the fix range will not be preserved. +/// +/// ## References +/// - [Python documentation: User-defined generic types](https://docs.python.org/3/library/typing.html#user-defined-generic-types) +/// - [Python documentation: type parameter lists](https://docs.python.org/3/reference/compound_stmts.html#type-params) +/// - [PEP 695 - Type Parameter Syntax](https://peps.python.org/pep-0695/) +/// +/// [PEP 695]: https://peps.python.org/pep-0695/ +/// [type parameter lists]: https://docs.python.org/3/reference/compound_stmts.html#type-params +#[derive(ViolationMetadata)] +pub(crate) struct ClassWithMixedTypeVars; + +impl Violation for ClassWithMixedTypeVars { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Class with type parameter list inherits from `Generic`".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Remove `Generic` base class".to_string()) + } +} + +/// RUF053 +pub(crate) fn class_with_mixed_type_vars(checker: &Checker, class_def: &StmtClassDef) { + if checker.target_version() < PythonVersion::PY312 { + return; + } + + let StmtClassDef { + type_params, + arguments, + .. + } = class_def; + + let Some(type_params) = type_params else { + return; + }; + + let Some(arguments) = arguments else { + return; + }; + + let Some((generic_base, old_style_type_vars)) = + typing_generic_base_and_arguments(arguments, checker.semantic()) + else { + return; + }; + + let mut diagnostic = Diagnostic::new(ClassWithMixedTypeVars, generic_base.range); + + diagnostic.try_set_optional_fix(|| { + convert_type_vars( + generic_base, + old_style_type_vars, + type_params, + arguments, + checker, + ) + }); + + checker.report_diagnostic(diagnostic); +} + +fn typing_generic_base_and_arguments<'a>( + class_arguments: &'a Arguments, + semantic: &SemanticModel, +) -> Option<(&'a ExprSubscript, &'a Expr)> { + let (_, base @ ExprSubscript { slice, .. }) = find_generic(class_arguments, semantic)?; + + Some((base, slice.as_ref())) +} + +fn convert_type_vars( + generic_base: &ExprSubscript, + old_style_type_vars: &Expr, + type_params: &TypeParams, + class_arguments: &Arguments, + checker: &Checker, +) -> anyhow::Result<Option<Fix>> { + let mut type_vars: Vec<_> = type_params.type_params.iter().map(TypeVar::from).collect(); + + let semantic = checker.semantic(); + let converted_type_vars = match old_style_type_vars { + Expr::Tuple(ExprTuple { elts, .. }) => { + generic_arguments_to_type_vars(elts.iter(), type_params, semantic) + } + expr @ (Expr::Subscript(_) | Expr::Name(_)) => { + generic_arguments_to_type_vars(iter::once(expr), type_params, semantic) + } + _ => None, + }; + + let Some(converted_type_vars) = converted_type_vars else { + return Ok(None); + }; + + type_vars.extend(converted_type_vars); + + let source = checker.source(); + let new_type_params = DisplayTypeVars { + type_vars: &type_vars, + source, + }; + + let remove_generic_base = + remove_argument(generic_base, class_arguments, Parentheses::Remove, source)?; + let replace_type_params = + Edit::range_replacement(new_type_params.to_string(), type_params.range); + + Ok(Some(Fix::unsafe_edits( + remove_generic_base, + [replace_type_params], + ))) +} + +/// Returns the type variables `exprs` represent. +/// +/// If at least one of them cannot be converted to [`TypeVar`], +/// `None` is returned. +fn generic_arguments_to_type_vars<'a>( + exprs: impl Iterator<Item = &'a Expr>, + existing_type_params: &TypeParams, + semantic: &'a SemanticModel, +) -> Option<Vec<TypeVar<'a>>> { + let mut type_vars = vec![]; + let mut encountered: FxHashSet<&str> = existing_type_params + .iter() + .map(|tp| tp.name().as_str()) + .collect(); + + for expr in exprs { + let (name, unpacked) = match expr { + Expr::Name(name) => (name, false), + Expr::Starred(ExprStarred { value, .. }) => (value.as_name_expr()?, true), + + Expr::Subscript(ExprSubscript { value, slice, .. }) => { + if !semantic.match_typing_expr(value, "Unpack") { + return None; + } + + (slice.as_name_expr()?, true) + } + + _ => return None, + }; + + if !encountered.insert(name.id.as_str()) { + continue; + } + + let type_var = expr_name_to_type_var(semantic, name)?; + + if !type_var_is_valid(&type_var, unpacked) { + return None; + } + + // TODO: Type parameter defaults + if type_var.default.is_some() { + return None; + } + + type_vars.push(type_var); + } + + Some(type_vars) +} + +/// Returns true in the following cases: +/// +/// * If `type_var` is a `TypeVar`: +/// * It must not be unpacked +/// * If `type_var` is a `TypeVarTuple`: +/// * It must be unpacked +/// * It must not have any restrictions +/// * If `type_var` is a `ParamSpec`: +/// * It must not be unpacked +/// * It must not have any restrictions +fn type_var_is_valid(type_var: &TypeVar, unpacked: bool) -> bool { + let is_type_var_tuple = matches!(&type_var.kind, TypeParamKind::TypeVarTuple); + + if is_type_var_tuple && !unpacked || !is_type_var_tuple && unpacked { + return false; + } + + if !matches!(&type_var.kind, TypeParamKind::TypeVar) && type_var.restriction.is_some() { + return false; + } + + true +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/collection_literal_concatenation.rs b/crates/ruff_linter/src/rules/ruff/rules/collection_literal_concatenation.rs index 0689a2957a30a..acf3d6a4a6fcf 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/collection_literal_concatenation.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/collection_literal_concatenation.rs @@ -1,10 +1,11 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Expr, ExprContext, Operator}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; use crate::fix::snippet::SourceCodeSnippet; +use crate::preview::is_support_slices_in_literal_concatenation_enabled; /// ## What it does /// Checks for uses of the `+` operator to concatenate collections. @@ -33,11 +34,17 @@ use crate::fix::snippet::SourceCodeSnippet; /// bar = [1, *foo, 5, 6] /// ``` /// +/// ## Fix safety +/// +/// The fix is always marked as unsafe because the `+` operator uses the `__add__` magic method and +/// `*`-unpacking uses the `__iter__` magic method. Both of these could have custom +/// implementations, causing the fix to change program behaviour. +/// /// ## References /// - [PEP 448 – Additional Unpacking Generalizations](https://peps.python.org/pep-0448/) /// - [Python documentation: Sequence Types — `list`, `tuple`, `range`](https://docs.python.org/3/library/stdtypes.html#sequence-types-list-tuple-range) -#[violation] -pub struct CollectionLiteralConcatenation { +#[derive(ViolationMetadata)] +pub(crate) struct CollectionLiteralConcatenation { expression: SourceCodeSnippet, } @@ -46,21 +53,19 @@ impl Violation for CollectionLiteralConcatenation { #[derive_message_formats] fn message(&self) -> String { - let CollectionLiteralConcatenation { expression } = self; - if let Some(expression) = expression.full_display() { + if let Some(expression) = self.expression.full_display() { format!("Consider `{expression}` instead of concatenation") } else { - format!("Consider iterable unpacking instead of concatenation") + "Consider iterable unpacking instead of concatenation".to_string() } } fn fix_title(&self) -> Option<String> { - let CollectionLiteralConcatenation { expression } = self; - if let Some(expression) = expression.full_display() { - Some(format!("Replace with `{expression}`")) - } else { - Some(format!("Replace with iterable unpacking")) - } + let title = match self.expression.full_display() { + Some(expression) => format!("Replace with `{expression}`"), + None => "Replace with iterable unpacking".to_string(), + }; + Some(title) } } @@ -91,7 +96,7 @@ enum Type { } /// Recursively merge all the tuples and lists in the expression. -fn concatenate_expressions(expr: &Expr) -> Option<(Expr, Type)> { +fn concatenate_expressions(expr: &Expr, should_support_slices: bool) -> Option<(Expr, Type)> { let Expr::BinOp(ast::ExprBinOp { left, op: Operator::Add, @@ -103,18 +108,22 @@ fn concatenate_expressions(expr: &Expr) -> Option<(Expr, Type)> { }; let new_left = match left.as_ref() { - Expr::BinOp(ast::ExprBinOp { .. }) => match concatenate_expressions(left) { - Some((new_left, _)) => new_left, - None => *left.clone(), - }, + Expr::BinOp(ast::ExprBinOp { .. }) => { + match concatenate_expressions(left, should_support_slices) { + Some((new_left, _)) => new_left, + None => *left.clone(), + } + } _ => *left.clone(), }; let new_right = match right.as_ref() { - Expr::BinOp(ast::ExprBinOp { .. }) => match concatenate_expressions(right) { - Some((new_right, _)) => new_right, - None => *right.clone(), - }, + Expr::BinOp(ast::ExprBinOp { .. }) => { + match concatenate_expressions(right, should_support_slices) { + Some((new_right, _)) => new_right, + None => *right.clone(), + } + } _ => *right.clone(), }; @@ -141,6 +150,12 @@ fn concatenate_expressions(expr: &Expr) -> Option<(Expr, Type)> { Expr::Call(_) | Expr::Attribute(_) | Expr::Name(_) => { make_splat_elts(splat_element, other_elements, splat_at_left) } + // Subscripts are also considered safe-ish to splat if the indexer is a slice. + Expr::Subscript(ast::ExprSubscript { slice, .. }) + if should_support_slices && matches!(&**slice, Expr::Slice(_)) => + { + make_splat_elts(splat_element, other_elements, splat_at_left) + } // If the splat element is itself a list/tuple, insert them in the other list/tuple. Expr::List(ast::ExprList { elts, .. }) if matches!(type_, Type::List) => { other_elements.iter().chain(elts).cloned().collect() @@ -171,7 +186,7 @@ fn concatenate_expressions(expr: &Expr) -> Option<(Expr, Type)> { } /// RUF005 -pub(crate) fn collection_literal_concatenation(checker: &mut Checker, expr: &Expr) { +pub(crate) fn collection_literal_concatenation(checker: &Checker, expr: &Expr) { // If the expression is already a child of an addition, we'll have analyzed it already. if matches!( checker.semantic().current_expression_parent(), @@ -183,7 +198,10 @@ pub(crate) fn collection_literal_concatenation(checker: &mut Checker, expr: &Exp return; } - let Some((new_expr, type_)) = concatenate_expressions(expr) else { + let should_support_slices = + is_support_slices_in_literal_concatenation_enabled(checker.settings); + + let Some((new_expr, type_)) = concatenate_expressions(expr, should_support_slices) else { return; }; @@ -209,5 +227,5 @@ pub(crate) fn collection_literal_concatenation(checker: &mut Checker, expr: &Exp expr.range(), ))); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/ruff/rules/dataclass_enum.rs b/crates/ruff_linter/src/rules/ruff/rules/dataclass_enum.rs new file mode 100644 index 0000000000000..3d168d8c3fb01 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/dataclass_enum.rs @@ -0,0 +1,76 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::StmtClassDef; +use ruff_python_semantic::analyze::class::is_enumeration; + +use crate::checkers::ast::Checker; +use crate::rules::ruff::rules::helpers::{DataclassKind, dataclass_kind}; + +/// ## What it does +/// Checks for enum classes which are also decorated with `@dataclass`. +/// +/// ## Why is this bad? +/// Decorating an enum with `@dataclass()` does not cause any errors at runtime, +/// but may cause erroneous results: +/// +/// ```python +/// @dataclass +/// class E(Enum): +/// A = 1 +/// B = 2 +/// +/// print(E.A == E.B) # True +/// ``` +/// +/// ## Example +/// +/// ```python +/// from dataclasses import dataclass +/// from enum import Enum +/// +/// +/// @dataclass +/// class E(Enum): ... +/// ``` +/// +/// Use instead: +/// +/// ```python +/// from enum import Enum +/// +/// +/// class E(Enum): ... +/// ``` +/// +/// ## References +/// - [Python documentation: Enum HOWTO § Dataclass support](https://docs.python.org/3/howto/enum.html#dataclass-support) +#[derive(ViolationMetadata)] +pub(crate) struct DataclassEnum; + +impl Violation for DataclassEnum { + #[derive_message_formats] + fn message(&self) -> String { + "An enum class should not be decorated with `@dataclass`".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Remove either `@dataclass` or `Enum`".to_string()) + } +} + +/// RUF049 +pub(crate) fn dataclass_enum(checker: &Checker, class_def: &StmtClassDef) { + let semantic = checker.semantic(); + + let Some((DataclassKind::Stdlib, decorator)) = dataclass_kind(class_def, semantic) else { + return; + }; + + if !is_enumeration(class_def, semantic) { + return; + } + + let diagnostic = Diagnostic::new(DataclassEnum, decorator.range); + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/decimal_from_float_literal.rs b/crates/ruff_linter/src/rules/ruff/rules/decimal_from_float_literal.rs index f78cad69f70d2..6458126dec1cd 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/decimal_from_float_literal.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/decimal_from_float_literal.rs @@ -1,13 +1,13 @@ use std::fmt; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_codegen::Stylist; use ruff_text_size::{Ranged, TextRange}; -use crate::checkers::ast::Checker; use crate::Locator; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for `Decimal` calls passing a float literal. @@ -32,22 +32,22 @@ use crate::Locator; /// This rule's fix is marked as unsafe because it changes the underlying value /// of the `Decimal` instance that is constructed. This can lead to unexpected /// behavior if your program relies on the previous value (whether deliberately or not). -#[violation] -pub struct DecimalFromFloatLiteral; +#[derive(ViolationMetadata)] +pub(crate) struct DecimalFromFloatLiteral; impl AlwaysFixableViolation for DecimalFromFloatLiteral { #[derive_message_formats] fn message(&self) -> String { - format!("`Decimal()` called with float literal argument") + "`Decimal()` called with float literal argument".to_string() } fn fix_title(&self) -> String { - "Use a string literal instead".to_string() + "Replace with string literal".to_string() } } /// RUF032: `Decimal()` called with float literal argument -pub(crate) fn decimal_from_float_literal_syntax(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn decimal_from_float_literal_syntax(checker: &Checker, call: &ast::ExprCall) { let Some(arg) = call.arguments.args.first() else { return; }; @@ -63,7 +63,7 @@ pub(crate) fn decimal_from_float_literal_syntax(checker: &mut Checker, call: &as let diagnostic = Diagnostic::new(DecimalFromFloatLiteral, arg.range()).with_fix( fix_float_literal(arg.range(), float, checker.locator(), checker.stylist()), ); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/default_factory_kwarg.rs b/crates/ruff_linter/src/rules/ruff/rules/default_factory_kwarg.rs index 2e814faae21c4..521bd5d90a186 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/default_factory_kwarg.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/default_factory_kwarg.rs @@ -2,15 +2,15 @@ use anyhow::Result; use ast::Keyword; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::is_constant; use ruff_python_ast::{self as ast, Expr}; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; -use crate::fix::edits::{remove_argument, Parentheses}; +use crate::fix::edits::{Parentheses, remove_argument}; use crate::fix::snippet::SourceCodeSnippet; -use crate::Locator; /// ## What it does /// Checks for incorrect usages of `default_factory` as a keyword argument when @@ -38,7 +38,7 @@ use crate::Locator; /// keyword to a positional argument will change the behavior of the code, even /// if the keyword argument was used erroneously. /// -/// ## Examples +/// ## Example /// ```python /// defaultdict(default_factory=int) /// defaultdict(default_factory=list) @@ -49,8 +49,8 @@ use crate::Locator; /// defaultdict(int) /// defaultdict(list) /// ``` -#[violation] -pub struct DefaultFactoryKwarg { +#[derive(ViolationMetadata)] +pub(crate) struct DefaultFactoryKwarg { default_factory: SourceCodeSnippet, } @@ -59,7 +59,7 @@ impl Violation for DefaultFactoryKwarg { #[derive_message_formats] fn message(&self) -> String { - format!("`default_factory` is a positional-only argument to `defaultdict`") + "`default_factory` is a positional-only argument to `defaultdict`".to_string() } fn fix_title(&self) -> Option<String> { @@ -73,7 +73,7 @@ impl Violation for DefaultFactoryKwarg { } /// RUF026 -pub(crate) fn default_factory_kwarg(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn default_factory_kwarg(checker: &Checker, call: &ast::ExprCall) { // If the call isn't a `defaultdict` constructor, return. if !checker .semantic() @@ -107,7 +107,7 @@ pub(crate) fn default_factory_kwarg(checker: &mut Checker, call: &ast::ExprCall) call.range(), ); diagnostic.try_set_fix(|| convert_to_positional(call, keyword, checker.locator())); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Returns `true` if a value is definitively not callable (e.g., `1` or `[]`). diff --git a/crates/ruff_linter/src/rules/ruff/rules/explicit_f_string_type_conversion.rs b/crates/ruff_linter/src/rules/ruff/rules/explicit_f_string_type_conversion.rs index 86ca73ba673cb..eaf93d17dd1b1 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/explicit_f_string_type_conversion.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/explicit_f_string_type_conversion.rs @@ -1,17 +1,17 @@ -use anyhow::{bail, Result}; +use anyhow::{Result, bail}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_python_codegen::Stylist; use ruff_text_size::Ranged; +use crate::Locator; use crate::checkers::ast::Checker; use crate::cst::matchers::{ match_call_mut, match_formatted_string, match_formatted_string_expression, match_name, transform_expression, }; -use crate::Locator; /// ## What it does /// Checks for uses of `str()`, `repr()`, and `ascii()` as explicit type @@ -37,13 +37,13 @@ use crate::Locator; /// a = "some string" /// f"{a!r}" /// ``` -#[violation] -pub struct ExplicitFStringTypeConversion; +#[derive(ViolationMetadata)] +pub(crate) struct ExplicitFStringTypeConversion; impl AlwaysFixableViolation for ExplicitFStringTypeConversion { #[derive_message_formats] fn message(&self) -> String { - format!("Use explicit conversion flag") + "Use explicit conversion flag".to_string() } fn fix_title(&self) -> String { @@ -52,7 +52,7 @@ impl AlwaysFixableViolation for ExplicitFStringTypeConversion { } /// RUF010 -pub(crate) fn explicit_f_string_type_conversion(checker: &mut Checker, f_string: &ast::FString) { +pub(crate) fn explicit_f_string_type_conversion(checker: &Checker, f_string: &ast::FString) { for (index, element) in f_string.elements.iter().enumerate() { let Some(ast::FStringExpressionElement { expression, @@ -112,7 +112,7 @@ pub(crate) fn explicit_f_string_type_conversion(checker: &mut Checker, f_string: diagnostic.try_set_fix(|| { convert_call_to_conversion_flag(f_string, index, checker.locator(), checker.stylist()) }); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/falsy_dict_get_fallback.rs b/crates/ruff_linter/src/rules/ruff/rules/falsy_dict_get_fallback.rs new file mode 100644 index 0000000000000..9e8c04521659d --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/falsy_dict_get_fallback.rs @@ -0,0 +1,111 @@ +use crate::checkers::ast::Checker; +use crate::fix::edits::{Parentheses, remove_argument}; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprAttribute, helpers::Truthiness}; +use ruff_python_semantic::analyze::typing; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for `dict.get(key, falsy_value)` calls in boolean test positions. +/// +/// ## Why is this bad? +/// The default fallback `None` is already falsy. +/// +/// ## Example +/// +/// ```python +/// if dict.get(key, False): +/// ... +/// ``` +/// +/// Use instead: +/// +/// ```python +/// if dict.get(key): +/// ... +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the `dict.get()` call contains comments between arguments. +#[derive(ViolationMetadata)] +pub(crate) struct FalsyDictGetFallback; + +impl AlwaysFixableViolation for FalsyDictGetFallback { + #[derive_message_formats] + fn message(&self) -> String { + "Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy.".to_string() + } + + fn fix_title(&self) -> String { + "Remove falsy fallback from `dict.get()`".to_string() + } +} + +pub(crate) fn falsy_dict_get_fallback(checker: &Checker, expr: &Expr) { + let semantic = checker.semantic(); + + // Check if we are in a boolean test + if !semantic.in_boolean_test() { + return; + } + + // Check if the expression is a call + let Expr::Call(call) = expr else { + return; + }; + + // Check if the function being called is an attribute (e.g. `dict.get`) + let Expr::Attribute(ExprAttribute { value, attr, .. }) = &*call.func else { + return; + }; + + // Ensure the method called is `get` + if attr != "get" { + return; + } + + // Check if the object is a dictionary using the semantic model + if !value + .as_name_expr() + .is_some_and(|name| typing::is_known_to_be_of_type_dict(semantic, name)) + { + return; + } + + // Get the fallback argument + let Some(fallback_arg) = call.arguments.find_argument("default", 1) else { + return; + }; + + // Check if the fallback is a falsy value + if Truthiness::from_expr(fallback_arg.value(), |id| semantic.has_builtin_binding(id)) + .into_bool() + != Some(false) + { + return; + } + + let mut diagnostic = Diagnostic::new(FalsyDictGetFallback, fallback_arg.range()); + + let comment_ranges = checker.comment_ranges(); + + // Determine applicability based on the presence of comments + let applicability = if comment_ranges.intersects(call.arguments.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + diagnostic.try_set_fix(|| { + remove_argument( + &fallback_arg, + &call.arguments, + Parentheses::Preserve, + checker.locator().contents(), + ) + .map(|edit| Fix::applicable_edit(edit, applicability)) + }); + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/function_call_in_dataclass_default.rs b/crates/ruff_linter/src/rules/ruff/rules/function_call_in_dataclass_default.rs index 017e243da93f1..debba91faea3e 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/function_call_in_dataclass_default.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/function_call_in_dataclass_default.rs @@ -1,14 +1,17 @@ use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::{QualifiedName, UnqualifiedName}; -use ruff_python_semantic::analyze::typing::is_immutable_func; +use ruff_python_semantic::analyze::typing::{ + is_immutable_annotation, is_immutable_func, is_immutable_newtype_call, +}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::rules::ruff::rules::helpers::{ - is_class_var_annotation, is_dataclass, is_dataclass_field, is_descriptor_class, + AttrsAutoAttribs, DataclassKind, dataclass_kind, is_class_var_annotation, is_dataclass_field, + is_descriptor_class, }; /// ## What it does @@ -23,7 +26,10 @@ use crate::rules::ruff::rules::helpers::{ /// If a field needs to be initialized with a mutable object, use the /// `field(default_factory=...)` pattern. /// -/// ## Examples +/// Attributes whose default arguments are `NewType` calls +/// where the original type is immutable are ignored. +/// +/// ## Example /// ```python /// from dataclasses import dataclass /// @@ -53,31 +59,52 @@ use crate::rules::ruff::rules::helpers::{ /// /// ## Options /// - `lint.flake8-bugbear.extend-immutable-calls` -#[violation] -pub struct FunctionCallInDataclassDefaultArgument { +#[derive(ViolationMetadata)] +pub(crate) struct FunctionCallInDataclassDefaultArgument { name: Option<String>, } impl Violation for FunctionCallInDataclassDefaultArgument { #[derive_message_formats] fn message(&self) -> String { - let FunctionCallInDataclassDefaultArgument { name } = self; - if let Some(name) = name { + if let Some(name) = &self.name { format!("Do not perform function call `{name}` in dataclass defaults") } else { - format!("Do not perform function call in dataclass defaults") + "Do not perform function call in dataclass defaults".to_string() } } } /// RUF009 -pub(crate) fn function_call_in_dataclass_default( - checker: &mut Checker, - class_def: &ast::StmtClassDef, -) { - if !is_dataclass(class_def, checker.semantic()) { +pub(crate) fn function_call_in_dataclass_default(checker: &Checker, class_def: &ast::StmtClassDef) { + let semantic = checker.semantic(); + + let Some((dataclass_kind, _)) = dataclass_kind(class_def, semantic) else { return; - } + }; + + let attrs_auto_attribs = match dataclass_kind { + DataclassKind::Stdlib => None, + + DataclassKind::Attrs(auto_attribs) => match auto_attribs { + AttrsAutoAttribs::Unknown => return, + + AttrsAutoAttribs::None => { + if any_annotated(&class_def.body) { + Some(AttrsAutoAttribs::True) + } else { + Some(AttrsAutoAttribs::False) + } + } + + _ => Some(auto_attribs), + }, + }; + + let dataclass_kind = match attrs_auto_attribs { + None => DataclassKind::Stdlib, + Some(auto_attribs) => DataclassKind::Attrs(auto_attribs), + }; let extend_immutable_calls: Vec<QualifiedName> = checker .settings @@ -88,26 +115,50 @@ pub(crate) fn function_call_in_dataclass_default( .collect(); for statement in &class_def.body { - if let Stmt::AnnAssign(ast::StmtAnnAssign { + let Stmt::AnnAssign(ast::StmtAnnAssign { annotation, value: Some(expr), .. }) = statement + else { + continue; + }; + let Expr::Call(ast::ExprCall { func, .. }) = expr.as_ref() else { + continue; + }; + + let is_field = is_dataclass_field(func, checker.semantic(), dataclass_kind); + + // Non-explicit fields in an `attrs` dataclass + // with `auto_attribs=False` are class variables. + if matches!(attrs_auto_attribs, Some(AttrsAutoAttribs::False)) && !is_field { + continue; + } + + if is_field + || is_immutable_annotation(annotation, checker.semantic(), &extend_immutable_calls) + || is_class_var_annotation(annotation, checker.semantic()) + || is_immutable_func(func, checker.semantic(), &extend_immutable_calls) + || is_descriptor_class(func, checker.semantic()) + || func.as_name_expr().is_some_and(|name| { + is_immutable_newtype_call(name, checker.semantic(), &extend_immutable_calls) + }) { - if let Expr::Call(ast::ExprCall { func, .. }) = expr.as_ref() { - if !is_class_var_annotation(annotation, checker.semantic()) - && !is_immutable_func(func, checker.semantic(), &extend_immutable_calls) - && !is_dataclass_field(func, checker.semantic()) - && !is_descriptor_class(func, checker.semantic()) - { - checker.diagnostics.push(Diagnostic::new( - FunctionCallInDataclassDefaultArgument { - name: UnqualifiedName::from_expr(func).map(|name| name.to_string()), - }, - expr.range(), - )); - } - } + continue; } + + let kind = FunctionCallInDataclassDefaultArgument { + name: UnqualifiedName::from_expr(func).map(|name| name.to_string()), + }; + let diagnostic = Diagnostic::new(kind, expr.range()); + + checker.report_diagnostic(diagnostic); } } + +#[inline] +fn any_annotated(class_body: &[Stmt]) -> bool { + class_body + .iter() + .any(|stmt| matches!(stmt, Stmt::AnnAssign(..))) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/helpers.rs b/crates/ruff_linter/src/rules/ruff/rules/helpers.rs index 07b96af1f0fbf..4fef08b2aace9 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/helpers.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/helpers.rs @@ -1,6 +1,6 @@ -use ruff_python_ast::helpers::{map_callable, map_subscript}; -use ruff_python_ast::{self as ast, Expr}; -use ruff_python_semantic::{analyze, BindingKind, Modules, SemanticModel}; +use ruff_python_ast::helpers::{Truthiness, map_callable, map_subscript}; +use ruff_python_ast::{self as ast, Expr, ExprCall}; +use ruff_python_semantic::{BindingKind, Modules, SemanticModel, analyze}; /// Return `true` if the given [`Expr`] is a special class attribute, like `__slots__`. /// @@ -18,17 +18,42 @@ pub(super) fn is_special_attribute(value: &Expr) -> bool { } } -/// Returns `true` if the given [`Expr`] is a `dataclasses.field` call. -pub(super) fn is_dataclass_field(func: &Expr, semantic: &SemanticModel) -> bool { - if !semantic.seen_module(Modules::DATACLASSES) { - return false; - } - +/// Returns `true` if the given [`Expr`] is a stdlib `dataclasses.field` call. +fn is_stdlib_dataclass_field(func: &Expr, semantic: &SemanticModel) -> bool { semantic .resolve_qualified_name(func) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["dataclasses", "field"])) } +/// Returns `true` if the given [`Expr`] is a call to `attr.ib()` or `attrs.field()`. +fn is_attrs_field(func: &Expr, semantic: &SemanticModel) -> bool { + semantic + .resolve_qualified_name(func) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + ["attrs", "field" | "Factory"] | ["attr", "ib"] + ) + }) +} + +/// Return `true` if `func` represents a `field()` call corresponding to the `dataclass_kind` variant passed in. +/// +/// I.e., if `DataclassKind::Attrs` is passed in, +/// return `true` if `func` represents a call to `attr.ib()` or `attrs.field()`; +/// if `DataclassKind::Stdlib` is passed in, +/// return `true` if `func` represents a call to `dataclasse.field()`. +pub(super) fn is_dataclass_field( + func: &Expr, + semantic: &SemanticModel, + dataclass_kind: DataclassKind, +) -> bool { + match dataclass_kind { + DataclassKind::Attrs(..) => is_attrs_field(func, semantic), + DataclassKind::Stdlib => is_stdlib_dataclass_field(func, semantic), + } +} + /// Returns `true` if the given [`Expr`] is a `typing.ClassVar` annotation. pub(super) fn is_class_var_annotation(annotation: &Expr, semantic: &SemanticModel) -> bool { if !semantic.seen_typing() { @@ -51,24 +76,96 @@ pub(super) fn is_final_annotation(annotation: &Expr, semantic: &SemanticModel) - semantic.match_typing_expr(map_subscript(annotation), "Final") } -/// Returns `true` if the given class is a dataclass. -pub(super) fn is_dataclass(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> bool { - if !semantic.seen_module(Modules::DATACLASSES) { - return false; +/// Values that [`attrs`'s `auto_attribs`][1] accept. +/// +/// [1]: https://www.attrs.org/en/stable/api.html#attrs.define +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(super) enum AttrsAutoAttribs { + /// `a: str = ...` are automatically converted to fields. + True, + /// Only `attrs.field()`/`attr.ib()` calls are considered fields. + False, + /// `True` if any attributes are annotated (and no unannotated `attrs.field`s are found). + /// `False` otherwise. + None, + /// The provided value is not a literal. + Unknown, +} + +/// Enumeration of various kinds of dataclasses recognised by Ruff +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(super) enum DataclassKind { + /// dataclasses created by the stdlib `dataclasses` module + Stdlib, + /// dataclasses created by the third-party `attrs` library + Attrs(AttrsAutoAttribs), +} + +/// Return the kind of dataclass this class definition is (stdlib or `attrs`), +/// or `None` if the class is not a dataclass. +pub(super) fn dataclass_kind<'a>( + class_def: &'a ast::StmtClassDef, + semantic: &SemanticModel, +) -> Option<(DataclassKind, &'a ast::Decorator)> { + if !(semantic.seen_module(Modules::DATACLASSES) || semantic.seen_module(Modules::ATTRS)) { + return None; } - class_def.decorator_list.iter().any(|decorator| { - semantic - .resolve_qualified_name(map_callable(&decorator.expression)) - .is_some_and(|qualified_name| { - matches!(qualified_name.segments(), ["dataclasses", "dataclass"]) - }) - }) + for decorator in &class_def.decorator_list { + let Some(qualified_name) = + semantic.resolve_qualified_name(map_callable(&decorator.expression)) + else { + continue; + }; + + match qualified_name.segments() { + ["attrs", func @ ("define" | "frozen" | "mutable")] | ["attr", func @ "s"] => { + // `.define`, `.frozen` and `.mutable` all default `auto_attribs` to `None`, + // whereas `@attr.s` implicitly sets `auto_attribs=False`. + // https://www.attrs.org/en/stable/api.html#attrs.define + // https://www.attrs.org/en/stable/api-attr.html#attr.s + let Expr::Call(ExprCall { arguments, .. }) = &decorator.expression else { + let auto_attribs = if *func == "s" { + AttrsAutoAttribs::False + } else { + AttrsAutoAttribs::None + }; + + return Some((DataclassKind::Attrs(auto_attribs), decorator)); + }; + + let Some(auto_attribs) = arguments.find_keyword("auto_attribs") else { + return Some((DataclassKind::Attrs(AttrsAutoAttribs::None), decorator)); + }; + + let auto_attribs = match Truthiness::from_expr(&auto_attribs.value, |id| { + semantic.has_builtin_binding(id) + }) { + // `auto_attribs` requires an exact `True` to be true + Truthiness::True => AttrsAutoAttribs::True, + // Or an exact `None` to auto-detect. + Truthiness::None => AttrsAutoAttribs::None, + // Otherwise, anything else (even a truthy value, like `1`) is considered `False`. + Truthiness::Truthy | Truthiness::False | Truthiness::Falsey => { + AttrsAutoAttribs::False + } + // Unless, of course, we can't determine the value. + Truthiness::Unknown => AttrsAutoAttribs::Unknown, + }; + + return Some((DataclassKind::Attrs(auto_attribs), decorator)); + } + ["dataclasses", "dataclass"] => return Some((DataclassKind::Stdlib, decorator)), + _ => continue, + } + } + + None } /// Returns `true` if the given class has "default copy" semantics. /// -/// For example, Pydantic `BaseModel` and `BaseSettings` subclassses copy attribute defaults on +/// For example, Pydantic `BaseModel` and `BaseSettings` subclasses copy attribute defaults on /// instance creation. As such, the use of mutable default values is safe for such classes. pub(super) fn has_default_copy_semantics( class_def: &ast::StmtClassDef, @@ -77,9 +174,19 @@ pub(super) fn has_default_copy_semantics( analyze::class::any_qualified_base_class(class_def, semantic, &|qualified_name| { matches!( qualified_name.segments(), - ["pydantic", "BaseModel" | "BaseSettings" | "BaseConfig"] + [ + "pydantic", + "BaseModel" | "RootModel" | "BaseSettings" | "BaseConfig" + ] | ["pydantic", "generics", "GenericModel"] + | [ + "pydantic", + "v1", + "BaseModel" | "BaseSettings" | "BaseConfig" + ] + | ["pydantic", "v1", "generics", "GenericModel"] | ["pydantic_settings", "BaseSettings"] | ["msgspec", "Struct"] + | ["sqlmodel", "SQLModel"] ) }) } diff --git a/crates/ruff_linter/src/rules/ruff/rules/if_key_in_dict_del.rs b/crates/ruff_linter/src/rules/ruff/rules/if_key_in_dict_del.rs new file mode 100644 index 0000000000000..f44d19d9e767a --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/if_key_in_dict_del.rs @@ -0,0 +1,145 @@ +use crate::checkers::ast::Checker; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{CmpOp, Expr, ExprName, ExprSubscript, Stmt, StmtIf}; +use ruff_python_semantic::analyze::typing; + +type Key = Expr; +type Dict = ExprName; + +/// ## What it does +/// Checks for `if key in dictionary: del dictionary[key]`. +/// +/// ## Why is this bad? +/// To remove a key-value pair from a dictionary, it's more concise to use `.pop(..., None)`. +/// +/// ## Example +/// +/// ```python +/// if key in dictionary: +/// del dictionary[key] +/// ``` +/// +/// Use instead: +/// +/// ```python +/// dictionary.pop(key, None) +/// ``` +/// +/// ## Fix safety +/// This rule's fix is marked as safe, unless the if statement contains comments. +#[derive(ViolationMetadata)] +pub(crate) struct IfKeyInDictDel; + +impl AlwaysFixableViolation for IfKeyInDictDel { + #[derive_message_formats] + fn message(&self) -> String { + "Use `pop` instead of `key in dict` followed by `del dict[key]`".to_string() + } + + fn fix_title(&self) -> String { + "Replace `if` statement with `.pop(..., None)`".to_string() + } +} + +/// RUF051 +pub(crate) fn if_key_in_dict_del(checker: &Checker, stmt: &StmtIf) { + let [Stmt::Delete(delete)] = &stmt.body[..] else { + return; + }; + + let Some((test_dict, test_key)) = extract_dict_and_key_from_test(&stmt.test) else { + return; + }; + let Some((del_dict, del_key)) = extract_dict_and_key_from_del(&delete.targets) else { + return; + }; + + if !is_same_key(test_key, del_key) || !is_same_dict(test_dict, del_dict) { + return; + } + + if !typing::is_known_to_be_of_type_dict(checker.semantic(), test_dict) { + return; + } + + let fix = replace_with_dict_pop_fix(checker, stmt, test_dict, test_key); + + let diagnostic = Diagnostic::new(IfKeyInDictDel, delete.range); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +fn extract_dict_and_key_from_test(test: &Expr) -> Option<(&Dict, &Key)> { + let Expr::Compare(comp) = test else { + return None; + }; + + let [Expr::Name(dict)] = comp.comparators.as_ref() else { + return None; + }; + + if !matches!(comp.ops.as_ref(), [CmpOp::In]) { + return None; + } + + Some((dict, &comp.left)) +} + +fn extract_dict_and_key_from_del(targets: &[Expr]) -> Option<(&Dict, &Key)> { + let [Expr::Subscript(ExprSubscript { value, slice, .. })] = targets else { + return None; + }; + + let Expr::Name(dict) = value.as_ref() else { + return None; + }; + + Some((dict, slice)) +} + +fn is_same_key(test: &Key, del: &Key) -> bool { + match (test, del) { + (Expr::Name(ExprName { id: test, .. }), Expr::Name(ExprName { id: del, .. })) => { + test.as_str() == del.as_str() + } + + (Expr::NoneLiteral(..), Expr::NoneLiteral(..)) => true, + (Expr::EllipsisLiteral(..), Expr::EllipsisLiteral(..)) => true, + + (Expr::BooleanLiteral(test), Expr::BooleanLiteral(del)) => test.value == del.value, + (Expr::NumberLiteral(test), Expr::NumberLiteral(del)) => test.value == del.value, + + (Expr::BytesLiteral(test), Expr::BytesLiteral(del)) => { + Iterator::eq(test.value.bytes(), del.value.bytes()) + } + + (Expr::StringLiteral(test), Expr::StringLiteral(del)) => { + Iterator::eq(test.value.chars(), del.value.chars()) + } + + _ => false, + } +} + +fn is_same_dict(test: &Dict, del: &Dict) -> bool { + test.id.as_str() == del.id.as_str() +} + +fn replace_with_dict_pop_fix(checker: &Checker, stmt: &StmtIf, dict: &Dict, key: &Key) -> Fix { + let locator = checker.locator(); + let dict_expr = locator.slice(dict); + let key_expr = locator.slice(key); + + let replacement = format!("{dict_expr}.pop({key_expr}, None)"); + let edit = Edit::range_replacement(replacement, stmt.range); + + let comment_ranges = checker.comment_ranges(); + let applicability = if comment_ranges.intersects(stmt.range) { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + Fix::applicable_edit(edit, applicability) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/implicit_classvar_in_dataclass.rs b/crates/ruff_linter/src/rules/ruff/rules/implicit_classvar_in_dataclass.rs new file mode 100644 index 0000000000000..91643214f9f7e --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/implicit_classvar_in_dataclass.rs @@ -0,0 +1,102 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::is_dunder; +use ruff_python_ast::{Expr, ExprName, Stmt, StmtAssign, StmtClassDef}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; +use crate::rules::ruff::rules::helpers::{DataclassKind, dataclass_kind}; + +/// ## What it does +/// Checks for implicit class variables in dataclasses. +/// +/// Variables matching the [`lint.dummy-variable-rgx`] are excluded +/// from this rule. +/// +/// ## Why is this bad? +/// Class variables are shared between all instances of that class. +/// In dataclasses, fields with no annotations at all +/// are implicitly considered class variables, and a `TypeError` is +/// raised if a user attempts to initialize an instance of the class +/// with this field. +/// +/// +/// ```python +/// @dataclass +/// class C: +/// a = 1 +/// b: str = "" +/// +/// C(a = 42) # TypeError: C.__init__() got an unexpected keyword argument 'a' +/// ``` +/// +/// ## Example +/// +/// ```python +/// @dataclass +/// class C: +/// a = 1 +/// ``` +/// +/// Use instead: +/// +/// ```python +/// from typing import ClassVar +/// +/// +/// @dataclass +/// class C: +/// a: ClassVar[int] = 1 +/// ``` +/// +/// ## Options +/// - [`lint.dummy-variable-rgx`] +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitClassVarInDataclass; + +impl Violation for ImplicitClassVarInDataclass { + #[derive_message_formats] + fn message(&self) -> String { + "Assignment without annotation found in dataclass body".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Use `ClassVar[...]`".to_string()) + } +} + +/// RUF045 +pub(crate) fn implicit_class_var_in_dataclass(checker: &mut Checker, class_def: &StmtClassDef) { + let dataclass_kind = dataclass_kind(class_def, checker.semantic()); + + if !matches!(dataclass_kind, Some((DataclassKind::Stdlib, _))) { + return; + } + + for statement in &class_def.body { + let Stmt::Assign(StmtAssign { targets, .. }) = statement else { + continue; + }; + + if targets.len() > 1 { + continue; + } + + let target = targets.first().unwrap(); + let Expr::Name(ExprName { id, .. }) = target else { + continue; + }; + + if checker.settings.dummy_variable_rgx.is_match(id.as_str()) { + continue; + } + + if is_dunder(id.as_str()) { + continue; + } + + let diagnostic = Diagnostic::new(ImplicitClassVarInDataclass, target.range()); + + checker.report_diagnostic(diagnostic); + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/implicit_optional.rs b/crates/ruff_linter/src/rules/ruff/rules/implicit_optional.rs index acb7104a9a35b..298d261e430f5 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/implicit_optional.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/implicit_optional.rs @@ -1,18 +1,17 @@ use std::fmt; -use anyhow::Result; +use anyhow::{Context, Result}; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; -use ruff_python_ast::{self as ast, Expr, Operator, ParameterWithDefault, Parameters}; +use ruff_python_ast::{self as ast, Expr, Operator, Parameters}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; -use crate::importer::ImportRequest; -use crate::settings::types::PythonVersion; +use ruff_python_ast::PythonVersion; use super::super::typing::type_hint_explicitly_allows_none; @@ -73,9 +72,14 @@ use super::super::typing::type_hint_explicitly_allows_none; /// ## Options /// - `target-version` /// +/// ## Fix safety +/// +/// This fix is always marked as unsafe because it can change the behavior of code that relies on +/// type hints, and it assumes the default value is always appropriate—which might not be the case. +/// /// [PEP 484]: https://peps.python.org/pep-0484/#union-types -#[violation] -pub struct ImplicitOptional { +#[derive(ViolationMetadata)] +pub(crate) struct ImplicitOptional { conversion_type: ConversionType, } @@ -84,7 +88,7 @@ impl Violation for ImplicitOptional { #[derive_message_formats] fn message(&self) -> String { - format!("PEP 484 prohibits implicit `Optional`") + "PEP 484 prohibits implicit `Optional`".to_string() } fn fix_title(&self) -> Option<String> { @@ -112,7 +116,7 @@ impl fmt::Display for ConversionType { impl From<PythonVersion> for ConversionType { fn from(target_version: PythonVersion) -> Self { - if target_version >= PythonVersion::Py310 { + if target_version >= PythonVersion::PY310 { Self::BinOpOr } else { Self::Optional @@ -137,11 +141,10 @@ fn generate_fix(checker: &Checker, conversion_type: ConversionType, expr: &Expr) ))) } ConversionType::Optional => { - let (import_edit, binding) = checker.importer().get_or_import_symbol( - &ImportRequest::import_from("typing", "Optional"), - expr.start(), - checker.semantic(), - )?; + let importer = checker + .typing_importer("Optional", PythonVersion::lowest()) + .context("Optional should be available on all supported Python versions")?; + let (import_edit, binding) = importer.import(expr.start())?; let new_expr = Expr::Subscript(ast::ExprSubscript { range: TextRange::default(), value: Box::new(Expr::Name(ast::ExprName { @@ -162,55 +165,47 @@ fn generate_fix(checker: &Checker, conversion_type: ConversionType, expr: &Expr) } /// RUF013 -pub(crate) fn implicit_optional(checker: &mut Checker, parameters: &Parameters) { - for ParameterWithDefault { - parameter, - default, - range: _, - } in parameters.iter_non_variadic_params() - { - let Some(default) = default else { continue }; - if !default.is_none_literal_expr() { +pub(crate) fn implicit_optional(checker: &Checker, parameters: &Parameters) { + for parameter in parameters.iter_non_variadic_params() { + let Some(Expr::NoneLiteral(_)) = parameter.default() else { continue; - } - let Some(annotation) = ¶meter.annotation else { + }; + let Some(annotation) = parameter.annotation() else { continue; }; - if let Expr::StringLiteral(string_expr) = annotation.as_ref() { + if let Expr::StringLiteral(string_expr) = annotation { // Quoted annotation. - if let Some(parsed_annotation) = checker.parse_type_annotation(string_expr) { + if let Ok(parsed_annotation) = checker.parse_type_annotation(string_expr) { let Some(expr) = type_hint_explicitly_allows_none( parsed_annotation.expression(), checker, - checker.settings.target_version.minor(), + checker.target_version(), ) else { continue; }; - let conversion_type = checker.settings.target_version.into(); + let conversion_type = checker.target_version().into(); let mut diagnostic = Diagnostic::new(ImplicitOptional { conversion_type }, expr.range()); if parsed_annotation.kind().is_simple() { diagnostic.try_set_fix(|| generate_fix(checker, conversion_type, expr)); } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } else { // Unquoted annotation. - let Some(expr) = type_hint_explicitly_allows_none( - annotation, - checker, - checker.settings.target_version.minor(), - ) else { + let Some(expr) = + type_hint_explicitly_allows_none(annotation, checker, checker.target_version()) + else { continue; }; - let conversion_type = checker.settings.target_version.into(); + let conversion_type = checker.target_version().into(); let mut diagnostic = Diagnostic::new(ImplicitOptional { conversion_type }, expr.range()); diagnostic.try_set_fix(|| generate_fix(checker, conversion_type, expr)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/in_empty_collection.rs b/crates/ruff_linter/src/rules/ruff/rules/in_empty_collection.rs new file mode 100644 index 0000000000000..1fe9f7675cb51 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/in_empty_collection.rs @@ -0,0 +1,102 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, CmpOp, Expr}; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for membership tests on empty collections (such as `list`, `tuple`, `set` or `dict`). +/// +/// ## Why is this bad? +/// If the collection is always empty, the check is unnecessary, and can be removed. +/// +/// ## Example +/// +/// ```python +/// if 1 not in set(): +/// print("got it!") +/// ``` +/// +/// Use instead: +/// +/// ```python +/// print("got it!") +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct InEmptyCollection; + +impl Violation for InEmptyCollection { + #[derive_message_formats] + fn message(&self) -> String { + "Unnecessary membership test on empty collection".to_string() + } +} + +/// RUF060 +pub(crate) fn in_empty_collection(checker: &Checker, compare: &ast::ExprCompare) { + let [op] = &*compare.ops else { + return; + }; + + if !matches!(op, CmpOp::In | CmpOp::NotIn) { + return; + } + + let [right] = &*compare.comparators else { + return; + }; + + let semantic = checker.semantic(); + + if is_empty(right, semantic) { + checker.report_diagnostic(Diagnostic::new(InEmptyCollection, compare.range())); + } +} + +fn is_empty(expr: &Expr, semantic: &SemanticModel) -> bool { + let set_methods = ["set", "frozenset"]; + let collection_methods = [ + "list", + "tuple", + "set", + "frozenset", + "dict", + "bytes", + "bytearray", + "str", + ]; + + match expr { + Expr::List(ast::ExprList { elts, .. }) => elts.is_empty(), + Expr::Tuple(ast::ExprTuple { elts, .. }) => elts.is_empty(), + Expr::Set(ast::ExprSet { elts, .. }) => elts.is_empty(), + Expr::Dict(ast::ExprDict { items, .. }) => items.is_empty(), + Expr::BytesLiteral(ast::ExprBytesLiteral { value, .. }) => value.is_empty(), + Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => value.is_empty(), + Expr::FString(s) => s + .value + .elements() + .all(|elt| elt.as_literal().is_some_and(|elt| elt.is_empty())), + Expr::Call(ast::ExprCall { + func, + arguments, + range: _, + }) => { + if arguments.is_empty() { + collection_methods + .iter() + .any(|s| semantic.match_builtin_expr(func, s)) + } else if let Some(arg) = arguments.find_positional(0) { + set_methods + .iter() + .any(|s| semantic.match_builtin_expr(func, s)) + && is_empty(arg, semantic) + } else { + false + } + } + _ => false, + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_subscript.rs b/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_subscript.rs index a0b7b0552ef56..44956550d2dd5 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_subscript.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_subscript.rs @@ -1,9 +1,9 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{Expr, ExprSubscript}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprSubscript, PythonVersion}; use ruff_text_size::Ranged; -use crate::{checkers::ast::Checker, settings::types::PythonVersion}; +use crate::checkers::ast::Checker; /// ## What it does /// Checks for consistent style regarding whether nonempty tuples in subscripts @@ -34,9 +34,11 @@ use crate::{checkers::ast::Checker, settings::types::PythonVersion}; /// directions = {(0, 1): "North", (1, 0): "East", (0, -1): "South", (-1, 0): "West"} /// directions[0, 1] /// ``` - -#[violation] -pub struct IncorrectlyParenthesizedTupleInSubscript { +/// +/// ## Options +/// - `lint.ruff.parenthesize-tuple-in-subscript` +#[derive(ViolationMetadata)] +pub(crate) struct IncorrectlyParenthesizedTupleInSubscript { prefer_parentheses: bool, } @@ -44,23 +46,23 @@ impl AlwaysFixableViolation for IncorrectlyParenthesizedTupleInSubscript { #[derive_message_formats] fn message(&self) -> String { if self.prefer_parentheses { - format!("Use parentheses for tuples in subscripts.") + "Use parentheses for tuples in subscripts".to_string() } else { - format!("Avoid parentheses for tuples in subscripts.") + "Avoid parentheses for tuples in subscripts".to_string() } } fn fix_title(&self) -> String { if self.prefer_parentheses { - "Parenthesize the tuple.".to_string() + "Parenthesize tuple".to_string() } else { - "Remove the parentheses.".to_string() + "Remove parentheses".to_string() } } } /// RUF031 -pub(crate) fn subscript_with_parenthesized_tuple(checker: &mut Checker, subscript: &ExprSubscript) { +pub(crate) fn subscript_with_parenthesized_tuple(checker: &Checker, subscript: &ExprSubscript) { let prefer_parentheses = checker.settings.ruff.parenthesize_tuple_in_subscript; let Expr::Tuple(tuple_subscript) = &*subscript.slice else { @@ -71,6 +73,12 @@ pub(crate) fn subscript_with_parenthesized_tuple(checker: &mut Checker, subscrip return; } + // We should not handle single starred expressions + // (regardless of `prefer_parentheses`) + if matches!(&tuple_subscript.elts[..], &[Expr::Starred(_)]) { + return; + } + // Adding parentheses in the presence of a slice leads to a syntax error. if prefer_parentheses && tuple_subscript.iter().any(Expr::is_slice_expr) { return; @@ -80,7 +88,7 @@ pub(crate) fn subscript_with_parenthesized_tuple(checker: &mut Checker, subscrip // to a syntax error in Python 3.10. // This is no longer a syntax error starting in Python 3.11 // see https://peps.python.org/pep-0646/#change-1-star-expressions-in-indexes - if checker.settings.target_version <= PythonVersion::Py310 + if checker.target_version() <= PythonVersion::PY310 && !prefer_parentheses && tuple_subscript.iter().any(Expr::is_starred_expr) { @@ -103,7 +111,7 @@ pub(crate) fn subscript_with_parenthesized_tuple(checker: &mut Checker, subscrip }; let edit = Edit::range_replacement(new_source, source_range); - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new( IncorrectlyParenthesizedTupleInSubscript { prefer_parentheses }, source_range, diff --git a/crates/ruff_linter/src/rules/ruff/rules/indented_form_feed.rs b/crates/ruff_linter/src/rules/ruff/rules/indented_form_feed.rs new file mode 100644 index 0000000000000..66f0c7d1c07b6 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/indented_form_feed.rs @@ -0,0 +1,71 @@ +use memchr::memchr; + +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_source_file::Line; +use ruff_text_size::{TextRange, TextSize}; + +/// ## What it does +/// Checks for form feed characters preceded by either a space or a tab. +/// +/// ## Why is this bad? +/// [The language reference][lexical-analysis-indentation] states: +/// +/// > A formfeed character may be present at the start of the line; +/// > it will be ignored for the indentation calculations above. +/// > Formfeed characters occurring elsewhere in the leading whitespace +/// > have an undefined effect (for instance, they may reset the space count to zero). +/// +/// ## Example +/// +/// ```python +/// if foo():\n \fbar() +/// ``` +/// +/// Use instead: +/// +/// ```python +/// if foo():\n bar() +/// ``` +/// +/// [lexical-analysis-indentation]: https://docs.python.org/3/reference/lexical_analysis.html#indentation +#[derive(ViolationMetadata)] +pub(crate) struct IndentedFormFeed; + +impl Violation for IndentedFormFeed { + #[derive_message_formats] + fn message(&self) -> String { + "Indented form feed".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Remove form feed".to_string()) + } +} + +const FORM_FEED: u8 = b'\x0c'; +const SPACE: u8 = b' '; +const TAB: u8 = b'\t'; + +/// RUF054 +pub(crate) fn indented_form_feed(line: &Line) -> Option<Diagnostic> { + let index_relative_to_line = memchr(FORM_FEED, line.as_bytes())?; + + if index_relative_to_line == 0 { + return None; + } + + if line[..index_relative_to_line] + .as_bytes() + .iter() + .any(|byte| *byte != SPACE && *byte != TAB) + { + return None; + } + + let relative_index = u32::try_from(index_relative_to_line).ok()?; + let absolute_index = line.start() + TextSize::new(relative_index); + let range = TextRange::at(absolute_index, 1.into()); + + Some(Diagnostic::new(IndentedFormFeed, range)) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_assert_message_literal_argument.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_assert_message_literal_argument.rs new file mode 100644 index 0000000000000..b7d74d1258081 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_assert_message_literal_argument.rs @@ -0,0 +1,59 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, StmtAssert}; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for invalid use of literals in assert message arguments. +/// +/// ## Why is this bad? +/// An assert message which is a non-string literal was likely intended +/// to be used in a comparison assertion, rather than as a message. +/// +/// ## Example +/// ```python +/// fruits = ["apples", "plums", "pears"] +/// fruits.filter(lambda fruit: fruit.startwith("p")) +/// assert len(fruits), 2 # True unless the list is empty +/// ``` +/// +/// Use instead: +/// ```python +/// fruits = ["apples", "plums", "pears"] +/// fruits.filter(lambda fruit: fruit.startwith("p")) +/// assert len(fruits) == 2 +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct InvalidAssertMessageLiteralArgument; + +impl Violation for InvalidAssertMessageLiteralArgument { + #[derive_message_formats] + fn message(&self) -> String { + "Non-string literal used as assert message".to_string() + } +} + +/// RUF040 +pub(crate) fn invalid_assert_message_literal_argument(checker: &Checker, stmt: &StmtAssert) { + let Some(message) = stmt.msg.as_deref() else { + return; + }; + + if !matches!( + message, + Expr::NumberLiteral(_) + | Expr::BooleanLiteral(_) + | Expr::NoneLiteral(_) + | Expr::EllipsisLiteral(_) + | Expr::BytesLiteral(_) + ) { + return; + } + + checker.report_diagnostic(Diagnostic::new( + InvalidAssertMessageLiteralArgument, + message.range(), + )); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_formatter_suppression_comment.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_formatter_suppression_comment.rs index a8f525869533a..0e1bbd329a0b4 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/invalid_formatter_suppression_comment.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_formatter_suppression_comment.rs @@ -4,14 +4,14 @@ use smallvec::SmallVec; use ast::{StmtClassDef, StmtFunctionDef}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, helpers::comment_indentation_after, AnyNodeRef}; -use ruff_python_trivia::{indentation_at_offset, SuppressionKind}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, AnyNodeRef, helpers::comment_indentation_after}; +use ruff_python_trivia::{SuppressionKind, indentation_at_offset}; use ruff_text_size::{Ranged, TextLen, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::fix::edits::delete_comment; -use crate::Locator; use super::suppression_comment_visitor::{ CaptureSuppressionComment, SuppressionComment, SuppressionCommentData, @@ -26,7 +26,7 @@ use super::suppression_comment_visitor::{ /// Suppression comments that do not actually prevent formatting could cause unintended changes /// when the formatter is run. /// -/// ## Examples +/// ## Example /// In the following example, all suppression comments would cause /// a rule violation. /// @@ -49,8 +49,14 @@ use super::suppression_comment_visitor::{ /// # fmt: on /// # yapf: enable /// ``` -#[violation] -pub struct InvalidFormatterSuppressionComment { +/// +/// ## Fix safety +/// +/// This fix is always marked as unsafe because it deletes the invalid suppression comment, +/// rather than trying to move it to a valid position, which the user more likely intended. +/// +#[derive(ViolationMetadata)] +pub(crate) struct InvalidFormatterSuppressionComment { reason: IgnoredReason, } @@ -64,12 +70,12 @@ impl AlwaysFixableViolation for InvalidFormatterSuppressionComment { } fn fix_title(&self) -> String { - format!("Remove this comment") + "Remove this comment".to_string() } } /// RUF028 -pub(crate) fn ignored_formatter_suppression_comment(checker: &mut Checker, suite: &ast::Suite) { +pub(crate) fn ignored_formatter_suppression_comment(checker: &Checker, suite: &ast::Suite) { let locator = checker.locator(); let comment_ranges: SmallVec<[SuppressionComment; 8]> = checker .comment_ranges() @@ -99,7 +105,7 @@ pub(crate) fn ignored_formatter_suppression_comment(checker: &mut Checker, suite comments.sort(); for (range, reason) in comments.ignored_comments() { - checker.diagnostics.push( + checker.report_diagnostic( Diagnostic::new(InvalidFormatterSuppressionComment { reason }, range) .with_fix(Fix::unsafe_edit(delete_comment(range, checker.locator()))), ); @@ -203,7 +209,7 @@ impl<'src, 'loc> UselessSuppressionComments<'src, 'loc> { } } -impl<'src, 'loc> CaptureSuppressionComment<'src> for UselessSuppressionComments<'src, 'loc> { +impl<'src> CaptureSuppressionComment<'src> for UselessSuppressionComments<'src, '_> { fn capture(&mut self, comment: SuppressionCommentData<'src>) { match self.check_suppression_comment(&comment) { Ok(()) => {} @@ -278,6 +284,7 @@ const fn is_valid_enclosing_node(node: AnyNodeRef) -> bool { | AnyNodeRef::StmtIpyEscapeCommand(_) | AnyNodeRef::ExceptHandlerExceptHandler(_) | AnyNodeRef::MatchCase(_) + | AnyNodeRef::Decorator(_) | AnyNodeRef::ElifElseClause(_) => true, AnyNodeRef::ExprBoolOp(_) @@ -333,7 +340,6 @@ const fn is_valid_enclosing_node(node: AnyNodeRef) -> bool { | AnyNodeRef::Keyword(_) | AnyNodeRef::Alias(_) | AnyNodeRef::WithItem(_) - | AnyNodeRef::Decorator(_) | AnyNodeRef::TypeParams(_) | AnyNodeRef::TypeParamTypeVar(_) | AnyNodeRef::TypeParamTypeVarTuple(_) diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_index_type.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_index_type.rs index 707a3b9db7c84..0118b35a91e32 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/invalid_index_type.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_index_type.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{Expr, ExprNumberLiteral, ExprSlice, ExprSubscript, Number}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use std::fmt; @@ -25,8 +25,8 @@ use crate::checkers::ast::Checker; /// ```python /// var = [1, 2, 3][0] /// ``` -#[violation] -pub struct InvalidIndexType { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidIndexType { value_type: String, index_type: String, is_slice: bool, @@ -41,7 +41,9 @@ impl Violation for InvalidIndexType { is_slice, } = self; if *is_slice { - format!("Slice in indexed access to type `{value_type}` uses type `{index_type}` instead of an integer") + format!( + "Slice in indexed access to type `{value_type}` uses type `{index_type}` instead of an integer" + ) } else { format!( "Indexed access to type `{value_type}` uses type `{index_type}` instead of an integer or slice" @@ -51,7 +53,7 @@ impl Violation for InvalidIndexType { } /// RUF016 -pub(crate) fn invalid_index_type(checker: &mut Checker, expr: &ExprSubscript) { +pub(crate) fn invalid_index_type(checker: &Checker, expr: &ExprSubscript) { let ExprSubscript { value, slice: index, @@ -88,7 +90,7 @@ pub(crate) fn invalid_index_type(checker: &mut Checker, expr: &ExprSubscript) { if index_type.is_literal() { // If the index is a literal, require an integer if index_type != CheckableExprType::IntLiteral { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidIndexType { value_type: value_type.to_string(), index_type: index_type.to_string(), @@ -111,7 +113,7 @@ pub(crate) fn invalid_index_type(checker: &mut Checker, expr: &ExprSubscript) { is_slice_type, CheckableExprType::IntLiteral | CheckableExprType::NoneLiteral ) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidIndexType { value_type: value_type.to_string(), index_type: is_slice_type.to_string(), @@ -121,7 +123,7 @@ pub(crate) fn invalid_index_type(checker: &mut Checker, expr: &ExprSubscript) { )); } } else if let Some(is_slice_type) = CheckableExprType::try_from(is_slice.as_ref()) { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidIndexType { value_type: value_type.to_string(), index_type: is_slice_type.to_string(), @@ -133,7 +135,7 @@ pub(crate) fn invalid_index_type(checker: &mut Checker, expr: &ExprSubscript) { } } else { // If it's some other checkable data type, it's a violation - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( InvalidIndexType { value_type: value_type.to_string(), index_type: index_type.to_string(), diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs index 8d34ea57481d9..875114df4dcb4 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## What it does /// Checks for any pyproject.toml that does not conform to the schema from the relevant PEPs. @@ -21,8 +21,7 @@ use ruff_macros::{derive_message_formats, violation}; /// name = "crab" /// version = "1.0.0" /// authors = [ -/// { email = "ferris@example.org" }, -/// { name = "Ferris the Crab"} +/// { name = "Ferris the Crab", email = "ferris@example.org" } /// ] /// ``` /// @@ -30,8 +29,8 @@ use ruff_macros::{derive_message_formats, violation}; /// - [Specification of `[project]` in pyproject.toml](https://packaging.python.org/en/latest/specifications/declaring-project-metadata/) /// - [Specification of `[build-system]` in pyproject.toml](https://peps.python.org/pep-0518/) /// - [Draft but implemented license declaration extensions](https://peps.python.org/pep-0639) -#[violation] -pub struct InvalidPyprojectToml { +#[derive(ViolationMetadata)] +pub(crate) struct InvalidPyprojectToml { pub message: String, } diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_rule_code.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_rule_code.rs new file mode 100644 index 0000000000000..fa9de17d412ef --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_rule_code.rs @@ -0,0 +1,160 @@ +use crate::Locator; +use crate::noqa::{Code, Directive}; +use crate::registry::Rule; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; + +use crate::noqa::{Codes, NoqaDirectives}; + +/// ## What it does +/// Checks for `noqa` codes that are invalid. +/// +/// ## Why is this bad? +/// Invalid rule codes serve no purpose and may indicate outdated code suppressions. +/// +/// ## Example +/// ```python +/// import os # noqa: XYZ999 +/// ``` +/// +/// Use instead: +/// ```python +/// import os +/// ``` +/// +/// Or if there are still valid codes needed: +/// ```python +/// import os # noqa: E402 +/// ``` +/// +/// ## Options +/// - `lint.external` +#[derive(ViolationMetadata)] +pub(crate) struct InvalidRuleCode { + pub(crate) rule_code: String, +} + +impl AlwaysFixableViolation for InvalidRuleCode { + #[derive_message_formats] + fn message(&self) -> String { + format!("Invalid rule code in `# noqa`: {}", self.rule_code) + } + + fn fix_title(&self) -> String { + "Remove the rule code".to_string() + } +} + +/// RUF102 for invalid noqa codes +pub(crate) fn invalid_noqa_code( + diagnostics: &mut Vec<Diagnostic>, + noqa_directives: &NoqaDirectives, + locator: &Locator, + external: &[String], +) { + for line in noqa_directives.lines() { + let Directive::Codes(directive) = &line.directive else { + continue; + }; + + let all_valid = directive.iter().all(|code| code_is_valid(code, external)); + + if all_valid { + continue; + } + + let (valid_codes, invalid_codes): (Vec<_>, Vec<_>) = directive + .iter() + .partition(|&code| code_is_valid(code, external)); + + if valid_codes.is_empty() { + diagnostics.push(all_codes_invalid_diagnostic(directive, invalid_codes)); + } else { + diagnostics.extend(invalid_codes.into_iter().map(|invalid_code| { + some_codes_are_invalid_diagnostic(directive, invalid_code, locator) + })); + } + } +} + +fn code_is_valid(code: &Code, external: &[String]) -> bool { + let code_str = code.as_str(); + Rule::from_code(code_str).is_ok() || external.iter().any(|ext| code_str.starts_with(ext)) +} + +fn all_codes_invalid_diagnostic( + directive: &Codes<'_>, + invalid_codes: Vec<&Code<'_>>, +) -> Diagnostic { + Diagnostic::new( + InvalidRuleCode { + rule_code: invalid_codes + .into_iter() + .map(Code::as_str) + .collect::<Vec<_>>() + .join(", "), + }, + directive.range(), + ) + .with_fix(Fix::safe_edit(Edit::range_deletion(directive.range()))) +} + +fn some_codes_are_invalid_diagnostic( + codes: &Codes, + invalid_code: &Code, + locator: &Locator, +) -> Diagnostic { + let diagnostic = Diagnostic::new( + InvalidRuleCode { + rule_code: invalid_code.to_string(), + }, + invalid_code.range(), + ); + diagnostic.with_fix(Fix::safe_edit(remove_invalid_noqa( + codes, + invalid_code, + locator, + ))) +} + +fn remove_invalid_noqa(codes: &Codes, invalid_code: &Code, locator: &Locator) -> Edit { + // Is this the first code after the `:` that needs to get deleted + // For the first element, delete from after the `:` to the next comma (including) + // For any other element, delete from the previous comma (including) to the next comma (excluding) + let mut first = false; + + // Find the index of the previous comma or colon. + let start = locator + .slice(TextRange::new(codes.start(), invalid_code.start())) + .rmatch_indices([',', ':']) + .next() + .map(|(offset, text)| { + let offset = codes.start() + TextSize::try_from(offset).unwrap(); + if text == ":" { + first = true; + // Don't include the colon in the deletion range, or the noqa comment becomes invalid + offset + ':'.text_len() + } else { + offset + } + }) + .unwrap_or(invalid_code.start()); + + // Find the index of the trailing comma (if any) + let end = locator + .slice(TextRange::new(invalid_code.end(), codes.end())) + .find(',') + .map(|offset| { + let offset = invalid_code.end() + TextSize::try_from(offset).unwrap(); + + if first { + offset + ','.text_len() + } else { + offset + } + }) + .unwrap_or(invalid_code.end()); + + Edit::range_deletion(TextRange::new(start, end)) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/map_int_version_parsing.rs b/crates/ruff_linter/src/rules/ruff/rules/map_int_version_parsing.rs new file mode 100644 index 0000000000000..7fd0e9e69d656 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/map_int_version_parsing.rs @@ -0,0 +1,140 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; +use ruff_python_semantic::SemanticModel; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for calls of the form `map(int, __version__.split("."))`. +/// +/// ## Why is this bad? +/// `__version__` does not always contain integral-like elements. +/// +/// ```python +/// import matplotlib # `__version__ == "3.9.1.post-1"` in our environment +/// +/// # ValueError: invalid literal for int() with base 10: 'post1' +/// tuple(map(int, matplotlib.__version__.split("."))) +/// ``` +/// +/// See also [*Version specifiers* | Packaging spec][version-specifier]. +/// +/// ## Example +/// ```python +/// tuple(map(int, matplotlib.__version__.split("."))) +/// ``` +/// +/// Use instead: +/// ```python +/// import packaging.version as version +/// +/// version.parse(matplotlib.__version__) +/// ``` +/// +/// [version-specifier]: https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers +#[derive(ViolationMetadata)] +pub(crate) struct MapIntVersionParsing; + +impl Violation for MapIntVersionParsing { + #[derive_message_formats] + fn message(&self) -> String { + "`__version__` may contain non-integral-like elements".to_string() + } +} + +/// RUF048 +pub(crate) fn map_int_version_parsing(checker: &Checker, call: &ast::ExprCall) { + let semantic = checker.semantic(); + + let Some((first, second)) = map_call_with_two_arguments(semantic, call) else { + return; + }; + + if is_dunder_version_split_dot(second) && semantic.match_builtin_expr(first, "int") { + checker.report_diagnostic(Diagnostic::new(MapIntVersionParsing, call.range())); + } +} + +fn map_call_with_two_arguments<'a>( + semantic: &SemanticModel, + call: &'a ast::ExprCall, +) -> Option<(&'a ast::Expr, &'a ast::Expr)> { + let ast::ExprCall { + func, + arguments: + ast::Arguments { + args, + keywords, + range: _, + }, + range: _, + } = call; + + if !keywords.is_empty() { + return None; + } + + let [first, second] = &**args else { + return None; + }; + + if !semantic.match_builtin_expr(func, "map") { + return None; + } + + Some((first, second)) +} + +/// Whether `expr` has the form `__version__.split(".")` or `something.__version__.split(".")`. +fn is_dunder_version_split_dot(expr: &ast::Expr) -> bool { + let ast::Expr::Call(ast::ExprCall { + func, arguments, .. + }) = expr + else { + return false; + }; + + if arguments.len() != 1 { + return false; + } + + let Some(ast::Expr::StringLiteral(ast::ExprStringLiteral { value, range: _ })) = + arguments.find_argument_value("sep", 0) + else { + return false; + }; + + if value.to_str() != "." { + return false; + } + + is_dunder_version_split(func) +} + +fn is_dunder_version_split(func: &ast::Expr) -> bool { + // foo.__version__.split(".") + // ---- value ---- ^^^^^ attr + let ast::Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = func else { + return false; + }; + if attr != "split" { + return false; + } + is_dunder_version(value) +} + +fn is_dunder_version(expr: &ast::Expr) -> bool { + if let ast::Expr::Name(ast::ExprName { id, .. }) = expr { + return id == "__version__"; + } + + // foo.__version__.split(".") + // ^^^^^^^^^^^ attr + let ast::Expr::Attribute(ast::ExprAttribute { attr, .. }) = expr else { + return false; + }; + + attr == "__version__" +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/missing_fstring_syntax.rs b/crates/ruff_linter/src/rules/ruff/rules/missing_fstring_syntax.rs index 8025fd829244c..98f54229b1201 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/missing_fstring_syntax.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/missing_fstring_syntax.rs @@ -2,17 +2,17 @@ use memchr::memchr2_iter; use rustc_hash::FxHashSet; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_literal::format::FormatSpec; use ruff_python_parser::parse_expression; use ruff_python_semantic::analyze::logging::is_logger_candidate; -use ruff_python_semantic::{Modules, SemanticModel}; +use ruff_python_semantic::{Modules, SemanticModel, TypingOnlyBindingsStatus}; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::fastapi::rules::is_fastapi_route_call; -use crate::Locator; /// ## What it does /// Searches for strings that look like they were meant to be f-strings, but are missing an `f` prefix. @@ -35,7 +35,8 @@ use crate::Locator; /// 5. The string references variables that are not in scope, or it doesn't capture variables at all. /// 6. Any format specifiers in the potential f-string are invalid. /// 7. The string is part of a function call that is known to expect a template string rather than an -/// evaluated f-string: for example, a [`logging`] call, a [`gettext`] call, or a [fastAPI path]. +/// evaluated f-string: for example, a [`logging`][logging] call, a [`gettext`][gettext] call, +/// or a [FastAPI path]. /// /// ## Example /// @@ -52,16 +53,21 @@ use crate::Locator; /// print(f"Hello {name}! It is {day_of_week} today!") /// ``` /// +/// ## Fix safety +/// +/// This fix will always change the behavior of the program and, despite the precautions detailed +/// above, this may be undesired. As such the fix is always marked as unsafe. +/// /// [logging]: https://docs.python.org/3/howto/logging-cookbook.html#using-particular-formatting-styles-throughout-your-application /// [gettext]: https://docs.python.org/3/library/gettext.html -/// [fastAPI path]: https://fastapi.tiangolo.com/tutorial/path-params/ -#[violation] -pub struct MissingFStringSyntax; +/// [FastAPI path]: https://fastapi.tiangolo.com/tutorial/path-params/ +#[derive(ViolationMetadata)] +pub(crate) struct MissingFStringSyntax; impl AlwaysFixableViolation for MissingFStringSyntax { #[derive_message_formats] fn message(&self) -> String { - format!(r"Possible f-string without an `f` prefix") + r"Possible f-string without an `f` prefix".to_string() } fn fix_title(&self) -> String { @@ -70,9 +76,14 @@ impl AlwaysFixableViolation for MissingFStringSyntax { } /// RUF027 -pub(crate) fn missing_fstring_syntax(checker: &mut Checker, literal: &ast::StringLiteral) { +pub(crate) fn missing_fstring_syntax(checker: &Checker, literal: &ast::StringLiteral) { let semantic = checker.semantic(); + // fstrings are never correct as type definitions + if semantic.in_type_definition() { + return; + } + // we want to avoid statement expressions that are just a string literal. // there's no reason to have standalone f-strings and this lets us avoid docstrings too if let ast::Stmt::Expr(ast::StmtExpr { value, .. }) = semantic.current_statement() { @@ -107,7 +118,7 @@ pub(crate) fn missing_fstring_syntax(checker: &mut Checker, literal: &ast::Strin if should_be_fstring(literal, checker.locator(), semantic) { let diagnostic = Diagnostic::new(MissingFStringSyntax, literal.range()) .with_fix(fix_fstring_syntax(literal.range())); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } @@ -209,8 +220,16 @@ fn should_be_fstring( return false; } if semantic - .lookup_symbol(id) - .map_or(true, |id| semantic.binding(id).kind.is_builtin()) + // the parsed expression nodes have incorrect ranges + // so we need to use the range of the literal for the + // lookup in order to get reasonable results. + .simulate_runtime_load_at_location_in_scope( + id, + literal.range(), + semantic.scope_id, + TypingOnlyBindingsStatus::Disallowed, + ) + .is_none_or(|id| semantic.binding(id).kind.is_builtin()) { return false; } diff --git a/crates/ruff_linter/src/rules/ruff/rules/mod.rs b/crates/ruff_linter/src/rules/ruff/rules/mod.rs index 49b40b0b7900d..4706c713c6e91 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/mod.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/mod.rs @@ -2,33 +2,58 @@ pub(crate) use ambiguous_unicode_character::*; pub(crate) use assert_with_print_message::*; pub(crate) use assignment_in_assert::*; pub(crate) use asyncio_dangling_task::*; +pub(crate) use class_with_mixed_type_vars::*; pub(crate) use collection_literal_concatenation::*; +pub(crate) use dataclass_enum::*; pub(crate) use decimal_from_float_literal::*; pub(crate) use default_factory_kwarg::*; pub(crate) use explicit_f_string_type_conversion::*; +pub(crate) use falsy_dict_get_fallback::*; pub(crate) use function_call_in_dataclass_default::*; +pub(crate) use if_key_in_dict_del::*; +pub(crate) use implicit_classvar_in_dataclass::*; pub(crate) use implicit_optional::*; +pub(crate) use in_empty_collection::*; pub(crate) use incorrectly_parenthesized_tuple_in_subscript::*; +pub(crate) use indented_form_feed::*; +pub(crate) use invalid_assert_message_literal_argument::*; pub(crate) use invalid_formatter_suppression_comment::*; pub(crate) use invalid_index_type::*; pub(crate) use invalid_pyproject_toml::*; +pub(crate) use invalid_rule_code::*; +pub(crate) use map_int_version_parsing::*; pub(crate) use missing_fstring_syntax::*; pub(crate) use mutable_class_default::*; pub(crate) use mutable_dataclass_default::*; pub(crate) use mutable_fromkeys_value::*; +pub(crate) use needless_else::*; pub(crate) use never_union::*; -pub(crate) use parenthesize_logical_operators::*; +pub(crate) use none_not_at_end_of_union::*; +pub(crate) use parenthesize_chained_operators::*; +pub(crate) use post_init_default::*; +pub(crate) use pytest_raises_ambiguous_pattern::*; pub(crate) use quadratic_list_summation::*; pub(crate) use redirected_noqa::*; +pub(crate) use redundant_bool_literal::*; pub(crate) use sort_dunder_all::*; pub(crate) use sort_dunder_slots::*; +pub(crate) use starmap_zip::*; pub(crate) use static_key_dict_comprehension::*; #[cfg(any(feature = "test-rules", test))] pub(crate) use test_rules::*; +pub(crate) use unnecessary_cast_to_int::*; pub(crate) use unnecessary_iterable_allocation_for_first_element::*; pub(crate) use unnecessary_key_check::*; +pub(crate) use unnecessary_literal_within_deque_call::*; +pub(crate) use unnecessary_nested_literal::*; +pub(crate) use unnecessary_regular_expression::*; +pub(crate) use unnecessary_round::*; +pub(crate) use unraw_re_pattern::*; +pub(crate) use unsafe_markup_use::*; pub(crate) use unused_async::*; pub(crate) use unused_noqa::*; +pub(crate) use unused_unpacked_variable::*; +pub(crate) use used_dummy_variable::*; pub(crate) use useless_if_else::*; pub(crate) use zip_instead_of_pairwise::*; @@ -36,37 +61,62 @@ mod ambiguous_unicode_character; mod assert_with_print_message; mod assignment_in_assert; mod asyncio_dangling_task; +mod class_with_mixed_type_vars; mod collection_literal_concatenation; mod confusables; +mod dataclass_enum; mod decimal_from_float_literal; mod default_factory_kwarg; mod explicit_f_string_type_conversion; +mod falsy_dict_get_fallback; mod function_call_in_dataclass_default; mod helpers; +mod if_key_in_dict_del; +mod implicit_classvar_in_dataclass; mod implicit_optional; +mod in_empty_collection; mod incorrectly_parenthesized_tuple_in_subscript; +mod indented_form_feed; +mod invalid_assert_message_literal_argument; mod invalid_formatter_suppression_comment; mod invalid_index_type; mod invalid_pyproject_toml; +mod invalid_rule_code; +mod map_int_version_parsing; mod missing_fstring_syntax; mod mutable_class_default; mod mutable_dataclass_default; mod mutable_fromkeys_value; +mod needless_else; mod never_union; -mod parenthesize_logical_operators; +mod none_not_at_end_of_union; +mod parenthesize_chained_operators; +mod post_init_default; +mod pytest_raises_ambiguous_pattern; mod quadratic_list_summation; mod redirected_noqa; +mod redundant_bool_literal; mod sequence_sorting; mod sort_dunder_all; mod sort_dunder_slots; +mod starmap_zip; mod static_key_dict_comprehension; mod suppression_comment_visitor; #[cfg(any(feature = "test-rules", test))] pub(crate) mod test_rules; +mod unnecessary_cast_to_int; mod unnecessary_iterable_allocation_for_first_element; mod unnecessary_key_check; +mod unnecessary_literal_within_deque_call; +mod unnecessary_nested_literal; +mod unnecessary_regular_expression; +mod unnecessary_round; +mod unraw_re_pattern; +mod unsafe_markup_use; mod unused_async; mod unused_noqa; +mod unused_unpacked_variable; +mod used_dummy_variable; mod useless_if_else; mod zip_instead_of_pairwise; @@ -76,6 +126,3 @@ pub(crate) enum Context { Docstring, Comment, } -pub(crate) use post_init_default::*; - -mod post_init_default; diff --git a/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs b/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs index 776209d6f6812..d2350e50692f7 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs @@ -1,13 +1,13 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::typing::{is_immutable_annotation, is_mutable_expr}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; use crate::rules::ruff::rules::helpers::{ - has_default_copy_semantics, is_class_var_annotation, is_dataclass, is_final_annotation, + dataclass_kind, has_default_copy_semantics, is_class_var_annotation, is_final_annotation, is_special_attribute, }; @@ -20,38 +20,81 @@ use crate::rules::ruff::rules::helpers::{ /// changed in one instance, as those changes will unexpectedly affect all /// other instances. /// -/// When mutable values are intended, they should be annotated with -/// `typing.ClassVar`. When mutability is not required, values should be -/// immutable types, like `tuple` or `frozenset`. +/// Generally speaking, you probably want to avoid having mutable default +/// values in the class body at all; instead, these variables should usually +/// be initialized in `__init__`. However, other possible fixes for the issue +/// can include: +/// - Explicitly annotating the variable with [`typing.ClassVar`][ClassVar] to +/// indicate that it is intended to be shared across all instances. +/// - Using an immutable data type (e.g. a tuple instead of a list) +/// for the default value. +/// +/// ## Example /// -/// ## Examples /// ```python /// class A: -/// mutable_default: list[int] = [] -/// immutable_default: list[int] = [] +/// variable_1: list[int] = [] +/// variable_2: set[int] = set() +/// variable_3: dict[str, int] = {} /// ``` /// /// Use instead: +/// +/// ```python +/// class A: +/// def __init__(self) -> None: +/// self.variable_1: list[int] = [] +/// self.variable_2: set[int] = set() +/// self.variable_3: dict[str, int] = {} +/// ``` +/// +/// Or: +/// /// ```python /// from typing import ClassVar /// /// /// class A: -/// mutable_default: ClassVar[list[int]] = [] -/// immutable_default: tuple[int, ...] = () +/// variable_1: ClassVar[list[int]] = [] +/// variable_2: ClassVar[set[int]] = set() +/// variable_3: ClassVar[dict[str, int]] = {} +/// ``` +/// +/// Or: +/// +/// ```python +/// class A: +/// variable_1: list[int] | None = None +/// variable_2: set[int] | None = None +/// variable_3: dict[str, int] | None = None /// ``` -#[violation] -pub struct MutableClassDefault; +/// +/// Or: +/// +/// ```python +/// from collections.abc import Sequence, Mapping, Set as AbstractSet +/// from types import MappingProxyType +/// +/// +/// class A: +/// variable_1: Sequence[int] = () +/// variable_2: AbstractSet[int] = frozenset() +/// variable_3: Mapping[str, int] = MappingProxyType({}) +/// ``` +/// +/// [ClassVar]: https://docs.python.org/3/library/typing.html#typing.ClassVar +#[derive(ViolationMetadata)] +pub(crate) struct MutableClassDefault; impl Violation for MutableClassDefault { #[derive_message_formats] fn message(&self) -> String { - format!("Mutable class attributes should be annotated with `typing.ClassVar`") + "Mutable class attributes should be annotated with `typing.ClassVar`".to_string() } } /// RUF012 -pub(crate) fn mutable_class_default(checker: &mut Checker, class_def: &ast::StmtClassDef) { +pub(crate) fn mutable_class_default(checker: &Checker, class_def: &ast::StmtClassDef) { for statement in &class_def.body { match statement { Stmt::AnnAssign(ast::StmtAnnAssign { @@ -65,16 +108,17 @@ pub(crate) fn mutable_class_default(checker: &mut Checker, class_def: &ast::Stmt && !is_class_var_annotation(annotation, checker.semantic()) && !is_final_annotation(annotation, checker.semantic()) && !is_immutable_annotation(annotation, checker.semantic(), &[]) - && !is_dataclass(class_def, checker.semantic()) { + if dataclass_kind(class_def, checker.semantic()).is_some() { + continue; + } + // Avoid, e.g., Pydantic and msgspec models, which end up copying defaults on instance creation. if has_default_copy_semantics(class_def, checker.semantic()) { return; } - checker - .diagnostics - .push(Diagnostic::new(MutableClassDefault, value.range())); + checker.report_diagnostic(Diagnostic::new(MutableClassDefault, value.range())); } } Stmt::Assign(ast::StmtAssign { value, targets, .. }) => { @@ -86,9 +130,7 @@ pub(crate) fn mutable_class_default(checker: &mut Checker, class_def: &ast::Stmt return; } - checker - .diagnostics - .push(Diagnostic::new(MutableClassDefault, value.range())); + checker.report_diagnostic(Diagnostic::new(MutableClassDefault, value.range())); } } _ => (), diff --git a/crates/ruff_linter/src/rules/ruff/rules/mutable_dataclass_default.rs b/crates/ruff_linter/src/rules/ruff/rules/mutable_dataclass_default.rs index 9eebf896b523f..29676fc10fe07 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/mutable_dataclass_default.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/mutable_dataclass_default.rs @@ -1,12 +1,12 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_semantic::analyze::typing::{is_immutable_annotation, is_mutable_expr}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; -use crate::rules::ruff::rules::helpers::{is_class_var_annotation, is_dataclass}; +use crate::rules::ruff::rules::helpers::{dataclass_kind, is_class_var_annotation}; /// ## What it does /// Checks for mutable default values in dataclass attributes. @@ -22,7 +22,7 @@ use crate::rules::ruff::rules::helpers::{is_class_var_annotation, is_dataclass}; /// If the default value is intended to be mutable, it must be annotated with /// `typing.ClassVar`; otherwise, a `ValueError` will be raised. /// -/// ## Examples +/// ## Example /// ```python /// from dataclasses import dataclass /// @@ -54,37 +54,41 @@ use crate::rules::ruff::rules::helpers::{is_class_var_annotation, is_dataclass}; /// class A: /// mutable_default: ClassVar[list[int]] = [] /// ``` -#[violation] -pub struct MutableDataclassDefault; +#[derive(ViolationMetadata)] +pub(crate) struct MutableDataclassDefault; impl Violation for MutableDataclassDefault { #[derive_message_formats] fn message(&self) -> String { - format!("Do not use mutable default values for dataclass attributes") + "Do not use mutable default values for dataclass attributes".to_string() } } /// RUF008 -pub(crate) fn mutable_dataclass_default(checker: &mut Checker, class_def: &ast::StmtClassDef) { - if !is_dataclass(class_def, checker.semantic()) { +pub(crate) fn mutable_dataclass_default(checker: &Checker, class_def: &ast::StmtClassDef) { + let semantic = checker.semantic(); + + if dataclass_kind(class_def, semantic).is_none() { return; } for statement in &class_def.body { - if let Stmt::AnnAssign(ast::StmtAnnAssign { + let Stmt::AnnAssign(ast::StmtAnnAssign { annotation, value: Some(value), .. }) = statement + else { + continue; + }; + + if is_mutable_expr(value, checker.semantic()) + && !is_class_var_annotation(annotation, checker.semantic()) + && !is_immutable_annotation(annotation, checker.semantic(), &[]) { - if is_mutable_expr(value, checker.semantic()) - && !is_class_var_annotation(annotation, checker.semantic()) - && !is_immutable_annotation(annotation, checker.semantic(), &[]) - { - checker - .diagnostics - .push(Diagnostic::new(MutableDataclassDefault, value.range())); - } + let diagnostic = Diagnostic::new(MutableDataclassDefault, value.range()); + + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/mutable_fromkeys_value.rs b/crates/ruff_linter/src/rules/ruff/rules/mutable_fromkeys_value.rs index 2a06f9d993691..bd39425a6bfe3 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/mutable_fromkeys_value.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/mutable_fromkeys_value.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr}; use ruff_python_semantic::analyze::typing::is_mutable_expr; @@ -48,15 +48,15 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `dict.fromkeys`](https://docs.python.org/3/library/stdtypes.html#dict.fromkeys) -#[violation] -pub struct MutableFromkeysValue; +#[derive(ViolationMetadata)] +pub(crate) struct MutableFromkeysValue; impl Violation for MutableFromkeysValue { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Do not pass mutable objects as values to `dict.fromkeys`") + "Do not pass mutable objects as values to `dict.fromkeys`".to_string() } fn fix_title(&self) -> Option<String> { @@ -65,7 +65,7 @@ impl Violation for MutableFromkeysValue { } /// RUF024 -pub(crate) fn mutable_fromkeys_value(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn mutable_fromkeys_value(checker: &Checker, call: &ast::ExprCall) { let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = call.func.as_ref() else { return; }; @@ -92,7 +92,7 @@ pub(crate) fn mutable_fromkeys_value(checker: &mut Checker, call: &ast::ExprCall generate_dict_comprehension(keys, value, checker.generator()), call.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Format a code snippet to expression `{key: value for key in keys}`, where diff --git a/crates/ruff_linter/src/rules/ruff/rules/needless_else.rs b/crates/ruff_linter/src/rules/ruff/rules/needless_else.rs new file mode 100644 index 0000000000000..7b0b71e04e638 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/needless_else.rs @@ -0,0 +1,304 @@ +use std::cmp::Ordering; + +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::comment_indentation_after; +use ruff_python_ast::whitespace::indentation; +use ruff_python_ast::{Stmt, StmtExpr, StmtFor, StmtIf, StmtTry, StmtWhile}; +use ruff_python_parser::{TokenKind, Tokens}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for `else` clauses that only contains `pass` and `...` statements. +/// +/// ## Why is this bad? +/// Such an else clause does nothing and can be removed. +/// +/// ## Example +/// ```python +/// if foo: +/// bar() +/// else: +/// pass +/// ``` +/// +/// Use instead: +/// ```python +/// if foo: +/// bar() +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct NeedlessElse; + +impl AlwaysFixableViolation for NeedlessElse { + #[derive_message_formats] + fn message(&self) -> String { + "Empty `else` clause".to_string() + } + + fn fix_title(&self) -> String { + "Remove the `else` clause".to_string() + } +} + +/// RUF047 +pub(crate) fn needless_else(checker: &Checker, stmt: AnyNodeWithOrElse) { + let source = checker.source(); + let tokens = checker.tokens(); + + let else_body = stmt.else_body(); + + if !body_is_no_op(else_body) { + return; + } + + let Some(else_range) = stmt.else_range(tokens) else { + return; + }; + + if else_contains_comments(stmt, else_range, checker) { + return; + } + + let else_line_start = source.line_start(else_range.start()); + let else_full_end = source.full_line_end(else_range.end()); + let remove_range = TextRange::new(else_line_start, else_full_end); + + let edit = Edit::range_deletion(remove_range); + let fix = Fix::safe_edit(edit); + + let diagnostic = Diagnostic::new(NeedlessElse, else_range); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +/// Whether `body` contains only one `pass` or `...` statement. +fn body_is_no_op(body: &[Stmt]) -> bool { + match body { + [Stmt::Pass(_)] => true, + [Stmt::Expr(StmtExpr { value, .. })] => value.is_ellipsis_literal_expr(), + _ => false, + } +} + +fn else_contains_comments( + stmt: AnyNodeWithOrElse, + else_range: TextRange, + checker: &Checker, +) -> bool { + let else_full_end = checker.source().full_line_end(else_range.end()); + let commentable_range = TextRange::new(else_range.start(), else_full_end); + + // A comment after the `else` keyword or after the dummy statement. + // + // ```python + // if ...: + // ... + // else: # comment + // pass # comment + // ``` + if checker.comment_ranges().intersects(commentable_range) { + return true; + } + + let Some(preceding_stmt) = stmt.body_before_else().last() else { + return false; + }; + + let Some(else_last_stmt) = stmt.else_body().last() else { + return false; + }; + + else_branch_has_preceding_comment(preceding_stmt, else_range, checker) + || else_branch_has_trailing_comment(else_last_stmt, else_full_end, checker) +} + +/// Returns `true` if the `else` clause header has a leading own-line comment. +/// +/// ```python +/// if ...: +/// ... +/// # some comment +/// else: +/// pass +/// ``` +fn else_branch_has_preceding_comment( + preceding_stmt: &Stmt, + else_range: TextRange, + checker: &Checker, +) -> bool { + let (tokens, source) = (checker.tokens(), checker.source()); + + let before_else_full_end = source.full_line_end(preceding_stmt.end()); + + let preceding_indentation = indentation(source, &preceding_stmt) + .unwrap_or_default() + .text_len(); + + for token in tokens.in_range(TextRange::new(before_else_full_end, else_range.start())) { + if token.kind() != TokenKind::Comment { + continue; + } + + let comment_indentation = + comment_indentation_after(preceding_stmt.into(), token.range(), source); + + match comment_indentation.cmp(&preceding_indentation) { + // Comment belongs to preceding statement. + Ordering::Greater | Ordering::Equal => continue, + Ordering::Less => return true, + } + } + + false +} + +/// Returns `true` if the `else` branch has a trailing own line comment: +/// +/// ```python +/// if ...: +/// ... +/// else: +/// pass +/// # some comment +/// ``` +fn else_branch_has_trailing_comment( + last_else_stmt: &Stmt, + else_full_end: TextSize, + checker: &Checker, +) -> bool { + let (tokens, source) = (checker.tokens(), checker.source()); + + let preceding_indentation = indentation(source, &last_else_stmt) + .unwrap_or_default() + .text_len(); + + for token in tokens.after(else_full_end) { + match token.kind() { + TokenKind::Comment => { + let comment_indentation = + comment_indentation_after(last_else_stmt.into(), token.range(), source); + + match comment_indentation.cmp(&preceding_indentation) { + Ordering::Greater | Ordering::Equal => return true, + Ordering::Less => break, + } + } + + TokenKind::NonLogicalNewline + | TokenKind::Newline + | TokenKind::Indent + | TokenKind::Dedent => {} + + _ => break, + } + } + + false +} + +#[derive(Copy, Clone, Debug)] +pub(crate) enum AnyNodeWithOrElse<'a> { + While(&'a StmtWhile), + For(&'a StmtFor), + Try(&'a StmtTry), + If(&'a StmtIf), +} + +impl<'a> AnyNodeWithOrElse<'a> { + /// Returns the range from the `else` keyword to the last statement in its block. + fn else_range(self, tokens: &Tokens) -> Option<TextRange> { + match self { + Self::For(_) | Self::While(_) | Self::Try(_) => { + let before_else = self.body_before_else(); + + let else_body = self.else_body(); + let end = else_body.last()?.end(); + + let start = tokens + .in_range(TextRange::new(before_else.last()?.end(), end)) + .iter() + .find(|token| token.kind() == TokenKind::Else)? + .start(); + + Some(TextRange::new(start, end)) + } + + Self::If(StmtIf { + elif_else_clauses, .. + }) => elif_else_clauses + .last() + .filter(|clause| clause.test.is_none()) + .map(Ranged::range), + } + } + + /// Returns the suite before the else block. + fn body_before_else(self) -> &'a [Stmt] { + match self { + Self::Try(StmtTry { body, handlers, .. }) => handlers + .last() + .and_then(|handler| handler.as_except_handler()) + .map(|handler| &handler.body) + .unwrap_or(body), + + Self::While(StmtWhile { body, .. }) | Self::For(StmtFor { body, .. }) => body, + + Self::If(StmtIf { + body, + elif_else_clauses, + .. + }) => elif_else_clauses + .iter() + .rev() + .find(|clause| clause.test.is_some()) + .map(|clause| &*clause.body) + .unwrap_or(body), + } + } + + /// Returns the `else` suite. + /// Defaults to an empty suite if the statement has no `else` block. + fn else_body(self) -> &'a [Stmt] { + match self { + Self::While(StmtWhile { orelse, .. }) + | Self::For(StmtFor { orelse, .. }) + | Self::Try(StmtTry { orelse, .. }) => orelse, + + Self::If(StmtIf { + elif_else_clauses, .. + }) => elif_else_clauses + .last() + .filter(|clause| clause.test.is_none()) + .map(|clause| &*clause.body) + .unwrap_or_default(), + } + } +} + +impl<'a> From<&'a StmtFor> for AnyNodeWithOrElse<'a> { + fn from(value: &'a StmtFor) -> Self { + Self::For(value) + } +} + +impl<'a> From<&'a StmtWhile> for AnyNodeWithOrElse<'a> { + fn from(value: &'a StmtWhile) -> Self { + Self::While(value) + } +} + +impl<'a> From<&'a StmtIf> for AnyNodeWithOrElse<'a> { + fn from(value: &'a StmtIf) -> Self { + Self::If(value) + } +} + +impl<'a> From<&'a StmtTry> for AnyNodeWithOrElse<'a> { + fn from(value: &'a StmtTry) -> Self { + Self::Try(value) + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/never_union.rs b/crates/ruff_linter/src/rules/ruff/rules/never_union.rs index 53b2641bb5b41..57cdcf0763b61 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/never_union.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/never_union.rs @@ -1,6 +1,7 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::{self as ast, Expr, Operator}; +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr, ExprBinOp, Operator}; +use ruff_python_semantic::{SemanticModel, analyze::typing::traverse_union}; use ruff_text_size::{Ranged, TextRange}; use crate::checkers::ast::Checker; @@ -33,13 +34,15 @@ use crate::checkers::ast::Checker; /// ## References /// - [Python documentation: `typing.Never`](https://docs.python.org/3/library/typing.html#typing.Never) /// - [Python documentation: `typing.NoReturn`](https://docs.python.org/3/library/typing.html#typing.NoReturn) -#[violation] -pub struct NeverUnion { +#[derive(ViolationMetadata)] +pub(crate) struct NeverUnion { never_like: NeverLike, union_like: UnionLike, } -impl AlwaysFixableViolation for NeverUnion { +impl Violation for NeverUnion { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { let Self { @@ -47,7 +50,7 @@ impl AlwaysFixableViolation for NeverUnion { union_like, } = self; match union_like { - UnionLike::BinOp => { + UnionLike::PEP604 => { format!("`{never_like} | T` is equivalent to `T`") } UnionLike::TypingUnion => { @@ -56,14 +59,14 @@ impl AlwaysFixableViolation for NeverUnion { } } - fn fix_title(&self) -> String { + fn fix_title(&self) -> Option<String> { let Self { never_like, .. } = self; - format!("Remove `{never_like}`") + Some(format!("Remove `{never_like}`")) } } /// RUF020 -pub(crate) fn never_union(checker: &mut Checker, expr: &Expr) { +pub(crate) fn never_union(checker: &Checker, expr: &Expr) { match expr { // Ex) `typing.NoReturn | int` Expr::BinOp(ast::ExprBinOp { @@ -77,15 +80,22 @@ pub(crate) fn never_union(checker: &mut Checker, expr: &Expr) { let mut diagnostic = Diagnostic::new( NeverUnion { never_like, - union_like: UnionLike::BinOp, + union_like: UnionLike::PEP604, }, left.range(), ); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - checker.locator().slice(right.as_ref()).to_string(), - expr.range(), - ))); - checker.diagnostics.push(diagnostic); + // Avoid producing code that would raise an exception when + // `Never | None` would be fixed to `None | None`. + // Instead do not provide a fix. No action needed for `typing.Union`, + // as `Union[None, None]` is valid Python. + // See https://github.com/astral-sh/ruff/issues/14567. + if !is_pep604_union_with_bare_none(checker.semantic()) { + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + checker.locator().slice(right.as_ref()).to_string(), + expr.range(), + ))); + } + checker.report_diagnostic(diagnostic); } // Analyze the right-hand side of the `|` operator. @@ -93,15 +103,17 @@ pub(crate) fn never_union(checker: &mut Checker, expr: &Expr) { let mut diagnostic = Diagnostic::new( NeverUnion { never_like, - union_like: UnionLike::BinOp, + union_like: UnionLike::PEP604, }, right.range(), ); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - checker.locator().slice(left.as_ref()).to_string(), - expr.range(), - ))); - checker.diagnostics.push(diagnostic); + if !is_pep604_union_with_bare_none(checker.semantic()) { + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + checker.locator().slice(left.as_ref()).to_string(), + expr.range(), + ))); + } + checker.report_diagnostic(diagnostic); } } @@ -160,7 +172,7 @@ pub(crate) fn never_union(checker: &mut Checker, expr: &Expr) { }, expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } @@ -174,7 +186,7 @@ enum UnionLike { /// E.g., `typing.Union[int, str]` TypingUnion, /// E.g., `int | str` - BinOp, + PEP604, } #[derive(Debug, Clone, Copy, PartialEq, Eq)] @@ -206,3 +218,44 @@ impl std::fmt::Display for NeverLike { } } } + +/// Return `true` if this union is a [PEP 604 union] that contains `None`, +/// e.g. `int | Never | None`. +/// +/// Autofixing these unions can be dangerous, +/// as `None | None` results in a runtime exception in Python. +/// +/// [PEP 604 union]: https://docs.python.org/3/library/stdtypes.html#types-union +fn is_pep604_union_with_bare_none(semantic: &SemanticModel) -> bool { + let enclosing_pep604_union = semantic + .current_expressions() + .skip(1) + .take_while(|expr| { + matches!( + expr, + Expr::BinOp(ExprBinOp { + op: Operator::BitOr, + .. + }) + ) + }) + .last(); + + let Some(enclosing_pep604_union) = enclosing_pep604_union else { + return false; + }; + + let mut union_contains_bare_none = false; + + traverse_union( + &mut |expr, _| { + if matches!(expr, Expr::NoneLiteral(_)) { + union_contains_bare_none = true; + } + }, + semantic, + enclosing_pep604_union, + ); + + union_contains_bare_none +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/none_not_at_end_of_union.rs b/crates/ruff_linter/src/rules/ruff/rules/none_not_at_end_of_union.rs new file mode 100644 index 0000000000000..3645b3e574c41 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/none_not_at_end_of_union.rs @@ -0,0 +1,75 @@ +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Expr; +use ruff_python_semantic::analyze::typing::traverse_union; +use ruff_text_size::Ranged; +use smallvec::SmallVec; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for type annotations where `None` is not at the end of an union. +/// +/// ## Why is this bad? +/// Type annotation unions are associative, meaning that the order of the elements +/// does not matter. The `None` literal represents the absence of a value. For +/// readability, it's preferred to write the more informative type expressions first. +/// +/// ## Example +/// ```python +/// def func(arg: None | int): ... +/// ``` +/// +/// Use instead: +/// ```python +/// def func(arg: int | None): ... +/// ``` +/// +/// ## References +/// - [Python documentation: Union type](https://docs.python.org/3/library/stdtypes.html#types-union) +/// - [Python documentation: `typing.Optional`](https://docs.python.org/3/library/typing.html#typing.Optional) +/// - [Python documentation: `None`](https://docs.python.org/3/library/constants.html#None) +#[derive(ViolationMetadata)] +pub(crate) struct NoneNotAtEndOfUnion; + +impl Violation for NoneNotAtEndOfUnion { + #[derive_message_formats] + fn message(&self) -> String { + "`None` not at the end of the type annotation.".to_string() + } +} + +/// RUF036 +pub(crate) fn none_not_at_end_of_union<'a>(checker: &Checker, union: &'a Expr) { + let semantic = checker.semantic(); + let mut none_exprs: SmallVec<[&Expr; 1]> = SmallVec::new(); + + let mut last_expr: Option<&Expr> = None; + let mut find_none = |expr: &'a Expr, _parent: &Expr| { + if matches!(expr, Expr::NoneLiteral(_)) { + none_exprs.push(expr); + } + last_expr = Some(expr); + }; + + // Walk through all type expressions in the union and keep track of `None` literals. + traverse_union(&mut find_none, semantic, union); + + let Some(last_expr) = last_expr else { + return; + }; + + // The must be at least one `None` expression. + let Some(last_none) = none_exprs.last() else { + return; + }; + + // If any of the `None` literals is last we do not emit. + if *last_none == last_expr { + return; + } + + for none_expr in none_exprs { + checker.report_diagnostic(Diagnostic::new(NoneNotAtEndOfUnion, none_expr.range())); + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/parenthesize_chained_operators.rs b/crates/ruff_linter/src/rules/ruff/rules/parenthesize_chained_operators.rs new file mode 100644 index 0000000000000..cdcf523301d41 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/parenthesize_chained_operators.rs @@ -0,0 +1,98 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for chained operators where adding parentheses could improve the +/// clarity of the code. +/// +/// ## Why is this bad? +/// `and` always binds more tightly than `or` when chaining the two together, +/// but this can be hard to remember (and sometimes surprising). +/// Adding parentheses in these situations can greatly improve code readability, +/// with no change to semantics or performance. +/// +/// For example: +/// ```python +/// a, b, c = 1, 0, 2 +/// x = a or b and c +/// +/// d, e, f = 0, 1, 2 +/// y = d and e or f +/// ``` +/// +/// Use instead: +/// ```python +/// a, b, c = 1, 0, 2 +/// x = a or (b and c) +/// +/// d, e, f = 0, 1, 2 +/// y = (d and e) or f +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct ParenthesizeChainedOperators; + +impl AlwaysFixableViolation for ParenthesizeChainedOperators { + #[derive_message_formats] + fn message(&self) -> String { + "Parenthesize `a and b` expressions when chaining `and` and `or` together, to make the precedence clear".to_string() + } + + fn fix_title(&self) -> String { + "Parenthesize the `and` subexpression".to_string() + } +} + +/// RUF021 +pub(crate) fn parenthesize_chained_logical_operators(checker: &Checker, expr: &ast::ExprBoolOp) { + // We're only interested in `and` expressions inside `or` expressions: + // - `a or b or c` => `BoolOp(values=[Name("a"), Name("b"), Name("c")], op=Or)` + // - `a and b and c` => `BoolOp(values=[Name("a"), Name("b"), Name("c")], op=And)` + // - `a or b and c` => `BoolOp(value=[Name("a"), BoolOp(values=[Name("b"), Name("c")], op=And), op=Or)` + // + // While it is *possible* to get an `Or` node inside an `And` node, + // you can only achieve it by parenthesizing the `or` subexpression + // (since normally, `and` always binds more tightly): + // - `a and (b or c)` => `BoolOp(values=[Name("a"), BoolOp(values=[Name("b"), Name("c"), op=Or), op=And)` + // + // We only care about unparenthesized boolean subexpressions here + // (if they're parenthesized already, that's great!), + // so we can ignore all cases where an `Or` node + // exists inside an `And` node. + if expr.op.is_and() { + return; + } + for condition in &expr.values { + match condition { + ast::Expr::BoolOp( + bool_op @ ast::ExprBoolOp { + op: ast::BoolOp::And, + .. + }, + ) => { + let locator = checker.locator(); + let source_range = bool_op.range(); + if parenthesized_range( + bool_op.into(), + expr.into(), + checker.comment_ranges(), + locator.contents(), + ) + .is_none() + { + let new_source = format!("({})", locator.slice(source_range)); + let edit = Edit::range_replacement(new_source, source_range); + checker.report_diagnostic( + Diagnostic::new(ParenthesizeChainedOperators, source_range) + .with_fix(Fix::safe_edit(edit)), + ); + } + } + _ => continue, + } + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/parenthesize_logical_operators.rs b/crates/ruff_linter/src/rules/ruff/rules/parenthesize_logical_operators.rs deleted file mode 100644 index a6cc31bf01c03..0000000000000 --- a/crates/ruff_linter/src/rules/ruff/rules/parenthesize_logical_operators.rs +++ /dev/null @@ -1,103 +0,0 @@ -use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast as ast; -use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_text_size::Ranged; - -use crate::checkers::ast::Checker; - -/// ## What it does -/// Checks for chained operators where adding parentheses could improve the -/// clarity of the code. -/// -/// ## Why is this bad? -/// `and` always binds more tightly than `or` when chaining the two together, -/// but this can be hard to remember (and sometimes surprising). -/// Adding parentheses in these situations can greatly improve code readability, -/// with no change to semantics or performance. -/// -/// For example: -/// ```python -/// a, b, c = 1, 0, 2 -/// x = a or b and c -/// -/// d, e, f = 0, 1, 2 -/// y = d and e or f -/// ``` -/// -/// Use instead: -/// ```python -/// a, b, c = 1, 0, 2 -/// x = a or (b and c) -/// -/// d, e, f = 0, 1, 2 -/// y = (d and e) or f -/// ``` -#[violation] -pub struct ParenthesizeChainedOperators; - -impl AlwaysFixableViolation for ParenthesizeChainedOperators { - #[derive_message_formats] - fn message(&self) -> String { - format!( - "Parenthesize `a and b` expressions when chaining `and` and `or` together, to make the precedence clear" - ) - } - - fn fix_title(&self) -> String { - "Parenthesize the `and` subexpression".to_string() - } -} - -/// RUF021 -pub(crate) fn parenthesize_chained_logical_operators( - checker: &mut Checker, - expr: &ast::ExprBoolOp, -) { - // We're only interested in `and` expressions inside `or` expressions: - // - `a or b or c` => `BoolOp(values=[Name("a"), Name("b"), Name("c")], op=Or)` - // - `a and b and c` => `BoolOp(values=[Name("a"), Name("b"), Name("c")], op=And)` - // - `a or b and c` => `BoolOp(value=[Name("a"), BoolOp(values=[Name("b"), Name("c")], op=And), op=Or)` - // - // While it is *possible* to get an `Or` node inside an `And` node, - // you can only achieve it by parenthesizing the `or` subexpression - // (since normally, `and` always binds more tightly): - // - `a and (b or c)` => `BoolOp(values=[Name("a"), BoolOp(values=[Name("b"), Name("c"), op=Or), op=And)` - // - // We only care about unparenthesized boolean subexpressions here - // (if they're parenthesized already, that's great!), - // so we can ignore all cases where an `Or` node - // exists inside an `And` node. - if expr.op.is_and() { - return; - } - for condition in &expr.values { - match condition { - ast::Expr::BoolOp( - bool_op @ ast::ExprBoolOp { - op: ast::BoolOp::And, - .. - }, - ) => { - let locator = checker.locator(); - let source_range = bool_op.range(); - if parenthesized_range( - bool_op.into(), - expr.into(), - checker.comment_ranges(), - locator.contents(), - ) - .is_none() - { - let new_source = format!("({})", locator.slice(source_range)); - let edit = Edit::range_replacement(new_source, source_range); - checker.diagnostics.push( - Diagnostic::new(ParenthesizeChainedOperators, source_range) - .with_fix(Fix::safe_edit(edit)), - ); - } - } - _ => continue, - }; - } -} diff --git a/crates/ruff_linter/src/rules/ruff/rules/post_init_default.rs b/crates/ruff_linter/src/rules/ruff/rules/post_init_default.rs index 61a321b6e154a..f189459e27025 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/post_init_default.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/post_init_default.rs @@ -1,7 +1,7 @@ use anyhow::Context; use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::{Scope, ScopeKind}; use ruff_python_trivia::{indentation_at_offset, textwrap}; @@ -10,7 +10,7 @@ use ruff_text_size::Ranged; use crate::{checkers::ast::Checker, importer::ImportRequest}; -use super::helpers::is_dataclass; +use super::helpers::{DataclassKind, dataclass_kind}; /// ## What it does /// Checks for `__post_init__` dataclass methods with parameter defaults. @@ -61,29 +61,35 @@ use super::helpers::is_dataclass; /// foo = Foo() # Prints '1 2'. /// ``` /// +/// ## Fix safety +/// +/// This fix is always marked as unsafe because, although switching to `InitVar` is usually correct, +/// it is incorrect when the parameter is not intended to be part of the public API or when the value +/// is meant to be shared across all instances. +/// /// ## References /// - [Python documentation: Post-init processing](https://docs.python.org/3/library/dataclasses.html#post-init-processing) /// - [Python documentation: Init-only variables](https://docs.python.org/3/library/dataclasses.html#init-only-variables) /// /// [documentation]: https://docs.python.org/3/library/dataclasses.html#init-only-variables -#[violation] -pub struct PostInitDefault; +#[derive(ViolationMetadata)] +pub(crate) struct PostInitDefault; impl Violation for PostInitDefault { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`__post_init__` method with argument defaults") + "`__post_init__` method with argument defaults".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Use `dataclasses.InitVar` instead")) + Some("Use `dataclasses.InitVar` instead".to_string()) } } /// RUF033 -pub(crate) fn post_init_default(checker: &mut Checker, function_def: &ast::StmtFunctionDef) { +pub(crate) fn post_init_default(checker: &Checker, function_def: &ast::StmtFunctionDef) { if &function_def.name != "__post_init__" { return; } @@ -91,7 +97,10 @@ pub(crate) fn post_init_default(checker: &mut Checker, function_def: &ast::StmtF let current_scope = checker.semantic().current_scope(); match current_scope.kind { ScopeKind::Class(class_def) => { - if !is_dataclass(class_def, checker.semantic()) { + if !matches!( + dataclass_kind(class_def, checker.semantic()), + Some((DataclassKind::Stdlib, _)) + ) { return; } } @@ -99,22 +108,22 @@ pub(crate) fn post_init_default(checker: &mut Checker, function_def: &ast::StmtF } let mut stopped_fixes = false; - let mut diagnostics = vec![]; - - for ast::ParameterWithDefault { - parameter, - default, - range: _, - } in function_def.parameters.iter_non_variadic_params() - { - let Some(default) = default else { + + for parameter in function_def.parameters.iter_non_variadic_params() { + let Some(default) = parameter.default() else { continue; }; let mut diagnostic = Diagnostic::new(PostInitDefault, default.range()); if !stopped_fixes { diagnostic.try_set_fix(|| { - use_initvar(current_scope, function_def, parameter, default, checker) + use_initvar( + current_scope, + function_def, + ¶meter.parameter, + default, + checker, + ) }); // Need to stop fixes as soon as there is a parameter we cannot fix. // Otherwise, we risk a syntax error (a parameter without a default @@ -122,10 +131,8 @@ pub(crate) fn post_init_default(checker: &mut Checker, function_def: &ast::StmtF stopped_fixes |= diagnostic.fix.is_none(); } - diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } - - checker.diagnostics.extend(diagnostics); } /// Generate a [`Fix`] to transform a `__post_init__` default argument into a @@ -166,8 +173,7 @@ fn use_initvar( let line_ending = checker.stylist().line_ending().as_str(); if let Some(annotation) = ¶meter - .annotation - .as_deref() + .annotation() .map(|annotation| locator.slice(annotation)) { format!("{parameter_name}: {initvar_binding}[{annotation}] = {default}{line_ending}") diff --git a/crates/ruff_linter/src/rules/ruff/rules/pytest_raises_ambiguous_pattern.rs b/crates/ruff_linter/src/rules/ruff/rules/pytest_raises_ambiguous_pattern.rs new file mode 100644 index 0000000000000..46b48a4ef2d96 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/pytest_raises_ambiguous_pattern.rs @@ -0,0 +1,155 @@ +use crate::checkers::ast::Checker; +use crate::rules::flake8_pytest_style::rules::is_pytest_raises; +use ruff_diagnostics::{Diagnostic, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast as ast; + +/// ## What it does +/// Checks for non-raw literal string arguments passed to the `match` parameter +/// of `pytest.raises()` where the string contains at least one unescaped +/// regex metacharacter. +/// +/// ## Why is this bad? +/// The `match` argument is implicitly converted to a regex under the hood. +/// It should be made explicit whether the string is meant to be a regex or a "plain" pattern +/// by prefixing the string with the `r` suffix, escaping the metacharacter(s) +/// in the string using backslashes, or wrapping the entire string in a call to +/// `re.escape()`. +/// +/// ## Example +/// +/// ```python +/// import pytest +/// +/// +/// with pytest.raises(Exception, match="A full sentence."): +/// do_thing_that_raises() +/// ``` +/// +/// Use instead: +/// +/// ```python +/// import pytest +/// +/// +/// with pytest.raises(Exception, match=r"A full sentence."): +/// do_thing_that_raises() +/// ``` +/// +/// Alternatively: +/// +/// ```python +/// import pytest +/// import re +/// +/// +/// with pytest.raises(Exception, match=re.escape("A full sentence.")): +/// do_thing_that_raises() +/// ``` +/// +/// or: +/// +/// ```python +/// import pytest +/// import re +/// +/// +/// with pytest.raises(Exception, "A full sentence\\."): +/// do_thing_that_raises() +/// ``` +/// +/// ## References +/// - [Python documentation: `re.escape`](https://docs.python.org/3/library/re.html#re.escape) +/// - [`pytest` documentation: `pytest.raises`](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) +#[derive(ViolationMetadata)] +pub(crate) struct PytestRaisesAmbiguousPattern; + +impl Violation for PytestRaisesAmbiguousPattern { + #[derive_message_formats] + fn message(&self) -> String { + "Pattern passed to `match=` contains metacharacters but is neither escaped nor raw" + .to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Use a raw string or `re.escape()` to make the intention explicit".to_string()) + } +} + +/// RUF043 +pub(crate) fn pytest_raises_ambiguous_pattern(checker: &Checker, call: &ast::ExprCall) { + if !is_pytest_raises(&call.func, checker.semantic()) { + return; + } + + // It *can* be passed as a positional argument if you try very hard, + // but pytest only documents it as a keyword argument, and it's quite hard pass it positionally + let Some(ast::Keyword { value, .. }) = call.arguments.find_keyword("match") else { + return; + }; + + let ast::Expr::StringLiteral(string) = value else { + return; + }; + + let any_part_is_raw = string.value.iter().any(|part| part.flags.prefix().is_raw()); + + if any_part_is_raw || !string_has_unescaped_metacharacters(&string.value) { + return; + } + + let diagnostic = Diagnostic::new(PytestRaisesAmbiguousPattern, string.range); + + checker.report_diagnostic(diagnostic); +} + +fn string_has_unescaped_metacharacters(value: &ast::StringLiteralValue) -> bool { + let mut escaped = false; + + for character in value.chars() { + if escaped { + if escaped_char_is_regex_metasequence(character) { + return true; + } + + escaped = false; + continue; + } + + if character == '\\' { + escaped = true; + continue; + } + + if char_is_regex_metacharacter(character) { + return true; + } + } + + false +} + +/// Whether the sequence `\<c>` means anything special: +/// +/// * `\A`: Start of input +/// * `\b`, `\B`: Word boundary and non-word-boundary +/// * `\d`, `\D`: Digit and non-digit +/// * `\s`, `\S`: Whitespace and non-whitespace +/// * `\w`, `\W`: Word and non-word character +/// * `\z`: End of input +/// +/// `\u`, `\U`, `\N`, `\x`, `\a`, `\f`, `\n`, `\r`, `\t`, `\v` +/// are also valid in normal strings and thus do not count. +/// `\b` means backspace only in character sets, +/// while backreferences (e.g., `\1`) are not valid without groups, +/// both of which should be caught in [`string_has_unescaped_metacharacters`]. +const fn escaped_char_is_regex_metasequence(c: char) -> bool { + matches!(c, 'A' | 'b' | 'B' | 'd' | 'D' | 's' | 'S' | 'w' | 'W' | 'z') +} + +const fn char_is_regex_metacharacter(c: char) -> bool { + matches!( + c, + '.' | '^' | '$' | '*' | '+' | '?' | '{' | '[' | '\\' | '|' | '(' | ')' + ) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/quadratic_list_summation.rs b/crates/ruff_linter/src/rules/ruff/rules/quadratic_list_summation.rs index 31b4396a2ac74..2a7e28c69a160 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/quadratic_list_summation.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/quadratic_list_summation.rs @@ -2,9 +2,8 @@ use anyhow::Result; use itertools::Itertools; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::parenthesize::parenthesized_range; -use ruff_python_ast::AstNode; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; @@ -47,27 +46,35 @@ use crate::importer::ImportRequest; /// functools.reduce(operator.iadd, lists, []) /// ``` /// +/// ## Fix safety +/// +/// This fix is always marked as unsafe because `sum` uses the `__add__` magic method while +/// `operator.iadd` uses the `__iadd__` magic method, and these behave differently on lists. +/// The former requires the right summand to be a list, whereas the latter allows for any iterable. +/// Therefore, the fix could inadvertently cause code that previously raised an error to silently +/// succeed. Moreover, the fix could remove comments from the original code. +/// /// ## References /// - [_How Not to Flatten a List of Lists in Python_](https://mathieularose.com/how-not-to-flatten-a-list-of-lists-in-python) /// - [_How do I make a flat list out of a list of lists?_](https://stackoverflow.com/questions/952914/how-do-i-make-a-flat-list-out-of-a-list-of-lists/953097#953097) /// /// [microbenchmarks]: https://github.com/astral-sh/ruff/issues/5073#issuecomment-1591836349 -#[violation] -pub struct QuadraticListSummation; +#[derive(ViolationMetadata)] +pub(crate) struct QuadraticListSummation; impl AlwaysFixableViolation for QuadraticListSummation { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid quadratic list summation") + "Avoid quadratic list summation".to_string() } fn fix_title(&self) -> String { - format!("Replace with `functools.reduce`") + "Replace with `functools.reduce`".to_string() } } /// RUF017 -pub(crate) fn quadratic_list_summation(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn quadratic_list_summation(checker: &Checker, call: &ast::ExprCall) { let ast::ExprCall { func, arguments, @@ -86,11 +93,11 @@ pub(crate) fn quadratic_list_summation(checker: &mut Checker, call: &ast::ExprCa if !start_is_empty_list(arguments, semantic) { return; - }; + } let mut diagnostic = Diagnostic::new(QuadraticListSummation, *range); diagnostic.try_set_fix(|| convert_to_reduce(iterable, call, checker)); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Generate a [`Fix`] to convert a `sum()` call to a `functools.reduce()` call. @@ -110,7 +117,7 @@ fn convert_to_reduce(iterable: &Expr, call: &ast::ExprCall, checker: &Checker) - let iterable = checker.locator().slice( parenthesized_range( iterable.into(), - call.arguments.as_any_node_ref(), + (&call.arguments).into(), checker.comment_ranges(), checker.locator().contents(), ) @@ -128,7 +135,7 @@ fn convert_to_reduce(iterable: &Expr, call: &ast::ExprCall, checker: &Checker) - /// Returns `true` if the `start` argument to a `sum()` call is an empty list. fn start_is_empty_list(arguments: &Arguments, semantic: &SemanticModel) -> bool { - let Some(start_arg) = arguments.find_argument("start", 1) else { + let Some(start_arg) = arguments.find_argument_value("start", 1) else { return false; }; diff --git a/crates/ruff_linter/src/rules/ruff/rules/redirected_noqa.rs b/crates/ruff_linter/src/rules/ruff/rules/redirected_noqa.rs index 455aa7775e843..12a2f23901634 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/redirected_noqa.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/redirected_noqa.rs @@ -1,8 +1,8 @@ use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; -use crate::noqa::{Directive, NoqaDirectives}; +use crate::noqa::{Codes, Directive, FileNoqaDirectives, NoqaDirectives}; use crate::rule_redirects::get_redirect_target; /// ## What it does @@ -23,8 +23,8 @@ use crate::rule_redirects::get_redirect_target; /// ```python /// x = eval(command) # noqa: S307 /// ``` -#[violation] -pub struct RedirectedNOQA { +#[derive(ViolationMetadata)] +pub(crate) struct RedirectedNOQA { original: String, target: String, } @@ -42,28 +42,47 @@ impl AlwaysFixableViolation for RedirectedNOQA { } } -/// RUF101 +/// RUF101 for in-line noqa directives pub(crate) fn redirected_noqa(diagnostics: &mut Vec<Diagnostic>, noqa_directives: &NoqaDirectives) { for line in noqa_directives.lines() { let Directive::Codes(directive) = &line.directive else { continue; }; - for code in directive.iter() { - if let Some(redirected) = get_redirect_target(code.as_str()) { - let mut diagnostic = Diagnostic::new( - RedirectedNOQA { - original: code.to_string(), - target: redirected.to_string(), - }, - code.range(), - ); - diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( - redirected.to_string(), - code.range(), - ))); - diagnostics.push(diagnostic); - } + build_diagnostics(diagnostics, directive); + } +} + +/// RUF101 for file noqa directives +pub(crate) fn redirected_file_noqa( + diagnostics: &mut Vec<Diagnostic>, + noqa_directives: &FileNoqaDirectives, +) { + for line in noqa_directives.lines() { + let Directive::Codes(codes) = &line.parsed_file_exemption else { + continue; + }; + + build_diagnostics(diagnostics, codes); + } +} + +/// Convert a sequence of [Codes] into [Diagnostic]s and append them to `diagnostics`. +fn build_diagnostics(diagnostics: &mut Vec<Diagnostic>, codes: &Codes<'_>) { + for code in codes.iter() { + if let Some(redirected) = get_redirect_target(code.as_str()) { + let mut diagnostic = Diagnostic::new( + RedirectedNOQA { + original: code.to_string(), + target: redirected.to_string(), + }, + code.range(), + ); + diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( + redirected.to_string(), + code.range(), + ))); + diagnostics.push(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/redundant_bool_literal.rs b/crates/ruff_linter/src/rules/ruff/rules/redundant_bool_literal.rs new file mode 100644 index 0000000000000..0faa8bad9a866 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/redundant_bool_literal.rs @@ -0,0 +1,137 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::Expr; +use ruff_python_semantic::analyze::typing::traverse_literal; +use ruff_text_size::Ranged; + +use bitflags::bitflags; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for `Literal[True, False]` type annotations. +/// +/// ## Why is this bad? +/// `Literal[True, False]` can be replaced with `bool` in type annotations, +/// which has the same semantic meaning but is more concise and readable. +/// +/// `bool` type has exactly two constant instances: `True` and `False`. Static +/// type checkers such as [mypy] treat `Literal[True, False]` as equivalent to +/// `bool` in a type annotation. +/// +/// ## Example +/// ```python +/// from typing import Literal +/// +/// x: Literal[True, False] +/// y: Literal[True, False, "hello", "world"] +/// ``` +/// +/// Use instead: +/// ```python +/// from typing import Literal +/// +/// x: bool +/// y: Literal["hello", "world"] | bool +/// ``` +/// +/// ## Fix safety +/// The fix for this rule is marked as unsafe, as it may change the semantics of the code. +/// Specifically: +/// +/// - Type checkers may not treat `bool` as equivalent when overloading boolean arguments +/// with `Literal[True]` and `Literal[False]` (see, e.g., [#14764] and [#5421]). +/// - `bool` is not strictly equivalent to `Literal[True, False]`, as `bool` is +/// a subclass of `int`, and this rule may not apply if the type annotations are used +/// in a numeric context. +/// +/// Further, the `Literal` slice may contain trailing-line comments which the fix would remove. +/// +/// ## References +/// - [Typing documentation: Legal parameters for `Literal` at type check time](https://typing.python.org/en/latest/spec/literal.html#legal-parameters-for-literal-at-type-check-time) +/// - [Python documentation: Boolean type - `bool`](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool) +/// +/// [mypy]: https://github.com/python/mypy/blob/master/mypy/typeops.py#L985 +/// [#14764]: https://github.com/python/mypy/issues/14764 +/// [#5421]: https://github.com/microsoft/pyright/issues/5421 +#[derive(ViolationMetadata)] +pub(crate) struct RedundantBoolLiteral { + seen_others: bool, +} + +impl Violation for RedundantBoolLiteral { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + if self.seen_others { + "`Literal[True, False, ...]` can be replaced with `Literal[...] | bool`".to_string() + } else { + "`Literal[True, False]` can be replaced with `bool`".to_string() + } + } + + fn fix_title(&self) -> Option<String> { + Some(if self.seen_others { + "Replace with `Literal[...] | bool`".to_string() + } else { + "Replace with `bool`".to_string() + }) + } +} + +/// RUF038 +pub(crate) fn redundant_bool_literal<'a>(checker: &Checker, literal_expr: &'a Expr) { + if !checker.semantic().seen_typing() { + return; + } + + let mut seen_expr = BooleanLiteral::empty(); + + let mut find_bools = |expr: &'a Expr, _parent: &'a Expr| { + let expr_type = match expr { + Expr::BooleanLiteral(boolean_expr) => { + if boolean_expr.value { + BooleanLiteral::TRUE + } else { + BooleanLiteral::FALSE + } + } + _ => BooleanLiteral::OTHER, + }; + seen_expr.insert(expr_type); + }; + + traverse_literal(&mut find_bools, checker.semantic(), literal_expr); + + if !seen_expr.contains(BooleanLiteral::TRUE | BooleanLiteral::FALSE) { + return; + } + + let seen_others = seen_expr.contains(BooleanLiteral::OTHER); + + let mut diagnostic = + Diagnostic::new(RedundantBoolLiteral { seen_others }, literal_expr.range()); + + // Provide a [`Fix`] when the complete `Literal` can be replaced. Applying the fix + // can leave an unused import to be fixed by the `unused-import` rule. + if !seen_others { + if checker.semantic().has_builtin_binding("bool") { + diagnostic.set_fix(Fix::unsafe_edit(Edit::range_replacement( + "bool".to_string(), + literal_expr.range(), + ))); + } + } + + checker.report_diagnostic(diagnostic); +} + +bitflags! { + #[derive(Default, Debug)] + struct BooleanLiteral: u8 { + const TRUE = 1 << 0; + const FALSE = 1 << 1; + const OTHER = 1 << 2; + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/sequence_sorting.rs b/crates/ruff_linter/src/rules/ruff/rules/sequence_sorting.rs index ad77ea03368d9..e5881bc0edde1 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/sequence_sorting.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/sequence_sorting.rs @@ -6,11 +6,13 @@ use std::borrow::Cow; use std::cmp::Ordering; +use itertools::Itertools; + use ruff_python_ast as ast; use ruff_python_codegen::Stylist; use ruff_python_parser::{TokenKind, Tokens}; use ruff_python_stdlib::str::is_cased_uppercase; -use ruff_python_trivia::{first_non_trivia_token, leading_indentation, SimpleTokenKind}; +use ruff_python_trivia::{SimpleTokenKind, first_non_trivia_token, leading_indentation}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -298,8 +300,10 @@ impl<'a> SortClassification<'a> { let Some(string_node) = expr.as_string_literal_expr() else { return Self::NotAListOfStringLiterals; }; - any_implicit_concatenation |= string_node.value.is_implicit_concatenated(); - items.push(string_node.value.to_str()); + match string_node.as_single_part_string() { + Some(literal) => items.push(&*literal.value), + None => any_implicit_concatenation = true, + } } if any_implicit_concatenation { return Self::UnsortedButUnfixable; @@ -314,6 +318,52 @@ impl<'a> SortClassification<'a> { } } +/// The complexity of the comments in a multiline sequence. +/// +/// A sequence like this has "simple" comments: it's unambiguous +/// which item each comment refers to, so there's no "risk" in sorting it: +/// +/// ```py +/// __all__ = [ +/// "foo", # comment1 +/// "bar", # comment2 +/// ] +/// ``` +/// +/// This sequence has complex comments: we can't safely autofix the sort here, +/// as the own-line comments might be used to create sections in `__all__`: +/// +/// ```py +/// __all__ = [ +/// # fooey things +/// "foo1", +/// "foo2", +/// # barey things +/// "bar1", +/// "foobar", +/// ] +/// ``` +/// +/// This sequence also has complex comments -- it's ambiguous which item +/// each comment should belong to: +/// +/// ```py +/// __all__ = [ +/// "foo1", "foo", "barfoo", # fooey things +/// "baz", bazz2", "fbaz", # barrey things +/// ] +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(super) enum CommentComplexity { + Simple, + Complex, +} + +impl CommentComplexity { + pub(super) const fn is_complex(self) -> bool { + matches!(self, CommentComplexity::Complex) + } +} + // An instance of this struct encapsulates an analysis /// of a multiline Python tuple/list that represents an /// `__all__`/`__slots__`/etc. definition or augmentation. @@ -328,6 +378,24 @@ impl<'a> MultilineStringSequenceValue<'a> { self.items.len() } + /// Determine the [`CommentComplexity`] of this multiline string sequence. + pub(super) fn comment_complexity(&self) -> CommentComplexity { + if self.items.iter().tuple_windows().any(|(first, second)| { + first.has_own_line_comments() + || first + .end_of_line_comments + .is_some_and(|end_line_comment| second.start() < end_line_comment.end()) + }) || self + .items + .last() + .is_some_and(StringSequenceItem::has_own_line_comments) + { + CommentComplexity::Complex + } else { + CommentComplexity::Simple + } + } + /// Analyse the source range for a multiline Python tuple/list that /// represents an `__all__`/`__slots__`/etc. definition or augmentation. /// Return `None` if the analysis fails for whatever reason. @@ -445,7 +513,7 @@ impl<'a> MultilineStringSequenceValue<'a> { // we'll end up with two commas after the final item, which would be invalid syntax) let needs_trailing_comma = self.ends_with_trailing_comma && first_non_trivia_token(TextSize::new(0), &postlude) - .map_or(true, |tok| tok.kind() != SimpleTokenKind::Comma); + .is_none_or(|tok| tok.kind() != SimpleTokenKind::Comma); self.items .sort_by(|a, b| sorting_style.compare(a.value, b.value)); @@ -519,7 +587,9 @@ fn collect_string_sequence_lines<'a>( } TokenKind::String => { let Some(string_value) = string_items_iter.next() else { - unreachable!("Expected the number of string tokens to be equal to the number of string items in the sequence"); + unreachable!( + "Expected the number of string tokens to be equal to the number of string items in the sequence" + ); }; line_state.visit_string_token(string_value, token.range()); ends_with_trailing_comma = false; @@ -792,6 +862,10 @@ impl<'a> StringSequenceItem<'a> { fn with_no_comments(value: &'a str, element_range: TextRange) -> Self { Self::new(value, vec![], element_range, None) } + + fn has_own_line_comments(&self) -> bool { + !self.preceding_comment_ranges.is_empty() + } } impl Ranged for StringSequenceItem<'_> { @@ -907,7 +981,7 @@ fn multiline_string_sequence_postlude<'a>( if postlude.len() <= 2 { let mut reversed_postlude_chars = postlude.chars().rev(); if let Some(closing_paren @ (')' | '}' | ']')) = reversed_postlude_chars.next() { - if reversed_postlude_chars.next().map_or(true, |c| c == ',') { + if reversed_postlude_chars.next().is_none_or(|c| c == ',') { return Cow::Owned(format!(",{newline}{leading_indent}{closing_paren}")); } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_all.rs b/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_all.rs index 6548d8077eb55..6834e7643dd78 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_all.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_all.rs @@ -1,13 +1,13 @@ -use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_source_file::LineRanges; use ruff_text_size::TextRange; use crate::checkers::ast::Checker; use crate::rules::ruff::rules::sequence_sorting::{ - sort_single_line_elements_sequence, MultilineStringSequenceValue, SequenceKind, - SortClassification, SortingStyle, + MultilineStringSequenceValue, SequenceKind, SortClassification, SortingStyle, + sort_single_line_elements_sequence, }; /// ## What it does @@ -54,28 +54,49 @@ use crate::rules::ruff::rules::sequence_sorting::{ /// ``` /// /// ## Fix safety -/// This rule's fix is marked as always being safe, in that +/// This rule's fix is marked as unsafe if there are any comments that take up +/// a whole line by themselves inside the `__all__` definition, for example: +/// ```py +/// __all__ = [ +/// # eggy things +/// "duck_eggs", +/// "chicken_eggs", +/// # hammy things +/// "country_ham", +/// "parma_ham", +/// ] +/// ``` +/// +/// This is a common pattern used to delimit categories within a module's API, +/// but it would be out of the scope of this rule to attempt to maintain these +/// categories when alphabetically sorting the items of `__all__`. +/// +/// The fix is also marked as unsafe if there are more than two `__all__` items +/// on a single line and that line also has a trailing comment, since here it +/// is impossible to accurately gauge which item the comment should be moved +/// with when sorting `__all__`: +/// ```py +/// __all__ = [ +/// "a", "c", "e", # a comment +/// "b", "d", "f", # a second comment +/// ] +/// ``` +/// +/// Other than this, the rule's fix is marked as always being safe, in that /// it should very rarely alter the semantics of any Python code. /// However, note that (although it's rare) the value of `__all__` /// could be read by code elsewhere that depends on the exact /// iteration order of the items in `__all__`, in which case this /// rule's fix could theoretically cause breakage. -/// -/// Note also that for multiline `__all__` definitions -/// that include comments on their own line, it can be hard -/// to tell where the comments should be moved to when sorting -/// the contents of `__all__`. While this rule's fix will -/// never delete a comment, it might *sometimes* move a -/// comment to an unexpected location. -#[violation] -pub struct UnsortedDunderAll; +#[derive(ViolationMetadata)] +pub(crate) struct UnsortedDunderAll; impl Violation for UnsortedDunderAll { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("`__all__` is not sorted") + "`__all__` is not sorted".to_string() } fn fix_title(&self) -> Option<String> { @@ -88,7 +109,7 @@ const SORTING_STYLE: SortingStyle = SortingStyle::Isort; /// Sort an `__all__` definition represented by a `StmtAssign` AST node. /// For example: `__all__ = ["b", "c", "a"]`. pub(crate) fn sort_dunder_all_assign( - checker: &mut Checker, + checker: &Checker, ast::StmtAssign { value, targets, .. }: &ast::StmtAssign, ) { if let [expr] = targets.as_slice() { @@ -98,7 +119,7 @@ pub(crate) fn sort_dunder_all_assign( /// Sort an `__all__` mutation represented by a `StmtAugAssign` AST node. /// For example: `__all__ += ["b", "c", "a"]`. -pub(crate) fn sort_dunder_all_aug_assign(checker: &mut Checker, node: &ast::StmtAugAssign) { +pub(crate) fn sort_dunder_all_aug_assign(checker: &Checker, node: &ast::StmtAugAssign) { if node.op.is_add() { sort_dunder_all(checker, &node.target, &node.value); } @@ -106,7 +127,7 @@ pub(crate) fn sort_dunder_all_aug_assign(checker: &mut Checker, node: &ast::Stmt /// Sort a tuple or list passed to `__all__.extend()`. pub(crate) fn sort_dunder_all_extend_call( - checker: &mut Checker, + checker: &Checker, ast::ExprCall { func, arguments: ast::Arguments { args, keywords, .. }, @@ -131,7 +152,7 @@ pub(crate) fn sort_dunder_all_extend_call( /// Sort an `__all__` definition represented by a `StmtAnnAssign` AST node. /// For example: `__all__: list[str] = ["b", "c", "a"]`. -pub(crate) fn sort_dunder_all_ann_assign(checker: &mut Checker, node: &ast::StmtAnnAssign) { +pub(crate) fn sort_dunder_all_ann_assign(checker: &Checker, node: &ast::StmtAnnAssign) { if let Some(value) = &node.value { sort_dunder_all(checker, &node.target, value); } @@ -142,7 +163,7 @@ pub(crate) fn sort_dunder_all_ann_assign(checker: &mut Checker, node: &ast::Stmt /// This routine checks whether the tuple or list is sorted, and emits a /// violation if it is not sorted. If the tuple/list was not sorted, /// it attempts to set a `Fix` on the violation. -fn sort_dunder_all(checker: &mut Checker, target: &ast::Expr, node: &ast::Expr) { +fn sort_dunder_all(checker: &Checker, target: &ast::Expr, node: &ast::Expr) { let ast::Expr::Name(ast::ExprName { id, .. }) = target else { return; }; @@ -186,7 +207,7 @@ fn sort_dunder_all(checker: &mut Checker, target: &ast::Expr, node: &ast::Expr) } } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Attempt to return `Some(fix)`, where `fix` is a `Fix` @@ -208,37 +229,42 @@ fn create_fix( let locator = checker.locator(); let is_multiline = locator.contains_line_break(range); - let sorted_source_code = { - // The machinery in the `MultilineDunderAllValue` is actually - // sophisticated enough that it would work just as well for - // single-line `__all__` definitions, and we could reduce - // the number of lines of code in this file by doing that. - // Unfortunately, however, `MultilineDunderAllValue::from_source_range()` - // must process every token in an `__all__` definition as - // part of its analysis, and this is quite slow. For - // single-line `__all__` definitions, it's also unnecessary, - // as it's impossible to have comments in between the - // `__all__` elements if the `__all__` definition is all on - // a single line. Therefore, as an optimisation, we do the - // bare minimum of token-processing for single-line `__all__` - // definitions: - if is_multiline { - let value = MultilineStringSequenceValue::from_source_range( - range, - kind, - locator, - checker.tokens(), - string_items, - )?; - assert_eq!(value.len(), elts.len()); - value.into_sorted_source_code(SORTING_STYLE, locator, checker.stylist()) + // The machinery in the `MultilineDunderAllValue` is actually + // sophisticated enough that it would work just as well for + // single-line `__all__` definitions, and we could reduce + // the number of lines of code in this file by doing that. + // Unfortunately, however, `MultilineDunderAllValue::from_source_range()` + // must process every token in an `__all__` definition as + // part of its analysis, and this is quite slow. For + // single-line `__all__` definitions, it's also unnecessary, + // as it's impossible to have comments in between the + // `__all__` elements if the `__all__` definition is all on + // a single line. Therefore, as an optimisation, we do the + // bare minimum of token-processing for single-line `__all__` + // definitions: + let (sorted_source_code, applicability) = if is_multiline { + let value = MultilineStringSequenceValue::from_source_range( + range, + kind, + locator, + checker.tokens(), + string_items, + )?; + assert_eq!(value.len(), elts.len()); + let applicability = if value.comment_complexity().is_complex() { + Applicability::Unsafe } else { - sort_single_line_elements_sequence(kind, elts, string_items, locator, SORTING_STYLE) - } + Applicability::Safe + }; + let sorted_source = + value.into_sorted_source_code(SORTING_STYLE, locator, checker.stylist()); + (sorted_source, applicability) + } else { + let sorted_source = + sort_single_line_elements_sequence(kind, elts, string_items, locator, SORTING_STYLE); + (sorted_source, Applicability::Safe) }; - Some(Fix::safe_edit(Edit::range_replacement( - sorted_source_code, - range, - ))) + let edit = Edit::range_replacement(sorted_source_code, range); + Some(Fix::applicable_edit(edit, applicability)) } diff --git a/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_slots.rs b/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_slots.rs index b344e4f018ad7..ec7157621e0e9 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_slots.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/sort_dunder_slots.rs @@ -3,18 +3,18 @@ use std::borrow::Cow; use itertools::izip; use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_semantic::Binding; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use crate::Locator; use crate::checkers::ast::Checker; use crate::rules::ruff::rules::sequence_sorting::{ - sort_single_line_elements_sequence, MultilineStringSequenceValue, SequenceKind, - SortClassification, SortingStyle, + CommentComplexity, MultilineStringSequenceValue, SequenceKind, SortClassification, + SortingStyle, sort_single_line_elements_sequence, }; -use crate::Locator; /// ## What it does /// Checks for `__slots__` definitions that are not ordered according to a @@ -37,11 +37,44 @@ use crate::Locator; /// ``` /// /// ## Fix safety -/// This rule's fix is marked as unsafe whenever Ruff can detect that code -/// elsewhere in the same file reads the `__slots__` variable in some way. -/// This is because the order of the items in `__slots__` may have semantic -/// significance if the `__slots__` of a class is being iterated over, or -/// being assigned to another value. +/// This rule's fix is marked as unsafe in three situations. +/// +/// Firstly, the fix is unsafe if there are any comments that take up +/// a whole line by themselves inside the `__slots__` definition, for example: +/// ```py +/// class Foo: +/// __slots__ = [ +/// # eggy things +/// "duck_eggs", +/// "chicken_eggs", +/// # hammy things +/// "country_ham", +/// "parma_ham", +/// ] +/// ``` +/// +/// This is a common pattern used to delimit categories within a class's slots, +/// but it would be out of the scope of this rule to attempt to maintain these +/// categories when applying a natural sort to the items of `__slots__`. +/// +/// Secondly, the fix is also marked as unsafe if there are more than two +/// `__slots__` items on a single line and that line also has a trailing +/// comment, since here it is impossible to accurately gauge which item the +/// comment should be moved with when sorting `__slots__`: +/// ```py +/// class Bar: +/// __slots__ = [ +/// "a", "c", "e", # a comment +/// "b", "d", "f", # a second comment +/// ] +/// ``` +/// +/// Lastly, this rule's fix is marked as unsafe whenever Ruff can detect that +/// code elsewhere in the same file reads the `__slots__` variable in some way +/// and the `__slots__` variable is not assigned to a set. This is because the +/// order of the items in `__slots__` may have semantic significance if the +/// `__slots__` of a class is being iterated over, or being assigned to another +/// value. /// /// In the vast majority of other cases, this rule's fix is unlikely to /// cause breakage; as such, Ruff will otherwise mark this rule's fix as @@ -49,14 +82,8 @@ use crate::Locator; /// could still be read by code outside of the module in which the /// `__slots__` definition occurs, in which case this rule's fix could /// theoretically cause breakage. -/// -/// Additionally, note that for multiline `__slots__` definitions that -/// include comments on their own line, it can be hard to tell where the -/// comments should be moved to when sorting the contents of `__slots__`. -/// While this rule's fix will never delete a comment, it might *sometimes* -/// move a comment to an unexpected location. -#[violation] -pub struct UnsortedDunderSlots { +#[derive(ViolationMetadata)] +pub(crate) struct UnsortedDunderSlots { class_name: ast::name::Name, } @@ -122,15 +149,17 @@ pub(crate) fn sort_dunder_slots(checker: &Checker, binding: &Binding) -> Option< ); if let SortClassification::UnsortedAndMaybeFixable { items } = sort_classification { - if let Some(sorted_source_code) = display.generate_sorted_source_code(&items, checker) { + if let Some((sorted_source_code, comment_complexity)) = + display.generate_sorted_source_code(&items, checker) + { let edit = Edit::range_replacement(sorted_source_code, display.range()); - - let applicability = if display.kind.is_set_literal() || binding.is_unused() { - Applicability::Safe - } else { + let applicability = if comment_complexity.is_complex() + || (binding.is_used() && !display.kind.is_set_literal()) + { Applicability::Unsafe + } else { + Applicability::Safe }; - diagnostic.set_fix(Fix::applicable_edit(edit, applicability)); } } @@ -145,7 +174,7 @@ struct StringLiteralDisplay<'a> { /// The elts from the original AST node representing the display. /// Each elt is the AST representation of a single string literal /// element in the display - elts: Cow<'a, Vec<ast::Expr>>, + elts: Cow<'a, [ast::Expr]>, /// The source-code range of the display as a whole range: TextRange, /// What kind of a display is it? A dict, set, list or tuple? @@ -219,7 +248,11 @@ impl<'a> StringLiteralDisplay<'a> { Some(result) } - fn generate_sorted_source_code(&self, elements: &[&str], checker: &Checker) -> Option<String> { + fn generate_sorted_source_code( + &self, + elements: &[&str], + checker: &Checker, + ) -> Option<(String, CommentComplexity)> { let locator = checker.locator(); let multiline_classification = if locator.contains_line_break(self.range()) { @@ -238,26 +271,31 @@ impl<'a> StringLiteralDisplay<'a> { elements, )?; assert_eq!(analyzed_sequence.len(), self.elts.len()); - Some(analyzed_sequence.into_sorted_source_code( + let comment_complexity = analyzed_sequence.comment_complexity(); + let sorted_code = analyzed_sequence.into_sorted_source_code( SORTING_STYLE, locator, checker.stylist(), - )) + ); + Some((sorted_code, comment_complexity)) } // Sorting multiline dicts is unsupported (DisplayKind::Dict { .. }, MultilineClassification::Multiline) => None, (DisplayKind::Sequence(sequence_kind), MultilineClassification::SingleLine) => { - Some(sort_single_line_elements_sequence( + let sorted_code = sort_single_line_elements_sequence( *sequence_kind, &self.elts, elements, locator, SORTING_STYLE, - )) + ); + Some((sorted_code, CommentComplexity::Simple)) + } + (DisplayKind::Dict { items }, MultilineClassification::SingleLine) => { + let sorted_code = + sort_single_line_elements_dict(&self.elts, elements, items, locator); + Some((sorted_code, CommentComplexity::Simple)) } - (DisplayKind::Dict { items }, MultilineClassification::SingleLine) => Some( - sort_single_line_elements_dict(&self.elts, elements, items, locator), - ), } } } @@ -277,7 +315,7 @@ enum DisplayKind<'a> { Dict { items: &'a [ast::DictItem] }, } -impl<'a> DisplayKind<'a> { +impl DisplayKind<'_> { const fn is_set_literal(self) -> bool { matches!(self, Self::Sequence(SequenceKind::Set)) } diff --git a/crates/ruff_linter/src/rules/ruff/rules/starmap_zip.rs b/crates/ruff_linter/src/rules/ruff/rules/starmap_zip.rs new file mode 100644 index 0000000000000..c20371284c9c9 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/starmap_zip.rs @@ -0,0 +1,177 @@ +use crate::checkers::ast::Checker; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Expr, ExprCall, parenthesize::parenthesized_range}; +use ruff_python_parser::TokenKind; +use ruff_text_size::{Ranged, TextRange}; + +/// ## What it does +/// Checks for `itertools.starmap` calls where the second argument is a `zip` call. +/// +/// ## Why is this bad? +/// `zip`-ping iterables only to unpack them later from within `starmap` is unnecessary. +/// For such cases, `map()` should be used instead. +/// +/// ## Example +/// +/// ```python +/// from itertools import starmap +/// +/// +/// starmap(func, zip(a, b)) +/// starmap(func, zip(a, b, strict=True)) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// map(func, a, b) +/// map(func, a, b, strict=True) # 3.14+ +/// ``` +/// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe if the `starmap` or `zip` expressions contain comments that +/// would be deleted by applying the fix. Otherwise, the fix can be applied safely. +/// +/// ## Fix availability +/// +/// This rule will emit a diagnostic but not suggest a fix if `map` has been shadowed from its +/// builtin binding. +#[derive(ViolationMetadata)] +pub(crate) struct StarmapZip; + +impl Violation for StarmapZip { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "`itertools.starmap` called on `zip` iterable".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Use `map` instead".to_string()) + } +} + +/// RUF058 +pub(crate) fn starmap_zip(checker: &Checker, call: &ExprCall) { + let semantic = checker.semantic(); + + if !call.arguments.keywords.is_empty() { + return; + } + + let [_map_func, Expr::Call(iterable_call)] = &*call.arguments.args else { + return; + }; + + if !iterable_call.arguments.keywords.is_empty() { + // TODO: Pass `strict=` to `map` too when 3.14 is supported. + return; + } + + let positionals = &iterable_call.arguments.args; + + // `zip(*a)` where `a` is empty is valid, but `map(_, *a)` isn't. + if !positionals.is_empty() && positionals.iter().all(Expr::is_starred_expr) { + return; + } + + if !semantic + .resolve_qualified_name(&call.func) + .is_some_and(|it| matches!(it.segments(), ["itertools", "starmap"])) + { + return; + } + + if !semantic.match_builtin_expr(&iterable_call.func, "zip") { + return; + } + + let mut diagnostic = Diagnostic::new(StarmapZip, call.range); + + if let Some(fix) = replace_with_map(call, iterable_call, checker) { + diagnostic.set_fix(fix); + } + + checker.report_diagnostic(diagnostic); +} + +/// Replace the `starmap` call with a call to the `map` builtin, if `map` has not been shadowed. +fn replace_with_map(starmap: &ExprCall, zip: &ExprCall, checker: &Checker) -> Option<Fix> { + if !checker.semantic().has_builtin_binding("map") { + return None; + } + + let change_func_to_map = Edit::range_replacement("map".to_string(), starmap.func.range()); + + let mut remove_zip = vec![]; + + let full_zip_range = parenthesized_range( + zip.into(), + starmap.into(), + checker.comment_ranges(), + checker.source(), + ) + .unwrap_or(zip.range()); + + // Delete any parentheses around the `zip` call to prevent that the argument turns into a tuple. + remove_zip.push(Edit::range_deletion(TextRange::new( + full_zip_range.start(), + zip.start(), + ))); + + let full_zip_func_range = parenthesized_range( + (&zip.func).into(), + zip.into(), + checker.comment_ranges(), + checker.source(), + ) + .unwrap_or(zip.func.range()); + + // Delete the `zip` callee + remove_zip.push(Edit::range_deletion(full_zip_func_range)); + + // Delete the `(` from the `zip(...)` call + remove_zip.push(Edit::range_deletion(zip.arguments.l_paren_range())); + + // `zip` can be called without arguments but `map` can't. + if zip.arguments.is_empty() { + remove_zip.push(Edit::insertion("[]".to_string(), zip.arguments.start())); + } + + let after_zip = checker.tokens().after(full_zip_range.end()); + + // Remove any trailing commas after the `zip` call to avoid multiple trailing commas + // if the iterable has a trailing comma. + if let Some(trailing_comma) = after_zip.iter().find(|token| !token.kind().is_trivia()) { + if trailing_comma.kind() == TokenKind::Comma { + remove_zip.push(Edit::range_deletion(trailing_comma.range())); + } + } + + // Delete the `)` from the `zip(...)` call + remove_zip.push(Edit::range_deletion(zip.arguments.r_paren_range())); + + // Delete any trailing parentheses wrapping the `zip` call. + remove_zip.push(Edit::range_deletion(TextRange::new( + zip.end(), + full_zip_range.end(), + ))); + + let comment_ranges = checker.comment_ranges(); + let applicability = if comment_ranges.intersects(starmap.func.range()) + || comment_ranges.intersects(full_zip_range) + { + Applicability::Unsafe + } else { + Applicability::Safe + }; + + Some(Fix::applicable_edits( + change_func_to_map, + remove_zip, + applicability, + )) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/static_key_dict_comprehension.rs b/crates/ruff_linter/src/rules/ruff/rules/static_key_dict_comprehension.rs index 1d2236c6737e7..69f747b7733da 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/static_key_dict_comprehension.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/static_key_dict_comprehension.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## Removed /// This rule was implemented in `flake8-bugbear` and has been remapped to [B035] @@ -26,12 +26,12 @@ use ruff_macros::{derive_message_formats, violation}; /// ``` /// /// [B035]: https://docs.astral.sh/ruff/rules/static-key-dict-comprehension/ -#[violation] -pub struct RuffStaticKeyDictComprehension; +#[derive(ViolationMetadata)] +pub(crate) struct RuffStaticKeyDictComprehension; impl Violation for RuffStaticKeyDictComprehension { #[derive_message_formats] fn message(&self) -> String { - format!("Dictionary comprehension uses static key") + "Dictionary comprehension uses static key".to_string() } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/suppression_comment_visitor.rs b/crates/ruff_linter/src/rules/ruff/rules/suppression_comment_visitor.rs index b97ed311799c3..c99dec47ca6cf 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/suppression_comment_visitor.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/suppression_comment_visitor.rs @@ -1,12 +1,12 @@ use std::iter::Peekable; use ruff_python_ast::{ + AnyNodeRef, Suite, helpers::comment_indentation_after, visitor::source_order::{self, SourceOrderVisitor, TraversalSignal}, - AnyNodeRef, Suite, }; use ruff_python_trivia::{ - indentation_at_offset, CommentLinePosition, SimpleTokenizer, SuppressionKind, + CommentLinePosition, SimpleTokenizer, SuppressionKind, indentation_at_offset, }; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -59,7 +59,7 @@ where fn can_skip(&mut self, node_end: TextSize) -> bool { self.comments .peek() - .map_or(true, |next| next.range.start() >= node_end) + .is_none_or(|next| next.range.start() >= node_end) } } @@ -195,6 +195,10 @@ where } } } + + fn visit_identifier(&mut self, _identifier: &'ast ruff_python_ast::Identifier) { + // Skip identifiers, matching the formatter comment extraction + } } #[derive(Clone, Debug)] diff --git a/crates/ruff_linter/src/rules/ruff/rules/test_rules.rs b/crates/ruff_linter/src/rules/ruff/rules/test_rules.rs index 43fd1f44c767b..38c82b5460af7 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/test_rules.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/test_rules.rs @@ -14,12 +14,12 @@ /// Rules that provide a fix _must_ not raise unconditionally or the linter /// will not converge. use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_trivia::CommentRanges; use ruff_text_size::TextSize; -use crate::registry::Rule; use crate::Locator; +use crate::registry::Rule; /// Check if a comment exists anywhere in a given file fn comment_exists(text: &str, locator: &Locator, comment_ranges: &CommentRanges) -> bool { @@ -66,15 +66,15 @@ pub(crate) trait TestRule { /// ```python /// bar /// ``` -#[violation] -pub struct StableTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct StableTestRule; impl Violation for StableTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a stable test rule.") + "Hey this is a stable test rule.".to_string() } } @@ -102,21 +102,21 @@ impl TestRule for StableTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct StableTestRuleSafeFix; +#[derive(ViolationMetadata)] +pub(crate) struct StableTestRuleSafeFix; impl Violation for StableTestRuleSafeFix { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a stable test rule with a safe fix.") + "Hey this is a stable test rule with a safe fix.".to_string() } } impl TestRule for StableTestRuleSafeFix { fn diagnostic(locator: &Locator, comment_ranges: &CommentRanges) -> Option<Diagnostic> { - let comment = format!("# fix from stable-test-rule-safe-fix\n"); + let comment = "# fix from stable-test-rule-safe-fix\n".to_string(); if comment_exists(&comment, locator, comment_ranges) { None } else { @@ -143,21 +143,21 @@ impl TestRule for StableTestRuleSafeFix { /// ```python /// bar /// ``` -#[violation] -pub struct StableTestRuleUnsafeFix; +#[derive(ViolationMetadata)] +pub(crate) struct StableTestRuleUnsafeFix; impl Violation for StableTestRuleUnsafeFix { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a stable test rule with an unsafe fix.") + "Hey this is a stable test rule with an unsafe fix.".to_string() } } impl TestRule for StableTestRuleUnsafeFix { fn diagnostic(locator: &Locator, comment_ranges: &CommentRanges) -> Option<Diagnostic> { - let comment = format!("# fix from stable-test-rule-unsafe-fix\n"); + let comment = "# fix from stable-test-rule-unsafe-fix\n".to_string(); if comment_exists(&comment, locator, comment_ranges) { None } else { @@ -187,21 +187,21 @@ impl TestRule for StableTestRuleUnsafeFix { /// ```python /// bar /// ``` -#[violation] -pub struct StableTestRuleDisplayOnlyFix; +#[derive(ViolationMetadata)] +pub(crate) struct StableTestRuleDisplayOnlyFix; impl Violation for StableTestRuleDisplayOnlyFix { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a stable test rule with a display only fix.") + "Hey this is a stable test rule with a display only fix.".to_string() } } impl TestRule for StableTestRuleDisplayOnlyFix { fn diagnostic(locator: &Locator, comment_ranges: &CommentRanges) -> Option<Diagnostic> { - let comment = format!("# fix from stable-test-rule-display-only-fix\n"); + let comment = "# fix from stable-test-rule-display-only-fix\n".to_string(); if comment_exists(&comment, locator, comment_ranges) { None } else { @@ -234,15 +234,15 @@ impl TestRule for StableTestRuleDisplayOnlyFix { /// ```python /// bar /// ``` -#[violation] -pub struct PreviewTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct PreviewTestRule; impl Violation for PreviewTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a preview test rule.") + "Hey this is a preview test rule.".to_string() } } @@ -270,15 +270,15 @@ impl TestRule for PreviewTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct DeprecatedTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct DeprecatedTestRule; impl Violation for DeprecatedTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a deprecated test rule.") + "Hey this is a deprecated test rule.".to_string() } } @@ -306,15 +306,15 @@ impl TestRule for DeprecatedTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct AnotherDeprecatedTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct AnotherDeprecatedTestRule; impl Violation for AnotherDeprecatedTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is another deprecated test rule.") + "Hey this is another deprecated test rule.".to_string() } } @@ -342,15 +342,15 @@ impl TestRule for AnotherDeprecatedTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct RemovedTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct RemovedTestRule; impl Violation for RemovedTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a removed test rule.") + "Hey this is a removed test rule.".to_string() } } @@ -378,15 +378,15 @@ impl TestRule for RemovedTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct AnotherRemovedTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct AnotherRemovedTestRule; impl Violation for AnotherRemovedTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a another removed test rule.") + "Hey this is a another removed test rule.".to_string() } } @@ -414,15 +414,15 @@ impl TestRule for AnotherRemovedTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct RedirectedFromTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct RedirectedFromTestRule; impl Violation for RedirectedFromTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a test rule that was redirected to another.") + "Hey this is a test rule that was redirected to another.".to_string() } } @@ -450,15 +450,15 @@ impl TestRule for RedirectedFromTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct RedirectedToTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct RedirectedToTestRule; impl Violation for RedirectedToTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a test rule that was redirected from another.") + "Hey this is a test rule that was redirected from another.".to_string() } } @@ -486,15 +486,15 @@ impl TestRule for RedirectedToTestRule { /// ```python /// bar /// ``` -#[violation] -pub struct RedirectedFromPrefixTestRule; +#[derive(ViolationMetadata)] +pub(crate) struct RedirectedFromPrefixTestRule; impl Violation for RedirectedFromPrefixTestRule { const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; #[derive_message_formats] fn message(&self) -> String { - format!("Hey this is a test rule that was redirected to another by prefix.") + "Hey this is a test rule that was redirected to another by prefix.".to_string() } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_cast_to_int.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_cast_to_int.rs new file mode 100644 index 0000000000000..4b97745a3a03f --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_cast_to_int.rs @@ -0,0 +1,304 @@ +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::parenthesize::parenthesized_range; +use ruff_python_ast::{Arguments, Expr, ExprCall}; +use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; +use ruff_python_trivia::{CommentRanges, lines_after_ignoring_trivia}; +use ruff_source_file::LineRanges; +use ruff_text_size::{Ranged, TextRange}; + +use crate::Locator; +use crate::checkers::ast::Checker; +use crate::rules::ruff::rules::unnecessary_round::{ + InferredType, NdigitsValue, RoundedValue, rounded_and_ndigits, +}; + +/// ## What it does +/// Checks for `int` conversions of values that are already integers. +/// +/// ## Why is this bad? +/// Such a conversion is unnecessary. +/// +/// ## Known problems +/// This rule may produce false positives for `round`, `math.ceil`, `math.floor`, +/// and `math.trunc` calls when values override the `__round__`, `__ceil__`, `__floor__`, +/// or `__trunc__` operators such that they don't return an integer. +/// +/// ## Example +/// +/// ```python +/// int(len([])) +/// int(round(foo, None)) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// len([]) +/// round(foo) +/// ``` +/// +/// ## Fix safety +/// The fix for `round`, `math.ceil`, `math.floor`, and `math.truncate` is unsafe +/// because removing the `int` conversion can change the semantics for values +/// overriding the `__round__`, `__ceil__`, `__floor__`, or `__trunc__` dunder methods +/// such that they don't return an integer. +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryCastToInt; + +impl AlwaysFixableViolation for UnnecessaryCastToInt { + #[derive_message_formats] + fn message(&self) -> String { + "Value being cast to `int` is already an integer".to_string() + } + + fn fix_title(&self) -> String { + "Remove unnecessary `int` call".to_string() + } +} + +/// RUF046 +pub(crate) fn unnecessary_cast_to_int(checker: &Checker, call: &ExprCall) { + let Some(argument) = single_argument_to_int_call(call, checker.semantic()) else { + return; + }; + + let applicability = if matches!( + ResolvedPythonType::from(argument), + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) + ) { + Some(Applicability::Safe) + } else if let Expr::Call(inner_call) = argument { + call_applicability(checker, inner_call) + } else { + None + }; + + let Some(applicability) = applicability else { + return; + }; + + let fix = unwrap_int_expression( + call, + argument, + applicability, + checker.semantic(), + checker.locator(), + checker.comment_ranges(), + checker.source(), + ); + let diagnostic = Diagnostic::new(UnnecessaryCastToInt, call.range()); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +/// Creates a fix that replaces `int(expression)` with `expression`. +fn unwrap_int_expression( + call: &ExprCall, + argument: &Expr, + applicability: Applicability, + semantic: &SemanticModel, + locator: &Locator, + comment_ranges: &CommentRanges, + source: &str, +) -> Fix { + let content = if let Some(range) = parenthesized_range( + argument.into(), + (&call.arguments).into(), + comment_ranges, + source, + ) { + locator.slice(range).to_string() + } else { + let parenthesize = semantic.current_expression_parent().is_some() + || argument.is_named_expr() + || locator.count_lines(argument.range()) > 0; + if parenthesize && !has_own_parentheses(argument, comment_ranges, source) { + format!("({})", locator.slice(argument.range())) + } else { + locator.slice(argument.range()).to_string() + } + }; + + // Since we're deleting the complement of the argument range within + // the call range, we have to check both ends for comments. + // + // For example: + // ```python + // int( # comment + // round( + // 42.1 + // ) # comment + // ) + // ``` + let applicability = { + let call_to_arg_start = TextRange::new(call.start(), argument.start()); + let arg_to_call_end = TextRange::new(argument.end(), call.end()); + if comment_ranges.intersects(call_to_arg_start) + || comment_ranges.intersects(arg_to_call_end) + { + Applicability::Unsafe + } else { + applicability + } + }; + + let edit = Edit::range_replacement(content, call.range()); + Fix::applicable_edit(edit, applicability) +} + +/// Returns `Some` if `call` in `int(call(...))` is a method that returns an `int` +/// and `None` otherwise. +fn call_applicability(checker: &Checker, inner_call: &ExprCall) -> Option<Applicability> { + let (func, arguments) = (&inner_call.func, &inner_call.arguments); + + let qualified_name = checker.semantic().resolve_qualified_name(func)?; + + match qualified_name.segments() { + // Always returns a strict instance of `int` + ["" | "builtins", "len" | "id" | "hash" | "ord" | "int"] + | [ + "math", + "comb" | "factorial" | "gcd" | "lcm" | "isqrt" | "perm", + ] => Some(Applicability::Safe), + + // Depends on `ndigits` and `number.__round__` + ["" | "builtins", "round"] => round_applicability(arguments, checker.semantic()), + + // Depends on `__ceil__`/`__floor__`/`__trunc__` + ["math", "ceil" | "floor" | "trunc"] => Some(Applicability::Unsafe), + + _ => None, + } +} + +fn single_argument_to_int_call<'a>( + call: &'a ExprCall, + semantic: &SemanticModel, +) -> Option<&'a Expr> { + let ExprCall { + func, arguments, .. + } = call; + + if !semantic.match_builtin_expr(func, "int") { + return None; + } + + if !arguments.keywords.is_empty() { + return None; + } + + let [argument] = &*arguments.args else { + return None; + }; + + Some(argument) +} + +/// Determines the [`Applicability`] for a `round(..)` call. +/// +/// The Applicability depends on the `ndigits` and the number argument. +fn round_applicability(arguments: &Arguments, semantic: &SemanticModel) -> Option<Applicability> { + let (_rounded, rounded_value, ndigits_value) = rounded_and_ndigits(arguments, semantic)?; + + match (rounded_value, ndigits_value) { + // ```python + // int(round(2, -1)) + // int(round(2, 0)) + // int(round(2)) + // int(round(2, None)) + // ``` + ( + RoundedValue::Int(InferredType::Equivalent), + NdigitsValue::LiteralInt { .. } + | NdigitsValue::Int(InferredType::Equivalent) + | NdigitsValue::NotGivenOrNone, + ) => Some(Applicability::Safe), + + // ```python + // int(round(2.0)) + // int(round(2.0, None)) + // ``` + (RoundedValue::Float(InferredType::Equivalent), NdigitsValue::NotGivenOrNone) => { + Some(Applicability::Safe) + } + + // ```python + // a: int = 2 # or True + // int(round(a, -2)) + // int(round(a, 1)) + // int(round(a)) + // int(round(a, None)) + // ``` + ( + RoundedValue::Int(InferredType::AssignableTo), + NdigitsValue::LiteralInt { .. } + | NdigitsValue::Int(InferredType::Equivalent) + | NdigitsValue::NotGivenOrNone, + ) => Some(Applicability::Unsafe), + + // ```python + // int(round(2.0)) + // int(round(2.0, None)) + // int(round(x)) + // int(round(x, None)) + // ``` + ( + RoundedValue::Float(InferredType::AssignableTo) | RoundedValue::Other, + NdigitsValue::NotGivenOrNone, + ) => Some(Applicability::Unsafe), + + _ => None, + } +} + +/// Returns `true` if the given [`Expr`] has its own parentheses (e.g., `()`, `[]`, `{}`). +fn has_own_parentheses(expr: &Expr, comment_ranges: &CommentRanges, source: &str) -> bool { + match expr { + Expr::ListComp(_) + | Expr::SetComp(_) + | Expr::DictComp(_) + | Expr::List(_) + | Expr::Set(_) + | Expr::Dict(_) => true, + Expr::Call(call_expr) => { + // A call where the function and parenthesized + // argument(s) appear on separate lines + // requires outer parentheses. That is: + // ``` + // (f + // (10)) + // ``` + // is different than + // ``` + // f + // (10) + // ``` + let func_end = parenthesized_range( + call_expr.func.as_ref().into(), + call_expr.into(), + comment_ranges, + source, + ) + .unwrap_or(call_expr.func.range()) + .end(); + lines_after_ignoring_trivia(func_end, source) == 0 + } + Expr::Subscript(subscript_expr) => { + // Same as above + let subscript_end = parenthesized_range( + subscript_expr.value.as_ref().into(), + subscript_expr.into(), + comment_ranges, + source, + ) + .unwrap_or(subscript_expr.value.range()) + .end(); + lines_after_ignoring_trivia(subscript_end, source) == 0 + } + Expr::Generator(generator) => generator.parenthesized, + Expr::Tuple(tuple) => tuple.parenthesized, + _ => false, + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_iterable_allocation_for_first_element.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_iterable_allocation_for_first_element.rs index 1bb91c820216a..f01e6aca119da 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_iterable_allocation_for_first_element.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_iterable_allocation_for_first_element.rs @@ -1,7 +1,7 @@ use std::borrow::Cow; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Comprehension, Expr, Int}; use ruff_python_semantic::SemanticModel; use ruff_python_stdlib::builtins::is_iterator; @@ -53,7 +53,7 @@ use crate::fix::snippet::SourceCodeSnippet; /// /// ## References /// - [Iterators and Iterables in Python: Run Efficient Iterations](https://realpython.com/python-iterators-iterables/#when-to-use-an-iterator-in-python) -#[violation] +#[derive(ViolationMetadata)] pub(crate) struct UnnecessaryIterableAllocationForFirstElement { iterable: SourceCodeSnippet, } @@ -61,23 +61,18 @@ pub(crate) struct UnnecessaryIterableAllocationForFirstElement { impl AlwaysFixableViolation for UnnecessaryIterableAllocationForFirstElement { #[derive_message_formats] fn message(&self) -> String { - let UnnecessaryIterableAllocationForFirstElement { iterable } = self; - let iterable = iterable.truncated_display(); + let iterable = &self.iterable.truncated_display(); format!("Prefer `next({iterable})` over single element slice") } fn fix_title(&self) -> String { - let UnnecessaryIterableAllocationForFirstElement { iterable } = self; - let iterable = iterable.truncated_display(); + let iterable = &self.iterable.truncated_display(); format!("Replace with `next({iterable})`") } } /// RUF015 -pub(crate) fn unnecessary_iterable_allocation_for_first_element( - checker: &mut Checker, - expr: &Expr, -) { +pub(crate) fn unnecessary_iterable_allocation_for_first_element(checker: &Checker, expr: &Expr) { let value = match expr { // Ex) `list(x)[0]` Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { @@ -132,7 +127,7 @@ pub(crate) fn unnecessary_iterable_allocation_for_first_element( expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } /// Check that the slice [`Expr`] is a slice of the first element (e.g., `x[0]`). @@ -268,9 +263,11 @@ fn match_iteration_target(expr: &Expr, semantic: &SemanticModel) -> Option<Itera /// Returns the [`Expr`] target for a comprehension, if the comprehension is "simple" /// (e.g., `x` for `[i for i in x]`). fn match_simple_comprehension(elt: &Expr, generators: &[Comprehension]) -> Option<TextRange> { - let [generator @ Comprehension { - is_async: false, .. - }] = generators + let [ + generator @ Comprehension { + is_async: false, .. + }, + ] = generators else { return None; }; diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_key_check.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_key_check.rs index bd939d354a2e8..34d1d9f9d0ae9 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_key_check.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_key_check.rs @@ -2,7 +2,7 @@ use ruff_python_ast::comparable::ComparableExpr; use ruff_python_ast::{self as ast, BoolOp, CmpOp, Expr}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::contains_effect; use ruff_python_ast::parenthesize::parenthesized_range; use ruff_text_size::Ranged; @@ -17,7 +17,7 @@ use crate::checkers::ast::Checker; /// without having to check if the dictionary contains the relevant key, /// returning `None` if the key is not present. /// -/// ## Examples +/// ## Example /// ```python /// if "key" in dct and dct["key"]: /// ... @@ -28,22 +28,22 @@ use crate::checkers::ast::Checker; /// if dct.get("key"): /// ... /// ``` -#[violation] -pub struct UnnecessaryKeyCheck; +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryKeyCheck; impl AlwaysFixableViolation for UnnecessaryKeyCheck { #[derive_message_formats] fn message(&self) -> String { - format!("Unnecessary key check before dictionary access") + "Unnecessary key check before dictionary access".to_string() } fn fix_title(&self) -> String { - format!("Replace with `dict.get`") + "Replace with `dict.get`".to_string() } } /// RUF019 -pub(crate) fn unnecessary_key_check(checker: &mut Checker, expr: &Expr) { +pub(crate) fn unnecessary_key_check(checker: &Checker, expr: &Expr) { if !checker.semantic().in_boolean_test() { return; } @@ -127,5 +127,5 @@ pub(crate) fn unnecessary_key_check(checker: &mut Checker, expr: &Expr) { ), expr.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_literal_within_deque_call.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_literal_within_deque_call.rs new file mode 100644 index 0000000000000..eeef2580c6f6c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_literal_within_deque_call.rs @@ -0,0 +1,120 @@ +use crate::checkers::ast::Checker; +use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{self as ast, Expr}; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for usages of `collections.deque` that have an empty iterable as the first argument. +/// +/// ## Why is this bad? +/// It's unnecessary to use an empty literal as a deque's iterable, since this is already the default behavior. +/// +/// ## Example +/// +/// ```python +/// from collections import deque +/// +/// queue = deque(set()) +/// queue = deque([], 10) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// from collections import deque +/// +/// queue = deque() +/// queue = deque(maxlen=10) +/// ``` +/// +/// ## References +/// - [Python documentation: `collections.deque`](https://docs.python.org/3/library/collections.html#collections.deque) +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryEmptyIterableWithinDequeCall { + has_maxlen: bool, +} + +impl AlwaysFixableViolation for UnnecessaryEmptyIterableWithinDequeCall { + #[derive_message_formats] + fn message(&self) -> String { + "Unnecessary empty iterable within a deque call".to_string() + } + + fn fix_title(&self) -> String { + let title = if self.has_maxlen { + "Replace with `deque(maxlen=...)`" + } else { + "Replace with `deque()`" + }; + title.to_string() + } +} + +/// RUF037 +pub(crate) fn unnecessary_literal_within_deque_call(checker: &Checker, deque: &ast::ExprCall) { + let ast::ExprCall { + func, arguments, .. + } = deque; + + let Some(qualified) = checker.semantic().resolve_qualified_name(func) else { + return; + }; + if !matches!(qualified.segments(), ["collections", "deque"]) || arguments.len() > 2 { + return; + } + + let Some(iterable) = arguments.find_argument_value("iterable", 0) else { + return; + }; + + let maxlen = arguments.find_argument_value("maxlen", 1); + + let is_empty_literal = match iterable { + Expr::Dict(dict) => dict.is_empty(), + Expr::List(list) => list.is_empty(), + Expr::Tuple(tuple) => tuple.is_empty(), + Expr::Call(call) => { + checker + .semantic() + .resolve_builtin_symbol(&call.func) + // other lints should handle empty list/dict/tuple calls, + // but this means that the lint still applies before those are fixed + .is_some_and(|name| { + name == "set" || name == "list" || name == "dict" || name == "tuple" + }) + && call.arguments.is_empty() + } + _ => false, + }; + if !is_empty_literal { + return; + } + + let mut diagnostic = Diagnostic::new( + UnnecessaryEmptyIterableWithinDequeCall { + has_maxlen: maxlen.is_some(), + }, + deque.range, + ); + + diagnostic.set_fix(fix_unnecessary_literal_in_deque(checker, deque, maxlen)); + + checker.report_diagnostic(diagnostic); +} + +fn fix_unnecessary_literal_in_deque( + checker: &Checker, + deque: &ast::ExprCall, + maxlen: Option<&Expr>, +) -> Fix { + let deque_name = checker.locator().slice(deque.func.range()); + let deque_str = match maxlen { + Some(maxlen) => { + let len_str = checker.locator().slice(maxlen); + format!("{deque_name}(maxlen={len_str})") + } + None => format!("{deque_name}()"), + }; + Fix::safe_edit(Edit::range_replacement(deque_str, deque.range)) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_nested_literal.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_nested_literal.rs new file mode 100644 index 0000000000000..a40bb723cbfaa --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_nested_literal.rs @@ -0,0 +1,139 @@ +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{AnyNodeRef, Expr, ExprContext, ExprSubscript, ExprTuple}; +use ruff_python_semantic::analyze::typing::traverse_literal; +use ruff_text_size::{Ranged, TextRange}; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for unnecessary nested `Literal`. +/// +/// ## Why is this bad? +/// Prefer using a single `Literal`, which is equivalent and more concise. +/// +/// Parameterization of literals by other literals is supported as an ergonomic +/// feature as proposed in [PEP 586], to enable patterns such as: +/// ```python +/// ReadOnlyMode = Literal["r", "r+"] +/// WriteAndTruncateMode = Literal["w", "w+", "wt", "w+t"] +/// WriteNoTruncateMode = Literal["r+", "r+t"] +/// AppendMode = Literal["a", "a+", "at", "a+t"] +/// +/// AllModes = Literal[ReadOnlyMode, WriteAndTruncateMode, +/// WriteNoTruncateMode, AppendMode] +/// ``` +/// +/// As a consequence, type checkers also support nesting of literals +/// which is less readable than a flat `Literal`: +/// ```python +/// AllModes = Literal[Literal["r", "r+"], Literal["w", "w+", "wt", "w+t"], +/// Literal["r+", "r+t"], Literal["a", "a+", "at", "a+t"]] +/// ``` +/// +/// ## Example +/// ```python +/// AllModes = Literal[ +/// Literal["r", "r+"], +/// Literal["w", "w+", "wt", "w+t"], +/// Literal["r+", "r+t"], +/// Literal["a", "a+", "at", "a+t"], +/// ] +/// ``` +/// +/// Use instead: +/// ```python +/// AllModes = Literal[ +/// "r", "r+", "w", "w+", "wt", "w+t", "r+", "r+t", "a", "a+", "at", "a+t" +/// ] +/// ``` +/// +/// or assign the literal to a variable as in the first example. +/// +/// ## Fix safety +/// The fix for this rule is marked as unsafe when the `Literal` slice is split +/// across multiple lines and some of the lines have trailing comments. +/// +/// ## References +/// - [Typing documentation: Legal parameters for `Literal` at type check time](https://typing.python.org/en/latest/spec/literal.html#legal-parameters-for-literal-at-type-check-time) +/// +/// [PEP 586](https://peps.python.org/pep-0586/) +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryNestedLiteral; + +impl Violation for UnnecessaryNestedLiteral { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Unnecessary nested `Literal`".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some("Replace with flattened `Literal`".to_string()) + } +} + +/// RUF039 +pub(crate) fn unnecessary_nested_literal<'a>(checker: &Checker, literal_expr: &'a Expr) { + let mut is_nested = false; + + // Traverse the type expressions in the `Literal`. + traverse_literal( + &mut |_: &'a Expr, parent: &'a Expr| { + // If the parent is not equal to the `literal_expr` then we know we are traversing recursively. + if !AnyNodeRef::ptr_eq(parent.into(), literal_expr.into()) { + is_nested = true; + } + }, + checker.semantic(), + literal_expr, + ); + + if !is_nested { + return; + } + + // Collect the literal nodes for the fix + let mut nodes: Vec<&Expr> = Vec::new(); + + traverse_literal( + &mut |expr, _| { + nodes.push(expr); + }, + checker.semantic(), + literal_expr, + ); + + let mut diagnostic = Diagnostic::new(UnnecessaryNestedLiteral, literal_expr.range()); + + // Create a [`Fix`] that flattens all nodes. + if let Expr::Subscript(subscript) = literal_expr { + let subscript = Expr::Subscript(ExprSubscript { + slice: Box::new(if let [elt] = nodes.as_slice() { + (*elt).clone() + } else { + Expr::Tuple(ExprTuple { + elts: nodes.into_iter().cloned().collect(), + range: TextRange::default(), + ctx: ExprContext::Load, + parenthesized: false, + }) + }), + value: subscript.value.clone(), + range: TextRange::default(), + ctx: ExprContext::Load, + }); + let fix = Fix::applicable_edit( + Edit::range_replacement(checker.generator().expr(&subscript), literal_expr.range()), + if checker.comment_ranges().intersects(literal_expr.range()) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + ); + diagnostic.set_fix(fix); + } + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_regular_expression.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_regular_expression.rs new file mode 100644 index 0000000000000..2c9c7ed247bf7 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_regular_expression.rs @@ -0,0 +1,379 @@ +use itertools::Itertools; +use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + Arguments, CmpOp, Expr, ExprAttribute, ExprCall, ExprCompare, ExprContext, ExprStringLiteral, + ExprUnaryOp, Identifier, UnaryOp, +}; +use ruff_python_semantic::analyze::typing::find_binding_value; +use ruff_python_semantic::{Modules, SemanticModel}; +use ruff_text_size::TextRange; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// +/// Checks for uses of the `re` module that can be replaced with builtin `str` methods. +/// +/// ## Why is this bad? +/// +/// Performing checks on strings directly can make the code simpler, may require +/// less escaping, and will often be faster. +/// +/// ## Example +/// +/// ```python +/// re.sub("abc", "", s) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// s.replace("abc", "") +/// ``` +/// +/// ## Details +/// +/// The rule reports the following calls when the first argument to the call is +/// a plain string literal, and no additional flags are passed: +/// +/// - `re.sub` +/// - `re.match` +/// - `re.search` +/// - `re.fullmatch` +/// - `re.split` +/// +/// For `re.sub`, the `repl` (replacement) argument must also be a string literal, +/// not a function. For `re.match`, `re.search`, and `re.fullmatch`, the return +/// value must also be used only for its truth value. +/// +/// ## Fix safety +/// +/// This rule's fix is marked as unsafe if the affected expression contains comments. Otherwise, +/// the fix can be applied safely. +/// +/// ## References +/// - [Python Regular Expression HOWTO: Common Problems - Use String Methods](https://docs.python.org/3/howto/regex.html#use-string-methods) +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryRegularExpression { + replacement: Option<String>, +} + +impl Violation for UnnecessaryRegularExpression { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + "Plain string pattern passed to `re` function".to_string() + } + + fn fix_title(&self) -> Option<String> { + Some(format!("Replace with `{}`", self.replacement.as_ref()?)) + } +} + +/// RUF055 +pub(crate) fn unnecessary_regular_expression(checker: &Checker, call: &ExprCall) { + // adapted from unraw_re_pattern + let semantic = checker.semantic(); + + if !semantic.seen_module(Modules::RE) { + return; + } + + let Some(qualified_name) = semantic.resolve_qualified_name(&call.func) else { + return; + }; + + let ["re", func] = qualified_name.segments() else { + return; + }; + + // skip calls with more than `pattern` and `string` arguments (and `repl` + // for `sub`) + let Some(re_func) = ReFunc::from_call_expr(semantic, call, func) else { + return; + }; + + // For now, restrict this rule to string literals and variables that can be resolved to literals + let Some(string_lit) = resolve_string_literal(re_func.pattern, semantic) else { + return; + }; + + // For now, reject any regex metacharacters. Compare to the complete list + // from https://docs.python.org/3/howto/regex.html#matching-characters + let has_metacharacters = string_lit + .value + .to_str() + .contains(['.', '^', '$', '*', '+', '?', '{', '[', '\\', '|', '(', ')']); + + if has_metacharacters { + return; + } + + // Now we know the pattern is a string literal with no metacharacters, so + // we can proceed with the str method replacement. + let new_expr = re_func.replacement(); + + let repl = new_expr.map(|expr| checker.generator().expr(&expr)); + let mut diagnostic = Diagnostic::new( + UnnecessaryRegularExpression { + replacement: repl.clone(), + }, + re_func.range, + ); + + if let Some(repl) = repl { + diagnostic.set_fix(Fix::applicable_edit( + Edit::range_replacement(repl, re_func.range), + if checker.comment_ranges().intersects(re_func.range) { + Applicability::Unsafe + } else { + Applicability::Safe + }, + )); + } + + checker.report_diagnostic(diagnostic); +} + +/// The `re` functions supported by this rule. +#[derive(Debug)] +enum ReFuncKind<'a> { + // Only `Some` if it's a fixable `re.sub()` call + Sub { repl: Option<&'a Expr> }, + Match, + Search, + Fullmatch, + Split, +} + +#[derive(Debug)] +struct ReFunc<'a> { + kind: ReFuncKind<'a>, + pattern: &'a Expr, + string: &'a Expr, + comparison_to_none: Option<ComparisonToNone>, + range: TextRange, +} + +impl<'a> ReFunc<'a> { + fn from_call_expr( + semantic: &'a SemanticModel, + call: &'a ExprCall, + func_name: &str, + ) -> Option<Self> { + // the proposed fixes for match, search, and fullmatch rely on the + // return value only being used for its truth value or being compared to None + let comparison_to_none = get_comparison_to_none(semantic); + let in_truthy_context = semantic.in_boolean_test() || comparison_to_none.is_some(); + + let (comparison_to_none, range) = match comparison_to_none { + Some((cmp, range)) => (Some(cmp), range), + None => (None, call.range), + }; + + match (func_name, call.arguments.len()) { + // `split` is the safest of these to fix, as long as metacharacters + // have already been filtered out from the `pattern` + ("split", 2) => Some(ReFunc { + kind: ReFuncKind::Split, + pattern: call.arguments.find_argument_value("pattern", 0)?, + string: call.arguments.find_argument_value("string", 1)?, + comparison_to_none, + range, + }), + // `sub` is only safe to fix if `repl` is a string. `re.sub` also + // allows it to be a function, which will *not* work in the str + // version + ("sub", 3) => { + let repl = call.arguments.find_argument_value("repl", 1)?; + let lit = resolve_string_literal(repl, semantic)?; + let mut fixable = true; + for (c, next) in lit.value.chars().tuple_windows() { + // `\0` (or any other ASCII digit) and `\g` have special meaning in `repl` strings. + // Meanwhile, nearly all other escapes of ASCII letters in a `repl` string causes + // `re.PatternError` to be raised at runtime. + // + // If we see that the escaped character is an alphanumeric ASCII character, + // we should only emit a diagnostic suggesting to replace the `re.sub()` call with + // `str.replace`if we can detect that the escaped character is one that is both + // valid in a `repl` string *and* does not have any special meaning in a REPL string. + // + // It's out of scope for this rule to change invalid `re.sub()` calls into something + // that would not raise an exception at runtime. They should be left as-is. + if c == '\\' && next.is_ascii_alphanumeric() { + if "abfnrtv".contains(next) { + fixable = false; + } else { + return None; + } + } + } + Some(ReFunc { + kind: ReFuncKind::Sub { + repl: fixable.then_some(repl), + }, + pattern: call.arguments.find_argument_value("pattern", 0)?, + string: call.arguments.find_argument_value("string", 2)?, + comparison_to_none, + range, + }) + } + ("match", 2) if in_truthy_context => Some(ReFunc { + kind: ReFuncKind::Match, + pattern: call.arguments.find_argument_value("pattern", 0)?, + string: call.arguments.find_argument_value("string", 1)?, + comparison_to_none, + range, + }), + ("search", 2) if in_truthy_context => Some(ReFunc { + kind: ReFuncKind::Search, + pattern: call.arguments.find_argument_value("pattern", 0)?, + string: call.arguments.find_argument_value("string", 1)?, + comparison_to_none, + range, + }), + ("fullmatch", 2) if in_truthy_context => Some(ReFunc { + kind: ReFuncKind::Fullmatch, + pattern: call.arguments.find_argument_value("pattern", 0)?, + string: call.arguments.find_argument_value("string", 1)?, + comparison_to_none, + range, + }), + _ => None, + } + } + + /// Get replacement for the call or parent expression. + /// + /// Examples: + /// `re.search("abc", s) is None` => `"abc" not in s` + /// `re.search("abc", s)` => `"abc" in s` + fn replacement(&self) -> Option<Expr> { + match (&self.kind, &self.comparison_to_none) { + // string.replace(pattern, repl) + (ReFuncKind::Sub { repl }, _) => repl + .cloned() + .map(|repl| self.method_expr("replace", vec![self.pattern.clone(), repl])), + // string.split(pattern) + (ReFuncKind::Split, _) => Some(self.method_expr("split", vec![self.pattern.clone()])), + // pattern in string + (ReFuncKind::Search, None | Some(ComparisonToNone::IsNot)) => { + Some(ReFunc::compare_expr(self.pattern, CmpOp::In, self.string)) + } + // pattern not in string + (ReFuncKind::Search, Some(ComparisonToNone::Is)) => Some(ReFunc::compare_expr( + self.pattern, + CmpOp::NotIn, + self.string, + )), + // string.startswith(pattern) + (ReFuncKind::Match, None | Some(ComparisonToNone::IsNot)) => { + Some(self.method_expr("startswith", vec![self.pattern.clone()])) + } + // not string.startswith(pattern) + (ReFuncKind::Match, Some(ComparisonToNone::Is)) => { + let expr = self.method_expr("startswith", vec![self.pattern.clone()]); + let negated_expr = Expr::UnaryOp(ExprUnaryOp { + op: UnaryOp::Not, + operand: Box::new(expr), + range: TextRange::default(), + }); + Some(negated_expr) + } + // string == pattern + (ReFuncKind::Fullmatch, None | Some(ComparisonToNone::IsNot)) => { + Some(ReFunc::compare_expr(self.string, CmpOp::Eq, self.pattern)) + } + // string != pattern + (ReFuncKind::Fullmatch, Some(ComparisonToNone::Is)) => Some(ReFunc::compare_expr( + self.string, + CmpOp::NotEq, + self.pattern, + )), + } + } + + /// Return a new compare expr of the form `left op right` + fn compare_expr(left: &Expr, op: CmpOp, right: &Expr) -> Expr { + Expr::Compare(ExprCompare { + left: Box::new(left.clone()), + ops: Box::new([op]), + comparators: Box::new([right.clone()]), + range: TextRange::default(), + }) + } + + /// Return a new method call expression on `self.string` with `args` like + /// `self.string.method(args...)` + fn method_expr(&self, method: &str, args: Vec<Expr>) -> Expr { + let method = Expr::Attribute(ExprAttribute { + value: Box::new(self.string.clone()), + attr: Identifier::new(method, TextRange::default()), + ctx: ExprContext::Load, + range: TextRange::default(), + }); + Expr::Call(ExprCall { + func: Box::new(method), + arguments: Arguments { + args: args.into_boxed_slice(), + keywords: Box::new([]), + range: TextRange::default(), + }, + range: TextRange::default(), + }) + } +} + +/// Try to resolve `name` to an [`ExprStringLiteral`] in `semantic`. +fn resolve_string_literal<'a>( + name: &'a Expr, + semantic: &'a SemanticModel, +) -> Option<&'a ExprStringLiteral> { + if name.is_string_literal_expr() { + return name.as_string_literal_expr(); + } + + if let Some(name_expr) = name.as_name_expr() { + let binding = semantic.binding(semantic.only_binding(name_expr)?); + let value = find_binding_value(binding, semantic)?; + if value.is_string_literal_expr() { + return value.as_string_literal_expr(); + } + } + + None +} + +#[derive(Clone, Copy, Debug)] +enum ComparisonToNone { + Is, + IsNot, +} + +/// If the regex call is compared to `None`, return the comparison and its range. +/// Example: `re.search("abc", s) is None` +fn get_comparison_to_none(semantic: &SemanticModel) -> Option<(ComparisonToNone, TextRange)> { + let parent_expr = semantic.current_expression_parent()?; + + let Expr::Compare(ExprCompare { + ops, + comparators, + range, + .. + }) = parent_expr + else { + return None; + }; + + let Some(Expr::NoneLiteral(_)) = comparators.first() else { + return None; + }; + + match ops.as_ref() { + [CmpOp::Is] => Some((ComparisonToNone::Is, *range)), + [CmpOp::IsNot] => Some((ComparisonToNone::IsNot, *range)), + _ => None, + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unnecessary_round.rs b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_round.rs new file mode 100644 index 0000000000000..009d875ba16b7 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unnecessary_round.rs @@ -0,0 +1,219 @@ +use crate::Locator; +use crate::checkers::ast::Checker; +use ruff_diagnostics::{AlwaysFixableViolation, Applicability, Diagnostic, Edit, Fix}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{Arguments, Expr, ExprCall, ExprNumberLiteral, Number}; +use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; +use ruff_python_semantic::analyze::typing; +use ruff_source_file::find_newline; +use ruff_text_size::Ranged; + +/// ## What it does +/// Checks for `round()` calls that have no effect on the input. +/// +/// ## Why is this bad? +/// Rounding a value that's already an integer is unnecessary. +/// It's clearer to use the value directly. +/// +/// ## Example +/// +/// ```python +/// a = round(1, 0) +/// ``` +/// +/// Use instead: +/// +/// ```python +/// a = 1 +/// ``` +/// +/// ## Fix safety +/// +/// The fix is marked unsafe if it is not possible to guarantee that the first argument of +/// `round()` is of type `int`, or if the fix deletes comments. +/// +#[derive(ViolationMetadata)] +pub(crate) struct UnnecessaryRound; + +impl AlwaysFixableViolation for UnnecessaryRound { + #[derive_message_formats] + fn message(&self) -> String { + "Value being rounded is already an integer".to_string() + } + + fn fix_title(&self) -> String { + "Remove unnecessary `round` call".to_string() + } +} + +/// RUF057 +pub(crate) fn unnecessary_round(checker: &Checker, call: &ExprCall) { + if !checker.semantic().match_builtin_expr(&call.func, "round") { + return; + } + + let Some((rounded, rounded_value, ndigits_value)) = + rounded_and_ndigits(&call.arguments, checker.semantic()) + else { + return; + }; + + if !matches!( + ndigits_value, + NdigitsValue::NotGivenOrNone | NdigitsValue::LiteralInt { is_negative: false } + ) { + return; + } + + let mut applicability = match rounded_value { + // ```python + // some_int: int + // + // rounded(1) + // rounded(1, None) + // rounded(1, 42) + // rounded(1, 4 + 2) + // rounded(1, some_int) + // ``` + RoundedValue::Int(InferredType::Equivalent) => Applicability::Safe, + + // ```python + // some_int: int + // some_other_int: int + // + // rounded(some_int) + // rounded(some_int, None) + // rounded(some_int, 42) + // rounded(some_int, 4 + 2) + // rounded(some_int, some_other_int) + // ``` + RoundedValue::Int(InferredType::AssignableTo) => Applicability::Unsafe, + + _ => return, + }; + + if checker.comment_ranges().intersects(call.range()) { + applicability = Applicability::Unsafe; + } + + let edit = unwrap_round_call(call, rounded, checker.semantic(), checker.locator()); + let fix = Fix::applicable_edit(edit, applicability); + + let diagnostic = Diagnostic::new(UnnecessaryRound, call.range()); + + checker.report_diagnostic(diagnostic.with_fix(fix)); +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(super) enum InferredType { + /// The value is an exact instance of the type in question. + Equivalent, + /// The value is an instance of the type in question or a subtype thereof. + AssignableTo, +} + +/// The type of the first argument to `round()` +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(super) enum RoundedValue { + Int(InferredType), + Float(InferredType), + Other, +} + +/// The type of the second argument to `round()` +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(super) enum NdigitsValue { + NotGivenOrNone, + LiteralInt { is_negative: bool }, + Int(InferredType), + Other, +} + +/// Extracts the rounded and `ndigits` values from `arguments`. +/// +/// Returns a tripled where the first element is the rounded value's expression, the second is the rounded value, +///and the third is the `ndigits` value. +pub(super) fn rounded_and_ndigits<'a>( + arguments: &'a Arguments, + semantic: &'a SemanticModel, +) -> Option<(&'a Expr, RoundedValue, NdigitsValue)> { + if arguments.len() > 2 { + return None; + } + + let rounded = arguments.find_argument_value("number", 0)?; + let ndigits = arguments.find_argument_value("ndigits", 1); + + let rounded_kind = match rounded { + Expr::Name(name) => match semantic.only_binding(name).map(|id| semantic.binding(id)) { + Some(binding) if typing::is_int(binding, semantic) => { + RoundedValue::Int(InferredType::AssignableTo) + } + Some(binding) if typing::is_float(binding, semantic) => { + RoundedValue::Float(InferredType::AssignableTo) + } + _ => RoundedValue::Other, + }, + + _ => match ResolvedPythonType::from(rounded) { + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) => { + RoundedValue::Int(InferredType::Equivalent) + } + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Float)) => { + RoundedValue::Float(InferredType::Equivalent) + } + _ => RoundedValue::Other, + }, + }; + + let ndigits_kind = match ndigits { + None | Some(Expr::NoneLiteral(_)) => NdigitsValue::NotGivenOrNone, + + Some(Expr::Name(name)) => { + match semantic.only_binding(name).map(|id| semantic.binding(id)) { + Some(binding) if typing::is_int(binding, semantic) => { + NdigitsValue::Int(InferredType::AssignableTo) + } + _ => NdigitsValue::Other, + } + } + + Some(Expr::NumberLiteral(ExprNumberLiteral { + value: Number::Int(int), + .. + })) => match int.as_i64() { + None => NdigitsValue::Int(InferredType::Equivalent), + Some(value) => NdigitsValue::LiteralInt { + is_negative: value < 0, + }, + }, + + Some(ndigits) => match ResolvedPythonType::from(ndigits) { + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)) => { + NdigitsValue::Int(InferredType::Equivalent) + } + _ => NdigitsValue::Other, + }, + }; + + Some((rounded, rounded_kind, ndigits_kind)) +} + +fn unwrap_round_call( + call: &ExprCall, + rounded: &Expr, + semantic: &SemanticModel, + locator: &Locator, +) -> Edit { + let rounded_expr = locator.slice(rounded.range()); + let has_parent_expr = semantic.current_expression_parent().is_some(); + let new_content = + if has_parent_expr || rounded.is_named_expr() || find_newline(rounded_expr).is_some() { + format!("({rounded_expr})") + } else { + rounded_expr.to_string() + }; + + Edit::range_replacement(new_content, call.range) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unraw_re_pattern.rs b/crates/ruff_linter/src/rules/ruff/rules/unraw_re_pattern.rs new file mode 100644 index 0000000000000..18135f9bb9046 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unraw_re_pattern.rs @@ -0,0 +1,194 @@ +use std::fmt::{Display, Formatter}; +use std::str::FromStr; + +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::{ + BytesLiteral, Expr, ExprBytesLiteral, ExprCall, ExprStringLiteral, StringLiteral, +}; +use ruff_python_semantic::{Modules, SemanticModel}; + +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Reports the following `re` and `regex` calls when +/// their first arguments are not raw strings: +/// +/// - For `regex` and `re`: `compile`, `findall`, `finditer`, +/// `fullmatch`, `match`, `search`, `split`, `sub`, `subn`. +/// - `regex`-specific: `splititer`, `subf`, `subfn`, `template`. +/// +/// ## Why is this bad? +/// Regular expressions should be written +/// using raw strings to avoid double escaping. +/// +/// ## Example +/// +/// ```python +/// re.compile("foo\\bar") +/// ``` +/// +/// Use instead: +/// +/// ```python +/// re.compile(r"foo\bar") +/// ``` +#[derive(ViolationMetadata)] +pub(crate) struct UnrawRePattern { + module: RegexModule, + func: String, + kind: PatternKind, +} + +impl Violation for UnrawRePattern { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] + fn message(&self) -> String { + let Self { module, func, kind } = &self; + let call = format!("`{module}.{func}()`"); + + match kind { + PatternKind::String => format!("First argument to {call} is not raw string"), + PatternKind::Bytes => format!("First argument to {call} is not raw bytes literal"), + } + } + + fn fix_title(&self) -> Option<String> { + match self.kind { + PatternKind::String => Some("Replace with raw string".to_string()), + PatternKind::Bytes => Some("Replace with raw bytes literal".to_string()), + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +enum RegexModule { + Re, + Regex, +} + +impl RegexModule { + fn is_function_taking_pattern(self, name: &str) -> bool { + match name { + "compile" | "findall" | "finditer" | "fullmatch" | "match" | "search" | "split" + | "sub" | "subn" => true, + "splititer" | "subf" | "subfn" | "template" => self == Self::Regex, + _ => false, + } + } +} + +impl Display for RegexModule { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + RegexModule::Re => "re", + RegexModule::Regex => "regex", + }) + } +} + +impl FromStr for RegexModule { + type Err = (); + + fn from_str(s: &str) -> Result<Self, Self::Err> { + match s { + "re" => Ok(Self::Re), + "regex" => Ok(Self::Regex), + _ => Err(()), + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +enum PatternKind { + String, + Bytes, +} + +/// RUF039 +pub(crate) fn unraw_re_pattern(checker: &Checker, call: &ExprCall) { + let semantic = checker.semantic(); + + if !semantic.seen_module(Modules::RE) && !semantic.seen_module(Modules::REGEX) { + return; + } + + let Some((module, func)) = regex_module_and_func(semantic, call.func.as_ref()) else { + return; + }; + + match call.arguments.args.as_ref().first() { + Some(Expr::StringLiteral(ExprStringLiteral { value, .. })) => { + value + .iter() + .for_each(|part| check_string(checker, part, module, func)); + } + Some(Expr::BytesLiteral(ExprBytesLiteral { value, .. })) => { + value + .iter() + .for_each(|part| check_bytes(checker, part, module, func)); + } + _ => {} + } +} + +fn regex_module_and_func<'model>( + semantic: &SemanticModel<'model>, + expr: &'model Expr, +) -> Option<(RegexModule, &'model str)> { + let qualified_name = semantic.resolve_qualified_name(expr)?; + + if let [module, func] = qualified_name.segments() { + let module = RegexModule::from_str(module).ok()?; + + if !module.is_function_taking_pattern(func) { + return None; + } + + return Some((module, func)); + } + + None +} + +fn check_string(checker: &Checker, literal: &StringLiteral, module: RegexModule, func: &str) { + if literal.flags.prefix().is_raw() { + return; + } + + let kind = PatternKind::String; + let func = func.to_string(); + let range = literal.range; + let mut diagnostic = Diagnostic::new(UnrawRePattern { module, func, kind }, range); + + if + // The (no-op) `u` prefix is a syntax error when combined with `r` + !literal.flags.prefix().is_unicode() + // We are looking for backslash characters + // in the raw source code here, because `\n` + // gets converted to a single character already + // at the lexing stage. + &&!checker.locator().slice(literal.range()).contains('\\') + { + diagnostic.set_fix(Fix::safe_edit(Edit::insertion( + "r".to_string(), + literal.range().start(), + ))); + } + checker.report_diagnostic(diagnostic); +} + +fn check_bytes(checker: &Checker, literal: &BytesLiteral, module: RegexModule, func: &str) { + if literal.flags.prefix().is_raw() { + return; + } + + let kind = PatternKind::Bytes; + let func = func.to_string(); + let range = literal.range; + let diagnostic = Diagnostic::new(UnrawRePattern { module, func, kind }, range); + + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unsafe_markup_use.rs b/crates/ruff_linter/src/rules/ruff/rules/unsafe_markup_use.rs new file mode 100644 index 0000000000000..afd79f23b5a6c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unsafe_markup_use.rs @@ -0,0 +1,85 @@ +use ruff_diagnostics::Violation; +use ruff_macros::{ViolationMetadata, derive_message_formats}; + +/// ## Removed +/// This rule was implemented in `bandit` and has been remapped to +/// [S704](unsafe-markup-use.md) +/// +/// ## What it does +/// Checks for non-literal strings being passed to [`markupsafe.Markup`][markupsafe-markup]. +/// +/// ## Why is this bad? +/// [`markupsafe.Markup`][markupsafe-markup] does not perform any escaping, +/// so passing dynamic content, like f-strings, variables or interpolated strings +/// will potentially lead to XSS vulnerabilities. +/// +/// Instead you should interpolate the `Markup` object. +/// +/// Using [`lint.flake8-bandit.extend-markup-names`] additional objects can be +/// treated like `Markup`. +/// +/// This rule was originally inspired by [flake8-markupsafe] but doesn't carve +/// out any exceptions for i18n related calls by default. +/// +/// You can use [`lint.flake8-bandit.allowed-markup-calls`] to specify exceptions. +/// +/// ## Example +/// Given: +/// ```python +/// from markupsafe import Markup +/// +/// content = "<script>alert('Hello, world!')</script>" +/// html = Markup(f"<b>{content}</b>") # XSS +/// ``` +/// +/// Use instead: +/// ```python +/// from markupsafe import Markup +/// +/// content = "<script>alert('Hello, world!')</script>" +/// html = Markup("<b>{}</b>").format(content) # Safe +/// ``` +/// +/// Given: +/// ```python +/// from markupsafe import Markup +/// +/// lines = [ +/// Markup("<b>heading</b>"), +/// "<script>alert('XSS attempt')</script>", +/// ] +/// html = Markup("<br>".join(lines)) # XSS +/// ``` +/// +/// Use instead: +/// ```python +/// from markupsafe import Markup +/// +/// lines = [ +/// Markup("<b>heading</b>"), +/// "<script>alert('XSS attempt')</script>", +/// ] +/// html = Markup("<br>").join(lines) # Safe +/// ``` +/// ## Options +/// - `lint.flake8-bandit.extend-markup-names` +/// - `lint.flake8-bandit.allowed-markup-calls` +/// +/// ## References +/// - [MarkupSafe on PyPI](https://pypi.org/project/MarkupSafe/) +/// - [`markupsafe.Markup` API documentation](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup) +/// +/// [markupsafe-markup]: https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup +/// [flake8-markupsafe]: https://github.com/vmagamedov/flake8-markupsafe +#[derive(ViolationMetadata)] +pub(crate) struct RuffUnsafeMarkupUse { + name: String, +} + +impl Violation for RuffUnsafeMarkupUse { + #[derive_message_formats] + fn message(&self) -> String { + let RuffUnsafeMarkupUse { name } = self; + format!("Unsafe use of `{name}` detected") + } +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/unused_async.rs b/crates/ruff_linter/src/rules/ruff/rules/unused_async.rs index b3b78c2755447..6bc529ec5572e 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/unused_async.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/unused_async.rs @@ -1,10 +1,10 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::identifier::Identifier; use ruff_python_ast::visitor::source_order; use ruff_python_ast::{self as ast, AnyNodeRef, Expr, Stmt}; -use ruff_python_semantic::analyze::function_type::is_stub; use ruff_python_semantic::Modules; +use ruff_python_semantic::analyze::function_type::is_stub; use crate::checkers::ast::Checker; use crate::rules::fastapi::rules::is_fastapi_route; @@ -18,7 +18,7 @@ use crate::rules::fastapi::rules::is_fastapi_route; /// contexts where that function may be called. In some cases, labeling a function `async` is /// semantically meaningful (e.g. with the trio library). /// -/// ## Examples +/// ## Example /// ```python /// async def foo(): /// bar() @@ -29,8 +29,8 @@ use crate::rules::fastapi::rules::is_fastapi_route; /// def foo(): /// bar() /// ``` -#[violation] -pub struct UnusedAsync { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedAsync { name: String, } @@ -154,7 +154,7 @@ where /// RUF029 pub(crate) fn unused_async( - checker: &mut Checker, + checker: &Checker, function_def @ ast::StmtFunctionDef { is_async, name, @@ -188,7 +188,7 @@ pub(crate) fn unused_async( }; if !found_await_or_async { - checker.diagnostics.push(Diagnostic::new( + checker.report_diagnostic(Diagnostic::new( UnusedAsync { name: name.to_string(), }, diff --git a/crates/ruff_linter/src/rules/ruff/rules/unused_noqa.rs b/crates/ruff_linter/src/rules/ruff/rules/unused_noqa.rs index 9e9109c092cfc..e29e7acfeb011 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/unused_noqa.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/unused_noqa.rs @@ -1,10 +1,10 @@ use itertools::Itertools; use ruff_diagnostics::AlwaysFixableViolation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; #[derive(Debug, PartialEq, Eq)] -pub struct UnusedCodes { +pub(crate) struct UnusedCodes { pub disabled: Vec<String>, pub duplicated: Vec<String>, pub unknown: Vec<String>, @@ -41,16 +41,15 @@ pub struct UnusedCodes { /// /// ## References /// - [Ruff error suppression](https://docs.astral.sh/ruff/linter/#error-suppression) -#[violation] -pub struct UnusedNOQA { +#[derive(ViolationMetadata)] +pub(crate) struct UnusedNOQA { pub codes: Option<UnusedCodes>, } impl AlwaysFixableViolation for UnusedNOQA { #[derive_message_formats] fn message(&self) -> String { - let UnusedNOQA { codes } = self; - match codes { + match &self.codes { Some(codes) => { let mut codes_by_reason = vec![]; if !codes.unmatched.is_empty() { @@ -94,12 +93,12 @@ impl AlwaysFixableViolation for UnusedNOQA { )); } if codes_by_reason.is_empty() { - format!("Unused `noqa` directive") + "Unused `noqa` directive".to_string() } else { format!("Unused `noqa` directive ({})", codes_by_reason.join("; ")) } } - None => format!("Unused blanket `noqa` directive"), + None => "Unused blanket `noqa` directive".to_string(), } } diff --git a/crates/ruff_linter/src/rules/ruff/rules/unused_unpacked_variable.rs b/crates/ruff_linter/src/rules/ruff/rules/unused_unpacked_variable.rs new file mode 100644 index 0000000000000..02defb93263af --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/unused_unpacked_variable.rs @@ -0,0 +1,91 @@ +use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_semantic::Binding; +use ruff_text_size::Ranged; + +use crate::checkers::ast::Checker; + +/// ## What it does +/// Checks for the presence of unused variables in unpacked assignments. +/// +/// ## Why is this bad? +/// A variable that is defined but never used can confuse readers. +/// +/// If a variable is intentionally defined-but-not-used, it should be +/// prefixed with an underscore, or some other value that adheres to the +/// [`lint.dummy-variable-rgx`] pattern. +/// +/// ## Example +/// +/// ```python +/// def get_pair(): +/// return 1, 2 +/// +/// +/// def foo(): +/// x, y = get_pair() +/// return x +/// ``` +/// +/// Use instead: +/// +/// ```python +/// def foo(): +/// x, _ = get_pair() +/// return x +/// ``` +/// +/// ## Options +/// - `lint.dummy-variable-rgx` +#[derive(ViolationMetadata)] +pub(crate) struct UnusedUnpackedVariable { + pub name: String, +} + +impl Violation for UnusedUnpackedVariable { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + let UnusedUnpackedVariable { name } = self; + format!("Unpacked variable `{name}` is never used") + } + + fn fix_title(&self) -> Option<String> { + Some("Prefix it with an underscore or any other dummy variable pattern".to_string()) + } +} + +/// Generate a [`Edit`] to remove an unused variable assignment to a [`Binding`]. +fn remove_unused_variable(binding: &Binding, checker: &Checker) -> Option<Fix> { + let node_id = binding.source?; + let isolation = Checker::isolation(checker.semantic().parent_statement_id(node_id)); + + let name = binding.name(checker.source()); + let renamed = format!("_{name}"); + if checker.settings.dummy_variable_rgx.is_match(&renamed) { + let edit = Edit::range_replacement(renamed, binding.range()); + + return Some(Fix::unsafe_edit(edit).isolate(isolation)); + } + + None +} + +/// RUF059 +pub(crate) fn unused_unpacked_variable(checker: &Checker, name: &str, binding: &Binding) { + if !binding.is_unpacked_assignment() { + return; + } + + let mut diagnostic = Diagnostic::new( + UnusedUnpackedVariable { + name: name.to_string(), + }, + binding.range(), + ); + if let Some(fix) = remove_unused_variable(binding, checker) { + diagnostic.set_fix(fix); + } + checker.report_diagnostic(diagnostic); +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/used_dummy_variable.rs b/crates/ruff_linter/src/rules/ruff/rules/used_dummy_variable.rs new file mode 100644 index 0000000000000..a6737dff8598a --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/rules/used_dummy_variable.rs @@ -0,0 +1,230 @@ +use ruff_diagnostics::{Diagnostic, Fix, FixAvailability, Violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::helpers::is_dunder; +use ruff_python_semantic::{Binding, BindingId}; +use ruff_python_stdlib::identifiers::is_identifier; +use ruff_text_size::Ranged; + +use crate::{ + checkers::ast::Checker, + renamer::{Renamer, ShadowedKind}, +}; + +/// ## What it does +/// Checks for "dummy variables" (variables that are named as if to indicate they are unused) +/// that are in fact used. +/// +/// By default, "dummy variables" are any variables with names that start with leading +/// underscores. However, this is customisable using the [`lint.dummy-variable-rgx`] setting). +/// +/// ## Why is this bad? +/// Marking a variable with a leading underscore conveys that it is intentionally unused within the function or method. +/// When these variables are later referenced in the code, it causes confusion and potential misunderstandings about +/// the code's intention. If a variable marked as "unused" is subsequently used, it suggests that either the variable +/// could be given a clearer name, or that the code is accidentally making use of the wrong variable. +/// +/// Sometimes leading underscores are used to avoid variables shadowing other variables, Python builtins, or Python +/// keywords. However, [PEP 8] recommends to use trailing underscores for this rather than leading underscores. +/// +/// Dunder variables are ignored by this rule, as are variables named `_`. +/// Only local variables in function scopes are flagged by the rule. +/// +/// ## Example +/// ```python +/// def function(): +/// _variable = 3 +/// # important: avoid shadowing the builtin `id()` function! +/// _id = 4 +/// return _variable + _id +/// ``` +/// +/// Use instead: +/// ```python +/// def function(): +/// variable = 3 +/// # important: avoid shadowing the builtin `id()` function! +/// id_ = 4 +/// return variable + id_ +/// ``` +/// +/// ## Fix availability +/// The rule's fix is only available for variables that start with leading underscores. +/// It will also only be available if the "obvious" new name for the variable +/// would not shadow any other known variables already accessible from the scope +/// in which the variable is defined. +/// +/// ## Fix safety +/// This rule's fix is marked as unsafe. +/// +/// For this rule's fix, Ruff renames the variable and fixes up all known references to +/// it so they point to the renamed variable. However, some renamings also require other +/// changes such as different arguments to constructor calls or alterations to comments. +/// Ruff is aware of some of these cases: `_T = TypeVar("_T")` will be fixed to +/// `T = TypeVar("T")` if the `_T` binding is flagged by this rule. However, in general, +/// cases like these are hard to detect and hard to automatically fix. +/// +/// ## Options +/// - [`lint.dummy-variable-rgx`] +/// +/// [PEP 8]: https://peps.python.org/pep-0008/ +#[derive(ViolationMetadata)] +pub(crate) struct UsedDummyVariable { + name: String, + shadowed_kind: Option<ShadowedKind>, +} + +impl Violation for UsedDummyVariable { + const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + + #[derive_message_formats] + fn message(&self) -> String { + format!("Local dummy variable `{}` is accessed", self.name) + } + + fn fix_title(&self) -> Option<String> { + self.shadowed_kind.map(|kind| match kind { + ShadowedKind::BuiltIn => { + "Prefer using trailing underscores to avoid shadowing a built-in".to_string() + } + ShadowedKind::Keyword => { + "Prefer using trailing underscores to avoid shadowing a keyword".to_string() + } + ShadowedKind::Some => { + "Prefer using trailing underscores to avoid shadowing a variable".to_string() + } + ShadowedKind::None => "Remove leading underscores".to_string(), + }) + } +} + +/// RUF052 +pub(crate) fn used_dummy_variable( + checker: &Checker, + binding: &Binding, + binding_id: BindingId, +) -> Option<Diagnostic> { + let name = binding.name(checker.source()); + + // Ignore `_` and dunder variables + if name == "_" || is_dunder(name) { + return None; + } + // only used variables + if binding.is_unused() { + return None; + } + + // We only emit the lint on variables defined via assignments. + // + // ## Why not also emit the lint on function parameters? + // + // There isn't universal agreement that leading underscores indicate "unused" parameters + // in Python (many people use them for "private" parameters), so this would be a lot more + // controversial than emitting the lint on assignments. Even if it's decided that it's + // desirable to emit a lint on function parameters with "dummy variable" names, it would + // possibly have to be a separate rule or we'd have to put it behind a configuration flag, + // as there's much less community consensus about the issue. + // See <https://github.com/astral-sh/ruff/issues/14796>. + // + // Moreover, autofixing the diagnostic for function parameters is much more troublesome than + // autofixing the diagnostic for assignments. See: + // - <https://github.com/astral-sh/ruff/issues/14790> + // - <https://github.com/astral-sh/ruff/issues/14799> + if !binding.kind.is_assignment() { + return None; + } + + // This excludes `global` and `nonlocal` variables. + if binding.is_global() || binding.is_nonlocal() { + return None; + } + + let semantic = checker.semantic(); + + // Only variables defined in function scopes + let scope = &semantic.scopes[binding.scope]; + if !scope.kind.is_function() { + return None; + } + + // Recall from above that we do not wish to flag "private" + // function parameters. The previous early exit ensured + // that the binding in hand was not a function parameter. + // We now check that, in the body of our function, we are + // not looking at a shadowing of a private parameter. + // + // (Technically this also covers the case in the previous early exit, + // but it is more expensive so we keep both.) + if scope + .shadowed_bindings(binding_id) + .any(|shadow_id| semantic.binding(shadow_id).kind.is_argument()) + { + return None; + } + if !checker.settings.dummy_variable_rgx.is_match(name) { + return None; + } + + // If the name doesn't start with an underscore, we don't consider it for a fix + if !name.starts_with('_') { + return Some(Diagnostic::new( + UsedDummyVariable { + name: name.to_string(), + shadowed_kind: None, + }, + binding.range(), + )); + } + + // Trim the leading underscores for further checks + let trimmed_name = name.trim_start_matches('_'); + + let shadowed_kind = ShadowedKind::new(binding, trimmed_name, checker); + + let mut diagnostic = Diagnostic::new( + UsedDummyVariable { + name: name.to_string(), + shadowed_kind: Some(shadowed_kind), + }, + binding.range(), + ); + + // Get the possible fix based on the scope + if let Some(new_name) = get_possible_new_name(binding, trimmed_name, shadowed_kind, checker) { + diagnostic.try_set_fix(|| { + Renamer::rename(name, &new_name, scope, semantic, checker.stylist()) + .map(|(edit, rest)| Fix::unsafe_edits(edit, rest)) + }); + } + + Some(diagnostic) +} + +/// Suggests a potential alternative name to resolve a shadowing conflict. +fn get_possible_new_name( + binding: &Binding, + trimmed_name: &str, + kind: ShadowedKind, + checker: &Checker, +) -> Option<String> { + // Construct the potential fix name based on ShadowedKind + let fix_name = match kind { + ShadowedKind::Some | ShadowedKind::BuiltIn | ShadowedKind::Keyword => { + format!("{trimmed_name}_") // Append an underscore + } + ShadowedKind::None => trimmed_name.to_string(), + }; + + // Check if the fix name is again dummy identifier + if checker.settings.dummy_variable_rgx.is_match(&fix_name) { + return None; + } + + // Ensure the fix name is not already taken in the scope or enclosing scopes + if ShadowedKind::new(binding, &fix_name, checker).shadows_any() { + return None; + } + + // Check if the fix name is a valid identifier + is_identifier(&fix_name).then_some(fix_name) +} diff --git a/crates/ruff_linter/src/rules/ruff/rules/useless_if_else.rs b/crates/ruff_linter/src/rules/ruff/rules/useless_if_else.rs index aa3caad384942..d1f59ca8d2192 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/useless_if_else.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/useless_if_else.rs @@ -1,42 +1,37 @@ use crate::checkers::ast::Checker; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast as ast; use ruff_python_ast::comparable::ComparableExpr; /// ## What it does -/// Checks for useless if-else conditions with identical arms. +/// Checks for useless `if`-`else` conditions with identical arms. /// /// ## Why is this bad? -/// Useless if-else conditions add unnecessary complexity to the code without -/// providing any logical benefit. -/// -/// Assigning the value directly is clearer and more explicit, and -/// should be preferred. +/// Useless `if`-`else` conditions add unnecessary complexity to the code without +/// providing any logical benefit. Assigning the value directly is clearer. /// /// ## Example /// ```python -/// # Bad /// foo = x if y else x /// ``` /// /// Use instead: /// ```python -/// # Good /// foo = x /// ``` -#[violation] -pub struct UselessIfElse; +#[derive(ViolationMetadata)] +pub(crate) struct UselessIfElse; impl Violation for UselessIfElse { #[derive_message_formats] fn message(&self) -> String { - format!("Useless if-else condition") + "Useless `if`-`else` condition".to_string() } } -/// RUF031 -pub(crate) fn useless_if_else(checker: &mut Checker, if_expr: &ast::ExprIf) { +/// RUF034 +pub(crate) fn useless_if_else(checker: &Checker, if_expr: &ast::ExprIf) { let ast::ExprIf { body, orelse, @@ -44,12 +39,10 @@ pub(crate) fn useless_if_else(checker: &mut Checker, if_expr: &ast::ExprIf) { .. } = if_expr; - // Skip if the body and orelse are not the same + // Skip if the `body` and `orelse` are not the same. if ComparableExpr::from(body) != ComparableExpr::from(orelse) { return; } - checker - .diagnostics - .push(Diagnostic::new(UselessIfElse, *range)); + checker.report_diagnostic(Diagnostic::new(UselessIfElse, *range)); } diff --git a/crates/ruff_linter/src/rules/ruff/rules/zip_instead_of_pairwise.rs b/crates/ruff_linter/src/rules/ruff/rules/zip_instead_of_pairwise.rs index 27e209bfb92ec..d4bcd9844deaa 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/zip_instead_of_pairwise.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/zip_instead_of_pairwise.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr, Int}; use ruff_text_size::Ranged; @@ -29,16 +29,26 @@ use crate::{checkers::ast::Checker, importer::ImportRequest}; /// pairwise(letters) # ("A", "B"), ("B", "C"), ("C", "D") /// ``` /// +/// ## Fix safety +/// +/// The fix is always marked unsafe because it assumes that slicing an object +/// (e.g., `obj[1:]`) produces a value with the same type and iteration behavior +/// as the original object, which is not guaranteed for user-defined types that +/// override `__getitem__` without properly handling slices. Moreover, the fix +/// could delete comments. +/// /// ## References /// - [Python documentation: `itertools.pairwise`](https://docs.python.org/3/library/itertools.html#itertools.pairwise) -#[violation] -pub struct ZipInsteadOfPairwise; +#[derive(ViolationMetadata)] +pub(crate) struct ZipInsteadOfPairwise; impl Violation for ZipInsteadOfPairwise { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; + #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs") + "Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs" + .to_string() } fn fix_title(&self) -> Option<String> { @@ -100,7 +110,7 @@ fn match_slice_info(expr: &Expr) -> Option<SliceInfo> { } /// RUF007 -pub(crate) fn zip_instead_of_pairwise(checker: &mut Checker, call: &ast::ExprCall) { +pub(crate) fn zip_instead_of_pairwise(checker: &Checker, call: &ast::ExprCall) { let ast::ExprCall { func, arguments: Arguments { args, .. }, @@ -152,18 +162,16 @@ pub(crate) fn zip_instead_of_pairwise(checker: &mut Checker, call: &ast::ExprCal let mut diagnostic = Diagnostic::new(ZipInsteadOfPairwise, func.range()); - if checker.settings.preview.is_enabled() { - diagnostic.try_set_fix(|| { - let (import_edit, binding) = checker.importer().get_or_import_symbol( - &ImportRequest::import("itertools", "pairwise"), - func.start(), - checker.semantic(), - )?; - let reference_edit = - Edit::range_replacement(format!("{binding}({})", first_arg_info.id), call.range()); - Ok(Fix::unsafe_edits(import_edit, [reference_edit])) - }); - } - - checker.diagnostics.push(diagnostic); + diagnostic.try_set_fix(|| { + let (import_edit, binding) = checker.importer().get_or_import_symbol( + &ImportRequest::import("itertools", "pairwise"), + func.start(), + checker.semantic(), + )?; + let reference_edit = + Edit::range_replacement(format!("{binding}({})", first_arg_info.id), call.range()); + Ok(Fix::unsafe_edits(import_edit, [reference_edit])) + }); + + checker.report_diagnostic(diagnostic); } diff --git a/crates/ruff_linter/src/rules/ruff/settings.rs b/crates/ruff_linter/src/rules/ruff/settings.rs index a1c36b64951e5..c6768121f054f 100644 --- a/crates/ruff_linter/src/rules/ruff/settings.rs +++ b/crates/ruff_linter/src/rules/ruff/settings.rs @@ -15,7 +15,7 @@ impl fmt::Display for Settings { formatter = f, namespace = "linter.ruff", fields = [ - self.parenthesize_tuple_in_subscript + self.parenthesize_tuple_in_subscript, ] } Ok(()) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_0.py.snap index 096eceb46b23a..26170773366c4 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_0.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF013_0.py:20:12: RUF013 [*] PEP 484 prohibits implicit `Optional` | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_1.py.snap index b15b7e14094f6..cf0db9093933a 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_1.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__PY39_RUF013_RUF013_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF013_1.py:4:12: RUF013 [*] PEP 484 prohibits implicit `Optional` | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF005_RUF005.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF005_RUF005.py.snap index 8e9c466eb6f66..14b7c0d3632bc 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF005_RUF005.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF005_RUF005.py.snap @@ -172,7 +172,7 @@ RUF005.py:47:16: RUF005 [*] Consider `("we all feel", *Fun.words)` instead of co 46 | excitement = ("we all think",) + Fun().yay() 47 | astonishment = ("we all feel",) + Fun.words | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF005 -48 | +48 | 49 | chain = ["a", "b", "c"] + eggs + list(("yes", "no", "pants") + zoob) | = help: Replace with `("we all feel", *Fun.words)` @@ -190,10 +190,10 @@ RUF005.py:47:16: RUF005 [*] Consider `("we all feel", *Fun.words)` instead of co RUF005.py:49:9: RUF005 [*] Consider iterable unpacking instead of concatenation | 47 | astonishment = ("we all feel",) + Fun.words -48 | +48 | 49 | chain = ["a", "b", "c"] + eggs + list(("yes", "no", "pants") + zoob) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF005 -50 | +50 | 51 | baz = () + zoob | = help: Replace with iterable unpacking @@ -211,10 +211,10 @@ RUF005.py:49:9: RUF005 [*] Consider iterable unpacking instead of concatenation RUF005.py:49:39: RUF005 [*] Consider `("yes", "no", "pants", *zoob)` instead of concatenation | 47 | astonishment = ("we all feel",) + Fun.words -48 | +48 | 49 | chain = ["a", "b", "c"] + eggs + list(("yes", "no", "pants") + zoob) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF005 -50 | +50 | 51 | baz = () + zoob | = help: Replace with `("yes", "no", "pants", *zoob)` @@ -232,10 +232,10 @@ RUF005.py:49:39: RUF005 [*] Consider `("yes", "no", "pants", *zoob)` instead of RUF005.py:51:7: RUF005 [*] Consider `(*zoob,)` instead of concatenation | 49 | chain = ["a", "b", "c"] + eggs + list(("yes", "no", "pants") + zoob) -50 | +50 | 51 | baz = () + zoob | ^^^^^^^^^ RUF005 -52 | +52 | 53 | [] + foo + [ | = help: Replace with `(*zoob,)` @@ -253,11 +253,11 @@ RUF005.py:51:7: RUF005 [*] Consider `(*zoob,)` instead of concatenation RUF005.py:53:1: RUF005 [*] Consider `[*foo]` instead of concatenation | 51 | baz = () + zoob -52 | +52 | 53 | / [] + foo + [ 54 | | ] | |_^ RUF005 -55 | +55 | 56 | pylint_call = [sys.executable, "-m", "pylint"] + args + [path] | = help: Replace with `[*foo]` @@ -276,7 +276,7 @@ RUF005.py:53:1: RUF005 [*] Consider `[*foo]` instead of concatenation RUF005.py:56:15: RUF005 [*] Consider `[sys.executable, "-m", "pylint", *args, path]` instead of concatenation | 54 | ] -55 | +55 | 56 | pylint_call = [sys.executable, "-m", "pylint"] + args + [path] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF005 57 | pylint_call_tuple = (sys.executable, "-m", "pylint") + args + (path, path2) @@ -319,7 +319,7 @@ RUF005.py:58:5: RUF005 [*] Consider `[*a, 2, 3, 4]` instead of concatenation 57 | pylint_call_tuple = (sys.executable, "-m", "pylint") + args + (path, path2) 58 | b = a + [2, 3] + [4] | ^^^^^^^^^^^^^^^^ RUF005 -59 | +59 | 60 | # Uses the non-preferred quote style, which should be retained. | = help: Replace with `[*a, 2, 3, 4]` @@ -339,7 +339,7 @@ RUF005.py:61:4: RUF005 [*] Consider `[*a(), 'b']` instead of concatenation 60 | # Uses the non-preferred quote style, which should be retained. 61 | f"{a() + ['b']}" | ^^^^^^^^^^^ RUF005 -62 | +62 | 63 | ### | = help: Replace with `[*a(), 'b']` @@ -353,5 +353,3 @@ RUF005.py:61:4: RUF005 [*] Consider `[*a(), 'b']` instead of concatenation 62 62 | 63 63 | ### 64 64 | # Non-errors. - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF006_RUF006.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF006_RUF006.py.snap index 884e920dcb16c..1df2682c60c45 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF006_RUF006.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF006_RUF006.py.snap @@ -57,7 +57,7 @@ RUF006.py:170:5: RUF006 Store a reference to the return value of `loop.create_ta 169 | loop = asyncio.new_event_loop() 170 | loop.create_task(main()) # Error | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF006 -171 | +171 | 172 | # Error | @@ -67,6 +67,6 @@ RUF006.py:175:5: RUF006 Store a reference to the return value of `loop.create_ta 174 | loop = asyncio.get_event_loop() 175 | loop.create_task(main()) # Error | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF006 -176 | +176 | 177 | # OK | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF007_RUF007.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF007_RUF007.py.snap index 653760b026e34..b12828b3ac84f 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF007_RUF007.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF007_RUF007.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -RUF007.py:16:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +RUF007.py:16:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 15 | # Errors 16 | zip(input, input[1:]) @@ -11,7 +11,22 @@ RUF007.py:16:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:17:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +13 14 | zip(foo[:-1], foo[1:], foo, strict=True) # more than 2 inputs +14 15 | +15 16 | # Errors +16 |-zip(input, input[1:]) + 17 |+itertools.pairwise(input) +17 18 | zip(input, input[1::1]) +18 19 | zip(input[:-1], input[1:]) +19 20 | zip(input[1:], input[2:]) + +RUF007.py:17:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 15 | # Errors 16 | zip(input, input[1:]) @@ -22,7 +37,22 @@ RUF007.py:17:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:18:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +14 15 | +15 16 | # Errors +16 17 | zip(input, input[1:]) +17 |-zip(input, input[1::1]) + 18 |+itertools.pairwise(input) +18 19 | zip(input[:-1], input[1:]) +19 20 | zip(input[1:], input[2:]) +20 21 | zip(input[1:-1], input[2:]) + +RUF007.py:18:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 16 | zip(input, input[1:]) 17 | zip(input, input[1::1]) @@ -33,7 +63,22 @@ RUF007.py:18:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:19:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +15 16 | # Errors +16 17 | zip(input, input[1:]) +17 18 | zip(input, input[1::1]) +18 |-zip(input[:-1], input[1:]) + 19 |+itertools.pairwise(input) +19 20 | zip(input[1:], input[2:]) +20 21 | zip(input[1:-1], input[2:]) +21 22 | list(zip(input, input[1:])) + +RUF007.py:19:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 17 | zip(input, input[1::1]) 18 | zip(input[:-1], input[1:]) @@ -44,7 +89,22 @@ RUF007.py:19:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:20:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +16 17 | zip(input, input[1:]) +17 18 | zip(input, input[1::1]) +18 19 | zip(input[:-1], input[1:]) +19 |-zip(input[1:], input[2:]) + 20 |+itertools.pairwise(input) +20 21 | zip(input[1:-1], input[2:]) +21 22 | list(zip(input, input[1:])) +22 23 | list(zip(input[:-1], input[1:])) + +RUF007.py:20:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 18 | zip(input[:-1], input[1:]) 19 | zip(input[1:], input[2:]) @@ -55,7 +115,22 @@ RUF007.py:20:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:21:6: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +17 18 | zip(input, input[1::1]) +18 19 | zip(input[:-1], input[1:]) +19 20 | zip(input[1:], input[2:]) +20 |-zip(input[1:-1], input[2:]) + 21 |+itertools.pairwise(input) +21 22 | list(zip(input, input[1:])) +22 23 | list(zip(input[:-1], input[1:])) +23 24 | zip(foo[:-1], foo[1:], strict=True) + +RUF007.py:21:6: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 19 | zip(input[1:], input[2:]) 20 | zip(input[1:-1], input[2:]) @@ -66,7 +141,22 @@ RUF007.py:21:6: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:22:6: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +18 19 | zip(input[:-1], input[1:]) +19 20 | zip(input[1:], input[2:]) +20 21 | zip(input[1:-1], input[2:]) +21 |-list(zip(input, input[1:])) + 22 |+list(itertools.pairwise(input)) +22 23 | list(zip(input[:-1], input[1:])) +23 24 | zip(foo[:-1], foo[1:], strict=True) +24 25 | zip(foo[:-1], foo[1:], strict=False) + +RUF007.py:22:6: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 20 | zip(input[1:-1], input[2:]) 21 | list(zip(input, input[1:])) @@ -77,7 +167,22 @@ RUF007.py:22:6: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:23:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +19 20 | zip(input[1:], input[2:]) +20 21 | zip(input[1:-1], input[2:]) +21 22 | list(zip(input, input[1:])) +22 |-list(zip(input[:-1], input[1:])) + 23 |+list(itertools.pairwise(input)) +23 24 | zip(foo[:-1], foo[1:], strict=True) +24 25 | zip(foo[:-1], foo[1:], strict=False) +25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) + +RUF007.py:23:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 21 | list(zip(input, input[1:])) 22 | list(zip(input[:-1], input[1:])) @@ -88,7 +193,21 @@ RUF007.py:23:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:24:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +20 21 | zip(input[1:-1], input[2:]) +21 22 | list(zip(input, input[1:])) +22 23 | list(zip(input[:-1], input[1:])) +23 |-zip(foo[:-1], foo[1:], strict=True) + 24 |+itertools.pairwise(foo) +24 25 | zip(foo[:-1], foo[1:], strict=False) +25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) + +RUF007.py:24:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 22 | list(zip(input[:-1], input[1:])) 23 | zip(foo[:-1], foo[1:], strict=True) @@ -98,7 +217,20 @@ RUF007.py:24:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | = help: Replace `zip()` with `itertools.pairwise()` -RUF007.py:25:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +21 22 | list(zip(input, input[1:])) +22 23 | list(zip(input[:-1], input[1:])) +23 24 | zip(foo[:-1], foo[1:], strict=True) +24 |-zip(foo[:-1], foo[1:], strict=False) + 25 |+itertools.pairwise(foo) +25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) + +RUF007.py:25:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs | 23 | zip(foo[:-1], foo[1:], strict=True) 24 | zip(foo[:-1], foo[1:], strict=False) @@ -106,3 +238,15 @@ RUF007.py:25:1: RUF007 Prefer `itertools.pairwise()` over `zip()` when iterating | ^^^ RUF007 | = help: Replace `zip()` with `itertools.pairwise()` + +ℹ Unsafe fix + 1 |+import itertools +1 2 | input = [1, 2, 3] +2 3 | otherInput = [2, 3, 4] +3 4 | foo = [1, 2, 3, 4] +-------------------------------------------------------------------------------- +22 23 | list(zip(input[:-1], input[1:])) +23 24 | zip(foo[:-1], foo[1:], strict=True) +24 25 | zip(foo[:-1], foo[1:], strict=False) +25 |-zip(foo[:-1], foo[1:], strict=bool(foo)) + 26 |+itertools.pairwise(foo) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008.py.snap index 97ea363c77896..c3762051ba576 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008.py.snap @@ -21,4 +21,30 @@ RUF008.py:20:34: RUF008 Do not use mutable default values for dataclass attribut 22 | without_annotation = [] | +RUF008.py:31:36: RUF008 Do not use mutable default values for dataclass attributes + | +29 | @dataclass +30 | class AWithQuotes: +31 | mutable_default: 'list[int]' = [] + | ^^ RUF008 +32 | immutable_annotation: 'typing.Sequence[int]' = [] +33 | without_annotation = [] + | +RUF008.py:32:52: RUF008 Do not use mutable default values for dataclass attributes + | +30 | class AWithQuotes: +31 | mutable_default: 'list[int]' = [] +32 | immutable_annotation: 'typing.Sequence[int]' = [] + | ^^ RUF008 +33 | without_annotation = [] +34 | correct_code: 'list[int]' = KNOWINGLY_MUTABLE_DEFAULT + | + +RUF008.py:36:51: RUF008 Do not use mutable default values for dataclass attributes + | +34 | correct_code: 'list[int]' = KNOWINGLY_MUTABLE_DEFAULT +35 | perfectly_fine: 'list[int]' = field(default_factory=list) +36 | class_variable: 'typing.ClassVar[list[int]]'= [] + | ^^ RUF008 + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_attrs.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_attrs.py.snap new file mode 100644 index 0000000000000..0b4772e4919bb --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_attrs.py.snap @@ -0,0 +1,43 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF008_attrs.py:13:34: RUF008 Do not use mutable default values for dataclass attributes + | +11 | @define +12 | class A: +13 | mutable_default: list[int] = [] + | ^^ RUF008 +14 | immutable_annotation: typing.Sequence[int] = [] +15 | without_annotation = [] + | + +RUF008_attrs.py:23:34: RUF008 Do not use mutable default values for dataclass attributes + | +21 | @frozen +22 | class B: +23 | mutable_default: list[int] = [] + | ^^ RUF008 +24 | immutable_annotation: Sequence[int] = [] +25 | without_annotation = [] + | + +RUF008_attrs.py:33:34: RUF008 Do not use mutable default values for dataclass attributes + | +31 | @attr.s +32 | class C: +33 | mutable_default: list[int] = [] + | ^^ RUF008 +34 | immutable_annotation: Sequence[int] = [] +35 | without_annotation = [] + | + +RUF008_attrs.py:42:34: RUF008 Do not use mutable default values for dataclass attributes + | +40 | @s +41 | class D: +42 | mutable_default: list[int] = [] + | ^^ RUF008 +43 | immutable_annotation: Sequence[int] = [] +44 | without_annotation = [] + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_deferred.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_deferred.py.snap new file mode 100644 index 0000000000000..7f58cfd7246a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF008_RUF008_deferred.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009.py.snap index c9c3e9ed8477e..8a297d3c15ab9 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF009.py:20:41: RUF009 Do not perform function call `default_function` in dataclass defaults | @@ -41,4 +42,61 @@ RUF009.py:45:34: RUF009 Do not perform function call `ImmutableType` in dataclas 47 | okay_variant: A = DEFAULT_A_FOR_ALL_DATACLASSES | +RUF009.py:91:24: RUF009 Do not perform function call `ListOfStrings` in dataclass defaults + | +89 | class DataclassWithNewTypeFields: +90 | # Errors +91 | a: ListOfStrings = ListOfStrings([]) + | ^^^^^^^^^^^^^^^^^ RUF009 +92 | b: StringsToInts = StringsToInts() +93 | c: Invalid1 = Invalid1() + | + +RUF009.py:92:24: RUF009 Do not perform function call `StringsToInts` in dataclass defaults + | +90 | # Errors +91 | a: ListOfStrings = ListOfStrings([]) +92 | b: StringsToInts = StringsToInts() + | ^^^^^^^^^^^^^^^ RUF009 +93 | c: Invalid1 = Invalid1() +94 | d: Invalid2 = Invalid2() + | + +RUF009.py:93:19: RUF009 Do not perform function call `Invalid1` in dataclass defaults + | +91 | a: ListOfStrings = ListOfStrings([]) +92 | b: StringsToInts = StringsToInts() +93 | c: Invalid1 = Invalid1() + | ^^^^^^^^^^ RUF009 +94 | d: Invalid2 = Invalid2() +95 | e: Invalid3 = Invalid3() + | + +RUF009.py:94:19: RUF009 Do not perform function call `Invalid2` in dataclass defaults + | +92 | b: StringsToInts = StringsToInts() +93 | c: Invalid1 = Invalid1() +94 | d: Invalid2 = Invalid2() + | ^^^^^^^^^^ RUF009 +95 | e: Invalid3 = Invalid3() + | + +RUF009.py:95:19: RUF009 Do not perform function call `Invalid3` in dataclass defaults + | +93 | c: Invalid1 = Invalid1() +94 | d: Invalid2 = Invalid2() +95 | e: Invalid3 = Invalid3() + | ^^^^^^^^^^ RUF009 +96 | +97 | # No errors + | +RUF009.py:109:35: RUF009 Do not perform function call `default_function` in dataclass defaults + | +107 | @dataclass +108 | class ShouldMatchB008RuleOfImmutableTypeAnnotationIgnored: +109 | this_is_not_fine: list[int] = default_function() + | ^^^^^^^^^^^^^^^^^^ RUF009 +110 | # ignored +111 | this_is_fine: int = f() + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs.py.snap new file mode 100644 index 0000000000000..5ed5adb316ebb --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs.py.snap @@ -0,0 +1,33 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF009_attrs.py:46:41: RUF009 Do not perform function call `default_function` in dataclass defaults + | +44 | @define +45 | class B: +46 | hidden_mutable_default: list[int] = default_function() + | ^^^^^^^^^^^^^^^^^^ RUF009 +47 | another_dataclass: A = A() +48 | not_optimal: ImmutableType = ImmutableType(20) + | + +RUF009_attrs.py:47:28: RUF009 Do not perform function call `A` in dataclass defaults + | +45 | class B: +46 | hidden_mutable_default: list[int] = default_function() +47 | another_dataclass: A = A() + | ^^^ RUF009 +48 | not_optimal: ImmutableType = ImmutableType(20) +49 | good_variant: ImmutableType = DEFAULT_IMMUTABLETYPE_FOR_ALL_DATACLASSES + | + +RUF009_attrs.py:48:34: RUF009 Do not perform function call `ImmutableType` in dataclass defaults + | +46 | hidden_mutable_default: list[int] = default_function() +47 | another_dataclass: A = A() +48 | not_optimal: ImmutableType = ImmutableType(20) + | ^^^^^^^^^^^^^^^^^ RUF009 +49 | good_variant: ImmutableType = DEFAULT_IMMUTABLETYPE_FOR_ALL_DATACLASSES +50 | okay_variant: A = DEFAULT_A_FOR_ALL_DATACLASSES + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs_auto_attribs.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs_auto_attribs.py.snap new file mode 100644 index 0000000000000..b3a37c0921109 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_attrs_auto_attribs.py.snap @@ -0,0 +1,5 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- + diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_deferred.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_deferred.py.snap new file mode 100644 index 0000000000000..91607116fbe4e --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF009_RUF009_deferred.py.snap @@ -0,0 +1,21 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF009_deferred.py:10:41: RUF009 Do not perform function call `default_function` in dataclass defaults + | + 8 | @dataclass() + 9 | class A: +10 | hidden_mutable_default: list[int] = default_function() + | ^^^^^^^^^^^^^^^^^^ RUF009 +11 | class_variable: typing.ClassVar[list[int]] = default_function() +12 | another_class_var: ClassVar[list[int]] = default_function() + | + +RUF009_deferred.py:11:50: RUF009 Do not perform function call `default_function` in dataclass defaults + | + 9 | class A: +10 | hidden_mutable_default: list[int] = default_function() +11 | class_variable: typing.ClassVar[list[int]] = default_function() + | ^^^^^^^^^^^^^^^^^^ RUF009 +12 | another_class_var: ClassVar[list[int]] = default_function() + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF010_RUF010.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF010_RUF010.py.snap index fe2e4e3c743be..1910bdf6f9d0e 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF010_RUF010.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF010_RUF010.py.snap @@ -5,7 +5,7 @@ RUF010.py:9:4: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 | ^^^^^^^^ RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | = help: Replace with conversion flag @@ -24,7 +24,7 @@ RUF010.py:9:16: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 | ^^^^^^^^^ RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | = help: Replace with conversion flag @@ -43,7 +43,7 @@ RUF010.py:9:29: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 | ^^^^^^^^^^ RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | = help: Replace with conversion flag @@ -61,10 +61,10 @@ RUF010.py:9:29: RUF010 [*] Use explicit conversion flag RUF010.py:11:4: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | ^^^^^^^^^^^ RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -82,10 +82,10 @@ RUF010.py:11:4: RUF010 [*] Use explicit conversion flag RUF010.py:11:19: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | ^^^^^^^^^^^^ RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -103,10 +103,10 @@ RUF010.py:11:19: RUF010 [*] Use explicit conversion flag RUF010.py:11:35: RUF010 [*] Use explicit conversion flag | 9 | f"{str(bla)}, {repr(bla)}, {ascii(bla)}" # RUF010 -10 | +10 | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 | ^^^^^^^^^^^^^ RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -124,10 +124,10 @@ RUF010.py:11:35: RUF010 [*] Use explicit conversion flag RUF010.py:13:5: RUF010 [*] Use explicit conversion flag | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | ^^^^^^^^ RUF010 -14 | +14 | 15 | f"{bla!s}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -145,10 +145,10 @@ RUF010.py:13:5: RUF010 [*] Use explicit conversion flag RUF010.py:13:19: RUF010 [*] Use explicit conversion flag | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | ^^^^^^^^^ RUF010 -14 | +14 | 15 | f"{bla!s}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -166,10 +166,10 @@ RUF010.py:13:19: RUF010 [*] Use explicit conversion flag RUF010.py:13:34: RUF010 [*] Use explicit conversion flag | 11 | f"{str(d['a'])}, {repr(d['b'])}, {ascii(d['c'])}" # RUF010 -12 | +12 | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | ^^^^^^^^^^ RUF010 -14 | +14 | 15 | f"{bla!s}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | = help: Replace with conversion flag @@ -187,10 +187,10 @@ RUF010.py:13:34: RUF010 [*] Use explicit conversion flag RUF010.py:15:14: RUF010 [*] Use explicit conversion flag | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 -14 | +14 | 15 | f"{bla!s}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | ^^^^^^^^^ RUF010 -16 | +16 | 17 | f"{foo(bla)}" # OK | = help: Replace with conversion flag @@ -208,10 +208,10 @@ RUF010.py:15:14: RUF010 [*] Use explicit conversion flag RUF010.py:15:29: RUF010 [*] Use explicit conversion flag | 13 | f"{(str(bla))}, {(repr(bla))}, {(ascii(bla))}" # RUF010 -14 | +14 | 15 | f"{bla!s}, {(repr(bla))}, {(ascii(bla))}" # RUF010 | ^^^^^^^^^^ RUF010 -16 | +16 | 17 | f"{foo(bla)}" # OK | = help: Replace with conversion flag @@ -244,6 +244,4 @@ RUF010.py:35:20: RUF010 [*] Use explicit conversion flag 35 |+ f" that flows {obj!r} of type {type(obj)}.{additional_message}" # RUF010 36 36 | ) 37 37 | -38 38 | - - +38 38 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012.py.snap index c6c9873efcc90..c83fb86785d00 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF012.py:9:34: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` | 7 | } - 8 | + 8 | 9 | mutable_default: list[int] = [] | ^^ RUF012 10 | immutable_annotation: Sequence[int] = [] @@ -31,4 +31,78 @@ RUF012.py:25:26: RUF012 Mutable class attributes should be annotated with `typin 27 | class_variable: ClassVar[list[int]] = [] | +RUF012.py:103:38: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +101 | class K(SQLModel): +102 | id: int +103 | mutable_default: list[int] = [] + | ^^ RUF012 +104 | +105 | from sqlmodel import SQLModel + | +RUF012.py:128:36: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +126 | } +127 | +128 | mutable_default: 'list[int]' = [] + | ^^ RUF012 +129 | immutable_annotation: 'Sequence[int]'= [] +130 | without_annotation = [] + | + +RUF012.py:129:44: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +128 | mutable_default: 'list[int]' = [] +129 | immutable_annotation: 'Sequence[int]'= [] + | ^^ RUF012 +130 | without_annotation = [] +131 | class_variable: 'ClassVar[list[int]]' = [] + | + +RUF012.py:130:26: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +128 | mutable_default: 'list[int]' = [] +129 | immutable_annotation: 'Sequence[int]'= [] +130 | without_annotation = [] + | ^^ RUF012 +131 | class_variable: 'ClassVar[list[int]]' = [] +132 | final_variable: 'Final[list[int]]' = [] + | + +RUF012.py:131:45: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +129 | immutable_annotation: 'Sequence[int]'= [] +130 | without_annotation = [] +131 | class_variable: 'ClassVar[list[int]]' = [] + | ^^ RUF012 +132 | final_variable: 'Final[list[int]]' = [] +133 | class_variable_without_subscript: 'ClassVar' = [] + | + +RUF012.py:132:42: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +130 | without_annotation = [] +131 | class_variable: 'ClassVar[list[int]]' = [] +132 | final_variable: 'Final[list[int]]' = [] + | ^^ RUF012 +133 | class_variable_without_subscript: 'ClassVar' = [] +134 | final_variable_without_subscript: 'Final' = [] + | + +RUF012.py:133:52: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +131 | class_variable: 'ClassVar[list[int]]' = [] +132 | final_variable: 'Final[list[int]]' = [] +133 | class_variable_without_subscript: 'ClassVar' = [] + | ^^ RUF012 +134 | final_variable_without_subscript: 'Final' = [] + | + +RUF012.py:134:49: RUF012 Mutable class attributes should be annotated with `typing.ClassVar` + | +132 | final_variable: 'Final[list[int]]' = [] +133 | class_variable_without_subscript: 'ClassVar' = [] +134 | final_variable_without_subscript: 'Final' = [] + | ^^ RUF012 + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012_deferred.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012_deferred.py.snap new file mode 100644 index 0000000000000..7f58cfd7246a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF012_RUF012_deferred.py.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_0.py.snap index 50bcc3df25e9f..ded2a1770c369 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_0.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_0.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF013_0.py:20:12: RUF013 [*] PEP 484 prohibits implicit `Optional` | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_1.py.snap index f2bf264ff57d4..c132eee6a9d55 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_1.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF013_1.py:4:12: RUF013 [*] PEP 484 prohibits implicit `Optional` | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_2.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_2.py.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_2.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_3.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_3.py.snap index f8172df9aafe2..2c90acd33887b 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_3.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_3.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF013_3.py:4:12: RUF013 [*] PEP 484 prohibits implicit `Optional` | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_4.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_4.py.snap new file mode 100644 index 0000000000000..1e4ea1f4eeff1 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF013_RUF013_4.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF013_4.py:15:61: RUF013 [*] PEP 484 prohibits implicit `Optional` + | +15 | def multiple_2(arg1: Optional, arg2: Optional = None, arg3: int = None): ... + | ^^^ RUF013 + | + = help: Convert to `T | None` + +ℹ Unsafe fix +12 12 | def multiple_1(arg1: Optional, arg2: Optional = None): ... +13 13 | +14 14 | +15 |-def multiple_2(arg1: Optional, arg2: Optional = None, arg3: int = None): ... + 15 |+def multiple_2(arg1: Optional, arg2: Optional = None, arg3: int | None = None): ... +16 16 | +17 17 | +18 18 | def return_type(arg: Optional = None) -> Optional: ... diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF015_RUF015.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF015_RUF015.py.snap index 7500f39c81f82..e0dcb01a6a050 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF015_RUF015.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF015_RUF015.py.snap @@ -68,7 +68,7 @@ RUF015.py:7:1: RUF015 [*] Prefer `next(iter(x))` over single element slice 6 | list(i for i in x)[0] 7 | [i for i in x][0] | ^^^^^^^^^^^^^^^^^ RUF015 -8 | +8 | 9 | # OK (not indexing (solely) the first element) | = help: Replace with `next(iter(x))` @@ -129,7 +129,7 @@ RUF015.py:31:1: RUF015 [*] Prefer `next((i, i + 1) for i in x)` over single elem 30 | [i for i in x if i > 5][0] 31 | [(i, i + 1) for i in x][0] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF015 -32 | +32 | 33 | # RUF015 (multiple generators) | = help: Replace with `next((i, i + 1) for i in x)` @@ -150,7 +150,7 @@ RUF015.py:35:1: RUF015 [*] Prefer `next(i + j for i in x for j in y)` over singl 34 | y = range(10) 35 | [i + j for i in x for j in y][0] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF015 -36 | +36 | 37 | # RUF015 | = help: Replace with `next(i + j for i in x for j in y)` @@ -319,7 +319,7 @@ RUF015.py:45:1: RUF015 [*] Prefer `next(iter(x.y))` over single element slice 46 | | *x.y 47 | | ][0] | |____^ RUF015 -48 | +48 | 49 | # RUF015 (multi-line) | = help: Replace with `next(iter(x.y))` @@ -346,7 +346,7 @@ RUF015.py:50:26: RUF015 [*] Prefer `next(...)` over single element slice 53 | | if isinstance(a, ast.Assign) and a.targets[0].id == "REVISION_HEADS_MAP" 54 | | ][0] | |____^ RUF015 -55 | +55 | 56 | # RUF015 (zip) | = help: Replace with `next(...)` @@ -391,7 +391,7 @@ RUF015.py:58:1: RUF015 [*] Prefer `next(zip(x, y))` over single element slice 57 | list(zip(x, y))[0] 58 | [*zip(x, y)][0] | ^^^^^^^^^^^^^^^ RUF015 -59 | +59 | 60 | # RUF015 (pop) | = help: Replace with `next(zip(x, y))` @@ -452,7 +452,7 @@ RUF015.py:63:1: RUF015 [*] Prefer `next(iter(x))` over single element slice 62 | [i for i in x].pop(0) 63 | list(i for i in x).pop(0) | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF015 -64 | +64 | 65 | # OK | = help: Replace with `next(iter(x))` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF016_RUF016.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF016_RUF016.py.snap index 5e69aaee10156..32d0727cc8dd2 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF016_RUF016.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF016_RUF016.py.snap @@ -15,7 +15,7 @@ RUF016.py:21:14: RUF016 Indexed access to type `str` uses type `str` instead of 20 | var = "abc"["x"] 21 | var = f"abc"["x"] | ^^^ RUF016 -22 | +22 | 23 | # Should emit for invalid access on bytes | @@ -24,7 +24,7 @@ RUF016.py:24:14: RUF016 Indexed access to type `bytes` uses type `str` instead o 23 | # Should emit for invalid access on bytes 24 | var = b"abc"["x"] | ^^^ RUF016 -25 | +25 | 26 | # Should emit for invalid access on lists and tuples | @@ -42,7 +42,7 @@ RUF016.py:28:17: RUF016 Indexed access to type `tuple` uses type `str` instead o 27 | var = [1, 2, 3]["x"] 28 | var = (1, 2, 3)["x"] | ^^^ RUF016 -29 | +29 | 30 | # Should emit for invalid access on list comprehensions | @@ -51,7 +51,7 @@ RUF016.py:31:30: RUF016 Indexed access to type `list comprehension` uses type `s 30 | # Should emit for invalid access on list comprehensions 31 | var = [x for x in range(10)]["x"] | ^^^ RUF016 -32 | +32 | 33 | # Should emit for invalid access using tuple | @@ -60,7 +60,7 @@ RUF016.py:34:13: RUF016 Indexed access to type `str` uses type `tuple` instead o 33 | # Should emit for invalid access using tuple 34 | var = "abc"[1, 2] | ^^^^ RUF016 -35 | +35 | 36 | # Should emit for invalid access using string | @@ -69,7 +69,7 @@ RUF016.py:37:14: RUF016 Indexed access to type `list` uses type `str` instead of 36 | # Should emit for invalid access using string 37 | var = [1, 2]["x"] | ^^^ RUF016 -38 | +38 | 39 | # Should emit for invalid access using float | @@ -78,7 +78,7 @@ RUF016.py:40:14: RUF016 Indexed access to type `list` uses type `float` instead 39 | # Should emit for invalid access using float 40 | var = [1, 2][0.25] | ^^^^ RUF016 -41 | +41 | 42 | # Should emit for invalid access using dict | @@ -87,7 +87,7 @@ RUF016.py:43:14: RUF016 Indexed access to type `list` uses type `dict` instead o 42 | # Should emit for invalid access using dict 43 | var = [1, 2][{"x": "y"}] | ^^^^^^^^^^ RUF016 -44 | +44 | 45 | # Should emit for invalid access using dict comp | @@ -96,7 +96,7 @@ RUF016.py:46:14: RUF016 Indexed access to type `list` uses type `dict comprehens 45 | # Should emit for invalid access using dict comp 46 | var = [1, 2][{x: "y" for x in range(2)}] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF016 -47 | +47 | 48 | # Should emit for invalid access using list | @@ -105,7 +105,7 @@ RUF016.py:49:14: RUF016 Indexed access to type `list` uses type `tuple` instead 48 | # Should emit for invalid access using list 49 | var = [1, 2][2, 3] | ^^^^ RUF016 -50 | +50 | 51 | # Should emit for invalid access using list comp | @@ -114,7 +114,7 @@ RUF016.py:52:14: RUF016 Indexed access to type `list` uses type `list comprehens 51 | # Should emit for invalid access using list comp 52 | var = [1, 2][[x for x in range(2)]] | ^^^^^^^^^^^^^^^^^^^^^ RUF016 -53 | +53 | 54 | # Should emit on invalid access using set | @@ -123,7 +123,7 @@ RUF016.py:55:14: RUF016 Indexed access to type `list` uses type `set` instead of 54 | # Should emit on invalid access using set 55 | var = [1, 2][{"x", "y"}] | ^^^^^^^^^^ RUF016 -56 | +56 | 57 | # Should emit on invalid access using set comp | @@ -132,7 +132,7 @@ RUF016.py:58:14: RUF016 Indexed access to type `list` uses type `set comprehensi 57 | # Should emit on invalid access using set comp 58 | var = [1, 2][{x for x in range(2)}] | ^^^^^^^^^^^^^^^^^^^^^ RUF016 -59 | +59 | 60 | # Should emit on invalid access using bytes | @@ -141,7 +141,7 @@ RUF016.py:61:14: RUF016 Indexed access to type `list` uses type `bytes` instead 60 | # Should emit on invalid access using bytes 61 | var = [1, 2][b"x"] | ^^^^ RUF016 -62 | +62 | 63 | # Should emit for non-integer slice start | @@ -209,7 +209,7 @@ RUF016.py:70:17: RUF016 Slice in indexed access to type `list` uses type `list c 69 | var = [1, 2, 3][{"x": x for x in range(2)}:2] 70 | var = [1, 2, 3][[x for x in range(2)]:2] | ^^^^^^^^^^^^^^^^^^^^^ RUF016 -71 | +71 | 72 | # Should emit for non-integer slice end | @@ -277,7 +277,7 @@ RUF016.py:79:19: RUF016 Slice in indexed access to type `list` uses type `list c 78 | var = [1, 2, 3][0:{"x": x for x in range(2)}] 79 | var = [1, 2, 3][0:[x for x in range(2)]] | ^^^^^^^^^^^^^^^^^^^^^ RUF016 -80 | +80 | 81 | # Should emit for non-integer slice step | @@ -345,7 +345,7 @@ RUF016.py:88:21: RUF016 Slice in indexed access to type `list` uses type `list c 87 | var = [1, 2, 3][0:1:{"x": x for x in range(2)}] 88 | var = [1, 2, 3][0:1:[x for x in range(2)]] | ^^^^^^^^^^^^^^^^^^^^^ RUF016 -89 | +89 | 90 | # Should emit for non-integer slice start and end; should emit twice with specific ranges | @@ -354,7 +354,7 @@ RUF016.py:91:17: RUF016 Slice in indexed access to type `list` uses type `str` i 90 | # Should emit for non-integer slice start and end; should emit twice with specific ranges 91 | var = [1, 2, 3]["x":"y"] | ^^^ RUF016 -92 | +92 | 93 | # Should emit once for repeated invalid access | @@ -363,7 +363,7 @@ RUF016.py:91:21: RUF016 Slice in indexed access to type `list` uses type `str` i 90 | # Should emit for non-integer slice start and end; should emit twice with specific ranges 91 | var = [1, 2, 3]["x":"y"] | ^^^ RUF016 -92 | +92 | 93 | # Should emit once for repeated invalid access | @@ -372,8 +372,6 @@ RUF016.py:94:17: RUF016 Indexed access to type `list` uses type `str` instead of 93 | # Should emit once for repeated invalid access 94 | var = [1, 2, 3]["x"]["y"]["z"] | ^^^ RUF016 -95 | +95 | 96 | # Cannot emit on invalid access using variable in index | - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_0.py.snap index aad3c2fed9103..71be7e5fb593b 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_0.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_0.py.snap @@ -109,7 +109,7 @@ RUF017_0.py:9:1: RUF017 [*] Avoid quadratic list summation 9 | / sum([[1, 2, 3], [4, 5, 6]], 10 | | []) | |_______^ RUF017 -11 | +11 | 12 | # OK | = help: Replace with `functools.reduce` @@ -134,7 +134,7 @@ RUF017_0.py:9:1: RUF017 [*] Avoid quadratic list summation RUF017_0.py:21:5: RUF017 [*] Avoid quadratic list summation | 19 | import functools, operator -20 | +20 | 21 | sum([x, y], []) | ^^^^^^^^^^^^^^^ RUF017 | @@ -171,5 +171,3 @@ RUF017_0.py:26:5: RUF017 [*] Avoid quadratic list summation 25 27 | def func(): 26 |- sum((factor.dims for factor in bases), []) 28 |+ functools.reduce(operator.iadd, (factor.dims for factor in bases), []) - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_1.py.snap index ff3b145e56799..4622f8eb6e25d 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_1.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF017_RUF017_1.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF017_1.py:1:1: RUF017 [*] Avoid quadratic list summation | @@ -13,5 +14,3 @@ RUF017_1.py:1:1: RUF017 [*] Avoid quadratic list summation 1 |+import functools 2 |+import operator 3 |+functools.reduce(operator.iadd, (factor.dims for factor in bases), []) - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF018_RUF018.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF018_RUF018.py.snap index d4ceedb6246cf..4ca2e189dbfa0 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF018_RUF018.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF018_RUF018.py.snap @@ -7,6 +7,7 @@ RUF018.py:2:9: RUF018 Avoid assignment expressions in `assert` statements 2 | assert (x := 0) == 0 | ^^^^^^ RUF018 3 | assert x, (y := "error") +4 | print(x, y) | RUF018.py:3:12: RUF018 Avoid assignment expressions in `assert` statements @@ -15,8 +16,5 @@ RUF018.py:3:12: RUF018 Avoid assignment expressions in `assert` statements 2 | assert (x := 0) == 0 3 | assert x, (y := "error") | ^^^^^^^^^^^^ RUF018 -4 | -5 | # OK +4 | print(x, y) | - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF019_RUF019.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF019_RUF019.py.snap index f536eb250ac13..24416b08b7587 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF019_RUF019.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF019_RUF019.py.snap @@ -42,7 +42,7 @@ RUF019.py:7:4: RUF019 [*] Unnecessary key check before dictionary access RUF019.py:10:4: RUF019 [*] Unnecessary key check before dictionary access | 8 | pass - 9 | + 9 | 10 | if (k) in d and d[k]: | ^^^^^^^^^^^^^^^^^ RUF019 11 | pass @@ -62,7 +62,7 @@ RUF019.py:10:4: RUF019 [*] Unnecessary key check before dictionary access RUF019.py:13:4: RUF019 [*] Unnecessary key check before dictionary access | 11 | pass -12 | +12 | 13 | if k in d and d[(k)]: | ^^^^^^^^^^^^^^^^^ RUF019 14 | pass @@ -82,10 +82,10 @@ RUF019.py:13:4: RUF019 [*] Unnecessary key check before dictionary access RUF019.py:16:6: RUF019 [*] Unnecessary key check before dictionary access | 14 | pass -15 | +15 | 16 | not ("key" in dct and dct["key"]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF019 -17 | +17 | 18 | bool("key" in dct and dct["key"]) | = help: Replace with `dict.get` @@ -103,10 +103,10 @@ RUF019.py:16:6: RUF019 [*] Unnecessary key check before dictionary access RUF019.py:18:6: RUF019 [*] Unnecessary key check before dictionary access | 16 | not ("key" in dct and dct["key"]) -17 | +17 | 18 | bool("key" in dct and dct["key"]) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF019 -19 | +19 | 20 | # OK | = help: Replace with `dict.get` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF020_RUF020.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF020_RUF020.py.snap index 64fd30b4ed4d2..93eccd0055449 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF020_RUF020.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF020_RUF020.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF020.py:3:7: RUF020 [*] `Union[Never, T]` is equivalent to `T` | 1 | from typing import Never, NoReturn, Union -2 | +2 | 3 | Union[Never, int] | ^^^^^ RUF020 4 | Union[NoReturn, int] @@ -81,6 +81,7 @@ RUF020.py:6:1: RUF020 [*] `NoReturn | T` is equivalent to `T` 6 |+int 7 7 | Union[Union[Never, int], Union[NoReturn, int]] 8 8 | Union[NoReturn, int, float] +9 9 | RUF020.py:7:13: RUF020 [*] `Union[Never, T]` is equivalent to `T` | @@ -99,6 +100,8 @@ RUF020.py:7:13: RUF020 [*] `Union[Never, T]` is equivalent to `T` 7 |-Union[Union[Never, int], Union[NoReturn, int]] 7 |+Union[int, Union[NoReturn, int]] 8 8 | Union[NoReturn, int, float] +9 9 | +10 10 | RUF020.py:7:32: RUF020 [*] `Union[NoReturn, T]` is equivalent to `T` | @@ -117,6 +120,8 @@ RUF020.py:7:32: RUF020 [*] `Union[NoReturn, T]` is equivalent to `T` 7 |-Union[Union[Never, int], Union[NoReturn, int]] 7 |+Union[Union[Never, int], int] 8 8 | Union[NoReturn, int, float] +9 9 | +10 10 | RUF020.py:8:7: RUF020 [*] `Union[NoReturn, T]` is equivalent to `T` | @@ -133,5 +138,63 @@ RUF020.py:8:7: RUF020 [*] `Union[NoReturn, T]` is equivalent to `T` 7 7 | Union[Union[Never, int], Union[NoReturn, int]] 8 |-Union[NoReturn, int, float] 8 |+Union[int, float] +9 9 | +10 10 | +11 11 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +RUF020.py:12:11: RUF020 `Never | T` is equivalent to `T` + | +11 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +12 | x: None | Never | None + | ^^^^^ RUF020 +13 | y: (None | Never) | None +14 | z: None | (Never | None) + | + = help: Remove `Never` +RUF020.py:13:12: RUF020 `Never | T` is equivalent to `T` + | +11 | # Regression tests for https://github.com/astral-sh/ruff/issues/14567 +12 | x: None | Never | None +13 | y: (None | Never) | None + | ^^^^^ RUF020 +14 | z: None | (Never | None) + | + = help: Remove `Never` + +RUF020.py:14:12: RUF020 `Never | T` is equivalent to `T` + | +12 | x: None | Never | None +13 | y: (None | Never) | None +14 | z: None | (Never | None) + | ^^^^^ RUF020 +15 | +16 | a: int | Never | None + | + = help: Remove `Never` + +RUF020.py:16:10: RUF020 `Never | T` is equivalent to `T` + | +14 | z: None | (Never | None) +15 | +16 | a: int | Never | None + | ^^^^^ RUF020 +17 | b: Never | Never | None + | + = help: Remove `Never` + +RUF020.py:17:4: RUF020 `Never | T` is equivalent to `T` + | +16 | a: int | Never | None +17 | b: Never | Never | None + | ^^^^^ RUF020 + | + = help: Remove `Never` + +RUF020.py:17:12: RUF020 `Never | T` is equivalent to `T` + | +16 | a: int | Never | None +17 | b: Never | Never | None + | ^^^^^ RUF020 + | + = help: Remove `Never` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF021_RUF021.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF021_RUF021.py.snap index 0660b0b97f85a..5239070ff1f95 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF021_RUF021.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF021_RUF021.py.snap @@ -26,7 +26,7 @@ RUF021.py:13:10: RUF021 [*] Parenthesize `a and b` expressions when chaining `an 12 | x = a or b and c # RUF021: => `a or (b and c)` 13 | x = a or b and c # looooooooooooooooooooooooooooooong comment but it won't prevent an autofix | ^^^^^^^ RUF021 -14 | +14 | 15 | a, b, c = 0, 1, 2 | = help: Parenthesize the `and` subexpression @@ -46,7 +46,7 @@ RUF021.py:16:5: RUF021 [*] Parenthesize `a and b` expressions when chaining `and 15 | a, b, c = 0, 1, 2 16 | y = a and b or c # RUF021: => `(a and b) or c` | ^^^^^^^ RUF021 -17 | +17 | 18 | a, b, c, d = 1, 2, 0, 3 | = help: Parenthesize the `and` subexpression @@ -144,7 +144,7 @@ RUF021.py:35:44: RUF021 [*] Parenthesize `a and b` expressions when chaining `an 34 | # RUF021: => `a or b or c or (d and e)`: 35 | z = [a for a in range(5) if a or b or c or d and e] | ^^^^^^^ RUF021 -36 | +36 | 37 | a, b, c, d = 0, 1, 3, 0 | = help: Parenthesize the `and` subexpression @@ -164,7 +164,7 @@ RUF021.py:38:8: RUF021 [*] Parenthesize `a and b` expressions when chaining `and 37 | a, b, c, d = 0, 1, 3, 0 38 | assert not a and b or c or d # RUF021: => `(not a and b) or c or d` | ^^^^^^^^^^^ RUF021 -39 | +39 | 40 | if (not a) and b or c or d: # RUF021: => `((not a) and b) or c or d` | = help: Parenthesize the `and` subexpression @@ -182,7 +182,7 @@ RUF021.py:38:8: RUF021 [*] Parenthesize `a and b` expressions when chaining `and RUF021.py:40:4: RUF021 [*] Parenthesize `a and b` expressions when chaining `and` and `or` together, to make the precedence clear | 38 | assert not a and b or c or d # RUF021: => `(not a and b) or c or d` -39 | +39 | 40 | if (not a) and b or c or d: # RUF021: => `((not a) and b) or c or d` | ^^^^^^^^^^^^^ RUF021 41 | if (not a and b) or c or d: # OK diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF022_RUF022.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF022_RUF022.py.snap index c886b91ccf04d..f512d92a1d7ac 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF022_RUF022.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF022_RUF022.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF022.py:5:11: RUF022 [*] `__all__` is not sorted | 3 | ################################################## -4 | +4 | 5 | __all__ = ["d", "c", "b", "a"] # a comment that is untouched | ^^^^^^^^^^^^^^^^^^^^ RUF022 6 | __all__ += ["foo", "bar", "antipasti"] @@ -47,7 +47,7 @@ RUF022.py:7:11: RUF022 [*] `__all__` is not sorted 6 | __all__ += ["foo", "bar", "antipasti"] 7 | __all__ = ("d", "c", "b", "a") | ^^^^^^^^^^^^^^^^^^^^ RUF022 -8 | +8 | 9 | # Quoting style is retained, | = help: Apply an isort-style sorting to `__all__` @@ -89,7 +89,7 @@ RUF022.py:14:18: RUF022 [*] `__all__` is not sorted 13 | # (but they are in multiline `__all__` definitions) 14 | __all__: tuple = ("b", "c", "a",) | ^^^^^^^^^^^^^^^^ RUF022 -15 | +15 | 16 | if bool(): | = help: Apply an isort-style sorting to `__all__` @@ -130,7 +130,7 @@ RUF022.py:19:16: RUF022 [*] `__all__` is not sorted 18 | else: 19 | __all__ += "foo3", "foo2", "foo1" # NB: an implicit tuple (without parens) | ^^^^^^^^^^^^^^^^^^^^^^ RUF022 -20 | +20 | 21 | __all__: list[str] = ["the", "three", "little", "pigs"] | = help: Apply an isort-style sorting to `__all__` @@ -148,10 +148,10 @@ RUF022.py:19:16: RUF022 [*] `__all__` is not sorted RUF022.py:21:22: RUF022 [*] `__all__` is not sorted | 19 | __all__ += "foo3", "foo2", "foo1" # NB: an implicit tuple (without parens) -20 | +20 | 21 | __all__: list[str] = ["the", "three", "little", "pigs"] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF022 -22 | +22 | 23 | __all__ = ("parenthesized_item"), "in", ("an_unparenthesized_tuple") | = help: Apply an isort-style sorting to `__all__` @@ -169,7 +169,7 @@ RUF022.py:21:22: RUF022 [*] `__all__` is not sorted RUF022.py:23:11: RUF022 [*] `__all__` is not sorted | 21 | __all__: list[str] = ["the", "three", "little", "pigs"] -22 | +22 | 23 | __all__ = ("parenthesized_item"), "in", ("an_unparenthesized_tuple") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF022 24 | __all__.extend(["foo", "bar"]) @@ -233,7 +233,7 @@ RUF022.py:26:19: RUF022 [*] `__all__` is not sorted 25 | __all__.extend(("foo", "bar")) 26 | __all__.extend((((["foo", "bar"])))) | ^^^^^^^^^^^^^^ RUF022 -27 | +27 | 28 | #################################### | = help: Apply an isort-style sorting to `__all__` @@ -251,7 +251,7 @@ RUF022.py:26:19: RUF022 [*] `__all__` is not sorted RUF022.py:32:11: RUF022 [*] `__all__` is not sorted | 30 | #################################### -31 | +31 | 32 | __all__ = ( | ___________^ 33 | | "d0", @@ -261,12 +261,12 @@ RUF022.py:32:11: RUF022 [*] `__all__` is not sorted 37 | | "a0" 38 | | ) | |_^ RUF022 -39 | +39 | 40 | __all__ = [ | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 30 30 | #################################### 31 31 | 32 32 | __all__ = ( @@ -286,7 +286,7 @@ RUF022.py:32:11: RUF022 [*] `__all__` is not sorted RUF022.py:40:11: RUF022 [*] `__all__` is not sorted | 38 | ) -39 | +39 | 40 | __all__ = [ | ___________^ 41 | | "d", @@ -296,12 +296,12 @@ RUF022.py:40:11: RUF022 [*] `__all__` is not sorted 45 | | "a" 46 | | ] | |_^ RUF022 -47 | +47 | 48 | # we implement an "isort-style sort": | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 38 38 | ) 39 39 | 40 40 | __all__ = [ @@ -355,7 +355,7 @@ RUF022.py:54:11: RUF022 [*] `__all__` is not sorted 83 | | "weekday", 84 | | "weekheader"] | |_________________^ RUF022 -85 | +85 | 86 | ########################################## | = help: Apply an isort-style sorting to `__all__` @@ -422,7 +422,7 @@ RUF022.py:91:11: RUF022 [*] `__all__` is not sorted | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 88 88 | ########################################## 89 89 | 90 90 | # comment0 @@ -447,7 +447,7 @@ RUF022.py:91:11: RUF022 [*] `__all__` is not sorted RUF022.py:101:11: RUF022 [*] `__all__` is not sorted | 99 | # comment7 -100 | +100 | 101 | __all__ = [ # comment0 | ___________^ 102 | | # comment1 @@ -458,12 +458,12 @@ RUF022.py:101:11: RUF022 [*] `__all__` is not sorted 107 | | # comment6 108 | | ] # comment7 | |_^ RUF022 -109 | +109 | 110 | __all__ = ["register", "lookup", "open", "EncodedFile", "BOM", "BOM_BE", | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 99 99 | # comment7 100 100 | 101 101 | __all__ = [ # comment0 @@ -481,7 +481,7 @@ RUF022.py:101:11: RUF022 [*] `__all__` is not sorted RUF022.py:110:11: RUF022 [*] `__all__` is not sorted | 108 | ] # comment7 -109 | +109 | 110 | __all__ = ["register", "lookup", "open", "EncodedFile", "BOM", "BOM_BE", | ___________^ 111 | | "BOM_LE", "BOM32_BE", "BOM32_LE", "BOM64_BE", "BOM64_LE", @@ -498,7 +498,7 @@ RUF022.py:110:11: RUF022 [*] `__all__` is not sorted 122 | | "backslashreplace_errors", "namereplace_errors", 123 | | "register_error", "lookup_error"] | |____________________________________________^ RUF022 -124 | +124 | 125 | __all__: tuple[str, ...] = ( # a comment about the opening paren | = help: Apply an isort-style sorting to `__all__` @@ -574,7 +574,7 @@ RUF022.py:110:11: RUF022 [*] `__all__` is not sorted RUF022.py:125:28: RUF022 [*] `__all__` is not sorted | 123 | "register_error", "lookup_error"] -124 | +124 | 125 | __all__: tuple[str, ...] = ( # a comment about the opening paren | ____________________________^ 126 | | # multiline comment about "bbb" part 1 @@ -585,12 +585,12 @@ RUF022.py:125:28: RUF022 [*] `__all__` is not sorted 131 | | "aaa", 132 | | ) | |_^ RUF022 -133 | +133 | 134 | # we use natural sort for `__all__`, | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 123 123 | "register_error", "lookup_error"] 124 124 | 125 125 | __all__: tuple[str, ...] = ( # a comment about the opening paren @@ -619,7 +619,7 @@ RUF022.py:138:11: RUF022 [*] `__all__` is not sorted 142 | | "aadvark532" # the even longer whitespace span before this comment is retained 143 | | ) | |_^ RUF022 -144 | +144 | 145 | __all__.extend(( # comment0 | = help: Apply an isort-style sorting to `__all__` @@ -642,7 +642,7 @@ RUF022.py:138:11: RUF022 [*] `__all__` is not sorted RUF022.py:145:16: RUF022 [*] `__all__` is not sorted | 143 | ) -144 | +144 | 145 | __all__.extend(( # comment0 | ________________^ 146 | | # comment about foo @@ -652,12 +652,12 @@ RUF022.py:145:16: RUF022 [*] `__all__` is not sorted 150 | | # comment1 151 | | )) # comment2 | |_^ RUF022 -152 | +152 | 153 | __all__.extend( # comment0 | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 143 143 | ) 144 144 | 145 145 | __all__.extend(( # comment0 @@ -676,8 +676,7 @@ RUF022.py:155:5: RUF022 [*] `__all__` is not sorted | 153 | __all__.extend( # comment0 154 | # comment1 -155 | ( # comment2 - | _____^ +155 | / ( # comment2 156 | | # comment about foo 157 | | "foo", # comment about foo 158 | | # comment about bar @@ -689,7 +688,7 @@ RUF022.py:155:5: RUF022 [*] `__all__` is not sorted | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 153 153 | __all__.extend( # comment0 154 154 | # comment1 155 155 | ( # comment2 @@ -707,7 +706,7 @@ RUF022.py:155:5: RUF022 [*] `__all__` is not sorted RUF022.py:164:16: RUF022 [*] `__all__` is not sorted | 162 | ) # comment2 -163 | +163 | 164 | __all__.extend([ # comment0 | ________________^ 165 | | # comment about foo @@ -717,12 +716,12 @@ RUF022.py:164:16: RUF022 [*] `__all__` is not sorted 169 | | # comment1 170 | | ]) # comment2 | |_^ RUF022 -171 | +171 | 172 | __all__.extend( # comment0 | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 162 162 | ) # comment2 163 163 | 164 164 | __all__.extend([ # comment0 @@ -741,8 +740,7 @@ RUF022.py:174:5: RUF022 [*] `__all__` is not sorted | 172 | __all__.extend( # comment0 173 | # comment1 -174 | [ # comment2 - | _____^ +174 | / [ # comment2 175 | | # comment about foo 176 | | "foo", # comment about foo 177 | | # comment about bar @@ -754,7 +752,7 @@ RUF022.py:174:5: RUF022 [*] `__all__` is not sorted | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 172 172 | __all__.extend( # comment0 173 173 | # comment1 174 174 | [ # comment2 @@ -772,19 +770,19 @@ RUF022.py:174:5: RUF022 [*] `__all__` is not sorted RUF022.py:183:11: RUF022 [*] `__all__` is not sorted | 181 | ) # comment2 -182 | +182 | 183 | __all__ = ["Style", "Treeview", | ___________^ 184 | | # Extensions 185 | | "LabeledScale", "OptionMenu", 186 | | ] | |_^ RUF022 -187 | +187 | 188 | __all__ = ["Awaitable", "Coroutine", | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 180 180 | ] # comment4 181 181 | ) # comment2 182 182 | @@ -804,13 +802,13 @@ RUF022.py:183:11: RUF022 [*] `__all__` is not sorted RUF022.py:188:11: RUF022 [*] `__all__` is not sorted | 186 | ] -187 | +187 | 188 | __all__ = ["Awaitable", "Coroutine", | ___________^ 189 | | "AsyncIterable", "AsyncIterator", "AsyncGenerator", 190 | | ] | |____________^ RUF022 -191 | +191 | 192 | __all__ = [ | = help: Apply an isort-style sorting to `__all__` @@ -836,7 +834,7 @@ RUF022.py:188:11: RUF022 [*] `__all__` is not sorted RUF022.py:192:11: RUF022 [*] `__all__` is not sorted | 190 | ] -191 | +191 | 192 | __all__ = [ | ___________^ 193 | | "foo", @@ -844,7 +842,7 @@ RUF022.py:192:11: RUF022 [*] `__all__` is not sorted 195 | | "baz", 196 | | ] | |_____^ RUF022 -197 | +197 | 198 | ######################################################################### | = help: Apply an isort-style sorting to `__all__` @@ -864,7 +862,7 @@ RUF022.py:192:11: RUF022 [*] `__all__` is not sorted RUF022.py:204:11: RUF022 `__all__` is not sorted | 202 | ######################################################################### -203 | +203 | 204 | __all__ = ( | ___________^ 205 | | "look", @@ -873,7 +871,7 @@ RUF022.py:204:11: RUF022 `__all__` is not sorted 208 | | ), 209 | | ) | |_^ RUF022 -210 | +210 | 211 | __all__ = ( | = help: Apply an isort-style sorting to `__all__` @@ -881,7 +879,7 @@ RUF022.py:204:11: RUF022 `__all__` is not sorted RUF022.py:211:11: RUF022 `__all__` is not sorted | 209 | ) -210 | +210 | 211 | __all__ = ( | ___________^ 212 | | "b", @@ -891,7 +889,7 @@ RUF022.py:211:11: RUF022 `__all__` is not sorted 216 | | "a" 217 | | ) | |_^ RUF022 -218 | +218 | 219 | __all__ = ("don't" "care" "about", "__all__" "with", "concatenated" "strings") | = help: Apply an isort-style sorting to `__all__` @@ -899,10 +897,10 @@ RUF022.py:211:11: RUF022 `__all__` is not sorted RUF022.py:219:11: RUF022 `__all__` is not sorted | 217 | ) -218 | +218 | 219 | __all__ = ("don't" "care" "about", "__all__" "with", "concatenated" "strings") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF022 -220 | +220 | 221 | ############################################################ | = help: Apply an isort-style sorting to `__all__` @@ -910,13 +908,13 @@ RUF022.py:219:11: RUF022 `__all__` is not sorted RUF022.py:225:11: RUF022 [*] `__all__` is not sorted | 223 | ############################################################ -224 | +224 | 225 | __all__ = ( | ___________^ 226 | | "loads", 227 | | "dumps",) | |_____________^ RUF022 -228 | +228 | 229 | __all__ = [ | = help: Apply an isort-style sorting to `__all__` @@ -936,13 +934,13 @@ RUF022.py:225:11: RUF022 [*] `__all__` is not sorted RUF022.py:229:11: RUF022 [*] `__all__` is not sorted | 227 | "dumps",) -228 | +228 | 229 | __all__ = [ | ___________^ 230 | | "loads", 231 | | "dumps" , ] | |_________________________^ RUF022 -232 | +232 | 233 | __all__ = ['xp', 'yp', | = help: Apply an isort-style sorting to `__all__` @@ -962,19 +960,19 @@ RUF022.py:229:11: RUF022 [*] `__all__` is not sorted RUF022.py:233:11: RUF022 [*] `__all__` is not sorted | 231 | "dumps" , ] -232 | +232 | 233 | __all__ = ['xp', 'yp', | ___________^ 234 | | 'canvas' -235 | | +235 | | 236 | | # very strangely placed comment -237 | | +237 | | 238 | | , -239 | | +239 | | 240 | | # another strangely placed comment 241 | | ] | |_________________^ RUF022 -242 | +242 | 243 | __all__ = ( | = help: Apply an isort-style sorting to `__all__` @@ -996,7 +994,7 @@ RUF022.py:233:11: RUF022 [*] `__all__` is not sorted RUF022.py:243:11: RUF022 [*] `__all__` is not sorted | 241 | ] -242 | +242 | 243 | __all__ = ( | ___________^ 244 | | "foo" @@ -1008,12 +1006,12 @@ RUF022.py:243:11: RUF022 [*] `__all__` is not sorted 250 | | , 251 | | ) | |_^ RUF022 -252 | +252 | 253 | __all__ = ( # comment about the opening paren | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 241 241 | ] 242 242 | 243 243 | __all__ = ( @@ -1031,7 +1029,7 @@ RUF022.py:243:11: RUF022 [*] `__all__` is not sorted RUF022.py:253:11: RUF022 [*] `__all__` is not sorted | 251 | ) -252 | +252 | 253 | __all__ = ( # comment about the opening paren | ___________^ 254 | | # multiline strange comment 0a @@ -1050,12 +1048,12 @@ RUF022.py:253:11: RUF022 [*] `__all__` is not sorted 267 | | # strange multiline comment 3b 268 | | ) # comment about the closing paren | |_^ RUF022 -269 | +269 | 270 | ################################### | = help: Apply an isort-style sorting to `__all__` -ℹ Safe fix +ℹ Unsafe fix 251 251 | ) 252 252 | 253 253 | __all__ = ( # comment about the opening paren @@ -1076,5 +1074,3 @@ RUF022.py:253:11: RUF022 [*] `__all__` is not sorted 263 263 | # strange multiline comment comment 2a 264 264 | # strange multiline comment 2b 265 265 | , - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF023_RUF023.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF023_RUF023.py.snap index 7365bb1259708..452195dad73dc 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF023_RUF023.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF023_RUF023.py.snap @@ -26,7 +26,7 @@ RUF023.py:7:17: RUF023 [*] `Klass.__slots__` is not sorted 6 | __slots__ = ["d", "c", "b", "a"] # a comment that is untouched 7 | __slots__ = ("d", "c", "b", "a") | ^^^^^^^^^^^^^^^^^^^^ RUF023 -8 | +8 | 9 | # Quoting style is retained, | = help: Apply a natural sort to `Klass.__slots__` @@ -68,7 +68,7 @@ RUF023.py:14:24: RUF023 [*] `Klass.__slots__` is not sorted 13 | # (but they are in multiline definitions) 14 | __slots__: tuple = ("b", "c", "a",) | ^^^^^^^^^^^^^^^^ RUF023 -15 | +15 | 16 | class Klass2: | = help: Apply a natural sort to `Klass.__slots__` @@ -110,7 +110,7 @@ RUF023.py:20:21: RUF023 [*] `Klass2.__slots__` is not sorted 19 | else: 20 | __slots__ = "foo3", "foo2", "foo1" # NB: an implicit tuple (without parens) | ^^^^^^^^^^^^^^^^^^^^^^ RUF023 -21 | +21 | 22 | __slots__: list[str] = ["the", "three", "little", "pigs"] | = help: Apply a natural sort to `Klass2.__slots__` @@ -128,7 +128,7 @@ RUF023.py:20:21: RUF023 [*] `Klass2.__slots__` is not sorted RUF023.py:22:28: RUF023 [*] `Klass2.__slots__` is not sorted | 20 | __slots__ = "foo3", "foo2", "foo1" # NB: an implicit tuple (without parens) -21 | +21 | 22 | __slots__: list[str] = ["the", "three", "little", "pigs"] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF023 23 | __slots__ = ("parenthesized_item"), "in", ("an_unparenthesized_tuple") @@ -172,7 +172,7 @@ RUF023.py:26:17: RUF023 [*] `Klass2.__slots__` is not sorted 25 | # not alphabetical sort or "isort-style" sort 26 | __slots__ = {"aadvark237", "aadvark10092", "aadvark174", "aadvark532"} | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF023 -27 | +27 | 28 | ############################ | = help: Apply a natural sort to `Klass2.__slots__` @@ -204,7 +204,7 @@ RUF023.py:33:17: RUF023 [*] `Klass3.__slots__` is not sorted | = help: Apply a natural sort to `Klass3.__slots__` -ℹ Safe fix +ℹ Unsafe fix 31 31 | 32 32 | class Klass3: 33 33 | __slots__ = ( @@ -234,12 +234,12 @@ RUF023.py:40:17: RUF023 [*] `Klass3.__slots__` is not sorted 45 | | "a" 46 | | ] | |_____^ RUF023 -47 | +47 | 48 | ################################## | = help: Apply a natural sort to `Klass3.__slots__` -ℹ Safe fix +ℹ Unsafe fix 38 38 | "a0" 39 39 | ) 40 40 | __slots__ = [ @@ -274,7 +274,7 @@ RUF023.py:54:17: RUF023 [*] `Klass4.__slots__` is not sorted | = help: Apply a natural sort to `Klass4.__slots__` -ℹ Safe fix +ℹ Unsafe fix 51 51 | 52 52 | class Klass4: 53 53 | # comment0 @@ -299,7 +299,7 @@ RUF023.py:54:17: RUF023 [*] `Klass4.__slots__` is not sorted RUF023.py:64:17: RUF023 [*] `Klass4.__slots__` is not sorted | 62 | # comment7 -63 | +63 | 64 | __slots__ = [ # comment0 | _________________^ 65 | | # comment1 @@ -310,12 +310,12 @@ RUF023.py:64:17: RUF023 [*] `Klass4.__slots__` is not sorted 70 | | # comment6 71 | | ] # comment7 | |_____^ RUF023 -72 | +72 | 73 | # from cpython/Lib/pathlib/__init__.py | = help: Apply a natural sort to `Klass4.__slots__` -ℹ Safe fix +ℹ Unsafe fix 62 62 | # comment7 63 63 | 64 64 | __slots__ = [ # comment0 @@ -339,7 +339,7 @@ RUF023.py:75:17: RUF023 [*] `PurePath.__slots__` is not sorted 76 | | # The `_raw_paths` slot stores unnormalized string paths. This is set 77 | | # in the `__init__()` method. 78 | | '_raw_paths', - 79 | | + 79 | | 80 | | # The `_drv`, `_root` and `_tail_cached` slots store parsed and 81 | | # normalized parts of the path. They are set when any of the `drive`, 82 | | # `root` or `_tail` properties are accessed for the first time. The @@ -348,35 +348,35 @@ RUF023.py:75:17: RUF023 [*] `PurePath.__slots__` is not sorted 85 | | # separators (i.e. it is a list of strings), and that the root and 86 | | # tail are normalized. 87 | | '_drv', '_root', '_tail_cached', - 88 | | + 88 | | 89 | | # The `_str` slot stores the string representation of the path, 90 | | # computed from the drive, root and tail when `__str__()` is called 91 | | # for the first time. It's used to implement `_str_normcase` 92 | | '_str', - 93 | | + 93 | | 94 | | # The `_str_normcase_cached` slot stores the string path with 95 | | # normalized case. It is set when the `_str_normcase` property is 96 | | # accessed for the first time. It's used to implement `__eq__()` 97 | | # `__hash__()`, and `_parts_normcase` 98 | | '_str_normcase_cached', - 99 | | + 99 | | 100 | | # The `_parts_normcase_cached` slot stores the case-normalized 101 | | # string path after splitting on path separators. It's set when the 102 | | # `_parts_normcase` property is accessed for the first time. It's used 103 | | # to implement comparison methods like `__lt__()`. 104 | | '_parts_normcase_cached', -105 | | +105 | | 106 | | # The `_hash` slot stores the hash of the case-normalized string 107 | | # path. It's set when `__hash__()` is called for the first time. 108 | | '_hash', 109 | | ) | |_____^ RUF023 -110 | +110 | 111 | # From cpython/Lib/pickletools.py | = help: Apply a natural sort to `PurePath.__slots__` -ℹ Safe fix +ℹ Unsafe fix 73 73 | # from cpython/Lib/pathlib/__init__.py 74 74 | class PurePath: 75 75 | __slots__ = ( @@ -439,27 +439,27 @@ RUF023.py:113:17: RUF023 [*] `ArgumentDescriptor.__slots__` is not sorted | _________________^ 114 | | # name of descriptor record, also a module global name; a string 115 | | 'name', -116 | | +116 | | 117 | | # length of argument, in bytes; an int; UP_TO_NEWLINE and 118 | | # TAKEN_FROM_ARGUMENT{1,4,8} are negative values for variable-length 119 | | # cases 120 | | 'n', -121 | | +121 | | 122 | | # a function taking a file-like object, reading this kind of argument 123 | | # from the object at the current position, advancing the current 124 | | # position by n bytes, and returning the value of the argument 125 | | 'reader', -126 | | +126 | | 127 | | # human-readable docs for this arg descriptor; a string 128 | | 'doc', 129 | | ) | |_____^ RUF023 -130 | +130 | 131 | #################################### | = help: Apply a natural sort to `ArgumentDescriptor.__slots__` -ℹ Safe fix +ℹ Unsafe fix 111 111 | # From cpython/Lib/pickletools.py 112 112 | class ArgumentDescriptor(object): 113 113 | __slots__ = ( @@ -494,7 +494,7 @@ RUF023.py:138:17: RUF023 `SlotUser.__slots__` is not sorted | _________________^ 139 | | 'distance': 'measured in kilometers'} | |______________________________________________________^ RUF023 -140 | +140 | 141 | class Klass5: | = help: Apply a natural sort to `SlotUser.__slots__` @@ -538,7 +538,7 @@ RUF023.py:155:17: RUF023 `Klass5.__slots__` is not sorted 154 | ) 155 | __slots__ = ("don't" "care" "about", "__slots__" "with", "concatenated" "strings") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF023 -156 | +156 | 157 | ############################################################ | = help: Apply a natural sort to `Klass5.__slots__` @@ -550,7 +550,7 @@ RUF023.py:162:17: RUF023 [*] `BezierBuilder.__slots__` is not sorted | _________________^ 163 | | 'canvas',) | |___________________________^ RUF023 -164 | +164 | 165 | class BezierBuilder2: | = help: Apply a natural sort to `BezierBuilder.__slots__` @@ -577,7 +577,7 @@ RUF023.py:166:17: RUF023 [*] `BezierBuilder2.__slots__` is not sorted | _________________^ 167 | | 'canvas' , } | |___________________________________________^ RUF023 -168 | +168 | 169 | class BezierBuilder3: | = help: Apply a natural sort to `BezierBuilder2.__slots__` @@ -602,15 +602,15 @@ RUF023.py:170:17: RUF023 [*] `BezierBuilder3.__slots__` is not sorted 170 | __slots__ = ['xp', 'yp', | _________________^ 171 | | 'canvas' -172 | | +172 | | 173 | | # very strangely placed comment -174 | | +174 | | 175 | | , -176 | | +176 | | 177 | | # another strangely placed comment 178 | | ] | |__________________^ RUF023 -179 | +179 | 180 | class BezierBuilder4: | = help: Apply a natural sort to `BezierBuilder3.__slots__` @@ -643,12 +643,12 @@ RUF023.py:181:17: RUF023 [*] `BezierBuilder4.__slots__` is not sorted 188 | | , 189 | | ) | |_____^ RUF023 -190 | +190 | 191 | __slots__ = {"foo", "bar", | = help: Apply a natural sort to `BezierBuilder4.__slots__` -ℹ Safe fix +ℹ Unsafe fix 179 179 | 180 180 | class BezierBuilder4: 181 181 | __slots__ = ( @@ -666,7 +666,7 @@ RUF023.py:181:17: RUF023 [*] `BezierBuilder4.__slots__` is not sorted RUF023.py:191:17: RUF023 [*] `BezierBuilder4.__slots__` is not sorted | 189 | ) -190 | +190 | 191 | __slots__ = {"foo", "bar", | _________________^ 192 | | "baz", "bingo" diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF024_RUF024.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF024_RUF024.py.snap index f083f1920fa04..4c361c86398aa 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF024_RUF024.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF024_RUF024.py.snap @@ -132,7 +132,7 @@ RUF024.py:16:1: RUF024 [*] Do not pass mutable objects as values to `dict.fromke 15 | import builtins 16 | builtins.dict.fromkeys(pierogi_fillings, dict()) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF024 -17 | +17 | 18 | # Okay. | = help: Replace with comprehension diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF026_RUF026.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF026_RUF026.py.snap index 100ff9db321ba..aa55a482043a0 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF026_RUF026.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF026_RUF026.py.snap @@ -94,7 +94,7 @@ RUF026.py:27:5: RUF026 [*] `default_factory` is a positional-only argument to `d RUF026.py:34:5: RUF026 [*] `default_factory` is a positional-only argument to `defaultdict` | 32 | pass -33 | +33 | 34 | defaultdict(default_factory=foo) # RUF026 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF026 | @@ -131,7 +131,7 @@ RUF026.py:38:5: RUF026 [*] `default_factory` is a positional-only argument to `d RUF026.py:44:5: RUF026 [*] `default_factory` is a positional-only argument to `defaultdict` | 42 | from collections import deque -43 | +43 | 44 | defaultdict(default_factory=deque) # RUF026 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF026 | @@ -150,7 +150,7 @@ RUF026.py:44:5: RUF026 [*] `default_factory` is a positional-only argument to `d RUF026.py:52:5: RUF026 [*] `default_factory` is a positional-only argument to `defaultdict` | 50 | pass -51 | +51 | 52 | defaultdict(default_factory=MyCallable()) # RUF026 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF026 | @@ -223,8 +223,7 @@ RUF026.py:64:5: RUF026 [*] `default_factory` is a positional-only argument to `d RUF026.py:68:5: RUF026 [*] `default_factory` is a positional-only argument to `defaultdict` | 67 | def func(): -68 | defaultdict( - | _____^ +68 | / defaultdict( 69 | | member=1, 70 | | default_factory=tuple, 71 | | ) # RUF026 @@ -246,8 +245,7 @@ RUF026.py:68:5: RUF026 [*] `default_factory` is a positional-only argument to `d RUF026.py:75:5: RUF026 [*] `default_factory` is a positional-only argument to `defaultdict` | 74 | def func(): -75 | defaultdict( - | _____^ +75 | / defaultdict( 76 | | default_factory=tuple, 77 | | member=1, 78 | | ) # RUF026 @@ -264,6 +262,4 @@ RUF026.py:75:5: RUF026 [*] `default_factory` is a positional-only argument to `d 76 |+ tuple, member=1, 78 77 | ) # RUF026 79 78 | -80 79 | - - +80 79 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_0.py.snap index ca858cdcda640..590ff57921a60 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_0.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_0.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF027_0.py:5:7: RUF027 [*] Possible f-string without an `f` prefix | 3 | "always ignore this: {val}" -4 | +4 | 5 | print("but don't ignore this: {val}") # RUF027 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF027 | @@ -285,7 +285,7 @@ RUF027_0.py:70:18: RUF027 [*] Possible f-string without an `f` prefix 69 | last = "Appleseed" 70 | value.method("{first} {last}") # RUF027 | ^^^^^^^^^^^^^^^^ RUF027 -71 | +71 | 72 | def format_specifiers(): | = help: Add `f` prefix @@ -306,6 +306,8 @@ RUF027_0.py:74:9: RUF027 [*] Possible f-string without an `f` prefix 73 | a = 4 74 | b = "{a:b} {a:^5}" | ^^^^^^^^^^^^^^ RUF027 +75 | +76 | # fstrings are never correct as type definitions | = help: Add `f` prefix @@ -315,5 +317,6 @@ RUF027_0.py:74:9: RUF027 [*] Possible f-string without an `f` prefix 73 73 | a = 4 74 |- b = "{a:b} {a:^5}" 74 |+ b = f"{a:b} {a:^5}" - - +75 75 | +76 76 | # fstrings are never correct as type definitions +77 77 | # so we should always skip those diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_1.py.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_1.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_1.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_2.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_2.py.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_2.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF027_RUF027_2.py.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF028_RUF028.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF028_RUF028.py.snap index a2846ab41fa89..c3504d7828fb9 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF028_RUF028.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF028_RUF028.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF028.py:3:9: RUF028 [*] This suppression comment is invalid because it cannot be in an expression, pattern, argument list, or other non-statement | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF029_RUF029.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF029_RUF029.py.snap index 34cbd80ea666f..dbd3b6c632c32 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF029_RUF029.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF029_RUF029.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF029.py:38:11: RUF029 Function `fail_1a` is declared `async`, but doesn't `await` or use `async` features. | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF030_RUF030.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF030_RUF030.py.snap index aeea27858e988..8b6a2c39358c2 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF030_RUF030.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF030_RUF030.py.snap @@ -1,13 +1,13 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -RUF030.py:6:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:6:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 4 | # Expects: 5 | # - single StringLiteral 6 | assert True, print("This print is not intentional.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -7 | +7 | 8 | # Concatenated string literals | = help: Remove `print` @@ -22,13 +22,13 @@ RUF030.py:6:14: RUF030 [*] `print()` expression in `assert` statement is likely 8 8 | # Concatenated string literals 9 9 | # Expects: -RUF030.py:11:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:11:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 9 | # Expects: 10 | # - single StringLiteral 11 | assert True, print("This print" " is not intentional.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -12 | +12 | 13 | # Positional arguments, string literals | = help: Remove `print` @@ -43,13 +43,13 @@ RUF030.py:11:14: RUF030 [*] `print()` expression in `assert` statement is likely 13 13 | # Positional arguments, string literals 14 14 | # Expects: -RUF030.py:16:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:16:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 14 | # Expects: 15 | # - single StringLiteral concatenated with " " 16 | assert True, print("This print", "is not intentional") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -17 | +17 | 18 | # Concatenated string literals combined with Positional arguments | = help: Remove `print` @@ -64,13 +64,13 @@ RUF030.py:16:14: RUF030 [*] `print()` expression in `assert` statement is likely 18 18 | # Concatenated string literals combined with Positional arguments 19 19 | # Expects: -RUF030.py:21:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:21:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 19 | # Expects: 20 | # - single stringliteral concatenated with " " only between `print` and `is` 21 | assert True, print("This " "print", "is not intentional.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -22 | +22 | 23 | # Positional arguments, string literals with a variable | = help: Remove `print` @@ -85,13 +85,13 @@ RUF030.py:21:14: RUF030 [*] `print()` expression in `assert` statement is likely 23 23 | # Positional arguments, string literals with a variable 24 24 | # Expects: -RUF030.py:26:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:26:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 24 | # Expects: 25 | # - single FString concatenated with " " 26 | assert True, print("This", print.__name__, "is not intentional.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -27 | +27 | 28 | # Mixed brackets string literals | = help: Remove `print` @@ -106,13 +106,13 @@ RUF030.py:26:14: RUF030 [*] `print()` expression in `assert` statement is likely 28 28 | # Mixed brackets string literals 29 29 | # Expects: -RUF030.py:31:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:31:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 29 | # Expects: 30 | # - single StringLiteral concatenated with " " 31 | assert True, print("This print", 'is not intentional', """and should be removed""") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -32 | +32 | 33 | # Mixed brackets with other brackets inside | = help: Remove `print` @@ -127,13 +127,13 @@ RUF030.py:31:14: RUF030 [*] `print()` expression in `assert` statement is likely 33 33 | # Mixed brackets with other brackets inside 34 34 | # Expects: -RUF030.py:36:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:36:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 34 | # Expects: 35 | # - single StringLiteral concatenated with " " and escaped brackets 36 | assert True, print("This print", 'is not "intentional"', """and "should" be 'removed'""") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -37 | +37 | 38 | # Positional arguments, string literals with a separator | = help: Remove `print` @@ -148,13 +148,13 @@ RUF030.py:36:14: RUF030 [*] `print()` expression in `assert` statement is likely 38 38 | # Positional arguments, string literals with a separator 39 39 | # Expects: -RUF030.py:41:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:41:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 39 | # Expects: 40 | # - single StringLiteral concatenated with "|" 41 | assert True, print("This print", "is not intentional", sep="|") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -42 | +42 | 43 | # Positional arguments, string literals with None as separator | = help: Remove `print` @@ -169,13 +169,13 @@ RUF030.py:41:14: RUF030 [*] `print()` expression in `assert` statement is likely 43 43 | # Positional arguments, string literals with None as separator 44 44 | # Expects: -RUF030.py:46:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:46:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 44 | # Expects: 45 | # - single StringLiteral concatenated with " " 46 | assert True, print("This print", "is not intentional", sep=None) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -47 | +47 | 48 | # Positional arguments, string literals with variable as separator, needs f-string | = help: Remove `print` @@ -190,13 +190,13 @@ RUF030.py:46:14: RUF030 [*] `print()` expression in `assert` statement is likely 48 48 | # Positional arguments, string literals with variable as separator, needs f-string 49 49 | # Expects: -RUF030.py:51:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:51:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 49 | # Expects: 50 | # - single FString concatenated with "{U00A0}" 51 | assert True, print("This print", "is not intentional", sep=U00A0) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -52 | +52 | 53 | # Unnecessary f-string | = help: Remove `print` @@ -211,13 +211,13 @@ RUF030.py:51:14: RUF030 [*] `print()` expression in `assert` statement is likely 53 53 | # Unnecessary f-string 54 54 | # Expects: -RUF030.py:56:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:56:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 54 | # Expects: 55 | # - single StringLiteral 56 | assert True, print(f"This f-string is just a literal.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -57 | +57 | 58 | # Positional arguments, string literals and f-strings | = help: Remove `print` @@ -232,13 +232,13 @@ RUF030.py:56:14: RUF030 [*] `print()` expression in `assert` statement is likely 58 58 | # Positional arguments, string literals and f-strings 59 59 | # Expects: -RUF030.py:61:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:61:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 59 | # Expects: 60 | # - single FString concatenated with " " 61 | assert True, print("This print", f"is not {'intentional':s}") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -62 | +62 | 63 | # Positional arguments, string literals and f-strings with a separator | = help: Remove `print` @@ -253,13 +253,13 @@ RUF030.py:61:14: RUF030 [*] `print()` expression in `assert` statement is likely 63 63 | # Positional arguments, string literals and f-strings with a separator 64 64 | # Expects: -RUF030.py:66:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:66:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 64 | # Expects: 65 | # - single FString concatenated with "|" 66 | assert True, print("This print", f"is not {'intentional':s}", sep="|") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -67 | +67 | 68 | # A single f-string | = help: Remove `print` @@ -274,13 +274,13 @@ RUF030.py:66:14: RUF030 [*] `print()` expression in `assert` statement is likely 68 68 | # A single f-string 69 69 | # Expects: -RUF030.py:71:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:71:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 69 | # Expects: 70 | # - single FString 71 | assert True, print(f"This print is not {'intentional':s}") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -72 | +72 | 73 | # A single f-string with a redundant separator | = help: Remove `print` @@ -295,13 +295,13 @@ RUF030.py:71:14: RUF030 [*] `print()` expression in `assert` statement is likely 73 73 | # A single f-string with a redundant separator 74 74 | # Expects: -RUF030.py:76:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:76:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 74 | # Expects: 75 | # - single FString 76 | assert True, print(f"This print is not {'intentional':s}", sep="|") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -77 | +77 | 78 | # Complex f-string with variable as separator | = help: Remove `print` @@ -316,13 +316,13 @@ RUF030.py:76:14: RUF030 [*] `print()` expression in `assert` statement is likely 78 78 | # Complex f-string with variable as separator 79 79 | # Expects: -RUF030.py:83:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:83:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 81 | condition = "True is True" 82 | maintainer = "John Doe" 83 | assert True, print("Unreachable due to", condition, f", ask {maintainer} for advice", sep=U00A0) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF030 -84 | +84 | 85 | # Empty print | = help: Remove `print` @@ -337,13 +337,13 @@ RUF030.py:83:14: RUF030 [*] `print()` expression in `assert` statement is likely 85 85 | # Empty print 86 86 | # Expects: -RUF030.py:88:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:88:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 86 | # Expects: 87 | # - `msg` entirely removed from assertion 88 | assert True, print() | ^^^^^^^ RUF030 -89 | +89 | 90 | # Empty print with separator | = help: Remove `print` @@ -358,13 +358,13 @@ RUF030.py:88:14: RUF030 [*] `print()` expression in `assert` statement is likely 90 90 | # Empty print with separator 91 91 | # Expects: -RUF030.py:93:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:93:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 91 | # Expects: 92 | # - `msg` entirely removed from assertion 93 | assert True, print(sep=" ") | ^^^^^^^^^^^^^^ RUF030 -94 | +94 | 95 | # Custom print function that actually returns a string | = help: Remove `print` @@ -379,7 +379,7 @@ RUF030.py:93:14: RUF030 [*] `print()` expression in `assert` statement is likely 95 95 | # Custom print function that actually returns a string 96 96 | # Expects: -RUF030.py:108:14: RUF030 [*] `print()` expression in `assert` statement is likely unintentional +RUF030.py:108:14: RUF030 [*] `print()` call in `assert` statement is likely unintentional | 106 | # Expects: 107 | # - single StringLiteral diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF031_RUF031.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF031_RUF031.py.snap index b3ca339ba13a6..3c1b4128b75e6 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF031_RUF031.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF031_RUF031.py.snap @@ -1,7 +1,7 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} 2 | d[(1,2)] @@ -9,7 +9,7 @@ RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 3 | d[( 4 | 1, | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 1 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} @@ -19,7 +19,7 @@ RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 4 4 | 1, 5 5 | 2 -RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} 2 | d[(1,2)] @@ -32,7 +32,7 @@ RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 7 | d[ 8 | 1, | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 1 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} @@ -47,7 +47,7 @@ RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 8 8 | 1, 9 9 | 2 -RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 9 | 2 10 | ] @@ -56,7 +56,7 @@ RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 12 | d[(5,6,7)] 13 | d[(8,)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 8 8 | 1, @@ -68,7 +68,7 @@ RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 13 13 | d[(8,)] 14 14 | d[tuple(1,2)] -RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 10 | ] 11 | d[(2,4)] @@ -77,7 +77,7 @@ RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 13 | d[(8,)] 14 | d[tuple(1,2)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 9 9 | 2 @@ -89,7 +89,7 @@ RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 14 14 | d[tuple(1,2)] 15 15 | d[tuple(8)] -RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 11 | d[(2,4)] 12 | d[(5,6,7)] @@ -98,7 +98,7 @@ RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 14 | d[tuple(1,2)] 15 | d[tuple(8)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 10 10 | ] @@ -110,7 +110,7 @@ RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 15 15 | d[tuple(8)] 16 16 | d[1,2] -RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 18 | d[5,6,7] 19 | e = {((1,2),(3,4)):"a"} @@ -118,7 +118,7 @@ RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. | ^^^^^^^^^^^^^ RUF031 21 | e[(1,2),(3,4)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 17 17 | d[3,4] @@ -131,14 +131,14 @@ RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 23 23 | token_features[ 24 24 | (window_position, feature_name) -RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts | 23 | token_features[ 24 | (window_position, feature_name) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF031 25 | ] = self._extract_raw_features_from_token | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 21 21 | e[(1,2),(3,4)] @@ -150,7 +150,7 @@ RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts. 26 26 | 27 27 | d[1,] -RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 27 | d[1,] 28 | d[(1,)] @@ -158,7 +158,7 @@ RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 29 | d[()] # empty tuples should be ignored 30 | d[:,] # slices in the subscript lead to syntax error if parens are added | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 25 25 | ] = self._extract_raw_features_from_token @@ -170,16 +170,16 @@ RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 30 30 | d[:,] # slices in the subscript lead to syntax error if parens are added 31 31 | d[1,2,:] -RUF031.py:36:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:36:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 34 | # Python <=3.10 to avoid syntax error. 35 | # https://github.com/astral-sh/ruff/issues/12776 36 | d[(*foo,bar)] | ^^^^^^^^^^ RUF031 -37 | +37 | 38 | x: dict[str, int] # tuples inside type annotations should never be altered | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 33 33 | # Should keep these parentheses in diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF032_RUF032.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF032_RUF032.py.snap index f170aea8042d3..98e940a88a912 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF032_RUF032.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF032_RUF032.py.snap @@ -4,13 +4,13 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF032.py:6:17: RUF032 [*] `Decimal()` called with float literal argument | 4 | decimal.Decimal(0) -5 | +5 | 6 | decimal.Decimal(0.0) # Should error | ^^^ RUF032 -7 | +7 | 8 | decimal.Decimal("0.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 3 3 | # Tests with fully qualified import @@ -25,13 +25,13 @@ RUF032.py:6:17: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:12:17: RUF032 [*] `Decimal()` called with float literal argument | 10 | decimal.Decimal(10) -11 | +11 | 12 | decimal.Decimal(10.0) # Should error | ^^^^ RUF032 -13 | +13 | 14 | decimal.Decimal("10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 9 9 | @@ -46,13 +46,13 @@ RUF032.py:12:17: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:18:17: RUF032 [*] `Decimal()` called with float literal argument | 16 | decimal.Decimal(-10) -17 | +17 | 18 | decimal.Decimal(-10.0) # Should error | ^^^^^ RUF032 -19 | +19 | 20 | decimal.Decimal("-10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 15 15 | @@ -67,13 +67,13 @@ RUF032.py:18:17: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:33:15: RUF032 [*] `Decimal()` called with float literal argument | 31 | val = Decimal(0) -32 | +32 | 33 | val = Decimal(0.0) # Should error | ^^^ RUF032 -34 | +34 | 35 | val = Decimal("0.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 30 30 | @@ -88,13 +88,13 @@ RUF032.py:33:15: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:39:15: RUF032 [*] `Decimal()` called with float literal argument | 37 | val = Decimal(10) -38 | +38 | 39 | val = Decimal(10.0) # Should error | ^^^^ RUF032 -40 | +40 | 41 | val = Decimal("10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 36 36 | @@ -109,13 +109,13 @@ RUF032.py:39:15: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:45:15: RUF032 [*] `Decimal()` called with float literal argument | 43 | val = Decimal(-10) -44 | +44 | 45 | val = Decimal(-10.0) # Should error | ^^^^^ RUF032 -46 | +46 | 47 | val = Decimal("-10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 42 42 | @@ -130,13 +130,13 @@ RUF032.py:45:15: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:56:15: RUF032 [*] `Decimal()` called with float literal argument | 54 | val = Decimal(~4.0) # Skip -55 | +55 | 56 | val = Decimal(++4.0) # Suggest `Decimal("4.0")` | ^^^^^ RUF032 -57 | +57 | 58 | val = Decimal(-+--++--4.0) # Suggest `Decimal("-4.0")` | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 53 53 | # See https://github.com/astral-sh/ruff/issues/13258 @@ -151,11 +151,11 @@ RUF032.py:56:15: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:58:15: RUF032 [*] `Decimal()` called with float literal argument | 56 | val = Decimal(++4.0) # Suggest `Decimal("4.0")` -57 | +57 | 58 | val = Decimal(-+--++--4.0) # Suggest `Decimal("-4.0")` | ^^^^^^^^^^^ RUF032 | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 55 55 | @@ -170,13 +170,13 @@ RUF032.py:58:15: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:88:23: RUF032 [*] `Decimal()` called with float literal argument | 86 | # Retest with fully qualified import -87 | +87 | 88 | val = decimal.Decimal(0.0) # Should error | ^^^ RUF032 -89 | +89 | 90 | val = decimal.Decimal("0.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 85 85 | @@ -191,13 +191,13 @@ RUF032.py:88:23: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:92:23: RUF032 [*] `Decimal()` called with float literal argument | 90 | val = decimal.Decimal("0.0") -91 | +91 | 92 | val = decimal.Decimal(10.0) # Should error | ^^^^ RUF032 -93 | +93 | 94 | val = decimal.Decimal("10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 89 89 | @@ -212,13 +212,13 @@ RUF032.py:92:23: RUF032 [*] `Decimal()` called with float literal argument RUF032.py:96:23: RUF032 [*] `Decimal()` called with float literal argument | 94 | val = decimal.Decimal("10.0") -95 | +95 | 96 | val = decimal.Decimal(-10.0) # Should error | ^^^^^ RUF032 -97 | +97 | 98 | val = decimal.Decimal("-10.0") | - = help: Use a string literal instead + = help: Replace with string literal ℹ Unsafe fix 93 93 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF033_RUF033.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF033_RUF033.py.snap index a5b42e3f4a71e..073ab755a901c 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF033_RUF033.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF033_RUF033.py.snap @@ -4,7 +4,7 @@ source: crates/ruff_linter/src/rules/ruff/mod.rs RUF033.py:19:35: RUF033 `__post_init__` method with argument defaults | 17 | baz: InitVar[int] = 1 -18 | +18 | 19 | def __post_init__(self, bar = 11, baz = 11) -> None: ... | ^^ RUF033 | @@ -13,7 +13,7 @@ RUF033.py:19:35: RUF033 `__post_init__` method with argument defaults RUF033.py:19:45: RUF033 `__post_init__` method with argument defaults | 17 | baz: InitVar[int] = 1 -18 | +18 | 19 | def __post_init__(self, bar = 11, baz = 11) -> None: ... | ^^ RUF033 | @@ -102,7 +102,7 @@ RUF033.py:46:78: RUF033 [*] `__post_init__` method with argument defaults RUF033.py:59:40: RUF033 [*] `__post_init__` method with argument defaults | 57 | ping = "pong" -58 | +58 | 59 | def __post_init__(self, bar: int = 11, baz: int = 12) -> None: ... | ^^ RUF033 | @@ -122,7 +122,7 @@ RUF033.py:59:40: RUF033 [*] `__post_init__` method with argument defaults RUF033.py:59:55: RUF033 [*] `__post_init__` method with argument defaults | 57 | ping = "pong" -58 | +58 | 59 | def __post_init__(self, bar: int = 11, baz: int = 12) -> None: ... | ^^ RUF033 | @@ -142,7 +142,7 @@ RUF033.py:59:55: RUF033 [*] `__post_init__` method with argument defaults RUF033.py:67:40: RUF033 `__post_init__` method with argument defaults | 65 | bar = "should've used attrs" -66 | +66 | 67 | def __post_init__(self, bar: str = "ahhh", baz: str = "hmm") -> None: ... | ^^^^^^ RUF033 | @@ -151,7 +151,7 @@ RUF033.py:67:40: RUF033 `__post_init__` method with argument defaults RUF033.py:67:59: RUF033 `__post_init__` method with argument defaults | 65 | bar = "should've used attrs" -66 | +66 | 67 | def __post_init__(self, bar: str = "ahhh", baz: str = "hmm") -> None: ... | ^^^^^ RUF033 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF034_RUF034.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF034_RUF034.py.snap index 9feaa0bea123f..769e8dbce148f 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF034_RUF034.py.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF034_RUF034.py.snap @@ -1,25 +1,25 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -RUF034.py:5:5: RUF034 Useless if-else condition +RUF034.py:5:5: RUF034 Useless `if`-`else` condition | 4 | # Invalid 5 | x = 1 if True else 1 | ^^^^^^^^^^^^^^^^ RUF034 -6 | +6 | 7 | # Invalid | -RUF034.py:8:5: RUF034 Useless if-else condition +RUF034.py:8:5: RUF034 Useless `if`-`else` condition | 7 | # Invalid 8 | x = "a" if True else "a" | ^^^^^^^^^^^^^^^^^^^^ RUF034 - 9 | + 9 | 10 | # Invalid | -RUF034.py:11:5: RUF034 Useless if-else condition +RUF034.py:11:5: RUF034 Useless `if`-`else` condition | 10 | # Invalid 11 | x = 0.1 if False else 0.1 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.py.snap new file mode 100644 index 0000000000000..62619ff4b2e49 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.py.snap @@ -0,0 +1,59 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF036.py:4:16: RUF036 `None` not at the end of the type annotation. + | +4 | def func1(arg: None | int): + | ^^^^ RUF036 +5 | ... + | + +RUF036.py:8:16: RUF036 `None` not at the end of the type annotation. + | +8 | def func2() -> None | int: + | ^^^^ RUF036 +9 | ... + | + +RUF036.py:12:16: RUF036 `None` not at the end of the type annotation. + | +12 | def func3(arg: None | None | int): + | ^^^^ RUF036 +13 | ... + | + +RUF036.py:12:23: RUF036 `None` not at the end of the type annotation. + | +12 | def func3(arg: None | None | int): + | ^^^^ RUF036 +13 | ... + | + +RUF036.py:16:18: RUF036 `None` not at the end of the type annotation. + | +16 | def func4(arg: U[None, int]): + | ^^^^ RUF036 +17 | ... + | + +RUF036.py:20:18: RUF036 `None` not at the end of the type annotation. + | +20 | def func5() -> U[None, int]: + | ^^^^ RUF036 +21 | ... + | + +RUF036.py:24:18: RUF036 `None` not at the end of the type annotation. + | +24 | def func6(arg: U[None, None, int]): + | ^^^^ RUF036 +25 | ... + | + +RUF036.py:24:24: RUF036 `None` not at the end of the type annotation. + | +24 | def func6(arg: U[None, None, int]): + | ^^^^ RUF036 +25 | ... + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.pyi.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.pyi.snap new file mode 100644 index 0000000000000..64bb14120af35 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF036_RUF036.pyi.snap @@ -0,0 +1,80 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF036.pyi:4:16: RUF036 `None` not at the end of the type annotation. + | +4 | def func1(arg: None | int): ... + | ^^^^ RUF036 +5 | +6 | def func2() -> None | int: ... + | + +RUF036.pyi:6:16: RUF036 `None` not at the end of the type annotation. + | +4 | def func1(arg: None | int): ... +5 | +6 | def func2() -> None | int: ... + | ^^^^ RUF036 +7 | +8 | def func3(arg: None | None | int): ... + | + +RUF036.pyi:8:16: RUF036 `None` not at the end of the type annotation. + | + 6 | def func2() -> None | int: ... + 7 | + 8 | def func3(arg: None | None | int): ... + | ^^^^ RUF036 + 9 | +10 | def func4(arg: U[None, int]): ... + | + +RUF036.pyi:8:23: RUF036 `None` not at the end of the type annotation. + | + 6 | def func2() -> None | int: ... + 7 | + 8 | def func3(arg: None | None | int): ... + | ^^^^ RUF036 + 9 | +10 | def func4(arg: U[None, int]): ... + | + +RUF036.pyi:10:18: RUF036 `None` not at the end of the type annotation. + | + 8 | def func3(arg: None | None | int): ... + 9 | +10 | def func4(arg: U[None, int]): ... + | ^^^^ RUF036 +11 | +12 | def func5() -> U[None, int]: ... + | + +RUF036.pyi:12:18: RUF036 `None` not at the end of the type annotation. + | +10 | def func4(arg: U[None, int]): ... +11 | +12 | def func5() -> U[None, int]: ... + | ^^^^ RUF036 +13 | +14 | def func6(arg: U[None, None, int]): ... + | + +RUF036.pyi:14:18: RUF036 `None` not at the end of the type annotation. + | +12 | def func5() -> U[None, int]: ... +13 | +14 | def func6(arg: U[None, None, int]): ... + | ^^^^ RUF036 +15 | +16 | # Ok + | + +RUF036.pyi:14:24: RUF036 `None` not at the end of the type annotation. + | +12 | def func5() -> U[None, int]: ... +13 | +14 | def func6(arg: U[None, None, int]): ... + | ^^^^ RUF036 +15 | +16 | # Ok + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF037_RUF037.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF037_RUF037.py.snap new file mode 100644 index 0000000000000..288b5bded4d30 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF037_RUF037.py.snap @@ -0,0 +1,129 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF037.py:6:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +5 | def f(): +6 | queue = collections.deque([]) # RUF037 + | ^^^^^^^^^^^^^^^^^^^^^ RUF037 + | + = help: Replace with `deque()` + +ℹ Safe fix +3 3 | +4 4 | +5 5 | def f(): +6 |- queue = collections.deque([]) # RUF037 + 6 |+ queue = collections.deque() # RUF037 +7 7 | +8 8 | +9 9 | def f(): + +RUF037.py:10:13: RUF037 [*] Unnecessary empty iterable within a deque call + | + 9 | def f(): +10 | queue = collections.deque([], maxlen=10) # RUF037 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF037 + | + = help: Replace with `deque(maxlen=...)` + +ℹ Safe fix +7 7 | +8 8 | +9 9 | def f(): +10 |- queue = collections.deque([], maxlen=10) # RUF037 + 10 |+ queue = collections.deque(maxlen=10) # RUF037 +11 11 | +12 12 | +13 13 | def f(): + +RUF037.py:14:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +13 | def f(): +14 | queue = deque([]) # RUF037 + | ^^^^^^^^^ RUF037 + | + = help: Replace with `deque()` + +ℹ Safe fix +11 11 | +12 12 | +13 13 | def f(): +14 |- queue = deque([]) # RUF037 + 14 |+ queue = deque() # RUF037 +15 15 | +16 16 | +17 17 | def f(): + +RUF037.py:18:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +17 | def f(): +18 | queue = deque(()) # RUF037 + | ^^^^^^^^^ RUF037 + | + = help: Replace with `deque()` + +ℹ Safe fix +15 15 | +16 16 | +17 17 | def f(): +18 |- queue = deque(()) # RUF037 + 18 |+ queue = deque() # RUF037 +19 19 | +20 20 | +21 21 | def f(): + +RUF037.py:22:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +21 | def f(): +22 | queue = deque({}) # RUF037 + | ^^^^^^^^^ RUF037 + | + = help: Replace with `deque()` + +ℹ Safe fix +19 19 | +20 20 | +21 21 | def f(): +22 |- queue = deque({}) # RUF037 + 22 |+ queue = deque() # RUF037 +23 23 | +24 24 | +25 25 | def f(): + +RUF037.py:26:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +25 | def f(): +26 | queue = deque(set()) # RUF037 + | ^^^^^^^^^^^^ RUF037 + | + = help: Replace with `deque()` + +ℹ Safe fix +23 23 | +24 24 | +25 25 | def f(): +26 |- queue = deque(set()) # RUF037 + 26 |+ queue = deque() # RUF037 +27 27 | +28 28 | +29 29 | def f(): + +RUF037.py:30:13: RUF037 [*] Unnecessary empty iterable within a deque call + | +29 | def f(): +30 | queue = collections.deque([], maxlen=10) # RUF037 + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF037 + | + = help: Replace with `deque(maxlen=...)` + +ℹ Safe fix +27 27 | +28 28 | +29 29 | def f(): +30 |- queue = collections.deque([], maxlen=10) # RUF037 + 30 |+ queue = collections.deque(maxlen=10) # RUF037 +31 31 | +32 32 | +33 33 | def f(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.py.snap new file mode 100644 index 0000000000000..a5a0ffa3859d6 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.py.snap @@ -0,0 +1,100 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF038.py:4:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +4 | def func1(arg1: Literal[True, False]): + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +5 | ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +1 1 | from typing import Literal +2 2 | +3 3 | +4 |-def func1(arg1: Literal[True, False]): + 4 |+def func1(arg1: bool): +5 5 | ... +6 6 | +7 7 | + +RUF038.py:8:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +8 | def func2(arg1: Literal[True, False, True]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF038 +9 | ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +5 5 | ... +6 6 | +7 7 | +8 |-def func2(arg1: Literal[True, False, True]): + 8 |+def func2(arg1: bool): +9 9 | ... +10 10 | +11 11 | + +RUF038.py:12:16: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +12 | def func3() -> Literal[True, False]: + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +13 | ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +9 9 | ... +10 10 | +11 11 | +12 |-def func3() -> Literal[True, False]: + 12 |+def func3() -> bool: +13 13 | ... +14 14 | +15 15 | + +RUF038.py:16:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +16 | def func4(arg1: Literal[True, False] | bool): + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +17 | ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +13 13 | ... +14 14 | +15 15 | +16 |-def func4(arg1: Literal[True, False] | bool): + 16 |+def func4(arg1: bool | bool): +17 17 | ... +18 18 | +19 19 | + +RUF038.py:20:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +20 | def func5(arg1: Literal[False, True]): + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +21 | ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +17 17 | ... +18 18 | +19 19 | +20 |-def func5(arg1: Literal[False, True]): + 20 |+def func5(arg1: bool): +21 21 | ... +22 22 | +23 23 | + +RUF038.py:24:17: RUF038 `Literal[True, False, ...]` can be replaced with `Literal[...] | bool` + | +24 | def func6(arg1: Literal[True, False, "hello", "world"]): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF038 +25 | ... + | + = help: Replace with `Literal[...] | bool` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.pyi.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.pyi.snap new file mode 100644 index 0000000000000..ec4ffb9e79834 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF038_RUF038.pyi.snap @@ -0,0 +1,116 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF038.pyi:4:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +4 | def func1(arg1: Literal[True, False]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +5 | +6 | def func2(arg1: Literal[True, False, True]): ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +1 1 | from typing import Literal +2 2 | +3 3 | +4 |-def func1(arg1: Literal[True, False]): ... + 4 |+def func1(arg1: bool): ... +5 5 | +6 6 | def func2(arg1: Literal[True, False, True]): ... +7 7 | + +RUF038.pyi:6:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +4 | def func1(arg1: Literal[True, False]): ... +5 | +6 | def func2(arg1: Literal[True, False, True]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF038 +7 | +8 | def func3() -> Literal[True, False]: ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +3 3 | +4 4 | def func1(arg1: Literal[True, False]): ... +5 5 | +6 |-def func2(arg1: Literal[True, False, True]): ... + 6 |+def func2(arg1: bool): ... +7 7 | +8 8 | def func3() -> Literal[True, False]: ... +9 9 | + +RUF038.pyi:8:16: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | + 6 | def func2(arg1: Literal[True, False, True]): ... + 7 | + 8 | def func3() -> Literal[True, False]: ... + | ^^^^^^^^^^^^^^^^^^^^ RUF038 + 9 | +10 | def func4(arg1: Literal[True, False] | bool): ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +5 5 | +6 6 | def func2(arg1: Literal[True, False, True]): ... +7 7 | +8 |-def func3() -> Literal[True, False]: ... + 8 |+def func3() -> bool: ... +9 9 | +10 10 | def func4(arg1: Literal[True, False] | bool): ... +11 11 | + +RUF038.pyi:10:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | + 8 | def func3() -> Literal[True, False]: ... + 9 | +10 | def func4(arg1: Literal[True, False] | bool): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +11 | +12 | def func5(arg1: Literal[False, True]): ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +7 7 | +8 8 | def func3() -> Literal[True, False]: ... +9 9 | +10 |-def func4(arg1: Literal[True, False] | bool): ... + 10 |+def func4(arg1: bool | bool): ... +11 11 | +12 12 | def func5(arg1: Literal[False, True]): ... +13 13 | + +RUF038.pyi:12:17: RUF038 [*] `Literal[True, False]` can be replaced with `bool` + | +10 | def func4(arg1: Literal[True, False] | bool): ... +11 | +12 | def func5(arg1: Literal[False, True]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF038 +13 | +14 | def func6(arg1: Literal[True, False, "hello", "world"]): ... + | + = help: Replace with `bool` + +ℹ Unsafe fix +9 9 | +10 10 | def func4(arg1: Literal[True, False] | bool): ... +11 11 | +12 |-def func5(arg1: Literal[False, True]): ... + 12 |+def func5(arg1: bool): ... +13 13 | +14 14 | def func6(arg1: Literal[True, False, "hello", "world"]): ... +15 15 | + +RUF038.pyi:14:17: RUF038 `Literal[True, False, ...]` can be replaced with `Literal[...] | bool` + | +12 | def func5(arg1: Literal[False, True]): ... +13 | +14 | def func6(arg1: Literal[True, False, "hello", "world"]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF038 +15 | +16 | # ok + | + = help: Replace with `Literal[...] | bool` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF040_RUF040.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF040_RUF040.py.snap new file mode 100644 index 0000000000000..4102fe32b8ffd --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF040_RUF040.py.snap @@ -0,0 +1,12 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF040.py:3:21: RUF040 Non-string literal used as assert message + | +1 | fruits = ["apples", "plums", "pear"] +2 | fruits.filter(lambda fruit: fruit.startwith("p")) +3 | assert len(fruits), 2 + | ^ RUF040 +4 | +5 | assert True, "always true" + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.py.snap new file mode 100644 index 0000000000000..d09f2bde4e621 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.py.snap @@ -0,0 +1,237 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF041.py:6:4: RUF041 [*] Unnecessary nested `Literal` + | +6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +7 | Literal[1, Literal[1]] +8 | Literal[1, 2, Literal[1, 2]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +3 3 | import typing_extensions +4 4 | +5 5 | +6 |-y: Literal[1, print("hello"), 3, Literal[4, 1]] + 6 |+y: Literal[1, print("hello"), 3, 4, 1] +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] + +RUF041.py:7:1: RUF041 [*] Unnecessary nested `Literal` + | +6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 | Literal[1, Literal[1]] + | ^^^^^^^^^^^^^^^^^^^^^^ RUF041 +8 | Literal[1, 2, Literal[1, 2]] +9 | Literal[1, Literal[1], Literal[1]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +4 4 | +5 5 | +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 |-Literal[1, Literal[1]] + 7 |+Literal[1, 1] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] + +RUF041.py:8:1: RUF041 [*] Unnecessary nested `Literal` + | + 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] + 7 | Literal[1, Literal[1]] + 8 | Literal[1, 2, Literal[1, 2]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +5 5 | +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 7 | Literal[1, Literal[1]] +8 |-Literal[1, 2, Literal[1, 2]] + 8 |+Literal[1, 2, 1, 2] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + +RUF041.py:9:1: RUF041 [*] Unnecessary nested `Literal` + | + 7 | Literal[1, Literal[1]] + 8 | Literal[1, 2, Literal[1, 2]] + 9 | Literal[1, Literal[1], Literal[1]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 |-Literal[1, Literal[1], Literal[1]] + 9 |+Literal[1, 1, 1] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 12 | Literal[ + +RUF041.py:10:1: RUF041 [*] Unnecessary nested `Literal` + | + 8 | Literal[1, 2, Literal[1, 2]] + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 | Literal[ + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 |-Literal[1, Literal[2], Literal[2]] + 10 |+Literal[1, 2, 2] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 12 | Literal[ +13 13 | 1, # comment 1 + +RUF041.py:11:1: RUF041 [*] Unnecessary nested `Literal` + | + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +12 | Literal[ +13 | 1, # comment 1 + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 |-t.Literal[1, t.Literal[2, t.Literal[1]]] + 11 |+t.Literal[1, 2, 1] +12 12 | Literal[ +13 13 | 1, # comment 1 +14 14 | Literal[ # another comment + +RUF041.py:12:1: RUF041 [*] Unnecessary nested `Literal` + | +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 | / Literal[ +13 | | 1, # comment 1 +14 | | Literal[ # another comment +15 | | 1 # yet another comment +16 | | ] +17 | | ] # once + | |_^ RUF041 +18 | +19 | # Ensure issue is only raised once, even on nested literals + | + = help: Replace with flattened `Literal` + +ℹ Unsafe fix +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 |-Literal[ +13 |- 1, # comment 1 +14 |- Literal[ # another comment +15 |- 1 # yet another comment +16 |- ] +17 |-] # once + 12 |+Literal[1, 1] # once +18 13 | +19 14 | # Ensure issue is only raised once, even on nested literals +20 15 | MyType = Literal["foo", Literal[True, False, True], "bar"] + +RUF041.py:20:10: RUF041 [*] Unnecessary nested `Literal` + | +19 | # Ensure issue is only raised once, even on nested literals +20 | MyType = Literal["foo", Literal[True, False, True], "bar"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +21 | +22 | # nested literals, all equivalent to `Literal[1]` + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +17 17 | ] # once +18 18 | +19 19 | # Ensure issue is only raised once, even on nested literals +20 |-MyType = Literal["foo", Literal[True, False, True], "bar"] + 20 |+MyType = Literal["foo", True, False, True, "bar"] +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] + +RUF041.py:23:1: RUF041 [*] Unnecessary nested `Literal` + | +22 | # nested literals, all equivalent to `Literal[1]` +23 | Literal[Literal[1]] + | ^^^^^^^^^^^^^^^^^^^ RUF041 +24 | Literal[Literal[Literal[1], Literal[1]]] +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +20 20 | MyType = Literal["foo", Literal[True, False, True], "bar"] +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 |-Literal[Literal[1]] + 23 |+Literal[1] +24 24 | Literal[Literal[Literal[1], Literal[1]]] +25 25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] +26 26 | + +RUF041.py:24:1: RUF041 [*] Unnecessary nested `Literal` + | +22 | # nested literals, all equivalent to `Literal[1]` +23 | Literal[Literal[1]] +24 | Literal[Literal[Literal[1], Literal[1]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] +24 |-Literal[Literal[Literal[1], Literal[1]]] + 24 |+Literal[1, 1] +25 25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] +26 26 | +27 27 | # OK + +RUF041.py:25:1: RUF041 [*] Unnecessary nested `Literal` + | +23 | Literal[Literal[1]] +24 | Literal[Literal[Literal[1], Literal[1]]] +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +26 | +27 | # OK + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] +24 24 | Literal[Literal[Literal[1], Literal[1]]] +25 |-Literal[Literal[1], Literal[Literal[Literal[1]]]] + 25 |+Literal[1, 1] +26 26 | +27 27 | # OK +28 28 | x: Literal[True, False, True, False] diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.pyi.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.pyi.snap new file mode 100644 index 0000000000000..6b146bdc64cdb --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF041_RUF041.pyi.snap @@ -0,0 +1,237 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF041.pyi:6:4: RUF041 [*] Unnecessary nested `Literal` + | +6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +7 | Literal[1, Literal[1]] +8 | Literal[1, 2, Literal[1, 2]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +3 3 | import typing_extensions +4 4 | +5 5 | +6 |-y: Literal[1, print("hello"), 3, Literal[4, 1]] + 6 |+y: Literal[1, print("hello"), 3, 4, 1] +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] + +RUF041.pyi:7:1: RUF041 [*] Unnecessary nested `Literal` + | +6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 | Literal[1, Literal[1]] + | ^^^^^^^^^^^^^^^^^^^^^^ RUF041 +8 | Literal[1, 2, Literal[1, 2]] +9 | Literal[1, Literal[1], Literal[1]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +4 4 | +5 5 | +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 |-Literal[1, Literal[1]] + 7 |+Literal[1, 1] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] + +RUF041.pyi:8:1: RUF041 [*] Unnecessary nested `Literal` + | + 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] + 7 | Literal[1, Literal[1]] + 8 | Literal[1, 2, Literal[1, 2]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +5 5 | +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 7 | Literal[1, Literal[1]] +8 |-Literal[1, 2, Literal[1, 2]] + 8 |+Literal[1, 2, 1, 2] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + +RUF041.pyi:9:1: RUF041 [*] Unnecessary nested `Literal` + | + 7 | Literal[1, Literal[1]] + 8 | Literal[1, 2, Literal[1, 2]] + 9 | Literal[1, Literal[1], Literal[1]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +6 6 | y: Literal[1, print("hello"), 3, Literal[4, 1]] +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 |-Literal[1, Literal[1], Literal[1]] + 9 |+Literal[1, 1, 1] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 12 | Literal[ + +RUF041.pyi:10:1: RUF041 [*] Unnecessary nested `Literal` + | + 8 | Literal[1, 2, Literal[1, 2]] + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 | Literal[ + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +7 7 | Literal[1, Literal[1]] +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 |-Literal[1, Literal[2], Literal[2]] + 10 |+Literal[1, 2, 2] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 12 | Literal[ +13 13 | 1, # comment 1 + +RUF041.pyi:11:1: RUF041 [*] Unnecessary nested `Literal` + | + 9 | Literal[1, Literal[1], Literal[1]] +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +12 | Literal[ +13 | 1, # comment 1 + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +8 8 | Literal[1, 2, Literal[1, 2]] +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 |-t.Literal[1, t.Literal[2, t.Literal[1]]] + 11 |+t.Literal[1, 2, 1] +12 12 | Literal[ +13 13 | 1, # comment 1 +14 14 | Literal[ # another comment + +RUF041.pyi:12:1: RUF041 [*] Unnecessary nested `Literal` + | +10 | Literal[1, Literal[2], Literal[2]] +11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 | / Literal[ +13 | | 1, # comment 1 +14 | | Literal[ # another comment +15 | | 1 # yet another comment +16 | | ] +17 | | ] # once + | |_^ RUF041 +18 | +19 | # Ensure issue is only raised once, even on nested literals + | + = help: Replace with flattened `Literal` + +ℹ Unsafe fix +9 9 | Literal[1, Literal[1], Literal[1]] +10 10 | Literal[1, Literal[2], Literal[2]] +11 11 | t.Literal[1, t.Literal[2, t.Literal[1]]] +12 |-Literal[ +13 |- 1, # comment 1 +14 |- Literal[ # another comment +15 |- 1 # yet another comment +16 |- ] +17 |-] # once + 12 |+Literal[1, 1] # once +18 13 | +19 14 | # Ensure issue is only raised once, even on nested literals +20 15 | MyType = Literal["foo", Literal[True, False, True], "bar"] + +RUF041.pyi:20:10: RUF041 [*] Unnecessary nested `Literal` + | +19 | # Ensure issue is only raised once, even on nested literals +20 | MyType = Literal["foo", Literal[True, False, True], "bar"] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +21 | +22 | # nested literals, all equivalent to `Literal[1]` + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +17 17 | ] # once +18 18 | +19 19 | # Ensure issue is only raised once, even on nested literals +20 |-MyType = Literal["foo", Literal[True, False, True], "bar"] + 20 |+MyType = Literal["foo", True, False, True, "bar"] +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] + +RUF041.pyi:23:1: RUF041 [*] Unnecessary nested `Literal` + | +22 | # nested literals, all equivalent to `Literal[1]` +23 | Literal[Literal[1]] + | ^^^^^^^^^^^^^^^^^^^ RUF041 +24 | Literal[Literal[Literal[1], Literal[1]]] +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +20 20 | MyType = Literal["foo", Literal[True, False, True], "bar"] +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 |-Literal[Literal[1]] + 23 |+Literal[1] +24 24 | Literal[Literal[Literal[1], Literal[1]]] +25 25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] +26 26 | + +RUF041.pyi:24:1: RUF041 [*] Unnecessary nested `Literal` + | +22 | # nested literals, all equivalent to `Literal[1]` +23 | Literal[Literal[1]] +24 | Literal[Literal[Literal[1], Literal[1]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +21 21 | +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] +24 |-Literal[Literal[Literal[1], Literal[1]]] + 24 |+Literal[1, 1] +25 25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] +26 26 | +27 27 | # OK + +RUF041.pyi:25:1: RUF041 [*] Unnecessary nested `Literal` + | +23 | Literal[Literal[1]] +24 | Literal[Literal[Literal[1], Literal[1]]] +25 | Literal[Literal[1], Literal[Literal[Literal[1]]]] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF041 +26 | +27 | # OK + | + = help: Replace with flattened `Literal` + +ℹ Safe fix +22 22 | # nested literals, all equivalent to `Literal[1]` +23 23 | Literal[Literal[1]] +24 24 | Literal[Literal[Literal[1], Literal[1]]] +25 |-Literal[Literal[1], Literal[Literal[Literal[1]]]] + 25 |+Literal[1, 1] +26 26 | +27 27 | # OK +28 28 | x: Literal[True, False, True, False] diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046.py.snap new file mode 100644 index 0000000000000..f4d9f4d4659ca --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046.py.snap @@ -0,0 +1,1258 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF046.py:10:1: RUF046 [*] Value being cast to `int` is already an integer + | + 8 | ### Safely fixable + 9 | +10 | int(id()) + | ^^^^^^^^^ RUF046 +11 | int(len([])) +12 | int(ord(foo)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +7 7 | +8 8 | ### Safely fixable +9 9 | +10 |-int(id()) + 10 |+id() +11 11 | int(len([])) +12 12 | int(ord(foo)) +13 13 | int(hash(foo, bar)) + +RUF046.py:11:1: RUF046 [*] Value being cast to `int` is already an integer + | +10 | int(id()) +11 | int(len([])) + | ^^^^^^^^^^^^ RUF046 +12 | int(ord(foo)) +13 | int(hash(foo, bar)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +8 8 | ### Safely fixable +9 9 | +10 10 | int(id()) +11 |-int(len([])) + 11 |+len([]) +12 12 | int(ord(foo)) +13 13 | int(hash(foo, bar)) +14 14 | int(int('')) + +RUF046.py:12:1: RUF046 [*] Value being cast to `int` is already an integer + | +10 | int(id()) +11 | int(len([])) +12 | int(ord(foo)) + | ^^^^^^^^^^^^^ RUF046 +13 | int(hash(foo, bar)) +14 | int(int('')) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +9 9 | +10 10 | int(id()) +11 11 | int(len([])) +12 |-int(ord(foo)) + 12 |+ord(foo) +13 13 | int(hash(foo, bar)) +14 14 | int(int('')) +15 15 | + +RUF046.py:13:1: RUF046 [*] Value being cast to `int` is already an integer + | +11 | int(len([])) +12 | int(ord(foo)) +13 | int(hash(foo, bar)) + | ^^^^^^^^^^^^^^^^^^^ RUF046 +14 | int(int('')) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +10 10 | int(id()) +11 11 | int(len([])) +12 12 | int(ord(foo)) +13 |-int(hash(foo, bar)) + 13 |+hash(foo, bar) +14 14 | int(int('')) +15 15 | +16 16 | int(math.comb()) + +RUF046.py:14:1: RUF046 [*] Value being cast to `int` is already an integer + | +12 | int(ord(foo)) +13 | int(hash(foo, bar)) +14 | int(int('')) + | ^^^^^^^^^^^^ RUF046 +15 | +16 | int(math.comb()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +11 11 | int(len([])) +12 12 | int(ord(foo)) +13 13 | int(hash(foo, bar)) +14 |-int(int('')) + 14 |+int('') +15 15 | +16 16 | int(math.comb()) +17 17 | int(math.factorial()) + +RUF046.py:16:1: RUF046 [*] Value being cast to `int` is already an integer + | +14 | int(int('')) +15 | +16 | int(math.comb()) + | ^^^^^^^^^^^^^^^^ RUF046 +17 | int(math.factorial()) +18 | int(math.gcd()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +13 13 | int(hash(foo, bar)) +14 14 | int(int('')) +15 15 | +16 |-int(math.comb()) + 16 |+math.comb() +17 17 | int(math.factorial()) +18 18 | int(math.gcd()) +19 19 | int(math.lcm()) + +RUF046.py:17:1: RUF046 [*] Value being cast to `int` is already an integer + | +16 | int(math.comb()) +17 | int(math.factorial()) + | ^^^^^^^^^^^^^^^^^^^^^ RUF046 +18 | int(math.gcd()) +19 | int(math.lcm()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +14 14 | int(int('')) +15 15 | +16 16 | int(math.comb()) +17 |-int(math.factorial()) + 17 |+math.factorial() +18 18 | int(math.gcd()) +19 19 | int(math.lcm()) +20 20 | int(math.isqrt()) + +RUF046.py:18:1: RUF046 [*] Value being cast to `int` is already an integer + | +16 | int(math.comb()) +17 | int(math.factorial()) +18 | int(math.gcd()) + | ^^^^^^^^^^^^^^^ RUF046 +19 | int(math.lcm()) +20 | int(math.isqrt()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +15 15 | +16 16 | int(math.comb()) +17 17 | int(math.factorial()) +18 |-int(math.gcd()) + 18 |+math.gcd() +19 19 | int(math.lcm()) +20 20 | int(math.isqrt()) +21 21 | int(math.perm()) + +RUF046.py:19:1: RUF046 [*] Value being cast to `int` is already an integer + | +17 | int(math.factorial()) +18 | int(math.gcd()) +19 | int(math.lcm()) + | ^^^^^^^^^^^^^^^ RUF046 +20 | int(math.isqrt()) +21 | int(math.perm()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +16 16 | int(math.comb()) +17 17 | int(math.factorial()) +18 18 | int(math.gcd()) +19 |-int(math.lcm()) + 19 |+math.lcm() +20 20 | int(math.isqrt()) +21 21 | int(math.perm()) +22 22 | + +RUF046.py:20:1: RUF046 [*] Value being cast to `int` is already an integer + | +18 | int(math.gcd()) +19 | int(math.lcm()) +20 | int(math.isqrt()) + | ^^^^^^^^^^^^^^^^^ RUF046 +21 | int(math.perm()) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +17 17 | int(math.factorial()) +18 18 | int(math.gcd()) +19 19 | int(math.lcm()) +20 |-int(math.isqrt()) + 20 |+math.isqrt() +21 21 | int(math.perm()) +22 22 | +23 23 | int(round(1, 0)) + +RUF046.py:21:1: RUF046 [*] Value being cast to `int` is already an integer + | +19 | int(math.lcm()) +20 | int(math.isqrt()) +21 | int(math.perm()) + | ^^^^^^^^^^^^^^^^ RUF046 +22 | +23 | int(round(1, 0)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +18 18 | int(math.gcd()) +19 19 | int(math.lcm()) +20 20 | int(math.isqrt()) +21 |-int(math.perm()) + 21 |+math.perm() +22 22 | +23 23 | int(round(1, 0)) +24 24 | int(round(1, 10)) + +RUF046.py:23:1: RUF046 [*] Value being cast to `int` is already an integer + | +21 | int(math.perm()) +22 | +23 | int(round(1, 0)) + | ^^^^^^^^^^^^^^^^ RUF046 +24 | int(round(1, 10)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +20 20 | int(math.isqrt()) +21 21 | int(math.perm()) +22 22 | +23 |-int(round(1, 0)) + 23 |+round(1, 0) +24 24 | int(round(1, 10)) +25 25 | +26 26 | int(round(1)) + +RUF046.py:24:1: RUF046 [*] Value being cast to `int` is already an integer + | +23 | int(round(1, 0)) +24 | int(round(1, 10)) + | ^^^^^^^^^^^^^^^^^ RUF046 +25 | +26 | int(round(1)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +21 21 | int(math.perm()) +22 22 | +23 23 | int(round(1, 0)) +24 |-int(round(1, 10)) + 24 |+round(1, 10) +25 25 | +26 26 | int(round(1)) +27 27 | int(round(1, None)) + +RUF046.py:26:1: RUF046 [*] Value being cast to `int` is already an integer + | +24 | int(round(1, 10)) +25 | +26 | int(round(1)) + | ^^^^^^^^^^^^^ RUF046 +27 | int(round(1, None)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +23 23 | int(round(1, 0)) +24 24 | int(round(1, 10)) +25 25 | +26 |-int(round(1)) + 26 |+round(1) +27 27 | int(round(1, None)) +28 28 | +29 29 | int(round(1.)) + +RUF046.py:27:1: RUF046 [*] Value being cast to `int` is already an integer + | +26 | int(round(1)) +27 | int(round(1, None)) + | ^^^^^^^^^^^^^^^^^^^ RUF046 +28 | +29 | int(round(1.)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +24 24 | int(round(1, 10)) +25 25 | +26 26 | int(round(1)) +27 |-int(round(1, None)) + 27 |+round(1, None) +28 28 | +29 29 | int(round(1.)) +30 30 | int(round(1., None)) + +RUF046.py:29:1: RUF046 [*] Value being cast to `int` is already an integer + | +27 | int(round(1, None)) +28 | +29 | int(round(1.)) + | ^^^^^^^^^^^^^^ RUF046 +30 | int(round(1., None)) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +26 26 | int(round(1)) +27 27 | int(round(1, None)) +28 28 | +29 |-int(round(1.)) + 29 |+round(1.) +30 30 | int(round(1., None)) +31 31 | +32 32 | int(1) + +RUF046.py:30:1: RUF046 [*] Value being cast to `int` is already an integer + | +29 | int(round(1.)) +30 | int(round(1., None)) + | ^^^^^^^^^^^^^^^^^^^^ RUF046 +31 | +32 | int(1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +27 27 | int(round(1, None)) +28 28 | +29 29 | int(round(1.)) +30 |-int(round(1., None)) + 30 |+round(1., None) +31 31 | +32 32 | int(1) +33 33 | int(v := 1) + +RUF046.py:32:1: RUF046 [*] Value being cast to `int` is already an integer + | +30 | int(round(1., None)) +31 | +32 | int(1) + | ^^^^^^ RUF046 +33 | int(v := 1) +34 | int(~1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +29 29 | int(round(1.)) +30 30 | int(round(1., None)) +31 31 | +32 |-int(1) + 32 |+1 +33 33 | int(v := 1) +34 34 | int(~1) +35 35 | int(-1) + +RUF046.py:33:1: RUF046 [*] Value being cast to `int` is already an integer + | +32 | int(1) +33 | int(v := 1) + | ^^^^^^^^^^^ RUF046 +34 | int(~1) +35 | int(-1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +30 30 | int(round(1., None)) +31 31 | +32 32 | int(1) +33 |-int(v := 1) + 33 |+(v := 1) +34 34 | int(~1) +35 35 | int(-1) +36 36 | int(+1) + +RUF046.py:34:1: RUF046 [*] Value being cast to `int` is already an integer + | +32 | int(1) +33 | int(v := 1) +34 | int(~1) + | ^^^^^^^ RUF046 +35 | int(-1) +36 | int(+1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +31 31 | +32 32 | int(1) +33 33 | int(v := 1) +34 |-int(~1) + 34 |+~1 +35 35 | int(-1) +36 36 | int(+1) +37 37 | + +RUF046.py:35:1: RUF046 [*] Value being cast to `int` is already an integer + | +33 | int(v := 1) +34 | int(~1) +35 | int(-1) + | ^^^^^^^ RUF046 +36 | int(+1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +32 32 | int(1) +33 33 | int(v := 1) +34 34 | int(~1) +35 |-int(-1) + 35 |+-1 +36 36 | int(+1) +37 37 | +38 38 | int(1 + 1) + +RUF046.py:36:1: RUF046 [*] Value being cast to `int` is already an integer + | +34 | int(~1) +35 | int(-1) +36 | int(+1) + | ^^^^^^^ RUF046 +37 | +38 | int(1 + 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +33 33 | int(v := 1) +34 34 | int(~1) +35 35 | int(-1) +36 |-int(+1) + 36 |++1 +37 37 | +38 38 | int(1 + 1) +39 39 | int(1 - 1) + +RUF046.py:38:1: RUF046 [*] Value being cast to `int` is already an integer + | +36 | int(+1) +37 | +38 | int(1 + 1) + | ^^^^^^^^^^ RUF046 +39 | int(1 - 1) +40 | int(1 * 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +35 35 | int(-1) +36 36 | int(+1) +37 37 | +38 |-int(1 + 1) + 38 |+1 + 1 +39 39 | int(1 - 1) +40 40 | int(1 * 1) +41 41 | int(1 % 1) + +RUF046.py:39:1: RUF046 [*] Value being cast to `int` is already an integer + | +38 | int(1 + 1) +39 | int(1 - 1) + | ^^^^^^^^^^ RUF046 +40 | int(1 * 1) +41 | int(1 % 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +36 36 | int(+1) +37 37 | +38 38 | int(1 + 1) +39 |-int(1 - 1) + 39 |+1 - 1 +40 40 | int(1 * 1) +41 41 | int(1 % 1) +42 42 | int(1 ** 1) + +RUF046.py:40:1: RUF046 [*] Value being cast to `int` is already an integer + | +38 | int(1 + 1) +39 | int(1 - 1) +40 | int(1 * 1) + | ^^^^^^^^^^ RUF046 +41 | int(1 % 1) +42 | int(1 ** 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +37 37 | +38 38 | int(1 + 1) +39 39 | int(1 - 1) +40 |-int(1 * 1) + 40 |+1 * 1 +41 41 | int(1 % 1) +42 42 | int(1 ** 1) +43 43 | int(1 << 1) + +RUF046.py:41:1: RUF046 [*] Value being cast to `int` is already an integer + | +39 | int(1 - 1) +40 | int(1 * 1) +41 | int(1 % 1) + | ^^^^^^^^^^ RUF046 +42 | int(1 ** 1) +43 | int(1 << 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +38 38 | int(1 + 1) +39 39 | int(1 - 1) +40 40 | int(1 * 1) +41 |-int(1 % 1) + 41 |+1 % 1 +42 42 | int(1 ** 1) +43 43 | int(1 << 1) +44 44 | int(1 >> 1) + +RUF046.py:42:1: RUF046 [*] Value being cast to `int` is already an integer + | +40 | int(1 * 1) +41 | int(1 % 1) +42 | int(1 ** 1) + | ^^^^^^^^^^^ RUF046 +43 | int(1 << 1) +44 | int(1 >> 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +39 39 | int(1 - 1) +40 40 | int(1 * 1) +41 41 | int(1 % 1) +42 |-int(1 ** 1) + 42 |+1 ** 1 +43 43 | int(1 << 1) +44 44 | int(1 >> 1) +45 45 | int(1 | 1) + +RUF046.py:43:1: RUF046 [*] Value being cast to `int` is already an integer + | +41 | int(1 % 1) +42 | int(1 ** 1) +43 | int(1 << 1) + | ^^^^^^^^^^^ RUF046 +44 | int(1 >> 1) +45 | int(1 | 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +40 40 | int(1 * 1) +41 41 | int(1 % 1) +42 42 | int(1 ** 1) +43 |-int(1 << 1) + 43 |+1 << 1 +44 44 | int(1 >> 1) +45 45 | int(1 | 1) +46 46 | int(1 ^ 1) + +RUF046.py:44:1: RUF046 [*] Value being cast to `int` is already an integer + | +42 | int(1 ** 1) +43 | int(1 << 1) +44 | int(1 >> 1) + | ^^^^^^^^^^^ RUF046 +45 | int(1 | 1) +46 | int(1 ^ 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +41 41 | int(1 % 1) +42 42 | int(1 ** 1) +43 43 | int(1 << 1) +44 |-int(1 >> 1) + 44 |+1 >> 1 +45 45 | int(1 | 1) +46 46 | int(1 ^ 1) +47 47 | int(1 & 1) + +RUF046.py:45:1: RUF046 [*] Value being cast to `int` is already an integer + | +43 | int(1 << 1) +44 | int(1 >> 1) +45 | int(1 | 1) + | ^^^^^^^^^^ RUF046 +46 | int(1 ^ 1) +47 | int(1 & 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +42 42 | int(1 ** 1) +43 43 | int(1 << 1) +44 44 | int(1 >> 1) +45 |-int(1 | 1) + 45 |+1 | 1 +46 46 | int(1 ^ 1) +47 47 | int(1 & 1) +48 48 | int(1 // 1) + +RUF046.py:46:1: RUF046 [*] Value being cast to `int` is already an integer + | +44 | int(1 >> 1) +45 | int(1 | 1) +46 | int(1 ^ 1) + | ^^^^^^^^^^ RUF046 +47 | int(1 & 1) +48 | int(1 // 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +43 43 | int(1 << 1) +44 44 | int(1 >> 1) +45 45 | int(1 | 1) +46 |-int(1 ^ 1) + 46 |+1 ^ 1 +47 47 | int(1 & 1) +48 48 | int(1 // 1) +49 49 | + +RUF046.py:47:1: RUF046 [*] Value being cast to `int` is already an integer + | +45 | int(1 | 1) +46 | int(1 ^ 1) +47 | int(1 & 1) + | ^^^^^^^^^^ RUF046 +48 | int(1 // 1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +44 44 | int(1 >> 1) +45 45 | int(1 | 1) +46 46 | int(1 ^ 1) +47 |-int(1 & 1) + 47 |+1 & 1 +48 48 | int(1 // 1) +49 49 | +50 50 | int(1 if ... else 2) + +RUF046.py:48:1: RUF046 [*] Value being cast to `int` is already an integer + | +46 | int(1 ^ 1) +47 | int(1 & 1) +48 | int(1 // 1) + | ^^^^^^^^^^^ RUF046 +49 | +50 | int(1 if ... else 2) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +45 45 | int(1 | 1) +46 46 | int(1 ^ 1) +47 47 | int(1 & 1) +48 |-int(1 // 1) + 48 |+1 // 1 +49 49 | +50 50 | int(1 if ... else 2) +51 51 | + +RUF046.py:50:1: RUF046 [*] Value being cast to `int` is already an integer + | +48 | int(1 // 1) +49 | +50 | int(1 if ... else 2) + | ^^^^^^^^^^^^^^^^^^^^ RUF046 +51 | +52 | int(1 and 0) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +47 47 | int(1 & 1) +48 48 | int(1 // 1) +49 49 | +50 |-int(1 if ... else 2) + 50 |+1 if ... else 2 +51 51 | +52 52 | int(1 and 0) +53 53 | int(0 or -1) + +RUF046.py:52:1: RUF046 [*] Value being cast to `int` is already an integer + | +50 | int(1 if ... else 2) +51 | +52 | int(1 and 0) + | ^^^^^^^^^^^^ RUF046 +53 | int(0 or -1) + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +49 49 | +50 50 | int(1 if ... else 2) +51 51 | +52 |-int(1 and 0) + 52 |+1 and 0 +53 53 | int(0 or -1) +54 54 | +55 55 | + +RUF046.py:53:1: RUF046 [*] Value being cast to `int` is already an integer + | +52 | int(1 and 0) +53 | int(0 or -1) + | ^^^^^^^^^^^^ RUF046 + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +50 50 | int(1 if ... else 2) +51 51 | +52 52 | int(1 and 0) +53 |-int(0 or -1) + 53 |+0 or -1 +54 54 | +55 55 | +56 56 | if int(1 + 2) * 3: + +RUF046.py:56:4: RUF046 [*] Value being cast to `int` is already an integer + | +56 | if int(1 + 2) * 3: + | ^^^^^^^^^^ RUF046 +57 | ... + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +53 53 | int(0 or -1) +54 54 | +55 55 | +56 |-if int(1 + 2) * 3: + 56 |+if (1 + 2) * 3: +57 57 | ... +58 58 | +59 59 | + +RUF046.py:62:1: RUF046 [*] Value being cast to `int` is already an integer + | +60 | ### Unsafe +61 | +62 | int(math.ceil()) + | ^^^^^^^^^^^^^^^^ RUF046 +63 | int(math.floor()) +64 | int(math.trunc()) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +59 59 | +60 60 | ### Unsafe +61 61 | +62 |-int(math.ceil()) + 62 |+math.ceil() +63 63 | int(math.floor()) +64 64 | int(math.trunc()) +65 65 | + +RUF046.py:63:1: RUF046 [*] Value being cast to `int` is already an integer + | +62 | int(math.ceil()) +63 | int(math.floor()) + | ^^^^^^^^^^^^^^^^^ RUF046 +64 | int(math.trunc()) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +60 60 | ### Unsafe +61 61 | +62 62 | int(math.ceil()) +63 |-int(math.floor()) + 63 |+math.floor() +64 64 | int(math.trunc()) +65 65 | +66 66 | int(round(inferred_int, 0)) + +RUF046.py:64:1: RUF046 [*] Value being cast to `int` is already an integer + | +62 | int(math.ceil()) +63 | int(math.floor()) +64 | int(math.trunc()) + | ^^^^^^^^^^^^^^^^^ RUF046 +65 | +66 | int(round(inferred_int, 0)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +61 61 | +62 62 | int(math.ceil()) +63 63 | int(math.floor()) +64 |-int(math.trunc()) + 64 |+math.trunc() +65 65 | +66 66 | int(round(inferred_int, 0)) +67 67 | int(round(inferred_int, 10)) + +RUF046.py:66:1: RUF046 [*] Value being cast to `int` is already an integer + | +64 | int(math.trunc()) +65 | +66 | int(round(inferred_int, 0)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +67 | int(round(inferred_int, 10)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +63 63 | int(math.floor()) +64 64 | int(math.trunc()) +65 65 | +66 |-int(round(inferred_int, 0)) + 66 |+round(inferred_int, 0) +67 67 | int(round(inferred_int, 10)) +68 68 | +69 69 | int(round(inferred_int)) + +RUF046.py:67:1: RUF046 [*] Value being cast to `int` is already an integer + | +66 | int(round(inferred_int, 0)) +67 | int(round(inferred_int, 10)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +68 | +69 | int(round(inferred_int)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +64 64 | int(math.trunc()) +65 65 | +66 66 | int(round(inferred_int, 0)) +67 |-int(round(inferred_int, 10)) + 67 |+round(inferred_int, 10) +68 68 | +69 69 | int(round(inferred_int)) +70 70 | int(round(inferred_int, None)) + +RUF046.py:69:1: RUF046 [*] Value being cast to `int` is already an integer + | +67 | int(round(inferred_int, 10)) +68 | +69 | int(round(inferred_int)) + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +70 | int(round(inferred_int, None)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +66 66 | int(round(inferred_int, 0)) +67 67 | int(round(inferred_int, 10)) +68 68 | +69 |-int(round(inferred_int)) + 69 |+round(inferred_int) +70 70 | int(round(inferred_int, None)) +71 71 | +72 72 | int(round(inferred_float)) + +RUF046.py:70:1: RUF046 [*] Value being cast to `int` is already an integer + | +69 | int(round(inferred_int)) +70 | int(round(inferred_int, None)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +71 | +72 | int(round(inferred_float)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +67 67 | int(round(inferred_int, 10)) +68 68 | +69 69 | int(round(inferred_int)) +70 |-int(round(inferred_int, None)) + 70 |+round(inferred_int, None) +71 71 | +72 72 | int(round(inferred_float)) +73 73 | int(round(inferred_float, None)) + +RUF046.py:72:1: RUF046 [*] Value being cast to `int` is already an integer + | +70 | int(round(inferred_int, None)) +71 | +72 | int(round(inferred_float)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +73 | int(round(inferred_float, None)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +69 69 | int(round(inferred_int)) +70 70 | int(round(inferred_int, None)) +71 71 | +72 |-int(round(inferred_float)) + 72 |+round(inferred_float) +73 73 | int(round(inferred_float, None)) +74 74 | +75 75 | int(round(unknown)) + +RUF046.py:73:1: RUF046 [*] Value being cast to `int` is already an integer + | +72 | int(round(inferred_float)) +73 | int(round(inferred_float, None)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 +74 | +75 | int(round(unknown)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +70 70 | int(round(inferred_int, None)) +71 71 | +72 72 | int(round(inferred_float)) +73 |-int(round(inferred_float, None)) + 73 |+round(inferred_float, None) +74 74 | +75 75 | int(round(unknown)) +76 76 | int(round(unknown, None)) + +RUF046.py:75:1: RUF046 [*] Value being cast to `int` is already an integer + | +73 | int(round(inferred_float, None)) +74 | +75 | int(round(unknown)) + | ^^^^^^^^^^^^^^^^^^^ RUF046 +76 | int(round(unknown, None)) + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +72 72 | int(round(inferred_float)) +73 73 | int(round(inferred_float, None)) +74 74 | +75 |-int(round(unknown)) + 75 |+round(unknown) +76 76 | int(round(unknown, None)) +77 77 | +78 78 | + +RUF046.py:76:1: RUF046 [*] Value being cast to `int` is already an integer + | +75 | int(round(unknown)) +76 | int(round(unknown, None)) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF046 + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +73 73 | int(round(inferred_float, None)) +74 74 | +75 75 | int(round(unknown)) +76 |-int(round(unknown, None)) + 76 |+round(unknown, None) +77 77 | +78 78 | +79 79 | ### No errors + +RUF046.py:158:1: RUF046 [*] Value being cast to `int` is already an integer + | +156 | int(1. if ... else .2) +157 | +158 | / int(1 + +159 | | 1) + | |______^ RUF046 +160 | +161 | int(round(1, + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +155 155 | +156 156 | int(1. if ... else .2) +157 157 | +158 |-int(1 + + 158 |+(1 + +159 159 | 1) +160 160 | +161 161 | int(round(1, + +RUF046.py:161:1: RUF046 [*] Value being cast to `int` is already an integer + | +159 | 1) +160 | +161 | / int(round(1, +162 | | 0)) + | |_____________^ RUF046 +163 | +164 | # function calls may need to retain parentheses + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +158 158 | int(1 + +159 159 | 1) +160 160 | +161 |-int(round(1, +162 |- 0)) + 161 |+round(1, + 162 |+ 0) +163 163 | +164 164 | # function calls may need to retain parentheses +165 165 | # if the parentheses for the call itself + +RUF046.py:168:1: RUF046 [*] Value being cast to `int` is already an integer + | +166 | # lie on the next line. +167 | # See https://github.com/astral-sh/ruff/issues/15263 +168 | / int(round +169 | | (1)) + | |____^ RUF046 +170 | +171 | int(round # a comment + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +165 165 | # if the parentheses for the call itself +166 166 | # lie on the next line. +167 167 | # See https://github.com/astral-sh/ruff/issues/15263 +168 |-int(round + 168 |+(round +169 169 | (1)) +170 170 | +171 171 | int(round # a comment + +RUF046.py:171:1: RUF046 [*] Value being cast to `int` is already an integer + | +169 | (1)) +170 | +171 | / int(round # a comment +172 | | # and another comment +173 | | (10) +174 | | ) + | |_^ RUF046 +175 | +176 | int(round (17)) # this is safe without parens + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +168 168 | int(round +169 169 | (1)) +170 170 | +171 |-int(round # a comment + 171 |+(round # a comment +172 172 | # and another comment +173 |-(10) +174 |-) + 173 |+(10)) +175 174 | +176 175 | int(round (17)) # this is safe without parens +177 176 | + +RUF046.py:176:1: RUF046 [*] Value being cast to `int` is already an integer + | +174 | ) +175 | +176 | int(round (17)) # this is safe without parens + | ^^^^^^^^^^^^^^^ RUF046 +177 | +178 | int( round ( + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +173 173 | (10) +174 174 | ) +175 175 | +176 |-int(round (17)) # this is safe without parens + 176 |+round (17) # this is safe without parens +177 177 | +178 178 | int( round ( +179 179 | 17 + +RUF046.py:178:1: RUF046 [*] Value being cast to `int` is already an integer + | +176 | int(round (17)) # this is safe without parens +177 | +178 | / int( round ( +179 | | 17 +180 | | )) # this is also safe without parens + | |______________^ RUF046 +181 | +182 | int((round) # Comment + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +175 175 | +176 176 | int(round (17)) # this is safe without parens +177 177 | +178 |-int( round ( + 178 |+round ( +179 179 | 17 +180 |- )) # this is also safe without parens + 180 |+ ) # this is also safe without parens +181 181 | +182 182 | int((round) # Comment +183 183 | (42) + +RUF046.py:182:1: RUF046 [*] Value being cast to `int` is already an integer + | +180 | )) # this is also safe without parens +181 | +182 | / int((round) # Comment +183 | | (42) +184 | | ) + | |_^ RUF046 +185 | +186 | int((round # Comment + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +179 179 | 17 +180 180 | )) # this is also safe without parens +181 181 | +182 |-int((round) # Comment +183 |-(42) +184 |-) + 182 |+((round) # Comment + 183 |+(42)) +185 184 | +186 185 | int((round # Comment +187 186 | )(42) + +RUF046.py:186:1: RUF046 [*] Value being cast to `int` is already an integer + | +184 | ) +185 | +186 | / int((round # Comment +187 | | )(42) +188 | | ) + | |_^ RUF046 +189 | +190 | int( # Unsafe fix because of this comment + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +183 183 | (42) +184 184 | ) +185 185 | +186 |-int((round # Comment + 186 |+(round # Comment +187 187 | )(42) +188 |-) +189 188 | +190 189 | int( # Unsafe fix because of this comment +191 190 | ( # Comment + +RUF046.py:190:1: RUF046 [*] Value being cast to `int` is already an integer + | +188 | ) +189 | +190 | / int( # Unsafe fix because of this comment +191 | | ( # Comment +192 | | (round +193 | | ) # Comment +194 | | )(42) +195 | | ) + | |_^ RUF046 +196 | +197 | int( + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +187 187 | )(42) +188 188 | ) +189 189 | +190 |-int( # Unsafe fix because of this comment +191 190 | ( # Comment +192 191 | (round +193 192 | ) # Comment +194 193 | )(42) +195 |-) +196 194 | +197 195 | int( +198 196 | round( + +RUF046.py:197:1: RUF046 [*] Value being cast to `int` is already an integer + | +195 | ) +196 | +197 | / int( +198 | | round( +199 | | 42 +200 | | ) # unsafe fix because of this comment +201 | | ) + | |_^ RUF046 +202 | +203 | int( + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +194 194 | )(42) +195 195 | ) +196 196 | +197 |-int( +198 |- round( + 197 |+round( +199 198 | 42 +200 |- ) # unsafe fix because of this comment +201 |-) + 199 |+ ) +202 200 | +203 201 | int( +204 202 | round( + +RUF046.py:203:1: RUF046 [*] Value being cast to `int` is already an integer + | +201 | ) +202 | +203 | / int( +204 | | round( +205 | | 42 +206 | | ) +207 | | # unsafe fix because of this comment +208 | | ) + | |_^ RUF046 + | + = help: Remove unnecessary `int` call + +ℹ Unsafe fix +200 200 | ) # unsafe fix because of this comment +201 201 | ) +202 202 | +203 |-int( +204 |- round( + 203 |+round( +205 204 | 42 +206 |- ) +207 |-# unsafe fix because of this comment +208 |-) + 205 |+ ) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_CR.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_CR.py.snap new file mode 100644 index 0000000000000..61b9115357d0a --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_CR.py.snap @@ -0,0 +1,12 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF046_CR.py:1:1: RUF046 [*] Value being cast to `int` is already an integer + | +1 | int(- 1) # Carriage return as newline + | ^^^^^^^^^^^ RUF046 + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +1 |-int(- 1 |+(- 2 2 | 1) # Carriage return as newline diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_LF.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_LF.py.snap new file mode 100644 index 0000000000000..97d44c191d4df --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF046_RUF046_LF.py.snap @@ -0,0 +1,17 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF046_LF.py:2:1: RUF046 [*] Value being cast to `int` is already an integer + | +1 | # \n as newline +2 | / int(- +3 | | 1) + | |______^ RUF046 + | + = help: Remove unnecessary `int` call + +ℹ Safe fix +1 1 | # \n as newline +2 |-int(- + 2 |+(- +3 3 | 1) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_for.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_for.py.snap new file mode 100644 index 0000000000000..3a0d9bc7a97a7 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_for.py.snap @@ -0,0 +1,42 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF047_for.py:6:1: RUF047 [*] Empty `else` clause + | +4 | loop_body_is_not_checked() +5 | break +6 | / else: +7 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +3 3 | for _ in range(0): +4 4 | loop_body_is_not_checked() +5 5 | break +6 |-else: +7 |- pass +8 6 | +9 7 | +10 8 | for this in comment: + +RUF047_for.py:12:1: RUF047 [*] Empty `else` clause + | +10 | for this in comment: +11 | belongs_to() # `for` +12 | / else: +13 | | ... + | |_______^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +9 9 | +10 10 | for this in comment: +11 11 | belongs_to() # `for` +12 |-else: +13 |- ... +14 12 | +15 13 | +16 14 | for of in course(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_if.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_if.py.snap new file mode 100644 index 0000000000000..b84cff6ad2572 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_if.py.snap @@ -0,0 +1,159 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF047_if.py:5:1: RUF047 [*] Empty `else` clause + | +3 | if False: +4 | condition_is_not_evaluated() +5 | / else: +6 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +2 2 | +3 3 | if False: +4 4 | condition_is_not_evaluated() +5 |-else: +6 |- pass +7 5 | +8 6 | +9 7 | if this_comment(): + +RUF047_if.py:11:1: RUF047 [*] Empty `else` clause + | + 9 | if this_comment(): +10 | belongs_to() # `if` +11 | / else: +12 | | ... + | |_______^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +8 8 | +9 9 | if this_comment(): +10 10 | belongs_to() # `if` +11 |-else: +12 |- ... +13 11 | +14 12 | +15 13 | if elif_is(): + +RUF047_if.py:19:1: RUF047 [*] Empty `else` clause + | +17 | elif the_same(): +18 | as_if() +19 | / else: +20 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +16 16 | treated() +17 17 | elif the_same(): +18 18 | as_if() +19 |-else: +20 |- pass +21 19 | +22 20 | +23 21 | if this_second_comment(): + +RUF047_if.py:26:1: RUF047 [*] Empty `else` clause + | +24 | belongs() # to +25 | # `if` +26 | / else: +27 | | pass + | |________^ RUF047 +28 | +29 | if this_second_comment(): + | + = help: Remove the `else` clause + +ℹ Safe fix +23 23 | if this_second_comment(): +24 24 | belongs() # to +25 25 | # `if` +26 |-else: +27 |- pass +28 26 | +29 27 | if this_second_comment(): +30 28 | belongs() # to + +RUF047_if.py:32:1: RUF047 [*] Empty `else` clause + | +30 | belongs() # to +31 | # `if` +32 | / else: +33 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +29 29 | if this_second_comment(): +30 30 | belongs() # to +31 31 | # `if` +32 |-else: +33 |- pass +34 32 | +35 33 | +36 34 | if of_course(): + +RUF047_if.py:44:1: RUF047 [*] Empty `else` clause + | +43 | if of_course: this() +44 | else: ... + | ^^^^^^^^^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +41 41 | +42 42 | +43 43 | if of_course: this() +44 |-else: ... +45 44 | +46 45 | +47 46 | if of_course: + +RUF047_if.py:49:1: RUF047 [*] Empty `else` clause + | +47 | if of_course: +48 | this() # comment +49 | else: ... + | ^^^^^^^^^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +46 46 | +47 47 | if of_course: +48 48 | this() # comment +49 |-else: ... +50 49 | +51 50 | +52 51 | def nested(): + +RUF047_if.py:55:5: RUF047 [*] Empty `else` clause + | +53 | if a: +54 | b() +55 | / else: +56 | | ... + | |___________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +52 52 | def nested(): +53 53 | if a: +54 54 | b() +55 |- else: +56 |- ... +57 55 | +58 56 | +59 57 | ### No errors diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_try.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_try.py.snap new file mode 100644 index 0000000000000..e27078492cd2c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_try.py.snap @@ -0,0 +1,42 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF047_try.py:7:1: RUF047 [*] Empty `else` clause + | +5 | except: +6 | pass +7 | / else: +8 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +4 4 | raise try_body_is_not_checked() +5 5 | except: +6 6 | pass +7 |-else: +8 |- pass +9 7 | +10 8 | +11 9 | try: + +RUF047_try.py:17:1: RUF047 [*] Empty `else` clause + | +15 | except: +16 | to() # `except` +17 | / else: +18 | | ... + | |_______^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +14 14 | belongs() +15 15 | except: +16 16 | to() # `except` +17 |-else: +18 |- ... +19 17 | +20 18 | +21 19 | try: diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_while.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_while.py.snap new file mode 100644 index 0000000000000..c149edd4edd06 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF047_RUF047_while.py.snap @@ -0,0 +1,42 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF047_while.py:6:1: RUF047 [*] Empty `else` clause + | +4 | loop_body_is_not_checked() +5 | break +6 | / else: +7 | | pass + | |________^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +3 3 | while True: +4 4 | loop_body_is_not_checked() +5 5 | break +6 |-else: +7 |- pass +8 6 | +9 7 | +10 8 | while this_comment: + +RUF047_while.py:12:1: RUF047 [*] Empty `else` clause + | +10 | while this_comment: +11 | belongs_to() # `for` +12 | / else: +13 | | ... + | |_______^ RUF047 + | + = help: Remove the `else` clause + +ℹ Safe fix +9 9 | +10 10 | while this_comment: +11 11 | belongs_to() # `for` +12 |-else: +13 |- ... +14 12 | +15 13 | +16 14 | while of_course(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048.py.snap new file mode 100644 index 0000000000000..94348d436371c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048.py.snap @@ -0,0 +1,26 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF048.py:4:7: RUF048 `__version__` may contain non-integral-like elements + | +4 | tuple(map(int, __version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +5 | list(map(int, __version__.split("."))) + | + +RUF048.py:5:6: RUF048 `__version__` may contain non-integral-like elements + | +4 | tuple(map(int, __version__.split("."))) +5 | list(map(int, __version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +6 | +7 | # `sep` passed as keyword argument + | + +RUF048.py:8:13: RUF048 `__version__` may contain non-integral-like elements + | +7 | # `sep` passed as keyword argument +8 | for part in map(int, __version__.split(sep=".")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +9 | print(part) + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048_1.py.snap new file mode 100644 index 0000000000000..ae6ce29c4e4db --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF048_RUF048_1.py.snap @@ -0,0 +1,55 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF048_1.py:5:7: RUF048 `__version__` may contain non-integral-like elements + | +5 | tuple(map(int, __version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +6 | list(map(int, __version__.split("."))) +7 | tuple(map(int, bar.__version__.split("."))) + | + +RUF048_1.py:6:6: RUF048 `__version__` may contain non-integral-like elements + | +5 | tuple(map(int, __version__.split("."))) +6 | list(map(int, __version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +7 | tuple(map(int, bar.__version__.split("."))) +8 | list(map(int, bar.__version__.split("."))) + | + +RUF048_1.py:7:7: RUF048 `__version__` may contain non-integral-like elements + | +5 | tuple(map(int, __version__.split("."))) +6 | list(map(int, __version__.split("."))) +7 | tuple(map(int, bar.__version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +8 | list(map(int, bar.__version__.split("."))) + | + +RUF048_1.py:8:6: RUF048 `__version__` may contain non-integral-like elements + | + 6 | list(map(int, __version__.split("."))) + 7 | tuple(map(int, bar.__version__.split("."))) + 8 | list(map(int, bar.__version__.split("."))) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 + 9 | +10 | # `sep` passed as keyword argument + | + +RUF048_1.py:11:13: RUF048 `__version__` may contain non-integral-like elements + | +10 | # `sep` passed as keyword argument +11 | for part in map(int, bar.__version__.split(sep=".")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +12 | print(part) + | + +RUF048_1.py:14:13: RUF048 `__version__` may contain non-integral-like elements + | +12 | print(part) +13 | +14 | for part in map(int, __version__.split(sep=".")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF048 +15 | print(part) + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF051_RUF051.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF051_RUF051.py.snap new file mode 100644 index 0000000000000..d164c38b8cb03 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF051_RUF051.py.snap @@ -0,0 +1,593 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF051.py:8:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | + 7 | if k in d: # Bare name + 8 | del d[k] + | ^^^^^^^^ RUF051 + 9 | +10 | if '' in d: # String + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +4 4 | +5 5 | ### Errors +6 6 | +7 |-if k in d: # Bare name +8 |- del d[k] + 7 |+d.pop(k, None) +9 8 | +10 9 | if '' in d: # String +11 10 | del d[""] # Different quotes + +RUF051.py:11:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +10 | if '' in d: # String +11 | del d[""] # Different quotes + | ^^^^^^^^^ RUF051 +12 | +13 | if b"" in d: # Bytes + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +7 7 | if k in d: # Bare name +8 8 | del d[k] +9 9 | +10 |-if '' in d: # String +11 |- del d[""] # Different quotes + 10 |+d.pop('', None) # Different quotes +12 11 | +13 12 | if b"" in d: # Bytes +14 13 | del d[ # Multiline slice + +RUF051.py:14:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +13 | if b"" in d: # Bytes +14 | / del d[ # Multiline slice +15 | | b'''''' # Triple quotes +16 | | ] + | |_____^ RUF051 +17 | +18 | if 0 in d: del d[0] # Single-line statement + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +10 10 | if '' in d: # String +11 11 | del d[""] # Different quotes +12 12 | +13 |-if b"" in d: # Bytes +14 |- del d[ # Multiline slice +15 |- b'''''' # Triple quotes +16 |- ] + 13 |+d.pop(b"", None) +17 14 | +18 15 | if 0 in d: del d[0] # Single-line statement +19 16 | + +RUF051.py:18:12: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +16 | ] +17 | +18 | if 0 in d: del d[0] # Single-line statement + | ^^^^^^^^ RUF051 +19 | +20 | if 3j in d: # Complex + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +15 15 | b'''''' # Triple quotes +16 16 | ] +17 17 | +18 |-if 0 in d: del d[0] # Single-line statement + 18 |+d.pop(0, None) # Single-line statement +19 19 | +20 20 | if 3j in d: # Complex +21 21 | del d[3j] + +RUF051.py:21:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +20 | if 3j in d: # Complex +21 | del d[3j] + | ^^^^^^^^^ RUF051 +22 | +23 | if 0.1234 in d: # Float + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +17 17 | +18 18 | if 0 in d: del d[0] # Single-line statement +19 19 | +20 |-if 3j in d: # Complex +21 |- del d[3j] + 20 |+d.pop(3j, None) +22 21 | +23 22 | if 0.1234 in d: # Float +24 23 | del d[.1_2_3_4] # Number separators and shorthand syntax + +RUF051.py:24:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +23 | if 0.1234 in d: # Float +24 | del d[.1_2_3_4] # Number separators and shorthand syntax + | ^^^^^^^^^^^^^^^ RUF051 +25 | +26 | if True in d: # True + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +20 20 | if 3j in d: # Complex +21 21 | del d[3j] +22 22 | +23 |-if 0.1234 in d: # Float +24 |- del d[.1_2_3_4] # Number separators and shorthand syntax + 23 |+d.pop(0.1234, None) # Number separators and shorthand syntax +25 24 | +26 25 | if True in d: # True +27 26 | del d[True] + +RUF051.py:27:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +26 | if True in d: # True +27 | del d[True] + | ^^^^^^^^^^^ RUF051 +28 | +29 | if False in d: # False + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +23 23 | if 0.1234 in d: # Float +24 24 | del d[.1_2_3_4] # Number separators and shorthand syntax +25 25 | +26 |-if True in d: # True +27 |- del d[True] + 26 |+d.pop(True, None) +28 27 | +29 28 | if False in d: # False +30 29 | del d[False] + +RUF051.py:30:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +29 | if False in d: # False +30 | del d[False] + | ^^^^^^^^^^^^ RUF051 +31 | +32 | if None in d: # None + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +26 26 | if True in d: # True +27 27 | del d[True] +28 28 | +29 |-if False in d: # False +30 |- del d[False] + 29 |+d.pop(False, None) +31 30 | +32 31 | if None in d: # None +33 32 | del d[ + +RUF051.py:33:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +32 | if None in d: # None +33 | / del d[ +34 | | # Comment in the middle +35 | | None +36 | | ] + | |_____^ RUF051 +37 | +38 | if ... in d: # Ellipsis + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +29 29 | if False in d: # False +30 30 | del d[False] +31 31 | +32 |-if None in d: # None +33 |- del d[ +34 |- # Comment in the middle +35 |- None +36 |- ] + 32 |+d.pop(None, None) +37 33 | +38 34 | if ... in d: # Ellipsis +39 35 | del d[ + +RUF051.py:39:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +38 | if ... in d: # Ellipsis +39 | / del d[ +40 | | # Comment in the middle, indented +41 | | ...] + | |____________^ RUF051 +42 | +43 | if "a" "bc" in d: # String concatenation + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +35 35 | None +36 36 | ] +37 37 | +38 |-if ... in d: # Ellipsis +39 |- del d[ +40 |- # Comment in the middle, indented +41 |- ...] + 38 |+d.pop(..., None) +42 39 | +43 40 | if "a" "bc" in d: # String concatenation +44 41 | del d['abc'] + +RUF051.py:44:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +43 | if "a" "bc" in d: # String concatenation +44 | del d['abc'] + | ^^^^^^^^^^^^ RUF051 +45 | +46 | if r"\foo" in d: # Raw string + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +40 40 | # Comment in the middle, indented +41 41 | ...] +42 42 | +43 |-if "a" "bc" in d: # String concatenation +44 |- del d['abc'] + 43 |+d.pop("a" "bc", None) +45 44 | +46 45 | if r"\foo" in d: # Raw string +47 46 | del d['\\foo'] + +RUF051.py:47:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +46 | if r"\foo" in d: # Raw string +47 | del d['\\foo'] + | ^^^^^^^^^^^^^^ RUF051 +48 | +49 | if b'yt' b'es' in d: # Bytes concatenation + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +43 43 | if "a" "bc" in d: # String concatenation +44 44 | del d['abc'] +45 45 | +46 |-if r"\foo" in d: # Raw string +47 |- del d['\\foo'] + 46 |+d.pop(r"\foo", None) +48 47 | +49 48 | if b'yt' b'es' in d: # Bytes concatenation +50 49 | del d[rb"""ytes"""] # Raw bytes + +RUF051.py:50:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +49 | if b'yt' b'es' in d: # Bytes concatenation +50 | del d[rb"""ytes"""] # Raw bytes + | ^^^^^^^^^^^^^^^^^^^ RUF051 +51 | +52 | if k in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +46 46 | if r"\foo" in d: # Raw string +47 47 | del d['\\foo'] +48 48 | +49 |-if b'yt' b'es' in d: # Bytes concatenation +50 |- del d[rb"""ytes"""] # Raw bytes + 49 |+d.pop(b'yt' b'es', None) # Raw bytes +51 50 | +52 51 | if k in d: +53 52 | # comment that gets dropped + +RUF051.py:54:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +52 | if k in d: +53 | # comment that gets dropped +54 | del d[k] + | ^^^^^^^^ RUF051 +55 | +56 | ### Safely fixable + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Unsafe fix +49 49 | if b'yt' b'es' in d: # Bytes concatenation +50 50 | del d[rb"""ytes"""] # Raw bytes +51 51 | +52 |-if k in d: +53 |- # comment that gets dropped +54 |- del d[k] + 52 |+d.pop(k, None) +55 53 | +56 54 | ### Safely fixable +57 55 | + +RUF051.py:59:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +58 | if k in d: +59 | del d[k] + | ^^^^^^^^ RUF051 +60 | +61 | if '' in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +55 55 | +56 56 | ### Safely fixable +57 57 | +58 |-if k in d: +59 |- del d[k] + 58 |+d.pop(k, None) +60 59 | +61 60 | if '' in d: +62 61 | del d[""] + +RUF051.py:62:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +61 | if '' in d: +62 | del d[""] + | ^^^^^^^^^ RUF051 +63 | +64 | if b"" in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +58 58 | if k in d: +59 59 | del d[k] +60 60 | +61 |-if '' in d: +62 |- del d[""] + 61 |+d.pop('', None) +63 62 | +64 63 | if b"" in d: +65 64 | del d[ + +RUF051.py:65:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +64 | if b"" in d: +65 | / del d[ +66 | | b'''''' +67 | | ] + | |_____^ RUF051 +68 | +69 | if 0 in d: del d[0] + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +61 61 | if '' in d: +62 62 | del d[""] +63 63 | +64 |-if b"" in d: +65 |- del d[ +66 |- b'''''' +67 |- ] + 64 |+d.pop(b"", None) +68 65 | +69 66 | if 0 in d: del d[0] +70 67 | + +RUF051.py:69:12: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +67 | ] +68 | +69 | if 0 in d: del d[0] + | ^^^^^^^^ RUF051 +70 | +71 | if 3j in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +66 66 | b'''''' +67 67 | ] +68 68 | +69 |-if 0 in d: del d[0] + 69 |+d.pop(0, None) +70 70 | +71 71 | if 3j in d: +72 72 | del d[3j] + +RUF051.py:72:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +71 | if 3j in d: +72 | del d[3j] + | ^^^^^^^^^ RUF051 +73 | +74 | if 0.1234 in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +68 68 | +69 69 | if 0 in d: del d[0] +70 70 | +71 |-if 3j in d: +72 |- del d[3j] + 71 |+d.pop(3j, None) +73 72 | +74 73 | if 0.1234 in d: +75 74 | del d[.1_2_3_4] + +RUF051.py:75:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +74 | if 0.1234 in d: +75 | del d[.1_2_3_4] + | ^^^^^^^^^^^^^^^ RUF051 +76 | +77 | if True in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +71 71 | if 3j in d: +72 72 | del d[3j] +73 73 | +74 |-if 0.1234 in d: +75 |- del d[.1_2_3_4] + 74 |+d.pop(0.1234, None) +76 75 | +77 76 | if True in d: +78 77 | del d[True] + +RUF051.py:78:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +77 | if True in d: +78 | del d[True] + | ^^^^^^^^^^^ RUF051 +79 | +80 | if False in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +74 74 | if 0.1234 in d: +75 75 | del d[.1_2_3_4] +76 76 | +77 |-if True in d: +78 |- del d[True] + 77 |+d.pop(True, None) +79 78 | +80 79 | if False in d: +81 80 | del d[False] + +RUF051.py:81:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +80 | if False in d: +81 | del d[False] + | ^^^^^^^^^^^^ RUF051 +82 | +83 | if None in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +77 77 | if True in d: +78 78 | del d[True] +79 79 | +80 |-if False in d: +81 |- del d[False] + 80 |+d.pop(False, None) +82 81 | +83 82 | if None in d: +84 83 | del d[ + +RUF051.py:84:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +83 | if None in d: +84 | / del d[ +85 | | None +86 | | ] + | |_____^ RUF051 +87 | +88 | if ... in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +80 80 | if False in d: +81 81 | del d[False] +82 82 | +83 |-if None in d: +84 |- del d[ +85 |- None +86 |- ] + 83 |+d.pop(None, None) +87 84 | +88 85 | if ... in d: +89 86 | del d[ + +RUF051.py:89:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +88 | if ... in d: +89 | / del d[ +90 | | ...] + | |____________^ RUF051 +91 | +92 | if "a" "bc" in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +85 85 | None +86 86 | ] +87 87 | +88 |-if ... in d: +89 |- del d[ +90 |- ...] + 88 |+d.pop(..., None) +91 89 | +92 90 | if "a" "bc" in d: +93 91 | del d['abc'] + +RUF051.py:93:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +92 | if "a" "bc" in d: +93 | del d['abc'] + | ^^^^^^^^^^^^ RUF051 +94 | +95 | if r"\foo" in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +89 89 | del d[ +90 90 | ...] +91 91 | +92 |-if "a" "bc" in d: +93 |- del d['abc'] + 92 |+d.pop("a" "bc", None) +94 93 | +95 94 | if r"\foo" in d: +96 95 | del d['\\foo'] + +RUF051.py:96:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +95 | if r"\foo" in d: +96 | del d['\\foo'] + | ^^^^^^^^^^^^^^ RUF051 +97 | +98 | if b'yt' b'es' in d: + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +92 92 | if "a" "bc" in d: +93 93 | del d['abc'] +94 94 | +95 |-if r"\foo" in d: +96 |- del d['\\foo'] + 95 |+d.pop(r"\foo", None) +97 96 | +98 97 | if b'yt' b'es' in d: +99 98 | del d[rb"""ytes"""] # This should not make the fix unsafe + +RUF051.py:99:5: RUF051 [*] Use `pop` instead of `key in dict` followed by `del dict[key]` + | +98 | if b'yt' b'es' in d: +99 | del d[rb"""ytes"""] # This should not make the fix unsafe + | ^^^^^^^^^^^^^^^^^^^ RUF051 + | + = help: Replace `if` statement with `.pop(..., None)` + +ℹ Safe fix +95 95 | if r"\foo" in d: +96 96 | del d['\\foo'] +97 97 | +98 |-if b'yt' b'es' in d: +99 |- del d[rb"""ytes"""] # This should not make the fix unsafe + 98 |+d.pop(b'yt' b'es', None) # This should not make the fix unsafe +100 99 | +101 100 | +102 101 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF052_RUF052.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF052_RUF052.py.snap new file mode 100644 index 0000000000000..d9d8b1e40296b --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF052_RUF052.py.snap @@ -0,0 +1,403 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF052.py:92:9: RUF052 [*] Local dummy variable `_var` is accessed + | +90 | class Class_: +91 | def fun(self): +92 | _var = "method variable" # [RUF052] + | ^^^^ RUF052 +93 | return _var + | + = help: Remove leading underscores + +ℹ Unsafe fix +89 89 | +90 90 | class Class_: +91 91 | def fun(self): +92 |- _var = "method variable" # [RUF052] +93 |- return _var + 92 |+ var = "method variable" # [RUF052] + 93 |+ return var +94 94 | +95 95 | def fun(_var): # parameters are ignored +96 96 | return _var + +RUF052.py:99:5: RUF052 [*] Local dummy variable `_list` is accessed + | + 98 | def fun(): + 99 | _list = "built-in" # [RUF052] + | ^^^^^ RUF052 +100 | return _list + | + = help: Prefer using trailing underscores to avoid shadowing a built-in + +ℹ Unsafe fix +96 96 | return _var +97 97 | +98 98 | def fun(): +99 |- _list = "built-in" # [RUF052] +100 |- return _list + 99 |+ list_ = "built-in" # [RUF052] + 100 |+ return list_ +101 101 | +102 102 | x = "global" +103 103 | + +RUF052.py:106:5: RUF052 [*] Local dummy variable `_x` is accessed + | +104 | def fun(): +105 | global x +106 | _x = "shadows global" # [RUF052] + | ^^ RUF052 +107 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +103 103 | +104 104 | def fun(): +105 105 | global x +106 |- _x = "shadows global" # [RUF052] +107 |- return _x + 106 |+ x_ = "shadows global" # [RUF052] + 107 |+ return x_ +108 108 | +109 109 | def foo(): +110 110 | x = "outer" + +RUF052.py:113:5: RUF052 [*] Local dummy variable `_x` is accessed + | +111 | def bar(): +112 | nonlocal x +113 | _x = "shadows nonlocal" # [RUF052] + | ^^ RUF052 +114 | return _x +115 | bar() + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +110 110 | x = "outer" +111 111 | def bar(): +112 112 | nonlocal x +113 |- _x = "shadows nonlocal" # [RUF052] +114 |- return _x + 113 |+ x_ = "shadows nonlocal" # [RUF052] + 114 |+ return x_ +115 115 | bar() +116 116 | return x +117 117 | + +RUF052.py:120:5: RUF052 [*] Local dummy variable `_x` is accessed + | +118 | def fun(): +119 | x = "local" +120 | _x = "shadows local" # [RUF052] + | ^^ RUF052 +121 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +117 117 | +118 118 | def fun(): +119 119 | x = "local" +120 |- _x = "shadows local" # [RUF052] +121 |- return _x + 120 |+ x_ = "shadows local" # [RUF052] + 121 |+ return x_ +122 122 | +123 123 | +124 124 | GLOBAL_1 = "global 1" + +RUF052.py:128:5: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +127 | def unfixables(): +128 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +129 | # unfixable because the rename would shadow a global variable +130 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:136:5: RUF052 Local dummy variable `_local` is accessed + | +135 | # unfixable because the rename would shadow a local variable +136 | _local = "local3" # [RUF052] + | ^^^^^^ RUF052 +137 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:140:9: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +139 | def nested(): +140 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +141 | # unfixable because the rename would shadow a global variable +142 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:145:9: RUF052 Local dummy variable `_local` is accessed + | +144 | # unfixable because the rename would shadow a variable from the outer function +145 | _local = "local4" + | ^^^^^^ RUF052 +146 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:153:5: RUF052 [*] Local dummy variable `_P` is accessed + | +151 | from collections import namedtuple +152 | +153 | _P = ParamSpec("_P") + | ^^ RUF052 +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | + = help: Remove leading underscores + +ℹ Unsafe fix +150 150 | from enum import Enum +151 151 | from collections import namedtuple +152 152 | +153 |- _P = ParamSpec("_P") + 153 |+ P = ParamSpec("P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +-------------------------------------------------------------------------------- +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:154:5: RUF052 [*] Local dummy variable `_T` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) + | ^^ RUF052 +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | + = help: Remove leading underscores + +ℹ Unsafe fix +151 151 | from collections import namedtuple +152 152 | +153 153 | _P = ParamSpec("_P") +154 |- _T = TypeVar(name="_T", covariant=True, bound=int|str) + 154 |+ T = TypeVar(name="T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +-------------------------------------------------------------------------------- +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:155:5: RUF052 [*] Local dummy variable `_NT` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | ^^^ RUF052 +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | + = help: Remove leading underscores + +ℹ Unsafe fix +152 152 | +153 153 | _P = ParamSpec("_P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 |- _NT = NamedTuple("_NT", [("foo", int)]) + 155 |+ NT = NamedTuple("NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:156:5: RUF052 [*] Local dummy variable `_E` is accessed + | +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | ^^ RUF052 +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | + = help: Remove leading underscores + +ℹ Unsafe fix +153 153 | _P = ParamSpec("_P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 |- _E = Enum("_E", ["a", "b", "c"]) + 156 |+ E = Enum("E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:157:5: RUF052 [*] Local dummy variable `_NT2` is accessed + | +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | ^^^^ RUF052 +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | + = help: Remove leading underscores + +ℹ Unsafe fix +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 |- _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + 157 |+ NT2 = namedtuple("NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:158:5: RUF052 [*] Local dummy variable `_NT3` is accessed + | +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | ^^^^ RUF052 +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +ℹ Unsafe fix +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 |- _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + 158 |+ NT3 = namedtuple(typename="NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:159:5: RUF052 [*] Local dummy variable `_DynamicClass` is accessed + | +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | ^^^^^^^^^^^^^ RUF052 +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +ℹ Unsafe fix +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 |- _DynamicClass = type("_DynamicClass", (), {}) + 159 |+ DynamicClass = type("DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, _NT3, DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:160:5: RUF052 [*] Local dummy variable `_NotADynamicClass` is accessed + | +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | ^^^^^^^^^^^^^^^^^ RUF052 +161 | +162 | print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + | + = help: Remove leading underscores + +ℹ Unsafe fix +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 |- _NotADynamicClass = type("_NotADynamicClass") + 160 |+ NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:182:5: RUF052 [*] Local dummy variable `_dummy_var` is accessed + | +181 | def foo(): +182 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +183 | +184 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +179 179 | +180 180 | +181 181 | def foo(): +182 |- _dummy_var = 42 + 182 |+ dummy_var_ = 42 +183 183 | +184 184 | def bar(): +185 185 | dummy_var = 43 +186 |- print(_dummy_var) + 186 |+ print(dummy_var_) +187 187 | +188 188 | +189 189 | def foo(): + +RUF052.py:192:5: RUF052 Local dummy variable `_dummy_var` is accessed + | +190 | # Unfixable because both possible candidates for the new name are shadowed +191 | # in the scope of one of the references to the variable +192 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +193 | +194 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF056_RUF056.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF056_RUF056.py.snap new file mode 100644 index 0000000000000..c269084fef655 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF056_RUF056.py.snap @@ -0,0 +1,484 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF056.py:117:43: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +116 | # dict.get in ternary expression +117 | value = "not found" if my_dict.get("key", False) else "default" # [RUF056] + | ^^^^^ RUF056 +118 | +119 | # dict.get in an if statement + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +114 114 | # Invalid falsy fallbacks are when the call to dict.get is used in a boolean context +115 115 | +116 116 | # dict.get in ternary expression +117 |-value = "not found" if my_dict.get("key", False) else "default" # [RUF056] + 117 |+value = "not found" if my_dict.get("key") else "default" # [RUF056] +118 118 | +119 119 | # dict.get in an if statement +120 120 | if my_dict.get("key", False): # [RUF056] + +RUF056.py:120:23: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +119 | # dict.get in an if statement +120 | if my_dict.get("key", False): # [RUF056] + | ^^^^^ RUF056 +121 | pass + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +117 117 | value = "not found" if my_dict.get("key", False) else "default" # [RUF056] +118 118 | +119 119 | # dict.get in an if statement +120 |-if my_dict.get("key", False): # [RUF056] + 120 |+if my_dict.get("key"): # [RUF056] +121 121 | pass +122 122 | +123 123 | # dict.get in compound if statement + +RUF056.py:124:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +123 | # dict.get in compound if statement +124 | if True and my_dict.get("key", False): # [RUF056] + | ^^^^^ RUF056 +125 | pass + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +121 121 | pass +122 122 | +123 123 | # dict.get in compound if statement +124 |-if True and my_dict.get("key", False): # [RUF056] + 124 |+if True and my_dict.get("key"): # [RUF056] +125 125 | pass +126 126 | +127 127 | if my_dict.get("key", False) or True: # [RUF056] + +RUF056.py:127:23: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +125 | pass +126 | +127 | if my_dict.get("key", False) or True: # [RUF056] + | ^^^^^ RUF056 +128 | pass + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +124 124 | if True and my_dict.get("key", False): # [RUF056] +125 125 | pass +126 126 | +127 |-if my_dict.get("key", False) or True: # [RUF056] + 127 |+if my_dict.get("key") or True: # [RUF056] +128 128 | pass +129 129 | +130 130 | # dict.get in an assert statement + +RUF056.py:131:27: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +130 | # dict.get in an assert statement +131 | assert my_dict.get("key", False) # [RUF056] + | ^^^^^ RUF056 +132 | +133 | # dict.get in a while statement + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +128 128 | pass +129 129 | +130 130 | # dict.get in an assert statement +131 |-assert my_dict.get("key", False) # [RUF056] + 131 |+assert my_dict.get("key") # [RUF056] +132 132 | +133 133 | # dict.get in a while statement +134 134 | while my_dict.get("key", False): # [RUF056] + +RUF056.py:134:26: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +133 | # dict.get in a while statement +134 | while my_dict.get("key", False): # [RUF056] + | ^^^^^ RUF056 +135 | pass + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +131 131 | assert my_dict.get("key", False) # [RUF056] +132 132 | +133 133 | # dict.get in a while statement +134 |-while my_dict.get("key", False): # [RUF056] + 134 |+while my_dict.get("key"): # [RUF056] +135 135 | pass +136 136 | +137 137 | # dict.get in unary not expression + +RUF056.py:138:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +137 | # dict.get in unary not expression +138 | value = not my_dict.get("key", False) # [RUF056] + | ^^^^^ RUF056 +139 | +140 | # testing all falsy fallbacks + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +135 135 | pass +136 136 | +137 137 | # dict.get in unary not expression +138 |-value = not my_dict.get("key", False) # [RUF056] + 138 |+value = not my_dict.get("key") # [RUF056] +139 139 | +140 140 | # testing all falsy fallbacks +141 141 | value = not my_dict.get("key", False) # [RUF056] + +RUF056.py:141:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +140 | # testing all falsy fallbacks +141 | value = not my_dict.get("key", False) # [RUF056] + | ^^^^^ RUF056 +142 | value = not my_dict.get("key", []) # [RUF056] +143 | value = not my_dict.get("key", list()) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +138 138 | value = not my_dict.get("key", False) # [RUF056] +139 139 | +140 140 | # testing all falsy fallbacks +141 |-value = not my_dict.get("key", False) # [RUF056] + 141 |+value = not my_dict.get("key") # [RUF056] +142 142 | value = not my_dict.get("key", []) # [RUF056] +143 143 | value = not my_dict.get("key", list()) # [RUF056] +144 144 | value = not my_dict.get("key", {}) # [RUF056] + +RUF056.py:142:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +140 | # testing all falsy fallbacks +141 | value = not my_dict.get("key", False) # [RUF056] +142 | value = not my_dict.get("key", []) # [RUF056] + | ^^ RUF056 +143 | value = not my_dict.get("key", list()) # [RUF056] +144 | value = not my_dict.get("key", {}) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +139 139 | +140 140 | # testing all falsy fallbacks +141 141 | value = not my_dict.get("key", False) # [RUF056] +142 |-value = not my_dict.get("key", []) # [RUF056] + 142 |+value = not my_dict.get("key") # [RUF056] +143 143 | value = not my_dict.get("key", list()) # [RUF056] +144 144 | value = not my_dict.get("key", {}) # [RUF056] +145 145 | value = not my_dict.get("key", dict()) # [RUF056] + +RUF056.py:143:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +141 | value = not my_dict.get("key", False) # [RUF056] +142 | value = not my_dict.get("key", []) # [RUF056] +143 | value = not my_dict.get("key", list()) # [RUF056] + | ^^^^^^ RUF056 +144 | value = not my_dict.get("key", {}) # [RUF056] +145 | value = not my_dict.get("key", dict()) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +140 140 | # testing all falsy fallbacks +141 141 | value = not my_dict.get("key", False) # [RUF056] +142 142 | value = not my_dict.get("key", []) # [RUF056] +143 |-value = not my_dict.get("key", list()) # [RUF056] + 143 |+value = not my_dict.get("key") # [RUF056] +144 144 | value = not my_dict.get("key", {}) # [RUF056] +145 145 | value = not my_dict.get("key", dict()) # [RUF056] +146 146 | value = not my_dict.get("key", set()) # [RUF056] + +RUF056.py:144:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +142 | value = not my_dict.get("key", []) # [RUF056] +143 | value = not my_dict.get("key", list()) # [RUF056] +144 | value = not my_dict.get("key", {}) # [RUF056] + | ^^ RUF056 +145 | value = not my_dict.get("key", dict()) # [RUF056] +146 | value = not my_dict.get("key", set()) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +141 141 | value = not my_dict.get("key", False) # [RUF056] +142 142 | value = not my_dict.get("key", []) # [RUF056] +143 143 | value = not my_dict.get("key", list()) # [RUF056] +144 |-value = not my_dict.get("key", {}) # [RUF056] + 144 |+value = not my_dict.get("key") # [RUF056] +145 145 | value = not my_dict.get("key", dict()) # [RUF056] +146 146 | value = not my_dict.get("key", set()) # [RUF056] +147 147 | value = not my_dict.get("key", None) # [RUF056] + +RUF056.py:145:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +143 | value = not my_dict.get("key", list()) # [RUF056] +144 | value = not my_dict.get("key", {}) # [RUF056] +145 | value = not my_dict.get("key", dict()) # [RUF056] + | ^^^^^^ RUF056 +146 | value = not my_dict.get("key", set()) # [RUF056] +147 | value = not my_dict.get("key", None) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +142 142 | value = not my_dict.get("key", []) # [RUF056] +143 143 | value = not my_dict.get("key", list()) # [RUF056] +144 144 | value = not my_dict.get("key", {}) # [RUF056] +145 |-value = not my_dict.get("key", dict()) # [RUF056] + 145 |+value = not my_dict.get("key") # [RUF056] +146 146 | value = not my_dict.get("key", set()) # [RUF056] +147 147 | value = not my_dict.get("key", None) # [RUF056] +148 148 | value = not my_dict.get("key", 0) # [RUF056] + +RUF056.py:146:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +144 | value = not my_dict.get("key", {}) # [RUF056] +145 | value = not my_dict.get("key", dict()) # [RUF056] +146 | value = not my_dict.get("key", set()) # [RUF056] + | ^^^^^ RUF056 +147 | value = not my_dict.get("key", None) # [RUF056] +148 | value = not my_dict.get("key", 0) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +143 143 | value = not my_dict.get("key", list()) # [RUF056] +144 144 | value = not my_dict.get("key", {}) # [RUF056] +145 145 | value = not my_dict.get("key", dict()) # [RUF056] +146 |-value = not my_dict.get("key", set()) # [RUF056] + 146 |+value = not my_dict.get("key") # [RUF056] +147 147 | value = not my_dict.get("key", None) # [RUF056] +148 148 | value = not my_dict.get("key", 0) # [RUF056] +149 149 | value = not my_dict.get("key", 0.0) # [RUF056] + +RUF056.py:147:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +145 | value = not my_dict.get("key", dict()) # [RUF056] +146 | value = not my_dict.get("key", set()) # [RUF056] +147 | value = not my_dict.get("key", None) # [RUF056] + | ^^^^ RUF056 +148 | value = not my_dict.get("key", 0) # [RUF056] +149 | value = not my_dict.get("key", 0.0) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +144 144 | value = not my_dict.get("key", {}) # [RUF056] +145 145 | value = not my_dict.get("key", dict()) # [RUF056] +146 146 | value = not my_dict.get("key", set()) # [RUF056] +147 |-value = not my_dict.get("key", None) # [RUF056] + 147 |+value = not my_dict.get("key") # [RUF056] +148 148 | value = not my_dict.get("key", 0) # [RUF056] +149 149 | value = not my_dict.get("key", 0.0) # [RUF056] +150 150 | value = not my_dict.get("key", "") # [RUF056] + +RUF056.py:148:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +146 | value = not my_dict.get("key", set()) # [RUF056] +147 | value = not my_dict.get("key", None) # [RUF056] +148 | value = not my_dict.get("key", 0) # [RUF056] + | ^ RUF056 +149 | value = not my_dict.get("key", 0.0) # [RUF056] +150 | value = not my_dict.get("key", "") # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +145 145 | value = not my_dict.get("key", dict()) # [RUF056] +146 146 | value = not my_dict.get("key", set()) # [RUF056] +147 147 | value = not my_dict.get("key", None) # [RUF056] +148 |-value = not my_dict.get("key", 0) # [RUF056] + 148 |+value = not my_dict.get("key") # [RUF056] +149 149 | value = not my_dict.get("key", 0.0) # [RUF056] +150 150 | value = not my_dict.get("key", "") # [RUF056] +151 151 | + +RUF056.py:149:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +147 | value = not my_dict.get("key", None) # [RUF056] +148 | value = not my_dict.get("key", 0) # [RUF056] +149 | value = not my_dict.get("key", 0.0) # [RUF056] + | ^^^ RUF056 +150 | value = not my_dict.get("key", "") # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +146 146 | value = not my_dict.get("key", set()) # [RUF056] +147 147 | value = not my_dict.get("key", None) # [RUF056] +148 148 | value = not my_dict.get("key", 0) # [RUF056] +149 |-value = not my_dict.get("key", 0.0) # [RUF056] + 149 |+value = not my_dict.get("key") # [RUF056] +150 150 | value = not my_dict.get("key", "") # [RUF056] +151 151 | +152 152 | # testing dict.get call using kwargs + +RUF056.py:150:32: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +148 | value = not my_dict.get("key", 0) # [RUF056] +149 | value = not my_dict.get("key", 0.0) # [RUF056] +150 | value = not my_dict.get("key", "") # [RUF056] + | ^^ RUF056 +151 | +152 | # testing dict.get call using kwargs + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +147 147 | value = not my_dict.get("key", None) # [RUF056] +148 148 | value = not my_dict.get("key", 0) # [RUF056] +149 149 | value = not my_dict.get("key", 0.0) # [RUF056] +150 |-value = not my_dict.get("key", "") # [RUF056] + 150 |+value = not my_dict.get("key") # [RUF056] +151 151 | +152 152 | # testing dict.get call using kwargs +153 153 | value = not my_dict.get(key="key", default=False) # [RUF056] + +RUF056.py:153:36: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +152 | # testing dict.get call using kwargs +153 | value = not my_dict.get(key="key", default=False) # [RUF056] + | ^^^^^^^^^^^^^ RUF056 +154 | value = not my_dict.get(default=[], key="key") # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +150 150 | value = not my_dict.get("key", "") # [RUF056] +151 151 | +152 152 | # testing dict.get call using kwargs +153 |-value = not my_dict.get(key="key", default=False) # [RUF056] + 153 |+value = not my_dict.get(key="key") # [RUF056] +154 154 | value = not my_dict.get(default=[], key="key") # [RUF056] +155 155 | +156 156 | # testing invalid dict.get call with inline comment + +RUF056.py:154:25: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +152 | # testing dict.get call using kwargs +153 | value = not my_dict.get(key="key", default=False) # [RUF056] +154 | value = not my_dict.get(default=[], key="key") # [RUF056] + | ^^^^^^^^^^ RUF056 +155 | +156 | # testing invalid dict.get call with inline comment + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +151 151 | +152 152 | # testing dict.get call using kwargs +153 153 | value = not my_dict.get(key="key", default=False) # [RUF056] +154 |-value = not my_dict.get(default=[], key="key") # [RUF056] + 154 |+value = not my_dict.get(key="key") # [RUF056] +155 155 | +156 156 | # testing invalid dict.get call with inline comment +157 157 | value = not my_dict.get("key", # comment1 + +RUF056.py:158:22: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +156 | # testing invalid dict.get call with inline comment +157 | value = not my_dict.get("key", # comment1 +158 | [] # comment2 + | ^^ RUF056 +159 | ) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Unsafe fix +154 154 | value = not my_dict.get(default=[], key="key") # [RUF056] +155 155 | +156 156 | # testing invalid dict.get call with inline comment +157 |-value = not my_dict.get("key", # comment1 +158 |- [] # comment2 + 157 |+value = not my_dict.get("key" # comment2 +159 158 | ) # [RUF056] +160 159 | +161 160 | # testing invalid dict.get call with kwargs and inline comment + +RUF056.py:163:25: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +161 | # testing invalid dict.get call with kwargs and inline comment +162 | value = not my_dict.get(key="key", # comment1 +163 | default=False # comment2 + | ^^^^^^^^^^^^^ RUF056 +164 | ) # [RUF056] +165 | value = not my_dict.get(default=[], # comment1 + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Unsafe fix +159 159 | ) # [RUF056] +160 160 | +161 161 | # testing invalid dict.get call with kwargs and inline comment +162 |-value = not my_dict.get(key="key", # comment1 +163 |- default=False # comment2 + 162 |+value = not my_dict.get(key="key" # comment2 +164 163 | ) # [RUF056] +165 164 | value = not my_dict.get(default=[], # comment1 +166 165 | key="key" # comment2 + +RUF056.py:165:25: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +163 | default=False # comment2 +164 | ) # [RUF056] +165 | value = not my_dict.get(default=[], # comment1 + | ^^^^^^^^^^ RUF056 +166 | key="key" # comment2 +167 | ) # [RUF056] + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Unsafe fix +162 162 | value = not my_dict.get(key="key", # comment1 +163 163 | default=False # comment2 +164 164 | ) # [RUF056] +165 |-value = not my_dict.get(default=[], # comment1 + 165 |+value = not my_dict.get(# comment1 +166 166 | key="key" # comment2 +167 167 | ) # [RUF056] +168 168 | + +RUF056.py:170:55: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +169 | # testing invalid dict.get calls +170 | value = not my_dict.get(key="key", other="something", default=False) + | ^^^^^^^^^^^^^ RUF056 +171 | value = not my_dict.get(default=False, other="something", key="test") + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +167 167 | ) # [RUF056] +168 168 | +169 169 | # testing invalid dict.get calls +170 |-value = not my_dict.get(key="key", other="something", default=False) + 170 |+value = not my_dict.get(key="key", other="something") +171 171 | value = not my_dict.get(default=False, other="something", key="test") + +RUF056.py:171:25: RUF056 [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy. + | +169 | # testing invalid dict.get calls +170 | value = not my_dict.get(key="key", other="something", default=False) +171 | value = not my_dict.get(default=False, other="something", key="test") + | ^^^^^^^^^^^^^ RUF056 + | + = help: Remove falsy fallback from `dict.get()` + +ℹ Safe fix +168 168 | +169 169 | # testing invalid dict.get calls +170 170 | value = not my_dict.get(key="key", other="something", default=False) +171 |-value = not my_dict.get(default=False, other="something", key="test") + 171 |+value = not my_dict.get(other="something", key="test") diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_0.py.snap new file mode 100644 index 0000000000000..03d9674ce00d8 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_0.py.snap @@ -0,0 +1,200 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF059_0.py:24:6: RUF059 [*] Unpacked variable `c` is never used + | +23 | bar = (1, 2) +24 | (c, d) = bar + | ^ RUF059 +25 | +26 | (x, y) = baz = bar + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +21 21 | (a, b) = (1, 2) +22 22 | +23 23 | bar = (1, 2) +24 |- (c, d) = bar + 24 |+ (_c, d) = bar +25 25 | +26 26 | (x, y) = baz = bar +27 27 | + +RUF059_0.py:24:9: RUF059 [*] Unpacked variable `d` is never used + | +23 | bar = (1, 2) +24 | (c, d) = bar + | ^ RUF059 +25 | +26 | (x, y) = baz = bar + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +21 21 | (a, b) = (1, 2) +22 22 | +23 23 | bar = (1, 2) +24 |- (c, d) = bar + 24 |+ (c, _d) = bar +25 25 | +26 26 | (x, y) = baz = bar +27 27 | + +RUF059_0.py:26:6: RUF059 [*] Unpacked variable `x` is never used + | +24 | (c, d) = bar +25 | +26 | (x, y) = baz = bar + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +23 23 | bar = (1, 2) +24 24 | (c, d) = bar +25 25 | +26 |- (x, y) = baz = bar + 26 |+ (_x, y) = baz = bar +27 27 | +28 28 | +29 29 | def f(): + +RUF059_0.py:26:9: RUF059 [*] Unpacked variable `y` is never used + | +24 | (c, d) = bar +25 | +26 | (x, y) = baz = bar + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +23 23 | bar = (1, 2) +24 24 | (c, d) = bar +25 25 | +26 |- (x, y) = baz = bar + 26 |+ (x, _y) = baz = bar +27 27 | +28 28 | +29 29 | def f(): + +RUF059_0.py:66:24: RUF059 [*] Unpacked variable `connection` is never used + | +64 | return None, None +65 | +66 | with connect() as (connection, cursor): + | ^^^^^^^^^^ RUF059 +67 | cursor.execute("SELECT * FROM users") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +63 63 | def connect(): +64 64 | return None, None +65 65 | +66 |- with connect() as (connection, cursor): + 66 |+ with connect() as (_connection, cursor): +67 67 | cursor.execute("SELECT * FROM users") +68 68 | +69 69 | + +RUF059_0.py:74:24: RUF059 [*] Unpacked variable `connection` is never used + | +72 | return None, None +73 | +74 | with connect() as (connection, cursor): + | ^^^^^^^^^^ RUF059 +75 | cursor.execute("SELECT * FROM users") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +71 71 | def connect(): +72 72 | return None, None +73 73 | +74 |- with connect() as (connection, cursor): + 74 |+ with connect() as (_connection, cursor): +75 75 | cursor.execute("SELECT * FROM users") +76 76 | +77 77 | + +RUF059_0.py:79:49: RUF059 [*] Unpacked variable `this` is never used + | +78 | def f(): +79 | with open("file") as my_file, open("") as ((this, that)): + | ^^^^ RUF059 +80 | print("hello") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +76 76 | +77 77 | +78 78 | def f(): +79 |- with open("file") as my_file, open("") as ((this, that)): + 79 |+ with open("file") as my_file, open("") as ((_this, that)): +80 80 | print("hello") +81 81 | +82 82 | + +RUF059_0.py:79:55: RUF059 [*] Unpacked variable `that` is never used + | +78 | def f(): +79 | with open("file") as my_file, open("") as ((this, that)): + | ^^^^ RUF059 +80 | print("hello") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +76 76 | +77 77 | +78 78 | def f(): +79 |- with open("file") as my_file, open("") as ((this, that)): + 79 |+ with open("file") as my_file, open("") as ((this, _that)): +80 80 | print("hello") +81 81 | +82 82 | + +RUF059_0.py:86:23: RUF059 [*] Unpacked variable `this` is never used + | +84 | with ( +85 | open("file") as my_file, +86 | open("") as ((this, that)), + | ^^^^ RUF059 +87 | ): +88 | print("hello") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +83 83 | def f(): +84 84 | with ( +85 85 | open("file") as my_file, +86 |- open("") as ((this, that)), + 86 |+ open("") as ((_this, that)), +87 87 | ): +88 88 | print("hello") +89 89 | + +RUF059_0.py:86:29: RUF059 [*] Unpacked variable `that` is never used + | +84 | with ( +85 | open("file") as my_file, +86 | open("") as ((this, that)), + | ^^^^ RUF059 +87 | ): +88 | print("hello") + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +83 83 | def f(): +84 84 | with ( +85 85 | open("file") as my_file, +86 |- open("") as ((this, that)), + 86 |+ open("") as ((this, _that)), +87 87 | ): +88 88 | print("hello") +89 89 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_1.py.snap new file mode 100644 index 0000000000000..4172040bf243e --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_1.py.snap @@ -0,0 +1,126 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF059_1.py:2:5: RUF059 [*] Unpacked variable `x` is never used + | +1 | def f(tup): +2 | x, y = tup + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +1 1 | def f(tup): +2 |- x, y = tup + 2 |+ _x, y = tup +3 3 | +4 4 | +5 5 | def f(): + +RUF059_1.py:2:8: RUF059 [*] Unpacked variable `y` is never used + | +1 | def f(tup): +2 | x, y = tup + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +1 1 | def f(tup): +2 |- x, y = tup + 2 |+ x, _y = tup +3 3 | +4 4 | +5 5 | def f(): + +RUF059_1.py:10:9: RUF059 [*] Unpacked variable `y` is never used + | + 9 | def f(): +10 | (x, y) = coords = 1, 2 + | ^ RUF059 +11 | if x > 1: +12 | print(coords) + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +7 7 | +8 8 | +9 9 | def f(): +10 |- (x, y) = coords = 1, 2 + 10 |+ (x, _y) = coords = 1, 2 +11 11 | if x > 1: +12 12 | print(coords) +13 13 | + +RUF059_1.py:16:6: RUF059 [*] Unpacked variable `x` is never used + | +15 | def f(): +16 | (x, y) = coords = 1, 2 + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +13 13 | +14 14 | +15 15 | def f(): +16 |- (x, y) = coords = 1, 2 + 16 |+ (_x, y) = coords = 1, 2 +17 17 | +18 18 | +19 19 | def f(): + +RUF059_1.py:16:9: RUF059 [*] Unpacked variable `y` is never used + | +15 | def f(): +16 | (x, y) = coords = 1, 2 + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +13 13 | +14 14 | +15 15 | def f(): +16 |- (x, y) = coords = 1, 2 + 16 |+ (x, _y) = coords = 1, 2 +17 17 | +18 18 | +19 19 | def f(): + +RUF059_1.py:20:15: RUF059 [*] Unpacked variable `x` is never used + | +19 | def f(): +20 | coords = (x, y) = 1, 2 + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +17 17 | +18 18 | +19 19 | def f(): +20 |- coords = (x, y) = 1, 2 + 20 |+ coords = (_x, y) = 1, 2 +21 21 | +22 22 | +23 23 | def f(): + +RUF059_1.py:20:18: RUF059 [*] Unpacked variable `y` is never used + | +19 | def f(): +20 | coords = (x, y) = 1, 2 + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +17 17 | +18 18 | +19 19 | def f(): +20 |- coords = (x, y) = 1, 2 + 20 |+ coords = (x, _y) = 1, 2 +21 21 | +22 22 | +23 23 | def f(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_2.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_2.py.snap new file mode 100644 index 0000000000000..b7f265321eba4 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_2.py.snap @@ -0,0 +1,224 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF059_2.py:8:20: RUF059 [*] Unpacked variable `x2` is never used + | +6 | pass +7 | +8 | with foo() as (x2, y2): + | ^^ RUF059 +9 | pass + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +5 5 | with foo() as x1: +6 6 | pass +7 7 | +8 |- with foo() as (x2, y2): + 8 |+ with foo() as (_x2, y2): +9 9 | pass +10 10 | +11 11 | with (foo() as x3, foo() as y3, foo() as z3): + +RUF059_2.py:8:24: RUF059 [*] Unpacked variable `y2` is never used + | +6 | pass +7 | +8 | with foo() as (x2, y2): + | ^^ RUF059 +9 | pass + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +5 5 | with foo() as x1: +6 6 | pass +7 7 | +8 |- with foo() as (x2, y2): + 8 |+ with foo() as (x2, _y2): +9 9 | pass +10 10 | +11 11 | with (foo() as x3, foo() as y3, foo() as z3): + +RUF059_2.py:17:6: RUF059 [*] Unpacked variable `x2` is never used + | +15 | def f(): +16 | (x1, y1) = (1, 2) +17 | (x2, y2) = coords2 = (1, 2) + | ^^ RUF059 +18 | coords3 = (x3, y3) = (1, 2) + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +14 14 | +15 15 | def f(): +16 16 | (x1, y1) = (1, 2) +17 |- (x2, y2) = coords2 = (1, 2) + 17 |+ (_x2, y2) = coords2 = (1, 2) +18 18 | coords3 = (x3, y3) = (1, 2) +19 19 | +20 20 | + +RUF059_2.py:17:10: RUF059 [*] Unpacked variable `y2` is never used + | +15 | def f(): +16 | (x1, y1) = (1, 2) +17 | (x2, y2) = coords2 = (1, 2) + | ^^ RUF059 +18 | coords3 = (x3, y3) = (1, 2) + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +14 14 | +15 15 | def f(): +16 16 | (x1, y1) = (1, 2) +17 |- (x2, y2) = coords2 = (1, 2) + 17 |+ (x2, _y2) = coords2 = (1, 2) +18 18 | coords3 = (x3, y3) = (1, 2) +19 19 | +20 20 | + +RUF059_2.py:18:16: RUF059 [*] Unpacked variable `x3` is never used + | +16 | (x1, y1) = (1, 2) +17 | (x2, y2) = coords2 = (1, 2) +18 | coords3 = (x3, y3) = (1, 2) + | ^^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +15 15 | def f(): +16 16 | (x1, y1) = (1, 2) +17 17 | (x2, y2) = coords2 = (1, 2) +18 |- coords3 = (x3, y3) = (1, 2) + 18 |+ coords3 = (_x3, y3) = (1, 2) +19 19 | +20 20 | +21 21 | def f(): + +RUF059_2.py:18:20: RUF059 [*] Unpacked variable `y3` is never used + | +16 | (x1, y1) = (1, 2) +17 | (x2, y2) = coords2 = (1, 2) +18 | coords3 = (x3, y3) = (1, 2) + | ^^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +15 15 | def f(): +16 16 | (x1, y1) = (1, 2) +17 17 | (x2, y2) = coords2 = (1, 2) +18 |- coords3 = (x3, y3) = (1, 2) + 18 |+ coords3 = (x3, _y3) = (1, 2) +19 19 | +20 20 | +21 21 | def f(): + +RUF059_2.py:22:24: RUF059 [*] Unpacked variable `x` is never used + | +21 | def f(): +22 | with Nested(m) as (x, y): + | ^ RUF059 +23 | pass + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +19 19 | +20 20 | +21 21 | def f(): +22 |- with Nested(m) as (x, y): + 22 |+ with Nested(m) as (_x, y): +23 23 | pass +24 24 | +25 25 | + +RUF059_2.py:22:27: RUF059 [*] Unpacked variable `y` is never used + | +21 | def f(): +22 | with Nested(m) as (x, y): + | ^ RUF059 +23 | pass + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +19 19 | +20 20 | +21 21 | def f(): +22 |- with Nested(m) as (x, y): + 22 |+ with Nested(m) as (x, _y): +23 23 | pass +24 24 | +25 25 | + +RUF059_2.py:27:17: RUF059 [*] Unpacked variable `a` is never used + | +26 | def f(): +27 | toplevel = (a, b) = lexer.get_token() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +24 24 | +25 25 | +26 26 | def f(): +27 |- toplevel = (a, b) = lexer.get_token() + 27 |+ toplevel = (_a, b) = lexer.get_token() +28 28 | +29 29 | +30 30 | def f(): + +RUF059_2.py:27:20: RUF059 [*] Unpacked variable `b` is never used + | +26 | def f(): +27 | toplevel = (a, b) = lexer.get_token() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +24 24 | +25 25 | +26 26 | def f(): +27 |- toplevel = (a, b) = lexer.get_token() + 27 |+ toplevel = (a, _b) = lexer.get_token() +28 28 | +29 29 | +30 30 | def f(): + +RUF059_2.py:31:6: RUF059 [*] Unpacked variable `a` is never used + | +30 | def f(): +31 | (a, b) = toplevel = lexer.get_token() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +28 28 | +29 29 | +30 30 | def f(): +31 |- (a, b) = toplevel = lexer.get_token() + 31 |+ (_a, b) = toplevel = lexer.get_token() + +RUF059_2.py:31:9: RUF059 [*] Unpacked variable `b` is never used + | +30 | def f(): +31 | (a, b) = toplevel = lexer.get_token() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +28 28 | +29 29 | +30 30 | def f(): +31 |- (a, b) = toplevel = lexer.get_token() + 31 |+ (a, _b) = toplevel = lexer.get_token() diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_3.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_3.py.snap new file mode 100644 index 0000000000000..754acdcc6f359 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF059_RUF059_3.py.snap @@ -0,0 +1,40 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF059_3.py:13:5: RUF059 [*] Unpacked variable `b` is never used + | +11 | def bar(): +12 | a = foo() +13 | b, c = foo() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +10 10 | +11 11 | def bar(): +12 12 | a = foo() +13 |- b, c = foo() + 13 |+ _b, c = foo() +14 14 | +15 15 | +16 16 | def baz(): + +RUF059_3.py:13:8: RUF059 [*] Unpacked variable `c` is never used + | +11 | def bar(): +12 | a = foo() +13 | b, c = foo() + | ^ RUF059 + | + = help: Prefix it with an underscore or any other dummy variable pattern + +ℹ Unsafe fix +10 10 | +11 11 | def bar(): +12 12 | a = foo() +13 |- b, c = foo() + 13 |+ b, _c = foo() +14 14 | +15 15 | +16 16 | def baz(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF060_RUF060.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF060_RUF060.py.snap new file mode 100644 index 0000000000000..ac92e967a9792 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF060_RUF060.py.snap @@ -0,0 +1,230 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF060.py:2:1: RUF060 Unnecessary membership test on empty collection + | +1 | # Errors +2 | 1 in [] + | ^^^^^^^ RUF060 +3 | 1 not in [] +4 | 2 in list() + | + +RUF060.py:3:1: RUF060 Unnecessary membership test on empty collection + | +1 | # Errors +2 | 1 in [] +3 | 1 not in [] + | ^^^^^^^^^^^ RUF060 +4 | 2 in list() +5 | 2 not in list() + | + +RUF060.py:4:1: RUF060 Unnecessary membership test on empty collection + | +2 | 1 in [] +3 | 1 not in [] +4 | 2 in list() + | ^^^^^^^^^^^ RUF060 +5 | 2 not in list() +6 | _ in () + | + +RUF060.py:5:1: RUF060 Unnecessary membership test on empty collection + | +3 | 1 not in [] +4 | 2 in list() +5 | 2 not in list() + | ^^^^^^^^^^^^^^^ RUF060 +6 | _ in () +7 | _ not in () + | + +RUF060.py:6:1: RUF060 Unnecessary membership test on empty collection + | +4 | 2 in list() +5 | 2 not in list() +6 | _ in () + | ^^^^^^^ RUF060 +7 | _ not in () +8 | 'x' in tuple() + | + +RUF060.py:7:1: RUF060 Unnecessary membership test on empty collection + | +5 | 2 not in list() +6 | _ in () +7 | _ not in () + | ^^^^^^^^^^^ RUF060 +8 | 'x' in tuple() +9 | 'y' not in tuple() + | + +RUF060.py:8:1: RUF060 Unnecessary membership test on empty collection + | + 6 | _ in () + 7 | _ not in () + 8 | 'x' in tuple() + | ^^^^^^^^^^^^^^ RUF060 + 9 | 'y' not in tuple() +10 | 'a' in set() + | + +RUF060.py:9:1: RUF060 Unnecessary membership test on empty collection + | + 7 | _ not in () + 8 | 'x' in tuple() + 9 | 'y' not in tuple() + | ^^^^^^^^^^^^^^^^^^ RUF060 +10 | 'a' in set() +11 | 'a' not in set() + | + +RUF060.py:10:1: RUF060 Unnecessary membership test on empty collection + | + 8 | 'x' in tuple() + 9 | 'y' not in tuple() +10 | 'a' in set() + | ^^^^^^^^^^^^ RUF060 +11 | 'a' not in set() +12 | 'b' in {} + | + +RUF060.py:11:1: RUF060 Unnecessary membership test on empty collection + | + 9 | 'y' not in tuple() +10 | 'a' in set() +11 | 'a' not in set() + | ^^^^^^^^^^^^^^^^ RUF060 +12 | 'b' in {} +13 | 'b' not in {} + | + +RUF060.py:12:1: RUF060 Unnecessary membership test on empty collection + | +10 | 'a' in set() +11 | 'a' not in set() +12 | 'b' in {} + | ^^^^^^^^^ RUF060 +13 | 'b' not in {} +14 | 1 in dict() + | + +RUF060.py:13:1: RUF060 Unnecessary membership test on empty collection + | +11 | 'a' not in set() +12 | 'b' in {} +13 | 'b' not in {} + | ^^^^^^^^^^^^^ RUF060 +14 | 1 in dict() +15 | 2 not in dict() + | + +RUF060.py:14:1: RUF060 Unnecessary membership test on empty collection + | +12 | 'b' in {} +13 | 'b' not in {} +14 | 1 in dict() + | ^^^^^^^^^^^ RUF060 +15 | 2 not in dict() +16 | "a" in "" + | + +RUF060.py:15:1: RUF060 Unnecessary membership test on empty collection + | +13 | 'b' not in {} +14 | 1 in dict() +15 | 2 not in dict() + | ^^^^^^^^^^^^^^^ RUF060 +16 | "a" in "" +17 | b'c' in b"" + | + +RUF060.py:16:1: RUF060 Unnecessary membership test on empty collection + | +14 | 1 in dict() +15 | 2 not in dict() +16 | "a" in "" + | ^^^^^^^^^ RUF060 +17 | b'c' in b"" +18 | "b" in f"" + | + +RUF060.py:17:1: RUF060 Unnecessary membership test on empty collection + | +15 | 2 not in dict() +16 | "a" in "" +17 | b'c' in b"" + | ^^^^^^^^^^^ RUF060 +18 | "b" in f"" +19 | b"a" in bytearray() + | + +RUF060.py:18:1: RUF060 Unnecessary membership test on empty collection + | +16 | "a" in "" +17 | b'c' in b"" +18 | "b" in f"" + | ^^^^^^^^^^ RUF060 +19 | b"a" in bytearray() +20 | b"a" in bytes() + | + +RUF060.py:19:1: RUF060 Unnecessary membership test on empty collection + | +17 | b'c' in b"" +18 | "b" in f"" +19 | b"a" in bytearray() + | ^^^^^^^^^^^^^^^^^^^ RUF060 +20 | b"a" in bytes() +21 | 1 in frozenset() + | + +RUF060.py:20:1: RUF060 Unnecessary membership test on empty collection + | +18 | "b" in f"" +19 | b"a" in bytearray() +20 | b"a" in bytes() + | ^^^^^^^^^^^^^^^ RUF060 +21 | 1 in frozenset() +22 | 1 in set(set()) + | + +RUF060.py:21:1: RUF060 Unnecessary membership test on empty collection + | +19 | b"a" in bytearray() +20 | b"a" in bytes() +21 | 1 in frozenset() + | ^^^^^^^^^^^^^^^^ RUF060 +22 | 1 in set(set()) +23 | 2 in frozenset([]) + | + +RUF060.py:22:1: RUF060 Unnecessary membership test on empty collection + | +20 | b"a" in bytes() +21 | 1 in frozenset() +22 | 1 in set(set()) + | ^^^^^^^^^^^^^^^ RUF060 +23 | 2 in frozenset([]) +24 | '' in set("") + | + +RUF060.py:23:1: RUF060 Unnecessary membership test on empty collection + | +21 | 1 in frozenset() +22 | 1 in set(set()) +23 | 2 in frozenset([]) + | ^^^^^^^^^^^^^^^^^^ RUF060 +24 | '' in set("") + | + +RUF060.py:24:1: RUF060 Unnecessary membership test on empty collection + | +22 | 1 in set(set()) +23 | 2 in frozenset([]) +24 | '' in set("") + | ^^^^^^^^^^^^^ RUF060 +25 | +26 | # OK + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101.py.snap deleted file mode 100644 index c7a92cb49eff8..0000000000000 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101.py.snap +++ /dev/null @@ -1,127 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/ruff/mod.rs ---- -RUF101.py:1:15: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -1 | x = 2 # noqa: RUF940 - | ^^^^^^ RUF101 -2 | x = 2 # noqa: RUF950 -3 | x = 2 # noqa: RUF940, RUF950 - | - = help: Replace with `RUF950` - -ℹ Safe fix -1 |-x = 2 # noqa: RUF940 -2 1 | x = 2 # noqa: RUF950 - 2 |+x = 2 # noqa: RUF950 -3 3 | x = 2 # noqa: RUF940, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 - -RUF101.py:3:15: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -1 | x = 2 # noqa: RUF940 -2 | x = 2 # noqa: RUF950 -3 | x = 2 # noqa: RUF940, RUF950 - | ^^^^^^ RUF101 -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 - | - = help: Replace with `RUF950` - -ℹ Safe fix -1 1 | x = 2 # noqa: RUF940 -2 2 | x = 2 # noqa: RUF950 -3 |-x = 2 # noqa: RUF940, RUF950 - 3 |+x = 2 # noqa: RUF950, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - -RUF101.py:4:23: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -2 | x = 2 # noqa: RUF950 -3 | x = 2 # noqa: RUF940, RUF950 -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 - | ^^^^^^ RUF101 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - | - = help: Replace with `RUF950` - -ℹ Safe fix -1 1 | x = 2 # noqa: RUF940 -2 2 | x = 2 # noqa: RUF950 -3 3 | x = 2 # noqa: RUF940, RUF950 -4 |-x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 - 4 |+x = 2 # noqa: RUF950, RUF950, RUF950, RUF950, RUF950 -5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - -RUF101.py:5:15: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -3 | x = 2 # noqa: RUF940, RUF950 -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 - | ^^^^^^ RUF101 -6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - | - = help: Replace with `RUF950` - -ℹ Safe fix -2 2 | x = 2 # noqa: RUF950 -3 3 | x = 2 # noqa: RUF940, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 |-x = 2 # noqa: RUF940, RUF950, RUF940 - 5 |+x = 2 # noqa: RUF950, RUF950, RUF940 -6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - -RUF101.py:5:31: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -3 | x = 2 # noqa: RUF940, RUF950 -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 - | ^^^^^^ RUF101 -6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - | - = help: Replace with `RUF950` - -ℹ Safe fix -2 2 | x = 2 # noqa: RUF950 -3 3 | x = 2 # noqa: RUF940, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 |-x = 2 # noqa: RUF940, RUF950, RUF940 - 5 |+x = 2 # noqa: RUF940, RUF950, RUF950 -6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - -RUF101.py:6:15: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - | ^^^^^^ RUF101 - | - = help: Replace with `RUF950` - -ℹ Safe fix -3 3 | x = 2 # noqa: RUF940, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 |-x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - 6 |+x = 2 # noqa: RUF950, RUF950, RUF940, RUF950 - -RUF101.py:6:31: RUF101 [*] `RUF940` is a redirect to `RUF950` - | -4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - | ^^^^^^ RUF101 - | - = help: Replace with `RUF950` - -ℹ Safe fix -3 3 | x = 2 # noqa: RUF940, RUF950 -4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 -5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 -6 |-x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 - 6 |+x = 2 # noqa: RUF940, RUF950, RUF950, RUF950 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_0.py.snap new file mode 100644 index 0000000000000..3a43790129b8c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_0.py.snap @@ -0,0 +1,128 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF101_0.py:1:15: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +1 | x = 2 # noqa: RUF940 + | ^^^^^^ RUF101 +2 | x = 2 # noqa: RUF950 +3 | x = 2 # noqa: RUF940, RUF950 + | + = help: Replace with `RUF950` + +ℹ Safe fix +1 |-x = 2 # noqa: RUF940 +2 1 | x = 2 # noqa: RUF950 + 2 |+x = 2 # noqa: RUF950 +3 3 | x = 2 # noqa: RUF940, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 + +RUF101_0.py:3:15: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +1 | x = 2 # noqa: RUF940 +2 | x = 2 # noqa: RUF950 +3 | x = 2 # noqa: RUF940, RUF950 + | ^^^^^^ RUF101 +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 + | + = help: Replace with `RUF950` + +ℹ Safe fix +1 1 | x = 2 # noqa: RUF940 +2 2 | x = 2 # noqa: RUF950 +3 |-x = 2 # noqa: RUF940, RUF950 + 3 |+x = 2 # noqa: RUF950, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + +RUF101_0.py:4:23: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +2 | x = 2 # noqa: RUF950 +3 | x = 2 # noqa: RUF940, RUF950 +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 + | ^^^^^^ RUF101 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + | + = help: Replace with `RUF950` + +ℹ Safe fix +1 1 | x = 2 # noqa: RUF940 +2 2 | x = 2 # noqa: RUF950 +3 3 | x = 2 # noqa: RUF940, RUF950 +4 |-x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 + 4 |+x = 2 # noqa: RUF950, RUF950, RUF950, RUF950, RUF950 +5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + +RUF101_0.py:5:15: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +3 | x = 2 # noqa: RUF940, RUF950 +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 + | ^^^^^^ RUF101 +6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + | + = help: Replace with `RUF950` + +ℹ Safe fix +2 2 | x = 2 # noqa: RUF950 +3 3 | x = 2 # noqa: RUF940, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 |-x = 2 # noqa: RUF940, RUF950, RUF940 + 5 |+x = 2 # noqa: RUF950, RUF950, RUF940 +6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + +RUF101_0.py:5:31: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +3 | x = 2 # noqa: RUF940, RUF950 +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 + | ^^^^^^ RUF101 +6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + | + = help: Replace with `RUF950` + +ℹ Safe fix +2 2 | x = 2 # noqa: RUF950 +3 3 | x = 2 # noqa: RUF940, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 |-x = 2 # noqa: RUF940, RUF950, RUF940 + 5 |+x = 2 # noqa: RUF940, RUF950, RUF950 +6 6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + +RUF101_0.py:6:15: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + | ^^^^^^ RUF101 + | + = help: Replace with `RUF950` + +ℹ Safe fix +3 3 | x = 2 # noqa: RUF940, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 |-x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + 6 |+x = 2 # noqa: RUF950, RUF950, RUF940, RUF950 + +RUF101_0.py:6:31: RUF101 [*] `RUF940` is a redirect to `RUF950` + | +4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 | x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + | ^^^^^^ RUF101 + | + = help: Replace with `RUF950` + +ℹ Safe fix +3 3 | x = 2 # noqa: RUF940, RUF950 +4 4 | x = 2 # noqa: RUF950, RUF940, RUF950, RUF950, RUF950 +5 5 | x = 2 # noqa: RUF940, RUF950, RUF940 +6 |-x = 2 # noqa: RUF940, RUF950, RUF940, RUF950 + 6 |+x = 2 # noqa: RUF940, RUF950, RUF950, RUF950 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_1.py.snap new file mode 100644 index 0000000000000..2b1d4b2b8b5e3 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF101_RUF101_1.py.snap @@ -0,0 +1,23 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF101_1.py:5:15: RUF101 [*] `TCH002` is a redirect to `TC002` + | +3 | RUF101 should trigger here because the TCH rules have been recoded to TC. +4 | """ +5 | # ruff: noqa: TCH002 + | ^^^^^^ RUF101 +6 | +7 | from __future__ import annotations + | + = help: Replace with `TC002` + +ℹ Safe fix +2 2 | +3 3 | RUF101 should trigger here because the TCH rules have been recoded to TC. +4 4 | """ +5 |-# ruff: noqa: TCH002 + 5 |+# ruff: noqa: TC002 +6 6 | +7 7 | from __future__ import annotations +8 8 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF102_RUF102.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF102_RUF102.py.snap new file mode 100644 index 0000000000000..c70fa01b6ca01 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF102_RUF102.py.snap @@ -0,0 +1,219 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF102.py:2:12: RUF102 [*] Invalid rule code in `# noqa`: INVALID123 + | +1 | # Invalid code +2 | import os # noqa: INVALID123 + | ^^^^^^^^^^^^^^^^^^ RUF102 +3 | # External code +4 | import re # noqa: V123 + | + = help: Remove the rule code + +ℹ Safe fix +1 1 | # Invalid code +2 |-import os # noqa: INVALID123 + 2 |+import os +3 3 | # External code +4 4 | import re # noqa: V123 +5 5 | # Valid noqa + +RUF102.py:4:12: RUF102 [*] Invalid rule code in `# noqa`: V123 + | +2 | import os # noqa: INVALID123 +3 | # External code +4 | import re # noqa: V123 + | ^^^^^^^^^^^^ RUF102 +5 | # Valid noqa +6 | import sys # noqa: E402 + | + = help: Remove the rule code + +ℹ Safe fix +1 1 | # Invalid code +2 2 | import os # noqa: INVALID123 +3 3 | # External code +4 |-import re # noqa: V123 + 4 |+import re +5 5 | # Valid noqa +6 6 | import sys # noqa: E402 +7 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 + +RUF102.py:7:65: RUF102 [*] Invalid rule code in `# noqa`: INVALID456 + | +5 | # Valid noqa +6 | import sys # noqa: E402 +7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 + | ^^^^^^^^^^ RUF102 +8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 | # Succeeding comment + | + = help: Remove the rule code + +ℹ Safe fix +4 4 | import re # noqa: V123 +5 5 | # Valid noqa +6 6 | import sys # noqa: E402 +7 |-from functools import cache # Preceeding comment # noqa: F401, INVALID456 + 7 |+from functools import cache # Preceeding comment # noqa: F401 +8 8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment + +RUF102.py:8:53: RUF102 [*] Invalid rule code in `# noqa`: INVALID789 + | + 6 | import sys # noqa: E402 + 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 + 8 | from itertools import product # Preceeding comment # noqa: INVALID789 + | ^^^^^^^^^^^^^^^^^^ RUF102 + 9 | # Succeeding comment +10 | import math # noqa: INVALID000 # Succeeding comment + | + = help: Remove the rule code + +ℹ Safe fix +5 5 | # Valid noqa +6 6 | import sys # noqa: E402 +7 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 +8 |-from itertools import product # Preceeding comment # noqa: INVALID789 + 8 |+from itertools import product # Preceeding comment +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment +11 11 | # Mixed valid and invalid + +RUF102.py:10:13: RUF102 [*] Invalid rule code in `# noqa`: INVALID000 + | + 8 | from itertools import product # Preceeding comment # noqa: INVALID789 + 9 | # Succeeding comment +10 | import math # noqa: INVALID000 # Succeeding comment + | ^^^^^^^^^^^^^^^^^^ RUF102 +11 | # Mixed valid and invalid +12 | from typing import List # noqa: F401, INVALID123 + | + = help: Remove the rule code + +ℹ Safe fix +7 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 +8 8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 9 | # Succeeding comment +10 |-import math # noqa: INVALID000 # Succeeding comment + 10 |+import math # Succeeding comment +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid + +RUF102.py:12:40: RUF102 [*] Invalid rule code in `# noqa`: INVALID123 + | +10 | import math # noqa: INVALID000 # Succeeding comment +11 | # Mixed valid and invalid +12 | from typing import List # noqa: F401, INVALID123 + | ^^^^^^^^^^ RUF102 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | + = help: Remove the rule code + +ℹ Safe fix +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment +11 11 | # Mixed valid and invalid +12 |-from typing import List # noqa: F401, INVALID123 + 12 |+from typing import List # noqa: F401 +13 13 | # Test for multiple invalid +14 14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing + +RUF102.py:14:46: RUF102 [*] Invalid rule code in `# noqa`: INVALID100 + | +12 | from typing import List # noqa: F401, INVALID123 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | ^^^^^^^^^^ RUF102 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | + = help: Remove the rule code + +ℹ Safe fix +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid +14 |-from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + 14 |+from collections import defaultdict # noqa: INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types + +RUF102.py:14:58: RUF102 [*] Invalid rule code in `# noqa`: INVALID200 + | +12 | from typing import List # noqa: F401, INVALID123 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | ^^^^^^^^^^ RUF102 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | + = help: Remove the rule code + +ℹ Safe fix +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid +14 |-from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + 14 |+from collections import defaultdict # noqa: INVALID100, F401 +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types + +RUF102.py:16:44: RUF102 [*] Invalid rule code in `# noqa`: INVALID300 + | +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | ^^^^^^^^^^ RUF102 +17 | # Test for mixed code types +18 | import json # noqa: E402, INVALID400, V100 + | + = help: Remove the rule code + +ℹ Safe fix +13 13 | # Test for multiple invalid +14 14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing +16 |-from itertools import chain # noqa: E402, INVALID300, F401 + 16 |+from itertools import chain # noqa: E402, F401 +17 17 | # Test for mixed code types +18 18 | import json # noqa: E402, INVALID400, V100 + +RUF102.py:18:28: RUF102 [*] Invalid rule code in `# noqa`: INVALID400 + | +16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 | # Test for mixed code types +18 | import json # noqa: E402, INVALID400, V100 + | ^^^^^^^^^^ RUF102 + | + = help: Remove the rule code + +ℹ Safe fix +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types +18 |-import json # noqa: E402, INVALID400, V100 + 18 |+import json # noqa: E402, V100 + +RUF102.py:18:40: RUF102 [*] Invalid rule code in `# noqa`: V100 + | +16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 | # Test for mixed code types +18 | import json # noqa: E402, INVALID400, V100 + | ^^^^ RUF102 + | + = help: Remove the rule code + +ℹ Safe fix +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types +18 |-import json # noqa: E402, INVALID400, V100 + 18 |+import json # noqa: E402, INVALID400 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_bleach.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_bleach.snap index 7d974f8ffe2fc..170a923b43539 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_bleach.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_bleach.snap @@ -1,7 +1,8 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- -pyproject.toml:5:16: RUF200 Failed to parse pyproject.toml: Version specifier `>=1.1.0<1.2` doesn't match PEP 440 rules +pyproject.toml:5:16: RUF200 Failed to parse pyproject.toml: after parsing `1.1.0`, found `<1.2`, which is not part of a valid version tinycss2>=1.1.0<1.2 ^^^^^^^^^^^ | @@ -13,5 +14,3 @@ tinycss2>=1.1.0<1.2 7 | | ] | |_^ RUF200 | - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_invalid_author.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_invalid_author.snap index 5ce87296044dd..da4c911caadfa 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_invalid_author.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_invalid_author.snap @@ -1,13 +1,14 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- -pyproject.toml:6:84: RUF200 Failed to parse pyproject.toml: invalid type: integer `1`, expected a string +pyproject.toml:5:11: RUF200 Failed to parse pyproject.toml: a table with 'name' and/or 'email' keys | -4 | # Ensure that the spans from toml handle utf-8 correctly -5 | authors = [ -6 | { name = "Z͑ͫ̓ͪ̂ͫ̽͏̴̙̤̞͉͚̯̞̠͍A̴̵̜̰͔ͫ͗͢L̠ͨͧͩ͘G̴̻͈͍͔̹̑͗̎̅͛́Ǫ̵̹̻̝̳͂̌̌͘", email = 1 } - | ^ RUF200 -7 | ] +3 | version = "0.1.0" +4 | # Ensure that the spans from toml handle utf-8 correctly +5 | authors = [ + | ___________^ +6 | | { name = "Z͑ͫ̓ͪ̂ͫ̽͏̴̙̤̞͉͚̯̞̠͍A̴̵̜̰͔ͫ͗͢L̠ͨͧͩ͘G̴̻͈͍͔̹̑͗̎̅͛́Ǫ̵̹̻̝̳͂̌̌͘", email = 1 } +7 | | ] + | |_^ RUF200 | - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin_gh_1615.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin_gh_1615.snap deleted file mode 100644 index 8d9104c7ece14..0000000000000 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_maturin_gh_1615.snap +++ /dev/null @@ -1,14 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/ruff/mod.rs ---- -pyproject.toml:9:17: RUF200 Failed to parse pyproject.toml: wanted string or table - | - 7 | [project] - 8 | name = "..." - 9 | license-files = [ "license.txt",] - | ^^^^^^^^^^^^^^^^^ RUF200 -10 | requires-python = ">=3.8" -11 | requires-dist = [ "maturin>=0.14", "...",] - | - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_pep639.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_pep639.snap new file mode 100644 index 0000000000000..7f58cfd7246a3 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_pep639.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- + diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_various_invalid.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_various_invalid.snap new file mode 100644 index 0000000000000..aa79926ea25e7 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF200_various_invalid.snap @@ -0,0 +1,15 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +pyproject.toml:10:16: RUF200 Failed to parse pyproject.toml: URL requirement must be preceded by a package name. Add the name of the package before the URL (e.g., `package_name @ /path/to/file`). +... +^^^ + | + 8 | requires-python = ">=3.8" + 9 | requires-dist = [ "maturin>=0.14", "...",] +10 | dependencies = [ "packaging", "...",] + | ^^^^^^^^^^^^^^^^^^^^^^ RUF200 +11 | zip-safe = false +12 | version = "..." + | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__confusables.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__confusables.snap index 7bbfa68012c1c..f39d03cef4225 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__confusables.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__confusables.snap @@ -39,7 +39,7 @@ confusables.py:26:10: RUF001 String contains ambiguous `α` (GREEK SMALL LETTER 25 | # contains ASCII. 26 | x = "βα Bαd" | ^ RUF001 -27 | +27 | 28 | # The two characters should be flagged here. The first character is a "word" | @@ -49,7 +49,7 @@ confusables.py:31:6: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LET 30 | # boundary" (whitespace) that it itself ambiguous. 31 | x = "Р усский" | ^ RUF001 -32 | +32 | 33 | # Same test cases as above but using f-strings instead: | @@ -59,7 +59,7 @@ confusables.py:31:7: RUF001 String contains ambiguous ` ` (EN QUAD). Did you m 30 | # boundary" (whitespace) that it itself ambiguous. 31 | x = "Р усский" | ^ RUF001 -32 | +32 | 33 | # Same test cases as above but using f-strings instead: | @@ -87,7 +87,7 @@ confusables.py:38:7: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LET 37 | x = f"βα Bαd" 38 | x = f"Р усский" | ^ RUF001 -39 | +39 | 40 | # Nested f-strings | @@ -97,7 +97,7 @@ confusables.py:38:8: RUF001 String contains ambiguous ` ` (EN QUAD). Did you m 37 | x = f"βα Bαd" 38 | x = f"Р усский" | ^ RUF001 -39 | +39 | 40 | # Nested f-strings | @@ -106,7 +106,7 @@ confusables.py:41:7: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -115,7 +115,7 @@ confusables.py:41:21: RUF001 String contains ambiguous ` ` (EN QUAD). Did you 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -124,7 +124,7 @@ confusables.py:41:25: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LE 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -133,7 +133,7 @@ confusables.py:41:26: RUF001 String contains ambiguous ` ` (EN QUAD). Did you 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -160,6 +160,8 @@ confusables.py:58:6: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 57 | # Implicit string concatenation 58 | x = "𝐁ad" f"𝐁ad string" | ^ RUF001 +59 | +60 | from typing import Literal | confusables.py:58:13: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD CAPITAL B). Did you mean `B` (LATIN CAPITAL LETTER B)? @@ -167,4 +169,13 @@ confusables.py:58:13: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 57 | # Implicit string concatenation 58 | x = "𝐁ad" f"𝐁ad string" | ^ RUF001 +59 | +60 | from typing import Literal + | + +confusables.py:61:20: RUF001 String contains ambiguous `ﮨ` (ARABIC LETTER HEH GOAL INITIAL FORM). Did you mean `o` (LATIN SMALL LETTER O)? + | +60 | from typing import Literal +61 | x: '''"""'Literal["ﮨ"]'"""''' + | ^ RUF001 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_1.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_1.snap new file mode 100644 index 0000000000000..d9d8b1e40296b --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_1.snap @@ -0,0 +1,403 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF052.py:92:9: RUF052 [*] Local dummy variable `_var` is accessed + | +90 | class Class_: +91 | def fun(self): +92 | _var = "method variable" # [RUF052] + | ^^^^ RUF052 +93 | return _var + | + = help: Remove leading underscores + +ℹ Unsafe fix +89 89 | +90 90 | class Class_: +91 91 | def fun(self): +92 |- _var = "method variable" # [RUF052] +93 |- return _var + 92 |+ var = "method variable" # [RUF052] + 93 |+ return var +94 94 | +95 95 | def fun(_var): # parameters are ignored +96 96 | return _var + +RUF052.py:99:5: RUF052 [*] Local dummy variable `_list` is accessed + | + 98 | def fun(): + 99 | _list = "built-in" # [RUF052] + | ^^^^^ RUF052 +100 | return _list + | + = help: Prefer using trailing underscores to avoid shadowing a built-in + +ℹ Unsafe fix +96 96 | return _var +97 97 | +98 98 | def fun(): +99 |- _list = "built-in" # [RUF052] +100 |- return _list + 99 |+ list_ = "built-in" # [RUF052] + 100 |+ return list_ +101 101 | +102 102 | x = "global" +103 103 | + +RUF052.py:106:5: RUF052 [*] Local dummy variable `_x` is accessed + | +104 | def fun(): +105 | global x +106 | _x = "shadows global" # [RUF052] + | ^^ RUF052 +107 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +103 103 | +104 104 | def fun(): +105 105 | global x +106 |- _x = "shadows global" # [RUF052] +107 |- return _x + 106 |+ x_ = "shadows global" # [RUF052] + 107 |+ return x_ +108 108 | +109 109 | def foo(): +110 110 | x = "outer" + +RUF052.py:113:5: RUF052 [*] Local dummy variable `_x` is accessed + | +111 | def bar(): +112 | nonlocal x +113 | _x = "shadows nonlocal" # [RUF052] + | ^^ RUF052 +114 | return _x +115 | bar() + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +110 110 | x = "outer" +111 111 | def bar(): +112 112 | nonlocal x +113 |- _x = "shadows nonlocal" # [RUF052] +114 |- return _x + 113 |+ x_ = "shadows nonlocal" # [RUF052] + 114 |+ return x_ +115 115 | bar() +116 116 | return x +117 117 | + +RUF052.py:120:5: RUF052 [*] Local dummy variable `_x` is accessed + | +118 | def fun(): +119 | x = "local" +120 | _x = "shadows local" # [RUF052] + | ^^ RUF052 +121 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +117 117 | +118 118 | def fun(): +119 119 | x = "local" +120 |- _x = "shadows local" # [RUF052] +121 |- return _x + 120 |+ x_ = "shadows local" # [RUF052] + 121 |+ return x_ +122 122 | +123 123 | +124 124 | GLOBAL_1 = "global 1" + +RUF052.py:128:5: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +127 | def unfixables(): +128 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +129 | # unfixable because the rename would shadow a global variable +130 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:136:5: RUF052 Local dummy variable `_local` is accessed + | +135 | # unfixable because the rename would shadow a local variable +136 | _local = "local3" # [RUF052] + | ^^^^^^ RUF052 +137 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:140:9: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +139 | def nested(): +140 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +141 | # unfixable because the rename would shadow a global variable +142 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:145:9: RUF052 Local dummy variable `_local` is accessed + | +144 | # unfixable because the rename would shadow a variable from the outer function +145 | _local = "local4" + | ^^^^^^ RUF052 +146 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:153:5: RUF052 [*] Local dummy variable `_P` is accessed + | +151 | from collections import namedtuple +152 | +153 | _P = ParamSpec("_P") + | ^^ RUF052 +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | + = help: Remove leading underscores + +ℹ Unsafe fix +150 150 | from enum import Enum +151 151 | from collections import namedtuple +152 152 | +153 |- _P = ParamSpec("_P") + 153 |+ P = ParamSpec("P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +-------------------------------------------------------------------------------- +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:154:5: RUF052 [*] Local dummy variable `_T` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) + | ^^ RUF052 +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | + = help: Remove leading underscores + +ℹ Unsafe fix +151 151 | from collections import namedtuple +152 152 | +153 153 | _P = ParamSpec("_P") +154 |- _T = TypeVar(name="_T", covariant=True, bound=int|str) + 154 |+ T = TypeVar(name="T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +-------------------------------------------------------------------------------- +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:155:5: RUF052 [*] Local dummy variable `_NT` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | ^^^ RUF052 +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | + = help: Remove leading underscores + +ℹ Unsafe fix +152 152 | +153 153 | _P = ParamSpec("_P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 |- _NT = NamedTuple("_NT", [("foo", int)]) + 155 |+ NT = NamedTuple("NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:156:5: RUF052 [*] Local dummy variable `_E` is accessed + | +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | ^^ RUF052 +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | + = help: Remove leading underscores + +ℹ Unsafe fix +153 153 | _P = ParamSpec("_P") +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 |- _E = Enum("_E", ["a", "b", "c"]) + 156 |+ E = Enum("E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:157:5: RUF052 [*] Local dummy variable `_NT2` is accessed + | +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | ^^^^ RUF052 +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | + = help: Remove leading underscores + +ℹ Unsafe fix +154 154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 |- _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + 157 |+ NT2 = namedtuple("NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, NT2, _NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:158:5: RUF052 [*] Local dummy variable `_NT3` is accessed + | +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | ^^^^ RUF052 +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +ℹ Unsafe fix +155 155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 |- _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + 158 |+ NT3 = namedtuple(typename="NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, NT3, _DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:159:5: RUF052 [*] Local dummy variable `_DynamicClass` is accessed + | +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | ^^^^^^^^^^^^^ RUF052 +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +ℹ Unsafe fix +156 156 | _E = Enum("_E", ["a", "b", "c"]) +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 |- _DynamicClass = type("_DynamicClass", (), {}) + 159 |+ DynamicClass = type("DynamicClass", (), {}) +160 160 | _NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, _NT3, DynamicClass, _NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:160:5: RUF052 [*] Local dummy variable `_NotADynamicClass` is accessed + | +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | ^^^^^^^^^^^^^^^^^ RUF052 +161 | +162 | print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + | + = help: Remove leading underscores + +ℹ Unsafe fix +157 157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 159 | _DynamicClass = type("_DynamicClass", (), {}) +160 |- _NotADynamicClass = type("_NotADynamicClass") + 160 |+ NotADynamicClass = type("_NotADynamicClass") +161 161 | +162 |- print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + 162 |+ print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, NotADynamicClass) +163 163 | +164 164 | # Do not emit diagnostic if parameter is private +165 165 | # even if it is later shadowed in the body of the function + +RUF052.py:182:5: RUF052 [*] Local dummy variable `_dummy_var` is accessed + | +181 | def foo(): +182 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +183 | +184 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +ℹ Unsafe fix +179 179 | +180 180 | +181 181 | def foo(): +182 |- _dummy_var = 42 + 182 |+ dummy_var_ = 42 +183 183 | +184 184 | def bar(): +185 185 | dummy_var = 43 +186 |- print(_dummy_var) + 186 |+ print(dummy_var_) +187 187 | +188 188 | +189 189 | def foo(): + +RUF052.py:192:5: RUF052 Local dummy variable `_dummy_var` is accessed + | +190 | # Unfixable because both possible candidates for the new name are shadowed +191 | # in the scope of one of the references to the variable +192 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +193 | +194 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_2.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_2.snap new file mode 100644 index 0000000000000..ae071a393dd29 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__custom_dummy_var_regexp_preset__RUF052_RUF052.py_2.snap @@ -0,0 +1,206 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF052.py:92:9: RUF052 Local dummy variable `_var` is accessed + | +90 | class Class_: +91 | def fun(self): +92 | _var = "method variable" # [RUF052] + | ^^^^ RUF052 +93 | return _var + | + = help: Remove leading underscores + +RUF052.py:99:5: RUF052 Local dummy variable `_list` is accessed + | + 98 | def fun(): + 99 | _list = "built-in" # [RUF052] + | ^^^^^ RUF052 +100 | return _list + | + = help: Prefer using trailing underscores to avoid shadowing a built-in + +RUF052.py:106:5: RUF052 Local dummy variable `_x` is accessed + | +104 | def fun(): +105 | global x +106 | _x = "shadows global" # [RUF052] + | ^^ RUF052 +107 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:110:3: RUF052 Local dummy variable `x` is accessed + | +109 | def foo(): +110 | x = "outer" + | ^ RUF052 +111 | def bar(): +112 | nonlocal x + | + +RUF052.py:113:5: RUF052 Local dummy variable `_x` is accessed + | +111 | def bar(): +112 | nonlocal x +113 | _x = "shadows nonlocal" # [RUF052] + | ^^ RUF052 +114 | return _x +115 | bar() + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:120:5: RUF052 Local dummy variable `_x` is accessed + | +118 | def fun(): +119 | x = "local" +120 | _x = "shadows local" # [RUF052] + | ^^ RUF052 +121 | return _x + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:128:5: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +127 | def unfixables(): +128 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +129 | # unfixable because the rename would shadow a global variable +130 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:136:5: RUF052 Local dummy variable `_local` is accessed + | +135 | # unfixable because the rename would shadow a local variable +136 | _local = "local3" # [RUF052] + | ^^^^^^ RUF052 +137 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:140:9: RUF052 Local dummy variable `_GLOBAL_1` is accessed + | +139 | def nested(): +140 | _GLOBAL_1 = "foo" + | ^^^^^^^^^ RUF052 +141 | # unfixable because the rename would shadow a global variable +142 | print(_GLOBAL_1) # [RUF052] + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:145:9: RUF052 Local dummy variable `_local` is accessed + | +144 | # unfixable because the rename would shadow a variable from the outer function +145 | _local = "local4" + | ^^^^^^ RUF052 +146 | print(_local) + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:153:5: RUF052 Local dummy variable `_P` is accessed + | +151 | from collections import namedtuple +152 | +153 | _P = ParamSpec("_P") + | ^^ RUF052 +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | + = help: Remove leading underscores + +RUF052.py:154:5: RUF052 Local dummy variable `_T` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) + | ^^ RUF052 +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | + = help: Remove leading underscores + +RUF052.py:155:5: RUF052 Local dummy variable `_NT` is accessed + | +153 | _P = ParamSpec("_P") +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) + | ^^^ RUF052 +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | + = help: Remove leading underscores + +RUF052.py:156:5: RUF052 Local dummy variable `_E` is accessed + | +154 | _T = TypeVar(name="_T", covariant=True, bound=int|str) +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) + | ^^ RUF052 +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | + = help: Remove leading underscores + +RUF052.py:157:5: RUF052 Local dummy variable `_NT2` is accessed + | +155 | _NT = NamedTuple("_NT", [("foo", int)]) +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) + | ^^^^ RUF052 +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | + = help: Remove leading underscores + +RUF052.py:158:5: RUF052 Local dummy variable `_NT3` is accessed + | +156 | _E = Enum("_E", ["a", "b", "c"]) +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) + | ^^^^ RUF052 +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +RUF052.py:159:5: RUF052 Local dummy variable `_DynamicClass` is accessed + | +157 | _NT2 = namedtuple("_NT2", ['x', 'y', 'z']) +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) + | ^^^^^^^^^^^^^ RUF052 +160 | _NotADynamicClass = type("_NotADynamicClass") + | + = help: Remove leading underscores + +RUF052.py:160:5: RUF052 Local dummy variable `_NotADynamicClass` is accessed + | +158 | _NT3 = namedtuple(typename="_NT3", field_names=['x', 'y', 'z']) +159 | _DynamicClass = type("_DynamicClass", (), {}) +160 | _NotADynamicClass = type("_NotADynamicClass") + | ^^^^^^^^^^^^^^^^^ RUF052 +161 | +162 | print(_T, _P, _NT, _E, _NT2, _NT3, _DynamicClass, _NotADynamicClass) + | + = help: Remove leading underscores + +RUF052.py:182:5: RUF052 Local dummy variable `_dummy_var` is accessed + | +181 | def foo(): +182 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +183 | +184 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable + +RUF052.py:192:5: RUF052 Local dummy variable `_dummy_var` is accessed + | +190 | # Unfixable because both possible candidates for the new name are shadowed +191 | # in the scope of one of the references to the variable +192 | _dummy_var = 42 + | ^^^^^^^^^^ RUF052 +193 | +194 | def bar(): + | + = help: Prefer using trailing underscores to avoid shadowing a variable diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__flake8_noqa.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__flake8_noqa.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__flake8_noqa.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__flake8_noqa.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__invalid_rule_code_external_rules.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__invalid_rule_code_external_rules.snap new file mode 100644 index 0000000000000..2c2e4e88db538 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__invalid_rule_code_external_rules.snap @@ -0,0 +1,182 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF102.py:2:12: RUF102 [*] Invalid rule code in `# noqa`: INVALID123 + | +1 | # Invalid code +2 | import os # noqa: INVALID123 + | ^^^^^^^^^^^^^^^^^^ RUF102 +3 | # External code +4 | import re # noqa: V123 + | + = help: Remove the rule code + +ℹ Safe fix +1 1 | # Invalid code +2 |-import os # noqa: INVALID123 + 2 |+import os +3 3 | # External code +4 4 | import re # noqa: V123 +5 5 | # Valid noqa + +RUF102.py:7:65: RUF102 [*] Invalid rule code in `# noqa`: INVALID456 + | +5 | # Valid noqa +6 | import sys # noqa: E402 +7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 + | ^^^^^^^^^^ RUF102 +8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 | # Succeeding comment + | + = help: Remove the rule code + +ℹ Safe fix +4 4 | import re # noqa: V123 +5 5 | # Valid noqa +6 6 | import sys # noqa: E402 +7 |-from functools import cache # Preceeding comment # noqa: F401, INVALID456 + 7 |+from functools import cache # Preceeding comment # noqa: F401 +8 8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment + +RUF102.py:8:53: RUF102 [*] Invalid rule code in `# noqa`: INVALID789 + | + 6 | import sys # noqa: E402 + 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 + 8 | from itertools import product # Preceeding comment # noqa: INVALID789 + | ^^^^^^^^^^^^^^^^^^ RUF102 + 9 | # Succeeding comment +10 | import math # noqa: INVALID000 # Succeeding comment + | + = help: Remove the rule code + +ℹ Safe fix +5 5 | # Valid noqa +6 6 | import sys # noqa: E402 +7 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 +8 |-from itertools import product # Preceeding comment # noqa: INVALID789 + 8 |+from itertools import product # Preceeding comment +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment +11 11 | # Mixed valid and invalid + +RUF102.py:10:13: RUF102 [*] Invalid rule code in `# noqa`: INVALID000 + | + 8 | from itertools import product # Preceeding comment # noqa: INVALID789 + 9 | # Succeeding comment +10 | import math # noqa: INVALID000 # Succeeding comment + | ^^^^^^^^^^^^^^^^^^ RUF102 +11 | # Mixed valid and invalid +12 | from typing import List # noqa: F401, INVALID123 + | + = help: Remove the rule code + +ℹ Safe fix +7 7 | from functools import cache # Preceeding comment # noqa: F401, INVALID456 +8 8 | from itertools import product # Preceeding comment # noqa: INVALID789 +9 9 | # Succeeding comment +10 |-import math # noqa: INVALID000 # Succeeding comment + 10 |+import math # Succeeding comment +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid + +RUF102.py:12:40: RUF102 [*] Invalid rule code in `# noqa`: INVALID123 + | +10 | import math # noqa: INVALID000 # Succeeding comment +11 | # Mixed valid and invalid +12 | from typing import List # noqa: F401, INVALID123 + | ^^^^^^^^^^ RUF102 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | + = help: Remove the rule code + +ℹ Safe fix +9 9 | # Succeeding comment +10 10 | import math # noqa: INVALID000 # Succeeding comment +11 11 | # Mixed valid and invalid +12 |-from typing import List # noqa: F401, INVALID123 + 12 |+from typing import List # noqa: F401 +13 13 | # Test for multiple invalid +14 14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing + +RUF102.py:14:46: RUF102 [*] Invalid rule code in `# noqa`: INVALID100 + | +12 | from typing import List # noqa: F401, INVALID123 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | ^^^^^^^^^^ RUF102 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | + = help: Remove the rule code + +ℹ Safe fix +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid +14 |-from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + 14 |+from collections import defaultdict # noqa: INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types + +RUF102.py:14:58: RUF102 [*] Invalid rule code in `# noqa`: INVALID200 + | +12 | from typing import List # noqa: F401, INVALID123 +13 | # Test for multiple invalid +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + | ^^^^^^^^^^ RUF102 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | + = help: Remove the rule code + +ℹ Safe fix +11 11 | # Mixed valid and invalid +12 12 | from typing import List # noqa: F401, INVALID123 +13 13 | # Test for multiple invalid +14 |-from collections import defaultdict # noqa: INVALID100, INVALID200, F401 + 14 |+from collections import defaultdict # noqa: INVALID100, F401 +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types + +RUF102.py:16:44: RUF102 [*] Invalid rule code in `# noqa`: INVALID300 + | +14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 | # Test for preserving valid codes when fixing +16 | from itertools import chain # noqa: E402, INVALID300, F401 + | ^^^^^^^^^^ RUF102 +17 | # Test for mixed code types +18 | import json # noqa: E402, INVALID400, V100 + | + = help: Remove the rule code + +ℹ Safe fix +13 13 | # Test for multiple invalid +14 14 | from collections import defaultdict # noqa: INVALID100, INVALID200, F401 +15 15 | # Test for preserving valid codes when fixing +16 |-from itertools import chain # noqa: E402, INVALID300, F401 + 16 |+from itertools import chain # noqa: E402, F401 +17 17 | # Test for mixed code types +18 18 | import json # noqa: E402, INVALID400, V100 + +RUF102.py:18:28: RUF102 [*] Invalid rule code in `# noqa`: INVALID400 + | +16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 | # Test for mixed code types +18 | import json # noqa: E402, INVALID400, V100 + | ^^^^^^^^^^ RUF102 + | + = help: Remove the rule code + +ℹ Safe fix +15 15 | # Test for preserving valid codes when fixing +16 16 | from itertools import chain # noqa: E402, INVALID300, F401 +17 17 | # Test for mixed code types +18 |-import json # noqa: E402, INVALID400, V100 + 18 |+import json # noqa: E402, V100 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__no_remove_parentheses_starred_expr_py310.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__no_remove_parentheses_starred_expr_py310.snap index 4dbad809a6b3d..8fee3cc35a9f9 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__no_remove_parentheses_starred_expr_py310.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__no_remove_parentheses_starred_expr_py310.snap @@ -1,7 +1,8 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- -RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} 2 | d[(1,2)] @@ -9,7 +10,7 @@ RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 3 | d[( 4 | 1, | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 1 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} @@ -19,7 +20,7 @@ RUF031.py:2:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 4 4 | 1, 5 5 | 2 -RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} 2 | d[(1,2)] @@ -32,7 +33,7 @@ RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 7 | d[ 8 | 1, | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 1 1 | d = {(1,2):"a",(3,4):"b",(5,6,7):"c",(8,):"d"} @@ -47,7 +48,7 @@ RUF031.py:3:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 8 8 | 1, 9 9 | 2 -RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 9 | 2 10 | ] @@ -56,7 +57,7 @@ RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 12 | d[(5,6,7)] 13 | d[(8,)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 8 8 | 1, @@ -68,7 +69,7 @@ RUF031.py:11:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 13 13 | d[(8,)] 14 14 | d[tuple(1,2)] -RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 10 | ] 11 | d[(2,4)] @@ -77,7 +78,7 @@ RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 13 | d[(8,)] 14 | d[tuple(1,2)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 9 9 | 2 @@ -89,7 +90,7 @@ RUF031.py:12:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 14 14 | d[tuple(1,2)] 15 15 | d[tuple(8)] -RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 11 | d[(2,4)] 12 | d[(5,6,7)] @@ -98,7 +99,7 @@ RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 14 | d[tuple(1,2)] 15 | d[tuple(8)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 10 10 | ] @@ -110,7 +111,7 @@ RUF031.py:13:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 15 15 | d[tuple(8)] 16 16 | d[1,2] -RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 18 | d[5,6,7] 19 | e = {((1,2),(3,4)):"a"} @@ -118,7 +119,7 @@ RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. | ^^^^^^^^^^^^^ RUF031 21 | e[(1,2),(3,4)] | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 17 17 | d[3,4] @@ -131,14 +132,14 @@ RUF031.py:20:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 23 23 | token_features[ 24 24 | (window_position, feature_name) -RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts | 23 | token_features[ 24 | (window_position, feature_name) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF031 25 | ] = self._extract_raw_features_from_token | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 21 21 | e[(1,2),(3,4)] @@ -150,7 +151,7 @@ RUF031.py:24:5: RUF031 [*] Avoid parentheses for tuples in subscripts. 26 26 | 27 27 | d[1,] -RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts. +RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts | 27 | d[1,] 28 | d[(1,)] @@ -158,7 +159,7 @@ RUF031.py:28:3: RUF031 [*] Avoid parentheses for tuples in subscripts. 29 | d[()] # empty tuples should be ignored 30 | d[:,] # slices in the subscript lead to syntax error if parens are added | - = help: Remove the parentheses. + = help: Remove parentheses ℹ Safe fix 25 25 | ] = self._extract_raw_features_from_token diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__noqa.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__noqa.snap index 6736a8f1c5020..e56c55ecce86a 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__noqa.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__noqa.snap @@ -1,20 +1,26 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -noqa.py:23:5: F841 [*] Local variable `I` is assigned to but never used +noqa.py:24:5: E741 Ambiguous variable name: `I` | -21 | def f(): -22 | # Only `E741` should be ignored by the `noqa`. -23 | I = 1 # noqa: E741.F841 +22 | # Neither of these are ignored and warning is +23 | # logged to user +24 | I = 1 # noqa: E741.F841 + | ^ E741 + | + +noqa.py:24:5: F841 [*] Local variable `I` is assigned to but never used + | +22 | # Neither of these are ignored and warning is +23 | # logged to user +24 | I = 1 # noqa: E741.F841 | ^ F841 | = help: Remove assignment to unused variable `I` ℹ Unsafe fix -20 20 | 21 21 | def f(): -22 22 | # Only `E741` should be ignored by the `noqa`. -23 |- I = 1 # noqa: E741.F841 - 23 |+ pass # noqa: E741.F841 - - +22 22 | # Neither of these are ignored and warning is +23 23 | # logged to user +24 |- I = 1 # noqa: E741.F841 + 24 |+ pass # noqa: E741.F841 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__prefer_parentheses_getitem_tuple.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__prefer_parentheses_getitem_tuple.snap index 9af8d5e20bb47..3ea279c548de9 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__prefer_parentheses_getitem_tuple.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__prefer_parentheses_getitem_tuple.snap @@ -1,18 +1,17 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs --- -RUF031_prefer_parens.py:8:5: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:8:5: RUF031 [*] Use parentheses for tuples in subscripts | 6 | )] 7 | d[ - 8 | 1, - | _____^ + 8 | / 1, 9 | | 2 | |_____^ RUF031 10 | ] 11 | d[(2,4)] | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 5 5 | 2 @@ -26,7 +25,7 @@ RUF031_prefer_parens.py:8:5: RUF031 [*] Use parentheses for tuples in subscripts 11 11 | d[(2,4)] 12 12 | d[(5,6,7)] -RUF031_prefer_parens.py:16:3: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:16:3: RUF031 [*] Use parentheses for tuples in subscripts | 14 | d[tuple(1,2)] 15 | d[tuple(8)] @@ -35,7 +34,7 @@ RUF031_prefer_parens.py:16:3: RUF031 [*] Use parentheses for tuples in subscript 17 | d[3,4] 18 | d[5,6,7] | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 13 13 | d[(8,)] @@ -47,7 +46,7 @@ RUF031_prefer_parens.py:16:3: RUF031 [*] Use parentheses for tuples in subscript 18 18 | d[5,6,7] 19 19 | e = {((1,2),(3,4)):"a"} -RUF031_prefer_parens.py:17:3: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:17:3: RUF031 [*] Use parentheses for tuples in subscripts | 15 | d[tuple(8)] 16 | d[1,2] @@ -56,7 +55,7 @@ RUF031_prefer_parens.py:17:3: RUF031 [*] Use parentheses for tuples in subscript 18 | d[5,6,7] 19 | e = {((1,2),(3,4)):"a"} | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 14 14 | d[tuple(1,2)] @@ -68,7 +67,7 @@ RUF031_prefer_parens.py:17:3: RUF031 [*] Use parentheses for tuples in subscript 19 19 | e = {((1,2),(3,4)):"a"} 20 20 | e[((1,2),(3,4))] -RUF031_prefer_parens.py:18:3: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:18:3: RUF031 [*] Use parentheses for tuples in subscripts | 16 | d[1,2] 17 | d[3,4] @@ -77,7 +76,7 @@ RUF031_prefer_parens.py:18:3: RUF031 [*] Use parentheses for tuples in subscript 19 | e = {((1,2),(3,4)):"a"} 20 | e[((1,2),(3,4))] | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 15 15 | d[tuple(8)] @@ -89,16 +88,16 @@ RUF031_prefer_parens.py:18:3: RUF031 [*] Use parentheses for tuples in subscript 20 20 | e[((1,2),(3,4))] 21 21 | e[(1,2),(3,4)] -RUF031_prefer_parens.py:21:3: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:21:3: RUF031 [*] Use parentheses for tuples in subscripts | 19 | e = {((1,2),(3,4)):"a"} 20 | e[((1,2),(3,4))] 21 | e[(1,2),(3,4)] | ^^^^^^^^^^^ RUF031 -22 | +22 | 23 | token_features[ | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 18 18 | d[5,6,7] @@ -110,7 +109,7 @@ RUF031_prefer_parens.py:21:3: RUF031 [*] Use parentheses for tuples in subscript 23 23 | token_features[ 24 24 | (window_position, feature_name) -RUF031_prefer_parens.py:26:3: RUF031 [*] Use parentheses for tuples in subscripts. +RUF031_prefer_parens.py:26:3: RUF031 [*] Use parentheses for tuples in subscripts | 24 | (window_position, feature_name) 25 | ] = self._extract_raw_features_from_token @@ -119,7 +118,7 @@ RUF031_prefer_parens.py:26:3: RUF031 [*] Use parentheses for tuples in subscript 27 | d[(1,)] 28 | d[()] # empty tuples should be ignored | - = help: Parenthesize the tuple. + = help: Parenthesize tuple ℹ Safe fix 23 23 | token_features[ diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF005_RUF005_slices.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF005_RUF005_slices.py.snap new file mode 100644 index 0000000000000..25a182d790297 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF005_RUF005_slices.py.snap @@ -0,0 +1,78 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF005_slices.py:2:7: RUF005 [*] Consider `[1, 2, 3, *foo]` instead of concatenation + | +1 | foo = [4, 5, 6] +2 | bar = [1, 2, 3] + foo + | ^^^^^^^^^^^^^^^ RUF005 +3 | slicing1 = foo[:1] + [7, 8, 9] +4 | slicing2 = [7, 8, 9] + bar[1:] + | + = help: Replace with `[1, 2, 3, *foo]` + +ℹ Unsafe fix +1 1 | foo = [4, 5, 6] +2 |-bar = [1, 2, 3] + foo + 2 |+bar = [1, 2, 3, *foo] +3 3 | slicing1 = foo[:1] + [7, 8, 9] +4 4 | slicing2 = [7, 8, 9] + bar[1:] +5 5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] + +RUF005_slices.py:3:12: RUF005 [*] Consider `[*foo[:1], 7, 8, 9]` instead of concatenation + | +1 | foo = [4, 5, 6] +2 | bar = [1, 2, 3] + foo +3 | slicing1 = foo[:1] + [7, 8, 9] + | ^^^^^^^^^^^^^^^^^^^ RUF005 +4 | slicing2 = [7, 8, 9] + bar[1:] +5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] + | + = help: Replace with `[*foo[:1], 7, 8, 9]` + +ℹ Unsafe fix +1 1 | foo = [4, 5, 6] +2 2 | bar = [1, 2, 3] + foo +3 |-slicing1 = foo[:1] + [7, 8, 9] + 3 |+slicing1 = [*foo[:1], 7, 8, 9] +4 4 | slicing2 = [7, 8, 9] + bar[1:] +5 5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] +6 6 | indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. + +RUF005_slices.py:4:12: RUF005 [*] Consider `[7, 8, 9, *bar[1:]]` instead of concatenation + | +2 | bar = [1, 2, 3] + foo +3 | slicing1 = foo[:1] + [7, 8, 9] +4 | slicing2 = [7, 8, 9] + bar[1:] + | ^^^^^^^^^^^^^^^^^^^ RUF005 +5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] +6 | indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. + | + = help: Replace with `[7, 8, 9, *bar[1:]]` + +ℹ Unsafe fix +1 1 | foo = [4, 5, 6] +2 2 | bar = [1, 2, 3] + foo +3 3 | slicing1 = foo[:1] + [7, 8, 9] +4 |-slicing2 = [7, 8, 9] + bar[1:] + 4 |+slicing2 = [7, 8, 9, *bar[1:]] +5 5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] +6 6 | indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. + +RUF005_slices.py:5:12: RUF005 [*] Consider `[*foo[:1], 7, 8, 9, *bar[1:]]` instead of concatenation + | +3 | slicing1 = foo[:1] + [7, 8, 9] +4 | slicing2 = [7, 8, 9] + bar[1:] +5 | slicing3 = foo[:1] + [7, 8, 9] + bar[1:] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF005 +6 | indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. + | + = help: Replace with `[*foo[:1], 7, 8, 9, *bar[1:]]` + +ℹ Unsafe fix +2 2 | bar = [1, 2, 3] + foo +3 3 | slicing1 = foo[:1] + [7, 8, 9] +4 4 | slicing2 = [7, 8, 9] + bar[1:] +5 |-slicing3 = foo[:1] + [7, 8, 9] + bar[1:] + 5 |+slicing3 = [*foo[:1], 7, 8, 9, *bar[1:]] +6 6 | indexing = foo[0] + [7, 8, 9] + bar[1] # Not changed; looks a little suspect for concatenation. diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF007_RUF007.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF007_RUF007.py.snap deleted file mode 100644 index b12828b3ac84f..0000000000000 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF007_RUF007.py.snap +++ /dev/null @@ -1,252 +0,0 @@ ---- -source: crates/ruff_linter/src/rules/ruff/mod.rs ---- -RUF007.py:16:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -15 | # Errors -16 | zip(input, input[1:]) - | ^^^ RUF007 -17 | zip(input, input[1::1]) -18 | zip(input[:-1], input[1:]) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -13 14 | zip(foo[:-1], foo[1:], foo, strict=True) # more than 2 inputs -14 15 | -15 16 | # Errors -16 |-zip(input, input[1:]) - 17 |+itertools.pairwise(input) -17 18 | zip(input, input[1::1]) -18 19 | zip(input[:-1], input[1:]) -19 20 | zip(input[1:], input[2:]) - -RUF007.py:17:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -15 | # Errors -16 | zip(input, input[1:]) -17 | zip(input, input[1::1]) - | ^^^ RUF007 -18 | zip(input[:-1], input[1:]) -19 | zip(input[1:], input[2:]) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -14 15 | -15 16 | # Errors -16 17 | zip(input, input[1:]) -17 |-zip(input, input[1::1]) - 18 |+itertools.pairwise(input) -18 19 | zip(input[:-1], input[1:]) -19 20 | zip(input[1:], input[2:]) -20 21 | zip(input[1:-1], input[2:]) - -RUF007.py:18:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -16 | zip(input, input[1:]) -17 | zip(input, input[1::1]) -18 | zip(input[:-1], input[1:]) - | ^^^ RUF007 -19 | zip(input[1:], input[2:]) -20 | zip(input[1:-1], input[2:]) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -15 16 | # Errors -16 17 | zip(input, input[1:]) -17 18 | zip(input, input[1::1]) -18 |-zip(input[:-1], input[1:]) - 19 |+itertools.pairwise(input) -19 20 | zip(input[1:], input[2:]) -20 21 | zip(input[1:-1], input[2:]) -21 22 | list(zip(input, input[1:])) - -RUF007.py:19:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -17 | zip(input, input[1::1]) -18 | zip(input[:-1], input[1:]) -19 | zip(input[1:], input[2:]) - | ^^^ RUF007 -20 | zip(input[1:-1], input[2:]) -21 | list(zip(input, input[1:])) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -16 17 | zip(input, input[1:]) -17 18 | zip(input, input[1::1]) -18 19 | zip(input[:-1], input[1:]) -19 |-zip(input[1:], input[2:]) - 20 |+itertools.pairwise(input) -20 21 | zip(input[1:-1], input[2:]) -21 22 | list(zip(input, input[1:])) -22 23 | list(zip(input[:-1], input[1:])) - -RUF007.py:20:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -18 | zip(input[:-1], input[1:]) -19 | zip(input[1:], input[2:]) -20 | zip(input[1:-1], input[2:]) - | ^^^ RUF007 -21 | list(zip(input, input[1:])) -22 | list(zip(input[:-1], input[1:])) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -17 18 | zip(input, input[1::1]) -18 19 | zip(input[:-1], input[1:]) -19 20 | zip(input[1:], input[2:]) -20 |-zip(input[1:-1], input[2:]) - 21 |+itertools.pairwise(input) -21 22 | list(zip(input, input[1:])) -22 23 | list(zip(input[:-1], input[1:])) -23 24 | zip(foo[:-1], foo[1:], strict=True) - -RUF007.py:21:6: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -19 | zip(input[1:], input[2:]) -20 | zip(input[1:-1], input[2:]) -21 | list(zip(input, input[1:])) - | ^^^ RUF007 -22 | list(zip(input[:-1], input[1:])) -23 | zip(foo[:-1], foo[1:], strict=True) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -18 19 | zip(input[:-1], input[1:]) -19 20 | zip(input[1:], input[2:]) -20 21 | zip(input[1:-1], input[2:]) -21 |-list(zip(input, input[1:])) - 22 |+list(itertools.pairwise(input)) -22 23 | list(zip(input[:-1], input[1:])) -23 24 | zip(foo[:-1], foo[1:], strict=True) -24 25 | zip(foo[:-1], foo[1:], strict=False) - -RUF007.py:22:6: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -20 | zip(input[1:-1], input[2:]) -21 | list(zip(input, input[1:])) -22 | list(zip(input[:-1], input[1:])) - | ^^^ RUF007 -23 | zip(foo[:-1], foo[1:], strict=True) -24 | zip(foo[:-1], foo[1:], strict=False) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -19 20 | zip(input[1:], input[2:]) -20 21 | zip(input[1:-1], input[2:]) -21 22 | list(zip(input, input[1:])) -22 |-list(zip(input[:-1], input[1:])) - 23 |+list(itertools.pairwise(input)) -23 24 | zip(foo[:-1], foo[1:], strict=True) -24 25 | zip(foo[:-1], foo[1:], strict=False) -25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) - -RUF007.py:23:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -21 | list(zip(input, input[1:])) -22 | list(zip(input[:-1], input[1:])) -23 | zip(foo[:-1], foo[1:], strict=True) - | ^^^ RUF007 -24 | zip(foo[:-1], foo[1:], strict=False) -25 | zip(foo[:-1], foo[1:], strict=bool(foo)) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -20 21 | zip(input[1:-1], input[2:]) -21 22 | list(zip(input, input[1:])) -22 23 | list(zip(input[:-1], input[1:])) -23 |-zip(foo[:-1], foo[1:], strict=True) - 24 |+itertools.pairwise(foo) -24 25 | zip(foo[:-1], foo[1:], strict=False) -25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) - -RUF007.py:24:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -22 | list(zip(input[:-1], input[1:])) -23 | zip(foo[:-1], foo[1:], strict=True) -24 | zip(foo[:-1], foo[1:], strict=False) - | ^^^ RUF007 -25 | zip(foo[:-1], foo[1:], strict=bool(foo)) - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -21 22 | list(zip(input, input[1:])) -22 23 | list(zip(input[:-1], input[1:])) -23 24 | zip(foo[:-1], foo[1:], strict=True) -24 |-zip(foo[:-1], foo[1:], strict=False) - 25 |+itertools.pairwise(foo) -25 26 | zip(foo[:-1], foo[1:], strict=bool(foo)) - -RUF007.py:25:1: RUF007 [*] Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs - | -23 | zip(foo[:-1], foo[1:], strict=True) -24 | zip(foo[:-1], foo[1:], strict=False) -25 | zip(foo[:-1], foo[1:], strict=bool(foo)) - | ^^^ RUF007 - | - = help: Replace `zip()` with `itertools.pairwise()` - -ℹ Unsafe fix - 1 |+import itertools -1 2 | input = [1, 2, 3] -2 3 | otherInput = [2, 3, 4] -3 4 | foo = [1, 2, 3, 4] --------------------------------------------------------------------------------- -22 23 | list(zip(input[:-1], input[1:])) -23 24 | zip(foo[:-1], foo[1:], strict=True) -24 25 | zip(foo[:-1], foo[1:], strict=False) -25 |-zip(foo[:-1], foo[1:], strict=bool(foo)) - 26 |+itertools.pairwise(foo) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039.py.snap new file mode 100644 index 0000000000000..4573c15be2319 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039.py.snap @@ -0,0 +1,280 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF039.py:5:12: RUF039 [*] First argument to `re.compile()` is not raw string + | +4 | # Errors +5 | re.compile('single free-spacing', flags=re.X) + | ^^^^^^^^^^^^^^^^^^^^^ RUF039 +6 | re.findall('si\ngle') +7 | re.finditer("dou\ble") + | + = help: Replace with raw string + +ℹ Safe fix +2 2 | import regex +3 3 | +4 4 | # Errors +5 |-re.compile('single free-spacing', flags=re.X) + 5 |+re.compile(r'single free-spacing', flags=re.X) +6 6 | re.findall('si\ngle') +7 7 | re.finditer("dou\ble") +8 8 | re.fullmatch('''t\riple single''') + +RUF039.py:6:12: RUF039 First argument to `re.findall()` is not raw string + | +4 | # Errors +5 | re.compile('single free-spacing', flags=re.X) +6 | re.findall('si\ngle') + | ^^^^^^^^^ RUF039 +7 | re.finditer("dou\ble") +8 | re.fullmatch('''t\riple single''') + | + = help: Replace with raw string + +RUF039.py:7:13: RUF039 First argument to `re.finditer()` is not raw string + | +5 | re.compile('single free-spacing', flags=re.X) +6 | re.findall('si\ngle') +7 | re.finditer("dou\ble") + | ^^^^^^^^^ RUF039 +8 | re.fullmatch('''t\riple single''') +9 | re.match("""\triple double""") + | + = help: Replace with raw string + +RUF039.py:8:14: RUF039 First argument to `re.fullmatch()` is not raw string + | + 6 | re.findall('si\ngle') + 7 | re.finditer("dou\ble") + 8 | re.fullmatch('''t\riple single''') + | ^^^^^^^^^^^^^^^^^^^^ RUF039 + 9 | re.match("""\triple double""") +10 | re.search('two', 'args') + | + = help: Replace with raw string + +RUF039.py:9:10: RUF039 First argument to `re.match()` is not raw string + | + 7 | re.finditer("dou\ble") + 8 | re.fullmatch('''t\riple single''') + 9 | re.match("""\triple double""") + | ^^^^^^^^^^^^^^^^^^^^ RUF039 +10 | re.search('two', 'args') +11 | re.split("raw", r'second') + | + = help: Replace with raw string + +RUF039.py:10:11: RUF039 [*] First argument to `re.search()` is not raw string + | + 8 | re.fullmatch('''t\riple single''') + 9 | re.match("""\triple double""") +10 | re.search('two', 'args') + | ^^^^^ RUF039 +11 | re.split("raw", r'second') +12 | re.sub(u'''nicode''', u"f(?i)rst") + | + = help: Replace with raw string + +ℹ Safe fix +7 7 | re.finditer("dou\ble") +8 8 | re.fullmatch('''t\riple single''') +9 9 | re.match("""\triple double""") +10 |-re.search('two', 'args') + 10 |+re.search(r'two', 'args') +11 11 | re.split("raw", r'second') +12 12 | re.sub(u'''nicode''', u"f(?i)rst") +13 13 | re.subn(b"""ytes are""", f"\u006e") + +RUF039.py:11:10: RUF039 [*] First argument to `re.split()` is not raw string + | + 9 | re.match("""\triple double""") +10 | re.search('two', 'args') +11 | re.split("raw", r'second') + | ^^^^^ RUF039 +12 | re.sub(u'''nicode''', u"f(?i)rst") +13 | re.subn(b"""ytes are""", f"\u006e") + | + = help: Replace with raw string + +ℹ Safe fix +8 8 | re.fullmatch('''t\riple single''') +9 9 | re.match("""\triple double""") +10 10 | re.search('two', 'args') +11 |-re.split("raw", r'second') + 11 |+re.split(r"raw", r'second') +12 12 | re.sub(u'''nicode''', u"f(?i)rst") +13 13 | re.subn(b"""ytes are""", f"\u006e") +14 14 | + +RUF039.py:12:8: RUF039 First argument to `re.sub()` is not raw string + | +10 | re.search('two', 'args') +11 | re.split("raw", r'second') +12 | re.sub(u'''nicode''', u"f(?i)rst") + | ^^^^^^^^^^^^^ RUF039 +13 | re.subn(b"""ytes are""", f"\u006e") + | + = help: Replace with raw string + +RUF039.py:13:9: RUF039 First argument to `re.subn()` is not raw bytes literal + | +11 | re.split("raw", r'second') +12 | re.sub(u'''nicode''', u"f(?i)rst") +13 | re.subn(b"""ytes are""", f"\u006e") + | ^^^^^^^^^^^^^^^ RUF039 +14 | +15 | regex.compile('single free-spacing', flags=regex.X) + | + = help: Replace with raw bytes literal + +RUF039.py:15:15: RUF039 [*] First argument to `regex.compile()` is not raw string + | +13 | re.subn(b"""ytes are""", f"\u006e") +14 | +15 | regex.compile('single free-spacing', flags=regex.X) + | ^^^^^^^^^^^^^^^^^^^^^ RUF039 +16 | regex.findall('si\ngle') +17 | regex.finditer("dou\ble") + | + = help: Replace with raw string + +ℹ Safe fix +12 12 | re.sub(u'''nicode''', u"f(?i)rst") +13 13 | re.subn(b"""ytes are""", f"\u006e") +14 14 | +15 |-regex.compile('single free-spacing', flags=regex.X) + 15 |+regex.compile(r'single free-spacing', flags=regex.X) +16 16 | regex.findall('si\ngle') +17 17 | regex.finditer("dou\ble") +18 18 | regex.fullmatch('''t\riple single''') + +RUF039.py:16:15: RUF039 First argument to `regex.findall()` is not raw string + | +15 | regex.compile('single free-spacing', flags=regex.X) +16 | regex.findall('si\ngle') + | ^^^^^^^^^ RUF039 +17 | regex.finditer("dou\ble") +18 | regex.fullmatch('''t\riple single''') + | + = help: Replace with raw string + +RUF039.py:17:16: RUF039 First argument to `regex.finditer()` is not raw string + | +15 | regex.compile('single free-spacing', flags=regex.X) +16 | regex.findall('si\ngle') +17 | regex.finditer("dou\ble") + | ^^^^^^^^^ RUF039 +18 | regex.fullmatch('''t\riple single''') +19 | regex.match("""\triple double""") + | + = help: Replace with raw string + +RUF039.py:18:17: RUF039 First argument to `regex.fullmatch()` is not raw string + | +16 | regex.findall('si\ngle') +17 | regex.finditer("dou\ble") +18 | regex.fullmatch('''t\riple single''') + | ^^^^^^^^^^^^^^^^^^^^ RUF039 +19 | regex.match("""\triple double""") +20 | regex.search('two', 'args') + | + = help: Replace with raw string + +RUF039.py:19:13: RUF039 First argument to `regex.match()` is not raw string + | +17 | regex.finditer("dou\ble") +18 | regex.fullmatch('''t\riple single''') +19 | regex.match("""\triple double""") + | ^^^^^^^^^^^^^^^^^^^^ RUF039 +20 | regex.search('two', 'args') +21 | regex.split("raw", r'second') + | + = help: Replace with raw string + +RUF039.py:20:14: RUF039 [*] First argument to `regex.search()` is not raw string + | +18 | regex.fullmatch('''t\riple single''') +19 | regex.match("""\triple double""") +20 | regex.search('two', 'args') + | ^^^^^ RUF039 +21 | regex.split("raw", r'second') +22 | regex.sub(u'''nicode''', u"f(?i)rst") + | + = help: Replace with raw string + +ℹ Safe fix +17 17 | regex.finditer("dou\ble") +18 18 | regex.fullmatch('''t\riple single''') +19 19 | regex.match("""\triple double""") +20 |-regex.search('two', 'args') + 20 |+regex.search(r'two', 'args') +21 21 | regex.split("raw", r'second') +22 22 | regex.sub(u'''nicode''', u"f(?i)rst") +23 23 | regex.subn(b"""ytes are""", f"\u006e") + +RUF039.py:21:13: RUF039 [*] First argument to `regex.split()` is not raw string + | +19 | regex.match("""\triple double""") +20 | regex.search('two', 'args') +21 | regex.split("raw", r'second') + | ^^^^^ RUF039 +22 | regex.sub(u'''nicode''', u"f(?i)rst") +23 | regex.subn(b"""ytes are""", f"\u006e") + | + = help: Replace with raw string + +ℹ Safe fix +18 18 | regex.fullmatch('''t\riple single''') +19 19 | regex.match("""\triple double""") +20 20 | regex.search('two', 'args') +21 |-regex.split("raw", r'second') + 21 |+regex.split(r"raw", r'second') +22 22 | regex.sub(u'''nicode''', u"f(?i)rst") +23 23 | regex.subn(b"""ytes are""", f"\u006e") +24 24 | + +RUF039.py:22:11: RUF039 First argument to `regex.sub()` is not raw string + | +20 | regex.search('two', 'args') +21 | regex.split("raw", r'second') +22 | regex.sub(u'''nicode''', u"f(?i)rst") + | ^^^^^^^^^^^^^ RUF039 +23 | regex.subn(b"""ytes are""", f"\u006e") + | + = help: Replace with raw string + +RUF039.py:23:12: RUF039 First argument to `regex.subn()` is not raw bytes literal + | +21 | regex.split("raw", r'second') +22 | regex.sub(u'''nicode''', u"f(?i)rst") +23 | regex.subn(b"""ytes are""", f"\u006e") + | ^^^^^^^^^^^^^^^ RUF039 +24 | +25 | regex.template("""(?m) + | + = help: Replace with raw bytes literal + +RUF039.py:25:16: RUF039 [*] First argument to `regex.template()` is not raw string + | +23 | regex.subn(b"""ytes are""", f"\u006e") +24 | +25 | regex.template("""(?m) + | ________________^ +26 | | (?:ulti)? +27 | | (?=(?<!(?<=(?!l))) +28 | | l(?i:ne) +29 | | """, flags = regex.X) + | |___^ RUF039 + | + = help: Replace with raw string + +ℹ Safe fix +22 22 | regex.sub(u'''nicode''', u"f(?i)rst") +23 23 | regex.subn(b"""ytes are""", f"\u006e") +24 24 | +25 |-regex.template("""(?m) + 25 |+regex.template(r"""(?m) +26 26 | (?:ulti)? +27 27 | (?=(?<!(?<=(?!l))) +28 28 | l(?i:ne) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039_concat.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039_concat.py.snap new file mode 100644 index 0000000000000..77e805efd512c --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF039_RUF039_concat.py.snap @@ -0,0 +1,462 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF039_concat.py:5:5: RUF039 [*] First argument to `re.compile()` is not raw string + | +4 | re.compile( +5 | 'implicit' + | ^^^^^^^^^^ RUF039 +6 | 'concatenation' +7 | ) + | + = help: Replace with raw string + +ℹ Safe fix +2 2 | +3 3 | +4 4 | re.compile( +5 |- 'implicit' + 5 |+ r'implicit' +6 6 | 'concatenation' +7 7 | ) +8 8 | re.findall( + +RUF039_concat.py:6:5: RUF039 [*] First argument to `re.compile()` is not raw string + | +4 | re.compile( +5 | 'implicit' +6 | 'concatenation' + | ^^^^^^^^^^^^^^^ RUF039 +7 | ) +8 | re.findall( + | + = help: Replace with raw string + +ℹ Safe fix +3 3 | +4 4 | re.compile( +5 5 | 'implicit' +6 |- 'concatenation' + 6 |+ r'concatenation' +7 7 | ) +8 8 | re.findall( +9 9 | r''' + +RUF039_concat.py:12:5: RUF039 [*] First argument to `re.findall()` is not raw string + | +10 | multiline +11 | ''' +12 | / """ +13 | | concatenation +14 | | """ + | |_______^ RUF039 +15 | ) +16 | re.finditer( + | + = help: Replace with raw string + +ℹ Safe fix +9 9 | r''' +10 10 | multiline +11 11 | ''' +12 |- """ + 12 |+ r""" +13 13 | concatenation +14 14 | """ +15 15 | ) + +RUF039_concat.py:26:5: RUF039 First argument to `re.match()` is not raw bytes literal + | +24 | ) +25 | re.match( +26 | b'reak' + | ^^^^^^^ RUF039 +27 | br'eak' +28 | ) + | + = help: Replace with raw bytes literal + +RUF039_concat.py:30:8: RUF039 First argument to `re.search()` is not raw string + | +28 | ) +29 | re.search( +30 | r''u'' + | ^^^ RUF039 +31 | '''okay?''' +32 | ) + | + = help: Replace with raw string + +RUF039_concat.py:31:5: RUF039 [*] First argument to `re.search()` is not raw string + | +29 | re.search( +30 | r''u'' +31 | '''okay?''' + | ^^^^^^^^^^^ RUF039 +32 | ) +33 | re.split(''U"""w"""U'') + | + = help: Replace with raw string + +ℹ Safe fix +28 28 | ) +29 29 | re.search( +30 30 | r''u'' +31 |- '''okay?''' + 31 |+ r'''okay?''' +32 32 | ) +33 33 | re.split(''U"""w"""U'') +34 34 | re.sub( + +RUF039_concat.py:33:10: RUF039 [*] First argument to `re.split()` is not raw string + | +31 | '''okay?''' +32 | ) +33 | re.split(''U"""w"""U'') + | ^^ RUF039 +34 | re.sub( +35 | "I''m o" + | + = help: Replace with raw string + +ℹ Safe fix +30 30 | r''u'' +31 31 | '''okay?''' +32 32 | ) +33 |-re.split(''U"""w"""U'') + 33 |+re.split(r''U"""w"""U'') +34 34 | re.sub( +35 35 | "I''m o" +36 36 | 'utta ideas' + +RUF039_concat.py:33:12: RUF039 First argument to `re.split()` is not raw string + | +31 | '''okay?''' +32 | ) +33 | re.split(''U"""w"""U'') + | ^^^^^^^^ RUF039 +34 | re.sub( +35 | "I''m o" + | + = help: Replace with raw string + +RUF039_concat.py:33:20: RUF039 First argument to `re.split()` is not raw string + | +31 | '''okay?''' +32 | ) +33 | re.split(''U"""w"""U'') + | ^^^ RUF039 +34 | re.sub( +35 | "I''m o" + | + = help: Replace with raw string + +RUF039_concat.py:35:5: RUF039 [*] First argument to `re.sub()` is not raw string + | +33 | re.split(''U"""w"""U'') +34 | re.sub( +35 | "I''m o" + | ^^^^^^^^ RUF039 +36 | 'utta ideas' +37 | ) + | + = help: Replace with raw string + +ℹ Safe fix +32 32 | ) +33 33 | re.split(''U"""w"""U'') +34 34 | re.sub( +35 |- "I''m o" + 35 |+ r"I''m o" +36 36 | 'utta ideas' +37 37 | ) +38 38 | re.subn("()"r' am I'"??") + +RUF039_concat.py:36:5: RUF039 [*] First argument to `re.sub()` is not raw string + | +34 | re.sub( +35 | "I''m o" +36 | 'utta ideas' + | ^^^^^^^^^^^^ RUF039 +37 | ) +38 | re.subn("()"r' am I'"??") + | + = help: Replace with raw string + +ℹ Safe fix +33 33 | re.split(''U"""w"""U'') +34 34 | re.sub( +35 35 | "I''m o" +36 |- 'utta ideas' + 36 |+ r'utta ideas' +37 37 | ) +38 38 | re.subn("()"r' am I'"??") +39 39 | + +RUF039_concat.py:38:9: RUF039 [*] First argument to `re.subn()` is not raw string + | +36 | 'utta ideas' +37 | ) +38 | re.subn("()"r' am I'"??") + | ^^^^ RUF039 + | + = help: Replace with raw string + +ℹ Safe fix +35 35 | "I''m o" +36 36 | 'utta ideas' +37 37 | ) +38 |-re.subn("()"r' am I'"??") + 38 |+re.subn(r"()"r' am I'"??") +39 39 | +40 40 | +41 41 | import regex + +RUF039_concat.py:38:21: RUF039 [*] First argument to `re.subn()` is not raw string + | +36 | 'utta ideas' +37 | ) +38 | re.subn("()"r' am I'"??") + | ^^^^ RUF039 + | + = help: Replace with raw string + +ℹ Safe fix +35 35 | "I''m o" +36 36 | 'utta ideas' +37 37 | ) +38 |-re.subn("()"r' am I'"??") + 38 |+re.subn("()"r' am I'r"??") +39 39 | +40 40 | +41 41 | import regex + +RUF039_concat.py:45:5: RUF039 [*] First argument to `regex.compile()` is not raw string + | +44 | regex.compile( +45 | 'implicit' + | ^^^^^^^^^^ RUF039 +46 | 'concatenation' +47 | ) + | + = help: Replace with raw string + +ℹ Safe fix +42 42 | +43 43 | +44 44 | regex.compile( +45 |- 'implicit' + 45 |+ r'implicit' +46 46 | 'concatenation' +47 47 | ) +48 48 | regex.findall( + +RUF039_concat.py:46:5: RUF039 [*] First argument to `regex.compile()` is not raw string + | +44 | regex.compile( +45 | 'implicit' +46 | 'concatenation' + | ^^^^^^^^^^^^^^^ RUF039 +47 | ) +48 | regex.findall( + | + = help: Replace with raw string + +ℹ Safe fix +43 43 | +44 44 | regex.compile( +45 45 | 'implicit' +46 |- 'concatenation' + 46 |+ r'concatenation' +47 47 | ) +48 48 | regex.findall( +49 49 | r''' + +RUF039_concat.py:52:5: RUF039 [*] First argument to `regex.findall()` is not raw string + | +50 | multiline +51 | ''' +52 | / """ +53 | | concatenation +54 | | """ + | |_______^ RUF039 +55 | ) +56 | regex.finditer( + | + = help: Replace with raw string + +ℹ Safe fix +49 49 | r''' +50 50 | multiline +51 51 | ''' +52 |- """ + 52 |+ r""" +53 53 | concatenation +54 54 | """ +55 55 | ) + +RUF039_concat.py:66:5: RUF039 First argument to `regex.match()` is not raw bytes literal + | +64 | ) +65 | regex.match( +66 | b'reak' + | ^^^^^^^ RUF039 +67 | br'eak' +68 | ) + | + = help: Replace with raw bytes literal + +RUF039_concat.py:70:8: RUF039 First argument to `regex.search()` is not raw string + | +68 | ) +69 | regex.search( +70 | r''u'' + | ^^^ RUF039 +71 | '''okay?''' +72 | ) + | + = help: Replace with raw string + +RUF039_concat.py:71:5: RUF039 [*] First argument to `regex.search()` is not raw string + | +69 | regex.search( +70 | r''u'' +71 | '''okay?''' + | ^^^^^^^^^^^ RUF039 +72 | ) +73 | regex.split(''U"""w"""U'') + | + = help: Replace with raw string + +ℹ Safe fix +68 68 | ) +69 69 | regex.search( +70 70 | r''u'' +71 |- '''okay?''' + 71 |+ r'''okay?''' +72 72 | ) +73 73 | regex.split(''U"""w"""U'') +74 74 | regex.sub( + +RUF039_concat.py:73:13: RUF039 [*] First argument to `regex.split()` is not raw string + | +71 | '''okay?''' +72 | ) +73 | regex.split(''U"""w"""U'') + | ^^ RUF039 +74 | regex.sub( +75 | "I''m o" + | + = help: Replace with raw string + +ℹ Safe fix +70 70 | r''u'' +71 71 | '''okay?''' +72 72 | ) +73 |-regex.split(''U"""w"""U'') + 73 |+regex.split(r''U"""w"""U'') +74 74 | regex.sub( +75 75 | "I''m o" +76 76 | 'utta ideas' + +RUF039_concat.py:73:15: RUF039 First argument to `regex.split()` is not raw string + | +71 | '''okay?''' +72 | ) +73 | regex.split(''U"""w"""U'') + | ^^^^^^^^ RUF039 +74 | regex.sub( +75 | "I''m o" + | + = help: Replace with raw string + +RUF039_concat.py:73:23: RUF039 First argument to `regex.split()` is not raw string + | +71 | '''okay?''' +72 | ) +73 | regex.split(''U"""w"""U'') + | ^^^ RUF039 +74 | regex.sub( +75 | "I''m o" + | + = help: Replace with raw string + +RUF039_concat.py:75:5: RUF039 [*] First argument to `regex.sub()` is not raw string + | +73 | regex.split(''U"""w"""U'') +74 | regex.sub( +75 | "I''m o" + | ^^^^^^^^ RUF039 +76 | 'utta ideas' +77 | ) + | + = help: Replace with raw string + +ℹ Safe fix +72 72 | ) +73 73 | regex.split(''U"""w"""U'') +74 74 | regex.sub( +75 |- "I''m o" + 75 |+ r"I''m o" +76 76 | 'utta ideas' +77 77 | ) +78 78 | regex.subn("()"r' am I'"??") + +RUF039_concat.py:76:5: RUF039 [*] First argument to `regex.sub()` is not raw string + | +74 | regex.sub( +75 | "I''m o" +76 | 'utta ideas' + | ^^^^^^^^^^^^ RUF039 +77 | ) +78 | regex.subn("()"r' am I'"??") + | + = help: Replace with raw string + +ℹ Safe fix +73 73 | regex.split(''U"""w"""U'') +74 74 | regex.sub( +75 75 | "I''m o" +76 |- 'utta ideas' + 76 |+ r'utta ideas' +77 77 | ) +78 78 | regex.subn("()"r' am I'"??") +79 79 | + +RUF039_concat.py:78:12: RUF039 [*] First argument to `regex.subn()` is not raw string + | +76 | 'utta ideas' +77 | ) +78 | regex.subn("()"r' am I'"??") + | ^^^^ RUF039 + | + = help: Replace with raw string + +ℹ Safe fix +75 75 | "I''m o" +76 76 | 'utta ideas' +77 77 | ) +78 |-regex.subn("()"r' am I'"??") + 78 |+regex.subn(r"()"r' am I'"??") +79 79 | +80 80 | +81 81 | regex.template( + +RUF039_concat.py:78:24: RUF039 [*] First argument to `regex.subn()` is not raw string + | +76 | 'utta ideas' +77 | ) +78 | regex.subn("()"r' am I'"??") + | ^^^^ RUF039 + | + = help: Replace with raw string + +ℹ Safe fix +75 75 | "I''m o" +76 76 | 'utta ideas' +77 77 | ) +78 |-regex.subn("()"r' am I'"??") + 78 |+regex.subn("()"r' am I'r"??") +79 79 | +80 80 | +81 81 | regex.template( diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF043_RUF043.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF043_RUF043.py.snap new file mode 100644 index 0000000000000..0207b8a58397d --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF043_RUF043.py.snap @@ -0,0 +1,330 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF043.py:8:43: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | + 6 | ### Errors + 7 | + 8 | with pytest.raises(FooAtTheEnd, match="foo."): ... + | ^^^^^^ RUF043 + 9 | with pytest.raises(PackageExtraSpecifier, match="Install `foo[bar]` to enjoy all features"): ... +10 | with pytest.raises(InnocentQuestion, match="Did you mean to use `Literal` instead?"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:9:53: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | + 8 | with pytest.raises(FooAtTheEnd, match="foo."): ... + 9 | with pytest.raises(PackageExtraSpecifier, match="Install `foo[bar]` to enjoy all features"): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF043 +10 | with pytest.raises(InnocentQuestion, match="Did you mean to use `Literal` instead?"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:10:48: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | + 8 | with pytest.raises(FooAtTheEnd, match="foo."): ... + 9 | with pytest.raises(PackageExtraSpecifier, match="Install `foo[bar]` to enjoy all features"): ... +10 | with pytest.raises(InnocentQuestion, match="Did you mean to use `Literal` instead?"): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF043 +11 | +12 | with pytest.raises(StringConcatenation, match="Huh" + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:12:51: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +10 | with pytest.raises(InnocentQuestion, match="Did you mean to use `Literal` instead?"): ... +11 | +12 | with pytest.raises(StringConcatenation, match="Huh" + | ___________________________________________________^ +13 | | "?"): ... + | |_____________________________________________________^ RUF043 +14 | with pytest.raises(ManuallyEscapedWindowsPathToDotFile, match="C:\\\\Users\\\\Foo\\\\.config"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:14:67: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +12 | with pytest.raises(StringConcatenation, match="Huh" +13 | "?"): ... +14 | with pytest.raises(ManuallyEscapedWindowsPathToDotFile, match="C:\\\\Users\\\\Foo\\\\.config"): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF043 +15 | +16 | with pytest.raises(MiddleDot, match="foo.bar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:16:41: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +14 | with pytest.raises(ManuallyEscapedWindowsPathToDotFile, match="C:\\\\Users\\\\Foo\\\\.config"): ... +15 | +16 | with pytest.raises(MiddleDot, match="foo.bar"): ... + | ^^^^^^^^^ RUF043 +17 | with pytest.raises(EndDot, match="foobar."): ... +18 | with pytest.raises(EscapedFollowedByUnescaped, match="foo\\.*bar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:17:38: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +16 | with pytest.raises(MiddleDot, match="foo.bar"): ... +17 | with pytest.raises(EndDot, match="foobar."): ... + | ^^^^^^^^^ RUF043 +18 | with pytest.raises(EscapedFollowedByUnescaped, match="foo\\.*bar"): ... +19 | with pytest.raises(UnescapedFollowedByEscaped, match="foo.\\*bar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:18:58: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +16 | with pytest.raises(MiddleDot, match="foo.bar"): ... +17 | with pytest.raises(EndDot, match="foobar."): ... +18 | with pytest.raises(EscapedFollowedByUnescaped, match="foo\\.*bar"): ... + | ^^^^^^^^^^^^ RUF043 +19 | with pytest.raises(UnescapedFollowedByEscaped, match="foo.\\*bar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:19:58: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +17 | with pytest.raises(EndDot, match="foobar."): ... +18 | with pytest.raises(EscapedFollowedByUnescaped, match="foo\\.*bar"): ... +19 | with pytest.raises(UnescapedFollowedByEscaped, match="foo.\\*bar"): ... + | ^^^^^^^^^^^^ RUF043 +20 | +21 | # https://github.com/astral-sh/ruff/issues/15316 + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:22:50: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +21 | # https://github.com/astral-sh/ruff/issues/15316 +22 | with pytest.raises(ClosingParenthesis, match="foo)"): ... + | ^^^^^^ RUF043 + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:27:44: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +25 | ## Metasequences +26 | +27 | with pytest.raises(StartOfInput, match="foo\\Abar"): ... + | ^^^^^^^^^^^ RUF043 +28 | with pytest.raises(WordBoundary, match="foo\\bbar"): ... +29 | with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:28:44: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +27 | with pytest.raises(StartOfInput, match="foo\\Abar"): ... +28 | with pytest.raises(WordBoundary, match="foo\\bbar"): ... + | ^^^^^^^^^^^ RUF043 +29 | with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... +30 | with pytest.raises(Digit, match="foo\\dbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:29:47: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +27 | with pytest.raises(StartOfInput, match="foo\\Abar"): ... +28 | with pytest.raises(WordBoundary, match="foo\\bbar"): ... +29 | with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... + | ^^^^^^^^^^^ RUF043 +30 | with pytest.raises(Digit, match="foo\\dbar"): ... +31 | with pytest.raises(NonDigit, match="foo\\Dbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:30:37: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +28 | with pytest.raises(WordBoundary, match="foo\\bbar"): ... +29 | with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... +30 | with pytest.raises(Digit, match="foo\\dbar"): ... + | ^^^^^^^^^^^ RUF043 +31 | with pytest.raises(NonDigit, match="foo\\Dbar"): ... +32 | with pytest.raises(Whitespace, match="foo\\sbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:31:40: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +29 | with pytest.raises(NonWordBoundary, match="foo\\Bbar"): ... +30 | with pytest.raises(Digit, match="foo\\dbar"): ... +31 | with pytest.raises(NonDigit, match="foo\\Dbar"): ... + | ^^^^^^^^^^^ RUF043 +32 | with pytest.raises(Whitespace, match="foo\\sbar"): ... +33 | with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:32:42: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +30 | with pytest.raises(Digit, match="foo\\dbar"): ... +31 | with pytest.raises(NonDigit, match="foo\\Dbar"): ... +32 | with pytest.raises(Whitespace, match="foo\\sbar"): ... + | ^^^^^^^^^^^ RUF043 +33 | with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... +34 | with pytest.raises(WordCharacter, match="foo\\wbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:33:45: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +31 | with pytest.raises(NonDigit, match="foo\\Dbar"): ... +32 | with pytest.raises(Whitespace, match="foo\\sbar"): ... +33 | with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... + | ^^^^^^^^^^^ RUF043 +34 | with pytest.raises(WordCharacter, match="foo\\wbar"): ... +35 | with pytest.raises(NonWordCharacter, match="foo\\Wbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:34:45: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +32 | with pytest.raises(Whitespace, match="foo\\sbar"): ... +33 | with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... +34 | with pytest.raises(WordCharacter, match="foo\\wbar"): ... + | ^^^^^^^^^^^ RUF043 +35 | with pytest.raises(NonWordCharacter, match="foo\\Wbar"): ... +36 | with pytest.raises(EndOfInput, match="foo\\zbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:35:48: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +33 | with pytest.raises(NonWhitespace, match="foo\\Sbar"): ... +34 | with pytest.raises(WordCharacter, match="foo\\wbar"): ... +35 | with pytest.raises(NonWordCharacter, match="foo\\Wbar"): ... + | ^^^^^^^^^^^ RUF043 +36 | with pytest.raises(EndOfInput, match="foo\\zbar"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:36:42: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +34 | with pytest.raises(WordCharacter, match="foo\\wbar"): ... +35 | with pytest.raises(NonWordCharacter, match="foo\\Wbar"): ... +36 | with pytest.raises(EndOfInput, match="foo\\zbar"): ... + | ^^^^^^^^^^^ RUF043 +37 | +38 | with pytest.raises(StartOfInput2, match="foobar\\A"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:38:45: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +36 | with pytest.raises(EndOfInput, match="foo\\zbar"): ... +37 | +38 | with pytest.raises(StartOfInput2, match="foobar\\A"): ... + | ^^^^^^^^^^^ RUF043 +39 | with pytest.raises(WordBoundary2, match="foobar\\b"): ... +40 | with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:39:45: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +38 | with pytest.raises(StartOfInput2, match="foobar\\A"): ... +39 | with pytest.raises(WordBoundary2, match="foobar\\b"): ... + | ^^^^^^^^^^^ RUF043 +40 | with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... +41 | with pytest.raises(Digit2, match="foobar\\d"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:40:48: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +38 | with pytest.raises(StartOfInput2, match="foobar\\A"): ... +39 | with pytest.raises(WordBoundary2, match="foobar\\b"): ... +40 | with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... + | ^^^^^^^^^^^ RUF043 +41 | with pytest.raises(Digit2, match="foobar\\d"): ... +42 | with pytest.raises(NonDigit2, match="foobar\\D"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:41:38: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +39 | with pytest.raises(WordBoundary2, match="foobar\\b"): ... +40 | with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... +41 | with pytest.raises(Digit2, match="foobar\\d"): ... + | ^^^^^^^^^^^ RUF043 +42 | with pytest.raises(NonDigit2, match="foobar\\D"): ... +43 | with pytest.raises(Whitespace2, match="foobar\\s"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:42:41: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +40 | with pytest.raises(NonWordBoundary2, match="foobar\\B"): ... +41 | with pytest.raises(Digit2, match="foobar\\d"): ... +42 | with pytest.raises(NonDigit2, match="foobar\\D"): ... + | ^^^^^^^^^^^ RUF043 +43 | with pytest.raises(Whitespace2, match="foobar\\s"): ... +44 | with pytest.raises(NonWhitespace2, match="foobar\\S"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:43:43: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +41 | with pytest.raises(Digit2, match="foobar\\d"): ... +42 | with pytest.raises(NonDigit2, match="foobar\\D"): ... +43 | with pytest.raises(Whitespace2, match="foobar\\s"): ... + | ^^^^^^^^^^^ RUF043 +44 | with pytest.raises(NonWhitespace2, match="foobar\\S"): ... +45 | with pytest.raises(WordCharacter2, match="foobar\\w"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:44:46: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +42 | with pytest.raises(NonDigit2, match="foobar\\D"): ... +43 | with pytest.raises(Whitespace2, match="foobar\\s"): ... +44 | with pytest.raises(NonWhitespace2, match="foobar\\S"): ... + | ^^^^^^^^^^^ RUF043 +45 | with pytest.raises(WordCharacter2, match="foobar\\w"): ... +46 | with pytest.raises(NonWordCharacter2, match="foobar\\W"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:45:46: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +43 | with pytest.raises(Whitespace2, match="foobar\\s"): ... +44 | with pytest.raises(NonWhitespace2, match="foobar\\S"): ... +45 | with pytest.raises(WordCharacter2, match="foobar\\w"): ... + | ^^^^^^^^^^^ RUF043 +46 | with pytest.raises(NonWordCharacter2, match="foobar\\W"): ... +47 | with pytest.raises(EndOfInput2, match="foobar\\z"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:46:49: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +44 | with pytest.raises(NonWhitespace2, match="foobar\\S"): ... +45 | with pytest.raises(WordCharacter2, match="foobar\\w"): ... +46 | with pytest.raises(NonWordCharacter2, match="foobar\\W"): ... + | ^^^^^^^^^^^ RUF043 +47 | with pytest.raises(EndOfInput2, match="foobar\\z"): ... + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:47:43: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +45 | with pytest.raises(WordCharacter2, match="foobar\\w"): ... +46 | with pytest.raises(NonWordCharacter2, match="foobar\\W"): ... +47 | with pytest.raises(EndOfInput2, match="foobar\\z"): ... + | ^^^^^^^^^^^ RUF043 + | + = help: Use a raw string or `re.escape()` to make the intention explicit + +RUF043.py:52:42: RUF043 Pattern passed to `match=` contains metacharacters but is neither escaped nor raw + | +50 | ### Acceptable false positives +51 | +52 | with pytest.raises(NameEscape, match="\\N{EN DASH}"): ... + | ^^^^^^^^^^^^^^ RUF043 + | + = help: Use a raw string or `re.escape()` to make the intention explicit diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF045_RUF045.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF045_RUF045.py.snap new file mode 100644 index 0000000000000..5e1aa23b88463 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF045_RUF045.py.snap @@ -0,0 +1,34 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF045.py:8:5: RUF045 Assignment without annotation found in dataclass body + | + 6 | class C: + 7 | # Errors + 8 | no_annotation = r"foo" + | ^^^^^^^^^^^^^ RUF045 + 9 | missing = MISSING +10 | field = field() + | + = help: Use `ClassVar[...]` + +RUF045.py:9:5: RUF045 Assignment without annotation found in dataclass body + | + 7 | # Errors + 8 | no_annotation = r"foo" + 9 | missing = MISSING + | ^^^^^^^ RUF045 +10 | field = field() + | + = help: Use `ClassVar[...]` + +RUF045.py:10:5: RUF045 Assignment without annotation found in dataclass body + | + 8 | no_annotation = r"foo" + 9 | missing = MISSING +10 | field = field() + | ^^^^^ RUF045 +11 | +12 | # No errors + | + = help: Use `ClassVar[...]` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF049_RUF049.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF049_RUF049.py.snap new file mode 100644 index 0000000000000..a2189975df299 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF049_RUF049.py.snap @@ -0,0 +1,66 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF049.py:10:1: RUF049 An enum class should not be decorated with `@dataclass` + | + 8 | ## Errors + 9 | +10 | @dataclass + | ^^^^^^^^^^ RUF049 +11 | class E(Enum): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:14:1: RUF049 An enum class should not be decorated with `@dataclass` + | +14 | @dataclass # Foobar + | ^^^^^^^^^^ RUF049 +15 | class E(Flag): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:18:1: RUF049 An enum class should not be decorated with `@dataclass` + | +18 | @dataclass() + | ^^^^^^^^^^^^ RUF049 +19 | class E(IntEnum): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:22:1: RUF049 An enum class should not be decorated with `@dataclass` + | +22 | @dataclass() # Foobar + | ^^^^^^^^^^^^ RUF049 +23 | class E(IntFlag): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:26:1: RUF049 An enum class should not be decorated with `@dataclass` + | +26 | / @dataclass( +27 | | frozen=True +28 | | ) + | |_^ RUF049 +29 | class E(StrEnum): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:32:1: RUF049 An enum class should not be decorated with `@dataclass` + | +32 | / @dataclass( # Foobar +33 | | frozen=True +34 | | ) + | |_^ RUF049 +35 | class E(ReprEnum): ... + | + = help: Remove either `@dataclass` or `Enum` + +RUF049.py:38:1: RUF049 An enum class should not be decorated with `@dataclass` + | +38 | / @dataclass( +39 | | frozen=True +40 | | ) # Foobar + | |_^ RUF049 +41 | class E(Enum): ... + | + = help: Remove either `@dataclass` or `Enum` diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF053_RUF053.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF053_RUF053.py.snap new file mode 100644 index 0000000000000..8d308ab552d9f --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF053_RUF053.py.snap @@ -0,0 +1,475 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF053.py:23:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +21 | ### Errors +22 | +23 | class C[T](Generic[_A]): ... + | ^^^^^^^^^^^ RUF053 +24 | class C[T](Generic[_B], str): ... +25 | class C[T](int, Generic[_C]): ... + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +20 20 | +21 21 | ### Errors +22 22 | +23 |-class C[T](Generic[_A]): ... + 23 |+class C[T, _A]: ... +24 24 | class C[T](Generic[_B], str): ... +25 25 | class C[T](int, Generic[_C]): ... +26 26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults + +RUF053.py:24:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +23 | class C[T](Generic[_A]): ... +24 | class C[T](Generic[_B], str): ... + | ^^^^^^^^^^^ RUF053 +25 | class C[T](int, Generic[_C]): ... +26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +21 21 | ### Errors +22 22 | +23 23 | class C[T](Generic[_A]): ... +24 |-class C[T](Generic[_B], str): ... + 24 |+class C[T, _B: int](str): ... +25 25 | class C[T](int, Generic[_C]): ... +26 26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +27 27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults + +RUF053.py:25:17: RUF053 [*] Class with type parameter list inherits from `Generic` + | +23 | class C[T](Generic[_A]): ... +24 | class C[T](Generic[_B], str): ... +25 | class C[T](int, Generic[_C]): ... + | ^^^^^^^^^^^ RUF053 +26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +22 22 | +23 23 | class C[T](Generic[_A]): ... +24 24 | class C[T](Generic[_B], str): ... +25 |-class C[T](int, Generic[_C]): ... + 25 |+class C[T, _C: (str, bytes)](int): ... +26 26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +27 27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults +28 28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults + +RUF053.py:26:19: RUF053 Class with type parameter list inherits from `Generic` + | +24 | class C[T](Generic[_B], str): ... +25 | class C[T](int, Generic[_C]): ... +26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^ RUF053 +27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults +28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +RUF053.py:27:12: RUF053 Class with type parameter list inherits from `Generic` + | +25 | class C[T](int, Generic[_C]): ... +26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^ RUF053 +28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +RUF053.py:28:22: RUF053 Class with type parameter list inherits from `Generic` + | +26 | class C[T](bytes, Generic[_D], bool): ... # TODO: Type parameter defaults +27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults +28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^ RUF053 +29 | +30 | class C[*Ts](Generic[*_As]): ... + | + = help: Remove `Generic` base class + +RUF053.py:30:14: RUF053 [*] Class with type parameter list inherits from `Generic` + | +28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults +29 | +30 | class C[*Ts](Generic[*_As]): ... + | ^^^^^^^^^^^^^ RUF053 +31 | class C[*Ts](Generic[Unpack[_As]]): ... +32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +27 27 | class C[T](Generic[_E], list[_E]): ... # TODO: Type parameter defaults +28 28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults +29 29 | +30 |-class C[*Ts](Generic[*_As]): ... + 30 |+class C[*Ts, *_As]: ... +31 31 | class C[*Ts](Generic[Unpack[_As]]): ... +32 32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... +33 33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults + +RUF053.py:31:14: RUF053 [*] Class with type parameter list inherits from `Generic` + | +30 | class C[*Ts](Generic[*_As]): ... +31 | class C[*Ts](Generic[Unpack[_As]]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF053 +32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... +33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +28 28 | class C[T](list[_F], Generic[_F]): ... # TODO: Type parameter defaults +29 29 | +30 30 | class C[*Ts](Generic[*_As]): ... +31 |-class C[*Ts](Generic[Unpack[_As]]): ... + 31 |+class C[*Ts, *_As]: ... +32 32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... +33 33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults +34 34 | + +RUF053.py:32:14: RUF053 Class with type parameter list inherits from `Generic` + | +30 | class C[*Ts](Generic[*_As]): ... +31 | class C[*Ts](Generic[Unpack[_As]]): ... +32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF053 +33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +RUF053.py:33:44: RUF053 Class with type parameter list inherits from `Generic` + | +31 | class C[*Ts](Generic[Unpack[_As]]): ... +32 | class C[*Ts](Generic[Unpack[_Bs]], tuple[*Bs]): ... +33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:36:14: RUF053 [*] Class with type parameter list inherits from `Generic` + | +36 | class C[**P](Generic[_P1]): ... + | ^^^^^^^^^^^^ RUF053 +37 | class C[**P](Generic[_P2]): ... +38 | class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +33 33 | class C[*Ts](Callable[[*_Cs], tuple[*Ts]], Generic[_Cs]): ... # TODO: Type parameter defaults +34 34 | +35 35 | +36 |-class C[**P](Generic[_P1]): ... + 36 |+class C[**P, **_P1]: ... +37 37 | class C[**P](Generic[_P2]): ... +38 38 | class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults +39 39 | + +RUF053.py:37:14: RUF053 Class with type parameter list inherits from `Generic` + | +36 | class C[**P](Generic[_P1]): ... +37 | class C[**P](Generic[_P2]): ... + | ^^^^^^^^^^^^ RUF053 +38 | class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +RUF053.py:38:14: RUF053 Class with type parameter list inherits from `Generic` + | +36 | class C[**P](Generic[_P1]): ... +37 | class C[**P](Generic[_P2]): ... +38 | class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:41:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +41 | class C[T](Generic[T, _A]): ... + | ^^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +38 38 | class C[**P](Generic[_P3]): ... # TODO: Type parameter defaults +39 39 | +40 40 | +41 |-class C[T](Generic[T, _A]): ... + 41 |+class C[T, _A]: ... +42 42 | +43 43 | +44 44 | # See `is_existing_param_of_same_class`. + +RUF053.py:47:35: RUF053 Class with type parameter list inherits from `Generic` + | +45 | # `expr_name_to_type_var` doesn't handle named expressions, +46 | # only simple assignments, so there is no fix. +47 | class C[T: (_Z := TypeVar('_Z'))](Generic[_Z]): ... + | ^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:51:16: RUF053 [*] Class with type parameter list inherits from `Generic` + | +50 | class C(Generic[_B]): +51 | class D[T](Generic[_B, T]): ... + | ^^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +48 48 | +49 49 | +50 50 | class C(Generic[_B]): +51 |- class D[T](Generic[_B, T]): ... + 51 |+ class D[T, _B: int]: ... +52 52 | +53 53 | +54 54 | class C[T]: + +RUF053.py:55:16: RUF053 Class with type parameter list inherits from `Generic` + | +54 | class C[T]: +55 | class D[U](Generic[T, U]): ... + | ^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:60:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +58 | # In a single run, only the first is reported. +59 | # Others will be reported/fixed in following iterations. +60 | class C[T](Generic[_C], Generic[_D]): ... + | ^^^^^^^^^^^ RUF053 +61 | class C[T, _C: (str, bytes)](Generic[_D]): ... # TODO: Type parameter defaults + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +57 57 | +58 58 | # In a single run, only the first is reported. +59 59 | # Others will be reported/fixed in following iterations. +60 |-class C[T](Generic[_C], Generic[_D]): ... + 60 |+class C[T, _C: (str, bytes)](Generic[_D]): ... +61 61 | class C[T, _C: (str, bytes)](Generic[_D]): ... # TODO: Type parameter defaults +62 62 | +63 63 | + +RUF053.py:61:30: RUF053 Class with type parameter list inherits from `Generic` + | +59 | # Others will be reported/fixed in following iterations. +60 | class C[T](Generic[_C], Generic[_D]): ... +61 | class C[T, _C: (str, bytes)](Generic[_D]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:66:3: RUF053 Class with type parameter list inherits from `Generic` + | +64 | class C[ +65 | T # Comment +66 | ](Generic[_E]): ... # TODO: Type parameter defaults + | ^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:69:12: RUF053 Class with type parameter list inherits from `Generic` + | +69 | class C[T](Generic[Generic[_F]]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF053 +70 | class C[T](Generic[Unpack[_A]]): ... +71 | class C[T](Generic[Unpack[_P1]]): ... + | + = help: Remove `Generic` base class + +RUF053.py:70:12: RUF053 Class with type parameter list inherits from `Generic` + | +69 | class C[T](Generic[Generic[_F]]): ... +70 | class C[T](Generic[Unpack[_A]]): ... + | ^^^^^^^^^^^^^^^^^^^ RUF053 +71 | class C[T](Generic[Unpack[_P1]]): ... +72 | class C[T](Generic[Unpack[Unpack[_P2]]]): ... + | + = help: Remove `Generic` base class + +RUF053.py:71:12: RUF053 Class with type parameter list inherits from `Generic` + | +69 | class C[T](Generic[Generic[_F]]): ... +70 | class C[T](Generic[Unpack[_A]]): ... +71 | class C[T](Generic[Unpack[_P1]]): ... + | ^^^^^^^^^^^^^^^^^^^^ RUF053 +72 | class C[T](Generic[Unpack[Unpack[_P2]]]): ... +73 | class C[T](Generic[Unpack[*_As]]): ... + | + = help: Remove `Generic` base class + +RUF053.py:72:12: RUF053 Class with type parameter list inherits from `Generic` + | +70 | class C[T](Generic[Unpack[_A]]): ... +71 | class C[T](Generic[Unpack[_P1]]): ... +72 | class C[T](Generic[Unpack[Unpack[_P2]]]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF053 +73 | class C[T](Generic[Unpack[*_As]]): ... +74 | class C[T](Generic[Unpack[_As, _Bs]]): ... + | + = help: Remove `Generic` base class + +RUF053.py:73:12: RUF053 Class with type parameter list inherits from `Generic` + | +71 | class C[T](Generic[Unpack[_P1]]): ... +72 | class C[T](Generic[Unpack[Unpack[_P2]]]): ... +73 | class C[T](Generic[Unpack[*_As]]): ... + | ^^^^^^^^^^^^^^^^^^^^^ RUF053 +74 | class C[T](Generic[Unpack[_As, _Bs]]): ... + | + = help: Remove `Generic` base class + +RUF053.py:74:12: RUF053 Class with type parameter list inherits from `Generic` + | +72 | class C[T](Generic[Unpack[Unpack[_P2]]]): ... +73 | class C[T](Generic[Unpack[*_As]]): ... +74 | class C[T](Generic[Unpack[_As, _Bs]]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:77:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +77 | class C[T](Generic[_A, _A]): ... + | ^^^^^^^^^^^^^^^ RUF053 +78 | class C[T](Generic[_A, Unpack[_As]]): ... +79 | class C[T](Generic[*_As, _A]): ... + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +74 74 | class C[T](Generic[Unpack[_As, _Bs]]): ... +75 75 | +76 76 | +77 |-class C[T](Generic[_A, _A]): ... + 77 |+class C[T, _A]: ... +78 78 | class C[T](Generic[_A, Unpack[_As]]): ... +79 79 | class C[T](Generic[*_As, _A]): ... +80 80 | + +RUF053.py:78:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +77 | class C[T](Generic[_A, _A]): ... +78 | class C[T](Generic[_A, Unpack[_As]]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF053 +79 | class C[T](Generic[*_As, _A]): ... + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +75 75 | +76 76 | +77 77 | class C[T](Generic[_A, _A]): ... +78 |-class C[T](Generic[_A, Unpack[_As]]): ... + 78 |+class C[T, _A, *_As]: ... +79 79 | class C[T](Generic[*_As, _A]): ... +80 80 | +81 81 | + +RUF053.py:79:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +77 | class C[T](Generic[_A, _A]): ... +78 | class C[T](Generic[_A, Unpack[_As]]): ... +79 | class C[T](Generic[*_As, _A]): ... + | ^^^^^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +76 76 | +77 77 | class C[T](Generic[_A, _A]): ... +78 78 | class C[T](Generic[_A, Unpack[_As]]): ... +79 |-class C[T](Generic[*_As, _A]): ... + 79 |+class C[T, *_As, _A]: ... +80 80 | +81 81 | +82 82 | from somewhere import APublicTypeVar + +RUF053.py:83:12: RUF053 Class with type parameter list inherits from `Generic` + | +82 | from somewhere import APublicTypeVar +83 | class C[T](Generic[APublicTypeVar]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^ RUF053 +84 | class C[T](Generic[APublicTypeVar, _A]): ... + | + = help: Remove `Generic` base class + +RUF053.py:84:12: RUF053 Class with type parameter list inherits from `Generic` + | +82 | from somewhere import APublicTypeVar +83 | class C[T](Generic[APublicTypeVar]): ... +84 | class C[T](Generic[APublicTypeVar, _A]): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +RUF053.py:91:12: RUF053 [*] Class with type parameter list inherits from `Generic` + | +89 | # as named expressions are forbidden within type parameter lists. +90 | # See also the `_Z` example above. +91 | class C[T](Generic[_G]): ... # Should be moved down below eventually + | ^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +88 88 | # The latter cannot be used as a PEP 695 constraint, +89 89 | # as named expressions are forbidden within type parameter lists. +90 90 | # See also the `_Z` example above. +91 |-class C[T](Generic[_G]): ... # Should be moved down below eventually + 91 |+class C[T, _G: (str, a := int)]: ... # Should be moved down below eventually +92 92 | +93 93 | +94 94 | # Single-element constraints should not be converted to a bound. + +RUF053.py:95:20: RUF053 [*] Class with type parameter list inherits from `Generic` + | +94 | # Single-element constraints should not be converted to a bound. +95 | class C[T: (str,)](Generic[_A]): ... + | ^^^^^^^^^^^ RUF053 +96 | class C[T: [a]](Generic[_A]): ... + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +92 92 | +93 93 | +94 94 | # Single-element constraints should not be converted to a bound. +95 |-class C[T: (str,)](Generic[_A]): ... + 95 |+class C[T: (str), _A]: ... +96 96 | class C[T: [a]](Generic[_A]): ... +97 97 | +98 98 | + +RUF053.py:96:17: RUF053 [*] Class with type parameter list inherits from `Generic` + | +94 | # Single-element constraints should not be converted to a bound. +95 | class C[T: (str,)](Generic[_A]): ... +96 | class C[T: [a]](Generic[_A]): ... + | ^^^^^^^^^^^ RUF053 + | + = help: Remove `Generic` base class + +ℹ Unsafe fix +93 93 | +94 94 | # Single-element constraints should not be converted to a bound. +95 95 | class C[T: (str,)](Generic[_A]): ... +96 |-class C[T: [a]](Generic[_A]): ... + 96 |+class C[T: [a], _A]: ... +97 97 | +98 98 | +99 99 | # Existing bounds should not be deparenthesized. diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF054_RUF054.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF054_RUF054.py.snap new file mode 100644 index 0000000000000..a54d2e2471bd0 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF054_RUF054.py.snap @@ -0,0 +1,39 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF054.py:8:2: RUF054 Indented form feed + | +6 | # Errors +7 | +8 | + | ^ RUF054 + | + = help: Remove form feed + +RUF054.py:10:3: RUF054 Indented form feed + | +10 | + | ^ RUF054 +11 | +12 | def _(): + | + = help: Remove form feed + +RUF054.py:13:2: RUF054 Indented form feed + | +12 | def _(): +13 | pass + | ^ RUF054 +14 | +15 | if False: + | + = help: Remove form feed + +RUF054.py:17:5: RUF054 Indented form feed + | +15 | if False: +16 | print('F') +17 | print('T') + | ^ RUF054 + | + = help: Remove form feed diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_0.py.snap new file mode 100644 index 0000000000000..0ea320d36a28f --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_0.py.snap @@ -0,0 +1,287 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF055_0.py:6:1: RUF055 [*] Plain string pattern passed to `re` function + | +5 | # this should be replaced with `s.replace("abc", "")` +6 | re.sub("abc", "", s) + | ^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `s.replace("abc", "")` + +ℹ Safe fix +3 3 | s = "str" +4 4 | +5 5 | # this should be replaced with `s.replace("abc", "")` +6 |-re.sub("abc", "", s) + 6 |+s.replace("abc", "") +7 7 | +8 8 | +9 9 | # this example, adapted from https://docs.python.org/3/library/re.html#re.sub, + +RUF055_0.py:22:4: RUF055 [*] Plain string pattern passed to `re` function + | +20 | # this one should be replaced with `s.startswith("abc")` because the Match is +21 | # used in an if context for its truth value +22 | if re.match("abc", s): + | ^^^^^^^^^^^^^^^^^^ RUF055 +23 | pass +24 | if m := re.match("abc", s): # this should *not* be replaced + | + = help: Replace with `s.startswith("abc")` + +ℹ Safe fix +19 19 | +20 20 | # this one should be replaced with `s.startswith("abc")` because the Match is +21 21 | # used in an if context for its truth value +22 |-if re.match("abc", s): + 22 |+if s.startswith("abc"): +23 23 | pass +24 24 | if m := re.match("abc", s): # this should *not* be replaced +25 25 | pass + +RUF055_0.py:29:4: RUF055 [*] Plain string pattern passed to `re` function + | +28 | # this should be replaced with `"abc" in s` +29 | if re.search("abc", s): + | ^^^^^^^^^^^^^^^^^^^ RUF055 +30 | pass +31 | re.search("abc", s) # this should not be replaced + | + = help: Replace with `"abc" in s` + +ℹ Safe fix +26 26 | re.match("abc", s) # this should not be replaced because match returns a Match +27 27 | +28 28 | # this should be replaced with `"abc" in s` +29 |-if re.search("abc", s): + 29 |+if "abc" in s: +30 30 | pass +31 31 | re.search("abc", s) # this should not be replaced +32 32 | + +RUF055_0.py:34:4: RUF055 [*] Plain string pattern passed to `re` function + | +33 | # this should be replaced with `"abc" == s` +34 | if re.fullmatch("abc", s): + | ^^^^^^^^^^^^^^^^^^^^^^ RUF055 +35 | pass +36 | re.fullmatch("abc", s) # this should not be replaced + | + = help: Replace with `s == "abc"` + +ℹ Safe fix +31 31 | re.search("abc", s) # this should not be replaced +32 32 | +33 33 | # this should be replaced with `"abc" == s` +34 |-if re.fullmatch("abc", s): + 34 |+if s == "abc": +35 35 | pass +36 36 | re.fullmatch("abc", s) # this should not be replaced +37 37 | + +RUF055_0.py:39:1: RUF055 [*] Plain string pattern passed to `re` function + | +38 | # this should be replaced with `s.split("abc")` +39 | re.split("abc", s) + | ^^^^^^^^^^^^^^^^^^ RUF055 +40 | +41 | # these currently should not be modified because the patterns contain regex + | + = help: Replace with `s.split("abc")` + +ℹ Safe fix +36 36 | re.fullmatch("abc", s) # this should not be replaced +37 37 | +38 38 | # this should be replaced with `s.split("abc")` +39 |-re.split("abc", s) + 39 |+s.split("abc") +40 40 | +41 41 | # these currently should not be modified because the patterns contain regex +42 42 | # metacharacters + +RUF055_0.py:71:1: RUF055 [*] Plain string pattern passed to `re` function + | +70 | # this should trigger an unsafe fix because of the presence of comments +71 | / re.sub( +72 | | # pattern +73 | | "abc", +74 | | # repl +75 | | "", +76 | | s, # string +77 | | ) + | |_^ RUF055 +78 | +79 | # A diagnostic should not be emitted for `sub` replacements with backreferences or + | + = help: Replace with `s.replace("abc", "")` + +ℹ Unsafe fix +68 68 | re.split("abc", s, maxsplit=2) +69 69 | +70 70 | # this should trigger an unsafe fix because of the presence of comments +71 |-re.sub( +72 |- # pattern +73 |- "abc", +74 |- # repl +75 |- "", +76 |- s, # string +77 |-) + 71 |+s.replace("abc", "") +78 72 | +79 73 | # A diagnostic should not be emitted for `sub` replacements with backreferences or +80 74 | # most other ASCII escapes + +RUF055_0.py:89:1: RUF055 [*] Plain string pattern passed to `re` function + | +87 | # *not* `some_string.replace("a", "\\n")`. +88 | # We currently emit diagnostics for some of these without fixing them. +89 | re.sub(r"a", "\n", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +90 | re.sub(r"a", r"\n", "a") +91 | re.sub(r"a", "\a", "a") + | + = help: Replace with `"a".replace(r"a", "\n")` + +ℹ Safe fix +86 86 | # `re.sub(r"a", r"\n", some_string)` is fixed to `some_string.replace("a", "\n")` +87 87 | # *not* `some_string.replace("a", "\\n")`. +88 88 | # We currently emit diagnostics for some of these without fixing them. +89 |-re.sub(r"a", "\n", "a") + 89 |+"a".replace(r"a", "\n") +90 90 | re.sub(r"a", r"\n", "a") +91 91 | re.sub(r"a", "\a", "a") +92 92 | re.sub(r"a", r"\a", "a") + +RUF055_0.py:90:1: RUF055 Plain string pattern passed to `re` function + | +88 | # We currently emit diagnostics for some of these without fixing them. +89 | re.sub(r"a", "\n", "a") +90 | re.sub(r"a", r"\n", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +91 | re.sub(r"a", "\a", "a") +92 | re.sub(r"a", r"\a", "a") + | + +RUF055_0.py:91:1: RUF055 [*] Plain string pattern passed to `re` function + | +89 | re.sub(r"a", "\n", "a") +90 | re.sub(r"a", r"\n", "a") +91 | re.sub(r"a", "\a", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +92 | re.sub(r"a", r"\a", "a") + | + = help: Replace with `"a".replace(r"a", "\x07")` + +ℹ Safe fix +88 88 | # We currently emit diagnostics for some of these without fixing them. +89 89 | re.sub(r"a", "\n", "a") +90 90 | re.sub(r"a", r"\n", "a") +91 |-re.sub(r"a", "\a", "a") + 91 |+"a".replace(r"a", "\x07") +92 92 | re.sub(r"a", r"\a", "a") +93 93 | +94 94 | re.sub(r"a", "\?", "a") + +RUF055_0.py:92:1: RUF055 Plain string pattern passed to `re` function + | +90 | re.sub(r"a", r"\n", "a") +91 | re.sub(r"a", "\a", "a") +92 | re.sub(r"a", r"\a", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +93 | +94 | re.sub(r"a", "\?", "a") + | + +RUF055_0.py:94:1: RUF055 [*] Plain string pattern passed to `re` function + | +92 | re.sub(r"a", r"\a", "a") +93 | +94 | re.sub(r"a", "\?", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +95 | re.sub(r"a", r"\?", "a") + | + = help: Replace with `"a".replace(r"a", "\\?")` + +ℹ Safe fix +91 91 | re.sub(r"a", "\a", "a") +92 92 | re.sub(r"a", r"\a", "a") +93 93 | +94 |-re.sub(r"a", "\?", "a") + 94 |+"a".replace(r"a", "\\?") +95 95 | re.sub(r"a", r"\?", "a") +96 96 | +97 97 | # these double as tests for preserving raw string quoting style + +RUF055_0.py:95:1: RUF055 [*] Plain string pattern passed to `re` function + | +94 | re.sub(r"a", "\?", "a") +95 | re.sub(r"a", r"\?", "a") + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +96 | +97 | # these double as tests for preserving raw string quoting style + | + = help: Replace with `"a".replace(r"a", r"\?")` + +ℹ Safe fix +92 92 | re.sub(r"a", r"\a", "a") +93 93 | +94 94 | re.sub(r"a", "\?", "a") +95 |-re.sub(r"a", r"\?", "a") + 95 |+"a".replace(r"a", r"\?") +96 96 | +97 97 | # these double as tests for preserving raw string quoting style +98 98 | re.sub(r'abc', "", s) + +RUF055_0.py:98:1: RUF055 [*] Plain string pattern passed to `re` function + | + 97 | # these double as tests for preserving raw string quoting style + 98 | re.sub(r'abc', "", s) + | ^^^^^^^^^^^^^^^^^^^^^ RUF055 + 99 | re.sub(r"""abc""", "", s) +100 | re.sub(r'''abc''', "", s) + | + = help: Replace with `s.replace(r'abc', "")` + +ℹ Safe fix +95 95 | re.sub(r"a", r"\?", "a") +96 96 | +97 97 | # these double as tests for preserving raw string quoting style +98 |-re.sub(r'abc', "", s) + 98 |+s.replace(r'abc', "") +99 99 | re.sub(r"""abc""", "", s) +100 100 | re.sub(r'''abc''', "", s) + +RUF055_0.py:99:1: RUF055 [*] Plain string pattern passed to `re` function + | + 97 | # these double as tests for preserving raw string quoting style + 98 | re.sub(r'abc', "", s) + 99 | re.sub(r"""abc""", "", s) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +100 | re.sub(r'''abc''', "", s) + | + = help: Replace with `s.replace(r"""abc""", "")` + +ℹ Safe fix +96 96 | +97 97 | # these double as tests for preserving raw string quoting style +98 98 | re.sub(r'abc', "", s) +99 |-re.sub(r"""abc""", "", s) + 99 |+s.replace(r"""abc""", "") +100 100 | re.sub(r'''abc''', "", s) + +RUF055_0.py:100:1: RUF055 [*] Plain string pattern passed to `re` function + | + 98 | re.sub(r'abc', "", s) + 99 | re.sub(r"""abc""", "", s) +100 | re.sub(r'''abc''', "", s) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `s.replace(r'''abc''', "")` + +ℹ Safe fix +97 97 | # these double as tests for preserving raw string quoting style +98 98 | re.sub(r'abc', "", s) +99 99 | re.sub(r"""abc""", "", s) +100 |-re.sub(r'''abc''', "", s) + 100 |+s.replace(r'''abc''', "") diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_1.py.snap new file mode 100644 index 0000000000000..cf97bd89098c7 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_1.py.snap @@ -0,0 +1,39 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF055_1.py:9:1: RUF055 [*] Plain string pattern passed to `re` function + | + 7 | pat1 = "needle" + 8 | + 9 | re.sub(pat1, "", haystack) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 +10 | +11 | # aliases are not followed, so this one should not trigger the rule + | + = help: Replace with `haystack.replace(pat1, "")` + +ℹ Safe fix +6 6 | +7 7 | pat1 = "needle" +8 8 | +9 |-re.sub(pat1, "", haystack) + 9 |+haystack.replace(pat1, "") +10 10 | +11 11 | # aliases are not followed, so this one should not trigger the rule +12 12 | if pat4 := pat1: + +RUF055_1.py:17:1: RUF055 [*] Plain string pattern passed to `re` function + | +15 | # also works for the `repl` argument in sub +16 | repl = "new" +17 | re.sub(r"abc", repl, haystack) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `haystack.replace(r"abc", repl)` + +ℹ Safe fix +14 14 | +15 15 | # also works for the `repl` argument in sub +16 16 | repl = "new" +17 |-re.sub(r"abc", repl, haystack) + 17 |+haystack.replace(r"abc", repl) diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_2.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_2.py.snap new file mode 100644 index 0000000000000..b2d2b8017c46a --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF055_RUF055_2.py.snap @@ -0,0 +1,170 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text +--- +RUF055_2.py:7:1: RUF055 [*] Plain string pattern passed to `re` function + | +6 | # this should be replaced with `"abc" not in s` +7 | re.search("abc", s) is None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `"abc" not in s` + +ℹ Safe fix +4 4 | s = "str" +5 5 | +6 6 | # this should be replaced with `"abc" not in s` +7 |-re.search("abc", s) is None + 7 |+"abc" not in s +8 8 | +9 9 | +10 10 | # this should be replaced with `"abc" in s` + +RUF055_2.py:11:1: RUF055 [*] Plain string pattern passed to `re` function + | +10 | # this should be replaced with `"abc" in s` +11 | re.search("abc", s) is not None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `"abc" in s` + +ℹ Safe fix +8 8 | +9 9 | +10 10 | # this should be replaced with `"abc" in s` +11 |-re.search("abc", s) is not None + 11 |+"abc" in s +12 12 | +13 13 | +14 14 | # this should be replaced with `not s.startswith("abc")` + +RUF055_2.py:15:1: RUF055 [*] Plain string pattern passed to `re` function + | +14 | # this should be replaced with `not s.startswith("abc")` +15 | re.match("abc", s) is None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `not s.startswith("abc")` + +ℹ Safe fix +12 12 | +13 13 | +14 14 | # this should be replaced with `not s.startswith("abc")` +15 |-re.match("abc", s) is None + 15 |+not s.startswith("abc") +16 16 | +17 17 | +18 18 | # this should be replaced with `s.startswith("abc")` + +RUF055_2.py:19:1: RUF055 [*] Plain string pattern passed to `re` function + | +18 | # this should be replaced with `s.startswith("abc")` +19 | re.match("abc", s) is not None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `s.startswith("abc")` + +ℹ Safe fix +16 16 | +17 17 | +18 18 | # this should be replaced with `s.startswith("abc")` +19 |-re.match("abc", s) is not None + 19 |+s.startswith("abc") +20 20 | +21 21 | +22 22 | # this should be replaced with `s != "abc"` + +RUF055_2.py:23:1: RUF055 [*] Plain string pattern passed to `re` function + | +22 | # this should be replaced with `s != "abc"` +23 | re.fullmatch("abc", s) is None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `s != "abc"` + +ℹ Safe fix +20 20 | +21 21 | +22 22 | # this should be replaced with `s != "abc"` +23 |-re.fullmatch("abc", s) is None + 23 |+s != "abc" +24 24 | +25 25 | +26 26 | # this should be replaced with `s == "abc"` + +RUF055_2.py:27:1: RUF055 [*] Plain string pattern passed to `re` function + | +26 | # this should be replaced with `s == "abc"` +27 | re.fullmatch("abc", s) is not None + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF055 + | + = help: Replace with `s == "abc"` + +ℹ Safe fix +24 24 | +25 25 | +26 26 | # this should be replaced with `s == "abc"` +27 |-re.fullmatch("abc", s) is not None + 27 |+s == "abc" +28 28 | +29 29 | +30 30 | # this should trigger an unsafe fix because of the presence of a comment within the + +RUF055_2.py:33:5: RUF055 [*] Plain string pattern passed to `re` function + | +31 | # expression being replaced (which we'd lose) +32 | if ( +33 | / re.fullmatch( +34 | | "a really really really really long string", +35 | | s, +36 | | ) +37 | | # with a comment here +38 | | is None + | |___________^ RUF055 +39 | ): +40 | pass + | + = help: Replace with `s != "a really really really really long string"` + +ℹ Unsafe fix +30 30 | # this should trigger an unsafe fix because of the presence of a comment within the +31 31 | # expression being replaced (which we'd lose) +32 32 | if ( +33 |- re.fullmatch( +34 |- "a really really really really long string", +35 |- s, +36 |- ) +37 |- # with a comment here +38 |- is None + 33 |+ s != "a really really really really long string" +39 34 | ): +40 35 | pass +41 36 | + +RUF055_2.py:46:5: RUF055 [*] Plain string pattern passed to `re` function + | +44 | # expression) +45 | if ( # leading +46 | / re.fullmatch( +47 | | "a really really really really long string", +48 | | s, +49 | | ) +50 | | is None # trailing + | |___________^ RUF055 +51 | ): +52 | pass + | + = help: Replace with `s != "a really really really really long string"` + +ℹ Safe fix +43 43 | # this should trigger a safe fix (comments are preserved given they're outside the +44 44 | # expression) +45 45 | if ( # leading +46 |- re.fullmatch( +47 |- "a really really really really long string", +48 |- s, +49 |- ) +50 |- is None # trailing + 46 |+ s != "a really really really really long string" # trailing +51 47 | ): +52 48 | pass diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF057_RUF057.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF057_RUF057.py.snap new file mode 100644 index 0000000000000..6b24910fb3c65 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF057_RUF057.py.snap @@ -0,0 +1,273 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF057.py:6:1: RUF057 [*] Value being rounded is already an integer + | +6 | round(42) # Error (safe) + | ^^^^^^^^^ RUF057 +7 | round(42, None) # Error (safe) +8 | round(42, 2) # Error (safe) + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +3 3 | +4 4 | +5 5 | +6 |-round(42) # Error (safe) + 6 |+42 # Error (safe) +7 7 | round(42, None) # Error (safe) +8 8 | round(42, 2) # Error (safe) +9 9 | round(42, -2) # No error + +RUF057.py:7:1: RUF057 [*] Value being rounded is already an integer + | +6 | round(42) # Error (safe) +7 | round(42, None) # Error (safe) + | ^^^^^^^^^^^^^^^ RUF057 +8 | round(42, 2) # Error (safe) +9 | round(42, -2) # No error + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +4 4 | +5 5 | +6 6 | round(42) # Error (safe) +7 |-round(42, None) # Error (safe) + 7 |+42 # Error (safe) +8 8 | round(42, 2) # Error (safe) +9 9 | round(42, -2) # No error +10 10 | round(42, inferred_int) # No error + +RUF057.py:8:1: RUF057 [*] Value being rounded is already an integer + | + 6 | round(42) # Error (safe) + 7 | round(42, None) # Error (safe) + 8 | round(42, 2) # Error (safe) + | ^^^^^^^^^^^^ RUF057 + 9 | round(42, -2) # No error +10 | round(42, inferred_int) # No error + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +5 5 | +6 6 | round(42) # Error (safe) +7 7 | round(42, None) # Error (safe) +8 |-round(42, 2) # Error (safe) + 8 |+42 # Error (safe) +9 9 | round(42, -2) # No error +10 10 | round(42, inferred_int) # No error +11 11 | round(42, 3 + 4) # No error + +RUF057.py:24:1: RUF057 [*] Value being rounded is already an integer + | +24 | round(4 + 2) # Error (safe) + | ^^^^^^^^^^^^ RUF057 +25 | round(4 + 2, None) # Error (safe) +26 | round(4 + 2, 2) # Error (safe) + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +21 21 | round(42., foo) # No error +22 22 | +23 23 | +24 |-round(4 + 2) # Error (safe) + 24 |+4 + 2 # Error (safe) +25 25 | round(4 + 2, None) # Error (safe) +26 26 | round(4 + 2, 2) # Error (safe) +27 27 | round(4 + 2, -2) # No error + +RUF057.py:25:1: RUF057 [*] Value being rounded is already an integer + | +24 | round(4 + 2) # Error (safe) +25 | round(4 + 2, None) # Error (safe) + | ^^^^^^^^^^^^^^^^^^ RUF057 +26 | round(4 + 2, 2) # Error (safe) +27 | round(4 + 2, -2) # No error + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +22 22 | +23 23 | +24 24 | round(4 + 2) # Error (safe) +25 |-round(4 + 2, None) # Error (safe) + 25 |+4 + 2 # Error (safe) +26 26 | round(4 + 2, 2) # Error (safe) +27 27 | round(4 + 2, -2) # No error +28 28 | round(4 + 2, inferred_int) # No error + +RUF057.py:26:1: RUF057 [*] Value being rounded is already an integer + | +24 | round(4 + 2) # Error (safe) +25 | round(4 + 2, None) # Error (safe) +26 | round(4 + 2, 2) # Error (safe) + | ^^^^^^^^^^^^^^^ RUF057 +27 | round(4 + 2, -2) # No error +28 | round(4 + 2, inferred_int) # No error + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +23 23 | +24 24 | round(4 + 2) # Error (safe) +25 25 | round(4 + 2, None) # Error (safe) +26 |-round(4 + 2, 2) # Error (safe) + 26 |+4 + 2 # Error (safe) +27 27 | round(4 + 2, -2) # No error +28 28 | round(4 + 2, inferred_int) # No error +29 29 | round(4 + 2, 3 + 4) # No error + +RUF057.py:42:1: RUF057 [*] Value being rounded is already an integer + | +42 | round(inferred_int) # Error (unsafe) + | ^^^^^^^^^^^^^^^^^^^ RUF057 +43 | round(inferred_int, None) # Error (unsafe) +44 | round(inferred_int, 2) # Error (unsafe) + | + = help: Remove unnecessary `round` call + +ℹ Unsafe fix +39 39 | round(4. + 2., foo) # No error +40 40 | +41 41 | +42 |-round(inferred_int) # Error (unsafe) + 42 |+inferred_int # Error (unsafe) +43 43 | round(inferred_int, None) # Error (unsafe) +44 44 | round(inferred_int, 2) # Error (unsafe) +45 45 | round(inferred_int, -2) # No error + +RUF057.py:43:1: RUF057 [*] Value being rounded is already an integer + | +42 | round(inferred_int) # Error (unsafe) +43 | round(inferred_int, None) # Error (unsafe) + | ^^^^^^^^^^^^^^^^^^^^^^^^^ RUF057 +44 | round(inferred_int, 2) # Error (unsafe) +45 | round(inferred_int, -2) # No error + | + = help: Remove unnecessary `round` call + +ℹ Unsafe fix +40 40 | +41 41 | +42 42 | round(inferred_int) # Error (unsafe) +43 |-round(inferred_int, None) # Error (unsafe) + 43 |+inferred_int # Error (unsafe) +44 44 | round(inferred_int, 2) # Error (unsafe) +45 45 | round(inferred_int, -2) # No error +46 46 | round(inferred_int, inferred_int) # No error + +RUF057.py:44:1: RUF057 [*] Value being rounded is already an integer + | +42 | round(inferred_int) # Error (unsafe) +43 | round(inferred_int, None) # Error (unsafe) +44 | round(inferred_int, 2) # Error (unsafe) + | ^^^^^^^^^^^^^^^^^^^^^^ RUF057 +45 | round(inferred_int, -2) # No error +46 | round(inferred_int, inferred_int) # No error + | + = help: Remove unnecessary `round` call + +ℹ Unsafe fix +41 41 | +42 42 | round(inferred_int) # Error (unsafe) +43 43 | round(inferred_int, None) # Error (unsafe) +44 |-round(inferred_int, 2) # Error (unsafe) + 44 |+inferred_int # Error (unsafe) +45 45 | round(inferred_int, -2) # No error +46 46 | round(inferred_int, inferred_int) # No error +47 47 | round(inferred_int, 3 + 4) # No error + +RUF057.py:71:1: RUF057 [*] Value being rounded is already an integer + | +69 | # contains newline. +70 | # See https://github.com/astral-sh/ruff/issues/15598 +71 | / round(- +72 | | 1) + | |__^ RUF057 +73 | round(1 +74 | *1 + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +68 68 | # Fixes should preserve parentheses when argument +69 69 | # contains newline. +70 70 | # See https://github.com/astral-sh/ruff/issues/15598 +71 |-round(- + 71 |+(- +72 72 | 1) +73 73 | round(1 +74 74 | *1 + +RUF057.py:73:1: RUF057 [*] Value being rounded is already an integer + | +71 | round(- +72 | 1) +73 | / round(1 +74 | | *1 +75 | | ) + | |_^ RUF057 +76 | +77 | # fix should be unsafe if comment is in call range + | + = help: Remove unnecessary `round` call + +ℹ Safe fix +70 70 | # See https://github.com/astral-sh/ruff/issues/15598 +71 71 | round(- +72 72 | 1) +73 |-round(1 +74 |-*1 +75 |-) + 73 |+(1 + 74 |+*1) +76 75 | +77 76 | # fix should be unsafe if comment is in call range +78 77 | round(# a comment + +RUF057.py:78:1: RUF057 [*] Value being rounded is already an integer + | +77 | # fix should be unsafe if comment is in call range +78 | / round(# a comment +79 | | 17 +80 | | ) + | |_^ RUF057 +81 | round( +82 | 17 # a comment + | + = help: Remove unnecessary `round` call + +ℹ Unsafe fix +75 75 | ) +76 76 | +77 77 | # fix should be unsafe if comment is in call range +78 |-round(# a comment +79 78 | 17 +80 |-) +81 79 | round( +82 80 | 17 # a comment +83 81 | ) + +RUF057.py:81:1: RUF057 [*] Value being rounded is already an integer + | +79 | 17 +80 | ) +81 | / round( +82 | | 17 # a comment +83 | | ) + | |_^ RUF057 + | + = help: Remove unnecessary `round` call + +ℹ Unsafe fix +78 78 | round(# a comment +79 79 | 17 +80 80 | ) +81 |-round( +82 |- 17 # a comment +83 |-) + 81 |+17 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_0.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_0.py.snap new file mode 100644 index 0000000000000..4316cc714ac19 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_0.py.snap @@ -0,0 +1,222 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF058_0.py:7:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +5 | # Errors +6 | +7 | starmap(func, zip()) + | ^^^^^^^^^^^^^^^^^^^^ RUF058 +8 | starmap(func, zip([])) + | + = help: Use `map` instead + +ℹ Safe fix +4 4 | +5 5 | # Errors +6 6 | +7 |-starmap(func, zip()) + 7 |+map(func, []) +8 8 | starmap(func, zip([])) +9 9 | +10 10 | + +RUF058_0.py:8:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +7 | starmap(func, zip()) +8 | starmap(func, zip([])) + | ^^^^^^^^^^^^^^^^^^^^^^ RUF058 + | + = help: Use `map` instead + +ℹ Safe fix +5 5 | # Errors +6 6 | +7 7 | starmap(func, zip()) +8 |-starmap(func, zip([])) + 8 |+map(func, []) +9 9 | +10 10 | +11 11 | starmap(func, zip(a, b, c,),) + +RUF058_0.py:11:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +11 | starmap(func, zip(a, b, c,),) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF058 + | + = help: Use `map` instead + +ℹ Safe fix +8 8 | starmap(func, zip([])) +9 9 | +10 10 | +11 |-starmap(func, zip(a, b, c,),) + 11 |+map(func, a, b, c,) +12 12 | +13 13 | +14 14 | starmap( + +RUF058_0.py:14:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +14 | / starmap( +15 | | func, # Foo +16 | | zip( +17 | | # Foo +18 | | +19 | | ) +20 | | ) + | |_^ RUF058 +21 | +22 | ( # Foo + | + = help: Use `map` instead + +ℹ Unsafe fix +11 11 | starmap(func, zip(a, b, c,),) +12 12 | +13 13 | +14 |-starmap( + 14 |+map( +15 15 | func, # Foo +16 |- zip( + 16 |+ [] +17 17 | # Foo +18 18 | +19 |- ) + 19 |+ +20 20 | ) +21 21 | +22 22 | ( # Foo + +RUF058_0.py:22:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +20 | ) +21 | +22 | / ( # Foo +23 | | itertools +24 | | ) . starmap ( +25 | | +26 | | func, zip ( +27 | | a, b, c, +28 | | ), +29 | | ) + | |_^ RUF058 +30 | +31 | ( # Foobar + | + = help: Use `map` instead + +ℹ Unsafe fix +19 19 | ) +20 20 | ) +21 21 | +22 |-( # Foo +23 |- itertools +24 |- ) . starmap ( + 22 |+map ( +25 23 | +26 |- func, zip ( + 24 |+ func, +27 25 | a, b, c, +28 |- ), + 26 |+ +29 27 | ) +30 28 | +31 29 | ( # Foobar + +RUF058_0.py:31:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +29 | ) +30 | +31 | / ( # Foobar +32 | | ( starmap ) +33 | | # Bazqux +34 | | ) \ +35 | | (func, +36 | | ( ( +37 | | ( # Zip +38 | | ( +39 | | ( zip +40 | | # Zip +41 | | ) +42 | | ) +43 | | ) +44 | | (a, # A +45 | | b, # B +46 | | c, # C +47 | | ) ) +48 | | ), +49 | | ) + | |_^ RUF058 +50 | +51 | starmap( + | + = help: Use `map` instead + +ℹ Unsafe fix +29 29 | ) +30 30 | +31 31 | ( # Foobar +32 |- ( starmap ) + 32 |+ ( map ) +33 33 | # Bazqux +34 34 | ) \ +35 35 | (func, +36 |- ( ( +37 |- ( # Zip +38 |- ( +39 |- ( zip +40 |- # Zip +41 |- ) +42 |- ) +43 |- ) +44 |- (a, # A + 36 |+ + 37 |+ a, # A +45 38 | b, # B +46 39 | c, # C +47 |- ) ) +48 |- ), + 40 |+ +49 41 | ) +50 42 | +51 43 | starmap( + +RUF058_0.py:51:1: RUF058 [*] `itertools.starmap` called on `zip` iterable + | +49 | ) +50 | +51 | / starmap( +52 | | func \ +53 | | , \ +54 | | zip \ +55 | | ( +56 | | a,\ +57 | | b,\ +58 | | c,\ +59 | | ) +60 | | ) + | |_^ RUF058 + | + = help: Use `map` instead + +ℹ Safe fix +48 48 | ), +49 49 | ) +50 50 | +51 |-starmap( + 51 |+map( +52 52 | func \ +53 53 | , \ +54 |- zip \ +55 |- ( + 54 |+ \ + 55 |+ +56 56 | a,\ +57 57 | b,\ +58 58 | c,\ +59 |- ) + 59 |+ +60 60 | ) +61 61 | +62 62 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_1.py.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_1.py.snap new file mode 100644 index 0000000000000..49f3892fd4486 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF058_RUF058_1.py.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF058_1.py:10:10: RUF058 `itertools.starmap` called on `zip` iterable + | + 9 | map = {} +10 | for _ in starmap(print, zip("A", "12")): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF058 +11 | pass + | + = help: Use `map` instead diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview_confusables.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview_confusables.snap index 46ac0fafeb4a9..be9d27b76f689 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview_confusables.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview_confusables.snap @@ -39,7 +39,7 @@ confusables.py:26:10: RUF001 String contains ambiguous `α` (GREEK SMALL LETTER 25 | # contains ASCII. 26 | x = "βα Bαd" | ^ RUF001 -27 | +27 | 28 | # The two characters should be flagged here. The first character is a "word" | @@ -49,7 +49,7 @@ confusables.py:31:6: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LET 30 | # boundary" (whitespace) that it itself ambiguous. 31 | x = "Р усский" | ^ RUF001 -32 | +32 | 33 | # Same test cases as above but using f-strings instead: | @@ -59,7 +59,7 @@ confusables.py:31:7: RUF001 String contains ambiguous ` ` (EN QUAD). Did you m 30 | # boundary" (whitespace) that it itself ambiguous. 31 | x = "Р усский" | ^ RUF001 -32 | +32 | 33 | # Same test cases as above but using f-strings instead: | @@ -87,7 +87,7 @@ confusables.py:38:7: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LET 37 | x = f"βα Bαd" 38 | x = f"Р усский" | ^ RUF001 -39 | +39 | 40 | # Nested f-strings | @@ -97,7 +97,7 @@ confusables.py:38:8: RUF001 String contains ambiguous ` ` (EN QUAD). Did you m 37 | x = f"βα Bαd" 38 | x = f"Р усский" | ^ RUF001 -39 | +39 | 40 | # Nested f-strings | @@ -106,7 +106,7 @@ confusables.py:41:7: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -115,7 +115,7 @@ confusables.py:41:21: RUF001 String contains ambiguous ` ` (EN QUAD). Did you 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -124,7 +124,7 @@ confusables.py:41:25: RUF001 String contains ambiguous `Р` (CYRILLIC CAPITAL LE 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -133,7 +133,7 @@ confusables.py:41:26: RUF001 String contains ambiguous ` ` (EN QUAD). Did you 40 | # Nested f-strings 41 | x = f"𝐁ad string {f" {f"Р усский"}"}" | ^ RUF001 -42 | +42 | 43 | # Comments inside f-strings | @@ -159,7 +159,7 @@ confusables.py:55:28: RUF001 String contains ambiguous `µ` (MICRO SIGN). Did yo | 55 | assert getattr(Labware(), "µL") == 1.5 | ^ RUF001 -56 | +56 | 57 | # Implicit string concatenation | @@ -168,6 +168,8 @@ confusables.py:58:6: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 57 | # Implicit string concatenation 58 | x = "𝐁ad" f"𝐁ad string" | ^ RUF001 +59 | +60 | from typing import Literal | confusables.py:58:13: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD CAPITAL B). Did you mean `B` (LATIN CAPITAL LETTER B)? @@ -175,4 +177,13 @@ confusables.py:58:13: RUF001 String contains ambiguous `𝐁` (MATHEMATICAL BOLD 57 | # Implicit string concatenation 58 | x = "𝐁ad" f"𝐁ad string" | ^ RUF001 +59 | +60 | from typing import Literal + | + +confusables.py:61:20: RUF001 String contains ambiguous `ﮨ` (ARABIC LETTER HEH GOAL INITIAL FORM). Did you mean `o` (LATIN SMALL LETTER O)? + | +60 | from typing import Literal +61 | x: '''"""'Literal["ﮨ"]'"""''' + | ^ RUF001 | diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__redirects.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__redirects.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__redirects.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__redirects.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0.snap index 4832895a7074b..b4fc07e49ec1d 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0.snap @@ -25,7 +25,7 @@ RUF100_0.py:13:12: RUF100 [*] Unused `noqa` directive (unused: `E501`) 12 | # Invalid 13 | d = 1 # noqa: E501 | ^^^^^^^^^^^^ RUF100 -14 | +14 | 15 | # Invalid | = help: Remove unused `noqa` directive @@ -45,7 +45,7 @@ RUF100_0.py:16:12: RUF100 [*] Unused `noqa` directive (unused: `F841`, `E501`) 15 | # Invalid 16 | d = 1 # noqa: F841, E501 | ^^^^^^^^^^^^^^^^^^ RUF100 -17 | +17 | 18 | # Invalid (and unimplemented or not enabled) | = help: Remove unused `noqa` directive @@ -65,7 +65,7 @@ RUF100_0.py:19:12: RUF100 [*] Unused `noqa` directive (unused: `F841`, `W191`; n 18 | # Invalid (and unimplemented or not enabled) 19 | d = 1 # noqa: F841, W191, F821 | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -20 | +20 | 21 | # Invalid (but external) | = help: Remove unused `noqa` directive @@ -85,7 +85,7 @@ RUF100_0.py:22:12: RUF100 [*] Unused `noqa` directive (unused: `F841`) 21 | # Invalid (but external) 22 | d = 1 # noqa: F841, V101 | ^^^^^^^^^^^^^^^^^^ RUF100 -23 | +23 | 24 | # Invalid (but external) | = help: Remove unused `noqa` directive @@ -105,7 +105,7 @@ RUF100_0.py:25:12: RUF100 [*] Unused `noqa` directive (unknown: `V500`) 24 | # Invalid (but external) 25 | d = 1 # noqa: V500 | ^^^^^^^^^^^^ RUF100 -26 | +26 | 27 | # fmt: off | = help: Remove unused `noqa` directive @@ -126,7 +126,7 @@ RUF100_0.py:29:12: RUF100 [*] Unused `noqa` directive (unused: `E501`) 28 | # Invalid - no space before # 29 | d = 1 # noqa: E501 | ^^^^^^^^^^^^ RUF100 -30 | +30 | 31 | # Invalid - many spaces before # | = help: Remove unused `noqa` directive @@ -183,7 +183,7 @@ RUF100_0.py:58:6: RUF100 [*] Unused `noqa` directive (unused: `F841`) 57 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 58 | """ # noqa: E501, F841 | ^^^^^^^^^^^^^^^^^^ RUF100 -59 | +59 | 60 | # Invalid | = help: Remove unused `noqa` directive @@ -203,7 +203,7 @@ RUF100_0.py:66:6: RUF100 [*] Unused `noqa` directive (unused: `E501`) 65 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. 66 | """ # noqa: E501 | ^^^^^^^^^^^^ RUF100 -67 | +67 | 68 | # Invalid | = help: Remove unused `noqa` directive @@ -223,7 +223,7 @@ RUF100_0.py:74:6: RUF100 [*] Unused blanket `noqa` directive 73 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. 74 | """ # noqa | ^^^^^^ RUF100 -75 | +75 | 76 | # Valid | = help: Remove unused `noqa` directive @@ -260,7 +260,7 @@ RUF100_0.py:88:8: F401 [*] `shelve` imported but unused RUF100_0.py:93:89: E501 Line too long (89 > 88) | 91 | print(sys.path) -92 | +92 | 93 | "shape: (6,)\nSeries: '' [duration[μs]]\n[\n\t0µs\n\t1µs\n\t2µs\n\t3µs\n\t4µs\n\t5µs\n]" # noqa: F401 | ^ E501 | @@ -268,7 +268,7 @@ RUF100_0.py:93:89: E501 Line too long (89 > 88) RUF100_0.py:93:92: RUF100 [*] Unused `noqa` directive (unused: `F401`) | 91 | print(sys.path) -92 | +92 | 93 | "shape: (6,)\nSeries: '' [duration[μs]]\n[\n\t0µs\n\t1µs\n\t2µs\n\t3µs\n\t4µs\n\t5µs\n]" # noqa: F401 | ^^^^^^^^^^^^ RUF100 | @@ -347,7 +347,7 @@ RUF100_0.py:118:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`; unkn 117 | def f(): 118 | x = 2 # noqa: F841, F841, X200 | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -119 | +119 | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 | = help: Remove unused `noqa` directive @@ -365,10 +365,10 @@ RUF100_0.py:118:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`; unkn RUF100_0.py:120:19: RUF100 [*] Unused `noqa` directive (duplicated: `SIM300`, `SIM300`) | 118 | x = 2 # noqa: F841, F841, X200 -119 | +119 | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -121 | +121 | 122 | z = 2 # noqa: F841 F841 F841, F841, F841 | = help: Remove unused `noqa` directive @@ -386,10 +386,10 @@ RUF100_0.py:120:19: RUF100 [*] Unused `noqa` directive (duplicated: `SIM300`, `S RUF100_0.py:122:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`, `F841`, `F841`, `F841`) | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 -121 | +121 | 122 | z = 2 # noqa: F841 F841 F841, F841, F841 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -123 | +123 | 124 | return | = help: Remove unused `noqa` directive diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0_prefix.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0_prefix.snap index 10d49089c3dc9..68c0809458083 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0_prefix.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_0_prefix.snap @@ -25,7 +25,7 @@ RUF100_0.py:13:12: RUF100 [*] Unused `noqa` directive (unused: `E501`) 12 | # Invalid 13 | d = 1 # noqa: E501 | ^^^^^^^^^^^^ RUF100 -14 | +14 | 15 | # Invalid | = help: Remove unused `noqa` directive @@ -45,7 +45,7 @@ RUF100_0.py:16:12: RUF100 [*] Unused `noqa` directive (unused: `F841`, `E501`) 15 | # Invalid 16 | d = 1 # noqa: F841, E501 | ^^^^^^^^^^^^^^^^^^ RUF100 -17 | +17 | 18 | # Invalid (and unimplemented or not enabled) | = help: Remove unused `noqa` directive @@ -65,7 +65,7 @@ RUF100_0.py:19:12: RUF100 [*] Unused `noqa` directive (unused: `F841`, `W191`; n 18 | # Invalid (and unimplemented or not enabled) 19 | d = 1 # noqa: F841, W191, F821 | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -20 | +20 | 21 | # Invalid (but external) | = help: Remove unused `noqa` directive @@ -85,7 +85,7 @@ RUF100_0.py:22:12: RUF100 [*] Unused `noqa` directive (unused: `F841`) 21 | # Invalid (but external) 22 | d = 1 # noqa: F841, V101 | ^^^^^^^^^^^^^^^^^^ RUF100 -23 | +23 | 24 | # Invalid (but external) | = help: Remove unused `noqa` directive @@ -106,7 +106,7 @@ RUF100_0.py:29:12: RUF100 [*] Unused `noqa` directive (unused: `E501`) 28 | # Invalid - no space before # 29 | d = 1 # noqa: E501 | ^^^^^^^^^^^^ RUF100 -30 | +30 | 31 | # Invalid - many spaces before # | = help: Remove unused `noqa` directive @@ -163,7 +163,7 @@ RUF100_0.py:58:6: RUF100 [*] Unused `noqa` directive (unused: `F841`) 57 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 58 | """ # noqa: E501, F841 | ^^^^^^^^^^^^^^^^^^ RUF100 -59 | +59 | 60 | # Invalid | = help: Remove unused `noqa` directive @@ -183,7 +183,7 @@ RUF100_0.py:66:6: RUF100 [*] Unused `noqa` directive (unused: `E501`) 65 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. 66 | """ # noqa: E501 | ^^^^^^^^^^^^ RUF100 -67 | +67 | 68 | # Invalid | = help: Remove unused `noqa` directive @@ -203,7 +203,7 @@ RUF100_0.py:74:6: RUF100 [*] Unused blanket `noqa` directive 73 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. 74 | """ # noqa | ^^^^^^ RUF100 -75 | +75 | 76 | # Valid | = help: Remove unused `noqa` directive @@ -240,7 +240,7 @@ RUF100_0.py:88:8: F401 [*] `shelve` imported but unused RUF100_0.py:93:89: E501 Line too long (89 > 88) | 91 | print(sys.path) -92 | +92 | 93 | "shape: (6,)\nSeries: '' [duration[μs]]\n[\n\t0µs\n\t1µs\n\t2µs\n\t3µs\n\t4µs\n\t5µs\n]" # noqa: F401 | ^ E501 | @@ -248,7 +248,7 @@ RUF100_0.py:93:89: E501 Line too long (89 > 88) RUF100_0.py:93:92: RUF100 [*] Unused `noqa` directive (unused: `F401`) | 91 | print(sys.path) -92 | +92 | 93 | "shape: (6,)\nSeries: '' [duration[μs]]\n[\n\t0µs\n\t1µs\n\t2µs\n\t3µs\n\t4µs\n\t5µs\n]" # noqa: F401 | ^^^^^^^^^^^^ RUF100 | @@ -327,7 +327,7 @@ RUF100_0.py:118:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`; unkn 117 | def f(): 118 | x = 2 # noqa: F841, F841, X200 | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -119 | +119 | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 | = help: Remove unused `noqa` directive @@ -345,10 +345,10 @@ RUF100_0.py:118:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`; unkn RUF100_0.py:120:19: RUF100 [*] Unused `noqa` directive (duplicated: `SIM300`, `SIM300`) | 118 | x = 2 # noqa: F841, F841, X200 -119 | +119 | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -121 | +121 | 122 | z = 2 # noqa: F841 F841 F841, F841, F841 | = help: Remove unused `noqa` directive @@ -366,10 +366,10 @@ RUF100_0.py:120:19: RUF100 [*] Unused `noqa` directive (duplicated: `SIM300`, `S RUF100_0.py:122:12: RUF100 [*] Unused `noqa` directive (duplicated: `F841`, `F841`, `F841`, `F841`) | 120 | y = 2 == bar # noqa: SIM300, F841, SIM300, SIM300 -121 | +121 | 122 | z = 2 # noqa: F841 F841 F841, F841, F841 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 -123 | +123 | 124 | return | = help: Remove unused `noqa` directive diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_1.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_1.snap index bd0aaf365a2cf..967b7a5d3b862 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_1.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_1.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF100_1.py:37:9: F401 [*] `typing.Union` imported but unused | @@ -150,5 +151,3 @@ RUF100_1.py:89:55: RUF100 [*] Unused `noqa` directive (non-enabled: `F501`) 88 88 | # This should mark F501 as unused. 89 |- from typing import Awaitable, AwaitableGenerator # noqa: F501 89 |+ from typing import Awaitable, AwaitableGenerator - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_2.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_2.snap index 4eef8cdef37e6..d4ea19a5df52a 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_2.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_2.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- RUF100_2.py:1:19: RUF100 [*] Unused `noqa` directive (unused: `F401`) | @@ -11,5 +12,3 @@ RUF100_2.py:1:19: RUF100 [*] Unused `noqa` directive (unused: `F401`) ℹ Safe fix 1 |-import itertools # noqa: F401 1 |+import itertools - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_3.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_3.snap index 1ccfc73987d4e..f0918df155b84 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_3.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_3.snap @@ -141,7 +141,7 @@ RUF100_3.py:7:10: RUF100 [*] Unused blanket `noqa` directive RUF100_3.py:14:1: RUF100 [*] Unused `noqa` directive (unused: `E501`, `F821`) | 12 | print(a) # noqa comment -13 | +13 | 14 | # noqa: E501, F821 | ^^^^^^^^^^^^^^^^^^ RUF100 15 | # noqa: E501, F821 # comment @@ -344,7 +344,7 @@ RUF100_3.py:23:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) 23 |+print(a) # noqa: F821 # comment 24 24 | print(a) # noqa: E501, F821 comment 25 25 | print(a) # noqa: E501, F821 comment -26 26 | +26 26 | print(a) # noqa: E501,,F821 comment RUF100_3.py:24:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) | @@ -353,6 +353,7 @@ RUF100_3.py:24:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) 24 | print(a) # noqa: E501, F821 comment | ^^^^^^^^^^^^^^^^^^ RUF100 25 | print(a) # noqa: E501, F821 comment +26 | print(a) # noqa: E501,,F821 comment | = help: Remove unused `noqa` directive @@ -363,8 +364,8 @@ RUF100_3.py:24:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) 24 |-print(a) # noqa: E501, F821 comment 24 |+print(a) # noqa: F821 comment 25 25 | print(a) # noqa: E501, F821 comment -26 26 | -27 27 | print(a) # comment with unicode µ # noqa: E501 +26 26 | print(a) # noqa: E501,,F821 comment +27 27 | print(a) # noqa: E501, ,F821 comment RUF100_3.py:25:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) | @@ -372,8 +373,8 @@ RUF100_3.py:25:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) 24 | print(a) # noqa: E501, F821 comment 25 | print(a) # noqa: E501, F821 comment | ^^^^^^^^^^^^^^^^^^ RUF100 -26 | -27 | print(a) # comment with unicode µ # noqa: E501 +26 | print(a) # noqa: E501,,F821 comment +27 | print(a) # noqa: E501, ,F821 comment | = help: Remove unused `noqa` directive @@ -383,48 +384,110 @@ RUF100_3.py:25:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) 24 24 | print(a) # noqa: E501, F821 comment 25 |-print(a) # noqa: E501, F821 comment 25 |+print(a) # noqa: F821 comment -26 26 | -27 27 | print(a) # comment with unicode µ # noqa: E501 -28 28 | print(a) # comment with unicode µ # noqa: E501, F821 +26 26 | print(a) # noqa: E501,,F821 comment +27 27 | print(a) # noqa: E501, ,F821 comment +28 28 | print(a) # noqa: E501 F821 comment -RUF100_3.py:27:7: F821 Undefined name `a` +RUF100_3.py:26:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) | +24 | print(a) # noqa: E501, F821 comment 25 | print(a) # noqa: E501, F821 comment -26 | -27 | print(a) # comment with unicode µ # noqa: E501 - | ^ F821 -28 | print(a) # comment with unicode µ # noqa: E501, F821 +26 | print(a) # noqa: E501,,F821 comment + | ^^^^^^^^^^^^^^^^^^ RUF100 +27 | print(a) # noqa: E501, ,F821 comment +28 | print(a) # noqa: E501 F821 comment | + = help: Remove unused `noqa` directive -RUF100_3.py:27:39: RUF100 [*] Unused `noqa` directive (unused: `E501`) +ℹ Safe fix +23 23 | print(a) # noqa: E501, F821 # comment +24 24 | print(a) # noqa: E501, F821 comment +25 25 | print(a) # noqa: E501, F821 comment +26 |-print(a) # noqa: E501,,F821 comment + 26 |+print(a) # noqa: F821 comment +27 27 | print(a) # noqa: E501, ,F821 comment +28 28 | print(a) # noqa: E501 F821 comment +29 29 | + +RUF100_3.py:27:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) | 25 | print(a) # noqa: E501, F821 comment -26 | -27 | print(a) # comment with unicode µ # noqa: E501 - | ^^^^^^^^^^^^ RUF100 -28 | print(a) # comment with unicode µ # noqa: E501, F821 +26 | print(a) # noqa: E501,,F821 comment +27 | print(a) # noqa: E501, ,F821 comment + | ^^^^^^^^^^^^^^^^^^^ RUF100 +28 | print(a) # noqa: E501 F821 comment | = help: Remove unused `noqa` directive ℹ Safe fix 24 24 | print(a) # noqa: E501, F821 comment 25 25 | print(a) # noqa: E501, F821 comment -26 26 | -27 |-print(a) # comment with unicode µ # noqa: E501 - 27 |+print(a) # comment with unicode µ -28 28 | print(a) # comment with unicode µ # noqa: E501, F821 +26 26 | print(a) # noqa: E501,,F821 comment +27 |-print(a) # noqa: E501, ,F821 comment + 27 |+print(a) # noqa: F821 comment +28 28 | print(a) # noqa: E501 F821 comment +29 29 | +30 30 | print(a) # comment with unicode µ # noqa: E501 + +RUF100_3.py:28:11: RUF100 [*] Unused `noqa` directive (unused: `E501`) + | +26 | print(a) # noqa: E501,,F821 comment +27 | print(a) # noqa: E501, ,F821 comment +28 | print(a) # noqa: E501 F821 comment + | ^^^^^^^^^^^^^^^^^ RUF100 +29 | +30 | print(a) # comment with unicode µ # noqa: E501 + | + = help: Remove unused `noqa` directive + +ℹ Safe fix +25 25 | print(a) # noqa: E501, F821 comment +26 26 | print(a) # noqa: E501,,F821 comment +27 27 | print(a) # noqa: E501, ,F821 comment +28 |-print(a) # noqa: E501 F821 comment + 28 |+print(a) # noqa: F821 comment +29 29 | +30 30 | print(a) # comment with unicode µ # noqa: E501 +31 31 | print(a) # comment with unicode µ # noqa: E501, F821 + +RUF100_3.py:30:7: F821 Undefined name `a` + | +28 | print(a) # noqa: E501 F821 comment +29 | +30 | print(a) # comment with unicode µ # noqa: E501 + | ^ F821 +31 | print(a) # comment with unicode µ # noqa: E501, F821 + | -RUF100_3.py:28:39: RUF100 [*] Unused `noqa` directive (unused: `E501`) +RUF100_3.py:30:39: RUF100 [*] Unused `noqa` directive (unused: `E501`) | -27 | print(a) # comment with unicode µ # noqa: E501 -28 | print(a) # comment with unicode µ # noqa: E501, F821 +28 | print(a) # noqa: E501 F821 comment +29 | +30 | print(a) # comment with unicode µ # noqa: E501 + | ^^^^^^^^^^^^ RUF100 +31 | print(a) # comment with unicode µ # noqa: E501, F821 + | + = help: Remove unused `noqa` directive + +ℹ Safe fix +27 27 | print(a) # noqa: E501, ,F821 comment +28 28 | print(a) # noqa: E501 F821 comment +29 29 | +30 |-print(a) # comment with unicode µ # noqa: E501 + 30 |+print(a) # comment with unicode µ +31 31 | print(a) # comment with unicode µ # noqa: E501, F821 + +RUF100_3.py:31:39: RUF100 [*] Unused `noqa` directive (unused: `E501`) + | +30 | print(a) # comment with unicode µ # noqa: E501 +31 | print(a) # comment with unicode µ # noqa: E501, F821 | ^^^^^^^^^^^^^^^^^^ RUF100 | = help: Remove unused `noqa` directive ℹ Safe fix -25 25 | print(a) # noqa: E501, F821 comment -26 26 | -27 27 | print(a) # comment with unicode µ # noqa: E501 -28 |-print(a) # comment with unicode µ # noqa: E501, F821 - 28 |+print(a) # comment with unicode µ # noqa: F821 +28 28 | print(a) # noqa: E501 F821 comment +29 29 | +30 30 | print(a) # comment with unicode µ # noqa: E501 +31 |-print(a) # comment with unicode µ # noqa: E501, F821 + 31 |+print(a) # comment with unicode µ # noqa: F821 diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_4.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_4.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_4.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_4.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_5.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_5.snap index 23e5840e5720c..05d515713a9c7 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_5.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruf100_5.snap @@ -24,7 +24,7 @@ RUF100_5.py:11:1: ERA001 Found commented-out code | 11 | #import os # noqa: E501 | ^^^^^^^^^^^^^^^^^^^^^^^^ ERA001 -12 | +12 | 13 | def f(): | = help: Remove commented-out code @@ -42,7 +42,7 @@ RUF100_5.py:11:13: RUF100 [*] Unused `noqa` directive (unused: `E501`) | 11 | #import os # noqa: E501 | ^^^^^^^^^^^^ RUF100 -12 | +12 | 13 | def f(): | = help: Remove unused `noqa` directive @@ -63,7 +63,7 @@ RUF100_5.py:16:18: RUF100 [*] Unused `noqa` directive (non-enabled: `RET504`) 15 | # line below should autofix to `return data # fmt: skip` 16 | return data # noqa: RET504 # fmt: skip | ^^^^^^^^^^^^^^ RUF100 -17 | +17 | 18 | def f(): | = help: Remove unused `noqa` directive diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_all.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_all.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_all.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_all.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_codes.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_codes.snap index 32744177506e0..8762e87e47973 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_codes.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_codes.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- ruff_noqa_codes.py:8:5: F841 [*] Local variable `x` is assigned to but never used | @@ -15,5 +16,3 @@ ruff_noqa_codes.py:8:5: F841 [*] Local variable `x` is assigned to but never use 7 7 | def f(): 8 |- x = 1 8 |+ pass - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused.snap new file mode 100644 index 0000000000000..1a570501c1491 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused.snap @@ -0,0 +1,13 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF100_6.py:1:1: RUF100 [*] Unused `noqa` directive (non-enabled: `F841`) + | +1 | # ruff: noqa: F841 -- intentional unused file directive; will be removed + | ^^^^^^^^^^^^^^^^^^ RUF100 + | + = help: Remove unused `noqa` directive + +ℹ Safe fix +1 |-# ruff: noqa: F841 -- intentional unused file directive; will be removed + 1 |+ diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused_last_of_many.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused_last_of_many.snap new file mode 100644 index 0000000000000..49022bf759212 --- /dev/null +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_filedirective_unused_last_of_many.snap @@ -0,0 +1,33 @@ +--- +source: crates/ruff_linter/src/rules/ruff/mod.rs +--- +RUF100_7.py:1:1: RUF100 [*] Unused `noqa` directive (unused: `E501`) + | +1 | # flake8: noqa: F841, E501 -- used followed by unused code + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 +2 | # ruff: noqa: E701, F541 -- unused followed by used code + | + = help: Remove unused `noqa` directive + +ℹ Safe fix +1 |-# flake8: noqa: F841, E501 -- used followed by unused code + 1 |+# flake8: noqa: F841 -- used followed by unused code +2 2 | # ruff: noqa: E701, F541 -- unused followed by used code +3 3 | +4 4 | + +RUF100_7.py:2:1: RUF100 [*] Unused `noqa` directive (non-enabled: `E701`) + | +1 | # flake8: noqa: F841, E501 -- used followed by unused code +2 | # ruff: noqa: E701, F541 -- unused followed by used code + | ^^^^^^^^^^^^^^^^^^^^^^^^ RUF100 + | + = help: Remove unused `noqa` directive + +ℹ Safe fix +1 1 | # flake8: noqa: F841, E501 -- used followed by unused code +2 |-# ruff: noqa: E701, F541 -- unused followed by used code + 2 |+# ruff: noqa: F541 -- unused followed by used code +3 3 | +4 4 | +5 5 | def a(): diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_invalid.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_invalid.snap index 7161b11be3c2b..2b7f08191c3fc 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_invalid.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_noqa_invalid.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- ruff_noqa_invalid.py:1:8: F401 [*] `os` imported but unused | @@ -28,5 +29,3 @@ ruff_noqa_invalid.py:5:5: F841 [*] Local variable `x` is assigned to but never u 4 4 | def f(): 5 |- x = 1 5 |+ pass - - diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores_empty.snap b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores_empty.snap index 7f58cfd7246a3..b3a37c0921109 100644 --- a/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores_empty.snap +++ b/crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__ruff_per_file_ignores_empty.snap @@ -1,4 +1,5 @@ --- source: crates/ruff_linter/src/rules/ruff/mod.rs +snapshot_kind: text --- diff --git a/crates/ruff_linter/src/rules/ruff/typing.rs b/crates/ruff_linter/src/rules/ruff/typing.rs index 08fde21b31a70..3c650bfe0bb69 100644 --- a/crates/ruff_linter/src/rules/ruff/typing.rs +++ b/crates/ruff_linter/src/rules/ruff/typing.rs @@ -10,10 +10,10 @@ use crate::checkers::ast::Checker; /// /// A known type is either a builtin type, any object from the standard library, /// or a type from the `typing_extensions` module. -fn is_known_type(qualified_name: &QualifiedName, minor_version: u8) -> bool { +fn is_known_type(qualified_name: &QualifiedName, version: ast::PythonVersion) -> bool { match qualified_name.segments() { ["" | "typing_extensions", ..] => true, - [module, ..] => is_known_standard_library(minor_version, module), + [module, ..] => is_known_standard_library(version.minor, module), _ => false, } } @@ -42,19 +42,19 @@ enum TypingTarget<'a> { ForwardReference(&'a Expr), /// A `typing.Union` type e.g., `Union[int, str]`. - Union(&'a Expr), + Union(Option<&'a Expr>), /// A PEP 604 union type e.g., `int | str`. PEP604Union(&'a Expr, &'a Expr), /// A `typing.Literal` type e.g., `Literal[1, 2, 3]`. - Literal(&'a Expr), + Literal(Option<&'a Expr>), /// A `typing.Optional` type e.g., `Optional[int]`. - Optional(&'a Expr), + Optional(Option<&'a Expr>), /// A `typing.Annotated` type e.g., `Annotated[int, ...]`. - Annotated(&'a Expr), + Annotated(Option<&'a Expr>), /// The `typing.Hashable` type. Hashable, @@ -70,7 +70,11 @@ enum TypingTarget<'a> { } impl<'a> TypingTarget<'a> { - fn try_from_expr(expr: &'a Expr, checker: &'a Checker, minor_version: u8) -> Option<Self> { + fn try_from_expr( + expr: &'a Expr, + checker: &'a Checker, + version: ast::PythonVersion, + ) -> Option<Self> { let semantic = checker.semantic(); match expr { Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { @@ -80,18 +84,18 @@ impl<'a> TypingTarget<'a> { Some(TypingTarget::Unknown), |qualified_name| { if semantic.match_typing_qualified_name(&qualified_name, "Optional") { - Some(TypingTarget::Optional(slice.as_ref())) + Some(TypingTarget::Optional(Some(slice.as_ref()))) } else if semantic.match_typing_qualified_name(&qualified_name, "Literal") { - Some(TypingTarget::Literal(slice.as_ref())) + Some(TypingTarget::Literal(Some(slice.as_ref()))) } else if semantic.match_typing_qualified_name(&qualified_name, "Union") { - Some(TypingTarget::Union(slice.as_ref())) + Some(TypingTarget::Union(Some(slice.as_ref()))) } else if semantic.match_typing_qualified_name(&qualified_name, "Annotated") { - resolve_slice_value(slice.as_ref()) - .next() - .map(TypingTarget::Annotated) + Some(TypingTarget::Annotated( + resolve_slice_value(slice.as_ref()).next(), + )) } else { - if is_known_type(&qualified_name, minor_version) { + if is_known_type(&qualified_name, version) { Some(TypingTarget::Known) } else { Some(TypingTarget::Unknown) @@ -109,7 +113,7 @@ impl<'a> TypingTarget<'a> { Expr::NoneLiteral(_) => Some(TypingTarget::None), Expr::StringLiteral(string_expr) => checker .parse_type_annotation(string_expr) - .as_ref() + .ok() .map(|parsed_annotation| { TypingTarget::ForwardReference(parsed_annotation.expression()) }), @@ -118,7 +122,15 @@ impl<'a> TypingTarget<'a> { // same file, so we assume it's `Any` as it could be a type alias. Some(TypingTarget::Unknown), |qualified_name| { - if semantic.match_typing_qualified_name(&qualified_name, "Any") { + if semantic.match_typing_qualified_name(&qualified_name, "Optional") { + Some(TypingTarget::Optional(None)) + } else if semantic.match_typing_qualified_name(&qualified_name, "Literal") { + Some(TypingTarget::Literal(None)) + } else if semantic.match_typing_qualified_name(&qualified_name, "Union") { + Some(TypingTarget::Union(None)) + } else if semantic.match_typing_qualified_name(&qualified_name, "Annotated") { + Some(TypingTarget::Annotated(None)) + } else if semantic.match_typing_qualified_name(&qualified_name, "Any") { Some(TypingTarget::Any) } else if matches!(qualified_name.segments(), ["" | "builtins", "object"]) { Some(TypingTarget::Object) @@ -129,7 +141,7 @@ impl<'a> TypingTarget<'a> { ) { Some(TypingTarget::Hashable) - } else if !is_known_type(&qualified_name, minor_version) { + } else if !is_known_type(&qualified_name, version) { // If it's not a known type, we assume it's `Any`. Some(TypingTarget::Unknown) } else { @@ -141,7 +153,7 @@ impl<'a> TypingTarget<'a> { } /// Check if the [`TypingTarget`] explicitly allows `None`. - fn contains_none(&self, checker: &Checker, minor_version: u8) -> bool { + fn contains_none(&self, checker: &Checker, version: ast::PythonVersion) -> bool { match self { TypingTarget::None | TypingTarget::Optional(_) @@ -150,46 +162,42 @@ impl<'a> TypingTarget<'a> { | TypingTarget::Object | TypingTarget::Unknown => true, TypingTarget::Known => false, - TypingTarget::Literal(slice) => resolve_slice_value(slice).any(|element| { - // Literal can only contain `None`, a literal value, other `Literal` - // or an enum value. - match TypingTarget::try_from_expr(element, checker, minor_version) { - None | Some(TypingTarget::None) => true, - Some(new_target @ TypingTarget::Literal(_)) => { - new_target.contains_none(checker, minor_version) + TypingTarget::Literal(slice) => slice.is_some_and(|slice| { + resolve_slice_value(slice).any(|element| { + // Literal can only contain `None`, a literal value, other `Literal` + // or an enum value. + match TypingTarget::try_from_expr(element, checker, version) { + None | Some(TypingTarget::None) => true, + Some(new_target @ TypingTarget::Literal(_)) => { + new_target.contains_none(checker, version) + } + _ => false, } - _ => false, - } + }) }), - TypingTarget::Union(slice) => resolve_slice_value(slice).any(|element| { - TypingTarget::try_from_expr(element, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_none(checker, minor_version) - }) + TypingTarget::Union(slice) => slice.is_some_and(|slice| { + resolve_slice_value(slice).any(|element| { + TypingTarget::try_from_expr(element, checker, version) + .is_none_or(|new_target| new_target.contains_none(checker, version)) + }) }), TypingTarget::PEP604Union(left, right) => [left, right].iter().any(|element| { - TypingTarget::try_from_expr(element, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_none(checker, minor_version) - }) + TypingTarget::try_from_expr(element, checker, version) + .is_none_or(|new_target| new_target.contains_none(checker, version)) + }), + TypingTarget::Annotated(expr) => expr.is_some_and(|expr| { + TypingTarget::try_from_expr(expr, checker, version) + .is_none_or(|new_target| new_target.contains_none(checker, version)) }), - TypingTarget::Annotated(expr) => { - TypingTarget::try_from_expr(expr, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_none(checker, minor_version) - }) - } TypingTarget::ForwardReference(expr) => { - TypingTarget::try_from_expr(expr, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_none(checker, minor_version) - }) + TypingTarget::try_from_expr(expr, checker, version) + .is_none_or(|new_target| new_target.contains_none(checker, version)) } } } /// Check if the [`TypingTarget`] explicitly allows `Any`. - fn contains_any(&self, checker: &Checker, minor_version: u8) -> bool { + fn contains_any(&self, checker: &Checker, version: ast::PythonVersion) -> bool { match self { TypingTarget::Any => true, // `Literal` cannot contain `Any` as it's a dynamic value. @@ -199,29 +207,25 @@ impl<'a> TypingTarget<'a> { | TypingTarget::Object | TypingTarget::Known | TypingTarget::Unknown => false, - TypingTarget::Union(slice) => resolve_slice_value(slice).any(|element| { - TypingTarget::try_from_expr(element, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_any(checker, minor_version) - }) + TypingTarget::Union(slice) => slice.is_some_and(|slice| { + resolve_slice_value(slice).any(|element| { + TypingTarget::try_from_expr(element, checker, version) + .is_none_or(|new_target| new_target.contains_any(checker, version)) + }) }), TypingTarget::PEP604Union(left, right) => [left, right].iter().any(|element| { - TypingTarget::try_from_expr(element, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_any(checker, minor_version) - }) + TypingTarget::try_from_expr(element, checker, version) + .is_none_or(|new_target| new_target.contains_any(checker, version)) }), TypingTarget::Annotated(expr) | TypingTarget::Optional(expr) => { - TypingTarget::try_from_expr(expr, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_any(checker, minor_version) - }) + expr.is_some_and(|expr| { + TypingTarget::try_from_expr(expr, checker, version) + .is_none_or(|new_target| new_target.contains_any(checker, version)) + }) } TypingTarget::ForwardReference(expr) => { - TypingTarget::try_from_expr(expr, checker, minor_version) - .map_or(true, |new_target| { - new_target.contains_any(checker, minor_version) - }) + TypingTarget::try_from_expr(expr, checker, version) + .is_none_or(|new_target| new_target.contains_any(checker, version)) } } } @@ -237,9 +241,9 @@ impl<'a> TypingTarget<'a> { pub(crate) fn type_hint_explicitly_allows_none<'a>( annotation: &'a Expr, checker: &'a Checker, - minor_version: u8, + version: ast::PythonVersion, ) -> Option<&'a Expr> { - match TypingTarget::try_from_expr(annotation, checker, minor_version) { + match TypingTarget::try_from_expr(annotation, checker, version) { None | // Short circuit on top level `None`, `Any` or `Optional` Some(TypingTarget::None | TypingTarget::Optional(_) | TypingTarget::Any) => None, @@ -248,14 +252,13 @@ pub(crate) fn type_hint_explicitly_allows_none<'a>( // is found nested inside another type, then the outer type should // be returned. Some(TypingTarget::Annotated(expr)) => { - type_hint_explicitly_allows_none(expr, checker, minor_version) + expr.and_then(|expr| type_hint_explicitly_allows_none(expr, checker, version)) } Some(target) => { - if target.contains_none(checker, minor_version) { - None - } else { - Some(annotation) + if target.contains_none(checker, version) { + return None; } + Some(annotation) } } } @@ -266,48 +269,53 @@ pub(crate) fn type_hint_explicitly_allows_none<'a>( pub(crate) fn type_hint_resolves_to_any( annotation: &Expr, checker: &Checker, - minor_version: u8, + version: ast::PythonVersion, ) -> bool { - match TypingTarget::try_from_expr(annotation, checker, minor_version) { - None | - // Short circuit on top level `Any` - Some(TypingTarget::Any) => true, + match TypingTarget::try_from_expr(annotation, checker, version) { + // Short circuit on top level `Any` + None | Some(TypingTarget::Any) => true, + // `Optional` is `Optional[Any]` which is `Any | None`. + Some(TypingTarget::Optional(None)) => true, // Top-level `Annotated` node should check if the inner type resolves // to `Any`. Some(TypingTarget::Annotated(expr)) => { - type_hint_resolves_to_any(expr, checker, minor_version) + expr.is_some_and(|expr| type_hint_resolves_to_any(expr, checker, version)) } - Some(target) => target.contains_any(checker, minor_version), + Some(target) => target.contains_any(checker, version), } } #[cfg(test)] mod tests { use super::is_known_type; + use ruff_python_ast as ast; use ruff_python_ast::name::QualifiedName; #[test] fn test_is_known_type() { - assert!(is_known_type(&QualifiedName::builtin("int"), 11)); + assert!(is_known_type( + &QualifiedName::builtin("int"), + ast::PythonVersion::PY311 + )); assert!(is_known_type( &QualifiedName::from_iter(["builtins", "int"]), - 11 + ast::PythonVersion::PY311 )); assert!(is_known_type( &QualifiedName::from_iter(["typing", "Optional"]), - 11 + ast::PythonVersion::PY311 )); assert!(is_known_type( &QualifiedName::from_iter(["typing_extensions", "Literal"]), - 11 + ast::PythonVersion::PY311 )); assert!(is_known_type( &QualifiedName::from_iter(["zoneinfo", "ZoneInfo"]), - 11 + ast::PythonVersion::PY311 )); assert!(!is_known_type( &QualifiedName::from_iter(["zoneinfo", "ZoneInfo"]), - 8 + ast::PythonVersion::PY38 )); } } diff --git a/crates/ruff_linter/src/rules/tryceratops/helpers.rs b/crates/ruff_linter/src/rules/tryceratops/helpers.rs index 7b07240c20a39..ed18c29fdc2f7 100644 --- a/crates/ruff_linter/src/rules/tryceratops/helpers.rs +++ b/crates/ruff_linter/src/rules/tryceratops/helpers.rs @@ -1,8 +1,8 @@ use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, ExceptHandler, Expr}; -use ruff_python_semantic::analyze::logging; use ruff_python_semantic::SemanticModel; +use ruff_python_semantic::analyze::logging; use ruff_python_stdlib::logging::LoggingLevel; /// Collect `logging`-like calls from an AST. @@ -22,7 +22,7 @@ impl<'a, 'b> LoggerCandidateVisitor<'a, 'b> { } } -impl<'a, 'b> Visitor<'b> for LoggerCandidateVisitor<'a, 'b> { +impl<'b> Visitor<'b> for LoggerCandidateVisitor<'_, 'b> { fn visit_expr(&mut self, expr: &'b Expr) { if let Expr::Call(call) = expr { match call.func.as_ref() { @@ -31,7 +31,7 @@ impl<'a, 'b> Visitor<'b> for LoggerCandidateVisitor<'a, 'b> { { if let Some(logging_level) = LoggingLevel::from_attribute(attr) { self.calls.push((call, logging_level)); - }; + } } } Expr::Name(_) => { diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/error_instead_of_exception.rs b/crates/ruff_linter/src/rules/tryceratops/rules/error_instead_of_exception.rs index b98c71452a9f8..dadbaa807c06d 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/error_instead_of_exception.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/error_instead_of_exception.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Applicability, Diagnostic, Edit, Fix, FixAvailability, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor::Visitor; use ruff_python_ast::{self as ast, ExceptHandler, Expr}; use ruff_python_semantic::analyze::logging::exc_info; @@ -51,24 +51,24 @@ use crate::rules::tryceratops::helpers::LoggerCandidateVisitor; /// /// ## References /// - [Python documentation: `logging.exception`](https://docs.python.org/3/library/logging.html#logging.exception) -#[violation] -pub struct ErrorInsteadOfException; +#[derive(ViolationMetadata)] +pub(crate) struct ErrorInsteadOfException; impl Violation for ErrorInsteadOfException { const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; #[derive_message_formats] fn message(&self) -> String { - format!("Use `logging.exception` instead of `logging.error`") + "Use `logging.exception` instead of `logging.error`".to_string() } fn fix_title(&self) -> Option<String> { - Some(format!("Replace with `exception`")) + Some("Replace with `exception`".to_string()) } } /// TRY400 -pub(crate) fn error_instead_of_exception(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn error_instead_of_exception(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { body, .. }) = handler; let calls = { @@ -135,7 +135,7 @@ pub(crate) fn error_instead_of_exception(checker: &mut Checker, handlers: &[Exce _ => {} } - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_args.rs b/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_args.rs index d21371efb5373..05cb8020b47ff 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_args.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_args.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{self as ast, Arguments, Expr}; use ruff_text_size::Ranged; @@ -43,18 +43,18 @@ use crate::checkers::ast::Checker; /// if x < 0: /// raise CantBeNegative(x) /// ``` -#[violation] -pub struct RaiseVanillaArgs; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseVanillaArgs; impl Violation for RaiseVanillaArgs { #[derive_message_formats] fn message(&self) -> String { - format!("Avoid specifying long messages outside the exception class") + "Avoid specifying long messages outside the exception class".to_string() } } /// TRY003 -pub(crate) fn raise_vanilla_args(checker: &mut Checker, expr: &Expr) { +pub(crate) fn raise_vanilla_args(checker: &Checker, expr: &Expr) { let Expr::Call(ast::ExprCall { func, arguments: Arguments { args, .. }, @@ -78,9 +78,7 @@ pub(crate) fn raise_vanilla_args(checker: &mut Checker, expr: &Expr) { } if contains_message(arg) { - checker - .diagnostics - .push(Diagnostic::new(RaiseVanillaArgs, expr.range())); + checker.report_diagnostic(Diagnostic::new(RaiseVanillaArgs, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_class.rs b/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_class.rs index 5dd288182b620..5f189ab4a37f3 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_class.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/raise_vanilla_class.rs @@ -1,8 +1,8 @@ -use ruff_python_ast::helpers::map_callable; use ruff_python_ast::Expr; +use ruff_python_ast::helpers::map_callable; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -52,18 +52,18 @@ use crate::checkers::ast::Checker; /// except Exception: /// logger.error("Oops") /// ``` -#[violation] -pub struct RaiseVanillaClass; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseVanillaClass; impl Violation for RaiseVanillaClass { #[derive_message_formats] fn message(&self) -> String { - format!("Create your own exception") + "Create your own exception".to_string() } } /// TRY002 -pub(crate) fn raise_vanilla_class(checker: &mut Checker, expr: &Expr) { +pub(crate) fn raise_vanilla_class(checker: &Checker, expr: &Expr) { if checker .semantic() .resolve_qualified_name(map_callable(expr)) @@ -74,8 +74,6 @@ pub(crate) fn raise_vanilla_class(checker: &mut Checker, expr: &Expr) { ) }) { - checker - .diagnostics - .push(Diagnostic::new(RaiseVanillaClass, expr.range())); + checker.report_diagnostic(Diagnostic::new(RaiseVanillaClass, expr.range())); } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/raise_within_try.rs b/crates/ruff_linter/src/rules/tryceratops/rules/raise_within_try.rs index c578468b28af0..6ac0172744608 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/raise_within_try.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/raise_within_try.rs @@ -1,11 +1,11 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::{ comparable::ComparableExpr, helpers::{self, map_callable}, - statement_visitor::{walk_stmt, StatementVisitor}, + statement_visitor::{StatementVisitor, walk_stmt}, }; use ruff_text_size::Ranged; @@ -49,13 +49,13 @@ use crate::checkers::ast::Checker; /// except ValueError: /// raise /// ``` -#[violation] -pub struct RaiseWithinTry; +#[derive(ViolationMetadata)] +pub(crate) struct RaiseWithinTry; impl Violation for RaiseWithinTry { #[derive_message_formats] fn message(&self) -> String { - format!("Abstract `raise` to an inner function") + "Abstract `raise` to an inner function".to_string() } } @@ -75,7 +75,7 @@ impl<'a> StatementVisitor<'a> for RaiseStatementVisitor<'a> { } /// TRY301 -pub(crate) fn raise_within_try(checker: &mut Checker, body: &[Stmt], handlers: &[ExceptHandler]) { +pub(crate) fn raise_within_try(checker: &Checker, body: &[Stmt], handlers: &[ExceptHandler]) { if handlers.is_empty() { return; } @@ -115,9 +115,7 @@ pub(crate) fn raise_within_try(checker: &mut Checker, body: &[Stmt], handlers: & .is_some_and(|builtin| matches!(builtin, "Exception" | "BaseException")) }) { - checker - .diagnostics - .push(Diagnostic::new(RaiseWithinTry, stmt.range())); + checker.report_diagnostic(Diagnostic::new(RaiseWithinTry, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/reraise_no_cause.rs b/crates/ruff_linter/src/rules/tryceratops/rules/reraise_no_cause.rs index 0de0ae4249d57..2470e5a1f6a1b 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/reraise_no_cause.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/reraise_no_cause.rs @@ -1,5 +1,5 @@ use ruff_diagnostics::Violation; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; /// ## Removed /// This rule is identical to [B904] which should be used instead. @@ -35,13 +35,13 @@ use ruff_macros::{derive_message_formats, violation}; /// - [Python documentation: Exception context](https://docs.python.org/3/library/exceptions.html#exception-context) /// /// [B904]: https://docs.astral.sh/ruff/rules/raise-without-from-inside-except/ -#[violation] -pub struct ReraiseNoCause; +#[derive(ViolationMetadata)] +pub(crate) struct ReraiseNoCause; /// TRY200 impl Violation for ReraiseNoCause { #[derive_message_formats] fn message(&self) -> String { - format!("Use `raise from` to specify exception cause") + "Use `raise from` to specify exception cause".to_string() } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/try_consider_else.rs b/crates/ruff_linter/src/rules/tryceratops/rules/try_consider_else.rs index c9dc566f5d432..87839a4e72457 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/try_consider_else.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/try_consider_else.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::contains_effect; use ruff_text_size::Ranged; @@ -12,8 +12,10 @@ use crate::checkers::ast::Checker; /// /// ## Why is this bad? /// The `try`-`except` statement has an `else` clause for code that should -/// run _only_ if no exceptions were raised. Using the `else` clause is more -/// explicit than using a `return` statement inside of a `try` block. +/// run _only_ if no exceptions were raised. Returns in `try` blocks may +/// exhibit confusing or unwanted behavior, such as being overridden by +/// control flow in `except` and `finally` blocks, or unintentionally +/// suppressing an exception. /// /// ## Example /// ```python @@ -46,19 +48,19 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: Errors and Exceptions](https://docs.python.org/3/tutorial/errors.html) -#[violation] -pub struct TryConsiderElse; +#[derive(ViolationMetadata)] +pub(crate) struct TryConsiderElse; impl Violation for TryConsiderElse { #[derive_message_formats] fn message(&self) -> String { - format!("Consider moving this statement to an `else` block") + "Consider moving this statement to an `else` block".to_string() } } /// TRY300 pub(crate) fn try_consider_else( - checker: &mut Checker, + checker: &Checker, body: &[Stmt], orelse: &[Stmt], handler: &[ExceptHandler], @@ -71,9 +73,7 @@ pub(crate) fn try_consider_else( return; } } - checker - .diagnostics - .push(Diagnostic::new(TryConsiderElse, stmt.range())); + checker.report_diagnostic(Diagnostic::new(TryConsiderElse, stmt.range())); } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/type_check_without_type_error.rs b/crates/ruff_linter/src/rules/tryceratops/rules/type_check_without_type_error.rs index 002fac596cb4c..c84f2238fded9 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/type_check_without_type_error.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/type_check_without_type_error.rs @@ -1,7 +1,7 @@ use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::helpers::map_callable; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_python_ast::{self as ast, Expr, Stmt, StmtIf}; use ruff_python_semantic::SemanticModel; use ruff_text_size::Ranged; @@ -35,13 +35,13 @@ use crate::checkers::ast::Checker; /// /// ## References /// - [Python documentation: `TypeError`](https://docs.python.org/3/library/exceptions.html#TypeError) -#[violation] -pub struct TypeCheckWithoutTypeError; +#[derive(ViolationMetadata)] +pub(crate) struct TypeCheckWithoutTypeError; impl Violation for TypeCheckWithoutTypeError { #[derive_message_formats] fn message(&self) -> String { - format!("Prefer `TypeError` exception for invalid type") + "Prefer `TypeError` exception for invalid type".to_string() } } @@ -92,16 +92,14 @@ fn check_type_check_test(semantic: &SemanticModel, test: &Expr) -> bool { } } -fn check_raise(checker: &mut Checker, exc: &Expr, item: &Stmt) { +fn check_raise(checker: &Checker, exc: &Expr, item: &Stmt) { if is_builtin_exception(exc, checker.semantic()) { - checker - .diagnostics - .push(Diagnostic::new(TypeCheckWithoutTypeError, item.range())); + checker.report_diagnostic(Diagnostic::new(TypeCheckWithoutTypeError, item.range())); } } /// Search the body of an if-condition for raises. -fn check_body(checker: &mut Checker, body: &[Stmt]) { +fn check_body(checker: &Checker, body: &[Stmt]) { for item in body { if has_control_flow(item) { return; @@ -145,7 +143,7 @@ fn is_builtin_exception(expr: &Expr, semantic: &SemanticModel) -> bool { /// TRY004 pub(crate) fn type_check_without_type_error( - checker: &mut Checker, + checker: &Checker, stmt_if: &StmtIf, parent: Option<&Stmt>, ) { diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/useless_try_except.rs b/crates/ruff_linter/src/rules/tryceratops/rules/useless_try_except.rs index e7deefb77fb40..199685480eb37 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/useless_try_except.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/useless_try_except.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, ExceptHandlerExceptHandler, Expr, Stmt}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -28,45 +28,42 @@ use crate::checkers::ast::Checker; /// def foo(): /// bar() /// ``` -#[violation] -pub struct UselessTryExcept; +#[derive(ViolationMetadata)] +pub(crate) struct UselessTryExcept; impl Violation for UselessTryExcept { #[derive_message_formats] fn message(&self) -> String { - format!("Remove exception handler; error is immediately re-raised") + "Remove exception handler; error is immediately re-raised".to_string() } } /// TRY203 (previously TRY302) -pub(crate) fn useless_try_except(checker: &mut Checker, handlers: &[ExceptHandler]) { - if let Some(diagnostics) = handlers - .iter() - .map(|handler| { - let ExceptHandler::ExceptHandler(ExceptHandlerExceptHandler { name, body, .. }) = - handler; - let Some(Stmt::Raise(ast::StmtRaise { - exc, cause: None, .. - })) = &body.first() - else { - return None; - }; - if let Some(expr) = exc { - // E.g., `except ... as e: raise e` - if let Expr::Name(ast::ExprName { id, .. }) = expr.as_ref() { - if name.as_ref().is_some_and(|name| name.as_str() == id) { - return Some(Diagnostic::new(UselessTryExcept, handler.range())); - } +pub(crate) fn useless_try_except(checker: &Checker, handlers: &[ExceptHandler]) { + if handlers.iter().all(|handler| { + let ExceptHandler::ExceptHandler(ExceptHandlerExceptHandler { name, body, .. }) = handler; + let Some(Stmt::Raise(ast::StmtRaise { + exc, cause: None, .. + })) = &body.first() + else { + return false; + }; + if let Some(expr) = exc { + // E.g., `except ... as e: raise e` + if let Expr::Name(ast::ExprName { id, .. }) = expr.as_ref() { + if name.as_ref().is_some_and(|name| name.as_str() == id) { + return true; } - None - } else { - // E.g., `except ...: raise` - Some(Diagnostic::new(UselessTryExcept, handler.range())) } - }) - .collect::<Option<Vec<_>>>() - { + false + } else { + // E.g., `except ...: raise` + true + } + }) { // Require that all handlers are useless, but create one diagnostic per handler. - checker.diagnostics.extend(diagnostics); + for handler in handlers { + checker.report_diagnostic(Diagnostic::new(UselessTryExcept, handler.range())); + } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/verbose_log_message.rs b/crates/ruff_linter/src/rules/tryceratops/rules/verbose_log_message.rs index 6af91307067f4..252d3c5562e75 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/verbose_log_message.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/verbose_log_message.rs @@ -1,7 +1,7 @@ use ruff_python_ast::{self as ast, ExceptHandler, Expr}; use ruff_diagnostics::{Diagnostic, Violation}; -use ruff_macros::{derive_message_formats, violation}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; use ruff_python_ast::visitor; use ruff_python_ast::visitor::Visitor; use ruff_python_stdlib::logging::LoggingLevel; @@ -33,18 +33,18 @@ use crate::rules::tryceratops::helpers::LoggerCandidateVisitor; /// except ValueError: /// logger.exception("Found an error") /// ``` -#[violation] -pub struct VerboseLogMessage; +#[derive(ViolationMetadata)] +pub(crate) struct VerboseLogMessage; impl Violation for VerboseLogMessage { #[derive_message_formats] fn message(&self) -> String { - format!("Redundant exception object included in `logging.exception` call") + "Redundant exception object included in `logging.exception` call".to_string() } } /// TRY401 -pub(crate) fn verbose_log_message(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn verbose_log_message(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { body, .. }) = handler; @@ -78,9 +78,7 @@ pub(crate) fn verbose_log_message(checker: &mut Checker, handlers: &[ExceptHandl }; let binding = checker.semantic().binding(id); if binding.kind.is_bound_exception() { - checker - .diagnostics - .push(Diagnostic::new(VerboseLogMessage, expr.range())); + checker.report_diagnostic(Diagnostic::new(VerboseLogMessage, expr.range())); } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/rules/verbose_raise.rs b/crates/ruff_linter/src/rules/tryceratops/rules/verbose_raise.rs index 132459592c6bb..008748680f016 100644 --- a/crates/ruff_linter/src/rules/tryceratops/rules/verbose_raise.rs +++ b/crates/ruff_linter/src/rules/tryceratops/rules/verbose_raise.rs @@ -1,8 +1,8 @@ use ruff_python_ast::{self as ast, ExceptHandler, Expr, Stmt}; use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; -use ruff_macros::{derive_message_formats, violation}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_macros::{ViolationMetadata, derive_message_formats}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; use ruff_text_size::Ranged; use crate::checkers::ast::Checker; @@ -35,22 +35,22 @@ use crate::checkers::ast::Checker; /// ## Fix safety /// This rule's fix is marked as unsafe, as it doesn't properly handle bound /// exceptions that are shadowed between the `except` and `raise` statements. -#[violation] -pub struct VerboseRaise; +#[derive(ViolationMetadata)] +pub(crate) struct VerboseRaise; impl AlwaysFixableViolation for VerboseRaise { #[derive_message_formats] fn message(&self) -> String { - format!("Use `raise` without specifying exception name") + "Use `raise` without specifying exception name".to_string() } fn fix_title(&self) -> String { - format!("Remove exception name") + "Remove exception name".to_string() } } /// TRY201 -pub(crate) fn verbose_raise(checker: &mut Checker, handlers: &[ExceptHandler]) { +pub(crate) fn verbose_raise(checker: &Checker, handlers: &[ExceptHandler]) { for handler in handlers { // If the handler assigned a name to the exception... if let ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { @@ -77,7 +77,7 @@ pub(crate) fn verbose_raise(checker: &mut Checker, handlers: &[ExceptHandler]) { "raise".to_string(), raise.range(), ))); - checker.diagnostics.push(diagnostic); + checker.report_diagnostic(diagnostic); } } } diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__error-instead-of-exception_TRY400.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__error-instead-of-exception_TRY400.py.snap index 1cc91d6730fee..9e60594d46032 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__error-instead-of-exception_TRY400.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__error-instead-of-exception_TRY400.py.snap @@ -7,7 +7,7 @@ TRY400.py:13:9: TRY400 [*] Use `logging.exception` instead of `logging.error` 12 | except Exception: 13 | logging.error("Context message here") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY400 -14 | +14 | 15 | if True: | = help: Replace with `exception` @@ -46,7 +46,7 @@ TRY400.py:27:9: TRY400 [*] Use `logging.exception` instead of `logging.error` 26 | except Exception: 27 | logger.error("Context message here") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY400 -28 | +28 | 29 | if True: | = help: Replace with `exception` @@ -85,7 +85,7 @@ TRY400.py:37:9: TRY400 [*] Use `logging.exception` instead of `logging.error` 36 | except Exception: 37 | log.error("Context message here") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY400 -38 | +38 | 39 | if True: | = help: Replace with `exception` @@ -124,7 +124,7 @@ TRY400.py:47:9: TRY400 [*] Use `logging.exception` instead of `logging.error` 46 | except Exception: 47 | self.logger.error("Context message here") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY400 -48 | +48 | 49 | if True: | = help: Replace with `exception` @@ -163,7 +163,7 @@ TRY400.py:100:9: TRY400 [*] Use `logging.exception` instead of `logging.error` 99 | except Exception: 100 | error("Context message here") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY400 -101 | +101 | 102 | if True: | = help: Replace with `exception` diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-args_TRY003.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-args_TRY003.py.snap index 23b37ca793311..9c8bf58daf544 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-args_TRY003.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-args_TRY003.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/tryceratops/mod.rs +snapshot_kind: text --- TRY003.py:8:15: TRY003 Avoid specifying long messages outside the exception class | @@ -34,5 +35,3 @@ TRY003.py:44:15: TRY003 Avoid specifying long messages outside the exception cla 44 | raise BadArgCantBeEven("The argument `a` should not be odd.") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY003 | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-class_TRY002.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-class_TRY002.py.snap index 4950b2e853f52..0df21137063fe 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-class_TRY002.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-vanilla-class_TRY002.py.snap @@ -7,7 +7,7 @@ TRY002.py:13:15: TRY002 Create your own exception 12 | if a == 1: 13 | raise Exception("Custom message") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY002 -14 | +14 | 15 | b = 1 | @@ -25,7 +25,7 @@ TRY002.py:37:15: TRY002 Create your own exception 36 | if a == 1: 37 | raise BaseException("Custom message") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY002 -38 | +38 | 39 | b = 1 | @@ -36,5 +36,3 @@ TRY002.py:41:15: TRY002 Create your own exception 41 | raise BaseException | ^^^^^^^^^^^^^ TRY002 | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-within-try_TRY301.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-within-try_TRY301.py.snap index f89e2f4b5366e..707345cf44296 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-within-try_TRY301.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__raise-within-try_TRY301.py.snap @@ -7,17 +7,17 @@ TRY301.py:14:13: TRY301 Abstract `raise` to an inner function 13 | if not a: 14 | raise MyException(a) | ^^^^^^^^^^^^^^^^^^^^ TRY301 -15 | +15 | 16 | raise MyException(a) | TRY301.py:16:9: TRY301 Abstract `raise` to an inner function | 14 | raise MyException(a) -15 | +15 | 16 | raise MyException(a) | ^^^^^^^^^^^^^^^^^^^^ TRY301 -17 | +17 | 18 | try: | @@ -37,17 +37,17 @@ TRY301.py:32:13: TRY301 Abstract `raise` to an inner function 31 | if not a: 32 | raise MyException(a) | ^^^^^^^^^^^^^^^^^^^^ TRY301 -33 | +33 | 34 | raise MyException(a) | TRY301.py:34:9: TRY301 Abstract `raise` to an inner function | 32 | raise MyException(a) -33 | +33 | 34 | raise MyException(a) | ^^^^^^^^^^^^^^^^^^^^ TRY301 -35 | +35 | 36 | try: | @@ -60,5 +60,3 @@ TRY301.py:39:17: TRY301 Abstract `raise` to an inner function 40 | except* Exception: 41 | logger.exception("something failed") | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__try-consider-else_TRY300.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__try-consider-else_TRY300.py.snap index 3217f019c2d32..1e5761ed6e27c 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__try-consider-else_TRY300.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__try-consider-else_TRY300.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/tryceratops/mod.rs +snapshot_kind: text --- TRY300.py:20:9: TRY300 Consider moving this statement to an `else` block | @@ -10,5 +11,3 @@ TRY300.py:20:9: TRY300 Consider moving this statement to an `else` block 21 | except MyException: 22 | logger.exception("process failed") | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__type-check-without-type-error_TRY004.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__type-check-without-type-error_TRY004.py.snap index 014682e8e9217..1400f13f981b1 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__type-check-without-type-error_TRY004.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__type-check-without-type-error_TRY004.py.snap @@ -93,8 +93,7 @@ TRY004.py:95:9: TRY004 Prefer `TypeError` exception for invalid type | 93 | # should be typeerror 94 | # not multiline is on purpose for fix -95 | raise MemoryError( - | _________^ +95 | / raise MemoryError( 96 | | "..." 97 | | ) | |_________^ TRY004 @@ -295,5 +294,3 @@ TRY004.py:316:9: TRY004 Prefer `TypeError` exception for invalid type 316 | raise Exception(f"Unknown object type: {obj.__class__.__name__}") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TRY004 | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__useless-try-except_TRY203.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__useless-try-except_TRY203.py.snap index 6dc6ab7348c41..9f150810bf46d 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__useless-try-except_TRY203.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__useless-try-except_TRY203.py.snap @@ -5,11 +5,10 @@ TRY203.py:12:5: TRY203 Remove exception handler; error is immediately re-raised | 10 | try: 11 | process() -12 | except Exception: - | _____^ +12 | / except Exception: 13 | | raise | |_____________^ TRY203 -14 | +14 | 15 | def bad(): | @@ -17,12 +16,11 @@ TRY203.py:18:5: TRY203 Remove exception handler; error is immediately re-raised | 16 | try: 17 | process() -18 | except Exception: - | _____^ +18 | / except Exception: 19 | | raise 20 | | print("this code is pointless!") | |________________________________________^ TRY203 -21 | +21 | 22 | def bad(): | @@ -30,12 +28,11 @@ TRY203.py:25:5: TRY203 Remove exception handler; error is immediately re-raised | 23 | try: 24 | process() -25 | except: - | _____^ +25 | / except: 26 | | # I am a comment, not a statement! 27 | | raise | |_____________^ TRY203 -28 | +28 | 29 | def bad(): | @@ -43,11 +40,10 @@ TRY203.py:32:5: TRY203 Remove exception handler; error is immediately re-raised | 30 | try: 31 | process() -32 | except Exception: - | _____^ +32 | / except Exception: 33 | | raise | |_____________^ TRY203 -34 | +34 | 35 | def bad(): | @@ -55,11 +51,10 @@ TRY203.py:38:5: TRY203 Remove exception handler; error is immediately re-raised | 36 | try: 37 | process() -38 | except Exception as e: - | _____^ +38 | / except Exception as e: 39 | | raise | |_____________^ TRY203 -40 | +40 | 41 | def bad(): | @@ -67,11 +62,10 @@ TRY203.py:44:5: TRY203 Remove exception handler; error is immediately re-raised | 42 | try: 43 | process() -44 | except Exception as e: - | _____^ +44 | / except Exception as e: 45 | | raise e | |_______________^ TRY203 -46 | +46 | 47 | def bad(): | @@ -79,8 +73,7 @@ TRY203.py:50:5: TRY203 Remove exception handler; error is immediately re-raised | 48 | try: 49 | process() -50 | except MyException: - | _____^ +50 | / except MyException: 51 | | raise | |_____________^ TRY203 52 | except Exception: @@ -91,11 +84,10 @@ TRY203.py:52:5: TRY203 Remove exception handler; error is immediately re-raised | 50 | except MyException: 51 | raise -52 | except Exception: - | _____^ +52 | / except Exception: 53 | | raise | |_____________^ TRY203 -54 | +54 | 55 | def bad(): | @@ -103,8 +95,7 @@ TRY203.py:58:5: TRY203 Remove exception handler; error is immediately re-raised | 56 | try: 57 | process() -58 | except MyException as e: - | _____^ +58 | / except MyException as e: 59 | | raise e | |_______________^ TRY203 60 | except Exception as e: @@ -115,11 +106,10 @@ TRY203.py:60:5: TRY203 Remove exception handler; error is immediately re-raised | 58 | except MyException as e: 59 | raise e -60 | except Exception as e: - | _____^ +60 | / except Exception as e: 61 | | raise e | |_______________^ TRY203 -62 | +62 | 63 | def bad(): | @@ -127,8 +117,7 @@ TRY203.py:66:5: TRY203 Remove exception handler; error is immediately re-raised | 64 | try: 65 | process() -66 | except MyException as ex: - | _____^ +66 | / except MyException as ex: 67 | | raise ex | |________________^ TRY203 68 | except Exception as e: @@ -139,10 +128,9 @@ TRY203.py:68:5: TRY203 Remove exception handler; error is immediately re-raised | 66 | except MyException as ex: 67 | raise ex -68 | except Exception as e: - | _____^ +68 | / except Exception as e: 69 | | raise e | |_______________^ TRY203 -70 | +70 | 71 | def fine(): | diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-log-message_TRY401.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-log-message_TRY401.py.snap index 3f71c86e70cdc..ddb8fc15bb7e9 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-log-message_TRY401.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-log-message_TRY401.py.snap @@ -54,7 +54,7 @@ TRY401.py:24:45: TRY401 Redundant exception object included in `logging.exceptio 23 | logger.exception(f"Found an error: {bad}") # TRY401 24 | logger.exception(f"Found an error: {bad}") # TRY401 | ^^^ TRY401 -25 | +25 | 26 | if True: | @@ -142,7 +142,7 @@ TRY401.py:93:38: TRY401 Redundant exception object included in `logging.exceptio 92 | exception(f"Found an error: {bad}") # TRY401 93 | exception(f"Found an error: {bad}") # TRY401 | ^^^ TRY401 -94 | +94 | 95 | if True: | @@ -192,5 +192,3 @@ TRY401.py:150:49: TRY401 Redundant exception object included in `logging.excepti 150 | logger.exception(f"Found an error: {ex}") # TRY401 | ^^ TRY401 | - - diff --git a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-raise_TRY201.py.snap b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-raise_TRY201.py.snap index 558c2c91ac299..b8383947f30f4 100644 --- a/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-raise_TRY201.py.snap +++ b/crates/ruff_linter/src/rules/tryceratops/snapshots/ruff_linter__rules__tryceratops__tests__verbose-raise_TRY201.py.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_linter/src/rules/tryceratops/mod.rs +snapshot_kind: text --- TRY201.py:20:15: TRY201 [*] Use `raise` without specifying exception name | @@ -53,5 +54,3 @@ TRY201.py:74:23: TRY201 [*] Use `raise` without specifying exception name 73 73 | def foo(): 74 |- raise e 74 |+ raise - - diff --git a/crates/ruff_linter/src/settings/fix_safety_table.rs b/crates/ruff_linter/src/settings/fix_safety_table.rs index 8f4382452f3c0..45ffa01415060 100644 --- a/crates/ruff_linter/src/settings/fix_safety_table.rs +++ b/crates/ruff_linter/src/settings/fix_safety_table.rs @@ -6,10 +6,9 @@ use rustc_hash::FxHashMap; use strum::IntoEnumIterator; use crate::{ - display_settings, + RuleSelector, display_settings, registry::{Rule, RuleSet}, rule_selector::{PreviewOptions, Specificity}, - RuleSelector, }; /// A table to keep track of which rules fixes should have diff --git a/crates/ruff_linter/src/settings/flags.rs b/crates/ruff_linter/src/settings/flags.rs index 5815e19b4939f..dd558ed52b0aa 100644 --- a/crates/ruff_linter/src/settings/flags.rs +++ b/crates/ruff_linter/src/settings/flags.rs @@ -19,11 +19,7 @@ impl Noqa { impl From<bool> for Noqa { fn from(value: bool) -> Self { - if value { - Noqa::Enabled - } else { - Noqa::Disabled - } + if value { Noqa::Enabled } else { Noqa::Disabled } } } diff --git a/crates/ruff_linter/src/settings/mod.rs b/crates/ruff_linter/src/settings/mod.rs index 2bc98bc930a8f..bfec035a594cd 100644 --- a/crates/ruff_linter/src/settings/mod.rs +++ b/crates/ruff_linter/src/settings/mod.rs @@ -2,15 +2,16 @@ //! command-line options. Structure is optimized for internal usage, as opposed //! to external visibility or parsing. -use path_absolutize::path_dedot; use regex::Regex; use rustc_hash::FxHashSet; use std::fmt::{Display, Formatter}; use std::path::{Path, PathBuf}; use std::sync::LazyLock; +use types::CompiledPerFileTargetVersionList; use crate::codes::RuleCodePrefix; use ruff_macros::CacheKey; +use ruff_python_ast::PythonVersion; use crate::line_width::LineLength; use crate::registry::{Linter, Rule}; @@ -19,12 +20,10 @@ use crate::rules::{ flake8_comprehensions, flake8_copyright, flake8_errmsg, flake8_gettext, flake8_implicit_str_concat, flake8_import_conventions, flake8_pytest_style, flake8_quotes, flake8_self, flake8_tidy_imports, flake8_type_checking, flake8_unused_arguments, isort, mccabe, - pep8_naming, pycodestyle, pydocstyle, pyflakes, pylint, pyupgrade, ruff, + pep8_naming, pycodestyle, pydoclint, pydocstyle, pyflakes, pylint, pyupgrade, ruff, }; -use crate::settings::types::{ - CompiledPerFileIgnoreList, ExtensionMapping, FilePatternSet, PythonVersion, -}; -use crate::{codes, RuleSelector}; +use crate::settings::types::{CompiledPerFileIgnoreList, ExtensionMapping, FilePatternSet}; +use crate::{RuleSelector, codes, fs}; use super::line_width::IndentWidth; @@ -220,7 +219,21 @@ pub struct LinterSettings { pub per_file_ignores: CompiledPerFileIgnoreList, pub fix_safety: FixSafetyTable, - pub target_version: PythonVersion, + /// The non-path-resolved Python version specified by the `target-version` input option. + /// + /// If you have a `Checker` available, see its `target_version` method instead. + /// + /// Otherwise, see [`LinterSettings::resolve_target_version`] for a way to obtain the Python + /// version for a given file, while respecting the overrides in `per_file_target_version`. + pub unresolved_target_version: TargetVersion, + /// Path-specific overrides to `unresolved_target_version`. + /// + /// If you have a `Checker` available, see its `target_version` method instead. + /// + /// Otherwise, see [`LinterSettings::resolve_target_version`] for a way to check a given + /// [`Path`] against these patterns, while falling back to `unresolved_target_version` if none + /// of them match. + pub per_file_target_version: CompiledPerFileTargetVersionList, pub preview: PreviewMode, pub explicit_preview_rules: bool, @@ -237,6 +250,7 @@ pub struct LinterSettings { pub line_length: LineLength, pub task_tags: Vec<String>, pub typing_modules: Vec<String>, + pub typing_extensions: bool, // Plugins pub flake8_annotations: flake8_annotations::settings::Settings, @@ -260,6 +274,7 @@ pub struct LinterSettings { pub mccabe: mccabe::settings::Settings, pub pep8_naming: pep8_naming::settings::Settings, pub pycodestyle: pycodestyle::settings::Settings, + pub pydoclint: pydoclint::settings::Settings, pub pydocstyle: pydocstyle::settings::Settings, pub pyflakes: pyflakes::settings::Settings, pub pylint: pylint::settings::Settings, @@ -281,7 +296,8 @@ impl Display for LinterSettings { self.per_file_ignores, self.fix_safety | nested, - self.target_version | debug, + self.unresolved_target_version, + self.per_file_target_version, self.preview, self.explicit_preview_rules, self.extension | debug, @@ -298,6 +314,7 @@ impl Display for LinterSettings { self.line_length, self.task_tags | array, self.typing_modules | array, + self.typing_extensions, ] } writeln!(f, "\n# Linter Plugins")?; @@ -361,7 +378,7 @@ impl LinterSettings { pub fn for_rule(rule_code: Rule) -> Self { Self { rules: RuleTable::from_iter([rule_code]), - target_version: PythonVersion::latest(), + unresolved_target_version: PythonVersion::latest().into(), ..Self::default() } } @@ -369,7 +386,7 @@ impl LinterSettings { pub fn for_rules(rules: impl IntoIterator<Item = Rule>) -> Self { Self { rules: RuleTable::from_iter(rules), - target_version: PythonVersion::latest(), + unresolved_target_version: PythonVersion::latest().into(), ..Self::default() } } @@ -377,7 +394,8 @@ impl LinterSettings { pub fn new(project_root: &Path) -> Self { Self { exclude: FilePatternSet::default(), - target_version: PythonVersion::default(), + unresolved_target_version: TargetVersion(None), + per_file_target_version: CompiledPerFileTargetVersionList::default(), project_root: project_root.to_path_buf(), rules: DEFAULT_SELECTORS .iter() @@ -397,7 +415,7 @@ impl LinterSettings { per_file_ignores: CompiledPerFileIgnoreList::default(), fix_safety: FixSafetyTable::default(), - src: vec![path_dedot::CWD.clone(), path_dedot::CWD.join("src")], + src: vec![fs::get_cwd().to_path_buf(), fs::get_cwd().join("src")], // Needs duplicating tab_size: IndentWidth::default(), line_length: LineLength::default(), @@ -425,6 +443,7 @@ impl LinterSettings { mccabe: mccabe::settings::Settings::default(), pep8_naming: pep8_naming::settings::Settings::default(), pycodestyle: pycodestyle::settings::Settings::default(), + pydoclint: pydoclint::settings::Settings::default(), pydocstyle: pydocstyle::settings::Settings::default(), pyflakes: pyflakes::settings::Settings::default(), pylint: pylint::settings::Settings::default(), @@ -433,18 +452,75 @@ impl LinterSettings { preview: PreviewMode::default(), explicit_preview_rules: false, extension: ExtensionMapping::default(), + typing_extensions: true, } } #[must_use] pub fn with_target_version(mut self, target_version: PythonVersion) -> Self { - self.target_version = target_version; + self.unresolved_target_version = target_version.into(); self } + + /// Resolve the [`TargetVersion`] to use for linting. + /// + /// This method respects the per-file version overrides in + /// [`LinterSettings::per_file_target_version`] and falls back on + /// [`LinterSettings::unresolved_target_version`] if none of the override patterns match. + pub fn resolve_target_version(&self, path: &Path) -> TargetVersion { + self.per_file_target_version + .is_match(path) + .map_or(self.unresolved_target_version, TargetVersion::from) + } } impl Default for LinterSettings { fn default() -> Self { - Self::new(path_dedot::CWD.as_path()) + Self::new(fs::get_cwd()) + } +} + +/// A thin wrapper around `Option<PythonVersion>` to clarify the reason for different `unwrap` +/// calls in various places. +/// +/// For example, we want to default to `PythonVersion::latest()` for parsing and detecting semantic +/// syntax errors because this will minimize version-related diagnostics when the Python version is +/// unset. In contrast, we want to default to `PythonVersion::default()` for lint rules. These +/// correspond to the [`TargetVersion::parser_version`] and [`TargetVersion::linter_version`] +/// methods, respectively. +#[derive(Debug, Clone, Copy, CacheKey)] +pub struct TargetVersion(pub Option<PythonVersion>); + +impl TargetVersion { + /// Return the [`PythonVersion`] to use for parsing. + /// + /// This will be either the Python version specified by the user or the latest supported + /// version if unset. + pub fn parser_version(&self) -> PythonVersion { + self.0.unwrap_or_else(PythonVersion::latest) + } + + /// Return the [`PythonVersion`] to use for version-dependent lint rules. + /// + /// This will either be the Python version specified by the user or the default Python version + /// if unset. + pub fn linter_version(&self) -> PythonVersion { + self.0.unwrap_or_default() + } +} + +impl From<PythonVersion> for TargetVersion { + fn from(value: PythonVersion) -> Self { + Self(Some(value)) + } +} + +impl Display for TargetVersion { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + // manual inlining of display_settings! + match self.0 { + Some(value) => write!(f, "{value}"), + None => f.write_str("none"), + } } } diff --git a/crates/ruff_linter/src/settings/types.rs b/crates/ruff_linter/src/settings/types.rs index e0f38391f5823..28f1135a7c8bd 100644 --- a/crates/ruff_linter/src/settings/types.rs +++ b/crates/ruff_linter/src/settings/types.rs @@ -5,57 +5,71 @@ use std::path::{Path, PathBuf}; use std::str::FromStr; use std::string::ToString; -use anyhow::{bail, Result}; +use anyhow::{Context, Result, bail}; use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder}; use log::debug; -use pep440_rs::{Operator, Version as Pep440Version, Version, VersionSpecifier, VersionSpecifiers}; +use pep440_rs::{VersionSpecifier, VersionSpecifiers}; use rustc_hash::FxHashMap; -use serde::{de, Deserialize, Deserializer, Serialize}; -use strum::IntoEnumIterator; +use serde::{Deserialize, Deserializer, Serialize, de}; use strum_macros::EnumIter; use ruff_cache::{CacheKey, CacheKeyHasher}; use ruff_diagnostics::Applicability; use ruff_macros::CacheKey; -use ruff_python_ast::PySourceType; +use ruff_python_ast::{self as ast, PySourceType}; use crate::registry::RuleSet; use crate::rule_selector::RuleSelector; use crate::{display_settings, fs}; -#[derive( - Clone, - Copy, - Debug, - PartialOrd, - Ord, - PartialEq, - Eq, - Default, - Serialize, - Deserialize, - CacheKey, - EnumIter, -)] +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, EnumIter)] #[cfg_attr(feature = "clap", derive(clap::ValueEnum))] #[serde(rename_all = "lowercase")] #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum PythonVersion { Py37, - // Make sure to also change the default for `ruff_python_formatter::PythonVersion` - // when changing the default here. - #[default] Py38, Py39, Py310, Py311, Py312, Py313, - // Remember to update the `latest()` function - // when adding new versions here! + Py314, +} + +impl Default for PythonVersion { + fn default() -> Self { + // SAFETY: the unit test `default_python_version_works()` checks that this doesn't panic + Self::try_from(ast::PythonVersion::default()).unwrap() + } } -impl From<PythonVersion> for Pep440Version { +impl TryFrom<ast::PythonVersion> for PythonVersion { + type Error = String; + + fn try_from(value: ast::PythonVersion) -> Result<Self, Self::Error> { + match value { + ast::PythonVersion::PY37 => Ok(Self::Py37), + ast::PythonVersion::PY38 => Ok(Self::Py38), + ast::PythonVersion::PY39 => Ok(Self::Py39), + ast::PythonVersion::PY310 => Ok(Self::Py310), + ast::PythonVersion::PY311 => Ok(Self::Py311), + ast::PythonVersion::PY312 => Ok(Self::Py312), + ast::PythonVersion::PY313 => Ok(Self::Py313), + ast::PythonVersion::PY314 => Ok(Self::Py314), + _ => Err(format!("unrecognized python version {value}")), + } + } +} + +impl From<PythonVersion> for ast::PythonVersion { + fn from(value: PythonVersion) -> Self { + let (major, minor) = value.as_tuple(); + Self { major, minor } + } +} + +impl From<PythonVersion> for pep440_rs::Version { fn from(version: PythonVersion) -> Self { let (major, minor) = version.as_tuple(); Self::new([u64::from(major), u64::from(minor)]) @@ -63,11 +77,6 @@ impl From<PythonVersion> for Pep440Version { } impl PythonVersion { - /// Return the latest supported Python version. - pub const fn latest() -> Self { - Self::Py313 - } - pub const fn as_tuple(&self) -> (u8, u8) { match self { Self::Py37 => (3, 7), @@ -77,55 +86,9 @@ impl PythonVersion { Self::Py311 => (3, 11), Self::Py312 => (3, 12), Self::Py313 => (3, 13), + Self::Py314 => (3, 14), } } - - pub const fn major(&self) -> u8 { - self.as_tuple().0 - } - - pub const fn minor(&self) -> u8 { - self.as_tuple().1 - } - - /// Infer the minimum supported [`PythonVersion`] from a `requires-python` specifier. - pub fn get_minimum_supported_version(requires_version: &VersionSpecifiers) -> Option<Self> { - /// Truncate a version to its major and minor components. - fn major_minor(version: &Version) -> Option<Version> { - let major = version.release().first()?; - let minor = version.release().get(1)?; - Some(Version::new([major, minor])) - } - - // Extract the minimum supported version from the specifiers. - let minimum_version = requires_version - .iter() - .filter(|specifier| { - matches!( - specifier.operator(), - Operator::Equal - | Operator::EqualStar - | Operator::ExactEqual - | Operator::TildeEqual - | Operator::GreaterThan - | Operator::GreaterThanEqual - ) - }) - .filter_map(|specifier| major_minor(specifier.version())) - .min()?; - - debug!("Detected minimum supported `requires-python` version: {minimum_version}"); - - // Find the Python version that matches the minimum supported version. - PythonVersion::iter().find(|version| Version::from(*version) == minimum_version) - } - - /// Return `true` if the current version supports [PEP 701]. - /// - /// [PEP 701]: https://peps.python.org/pep-0701/ - pub fn supports_pep701(self) -> bool { - self >= Self::Py312 - } } #[derive(Debug, Clone, Copy, PartialEq, Eq, Default, CacheKey, is_macro::Is)] @@ -199,10 +162,41 @@ impl UnsafeFixes { } } +/// Represents a path to be passed to [`Glob::new`]. +#[derive(Debug, Clone, CacheKey, PartialEq, PartialOrd, Eq, Ord)] +pub struct GlobPath { + path: PathBuf, +} + +impl GlobPath { + /// Constructs a [`GlobPath`] by escaping any glob metacharacters in `root` and normalizing + /// `path` to the escaped `root`. + /// + /// See [`fs::normalize_path_to`] for details of the normalization. + pub fn normalize(path: impl AsRef<Path>, root: impl AsRef<Path>) -> Self { + let root = root.as_ref().to_string_lossy(); + let escaped = globset::escape(&root); + let absolute = fs::normalize_path_to(path, escaped); + Self { path: absolute } + } + + pub fn into_inner(self) -> PathBuf { + self.path + } +} + +impl Deref for GlobPath { + type Target = PathBuf; + + fn deref(&self) -> &Self::Target { + &self.path + } +} + #[derive(Debug, Clone, CacheKey, PartialEq, PartialOrd, Eq, Ord)] pub enum FilePattern { Builtin(&'static str), - User(String, PathBuf), + User(String, GlobPath), } impl FilePattern { @@ -242,9 +236,10 @@ impl FromStr for FilePattern { type Err = anyhow::Error; fn from_str(s: &str) -> Result<Self, Self::Err> { - let pattern = s.to_string(); - let absolute = fs::normalize_path(&pattern); - Ok(Self::User(pattern, absolute)) + Ok(Self::User( + s.to_string(), + GlobPath::normalize(s, fs::get_cwd()), + )) } } @@ -254,12 +249,12 @@ pub struct FilePatternSet { cache_key: u64, // This field is only for displaying the internals // of `set`. - #[allow(clippy::used_underscore_binding)] + #[expect(clippy::used_underscore_binding)] _set_internals: Vec<FilePattern>, } impl FilePatternSet { - #[allow(clippy::used_underscore_binding)] + #[expect(clippy::used_underscore_binding)] pub fn try_from_iter<I>(patterns: I) -> Result<Self, anyhow::Error> where I: IntoIterator<Item = FilePattern>, @@ -315,41 +310,56 @@ impl CacheKey for FilePatternSet { } } +/// A glob pattern and associated data for matching file paths. #[derive(Debug, Clone)] -pub struct PerFileIgnore { - pub(crate) basename: String, - pub(crate) absolute: PathBuf, - pub(crate) negated: bool, - pub(crate) rules: RuleSet, -} - -impl PerFileIgnore { - pub fn new( - mut pattern: String, - prefixes: &[RuleSelector], - project_root: Option<&Path>, - ) -> Self { - // Rules in preview are included here even if preview mode is disabled; it's safe to ignore disabled rules - let rules: RuleSet = prefixes.iter().flat_map(RuleSelector::all_rules).collect(); +pub struct PerFile<T> { + /// The glob pattern used to construct the [`PerFile`]. + basename: String, + /// The same pattern as `basename` but normalized to the project root directory. + absolute: GlobPath, + /// Whether the glob pattern should be negated (e.g. `!*.ipynb`) + negated: bool, + /// The per-file data associated with these glob patterns. + data: T, +} + +impl<T> PerFile<T> { + /// Construct a new [`PerFile`] from the given glob `pattern` and containing `data`. + /// + /// If provided, `project_root` is used to construct a second glob pattern normalized to the + /// project root directory. See [`fs::normalize_path_to`] for more details. + fn new(mut pattern: String, project_root: Option<&Path>, data: T) -> Self { let negated = pattern.starts_with('!'); if negated { pattern.drain(..1); } - let path = Path::new(&pattern); - let absolute = match project_root { - Some(project_root) => fs::normalize_path_to(path, project_root), - None => fs::normalize_path(path), - }; + + let project_root = project_root.unwrap_or(fs::get_cwd()); Self { + absolute: GlobPath::normalize(&pattern, project_root), basename: pattern, - absolute, negated, - rules, + data, } } } +/// Per-file ignored linting rules. +/// +/// See [`PerFile`] for details of the representation. +#[derive(Debug, Clone)] +pub struct PerFileIgnore(PerFile<RuleSet>); + +impl PerFileIgnore { + pub fn new(pattern: String, prefixes: &[RuleSelector], project_root: Option<&Path>) -> Self { + // Rules in preview are included here even if preview mode is disabled; it's safe to ignore + // disabled rules + let rules: RuleSet = prefixes.iter().flat_map(RuleSelector::all_rules).collect(); + Self(PerFile::new(pattern, project_root, rules)) + } +} + #[derive(Clone, Debug, PartialEq, Eq)] pub struct PatternPrefixPair { pub pattern: String, @@ -568,8 +578,8 @@ impl schemars::JsonSchema for RequiredVersion { "RequiredVersion".to_string() } - fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { - gen.subschema_for::<String>() + fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> schemars::schema::Schema { + generator.subschema_for::<String>() } } @@ -599,15 +609,47 @@ impl Display for RequiredVersion { /// pattern matching. pub type IdentifierPattern = glob::Pattern; -#[derive(Debug, Clone, CacheKey)] -pub struct CompiledPerFileIgnore { +/// Like [`PerFile`] but with string globs compiled to [`GlobMatcher`]s for more efficient usage. +#[derive(Debug, Clone)] +pub struct CompiledPerFile<T> { pub absolute_matcher: GlobMatcher, pub basename_matcher: GlobMatcher, pub negated: bool, - pub rules: RuleSet, + pub data: T, +} + +impl<T> CompiledPerFile<T> { + fn new( + absolute_matcher: GlobMatcher, + basename_matcher: GlobMatcher, + negated: bool, + data: T, + ) -> Self { + Self { + absolute_matcher, + basename_matcher, + negated, + data, + } + } } -impl Display for CompiledPerFileIgnore { +impl<T> CacheKey for CompiledPerFile<T> +where + T: CacheKey, +{ + fn cache_key(&self, state: &mut CacheKeyHasher) { + self.absolute_matcher.cache_key(state); + self.basename_matcher.cache_key(state); + self.negated.cache_key(state); + self.data.cache_key(state); + } +} + +impl<T> Display for CompiledPerFile<T> +where + T: Display, +{ fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { display_settings! { formatter = f, @@ -615,52 +657,130 @@ impl Display for CompiledPerFileIgnore { self.absolute_matcher | globmatcher, self.basename_matcher | globmatcher, self.negated, - self.rules, + self.data, ] } Ok(()) } } -#[derive(Debug, Clone, CacheKey, Default)] -pub struct CompiledPerFileIgnoreList { - // Ordered as (absolute path matcher, basename matcher, rules) - ignores: Vec<CompiledPerFileIgnore>, +/// A sequence of [`CompiledPerFile<T>`]. +#[derive(Debug, Clone, Default)] +pub struct CompiledPerFileList<T> { + inner: Vec<CompiledPerFile<T>>, } -impl CompiledPerFileIgnoreList { - /// Given a list of patterns, create a `GlobSet`. - pub fn resolve(per_file_ignores: Vec<PerFileIgnore>) -> Result<Self> { - let ignores: Result<Vec<_>> = per_file_ignores +impl<T> CacheKey for CompiledPerFileList<T> +where + T: CacheKey, +{ + fn cache_key(&self, state: &mut CacheKeyHasher) { + self.inner.cache_key(state); + } +} + +impl<T> CompiledPerFileList<T> { + /// Given a list of [`PerFile`] patterns, create a compiled set of globs. + /// + /// Returns an error if either of the glob patterns cannot be parsed. + fn resolve(per_file_items: impl IntoIterator<Item = PerFile<T>>) -> Result<Self> { + let inner: Result<Vec<_>> = per_file_items .into_iter() .map(|per_file_ignore| { // Construct absolute path matcher. - let absolute_matcher = - Glob::new(&per_file_ignore.absolute.to_string_lossy())?.compile_matcher(); + let absolute_matcher = Glob::new(&per_file_ignore.absolute.to_string_lossy()) + .with_context(|| format!("invalid glob {:?}", per_file_ignore.absolute))? + .compile_matcher(); // Construct basename matcher. - let basename_matcher = Glob::new(&per_file_ignore.basename)?.compile_matcher(); + let basename_matcher = Glob::new(&per_file_ignore.basename) + .with_context(|| format!("invalid glob {:?}", per_file_ignore.basename))? + .compile_matcher(); - Ok(CompiledPerFileIgnore { + Ok(CompiledPerFile::new( absolute_matcher, basename_matcher, - negated: per_file_ignore.negated, - rules: per_file_ignore.rules, - }) + per_file_ignore.negated, + per_file_ignore.data, + )) }) .collect(); - Ok(Self { ignores: ignores? }) + Ok(Self { inner: inner? }) + } + + pub(crate) fn is_empty(&self) -> bool { + self.inner.is_empty() } } -impl Display for CompiledPerFileIgnoreList { +impl<T: std::fmt::Debug> CompiledPerFileList<T> { + /// Return an iterator over the entries in `self` that match the input `path`. + /// + /// `debug_label` is used for [`debug!`] messages explaining why certain patterns were matched. + pub(crate) fn iter_matches<'a, 'p>( + &'a self, + path: &'p Path, + debug_label: &'static str, + ) -> impl Iterator<Item = &'p T> + where + 'a: 'p, + { + let file_name = path.file_name().expect("Unable to parse filename"); + self.inner.iter().filter_map(move |entry| { + if entry.basename_matcher.is_match(file_name) { + if entry.negated { + None + } else { + debug!( + "{} for {:?} due to basename match on {:?}: {:?}", + debug_label, + path, + entry.basename_matcher.glob().regex(), + entry.data + ); + Some(&entry.data) + } + } else if entry.absolute_matcher.is_match(path) { + if entry.negated { + None + } else { + debug!( + "{} for {:?} due to absolute match on {:?}: {:?}", + debug_label, + path, + entry.absolute_matcher.glob().regex(), + entry.data + ); + Some(&entry.data) + } + } else if entry.negated { + debug!( + "{} for {:?} due to negated pattern matching neither {:?} nor {:?}: {:?}", + debug_label, + path, + entry.basename_matcher.glob().regex(), + entry.absolute_matcher.glob().regex(), + entry.data + ); + Some(&entry.data) + } else { + None + } + }) + } +} + +impl<T> Display for CompiledPerFileList<T> +where + T: Display, +{ fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - if self.ignores.is_empty() { + if self.inner.is_empty() { write!(f, "{{}}")?; } else { writeln!(f, "{{")?; - for ignore in &self.ignores { - writeln!(f, "\t{ignore}")?; + for value in &self.inner { + writeln!(f, "\t{value}")?; } write!(f, "}}")?; } @@ -668,10 +788,77 @@ impl Display for CompiledPerFileIgnoreList { } } +#[derive(Debug, Clone, CacheKey, Default)] +pub struct CompiledPerFileIgnoreList(CompiledPerFileList<RuleSet>); + +impl CompiledPerFileIgnoreList { + /// Given a list of [`PerFileIgnore`] patterns, create a compiled set of globs. + /// + /// Returns an error if either of the glob patterns cannot be parsed. + pub fn resolve(per_file_ignores: Vec<PerFileIgnore>) -> Result<Self> { + Ok(Self(CompiledPerFileList::resolve( + per_file_ignores.into_iter().map(|ignore| ignore.0), + )?)) + } +} + impl Deref for CompiledPerFileIgnoreList { - type Target = Vec<CompiledPerFileIgnore>; + type Target = CompiledPerFileList<RuleSet>; fn deref(&self) -> &Self::Target { - &self.ignores + &self.0 + } +} + +impl Display for CompiledPerFileIgnoreList { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.0.fmt(f) + } +} + +/// Contains the target Python version for a given glob pattern. +/// +/// See [`PerFile`] for details of the representation. +#[derive(Debug, Clone)] +pub struct PerFileTargetVersion(PerFile<ast::PythonVersion>); + +impl PerFileTargetVersion { + pub fn new(pattern: String, version: ast::PythonVersion, project_root: Option<&Path>) -> Self { + Self(PerFile::new(pattern, project_root, version)) + } +} + +#[derive(CacheKey, Clone, Debug, Default)] +pub struct CompiledPerFileTargetVersionList(CompiledPerFileList<ast::PythonVersion>); + +impl CompiledPerFileTargetVersionList { + /// Given a list of [`PerFileTargetVersion`] patterns, create a compiled set of globs. + /// + /// Returns an error if either of the glob patterns cannot be parsed. + pub fn resolve(per_file_versions: Vec<PerFileTargetVersion>) -> Result<Self> { + Ok(Self(CompiledPerFileList::resolve( + per_file_versions.into_iter().map(|version| version.0), + )?)) + } + + pub fn is_match(&self, path: &Path) -> Option<ast::PythonVersion> { + self.0 + .iter_matches(path, "Setting Python version") + .next() + .copied() + } +} + +impl Display for CompiledPerFileTargetVersionList { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.0.fmt(f) + } +} + +#[cfg(test)] +mod tests { + #[test] + fn default_python_version_works() { + super::PythonVersion::default(); } } diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension.py.snap new file mode 100644 index 0000000000000..9e570b889cc0a --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension.py.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/async_comprehension.py:5:8: PLE1142 `await` should be used within an async function + | +4 | def regular_function(): +5 | [x async for x in elements(1)] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ PLE1142 +6 | +7 | async with elements(1) as x: + | + +resources/test/fixtures/syntax_errors/async_comprehension.py:7:5: PLE1142 `await` should be used within an async function + | + 5 | [x async for x in elements(1)] + 6 | + 7 | / async with elements(1) as x: + 8 | | pass + | |____________^ PLE1142 + 9 | +10 | async for _ in elements(1): + | + +resources/test/fixtures/syntax_errors/async_comprehension.py:10:5: PLE1142 `await` should be used within an async function + | + 8 | pass + 9 | +10 | / async for _ in elements(1): +11 | | pass + | |____________^ PLE1142 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.10.snap new file mode 100644 index 0000000000000..c573573f7063c --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.10.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/async_comprehension.ipynb:3:5: SyntaxError: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) + | +1 | async def elements(n): yield n +2 | [x async for x in elements(5)] # okay, async at top level +3 | [[x async for x in elements(5)] for i in range(5)] # error on 3.10, okay after + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.11.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.11.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__async_comprehension_in_sync_comprehension_notebook_3.11.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_outside_async_function.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_outside_async_function.py.snap new file mode 100644 index 0000000000000..fb45718a9ab9e --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_outside_async_function.py.snap @@ -0,0 +1,18 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/await_outside_async_function.py:2:5: PLE1142 `await` should be used within an async function + | +1 | def func(): +2 | await 1 + | ^^^^^^^ PLE1142 +3 | +4 | # Top-level await + | + +resources/test/fixtures/syntax_errors/await_outside_async_function.py:5:1: PLE1142 `await` should be used within an async function + | +4 | # Top-level await +5 | await 1 + | ^^^^^^^ PLE1142 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_scope_notebook.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_scope_notebook.snap new file mode 100644 index 0000000000000..6a7e634ca6dbe --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__await_scope_notebook.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +await_scope.ipynb:cell 3:2:5: F704 `await` statement outside of a function + | +1 | class _: +2 | await 1 # SyntaxError: await outside function + | ^^^^^^^ F704 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_fast002_disabled.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_fast002_disabled.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_fast002_disabled.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_extensions.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_extensions.snap new file mode 100644 index 0000000000000..b2537598f04a1 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_extensions.snap @@ -0,0 +1,23 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:7:13: PYI019 [*] Use `Self` instead of custom TypeVar `T` + | +6 | class C: +7 | def __new__(cls: type[T]) -> T: + | ^^^^^^^^^^^^^^^^^^^ PYI019 +8 | return cls + | + = help: Replace TypeVar `T` with `Self` + +ℹ Safe fix +1 1 | +2 2 | from typing import TypeVar + 3 |+from typing_extensions import Self +3 4 | +4 5 | T = TypeVar("T", bound="_NiceReprEnum") +5 6 | +6 7 | class C: +7 |- def __new__(cls: type[T]) -> T: + 8 |+ def __new__(cls) -> Self: +8 9 | return cls diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_with_extensions_disabled.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_with_extensions_disabled.snap new file mode 100644 index 0000000000000..0dee5cdff1f70 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_with_extensions_disabled.snap @@ -0,0 +1,23 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:7:13: PYI019 [*] Use `Self` instead of custom TypeVar `T` + | +6 | class C: +7 | def __new__(cls: type[T]) -> T: + | ^^^^^^^^^^^^^^^^^^^ PYI019 +8 | return cls + | + = help: Replace TypeVar `T` with `Self` + +ℹ Safe fix +1 1 | +2 |-from typing import TypeVar + 2 |+from typing import TypeVar, Self +3 3 | +4 4 | T = TypeVar("T", bound="_NiceReprEnum") +5 5 | +6 6 | class C: +7 |- def __new__(cls: type[T]) -> T: + 7 |+ def __new__(cls) -> Self: +8 8 | return cls diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_without_extensions_disabled.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_without_extensions_disabled.snap new file mode 100644 index 0000000000000..0dee5cdff1f70 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_adds_typing_without_extensions_disabled.snap @@ -0,0 +1,23 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:7:13: PYI019 [*] Use `Self` instead of custom TypeVar `T` + | +6 | class C: +7 | def __new__(cls: type[T]) -> T: + | ^^^^^^^^^^^^^^^^^^^ PYI019 +8 | return cls + | + = help: Replace TypeVar `T` with `Self` + +ℹ Safe fix +1 1 | +2 |-from typing import TypeVar + 2 |+from typing import TypeVar, Self +3 3 | +4 4 | T = TypeVar("T", bound="_NiceReprEnum") +5 5 | +6 6 | class C: +7 |- def __new__(cls: type[T]) -> T: + 7 |+ def __new__(cls) -> Self: +8 8 | return cls diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_does_not_add_typing_extensions.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_does_not_add_typing_extensions.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi019_does_not_add_typing_extensions.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi034_disabled.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi034_disabled.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi034_disabled.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi_pyi026_disabled.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi_pyi026_disabled.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__disabled_typing_extensions_pyi_pyi026_disabled.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__import_sorting.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__import_sorting.snap index b0cc03fe750e1..283257a8d8c7a 100644 --- a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__import_sorting.snap +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__import_sorting.snap @@ -6,10 +6,7 @@ isort.ipynb:cell 1:1:1: I001 [*] Import block is un-sorted or un-formatted 1 | / from pathlib import Path 2 | | import random 3 | | import math -4 | | from typing import Any - | |_^ I001 -5 | import collections -6 | # Newline should be added here + | |___________^ I001 | = help: Organize imports @@ -27,10 +24,9 @@ isort.ipynb:cell 2:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from typing import Any 2 | | import collections -3 | | # Newline should be added here - | |_^ I001 + | |__________________^ I001 +3 | # Newline should be added here 4 | def foo(): -5 | pass | = help: Organize imports @@ -51,10 +47,9 @@ isort.ipynb:cell 3:1:1: I001 [*] Import block is un-sorted or un-formatted | 1 | / from pathlib import Path 2 | | import sys -3 | | -4 | | %matplotlib \ - | |_^ I001 -5 | --inline + | |__________^ I001 +3 | +4 | %matplotlib \ | = help: Organize imports @@ -72,9 +67,10 @@ isort.ipynb:cell 3:1:1: I001 [*] Import block is un-sorted or un-formatted isort.ipynb:cell 3:7:1: I001 [*] Import block is un-sorted or un-formatted | 5 | --inline -6 | +6 | 7 | / import math 8 | | import abc + | |__________^ I001 | = help: Organize imports @@ -85,5 +81,3 @@ isort.ipynb:cell 3:7:1: I001 [*] Import block is un-sorted or un-formatted 15 |+import abc 15 16 | import math 16 |-import abc - - diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__ipy_escape_command.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__ipy_escape_command.snap index 8c1a547e85966..1bf54524d923e 100644 --- a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__ipy_escape_command.snap +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__ipy_escape_command.snap @@ -4,10 +4,10 @@ source: crates/ruff_linter/src/linter.rs ipy_escape_command.ipynb:cell 1:5:8: F401 [*] `os` imported but unused | 3 | %matplotlib inline -4 | +4 | 5 | import os | ^^ F401 -6 | +6 | 7 | _ = math.pi | = help: Remove unused import: `os` @@ -34,5 +34,3 @@ ipy_escape_command.ipynb:cell 2:2:8: F401 [*] `sys` imported but unused 7 7 | _ = math.pi 8 8 | %%timeit 9 |-import sys - - diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__late_future_import.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__late_future_import.py.snap new file mode 100644 index 0000000000000..6140d4cf408ca --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__late_future_import.py.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/late_future_import.py:2:1: F404 `from __future__` imports must occur at the beginning of the file + | +1 | import random +2 | from __future__ import annotations # Error; not at top of file + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ F404 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__load_before_global_declaration.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__load_before_global_declaration.py.snap new file mode 100644 index 0000000000000..a917491f4125a --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__load_before_global_declaration.py.snap @@ -0,0 +1,20 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/load_before_global_declaration.py:9:5: PLE0118 Name `x` is used prior to global declaration on line 10 + | + 7 | x = 10 + 8 | def test_2(): + 9 | x += 1 # error + | ^ PLE0118 +10 | global x + | + +resources/test/fixtures/syntax_errors/load_before_global_declaration.py:13:11: PLE0118 Name `x` is used prior to global declaration on line 14 + | +12 | def test_3(): +13 | print(x) # error + | ^ PLE0118 +14 | global x +15 | x = 5 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__return_outside_function.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__return_outside_function.py.snap new file mode 100644 index 0000000000000..db348572fe66b --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__return_outside_function.py.snap @@ -0,0 +1,31 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/return_outside_function.py:13:1: F706 `return` statement outside of a function/method + | +13 | return 1 # error + | ^^^^^^^^ F706 +14 | return # error + | + +resources/test/fixtures/syntax_errors/return_outside_function.py:14:1: F706 `return` statement outside of a function/method + | +13 | return 1 # error +14 | return # error + | ^^^^^^ F706 + | + +resources/test/fixtures/syntax_errors/return_outside_function.py:18:5: F706 `return` statement outside of a function/method + | +17 | class C: +18 | return 1 # error + | ^^^^^^^^ F706 + | + +resources/test/fixtures/syntax_errors/return_outside_function.py:23:9: F706 `return` statement outside of a function/method + | +21 | def f(): +22 | class C: +23 | return 1 # error + | ^^^^^^^^ F706 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_error_on_310_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_error_on_310_3.10.snap new file mode 100644 index 0000000000000..9fd781f021060 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_error_on_310_3.10.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:1:27: SyntaxError: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) + | +1 | async def f(): return [[x async for x in foo(n)] for n in range(3)] + | ^^^^^^^^^^^^^^^^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_false_positive_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_false_positive_3.10.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_false_positive_3.10.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_310_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_310_3.10.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_310_3.10.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_311_3.11.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_311_3.11.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_async_in_sync_okay_on_311_3.11.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_deferred_function_body_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_deferred_function_body_3.10.snap new file mode 100644 index 0000000000000..4ba33c756c494 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_AsyncComprehensionOutsideAsyncFunction_deferred_function_body_3.10.snap @@ -0,0 +1,4 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- + diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchClassAttribute_duplicate_match_class_attribute_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchClassAttribute_duplicate_match_class_attribute_3.10.snap new file mode 100644 index 0000000000000..bac3111de0219 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchClassAttribute_duplicate_match_class_attribute_3.10.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:21: SyntaxError: attribute name `x` repeated in class pattern + | +2 | match x: +3 | case Point(x=1, x=2): + | ^ +4 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchKey_duplicate_match_key_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchKey_duplicate_match_key_3.10.snap new file mode 100644 index 0000000000000..f877e86e31013 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateMatchKey_duplicate_match_key_3.10.snap @@ -0,0 +1,10 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:21: SyntaxError: mapping pattern checks duplicate key `'key'` + | +2 | match x: +3 | case {'key': 1, 'key': 2}: + | ^^^^^ +4 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateTypeParameter_duplicate_type_param_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateTypeParameter_duplicate_type_param_3.12.snap new file mode 100644 index 0000000000000..5ede497ec6771 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_DuplicateTypeParameter_duplicate_type_param_3.12.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:1:12: SyntaxError: duplicate type parameter + | +1 | class C[T, T]: pass + | ^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_walrus_in_return_annotation_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_walrus_in_return_annotation_3.12.snap new file mode 100644 index 0000000000000..a09dda153fa57 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_walrus_in_return_annotation_3.12.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:22: SyntaxError: named expression cannot be used within a generic definition + | +2 | def f[T](x: int) -> (y := 3): return x + | ^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_from_in_base_class_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_from_in_base_class_3.12.snap new file mode 100644 index 0000000000000..6f71b926a1c69 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_from_in_base_class_3.12.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:13: SyntaxError: yield expression cannot be used within a generic definition + | +2 | class C[T]((yield from [object])): + | ^^^^^^^^^^^^^^^^^^^ +3 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_alias_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_alias_3.12.snap new file mode 100644 index 0000000000000..39c220e6a1534 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_alias_3.12.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:11: SyntaxError: yield expression cannot be used within a type alias + | +2 | type Y = (yield 1) + | ^^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_param_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_param_3.12.snap new file mode 100644 index 0000000000000..9f0c12aaacc42 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidExpression_invalid_expression_yield_in_type_param_3.12.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:12: SyntaxError: yield expression cannot be used within a TypeVar bound + | +2 | type X[T: (yield 1)] = int + | ^^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_3.10.snap new file mode 100644 index 0000000000000..81bc057071a74 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_3.10.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:12: SyntaxError: Starred expression cannot be used here + | +2 | def func(): +3 | return *x + | ^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_for_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_for_3.10.snap new file mode 100644 index 0000000000000..811caf59bb708 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_for_3.10.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:5: SyntaxError: Starred expression cannot be used here + | +2 | for *x in range(10): + | ^^ +3 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_yield_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_yield_3.10.snap new file mode 100644 index 0000000000000..ee1549b0cddd9 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_InvalidStarExpression_invalid_star_expression_yield_3.10.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:11: SyntaxError: Starred expression cannot be used here + | +2 | def func(): +3 | yield *x + | ^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_capture_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_capture_3.10.snap new file mode 100644 index 0000000000000..502f151558ad4 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_capture_3.10.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:10: SyntaxError: name capture `irrefutable` makes remaining patterns unreachable + | +2 | match value: +3 | case irrefutable: + | ^^^^^^^^^^^ +4 | pass +5 | case 1: + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_wildcard_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_wildcard_3.10.snap new file mode 100644 index 0000000000000..cc54b4776b6bb --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_IrrefutableCasePattern_irrefutable_case_pattern_wildcard_3.10.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:10: SyntaxError: wildcard makes remaining patterns unreachable + | +2 | match value: +3 | case _: + | ^ +4 | pass +5 | case 1: + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_MultipleCaseAssignment_multiple_case_assignment_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_MultipleCaseAssignment_multiple_case_assignment_3.10.snap new file mode 100644 index 0000000000000..6cee83489af49 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_MultipleCaseAssignment_multiple_case_assignment_3.10.snap @@ -0,0 +1,11 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:3:14: SyntaxError: multiple assignments to name `a` in pattern + | +2 | match x: +3 | case [a, a]: + | ^ +4 | pass +5 | case _: + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_ReboundComprehensionVariable_rebound_comprehension_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_ReboundComprehensionVariable_rebound_comprehension_3.10.snap new file mode 100644 index 0000000000000..80fb65620a4c3 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_ReboundComprehensionVariable_rebound_comprehension_3.10.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:1:2: SyntaxError: assignment expression cannot rebind comprehension variable + | +1 | [x:= 2 for x in range(2)] + | ^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_SingleStarredAssignment_single_starred_assignment_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_SingleStarredAssignment_single_starred_assignment_3.10.snap new file mode 100644 index 0000000000000..ecc8f955d8fff --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_SingleStarredAssignment_single_starred_assignment_3.10.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:1:1: SyntaxError: starred assignment target must be in a list or tuple + | +1 | *a = [1, 2, 3, 4] + | ^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_3.10.snap new file mode 100644 index 0000000000000..baebbdf41f123 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_3.10.snap @@ -0,0 +1,8 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:1: SyntaxError: cannot assign to `__debug__` + | +2 | __debug__ = False + | ^^^^^^^^^ + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_class_type_param_3.12.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_class_type_param_3.12.snap new file mode 100644 index 0000000000000..44139dc6cf0cb --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_class_type_param_3.12.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:15: SyntaxError: cannot assign to `__debug__` + | +2 | class Generic[__debug__]: + | ^^^^^^^^^ +3 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_in_function_param_3.10.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_in_function_param_3.10.snap new file mode 100644 index 0000000000000..935ad560543ce --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__semantic_syntax_error_WriteToDebug_write_to_debug_in_function_param_3.10.snap @@ -0,0 +1,9 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +<filename>:2:13: SyntaxError: cannot assign to `__debug__` + | +2 | def process(__debug__): + | ^^^^^^^^^ +3 | pass + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__undefined_name.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__undefined_name.snap index d38bdfa2e069b..88cd59f63cbf1 100644 --- a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__undefined_name.snap +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__undefined_name.snap @@ -6,5 +6,3 @@ undefined_name.ipynb:cell 3:1:7: F821 Undefined name `undefined` 1 | print(undefined) | ^^^^^^^^^ F821 | - - diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__unused_variable.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__unused_variable.snap index a610a9bb123c2..f59bd1aea2f50 100644 --- a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__unused_variable.snap +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__unused_variable.snap @@ -68,5 +68,3 @@ unused_variable.ipynb:cell 2:3:5: F841 [*] Local variable `bar2` is assigned to 5 5 | bar1 = !pwd 6 |- bar2: str = !pwd 6 |+ !pwd - - diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__vscode_language_id.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__vscode_language_id.snap index d89e58dc78c22..a8c65c981a9d5 100644 --- a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__vscode_language_id.snap +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__vscode_language_id.snap @@ -5,7 +5,7 @@ vscode_language_id.ipynb:cell 3:1:8: F401 [*] `os` imported but unused | 1 | import os | ^^ F401 -2 | +2 | 3 | print("hello world") | = help: Remove unused import: `os` diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__yield_scope.py.snap b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__yield_scope.py.snap new file mode 100644 index 0000000000000..dad54fa50e0a0 --- /dev/null +++ b/crates/ruff_linter/src/snapshots/ruff_linter__linter__tests__yield_scope.py.snap @@ -0,0 +1,117 @@ +--- +source: crates/ruff_linter/src/linter.rs +--- +resources/test/fixtures/syntax_errors/yield_scope.py:1:1: F704 `yield` statement outside of a function + | +1 | yield # error + | ^^^^^ F704 +2 | yield 1 # error +3 | yield from 1 # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:2:1: F704 `yield` statement outside of a function + | +1 | yield # error +2 | yield 1 # error + | ^^^^^^^ F704 +3 | yield from 1 # error +4 | await 1 # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:3:1: F704 `yield from` statement outside of a function + | +1 | yield # error +2 | yield 1 # error +3 | yield from 1 # error + | ^^^^^^^^^^^^ F704 +4 | await 1 # error +5 | [(yield x) for x in range(3)] # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:4:1: F704 `await` statement outside of a function + | +2 | yield 1 # error +3 | yield from 1 # error +4 | await 1 # error + | ^^^^^^^ F704 +5 | [(yield x) for x in range(3)] # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:5:3: F704 `yield` statement outside of a function + | +3 | yield from 1 # error +4 | await 1 # error +5 | [(yield x) for x in range(3)] # error + | ^^^^^^^ F704 + | + +resources/test/fixtures/syntax_errors/yield_scope.py:23:9: F704 `yield` statement outside of a function + | +21 | def outer(): +22 | class C: +23 | yield 1 # error + | ^^^^^^^ F704 +24 | +25 | [(yield 1) for x in range(3)] # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:25:7: F704 `yield` statement outside of a function + | +23 | yield 1 # error +24 | +25 | [(yield 1) for x in range(3)] # error + | ^^^^^^^ F704 +26 | ((yield 1) for x in range(3)) # error +27 | {(yield 1) for x in range(3)} # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:26:7: F704 `yield` statement outside of a function + | +25 | [(yield 1) for x in range(3)] # error +26 | ((yield 1) for x in range(3)) # error + | ^^^^^^^ F704 +27 | {(yield 1) for x in range(3)} # error +28 | {(yield 1): 0 for x in range(3)} # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:27:7: F704 `yield` statement outside of a function + | +25 | [(yield 1) for x in range(3)] # error +26 | ((yield 1) for x in range(3)) # error +27 | {(yield 1) for x in range(3)} # error + | ^^^^^^^ F704 +28 | {(yield 1): 0 for x in range(3)} # error +29 | {0: (yield 1) for x in range(3)} # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:28:7: F704 `yield` statement outside of a function + | +26 | ((yield 1) for x in range(3)) # error +27 | {(yield 1) for x in range(3)} # error +28 | {(yield 1): 0 for x in range(3)} # error + | ^^^^^^^ F704 +29 | {0: (yield 1) for x in range(3)} # error + | + +resources/test/fixtures/syntax_errors/yield_scope.py:29:10: F704 `yield` statement outside of a function + | +27 | {(yield 1) for x in range(3)} # error +28 | {(yield 1): 0 for x in range(3)} # error +29 | {0: (yield 1) for x in range(3)} # error + | ^^^^^^^ F704 + | + +resources/test/fixtures/syntax_errors/yield_scope.py:36:10: F704 `await` statement outside of a function + | +35 | class C: +36 | [await x for x in range(3)] # error, classes break async scope + | ^^^^^^^ F704 +37 | +38 | lambda x: await x # okay for now, lambda breaks _async_ scope but is a function + | + +resources/test/fixtures/syntax_errors/yield_scope.py:41:1: F704 `await` statement outside of a function + | +41 | await 1 # error + | ^^^^^^^ F704 + | diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_case_insensitive.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_case_insensitive.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_case_insensitive.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_no_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_no_space.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_all_no_space.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_codes.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_codes.snap deleted file mode 100644 index ab2330d822af3..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__flake8_exemption_codes.snap +++ /dev/null @@ -1,14 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - Codes( - [ - "F401", - "F841", - ], - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all.snap deleted file mode 100644 index 1f82ec4ceee35..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 0..6, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_case_insensitive.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_case_insensitive.snap deleted file mode 100644 index 1f82ec4ceee35..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_case_insensitive.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 0..6, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_leading_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_leading_comment.snap deleted file mode 100644 index 34691c9c16045..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_leading_comment.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 35..41, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_multi_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_multi_space.snap deleted file mode 100644 index 79d3acb35e76c..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_multi_space.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 0..7, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_no_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_no_space.snap deleted file mode 100644 index 4e20a49851484..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_no_space.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 0..5, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_trailing_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_trailing_comment.snap deleted file mode 100644 index 1f82ec4ceee35..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_all_trailing_comment.snap +++ /dev/null @@ -1,13 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - All( - All { - range: 0..6, - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code.snap deleted file mode 100644 index e5c3ff736563a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..12, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_case_insensitive.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_case_insensitive.snap deleted file mode 100644 index e5c3ff736563a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_case_insensitive.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..12, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_leading_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_leading_comment.snap deleted file mode 100644 index 051cc542ca6c9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_leading_comment.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 35..47, - codes: [ - Code { - code: "F401", - range: 43..47, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_multi_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_multi_space.snap deleted file mode 100644 index 1f4affbec007e..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_multi_space.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..13, - codes: [ - Code { - code: "F401", - range: 9..13, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_no_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_no_space.snap deleted file mode 100644 index 6b5ecf0c36d16..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_no_space.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..10, - codes: [ - Code { - code: "F401", - range: 6..10, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_trailing_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_trailing_comment.snap deleted file mode 100644 index e5c3ff736563a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_code_trailing_comment.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..12, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes.snap deleted file mode 100644 index 7a83ed9db2271..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..18, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - Code { - code: "F841", - range: 14..18, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_case_insensitive.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_case_insensitive.snap deleted file mode 100644 index 7a83ed9db2271..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_case_insensitive.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..18, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - Code { - code: "F841", - range: 14..18, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_leading_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_leading_comment.snap deleted file mode 100644 index 2fbd25417dc7a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_leading_comment.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 35..53, - codes: [ - Code { - code: "F401", - range: 43..47, - }, - Code { - code: "F841", - range: 49..53, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_multi_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_multi_space.snap deleted file mode 100644 index 53d9993f68e83..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_multi_space.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..20, - codes: [ - Code { - code: "F401", - range: 9..13, - }, - Code { - code: "F841", - range: 16..20, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_no_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_no_space.snap deleted file mode 100644 index 7e81d73d42413..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_no_space.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..15, - codes: [ - Code { - code: "F401", - range: 6..10, - }, - Code { - code: "F841", - range: 11..15, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_trailing_comment.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_trailing_comment.snap deleted file mode 100644 index 7a83ed9db2271..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_codes_trailing_comment.snap +++ /dev/null @@ -1,23 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..18, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - Code { - code: "F841", - range: 14..18, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_codes.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_codes.snap deleted file mode 100644 index 751f9e693b251..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_codes.snap +++ /dev/null @@ -1,7 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Err( - MissingCodes, -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_suffix.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_suffix.snap deleted file mode 100644 index 1852dbd27b70a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_invalid_suffix.snap +++ /dev/null @@ -1,7 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Err( - InvalidSuffix, -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_leading_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_leading_space.snap deleted file mode 100644 index fb2fa3fe4f380..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_leading_space.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 4..16, - codes: [ - Code { - code: "F401", - range: 12..16, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_trailing_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_trailing_space.snap deleted file mode 100644 index e5c3ff736563a..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__noqa_trailing_space.snap +++ /dev/null @@ -1,19 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "Directive::try_extract(source, TextSize::default())" ---- -Ok( - Some( - Codes( - Codes { - range: 0..12, - codes: [ - Code { - code: "F401", - range: 8..12, - }, - ], - }, - ), - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_case_insensitive.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_case_insensitive.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_case_insensitive.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_no_space.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_no_space.snap deleted file mode 100644 index 4fab59ef1b3a9..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_all_no_space.snap +++ /dev/null @@ -1,9 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - All, - ), -) diff --git a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_codes.snap b/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_codes.snap deleted file mode 100644 index ab2330d822af3..0000000000000 --- a/crates/ruff_linter/src/snapshots/ruff_linter__noqa__tests__ruff_exemption_codes.snap +++ /dev/null @@ -1,14 +0,0 @@ ---- -source: crates/ruff_linter/src/noqa.rs -expression: "ParsedFileExemption::try_extract(source)" ---- -Ok( - Some( - Codes( - [ - "F401", - "F841", - ], - ), - ), -) diff --git a/crates/ruff_linter/src/source_kind.rs b/crates/ruff_linter/src/source_kind.rs index f067fe49dbb4c..a146d2db13710 100644 --- a/crates/ruff_linter/src/source_kind.rs +++ b/crates/ruff_linter/src/source_kind.rs @@ -16,15 +16,47 @@ use colored::Colorize; use crate::fs; use crate::text_helpers::ShowNonprinting; -#[derive(Clone, Debug, PartialEq, is_macro::Is)] +#[derive(Clone, Debug, PartialEq)] pub enum SourceKind { /// The source contains Python source code. Python(String), /// The source contains a Jupyter notebook. - IpyNotebook(Notebook), + IpyNotebook(Box<Notebook>), } impl SourceKind { + pub fn ipy_notebook(notebook: Notebook) -> Self { + SourceKind::IpyNotebook(Box::new(notebook)) + } + + pub fn as_ipy_notebook(&self) -> Option<&Notebook> { + match self { + SourceKind::IpyNotebook(notebook) => Some(notebook), + SourceKind::Python(_) => None, + } + } + + pub fn as_python(&self) -> Option<&str> { + match self { + SourceKind::Python(code) => Some(code), + SourceKind::IpyNotebook(_) => None, + } + } + + pub fn expect_python(self) -> String { + match self { + SourceKind::Python(code) => code, + SourceKind::IpyNotebook(_) => panic!("expected python code"), + } + } + + pub fn expect_ipy_notebook(self) -> Notebook { + match self { + SourceKind::IpyNotebook(notebook) => *notebook, + SourceKind::Python(_) => panic!("expected ipy notebook"), + } + } + #[must_use] pub(crate) fn updated(&self, new_source: String, source_map: &SourceMap) -> Self { match self { @@ -52,7 +84,7 @@ impl SourceKind { let notebook = Notebook::from_path(path)?; Ok(notebook .is_python_notebook() - .then_some(Self::IpyNotebook(notebook))) + .then_some(Self::IpyNotebook(Box::new(notebook)))) } else { let contents = std::fs::read_to_string(path)?; Ok(Some(Self::Python(contents))) @@ -69,7 +101,7 @@ impl SourceKind { let notebook = Notebook::from_source_code(&source_code)?; Ok(notebook .is_python_notebook() - .then_some(Self::IpyNotebook(notebook))) + .then_some(Self::IpyNotebook(Box::new(notebook)))) } else { Ok(Some(Self::Python(source_code))) } diff --git a/crates/ruff_linter/src/test.rs b/crates/ruff_linter/src/test.rs index a0c1fe4fbab0d..1d5e2437c03ad 100644 --- a/crates/ruff_linter/src/test.rs +++ b/crates/ruff_linter/src/test.rs @@ -7,29 +7,29 @@ use std::path::Path; #[cfg(not(fuzzing))] use anyhow::Result; use itertools::Itertools; +use ruff_text_size::Ranged; use rustc_hash::FxHashMap; -use ruff_diagnostics::{Applicability, Diagnostic, FixAvailability}; +use ruff_diagnostics::{Applicability, FixAvailability}; use ruff_notebook::Notebook; #[cfg(not(fuzzing))] use ruff_notebook::NotebookError; use ruff_python_ast::PySourceType; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; -use ruff_python_parser::ParseError; +use ruff_python_parser::{ParseError, ParseOptions}; use ruff_python_trivia::textwrap::dedent; use ruff_source_file::SourceFileBuilder; -use ruff_text_size::Ranged; -use crate::fix::{fix_file, FixResult}; +use crate::fix::{FixResult, fix_file}; use crate::linter::check_path; use crate::message::{Emitter, EmitterContext, Message, TextEmitter}; +use crate::package::PackageRoot; use crate::packaging::detect_package_root; -use crate::registry::AsRule; use crate::settings::types::UnsafeFixes; -use crate::settings::{flags, LinterSettings}; +use crate::settings::{LinterSettings, flags}; use crate::source_kind::SourceKind; -use crate::{directives, Locator}; +use crate::{Locator, directives}; #[cfg(not(fuzzing))] pub(crate) fn test_resource_path(path: impl AsRef<Path>) -> std::path::PathBuf { @@ -60,7 +60,7 @@ pub(crate) fn assert_notebook_path( ) -> Result<TestedNotebook, NotebookError> { let source_notebook = Notebook::from_path(path.as_ref())?; - let source_kind = SourceKind::IpyNotebook(source_notebook); + let source_kind = SourceKind::ipy_notebook(source_notebook); let (messages, transformed) = test_contents(&source_kind, path.as_ref(), settings); let expected_notebook = Notebook::from_path(expected.as_ref())?; let linted_notebook = transformed.into_owned().expect_ipy_notebook(); @@ -109,7 +109,12 @@ pub(crate) fn test_contents<'a>( settings: &LinterSettings, ) -> (Vec<Message>, Cow<'a, SourceKind>) { let source_type = PySourceType::from(path); - let parsed = ruff_python_parser::parse_unchecked_source(source_kind.source_code(), source_type); + let target_version = settings.resolve_target_version(path); + let options = + ParseOptions::from(source_type).with_target_version(target_version.parser_version()); + let parsed = ruff_python_parser::parse_unchecked(source_kind.source_code(), options.clone()) + .try_into_module() + .expect("PySourceType always parses into a module"); let locator = Locator::new(source_kind.source_code()); let stylist = Stylist::from_tokens(parsed.tokens(), locator.contents()); let indexer = Indexer::from_tokens(parsed.tokens(), locator.contents()); @@ -119,10 +124,11 @@ pub(crate) fn test_contents<'a>( &locator, &indexer, ); - let diagnostics = check_path( + let messages = check_path( path, path.parent() - .and_then(|parent| detect_package_root(parent, &settings.namespace_packages)), + .and_then(|parent| detect_package_root(parent, &settings.namespace_packages)) + .map(|path| PackageRoot::Root { path }), &locator, &stylist, &indexer, @@ -132,34 +138,32 @@ pub(crate) fn test_contents<'a>( source_kind, source_type, &parsed, + target_version, ); - let source_has_errors = !parsed.is_valid(); + let source_has_errors = parsed.has_invalid_syntax(); // Detect fixes that don't converge after multiple iterations. let mut iterations = 0; let mut transformed = Cow::Borrowed(source_kind); - if diagnostics - .iter() - .any(|diagnostic| diagnostic.fix.is_some()) - { - let mut diagnostics = diagnostics.clone(); + if messages.iter().any(|message| message.fix().is_some()) { + let mut messages = messages.clone(); while let Some(FixResult { code: fixed_contents, source_map, .. }) = fix_file( - &diagnostics, + &messages, &Locator::new(transformed.source_code()), UnsafeFixes::Enabled, ) { if iterations < max_iterations() { iterations += 1; } else { - let output = print_diagnostics(diagnostics, path, &transformed); + let output = print_diagnostics(messages, path, &transformed); panic!( "Failed to converge after {} iterations. This likely \ @@ -172,7 +176,9 @@ pub(crate) fn test_contents<'a>( transformed = Cow::Owned(transformed.updated(fixed_contents, &source_map)); let parsed = - ruff_python_parser::parse_unchecked_source(transformed.source_code(), source_type); + ruff_python_parser::parse_unchecked(transformed.source_code(), options.clone()) + .try_into_module() + .expect("PySourceType always parses into a module"); let locator = Locator::new(transformed.source_code()); let stylist = Stylist::from_tokens(parsed.tokens(), locator.contents()); let indexer = Indexer::from_tokens(parsed.tokens(), locator.contents()); @@ -183,7 +189,7 @@ pub(crate) fn test_contents<'a>( &indexer, ); - let fixed_diagnostics = check_path( + let fixed_messages = check_path( path, None, &locator, @@ -195,11 +201,12 @@ pub(crate) fn test_contents<'a>( &transformed, source_type, &parsed, + target_version, ); - if !parsed.is_valid() && !source_has_errors { + if parsed.has_invalid_syntax() && !source_has_errors { // Previous fix introduced a syntax error, abort - let fixes = print_diagnostics(diagnostics, path, source_kind); + let fixes = print_diagnostics(messages, path, source_kind); let syntax_errors = print_syntax_errors(parsed.errors(), path, &locator, &transformed); @@ -214,7 +221,7 @@ Source with applied fixes: ); } - diagnostics = fixed_diagnostics; + messages = fixed_messages; } } @@ -224,11 +231,11 @@ Source with applied fixes: ) .finish(); - let messages = diagnostics + let messages = messages .into_iter() - .map(|diagnostic| { - let rule = diagnostic.kind.rule(); - let fixable = diagnostic.fix.as_ref().is_some_and(|fix| { + .filter_map(|msg| Some((msg.to_rule()?, msg))) + .map(|(rule, mut diagnostic)| { + let fixable = diagnostic.fix().is_some_and(|fix| { matches!( fix.applicability(), Applicability::Safe | Applicability::Unsafe @@ -261,15 +268,22 @@ Either ensure you always emit a fix or change `Violation::FIX_AVAILABILITY` to e } assert!( - !(fixable && diagnostic.kind.suggestion.is_none()), + !(fixable && diagnostic.suggestion().is_none()), "Diagnostic emitted by {rule:?} is fixable but \ `Violation::fix_title` returns `None`" ); - // Not strictly necessary but adds some coverage for this code path - let noqa = directives.noqa_line_for.resolve(diagnostic.start()); + // Not strictly necessary but adds some coverage for this code path by overriding the + // noqa offset and the source file + let range = diagnostic.range(); + diagnostic.noqa_offset = Some(directives.noqa_line_for.resolve(range.start())); + if let Some(annotation) = diagnostic.diagnostic.primary_annotation_mut() { + annotation.set_span( + ruff_db::diagnostic::Span::from(source_code.clone()).with_range(range), + ); + } - Message::from_diagnostic(diagnostic, source_code.clone(), noqa) + diagnostic }) .chain(parsed.errors().iter().map(|parse_error| { Message::from_parse_error(parse_error, &locator, source_code.clone()) @@ -300,18 +314,9 @@ fn print_syntax_errors( } } -fn print_diagnostics(diagnostics: Vec<Diagnostic>, path: &Path, source: &SourceKind) -> String { - let filename = path.file_name().unwrap().to_string_lossy(); - let source_file = SourceFileBuilder::new(filename.as_ref(), source.source_code()).finish(); - - let messages: Vec<_> = diagnostics - .into_iter() - .map(|diagnostic| { - let noqa_start = diagnostic.start(); - - Message::from_diagnostic(diagnostic, source_file.clone(), noqa_start) - }) - .collect(); +/// Print the [`Message::Diagnostic`]s in `messages`. +fn print_diagnostics(mut messages: Vec<Message>, path: &Path, source: &SourceKind) -> String { + messages.retain(|msg| !msg.is_syntax_error()); if let Some(notebook) = source.as_ipy_notebook() { print_jupyter_messages(&messages, path, notebook) diff --git a/crates/ruff_macros/Cargo.toml b/crates/ruff_macros/Cargo.toml index c0215053c5393..7e72d59855f72 100644 --- a/crates/ruff_macros/Cargo.toml +++ b/crates/ruff_macros/Cargo.toml @@ -17,6 +17,7 @@ doctest = false [dependencies] ruff_python_trivia = { workspace = true } +heck = { workspace = true } proc-macro2 = { workspace = true } quote = { workspace = true } syn = { workspace = true, features = ["derive", "parsing", "extra-traits", "full"] } diff --git a/crates/ruff_macros/src/cache_key.rs b/crates/ruff_macros/src/cache_key.rs index 65418ac4aa1d1..747fd3726061d 100644 --- a/crates/ruff_macros/src/cache_key.rs +++ b/crates/ruff_macros/src/cache_key.rs @@ -92,7 +92,7 @@ pub(crate) fn derive_cache_key(item: &DeriveInput) -> syn::Result<TokenStream> { return Err(Error::new( item.span(), "CacheKey does not support unions. Only structs and enums are supported", - )) + )); } }; @@ -143,7 +143,7 @@ impl Parse for CacheKeyFieldAttributes { return Err(Error::new( arg.span(), format!("Unknown `cache_field` argument {name}"), - )) + )); } } } diff --git a/crates/ruff_macros/src/combine.rs b/crates/ruff_macros/src/combine.rs new file mode 100644 index 0000000000000..3d755d8ac09d9 --- /dev/null +++ b/crates/ruff_macros/src/combine.rs @@ -0,0 +1,36 @@ +use quote::{quote, quote_spanned}; +use syn::spanned::Spanned; +use syn::{Data, DataStruct, DeriveInput}; + +pub(crate) fn derive_impl(input: DeriveInput) -> syn::Result<proc_macro2::TokenStream> { + let DeriveInput { ident, data, .. } = input; + + match data { + Data::Struct(DataStruct { fields, .. }) => { + let output: Vec<_> = fields + .members() + .map(|member| { + + quote_spanned!( + member.span() => crate::combine::Combine::combine_with(&mut self.#member, other.#member) + ) + }) + .collect(); + + Ok(quote! { + #[automatically_derived] + impl crate::combine::Combine for #ident { + fn combine_with(&mut self, other: Self) { + #( + #output + );* + } + } + }) + } + _ => Err(syn::Error::new( + ident.span(), + "Can only derive Combine from structs.", + )), + } +} diff --git a/crates/ruff_macros/src/combine_options.rs b/crates/ruff_macros/src/combine_options.rs index 05b2395e072bf..46d99965f6003 100644 --- a/crates/ruff_macros/src/combine_options.rs +++ b/crates/ruff_macros/src/combine_options.rs @@ -19,7 +19,7 @@ pub(crate) fn derive_impl(input: DeriveInput) -> syn::Result<proc_macro2::TokenS #[automatically_derived] impl crate::configuration::CombinePluginOptions for #ident { fn combine(self, other: Self) -> Self { - #[allow(deprecated)] + #[expect(deprecated)] Self { #( #output diff --git a/crates/ruff_macros/src/config.rs b/crates/ruff_macros/src/config.rs index 0df56a2256426..6d4f6e4d90c41 100644 --- a/crates/ruff_macros/src/config.rs +++ b/crates/ruff_macros/src/config.rs @@ -86,8 +86,8 @@ pub(crate) fn derive_impl(input: DeriveInput) -> syn::Result<TokenStream> { Ok(quote! { #[automatically_derived] - impl crate::options_base::OptionsMetadata for #ident { - fn record(visit: &mut dyn crate::options_base::Visit) { + impl ruff_options_metadata::OptionsMetadata for #ident { + fn record(visit: &mut dyn ruff_options_metadata::Visit) { #(#output);* } @@ -125,7 +125,7 @@ fn handle_option_group(field: &Field) -> syn::Result<proc_macro2::TokenStream> { let kebab_name = LitStr::new(&ident.to_string().replace('_', "-"), ident.span()); Ok(quote_spanned!( - ident.span() => (visit.record_set(#kebab_name, crate::options_base::OptionSet::of::<#path>())) + ident.span() => (visit.record_set(#kebab_name, ruff_options_metadata::OptionSet::of::<#path>())) )) } _ => Err(syn::Error::new( @@ -214,14 +214,14 @@ fn handle_option(field: &Field, attr: &Attribute) -> syn::Result<proc_macro2::To let note = quote_option(deprecated.note); let since = quote_option(deprecated.since); - quote!(Some(crate::options_base::Deprecated { since: #since, message: #note })) + quote!(Some(ruff_options_metadata::Deprecated { since: #since, message: #note })) } else { quote!(None) }; Ok(quote_spanned!( ident.span() => { - visit.record_field(#kebab_name, crate::options_base::OptionField{ + visit.record_field(#kebab_name, ruff_options_metadata::OptionField{ doc: &#doc, default: &#default, value_type: &#value_type, @@ -271,15 +271,24 @@ fn parse_field_attributes(attribute: &Attribute) -> syn::Result<FieldAttributes> })?; let Some(default) = default else { - return Err(syn::Error::new(attribute.span(), "Mandatory `default` field is missing in `#[option]` attribute. Specify the default using `#[option(default=\"..\")]`.")); + return Err(syn::Error::new( + attribute.span(), + "Mandatory `default` field is missing in `#[option]` attribute. Specify the default using `#[option(default=\"..\")]`.", + )); }; let Some(value_type) = value_type else { - return Err(syn::Error::new(attribute.span(), "Mandatory `value_type` field is missing in `#[option]` attribute. Specify the value type using `#[option(value_type=\"..\")]`.")); + return Err(syn::Error::new( + attribute.span(), + "Mandatory `value_type` field is missing in `#[option]` attribute. Specify the value type using `#[option(value_type=\"..\")]`.", + )); }; let Some(example) = example else { - return Err(syn::Error::new(attribute.span(), "Mandatory `example` field is missing in `#[option]` attribute. Add an example using `#[option(example=\"..\")]`.")); + return Err(syn::Error::new( + attribute.span(), + "Mandatory `example` field is missing in `#[option]` attribute. Add an example using `#[option(example=\"..\")]`.", + )); }; Ok(FieldAttributes { diff --git a/crates/ruff_macros/src/derive_message_formats.rs b/crates/ruff_macros/src/derive_message_formats.rs index c155ffb00bb41..67d522f9b76f5 100644 --- a/crates/ruff_macros/src/derive_message_formats.rs +++ b/crates/ruff_macros/src/derive_message_formats.rs @@ -1,7 +1,8 @@ use proc_macro2::TokenStream; -use quote::{quote, quote_spanned, ToTokens}; +use quote::{ToTokens, quote, quote_spanned}; use syn::spanned::Spanned; -use syn::{Block, Expr, ItemFn, Stmt}; +use syn::token::{Dot, Paren}; +use syn::{Block, Expr, ExprLit, ExprMethodCall, ItemFn, Lit, Stmt}; pub(crate) fn derive_message_formats(func: &ItemFn) -> TokenStream { let mut strings = quote!(); @@ -29,11 +30,22 @@ fn parse_block(block: &Block, strings: &mut TokenStream) -> Result<(), TokenStre fn parse_expr(expr: &Expr, strings: &mut TokenStream) -> Result<(), TokenStream> { match expr { Expr::Macro(mac) if mac.mac.path.is_ident("format") => { - let Some(first_token) = mac.mac.tokens.to_token_stream().into_iter().next() else { + let mut tokens = mac.mac.tokens.to_token_stream().into_iter(); + let Some(first_token) = tokens.next() else { return Err( - quote_spanned!(expr.span() => compile_error!("expected format! to have an argument")), + quote_spanned!(expr.span() => compile_error!("expected `format!` to have an argument")), ); }; + // do not throw an error if the `format!` argument contains a formatting argument + + if !first_token.to_string().contains('{') { + // comma and string + if tokens.next().is_none() || tokens.next().is_none() { + return Err( + quote_spanned!(expr.span() => compile_error!("prefer `String::to_string` over `format!` without arguments")), + ); + } + } strings.extend(quote! {#first_token,}); Ok(()) } @@ -45,6 +57,40 @@ fn parse_expr(expr: &Expr, strings: &mut TokenStream) -> Result<(), TokenStream> } Ok(()) } + Expr::MethodCall(method_call) => match method_call { + ExprMethodCall { + method, + receiver, + attrs, + dot_token, + turbofish: None, + paren_token, + args, + } if *method == *"to_string" + && attrs.is_empty() + && args.is_empty() + && *paren_token == Paren::default() + && *dot_token == Dot::default() => + { + let Expr::Lit(ExprLit { + lit: Lit::Str(ref literal_string), + .. + }) = **receiver + else { + return Err( + quote_spanned!(expr.span() => compile_error!("expected `String::to_string` method on str literal")), + ); + }; + + let str_token = literal_string.token(); + + strings.extend(quote! {#str_token,}); + Ok(()) + } + _ => Err( + quote_spanned!(expr.span() => compile_error!("expected `String::to_string` method on str literal")), + ), + }, Expr::Match(block) => { for arm in &block.arms { parse_expr(&arm.body, strings)?; @@ -53,7 +99,7 @@ fn parse_expr(expr: &Expr, strings: &mut TokenStream) -> Result<(), TokenStream> } _ => Err(quote_spanned!( expr.span() => - compile_error!("expected last expression to be a format! macro or a match block") + compile_error!("expected last expression to be a `format!` macro, a static String or a match block") )), } } diff --git a/crates/ruff_macros/src/kebab_case.rs b/crates/ruff_macros/src/kebab_case.rs new file mode 100644 index 0000000000000..3b7ef3f8db0a0 --- /dev/null +++ b/crates/ruff_macros/src/kebab_case.rs @@ -0,0 +1,10 @@ +use heck::ToKebabCase; +use proc_macro2::TokenStream; + +pub(crate) fn kebab_case(input: &syn::Ident) -> TokenStream { + let s = input.to_string(); + + let kebab_case_lit = syn::LitStr::new(&s.to_kebab_case(), input.span()); + + quote::quote!(#kebab_case_lit) +} diff --git a/crates/ruff_macros/src/lib.rs b/crates/ruff_macros/src/lib.rs index 04b9109982959..1f8089b711160 100644 --- a/crates/ruff_macros/src/lib.rs +++ b/crates/ruff_macros/src/lib.rs @@ -2,18 +2,21 @@ use crate::cache_key::derive_cache_key; use crate::newtype_index::generate_newtype_index; +use crate::violation_metadata::violation_metadata; use proc_macro::TokenStream; -use syn::{parse_macro_input, DeriveInput, ItemFn, ItemStruct}; +use syn::{DeriveInput, Error, ItemFn, ItemStruct, parse_macro_input}; mod cache_key; +mod combine; mod combine_options; mod config; mod derive_message_formats; +mod kebab_case; mod map_codes; mod newtype_index; mod rule_code_prefix; mod rule_namespace; -mod violation; +mod violation_metadata; #[proc_macro_derive(OptionsMetadata, attributes(option, doc, option_group))] pub fn derive_options_metadata(input: TokenStream) -> TokenStream { @@ -33,6 +36,27 @@ pub fn derive_combine_options(input: TokenStream) -> TokenStream { .into() } +/// Automatically derives a `ty_project::project::Combine` implementation for the attributed type +/// that calls `ty_project::project::Combine::combine` for each field. +/// +/// The derive macro can only be used on structs. Enums aren't yet supported. +#[proc_macro_derive(Combine)] +pub fn derive_combine(input: TokenStream) -> TokenStream { + let input = parse_macro_input!(input as DeriveInput); + + combine::derive_impl(input) + .unwrap_or_else(syn::Error::into_compile_error) + .into() +} + +/// Converts an identifier to a kebab case string. +#[proc_macro] +pub fn kebab_case(input: TokenStream) -> TokenStream { + let input = parse_macro_input!(input as syn::Ident); + + kebab_case::kebab_case(&input).into() +} + /// Generates a [`CacheKey`] implementation for the attributed type. /// /// Struct fields can be attributed with the `cache_key` field-attribute that supports: @@ -47,12 +71,12 @@ pub fn cache_key(input: TokenStream) -> TokenStream { TokenStream::from(stream) } -/// Adds an `explanation()` method from the doc comment. -#[proc_macro_attribute] -pub fn violation(_attr: TokenStream, item: TokenStream) -> TokenStream { - let violation = parse_macro_input!(item as ItemStruct); - violation::violation(&violation) - .unwrap_or_else(syn::Error::into_compile_error) +#[proc_macro_derive(ViolationMetadata)] +pub fn derive_violation_metadata(item: TokenStream) -> TokenStream { + let input: DeriveInput = parse_macro_input!(item); + + violation_metadata(input) + .unwrap_or_else(Error::into_compile_error) .into() } diff --git a/crates/ruff_macros/src/map_codes.rs b/crates/ruff_macros/src/map_codes.rs index 49cdf560691e5..c5e7b9879be88 100644 --- a/crates/ruff_macros/src/map_codes.rs +++ b/crates/ruff_macros/src/map_codes.rs @@ -2,10 +2,10 @@ use std::collections::{BTreeMap, HashMap}; use itertools::Itertools; use proc_macro2::TokenStream; -use quote::{quote, ToTokens}; +use quote::{ToTokens, quote}; use syn::{ - parenthesized, parse::Parse, spanned::Spanned, Attribute, Error, Expr, ExprCall, ExprMatch, - Ident, ItemFn, LitStr, Pat, Path, Stmt, Token, + Attribute, Error, Expr, ExprCall, ExprMatch, Ident, ItemFn, LitStr, Pat, Path, Stmt, Token, + parenthesized, parse::Parse, spanned::Spanned, }; use crate::rule_code_prefix::{get_prefix_ident, intersection_all}; @@ -404,8 +404,6 @@ fn register_rules<'a>(input: impl Iterator<Item = &'a Rule>) -> TokenStream { let mut rule_fixable_match_arms = quote!(); let mut rule_explanation_match_arms = quote!(); - let mut from_impls_for_diagnostic_kind = quote!(); - for Rule { name, attrs, path, .. } in input @@ -420,12 +418,7 @@ fn register_rules<'a>(input: impl Iterator<Item = &'a Rule>) -> TokenStream { rule_fixable_match_arms.extend( quote! {#(#attrs)* Self::#name => <#path as ruff_diagnostics::Violation>::FIX_AVAILABILITY,}, ); - rule_explanation_match_arms - .extend(quote! {#(#attrs)* Self::#name => #path::explanation(),}); - - // Enable conversion from `DiagnosticKind` to `Rule`. - from_impls_for_diagnostic_kind - .extend(quote! {#(#attrs)* stringify!(#name) => Rule::#name,}); + rule_explanation_match_arms.extend(quote! {#(#attrs)* Self::#name => #path::explain(),}); } quote! { @@ -444,6 +437,9 @@ fn register_rules<'a>(input: impl Iterator<Item = &'a Rule>) -> TokenStream { ::ruff_macros::CacheKey, AsRefStr, ::strum_macros::IntoStaticStr, + ::strum_macros::EnumString, + ::serde::Serialize, + ::serde::Deserialize, )] #[repr(u16)] #[strum(serialize_all = "kebab-case")] @@ -457,6 +453,7 @@ fn register_rules<'a>(input: impl Iterator<Item = &'a Rule>) -> TokenStream { /// Returns the documentation for this rule. pub fn explanation(&self) -> Option<&'static str> { + use ruff_diagnostics::ViolationMetadata; match self { #rule_explanation_match_arms } } @@ -466,14 +463,14 @@ fn register_rules<'a>(input: impl Iterator<Item = &'a Rule>) -> TokenStream { } } - impl AsRule for ruff_diagnostics::DiagnosticKind { + impl AsRule for ruff_diagnostics::Diagnostic { fn rule(&self) -> Rule { - match self.name.as_str() { - #from_impls_for_diagnostic_kind - _ => unreachable!("invalid rule name: {}", self.name), - } + self.name + .parse() + .unwrap_or_else(|_| unreachable!("invalid rule name: {}", self.name)) } } + } } diff --git a/crates/ruff_macros/src/newtype_index.rs b/crates/ruff_macros/src/newtype_index.rs index ad3638d21f7b6..99663542d7a7e 100644 --- a/crates/ruff_macros/src/newtype_index.rs +++ b/crates/ruff_macros/src/newtype_index.rs @@ -48,7 +48,7 @@ pub(super) fn generate_newtype_index(item: ItemStruct) -> syn::Result<proc_macro // // N.B. We have to use the unchecked variant here because we're // in a const context and Option::unwrap isn't const yet. - #[allow(unsafe_code)] + #[expect(unsafe_code)] Self(unsafe { std::num::NonZeroU32::new_unchecked((value as u32) + 1) }) } @@ -61,7 +61,7 @@ pub(super) fn generate_newtype_index(item: ItemStruct) -> syn::Result<proc_macro // // N.B. We have to use the unchecked variant here because we're // in a const context and Option::unwrap isn't const yet. - #[allow(unsafe_code)] + #[expect(unsafe_code)] Self(unsafe { std::num::NonZeroU32::new_unchecked(value + 1) }) } diff --git a/crates/ruff_macros/src/violation.rs b/crates/ruff_macros/src/violation.rs deleted file mode 100644 index 028a5e5a41330..0000000000000 --- a/crates/ruff_macros/src/violation.rs +++ /dev/null @@ -1,95 +0,0 @@ -use proc_macro2::TokenStream; -use quote::quote; -use syn::{Attribute, Error, ItemStruct, Lit, LitStr, Meta, Result}; - -fn parse_attr<'a, const LEN: usize>( - path: [&'static str; LEN], - attr: &'a Attribute, -) -> Option<&'a LitStr> { - if let Meta::NameValue(name_value) = &attr.meta { - let path_idents = name_value - .path - .segments - .iter() - .map(|segment| &segment.ident); - - if itertools::equal(path_idents, path) { - if let syn::Expr::Lit(syn::ExprLit { - lit: Lit::Str(lit), .. - }) = &name_value.value - { - return Some(lit); - } - } - } - - None -} - -/// Collect all doc comment attributes into a string -fn get_docs(attrs: &[Attribute]) -> Result<String> { - let mut explanation = String::new(); - for attr in attrs { - if attr.path().is_ident("doc") { - if let Some(lit) = parse_attr(["doc"], attr) { - let value = lit.value(); - // `/// ` adds - let line = value.strip_prefix(' ').unwrap_or(&value); - explanation.push_str(line); - explanation.push('\n'); - } else { - return Err(Error::new_spanned(attr, "unimplemented doc comment style")); - } - } - } - Ok(explanation) -} - -pub(crate) fn violation(violation: &ItemStruct) -> Result<TokenStream> { - let ident = &violation.ident; - let explanation = get_docs(&violation.attrs)?; - let violation = if explanation.trim().is_empty() { - quote! { - #[derive(Debug, PartialEq, Eq)] - #violation - - #[automatically_derived] - impl From<#ident> for ruff_diagnostics::DiagnosticKind { - fn from(value: #ident) -> Self { - use ruff_diagnostics::Violation; - - Self { - body: Violation::message(&value), - suggestion: Violation::fix_title(&value), - name: stringify!(#ident).to_string(), - } - } - } - } - } else { - quote! { - #[derive(Debug, PartialEq, Eq)] - #violation - - impl #ident { - pub fn explanation() -> Option<&'static str> { - Some(#explanation) - } - } - - #[automatically_derived] - impl From<#ident> for ruff_diagnostics::DiagnosticKind { - fn from(value: #ident) -> Self { - use ruff_diagnostics::Violation; - - Self { - body: Violation::message(&value), - suggestion: Violation::fix_title(&value), - name: stringify!(#ident).to_string(), - } - } - } - } - }; - Ok(violation) -} diff --git a/crates/ruff_macros/src/violation_metadata.rs b/crates/ruff_macros/src/violation_metadata.rs new file mode 100644 index 0000000000000..3cf60307abf40 --- /dev/null +++ b/crates/ruff_macros/src/violation_metadata.rs @@ -0,0 +1,66 @@ +use proc_macro2::TokenStream; +use quote::quote; +use syn::{Attribute, DeriveInput, Error, Lit, LitStr, Meta}; + +pub(crate) fn violation_metadata(input: DeriveInput) -> syn::Result<TokenStream> { + let docs = get_docs(&input.attrs)?; + + let name = input.ident; + + Ok(quote! { + #[automatically_derived] + #[expect(deprecated)] + impl ruff_diagnostics::ViolationMetadata for #name { + fn rule_name() -> &'static str { + ::ruff_macros::kebab_case!(#name) + } + + fn explain() -> Option<&'static str> { + Some(#docs) + } + } + }) +} + +/// Collect all doc comment attributes into a string +fn get_docs(attrs: &[Attribute]) -> syn::Result<String> { + let mut explanation = String::new(); + for attr in attrs { + if attr.path().is_ident("doc") { + if let Some(lit) = parse_attr(["doc"], attr) { + let value = lit.value(); + // `/// ` adds + let line = value.strip_prefix(' ').unwrap_or(&value); + explanation.push_str(line); + explanation.push('\n'); + } else { + return Err(Error::new_spanned(attr, "unimplemented doc comment style")); + } + } + } + Ok(explanation) +} + +fn parse_attr<'a, const LEN: usize>( + path: [&'static str; LEN], + attr: &'a Attribute, +) -> Option<&'a LitStr> { + if let Meta::NameValue(name_value) = &attr.meta { + let path_idents = name_value + .path + .segments + .iter() + .map(|segment| &segment.ident); + + if itertools::equal(path_idents, path) { + if let syn::Expr::Lit(syn::ExprLit { + lit: Lit::Str(lit), .. + }) = &name_value.value + { + return Some(lit); + } + } + } + + None +} diff --git a/crates/ruff_notebook/src/cell.rs b/crates/ruff_notebook/src/cell.rs index c917dd16274b8..56c1822341f79 100644 --- a/crates/ruff_notebook/src/cell.rs +++ b/crates/ruff_notebook/src/cell.rs @@ -5,8 +5,8 @@ use itertools::Itertools; use ruff_text_size::{TextRange, TextSize}; -use crate::schema::{Cell, SourceValue}; use crate::CellMetadata; +use crate::schema::{Cell, SourceValue}; impl fmt::Display for SourceValue { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { @@ -66,7 +66,7 @@ impl Cell { .metadata .vscode .as_ref() - .map_or(true, |vscode| vscode.language_id == "python") => + .is_none_or(|vscode| vscode.language_id == "python") => { &cell.source } diff --git a/crates/ruff_notebook/src/index.rs b/crates/ruff_notebook/src/index.rs index 9912b94e6225e..35e4e07fcbe52 100644 --- a/crates/ruff_notebook/src/index.rs +++ b/crates/ruff_notebook/src/index.rs @@ -1,6 +1,6 @@ use serde::{Deserialize, Serialize}; -use ruff_source_file::{OneIndexed, SourceLocation}; +use ruff_source_file::{LineColumn, OneIndexed, SourceLocation}; /// Jupyter Notebook indexing table /// @@ -33,16 +33,29 @@ impl NotebookIndex { self.row_to_row_in_cell.get(row.to_zero_indexed()).copied() } - /// Translates the given source location based on the indexing table. + /// Translates the given [`LineColumn`] based on the indexing table. /// /// This will translate the row/column in the concatenated source code /// to the row/column in the Jupyter Notebook. - pub fn translate_location(&self, source_location: &SourceLocation) -> SourceLocation { - SourceLocation { - row: self - .cell_row(source_location.row) + pub fn translate_line_column(&self, source_location: &LineColumn) -> LineColumn { + LineColumn { + line: self + .cell_row(source_location.line) .unwrap_or(OneIndexed::MIN), column: source_location.column, } } + + /// Translates the given [`SourceLocation`] based on the indexing table. + /// + /// This will translate the line/character in the concatenated source code + /// to the line/character in the Jupyter Notebook. + pub fn translate_source_location(&self, source_location: &SourceLocation) -> SourceLocation { + SourceLocation { + line: self + .cell_row(source_location.line) + .unwrap_or(OneIndexed::MIN), + character_offset: source_location.character_offset, + } + } } diff --git a/crates/ruff_notebook/src/notebook.rs b/crates/ruff_notebook/src/notebook.rs index 3ec9108e0373d..124202e9274cc 100644 --- a/crates/ruff_notebook/src/notebook.rs +++ b/crates/ruff_notebook/src/notebook.rs @@ -5,10 +5,10 @@ use serde_json::error::Category; use std::cmp::Ordering; use std::collections::HashSet; use std::fs::File; +use std::io; use std::io::{BufReader, Cursor, Read, Seek, SeekFrom, Write}; use std::path::Path; use std::sync::OnceLock; -use std::{io, iter}; use thiserror::Error; use ruff_diagnostics::{SourceMap, SourceMarker}; @@ -18,7 +18,7 @@ use ruff_text_size::TextSize; use crate::cell::CellOffsets; use crate::index::NotebookIndex; use crate::schema::{Cell, RawNotebook, SortAlphabetically, SourceValue}; -use crate::{schema, CellMetadata, RawNotebookMetadata}; +use crate::{CellMetadata, RawNotebookMetadata, schema}; /// Run round-trip source code generation on a given Jupyter notebook file path. pub fn round_trip(path: &Path) -> anyhow::Result<String> { @@ -43,7 +43,9 @@ pub enum NotebookError { Io(#[from] io::Error), #[error(transparent)] Json(serde_json::Error), - #[error("Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: {0}")] + #[error( + "Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: {0}" + )] InvalidJson(serde_json::Error), #[error("This file does not match the schema expected of Jupyter Notebooks: {0}")] InvalidSchema(serde_json::Error), @@ -177,7 +179,7 @@ impl Notebook { }; if id.is_none() { loop { - let new_id = uuid::Builder::from_random_bytes(rng.gen()) + let new_id = uuid::Builder::from_random_bytes(rng.random()) .into_uuid() .as_simple() .to_string(); @@ -340,9 +342,10 @@ impl Notebook { } } }; - row_to_cell.extend( - iter::repeat(OneIndexed::from_zero_indexed(cell_index as usize)).take(line_count), - ); + row_to_cell.extend(std::iter::repeat_n( + OneIndexed::from_zero_indexed(cell_index as usize), + line_count, + )); row_to_row_in_cell.extend((0..line_count).map(OneIndexed::from_zero_indexed)); } diff --git a/crates/ruff_options_metadata/Cargo.toml b/crates/ruff_options_metadata/Cargo.toml new file mode 100644 index 0000000000000..55f3f4ad19df2 --- /dev/null +++ b/crates/ruff_options_metadata/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "ruff_options_metadata" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } + +[dependencies] +serde = { workspace = true, optional = true } + +[dev-dependencies] + +[lints] +workspace = true diff --git a/crates/ruff_options_metadata/src/lib.rs b/crates/ruff_options_metadata/src/lib.rs new file mode 100644 index 0000000000000..7f7332c3c2429 --- /dev/null +++ b/crates/ruff_options_metadata/src/lib.rs @@ -0,0 +1,440 @@ +use std::fmt::{Debug, Display, Formatter}; + +/// Visits [`OptionsMetadata`]. +/// +/// An instance of [`Visit`] represents the logic for inspecting an object's options metadata. +pub trait Visit { + /// Visits an [`OptionField`] value named `name`. + fn record_field(&mut self, name: &str, field: OptionField); + + /// Visits an [`OptionSet`] value named `name`. + fn record_set(&mut self, name: &str, group: OptionSet); +} + +/// Returns metadata for its options. +pub trait OptionsMetadata { + /// Visits the options metadata of this object by calling `visit` for each option. + fn record(visit: &mut dyn Visit); + + fn documentation() -> Option<&'static str> { + None + } + + /// Returns the extracted metadata. + fn metadata() -> OptionSet + where + Self: Sized + 'static, + { + OptionSet::of::<Self>() + } +} + +impl<T> OptionsMetadata for Option<T> +where + T: OptionsMetadata, +{ + fn record(visit: &mut dyn Visit) { + T::record(visit); + } +} + +/// Metadata of an option that can either be a [`OptionField`] or [`OptionSet`]. +#[derive(Clone, PartialEq, Eq, Debug)] +#[cfg_attr(feature = "serde", derive(::serde::Serialize), serde(untagged))] +pub enum OptionEntry { + /// A single option. + Field(OptionField), + + /// A set of options. + Set(OptionSet), +} + +impl Display for OptionEntry { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + OptionEntry::Set(set) => std::fmt::Display::fmt(set, f), + OptionEntry::Field(field) => std::fmt::Display::fmt(&field, f), + } + } +} + +/// A set of options. +/// +/// It extracts the options by calling the [`OptionsMetadata::record`] of a type implementing +/// [`OptionsMetadata`]. +#[derive(Copy, Clone, Eq, PartialEq)] +pub struct OptionSet { + record: fn(&mut dyn Visit), + doc: fn() -> Option<&'static str>, +} + +impl OptionSet { + pub fn of<T>() -> Self + where + T: OptionsMetadata + 'static, + { + Self { + record: T::record, + doc: T::documentation, + } + } + + /// Visits the options in this set by calling `visit` for each option. + pub fn record(&self, visit: &mut dyn Visit) { + let record = self.record; + record(visit); + } + + pub fn documentation(&self) -> Option<&'static str> { + let documentation = self.doc; + documentation() + } + + /// Returns `true` if this set has an option that resolves to `name`. + /// + /// The name can be separated by `.` to find a nested option. + /// + /// ## Examples + /// + /// ### Test for the existence of a child option + /// + /// ```rust + /// # use ruff_options_metadata::{OptionField, OptionsMetadata, Visit}; + /// + /// struct WithOptions; + /// + /// impl OptionsMetadata for WithOptions { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("ignore-git-ignore", OptionField { + /// doc: "Whether Ruff should respect the gitignore file", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None, + /// }); + /// } + /// } + /// + /// assert!(WithOptions::metadata().has("ignore-git-ignore")); + /// assert!(!WithOptions::metadata().has("does-not-exist")); + /// ``` + /// ### Test for the existence of a nested option + /// + /// ```rust + /// # use ruff_options_metadata::{OptionField, OptionsMetadata, Visit}; + /// + /// struct Root; + /// + /// impl OptionsMetadata for Root { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("ignore-git-ignore", OptionField { + /// doc: "Whether Ruff should respect the gitignore file", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None + /// }); + /// + /// visit.record_set("format", Nested::metadata()); + /// } + /// } + /// + /// struct Nested; + /// + /// impl OptionsMetadata for Nested { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("hard-tabs", OptionField { + /// doc: "Use hard tabs for indentation and spaces for alignment.", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None + /// }); + /// } + /// } + /// + /// assert!(Root::metadata().has("format.hard-tabs")); + /// assert!(!Root::metadata().has("format.spaces")); + /// assert!(!Root::metadata().has("lint.hard-tabs")); + /// ``` + pub fn has(&self, name: &str) -> bool { + self.find(name).is_some() + } + + /// Returns `Some` if this set has an option that resolves to `name` and `None` otherwise. + /// + /// The name can be separated by `.` to find a nested option. + /// + /// ## Examples + /// + /// ### Find a child option + /// + /// ```rust + /// # use ruff_options_metadata::{OptionEntry, OptionField, OptionsMetadata, Visit}; + /// + /// struct WithOptions; + /// + /// static IGNORE_GIT_IGNORE: OptionField = OptionField { + /// doc: "Whether Ruff should respect the gitignore file", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None + /// }; + /// + /// impl OptionsMetadata for WithOptions { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("ignore-git-ignore", IGNORE_GIT_IGNORE.clone()); + /// } + /// } + /// + /// assert_eq!(WithOptions::metadata().find("ignore-git-ignore"), Some(OptionEntry::Field(IGNORE_GIT_IGNORE.clone()))); + /// assert_eq!(WithOptions::metadata().find("does-not-exist"), None); + /// ``` + /// ### Find a nested option + /// + /// ```rust + /// # use ruff_options_metadata::{OptionEntry, OptionField, OptionsMetadata, Visit}; + /// + /// static HARD_TABS: OptionField = OptionField { + /// doc: "Use hard tabs for indentation and spaces for alignment.", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None + /// }; + /// + /// struct Root; + /// + /// impl OptionsMetadata for Root { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("ignore-git-ignore", OptionField { + /// doc: "Whether Ruff should respect the gitignore file", + /// default: "false", + /// value_type: "bool", + /// example: "", + /// scope: None, + /// deprecated: None + /// }); + /// + /// visit.record_set("format", Nested::metadata()); + /// } + /// } + /// + /// struct Nested; + /// + /// impl OptionsMetadata for Nested { + /// fn record(visit: &mut dyn Visit) { + /// visit.record_field("hard-tabs", HARD_TABS.clone()); + /// } + /// } + /// + /// assert_eq!(Root::metadata().find("format.hard-tabs"), Some(OptionEntry::Field(HARD_TABS.clone()))); + /// assert_eq!(Root::metadata().find("format"), Some(OptionEntry::Set(Nested::metadata()))); + /// assert_eq!(Root::metadata().find("format.spaces"), None); + /// assert_eq!(Root::metadata().find("lint.hard-tabs"), None); + /// ``` + pub fn find(&self, name: &str) -> Option<OptionEntry> { + struct FindOptionVisitor<'a> { + option: Option<OptionEntry>, + parts: std::str::Split<'a, char>, + needle: &'a str, + } + + impl Visit for FindOptionVisitor<'_> { + fn record_set(&mut self, name: &str, set: OptionSet) { + if self.option.is_none() && name == self.needle { + if let Some(next) = self.parts.next() { + self.needle = next; + set.record(self); + } else { + self.option = Some(OptionEntry::Set(set)); + } + } + } + + fn record_field(&mut self, name: &str, field: OptionField) { + if self.option.is_none() && name == self.needle { + if self.parts.next().is_none() { + self.option = Some(OptionEntry::Field(field)); + } + } + } + } + + let mut parts = name.split('.'); + + if let Some(first) = parts.next() { + let mut visitor = FindOptionVisitor { + parts, + needle: first, + option: None, + }; + + self.record(&mut visitor); + visitor.option + } else { + None + } + } + + pub fn collect_fields(&self) -> Vec<(String, OptionField)> { + struct FieldsCollector(Vec<(String, OptionField)>); + + impl Visit for FieldsCollector { + fn record_field(&mut self, name: &str, field: OptionField) { + self.0.push((name.to_string(), field)); + } + + fn record_set(&mut self, _name: &str, _group: OptionSet) {} + } + + let mut visitor = FieldsCollector(vec![]); + self.record(&mut visitor); + visitor.0 + } +} + +/// Visitor that writes out the names of all fields and sets. +struct DisplayVisitor<'fmt, 'buf> { + f: &'fmt mut Formatter<'buf>, + result: std::fmt::Result, +} + +impl<'fmt, 'buf> DisplayVisitor<'fmt, 'buf> { + fn new(f: &'fmt mut Formatter<'buf>) -> Self { + Self { f, result: Ok(()) } + } + + fn finish(self) -> std::fmt::Result { + self.result + } +} + +impl Visit for DisplayVisitor<'_, '_> { + fn record_set(&mut self, name: &str, _: OptionSet) { + self.result = self.result.and_then(|()| writeln!(self.f, "{name}")); + } + + fn record_field(&mut self, name: &str, field: OptionField) { + self.result = self.result.and_then(|()| { + write!(self.f, "{name}")?; + + if field.deprecated.is_some() { + write!(self.f, " (deprecated)")?; + } + + writeln!(self.f) + }); + } +} + +impl Display for OptionSet { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + let mut visitor = DisplayVisitor::new(f); + self.record(&mut visitor); + visitor.finish() + } +} + +impl Debug for OptionSet { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + Display::fmt(self, f) + } +} + +#[derive(Debug, Eq, PartialEq, Clone)] +#[cfg_attr(feature = "serde", derive(::serde::Serialize))] +pub struct OptionField { + pub doc: &'static str, + /// Ex) `"false"` + pub default: &'static str, + /// Ex) `"bool"` + pub value_type: &'static str, + /// Ex) `"per-file-ignores"` + pub scope: Option<&'static str>, + pub example: &'static str, + pub deprecated: Option<Deprecated>, +} + +#[derive(Debug, Clone, Eq, PartialEq)] +#[cfg_attr(feature = "serde", derive(::serde::Serialize))] +pub struct Deprecated { + pub since: Option<&'static str>, + pub message: Option<&'static str>, +} + +impl Display for OptionField { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + writeln!(f, "{}", self.doc)?; + writeln!(f)?; + writeln!(f, "Default value: {}", self.default)?; + writeln!(f, "Type: {}", self.value_type)?; + + if let Some(deprecated) = &self.deprecated { + write!(f, "Deprecated")?; + + if let Some(since) = deprecated.since { + write!(f, " (since {since})")?; + } + + if let Some(message) = deprecated.message { + write!(f, ": {message}")?; + } + + writeln!(f)?; + } + + writeln!(f, "Example usage:\n```toml\n{}\n```", self.example) + } +} + +#[cfg(feature = "serde")] +mod serde { + use super::{OptionField, OptionSet, Visit}; + use serde::{Serialize, Serializer}; + use std::collections::BTreeMap; + + impl Serialize for OptionSet { + fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + let mut entries = BTreeMap::new(); + let mut visitor = SerializeVisitor { + entries: &mut entries, + }; + self.record(&mut visitor); + entries.serialize(serializer) + } + } + + struct SerializeVisitor<'a> { + entries: &'a mut BTreeMap<String, OptionField>, + } + + impl Visit for SerializeVisitor<'_> { + fn record_set(&mut self, name: &str, set: OptionSet) { + // Collect the entries of the set. + let mut entries = BTreeMap::new(); + let mut visitor = SerializeVisitor { + entries: &mut entries, + }; + set.record(&mut visitor); + + // Insert the set into the entries. + for (key, value) in entries { + self.entries.insert(format!("{name}.{key}"), value); + } + } + + fn record_field(&mut self, name: &str, field: OptionField) { + self.entries.insert(name.to_string(), field); + } + } +} diff --git a/crates/ruff_python_ast/Cargo.toml b/crates/ruff_python_ast/Cargo.toml index 0d9cbc490ff36..22f484fdbc0d1 100644 --- a/crates/ruff_python_ast/Cargo.toml +++ b/crates/ruff_python_ast/Cargo.toml @@ -26,13 +26,19 @@ is-macro = { workspace = true } itertools = { workspace = true } memchr = { workspace = true } rustc-hash = { workspace = true } +salsa = { workspace = true, optional = true } schemars = { workspace = true, optional = true } serde = { workspace = true, optional = true } [features] schemars = ["dep:schemars"] cache = ["dep:ruff_cache", "dep:ruff_macros"] -serde = ["dep:serde", "ruff_text_size/serde", "dep:ruff_cache", "compact_str/serde"] +serde = [ + "dep:serde", + "ruff_text_size/serde", + "dep:ruff_cache", + "compact_str/serde", +] [lints] workspace = true diff --git a/crates/ruff_python_ast/ast.toml b/crates/ruff_python_ast/ast.toml new file mode 100644 index 0000000000000..8d2b9e067d4d0 --- /dev/null +++ b/crates/ruff_python_ast/ast.toml @@ -0,0 +1,586 @@ +# This file is used by generate.py to autogenerate our Python AST data model. +# +# We have defined a Rust struct for each syntax node in `src/nodes.rs`. Many of +# these nodes belong to groups. For instance, there is a `Stmt` group +# consisting of all of the syntax nodes that represent valid Python statements. +# +# There is a special group named `ungrouped` that contains syntax nodes that do +# not belong to any group. +# +# Each group is defined by two sections below. The `[GROUP]` section defines +# options that control the auto-generation for that group. The `[GROUP.nodes]` +# section defines which syntax nodes belong to that group. The name of each +# entry in the nodes section must match the name of the corresponding Rust +# struct. The value of each entry defines options that control the +# auto-generation for that syntax node. +# +# The following group options are available: +# +# add_suffix_to_is_methods: [true/false] +# Controls the name of the is_foo methods of the group's enums. If false (the +# default), these methods will use the variant name in snake_case. If true, +# then the group prefix will be moved to the end before snake_casing. (That +# is, `StmtIf` will become `if_stmt`.) +# +# anynode_is_label: foo_bar +# Controls the name of the AnyNodeRef::is_foo_bar method. The default is the +# group name in snake_case. +# +# doc: +# A doc comment that is added to the group's enums. +# +# The following syntax node options are available: +# +# doc: +# A doc comment that is added to the syntax node struct. +# +# derives: +# List of derives to add to the syntax node struct. Clone, Debug, PartialEq are added by default. +# +# custom_source_order: +# A boolean that specifies if this node has a custom source order visitor implementation. +# generation of visit_source_order will be skipped for this node. +# +# fields: +# List of fields in the syntax node struct. Each field is a table with the +# following keys: +# * name - The name of the field. +# * type - The type of the field. This can be a simple type name, or a type +# type field uses a special syntax to describe the rust type: +# * `Expr` - A single expression. +# * `Expr?` - Option type. +# * `Expr*` - A vector of Expr. +# * `&Expr*` - A boxed slice of Expr. +# These properties cannot be nested, for example we cannot create a vector of option types. +# * is_annotation - If this field is a type annotation. +# +# source_order: +# Defines in what order the fields appear in source +# +# variant: +# The name of the enum variant for this syntax node. Defaults to the node +# name with the group prefix removed. (That is, `StmtIf` becomes `If`.) + +[Mod] +anynode_is_label = "module" +doc = "See also [mod](https://docs.python.org/3/library/ast.html#ast.mod)" + +[Mod.nodes.ModModule] +doc = "See also [Module](https://docs.python.org/3/library/ast.html#ast.Module)" +fields = [{ name = "body", type = "Stmt*" }] + +[Mod.nodes.ModExpression] +doc = "See also [Module](https://docs.python.org/3/library/ast.html#ast.Module)" +fields = [{ name = "body", type = "Box<Expr>" }] + +[Stmt] +add_suffix_to_is_methods = true +anynode_is_label = "statement" +doc = "See also [stmt](https://docs.python.org/3/library/ast.html#ast.stmt)" + +[Stmt.nodes.StmtFunctionDef] +doc = """See also [FunctionDef](https://docs.python.org/3/library/ast.html#ast.FunctionDef) +and [AsyncFunctionDef](https://docs.python.org/3/library/ast.html#ast.AsyncFunctionDef). + +This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type.""" +fields = [ + { name = "is_async", type = "bool" }, + { name = "decorator_list", type = "Decorator*" }, + { name = "name", type = "Identifier" }, + { name = "type_params", type = "Box<crate::TypeParams>?" }, + { name = "parameters", type = "Box<crate::Parameters>" }, + { name = "returns", type = "Expr?", is_annotation = true }, + { name = "body", type = "Stmt*" }, +] + +[Stmt.nodes.StmtClassDef] +doc = "See also [ClassDef](https://docs.python.org/3/library/ast.html#ast.ClassDef)" +fields = [ + { name = "decorator_list", type = "Decorator*" }, + { name = "name", type = "Identifier" }, + { name = "type_params", type = "Box<crate::TypeParams>?" }, + { name = "arguments", type = "Box<crate::Arguments>?" }, + { name = "body", type = "Stmt*" }, +] + +[Stmt.nodes.StmtReturn] +doc = "See also [Return](https://docs.python.org/3/library/ast.html#ast.Return)" +fields = [{ name = "value", type = "Expr?" }] + +[Stmt.nodes.StmtDelete] +doc = "See also [Delete](https://docs.python.org/3/library/ast.html#ast.Delete)" +fields = [{ name = "targets", type = "Expr*" }] + +[Stmt.nodes.StmtTypeAlias] +doc = "See also [TypeAlias](https://docs.python.org/3/library/ast.html#ast.TypeAlias)" +fields = [ + { name = "name", type = "Expr" }, + { name = "type_params", type = "Box<crate::TypeParams>?" }, + { name = "value", type = "Expr" }, +] + +[Stmt.nodes.StmtAssign] +doc = "See also [Assign](https://docs.python.org/3/library/ast.html#ast.Assign)" +fields = [ + { name = "targets", type = "Expr*" }, + { name = "value", type = "Expr" }, +] + +[Stmt.nodes.StmtAugAssign] +doc = "See also [AugAssign](https://docs.python.org/3/library/ast.html#ast.AugAssign)" +fields = [ + { name = "target", type = "Expr" }, + { name = "op", type = "Operator" }, + { name = "value", type = "Expr" }, +] + +[Stmt.nodes.StmtAnnAssign] +doc = "See also [AnnAssign](https://docs.python.org/3/library/ast.html#ast.AnnAssign)" +fields = [ + { name = "target", type = "Expr" }, + { name = "annotation", type = "Expr", is_annotation = true }, + { name = "value", type = "Expr?" }, + { name = "simple", type = "bool" }, +] + +[Stmt.nodes.StmtFor] +doc = """See also [For](https://docs.python.org/3/library/ast.html#ast.For) +and [AsyncFor](https://docs.python.org/3/library/ast.html#ast.AsyncFor). + +This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type.""" +fields = [ + { name = "is_async", type = "bool" }, + { name = "target", type = "Expr" }, + { name = "iter", type = "Expr" }, + { name = "body", type = "Stmt*" }, + { name = "orelse", type = "Stmt*" }, +] + +[Stmt.nodes.StmtWhile] +doc = """See also [While](https://docs.python.org/3/library/ast.html#ast.While) +and [AsyncWhile](https://docs.python.org/3/library/ast.html#ast.AsyncWhile).""" +fields = [ + { name = "test", type = "Expr" }, + { name = "body", type = "Stmt*" }, + { name = "orelse", type = "Stmt*" }, +] + +[Stmt.nodes.StmtIf] +doc = "See also [If](https://docs.python.org/3/library/ast.html#ast.If)" +fields = [ + + { name = "test", type = "Expr" }, + { name = "body", type = "Stmt*" }, + { name = "elif_else_clauses", type = "ElifElseClause*" }, +] + +[Stmt.nodes.StmtWith] +doc = """See also [With](https://docs.python.org/3/library/ast.html#ast.With) +and [AsyncWith](https://docs.python.org/3/library/ast.html#ast.AsyncWith). + +This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type.""" +fields = [ + { name = "is_async", type = "bool" }, + { name = "items", type = "WithItem*" }, + { name = "body", type = "Stmt*" }, +] + +[Stmt.nodes.StmtMatch] +doc = "See also [Match](https://docs.python.org/3/library/ast.html#ast.Match)" +fields = [ + { name = "subject", type = "Expr" }, + { name = "cases", type = "MatchCase*" }, +] + +[Stmt.nodes.StmtRaise] +doc = "See also [Raise](https://docs.python.org/3/library/ast.html#ast.Raise)" +fields = [{ name = "exc", type = "Expr?" }, { name = "cause", type = "Expr?" }] + +[Stmt.nodes.StmtTry] +doc = """See also [Try](https://docs.python.org/3/library/ast.html#ast.Try) +and [TryStar](https://docs.python.org/3/library/ast.html#ast.TryStar)""" +fields = [ + { name = "body", type = "Stmt*" }, + { name = "handlers", type = "ExceptHandler*" }, + { name = "orelse", type = "Stmt*" }, + { name = "finalbody", type = "Stmt*" }, + { name = "is_star", type = "bool" }, +] + +[Stmt.nodes.StmtAssert] +doc = "See also [Assert](https://docs.python.org/3/library/ast.html#ast.Assert)" +fields = [{ name = "test", type = "Expr" }, { name = "msg", type = "Expr?" }] + +[Stmt.nodes.StmtImport] +doc = "See also [Import](https://docs.python.org/3/library/ast.html#ast.Import)" +fields = [{ name = "names", type = "Alias*" }] + +[Stmt.nodes.StmtImportFrom] +doc = "See also [ImportFrom](https://docs.python.org/3/library/ast.html#ast.ImportFrom)" +fields = [ + { name = "module", type = "Identifier?" }, + { name = "names", type = "Alias*" }, + { name = "level", type = "u32" }, +] + +[Stmt.nodes.StmtGlobal] +doc = "See also [Global](https://docs.python.org/3/library/ast.html#ast.Global)" +fields = [{ name = "names", type = "Identifier*" }] + +[Stmt.nodes.StmtNonlocal] +doc = "See also [Nonlocal](https://docs.python.org/3/library/ast.html#ast.Nonlocal)" +fields = [{ name = "names", type = "Identifier*" }] + +[Stmt.nodes.StmtExpr] +doc = "See also [Expr](https://docs.python.org/3/library/ast.html#ast.Expr)" +fields = [{ name = "value", type = "Expr" }] + +[Stmt.nodes.StmtPass] +doc = "See also [Pass](https://docs.python.org/3/library/ast.html#ast.Pass)" +fields = [] + +[Stmt.nodes.StmtBreak] +doc = "See also [Break](https://docs.python.org/3/library/ast.html#ast.Break)" +fields = [] + +[Stmt.nodes.StmtContinue] +doc = "See also [Continue](https://docs.python.org/3/library/ast.html#ast.Continue)" +fields = [] + +[Stmt.nodes.StmtIpyEscapeCommand] +# TODO: remove crate:: prefix from IpyEscapeKind after it's auto generated +doc = """An AST node used to represent a IPython escape command at the statement level. + +For example, +```python +%matplotlib inline +``` + +## Terminology + +Escape commands are special IPython syntax which starts with a token to identify +the escape kind followed by the command value itself. [Escape kind] are the kind +of escape commands that are recognized by the token: `%`, `%%`, `!`, `!!`, +`?`, `??`, `/`, `;`, and `,`. + +Help command (or Dynamic Object Introspection as it's called) are the escape commands +of the kind `?` and `??`. For example, `?str.replace`. Help end command are a subset +of Help command where the token can be at the end of the line i.e., after the value. +For example, `str.replace?`. + +Here's where things get tricky. I'll divide the help end command into two types for +better understanding: +1. Strict version: The token is _only_ at the end of the line. For example, + `str.replace?` or `str.replace??`. +2. Combined version: Along with the `?` or `??` token, which are at the end of the + line, there are other escape kind tokens that are present at the start as well. + For example, `%matplotlib?` or `%%timeit?`. + +Priority comes into picture for the "Combined version" mentioned above. How do +we determine the escape kind if there are tokens on both side of the value, i.e., which +token to choose? The Help end command always takes priority over any other token which +means that if there is `?`/`??` at the end then that is used to determine the kind. +For example, in `%matplotlib?` the escape kind is determined using the `?` token +instead of `%` token. + +## Syntax + +`<IpyEscapeKind><Command value>` + +The simplest form is an escape kind token followed by the command value. For example, +`%matplotlib inline`, `/foo`, `!pwd`, etc. + +`<Command value><IpyEscapeKind ("?" or "??")>` + +The help end escape command would be the reverse of the above syntax. Here, the +escape kind token can only be either `?` or `??` and it is at the end of the line. +For example, `str.replace?`, `math.pi??`, etc. + +`<IpyEscapeKind><Command value><EscapeKind ("?" or "??")>` + +The final syntax is the combined version of the above two. For example, `%matplotlib?`, +`%%timeit??`, etc. + +[Escape kind]: crate::IpyEscapeKind +""" +fields = [ + { name = "kind", type = "IpyEscapeKind" }, + { name = "value", type = "Box<str>" }, +] + +[Expr] +add_suffix_to_is_methods = true +anynode_is_label = "expression" +doc = "See also [expr](https://docs.python.org/3/library/ast.html#ast.expr)" + +[Expr.nodes.ExprBoolOp] +doc = "See also [BoolOp](https://docs.python.org/3/library/ast.html#ast.BoolOp)" +fields = [{ name = "op", type = "BoolOp" }, { name = "values", type = "Expr*" }] +custom_source_order = true + +[Expr.nodes.ExprNamed] +doc = "See also [NamedExpr](https://docs.python.org/3/library/ast.html#ast.NamedExpr)" +fields = [{ name = "target", type = "Expr" }, { name = "value", type = "Expr" }] + +[Expr.nodes.ExprBinOp] +doc = "See also [BinOp](https://docs.python.org/3/library/ast.html#ast.BinOp)" +fields = [ + { name = "left", type = "Expr" }, + { name = "op", type = "Operator" }, + { name = "right", type = "Expr" }, +] + +[Expr.nodes.ExprUnaryOp] +doc = "See also [UnaryOp](https://docs.python.org/3/library/ast.html#ast.UnaryOp)" +fields = [ + { name = "op", type = "UnaryOp" }, + { name = "operand", type = "Expr" }, +] + +[Expr.nodes.ExprLambda] +doc = "See also [Lambda](https://docs.python.org/3/library/ast.html#ast.Lambda)" +fields = [ + { name = "parameters", type = "Box<crate::Parameters>?" }, + { name = "body", type = "Expr" }, +] + +[Expr.nodes.ExprIf] +doc = "See also [IfExp](https://docs.python.org/3/library/ast.html#ast.IfExp)" +fields = [ + { name = "test", type = "Expr" }, + { name = "body", type = "Expr" }, + { name = "orelse", type = "Expr" }, +] +source_order = ["body", "test", "orelse"] + +[Expr.nodes.ExprDict] +doc = "See also [Dict](https://docs.python.org/3/library/ast.html#ast.Dict)" +fields = [{ name = "items", type = "DictItem*" }] +custom_source_order = true + +[Expr.nodes.ExprSet] +doc = "See also [Set](https://docs.python.org/3/library/ast.html#ast.Set)" +fields = [{ name = "elts", type = "Expr*" }] + +[Expr.nodes.ExprListComp] +doc = "See also [ListComp](https://docs.python.org/3/library/ast.html#ast.ListComp)" +fields = [ + { name = "elt", type = "Expr" }, + { name = "generators", type = "Comprehension*" }, +] + +[Expr.nodes.ExprSetComp] +doc = "See also [SetComp](https://docs.python.org/3/library/ast.html#ast.SetComp)" +fields = [ + { name = "elt", type = "Expr" }, + { name = "generators", type = "Comprehension*" }, +] + +[Expr.nodes.ExprDictComp] +doc = "See also [DictComp](https://docs.python.org/3/library/ast.html#ast.DictComp)" +fields = [ + { name = "key", type = "Expr" }, + { name = "value", type = "Expr" }, + { name = "generators", type = "Comprehension*" }, +] + +[Expr.nodes.ExprGenerator] +doc = "See also [GeneratorExp](https://docs.python.org/3/library/ast.html#ast.GeneratorExp)" +fields = [ + { name = "elt", type = "Expr" }, + { name = "generators", type = "Comprehension*" }, + { name = "parenthesized", type = "bool" }, +] + +[Expr.nodes.ExprAwait] +doc = "See also [Await](https://docs.python.org/3/library/ast.html#ast.Await)" +fields = [{ name = "value", type = "Expr" }] + +[Expr.nodes.ExprYield] +doc = "See also [Yield](https://docs.python.org/3/library/ast.html#ast.Yield)" +fields = [{ name = "value", type = "Expr?" }] + +[Expr.nodes.ExprYieldFrom] +doc = "See also [YieldFrom](https://docs.python.org/3/library/ast.html#ast.YieldFrom)" +fields = [{ name = "value", type = "Expr" }] + +[Expr.nodes.ExprCompare] +doc = "See also [Compare](https://docs.python.org/3/library/ast.html#ast.Compare)" +fields = [ + { name = "left", type = "Expr" }, + { name = "ops", type = "&CmpOp*" }, + { name = "comparators", type = "&Expr*" }, +] +# The fields must be visited simultaneously +custom_source_order = true + +[Expr.nodes.ExprCall] +doc = "See also [Call](https://docs.python.org/3/library/ast.html#ast.Call)" +fields = [ + { name = "func", type = "Expr" }, + { name = "arguments", type = "Arguments" }, +] + +[Expr.nodes.ExprFString] +doc = """An AST node that represents either a single-part f-string literal +or an implicitly concatenated f-string literal. + +This type differs from the original Python AST `JoinedStr` in that it +doesn't join the implicitly concatenated parts into a single string. Instead, +it keeps them separate and provide various methods to access the parts. + +See also [JoinedStr](https://docs.python.org/3/library/ast.html#ast.JoinedStr)""" +fields = [{ name = "value", type = "FStringValue" }] +custom_source_order = true + +[Expr.nodes.ExprStringLiteral] +doc = """An AST node that represents either a single-part string literal +or an implicitly concatenated string literal.""" +fields = [{ name = "value", type = "StringLiteralValue" }] +# Because StringLiteralValue type is an iterator and it's not clear from the type +custom_source_order = true + +[Expr.nodes.ExprBytesLiteral] +doc = """An AST node that represents either a single-part bytestring literal +or an implicitly concatenated bytestring literal.""" +fields = [{ name = "value", type = "BytesLiteralValue" }] +# Because BytesLiteralValue type is an iterator and it's not clear from the type +custom_source_order = true + +[Expr.nodes.ExprNumberLiteral] +fields = [{ name = "value", type = "Number" }] + +[Expr.nodes.ExprBooleanLiteral] +fields = [{ name = "value", type = "bool" }] +derives = ["Default"] + +[Expr.nodes.ExprNoneLiteral] +fields = [] +derives = ["Default"] + +[Expr.nodes.ExprEllipsisLiteral] +fields = [] +derives = ["Default"] + +[Expr.nodes.ExprAttribute] +doc = "See also [Attribute](https://docs.python.org/3/library/ast.html#ast.Attribute)" +fields = [ + { name = "value", type = "Expr" }, + { name = "attr", type = "Identifier" }, + { name = "ctx", type = "ExprContext" }, +] + +[Expr.nodes.ExprSubscript] +doc = "See also [Subscript](https://docs.python.org/3/library/ast.html#ast.Subscript)" +fields = [ + { name = "value", type = "Expr" }, + { name = "slice", type = "Expr" }, + { name = "ctx", type = "ExprContext" }, +] + +[Expr.nodes.ExprStarred] +doc = "See also [Starred](https://docs.python.org/3/library/ast.html#ast.Starred)" +fields = [ + { name = "value", type = "Expr" }, + { name = "ctx", type = "ExprContext" }, +] + +[Expr.nodes.ExprName] +doc = "See also [Name](https://docs.python.org/3/library/ast.html#ast.Name)" +fields = [ + { name = "id", type = "Name" }, + { name = "ctx", type = "ExprContext" }, +] + +[Expr.nodes.ExprList] +doc = "See also [List](https://docs.python.org/3/library/ast.html#ast.List)" +fields = [ + { name = "elts", type = "Expr*" }, + { name = "ctx", type = "ExprContext" }, +] + +[Expr.nodes.ExprTuple] +doc = "See also [Tuple](https://docs.python.org/3/library/ast.html#ast.Tuple)" +fields = [ + { name = "elts", type = "Expr*" }, + { name = "ctx", type = "ExprContext" }, + { name = "parenthesized", type = "bool" }, +] + +[Expr.nodes.ExprSlice] +doc = "See also [Slice](https://docs.python.org/3/library/ast.html#ast.Slice)" +fields = [ + { name = "lower", type = "Expr?" }, + { name = "upper", type = "Expr?" }, + { name = "step", type = "Expr?" }, +] + +[Expr.nodes.ExprIpyEscapeCommand] +doc = """An AST node used to represent a IPython escape command at the expression level. + +For example, +```python +dir = !pwd +``` + +Here, the escape kind can only be `!` or `%` otherwise it is a syntax error. + +For more information related to terminology and syntax of escape commands, +see [`StmtIpyEscapeCommand`].""" + +fields = [ + { name = "kind", type = "IpyEscapeKind" }, + { name = "value", type = "Box<str>" }, +] + +[ExceptHandler] +doc = "See also [excepthandler](https://docs.python.org/3/library/ast.html#ast.excepthandler)" + +[ExceptHandler.nodes] +ExceptHandlerExceptHandler = {} + +[FStringElement.nodes] +FStringExpressionElement = { variant = "Expression" } +FStringLiteralElement = { variant = "Literal" } + +[Pattern] +doc = "See also [pattern](https://docs.python.org/3/library/ast.html#ast.pattern)" + +[Pattern.nodes] +PatternMatchValue = {} +PatternMatchSingleton = {} +PatternMatchSequence = {} +PatternMatchMapping = {} +PatternMatchClass = {} +PatternMatchStar = {} +PatternMatchAs = {} +PatternMatchOr = {} + +[TypeParam] +doc = "See also [type_param](https://docs.python.org/3/library/ast.html#ast.type_param)" + +[TypeParam.nodes] +TypeParamTypeVar = {} +TypeParamTypeVarTuple = {} +TypeParamParamSpec = {} + +[ungrouped.nodes] +FStringFormatSpec = {} +PatternArguments = {} +PatternKeyword = {} +Comprehension = {} +Arguments = {} +Parameters = {} +Parameter = {} +ParameterWithDefault = {} +Keyword = {} +Alias = {} +WithItem = {} +MatchCase = {} +Decorator = {} +ElifElseClause = {} +TypeParams = {} +FString = {} +StringLiteral = {} +BytesLiteral = {} +Identifier = {} diff --git a/crates/ruff_python_ast/generate.py b/crates/ruff_python_ast/generate.py new file mode 100644 index 0000000000000..f6afab68cc174 --- /dev/null +++ b/crates/ruff_python_ast/generate.py @@ -0,0 +1,886 @@ +#!/usr/bin/python +# /// script +# requires-python = ">=3.11" +# dependencies = [] +# /// + +from __future__ import annotations + +import re +from dataclasses import dataclass +from pathlib import Path +from subprocess import check_output +from typing import Any + +import tomllib + +# Types that require `crate::`. We can slowly remove these types as we move them to generate scripts. +types_requiring_create_prefix = { + "IpyEscapeKind", + "ExprContext", + "Identifier", + "Number", + "BytesLiteralValue", + "StringLiteralValue", + "FStringValue", + "Arguments", + "CmpOp", + "Comprehension", + "DictItem", + "UnaryOp", + "BoolOp", + "Operator", + "Decorator", + "TypeParams", + "Parameters", + "ElifElseClause", + "WithItem", + "MatchCase", + "Alias", +} + + +@dataclass +class VisitorInfo: + name: str + accepts_sequence: bool = False + + +# Map of AST node types to their corresponding visitor information. +# Only visitors that are different from the default `visit_*` method are included. +# These visitors either have a different name or accept a sequence of items. +type_to_visitor_function: dict[str, VisitorInfo] = { + "TypeParams": VisitorInfo("visit_type_params", True), + "Parameters": VisitorInfo("visit_parameters", True), + "Stmt": VisitorInfo("visit_body", True), + "Arguments": VisitorInfo("visit_arguments", True), +} + + +def rustfmt(code: str) -> str: + return check_output(["rustfmt", "--emit=stdout"], input=code, text=True) + + +def to_snake_case(node: str) -> str: + """Converts CamelCase to snake_case""" + return re.sub("([A-Z])", r"_\1", node).lower().lstrip("_") + + +def write_rustdoc(out: list[str], doc: str) -> None: + for line in doc.split("\n"): + out.append(f"/// {line}") + + +# ------------------------------------------------------------------------------ +# Read AST description + + +def load_ast(root: Path) -> Ast: + ast_path = root.joinpath("crates", "ruff_python_ast", "ast.toml") + with ast_path.open("rb") as ast_file: + ast = tomllib.load(ast_file) + return Ast(ast) + + +# ------------------------------------------------------------------------------ +# Preprocess + + +@dataclass +class Ast: + """ + The parsed representation of the `ast.toml` file. Defines all of the Python + AST syntax nodes, and which groups (`Stmt`, `Expr`, etc.) they belong to. + """ + + groups: list[Group] + ungrouped_nodes: list[Node] + all_nodes: list[Node] + + def __init__(self, ast: dict[str, Any]) -> None: + self.groups = [] + self.ungrouped_nodes = [] + self.all_nodes = [] + for group_name, group in ast.items(): + group = Group(group_name, group) + self.all_nodes.extend(group.nodes) + if group_name == "ungrouped": + self.ungrouped_nodes = group.nodes + else: + self.groups.append(group) + + +@dataclass +class Group: + name: str + nodes: list[Node] + owned_enum_ty: str + + add_suffix_to_is_methods: bool + anynode_is_label: str + doc: str | None + + def __init__(self, group_name: str, group: dict[str, Any]) -> None: + self.name = group_name + self.owned_enum_ty = group_name + self.ref_enum_ty = group_name + "Ref" + self.add_suffix_to_is_methods = group.get("add_suffix_to_is_methods", False) + self.anynode_is_label = group.get("anynode_is_label", to_snake_case(group_name)) + self.doc = group.get("doc") + self.nodes = [ + Node(self, node_name, node) for node_name, node in group["nodes"].items() + ] + + +@dataclass +class Node: + name: str + variant: str + ty: str + doc: str | None + fields: list[Field] | None + derives: list[str] + custom_source_order: bool + source_order: list[str] | None + + def __init__(self, group: Group, node_name: str, node: dict[str, Any]) -> None: + self.name = node_name + self.variant = node.get("variant", node_name.removeprefix(group.name)) + self.ty = f"crate::{node_name}" + self.fields = None + fields = node.get("fields") + if fields is not None: + self.fields = [Field(f) for f in fields] + self.custom_source_order = node.get("custom_source_order", False) + self.derives = node.get("derives", []) + self.doc = node.get("doc") + self.source_order = node.get("source_order") + + def fields_in_source_order(self) -> list[Field]: + if self.fields is None: + return [] + if self.source_order is None: + return list(filter(lambda x: not x.skip_source_order(), self.fields)) + + fields = [] + for field_name in self.source_order: + field = None + for field in self.fields: + if field.skip_source_order(): + continue + if field.name == field_name: + field = field + break + fields.append(field) + return fields + + +@dataclass +class Field: + name: str + ty: str + _skip_visit: bool + is_annotation: bool + parsed_ty: FieldType + + def __init__(self, field: dict[str, Any]) -> None: + self.name = field["name"] + self.ty = field["type"] + self.parsed_ty = FieldType(self.ty) + self._skip_visit = field.get("skip_visit", False) + self.is_annotation = field.get("is_annotation", False) + + def skip_source_order(self) -> bool: + return self._skip_visit or self.parsed_ty.inner in [ + "str", + "ExprContext", + "Name", + "u32", + "bool", + "Number", + "IpyEscapeKind", + ] + + +# Extracts the type argument from the given rust type with AST field type syntax. +# Box<str> -> str +# Box<Expr?> -> Expr +# If the type does not have a type argument, it will return the string. +# Does not support nested types +def extract_type_argument(rust_type_str: str) -> str: + rust_type_str = rust_type_str.replace("*", "") + rust_type_str = rust_type_str.replace("?", "") + rust_type_str = rust_type_str.replace("&", "") + + open_bracket_index = rust_type_str.find("<") + if open_bracket_index == -1: + return rust_type_str + close_bracket_index = rust_type_str.rfind(">") + if close_bracket_index == -1 or close_bracket_index <= open_bracket_index: + raise ValueError(f"Brackets are not balanced for type {rust_type_str}") + inner_type = rust_type_str[open_bracket_index + 1 : close_bracket_index].strip() + inner_type = inner_type.replace("crate::", "") + return inner_type + + +@dataclass +class FieldType: + rule: str + name: str + inner: str + seq: bool = False + optional: bool = False + slice_: bool = False + + def __init__(self, rule: str) -> None: + self.rule = rule + self.name = "" + self.inner = extract_type_argument(rule) + + # The following cases are the limitations of this parser(and not used in the ast.toml): + # * Rules that involve declaring a sequence with optional items e.g. Vec<Option<...>> + last_pos = len(rule) - 1 + for i, ch in enumerate(rule): + if ch == "?": + if i == last_pos: + self.optional = True + else: + raise ValueError(f"`?` must be at the end: {rule}") + elif ch == "*": + if self.slice_: # The * after & is a slice + continue + if i == last_pos: + self.seq = True + else: + raise ValueError(f"`*` must be at the end: {rule}") + elif ch == "&": + if i == 0 and rule.endswith("*"): + self.slice_ = True + else: + raise ValueError( + f"`&` must be at the start and end with `*`: {rule}" + ) + else: + self.name += ch + + if self.optional and (self.seq or self.slice_): + raise ValueError(f"optional field cannot be sequence or slice: {rule}") + + +# ------------------------------------------------------------------------------ +# Preamble + + +def write_preamble(out: list[str]) -> None: + out.append(""" + // This is a generated file. Don't modify it by hand! + // Run `crates/ruff_python_ast/generate.py` to re-generate the file. + + use crate::name::Name; + use crate::visitor::source_order::SourceOrderVisitor; + """) + + +# ------------------------------------------------------------------------------ +# Owned enum + + +def write_owned_enum(out: list[str], ast: Ast) -> None: + """ + Create an enum for each group that contains an owned copy of a syntax node. + + ```rust + pub enum TypeParam { + TypeVar(TypeParamTypeVar), + TypeVarTuple(TypeParamTypeVarTuple), + ... + } + ``` + + Also creates: + - `impl Ranged for TypeParam` + - `TypeParam::visit_source_order` + - `impl From<TypeParamTypeVar> for TypeParam` + - `impl Ranged for TypeParamTypeVar` + - `fn TypeParam::is_type_var() -> bool` + + If the `add_suffix_to_is_methods` group option is true, then the + `is_type_var` method will be named `is_type_var_type_param`. + """ + + for group in ast.groups: + out.append("") + if group.doc is not None: + write_rustdoc(out, group.doc) + out.append("#[derive(Clone, Debug, PartialEq)]") + out.append(f"pub enum {group.owned_enum_ty} {{") + for node in group.nodes: + out.append(f"{node.variant}({node.ty}),") + out.append("}") + + for node in group.nodes: + out.append(f""" + impl From<{node.ty}> for {group.owned_enum_ty} {{ + fn from(node: {node.ty}) -> Self {{ + Self::{node.variant}(node) + }} + }} + """) + + out.append(f""" + impl ruff_text_size::Ranged for {group.owned_enum_ty} {{ + fn range(&self) -> ruff_text_size::TextRange {{ + match self {{ + """) + for node in group.nodes: + out.append(f"Self::{node.variant}(node) => node.range(),") + out.append(""" + } + } + } + """) + + out.append( + "#[allow(dead_code, clippy::match_wildcard_for_single_variants)]" + ) # Not all is_methods are used + out.append(f"impl {group.name} {{") + for node in group.nodes: + is_name = to_snake_case(node.variant) + variant_name = node.variant + match_arm = f"Self::{variant_name}" + if group.add_suffix_to_is_methods: + is_name = to_snake_case(node.variant + group.name) + if len(group.nodes) > 1: + out.append(f""" + #[inline] + pub const fn is_{is_name}(&self) -> bool {{ + matches!(self, {match_arm}(_)) + }} + + #[inline] + pub fn {is_name}(self) -> Option<{node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + _ => None, + }} + }} + + #[inline] + pub fn expect_{is_name}(self) -> {node.ty} {{ + match self {{ + {match_arm}(val) => val, + _ => panic!("called expect on {{self:?}}"), + }} + }} + + #[inline] + pub fn as_{is_name}_mut(&mut self) -> Option<&mut {node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + _ => None, + }} + }} + + #[inline] + pub fn as_{is_name}(&self) -> Option<&{node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + _ => None, + }} + }} + """) + elif len(group.nodes) == 1: + out.append(f""" + #[inline] + pub const fn is_{is_name}(&self) -> bool {{ + matches!(self, {match_arm}(_)) + }} + + #[inline] + pub fn {is_name}(self) -> Option<{node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + }} + }} + + #[inline] + pub fn expect_{is_name}(self) -> {node.ty} {{ + match self {{ + {match_arm}(val) => val, + }} + }} + + #[inline] + pub fn as_{is_name}_mut(&mut self) -> Option<&mut {node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + }} + }} + + #[inline] + pub fn as_{is_name}(&self) -> Option<&{node.ty}> {{ + match self {{ + {match_arm}(val) => Some(val), + }} + }} + """) + + out.append("}") + + for node in ast.all_nodes: + out.append(f""" + impl ruff_text_size::Ranged for {node.ty} {{ + fn range(&self) -> ruff_text_size::TextRange {{ + self.range + }} + }} + """) + + for group in ast.groups: + out.append(f""" + impl {group.owned_enum_ty} {{ + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + {{ + match self {{ + """) + for node in group.nodes: + out.append( + f"{group.owned_enum_ty}::{node.variant}(node) => node.visit_source_order(visitor)," + ) + out.append(""" + } + } + } + """) + + +# ------------------------------------------------------------------------------ +# Ref enum + + +def write_ref_enum(out: list[str], ast: Ast) -> None: + """ + Create an enum for each group that contains a reference to a syntax node. + + ```rust + pub enum TypeParamRef<'a> { + TypeVar(&'a TypeParamTypeVar), + TypeVarTuple(&'a TypeParamTypeVarTuple), + ... + } + ``` + + Also creates: + - `impl<'a> From<&'a TypeParam> for TypeParamRef<'a>` + - `impl<'a> From<&'a TypeParamTypeVar> for TypeParamRef<'a>` + - `impl Ranged for TypeParamRef<'_>` + - `fn TypeParamRef::is_type_var() -> bool` + + The name of each variant can be customized via the `variant` node option. If + the `add_suffix_to_is_methods` group option is true, then the `is_type_var` + method will be named `is_type_var_type_param`. + """ + + for group in ast.groups: + out.append("") + if group.doc is not None: + write_rustdoc(out, group.doc) + out.append("""#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)]""") + out.append(f"""pub enum {group.ref_enum_ty}<'a> {{""") + for node in group.nodes: + if group.add_suffix_to_is_methods: + is_name = to_snake_case(node.variant + group.name) + out.append(f'#[is(name = "{is_name}")]') + out.append(f"""{node.variant}(&'a {node.ty}),""") + out.append("}") + + out.append(f""" + impl<'a> From<&'a {group.owned_enum_ty}> for {group.ref_enum_ty}<'a> {{ + fn from(node: &'a {group.owned_enum_ty}) -> Self {{ + match node {{ + """) + for node in group.nodes: + out.append( + f"{group.owned_enum_ty}::{node.variant}(node) => {group.ref_enum_ty}::{node.variant}(node)," + ) + out.append(""" + } + } + } + """) + + for node in group.nodes: + out.append(f""" + impl<'a> From<&'a {node.ty}> for {group.ref_enum_ty}<'a> {{ + fn from(node: &'a {node.ty}) -> Self {{ + Self::{node.variant}(node) + }} + }} + """) + + out.append(f""" + impl ruff_text_size::Ranged for {group.ref_enum_ty}<'_> {{ + fn range(&self) -> ruff_text_size::TextRange {{ + match self {{ + """) + for node in group.nodes: + out.append(f"Self::{node.variant}(node) => node.range(),") + out.append(""" + } + } + } + """) + + +# ------------------------------------------------------------------------------ +# AnyNodeRef + + +def write_anynoderef(out: list[str], ast: Ast) -> None: + """ + Create the AnyNodeRef type. + + ```rust + pub enum AnyNodeRef<'a> { + ... + TypeParamTypeVar(&'a TypeParamTypeVar), + TypeParamTypeVarTuple(&'a TypeParamTypeVarTuple), + ... + } + ``` + + Also creates: + - `impl<'a> From<&'a TypeParam> for AnyNodeRef<'a>` + - `impl<'a> From<TypeParamRef<'a>> for AnyNodeRef<'a>` + - `impl<'a> From<&'a TypeParamTypeVarTuple> for AnyNodeRef<'a>` + - `impl Ranged for AnyNodeRef<'_>` + - `fn AnyNodeRef::as_ptr(&self) -> std::ptr::NonNull<()>` + - `fn AnyNodeRef::visit_source_order(self, visitor &mut impl SourceOrderVisitor)` + """ + + out.append(""" + #[derive(Copy, Clone, Debug, is_macro::Is, PartialEq)] + pub enum AnyNodeRef<'a> { + """) + for node in ast.all_nodes: + out.append(f"""{node.name}(&'a {node.ty}),""") + out.append(""" + } + """) + + for group in ast.groups: + out.append(f""" + impl<'a> From<&'a {group.owned_enum_ty}> for AnyNodeRef<'a> {{ + fn from(node: &'a {group.owned_enum_ty}) -> AnyNodeRef<'a> {{ + match node {{ + """) + for node in group.nodes: + out.append( + f"{group.owned_enum_ty}::{node.variant}(node) => AnyNodeRef::{node.name}(node)," + ) + out.append(""" + } + } + } + """) + + out.append(f""" + impl<'a> From<{group.ref_enum_ty}<'a>> for AnyNodeRef<'a> {{ + fn from(node: {group.ref_enum_ty}<'a>) -> AnyNodeRef<'a> {{ + match node {{ + """) + for node in group.nodes: + out.append( + f"{group.ref_enum_ty}::{node.variant}(node) => AnyNodeRef::{node.name}(node)," + ) + out.append(""" + } + } + } + """) + + # `as_*` methods to convert from `AnyNodeRef` to e.g. `ExprRef` + out.append(f""" + impl<'a> AnyNodeRef<'a> {{ + pub fn as_{to_snake_case(group.ref_enum_ty)}(self) -> Option<{group.ref_enum_ty}<'a>> {{ + match self {{ + """) + for node in group.nodes: + out.append( + f"Self::{node.name}(node) => Some({group.ref_enum_ty}::{node.variant}(node))," + ) + out.append(""" + _ => None, + } + } + } + """) + + for node in ast.all_nodes: + out.append(f""" + impl<'a> From<&'a {node.ty}> for AnyNodeRef<'a> {{ + fn from(node: &'a {node.ty}) -> AnyNodeRef<'a> {{ + AnyNodeRef::{node.name}(node) + }} + }} + """) + + out.append(""" + impl ruff_text_size::Ranged for AnyNodeRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + """) + for node in ast.all_nodes: + out.append(f"""AnyNodeRef::{node.name}(node) => node.range(),""") + out.append(""" + } + } + } + """) + + out.append(""" + impl AnyNodeRef<'_> { + pub fn as_ptr(&self) -> std::ptr::NonNull<()> { + match self { + """) + for node in ast.all_nodes: + out.append( + f"AnyNodeRef::{node.name}(node) => std::ptr::NonNull::from(*node).cast()," + ) + out.append(""" + } + } + } + """) + + out.append(""" + impl<'a> AnyNodeRef<'a> { + pub fn visit_source_order<'b, V>(self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'b> + ?Sized, + 'a: 'b, + { + match self { + """) + for node in ast.all_nodes: + out.append( + f"AnyNodeRef::{node.name}(node) => node.visit_source_order(visitor)," + ) + out.append(""" + } + } + } + """) + + for group in ast.groups: + out.append(f""" + impl AnyNodeRef<'_> {{ + pub const fn is_{group.anynode_is_label}(self) -> bool {{ + matches!(self, + """) + for i, node in enumerate(group.nodes): + if i > 0: + out.append("|") + out.append(f"""AnyNodeRef::{node.name}(_)""") + out.append(""" + ) + } + } + """) + + +# ------------------------------------------------------------------------------ +# NodeKind + + +def write_nodekind(out: list[str], ast: Ast) -> None: + """ + Create the NodeKind type. + + ```rust + pub enum NodeKind { + ... + TypeParamTypeVar, + TypeParamTypeVarTuple, + ... + } + + Also creates: + - `fn AnyNodeRef::kind(self) -> NodeKind` + ``` + """ + + out.append(""" + #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] + pub enum NodeKind { + """) + for node in ast.all_nodes: + out.append(f"""{node.name},""") + out.append(""" + } + """) + + out.append(""" + impl AnyNodeRef<'_> { + pub const fn kind(self) -> NodeKind { + match self { + """) + for node in ast.all_nodes: + out.append(f"""AnyNodeRef::{node.name}(_) => NodeKind::{node.name},""") + out.append(""" + } + } + } + """) + + +# ------------------------------------------------------------------------------ +# Node structs + + +def write_node(out: list[str], ast: Ast) -> None: + group_names = [group.name for group in ast.groups] + for group in ast.groups: + for node in group.nodes: + if node.fields is None: + continue + if node.doc is not None: + write_rustdoc(out, node.doc) + out.append( + "#[derive(Clone, Debug, PartialEq" + + "".join(f", {derive}" for derive in node.derives) + + ")]" + ) + name = node.name + out.append(f"pub struct {name} {{") + out.append("pub range: ruff_text_size::TextRange,") + for field in node.fields: + field_str = f"pub {field.name}: " + ty = field.parsed_ty + + rust_ty = f"{field.parsed_ty.name}" + if ty.name in types_requiring_create_prefix: + rust_ty = f"crate::{rust_ty}" + if ty.slice_: + rust_ty = f"[{rust_ty}]" + if (ty.name in group_names or ty.slice_) and ty.seq is False: + rust_ty = f"Box<{rust_ty}>" + + if ty.seq: + rust_ty = f"Vec<{rust_ty}>" + elif ty.optional: + rust_ty = f"Option<{rust_ty}>" + + field_str += rust_ty + "," + out.append(field_str) + out.append("}") + out.append("") + + +# ------------------------------------------------------------------------------ +# Source order visitor + + +def write_source_order(out: list[str], ast: Ast) -> None: + for group in ast.groups: + for node in group.nodes: + if node.fields is None or node.custom_source_order: + continue + name = node.name + fields_list = "" + body = "" + + for field in node.fields: + if field.skip_source_order(): + fields_list += f"{field.name}: _,\n" + else: + fields_list += f"{field.name},\n" + fields_list += "range: _,\n" + + for field in node.fields_in_source_order(): + visitor_name = ( + type_to_visitor_function.get( + field.parsed_ty.inner, VisitorInfo("") + ).name + or f"visit_{to_snake_case(field.parsed_ty.inner)}" + ) + visits_sequence = type_to_visitor_function.get( + field.parsed_ty.inner, VisitorInfo("") + ).accepts_sequence + + if field.is_annotation: + visitor_name = "visit_annotation" + + if field.parsed_ty.optional: + body += f""" + if let Some({field.name}) = {field.name} {{ + visitor.{visitor_name}({field.name}); + }}\n + """ + elif not visits_sequence and field.parsed_ty.seq: + body += f""" + for elm in {field.name} {{ + visitor.{visitor_name}(elm); + }} + """ + else: + body += f"visitor.{visitor_name}({field.name});\n" + + visitor_arg_name = "visitor" + if len(node.fields_in_source_order()) == 0: + visitor_arg_name = "_" + + out.append(f""" +impl {name} {{ + pub(crate) fn visit_source_order<'a, V>(&'a self, {visitor_arg_name}: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + {{ + let {name} {{ + {fields_list} + }} = self; + {body} + }} +}} + """) + + +# ------------------------------------------------------------------------------ +# Format and write output + + +def generate(ast: Ast) -> list[str]: + out = [] + write_preamble(out) + write_owned_enum(out, ast) + write_ref_enum(out, ast) + write_anynoderef(out, ast) + write_nodekind(out, ast) + write_node(out, ast) + write_source_order(out, ast) + return out + + +def write_output(root: Path, out: list[str]) -> None: + out_path = root.joinpath("crates", "ruff_python_ast", "src", "generated.rs") + out_path.write_text(rustfmt("\n".join(out))) + + +# ------------------------------------------------------------------------------ +# Main + + +def main() -> None: + root = Path( + check_output(["git", "rev-parse", "--show-toplevel"], text=True).strip() + ) + ast = load_ast(root) + out = generate(ast) + write_output(root, out) + + +if __name__ == "__main__": + main() diff --git a/crates/ruff_python_ast/src/comparable.rs b/crates/ruff_python_ast/src/comparable.rs index a6825b6eb2578..5197bfd38ac7b 100644 --- a/crates/ruff_python_ast/src/comparable.rs +++ b/crates/ruff_python_ast/src/comparable.rs @@ -15,9 +15,10 @@ //! an implicit concatenation of string literals, as these expressions are considered to //! have the same shape in that they evaluate to the same value. -use std::borrow::Cow; - use crate as ast; +use crate::{Expr, Number}; +use std::borrow::Cow; +use std::hash::Hash; #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone)] pub enum ComparableBoolOp { @@ -225,7 +226,6 @@ pub struct PatternMatchOr<'a> { patterns: Vec<ComparablePattern<'a>>, } -#[allow(clippy::enum_variant_names)] #[derive(Debug, PartialEq, Eq, Hash)] pub enum ComparablePattern<'a> { MatchValue(PatternMatchValue<'a>), @@ -861,8 +861,8 @@ pub struct ExprNumberLiteral<'a> { } #[derive(Debug, PartialEq, Eq, Hash)] -pub struct ExprBoolLiteral<'a> { - value: &'a bool, +pub struct ExprBoolLiteral { + value: bool, } #[derive(Debug, PartialEq, Eq, Hash)] @@ -934,7 +934,7 @@ pub enum ComparableExpr<'a> { StringLiteral(ExprStringLiteral<'a>), BytesLiteral(ExprBytesLiteral<'a>), NumberLiteral(ExprNumberLiteral<'a>), - BoolLiteral(ExprBoolLiteral<'a>), + BoolLiteral(ExprBoolLiteral), NoneLiteral, EllipsisLiteral, Attribute(ExprAttribute<'a>), @@ -1109,7 +1109,7 @@ impl<'a> From<&'a ast::Expr> for ComparableExpr<'a> { }) } ast::Expr::BooleanLiteral(ast::ExprBooleanLiteral { value, range: _ }) => { - Self::BoolLiteral(ExprBoolLiteral { value }) + Self::BoolLiteral(ExprBoolLiteral { value: *value }) } ast::Expr::NoneLiteral(_) => Self::NoneLiteral, ast::Expr::EllipsisLiteral(_) => Self::EllipsisLiteral, @@ -1675,3 +1675,76 @@ impl<'a> From<&'a ast::ModExpression> for ComparableModExpression<'a> { } } } + +/// Wrapper around [`Expr`] that implements [`Hash`] and [`PartialEq`] according to Python +/// semantics: +/// +/// > Values that compare equal (such as 1, 1.0, and True) can be used interchangeably to index the +/// > same dictionary entry. +/// +/// For example, considers `True`, `1`, and `1.0` to be equal, as they hash to the same value +/// in Python, along with `False`, `0`, and `0.0`. +/// +/// See: <https://docs.python.org/3/library/stdtypes.html#mapping-types-dict> +#[derive(Debug)] +pub struct HashableExpr<'a>(ComparableExpr<'a>); + +impl Hash for HashableExpr<'_> { + fn hash<H: std::hash::Hasher>(&self, state: &mut H) { + self.0.hash(state); + } +} + +impl PartialEq<Self> for HashableExpr<'_> { + fn eq(&self, other: &Self) -> bool { + self.0 == other.0 + } +} + +impl Eq for HashableExpr<'_> {} + +impl<'a> From<&'a Expr> for HashableExpr<'a> { + fn from(expr: &'a Expr) -> Self { + /// Returns a version of the given expression that can be hashed and compared according to + /// Python semantics. + fn as_hashable(expr: &Expr) -> ComparableExpr { + match expr { + Expr::Named(named) => ComparableExpr::NamedExpr(ExprNamed { + target: Box::new(ComparableExpr::from(&named.target)), + value: Box::new(as_hashable(&named.value)), + }), + Expr::NumberLiteral(number) => as_bool(number) + .map(|value| ComparableExpr::BoolLiteral(ExprBoolLiteral { value })) + .unwrap_or_else(|| ComparableExpr::from(expr)), + Expr::Tuple(tuple) => ComparableExpr::Tuple(ExprTuple { + elts: tuple.iter().map(as_hashable).collect(), + }), + _ => ComparableExpr::from(expr), + } + } + + /// Returns the `bool` value of the given expression, if it has an equivalent hash to + /// `True` or `False`. + fn as_bool(number: &crate::ExprNumberLiteral) -> Option<bool> { + match &number.value { + Number::Int(int) => match int.as_u8() { + Some(0) => Some(false), + Some(1) => Some(true), + _ => None, + }, + Number::Float(float) => match float { + 0.0 => Some(false), + 1.0 => Some(true), + _ => None, + }, + Number::Complex { real, imag } => match (real, imag) { + (0.0, 0.0) => Some(false), + (1.0, 0.0) => Some(true), + _ => None, + }, + } + } + + Self(as_hashable(expr)) + } +} diff --git a/crates/ruff_python_ast/src/expression.rs b/crates/ruff_python_ast/src/expression.rs index 469f12b003af4..48a0342971e5b 100644 --- a/crates/ruff_python_ast/src/expression.rs +++ b/crates/ruff_python_ast/src/expression.rs @@ -3,332 +3,13 @@ use std::iter::FusedIterator; use ruff_text_size::{Ranged, TextRange}; use crate::{ - self as ast, AnyNodeRef, AnyStringFlags, Expr, ExprBytesLiteral, ExprFString, + self as ast, AnyNodeRef, AnyStringFlags, Expr, ExprBytesLiteral, ExprFString, ExprRef, ExprStringLiteral, StringFlags, }; -/// Unowned pendant to [`ast::Expr`] that stores a reference instead of a owned value. -#[derive(Copy, Clone, Debug, PartialEq)] -pub enum ExpressionRef<'a> { - BoolOp(&'a ast::ExprBoolOp), - Named(&'a ast::ExprNamed), - BinOp(&'a ast::ExprBinOp), - UnaryOp(&'a ast::ExprUnaryOp), - Lambda(&'a ast::ExprLambda), - If(&'a ast::ExprIf), - Dict(&'a ast::ExprDict), - Set(&'a ast::ExprSet), - ListComp(&'a ast::ExprListComp), - SetComp(&'a ast::ExprSetComp), - DictComp(&'a ast::ExprDictComp), - Generator(&'a ast::ExprGenerator), - Await(&'a ast::ExprAwait), - Yield(&'a ast::ExprYield), - YieldFrom(&'a ast::ExprYieldFrom), - Compare(&'a ast::ExprCompare), - Call(&'a ast::ExprCall), - FString(&'a ast::ExprFString), - StringLiteral(&'a ast::ExprStringLiteral), - BytesLiteral(&'a ast::ExprBytesLiteral), - NumberLiteral(&'a ast::ExprNumberLiteral), - BooleanLiteral(&'a ast::ExprBooleanLiteral), - NoneLiteral(&'a ast::ExprNoneLiteral), - EllipsisLiteral(&'a ast::ExprEllipsisLiteral), - Attribute(&'a ast::ExprAttribute), - Subscript(&'a ast::ExprSubscript), - Starred(&'a ast::ExprStarred), - Name(&'a ast::ExprName), - List(&'a ast::ExprList), - Tuple(&'a ast::ExprTuple), - Slice(&'a ast::ExprSlice), - IpyEscapeCommand(&'a ast::ExprIpyEscapeCommand), -} - -impl<'a> From<&'a Box<Expr>> for ExpressionRef<'a> { +impl<'a> From<&'a Box<Expr>> for ExprRef<'a> { fn from(value: &'a Box<Expr>) -> Self { - ExpressionRef::from(value.as_ref()) - } -} - -impl<'a> From<&'a Expr> for ExpressionRef<'a> { - fn from(value: &'a Expr) -> Self { - match value { - Expr::BoolOp(value) => ExpressionRef::BoolOp(value), - Expr::Named(value) => ExpressionRef::Named(value), - Expr::BinOp(value) => ExpressionRef::BinOp(value), - Expr::UnaryOp(value) => ExpressionRef::UnaryOp(value), - Expr::Lambda(value) => ExpressionRef::Lambda(value), - Expr::If(value) => ExpressionRef::If(value), - Expr::Dict(value) => ExpressionRef::Dict(value), - Expr::Set(value) => ExpressionRef::Set(value), - Expr::ListComp(value) => ExpressionRef::ListComp(value), - Expr::SetComp(value) => ExpressionRef::SetComp(value), - Expr::DictComp(value) => ExpressionRef::DictComp(value), - Expr::Generator(value) => ExpressionRef::Generator(value), - Expr::Await(value) => ExpressionRef::Await(value), - Expr::Yield(value) => ExpressionRef::Yield(value), - Expr::YieldFrom(value) => ExpressionRef::YieldFrom(value), - Expr::Compare(value) => ExpressionRef::Compare(value), - Expr::Call(value) => ExpressionRef::Call(value), - Expr::FString(value) => ExpressionRef::FString(value), - Expr::StringLiteral(value) => ExpressionRef::StringLiteral(value), - Expr::BytesLiteral(value) => ExpressionRef::BytesLiteral(value), - Expr::NumberLiteral(value) => ExpressionRef::NumberLiteral(value), - Expr::BooleanLiteral(value) => ExpressionRef::BooleanLiteral(value), - Expr::NoneLiteral(value) => ExpressionRef::NoneLiteral(value), - Expr::EllipsisLiteral(value) => ExpressionRef::EllipsisLiteral(value), - Expr::Attribute(value) => ExpressionRef::Attribute(value), - Expr::Subscript(value) => ExpressionRef::Subscript(value), - Expr::Starred(value) => ExpressionRef::Starred(value), - Expr::Name(value) => ExpressionRef::Name(value), - Expr::List(value) => ExpressionRef::List(value), - Expr::Tuple(value) => ExpressionRef::Tuple(value), - Expr::Slice(value) => ExpressionRef::Slice(value), - Expr::IpyEscapeCommand(value) => ExpressionRef::IpyEscapeCommand(value), - } - } -} - -impl<'a> From<&'a ast::ExprBoolOp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprBoolOp) -> Self { - Self::BoolOp(value) - } -} -impl<'a> From<&'a ast::ExprNamed> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprNamed) -> Self { - Self::Named(value) - } -} -impl<'a> From<&'a ast::ExprBinOp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprBinOp) -> Self { - Self::BinOp(value) - } -} -impl<'a> From<&'a ast::ExprUnaryOp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprUnaryOp) -> Self { - Self::UnaryOp(value) - } -} -impl<'a> From<&'a ast::ExprLambda> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprLambda) -> Self { - Self::Lambda(value) - } -} -impl<'a> From<&'a ast::ExprIf> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprIf) -> Self { - Self::If(value) - } -} -impl<'a> From<&'a ast::ExprDict> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprDict) -> Self { - Self::Dict(value) - } -} -impl<'a> From<&'a ast::ExprSet> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprSet) -> Self { - Self::Set(value) - } -} -impl<'a> From<&'a ast::ExprListComp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprListComp) -> Self { - Self::ListComp(value) - } -} -impl<'a> From<&'a ast::ExprSetComp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprSetComp) -> Self { - Self::SetComp(value) - } -} -impl<'a> From<&'a ast::ExprDictComp> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprDictComp) -> Self { - Self::DictComp(value) - } -} -impl<'a> From<&'a ast::ExprGenerator> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprGenerator) -> Self { - Self::Generator(value) - } -} -impl<'a> From<&'a ast::ExprAwait> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprAwait) -> Self { - Self::Await(value) - } -} -impl<'a> From<&'a ast::ExprYield> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprYield) -> Self { - Self::Yield(value) - } -} -impl<'a> From<&'a ast::ExprYieldFrom> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprYieldFrom) -> Self { - Self::YieldFrom(value) - } -} -impl<'a> From<&'a ast::ExprCompare> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprCompare) -> Self { - Self::Compare(value) - } -} -impl<'a> From<&'a ast::ExprCall> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprCall) -> Self { - Self::Call(value) - } -} -impl<'a> From<&'a ast::ExprFString> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprFString) -> Self { - Self::FString(value) - } -} -impl<'a> From<&'a ast::ExprStringLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprStringLiteral) -> Self { - Self::StringLiteral(value) - } -} -impl<'a> From<&'a ast::ExprBytesLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprBytesLiteral) -> Self { - Self::BytesLiteral(value) - } -} -impl<'a> From<&'a ast::ExprNumberLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprNumberLiteral) -> Self { - Self::NumberLiteral(value) - } -} -impl<'a> From<&'a ast::ExprBooleanLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprBooleanLiteral) -> Self { - Self::BooleanLiteral(value) - } -} -impl<'a> From<&'a ast::ExprNoneLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprNoneLiteral) -> Self { - Self::NoneLiteral(value) - } -} -impl<'a> From<&'a ast::ExprEllipsisLiteral> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprEllipsisLiteral) -> Self { - Self::EllipsisLiteral(value) - } -} -impl<'a> From<&'a ast::ExprAttribute> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprAttribute) -> Self { - Self::Attribute(value) - } -} -impl<'a> From<&'a ast::ExprSubscript> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprSubscript) -> Self { - Self::Subscript(value) - } -} -impl<'a> From<&'a ast::ExprStarred> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprStarred) -> Self { - Self::Starred(value) - } -} -impl<'a> From<&'a ast::ExprName> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprName) -> Self { - Self::Name(value) - } -} -impl<'a> From<&'a ast::ExprList> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprList) -> Self { - Self::List(value) - } -} -impl<'a> From<&'a ast::ExprTuple> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprTuple) -> Self { - Self::Tuple(value) - } -} -impl<'a> From<&'a ast::ExprSlice> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprSlice) -> Self { - Self::Slice(value) - } -} -impl<'a> From<&'a ast::ExprIpyEscapeCommand> for ExpressionRef<'a> { - fn from(value: &'a ast::ExprIpyEscapeCommand) -> Self { - Self::IpyEscapeCommand(value) - } -} - -impl<'a> From<ExpressionRef<'a>> for AnyNodeRef<'a> { - fn from(value: ExpressionRef<'a>) -> Self { - match value { - ExpressionRef::BoolOp(expression) => AnyNodeRef::ExprBoolOp(expression), - ExpressionRef::Named(expression) => AnyNodeRef::ExprNamed(expression), - ExpressionRef::BinOp(expression) => AnyNodeRef::ExprBinOp(expression), - ExpressionRef::UnaryOp(expression) => AnyNodeRef::ExprUnaryOp(expression), - ExpressionRef::Lambda(expression) => AnyNodeRef::ExprLambda(expression), - ExpressionRef::If(expression) => AnyNodeRef::ExprIf(expression), - ExpressionRef::Dict(expression) => AnyNodeRef::ExprDict(expression), - ExpressionRef::Set(expression) => AnyNodeRef::ExprSet(expression), - ExpressionRef::ListComp(expression) => AnyNodeRef::ExprListComp(expression), - ExpressionRef::SetComp(expression) => AnyNodeRef::ExprSetComp(expression), - ExpressionRef::DictComp(expression) => AnyNodeRef::ExprDictComp(expression), - ExpressionRef::Generator(expression) => AnyNodeRef::ExprGenerator(expression), - ExpressionRef::Await(expression) => AnyNodeRef::ExprAwait(expression), - ExpressionRef::Yield(expression) => AnyNodeRef::ExprYield(expression), - ExpressionRef::YieldFrom(expression) => AnyNodeRef::ExprYieldFrom(expression), - ExpressionRef::Compare(expression) => AnyNodeRef::ExprCompare(expression), - ExpressionRef::Call(expression) => AnyNodeRef::ExprCall(expression), - ExpressionRef::FString(expression) => AnyNodeRef::ExprFString(expression), - ExpressionRef::StringLiteral(expression) => AnyNodeRef::ExprStringLiteral(expression), - ExpressionRef::BytesLiteral(expression) => AnyNodeRef::ExprBytesLiteral(expression), - ExpressionRef::NumberLiteral(expression) => AnyNodeRef::ExprNumberLiteral(expression), - ExpressionRef::BooleanLiteral(expression) => AnyNodeRef::ExprBooleanLiteral(expression), - ExpressionRef::NoneLiteral(expression) => AnyNodeRef::ExprNoneLiteral(expression), - ExpressionRef::EllipsisLiteral(expression) => { - AnyNodeRef::ExprEllipsisLiteral(expression) - } - ExpressionRef::Attribute(expression) => AnyNodeRef::ExprAttribute(expression), - ExpressionRef::Subscript(expression) => AnyNodeRef::ExprSubscript(expression), - ExpressionRef::Starred(expression) => AnyNodeRef::ExprStarred(expression), - ExpressionRef::Name(expression) => AnyNodeRef::ExprName(expression), - ExpressionRef::List(expression) => AnyNodeRef::ExprList(expression), - ExpressionRef::Tuple(expression) => AnyNodeRef::ExprTuple(expression), - ExpressionRef::Slice(expression) => AnyNodeRef::ExprSlice(expression), - ExpressionRef::IpyEscapeCommand(expression) => { - AnyNodeRef::ExprIpyEscapeCommand(expression) - } - } - } -} - -impl Ranged for ExpressionRef<'_> { - fn range(&self) -> TextRange { - match self { - ExpressionRef::BoolOp(expression) => expression.range(), - ExpressionRef::Named(expression) => expression.range(), - ExpressionRef::BinOp(expression) => expression.range(), - ExpressionRef::UnaryOp(expression) => expression.range(), - ExpressionRef::Lambda(expression) => expression.range(), - ExpressionRef::If(expression) => expression.range(), - ExpressionRef::Dict(expression) => expression.range(), - ExpressionRef::Set(expression) => expression.range(), - ExpressionRef::ListComp(expression) => expression.range(), - ExpressionRef::SetComp(expression) => expression.range(), - ExpressionRef::DictComp(expression) => expression.range(), - ExpressionRef::Generator(expression) => expression.range(), - ExpressionRef::Await(expression) => expression.range(), - ExpressionRef::Yield(expression) => expression.range(), - ExpressionRef::YieldFrom(expression) => expression.range(), - ExpressionRef::Compare(expression) => expression.range(), - ExpressionRef::Call(expression) => expression.range(), - ExpressionRef::FString(expression) => expression.range(), - ExpressionRef::StringLiteral(expression) => expression.range(), - ExpressionRef::BytesLiteral(expression) => expression.range(), - ExpressionRef::NumberLiteral(expression) => expression.range(), - ExpressionRef::BooleanLiteral(expression) => expression.range(), - ExpressionRef::NoneLiteral(expression) => expression.range(), - ExpressionRef::EllipsisLiteral(expression) => expression.range(), - ExpressionRef::Attribute(expression) => expression.range(), - ExpressionRef::Subscript(expression) => expression.range(), - ExpressionRef::Starred(expression) => expression.range(), - ExpressionRef::Name(expression) => expression.range(), - ExpressionRef::List(expression) => expression.range(), - ExpressionRef::Tuple(expression) => expression.range(), - ExpressionRef::Slice(expression) => expression.range(), - ExpressionRef::IpyEscapeCommand(expression) => expression.range(), - } + ExprRef::from(value.as_ref()) } } @@ -413,7 +94,7 @@ impl<'a> StringLike<'a> { } /// Returns an iterator over the [`StringLikePart`] contained in this string-like expression. - pub fn parts(&self) -> StringLikePartIter<'_> { + pub fn parts(&self) -> StringLikePartIter<'a> { match self { StringLike::String(expr) => StringLikePartIter::String(expr.value.iter()), StringLike::Bytes(expr) => StringLikePartIter::Bytes(expr.value.iter()), @@ -429,6 +110,14 @@ impl<'a> StringLike<'a> { Self::FString(ExprFString { value, .. }) => value.is_implicit_concatenated(), } } + + pub const fn as_expression_ref(self) -> ExprRef<'a> { + match self { + StringLike::String(expr) => ExprRef::StringLiteral(expr), + StringLike::Bytes(expr) => ExprRef::BytesLiteral(expr), + StringLike::FString(expr) => ExprRef::FString(expr), + } + } } impl<'a> From<&'a ast::ExprStringLiteral> for StringLike<'a> { @@ -449,12 +138,12 @@ impl<'a> From<&'a ast::ExprFString> for StringLike<'a> { } } -impl<'a> From<&StringLike<'a>> for ExpressionRef<'a> { +impl<'a> From<&StringLike<'a>> for ExprRef<'a> { fn from(value: &StringLike<'a>) -> Self { match value { - StringLike::String(expr) => ExpressionRef::StringLiteral(expr), - StringLike::Bytes(expr) => ExpressionRef::BytesLiteral(expr), - StringLike::FString(expr) => ExpressionRef::FString(expr), + StringLike::String(expr) => ExprRef::StringLiteral(expr), + StringLike::Bytes(expr) => ExprRef::BytesLiteral(expr), + StringLike::FString(expr) => ExprRef::FString(expr), } } } @@ -488,6 +177,19 @@ impl<'a> TryFrom<&'a Expr> for StringLike<'a> { } } +impl<'a> TryFrom<AnyNodeRef<'a>> for StringLike<'a> { + type Error = (); + + fn try_from(value: AnyNodeRef<'a>) -> Result<Self, Self::Error> { + match value { + AnyNodeRef::ExprStringLiteral(value) => Ok(Self::String(value)), + AnyNodeRef::ExprBytesLiteral(value) => Ok(Self::Bytes(value)), + AnyNodeRef::ExprFString(value) => Ok(Self::FString(value)), + _ => Err(()), + } + } +} + impl Ranged for StringLike<'_> { fn range(&self) -> TextRange { match self { @@ -561,6 +263,12 @@ impl<'a> From<&'a ast::FString> for StringLikePart<'a> { impl<'a> From<&StringLikePart<'a>> for AnyNodeRef<'a> { fn from(value: &StringLikePart<'a>) -> Self { + AnyNodeRef::from(*value) + } +} + +impl<'a> From<StringLikePart<'a>> for AnyNodeRef<'a> { + fn from(value: StringLikePart<'a>) -> Self { match value { StringLikePart::String(part) => AnyNodeRef::StringLiteral(part), StringLikePart::Bytes(part) => AnyNodeRef::BytesLiteral(part), diff --git a/crates/ruff_python_ast/src/generated.rs b/crates/ruff_python_ast/src/generated.rs new file mode 100644 index 0000000000000..166878d973d32 --- /dev/null +++ b/crates/ruff_python_ast/src/generated.rs @@ -0,0 +1,7984 @@ +// This is a generated file. Don't modify it by hand! +// Run `crates/ruff_python_ast/generate.py` to re-generate the file. + +use crate::name::Name; +use crate::visitor::source_order::SourceOrderVisitor; + +/// See also [mod](https://docs.python.org/3/library/ast.html#ast.mod) +#[derive(Clone, Debug, PartialEq)] +pub enum Mod { + Module(crate::ModModule), + Expression(crate::ModExpression), +} + +impl From<crate::ModModule> for Mod { + fn from(node: crate::ModModule) -> Self { + Self::Module(node) + } +} + +impl From<crate::ModExpression> for Mod { + fn from(node: crate::ModExpression) -> Self { + Self::Expression(node) + } +} + +impl ruff_text_size::Ranged for Mod { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::Module(node) => node.range(), + Self::Expression(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl Mod { + #[inline] + pub const fn is_module(&self) -> bool { + matches!(self, Self::Module(_)) + } + + #[inline] + pub fn module(self) -> Option<crate::ModModule> { + match self { + Self::Module(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_module(self) -> crate::ModModule { + match self { + Self::Module(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_module_mut(&mut self) -> Option<&mut crate::ModModule> { + match self { + Self::Module(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_module(&self) -> Option<&crate::ModModule> { + match self { + Self::Module(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_expression(&self) -> bool { + matches!(self, Self::Expression(_)) + } + + #[inline] + pub fn expression(self) -> Option<crate::ModExpression> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_expression(self) -> crate::ModExpression { + match self { + Self::Expression(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_expression_mut(&mut self) -> Option<&mut crate::ModExpression> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_expression(&self) -> Option<&crate::ModExpression> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } +} + +/// See also [stmt](https://docs.python.org/3/library/ast.html#ast.stmt) +#[derive(Clone, Debug, PartialEq)] +pub enum Stmt { + FunctionDef(crate::StmtFunctionDef), + ClassDef(crate::StmtClassDef), + Return(crate::StmtReturn), + Delete(crate::StmtDelete), + TypeAlias(crate::StmtTypeAlias), + Assign(crate::StmtAssign), + AugAssign(crate::StmtAugAssign), + AnnAssign(crate::StmtAnnAssign), + For(crate::StmtFor), + While(crate::StmtWhile), + If(crate::StmtIf), + With(crate::StmtWith), + Match(crate::StmtMatch), + Raise(crate::StmtRaise), + Try(crate::StmtTry), + Assert(crate::StmtAssert), + Import(crate::StmtImport), + ImportFrom(crate::StmtImportFrom), + Global(crate::StmtGlobal), + Nonlocal(crate::StmtNonlocal), + Expr(crate::StmtExpr), + Pass(crate::StmtPass), + Break(crate::StmtBreak), + Continue(crate::StmtContinue), + IpyEscapeCommand(crate::StmtIpyEscapeCommand), +} + +impl From<crate::StmtFunctionDef> for Stmt { + fn from(node: crate::StmtFunctionDef) -> Self { + Self::FunctionDef(node) + } +} + +impl From<crate::StmtClassDef> for Stmt { + fn from(node: crate::StmtClassDef) -> Self { + Self::ClassDef(node) + } +} + +impl From<crate::StmtReturn> for Stmt { + fn from(node: crate::StmtReturn) -> Self { + Self::Return(node) + } +} + +impl From<crate::StmtDelete> for Stmt { + fn from(node: crate::StmtDelete) -> Self { + Self::Delete(node) + } +} + +impl From<crate::StmtTypeAlias> for Stmt { + fn from(node: crate::StmtTypeAlias) -> Self { + Self::TypeAlias(node) + } +} + +impl From<crate::StmtAssign> for Stmt { + fn from(node: crate::StmtAssign) -> Self { + Self::Assign(node) + } +} + +impl From<crate::StmtAugAssign> for Stmt { + fn from(node: crate::StmtAugAssign) -> Self { + Self::AugAssign(node) + } +} + +impl From<crate::StmtAnnAssign> for Stmt { + fn from(node: crate::StmtAnnAssign) -> Self { + Self::AnnAssign(node) + } +} + +impl From<crate::StmtFor> for Stmt { + fn from(node: crate::StmtFor) -> Self { + Self::For(node) + } +} + +impl From<crate::StmtWhile> for Stmt { + fn from(node: crate::StmtWhile) -> Self { + Self::While(node) + } +} + +impl From<crate::StmtIf> for Stmt { + fn from(node: crate::StmtIf) -> Self { + Self::If(node) + } +} + +impl From<crate::StmtWith> for Stmt { + fn from(node: crate::StmtWith) -> Self { + Self::With(node) + } +} + +impl From<crate::StmtMatch> for Stmt { + fn from(node: crate::StmtMatch) -> Self { + Self::Match(node) + } +} + +impl From<crate::StmtRaise> for Stmt { + fn from(node: crate::StmtRaise) -> Self { + Self::Raise(node) + } +} + +impl From<crate::StmtTry> for Stmt { + fn from(node: crate::StmtTry) -> Self { + Self::Try(node) + } +} + +impl From<crate::StmtAssert> for Stmt { + fn from(node: crate::StmtAssert) -> Self { + Self::Assert(node) + } +} + +impl From<crate::StmtImport> for Stmt { + fn from(node: crate::StmtImport) -> Self { + Self::Import(node) + } +} + +impl From<crate::StmtImportFrom> for Stmt { + fn from(node: crate::StmtImportFrom) -> Self { + Self::ImportFrom(node) + } +} + +impl From<crate::StmtGlobal> for Stmt { + fn from(node: crate::StmtGlobal) -> Self { + Self::Global(node) + } +} + +impl From<crate::StmtNonlocal> for Stmt { + fn from(node: crate::StmtNonlocal) -> Self { + Self::Nonlocal(node) + } +} + +impl From<crate::StmtExpr> for Stmt { + fn from(node: crate::StmtExpr) -> Self { + Self::Expr(node) + } +} + +impl From<crate::StmtPass> for Stmt { + fn from(node: crate::StmtPass) -> Self { + Self::Pass(node) + } +} + +impl From<crate::StmtBreak> for Stmt { + fn from(node: crate::StmtBreak) -> Self { + Self::Break(node) + } +} + +impl From<crate::StmtContinue> for Stmt { + fn from(node: crate::StmtContinue) -> Self { + Self::Continue(node) + } +} + +impl From<crate::StmtIpyEscapeCommand> for Stmt { + fn from(node: crate::StmtIpyEscapeCommand) -> Self { + Self::IpyEscapeCommand(node) + } +} + +impl ruff_text_size::Ranged for Stmt { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::FunctionDef(node) => node.range(), + Self::ClassDef(node) => node.range(), + Self::Return(node) => node.range(), + Self::Delete(node) => node.range(), + Self::TypeAlias(node) => node.range(), + Self::Assign(node) => node.range(), + Self::AugAssign(node) => node.range(), + Self::AnnAssign(node) => node.range(), + Self::For(node) => node.range(), + Self::While(node) => node.range(), + Self::If(node) => node.range(), + Self::With(node) => node.range(), + Self::Match(node) => node.range(), + Self::Raise(node) => node.range(), + Self::Try(node) => node.range(), + Self::Assert(node) => node.range(), + Self::Import(node) => node.range(), + Self::ImportFrom(node) => node.range(), + Self::Global(node) => node.range(), + Self::Nonlocal(node) => node.range(), + Self::Expr(node) => node.range(), + Self::Pass(node) => node.range(), + Self::Break(node) => node.range(), + Self::Continue(node) => node.range(), + Self::IpyEscapeCommand(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl Stmt { + #[inline] + pub const fn is_function_def_stmt(&self) -> bool { + matches!(self, Self::FunctionDef(_)) + } + + #[inline] + pub fn function_def_stmt(self) -> Option<crate::StmtFunctionDef> { + match self { + Self::FunctionDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_function_def_stmt(self) -> crate::StmtFunctionDef { + match self { + Self::FunctionDef(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_function_def_stmt_mut(&mut self) -> Option<&mut crate::StmtFunctionDef> { + match self { + Self::FunctionDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_function_def_stmt(&self) -> Option<&crate::StmtFunctionDef> { + match self { + Self::FunctionDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_class_def_stmt(&self) -> bool { + matches!(self, Self::ClassDef(_)) + } + + #[inline] + pub fn class_def_stmt(self) -> Option<crate::StmtClassDef> { + match self { + Self::ClassDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_class_def_stmt(self) -> crate::StmtClassDef { + match self { + Self::ClassDef(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_class_def_stmt_mut(&mut self) -> Option<&mut crate::StmtClassDef> { + match self { + Self::ClassDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_class_def_stmt(&self) -> Option<&crate::StmtClassDef> { + match self { + Self::ClassDef(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_return_stmt(&self) -> bool { + matches!(self, Self::Return(_)) + } + + #[inline] + pub fn return_stmt(self) -> Option<crate::StmtReturn> { + match self { + Self::Return(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_return_stmt(self) -> crate::StmtReturn { + match self { + Self::Return(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_return_stmt_mut(&mut self) -> Option<&mut crate::StmtReturn> { + match self { + Self::Return(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_return_stmt(&self) -> Option<&crate::StmtReturn> { + match self { + Self::Return(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_delete_stmt(&self) -> bool { + matches!(self, Self::Delete(_)) + } + + #[inline] + pub fn delete_stmt(self) -> Option<crate::StmtDelete> { + match self { + Self::Delete(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_delete_stmt(self) -> crate::StmtDelete { + match self { + Self::Delete(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_delete_stmt_mut(&mut self) -> Option<&mut crate::StmtDelete> { + match self { + Self::Delete(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_delete_stmt(&self) -> Option<&crate::StmtDelete> { + match self { + Self::Delete(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_type_alias_stmt(&self) -> bool { + matches!(self, Self::TypeAlias(_)) + } + + #[inline] + pub fn type_alias_stmt(self) -> Option<crate::StmtTypeAlias> { + match self { + Self::TypeAlias(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_type_alias_stmt(self) -> crate::StmtTypeAlias { + match self { + Self::TypeAlias(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_type_alias_stmt_mut(&mut self) -> Option<&mut crate::StmtTypeAlias> { + match self { + Self::TypeAlias(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_type_alias_stmt(&self) -> Option<&crate::StmtTypeAlias> { + match self { + Self::TypeAlias(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_assign_stmt(&self) -> bool { + matches!(self, Self::Assign(_)) + } + + #[inline] + pub fn assign_stmt(self) -> Option<crate::StmtAssign> { + match self { + Self::Assign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_assign_stmt(self) -> crate::StmtAssign { + match self { + Self::Assign(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_assign_stmt_mut(&mut self) -> Option<&mut crate::StmtAssign> { + match self { + Self::Assign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_assign_stmt(&self) -> Option<&crate::StmtAssign> { + match self { + Self::Assign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_aug_assign_stmt(&self) -> bool { + matches!(self, Self::AugAssign(_)) + } + + #[inline] + pub fn aug_assign_stmt(self) -> Option<crate::StmtAugAssign> { + match self { + Self::AugAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_aug_assign_stmt(self) -> crate::StmtAugAssign { + match self { + Self::AugAssign(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_aug_assign_stmt_mut(&mut self) -> Option<&mut crate::StmtAugAssign> { + match self { + Self::AugAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_aug_assign_stmt(&self) -> Option<&crate::StmtAugAssign> { + match self { + Self::AugAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_ann_assign_stmt(&self) -> bool { + matches!(self, Self::AnnAssign(_)) + } + + #[inline] + pub fn ann_assign_stmt(self) -> Option<crate::StmtAnnAssign> { + match self { + Self::AnnAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_ann_assign_stmt(self) -> crate::StmtAnnAssign { + match self { + Self::AnnAssign(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_ann_assign_stmt_mut(&mut self) -> Option<&mut crate::StmtAnnAssign> { + match self { + Self::AnnAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_ann_assign_stmt(&self) -> Option<&crate::StmtAnnAssign> { + match self { + Self::AnnAssign(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_for_stmt(&self) -> bool { + matches!(self, Self::For(_)) + } + + #[inline] + pub fn for_stmt(self) -> Option<crate::StmtFor> { + match self { + Self::For(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_for_stmt(self) -> crate::StmtFor { + match self { + Self::For(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_for_stmt_mut(&mut self) -> Option<&mut crate::StmtFor> { + match self { + Self::For(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_for_stmt(&self) -> Option<&crate::StmtFor> { + match self { + Self::For(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_while_stmt(&self) -> bool { + matches!(self, Self::While(_)) + } + + #[inline] + pub fn while_stmt(self) -> Option<crate::StmtWhile> { + match self { + Self::While(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_while_stmt(self) -> crate::StmtWhile { + match self { + Self::While(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_while_stmt_mut(&mut self) -> Option<&mut crate::StmtWhile> { + match self { + Self::While(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_while_stmt(&self) -> Option<&crate::StmtWhile> { + match self { + Self::While(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_if_stmt(&self) -> bool { + matches!(self, Self::If(_)) + } + + #[inline] + pub fn if_stmt(self) -> Option<crate::StmtIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_if_stmt(self) -> crate::StmtIf { + match self { + Self::If(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_if_stmt_mut(&mut self) -> Option<&mut crate::StmtIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_if_stmt(&self) -> Option<&crate::StmtIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_with_stmt(&self) -> bool { + matches!(self, Self::With(_)) + } + + #[inline] + pub fn with_stmt(self) -> Option<crate::StmtWith> { + match self { + Self::With(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_with_stmt(self) -> crate::StmtWith { + match self { + Self::With(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_with_stmt_mut(&mut self) -> Option<&mut crate::StmtWith> { + match self { + Self::With(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_with_stmt(&self) -> Option<&crate::StmtWith> { + match self { + Self::With(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_stmt(&self) -> bool { + matches!(self, Self::Match(_)) + } + + #[inline] + pub fn match_stmt(self) -> Option<crate::StmtMatch> { + match self { + Self::Match(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_stmt(self) -> crate::StmtMatch { + match self { + Self::Match(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_stmt_mut(&mut self) -> Option<&mut crate::StmtMatch> { + match self { + Self::Match(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_stmt(&self) -> Option<&crate::StmtMatch> { + match self { + Self::Match(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_raise_stmt(&self) -> bool { + matches!(self, Self::Raise(_)) + } + + #[inline] + pub fn raise_stmt(self) -> Option<crate::StmtRaise> { + match self { + Self::Raise(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_raise_stmt(self) -> crate::StmtRaise { + match self { + Self::Raise(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_raise_stmt_mut(&mut self) -> Option<&mut crate::StmtRaise> { + match self { + Self::Raise(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_raise_stmt(&self) -> Option<&crate::StmtRaise> { + match self { + Self::Raise(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_try_stmt(&self) -> bool { + matches!(self, Self::Try(_)) + } + + #[inline] + pub fn try_stmt(self) -> Option<crate::StmtTry> { + match self { + Self::Try(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_try_stmt(self) -> crate::StmtTry { + match self { + Self::Try(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_try_stmt_mut(&mut self) -> Option<&mut crate::StmtTry> { + match self { + Self::Try(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_try_stmt(&self) -> Option<&crate::StmtTry> { + match self { + Self::Try(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_assert_stmt(&self) -> bool { + matches!(self, Self::Assert(_)) + } + + #[inline] + pub fn assert_stmt(self) -> Option<crate::StmtAssert> { + match self { + Self::Assert(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_assert_stmt(self) -> crate::StmtAssert { + match self { + Self::Assert(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_assert_stmt_mut(&mut self) -> Option<&mut crate::StmtAssert> { + match self { + Self::Assert(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_assert_stmt(&self) -> Option<&crate::StmtAssert> { + match self { + Self::Assert(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_import_stmt(&self) -> bool { + matches!(self, Self::Import(_)) + } + + #[inline] + pub fn import_stmt(self) -> Option<crate::StmtImport> { + match self { + Self::Import(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_import_stmt(self) -> crate::StmtImport { + match self { + Self::Import(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_import_stmt_mut(&mut self) -> Option<&mut crate::StmtImport> { + match self { + Self::Import(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_import_stmt(&self) -> Option<&crate::StmtImport> { + match self { + Self::Import(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_import_from_stmt(&self) -> bool { + matches!(self, Self::ImportFrom(_)) + } + + #[inline] + pub fn import_from_stmt(self) -> Option<crate::StmtImportFrom> { + match self { + Self::ImportFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_import_from_stmt(self) -> crate::StmtImportFrom { + match self { + Self::ImportFrom(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_import_from_stmt_mut(&mut self) -> Option<&mut crate::StmtImportFrom> { + match self { + Self::ImportFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_import_from_stmt(&self) -> Option<&crate::StmtImportFrom> { + match self { + Self::ImportFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_global_stmt(&self) -> bool { + matches!(self, Self::Global(_)) + } + + #[inline] + pub fn global_stmt(self) -> Option<crate::StmtGlobal> { + match self { + Self::Global(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_global_stmt(self) -> crate::StmtGlobal { + match self { + Self::Global(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_global_stmt_mut(&mut self) -> Option<&mut crate::StmtGlobal> { + match self { + Self::Global(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_global_stmt(&self) -> Option<&crate::StmtGlobal> { + match self { + Self::Global(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_nonlocal_stmt(&self) -> bool { + matches!(self, Self::Nonlocal(_)) + } + + #[inline] + pub fn nonlocal_stmt(self) -> Option<crate::StmtNonlocal> { + match self { + Self::Nonlocal(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_nonlocal_stmt(self) -> crate::StmtNonlocal { + match self { + Self::Nonlocal(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_nonlocal_stmt_mut(&mut self) -> Option<&mut crate::StmtNonlocal> { + match self { + Self::Nonlocal(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_nonlocal_stmt(&self) -> Option<&crate::StmtNonlocal> { + match self { + Self::Nonlocal(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_expr_stmt(&self) -> bool { + matches!(self, Self::Expr(_)) + } + + #[inline] + pub fn expr_stmt(self) -> Option<crate::StmtExpr> { + match self { + Self::Expr(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_expr_stmt(self) -> crate::StmtExpr { + match self { + Self::Expr(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_expr_stmt_mut(&mut self) -> Option<&mut crate::StmtExpr> { + match self { + Self::Expr(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_expr_stmt(&self) -> Option<&crate::StmtExpr> { + match self { + Self::Expr(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_pass_stmt(&self) -> bool { + matches!(self, Self::Pass(_)) + } + + #[inline] + pub fn pass_stmt(self) -> Option<crate::StmtPass> { + match self { + Self::Pass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_pass_stmt(self) -> crate::StmtPass { + match self { + Self::Pass(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_pass_stmt_mut(&mut self) -> Option<&mut crate::StmtPass> { + match self { + Self::Pass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_pass_stmt(&self) -> Option<&crate::StmtPass> { + match self { + Self::Pass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_break_stmt(&self) -> bool { + matches!(self, Self::Break(_)) + } + + #[inline] + pub fn break_stmt(self) -> Option<crate::StmtBreak> { + match self { + Self::Break(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_break_stmt(self) -> crate::StmtBreak { + match self { + Self::Break(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_break_stmt_mut(&mut self) -> Option<&mut crate::StmtBreak> { + match self { + Self::Break(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_break_stmt(&self) -> Option<&crate::StmtBreak> { + match self { + Self::Break(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_continue_stmt(&self) -> bool { + matches!(self, Self::Continue(_)) + } + + #[inline] + pub fn continue_stmt(self) -> Option<crate::StmtContinue> { + match self { + Self::Continue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_continue_stmt(self) -> crate::StmtContinue { + match self { + Self::Continue(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_continue_stmt_mut(&mut self) -> Option<&mut crate::StmtContinue> { + match self { + Self::Continue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_continue_stmt(&self) -> Option<&crate::StmtContinue> { + match self { + Self::Continue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_ipy_escape_command_stmt(&self) -> bool { + matches!(self, Self::IpyEscapeCommand(_)) + } + + #[inline] + pub fn ipy_escape_command_stmt(self) -> Option<crate::StmtIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_ipy_escape_command_stmt(self) -> crate::StmtIpyEscapeCommand { + match self { + Self::IpyEscapeCommand(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_ipy_escape_command_stmt_mut(&mut self) -> Option<&mut crate::StmtIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_ipy_escape_command_stmt(&self) -> Option<&crate::StmtIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } +} + +/// See also [expr](https://docs.python.org/3/library/ast.html#ast.expr) +#[derive(Clone, Debug, PartialEq)] +pub enum Expr { + BoolOp(crate::ExprBoolOp), + Named(crate::ExprNamed), + BinOp(crate::ExprBinOp), + UnaryOp(crate::ExprUnaryOp), + Lambda(crate::ExprLambda), + If(crate::ExprIf), + Dict(crate::ExprDict), + Set(crate::ExprSet), + ListComp(crate::ExprListComp), + SetComp(crate::ExprSetComp), + DictComp(crate::ExprDictComp), + Generator(crate::ExprGenerator), + Await(crate::ExprAwait), + Yield(crate::ExprYield), + YieldFrom(crate::ExprYieldFrom), + Compare(crate::ExprCompare), + Call(crate::ExprCall), + FString(crate::ExprFString), + StringLiteral(crate::ExprStringLiteral), + BytesLiteral(crate::ExprBytesLiteral), + NumberLiteral(crate::ExprNumberLiteral), + BooleanLiteral(crate::ExprBooleanLiteral), + NoneLiteral(crate::ExprNoneLiteral), + EllipsisLiteral(crate::ExprEllipsisLiteral), + Attribute(crate::ExprAttribute), + Subscript(crate::ExprSubscript), + Starred(crate::ExprStarred), + Name(crate::ExprName), + List(crate::ExprList), + Tuple(crate::ExprTuple), + Slice(crate::ExprSlice), + IpyEscapeCommand(crate::ExprIpyEscapeCommand), +} + +impl From<crate::ExprBoolOp> for Expr { + fn from(node: crate::ExprBoolOp) -> Self { + Self::BoolOp(node) + } +} + +impl From<crate::ExprNamed> for Expr { + fn from(node: crate::ExprNamed) -> Self { + Self::Named(node) + } +} + +impl From<crate::ExprBinOp> for Expr { + fn from(node: crate::ExprBinOp) -> Self { + Self::BinOp(node) + } +} + +impl From<crate::ExprUnaryOp> for Expr { + fn from(node: crate::ExprUnaryOp) -> Self { + Self::UnaryOp(node) + } +} + +impl From<crate::ExprLambda> for Expr { + fn from(node: crate::ExprLambda) -> Self { + Self::Lambda(node) + } +} + +impl From<crate::ExprIf> for Expr { + fn from(node: crate::ExprIf) -> Self { + Self::If(node) + } +} + +impl From<crate::ExprDict> for Expr { + fn from(node: crate::ExprDict) -> Self { + Self::Dict(node) + } +} + +impl From<crate::ExprSet> for Expr { + fn from(node: crate::ExprSet) -> Self { + Self::Set(node) + } +} + +impl From<crate::ExprListComp> for Expr { + fn from(node: crate::ExprListComp) -> Self { + Self::ListComp(node) + } +} + +impl From<crate::ExprSetComp> for Expr { + fn from(node: crate::ExprSetComp) -> Self { + Self::SetComp(node) + } +} + +impl From<crate::ExprDictComp> for Expr { + fn from(node: crate::ExprDictComp) -> Self { + Self::DictComp(node) + } +} + +impl From<crate::ExprGenerator> for Expr { + fn from(node: crate::ExprGenerator) -> Self { + Self::Generator(node) + } +} + +impl From<crate::ExprAwait> for Expr { + fn from(node: crate::ExprAwait) -> Self { + Self::Await(node) + } +} + +impl From<crate::ExprYield> for Expr { + fn from(node: crate::ExprYield) -> Self { + Self::Yield(node) + } +} + +impl From<crate::ExprYieldFrom> for Expr { + fn from(node: crate::ExprYieldFrom) -> Self { + Self::YieldFrom(node) + } +} + +impl From<crate::ExprCompare> for Expr { + fn from(node: crate::ExprCompare) -> Self { + Self::Compare(node) + } +} + +impl From<crate::ExprCall> for Expr { + fn from(node: crate::ExprCall) -> Self { + Self::Call(node) + } +} + +impl From<crate::ExprFString> for Expr { + fn from(node: crate::ExprFString) -> Self { + Self::FString(node) + } +} + +impl From<crate::ExprStringLiteral> for Expr { + fn from(node: crate::ExprStringLiteral) -> Self { + Self::StringLiteral(node) + } +} + +impl From<crate::ExprBytesLiteral> for Expr { + fn from(node: crate::ExprBytesLiteral) -> Self { + Self::BytesLiteral(node) + } +} + +impl From<crate::ExprNumberLiteral> for Expr { + fn from(node: crate::ExprNumberLiteral) -> Self { + Self::NumberLiteral(node) + } +} + +impl From<crate::ExprBooleanLiteral> for Expr { + fn from(node: crate::ExprBooleanLiteral) -> Self { + Self::BooleanLiteral(node) + } +} + +impl From<crate::ExprNoneLiteral> for Expr { + fn from(node: crate::ExprNoneLiteral) -> Self { + Self::NoneLiteral(node) + } +} + +impl From<crate::ExprEllipsisLiteral> for Expr { + fn from(node: crate::ExprEllipsisLiteral) -> Self { + Self::EllipsisLiteral(node) + } +} + +impl From<crate::ExprAttribute> for Expr { + fn from(node: crate::ExprAttribute) -> Self { + Self::Attribute(node) + } +} + +impl From<crate::ExprSubscript> for Expr { + fn from(node: crate::ExprSubscript) -> Self { + Self::Subscript(node) + } +} + +impl From<crate::ExprStarred> for Expr { + fn from(node: crate::ExprStarred) -> Self { + Self::Starred(node) + } +} + +impl From<crate::ExprName> for Expr { + fn from(node: crate::ExprName) -> Self { + Self::Name(node) + } +} + +impl From<crate::ExprList> for Expr { + fn from(node: crate::ExprList) -> Self { + Self::List(node) + } +} + +impl From<crate::ExprTuple> for Expr { + fn from(node: crate::ExprTuple) -> Self { + Self::Tuple(node) + } +} + +impl From<crate::ExprSlice> for Expr { + fn from(node: crate::ExprSlice) -> Self { + Self::Slice(node) + } +} + +impl From<crate::ExprIpyEscapeCommand> for Expr { + fn from(node: crate::ExprIpyEscapeCommand) -> Self { + Self::IpyEscapeCommand(node) + } +} + +impl ruff_text_size::Ranged for Expr { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::BoolOp(node) => node.range(), + Self::Named(node) => node.range(), + Self::BinOp(node) => node.range(), + Self::UnaryOp(node) => node.range(), + Self::Lambda(node) => node.range(), + Self::If(node) => node.range(), + Self::Dict(node) => node.range(), + Self::Set(node) => node.range(), + Self::ListComp(node) => node.range(), + Self::SetComp(node) => node.range(), + Self::DictComp(node) => node.range(), + Self::Generator(node) => node.range(), + Self::Await(node) => node.range(), + Self::Yield(node) => node.range(), + Self::YieldFrom(node) => node.range(), + Self::Compare(node) => node.range(), + Self::Call(node) => node.range(), + Self::FString(node) => node.range(), + Self::StringLiteral(node) => node.range(), + Self::BytesLiteral(node) => node.range(), + Self::NumberLiteral(node) => node.range(), + Self::BooleanLiteral(node) => node.range(), + Self::NoneLiteral(node) => node.range(), + Self::EllipsisLiteral(node) => node.range(), + Self::Attribute(node) => node.range(), + Self::Subscript(node) => node.range(), + Self::Starred(node) => node.range(), + Self::Name(node) => node.range(), + Self::List(node) => node.range(), + Self::Tuple(node) => node.range(), + Self::Slice(node) => node.range(), + Self::IpyEscapeCommand(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl Expr { + #[inline] + pub const fn is_bool_op_expr(&self) -> bool { + matches!(self, Self::BoolOp(_)) + } + + #[inline] + pub fn bool_op_expr(self) -> Option<crate::ExprBoolOp> { + match self { + Self::BoolOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_bool_op_expr(self) -> crate::ExprBoolOp { + match self { + Self::BoolOp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_bool_op_expr_mut(&mut self) -> Option<&mut crate::ExprBoolOp> { + match self { + Self::BoolOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_bool_op_expr(&self) -> Option<&crate::ExprBoolOp> { + match self { + Self::BoolOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_named_expr(&self) -> bool { + matches!(self, Self::Named(_)) + } + + #[inline] + pub fn named_expr(self) -> Option<crate::ExprNamed> { + match self { + Self::Named(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_named_expr(self) -> crate::ExprNamed { + match self { + Self::Named(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_named_expr_mut(&mut self) -> Option<&mut crate::ExprNamed> { + match self { + Self::Named(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_named_expr(&self) -> Option<&crate::ExprNamed> { + match self { + Self::Named(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_bin_op_expr(&self) -> bool { + matches!(self, Self::BinOp(_)) + } + + #[inline] + pub fn bin_op_expr(self) -> Option<crate::ExprBinOp> { + match self { + Self::BinOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_bin_op_expr(self) -> crate::ExprBinOp { + match self { + Self::BinOp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_bin_op_expr_mut(&mut self) -> Option<&mut crate::ExprBinOp> { + match self { + Self::BinOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_bin_op_expr(&self) -> Option<&crate::ExprBinOp> { + match self { + Self::BinOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_unary_op_expr(&self) -> bool { + matches!(self, Self::UnaryOp(_)) + } + + #[inline] + pub fn unary_op_expr(self) -> Option<crate::ExprUnaryOp> { + match self { + Self::UnaryOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_unary_op_expr(self) -> crate::ExprUnaryOp { + match self { + Self::UnaryOp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_unary_op_expr_mut(&mut self) -> Option<&mut crate::ExprUnaryOp> { + match self { + Self::UnaryOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_unary_op_expr(&self) -> Option<&crate::ExprUnaryOp> { + match self { + Self::UnaryOp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_lambda_expr(&self) -> bool { + matches!(self, Self::Lambda(_)) + } + + #[inline] + pub fn lambda_expr(self) -> Option<crate::ExprLambda> { + match self { + Self::Lambda(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_lambda_expr(self) -> crate::ExprLambda { + match self { + Self::Lambda(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_lambda_expr_mut(&mut self) -> Option<&mut crate::ExprLambda> { + match self { + Self::Lambda(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_lambda_expr(&self) -> Option<&crate::ExprLambda> { + match self { + Self::Lambda(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_if_expr(&self) -> bool { + matches!(self, Self::If(_)) + } + + #[inline] + pub fn if_expr(self) -> Option<crate::ExprIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_if_expr(self) -> crate::ExprIf { + match self { + Self::If(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_if_expr_mut(&mut self) -> Option<&mut crate::ExprIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_if_expr(&self) -> Option<&crate::ExprIf> { + match self { + Self::If(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_dict_expr(&self) -> bool { + matches!(self, Self::Dict(_)) + } + + #[inline] + pub fn dict_expr(self) -> Option<crate::ExprDict> { + match self { + Self::Dict(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_dict_expr(self) -> crate::ExprDict { + match self { + Self::Dict(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_dict_expr_mut(&mut self) -> Option<&mut crate::ExprDict> { + match self { + Self::Dict(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_dict_expr(&self) -> Option<&crate::ExprDict> { + match self { + Self::Dict(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_set_expr(&self) -> bool { + matches!(self, Self::Set(_)) + } + + #[inline] + pub fn set_expr(self) -> Option<crate::ExprSet> { + match self { + Self::Set(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_set_expr(self) -> crate::ExprSet { + match self { + Self::Set(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_set_expr_mut(&mut self) -> Option<&mut crate::ExprSet> { + match self { + Self::Set(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_set_expr(&self) -> Option<&crate::ExprSet> { + match self { + Self::Set(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_list_comp_expr(&self) -> bool { + matches!(self, Self::ListComp(_)) + } + + #[inline] + pub fn list_comp_expr(self) -> Option<crate::ExprListComp> { + match self { + Self::ListComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_list_comp_expr(self) -> crate::ExprListComp { + match self { + Self::ListComp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_list_comp_expr_mut(&mut self) -> Option<&mut crate::ExprListComp> { + match self { + Self::ListComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_list_comp_expr(&self) -> Option<&crate::ExprListComp> { + match self { + Self::ListComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_set_comp_expr(&self) -> bool { + matches!(self, Self::SetComp(_)) + } + + #[inline] + pub fn set_comp_expr(self) -> Option<crate::ExprSetComp> { + match self { + Self::SetComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_set_comp_expr(self) -> crate::ExprSetComp { + match self { + Self::SetComp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_set_comp_expr_mut(&mut self) -> Option<&mut crate::ExprSetComp> { + match self { + Self::SetComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_set_comp_expr(&self) -> Option<&crate::ExprSetComp> { + match self { + Self::SetComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_dict_comp_expr(&self) -> bool { + matches!(self, Self::DictComp(_)) + } + + #[inline] + pub fn dict_comp_expr(self) -> Option<crate::ExprDictComp> { + match self { + Self::DictComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_dict_comp_expr(self) -> crate::ExprDictComp { + match self { + Self::DictComp(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_dict_comp_expr_mut(&mut self) -> Option<&mut crate::ExprDictComp> { + match self { + Self::DictComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_dict_comp_expr(&self) -> Option<&crate::ExprDictComp> { + match self { + Self::DictComp(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_generator_expr(&self) -> bool { + matches!(self, Self::Generator(_)) + } + + #[inline] + pub fn generator_expr(self) -> Option<crate::ExprGenerator> { + match self { + Self::Generator(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_generator_expr(self) -> crate::ExprGenerator { + match self { + Self::Generator(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_generator_expr_mut(&mut self) -> Option<&mut crate::ExprGenerator> { + match self { + Self::Generator(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_generator_expr(&self) -> Option<&crate::ExprGenerator> { + match self { + Self::Generator(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_await_expr(&self) -> bool { + matches!(self, Self::Await(_)) + } + + #[inline] + pub fn await_expr(self) -> Option<crate::ExprAwait> { + match self { + Self::Await(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_await_expr(self) -> crate::ExprAwait { + match self { + Self::Await(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_await_expr_mut(&mut self) -> Option<&mut crate::ExprAwait> { + match self { + Self::Await(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_await_expr(&self) -> Option<&crate::ExprAwait> { + match self { + Self::Await(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_yield_expr(&self) -> bool { + matches!(self, Self::Yield(_)) + } + + #[inline] + pub fn yield_expr(self) -> Option<crate::ExprYield> { + match self { + Self::Yield(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_yield_expr(self) -> crate::ExprYield { + match self { + Self::Yield(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_yield_expr_mut(&mut self) -> Option<&mut crate::ExprYield> { + match self { + Self::Yield(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_yield_expr(&self) -> Option<&crate::ExprYield> { + match self { + Self::Yield(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_yield_from_expr(&self) -> bool { + matches!(self, Self::YieldFrom(_)) + } + + #[inline] + pub fn yield_from_expr(self) -> Option<crate::ExprYieldFrom> { + match self { + Self::YieldFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_yield_from_expr(self) -> crate::ExprYieldFrom { + match self { + Self::YieldFrom(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_yield_from_expr_mut(&mut self) -> Option<&mut crate::ExprYieldFrom> { + match self { + Self::YieldFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_yield_from_expr(&self) -> Option<&crate::ExprYieldFrom> { + match self { + Self::YieldFrom(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_compare_expr(&self) -> bool { + matches!(self, Self::Compare(_)) + } + + #[inline] + pub fn compare_expr(self) -> Option<crate::ExprCompare> { + match self { + Self::Compare(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_compare_expr(self) -> crate::ExprCompare { + match self { + Self::Compare(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_compare_expr_mut(&mut self) -> Option<&mut crate::ExprCompare> { + match self { + Self::Compare(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_compare_expr(&self) -> Option<&crate::ExprCompare> { + match self { + Self::Compare(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_call_expr(&self) -> bool { + matches!(self, Self::Call(_)) + } + + #[inline] + pub fn call_expr(self) -> Option<crate::ExprCall> { + match self { + Self::Call(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_call_expr(self) -> crate::ExprCall { + match self { + Self::Call(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_call_expr_mut(&mut self) -> Option<&mut crate::ExprCall> { + match self { + Self::Call(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_call_expr(&self) -> Option<&crate::ExprCall> { + match self { + Self::Call(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_f_string_expr(&self) -> bool { + matches!(self, Self::FString(_)) + } + + #[inline] + pub fn f_string_expr(self) -> Option<crate::ExprFString> { + match self { + Self::FString(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_f_string_expr(self) -> crate::ExprFString { + match self { + Self::FString(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_f_string_expr_mut(&mut self) -> Option<&mut crate::ExprFString> { + match self { + Self::FString(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_f_string_expr(&self) -> Option<&crate::ExprFString> { + match self { + Self::FString(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_string_literal_expr(&self) -> bool { + matches!(self, Self::StringLiteral(_)) + } + + #[inline] + pub fn string_literal_expr(self) -> Option<crate::ExprStringLiteral> { + match self { + Self::StringLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_string_literal_expr(self) -> crate::ExprStringLiteral { + match self { + Self::StringLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_string_literal_expr_mut(&mut self) -> Option<&mut crate::ExprStringLiteral> { + match self { + Self::StringLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_string_literal_expr(&self) -> Option<&crate::ExprStringLiteral> { + match self { + Self::StringLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_bytes_literal_expr(&self) -> bool { + matches!(self, Self::BytesLiteral(_)) + } + + #[inline] + pub fn bytes_literal_expr(self) -> Option<crate::ExprBytesLiteral> { + match self { + Self::BytesLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_bytes_literal_expr(self) -> crate::ExprBytesLiteral { + match self { + Self::BytesLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_bytes_literal_expr_mut(&mut self) -> Option<&mut crate::ExprBytesLiteral> { + match self { + Self::BytesLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_bytes_literal_expr(&self) -> Option<&crate::ExprBytesLiteral> { + match self { + Self::BytesLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_number_literal_expr(&self) -> bool { + matches!(self, Self::NumberLiteral(_)) + } + + #[inline] + pub fn number_literal_expr(self) -> Option<crate::ExprNumberLiteral> { + match self { + Self::NumberLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_number_literal_expr(self) -> crate::ExprNumberLiteral { + match self { + Self::NumberLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_number_literal_expr_mut(&mut self) -> Option<&mut crate::ExprNumberLiteral> { + match self { + Self::NumberLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_number_literal_expr(&self) -> Option<&crate::ExprNumberLiteral> { + match self { + Self::NumberLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_boolean_literal_expr(&self) -> bool { + matches!(self, Self::BooleanLiteral(_)) + } + + #[inline] + pub fn boolean_literal_expr(self) -> Option<crate::ExprBooleanLiteral> { + match self { + Self::BooleanLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_boolean_literal_expr(self) -> crate::ExprBooleanLiteral { + match self { + Self::BooleanLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_boolean_literal_expr_mut(&mut self) -> Option<&mut crate::ExprBooleanLiteral> { + match self { + Self::BooleanLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_boolean_literal_expr(&self) -> Option<&crate::ExprBooleanLiteral> { + match self { + Self::BooleanLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_none_literal_expr(&self) -> bool { + matches!(self, Self::NoneLiteral(_)) + } + + #[inline] + pub fn none_literal_expr(self) -> Option<crate::ExprNoneLiteral> { + match self { + Self::NoneLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_none_literal_expr(self) -> crate::ExprNoneLiteral { + match self { + Self::NoneLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_none_literal_expr_mut(&mut self) -> Option<&mut crate::ExprNoneLiteral> { + match self { + Self::NoneLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_none_literal_expr(&self) -> Option<&crate::ExprNoneLiteral> { + match self { + Self::NoneLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_ellipsis_literal_expr(&self) -> bool { + matches!(self, Self::EllipsisLiteral(_)) + } + + #[inline] + pub fn ellipsis_literal_expr(self) -> Option<crate::ExprEllipsisLiteral> { + match self { + Self::EllipsisLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_ellipsis_literal_expr(self) -> crate::ExprEllipsisLiteral { + match self { + Self::EllipsisLiteral(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_ellipsis_literal_expr_mut(&mut self) -> Option<&mut crate::ExprEllipsisLiteral> { + match self { + Self::EllipsisLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_ellipsis_literal_expr(&self) -> Option<&crate::ExprEllipsisLiteral> { + match self { + Self::EllipsisLiteral(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_attribute_expr(&self) -> bool { + matches!(self, Self::Attribute(_)) + } + + #[inline] + pub fn attribute_expr(self) -> Option<crate::ExprAttribute> { + match self { + Self::Attribute(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_attribute_expr(self) -> crate::ExprAttribute { + match self { + Self::Attribute(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_attribute_expr_mut(&mut self) -> Option<&mut crate::ExprAttribute> { + match self { + Self::Attribute(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_attribute_expr(&self) -> Option<&crate::ExprAttribute> { + match self { + Self::Attribute(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_subscript_expr(&self) -> bool { + matches!(self, Self::Subscript(_)) + } + + #[inline] + pub fn subscript_expr(self) -> Option<crate::ExprSubscript> { + match self { + Self::Subscript(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_subscript_expr(self) -> crate::ExprSubscript { + match self { + Self::Subscript(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_subscript_expr_mut(&mut self) -> Option<&mut crate::ExprSubscript> { + match self { + Self::Subscript(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_subscript_expr(&self) -> Option<&crate::ExprSubscript> { + match self { + Self::Subscript(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_starred_expr(&self) -> bool { + matches!(self, Self::Starred(_)) + } + + #[inline] + pub fn starred_expr(self) -> Option<crate::ExprStarred> { + match self { + Self::Starred(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_starred_expr(self) -> crate::ExprStarred { + match self { + Self::Starred(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_starred_expr_mut(&mut self) -> Option<&mut crate::ExprStarred> { + match self { + Self::Starred(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_starred_expr(&self) -> Option<&crate::ExprStarred> { + match self { + Self::Starred(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_name_expr(&self) -> bool { + matches!(self, Self::Name(_)) + } + + #[inline] + pub fn name_expr(self) -> Option<crate::ExprName> { + match self { + Self::Name(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_name_expr(self) -> crate::ExprName { + match self { + Self::Name(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_name_expr_mut(&mut self) -> Option<&mut crate::ExprName> { + match self { + Self::Name(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_name_expr(&self) -> Option<&crate::ExprName> { + match self { + Self::Name(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_list_expr(&self) -> bool { + matches!(self, Self::List(_)) + } + + #[inline] + pub fn list_expr(self) -> Option<crate::ExprList> { + match self { + Self::List(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_list_expr(self) -> crate::ExprList { + match self { + Self::List(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_list_expr_mut(&mut self) -> Option<&mut crate::ExprList> { + match self { + Self::List(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_list_expr(&self) -> Option<&crate::ExprList> { + match self { + Self::List(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_tuple_expr(&self) -> bool { + matches!(self, Self::Tuple(_)) + } + + #[inline] + pub fn tuple_expr(self) -> Option<crate::ExprTuple> { + match self { + Self::Tuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_tuple_expr(self) -> crate::ExprTuple { + match self { + Self::Tuple(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_tuple_expr_mut(&mut self) -> Option<&mut crate::ExprTuple> { + match self { + Self::Tuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_tuple_expr(&self) -> Option<&crate::ExprTuple> { + match self { + Self::Tuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_slice_expr(&self) -> bool { + matches!(self, Self::Slice(_)) + } + + #[inline] + pub fn slice_expr(self) -> Option<crate::ExprSlice> { + match self { + Self::Slice(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_slice_expr(self) -> crate::ExprSlice { + match self { + Self::Slice(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_slice_expr_mut(&mut self) -> Option<&mut crate::ExprSlice> { + match self { + Self::Slice(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_slice_expr(&self) -> Option<&crate::ExprSlice> { + match self { + Self::Slice(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_ipy_escape_command_expr(&self) -> bool { + matches!(self, Self::IpyEscapeCommand(_)) + } + + #[inline] + pub fn ipy_escape_command_expr(self) -> Option<crate::ExprIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_ipy_escape_command_expr(self) -> crate::ExprIpyEscapeCommand { + match self { + Self::IpyEscapeCommand(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_ipy_escape_command_expr_mut(&mut self) -> Option<&mut crate::ExprIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_ipy_escape_command_expr(&self) -> Option<&crate::ExprIpyEscapeCommand> { + match self { + Self::IpyEscapeCommand(val) => Some(val), + _ => None, + } + } +} + +/// See also [excepthandler](https://docs.python.org/3/library/ast.html#ast.excepthandler) +#[derive(Clone, Debug, PartialEq)] +pub enum ExceptHandler { + ExceptHandler(crate::ExceptHandlerExceptHandler), +} + +impl From<crate::ExceptHandlerExceptHandler> for ExceptHandler { + fn from(node: crate::ExceptHandlerExceptHandler) -> Self { + Self::ExceptHandler(node) + } +} + +impl ruff_text_size::Ranged for ExceptHandler { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::ExceptHandler(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl ExceptHandler { + #[inline] + pub const fn is_except_handler(&self) -> bool { + matches!(self, Self::ExceptHandler(_)) + } + + #[inline] + pub fn except_handler(self) -> Option<crate::ExceptHandlerExceptHandler> { + match self { + Self::ExceptHandler(val) => Some(val), + } + } + + #[inline] + pub fn expect_except_handler(self) -> crate::ExceptHandlerExceptHandler { + match self { + Self::ExceptHandler(val) => val, + } + } + + #[inline] + pub fn as_except_handler_mut(&mut self) -> Option<&mut crate::ExceptHandlerExceptHandler> { + match self { + Self::ExceptHandler(val) => Some(val), + } + } + + #[inline] + pub fn as_except_handler(&self) -> Option<&crate::ExceptHandlerExceptHandler> { + match self { + Self::ExceptHandler(val) => Some(val), + } + } +} + +#[derive(Clone, Debug, PartialEq)] +pub enum FStringElement { + Expression(crate::FStringExpressionElement), + Literal(crate::FStringLiteralElement), +} + +impl From<crate::FStringExpressionElement> for FStringElement { + fn from(node: crate::FStringExpressionElement) -> Self { + Self::Expression(node) + } +} + +impl From<crate::FStringLiteralElement> for FStringElement { + fn from(node: crate::FStringLiteralElement) -> Self { + Self::Literal(node) + } +} + +impl ruff_text_size::Ranged for FStringElement { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::Expression(node) => node.range(), + Self::Literal(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl FStringElement { + #[inline] + pub const fn is_expression(&self) -> bool { + matches!(self, Self::Expression(_)) + } + + #[inline] + pub fn expression(self) -> Option<crate::FStringExpressionElement> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_expression(self) -> crate::FStringExpressionElement { + match self { + Self::Expression(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_expression_mut(&mut self) -> Option<&mut crate::FStringExpressionElement> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_expression(&self) -> Option<&crate::FStringExpressionElement> { + match self { + Self::Expression(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_literal(&self) -> bool { + matches!(self, Self::Literal(_)) + } + + #[inline] + pub fn literal(self) -> Option<crate::FStringLiteralElement> { + match self { + Self::Literal(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_literal(self) -> crate::FStringLiteralElement { + match self { + Self::Literal(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_literal_mut(&mut self) -> Option<&mut crate::FStringLiteralElement> { + match self { + Self::Literal(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_literal(&self) -> Option<&crate::FStringLiteralElement> { + match self { + Self::Literal(val) => Some(val), + _ => None, + } + } +} + +/// See also [pattern](https://docs.python.org/3/library/ast.html#ast.pattern) +#[derive(Clone, Debug, PartialEq)] +pub enum Pattern { + MatchValue(crate::PatternMatchValue), + MatchSingleton(crate::PatternMatchSingleton), + MatchSequence(crate::PatternMatchSequence), + MatchMapping(crate::PatternMatchMapping), + MatchClass(crate::PatternMatchClass), + MatchStar(crate::PatternMatchStar), + MatchAs(crate::PatternMatchAs), + MatchOr(crate::PatternMatchOr), +} + +impl From<crate::PatternMatchValue> for Pattern { + fn from(node: crate::PatternMatchValue) -> Self { + Self::MatchValue(node) + } +} + +impl From<crate::PatternMatchSingleton> for Pattern { + fn from(node: crate::PatternMatchSingleton) -> Self { + Self::MatchSingleton(node) + } +} + +impl From<crate::PatternMatchSequence> for Pattern { + fn from(node: crate::PatternMatchSequence) -> Self { + Self::MatchSequence(node) + } +} + +impl From<crate::PatternMatchMapping> for Pattern { + fn from(node: crate::PatternMatchMapping) -> Self { + Self::MatchMapping(node) + } +} + +impl From<crate::PatternMatchClass> for Pattern { + fn from(node: crate::PatternMatchClass) -> Self { + Self::MatchClass(node) + } +} + +impl From<crate::PatternMatchStar> for Pattern { + fn from(node: crate::PatternMatchStar) -> Self { + Self::MatchStar(node) + } +} + +impl From<crate::PatternMatchAs> for Pattern { + fn from(node: crate::PatternMatchAs) -> Self { + Self::MatchAs(node) + } +} + +impl From<crate::PatternMatchOr> for Pattern { + fn from(node: crate::PatternMatchOr) -> Self { + Self::MatchOr(node) + } +} + +impl ruff_text_size::Ranged for Pattern { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::MatchValue(node) => node.range(), + Self::MatchSingleton(node) => node.range(), + Self::MatchSequence(node) => node.range(), + Self::MatchMapping(node) => node.range(), + Self::MatchClass(node) => node.range(), + Self::MatchStar(node) => node.range(), + Self::MatchAs(node) => node.range(), + Self::MatchOr(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl Pattern { + #[inline] + pub const fn is_match_value(&self) -> bool { + matches!(self, Self::MatchValue(_)) + } + + #[inline] + pub fn match_value(self) -> Option<crate::PatternMatchValue> { + match self { + Self::MatchValue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_value(self) -> crate::PatternMatchValue { + match self { + Self::MatchValue(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_value_mut(&mut self) -> Option<&mut crate::PatternMatchValue> { + match self { + Self::MatchValue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_value(&self) -> Option<&crate::PatternMatchValue> { + match self { + Self::MatchValue(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_singleton(&self) -> bool { + matches!(self, Self::MatchSingleton(_)) + } + + #[inline] + pub fn match_singleton(self) -> Option<crate::PatternMatchSingleton> { + match self { + Self::MatchSingleton(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_singleton(self) -> crate::PatternMatchSingleton { + match self { + Self::MatchSingleton(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_singleton_mut(&mut self) -> Option<&mut crate::PatternMatchSingleton> { + match self { + Self::MatchSingleton(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_singleton(&self) -> Option<&crate::PatternMatchSingleton> { + match self { + Self::MatchSingleton(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_sequence(&self) -> bool { + matches!(self, Self::MatchSequence(_)) + } + + #[inline] + pub fn match_sequence(self) -> Option<crate::PatternMatchSequence> { + match self { + Self::MatchSequence(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_sequence(self) -> crate::PatternMatchSequence { + match self { + Self::MatchSequence(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_sequence_mut(&mut self) -> Option<&mut crate::PatternMatchSequence> { + match self { + Self::MatchSequence(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_sequence(&self) -> Option<&crate::PatternMatchSequence> { + match self { + Self::MatchSequence(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_mapping(&self) -> bool { + matches!(self, Self::MatchMapping(_)) + } + + #[inline] + pub fn match_mapping(self) -> Option<crate::PatternMatchMapping> { + match self { + Self::MatchMapping(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_mapping(self) -> crate::PatternMatchMapping { + match self { + Self::MatchMapping(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_mapping_mut(&mut self) -> Option<&mut crate::PatternMatchMapping> { + match self { + Self::MatchMapping(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_mapping(&self) -> Option<&crate::PatternMatchMapping> { + match self { + Self::MatchMapping(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_class(&self) -> bool { + matches!(self, Self::MatchClass(_)) + } + + #[inline] + pub fn match_class(self) -> Option<crate::PatternMatchClass> { + match self { + Self::MatchClass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_class(self) -> crate::PatternMatchClass { + match self { + Self::MatchClass(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_class_mut(&mut self) -> Option<&mut crate::PatternMatchClass> { + match self { + Self::MatchClass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_class(&self) -> Option<&crate::PatternMatchClass> { + match self { + Self::MatchClass(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_star(&self) -> bool { + matches!(self, Self::MatchStar(_)) + } + + #[inline] + pub fn match_star(self) -> Option<crate::PatternMatchStar> { + match self { + Self::MatchStar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_star(self) -> crate::PatternMatchStar { + match self { + Self::MatchStar(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_star_mut(&mut self) -> Option<&mut crate::PatternMatchStar> { + match self { + Self::MatchStar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_star(&self) -> Option<&crate::PatternMatchStar> { + match self { + Self::MatchStar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_as(&self) -> bool { + matches!(self, Self::MatchAs(_)) + } + + #[inline] + pub fn match_as(self) -> Option<crate::PatternMatchAs> { + match self { + Self::MatchAs(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_as(self) -> crate::PatternMatchAs { + match self { + Self::MatchAs(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_as_mut(&mut self) -> Option<&mut crate::PatternMatchAs> { + match self { + Self::MatchAs(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_as(&self) -> Option<&crate::PatternMatchAs> { + match self { + Self::MatchAs(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_match_or(&self) -> bool { + matches!(self, Self::MatchOr(_)) + } + + #[inline] + pub fn match_or(self) -> Option<crate::PatternMatchOr> { + match self { + Self::MatchOr(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_match_or(self) -> crate::PatternMatchOr { + match self { + Self::MatchOr(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_match_or_mut(&mut self) -> Option<&mut crate::PatternMatchOr> { + match self { + Self::MatchOr(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_match_or(&self) -> Option<&crate::PatternMatchOr> { + match self { + Self::MatchOr(val) => Some(val), + _ => None, + } + } +} + +/// See also [type_param](https://docs.python.org/3/library/ast.html#ast.type_param) +#[derive(Clone, Debug, PartialEq)] +pub enum TypeParam { + TypeVar(crate::TypeParamTypeVar), + TypeVarTuple(crate::TypeParamTypeVarTuple), + ParamSpec(crate::TypeParamParamSpec), +} + +impl From<crate::TypeParamTypeVar> for TypeParam { + fn from(node: crate::TypeParamTypeVar) -> Self { + Self::TypeVar(node) + } +} + +impl From<crate::TypeParamTypeVarTuple> for TypeParam { + fn from(node: crate::TypeParamTypeVarTuple) -> Self { + Self::TypeVarTuple(node) + } +} + +impl From<crate::TypeParamParamSpec> for TypeParam { + fn from(node: crate::TypeParamParamSpec) -> Self { + Self::ParamSpec(node) + } +} + +impl ruff_text_size::Ranged for TypeParam { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::TypeVar(node) => node.range(), + Self::TypeVarTuple(node) => node.range(), + Self::ParamSpec(node) => node.range(), + } + } +} + +#[allow(dead_code, clippy::match_wildcard_for_single_variants)] +impl TypeParam { + #[inline] + pub const fn is_type_var(&self) -> bool { + matches!(self, Self::TypeVar(_)) + } + + #[inline] + pub fn type_var(self) -> Option<crate::TypeParamTypeVar> { + match self { + Self::TypeVar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_type_var(self) -> crate::TypeParamTypeVar { + match self { + Self::TypeVar(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_type_var_mut(&mut self) -> Option<&mut crate::TypeParamTypeVar> { + match self { + Self::TypeVar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_type_var(&self) -> Option<&crate::TypeParamTypeVar> { + match self { + Self::TypeVar(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_type_var_tuple(&self) -> bool { + matches!(self, Self::TypeVarTuple(_)) + } + + #[inline] + pub fn type_var_tuple(self) -> Option<crate::TypeParamTypeVarTuple> { + match self { + Self::TypeVarTuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_type_var_tuple(self) -> crate::TypeParamTypeVarTuple { + match self { + Self::TypeVarTuple(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_type_var_tuple_mut(&mut self) -> Option<&mut crate::TypeParamTypeVarTuple> { + match self { + Self::TypeVarTuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_type_var_tuple(&self) -> Option<&crate::TypeParamTypeVarTuple> { + match self { + Self::TypeVarTuple(val) => Some(val), + _ => None, + } + } + + #[inline] + pub const fn is_param_spec(&self) -> bool { + matches!(self, Self::ParamSpec(_)) + } + + #[inline] + pub fn param_spec(self) -> Option<crate::TypeParamParamSpec> { + match self { + Self::ParamSpec(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn expect_param_spec(self) -> crate::TypeParamParamSpec { + match self { + Self::ParamSpec(val) => val, + _ => panic!("called expect on {self:?}"), + } + } + + #[inline] + pub fn as_param_spec_mut(&mut self) -> Option<&mut crate::TypeParamParamSpec> { + match self { + Self::ParamSpec(val) => Some(val), + _ => None, + } + } + + #[inline] + pub fn as_param_spec(&self) -> Option<&crate::TypeParamParamSpec> { + match self { + Self::ParamSpec(val) => Some(val), + _ => None, + } + } +} + +impl ruff_text_size::Ranged for crate::ModModule { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ModExpression { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtFunctionDef { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtClassDef { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtReturn { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtDelete { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtTypeAlias { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtAssign { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtAugAssign { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtAnnAssign { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtFor { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtWhile { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtIf { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtWith { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtMatch { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtRaise { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtTry { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtAssert { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtImport { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtImportFrom { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtGlobal { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtNonlocal { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtExpr { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtPass { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtBreak { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtContinue { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StmtIpyEscapeCommand { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprBoolOp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprNamed { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprBinOp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprUnaryOp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprLambda { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprIf { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprDict { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprSet { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprListComp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprSetComp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprDictComp { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprGenerator { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprAwait { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprYield { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprYieldFrom { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprCompare { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprCall { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprFString { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprStringLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprBytesLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprNumberLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprBooleanLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprNoneLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprEllipsisLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprAttribute { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprSubscript { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprStarred { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprName { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprList { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprTuple { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprSlice { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExprIpyEscapeCommand { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ExceptHandlerExceptHandler { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::FStringExpressionElement { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::FStringLiteralElement { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchValue { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchSingleton { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchSequence { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchMapping { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchClass { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchStar { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchAs { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternMatchOr { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::TypeParamTypeVar { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::TypeParamTypeVarTuple { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::TypeParamParamSpec { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::FStringFormatSpec { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternArguments { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::PatternKeyword { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Comprehension { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Arguments { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Parameters { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Parameter { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ParameterWithDefault { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Keyword { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Alias { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::WithItem { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::MatchCase { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Decorator { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::ElifElseClause { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::TypeParams { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::FString { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::StringLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::BytesLiteral { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl ruff_text_size::Ranged for crate::Identifier { + fn range(&self) -> ruff_text_size::TextRange { + self.range + } +} + +impl Mod { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + Mod::Module(node) => node.visit_source_order(visitor), + Mod::Expression(node) => node.visit_source_order(visitor), + } + } +} + +impl Stmt { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + Stmt::FunctionDef(node) => node.visit_source_order(visitor), + Stmt::ClassDef(node) => node.visit_source_order(visitor), + Stmt::Return(node) => node.visit_source_order(visitor), + Stmt::Delete(node) => node.visit_source_order(visitor), + Stmt::TypeAlias(node) => node.visit_source_order(visitor), + Stmt::Assign(node) => node.visit_source_order(visitor), + Stmt::AugAssign(node) => node.visit_source_order(visitor), + Stmt::AnnAssign(node) => node.visit_source_order(visitor), + Stmt::For(node) => node.visit_source_order(visitor), + Stmt::While(node) => node.visit_source_order(visitor), + Stmt::If(node) => node.visit_source_order(visitor), + Stmt::With(node) => node.visit_source_order(visitor), + Stmt::Match(node) => node.visit_source_order(visitor), + Stmt::Raise(node) => node.visit_source_order(visitor), + Stmt::Try(node) => node.visit_source_order(visitor), + Stmt::Assert(node) => node.visit_source_order(visitor), + Stmt::Import(node) => node.visit_source_order(visitor), + Stmt::ImportFrom(node) => node.visit_source_order(visitor), + Stmt::Global(node) => node.visit_source_order(visitor), + Stmt::Nonlocal(node) => node.visit_source_order(visitor), + Stmt::Expr(node) => node.visit_source_order(visitor), + Stmt::Pass(node) => node.visit_source_order(visitor), + Stmt::Break(node) => node.visit_source_order(visitor), + Stmt::Continue(node) => node.visit_source_order(visitor), + Stmt::IpyEscapeCommand(node) => node.visit_source_order(visitor), + } + } +} + +impl Expr { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + Expr::BoolOp(node) => node.visit_source_order(visitor), + Expr::Named(node) => node.visit_source_order(visitor), + Expr::BinOp(node) => node.visit_source_order(visitor), + Expr::UnaryOp(node) => node.visit_source_order(visitor), + Expr::Lambda(node) => node.visit_source_order(visitor), + Expr::If(node) => node.visit_source_order(visitor), + Expr::Dict(node) => node.visit_source_order(visitor), + Expr::Set(node) => node.visit_source_order(visitor), + Expr::ListComp(node) => node.visit_source_order(visitor), + Expr::SetComp(node) => node.visit_source_order(visitor), + Expr::DictComp(node) => node.visit_source_order(visitor), + Expr::Generator(node) => node.visit_source_order(visitor), + Expr::Await(node) => node.visit_source_order(visitor), + Expr::Yield(node) => node.visit_source_order(visitor), + Expr::YieldFrom(node) => node.visit_source_order(visitor), + Expr::Compare(node) => node.visit_source_order(visitor), + Expr::Call(node) => node.visit_source_order(visitor), + Expr::FString(node) => node.visit_source_order(visitor), + Expr::StringLiteral(node) => node.visit_source_order(visitor), + Expr::BytesLiteral(node) => node.visit_source_order(visitor), + Expr::NumberLiteral(node) => node.visit_source_order(visitor), + Expr::BooleanLiteral(node) => node.visit_source_order(visitor), + Expr::NoneLiteral(node) => node.visit_source_order(visitor), + Expr::EllipsisLiteral(node) => node.visit_source_order(visitor), + Expr::Attribute(node) => node.visit_source_order(visitor), + Expr::Subscript(node) => node.visit_source_order(visitor), + Expr::Starred(node) => node.visit_source_order(visitor), + Expr::Name(node) => node.visit_source_order(visitor), + Expr::List(node) => node.visit_source_order(visitor), + Expr::Tuple(node) => node.visit_source_order(visitor), + Expr::Slice(node) => node.visit_source_order(visitor), + Expr::IpyEscapeCommand(node) => node.visit_source_order(visitor), + } + } +} + +impl ExceptHandler { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + ExceptHandler::ExceptHandler(node) => node.visit_source_order(visitor), + } + } +} + +impl FStringElement { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + FStringElement::Expression(node) => node.visit_source_order(visitor), + FStringElement::Literal(node) => node.visit_source_order(visitor), + } + } +} + +impl Pattern { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + Pattern::MatchValue(node) => node.visit_source_order(visitor), + Pattern::MatchSingleton(node) => node.visit_source_order(visitor), + Pattern::MatchSequence(node) => node.visit_source_order(visitor), + Pattern::MatchMapping(node) => node.visit_source_order(visitor), + Pattern::MatchClass(node) => node.visit_source_order(visitor), + Pattern::MatchStar(node) => node.visit_source_order(visitor), + Pattern::MatchAs(node) => node.visit_source_order(visitor), + Pattern::MatchOr(node) => node.visit_source_order(visitor), + } + } +} + +impl TypeParam { + #[allow(unused)] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'a> + ?Sized, + { + match self { + TypeParam::TypeVar(node) => node.visit_source_order(visitor), + TypeParam::TypeVarTuple(node) => node.visit_source_order(visitor), + TypeParam::ParamSpec(node) => node.visit_source_order(visitor), + } + } +} + +/// See also [mod](https://docs.python.org/3/library/ast.html#ast.mod) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum ModRef<'a> { + Module(&'a crate::ModModule), + Expression(&'a crate::ModExpression), +} + +impl<'a> From<&'a Mod> for ModRef<'a> { + fn from(node: &'a Mod) -> Self { + match node { + Mod::Module(node) => ModRef::Module(node), + Mod::Expression(node) => ModRef::Expression(node), + } + } +} + +impl<'a> From<&'a crate::ModModule> for ModRef<'a> { + fn from(node: &'a crate::ModModule) -> Self { + Self::Module(node) + } +} + +impl<'a> From<&'a crate::ModExpression> for ModRef<'a> { + fn from(node: &'a crate::ModExpression) -> Self { + Self::Expression(node) + } +} + +impl ruff_text_size::Ranged for ModRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::Module(node) => node.range(), + Self::Expression(node) => node.range(), + } + } +} + +/// See also [stmt](https://docs.python.org/3/library/ast.html#ast.stmt) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum StmtRef<'a> { + #[is(name = "function_def_stmt")] + FunctionDef(&'a crate::StmtFunctionDef), + #[is(name = "class_def_stmt")] + ClassDef(&'a crate::StmtClassDef), + #[is(name = "return_stmt")] + Return(&'a crate::StmtReturn), + #[is(name = "delete_stmt")] + Delete(&'a crate::StmtDelete), + #[is(name = "type_alias_stmt")] + TypeAlias(&'a crate::StmtTypeAlias), + #[is(name = "assign_stmt")] + Assign(&'a crate::StmtAssign), + #[is(name = "aug_assign_stmt")] + AugAssign(&'a crate::StmtAugAssign), + #[is(name = "ann_assign_stmt")] + AnnAssign(&'a crate::StmtAnnAssign), + #[is(name = "for_stmt")] + For(&'a crate::StmtFor), + #[is(name = "while_stmt")] + While(&'a crate::StmtWhile), + #[is(name = "if_stmt")] + If(&'a crate::StmtIf), + #[is(name = "with_stmt")] + With(&'a crate::StmtWith), + #[is(name = "match_stmt")] + Match(&'a crate::StmtMatch), + #[is(name = "raise_stmt")] + Raise(&'a crate::StmtRaise), + #[is(name = "try_stmt")] + Try(&'a crate::StmtTry), + #[is(name = "assert_stmt")] + Assert(&'a crate::StmtAssert), + #[is(name = "import_stmt")] + Import(&'a crate::StmtImport), + #[is(name = "import_from_stmt")] + ImportFrom(&'a crate::StmtImportFrom), + #[is(name = "global_stmt")] + Global(&'a crate::StmtGlobal), + #[is(name = "nonlocal_stmt")] + Nonlocal(&'a crate::StmtNonlocal), + #[is(name = "expr_stmt")] + Expr(&'a crate::StmtExpr), + #[is(name = "pass_stmt")] + Pass(&'a crate::StmtPass), + #[is(name = "break_stmt")] + Break(&'a crate::StmtBreak), + #[is(name = "continue_stmt")] + Continue(&'a crate::StmtContinue), + #[is(name = "ipy_escape_command_stmt")] + IpyEscapeCommand(&'a crate::StmtIpyEscapeCommand), +} + +impl<'a> From<&'a Stmt> for StmtRef<'a> { + fn from(node: &'a Stmt) -> Self { + match node { + Stmt::FunctionDef(node) => StmtRef::FunctionDef(node), + Stmt::ClassDef(node) => StmtRef::ClassDef(node), + Stmt::Return(node) => StmtRef::Return(node), + Stmt::Delete(node) => StmtRef::Delete(node), + Stmt::TypeAlias(node) => StmtRef::TypeAlias(node), + Stmt::Assign(node) => StmtRef::Assign(node), + Stmt::AugAssign(node) => StmtRef::AugAssign(node), + Stmt::AnnAssign(node) => StmtRef::AnnAssign(node), + Stmt::For(node) => StmtRef::For(node), + Stmt::While(node) => StmtRef::While(node), + Stmt::If(node) => StmtRef::If(node), + Stmt::With(node) => StmtRef::With(node), + Stmt::Match(node) => StmtRef::Match(node), + Stmt::Raise(node) => StmtRef::Raise(node), + Stmt::Try(node) => StmtRef::Try(node), + Stmt::Assert(node) => StmtRef::Assert(node), + Stmt::Import(node) => StmtRef::Import(node), + Stmt::ImportFrom(node) => StmtRef::ImportFrom(node), + Stmt::Global(node) => StmtRef::Global(node), + Stmt::Nonlocal(node) => StmtRef::Nonlocal(node), + Stmt::Expr(node) => StmtRef::Expr(node), + Stmt::Pass(node) => StmtRef::Pass(node), + Stmt::Break(node) => StmtRef::Break(node), + Stmt::Continue(node) => StmtRef::Continue(node), + Stmt::IpyEscapeCommand(node) => StmtRef::IpyEscapeCommand(node), + } + } +} + +impl<'a> From<&'a crate::StmtFunctionDef> for StmtRef<'a> { + fn from(node: &'a crate::StmtFunctionDef) -> Self { + Self::FunctionDef(node) + } +} + +impl<'a> From<&'a crate::StmtClassDef> for StmtRef<'a> { + fn from(node: &'a crate::StmtClassDef) -> Self { + Self::ClassDef(node) + } +} + +impl<'a> From<&'a crate::StmtReturn> for StmtRef<'a> { + fn from(node: &'a crate::StmtReturn) -> Self { + Self::Return(node) + } +} + +impl<'a> From<&'a crate::StmtDelete> for StmtRef<'a> { + fn from(node: &'a crate::StmtDelete) -> Self { + Self::Delete(node) + } +} + +impl<'a> From<&'a crate::StmtTypeAlias> for StmtRef<'a> { + fn from(node: &'a crate::StmtTypeAlias) -> Self { + Self::TypeAlias(node) + } +} + +impl<'a> From<&'a crate::StmtAssign> for StmtRef<'a> { + fn from(node: &'a crate::StmtAssign) -> Self { + Self::Assign(node) + } +} + +impl<'a> From<&'a crate::StmtAugAssign> for StmtRef<'a> { + fn from(node: &'a crate::StmtAugAssign) -> Self { + Self::AugAssign(node) + } +} + +impl<'a> From<&'a crate::StmtAnnAssign> for StmtRef<'a> { + fn from(node: &'a crate::StmtAnnAssign) -> Self { + Self::AnnAssign(node) + } +} + +impl<'a> From<&'a crate::StmtFor> for StmtRef<'a> { + fn from(node: &'a crate::StmtFor) -> Self { + Self::For(node) + } +} + +impl<'a> From<&'a crate::StmtWhile> for StmtRef<'a> { + fn from(node: &'a crate::StmtWhile) -> Self { + Self::While(node) + } +} + +impl<'a> From<&'a crate::StmtIf> for StmtRef<'a> { + fn from(node: &'a crate::StmtIf) -> Self { + Self::If(node) + } +} + +impl<'a> From<&'a crate::StmtWith> for StmtRef<'a> { + fn from(node: &'a crate::StmtWith) -> Self { + Self::With(node) + } +} + +impl<'a> From<&'a crate::StmtMatch> for StmtRef<'a> { + fn from(node: &'a crate::StmtMatch) -> Self { + Self::Match(node) + } +} + +impl<'a> From<&'a crate::StmtRaise> for StmtRef<'a> { + fn from(node: &'a crate::StmtRaise) -> Self { + Self::Raise(node) + } +} + +impl<'a> From<&'a crate::StmtTry> for StmtRef<'a> { + fn from(node: &'a crate::StmtTry) -> Self { + Self::Try(node) + } +} + +impl<'a> From<&'a crate::StmtAssert> for StmtRef<'a> { + fn from(node: &'a crate::StmtAssert) -> Self { + Self::Assert(node) + } +} + +impl<'a> From<&'a crate::StmtImport> for StmtRef<'a> { + fn from(node: &'a crate::StmtImport) -> Self { + Self::Import(node) + } +} + +impl<'a> From<&'a crate::StmtImportFrom> for StmtRef<'a> { + fn from(node: &'a crate::StmtImportFrom) -> Self { + Self::ImportFrom(node) + } +} + +impl<'a> From<&'a crate::StmtGlobal> for StmtRef<'a> { + fn from(node: &'a crate::StmtGlobal) -> Self { + Self::Global(node) + } +} + +impl<'a> From<&'a crate::StmtNonlocal> for StmtRef<'a> { + fn from(node: &'a crate::StmtNonlocal) -> Self { + Self::Nonlocal(node) + } +} + +impl<'a> From<&'a crate::StmtExpr> for StmtRef<'a> { + fn from(node: &'a crate::StmtExpr) -> Self { + Self::Expr(node) + } +} + +impl<'a> From<&'a crate::StmtPass> for StmtRef<'a> { + fn from(node: &'a crate::StmtPass) -> Self { + Self::Pass(node) + } +} + +impl<'a> From<&'a crate::StmtBreak> for StmtRef<'a> { + fn from(node: &'a crate::StmtBreak) -> Self { + Self::Break(node) + } +} + +impl<'a> From<&'a crate::StmtContinue> for StmtRef<'a> { + fn from(node: &'a crate::StmtContinue) -> Self { + Self::Continue(node) + } +} + +impl<'a> From<&'a crate::StmtIpyEscapeCommand> for StmtRef<'a> { + fn from(node: &'a crate::StmtIpyEscapeCommand) -> Self { + Self::IpyEscapeCommand(node) + } +} + +impl ruff_text_size::Ranged for StmtRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::FunctionDef(node) => node.range(), + Self::ClassDef(node) => node.range(), + Self::Return(node) => node.range(), + Self::Delete(node) => node.range(), + Self::TypeAlias(node) => node.range(), + Self::Assign(node) => node.range(), + Self::AugAssign(node) => node.range(), + Self::AnnAssign(node) => node.range(), + Self::For(node) => node.range(), + Self::While(node) => node.range(), + Self::If(node) => node.range(), + Self::With(node) => node.range(), + Self::Match(node) => node.range(), + Self::Raise(node) => node.range(), + Self::Try(node) => node.range(), + Self::Assert(node) => node.range(), + Self::Import(node) => node.range(), + Self::ImportFrom(node) => node.range(), + Self::Global(node) => node.range(), + Self::Nonlocal(node) => node.range(), + Self::Expr(node) => node.range(), + Self::Pass(node) => node.range(), + Self::Break(node) => node.range(), + Self::Continue(node) => node.range(), + Self::IpyEscapeCommand(node) => node.range(), + } + } +} + +/// See also [expr](https://docs.python.org/3/library/ast.html#ast.expr) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum ExprRef<'a> { + #[is(name = "bool_op_expr")] + BoolOp(&'a crate::ExprBoolOp), + #[is(name = "named_expr")] + Named(&'a crate::ExprNamed), + #[is(name = "bin_op_expr")] + BinOp(&'a crate::ExprBinOp), + #[is(name = "unary_op_expr")] + UnaryOp(&'a crate::ExprUnaryOp), + #[is(name = "lambda_expr")] + Lambda(&'a crate::ExprLambda), + #[is(name = "if_expr")] + If(&'a crate::ExprIf), + #[is(name = "dict_expr")] + Dict(&'a crate::ExprDict), + #[is(name = "set_expr")] + Set(&'a crate::ExprSet), + #[is(name = "list_comp_expr")] + ListComp(&'a crate::ExprListComp), + #[is(name = "set_comp_expr")] + SetComp(&'a crate::ExprSetComp), + #[is(name = "dict_comp_expr")] + DictComp(&'a crate::ExprDictComp), + #[is(name = "generator_expr")] + Generator(&'a crate::ExprGenerator), + #[is(name = "await_expr")] + Await(&'a crate::ExprAwait), + #[is(name = "yield_expr")] + Yield(&'a crate::ExprYield), + #[is(name = "yield_from_expr")] + YieldFrom(&'a crate::ExprYieldFrom), + #[is(name = "compare_expr")] + Compare(&'a crate::ExprCompare), + #[is(name = "call_expr")] + Call(&'a crate::ExprCall), + #[is(name = "f_string_expr")] + FString(&'a crate::ExprFString), + #[is(name = "string_literal_expr")] + StringLiteral(&'a crate::ExprStringLiteral), + #[is(name = "bytes_literal_expr")] + BytesLiteral(&'a crate::ExprBytesLiteral), + #[is(name = "number_literal_expr")] + NumberLiteral(&'a crate::ExprNumberLiteral), + #[is(name = "boolean_literal_expr")] + BooleanLiteral(&'a crate::ExprBooleanLiteral), + #[is(name = "none_literal_expr")] + NoneLiteral(&'a crate::ExprNoneLiteral), + #[is(name = "ellipsis_literal_expr")] + EllipsisLiteral(&'a crate::ExprEllipsisLiteral), + #[is(name = "attribute_expr")] + Attribute(&'a crate::ExprAttribute), + #[is(name = "subscript_expr")] + Subscript(&'a crate::ExprSubscript), + #[is(name = "starred_expr")] + Starred(&'a crate::ExprStarred), + #[is(name = "name_expr")] + Name(&'a crate::ExprName), + #[is(name = "list_expr")] + List(&'a crate::ExprList), + #[is(name = "tuple_expr")] + Tuple(&'a crate::ExprTuple), + #[is(name = "slice_expr")] + Slice(&'a crate::ExprSlice), + #[is(name = "ipy_escape_command_expr")] + IpyEscapeCommand(&'a crate::ExprIpyEscapeCommand), +} + +impl<'a> From<&'a Expr> for ExprRef<'a> { + fn from(node: &'a Expr) -> Self { + match node { + Expr::BoolOp(node) => ExprRef::BoolOp(node), + Expr::Named(node) => ExprRef::Named(node), + Expr::BinOp(node) => ExprRef::BinOp(node), + Expr::UnaryOp(node) => ExprRef::UnaryOp(node), + Expr::Lambda(node) => ExprRef::Lambda(node), + Expr::If(node) => ExprRef::If(node), + Expr::Dict(node) => ExprRef::Dict(node), + Expr::Set(node) => ExprRef::Set(node), + Expr::ListComp(node) => ExprRef::ListComp(node), + Expr::SetComp(node) => ExprRef::SetComp(node), + Expr::DictComp(node) => ExprRef::DictComp(node), + Expr::Generator(node) => ExprRef::Generator(node), + Expr::Await(node) => ExprRef::Await(node), + Expr::Yield(node) => ExprRef::Yield(node), + Expr::YieldFrom(node) => ExprRef::YieldFrom(node), + Expr::Compare(node) => ExprRef::Compare(node), + Expr::Call(node) => ExprRef::Call(node), + Expr::FString(node) => ExprRef::FString(node), + Expr::StringLiteral(node) => ExprRef::StringLiteral(node), + Expr::BytesLiteral(node) => ExprRef::BytesLiteral(node), + Expr::NumberLiteral(node) => ExprRef::NumberLiteral(node), + Expr::BooleanLiteral(node) => ExprRef::BooleanLiteral(node), + Expr::NoneLiteral(node) => ExprRef::NoneLiteral(node), + Expr::EllipsisLiteral(node) => ExprRef::EllipsisLiteral(node), + Expr::Attribute(node) => ExprRef::Attribute(node), + Expr::Subscript(node) => ExprRef::Subscript(node), + Expr::Starred(node) => ExprRef::Starred(node), + Expr::Name(node) => ExprRef::Name(node), + Expr::List(node) => ExprRef::List(node), + Expr::Tuple(node) => ExprRef::Tuple(node), + Expr::Slice(node) => ExprRef::Slice(node), + Expr::IpyEscapeCommand(node) => ExprRef::IpyEscapeCommand(node), + } + } +} + +impl<'a> From<&'a crate::ExprBoolOp> for ExprRef<'a> { + fn from(node: &'a crate::ExprBoolOp) -> Self { + Self::BoolOp(node) + } +} + +impl<'a> From<&'a crate::ExprNamed> for ExprRef<'a> { + fn from(node: &'a crate::ExprNamed) -> Self { + Self::Named(node) + } +} + +impl<'a> From<&'a crate::ExprBinOp> for ExprRef<'a> { + fn from(node: &'a crate::ExprBinOp) -> Self { + Self::BinOp(node) + } +} + +impl<'a> From<&'a crate::ExprUnaryOp> for ExprRef<'a> { + fn from(node: &'a crate::ExprUnaryOp) -> Self { + Self::UnaryOp(node) + } +} + +impl<'a> From<&'a crate::ExprLambda> for ExprRef<'a> { + fn from(node: &'a crate::ExprLambda) -> Self { + Self::Lambda(node) + } +} + +impl<'a> From<&'a crate::ExprIf> for ExprRef<'a> { + fn from(node: &'a crate::ExprIf) -> Self { + Self::If(node) + } +} + +impl<'a> From<&'a crate::ExprDict> for ExprRef<'a> { + fn from(node: &'a crate::ExprDict) -> Self { + Self::Dict(node) + } +} + +impl<'a> From<&'a crate::ExprSet> for ExprRef<'a> { + fn from(node: &'a crate::ExprSet) -> Self { + Self::Set(node) + } +} + +impl<'a> From<&'a crate::ExprListComp> for ExprRef<'a> { + fn from(node: &'a crate::ExprListComp) -> Self { + Self::ListComp(node) + } +} + +impl<'a> From<&'a crate::ExprSetComp> for ExprRef<'a> { + fn from(node: &'a crate::ExprSetComp) -> Self { + Self::SetComp(node) + } +} + +impl<'a> From<&'a crate::ExprDictComp> for ExprRef<'a> { + fn from(node: &'a crate::ExprDictComp) -> Self { + Self::DictComp(node) + } +} + +impl<'a> From<&'a crate::ExprGenerator> for ExprRef<'a> { + fn from(node: &'a crate::ExprGenerator) -> Self { + Self::Generator(node) + } +} + +impl<'a> From<&'a crate::ExprAwait> for ExprRef<'a> { + fn from(node: &'a crate::ExprAwait) -> Self { + Self::Await(node) + } +} + +impl<'a> From<&'a crate::ExprYield> for ExprRef<'a> { + fn from(node: &'a crate::ExprYield) -> Self { + Self::Yield(node) + } +} + +impl<'a> From<&'a crate::ExprYieldFrom> for ExprRef<'a> { + fn from(node: &'a crate::ExprYieldFrom) -> Self { + Self::YieldFrom(node) + } +} + +impl<'a> From<&'a crate::ExprCompare> for ExprRef<'a> { + fn from(node: &'a crate::ExprCompare) -> Self { + Self::Compare(node) + } +} + +impl<'a> From<&'a crate::ExprCall> for ExprRef<'a> { + fn from(node: &'a crate::ExprCall) -> Self { + Self::Call(node) + } +} + +impl<'a> From<&'a crate::ExprFString> for ExprRef<'a> { + fn from(node: &'a crate::ExprFString) -> Self { + Self::FString(node) + } +} + +impl<'a> From<&'a crate::ExprStringLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprStringLiteral) -> Self { + Self::StringLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprBytesLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprBytesLiteral) -> Self { + Self::BytesLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprNumberLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprNumberLiteral) -> Self { + Self::NumberLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprBooleanLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprBooleanLiteral) -> Self { + Self::BooleanLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprNoneLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprNoneLiteral) -> Self { + Self::NoneLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprEllipsisLiteral> for ExprRef<'a> { + fn from(node: &'a crate::ExprEllipsisLiteral) -> Self { + Self::EllipsisLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprAttribute> for ExprRef<'a> { + fn from(node: &'a crate::ExprAttribute) -> Self { + Self::Attribute(node) + } +} + +impl<'a> From<&'a crate::ExprSubscript> for ExprRef<'a> { + fn from(node: &'a crate::ExprSubscript) -> Self { + Self::Subscript(node) + } +} + +impl<'a> From<&'a crate::ExprStarred> for ExprRef<'a> { + fn from(node: &'a crate::ExprStarred) -> Self { + Self::Starred(node) + } +} + +impl<'a> From<&'a crate::ExprName> for ExprRef<'a> { + fn from(node: &'a crate::ExprName) -> Self { + Self::Name(node) + } +} + +impl<'a> From<&'a crate::ExprList> for ExprRef<'a> { + fn from(node: &'a crate::ExprList) -> Self { + Self::List(node) + } +} + +impl<'a> From<&'a crate::ExprTuple> for ExprRef<'a> { + fn from(node: &'a crate::ExprTuple) -> Self { + Self::Tuple(node) + } +} + +impl<'a> From<&'a crate::ExprSlice> for ExprRef<'a> { + fn from(node: &'a crate::ExprSlice) -> Self { + Self::Slice(node) + } +} + +impl<'a> From<&'a crate::ExprIpyEscapeCommand> for ExprRef<'a> { + fn from(node: &'a crate::ExprIpyEscapeCommand) -> Self { + Self::IpyEscapeCommand(node) + } +} + +impl ruff_text_size::Ranged for ExprRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::BoolOp(node) => node.range(), + Self::Named(node) => node.range(), + Self::BinOp(node) => node.range(), + Self::UnaryOp(node) => node.range(), + Self::Lambda(node) => node.range(), + Self::If(node) => node.range(), + Self::Dict(node) => node.range(), + Self::Set(node) => node.range(), + Self::ListComp(node) => node.range(), + Self::SetComp(node) => node.range(), + Self::DictComp(node) => node.range(), + Self::Generator(node) => node.range(), + Self::Await(node) => node.range(), + Self::Yield(node) => node.range(), + Self::YieldFrom(node) => node.range(), + Self::Compare(node) => node.range(), + Self::Call(node) => node.range(), + Self::FString(node) => node.range(), + Self::StringLiteral(node) => node.range(), + Self::BytesLiteral(node) => node.range(), + Self::NumberLiteral(node) => node.range(), + Self::BooleanLiteral(node) => node.range(), + Self::NoneLiteral(node) => node.range(), + Self::EllipsisLiteral(node) => node.range(), + Self::Attribute(node) => node.range(), + Self::Subscript(node) => node.range(), + Self::Starred(node) => node.range(), + Self::Name(node) => node.range(), + Self::List(node) => node.range(), + Self::Tuple(node) => node.range(), + Self::Slice(node) => node.range(), + Self::IpyEscapeCommand(node) => node.range(), + } + } +} + +/// See also [excepthandler](https://docs.python.org/3/library/ast.html#ast.excepthandler) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum ExceptHandlerRef<'a> { + ExceptHandler(&'a crate::ExceptHandlerExceptHandler), +} + +impl<'a> From<&'a ExceptHandler> for ExceptHandlerRef<'a> { + fn from(node: &'a ExceptHandler) -> Self { + match node { + ExceptHandler::ExceptHandler(node) => ExceptHandlerRef::ExceptHandler(node), + } + } +} + +impl<'a> From<&'a crate::ExceptHandlerExceptHandler> for ExceptHandlerRef<'a> { + fn from(node: &'a crate::ExceptHandlerExceptHandler) -> Self { + Self::ExceptHandler(node) + } +} + +impl ruff_text_size::Ranged for ExceptHandlerRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::ExceptHandler(node) => node.range(), + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum FStringElementRef<'a> { + Expression(&'a crate::FStringExpressionElement), + Literal(&'a crate::FStringLiteralElement), +} + +impl<'a> From<&'a FStringElement> for FStringElementRef<'a> { + fn from(node: &'a FStringElement) -> Self { + match node { + FStringElement::Expression(node) => FStringElementRef::Expression(node), + FStringElement::Literal(node) => FStringElementRef::Literal(node), + } + } +} + +impl<'a> From<&'a crate::FStringExpressionElement> for FStringElementRef<'a> { + fn from(node: &'a crate::FStringExpressionElement) -> Self { + Self::Expression(node) + } +} + +impl<'a> From<&'a crate::FStringLiteralElement> for FStringElementRef<'a> { + fn from(node: &'a crate::FStringLiteralElement) -> Self { + Self::Literal(node) + } +} + +impl ruff_text_size::Ranged for FStringElementRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::Expression(node) => node.range(), + Self::Literal(node) => node.range(), + } + } +} + +/// See also [pattern](https://docs.python.org/3/library/ast.html#ast.pattern) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum PatternRef<'a> { + MatchValue(&'a crate::PatternMatchValue), + MatchSingleton(&'a crate::PatternMatchSingleton), + MatchSequence(&'a crate::PatternMatchSequence), + MatchMapping(&'a crate::PatternMatchMapping), + MatchClass(&'a crate::PatternMatchClass), + MatchStar(&'a crate::PatternMatchStar), + MatchAs(&'a crate::PatternMatchAs), + MatchOr(&'a crate::PatternMatchOr), +} + +impl<'a> From<&'a Pattern> for PatternRef<'a> { + fn from(node: &'a Pattern) -> Self { + match node { + Pattern::MatchValue(node) => PatternRef::MatchValue(node), + Pattern::MatchSingleton(node) => PatternRef::MatchSingleton(node), + Pattern::MatchSequence(node) => PatternRef::MatchSequence(node), + Pattern::MatchMapping(node) => PatternRef::MatchMapping(node), + Pattern::MatchClass(node) => PatternRef::MatchClass(node), + Pattern::MatchStar(node) => PatternRef::MatchStar(node), + Pattern::MatchAs(node) => PatternRef::MatchAs(node), + Pattern::MatchOr(node) => PatternRef::MatchOr(node), + } + } +} + +impl<'a> From<&'a crate::PatternMatchValue> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchValue) -> Self { + Self::MatchValue(node) + } +} + +impl<'a> From<&'a crate::PatternMatchSingleton> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchSingleton) -> Self { + Self::MatchSingleton(node) + } +} + +impl<'a> From<&'a crate::PatternMatchSequence> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchSequence) -> Self { + Self::MatchSequence(node) + } +} + +impl<'a> From<&'a crate::PatternMatchMapping> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchMapping) -> Self { + Self::MatchMapping(node) + } +} + +impl<'a> From<&'a crate::PatternMatchClass> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchClass) -> Self { + Self::MatchClass(node) + } +} + +impl<'a> From<&'a crate::PatternMatchStar> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchStar) -> Self { + Self::MatchStar(node) + } +} + +impl<'a> From<&'a crate::PatternMatchAs> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchAs) -> Self { + Self::MatchAs(node) + } +} + +impl<'a> From<&'a crate::PatternMatchOr> for PatternRef<'a> { + fn from(node: &'a crate::PatternMatchOr) -> Self { + Self::MatchOr(node) + } +} + +impl ruff_text_size::Ranged for PatternRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::MatchValue(node) => node.range(), + Self::MatchSingleton(node) => node.range(), + Self::MatchSequence(node) => node.range(), + Self::MatchMapping(node) => node.range(), + Self::MatchClass(node) => node.range(), + Self::MatchStar(node) => node.range(), + Self::MatchAs(node) => node.range(), + Self::MatchOr(node) => node.range(), + } + } +} + +/// See also [type_param](https://docs.python.org/3/library/ast.html#ast.type_param) +#[derive(Clone, Copy, Debug, PartialEq, is_macro::Is)] +pub enum TypeParamRef<'a> { + TypeVar(&'a crate::TypeParamTypeVar), + TypeVarTuple(&'a crate::TypeParamTypeVarTuple), + ParamSpec(&'a crate::TypeParamParamSpec), +} + +impl<'a> From<&'a TypeParam> for TypeParamRef<'a> { + fn from(node: &'a TypeParam) -> Self { + match node { + TypeParam::TypeVar(node) => TypeParamRef::TypeVar(node), + TypeParam::TypeVarTuple(node) => TypeParamRef::TypeVarTuple(node), + TypeParam::ParamSpec(node) => TypeParamRef::ParamSpec(node), + } + } +} + +impl<'a> From<&'a crate::TypeParamTypeVar> for TypeParamRef<'a> { + fn from(node: &'a crate::TypeParamTypeVar) -> Self { + Self::TypeVar(node) + } +} + +impl<'a> From<&'a crate::TypeParamTypeVarTuple> for TypeParamRef<'a> { + fn from(node: &'a crate::TypeParamTypeVarTuple) -> Self { + Self::TypeVarTuple(node) + } +} + +impl<'a> From<&'a crate::TypeParamParamSpec> for TypeParamRef<'a> { + fn from(node: &'a crate::TypeParamParamSpec) -> Self { + Self::ParamSpec(node) + } +} + +impl ruff_text_size::Ranged for TypeParamRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + Self::TypeVar(node) => node.range(), + Self::TypeVarTuple(node) => node.range(), + Self::ParamSpec(node) => node.range(), + } + } +} + +#[derive(Copy, Clone, Debug, is_macro::Is, PartialEq)] +pub enum AnyNodeRef<'a> { + ModModule(&'a crate::ModModule), + ModExpression(&'a crate::ModExpression), + StmtFunctionDef(&'a crate::StmtFunctionDef), + StmtClassDef(&'a crate::StmtClassDef), + StmtReturn(&'a crate::StmtReturn), + StmtDelete(&'a crate::StmtDelete), + StmtTypeAlias(&'a crate::StmtTypeAlias), + StmtAssign(&'a crate::StmtAssign), + StmtAugAssign(&'a crate::StmtAugAssign), + StmtAnnAssign(&'a crate::StmtAnnAssign), + StmtFor(&'a crate::StmtFor), + StmtWhile(&'a crate::StmtWhile), + StmtIf(&'a crate::StmtIf), + StmtWith(&'a crate::StmtWith), + StmtMatch(&'a crate::StmtMatch), + StmtRaise(&'a crate::StmtRaise), + StmtTry(&'a crate::StmtTry), + StmtAssert(&'a crate::StmtAssert), + StmtImport(&'a crate::StmtImport), + StmtImportFrom(&'a crate::StmtImportFrom), + StmtGlobal(&'a crate::StmtGlobal), + StmtNonlocal(&'a crate::StmtNonlocal), + StmtExpr(&'a crate::StmtExpr), + StmtPass(&'a crate::StmtPass), + StmtBreak(&'a crate::StmtBreak), + StmtContinue(&'a crate::StmtContinue), + StmtIpyEscapeCommand(&'a crate::StmtIpyEscapeCommand), + ExprBoolOp(&'a crate::ExprBoolOp), + ExprNamed(&'a crate::ExprNamed), + ExprBinOp(&'a crate::ExprBinOp), + ExprUnaryOp(&'a crate::ExprUnaryOp), + ExprLambda(&'a crate::ExprLambda), + ExprIf(&'a crate::ExprIf), + ExprDict(&'a crate::ExprDict), + ExprSet(&'a crate::ExprSet), + ExprListComp(&'a crate::ExprListComp), + ExprSetComp(&'a crate::ExprSetComp), + ExprDictComp(&'a crate::ExprDictComp), + ExprGenerator(&'a crate::ExprGenerator), + ExprAwait(&'a crate::ExprAwait), + ExprYield(&'a crate::ExprYield), + ExprYieldFrom(&'a crate::ExprYieldFrom), + ExprCompare(&'a crate::ExprCompare), + ExprCall(&'a crate::ExprCall), + ExprFString(&'a crate::ExprFString), + ExprStringLiteral(&'a crate::ExprStringLiteral), + ExprBytesLiteral(&'a crate::ExprBytesLiteral), + ExprNumberLiteral(&'a crate::ExprNumberLiteral), + ExprBooleanLiteral(&'a crate::ExprBooleanLiteral), + ExprNoneLiteral(&'a crate::ExprNoneLiteral), + ExprEllipsisLiteral(&'a crate::ExprEllipsisLiteral), + ExprAttribute(&'a crate::ExprAttribute), + ExprSubscript(&'a crate::ExprSubscript), + ExprStarred(&'a crate::ExprStarred), + ExprName(&'a crate::ExprName), + ExprList(&'a crate::ExprList), + ExprTuple(&'a crate::ExprTuple), + ExprSlice(&'a crate::ExprSlice), + ExprIpyEscapeCommand(&'a crate::ExprIpyEscapeCommand), + ExceptHandlerExceptHandler(&'a crate::ExceptHandlerExceptHandler), + FStringExpressionElement(&'a crate::FStringExpressionElement), + FStringLiteralElement(&'a crate::FStringLiteralElement), + PatternMatchValue(&'a crate::PatternMatchValue), + PatternMatchSingleton(&'a crate::PatternMatchSingleton), + PatternMatchSequence(&'a crate::PatternMatchSequence), + PatternMatchMapping(&'a crate::PatternMatchMapping), + PatternMatchClass(&'a crate::PatternMatchClass), + PatternMatchStar(&'a crate::PatternMatchStar), + PatternMatchAs(&'a crate::PatternMatchAs), + PatternMatchOr(&'a crate::PatternMatchOr), + TypeParamTypeVar(&'a crate::TypeParamTypeVar), + TypeParamTypeVarTuple(&'a crate::TypeParamTypeVarTuple), + TypeParamParamSpec(&'a crate::TypeParamParamSpec), + FStringFormatSpec(&'a crate::FStringFormatSpec), + PatternArguments(&'a crate::PatternArguments), + PatternKeyword(&'a crate::PatternKeyword), + Comprehension(&'a crate::Comprehension), + Arguments(&'a crate::Arguments), + Parameters(&'a crate::Parameters), + Parameter(&'a crate::Parameter), + ParameterWithDefault(&'a crate::ParameterWithDefault), + Keyword(&'a crate::Keyword), + Alias(&'a crate::Alias), + WithItem(&'a crate::WithItem), + MatchCase(&'a crate::MatchCase), + Decorator(&'a crate::Decorator), + ElifElseClause(&'a crate::ElifElseClause), + TypeParams(&'a crate::TypeParams), + FString(&'a crate::FString), + StringLiteral(&'a crate::StringLiteral), + BytesLiteral(&'a crate::BytesLiteral), + Identifier(&'a crate::Identifier), +} + +impl<'a> From<&'a Mod> for AnyNodeRef<'a> { + fn from(node: &'a Mod) -> AnyNodeRef<'a> { + match node { + Mod::Module(node) => AnyNodeRef::ModModule(node), + Mod::Expression(node) => AnyNodeRef::ModExpression(node), + } + } +} + +impl<'a> From<ModRef<'a>> for AnyNodeRef<'a> { + fn from(node: ModRef<'a>) -> AnyNodeRef<'a> { + match node { + ModRef::Module(node) => AnyNodeRef::ModModule(node), + ModRef::Expression(node) => AnyNodeRef::ModExpression(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_mod_ref(self) -> Option<ModRef<'a>> { + match self { + Self::ModModule(node) => Some(ModRef::Module(node)), + Self::ModExpression(node) => Some(ModRef::Expression(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a Stmt> for AnyNodeRef<'a> { + fn from(node: &'a Stmt) -> AnyNodeRef<'a> { + match node { + Stmt::FunctionDef(node) => AnyNodeRef::StmtFunctionDef(node), + Stmt::ClassDef(node) => AnyNodeRef::StmtClassDef(node), + Stmt::Return(node) => AnyNodeRef::StmtReturn(node), + Stmt::Delete(node) => AnyNodeRef::StmtDelete(node), + Stmt::TypeAlias(node) => AnyNodeRef::StmtTypeAlias(node), + Stmt::Assign(node) => AnyNodeRef::StmtAssign(node), + Stmt::AugAssign(node) => AnyNodeRef::StmtAugAssign(node), + Stmt::AnnAssign(node) => AnyNodeRef::StmtAnnAssign(node), + Stmt::For(node) => AnyNodeRef::StmtFor(node), + Stmt::While(node) => AnyNodeRef::StmtWhile(node), + Stmt::If(node) => AnyNodeRef::StmtIf(node), + Stmt::With(node) => AnyNodeRef::StmtWith(node), + Stmt::Match(node) => AnyNodeRef::StmtMatch(node), + Stmt::Raise(node) => AnyNodeRef::StmtRaise(node), + Stmt::Try(node) => AnyNodeRef::StmtTry(node), + Stmt::Assert(node) => AnyNodeRef::StmtAssert(node), + Stmt::Import(node) => AnyNodeRef::StmtImport(node), + Stmt::ImportFrom(node) => AnyNodeRef::StmtImportFrom(node), + Stmt::Global(node) => AnyNodeRef::StmtGlobal(node), + Stmt::Nonlocal(node) => AnyNodeRef::StmtNonlocal(node), + Stmt::Expr(node) => AnyNodeRef::StmtExpr(node), + Stmt::Pass(node) => AnyNodeRef::StmtPass(node), + Stmt::Break(node) => AnyNodeRef::StmtBreak(node), + Stmt::Continue(node) => AnyNodeRef::StmtContinue(node), + Stmt::IpyEscapeCommand(node) => AnyNodeRef::StmtIpyEscapeCommand(node), + } + } +} + +impl<'a> From<StmtRef<'a>> for AnyNodeRef<'a> { + fn from(node: StmtRef<'a>) -> AnyNodeRef<'a> { + match node { + StmtRef::FunctionDef(node) => AnyNodeRef::StmtFunctionDef(node), + StmtRef::ClassDef(node) => AnyNodeRef::StmtClassDef(node), + StmtRef::Return(node) => AnyNodeRef::StmtReturn(node), + StmtRef::Delete(node) => AnyNodeRef::StmtDelete(node), + StmtRef::TypeAlias(node) => AnyNodeRef::StmtTypeAlias(node), + StmtRef::Assign(node) => AnyNodeRef::StmtAssign(node), + StmtRef::AugAssign(node) => AnyNodeRef::StmtAugAssign(node), + StmtRef::AnnAssign(node) => AnyNodeRef::StmtAnnAssign(node), + StmtRef::For(node) => AnyNodeRef::StmtFor(node), + StmtRef::While(node) => AnyNodeRef::StmtWhile(node), + StmtRef::If(node) => AnyNodeRef::StmtIf(node), + StmtRef::With(node) => AnyNodeRef::StmtWith(node), + StmtRef::Match(node) => AnyNodeRef::StmtMatch(node), + StmtRef::Raise(node) => AnyNodeRef::StmtRaise(node), + StmtRef::Try(node) => AnyNodeRef::StmtTry(node), + StmtRef::Assert(node) => AnyNodeRef::StmtAssert(node), + StmtRef::Import(node) => AnyNodeRef::StmtImport(node), + StmtRef::ImportFrom(node) => AnyNodeRef::StmtImportFrom(node), + StmtRef::Global(node) => AnyNodeRef::StmtGlobal(node), + StmtRef::Nonlocal(node) => AnyNodeRef::StmtNonlocal(node), + StmtRef::Expr(node) => AnyNodeRef::StmtExpr(node), + StmtRef::Pass(node) => AnyNodeRef::StmtPass(node), + StmtRef::Break(node) => AnyNodeRef::StmtBreak(node), + StmtRef::Continue(node) => AnyNodeRef::StmtContinue(node), + StmtRef::IpyEscapeCommand(node) => AnyNodeRef::StmtIpyEscapeCommand(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_stmt_ref(self) -> Option<StmtRef<'a>> { + match self { + Self::StmtFunctionDef(node) => Some(StmtRef::FunctionDef(node)), + Self::StmtClassDef(node) => Some(StmtRef::ClassDef(node)), + Self::StmtReturn(node) => Some(StmtRef::Return(node)), + Self::StmtDelete(node) => Some(StmtRef::Delete(node)), + Self::StmtTypeAlias(node) => Some(StmtRef::TypeAlias(node)), + Self::StmtAssign(node) => Some(StmtRef::Assign(node)), + Self::StmtAugAssign(node) => Some(StmtRef::AugAssign(node)), + Self::StmtAnnAssign(node) => Some(StmtRef::AnnAssign(node)), + Self::StmtFor(node) => Some(StmtRef::For(node)), + Self::StmtWhile(node) => Some(StmtRef::While(node)), + Self::StmtIf(node) => Some(StmtRef::If(node)), + Self::StmtWith(node) => Some(StmtRef::With(node)), + Self::StmtMatch(node) => Some(StmtRef::Match(node)), + Self::StmtRaise(node) => Some(StmtRef::Raise(node)), + Self::StmtTry(node) => Some(StmtRef::Try(node)), + Self::StmtAssert(node) => Some(StmtRef::Assert(node)), + Self::StmtImport(node) => Some(StmtRef::Import(node)), + Self::StmtImportFrom(node) => Some(StmtRef::ImportFrom(node)), + Self::StmtGlobal(node) => Some(StmtRef::Global(node)), + Self::StmtNonlocal(node) => Some(StmtRef::Nonlocal(node)), + Self::StmtExpr(node) => Some(StmtRef::Expr(node)), + Self::StmtPass(node) => Some(StmtRef::Pass(node)), + Self::StmtBreak(node) => Some(StmtRef::Break(node)), + Self::StmtContinue(node) => Some(StmtRef::Continue(node)), + Self::StmtIpyEscapeCommand(node) => Some(StmtRef::IpyEscapeCommand(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a Expr> for AnyNodeRef<'a> { + fn from(node: &'a Expr) -> AnyNodeRef<'a> { + match node { + Expr::BoolOp(node) => AnyNodeRef::ExprBoolOp(node), + Expr::Named(node) => AnyNodeRef::ExprNamed(node), + Expr::BinOp(node) => AnyNodeRef::ExprBinOp(node), + Expr::UnaryOp(node) => AnyNodeRef::ExprUnaryOp(node), + Expr::Lambda(node) => AnyNodeRef::ExprLambda(node), + Expr::If(node) => AnyNodeRef::ExprIf(node), + Expr::Dict(node) => AnyNodeRef::ExprDict(node), + Expr::Set(node) => AnyNodeRef::ExprSet(node), + Expr::ListComp(node) => AnyNodeRef::ExprListComp(node), + Expr::SetComp(node) => AnyNodeRef::ExprSetComp(node), + Expr::DictComp(node) => AnyNodeRef::ExprDictComp(node), + Expr::Generator(node) => AnyNodeRef::ExprGenerator(node), + Expr::Await(node) => AnyNodeRef::ExprAwait(node), + Expr::Yield(node) => AnyNodeRef::ExprYield(node), + Expr::YieldFrom(node) => AnyNodeRef::ExprYieldFrom(node), + Expr::Compare(node) => AnyNodeRef::ExprCompare(node), + Expr::Call(node) => AnyNodeRef::ExprCall(node), + Expr::FString(node) => AnyNodeRef::ExprFString(node), + Expr::StringLiteral(node) => AnyNodeRef::ExprStringLiteral(node), + Expr::BytesLiteral(node) => AnyNodeRef::ExprBytesLiteral(node), + Expr::NumberLiteral(node) => AnyNodeRef::ExprNumberLiteral(node), + Expr::BooleanLiteral(node) => AnyNodeRef::ExprBooleanLiteral(node), + Expr::NoneLiteral(node) => AnyNodeRef::ExprNoneLiteral(node), + Expr::EllipsisLiteral(node) => AnyNodeRef::ExprEllipsisLiteral(node), + Expr::Attribute(node) => AnyNodeRef::ExprAttribute(node), + Expr::Subscript(node) => AnyNodeRef::ExprSubscript(node), + Expr::Starred(node) => AnyNodeRef::ExprStarred(node), + Expr::Name(node) => AnyNodeRef::ExprName(node), + Expr::List(node) => AnyNodeRef::ExprList(node), + Expr::Tuple(node) => AnyNodeRef::ExprTuple(node), + Expr::Slice(node) => AnyNodeRef::ExprSlice(node), + Expr::IpyEscapeCommand(node) => AnyNodeRef::ExprIpyEscapeCommand(node), + } + } +} + +impl<'a> From<ExprRef<'a>> for AnyNodeRef<'a> { + fn from(node: ExprRef<'a>) -> AnyNodeRef<'a> { + match node { + ExprRef::BoolOp(node) => AnyNodeRef::ExprBoolOp(node), + ExprRef::Named(node) => AnyNodeRef::ExprNamed(node), + ExprRef::BinOp(node) => AnyNodeRef::ExprBinOp(node), + ExprRef::UnaryOp(node) => AnyNodeRef::ExprUnaryOp(node), + ExprRef::Lambda(node) => AnyNodeRef::ExprLambda(node), + ExprRef::If(node) => AnyNodeRef::ExprIf(node), + ExprRef::Dict(node) => AnyNodeRef::ExprDict(node), + ExprRef::Set(node) => AnyNodeRef::ExprSet(node), + ExprRef::ListComp(node) => AnyNodeRef::ExprListComp(node), + ExprRef::SetComp(node) => AnyNodeRef::ExprSetComp(node), + ExprRef::DictComp(node) => AnyNodeRef::ExprDictComp(node), + ExprRef::Generator(node) => AnyNodeRef::ExprGenerator(node), + ExprRef::Await(node) => AnyNodeRef::ExprAwait(node), + ExprRef::Yield(node) => AnyNodeRef::ExprYield(node), + ExprRef::YieldFrom(node) => AnyNodeRef::ExprYieldFrom(node), + ExprRef::Compare(node) => AnyNodeRef::ExprCompare(node), + ExprRef::Call(node) => AnyNodeRef::ExprCall(node), + ExprRef::FString(node) => AnyNodeRef::ExprFString(node), + ExprRef::StringLiteral(node) => AnyNodeRef::ExprStringLiteral(node), + ExprRef::BytesLiteral(node) => AnyNodeRef::ExprBytesLiteral(node), + ExprRef::NumberLiteral(node) => AnyNodeRef::ExprNumberLiteral(node), + ExprRef::BooleanLiteral(node) => AnyNodeRef::ExprBooleanLiteral(node), + ExprRef::NoneLiteral(node) => AnyNodeRef::ExprNoneLiteral(node), + ExprRef::EllipsisLiteral(node) => AnyNodeRef::ExprEllipsisLiteral(node), + ExprRef::Attribute(node) => AnyNodeRef::ExprAttribute(node), + ExprRef::Subscript(node) => AnyNodeRef::ExprSubscript(node), + ExprRef::Starred(node) => AnyNodeRef::ExprStarred(node), + ExprRef::Name(node) => AnyNodeRef::ExprName(node), + ExprRef::List(node) => AnyNodeRef::ExprList(node), + ExprRef::Tuple(node) => AnyNodeRef::ExprTuple(node), + ExprRef::Slice(node) => AnyNodeRef::ExprSlice(node), + ExprRef::IpyEscapeCommand(node) => AnyNodeRef::ExprIpyEscapeCommand(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_expr_ref(self) -> Option<ExprRef<'a>> { + match self { + Self::ExprBoolOp(node) => Some(ExprRef::BoolOp(node)), + Self::ExprNamed(node) => Some(ExprRef::Named(node)), + Self::ExprBinOp(node) => Some(ExprRef::BinOp(node)), + Self::ExprUnaryOp(node) => Some(ExprRef::UnaryOp(node)), + Self::ExprLambda(node) => Some(ExprRef::Lambda(node)), + Self::ExprIf(node) => Some(ExprRef::If(node)), + Self::ExprDict(node) => Some(ExprRef::Dict(node)), + Self::ExprSet(node) => Some(ExprRef::Set(node)), + Self::ExprListComp(node) => Some(ExprRef::ListComp(node)), + Self::ExprSetComp(node) => Some(ExprRef::SetComp(node)), + Self::ExprDictComp(node) => Some(ExprRef::DictComp(node)), + Self::ExprGenerator(node) => Some(ExprRef::Generator(node)), + Self::ExprAwait(node) => Some(ExprRef::Await(node)), + Self::ExprYield(node) => Some(ExprRef::Yield(node)), + Self::ExprYieldFrom(node) => Some(ExprRef::YieldFrom(node)), + Self::ExprCompare(node) => Some(ExprRef::Compare(node)), + Self::ExprCall(node) => Some(ExprRef::Call(node)), + Self::ExprFString(node) => Some(ExprRef::FString(node)), + Self::ExprStringLiteral(node) => Some(ExprRef::StringLiteral(node)), + Self::ExprBytesLiteral(node) => Some(ExprRef::BytesLiteral(node)), + Self::ExprNumberLiteral(node) => Some(ExprRef::NumberLiteral(node)), + Self::ExprBooleanLiteral(node) => Some(ExprRef::BooleanLiteral(node)), + Self::ExprNoneLiteral(node) => Some(ExprRef::NoneLiteral(node)), + Self::ExprEllipsisLiteral(node) => Some(ExprRef::EllipsisLiteral(node)), + Self::ExprAttribute(node) => Some(ExprRef::Attribute(node)), + Self::ExprSubscript(node) => Some(ExprRef::Subscript(node)), + Self::ExprStarred(node) => Some(ExprRef::Starred(node)), + Self::ExprName(node) => Some(ExprRef::Name(node)), + Self::ExprList(node) => Some(ExprRef::List(node)), + Self::ExprTuple(node) => Some(ExprRef::Tuple(node)), + Self::ExprSlice(node) => Some(ExprRef::Slice(node)), + Self::ExprIpyEscapeCommand(node) => Some(ExprRef::IpyEscapeCommand(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a ExceptHandler> for AnyNodeRef<'a> { + fn from(node: &'a ExceptHandler) -> AnyNodeRef<'a> { + match node { + ExceptHandler::ExceptHandler(node) => AnyNodeRef::ExceptHandlerExceptHandler(node), + } + } +} + +impl<'a> From<ExceptHandlerRef<'a>> for AnyNodeRef<'a> { + fn from(node: ExceptHandlerRef<'a>) -> AnyNodeRef<'a> { + match node { + ExceptHandlerRef::ExceptHandler(node) => AnyNodeRef::ExceptHandlerExceptHandler(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_except_handler_ref(self) -> Option<ExceptHandlerRef<'a>> { + match self { + Self::ExceptHandlerExceptHandler(node) => Some(ExceptHandlerRef::ExceptHandler(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a FStringElement> for AnyNodeRef<'a> { + fn from(node: &'a FStringElement) -> AnyNodeRef<'a> { + match node { + FStringElement::Expression(node) => AnyNodeRef::FStringExpressionElement(node), + FStringElement::Literal(node) => AnyNodeRef::FStringLiteralElement(node), + } + } +} + +impl<'a> From<FStringElementRef<'a>> for AnyNodeRef<'a> { + fn from(node: FStringElementRef<'a>) -> AnyNodeRef<'a> { + match node { + FStringElementRef::Expression(node) => AnyNodeRef::FStringExpressionElement(node), + FStringElementRef::Literal(node) => AnyNodeRef::FStringLiteralElement(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_f_string_element_ref(self) -> Option<FStringElementRef<'a>> { + match self { + Self::FStringExpressionElement(node) => Some(FStringElementRef::Expression(node)), + Self::FStringLiteralElement(node) => Some(FStringElementRef::Literal(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a Pattern> for AnyNodeRef<'a> { + fn from(node: &'a Pattern) -> AnyNodeRef<'a> { + match node { + Pattern::MatchValue(node) => AnyNodeRef::PatternMatchValue(node), + Pattern::MatchSingleton(node) => AnyNodeRef::PatternMatchSingleton(node), + Pattern::MatchSequence(node) => AnyNodeRef::PatternMatchSequence(node), + Pattern::MatchMapping(node) => AnyNodeRef::PatternMatchMapping(node), + Pattern::MatchClass(node) => AnyNodeRef::PatternMatchClass(node), + Pattern::MatchStar(node) => AnyNodeRef::PatternMatchStar(node), + Pattern::MatchAs(node) => AnyNodeRef::PatternMatchAs(node), + Pattern::MatchOr(node) => AnyNodeRef::PatternMatchOr(node), + } + } +} + +impl<'a> From<PatternRef<'a>> for AnyNodeRef<'a> { + fn from(node: PatternRef<'a>) -> AnyNodeRef<'a> { + match node { + PatternRef::MatchValue(node) => AnyNodeRef::PatternMatchValue(node), + PatternRef::MatchSingleton(node) => AnyNodeRef::PatternMatchSingleton(node), + PatternRef::MatchSequence(node) => AnyNodeRef::PatternMatchSequence(node), + PatternRef::MatchMapping(node) => AnyNodeRef::PatternMatchMapping(node), + PatternRef::MatchClass(node) => AnyNodeRef::PatternMatchClass(node), + PatternRef::MatchStar(node) => AnyNodeRef::PatternMatchStar(node), + PatternRef::MatchAs(node) => AnyNodeRef::PatternMatchAs(node), + PatternRef::MatchOr(node) => AnyNodeRef::PatternMatchOr(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_pattern_ref(self) -> Option<PatternRef<'a>> { + match self { + Self::PatternMatchValue(node) => Some(PatternRef::MatchValue(node)), + Self::PatternMatchSingleton(node) => Some(PatternRef::MatchSingleton(node)), + Self::PatternMatchSequence(node) => Some(PatternRef::MatchSequence(node)), + Self::PatternMatchMapping(node) => Some(PatternRef::MatchMapping(node)), + Self::PatternMatchClass(node) => Some(PatternRef::MatchClass(node)), + Self::PatternMatchStar(node) => Some(PatternRef::MatchStar(node)), + Self::PatternMatchAs(node) => Some(PatternRef::MatchAs(node)), + Self::PatternMatchOr(node) => Some(PatternRef::MatchOr(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a TypeParam> for AnyNodeRef<'a> { + fn from(node: &'a TypeParam) -> AnyNodeRef<'a> { + match node { + TypeParam::TypeVar(node) => AnyNodeRef::TypeParamTypeVar(node), + TypeParam::TypeVarTuple(node) => AnyNodeRef::TypeParamTypeVarTuple(node), + TypeParam::ParamSpec(node) => AnyNodeRef::TypeParamParamSpec(node), + } + } +} + +impl<'a> From<TypeParamRef<'a>> for AnyNodeRef<'a> { + fn from(node: TypeParamRef<'a>) -> AnyNodeRef<'a> { + match node { + TypeParamRef::TypeVar(node) => AnyNodeRef::TypeParamTypeVar(node), + TypeParamRef::TypeVarTuple(node) => AnyNodeRef::TypeParamTypeVarTuple(node), + TypeParamRef::ParamSpec(node) => AnyNodeRef::TypeParamParamSpec(node), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn as_type_param_ref(self) -> Option<TypeParamRef<'a>> { + match self { + Self::TypeParamTypeVar(node) => Some(TypeParamRef::TypeVar(node)), + Self::TypeParamTypeVarTuple(node) => Some(TypeParamRef::TypeVarTuple(node)), + Self::TypeParamParamSpec(node) => Some(TypeParamRef::ParamSpec(node)), + + _ => None, + } + } +} + +impl<'a> From<&'a crate::ModModule> for AnyNodeRef<'a> { + fn from(node: &'a crate::ModModule) -> AnyNodeRef<'a> { + AnyNodeRef::ModModule(node) + } +} + +impl<'a> From<&'a crate::ModExpression> for AnyNodeRef<'a> { + fn from(node: &'a crate::ModExpression) -> AnyNodeRef<'a> { + AnyNodeRef::ModExpression(node) + } +} + +impl<'a> From<&'a crate::StmtFunctionDef> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtFunctionDef) -> AnyNodeRef<'a> { + AnyNodeRef::StmtFunctionDef(node) + } +} + +impl<'a> From<&'a crate::StmtClassDef> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtClassDef) -> AnyNodeRef<'a> { + AnyNodeRef::StmtClassDef(node) + } +} + +impl<'a> From<&'a crate::StmtReturn> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtReturn) -> AnyNodeRef<'a> { + AnyNodeRef::StmtReturn(node) + } +} + +impl<'a> From<&'a crate::StmtDelete> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtDelete) -> AnyNodeRef<'a> { + AnyNodeRef::StmtDelete(node) + } +} + +impl<'a> From<&'a crate::StmtTypeAlias> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtTypeAlias) -> AnyNodeRef<'a> { + AnyNodeRef::StmtTypeAlias(node) + } +} + +impl<'a> From<&'a crate::StmtAssign> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtAssign) -> AnyNodeRef<'a> { + AnyNodeRef::StmtAssign(node) + } +} + +impl<'a> From<&'a crate::StmtAugAssign> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtAugAssign) -> AnyNodeRef<'a> { + AnyNodeRef::StmtAugAssign(node) + } +} + +impl<'a> From<&'a crate::StmtAnnAssign> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtAnnAssign) -> AnyNodeRef<'a> { + AnyNodeRef::StmtAnnAssign(node) + } +} + +impl<'a> From<&'a crate::StmtFor> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtFor) -> AnyNodeRef<'a> { + AnyNodeRef::StmtFor(node) + } +} + +impl<'a> From<&'a crate::StmtWhile> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtWhile) -> AnyNodeRef<'a> { + AnyNodeRef::StmtWhile(node) + } +} + +impl<'a> From<&'a crate::StmtIf> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtIf) -> AnyNodeRef<'a> { + AnyNodeRef::StmtIf(node) + } +} + +impl<'a> From<&'a crate::StmtWith> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtWith) -> AnyNodeRef<'a> { + AnyNodeRef::StmtWith(node) + } +} + +impl<'a> From<&'a crate::StmtMatch> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtMatch) -> AnyNodeRef<'a> { + AnyNodeRef::StmtMatch(node) + } +} + +impl<'a> From<&'a crate::StmtRaise> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtRaise) -> AnyNodeRef<'a> { + AnyNodeRef::StmtRaise(node) + } +} + +impl<'a> From<&'a crate::StmtTry> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtTry) -> AnyNodeRef<'a> { + AnyNodeRef::StmtTry(node) + } +} + +impl<'a> From<&'a crate::StmtAssert> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtAssert) -> AnyNodeRef<'a> { + AnyNodeRef::StmtAssert(node) + } +} + +impl<'a> From<&'a crate::StmtImport> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtImport) -> AnyNodeRef<'a> { + AnyNodeRef::StmtImport(node) + } +} + +impl<'a> From<&'a crate::StmtImportFrom> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtImportFrom) -> AnyNodeRef<'a> { + AnyNodeRef::StmtImportFrom(node) + } +} + +impl<'a> From<&'a crate::StmtGlobal> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtGlobal) -> AnyNodeRef<'a> { + AnyNodeRef::StmtGlobal(node) + } +} + +impl<'a> From<&'a crate::StmtNonlocal> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtNonlocal) -> AnyNodeRef<'a> { + AnyNodeRef::StmtNonlocal(node) + } +} + +impl<'a> From<&'a crate::StmtExpr> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtExpr) -> AnyNodeRef<'a> { + AnyNodeRef::StmtExpr(node) + } +} + +impl<'a> From<&'a crate::StmtPass> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtPass) -> AnyNodeRef<'a> { + AnyNodeRef::StmtPass(node) + } +} + +impl<'a> From<&'a crate::StmtBreak> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtBreak) -> AnyNodeRef<'a> { + AnyNodeRef::StmtBreak(node) + } +} + +impl<'a> From<&'a crate::StmtContinue> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtContinue) -> AnyNodeRef<'a> { + AnyNodeRef::StmtContinue(node) + } +} + +impl<'a> From<&'a crate::StmtIpyEscapeCommand> for AnyNodeRef<'a> { + fn from(node: &'a crate::StmtIpyEscapeCommand) -> AnyNodeRef<'a> { + AnyNodeRef::StmtIpyEscapeCommand(node) + } +} + +impl<'a> From<&'a crate::ExprBoolOp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprBoolOp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprBoolOp(node) + } +} + +impl<'a> From<&'a crate::ExprNamed> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprNamed) -> AnyNodeRef<'a> { + AnyNodeRef::ExprNamed(node) + } +} + +impl<'a> From<&'a crate::ExprBinOp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprBinOp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprBinOp(node) + } +} + +impl<'a> From<&'a crate::ExprUnaryOp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprUnaryOp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprUnaryOp(node) + } +} + +impl<'a> From<&'a crate::ExprLambda> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprLambda) -> AnyNodeRef<'a> { + AnyNodeRef::ExprLambda(node) + } +} + +impl<'a> From<&'a crate::ExprIf> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprIf) -> AnyNodeRef<'a> { + AnyNodeRef::ExprIf(node) + } +} + +impl<'a> From<&'a crate::ExprDict> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprDict) -> AnyNodeRef<'a> { + AnyNodeRef::ExprDict(node) + } +} + +impl<'a> From<&'a crate::ExprSet> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprSet) -> AnyNodeRef<'a> { + AnyNodeRef::ExprSet(node) + } +} + +impl<'a> From<&'a crate::ExprListComp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprListComp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprListComp(node) + } +} + +impl<'a> From<&'a crate::ExprSetComp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprSetComp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprSetComp(node) + } +} + +impl<'a> From<&'a crate::ExprDictComp> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprDictComp) -> AnyNodeRef<'a> { + AnyNodeRef::ExprDictComp(node) + } +} + +impl<'a> From<&'a crate::ExprGenerator> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprGenerator) -> AnyNodeRef<'a> { + AnyNodeRef::ExprGenerator(node) + } +} + +impl<'a> From<&'a crate::ExprAwait> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprAwait) -> AnyNodeRef<'a> { + AnyNodeRef::ExprAwait(node) + } +} + +impl<'a> From<&'a crate::ExprYield> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprYield) -> AnyNodeRef<'a> { + AnyNodeRef::ExprYield(node) + } +} + +impl<'a> From<&'a crate::ExprYieldFrom> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprYieldFrom) -> AnyNodeRef<'a> { + AnyNodeRef::ExprYieldFrom(node) + } +} + +impl<'a> From<&'a crate::ExprCompare> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprCompare) -> AnyNodeRef<'a> { + AnyNodeRef::ExprCompare(node) + } +} + +impl<'a> From<&'a crate::ExprCall> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprCall) -> AnyNodeRef<'a> { + AnyNodeRef::ExprCall(node) + } +} + +impl<'a> From<&'a crate::ExprFString> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprFString) -> AnyNodeRef<'a> { + AnyNodeRef::ExprFString(node) + } +} + +impl<'a> From<&'a crate::ExprStringLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprStringLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprStringLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprBytesLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprBytesLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprBytesLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprNumberLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprNumberLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprNumberLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprBooleanLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprBooleanLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprBooleanLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprNoneLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprNoneLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprNoneLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprEllipsisLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprEllipsisLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::ExprEllipsisLiteral(node) + } +} + +impl<'a> From<&'a crate::ExprAttribute> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprAttribute) -> AnyNodeRef<'a> { + AnyNodeRef::ExprAttribute(node) + } +} + +impl<'a> From<&'a crate::ExprSubscript> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprSubscript) -> AnyNodeRef<'a> { + AnyNodeRef::ExprSubscript(node) + } +} + +impl<'a> From<&'a crate::ExprStarred> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprStarred) -> AnyNodeRef<'a> { + AnyNodeRef::ExprStarred(node) + } +} + +impl<'a> From<&'a crate::ExprName> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprName) -> AnyNodeRef<'a> { + AnyNodeRef::ExprName(node) + } +} + +impl<'a> From<&'a crate::ExprList> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprList) -> AnyNodeRef<'a> { + AnyNodeRef::ExprList(node) + } +} + +impl<'a> From<&'a crate::ExprTuple> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprTuple) -> AnyNodeRef<'a> { + AnyNodeRef::ExprTuple(node) + } +} + +impl<'a> From<&'a crate::ExprSlice> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprSlice) -> AnyNodeRef<'a> { + AnyNodeRef::ExprSlice(node) + } +} + +impl<'a> From<&'a crate::ExprIpyEscapeCommand> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExprIpyEscapeCommand) -> AnyNodeRef<'a> { + AnyNodeRef::ExprIpyEscapeCommand(node) + } +} + +impl<'a> From<&'a crate::ExceptHandlerExceptHandler> for AnyNodeRef<'a> { + fn from(node: &'a crate::ExceptHandlerExceptHandler) -> AnyNodeRef<'a> { + AnyNodeRef::ExceptHandlerExceptHandler(node) + } +} + +impl<'a> From<&'a crate::FStringExpressionElement> for AnyNodeRef<'a> { + fn from(node: &'a crate::FStringExpressionElement) -> AnyNodeRef<'a> { + AnyNodeRef::FStringExpressionElement(node) + } +} + +impl<'a> From<&'a crate::FStringLiteralElement> for AnyNodeRef<'a> { + fn from(node: &'a crate::FStringLiteralElement) -> AnyNodeRef<'a> { + AnyNodeRef::FStringLiteralElement(node) + } +} + +impl<'a> From<&'a crate::PatternMatchValue> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchValue) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchValue(node) + } +} + +impl<'a> From<&'a crate::PatternMatchSingleton> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchSingleton) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchSingleton(node) + } +} + +impl<'a> From<&'a crate::PatternMatchSequence> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchSequence) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchSequence(node) + } +} + +impl<'a> From<&'a crate::PatternMatchMapping> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchMapping) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchMapping(node) + } +} + +impl<'a> From<&'a crate::PatternMatchClass> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchClass) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchClass(node) + } +} + +impl<'a> From<&'a crate::PatternMatchStar> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchStar) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchStar(node) + } +} + +impl<'a> From<&'a crate::PatternMatchAs> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchAs) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchAs(node) + } +} + +impl<'a> From<&'a crate::PatternMatchOr> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternMatchOr) -> AnyNodeRef<'a> { + AnyNodeRef::PatternMatchOr(node) + } +} + +impl<'a> From<&'a crate::TypeParamTypeVar> for AnyNodeRef<'a> { + fn from(node: &'a crate::TypeParamTypeVar) -> AnyNodeRef<'a> { + AnyNodeRef::TypeParamTypeVar(node) + } +} + +impl<'a> From<&'a crate::TypeParamTypeVarTuple> for AnyNodeRef<'a> { + fn from(node: &'a crate::TypeParamTypeVarTuple) -> AnyNodeRef<'a> { + AnyNodeRef::TypeParamTypeVarTuple(node) + } +} + +impl<'a> From<&'a crate::TypeParamParamSpec> for AnyNodeRef<'a> { + fn from(node: &'a crate::TypeParamParamSpec) -> AnyNodeRef<'a> { + AnyNodeRef::TypeParamParamSpec(node) + } +} + +impl<'a> From<&'a crate::FStringFormatSpec> for AnyNodeRef<'a> { + fn from(node: &'a crate::FStringFormatSpec) -> AnyNodeRef<'a> { + AnyNodeRef::FStringFormatSpec(node) + } +} + +impl<'a> From<&'a crate::PatternArguments> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternArguments) -> AnyNodeRef<'a> { + AnyNodeRef::PatternArguments(node) + } +} + +impl<'a> From<&'a crate::PatternKeyword> for AnyNodeRef<'a> { + fn from(node: &'a crate::PatternKeyword) -> AnyNodeRef<'a> { + AnyNodeRef::PatternKeyword(node) + } +} + +impl<'a> From<&'a crate::Comprehension> for AnyNodeRef<'a> { + fn from(node: &'a crate::Comprehension) -> AnyNodeRef<'a> { + AnyNodeRef::Comprehension(node) + } +} + +impl<'a> From<&'a crate::Arguments> for AnyNodeRef<'a> { + fn from(node: &'a crate::Arguments) -> AnyNodeRef<'a> { + AnyNodeRef::Arguments(node) + } +} + +impl<'a> From<&'a crate::Parameters> for AnyNodeRef<'a> { + fn from(node: &'a crate::Parameters) -> AnyNodeRef<'a> { + AnyNodeRef::Parameters(node) + } +} + +impl<'a> From<&'a crate::Parameter> for AnyNodeRef<'a> { + fn from(node: &'a crate::Parameter) -> AnyNodeRef<'a> { + AnyNodeRef::Parameter(node) + } +} + +impl<'a> From<&'a crate::ParameterWithDefault> for AnyNodeRef<'a> { + fn from(node: &'a crate::ParameterWithDefault) -> AnyNodeRef<'a> { + AnyNodeRef::ParameterWithDefault(node) + } +} + +impl<'a> From<&'a crate::Keyword> for AnyNodeRef<'a> { + fn from(node: &'a crate::Keyword) -> AnyNodeRef<'a> { + AnyNodeRef::Keyword(node) + } +} + +impl<'a> From<&'a crate::Alias> for AnyNodeRef<'a> { + fn from(node: &'a crate::Alias) -> AnyNodeRef<'a> { + AnyNodeRef::Alias(node) + } +} + +impl<'a> From<&'a crate::WithItem> for AnyNodeRef<'a> { + fn from(node: &'a crate::WithItem) -> AnyNodeRef<'a> { + AnyNodeRef::WithItem(node) + } +} + +impl<'a> From<&'a crate::MatchCase> for AnyNodeRef<'a> { + fn from(node: &'a crate::MatchCase) -> AnyNodeRef<'a> { + AnyNodeRef::MatchCase(node) + } +} + +impl<'a> From<&'a crate::Decorator> for AnyNodeRef<'a> { + fn from(node: &'a crate::Decorator) -> AnyNodeRef<'a> { + AnyNodeRef::Decorator(node) + } +} + +impl<'a> From<&'a crate::ElifElseClause> for AnyNodeRef<'a> { + fn from(node: &'a crate::ElifElseClause) -> AnyNodeRef<'a> { + AnyNodeRef::ElifElseClause(node) + } +} + +impl<'a> From<&'a crate::TypeParams> for AnyNodeRef<'a> { + fn from(node: &'a crate::TypeParams) -> AnyNodeRef<'a> { + AnyNodeRef::TypeParams(node) + } +} + +impl<'a> From<&'a crate::FString> for AnyNodeRef<'a> { + fn from(node: &'a crate::FString) -> AnyNodeRef<'a> { + AnyNodeRef::FString(node) + } +} + +impl<'a> From<&'a crate::StringLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::StringLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::StringLiteral(node) + } +} + +impl<'a> From<&'a crate::BytesLiteral> for AnyNodeRef<'a> { + fn from(node: &'a crate::BytesLiteral) -> AnyNodeRef<'a> { + AnyNodeRef::BytesLiteral(node) + } +} + +impl<'a> From<&'a crate::Identifier> for AnyNodeRef<'a> { + fn from(node: &'a crate::Identifier) -> AnyNodeRef<'a> { + AnyNodeRef::Identifier(node) + } +} + +impl ruff_text_size::Ranged for AnyNodeRef<'_> { + fn range(&self) -> ruff_text_size::TextRange { + match self { + AnyNodeRef::ModModule(node) => node.range(), + AnyNodeRef::ModExpression(node) => node.range(), + AnyNodeRef::StmtFunctionDef(node) => node.range(), + AnyNodeRef::StmtClassDef(node) => node.range(), + AnyNodeRef::StmtReturn(node) => node.range(), + AnyNodeRef::StmtDelete(node) => node.range(), + AnyNodeRef::StmtTypeAlias(node) => node.range(), + AnyNodeRef::StmtAssign(node) => node.range(), + AnyNodeRef::StmtAugAssign(node) => node.range(), + AnyNodeRef::StmtAnnAssign(node) => node.range(), + AnyNodeRef::StmtFor(node) => node.range(), + AnyNodeRef::StmtWhile(node) => node.range(), + AnyNodeRef::StmtIf(node) => node.range(), + AnyNodeRef::StmtWith(node) => node.range(), + AnyNodeRef::StmtMatch(node) => node.range(), + AnyNodeRef::StmtRaise(node) => node.range(), + AnyNodeRef::StmtTry(node) => node.range(), + AnyNodeRef::StmtAssert(node) => node.range(), + AnyNodeRef::StmtImport(node) => node.range(), + AnyNodeRef::StmtImportFrom(node) => node.range(), + AnyNodeRef::StmtGlobal(node) => node.range(), + AnyNodeRef::StmtNonlocal(node) => node.range(), + AnyNodeRef::StmtExpr(node) => node.range(), + AnyNodeRef::StmtPass(node) => node.range(), + AnyNodeRef::StmtBreak(node) => node.range(), + AnyNodeRef::StmtContinue(node) => node.range(), + AnyNodeRef::StmtIpyEscapeCommand(node) => node.range(), + AnyNodeRef::ExprBoolOp(node) => node.range(), + AnyNodeRef::ExprNamed(node) => node.range(), + AnyNodeRef::ExprBinOp(node) => node.range(), + AnyNodeRef::ExprUnaryOp(node) => node.range(), + AnyNodeRef::ExprLambda(node) => node.range(), + AnyNodeRef::ExprIf(node) => node.range(), + AnyNodeRef::ExprDict(node) => node.range(), + AnyNodeRef::ExprSet(node) => node.range(), + AnyNodeRef::ExprListComp(node) => node.range(), + AnyNodeRef::ExprSetComp(node) => node.range(), + AnyNodeRef::ExprDictComp(node) => node.range(), + AnyNodeRef::ExprGenerator(node) => node.range(), + AnyNodeRef::ExprAwait(node) => node.range(), + AnyNodeRef::ExprYield(node) => node.range(), + AnyNodeRef::ExprYieldFrom(node) => node.range(), + AnyNodeRef::ExprCompare(node) => node.range(), + AnyNodeRef::ExprCall(node) => node.range(), + AnyNodeRef::ExprFString(node) => node.range(), + AnyNodeRef::ExprStringLiteral(node) => node.range(), + AnyNodeRef::ExprBytesLiteral(node) => node.range(), + AnyNodeRef::ExprNumberLiteral(node) => node.range(), + AnyNodeRef::ExprBooleanLiteral(node) => node.range(), + AnyNodeRef::ExprNoneLiteral(node) => node.range(), + AnyNodeRef::ExprEllipsisLiteral(node) => node.range(), + AnyNodeRef::ExprAttribute(node) => node.range(), + AnyNodeRef::ExprSubscript(node) => node.range(), + AnyNodeRef::ExprStarred(node) => node.range(), + AnyNodeRef::ExprName(node) => node.range(), + AnyNodeRef::ExprList(node) => node.range(), + AnyNodeRef::ExprTuple(node) => node.range(), + AnyNodeRef::ExprSlice(node) => node.range(), + AnyNodeRef::ExprIpyEscapeCommand(node) => node.range(), + AnyNodeRef::ExceptHandlerExceptHandler(node) => node.range(), + AnyNodeRef::FStringExpressionElement(node) => node.range(), + AnyNodeRef::FStringLiteralElement(node) => node.range(), + AnyNodeRef::PatternMatchValue(node) => node.range(), + AnyNodeRef::PatternMatchSingleton(node) => node.range(), + AnyNodeRef::PatternMatchSequence(node) => node.range(), + AnyNodeRef::PatternMatchMapping(node) => node.range(), + AnyNodeRef::PatternMatchClass(node) => node.range(), + AnyNodeRef::PatternMatchStar(node) => node.range(), + AnyNodeRef::PatternMatchAs(node) => node.range(), + AnyNodeRef::PatternMatchOr(node) => node.range(), + AnyNodeRef::TypeParamTypeVar(node) => node.range(), + AnyNodeRef::TypeParamTypeVarTuple(node) => node.range(), + AnyNodeRef::TypeParamParamSpec(node) => node.range(), + AnyNodeRef::FStringFormatSpec(node) => node.range(), + AnyNodeRef::PatternArguments(node) => node.range(), + AnyNodeRef::PatternKeyword(node) => node.range(), + AnyNodeRef::Comprehension(node) => node.range(), + AnyNodeRef::Arguments(node) => node.range(), + AnyNodeRef::Parameters(node) => node.range(), + AnyNodeRef::Parameter(node) => node.range(), + AnyNodeRef::ParameterWithDefault(node) => node.range(), + AnyNodeRef::Keyword(node) => node.range(), + AnyNodeRef::Alias(node) => node.range(), + AnyNodeRef::WithItem(node) => node.range(), + AnyNodeRef::MatchCase(node) => node.range(), + AnyNodeRef::Decorator(node) => node.range(), + AnyNodeRef::ElifElseClause(node) => node.range(), + AnyNodeRef::TypeParams(node) => node.range(), + AnyNodeRef::FString(node) => node.range(), + AnyNodeRef::StringLiteral(node) => node.range(), + AnyNodeRef::BytesLiteral(node) => node.range(), + AnyNodeRef::Identifier(node) => node.range(), + } + } +} + +impl AnyNodeRef<'_> { + pub fn as_ptr(&self) -> std::ptr::NonNull<()> { + match self { + AnyNodeRef::ModModule(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ModExpression(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtFunctionDef(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtClassDef(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtReturn(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtDelete(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtTypeAlias(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtAssign(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtAugAssign(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtAnnAssign(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtFor(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtWhile(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtIf(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtWith(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtMatch(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtRaise(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtTry(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtAssert(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtImport(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtImportFrom(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtGlobal(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtNonlocal(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtExpr(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtPass(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtBreak(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtContinue(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StmtIpyEscapeCommand(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprBoolOp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprNamed(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprBinOp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprUnaryOp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprLambda(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprIf(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprDict(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprSet(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprListComp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprSetComp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprDictComp(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprGenerator(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprAwait(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprYield(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprYieldFrom(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprCompare(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprCall(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprFString(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprStringLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprBytesLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprNumberLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprBooleanLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprNoneLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprEllipsisLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprAttribute(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprSubscript(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprStarred(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprName(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprList(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprTuple(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprSlice(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExprIpyEscapeCommand(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ExceptHandlerExceptHandler(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::FStringExpressionElement(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::FStringLiteralElement(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchValue(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchSingleton(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchSequence(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchMapping(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchClass(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchStar(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchAs(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternMatchOr(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::TypeParamTypeVar(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::TypeParamTypeVarTuple(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::TypeParamParamSpec(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::FStringFormatSpec(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternArguments(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::PatternKeyword(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Comprehension(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Arguments(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Parameters(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Parameter(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ParameterWithDefault(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Keyword(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Alias(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::WithItem(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::MatchCase(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Decorator(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::ElifElseClause(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::TypeParams(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::FString(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::StringLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::BytesLiteral(node) => std::ptr::NonNull::from(*node).cast(), + AnyNodeRef::Identifier(node) => std::ptr::NonNull::from(*node).cast(), + } + } +} + +impl<'a> AnyNodeRef<'a> { + pub fn visit_source_order<'b, V>(self, visitor: &mut V) + where + V: crate::visitor::source_order::SourceOrderVisitor<'b> + ?Sized, + 'a: 'b, + { + match self { + AnyNodeRef::ModModule(node) => node.visit_source_order(visitor), + AnyNodeRef::ModExpression(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtFunctionDef(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtClassDef(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtReturn(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtDelete(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtTypeAlias(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtAssign(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtAugAssign(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtAnnAssign(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtFor(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtWhile(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtIf(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtWith(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtMatch(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtRaise(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtTry(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtAssert(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtImport(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtImportFrom(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtGlobal(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtNonlocal(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtExpr(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtPass(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtBreak(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtContinue(node) => node.visit_source_order(visitor), + AnyNodeRef::StmtIpyEscapeCommand(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprBoolOp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprNamed(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprBinOp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprUnaryOp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprLambda(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprIf(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprDict(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprSet(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprListComp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprSetComp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprDictComp(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprGenerator(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprAwait(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprYield(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprYieldFrom(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprCompare(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprCall(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprFString(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprStringLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprBytesLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprNumberLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprBooleanLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprNoneLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprEllipsisLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprAttribute(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprSubscript(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprStarred(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprName(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprList(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprTuple(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprSlice(node) => node.visit_source_order(visitor), + AnyNodeRef::ExprIpyEscapeCommand(node) => node.visit_source_order(visitor), + AnyNodeRef::ExceptHandlerExceptHandler(node) => node.visit_source_order(visitor), + AnyNodeRef::FStringExpressionElement(node) => node.visit_source_order(visitor), + AnyNodeRef::FStringLiteralElement(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchValue(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchSingleton(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchSequence(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchMapping(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchClass(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchStar(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchAs(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternMatchOr(node) => node.visit_source_order(visitor), + AnyNodeRef::TypeParamTypeVar(node) => node.visit_source_order(visitor), + AnyNodeRef::TypeParamTypeVarTuple(node) => node.visit_source_order(visitor), + AnyNodeRef::TypeParamParamSpec(node) => node.visit_source_order(visitor), + AnyNodeRef::FStringFormatSpec(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternArguments(node) => node.visit_source_order(visitor), + AnyNodeRef::PatternKeyword(node) => node.visit_source_order(visitor), + AnyNodeRef::Comprehension(node) => node.visit_source_order(visitor), + AnyNodeRef::Arguments(node) => node.visit_source_order(visitor), + AnyNodeRef::Parameters(node) => node.visit_source_order(visitor), + AnyNodeRef::Parameter(node) => node.visit_source_order(visitor), + AnyNodeRef::ParameterWithDefault(node) => node.visit_source_order(visitor), + AnyNodeRef::Keyword(node) => node.visit_source_order(visitor), + AnyNodeRef::Alias(node) => node.visit_source_order(visitor), + AnyNodeRef::WithItem(node) => node.visit_source_order(visitor), + AnyNodeRef::MatchCase(node) => node.visit_source_order(visitor), + AnyNodeRef::Decorator(node) => node.visit_source_order(visitor), + AnyNodeRef::ElifElseClause(node) => node.visit_source_order(visitor), + AnyNodeRef::TypeParams(node) => node.visit_source_order(visitor), + AnyNodeRef::FString(node) => node.visit_source_order(visitor), + AnyNodeRef::StringLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::BytesLiteral(node) => node.visit_source_order(visitor), + AnyNodeRef::Identifier(node) => node.visit_source_order(visitor), + } + } +} + +impl AnyNodeRef<'_> { + pub const fn is_module(self) -> bool { + matches!( + self, + AnyNodeRef::ModModule(_) | AnyNodeRef::ModExpression(_) + ) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_statement(self) -> bool { + matches!( + self, + AnyNodeRef::StmtFunctionDef(_) + | AnyNodeRef::StmtClassDef(_) + | AnyNodeRef::StmtReturn(_) + | AnyNodeRef::StmtDelete(_) + | AnyNodeRef::StmtTypeAlias(_) + | AnyNodeRef::StmtAssign(_) + | AnyNodeRef::StmtAugAssign(_) + | AnyNodeRef::StmtAnnAssign(_) + | AnyNodeRef::StmtFor(_) + | AnyNodeRef::StmtWhile(_) + | AnyNodeRef::StmtIf(_) + | AnyNodeRef::StmtWith(_) + | AnyNodeRef::StmtMatch(_) + | AnyNodeRef::StmtRaise(_) + | AnyNodeRef::StmtTry(_) + | AnyNodeRef::StmtAssert(_) + | AnyNodeRef::StmtImport(_) + | AnyNodeRef::StmtImportFrom(_) + | AnyNodeRef::StmtGlobal(_) + | AnyNodeRef::StmtNonlocal(_) + | AnyNodeRef::StmtExpr(_) + | AnyNodeRef::StmtPass(_) + | AnyNodeRef::StmtBreak(_) + | AnyNodeRef::StmtContinue(_) + | AnyNodeRef::StmtIpyEscapeCommand(_) + ) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_expression(self) -> bool { + matches!( + self, + AnyNodeRef::ExprBoolOp(_) + | AnyNodeRef::ExprNamed(_) + | AnyNodeRef::ExprBinOp(_) + | AnyNodeRef::ExprUnaryOp(_) + | AnyNodeRef::ExprLambda(_) + | AnyNodeRef::ExprIf(_) + | AnyNodeRef::ExprDict(_) + | AnyNodeRef::ExprSet(_) + | AnyNodeRef::ExprListComp(_) + | AnyNodeRef::ExprSetComp(_) + | AnyNodeRef::ExprDictComp(_) + | AnyNodeRef::ExprGenerator(_) + | AnyNodeRef::ExprAwait(_) + | AnyNodeRef::ExprYield(_) + | AnyNodeRef::ExprYieldFrom(_) + | AnyNodeRef::ExprCompare(_) + | AnyNodeRef::ExprCall(_) + | AnyNodeRef::ExprFString(_) + | AnyNodeRef::ExprStringLiteral(_) + | AnyNodeRef::ExprBytesLiteral(_) + | AnyNodeRef::ExprNumberLiteral(_) + | AnyNodeRef::ExprBooleanLiteral(_) + | AnyNodeRef::ExprNoneLiteral(_) + | AnyNodeRef::ExprEllipsisLiteral(_) + | AnyNodeRef::ExprAttribute(_) + | AnyNodeRef::ExprSubscript(_) + | AnyNodeRef::ExprStarred(_) + | AnyNodeRef::ExprName(_) + | AnyNodeRef::ExprList(_) + | AnyNodeRef::ExprTuple(_) + | AnyNodeRef::ExprSlice(_) + | AnyNodeRef::ExprIpyEscapeCommand(_) + ) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_except_handler(self) -> bool { + matches!(self, AnyNodeRef::ExceptHandlerExceptHandler(_)) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_f_string_element(self) -> bool { + matches!( + self, + AnyNodeRef::FStringExpressionElement(_) | AnyNodeRef::FStringLiteralElement(_) + ) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_pattern(self) -> bool { + matches!( + self, + AnyNodeRef::PatternMatchValue(_) + | AnyNodeRef::PatternMatchSingleton(_) + | AnyNodeRef::PatternMatchSequence(_) + | AnyNodeRef::PatternMatchMapping(_) + | AnyNodeRef::PatternMatchClass(_) + | AnyNodeRef::PatternMatchStar(_) + | AnyNodeRef::PatternMatchAs(_) + | AnyNodeRef::PatternMatchOr(_) + ) + } +} + +impl AnyNodeRef<'_> { + pub const fn is_type_param(self) -> bool { + matches!( + self, + AnyNodeRef::TypeParamTypeVar(_) + | AnyNodeRef::TypeParamTypeVarTuple(_) + | AnyNodeRef::TypeParamParamSpec(_) + ) + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub enum NodeKind { + ModModule, + ModExpression, + StmtFunctionDef, + StmtClassDef, + StmtReturn, + StmtDelete, + StmtTypeAlias, + StmtAssign, + StmtAugAssign, + StmtAnnAssign, + StmtFor, + StmtWhile, + StmtIf, + StmtWith, + StmtMatch, + StmtRaise, + StmtTry, + StmtAssert, + StmtImport, + StmtImportFrom, + StmtGlobal, + StmtNonlocal, + StmtExpr, + StmtPass, + StmtBreak, + StmtContinue, + StmtIpyEscapeCommand, + ExprBoolOp, + ExprNamed, + ExprBinOp, + ExprUnaryOp, + ExprLambda, + ExprIf, + ExprDict, + ExprSet, + ExprListComp, + ExprSetComp, + ExprDictComp, + ExprGenerator, + ExprAwait, + ExprYield, + ExprYieldFrom, + ExprCompare, + ExprCall, + ExprFString, + ExprStringLiteral, + ExprBytesLiteral, + ExprNumberLiteral, + ExprBooleanLiteral, + ExprNoneLiteral, + ExprEllipsisLiteral, + ExprAttribute, + ExprSubscript, + ExprStarred, + ExprName, + ExprList, + ExprTuple, + ExprSlice, + ExprIpyEscapeCommand, + ExceptHandlerExceptHandler, + FStringExpressionElement, + FStringLiteralElement, + PatternMatchValue, + PatternMatchSingleton, + PatternMatchSequence, + PatternMatchMapping, + PatternMatchClass, + PatternMatchStar, + PatternMatchAs, + PatternMatchOr, + TypeParamTypeVar, + TypeParamTypeVarTuple, + TypeParamParamSpec, + FStringFormatSpec, + PatternArguments, + PatternKeyword, + Comprehension, + Arguments, + Parameters, + Parameter, + ParameterWithDefault, + Keyword, + Alias, + WithItem, + MatchCase, + Decorator, + ElifElseClause, + TypeParams, + FString, + StringLiteral, + BytesLiteral, + Identifier, +} + +impl AnyNodeRef<'_> { + pub const fn kind(self) -> NodeKind { + match self { + AnyNodeRef::ModModule(_) => NodeKind::ModModule, + AnyNodeRef::ModExpression(_) => NodeKind::ModExpression, + AnyNodeRef::StmtFunctionDef(_) => NodeKind::StmtFunctionDef, + AnyNodeRef::StmtClassDef(_) => NodeKind::StmtClassDef, + AnyNodeRef::StmtReturn(_) => NodeKind::StmtReturn, + AnyNodeRef::StmtDelete(_) => NodeKind::StmtDelete, + AnyNodeRef::StmtTypeAlias(_) => NodeKind::StmtTypeAlias, + AnyNodeRef::StmtAssign(_) => NodeKind::StmtAssign, + AnyNodeRef::StmtAugAssign(_) => NodeKind::StmtAugAssign, + AnyNodeRef::StmtAnnAssign(_) => NodeKind::StmtAnnAssign, + AnyNodeRef::StmtFor(_) => NodeKind::StmtFor, + AnyNodeRef::StmtWhile(_) => NodeKind::StmtWhile, + AnyNodeRef::StmtIf(_) => NodeKind::StmtIf, + AnyNodeRef::StmtWith(_) => NodeKind::StmtWith, + AnyNodeRef::StmtMatch(_) => NodeKind::StmtMatch, + AnyNodeRef::StmtRaise(_) => NodeKind::StmtRaise, + AnyNodeRef::StmtTry(_) => NodeKind::StmtTry, + AnyNodeRef::StmtAssert(_) => NodeKind::StmtAssert, + AnyNodeRef::StmtImport(_) => NodeKind::StmtImport, + AnyNodeRef::StmtImportFrom(_) => NodeKind::StmtImportFrom, + AnyNodeRef::StmtGlobal(_) => NodeKind::StmtGlobal, + AnyNodeRef::StmtNonlocal(_) => NodeKind::StmtNonlocal, + AnyNodeRef::StmtExpr(_) => NodeKind::StmtExpr, + AnyNodeRef::StmtPass(_) => NodeKind::StmtPass, + AnyNodeRef::StmtBreak(_) => NodeKind::StmtBreak, + AnyNodeRef::StmtContinue(_) => NodeKind::StmtContinue, + AnyNodeRef::StmtIpyEscapeCommand(_) => NodeKind::StmtIpyEscapeCommand, + AnyNodeRef::ExprBoolOp(_) => NodeKind::ExprBoolOp, + AnyNodeRef::ExprNamed(_) => NodeKind::ExprNamed, + AnyNodeRef::ExprBinOp(_) => NodeKind::ExprBinOp, + AnyNodeRef::ExprUnaryOp(_) => NodeKind::ExprUnaryOp, + AnyNodeRef::ExprLambda(_) => NodeKind::ExprLambda, + AnyNodeRef::ExprIf(_) => NodeKind::ExprIf, + AnyNodeRef::ExprDict(_) => NodeKind::ExprDict, + AnyNodeRef::ExprSet(_) => NodeKind::ExprSet, + AnyNodeRef::ExprListComp(_) => NodeKind::ExprListComp, + AnyNodeRef::ExprSetComp(_) => NodeKind::ExprSetComp, + AnyNodeRef::ExprDictComp(_) => NodeKind::ExprDictComp, + AnyNodeRef::ExprGenerator(_) => NodeKind::ExprGenerator, + AnyNodeRef::ExprAwait(_) => NodeKind::ExprAwait, + AnyNodeRef::ExprYield(_) => NodeKind::ExprYield, + AnyNodeRef::ExprYieldFrom(_) => NodeKind::ExprYieldFrom, + AnyNodeRef::ExprCompare(_) => NodeKind::ExprCompare, + AnyNodeRef::ExprCall(_) => NodeKind::ExprCall, + AnyNodeRef::ExprFString(_) => NodeKind::ExprFString, + AnyNodeRef::ExprStringLiteral(_) => NodeKind::ExprStringLiteral, + AnyNodeRef::ExprBytesLiteral(_) => NodeKind::ExprBytesLiteral, + AnyNodeRef::ExprNumberLiteral(_) => NodeKind::ExprNumberLiteral, + AnyNodeRef::ExprBooleanLiteral(_) => NodeKind::ExprBooleanLiteral, + AnyNodeRef::ExprNoneLiteral(_) => NodeKind::ExprNoneLiteral, + AnyNodeRef::ExprEllipsisLiteral(_) => NodeKind::ExprEllipsisLiteral, + AnyNodeRef::ExprAttribute(_) => NodeKind::ExprAttribute, + AnyNodeRef::ExprSubscript(_) => NodeKind::ExprSubscript, + AnyNodeRef::ExprStarred(_) => NodeKind::ExprStarred, + AnyNodeRef::ExprName(_) => NodeKind::ExprName, + AnyNodeRef::ExprList(_) => NodeKind::ExprList, + AnyNodeRef::ExprTuple(_) => NodeKind::ExprTuple, + AnyNodeRef::ExprSlice(_) => NodeKind::ExprSlice, + AnyNodeRef::ExprIpyEscapeCommand(_) => NodeKind::ExprIpyEscapeCommand, + AnyNodeRef::ExceptHandlerExceptHandler(_) => NodeKind::ExceptHandlerExceptHandler, + AnyNodeRef::FStringExpressionElement(_) => NodeKind::FStringExpressionElement, + AnyNodeRef::FStringLiteralElement(_) => NodeKind::FStringLiteralElement, + AnyNodeRef::PatternMatchValue(_) => NodeKind::PatternMatchValue, + AnyNodeRef::PatternMatchSingleton(_) => NodeKind::PatternMatchSingleton, + AnyNodeRef::PatternMatchSequence(_) => NodeKind::PatternMatchSequence, + AnyNodeRef::PatternMatchMapping(_) => NodeKind::PatternMatchMapping, + AnyNodeRef::PatternMatchClass(_) => NodeKind::PatternMatchClass, + AnyNodeRef::PatternMatchStar(_) => NodeKind::PatternMatchStar, + AnyNodeRef::PatternMatchAs(_) => NodeKind::PatternMatchAs, + AnyNodeRef::PatternMatchOr(_) => NodeKind::PatternMatchOr, + AnyNodeRef::TypeParamTypeVar(_) => NodeKind::TypeParamTypeVar, + AnyNodeRef::TypeParamTypeVarTuple(_) => NodeKind::TypeParamTypeVarTuple, + AnyNodeRef::TypeParamParamSpec(_) => NodeKind::TypeParamParamSpec, + AnyNodeRef::FStringFormatSpec(_) => NodeKind::FStringFormatSpec, + AnyNodeRef::PatternArguments(_) => NodeKind::PatternArguments, + AnyNodeRef::PatternKeyword(_) => NodeKind::PatternKeyword, + AnyNodeRef::Comprehension(_) => NodeKind::Comprehension, + AnyNodeRef::Arguments(_) => NodeKind::Arguments, + AnyNodeRef::Parameters(_) => NodeKind::Parameters, + AnyNodeRef::Parameter(_) => NodeKind::Parameter, + AnyNodeRef::ParameterWithDefault(_) => NodeKind::ParameterWithDefault, + AnyNodeRef::Keyword(_) => NodeKind::Keyword, + AnyNodeRef::Alias(_) => NodeKind::Alias, + AnyNodeRef::WithItem(_) => NodeKind::WithItem, + AnyNodeRef::MatchCase(_) => NodeKind::MatchCase, + AnyNodeRef::Decorator(_) => NodeKind::Decorator, + AnyNodeRef::ElifElseClause(_) => NodeKind::ElifElseClause, + AnyNodeRef::TypeParams(_) => NodeKind::TypeParams, + AnyNodeRef::FString(_) => NodeKind::FString, + AnyNodeRef::StringLiteral(_) => NodeKind::StringLiteral, + AnyNodeRef::BytesLiteral(_) => NodeKind::BytesLiteral, + AnyNodeRef::Identifier(_) => NodeKind::Identifier, + } + } +} + +/// See also [Module](https://docs.python.org/3/library/ast.html#ast.Module) +#[derive(Clone, Debug, PartialEq)] +pub struct ModModule { + pub range: ruff_text_size::TextRange, + pub body: Vec<Stmt>, +} + +/// See also [Module](https://docs.python.org/3/library/ast.html#ast.Module) +#[derive(Clone, Debug, PartialEq)] +pub struct ModExpression { + pub range: ruff_text_size::TextRange, + pub body: Box<Expr>, +} + +/// See also [FunctionDef](https://docs.python.org/3/library/ast.html#ast.FunctionDef) +/// and [AsyncFunctionDef](https://docs.python.org/3/library/ast.html#ast.AsyncFunctionDef). +/// +/// This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type. +#[derive(Clone, Debug, PartialEq)] +pub struct StmtFunctionDef { + pub range: ruff_text_size::TextRange, + pub is_async: bool, + pub decorator_list: Vec<crate::Decorator>, + pub name: crate::Identifier, + pub type_params: Option<Box<crate::TypeParams>>, + pub parameters: Box<crate::Parameters>, + pub returns: Option<Box<Expr>>, + pub body: Vec<Stmt>, +} + +/// See also [ClassDef](https://docs.python.org/3/library/ast.html#ast.ClassDef) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtClassDef { + pub range: ruff_text_size::TextRange, + pub decorator_list: Vec<crate::Decorator>, + pub name: crate::Identifier, + pub type_params: Option<Box<crate::TypeParams>>, + pub arguments: Option<Box<crate::Arguments>>, + pub body: Vec<Stmt>, +} + +/// See also [Return](https://docs.python.org/3/library/ast.html#ast.Return) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtReturn { + pub range: ruff_text_size::TextRange, + pub value: Option<Box<Expr>>, +} + +/// See also [Delete](https://docs.python.org/3/library/ast.html#ast.Delete) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtDelete { + pub range: ruff_text_size::TextRange, + pub targets: Vec<Expr>, +} + +/// See also [TypeAlias](https://docs.python.org/3/library/ast.html#ast.TypeAlias) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtTypeAlias { + pub range: ruff_text_size::TextRange, + pub name: Box<Expr>, + pub type_params: Option<Box<crate::TypeParams>>, + pub value: Box<Expr>, +} + +/// See also [Assign](https://docs.python.org/3/library/ast.html#ast.Assign) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtAssign { + pub range: ruff_text_size::TextRange, + pub targets: Vec<Expr>, + pub value: Box<Expr>, +} + +/// See also [AugAssign](https://docs.python.org/3/library/ast.html#ast.AugAssign) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtAugAssign { + pub range: ruff_text_size::TextRange, + pub target: Box<Expr>, + pub op: crate::Operator, + pub value: Box<Expr>, +} + +/// See also [AnnAssign](https://docs.python.org/3/library/ast.html#ast.AnnAssign) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtAnnAssign { + pub range: ruff_text_size::TextRange, + pub target: Box<Expr>, + pub annotation: Box<Expr>, + pub value: Option<Box<Expr>>, + pub simple: bool, +} + +/// See also [For](https://docs.python.org/3/library/ast.html#ast.For) +/// and [AsyncFor](https://docs.python.org/3/library/ast.html#ast.AsyncFor). +/// +/// This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type. +#[derive(Clone, Debug, PartialEq)] +pub struct StmtFor { + pub range: ruff_text_size::TextRange, + pub is_async: bool, + pub target: Box<Expr>, + pub iter: Box<Expr>, + pub body: Vec<Stmt>, + pub orelse: Vec<Stmt>, +} + +/// See also [While](https://docs.python.org/3/library/ast.html#ast.While) +/// and [AsyncWhile](https://docs.python.org/3/library/ast.html#ast.AsyncWhile). +#[derive(Clone, Debug, PartialEq)] +pub struct StmtWhile { + pub range: ruff_text_size::TextRange, + pub test: Box<Expr>, + pub body: Vec<Stmt>, + pub orelse: Vec<Stmt>, +} + +/// See also [If](https://docs.python.org/3/library/ast.html#ast.If) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtIf { + pub range: ruff_text_size::TextRange, + pub test: Box<Expr>, + pub body: Vec<Stmt>, + pub elif_else_clauses: Vec<crate::ElifElseClause>, +} + +/// See also [With](https://docs.python.org/3/library/ast.html#ast.With) +/// and [AsyncWith](https://docs.python.org/3/library/ast.html#ast.AsyncWith). +/// +/// This type differs from the original Python AST, as it collapses the synchronous and asynchronous variants into a single type. +#[derive(Clone, Debug, PartialEq)] +pub struct StmtWith { + pub range: ruff_text_size::TextRange, + pub is_async: bool, + pub items: Vec<crate::WithItem>, + pub body: Vec<Stmt>, +} + +/// See also [Match](https://docs.python.org/3/library/ast.html#ast.Match) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtMatch { + pub range: ruff_text_size::TextRange, + pub subject: Box<Expr>, + pub cases: Vec<crate::MatchCase>, +} + +/// See also [Raise](https://docs.python.org/3/library/ast.html#ast.Raise) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtRaise { + pub range: ruff_text_size::TextRange, + pub exc: Option<Box<Expr>>, + pub cause: Option<Box<Expr>>, +} + +/// See also [Try](https://docs.python.org/3/library/ast.html#ast.Try) +/// and [TryStar](https://docs.python.org/3/library/ast.html#ast.TryStar) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtTry { + pub range: ruff_text_size::TextRange, + pub body: Vec<Stmt>, + pub handlers: Vec<ExceptHandler>, + pub orelse: Vec<Stmt>, + pub finalbody: Vec<Stmt>, + pub is_star: bool, +} + +/// See also [Assert](https://docs.python.org/3/library/ast.html#ast.Assert) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtAssert { + pub range: ruff_text_size::TextRange, + pub test: Box<Expr>, + pub msg: Option<Box<Expr>>, +} + +/// See also [Import](https://docs.python.org/3/library/ast.html#ast.Import) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtImport { + pub range: ruff_text_size::TextRange, + pub names: Vec<crate::Alias>, +} + +/// See also [ImportFrom](https://docs.python.org/3/library/ast.html#ast.ImportFrom) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtImportFrom { + pub range: ruff_text_size::TextRange, + pub module: Option<crate::Identifier>, + pub names: Vec<crate::Alias>, + pub level: u32, +} + +/// See also [Global](https://docs.python.org/3/library/ast.html#ast.Global) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtGlobal { + pub range: ruff_text_size::TextRange, + pub names: Vec<crate::Identifier>, +} + +/// See also [Nonlocal](https://docs.python.org/3/library/ast.html#ast.Nonlocal) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtNonlocal { + pub range: ruff_text_size::TextRange, + pub names: Vec<crate::Identifier>, +} + +/// See also [Expr](https://docs.python.org/3/library/ast.html#ast.Expr) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtExpr { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, +} + +/// See also [Pass](https://docs.python.org/3/library/ast.html#ast.Pass) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtPass { + pub range: ruff_text_size::TextRange, +} + +/// See also [Break](https://docs.python.org/3/library/ast.html#ast.Break) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtBreak { + pub range: ruff_text_size::TextRange, +} + +/// See also [Continue](https://docs.python.org/3/library/ast.html#ast.Continue) +#[derive(Clone, Debug, PartialEq)] +pub struct StmtContinue { + pub range: ruff_text_size::TextRange, +} + +/// An AST node used to represent a IPython escape command at the statement level. +/// +/// For example, +/// ```python +/// %matplotlib inline +/// ``` +/// +/// ## Terminology +/// +/// Escape commands are special IPython syntax which starts with a token to identify +/// the escape kind followed by the command value itself. [Escape kind] are the kind +/// of escape commands that are recognized by the token: `%`, `%%`, `!`, `!!`, +/// `?`, `??`, `/`, `;`, and `,`. +/// +/// Help command (or Dynamic Object Introspection as it's called) are the escape commands +/// of the kind `?` and `??`. For example, `?str.replace`. Help end command are a subset +/// of Help command where the token can be at the end of the line i.e., after the value. +/// For example, `str.replace?`. +/// +/// Here's where things get tricky. I'll divide the help end command into two types for +/// better understanding: +/// 1. Strict version: The token is _only_ at the end of the line. For example, +/// `str.replace?` or `str.replace??`. +/// 2. Combined version: Along with the `?` or `??` token, which are at the end of the +/// line, there are other escape kind tokens that are present at the start as well. +/// For example, `%matplotlib?` or `%%timeit?`. +/// +/// Priority comes into picture for the "Combined version" mentioned above. How do +/// we determine the escape kind if there are tokens on both side of the value, i.e., which +/// token to choose? The Help end command always takes priority over any other token which +/// means that if there is `?`/`??` at the end then that is used to determine the kind. +/// For example, in `%matplotlib?` the escape kind is determined using the `?` token +/// instead of `%` token. +/// +/// ## Syntax +/// +/// `<IpyEscapeKind><Command value>` +/// +/// The simplest form is an escape kind token followed by the command value. For example, +/// `%matplotlib inline`, `/foo`, `!pwd`, etc. +/// +/// `<Command value><IpyEscapeKind ("?" or "??")>` +/// +/// The help end escape command would be the reverse of the above syntax. Here, the +/// escape kind token can only be either `?` or `??` and it is at the end of the line. +/// For example, `str.replace?`, `math.pi??`, etc. +/// +/// `<IpyEscapeKind><Command value><EscapeKind ("?" or "??")>` +/// +/// The final syntax is the combined version of the above two. For example, `%matplotlib?`, +/// `%%timeit??`, etc. +/// +/// [Escape kind]: crate::IpyEscapeKind +/// +#[derive(Clone, Debug, PartialEq)] +pub struct StmtIpyEscapeCommand { + pub range: ruff_text_size::TextRange, + pub kind: crate::IpyEscapeKind, + pub value: Box<str>, +} + +/// See also [BoolOp](https://docs.python.org/3/library/ast.html#ast.BoolOp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprBoolOp { + pub range: ruff_text_size::TextRange, + pub op: crate::BoolOp, + pub values: Vec<Expr>, +} + +/// See also [NamedExpr](https://docs.python.org/3/library/ast.html#ast.NamedExpr) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprNamed { + pub range: ruff_text_size::TextRange, + pub target: Box<Expr>, + pub value: Box<Expr>, +} + +/// See also [BinOp](https://docs.python.org/3/library/ast.html#ast.BinOp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprBinOp { + pub range: ruff_text_size::TextRange, + pub left: Box<Expr>, + pub op: crate::Operator, + pub right: Box<Expr>, +} + +/// See also [UnaryOp](https://docs.python.org/3/library/ast.html#ast.UnaryOp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprUnaryOp { + pub range: ruff_text_size::TextRange, + pub op: crate::UnaryOp, + pub operand: Box<Expr>, +} + +/// See also [Lambda](https://docs.python.org/3/library/ast.html#ast.Lambda) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprLambda { + pub range: ruff_text_size::TextRange, + pub parameters: Option<Box<crate::Parameters>>, + pub body: Box<Expr>, +} + +/// See also [IfExp](https://docs.python.org/3/library/ast.html#ast.IfExp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprIf { + pub range: ruff_text_size::TextRange, + pub test: Box<Expr>, + pub body: Box<Expr>, + pub orelse: Box<Expr>, +} + +/// See also [Dict](https://docs.python.org/3/library/ast.html#ast.Dict) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprDict { + pub range: ruff_text_size::TextRange, + pub items: Vec<crate::DictItem>, +} + +/// See also [Set](https://docs.python.org/3/library/ast.html#ast.Set) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprSet { + pub range: ruff_text_size::TextRange, + pub elts: Vec<Expr>, +} + +/// See also [ListComp](https://docs.python.org/3/library/ast.html#ast.ListComp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprListComp { + pub range: ruff_text_size::TextRange, + pub elt: Box<Expr>, + pub generators: Vec<crate::Comprehension>, +} + +/// See also [SetComp](https://docs.python.org/3/library/ast.html#ast.SetComp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprSetComp { + pub range: ruff_text_size::TextRange, + pub elt: Box<Expr>, + pub generators: Vec<crate::Comprehension>, +} + +/// See also [DictComp](https://docs.python.org/3/library/ast.html#ast.DictComp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprDictComp { + pub range: ruff_text_size::TextRange, + pub key: Box<Expr>, + pub value: Box<Expr>, + pub generators: Vec<crate::Comprehension>, +} + +/// See also [GeneratorExp](https://docs.python.org/3/library/ast.html#ast.GeneratorExp) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprGenerator { + pub range: ruff_text_size::TextRange, + pub elt: Box<Expr>, + pub generators: Vec<crate::Comprehension>, + pub parenthesized: bool, +} + +/// See also [Await](https://docs.python.org/3/library/ast.html#ast.Await) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprAwait { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, +} + +/// See also [Yield](https://docs.python.org/3/library/ast.html#ast.Yield) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprYield { + pub range: ruff_text_size::TextRange, + pub value: Option<Box<Expr>>, +} + +/// See also [YieldFrom](https://docs.python.org/3/library/ast.html#ast.YieldFrom) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprYieldFrom { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, +} + +/// See also [Compare](https://docs.python.org/3/library/ast.html#ast.Compare) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprCompare { + pub range: ruff_text_size::TextRange, + pub left: Box<Expr>, + pub ops: Box<[crate::CmpOp]>, + pub comparators: Box<[Expr]>, +} + +/// See also [Call](https://docs.python.org/3/library/ast.html#ast.Call) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprCall { + pub range: ruff_text_size::TextRange, + pub func: Box<Expr>, + pub arguments: crate::Arguments, +} + +/// An AST node that represents either a single-part f-string literal +/// or an implicitly concatenated f-string literal. +/// +/// This type differs from the original Python AST `JoinedStr` in that it +/// doesn't join the implicitly concatenated parts into a single string. Instead, +/// it keeps them separate and provide various methods to access the parts. +/// +/// See also [JoinedStr](https://docs.python.org/3/library/ast.html#ast.JoinedStr) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprFString { + pub range: ruff_text_size::TextRange, + pub value: crate::FStringValue, +} + +/// An AST node that represents either a single-part string literal +/// or an implicitly concatenated string literal. +#[derive(Clone, Debug, PartialEq)] +pub struct ExprStringLiteral { + pub range: ruff_text_size::TextRange, + pub value: crate::StringLiteralValue, +} + +/// An AST node that represents either a single-part bytestring literal +/// or an implicitly concatenated bytestring literal. +#[derive(Clone, Debug, PartialEq)] +pub struct ExprBytesLiteral { + pub range: ruff_text_size::TextRange, + pub value: crate::BytesLiteralValue, +} + +#[derive(Clone, Debug, PartialEq)] +pub struct ExprNumberLiteral { + pub range: ruff_text_size::TextRange, + pub value: crate::Number, +} + +#[derive(Clone, Debug, PartialEq, Default)] +pub struct ExprBooleanLiteral { + pub range: ruff_text_size::TextRange, + pub value: bool, +} + +#[derive(Clone, Debug, PartialEq, Default)] +pub struct ExprNoneLiteral { + pub range: ruff_text_size::TextRange, +} + +#[derive(Clone, Debug, PartialEq, Default)] +pub struct ExprEllipsisLiteral { + pub range: ruff_text_size::TextRange, +} + +/// See also [Attribute](https://docs.python.org/3/library/ast.html#ast.Attribute) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprAttribute { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, + pub attr: crate::Identifier, + pub ctx: crate::ExprContext, +} + +/// See also [Subscript](https://docs.python.org/3/library/ast.html#ast.Subscript) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprSubscript { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, + pub slice: Box<Expr>, + pub ctx: crate::ExprContext, +} + +/// See also [Starred](https://docs.python.org/3/library/ast.html#ast.Starred) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprStarred { + pub range: ruff_text_size::TextRange, + pub value: Box<Expr>, + pub ctx: crate::ExprContext, +} + +/// See also [Name](https://docs.python.org/3/library/ast.html#ast.Name) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprName { + pub range: ruff_text_size::TextRange, + pub id: Name, + pub ctx: crate::ExprContext, +} + +/// See also [List](https://docs.python.org/3/library/ast.html#ast.List) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprList { + pub range: ruff_text_size::TextRange, + pub elts: Vec<Expr>, + pub ctx: crate::ExprContext, +} + +/// See also [Tuple](https://docs.python.org/3/library/ast.html#ast.Tuple) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprTuple { + pub range: ruff_text_size::TextRange, + pub elts: Vec<Expr>, + pub ctx: crate::ExprContext, + pub parenthesized: bool, +} + +/// See also [Slice](https://docs.python.org/3/library/ast.html#ast.Slice) +#[derive(Clone, Debug, PartialEq)] +pub struct ExprSlice { + pub range: ruff_text_size::TextRange, + pub lower: Option<Box<Expr>>, + pub upper: Option<Box<Expr>>, + pub step: Option<Box<Expr>>, +} + +/// An AST node used to represent a IPython escape command at the expression level. +/// +/// For example, +/// ```python +/// dir = !pwd +/// ``` +/// +/// Here, the escape kind can only be `!` or `%` otherwise it is a syntax error. +/// +/// For more information related to terminology and syntax of escape commands, +/// see [`StmtIpyEscapeCommand`]. +#[derive(Clone, Debug, PartialEq)] +pub struct ExprIpyEscapeCommand { + pub range: ruff_text_size::TextRange, + pub kind: crate::IpyEscapeKind, + pub value: Box<str>, +} + +impl ModModule { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ModModule { body, range: _ } = self; + visitor.visit_body(body); + } +} + +impl ModExpression { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ModExpression { body, range: _ } = self; + visitor.visit_expr(body); + } +} + +impl StmtFunctionDef { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtFunctionDef { + is_async: _, + decorator_list, + name, + type_params, + parameters, + returns, + body, + range: _, + } = self; + + for elm in decorator_list { + visitor.visit_decorator(elm); + } + visitor.visit_identifier(name); + + if let Some(type_params) = type_params { + visitor.visit_type_params(type_params); + } + + visitor.visit_parameters(parameters); + + if let Some(returns) = returns { + visitor.visit_annotation(returns); + } + + visitor.visit_body(body); + } +} + +impl StmtClassDef { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtClassDef { + decorator_list, + name, + type_params, + arguments, + body, + range: _, + } = self; + + for elm in decorator_list { + visitor.visit_decorator(elm); + } + visitor.visit_identifier(name); + + if let Some(type_params) = type_params { + visitor.visit_type_params(type_params); + } + + if let Some(arguments) = arguments { + visitor.visit_arguments(arguments); + } + + visitor.visit_body(body); + } +} + +impl StmtReturn { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtReturn { value, range: _ } = self; + + if let Some(value) = value { + visitor.visit_expr(value); + } + } +} + +impl StmtDelete { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtDelete { targets, range: _ } = self; + + for elm in targets { + visitor.visit_expr(elm); + } + } +} + +impl StmtTypeAlias { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtTypeAlias { + name, + type_params, + value, + range: _, + } = self; + visitor.visit_expr(name); + + if let Some(type_params) = type_params { + visitor.visit_type_params(type_params); + } + + visitor.visit_expr(value); + } +} + +impl StmtAssign { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtAssign { + targets, + value, + range: _, + } = self; + + for elm in targets { + visitor.visit_expr(elm); + } + visitor.visit_expr(value); + } +} + +impl StmtAugAssign { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtAugAssign { + target, + op, + value, + range: _, + } = self; + visitor.visit_expr(target); + visitor.visit_operator(op); + visitor.visit_expr(value); + } +} + +impl StmtAnnAssign { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtAnnAssign { + target, + annotation, + value, + simple: _, + range: _, + } = self; + visitor.visit_expr(target); + visitor.visit_annotation(annotation); + + if let Some(value) = value { + visitor.visit_expr(value); + } + } +} + +impl StmtFor { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtFor { + is_async: _, + target, + iter, + body, + orelse, + range: _, + } = self; + visitor.visit_expr(target); + visitor.visit_expr(iter); + visitor.visit_body(body); + visitor.visit_body(orelse); + } +} + +impl StmtWhile { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtWhile { + test, + body, + orelse, + range: _, + } = self; + visitor.visit_expr(test); + visitor.visit_body(body); + visitor.visit_body(orelse); + } +} + +impl StmtIf { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtIf { + test, + body, + elif_else_clauses, + range: _, + } = self; + visitor.visit_expr(test); + visitor.visit_body(body); + + for elm in elif_else_clauses { + visitor.visit_elif_else_clause(elm); + } + } +} + +impl StmtWith { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtWith { + is_async: _, + items, + body, + range: _, + } = self; + + for elm in items { + visitor.visit_with_item(elm); + } + visitor.visit_body(body); + } +} + +impl StmtMatch { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtMatch { + subject, + cases, + range: _, + } = self; + visitor.visit_expr(subject); + + for elm in cases { + visitor.visit_match_case(elm); + } + } +} + +impl StmtRaise { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtRaise { + exc, + cause, + range: _, + } = self; + + if let Some(exc) = exc { + visitor.visit_expr(exc); + } + + if let Some(cause) = cause { + visitor.visit_expr(cause); + } + } +} + +impl StmtTry { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtTry { + body, + handlers, + orelse, + finalbody, + is_star: _, + range: _, + } = self; + visitor.visit_body(body); + + for elm in handlers { + visitor.visit_except_handler(elm); + } + visitor.visit_body(orelse); + visitor.visit_body(finalbody); + } +} + +impl StmtAssert { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtAssert { + test, + msg, + range: _, + } = self; + visitor.visit_expr(test); + + if let Some(msg) = msg { + visitor.visit_expr(msg); + } + } +} + +impl StmtImport { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtImport { names, range: _ } = self; + + for elm in names { + visitor.visit_alias(elm); + } + } +} + +impl StmtImportFrom { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtImportFrom { + module, + names, + level: _, + range: _, + } = self; + + if let Some(module) = module { + visitor.visit_identifier(module); + } + + for elm in names { + visitor.visit_alias(elm); + } + } +} + +impl StmtGlobal { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtGlobal { names, range: _ } = self; + + for elm in names { + visitor.visit_identifier(elm); + } + } +} + +impl StmtNonlocal { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtNonlocal { names, range: _ } = self; + + for elm in names { + visitor.visit_identifier(elm); + } + } +} + +impl StmtExpr { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtExpr { value, range: _ } = self; + visitor.visit_expr(value); + } +} + +impl StmtPass { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtPass { range: _ } = self; + } +} + +impl StmtBreak { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtBreak { range: _ } = self; + } +} + +impl StmtContinue { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtContinue { range: _ } = self; + } +} + +impl StmtIpyEscapeCommand { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let StmtIpyEscapeCommand { + kind: _, + value: _, + range: _, + } = self; + } +} + +impl ExprNamed { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprNamed { + target, + value, + range: _, + } = self; + visitor.visit_expr(target); + visitor.visit_expr(value); + } +} + +impl ExprBinOp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprBinOp { + left, + op, + right, + range: _, + } = self; + visitor.visit_expr(left); + visitor.visit_operator(op); + visitor.visit_expr(right); + } +} + +impl ExprUnaryOp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprUnaryOp { + op, + operand, + range: _, + } = self; + visitor.visit_unary_op(op); + visitor.visit_expr(operand); + } +} + +impl ExprLambda { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprLambda { + parameters, + body, + range: _, + } = self; + + if let Some(parameters) = parameters { + visitor.visit_parameters(parameters); + } + + visitor.visit_expr(body); + } +} + +impl ExprIf { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprIf { + test, + body, + orelse, + range: _, + } = self; + visitor.visit_expr(body); + visitor.visit_expr(test); + visitor.visit_expr(orelse); + } +} + +impl ExprSet { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprSet { elts, range: _ } = self; + + for elm in elts { + visitor.visit_expr(elm); + } + } +} + +impl ExprListComp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprListComp { + elt, + generators, + range: _, + } = self; + visitor.visit_expr(elt); + + for elm in generators { + visitor.visit_comprehension(elm); + } + } +} + +impl ExprSetComp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprSetComp { + elt, + generators, + range: _, + } = self; + visitor.visit_expr(elt); + + for elm in generators { + visitor.visit_comprehension(elm); + } + } +} + +impl ExprDictComp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprDictComp { + key, + value, + generators, + range: _, + } = self; + visitor.visit_expr(key); + visitor.visit_expr(value); + + for elm in generators { + visitor.visit_comprehension(elm); + } + } +} + +impl ExprGenerator { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprGenerator { + elt, + generators, + parenthesized: _, + range: _, + } = self; + visitor.visit_expr(elt); + + for elm in generators { + visitor.visit_comprehension(elm); + } + } +} + +impl ExprAwait { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprAwait { value, range: _ } = self; + visitor.visit_expr(value); + } +} + +impl ExprYield { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprYield { value, range: _ } = self; + + if let Some(value) = value { + visitor.visit_expr(value); + } + } +} + +impl ExprYieldFrom { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprYieldFrom { value, range: _ } = self; + visitor.visit_expr(value); + } +} + +impl ExprCall { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprCall { + func, + arguments, + range: _, + } = self; + visitor.visit_expr(func); + visitor.visit_arguments(arguments); + } +} + +impl ExprNumberLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprNumberLiteral { value: _, range: _ } = self; + } +} + +impl ExprBooleanLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprBooleanLiteral { value: _, range: _ } = self; + } +} + +impl ExprNoneLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprNoneLiteral { range: _ } = self; + } +} + +impl ExprEllipsisLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprEllipsisLiteral { range: _ } = self; + } +} + +impl ExprAttribute { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprAttribute { + value, + attr, + ctx: _, + range: _, + } = self; + visitor.visit_expr(value); + visitor.visit_identifier(attr); + } +} + +impl ExprSubscript { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprSubscript { + value, + slice, + ctx: _, + range: _, + } = self; + visitor.visit_expr(value); + visitor.visit_expr(slice); + } +} + +impl ExprStarred { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprStarred { + value, + ctx: _, + range: _, + } = self; + visitor.visit_expr(value); + } +} + +impl ExprName { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprName { + id: _, + ctx: _, + range: _, + } = self; + } +} + +impl ExprList { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprList { + elts, + ctx: _, + range: _, + } = self; + + for elm in elts { + visitor.visit_expr(elm); + } + } +} + +impl ExprTuple { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprTuple { + elts, + ctx: _, + parenthesized: _, + range: _, + } = self; + + for elm in elts { + visitor.visit_expr(elm); + } + } +} + +impl ExprSlice { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprSlice { + lower, + upper, + step, + range: _, + } = self; + + if let Some(lower) = lower { + visitor.visit_expr(lower); + } + + if let Some(upper) = upper { + visitor.visit_expr(upper); + } + + if let Some(step) = step { + visitor.visit_expr(step); + } + } +} + +impl ExprIpyEscapeCommand { + pub(crate) fn visit_source_order<'a, V>(&'a self, _: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ExprIpyEscapeCommand { + kind: _, + value: _, + range: _, + } = self; + } +} diff --git a/crates/ruff_python_ast/src/hashable.rs b/crates/ruff_python_ast/src/hashable.rs deleted file mode 100644 index 7332716db4594..0000000000000 --- a/crates/ruff_python_ast/src/hashable.rs +++ /dev/null @@ -1,40 +0,0 @@ -use std::hash::Hash; - -use crate::Expr; - -use crate::comparable::ComparableExpr; - -/// Wrapper around `Expr` that implements `Hash` and `PartialEq`. -pub struct HashableExpr<'a>(&'a Expr); - -impl Hash for HashableExpr<'_> { - fn hash<H: std::hash::Hasher>(&self, state: &mut H) { - let comparable = ComparableExpr::from(self.0); - comparable.hash(state); - } -} - -impl PartialEq<Self> for HashableExpr<'_> { - fn eq(&self, other: &Self) -> bool { - let comparable = ComparableExpr::from(self.0); - comparable == ComparableExpr::from(other.0) - } -} - -impl Eq for HashableExpr<'_> {} - -impl<'a> From<&'a Expr> for HashableExpr<'a> { - fn from(expr: &'a Expr) -> Self { - Self(expr) - } -} - -impl<'a> HashableExpr<'a> { - pub const fn from_expr(expr: &'a Expr) -> Self { - Self(expr) - } - - pub const fn as_expr(&self) -> &'a Expr { - self.0 - } -} diff --git a/crates/ruff_python_ast/src/helpers.rs b/crates/ruff_python_ast/src/helpers.rs index 3a95065cbfa67..0464c636f43c4 100644 --- a/crates/ruff_python_ast/src/helpers.rs +++ b/crates/ruff_python_ast/src/helpers.rs @@ -3,7 +3,7 @@ use std::path::Path; use rustc_hash::FxHashMap; -use ruff_python_trivia::{indentation_at_offset, CommentRanges, SimpleTokenKind, SimpleTokenizer}; +use ruff_python_trivia::{CommentRanges, SimpleTokenKind, SimpleTokenizer, indentation_at_offset}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; @@ -12,8 +12,8 @@ use crate::parenthesize::parenthesized_range; use crate::statement_visitor::StatementVisitor; use crate::visitor::Visitor; use crate::{ - self as ast, Arguments, CmpOp, ExceptHandler, Expr, FStringElement, MatchCase, Operator, - Pattern, Stmt, TypeParam, + self as ast, Arguments, CmpOp, DictItem, ExceptHandler, Expr, FStringElement, MatchCase, + Operator, Pattern, Stmt, TypeParam, }; use crate::{AnyNodeRef, ExprContext}; @@ -548,6 +548,13 @@ pub fn is_dunder(id: &str) -> bool { id.starts_with("__") && id.ends_with("__") } +/// Whether a name starts and ends with a single underscore. +/// +/// `_a__` is considered neither a dunder nor a sunder name. +pub fn is_sunder(id: &str) -> bool { + id.starts_with('_') && id.ends_with('_') && !id.starts_with("__") && !id.ends_with("__") +} + /// Return `true` if the [`Stmt`] is an assignment to a dunder (like `__all__`). pub fn is_assignment_to_a_dunder(stmt: &Stmt) -> bool { // Check whether it's an assignment to a dunder, with or without a type @@ -1118,6 +1125,8 @@ pub enum Truthiness { Falsey, /// The expression evaluates to a `True`-like value (e.g., `1`, `"foo"`). Truthy, + /// The expression evaluates to `None`. + None, /// The expression evaluates to an unknown value (e.g., a variable `x` of unknown type). Unknown, } @@ -1173,7 +1182,7 @@ impl Truthiness { Self::False } } - Expr::NoneLiteral(_) => Self::Falsey, + Expr::NoneLiteral(_) => Self::None, Expr::EllipsisLiteral(_) => Self::Truthy, Expr::FString(f_string) => { if is_empty_f_string(f_string) { @@ -1188,14 +1197,32 @@ impl Truthiness { | Expr::Set(ast::ExprSet { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { if elts.is_empty() { - Self::Falsey + return Self::Falsey; + } + + if elts.iter().all(Expr::is_starred_expr) { + // [*foo] / [*foo, *bar] + Self::Unknown } else { Self::Truthy } } Expr::Dict(dict) => { if dict.is_empty() { - Self::Falsey + return Self::Falsey; + } + + if dict.items.iter().all(|item| { + matches!( + item, + DictItem { + key: None, + value: Expr::Name(..) + } + ) + }) { + // {**foo} / {**foo, **bar} + Self::Unknown } else { Self::Truthy } @@ -1229,6 +1256,7 @@ impl Truthiness { match self { Self::True | Self::Truthy => Some(true), Self::False | Self::Falsey => Some(false), + Self::None => Some(false), Self::Unknown => None, } } @@ -1416,33 +1444,22 @@ pub fn typing_optional(elt: Expr, binding: Name) -> Expr { } /// Format the expressions as a `typing.Union`-style union. +/// +/// Note: It is a syntax error to have `Union[]` so the caller +/// should ensure that the `elts` argument is nonempty. pub fn typing_union(elts: &[Expr], binding: Name) -> Expr { - fn tuple(elts: &[Expr], binding: Name) -> Expr { - match elts { - [] => Expr::Tuple(ast::ExprTuple { - elts: vec![], - ctx: ExprContext::Load, - range: TextRange::default(), - parenthesized: true, - }), - [Expr::Tuple(ast::ExprTuple { elts, .. })] => typing_union(elts, binding), - [elt] => elt.clone(), - [rest @ .., elt] => Expr::BinOp(ast::ExprBinOp { - left: Box::new(tuple(rest, binding)), - op: Operator::BitOr, - right: Box::new(elt.clone()), - range: TextRange::default(), - }), - } - } - Expr::Subscript(ast::ExprSubscript { value: Box::new(Expr::Name(ast::ExprName { - id: binding.clone(), + id: binding, + range: TextRange::default(), + ctx: ExprContext::Load, + })), + slice: Box::new(Expr::Tuple(ast::ExprTuple { range: TextRange::default(), + elts: elts.to_vec(), ctx: ExprContext::Load, + parenthesized: false, })), - slice: Box::new(tuple(elts, binding)), ctx: ExprContext::Load, range: TextRange::default(), }) @@ -1605,10 +1622,10 @@ mod tests { }); let type_alias = Stmt::TypeAlias(StmtTypeAlias { name: Box::new(name.clone()), - type_params: Some(TypeParams { + type_params: Some(Box::new(TypeParams { type_params: vec![type_var_one, type_var_two], range: TextRange::default(), - }), + })), value: Box::new(constant_three.clone()), range: TextRange::default(), }); diff --git a/crates/ruff_python_ast/src/identifier.rs b/crates/ruff_python_ast/src/identifier.rs index 566b9c79251be..c8a54cbadf264 100644 --- a/crates/ruff_python_ast/src/identifier.rs +++ b/crates/ruff_python_ast/src/identifier.rs @@ -13,7 +13,7 @@ use crate::{self as ast, Alias, ExceptHandler, Parameter, ParameterWithDefault, Stmt}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; -use ruff_python_trivia::{is_python_whitespace, Cursor}; +use ruff_python_trivia::{Cursor, is_python_whitespace}; pub trait Identifier { /// Return the [`TextRange`] of the identifier in the given AST node. @@ -207,7 +207,7 @@ impl<'a> IdentifierTokenizer<'a> { _ => { // Nothing to do. } - }; + } } None diff --git a/crates/ruff_python_ast/src/int.rs b/crates/ruff_python_ast/src/int.rs index bbcf1b0b2a349..4d918f5574354 100644 --- a/crates/ruff_python_ast/src/int.rs +++ b/crates/ruff_python_ast/src/int.rs @@ -96,7 +96,7 @@ impl Int { } } - /// Return the [`Int`] as an u64, if it can be represented as that data type. + /// Return the [`Int`] as an usize, if it can be represented as that data type. pub fn as_usize(&self) -> Option<usize> { match &self.0 { Number::Small(small) => usize::try_from(*small).ok(), diff --git a/crates/ruff_python_ast/src/lib.rs b/crates/ruff_python_ast/src/lib.rs index b149bdddc8430..7983ccee82190 100644 --- a/crates/ruff_python_ast/src/lib.rs +++ b/crates/ruff_python_ast/src/lib.rs @@ -2,21 +2,25 @@ use std::ffi::OsStr; use std::path::Path; pub use expression::*; +pub use generated::*; pub use int::*; -pub use node::{AnyNode, AnyNodeRef, AstNode, NodeKind}; pub use nodes::*; +pub use operator_precedence::*; +pub use python_version::*; pub mod comparable; pub mod docstrings; mod expression; -pub mod hashable; +mod generated; pub mod helpers; pub mod identifier; mod int; pub mod name; mod node; mod nodes; +pub mod operator_precedence; pub mod parenthesize; +mod python_version; pub mod relocate; pub mod script; pub mod statement_visitor; @@ -69,7 +73,7 @@ pub enum TomlSourceType { Unrecognized, } -#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] +#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub enum PySourceType { /// The source is a Python file (`.py`). diff --git a/crates/ruff_python_ast/src/name.rs b/crates/ruff_python_ast/src/name.rs index 58da7e14592f5..f57f4ebdf7ed3 100644 --- a/crates/ruff_python_ast/src/name.rs +++ b/crates/ruff_python_ast/src/name.rs @@ -3,11 +3,13 @@ use std::fmt::{Debug, Display, Formatter, Write}; use std::hash::{Hash, Hasher}; use std::ops::Deref; -use crate::{nodes, Expr}; +use crate::Expr; +use crate::generated::ExprName; #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] #[cfg_attr(feature = "cache", derive(ruff_macros::CacheKey))] +#[cfg_attr(feature = "salsa", derive(salsa::Update))] pub struct Name(compact_str::CompactString); impl Name { @@ -190,14 +192,14 @@ impl schemars::JsonSchema for Name { String::schema_id() } - fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { - String::json_schema(gen) + fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> schemars::schema::Schema { + String::json_schema(generator) } fn _schemars_private_non_optional_json_schema( - gen: &mut schemars::gen::SchemaGenerator, + generator: &mut schemars::r#gen::SchemaGenerator, ) -> schemars::schema::Schema { - String::_schemars_private_non_optional_json_schema(gen) + String::_schemars_private_non_optional_json_schema(generator) } fn _schemars_private_is_option() -> bool { @@ -277,6 +279,14 @@ impl<'a> QualifiedName<'a> { inner.push(member); Self(inner) } + + /// Extends the qualified name using the given members. + #[must_use] + pub fn extend_members<T: IntoIterator<Item = &'a str>>(self, members: T) -> Self { + let mut inner = self.0; + inner.extend(members); + Self(inner) + } } impl Display for QualifiedName<'_> { @@ -378,17 +388,15 @@ impl<'a> UnqualifiedName<'a> { let attr1 = match expr { Expr::Attribute(attr1) => attr1, // Ex) `foo` - Expr::Name(nodes::ExprName { id, .. }) => { - return Some(Self::from_slice(&[id.as_str()])) - } + Expr::Name(ExprName { id, .. }) => return Some(Self::from_slice(&[id.as_str()])), _ => return None, }; let attr2 = match attr1.value.as_ref() { Expr::Attribute(attr2) => attr2, // Ex) `foo.bar` - Expr::Name(nodes::ExprName { id, .. }) => { - return Some(Self::from_slice(&[id.as_str(), attr1.attr.as_str()])) + Expr::Name(ExprName { id, .. }) => { + return Some(Self::from_slice(&[id.as_str(), attr1.attr.as_str()])); } _ => return None, }; @@ -396,7 +404,7 @@ impl<'a> UnqualifiedName<'a> { let attr3 = match attr2.value.as_ref() { Expr::Attribute(attr3) => attr3, // Ex) `foo.bar.baz` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self::from_slice(&[ id.as_str(), attr2.attr.as_str(), @@ -409,7 +417,7 @@ impl<'a> UnqualifiedName<'a> { let attr4 = match attr3.value.as_ref() { Expr::Attribute(attr4) => attr4, // Ex) `foo.bar.baz.bop` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self::from_slice(&[ id.as_str(), attr3.attr.as_str(), @@ -423,7 +431,7 @@ impl<'a> UnqualifiedName<'a> { let attr5 = match attr4.value.as_ref() { Expr::Attribute(attr5) => attr5, // Ex) `foo.bar.baz.bop.bap` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self::from_slice(&[ id.as_str(), attr4.attr.as_str(), @@ -438,7 +446,7 @@ impl<'a> UnqualifiedName<'a> { let attr6 = match attr5.value.as_ref() { Expr::Attribute(attr6) => attr6, // Ex) `foo.bar.baz.bop.bap.bab` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self::from_slice(&[ id.as_str(), attr5.attr.as_str(), @@ -454,7 +462,7 @@ impl<'a> UnqualifiedName<'a> { let attr7 = match attr6.value.as_ref() { Expr::Attribute(attr7) => attr7, // Ex) `foo.bar.baz.bop.bap.bab.bob` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self::from_slice(&[ id.as_str(), attr6.attr.as_str(), @@ -471,7 +479,7 @@ impl<'a> UnqualifiedName<'a> { let attr8 = match attr7.value.as_ref() { Expr::Attribute(attr8) => attr8, // Ex) `foo.bar.baz.bop.bap.bab.bob.bib` - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { return Some(Self(SegmentsVec::from([ id.as_str(), attr7.attr.as_str(), @@ -496,7 +504,7 @@ impl<'a> UnqualifiedName<'a> { segments.push(attr.attr.as_str()); &*attr.value } - Expr::Name(nodes::ExprName { id, .. }) => { + Expr::Name(ExprName { id, .. }) => { segments.push(id.as_str()); break; } @@ -669,7 +677,7 @@ impl<'a> Deref for SegmentsVec<'a> { } } -impl<'a, 'b> PartialEq<SegmentsVec<'b>> for SegmentsVec<'a> { +impl<'b> PartialEq<SegmentsVec<'b>> for SegmentsVec<'_> { fn eq(&self, other: &SegmentsVec<'b>) -> bool { self.as_slice() == other.as_slice() } diff --git a/crates/ruff_python_ast/src/node.rs b/crates/ruff_python_ast/src/node.rs index 0eb967e0c440a..8e7a10bc528f7 100644 --- a/crates/ruff_python_ast/src/node.rs +++ b/crates/ruff_python_ast/src/node.rs @@ -1,8304 +1,847 @@ +use ruff_text_size::Ranged; + use crate::visitor::source_order::SourceOrderVisitor; use crate::{ - self as ast, Alias, AnyParameterRef, ArgOrKeyword, Arguments, Comprehension, Decorator, - ExceptHandler, Expr, FStringElement, Keyword, MatchCase, Mod, Parameter, ParameterWithDefault, - Parameters, Pattern, PatternArguments, PatternKeyword, Stmt, StmtAnnAssign, StmtAssert, - StmtAssign, StmtAugAssign, StmtBreak, StmtClassDef, StmtContinue, StmtDelete, StmtExpr, - StmtFor, StmtFunctionDef, StmtGlobal, StmtIf, StmtImport, StmtImportFrom, StmtIpyEscapeCommand, - StmtMatch, StmtNonlocal, StmtPass, StmtRaise, StmtReturn, StmtTry, StmtTypeAlias, StmtWhile, - StmtWith, TypeParam, TypeParamParamSpec, TypeParamTypeVar, TypeParamTypeVarTuple, TypeParams, - WithItem, + self as ast, Alias, AnyNodeRef, AnyParameterRef, ArgOrKeyword, MatchCase, PatternArguments, + PatternKeyword, }; -use ruff_text_size::{Ranged, TextRange}; -use std::ptr::NonNull; - -pub trait AstNode: Ranged { - type Ref<'a>; - - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized; - fn cast_ref(kind: AnyNodeRef<'_>) -> Option<Self::Ref<'_>>; - - fn can_cast(kind: NodeKind) -> bool; - - /// Returns the [`AnyNodeRef`] referencing this node. - fn as_any_node_ref(&self) -> AnyNodeRef; - - /// Consumes `self` and returns its [`AnyNode`] representation. - fn into_any_node(self) -> AnyNode; - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::ElifElseClause { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - V: SourceOrderVisitor<'a> + ?Sized; -} - -#[derive(Clone, Debug, is_macro::Is, PartialEq)] -pub enum AnyNode { - ModModule(ast::ModModule), - ModExpression(ast::ModExpression), - StmtFunctionDef(ast::StmtFunctionDef), - StmtClassDef(ast::StmtClassDef), - StmtReturn(ast::StmtReturn), - StmtDelete(ast::StmtDelete), - StmtTypeAlias(ast::StmtTypeAlias), - StmtAssign(ast::StmtAssign), - StmtAugAssign(ast::StmtAugAssign), - StmtAnnAssign(ast::StmtAnnAssign), - StmtFor(ast::StmtFor), - StmtWhile(ast::StmtWhile), - StmtIf(ast::StmtIf), - StmtWith(ast::StmtWith), - StmtMatch(ast::StmtMatch), - StmtRaise(ast::StmtRaise), - StmtTry(ast::StmtTry), - StmtAssert(ast::StmtAssert), - StmtImport(ast::StmtImport), - StmtImportFrom(ast::StmtImportFrom), - StmtGlobal(ast::StmtGlobal), - StmtNonlocal(ast::StmtNonlocal), - StmtExpr(ast::StmtExpr), - StmtPass(ast::StmtPass), - StmtBreak(ast::StmtBreak), - StmtContinue(ast::StmtContinue), - StmtIpyEscapeCommand(ast::StmtIpyEscapeCommand), - ExprBoolOp(ast::ExprBoolOp), - ExprNamed(ast::ExprNamed), - ExprBinOp(ast::ExprBinOp), - ExprUnaryOp(ast::ExprUnaryOp), - ExprLambda(ast::ExprLambda), - ExprIf(ast::ExprIf), - ExprDict(ast::ExprDict), - ExprSet(ast::ExprSet), - ExprListComp(ast::ExprListComp), - ExprSetComp(ast::ExprSetComp), - ExprDictComp(ast::ExprDictComp), - ExprGenerator(ast::ExprGenerator), - ExprAwait(ast::ExprAwait), - ExprYield(ast::ExprYield), - ExprYieldFrom(ast::ExprYieldFrom), - ExprCompare(ast::ExprCompare), - ExprCall(ast::ExprCall), - ExprFString(ast::ExprFString), - ExprStringLiteral(ast::ExprStringLiteral), - ExprBytesLiteral(ast::ExprBytesLiteral), - ExprNumberLiteral(ast::ExprNumberLiteral), - ExprBooleanLiteral(ast::ExprBooleanLiteral), - ExprNoneLiteral(ast::ExprNoneLiteral), - ExprEllipsisLiteral(ast::ExprEllipsisLiteral), - ExprAttribute(ast::ExprAttribute), - ExprSubscript(ast::ExprSubscript), - ExprStarred(ast::ExprStarred), - ExprName(ast::ExprName), - ExprList(ast::ExprList), - ExprTuple(ast::ExprTuple), - ExprSlice(ast::ExprSlice), - ExprIpyEscapeCommand(ast::ExprIpyEscapeCommand), - ExceptHandlerExceptHandler(ast::ExceptHandlerExceptHandler), - FStringExpressionElement(ast::FStringExpressionElement), - FStringLiteralElement(ast::FStringLiteralElement), - FStringFormatSpec(ast::FStringFormatSpec), - PatternMatchValue(ast::PatternMatchValue), - PatternMatchSingleton(ast::PatternMatchSingleton), - PatternMatchSequence(ast::PatternMatchSequence), - PatternMatchMapping(ast::PatternMatchMapping), - PatternMatchClass(ast::PatternMatchClass), - PatternMatchStar(ast::PatternMatchStar), - PatternMatchAs(ast::PatternMatchAs), - PatternMatchOr(ast::PatternMatchOr), - PatternArguments(PatternArguments), - PatternKeyword(PatternKeyword), - Comprehension(Comprehension), - Arguments(Arguments), - Parameters(Parameters), - Parameter(Parameter), - ParameterWithDefault(ParameterWithDefault), - Keyword(Keyword), - Alias(Alias), - WithItem(WithItem), - MatchCase(MatchCase), - Decorator(Decorator), - ElifElseClause(ast::ElifElseClause), - TypeParams(TypeParams), - TypeParamTypeVar(TypeParamTypeVar), - TypeParamTypeVarTuple(TypeParamTypeVarTuple), - TypeParamParamSpec(TypeParamParamSpec), - FString(ast::FString), - StringLiteral(ast::StringLiteral), - BytesLiteral(ast::BytesLiteral), - Identifier(ast::Identifier), -} - -impl AnyNode { - pub fn statement(self) -> Option<Stmt> { - Stmt::cast(self) - } - - pub fn expression(self) -> Option<Expr> { - match self { - AnyNode::ExprBoolOp(node) => Some(Expr::BoolOp(node)), - AnyNode::ExprNamed(node) => Some(Expr::Named(node)), - AnyNode::ExprBinOp(node) => Some(Expr::BinOp(node)), - AnyNode::ExprUnaryOp(node) => Some(Expr::UnaryOp(node)), - AnyNode::ExprLambda(node) => Some(Expr::Lambda(node)), - AnyNode::ExprIf(node) => Some(Expr::If(node)), - AnyNode::ExprDict(node) => Some(Expr::Dict(node)), - AnyNode::ExprSet(node) => Some(Expr::Set(node)), - AnyNode::ExprListComp(node) => Some(Expr::ListComp(node)), - AnyNode::ExprSetComp(node) => Some(Expr::SetComp(node)), - AnyNode::ExprDictComp(node) => Some(Expr::DictComp(node)), - AnyNode::ExprGenerator(node) => Some(Expr::Generator(node)), - AnyNode::ExprAwait(node) => Some(Expr::Await(node)), - AnyNode::ExprYield(node) => Some(Expr::Yield(node)), - AnyNode::ExprYieldFrom(node) => Some(Expr::YieldFrom(node)), - AnyNode::ExprCompare(node) => Some(Expr::Compare(node)), - AnyNode::ExprCall(node) => Some(Expr::Call(node)), - AnyNode::ExprFString(node) => Some(Expr::FString(node)), - AnyNode::ExprStringLiteral(node) => Some(Expr::StringLiteral(node)), - AnyNode::ExprBytesLiteral(node) => Some(Expr::BytesLiteral(node)), - AnyNode::ExprNumberLiteral(node) => Some(Expr::NumberLiteral(node)), - AnyNode::ExprBooleanLiteral(node) => Some(Expr::BooleanLiteral(node)), - AnyNode::ExprNoneLiteral(node) => Some(Expr::NoneLiteral(node)), - AnyNode::ExprEllipsisLiteral(node) => Some(Expr::EllipsisLiteral(node)), - AnyNode::ExprAttribute(node) => Some(Expr::Attribute(node)), - AnyNode::ExprSubscript(node) => Some(Expr::Subscript(node)), - AnyNode::ExprStarred(node) => Some(Expr::Starred(node)), - AnyNode::ExprName(node) => Some(Expr::Name(node)), - AnyNode::ExprList(node) => Some(Expr::List(node)), - AnyNode::ExprTuple(node) => Some(Expr::Tuple(node)), - AnyNode::ExprSlice(node) => Some(Expr::Slice(node)), - AnyNode::ExprIpyEscapeCommand(node) => Some(Expr::IpyEscapeCommand(node)), - - AnyNode::ModModule(_) - | AnyNode::ModExpression(_) - | AnyNode::StmtFunctionDef(_) - | AnyNode::StmtClassDef(_) - | AnyNode::StmtReturn(_) - | AnyNode::StmtDelete(_) - | AnyNode::StmtTypeAlias(_) - | AnyNode::StmtAssign(_) - | AnyNode::StmtAugAssign(_) - | AnyNode::StmtAnnAssign(_) - | AnyNode::StmtFor(_) - | AnyNode::StmtWhile(_) - | AnyNode::StmtIf(_) - | AnyNode::StmtWith(_) - | AnyNode::StmtMatch(_) - | AnyNode::StmtRaise(_) - | AnyNode::StmtTry(_) - | AnyNode::StmtAssert(_) - | AnyNode::StmtImport(_) - | AnyNode::StmtImportFrom(_) - | AnyNode::StmtGlobal(_) - | AnyNode::StmtNonlocal(_) - | AnyNode::StmtExpr(_) - | AnyNode::StmtPass(_) - | AnyNode::StmtBreak(_) - | AnyNode::StmtContinue(_) - | AnyNode::StmtIpyEscapeCommand(_) - | AnyNode::ExceptHandlerExceptHandler(_) - | AnyNode::FStringExpressionElement(_) - | AnyNode::FStringLiteralElement(_) - | AnyNode::FStringFormatSpec(_) - | AnyNode::PatternMatchValue(_) - | AnyNode::PatternMatchSingleton(_) - | AnyNode::PatternMatchSequence(_) - | AnyNode::PatternMatchMapping(_) - | AnyNode::PatternMatchClass(_) - | AnyNode::PatternMatchStar(_) - | AnyNode::PatternMatchAs(_) - | AnyNode::PatternMatchOr(_) - | AnyNode::PatternArguments(_) - | AnyNode::PatternKeyword(_) - | AnyNode::Comprehension(_) - | AnyNode::Arguments(_) - | AnyNode::Parameters(_) - | AnyNode::Parameter(_) - | AnyNode::ParameterWithDefault(_) - | AnyNode::Keyword(_) - | AnyNode::Alias(_) - | AnyNode::WithItem(_) - | AnyNode::MatchCase(_) - | AnyNode::Decorator(_) - | AnyNode::TypeParams(_) - | AnyNode::TypeParamTypeVar(_) - | AnyNode::TypeParamTypeVarTuple(_) - | AnyNode::TypeParamParamSpec(_) - | AnyNode::FString(_) - | AnyNode::StringLiteral(_) - | AnyNode::BytesLiteral(_) - | AnyNode::Identifier(_) - | AnyNode::ElifElseClause(_) => None, - } - } - - pub fn module(self) -> Option<Mod> { - match self { - AnyNode::ModModule(node) => Some(Mod::Module(node)), - AnyNode::ModExpression(node) => Some(Mod::Expression(node)), - - AnyNode::StmtFunctionDef(_) - | AnyNode::StmtClassDef(_) - | AnyNode::StmtReturn(_) - | AnyNode::StmtDelete(_) - | AnyNode::StmtTypeAlias(_) - | AnyNode::StmtAssign(_) - | AnyNode::StmtAugAssign(_) - | AnyNode::StmtAnnAssign(_) - | AnyNode::StmtFor(_) - | AnyNode::StmtWhile(_) - | AnyNode::StmtIf(_) - | AnyNode::StmtWith(_) - | AnyNode::StmtMatch(_) - | AnyNode::StmtRaise(_) - | AnyNode::StmtTry(_) - | AnyNode::StmtAssert(_) - | AnyNode::StmtImport(_) - | AnyNode::StmtImportFrom(_) - | AnyNode::StmtGlobal(_) - | AnyNode::StmtNonlocal(_) - | AnyNode::StmtExpr(_) - | AnyNode::StmtPass(_) - | AnyNode::StmtBreak(_) - | AnyNode::StmtContinue(_) - | AnyNode::StmtIpyEscapeCommand(_) - | AnyNode::ExprBoolOp(_) - | AnyNode::ExprNamed(_) - | AnyNode::ExprBinOp(_) - | AnyNode::ExprUnaryOp(_) - | AnyNode::ExprLambda(_) - | AnyNode::ExprIf(_) - | AnyNode::ExprDict(_) - | AnyNode::ExprSet(_) - | AnyNode::ExprListComp(_) - | AnyNode::ExprSetComp(_) - | AnyNode::ExprDictComp(_) - | AnyNode::ExprGenerator(_) - | AnyNode::ExprAwait(_) - | AnyNode::ExprYield(_) - | AnyNode::ExprYieldFrom(_) - | AnyNode::ExprCompare(_) - | AnyNode::ExprCall(_) - | AnyNode::FStringExpressionElement(_) - | AnyNode::FStringLiteralElement(_) - | AnyNode::FStringFormatSpec(_) - | AnyNode::ExprFString(_) - | AnyNode::ExprStringLiteral(_) - | AnyNode::ExprBytesLiteral(_) - | AnyNode::ExprNumberLiteral(_) - | AnyNode::ExprBooleanLiteral(_) - | AnyNode::ExprNoneLiteral(_) - | AnyNode::ExprEllipsisLiteral(_) - | AnyNode::ExprAttribute(_) - | AnyNode::ExprSubscript(_) - | AnyNode::ExprStarred(_) - | AnyNode::ExprName(_) - | AnyNode::ExprList(_) - | AnyNode::ExprTuple(_) - | AnyNode::ExprSlice(_) - | AnyNode::ExprIpyEscapeCommand(_) - | AnyNode::ExceptHandlerExceptHandler(_) - | AnyNode::PatternMatchValue(_) - | AnyNode::PatternMatchSingleton(_) - | AnyNode::PatternMatchSequence(_) - | AnyNode::PatternMatchMapping(_) - | AnyNode::PatternMatchClass(_) - | AnyNode::PatternMatchStar(_) - | AnyNode::PatternMatchAs(_) - | AnyNode::PatternMatchOr(_) - | AnyNode::PatternArguments(_) - | AnyNode::PatternKeyword(_) - | AnyNode::Comprehension(_) - | AnyNode::Arguments(_) - | AnyNode::Parameters(_) - | AnyNode::Parameter(_) - | AnyNode::ParameterWithDefault(_) - | AnyNode::Keyword(_) - | AnyNode::Alias(_) - | AnyNode::WithItem(_) - | AnyNode::MatchCase(_) - | AnyNode::Decorator(_) - | AnyNode::TypeParams(_) - | AnyNode::TypeParamTypeVar(_) - | AnyNode::TypeParamTypeVarTuple(_) - | AnyNode::TypeParamParamSpec(_) - | AnyNode::FString(_) - | AnyNode::StringLiteral(_) - | AnyNode::BytesLiteral(_) - | AnyNode::Identifier(_) - | AnyNode::ElifElseClause(_) => None, - } - } - - pub fn pattern(self) -> Option<Pattern> { - match self { - AnyNode::PatternMatchValue(node) => Some(Pattern::MatchValue(node)), - AnyNode::PatternMatchSingleton(node) => Some(Pattern::MatchSingleton(node)), - AnyNode::PatternMatchSequence(node) => Some(Pattern::MatchSequence(node)), - AnyNode::PatternMatchMapping(node) => Some(Pattern::MatchMapping(node)), - AnyNode::PatternMatchClass(node) => Some(Pattern::MatchClass(node)), - AnyNode::PatternMatchStar(node) => Some(Pattern::MatchStar(node)), - AnyNode::PatternMatchAs(node) => Some(Pattern::MatchAs(node)), - AnyNode::PatternMatchOr(node) => Some(Pattern::MatchOr(node)), - - AnyNode::ModModule(_) - | AnyNode::ModExpression(_) - | AnyNode::StmtFunctionDef(_) - | AnyNode::StmtClassDef(_) - | AnyNode::StmtReturn(_) - | AnyNode::StmtDelete(_) - | AnyNode::StmtTypeAlias(_) - | AnyNode::StmtAssign(_) - | AnyNode::StmtAugAssign(_) - | AnyNode::StmtAnnAssign(_) - | AnyNode::StmtFor(_) - | AnyNode::StmtWhile(_) - | AnyNode::StmtIf(_) - | AnyNode::StmtWith(_) - | AnyNode::StmtMatch(_) - | AnyNode::StmtRaise(_) - | AnyNode::StmtTry(_) - | AnyNode::StmtAssert(_) - | AnyNode::StmtImport(_) - | AnyNode::StmtImportFrom(_) - | AnyNode::StmtGlobal(_) - | AnyNode::StmtNonlocal(_) - | AnyNode::StmtExpr(_) - | AnyNode::StmtPass(_) - | AnyNode::StmtBreak(_) - | AnyNode::StmtContinue(_) - | AnyNode::StmtIpyEscapeCommand(_) - | AnyNode::ExprBoolOp(_) - | AnyNode::ExprNamed(_) - | AnyNode::ExprBinOp(_) - | AnyNode::ExprUnaryOp(_) - | AnyNode::ExprLambda(_) - | AnyNode::ExprIf(_) - | AnyNode::ExprDict(_) - | AnyNode::ExprSet(_) - | AnyNode::ExprListComp(_) - | AnyNode::ExprSetComp(_) - | AnyNode::ExprDictComp(_) - | AnyNode::ExprGenerator(_) - | AnyNode::ExprAwait(_) - | AnyNode::ExprYield(_) - | AnyNode::ExprYieldFrom(_) - | AnyNode::ExprCompare(_) - | AnyNode::ExprCall(_) - | AnyNode::FStringExpressionElement(_) - | AnyNode::FStringLiteralElement(_) - | AnyNode::FStringFormatSpec(_) - | AnyNode::ExprFString(_) - | AnyNode::ExprStringLiteral(_) - | AnyNode::ExprBytesLiteral(_) - | AnyNode::ExprNumberLiteral(_) - | AnyNode::ExprBooleanLiteral(_) - | AnyNode::ExprNoneLiteral(_) - | AnyNode::ExprEllipsisLiteral(_) - | AnyNode::ExprAttribute(_) - | AnyNode::ExprSubscript(_) - | AnyNode::ExprStarred(_) - | AnyNode::ExprName(_) - | AnyNode::ExprList(_) - | AnyNode::ExprTuple(_) - | AnyNode::ExprSlice(_) - | AnyNode::ExprIpyEscapeCommand(_) - | AnyNode::ExceptHandlerExceptHandler(_) - | AnyNode::PatternArguments(_) - | AnyNode::PatternKeyword(_) - | AnyNode::Comprehension(_) - | AnyNode::Arguments(_) - | AnyNode::Parameters(_) - | AnyNode::Parameter(_) - | AnyNode::ParameterWithDefault(_) - | AnyNode::Keyword(_) - | AnyNode::Alias(_) - | AnyNode::WithItem(_) - | AnyNode::MatchCase(_) - | AnyNode::Decorator(_) - | AnyNode::TypeParams(_) - | AnyNode::TypeParamTypeVar(_) - | AnyNode::TypeParamTypeVarTuple(_) - | AnyNode::TypeParamParamSpec(_) - | AnyNode::FString(_) - | AnyNode::StringLiteral(_) - | AnyNode::BytesLiteral(_) - | AnyNode::Identifier(_) - | AnyNode::ElifElseClause(_) => None, - } - } - - pub fn except_handler(self) -> Option<ExceptHandler> { - match self { - AnyNode::ExceptHandlerExceptHandler(node) => Some(ExceptHandler::ExceptHandler(node)), - - AnyNode::ModModule(_) - | AnyNode::ModExpression(_) - | AnyNode::StmtFunctionDef(_) - | AnyNode::StmtClassDef(_) - | AnyNode::StmtReturn(_) - | AnyNode::StmtDelete(_) - | AnyNode::StmtTypeAlias(_) - | AnyNode::StmtAssign(_) - | AnyNode::StmtAugAssign(_) - | AnyNode::StmtAnnAssign(_) - | AnyNode::StmtFor(_) - | AnyNode::StmtWhile(_) - | AnyNode::StmtIf(_) - | AnyNode::StmtWith(_) - | AnyNode::StmtMatch(_) - | AnyNode::StmtRaise(_) - | AnyNode::StmtTry(_) - | AnyNode::StmtAssert(_) - | AnyNode::StmtImport(_) - | AnyNode::StmtImportFrom(_) - | AnyNode::StmtGlobal(_) - | AnyNode::StmtNonlocal(_) - | AnyNode::StmtExpr(_) - | AnyNode::StmtPass(_) - | AnyNode::StmtBreak(_) - | AnyNode::StmtContinue(_) - | AnyNode::StmtIpyEscapeCommand(_) - | AnyNode::ExprBoolOp(_) - | AnyNode::ExprNamed(_) - | AnyNode::ExprBinOp(_) - | AnyNode::ExprUnaryOp(_) - | AnyNode::ExprLambda(_) - | AnyNode::ExprIf(_) - | AnyNode::ExprDict(_) - | AnyNode::ExprSet(_) - | AnyNode::ExprListComp(_) - | AnyNode::ExprSetComp(_) - | AnyNode::ExprDictComp(_) - | AnyNode::ExprGenerator(_) - | AnyNode::ExprAwait(_) - | AnyNode::ExprYield(_) - | AnyNode::ExprYieldFrom(_) - | AnyNode::ExprCompare(_) - | AnyNode::ExprCall(_) - | AnyNode::FStringExpressionElement(_) - | AnyNode::FStringLiteralElement(_) - | AnyNode::FStringFormatSpec(_) - | AnyNode::ExprFString(_) - | AnyNode::ExprStringLiteral(_) - | AnyNode::ExprBytesLiteral(_) - | AnyNode::ExprNumberLiteral(_) - | AnyNode::ExprBooleanLiteral(_) - | AnyNode::ExprNoneLiteral(_) - | AnyNode::ExprEllipsisLiteral(_) - | AnyNode::ExprAttribute(_) - | AnyNode::ExprSubscript(_) - | AnyNode::ExprStarred(_) - | AnyNode::ExprName(_) - | AnyNode::ExprList(_) - | AnyNode::ExprTuple(_) - | AnyNode::ExprSlice(_) - | AnyNode::ExprIpyEscapeCommand(_) - | AnyNode::PatternMatchValue(_) - | AnyNode::PatternMatchSingleton(_) - | AnyNode::PatternMatchSequence(_) - | AnyNode::PatternMatchMapping(_) - | AnyNode::PatternMatchClass(_) - | AnyNode::PatternMatchStar(_) - | AnyNode::PatternMatchAs(_) - | AnyNode::PatternMatchOr(_) - | AnyNode::PatternArguments(_) - | AnyNode::PatternKeyword(_) - | AnyNode::Comprehension(_) - | AnyNode::Arguments(_) - | AnyNode::Parameters(_) - | AnyNode::Parameter(_) - | AnyNode::ParameterWithDefault(_) - | AnyNode::Keyword(_) - | AnyNode::Alias(_) - | AnyNode::WithItem(_) - | AnyNode::MatchCase(_) - | AnyNode::Decorator(_) - | AnyNode::TypeParams(_) - | AnyNode::TypeParamTypeVar(_) - | AnyNode::TypeParamTypeVarTuple(_) - | AnyNode::TypeParamParamSpec(_) - | AnyNode::FString(_) - | AnyNode::StringLiteral(_) - | AnyNode::BytesLiteral(_) - | AnyNode::Identifier(_) - | AnyNode::ElifElseClause(_) => None, + V: SourceOrderVisitor<'a> + ?Sized, + { + let ast::ElifElseClause { + range: _, + test, + body, + } = self; + if let Some(test) = test { + visitor.visit_expr(test); } + visitor.visit_body(body); } +} - pub const fn is_statement(&self) -> bool { - self.as_ref().is_statement() - } - - pub const fn is_expression(&self) -> bool { - self.as_ref().is_expression() - } - - pub const fn is_module(&self) -> bool { - self.as_ref().is_module() - } - - pub const fn is_pattern(&self) -> bool { - self.as_ref().is_pattern() - } - - pub const fn is_except_handler(&self) -> bool { - self.as_ref().is_except_handler() - } +impl ast::ExprDict { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ast::ExprDict { items, range: _ } = self; - pub const fn as_ref(&self) -> AnyNodeRef { - match self { - Self::ModModule(node) => AnyNodeRef::ModModule(node), - Self::ModExpression(node) => AnyNodeRef::ModExpression(node), - Self::StmtFunctionDef(node) => AnyNodeRef::StmtFunctionDef(node), - Self::StmtClassDef(node) => AnyNodeRef::StmtClassDef(node), - Self::StmtReturn(node) => AnyNodeRef::StmtReturn(node), - Self::StmtDelete(node) => AnyNodeRef::StmtDelete(node), - Self::StmtTypeAlias(node) => AnyNodeRef::StmtTypeAlias(node), - Self::StmtAssign(node) => AnyNodeRef::StmtAssign(node), - Self::StmtAugAssign(node) => AnyNodeRef::StmtAugAssign(node), - Self::StmtAnnAssign(node) => AnyNodeRef::StmtAnnAssign(node), - Self::StmtFor(node) => AnyNodeRef::StmtFor(node), - Self::StmtWhile(node) => AnyNodeRef::StmtWhile(node), - Self::StmtIf(node) => AnyNodeRef::StmtIf(node), - Self::StmtWith(node) => AnyNodeRef::StmtWith(node), - Self::StmtMatch(node) => AnyNodeRef::StmtMatch(node), - Self::StmtRaise(node) => AnyNodeRef::StmtRaise(node), - Self::StmtTry(node) => AnyNodeRef::StmtTry(node), - Self::StmtAssert(node) => AnyNodeRef::StmtAssert(node), - Self::StmtImport(node) => AnyNodeRef::StmtImport(node), - Self::StmtImportFrom(node) => AnyNodeRef::StmtImportFrom(node), - Self::StmtGlobal(node) => AnyNodeRef::StmtGlobal(node), - Self::StmtNonlocal(node) => AnyNodeRef::StmtNonlocal(node), - Self::StmtExpr(node) => AnyNodeRef::StmtExpr(node), - Self::StmtPass(node) => AnyNodeRef::StmtPass(node), - Self::StmtBreak(node) => AnyNodeRef::StmtBreak(node), - Self::StmtContinue(node) => AnyNodeRef::StmtContinue(node), - Self::StmtIpyEscapeCommand(node) => AnyNodeRef::StmtIpyEscapeCommand(node), - Self::ExprBoolOp(node) => AnyNodeRef::ExprBoolOp(node), - Self::ExprNamed(node) => AnyNodeRef::ExprNamed(node), - Self::ExprBinOp(node) => AnyNodeRef::ExprBinOp(node), - Self::ExprUnaryOp(node) => AnyNodeRef::ExprUnaryOp(node), - Self::ExprLambda(node) => AnyNodeRef::ExprLambda(node), - Self::ExprIf(node) => AnyNodeRef::ExprIf(node), - Self::ExprDict(node) => AnyNodeRef::ExprDict(node), - Self::ExprSet(node) => AnyNodeRef::ExprSet(node), - Self::ExprListComp(node) => AnyNodeRef::ExprListComp(node), - Self::ExprSetComp(node) => AnyNodeRef::ExprSetComp(node), - Self::ExprDictComp(node) => AnyNodeRef::ExprDictComp(node), - Self::ExprGenerator(node) => AnyNodeRef::ExprGenerator(node), - Self::ExprAwait(node) => AnyNodeRef::ExprAwait(node), - Self::ExprYield(node) => AnyNodeRef::ExprYield(node), - Self::ExprYieldFrom(node) => AnyNodeRef::ExprYieldFrom(node), - Self::ExprCompare(node) => AnyNodeRef::ExprCompare(node), - Self::ExprCall(node) => AnyNodeRef::ExprCall(node), - Self::FStringExpressionElement(node) => AnyNodeRef::FStringExpressionElement(node), - Self::FStringLiteralElement(node) => AnyNodeRef::FStringLiteralElement(node), - Self::FStringFormatSpec(node) => AnyNodeRef::FStringFormatSpec(node), - Self::ExprFString(node) => AnyNodeRef::ExprFString(node), - Self::ExprStringLiteral(node) => AnyNodeRef::ExprStringLiteral(node), - Self::ExprBytesLiteral(node) => AnyNodeRef::ExprBytesLiteral(node), - Self::ExprNumberLiteral(node) => AnyNodeRef::ExprNumberLiteral(node), - Self::ExprBooleanLiteral(node) => AnyNodeRef::ExprBooleanLiteral(node), - Self::ExprNoneLiteral(node) => AnyNodeRef::ExprNoneLiteral(node), - Self::ExprEllipsisLiteral(node) => AnyNodeRef::ExprEllipsisLiteral(node), - Self::ExprAttribute(node) => AnyNodeRef::ExprAttribute(node), - Self::ExprSubscript(node) => AnyNodeRef::ExprSubscript(node), - Self::ExprStarred(node) => AnyNodeRef::ExprStarred(node), - Self::ExprName(node) => AnyNodeRef::ExprName(node), - Self::ExprList(node) => AnyNodeRef::ExprList(node), - Self::ExprTuple(node) => AnyNodeRef::ExprTuple(node), - Self::ExprSlice(node) => AnyNodeRef::ExprSlice(node), - Self::ExprIpyEscapeCommand(node) => AnyNodeRef::ExprIpyEscapeCommand(node), - Self::ExceptHandlerExceptHandler(node) => AnyNodeRef::ExceptHandlerExceptHandler(node), - Self::PatternMatchValue(node) => AnyNodeRef::PatternMatchValue(node), - Self::PatternMatchSingleton(node) => AnyNodeRef::PatternMatchSingleton(node), - Self::PatternMatchSequence(node) => AnyNodeRef::PatternMatchSequence(node), - Self::PatternMatchMapping(node) => AnyNodeRef::PatternMatchMapping(node), - Self::PatternMatchClass(node) => AnyNodeRef::PatternMatchClass(node), - Self::PatternMatchStar(node) => AnyNodeRef::PatternMatchStar(node), - Self::PatternMatchAs(node) => AnyNodeRef::PatternMatchAs(node), - Self::PatternMatchOr(node) => AnyNodeRef::PatternMatchOr(node), - Self::PatternArguments(node) => AnyNodeRef::PatternArguments(node), - Self::PatternKeyword(node) => AnyNodeRef::PatternKeyword(node), - Self::Comprehension(node) => AnyNodeRef::Comprehension(node), - Self::Arguments(node) => AnyNodeRef::Arguments(node), - Self::Parameters(node) => AnyNodeRef::Parameters(node), - Self::Parameter(node) => AnyNodeRef::Parameter(node), - Self::ParameterWithDefault(node) => AnyNodeRef::ParameterWithDefault(node), - Self::Keyword(node) => AnyNodeRef::Keyword(node), - Self::Alias(node) => AnyNodeRef::Alias(node), - Self::WithItem(node) => AnyNodeRef::WithItem(node), - Self::MatchCase(node) => AnyNodeRef::MatchCase(node), - Self::Decorator(node) => AnyNodeRef::Decorator(node), - Self::TypeParams(node) => AnyNodeRef::TypeParams(node), - Self::TypeParamTypeVar(node) => AnyNodeRef::TypeParamTypeVar(node), - Self::TypeParamTypeVarTuple(node) => AnyNodeRef::TypeParamTypeVarTuple(node), - Self::TypeParamParamSpec(node) => AnyNodeRef::TypeParamParamSpec(node), - Self::FString(node) => AnyNodeRef::FString(node), - Self::StringLiteral(node) => AnyNodeRef::StringLiteral(node), - Self::BytesLiteral(node) => AnyNodeRef::BytesLiteral(node), - Self::ElifElseClause(node) => AnyNodeRef::ElifElseClause(node), - Self::Identifier(node) => AnyNodeRef::Identifier(node), + for ast::DictItem { key, value } in items { + if let Some(key) = key { + visitor.visit_expr(key); + } + visitor.visit_expr(value); } } - - /// Returns the node's [`kind`](NodeKind) that has no data associated and is [`Copy`]. - pub const fn kind(&self) -> NodeKind { - self.as_ref().kind() - } } -impl AstNode for ast::ModModule { - type Ref<'a> = &'a Self; - - fn cast(kind: AnyNode) -> Option<Self> +impl ast::ExprBoolOp { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::ModModule(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ModModule(node) = kind { - Some(node) - } else { - None + let ast::ExprBoolOp { + op, + values, + range: _, + } = self; + match values.as_slice() { + [left, rest @ ..] => { + visitor.visit_expr(left); + visitor.visit_bool_op(op); + for expr in rest { + visitor.visit_expr(expr); + } + } + [] => { + visitor.visit_bool_op(op); + } } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ModModule) - } +impl ast::ExprCompare { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ast::ExprCompare { + left, + ops, + comparators, + range: _, + } = self; - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + visitor.visit_expr(left); - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) + for (op, comparator) in ops.iter().zip(comparators) { + visitor.visit_cmp_op(op); + visitor.visit_expr(comparator); + } } +} - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::FStringFormatSpec { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::ModModule { body, range: _ } = self; - visitor.visit_body(body); + for element in &self.elements { + visitor.visit_f_string_element(element); + } } } -impl AstNode for ast::ModExpression { - type Ref<'a> = &'a Self; - - fn cast(kind: AnyNode) -> Option<Self> +impl ast::FStringExpressionElement { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::ModExpression(node) = kind { - Some(node) - } else { - None - } - } + let ast::FStringExpressionElement { + expression, + format_spec, + .. + } = self; + visitor.visit_expr(expression); - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ModExpression(node) = kind { - Some(node) - } else { - None + if let Some(format_spec) = format_spec { + for spec_part in &format_spec.elements { + visitor.visit_f_string_element(spec_part); + } } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ModExpression) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::FStringLiteralElement { + pub(crate) fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::ModExpression { body, range: _ } = self; - visitor.visit_expr(body); + let ast::FStringLiteralElement { range: _, value: _ } = self; } } -impl AstNode for ast::StmtFunctionDef { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> +impl ast::ExprFString { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtFunctionDef(node) = kind { - Some(node) - } else { - None - } - } + let ast::ExprFString { value, range: _ } = self; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtFunctionDef(node) = kind { - Some(node) - } else { - None + for f_string_part in value { + match f_string_part { + ast::FStringPart::Literal(string_literal) => { + visitor.visit_string_literal(string_literal); + } + ast::FStringPart::FString(f_string) => { + visitor.visit_f_string(f_string); + } + } } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtFunctionDef) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::ExprStringLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtFunctionDef { - parameters, - body, - decorator_list, - returns, - type_params, - .. - } = self; - - for decorator in decorator_list { - visitor.visit_decorator(decorator); - } - - if let Some(type_params) = type_params { - visitor.visit_type_params(type_params); - } - - visitor.visit_parameters(parameters); + let ast::ExprStringLiteral { value, range: _ } = self; - if let Some(expr) = returns { - visitor.visit_annotation(expr); + for string_literal in value { + visitor.visit_string_literal(string_literal); } - - visitor.visit_body(body); } } -impl AstNode for ast::StmtClassDef { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> +impl ast::ExprBytesLiteral { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtClassDef(node) = kind { - Some(node) - } else { - None - } - } + let ast::ExprBytesLiteral { value, range: _ } = self; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtClassDef(node) = kind { - Some(node) - } else { - None + for bytes_literal in value { + visitor.visit_bytes_literal(bytes_literal); } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtClassDef) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::ExceptHandlerExceptHandler { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtClassDef { - arguments, + let ast::ExceptHandlerExceptHandler { + range: _, + type_, + name, body, - decorator_list, - type_params, - .. } = self; - - for decorator in decorator_list { - visitor.visit_decorator(decorator); - } - - if let Some(type_params) = type_params { - visitor.visit_type_params(type_params); + if let Some(expr) = type_ { + visitor.visit_expr(expr); } - if let Some(arguments) = arguments { - visitor.visit_arguments(arguments); + if let Some(name) = name { + visitor.visit_identifier(name); } visitor.visit_body(body); } } -impl AstNode for ast::StmtReturn { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::PatternMatchValue { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtReturn(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtReturn(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtReturn) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) + let ast::PatternMatchValue { value, range: _ } = self; + visitor.visit_expr(value); } +} - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::PatternMatchSingleton { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtReturn { value, range: _ } = self; - if let Some(expr) = value { - visitor.visit_expr(expr); - } + let ast::PatternMatchSingleton { value, range: _ } = self; + visitor.visit_singleton(value); } } -impl AstNode for ast::StmtDelete { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::PatternMatchSequence { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtDelete(node) = kind { - Some(node) - } else { - None + let ast::PatternMatchSequence { patterns, range: _ } = self; + for pattern in patterns { + visitor.visit_pattern(pattern); } } +} - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtDelete(node) = kind { - Some(node) - } else { - None - } - } +impl ast::PatternMatchMapping { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) + where + V: SourceOrderVisitor<'a> + ?Sized, + { + let ast::PatternMatchMapping { + keys, + patterns, + rest, + range: _, + } = self; - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtDelete) - } + let mut rest = rest.as_ref(); - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + for (key, pattern) in keys.iter().zip(patterns) { + if let Some(rest_identifier) = rest { + if rest_identifier.start() < key.start() { + visitor.visit_identifier(rest_identifier); + rest = None; + } + } + visitor.visit_expr(key); + visitor.visit_pattern(pattern); + } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) + if let Some(rest) = rest { + visitor.visit_identifier(rest); + } } +} - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::PatternMatchClass { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtDelete { targets, range: _ } = self; - for expr in targets { - visitor.visit_expr(expr); - } + let ast::PatternMatchClass { + cls, + arguments: parameters, + range: _, + } = self; + visitor.visit_expr(cls); + visitor.visit_pattern_arguments(parameters); } } -impl AstNode for ast::StmtTypeAlias { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::PatternMatchStar { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtTypeAlias(node) = kind { - Some(node) - } else { - None - } - } + let ast::PatternMatchStar { range: _, name } = self; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtTypeAlias(node) = kind { - Some(node) - } else { - None + if let Some(name) = name { + visitor.visit_identifier(name); } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtTypeAlias) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::PatternMatchAs { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtTypeAlias { + let ast::PatternMatchAs { + pattern, range: _, name, - type_params, - value, } = self; + if let Some(pattern) = pattern { + visitor.visit_pattern(pattern); + } - visitor.visit_expr(name); - if let Some(type_params) = type_params { - visitor.visit_type_params(type_params); + if let Some(name) = name { + visitor.visit_identifier(name); } - visitor.visit_expr(value); } } -impl AstNode for ast::StmtAssign { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::PatternMatchOr { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtAssign(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtAssign(node) = kind { - Some(node) - } else { - None + let ast::PatternMatchOr { patterns, range: _ } = self; + for pattern in patterns { + visitor.visit_pattern(pattern); } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtAssign) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::PatternArguments { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtAssign { - targets, - value, + let PatternArguments { range: _, + patterns, + keywords, } = self; - for expr in targets { - visitor.visit_expr(expr); - } - - visitor.visit_expr(value); - } -} -impl AstNode for ast::StmtAugAssign { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtAugAssign(node) = kind { - Some(node) - } else { - None + for pattern in patterns { + visitor.visit_pattern(pattern); } - } - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtAugAssign(node) = kind { - Some(node) - } else { - None + for keyword in keywords { + visitor.visit_pattern_keyword(keyword); } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtAugAssign) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::PatternKeyword { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtAugAssign { - target, - op, - value, + let PatternKeyword { range: _, + attr, + pattern, } = self; - visitor.visit_expr(target); - visitor.visit_operator(op); - visitor.visit_expr(value); + visitor.visit_identifier(attr); + visitor.visit_pattern(pattern); } } -impl AstNode for ast::StmtAnnAssign { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtAnnAssign(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtAnnAssign(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtAnnAssign) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::Comprehension { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtAnnAssign { - target, - annotation, - value, + let ast::Comprehension { range: _, - simple: _, + target, + iter, + ifs, + is_async: _, } = self; - visitor.visit_expr(target); - visitor.visit_annotation(annotation); - if let Some(expr) = value { + visitor.visit_expr(iter); + + for expr in ifs { visitor.visit_expr(expr); } } } -impl AstNode for ast::StmtFor { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::Arguments { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtFor(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtFor(node) = kind { - Some(node) - } else { - None + for arg_or_keyword in self.arguments_source_order() { + match arg_or_keyword { + ArgOrKeyword::Arg(arg) => visitor.visit_expr(arg), + ArgOrKeyword::Keyword(keyword) => visitor.visit_keyword(keyword), + } } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtFor) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::Parameters { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtFor { - target, - iter, - body, - orelse, - .. - } = self; - - visitor.visit_expr(target); - visitor.visit_expr(iter); - visitor.visit_body(body); - visitor.visit_body(orelse); + for parameter in self { + match parameter { + AnyParameterRef::NonVariadic(parameter_with_default) => { + visitor.visit_parameter_with_default(parameter_with_default); + } + AnyParameterRef::Variadic(parameter) => visitor.visit_parameter(parameter), + } + } } } -impl AstNode for ast::StmtWhile { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::Parameter { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtWhile(node) = kind { - Some(node) - } else { - None - } - } + let ast::Parameter { + range: _, + name, + annotation, + } = self; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtWhile(node) = kind { - Some(node) - } else { - None + visitor.visit_identifier(name); + if let Some(expr) = annotation { + visitor.visit_annotation(expr); } } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtWhile) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::ParameterWithDefault { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtWhile { - test, - body, - orelse, + let ast::ParameterWithDefault { range: _, + parameter, + default, } = self; - - visitor.visit_expr(test); - visitor.visit_body(body); - visitor.visit_body(orelse); + visitor.visit_parameter(parameter); + if let Some(expr) = default { + visitor.visit_expr(expr); + } } } -impl AstNode for ast::StmtIf { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::Keyword { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtIf(node) = kind { - Some(node) - } else { - None - } - } + let ast::Keyword { + range: _, + arg, + value, + } = self; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtIf(node) = kind { - Some(node) - } else { - None + if let Some(arg) = arg { + visitor.visit_identifier(arg); } + visitor.visit_expr(value); } +} - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtIf) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl Alias { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtIf { - test, - body, - elif_else_clauses, + let ast::Alias { range: _, + name, + asname, } = self; - visitor.visit_expr(test); - visitor.visit_body(body); - for clause in elif_else_clauses { - visitor.visit_elif_else_clause(clause); + visitor.visit_identifier(name); + if let Some(asname) = asname { + visitor.visit_identifier(asname); } } } -impl AstNode for ast::ElifElseClause { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::WithItem { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::ElifElseClause(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ElifElseClause(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ElifElseClause) - } + let ast::WithItem { + range: _, + context_expr, + optional_vars, + } = self; - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + visitor.visit_expr(context_expr); - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) + if let Some(expr) = optional_vars { + visitor.visit_expr(expr); + } } +} - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::MatchCase { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::ElifElseClause { + let ast::MatchCase { range: _, - test, + pattern, + guard, body, } = self; - if let Some(test) = test { - visitor.visit_expr(test); + + visitor.visit_pattern(pattern); + if let Some(expr) = guard { + visitor.visit_expr(expr); } visitor.visit_body(body); } } -impl AstNode for ast::StmtWith { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtWith(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtWith(node) = kind { - Some(node) - } else { - None - } - } - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtWith) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::Decorator { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtWith { - items, - body, - is_async: _, + let ast::Decorator { range: _, + expression, } = self; - for with_item in items { - visitor.visit_with_item(with_item); - } - visitor.visit_body(body); + visitor.visit_expr(expression); } } -impl AstNode for ast::StmtMatch { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtMatch(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtMatch(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtMatch) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::TypeParams { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtMatch { - subject, - cases, + let ast::TypeParams { range: _, + type_params, } = self; - visitor.visit_expr(subject); - for match_case in cases { - visitor.visit_match_case(match_case); + for type_param in type_params { + visitor.visit_type_param(type_param); } } } -impl AstNode for ast::StmtRaise { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtRaise(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtRaise(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtRaise) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::TypeParamTypeVar { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtRaise { - exc, - cause, + let ast::TypeParamTypeVar { + bound, + default, + name, range: _, } = self; - if let Some(expr) = exc { + visitor.visit_identifier(name); + if let Some(expr) = bound { visitor.visit_expr(expr); - }; - if let Some(expr) = cause { + } + if let Some(expr) = default { visitor.visit_expr(expr); - }; + } } } -impl AstNode for ast::StmtTry { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> + +impl ast::TypeParamTypeVarTuple { + #[inline] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where - Self: Sized, + V: SourceOrderVisitor<'a> + ?Sized, { - if let AnyNode::StmtTry(node) = kind { - Some(node) - } else { - None + let ast::TypeParamTypeVarTuple { + range: _, + name, + default, + } = self; + visitor.visit_identifier(name); + if let Some(expr) = default { + visitor.visit_expr(expr); } } +} - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtTry(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtTry) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::TypeParamParamSpec { + #[inline] + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtTry { - body, - handlers, - orelse, - finalbody, - is_star: _, + let ast::TypeParamParamSpec { range: _, + name, + default, } = self; - - visitor.visit_body(body); - for except_handler in handlers { - visitor.visit_except_handler(except_handler); + visitor.visit_identifier(name); + if let Some(expr) = default { + visitor.visit_expr(expr); } - visitor.visit_body(orelse); - visitor.visit_body(finalbody); } } -impl AstNode for ast::StmtAssert { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtAssert(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtAssert(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtAssert) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::FString { + pub(crate) fn visit_source_order<'a, V>(&'a self, visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtAssert { - test, - msg, + let ast::FString { + elements, range: _, + flags: _, } = self; - visitor.visit_expr(test); - if let Some(expr) = msg { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::StmtImport { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtImport(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtImport(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtImport) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::StmtImport { names, range: _ } = self; - - for alias in names { - visitor.visit_alias(alias); + for fstring_element in elements { + visitor.visit_f_string_element(fstring_element); } } } -impl AstNode for ast::StmtImportFrom { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtImportFrom(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtImportFrom(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtImportFrom) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) +impl ast::StringLiteral { + #[inline] + pub(crate) fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { - let ast::StmtImportFrom { + let ast::StringLiteral { range: _, - module: _, - names, - level: _, + value: _, + flags: _, } = self; - - for alias in names { - visitor.visit_alias(alias); - } } } -impl AstNode for ast::StmtGlobal { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtGlobal(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtGlobal(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtGlobal) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } +impl ast::BytesLiteral { #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) + pub(crate) fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { + let ast::BytesLiteral { + range: _, + value: _, + flags: _, + } = self; } } -impl AstNode for ast::StmtNonlocal { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtNonlocal(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtNonlocal(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtNonlocal) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } +impl ast::Identifier { #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) + pub(crate) fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) where V: SourceOrderVisitor<'a> + ?Sized, { + let ast::Identifier { range: _, id: _ } = self; } } -impl AstNode for ast::StmtExpr { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtExpr(node) = kind { - Some(node) - } else { - None - } - } - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtExpr(node) = kind { - Some(node) - } else { - None - } +impl<'a> AnyNodeRef<'a> { + /// Compares two any node refs by their pointers (referential equality). + pub fn ptr_eq(self, other: AnyNodeRef) -> bool { + self.as_ptr().eq(&other.as_ptr()) && self.kind() == other.kind() } - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtExpr) + /// In our AST, only some alternative branches are represented as a node. This has historical + /// reasons, e.g. we added a node for elif/else in if statements which was not originally + /// present in the parser. + pub const fn is_alternative_branch_with_node(self) -> bool { + matches!( + self, + AnyNodeRef::ExceptHandlerExceptHandler(_) | AnyNodeRef::ElifElseClause(_) + ) } - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + /// The last child of the last branch, if the node has multiple branches. + pub fn last_child_in_body(&self) -> Option<AnyNodeRef<'a>> { + let body = + match self { + AnyNodeRef::StmtFunctionDef(ast::StmtFunctionDef { body, .. }) + | AnyNodeRef::StmtClassDef(ast::StmtClassDef { body, .. }) + | AnyNodeRef::StmtWith(ast::StmtWith { body, .. }) + | AnyNodeRef::MatchCase(MatchCase { body, .. }) + | AnyNodeRef::ExceptHandlerExceptHandler(ast::ExceptHandlerExceptHandler { + body, + .. + }) + | AnyNodeRef::ElifElseClause(ast::ElifElseClause { body, .. }) => body, + AnyNodeRef::StmtIf(ast::StmtIf { + body, + elif_else_clauses, + .. + }) => elif_else_clauses.last().map_or(body, |clause| &clause.body), + + AnyNodeRef::StmtFor(ast::StmtFor { body, orelse, .. }) + | AnyNodeRef::StmtWhile(ast::StmtWhile { body, orelse, .. }) => { + if orelse.is_empty() { body } else { orelse } + } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } + AnyNodeRef::StmtMatch(ast::StmtMatch { cases, .. }) => { + return cases.last().map(AnyNodeRef::from); + } - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::StmtExpr { value, range: _ } = self; + AnyNodeRef::StmtTry(ast::StmtTry { + body, + handlers, + orelse, + finalbody, + .. + }) => { + if finalbody.is_empty() { + if orelse.is_empty() { + if handlers.is_empty() { + body + } else { + return handlers.last().map(AnyNodeRef::from); + } + } else { + orelse + } + } else { + finalbody + } + } - visitor.visit_expr(value); - } -} -impl AstNode for ast::StmtPass { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtPass(node) = kind { - Some(node) - } else { - None - } - } + // Not a node that contains an indented child node. + _ => return None, + }; - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtPass(node) = kind { - Some(node) - } else { - None - } + body.last().map(AnyNodeRef::from) } - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtPass) - } + /// Check if the given statement is the first statement after the colon of a branch, be it in if + /// statements, for statements, after each part of a try-except-else-finally or function/class + /// definitions. + /// + /// + /// ```python + /// if True: <- has body + /// a <- first statement + /// b + /// elif b: <- has body + /// c <- first statement + /// d + /// else: <- has body + /// e <- first statement + /// f + /// + /// class: <- has body + /// a: int <- first statement + /// b: int + /// + /// ``` + /// + /// For nodes with multiple bodies, we check all bodies that don't have their own node. For + /// try-except-else-finally, each except branch has it's own node, so for the `StmtTry`, we check + /// the `try:`, `else:` and `finally:`, bodies, while `ExceptHandlerExceptHandler` has it's own + /// check. For for-else and while-else, we check both branches for the whole statement. + /// + /// ```python + /// try: <- has body (a) + /// 6/8 <- first statement (a) + /// 1/0 + /// except: <- has body (b) + /// a <- first statement (b) + /// b + /// else: + /// c <- first statement (a) + /// d + /// finally: + /// e <- first statement (a) + /// f + /// ``` + pub fn is_first_statement_in_body(&self, body: AnyNodeRef) -> bool { + match body { + AnyNodeRef::StmtFor(ast::StmtFor { body, orelse, .. }) + | AnyNodeRef::StmtWhile(ast::StmtWhile { body, orelse, .. }) => { + are_same_optional(*self, body.first()) || are_same_optional(*self, orelse.first()) + } - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + AnyNodeRef::StmtTry(ast::StmtTry { + body, + orelse, + finalbody, + .. + }) => { + are_same_optional(*self, body.first()) + || are_same_optional(*self, orelse.first()) + || are_same_optional(*self, finalbody.first()) + } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } + AnyNodeRef::StmtIf(ast::StmtIf { body, .. }) + | AnyNodeRef::ElifElseClause(ast::ElifElseClause { body, .. }) + | AnyNodeRef::StmtWith(ast::StmtWith { body, .. }) + | AnyNodeRef::ExceptHandlerExceptHandler(ast::ExceptHandlerExceptHandler { + body, + .. + }) + | AnyNodeRef::MatchCase(MatchCase { body, .. }) + | AnyNodeRef::StmtFunctionDef(ast::StmtFunctionDef { body, .. }) + | AnyNodeRef::StmtClassDef(ast::StmtClassDef { body, .. }) => { + are_same_optional(*self, body.first()) + } - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::StmtBreak { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtBreak(node) = kind { - Some(node) - } else { - None - } - } + AnyNodeRef::StmtMatch(ast::StmtMatch { cases, .. }) => { + are_same_optional(*self, cases.first()) + } - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtBreak(node) = kind { - Some(node) - } else { - None + _ => false, } } - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtBreak) - } + /// Returns `true` if `statement` is the first statement in an alternate `body` (e.g. the else of an if statement) + pub fn is_first_statement_in_alternate_body(&self, body: AnyNodeRef) -> bool { + match body { + AnyNodeRef::StmtFor(ast::StmtFor { orelse, .. }) + | AnyNodeRef::StmtWhile(ast::StmtWhile { orelse, .. }) => { + are_same_optional(*self, orelse.first()) + } - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } + AnyNodeRef::StmtTry(ast::StmtTry { + handlers, + orelse, + finalbody, + .. + }) => { + are_same_optional(*self, handlers.first()) + || are_same_optional(*self, orelse.first()) + || are_same_optional(*self, finalbody.first()) + } - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) + AnyNodeRef::StmtIf(ast::StmtIf { + elif_else_clauses, .. + }) => are_same_optional(*self, elif_else_clauses.first()), + _ => false, + } } +} - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::StmtContinue { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtContinue(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtContinue(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtContinue) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::StmtIpyEscapeCommand { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StmtIpyEscapeCommand(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StmtIpyEscapeCommand(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StmtIpyEscapeCommand) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprBoolOp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprBoolOp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprBoolOp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprBoolOp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprBoolOp { - op, - values, - range: _, - } = self; - match values.as_slice() { - [left, rest @ ..] => { - visitor.visit_expr(left); - visitor.visit_bool_op(op); - for expr in rest { - visitor.visit_expr(expr); - } - } - [] => { - visitor.visit_bool_op(op); - } - } - } -} -impl AstNode for ast::ExprNamed { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprNamed(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprNamed(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprNamed) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprNamed { - target, - value, - range: _, - } = self; - visitor.visit_expr(target); - visitor.visit_expr(value); - } -} -impl AstNode for ast::ExprBinOp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprBinOp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprBinOp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprBinOp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprBinOp { - left, - op, - right, - range: _, - } = self; - visitor.visit_expr(left); - visitor.visit_operator(op); - visitor.visit_expr(right); - } -} -impl AstNode for ast::ExprUnaryOp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprUnaryOp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprUnaryOp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprUnaryOp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprUnaryOp { - op, - operand, - range: _, - } = self; - - visitor.visit_unary_op(op); - visitor.visit_expr(operand); - } -} -impl AstNode for ast::ExprLambda { - type Ref<'a> = &'a Self; - - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprLambda(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprLambda(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprLambda) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprLambda { - parameters, - body, - range: _, - } = self; - - if let Some(parameters) = parameters { - visitor.visit_parameters(parameters); - } - visitor.visit_expr(body); - } -} -impl AstNode for ast::ExprIf { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprIf(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprIf(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprIf) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprIf { - test, - body, - orelse, - range: _, - } = self; - - // `body if test else orelse` - visitor.visit_expr(body); - visitor.visit_expr(test); - visitor.visit_expr(orelse); - } -} -impl AstNode for ast::ExprDict { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprDict(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprDict(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprDict) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprDict { items, range: _ } = self; - - for ast::DictItem { key, value } in items { - if let Some(key) = key { - visitor.visit_expr(key); - } - visitor.visit_expr(value); - } - } -} -impl AstNode for ast::ExprSet { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprSet(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprSet(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprSet) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprSet { elts, range: _ } = self; - - for expr in elts { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::ExprListComp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprListComp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprListComp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprListComp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprListComp { - elt, - generators, - range: _, - } = self; - - visitor.visit_expr(elt); - for comprehension in generators { - visitor.visit_comprehension(comprehension); - } - } -} -impl AstNode for ast::ExprSetComp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprSetComp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprSetComp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprSetComp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprSetComp { - elt, - generators, - range: _, - } = self; - - visitor.visit_expr(elt); - for comprehension in generators { - visitor.visit_comprehension(comprehension); - } - } -} -impl AstNode for ast::ExprDictComp { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprDictComp(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprDictComp(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprDictComp) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprDictComp { - key, - value, - generators, - range: _, - } = self; - - visitor.visit_expr(key); - visitor.visit_expr(value); - - for comprehension in generators { - visitor.visit_comprehension(comprehension); - } - } -} -impl AstNode for ast::ExprGenerator { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprGenerator(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprGenerator(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprGenerator) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprGenerator { - elt, - generators, - range: _, - parenthesized: _, - } = self; - visitor.visit_expr(elt); - for comprehension in generators { - visitor.visit_comprehension(comprehension); - } - } -} -impl AstNode for ast::ExprAwait { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprAwait(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprAwait(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprAwait) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprAwait { value, range: _ } = self; - visitor.visit_expr(value); - } -} -impl AstNode for ast::ExprYield { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprYield(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprYield(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprYield) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprYield { value, range: _ } = self; - if let Some(expr) = value { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::ExprYieldFrom { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprYieldFrom(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprYieldFrom(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprYieldFrom) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprYieldFrom { value, range: _ } = self; - visitor.visit_expr(value); - } -} -impl AstNode for ast::ExprCompare { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprCompare(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprCompare(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprCompare) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprCompare { - left, - ops, - comparators, - range: _, - } = self; - - visitor.visit_expr(left); - - for (op, comparator) in ops.iter().zip(comparators) { - visitor.visit_cmp_op(op); - visitor.visit_expr(comparator); - } - } -} -impl AstNode for ast::ExprCall { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprCall(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprCall(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprCall) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprCall { - func, - arguments, - range: _, - } = self; - visitor.visit_expr(func); - visitor.visit_arguments(arguments); - } -} -impl AstNode for ast::FStringFormatSpec { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::FStringFormatSpec(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::FStringFormatSpec(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::FStringFormatSpec) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - for element in &self.elements { - visitor.visit_f_string_element(element); - } - } -} -impl AstNode for ast::FStringExpressionElement { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::FStringExpressionElement(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::FStringExpressionElement(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::FStringExpressionElement) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::FStringExpressionElement { - expression, - format_spec, - .. - } = self; - visitor.visit_expr(expression); - - if let Some(format_spec) = format_spec { - for spec_part in &format_spec.elements { - visitor.visit_f_string_element(spec_part); - } - } - } -} -impl AstNode for ast::FStringLiteralElement { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::FStringLiteralElement(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::FStringLiteralElement(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::FStringLiteralElement) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprFString { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprFString(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprFString(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprFString) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprFString { value, range: _ } = self; - - for f_string_part in value { - match f_string_part { - ast::FStringPart::Literal(string_literal) => { - visitor.visit_string_literal(string_literal); - } - ast::FStringPart::FString(f_string) => { - visitor.visit_f_string(f_string); - } - } - } - } -} -impl AstNode for ast::ExprStringLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprStringLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprStringLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprStringLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprStringLiteral { value, range: _ } = self; - - for string_literal in value { - visitor.visit_string_literal(string_literal); - } - } -} -impl AstNode for ast::ExprBytesLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprBytesLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprBytesLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprBytesLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprBytesLiteral { value, range: _ } = self; - - for bytes_literal in value { - visitor.visit_bytes_literal(bytes_literal); - } - } -} -impl AstNode for ast::ExprNumberLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprNumberLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprNumberLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprNumberLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprBooleanLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprBooleanLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprBooleanLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprBooleanLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprNoneLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprNoneLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprNoneLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprNoneLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprEllipsisLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprEllipsisLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprEllipsisLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprEllipsisLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::ExprAttribute { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprAttribute(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprAttribute(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprAttribute) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprAttribute { - value, - attr: _, - ctx: _, - range: _, - } = self; - - visitor.visit_expr(value); - } -} -impl AstNode for ast::ExprSubscript { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprSubscript(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprSubscript(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprSubscript) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprSubscript { - value, - slice, - ctx: _, - range: _, - } = self; - visitor.visit_expr(value); - visitor.visit_expr(slice); - } -} -impl AstNode for ast::ExprStarred { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprStarred(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprStarred(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprStarred) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprStarred { - value, - ctx: _, - range: _, - } = self; - - visitor.visit_expr(value); - } -} -impl AstNode for ast::ExprName { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprName(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprName(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprName) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprName { - id: _, - ctx: _, - range: _, - } = self; - } -} -impl AstNode for ast::ExprList { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprList(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprList(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprList) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprList { - elts, - ctx: _, - range: _, - } = self; - - for expr in elts { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::ExprTuple { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprTuple(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprTuple(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprTuple) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprTuple { - elts, - ctx: _, - range: _, - parenthesized: _, - } = self; - - for expr in elts { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::ExprSlice { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprSlice(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprSlice(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprSlice) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprSlice { - lower, - upper, - step, - range: _, - } = self; - - if let Some(expr) = lower { - visitor.visit_expr(expr); - } - if let Some(expr) = upper { - visitor.visit_expr(expr); - } - if let Some(expr) = step { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::ExprIpyEscapeCommand { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExprIpyEscapeCommand(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExprIpyEscapeCommand(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExprIpyEscapeCommand) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExprIpyEscapeCommand { - range: _, - kind: _, - value: _, - } = self; - } -} -impl AstNode for ast::ExceptHandlerExceptHandler { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ExceptHandlerExceptHandler(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ExceptHandlerExceptHandler(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ExceptHandlerExceptHandler) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ExceptHandlerExceptHandler { - range: _, - type_, - name: _, - body, - } = self; - if let Some(expr) = type_ { - visitor.visit_expr(expr); - } - visitor.visit_body(body); - } -} -impl AstNode for ast::PatternMatchValue { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchValue(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchValue(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchValue) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchValue { value, range: _ } = self; - visitor.visit_expr(value); - } -} -impl AstNode for ast::PatternMatchSingleton { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchSingleton(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchSingleton(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchSingleton) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchSingleton { value, range: _ } = self; - visitor.visit_singleton(value); - } -} -impl AstNode for ast::PatternMatchSequence { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchSequence(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchSequence(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchSequence) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchSequence { patterns, range: _ } = self; - for pattern in patterns { - visitor.visit_pattern(pattern); - } - } -} -impl AstNode for ast::PatternMatchMapping { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchMapping(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchMapping(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchMapping) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchMapping { - keys, - patterns, - range: _, - rest: _, - } = self; - for (key, pattern) in keys.iter().zip(patterns) { - visitor.visit_expr(key); - visitor.visit_pattern(pattern); - } - } -} -impl AstNode for ast::PatternMatchClass { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchClass(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchClass(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchClass) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchClass { - cls, - arguments: parameters, - range: _, - } = self; - visitor.visit_expr(cls); - visitor.visit_pattern_arguments(parameters); - } -} -impl AstNode for ast::PatternMatchStar { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchStar(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchStar(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchStar) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchStar { range: _, name: _ } = self; - } -} -impl AstNode for ast::PatternMatchAs { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchAs(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchAs(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchAs) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchAs { - pattern, - range: _, - name: _, - } = self; - if let Some(pattern) = pattern { - visitor.visit_pattern(pattern); - } - } -} -impl AstNode for ast::PatternMatchOr { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternMatchOr(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternMatchOr(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternMatchOr) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::PatternMatchOr { patterns, range: _ } = self; - for pattern in patterns { - visitor.visit_pattern(pattern); - } - } -} -impl AstNode for PatternArguments { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternArguments(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternArguments(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternArguments) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let PatternArguments { - range: _, - patterns, - keywords, - } = self; - - for pattern in patterns { - visitor.visit_pattern(pattern); - } - - for keyword in keywords { - visitor.visit_pattern_keyword(keyword); - } - } -} -impl AstNode for PatternKeyword { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::PatternKeyword(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::PatternKeyword(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::PatternKeyword) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let PatternKeyword { - range: _, - attr: _, - pattern, - } = self; - - visitor.visit_pattern(pattern); - } -} - -impl AstNode for Comprehension { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Comprehension(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Comprehension(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Comprehension) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::Comprehension { - range: _, - target, - iter, - ifs, - is_async: _, - } = self; - visitor.visit_expr(target); - visitor.visit_expr(iter); - - for expr in ifs { - visitor.visit_expr(expr); - } - } -} -impl AstNode for Arguments { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Arguments(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Arguments(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Arguments) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - for arg_or_keyword in self.arguments_source_order() { - match arg_or_keyword { - ArgOrKeyword::Arg(arg) => visitor.visit_expr(arg), - ArgOrKeyword::Keyword(keyword) => visitor.visit_keyword(keyword), - } - } - } -} -impl AstNode for Parameters { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Parameters(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Parameters(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Parameters) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - for parameter in self { - match parameter { - AnyParameterRef::NonVariadic(parameter_with_default) => { - visitor.visit_parameter_with_default(parameter_with_default); - } - AnyParameterRef::Variadic(parameter) => visitor.visit_parameter(parameter), - } - } - } -} -impl AstNode for Parameter { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Parameter(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Parameter(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Parameter) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::Parameter { - range: _, - name: _, - annotation, - } = self; - - if let Some(expr) = annotation { - visitor.visit_annotation(expr); - } - } -} -impl AstNode for ParameterWithDefault { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::ParameterWithDefault(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::ParameterWithDefault(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::ParameterWithDefault) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::ParameterWithDefault { - range: _, - parameter, - default, - } = self; - visitor.visit_parameter(parameter); - if let Some(expr) = default { - visitor.visit_expr(expr); - } - } -} -impl AstNode for Keyword { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Keyword(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Keyword(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Keyword) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::Keyword { - range: _, - arg: _, - value, - } = self; - - visitor.visit_expr(value); - } -} -impl AstNode for Alias { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Alias(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Alias(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Alias) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::Alias { - range: _, - name: _, - asname: _, - } = self; - } -} -impl AstNode for WithItem { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::WithItem(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::WithItem(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::WithItem) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::WithItem { - range: _, - context_expr, - optional_vars, - } = self; - - visitor.visit_expr(context_expr); - - if let Some(expr) = optional_vars { - visitor.visit_expr(expr); - } - } -} -impl AstNode for MatchCase { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::MatchCase(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::MatchCase(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::MatchCase) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::MatchCase { - range: _, - pattern, - guard, - body, - } = self; - - visitor.visit_pattern(pattern); - if let Some(expr) = guard { - visitor.visit_expr(expr); - } - visitor.visit_body(body); - } -} - -impl AstNode for Decorator { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Decorator(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::Decorator(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Decorator) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::Decorator { - range: _, - expression, - } = self; - - visitor.visit_expr(expression); - } -} -impl AstNode for ast::TypeParams { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::TypeParams(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::TypeParams(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::TypeParams) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::TypeParams { - range: _, - type_params, - } = self; - - for type_param in type_params { - visitor.visit_type_param(type_param); - } - } -} -impl AstNode for ast::TypeParamTypeVar { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::TypeParamTypeVar(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::TypeParamTypeVar(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::TypeParamTypeVar) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::TypeParamTypeVar { - bound, - default, - name: _, - range: _, - } = self; - - if let Some(expr) = bound { - visitor.visit_expr(expr); - } - if let Some(expr) = default { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::TypeParamTypeVarTuple { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::TypeParamTypeVarTuple(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::TypeParamTypeVarTuple(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::TypeParamTypeVarTuple) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::TypeParamTypeVarTuple { - range: _, - name: _, - default, - } = self; - if let Some(expr) = default { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::TypeParamParamSpec { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::TypeParamParamSpec(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::TypeParamParamSpec(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::TypeParamParamSpec) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - #[inline] - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::TypeParamParamSpec { - range: _, - name: _, - default, - } = self; - if let Some(expr) = default { - visitor.visit_expr(expr); - } - } -} -impl AstNode for ast::FString { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::FString(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::FString(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::FString) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - let ast::FString { - elements, - range: _, - flags: _, - } = self; - - for fstring_element in elements { - visitor.visit_f_string_element(fstring_element); - } - } -} -impl AstNode for ast::StringLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::StringLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::StringLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::StringLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} -impl AstNode for ast::BytesLiteral { - type Ref<'a> = &'a Self; - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::BytesLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<&Self> { - if let AnyNodeRef::BytesLiteral(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::BytesLiteral) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} - -impl AstNode for ast::Identifier { - type Ref<'a> = &'a Self; - - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - if let AnyNode::Identifier(node) = kind { - Some(node) - } else { - None - } - } - - fn cast_ref(kind: AnyNodeRef<'_>) -> Option<Self::Ref<'_>> { - if let AnyNodeRef::Identifier(node) = kind { - Some(node) - } else { - None - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!(kind, NodeKind::Identifier) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - AnyNodeRef::from(self) - } - - fn into_any_node(self) -> AnyNode { - AnyNode::from(self) - } - - fn visit_source_order<'a, V>(&'a self, _visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - } -} - -impl AstNode for Stmt { - type Ref<'a> = StatementRef<'a>; - - fn cast(kind: AnyNode) -> Option<Self> { - match kind { - AnyNode::StmtFunctionDef(node) => Some(Stmt::FunctionDef(node)), - AnyNode::StmtClassDef(node) => Some(Stmt::ClassDef(node)), - AnyNode::StmtReturn(node) => Some(Stmt::Return(node)), - AnyNode::StmtDelete(node) => Some(Stmt::Delete(node)), - AnyNode::StmtTypeAlias(node) => Some(Stmt::TypeAlias(node)), - AnyNode::StmtAssign(node) => Some(Stmt::Assign(node)), - AnyNode::StmtAugAssign(node) => Some(Stmt::AugAssign(node)), - AnyNode::StmtAnnAssign(node) => Some(Stmt::AnnAssign(node)), - AnyNode::StmtFor(node) => Some(Stmt::For(node)), - AnyNode::StmtWhile(node) => Some(Stmt::While(node)), - AnyNode::StmtIf(node) => Some(Stmt::If(node)), - AnyNode::StmtWith(node) => Some(Stmt::With(node)), - AnyNode::StmtMatch(node) => Some(Stmt::Match(node)), - AnyNode::StmtRaise(node) => Some(Stmt::Raise(node)), - AnyNode::StmtTry(node) => Some(Stmt::Try(node)), - AnyNode::StmtAssert(node) => Some(Stmt::Assert(node)), - AnyNode::StmtImport(node) => Some(Stmt::Import(node)), - AnyNode::StmtImportFrom(node) => Some(Stmt::ImportFrom(node)), - AnyNode::StmtGlobal(node) => Some(Stmt::Global(node)), - AnyNode::StmtNonlocal(node) => Some(Stmt::Nonlocal(node)), - AnyNode::StmtExpr(node) => Some(Stmt::Expr(node)), - AnyNode::StmtPass(node) => Some(Stmt::Pass(node)), - AnyNode::StmtBreak(node) => Some(Stmt::Break(node)), - AnyNode::StmtContinue(node) => Some(Stmt::Continue(node)), - AnyNode::StmtIpyEscapeCommand(node) => Some(Stmt::IpyEscapeCommand(node)), - - AnyNode::ModModule(_) - | AnyNode::ModExpression(_) - | AnyNode::ExprBoolOp(_) - | AnyNode::ExprNamed(_) - | AnyNode::ExprBinOp(_) - | AnyNode::ExprUnaryOp(_) - | AnyNode::ExprLambda(_) - | AnyNode::ExprIf(_) - | AnyNode::ExprDict(_) - | AnyNode::ExprSet(_) - | AnyNode::ExprListComp(_) - | AnyNode::ExprSetComp(_) - | AnyNode::ExprDictComp(_) - | AnyNode::ExprGenerator(_) - | AnyNode::ExprAwait(_) - | AnyNode::ExprYield(_) - | AnyNode::ExprYieldFrom(_) - | AnyNode::ExprCompare(_) - | AnyNode::ExprCall(_) - | AnyNode::FStringExpressionElement(_) - | AnyNode::FStringLiteralElement(_) - | AnyNode::FStringFormatSpec(_) - | AnyNode::ExprFString(_) - | AnyNode::ExprStringLiteral(_) - | AnyNode::ExprBytesLiteral(_) - | AnyNode::ExprNumberLiteral(_) - | AnyNode::ExprBooleanLiteral(_) - | AnyNode::ExprNoneLiteral(_) - | AnyNode::ExprEllipsisLiteral(_) - | AnyNode::ExprAttribute(_) - | AnyNode::ExprSubscript(_) - | AnyNode::ExprStarred(_) - | AnyNode::ExprName(_) - | AnyNode::ExprList(_) - | AnyNode::ExprTuple(_) - | AnyNode::ExprSlice(_) - | AnyNode::ExprIpyEscapeCommand(_) - | AnyNode::ExceptHandlerExceptHandler(_) - | AnyNode::PatternMatchValue(_) - | AnyNode::PatternMatchSingleton(_) - | AnyNode::PatternMatchSequence(_) - | AnyNode::PatternMatchMapping(_) - | AnyNode::PatternMatchClass(_) - | AnyNode::PatternMatchStar(_) - | AnyNode::PatternMatchAs(_) - | AnyNode::PatternMatchOr(_) - | AnyNode::PatternArguments(_) - | AnyNode::PatternKeyword(_) - | AnyNode::Comprehension(_) - | AnyNode::Arguments(_) - | AnyNode::Parameters(_) - | AnyNode::Parameter(_) - | AnyNode::ParameterWithDefault(_) - | AnyNode::Keyword(_) - | AnyNode::Alias(_) - | AnyNode::WithItem(_) - | AnyNode::MatchCase(_) - | AnyNode::Decorator(_) - | AnyNode::TypeParams(_) - | AnyNode::TypeParamTypeVar(_) - | AnyNode::TypeParamTypeVarTuple(_) - | AnyNode::TypeParamParamSpec(_) - | AnyNode::FString(_) - | AnyNode::StringLiteral(_) - | AnyNode::BytesLiteral(_) - | AnyNode::Identifier(_) - | AnyNode::ElifElseClause(_) => None, - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<Self::Ref<'_>> { - match kind { - AnyNodeRef::StmtFunctionDef(statement) => Some(StatementRef::FunctionDef(statement)), - AnyNodeRef::StmtClassDef(statement) => Some(StatementRef::ClassDef(statement)), - AnyNodeRef::StmtReturn(statement) => Some(StatementRef::Return(statement)), - AnyNodeRef::StmtDelete(statement) => Some(StatementRef::Delete(statement)), - AnyNodeRef::StmtTypeAlias(statement) => Some(StatementRef::TypeAlias(statement)), - AnyNodeRef::StmtAssign(statement) => Some(StatementRef::Assign(statement)), - AnyNodeRef::StmtAugAssign(statement) => Some(StatementRef::AugAssign(statement)), - AnyNodeRef::StmtAnnAssign(statement) => Some(StatementRef::AnnAssign(statement)), - AnyNodeRef::StmtFor(statement) => Some(StatementRef::For(statement)), - AnyNodeRef::StmtWhile(statement) => Some(StatementRef::While(statement)), - AnyNodeRef::StmtIf(statement) => Some(StatementRef::If(statement)), - AnyNodeRef::StmtWith(statement) => Some(StatementRef::With(statement)), - AnyNodeRef::StmtMatch(statement) => Some(StatementRef::Match(statement)), - AnyNodeRef::StmtRaise(statement) => Some(StatementRef::Raise(statement)), - AnyNodeRef::StmtTry(statement) => Some(StatementRef::Try(statement)), - AnyNodeRef::StmtAssert(statement) => Some(StatementRef::Assert(statement)), - AnyNodeRef::StmtImport(statement) => Some(StatementRef::Import(statement)), - AnyNodeRef::StmtImportFrom(statement) => Some(StatementRef::ImportFrom(statement)), - AnyNodeRef::StmtGlobal(statement) => Some(StatementRef::Global(statement)), - AnyNodeRef::StmtNonlocal(statement) => Some(StatementRef::Nonlocal(statement)), - AnyNodeRef::StmtExpr(statement) => Some(StatementRef::Expr(statement)), - AnyNodeRef::StmtPass(statement) => Some(StatementRef::Pass(statement)), - AnyNodeRef::StmtBreak(statement) => Some(StatementRef::Break(statement)), - AnyNodeRef::StmtContinue(statement) => Some(StatementRef::Continue(statement)), - AnyNodeRef::StmtIpyEscapeCommand(statement) => { - Some(StatementRef::IpyEscapeCommand(statement)) - } - AnyNodeRef::ModModule(_) - | AnyNodeRef::ModExpression(_) - | AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) - | AnyNodeRef::ExceptHandlerExceptHandler(_) - | AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => None, - } - } - - fn can_cast(kind: NodeKind) -> bool { - match kind { - NodeKind::StmtClassDef - | NodeKind::StmtReturn - | NodeKind::StmtDelete - | NodeKind::StmtTypeAlias - | NodeKind::StmtAssign - | NodeKind::StmtAugAssign - | NodeKind::StmtAnnAssign - | NodeKind::StmtFor - | NodeKind::StmtWhile - | NodeKind::StmtIf - | NodeKind::StmtWith - | NodeKind::StmtMatch - | NodeKind::StmtRaise - | NodeKind::StmtTry - | NodeKind::StmtAssert - | NodeKind::StmtImport - | NodeKind::StmtImportFrom - | NodeKind::StmtGlobal - | NodeKind::StmtNonlocal - | NodeKind::StmtIpyEscapeCommand - | NodeKind::StmtExpr - | NodeKind::StmtPass - | NodeKind::StmtBreak - | NodeKind::StmtContinue => true, - NodeKind::ExprBoolOp - | NodeKind::ModModule - | NodeKind::ModInteractive - | NodeKind::ModExpression - | NodeKind::ModFunctionType - | NodeKind::StmtFunctionDef - | NodeKind::ExprNamed - | NodeKind::ExprBinOp - | NodeKind::ExprUnaryOp - | NodeKind::ExprLambda - | NodeKind::ExprIf - | NodeKind::ExprDict - | NodeKind::ExprSet - | NodeKind::ExprListComp - | NodeKind::ExprSetComp - | NodeKind::ExprDictComp - | NodeKind::ExprGenerator - | NodeKind::ExprAwait - | NodeKind::ExprYield - | NodeKind::ExprYieldFrom - | NodeKind::ExprCompare - | NodeKind::ExprCall - | NodeKind::FStringExpressionElement - | NodeKind::FStringLiteralElement - | NodeKind::FStringFormatSpec - | NodeKind::ExprFString - | NodeKind::ExprStringLiteral - | NodeKind::ExprBytesLiteral - | NodeKind::ExprNumberLiteral - | NodeKind::ExprBooleanLiteral - | NodeKind::ExprNoneLiteral - | NodeKind::ExprEllipsisLiteral - | NodeKind::ExprAttribute - | NodeKind::ExprSubscript - | NodeKind::ExprStarred - | NodeKind::ExprName - | NodeKind::ExprList - | NodeKind::ExprTuple - | NodeKind::ExprSlice - | NodeKind::ExprIpyEscapeCommand - | NodeKind::ExceptHandlerExceptHandler - | NodeKind::PatternMatchValue - | NodeKind::PatternMatchSingleton - | NodeKind::PatternMatchSequence - | NodeKind::PatternMatchMapping - | NodeKind::PatternMatchClass - | NodeKind::PatternMatchStar - | NodeKind::PatternMatchAs - | NodeKind::PatternMatchOr - | NodeKind::PatternArguments - | NodeKind::PatternKeyword - | NodeKind::TypeIgnoreTypeIgnore - | NodeKind::Comprehension - | NodeKind::Arguments - | NodeKind::Parameters - | NodeKind::Parameter - | NodeKind::ParameterWithDefault - | NodeKind::Keyword - | NodeKind::Alias - | NodeKind::WithItem - | NodeKind::MatchCase - | NodeKind::Decorator - | NodeKind::ElifElseClause - | NodeKind::TypeParams - | NodeKind::TypeParamTypeVar - | NodeKind::TypeParamTypeVarTuple - | NodeKind::TypeParamParamSpec - | NodeKind::FString - | NodeKind::StringLiteral - | NodeKind::Identifier - | NodeKind::BytesLiteral => false, - } - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - match self { - Stmt::FunctionDef(stmt) => stmt.as_any_node_ref(), - Stmt::ClassDef(stmt) => stmt.as_any_node_ref(), - Stmt::Return(stmt) => stmt.as_any_node_ref(), - Stmt::Delete(stmt) => stmt.as_any_node_ref(), - Stmt::Assign(stmt) => stmt.as_any_node_ref(), - Stmt::AugAssign(stmt) => stmt.as_any_node_ref(), - Stmt::AnnAssign(stmt) => stmt.as_any_node_ref(), - Stmt::TypeAlias(stmt) => stmt.as_any_node_ref(), - Stmt::For(stmt) => stmt.as_any_node_ref(), - Stmt::While(stmt) => stmt.as_any_node_ref(), - Stmt::If(stmt) => stmt.as_any_node_ref(), - Stmt::With(stmt) => stmt.as_any_node_ref(), - Stmt::Match(stmt) => stmt.as_any_node_ref(), - Stmt::Raise(stmt) => stmt.as_any_node_ref(), - Stmt::Try(stmt) => stmt.as_any_node_ref(), - Stmt::Assert(stmt) => stmt.as_any_node_ref(), - Stmt::Import(stmt) => stmt.as_any_node_ref(), - Stmt::ImportFrom(stmt) => stmt.as_any_node_ref(), - Stmt::Global(stmt) => stmt.as_any_node_ref(), - Stmt::Nonlocal(stmt) => stmt.as_any_node_ref(), - Stmt::Expr(stmt) => stmt.as_any_node_ref(), - Stmt::Pass(stmt) => stmt.as_any_node_ref(), - Stmt::Break(stmt) => stmt.as_any_node_ref(), - Stmt::Continue(stmt) => stmt.as_any_node_ref(), - Stmt::IpyEscapeCommand(stmt) => stmt.as_any_node_ref(), - } - } - - fn into_any_node(self) -> AnyNode { - match self { - Stmt::FunctionDef(stmt) => stmt.into_any_node(), - Stmt::ClassDef(stmt) => stmt.into_any_node(), - Stmt::Return(stmt) => stmt.into_any_node(), - Stmt::Delete(stmt) => stmt.into_any_node(), - Stmt::Assign(stmt) => stmt.into_any_node(), - Stmt::AugAssign(stmt) => stmt.into_any_node(), - Stmt::AnnAssign(stmt) => stmt.into_any_node(), - Stmt::TypeAlias(stmt) => stmt.into_any_node(), - Stmt::For(stmt) => stmt.into_any_node(), - Stmt::While(stmt) => stmt.into_any_node(), - Stmt::If(stmt) => stmt.into_any_node(), - Stmt::With(stmt) => stmt.into_any_node(), - Stmt::Match(stmt) => stmt.into_any_node(), - Stmt::Raise(stmt) => stmt.into_any_node(), - Stmt::Try(stmt) => stmt.into_any_node(), - Stmt::Assert(stmt) => stmt.into_any_node(), - Stmt::Import(stmt) => stmt.into_any_node(), - Stmt::ImportFrom(stmt) => stmt.into_any_node(), - Stmt::Global(stmt) => stmt.into_any_node(), - Stmt::Nonlocal(stmt) => stmt.into_any_node(), - Stmt::Expr(stmt) => stmt.into_any_node(), - Stmt::Pass(stmt) => stmt.into_any_node(), - Stmt::Break(stmt) => stmt.into_any_node(), - Stmt::Continue(stmt) => stmt.into_any_node(), - Stmt::IpyEscapeCommand(stmt) => stmt.into_any_node(), - } - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - match self { - Stmt::FunctionDef(stmt) => stmt.visit_source_order(visitor), - Stmt::ClassDef(stmt) => stmt.visit_source_order(visitor), - Stmt::Return(stmt) => stmt.visit_source_order(visitor), - Stmt::Delete(stmt) => stmt.visit_source_order(visitor), - Stmt::Assign(stmt) => stmt.visit_source_order(visitor), - Stmt::AugAssign(stmt) => stmt.visit_source_order(visitor), - Stmt::AnnAssign(stmt) => stmt.visit_source_order(visitor), - Stmt::TypeAlias(stmt) => stmt.visit_source_order(visitor), - Stmt::For(stmt) => stmt.visit_source_order(visitor), - Stmt::While(stmt) => stmt.visit_source_order(visitor), - Stmt::If(stmt) => stmt.visit_source_order(visitor), - Stmt::With(stmt) => stmt.visit_source_order(visitor), - Stmt::Match(stmt) => stmt.visit_source_order(visitor), - Stmt::Raise(stmt) => stmt.visit_source_order(visitor), - Stmt::Try(stmt) => stmt.visit_source_order(visitor), - Stmt::Assert(stmt) => stmt.visit_source_order(visitor), - Stmt::Import(stmt) => stmt.visit_source_order(visitor), - Stmt::ImportFrom(stmt) => stmt.visit_source_order(visitor), - Stmt::Global(stmt) => stmt.visit_source_order(visitor), - Stmt::Nonlocal(stmt) => stmt.visit_source_order(visitor), - Stmt::Expr(stmt) => stmt.visit_source_order(visitor), - Stmt::Pass(stmt) => stmt.visit_source_order(visitor), - Stmt::Break(stmt) => stmt.visit_source_order(visitor), - Stmt::Continue(stmt) => stmt.visit_source_order(visitor), - Stmt::IpyEscapeCommand(stmt) => stmt.visit_source_order(visitor), - } - } -} - -impl AstNode for TypeParam { - type Ref<'a> = TypeParamRef<'a>; - - fn cast(kind: AnyNode) -> Option<Self> - where - Self: Sized, - { - match kind { - AnyNode::TypeParamTypeVar(node) => Some(TypeParam::TypeVar(node)), - AnyNode::TypeParamTypeVarTuple(node) => Some(TypeParam::TypeVarTuple(node)), - AnyNode::TypeParamParamSpec(node) => Some(TypeParam::ParamSpec(node)), - _ => None, - } - } - - fn cast_ref(kind: AnyNodeRef) -> Option<Self::Ref<'_>> { - match kind { - AnyNodeRef::TypeParamTypeVar(node) => Some(TypeParamRef::TypeVar(node)), - AnyNodeRef::TypeParamTypeVarTuple(node) => Some(TypeParamRef::TypeVarTuple(node)), - AnyNodeRef::TypeParamParamSpec(node) => Some(TypeParamRef::ParamSpec(node)), - _ => None, - } - } - - fn can_cast(kind: NodeKind) -> bool { - matches!( - kind, - NodeKind::TypeParamTypeVar - | NodeKind::TypeParamTypeVarTuple - | NodeKind::TypeParamParamSpec - ) - } - - fn as_any_node_ref(&self) -> AnyNodeRef { - match self { - TypeParam::TypeVar(node) => node.as_any_node_ref(), - TypeParam::TypeVarTuple(node) => node.as_any_node_ref(), - TypeParam::ParamSpec(node) => node.as_any_node_ref(), - } - } - - fn into_any_node(self) -> AnyNode { - match self { - TypeParam::TypeVar(node) => node.into_any_node(), - TypeParam::TypeVarTuple(node) => node.into_any_node(), - TypeParam::ParamSpec(node) => node.into_any_node(), - } - } - - fn visit_source_order<'a, V>(&'a self, visitor: &mut V) - where - V: SourceOrderVisitor<'a> + ?Sized, - { - match self { - TypeParam::TypeVar(node) => node.visit_source_order(visitor), - TypeParam::TypeVarTuple(node) => node.visit_source_order(visitor), - TypeParam::ParamSpec(node) => node.visit_source_order(visitor), - } - } -} - -impl From<Stmt> for AnyNode { - fn from(stmt: Stmt) -> Self { - match stmt { - Stmt::FunctionDef(node) => AnyNode::StmtFunctionDef(node), - Stmt::ClassDef(node) => AnyNode::StmtClassDef(node), - Stmt::Return(node) => AnyNode::StmtReturn(node), - Stmt::Delete(node) => AnyNode::StmtDelete(node), - Stmt::TypeAlias(node) => AnyNode::StmtTypeAlias(node), - Stmt::Assign(node) => AnyNode::StmtAssign(node), - Stmt::AugAssign(node) => AnyNode::StmtAugAssign(node), - Stmt::AnnAssign(node) => AnyNode::StmtAnnAssign(node), - Stmt::For(node) => AnyNode::StmtFor(node), - Stmt::While(node) => AnyNode::StmtWhile(node), - Stmt::If(node) => AnyNode::StmtIf(node), - Stmt::With(node) => AnyNode::StmtWith(node), - Stmt::Match(node) => AnyNode::StmtMatch(node), - Stmt::Raise(node) => AnyNode::StmtRaise(node), - Stmt::Try(node) => AnyNode::StmtTry(node), - Stmt::Assert(node) => AnyNode::StmtAssert(node), - Stmt::Import(node) => AnyNode::StmtImport(node), - Stmt::ImportFrom(node) => AnyNode::StmtImportFrom(node), - Stmt::Global(node) => AnyNode::StmtGlobal(node), - Stmt::Nonlocal(node) => AnyNode::StmtNonlocal(node), - Stmt::Expr(node) => AnyNode::StmtExpr(node), - Stmt::Pass(node) => AnyNode::StmtPass(node), - Stmt::Break(node) => AnyNode::StmtBreak(node), - Stmt::Continue(node) => AnyNode::StmtContinue(node), - Stmt::IpyEscapeCommand(node) => AnyNode::StmtIpyEscapeCommand(node), - } - } -} - -impl From<Expr> for AnyNode { - fn from(expr: Expr) -> Self { - match expr { - Expr::BoolOp(node) => AnyNode::ExprBoolOp(node), - Expr::Named(node) => AnyNode::ExprNamed(node), - Expr::BinOp(node) => AnyNode::ExprBinOp(node), - Expr::UnaryOp(node) => AnyNode::ExprUnaryOp(node), - Expr::Lambda(node) => AnyNode::ExprLambda(node), - Expr::If(node) => AnyNode::ExprIf(node), - Expr::Dict(node) => AnyNode::ExprDict(node), - Expr::Set(node) => AnyNode::ExprSet(node), - Expr::ListComp(node) => AnyNode::ExprListComp(node), - Expr::SetComp(node) => AnyNode::ExprSetComp(node), - Expr::DictComp(node) => AnyNode::ExprDictComp(node), - Expr::Generator(node) => AnyNode::ExprGenerator(node), - Expr::Await(node) => AnyNode::ExprAwait(node), - Expr::Yield(node) => AnyNode::ExprYield(node), - Expr::YieldFrom(node) => AnyNode::ExprYieldFrom(node), - Expr::Compare(node) => AnyNode::ExprCompare(node), - Expr::Call(node) => AnyNode::ExprCall(node), - Expr::FString(node) => AnyNode::ExprFString(node), - Expr::StringLiteral(node) => AnyNode::ExprStringLiteral(node), - Expr::BytesLiteral(node) => AnyNode::ExprBytesLiteral(node), - Expr::NumberLiteral(node) => AnyNode::ExprNumberLiteral(node), - Expr::BooleanLiteral(node) => AnyNode::ExprBooleanLiteral(node), - Expr::NoneLiteral(node) => AnyNode::ExprNoneLiteral(node), - Expr::EllipsisLiteral(node) => AnyNode::ExprEllipsisLiteral(node), - Expr::Attribute(node) => AnyNode::ExprAttribute(node), - Expr::Subscript(node) => AnyNode::ExprSubscript(node), - Expr::Starred(node) => AnyNode::ExprStarred(node), - Expr::Name(node) => AnyNode::ExprName(node), - Expr::List(node) => AnyNode::ExprList(node), - Expr::Tuple(node) => AnyNode::ExprTuple(node), - Expr::Slice(node) => AnyNode::ExprSlice(node), - Expr::IpyEscapeCommand(node) => AnyNode::ExprIpyEscapeCommand(node), - } - } -} - -impl From<Mod> for AnyNode { - fn from(module: Mod) -> Self { - match module { - Mod::Module(node) => AnyNode::ModModule(node), - Mod::Expression(node) => AnyNode::ModExpression(node), - } - } -} - -impl From<FStringElement> for AnyNode { - fn from(element: FStringElement) -> Self { - match element { - FStringElement::Literal(node) => AnyNode::FStringLiteralElement(node), - FStringElement::Expression(node) => AnyNode::FStringExpressionElement(node), - } - } -} - -impl From<Pattern> for AnyNode { - fn from(pattern: Pattern) -> Self { - match pattern { - Pattern::MatchValue(node) => AnyNode::PatternMatchValue(node), - Pattern::MatchSingleton(node) => AnyNode::PatternMatchSingleton(node), - Pattern::MatchSequence(node) => AnyNode::PatternMatchSequence(node), - Pattern::MatchMapping(node) => AnyNode::PatternMatchMapping(node), - Pattern::MatchClass(node) => AnyNode::PatternMatchClass(node), - Pattern::MatchStar(node) => AnyNode::PatternMatchStar(node), - Pattern::MatchAs(node) => AnyNode::PatternMatchAs(node), - Pattern::MatchOr(node) => AnyNode::PatternMatchOr(node), - } - } -} - -impl From<ExceptHandler> for AnyNode { - fn from(handler: ExceptHandler) -> Self { - match handler { - ExceptHandler::ExceptHandler(handler) => AnyNode::ExceptHandlerExceptHandler(handler), - } - } -} - -impl From<ast::ModModule> for AnyNode { - fn from(node: ast::ModModule) -> Self { - AnyNode::ModModule(node) - } -} - -impl From<ast::ModExpression> for AnyNode { - fn from(node: ast::ModExpression) -> Self { - AnyNode::ModExpression(node) - } -} - -impl From<ast::StmtFunctionDef> for AnyNode { - fn from(node: ast::StmtFunctionDef) -> Self { - AnyNode::StmtFunctionDef(node) - } -} - -impl From<ast::StmtClassDef> for AnyNode { - fn from(node: ast::StmtClassDef) -> Self { - AnyNode::StmtClassDef(node) - } -} - -impl From<ast::StmtReturn> for AnyNode { - fn from(node: ast::StmtReturn) -> Self { - AnyNode::StmtReturn(node) - } -} - -impl From<ast::StmtDelete> for AnyNode { - fn from(node: ast::StmtDelete) -> Self { - AnyNode::StmtDelete(node) - } -} - -impl From<ast::StmtTypeAlias> for AnyNode { - fn from(node: ast::StmtTypeAlias) -> Self { - AnyNode::StmtTypeAlias(node) - } -} - -impl From<ast::StmtAssign> for AnyNode { - fn from(node: ast::StmtAssign) -> Self { - AnyNode::StmtAssign(node) - } -} - -impl From<ast::StmtAugAssign> for AnyNode { - fn from(node: ast::StmtAugAssign) -> Self { - AnyNode::StmtAugAssign(node) - } -} - -impl From<ast::StmtAnnAssign> for AnyNode { - fn from(node: ast::StmtAnnAssign) -> Self { - AnyNode::StmtAnnAssign(node) - } -} - -impl From<ast::StmtFor> for AnyNode { - fn from(node: ast::StmtFor) -> Self { - AnyNode::StmtFor(node) - } -} - -impl From<ast::StmtWhile> for AnyNode { - fn from(node: ast::StmtWhile) -> Self { - AnyNode::StmtWhile(node) - } -} - -impl From<ast::StmtIf> for AnyNode { - fn from(node: ast::StmtIf) -> Self { - AnyNode::StmtIf(node) - } -} - -impl From<ast::ElifElseClause> for AnyNode { - fn from(node: ast::ElifElseClause) -> Self { - AnyNode::ElifElseClause(node) - } -} - -impl From<ast::StmtWith> for AnyNode { - fn from(node: ast::StmtWith) -> Self { - AnyNode::StmtWith(node) - } -} - -impl From<ast::StmtMatch> for AnyNode { - fn from(node: ast::StmtMatch) -> Self { - AnyNode::StmtMatch(node) - } -} - -impl From<ast::StmtRaise> for AnyNode { - fn from(node: ast::StmtRaise) -> Self { - AnyNode::StmtRaise(node) - } -} - -impl From<ast::StmtTry> for AnyNode { - fn from(node: ast::StmtTry) -> Self { - AnyNode::StmtTry(node) - } -} - -impl From<ast::StmtAssert> for AnyNode { - fn from(node: ast::StmtAssert) -> Self { - AnyNode::StmtAssert(node) - } -} - -impl From<ast::StmtImport> for AnyNode { - fn from(node: ast::StmtImport) -> Self { - AnyNode::StmtImport(node) - } -} - -impl From<ast::StmtImportFrom> for AnyNode { - fn from(node: ast::StmtImportFrom) -> Self { - AnyNode::StmtImportFrom(node) - } -} - -impl From<ast::StmtGlobal> for AnyNode { - fn from(node: ast::StmtGlobal) -> Self { - AnyNode::StmtGlobal(node) - } -} - -impl From<ast::StmtNonlocal> for AnyNode { - fn from(node: ast::StmtNonlocal) -> Self { - AnyNode::StmtNonlocal(node) - } -} - -impl From<ast::StmtExpr> for AnyNode { - fn from(node: ast::StmtExpr) -> Self { - AnyNode::StmtExpr(node) - } -} - -impl From<ast::StmtPass> for AnyNode { - fn from(node: ast::StmtPass) -> Self { - AnyNode::StmtPass(node) - } -} - -impl From<ast::StmtBreak> for AnyNode { - fn from(node: ast::StmtBreak) -> Self { - AnyNode::StmtBreak(node) - } -} - -impl From<ast::StmtContinue> for AnyNode { - fn from(node: ast::StmtContinue) -> Self { - AnyNode::StmtContinue(node) - } -} - -impl From<ast::StmtIpyEscapeCommand> for AnyNode { - fn from(node: ast::StmtIpyEscapeCommand) -> Self { - AnyNode::StmtIpyEscapeCommand(node) - } -} - -impl From<ast::ExprBoolOp> for AnyNode { - fn from(node: ast::ExprBoolOp) -> Self { - AnyNode::ExprBoolOp(node) - } -} - -impl From<ast::ExprNamed> for AnyNode { - fn from(node: ast::ExprNamed) -> Self { - AnyNode::ExprNamed(node) - } -} - -impl From<ast::ExprBinOp> for AnyNode { - fn from(node: ast::ExprBinOp) -> Self { - AnyNode::ExprBinOp(node) - } -} - -impl From<ast::ExprUnaryOp> for AnyNode { - fn from(node: ast::ExprUnaryOp) -> Self { - AnyNode::ExprUnaryOp(node) - } -} - -impl From<ast::ExprLambda> for AnyNode { - fn from(node: ast::ExprLambda) -> Self { - AnyNode::ExprLambda(node) - } -} - -impl From<ast::ExprIf> for AnyNode { - fn from(node: ast::ExprIf) -> Self { - AnyNode::ExprIf(node) - } -} - -impl From<ast::ExprDict> for AnyNode { - fn from(node: ast::ExprDict) -> Self { - AnyNode::ExprDict(node) - } -} - -impl From<ast::ExprSet> for AnyNode { - fn from(node: ast::ExprSet) -> Self { - AnyNode::ExprSet(node) - } -} - -impl From<ast::ExprListComp> for AnyNode { - fn from(node: ast::ExprListComp) -> Self { - AnyNode::ExprListComp(node) - } -} - -impl From<ast::ExprSetComp> for AnyNode { - fn from(node: ast::ExprSetComp) -> Self { - AnyNode::ExprSetComp(node) - } -} - -impl From<ast::ExprDictComp> for AnyNode { - fn from(node: ast::ExprDictComp) -> Self { - AnyNode::ExprDictComp(node) - } -} - -impl From<ast::ExprGenerator> for AnyNode { - fn from(node: ast::ExprGenerator) -> Self { - AnyNode::ExprGenerator(node) - } -} - -impl From<ast::ExprAwait> for AnyNode { - fn from(node: ast::ExprAwait) -> Self { - AnyNode::ExprAwait(node) - } -} - -impl From<ast::ExprYield> for AnyNode { - fn from(node: ast::ExprYield) -> Self { - AnyNode::ExprYield(node) - } -} - -impl From<ast::ExprYieldFrom> for AnyNode { - fn from(node: ast::ExprYieldFrom) -> Self { - AnyNode::ExprYieldFrom(node) - } -} - -impl From<ast::ExprCompare> for AnyNode { - fn from(node: ast::ExprCompare) -> Self { - AnyNode::ExprCompare(node) - } -} - -impl From<ast::ExprCall> for AnyNode { - fn from(node: ast::ExprCall) -> Self { - AnyNode::ExprCall(node) - } -} - -impl From<ast::FStringExpressionElement> for AnyNode { - fn from(node: ast::FStringExpressionElement) -> Self { - AnyNode::FStringExpressionElement(node) - } -} - -impl From<ast::FStringLiteralElement> for AnyNode { - fn from(node: ast::FStringLiteralElement) -> Self { - AnyNode::FStringLiteralElement(node) - } -} - -impl From<ast::FStringFormatSpec> for AnyNode { - fn from(node: ast::FStringFormatSpec) -> Self { - AnyNode::FStringFormatSpec(node) - } -} - -impl From<ast::ExprFString> for AnyNode { - fn from(node: ast::ExprFString) -> Self { - AnyNode::ExprFString(node) - } -} - -impl From<ast::ExprStringLiteral> for AnyNode { - fn from(node: ast::ExprStringLiteral) -> Self { - AnyNode::ExprStringLiteral(node) - } -} - -impl From<ast::ExprBytesLiteral> for AnyNode { - fn from(node: ast::ExprBytesLiteral) -> Self { - AnyNode::ExprBytesLiteral(node) - } -} - -impl From<ast::ExprNumberLiteral> for AnyNode { - fn from(node: ast::ExprNumberLiteral) -> Self { - AnyNode::ExprNumberLiteral(node) - } -} - -impl From<ast::ExprBooleanLiteral> for AnyNode { - fn from(node: ast::ExprBooleanLiteral) -> Self { - AnyNode::ExprBooleanLiteral(node) - } -} - -impl From<ast::ExprNoneLiteral> for AnyNode { - fn from(node: ast::ExprNoneLiteral) -> Self { - AnyNode::ExprNoneLiteral(node) - } -} - -impl From<ast::ExprEllipsisLiteral> for AnyNode { - fn from(node: ast::ExprEllipsisLiteral) -> Self { - AnyNode::ExprEllipsisLiteral(node) - } -} - -impl From<ast::ExprAttribute> for AnyNode { - fn from(node: ast::ExprAttribute) -> Self { - AnyNode::ExprAttribute(node) - } -} - -impl From<ast::ExprSubscript> for AnyNode { - fn from(node: ast::ExprSubscript) -> Self { - AnyNode::ExprSubscript(node) - } -} - -impl From<ast::ExprStarred> for AnyNode { - fn from(node: ast::ExprStarred) -> Self { - AnyNode::ExprStarred(node) - } -} - -impl From<ast::ExprName> for AnyNode { - fn from(node: ast::ExprName) -> Self { - AnyNode::ExprName(node) - } -} - -impl From<ast::ExprList> for AnyNode { - fn from(node: ast::ExprList) -> Self { - AnyNode::ExprList(node) - } -} - -impl From<ast::ExprTuple> for AnyNode { - fn from(node: ast::ExprTuple) -> Self { - AnyNode::ExprTuple(node) - } -} - -impl From<ast::ExprSlice> for AnyNode { - fn from(node: ast::ExprSlice) -> Self { - AnyNode::ExprSlice(node) - } -} - -impl From<ast::ExprIpyEscapeCommand> for AnyNode { - fn from(node: ast::ExprIpyEscapeCommand) -> Self { - AnyNode::ExprIpyEscapeCommand(node) - } -} - -impl From<ast::ExceptHandlerExceptHandler> for AnyNode { - fn from(node: ast::ExceptHandlerExceptHandler) -> Self { - AnyNode::ExceptHandlerExceptHandler(node) - } -} - -impl From<ast::PatternMatchValue> for AnyNode { - fn from(node: ast::PatternMatchValue) -> Self { - AnyNode::PatternMatchValue(node) - } -} - -impl From<ast::PatternMatchSingleton> for AnyNode { - fn from(node: ast::PatternMatchSingleton) -> Self { - AnyNode::PatternMatchSingleton(node) - } -} - -impl From<ast::PatternMatchSequence> for AnyNode { - fn from(node: ast::PatternMatchSequence) -> Self { - AnyNode::PatternMatchSequence(node) - } -} - -impl From<ast::PatternMatchMapping> for AnyNode { - fn from(node: ast::PatternMatchMapping) -> Self { - AnyNode::PatternMatchMapping(node) - } -} - -impl From<ast::PatternMatchClass> for AnyNode { - fn from(node: ast::PatternMatchClass) -> Self { - AnyNode::PatternMatchClass(node) - } -} - -impl From<ast::PatternMatchStar> for AnyNode { - fn from(node: ast::PatternMatchStar) -> Self { - AnyNode::PatternMatchStar(node) - } -} - -impl From<ast::PatternMatchAs> for AnyNode { - fn from(node: ast::PatternMatchAs) -> Self { - AnyNode::PatternMatchAs(node) - } -} - -impl From<ast::PatternMatchOr> for AnyNode { - fn from(node: ast::PatternMatchOr) -> Self { - AnyNode::PatternMatchOr(node) - } -} - -impl From<PatternArguments> for AnyNode { - fn from(node: PatternArguments) -> Self { - AnyNode::PatternArguments(node) - } -} - -impl From<PatternKeyword> for AnyNode { - fn from(node: PatternKeyword) -> Self { - AnyNode::PatternKeyword(node) - } -} - -impl From<Comprehension> for AnyNode { - fn from(node: Comprehension) -> Self { - AnyNode::Comprehension(node) - } -} -impl From<Arguments> for AnyNode { - fn from(node: Arguments) -> Self { - AnyNode::Arguments(node) - } -} -impl From<Parameters> for AnyNode { - fn from(node: Parameters) -> Self { - AnyNode::Parameters(node) - } -} -impl From<Parameter> for AnyNode { - fn from(node: Parameter) -> Self { - AnyNode::Parameter(node) - } -} -impl From<ParameterWithDefault> for AnyNode { - fn from(node: ParameterWithDefault) -> Self { - AnyNode::ParameterWithDefault(node) - } -} -impl From<Keyword> for AnyNode { - fn from(node: Keyword) -> Self { - AnyNode::Keyword(node) - } -} -impl From<Alias> for AnyNode { - fn from(node: Alias) -> Self { - AnyNode::Alias(node) - } -} -impl From<WithItem> for AnyNode { - fn from(node: WithItem) -> Self { - AnyNode::WithItem(node) - } -} -impl From<MatchCase> for AnyNode { - fn from(node: MatchCase) -> Self { - AnyNode::MatchCase(node) - } -} -impl From<Decorator> for AnyNode { - fn from(node: Decorator) -> Self { - AnyNode::Decorator(node) - } -} -impl From<TypeParams> for AnyNode { - fn from(node: TypeParams) -> Self { - AnyNode::TypeParams(node) - } -} -impl From<TypeParamTypeVar> for AnyNode { - fn from(node: TypeParamTypeVar) -> Self { - AnyNode::TypeParamTypeVar(node) - } -} - -impl From<TypeParamTypeVarTuple> for AnyNode { - fn from(node: TypeParamTypeVarTuple) -> Self { - AnyNode::TypeParamTypeVarTuple(node) - } -} - -impl From<TypeParamParamSpec> for AnyNode { - fn from(node: TypeParamParamSpec) -> Self { - AnyNode::TypeParamParamSpec(node) - } -} - -impl From<ast::FString> for AnyNode { - fn from(node: ast::FString) -> Self { - AnyNode::FString(node) - } -} - -impl From<ast::StringLiteral> for AnyNode { - fn from(node: ast::StringLiteral) -> Self { - AnyNode::StringLiteral(node) - } -} - -impl From<ast::BytesLiteral> for AnyNode { - fn from(node: ast::BytesLiteral) -> Self { - AnyNode::BytesLiteral(node) - } -} - -impl From<ast::Identifier> for AnyNode { - fn from(node: ast::Identifier) -> Self { - AnyNode::Identifier(node) - } -} - -impl Ranged for AnyNode { - fn range(&self) -> TextRange { - match self { - AnyNode::ModModule(node) => node.range(), - AnyNode::ModExpression(node) => node.range(), - AnyNode::StmtFunctionDef(node) => node.range(), - AnyNode::StmtClassDef(node) => node.range(), - AnyNode::StmtReturn(node) => node.range(), - AnyNode::StmtDelete(node) => node.range(), - AnyNode::StmtTypeAlias(node) => node.range(), - AnyNode::StmtAssign(node) => node.range(), - AnyNode::StmtAugAssign(node) => node.range(), - AnyNode::StmtAnnAssign(node) => node.range(), - AnyNode::StmtFor(node) => node.range(), - AnyNode::StmtWhile(node) => node.range(), - AnyNode::StmtIf(node) => node.range(), - AnyNode::StmtWith(node) => node.range(), - AnyNode::StmtMatch(node) => node.range(), - AnyNode::StmtRaise(node) => node.range(), - AnyNode::StmtTry(node) => node.range(), - AnyNode::StmtAssert(node) => node.range(), - AnyNode::StmtImport(node) => node.range(), - AnyNode::StmtImportFrom(node) => node.range(), - AnyNode::StmtGlobal(node) => node.range(), - AnyNode::StmtNonlocal(node) => node.range(), - AnyNode::StmtExpr(node) => node.range(), - AnyNode::StmtPass(node) => node.range(), - AnyNode::StmtBreak(node) => node.range(), - AnyNode::StmtContinue(node) => node.range(), - AnyNode::StmtIpyEscapeCommand(node) => node.range(), - AnyNode::ExprBoolOp(node) => node.range(), - AnyNode::ExprNamed(node) => node.range(), - AnyNode::ExprBinOp(node) => node.range(), - AnyNode::ExprUnaryOp(node) => node.range(), - AnyNode::ExprLambda(node) => node.range(), - AnyNode::ExprIf(node) => node.range(), - AnyNode::ExprDict(node) => node.range(), - AnyNode::ExprSet(node) => node.range(), - AnyNode::ExprListComp(node) => node.range(), - AnyNode::ExprSetComp(node) => node.range(), - AnyNode::ExprDictComp(node) => node.range(), - AnyNode::ExprGenerator(node) => node.range(), - AnyNode::ExprAwait(node) => node.range(), - AnyNode::ExprYield(node) => node.range(), - AnyNode::ExprYieldFrom(node) => node.range(), - AnyNode::ExprCompare(node) => node.range(), - AnyNode::ExprCall(node) => node.range(), - AnyNode::FStringExpressionElement(node) => node.range(), - AnyNode::FStringLiteralElement(node) => node.range(), - AnyNode::FStringFormatSpec(node) => node.range(), - AnyNode::ExprFString(node) => node.range(), - AnyNode::ExprStringLiteral(node) => node.range(), - AnyNode::ExprBytesLiteral(node) => node.range(), - AnyNode::ExprNumberLiteral(node) => node.range(), - AnyNode::ExprBooleanLiteral(node) => node.range(), - AnyNode::ExprNoneLiteral(node) => node.range(), - AnyNode::ExprEllipsisLiteral(node) => node.range(), - AnyNode::ExprAttribute(node) => node.range(), - AnyNode::ExprSubscript(node) => node.range(), - AnyNode::ExprStarred(node) => node.range(), - AnyNode::ExprName(node) => node.range(), - AnyNode::ExprList(node) => node.range(), - AnyNode::ExprTuple(node) => node.range(), - AnyNode::ExprSlice(node) => node.range(), - AnyNode::ExprIpyEscapeCommand(node) => node.range(), - AnyNode::ExceptHandlerExceptHandler(node) => node.range(), - AnyNode::PatternMatchValue(node) => node.range(), - AnyNode::PatternMatchSingleton(node) => node.range(), - AnyNode::PatternMatchSequence(node) => node.range(), - AnyNode::PatternMatchMapping(node) => node.range(), - AnyNode::PatternMatchClass(node) => node.range(), - AnyNode::PatternMatchStar(node) => node.range(), - AnyNode::PatternMatchAs(node) => node.range(), - AnyNode::PatternMatchOr(node) => node.range(), - AnyNode::PatternArguments(node) => node.range(), - AnyNode::PatternKeyword(node) => node.range(), - AnyNode::Comprehension(node) => node.range(), - AnyNode::Arguments(node) => node.range(), - AnyNode::Parameters(node) => node.range(), - AnyNode::Parameter(node) => node.range(), - AnyNode::ParameterWithDefault(node) => node.range(), - AnyNode::Keyword(node) => node.range(), - AnyNode::Alias(node) => node.range(), - AnyNode::WithItem(node) => node.range(), - AnyNode::MatchCase(node) => node.range(), - AnyNode::Decorator(node) => node.range(), - AnyNode::TypeParams(node) => node.range(), - AnyNode::TypeParamTypeVar(node) => node.range(), - AnyNode::TypeParamTypeVarTuple(node) => node.range(), - AnyNode::TypeParamParamSpec(node) => node.range(), - AnyNode::FString(node) => node.range(), - AnyNode::StringLiteral(node) => node.range(), - AnyNode::BytesLiteral(node) => node.range(), - AnyNode::ElifElseClause(node) => node.range(), - AnyNode::Identifier(node) => node.range(), - } - } -} - -#[derive(Copy, Clone, Debug, is_macro::Is, PartialEq)] -pub enum AnyNodeRef<'a> { - ModModule(&'a ast::ModModule), - ModExpression(&'a ast::ModExpression), - StmtFunctionDef(&'a ast::StmtFunctionDef), - StmtClassDef(&'a ast::StmtClassDef), - StmtReturn(&'a ast::StmtReturn), - StmtDelete(&'a ast::StmtDelete), - StmtTypeAlias(&'a ast::StmtTypeAlias), - StmtAssign(&'a ast::StmtAssign), - StmtAugAssign(&'a ast::StmtAugAssign), - StmtAnnAssign(&'a ast::StmtAnnAssign), - StmtFor(&'a ast::StmtFor), - StmtWhile(&'a ast::StmtWhile), - StmtIf(&'a ast::StmtIf), - StmtWith(&'a ast::StmtWith), - StmtMatch(&'a ast::StmtMatch), - StmtRaise(&'a ast::StmtRaise), - StmtTry(&'a ast::StmtTry), - StmtAssert(&'a ast::StmtAssert), - StmtImport(&'a ast::StmtImport), - StmtImportFrom(&'a ast::StmtImportFrom), - StmtGlobal(&'a ast::StmtGlobal), - StmtNonlocal(&'a ast::StmtNonlocal), - StmtExpr(&'a ast::StmtExpr), - StmtPass(&'a ast::StmtPass), - StmtBreak(&'a ast::StmtBreak), - StmtContinue(&'a ast::StmtContinue), - StmtIpyEscapeCommand(&'a ast::StmtIpyEscapeCommand), - ExprBoolOp(&'a ast::ExprBoolOp), - ExprNamed(&'a ast::ExprNamed), - ExprBinOp(&'a ast::ExprBinOp), - ExprUnaryOp(&'a ast::ExprUnaryOp), - ExprLambda(&'a ast::ExprLambda), - ExprIf(&'a ast::ExprIf), - ExprDict(&'a ast::ExprDict), - ExprSet(&'a ast::ExprSet), - ExprListComp(&'a ast::ExprListComp), - ExprSetComp(&'a ast::ExprSetComp), - ExprDictComp(&'a ast::ExprDictComp), - ExprGenerator(&'a ast::ExprGenerator), - ExprAwait(&'a ast::ExprAwait), - ExprYield(&'a ast::ExprYield), - ExprYieldFrom(&'a ast::ExprYieldFrom), - ExprCompare(&'a ast::ExprCompare), - ExprCall(&'a ast::ExprCall), - FStringExpressionElement(&'a ast::FStringExpressionElement), - FStringLiteralElement(&'a ast::FStringLiteralElement), - FStringFormatSpec(&'a ast::FStringFormatSpec), - ExprFString(&'a ast::ExprFString), - ExprStringLiteral(&'a ast::ExprStringLiteral), - ExprBytesLiteral(&'a ast::ExprBytesLiteral), - ExprNumberLiteral(&'a ast::ExprNumberLiteral), - ExprBooleanLiteral(&'a ast::ExprBooleanLiteral), - ExprNoneLiteral(&'a ast::ExprNoneLiteral), - ExprEllipsisLiteral(&'a ast::ExprEllipsisLiteral), - ExprAttribute(&'a ast::ExprAttribute), - ExprSubscript(&'a ast::ExprSubscript), - ExprStarred(&'a ast::ExprStarred), - ExprName(&'a ast::ExprName), - ExprList(&'a ast::ExprList), - ExprTuple(&'a ast::ExprTuple), - ExprSlice(&'a ast::ExprSlice), - ExprIpyEscapeCommand(&'a ast::ExprIpyEscapeCommand), - ExceptHandlerExceptHandler(&'a ast::ExceptHandlerExceptHandler), - PatternMatchValue(&'a ast::PatternMatchValue), - PatternMatchSingleton(&'a ast::PatternMatchSingleton), - PatternMatchSequence(&'a ast::PatternMatchSequence), - PatternMatchMapping(&'a ast::PatternMatchMapping), - PatternMatchClass(&'a ast::PatternMatchClass), - PatternMatchStar(&'a ast::PatternMatchStar), - PatternMatchAs(&'a ast::PatternMatchAs), - PatternMatchOr(&'a ast::PatternMatchOr), - PatternArguments(&'a ast::PatternArguments), - PatternKeyword(&'a ast::PatternKeyword), - Comprehension(&'a Comprehension), - Arguments(&'a Arguments), - Parameters(&'a Parameters), - Parameter(&'a Parameter), - ParameterWithDefault(&'a ParameterWithDefault), - Keyword(&'a Keyword), - Alias(&'a Alias), - WithItem(&'a WithItem), - MatchCase(&'a MatchCase), - Decorator(&'a Decorator), - TypeParams(&'a TypeParams), - TypeParamTypeVar(&'a TypeParamTypeVar), - TypeParamTypeVarTuple(&'a TypeParamTypeVarTuple), - TypeParamParamSpec(&'a TypeParamParamSpec), - FString(&'a ast::FString), - StringLiteral(&'a ast::StringLiteral), - BytesLiteral(&'a ast::BytesLiteral), - ElifElseClause(&'a ast::ElifElseClause), - Identifier(&'a ast::Identifier), -} - -impl<'a> AnyNodeRef<'a> { - pub fn as_ptr(&self) -> NonNull<()> { - match self { - AnyNodeRef::ModModule(node) => NonNull::from(*node).cast(), - AnyNodeRef::ModExpression(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtFunctionDef(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtClassDef(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtReturn(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtDelete(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtTypeAlias(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtAssign(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtAugAssign(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtAnnAssign(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtFor(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtWhile(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtIf(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtWith(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtMatch(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtRaise(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtTry(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtAssert(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtImport(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtImportFrom(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtGlobal(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtNonlocal(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtExpr(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtPass(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtBreak(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtContinue(node) => NonNull::from(*node).cast(), - AnyNodeRef::StmtIpyEscapeCommand(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprBoolOp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprNamed(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprBinOp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprUnaryOp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprLambda(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprIf(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprDict(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprSet(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprListComp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprSetComp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprDictComp(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprGenerator(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprAwait(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprYield(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprYieldFrom(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprCompare(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprCall(node) => NonNull::from(*node).cast(), - AnyNodeRef::FStringExpressionElement(node) => NonNull::from(*node).cast(), - AnyNodeRef::FStringLiteralElement(node) => NonNull::from(*node).cast(), - AnyNodeRef::FStringFormatSpec(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprFString(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprStringLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprBytesLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprNumberLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprBooleanLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprNoneLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprEllipsisLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprAttribute(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprSubscript(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprStarred(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprName(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprList(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprTuple(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprSlice(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExprIpyEscapeCommand(node) => NonNull::from(*node).cast(), - AnyNodeRef::ExceptHandlerExceptHandler(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchValue(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchSingleton(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchSequence(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchMapping(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchClass(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchStar(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchAs(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternMatchOr(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternArguments(node) => NonNull::from(*node).cast(), - AnyNodeRef::PatternKeyword(node) => NonNull::from(*node).cast(), - AnyNodeRef::Comprehension(node) => NonNull::from(*node).cast(), - AnyNodeRef::Arguments(node) => NonNull::from(*node).cast(), - AnyNodeRef::Parameters(node) => NonNull::from(*node).cast(), - AnyNodeRef::Parameter(node) => NonNull::from(*node).cast(), - AnyNodeRef::ParameterWithDefault(node) => NonNull::from(*node).cast(), - AnyNodeRef::Keyword(node) => NonNull::from(*node).cast(), - AnyNodeRef::Alias(node) => NonNull::from(*node).cast(), - AnyNodeRef::WithItem(node) => NonNull::from(*node).cast(), - AnyNodeRef::MatchCase(node) => NonNull::from(*node).cast(), - AnyNodeRef::Decorator(node) => NonNull::from(*node).cast(), - AnyNodeRef::TypeParams(node) => NonNull::from(*node).cast(), - AnyNodeRef::TypeParamTypeVar(node) => NonNull::from(*node).cast(), - AnyNodeRef::TypeParamTypeVarTuple(node) => NonNull::from(*node).cast(), - AnyNodeRef::TypeParamParamSpec(node) => NonNull::from(*node).cast(), - AnyNodeRef::FString(node) => NonNull::from(*node).cast(), - AnyNodeRef::StringLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::BytesLiteral(node) => NonNull::from(*node).cast(), - AnyNodeRef::ElifElseClause(node) => NonNull::from(*node).cast(), - AnyNodeRef::Identifier(node) => NonNull::from(*node).cast(), - } - } - - /// Compares two any node refs by their pointers (referential equality). - pub fn ptr_eq(self, other: AnyNodeRef) -> bool { - self.as_ptr().eq(&other.as_ptr()) && self.kind() == other.kind() - } - - /// Returns the node's [`kind`](NodeKind) that has no data associated and is [`Copy`]. - pub const fn kind(self) -> NodeKind { - match self { - AnyNodeRef::ModModule(_) => NodeKind::ModModule, - AnyNodeRef::ModExpression(_) => NodeKind::ModExpression, - AnyNodeRef::StmtFunctionDef(_) => NodeKind::StmtFunctionDef, - AnyNodeRef::StmtClassDef(_) => NodeKind::StmtClassDef, - AnyNodeRef::StmtReturn(_) => NodeKind::StmtReturn, - AnyNodeRef::StmtDelete(_) => NodeKind::StmtDelete, - AnyNodeRef::StmtTypeAlias(_) => NodeKind::StmtTypeAlias, - AnyNodeRef::StmtAssign(_) => NodeKind::StmtAssign, - AnyNodeRef::StmtAugAssign(_) => NodeKind::StmtAugAssign, - AnyNodeRef::StmtAnnAssign(_) => NodeKind::StmtAnnAssign, - AnyNodeRef::StmtFor(_) => NodeKind::StmtFor, - AnyNodeRef::StmtWhile(_) => NodeKind::StmtWhile, - AnyNodeRef::StmtIf(_) => NodeKind::StmtIf, - AnyNodeRef::StmtWith(_) => NodeKind::StmtWith, - AnyNodeRef::StmtMatch(_) => NodeKind::StmtMatch, - AnyNodeRef::StmtRaise(_) => NodeKind::StmtRaise, - AnyNodeRef::StmtTry(_) => NodeKind::StmtTry, - AnyNodeRef::StmtAssert(_) => NodeKind::StmtAssert, - AnyNodeRef::StmtImport(_) => NodeKind::StmtImport, - AnyNodeRef::StmtImportFrom(_) => NodeKind::StmtImportFrom, - AnyNodeRef::StmtGlobal(_) => NodeKind::StmtGlobal, - AnyNodeRef::StmtNonlocal(_) => NodeKind::StmtNonlocal, - AnyNodeRef::StmtExpr(_) => NodeKind::StmtExpr, - AnyNodeRef::StmtPass(_) => NodeKind::StmtPass, - AnyNodeRef::StmtBreak(_) => NodeKind::StmtBreak, - AnyNodeRef::StmtContinue(_) => NodeKind::StmtContinue, - AnyNodeRef::StmtIpyEscapeCommand(_) => NodeKind::StmtIpyEscapeCommand, - AnyNodeRef::ExprBoolOp(_) => NodeKind::ExprBoolOp, - AnyNodeRef::ExprNamed(_) => NodeKind::ExprNamed, - AnyNodeRef::ExprBinOp(_) => NodeKind::ExprBinOp, - AnyNodeRef::ExprUnaryOp(_) => NodeKind::ExprUnaryOp, - AnyNodeRef::ExprLambda(_) => NodeKind::ExprLambda, - AnyNodeRef::ExprIf(_) => NodeKind::ExprIf, - AnyNodeRef::ExprDict(_) => NodeKind::ExprDict, - AnyNodeRef::ExprSet(_) => NodeKind::ExprSet, - AnyNodeRef::ExprListComp(_) => NodeKind::ExprListComp, - AnyNodeRef::ExprSetComp(_) => NodeKind::ExprSetComp, - AnyNodeRef::ExprDictComp(_) => NodeKind::ExprDictComp, - AnyNodeRef::ExprGenerator(_) => NodeKind::ExprGenerator, - AnyNodeRef::ExprAwait(_) => NodeKind::ExprAwait, - AnyNodeRef::ExprYield(_) => NodeKind::ExprYield, - AnyNodeRef::ExprYieldFrom(_) => NodeKind::ExprYieldFrom, - AnyNodeRef::ExprCompare(_) => NodeKind::ExprCompare, - AnyNodeRef::ExprCall(_) => NodeKind::ExprCall, - AnyNodeRef::FStringExpressionElement(_) => NodeKind::FStringExpressionElement, - AnyNodeRef::FStringLiteralElement(_) => NodeKind::FStringLiteralElement, - AnyNodeRef::FStringFormatSpec(_) => NodeKind::FStringFormatSpec, - AnyNodeRef::ExprFString(_) => NodeKind::ExprFString, - AnyNodeRef::ExprStringLiteral(_) => NodeKind::ExprStringLiteral, - AnyNodeRef::ExprBytesLiteral(_) => NodeKind::ExprBytesLiteral, - AnyNodeRef::ExprNumberLiteral(_) => NodeKind::ExprNumberLiteral, - AnyNodeRef::ExprBooleanLiteral(_) => NodeKind::ExprBooleanLiteral, - AnyNodeRef::ExprNoneLiteral(_) => NodeKind::ExprNoneLiteral, - AnyNodeRef::ExprEllipsisLiteral(_) => NodeKind::ExprEllipsisLiteral, - AnyNodeRef::ExprAttribute(_) => NodeKind::ExprAttribute, - AnyNodeRef::ExprSubscript(_) => NodeKind::ExprSubscript, - AnyNodeRef::ExprStarred(_) => NodeKind::ExprStarred, - AnyNodeRef::ExprName(_) => NodeKind::ExprName, - AnyNodeRef::ExprList(_) => NodeKind::ExprList, - AnyNodeRef::ExprTuple(_) => NodeKind::ExprTuple, - AnyNodeRef::ExprSlice(_) => NodeKind::ExprSlice, - AnyNodeRef::ExprIpyEscapeCommand(_) => NodeKind::ExprIpyEscapeCommand, - AnyNodeRef::ExceptHandlerExceptHandler(_) => NodeKind::ExceptHandlerExceptHandler, - AnyNodeRef::PatternMatchValue(_) => NodeKind::PatternMatchValue, - AnyNodeRef::PatternMatchSingleton(_) => NodeKind::PatternMatchSingleton, - AnyNodeRef::PatternMatchSequence(_) => NodeKind::PatternMatchSequence, - AnyNodeRef::PatternMatchMapping(_) => NodeKind::PatternMatchMapping, - AnyNodeRef::PatternMatchClass(_) => NodeKind::PatternMatchClass, - AnyNodeRef::PatternMatchStar(_) => NodeKind::PatternMatchStar, - AnyNodeRef::PatternMatchAs(_) => NodeKind::PatternMatchAs, - AnyNodeRef::PatternMatchOr(_) => NodeKind::PatternMatchOr, - AnyNodeRef::PatternArguments(_) => NodeKind::PatternArguments, - AnyNodeRef::PatternKeyword(_) => NodeKind::PatternKeyword, - AnyNodeRef::Comprehension(_) => NodeKind::Comprehension, - AnyNodeRef::Arguments(_) => NodeKind::Arguments, - AnyNodeRef::Parameters(_) => NodeKind::Parameters, - AnyNodeRef::Parameter(_) => NodeKind::Parameter, - AnyNodeRef::ParameterWithDefault(_) => NodeKind::ParameterWithDefault, - AnyNodeRef::Keyword(_) => NodeKind::Keyword, - AnyNodeRef::Alias(_) => NodeKind::Alias, - AnyNodeRef::WithItem(_) => NodeKind::WithItem, - AnyNodeRef::MatchCase(_) => NodeKind::MatchCase, - AnyNodeRef::Decorator(_) => NodeKind::Decorator, - AnyNodeRef::TypeParams(_) => NodeKind::TypeParams, - AnyNodeRef::TypeParamTypeVar(_) => NodeKind::TypeParamTypeVar, - AnyNodeRef::TypeParamTypeVarTuple(_) => NodeKind::TypeParamTypeVarTuple, - AnyNodeRef::TypeParamParamSpec(_) => NodeKind::TypeParamParamSpec, - AnyNodeRef::FString(_) => NodeKind::FString, - AnyNodeRef::StringLiteral(_) => NodeKind::StringLiteral, - AnyNodeRef::BytesLiteral(_) => NodeKind::BytesLiteral, - AnyNodeRef::ElifElseClause(_) => NodeKind::ElifElseClause, - AnyNodeRef::Identifier(_) => NodeKind::Identifier, - } - } - - pub const fn is_statement(self) -> bool { - match self { - AnyNodeRef::StmtFunctionDef(_) - | AnyNodeRef::StmtClassDef(_) - | AnyNodeRef::StmtReturn(_) - | AnyNodeRef::StmtDelete(_) - | AnyNodeRef::StmtTypeAlias(_) - | AnyNodeRef::StmtAssign(_) - | AnyNodeRef::StmtAugAssign(_) - | AnyNodeRef::StmtAnnAssign(_) - | AnyNodeRef::StmtFor(_) - | AnyNodeRef::StmtWhile(_) - | AnyNodeRef::StmtIf(_) - | AnyNodeRef::StmtWith(_) - | AnyNodeRef::StmtMatch(_) - | AnyNodeRef::StmtRaise(_) - | AnyNodeRef::StmtTry(_) - | AnyNodeRef::StmtAssert(_) - | AnyNodeRef::StmtImport(_) - | AnyNodeRef::StmtImportFrom(_) - | AnyNodeRef::StmtGlobal(_) - | AnyNodeRef::StmtNonlocal(_) - | AnyNodeRef::StmtExpr(_) - | AnyNodeRef::StmtPass(_) - | AnyNodeRef::StmtBreak(_) - | AnyNodeRef::StmtContinue(_) - | AnyNodeRef::StmtIpyEscapeCommand(_) => true, - - AnyNodeRef::ModModule(_) - | AnyNodeRef::ModExpression(_) - | AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) - | AnyNodeRef::ExceptHandlerExceptHandler(_) - | AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => false, - } - } - - pub const fn is_expression(self) -> bool { - match self { - AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) => true, - - AnyNodeRef::ModModule(_) - | AnyNodeRef::ModExpression(_) - | AnyNodeRef::StmtFunctionDef(_) - | AnyNodeRef::StmtClassDef(_) - | AnyNodeRef::StmtReturn(_) - | AnyNodeRef::StmtDelete(_) - | AnyNodeRef::StmtTypeAlias(_) - | AnyNodeRef::StmtAssign(_) - | AnyNodeRef::StmtAugAssign(_) - | AnyNodeRef::StmtAnnAssign(_) - | AnyNodeRef::StmtFor(_) - | AnyNodeRef::StmtWhile(_) - | AnyNodeRef::StmtIf(_) - | AnyNodeRef::StmtWith(_) - | AnyNodeRef::StmtMatch(_) - | AnyNodeRef::StmtRaise(_) - | AnyNodeRef::StmtTry(_) - | AnyNodeRef::StmtAssert(_) - | AnyNodeRef::StmtImport(_) - | AnyNodeRef::StmtImportFrom(_) - | AnyNodeRef::StmtGlobal(_) - | AnyNodeRef::StmtNonlocal(_) - | AnyNodeRef::StmtExpr(_) - | AnyNodeRef::StmtPass(_) - | AnyNodeRef::StmtBreak(_) - | AnyNodeRef::StmtContinue(_) - | AnyNodeRef::StmtIpyEscapeCommand(_) - | AnyNodeRef::ExceptHandlerExceptHandler(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => false, - } - } - - pub const fn is_module(self) -> bool { - match self { - AnyNodeRef::ModModule(_) | AnyNodeRef::ModExpression(_) => true, - - AnyNodeRef::StmtFunctionDef(_) - | AnyNodeRef::StmtClassDef(_) - | AnyNodeRef::StmtReturn(_) - | AnyNodeRef::StmtDelete(_) - | AnyNodeRef::StmtTypeAlias(_) - | AnyNodeRef::StmtAssign(_) - | AnyNodeRef::StmtAugAssign(_) - | AnyNodeRef::StmtAnnAssign(_) - | AnyNodeRef::StmtFor(_) - | AnyNodeRef::StmtWhile(_) - | AnyNodeRef::StmtIf(_) - | AnyNodeRef::StmtWith(_) - | AnyNodeRef::StmtMatch(_) - | AnyNodeRef::StmtRaise(_) - | AnyNodeRef::StmtTry(_) - | AnyNodeRef::StmtAssert(_) - | AnyNodeRef::StmtImport(_) - | AnyNodeRef::StmtImportFrom(_) - | AnyNodeRef::StmtGlobal(_) - | AnyNodeRef::StmtNonlocal(_) - | AnyNodeRef::StmtExpr(_) - | AnyNodeRef::StmtPass(_) - | AnyNodeRef::StmtBreak(_) - | AnyNodeRef::StmtContinue(_) - | AnyNodeRef::StmtIpyEscapeCommand(_) - | AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) - | AnyNodeRef::ExceptHandlerExceptHandler(_) - | AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => false, - } - } - - pub const fn is_pattern(self) -> bool { - match self { - AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) => true, - - AnyNodeRef::ModModule(_) - | AnyNodeRef::ModExpression(_) - | AnyNodeRef::StmtFunctionDef(_) - | AnyNodeRef::StmtClassDef(_) - | AnyNodeRef::StmtReturn(_) - | AnyNodeRef::StmtDelete(_) - | AnyNodeRef::StmtTypeAlias(_) - | AnyNodeRef::StmtAssign(_) - | AnyNodeRef::StmtAugAssign(_) - | AnyNodeRef::StmtAnnAssign(_) - | AnyNodeRef::StmtFor(_) - | AnyNodeRef::StmtWhile(_) - | AnyNodeRef::StmtIf(_) - | AnyNodeRef::StmtWith(_) - | AnyNodeRef::StmtMatch(_) - | AnyNodeRef::StmtRaise(_) - | AnyNodeRef::StmtTry(_) - | AnyNodeRef::StmtAssert(_) - | AnyNodeRef::StmtImport(_) - | AnyNodeRef::StmtImportFrom(_) - | AnyNodeRef::StmtGlobal(_) - | AnyNodeRef::StmtNonlocal(_) - | AnyNodeRef::StmtExpr(_) - | AnyNodeRef::StmtPass(_) - | AnyNodeRef::StmtBreak(_) - | AnyNodeRef::StmtContinue(_) - | AnyNodeRef::StmtIpyEscapeCommand(_) - | AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::ExceptHandlerExceptHandler(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => false, - } - } - - pub const fn is_except_handler(self) -> bool { - match self { - AnyNodeRef::ExceptHandlerExceptHandler(_) => true, - - AnyNodeRef::ModModule(_) - | AnyNodeRef::ModExpression(_) - | AnyNodeRef::StmtFunctionDef(_) - | AnyNodeRef::StmtClassDef(_) - | AnyNodeRef::StmtReturn(_) - | AnyNodeRef::StmtDelete(_) - | AnyNodeRef::StmtTypeAlias(_) - | AnyNodeRef::StmtAssign(_) - | AnyNodeRef::StmtAugAssign(_) - | AnyNodeRef::StmtAnnAssign(_) - | AnyNodeRef::StmtFor(_) - | AnyNodeRef::StmtWhile(_) - | AnyNodeRef::StmtIf(_) - | AnyNodeRef::StmtWith(_) - | AnyNodeRef::StmtMatch(_) - | AnyNodeRef::StmtRaise(_) - | AnyNodeRef::StmtTry(_) - | AnyNodeRef::StmtAssert(_) - | AnyNodeRef::StmtImport(_) - | AnyNodeRef::StmtImportFrom(_) - | AnyNodeRef::StmtGlobal(_) - | AnyNodeRef::StmtNonlocal(_) - | AnyNodeRef::StmtExpr(_) - | AnyNodeRef::StmtPass(_) - | AnyNodeRef::StmtBreak(_) - | AnyNodeRef::StmtContinue(_) - | AnyNodeRef::StmtIpyEscapeCommand(_) - | AnyNodeRef::ExprBoolOp(_) - | AnyNodeRef::ExprNamed(_) - | AnyNodeRef::ExprBinOp(_) - | AnyNodeRef::ExprUnaryOp(_) - | AnyNodeRef::ExprLambda(_) - | AnyNodeRef::ExprIf(_) - | AnyNodeRef::ExprDict(_) - | AnyNodeRef::ExprSet(_) - | AnyNodeRef::ExprListComp(_) - | AnyNodeRef::ExprSetComp(_) - | AnyNodeRef::ExprDictComp(_) - | AnyNodeRef::ExprGenerator(_) - | AnyNodeRef::ExprAwait(_) - | AnyNodeRef::ExprYield(_) - | AnyNodeRef::ExprYieldFrom(_) - | AnyNodeRef::ExprCompare(_) - | AnyNodeRef::ExprCall(_) - | AnyNodeRef::FStringExpressionElement(_) - | AnyNodeRef::FStringLiteralElement(_) - | AnyNodeRef::FStringFormatSpec(_) - | AnyNodeRef::ExprFString(_) - | AnyNodeRef::ExprStringLiteral(_) - | AnyNodeRef::ExprBytesLiteral(_) - | AnyNodeRef::ExprNumberLiteral(_) - | AnyNodeRef::ExprBooleanLiteral(_) - | AnyNodeRef::ExprNoneLiteral(_) - | AnyNodeRef::ExprEllipsisLiteral(_) - | AnyNodeRef::ExprAttribute(_) - | AnyNodeRef::ExprSubscript(_) - | AnyNodeRef::ExprStarred(_) - | AnyNodeRef::ExprName(_) - | AnyNodeRef::ExprList(_) - | AnyNodeRef::ExprTuple(_) - | AnyNodeRef::ExprSlice(_) - | AnyNodeRef::ExprIpyEscapeCommand(_) - | AnyNodeRef::PatternMatchValue(_) - | AnyNodeRef::PatternMatchSingleton(_) - | AnyNodeRef::PatternMatchSequence(_) - | AnyNodeRef::PatternMatchMapping(_) - | AnyNodeRef::PatternMatchClass(_) - | AnyNodeRef::PatternMatchStar(_) - | AnyNodeRef::PatternMatchAs(_) - | AnyNodeRef::PatternMatchOr(_) - | AnyNodeRef::PatternArguments(_) - | AnyNodeRef::PatternKeyword(_) - | AnyNodeRef::Comprehension(_) - | AnyNodeRef::Arguments(_) - | AnyNodeRef::Parameters(_) - | AnyNodeRef::Parameter(_) - | AnyNodeRef::ParameterWithDefault(_) - | AnyNodeRef::Keyword(_) - | AnyNodeRef::Alias(_) - | AnyNodeRef::WithItem(_) - | AnyNodeRef::MatchCase(_) - | AnyNodeRef::Decorator(_) - | AnyNodeRef::TypeParams(_) - | AnyNodeRef::TypeParamTypeVar(_) - | AnyNodeRef::TypeParamTypeVarTuple(_) - | AnyNodeRef::TypeParamParamSpec(_) - | AnyNodeRef::FString(_) - | AnyNodeRef::StringLiteral(_) - | AnyNodeRef::BytesLiteral(_) - | AnyNodeRef::Identifier(_) - | AnyNodeRef::ElifElseClause(_) => false, - } - } - - /// In our AST, only some alternative branches are represented as a node. This has historical - /// reasons, e.g. we added a node for elif/else in if statements which was not originally - /// present in the parser. - pub const fn is_alternative_branch_with_node(self) -> bool { - matches!( - self, - AnyNodeRef::ExceptHandlerExceptHandler(_) | AnyNodeRef::ElifElseClause(_) - ) - } - - pub fn visit_preorder<'b, V>(self, visitor: &mut V) - where - V: SourceOrderVisitor<'b> + ?Sized, - 'a: 'b, - { - match self { - AnyNodeRef::ModModule(node) => node.visit_source_order(visitor), - AnyNodeRef::ModExpression(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtFunctionDef(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtClassDef(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtReturn(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtDelete(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtTypeAlias(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtAssign(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtAugAssign(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtAnnAssign(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtFor(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtWhile(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtIf(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtWith(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtMatch(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtRaise(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtTry(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtAssert(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtImport(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtImportFrom(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtGlobal(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtNonlocal(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtExpr(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtPass(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtBreak(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtContinue(node) => node.visit_source_order(visitor), - AnyNodeRef::StmtIpyEscapeCommand(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprBoolOp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprNamed(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprBinOp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprUnaryOp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprLambda(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprIf(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprDict(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprSet(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprListComp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprSetComp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprDictComp(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprGenerator(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprAwait(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprYield(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprYieldFrom(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprCompare(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprCall(node) => node.visit_source_order(visitor), - AnyNodeRef::FStringExpressionElement(node) => node.visit_source_order(visitor), - AnyNodeRef::FStringLiteralElement(node) => node.visit_source_order(visitor), - AnyNodeRef::FStringFormatSpec(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprFString(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprStringLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprBytesLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprNumberLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprBooleanLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprNoneLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprEllipsisLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprAttribute(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprSubscript(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprStarred(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprName(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprList(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprTuple(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprSlice(node) => node.visit_source_order(visitor), - AnyNodeRef::ExprIpyEscapeCommand(node) => node.visit_source_order(visitor), - AnyNodeRef::ExceptHandlerExceptHandler(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchValue(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchSingleton(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchSequence(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchMapping(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchClass(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchStar(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchAs(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternMatchOr(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternArguments(node) => node.visit_source_order(visitor), - AnyNodeRef::PatternKeyword(node) => node.visit_source_order(visitor), - AnyNodeRef::Comprehension(node) => node.visit_source_order(visitor), - AnyNodeRef::Arguments(node) => node.visit_source_order(visitor), - AnyNodeRef::Parameters(node) => node.visit_source_order(visitor), - AnyNodeRef::Parameter(node) => node.visit_source_order(visitor), - AnyNodeRef::ParameterWithDefault(node) => node.visit_source_order(visitor), - AnyNodeRef::Keyword(node) => node.visit_source_order(visitor), - AnyNodeRef::Alias(node) => node.visit_source_order(visitor), - AnyNodeRef::WithItem(node) => node.visit_source_order(visitor), - AnyNodeRef::MatchCase(node) => node.visit_source_order(visitor), - AnyNodeRef::Decorator(node) => node.visit_source_order(visitor), - AnyNodeRef::TypeParams(node) => node.visit_source_order(visitor), - AnyNodeRef::TypeParamTypeVar(node) => node.visit_source_order(visitor), - AnyNodeRef::TypeParamTypeVarTuple(node) => node.visit_source_order(visitor), - AnyNodeRef::TypeParamParamSpec(node) => node.visit_source_order(visitor), - AnyNodeRef::FString(node) => node.visit_source_order(visitor), - AnyNodeRef::StringLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::BytesLiteral(node) => node.visit_source_order(visitor), - AnyNodeRef::ElifElseClause(node) => node.visit_source_order(visitor), - AnyNodeRef::Identifier(node) => node.visit_source_order(visitor), - } - } - - /// The last child of the last branch, if the node has multiple branches. - pub fn last_child_in_body(&self) -> Option<AnyNodeRef<'a>> { - let body = match self { - AnyNodeRef::StmtFunctionDef(ast::StmtFunctionDef { body, .. }) - | AnyNodeRef::StmtClassDef(ast::StmtClassDef { body, .. }) - | AnyNodeRef::StmtWith(ast::StmtWith { body, .. }) - | AnyNodeRef::MatchCase(MatchCase { body, .. }) - | AnyNodeRef::ExceptHandlerExceptHandler(ast::ExceptHandlerExceptHandler { - body, - .. - }) - | AnyNodeRef::ElifElseClause(ast::ElifElseClause { body, .. }) => body, - AnyNodeRef::StmtIf(ast::StmtIf { - body, - elif_else_clauses, - .. - }) => elif_else_clauses.last().map_or(body, |clause| &clause.body), - - AnyNodeRef::StmtFor(ast::StmtFor { body, orelse, .. }) - | AnyNodeRef::StmtWhile(ast::StmtWhile { body, orelse, .. }) => { - if orelse.is_empty() { - body - } else { - orelse - } - } - - AnyNodeRef::StmtMatch(ast::StmtMatch { cases, .. }) => { - return cases.last().map(AnyNodeRef::from); - } - - AnyNodeRef::StmtTry(ast::StmtTry { - body, - handlers, - orelse, - finalbody, - .. - }) => { - if finalbody.is_empty() { - if orelse.is_empty() { - if handlers.is_empty() { - body - } else { - return handlers.last().map(AnyNodeRef::from); - } - } else { - orelse - } - } else { - finalbody - } - } - - // Not a node that contains an indented child node. - _ => return None, - }; - - body.last().map(AnyNodeRef::from) - } - - /// Check if the given statement is the first statement after the colon of a branch, be it in if - /// statements, for statements, after each part of a try-except-else-finally or function/class - /// definitions. - /// - /// - /// ```python - /// if True: <- has body - /// a <- first statement - /// b - /// elif b: <- has body - /// c <- first statement - /// d - /// else: <- has body - /// e <- first statement - /// f - /// - /// class: <- has body - /// a: int <- first statement - /// b: int - /// - /// ``` - /// - /// For nodes with multiple bodies, we check all bodies that don't have their own node. For - /// try-except-else-finally, each except branch has it's own node, so for the `StmtTry`, we check - /// the `try:`, `else:` and `finally:`, bodies, while `ExceptHandlerExceptHandler` has it's own - /// check. For for-else and while-else, we check both branches for the whole statement. - /// - /// ```python - /// try: <- has body (a) - /// 6/8 <- first statement (a) - /// 1/0 - /// except: <- has body (b) - /// a <- first statement (b) - /// b - /// else: - /// c <- first statement (a) - /// d - /// finally: - /// e <- first statement (a) - /// f - /// ``` - pub fn is_first_statement_in_body(&self, body: AnyNodeRef) -> bool { - match body { - AnyNodeRef::StmtFor(ast::StmtFor { body, orelse, .. }) - | AnyNodeRef::StmtWhile(ast::StmtWhile { body, orelse, .. }) => { - are_same_optional(*self, body.first()) || are_same_optional(*self, orelse.first()) - } - - AnyNodeRef::StmtTry(ast::StmtTry { - body, - orelse, - finalbody, - .. - }) => { - are_same_optional(*self, body.first()) - || are_same_optional(*self, orelse.first()) - || are_same_optional(*self, finalbody.first()) - } - - AnyNodeRef::StmtIf(ast::StmtIf { body, .. }) - | AnyNodeRef::ElifElseClause(ast::ElifElseClause { body, .. }) - | AnyNodeRef::StmtWith(ast::StmtWith { body, .. }) - | AnyNodeRef::ExceptHandlerExceptHandler(ast::ExceptHandlerExceptHandler { - body, - .. - }) - | AnyNodeRef::MatchCase(MatchCase { body, .. }) - | AnyNodeRef::StmtFunctionDef(ast::StmtFunctionDef { body, .. }) - | AnyNodeRef::StmtClassDef(ast::StmtClassDef { body, .. }) => { - are_same_optional(*self, body.first()) - } - - AnyNodeRef::StmtMatch(ast::StmtMatch { cases, .. }) => { - are_same_optional(*self, cases.first()) - } - - _ => false, - } - } - - /// Returns `true` if `statement` is the first statement in an alternate `body` (e.g. the else of an if statement) - pub fn is_first_statement_in_alternate_body(&self, body: AnyNodeRef) -> bool { - match body { - AnyNodeRef::StmtFor(ast::StmtFor { orelse, .. }) - | AnyNodeRef::StmtWhile(ast::StmtWhile { orelse, .. }) => { - are_same_optional(*self, orelse.first()) - } - - AnyNodeRef::StmtTry(ast::StmtTry { - handlers, - orelse, - finalbody, - .. - }) => { - are_same_optional(*self, handlers.first()) - || are_same_optional(*self, orelse.first()) - || are_same_optional(*self, finalbody.first()) - } - - AnyNodeRef::StmtIf(ast::StmtIf { - elif_else_clauses, .. - }) => are_same_optional(*self, elif_else_clauses.first()), - _ => false, - } - } -} - -/// Returns `true` if `right` is `Some` and `left` and `right` are referentially equal. -fn are_same_optional<'a, T>(left: AnyNodeRef, right: Option<T>) -> bool -where - T: Into<AnyNodeRef<'a>>, -{ - right.is_some_and(|right| left.ptr_eq(right.into())) -} - -impl<'a> From<&'a ast::ModModule> for AnyNodeRef<'a> { - fn from(node: &'a ast::ModModule) -> Self { - AnyNodeRef::ModModule(node) - } -} - -impl<'a> From<&'a ast::ModExpression> for AnyNodeRef<'a> { - fn from(node: &'a ast::ModExpression) -> Self { - AnyNodeRef::ModExpression(node) - } -} - -impl<'a> From<&'a ast::StmtFunctionDef> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtFunctionDef) -> Self { - AnyNodeRef::StmtFunctionDef(node) - } -} - -impl<'a> From<&'a ast::StmtClassDef> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtClassDef) -> Self { - AnyNodeRef::StmtClassDef(node) - } -} - -impl<'a> From<&'a ast::StmtReturn> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtReturn) -> Self { - AnyNodeRef::StmtReturn(node) - } -} - -impl<'a> From<&'a ast::StmtDelete> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtDelete) -> Self { - AnyNodeRef::StmtDelete(node) - } -} - -impl<'a> From<&'a ast::StmtTypeAlias> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtTypeAlias) -> Self { - AnyNodeRef::StmtTypeAlias(node) - } -} - -impl<'a> From<&'a ast::StmtAssign> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtAssign) -> Self { - AnyNodeRef::StmtAssign(node) - } -} - -impl<'a> From<&'a ast::StmtAugAssign> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtAugAssign) -> Self { - AnyNodeRef::StmtAugAssign(node) - } -} - -impl<'a> From<&'a ast::StmtAnnAssign> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtAnnAssign) -> Self { - AnyNodeRef::StmtAnnAssign(node) - } -} - -impl<'a> From<&'a ast::StmtFor> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtFor) -> Self { - AnyNodeRef::StmtFor(node) - } -} - -impl<'a> From<&'a ast::StmtWhile> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtWhile) -> Self { - AnyNodeRef::StmtWhile(node) - } -} - -impl<'a> From<&'a ast::StmtIf> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtIf) -> Self { - AnyNodeRef::StmtIf(node) - } -} - -impl<'a> From<&'a ast::ElifElseClause> for AnyNodeRef<'a> { - fn from(node: &'a ast::ElifElseClause) -> Self { - AnyNodeRef::ElifElseClause(node) - } -} - -impl<'a> From<&'a ast::StmtWith> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtWith) -> Self { - AnyNodeRef::StmtWith(node) - } -} - -impl<'a> From<&'a ast::StmtMatch> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtMatch) -> Self { - AnyNodeRef::StmtMatch(node) - } -} - -impl<'a> From<&'a ast::StmtRaise> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtRaise) -> Self { - AnyNodeRef::StmtRaise(node) - } -} - -impl<'a> From<&'a ast::StmtTry> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtTry) -> Self { - AnyNodeRef::StmtTry(node) - } -} - -impl<'a> From<&'a ast::StmtAssert> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtAssert) -> Self { - AnyNodeRef::StmtAssert(node) - } -} - -impl<'a> From<&'a ast::StmtImport> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtImport) -> Self { - AnyNodeRef::StmtImport(node) - } -} - -impl<'a> From<&'a ast::StmtImportFrom> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtImportFrom) -> Self { - AnyNodeRef::StmtImportFrom(node) - } -} - -impl<'a> From<&'a ast::StmtGlobal> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtGlobal) -> Self { - AnyNodeRef::StmtGlobal(node) - } -} - -impl<'a> From<&'a ast::StmtNonlocal> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtNonlocal) -> Self { - AnyNodeRef::StmtNonlocal(node) - } -} - -impl<'a> From<&'a ast::StmtExpr> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtExpr) -> Self { - AnyNodeRef::StmtExpr(node) - } -} - -impl<'a> From<&'a ast::StmtPass> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtPass) -> Self { - AnyNodeRef::StmtPass(node) - } -} - -impl<'a> From<&'a ast::StmtBreak> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtBreak) -> Self { - AnyNodeRef::StmtBreak(node) - } -} - -impl<'a> From<&'a ast::StmtContinue> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtContinue) -> Self { - AnyNodeRef::StmtContinue(node) - } -} - -impl<'a> From<&'a ast::StmtIpyEscapeCommand> for AnyNodeRef<'a> { - fn from(node: &'a ast::StmtIpyEscapeCommand) -> Self { - AnyNodeRef::StmtIpyEscapeCommand(node) - } -} - -impl<'a> From<&'a ast::ExprBoolOp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprBoolOp) -> Self { - AnyNodeRef::ExprBoolOp(node) - } -} - -impl<'a> From<&'a ast::ExprNamed> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprNamed) -> Self { - AnyNodeRef::ExprNamed(node) - } -} - -impl<'a> From<&'a ast::ExprBinOp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprBinOp) -> Self { - AnyNodeRef::ExprBinOp(node) - } -} - -impl<'a> From<&'a ast::ExprUnaryOp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprUnaryOp) -> Self { - AnyNodeRef::ExprUnaryOp(node) - } -} - -impl<'a> From<&'a ast::ExprLambda> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprLambda) -> Self { - AnyNodeRef::ExprLambda(node) - } -} - -impl<'a> From<&'a ast::ExprIf> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprIf) -> Self { - AnyNodeRef::ExprIf(node) - } -} - -impl<'a> From<&'a ast::ExprDict> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprDict) -> Self { - AnyNodeRef::ExprDict(node) - } -} - -impl<'a> From<&'a ast::ExprSet> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprSet) -> Self { - AnyNodeRef::ExprSet(node) - } -} - -impl<'a> From<&'a ast::ExprListComp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprListComp) -> Self { - AnyNodeRef::ExprListComp(node) - } -} - -impl<'a> From<&'a ast::ExprSetComp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprSetComp) -> Self { - AnyNodeRef::ExprSetComp(node) - } -} - -impl<'a> From<&'a ast::ExprDictComp> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprDictComp) -> Self { - AnyNodeRef::ExprDictComp(node) - } -} - -impl<'a> From<&'a ast::ExprGenerator> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprGenerator) -> Self { - AnyNodeRef::ExprGenerator(node) - } -} - -impl<'a> From<&'a ast::ExprAwait> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprAwait) -> Self { - AnyNodeRef::ExprAwait(node) - } -} - -impl<'a> From<&'a ast::ExprYield> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprYield) -> Self { - AnyNodeRef::ExprYield(node) - } -} - -impl<'a> From<&'a ast::ExprYieldFrom> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprYieldFrom) -> Self { - AnyNodeRef::ExprYieldFrom(node) - } -} - -impl<'a> From<&'a ast::ExprCompare> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprCompare) -> Self { - AnyNodeRef::ExprCompare(node) - } -} - -impl<'a> From<&'a ast::ExprCall> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprCall) -> Self { - AnyNodeRef::ExprCall(node) - } -} - -impl<'a> From<&'a ast::FStringExpressionElement> for AnyNodeRef<'a> { - fn from(node: &'a ast::FStringExpressionElement) -> Self { - AnyNodeRef::FStringExpressionElement(node) - } -} - -impl<'a> From<&'a ast::FStringLiteralElement> for AnyNodeRef<'a> { - fn from(node: &'a ast::FStringLiteralElement) -> Self { - AnyNodeRef::FStringLiteralElement(node) - } -} - -impl<'a> From<&'a ast::FStringFormatSpec> for AnyNodeRef<'a> { - fn from(node: &'a ast::FStringFormatSpec) -> Self { - AnyNodeRef::FStringFormatSpec(node) - } -} - -impl<'a> From<&'a ast::ExprFString> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprFString) -> Self { - AnyNodeRef::ExprFString(node) - } -} - -impl<'a> From<&'a ast::ExprStringLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprStringLiteral) -> Self { - AnyNodeRef::ExprStringLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprBytesLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprBytesLiteral) -> Self { - AnyNodeRef::ExprBytesLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprNumberLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprNumberLiteral) -> Self { - AnyNodeRef::ExprNumberLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprBooleanLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprBooleanLiteral) -> Self { - AnyNodeRef::ExprBooleanLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprNoneLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprNoneLiteral) -> Self { - AnyNodeRef::ExprNoneLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprEllipsisLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprEllipsisLiteral) -> Self { - AnyNodeRef::ExprEllipsisLiteral(node) - } -} - -impl<'a> From<&'a ast::ExprAttribute> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprAttribute) -> Self { - AnyNodeRef::ExprAttribute(node) - } -} - -impl<'a> From<&'a ast::ExprSubscript> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprSubscript) -> Self { - AnyNodeRef::ExprSubscript(node) - } -} - -impl<'a> From<&'a ast::ExprStarred> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprStarred) -> Self { - AnyNodeRef::ExprStarred(node) - } -} - -impl<'a> From<&'a ast::ExprName> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprName) -> Self { - AnyNodeRef::ExprName(node) - } -} - -impl<'a> From<&'a ast::ExprList> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprList) -> Self { - AnyNodeRef::ExprList(node) - } -} - -impl<'a> From<&'a ast::ExprTuple> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprTuple) -> Self { - AnyNodeRef::ExprTuple(node) - } -} - -impl<'a> From<&'a ast::ExprSlice> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprSlice) -> Self { - AnyNodeRef::ExprSlice(node) - } -} - -impl<'a> From<&'a ast::ExprIpyEscapeCommand> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExprIpyEscapeCommand) -> Self { - AnyNodeRef::ExprIpyEscapeCommand(node) - } -} - -impl<'a> From<&'a ast::ExceptHandlerExceptHandler> for AnyNodeRef<'a> { - fn from(node: &'a ast::ExceptHandlerExceptHandler) -> Self { - AnyNodeRef::ExceptHandlerExceptHandler(node) - } -} - -impl<'a> From<&'a ast::PatternMatchValue> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchValue) -> Self { - AnyNodeRef::PatternMatchValue(node) - } -} - -impl<'a> From<&'a ast::PatternMatchSingleton> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchSingleton) -> Self { - AnyNodeRef::PatternMatchSingleton(node) - } -} - -impl<'a> From<&'a ast::PatternMatchSequence> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchSequence) -> Self { - AnyNodeRef::PatternMatchSequence(node) - } -} - -impl<'a> From<&'a ast::PatternMatchMapping> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchMapping) -> Self { - AnyNodeRef::PatternMatchMapping(node) - } -} - -impl<'a> From<&'a ast::PatternMatchClass> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchClass) -> Self { - AnyNodeRef::PatternMatchClass(node) - } -} - -impl<'a> From<&'a ast::PatternMatchStar> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchStar) -> Self { - AnyNodeRef::PatternMatchStar(node) - } -} - -impl<'a> From<&'a ast::PatternMatchAs> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchAs) -> Self { - AnyNodeRef::PatternMatchAs(node) - } -} - -impl<'a> From<&'a ast::PatternMatchOr> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternMatchOr) -> Self { - AnyNodeRef::PatternMatchOr(node) - } -} - -impl<'a> From<&'a ast::PatternArguments> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternArguments) -> Self { - AnyNodeRef::PatternArguments(node) - } -} - -impl<'a> From<&'a ast::PatternKeyword> for AnyNodeRef<'a> { - fn from(node: &'a ast::PatternKeyword) -> Self { - AnyNodeRef::PatternKeyword(node) - } -} - -impl<'a> From<&'a Decorator> for AnyNodeRef<'a> { - fn from(node: &'a Decorator) -> Self { - AnyNodeRef::Decorator(node) - } -} - -impl<'a> From<&'a ast::TypeParams> for AnyNodeRef<'a> { - fn from(node: &'a ast::TypeParams) -> Self { - AnyNodeRef::TypeParams(node) - } -} -impl<'a> From<&'a TypeParamTypeVar> for AnyNodeRef<'a> { - fn from(node: &'a TypeParamTypeVar) -> Self { - AnyNodeRef::TypeParamTypeVar(node) - } -} - -impl<'a> From<&'a TypeParamTypeVarTuple> for AnyNodeRef<'a> { - fn from(node: &'a TypeParamTypeVarTuple) -> Self { - AnyNodeRef::TypeParamTypeVarTuple(node) - } -} - -impl<'a> From<&'a TypeParamParamSpec> for AnyNodeRef<'a> { - fn from(node: &'a TypeParamParamSpec) -> Self { - AnyNodeRef::TypeParamParamSpec(node) - } -} - -impl<'a> From<&'a ast::FString> for AnyNodeRef<'a> { - fn from(node: &'a ast::FString) -> Self { - AnyNodeRef::FString(node) - } -} - -impl<'a> From<&'a ast::StringLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::StringLiteral) -> Self { - AnyNodeRef::StringLiteral(node) - } -} - -impl<'a> From<&'a ast::BytesLiteral> for AnyNodeRef<'a> { - fn from(node: &'a ast::BytesLiteral) -> Self { - AnyNodeRef::BytesLiteral(node) - } -} - -impl<'a> From<&'a Stmt> for AnyNodeRef<'a> { - fn from(stmt: &'a Stmt) -> Self { - match stmt { - Stmt::FunctionDef(node) => AnyNodeRef::StmtFunctionDef(node), - Stmt::ClassDef(node) => AnyNodeRef::StmtClassDef(node), - Stmt::Return(node) => AnyNodeRef::StmtReturn(node), - Stmt::Delete(node) => AnyNodeRef::StmtDelete(node), - Stmt::TypeAlias(node) => AnyNodeRef::StmtTypeAlias(node), - Stmt::Assign(node) => AnyNodeRef::StmtAssign(node), - Stmt::AugAssign(node) => AnyNodeRef::StmtAugAssign(node), - Stmt::AnnAssign(node) => AnyNodeRef::StmtAnnAssign(node), - Stmt::For(node) => AnyNodeRef::StmtFor(node), - Stmt::While(node) => AnyNodeRef::StmtWhile(node), - Stmt::If(node) => AnyNodeRef::StmtIf(node), - Stmt::With(node) => AnyNodeRef::StmtWith(node), - Stmt::Match(node) => AnyNodeRef::StmtMatch(node), - Stmt::Raise(node) => AnyNodeRef::StmtRaise(node), - Stmt::Try(node) => AnyNodeRef::StmtTry(node), - Stmt::Assert(node) => AnyNodeRef::StmtAssert(node), - Stmt::Import(node) => AnyNodeRef::StmtImport(node), - Stmt::ImportFrom(node) => AnyNodeRef::StmtImportFrom(node), - Stmt::Global(node) => AnyNodeRef::StmtGlobal(node), - Stmt::Nonlocal(node) => AnyNodeRef::StmtNonlocal(node), - Stmt::Expr(node) => AnyNodeRef::StmtExpr(node), - Stmt::Pass(node) => AnyNodeRef::StmtPass(node), - Stmt::Break(node) => AnyNodeRef::StmtBreak(node), - Stmt::Continue(node) => AnyNodeRef::StmtContinue(node), - Stmt::IpyEscapeCommand(node) => AnyNodeRef::StmtIpyEscapeCommand(node), - } - } -} - -impl<'a> From<&'a Expr> for AnyNodeRef<'a> { - fn from(expr: &'a Expr) -> Self { - match expr { - Expr::BoolOp(node) => AnyNodeRef::ExprBoolOp(node), - Expr::Named(node) => AnyNodeRef::ExprNamed(node), - Expr::BinOp(node) => AnyNodeRef::ExprBinOp(node), - Expr::UnaryOp(node) => AnyNodeRef::ExprUnaryOp(node), - Expr::Lambda(node) => AnyNodeRef::ExprLambda(node), - Expr::If(node) => AnyNodeRef::ExprIf(node), - Expr::Dict(node) => AnyNodeRef::ExprDict(node), - Expr::Set(node) => AnyNodeRef::ExprSet(node), - Expr::ListComp(node) => AnyNodeRef::ExprListComp(node), - Expr::SetComp(node) => AnyNodeRef::ExprSetComp(node), - Expr::DictComp(node) => AnyNodeRef::ExprDictComp(node), - Expr::Generator(node) => AnyNodeRef::ExprGenerator(node), - Expr::Await(node) => AnyNodeRef::ExprAwait(node), - Expr::Yield(node) => AnyNodeRef::ExprYield(node), - Expr::YieldFrom(node) => AnyNodeRef::ExprYieldFrom(node), - Expr::Compare(node) => AnyNodeRef::ExprCompare(node), - Expr::Call(node) => AnyNodeRef::ExprCall(node), - Expr::FString(node) => AnyNodeRef::ExprFString(node), - Expr::StringLiteral(node) => AnyNodeRef::ExprStringLiteral(node), - Expr::BytesLiteral(node) => AnyNodeRef::ExprBytesLiteral(node), - Expr::NumberLiteral(node) => AnyNodeRef::ExprNumberLiteral(node), - Expr::BooleanLiteral(node) => AnyNodeRef::ExprBooleanLiteral(node), - Expr::NoneLiteral(node) => AnyNodeRef::ExprNoneLiteral(node), - Expr::EllipsisLiteral(node) => AnyNodeRef::ExprEllipsisLiteral(node), - Expr::Attribute(node) => AnyNodeRef::ExprAttribute(node), - Expr::Subscript(node) => AnyNodeRef::ExprSubscript(node), - Expr::Starred(node) => AnyNodeRef::ExprStarred(node), - Expr::Name(node) => AnyNodeRef::ExprName(node), - Expr::List(node) => AnyNodeRef::ExprList(node), - Expr::Tuple(node) => AnyNodeRef::ExprTuple(node), - Expr::Slice(node) => AnyNodeRef::ExprSlice(node), - Expr::IpyEscapeCommand(node) => AnyNodeRef::ExprIpyEscapeCommand(node), - } - } -} - -impl<'a> From<&'a Mod> for AnyNodeRef<'a> { - fn from(module: &'a Mod) -> Self { - match module { - Mod::Module(node) => AnyNodeRef::ModModule(node), - Mod::Expression(node) => AnyNodeRef::ModExpression(node), - } - } -} - -impl<'a> From<&'a FStringElement> for AnyNodeRef<'a> { - fn from(element: &'a FStringElement) -> Self { - match element { - FStringElement::Expression(node) => AnyNodeRef::FStringExpressionElement(node), - FStringElement::Literal(node) => AnyNodeRef::FStringLiteralElement(node), - } - } -} - -impl<'a> From<&'a Pattern> for AnyNodeRef<'a> { - fn from(pattern: &'a Pattern) -> Self { - match pattern { - Pattern::MatchValue(node) => AnyNodeRef::PatternMatchValue(node), - Pattern::MatchSingleton(node) => AnyNodeRef::PatternMatchSingleton(node), - Pattern::MatchSequence(node) => AnyNodeRef::PatternMatchSequence(node), - Pattern::MatchMapping(node) => AnyNodeRef::PatternMatchMapping(node), - Pattern::MatchClass(node) => AnyNodeRef::PatternMatchClass(node), - Pattern::MatchStar(node) => AnyNodeRef::PatternMatchStar(node), - Pattern::MatchAs(node) => AnyNodeRef::PatternMatchAs(node), - Pattern::MatchOr(node) => AnyNodeRef::PatternMatchOr(node), - } - } -} - -impl<'a> From<&'a TypeParam> for AnyNodeRef<'a> { - fn from(type_param: &'a TypeParam) -> Self { - match type_param { - TypeParam::TypeVar(node) => AnyNodeRef::TypeParamTypeVar(node), - TypeParam::TypeVarTuple(node) => AnyNodeRef::TypeParamTypeVarTuple(node), - TypeParam::ParamSpec(node) => AnyNodeRef::TypeParamParamSpec(node), - } - } -} - -impl<'a> From<&'a ExceptHandler> for AnyNodeRef<'a> { - fn from(handler: &'a ExceptHandler) -> Self { - match handler { - ExceptHandler::ExceptHandler(handler) => { - AnyNodeRef::ExceptHandlerExceptHandler(handler) - } - } - } -} - -impl<'a> From<&'a Comprehension> for AnyNodeRef<'a> { - fn from(node: &'a Comprehension) -> Self { - AnyNodeRef::Comprehension(node) - } -} -impl<'a> From<&'a Arguments> for AnyNodeRef<'a> { - fn from(node: &'a Arguments) -> Self { - AnyNodeRef::Arguments(node) - } -} -impl<'a> From<&'a Parameters> for AnyNodeRef<'a> { - fn from(node: &'a Parameters) -> Self { - AnyNodeRef::Parameters(node) - } -} -impl<'a> From<&'a Parameter> for AnyNodeRef<'a> { - fn from(node: &'a Parameter) -> Self { - AnyNodeRef::Parameter(node) - } -} -impl<'a> From<&'a ParameterWithDefault> for AnyNodeRef<'a> { - fn from(node: &'a ParameterWithDefault) -> Self { - AnyNodeRef::ParameterWithDefault(node) - } -} -impl<'a> From<&'a Keyword> for AnyNodeRef<'a> { - fn from(node: &'a Keyword) -> Self { - AnyNodeRef::Keyword(node) - } -} -impl<'a> From<&'a Alias> for AnyNodeRef<'a> { - fn from(node: &'a Alias) -> Self { - AnyNodeRef::Alias(node) - } -} -impl<'a> From<&'a WithItem> for AnyNodeRef<'a> { - fn from(node: &'a WithItem) -> Self { - AnyNodeRef::WithItem(node) - } -} -impl<'a> From<&'a MatchCase> for AnyNodeRef<'a> { - fn from(node: &'a MatchCase) -> Self { - AnyNodeRef::MatchCase(node) - } -} -impl<'a> From<&'a ast::Identifier> for AnyNodeRef<'a> { - fn from(node: &'a ast::Identifier) -> Self { - AnyNodeRef::Identifier(node) - } -} - -impl Ranged for AnyNodeRef<'_> { - fn range(&self) -> TextRange { - match self { - AnyNodeRef::ModModule(node) => node.range(), - AnyNodeRef::ModExpression(node) => node.range(), - AnyNodeRef::StmtFunctionDef(node) => node.range(), - AnyNodeRef::StmtClassDef(node) => node.range(), - AnyNodeRef::StmtReturn(node) => node.range(), - AnyNodeRef::StmtDelete(node) => node.range(), - AnyNodeRef::StmtTypeAlias(node) => node.range(), - AnyNodeRef::StmtAssign(node) => node.range(), - AnyNodeRef::StmtAugAssign(node) => node.range(), - AnyNodeRef::StmtAnnAssign(node) => node.range(), - AnyNodeRef::StmtFor(node) => node.range(), - AnyNodeRef::StmtWhile(node) => node.range(), - AnyNodeRef::StmtIf(node) => node.range(), - AnyNodeRef::StmtWith(node) => node.range(), - AnyNodeRef::StmtMatch(node) => node.range(), - AnyNodeRef::StmtRaise(node) => node.range(), - AnyNodeRef::StmtTry(node) => node.range(), - AnyNodeRef::StmtAssert(node) => node.range(), - AnyNodeRef::StmtImport(node) => node.range(), - AnyNodeRef::StmtImportFrom(node) => node.range(), - AnyNodeRef::StmtGlobal(node) => node.range(), - AnyNodeRef::StmtNonlocal(node) => node.range(), - AnyNodeRef::StmtExpr(node) => node.range(), - AnyNodeRef::StmtPass(node) => node.range(), - AnyNodeRef::StmtBreak(node) => node.range(), - AnyNodeRef::StmtContinue(node) => node.range(), - AnyNodeRef::StmtIpyEscapeCommand(node) => node.range(), - AnyNodeRef::ExprBoolOp(node) => node.range(), - AnyNodeRef::ExprNamed(node) => node.range(), - AnyNodeRef::ExprBinOp(node) => node.range(), - AnyNodeRef::ExprUnaryOp(node) => node.range(), - AnyNodeRef::ExprLambda(node) => node.range(), - AnyNodeRef::ExprIf(node) => node.range(), - AnyNodeRef::ExprDict(node) => node.range(), - AnyNodeRef::ExprSet(node) => node.range(), - AnyNodeRef::ExprListComp(node) => node.range(), - AnyNodeRef::ExprSetComp(node) => node.range(), - AnyNodeRef::ExprDictComp(node) => node.range(), - AnyNodeRef::ExprGenerator(node) => node.range(), - AnyNodeRef::ExprAwait(node) => node.range(), - AnyNodeRef::ExprYield(node) => node.range(), - AnyNodeRef::ExprYieldFrom(node) => node.range(), - AnyNodeRef::ExprCompare(node) => node.range(), - AnyNodeRef::ExprCall(node) => node.range(), - AnyNodeRef::FStringExpressionElement(node) => node.range(), - AnyNodeRef::FStringLiteralElement(node) => node.range(), - AnyNodeRef::FStringFormatSpec(node) => node.range(), - AnyNodeRef::ExprFString(node) => node.range(), - AnyNodeRef::ExprStringLiteral(node) => node.range(), - AnyNodeRef::ExprBytesLiteral(node) => node.range(), - AnyNodeRef::ExprNumberLiteral(node) => node.range(), - AnyNodeRef::ExprBooleanLiteral(node) => node.range(), - AnyNodeRef::ExprNoneLiteral(node) => node.range(), - AnyNodeRef::ExprEllipsisLiteral(node) => node.range(), - AnyNodeRef::ExprAttribute(node) => node.range(), - AnyNodeRef::ExprSubscript(node) => node.range(), - AnyNodeRef::ExprStarred(node) => node.range(), - AnyNodeRef::ExprName(node) => node.range(), - AnyNodeRef::ExprList(node) => node.range(), - AnyNodeRef::ExprTuple(node) => node.range(), - AnyNodeRef::ExprSlice(node) => node.range(), - AnyNodeRef::ExprIpyEscapeCommand(node) => node.range(), - AnyNodeRef::ExceptHandlerExceptHandler(node) => node.range(), - AnyNodeRef::PatternMatchValue(node) => node.range(), - AnyNodeRef::PatternMatchSingleton(node) => node.range(), - AnyNodeRef::PatternMatchSequence(node) => node.range(), - AnyNodeRef::PatternMatchMapping(node) => node.range(), - AnyNodeRef::PatternMatchClass(node) => node.range(), - AnyNodeRef::PatternMatchStar(node) => node.range(), - AnyNodeRef::PatternMatchAs(node) => node.range(), - AnyNodeRef::PatternMatchOr(node) => node.range(), - AnyNodeRef::PatternArguments(node) => node.range(), - AnyNodeRef::PatternKeyword(node) => node.range(), - AnyNodeRef::Comprehension(node) => node.range(), - AnyNodeRef::Arguments(node) => node.range(), - AnyNodeRef::Parameters(node) => node.range(), - AnyNodeRef::Parameter(node) => node.range(), - AnyNodeRef::ParameterWithDefault(node) => node.range(), - AnyNodeRef::Keyword(node) => node.range(), - AnyNodeRef::Alias(node) => node.range(), - AnyNodeRef::WithItem(node) => node.range(), - AnyNodeRef::MatchCase(node) => node.range(), - AnyNodeRef::Decorator(node) => node.range(), - AnyNodeRef::ElifElseClause(node) => node.range(), - AnyNodeRef::TypeParams(node) => node.range(), - AnyNodeRef::TypeParamTypeVar(node) => node.range(), - AnyNodeRef::TypeParamTypeVarTuple(node) => node.range(), - AnyNodeRef::TypeParamParamSpec(node) => node.range(), - AnyNodeRef::FString(node) => node.range(), - AnyNodeRef::StringLiteral(node) => node.range(), - AnyNodeRef::BytesLiteral(node) => node.range(), - AnyNodeRef::Identifier(node) => node.range(), - } - } -} - -#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] -pub enum NodeKind { - ModModule, - ModInteractive, - ModExpression, - ModFunctionType, - StmtFunctionDef, - StmtClassDef, - StmtReturn, - StmtDelete, - StmtTypeAlias, - StmtAssign, - StmtAugAssign, - StmtAnnAssign, - StmtFor, - StmtWhile, - StmtIf, - StmtWith, - StmtMatch, - StmtRaise, - StmtTry, - StmtAssert, - StmtImport, - StmtImportFrom, - StmtGlobal, - StmtNonlocal, - StmtIpyEscapeCommand, - StmtExpr, - StmtPass, - StmtBreak, - StmtContinue, - ExprBoolOp, - ExprNamed, - ExprBinOp, - ExprUnaryOp, - ExprLambda, - ExprIf, - ExprDict, - ExprSet, - ExprListComp, - ExprSetComp, - ExprDictComp, - ExprGenerator, - ExprAwait, - ExprYield, - ExprYieldFrom, - ExprCompare, - ExprCall, - FStringExpressionElement, - FStringLiteralElement, - FStringFormatSpec, - ExprFString, - ExprStringLiteral, - ExprBytesLiteral, - ExprNumberLiteral, - ExprBooleanLiteral, - ExprNoneLiteral, - ExprEllipsisLiteral, - ExprAttribute, - ExprSubscript, - ExprStarred, - ExprName, - ExprList, - ExprTuple, - ExprSlice, - ExprIpyEscapeCommand, - ExceptHandlerExceptHandler, - PatternMatchValue, - PatternMatchSingleton, - PatternMatchSequence, - PatternMatchMapping, - PatternMatchClass, - PatternMatchStar, - PatternMatchAs, - PatternMatchOr, - PatternArguments, - PatternKeyword, - TypeIgnoreTypeIgnore, - Comprehension, - Arguments, - Parameters, - Parameter, - ParameterWithDefault, - Keyword, - Alias, - WithItem, - MatchCase, - Decorator, - ElifElseClause, - TypeParams, - TypeParamTypeVar, - TypeParamTypeVarTuple, - TypeParamParamSpec, - FString, - StringLiteral, - BytesLiteral, - Identifier, -} - -// FIXME: The `StatementRef` here allows us to implement `AstNode` for `Stmt` which otherwise wouldn't be possible -// because of the `cast_ref` method that needs to return a `&Stmt` for a specific statement node. -// Implementing `AstNode` for `Stmt` is desired to have `AstId.upcast` work where the Id then represents -// any `Stmt` instead of a specific statement. -// The existing solution "works" in the sense that `upcast` etc can be implemented. However, `StatementRef` -// doesn't implement `AstNode` itself and thus, can't be used as `AstNodeKey` or passed to query the `ast_id` (because that requires that the node implements `HasAstId` which extends `AstNode`). -// I don't know how a solution to this would look like but this isn't the first time where this problem has come up. -#[derive(Clone, Copy, Debug, PartialEq)] -pub enum StatementRef<'a> { - FunctionDef(&'a StmtFunctionDef), - ClassDef(&'a StmtClassDef), - Return(&'a StmtReturn), - Delete(&'a StmtDelete), - Assign(&'a StmtAssign), - AugAssign(&'a StmtAugAssign), - AnnAssign(&'a StmtAnnAssign), - TypeAlias(&'a StmtTypeAlias), - For(&'a StmtFor), - While(&'a StmtWhile), - If(&'a StmtIf), - With(&'a StmtWith), - Match(&'a StmtMatch), - Raise(&'a StmtRaise), - Try(&'a StmtTry), - Assert(&'a StmtAssert), - Import(&'a StmtImport), - ImportFrom(&'a StmtImportFrom), - Global(&'a StmtGlobal), - Nonlocal(&'a StmtNonlocal), - Expr(&'a StmtExpr), - Pass(&'a StmtPass), - Break(&'a StmtBreak), - Continue(&'a StmtContinue), - IpyEscapeCommand(&'a StmtIpyEscapeCommand), -} - -impl<'a> From<&'a StmtFunctionDef> for StatementRef<'a> { - fn from(value: &'a StmtFunctionDef) -> Self { - Self::FunctionDef(value) - } -} -impl<'a> From<&'a StmtClassDef> for StatementRef<'a> { - fn from(value: &'a StmtClassDef) -> Self { - Self::ClassDef(value) - } -} -impl<'a> From<&'a StmtReturn> for StatementRef<'a> { - fn from(value: &'a StmtReturn) -> Self { - Self::Return(value) - } -} -impl<'a> From<&'a StmtDelete> for StatementRef<'a> { - fn from(value: &'a StmtDelete) -> Self { - Self::Delete(value) - } -} -impl<'a> From<&'a StmtAssign> for StatementRef<'a> { - fn from(value: &'a StmtAssign) -> Self { - Self::Assign(value) - } -} -impl<'a> From<&'a StmtAugAssign> for StatementRef<'a> { - fn from(value: &'a StmtAugAssign) -> Self { - Self::AugAssign(value) - } -} -impl<'a> From<&'a StmtAnnAssign> for StatementRef<'a> { - fn from(value: &'a StmtAnnAssign) -> Self { - Self::AnnAssign(value) - } -} -impl<'a> From<&'a StmtTypeAlias> for StatementRef<'a> { - fn from(value: &'a StmtTypeAlias) -> Self { - Self::TypeAlias(value) - } -} -impl<'a> From<&'a StmtFor> for StatementRef<'a> { - fn from(value: &'a StmtFor) -> Self { - Self::For(value) - } -} -impl<'a> From<&'a StmtWhile> for StatementRef<'a> { - fn from(value: &'a StmtWhile) -> Self { - Self::While(value) - } -} -impl<'a> From<&'a StmtIf> for StatementRef<'a> { - fn from(value: &'a StmtIf) -> Self { - Self::If(value) - } -} -impl<'a> From<&'a StmtWith> for StatementRef<'a> { - fn from(value: &'a StmtWith) -> Self { - Self::With(value) - } -} -impl<'a> From<&'a StmtMatch> for StatementRef<'a> { - fn from(value: &'a StmtMatch) -> Self { - Self::Match(value) - } -} -impl<'a> From<&'a StmtRaise> for StatementRef<'a> { - fn from(value: &'a StmtRaise) -> Self { - Self::Raise(value) - } -} -impl<'a> From<&'a StmtTry> for StatementRef<'a> { - fn from(value: &'a StmtTry) -> Self { - Self::Try(value) - } -} -impl<'a> From<&'a StmtAssert> for StatementRef<'a> { - fn from(value: &'a StmtAssert) -> Self { - Self::Assert(value) - } -} -impl<'a> From<&'a StmtImport> for StatementRef<'a> { - fn from(value: &'a StmtImport) -> Self { - Self::Import(value) - } -} -impl<'a> From<&'a StmtImportFrom> for StatementRef<'a> { - fn from(value: &'a StmtImportFrom) -> Self { - Self::ImportFrom(value) - } -} -impl<'a> From<&'a StmtGlobal> for StatementRef<'a> { - fn from(value: &'a StmtGlobal) -> Self { - Self::Global(value) - } -} -impl<'a> From<&'a StmtNonlocal> for StatementRef<'a> { - fn from(value: &'a StmtNonlocal) -> Self { - Self::Nonlocal(value) - } -} -impl<'a> From<&'a StmtExpr> for StatementRef<'a> { - fn from(value: &'a StmtExpr) -> Self { - Self::Expr(value) - } -} -impl<'a> From<&'a StmtPass> for StatementRef<'a> { - fn from(value: &'a StmtPass) -> Self { - Self::Pass(value) - } -} -impl<'a> From<&'a StmtBreak> for StatementRef<'a> { - fn from(value: &'a StmtBreak) -> Self { - Self::Break(value) - } -} -impl<'a> From<&'a StmtContinue> for StatementRef<'a> { - fn from(value: &'a StmtContinue) -> Self { - Self::Continue(value) - } -} -impl<'a> From<&'a StmtIpyEscapeCommand> for StatementRef<'a> { - fn from(value: &'a StmtIpyEscapeCommand) -> Self { - Self::IpyEscapeCommand(value) - } -} - -impl<'a> From<&'a Stmt> for StatementRef<'a> { - fn from(value: &'a Stmt) -> Self { - match value { - Stmt::FunctionDef(statement) => Self::FunctionDef(statement), - Stmt::ClassDef(statement) => Self::ClassDef(statement), - Stmt::Return(statement) => Self::Return(statement), - Stmt::Delete(statement) => Self::Delete(statement), - Stmt::Assign(statement) => Self::Assign(statement), - Stmt::AugAssign(statement) => Self::AugAssign(statement), - Stmt::AnnAssign(statement) => Self::AnnAssign(statement), - Stmt::TypeAlias(statement) => Self::TypeAlias(statement), - Stmt::For(statement) => Self::For(statement), - Stmt::While(statement) => Self::While(statement), - Stmt::If(statement) => Self::If(statement), - Stmt::With(statement) => Self::With(statement), - Stmt::Match(statement) => Self::Match(statement), - Stmt::Raise(statement) => Self::Raise(statement), - Stmt::Try(statement) => Self::Try(statement), - Stmt::Assert(statement) => Self::Assert(statement), - Stmt::Import(statement) => Self::Import(statement), - Stmt::ImportFrom(statement) => Self::ImportFrom(statement), - Stmt::Global(statement) => Self::Global(statement), - Stmt::Nonlocal(statement) => Self::Nonlocal(statement), - Stmt::Expr(statement) => Self::Expr(statement), - Stmt::Pass(statement) => Self::Pass(statement), - Stmt::Break(statement) => Self::Break(statement), - Stmt::Continue(statement) => Self::Continue(statement), - Stmt::IpyEscapeCommand(statement) => Self::IpyEscapeCommand(statement), - } - } -} - -#[derive(Copy, Clone, Debug, PartialEq)] -pub enum TypeParamRef<'a> { - TypeVar(&'a TypeParamTypeVar), - ParamSpec(&'a TypeParamParamSpec), - TypeVarTuple(&'a TypeParamTypeVarTuple), -} - -impl<'a> From<&'a TypeParamTypeVar> for TypeParamRef<'a> { - fn from(value: &'a TypeParamTypeVar) -> Self { - Self::TypeVar(value) - } -} - -impl<'a> From<&'a TypeParamParamSpec> for TypeParamRef<'a> { - fn from(value: &'a TypeParamParamSpec) -> Self { - Self::ParamSpec(value) - } -} - -impl<'a> From<&'a TypeParamTypeVarTuple> for TypeParamRef<'a> { - fn from(value: &'a TypeParamTypeVarTuple) -> Self { - Self::TypeVarTuple(value) - } -} - -impl<'a> From<&'a TypeParam> for TypeParamRef<'a> { - fn from(value: &'a TypeParam) -> Self { - match value { - TypeParam::TypeVar(value) => Self::TypeVar(value), - TypeParam::ParamSpec(value) => Self::ParamSpec(value), - TypeParam::TypeVarTuple(value) => Self::TypeVarTuple(value), - } - } +/// Returns `true` if `right` is `Some` and `left` and `right` are referentially equal. +fn are_same_optional<'a, T>(left: AnyNodeRef, right: Option<T>) -> bool +where + T: Into<AnyNodeRef<'a>>, +{ + right.is_some_and(|right| left.ptr_eq(right.into())) } diff --git a/crates/ruff_python_ast/src/nodes.rs b/crates/ruff_python_ast/src/nodes.rs index a35868d6a0371..40e3dd8f00d64 100644 --- a/crates/ruff_python_ast/src/nodes.rs +++ b/crates/ruff_python_ast/src/nodes.rs @@ -1,5 +1,9 @@ #![allow(clippy::derive_partial_eq_without_eq)] +use crate::generated::{ + ExprBytesLiteral, ExprDict, ExprFString, ExprList, ExprName, ExprSet, ExprStringLiteral, + ExprTuple, StmtClassDef, +}; use std::borrow::Cow; use std::fmt; use std::fmt::Debug; @@ -13,204 +17,14 @@ use itertools::Itertools; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; -use crate::name::Name; +use crate::str_prefix::{AnyStringPrefix, ByteStringPrefix, FStringPrefix, StringLiteralPrefix}; use crate::{ - int, - str::Quote, - str_prefix::{AnyStringPrefix, ByteStringPrefix, FStringPrefix, StringLiteralPrefix}, - LiteralExpressionRef, + Expr, ExprRef, FStringElement, LiteralExpressionRef, OperatorPrecedence, Pattern, Stmt, + TypeParam, int, + name::Name, + str::{Quote, TripleQuotes}, }; -/// See also [mod](https://docs.python.org/3/library/ast.html#ast.mod) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum Mod { - Module(ModModule), - Expression(ModExpression), -} - -/// See also [Module](https://docs.python.org/3/library/ast.html#ast.Module) -#[derive(Clone, Debug, PartialEq)] -pub struct ModModule { - pub range: TextRange, - pub body: Vec<Stmt>, -} - -impl From<ModModule> for Mod { - fn from(payload: ModModule) -> Self { - Mod::Module(payload) - } -} - -/// See also [Expression](https://docs.python.org/3/library/ast.html#ast.Expression) -#[derive(Clone, Debug, PartialEq)] -pub struct ModExpression { - pub range: TextRange, - pub body: Box<Expr>, -} - -impl From<ModExpression> for Mod { - fn from(payload: ModExpression) -> Self { - Mod::Expression(payload) - } -} - -/// See also [stmt](https://docs.python.org/3/library/ast.html#ast.stmt) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum Stmt { - #[is(name = "function_def_stmt")] - FunctionDef(StmtFunctionDef), - #[is(name = "class_def_stmt")] - ClassDef(StmtClassDef), - #[is(name = "return_stmt")] - Return(StmtReturn), - #[is(name = "delete_stmt")] - Delete(StmtDelete), - #[is(name = "assign_stmt")] - Assign(StmtAssign), - #[is(name = "aug_assign_stmt")] - AugAssign(StmtAugAssign), - #[is(name = "ann_assign_stmt")] - AnnAssign(StmtAnnAssign), - #[is(name = "type_alias_stmt")] - TypeAlias(StmtTypeAlias), - #[is(name = "for_stmt")] - For(StmtFor), - #[is(name = "while_stmt")] - While(StmtWhile), - #[is(name = "if_stmt")] - If(StmtIf), - #[is(name = "with_stmt")] - With(StmtWith), - #[is(name = "match_stmt")] - Match(StmtMatch), - #[is(name = "raise_stmt")] - Raise(StmtRaise), - #[is(name = "try_stmt")] - Try(StmtTry), - #[is(name = "assert_stmt")] - Assert(StmtAssert), - #[is(name = "import_stmt")] - Import(StmtImport), - #[is(name = "import_from_stmt")] - ImportFrom(StmtImportFrom), - #[is(name = "global_stmt")] - Global(StmtGlobal), - #[is(name = "nonlocal_stmt")] - Nonlocal(StmtNonlocal), - #[is(name = "expr_stmt")] - Expr(StmtExpr), - #[is(name = "pass_stmt")] - Pass(StmtPass), - #[is(name = "break_stmt")] - Break(StmtBreak), - #[is(name = "continue_stmt")] - Continue(StmtContinue), - - // Jupyter notebook specific - #[is(name = "ipy_escape_command_stmt")] - IpyEscapeCommand(StmtIpyEscapeCommand), -} - -/// An AST node used to represent a IPython escape command at the statement level. -/// -/// For example, -/// ```python -/// %matplotlib inline -/// ``` -/// -/// ## Terminology -/// -/// Escape commands are special IPython syntax which starts with a token to identify -/// the escape kind followed by the command value itself. [Escape kind] are the kind -/// of escape commands that are recognized by the token: `%`, `%%`, `!`, `!!`, -/// `?`, `??`, `/`, `;`, and `,`. -/// -/// Help command (or Dynamic Object Introspection as it's called) are the escape commands -/// of the kind `?` and `??`. For example, `?str.replace`. Help end command are a subset -/// of Help command where the token can be at the end of the line i.e., after the value. -/// For example, `str.replace?`. -/// -/// Here's where things get tricky. I'll divide the help end command into two types for -/// better understanding: -/// 1. Strict version: The token is _only_ at the end of the line. For example, -/// `str.replace?` or `str.replace??`. -/// 2. Combined version: Along with the `?` or `??` token, which are at the end of the -/// line, there are other escape kind tokens that are present at the start as well. -/// For example, `%matplotlib?` or `%%timeit?`. -/// -/// Priority comes into picture for the "Combined version" mentioned above. How do -/// we determine the escape kind if there are tokens on both side of the value, i.e., which -/// token to choose? The Help end command always takes priority over any other token which -/// means that if there is `?`/`??` at the end then that is used to determine the kind. -/// For example, in `%matplotlib?` the escape kind is determined using the `?` token -/// instead of `%` token. -/// -/// ## Syntax -/// -/// `<IpyEscapeKind><Command value>` -/// -/// The simplest form is an escape kind token followed by the command value. For example, -/// `%matplotlib inline`, `/foo`, `!pwd`, etc. -/// -/// `<Command value><IpyEscapeKind ("?" or "??")>` -/// -/// The help end escape command would be the reverse of the above syntax. Here, the -/// escape kind token can only be either `?` or `??` and it is at the end of the line. -/// For example, `str.replace?`, `math.pi??`, etc. -/// -/// `<IpyEscapeKind><Command value><EscapeKind ("?" or "??")>` -/// -/// The final syntax is the combined version of the above two. For example, `%matplotlib?`, -/// `%%timeit??`, etc. -/// -/// [Escape kind]: IpyEscapeKind -#[derive(Clone, Debug, PartialEq)] -pub struct StmtIpyEscapeCommand { - pub range: TextRange, - pub kind: IpyEscapeKind, - pub value: Box<str>, -} - -impl From<StmtIpyEscapeCommand> for Stmt { - fn from(payload: StmtIpyEscapeCommand) -> Self { - Stmt::IpyEscapeCommand(payload) - } -} - -/// See also [FunctionDef](https://docs.python.org/3/library/ast.html#ast.FunctionDef) and -/// [AsyncFunctionDef](https://docs.python.org/3/library/ast.html#ast.AsyncFunctionDef). -/// -/// This type differs from the original Python AST, as it collapses the -/// synchronous and asynchronous variants into a single type. -#[derive(Clone, Debug, PartialEq)] -pub struct StmtFunctionDef { - pub range: TextRange, - pub is_async: bool, - pub decorator_list: Vec<Decorator>, - pub name: Identifier, - pub type_params: Option<Box<TypeParams>>, - pub parameters: Box<Parameters>, - pub returns: Option<Box<Expr>>, - pub body: Vec<Stmt>, -} - -impl From<StmtFunctionDef> for Stmt { - fn from(payload: StmtFunctionDef) -> Self { - Stmt::FunctionDef(payload) - } -} - -/// See also [ClassDef](https://docs.python.org/3/library/ast.html#ast.ClassDef) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtClassDef { - pub range: TextRange, - pub decorator_list: Vec<Decorator>, - pub name: Identifier, - pub type_params: Option<Box<TypeParams>>, - pub arguments: Option<Box<Arguments>>, - pub body: Vec<Stmt>, -} - impl StmtClassDef { /// Return an iterator over the bases of the class. pub fn bases(&self) -> &[Expr] { @@ -229,1331 +43,1151 @@ impl StmtClassDef { } } -impl From<StmtClassDef> for Stmt { - fn from(payload: StmtClassDef) -> Self { - Stmt::ClassDef(payload) - } -} - -/// See also [Return](https://docs.python.org/3/library/ast.html#ast.Return) #[derive(Clone, Debug, PartialEq)] -pub struct StmtReturn { +pub struct ElifElseClause { pub range: TextRange, - pub value: Option<Box<Expr>>, + pub test: Option<Expr>, + pub body: Vec<Stmt>, } -impl From<StmtReturn> for Stmt { - fn from(payload: StmtReturn) -> Self { - Stmt::Return(payload) +impl Expr { + /// Returns `true` if the expression is a literal expression. + /// + /// A literal expression is either a string literal, bytes literal, + /// integer, float, complex number, boolean, `None`, or ellipsis (`...`). + pub fn is_literal_expr(&self) -> bool { + matches!( + self, + Expr::StringLiteral(_) + | Expr::BytesLiteral(_) + | Expr::NumberLiteral(_) + | Expr::BooleanLiteral(_) + | Expr::NoneLiteral(_) + | Expr::EllipsisLiteral(_) + ) } -} - -/// See also [Delete](https://docs.python.org/3/library/ast.html#ast.Delete) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtDelete { - pub range: TextRange, - pub targets: Vec<Expr>, -} -impl From<StmtDelete> for Stmt { - fn from(payload: StmtDelete) -> Self { - Stmt::Delete(payload) + /// Returns [`LiteralExpressionRef`] if the expression is a literal expression. + pub fn as_literal_expr(&self) -> Option<LiteralExpressionRef<'_>> { + match self { + Expr::StringLiteral(expr) => Some(LiteralExpressionRef::StringLiteral(expr)), + Expr::BytesLiteral(expr) => Some(LiteralExpressionRef::BytesLiteral(expr)), + Expr::NumberLiteral(expr) => Some(LiteralExpressionRef::NumberLiteral(expr)), + Expr::BooleanLiteral(expr) => Some(LiteralExpressionRef::BooleanLiteral(expr)), + Expr::NoneLiteral(expr) => Some(LiteralExpressionRef::NoneLiteral(expr)), + Expr::EllipsisLiteral(expr) => Some(LiteralExpressionRef::EllipsisLiteral(expr)), + _ => None, + } } -} - -/// See also [TypeAlias](https://docs.python.org/3/library/ast.html#ast.TypeAlias) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtTypeAlias { - pub range: TextRange, - pub name: Box<Expr>, - pub type_params: Option<TypeParams>, - pub value: Box<Expr>, -} -impl From<StmtTypeAlias> for Stmt { - fn from(payload: StmtTypeAlias) -> Self { - Stmt::TypeAlias(payload) + /// Return the [`OperatorPrecedence`] of this expression + pub fn precedence(&self) -> OperatorPrecedence { + OperatorPrecedence::from(self) } } -/// See also [Assign](https://docs.python.org/3/library/ast.html#ast.Assign) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtAssign { - pub range: TextRange, - pub targets: Vec<Expr>, - pub value: Box<Expr>, -} +impl ExprRef<'_> { + /// See [`Expr::is_literal_expr`]. + pub fn is_literal_expr(&self) -> bool { + matches!( + self, + ExprRef::StringLiteral(_) + | ExprRef::BytesLiteral(_) + | ExprRef::NumberLiteral(_) + | ExprRef::BooleanLiteral(_) + | ExprRef::NoneLiteral(_) + | ExprRef::EllipsisLiteral(_) + ) + } -impl From<StmtAssign> for Stmt { - fn from(payload: StmtAssign) -> Self { - Stmt::Assign(payload) + pub fn precedence(&self) -> OperatorPrecedence { + OperatorPrecedence::from(self) } } -/// See also [AugAssign](https://docs.python.org/3/library/ast.html#ast.AugAssign) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtAugAssign { - pub range: TextRange, - pub target: Box<Expr>, - pub op: Operator, - pub value: Box<Expr>, +/// Represents an item in a [dictionary literal display][1]. +/// +/// Consider the following Python dictionary literal: +/// ```python +/// {key1: value1, **other_dictionary} +/// ``` +/// +/// In our AST, this would be represented using an `ExprDict` node containing +/// two `DictItem` nodes inside it: +/// ```ignore +/// [ +/// DictItem { +/// key: Some(Expr::Name(ExprName { id: "key1" })), +/// value: Expr::Name(ExprName { id: "value1" }), +/// }, +/// DictItem { +/// key: None, +/// value: Expr::Name(ExprName { id: "other_dictionary" }), +/// } +/// ] +/// ``` +/// +/// [1]: https://docs.python.org/3/reference/expressions.html#displays-for-lists-sets-and-dictionaries +#[derive(Debug, Clone, PartialEq)] +pub struct DictItem { + pub key: Option<Expr>, + pub value: Expr, } -impl From<StmtAugAssign> for Stmt { - fn from(payload: StmtAugAssign) -> Self { - Stmt::AugAssign(payload) +impl DictItem { + fn key(&self) -> Option<&Expr> { + self.key.as_ref() } -} -/// See also [AnnAssign](https://docs.python.org/3/library/ast.html#ast.AnnAssign) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtAnnAssign { - pub range: TextRange, - pub target: Box<Expr>, - pub annotation: Box<Expr>, - pub value: Option<Box<Expr>>, - pub simple: bool, + fn value(&self) -> &Expr { + &self.value + } } -impl From<StmtAnnAssign> for Stmt { - fn from(payload: StmtAnnAssign) -> Self { - Stmt::AnnAssign(payload) +impl Ranged for DictItem { + fn range(&self) -> TextRange { + TextRange::new( + self.key.as_ref().map_or(self.value.start(), Ranged::start), + self.value.end(), + ) } } -/// See also [For](https://docs.python.org/3/library/ast.html#ast.For) and -/// [AsyncFor](https://docs.python.org/3/library/ast.html#ast.AsyncFor). -/// -/// This type differs from the original Python AST, as it collapses the -/// synchronous and asynchronous variants into a single type. -#[derive(Clone, Debug, PartialEq)] -pub struct StmtFor { - pub range: TextRange, - pub is_async: bool, - pub target: Box<Expr>, - pub iter: Box<Expr>, - pub body: Vec<Stmt>, - pub orelse: Vec<Stmt>, -} +impl ExprDict { + /// Returns an `Iterator` over the AST nodes representing the + /// dictionary's keys. + pub fn iter_keys(&self) -> DictKeyIterator { + DictKeyIterator::new(&self.items) + } -impl From<StmtFor> for Stmt { - fn from(payload: StmtFor) -> Self { - Stmt::For(payload) + /// Returns an `Iterator` over the AST nodes representing the + /// dictionary's values. + pub fn iter_values(&self) -> DictValueIterator { + DictValueIterator::new(&self.items) } -} -/// See also [While](https://docs.python.org/3/library/ast.html#ast.While) and -/// [AsyncWhile](https://docs.python.org/3/library/ast.html#ast.AsyncWhile). -#[derive(Clone, Debug, PartialEq)] -pub struct StmtWhile { - pub range: TextRange, - pub test: Box<Expr>, - pub body: Vec<Stmt>, - pub orelse: Vec<Stmt>, -} + /// Returns the AST node representing the *n*th key of this + /// dictionary. + /// + /// Panics: If the index `n` is out of bounds. + pub fn key(&self, n: usize) -> Option<&Expr> { + self.items[n].key() + } -impl From<StmtWhile> for Stmt { - fn from(payload: StmtWhile) -> Self { - Stmt::While(payload) + /// Returns the AST node representing the *n*th value of this + /// dictionary. + /// + /// Panics: If the index `n` is out of bounds. + pub fn value(&self, n: usize) -> &Expr { + self.items[n].value() } -} -/// See also [If](https://docs.python.org/3/library/ast.html#ast.If) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtIf { - pub range: TextRange, - pub test: Box<Expr>, - pub body: Vec<Stmt>, - pub elif_else_clauses: Vec<ElifElseClause>, -} + pub fn iter(&self) -> std::slice::Iter<'_, DictItem> { + self.items.iter() + } -impl From<StmtIf> for Stmt { - fn from(payload: StmtIf) -> Self { - Stmt::If(payload) + pub fn len(&self) -> usize { + self.items.len() } -} -#[derive(Clone, Debug, PartialEq)] -pub struct ElifElseClause { - pub range: TextRange, - pub test: Option<Expr>, - pub body: Vec<Stmt>, + pub fn is_empty(&self) -> bool { + self.items.is_empty() + } } -/// See also [With](https://docs.python.org/3/library/ast.html#ast.With) and -/// [AsyncWith](https://docs.python.org/3/library/ast.html#ast.AsyncWith). -/// -/// This type differs from the original Python AST, as it collapses the -/// synchronous and asynchronous variants into a single type. -#[derive(Clone, Debug, PartialEq)] -pub struct StmtWith { - pub range: TextRange, - pub is_async: bool, - pub items: Vec<WithItem>, - pub body: Vec<Stmt>, -} +impl<'a> IntoIterator for &'a ExprDict { + type IntoIter = std::slice::Iter<'a, DictItem>; + type Item = &'a DictItem; -impl From<StmtWith> for Stmt { - fn from(payload: StmtWith) -> Self { - Stmt::With(payload) + fn into_iter(self) -> Self::IntoIter { + self.iter() } } -/// See also [Match](https://docs.python.org/3/library/ast.html#ast.Match) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtMatch { - pub range: TextRange, - pub subject: Box<Expr>, - pub cases: Vec<MatchCase>, +#[derive(Debug, Clone)] +pub struct DictKeyIterator<'a> { + items: Iter<'a, DictItem>, } -impl From<StmtMatch> for Stmt { - fn from(payload: StmtMatch) -> Self { - Stmt::Match(payload) +impl<'a> DictKeyIterator<'a> { + fn new(items: &'a [DictItem]) -> Self { + Self { + items: items.iter(), + } } -} - -/// See also [Raise](https://docs.python.org/3/library/ast.html#ast.Raise) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtRaise { - pub range: TextRange, - pub exc: Option<Box<Expr>>, - pub cause: Option<Box<Expr>>, -} -impl From<StmtRaise> for Stmt { - fn from(payload: StmtRaise) -> Self { - Stmt::Raise(payload) + pub fn is_empty(&self) -> bool { + self.len() == 0 } } -/// See also [Try](https://docs.python.org/3/library/ast.html#ast.Try) and -/// [TryStar](https://docs.python.org/3/library/ast.html#ast.TryStar) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtTry { - pub range: TextRange, - pub body: Vec<Stmt>, - pub handlers: Vec<ExceptHandler>, - pub orelse: Vec<Stmt>, - pub finalbody: Vec<Stmt>, - pub is_star: bool, -} +impl<'a> Iterator for DictKeyIterator<'a> { + type Item = Option<&'a Expr>; -impl From<StmtTry> for Stmt { - fn from(payload: StmtTry) -> Self { - Stmt::Try(payload) + fn next(&mut self) -> Option<Self::Item> { + self.items.next().map(DictItem::key) } -} -/// See also [Assert](https://docs.python.org/3/library/ast.html#ast.Assert) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtAssert { - pub range: TextRange, - pub test: Box<Expr>, - pub msg: Option<Box<Expr>>, -} + fn last(mut self) -> Option<Self::Item> { + self.next_back() + } -impl From<StmtAssert> for Stmt { - fn from(payload: StmtAssert) -> Self { - Stmt::Assert(payload) + fn size_hint(&self) -> (usize, Option<usize>) { + self.items.size_hint() } } -/// See also [Import](https://docs.python.org/3/library/ast.html#ast.Import) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtImport { - pub range: TextRange, - pub names: Vec<Alias>, -} - -impl From<StmtImport> for Stmt { - fn from(payload: StmtImport) -> Self { - Stmt::Import(payload) +impl DoubleEndedIterator for DictKeyIterator<'_> { + fn next_back(&mut self) -> Option<Self::Item> { + self.items.next_back().map(DictItem::key) } } -/// See also [ImportFrom](https://docs.python.org/3/library/ast.html#ast.ImportFrom) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtImportFrom { - pub range: TextRange, - pub module: Option<Identifier>, - pub names: Vec<Alias>, - pub level: u32, -} - -impl From<StmtImportFrom> for Stmt { - fn from(payload: StmtImportFrom) -> Self { - Stmt::ImportFrom(payload) - } -} +impl FusedIterator for DictKeyIterator<'_> {} +impl ExactSizeIterator for DictKeyIterator<'_> {} -/// See also [Global](https://docs.python.org/3/library/ast.html#ast.Global) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtGlobal { - pub range: TextRange, - pub names: Vec<Identifier>, +#[derive(Debug, Clone)] +pub struct DictValueIterator<'a> { + items: Iter<'a, DictItem>, } -impl From<StmtGlobal> for Stmt { - fn from(payload: StmtGlobal) -> Self { - Stmt::Global(payload) +impl<'a> DictValueIterator<'a> { + fn new(items: &'a [DictItem]) -> Self { + Self { + items: items.iter(), + } } -} - -/// See also [Nonlocal](https://docs.python.org/3/library/ast.html#ast.Nonlocal) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtNonlocal { - pub range: TextRange, - pub names: Vec<Identifier>, -} -impl From<StmtNonlocal> for Stmt { - fn from(payload: StmtNonlocal) -> Self { - Stmt::Nonlocal(payload) + pub fn is_empty(&self) -> bool { + self.len() == 0 } } -/// See also [Expr](https://docs.python.org/3/library/ast.html#ast.Expr) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtExpr { - pub range: TextRange, - pub value: Box<Expr>, -} +impl<'a> Iterator for DictValueIterator<'a> { + type Item = &'a Expr; -impl From<StmtExpr> for Stmt { - fn from(payload: StmtExpr) -> Self { - Stmt::Expr(payload) + fn next(&mut self) -> Option<Self::Item> { + self.items.next().map(DictItem::value) } -} - -/// See also [Pass](https://docs.python.org/3/library/ast.html#ast.Pass) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtPass { - pub range: TextRange, -} -impl From<StmtPass> for Stmt { - fn from(payload: StmtPass) -> Self { - Stmt::Pass(payload) + fn last(mut self) -> Option<Self::Item> { + self.next_back() } -} -/// See also [Break](https://docs.python.org/3/library/ast.html#ast.Break) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtBreak { - pub range: TextRange, + fn size_hint(&self) -> (usize, Option<usize>) { + self.items.size_hint() + } } -impl From<StmtBreak> for Stmt { - fn from(payload: StmtBreak) -> Self { - Stmt::Break(payload) +impl DoubleEndedIterator for DictValueIterator<'_> { + fn next_back(&mut self) -> Option<Self::Item> { + self.items.next_back().map(DictItem::value) } } -/// See also [Continue](https://docs.python.org/3/library/ast.html#ast.Continue) -#[derive(Clone, Debug, PartialEq)] -pub struct StmtContinue { - pub range: TextRange, -} +impl FusedIterator for DictValueIterator<'_> {} +impl ExactSizeIterator for DictValueIterator<'_> {} -impl From<StmtContinue> for Stmt { - fn from(payload: StmtContinue) -> Self { - Stmt::Continue(payload) +impl ExprSet { + pub fn iter(&self) -> std::slice::Iter<'_, Expr> { + self.elts.iter() } -} - -/// See also [expr](https://docs.python.org/3/library/ast.html#ast.expr) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum Expr { - #[is(name = "bool_op_expr")] - BoolOp(ExprBoolOp), - #[is(name = "named_expr")] - Named(ExprNamed), - #[is(name = "bin_op_expr")] - BinOp(ExprBinOp), - #[is(name = "unary_op_expr")] - UnaryOp(ExprUnaryOp), - #[is(name = "lambda_expr")] - Lambda(ExprLambda), - #[is(name = "if_expr")] - If(ExprIf), - #[is(name = "dict_expr")] - Dict(ExprDict), - #[is(name = "set_expr")] - Set(ExprSet), - #[is(name = "list_comp_expr")] - ListComp(ExprListComp), - #[is(name = "set_comp_expr")] - SetComp(ExprSetComp), - #[is(name = "dict_comp_expr")] - DictComp(ExprDictComp), - #[is(name = "generator_expr")] - Generator(ExprGenerator), - #[is(name = "await_expr")] - Await(ExprAwait), - #[is(name = "yield_expr")] - Yield(ExprYield), - #[is(name = "yield_from_expr")] - YieldFrom(ExprYieldFrom), - #[is(name = "compare_expr")] - Compare(ExprCompare), - #[is(name = "call_expr")] - Call(ExprCall), - #[is(name = "f_string_expr")] - FString(ExprFString), - #[is(name = "string_literal_expr")] - StringLiteral(ExprStringLiteral), - #[is(name = "bytes_literal_expr")] - BytesLiteral(ExprBytesLiteral), - #[is(name = "number_literal_expr")] - NumberLiteral(ExprNumberLiteral), - #[is(name = "boolean_literal_expr")] - BooleanLiteral(ExprBooleanLiteral), - #[is(name = "none_literal_expr")] - NoneLiteral(ExprNoneLiteral), - #[is(name = "ellipsis_literal_expr")] - EllipsisLiteral(ExprEllipsisLiteral), - #[is(name = "attribute_expr")] - Attribute(ExprAttribute), - #[is(name = "subscript_expr")] - Subscript(ExprSubscript), - #[is(name = "starred_expr")] - Starred(ExprStarred), - #[is(name = "name_expr")] - Name(ExprName), - #[is(name = "list_expr")] - List(ExprList), - #[is(name = "tuple_expr")] - Tuple(ExprTuple), - #[is(name = "slice_expr")] - Slice(ExprSlice), - - // Jupyter notebook specific - #[is(name = "ipy_escape_command_expr")] - IpyEscapeCommand(ExprIpyEscapeCommand), -} -impl Expr { - /// Returns `true` if the expression is a literal expression. - /// - /// A literal expression is either a string literal, bytes literal, - /// integer, float, complex number, boolean, `None`, or ellipsis (`...`). - pub fn is_literal_expr(&self) -> bool { - matches!( - self, - Expr::StringLiteral(_) - | Expr::BytesLiteral(_) - | Expr::NumberLiteral(_) - | Expr::BooleanLiteral(_) - | Expr::NoneLiteral(_) - | Expr::EllipsisLiteral(_) - ) + pub fn len(&self) -> usize { + self.elts.len() } - /// Returns [`LiteralExpressionRef`] if the expression is a literal expression. - pub fn as_literal_expr(&self) -> Option<LiteralExpressionRef<'_>> { - match self { - Expr::StringLiteral(expr) => Some(LiteralExpressionRef::StringLiteral(expr)), - Expr::BytesLiteral(expr) => Some(LiteralExpressionRef::BytesLiteral(expr)), - Expr::NumberLiteral(expr) => Some(LiteralExpressionRef::NumberLiteral(expr)), - Expr::BooleanLiteral(expr) => Some(LiteralExpressionRef::BooleanLiteral(expr)), - Expr::NoneLiteral(expr) => Some(LiteralExpressionRef::NoneLiteral(expr)), - Expr::EllipsisLiteral(expr) => Some(LiteralExpressionRef::EllipsisLiteral(expr)), - _ => None, - } + pub fn is_empty(&self) -> bool { + self.elts.is_empty() } } -/// An AST node used to represent a IPython escape command at the expression level. -/// -/// For example, -/// ```python -/// dir = !pwd -/// ``` -/// -/// Here, the escape kind can only be `!` or `%` otherwise it is a syntax error. -/// -/// For more information related to terminology and syntax of escape commands, -/// see [`StmtIpyEscapeCommand`]. -#[derive(Clone, Debug, PartialEq)] -pub struct ExprIpyEscapeCommand { - pub range: TextRange, - pub kind: IpyEscapeKind, - pub value: Box<str>, -} +impl<'a> IntoIterator for &'a ExprSet { + type IntoIter = std::slice::Iter<'a, Expr>; + type Item = &'a Expr; -impl From<ExprIpyEscapeCommand> for Expr { - fn from(payload: ExprIpyEscapeCommand) -> Self { - Expr::IpyEscapeCommand(payload) + fn into_iter(self) -> Self::IntoIter { + self.iter() } } -/// See also [BoolOp](https://docs.python.org/3/library/ast.html#ast.BoolOp) #[derive(Clone, Debug, PartialEq)] -pub struct ExprBoolOp { +pub struct FStringFormatSpec { pub range: TextRange, - pub op: BoolOp, - pub values: Vec<Expr>, -} - -impl From<ExprBoolOp> for Expr { - fn from(payload: ExprBoolOp) -> Self { - Expr::BoolOp(payload) - } + pub elements: FStringElements, } -/// See also [NamedExpr](https://docs.python.org/3/library/ast.html#ast.NamedExpr) +/// See also [FormattedValue](https://docs.python.org/3/library/ast.html#ast.FormattedValue) #[derive(Clone, Debug, PartialEq)] -pub struct ExprNamed { +pub struct FStringExpressionElement { pub range: TextRange, - pub target: Box<Expr>, - pub value: Box<Expr>, -} - -impl From<ExprNamed> for Expr { - fn from(payload: ExprNamed) -> Self { - Expr::Named(payload) - } + pub expression: Box<Expr>, + pub debug_text: Option<DebugText>, + pub conversion: ConversionFlag, + pub format_spec: Option<Box<FStringFormatSpec>>, } -/// See also [BinOp](https://docs.python.org/3/library/ast.html#ast.BinOp) +/// An `FStringLiteralElement` with an empty `value` is an invalid f-string element. #[derive(Clone, Debug, PartialEq)] -pub struct ExprBinOp { +pub struct FStringLiteralElement { pub range: TextRange, - pub left: Box<Expr>, - pub op: Operator, - pub right: Box<Expr>, + pub value: Box<str>, } -impl From<ExprBinOp> for Expr { - fn from(payload: ExprBinOp) -> Self { - Expr::BinOp(payload) +impl FStringLiteralElement { + pub fn is_valid(&self) -> bool { + !self.value.is_empty() } } -/// See also [UnaryOp](https://docs.python.org/3/library/ast.html#ast.UnaryOp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprUnaryOp { - pub range: TextRange, - pub op: UnaryOp, - pub operand: Box<Expr>, -} +impl Deref for FStringLiteralElement { + type Target = str; -impl From<ExprUnaryOp> for Expr { - fn from(payload: ExprUnaryOp) -> Self { - Expr::UnaryOp(payload) + fn deref(&self) -> &Self::Target { + &self.value } } -/// See also [Lambda](https://docs.python.org/3/library/ast.html#ast.Lambda) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprLambda { - pub range: TextRange, - pub parameters: Option<Box<Parameters>>, - pub body: Box<Expr>, +/// Transforms a value prior to formatting it. +#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, is_macro::Is)] +#[repr(i8)] +#[expect(clippy::cast_possible_wrap)] +pub enum ConversionFlag { + /// No conversion + None = -1, // CPython uses -1 + /// Converts by calling `str(<value>)`. + Str = b's' as i8, + /// Converts by calling `ascii(<value>)`. + Ascii = b'a' as i8, + /// Converts by calling `repr(<value>)`. + Repr = b'r' as i8, } -impl From<ExprLambda> for Expr { - fn from(payload: ExprLambda) -> Self { - Expr::Lambda(payload) +impl ConversionFlag { + pub fn to_byte(&self) -> Option<u8> { + match self { + Self::None => None, + flag => Some(*flag as u8), + } + } + pub fn to_char(&self) -> Option<char> { + Some(self.to_byte()? as char) } } -/// See also [IfExp](https://docs.python.org/3/library/ast.html#ast.IfExp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprIf { - pub range: TextRange, - pub test: Box<Expr>, - pub body: Box<Expr>, - pub orelse: Box<Expr>, +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub struct DebugText { + /// The text between the `{` and the expression node. + pub leading: String, + /// The text between the expression and the conversion, the `format_spec`, or the `}`, depending on what's present in the source + pub trailing: String, } -impl From<ExprIf> for Expr { - fn from(payload: ExprIf) -> Self { - Expr::If(payload) +impl ExprFString { + /// Returns the single [`FString`] if the f-string isn't implicitly concatenated, [`None`] + /// otherwise. + pub const fn as_single_part_fstring(&self) -> Option<&FString> { + match &self.value.inner { + FStringValueInner::Single(FStringPart::FString(fstring)) => Some(fstring), + _ => None, + } } } -/// Represents an item in a [dictionary literal display][1]. -/// -/// Consider the following Python dictionary literal: -/// ```python -/// {key1: value1, **other_dictionary} -/// ``` -/// -/// In our AST, this would be represented using an `ExprDict` node containing -/// two `DictItem` nodes inside it: -/// ```ignore -/// [ -/// DictItem { -/// key: Some(Expr::Name(ExprName { id: "key1" })), -/// value: Expr::Name(ExprName { id: "value1" }), -/// }, -/// DictItem { -/// key: None, -/// value: Expr::Name(ExprName { id: "other_dictionary" }), -/// } -/// ] -/// ``` -/// -/// [1]: https://docs.python.org/3/reference/expressions.html#displays-for-lists-sets-and-dictionaries -#[derive(Debug, Clone, PartialEq)] -pub struct DictItem { - pub key: Option<Expr>, - pub value: Expr, +/// The value representing an [`ExprFString`]. +#[derive(Clone, Debug, PartialEq)] +pub struct FStringValue { + inner: FStringValueInner, } -impl DictItem { - fn key(&self) -> Option<&Expr> { - self.key.as_ref() +impl FStringValue { + /// Creates a new f-string literal with a single [`FString`] part. + pub fn single(value: FString) -> Self { + Self { + inner: FStringValueInner::Single(FStringPart::FString(value)), + } } - fn value(&self) -> &Expr { - &self.value + /// Creates a new f-string with the given values that represents an implicitly + /// concatenated f-string. + /// + /// # Panics + /// + /// Panics if `values` has less than 2 elements. + /// Use [`FStringValue::single`] instead. + pub fn concatenated(values: Vec<FStringPart>) -> Self { + assert!( + values.len() > 1, + "Use `FStringValue::single` to create single-part f-strings" + ); + Self { + inner: FStringValueInner::Concatenated(values), + } } -} -impl Ranged for DictItem { - fn range(&self) -> TextRange { - TextRange::new( - self.key.as_ref().map_or(self.value.start(), Ranged::start), - self.value.end(), - ) + /// Returns `true` if the f-string is implicitly concatenated, `false` otherwise. + pub fn is_implicit_concatenated(&self) -> bool { + matches!(self.inner, FStringValueInner::Concatenated(_)) } -} -/// See also [Dict](https://docs.python.org/3/library/ast.html#ast.Dict) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprDict { - pub range: TextRange, - pub items: Vec<DictItem>, -} + /// Returns a slice of all the [`FStringPart`]s contained in this value. + pub fn as_slice(&self) -> &[FStringPart] { + match &self.inner { + FStringValueInner::Single(part) => std::slice::from_ref(part), + FStringValueInner::Concatenated(parts) => parts, + } + } -impl ExprDict { - /// Returns an `Iterator` over the AST nodes representing the - /// dictionary's keys. - pub fn iter_keys(&self) -> DictKeyIterator { - DictKeyIterator::new(&self.items) + /// Returns a mutable slice of all the [`FStringPart`]s contained in this value. + fn as_mut_slice(&mut self) -> &mut [FStringPart] { + match &mut self.inner { + FStringValueInner::Single(part) => std::slice::from_mut(part), + FStringValueInner::Concatenated(parts) => parts, + } } - /// Returns an `Iterator` over the AST nodes representing the - /// dictionary's values. - pub fn iter_values(&self) -> DictValueIterator { - DictValueIterator::new(&self.items) + /// Returns an iterator over all the [`FStringPart`]s contained in this value. + pub fn iter(&self) -> Iter<FStringPart> { + self.as_slice().iter() } - /// Returns the AST node representing the *n*th key of this - /// dictionary. - /// - /// Panics: If the index `n` is out of bounds. - pub fn key(&self, n: usize) -> Option<&Expr> { - self.items[n].key() + /// Returns an iterator over all the [`FStringPart`]s contained in this value + /// that allows modification. + pub fn iter_mut(&mut self) -> IterMut<FStringPart> { + self.as_mut_slice().iter_mut() } - /// Returns the AST node representing the *n*th value of this - /// dictionary. + /// Returns an iterator over the [`StringLiteral`] parts contained in this value. /// - /// Panics: If the index `n` is out of bounds. - pub fn value(&self, n: usize) -> &Expr { - self.items[n].value() - } - - pub fn iter(&self) -> std::slice::Iter<'_, DictItem> { - self.items.iter() + /// Note that this doesn't recurse into the f-string parts. For example, + /// + /// ```python + /// "foo" f"bar {x}" "baz" f"qux" + /// ``` + /// + /// Here, the string literal parts returned would be `"foo"` and `"baz"`. + pub fn literals(&self) -> impl Iterator<Item = &StringLiteral> { + self.iter().filter_map(|part| part.as_literal()) } - pub fn len(&self) -> usize { - self.items.len() + /// Returns an iterator over the [`FString`] parts contained in this value. + /// + /// Note that this doesn't recurse into the f-string parts. For example, + /// + /// ```python + /// "foo" f"bar {x}" "baz" f"qux" + /// ``` + /// + /// Here, the f-string parts returned would be `f"bar {x}"` and `f"qux"`. + pub fn f_strings(&self) -> impl Iterator<Item = &FString> { + self.iter().filter_map(|part| part.as_f_string()) } - pub fn is_empty(&self) -> bool { - self.items.is_empty() + /// Returns an iterator over all the [`FStringElement`] contained in this value. + /// + /// An f-string element is what makes up an [`FString`] i.e., it is either a + /// string literal or an expression. In the following example, + /// + /// ```python + /// "foo" f"bar {x}" "baz" f"qux" + /// ``` + /// + /// The f-string elements returned would be string literal (`"bar "`), + /// expression (`x`) and string literal (`"qux"`). + pub fn elements(&self) -> impl Iterator<Item = &FStringElement> { + self.f_strings().flat_map(|fstring| fstring.elements.iter()) } } -impl<'a> IntoIterator for &'a ExprDict { - type IntoIter = std::slice::Iter<'a, DictItem>; - type Item = &'a DictItem; +impl<'a> IntoIterator for &'a FStringValue { + type Item = &'a FStringPart; + type IntoIter = Iter<'a, FStringPart>; fn into_iter(self) -> Self::IntoIter { self.iter() } } -impl From<ExprDict> for Expr { - fn from(payload: ExprDict) -> Self { - Expr::Dict(payload) +impl<'a> IntoIterator for &'a mut FStringValue { + type Item = &'a mut FStringPart; + type IntoIter = IterMut<'a, FStringPart>; + fn into_iter(self) -> Self::IntoIter { + self.iter_mut() } } -#[derive(Debug, Clone)] -pub struct DictKeyIterator<'a> { - items: Iter<'a, DictItem>, -} - -impl<'a> DictKeyIterator<'a> { - fn new(items: &'a [DictItem]) -> Self { - Self { - items: items.iter(), - } - } +/// An internal representation of [`FStringValue`]. +#[derive(Clone, Debug, PartialEq)] +enum FStringValueInner { + /// A single f-string i.e., `f"foo"`. + /// + /// This is always going to be `FStringPart::FString` variant which is + /// maintained by the `FStringValue::single` constructor. + Single(FStringPart), - pub fn is_empty(&self) -> bool { - self.len() == 0 - } + /// An implicitly concatenated f-string i.e., `"foo" f"bar {x}"`. + Concatenated(Vec<FStringPart>), } -impl<'a> Iterator for DictKeyIterator<'a> { - type Item = Option<&'a Expr>; - - fn next(&mut self) -> Option<Self::Item> { - self.items.next().map(DictItem::key) - } - - fn last(mut self) -> Option<Self::Item> { - self.next_back() - } - - fn size_hint(&self) -> (usize, Option<usize>) { - self.items.size_hint() - } +/// An f-string part which is either a string literal or an f-string. +#[derive(Clone, Debug, PartialEq, is_macro::Is)] +pub enum FStringPart { + Literal(StringLiteral), + FString(FString), } -impl<'a> DoubleEndedIterator for DictKeyIterator<'a> { - fn next_back(&mut self) -> Option<Self::Item> { - self.items.next_back().map(DictItem::key) +impl FStringPart { + pub fn quote_style(&self) -> Quote { + match self { + Self::Literal(string_literal) => string_literal.flags.quote_style(), + Self::FString(f_string) => f_string.flags.quote_style(), + } } } -impl<'a> FusedIterator for DictKeyIterator<'a> {} -impl<'a> ExactSizeIterator for DictKeyIterator<'a> {} - -#[derive(Debug, Clone)] -pub struct DictValueIterator<'a> { - items: Iter<'a, DictItem>, -} - -impl<'a> DictValueIterator<'a> { - fn new(items: &'a [DictItem]) -> Self { - Self { - items: items.iter(), +impl Ranged for FStringPart { + fn range(&self) -> TextRange { + match self { + FStringPart::Literal(string_literal) => string_literal.range(), + FStringPart::FString(f_string) => f_string.range(), } } - - pub fn is_empty(&self) -> bool { - self.len() == 0 - } } -impl<'a> Iterator for DictValueIterator<'a> { - type Item = &'a Expr; +pub trait StringFlags: Copy { + /// Does the string use single or double quotes in its opener and closer? + fn quote_style(self) -> Quote; - fn next(&mut self) -> Option<Self::Item> { - self.items.next().map(DictItem::value) - } + fn triple_quotes(self) -> TripleQuotes; - fn last(mut self) -> Option<Self::Item> { - self.next_back() - } + fn prefix(self) -> AnyStringPrefix; - fn size_hint(&self) -> (usize, Option<usize>) { - self.items.size_hint() + /// Is the string triple-quoted, i.e., + /// does it begin and end with three consecutive quote characters? + fn is_triple_quoted(self) -> bool { + self.triple_quotes().is_yes() } -} -impl<'a> DoubleEndedIterator for DictValueIterator<'a> { - fn next_back(&mut self) -> Option<Self::Item> { - self.items.next_back().map(DictItem::value) + /// A `str` representation of the quotes used to start and close. + /// This does not include any prefixes the string has in its opener. + fn quote_str(self) -> &'static str { + match (self.triple_quotes(), self.quote_style()) { + (TripleQuotes::Yes, Quote::Single) => "'''", + (TripleQuotes::Yes, Quote::Double) => r#"""""#, + (TripleQuotes::No, Quote::Single) => "'", + (TripleQuotes::No, Quote::Double) => "\"", + } } -} - -impl<'a> FusedIterator for DictValueIterator<'a> {} -impl<'a> ExactSizeIterator for DictValueIterator<'a> {} - -/// See also [Set](https://docs.python.org/3/library/ast.html#ast.Set) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprSet { - pub range: TextRange, - pub elts: Vec<Expr>, -} -impl ExprSet { - pub fn iter(&self) -> std::slice::Iter<'_, Expr> { - self.elts.iter() + /// The length of the quotes used to start and close the string. + /// This does not include the length of any prefixes the string has + /// in its opener. + fn quote_len(self) -> TextSize { + if self.is_triple_quoted() { + TextSize::new(3) + } else { + TextSize::new(1) + } } - pub fn len(&self) -> usize { - self.elts.len() + /// The total length of the string's opener, + /// i.e., the length of the prefixes plus the length + /// of the quotes used to open the string. + fn opener_len(self) -> TextSize { + self.prefix().text_len() + self.quote_len() } - pub fn is_empty(&self) -> bool { - self.elts.is_empty() + /// The total length of the string's closer. + /// This is always equal to `self.quote_len()`, + /// but is provided here for symmetry with the `opener_len()` method. + fn closer_len(self) -> TextSize { + self.quote_len() } -} -impl<'a> IntoIterator for &'a ExprSet { - type IntoIter = std::slice::Iter<'a, Expr>; - type Item = &'a Expr; - - fn into_iter(self) -> Self::IntoIter { - self.iter() + fn as_any_string_flags(self) -> AnyStringFlags { + AnyStringFlags::new(self.prefix(), self.quote_style(), self.triple_quotes()) } -} -impl From<ExprSet> for Expr { - fn from(payload: ExprSet) -> Self { - Expr::Set(payload) + fn display_contents(self, contents: &str) -> DisplayFlags { + DisplayFlags { + flags: self.as_any_string_flags(), + contents, + } } } -/// See also [ListComp](https://docs.python.org/3/library/ast.html#ast.ListComp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprListComp { - pub range: TextRange, - pub elt: Box<Expr>, - pub generators: Vec<Comprehension>, +pub struct DisplayFlags<'a> { + flags: AnyStringFlags, + contents: &'a str, } -impl From<ExprListComp> for Expr { - fn from(payload: ExprListComp) -> Self { - Expr::ListComp(payload) +impl std::fmt::Display for DisplayFlags<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!( + f, + "{prefix}{quote}{contents}{quote}", + prefix = self.flags.prefix(), + quote = self.flags.quote_str(), + contents = self.contents + ) } } -/// See also [SetComp](https://docs.python.org/3/library/ast.html#ast.SetComp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprSetComp { - pub range: TextRange, - pub elt: Box<Expr>, - pub generators: Vec<Comprehension>, -} +bitflags! { + #[derive(Default, Copy, Clone, PartialEq, Eq, Hash)] + struct FStringFlagsInner: u8 { + /// The f-string uses double quotes (`"`) for its opener and closer. + /// If this flag is not set, the f-string uses single quotes (`'`) + /// for its opener and closer. + const DOUBLE = 1 << 0; -impl From<ExprSetComp> for Expr { - fn from(payload: ExprSetComp) -> Self { - Expr::SetComp(payload) - } -} + /// The f-string is triple-quoted: + /// it begins and ends with three consecutive quote characters. + /// For example: `f"""{bar}"""`. + const TRIPLE_QUOTED = 1 << 1; -/// See also [DictComp](https://docs.python.org/3/library/ast.html#ast.DictComp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprDictComp { - pub range: TextRange, - pub key: Box<Expr>, - pub value: Box<Expr>, - pub generators: Vec<Comprehension>, -} + /// The f-string has an `r` prefix, meaning it is a raw f-string + /// with a lowercase 'r'. For example: `rf"{bar}"` + const R_PREFIX_LOWER = 1 << 2; -impl From<ExprDictComp> for Expr { - fn from(payload: ExprDictComp) -> Self { - Expr::DictComp(payload) + /// The f-string has an `R` prefix, meaning it is a raw f-string + /// with an uppercase 'r'. For example: `Rf"{bar}"`. + /// See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings + /// for why we track the casing of the `r` prefix, + /// but not for any other prefix + const R_PREFIX_UPPER = 1 << 3; } } -/// See also [GeneratorExp](https://docs.python.org/3/library/ast.html#ast.GeneratorExp) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprGenerator { - pub range: TextRange, - pub elt: Box<Expr>, - pub generators: Vec<Comprehension>, - pub parenthesized: bool, -} +/// Flags that can be queried to obtain information +/// regarding the prefixes and quotes used for an f-string. +/// +/// ## Notes on usage +/// +/// If you're using a `Generator` from the `ruff_python_codegen` crate to generate a lint-rule fix +/// from an existing f-string literal, consider passing along the [`FString::flags`] field. If you +/// don't have an existing literal but have a `Checker` from the `ruff_linter` crate available, +/// consider using `Checker::default_fstring_flags` to create instances of this struct; this method +/// will properly handle nested f-strings. For usage that doesn't fit into one of these categories, +/// the public constructor [`FStringFlags::empty`] can be used. +#[derive(Copy, Clone, Eq, PartialEq, Hash)] +pub struct FStringFlags(FStringFlagsInner); -impl From<ExprGenerator> for Expr { - fn from(payload: ExprGenerator) -> Self { - Expr::Generator(payload) +impl FStringFlags { + /// Construct a new [`FStringFlags`] with **no flags set**. + /// + /// See [`FStringFlags::with_quote_style`], [`FStringFlags::with_triple_quotes`], and + /// [`FStringFlags::with_prefix`] for ways of setting the quote style (single or double), + /// enabling triple quotes, and adding prefixes (such as `r`), respectively. + /// + /// See the documentation for [`FStringFlags`] for additional caveats on this constructor, and + /// situations in which alternative ways to construct this struct should be used, especially + /// when writing lint rules. + pub fn empty() -> Self { + Self(FStringFlagsInner::empty()) } -} - -/// See also [Await](https://docs.python.org/3/library/ast.html#ast.Await) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprAwait { - pub range: TextRange, - pub value: Box<Expr>, -} -impl From<ExprAwait> for Expr { - fn from(payload: ExprAwait) -> Self { - Expr::Await(payload) + #[must_use] + pub fn with_quote_style(mut self, quote_style: Quote) -> Self { + self.0 + .set(FStringFlagsInner::DOUBLE, quote_style.is_double()); + self } -} -/// See also [Yield](https://docs.python.org/3/library/ast.html#ast.Yield) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprYield { - pub range: TextRange, - pub value: Option<Box<Expr>>, -} - -impl From<ExprYield> for Expr { - fn from(payload: ExprYield) -> Self { - Expr::Yield(payload) + #[must_use] + pub fn with_triple_quotes(mut self, triple_quotes: TripleQuotes) -> Self { + self.0 + .set(FStringFlagsInner::TRIPLE_QUOTED, triple_quotes.is_yes()); + self } -} -/// See also [YieldFrom](https://docs.python.org/3/library/ast.html#ast.YieldFrom) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprYieldFrom { - pub range: TextRange, - pub value: Box<Expr>, -} + #[must_use] + pub fn with_prefix(mut self, prefix: FStringPrefix) -> Self { + match prefix { + FStringPrefix::Regular => { + Self(self.0 - FStringFlagsInner::R_PREFIX_LOWER - FStringFlagsInner::R_PREFIX_UPPER) + } + FStringPrefix::Raw { uppercase_r } => { + self.0.set(FStringFlagsInner::R_PREFIX_UPPER, uppercase_r); + self.0.set(FStringFlagsInner::R_PREFIX_LOWER, !uppercase_r); + self + } + } + } -impl From<ExprYieldFrom> for Expr { - fn from(payload: ExprYieldFrom) -> Self { - Expr::YieldFrom(payload) + pub const fn prefix(self) -> FStringPrefix { + if self.0.contains(FStringFlagsInner::R_PREFIX_LOWER) { + debug_assert!(!self.0.contains(FStringFlagsInner::R_PREFIX_UPPER)); + FStringPrefix::Raw { uppercase_r: false } + } else if self.0.contains(FStringFlagsInner::R_PREFIX_UPPER) { + FStringPrefix::Raw { uppercase_r: true } + } else { + FStringPrefix::Regular + } } } -/// See also [Compare](https://docs.python.org/3/library/ast.html#ast.Compare) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprCompare { - pub range: TextRange, - pub left: Box<Expr>, - pub ops: Box<[CmpOp]>, - pub comparators: Box<[Expr]>, -} +impl StringFlags for FStringFlags { + /// Return `true` if the f-string is triple-quoted, i.e., + /// it begins and ends with three consecutive quote characters. + /// For example: `f"""{bar}"""` + fn triple_quotes(self) -> TripleQuotes { + if self.0.contains(FStringFlagsInner::TRIPLE_QUOTED) { + TripleQuotes::Yes + } else { + TripleQuotes::No + } + } -impl From<ExprCompare> for Expr { - fn from(payload: ExprCompare) -> Self { - Expr::Compare(payload) + /// Return the quoting style (single or double quotes) + /// used by the f-string's opener and closer: + /// - `f"{"a"}"` -> `QuoteStyle::Double` + /// - `f'{"a"}'` -> `QuoteStyle::Single` + fn quote_style(self) -> Quote { + if self.0.contains(FStringFlagsInner::DOUBLE) { + Quote::Double + } else { + Quote::Single + } } -} -/// See also [Call](https://docs.python.org/3/library/ast.html#ast.Call) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprCall { - pub range: TextRange, - pub func: Box<Expr>, - pub arguments: Arguments, + fn prefix(self) -> AnyStringPrefix { + AnyStringPrefix::Format(self.prefix()) + } } -impl From<ExprCall> for Expr { - fn from(payload: ExprCall) -> Self { - Expr::Call(payload) +impl fmt::Debug for FStringFlags { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("FStringFlags") + .field("quote_style", &self.quote_style()) + .field("prefix", &self.prefix()) + .field("triple_quoted", &self.is_triple_quoted()) + .finish() } } +/// An AST node that represents a single f-string which is part of an [`ExprFString`]. #[derive(Clone, Debug, PartialEq)] -pub struct FStringFormatSpec { +pub struct FString { pub range: TextRange, pub elements: FStringElements, + pub flags: FStringFlags, } -impl Ranged for FStringFormatSpec { - fn range(&self) -> TextRange { - self.range +impl From<FString> for Expr { + fn from(payload: FString) -> Self { + ExprFString { + range: payload.range, + value: FStringValue::single(payload), + } + .into() } } -/// See also [FormattedValue](https://docs.python.org/3/library/ast.html#ast.FormattedValue) -#[derive(Clone, Debug, PartialEq)] -pub struct FStringExpressionElement { - pub range: TextRange, - pub expression: Box<Expr>, - pub debug_text: Option<DebugText>, - pub conversion: ConversionFlag, - pub format_spec: Option<Box<FStringFormatSpec>>, -} +/// A newtype wrapper around a list of [`FStringElement`]. +#[derive(Clone, Default, PartialEq)] +pub struct FStringElements(Vec<FStringElement>); -impl Ranged for FStringExpressionElement { - fn range(&self) -> TextRange { - self.range +impl FStringElements { + /// Returns an iterator over all the [`FStringLiteralElement`] nodes contained in this f-string. + pub fn literals(&self) -> impl Iterator<Item = &FStringLiteralElement> { + self.iter().filter_map(|element| element.as_literal()) } -} -/// An `FStringLiteralElement` with an empty `value` is an invalid f-string element. -#[derive(Clone, Debug, PartialEq)] -pub struct FStringLiteralElement { - pub range: TextRange, - pub value: Box<str>, + /// Returns an iterator over all the [`FStringExpressionElement`] nodes contained in this f-string. + pub fn expressions(&self) -> impl Iterator<Item = &FStringExpressionElement> { + self.iter().filter_map(|element| element.as_expression()) + } } -impl FStringLiteralElement { - pub fn is_valid(&self) -> bool { - !self.value.is_empty() +impl From<Vec<FStringElement>> for FStringElements { + fn from(elements: Vec<FStringElement>) -> Self { + FStringElements(elements) } } -impl Ranged for FStringLiteralElement { - fn range(&self) -> TextRange { - self.range +impl<'a> IntoIterator for &'a FStringElements { + type IntoIter = Iter<'a, FStringElement>; + type Item = &'a FStringElement; + + fn into_iter(self) -> Self::IntoIter { + self.iter() } } -impl Deref for FStringLiteralElement { - type Target = str; +impl<'a> IntoIterator for &'a mut FStringElements { + type IntoIter = IterMut<'a, FStringElement>; + type Item = &'a mut FStringElement; - fn deref(&self) -> &Self::Target { - &self.value + fn into_iter(self) -> Self::IntoIter { + self.iter_mut() } } -/// Transforms a value prior to formatting it. -#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, is_macro::Is)] -#[repr(i8)] -#[allow(clippy::cast_possible_wrap)] -pub enum ConversionFlag { - /// No conversion - None = -1, // CPython uses -1 - /// Converts by calling `str(<value>)`. - Str = b's' as i8, - /// Converts by calling `ascii(<value>)`. - Ascii = b'a' as i8, - /// Converts by calling `repr(<value>)`. - Repr = b'r' as i8, -} +impl Deref for FStringElements { + type Target = [FStringElement]; -impl ConversionFlag { - pub fn to_byte(&self) -> Option<u8> { - match self { - Self::None => None, - flag => Some(*flag as u8), - } - } - pub fn to_char(&self) -> Option<char> { - Some(self.to_byte()? as char) + fn deref(&self) -> &Self::Target { + &self.0 } } -#[derive(Clone, Debug, PartialEq, Eq, Hash)] -pub struct DebugText { - /// The text between the `{` and the expression node. - pub leading: String, - /// The text between the expression and the conversion, the `format_spec`, or the `}`, depending on what's present in the source - pub trailing: String, +impl DerefMut for FStringElements { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } } -/// An AST node used to represent an f-string. -/// -/// This type differs from the original Python AST ([JoinedStr]) in that it -/// doesn't join the implicitly concatenated parts into a single string. Instead, -/// it keeps them separate and provide various methods to access the parts. -/// -/// [JoinedStr]: https://docs.python.org/3/library/ast.html#ast.JoinedStr -#[derive(Clone, Debug, PartialEq)] -pub struct ExprFString { - pub range: TextRange, - pub value: FStringValue, +impl fmt::Debug for FStringElements { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt::Debug::fmt(&self.0, f) + } } -impl From<ExprFString> for Expr { - fn from(payload: ExprFString) -> Self { - Expr::FString(payload) +impl ExprStringLiteral { + /// Return `Some(literal)` if the string only consists of a single `StringLiteral` part + /// (indicating that it is not implicitly concatenated). Otherwise, return `None`. + pub fn as_single_part_string(&self) -> Option<&StringLiteral> { + match &self.value.inner { + StringLiteralValueInner::Single(value) => Some(value), + StringLiteralValueInner::Concatenated(_) => None, + } } } -/// The value representing an [`ExprFString`]. +/// The value representing a [`ExprStringLiteral`]. #[derive(Clone, Debug, PartialEq)] -pub struct FStringValue { - inner: FStringValueInner, +pub struct StringLiteralValue { + inner: StringLiteralValueInner, } -impl FStringValue { - /// Creates a new f-string with the given value. - pub fn single(value: FString) -> Self { +impl StringLiteralValue { + /// Creates a new string literal with a single [`StringLiteral`] part. + pub fn single(string: StringLiteral) -> Self { Self { - inner: FStringValueInner::Single(FStringPart::FString(value)), + inner: StringLiteralValueInner::Single(string), } } - /// Creates a new f-string with the given values that represents an implicitly - /// concatenated f-string. + /// Returns the [`StringLiteralFlags`] associated with this string literal. + /// + /// For an implicitly concatenated string, it returns the flags for the first literal. + pub fn first_literal_flags(&self) -> StringLiteralFlags { + self.iter() + .next() + .expect( + "There should always be at least one string literal in an `ExprStringLiteral` node", + ) + .flags + } + + /// Creates a new string literal with the given values that represents an + /// implicitly concatenated strings. /// /// # Panics /// - /// Panics if `values` is less than 2. Use [`FStringValue::single`] instead. - pub fn concatenated(values: Vec<FStringPart>) -> Self { - assert!(values.len() > 1); + /// Panics if `strings` has less than 2 elements. + /// Use [`StringLiteralValue::single`] instead. + pub fn concatenated(strings: Vec<StringLiteral>) -> Self { + assert!( + strings.len() > 1, + "Use `StringLiteralValue::single` to create single-part strings" + ); Self { - inner: FStringValueInner::Concatenated(values), + inner: StringLiteralValueInner::Concatenated(ConcatenatedStringLiteral { + strings, + value: OnceLock::new(), + }), } } - /// Returns `true` if the f-string is implicitly concatenated, `false` otherwise. - pub fn is_implicit_concatenated(&self) -> bool { - matches!(self.inner, FStringValueInner::Concatenated(_)) + /// Returns `true` if the string literal is implicitly concatenated. + pub const fn is_implicit_concatenated(&self) -> bool { + matches!(self.inner, StringLiteralValueInner::Concatenated(_)) } - /// Returns a slice of all the [`FStringPart`]s contained in this value. - pub fn as_slice(&self) -> &[FStringPart] { + /// Returns `true` if the string literal has a `u` prefix, e.g. `u"foo"`. + /// + /// Although all strings in Python 3 are valid unicode (and the `u` prefix + /// is only retained for backwards compatibility), these strings are known as + /// "unicode strings". + /// + /// For an implicitly concatenated string, it returns `true` only if the first + /// [`StringLiteral`] has the `u` prefix. + pub fn is_unicode(&self) -> bool { + self.iter() + .next() + .is_some_and(|part| part.flags.prefix().is_unicode()) + } + + /// Returns a slice of all the [`StringLiteral`] parts contained in this value. + pub fn as_slice(&self) -> &[StringLiteral] { match &self.inner { - FStringValueInner::Single(part) => std::slice::from_ref(part), - FStringValueInner::Concatenated(parts) => parts, + StringLiteralValueInner::Single(value) => std::slice::from_ref(value), + StringLiteralValueInner::Concatenated(value) => value.strings.as_slice(), } } - /// Returns a mutable slice of all the [`FStringPart`]s contained in this value. - fn as_mut_slice(&mut self) -> &mut [FStringPart] { + /// Returns a mutable slice of all the [`StringLiteral`] parts contained in this value. + fn as_mut_slice(&mut self) -> &mut [StringLiteral] { match &mut self.inner { - FStringValueInner::Single(part) => std::slice::from_mut(part), - FStringValueInner::Concatenated(parts) => parts, + StringLiteralValueInner::Single(value) => std::slice::from_mut(value), + StringLiteralValueInner::Concatenated(value) => value.strings.as_mut_slice(), } } - /// Returns an iterator over all the [`FStringPart`]s contained in this value. - pub fn iter(&self) -> Iter<FStringPart> { + /// Returns an iterator over all the [`StringLiteral`] parts contained in this value. + pub fn iter(&self) -> Iter<StringLiteral> { self.as_slice().iter() } - /// Returns an iterator over all the [`FStringPart`]s contained in this value + /// Returns an iterator over all the [`StringLiteral`] parts contained in this value /// that allows modification. - pub fn iter_mut(&mut self) -> IterMut<FStringPart> { + pub fn iter_mut(&mut self) -> IterMut<StringLiteral> { self.as_mut_slice().iter_mut() } - /// Returns an iterator over the [`StringLiteral`] parts contained in this value. - /// - /// Note that this doesn't nest into the f-string parts. For example, - /// - /// ```python - /// "foo" f"bar {x}" "baz" f"qux" - /// ``` + /// Returns `true` if the node represents an empty string. /// - /// Here, the string literal parts returned would be `"foo"` and `"baz"`. - pub fn literals(&self) -> impl Iterator<Item = &StringLiteral> { - self.iter().filter_map(|part| part.as_literal()) + /// Note that a [`StringLiteralValue`] node will always have >=1 [`StringLiteral`] parts + /// inside it. This method checks whether the value of the concatenated parts is equal + /// to the empty string, not whether the string has 0 parts inside it. + pub fn is_empty(&self) -> bool { + self.len() == 0 } - /// Returns an iterator over the [`FString`] parts contained in this value. - /// - /// Note that this doesn't nest into the f-string parts. For example, - /// - /// ```python - /// "foo" f"bar {x}" "baz" f"qux" - /// ``` - /// - /// Here, the f-string parts returned would be `f"bar {x}"` and `f"qux"`. - pub fn f_strings(&self) -> impl Iterator<Item = &FString> { - self.iter().filter_map(|part| part.as_f_string()) + /// Returns the total length of the string literal value, in bytes, not + /// [`char`]s or graphemes. + pub fn len(&self) -> usize { + self.iter().fold(0, |acc, part| acc + part.value.len()) } - /// Returns an iterator over all the [`FStringElement`] contained in this value. - /// - /// An f-string element is what makes up an [`FString`] i.e., it is either a - /// string literal or an expression. In the following example, - /// - /// ```python - /// "foo" f"bar {x}" "baz" f"qux" - /// ``` + /// Returns an iterator over the [`char`]s of each string literal part. + pub fn chars(&self) -> impl Iterator<Item = char> + Clone + '_ { + self.iter().flat_map(|part| part.value.chars()) + } + + /// Returns the concatenated string value as a [`str`]. /// - /// The f-string elements returned would be string literal (`"bar "`), - /// expression (`x`) and string literal (`"qux"`). - pub fn elements(&self) -> impl Iterator<Item = &FStringElement> { - self.f_strings().flat_map(|fstring| fstring.elements.iter()) + /// Note that this will perform an allocation on the first invocation if the + /// string value is implicitly concatenated. + pub fn to_str(&self) -> &str { + match &self.inner { + StringLiteralValueInner::Single(value) => value.as_str(), + StringLiteralValueInner::Concatenated(value) => value.to_str(), + } } } -impl<'a> IntoIterator for &'a FStringValue { - type Item = &'a FStringPart; - type IntoIter = Iter<'a, FStringPart>; +impl<'a> IntoIterator for &'a StringLiteralValue { + type Item = &'a StringLiteral; + type IntoIter = Iter<'a, StringLiteral>; fn into_iter(self) -> Self::IntoIter { self.iter() } } -impl<'a> IntoIterator for &'a mut FStringValue { - type Item = &'a mut FStringPart; - type IntoIter = IterMut<'a, FStringPart>; +impl<'a> IntoIterator for &'a mut StringLiteralValue { + type Item = &'a mut StringLiteral; + type IntoIter = IterMut<'a, StringLiteral>; fn into_iter(self) -> Self::IntoIter { self.iter_mut() } } -/// An internal representation of [`FStringValue`]. -#[derive(Clone, Debug, PartialEq)] -enum FStringValueInner { - /// A single f-string i.e., `f"foo"`. - /// - /// This is always going to be `FStringPart::FString` variant which is - /// maintained by the `FStringValue::single` constructor. - Single(FStringPart), - - /// An implicitly concatenated f-string i.e., `"foo" f"bar {x}"`. - Concatenated(Vec<FStringPart>), -} - -/// An f-string part which is either a string literal or an f-string. -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum FStringPart { - Literal(StringLiteral), - FString(FString), -} - -impl FStringPart { - pub fn quote_style(&self) -> Quote { - match self { - Self::Literal(string_literal) => string_literal.flags.quote_style(), - Self::FString(f_string) => f_string.flags.quote_style(), +impl PartialEq<str> for StringLiteralValue { + fn eq(&self, other: &str) -> bool { + if self.len() != other.len() { + return false; } + // The `zip` here is safe because we have checked the length of both parts. + self.chars().zip(other.chars()).all(|(c1, c2)| c1 == c2) } } -impl Ranged for FStringPart { - fn range(&self) -> TextRange { - match self { - FStringPart::Literal(string_literal) => string_literal.range(), - FStringPart::FString(f_string) => f_string.range(), - } +impl fmt::Display for StringLiteralValue { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.to_str()) } } -pub trait StringFlags: Copy { - /// Does the string use single or double quotes in its opener and closer? - fn quote_style(self) -> Quote; - - /// Is the string triple-quoted, i.e., - /// does it begin and end with three consecutive quote characters? - fn is_triple_quoted(self) -> bool; - - fn prefix(self) -> AnyStringPrefix; - - /// A `str` representation of the quotes used to start and close. - /// This does not include any prefixes the string has in its opener. - fn quote_str(self) -> &'static str { - if self.is_triple_quoted() { - match self.quote_style() { - Quote::Single => "'''", - Quote::Double => r#"""""#, - } - } else { - match self.quote_style() { - Quote::Single => "'", - Quote::Double => "\"", - } - } - } - - /// The length of the quotes used to start and close the string. - /// This does not include the length of any prefixes the string has - /// in its opener. - fn quote_len(self) -> TextSize { - if self.is_triple_quoted() { - TextSize::new(3) - } else { - TextSize::new(1) - } - } - - /// The total length of the string's opener, - /// i.e., the length of the prefixes plus the length - /// of the quotes used to open the string. - fn opener_len(self) -> TextSize { - self.prefix().as_str().text_len() + self.quote_len() - } - - /// The total length of the string's closer. - /// This is always equal to `self.quote_len()`, - /// but is provided here for symmetry with the `opener_len()` method. - fn closer_len(self) -> TextSize { - self.quote_len() - } +/// An internal representation of [`StringLiteralValue`]. +#[derive(Clone, Debug, PartialEq)] +enum StringLiteralValueInner { + /// A single string literal i.e., `"foo"`. + Single(StringLiteral), - fn format_string_contents(self, contents: &str) -> String { - let prefix = self.prefix(); - let quote_str = self.quote_str(); - format!("{prefix}{quote_str}{contents}{quote_str}") - } + /// An implicitly concatenated string literals i.e., `"foo" "bar"`. + Concatenated(ConcatenatedStringLiteral), } bitflags! { - #[derive(Default, Copy, Clone, PartialEq, Eq, Hash)] - struct FStringFlagsInner: u8 { - /// The f-string uses double quotes (`"`) for its opener and closer. - /// If this flag is not set, the f-string uses single quotes (`'`) - /// for its opener and closer. + #[derive(Debug, Default, Copy, Clone, PartialEq, Eq, Hash)] + struct StringLiteralFlagsInner: u8 { + /// The string uses double quotes (e.g. `"foo"`). + /// If this flag is not set, the string uses single quotes (`'foo'`). const DOUBLE = 1 << 0; - /// The f-string is triple-quoted: + /// The string is triple-quoted (`"""foo"""`): /// it begins and ends with three consecutive quote characters. - /// For example: `f"""{bar}"""`. const TRIPLE_QUOTED = 1 << 1; - /// The f-string has an `r` prefix, meaning it is a raw f-string - /// with a lowercase 'r'. For example: `rf"{bar}"` - const R_PREFIX_LOWER = 1 << 2; + /// The string has a `u` or `U` prefix, e.g. `u"foo"`. + /// While this prefix is a no-op at runtime, + /// strings with this prefix can have no other prefixes set; + /// it is therefore invalid for this flag to be set + /// if `R_PREFIX` is also set. + const U_PREFIX = 1 << 2; - /// The f-string has an `R` prefix, meaning it is a raw f-string - /// with an uppercase 'r'. For example: `Rf"{bar}"`. + /// The string has an `r` prefix, meaning it is a raw string + /// with a lowercase 'r' (e.g. `r"foo\."`). + /// It is invalid to set this flag if `U_PREFIX` is also set. + const R_PREFIX_LOWER = 1 << 3; + + /// The string has an `R` prefix, meaning it is a raw string + /// with an uppercase 'R' (e.g. `R'foo\d'`). /// See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings /// for why we track the casing of the `r` prefix, /// but not for any other prefix - const R_PREFIX_UPPER = 1 << 3; + const R_PREFIX_UPPER = 1 << 4; + + /// The string was deemed invalid by the parser. + const INVALID = 1 << 5; } } /// Flags that can be queried to obtain information -/// regarding the prefixes and quotes used for an f-string. -#[derive(Default, Copy, Clone, Eq, PartialEq, Hash)] -pub struct FStringFlags(FStringFlagsInner); +/// regarding the prefixes and quotes used for a string literal. +/// +/// ## Notes on usage +/// +/// If you're using a `Generator` from the `ruff_python_codegen` crate to generate a lint-rule fix +/// from an existing string literal, consider passing along the [`StringLiteral::flags`] field or +/// the result of the [`StringLiteralValue::first_literal_flags`] method. If you don't have an +/// existing string but have a `Checker` from the `ruff_linter` crate available, consider using +/// `Checker::default_string_flags` to create instances of this struct; this method will properly +/// handle surrounding f-strings. For usage that doesn't fit into one of these categories, the +/// public constructor [`StringLiteralFlags::empty`] can be used. +#[derive(Copy, Clone, Eq, PartialEq, Hash)] +pub struct StringLiteralFlags(StringLiteralFlagsInner); + +impl StringLiteralFlags { + /// Construct a new [`StringLiteralFlags`] with **no flags set**. + /// + /// See [`StringLiteralFlags::with_quote_style`], [`StringLiteralFlags::with_triple_quotes`], + /// and [`StringLiteralFlags::with_prefix`] for ways of setting the quote style (single or + /// double), enabling triple quotes, and adding prefixes (such as `r` or `u`), respectively. + /// + /// See the documentation for [`StringLiteralFlags`] for additional caveats on this constructor, + /// and situations in which alternative ways to construct this struct should be used, especially + /// when writing lint rules. + pub fn empty() -> Self { + Self(StringLiteralFlagsInner::empty()) + } -impl FStringFlags { #[must_use] pub fn with_quote_style(mut self, quote_style: Quote) -> Self { self.0 - .set(FStringFlagsInner::DOUBLE, quote_style.is_double()); + .set(StringLiteralFlagsInner::DOUBLE, quote_style.is_double()); self } #[must_use] - pub fn with_triple_quotes(mut self) -> Self { - self.0 |= FStringFlagsInner::TRIPLE_QUOTED; + pub fn with_triple_quotes(mut self, triple_quotes: TripleQuotes) -> Self { + self.0.set( + StringLiteralFlagsInner::TRIPLE_QUOTED, + triple_quotes.is_yes(), + ); self } #[must_use] - pub fn with_prefix(mut self, prefix: FStringPrefix) -> Self { + pub fn with_prefix(self, prefix: StringLiteralPrefix) -> Self { + let StringLiteralFlags(flags) = self; match prefix { - FStringPrefix::Regular => { - Self(self.0 - FStringFlagsInner::R_PREFIX_LOWER - FStringFlagsInner::R_PREFIX_UPPER) - } - FStringPrefix::Raw { uppercase_r } => { - self.0.set(FStringFlagsInner::R_PREFIX_UPPER, uppercase_r); - self.0.set(FStringFlagsInner::R_PREFIX_LOWER, !uppercase_r); - self - } + StringLiteralPrefix::Empty => Self( + flags + - StringLiteralFlagsInner::R_PREFIX_LOWER + - StringLiteralFlagsInner::R_PREFIX_UPPER + - StringLiteralFlagsInner::U_PREFIX, + ), + StringLiteralPrefix::Raw { uppercase: false } => Self( + (flags | StringLiteralFlagsInner::R_PREFIX_LOWER) + - StringLiteralFlagsInner::R_PREFIX_UPPER + - StringLiteralFlagsInner::U_PREFIX, + ), + StringLiteralPrefix::Raw { uppercase: true } => Self( + (flags | StringLiteralFlagsInner::R_PREFIX_UPPER) + - StringLiteralFlagsInner::R_PREFIX_LOWER + - StringLiteralFlagsInner::U_PREFIX, + ), + StringLiteralPrefix::Unicode => Self( + (flags | StringLiteralFlagsInner::U_PREFIX) + - StringLiteralFlagsInner::R_PREFIX_LOWER + - StringLiteralFlagsInner::R_PREFIX_UPPER, + ), } } - pub const fn prefix(self) -> FStringPrefix { - if self.0.contains(FStringFlagsInner::R_PREFIX_LOWER) { - debug_assert!(!self.0.contains(FStringFlagsInner::R_PREFIX_UPPER)); - FStringPrefix::Raw { uppercase_r: false } - } else if self.0.contains(FStringFlagsInner::R_PREFIX_UPPER) { - FStringPrefix::Raw { uppercase_r: true } + #[must_use] + pub fn with_invalid(mut self) -> Self { + self.0 |= StringLiteralFlagsInner::INVALID; + self + } + + pub const fn prefix(self) -> StringLiteralPrefix { + if self.0.contains(StringLiteralFlagsInner::U_PREFIX) { + debug_assert!( + !self.0.intersects( + StringLiteralFlagsInner::R_PREFIX_LOWER + .union(StringLiteralFlagsInner::R_PREFIX_UPPER) + ) + ); + StringLiteralPrefix::Unicode + } else if self.0.contains(StringLiteralFlagsInner::R_PREFIX_LOWER) { + debug_assert!(!self.0.contains(StringLiteralFlagsInner::R_PREFIX_UPPER)); + StringLiteralPrefix::Raw { uppercase: false } + } else if self.0.contains(StringLiteralFlagsInner::R_PREFIX_UPPER) { + StringLiteralPrefix::Raw { uppercase: true } } else { - FStringPrefix::Regular + StringLiteralPrefix::Empty } } } -impl StringFlags for FStringFlags { - /// Return `true` if the f-string is triple-quoted, i.e., - /// it begins and ends with three consecutive quote characters. - /// For example: `f"""{bar}"""` - fn is_triple_quoted(self) -> bool { - self.0.contains(FStringFlagsInner::TRIPLE_QUOTED) - } - +impl StringFlags for StringLiteralFlags { /// Return the quoting style (single or double quotes) - /// used by the f-string's opener and closer: - /// - `f"{"a"}"` -> `QuoteStyle::Double` - /// - `f'{"a"}'` -> `QuoteStyle::Single` + /// used by the string's opener and closer: + /// - `"a"` -> `QuoteStyle::Double` + /// - `'a'` -> `QuoteStyle::Single` fn quote_style(self) -> Quote { - if self.0.contains(FStringFlagsInner::DOUBLE) { + if self.0.contains(StringLiteralFlagsInner::DOUBLE) { Quote::Double } else { Quote::Single } } - fn prefix(self) -> AnyStringPrefix { - AnyStringPrefix::Format(self.prefix()) + /// Return `true` if the string is triple-quoted, i.e., + /// it begins and ends with three consecutive quote characters. + /// For example: `"""bar"""` + fn triple_quotes(self) -> TripleQuotes { + if self.0.contains(StringLiteralFlagsInner::TRIPLE_QUOTED) { + TripleQuotes::Yes + } else { + TripleQuotes::No + } + } + + fn prefix(self) -> AnyStringPrefix { + AnyStringPrefix::Regular(self.prefix()) } } -impl fmt::Debug for FStringFlags { +impl fmt::Debug for StringLiteralFlags { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("FStringFlags") + f.debug_struct("StringLiteralFlags") .field("quote_style", &self.quote_style()) .field("prefix", &self.prefix()) .field("triple_quoted", &self.is_triple_quoted()) @@ -1561,409 +1195,387 @@ impl fmt::Debug for FStringFlags { } } -/// An AST node that represents a single f-string which is part of an [`ExprFString`]. +/// An AST node that represents a single string literal which is part of an +/// [`ExprStringLiteral`]. #[derive(Clone, Debug, PartialEq)] -pub struct FString { +pub struct StringLiteral { pub range: TextRange, - pub elements: FStringElements, - pub flags: FStringFlags, + pub value: Box<str>, + pub flags: StringLiteralFlags, } -impl Ranged for FString { - fn range(&self) -> TextRange { - self.range - } -} +impl Deref for StringLiteral { + type Target = str; -impl From<FString> for Expr { - fn from(payload: FString) -> Self { - ExprFString { - range: payload.range, - value: FStringValue::single(payload), - } - .into() + fn deref(&self) -> &Self::Target { + &self.value } } -/// A newtype wrapper around a list of [`FStringElement`]. -#[derive(Clone, Default, PartialEq)] -pub struct FStringElements(Vec<FStringElement>); - -impl FStringElements { - /// Returns an iterator over all the [`FStringLiteralElement`] nodes contained in this f-string. - pub fn literals(&self) -> impl Iterator<Item = &FStringLiteralElement> { - self.iter().filter_map(|element| element.as_literal()) +impl StringLiteral { + /// Extracts a string slice containing the entire `String`. + pub fn as_str(&self) -> &str { + self } - /// Returns an iterator over all the [`FStringExpressionElement`] nodes contained in this f-string. - pub fn expressions(&self) -> impl Iterator<Item = &FStringExpressionElement> { - self.iter().filter_map(|element| element.as_expression()) + /// Creates an invalid string literal with the given range. + pub fn invalid(range: TextRange) -> Self { + Self { + range, + value: "".into(), + flags: StringLiteralFlags::empty().with_invalid(), + } } -} -impl From<Vec<FStringElement>> for FStringElements { - fn from(elements: Vec<FStringElement>) -> Self { - FStringElements(elements) + /// The range of the string literal's contents. + /// + /// This excludes any prefixes, opening quotes or closing quotes. + pub fn content_range(&self) -> TextRange { + TextRange::new( + self.start() + self.flags.opener_len(), + self.end() - self.flags.closer_len(), + ) } } -impl<'a> IntoIterator for &'a FStringElements { - type IntoIter = Iter<'a, FStringElement>; - type Item = &'a FStringElement; - - fn into_iter(self) -> Self::IntoIter { - self.iter() +impl From<StringLiteral> for Expr { + fn from(payload: StringLiteral) -> Self { + ExprStringLiteral { + range: payload.range, + value: StringLiteralValue::single(payload), + } + .into() } } -impl<'a> IntoIterator for &'a mut FStringElements { - type IntoIter = IterMut<'a, FStringElement>; - type Item = &'a mut FStringElement; - - fn into_iter(self) -> Self::IntoIter { - self.iter_mut() - } +/// An internal representation of [`StringLiteral`] that represents an +/// implicitly concatenated string. +#[derive(Clone)] +struct ConcatenatedStringLiteral { + /// The individual [`StringLiteral`] parts that make up the concatenated string. + strings: Vec<StringLiteral>, + /// The concatenated string value. + value: OnceLock<Box<str>>, } -impl Deref for FStringElements { - type Target = [FStringElement]; - - fn deref(&self) -> &Self::Target { - &self.0 +impl ConcatenatedStringLiteral { + /// Extracts a string slice containing the entire concatenated string. + fn to_str(&self) -> &str { + self.value.get_or_init(|| { + let concatenated: String = self.strings.iter().map(StringLiteral::as_str).collect(); + concatenated.into_boxed_str() + }) } } -impl DerefMut for FStringElements { - fn deref_mut(&mut self) -> &mut Self::Target { - &mut self.0 +impl PartialEq for ConcatenatedStringLiteral { + fn eq(&self, other: &Self) -> bool { + if self.strings.len() != other.strings.len() { + return false; + } + // The `zip` here is safe because we have checked the length of both parts. + self.strings + .iter() + .zip(&other.strings) + .all(|(s1, s2)| s1 == s2) } } -impl fmt::Debug for FStringElements { +impl Debug for ConcatenatedStringLiteral { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - fmt::Debug::fmt(&self.0, f) + f.debug_struct("ConcatenatedStringLiteral") + .field("strings", &self.strings) + .field("value", &self.to_str()) + .finish() } } -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum FStringElement { - Literal(FStringLiteralElement), - Expression(FStringExpressionElement), -} - -impl Ranged for FStringElement { - fn range(&self) -> TextRange { - match self { - FStringElement::Literal(node) => node.range(), - FStringElement::Expression(node) => node.range(), +impl ExprBytesLiteral { + /// Return `Some(literal)` if the bytestring only consists of a single `BytesLiteral` part + /// (indicating that it is not implicitly concatenated). Otherwise, return `None`. + pub const fn as_single_part_bytestring(&self) -> Option<&BytesLiteral> { + match &self.value.inner { + BytesLiteralValueInner::Single(value) => Some(value), + BytesLiteralValueInner::Concatenated(_) => None, } } } -/// An AST node that represents either a single string literal or an implicitly -/// concatenated string literals. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ExprStringLiteral { - pub range: TextRange, - pub value: StringLiteralValue, -} - -impl From<ExprStringLiteral> for Expr { - fn from(payload: ExprStringLiteral) -> Self { - Expr::StringLiteral(payload) - } -} - -impl Ranged for ExprStringLiteral { - fn range(&self) -> TextRange { - self.range - } -} - -/// The value representing a [`ExprStringLiteral`]. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct StringLiteralValue { - inner: StringLiteralValueInner, +/// The value representing a [`ExprBytesLiteral`]. +#[derive(Clone, Debug, PartialEq)] +pub struct BytesLiteralValue { + inner: BytesLiteralValueInner, } -impl StringLiteralValue { - /// Creates a new single string literal with the given value. - pub fn single(string: StringLiteral) -> Self { +impl BytesLiteralValue { + /// Create a new bytestring literal with a single [`BytesLiteral`] part. + pub fn single(value: BytesLiteral) -> Self { Self { - inner: StringLiteralValueInner::Single(string), + inner: BytesLiteralValueInner::Single(value), } } - /// Creates a new string literal with the given values that represents an - /// implicitly concatenated strings. + /// Creates a new bytestring literal with the given values that represents an + /// implicitly concatenated bytestring. /// /// # Panics /// - /// Panics if `strings` is less than 2. Use [`StringLiteralValue::single`] - /// instead. - pub fn concatenated(strings: Vec<StringLiteral>) -> Self { - assert!(strings.len() > 1); + /// Panics if `values` has less than 2 elements. + /// Use [`BytesLiteralValue::single`] instead. + pub fn concatenated(values: Vec<BytesLiteral>) -> Self { + assert!( + values.len() > 1, + "Use `BytesLiteralValue::single` to create single-part bytestrings" + ); Self { - inner: StringLiteralValueInner::Concatenated(ConcatenatedStringLiteral { - strings, - value: OnceLock::new(), - }), + inner: BytesLiteralValueInner::Concatenated(values), } } - /// Returns `true` if the string literal is implicitly concatenated. + /// Returns `true` if the bytestring is implicitly concatenated. pub const fn is_implicit_concatenated(&self) -> bool { - matches!(self.inner, StringLiteralValueInner::Concatenated(_)) - } - - /// Returns `true` if the string literal is a unicode string. - /// - /// For an implicitly concatenated string, it returns `true` only if the first - /// string literal is a unicode string. - pub fn is_unicode(&self) -> bool { - self.iter() - .next() - .map_or(false, |part| part.flags.prefix().is_unicode()) + matches!(self.inner, BytesLiteralValueInner::Concatenated(_)) } - /// Returns a slice of all the [`StringLiteral`] parts contained in this value. - pub fn as_slice(&self) -> &[StringLiteral] { + /// Returns a slice of all the [`BytesLiteral`] parts contained in this value. + pub fn as_slice(&self) -> &[BytesLiteral] { match &self.inner { - StringLiteralValueInner::Single(value) => std::slice::from_ref(value), - StringLiteralValueInner::Concatenated(value) => value.strings.as_slice(), + BytesLiteralValueInner::Single(value) => std::slice::from_ref(value), + BytesLiteralValueInner::Concatenated(value) => value.as_slice(), } } - /// Returns a mutable slice of all the [`StringLiteral`] parts contained in this value. - fn as_mut_slice(&mut self) -> &mut [StringLiteral] { + /// Returns a mutable slice of all the [`BytesLiteral`] parts contained in this value. + fn as_mut_slice(&mut self) -> &mut [BytesLiteral] { match &mut self.inner { - StringLiteralValueInner::Single(value) => std::slice::from_mut(value), - StringLiteralValueInner::Concatenated(value) => value.strings.as_mut_slice(), + BytesLiteralValueInner::Single(value) => std::slice::from_mut(value), + BytesLiteralValueInner::Concatenated(value) => value.as_mut_slice(), } } - /// Returns an iterator over all the [`StringLiteral`] parts contained in this value. - pub fn iter(&self) -> Iter<StringLiteral> { + /// Returns an iterator over all the [`BytesLiteral`] parts contained in this value. + pub fn iter(&self) -> Iter<BytesLiteral> { self.as_slice().iter() } - /// Returns an iterator over all the [`StringLiteral`] parts contained in this value + /// Returns an iterator over all the [`BytesLiteral`] parts contained in this value /// that allows modification. - pub fn iter_mut(&mut self) -> IterMut<StringLiteral> { + pub fn iter_mut(&mut self) -> IterMut<BytesLiteral> { self.as_mut_slice().iter_mut() } - /// Returns `true` if the string literal value is empty. + /// Return `true` if the node represents an empty bytestring. + /// + /// Note that a [`BytesLiteralValue`] node will always have >=1 [`BytesLiteral`] parts + /// inside it. This method checks whether the value of the concatenated parts is equal + /// to the empty bytestring, not whether the bytestring has 0 parts inside it. pub fn is_empty(&self) -> bool { - self.len() == 0 + self.iter().all(|part| part.is_empty()) } - /// Returns the total length of the string literal value, in bytes, not - /// [`char`]s or graphemes. + /// Returns the length of the concatenated bytestring. pub fn len(&self) -> usize { - self.iter().fold(0, |acc, part| acc + part.value.len()) - } - - /// Returns an iterator over the [`char`]s of each string literal part. - pub fn chars(&self) -> impl Iterator<Item = char> + Clone + '_ { - self.iter().flat_map(|part| part.value.chars()) + self.iter().map(|part| part.len()).sum() } - /// Returns the concatenated string value as a [`str`]. - /// - /// Note that this will perform an allocation on the first invocation if the - /// string value is implicitly concatenated. - pub fn to_str(&self) -> &str { - match &self.inner { - StringLiteralValueInner::Single(value) => value.as_str(), - StringLiteralValueInner::Concatenated(value) => value.to_str(), - } + /// Returns an iterator over the bytes of the concatenated bytestring. + pub fn bytes(&self) -> impl Iterator<Item = u8> + '_ { + self.iter().flat_map(|part| part.as_slice().iter().copied()) } } -impl<'a> IntoIterator for &'a StringLiteralValue { - type Item = &'a StringLiteral; - type IntoIter = Iter<'a, StringLiteral>; +impl<'a> IntoIterator for &'a BytesLiteralValue { + type Item = &'a BytesLiteral; + type IntoIter = Iter<'a, BytesLiteral>; fn into_iter(self) -> Self::IntoIter { self.iter() } } -impl<'a> IntoIterator for &'a mut StringLiteralValue { - type Item = &'a mut StringLiteral; - type IntoIter = IterMut<'a, StringLiteral>; +impl<'a> IntoIterator for &'a mut BytesLiteralValue { + type Item = &'a mut BytesLiteral; + type IntoIter = IterMut<'a, BytesLiteral>; fn into_iter(self) -> Self::IntoIter { self.iter_mut() } } -impl PartialEq<str> for StringLiteralValue { - fn eq(&self, other: &str) -> bool { +impl PartialEq<[u8]> for BytesLiteralValue { + fn eq(&self, other: &[u8]) -> bool { if self.len() != other.len() { return false; } // The `zip` here is safe because we have checked the length of both parts. - self.chars().zip(other.chars()).all(|(c1, c2)| c1 == c2) + self.bytes() + .zip(other.iter().copied()) + .all(|(b1, b2)| b1 == b2) } } -impl fmt::Display for StringLiteralValue { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.to_str()) +impl<'a> From<&'a BytesLiteralValue> for Cow<'a, [u8]> { + fn from(value: &'a BytesLiteralValue) -> Self { + match &value.inner { + BytesLiteralValueInner::Single(BytesLiteral { + value: bytes_value, .. + }) => Cow::from(bytes_value.as_ref()), + BytesLiteralValueInner::Concatenated(bytes_literal_vec) => Cow::Owned( + bytes_literal_vec + .iter() + .flat_map(|bytes_literal| bytes_literal.value.to_vec()) + .collect::<Vec<u8>>(), + ), + } } } -/// An internal representation of [`StringLiteralValue`]. +/// An internal representation of [`BytesLiteralValue`]. #[derive(Clone, Debug, PartialEq)] -enum StringLiteralValueInner { - /// A single string literal i.e., `"foo"`. - Single(StringLiteral), - - /// An implicitly concatenated string literals i.e., `"foo" "bar"`. - Concatenated(ConcatenatedStringLiteral), -} +enum BytesLiteralValueInner { + /// A single-part bytestring literal i.e., `b"foo"`. + Single(BytesLiteral), -impl Default for StringLiteralValueInner { - fn default() -> Self { - Self::Single(StringLiteral::default()) - } + /// An implicitly concatenated bytestring literal i.e., `b"foo" b"bar"`. + Concatenated(Vec<BytesLiteral>), } bitflags! { - #[derive(Debug, Default, Copy, Clone, PartialEq, Eq, Hash)] - struct StringLiteralFlagsInner: u8 { - /// The string uses double quotes (e.g. `"foo"`). - /// If this flag is not set, the string uses single quotes (`'foo'`). + #[derive(Default, Copy, Clone, PartialEq, Eq, Hash)] + struct BytesLiteralFlagsInner: u8 { + /// The bytestring uses double quotes (e.g. `b"foo"`). + /// If this flag is not set, the bytestring uses single quotes (e.g. `b'foo'`). const DOUBLE = 1 << 0; - /// The string is triple-quoted (`"""foo"""`): + /// The bytestring is triple-quoted (e.g. `b"""foo"""`): /// it begins and ends with three consecutive quote characters. const TRIPLE_QUOTED = 1 << 1; - /// The string has a `u` or `U` prefix, e.g. `u"foo"`. - /// While this prefix is a no-op at runtime, - /// strings with this prefix can have no other prefixes set; - /// it is therefore invalid for this flag to be set - /// if `R_PREFIX` is also set. - const U_PREFIX = 1 << 2; - - /// The string has an `r` prefix, meaning it is a raw string - /// with a lowercase 'r' (e.g. `r"foo\."`). - /// It is invalid to set this flag if `U_PREFIX` is also set. - const R_PREFIX_LOWER = 1 << 3; + /// The bytestring has an `r` prefix (e.g. `rb"foo"`), + /// meaning it is a raw bytestring with a lowercase 'r'. + const R_PREFIX_LOWER = 1 << 2; - /// The string has an `R` prefix, meaning it is a raw string - /// with an uppercase 'R' (e.g. `R'foo\d'`). + /// The bytestring has an `R` prefix (e.g. `Rb"foo"`), + /// meaning it is a raw bytestring with an uppercase 'R'. /// See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings - /// for why we track the casing of the `r` prefix, - /// but not for any other prefix - const R_PREFIX_UPPER = 1 << 4; + /// for why we track the casing of the `r` prefix, but not for any other prefix + const R_PREFIX_UPPER = 1 << 3; - /// The string was deemed invalid by the parser. - const INVALID = 1 << 5; + /// The bytestring was deemed invalid by the parser. + const INVALID = 1 << 4; } } /// Flags that can be queried to obtain information -/// regarding the prefixes and quotes used for a string literal. -#[derive(Default, Copy, Clone, Eq, PartialEq, Hash)] -pub struct StringLiteralFlags(StringLiteralFlagsInner); +/// regarding the prefixes and quotes used for a bytes literal. +/// +/// ## Notes on usage +/// +/// If you're using a `Generator` from the `ruff_python_codegen` crate to generate a lint-rule fix +/// from an existing bytes literal, consider passing along the [`BytesLiteral::flags`] field. If +/// you don't have an existing literal but have a `Checker` from the `ruff_linter` crate available, +/// consider using `Checker::default_bytes_flags` to create instances of this struct; this method +/// will properly handle surrounding f-strings. For usage that doesn't fit into one of these +/// categories, the public constructor [`BytesLiteralFlags::empty`] can be used. +#[derive(Copy, Clone, Eq, PartialEq, Hash)] +pub struct BytesLiteralFlags(BytesLiteralFlagsInner); + +impl BytesLiteralFlags { + /// Construct a new [`BytesLiteralFlags`] with **no flags set**. + /// + /// See [`BytesLiteralFlags::with_quote_style`], [`BytesLiteralFlags::with_triple_quotes`], and + /// [`BytesLiteralFlags::with_prefix`] for ways of setting the quote style (single or double), + /// enabling triple quotes, and adding prefixes (such as `r`), respectively. + /// + /// See the documentation for [`BytesLiteralFlags`] for additional caveats on this constructor, + /// and situations in which alternative ways to construct this struct should be used, especially + /// when writing lint rules. + pub fn empty() -> Self { + Self(BytesLiteralFlagsInner::empty()) + } -impl StringLiteralFlags { #[must_use] pub fn with_quote_style(mut self, quote_style: Quote) -> Self { self.0 - .set(StringLiteralFlagsInner::DOUBLE, quote_style.is_double()); + .set(BytesLiteralFlagsInner::DOUBLE, quote_style.is_double()); self } #[must_use] - pub fn with_triple_quotes(mut self) -> Self { - self.0 |= StringLiteralFlagsInner::TRIPLE_QUOTED; + pub fn with_triple_quotes(mut self, triple_quotes: TripleQuotes) -> Self { + self.0.set( + BytesLiteralFlagsInner::TRIPLE_QUOTED, + triple_quotes.is_yes(), + ); self } #[must_use] - pub fn with_prefix(self, prefix: StringLiteralPrefix) -> Self { - let StringLiteralFlags(flags) = self; + pub fn with_prefix(mut self, prefix: ByteStringPrefix) -> Self { match prefix { - StringLiteralPrefix::Empty => Self( - flags - - StringLiteralFlagsInner::R_PREFIX_LOWER - - StringLiteralFlagsInner::R_PREFIX_UPPER - - StringLiteralFlagsInner::U_PREFIX, - ), - StringLiteralPrefix::Raw { uppercase: false } => Self( - (flags | StringLiteralFlagsInner::R_PREFIX_LOWER) - - StringLiteralFlagsInner::R_PREFIX_UPPER - - StringLiteralFlagsInner::U_PREFIX, - ), - StringLiteralPrefix::Raw { uppercase: true } => Self( - (flags | StringLiteralFlagsInner::R_PREFIX_UPPER) - - StringLiteralFlagsInner::R_PREFIX_LOWER - - StringLiteralFlagsInner::U_PREFIX, - ), - StringLiteralPrefix::Unicode => Self( - (flags | StringLiteralFlagsInner::U_PREFIX) - - StringLiteralFlagsInner::R_PREFIX_LOWER - - StringLiteralFlagsInner::R_PREFIX_UPPER, - ), + ByteStringPrefix::Regular => { + self.0 -= BytesLiteralFlagsInner::R_PREFIX_LOWER; + self.0 -= BytesLiteralFlagsInner::R_PREFIX_UPPER; + } + ByteStringPrefix::Raw { uppercase_r } => { + self.0 + .set(BytesLiteralFlagsInner::R_PREFIX_UPPER, uppercase_r); + self.0 + .set(BytesLiteralFlagsInner::R_PREFIX_LOWER, !uppercase_r); + } } + self } #[must_use] pub fn with_invalid(mut self) -> Self { - self.0 |= StringLiteralFlagsInner::INVALID; + self.0 |= BytesLiteralFlagsInner::INVALID; self } - pub const fn prefix(self) -> StringLiteralPrefix { - if self.0.contains(StringLiteralFlagsInner::U_PREFIX) { - debug_assert!(!self.0.intersects( - StringLiteralFlagsInner::R_PREFIX_LOWER - .union(StringLiteralFlagsInner::R_PREFIX_UPPER) - )); - StringLiteralPrefix::Unicode - } else if self.0.contains(StringLiteralFlagsInner::R_PREFIX_LOWER) { - debug_assert!(!self.0.contains(StringLiteralFlagsInner::R_PREFIX_UPPER)); - StringLiteralPrefix::Raw { uppercase: false } - } else if self.0.contains(StringLiteralFlagsInner::R_PREFIX_UPPER) { - StringLiteralPrefix::Raw { uppercase: true } + pub const fn prefix(self) -> ByteStringPrefix { + if self.0.contains(BytesLiteralFlagsInner::R_PREFIX_LOWER) { + debug_assert!(!self.0.contains(BytesLiteralFlagsInner::R_PREFIX_UPPER)); + ByteStringPrefix::Raw { uppercase_r: false } + } else if self.0.contains(BytesLiteralFlagsInner::R_PREFIX_UPPER) { + ByteStringPrefix::Raw { uppercase_r: true } } else { - StringLiteralPrefix::Empty + ByteStringPrefix::Regular } } } -impl StringFlags for StringLiteralFlags { +impl StringFlags for BytesLiteralFlags { + /// Return `true` if the bytestring is triple-quoted, i.e., + /// it begins and ends with three consecutive quote characters. + /// For example: `b"""{bar}"""` + fn triple_quotes(self) -> TripleQuotes { + if self.0.contains(BytesLiteralFlagsInner::TRIPLE_QUOTED) { + TripleQuotes::Yes + } else { + TripleQuotes::No + } + } + /// Return the quoting style (single or double quotes) - /// used by the string's opener and closer: - /// - `"a"` -> `QuoteStyle::Double` - /// - `'a'` -> `QuoteStyle::Single` + /// used by the bytestring's opener and closer: + /// - `b"a"` -> `QuoteStyle::Double` + /// - `b'a'` -> `QuoteStyle::Single` fn quote_style(self) -> Quote { - if self.0.contains(StringLiteralFlagsInner::DOUBLE) { + if self.0.contains(BytesLiteralFlagsInner::DOUBLE) { Quote::Double } else { Quote::Single } } - /// Return `true` if the string is triple-quoted, i.e., - /// it begins and ends with three consecutive quote characters. - /// For example: `"""bar"""` - fn is_triple_quoted(self) -> bool { - self.0.contains(StringLiteralFlagsInner::TRIPLE_QUOTED) - } - fn prefix(self) -> AnyStringPrefix { - AnyStringPrefix::Regular(self.prefix()) + AnyStringPrefix::Bytes(self.prefix()) } } -impl fmt::Debug for StringLiteralFlags { +impl fmt::Debug for BytesLiteralFlags { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("StringLiteralFlags") + f.debug_struct("BytesLiteralFlags") .field("quote_style", &self.quote_style()) .field("prefix", &self.prefix()) .field("triple_quoted", &self.is_triple_quoted()) @@ -1971,2593 +1583,1546 @@ impl fmt::Debug for StringLiteralFlags { } } -/// An AST node that represents a single string literal which is part of an -/// [`ExprStringLiteral`]. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct StringLiteral { +/// An AST node that represents a single bytes literal which is part of an +/// [`ExprBytesLiteral`]. +#[derive(Clone, Debug, PartialEq)] +pub struct BytesLiteral { pub range: TextRange, - pub value: Box<str>, - pub flags: StringLiteralFlags, -} - -impl Ranged for StringLiteral { - fn range(&self) -> TextRange { - self.range - } + pub value: Box<[u8]>, + pub flags: BytesLiteralFlags, } -impl Deref for StringLiteral { - type Target = str; +impl Deref for BytesLiteral { + type Target = [u8]; fn deref(&self) -> &Self::Target { &self.value } } -impl StringLiteral { - /// Extracts a string slice containing the entire `String`. - pub fn as_str(&self) -> &str { +impl BytesLiteral { + /// Extracts a byte slice containing the entire [`BytesLiteral`]. + pub fn as_slice(&self) -> &[u8] { self } - /// Creates an invalid string literal with the given range. + /// Creates a new invalid bytes literal with the given range. pub fn invalid(range: TextRange) -> Self { Self { range, - value: "".into(), - flags: StringLiteralFlags::default().with_invalid(), + value: Box::new([]), + flags: BytesLiteralFlags::empty().with_invalid(), } } } -impl From<StringLiteral> for Expr { - fn from(payload: StringLiteral) -> Self { - ExprStringLiteral { +impl From<BytesLiteral> for Expr { + fn from(payload: BytesLiteral) -> Self { + ExprBytesLiteral { range: payload.range, - value: StringLiteralValue::single(payload), + value: BytesLiteralValue::single(payload), } .into() } } -/// An internal representation of [`StringLiteral`] that represents an -/// implicitly concatenated string. -#[derive(Clone)] -struct ConcatenatedStringLiteral { - /// Each string literal that makes up the concatenated string. - strings: Vec<StringLiteral>, - /// The concatenated string value. - value: OnceLock<Box<str>>, -} - -impl ConcatenatedStringLiteral { - /// Extracts a string slice containing the entire concatenated string. - fn to_str(&self) -> &str { - self.value.get_or_init(|| { - let concatenated: String = self.strings.iter().map(StringLiteral::as_str).collect(); - concatenated.into_boxed_str() - }) - } -} +bitflags! { + /// Flags that can be queried to obtain information + /// regarding the prefixes and quotes used for a string literal. + /// + /// Note that not all of these flags can be validly combined -- e.g., + /// it is invalid to combine the `U_PREFIX` flag with any other + /// of the `*_PREFIX` flags. As such, the recommended way to set the + /// prefix flags is by calling the `as_flags()` method on the + /// `StringPrefix` enum. + #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)] + struct AnyStringFlagsInner: u8 { + /// The string uses double quotes (`"`). + /// If this flag is not set, the string uses single quotes (`'`). + const DOUBLE = 1 << 0; -impl PartialEq for ConcatenatedStringLiteral { - fn eq(&self, other: &Self) -> bool { - if self.strings.len() != other.strings.len() { - return false; - } - // The `zip` here is safe because we have checked the length of both parts. - self.strings - .iter() - .zip(&other.strings) - .all(|(s1, s2)| s1 == s2) - } -} + /// The string is triple-quoted: + /// it begins and ends with three consecutive quote characters. + const TRIPLE_QUOTED = 1 << 1; -impl Debug for ConcatenatedStringLiteral { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("ConcatenatedStringLiteral") - .field("strings", &self.strings) - .field("value", &self.to_str()) - .finish() - } -} + /// The string has a `u` or `U` prefix. + /// While this prefix is a no-op at runtime, + /// strings with this prefix can have no other prefixes set. + const U_PREFIX = 1 << 2; -/// An AST node that represents either a single bytes literal or an implicitly -/// concatenated bytes literals. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ExprBytesLiteral { - pub range: TextRange, - pub value: BytesLiteralValue, -} + /// The string has a `b` or `B` prefix. + /// This means that the string is a sequence of `int`s at runtime, + /// rather than a sequence of `str`s. + /// Strings with this flag can also be raw strings, + /// but can have no other prefixes. + const B_PREFIX = 1 << 3; -impl From<ExprBytesLiteral> for Expr { - fn from(payload: ExprBytesLiteral) -> Self { - Expr::BytesLiteral(payload) - } -} + /// The string has a `f` or `F` prefix, meaning it is an f-string. + /// F-strings can also be raw strings, + /// but can have no other prefixes. + const F_PREFIX = 1 << 4; -impl Ranged for ExprBytesLiteral { - fn range(&self) -> TextRange { - self.range - } -} + /// The string has an `r` prefix, meaning it is a raw string. + /// F-strings and byte-strings can be raw, + /// as can strings with no other prefixes. + /// U-strings cannot be raw. + const R_PREFIX_LOWER = 1 << 5; -/// The value representing a [`ExprBytesLiteral`]. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct BytesLiteralValue { - inner: BytesLiteralValueInner, + /// The string has an `R` prefix, meaning it is a raw string. + /// The casing of the `r`/`R` has no semantic significance at runtime; + /// see https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings + /// for why we track the casing of the `r` prefix, + /// but not for any other prefix + const R_PREFIX_UPPER = 1 << 6; + } } -impl BytesLiteralValue { - /// Creates a new single bytes literal with the given value. - pub fn single(value: BytesLiteral) -> Self { - Self { - inner: BytesLiteralValueInner::Single(value), - } +#[derive(Clone, Copy, PartialEq, Eq, Hash)] +pub struct AnyStringFlags(AnyStringFlagsInner); + +impl AnyStringFlags { + #[must_use] + pub fn with_prefix(mut self, prefix: AnyStringPrefix) -> Self { + self.0 |= match prefix { + // regular strings + AnyStringPrefix::Regular(StringLiteralPrefix::Empty) => AnyStringFlagsInner::empty(), + AnyStringPrefix::Regular(StringLiteralPrefix::Unicode) => AnyStringFlagsInner::U_PREFIX, + AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: false }) => { + AnyStringFlagsInner::R_PREFIX_LOWER + } + AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: true }) => { + AnyStringFlagsInner::R_PREFIX_UPPER + } + + // bytestrings + AnyStringPrefix::Bytes(ByteStringPrefix::Regular) => AnyStringFlagsInner::B_PREFIX, + AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: false }) => { + AnyStringFlagsInner::B_PREFIX.union(AnyStringFlagsInner::R_PREFIX_LOWER) + } + AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: true }) => { + AnyStringFlagsInner::B_PREFIX.union(AnyStringFlagsInner::R_PREFIX_UPPER) + } + + // f-strings + AnyStringPrefix::Format(FStringPrefix::Regular) => AnyStringFlagsInner::F_PREFIX, + AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: false }) => { + AnyStringFlagsInner::F_PREFIX.union(AnyStringFlagsInner::R_PREFIX_LOWER) + } + AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: true }) => { + AnyStringFlagsInner::F_PREFIX.union(AnyStringFlagsInner::R_PREFIX_UPPER) + } + }; + self } - /// Creates a new bytes literal with the given values that represents an - /// implicitly concatenated bytes. - /// - /// # Panics - /// - /// Panics if `values` is less than 2. Use [`BytesLiteralValue::single`] - /// instead. - pub fn concatenated(values: Vec<BytesLiteral>) -> Self { - assert!(values.len() > 1); - Self { - inner: BytesLiteralValueInner::Concatenated(values), - } + pub fn new(prefix: AnyStringPrefix, quotes: Quote, triple_quotes: TripleQuotes) -> Self { + Self(AnyStringFlagsInner::empty()) + .with_prefix(prefix) + .with_quote_style(quotes) + .with_triple_quotes(triple_quotes) } - /// Returns `true` if the bytes literal is implicitly concatenated. - pub const fn is_implicit_concatenated(&self) -> bool { - matches!(self.inner, BytesLiteralValueInner::Concatenated(_)) + /// Does the string have a `u` or `U` prefix? + pub const fn is_u_string(self) -> bool { + self.0.contains(AnyStringFlagsInner::U_PREFIX) } - /// Returns a slice of all the [`BytesLiteral`] parts contained in this value. - pub fn as_slice(&self) -> &[BytesLiteral] { - match &self.inner { - BytesLiteralValueInner::Single(value) => std::slice::from_ref(value), - BytesLiteralValueInner::Concatenated(value) => value.as_slice(), - } + /// Does the string have an `r` or `R` prefix? + pub const fn is_raw_string(self) -> bool { + self.0.intersects( + AnyStringFlagsInner::R_PREFIX_LOWER.union(AnyStringFlagsInner::R_PREFIX_UPPER), + ) } - /// Returns a mutable slice of all the [`BytesLiteral`] parts contained in this value. - fn as_mut_slice(&mut self) -> &mut [BytesLiteral] { - match &mut self.inner { - BytesLiteralValueInner::Single(value) => std::slice::from_mut(value), - BytesLiteralValueInner::Concatenated(value) => value.as_mut_slice(), + /// Does the string have an `f` or `F` prefix? + pub const fn is_f_string(self) -> bool { + self.0.contains(AnyStringFlagsInner::F_PREFIX) + } + + /// Does the string have a `b` or `B` prefix? + pub const fn is_byte_string(self) -> bool { + self.0.contains(AnyStringFlagsInner::B_PREFIX) + } + + #[must_use] + pub fn with_quote_style(mut self, quotes: Quote) -> Self { + match quotes { + Quote::Double => self.0 |= AnyStringFlagsInner::DOUBLE, + Quote::Single => self.0 -= AnyStringFlagsInner::DOUBLE, } + self } - /// Returns an iterator over all the [`BytesLiteral`] parts contained in this value. - pub fn iter(&self) -> Iter<BytesLiteral> { - self.as_slice().iter() + #[must_use] + pub fn with_triple_quotes(mut self, triple_quotes: TripleQuotes) -> Self { + self.0 + .set(AnyStringFlagsInner::TRIPLE_QUOTED, triple_quotes.is_yes()); + self } +} - /// Returns an iterator over all the [`BytesLiteral`] parts contained in this value - /// that allows modification. - pub fn iter_mut(&mut self) -> IterMut<BytesLiteral> { - self.as_mut_slice().iter_mut() +impl StringFlags for AnyStringFlags { + /// Does the string use single or double quotes in its opener and closer? + fn quote_style(self) -> Quote { + if self.0.contains(AnyStringFlagsInner::DOUBLE) { + Quote::Double + } else { + Quote::Single + } } - /// Returns `true` if the concatenated bytes has a length of zero. - pub fn is_empty(&self) -> bool { - self.iter().all(|part| part.is_empty()) + fn triple_quotes(self) -> TripleQuotes { + if self.0.contains(AnyStringFlagsInner::TRIPLE_QUOTED) { + TripleQuotes::Yes + } else { + TripleQuotes::No + } } - /// Returns the length of the concatenated bytes. - pub fn len(&self) -> usize { - self.iter().map(|part| part.len()).sum() + fn prefix(self) -> AnyStringPrefix { + let AnyStringFlags(flags) = self; + + // f-strings + if flags.contains(AnyStringFlagsInner::F_PREFIX) { + if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { + return AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: false }); + } + if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { + return AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: true }); + } + return AnyStringPrefix::Format(FStringPrefix::Regular); + } + + // bytestrings + if flags.contains(AnyStringFlagsInner::B_PREFIX) { + if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { + return AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: false }); + } + if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { + return AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: true }); + } + return AnyStringPrefix::Bytes(ByteStringPrefix::Regular); + } + + // all other strings + if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { + return AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: false }); + } + if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { + return AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: true }); + } + if flags.contains(AnyStringFlagsInner::U_PREFIX) { + return AnyStringPrefix::Regular(StringLiteralPrefix::Unicode); + } + AnyStringPrefix::Regular(StringLiteralPrefix::Empty) } +} - /// Returns an iterator over the bytes of the concatenated bytes. - pub fn bytes(&self) -> impl Iterator<Item = u8> + '_ { - self.iter().flat_map(|part| part.as_slice().iter().copied()) +impl fmt::Debug for AnyStringFlags { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("AnyStringFlags") + .field("prefix", &self.prefix()) + .field("triple_quoted", &self.is_triple_quoted()) + .field("quote_style", &self.quote_style()) + .finish() } } -impl<'a> IntoIterator for &'a BytesLiteralValue { - type Item = &'a BytesLiteral; - type IntoIter = Iter<'a, BytesLiteral>; +impl From<AnyStringFlags> for StringLiteralFlags { + fn from(value: AnyStringFlags) -> StringLiteralFlags { + let AnyStringPrefix::Regular(prefix) = value.prefix() else { + unreachable!( + "Should never attempt to convert {} into a regular string", + value.prefix() + ) + }; + StringLiteralFlags::empty() + .with_quote_style(value.quote_style()) + .with_prefix(prefix) + .with_triple_quotes(value.triple_quotes()) + } +} - fn into_iter(self) -> Self::IntoIter { - self.iter() +impl From<StringLiteralFlags> for AnyStringFlags { + fn from(value: StringLiteralFlags) -> Self { + value.as_any_string_flags() } } -impl<'a> IntoIterator for &'a mut BytesLiteralValue { - type Item = &'a mut BytesLiteral; - type IntoIter = IterMut<'a, BytesLiteral>; - fn into_iter(self) -> Self::IntoIter { - self.iter_mut() +impl From<AnyStringFlags> for BytesLiteralFlags { + fn from(value: AnyStringFlags) -> BytesLiteralFlags { + let AnyStringPrefix::Bytes(bytestring_prefix) = value.prefix() else { + unreachable!( + "Should never attempt to convert {} into a bytestring", + value.prefix() + ) + }; + BytesLiteralFlags::empty() + .with_quote_style(value.quote_style()) + .with_prefix(bytestring_prefix) + .with_triple_quotes(value.triple_quotes()) } } -impl PartialEq<[u8]> for BytesLiteralValue { - fn eq(&self, other: &[u8]) -> bool { - if self.len() != other.len() { - return false; - } - // The `zip` here is safe because we have checked the length of both parts. - self.bytes() - .zip(other.iter().copied()) - .all(|(b1, b2)| b1 == b2) +impl From<BytesLiteralFlags> for AnyStringFlags { + fn from(value: BytesLiteralFlags) -> Self { + value.as_any_string_flags() } } -impl<'a> From<&'a BytesLiteralValue> for Cow<'a, [u8]> { - fn from(value: &'a BytesLiteralValue) -> Self { - match &value.inner { - BytesLiteralValueInner::Single(BytesLiteral { - value: bytes_value, .. - }) => Cow::from(bytes_value.as_ref()), - BytesLiteralValueInner::Concatenated(bytes_literal_vec) => Cow::Owned( - bytes_literal_vec - .iter() - .flat_map(|bytes_literal| bytes_literal.value.to_vec()) - .collect::<Vec<u8>>(), - ), - } +impl From<AnyStringFlags> for FStringFlags { + fn from(value: AnyStringFlags) -> FStringFlags { + let AnyStringPrefix::Format(fstring_prefix) = value.prefix() else { + unreachable!( + "Should never attempt to convert {} into an f-string", + value.prefix() + ) + }; + FStringFlags::empty() + .with_quote_style(value.quote_style()) + .with_prefix(fstring_prefix) + .with_triple_quotes(value.triple_quotes()) } } -/// An internal representation of [`BytesLiteralValue`]. -#[derive(Clone, Debug, PartialEq)] -enum BytesLiteralValueInner { - /// A single bytes literal i.e., `b"foo"`. - Single(BytesLiteral), +impl From<FStringFlags> for AnyStringFlags { + fn from(value: FStringFlags) -> Self { + value.as_any_string_flags() + } +} - /// An implicitly concatenated bytes literals i.e., `b"foo" b"bar"`. - Concatenated(Vec<BytesLiteral>), +#[derive(Clone, Debug, PartialEq, is_macro::Is)] +pub enum Number { + Int(int::Int), + Float(f64), + Complex { real: f64, imag: f64 }, } -impl Default for BytesLiteralValueInner { - fn default() -> Self { - Self::Single(BytesLiteral::default()) +impl ExprName { + pub fn id(&self) -> &Name { + &self.id + } + + /// Returns `true` if this node represents an invalid name i.e., the `ctx` is [`Invalid`]. + /// + /// [`Invalid`]: ExprContext::Invalid + pub const fn is_invalid(&self) -> bool { + matches!(self.ctx, ExprContext::Invalid) } } -bitflags! { - #[derive(Default, Copy, Clone, PartialEq, Eq, Hash)] - struct BytesLiteralFlagsInner: u8 { - /// The bytestring uses double quotes (e.g. `b"foo"`). - /// If this flag is not set, the bytestring uses single quotes (e.g. `b'foo'`). - const DOUBLE = 1 << 0; - - /// The bytestring is triple-quoted (e.g. `b"""foo"""`): - /// it begins and ends with three consecutive quote characters. - const TRIPLE_QUOTED = 1 << 1; - - /// The bytestring has an `r` prefix (e.g. `rb"foo"`), - /// meaning it is a raw bytestring with a lowercase 'r'. - const R_PREFIX_LOWER = 1 << 2; +impl ExprList { + pub fn iter(&self) -> std::slice::Iter<'_, Expr> { + self.elts.iter() + } - /// The bytestring has an `R` prefix (e.g. `Rb"foo"`), - /// meaning it is a raw bytestring with an uppercase 'R'. - /// See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings - /// for why we track the casing of the `r` prefix, but not for any other prefix - const R_PREFIX_UPPER = 1 << 3; + pub fn len(&self) -> usize { + self.elts.len() + } - /// The bytestring was deemed invalid by the parser. - const INVALID = 1 << 4; + pub fn is_empty(&self) -> bool { + self.elts.is_empty() } } -/// Flags that can be queried to obtain information -/// regarding the prefixes and quotes used for a bytes literal. -#[derive(Default, Copy, Clone, Eq, PartialEq, Hash)] -pub struct BytesLiteralFlags(BytesLiteralFlagsInner); +impl<'a> IntoIterator for &'a ExprList { + type IntoIter = std::slice::Iter<'a, Expr>; + type Item = &'a Expr; -impl BytesLiteralFlags { - #[must_use] - pub fn with_quote_style(mut self, quote_style: Quote) -> Self { - self.0 - .set(BytesLiteralFlagsInner::DOUBLE, quote_style.is_double()); - self + fn into_iter(self) -> Self::IntoIter { + self.iter() } +} - #[must_use] - pub fn with_triple_quotes(mut self) -> Self { - self.0 |= BytesLiteralFlagsInner::TRIPLE_QUOTED; - self +impl ExprTuple { + pub fn iter(&self) -> std::slice::Iter<'_, Expr> { + self.elts.iter() } - #[must_use] - pub fn with_prefix(mut self, prefix: ByteStringPrefix) -> Self { - match prefix { - ByteStringPrefix::Regular => { - self.0 -= BytesLiteralFlagsInner::R_PREFIX_LOWER; - self.0 -= BytesLiteralFlagsInner::R_PREFIX_UPPER; - } - ByteStringPrefix::Raw { uppercase_r } => { - self.0 - .set(BytesLiteralFlagsInner::R_PREFIX_UPPER, uppercase_r); - self.0 - .set(BytesLiteralFlagsInner::R_PREFIX_LOWER, !uppercase_r); - } - }; - self + pub fn len(&self) -> usize { + self.elts.len() } - #[must_use] - pub fn with_invalid(mut self) -> Self { - self.0 |= BytesLiteralFlagsInner::INVALID; - self + pub fn is_empty(&self) -> bool { + self.elts.is_empty() } +} - pub const fn prefix(self) -> ByteStringPrefix { - if self.0.contains(BytesLiteralFlagsInner::R_PREFIX_LOWER) { - debug_assert!(!self.0.contains(BytesLiteralFlagsInner::R_PREFIX_UPPER)); - ByteStringPrefix::Raw { uppercase_r: false } - } else if self.0.contains(BytesLiteralFlagsInner::R_PREFIX_UPPER) { - ByteStringPrefix::Raw { uppercase_r: true } - } else { - ByteStringPrefix::Regular - } +impl<'a> IntoIterator for &'a ExprTuple { + type IntoIter = std::slice::Iter<'a, Expr>; + type Item = &'a Expr; + + fn into_iter(self) -> Self::IntoIter { + self.iter() } } -impl StringFlags for BytesLiteralFlags { - /// Return `true` if the bytestring is triple-quoted, i.e., - /// it begins and ends with three consecutive quote characters. - /// For example: `b"""{bar}"""` - fn is_triple_quoted(self) -> bool { - self.0.contains(BytesLiteralFlagsInner::TRIPLE_QUOTED) - } +/// See also [expr_context](https://docs.python.org/3/library/ast.html#ast.expr_context) +#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] +pub enum ExprContext { + Load, + Store, + Del, + Invalid, +} - /// Return the quoting style (single or double quotes) - /// used by the bytestring's opener and closer: - /// - `b"a"` -> `QuoteStyle::Double` - /// - `b'a'` -> `QuoteStyle::Single` - fn quote_style(self) -> Quote { - if self.0.contains(BytesLiteralFlagsInner::DOUBLE) { - Quote::Double - } else { - Quote::Single - } - } +/// See also [boolop](https://docs.python.org/3/library/ast.html#ast.BoolOp) +#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] +pub enum BoolOp { + And, + Or, +} - fn prefix(self) -> AnyStringPrefix { - AnyStringPrefix::Bytes(self.prefix()) +impl BoolOp { + pub const fn as_str(&self) -> &'static str { + match self { + BoolOp::And => "and", + BoolOp::Or => "or", + } } } -impl fmt::Debug for BytesLiteralFlags { +impl fmt::Display for BoolOp { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("BytesLiteralFlags") - .field("quote_style", &self.quote_style()) - .field("prefix", &self.prefix()) - .field("triple_quoted", &self.is_triple_quoted()) - .finish() + f.write_str(self.as_str()) } } -/// An AST node that represents a single bytes literal which is part of an -/// [`ExprBytesLiteral`]. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct BytesLiteral { - pub range: TextRange, - pub value: Box<[u8]>, - pub flags: BytesLiteralFlags, +/// See also [operator](https://docs.python.org/3/library/ast.html#ast.operator) +#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] +pub enum Operator { + Add, + Sub, + Mult, + MatMult, + Div, + Mod, + Pow, + LShift, + RShift, + BitOr, + BitXor, + BitAnd, + FloorDiv, } -impl Ranged for BytesLiteral { - fn range(&self) -> TextRange { - self.range +impl Operator { + pub const fn as_str(&self) -> &'static str { + match self { + Operator::Add => "+", + Operator::Sub => "-", + Operator::Mult => "*", + Operator::MatMult => "@", + Operator::Div => "/", + Operator::Mod => "%", + Operator::Pow => "**", + Operator::LShift => "<<", + Operator::RShift => ">>", + Operator::BitOr => "|", + Operator::BitXor => "^", + Operator::BitAnd => "&", + Operator::FloorDiv => "//", + } } -} -impl Deref for BytesLiteral { - type Target = [u8]; + /// Returns the dunder method name for the operator. + pub const fn dunder(self) -> &'static str { + match self { + Operator::Add => "__add__", + Operator::Sub => "__sub__", + Operator::Mult => "__mul__", + Operator::MatMult => "__matmul__", + Operator::Div => "__truediv__", + Operator::Mod => "__mod__", + Operator::Pow => "__pow__", + Operator::LShift => "__lshift__", + Operator::RShift => "__rshift__", + Operator::BitOr => "__or__", + Operator::BitXor => "__xor__", + Operator::BitAnd => "__and__", + Operator::FloorDiv => "__floordiv__", + } + } - fn deref(&self) -> &Self::Target { - &self.value + /// Returns the in-place dunder method name for the operator. + pub const fn in_place_dunder(self) -> &'static str { + match self { + Operator::Add => "__iadd__", + Operator::Sub => "__isub__", + Operator::Mult => "__imul__", + Operator::MatMult => "__imatmul__", + Operator::Div => "__itruediv__", + Operator::Mod => "__imod__", + Operator::Pow => "__ipow__", + Operator::LShift => "__ilshift__", + Operator::RShift => "__irshift__", + Operator::BitOr => "__ior__", + Operator::BitXor => "__ixor__", + Operator::BitAnd => "__iand__", + Operator::FloorDiv => "__ifloordiv__", + } + } + + /// Returns the reflected dunder method name for the operator. + pub const fn reflected_dunder(self) -> &'static str { + match self { + Operator::Add => "__radd__", + Operator::Sub => "__rsub__", + Operator::Mult => "__rmul__", + Operator::MatMult => "__rmatmul__", + Operator::Div => "__rtruediv__", + Operator::Mod => "__rmod__", + Operator::Pow => "__rpow__", + Operator::LShift => "__rlshift__", + Operator::RShift => "__rrshift__", + Operator::BitOr => "__ror__", + Operator::BitXor => "__rxor__", + Operator::BitAnd => "__rand__", + Operator::FloorDiv => "__rfloordiv__", + } } } -impl BytesLiteral { - /// Extracts a byte slice containing the entire [`BytesLiteral`]. - pub fn as_slice(&self) -> &[u8] { - self +impl fmt::Display for Operator { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.as_str()) } +} - /// Creates a new invalid bytes literal with the given range. - pub fn invalid(range: TextRange) -> Self { - Self { - range, - value: Box::new([]), - flags: BytesLiteralFlags::default().with_invalid(), +/// See also [unaryop](https://docs.python.org/3/library/ast.html#ast.unaryop) +#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] +pub enum UnaryOp { + Invert, + Not, + UAdd, + USub, +} + +impl UnaryOp { + pub const fn as_str(&self) -> &'static str { + match self { + UnaryOp::Invert => "~", + UnaryOp::Not => "not", + UnaryOp::UAdd => "+", + UnaryOp::USub => "-", } } } -impl From<BytesLiteral> for Expr { - fn from(payload: BytesLiteral) -> Self { - ExprBytesLiteral { - range: payload.range, - value: BytesLiteralValue::single(payload), - } - .into() +impl fmt::Display for UnaryOp { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.as_str()) } } -bitflags! { - /// Flags that can be queried to obtain information - /// regarding the prefixes and quotes used for a string literal. - /// - /// Note that not all of these flags can be validly combined -- e.g., - /// it is invalid to combine the `U_PREFIX` flag with any other - /// of the `*_PREFIX` flags. As such, the recommended way to set the - /// prefix flags is by calling the `as_flags()` method on the - /// `StringPrefix` enum. - #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)] - struct AnyStringFlagsInner: u8 { - /// The string uses double quotes (`"`). - /// If this flag is not set, the string uses single quotes (`'`). - const DOUBLE = 1 << 0; - - /// The string is triple-quoted: - /// it begins and ends with three consecutive quote characters. - const TRIPLE_QUOTED = 1 << 1; - - /// The string has a `u` or `U` prefix. - /// While this prefix is a no-op at runtime, - /// strings with this prefix can have no other prefixes set. - const U_PREFIX = 1 << 2; - - /// The string has a `b` or `B` prefix. - /// This means that the string is a sequence of `int`s at runtime, - /// rather than a sequence of `str`s. - /// Strings with this flag can also be raw strings, - /// but can have no other prefixes. - const B_PREFIX = 1 << 3; - - /// The string has a `f` or `F` prefix, meaning it is an f-string. - /// F-strings can also be raw strings, - /// but can have no other prefixes. - const F_PREFIX = 1 << 4; - - /// The string has an `r` prefix, meaning it is a raw string. - /// F-strings and byte-strings can be raw, - /// as can strings with no other prefixes. - /// U-strings cannot be raw. - const R_PREFIX_LOWER = 1 << 5; - - /// The string has an `R` prefix, meaning it is a raw string. - /// The casing of the `r`/`R` has no semantic significance at runtime; - /// see https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#r-strings-and-r-strings - /// for why we track the casing of the `r` prefix, - /// but not for any other prefix - const R_PREFIX_UPPER = 1 << 6; - } -} - -#[derive(Default, Clone, Copy, PartialEq, Eq, Hash)] -pub struct AnyStringFlags(AnyStringFlagsInner); - -impl AnyStringFlags { - #[must_use] - pub fn with_prefix(mut self, prefix: AnyStringPrefix) -> Self { - self.0 |= match prefix { - // regular strings - AnyStringPrefix::Regular(StringLiteralPrefix::Empty) => AnyStringFlagsInner::empty(), - AnyStringPrefix::Regular(StringLiteralPrefix::Unicode) => AnyStringFlagsInner::U_PREFIX, - AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: false }) => { - AnyStringFlagsInner::R_PREFIX_LOWER - } - AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: true }) => { - AnyStringFlagsInner::R_PREFIX_UPPER - } - - // bytestrings - AnyStringPrefix::Bytes(ByteStringPrefix::Regular) => AnyStringFlagsInner::B_PREFIX, - AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: false }) => { - AnyStringFlagsInner::B_PREFIX.union(AnyStringFlagsInner::R_PREFIX_LOWER) - } - AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: true }) => { - AnyStringFlagsInner::B_PREFIX.union(AnyStringFlagsInner::R_PREFIX_UPPER) - } - - // f-strings - AnyStringPrefix::Format(FStringPrefix::Regular) => AnyStringFlagsInner::F_PREFIX, - AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: false }) => { - AnyStringFlagsInner::F_PREFIX.union(AnyStringFlagsInner::R_PREFIX_LOWER) - } - AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: true }) => { - AnyStringFlagsInner::F_PREFIX.union(AnyStringFlagsInner::R_PREFIX_UPPER) - } - }; - self - } - - pub fn new(prefix: AnyStringPrefix, quotes: Quote, triple_quoted: bool) -> Self { - let new = Self::default().with_prefix(prefix).with_quote_style(quotes); - if triple_quoted { - new.with_triple_quotes() - } else { - new - } - } - - /// Does the string have a `u` or `U` prefix? - pub const fn is_u_string(self) -> bool { - self.0.contains(AnyStringFlagsInner::U_PREFIX) - } - - /// Does the string have an `r` or `R` prefix? - pub const fn is_raw_string(self) -> bool { - self.0.intersects( - AnyStringFlagsInner::R_PREFIX_LOWER.union(AnyStringFlagsInner::R_PREFIX_UPPER), - ) - } - - /// Does the string have an `f` or `F` prefix? - pub const fn is_f_string(self) -> bool { - self.0.contains(AnyStringFlagsInner::F_PREFIX) - } - - /// Does the string have a `b` or `B` prefix? - pub const fn is_byte_string(self) -> bool { - self.0.contains(AnyStringFlagsInner::B_PREFIX) - } - - #[must_use] - pub fn with_quote_style(mut self, quotes: Quote) -> Self { - match quotes { - Quote::Double => self.0 |= AnyStringFlagsInner::DOUBLE, - Quote::Single => self.0 -= AnyStringFlagsInner::DOUBLE, - }; - self - } - - #[must_use] - pub fn with_triple_quotes(mut self) -> Self { - self.0 |= AnyStringFlagsInner::TRIPLE_QUOTED; - self - } -} - -impl StringFlags for AnyStringFlags { - /// Does the string use single or double quotes in its opener and closer? - fn quote_style(self) -> Quote { - if self.0.contains(AnyStringFlagsInner::DOUBLE) { - Quote::Double - } else { - Quote::Single - } - } - - /// Is the string triple-quoted, i.e., - /// does it begin and end with three consecutive quote characters? - fn is_triple_quoted(self) -> bool { - self.0.contains(AnyStringFlagsInner::TRIPLE_QUOTED) - } - - fn prefix(self) -> AnyStringPrefix { - let AnyStringFlags(flags) = self; - - // f-strings - if flags.contains(AnyStringFlagsInner::F_PREFIX) { - if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { - return AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: false }); - } - if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { - return AnyStringPrefix::Format(FStringPrefix::Raw { uppercase_r: true }); - } - return AnyStringPrefix::Format(FStringPrefix::Regular); - } - - // bytestrings - if flags.contains(AnyStringFlagsInner::B_PREFIX) { - if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { - return AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: false }); - } - if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { - return AnyStringPrefix::Bytes(ByteStringPrefix::Raw { uppercase_r: true }); - } - return AnyStringPrefix::Bytes(ByteStringPrefix::Regular); - } - - // all other strings - if flags.contains(AnyStringFlagsInner::R_PREFIX_LOWER) { - return AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: false }); - } - if flags.contains(AnyStringFlagsInner::R_PREFIX_UPPER) { - return AnyStringPrefix::Regular(StringLiteralPrefix::Raw { uppercase: true }); - } - if flags.contains(AnyStringFlagsInner::U_PREFIX) { - return AnyStringPrefix::Regular(StringLiteralPrefix::Unicode); - } - AnyStringPrefix::Regular(StringLiteralPrefix::Empty) - } -} - -impl fmt::Debug for AnyStringFlags { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("AnyStringFlags") - .field("prefix", &self.prefix()) - .field("triple_quoted", &self.is_triple_quoted()) - .field("quote_style", &self.quote_style()) - .finish() - } -} - -impl From<AnyStringFlags> for StringLiteralFlags { - fn from(value: AnyStringFlags) -> StringLiteralFlags { - let AnyStringPrefix::Regular(prefix) = value.prefix() else { - unreachable!( - "Should never attempt to convert {} into a regular string", - value.prefix() - ) - }; - let new = StringLiteralFlags::default() - .with_quote_style(value.quote_style()) - .with_prefix(prefix); - if value.is_triple_quoted() { - new.with_triple_quotes() - } else { - new - } - } -} - -impl From<StringLiteralFlags> for AnyStringFlags { - fn from(value: StringLiteralFlags) -> Self { - Self::new( - AnyStringPrefix::Regular(value.prefix()), - value.quote_style(), - value.is_triple_quoted(), - ) - } -} - -impl From<AnyStringFlags> for BytesLiteralFlags { - fn from(value: AnyStringFlags) -> BytesLiteralFlags { - let AnyStringPrefix::Bytes(bytestring_prefix) = value.prefix() else { - unreachable!( - "Should never attempt to convert {} into a bytestring", - value.prefix() - ) - }; - let new = BytesLiteralFlags::default() - .with_quote_style(value.quote_style()) - .with_prefix(bytestring_prefix); - if value.is_triple_quoted() { - new.with_triple_quotes() - } else { - new - } - } -} - -impl From<BytesLiteralFlags> for AnyStringFlags { - fn from(value: BytesLiteralFlags) -> Self { - Self::new( - AnyStringPrefix::Bytes(value.prefix()), - value.quote_style(), - value.is_triple_quoted(), - ) - } -} - -impl From<AnyStringFlags> for FStringFlags { - fn from(value: AnyStringFlags) -> FStringFlags { - let AnyStringPrefix::Format(fstring_prefix) = value.prefix() else { - unreachable!( - "Should never attempt to convert {} into an f-string", - value.prefix() - ) - }; - let new = FStringFlags::default() - .with_quote_style(value.quote_style()) - .with_prefix(fstring_prefix); - if value.is_triple_quoted() { - new.with_triple_quotes() - } else { - new - } - } -} - -impl From<FStringFlags> for AnyStringFlags { - fn from(value: FStringFlags) -> Self { - Self::new( - AnyStringPrefix::Format(value.prefix()), - value.quote_style(), - value.is_triple_quoted(), - ) - } -} - -#[derive(Clone, Debug, PartialEq)] -pub struct ExprNumberLiteral { - pub range: TextRange, - pub value: Number, -} - -impl From<ExprNumberLiteral> for Expr { - fn from(payload: ExprNumberLiteral) -> Self { - Expr::NumberLiteral(payload) - } -} - -impl Ranged for ExprNumberLiteral { - fn range(&self) -> TextRange { - self.range - } -} - -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum Number { - Int(int::Int), - Float(f64), - Complex { real: f64, imag: f64 }, -} - -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ExprBooleanLiteral { - pub range: TextRange, - pub value: bool, -} - -impl From<ExprBooleanLiteral> for Expr { - fn from(payload: ExprBooleanLiteral) -> Self { - Expr::BooleanLiteral(payload) - } -} - -impl Ranged for ExprBooleanLiteral { - fn range(&self) -> TextRange { - self.range - } -} - -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ExprNoneLiteral { - pub range: TextRange, -} - -impl From<ExprNoneLiteral> for Expr { - fn from(payload: ExprNoneLiteral) -> Self { - Expr::NoneLiteral(payload) - } -} - -impl Ranged for ExprNoneLiteral { - fn range(&self) -> TextRange { - self.range - } -} - -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ExprEllipsisLiteral { - pub range: TextRange, -} - -impl From<ExprEllipsisLiteral> for Expr { - fn from(payload: ExprEllipsisLiteral) -> Self { - Expr::EllipsisLiteral(payload) - } -} - -impl Ranged for ExprEllipsisLiteral { - fn range(&self) -> TextRange { - self.range - } -} - -/// See also [Attribute](https://docs.python.org/3/library/ast.html#ast.Attribute) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprAttribute { - pub range: TextRange, - pub value: Box<Expr>, - pub attr: Identifier, - pub ctx: ExprContext, -} - -impl From<ExprAttribute> for Expr { - fn from(payload: ExprAttribute) -> Self { - Expr::Attribute(payload) - } -} - -/// See also [Subscript](https://docs.python.org/3/library/ast.html#ast.Subscript) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprSubscript { - pub range: TextRange, - pub value: Box<Expr>, - pub slice: Box<Expr>, - pub ctx: ExprContext, -} - -impl From<ExprSubscript> for Expr { - fn from(payload: ExprSubscript) -> Self { - Expr::Subscript(payload) - } -} - -/// See also [Starred](https://docs.python.org/3/library/ast.html#ast.Starred) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprStarred { - pub range: TextRange, - pub value: Box<Expr>, - pub ctx: ExprContext, -} - -impl From<ExprStarred> for Expr { - fn from(payload: ExprStarred) -> Self { - Expr::Starred(payload) - } -} - -/// See also [Name](https://docs.python.org/3/library/ast.html#ast.Name) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprName { - pub range: TextRange, - pub id: Name, - pub ctx: ExprContext, -} - -impl ExprName { - pub fn id(&self) -> &Name { - &self.id - } -} - -impl From<ExprName> for Expr { - fn from(payload: ExprName) -> Self { - Expr::Name(payload) - } -} - -/// See also [List](https://docs.python.org/3/library/ast.html#ast.List) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprList { - pub range: TextRange, - pub elts: Vec<Expr>, - pub ctx: ExprContext, -} - -impl ExprList { - pub fn iter(&self) -> std::slice::Iter<'_, Expr> { - self.elts.iter() - } - - pub fn len(&self) -> usize { - self.elts.len() - } - - pub fn is_empty(&self) -> bool { - self.elts.is_empty() - } -} - -impl<'a> IntoIterator for &'a ExprList { - type IntoIter = std::slice::Iter<'a, Expr>; - type Item = &'a Expr; - - fn into_iter(self) -> Self::IntoIter { - self.iter() - } -} - -impl From<ExprList> for Expr { - fn from(payload: ExprList) -> Self { - Expr::List(payload) - } -} - -/// See also [Tuple](https://docs.python.org/3/library/ast.html#ast.Tuple) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprTuple { - pub range: TextRange, - pub elts: Vec<Expr>, - pub ctx: ExprContext, - - /// Whether the tuple is parenthesized in the source code. - pub parenthesized: bool, -} - -impl ExprTuple { - pub fn iter(&self) -> std::slice::Iter<'_, Expr> { - self.elts.iter() - } - - pub fn len(&self) -> usize { - self.elts.len() - } - - pub fn is_empty(&self) -> bool { - self.elts.is_empty() - } -} - -impl<'a> IntoIterator for &'a ExprTuple { - type IntoIter = std::slice::Iter<'a, Expr>; - type Item = &'a Expr; - - fn into_iter(self) -> Self::IntoIter { - self.iter() - } -} - -impl From<ExprTuple> for Expr { - fn from(payload: ExprTuple) -> Self { - Expr::Tuple(payload) - } -} - -/// See also [Slice](https://docs.python.org/3/library/ast.html#ast.Slice) -#[derive(Clone, Debug, PartialEq)] -pub struct ExprSlice { - pub range: TextRange, - pub lower: Option<Box<Expr>>, - pub upper: Option<Box<Expr>>, - pub step: Option<Box<Expr>>, -} - -impl From<ExprSlice> for Expr { - fn from(payload: ExprSlice) -> Self { - Expr::Slice(payload) - } -} - -/// See also [expr_context](https://docs.python.org/3/library/ast.html#ast.expr_context) -#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] -pub enum ExprContext { - Load, - Store, - Del, - Invalid, -} - -/// See also [boolop](https://docs.python.org/3/library/ast.html#ast.BoolOp) -#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] -pub enum BoolOp { - And, - Or, -} - -impl BoolOp { - pub const fn as_str(&self) -> &'static str { - match self { - BoolOp::And => "and", - BoolOp::Or => "or", - } - } -} - -impl fmt::Display for BoolOp { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.as_str()) - } -} - -/// See also [operator](https://docs.python.org/3/library/ast.html#ast.operator) -#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] -pub enum Operator { - Add, - Sub, - Mult, - MatMult, - Div, - Mod, - Pow, - LShift, - RShift, - BitOr, - BitXor, - BitAnd, - FloorDiv, -} - -impl Operator { - pub const fn as_str(&self) -> &'static str { - match self { - Operator::Add => "+", - Operator::Sub => "-", - Operator::Mult => "*", - Operator::MatMult => "@", - Operator::Div => "/", - Operator::Mod => "%", - Operator::Pow => "**", - Operator::LShift => "<<", - Operator::RShift => ">>", - Operator::BitOr => "|", - Operator::BitXor => "^", - Operator::BitAnd => "&", - Operator::FloorDiv => "//", - } - } - - pub const fn dunder(self) -> &'static str { - match self { - Operator::Add => "__add__", - Operator::Sub => "__sub__", - Operator::Mult => "__mul__", - Operator::MatMult => "__matmul__", - Operator::Div => "__truediv__", - Operator::Mod => "__mod__", - Operator::Pow => "__pow__", - Operator::LShift => "__lshift__", - Operator::RShift => "__rshift__", - Operator::BitOr => "__or__", - Operator::BitXor => "__xor__", - Operator::BitAnd => "__and__", - Operator::FloorDiv => "__floordiv__", - } - } - - pub const fn reflected_dunder(self) -> &'static str { - match self { - Operator::Add => "__radd__", - Operator::Sub => "__rsub__", - Operator::Mult => "__rmul__", - Operator::MatMult => "__rmatmul__", - Operator::Div => "__rtruediv__", - Operator::Mod => "__rmod__", - Operator::Pow => "__rpow__", - Operator::LShift => "__rlshift__", - Operator::RShift => "__rrshift__", - Operator::BitOr => "__ror__", - Operator::BitXor => "__rxor__", - Operator::BitAnd => "__rand__", - Operator::FloorDiv => "__rfloordiv__", - } - } -} - -impl fmt::Display for Operator { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.as_str()) - } -} - -/// See also [unaryop](https://docs.python.org/3/library/ast.html#ast.unaryop) -#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] -pub enum UnaryOp { - Invert, - Not, - UAdd, - USub, -} - -impl UnaryOp { - pub const fn as_str(&self) -> &'static str { - match self { - UnaryOp::Invert => "~", - UnaryOp::Not => "not", - UnaryOp::UAdd => "+", - UnaryOp::USub => "-", - } - } -} - -impl fmt::Display for UnaryOp { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.as_str()) - } -} - -/// See also [cmpop](https://docs.python.org/3/library/ast.html#ast.cmpop) -#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] -pub enum CmpOp { - Eq, - NotEq, - Lt, - LtE, - Gt, - GtE, - Is, - IsNot, - In, - NotIn, -} - -impl CmpOp { - pub const fn as_str(&self) -> &'static str { - match self { - CmpOp::Eq => "==", - CmpOp::NotEq => "!=", - CmpOp::Lt => "<", - CmpOp::LtE => "<=", - CmpOp::Gt => ">", - CmpOp::GtE => ">=", - CmpOp::Is => "is", - CmpOp::IsNot => "is not", - CmpOp::In => "in", - CmpOp::NotIn => "not in", - } - } - - #[must_use] - pub const fn negate(&self) -> Self { - match self { - CmpOp::Eq => CmpOp::NotEq, - CmpOp::NotEq => CmpOp::Eq, - CmpOp::Lt => CmpOp::GtE, - CmpOp::LtE => CmpOp::Gt, - CmpOp::Gt => CmpOp::LtE, - CmpOp::GtE => CmpOp::Lt, - CmpOp::Is => CmpOp::IsNot, - CmpOp::IsNot => CmpOp::Is, - CmpOp::In => CmpOp::NotIn, - CmpOp::NotIn => CmpOp::In, - } - } -} - -impl fmt::Display for CmpOp { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.as_str()) - } -} - -/// See also [comprehension](https://docs.python.org/3/library/ast.html#ast.comprehension) -#[derive(Clone, Debug, PartialEq)] -pub struct Comprehension { - pub range: TextRange, - pub target: Expr, - pub iter: Expr, - pub ifs: Vec<Expr>, - pub is_async: bool, -} - -/// See also [excepthandler](https://docs.python.org/3/library/ast.html#ast.excepthandler) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum ExceptHandler { - ExceptHandler(ExceptHandlerExceptHandler), -} - -/// See also [ExceptHandler](https://docs.python.org/3/library/ast.html#ast.ExceptHandler) -#[derive(Clone, Debug, PartialEq)] -pub struct ExceptHandlerExceptHandler { - pub range: TextRange, - pub type_: Option<Box<Expr>>, - pub name: Option<Identifier>, - pub body: Vec<Stmt>, -} - -impl From<ExceptHandlerExceptHandler> for ExceptHandler { - fn from(payload: ExceptHandlerExceptHandler) -> Self { - ExceptHandler::ExceptHandler(payload) - } -} - -/// See also [arg](https://docs.python.org/3/library/ast.html#ast.arg) -#[derive(Clone, Debug, PartialEq)] -pub struct Parameter { - pub range: TextRange, - pub name: Identifier, - pub annotation: Option<Box<Expr>>, -} - -/// See also [keyword](https://docs.python.org/3/library/ast.html#ast.keyword) -#[derive(Clone, Debug, PartialEq)] -pub struct Keyword { - pub range: TextRange, - pub arg: Option<Identifier>, - pub value: Expr, -} - -/// See also [alias](https://docs.python.org/3/library/ast.html#ast.alias) -#[derive(Clone, Debug, PartialEq)] -pub struct Alias { - pub range: TextRange, - pub name: Identifier, - pub asname: Option<Identifier>, -} - -/// See also [withitem](https://docs.python.org/3/library/ast.html#ast.withitem) -#[derive(Clone, Debug, PartialEq)] -pub struct WithItem { - pub range: TextRange, - pub context_expr: Expr, - pub optional_vars: Option<Box<Expr>>, -} - -/// See also [match_case](https://docs.python.org/3/library/ast.html#ast.match_case) -#[derive(Clone, Debug, PartialEq)] -pub struct MatchCase { - pub range: TextRange, - pub pattern: Pattern, - pub guard: Option<Box<Expr>>, - pub body: Vec<Stmt>, -} - -/// See also [pattern](https://docs.python.org/3/library/ast.html#ast.pattern) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum Pattern { - MatchValue(PatternMatchValue), - MatchSingleton(PatternMatchSingleton), - MatchSequence(PatternMatchSequence), - MatchMapping(PatternMatchMapping), - MatchClass(PatternMatchClass), - MatchStar(PatternMatchStar), - MatchAs(PatternMatchAs), - MatchOr(PatternMatchOr), -} - -impl Pattern { - /// Checks if the [`Pattern`] is an [irrefutable pattern]. - /// - /// [irrefutable pattern]: https://peps.python.org/pep-0634/#irrefutable-case-blocks - pub fn is_irrefutable(&self) -> bool { - match self { - Pattern::MatchAs(PatternMatchAs { pattern: None, .. }) => true, - Pattern::MatchOr(PatternMatchOr { patterns, .. }) => { - patterns.iter().any(Pattern::is_irrefutable) - } - _ => false, - } - } - - /// Checks if the [`Pattern`] is a [wildcard pattern]. - /// - /// The following are wildcard patterns: - /// ```python - /// match subject: - /// case _ as x: ... - /// case _ | _: ... - /// case _: ... - /// ``` - /// - /// [wildcard pattern]: https://docs.python.org/3/reference/compound_stmts.html#wildcard-patterns - pub fn is_wildcard(&self) -> bool { - match self { - Pattern::MatchAs(PatternMatchAs { pattern, .. }) => { - pattern.as_deref().map_or(true, Pattern::is_wildcard) - } - Pattern::MatchOr(PatternMatchOr { patterns, .. }) => { - patterns.iter().all(Pattern::is_wildcard) - } - _ => false, - } - } -} - -/// See also [MatchValue](https://docs.python.org/3/library/ast.html#ast.MatchValue) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchValue { - pub range: TextRange, - pub value: Box<Expr>, -} - -impl From<PatternMatchValue> for Pattern { - fn from(payload: PatternMatchValue) -> Self { - Pattern::MatchValue(payload) - } -} - -/// See also [MatchSingleton](https://docs.python.org/3/library/ast.html#ast.MatchSingleton) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchSingleton { - pub range: TextRange, - pub value: Singleton, -} - -impl From<PatternMatchSingleton> for Pattern { - fn from(payload: PatternMatchSingleton) -> Self { - Pattern::MatchSingleton(payload) - } -} - -/// See also [MatchSequence](https://docs.python.org/3/library/ast.html#ast.MatchSequence) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchSequence { - pub range: TextRange, - pub patterns: Vec<Pattern>, -} - -impl From<PatternMatchSequence> for Pattern { - fn from(payload: PatternMatchSequence) -> Self { - Pattern::MatchSequence(payload) - } -} - -/// See also [MatchMapping](https://docs.python.org/3/library/ast.html#ast.MatchMapping) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchMapping { - pub range: TextRange, - pub keys: Vec<Expr>, - pub patterns: Vec<Pattern>, - pub rest: Option<Identifier>, -} - -impl From<PatternMatchMapping> for Pattern { - fn from(payload: PatternMatchMapping) -> Self { - Pattern::MatchMapping(payload) - } -} - -/// See also [MatchClass](https://docs.python.org/3/library/ast.html#ast.MatchClass) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchClass { - pub range: TextRange, - pub cls: Box<Expr>, - pub arguments: PatternArguments, -} - -impl From<PatternMatchClass> for Pattern { - fn from(payload: PatternMatchClass) -> Self { - Pattern::MatchClass(payload) - } -} - -/// An AST node to represent the arguments to a [`PatternMatchClass`], i.e., the -/// parenthesized contents in `case Point(1, x=0, y=0)`. -/// -/// Like [`Arguments`], but for [`PatternMatchClass`]. -#[derive(Clone, Debug, PartialEq)] -pub struct PatternArguments { - pub range: TextRange, - pub patterns: Vec<Pattern>, - pub keywords: Vec<PatternKeyword>, -} - -/// An AST node to represent the keyword arguments to a [`PatternMatchClass`], i.e., the -/// `x=0` and `y=0` in `case Point(x=0, y=0)`. -/// -/// Like [`Keyword`], but for [`PatternMatchClass`]. -#[derive(Clone, Debug, PartialEq)] -pub struct PatternKeyword { - pub range: TextRange, - pub attr: Identifier, - pub pattern: Pattern, -} - -/// See also [MatchStar](https://docs.python.org/3/library/ast.html#ast.MatchStar) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchStar { - pub range: TextRange, - pub name: Option<Identifier>, -} - -impl From<PatternMatchStar> for Pattern { - fn from(payload: PatternMatchStar) -> Self { - Pattern::MatchStar(payload) - } -} - -/// See also [MatchAs](https://docs.python.org/3/library/ast.html#ast.MatchAs) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchAs { - pub range: TextRange, - pub pattern: Option<Box<Pattern>>, - pub name: Option<Identifier>, -} - -impl From<PatternMatchAs> for Pattern { - fn from(payload: PatternMatchAs) -> Self { - Pattern::MatchAs(payload) - } -} - -/// See also [MatchOr](https://docs.python.org/3/library/ast.html#ast.MatchOr) -#[derive(Clone, Debug, PartialEq)] -pub struct PatternMatchOr { - pub range: TextRange, - pub patterns: Vec<Pattern>, -} - -impl From<PatternMatchOr> for Pattern { - fn from(payload: PatternMatchOr) -> Self { - Pattern::MatchOr(payload) - } -} - -/// See also [type_param](https://docs.python.org/3/library/ast.html#ast.type_param) -#[derive(Clone, Debug, PartialEq, is_macro::Is)] -pub enum TypeParam { - TypeVar(TypeParamTypeVar), - ParamSpec(TypeParamParamSpec), - TypeVarTuple(TypeParamTypeVarTuple), -} - -/// See also [TypeVar](https://docs.python.org/3/library/ast.html#ast.TypeVar) -#[derive(Clone, Debug, PartialEq)] -pub struct TypeParamTypeVar { - pub range: TextRange, - pub name: Identifier, - pub bound: Option<Box<Expr>>, - pub default: Option<Box<Expr>>, -} - -impl From<TypeParamTypeVar> for TypeParam { - fn from(payload: TypeParamTypeVar) -> Self { - TypeParam::TypeVar(payload) - } -} - -/// See also [ParamSpec](https://docs.python.org/3/library/ast.html#ast.ParamSpec) -#[derive(Clone, Debug, PartialEq)] -pub struct TypeParamParamSpec { - pub range: TextRange, - pub name: Identifier, - pub default: Option<Box<Expr>>, -} - -impl From<TypeParamParamSpec> for TypeParam { - fn from(payload: TypeParamParamSpec) -> Self { - TypeParam::ParamSpec(payload) - } -} - -/// See also [TypeVarTuple](https://docs.python.org/3/library/ast.html#ast.TypeVarTuple) -#[derive(Clone, Debug, PartialEq)] -pub struct TypeParamTypeVarTuple { - pub range: TextRange, - pub name: Identifier, - pub default: Option<Box<Expr>>, -} - -impl From<TypeParamTypeVarTuple> for TypeParam { - fn from(payload: TypeParamTypeVarTuple) -> Self { - TypeParam::TypeVarTuple(payload) - } -} - -/// See also [decorator](https://docs.python.org/3/library/ast.html#ast.decorator) -#[derive(Clone, Debug, PartialEq)] -pub struct Decorator { - pub range: TextRange, - pub expression: Expr, -} - -/// Enumeration of the two kinds of parameter -#[derive(Debug, PartialEq, Clone, Copy)] -pub enum AnyParameterRef<'a> { - /// Variadic parameters cannot have default values, - /// e.g. both `*args` and `**kwargs` in the following function: - /// - /// ```python - /// def foo(*args, **kwargs): pass - /// ``` - Variadic(&'a Parameter), - - /// Non-variadic parameters can have default values, - /// though they won't necessarily always have them: - /// - /// ```python - /// def bar(a=1, /, b=2, *, c=3): pass - /// ``` - NonVariadic(&'a ParameterWithDefault), -} - -impl<'a> AnyParameterRef<'a> { - pub const fn as_parameter(self) -> &'a Parameter { - match self { - Self::NonVariadic(param) => ¶m.parameter, - Self::Variadic(param) => param, - } - } - - pub const fn name(self) -> &'a Identifier { - &self.as_parameter().name - } - - pub const fn is_variadic(self) -> bool { - matches!(self, Self::Variadic(_)) - } - - pub fn annotation(self) -> Option<&'a Expr> { - self.as_parameter().annotation.as_deref() - } - - pub fn default(self) -> Option<&'a Expr> { - match self { - Self::NonVariadic(param) => param.default.as_deref(), - Self::Variadic(_) => None, - } - } -} - -impl Ranged for AnyParameterRef<'_> { - fn range(&self) -> TextRange { - match self { - Self::NonVariadic(param) => param.range, - Self::Variadic(param) => param.range, - } - } -} - -/// An alternative type of AST `arguments`. This is ruff_python_parser-friendly and human-friendly definition of function arguments. -/// This form also has advantage to implement pre-order traverse. -/// -/// `defaults` and `kw_defaults` fields are removed and the default values are placed under each [`ParameterWithDefault`] typed argument. -/// `vararg` and `kwarg` are still typed as `arg` because they never can have a default value. -/// -/// The original Python-style AST type orders `kwonlyargs` fields by default existence; [Parameters] has location-ordered `kwonlyargs` fields. -/// -/// NOTE: This type differs from the original Python AST. See: [arguments](https://docs.python.org/3/library/ast.html#ast.arguments). - -#[derive(Clone, Debug, PartialEq, Default)] -pub struct Parameters { - pub range: TextRange, - pub posonlyargs: Vec<ParameterWithDefault>, - pub args: Vec<ParameterWithDefault>, - pub vararg: Option<Box<Parameter>>, - pub kwonlyargs: Vec<ParameterWithDefault>, - pub kwarg: Option<Box<Parameter>>, -} - -impl Parameters { - /// Returns an iterator over all non-variadic parameters included in this [`Parameters`] node. - /// - /// The variadic parameters (`.vararg` and `.kwarg`) can never have default values; - /// non-variadic parameters sometimes will. - pub fn iter_non_variadic_params(&self) -> impl Iterator<Item = &ParameterWithDefault> { - self.posonlyargs - .iter() - .chain(&self.args) - .chain(&self.kwonlyargs) - } - - /// Returns the [`ParameterWithDefault`] with the given name, or `None` if no such [`ParameterWithDefault`] exists. - pub fn find(&self, name: &str) -> Option<&ParameterWithDefault> { - self.iter_non_variadic_params() - .find(|arg| arg.parameter.name.as_str() == name) - } - - /// Returns an iterator over all parameters included in this [`Parameters`] node. - pub fn iter(&self) -> ParametersIterator { - ParametersIterator::new(self) - } - - /// Returns the total number of parameters included in this [`Parameters`] node. - pub fn len(&self) -> usize { - let Parameters { - range: _, - posonlyargs, - args, - vararg, - kwonlyargs, - kwarg, - } = self; - // Safety: a Python function can have an arbitrary number of parameters, - // so theoretically this could be a number that wouldn't fit into a usize, - // which would lead to a panic. A Python function with that many parameters - // is extremely unlikely outside of generated code, however, and it's even - // more unlikely that we'd find a function with that many parameters in a - // source-code file <=4GB large (Ruff's maximum). - posonlyargs - .len() - .checked_add(args.len()) - .and_then(|length| length.checked_add(usize::from(vararg.is_some()))) - .and_then(|length| length.checked_add(kwonlyargs.len())) - .and_then(|length| length.checked_add(usize::from(kwarg.is_some()))) - .expect("Failed to fit the number of parameters into a usize") - } - - /// Returns `true` if a parameter with the given name is included in this [`Parameters`]. - pub fn includes(&self, name: &str) -> bool { - self.iter().any(|param| param.name() == name) - } - - /// Returns `true` if the [`Parameters`] is empty. - pub fn is_empty(&self) -> bool { - self.posonlyargs.is_empty() - && self.args.is_empty() - && self.kwonlyargs.is_empty() - && self.vararg.is_none() - && self.kwarg.is_none() - } -} - -pub struct ParametersIterator<'a> { - posonlyargs: Iter<'a, ParameterWithDefault>, - args: Iter<'a, ParameterWithDefault>, - vararg: Option<&'a Parameter>, - kwonlyargs: Iter<'a, ParameterWithDefault>, - kwarg: Option<&'a Parameter>, -} - -impl<'a> ParametersIterator<'a> { - fn new(parameters: &'a Parameters) -> Self { - let Parameters { - range: _, - posonlyargs, - args, - vararg, - kwonlyargs, - kwarg, - } = parameters; - Self { - posonlyargs: posonlyargs.iter(), - args: args.iter(), - vararg: vararg.as_deref(), - kwonlyargs: kwonlyargs.iter(), - kwarg: kwarg.as_deref(), - } - } -} - -impl<'a> Iterator for ParametersIterator<'a> { - type Item = AnyParameterRef<'a>; - - fn next(&mut self) -> Option<Self::Item> { - let ParametersIterator { - posonlyargs, - args, - vararg, - kwonlyargs, - kwarg, - } = self; - - if let Some(param) = posonlyargs.next() { - return Some(AnyParameterRef::NonVariadic(param)); - } - if let Some(param) = args.next() { - return Some(AnyParameterRef::NonVariadic(param)); - } - if let Some(param) = vararg.take() { - return Some(AnyParameterRef::Variadic(param)); - } - if let Some(param) = kwonlyargs.next() { - return Some(AnyParameterRef::NonVariadic(param)); - } - kwarg.take().map(AnyParameterRef::Variadic) - } - - fn size_hint(&self) -> (usize, Option<usize>) { - let ParametersIterator { - posonlyargs, - args, - vararg, - kwonlyargs, - kwarg, - } = self; - - let posonlyargs_len = posonlyargs.len(); - let args_len = args.len(); - let vararg_len = usize::from(vararg.is_some()); - let kwonlyargs_len = kwonlyargs.len(); - let kwarg_len = usize::from(kwarg.is_some()); - - let lower = posonlyargs_len - .saturating_add(args_len) - .saturating_add(vararg_len) - .saturating_add(kwonlyargs_len) - .saturating_add(kwarg_len); - - let upper = posonlyargs_len - .checked_add(args_len) - .and_then(|length| length.checked_add(vararg_len)) - .and_then(|length| length.checked_add(kwonlyargs_len)) - .and_then(|length| length.checked_add(kwarg_len)); - - (lower, upper) - } - - fn last(mut self) -> Option<Self::Item> { - self.next_back() - } +/// See also [cmpop](https://docs.python.org/3/library/ast.html#ast.cmpop) +#[derive(Clone, Debug, PartialEq, is_macro::Is, Copy, Hash, Eq)] +pub enum CmpOp { + Eq, + NotEq, + Lt, + LtE, + Gt, + GtE, + Is, + IsNot, + In, + NotIn, } -impl<'a> DoubleEndedIterator for ParametersIterator<'a> { - fn next_back(&mut self) -> Option<Self::Item> { - let ParametersIterator { - posonlyargs, - args, - vararg, - kwonlyargs, - kwarg, - } = self; - - if let Some(param) = kwarg.take() { - return Some(AnyParameterRef::Variadic(param)); - } - if let Some(param) = kwonlyargs.next_back() { - return Some(AnyParameterRef::NonVariadic(param)); - } - if let Some(param) = vararg.take() { - return Some(AnyParameterRef::Variadic(param)); - } - if let Some(param) = args.next_back() { - return Some(AnyParameterRef::NonVariadic(param)); +impl CmpOp { + pub const fn as_str(&self) -> &'static str { + match self { + CmpOp::Eq => "==", + CmpOp::NotEq => "!=", + CmpOp::Lt => "<", + CmpOp::LtE => "<=", + CmpOp::Gt => ">", + CmpOp::GtE => ">=", + CmpOp::Is => "is", + CmpOp::IsNot => "is not", + CmpOp::In => "in", + CmpOp::NotIn => "not in", } - posonlyargs.next_back().map(AnyParameterRef::NonVariadic) } -} -impl<'a> FusedIterator for ParametersIterator<'a> {} - -/// We rely on the same invariants outlined in the comment above `Parameters::len()` -/// in order to implement `ExactSizeIterator` here -impl<'a> ExactSizeIterator for ParametersIterator<'a> {} - -impl<'a> IntoIterator for &'a Parameters { - type IntoIter = ParametersIterator<'a>; - type Item = AnyParameterRef<'a>; - fn into_iter(self) -> Self::IntoIter { - self.iter() + #[must_use] + pub const fn negate(&self) -> Self { + match self { + CmpOp::Eq => CmpOp::NotEq, + CmpOp::NotEq => CmpOp::Eq, + CmpOp::Lt => CmpOp::GtE, + CmpOp::LtE => CmpOp::Gt, + CmpOp::Gt => CmpOp::LtE, + CmpOp::GtE => CmpOp::Lt, + CmpOp::Is => CmpOp::IsNot, + CmpOp::IsNot => CmpOp::Is, + CmpOp::In => CmpOp::NotIn, + CmpOp::NotIn => CmpOp::In, + } } } -impl<'a> IntoIterator for &'a Box<Parameters> { - type IntoIter = ParametersIterator<'a>; - type Item = AnyParameterRef<'a>; - fn into_iter(self) -> Self::IntoIter { - (&**self).into_iter() +impl fmt::Display for CmpOp { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.as_str()) } } -/// An alternative type of AST `arg`. This is used for each function argument that might have a default value. -/// Used by `Arguments` original type. -/// -/// NOTE: This type is different from original Python AST. - +/// See also [comprehension](https://docs.python.org/3/library/ast.html#ast.comprehension) #[derive(Clone, Debug, PartialEq)] -pub struct ParameterWithDefault { +pub struct Comprehension { pub range: TextRange, - pub parameter: Parameter, - pub default: Option<Box<Expr>>, + pub target: Expr, + pub iter: Expr, + pub ifs: Vec<Expr>, + pub is_async: bool, } -/// An AST node used to represent the arguments passed to a function call or class definition. -/// -/// For example, given: -/// ```python -/// foo(1, 2, 3, bar=4, baz=5) -/// ``` -/// The `Arguments` node would span from the left to right parentheses (inclusive), and contain -/// the arguments and keyword arguments in the order they appear in the source code. -/// -/// Similarly, given: -/// ```python -/// class Foo(Bar, baz=1, qux=2): -/// pass -/// ``` -/// The `Arguments` node would again span from the left to right parentheses (inclusive), and -/// contain the `Bar` argument and the `baz` and `qux` keyword arguments in the order they -/// appear in the source code. -/// -/// In the context of a class definition, the Python-style AST refers to the arguments as `bases`, -/// as they represent the "explicitly specified base classes", while the keyword arguments are -/// typically used for `metaclass`, with any additional arguments being passed to the `metaclass`. - +/// See also [ExceptHandler](https://docs.python.org/3/library/ast.html#ast.ExceptHandler) #[derive(Clone, Debug, PartialEq)] -pub struct Arguments { +pub struct ExceptHandlerExceptHandler { pub range: TextRange, - pub args: Box<[Expr]>, - pub keywords: Box<[Keyword]>, -} - -/// An entry in the argument list of a function call. -#[derive(Clone, Debug, PartialEq)] -pub enum ArgOrKeyword<'a> { - Arg(&'a Expr), - Keyword(&'a Keyword), -} - -impl<'a> From<&'a Expr> for ArgOrKeyword<'a> { - fn from(arg: &'a Expr) -> Self { - Self::Arg(arg) - } -} - -impl<'a> From<&'a Keyword> for ArgOrKeyword<'a> { - fn from(keyword: &'a Keyword) -> Self { - Self::Keyword(keyword) - } -} - -impl Ranged for ArgOrKeyword<'_> { - fn range(&self) -> TextRange { - match self { - Self::Arg(arg) => arg.range(), - Self::Keyword(keyword) => keyword.range(), - } - } -} - -impl Arguments { - /// Return the number of positional and keyword arguments. - pub fn len(&self) -> usize { - self.args.len() + self.keywords.len() - } - - /// Return `true` if there are no positional or keyword arguments. - pub fn is_empty(&self) -> bool { - self.len() == 0 - } - - /// Return the [`Keyword`] with the given name, or `None` if no such [`Keyword`] exists. - pub fn find_keyword(&self, keyword_name: &str) -> Option<&Keyword> { - self.keywords.iter().find(|keyword| { - let Keyword { arg, .. } = keyword; - arg.as_ref().is_some_and(|arg| arg == keyword_name) - }) - } - - /// Return the positional argument at the given index, or `None` if no such argument exists. - pub fn find_positional(&self, position: usize) -> Option<&Expr> { - self.args - .iter() - .take_while(|expr| !expr.is_starred_expr()) - .nth(position) - } - - /// Return the argument with the given name or at the given position, or `None` if no such - /// argument exists. Used to retrieve arguments that can be provided _either_ as keyword or - /// positional arguments. - pub fn find_argument(&self, name: &str, position: usize) -> Option<&Expr> { - self.find_keyword(name) - .map(|keyword| &keyword.value) - .or_else(|| self.find_positional(position)) - } - - /// Return the positional and keyword arguments in the order of declaration. - /// - /// Positional arguments are generally before keyword arguments, but star arguments are an - /// exception: - /// ```python - /// class A(*args, a=2, *args2, **kwargs): - /// pass - /// - /// f(*args, a=2, *args2, **kwargs) - /// ``` - /// where `*args` and `args2` are `args` while `a=1` and `kwargs` are `keywords`. - /// - /// If you would just chain `args` and `keywords` the call would get reordered which we don't - /// want. This function instead "merge sorts" them into the correct order. - /// - /// Note that the order of evaluation is always first `args`, then `keywords`: - /// ```python - /// def f(*args, **kwargs): - /// pass - /// - /// def g(x): - /// print(x) - /// return x - /// - /// - /// f(*g([1]), a=g(2), *g([3]), **g({"4": 5})) - /// ``` - /// Output: - /// ```text - /// [1] - /// [3] - /// 2 - /// {'4': 5} - /// ``` - pub fn arguments_source_order(&self) -> impl Iterator<Item = ArgOrKeyword<'_>> { - let args = self.args.iter().map(ArgOrKeyword::Arg); - let keywords = self.keywords.iter().map(ArgOrKeyword::Keyword); - args.merge_by(keywords, |left, right| left.start() < right.start()) - } + pub type_: Option<Box<Expr>>, + pub name: Option<Identifier>, + pub body: Vec<Stmt>, } -/// An AST node used to represent a sequence of type parameters. -/// -/// For example, given: -/// ```python -/// class C[T, U, V]: ... -/// ``` -/// The `TypeParams` node would span from the left to right brackets (inclusive), and contain -/// the `T`, `U`, and `V` type parameters in the order they appear in the source code. - +/// See also [arg](https://docs.python.org/3/library/ast.html#ast.arg) #[derive(Clone, Debug, PartialEq)] -pub struct TypeParams { +pub struct Parameter { pub range: TextRange, - pub type_params: Vec<TypeParam>, + pub name: Identifier, + pub annotation: Option<Box<Expr>>, } -impl Deref for TypeParams { - type Target = [TypeParam]; +impl Parameter { + pub const fn name(&self) -> &Identifier { + &self.name + } - fn deref(&self) -> &Self::Target { - &self.type_params + pub fn annotation(&self) -> Option<&Expr> { + self.annotation.as_deref() } } -/// A suite represents a [Vec] of [Stmt]. -/// -/// See: <https://docs.python.org/3/reference/compound_stmts.html#grammar-token-python-grammar-suite> -pub type Suite = Vec<Stmt>; - -/// The kind of escape command as defined in [IPython Syntax] in the IPython codebase. -/// -/// [IPython Syntax]: https://github.com/ipython/ipython/blob/635815e8f1ded5b764d66cacc80bbe25e9e2587f/IPython/core/inputtransformer2.py#L335-L343 -#[derive(PartialEq, Eq, Debug, Clone, Hash, Copy)] -pub enum IpyEscapeKind { - /// Send line to underlying system shell (`!`). - Shell, - /// Send line to system shell and capture output (`!!`). - ShCap, - /// Show help on object (`?`). - Help, - /// Show help on object, with extra verbosity (`??`). - Help2, - /// Call magic function (`%`). - Magic, - /// Call cell magic function (`%%`). - Magic2, - /// Call first argument with rest of line as arguments after splitting on whitespace - /// and quote each as string (`,`). - Quote, - /// Call first argument with rest of line as an argument quoted as a single string (`;`). - Quote2, - /// Call first argument with rest of line as arguments (`/`). - Paren, +/// See also [keyword](https://docs.python.org/3/library/ast.html#ast.keyword) +#[derive(Clone, Debug, PartialEq)] +pub struct Keyword { + pub range: TextRange, + pub arg: Option<Identifier>, + pub value: Expr, } -impl TryFrom<char> for IpyEscapeKind { - type Error = String; - - fn try_from(ch: char) -> Result<Self, Self::Error> { - match ch { - '!' => Ok(IpyEscapeKind::Shell), - '?' => Ok(IpyEscapeKind::Help), - '%' => Ok(IpyEscapeKind::Magic), - ',' => Ok(IpyEscapeKind::Quote), - ';' => Ok(IpyEscapeKind::Quote2), - '/' => Ok(IpyEscapeKind::Paren), - _ => Err(format!("Unexpected magic escape: {ch}")), - } - } +/// See also [alias](https://docs.python.org/3/library/ast.html#ast.alias) +#[derive(Clone, Debug, PartialEq)] +pub struct Alias { + pub range: TextRange, + pub name: Identifier, + pub asname: Option<Identifier>, } -impl TryFrom<[char; 2]> for IpyEscapeKind { - type Error = String; - - fn try_from(ch: [char; 2]) -> Result<Self, Self::Error> { - match ch { - ['!', '!'] => Ok(IpyEscapeKind::ShCap), - ['?', '?'] => Ok(IpyEscapeKind::Help2), - ['%', '%'] => Ok(IpyEscapeKind::Magic2), - [c1, c2] => Err(format!("Unexpected magic escape: {c1}{c2}")), - } - } +/// See also [withitem](https://docs.python.org/3/library/ast.html#ast.withitem) +#[derive(Clone, Debug, PartialEq)] +pub struct WithItem { + pub range: TextRange, + pub context_expr: Expr, + pub optional_vars: Option<Box<Expr>>, } -impl fmt::Display for IpyEscapeKind { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.write_str(self.as_str()) - } +/// See also [match_case](https://docs.python.org/3/library/ast.html#ast.match_case) +#[derive(Clone, Debug, PartialEq)] +pub struct MatchCase { + pub range: TextRange, + pub pattern: Pattern, + pub guard: Option<Box<Expr>>, + pub body: Vec<Stmt>, } -impl IpyEscapeKind { - /// Returns `true` if the escape kind is help i.e., `?` or `??`. - pub const fn is_help(self) -> bool { - matches!(self, IpyEscapeKind::Help | IpyEscapeKind::Help2) +impl Pattern { + /// Checks if the [`Pattern`] is an [irrefutable pattern]. + /// + /// [irrefutable pattern]: https://peps.python.org/pep-0634/#irrefutable-case-blocks + pub fn is_irrefutable(&self) -> bool { + self.irrefutable_pattern().is_some() } - /// Returns `true` if the escape kind is magic i.e., `%` or `%%`. - pub const fn is_magic(self) -> bool { - matches!(self, IpyEscapeKind::Magic | IpyEscapeKind::Magic2) + /// Return `Some(IrrefutablePattern)` if `self` is irrefutable or `None` otherwise. + pub fn irrefutable_pattern(&self) -> Option<IrrefutablePattern> { + match self { + Pattern::MatchAs(PatternMatchAs { + pattern, + name, + range, + }) => match pattern { + Some(pattern) => pattern.irrefutable_pattern(), + None => match name { + Some(name) => Some(IrrefutablePattern { + kind: IrrefutablePatternKind::Name(name.id.clone()), + range: *range, + }), + None => Some(IrrefutablePattern { + kind: IrrefutablePatternKind::Wildcard, + range: *range, + }), + }, + }, + Pattern::MatchOr(PatternMatchOr { patterns, .. }) => { + patterns.iter().find_map(Pattern::irrefutable_pattern) + } + _ => None, + } } - pub fn as_str(self) -> &'static str { + /// Checks if the [`Pattern`] is a [wildcard pattern]. + /// + /// The following are wildcard patterns: + /// ```python + /// match subject: + /// case _ as x: ... + /// case _ | _: ... + /// case _: ... + /// ``` + /// + /// [wildcard pattern]: https://docs.python.org/3/reference/compound_stmts.html#wildcard-patterns + pub fn is_wildcard(&self) -> bool { match self { - IpyEscapeKind::Shell => "!", - IpyEscapeKind::ShCap => "!!", - IpyEscapeKind::Help => "?", - IpyEscapeKind::Help2 => "??", - IpyEscapeKind::Magic => "%", - IpyEscapeKind::Magic2 => "%%", - IpyEscapeKind::Quote => ",", - IpyEscapeKind::Quote2 => ";", - IpyEscapeKind::Paren => "/", + Pattern::MatchAs(PatternMatchAs { pattern, .. }) => { + pattern.as_deref().is_none_or(Pattern::is_wildcard) + } + Pattern::MatchOr(PatternMatchOr { patterns, .. }) => { + patterns.iter().all(Pattern::is_wildcard) + } + _ => false, } } } -/// An `Identifier` with an empty `id` is invalid. -/// -/// For example, in the following code `id` will be empty. -/// ```python -/// def 1(): -/// ... -/// ``` -#[derive(Clone, Debug, PartialEq, Eq, Hash)] -pub struct Identifier { - pub id: Name, +pub struct IrrefutablePattern { + pub kind: IrrefutablePatternKind, pub range: TextRange, } -impl Identifier { - #[inline] - pub fn new(id: impl Into<Name>, range: TextRange) -> Self { - Self { - id: id.into(), - range, - } - } - - pub fn id(&self) -> &Name { - &self.id - } - - pub fn is_valid(&self) -> bool { - !self.id.is_empty() - } +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum IrrefutablePatternKind { + Name(Name), + Wildcard, } -impl Identifier { - #[inline] - pub fn as_str(&self) -> &str { - self.id.as_str() - } +/// See also [MatchValue](https://docs.python.org/3/library/ast.html#ast.MatchValue) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchValue { + pub range: TextRange, + pub value: Box<Expr>, } -impl PartialEq<str> for Identifier { - #[inline] - fn eq(&self, other: &str) -> bool { - self.id == other - } +/// See also [MatchSingleton](https://docs.python.org/3/library/ast.html#ast.MatchSingleton) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchSingleton { + pub range: TextRange, + pub value: Singleton, } -impl PartialEq<String> for Identifier { - #[inline] - fn eq(&self, other: &String) -> bool { - self.id == other - } +/// See also [MatchSequence](https://docs.python.org/3/library/ast.html#ast.MatchSequence) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchSequence { + pub range: TextRange, + pub patterns: Vec<Pattern>, } -impl std::ops::Deref for Identifier { - type Target = str; - #[inline] - fn deref(&self) -> &Self::Target { - self.id.as_str() - } +/// See also [MatchMapping](https://docs.python.org/3/library/ast.html#ast.MatchMapping) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchMapping { + pub range: TextRange, + pub keys: Vec<Expr>, + pub patterns: Vec<Pattern>, + pub rest: Option<Identifier>, } -impl AsRef<str> for Identifier { - #[inline] - fn as_ref(&self) -> &str { - self.id.as_str() - } +/// See also [MatchClass](https://docs.python.org/3/library/ast.html#ast.MatchClass) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchClass { + pub range: TextRange, + pub cls: Box<Expr>, + pub arguments: PatternArguments, } -impl std::fmt::Display for Identifier { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - std::fmt::Display::fmt(&self.id, f) - } +/// An AST node to represent the arguments to a [`PatternMatchClass`], i.e., the +/// parenthesized contents in `case Point(1, x=0, y=0)`. +/// +/// Like [`Arguments`], but for [`PatternMatchClass`]. +#[derive(Clone, Debug, PartialEq)] +pub struct PatternArguments { + pub range: TextRange, + pub patterns: Vec<Pattern>, + pub keywords: Vec<PatternKeyword>, } -impl From<Identifier> for Name { - #[inline] - fn from(identifier: Identifier) -> Name { - identifier.id - } +/// An AST node to represent the keyword arguments to a [`PatternMatchClass`], i.e., the +/// `x=0` and `y=0` in `case Point(x=0, y=0)`. +/// +/// Like [`Keyword`], but for [`PatternMatchClass`]. +#[derive(Clone, Debug, PartialEq)] +pub struct PatternKeyword { + pub range: TextRange, + pub attr: Identifier, + pub pattern: Pattern, } -impl Ranged for Identifier { - fn range(&self) -> TextRange { - self.range - } +/// See also [MatchStar](https://docs.python.org/3/library/ast.html#ast.MatchStar) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchStar { + pub range: TextRange, + pub name: Option<Identifier>, } +/// See also [MatchAs](https://docs.python.org/3/library/ast.html#ast.MatchAs) #[derive(Clone, Debug, PartialEq)] -pub enum Singleton { - None, - True, - False, +pub struct PatternMatchAs { + pub range: TextRange, + pub pattern: Option<Box<Pattern>>, + pub name: Option<Identifier>, } -impl From<bool> for Singleton { - fn from(value: bool) -> Self { - if value { - Singleton::True - } else { - Singleton::False - } - } +/// See also [MatchOr](https://docs.python.org/3/library/ast.html#ast.MatchOr) +#[derive(Clone, Debug, PartialEq)] +pub struct PatternMatchOr { + pub range: TextRange, + pub patterns: Vec<Pattern>, } -impl Ranged for crate::nodes::ModModule { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::ModExpression { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::Mod { - fn range(&self) -> TextRange { +impl TypeParam { + pub const fn name(&self) -> &Identifier { match self { - Self::Module(node) => node.range(), - Self::Expression(node) => node.range(), + Self::TypeVar(x) => &x.name, + Self::ParamSpec(x) => &x.name, + Self::TypeVarTuple(x) => &x.name, } } -} -impl Ranged for crate::nodes::StmtFunctionDef { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::StmtClassDef { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::StmtReturn { - fn range(&self) -> TextRange { - self.range + pub fn default(&self) -> Option<&Expr> { + match self { + Self::TypeVar(x) => x.default.as_deref(), + Self::ParamSpec(x) => x.default.as_deref(), + Self::TypeVarTuple(x) => x.default.as_deref(), + } } } -impl Ranged for crate::nodes::StmtDelete { - fn range(&self) -> TextRange { - self.range - } + +/// See also [TypeVar](https://docs.python.org/3/library/ast.html#ast.TypeVar) +#[derive(Clone, Debug, PartialEq)] +pub struct TypeParamTypeVar { + pub range: TextRange, + pub name: Identifier, + pub bound: Option<Box<Expr>>, + pub default: Option<Box<Expr>>, } -impl Ranged for crate::nodes::StmtTypeAlias { - fn range(&self) -> TextRange { - self.range - } + +/// See also [ParamSpec](https://docs.python.org/3/library/ast.html#ast.ParamSpec) +#[derive(Clone, Debug, PartialEq)] +pub struct TypeParamParamSpec { + pub range: TextRange, + pub name: Identifier, + pub default: Option<Box<Expr>>, } -impl Ranged for crate::nodes::StmtAssign { - fn range(&self) -> TextRange { - self.range - } + +/// See also [TypeVarTuple](https://docs.python.org/3/library/ast.html#ast.TypeVarTuple) +#[derive(Clone, Debug, PartialEq)] +pub struct TypeParamTypeVarTuple { + pub range: TextRange, + pub name: Identifier, + pub default: Option<Box<Expr>>, } -impl Ranged for crate::nodes::StmtAugAssign { - fn range(&self) -> TextRange { - self.range - } + +/// See also [decorator](https://docs.python.org/3/library/ast.html#ast.decorator) +#[derive(Clone, Debug, PartialEq)] +pub struct Decorator { + pub range: TextRange, + pub expression: Expr, } -impl Ranged for crate::nodes::StmtAnnAssign { - fn range(&self) -> TextRange { - self.range - } + +/// Enumeration of the two kinds of parameter +#[derive(Debug, PartialEq, Clone, Copy)] +pub enum AnyParameterRef<'a> { + /// Variadic parameters cannot have default values, + /// e.g. both `*args` and `**kwargs` in the following function: + /// + /// ```python + /// def foo(*args, **kwargs): pass + /// ``` + Variadic(&'a Parameter), + + /// Non-variadic parameters can have default values, + /// though they won't necessarily always have them: + /// + /// ```python + /// def bar(a=1, /, b=2, *, c=3): pass + /// ``` + NonVariadic(&'a ParameterWithDefault), } -impl Ranged for crate::nodes::StmtFor { - fn range(&self) -> TextRange { - self.range + +impl<'a> AnyParameterRef<'a> { + pub const fn as_parameter(self) -> &'a Parameter { + match self { + Self::NonVariadic(param) => ¶m.parameter, + Self::Variadic(param) => param, + } } -} -impl Ranged for crate::nodes::StmtWhile { - fn range(&self) -> TextRange { - self.range + + pub const fn name(self) -> &'a Identifier { + &self.as_parameter().name } -} -impl Ranged for crate::nodes::StmtIf { - fn range(&self) -> TextRange { - self.range + + pub const fn is_variadic(self) -> bool { + matches!(self, Self::Variadic(_)) } -} -impl Ranged for crate::nodes::ElifElseClause { - fn range(&self) -> TextRange { - self.range + + pub fn annotation(self) -> Option<&'a Expr> { + self.as_parameter().annotation.as_deref() } -} -impl Ranged for crate::nodes::StmtWith { - fn range(&self) -> TextRange { - self.range + + pub fn default(self) -> Option<&'a Expr> { + match self { + Self::NonVariadic(param) => param.default.as_deref(), + Self::Variadic(_) => None, + } } } -impl Ranged for crate::nodes::StmtMatch { + +impl Ranged for AnyParameterRef<'_> { fn range(&self) -> TextRange { - self.range + match self { + Self::NonVariadic(param) => param.range, + Self::Variadic(param) => param.range, + } } } -impl Ranged for crate::nodes::StmtRaise { - fn range(&self) -> TextRange { - self.range - } + +/// An alternative type of AST `arguments`. This is ruff_python_parser-friendly and human-friendly definition of function arguments. +/// This form also has advantage to implement pre-order traverse. +/// +/// `defaults` and `kw_defaults` fields are removed and the default values are placed under each [`ParameterWithDefault`] typed argument. +/// `vararg` and `kwarg` are still typed as `arg` because they never can have a default value. +/// +/// The original Python-style AST type orders `kwonlyargs` fields by default existence; [Parameters] has location-ordered `kwonlyargs` fields. +/// +/// NOTE: This type differs from the original Python AST. See: [arguments](https://docs.python.org/3/library/ast.html#ast.arguments). + +#[derive(Clone, Debug, PartialEq, Default)] +pub struct Parameters { + pub range: TextRange, + pub posonlyargs: Vec<ParameterWithDefault>, + pub args: Vec<ParameterWithDefault>, + pub vararg: Option<Box<Parameter>>, + pub kwonlyargs: Vec<ParameterWithDefault>, + pub kwarg: Option<Box<Parameter>>, } -impl Ranged for crate::nodes::StmtTry { - fn range(&self) -> TextRange { - self.range + +impl Parameters { + /// Returns an iterator over all non-variadic parameters included in this [`Parameters`] node. + /// + /// The variadic parameters (`.vararg` and `.kwarg`) can never have default values; + /// non-variadic parameters sometimes will. + pub fn iter_non_variadic_params(&self) -> impl Iterator<Item = &ParameterWithDefault> { + self.posonlyargs + .iter() + .chain(&self.args) + .chain(&self.kwonlyargs) } -} -impl Ranged for crate::nodes::StmtAssert { - fn range(&self) -> TextRange { - self.range + + /// Returns the [`ParameterWithDefault`] with the given name, or `None` if no such [`ParameterWithDefault`] exists. + pub fn find(&self, name: &str) -> Option<&ParameterWithDefault> { + self.iter_non_variadic_params() + .find(|arg| arg.parameter.name.as_str() == name) } -} -impl Ranged for crate::nodes::StmtImport { - fn range(&self) -> TextRange { - self.range + + /// Returns an iterator over all parameters included in this [`Parameters`] node. + pub fn iter(&self) -> ParametersIterator { + ParametersIterator::new(self) } -} -impl Ranged for crate::nodes::StmtImportFrom { - fn range(&self) -> TextRange { - self.range + + /// Returns the total number of parameters included in this [`Parameters`] node. + pub fn len(&self) -> usize { + let Parameters { + range: _, + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + } = self; + // Safety: a Python function can have an arbitrary number of parameters, + // so theoretically this could be a number that wouldn't fit into a usize, + // which would lead to a panic. A Python function with that many parameters + // is extremely unlikely outside of generated code, however, and it's even + // more unlikely that we'd find a function with that many parameters in a + // source-code file <=4GB large (Ruff's maximum). + posonlyargs + .len() + .checked_add(args.len()) + .and_then(|length| length.checked_add(usize::from(vararg.is_some()))) + .and_then(|length| length.checked_add(kwonlyargs.len())) + .and_then(|length| length.checked_add(usize::from(kwarg.is_some()))) + .expect("Failed to fit the number of parameters into a usize") } -} -impl Ranged for crate::nodes::StmtGlobal { - fn range(&self) -> TextRange { - self.range + + /// Returns `true` if a parameter with the given name is included in this [`Parameters`]. + pub fn includes(&self, name: &str) -> bool { + self.iter().any(|param| param.name() == name) } -} -impl Ranged for crate::nodes::StmtNonlocal { - fn range(&self) -> TextRange { - self.range + + /// Returns `true` if the [`Parameters`] is empty. + pub fn is_empty(&self) -> bool { + self.posonlyargs.is_empty() + && self.args.is_empty() + && self.kwonlyargs.is_empty() + && self.vararg.is_none() + && self.kwarg.is_none() } } -impl Ranged for crate::nodes::StmtExpr { - fn range(&self) -> TextRange { - self.range - } + +pub struct ParametersIterator<'a> { + posonlyargs: Iter<'a, ParameterWithDefault>, + args: Iter<'a, ParameterWithDefault>, + vararg: Option<&'a Parameter>, + kwonlyargs: Iter<'a, ParameterWithDefault>, + kwarg: Option<&'a Parameter>, } -impl Ranged for crate::nodes::StmtPass { - fn range(&self) -> TextRange { - self.range + +impl<'a> ParametersIterator<'a> { + fn new(parameters: &'a Parameters) -> Self { + let Parameters { + range: _, + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + } = parameters; + Self { + posonlyargs: posonlyargs.iter(), + args: args.iter(), + vararg: vararg.as_deref(), + kwonlyargs: kwonlyargs.iter(), + kwarg: kwarg.as_deref(), + } } } -impl Ranged for crate::nodes::StmtBreak { - fn range(&self) -> TextRange { - self.range + +impl<'a> Iterator for ParametersIterator<'a> { + type Item = AnyParameterRef<'a>; + + fn next(&mut self) -> Option<Self::Item> { + let ParametersIterator { + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + } = self; + + if let Some(param) = posonlyargs.next() { + return Some(AnyParameterRef::NonVariadic(param)); + } + if let Some(param) = args.next() { + return Some(AnyParameterRef::NonVariadic(param)); + } + if let Some(param) = vararg.take() { + return Some(AnyParameterRef::Variadic(param)); + } + if let Some(param) = kwonlyargs.next() { + return Some(AnyParameterRef::NonVariadic(param)); + } + kwarg.take().map(AnyParameterRef::Variadic) } -} -impl Ranged for crate::nodes::StmtContinue { - fn range(&self) -> TextRange { - self.range + + fn size_hint(&self) -> (usize, Option<usize>) { + let ParametersIterator { + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + } = self; + + let posonlyargs_len = posonlyargs.len(); + let args_len = args.len(); + let vararg_len = usize::from(vararg.is_some()); + let kwonlyargs_len = kwonlyargs.len(); + let kwarg_len = usize::from(kwarg.is_some()); + + let lower = posonlyargs_len + .saturating_add(args_len) + .saturating_add(vararg_len) + .saturating_add(kwonlyargs_len) + .saturating_add(kwarg_len); + + let upper = posonlyargs_len + .checked_add(args_len) + .and_then(|length| length.checked_add(vararg_len)) + .and_then(|length| length.checked_add(kwonlyargs_len)) + .and_then(|length| length.checked_add(kwarg_len)); + + (lower, upper) } -} -impl Ranged for crate::nodes::StmtIpyEscapeCommand { - fn range(&self) -> TextRange { - self.range + + fn last(mut self) -> Option<Self::Item> { + self.next_back() } } -impl Ranged for crate::Stmt { - fn range(&self) -> TextRange { - match self { - Self::FunctionDef(node) => node.range(), - Self::ClassDef(node) => node.range(), - Self::Return(node) => node.range(), - Self::Delete(node) => node.range(), - Self::TypeAlias(node) => node.range(), - Self::Assign(node) => node.range(), - Self::AugAssign(node) => node.range(), - Self::AnnAssign(node) => node.range(), - Self::For(node) => node.range(), - Self::While(node) => node.range(), - Self::If(node) => node.range(), - Self::With(node) => node.range(), - Self::Match(node) => node.range(), - Self::Raise(node) => node.range(), - Self::Try(node) => node.range(), - Self::Assert(node) => node.range(), - Self::Import(node) => node.range(), - Self::ImportFrom(node) => node.range(), - Self::Global(node) => node.range(), - Self::Nonlocal(node) => node.range(), - Self::Expr(node) => node.range(), - Self::Pass(node) => node.range(), - Self::Break(node) => node.range(), - Self::Continue(node) => node.range(), - Stmt::IpyEscapeCommand(node) => node.range(), + +impl DoubleEndedIterator for ParametersIterator<'_> { + fn next_back(&mut self) -> Option<Self::Item> { + let ParametersIterator { + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + } = self; + + if let Some(param) = kwarg.take() { + return Some(AnyParameterRef::Variadic(param)); + } + if let Some(param) = kwonlyargs.next_back() { + return Some(AnyParameterRef::NonVariadic(param)); } + if let Some(param) = vararg.take() { + return Some(AnyParameterRef::Variadic(param)); + } + if let Some(param) = args.next_back() { + return Some(AnyParameterRef::NonVariadic(param)); + } + posonlyargs.next_back().map(AnyParameterRef::NonVariadic) } } -impl Ranged for crate::nodes::ExprBoolOp { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::ExprNamed { - fn range(&self) -> TextRange { - self.range +impl FusedIterator for ParametersIterator<'_> {} + +/// We rely on the same invariants outlined in the comment above `Parameters::len()` +/// in order to implement `ExactSizeIterator` here +impl ExactSizeIterator for ParametersIterator<'_> {} + +impl<'a> IntoIterator for &'a Parameters { + type IntoIter = ParametersIterator<'a>; + type Item = AnyParameterRef<'a>; + fn into_iter(self) -> Self::IntoIter { + self.iter() } } -impl Ranged for crate::nodes::ExprBinOp { - fn range(&self) -> TextRange { - self.range + +impl<'a> IntoIterator for &'a Box<Parameters> { + type IntoIter = ParametersIterator<'a>; + type Item = AnyParameterRef<'a>; + fn into_iter(self) -> Self::IntoIter { + (&**self).into_iter() } } -impl Ranged for crate::nodes::ExprUnaryOp { - fn range(&self) -> TextRange { - self.range - } + +/// An alternative type of AST `arg`. This is used for each function argument that might have a default value. +/// Used by `Arguments` original type. +/// +/// NOTE: This type is different from original Python AST. + +#[derive(Clone, Debug, PartialEq)] +pub struct ParameterWithDefault { + pub range: TextRange, + pub parameter: Parameter, + pub default: Option<Box<Expr>>, } -impl Ranged for crate::nodes::ExprLambda { - fn range(&self) -> TextRange { - self.range + +impl ParameterWithDefault { + pub fn default(&self) -> Option<&Expr> { + self.default.as_deref() } -} -impl Ranged for crate::nodes::ExprIf { - fn range(&self) -> TextRange { - self.range + + pub const fn name(&self) -> &Identifier { + self.parameter.name() } -} -impl Ranged for crate::nodes::ExprDict { - fn range(&self) -> TextRange { - self.range + + pub fn annotation(&self) -> Option<&Expr> { + self.parameter.annotation() } } -impl Ranged for crate::nodes::ExprSet { - fn range(&self) -> TextRange { - self.range - } + +/// An AST node used to represent the arguments passed to a function call or class definition. +/// +/// For example, given: +/// ```python +/// foo(1, 2, 3, bar=4, baz=5) +/// ``` +/// The `Arguments` node would span from the left to right parentheses (inclusive), and contain +/// the arguments and keyword arguments in the order they appear in the source code. +/// +/// Similarly, given: +/// ```python +/// class Foo(Bar, baz=1, qux=2): +/// pass +/// ``` +/// The `Arguments` node would again span from the left to right parentheses (inclusive), and +/// contain the `Bar` argument and the `baz` and `qux` keyword arguments in the order they +/// appear in the source code. +/// +/// In the context of a class definition, the Python-style AST refers to the arguments as `bases`, +/// as they represent the "explicitly specified base classes", while the keyword arguments are +/// typically used for `metaclass`, with any additional arguments being passed to the `metaclass`. + +#[derive(Clone, Debug, PartialEq)] +pub struct Arguments { + pub range: TextRange, + pub args: Box<[Expr]>, + pub keywords: Box<[Keyword]>, } -impl Ranged for crate::nodes::ExprListComp { - fn range(&self) -> TextRange { - self.range - } + +/// An entry in the argument list of a function call. +#[derive(Copy, Clone, Debug, PartialEq)] +pub enum ArgOrKeyword<'a> { + Arg(&'a Expr), + Keyword(&'a Keyword), } -impl Ranged for crate::nodes::ExprSetComp { - fn range(&self) -> TextRange { - self.range + +impl<'a> ArgOrKeyword<'a> { + pub const fn value(self) -> &'a Expr { + match self { + ArgOrKeyword::Arg(argument) => argument, + ArgOrKeyword::Keyword(keyword) => &keyword.value, + } } } -impl Ranged for crate::nodes::ExprDictComp { - fn range(&self) -> TextRange { - self.range + +impl<'a> From<&'a Expr> for ArgOrKeyword<'a> { + fn from(arg: &'a Expr) -> Self { + Self::Arg(arg) } } -impl Ranged for crate::nodes::ExprGenerator { - fn range(&self) -> TextRange { - self.range + +impl<'a> From<&'a Keyword> for ArgOrKeyword<'a> { + fn from(keyword: &'a Keyword) -> Self { + Self::Keyword(keyword) } } -impl Ranged for crate::nodes::ExprAwait { + +impl Ranged for ArgOrKeyword<'_> { fn range(&self) -> TextRange { - self.range + match self { + Self::Arg(arg) => arg.range(), + Self::Keyword(keyword) => keyword.range(), + } } } -impl Ranged for crate::nodes::ExprYield { - fn range(&self) -> TextRange { - self.range + +impl Arguments { + /// Return the number of positional and keyword arguments. + pub fn len(&self) -> usize { + self.args.len() + self.keywords.len() } -} -impl Ranged for crate::nodes::ExprYieldFrom { - fn range(&self) -> TextRange { - self.range + + /// Return `true` if there are no positional or keyword arguments. + pub fn is_empty(&self) -> bool { + self.len() == 0 } -} -impl Ranged for crate::nodes::ExprCompare { - fn range(&self) -> TextRange { - self.range + + /// Return the [`Keyword`] with the given name, or `None` if no such [`Keyword`] exists. + pub fn find_keyword(&self, keyword_name: &str) -> Option<&Keyword> { + self.keywords.iter().find(|keyword| { + let Keyword { arg, .. } = keyword; + arg.as_ref().is_some_and(|arg| arg == keyword_name) + }) } -} -impl Ranged for crate::nodes::ExprCall { - fn range(&self) -> TextRange { - self.range + + /// Return the positional argument at the given index, or `None` if no such argument exists. + pub fn find_positional(&self, position: usize) -> Option<&Expr> { + self.args + .iter() + .take_while(|expr| !expr.is_starred_expr()) + .nth(position) } -} -impl Ranged for crate::nodes::ExprFString { - fn range(&self) -> TextRange { - self.range + + /// Return the value for the argument with the given name or at the given position, or `None` if no such + /// argument exists. Used to retrieve argument values that can be provided _either_ as keyword or + /// positional arguments. + pub fn find_argument_value(&self, name: &str, position: usize) -> Option<&Expr> { + self.find_argument(name, position).map(ArgOrKeyword::value) } -} -impl Ranged for crate::nodes::ExprAttribute { - fn range(&self) -> TextRange { - self.range + + /// Return the argument with the given name or at the given position, or `None` if no such + /// argument exists. Used to retrieve arguments that can be provided _either_ as keyword or + /// positional arguments. + pub fn find_argument(&self, name: &str, position: usize) -> Option<ArgOrKeyword> { + self.find_keyword(name) + .map(ArgOrKeyword::from) + .or_else(|| self.find_positional(position).map(ArgOrKeyword::from)) } -} -impl Ranged for crate::nodes::ExprSubscript { - fn range(&self) -> TextRange { - self.range + + /// Return the positional and keyword arguments in the order of declaration. + /// + /// Positional arguments are generally before keyword arguments, but star arguments are an + /// exception: + /// ```python + /// class A(*args, a=2, *args2, **kwargs): + /// pass + /// + /// f(*args, a=2, *args2, **kwargs) + /// ``` + /// where `*args` and `args2` are `args` while `a=1` and `kwargs` are `keywords`. + /// + /// If you would just chain `args` and `keywords` the call would get reordered which we don't + /// want. This function instead "merge sorts" them into the correct order. + /// + /// Note that the order of evaluation is always first `args`, then `keywords`: + /// ```python + /// def f(*args, **kwargs): + /// pass + /// + /// def g(x): + /// print(x) + /// return x + /// + /// + /// f(*g([1]), a=g(2), *g([3]), **g({"4": 5})) + /// ``` + /// Output: + /// ```text + /// [1] + /// [3] + /// 2 + /// {'4': 5} + /// ``` + pub fn arguments_source_order(&self) -> impl Iterator<Item = ArgOrKeyword<'_>> { + let args = self.args.iter().map(ArgOrKeyword::Arg); + let keywords = self.keywords.iter().map(ArgOrKeyword::Keyword); + args.merge_by(keywords, |left, right| left.start() < right.start()) } -} -impl Ranged for crate::nodes::ExprStarred { - fn range(&self) -> TextRange { - self.range + + pub fn inner_range(&self) -> TextRange { + TextRange::new(self.l_paren_range().end(), self.r_paren_range().start()) } -} -impl Ranged for crate::nodes::ExprName { - fn range(&self) -> TextRange { - self.range + + pub fn l_paren_range(&self) -> TextRange { + TextRange::at(self.start(), '('.text_len()) } -} -impl Ranged for crate::nodes::ExprList { - fn range(&self) -> TextRange { - self.range + + pub fn r_paren_range(&self) -> TextRange { + TextRange::new(self.end() - ')'.text_len(), self.end()) } } -impl Ranged for crate::nodes::ExprTuple { - fn range(&self) -> TextRange { - self.range - } + +/// An AST node used to represent a sequence of type parameters. +/// +/// For example, given: +/// ```python +/// class C[T, U, V]: ... +/// ``` +/// The `TypeParams` node would span from the left to right brackets (inclusive), and contain +/// the `T`, `U`, and `V` type parameters in the order they appear in the source code. + +#[derive(Clone, Debug, PartialEq)] +pub struct TypeParams { + pub range: TextRange, + pub type_params: Vec<TypeParam>, } -impl Ranged for crate::nodes::ExprSlice { - fn range(&self) -> TextRange { - self.range + +impl Deref for TypeParams { + type Target = [TypeParam]; + + fn deref(&self) -> &Self::Target { + &self.type_params } } -impl Ranged for crate::nodes::ExprIpyEscapeCommand { - fn range(&self) -> TextRange { - self.range - } + +/// A suite represents a [Vec] of [Stmt]. +/// +/// See: <https://docs.python.org/3/reference/compound_stmts.html#grammar-token-python-grammar-suite> +pub type Suite = Vec<Stmt>; + +/// The kind of escape command as defined in [IPython Syntax] in the IPython codebase. +/// +/// [IPython Syntax]: https://github.com/ipython/ipython/blob/635815e8f1ded5b764d66cacc80bbe25e9e2587f/IPython/core/inputtransformer2.py#L335-L343 +#[derive(PartialEq, Eq, Debug, Clone, Hash, Copy)] +pub enum IpyEscapeKind { + /// Send line to underlying system shell (`!`). + Shell, + /// Send line to system shell and capture output (`!!`). + ShCap, + /// Show help on object (`?`). + Help, + /// Show help on object, with extra verbosity (`??`). + Help2, + /// Call magic function (`%`). + Magic, + /// Call cell magic function (`%%`). + Magic2, + /// Call first argument with rest of line as arguments after splitting on whitespace + /// and quote each as string (`,`). + Quote, + /// Call first argument with rest of line as an argument quoted as a single string (`;`). + Quote2, + /// Call first argument with rest of line as arguments (`/`). + Paren, } -impl Ranged for crate::Expr { - fn range(&self) -> TextRange { - match self { - Self::BoolOp(node) => node.range(), - Self::Named(node) => node.range(), - Self::BinOp(node) => node.range(), - Self::UnaryOp(node) => node.range(), - Self::Lambda(node) => node.range(), - Self::If(node) => node.range(), - Self::Dict(node) => node.range(), - Self::Set(node) => node.range(), - Self::ListComp(node) => node.range(), - Self::SetComp(node) => node.range(), - Self::DictComp(node) => node.range(), - Self::Generator(node) => node.range(), - Self::Await(node) => node.range(), - Self::Yield(node) => node.range(), - Self::YieldFrom(node) => node.range(), - Self::Compare(node) => node.range(), - Self::Call(node) => node.range(), - Self::FString(node) => node.range(), - Self::StringLiteral(node) => node.range(), - Self::BytesLiteral(node) => node.range(), - Self::NumberLiteral(node) => node.range(), - Self::BooleanLiteral(node) => node.range(), - Self::NoneLiteral(node) => node.range(), - Self::EllipsisLiteral(node) => node.range(), - Self::Attribute(node) => node.range(), - Self::Subscript(node) => node.range(), - Self::Starred(node) => node.range(), - Self::Name(node) => node.range(), - Self::List(node) => node.range(), - Self::Tuple(node) => node.range(), - Self::Slice(node) => node.range(), - Self::IpyEscapeCommand(node) => node.range(), + +impl TryFrom<char> for IpyEscapeKind { + type Error = String; + + fn try_from(ch: char) -> Result<Self, Self::Error> { + match ch { + '!' => Ok(IpyEscapeKind::Shell), + '?' => Ok(IpyEscapeKind::Help), + '%' => Ok(IpyEscapeKind::Magic), + ',' => Ok(IpyEscapeKind::Quote), + ';' => Ok(IpyEscapeKind::Quote2), + '/' => Ok(IpyEscapeKind::Paren), + _ => Err(format!("Unexpected magic escape: {ch}")), } } } -impl Ranged for crate::nodes::Comprehension { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::ExceptHandlerExceptHandler { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::ExceptHandler { - fn range(&self) -> TextRange { - match self { - Self::ExceptHandler(node) => node.range(), + +impl TryFrom<[char; 2]> for IpyEscapeKind { + type Error = String; + + fn try_from(ch: [char; 2]) -> Result<Self, Self::Error> { + match ch { + ['!', '!'] => Ok(IpyEscapeKind::ShCap), + ['?', '?'] => Ok(IpyEscapeKind::Help2), + ['%', '%'] => Ok(IpyEscapeKind::Magic2), + [c1, c2] => Err(format!("Unexpected magic escape: {c1}{c2}")), } } } -impl Ranged for crate::nodes::Parameter { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::Keyword { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::Alias { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::WithItem { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::MatchCase { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::PatternMatchValue { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::PatternMatchSingleton { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::PatternMatchSequence { - fn range(&self) -> TextRange { - self.range - } -} -impl Ranged for crate::nodes::PatternMatchMapping { - fn range(&self) -> TextRange { - self.range + +impl fmt::Display for IpyEscapeKind { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.as_str()) } } -impl Ranged for crate::nodes::PatternMatchClass { - fn range(&self) -> TextRange { - self.range + +impl IpyEscapeKind { + /// Returns `true` if the escape kind is help i.e., `?` or `??`. + pub const fn is_help(self) -> bool { + matches!(self, IpyEscapeKind::Help | IpyEscapeKind::Help2) } -} -impl Ranged for crate::nodes::PatternMatchStar { - fn range(&self) -> TextRange { - self.range + + /// Returns `true` if the escape kind is magic i.e., `%` or `%%`. + pub const fn is_magic(self) -> bool { + matches!(self, IpyEscapeKind::Magic | IpyEscapeKind::Magic2) } -} -impl Ranged for crate::nodes::PatternMatchAs { - fn range(&self) -> TextRange { - self.range + + pub fn as_str(self) -> &'static str { + match self { + IpyEscapeKind::Shell => "!", + IpyEscapeKind::ShCap => "!!", + IpyEscapeKind::Help => "?", + IpyEscapeKind::Help2 => "??", + IpyEscapeKind::Magic => "%", + IpyEscapeKind::Magic2 => "%%", + IpyEscapeKind::Quote => ",", + IpyEscapeKind::Quote2 => ";", + IpyEscapeKind::Paren => "/", + } } } -impl Ranged for crate::nodes::PatternMatchOr { - fn range(&self) -> TextRange { - self.range - } + +/// An `Identifier` with an empty `id` is invalid. +/// +/// For example, in the following code `id` will be empty. +/// ```python +/// def 1(): +/// ... +/// ``` +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub struct Identifier { + pub id: Name, + pub range: TextRange, } -impl Ranged for crate::Pattern { - fn range(&self) -> TextRange { - match self { - Self::MatchValue(node) => node.range(), - Self::MatchSingleton(node) => node.range(), - Self::MatchSequence(node) => node.range(), - Self::MatchMapping(node) => node.range(), - Self::MatchClass(node) => node.range(), - Self::MatchStar(node) => node.range(), - Self::MatchAs(node) => node.range(), - Self::MatchOr(node) => node.range(), + +impl Identifier { + #[inline] + pub fn new(id: impl Into<Name>, range: TextRange) -> Self { + Self { + id: id.into(), + range, } } -} -impl Ranged for crate::nodes::PatternArguments { - fn range(&self) -> TextRange { - self.range + + pub fn id(&self) -> &Name { + &self.id } -} -impl Ranged for crate::nodes::PatternKeyword { - fn range(&self) -> TextRange { - self.range + + pub fn is_valid(&self) -> bool { + !self.id.is_empty() } } -impl Ranged for crate::nodes::TypeParams { - fn range(&self) -> TextRange { - self.range +impl Identifier { + #[inline] + pub fn as_str(&self) -> &str { + self.id.as_str() } } -impl Ranged for crate::nodes::TypeParamTypeVar { - fn range(&self) -> TextRange { - self.range + +impl PartialEq<str> for Identifier { + #[inline] + fn eq(&self, other: &str) -> bool { + self.id == other } } -impl Ranged for crate::nodes::TypeParamTypeVarTuple { - fn range(&self) -> TextRange { - self.range + +impl PartialEq<String> for Identifier { + #[inline] + fn eq(&self, other: &String) -> bool { + self.id == other } } -impl Ranged for crate::nodes::TypeParamParamSpec { - fn range(&self) -> TextRange { - self.range + +impl std::ops::Deref for Identifier { + type Target = str; + #[inline] + fn deref(&self) -> &Self::Target { + self.id.as_str() } } -impl Ranged for crate::TypeParam { - fn range(&self) -> TextRange { - match self { - Self::TypeVar(node) => node.range(), - Self::TypeVarTuple(node) => node.range(), - Self::ParamSpec(node) => node.range(), - } + +impl AsRef<str> for Identifier { + #[inline] + fn as_ref(&self) -> &str { + self.id.as_str() } } -impl Ranged for crate::nodes::Decorator { - fn range(&self) -> TextRange { - self.range + +impl std::fmt::Display for Identifier { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + std::fmt::Display::fmt(&self.id, f) } } -impl Ranged for crate::nodes::Arguments { - fn range(&self) -> TextRange { - self.range + +impl From<Identifier> for Name { + #[inline] + fn from(identifier: Identifier) -> Name { + identifier.id } } -impl Ranged for crate::nodes::Parameters { - fn range(&self) -> TextRange { - self.range - } + +#[derive(Clone, Copy, Debug, Hash, PartialEq)] +pub enum Singleton { + None, + True, + False, } -impl Ranged for crate::nodes::ParameterWithDefault { - fn range(&self) -> TextRange { - self.range + +impl From<bool> for Singleton { + fn from(value: bool) -> Self { + if value { + Singleton::True + } else { + Singleton::False + } } } #[cfg(test)] mod tests { - #[allow(clippy::wildcard_imports)] - use super::*; + use crate::Mod; + use crate::generated::*; #[test] #[cfg(target_pointer_width = "64")] @@ -4567,8 +3132,7 @@ mod tests { assert!(std::mem::size_of::<StmtClassDef>() <= 104); assert!(std::mem::size_of::<StmtTry>() <= 112); assert!(std::mem::size_of::<Mod>() <= 32); - // 96 for Rustc < 1.76 - assert!(matches!(std::mem::size_of::<Pattern>(), 88 | 96)); + assert!(matches!(std::mem::size_of::<Pattern>(), 88)); assert_eq!(std::mem::size_of::<Expr>(), 64); assert_eq!(std::mem::size_of::<ExprAttribute>(), 56); @@ -4582,8 +3146,7 @@ mod tests { assert_eq!(std::mem::size_of::<ExprDict>(), 32); assert_eq!(std::mem::size_of::<ExprDictComp>(), 48); assert_eq!(std::mem::size_of::<ExprEllipsisLiteral>(), 8); - // 56 for Rustc < 1.76 - assert!(matches!(std::mem::size_of::<ExprFString>(), 48 | 56)); + assert!(matches!(std::mem::size_of::<ExprFString>(), 48)); assert_eq!(std::mem::size_of::<ExprGenerator>(), 48); assert_eq!(std::mem::size_of::<ExprIf>(), 32); assert_eq!(std::mem::size_of::<ExprIpyEscapeCommand>(), 32); diff --git a/crates/ruff_python_ast/src/operator_precedence.rs b/crates/ruff_python_ast/src/operator_precedence.rs new file mode 100644 index 0000000000000..750ef7f719d3c --- /dev/null +++ b/crates/ruff_python_ast/src/operator_precedence.rs @@ -0,0 +1,194 @@ +use crate::{BoolOp, Expr, ExprRef, Operator, UnaryOp}; + +/// Represents the precedence levels for Python expressions. +/// Variants at the top have lower precedence and variants at the bottom have +/// higher precedence. +/// +/// See: <https://docs.python.org/3/reference/expressions.html#operator-precedence> +#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)] +pub enum OperatorPrecedence { + /// The lowest (virtual) precedence level + None, + /// Precedence of `yield` and `yield from` expressions. + Yield, + /// Precedence of assignment expressions (`name := expr`). + Assign, + /// Precedence of starred expressions (`*expr`). + Starred, + /// Precedence of lambda expressions (`lambda args: expr`). + Lambda, + /// Precedence of if/else expressions (`expr if cond else expr`). + IfElse, + /// Precedence of boolean `or` expressions. + Or, + /// Precedence of boolean `and` expressions. + And, + /// Precedence of boolean `not` expressions. + Not, + /// Precedence of comparisons (`<`, `<=`, `>`, `>=`, `!=`, `==`), + /// memberships (`in`, `not in`) and identity tests (`is`, `is not`). + ComparisonsMembershipIdentity, + /// Precedence of bitwise `|` operator. + BitOr, + /// Precedence of bitwise `^` operator. + BitXor, + /// Precedence of bitwise `&` operator. + BitAnd, + /// Precedence of left and right shift expressions (`<<`, `>>`). + LeftRightShift, + /// Precedence of addition and subtraction expressions (`+`, `-`). + AddSub, + /// Precedence of multiplication (`*`), matrix multiplication (`@`), division (`/`), + /// floor division (`//`) and remainder (`%`) expressions. + MulDivRemain, + /// Precedence of unary positive (`+`), negative (`-`), and bitwise NOT (`~`) expressions. + PosNegBitNot, + /// Precedence of exponentiation expressions (`**`). + Exponent, + /// Precedence of `await` expressions. + Await, + /// Precedence of call expressions (`()`), attribute access (`.`), and subscript (`[]`) expressions. + CallAttribute, + /// Precedence of atomic expressions (literals, names, containers). + Atomic, +} + +impl OperatorPrecedence { + pub fn from_expr_ref(expr: &ExprRef) -> Self { + match expr { + // Binding or parenthesized expression, list display, dictionary display, set display + ExprRef::Tuple(_) + | ExprRef::Dict(_) + | ExprRef::Set(_) + | ExprRef::ListComp(_) + | ExprRef::List(_) + | ExprRef::SetComp(_) + | ExprRef::DictComp(_) + | ExprRef::Generator(_) + | ExprRef::Name(_) + | ExprRef::StringLiteral(_) + | ExprRef::BytesLiteral(_) + | ExprRef::NumberLiteral(_) + | ExprRef::BooleanLiteral(_) + | ExprRef::NoneLiteral(_) + | ExprRef::EllipsisLiteral(_) + | ExprRef::FString(_) => Self::Atomic, + // Subscription, slicing, call, attribute reference + ExprRef::Attribute(_) + | ExprRef::Subscript(_) + | ExprRef::Call(_) + | ExprRef::Slice(_) => Self::CallAttribute, + + // Await expression + ExprRef::Await(_) => Self::Await, + + // Exponentiation ** + // Handled below along with other binary operators + + // Unary operators: +x, -x, ~x (except boolean not) + ExprRef::UnaryOp(operator) => match operator.op { + UnaryOp::UAdd | UnaryOp::USub | UnaryOp::Invert => Self::PosNegBitNot, + UnaryOp::Not => Self::Not, + }, + + // Math binary ops + ExprRef::BinOp(binary_operation) => Self::from(binary_operation.op), + + // Comparisons: <, <=, >, >=, ==, !=, in, not in, is, is not + ExprRef::Compare(_) => Self::ComparisonsMembershipIdentity, + + // Boolean not + // Handled above in unary operators + + // Boolean operations: and, or + ExprRef::BoolOp(bool_op) => Self::from(bool_op.op), + + // Conditional expressions: x if y else z + ExprRef::If(_) => Self::IfElse, + + // Lambda expressions + ExprRef::Lambda(_) => Self::Lambda, + + // Unpacking also omitted in the docs, but has almost the lowest precedence, + // except for assignment & yield expressions. E.g. `[*(v := [1,2])]` is valid + // but `[*v := [1,2]] would fail on incorrect syntax because * will associate + // `v` before the assignment. + ExprRef::Starred(_) => Self::Starred, + + // Assignment expressions (aka named) + ExprRef::Named(_) => Self::Assign, + + // Although omitted in docs, yield expressions may be used inside an expression + // but must be parenthesized. So for our purposes we assume they just have + // the lowest "real" precedence. + ExprRef::Yield(_) | ExprRef::YieldFrom(_) => Self::Yield, + + // Not a real python expression, so treat as lowest as well + ExprRef::IpyEscapeCommand(_) => Self::None, + } + } + + pub fn from_expr(expr: &Expr) -> Self { + Self::from(&ExprRef::from(expr)) + } + + /// Returns `true` if the precedence is right-associative i.e., the operations are evaluated + /// from right to left. + pub fn is_right_associative(self) -> bool { + matches!(self, OperatorPrecedence::Exponent) + } +} + +impl From<&Expr> for OperatorPrecedence { + fn from(expr: &Expr) -> Self { + Self::from_expr(expr) + } +} + +impl<'a> From<&ExprRef<'a>> for OperatorPrecedence { + fn from(expr_ref: &ExprRef<'a>) -> Self { + Self::from_expr_ref(expr_ref) + } +} + +impl From<Operator> for OperatorPrecedence { + fn from(operator: Operator) -> Self { + match operator { + // Multiplication, matrix multiplication, division, floor division, remainder: + // *, @, /, //, % + Operator::Mult + | Operator::MatMult + | Operator::Div + | Operator::Mod + | Operator::FloorDiv => Self::MulDivRemain, + // Addition, subtraction + Operator::Add | Operator::Sub => Self::AddSub, + // Bitwise shifts: <<, >> + Operator::LShift | Operator::RShift => Self::LeftRightShift, + // Bitwise operations: &, ^, | + Operator::BitAnd => Self::BitAnd, + Operator::BitXor => Self::BitXor, + Operator::BitOr => Self::BitOr, + // Exponentiation ** + Operator::Pow => Self::Exponent, + } + } +} + +impl From<BoolOp> for OperatorPrecedence { + fn from(operator: BoolOp) -> Self { + match operator { + BoolOp::And => Self::And, + BoolOp::Or => Self::Or, + } + } +} + +impl From<UnaryOp> for OperatorPrecedence { + fn from(unary_op: UnaryOp) -> Self { + match unary_op { + UnaryOp::UAdd | UnaryOp::USub | UnaryOp::Invert => Self::PosNegBitNot, + UnaryOp::Not => Self::Not, + } + } +} diff --git a/crates/ruff_python_ast/src/parenthesize.rs b/crates/ruff_python_ast/src/parenthesize.rs index 36ec307d73bfc..a7fb1224cefa9 100644 --- a/crates/ruff_python_ast/src/parenthesize.rs +++ b/crates/ruff_python_ast/src/parenthesize.rs @@ -2,7 +2,7 @@ use ruff_python_trivia::{BackwardsTokenizer, CommentRanges, SimpleTokenKind, Sim use ruff_text_size::{Ranged, TextLen, TextRange}; use crate::AnyNodeRef; -use crate::ExpressionRef; +use crate::ExprRef; /// Returns an iterator over the ranges of the optional parentheses surrounding an expression. /// @@ -12,7 +12,7 @@ use crate::ExpressionRef; /// parentheses around `a` even if the parentheses actually belong to `f`. That is why you should /// generally prefer [`parenthesized_range`]. pub fn parentheses_iterator<'a>( - expr: ExpressionRef<'a>, + expr: ExprRef<'a>, parent: Option<AnyNodeRef>, comment_ranges: &'a CommentRanges, source: &'a str, @@ -58,7 +58,7 @@ pub fn parentheses_iterator<'a>( /// Returns the [`TextRange`] of a given expression including parentheses, if the expression is /// parenthesized; or `None`, if the expression is not parenthesized. pub fn parenthesized_range( - expr: ExpressionRef, + expr: ExprRef, parent: AnyNodeRef, comment_ranges: &CommentRanges, source: &str, diff --git a/crates/ruff_python_ast/src/python_version.rs b/crates/ruff_python_ast/src/python_version.rs new file mode 100644 index 0000000000000..0658bc8dee1df --- /dev/null +++ b/crates/ruff_python_ast/src/python_version.rs @@ -0,0 +1,202 @@ +use std::fmt; + +/// Representation of a Python version. +/// +/// N.B. This does not necessarily represent a Python version that we actually support. +#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)] +#[cfg_attr(feature = "cache", derive(ruff_macros::CacheKey))] +pub struct PythonVersion { + pub major: u8, + pub minor: u8, +} + +impl PythonVersion { + pub const PY37: PythonVersion = PythonVersion { major: 3, minor: 7 }; + pub const PY38: PythonVersion = PythonVersion { major: 3, minor: 8 }; + pub const PY39: PythonVersion = PythonVersion { major: 3, minor: 9 }; + pub const PY310: PythonVersion = PythonVersion { + major: 3, + minor: 10, + }; + pub const PY311: PythonVersion = PythonVersion { + major: 3, + minor: 11, + }; + pub const PY312: PythonVersion = PythonVersion { + major: 3, + minor: 12, + }; + pub const PY313: PythonVersion = PythonVersion { + major: 3, + minor: 13, + }; + pub const PY314: PythonVersion = PythonVersion { + major: 3, + minor: 14, + }; + + pub fn iter() -> impl Iterator<Item = PythonVersion> { + [ + PythonVersion::PY37, + PythonVersion::PY38, + PythonVersion::PY39, + PythonVersion::PY310, + PythonVersion::PY311, + PythonVersion::PY312, + PythonVersion::PY313, + PythonVersion::PY314, + ] + .into_iter() + } + + /// The minimum supported Python version. + pub const fn lowest() -> Self { + Self::PY37 + } + + // TODO: change this to 314 when it is released + pub const fn latest() -> Self { + Self::PY313 + } + + pub const fn latest_ty() -> Self { + // Make sure to update the default value for `EnvironmentOptions::python_version` when bumping this version. + Self::PY313 + } + + pub const fn as_tuple(self) -> (u8, u8) { + (self.major, self.minor) + } + + pub fn free_threaded_build_available(self) -> bool { + self >= PythonVersion::PY313 + } + + /// Return `true` if the current version supports [PEP 701]. + /// + /// [PEP 701]: https://peps.python.org/pep-0701/ + pub fn supports_pep_701(self) -> bool { + self >= Self::PY312 + } + + pub fn defers_annotations(self) -> bool { + self >= Self::PY314 + } +} + +impl Default for PythonVersion { + fn default() -> Self { + Self::PY39 + } +} + +impl TryFrom<(&str, &str)> for PythonVersion { + type Error = std::num::ParseIntError; + + fn try_from(value: (&str, &str)) -> Result<Self, Self::Error> { + let (major, minor) = value; + Ok(Self { + major: major.parse()?, + minor: minor.parse()?, + }) + } +} + +impl From<(u8, u8)> for PythonVersion { + fn from(value: (u8, u8)) -> Self { + let (major, minor) = value; + Self { major, minor } + } +} + +impl fmt::Display for PythonVersion { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let PythonVersion { major, minor } = self; + write!(f, "{major}.{minor}") + } +} + +#[cfg(feature = "serde")] +mod serde { + use super::PythonVersion; + + impl<'de> serde::Deserialize<'de> for PythonVersion { + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> + where + D: serde::Deserializer<'de>, + { + let as_str = String::deserialize(deserializer)?; + + if let Some((major, minor)) = as_str.split_once('.') { + let major = major.parse().map_err(|err| { + serde::de::Error::custom(format!("invalid major version: {err}")) + })?; + let minor = minor.parse().map_err(|err| { + serde::de::Error::custom(format!("invalid minor version: {err}")) + })?; + + Ok((major, minor).into()) + } else { + let major = as_str.parse().map_err(|err| { + serde::de::Error::custom(format!( + "invalid python-version: {err}, expected: `major.minor`" + )) + })?; + + Ok((major, 0).into()) + } + } + } + + impl serde::Serialize for PythonVersion { + fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> + where + S: serde::Serializer, + { + serializer.serialize_str(&self.to_string()) + } + } +} + +#[cfg(feature = "schemars")] +mod schemars { + use super::PythonVersion; + use schemars::_serde_json::Value; + use schemars::JsonSchema; + use schemars::schema::{Metadata, Schema, SchemaObject, SubschemaValidation}; + + impl JsonSchema for PythonVersion { + fn schema_name() -> String { + "PythonVersion".to_string() + } + + fn json_schema(_gen: &mut schemars::r#gen::SchemaGenerator) -> Schema { + let sub_schemas = std::iter::once(Schema::Object(SchemaObject { + instance_type: Some(schemars::schema::InstanceType::String.into()), + string: Some(Box::new(schemars::schema::StringValidation { + pattern: Some(r"^\d+\.\d+$".to_string()), + ..Default::default() + })), + ..Default::default() + })) + .chain(Self::iter().map(|v| { + Schema::Object(SchemaObject { + const_value: Some(Value::String(v.to_string())), + metadata: Some(Box::new(Metadata { + description: Some(format!("Python {v}")), + ..Metadata::default() + })), + ..SchemaObject::default() + }) + })); + + Schema::Object(SchemaObject { + subschemas: Some(Box::new(SubschemaValidation { + any_of: Some(sub_schemas.collect()), + ..Default::default() + })), + ..SchemaObject::default() + }) + } + } +} diff --git a/crates/ruff_python_ast/src/relocate.rs b/crates/ruff_python_ast/src/relocate.rs index f4f327d0735a7..7410b9fc5eb8c 100644 --- a/crates/ruff_python_ast/src/relocate.rs +++ b/crates/ruff_python_ast/src/relocate.rs @@ -1,7 +1,8 @@ use ruff_text_size::TextRange; -use crate::visitor::transformer::{walk_expr, walk_keyword, Transformer}; -use crate::{nodes, Expr, Keyword}; +use crate::visitor::transformer::{Transformer, walk_expr, walk_keyword}; +use crate::{self as ast}; +use crate::{Expr, Keyword}; /// Change an expression's location (recursively) to match a desired, fixed /// range. @@ -17,100 +18,100 @@ struct Relocator { impl Transformer for Relocator { fn visit_expr(&self, expr: &mut Expr) { match expr { - Expr::BoolOp(nodes::ExprBoolOp { range, .. }) => { + Expr::BoolOp(ast::ExprBoolOp { range, .. }) => { *range = self.range; } - Expr::Named(nodes::ExprNamed { range, .. }) => { + Expr::Named(ast::ExprNamed { range, .. }) => { *range = self.range; } - Expr::BinOp(nodes::ExprBinOp { range, .. }) => { + Expr::BinOp(ast::ExprBinOp { range, .. }) => { *range = self.range; } - Expr::UnaryOp(nodes::ExprUnaryOp { range, .. }) => { + Expr::UnaryOp(ast::ExprUnaryOp { range, .. }) => { *range = self.range; } - Expr::Lambda(nodes::ExprLambda { range, .. }) => { + Expr::Lambda(ast::ExprLambda { range, .. }) => { *range = self.range; } - Expr::If(nodes::ExprIf { range, .. }) => { + Expr::If(ast::ExprIf { range, .. }) => { *range = self.range; } - Expr::Dict(nodes::ExprDict { range, .. }) => { + Expr::Dict(ast::ExprDict { range, .. }) => { *range = self.range; } - Expr::Set(nodes::ExprSet { range, .. }) => { + Expr::Set(ast::ExprSet { range, .. }) => { *range = self.range; } - Expr::ListComp(nodes::ExprListComp { range, .. }) => { + Expr::ListComp(ast::ExprListComp { range, .. }) => { *range = self.range; } - Expr::SetComp(nodes::ExprSetComp { range, .. }) => { + Expr::SetComp(ast::ExprSetComp { range, .. }) => { *range = self.range; } - Expr::DictComp(nodes::ExprDictComp { range, .. }) => { + Expr::DictComp(ast::ExprDictComp { range, .. }) => { *range = self.range; } - Expr::Generator(nodes::ExprGenerator { range, .. }) => { + Expr::Generator(ast::ExprGenerator { range, .. }) => { *range = self.range; } - Expr::Await(nodes::ExprAwait { range, .. }) => { + Expr::Await(ast::ExprAwait { range, .. }) => { *range = self.range; } - Expr::Yield(nodes::ExprYield { range, .. }) => { + Expr::Yield(ast::ExprYield { range, .. }) => { *range = self.range; } - Expr::YieldFrom(nodes::ExprYieldFrom { range, .. }) => { + Expr::YieldFrom(ast::ExprYieldFrom { range, .. }) => { *range = self.range; } - Expr::Compare(nodes::ExprCompare { range, .. }) => { + Expr::Compare(ast::ExprCompare { range, .. }) => { *range = self.range; } - Expr::Call(nodes::ExprCall { range, .. }) => { + Expr::Call(ast::ExprCall { range, .. }) => { *range = self.range; } - Expr::FString(nodes::ExprFString { range, .. }) => { + Expr::FString(ast::ExprFString { range, .. }) => { *range = self.range; } - Expr::StringLiteral(nodes::ExprStringLiteral { range, .. }) => { + Expr::StringLiteral(ast::ExprStringLiteral { range, .. }) => { *range = self.range; } - Expr::BytesLiteral(nodes::ExprBytesLiteral { range, .. }) => { + Expr::BytesLiteral(ast::ExprBytesLiteral { range, .. }) => { *range = self.range; } - Expr::NumberLiteral(nodes::ExprNumberLiteral { range, .. }) => { + Expr::NumberLiteral(ast::ExprNumberLiteral { range, .. }) => { *range = self.range; } - Expr::BooleanLiteral(nodes::ExprBooleanLiteral { range, .. }) => { + Expr::BooleanLiteral(ast::ExprBooleanLiteral { range, .. }) => { *range = self.range; } - Expr::NoneLiteral(nodes::ExprNoneLiteral { range }) => { + Expr::NoneLiteral(ast::ExprNoneLiteral { range }) => { *range = self.range; } - Expr::EllipsisLiteral(nodes::ExprEllipsisLiteral { range }) => { + Expr::EllipsisLiteral(ast::ExprEllipsisLiteral { range }) => { *range = self.range; } - Expr::Attribute(nodes::ExprAttribute { range, .. }) => { + Expr::Attribute(ast::ExprAttribute { range, .. }) => { *range = self.range; } - Expr::Subscript(nodes::ExprSubscript { range, .. }) => { + Expr::Subscript(ast::ExprSubscript { range, .. }) => { *range = self.range; } - Expr::Starred(nodes::ExprStarred { range, .. }) => { + Expr::Starred(ast::ExprStarred { range, .. }) => { *range = self.range; } - Expr::Name(nodes::ExprName { range, .. }) => { + Expr::Name(ast::ExprName { range, .. }) => { *range = self.range; } - Expr::List(nodes::ExprList { range, .. }) => { + Expr::List(ast::ExprList { range, .. }) => { *range = self.range; } - Expr::Tuple(nodes::ExprTuple { range, .. }) => { + Expr::Tuple(ast::ExprTuple { range, .. }) => { *range = self.range; } - Expr::Slice(nodes::ExprSlice { range, .. }) => { + Expr::Slice(ast::ExprSlice { range, .. }) => { *range = self.range; } - Expr::IpyEscapeCommand(nodes::ExprIpyEscapeCommand { range, .. }) => { + Expr::IpyEscapeCommand(ast::ExprIpyEscapeCommand { range, .. }) => { *range = self.range; } } diff --git a/crates/ruff_python_ast/src/script.rs b/crates/ruff_python_ast/src/script.rs index f6b592a7b9077..287769d338f5a 100644 --- a/crates/ruff_python_ast/src/script.rs +++ b/crates/ruff_python_ast/src/script.rs @@ -67,7 +67,7 @@ impl ScriptTag { let mut lines = contents.lines(); // Ensure that the first line is exactly `# /// script`. - if !lines.next().is_some_and(|line| line == "# /// script") { + if lines.next().is_none_or(|line| line != "# /// script") { return None; } diff --git a/crates/ruff_python_ast/src/str.rs b/crates/ruff_python_ast/src/str.rs index 13a08d2ccc793..5a8dd1093e3b5 100644 --- a/crates/ruff_python_ast/src/str.rs +++ b/crates/ruff_python_ast/src/str.rs @@ -24,6 +24,14 @@ impl Quote { } } + #[inline] + pub const fn as_str(self) -> &'static str { + match self { + Self::Single => "'", + Self::Double => "\"", + } + } + #[must_use] #[inline] pub const fn opposite(self) -> Self { @@ -60,6 +68,24 @@ impl TryFrom<char> for Quote { } } +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub enum TripleQuotes { + Yes, + No, +} + +impl TripleQuotes { + #[must_use] + pub const fn is_yes(self) -> bool { + matches!(self, Self::Yes) + } + + #[must_use] + pub const fn is_no(self) -> bool { + matches!(self, Self::No) + } +} + /// Includes all permutations of `r`, `u`, `f`, and `fr` (`ur` is invalid, as is `uf`). This /// includes all possible orders, and all possible casings, for both single and triple quotes. /// diff --git a/crates/ruff_python_ast/src/str_prefix.rs b/crates/ruff_python_ast/src/str_prefix.rs index b2da865d1772f..37f8421711da8 100644 --- a/crates/ruff_python_ast/src/str_prefix.rs +++ b/crates/ruff_python_ast/src/str_prefix.rs @@ -1,3 +1,5 @@ +use ruff_text_size::TextSize; + use std::fmt; /// Enumerations of the valid prefixes a string literal can have. @@ -33,6 +35,13 @@ impl StringLiteralPrefix { Self::Raw { uppercase: false } => "r", } } + + pub const fn text_len(self) -> TextSize { + match self { + Self::Empty => TextSize::new(0), + Self::Unicode | Self::Raw { .. } => TextSize::new(1), + } + } } impl fmt::Display for StringLiteralPrefix { @@ -62,6 +71,13 @@ impl FStringPrefix { } } + pub const fn text_len(self) -> TextSize { + match self { + Self::Regular => TextSize::new(1), + Self::Raw { .. } => TextSize::new(2), + } + } + /// Return true if this prefix indicates a "raw f-string", /// e.g. `rf"{bar}"` or `Rf"{bar}"` pub const fn is_raw(self) -> bool { @@ -96,6 +112,13 @@ impl ByteStringPrefix { } } + pub const fn text_len(self) -> TextSize { + match self { + Self::Regular => TextSize::new(1), + Self::Raw { .. } => TextSize::new(2), + } + } + /// Return true if this prefix indicates a "raw bytestring", /// e.g. `rb"foo"` or `Rb"foo"` pub const fn is_raw(self) -> bool { @@ -141,6 +164,14 @@ impl AnyStringPrefix { } } + pub const fn text_len(self) -> TextSize { + match self { + Self::Regular(regular_prefix) => regular_prefix.text_len(), + Self::Bytes(bytestring_prefix) => bytestring_prefix.text_len(), + Self::Format(fstring_prefix) => fstring_prefix.text_len(), + } + } + pub const fn is_raw(self) -> bool { match self { Self::Regular(regular_prefix) => regular_prefix.is_raw(), diff --git a/crates/ruff_python_ast/src/visitor.rs b/crates/ruff_python_ast/src/visitor.rs index 0f16af535461c..8bb2013efc07b 100644 --- a/crates/ruff_python_ast/src/visitor.rs +++ b/crates/ruff_python_ast/src/visitor.rs @@ -276,10 +276,10 @@ pub fn walk_stmt<'a, V: Visitor<'a> + ?Sized>(visitor: &mut V, stmt: &'a Stmt) { }) => { if let Some(expr) = exc { visitor.visit_expr(expr); - }; + } if let Some(expr) = cause { visitor.visit_expr(expr); - }; + } } Stmt::Try(ast::StmtTry { body, @@ -590,7 +590,7 @@ pub fn walk_except_handler<'a, V: Visitor<'a> + ?Sized>( } pub fn walk_arguments<'a, V: Visitor<'a> + ?Sized>(visitor: &mut V, arguments: &'a Arguments) { - // Note that the there might be keywords before the last arg, e.g. in + // Note that there might be keywords before the last arg, e.g. in // f(*args, a=2, *args2, **kwargs)`, but we follow Python in evaluating first `args` and then // `keywords`. See also [Arguments::arguments_source_order`]. for arg in &*arguments.args { diff --git a/crates/ruff_python_ast/src/visitor/source_order.rs b/crates/ruff_python_ast/src/visitor/source_order.rs index 894835b9654e1..5e6ca022a0600 100644 --- a/crates/ruff_python_ast/src/visitor/source_order.rs +++ b/crates/ruff_python_ast/src/visitor/source_order.rs @@ -4,7 +4,7 @@ use crate::{ ParameterWithDefault, Parameters, Pattern, PatternArguments, PatternKeyword, Singleton, Stmt, StringLiteral, TypeParam, TypeParams, UnaryOp, WithItem, }; -use crate::{AnyNodeRef, AstNode}; +use crate::{AnyNodeRef, Identifier}; /// Visitor that traverses all nodes recursively in the order they appear in the source. /// @@ -170,6 +170,11 @@ pub trait SourceOrderVisitor<'a> { fn visit_bytes_literal(&mut self, bytes_literal: &'a BytesLiteral) { walk_bytes_literal(self, bytes_literal); } + + #[inline] + fn visit_identifier(&mut self, identifier: &'a Identifier) { + walk_identifier(self, identifier); + } } pub fn walk_module<'a, V>(visitor: &mut V, module: &'a Mod) @@ -203,33 +208,7 @@ where let node = AnyNodeRef::from(stmt); if visitor.enter_node(node).is_traverse() { - match stmt { - Stmt::Expr(stmt) => stmt.visit_source_order(visitor), - Stmt::FunctionDef(stmt) => stmt.visit_source_order(visitor), - Stmt::ClassDef(stmt) => stmt.visit_source_order(visitor), - Stmt::Return(stmt) => stmt.visit_source_order(visitor), - Stmt::Delete(stmt) => stmt.visit_source_order(visitor), - Stmt::TypeAlias(stmt) => stmt.visit_source_order(visitor), - Stmt::Assign(stmt) => stmt.visit_source_order(visitor), - Stmt::AugAssign(stmt) => stmt.visit_source_order(visitor), - Stmt::AnnAssign(stmt) => stmt.visit_source_order(visitor), - Stmt::For(stmt) => stmt.visit_source_order(visitor), - Stmt::While(stmt) => stmt.visit_source_order(visitor), - Stmt::If(stmt) => stmt.visit_source_order(visitor), - Stmt::With(stmt) => stmt.visit_source_order(visitor), - Stmt::Match(stmt) => stmt.visit_source_order(visitor), - Stmt::Raise(stmt) => stmt.visit_source_order(visitor), - Stmt::Try(stmt) => stmt.visit_source_order(visitor), - Stmt::Assert(stmt) => stmt.visit_source_order(visitor), - Stmt::Import(stmt) => stmt.visit_source_order(visitor), - Stmt::ImportFrom(stmt) => stmt.visit_source_order(visitor), - Stmt::Pass(stmt) => stmt.visit_source_order(visitor), - Stmt::Break(stmt) => stmt.visit_source_order(visitor), - Stmt::Continue(stmt) => stmt.visit_source_order(visitor), - Stmt::Global(stmt) => stmt.visit_source_order(visitor), - Stmt::Nonlocal(stmt) => stmt.visit_source_order(visitor), - Stmt::IpyEscapeCommand(stmt) => stmt.visit_source_order(visitor), - } + stmt.visit_source_order(visitor); } visitor.leave_node(node); @@ -455,11 +434,7 @@ where { let node = AnyNodeRef::from(type_param); if visitor.enter_node(node).is_traverse() { - match type_param { - TypeParam::TypeVar(type_param) => type_param.visit_source_order(visitor), - TypeParam::TypeVarTuple(type_param) => type_param.visit_source_order(visitor), - TypeParam::ParamSpec(type_param) => type_param.visit_source_order(visitor), - } + type_param.visit_source_order(visitor); } visitor.leave_node(node); } @@ -610,3 +585,15 @@ where } visitor.leave_node(node); } + +#[inline] +pub fn walk_identifier<'a, V: SourceOrderVisitor<'a> + ?Sized>( + visitor: &mut V, + identifier: &'a Identifier, +) { + let node = AnyNodeRef::from(identifier); + if visitor.enter_node(node).is_traverse() { + identifier.visit_source_order(visitor); + } + visitor.leave_node(node); +} diff --git a/crates/ruff_python_ast/src/visitor/transformer.rs b/crates/ruff_python_ast/src/visitor/transformer.rs index bc48c1bd95f70..f3e1c30bbc2ae 100644 --- a/crates/ruff_python_ast/src/visitor/transformer.rs +++ b/crates/ruff_python_ast/src/visitor/transformer.rs @@ -234,9 +234,6 @@ pub fn walk_stmt<V: Transformer + ?Sized>(visitor: &V, stmt: &mut Stmt) { visitor.visit_expr(test); visitor.visit_body(body); for clause in elif_else_clauses { - if let Some(test) = &mut clause.test { - visitor.visit_expr(test); - } walk_elif_else_clause(visitor, clause); } } @@ -263,10 +260,10 @@ pub fn walk_stmt<V: Transformer + ?Sized>(visitor: &V, stmt: &mut Stmt) { }) => { if let Some(expr) = exc { visitor.visit_expr(expr); - }; + } if let Some(expr) = cause { visitor.visit_expr(expr); - }; + } } Stmt::Try(ast::StmtTry { body, @@ -576,7 +573,7 @@ pub fn walk_except_handler<V: Transformer + ?Sized>( } pub fn walk_arguments<V: Transformer + ?Sized>(visitor: &V, arguments: &mut Arguments) { - // Note that the there might be keywords before the last arg, e.g. in + // Note that there might be keywords before the last arg, e.g. in // f(*args, a=2, *args2, **kwargs)`, but we follow Python in evaluating first `args` and then // `keywords`. See also [Arguments::arguments_source_order`]. for arg in &mut *arguments.args { diff --git a/crates/ruff_python_ast/src/whitespace.rs b/crates/ruff_python_ast/src/whitespace.rs index 014f18ce56474..78a77bb49b574 100644 --- a/crates/ruff_python_ast/src/whitespace.rs +++ b/crates/ruff_python_ast/src/whitespace.rs @@ -1,4 +1,4 @@ -use ruff_python_trivia::{indentation_at_offset, is_python_whitespace, PythonWhitespace}; +use ruff_python_trivia::{PythonWhitespace, indentation_at_offset, is_python_whitespace}; use ruff_source_file::{LineRanges, UniversalNewlineIterator}; use ruff_text_size::{Ranged, TextRange, TextSize}; diff --git a/crates/ruff_python_ast_integration_tests/tests/comparable.rs b/crates/ruff_python_ast_integration_tests/tests/comparable.rs index b45b226168a2e..89155a58a059a 100644 --- a/crates/ruff_python_ast_integration_tests/tests/comparable.rs +++ b/crates/ruff_python_ast_integration_tests/tests/comparable.rs @@ -1,5 +1,5 @@ use ruff_python_ast::comparable::ComparableExpr; -use ruff_python_parser::{parse_expression, ParseError}; +use ruff_python_parser::{ParseError, parse_expression}; #[test] fn concatenated_strings_compare_equal() -> Result<(), ParseError> { diff --git a/crates/ruff_python_ast_integration_tests/tests/identifier.rs b/crates/ruff_python_ast_integration_tests/tests/identifier.rs index 324390b8454c9..080eb6d059baf 100644 --- a/crates/ruff_python_ast_integration_tests/tests/identifier.rs +++ b/crates/ruff_python_ast_integration_tests/tests/identifier.rs @@ -1,5 +1,5 @@ use ruff_python_ast::identifier; -use ruff_python_parser::{parse_module, ParseError}; +use ruff_python_parser::{ParseError, parse_module}; use ruff_text_size::{TextRange, TextSize}; #[test] diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__bytes_literals.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__bytes_literals.snap index 11df74981c042..d8d8eb0e8df7e 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__bytes_literals.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__bytes_literals.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__class_type_parameters.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__class_type_parameters.snap index 7b72f072ca01c..078564f39060d 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__class_type_parameters.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__class_type_parameters.snap @@ -1,14 +1,19 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule - StmtClassDef + - Identifier - TypeParams - TypeParamTypeVar + - Identifier - ExprName - TypeParamTypeVar + - Identifier - TypeParamTypeVarTuple + - Identifier - TypeParamParamSpec + - Identifier - StmtExpr - ExprEllipsisLiteral diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__compare.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__compare.snap index 7982572267a29..4fed977dca5cf 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__compare.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__compare.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__decorators.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__decorators.snap index f6b6c175ae9bb..fd002ba7e1926 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__decorators.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__decorators.snap @@ -1,14 +1,16 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule - StmtFunctionDef - Decorator - ExprName + - Identifier - Parameters - StmtPass - StmtClassDef - Decorator - ExprName + - Identifier - StmtPass diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__dict_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__dict_comprehension.snap index 2fa8d035d3f49..20daeacee0af3 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__dict_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__dict_comprehension.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__f_strings.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__f_strings.snap index 296252a266784..84266e3745e02 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__f_strings.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__f_strings.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_arguments.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_arguments.snap index d743ba0fa2a54..57611d34cd5b8 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_arguments.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_arguments.snap @@ -1,25 +1,34 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule - StmtFunctionDef + - Identifier - Parameters - ParameterWithDefault - Parameter + - Identifier - ParameterWithDefault - Parameter + - Identifier - ParameterWithDefault - Parameter + - Identifier - ParameterWithDefault - Parameter + - Identifier - ExprNumberLiteral - Parameter + - Identifier - ParameterWithDefault - Parameter + - Identifier - ExprNumberLiteral - ParameterWithDefault - Parameter + - Identifier - ExprNumberLiteral - Parameter + - Identifier - StmtPass diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_positional_only_with_default.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_positional_only_with_default.snap index 198e3b2aa304d..c46edad75c64d 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_positional_only_with_default.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_positional_only_with_default.snap @@ -1,17 +1,22 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule - StmtFunctionDef + - Identifier - Parameters - ParameterWithDefault - Parameter + - Identifier - ParameterWithDefault - Parameter + - Identifier - ExprNumberLiteral - ParameterWithDefault - Parameter + - Identifier - ExprNumberLiteral - Parameter + - Identifier - StmtPass diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_type_parameters.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_type_parameters.snap index d30516bf7bd50..3d02f25958b57 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_type_parameters.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_type_parameters.snap @@ -1,15 +1,20 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule - StmtFunctionDef + - Identifier - TypeParams - TypeParamTypeVar + - Identifier - ExprName - TypeParamTypeVar + - Identifier - TypeParamTypeVarTuple + - Identifier - TypeParamParamSpec + - Identifier - Parameters - StmtExpr - ExprEllipsisLiteral diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__list_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__list_comprehension.snap index d7fa6bda2f479..1cf6fb582f3f7 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__list_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__list_comprehension.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__match_class_pattern.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__match_class_pattern.snap index 70fa1276fe55f..ddd8b0c3d1079 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__match_class_pattern.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__match_class_pattern.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtMatch diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__set_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__set_comprehension.snap index 47c7344d6155d..89553f51a069d 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__set_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__set_comprehension.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__string_literals.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__string_literals.snap index fae44b6ed9aba..28c215cfb02ba 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__string_literals.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__string_literals.snap @@ -1,6 +1,7 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace +snapshot_kind: text --- - ModModule - StmtExpr diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__type_aliases.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__type_aliases.snap index 5c986912e2de5..f21ecb2147f3c 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__type_aliases.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__type_aliases.snap @@ -1,5 +1,5 @@ --- -source: crates/ruff_python_ast_integration_tests/tests/preorder.rs +source: crates/ruff_python_ast_integration_tests/tests/source_order.rs expression: trace --- - ModModule @@ -7,10 +7,14 @@ expression: trace - ExprName - TypeParams - TypeParamTypeVar + - Identifier - ExprName - TypeParamTypeVar + - Identifier - TypeParamTypeVarTuple + - Identifier - TypeParamParamSpec + - Identifier - ExprSubscript - ExprName - ExprName diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__bytes_literals.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__bytes_literals.snap index 0ad5f4f890800..00c432cfdd60b 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__bytes_literals.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__bytes_literals.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprBytesLiteral diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__class_type_parameters.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__class_type_parameters.snap index cf16702250f54..8b0acc8581cbb 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__class_type_parameters.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__class_type_parameters.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtClassDef - TypeParamTypeVar diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__compare.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__compare.snap index 8c0425fa43ca2..63981501e606d 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__compare.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__compare.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprCompare diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__decorators.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__decorators.snap index 799385941d8b9..2a5528b94f3a0 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__decorators.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__decorators.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtFunctionDef - ExprName diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__dict_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__dict_comprehension.snap index 40fe6e72eb67d..217b76d445a60 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__dict_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__dict_comprehension.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprDictComp diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__f_strings.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__f_strings.snap index 2e9b7dccbc06f..f379b791d7186 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__f_strings.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__f_strings.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprFString diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_arguments.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_arguments.snap index a526cdd144402..9ed633ee461a5 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_arguments.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_arguments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtFunctionDef - Parameters diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_positional_only_with_default.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_positional_only_with_default.snap index c7501b8ae868e..e4c1e7167f425 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_positional_only_with_default.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_positional_only_with_default.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtFunctionDef - Parameters diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_type_parameters.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_type_parameters.snap index 2af2fa85aa2bb..97bace8746d91 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_type_parameters.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__function_type_parameters.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtFunctionDef - TypeParamTypeVar diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__list_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__list_comprehension.snap index 7af26ca3c431d..903597237340d 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__list_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__list_comprehension.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprListComp diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__match_class_pattern.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__match_class_pattern.snap index d91b865a4f5a2..428de2cdabfba 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__match_class_pattern.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__match_class_pattern.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtMatch - ExprName diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__set_comprehension.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__set_comprehension.snap index 799b67aefac7c..da8ad27189199 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__set_comprehension.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__set_comprehension.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprSetComp diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__string_literals.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__string_literals.snap index 08cd420a9955b..48b18c6af31ce 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__string_literals.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__string_literals.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtExpr - ExprStringLiteral diff --git a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__type_aliases.snap b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__type_aliases.snap index 539a38562d357..452e3954deaff 100644 --- a/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__type_aliases.snap +++ b/crates/ruff_python_ast_integration_tests/tests/snapshots/visitor__type_aliases.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_ast_integration_tests/tests/visitor.rs expression: trace +snapshot_kind: text --- - StmtTypeAlias - ExprSubscript diff --git a/crates/ruff_python_ast_integration_tests/tests/source_order.rs b/crates/ruff_python_ast_integration_tests/tests/source_order.rs index fdfce78c38877..1f01d91c7f1f0 100644 --- a/crates/ruff_python_ast_integration_tests/tests/source_order.rs +++ b/crates/ruff_python_ast_integration_tests/tests/source_order.rs @@ -4,7 +4,7 @@ use insta::assert_snapshot; use ruff_python_ast::visitor::source_order::{SourceOrderVisitor, TraversalSignal}; use ruff_python_ast::{AnyNodeRef, BoolOp, CmpOp, Operator, Singleton, UnaryOp}; -use ruff_python_parser::{parse, Mode}; +use ruff_python_parser::{Mode, ParseOptions, parse}; #[test] fn function_arguments() { @@ -147,7 +147,7 @@ fn f_strings() { } fn trace_source_order_visitation(source: &str) -> String { - let parsed = parse(source, Mode::Module).unwrap(); + let parsed = parse(source, ParseOptions::from(Mode::Module)).unwrap(); let mut visitor = RecordVisitor::default(); visitor.visit_mod(parsed.syntax()); diff --git a/crates/ruff_python_ast_integration_tests/tests/stmt_if.rs b/crates/ruff_python_ast_integration_tests/tests/stmt_if.rs index 240d01187efc8..249e7de738efc 100644 --- a/crates/ruff_python_ast_integration_tests/tests/stmt_if.rs +++ b/crates/ruff_python_ast_integration_tests/tests/stmt_if.rs @@ -1,5 +1,5 @@ use ruff_python_ast::stmt_if::elif_else_range; -use ruff_python_parser::{parse_module, ParseError}; +use ruff_python_parser::{ParseError, parse_module}; use ruff_text_size::TextSize; #[test] diff --git a/crates/ruff_python_ast_integration_tests/tests/visitor.rs b/crates/ruff_python_ast_integration_tests/tests/visitor.rs index 128d0c3f12184..c99365898be3f 100644 --- a/crates/ruff_python_ast_integration_tests/tests/visitor.rs +++ b/crates/ruff_python_ast_integration_tests/tests/visitor.rs @@ -3,17 +3,16 @@ use std::fmt::{Debug, Write}; use insta::assert_snapshot; use ruff_python_ast::visitor::{ - walk_alias, walk_bytes_literal, walk_comprehension, walk_except_handler, walk_expr, + Visitor, walk_alias, walk_bytes_literal, walk_comprehension, walk_except_handler, walk_expr, walk_f_string, walk_f_string_element, walk_keyword, walk_match_case, walk_parameter, walk_parameters, walk_pattern, walk_stmt, walk_string_literal, walk_type_param, walk_with_item, - Visitor, }; use ruff_python_ast::{ self as ast, Alias, AnyNodeRef, BoolOp, BytesLiteral, CmpOp, Comprehension, ExceptHandler, Expr, FString, FStringElement, Keyword, MatchCase, Operator, Parameter, Parameters, Pattern, Stmt, StringLiteral, TypeParam, UnaryOp, WithItem, }; -use ruff_python_parser::{parse, Mode}; +use ruff_python_parser::{Mode, ParseOptions, parse}; #[test] fn function_arguments() { @@ -156,7 +155,7 @@ fn f_strings() { } fn trace_visitation(source: &str) -> String { - let parsed = parse(source, Mode::Module).unwrap(); + let parsed = parse(source, ParseOptions::from(Mode::Module)).unwrap(); let mut visitor = RecordVisitor::default(); walk_module(&mut visitor, parsed.syntax()); diff --git a/crates/ruff_python_codegen/Cargo.toml b/crates/ruff_python_codegen/Cargo.toml index 35dcbc30116d9..57a400ec825cf 100644 --- a/crates/ruff_python_codegen/Cargo.toml +++ b/crates/ruff_python_codegen/Cargo.toml @@ -20,6 +20,8 @@ ruff_python_parser = { workspace = true } ruff_source_file = { workspace = true } ruff_text_size = { workspace = true } +[dev-dependencies] +test-case = { workspace = true } [lints] workspace = true diff --git a/crates/ruff_python_codegen/src/generator.rs b/crates/ruff_python_codegen/src/generator.rs index 68b4ff606425d..d435ff5c2234f 100644 --- a/crates/ruff_python_codegen/src/generator.rs +++ b/crates/ruff_python_codegen/src/generator.rs @@ -1,13 +1,13 @@ //! Generate Python source code from an abstract syntax tree (AST). +use std::fmt::Write; use std::ops::Deref; -use ruff_python_ast::str::Quote; use ruff_python_ast::{ - self as ast, Alias, ArgOrKeyword, BoolOp, CmpOp, Comprehension, ConversionFlag, DebugText, - ExceptHandler, Expr, Identifier, MatchCase, Operator, Parameter, Parameters, Pattern, - Singleton, Stmt, Suite, TypeParam, TypeParamParamSpec, TypeParamTypeVar, TypeParamTypeVarTuple, - WithItem, + self as ast, Alias, AnyStringFlags, ArgOrKeyword, BoolOp, BytesLiteralFlags, CmpOp, + Comprehension, ConversionFlag, DebugText, ExceptHandler, Expr, FStringFlags, Identifier, + MatchCase, Operator, Parameter, Parameters, Pattern, Singleton, Stmt, StringFlags, Suite, + TypeParam, TypeParamParamSpec, TypeParamTypeVar, TypeParamTypeVarTuple, WithItem, }; use ruff_python_ast::{ParameterWithDefault, TypeParams}; use ruff_python_literal::escape::{AsciiEscape, Escape, UnicodeEscape}; @@ -65,8 +65,6 @@ mod precedence { pub struct Generator<'a> { /// The indentation style to use. indent: &'a Indentation, - /// The quote style to use for string literals. - quote: Quote, /// The line ending to use. line_ending: LineEnding, buffer: String, @@ -79,7 +77,6 @@ impl<'a> From<&'a Stylist<'a>> for Generator<'a> { fn from(stylist: &'a Stylist<'a>) -> Self { Self { indent: stylist.indentation(), - quote: stylist.quote(), line_ending: stylist.line_ending(), buffer: String::new(), indent_depth: 0, @@ -90,11 +87,10 @@ impl<'a> From<&'a Stylist<'a>> for Generator<'a> { } impl<'a> Generator<'a> { - pub const fn new(indent: &'a Indentation, quote: Quote, line_ending: LineEnding) -> Self { + pub const fn new(indent: &'a Indentation, line_ending: LineEnding) -> Self { Self { // Style preferences. indent, - quote, line_ending, // Internal state. buffer: String::new(), @@ -150,20 +146,44 @@ impl<'a> Generator<'a> { self.p(s.as_str()); } - fn p_bytes_repr(&mut self, s: &[u8]) { - let escape = AsciiEscape::with_preferred_quote(s, self.quote); + fn p_bytes_repr(&mut self, s: &[u8], flags: BytesLiteralFlags) { + // raw bytes are interpreted without escapes and should all be ascii (it's a python syntax + // error otherwise), but if this assumption is violated, a `Utf8Error` will be returned from + // `p_raw_bytes`, and we should fall back on the normal escaping behavior instead of + // panicking + if flags.prefix().is_raw() { + if let Ok(s) = std::str::from_utf8(s) { + write!(self.buffer, "{}", flags.display_contents(s)) + .expect("Writing to a String buffer should never fail"); + return; + } + } + let escape = AsciiEscape::with_preferred_quote(s, flags.quote_style()); if let Some(len) = escape.layout().len { self.buffer.reserve(len); } - escape.bytes_repr().write(&mut self.buffer).unwrap(); // write to string doesn't fail + escape + .bytes_repr(flags.triple_quotes()) + .write(&mut self.buffer) + .expect("Writing to a String buffer should never fail"); } - fn p_str_repr(&mut self, s: &str) { - let escape = UnicodeEscape::with_preferred_quote(s, self.quote); + fn p_str_repr(&mut self, s: &str, flags: impl Into<AnyStringFlags>) { + let flags = flags.into(); + if flags.prefix().is_raw() { + write!(self.buffer, "{}", flags.display_contents(s)) + .expect("Writing to a String buffer should never fail"); + return; + } + self.p(flags.prefix().as_str()); + let escape = UnicodeEscape::with_preferred_quote(s, flags.quote_style()); if let Some(len) = escape.layout().len { self.buffer.reserve(len); } - escape.str_repr().write(&mut self.buffer).unwrap(); // write to string doesn't fail + escape + .str_repr(flags.triple_quotes()) + .write(&mut self.buffer) + .expect("Writing to a String buffer should never fail"); } fn p_if(&mut self, cond: bool, s: &str) { @@ -669,7 +689,7 @@ impl<'a> Generator<'a> { self.unparse_expr(value, precedence::MAX); } Pattern::MatchSingleton(ast::PatternMatchSingleton { value, range: _ }) => { - self.unparse_singleton(value); + self.unparse_singleton(*value); } Pattern::MatchSequence(ast::PatternMatchSequence { patterns, range: _ }) => { self.p("["); @@ -1050,12 +1070,14 @@ impl<'a> Generator<'a> { self.unparse_expr(func, precedence::MAX); self.p("("); if let ( - [Expr::Generator(ast::ExprGenerator { - elt, - generators, - range: _, - parenthesized: _, - })], + [ + Expr::Generator(ast::ExprGenerator { + elt, + generators, + range: _, + parenthesized: _, + }), + ], [], ) = (arguments.args.as_ref(), arguments.keywords.as_ref()) { @@ -1088,7 +1110,7 @@ impl<'a> Generator<'a> { self.p(")"); } Expr::FString(ast::ExprFString { value, .. }) => { - self.unparse_f_string_value(value, false); + self.unparse_f_string_value(value); } Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => { self.unparse_string_literal_value(value); @@ -1097,7 +1119,7 @@ impl<'a> Generator<'a> { let mut first = true; for bytes_literal in value { self.p_delim(&mut first, " "); - self.p_bytes_repr(&bytes_literal.value); + self.p_bytes_repr(&bytes_literal.value, bytes_literal.flags); } } Expr::NumberLiteral(ast::ExprNumberLiteral { value, .. }) => { @@ -1150,7 +1172,7 @@ impl<'a> Generator<'a> { } else { self.unparse_expr(value, precedence::MAX); self.p("."); - }; + } self.p_id(attr); } Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { @@ -1211,7 +1233,7 @@ impl<'a> Generator<'a> { } } - pub(crate) fn unparse_singleton(&mut self, singleton: &Singleton) { + pub(crate) fn unparse_singleton(&mut self, singleton: Singleton) { match singleton { Singleton::None => self.p("None"), Singleton::True => self.p("True"), @@ -1284,10 +1306,7 @@ impl<'a> Generator<'a> { fn unparse_string_literal(&mut self, string_literal: &ast::StringLiteral) { let ast::StringLiteral { value, flags, .. } = string_literal; - if flags.prefix().is_unicode() { - self.p("u"); - } - self.p_str_repr(value); + self.p_str_repr(value, *flags); } fn unparse_string_literal_value(&mut self, value: &ast::StringLiteralValue) { @@ -1298,7 +1317,7 @@ impl<'a> Generator<'a> { } } - fn unparse_f_string_value(&mut self, value: &ast::FStringValue, is_spec: bool) { + fn unparse_f_string_value(&mut self, value: &ast::FStringValue) { let mut first = true; for f_string_part in value { self.p_delim(&mut first, " "); @@ -1307,7 +1326,7 @@ impl<'a> Generator<'a> { self.unparse_string_literal(string_literal); } ast::FStringPart::FString(f_string) => { - self.unparse_f_string(&f_string.elements, is_spec); + self.unparse_f_string(&f_string.elements, f_string.flags); } } } @@ -1326,7 +1345,7 @@ impl<'a> Generator<'a> { conversion: ConversionFlag, spec: Option<&ast::FStringFormatSpec>, ) { - let mut generator = Generator::new(self.indent, self.quote, self.line_ending); + let mut generator = Generator::new(self.indent, self.line_ending); generator.unparse_expr(val, precedence::FORMATTED_VALUE); let brace = if generator.buffer.starts_with('{') { // put a space to avoid escaping the bracket @@ -1348,13 +1367,13 @@ impl<'a> Generator<'a> { if !conversion.is_none() { self.p("!"); - #[allow(clippy::cast_possible_truncation)] + self.p(&format!("{}", conversion as u8 as char)); } if let Some(spec) = spec { self.p(":"); - self.unparse_f_string(&spec.elements, true); + self.unparse_f_string_specifier(&spec.elements); } self.p("}"); @@ -1385,17 +1404,17 @@ impl<'a> Generator<'a> { self.p(&s); } - fn unparse_f_string(&mut self, values: &[ast::FStringElement], is_spec: bool) { - if is_spec { - self.unparse_f_string_body(values); - } else { - self.p("f"); - let mut generator = - Generator::new(self.indent, self.quote.opposite(), self.line_ending); - generator.unparse_f_string_body(values); - let body = &generator.buffer; - self.p_str_repr(body); - } + fn unparse_f_string_specifier(&mut self, values: &[ast::FStringElement]) { + self.unparse_f_string_body(values); + } + + /// Unparse `values` with [`Generator::unparse_f_string_body`], using `quote` as the preferred + /// surrounding quote style. + fn unparse_f_string(&mut self, values: &[ast::FStringElement], flags: FStringFlags) { + let mut generator = Generator::new(self.indent, self.line_ending); + generator.unparse_f_string_body(values); + let body = &generator.buffer; + self.p_str_repr(body, flags); } fn unparse_alias(&mut self, alias: &Alias) { @@ -1417,8 +1436,8 @@ impl<'a> Generator<'a> { #[cfg(test)] mod tests { - use ruff_python_ast::{str::Quote, Mod, ModModule}; - use ruff_python_parser::{self, parse_module, Mode}; + use ruff_python_ast::{Mod, ModModule}; + use ruff_python_parser::{self, Mode, ParseOptions, parse_module}; use ruff_source_file::LineEnding; use crate::stylist::Indentation; @@ -1427,38 +1446,38 @@ mod tests { fn round_trip(contents: &str) -> String { let indentation = Indentation::default(); - let quote = Quote::default(); let line_ending = LineEnding::default(); let module = parse_module(contents).unwrap(); - let mut generator = Generator::new(&indentation, quote, line_ending); + let mut generator = Generator::new(&indentation, line_ending); generator.unparse_suite(module.suite()); generator.generate() } + /// Like [`round_trip`] but configure the [`Generator`] with the requested `indentation` and + /// `line_ending` settings. fn round_trip_with( indentation: &Indentation, - quote: Quote, line_ending: LineEnding, contents: &str, ) -> String { let module = parse_module(contents).unwrap(); - let mut generator = Generator::new(indentation, quote, line_ending); + let mut generator = Generator::new(indentation, line_ending); generator.unparse_suite(module.suite()); generator.generate() } fn jupyter_round_trip(contents: &str) -> String { let indentation = Indentation::default(); - let quote = Quote::default(); let line_ending = LineEnding::default(); - let parsed = ruff_python_parser::parse(contents, Mode::Ipython).unwrap(); + let parsed = + ruff_python_parser::parse(contents, ParseOptions::from(Mode::Ipython)).unwrap(); let Mod::Module(ModModule { body, .. }) = parsed.into_syntax() else { panic!("Source code didn't return ModModule") }; let [stmt] = body.as_slice() else { panic!("Expected only one statement in source code") }; - let mut generator = Generator::new(&indentation, quote, line_ending); + let mut generator = Generator::new(&indentation, line_ending); generator.unparse_stmt(stmt); generator.generate() } @@ -1709,15 +1728,67 @@ class Foo: #[test] fn quote() { - assert_eq!(round_trip(r#""hello""#), r#""hello""#); - assert_eq!(round_trip(r"'hello'"), r#""hello""#); - assert_eq!(round_trip(r"u'hello'"), r#"u"hello""#); - assert_eq!(round_trip(r"r'hello'"), r#""hello""#); - assert_eq!(round_trip(r"b'hello'"), r#"b"hello""#); + assert_round_trip!(r#""hello""#); + assert_round_trip!(r"'hello'"); + assert_round_trip!(r"u'hello'"); + assert_round_trip!(r"r'hello'"); + assert_round_trip!(r"b'hello'"); + assert_round_trip!(r#"b"hello""#); + assert_round_trip!(r"f'hello'"); + assert_round_trip!(r#"f"hello""#); assert_eq!(round_trip(r#"("abc" "def" "ghi")"#), r#""abc" "def" "ghi""#); assert_eq!(round_trip(r#""he\"llo""#), r#"'he"llo'"#); + assert_eq!(round_trip(r#"b"he\"llo""#), r#"b'he"llo'"#); assert_eq!(round_trip(r#"f"abc{'def'}{1}""#), r#"f"abc{'def'}{1}""#); - assert_eq!(round_trip(r#"f'abc{"def"}{1}'"#), r#"f"abc{'def'}{1}""#); + assert_round_trip!(r#"f'abc{"def"}{1}'"#); + } + + /// test all of the valid string literal prefix and quote combinations from + /// https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals + /// + /// Note that the numeric ids on the input/output and quote fields prevent name conflicts from + /// the test_matrix but are otherwise unnecessary + #[test_case::test_matrix( + [ + ("r", "r", 0), + ("u", "u", 1), + ("R", "R", 2), + ("U", "u", 3), // case not tracked + ("f", "f", 4), + ("F", "f", 5), // f case not tracked + ("fr", "rf", 6), // r before f + ("Fr", "rf", 7), // f case not tracked, r before f + ("fR", "Rf", 8), // r before f + ("FR", "Rf", 9), // f case not tracked, r before f + ("rf", "rf", 10), + ("rF", "rf", 11), // f case not tracked + ("Rf", "Rf", 12), + ("RF", "Rf", 13), // f case not tracked + // bytestrings + ("b", "b", 14), + ("B", "b", 15), // b case + ("br", "rb", 16), // r before b + ("Br", "rb", 17), // b case, r before b + ("bR", "Rb", 18), // r before b + ("BR", "Rb", 19), // b case, r before b + ("rb", "rb", 20), + ("rB", "rb", 21), // b case + ("Rb", "Rb", 22), + ("RB", "Rb", 23), // b case + ], + [("\"", 0), ("'",1), ("\"\"\"", 2), ("'''", 3)], + ["hello", "{hello} {world}"] + )] + fn prefix_quotes((inp, out, _id): (&str, &str, u8), (quote, _id2): (&str, u8), base: &str) { + let input = format!("{inp}{quote}{base}{quote}"); + let output = format!("{out}{quote}{base}{quote}"); + assert_eq!(round_trip(&input), output); + } + + #[test] + fn raw() { + assert_round_trip!(r#"r"a\.b""#); // https://github.com/astral-sh/ruff/issues/9663 + assert_round_trip!(r#"R"a\.b""#); } #[test] @@ -1756,52 +1827,11 @@ if True: ); } - #[test] - fn set_quote() { - assert_eq!( - round_trip_with( - &Indentation::default(), - Quote::Double, - LineEnding::default(), - r#""hello""# - ), - r#""hello""# - ); - assert_eq!( - round_trip_with( - &Indentation::default(), - Quote::Single, - LineEnding::default(), - r#""hello""# - ), - r"'hello'" - ); - assert_eq!( - round_trip_with( - &Indentation::default(), - Quote::Double, - LineEnding::default(), - r"'hello'" - ), - r#""hello""# - ); - assert_eq!( - round_trip_with( - &Indentation::default(), - Quote::Single, - LineEnding::default(), - r"'hello'" - ), - r"'hello'" - ); - } - #[test] fn set_indent() { assert_eq!( round_trip_with( &Indentation::new(" ".to_string()), - Quote::default(), LineEnding::default(), r" if True: @@ -1819,7 +1849,6 @@ if True: assert_eq!( round_trip_with( &Indentation::new(" ".to_string()), - Quote::default(), LineEnding::default(), r" if True: @@ -1837,7 +1866,6 @@ if True: assert_eq!( round_trip_with( &Indentation::new("\t".to_string()), - Quote::default(), LineEnding::default(), r" if True: @@ -1859,7 +1887,6 @@ if True: assert_eq!( round_trip_with( &Indentation::default(), - Quote::default(), LineEnding::Lf, "if True:\n print(42)", ), @@ -1869,7 +1896,6 @@ if True: assert_eq!( round_trip_with( &Indentation::default(), - Quote::default(), LineEnding::CrLf, "if True:\n print(42)", ), @@ -1879,7 +1905,6 @@ if True: assert_eq!( round_trip_with( &Indentation::default(), - Quote::default(), LineEnding::Cr, "if True:\n print(42)", ), diff --git a/crates/ruff_python_codegen/src/lib.rs b/crates/ruff_python_codegen/src/lib.rs index b1525cce3f48c..81a25cef1c13a 100644 --- a/crates/ruff_python_codegen/src/lib.rs +++ b/crates/ruff_python_codegen/src/lib.rs @@ -1,5 +1,5 @@ pub use generator::Generator; -use ruff_python_parser::{parse_module, ParseError}; +use ruff_python_parser::{ParseError, parse_module}; pub use stylist::Stylist; mod generator; diff --git a/crates/ruff_python_codegen/src/stylist.rs b/crates/ruff_python_codegen/src/stylist.rs index 20217c279e064..d8165941bf471 100644 --- a/crates/ruff_python_codegen/src/stylist.rs +++ b/crates/ruff_python_codegen/src/stylist.rs @@ -5,7 +5,7 @@ use std::ops::Deref; use ruff_python_ast::str::Quote; use ruff_python_parser::{Token, TokenKind, Tokens}; -use ruff_source_file::{find_newline, LineEnding, LineRanges}; +use ruff_source_file::{LineEnding, LineRanges, find_newline}; use ruff_text_size::Ranged; #[derive(Debug, Clone)] @@ -49,7 +49,7 @@ fn detect_quote(tokens: &[Token]) -> Quote { for token in tokens { match token.kind() { TokenKind::String if !token.is_triple_quoted_string() => { - return token.string_quote_style() + return token.string_quote_style(); } TokenKind::FStringStart => return token.string_quote_style(), _ => continue, @@ -148,8 +148,8 @@ impl Deref for Indentation { #[cfg(test)] mod tests { - use ruff_python_parser::{parse_module, parse_unchecked, Mode}; - use ruff_source_file::{find_newline, LineEnding}; + use ruff_python_parser::{Mode, ParseOptions, parse_module, parse_unchecked}; + use ruff_source_file::{LineEnding, find_newline}; use super::{Indentation, Quote, Stylist}; @@ -215,7 +215,7 @@ x = (  3, ) "; - let parsed = parse_unchecked(contents, Mode::Module); + let parsed = parse_unchecked(contents, ParseOptions::from(Mode::Module)); assert_eq!( Stylist::from_tokens(parsed.tokens(), contents).indentation(), &Indentation(" ".to_string()) diff --git a/crates/ruff_python_formatter/CONTRIBUTING.md b/crates/ruff_python_formatter/CONTRIBUTING.md index 540eb34748b88..3084ec3607dcc 100644 --- a/crates/ruff_python_formatter/CONTRIBUTING.md +++ b/crates/ruff_python_formatter/CONTRIBUTING.md @@ -297,7 +297,7 @@ in `placement.rs`, which this section is about. ``` Here, the comment is dangling because it is preceded by `[`, which is a non-trivia token but not a -node, and followed by `]`, which is also a non-trivia token but not a node. In the `FormatExprList` +node, and followed by `]`, which is also a non-trivia token but not a node. In the `FormatExprList` implementation, we have to call `dangling_comments` manually and stub out the `fmt_dangling_comments` default from `FormatNodeRule`. diff --git a/crates/ruff_python_formatter/Cargo.toml b/crates/ruff_python_formatter/Cargo.toml index 3341f94027c70..1f351ca622358 100644 --- a/crates/ruff_python_formatter/Cargo.toml +++ b/crates/ruff_python_formatter/Cargo.toml @@ -15,6 +15,7 @@ doctest = false [dependencies] ruff_cache = { workspace = true } +ruff_db = { workspace = true } ruff_formatter = { workspace = true } ruff_macros = { workspace = true } ruff_python_trivia = { workspace = true } @@ -30,6 +31,7 @@ itertools = { workspace = true } memchr = { workspace = true } regex = { workspace = true } rustc-hash = { workspace = true } +salsa = { workspace = true } serde = { workspace = true, optional = true } schemars = { workspace = true, optional = true } smallvec = { workspace = true } @@ -58,7 +60,12 @@ required-features = ["serde"] [features] default = ["serde"] -serde = ["dep:serde", "ruff_formatter/serde", "ruff_source_file/serde", "ruff_python_ast/serde"] +serde = [ + "dep:serde", + "ruff_formatter/serde", + "ruff_source_file/serde", + "ruff_python_ast/serde", +] schemars = ["dep:schemars", "ruff_formatter/schemars"] [lints] diff --git a/crates/ruff_python_formatter/README.md b/crates/ruff_python_formatter/README.md index 83370089bc1ba..d6ed9a96d8e26 100644 --- a/crates/ruff_python_formatter/README.md +++ b/crates/ruff_python_formatter/README.md @@ -19,8 +19,8 @@ filed in the issue tracker. If you've identified a new deviation, please [file a When run over _non_-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. -For details, see [Black compatibility](https://docs.astral.sh/ruff/formatter/#black-compatibility). +For details, see [Style Guide](https://docs.astral.sh/ruff/formatter/#style-guide). ## Getting started -The Ruff formatter is available as of Ruff v0.1.2. Head to [The Ruff Formatter](https://docs.astral.sh/ruff/formatter/) for usage instructions and a comparison to Black. +Head to [The Ruff Formatter](https://docs.astral.sh/ruff/formatter/) for usage instructions and a comparison to Black. diff --git a/crates/ruff_python_formatter/generate.py b/crates/ruff_python_formatter/generate.py index ff28a04331dc0..ba8354c2aab6b 100755 --- a/crates/ruff_python_formatter/generate.py +++ b/crates/ruff_python_formatter/generate.py @@ -3,6 +3,7 @@ """See CONTRIBUTING.md""" # %% +from __future__ import annotations import re from collections import defaultdict @@ -24,20 +25,19 @@ def rustfmt(code: str) -> str: root.joinpath("crates") .joinpath("ruff_python_ast") .joinpath("src") - .joinpath("node.rs") + .joinpath("generated.rs") .read_text() ) node_lines = ( - nodes_file.split("pub enum AnyNode {")[1].split("}")[0].strip().splitlines() + nodes_file.split("pub enum AnyNodeRef<'a> {")[1].split("}")[0].strip().splitlines() ) nodes = [] for node_line in node_lines: - node = node_line.split("(")[1].split(")")[0].split("::")[-1].split("<")[0] + node = node_line.split("(")[1].split(")")[0].split("::")[-1].removeprefix("&'a ") # `FString` has a custom implementation while the formatting for - # `FStringLiteralElement`, `FStringFormatSpec` and `FStringExpressionElement` are handled by the `FString` - # implementation. + # `FStringLiteralElement`, `FStringFormatSpec` and `FStringExpressionElement` are + # handled by the `FString` implementation. if node in ( - "FString", "FStringLiteralElement", "FStringExpressionElement", "FStringFormatSpec", @@ -113,7 +113,7 @@ def to_camel_case(node: str) -> str: write!(f, [verbatim_text(item)]) }} }} - """.strip() # noqa: E501 + """.strip() node_path.write_text(rustfmt(code)) @@ -128,7 +128,7 @@ def to_camel_case(node: str) -> str: use ruff_formatter::{FormatOwnedWithRule, FormatRefWithRule, FormatResult, FormatRule}; use ruff_python_ast as ast; -""" # noqa: E501 +""" for node in nodes: text = f""" impl FormatRule<ast::{node}, PyFormatContext<'_>> @@ -170,7 +170,7 @@ def to_camel_case(node: str) -> str: ) }} }} - """ # noqa: E501 + """ generated += text out.write_text(rustfmt(generated)) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/backslash_before_indent.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/backslash_before_indent.options.json index 60044b9854d9b..54724b66c51c0 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/backslash_before_indent.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/backslash_before_indent.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_38.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_38.options.json new file mode 100644 index 0000000000000..fa1bf06046805 --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_38.options.json @@ -0,0 +1 @@ +{"target_version": "3.8"} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_310.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_310.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_310.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_310.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_311.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_311.options.json index c723d00e423e8..dcb1b482570d8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_311.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_311.options.json @@ -1 +1 @@ -{"target_version": "py311"} \ No newline at end of file +{"target_version": "3.11"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_38.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_38.options.json new file mode 100644 index 0000000000000..01777c6d8fad4 --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_38.options.json @@ -0,0 +1 @@ +{"target_version": "3.8"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/fstring.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/fstring.options.json new file mode 100644 index 0000000000000..a97114e0487d6 --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/fstring.options.json @@ -0,0 +1 @@ +{"target_version": "3.12"} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/funcdef_return_type_trailing_comma.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/funcdef_return_type_trailing_comma.options.json index 0aaaa152bc848..1266ed1e66d91 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/funcdef_return_type_trailing_comma.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/funcdef_return_type_trailing_comma.options.json @@ -1 +1 @@ -{"preview": "enabled", "target_version": "py310"} \ No newline at end of file +{"preview": "enabled", "target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/keep_newline_after_match.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/keep_newline_after_match.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/keep_newline_after_match.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/keep_newline_after_match.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py index c39bb99bcf5a7..3dc4e3af71d0d 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py @@ -6,7 +6,7 @@ def foo2(parameter_1, parameter_2, parameter_3, parameter_4, parameter_5, parame def foo3(parameter_1, parameter_2, parameter_3, parameter_4, parameter_5, parameter_6, parameter_7): pass def foo4(parameter_1, parameter_2, parameter_3, parameter_4, parameter_5, parameter_6, parameter_7): pass -# Adding some unformated code covering a wide range of syntaxes. +# Adding some unformatted code covering a wide range of syntaxes. if True: # Incorrectly indented prefix comments. diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py.expect index 7fdfdfd0dbbae..01c9c002e3264 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py.expect +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_basic.py.expect @@ -28,7 +28,7 @@ def foo3( def foo4(parameter_1, parameter_2, parameter_3, parameter_4, parameter_5, parameter_6, parameter_7): pass -# Adding some unformated code covering a wide range of syntaxes. +# Adding some unformatted code covering a wide range of syntaxes. if True: # Incorrectly indented prefix comments. diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/parenthesized_context_managers.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/parenthesized_context_managers.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/parenthesized_context_managers.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/parenthesized_context_managers.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_complex.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_complex.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_complex.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_complex.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_extras.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_extras.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_extras.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_extras.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_generic.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_generic.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_generic.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_generic.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_long.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_long.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_long.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_long.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_simple.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_simple.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_simple.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_simple.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_style.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_style.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_style.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_style.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_trailing_comma.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_trailing_comma.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_trailing_comma.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_trailing_comma.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_with_if_stmt.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_with_if_stmt.options.json index 0aaaa152bc848..1266ed1e66d91 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_with_if_stmt.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_with_if_stmt.options.json @@ -1 +1 @@ -{"preview": "enabled", "target_version": "py310"} \ No newline at end of file +{"preview": "enabled", "target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py index bd3e48417b6b5..930759735bdc7 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py @@ -19,7 +19,7 @@ z: (int) = 2.3 z: ((int)) = foo() -# In case I go for not enforcing parantheses, this might get improved at the same time +# In case I go for not enforcing parentheses, this might get improved at the same time x = ( z == 9999999999999999999999999999999999999999 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py.expect index ab0a4d96772ca..e9c2f75f7e748 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py.expect +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py.expect @@ -28,7 +28,7 @@ z: Short | Short2 | Short3 | Short4 = 8 z: int = 2.3 z: int = foo() -# In case I go for not enforcing parantheses, this might get improved at the same time +# In case I go for not enforcing parentheses, this might get improved at the same time x = ( z == 9999999999999999999999999999999999999999 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_572_py310.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_572_py310.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_572_py310.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_572_py310.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_646.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_646.options.json index c723d00e423e8..dcb1b482570d8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_646.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_646.options.json @@ -1 +1 @@ -{"target_version": "py311"} \ No newline at end of file +{"target_version": "3.11"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654.options.json index c723d00e423e8..dcb1b482570d8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654.options.json @@ -1 +1 @@ -{"target_version": "py311"} \ No newline at end of file +{"target_version": "3.11"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654_style.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654_style.options.json index c723d00e423e8..dcb1b482570d8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654_style.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_654_style.options.json @@ -1 +1 @@ -{"target_version": "py311"} \ No newline at end of file +{"target_version": "3.11"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_701.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_701.options.json index cf266d35406c4..4295ffe1df58d 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_701.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_701.options.json @@ -1 +1 @@ -{"target_version": "py312"} \ No newline at end of file +{"target_version": "3.12"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py deleted file mode 100644 index 44b54ba9d7aa5..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py +++ /dev/null @@ -1,82 +0,0 @@ -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 - -def quux(): - - new_line = here - - -class Cls: - - def method(self): - - pass - - -async def async_fn(): - - """Docstring.""" - - -@decorated -async def async_fn(): - - """Docstring.""" - - -def top_level( - a: int, - b: str, -) -> Whatever[Generic, Something]: - - def nested(x: int) -> int: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py.expect deleted file mode 100644 index 3e5bdea0f93e5..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py.expect +++ /dev/null @@ -1,81 +0,0 @@ -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 - - -def quux(): - - new_line = here - - -class Cls: - - def method(self): - - pass - - -async def async_fn(): - """Docstring.""" - - -@decorated -async def async_fn(): - """Docstring.""" - - -def top_level( - a: int, - b: str, -) -> Whatever[Generic, Something]: - - def nested(x: int) -> int: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py deleted file mode 100644 index 7cf2fc1b8c18d..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py +++ /dev/null @@ -1,51 +0,0 @@ -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py.expect deleted file mode 100644 index 570a63b1d3f3c..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py.expect +++ /dev/null @@ -1,51 +0,0 @@ -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py deleted file mode 100644 index 88767abb88cc6..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py +++ /dev/null @@ -1,11 +0,0 @@ -async def func() -> (int): - return 0 - - -@decorated -async def func() -> (int): - return 0 - - -async for (item) in async_iter: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py.expect deleted file mode 100644 index 13423345b6386..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_async_stmts.py.expect +++ /dev/null @@ -1,11 +0,0 @@ -async def func() -> int: - return 0 - - -@decorated -async def func() -> int: - return 0 - - -async for item in async_iter: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.options.json deleted file mode 100644 index a3b0502b7c9f7..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py38"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py deleted file mode 100644 index 811be47176279..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py +++ /dev/null @@ -1,31 +0,0 @@ -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2(), \ - make_context_manager3() as cm3, \ - make_context_manager4() \ -: - pass - - -with \ - new_new_new1() as cm1, \ - new_new_new2() \ -: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py.expect deleted file mode 100644 index 5c0cdde0d29a5..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_38.py.expect +++ /dev/null @@ -1,18 +0,0 @@ -with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - -with make_context_manager1() as cm1, make_context_manager2(), make_context_manager3() as cm3, make_context_manager4(): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.options.json deleted file mode 100644 index 8bb726753bf76..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py39"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py deleted file mode 100644 index f0ae0053630a2..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py +++ /dev/null @@ -1,84 +0,0 @@ -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -# Leading comment -with \ - make_context_manager1() as cm1, \ - make_context_manager2(), \ - make_context_manager3() as cm3, \ - make_context_manager4() \ -: - pass - - -with \ - new_new_new1() as cm1, \ - new_new_new2() \ -: - pass - - -with ( - new_new_new1() as cm1, - new_new_new2() -): - pass - - -# Leading comment. -with ( - # First comment. - new_new_new1() as cm1, - # Second comment. - new_new_new2() - # Last comment. -): - pass - - -with \ - this_is_a_very_long_call(looong_arg1=looong_value1, looong_arg2=looong_value2) as cm1, \ - this_is_a_very_long_call(looong_arg1=looong_value1, looong_arg2=looong_value2, looong_arg3=looong_value3, looong_arg4=looong_value4) as cm2 \ -: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass - - -with xxxxxxxx.some_kind_of_method( - some_argument=[ - "first", - "second", - "third", - ] -).another_method() as cmd: - pass - - -async def func(): - async with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ - : - pass - - async with some_function( - argument1, argument2, argument3="some_value" - ) as some_cm, some_other_function( - argument1, argument2, argument3="some_value" - ): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py.expect deleted file mode 100644 index 1b8e86593390b..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_39.py.expect +++ /dev/null @@ -1,85 +0,0 @@ -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass - - -# Leading comment -with ( - make_context_manager1() as cm1, - make_context_manager2(), - make_context_manager3() as cm3, - make_context_manager4(), -): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -# Leading comment. -with ( - # First comment. - new_new_new1() as cm1, - # Second comment. - new_new_new2(), - # Last comment. -): - pass - - -with ( - this_is_a_very_long_call( - looong_arg1=looong_value1, looong_arg2=looong_value2 - ) as cm1, - this_is_a_very_long_call( - looong_arg1=looong_value1, - looong_arg2=looong_value2, - looong_arg3=looong_value3, - looong_arg4=looong_value4, - ) as cm2, -): - pass - - -with ( - mock.patch.object(self.my_runner, "first_method", autospec=True) as mock_run_adb, - mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" - ), -): - pass - - -with xxxxxxxx.some_kind_of_method( - some_argument=[ - "first", - "second", - "third", - ] -).another_method() as cmd: - pass - - -async def func(): - async with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, - ): - pass - - async with ( - some_function(argument1, argument2, argument3="some_value") as some_cm, - some_other_function(argument1, argument2, argument3="some_value"), - ): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.options.json deleted file mode 100644 index 0aaaa152bc848..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py310"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py deleted file mode 100644 index 493ad2110867c..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py +++ /dev/null @@ -1,15 +0,0 @@ -# This file uses pattern matching introduced in Python 3.10. - - -match http_code: - case 404: - print("Not found") - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py.expect deleted file mode 100644 index 4c35978000410..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_310.py.expect +++ /dev/null @@ -1,15 +0,0 @@ -# This file uses pattern matching introduced in Python 3.10. - - -match http_code: - case 404: - print("Not found") - - -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.options.json deleted file mode 100644 index f1b92cd916c4f..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py311"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py deleted file mode 100644 index fb3fb65a31129..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py +++ /dev/null @@ -1,16 +0,0 @@ -# This file uses except* clause in Python 3.11. - - -try: - some_call() -except* Error as e: - pass - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py.expect deleted file mode 100644 index b5ca9c0b1473e..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_311.py.expect +++ /dev/null @@ -1,16 +0,0 @@ -# This file uses except* clause in Python 3.11. - - -try: - some_call() -except* Error as e: - pass - - -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py deleted file mode 100644 index f48fbe78e3709..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py +++ /dev/null @@ -1,24 +0,0 @@ -# This file doesn't use any Python 3.9+ only grammars. - - -# Make sure parens around a single context manager don't get autodetected as -# Python 3.9+. -with (a): - pass - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py.expect deleted file mode 100644 index d43eb9f0917ca..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_38.py.expect +++ /dev/null @@ -1,19 +0,0 @@ -# This file doesn't use any Python 3.9+ only grammars. - - -# Make sure parens around a single context manager don't get autodetected as -# Python 3.9+. -with a: - pass - - -with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.options.json deleted file mode 100644 index 8bb726753bf76..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py39"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py deleted file mode 100644 index c69d3a72894b7..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py +++ /dev/null @@ -1,17 +0,0 @@ -# This file uses parenthesized context managers introduced in Python 3.9. - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -with ( - new_new_new1() as cm1, - new_new_new2() -): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py.expect deleted file mode 100644 index ff6ce999175b2..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_context_managers_autodetect_39.py.expect +++ /dev/null @@ -1,14 +0,0 @@ -# This file uses parenthesized context managers introduced in Python 3.9. - - -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py deleted file mode 100644 index 338cc01d33e64..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py +++ /dev/null @@ -1,10 +0,0 @@ -def do_not_touch_this_prefix(): - R"""There was a bug where docstring prefixes would be normalized even with -S.""" - - -def do_not_touch_this_prefix2(): - FR'There was a bug where docstring prefixes would be normalized even with -S.' - - -def do_not_touch_this_prefix3(): - u'''There was a bug where docstring prefixes would be normalized even with -S.''' diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py.expect deleted file mode 100644 index 338cc01d33e64..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py.expect +++ /dev/null @@ -1,10 +0,0 @@ -def do_not_touch_this_prefix(): - R"""There was a bug where docstring prefixes would be normalized even with -S.""" - - -def do_not_touch_this_prefix2(): - FR'There was a bug where docstring prefixes would be normalized even with -S.' - - -def do_not_touch_this_prefix3(): - u'''There was a bug where docstring prefixes would be normalized even with -S.''' diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py deleted file mode 100644 index 739359ee25bbc..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py +++ /dev/null @@ -1,69 +0,0 @@ -from typing import NoReturn, Protocol, Union, overload - -class Empty: - ... - -def dummy(a): ... -async def other(b): ... - - -@overload -def a(arg: int) -> int: ... -@overload -def a(arg: str) -> str: ... -@overload -def a(arg: object) -> NoReturn: ... -def a(arg: Union[int, str, object]) -> Union[int, str]: - if not isinstance(arg, (int, str)): - raise TypeError - return arg - -class Proto(Protocol): - def foo(self, a: int) -> int: - ... - - def bar(self, b: str) -> str: ... - def baz(self, c: bytes) -> str: - ... - - -def dummy_two(): - ... -@dummy -def dummy_three(): - ... - -def dummy_four(): - ... - -@overload -def b(arg: int) -> int: ... - -@overload -def b(arg: str) -> str: ... -@overload -def b(arg: object) -> NoReturn: ... - -def b(arg: Union[int, str, object]) -> Union[int, str]: - if not isinstance(arg, (int, str)): - raise TypeError - return arg - -def has_comment(): - ... # still a dummy - -if some_condition: - ... - -if already_dummy: ... - -class AsyncCls: - async def async_method(self): - ... - -async def async_function(self): - ... - -@decorated -async def async_function(self): - ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py.expect deleted file mode 100644 index 369e442152116..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py.expect +++ /dev/null @@ -1,72 +0,0 @@ -from typing import NoReturn, Protocol, Union, overload - - -class Empty: ... - - -def dummy(a): ... -async def other(b): ... - - -@overload -def a(arg: int) -> int: ... -@overload -def a(arg: str) -> str: ... -@overload -def a(arg: object) -> NoReturn: ... -def a(arg: Union[int, str, object]) -> Union[int, str]: - if not isinstance(arg, (int, str)): - raise TypeError - return arg - - -class Proto(Protocol): - def foo(self, a: int) -> int: ... - - def bar(self, b: str) -> str: ... - def baz(self, c: bytes) -> str: ... - - -def dummy_two(): ... -@dummy -def dummy_three(): ... - - -def dummy_four(): ... - - -@overload -def b(arg: int) -> int: ... - - -@overload -def b(arg: str) -> str: ... -@overload -def b(arg: object) -> NoReturn: ... - - -def b(arg: Union[int, str, object]) -> Union[int, str]: - if not isinstance(arg, (int, str)): - raise TypeError - return arg - - -def has_comment(): ... # still a dummy - - -if some_condition: - ... - -if already_dummy: - ... - - -class AsyncCls: - async def async_method(self): ... - - -async def async_function(self): ... - - -@decorated -async def async_function(self): ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py deleted file mode 100644 index 42ba8fe243b29..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py +++ /dev/null @@ -1,116 +0,0 @@ -# Warning! This file contains form feeds (ASCII 0x0C, often represented by \f or ^L). -# These may be invisible in your editor: ensure you can see them before making changes here. - -# There's one at the start that'll get stripped - -# Comment and statement processing is different enough that we'll test variations of both -# contexts here - -# - - -# - - -# - - - -# - - - -# - - - -# - - -# - - - -# - -# - -# - - \ -# -pass - -pass - - -pass - - -pass - - - -pass - - - -pass - - - -pass - - -pass - - - -pass - -pass - -pass - - -# form feed after a dedent -def foo(): - pass - -pass - - -# form feeds are prohibited inside blocks, or on a line with nonwhitespace - def bar( a = 1 ,b : bool = False ) : - - - pass - - -class Baz: - - def __init__(self): - pass - - - def something(self): - pass - - - -# -pass -pass # -a = 1 - # - pass - a = 1 - -a = [ - -] - -# as internal whitespace of a comment is allowed but why -"form feed literal in a string is okay " - -# form feeds at the very end get removed. diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py.expect deleted file mode 100644 index 4ce3d2832bf84..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py.expect +++ /dev/null @@ -1,103 +0,0 @@ -# Warning! This file contains form feeds (ASCII 0x0C, often represented by \f or ^L). -# These may be invisible in your editor: ensure you can see them before making changes here. - -# There's one at the start that'll get stripped - -# Comment and statement processing is different enough that we'll test variations of both -# contexts here - -# - - -# - - -# - - -# - - -# - - -# - - -# - - -# - -# - -# - -# -pass - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - -pass - -pass - - -# form feed after a dedent -def foo(): - pass - - -pass - - -# form feeds are prohibited inside blocks, or on a line with nonwhitespace -def bar(a=1, b: bool = False): - - pass - - -class Baz: - - def __init__(self): - pass - - def something(self): - pass - - -# -pass -pass # -a = 1 -# -pass -a = 1 - -a = [] - -# as internal whitespace of a comment is allowed but why -"form feed literal in a string is okay " - -# form feeds at the very end get removed. diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py deleted file mode 100644 index 56d361087d206..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py +++ /dev/null @@ -1,33 +0,0 @@ -def line_before_docstring(): - - """Please move me up""" - - -class LineBeforeDocstring: - - """Please move me up""" - - -class EvenIfThereIsAMethodAfter: - - """I'm the docstring""" - def method(self): - pass - - -class TwoLinesBeforeDocstring: - - - """I want to be treated the same as if I were closer""" - - -class MultilineDocstringsAsWell: - - """I'm so far - - and on so many lines... - """ - -class SingleQuotedDocstring: - - "I'm a docstring but I don't even get triple quotes." diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py.expect deleted file mode 100644 index fa042f49338ff..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_no_blank_line_before_docstring.py.expect +++ /dev/null @@ -1,28 +0,0 @@ -def line_before_docstring(): - """Please move me up""" - - -class LineBeforeDocstring: - """Please move me up""" - - -class EvenIfThereIsAMethodAfter: - """I'm the docstring""" - - def method(self): - pass - - -class TwoLinesBeforeDocstring: - """I want to be treated the same as if I were closer""" - - -class MultilineDocstringsAsWell: - """I'm so far - - and on so many lines... - """ - - -class SingleQuotedDocstring: - "I'm a docstring but I don't even get triple quotes." diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.options.json deleted file mode 100644 index 0aaaa152bc848..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py310"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py deleted file mode 100644 index 98b6ac56a2048..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py +++ /dev/null @@ -1,7 +0,0 @@ -match x: - case "abcd" | "abcd" | "abcd" : - pass - case "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd" | "abcd": - pass - case xxxxxxxxxxxxxxxxxxxxxxx: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py.expect deleted file mode 100644 index c60e5770a7a41..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_long.py.expect +++ /dev/null @@ -1,23 +0,0 @@ -match x: - case "abcd" | "abcd" | "abcd": - pass - case ( - "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - | "abcd" - ): - pass - case xxxxxxxxxxxxxxxxxxxxxxx: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.options.json deleted file mode 100644 index 0aaaa152bc848..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled", "target_version": "py310"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py deleted file mode 100644 index 002ceea330686..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py +++ /dev/null @@ -1,14 +0,0 @@ -match maybe, multiple: - case perhaps, 5: - pass - case perhaps, 6,: - pass - - -match more := (than, one), indeed,: - case _, (5, 6): - pass - case [[5], (6)], [7],: - pass - case _: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py.expect deleted file mode 100644 index 6e8ef32f18157..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py.expect +++ /dev/null @@ -1,20 +0,0 @@ -match maybe, multiple: - case perhaps, 5: - pass - case ( - perhaps, - 6, - ): - pass - - -match more := (than, one), indeed,: - case _, (5, 6): - pass - case ( - [[5], (6)], - [7], - ): - pass - case _: - pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep646_typed_star_arg_type_var_tuple.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep646_typed_star_arg_type_var_tuple.options.json index f1b92cd916c4f..938747847cf16 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep646_typed_star_arg_type_var_tuple.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep646_typed_star_arg_type_var_tuple.options.json @@ -1 +1 @@ -{"preview": "enabled", "target_version": "py311"} \ No newline at end of file +{"preview": "enabled", "target_version": "3.11"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py deleted file mode 100644 index dff98530388cf..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py +++ /dev/null @@ -1,2 +0,0 @@ -x[(a:=0):] -x[:(a:=0)] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py.expect deleted file mode 100644 index a976b8a318bbb..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pep_572.py.expect +++ /dev/null @@ -1,2 +0,0 @@ -x[(a := 0) :] -x[: (a := 0)] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py deleted file mode 100644 index ab71177d2e1d7..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py +++ /dev/null @@ -1,20 +0,0 @@ -("" % a) ** 2 -("" % a)[0] -("" % a)() -("" % a).b - -2 * ("" % a) -2 @ ("" % a) -2 / ("" % a) -2 // ("" % a) -2 % ("" % a) -+("" % a) -b + ("" % a) --("" % a) -b - ("" % a) -b + -("" % a) -~("" % a) -2 ** ("" % a) -await ("" % a) -b[("" % a)] -b(("" % a)) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py.expect deleted file mode 100644 index bd77adeeb7524..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py.expect +++ /dev/null @@ -1,20 +0,0 @@ -("" % a) ** 2 -("" % a)[0] -("" % a)() -("" % a).b - -2 * ("" % a) -2 @ ("" % a) -2 / ("" % a) -2 // ("" % a) -2 % ("" % a) -+("" % a) -b + "" % a --("" % a) -b - "" % a -b + -("" % a) -~("" % a) -2 ** ("" % a) -await ("" % a) -b[("" % a)] -b(("" % a)) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py deleted file mode 100644 index af361012ea829..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py +++ /dev/null @@ -1,11 +0,0 @@ -a = 1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1 -b = 1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1 -c = 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 ** 1 -d = 1**1 ** 1**1 ** 1**1 ** 1**1 ** 1**1**1 ** 1 ** 1**1 ** 1**1**1**1**1 ** 1 ** 1**1**1 **1**1** 1 ** 1 ** 1 -e = 𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟 -f = 𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟 - -a = 1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0 -b = 1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0 -c = 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 ** 1.0 -d = 1.0**1.0 ** 1.0**1.0 ** 1.0**1.0 ** 1.0**1.0 ** 1.0**1.0**1.0 ** 1.0 ** 1.0**1.0 ** 1.0**1.0**1.0 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py.expect deleted file mode 100644 index da8b91530b81d..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_power_op_spacing.py.expect +++ /dev/null @@ -1,83 +0,0 @@ -a = 1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1 -b = ( - 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 - ** 1 -) -c = 1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1 -d = 1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1 -e = 𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟**𨉟 -f = ( - 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 - ** 𨉟 -) - -a = 1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0 -b = ( - 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 - ** 1.0 -) -c = 1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0 -d = 1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0**1.0 diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py deleted file mode 100644 index f3d9fd672515c..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py +++ /dev/null @@ -1,106 +0,0 @@ -first_item, second_item = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure it works when the RHS only has one pair of (optional) parens. -first_item, second_item = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -# Make sure chaining assignments work. -first_item, second_item, third_item, forth_item = m["everything"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure when the RHS's first split at the non-optional paren fits, -# we split there instead of the outer RHS optional paren. -first_item, second_item = some_looooooooong_module.some_loooooog_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = everything = some_looooong_function_name( - first_argument, second_argument, third_argument -) - - -# Make sure unsplittable type ignore won't be moved. -some_kind_of_table[some_key] = util.some_function( # type: ignore # noqa: E501 - some_arg -).intersection(pk_cols) - -some_kind_of_table[ - some_key -] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - -some_kind_of_table[ - some_key # type: ignore # noqa: E501 -] = lambda obj: obj.some_long_named_method() - - -# Make when when the left side of assignment plus the opening paren "... = (" is -# exactly line length limit + 1, it won't be split like that. -xxxxxxxxx_yyy_zzzzzzzz[ - xx.xxxxxx(x_yyy_zzzzzz.xxxxx[0]), x_yyy_zzzzzz.xxxxxx(xxxx=1) -] = 1 - - -# Right side of assignment contains un-nested pairs of inner parens. -some_kind_of_instance.some_kind_of_map[a_key] = ( - isinstance(some_var, SomeClass) - and table.something_and_something != table.something_else -) or ( - isinstance(some_other_var, BaseClass) and table.something != table.some_other_thing -) - -# Multiple targets -a = b = ( - ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) - -a = b = c = d = e = f = g = ( - hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh -) = i = j = ( - kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk -) - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = c - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = ( - cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py.expect deleted file mode 100644 index f3d9fd672515c..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py.expect +++ /dev/null @@ -1,106 +0,0 @@ -first_item, second_item = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure it works when the RHS only has one pair of (optional) parens. -first_item, second_item = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -# Make sure chaining assignments work. -first_item, second_item, third_item, forth_item = m["everything"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure when the RHS's first split at the non-optional paren fits, -# we split there instead of the outer RHS optional paren. -first_item, second_item = some_looooooooong_module.some_loooooog_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = everything = some_looooong_function_name( - first_argument, second_argument, third_argument -) - - -# Make sure unsplittable type ignore won't be moved. -some_kind_of_table[some_key] = util.some_function( # type: ignore # noqa: E501 - some_arg -).intersection(pk_cols) - -some_kind_of_table[ - some_key -] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - -some_kind_of_table[ - some_key # type: ignore # noqa: E501 -] = lambda obj: obj.some_long_named_method() - - -# Make when when the left side of assignment plus the opening paren "... = (" is -# exactly line length limit + 1, it won't be split like that. -xxxxxxxxx_yyy_zzzzzzzz[ - xx.xxxxxx(x_yyy_zzzzzz.xxxxx[0]), x_yyy_zzzzzz.xxxxxx(xxxx=1) -] = 1 - - -# Right side of assignment contains un-nested pairs of inner parens. -some_kind_of_instance.some_kind_of_map[a_key] = ( - isinstance(some_var, SomeClass) - and table.something_and_something != table.something_else -) or ( - isinstance(some_other_var, BaseClass) and table.something != table.some_other_thing -) - -# Multiple targets -a = b = ( - ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) - -a = b = c = d = e = f = g = ( - hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh -) = i = j = ( - kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk -) - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = c - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = ( - cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py deleted file mode 100644 index 812febcf2a19f..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py +++ /dev/null @@ -1,8 +0,0 @@ -foo = 123 # fmt: skip # noqa: E501 # pylint -bar = ( - 123 , - ( 1 + 5 ) # pylint # fmt:skip -) -baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -skip_will_not_work = "a" + "b" # pylint fmt:skip -skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py.expect deleted file mode 100644 index d799b0c790e27..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py.expect +++ /dev/null @@ -1,8 +0,0 @@ -foo = 123 # fmt: skip # noqa: E501 # pylint -bar = ( - 123 , - ( 1 + 5 ) # pylint # fmt:skip -) -baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -skip_will_not_work = "a" + "b" # pylint fmt:skip -skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.options.json deleted file mode 100644 index ce7c52b163497..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.options.json +++ /dev/null @@ -1 +0,0 @@ -{"preview": "enabled"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py deleted file mode 100644 index 24c53091b9002..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py +++ /dev/null @@ -1,24 +0,0 @@ -e = { - "a": fun(msg, "ts"), - "longggggggggggggggid": ..., - "longgggggggggggggggggggkey": ..., "created": ... - # "longkey": ... -} -f = [ - arg1, - arg2, - arg3, arg4 - # comment -] -g = ( - arg1, - arg2, - arg3, arg4 - # comment -) -h = { - arg1, - arg2, - arg3, arg4 - # comment -} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py.expect deleted file mode 100644 index 1b2bafa0287ec..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_trailing_comma.py.expect +++ /dev/null @@ -1,28 +0,0 @@ -e = { - "a": fun(msg, "ts"), - "longggggggggggggggid": ..., - "longgggggggggggggggggggkey": ..., - "created": ..., - # "longkey": ... -} -f = [ - arg1, - arg2, - arg3, - arg4, - # comment -] -g = ( - arg1, - arg2, - arg3, - arg4, - # comment -) -h = { - arg1, - arg2, - arg3, - arg4, - # comment -} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/py310_pep572.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/py310_pep572.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/py310_pep572.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/py310_pep572.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.options.json deleted file mode 100644 index 60044b9854d9b..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.options.json +++ /dev/null @@ -1 +0,0 @@ -{"target_version": "py310"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py deleted file mode 100644 index 629b645fce34f..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py +++ /dev/null @@ -1,19 +0,0 @@ -def http_status(status): - - match status: - - case 400: - - return "Bad request" - - case 401: - - return "Unauthorized" - - case 403: - - return "Forbidden" - - case 404: - - return "Not found" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py.expect deleted file mode 100644 index 735169ef523cf..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_match.py.expect +++ /dev/null @@ -1,13 +0,0 @@ -def http_status(status): - match status: - case 400: - return "Bad request" - - case 401: - return "Unauthorized" - - case 403: - return "Forbidden" - - case 404: - return "Not found" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_redundant_parens_in_case_guard.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_redundant_parens_in_case_guard.options.json index 185c73ab05c66..172715c6e48c6 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_redundant_parens_in_case_guard.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_redundant_parens_in_case_guard.options.json @@ -1 +1 @@ -{"preview": "enabled", "line_width": 79, "target_version": "py310"} \ No newline at end of file +{"preview": "enabled", "line_width": 79, "target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/starred_for_target.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/starred_for_target.options.json index 60044b9854d9b..717b73130fe0f 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/starred_for_target.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/starred_for_target.options.json @@ -1 +1 @@ -{"target_version": "py310"} \ No newline at end of file +{"target_version": "3.10"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_aliases.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_aliases.options.json index cf266d35406c4..4295ffe1df58d 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_aliases.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_aliases.options.json @@ -1 +1 @@ -{"target_version": "py312"} \ No newline at end of file +{"target_version": "3.12"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_param_defaults.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_param_defaults.options.json index b9b2345df913c..f93c020fc917a 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_param_defaults.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_param_defaults.options.json @@ -1 +1 @@ -{"target_version": "py313"} \ No newline at end of file +{"target_version": "3.13"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_params.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_params.options.json index cf266d35406c4..4295ffe1df58d 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_params.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_params.options.json @@ -1 +1 @@ -{"target_version": "py312"} \ No newline at end of file +{"target_version": "3.12"} \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py b/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py deleted file mode 100644 index bbe56623c6107..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py +++ /dev/null @@ -1,67 +0,0 @@ -long_kwargs_single_line = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -multiline_kwargs_indented = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -imploding_kwargs = my_function( - foo="test, this is a sample value", - bar=a - if foo - else b, - baz="hello, this is a another value", -) - -imploding_line = ( - 1 - if 1 + 1 == 2 - else 0 -) - -exploding_line = "hello this is a slightly long string" if some_long_value_name_foo_bar_baz else "this one is a little shorter" - -positional_argument_test(some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz) - -def weird_default_argument(x=some_long_value_name_foo_bar_baz - if SOME_CONSTANT - else some_fallback_value_foo_bar_baz): - pass - -nested = "hello this is a slightly long string" if (some_long_value_name_foo_bar_baz if - nesting_test_expressions else some_fallback_value_foo_bar_baz) \ - else "this one is a little shorter" - -generator_expression = ( - some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz for some_boolean_variable in some_iterable -) - - -def limit_offset_sql(self, low_mark, high_mark): - """Return LIMIT/OFFSET SQL clause.""" - limit, offset = self._get_limit_offset_params(low_mark, high_mark) - return " ".join( - sql - for sql in ( - "LIMIT %d" % limit if limit else None, - ("OFFSET %d" % offset) if offset else None, - ) - if sql - ) - - -def something(): - clone._iterable_class = ( - NamedValuesListIterable - if named - else FlatValuesListIterable - if flat - else ValuesListIterable - ) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py.expect deleted file mode 100644 index 122ea7860dea7..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py.expect +++ /dev/null @@ -1,90 +0,0 @@ -long_kwargs_single_line = my_function( - foo="test, this is a sample value", - bar=( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ), - baz="hello, this is a another value", -) - -multiline_kwargs_indented = my_function( - foo="test, this is a sample value", - bar=( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ), - baz="hello, this is a another value", -) - -imploding_kwargs = my_function( - foo="test, this is a sample value", - bar=a if foo else b, - baz="hello, this is a another value", -) - -imploding_line = 1 if 1 + 1 == 2 else 0 - -exploding_line = ( - "hello this is a slightly long string" - if some_long_value_name_foo_bar_baz - else "this one is a little shorter" -) - -positional_argument_test( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz -) - - -def weird_default_argument( - x=( - some_long_value_name_foo_bar_baz - if SOME_CONSTANT - else some_fallback_value_foo_bar_baz - ), -): - pass - - -nested = ( - "hello this is a slightly long string" - if ( - some_long_value_name_foo_bar_baz - if nesting_test_expressions - else some_fallback_value_foo_bar_baz - ) - else "this one is a little shorter" -) - -generator_expression = ( - ( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ) - for some_boolean_variable in some_iterable -) - - -def limit_offset_sql(self, low_mark, high_mark): - """Return LIMIT/OFFSET SQL clause.""" - limit, offset = self._get_limit_offset_params(low_mark, high_mark) - return " ".join( - sql - for sql in ( - "LIMIT %d" % limit if limit else None, - ("OFFSET %d" % offset) if offset else None, - ) - if sql - ) - - -def something(): - clone._iterable_class = ( - NamedValuesListIterable - if named - else FlatValuesListIterable if flat else ValuesListIterable - ) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py b/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py deleted file mode 100644 index 9c8c40cc96239..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py +++ /dev/null @@ -1,30 +0,0 @@ -from typing import Union - -@bird -def zoo(): ... - -class A: ... -@bar -class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg : List[str]) -> None: ... - -class C: ... -@hmm -class D: ... -class E: ... - -@baz -def foo() -> None: - ... - -class F (A , C): ... -def spam() -> None: ... - -@overload -def spam(arg: str) -> str: ... - -var : int = 1 - -def eggs() -> Union[str, int]: ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py.expect deleted file mode 100644 index 4349ba0a53b5b..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py.expect +++ /dev/null @@ -1,32 +0,0 @@ -from typing import Union - -@bird -def zoo(): ... - -class A: ... - -@bar -class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg: List[str]) -> None: ... - -class C: ... - -@hmm -class D: ... - -class E: ... - -@baz -def foo() -> None: ... - -class F(A, C): ... - -def spam() -> None: ... -@overload -def spam(arg: str) -> str: ... - -var: int = 1 - -def eggs() -> Union[str, int]: ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py b/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py deleted file mode 100644 index bfde79202aade..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py +++ /dev/null @@ -1,16 +0,0 @@ -# flags: --preview --skip-string-normalization -class C: - - r"""Raw""" - -def f(): - - r"""Raw""" - -class SingleQuotes: - - - r'''Raw''' - -class UpperCaseR: - R"""Raw""" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py.expect deleted file mode 100644 index 5be480f7f0e89..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py.expect +++ /dev/null @@ -1,14 +0,0 @@ -class C: - r"""Raw""" - - -def f(): - r"""Raw""" - - -class SingleQuotes: - r'''Raw''' - - -class UpperCaseR: - R"""Raw""" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.options.json b/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.options.json deleted file mode 100644 index c106a9c8f36ea..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.options.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "preview": "enabled" -} diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py b/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py deleted file mode 100644 index eff37f23c008b..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py +++ /dev/null @@ -1,141 +0,0 @@ -def foo_brackets(request): - return JsonResponse( - { - "var_1": foo, - "var_2": bar, - } - ) - -def foo_square_brackets(request): - return JsonResponse( - [ - "var_1", - "var_2", - ] - ) - -func({"a": 37, "b": 42, "c": 927, "aaaaaaaaaaaaaaaaaaaaaaaaa": 11111111111111111111111111111111111111111}) - -func(["random_string_number_one","random_string_number_two","random_string_number_three","random_string_number_four"]) - -func( - { - # expand me - 'a':37, - 'b':42, - 'c':927 - } -) - -func( - [ - 'a', - 'b', - 'c', - ] -) - -func( - [ - 'a', - 'b', - 'c', - ], -) - -func( # a - [ # b - "c", # c - "d", # d - "e", # e - ] # f -) # g - -func( # a - { # b - "c": 1, # c - "d": 2, # d - "e": 3, # e - } # f -) # g - -func( - # preserve me - [ - "c", - "d", - "e", - ] -) - -func( - [ # preserve me but hug brackets - "c", - "d", - "e", - ] -) - -func( - [ - # preserve me but hug brackets - "c", - "d", - "e", - ] -) - -func( - [ - "c", - # preserve me but hug brackets - "d", - "e", - ] -) - -func( - [ - "c", - "d", - "e", - # preserve me but hug brackets - ] -) - -func( - [ - "c", - "d", - "e", - ] # preserve me but hug brackets -) - -func( - [ - "c", - "d", - "e", - ] - # preserve me -) - -func([x for x in "short line"]) -func([x for x in "long line long line long line long line long line long line long line"]) -func([x for x in [x for x in "long line long line long line long line long line long line long line"]]) - -func({"short line"}) -func({"long line", "long long line", "long long long line", "long long long long line", "long long long long long line"}) -func({{"long line", "long long line", "long long long line", "long long long long line", "long long long long long line"}}) - -foooooooooooooooooooo( - [{c: n + 1 for c in range(256)} for n in range(100)] + [{}], {size} -) - -baaaaaaaaaaaaar( - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {x}, "a string", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -) - -foo(*["long long long long long line", "long long long long long line", "long long long long long line"]) - -foo(*[str(i) for i in range(100000000000000000000000000000000000000000000000000000000000)]) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py.expect b/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py.expect deleted file mode 100644 index 963fb7c4040a4..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py.expect +++ /dev/null @@ -1,159 +0,0 @@ -def foo_brackets(request): - return JsonResponse({ - "var_1": foo, - "var_2": bar, - }) - - -def foo_square_brackets(request): - return JsonResponse([ - "var_1", - "var_2", - ]) - - -func({ - "a": 37, - "b": 42, - "c": 927, - "aaaaaaaaaaaaaaaaaaaaaaaaa": 11111111111111111111111111111111111111111, -}) - -func([ - "random_string_number_one", - "random_string_number_two", - "random_string_number_three", - "random_string_number_four", -]) - -func({ - # expand me - "a": 37, - "b": 42, - "c": 927, -}) - -func([ - "a", - "b", - "c", -]) - -func( - [ - "a", - "b", - "c", - ], -) - -func([ # a # b - "c", # c - "d", # d - "e", # e -]) # f # g - -func({ # a # b - "c": 1, # c - "d": 2, # d - "e": 3, # e -}) # f # g - -func( - # preserve me - [ - "c", - "d", - "e", - ] -) - -func([ # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - "c", - # preserve me but hug brackets - "d", - "e", -]) - -func([ - "c", - "d", - "e", - # preserve me but hug brackets -]) - -func([ - "c", - "d", - "e", -]) # preserve me but hug brackets - -func( - [ - "c", - "d", - "e", - ] - # preserve me -) - -func([x for x in "short line"]) -func([ - x for x in "long line long line long line long line long line long line long line" -]) -func([ - x - for x in [ - x - for x in "long line long line long line long line long line long line long line" - ] -]) - -func({"short line"}) -func({ - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", -}) -func({ - { - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", - } -}) - -foooooooooooooooooooo( - [{c: n + 1 for c in range(256)} for n in range(100)] + [{}], {size} -) - -baaaaaaaaaaaaar( - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {x}, "a string", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -) - -foo(*[ - "long long long long long line", - "long long long long long line", - "long long long long long line", -]) - -foo(*[ - str(i) for i in range(100000000000000000000000000000000000000000000000000000000000) -]) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/import_black_tests.py b/crates/ruff_python_formatter/resources/test/fixtures/import_black_tests.py index b658b5807332d..a9cbb2cc6d6da 100755 --- a/crates/ruff_python_formatter/resources/test/fixtures/import_black_tests.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/import_black_tests.py @@ -35,12 +35,12 @@ def import_fixture(fixture: Path, fixture_set: str): # If there's no output marker, treat the whole file as already pre-formatted expected = input - options = {} + black_options = {} extension = "py" if flags: if "--preview" in flags or "--unstable" in flags: - options["preview"] = "enabled" + black_options["preview"] = "enabled" if "--pyi" in flags: extension = "pyi" @@ -53,21 +53,22 @@ def import_fixture(fixture: Path, fixture_set: str): [_, length_and_rest] = flags.split("--line-length=", 1) length = length_and_rest.split(" ", 1)[0] length = int(length) - options["line_width"] = 1 if length == 0 else length + black_options["line_width"] = 1 if length == 0 else length if "--minimum-version=" in flags: [_, version] = flags.split("--minimum-version=", 1) version = version.split(" ", 1)[0] - # Convert 3.10 to py310 - options["target_version"] = f"py{version.strip().replace('.', '')}" + black_options["target_version"] = version.strip() if "--skip-magic-trailing-comma" in flags: - options["magic_trailing_comma"] = "ignore" + black_options["magic_trailing_comma"] = "ignore" fixture_path = output_directory.joinpath(fixture.name).with_suffix(f".{extension}") expect_path = fixture_path.with_suffix(f".{extension}.expect") options_path = fixture_path.with_suffix(".options.json") + options = OPTIONS_OVERRIDES.get(fixture.name, black_options) + if len(options) > 0: if extension == "pyi": options["source_type"] = "Stub" @@ -109,6 +110,16 @@ def import_fixture(fixture: Path, fixture_set: str): "line_ranges_outside_source.py", ] +# Specs for which to override the formatter options +OPTIONS_OVERRIDES = { + "context_managers_38.py": { + "target_version": "py38" + }, + "context_managers_autodetect_38.py" : { + "target_version": "py38" + } +} + def import_fixtures(black_dir: str): """Imports all the black fixtures""" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_chaperones.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_chaperones.py new file mode 100644 index 0000000000000..e855eecc77904 --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_chaperones.py @@ -0,0 +1,66 @@ +def a1(): + """Needs chaperone\\" """ + +def a2(): + """Needs chaperone\\\ """ + +def a3(): + """Needs chaperone" """ + +def a4(): + """Needs chaperone\ """ + +def a5(): + """Needs chaperone\\\\\ """ + +def a6(): + """Needs chaperone\"" """ + +def a7(): + """Doesn't need chaperone\"""" + +def a8(): + """Doesn't need chaperone\'""" + +def a9(): + """Doesn't need chaperone\\\"""" + +def a10(): + """Doesn't need chaperone\\\'""" + +def a11(): + """Doesn't need chaperone; all slashes escaped\\\\""" + +def a12(): + """Doesn't need chaperone\\""" + +def a12(): + """Doesn't need "chaperone" with contained quotes""" + +def a13(): + """Doesn't need chaperone\\\"\"\"""" + +def a14(): + """Multiline docstring + doesn't need chaperone + """ + +def a15(): + """Multiline docstring + doesn't need chaperone\ + """ + +def a16(): + """Multiline docstring with + odd number of backslashes don't need chaperone\\\ + """ + +def a17(): + """Multiline docstring with + even number of backslashes don't need chaperone\\\\ + """ + +def a18(): + r"""Raw multiline docstring + doesn't need chaperone\ + """ diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_non_visible_characters.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_non_visible_characters.py index 0b816c10a44e8..f35943561bda8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_non_visible_characters.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_non_visible_characters.py @@ -1,4 +1,4 @@ -# Regresssion test for https://github.com/astral-sh/ruff/issues/11724 +# Regression test for https://github.com/astral-sh/ruff/issues/11724 '''  diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/attribute.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/attribute.py index 6312b607d5c1e..6f5a7ac1a60d8 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/attribute.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/attribute.py @@ -152,3 +152,20 @@ f(111111111111111111111111111111111111111111111111111111111111111111111111111111111) + 1 ).bit_length() + + +# Regression test for https://github.com/astral-sh/ruff/issues/16151 +result = ( + (await query_the_thing(mypy_doesnt_understand)) # type: ignore[x] + .foo() + .bar() +) + +( + ( + a # trailing end-of-line + # trailing own-line + ) # trailing closing parentheses + # dangling before dot + .b # trailing end-of-line +) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary.py index 83c6f0ff9fc3a..8b27e3cd9f1a4 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary.py @@ -418,3 +418,16 @@ "permissions to manage this role, or else members of this role won't receive " "a notification." ) + +# This f-string should be flattened +xxxxxxxxxxxxxxxx = f"aaaaaaaaaaaaaaaaaaaaa { + expression } bbbbbbbbbbbbbbbbbbbbbbbb" + ( + yyyyyyyyyyyyyy + zzzzzzzzzzz +) + +# This is not a multiline f-string, but the expression is too long so it should be +# wrapped in parentheses. +f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) +aaaaaaaaaaa = f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring.py index 3c895ee85aeb4..d3a19d24e8238 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring.py @@ -313,6 +313,321 @@ # comment 28 } woah {x}" +# Assignment statement + +# Even though this f-string has multiline expression, thus allowing us to break it at the +# curly braces, the f-string fits on a single line if it's moved inside the parentheses. +# We should prefer doing that instead. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" + +# Same as above +xxxxxxx = f"{ + {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} +}" + +# Similar to the previous example, but the f-string will exceed the line length limit, +# we shouldn't add any parentheses here. +xxxxxxx = f"{ + {'aaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} +}" + +# Same as above but with an inline comment. The f-string should be formatted inside the +# parentheses and the comment should be part of the line inside the parentheses. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment + +# Similar to the previous example but this time parenthesizing doesn't work because it +# exceeds the line length. So, avoid parenthesizing this f-string. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# Similar to the previous example but we start with the parenthesized layout. This should +# remove the parentheses and format the f-string on a single line. This shows that the +# final layout for the formatter is same for this and the previous case. The only +# difference is that in the previous case the expression is already mulitline which means +# the formatter can break it further at the curly braces. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment loooooooong +) + +# The following f-strings are going to break because of the trailing comma so we should +# avoid using the best fit layout and instead use the default layout. +# left-to-right +aaaa = f"aaaa {[ + 1, 2, +]} bbbb" +# right-to-left +aaaa, bbbb = f"aaaa {[ + 1, 2, +]} bbbb" + +# Using the right-to-left assignment statement variant. +aaaaaaaaaaaaaaaaaa, bbbbbbbbbbb = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment + +# Here, the f-string layout is flat but it exceeds the line length limit. This shouldn't +# try the custom best fit layout because the f-string doesn't have any split points. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +# Same as above but without the parentheses to test that it gets formatted to the same +# layout as the previous example. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" + +# But, the following f-string does have a split point because of the multiline expression. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbb + cccccccccccccccccccccc + dddddddddddddddddddddddddddd} ddddddddddddddddddd" +) + +# This is an implicitly concatenated f-string but it cannot be joined because otherwise +# it'll exceed the line length limit. So, the two f-strings will be inside parentheses +# instead and the inline comment should be outside the parentheses. +a = f"test{ + expression +}flat" f"can be { + joined +} togethereeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# Similar to the above example but this fits within the line length limit. +a = f"test{ + expression +}flat" f"can be { + joined +} togethereeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# The following test cases are adopted from implicit string concatenation but for a +# single f-string instead. + +# Don't inline f-strings that contain expressions that are guaranteed to split, e.g. because of a magic trailing comma +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment +) + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = (f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment +) + +# Don't inline f-strings that contain commented expressions +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{[ + a # comment + ]}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{[ + a # comment + ]}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# Don't inline f-strings with multiline debug expressions or format specifiers +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + + b=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# This is not a multiline f-string even though it has a newline after the format specifier. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest" # comment +) + +# The newline is only considered when it's a tripled-quoted f-string. +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"""testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment +) + +# Remove the parentheses here +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{[a, b, + # comment + ]}moee" # comment +) +# ... but not here because of the ownline comment +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{[a, b, + ]}moee" + # comment +) + +# F-strings in other positions + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if ( + f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + }" +): pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { # comment + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if ( + f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + }" +): + pass + +if f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +# For loops +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeee": + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# With statements +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeee": + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# Assert statements +assert f"aaaaaaaaa{ + expression}bbbbbbbbbbbb", f"cccccccccc{ + expression}dddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{ + expression}dddddddddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{expression}dddddddddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccccccccccccccccc { + expression} dddddddddddddddddddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"cccccccccccccccccccccccccccccccc {expression} ddddddddddddddddddddddddddddddddddddd" + +# F-strings as a single argument to a call expression to test whether it's huggable or not. +call(f"{ + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"{ + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"{ # comment + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""") + +call(f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""") + +call( + f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""" +) + +call(f"{ + aaaaaa + + '''test + more''' +}") + # Indentation # What should be the indentation? @@ -346,3 +661,73 @@ f'This string uses double quotes in an expression {"it's a quote"}' f'This f-string does not use any quotes.' ) + +# Regression test for https://github.com/astral-sh/ruff/issues/14487 +f"aaaaaaaaaaaaaaaaaaaaaaaaaa {10**27} bbbbbbbbbbbbbbbbbbbbbbbbbb ccccccccccccccccccccccccc" + +# Regression test for https://github.com/astral-sh/ruff/issues/14778 +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' 'a' if True else ""}" +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' 'a' if True else ""}" + +# Quotes reuse +f"{'a'}" + +# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes +f'foo {10 + len("bar")=}' +f'''foo {10 + len("""bar""")=}''' + +# 312+, it's okay to change the quotes here without creating an invalid f-string +f'{"""other " """}' +f'{"""other " """ + "more"}' +f'{b"""other " """}' +f'{f"""other " """}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 +f'{1: hy "user"}' +f'{1:hy "user"}' +f'{1: abcd "{1}" }' +f'{1: abcd "{'aa'}" }' +f'{1=: "abcd {'aa'}}' +f'{x:a{z:hy "user"}} \'\'\'' + +# Changing the outer quotes is fine because the format-spec is in a nested expression. +f'{f'{z=:hy "user"}'} \'\'\'' + + +# We have to be careful about changing the quotes if the f-string has a debug expression because it is inserted verbatim. +f'{1=: "abcd \'\'}' # Don't change the outer quotes, or it results in a syntax error +f'{1=: abcd \'\'}' # Changing the quotes here is fine because the inner quotes aren't the opposite quotes +f'{1=: abcd \"\"}' # Changing the quotes here is fine because the inner quotes are escaped +# Don't change the quotes in the following cases: +f'{x=:hy "user"} \'\'\'' +f'{x=:a{y:hy "user"}} \'\'\'' +f'{x=:a{y:{z:hy "user"}}} \'\'\'' +f'{x:a{y=:{z:hy "user"}}} \'\'\'' + +# This is fine because the debug expression and format spec are in a nested expression + +f"""{1=: "this" is fine}""" +f'''{1=: "this" is fine}''' # Change quotes to double quotes because they're preferred +f'{1=: {'ab"cd"'}}' # It's okay if the quotes are in an expression part. + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15459 +print(f"{ {1, 2, 3} - {2} }") +print(f"{ {1: 2}.keys() }") +print(f"{({1, 2, 3}) - ({2})}") +print(f"{1, 2, {3} }") +print(f"{(1, 2, {3})}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15535 +print(f"{ {}, }") # A single item tuple gets parenthesized +print(f"{ {}.values(), }") +print(f"{ {}, 1 }") # A tuple with multiple elements doesn't get parenthesized +print(f"{ # Tuple with multiple elements that doesn't fit on a single line gets parenthesized + {}, 1, +}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15536 +print(f"{ {}, 1, }") diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.options.json similarity index 100% rename from crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.options.json rename to crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.options.json diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.py new file mode 100644 index 0000000000000..2926a0c1e20f1 --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.py @@ -0,0 +1,20 @@ +# This test is in its own file because it results in AST changes on stable. +# We don't plan to fix it on stable because we plan on promoting f-string formatting soon. + +# Regression test for https://github.com/astral-sh/ruff/issues/14766 +# Don't change the casing of the escaped characters in the f-string because it would be observable in the debug expression. +# >>> f"{r"\xFF"=}" +# 'r"ÿ"=\'\\\\xFF\'' +# >>> f"{r"\xff"=}" +# 'r"ÿ"=\'\\\\xff\'' +f"{r"\xFF"=}" +f"{r"\xff"=}" + + +# Test for https://github.com/astral-sh/ruff/issues/14926 +# We could change the casing of the escaped characters in non-raw f-string because Python interprets the inner string +# before printing it as a debug expression. For now, we decided not to change the casing because it's fairly complicated +# to implement and it seems uncommon (debug expressions are uncommon, escapes are uncommon). +# These two strings could be formatted to the same output but we currently don't do that. +f"{"\xFF\N{space}"=}" +f"{"\xff\N{SPACE}"=}" diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.options.json deleted file mode 100644 index a622b73244189..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.options.json +++ /dev/null @@ -1,5 +0,0 @@ -[ - { - "target_version": "py312" - } -] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.py deleted file mode 100644 index bd1d755f2d5fb..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.py +++ /dev/null @@ -1,17 +0,0 @@ -# This file contains test cases only for cases where the logic tests for whether -# the target version is 3.12 or later. A user can have 3.12 syntax even if the target -# version isn't set. - -# Quotes reuse -f"{'a'}" - -# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes -f'foo {10 + len("bar")=}' -f'''foo {10 + len("""bar""")=}''' - -# 312+, it's okay to change the quotes here without creating an invalid f-string -f'{"""other " """}' -f'{"""other " """ + "more"}' -f'{b"""other " """}' -f'{f"""other " """}' - diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.py index 6dccb377d898c..ede789e997978 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string.py @@ -55,7 +55,7 @@ # F-strings ############################################################################## -# Escape `{` and `}` when marging an f-string with a string +# Escape `{` and `}` when merging an f-string with a string "a {not_a_variable}" f"b {10}" "c" # Join, and break expressions @@ -96,7 +96,7 @@ f"{10 + len('bar')=}" f"{10 + len('bar')=}" f"{10 + len('bar')=}" f'no debug{10}' f"{10 + len('bar')=}" -# We can't savely merge this pre Python 3.12 without altering the debug expression. +# We can't safely merge this pre Python 3.12 without altering the debug expression. f"{10 + len('bar')=}" f'{10 + len("bar")=}' @@ -259,7 +259,7 @@ def short_docstring(): "Implicit" "concatenated" "docstring" def long_docstring(): - "Loooooooooooooooooooooong" "doooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiing" "exceding the line width" "but it should be concatenated anyways because it is single line" + "Loooooooooooooooooooooong" "doooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiing" "exceeding the line width" "but it should be concatenated anyways because it is single line" def docstring_with_leading_whitespace(): " This is a " "implicit" "concatenated" "docstring" @@ -319,3 +319,31 @@ def implicit_with_comment(): assert False, +"Implicit concatenated string" "uses {} layout on {} format".format( "Multiline", "first" ) + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 + +"a" f'{1=: "abcd \'\'}' +f'{1=: "abcd \'\'}' "a" +f'{1=: "abcd \'\'}' f"{1=: 'abcd \"\"}" + +# These strings contains escaped newline characters and should be joined, they are +# not multiline strings. +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd" +b"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" b"cccccccccccccc \ + ddddddddddddddddddd" +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd" # comment 1 +(f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd") # comment 2 +( + f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" # comment 3 + "cccccccccccccc \ + ddddddddddddddddddd" # comment 4 +) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.options.json deleted file mode 100644 index 8925dd0a8280f..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.options.json +++ /dev/null @@ -1,5 +0,0 @@ -[ - { - "preview": "enabled" - } -] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.py index 2cd23efdc254d..642ad83c27444 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_assignment.py @@ -291,3 +291,87 @@ f"testeeeeeeeeeeeeeeeeeeeeeeeee{a =}" "moreeeeeeeeeeeeeeeeeetest" # comment ) + + +# Trailing last-part comments + +a = ( + "a" + "b" # belongs to `b` +) + +a: Literal[str] = ( + "a" + "b" # belongs to `b` +) + +a += ( + "a" + "b" # belongs to `b` +) + +a = ( + r"a" + r"b" # belongs to `b` +) + +a = ( + "a" + "b" +) # belongs to the assignment + +a = ((( + "a" + "b" # belongs to `b` +))) + +a = ((( + "a" + "b" +) # belongs to the f-string expression +)) + +a = ( + "a" "b" # belongs to the f-string expression +) + +a = ( + "a" "b" + # belongs to the f-string expression +) + +# There's no "right" answer if some parts are on the same line while others are on separate lines. +# This is likely a comment for one of the last two parts but could also just be a comment for the entire f-string expression. +# Because there's no right answer, follow what we do elsewhere and associate the comment with the outer-most node which +# is the f-string expression. +a = ( + "a" + "b" "ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" # belongs to the f-string expression +) + +logger.error( + f"Failed to run task {task} for job" + f"with id {str(job.id)}" # type: ignore[union-attr] +) + +a = (10 + + "Exception in {call_back_name} " + f"'{msg}'" # belongs to binary operation +) + +a = 10 + ( + "Exception in {call_back_name} " + f"'{msg}'" # belongs to f-string +) + +self._attr_unique_id = ( + f"{self._device.temperature.group_address_state}_" + f"{self._device.target_temperature.group_address_state}_" + f"{self._device.target_temperature.group_address}_" + f"{self._device._setpoint_shift.group_address}" # noqa: SLF001 +) + +return ( + f"Exception in {call_back_name} when handling msg on " + f"'{msg.topic}': '{msg.payload}'" # type: ignore[str-bytes-safe] +) \ No newline at end of file diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.options.json index b7d2d58057d95..e6adddbe26fc4 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.options.json @@ -1,11 +1,9 @@ [ { - "quote_style": "preserve", - "preview": "enabled" + "quote_style": "preserve" }, { "quote_style": "preserve", - "preview": "enabled", - "target_version": "py312" + "target_version": "3.12" } ] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.py index 2492be47039e7..c8d60d251a468 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/join_implicit_concatenated_string_preserve.py @@ -11,3 +11,12 @@ # Already invalid Pre Python 312 f"{'Hy "User"'}" f'{"Hy 'User'"}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15514 +params = {} +string = "this is my string with " f'"{params.get("mine")}"' +string = f'"{params.get("mine")} ' f"with {'nested single quoted string'}" +string = f"{'''inner ' '''}" f'{"""inner " """}' +string = f"{10 + len('bar')=}" f"{10 + len('bar')=}" +string = f"{10 + len('bar')=}" f'{10 + len("bar")=}' diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/string.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/string.py index ce01296d5f7e7..cfdbf5c34b994 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/string.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/string.py @@ -138,3 +138,77 @@ a = """\x1F""" a = """\\x1F""" a = """\\\x1F""" + + +############################################################################## +# Implicit concatenated strings +############################################################################## + +# In preview, don't collapse implicit concatenated strings that can't be joined into a single string +# and that are multiline in the source. + +( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" +) + +( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + "cccccccccccccccccccccc" +) + +( + """aaaaaaaaa""" + """bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{ + 10}aaaaa""" + fr"""bbbbbbbbbbbbbbbbbbbb""" +) + +if ( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" + ) + ["aaaaaaaaaa", "bbbbbbbbbbbbbbbb"]: ... + + + +# In preview, keep implicit concatenated strings on a single line if they fit and are not separate by line breaks in the source +( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" +) + +r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + +( + f"aaaa{ + 10}aaaaa" fr"bbbbbbbbbbbbbbbbbbbb" +) + +( + r"""aaaaaaaaa""" r"""bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{ + 10}aaaaa""" fr"""bbbbbbbbbbbbbbbbbbbb""" +) + +# In docstring positions +def docstring(): + ( + r"aaaaaaaaa" + "bbbbbbbbbbbbbbbbbbbb" + ) + +def docstring_flat(): + ( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + ) + +def docstring_flat_overlong(): + ( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + ) diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern/pattern_maybe_parenthesize.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern/pattern_maybe_parenthesize.py index b898fad81bbba..fe1a4a30507f5 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern/pattern_maybe_parenthesize.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern/pattern_maybe_parenthesize.py @@ -288,5 +288,13 @@ ]: pass - +match a, b: + case [], []: + ... + case [], _: + ... + case _, []: + ... + case _, _: + ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern_match_regression_brackets.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern_match_regression_brackets.py new file mode 100644 index 0000000000000..5f94a64eb294a --- /dev/null +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern_match_regression_brackets.py @@ -0,0 +1,8 @@ +# Ruff in some cases added brackets around tuples in some cases; deviating from Black. +# Ensure we don't revert already-applied formats with the fix. +# See https://github.com/astral-sh/ruff/pull/18147 +match a, b: + case [[], []]: + ... + case [[], _]: + ... diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/same_line_body.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/same_line_body.py index 6e0adcd6a2336..d9ad82648e39a 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/same_line_body.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/same_line_body.py @@ -13,7 +13,7 @@ def test3( a): <RANGE_START>print("body" ) # The if header and the print statement together are longer than 100 characters. # The print statement should either be wrapped to fit at the end of the if statement, or be converted to a # suite body -if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be intented" )<RANGE_END> +if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be indented" )<RANGE_END> -# This print statement is too-long even when intented. It should be wrapped -if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be intented", "more content to make it exceed the 88 chars limit")<RANGE_END> +# This print statement is too long even when indented. It should be wrapped +if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be indented", "more content to make it exceed the 88 chars limit")<RANGE_END> diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/stub.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/stub.options.json index 94ab017cf889e..723251954940e 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/stub.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/stub.options.json @@ -1,6 +1,5 @@ [ { - "preview": "enabled", "source_type": "Stub" } ] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assignment_split_value_first.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assignment_split_value_first.options.json deleted file mode 100644 index 8925dd0a8280f..0000000000000 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assignment_split_value_first.options.json +++ /dev/null @@ -1,5 +0,0 @@ -[ - { - "preview": "enabled" - } -] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_parameters.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_parameters.py index c97a7e717487f..b866a86b5cf4a 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_parameters.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_parameters.py @@ -54,7 +54,7 @@ def test_return_union_with_elements_exceeding_length( ######################################################################################### -# Multiline stirngs (NeedsParentheses::Never) +# Multiline strings (NeedsParentheses::Never) ######################################################################################### diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.options.json index 2eeb9813abd27..c44e8651419b1 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.options.json @@ -1,9 +1,9 @@ [ { - "target_version": "py38" + "target_version": "3.8" }, { - "target_version": "py39", + "target_version": "3.9", "preview": "enabled" } ] diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.py b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.py index f987b0856ed9f..9c8b425628792 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.py +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with.py @@ -328,3 +328,42 @@ if True: with anyio.CancelScope(shield=True) if get_running_loop() else contextlib.nullcontext() as b: pass + + +# Regression test for https://github.com/astral-sh/ruff/issues/14001 +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( # trailing comment + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( + ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + ) + # Bar +): + pass diff --git a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with_39.options.json b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with_39.options.json index 3621449825eea..d929350237990 100644 --- a/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with_39.options.json +++ b/crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/with_39.options.json @@ -1,6 +1,6 @@ [ { - "target_version": "py39", + "target_version": "3.9", "preview": "enabled" } ] diff --git a/crates/ruff_python_formatter/src/builders.rs b/crates/ruff_python_formatter/src/builders.rs index 3d4990492645d..6d7c79e33dce1 100644 --- a/crates/ruff_python_formatter/src/builders.rs +++ b/crates/ruff_python_formatter/src/builders.rs @@ -1,7 +1,7 @@ -use ruff_formatter::{write, Argument, Arguments}; +use ruff_formatter::{Argument, Arguments, write}; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::context::{FStringState, NodeLevel, WithNodeLevel}; +use crate::context::{NodeLevel, WithNodeLevel}; use crate::other::commas::has_magic_trailing_comma; use crate::prelude::*; @@ -42,7 +42,7 @@ impl<'ast> Format<PyFormatContext<'ast>> for ParenthesizeIfExpands<'_, 'ast> { soft_block_indent(&Arguments::from(&self.inner)).fmt(f)?; } else { Arguments::from(&self.inner).fmt(f)?; - }; + } if_group_breaks(&token(")")).fmt(f) }))] @@ -178,7 +178,6 @@ impl<'fmt, 'ast, 'buf> JoinCommaSeparatedBuilder<'fmt, 'ast, 'buf> { self } - #[allow(unused)] pub(crate) fn entries<T, I, F>(&mut self, entries: I) -> &mut Self where T: Ranged, @@ -206,14 +205,18 @@ impl<'fmt, 'ast, 'buf> JoinCommaSeparatedBuilder<'fmt, 'ast, 'buf> { pub(crate) fn finish(&mut self) -> FormatResult<()> { self.result.and_then(|()| { - // If the formatter is inside an f-string expression element, and the layout - // is flat, then we don't need to add a trailing comma. - if let FStringState::InsideExpressionElement(context) = - self.fmt.context().f_string_state() + // Don't add a magic trailing comma when formatting an f-string expression + // that always must be flat because the `expand_parent` forces enclosing + // groups to expand, e.g. `print(f"{(a,)} ")` would format the f-string in + // flat mode but the `print` call gets expanded because of the `expand_parent`. + if self + .fmt + .context() + .f_string_state() + .can_contain_line_breaks() + == Some(false) { - if !context.can_contain_line_breaks() { - return Ok(()); - } + return Ok(()); } if let Some(last_end) = self.entries.position() { diff --git a/crates/ruff_python_formatter/src/cli.rs b/crates/ruff_python_formatter/src/cli.rs index dddd0db5a3a9b..60f7cd413c1e1 100644 --- a/crates/ruff_python_formatter/src/cli.rs +++ b/crates/ruff_python_formatter/src/cli.rs @@ -3,16 +3,16 @@ use std::path::{Path, PathBuf}; use anyhow::{Context, Result}; -use clap::{command, Parser, ValueEnum}; +use clap::{Parser, ValueEnum, command}; use ruff_formatter::SourceCode; use ruff_python_ast::PySourceType; -use ruff_python_parser::{parse, AsMode}; +use ruff_python_parser::{ParseOptions, parse}; use ruff_python_trivia::CommentRanges; use ruff_text_size::Ranged; use crate::comments::collect_comments; -use crate::{format_module_ast, MagicTrailingComma, PreviewMode, PyFormatOptions}; +use crate::{MagicTrailingComma, PreviewMode, PyFormatOptions, format_module_ast}; #[derive(ValueEnum, Clone, Debug)] pub enum Emit { @@ -24,7 +24,7 @@ pub enum Emit { #[derive(Parser)] #[command(author, version, about, long_about = None)] -#[allow(clippy::struct_excessive_bools)] // It's only the dev cli anyways +#[expect(clippy::struct_excessive_bools)] // It's only the dev cli anyways pub struct Cli { /// Python files to format. If there are none, stdin will be used. `-` as stdin is not supported pub files: Vec<PathBuf>, @@ -48,7 +48,7 @@ pub fn format_and_debug_print(source: &str, cli: &Cli, source_path: &Path) -> Re let source_type = PySourceType::from(source_path); // Parse the AST. - let parsed = parse(source, source_type.as_mode()).context("Syntax error in input")?; + let parsed = parse(source, ParseOptions::from(source_type)).context("Syntax error in input")?; let options = PyFormatOptions::from_extension(source_path) .with_preview(if cli.preview { diff --git a/crates/ruff_python_formatter/src/comments/debug.rs b/crates/ruff_python_formatter/src/comments/debug.rs index 2729275fe9645..a2038669b4282 100644 --- a/crates/ruff_python_formatter/src/comments/debug.rs +++ b/crates/ruff_python_formatter/src/comments/debug.rs @@ -184,7 +184,7 @@ mod tests { use insta::assert_debug_snapshot; use ruff_formatter::SourceCode; - use ruff_python_ast::AnyNode; + use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{StmtBreak, StmtContinue}; use ruff_python_trivia::{CommentLinePosition, CommentRanges}; use ruff_text_size::{TextRange, TextSize}; @@ -194,13 +194,13 @@ mod tests { #[test] fn debug() { - let continue_statement = AnyNode::from(StmtContinue { + let continue_statement = StmtContinue { range: TextRange::new(TextSize::new(18), TextSize::new(26)), - }); + }; - let break_statement = AnyNode::from(StmtBreak { + let break_statement = StmtBreak { range: TextRange::new(TextSize::new(55), TextSize::new(60)), - }); + }; let source = r"# leading comment continue; # trailing @@ -213,7 +213,7 @@ break; let mut comments_map: CommentsMap = MultiMap::new(); comments_map.push_leading( - continue_statement.as_ref().into(), + AnyNodeRef::from(&continue_statement).into(), SourceComment::new( source_code.slice(TextRange::at(TextSize::new(0), TextSize::new(17))), CommentLinePosition::OwnLine, @@ -221,7 +221,7 @@ break; ); comments_map.push_trailing( - continue_statement.as_ref().into(), + AnyNodeRef::from(&continue_statement).into(), SourceComment::new( source_code.slice(TextRange::at(TextSize::new(28), TextSize::new(10))), CommentLinePosition::EndOfLine, @@ -229,7 +229,7 @@ break; ); comments_map.push_leading( - break_statement.as_ref().into(), + AnyNodeRef::from(&break_statement).into(), SourceComment::new( source_code.slice(TextRange::at(TextSize::new(39), TextSize::new(15))), CommentLinePosition::OwnLine, diff --git a/crates/ruff_python_formatter/src/comments/format.rs b/crates/ruff_python_formatter/src/comments/format.rs index 8da3d1daeac2b..af1868681a56e 100644 --- a/crates/ruff_python_formatter/src/comments/format.rs +++ b/crates/ruff_python_formatter/src/comments/format.rs @@ -1,9 +1,9 @@ use std::borrow::Cow; -use ruff_formatter::{format_args, write, FormatError, FormatOptions, SourceCode}; -use ruff_python_ast::{AnyNodeRef, AstNode, NodeKind, PySourceType}; +use ruff_formatter::{FormatError, FormatOptions, SourceCode, format_args, write}; +use ruff_python_ast::{AnyNodeRef, NodeKind, PySourceType}; use ruff_python_trivia::{ - is_pragma_comment, lines_after, lines_after_ignoring_trivia, lines_before, CommentLinePosition, + CommentLinePosition, is_pragma_comment, lines_after, lines_after_ignoring_trivia, lines_before, }; use ruff_text_size::{Ranged, TextLen, TextRange}; @@ -13,11 +13,11 @@ use crate::prelude::*; use crate::statement::suite::should_insert_blank_line_after_class_in_stub_file; /// Formats the leading comments of a node. -pub(crate) fn leading_node_comments<T>(node: &T) -> FormatLeadingComments +pub(crate) fn leading_node_comments<'a, T>(node: T) -> FormatLeadingComments<'a> where - T: AstNode, + T: Into<AnyNodeRef<'a>>, { - FormatLeadingComments::Node(node.as_any_node_ref()) + FormatLeadingComments::Node(node.into()) } /// Formats the passed comments as leading comments @@ -85,7 +85,7 @@ pub(crate) struct FormatLeadingAlternateBranchComments<'a> { impl Format<PyFormatContext<'_>> for FormatLeadingAlternateBranchComments<'_> { fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { - if self.last_node.map_or(false, |preceding| { + if self.last_node.is_some_and(|preceding| { should_insert_blank_line_after_class_in_stub_file(preceding, None, f.context()) }) { write!(f, [empty_line(), leading_comments(self.comments)])?; @@ -192,11 +192,11 @@ impl Format<PyFormatContext<'_>> for FormatTrailingComments<'_> { } /// Formats the dangling comments of `node`. -pub(crate) fn dangling_node_comments<T>(node: &T) -> FormatDanglingComments +pub(crate) fn dangling_node_comments<'a, T>(node: T) -> FormatDanglingComments<'a> where - T: AstNode, + T: Into<AnyNodeRef<'a>>, { - FormatDanglingComments::Node(node.as_any_node_ref()) + FormatDanglingComments::Node(node.into()) } pub(crate) fn dangling_comments(comments: &[SourceComment]) -> FormatDanglingComments { @@ -381,14 +381,13 @@ impl Format<PyFormatContext<'_>> for FormatTrailingEndOfLineComment<'_> { 0 } else { // Start with 2 because of the two leading spaces. - let width = 2u32.saturating_add( + + 2u32.saturating_add( TextWidth::from_text(&normalized_comment, f.options().indent_width()) .width() .expect("Expected comment not to contain any newlines") .value(), - ); - - width + ) }; write!( diff --git a/crates/ruff_python_formatter/src/comments/map.rs b/crates/ruff_python_formatter/src/comments/map.rs index 9222d25549d2a..0d727fa212067 100644 --- a/crates/ruff_python_formatter/src/comments/map.rs +++ b/crates/ruff_python_formatter/src/comments/map.rs @@ -244,7 +244,6 @@ impl<K: std::hash::Hash + Eq, V> MultiMap<K, V> { } /// Returns `true` if `key` has any *leading*, *dangling*, or *trailing* parts. - #[allow(unused)] pub(super) fn has(&self, key: &K) -> bool { self.index.contains_key(key) } @@ -340,7 +339,7 @@ impl<'a, T> IntoIterator for LeadingDanglingTrailing<'a, T> { } } -impl<'a, T> Debug for LeadingDanglingTrailing<'a, T> +impl<T> Debug for LeadingDanglingTrailing<'_, T> where T: Debug, { @@ -505,7 +504,7 @@ impl InOrderEntry { #[derive(Clone, Debug)] struct OutOfOrderEntry { - /// Index into the [`MultiMap::out_of_order`] vector at which offset the leaading vec is stored. + /// Index into the [`MultiMap::out_of_order`] vector at which offset the leading vec is stored. leading_index: usize, _count: Count<OutOfOrderEntry>, } @@ -542,7 +541,7 @@ impl PartIndex { // OK because: // * The `value < u32::MAX` guarantees that the add doesn't overflow. // * The `+ 1` guarantees that the index is not zero - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] Self(std::num::NonZeroU32::new((value as u32) + 1).expect("valid value")) } diff --git a/crates/ruff_python_formatter/src/comments/mod.rs b/crates/ruff_python_formatter/src/comments/mod.rs index 40b7f47005788..af65795e1b2ab 100644 --- a/crates/ruff_python_formatter/src/comments/mod.rs +++ b/crates/ruff_python_formatter/src/comments/mod.rs @@ -422,7 +422,7 @@ impl<'a> Comments<'a> { dangling.mark_formatted(); } - node.visit_preorder(&mut MarkVerbatimCommentsAsFormattedVisitor(self)); + node.visit_source_order(&mut MarkVerbatimCommentsAsFormattedVisitor(self)); } /// Returns an object that implements [Debug] for nicely printing the [`Comments`]. @@ -460,7 +460,7 @@ impl<'a> Comments<'a> { comments: self, has_comment: false, }; - node.visit_preorder(&mut visitor); + node.visit_source_order(&mut visitor); visitor.has_comment } @@ -514,7 +514,7 @@ mod tests { use ruff_formatter::SourceCode; use ruff_python_ast::{Mod, PySourceType}; - use ruff_python_parser::{parse, AsMode, Parsed}; + use ruff_python_parser::{ParseOptions, Parsed, parse}; use ruff_python_trivia::CommentRanges; use crate::comments::Comments; @@ -529,8 +529,8 @@ mod tests { fn from_code(source: &'a str) -> Self { let source_code = SourceCode::new(source); let source_type = PySourceType::Python; - let parsed = - parse(source, source_type.as_mode()).expect("Expect source to be valid Python"); + let parsed = parse(source, ParseOptions::from(source_type)) + .expect("Expect source to be valid Python"); let comment_ranges = CommentRanges::from(parsed.tokens()); CommentsTestCase { diff --git a/crates/ruff_python_formatter/src/comments/placement.rs b/crates/ruff_python_formatter/src/comments/placement.rs index 02c61e2faadd4..43ebbfa68e879 100644 --- a/crates/ruff_python_formatter/src/comments/placement.rs +++ b/crates/ruff_python_formatter/src/comments/placement.rs @@ -1,19 +1,19 @@ -use std::cmp::Ordering; - use ast::helpers::comment_indentation_after; use ruff_python_ast::whitespace::indentation; use ruff_python_ast::{ - self as ast, AnyNodeRef, Comprehension, Expr, ModModule, Parameter, Parameters, + self as ast, AnyNodeRef, Comprehension, Expr, ModModule, Parameter, Parameters, StringLike, }; use ruff_python_trivia::{ - find_only_token_in_range, first_non_trivia_token, indentation_at_offset, BackwardsTokenizer, - CommentRanges, SimpleToken, SimpleTokenKind, SimpleTokenizer, + BackwardsTokenizer, CommentRanges, SimpleToken, SimpleTokenKind, SimpleTokenizer, + find_only_token_in_range, first_non_trivia_token, indentation_at_offset, }; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextLen, TextRange}; +use std::cmp::Ordering; use crate::comments::visitor::{CommentPlacement, DecoratedComment}; -use crate::expression::expr_slice::{assign_comment_in_slice, ExprSliceCommentSection}; +use crate::expression::expr_slice::{ExprSliceCommentSection, assign_comment_in_slice}; +use crate::expression::parentheses::is_expression_parenthesized; use crate::other::parameters::{ assign_argument_separator_comment_placement, find_parameter_separators, }; @@ -273,7 +273,7 @@ fn handle_enclosed_comment<'a>( .any(|token| token.kind() == SimpleTokenKind::LBracket) { return CommentPlacement::Default(comment); - }; + } // If there are no additional tokens between the open parenthesis and the comment, then // it should be attached as a dangling comment on the brackets, rather than a leading @@ -355,6 +355,41 @@ fn handle_enclosed_comment<'a>( AnyNodeRef::ExprGenerator(generator) if generator.parenthesized => { handle_bracketed_end_of_line_comment(comment, source) } + AnyNodeRef::StmtReturn(_) => { + handle_trailing_implicit_concatenated_string_comment(comment, comment_ranges, source) + } + AnyNodeRef::StmtAssign(assignment) + if comment.preceding_node().is_some_and(|preceding| { + preceding.ptr_eq(AnyNodeRef::from(&*assignment.value)) + }) => + { + handle_trailing_implicit_concatenated_string_comment(comment, comment_ranges, source) + } + AnyNodeRef::StmtAnnAssign(assignment) + if comment.preceding_node().is_some_and(|preceding| { + assignment + .value + .as_deref() + .is_some_and(|value| preceding.ptr_eq(value.into())) + }) => + { + handle_trailing_implicit_concatenated_string_comment(comment, comment_ranges, source) + } + AnyNodeRef::StmtAugAssign(assignment) + if comment.preceding_node().is_some_and(|preceding| { + preceding.ptr_eq(AnyNodeRef::from(&*assignment.value)) + }) => + { + handle_trailing_implicit_concatenated_string_comment(comment, comment_ranges, source) + } + AnyNodeRef::StmtTypeAlias(assignment) + if comment.preceding_node().is_some_and(|preceding| { + preceding.ptr_eq(AnyNodeRef::from(&*assignment.value)) + }) => + { + handle_trailing_implicit_concatenated_string_comment(comment, comment_ranges, source) + } + _ => CommentPlacement::Default(comment), } } @@ -763,7 +798,7 @@ fn handle_parameter_comment<'a>( parameter: &'a Parameter, source: &str, ) -> CommentPlacement<'a> { - if parameter.annotation.as_deref().is_some() { + if parameter.annotation().is_some() { let colon = first_non_trivia_token(parameter.name.end(), source).expect( "A annotated parameter should have a colon following its name when it is valid syntax.", ); @@ -1356,11 +1391,9 @@ fn handle_attribute_comment<'a>( .take_while(|token| token.kind == SimpleTokenKind::RParen) .last() { - return if comment.start() < right_paren.start() { - CommentPlacement::trailing(attribute.value.as_ref(), comment) - } else { - CommentPlacement::dangling(comment.enclosing_node(), comment) - }; + if comment.start() < right_paren.start() { + return CommentPlacement::trailing(attribute.value.as_ref(), comment); + } } // If the comment precedes the `.`, treat it as trailing _if_ it's on the same line as the @@ -1615,7 +1648,7 @@ fn handle_pattern_match_mapping_comment<'a>( // like `rest` above, isn't a node.) if comment.following_node().is_some() { return CommentPlacement::Default(comment); - }; + } // If there's no rest pattern, no need to do anything special. let Some(rest) = pattern.rest.as_ref() else { @@ -2086,6 +2119,75 @@ fn handle_comprehension_comment<'a>( CommentPlacement::Default(comment) } +/// Handle end-of-line comments for parenthesized implicitly concatenated strings when used in +/// a `FormatStatementLastExpression` context: +/// +/// ```python +/// a = ( +/// "a" +/// "b" +/// "c" # comment +/// ) +/// ``` +/// +/// `# comment` is a trailing comment of the last part and not a trailing comment of the entire f-string. +/// Associating the comment with the last part is important or the assignment formatting might move +/// the comment at the end of the assignment, making it impossible to suppress an error for the last part. +/// +/// On the other hand, `# comment` is a trailing end-of-line f-string comment for: +/// +/// ```python +/// a = ( +/// "a" "b" "c" # comment +/// ) +/// +/// a = ( +/// "a" +/// "b" +/// "c" +/// ) # comment +/// ``` +/// +/// Associating the comment with the f-string is desired in those cases because it allows +/// joining the string literals into a single string literal if it fits on the line. +fn handle_trailing_implicit_concatenated_string_comment<'a>( + comment: DecoratedComment<'a>, + comment_ranges: &CommentRanges, + source: &str, +) -> CommentPlacement<'a> { + if !comment.line_position().is_end_of_line() { + return CommentPlacement::Default(comment); + } + + let Some(string_like) = comment + .preceding_node() + .and_then(|preceding| StringLike::try_from(preceding).ok()) + else { + return CommentPlacement::Default(comment); + }; + + let mut parts = string_like.parts(); + + let (Some(last), Some(second_last)) = (parts.next_back(), parts.next_back()) else { + return CommentPlacement::Default(comment); + }; + + if source.contains_line_break(TextRange::new(second_last.end(), last.start())) + && is_expression_parenthesized(string_like.as_expression_ref(), comment_ranges, source) + { + let range = TextRange::new(last.end(), comment.start()); + + if !SimpleTokenizer::new(source, range) + .skip_trivia() + .any(|token| token.kind() == SimpleTokenKind::RParen) + { + return CommentPlacement::trailing(AnyNodeRef::from(last), comment); + } + } + + CommentPlacement::Default(comment) +} + /// Returns `true` if the parameters are parenthesized (as in a function definition), or `false` if /// not (as in a lambda). fn are_parameters_parenthesized(parameters: &Parameters, contents: &str) -> bool { @@ -2154,7 +2256,9 @@ mod tests { ); assert_eq!( - max_empty_lines("# trailing comment\n\n# own line comment\n\n\n# an other own line comment\n# block"), + max_empty_lines( + "# trailing comment\n\n# own line comment\n\n\n# an other own line comment\n# block" + ), 2 ); diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__debug__tests__debug.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__debug__tests__debug.snap index 897dfa97eec13..ab843732c208b 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__debug__tests__debug.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__debug__tests__debug.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/debug.rs expression: comments.debug(source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__base_test.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__base_test.snap index 1a8dc9fcd7250..9c23082e4dae7 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__base_test.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__base_test.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_comment.snap index 9be65b1a41b2a..d901a21e3630d 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_trailing_end_of_line_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_trailing_end_of_line_comment.snap index e1f0f769fd3ad..9b4dffe8a56e1 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_trailing_end_of_line_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__binary_expression_left_operand_trailing_end_of_line_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__dangling_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__dangling_comment.snap index f1b3403f32e20..295eceb8ff035 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__dangling_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__dangling_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__empty_file.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__empty_file.snap index 7ceb71b7a5ce3..62f859c0f5acc 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__empty_file.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__empty_file.snap @@ -1,5 +1,6 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- {} diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_else_comments.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_else_comments.snap index 99d380cc7089b..73c594fdd40ca 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_else_comments.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_else_comments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_if_else_comments.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_if_else_comments.snap index 1cd1f74ac2ff9..915b4744a494f 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_if_else_comments.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__if_elif_if_else_comments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__leading_most_outer.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__leading_most_outer.snap index 9bef07f421983..d3279f5945e66 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__leading_most_outer.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__leading_most_outer.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__match_cases.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__match_cases.snap index bc93d702ded9e..d9d7466f49be1 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__match_cases.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__match_cases.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__nested_binary_expression.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__nested_binary_expression.snap index 7309048231e32..635c756da2c6f 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__nested_binary_expression.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__nested_binary_expression.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_slash_on_same_line.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_slash_on_same_line.snap index ca9f11a24cdb9..285939e6f02b5 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_slash_on_same_line.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_slash_on_same_line.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_with_defaults.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_with_defaults.snap index a7f9ec4064686..4152fe5992012 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_with_defaults.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__non_positional_arguments_with_defaults.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__only_comments.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__only_comments.snap index 8f5f96bd7224c..95b80b4a41ea1 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__only_comments.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__only_comments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_expression.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_expression.snap index b39a29b9652e0..b7bfd5e439beb 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_expression.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_expression.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_trailing_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_trailing_comment.snap index 73aa8104d9654..928299740a26d 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_trailing_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__parenthesized_trailing_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment.snap index a8a9305375d39..993f6a4b37968 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment_without_following_node.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment_without_following_node.snap index 9e9db25a5ec0b..2c20ff80f0050 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment_without_following_node.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_comment_without_following_node.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_leading_comma_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_leading_comma_comment.snap index a8a9305375d39..993f6a4b37968 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_leading_comma_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__positional_argument_only_leading_comma_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_after_comma.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_after_comma.snap index 88f2be2c3094f..ad6a1e3f1aa5e 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_after_comma.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_after_comma.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_comment_after_single_statement_body.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_comment_after_single_statement_body.snap index 62b0b6652b643..abb80c9f78dc4 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_comment_after_single_statement_body.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_comment_after_single_statement_body.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_function_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_function_comment.snap index 9dd6d289d4f1e..6b9f63136226b 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_function_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_function_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer.snap index bb9a65c48007e..98728d29962b4 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer_nested.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer_nested.snap index 37e4a4cc52b17..120e2a9bb080c 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer_nested.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__trailing_most_outer_nested.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except.snap index f72858e2884c1..8937167e98242 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except_finally_else.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except_finally_else.snap index 004b7a2de2f57..3d20d99e2ac04 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except_finally_else.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__try_except_finally_else.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_else_end_of_line_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_else_end_of_line_comment.snap index 33cd36edc402c..2befb882a3514 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_else_end_of_line_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_else_end_of_line_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_end_of_line_comment.snap b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_end_of_line_comment.snap index 41e845c4b41e3..4a8a2ef3228b5 100644 --- a/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_end_of_line_comment.snap +++ b/crates/ruff_python_formatter/src/comments/snapshots/ruff_python_formatter__comments__tests__while_trailing_end_of_line_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/comments/mod.rs expression: comments.debug(test_case.source_code) +snapshot_kind: text --- { Node { diff --git a/crates/ruff_python_formatter/src/comments/visitor.rs b/crates/ruff_python_formatter/src/comments/visitor.rs index 52bd5d2009784..b9670a3ee829a 100644 --- a/crates/ruff_python_formatter/src/comments/visitor.rs +++ b/crates/ruff_python_formatter/src/comments/visitor.rs @@ -2,7 +2,7 @@ use std::fmt::Debug; use std::iter::Peekable; use ruff_formatter::{SourceCode, SourceCodeSlice}; -use ruff_python_ast::AnyNodeRef; +use ruff_python_ast::{AnyNodeRef, Identifier}; use ruff_python_ast::{Mod, Stmt}; // The interface is designed to only export the members relevant for iterating nodes in // pre-order. @@ -53,7 +53,7 @@ impl<'a, 'builder> CommentsVisitor<'a, 'builder> { pub(super) fn visit(mut self, root: AnyNodeRef<'a>) { if self.enter_node(root).is_traverse() { - root.visit_preorder(&mut self); + root.visit_source_order(&mut self); } self.leave_node(root); @@ -65,7 +65,7 @@ impl<'a, 'builder> CommentsVisitor<'a, 'builder> { fn can_skip(&mut self, node_end: TextSize) -> bool { self.comment_ranges .peek() - .map_or(true, |next_comment| next_comment.start() >= node_end) + .is_none_or(|next_comment| next_comment.start() >= node_end) } } @@ -166,6 +166,10 @@ impl<'ast> SourceOrderVisitor<'ast> for CommentsVisitor<'ast, '_> { } } } + + fn visit_identifier(&mut self, _identifier: &'ast Identifier) { + // TODO: Visit and associate comments with identifiers + } } /// A comment decorated with additional information about its surrounding context in the source document. @@ -359,7 +363,7 @@ pub(super) enum CommentPlacement<'a> { /// Makes the comment a... /// /// * [trailing comment] of the [`preceding_node`] if both the [`following_node`] and [`preceding_node`] are not [None] - /// and the comment and [`preceding_node`] are only separated by a space (there's no token between the comment and [`preceding_node`]). + /// and the comment and [`preceding_node`] are only separated by a space (there's no token between the comment and [`preceding_node`]). /// * [leading comment] of the [`following_node`] if the [`following_node`] is not [None] /// * [trailing comment] of the [`preceding_node`] if the [`preceding_node`] is not [None] /// * [dangling comment] of the [`enclosing_node`]. diff --git a/crates/ruff_python_formatter/src/context.rs b/crates/ruff_python_formatter/src/context.rs index 10d41cb5de95a..946deaf1a6f95 100644 --- a/crates/ruff_python_formatter/src/context.rs +++ b/crates/ruff_python_formatter/src/context.rs @@ -5,9 +5,9 @@ use ruff_formatter::{Buffer, FormatContext, GroupId, IndentWidth, SourceCode}; use ruff_python_ast::str::Quote; use ruff_python_parser::Tokens; +use crate::PyFormatOptions; use crate::comments::Comments; use crate::other::f_string_element::FStringExpressionElementContext; -use crate::PyFormatOptions; pub struct PyFormatContext<'a> { options: PyFormatOptions, @@ -106,7 +106,6 @@ impl<'a> PyFormatContext<'a> { } /// Returns `true` if preview mode is enabled. - #[allow(unused)] pub(crate) const fn is_preview(&self) -> bool { self.options.preview().is_enabled() } @@ -147,6 +146,17 @@ pub(crate) enum FStringState { Outside, } +impl FStringState { + pub(crate) fn can_contain_line_breaks(self) -> Option<bool> { + match self { + FStringState::InsideExpressionElement(context) => { + Some(context.can_contain_line_breaks()) + } + FStringState::Outside => None, + } + } +} + /// The position of a top-level statement in the module. #[derive(Copy, Clone, Debug, Eq, PartialEq, Default)] pub(crate) enum TopLevelStatementPosition { @@ -221,7 +231,7 @@ where } } -impl<'ast, 'buf, B> Deref for WithNodeLevel<'ast, 'buf, B> +impl<'ast, B> Deref for WithNodeLevel<'ast, '_, B> where B: Buffer<Context = PyFormatContext<'ast>>, { @@ -232,7 +242,7 @@ where } } -impl<'ast, 'buf, B> DerefMut for WithNodeLevel<'ast, 'buf, B> +impl<'ast, B> DerefMut for WithNodeLevel<'ast, '_, B> where B: Buffer<Context = PyFormatContext<'ast>>, { diff --git a/crates/ruff_python_formatter/src/db.rs b/crates/ruff_python_formatter/src/db.rs new file mode 100644 index 0000000000000..45d3f5c3cc2d7 --- /dev/null +++ b/crates/ruff_python_formatter/src/db.rs @@ -0,0 +1,9 @@ +use ruff_db::{Db as SourceDb, Upcast, files::File}; + +use crate::PyFormatOptions; + +#[salsa::db] +pub trait Db: SourceDb + Upcast<dyn SourceDb> { + /// Returns the formatting options + fn format_options(&self, file: File) -> PyFormatOptions; +} diff --git a/crates/ruff_python_formatter/src/expression/binary_like.rs b/crates/ruff_python_formatter/src/expression/binary_like.rs index be6f3ec22d212..5d8660845224c 100644 --- a/crates/ruff_python_formatter/src/expression/binary_like.rs +++ b/crates/ruff_python_formatter/src/expression/binary_like.rs @@ -11,14 +11,14 @@ use ruff_python_trivia::CommentRanges; use ruff_python_trivia::{SimpleToken, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; -use crate::comments::{leading_comments, trailing_comments, Comments, SourceComment}; +use crate::comments::{Comments, SourceComment, leading_comments, trailing_comments}; +use crate::expression::OperatorPrecedence; use crate::expression::parentheses::{ - in_parentheses_only_group, in_parentheses_only_if_group_breaks, + Parentheses, in_parentheses_only_group, in_parentheses_only_if_group_breaks, in_parentheses_only_soft_line_break, in_parentheses_only_soft_line_break_or_space, is_expression_parenthesized, write_in_parentheses_only_group_end_tag, - write_in_parentheses_only_group_start_tag, Parentheses, + write_in_parentheses_only_group_start_tag, }; -use crate::expression::OperatorPrecedence; use crate::prelude::*; use crate::string::implicit::FormatImplicitConcatenatedString; @@ -571,7 +571,7 @@ impl<'a> FlatBinaryExpressionSlice<'a> { "Operand slice must contain at least one operand" ); - #[allow(unsafe_code)] + #[expect(unsafe_code)] unsafe { // SAFETY: `BinaryChainSlice` has the same layout as a slice because it uses `repr(transparent)` &*(std::ptr::from_ref::<[OperandOrOperator<'a>]>(slice) @@ -881,7 +881,7 @@ impl Format<PyFormatContext<'_>> for Operand<'_> { fn fmt(&self, f: &mut Formatter<PyFormatContext<'_>>) -> FormatResult<()> { let expression = self.expression(); - return if is_expression_parenthesized( + if is_expression_parenthesized( expression.into(), f.context().comments().ranges(), f.context().source(), @@ -1017,7 +1017,7 @@ impl Format<PyFormatContext<'_>> for Operand<'_> { Ok(()) } else { expression.format().with_options(Parentheses::Never).fmt(f) - }; + } } } diff --git a/crates/ruff_python_formatter/src/expression/expr_attribute.rs b/crates/ruff_python_formatter/src/expression/expr_attribute.rs index fd70c3d2d498f..3d1d6ddb786ed 100644 --- a/crates/ruff_python_formatter/src/expression/expr_attribute.rs +++ b/crates/ruff_python_formatter/src/expression/expr_attribute.rs @@ -1,14 +1,14 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{Expr, ExprAttribute, ExprNumberLiteral, Number}; -use ruff_python_trivia::{find_only_token_in_range, SimpleTokenKind}; +use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer, find_only_token_in_range}; use ruff_text_size::{Ranged, TextRange}; use crate::comments::dangling_comments; +use crate::expression::CallChainLayout; use crate::expression::parentheses::{ - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, Parentheses, + NeedsParentheses, OptionalParentheses, Parentheses, is_expression_parenthesized, }; -use crate::expression::CallChainLayout; use crate::prelude::*; #[derive(Default)] @@ -50,9 +50,6 @@ impl FormatNodeRule<ExprAttribute> for FormatExprAttribute { if parenthesize_value { // Don't propagate the call chain layout. value.format().with_options(Parentheses::Always).fmt(f)?; - - // Format the dot on its own line. - soft_line_break().fmt(f)?; } else { match value.as_ref() { Expr::Attribute(expr) => { @@ -60,11 +57,9 @@ impl FormatNodeRule<ExprAttribute> for FormatExprAttribute { } Expr::Call(expr) => { expr.format().with_options(call_chain_layout).fmt(f)?; - soft_line_break().fmt(f)?; } Expr::Subscript(expr) => { expr.format().with_options(call_chain_layout).fmt(f)?; - soft_line_break().fmt(f)?; } _ => { value.format().with_options(Parentheses::Never).fmt(f)?; @@ -77,19 +72,56 @@ impl FormatNodeRule<ExprAttribute> for FormatExprAttribute { value.format().with_options(Parentheses::Never).fmt(f)?; } + let comments = f.context().comments().clone(); + + // Always add a line break if the value is parenthesized and there's an + // end of line comment on the same line as the closing parenthesis. + // ```python + // ( + // ( + // a + // ) # `end_of_line_comment` + // . + // b + // ) + // ``` + let has_trailing_end_of_line_comment = + SimpleTokenizer::starts_at(value.end(), f.context().source()) + .skip_trivia() + .take_while(|token| token.kind == SimpleTokenKind::RParen) + .last() + .is_some_and(|right_paren| { + let trailing_value_comments = comments.trailing(&**value); + trailing_value_comments.iter().any(|comment| { + comment.line_position().is_end_of_line() + && comment.start() > right_paren.end() + }) + }); + + if has_trailing_end_of_line_comment { + hard_line_break().fmt(f)?; + } + // Allow the `.` on its own line if this is a fluent call chain + // and the value either requires parenthesizing or is a call or subscript expression + // (it's a fluent chain but not the first element). + else if call_chain_layout == CallChainLayout::Fluent { + if parenthesize_value || value.is_call_expr() || value.is_subscript_expr() { + soft_line_break().fmt(f)?; + } + } + // Identify dangling comments before and after the dot: // ```python // ( // ( // a - // ) # `before_dot` + // ) // # `before_dot` // . # `after_dot` // # `after_dot` // b // ) // ``` - let comments = f.context().comments().clone(); let dangling = comments.dangling(item); let (before_dot, after_dot) = if dangling.is_empty() { (dangling, dangling) diff --git a/crates/ruff_python_formatter/src/expression/expr_await.rs b/crates/ruff_python_formatter/src/expression/expr_await.rs index a7073312988c7..3985e87d67c80 100644 --- a/crates/ruff_python_formatter/src/expression/expr_await.rs +++ b/crates/ruff_python_formatter/src/expression/expr_await.rs @@ -4,7 +4,7 @@ use ruff_python_ast::ExprAwait; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::{ - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, Parenthesize, + NeedsParentheses, OptionalParentheses, Parenthesize, is_expression_parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_bin_op.rs b/crates/ruff_python_formatter/src/expression/expr_bin_op.rs index 15b2b328147df..dcd4721860abc 100644 --- a/crates/ruff_python_formatter/src/expression/expr_bin_op.rs +++ b/crates/ruff_python_formatter/src/expression/expr_bin_op.rs @@ -28,7 +28,7 @@ impl NeedsParentheses for ExprBinOp { } else if let Ok(string) = StringLike::try_from(&*self.left) { // Multiline strings are guaranteed to never fit, avoid adding unnecessary parentheses if !string.is_implicit_concatenated() - && string.is_multiline(context.source()) + && string.is_multiline(context) && has_parentheses(&self.right, context).is_some() && !context.comments().has_dangling(self) && !context.comments().has(string) diff --git a/crates/ruff_python_formatter/src/expression/expr_bytes_literal.rs b/crates/ruff_python_formatter/src/expression/expr_bytes_literal.rs index 92d2af2d1f952..4243af72eaa0e 100644 --- a/crates/ruff_python_formatter/src/expression/expr_bytes_literal.rs +++ b/crates/ruff_python_formatter/src/expression/expr_bytes_literal.rs @@ -2,20 +2,18 @@ use ruff_python_ast::ExprBytesLiteral; use ruff_python_ast::{AnyNodeRef, StringLike}; use crate::expression::parentheses::{ - in_parentheses_only_group, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_group, }; use crate::prelude::*; use crate::string::implicit::FormatImplicitConcatenatedStringFlat; -use crate::string::{implicit::FormatImplicitConcatenatedString, StringLikeExtensions}; +use crate::string::{StringLikeExtensions, implicit::FormatImplicitConcatenatedString}; #[derive(Default)] pub struct FormatExprBytesLiteral; impl FormatNodeRule<ExprBytesLiteral> for FormatExprBytesLiteral { fn fmt_fields(&self, item: &ExprBytesLiteral, f: &mut PyFormatter) -> FormatResult<()> { - let ExprBytesLiteral { value, .. } = item; - - if let [bytes_literal] = value.as_slice() { + if let Some(bytes_literal) = item.as_single_part_bytestring() { bytes_literal.format().fmt(f) } else { // Always join byte literals that aren't parenthesized and thus, always on a single line. @@ -40,7 +38,7 @@ impl NeedsParentheses for ExprBytesLiteral { ) -> OptionalParentheses { if self.value.is_implicit_concatenated() { OptionalParentheses::Multiline - } else if StringLike::Bytes(self).is_multiline(context.source()) { + } else if StringLike::Bytes(self).is_multiline(context) { OptionalParentheses::Never } else { OptionalParentheses::BestFit diff --git a/crates/ruff_python_formatter/src/expression/expr_call.rs b/crates/ruff_python_formatter/src/expression/expr_call.rs index e1dc7a5ae61c3..3fc156331f969 100644 --- a/crates/ruff_python_formatter/src/expression/expr_call.rs +++ b/crates/ruff_python_formatter/src/expression/expr_call.rs @@ -3,10 +3,10 @@ use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{Expr, ExprCall}; use crate::comments::dangling_comments; +use crate::expression::CallChainLayout; use crate::expression::parentheses::{ - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, Parentheses, + NeedsParentheses, OptionalParentheses, Parentheses, is_expression_parenthesized, }; -use crate::expression::CallChainLayout; use crate::prelude::*; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_compare.rs b/crates/ruff_python_formatter/src/expression/expr_compare.rs index 13f072cde51ae..0b10ccaa31534 100644 --- a/crates/ruff_python_formatter/src/expression/expr_compare.rs +++ b/crates/ruff_python_formatter/src/expression/expr_compare.rs @@ -29,7 +29,7 @@ impl NeedsParentheses for ExprCompare { } else if let Ok(string) = StringLike::try_from(&*self.left) { // Multiline strings are guaranteed to never fit, avoid adding unnecessary parentheses if !string.is_implicit_concatenated() - && string.is_multiline(context.source()) + && string.is_multiline(context) && !context.comments().has(string) && self.comparators.first().is_some_and(|right| { has_parentheses(right, context).is_some() && !context.comments().has(right) diff --git a/crates/ruff_python_formatter/src/expression/expr_dict.rs b/crates/ruff_python_formatter/src/expression/expr_dict.rs index 4e0e3abb5e548..41f9804a4f4a8 100644 --- a/crates/ruff_python_formatter/src/expression/expr_dict.rs +++ b/crates/ruff_python_formatter/src/expression/expr_dict.rs @@ -2,9 +2,9 @@ use ruff_formatter::{format_args, write}; use ruff_python_ast::{AnyNodeRef, DictItem, Expr, ExprDict}; use ruff_text_size::{Ranged, TextRange}; -use crate::comments::{dangling_comments, leading_comments, SourceComment}; +use crate::comments::{SourceComment, dangling_comments, leading_comments}; use crate::expression::parentheses::{ - empty_parenthesized, parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, empty_parenthesized, parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_dict_comp.rs b/crates/ruff_python_formatter/src/expression/expr_dict_comp.rs index 223a982c6d6a6..793579b1d091d 100644 --- a/crates/ruff_python_formatter/src/expression/expr_dict_comp.rs +++ b/crates/ruff_python_formatter/src/expression/expr_dict_comp.rs @@ -4,7 +4,7 @@ use ruff_python_ast::ExprDictComp; use ruff_text_size::Ranged; use crate::comments::dangling_comments; -use crate::expression::parentheses::{parenthesized, NeedsParentheses, OptionalParentheses}; +use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, parenthesized}; use crate::prelude::*; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_f_string.rs b/crates/ruff_python_formatter/src/expression/expr_f_string.rs index 8976f3801d061..90db025694443 100644 --- a/crates/ruff_python_formatter/src/expression/expr_f_string.rs +++ b/crates/ruff_python_formatter/src/expression/expr_f_string.rs @@ -1,24 +1,22 @@ use ruff_python_ast::{AnyNodeRef, ExprFString, StringLike}; -use ruff_text_size::TextSlice; use crate::expression::parentheses::{ - in_parentheses_only_group, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_group, }; -use crate::other::f_string_part::FormatFStringPart; +use crate::other::f_string::FStringLayout; use crate::prelude::*; -use crate::string::implicit::FormatImplicitConcatenatedStringFlat; -use crate::string::{implicit::FormatImplicitConcatenatedString, Quoting, StringLikeExtensions}; +use crate::string::StringLikeExtensions; +use crate::string::implicit::{ + FormatImplicitConcatenatedString, FormatImplicitConcatenatedStringFlat, +}; #[derive(Default)] pub struct FormatExprFString; impl FormatNodeRule<ExprFString> for FormatExprFString { fn fmt_fields(&self, item: &ExprFString, f: &mut PyFormatter) -> FormatResult<()> { - let ExprFString { value, .. } = item; - - if let [f_string_part] = value.as_slice() { - FormatFStringPart::new(f_string_part, f_string_quoting(item, f.context().source())) - .fmt(f) + if let Some(f_string) = item.as_single_part_fstring() { + f_string.format().fmt(f) } else { // Always join fstrings that aren't parenthesized and thus, are always on a single line. if !f.context().node_level().is_parenthesized() { @@ -40,56 +38,18 @@ impl NeedsParentheses for ExprFString { _parent: AnyNodeRef, context: &PyFormatContext, ) -> OptionalParentheses { - if self.value.is_implicit_concatenated() { - OptionalParentheses::Multiline - } - // TODO(dhruvmanila): Ideally what we want here is a new variant which - // is something like: - // - If the expression fits by just adding the parentheses, then add them and - // avoid breaking the f-string expression. So, - // ``` - // xxxxxxxxx = ( - // f"aaaaaaaaaaaa { xxxxxxx + yyyyyyyy } bbbbbbbbbbbbb" - // ) - // ``` - // - But, if the expression is too long to fit even with parentheses, then - // don't add the parentheses and instead break the expression at `soft_line_break`. - // ``` - // xxxxxxxxx = f"aaaaaaaaaaaa { - // xxxxxxxxx + yyyyyyyyyy - // } bbbbbbbbbbbbb" - // ``` - // This isn't decided yet, refer to the relevant discussion: - // https://github.com/astral-sh/ruff/discussions/9785 - else if StringLike::FString(self).is_multiline(context.source()) { - OptionalParentheses::Never - } else { - OptionalParentheses::BestFit - } - } -} - -pub(crate) fn f_string_quoting(f_string: &ExprFString, source: &str) -> Quoting { - let unprefixed = source - .slice(f_string) - .trim_start_matches(|c| c != '"' && c != '\''); - let triple_quoted = unprefixed.starts_with(r#"""""#) || unprefixed.starts_with(r"'''"); - - if f_string - .value - .elements() - .filter_map(|element| element.as_expression()) - .any(|expression| { - let string_content = source.slice(expression); - if triple_quoted { - string_content.contains(r#"""""#) || string_content.contains("'''") + if let Some(fstring_part) = self.as_single_part_fstring() { + // The f-string is not implicitly concatenated + if StringLike::FString(self).is_multiline(context) + || FStringLayout::from_f_string(fstring_part, context.source()).is_multiline() + { + OptionalParentheses::Never } else { - string_content.contains(['"', '\'']) + OptionalParentheses::BestFit } - }) - { - Quoting::Preserve - } else { - Quoting::CanChange + } else { + // The f-string is implicitly concatenated + OptionalParentheses::Multiline + } } } diff --git a/crates/ruff_python_formatter/src/expression/expr_generator.rs b/crates/ruff_python_formatter/src/expression/expr_generator.rs index 566f81d5defc7..c6c92dfa724f9 100644 --- a/crates/ruff_python_formatter/src/expression/expr_generator.rs +++ b/crates/ruff_python_formatter/src/expression/expr_generator.rs @@ -1,8 +1,8 @@ -use ruff_formatter::{format_args, write, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, format_args, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::ExprGenerator; -use crate::expression::parentheses::{parenthesized, NeedsParentheses, OptionalParentheses}; +use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, parenthesized}; use crate::prelude::*; #[derive(Eq, PartialEq, Debug, Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_if.rs b/crates/ruff_python_formatter/src/expression/expr_if.rs index 9d417531fcd04..15be436c6ac9f 100644 --- a/crates/ruff_python_formatter/src/expression/expr_if.rs +++ b/crates/ruff_python_formatter/src/expression/expr_if.rs @@ -1,11 +1,11 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{Expr, ExprIf}; use crate::comments::leading_comments; use crate::expression::parentheses::{ - in_parentheses_only_group, in_parentheses_only_soft_line_break_or_space, - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_group, + in_parentheses_only_soft_line_break_or_space, is_expression_parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_list.rs b/crates/ruff_python_formatter/src/expression/expr_list.rs index a0c16248fa8fe..23586bf1a9531 100644 --- a/crates/ruff_python_formatter/src/expression/expr_list.rs +++ b/crates/ruff_python_formatter/src/expression/expr_list.rs @@ -4,7 +4,7 @@ use ruff_python_ast::ExprList; use ruff_text_size::Ranged; use crate::expression::parentheses::{ - empty_parenthesized, parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, empty_parenthesized, parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_list_comp.rs b/crates/ruff_python_formatter/src/expression/expr_list_comp.rs index 3ae851aefadad..b896c0a6a3620 100644 --- a/crates/ruff_python_formatter/src/expression/expr_list_comp.rs +++ b/crates/ruff_python_formatter/src/expression/expr_list_comp.rs @@ -1,8 +1,8 @@ -use ruff_formatter::{format_args, write, FormatResult}; +use ruff_formatter::{FormatResult, format_args, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::ExprListComp; -use crate::expression::parentheses::{parenthesized, NeedsParentheses, OptionalParentheses}; +use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, parenthesized}; use crate::prelude::*; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_named.rs b/crates/ruff_python_formatter/src/expression/expr_named.rs index 6815759efb1ff..5a5fa23ca3220 100644 --- a/crates/ruff_python_formatter/src/expression/expr_named.rs +++ b/crates/ruff_python_formatter/src/expression/expr_named.rs @@ -4,7 +4,7 @@ use ruff_python_ast::ExprNamed; use crate::comments::dangling_comments; use crate::expression::parentheses::{ - in_parentheses_only_soft_line_break_or_space, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_soft_line_break_or_space, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_set.rs b/crates/ruff_python_formatter/src/expression/expr_set.rs index b137342e30a3b..d034e0c4fd66a 100644 --- a/crates/ruff_python_formatter/src/expression/expr_set.rs +++ b/crates/ruff_python_formatter/src/expression/expr_set.rs @@ -2,7 +2,7 @@ use ruff_python_ast::AnyNodeRef; use ruff_python_ast::ExprSet; use ruff_text_size::Ranged; -use crate::expression::parentheses::{parenthesized, NeedsParentheses, OptionalParentheses}; +use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, parenthesized}; use crate::prelude::*; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_set_comp.rs b/crates/ruff_python_formatter/src/expression/expr_set_comp.rs index 18f20dbcee9d9..4d37f07928a9a 100644 --- a/crates/ruff_python_formatter/src/expression/expr_set_comp.rs +++ b/crates/ruff_python_formatter/src/expression/expr_set_comp.rs @@ -1,8 +1,8 @@ -use ruff_formatter::{format_args, write, Buffer, FormatResult}; +use ruff_formatter::{Buffer, FormatResult, format_args, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::ExprSetComp; -use crate::expression::parentheses::{parenthesized, NeedsParentheses, OptionalParentheses}; +use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, parenthesized}; use crate::prelude::*; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/expression/expr_slice.rs b/crates/ruff_python_formatter/src/expression/expr_slice.rs index 368fe0228c791..061874642befc 100644 --- a/crates/ruff_python_formatter/src/expression/expr_slice.rs +++ b/crates/ruff_python_formatter/src/expression/expr_slice.rs @@ -1,10 +1,10 @@ -use ruff_formatter::{write, FormatError}; -use ruff_python_ast::{AnyNodeRef, AstNode}; +use ruff_formatter::{FormatError, write}; +use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{Expr, ExprSlice, ExprUnaryOp, UnaryOp}; use ruff_python_trivia::{SimpleToken, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; -use crate::comments::{dangling_comments, SourceComment}; +use crate::comments::{SourceComment, dangling_comments}; use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses}; use crate::prelude::*; @@ -36,7 +36,7 @@ impl FormatNodeRule<ExprSlice> for FormatExprSlice { // to handle newlines and spacing, or the node is None and we insert the corresponding // slice of dangling comments let comments = f.context().comments().clone(); - let slice_dangling_comments = comments.dangling(item.as_any_node_ref()); + let slice_dangling_comments = comments.dangling(item); // Put the dangling comments (where the nodes are missing) into buckets let first_colon_partition_index = slice_dangling_comments.partition_point(|x| x.start() < first_colon.start()); @@ -60,9 +60,9 @@ impl FormatNodeRule<ExprSlice> for FormatExprSlice { // Handle spacing around the colon(s) // https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#slices - let lower_simple = lower.as_ref().map_or(true, |expr| is_simple_expr(expr)); - let upper_simple = upper.as_ref().map_or(true, |expr| is_simple_expr(expr)); - let step_simple = step.as_ref().map_or(true, |expr| is_simple_expr(expr)); + let lower_simple = lower.as_ref().is_none_or(|expr| is_simple_expr(expr)); + let upper_simple = upper.as_ref().is_none_or(|expr| is_simple_expr(expr)); + let step_simple = step.as_ref().is_none_or(|expr| is_simple_expr(expr)); let all_simple = lower_simple && upper_simple && step_simple; // lower diff --git a/crates/ruff_python_formatter/src/expression/expr_string_literal.rs b/crates/ruff_python_formatter/src/expression/expr_string_literal.rs index 9813958de52cf..217aeea20f3bc 100644 --- a/crates/ruff_python_formatter/src/expression/expr_string_literal.rs +++ b/crates/ruff_python_formatter/src/expression/expr_string_literal.rs @@ -1,13 +1,16 @@ -use ruff_formatter::FormatRuleWithOptions; -use ruff_python_ast::{AnyNodeRef, ExprStringLiteral, StringLike}; - +use crate::builders::parenthesize_if_expands; use crate::expression::parentheses::{ - in_parentheses_only_group, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_group, }; use crate::other::string_literal::StringLiteralKind; use crate::prelude::*; -use crate::string::implicit::FormatImplicitConcatenatedStringFlat; -use crate::string::{implicit::FormatImplicitConcatenatedString, StringLikeExtensions}; +use crate::string::implicit::{ + FormatImplicitConcatenatedStringExpanded, FormatImplicitConcatenatedStringFlat, + ImplicitConcatenatedLayout, +}; +use crate::string::{StringLikeExtensions, implicit::FormatImplicitConcatenatedString}; +use ruff_formatter::FormatRuleWithOptions; +use ruff_python_ast::{AnyNodeRef, ExprStringLiteral, StringLike}; #[derive(Default)] pub struct FormatExprStringLiteral { @@ -25,9 +28,7 @@ impl FormatRuleWithOptions<ExprStringLiteral, PyFormatContext<'_>> for FormatExp impl FormatNodeRule<ExprStringLiteral> for FormatExprStringLiteral { fn fmt_fields(&self, item: &ExprStringLiteral, f: &mut PyFormatter) -> FormatResult<()> { - let ExprStringLiteral { value, .. } = item; - - if let [string_literal] = value.as_slice() { + if let Some(string_literal) = item.as_single_part_string() { string_literal.format().with_options(self.kind).fmt(f) } else { // Always join strings that aren't parenthesized and thus, always on a single line. @@ -38,6 +39,23 @@ impl FormatNodeRule<ExprStringLiteral> for FormatExprStringLiteral { format_flat.set_docstring(self.kind.is_docstring()); return format_flat.fmt(f); } + + // ```py + // def test(): + // ( + // r"a" + // "b" + // ) + // ``` + if self.kind.is_docstring() { + return parenthesize_if_expands( + &FormatImplicitConcatenatedStringExpanded::new( + item.into(), + ImplicitConcatenatedLayout::Multipart, + ), + ) + .fmt(f); + } } in_parentheses_only_group(&FormatImplicitConcatenatedString::new(item)).fmt(f) @@ -53,7 +71,7 @@ impl NeedsParentheses for ExprStringLiteral { ) -> OptionalParentheses { if self.value.is_implicit_concatenated() { OptionalParentheses::Multiline - } else if StringLike::String(self).is_multiline(context.source()) { + } else if StringLike::String(self).is_multiline(context) { OptionalParentheses::Never } else { OptionalParentheses::BestFit diff --git a/crates/ruff_python_formatter/src/expression/expr_subscript.rs b/crates/ruff_python_formatter/src/expression/expr_subscript.rs index 481cb1f586a0f..0c058d7326ba4 100644 --- a/crates/ruff_python_formatter/src/expression/expr_subscript.rs +++ b/crates/ruff_python_formatter/src/expression/expr_subscript.rs @@ -1,14 +1,13 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; -use ruff_python_ast::{AnyNodeRef, AstNode}; +use ruff_formatter::{FormatRuleWithOptions, write}; +use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{Expr, ExprSubscript}; +use crate::expression::CallChainLayout; use crate::expression::expr_tuple::TupleParentheses; use crate::expression::parentheses::{ - is_expression_parenthesized, parenthesized, NeedsParentheses, OptionalParentheses, Parentheses, + NeedsParentheses, OptionalParentheses, Parentheses, is_expression_parenthesized, parenthesized, }; -use crate::expression::CallChainLayout; use crate::prelude::*; -use crate::preview::is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled; #[derive(Default)] pub struct FormatExprSubscript { @@ -36,7 +35,7 @@ impl FormatNodeRule<ExprSubscript> for FormatExprSubscript { let call_chain_layout = self.call_chain_layout.apply_in_node(item, f); let comments = f.context().comments().clone(); - let dangling_comments = comments.dangling(item.as_any_node_ref()); + let dangling_comments = comments.dangling(item); debug_assert!( dangling_comments.len() <= 1, "A subscript expression can only have a single dangling comment, the one after the bracket" @@ -108,13 +107,14 @@ impl NeedsParentheses for ExprSubscript { if function.returns.as_deref().is_some_and(|returns| { AnyNodeRef::ptr_eq(returns.into(), self.into()) }) { - if is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled(context) && - function.parameters.is_empty() && !context.comments().has(&*function.parameters) { + if function.parameters.is_empty() + && !context.comments().has(&*function.parameters) + { // Apply the `optional_parentheses` layout when the subscript // is in a return type position of a function without parameters. // This ensures the subscript is parenthesized if it has a very // long name that goes over the line length limit. - return OptionalParentheses::Multiline + return OptionalParentheses::Multiline; } // Don't use the best fitting layout for return type annotation because it results in the diff --git a/crates/ruff_python_formatter/src/expression/expr_tuple.rs b/crates/ruff_python_formatter/src/expression/expr_tuple.rs index 7ca6ac0ccde5f..3372ec219d1a8 100644 --- a/crates/ruff_python_formatter/src/expression/expr_tuple.rs +++ b/crates/ruff_python_formatter/src/expression/expr_tuple.rs @@ -1,11 +1,11 @@ -use ruff_formatter::{format_args, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, format_args}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::ExprTuple; use ruff_text_size::{Ranged, TextRange}; use crate::builders::parenthesize_if_expands; use crate::expression::parentheses::{ - empty_parenthesized, optional_parentheses, parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, empty_parenthesized, optional_parentheses, parenthesized, }; use crate::other::commas::has_trailing_comma; use crate::prelude::*; @@ -133,9 +133,7 @@ impl FormatNodeRule<ExprTuple> for FormatExprTuple { // ``` // In all other cases comments get assigned to a list element match elts.as_slice() { - [] => { - return empty_parenthesized("(", dangling, ")").fmt(f); - } + [] => empty_parenthesized("(", dangling, ")").fmt(f), [single] => match self.parentheses { TupleParentheses::Preserve if !is_parenthesized => { single.format().fmt(f)?; diff --git a/crates/ruff_python_formatter/src/expression/expr_unary_op.rs b/crates/ruff_python_formatter/src/expression/expr_unary_op.rs index 56b2ec198b1fd..e28bfd4a95adc 100644 --- a/crates/ruff_python_formatter/src/expression/expr_unary_op.rs +++ b/crates/ruff_python_formatter/src/expression/expr_unary_op.rs @@ -4,7 +4,7 @@ use ruff_python_ast::UnaryOp; use crate::comments::trailing_comments; use crate::expression::parentheses::{ - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, Parentheses, + NeedsParentheses, OptionalParentheses, Parentheses, is_expression_parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/expression/expr_yield.rs b/crates/ruff_python_formatter/src/expression/expr_yield.rs index 679cbef8965d2..4b335e208ef12 100644 --- a/crates/ruff_python_formatter/src/expression/expr_yield.rs +++ b/crates/ruff_python_formatter/src/expression/expr_yield.rs @@ -5,7 +5,7 @@ use ruff_text_size::{Ranged, TextRange}; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::{ - is_expression_parenthesized, NeedsParentheses, OptionalParentheses, Parenthesize, + NeedsParentheses, OptionalParentheses, Parenthesize, is_expression_parenthesized, }; use crate::prelude::*; @@ -14,7 +14,7 @@ pub(super) enum AnyExpressionYield<'a> { YieldFrom(&'a ExprYieldFrom), } -impl<'a> AnyExpressionYield<'a> { +impl AnyExpressionYield<'_> { const fn is_yield_from(&self) -> bool { matches!(self, AnyExpressionYield::YieldFrom(_)) } diff --git a/crates/ruff_python_formatter/src/expression/mod.rs b/crates/ruff_python_formatter/src/expression/mod.rs index d908ee2ae1ffc..aa5be138135a1 100644 --- a/crates/ruff_python_formatter/src/expression/mod.rs +++ b/crates/ruff_python_formatter/src/expression/mod.rs @@ -2,27 +2,24 @@ use std::cmp::Ordering; use std::slice; use ruff_formatter::{ - write, FormatOwnedWithRule, FormatRefWithRule, FormatRule, FormatRuleWithOptions, + FormatOwnedWithRule, FormatRefWithRule, FormatRule, FormatRuleWithOptions, write, }; -use ruff_python_ast as ast; use ruff_python_ast::parenthesize::parentheses_iterator; -use ruff_python_ast::visitor::source_order::{walk_expr, SourceOrderVisitor}; -use ruff_python_ast::{AnyNodeRef, Expr, ExpressionRef, Operator}; +use ruff_python_ast::visitor::source_order::{SourceOrderVisitor, walk_expr}; +use ruff_python_ast::{self as ast}; +use ruff_python_ast::{AnyNodeRef, Expr, ExprRef, Operator}; use ruff_python_trivia::CommentRanges; use ruff_text_size::Ranged; use crate::builders::parenthesize_if_expands; -use crate::comments::{leading_comments, trailing_comments, LeadingDanglingTrailingComments}; +use crate::comments::{LeadingDanglingTrailingComments, leading_comments, trailing_comments}; use crate::context::{NodeLevel, WithNodeLevel}; use crate::expression::parentheses::{ - is_expression_parenthesized, optional_parentheses, parenthesized, NeedsParentheses, - OptionalParentheses, Parentheses, Parenthesize, + NeedsParentheses, OptionalParentheses, Parentheses, Parenthesize, is_expression_parenthesized, + optional_parentheses, parenthesized, }; use crate::prelude::*; -use crate::preview::{ - is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled, - is_f_string_formatting_enabled, is_hug_parens_with_braces_and_square_brackets_enabled, -}; +use crate::preview::is_hug_parens_with_braces_and_square_brackets_enabled; mod binary_like; pub(crate) mod expr_attribute; @@ -388,19 +385,13 @@ impl Format<PyFormatContext<'_>> for MaybeParenthesizeExpression<'_> { // is parenthesized. Unless, it's the `Parenthesize::IfBreaksParenthesizedNested` layout // where parenthesizing nested `maybe_parenthesized_expression` is explicitly desired. _ if f.context().node_level().is_parenthesized() => { - if !is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled( - f.context(), - ) { - OptionalParentheses::Never - } else if matches!(parenthesize, Parenthesize::IfBreaksParenthesizedNested) { - return parenthesize_if_expands( - &expression.format().with_options(Parentheses::Never), - ) - .with_indent(!is_expression_huggable(expression, f.context())) - .fmt(f); + return if matches!(parenthesize, Parenthesize::IfBreaksParenthesizedNested) { + parenthesize_if_expands(&expression.format().with_options(Parentheses::Never)) + .with_indent(!is_expression_huggable(expression, f.context())) + .fmt(f) } else { - return expression.format().with_options(Parentheses::Never).fmt(f); - } + expression.format().with_options(Parentheses::Never).fmt(f) + }; } needs_parentheses => needs_parentheses, }; @@ -409,13 +400,12 @@ impl Format<PyFormatContext<'_>> for MaybeParenthesizeExpression<'_> { match needs_parentheses { OptionalParentheses::Multiline => match parenthesize { - Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested if !is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled(f.context()) => { - parenthesize_if_expands(&unparenthesized).fmt(f) - } - Parenthesize::IfRequired => unparenthesized.fmt(f), - Parenthesize::Optional | Parenthesize::IfBreaks | Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested => { + Parenthesize::Optional + | Parenthesize::IfBreaks + | Parenthesize::IfBreaksParenthesized + | Parenthesize::IfBreaksParenthesizedNested => { if can_omit_optional_parentheses(expression, f.context()) { optional_parentheses(&unparenthesized).fmt(f) } else { @@ -424,9 +414,6 @@ impl Format<PyFormatContext<'_>> for MaybeParenthesizeExpression<'_> { } }, OptionalParentheses::BestFit => match parenthesize { - Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested if !is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled(f.context()) => - parenthesize_if_expands(&unparenthesized).fmt(f), - Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested => { // Can-omit layout is relevant for `"abcd".call`. We don't want to add unnecessary // parentheses in this case. @@ -454,15 +441,11 @@ impl Format<PyFormatContext<'_>> for MaybeParenthesizeExpression<'_> { } }, OptionalParentheses::Never => match parenthesize { - Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested if !is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled(f.context()) => { - parenthesize_if_expands(&unparenthesized) - .with_indent(!is_expression_huggable(expression, f.context())) - .fmt(f) - } - - Parenthesize::Optional | Parenthesize::IfBreaks | Parenthesize::IfRequired | Parenthesize::IfBreaksParenthesized | Parenthesize::IfBreaksParenthesizedNested => { - unparenthesized.fmt(f) - } + Parenthesize::Optional + | Parenthesize::IfBreaks + | Parenthesize::IfRequired + | Parenthesize::IfBreaksParenthesized + | Parenthesize::IfBreaksParenthesizedNested => unparenthesized.fmt(f), }, OptionalParentheses::Always => { @@ -535,12 +518,11 @@ impl<'ast> IntoFormat<PyFormatContext<'ast>> for Expr { /// /// We prefer parentheses at least in the following cases: /// * The expression contains more than one unparenthesized expression with the same precedence. For example, -/// the expression `a * b * c` contains two multiply operations. We prefer parentheses in that case. -/// `(a * b) * c` or `a * b + c` are okay, because the subexpression is parenthesized, or the expression uses operands with a lower precedence +/// the expression `a * b * c` contains two multiply operations. We prefer parentheses in that case. +/// `(a * b) * c` or `a * b + c` are okay, because the subexpression is parenthesized, or the expression uses operands with a lower precedence /// * The expression contains at least one parenthesized sub expression (optimization to avoid unnecessary work) /// /// This mimics Black's [`_maybe_split_omitting_optional_parens`](https://github.com/psf/black/blob/d1248ca9beaf0ba526d265f4108836d89cf551b7/src/black/linegen.py#L746-L820) -#[allow(clippy::if_same_then_else)] pub(crate) fn can_omit_optional_parentheses(expr: &Expr, context: &PyFormatContext) -> bool { let mut visitor = CanOmitOptionalParenthesesVisitor::new(context); visitor.visit_subexpression(expr); @@ -696,7 +678,7 @@ impl<'input> CanOmitOptionalParenthesesVisitor<'input> { // It's impossible for a file smaller or equal to 4GB to contain more than 2^32 comparisons // because each comparison requires a left operand, and `n` `operands` and right sides. - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] Expr::BoolOp(ast::ExprBoolOp { range: _, op: _, @@ -719,7 +701,7 @@ impl<'input> CanOmitOptionalParenthesesVisitor<'input> { // It's impossible for a file smaller or equal to 4GB to contain more than 2^32 comparisons // because each comparison requires a left operand, and `n` `operands` and right sides. - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] Expr::Compare(ast::ExprCompare { range: _, left: _, @@ -766,32 +748,6 @@ impl<'input> CanOmitOptionalParenthesesVisitor<'input> { return; } - Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) - if value.is_implicit_concatenated() => - { - if !is_f_string_formatting_enabled(self.context) { - self.update_max_precedence(OperatorPrecedence::String); - } - - return; - } - Expr::BytesLiteral(ast::ExprBytesLiteral { value, .. }) - if value.is_implicit_concatenated() => - { - if !is_f_string_formatting_enabled(self.context) { - self.update_max_precedence(OperatorPrecedence::String); - } - - return; - } - Expr::FString(ast::ExprFString { value, .. }) if value.is_implicit_concatenated() => { - if !is_f_string_formatting_enabled(self.context) { - self.update_max_precedence(OperatorPrecedence::String); - } - - return; - } - // Non terminal nodes that don't have a termination token. Expr::Named(_) | Expr::Generator(_) | Expr::Tuple(_) => {} @@ -830,7 +786,7 @@ impl<'input> CanOmitOptionalParenthesesVisitor<'input> { | Expr::IpyEscapeCommand(_) => { return; } - }; + } walk_expr(self, expr); } @@ -924,14 +880,14 @@ pub enum CallChainLayout { impl CallChainLayout { pub(crate) fn from_expression( - mut expr: ExpressionRef, + mut expr: ExprRef, comment_ranges: &CommentRanges, source: &str, ) -> Self { let mut attributes_after_parentheses = 0; loop { match expr { - ExpressionRef::Attribute(ast::ExprAttribute { value, .. }) => { + ExprRef::Attribute(ast::ExprAttribute { value, .. }) => { // ``` // f().g // ^^^ value @@ -946,7 +902,7 @@ impl CallChainLayout { attributes_after_parentheses += 1; } - expr = ExpressionRef::from(value.as_ref()); + expr = ExprRef::from(value.as_ref()); } // ``` // f() @@ -956,9 +912,9 @@ impl CallChainLayout { // ^^^^^^^^^^ expr // ^^^^ value // ``` - ExpressionRef::Call(ast::ExprCall { func: inner, .. }) - | ExpressionRef::Subscript(ast::ExprSubscript { value: inner, .. }) => { - expr = ExpressionRef::from(inner.as_ref()); + ExprRef::Call(ast::ExprCall { func: inner, .. }) + | ExprRef::Subscript(ast::ExprSubscript { value: inner, .. }) => { + expr = ExprRef::from(inner.as_ref()); } _ => { // We to format the following in fluent style: @@ -990,7 +946,7 @@ impl CallChainLayout { /// formatting pub(crate) fn apply_in_node<'a>( self, - item: impl Into<ExpressionRef<'a>>, + item: impl Into<ExprRef<'a>>, f: &mut PyFormatter, ) -> CallChainLayout { match self { @@ -1193,8 +1149,6 @@ enum OperatorPrecedence { BitwiseXor, BitwiseOr, Comparator, - // Implicit string concatenation - String, BooleanOperation, Conditional, } @@ -1288,3 +1242,71 @@ pub(crate) fn is_splittable_expression(expr: &Expr, context: &PyFormatContext) - } } } + +/// Returns the sub-expression to which the left-most character in expression belongs. +/// +/// For example, in the expression `a + b * c`, the left-most subexpression is `a`. But for +/// the expression `{ "a": 1 }`, the left-most subexpression is the dictionary, and not `"a"` because +/// the `{` belongs to the dictionary. +/// +/// Parenthesized expressions are treated as belonging to the enclosing expression. Therefore, the left +/// most expression for `(a + b) * c` is `a + b` and not `a`. +pub(crate) fn left_most<'expr>( + expression: &'expr Expr, + comment_ranges: &CommentRanges, + source: &str, +) -> &'expr Expr { + let mut current = expression; + loop { + let left = match current { + Expr::BinOp(ast::ExprBinOp { left, .. }) + | Expr::If(ast::ExprIf { body: left, .. }) + | Expr::Call(ast::ExprCall { func: left, .. }) + | Expr::Attribute(ast::ExprAttribute { value: left, .. }) + | Expr::Subscript(ast::ExprSubscript { value: left, .. }) => Some(&**left), + + Expr::BoolOp(expr_bool_op) => expr_bool_op.values.first(), + Expr::Compare(compare) => Some(&*compare.left), + + Expr::Generator(generator) if !generator.parenthesized => Some(&*generator.elt), + + Expr::Tuple(tuple) if !tuple.parenthesized => tuple.elts.first(), + Expr::Slice(slice) => slice.lower.as_deref(), + + Expr::List(_) + | Expr::Tuple(_) + | Expr::Name(_) + | Expr::Starred(_) + | Expr::FString(_) + | Expr::StringLiteral(_) + | Expr::BytesLiteral(_) + | Expr::NumberLiteral(_) + | Expr::BooleanLiteral(_) + | Expr::NoneLiteral(_) + | Expr::EllipsisLiteral(_) + | Expr::Yield(_) + | Expr::YieldFrom(_) + | Expr::Await(_) + | Expr::DictComp(_) + | Expr::SetComp(_) + | Expr::ListComp(_) + | Expr::Set(_) + | Expr::Dict(_) + | Expr::UnaryOp(_) + | Expr::Lambda(_) + | Expr::Named(_) + | Expr::IpyEscapeCommand(_) + | Expr::Generator(_) => None, + }; + + let Some(left) = left else { + break current; + }; + + if is_expression_parenthesized(left.into(), comment_ranges, source) { + break current; + } + + current = left; + } +} diff --git a/crates/ruff_python_formatter/src/expression/parentheses.rs b/crates/ruff_python_formatter/src/expression/parentheses.rs index 9b8096dbaece1..a76f8a0aec7c7 100644 --- a/crates/ruff_python_formatter/src/expression/parentheses.rs +++ b/crates/ruff_python_formatter/src/expression/parentheses.rs @@ -1,15 +1,15 @@ use ruff_formatter::prelude::tag::Condition; -use ruff_formatter::{format_args, write, Argument, Arguments}; +use ruff_formatter::{Argument, Arguments, format_args, write}; use ruff_python_ast::AnyNodeRef; -use ruff_python_ast::ExpressionRef; +use ruff_python_ast::ExprRef; use ruff_python_trivia::CommentRanges; use ruff_python_trivia::{ - first_non_trivia_token, BackwardsTokenizer, SimpleToken, SimpleTokenKind, + BackwardsTokenizer, SimpleToken, SimpleTokenKind, first_non_trivia_token, }; use ruff_text_size::Ranged; use crate::comments::{ - dangling_comments, dangling_open_parenthesis_comments, trailing_comments, SourceComment, + SourceComment, dangling_comments, dangling_open_parenthesis_comments, trailing_comments, }; use crate::context::{NodeLevel, WithNodeLevel}; use crate::prelude::*; @@ -93,9 +93,9 @@ pub enum Parentheses { Never, } -/// Returns `true` if the [`ExpressionRef`] is enclosed by parentheses in the source code. +/// Returns `true` if the [`ExprRef`] is enclosed by parentheses in the source code. pub(crate) fn is_expression_parenthesized( - expr: ExpressionRef, + expr: ExprRef, comment_ranges: &CommentRanges, contents: &str, ) -> bool { @@ -255,7 +255,7 @@ impl<'ast> Format<PyFormatContext<'ast>> for FormatOptionalParentheses<'_, 'ast> soft_line_break(), if_group_breaks(&token(")")) ]) - .with_group_id(Some(parens_id))] + .with_id(Some(parens_id))] ) } } @@ -422,9 +422,11 @@ impl Format<PyFormatContext<'_>> for FormatEmptyParenthesized<'_> { let end_of_line_split = self .comments .partition_point(|comment| comment.line_position().is_end_of_line()); - debug_assert!(self.comments[end_of_line_split..] - .iter() - .all(|comment| comment.line_position().is_own_line())); + debug_assert!( + self.comments[end_of_line_split..] + .iter() + .all(|comment| comment.line_position().is_own_line()) + ); group(&format_args![ token(self.left), // end-of-line comments @@ -449,7 +451,7 @@ impl Format<PyFormatContext<'_>> for FormatEmptyParenthesized<'_> { #[cfg(test)] mod tests { - use ruff_python_ast::ExpressionRef; + use ruff_python_ast::ExprRef; use ruff_python_parser::parse_expression; use ruff_python_trivia::CommentRanges; @@ -460,7 +462,7 @@ mod tests { let expression = r#"(b().c("")).d()"#; let parsed = parse_expression(expression).unwrap(); assert!(!is_expression_parenthesized( - ExpressionRef::from(parsed.expr()), + ExprRef::from(parsed.expr()), &CommentRanges::default(), expression )); diff --git a/crates/ruff_python_formatter/src/generated.rs b/crates/ruff_python_formatter/src/generated.rs index 90ea7b00dd51e..9bb79d80accaf 100644 --- a/crates/ruff_python_formatter/src/generated.rs +++ b/crates/ruff_python_formatter/src/generated.rs @@ -2392,6 +2392,114 @@ impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::PatternMatchOr { } } +impl FormatRule<ast::TypeParamTypeVar, PyFormatContext<'_>> + for crate::type_param::type_param_type_var::FormatTypeParamTypeVar +{ + #[inline] + fn fmt(&self, node: &ast::TypeParamTypeVar, f: &mut PyFormatter) -> FormatResult<()> { + FormatNodeRule::<ast::TypeParamTypeVar>::fmt(self, node, f) + } +} +impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVar { + type Format<'a> = FormatRefWithRule< + 'a, + ast::TypeParamTypeVar, + crate::type_param::type_param_type_var::FormatTypeParamTypeVar, + PyFormatContext<'ast>, + >; + fn format(&self) -> Self::Format<'_> { + FormatRefWithRule::new( + self, + crate::type_param::type_param_type_var::FormatTypeParamTypeVar::default(), + ) + } +} +impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVar { + type Format = FormatOwnedWithRule< + ast::TypeParamTypeVar, + crate::type_param::type_param_type_var::FormatTypeParamTypeVar, + PyFormatContext<'ast>, + >; + fn into_format(self) -> Self::Format { + FormatOwnedWithRule::new( + self, + crate::type_param::type_param_type_var::FormatTypeParamTypeVar::default(), + ) + } +} + +impl FormatRule<ast::TypeParamTypeVarTuple, PyFormatContext<'_>> + for crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple +{ + #[inline] + fn fmt(&self, node: &ast::TypeParamTypeVarTuple, f: &mut PyFormatter) -> FormatResult<()> { + FormatNodeRule::<ast::TypeParamTypeVarTuple>::fmt(self, node, f) + } +} +impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVarTuple { + type Format<'a> = FormatRefWithRule< + 'a, + ast::TypeParamTypeVarTuple, + crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple, + PyFormatContext<'ast>, + >; + fn format(&self) -> Self::Format<'_> { + FormatRefWithRule::new( + self, + crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple::default(), + ) + } +} +impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVarTuple { + type Format = FormatOwnedWithRule< + ast::TypeParamTypeVarTuple, + crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple, + PyFormatContext<'ast>, + >; + fn into_format(self) -> Self::Format { + FormatOwnedWithRule::new( + self, + crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple::default(), + ) + } +} + +impl FormatRule<ast::TypeParamParamSpec, PyFormatContext<'_>> + for crate::type_param::type_param_param_spec::FormatTypeParamParamSpec +{ + #[inline] + fn fmt(&self, node: &ast::TypeParamParamSpec, f: &mut PyFormatter) -> FormatResult<()> { + FormatNodeRule::<ast::TypeParamParamSpec>::fmt(self, node, f) + } +} +impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamParamSpec { + type Format<'a> = FormatRefWithRule< + 'a, + ast::TypeParamParamSpec, + crate::type_param::type_param_param_spec::FormatTypeParamParamSpec, + PyFormatContext<'ast>, + >; + fn format(&self) -> Self::Format<'_> { + FormatRefWithRule::new( + self, + crate::type_param::type_param_param_spec::FormatTypeParamParamSpec::default(), + ) + } +} +impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamParamSpec { + type Format = FormatOwnedWithRule< + ast::TypeParamParamSpec, + crate::type_param::type_param_param_spec::FormatTypeParamParamSpec, + PyFormatContext<'ast>, + >; + fn into_format(self) -> Self::Format { + FormatOwnedWithRule::new( + self, + crate::type_param::type_param_param_spec::FormatTypeParamParamSpec::default(), + ) + } +} + impl FormatRule<ast::PatternArguments, PyFormatContext<'_>> for crate::pattern::pattern_arguments::FormatPatternArguments { @@ -2827,111 +2935,31 @@ impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParams { } } -impl FormatRule<ast::TypeParamTypeVar, PyFormatContext<'_>> - for crate::type_param::type_param_type_var::FormatTypeParamTypeVar -{ +impl FormatRule<ast::FString, PyFormatContext<'_>> for crate::other::f_string::FormatFString { #[inline] - fn fmt(&self, node: &ast::TypeParamTypeVar, f: &mut PyFormatter) -> FormatResult<()> { - FormatNodeRule::<ast::TypeParamTypeVar>::fmt(self, node, f) + fn fmt(&self, node: &ast::FString, f: &mut PyFormatter) -> FormatResult<()> { + FormatNodeRule::<ast::FString>::fmt(self, node, f) } } -impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVar { +impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::FString { type Format<'a> = FormatRefWithRule< 'a, - ast::TypeParamTypeVar, - crate::type_param::type_param_type_var::FormatTypeParamTypeVar, + ast::FString, + crate::other::f_string::FormatFString, PyFormatContext<'ast>, >; fn format(&self) -> Self::Format<'_> { - FormatRefWithRule::new( - self, - crate::type_param::type_param_type_var::FormatTypeParamTypeVar::default(), - ) + FormatRefWithRule::new(self, crate::other::f_string::FormatFString::default()) } } -impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVar { +impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::FString { type Format = FormatOwnedWithRule< - ast::TypeParamTypeVar, - crate::type_param::type_param_type_var::FormatTypeParamTypeVar, + ast::FString, + crate::other::f_string::FormatFString, PyFormatContext<'ast>, >; fn into_format(self) -> Self::Format { - FormatOwnedWithRule::new( - self, - crate::type_param::type_param_type_var::FormatTypeParamTypeVar::default(), - ) - } -} - -impl FormatRule<ast::TypeParamTypeVarTuple, PyFormatContext<'_>> - for crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple -{ - #[inline] - fn fmt(&self, node: &ast::TypeParamTypeVarTuple, f: &mut PyFormatter) -> FormatResult<()> { - FormatNodeRule::<ast::TypeParamTypeVarTuple>::fmt(self, node, f) - } -} -impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVarTuple { - type Format<'a> = FormatRefWithRule< - 'a, - ast::TypeParamTypeVarTuple, - crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple, - PyFormatContext<'ast>, - >; - fn format(&self) -> Self::Format<'_> { - FormatRefWithRule::new( - self, - crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple::default(), - ) - } -} -impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamTypeVarTuple { - type Format = FormatOwnedWithRule< - ast::TypeParamTypeVarTuple, - crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple, - PyFormatContext<'ast>, - >; - fn into_format(self) -> Self::Format { - FormatOwnedWithRule::new( - self, - crate::type_param::type_param_type_var_tuple::FormatTypeParamTypeVarTuple::default(), - ) - } -} - -impl FormatRule<ast::TypeParamParamSpec, PyFormatContext<'_>> - for crate::type_param::type_param_param_spec::FormatTypeParamParamSpec -{ - #[inline] - fn fmt(&self, node: &ast::TypeParamParamSpec, f: &mut PyFormatter) -> FormatResult<()> { - FormatNodeRule::<ast::TypeParamParamSpec>::fmt(self, node, f) - } -} -impl<'ast> AsFormat<PyFormatContext<'ast>> for ast::TypeParamParamSpec { - type Format<'a> = FormatRefWithRule< - 'a, - ast::TypeParamParamSpec, - crate::type_param::type_param_param_spec::FormatTypeParamParamSpec, - PyFormatContext<'ast>, - >; - fn format(&self) -> Self::Format<'_> { - FormatRefWithRule::new( - self, - crate::type_param::type_param_param_spec::FormatTypeParamParamSpec::default(), - ) - } -} -impl<'ast> IntoFormat<PyFormatContext<'ast>> for ast::TypeParamParamSpec { - type Format = FormatOwnedWithRule< - ast::TypeParamParamSpec, - crate::type_param::type_param_param_spec::FormatTypeParamParamSpec, - PyFormatContext<'ast>, - >; - fn into_format(self) -> Self::Format { - FormatOwnedWithRule::new( - self, - crate::type_param::type_param_param_spec::FormatTypeParamParamSpec::default(), - ) + FormatOwnedWithRule::new(self, crate::other::f_string::FormatFString::default()) } } diff --git a/crates/ruff_python_formatter/src/lib.rs b/crates/ruff_python_formatter/src/lib.rs index cbe56762f269d..c9c1c35bf8d29 100644 --- a/crates/ruff_python_formatter/src/lib.rs +++ b/crates/ruff_python_formatter/src/lib.rs @@ -1,21 +1,25 @@ +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_db::source::source_text; use thiserror::Error; use tracing::Level; pub use range::format_range; use ruff_formatter::prelude::*; -use ruff_formatter::{format, write, FormatError, Formatted, PrintError, Printed, SourceCode}; -use ruff_python_ast::AstNode; -use ruff_python_ast::Mod; -use ruff_python_parser::{parse, AsMode, ParseError, Parsed}; +use ruff_formatter::{FormatError, Formatted, PrintError, Printed, SourceCode, format, write}; +use ruff_python_ast::{AnyNodeRef, Mod}; +use ruff_python_parser::{ParseError, ParseOptions, Parsed, parse}; use ruff_python_trivia::CommentRanges; +use ruff_text_size::Ranged; use crate::comments::{ - has_skip_comment, leading_comments, trailing_comments, Comments, SourceComment, + Comments, SourceComment, has_skip_comment, leading_comments, trailing_comments, }; pub use crate::context::PyFormatContext; +pub use crate::db::Db; pub use crate::options::{ DocstringCode, DocstringCodeLineWidth, MagicTrailingComma, PreviewMode, PyFormatOptions, - PythonVersion, QuoteStyle, + QuoteStyle, }; use crate::range::is_logical_line; pub use crate::shared_traits::{AsFormat, FormattedIter, FormattedIterExt, IntoFormat}; @@ -25,6 +29,7 @@ pub(crate) mod builders; pub mod cli; mod comments; pub(crate) mod context; +mod db; pub(crate) mod expression; mod generated; pub(crate) mod module; @@ -43,23 +48,23 @@ mod verbatim; /// 'ast is the lifetime of the source code (input), 'buf is the lifetime of the buffer (output) pub(crate) type PyFormatter<'ast, 'buf> = Formatter<'buf, PyFormatContext<'ast>>; -/// Rule for formatting a Python [`AstNode`]. +/// Rule for formatting a Python AST node. pub(crate) trait FormatNodeRule<N> where - N: AstNode, + N: Ranged, + for<'a> AnyNodeRef<'a>: From<&'a N>, { fn fmt(&self, node: &N, f: &mut PyFormatter) -> FormatResult<()> { let comments = f.context().comments().clone(); - let node_comments = comments.leading_dangling_trailing(node.as_any_node_ref()); + let node_ref = AnyNodeRef::from(node); + let node_comments = comments.leading_dangling_trailing(node_ref); if self.is_suppressed(node_comments.trailing, f.context()) { - suppressed_node(node.as_any_node_ref()).fmt(f) + suppressed_node(node_ref).fmt(f) } else { leading_comments(node_comments.leading).fmt(f)?; - let node_ref = node.as_any_node_ref(); - // Emit source map information for nodes that are valid "narrowing" targets // in range formatting. Never emit source map information if they're disabled // for performance reasons. @@ -72,7 +77,13 @@ where self.fmt_fields(node, f)?; - debug_assert!(node_comments.dangling.iter().all(SourceComment::is_formatted), "The node has dangling comments that need to be formatted manually. Add the special dangling comments handling to `fmt_fields`."); + debug_assert!( + node_comments + .dangling + .iter() + .all(SourceComment::is_formatted), + "The node has dangling comments that need to be formatted manually. Add the special dangling comments handling to `fmt_fields`." + ); write!( f, @@ -96,7 +107,7 @@ where } } -#[derive(Error, Debug)] +#[derive(Error, Debug, salsa::Update, PartialEq, Eq)] pub enum FormatModuleError { #[error(transparent)] ParseError(#[from] ParseError), @@ -112,7 +123,7 @@ pub fn format_module_source( options: PyFormatOptions, ) -> Result<Printed, FormatModuleError> { let source_type = options.source_type(); - let parsed = parse(source, source_type.as_mode())?; + let parsed = parse(source, ParseOptions::from(source_type))?; let comment_ranges = CommentRanges::from(parsed.tokens()); let formatted = format_module_ast(&parsed, &comment_ranges, source, options)?; Ok(formatted.print()?) @@ -124,6 +135,19 @@ pub fn format_module_ast<'a>( source: &'a str, options: PyFormatOptions, ) -> FormatResult<Formatted<PyFormatContext<'a>>> { + format_node(parsed, comment_ranges, source, options) +} + +fn format_node<'a, N>( + parsed: &'a Parsed<N>, + comment_ranges: &'a CommentRanges, + source: &'a str, + options: PyFormatOptions, +) -> FormatResult<Formatted<PyFormatContext<'a>>> +where + N: AsFormat<PyFormatContext<'a>>, + &'a N: Into<AnyNodeRef<'a>>, +{ let source_code = SourceCode::new(source); let comments = Comments::from_ast(parsed.syntax(), source_code, comment_ranges); @@ -138,6 +162,28 @@ pub fn format_module_ast<'a>( Ok(formatted) } +pub fn formatted_file(db: &dyn Db, file: File) -> Result<Option<String>, FormatModuleError> { + let options = db.format_options(file); + + let parsed = parsed_module(db.upcast(), file); + + if let Some(first) = parsed.errors().first() { + return Err(FormatModuleError::ParseError(first.clone())); + } + + let comment_ranges = CommentRanges::from(parsed.tokens()); + let source = source_text(db.upcast(), file); + + let formatted = format_node(parsed, &comment_ranges, &source, options)?; + let printed = formatted.print()?; + + if printed.as_code() == &*source { + Ok(None) + } else { + Ok(Some(printed.into_code())) + } +} + /// Public function for generating a printable string of the debug comments. pub fn pretty_comments(module: &Mod, comment_ranges: &CommentRanges, source: &str) -> String { let source_code = SourceCode::new(source); @@ -154,11 +200,11 @@ mod tests { use insta::assert_snapshot; use ruff_python_ast::PySourceType; - use ruff_python_parser::{parse, AsMode}; + use ruff_python_parser::{ParseOptions, parse}; use ruff_python_trivia::CommentRanges; use ruff_text_size::{TextRange, TextSize}; - use crate::{format_module_ast, format_module_source, format_range, PyFormatOptions}; + use crate::{PyFormatOptions, format_module_ast, format_module_source, format_range}; /// Very basic test intentionally kept very similar to the CLI #[test] @@ -199,7 +245,7 @@ def main() -> None: // Parse the AST. let source_path = "code_inline.py"; - let parsed = parse(source, source_type.as_mode()).unwrap(); + let parsed = parse(source, ParseOptions::from(source_type)).unwrap(); let comment_ranges = CommentRanges::from(parsed.tokens()); let options = PyFormatOptions::from_extension(Path::new(source_path)); let formatted = format_module_ast(&parsed, &comment_ranges, source, options).unwrap(); diff --git a/crates/ruff_python_formatter/src/main.rs b/crates/ruff_python_formatter/src/main.rs index 248ee5fa54a7b..09e5ea2ae6740 100644 --- a/crates/ruff_python_formatter/src/main.rs +++ b/crates/ruff_python_formatter/src/main.rs @@ -1,11 +1,11 @@ -use std::io::{stdout, Read, Write}; +use std::io::{Read, Write, stdout}; use std::path::Path; use std::{fs, io}; -use anyhow::{bail, Context, Result}; +use anyhow::{Context, Result, bail}; use clap::Parser as ClapParser; -use ruff_python_formatter::cli::{format_and_debug_print, Cli, Emit}; +use ruff_python_formatter::cli::{Cli, Emit, format_and_debug_print}; /// Read a `String` from `stdin`. pub(crate) fn read_from_stdin() -> Result<String> { @@ -14,7 +14,6 @@ pub(crate) fn read_from_stdin() -> Result<String> { Ok(buffer) } -#[allow(clippy::print_stdout)] fn main() -> Result<()> { let cli: Cli = Cli::parse(); diff --git a/crates/ruff_python_formatter/src/module/mod_module.rs b/crates/ruff_python_formatter/src/module/mod_module.rs index 6eb3a1d5e846f..5b3436c6d1aee 100644 --- a/crates/ruff_python_formatter/src/module/mod_module.rs +++ b/crates/ruff_python_formatter/src/module/mod_module.rs @@ -2,9 +2,9 @@ use ruff_formatter::write; use ruff_python_ast::ModModule; use ruff_python_trivia::lines_after; +use crate::FormatNodeRule; use crate::prelude::*; use crate::statement::suite::SuiteKind; -use crate::FormatNodeRule; #[derive(Default)] pub struct FormatModModule; diff --git a/crates/ruff_python_formatter/src/options.rs b/crates/ruff_python_formatter/src/options.rs index 541bac549f5cd..26916d66ea2ae 100644 --- a/crates/ruff_python_formatter/src/options.rs +++ b/crates/ruff_python_formatter/src/options.rs @@ -5,7 +5,7 @@ use std::str::FromStr; use ruff_formatter::printer::{LineEnding, PrinterOptions, SourceMapGeneration}; use ruff_formatter::{FormatOptions, IndentStyle, IndentWidth, LineWidth}; use ruff_macros::CacheKey; -use ruff_python_ast::PySourceType; +use ruff_python_ast::{self as ast, PySourceType}; /// Resolved options for formatting one individual file. The difference to `FormatterSettings` /// is that `FormatterSettings` stores the settings for multiple files (the entire project, a subdirectory, ..) @@ -21,7 +21,7 @@ pub struct PyFormatOptions { /// The (minimum) Python version used to run the formatted code. This is used /// to determine the supported Python syntax. - target_version: PythonVersion, + target_version: ast::PythonVersion, /// Specifies the indent style: /// * Either a tab @@ -80,7 +80,7 @@ impl Default for PyFormatOptions { fn default() -> Self { Self { source_type: PySourceType::default(), - target_version: PythonVersion::default(), + target_version: ast::PythonVersion::default(), indent_style: default_indent_style(), line_width: default_line_width(), indent_width: default_indent_width(), @@ -108,7 +108,7 @@ impl PyFormatOptions { } } - pub const fn target_version(&self) -> PythonVersion { + pub const fn target_version(&self) -> ast::PythonVersion { self.target_version } @@ -145,7 +145,7 @@ impl PyFormatOptions { } #[must_use] - pub fn with_target_version(mut self, target_version: PythonVersion) -> Self { + pub fn with_target_version(mut self, target_version: ast::PythonVersion) -> Self { self.target_version = target_version; self } @@ -374,12 +374,15 @@ impl fmt::Display for DocstringCode { } #[derive(Copy, Clone, Default, Eq, PartialEq, CacheKey)] -#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] -#[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))] -#[cfg_attr(feature = "serde", serde(untagged))] +#[cfg_attr( + feature = "serde", + derive(serde::Serialize, serde::Deserialize), + serde(untagged, rename_all = "lowercase") +)] #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum DocstringCodeLineWidth { /// Wrap docstring code examples at a fixed line width. + #[cfg_attr(feature = "schemars", schemars(schema_with = "schema::fixed"))] Fixed(LineWidth), /// Respect the line length limit setting for the surrounding Python code. @@ -388,27 +391,45 @@ pub enum DocstringCodeLineWidth { feature = "serde", serde(deserialize_with = "deserialize_docstring_code_line_width_dynamic") )] - #[cfg_attr(feature = "schemars", schemars(with = "DynamicSchema"))] + #[cfg_attr(feature = "schemars", schemars(schema_with = "schema::dynamic"))] Dynamic, } -/// A dummy type that is used to generate a schema for `DocstringCodeLineWidth::Dynamic`. #[cfg(feature = "schemars")] -struct DynamicSchema; - -#[cfg(feature = "schemars")] -impl schemars::JsonSchema for DynamicSchema { - fn schema_name() -> String { - "Dynamic".to_string() - } - - fn json_schema(_: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { - schemars::schema::SchemaObject { - instance_type: Some(schemars::schema::InstanceType::String.into()), +mod schema { + use ruff_formatter::LineWidth; + use schemars::r#gen::SchemaGenerator; + use schemars::schema::{Metadata, Schema, SubschemaValidation}; + + /// A dummy type that is used to generate a schema for `DocstringCodeLineWidth::Dynamic`. + pub(super) fn dynamic(_: &mut SchemaGenerator) -> Schema { + Schema::Object(schemars::schema::SchemaObject { const_value: Some("dynamic".to_string().into()), ..Default::default() - } - .into() + }) + } + + // We use a manual schema for `fixed` even thought it isn't strictly necessary according to the + // JSON schema specification to work around a bug in Even Better TOML with `allOf`. + // https://github.com/astral-sh/ruff/issues/15978#issuecomment-2639547101 + // + // The only difference to the automatically derived schema is that we use `oneOf` instead of + // `allOf`. There's no semantic difference between `allOf` and `oneOf` for single element lists. + pub(super) fn fixed(generator: &mut SchemaGenerator) -> Schema { + let schema = generator.subschema_for::<LineWidth>(); + Schema::Object(schemars::schema::SchemaObject { + metadata: Some(Box::new(Metadata { + description: Some( + "Wrap docstring code examples at a fixed line width.".to_string(), + ), + ..Metadata::default() + })), + subschemas: Some(Box::new(SubschemaValidation { + one_of: Some(vec![schema]), + ..SubschemaValidation::default() + })), + ..Default::default() + }) } } @@ -436,7 +457,7 @@ fn deserialize_docstring_code_line_width_dynamic<'de, D>(d: D) -> Result<(), D:: where D: serde::Deserializer<'de>, { - use serde::{de::Error, Deserialize}; + use serde::{Deserialize, de::Error}; let value = String::deserialize(d)?; match &*value { @@ -447,32 +468,3 @@ where )), } } - -#[derive(CacheKey, Clone, Copy, Debug, PartialOrd, Ord, PartialEq, Eq, Default)] -#[cfg_attr( - feature = "serde", - derive(serde::Serialize, serde::Deserialize), - serde(rename_all = "lowercase") -)] -#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] -pub enum PythonVersion { - Py37, - // Make sure to also change the default for `ruff_linter::settings::types::PythonVersion` - // when changing the default here. - #[default] - Py38, - Py39, - Py310, - Py311, - Py312, - Py313, -} - -impl PythonVersion { - /// Return `true` if the current version supports [PEP 701]. - /// - /// [PEP 701]: https://peps.python.org/pep-0701/ - pub fn supports_pep_701(self) -> bool { - self >= Self::Py312 - } -} diff --git a/crates/ruff_python_formatter/src/other/arguments.rs b/crates/ruff_python_formatter/src/other/arguments.rs index 6e50f1cf01eb1..0ee77b790b0f5 100644 --- a/crates/ruff_python_formatter/src/other/arguments.rs +++ b/crates/ruff_python_formatter/src/other/arguments.rs @@ -1,11 +1,11 @@ -use ruff_formatter::{write, FormatContext}; -use ruff_python_ast::{ArgOrKeyword, Arguments, Expr, StringLike}; +use ruff_formatter::{FormatContext, write}; +use ruff_python_ast::{ArgOrKeyword, Arguments, Expr, StringFlags, StringLike}; use ruff_python_trivia::{PythonWhitespace, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; use crate::expression::expr_generator::GeneratorExpParentheses; use crate::expression::is_expression_huggable; -use crate::expression::parentheses::{empty_parenthesized, parenthesized, Parentheses}; +use crate::expression::parentheses::{Parentheses, empty_parenthesized, parenthesized}; use crate::other::commas; use crate::prelude::*; use crate::string::StringLikeExtensions; @@ -137,6 +137,7 @@ fn is_single_argument_parenthesized(argument: &Expr, call_end: TextSize, source: false } + /// Returns `true` if the arguments can hug directly to the enclosing parentheses in the call, as /// in Black's `hug_parens_with_braces_and_square_brackets` preview style behavior. /// @@ -223,7 +224,13 @@ fn is_huggable_string_argument( arguments: &Arguments, context: &PyFormatContext, ) -> bool { - if string.is_implicit_concatenated() || !string.is_multiline(context.source()) { + if string.is_implicit_concatenated() + || !string.is_multiline(context) + || !string + .parts() + .next() + .is_some_and(|part| part.flags().is_triple_quoted()) + { return false; } diff --git a/crates/ruff_python_formatter/src/other/commas.rs b/crates/ruff_python_formatter/src/other/commas.rs index 50a0fff111130..f96397abcb92f 100644 --- a/crates/ruff_python_formatter/src/other/commas.rs +++ b/crates/ruff_python_formatter/src/other/commas.rs @@ -2,8 +2,8 @@ use ruff_formatter::FormatContext; use ruff_python_trivia::{SimpleToken, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::TextRange; -use crate::prelude::*; use crate::MagicTrailingComma; +use crate::prelude::*; /// Returns `true` if the range ends with a magic trailing comma (and the magic trailing comma /// should be respected). diff --git a/crates/ruff_python_formatter/src/other/comprehension.rs b/crates/ruff_python_formatter/src/other/comprehension.rs index 106cf1957cc6c..75910cdc55341 100644 --- a/crates/ruff_python_formatter/src/other/comprehension.rs +++ b/crates/ruff_python_formatter/src/other/comprehension.rs @@ -1,13 +1,12 @@ -use ruff_formatter::{format_args, write, Buffer, FormatResult}; +use ruff_formatter::{Buffer, FormatResult, format_args, write}; use ruff_python_ast::{Comprehension, Expr}; -use ruff_python_trivia::{find_only_token_in_range, SimpleTokenKind}; +use ruff_python_trivia::{SimpleTokenKind, find_only_token_in_range}; use ruff_text_size::{Ranged, TextRange}; use crate::comments::{leading_comments, trailing_comments}; use crate::expression::expr_tuple::TupleParentheses; use crate::expression::parentheses::is_expression_parenthesized; use crate::prelude::*; -use crate::preview::is_comprehension_leading_expression_comments_same_line_enabled; #[derive(Default)] pub struct FormatComprehension; @@ -36,14 +35,12 @@ impl FormatNodeRule<Comprehension> for FormatComprehension { // ) // ] // ``` - let will_be_parenthesized = - is_comprehension_leading_expression_comments_same_line_enabled(f.context()) - && self.preserve_parentheses - && is_expression_parenthesized( - self.expression.into(), - f.context().comments().ranges(), - f.context().source(), - ); + let will_be_parenthesized = self.preserve_parentheses + && is_expression_parenthesized( + self.expression.into(), + f.context().comments().ranges(), + f.context().source(), + ); if has_leading_comments && !will_be_parenthesized { soft_line_break_or_space().fmt(f) diff --git a/crates/ruff_python_formatter/src/other/except_handler_except_handler.rs b/crates/ruff_python_formatter/src/other/except_handler_except_handler.rs index 11fdf640ad9dd..e638dc4b2a4df 100644 --- a/crates/ruff_python_formatter/src/other/except_handler_except_handler.rs +++ b/crates/ruff_python_formatter/src/other/except_handler_except_handler.rs @@ -1,11 +1,11 @@ -use ruff_formatter::write; use ruff_formatter::FormatRuleWithOptions; +use ruff_formatter::write; use ruff_python_ast::ExceptHandlerExceptHandler; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Copy, Clone, Default)] diff --git a/crates/ruff_python_formatter/src/other/f_string.rs b/crates/ruff_python_formatter/src/other/f_string.rs index 409697dfadf36..c423f39f34b0d 100644 --- a/crates/ruff_python_formatter/src/other/f_string.rs +++ b/crates/ruff_python_formatter/src/other/f_string.rs @@ -4,8 +4,7 @@ use ruff_source_file::LineRanges; use ruff_text_size::Ranged; use crate::prelude::*; -use crate::preview::is_f_string_formatting_enabled; -use crate::string::{Quoting, StringNormalizer, StringQuotes}; +use crate::string::{StringNormalizer, StringQuotes}; use super::f_string_element::FormatFStringElement; @@ -13,66 +12,25 @@ use super::f_string_element::FormatFStringElement; /// /// For example, this would be used to format the f-string part in `"foo" f"bar {x}"` /// or the standalone f-string in `f"foo {x} bar"`. -pub(crate) struct FormatFString<'a> { - value: &'a FString, - /// The quoting of an f-string. This is determined by the parent node - /// (f-string expression) and is required to format an f-string correctly. - quoting: Quoting, -} - -impl<'a> FormatFString<'a> { - pub(crate) fn new(value: &'a FString, quoting: Quoting) -> Self { - Self { value, quoting } - } -} +#[derive(Default)] +pub struct FormatFString; -impl Format<PyFormatContext<'_>> for FormatFString<'_> { - fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { - // If the preview style is enabled, make the decision on what quotes to use locally for each - // f-string instead of globally for the entire f-string expression. - let quoting = if is_f_string_formatting_enabled(f.context()) { - Quoting::CanChange - } else { - self.quoting - }; - - let normalizer = StringNormalizer::from_context(f.context()).with_quoting(quoting); - - // If f-string formatting is disabled (not in preview), then we will - // fall back to the previous behavior of normalizing the f-string. - if !is_f_string_formatting_enabled(f.context()) { - let result = normalizer.normalize(self.value.into()).fmt(f); - let comments = f.context().comments(); - self.value.elements.iter().for_each(|value| { - comments.mark_verbatim_node_comments_formatted(value.into()); - // Above method doesn't mark the trailing comments of the f-string elements - // as formatted, so we need to do it manually. For example, - // - // ```python - // f"""foo { - // x:.3f - // # comment - // }""" - // ``` - for trailing_comment in comments.trailing(value) { - trailing_comment.mark_formatted(); - } - }); - return result; - } +impl FormatNodeRule<FString> for FormatFString { + fn fmt_fields(&self, item: &FString, f: &mut PyFormatter) -> FormatResult<()> { + let normalizer = StringNormalizer::from_context(f.context()); - let string_kind = normalizer.choose_quotes(self.value.into()).flags(); + let string_kind = normalizer.choose_quotes(item.into()).flags(); let context = FStringContext::new( string_kind, - FStringLayout::from_f_string(self.value, f.context().source()), + FStringLayout::from_f_string(item, f.context().source()), ); // Starting prefix and quote let quotes = StringQuotes::from(string_kind); write!(f, [string_kind.prefix(), quotes])?; - for element in &self.value.elements { + for element in &item.elements { FormatFStringElement::new(element, context).fmt(f)?; } @@ -140,6 +98,10 @@ impl FStringLayout { } } + pub(crate) const fn is_flat(self) -> bool { + matches!(self, FStringLayout::Flat) + } + pub(crate) const fn is_multiline(self) -> bool { matches!(self, FStringLayout::Multiline) } diff --git a/crates/ruff_python_formatter/src/other/f_string_element.rs b/crates/ruff_python_formatter/src/other/f_string_element.rs index 7139b72af63dc..8418d5edf079b 100644 --- a/crates/ruff_python_formatter/src/other/f_string_element.rs +++ b/crates/ruff_python_formatter/src/other/f_string_element.rs @@ -1,6 +1,6 @@ use std::borrow::Cow; -use ruff_formatter::{format_args, write, Buffer, RemoveSoftLinesBuffer}; +use ruff_formatter::{Buffer, RemoveSoftLinesBuffer, format_args, write}; use ruff_python_ast::{ AnyStringFlags, ConversionFlag, Expr, FStringElement, FStringExpressionElement, FStringLiteralElement, StringFlags, @@ -9,6 +9,7 @@ use ruff_text_size::{Ranged, TextSlice}; use crate::comments::{dangling_open_parenthesis_comments, trailing_comments}; use crate::context::{FStringState, NodeLevel, WithFStringState, WithNodeLevel}; +use crate::expression::left_most; use crate::prelude::*; use crate::string::normalize_string; use crate::verbatim::verbatim_text; @@ -61,8 +62,7 @@ impl<'a> FormatFStringLiteralElement<'a> { impl Format<PyFormatContext<'_>> for FormatFStringLiteralElement<'_> { fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { let literal_content = f.context().source().slice(self.element); - let normalized = - normalize_string(literal_content, 0, self.fstring_flags, false, false, true); + let normalized = normalize_string(literal_content, 0, self.fstring_flags, false); match &normalized { Cow::Borrowed(_) => source_text_slice(self.element.range()).fmt(f), Cow::Owned(normalized) => text(normalized).fmt(f), @@ -191,32 +191,28 @@ impl Format<PyFormatContext<'_>> for FormatFStringExpressionElement<'_> { let comments = f.context().comments().clone(); let dangling_item_comments = comments.dangling(self.element); - let item = format_with(|f| { - let bracket_spacing = match expression.as_ref() { - // If an expression starts with a `{`, we need to add a space before the - // curly brace to avoid turning it into a literal curly with `{{`. - // - // For example, - // ```python - // f"{ {'x': 1, 'y': 2} }" - // # ^ ^ - // ``` - // - // We need to preserve the space highlighted by `^`. The whitespace - // before the closing curly brace is not strictly necessary, but it's - // added to maintain consistency. - Expr::Dict(_) | Expr::DictComp(_) | Expr::Set(_) | Expr::SetComp(_) => { - Some(format_with(|f| { - if self.context.can_contain_line_breaks() { - soft_line_break_or_space().fmt(f) - } else { - space().fmt(f) - } - })) + // If an expression starts with a `{`, we need to add a space before the + // curly brace to avoid turning it into a literal curly with `{{`. + // + // For example, + // ```python + // f"{ {'x': 1, 'y': 2} }" + // # ^ ^ + // ``` + // + // We need to preserve the space highlighted by `^`. The whitespace + // before the closing curly brace is not strictly necessary, but it's + // added to maintain consistency. + let bracket_spacing = + needs_bracket_spacing(expression, f.context()).then_some(format_with(|f| { + if self.context.can_contain_line_breaks() { + soft_line_break_or_space().fmt(f) + } else { + space().fmt(f) } - _ => None, - }; + })); + let item = format_with(|f: &mut PyFormatter| { // Update the context to be inside the f-string expression element. let f = &mut WithFStringState::new( FStringState::InsideExpressionElement(self.context), @@ -289,3 +285,19 @@ impl Format<PyFormatContext<'_>> for FormatFStringExpressionElement<'_> { } } } + +fn needs_bracket_spacing(expr: &Expr, context: &PyFormatContext) -> bool { + // Ruff parenthesizes single element tuples, that's why we shouldn't insert + // a space around the curly braces for those. + if expr + .as_tuple_expr() + .is_some_and(|tuple| !tuple.parenthesized && tuple.elts.len() == 1) + { + return false; + } + + matches!( + left_most(expr, context.comments().ranges(), context.source()), + Expr::Dict(_) | Expr::DictComp(_) | Expr::Set(_) | Expr::SetComp(_) + ) +} diff --git a/crates/ruff_python_formatter/src/other/f_string_part.rs b/crates/ruff_python_formatter/src/other/f_string_part.rs deleted file mode 100644 index d33148aaccc44..0000000000000 --- a/crates/ruff_python_formatter/src/other/f_string_part.rs +++ /dev/null @@ -1,38 +0,0 @@ -use ruff_python_ast::FStringPart; - -use crate::other::f_string::FormatFString; -use crate::other::string_literal::StringLiteralKind; -use crate::prelude::*; -use crate::string::Quoting; - -/// Formats an f-string part which is either a string literal or an f-string. -/// -/// This delegates the actual formatting to the appropriate formatter. -pub(crate) struct FormatFStringPart<'a> { - part: &'a FStringPart, - /// The quoting to be used for all the f-string parts. This is determined by - /// the parent node (f-string expression) and is required to format all parts - /// correctly. - quoting: Quoting, -} - -impl<'a> FormatFStringPart<'a> { - pub(crate) fn new(part: &'a FStringPart, quoting: Quoting) -> Self { - Self { part, quoting } - } -} - -impl Format<PyFormatContext<'_>> for FormatFStringPart<'_> { - fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { - match self.part { - #[allow(deprecated)] - FStringPart::Literal(string_literal) => string_literal - .format() - .with_options(StringLiteralKind::InImplicitlyConcatenatedFString( - self.quoting, - )) - .fmt(f), - FStringPart::FString(f_string) => FormatFString::new(f_string, self.quoting).fmt(f), - } - } -} diff --git a/crates/ruff_python_formatter/src/other/match_case.rs b/crates/ruff_python_formatter/src/other/match_case.rs index 3fd5fd1fea31e..2c96a1546c55e 100644 --- a/crates/ruff_python_formatter/src/other/match_case.rs +++ b/crates/ruff_python_formatter/src/other/match_case.rs @@ -1,16 +1,11 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; -use ruff_python_ast::AstNode; +use ruff_formatter::{FormatRuleWithOptions, format_args, write}; use ruff_python_ast::MatchCase; -use crate::builders::parenthesize_if_expands; use crate::expression::maybe_parenthesize_expression; -use crate::expression::parentheses::{ - NeedsParentheses, OptionalParentheses, Parentheses, Parenthesize, -}; +use crate::expression::parentheses::Parenthesize; use crate::pattern::maybe_parenthesize_pattern; use crate::prelude::*; -use crate::preview::is_match_case_parentheses_enabled; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Default)] @@ -39,42 +34,12 @@ impl FormatNodeRule<MatchCase> for FormatMatchCase { let comments = f.context().comments().clone(); let dangling_item_comments = comments.dangling(item); - let format_pattern = format_with(|f| { - if is_match_case_parentheses_enabled(f.context()) { - maybe_parenthesize_pattern(pattern, item).fmt(f) - } else { - let has_comments = - comments.has_leading(pattern) || comments.has_trailing_own_line(pattern); - - if has_comments { - pattern.format().with_options(Parentheses::Always).fmt(f) - } else { - match pattern.needs_parentheses(item.as_any_node_ref(), f.context()) { - OptionalParentheses::Multiline => parenthesize_if_expands( - &pattern.format().with_options(Parentheses::Never), - ) - .fmt(f), - OptionalParentheses::Always => { - pattern.format().with_options(Parentheses::Always).fmt(f) - } - OptionalParentheses::Never | OptionalParentheses::BestFit => { - pattern.format().with_options(Parentheses::Never).fmt(f) - } - } - } - } - }); - let format_guard = guard.as_deref().map(|guard| { format_with(|f| { write!(f, [space(), token("if"), space()])?; - if is_match_case_parentheses_enabled(f.context()) { - maybe_parenthesize_expression(guard, item, Parenthesize::IfBreaksParenthesized) - .fmt(f) - } else { - guard.format().fmt(f) - } + maybe_parenthesize_expression(guard, item, Parenthesize::IfBreaksParenthesized) + .fmt(f) }) }); @@ -84,9 +49,12 @@ impl FormatNodeRule<MatchCase> for FormatMatchCase { clause_header( ClauseHeader::MatchCase(item), dangling_item_comments, - &format_with(|f| { - write!(f, [token("case"), space(), format_pattern, format_guard]) - }), + &format_args![ + token("case"), + space(), + maybe_parenthesize_pattern(pattern, item), + format_guard + ], ), clause_body( body, diff --git a/crates/ruff_python_formatter/src/other/mod.rs b/crates/ruff_python_formatter/src/other/mod.rs index 2aace837913c4..b55b1a70f6e59 100644 --- a/crates/ruff_python_formatter/src/other/mod.rs +++ b/crates/ruff_python_formatter/src/other/mod.rs @@ -8,7 +8,6 @@ pub(crate) mod elif_else_clause; pub(crate) mod except_handler_except_handler; pub(crate) mod f_string; pub(crate) mod f_string_element; -pub(crate) mod f_string_part; pub(crate) mod identifier; pub(crate) mod keyword; pub(crate) mod match_case; diff --git a/crates/ruff_python_formatter/src/other/parameter_with_default.rs b/crates/ruff_python_formatter/src/other/parameter_with_default.rs index 74164fb5d9266..3248d7381f850 100644 --- a/crates/ruff_python_formatter/src/other/parameter_with_default.rs +++ b/crates/ruff_python_formatter/src/other/parameter_with_default.rs @@ -38,21 +38,26 @@ impl FormatNodeRule<ParameterWithDefault> for FormatParameterWithDefault { // ``` let needs_line_break_trailing = f.context().comments().has_trailing(parameter); let default_first_comment = f.context().comments().leading(default.as_ref()).first(); - let needs_line_break_leading = default_first_comment.is_some_and(|default_leading_comment| { - let mut tokenizer = SimpleTokenizer::new( - f.context().source(), - TextRange::new(parameter.end(), default_leading_comment.start()), - ) - .skip_trivia() - .skip_while(|token| token.kind == SimpleTokenKind::RParen); - let equals = tokenizer.next(); - debug_assert!(equals.is_some_and(|token| token.kind == SimpleTokenKind::Equals)); - let lparens = tokenizer.next(); - debug_assert!(lparens - .as_ref() - .map_or(true, |token| token.kind == SimpleTokenKind::LParen)); - lparens.is_none() - }); + let needs_line_break_leading = + default_first_comment.is_some_and(|default_leading_comment| { + let mut tokenizer = SimpleTokenizer::new( + f.context().source(), + TextRange::new(parameter.end(), default_leading_comment.start()), + ) + .skip_trivia() + .skip_while(|token| token.kind == SimpleTokenKind::RParen); + let equals = tokenizer.next(); + debug_assert!( + equals.is_some_and(|token| token.kind == SimpleTokenKind::Equals) + ); + let lparens = tokenizer.next(); + debug_assert!( + lparens + .as_ref() + .is_none_or(|token| token.kind == SimpleTokenKind::LParen) + ); + lparens.is_none() + }); let needs_line_break = needs_line_break_trailing || needs_line_break_leading; write!( diff --git a/crates/ruff_python_formatter/src/other/parameters.rs b/crates/ruff_python_formatter/src/other/parameters.rs index 7515ede0a0cc2..c677d7651e96a 100644 --- a/crates/ruff_python_formatter/src/other/parameters.rs +++ b/crates/ruff_python_formatter/src/other/parameters.rs @@ -1,12 +1,11 @@ -use ruff_formatter::{format_args, write, FormatRuleWithOptions}; -use ruff_python_ast::Parameters; -use ruff_python_ast::{AnyNodeRef, AstNode}; +use ruff_formatter::{FormatRuleWithOptions, format_args, write}; +use ruff_python_ast::{AnyNodeRef, Parameters}; use ruff_python_trivia::{CommentLinePosition, SimpleToken, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::comments::{ - dangling_comments, dangling_open_parenthesis_comments, leading_comments, leading_node_comments, - trailing_comments, SourceComment, + SourceComment, dangling_comments, dangling_open_parenthesis_comments, leading_comments, + leading_node_comments, trailing_comments, }; use crate::context::{NodeLevel, WithNodeLevel}; use crate::expression::parentheses::empty_parenthesized; @@ -165,7 +164,7 @@ impl FormatNodeRule<Parameters> for FormatParameters { token("*"), vararg.format() ]); - last_node = Some(vararg.as_any_node_ref()); + last_node = Some(vararg.as_ref().into()); } else if !kwonlyargs.is_empty() { // Given very strange comment placement, comments here may not actually have been // marked as `StarLeading`/`StarTrailing`, but that's fine since we still produce @@ -201,7 +200,7 @@ impl FormatNodeRule<Parameters> for FormatParameters { token("**"), kwarg.format() ]); - last_node = Some(kwarg.as_any_node_ref()); + last_node = Some(kwarg.as_ref().into()); } joiner.finish()?; @@ -671,10 +670,28 @@ fn has_trailing_comma( // The slash lacks its own node if ends_with_pos_only_argument_separator { let comma = tokens.next(); - assert!(matches!(comma, Some(SimpleToken { kind: SimpleTokenKind::Comma, .. })), "The last positional only argument must be separated by a `,` from the positional only parameters separator `/` but found '{comma:?}'."); + assert!( + matches!( + comma, + Some(SimpleToken { + kind: SimpleTokenKind::Comma, + .. + }) + ), + "The last positional only argument must be separated by a `,` from the positional only parameters separator `/` but found '{comma:?}'." + ); let slash = tokens.next(); - assert!(matches!(slash, Some(SimpleToken { kind: SimpleTokenKind::Slash, .. })), "The positional argument separator must be present for a function that has positional only parameters but found '{slash:?}'."); + assert!( + matches!( + slash, + Some(SimpleToken { + kind: SimpleTokenKind::Slash, + .. + }) + ), + "The positional argument separator must be present for a function that has positional only parameters but found '{slash:?}'." + ); } tokens diff --git a/crates/ruff_python_formatter/src/other/string_literal.rs b/crates/ruff_python_formatter/src/other/string_literal.rs index 7aee127d4b06e..0d5510417403a 100644 --- a/crates/ruff_python_formatter/src/other/string_literal.rs +++ b/crates/ruff_python_formatter/src/other/string_literal.rs @@ -1,10 +1,9 @@ use ruff_formatter::FormatRuleWithOptions; use ruff_python_ast::StringLiteral; -use crate::prelude::*; -use crate::preview::is_f_string_implicit_concatenated_string_literal_quotes_enabled; -use crate::string::{docstring, Quoting, StringNormalizer}; use crate::QuoteStyle; +use crate::prelude::*; +use crate::string::{StringNormalizer, docstring}; #[derive(Default)] pub struct FormatStringLiteral { @@ -28,12 +27,6 @@ pub enum StringLiteralKind { String, /// A string literal used as a docstring. Docstring, - /// A string literal that is implicitly concatenated with an f-string. This - /// makes the overall expression an f-string whose quoting detection comes - /// from the parent node (f-string expression). - #[deprecated] - #[allow(private_interfaces)] - InImplicitlyConcatenatedFString(Quoting), } impl StringLiteralKind { @@ -41,26 +34,6 @@ impl StringLiteralKind { pub(crate) const fn is_docstring(self) -> bool { matches!(self, StringLiteralKind::Docstring) } - - /// Returns the quoting to be used for this string literal. - fn quoting(self, context: &PyFormatContext) -> Quoting { - match self { - StringLiteralKind::String | StringLiteralKind::Docstring => Quoting::CanChange, - #[allow(deprecated)] - StringLiteralKind::InImplicitlyConcatenatedFString(quoting) => { - // Allow string literals to pick the "optimal" quote character - // even if any other fstring in the implicit concatenation uses an expression - // containing a quote character. - // TODO: Remove StringLiteralKind::InImplicitlyConcatenatedFString when promoting - // this style to stable and remove the layout from `AnyStringPart::String`. - if is_f_string_implicit_concatenated_string_literal_quotes_enabled(context) { - Quoting::CanChange - } else { - quoting - } - } - } - } } impl FormatNodeRule<StringLiteral> for FormatStringLiteral { @@ -75,7 +48,6 @@ impl FormatNodeRule<StringLiteral> for FormatStringLiteral { }; let normalized = StringNormalizer::from_context(f.context()) - .with_quoting(self.layout.quoting(f.context())) .with_preferred_quote_style(quote_style) .normalize(item.into()); diff --git a/crates/ruff_python_formatter/src/other/with_item.rs b/crates/ruff_python_formatter/src/other/with_item.rs index 8f30ee1081284..6a03b299a48bc 100644 --- a/crates/ruff_python_formatter/src/other/with_item.rs +++ b/crates/ruff_python_formatter/src/other/with_item.rs @@ -1,14 +1,13 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, write}; use ruff_python_ast::WithItem; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::{ - is_expression_parenthesized, parenthesized, Parentheses, Parenthesize, + Parentheses, Parenthesize, is_expression_parenthesized, parenthesized, }; use crate::prelude::*; -use crate::preview::is_with_single_item_pre_39_enabled; -#[derive(Copy, Clone, Debug, Eq, PartialEq, Default)] +#[derive(Copy, Clone, Debug, Eq, PartialEq)] pub enum WithItemLayout { /// A with item that is the `with`s only context manager and its context expression is parenthesized. /// @@ -69,8 +68,7 @@ pub enum WithItemLayout { /// a // ): ... /// ``` - #[default] - ParenthesizedContextManagers, + ParenthesizedContextManagers { single: bool }, } #[derive(Default)] @@ -78,6 +76,12 @@ pub struct FormatWithItem { layout: WithItemLayout, } +impl Default for WithItemLayout { + fn default() -> Self { + WithItemLayout::ParenthesizedContextManagers { single: false } + } +} + impl FormatRuleWithOptions<WithItem, PyFormatContext<'_>> for FormatWithItem { type Options = WithItemLayout; @@ -97,6 +101,10 @@ impl FormatNodeRule<WithItem> for FormatWithItem { let comments = f.context().comments().clone(); let trailing_as_comments = comments.dangling(item); + // WARNING: The `is_parenthesized` returns false-positives + // if the `with` has a single item without a target. + // E.g., it returns `true` for `with (a)` even though the parentheses + // belong to the with statement and not the expression but it can't determine that. let is_parenthesized = is_expression_parenthesized( context_expr.into(), f.context().comments().ranges(), @@ -105,10 +113,13 @@ impl FormatNodeRule<WithItem> for FormatWithItem { match self.layout { // Remove the parentheses of the `with_items` if the with statement adds parentheses - WithItemLayout::ParenthesizedContextManagers => { - if is_parenthesized { - // ...except if the with item is parenthesized, then use this with item as a preferred breaking point - // or when it has comments, then parenthesize it to prevent comments from moving. + WithItemLayout::ParenthesizedContextManagers { single } => { + // ...except if the with item is parenthesized and it's not the only with item or it has a target. + // Then use the context expression as a preferred breaking point. + let prefer_breaking_context_expression = + (optional_vars.is_some() || !single) && is_parenthesized; + + if prefer_breaking_context_expression { maybe_parenthesize_expression( context_expr, item, @@ -136,9 +147,7 @@ impl FormatNodeRule<WithItem> for FormatWithItem { } WithItemLayout::Python38OrOlder { single } => { - let parenthesize = if (single && is_with_single_item_pre_39_enabled(f.context())) - || is_parenthesized - { + let parenthesize = if single || is_parenthesized { Parenthesize::IfBreaks } else { Parenthesize::IfRequired diff --git a/crates/ruff_python_formatter/src/pattern/mod.rs b/crates/ruff_python_formatter/src/pattern/mod.rs index d2ba4801dd26e..fa197378a112e 100644 --- a/crates/ruff_python_formatter/src/pattern/mod.rs +++ b/crates/ruff_python_formatter/src/pattern/mod.rs @@ -3,7 +3,7 @@ use ruff_python_ast::{AnyNodeRef, Expr}; use ruff_python_ast::{MatchCase, Pattern}; use ruff_python_trivia::CommentRanges; use ruff_python_trivia::{ - first_non_trivia_token, BackwardsTokenizer, SimpleToken, SimpleTokenKind, + BackwardsTokenizer, SimpleToken, SimpleTokenKind, first_non_trivia_token, }; use ruff_text_size::Ranged; use std::cmp::Ordering; @@ -11,10 +11,9 @@ use std::cmp::Ordering; use crate::builders::parenthesize_if_expands; use crate::context::{NodeLevel, WithNodeLevel}; use crate::expression::parentheses::{ - optional_parentheses, parenthesized, NeedsParentheses, OptionalParentheses, Parentheses, + NeedsParentheses, OptionalParentheses, Parentheses, optional_parentheses, parenthesized, }; use crate::prelude::*; -use crate::preview::is_join_implicit_concatenated_string_enabled; pub(crate) mod pattern_arguments; pub(crate) mod pattern_keyword; @@ -227,7 +226,7 @@ pub(crate) fn can_pattern_omit_optional_parentheses( pattern: &Pattern, context: &PyFormatContext, ) -> bool { - let mut visitor = CanOmitOptionalParenthesesVisitor::new(context); + let mut visitor = CanOmitOptionalParenthesesVisitor::default(); visitor.visit_pattern(pattern, context); if !visitor.any_parenthesized_expressions { @@ -272,32 +271,16 @@ pub(crate) fn can_pattern_omit_optional_parentheses( } } -#[derive(Debug)] +#[derive(Debug, Default)] struct CanOmitOptionalParenthesesVisitor<'input> { max_precedence: OperatorPrecedence, max_precedence_count: usize, any_parenthesized_expressions: bool, - join_implicit_concatenated_strings: bool, last: Option<&'input Pattern>, first: First<'input>, } impl<'a> CanOmitOptionalParenthesesVisitor<'a> { - fn new(context: &PyFormatContext) -> Self { - Self { - max_precedence: OperatorPrecedence::default(), - max_precedence_count: 0, - any_parenthesized_expressions: false, - // TODO: Derive default for `CanOmitOptionalParenthesesVisitor` when removing the `join_implicit_concatenated_strings` - // preview style. - join_implicit_concatenated_strings: is_join_implicit_concatenated_string_enabled( - context, - ), - last: None, - first: First::default(), - } - } - fn visit_pattern(&mut self, pattern: &'a Pattern, context: &PyFormatContext) { match pattern { Pattern::MatchSequence(_) | Pattern::MatchMapping(_) => { @@ -305,27 +288,11 @@ impl<'a> CanOmitOptionalParenthesesVisitor<'a> { } Pattern::MatchValue(value) => match &*value.value { - Expr::StringLiteral(string) => { - if !self.join_implicit_concatenated_strings { - self.update_max_precedence(OperatorPrecedence::String, string.value.len()); - } - } - Expr::BytesLiteral(bytes) => { - if !self.join_implicit_concatenated_strings { - self.update_max_precedence(OperatorPrecedence::String, bytes.value.len()); - } - } + Expr::StringLiteral(_) | + Expr::BytesLiteral(_) | // F-strings are allowed according to python's grammar but fail with a syntax error at runtime. // That's why we need to support them for formatting. - Expr::FString(string) => { - if !self.join_implicit_concatenated_strings { - self.update_max_precedence( - OperatorPrecedence::String, - string.value.as_slice().len(), - ); - } - } - + Expr::FString(_) | Expr::NumberLiteral(_) | Expr::Attribute(_) | Expr::UnaryOp(_) => { // require no state update other than visit_pattern does. } @@ -397,8 +364,6 @@ enum OperatorPrecedence { None, Additive, Or, - // Implicit string concatenation - String, } #[derive(Copy, Clone, Debug, Default)] diff --git a/crates/ruff_python_formatter/src/pattern/pattern_arguments.rs b/crates/ruff_python_formatter/src/pattern/pattern_arguments.rs index 3bbfa4ceceb57..94d7448226e15 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_arguments.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_arguments.rs @@ -1,10 +1,9 @@ use ruff_formatter::write; -use ruff_python_ast::AstNode; use ruff_python_ast::{Pattern, PatternArguments}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::expression::parentheses::{empty_parenthesized, parenthesized, Parentheses}; +use crate::expression::parentheses::{Parentheses, empty_parenthesized, parenthesized}; use crate::prelude::*; #[derive(Default)] @@ -63,7 +62,7 @@ impl FormatNodeRule<PatternArguments> for FormatPatternArguments { // ) // ``` let comments = f.context().comments().clone(); - let dangling_comments = comments.dangling(item.as_any_node_ref()); + let dangling_comments = comments.dangling(item); write!( f, diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_as.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_as.rs index b4db7662f566d..68958cf02dbd7 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_as.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_as.rs @@ -5,7 +5,6 @@ use ruff_python_ast::PatternMatchAs; use crate::comments::dangling_comments; use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses}; use crate::prelude::*; -use crate::preview::is_match_case_parentheses_enabled; #[derive(Default)] pub struct FormatPatternMatchAs; @@ -55,16 +54,12 @@ impl NeedsParentheses for PatternMatchAs { fn needs_parentheses( &self, _parent: AnyNodeRef, - context: &PyFormatContext, + _context: &PyFormatContext, ) -> OptionalParentheses { - if is_match_case_parentheses_enabled(context) { - if self.name.is_some() { - OptionalParentheses::Multiline - } else { - OptionalParentheses::BestFit - } - } else { + if self.name.is_some() { OptionalParentheses::Multiline + } else { + OptionalParentheses::BestFit } } } diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_mapping.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_mapping.rs index e9943ab72bfcd..9ce8f7911ecd5 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_mapping.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_mapping.rs @@ -5,9 +5,9 @@ use ruff_python_ast::{Expr, Identifier, Pattern}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; -use crate::comments::{leading_comments, trailing_comments, SourceComment}; +use crate::comments::{SourceComment, leading_comments, trailing_comments}; use crate::expression::parentheses::{ - empty_parenthesized, parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, empty_parenthesized, parenthesized, }; use crate::prelude::*; diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_or.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_or.rs index 8364491bce5a0..d9653a81d4289 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_or.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_or.rs @@ -4,11 +4,10 @@ use ruff_python_ast::PatternMatchOr; use crate::comments::leading_comments; use crate::expression::parentheses::{ - in_parentheses_only_group, in_parentheses_only_soft_line_break_or_space, NeedsParentheses, - OptionalParentheses, + NeedsParentheses, OptionalParentheses, in_parentheses_only_group, + in_parentheses_only_soft_line_break_or_space, }; use crate::prelude::*; -use crate::preview::is_match_case_parentheses_enabled; #[derive(Default)] pub struct FormatPatternMatchOr; @@ -43,11 +42,7 @@ impl FormatNodeRule<PatternMatchOr> for FormatPatternMatchOr { Ok(()) }); - if is_match_case_parentheses_enabled(f.context()) { - in_parentheses_only_group(&inner).fmt(f) - } else { - inner.fmt(f) - } + in_parentheses_only_group(&inner).fmt(f) } } diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_sequence.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_sequence.rs index c3f4d0e65bf3c..24f07f050d9e4 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_sequence.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_sequence.rs @@ -1,11 +1,11 @@ -use ruff_formatter::{format_args, Format, FormatResult}; +use ruff_formatter::{Format, FormatResult, format_args}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::PatternMatchSequence; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; use crate::expression::parentheses::{ - empty_parenthesized, optional_parentheses, parenthesized, NeedsParentheses, OptionalParentheses, + NeedsParentheses, OptionalParentheses, empty_parenthesized, optional_parentheses, parenthesized, }; use crate::prelude::*; @@ -25,7 +25,7 @@ impl FormatNodeRule<PatternMatchSequence> for FormatPatternMatchSequence { // If the sequence is empty, format the empty parentheses, along with any dangling // comments. ([], SequenceType::Tuple | SequenceType::TupleNoParens) => { - return empty_parenthesized("(", dangling, ")").fmt(f) + return empty_parenthesized("(", dangling, ")").fmt(f); } ([], SequenceType::List) => return empty_parenthesized("[", dangling, "]").fmt(f), @@ -34,7 +34,7 @@ impl FormatNodeRule<PatternMatchSequence> for FormatPatternMatchSequence { ([elt], SequenceType::Tuple | SequenceType::TupleNoParens) => { return parenthesized("(", &format_args![elt.format(), token(",")], ")") .with_dangling_comments(dangling) - .fmt(f) + .fmt(f); } _ => {} @@ -79,9 +79,26 @@ pub(crate) enum SequenceType { impl SequenceType { pub(crate) fn from_pattern(pattern: &PatternMatchSequence, source: &str) -> SequenceType { - if source[pattern.range()].starts_with('[') { + let before_first_pattern = &source[TextRange::new( + pattern.start(), + pattern + .patterns + .first() + .map(Ranged::start) + .unwrap_or(pattern.end()), + )]; + let after_last_patttern = &source[TextRange::new( + pattern.start(), + pattern + .patterns + .first() + .map(Ranged::end) + .unwrap_or(pattern.end()), + )]; + + if before_first_pattern.starts_with('[') && !after_last_patttern.ends_with(',') { SequenceType::List - } else if source[pattern.range()].starts_with('(') { + } else if before_first_pattern.starts_with('(') { // If the pattern is empty, it must be a parenthesized tuple with no members. (This // branch exists to differentiate between a tuple with and without its own parentheses, // but a tuple without its own parentheses must have at least one member.) diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_singleton.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_singleton.rs index 8e15c3357d286..feb3d98919fbc 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_singleton.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_singleton.rs @@ -3,7 +3,6 @@ use ruff_python_ast::{PatternMatchSingleton, Singleton}; use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses}; use crate::prelude::*; -use crate::preview::is_match_case_parentheses_enabled; #[derive(Default)] pub struct FormatPatternMatchSingleton; @@ -22,12 +21,8 @@ impl NeedsParentheses for PatternMatchSingleton { fn needs_parentheses( &self, _parent: AnyNodeRef, - context: &PyFormatContext, + _context: &PyFormatContext, ) -> OptionalParentheses { - if is_match_case_parentheses_enabled(context) { - OptionalParentheses::BestFit - } else { - OptionalParentheses::Never - } + OptionalParentheses::BestFit } } diff --git a/crates/ruff_python_formatter/src/pattern/pattern_match_value.rs b/crates/ruff_python_formatter/src/pattern/pattern_match_value.rs index 7e23c757958bf..5f8efadd9e960 100644 --- a/crates/ruff_python_formatter/src/pattern/pattern_match_value.rs +++ b/crates/ruff_python_formatter/src/pattern/pattern_match_value.rs @@ -3,7 +3,6 @@ use ruff_python_ast::PatternMatchValue; use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, Parentheses}; use crate::prelude::*; -use crate::preview::is_match_case_parentheses_enabled; #[derive(Default)] pub struct FormatPatternMatchValue; @@ -21,10 +20,6 @@ impl NeedsParentheses for PatternMatchValue { parent: AnyNodeRef, context: &PyFormatContext, ) -> OptionalParentheses { - if is_match_case_parentheses_enabled(context) { - self.value.needs_parentheses(parent, context) - } else { - OptionalParentheses::Never - } + self.value.needs_parentheses(parent, context) } } diff --git a/crates/ruff_python_formatter/src/prelude.rs b/crates/ruff_python_formatter/src/prelude.rs index f3f88f6145a8d..be96d7a44fbff 100644 --- a/crates/ruff_python_formatter/src/prelude.rs +++ b/crates/ruff_python_formatter/src/prelude.rs @@ -1,7 +1,5 @@ -#[allow(unused_imports)] pub(crate) use crate::{ - builders::PyFormatterExtensions, AsFormat, FormatNodeRule, FormattedIterExt as _, IntoFormat, - PyFormatContext, PyFormatter, + AsFormat, FormatNodeRule, FormattedIterExt as _, IntoFormat, PyFormatContext, PyFormatter, + builders::PyFormatterExtensions, }; -#[allow(unused_imports)] pub(crate) use ruff_formatter::prelude::*; diff --git a/crates/ruff_python_formatter/src/preview.rs b/crates/ruff_python_formatter/src/preview.rs index 55d5d60dcd9fb..52e0881f3db8d 100644 --- a/crates/ruff_python_formatter/src/preview.rs +++ b/crates/ruff_python_formatter/src/preview.rs @@ -14,61 +14,9 @@ pub(crate) const fn is_hug_parens_with_braces_and_square_brackets_enabled( context.is_preview() } -/// Returns `true` if the [`f-string formatting`](https://github.com/astral-sh/ruff/issues/7594) preview style is enabled. -/// WARNING: This preview style depends on `is_f_string_implicit_concatenated_string_literal_quotes_enabled`. -/// TODO: Remove `Quoting` when promoting this preview style and convert `FormatStringPart` etc. regular `FormatWithRule` implementations. -/// TODO: Remove `format_f_string` from `normalize_string` when promoting this preview style. -pub(crate) fn is_f_string_formatting_enabled(context: &PyFormatContext) -> bool { - context.is_preview() -} - -/// See [#13539](https://github.com/astral-sh/ruff/pull/13539) -/// Remove `Quoting` when stabalizing this preview style. -pub(crate) fn is_f_string_implicit_concatenated_string_literal_quotes_enabled( - context: &PyFormatContext, -) -> bool { - context.is_preview() -} - -pub(crate) fn is_with_single_item_pre_39_enabled(context: &PyFormatContext) -> bool { - context.is_preview() -} - -/// See [#12282](https://github.com/astral-sh/ruff/pull/12282). -pub(crate) fn is_comprehension_leading_expression_comments_same_line_enabled( +/// Returns `true` if the [`no_chaperone_for_escaped_quote_in_triple_quoted_docstring`](https://github.com/astral-sh/ruff/pull/17216) preview style is enabled. +pub(crate) const fn is_no_chaperone_for_escaped_quote_in_triple_quoted_docstring_enabled( context: &PyFormatContext, ) -> bool { context.is_preview() } - -/// See [#9447](https://github.com/astral-sh/ruff/issues/9447) -pub(crate) fn is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled( - context: &PyFormatContext, -) -> bool { - context.is_preview() -} - -/// See [#6933](https://github.com/astral-sh/ruff/issues/6933). -/// This style also covers the black preview styles `remove_redundant_guard_parens` and `parens_for_long_if_clauses_in_case_block `. -/// WARNING: This preview style depends on `is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled` -/// because it relies on the new semantic of `IfBreaksParenthesized`. -pub(crate) fn is_match_case_parentheses_enabled(context: &PyFormatContext) -> bool { - context.is_preview() -} - -/// This preview style fixes a bug with the docstring's `line-length` calculation when using the `dynamic` mode. -/// The new style now respects the indent **inside** the docstring and reduces the `line-length` accordingly -/// so that the docstring's code block fits into the global line-length setting. -pub(crate) fn is_docstring_code_block_in_docstring_indent_enabled( - context: &PyFormatContext, -) -> bool { - context.is_preview() -} - -/// Returns `true` if implicitly concatenated strings should be joined if they all fit on a single line. -/// See [#9457](https://github.com/astral-sh/ruff/issues/9457) -/// WARNING: This preview style depends on `is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled` -/// because it relies on the new semantic of `IfBreaksParenthesized`. -pub(crate) fn is_join_implicit_concatenated_string_enabled(context: &PyFormatContext) -> bool { - context.is_preview() -} diff --git a/crates/ruff_python_formatter/src/range.rs b/crates/ruff_python_formatter/src/range.rs index c0f5cfa0c3294..2f2f12644ad6b 100644 --- a/crates/ruff_python_formatter/src/range.rs +++ b/crates/ruff_python_formatter/src/range.rs @@ -2,13 +2,13 @@ use tracing::Level; use ruff_formatter::printer::SourceMapGeneration; use ruff_formatter::{ - format, FormatContext, FormatError, FormatOptions, IndentStyle, PrintedRange, SourceCode, + FormatContext, FormatError, FormatOptions, IndentStyle, PrintedRange, SourceCode, format, }; -use ruff_python_ast::visitor::source_order::{walk_body, SourceOrderVisitor, TraversalSignal}; +use ruff_python_ast::visitor::source_order::{SourceOrderVisitor, TraversalSignal, walk_body}; use ruff_python_ast::{AnyNodeRef, Stmt, StmtMatch, StmtTry}; -use ruff_python_parser::{parse, AsMode}; +use ruff_python_parser::{ParseOptions, parse}; use ruff_python_trivia::{ - indentation_at_offset, BackwardsTokenizer, CommentRanges, SimpleToken, SimpleTokenKind, + BackwardsTokenizer, CommentRanges, SimpleToken, SimpleTokenKind, indentation_at_offset, }; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; @@ -17,7 +17,7 @@ use crate::context::{IndentLevel, NodeLevel}; use crate::prelude::*; use crate::statement::suite::DocstringStmt; use crate::verbatim::{ends_suppression, starts_suppression}; -use crate::{format_module_source, FormatModuleError, PyFormatOptions}; +use crate::{FormatModuleError, PyFormatOptions, format_module_source}; /// Formats the given `range` in source rather than the entire file. /// @@ -73,7 +73,7 @@ pub fn format_range( assert_valid_char_boundaries(range, source); - let parsed = parse(source, options.source_type().as_mode())?; + let parsed = parse(source, ParseOptions::from(options.source_type()))?; let source_code = SourceCode::new(source); let comment_ranges = CommentRanges::from(parsed.tokens()); let comments = Comments::from_ast(parsed.syntax(), source_code, &comment_ranges); @@ -154,7 +154,7 @@ fn find_enclosing_node<'ast>( let mut visitor = FindEnclosingNode::new(range, context); if visitor.enter_node(root).is_traverse() { - root.visit_preorder(&mut visitor); + root.visit_source_order(&mut visitor); } visitor.leave_node(root); @@ -314,7 +314,7 @@ fn narrow_range( }; if visitor.enter_node(enclosing_node).is_traverse() { - enclosing_node.visit_preorder(&mut visitor); + enclosing_node.visit_source_order(&mut visitor); } visitor.leave_node(enclosing_node); @@ -546,7 +546,7 @@ impl NarrowRange<'_> { Some(SavedLevel { level: saved_level }) } - #[allow(clippy::needless_pass_by_value)] + #[expect(clippy::needless_pass_by_value)] fn leave_level(&mut self, saved_state: SavedLevel) { self.level = saved_state.level; } diff --git a/crates/ruff_python_formatter/src/shared_traits.rs b/crates/ruff_python_formatter/src/shared_traits.rs index 7ffa5d9484764..6ccd9ac600ae2 100644 --- a/crates/ruff_python_formatter/src/shared_traits.rs +++ b/crates/ruff_python_formatter/src/shared_traits.rs @@ -18,7 +18,10 @@ impl<T, C> AsFormat<C> for &T where T: AsFormat<C>, { - type Format<'a> = T::Format<'a> where Self: 'a; + type Format<'a> + = T::Format<'a> + where + Self: 'a; fn format(&self) -> Self::Format<'_> { AsFormat::format(&**self) diff --git a/crates/ruff_python_formatter/src/snapshots/ruff_python_formatter__tests__string_processing.snap b/crates/ruff_python_formatter/src/snapshots/ruff_python_formatter__tests__string_processing.snap index fca7f8344e669..f3e17efb87baf 100644 --- a/crates/ruff_python_formatter/src/snapshots/ruff_python_formatter__tests__string_processing.snap +++ b/crates/ruff_python_formatter/src/snapshots/ruff_python_formatter__tests__string_processing.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/src/lib.rs expression: "output.print().expect(\"Printing to succeed\").as_code()" +snapshot_kind: text --- "aaaaaaaaaa bbbbbbbbbb cccccccccc dddddddddd eeeeeeeeee ffffffffff gggggggggg h" ( diff --git a/crates/ruff_python_formatter/src/statement/clause.rs b/crates/ruff_python_formatter/src/statement/clause.rs index 6e7e2adf5da2e..39b70254497fd 100644 --- a/crates/ruff_python_formatter/src/statement/clause.rs +++ b/crates/ruff_python_formatter/src/statement/clause.rs @@ -1,4 +1,4 @@ -use ruff_formatter::{write, Argument, Arguments, FormatError}; +use ruff_formatter::{Argument, Arguments, FormatError, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::{ ElifElseClause, ExceptHandlerExceptHandler, MatchCase, StmtClassDef, StmtFor, StmtFunctionDef, @@ -7,8 +7,8 @@ use ruff_python_ast::{ use ruff_python_trivia::{SimpleToken, SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::comments::{leading_alternate_branch_comments, trailing_comments, SourceComment}; -use crate::statement::suite::{contains_only_an_ellipsis, SuiteKind}; +use crate::comments::{SourceComment, leading_alternate_branch_comments, trailing_comments}; +use crate::statement::suite::{SuiteKind, contains_only_an_ellipsis}; use crate::verbatim::write_suppressed_clause_header; use crate::{has_skip_comment, prelude::*}; @@ -36,7 +36,7 @@ pub(crate) enum ClauseHeader<'a> { OrElse(ElseClause<'a>), } -impl<'a> ClauseHeader<'a> { +impl ClauseHeader<'_> { /// The range from the clause keyword up to and including the final colon. pub(crate) fn range(self, source: &str) -> FormatResult<TextRange> { let keyword_range = self.first_keyword_range(source)?; @@ -473,12 +473,22 @@ fn colon_range(after_keyword_or_condition: TextSize, source: &str) -> FormatResu range, }) => Ok(range), Some(token) => { - debug_assert!(false, "Expected the colon marking the end of the case header but found {token:?} instead."); - Err(FormatError::syntax_error("Expected colon marking the end of the case header but found another token instead.")) + debug_assert!( + false, + "Expected the colon marking the end of the case header but found {token:?} instead." + ); + Err(FormatError::syntax_error( + "Expected colon marking the end of the case header but found another token instead.", + )) } None => { - debug_assert!(false, "Expected the colon marking the end of the case header but found the end of the range."); - Err(FormatError::syntax_error("Expected the colon marking the end of the case header but found the end of the range.")) + debug_assert!( + false, + "Expected the colon marking the end of the case header but found the end of the range." + ); + Err(FormatError::syntax_error( + "Expected the colon marking the end of the case header but found the end of the range.", + )) } } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_assert.rs b/crates/ruff_python_formatter/src/statement/stmt_assert.rs index 2e7e99240beba..099ce3c24d391 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_assert.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_assert.rs @@ -3,10 +3,8 @@ use ruff_formatter::write; use ruff_python_ast::StmtAssert; use crate::comments::SourceComment; - use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; -use crate::preview::is_join_implicit_concatenated_string_enabled; use crate::{has_skip_comment, prelude::*}; #[derive(Default)] @@ -30,18 +28,12 @@ impl FormatNodeRule<StmtAssert> for FormatStmtAssert { )?; if let Some(msg) = msg { - let parenthesize = if is_join_implicit_concatenated_string_enabled(f.context()) { - Parenthesize::IfBreaksParenthesized - } else { - Parenthesize::IfBreaks - }; - write!( f, [ token(","), space(), - maybe_parenthesize_expression(msg, item, parenthesize), + maybe_parenthesize_expression(msg, item, Parenthesize::IfBreaksParenthesized), ] )?; } diff --git a/crates/ruff_python_formatter/src/statement/stmt_assign.rs b/crates/ruff_python_formatter/src/statement/stmt_assign.rs index f568d2a9756cb..4aad6a47a2a23 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_assign.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_assign.rs @@ -1,25 +1,28 @@ -use ruff_formatter::{format_args, write, FormatError, RemoveSoftLinesBuffer}; +use ruff_formatter::{FormatError, RemoveSoftLinesBuffer, format_args, write}; use ruff_python_ast::{ - AnyNodeRef, Expr, ExprAttribute, ExprCall, Operator, StmtAssign, StringLike, TypeParams, + AnyNodeRef, Expr, ExprAttribute, ExprCall, FString, Operator, StmtAssign, StringLike, + TypeParams, }; use crate::builders::parenthesize_if_expands; use crate::comments::{ - trailing_comments, Comments, LeadingDanglingTrailingComments, SourceComment, + Comments, LeadingDanglingTrailingComments, SourceComment, trailing_comments, }; use crate::context::{NodeLevel, WithNodeLevel}; use crate::expression::parentheses::{ - is_expression_parenthesized, optional_parentheses, NeedsParentheses, OptionalParentheses, - Parentheses, Parenthesize, + NeedsParentheses, OptionalParentheses, Parentheses, Parenthesize, is_expression_parenthesized, + optional_parentheses, }; use crate::expression::{ can_omit_optional_parentheses, has_own_parentheses, has_parentheses, maybe_parenthesize_expression, }; -use crate::preview::is_join_implicit_concatenated_string_enabled; +use crate::other::f_string::FStringLayout; use crate::statement::trailing_semicolon; +use crate::string::StringLikeExtensions; use crate::string::implicit::{ FormatImplicitConcatenatedStringExpanded, FormatImplicitConcatenatedStringFlat, + ImplicitConcatenatedLayout, }; use crate::{has_skip_comment, prelude::*}; @@ -182,6 +185,7 @@ impl Format<PyFormatContext<'_>> for FormatTargetWithEqualOperator<'_> { /// /// This logic isn't implemented in [`place_comment`] by associating trailing statement comments to the expression because /// doing so breaks the suite empty lines formatting that relies on trailing comments to be stored on the statement. +#[derive(Debug)] pub(super) enum FormatStatementsLastExpression<'a> { /// Prefers to split what's left of `value` before splitting the value. /// @@ -285,11 +289,18 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { match self { FormatStatementsLastExpression::LeftToRight { value, statement } => { let can_inline_comment = should_inline_comments(value, *statement, f.context()); - let format_implicit_flat = StringLike::try_from(*value).ok().and_then(|string| { + + let string_like = StringLike::try_from(*value).ok(); + let format_f_string = + string_like.and_then(|string| format_f_string_assignment(string, f.context())); + let format_implicit_flat = string_like.and_then(|string| { FormatImplicitConcatenatedStringFlat::new(string, f.context()) }); - if !can_inline_comment && format_implicit_flat.is_none() { + if !can_inline_comment + && format_implicit_flat.is_none() + && format_f_string.is_none() + { return maybe_parenthesize_expression( value, *statement, @@ -375,7 +386,13 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { let f = &mut WithNodeLevel::new(NodeLevel::Expression(Some(group_id)), f); - write!(f, [FormatImplicitConcatenatedStringExpanded::new(string)]) + write!( + f, + [FormatImplicitConcatenatedStringExpanded::new( + string, + ImplicitConcatenatedLayout::MaybeFlat + )] + ) }); // Join the implicit concatenated string if it fits on a single line @@ -396,7 +413,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { soft_block_indent(&format_args![flat, inline_comments]), token(")"), ]) - .with_group_id(Some(group_id)) + .with_id(Some(group_id)) .should_expand(true) .fmt(f) }); @@ -416,7 +433,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { token(")"), inline_comments, ]) - .with_group_id(Some(group_id)) + .with_id(Some(group_id)) .should_expand(true) .fmt(f) }); @@ -429,6 +446,79 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { best_fitting![single_line, joined_parenthesized, implicit_expanded] .with_mode(BestFittingMode::AllLines) .fmt(f)?; + } else if let Some(format_f_string) = format_f_string { + inline_comments.mark_formatted(); + + let f_string_flat = format_with(|f| { + let mut buffer = RemoveSoftLinesBuffer::new(&mut *f); + + write!(buffer, [format_f_string.format()]) + }) + .memoized(); + + // F-String containing an expression with a magic trailing comma, a comment, or a + // multiline debug expression should never be joined. Use the default layout. + // ```python + // aaaa = f"aaaa {[ + // 1, 2, + // ]} bbbb" + // ``` + if f_string_flat.inspect(f)?.will_break() { + inline_comments.mark_unformatted(); + + return write!( + f, + [maybe_parenthesize_expression( + value, + *statement, + Parenthesize::IfBreaks, + )] + ); + } + + // Considering the following example: + // ```python + // aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + // expression}moreeeeeeeeeeeeeeeee" + // ``` + + // Flatten the f-string. + // ```python + // aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" + // ``` + let single_line = + format_with(|f| write!(f, [f_string_flat, inline_comments])); + + // Parenthesize the f-string and flatten the f-string. + // ```python + // aaaaaaaaaaaaaaaaaa = ( + // f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" + // ) + // ``` + let joined_parenthesized = format_with(|f| { + group(&format_args![ + token("("), + soft_block_indent(&format_args![f_string_flat, inline_comments]), + token(")"), + ]) + .with_id(Some(group_id)) + .should_expand(true) + .fmt(f) + }); + + // Avoid flattening or parenthesizing the f-string, keep the original + // f-string formatting. + // ```python + // aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + // expression + // }moreeeeeeeeeeeeeeeee" + // ``` + let format_f_string = + format_with(|f| write!(f, [format_f_string.format(), inline_comments])); + + best_fitting![single_line, joined_parenthesized, format_f_string] + .with_mode(BestFittingMode::AllLines) + .fmt(f)?; } else { best_fit_parenthesize(&format_once(|f| { inline_comments.mark_formatted(); @@ -467,7 +557,11 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { statement, } => { let should_inline_comments = should_inline_comments(value, *statement, f.context()); - let format_implicit_flat = StringLike::try_from(*value).ok().and_then(|string| { + + let string_like = StringLike::try_from(*value).ok(); + let format_f_string = + string_like.and_then(|string| format_f_string_assignment(string, f.context())); + let format_implicit_flat = string_like.and_then(|string| { FormatImplicitConcatenatedStringFlat::new(string, f.context()) }); @@ -475,6 +569,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { if !should_inline_comments && !should_non_inlineable_use_best_fit(value, *statement, f.context()) && format_implicit_flat.is_none() + && format_f_string.is_none() { return write!( f, @@ -496,7 +591,10 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { let expression_comments = comments.leading_dangling_trailing(*value); // Don't inline comments for attribute and call expressions for black compatibility - let inline_comments = if should_inline_comments || format_implicit_flat.is_some() { + let inline_comments = if should_inline_comments + || format_implicit_flat.is_some() + || format_f_string.is_some() + { OptionalParenthesesInlinedComments::new( &expression_comments, *statement, @@ -535,7 +633,8 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { // This is mainly a performance optimisation that avoids unnecessary memoization // and using the costly `BestFitting` layout if it is already known that only the last variant // can ever fit because the left breaks. - if format_implicit_flat.is_none() && last_target_breaks { + if format_implicit_flat.is_none() && format_f_string.is_none() && last_target_breaks + { return write!( f, [ @@ -561,6 +660,11 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { } else { format_implicit_flat.fmt(f) } + } else if let Some(format_f_string) = format_f_string.as_ref() { + // Similar to above, remove any soft line breaks emitted by the f-string + // formatting. + let mut buffer = RemoveSoftLinesBuffer::new(&mut *f); + write!(buffer, [format_f_string.format()]) } else { value.format().with_options(Parentheses::Never).fmt(f) } @@ -593,20 +697,22 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { // ) // ``` let flat_target_parenthesize_value = format_with(|f| { - write!(f, [last_target, space(), operator, space(), token("("),])?; - - if is_join_implicit_concatenated_string_enabled(f.context()) { - group(&soft_block_indent(&format_args![ - format_value, - inline_comments - ])) - .should_expand(true) - .fmt(f)?; - } else { - block_indent(&format_args![format_value, inline_comments]).fmt(f)?; - } - - token(")").fmt(f) + write!( + f, + [ + last_target, + space(), + operator, + space(), + token("("), + group(&soft_block_indent(&format_args![ + format_value, + inline_comments + ])) + .should_expand(true), + token(")") + ] + ) }); // Fall back to parenthesizing (or splitting) the last target part if we can't make the value @@ -618,15 +724,16 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { // ] = c // ``` let split_target_flat_value = format_with(|f| { - if is_join_implicit_concatenated_string_enabled(f.context()) { - group(&last_target).should_expand(true).fmt(f)?; - } else { - last_target.fmt(f)?; - } - write!( f, - [space(), operator, space(), format_value, inline_comments] + [ + group(&last_target).should_expand(true), + space(), + operator, + space(), + format_value, + inline_comments + ] ) }); @@ -686,6 +793,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { FormatImplicitConcatenatedStringExpanded::new( StringLike::try_from(*value).unwrap(), + ImplicitConcatenatedLayout::MaybeFlat, ) .fmt(f) }) @@ -709,7 +817,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { space(), token("("), group(&soft_block_indent(&format_expanded)) - .with_group_id(Some(group_id)) + .with_id(Some(group_id)) .should_expand(true), token(")"), inline_comments @@ -767,7 +875,7 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { space(), token("("), group(&soft_block_indent(&format_expanded)) - .with_group_id(Some(group_id)) + .with_id(Some(group_id)) .should_expand(true), token(")"), inline_comments @@ -797,6 +905,133 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { .with_mode(BestFittingMode::AllLines) .fmt(f) } + } else if let Some(format_f_string) = &format_f_string { + // F-String containing an expression with a magic trailing comma, a comment, or a + // multiline debug expression should never be joined. Use the default layout. + // + // ```python + // aaaa, bbbb = f"aaaa {[ + // 1, 2, + // ]} bbbb" + // ``` + if format_value.inspect(f)?.will_break() { + inline_comments.mark_unformatted(); + + return write!( + f, + [ + before_operator, + space(), + operator, + space(), + maybe_parenthesize_expression( + value, + *statement, + Parenthesize::IfBreaks + ) + ] + ); + } + + let format_f_string = + format_with(|f| write!(f, [format_f_string.format(), inline_comments])) + .memoized(); + + // Considering the following initial source: + // + // ```python + // aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + // f"aaaaaaaaaaaaaaaaaaa { + // aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" + // ) + // ``` + // + // Keep the target flat, and use the regular f-string formatting. + // + // ```python + // aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa { + // aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc + // } ddddddddddddddddddd" + // ``` + let flat_target_regular_f_string = format_with(|f| { + write!( + f, + [last_target, space(), operator, space(), format_f_string] + ) + }); + + // Expand the parent and parenthesize the flattened f-string. + // + // ```python + // aaaaaaaaaaaa[ + // "bbbbbbbbbbbbbbbb" + // ] = ( + // f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" + // ) + // ``` + let split_target_value_parenthesized_flat = format_with(|f| { + write!( + f, + [ + group(&last_target).should_expand(true), + space(), + operator, + space(), + token("("), + group(&soft_block_indent(&format_args![ + format_value, + inline_comments + ])) + .should_expand(true), + token(")") + ] + ) + }); + + // Expand the parent, and use the regular f-string formatting. + // + // ```python + // aaaaaaaaaaaa[ + // "bbbbbbbbbbbbbbbb" + // ] = f"aaaaaaaaaaaaaaaaaaa { + // aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc + // } ddddddddddddddddddd" + // ``` + let split_target_regular_f_string = format_with(|f| { + write!( + f, + [ + group(&last_target).should_expand(true), + space(), + operator, + space(), + format_f_string, + ] + ) + }); + + // This is only a perf optimisation. No point in trying all the "flat-target" + // variants if we know that the last target must break. + if last_target_breaks { + best_fitting![ + split_target_flat_value, + split_target_value_parenthesized_flat, + split_target_regular_f_string, + ] + .with_mode(BestFittingMode::AllLines) + .fmt(f) + } else { + best_fitting![ + single_line, + flat_target_parenthesize_value, + flat_target_regular_f_string, + split_target_flat_value, + split_target_value_parenthesized_flat, + split_target_regular_f_string, + ] + .with_mode(BestFittingMode::AllLines) + .fmt(f) + } } else { best_fitting![ single_line, @@ -810,6 +1045,86 @@ impl Format<PyFormatContext<'_>> for FormatStatementsLastExpression<'_> { } } +/// Formats an f-string that is at the value position of an assignment statement. +/// +/// This is just a wrapper around [`FormatFString`] while considering a special case when the +/// f-string is at an assignment statement's value position. +/// +/// This is necessary to prevent an instability where an f-string contains a multiline expression +/// and the f-string fits on the line, but only when it's surrounded by parentheses. +/// +/// ```python +/// aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +/// expression}moreeeeeeeeeeeeeeeee" +/// ``` +/// +/// Without the special handling, this would get formatted to: +/// ```python +/// aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +/// expression +/// }moreeeeeeeeeeeeeeeee" +/// ``` +/// +/// However, if the parentheses already existed in the source like: +/// ```python +/// aaaaaaaaaaaaaaaaaa = ( +/// f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" +/// ) +/// ``` +/// +/// Then, it would remain unformatted because it fits on the line. This means that even in the +/// first example, the f-string should be formatted by surrounding it with parentheses. +/// +/// One might ask why not just use the `BestFit` layout in this case. Consider the following +/// example in which the f-string doesn't fit on the line even when surrounded by parentheses: +/// ```python +/// xxxxxxx = f"{ +/// {'aaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} +/// }" +/// ``` +/// +/// The `BestFit` layout will format this as: +/// ```python +/// xxxxxxx = ( +/// f"{ +/// { +/// 'aaaaaaaaaaaaaaaaaaaaaaaaa', +/// 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', +/// 'cccccccccccccccccccccccccc', +/// } +/// }" +/// ) +/// ``` +/// +/// The reason for this is because (a) f-string already has a multiline expression thus it tries to +/// break the expression and (b) the `BestFit` layout doesn't considers the layout where the +/// multiline f-string isn't surrounded by parentheses. +fn format_f_string_assignment<'a>( + string: StringLike<'a>, + context: &PyFormatContext, +) -> Option<&'a FString> { + let StringLike::FString(expr) = string else { + return None; + }; + + let f_string = expr.as_single_part_fstring()?; + + // If the f-string is flat, there are no breakpoints from which it can be made multiline. + // This is the case when the f-string has no expressions or if it does then the expressions + // are flat (no newlines). + if FStringLayout::from_f_string(f_string, context.source()).is_flat() { + return None; + } + + // This checks whether the f-string is multi-line and it can *never* be flattened. Thus, + // it's useless to try the flattened layout. + if string.is_multiline(context) { + return None; + } + + Some(f_string) +} + #[derive(Debug, Default)] struct OptionalParenthesesInlinedComments<'a> { expression: &'a [SourceComment], @@ -838,7 +1153,10 @@ impl<'a> OptionalParenthesesInlinedComments<'a> { let (expression_inline_comments, trailing_own_line_comments) = expression_comments.trailing.split_at(after_end_of_line); - debug_assert!(trailing_own_line_comments.is_empty(), "The method should have returned early if the expression has trailing own line comments"); + debug_assert!( + trailing_own_line_comments.is_empty(), + "The method should have returned early if the expression has trailing own line comments" + ); Some(OptionalParenthesesInlinedComments { expression: expression_inline_comments, diff --git a/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs b/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs index 4a8a3b382d85c..e69045d4e1c8b 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs @@ -4,12 +4,12 @@ use ruff_python_ast::StmtAugAssign; use crate::comments::SourceComment; use crate::expression::parentheses::is_expression_parenthesized; use crate::statement::stmt_assign::{ - has_target_own_parentheses, AnyAssignmentOperator, AnyBeforeOperator, - FormatStatementsLastExpression, + AnyAssignmentOperator, AnyBeforeOperator, FormatStatementsLastExpression, + has_target_own_parentheses, }; use crate::statement::trailing_semicolon; -use crate::{has_skip_comment, prelude::*}; use crate::{AsFormat, FormatNodeRule}; +use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtAugAssign; diff --git a/crates/ruff_python_formatter/src/statement/stmt_class_def.rs b/crates/ruff_python_formatter/src/statement/stmt_class_def.rs index 6077720412371..f24409704b776 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_class_def.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_class_def.rs @@ -6,9 +6,9 @@ use ruff_text_size::Ranged; use crate::comments::format::{ empty_lines_after_leading_comments, empty_lines_before_trailing_comments, }; -use crate::comments::{leading_comments, trailing_comments, SourceComment}; +use crate::comments::{SourceComment, leading_comments, trailing_comments}; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/statement/stmt_delete.rs b/crates/ruff_python_formatter/src/statement/stmt_delete.rs index 17b1cbe911237..e5b301e40f099 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_delete.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_delete.rs @@ -2,8 +2,8 @@ use ruff_formatter::write; use ruff_python_ast::StmtDelete; use ruff_text_size::Ranged; -use crate::builders::{parenthesize_if_expands, PyFormatterExtensions}; -use crate::comments::{dangling_node_comments, SourceComment}; +use crate::builders::{PyFormatterExtensions, parenthesize_if_expands}; +use crate::comments::{SourceComment, dangling_node_comments}; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::{has_skip_comment, prelude::*}; diff --git a/crates/ruff_python_formatter/src/statement/stmt_for.rs b/crates/ruff_python_formatter/src/statement/stmt_for.rs index 7d9d334d95fcf..a4758b6b6c03f 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_for.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_for.rs @@ -6,7 +6,7 @@ use crate::expression::expr_tuple::TupleParentheses; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader, ElseClause}; +use crate::statement::clause::{ClauseHeader, ElseClause, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Debug)] diff --git a/crates/ruff_python_formatter/src/statement/stmt_function_def.rs b/crates/ruff_python_formatter/src/statement/stmt_function_def.rs index ffd70bec6baf2..61b1655fa59ee 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_function_def.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_function_def.rs @@ -4,7 +4,7 @@ use crate::comments::format::{ use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::{Parentheses, Parenthesize}; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::stmt_class_def::FormatDecorators; use crate::statement::suite::SuiteKind; use ruff_formatter::write; diff --git a/crates/ruff_python_formatter/src/statement/stmt_global.rs b/crates/ruff_python_formatter/src/statement/stmt_global.rs index ea70ee34a4230..dd31d31106faf 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_global.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_global.rs @@ -1,5 +1,4 @@ use ruff_formatter::{format_args, write}; -use ruff_python_ast::AstNode; use ruff_python_ast::StmtGlobal; use crate::comments::SourceComment; @@ -14,7 +13,7 @@ impl FormatNodeRule<StmtGlobal> for FormatStmtGlobal { // Join the `global` names, breaking across continuation lines if necessary, unless the // `global` statement has a trailing comment, in which case, breaking the names would // move the comment "off" of the `global` statement. - if f.context().comments().has_trailing(item.as_any_node_ref()) { + if f.context().comments().has_trailing(item) { let joined = format_with(|f| { f.join_with(format_args![token(","), space()]) .entries(item.names.iter().formatted()) diff --git a/crates/ruff_python_formatter/src/statement/stmt_if.rs b/crates/ruff_python_formatter/src/statement/stmt_if.rs index f58333dc67b46..895c1476754e9 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_if.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_if.rs @@ -5,7 +5,7 @@ use ruff_text_size::Ranged; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Default)] diff --git a/crates/ruff_python_formatter/src/statement/stmt_import_from.rs b/crates/ruff_python_formatter/src/statement/stmt_import_from.rs index 5218f3c231f60..6699013593ff7 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_import_from.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_import_from.rs @@ -1,9 +1,8 @@ use ruff_formatter::write; -use ruff_python_ast::AstNode; use ruff_python_ast::StmtImportFrom; use ruff_text_size::Ranged; -use crate::builders::{parenthesize_if_expands, PyFormatterExtensions, TrailingComma}; +use crate::builders::{PyFormatterExtensions, TrailingComma, parenthesize_if_expands}; use crate::comments::SourceComment; use crate::expression::parentheses::parenthesized; use crate::has_skip_comment; @@ -62,7 +61,7 @@ impl FormatNodeRule<StmtImportFrom> for FormatStmtImportFrom { // ) // ``` let comments = f.context().comments().clone(); - let parenthesized_comments = comments.dangling(item.as_any_node_ref()); + let parenthesized_comments = comments.dangling(item); if parenthesized_comments.is_empty() { parenthesize_if_expands(&names).fmt(f) diff --git a/crates/ruff_python_formatter/src/statement/stmt_match.rs b/crates/ruff_python_formatter/src/statement/stmt_match.rs index 441c881c7a0f1..9ed641ba5541a 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_match.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_match.rs @@ -6,7 +6,7 @@ use crate::context::{NodeLevel, WithNodeLevel}; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::prelude::*; -use crate::statement::clause::{clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_header}; #[derive(Default)] pub struct FormatStmtMatch; diff --git a/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs b/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs index 3280e0d93bbda..666adbacae706 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs @@ -1,5 +1,4 @@ use ruff_formatter::{format_args, write}; -use ruff_python_ast::AstNode; use ruff_python_ast::StmtNonlocal; use crate::comments::SourceComment; @@ -14,7 +13,7 @@ impl FormatNodeRule<StmtNonlocal> for FormatStmtNonlocal { // Join the `nonlocal` names, breaking across continuation lines if necessary, unless the // `nonlocal` statement has a trailing comment, in which case, breaking the names would // move the comment "off" of the `nonlocal` statement. - if f.context().comments().has_trailing(item.as_any_node_ref()) { + if f.context().comments().has_trailing(item) { let joined = format_with(|f| { f.join_with(format_args![token(","), space()]) .entries(item.names.iter().formatted()) diff --git a/crates/ruff_python_formatter/src/statement/stmt_try.rs b/crates/ruff_python_formatter/src/statement/stmt_try.rs index a24cc654ccea7..97ef1512e46cf 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_try.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_try.rs @@ -1,15 +1,15 @@ -use ruff_formatter::{write, FormatRuleWithOptions}; +use ruff_formatter::{FormatRuleWithOptions, write}; use ruff_python_ast::{ExceptHandler, StmtTry}; use ruff_text_size::Ranged; use crate::comments; -use crate::comments::leading_alternate_branch_comments; use crate::comments::SourceComment; +use crate::comments::leading_alternate_branch_comments; use crate::other::except_handler_except_handler::{ ExceptHandlerKind, FormatExceptHandlerExceptHandler, }; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader, ElseClause}; +use crate::statement::clause::{ClauseHeader, ElseClause, clause_body, clause_header}; use crate::statement::suite::SuiteKind; use crate::statement::{FormatRefWithRule, Stmt}; @@ -47,12 +47,10 @@ impl FormatRule<ExceptHandler, PyFormatContext<'_>> for FormatExceptHandler { } impl<'ast> AsFormat<PyFormatContext<'ast>> for ExceptHandler { - type Format<'a> = FormatRefWithRule< - 'a, - ExceptHandler, - FormatExceptHandler, - PyFormatContext<'ast>, - > where Self: 'a; + type Format<'a> + = FormatRefWithRule<'a, ExceptHandler, FormatExceptHandler, PyFormatContext<'ast>> + where + Self: 'a; fn format(&self) -> Self::Format<'_> { FormatRefWithRule::new(self, FormatExceptHandler::default()) diff --git a/crates/ruff_python_formatter/src/statement/stmt_while.rs b/crates/ruff_python_formatter/src/statement/stmt_while.rs index 19dc175998deb..c471078620bcd 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_while.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_while.rs @@ -1,12 +1,11 @@ use ruff_formatter::{format_args, write}; -use ruff_python_ast::AstNode; use ruff_python_ast::{Stmt, StmtWhile}; use ruff_text_size::Ranged; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader, ElseClause}; +use crate::statement::clause::{ClauseHeader, ElseClause, clause_body, clause_header}; use crate::statement::suite::SuiteKind; #[derive(Default)] @@ -22,7 +21,7 @@ impl FormatNodeRule<StmtWhile> for FormatStmtWhile { } = item; let comments = f.context().comments().clone(); - let dangling_comments = comments.dangling(item.as_any_node_ref()); + let dangling_comments = comments.dangling(item); let body_start = body.first().map_or(test.end(), Stmt::start); let or_else_comments_start = diff --git a/crates/ruff_python_formatter/src/statement/stmt_with.rs b/crates/ruff_python_formatter/src/statement/stmt_with.rs index 79d2cb0bfa655..4c9cbc0b3f529 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_with.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_with.rs @@ -1,6 +1,6 @@ -use ruff_formatter::{format_args, write, FormatContext, FormatError}; -use ruff_python_ast::StmtWith; -use ruff_python_ast::{AstNode, WithItem}; +use ruff_formatter::{FormatContext, FormatError, format_args, write}; +use ruff_python_ast::PythonVersion; +use ruff_python_ast::{StmtWith, WithItem}; use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; use ruff_text_size::{Ranged, TextRange}; @@ -13,9 +13,8 @@ use crate::expression::parentheses::{ use crate::other::commas; use crate::other::with_item::WithItemLayout; use crate::prelude::*; -use crate::statement::clause::{clause_body, clause_header, ClauseHeader}; +use crate::statement::clause::{ClauseHeader, clause_body, clause_header}; use crate::statement::suite::SuiteKind; -use crate::PythonVersion; #[derive(Default)] pub struct FormatStmtWith; @@ -36,7 +35,7 @@ impl FormatNodeRule<StmtWith> for FormatStmtWith { // ... // ``` let comments = f.context().comments().clone(); - let dangling_comments = comments.dangling(with_stmt.as_any_node_ref()); + let dangling_comments = comments.dangling(with_stmt); let partition_point = dangling_comments.partition_point(|comment| { with_stmt .items @@ -71,7 +70,10 @@ impl FormatNodeRule<StmtWith> for FormatStmtWith { match layout { WithItemsLayout::SingleWithTarget(single) => { - optional_parentheses(&single.format()).fmt(f) + optional_parentheses(&single.format().with_options( + WithItemLayout::ParenthesizedContextManagers { single: true }, + )) + .fmt(f) } WithItemsLayout::SingleWithoutTarget(single) => single @@ -93,7 +95,11 @@ impl FormatNodeRule<StmtWith> for FormatStmtWith { for item in &with_stmt.items { joiner.entry_with_line_separator( item, - &item.format(), + &item.format().with_options( + WithItemLayout::ParenthesizedContextManagers { + single: with_stmt.items.len() == 1, + }, + ), soft_line_break_or_space(), ); } @@ -114,9 +120,22 @@ impl FormatNodeRule<StmtWith> for FormatStmtWith { WithItemsLayout::Parenthesized => parenthesized( "(", &format_with(|f: &mut PyFormatter| { - f.join_comma_separated(with_stmt.body.first().unwrap().start()) - .nodes(&with_stmt.items) - .finish() + let mut joiner = f.join_comma_separated( + with_stmt.body.first().unwrap().start(), + ); + + for item in &with_stmt.items { + joiner.entry( + item, + &item.format().with_options( + WithItemLayout::ParenthesizedContextManagers { + single: with_stmt.items.len() == 1, + }, + ), + ); + } + + joiner.finish() }), ")", ) @@ -283,7 +302,7 @@ impl<'a> WithItemsLayout<'a> { } } - let can_parenthesize = context.options().target_version() >= PythonVersion::Py39 + let can_parenthesize = context.options().target_version() >= PythonVersion::PY39 || are_with_items_parenthesized(with, context)?; // If the target version doesn't support parenthesized context managers and they aren't diff --git a/crates/ruff_python_formatter/src/statement/suite.rs b/crates/ruff_python_formatter/src/statement/suite.rs index 7b275677ef288..34d8216af7e51 100644 --- a/crates/ruff_python_formatter/src/statement/suite.rs +++ b/crates/ruff_python_formatter/src/statement/suite.rs @@ -1,5 +1,5 @@ use ruff_formatter::{ - write, FormatContext, FormatOwnedWithRule, FormatRefWithRule, FormatRuleWithOptions, + FormatContext, FormatOwnedWithRule, FormatRefWithRule, FormatRuleWithOptions, write, }; use ruff_python_ast::helpers::is_compound_statement; use ruff_python_ast::{self as ast, Expr, PySourceType, Stmt, Suite}; @@ -8,7 +8,7 @@ use ruff_python_trivia::{lines_after, lines_after_ignoring_end_of_line_trivia, l use ruff_text_size::{Ranged, TextRange}; use crate::comments::{ - leading_comments, trailing_comments, Comments, LeadingDanglingTrailingComments, + Comments, LeadingDanglingTrailingComments, leading_comments, trailing_comments, }; use crate::context::{NodeLevel, TopLevelStatementPosition, WithIndentLevel, WithNodeLevel}; use crate::other::string_literal::StringLiteralKind; @@ -170,7 +170,6 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite { } else { first.fmt(f)?; - #[allow(clippy::if_same_then_else)] let empty_line_after_docstring = if matches!(first, SuiteChildStatement::Docstring(_)) && self.kind == SuiteKind::Class { @@ -917,10 +916,10 @@ mod tests { use ruff_python_parser::parse_module; use ruff_python_trivia::CommentRanges; + use crate::PyFormatOptions; use crate::comments::Comments; use crate::prelude::*; use crate::statement::suite::SuiteKind; - use crate::PyFormatOptions; fn format_suite(level: SuiteKind) -> String { let source = r" diff --git a/crates/ruff_python_formatter/src/string/docstring.rs b/crates/ruff_python_formatter/src/string/docstring.rs index b078c5c6b3c90..5ca55677749f5 100644 --- a/crates/ruff_python_formatter/src/string/docstring.rs +++ b/crates/ruff_python_formatter/src/string/docstring.rs @@ -10,22 +10,19 @@ use itertools::Itertools; use regex::Regex; use ruff_formatter::printer::SourceMapGeneration; -use ruff_python_ast::{str::Quote, AnyStringFlags, StringFlags}; +use ruff_python_ast::{AnyStringFlags, StringFlags, str::Quote}; +use ruff_python_parser::ParseOptions; use ruff_python_trivia::CommentRanges; use { - ruff_formatter::{write, FormatOptions, IndentStyle, LineWidth, Printed}, - ruff_python_trivia::{is_python_whitespace, PythonWhitespace}, + ruff_formatter::{FormatOptions, IndentStyle, LineWidth, Printed, write}, + ruff_python_trivia::{PythonWhitespace, is_python_whitespace}, ruff_text_size::{Ranged, TextLen, TextRange, TextSize}, }; -use crate::preview::{ - is_docstring_code_block_in_docstring_indent_enabled, - is_join_implicit_concatenated_string_enabled, -}; -use crate::string::StringQuotes; -use crate::{prelude::*, DocstringCodeLineWidth, FormatModuleError}; - use super::NormalizedString; +use crate::preview::is_no_chaperone_for_escaped_quote_in_triple_quoted_docstring_enabled; +use crate::string::StringQuotes; +use crate::{DocstringCodeLineWidth, FormatModuleError, prelude::*}; /// Format a docstring by trimming whitespace and adjusting the indentation. /// @@ -267,7 +264,7 @@ struct DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { code_example: CodeExample<'src>, } -impl<'ast, 'buf, 'fmt, 'src> DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { +impl<'src> DocstringLinePrinter<'_, '_, '_, 'src> { /// Print all of the lines in the given iterator to this /// printer's formatter. /// @@ -462,7 +459,7 @@ impl<'ast, 'buf, 'fmt, 'src> DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { Indentation::from_str(trim_end).columns() - self.stripped_indentation.columns(); let in_docstring_indent = " ".repeat(indent_len) + trim_end.trim_start(); text(&in_docstring_indent).fmt(self.f)?; - }; + } // We handled the case that the closing quotes are on their own line // above (the last line is empty except for whitespace). If they are on @@ -496,8 +493,6 @@ impl<'ast, 'buf, 'fmt, 'src> DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { &mut self, kind: &mut CodeExampleKind<'_>, ) -> FormatResult<Option<Vec<OutputDocstringLine<'static>>>> { - use ruff_python_parser::AsMode; - let line_width = match self.f.options().docstring_code_line_width() { DocstringCodeLineWidth::Fixed(width) => width, DocstringCodeLineWidth::Dynamic => { @@ -508,17 +503,15 @@ impl<'ast, 'buf, 'fmt, 'src> DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { .to_ascii_spaces(indent_width) .saturating_add(kind.extra_indent_ascii_spaces()); - if is_docstring_code_block_in_docstring_indent_enabled(self.f.context()) { - // Add the in-docstring indentation - current_indent = current_indent.saturating_add( - u16::try_from( - kind.indent() - .columns() - .saturating_sub(self.stripped_indentation.columns()), - ) - .unwrap_or(u16::MAX), - ); - } + // Add the in-docstring indentation + current_indent = current_indent.saturating_add( + u16::try_from( + kind.indent() + .columns() + .saturating_sub(self.stripped_indentation.columns()), + ) + .unwrap_or(u16::MAX), + ); let width = std::cmp::max(1, global_line_width.saturating_sub(current_indent)); LineWidth::try_from(width).expect("width should be capped at a minimum of 1") @@ -576,7 +569,8 @@ impl<'ast, 'buf, 'fmt, 'src> DocstringLinePrinter<'ast, 'buf, 'fmt, 'src> { std::format!(r#""""{}""""#, printed.as_code()) } }; - let result = ruff_python_parser::parse(&wrapped, self.f.options().source_type().as_mode()); + let result = + ruff_python_parser::parse(&wrapped, ParseOptions::from(self.f.options().source_type())); // If the resulting code is not valid, then reset and pass through // the docstring lines as-is. if result.is_err() { @@ -665,7 +659,7 @@ struct OutputDocstringLine<'src> { is_last: bool, } -impl<'src> OutputDocstringLine<'src> { +impl OutputDocstringLine<'_> { /// Return this reformatted line, but with the given function applied to /// the text of the line. fn map(self, mut map: impl FnMut(&str) -> String) -> OutputDocstringLine<'static> { @@ -1026,7 +1020,7 @@ impl<'src> CodeExampleRst<'src> { /// /// [literal block]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks /// [code block directive]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block - fn new(original: InputDocstringLine<'src>) -> Option<CodeExampleRst> { + fn new(original: InputDocstringLine<'src>) -> Option<CodeExampleRst<'src>> { let (opening_indent, rest) = indent_with_suffix(original.line); if rest.starts_with(".. ") { if let Some(litblock) = CodeExampleRst::new_code_block(original) { @@ -1061,7 +1055,7 @@ impl<'src> CodeExampleRst<'src> { /// Attempts to create a new reStructuredText code example from a /// `code-block` or `sourcecode` directive. If one couldn't be found, then /// `None` is returned. - fn new_code_block(original: InputDocstringLine<'src>) -> Option<CodeExampleRst> { + fn new_code_block(original: InputDocstringLine<'src>) -> Option<CodeExampleRst<'src>> { // This regex attempts to parse the start of a reStructuredText code // block [directive]. From the reStructuredText spec: // @@ -1586,10 +1580,8 @@ fn docstring_format_source( docstring_quote_style: Quote, source: &str, ) -> Result<Printed, FormatModuleError> { - use ruff_python_parser::AsMode; - let source_type = options.source_type(); - let parsed = ruff_python_parser::parse(source, source_type.as_mode())?; + let parsed = ruff_python_parser::parse(source, ParseOptions::from(source_type))?; let comment_ranges = CommentRanges::from(parsed.tokens()); let source_code = ruff_formatter::SourceCode::new(source); let comments = crate::Comments::from_ast(parsed.syntax(), source_code, &comment_ranges); @@ -1604,23 +1596,45 @@ fn docstring_format_source( Ok(formatted.print()?) } -/// If the last line of the docstring is `content" """` or `content\ """`, we need a chaperone space -/// that avoids `content""""` and `content\"""`. This does only applies to un-escaped backslashes, -/// so `content\\ """` doesn't need a space while `content\\\ """` does. +/// If the last line of the docstring is `content""""` or `content\"""`, we need a chaperone space +/// that avoids `content""""` and `content\"""`. This only applies to un-escaped backslashes, +/// so `content\\"""` doesn't need a space while `content\\\"""` does. pub(super) fn needs_chaperone_space( flags: AnyStringFlags, trim_end: &str, context: &PyFormatContext, ) -> bool { - if trim_end.chars().rev().take_while(|c| *c == '\\').count() % 2 == 1 { - true - } else if is_join_implicit_concatenated_string_enabled(context) { - flags.is_triple_quoted() && trim_end.ends_with(flags.quote_style().as_char()) + if count_consecutive_chars_from_end(trim_end, '\\') % 2 == 1 { + // Odd backslash count; chaperone avoids escaping closing quotes + // `"\ "` -> prevent that this becomes `"\"` which escapes the closing quote. + return true; + } + + if is_no_chaperone_for_escaped_quote_in_triple_quoted_docstring_enabled(context) { + if flags.is_triple_quoted() { + if let Some(before_quote) = trim_end.strip_suffix(flags.quote_style().as_char()) { + if count_consecutive_chars_from_end(before_quote, '\\') % 2 == 0 { + // Even backslash count preceding quote; + // ```py + // """a " """ + // """a \\" """ + // ``` + // The chaperon is needed or the triple quoted string "ends" with 4 instead of 3 quotes. + return true; + } + } + } + + false } else { - trim_end.ends_with(flags.quote_style().as_char()) + flags.is_triple_quoted() && trim_end.ends_with(flags.quote_style().as_char()) } } +fn count_consecutive_chars_from_end(s: &str, target: char) -> usize { + s.chars().rev().take_while(|c| *c == target).count() +} + #[derive(Copy, Clone, Debug)] enum Indentation { /// Space only indentation or an empty indentation. @@ -1782,7 +1796,7 @@ impl Indentation { }), _ => None, - } + }; } Self::Mixed { .. } => return None, }; diff --git a/crates/ruff_python_formatter/src/string/implicit.rs b/crates/ruff_python_formatter/src/string/implicit.rs index 2f057a49d8481..fd6145c03342c 100644 --- a/crates/ruff_python_formatter/src/string/implicit.rs +++ b/crates/ruff_python_formatter/src/string/implicit.rs @@ -1,29 +1,26 @@ -use std::borrow::Cow; - -use ruff_formatter::{format_args, write, FormatContext}; -use ruff_python_ast::str::Quote; +use itertools::Itertools; +use ruff_formatter::{FormatContext, format_args, write}; +use ruff_python_ast::str::{Quote, TripleQuotes}; use ruff_python_ast::str_prefix::{ AnyStringPrefix, ByteStringPrefix, FStringPrefix, StringLiteralPrefix, }; use ruff_python_ast::{AnyStringFlags, FStringElement, StringFlags, StringLike, StringLikePart}; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange}; +use std::borrow::Cow; use crate::comments::{leading_comments, trailing_comments}; use crate::expression::parentheses::in_parentheses_only_soft_line_break_or_space; -use crate::other::f_string::{FStringContext, FStringLayout, FormatFString}; +use crate::other::f_string::{FStringContext, FStringLayout}; use crate::other::f_string_element::FormatFStringExpressionElement; -use crate::other::string_literal::StringLiteralKind; use crate::prelude::*; -use crate::preview::{ - is_f_string_formatting_enabled, is_join_implicit_concatenated_string_enabled, -}; use crate::string::docstring::needs_chaperone_space; use crate::string::normalize::{ - is_fstring_with_quoted_debug_expression, - is_fstring_with_triple_quoted_literal_expression_containing_quotes, QuoteMetadata, + QuoteMetadata, is_fstring_with_quoted_debug_expression, + is_fstring_with_quoted_format_spec_and_debug, + is_fstring_with_triple_quoted_literal_expression_containing_quotes, }; -use crate::string::{normalize_string, StringLikeExtensions, StringNormalizer, StringQuotes}; +use crate::string::{StringLikeExtensions, StringNormalizer, StringQuotes, normalize_string}; /// Formats any implicitly concatenated string. This could be any valid combination /// of string, bytes or f-string literals. @@ -41,12 +38,20 @@ impl<'a> FormatImplicitConcatenatedString<'a> { impl Format<PyFormatContext<'_>> for FormatImplicitConcatenatedString<'_> { fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { - let expanded = FormatImplicitConcatenatedStringExpanded::new(self.string); + let flat = FormatImplicitConcatenatedStringFlat::new(self.string, f.context()); + let expanded = FormatImplicitConcatenatedStringExpanded::new( + self.string, + if flat.is_some() { + ImplicitConcatenatedLayout::MaybeFlat + } else { + ImplicitConcatenatedLayout::Multipart + }, + ); // If the string can be joined, try joining the implicit concatenated string into a single string // if it fits on the line. Otherwise, parenthesize the string parts and format each part on its // own line. - if let Some(flat) = FormatImplicitConcatenatedStringFlat::new(self.string, f.context()) { + if let Some(flat) = flat { write!( f, [if_group_fits_on_line(&flat), if_group_breaks(&expanded)] @@ -60,44 +65,43 @@ impl Format<PyFormatContext<'_>> for FormatImplicitConcatenatedString<'_> { /// Formats an implicit concatenated string where parts are separated by a space or line break. pub(crate) struct FormatImplicitConcatenatedStringExpanded<'a> { string: StringLike<'a>, + layout: ImplicitConcatenatedLayout, } impl<'a> FormatImplicitConcatenatedStringExpanded<'a> { - pub(crate) fn new(string: StringLike<'a>) -> Self { + pub(crate) fn new(string: StringLike<'a>, layout: ImplicitConcatenatedLayout) -> Self { assert!(string.is_implicit_concatenated()); - Self { string } + Self { string, layout } } } impl Format<PyFormatContext<'_>> for FormatImplicitConcatenatedStringExpanded<'_> { fn fmt(&self, f: &mut Formatter<PyFormatContext<'_>>) -> FormatResult<()> { let comments = f.context().comments().clone(); - let quoting = self.string.quoting(f.context().source()); - let join_implicit_concatenated_string_enabled = - is_join_implicit_concatenated_string_enabled(f.context()); + // Keep implicit concatenated strings expanded unless they're already written on a single line. + if matches!(self.layout, ImplicitConcatenatedLayout::Multipart) + && self.string.parts().tuple_windows().any(|(a, b)| { + f.context() + .source() + .contains_line_break(TextRange::new(a.end(), b.start())) + }) + { + expand_parent().fmt(f)?; + } + let mut joiner = f.join_with(in_parentheses_only_soft_line_break_or_space()); for part in self.string.parts() { let format_part = format_with(|f: &mut PyFormatter| match part { - StringLikePart::String(part) => { - let kind = if self.string.is_fstring() { - #[allow(deprecated)] - StringLiteralKind::InImplicitlyConcatenatedFString(quoting) - } else { - StringLiteralKind::String - }; - - part.format().with_options(kind).fmt(f) - } + StringLikePart::String(part) => part.format().fmt(f), StringLikePart::Bytes(bytes_literal) => bytes_literal.format().fmt(f), - StringLikePart::FString(part) => FormatFString::new(part, quoting).fmt(f), + StringLikePart::FString(part) => part.format().fmt(f), }); - let part_comments = comments.leading_dangling_trailing(&part); + let part_comments = comments.leading_dangling_trailing(part); joiner.entry(&format_args![ - (!join_implicit_concatenated_string_enabled).then_some(line_suffix_boundary()), leading_comments(part_comments.leading), format_part, trailing_comments(part_comments.trailing) @@ -108,6 +112,14 @@ impl Format<PyFormatContext<'_>> for FormatImplicitConcatenatedStringExpanded<'_ } } +#[derive(Copy, Clone, Debug)] +pub(crate) enum ImplicitConcatenatedLayout { + /// The string might get joined into a single string if it fits on a single line. + MaybeFlat, + /// The string will remain a multipart string. + Multipart, +} + /// Formats an implicit concatenated string where parts are joined into a single string if possible. pub(crate) struct FormatImplicitConcatenatedStringFlat<'a> { string: StringLike<'a>, @@ -119,12 +131,8 @@ impl<'a> FormatImplicitConcatenatedStringFlat<'a> { /// Creates a new formatter. Returns `None` if the string can't be merged into a single string. pub(crate) fn new(string: StringLike<'a>, context: &PyFormatContext) -> Option<Self> { fn merge_flags(string: StringLike, context: &PyFormatContext) -> Option<AnyStringFlags> { - if !is_join_implicit_concatenated_string_enabled(context) { - return None; - } - // Multiline strings can never fit on a single line. - if !string.is_fstring() && string.is_multiline(context.source()) { + if string.is_multiline(context) { return None; } @@ -157,41 +165,30 @@ impl<'a> FormatImplicitConcatenatedStringFlat<'a> { } if let StringLikePart::FString(fstring) = part { - if fstring.elements.iter().any(|element| match element { - // Same as for other literals. Multiline literals can't fit on a single line. - FStringElement::Literal(literal) => { - context.source().contains_line_break(literal.range()) - } - FStringElement::Expression(expression) => { - if is_f_string_formatting_enabled(context) { - // Expressions containing comments can't be joined. - context.comments().contains_comments(expression.into()) - } else { - // Multiline f-string expressions can't be joined if the f-string formatting is disabled because - // the string gets inserted in verbatim preserving the newlines. - context.source().contains_line_break(expression.range()) + if context.options().target_version().supports_pep_701() { + if is_fstring_with_quoted_format_spec_and_debug(fstring, context) { + if preserve_quotes_requirement + .is_some_and(|quote| quote != part.flags().quote_style()) + { + return None; } + preserve_quotes_requirement = Some(part.flags().quote_style()); } - }) { - return None; } - // Avoid invalid syntax for pre Python 312: // * When joining parts that have debug expressions with quotes: `f"{10 + len('bar')=}" f'{10 + len("bar")=}' // * When joining parts that contain triple quoted strings with quotes: `f"{'''test ' '''}" f'{"""other " """}'` - if !context.options().target_version().supports_pep_701() { - if is_fstring_with_quoted_debug_expression(fstring, context) - || is_fstring_with_triple_quoted_literal_expression_containing_quotes( - fstring, context, - ) + else if is_fstring_with_quoted_debug_expression(fstring, context) + || is_fstring_with_triple_quoted_literal_expression_containing_quotes( + fstring, context, + ) + { + if preserve_quotes_requirement + .is_some_and(|quote| quote != part.flags().quote_style()) { - if preserve_quotes_requirement - .is_some_and(|quote| quote != part.flags().quote_style()) - { - return None; - } - preserve_quotes_requirement = Some(part.flags().quote_style()); + return None; } + preserve_quotes_requirement = Some(part.flags().quote_style()); } } } @@ -208,29 +205,33 @@ impl<'a> FormatImplicitConcatenatedStringFlat<'a> { StringLike::FString(_) => AnyStringPrefix::Format(FStringPrefix::Regular), }; - // Only determining the preferred quote for the first string is sufficient - // because we don't support joining triple quoted strings with non triple quoted strings. - let quote = if let Ok(preferred_quote) = - Quote::try_from(normalizer.preferred_quote_style(first_part)) - { - for part in string.parts() { - let part_quote_metadata = - QuoteMetadata::from_part(part, context, preferred_quote); - - if let Some(merged) = merged_quotes.as_mut() { - *merged = part_quote_metadata.merge(merged)?; - } else { - merged_quotes = Some(part_quote_metadata); + let quote = if let Some(quote) = preserve_quotes_requirement { + quote + } else { + // Only determining the preferred quote for the first string is sufficient + // because we don't support joining triple quoted strings with non triple quoted strings. + if let Ok(preferred_quote) = + Quote::try_from(normalizer.preferred_quote_style(first_part)) + { + for part in string.parts() { + let part_quote_metadata = + QuoteMetadata::from_part(part, context, preferred_quote); + + if let Some(merged) = merged_quotes.as_mut() { + *merged = part_quote_metadata.merge(merged)?; + } else { + merged_quotes = Some(part_quote_metadata); + } } - } - merged_quotes?.choose(preferred_quote) - } else { - // Use the quotes of the first part if the quotes should be preserved. - first_part.flags().quote_style() + merged_quotes?.choose(preferred_quote) + } else { + // Use the quotes of the first part if the quotes should be preserved. + first_part.flags().quote_style() + } }; - Some(AnyStringFlags::new(prefix, quote, false)) + Some(AnyStringFlags::new(prefix, quote, TripleQuotes::No)) } if !string.is_implicit_concatenated() { @@ -300,44 +301,29 @@ impl Format<PyFormatContext<'_>> for FormatImplicitConcatenatedStringFlat<'_> { } StringLikePart::FString(f_string) => { - if is_f_string_formatting_enabled(f.context()) { - for element in &f_string.elements { - match element { - FStringElement::Literal(literal) => { - FormatLiteralContent { - range: literal.range(), - flags: self.flags, - is_fstring: true, - trim_end: false, - trim_start: false, - } - .fmt(f)?; - } - // Formatting the expression here and in the expanded version is safe **only** - // because we assert that the f-string never contains any comments. - FStringElement::Expression(expression) => { - let context = FStringContext::new( - self.flags, - FStringLayout::from_f_string( - f_string, - f.context().source(), - ), - ); - - FormatFStringExpressionElement::new(expression, context) - .fmt(f)?; + for element in &f_string.elements { + match element { + FStringElement::Literal(literal) => { + FormatLiteralContent { + range: literal.range(), + flags: self.flags, + is_fstring: true, + trim_end: false, + trim_start: false, } + .fmt(f)?; + } + // Formatting the expression here and in the expanded version is safe **only** + // because we assert that the f-string never contains any comments. + FStringElement::Expression(expression) => { + let context = FStringContext::new( + self.flags, + FStringLayout::from_f_string(f_string, f.context().source()), + ); + + FormatFStringExpressionElement::new(expression, context).fmt(f)?; } } - } else { - FormatLiteralContent { - range: part.content_range(), - flags: self.flags, - is_fstring: true, - trim_end: false, - trim_start: false, - } - .fmt(f)?; } } } @@ -363,9 +349,6 @@ impl Format<PyFormatContext<'_>> for FormatLiteralContent { 0, self.flags, self.flags.is_f_string() && !self.is_fstring, - // TODO: Remove the argument from `normalize_string` when promoting the `is_f_string_formatting_enabled` preview style. - self.flags.is_f_string() && !is_f_string_formatting_enabled(f.context()), - is_f_string_formatting_enabled(f.context()), ); // Trim the start and end of the string if it's the first or last part of a docstring. diff --git a/crates/ruff_python_formatter/src/string/mod.rs b/crates/ruff_python_formatter/src/string/mod.rs index eaff5efac2cf8..52fd92ad80249 100644 --- a/crates/ruff_python_formatter/src/string/mod.rs +++ b/crates/ruff_python_formatter/src/string/mod.rs @@ -1,29 +1,21 @@ use memchr::memchr2; - -pub(crate) use normalize::{normalize_string, NormalizedString, StringNormalizer}; -use ruff_python_ast::str::Quote; +pub(crate) use normalize::{NormalizedString, StringNormalizer, normalize_string}; +use ruff_python_ast::StringLikePart; +use ruff_python_ast::str::{Quote, TripleQuotes}; use ruff_python_ast::{ - self as ast, + self as ast, AnyStringFlags, StringFlags, str_prefix::{AnyStringPrefix, StringLiteralPrefix}, - AnyStringFlags, StringFlags, }; +use ruff_source_file::LineRanges; use ruff_text_size::Ranged; -use crate::expression::expr_f_string::f_string_quoting; -use crate::prelude::*; use crate::QuoteStyle; +use crate::prelude::*; pub(crate) mod docstring; pub(crate) mod implicit; mod normalize; -#[derive(Copy, Clone, Debug, Default)] -pub(crate) enum Quoting { - #[default] - CanChange, - Preserve, -} - impl Format<PyFormatContext<'_>> for AnyStringPrefix { fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> { // Remove the unicode prefix `u` if any because it is meaningless in Python 3+. @@ -88,28 +80,62 @@ impl From<Quote> for QuoteStyle { // Extension trait that adds formatter specific helper methods to `StringLike`. pub(crate) trait StringLikeExtensions { - fn quoting(&self, source: &str) -> Quoting; - - fn is_multiline(&self, source: &str) -> bool; + fn is_multiline(&self, context: &PyFormatContext) -> bool; } impl StringLikeExtensions for ast::StringLike<'_> { - fn quoting(&self, source: &str) -> Quoting { - match self { - Self::String(_) | Self::Bytes(_) => Quoting::CanChange, - Self::FString(f_string) => f_string_quoting(f_string, source), - } - } - - fn is_multiline(&self, source: &str) -> bool { - match self { - Self::String(_) | Self::Bytes(_) => self.parts().any(|part| { + fn is_multiline(&self, context: &PyFormatContext) -> bool { + self.parts().any(|part| match part { + StringLikePart::String(_) | StringLikePart::Bytes(_) => { part.flags().is_triple_quoted() - && memchr2(b'\n', b'\r', source[self.range()].as_bytes()).is_some() - }), - Self::FString(fstring) => { - memchr2(b'\n', b'\r', source[fstring.range].as_bytes()).is_some() + && context.source().contains_line_break(part.range()) } - } + StringLikePart::FString(f_string) => { + fn contains_line_break_or_comments( + elements: &ast::FStringElements, + context: &PyFormatContext, + triple_quotes: TripleQuotes, + ) -> bool { + elements.iter().any(|element| match element { + ast::FStringElement::Literal(literal) => { + triple_quotes.is_yes() + && context.source().contains_line_break(literal.range()) + } + ast::FStringElement::Expression(expression) => { + // Expressions containing comments can't be joined. + // + // Format specifiers needs to be checked as well. For example, the + // following should be considered multiline because the literal + // part of the format specifier contains a newline at the end + // (`.3f\n`): + // + // ```py + // x = f"hello {a + b + c + d:.3f + // } world" + // ``` + context.comments().contains_comments(expression.into()) + || expression.format_spec.as_deref().is_some_and(|spec| { + contains_line_break_or_comments( + &spec.elements, + context, + triple_quotes, + ) + }) + || expression.debug_text.as_ref().is_some_and(|debug_text| { + memchr2(b'\n', b'\r', debug_text.leading.as_bytes()).is_some() + || memchr2(b'\n', b'\r', debug_text.trailing.as_bytes()) + .is_some() + }) + } + }) + } + + contains_line_break_or_comments( + &f_string.elements, + context, + f_string.flags.triple_quotes(), + ) + } + }) } } diff --git a/crates/ruff_python_formatter/src/string/normalize.rs b/crates/ruff_python_formatter/src/string/normalize.rs index d23e359958d5c..b8f2902d85aa1 100644 --- a/crates/ruff_python_formatter/src/string/normalize.rs +++ b/crates/ruff_python_formatter/src/string/normalize.rs @@ -5,18 +5,18 @@ use std::iter::FusedIterator; use ruff_formatter::FormatContext; use ruff_python_ast::visitor::source_order::SourceOrderVisitor; use ruff_python_ast::{ - str::Quote, AnyStringFlags, BytesLiteral, FString, StringFlags, StringLikePart, StringLiteral, + AnyStringFlags, BytesLiteral, FString, FStringElement, FStringElements, FStringFlags, + StringFlags, StringLikePart, StringLiteral, + str::{Quote, TripleQuotes}, }; use ruff_text_size::{Ranged, TextRange, TextSlice}; +use crate::QuoteStyle; use crate::context::FStringState; use crate::prelude::*; -use crate::preview::is_f_string_formatting_enabled; -use crate::string::{Quoting, StringQuotes}; -use crate::QuoteStyle; +use crate::string::StringQuotes; pub(crate) struct StringNormalizer<'a, 'src> { - quoting: Quoting, preferred_quote_style: Option<QuoteStyle>, context: &'a PyFormatContext<'src>, } @@ -24,7 +24,6 @@ pub(crate) struct StringNormalizer<'a, 'src> { impl<'a, 'src> StringNormalizer<'a, 'src> { pub(crate) fn from_context(context: &'a PyFormatContext<'src>) -> Self { Self { - quoting: Quoting::default(), preferred_quote_style: None, context, } @@ -35,11 +34,6 @@ impl<'a, 'src> StringNormalizer<'a, 'src> { self } - pub(crate) fn with_quoting(mut self, quoting: Quoting) -> Self { - self.quoting = quoting; - self - } - /// Determines the preferred quote style for `string`. /// The formatter should use the preferred quote style unless /// it can't because the string contains the preferred quotes OR @@ -48,105 +42,114 @@ impl<'a, 'src> StringNormalizer<'a, 'src> { /// Note: If you add more cases here where we return `QuoteStyle::Preserve`, /// make sure to also add them to [`FormatImplicitConcatenatedStringFlat::new`]. pub(super) fn preferred_quote_style(&self, string: StringLikePart) -> QuoteStyle { - match self.quoting { - Quoting::Preserve => QuoteStyle::Preserve, - Quoting::CanChange => { - let preferred_quote_style = self - .preferred_quote_style - .unwrap_or(self.context.options().quote_style()); - - if preferred_quote_style.is_preserve() { - return QuoteStyle::Preserve; - } + let preferred_quote_style = self + .preferred_quote_style + .unwrap_or(self.context.options().quote_style()); + let supports_pep_701 = self.context.options().target_version().supports_pep_701(); - // There are two cases where it's necessary to preserve the quotes - // if the target version is pre 3.12 and the part is an f-string. - if !self.context.options().target_version().supports_pep_701() { - if let StringLikePart::FString(fstring) = string { - // An f-string expression contains a debug text with a quote character - // because the formatter will emit the debug expression **exactly** the same as in the source text. - if is_fstring_with_quoted_debug_expression(fstring, self.context) { - return QuoteStyle::Preserve; - } - - // An f-string expression that contains a triple quoted string literal expression - // that contains a quote. - if is_fstring_with_triple_quoted_literal_expression_containing_quotes( - fstring, - self.context, - ) { - return QuoteStyle::Preserve; - } - } + // For f-strings prefer alternating the quotes unless The outer string is triple quoted and the inner isn't. + if let FStringState::InsideExpressionElement(parent_context) = self.context.f_string_state() + { + let parent_flags = parent_context.f_string().flags(); + + if !parent_flags.is_triple_quoted() || string.flags().is_triple_quoted() { + // This logic is even necessary when using preserve and the target python version doesn't support PEP701 because + // we might end up joining two f-strings that have different quote styles, in which case we need to alternate the quotes + // for inner strings to avoid a syntax error: `string = "this is my string with " f'"{params.get("mine")}"'` + if !preferred_quote_style.is_preserve() || !supports_pep_701 { + return QuoteStyle::from(parent_flags.quote_style().opposite()); } + } + } - // For f-strings prefer alternating the quotes unless The outer string is triple quoted and the inner isn't. - if let FStringState::InsideExpressionElement(parent_context) = - self.context.f_string_state() - { - let parent_flags = parent_context.f_string().flags(); + // Leave the quotes unchanged for all other strings. + if preferred_quote_style.is_preserve() { + return QuoteStyle::Preserve; + } - if !parent_flags.is_triple_quoted() || string.flags().is_triple_quoted() { - return QuoteStyle::from(parent_flags.quote_style().opposite()); - } + // There are cases where it is necessary to preserve the quotes to prevent an invalid f-string. + if let StringLikePart::FString(fstring) = string { + // There are two cases where it's necessary to preserve the quotes if the + // target version is pre 3.12 and the part is an f-string. + if !supports_pep_701 { + // An f-string expression contains a debug text with a quote character + // because the formatter will emit the debug expression **exactly** the + // same as in the source text. + if is_fstring_with_quoted_debug_expression(fstring, self.context) { + return QuoteStyle::Preserve; } - // Per PEP 8, always prefer double quotes for triple-quoted strings. - if string.flags().is_triple_quoted() { - // ... unless we're formatting a code snippet inside a docstring, - // then we specifically want to invert our quote style to avoid - // writing out invalid Python. - // - // It's worth pointing out that we can actually wind up being - // somewhat out of sync with PEP8 in this case. Consider this - // example: - // - // def foo(): - // ''' - // Something. - // - // >>> """tricksy""" - // ''' - // pass - // - // Ideally, this would be reformatted as: - // - // def foo(): - // """ - // Something. - // - // >>> '''tricksy''' - // """ - // pass - // - // But the logic here results in the original quoting being - // preserved. This is because the quoting style of the outer - // docstring is determined, in part, by looking at its contents. In - // this case, it notices that it contains a `"""` and thus infers - // that using `'''` would overall read better because it avoids - // the need to escape the interior `"""`. Except... in this case, - // the `"""` is actually part of a code snippet that could get - // reformatted to using a different quoting style itself. - // - // Fixing this would, I believe, require some fairly seismic - // changes to how formatting strings works. Namely, we would need - // to look for code snippets before normalizing the docstring, and - // then figure out the quoting style more holistically by looking - // at the various kinds of quotes used in the code snippets and - // what reformatting them might look like. - // - // Overall this is a bit of a corner case and just inverting the - // style from what the parent ultimately decided upon works, even - // if it doesn't have perfect alignment with PEP8. - if let Some(quote) = self.context.docstring() { - QuoteStyle::from(quote.opposite()) - } else { - QuoteStyle::Double - } - } else { - preferred_quote_style + // An f-string expression that contains a triple quoted string literal + // expression that contains a quote. + if is_fstring_with_triple_quoted_literal_expression_containing_quotes( + fstring, + self.context, + ) { + return QuoteStyle::Preserve; } } + + // An f-string expression element contains a debug text and the corresponding + // format specifier has a literal element with a quote character. + if is_fstring_with_quoted_format_spec_and_debug(fstring, self.context) { + return QuoteStyle::Preserve; + } + } + + // Per PEP 8, always prefer double quotes for triple-quoted strings. + if string.flags().is_triple_quoted() { + // ... unless we're formatting a code snippet inside a docstring, + // then we specifically want to invert our quote style to avoid + // writing out invalid Python. + // + // It's worth pointing out that we can actually wind up being + // somewhat out of sync with PEP8 in this case. Consider this + // example: + // + // def foo(): + // ''' + // Something. + // + // >>> """tricksy""" + // ''' + // pass + // + // Ideally, this would be reformatted as: + // + // def foo(): + // """ + // Something. + // + // >>> '''tricksy''' + // """ + // pass + // + // But the logic here results in the original quoting being + // preserved. This is because the quoting style of the outer + // docstring is determined, in part, by looking at its contents. In + // this case, it notices that it contains a `"""` and thus infers + // that using `'''` would overall read better because it avoids + // the need to escape the interior `"""`. Except... in this case, + // the `"""` is actually part of a code snippet that could get + // reformatted to using a different quoting style itself. + // + // Fixing this would, I believe, require some fairly seismic + // changes to how formatting strings works. Namely, we would need + // to look for code snippets before normalizing the docstring, and + // then figure out the quoting style more holistically by looking + // at the various kinds of quotes used in the code snippets and + // what reformatting them might look like. + // + // Overall this is a bit of a corner case and just inverting the + // style from what the parent ultimately decided upon works, even + // if it doesn't have perfect alignment with PEP8. + if let Some(quote) = self.context.docstring() { + QuoteStyle::from(quote.opposite()) + } else { + QuoteStyle::Double + } + } else { + preferred_quote_style } } @@ -155,7 +158,7 @@ impl<'a, 'src> StringNormalizer<'a, 'src> { let raw_content = &self.context.source()[string.content_range()]; let first_quote_or_normalized_char_offset = raw_content .bytes() - .position(|b| matches!(b, b'\\' | b'"' | b'\'' | b'\r' | b'{')); + .position(|b| matches!(b, b'\\' | b'"' | b'\'' | b'\r')); let string_flags = string.flags(); let preferred_style = self.preferred_quote_style(string); @@ -206,11 +209,7 @@ impl<'a, 'src> StringNormalizer<'a, 'src> { raw_content, first_quote_or_escape_offset, quote_selection.flags, - // TODO: Remove the `b'{'` in `choose_quotes` when promoting the - // `format_fstring` preview style - false, false, - is_f_string_formatting_enabled(self.context), ) } else { Cow::Borrowed(raw_content) @@ -261,50 +260,21 @@ impl QuoteMetadata { Self::from_str(text, part.flags(), preferred_quote) } StringLikePart::FString(fstring) => { - if is_f_string_formatting_enabled(context) { - // For f-strings, only consider the quotes inside string-literals but ignore - // quotes inside expressions. This allows both the outer and the nested literals - // to make the optimal local-choice to reduce the total number of quotes necessary. - // This doesn't require any pre 312 special handling because an expression - // can never contain the outer quote character, not even escaped: - // ```python - // f"{'escaping a quote like this \" is a syntax error pre 312'}" - // ``` - let mut literals = fstring.elements.literals(); - - let Some(first) = literals.next() else { - return QuoteMetadata::from_str("", part.flags(), preferred_quote); - }; - - let mut metadata = QuoteMetadata::from_str( - context.source().slice(first), - fstring.flags.into(), - preferred_quote, - ); - - for literal in literals { - metadata = metadata - .merge(&QuoteMetadata::from_str( - context.source().slice(literal), - fstring.flags.into(), - preferred_quote, - )) - .expect("Merge to succeed because all parts have the same flags"); - } - - metadata - } else { - let text = &context.source()[part.content_range()]; - - Self::from_str(text, part.flags(), preferred_quote) - } + let metadata = QuoteMetadata::from_str("", part.flags(), preferred_quote); + + metadata.merge_fstring_elements( + &fstring.elements, + fstring.flags, + context, + preferred_quote, + ) } } } pub(crate) fn from_str(text: &str, flags: AnyStringFlags, preferred_quote: Quote) -> Self { let kind = if flags.is_raw_string() { - QuoteMetadataKind::raw(text, preferred_quote, flags.is_triple_quoted()) + QuoteMetadataKind::raw(text, preferred_quote, flags.triple_quotes()) } else if flags.is_triple_quoted() { QuoteMetadataKind::triple_quoted(text, preferred_quote) } else { @@ -398,6 +368,52 @@ impl QuoteMetadata { source_style: self.source_style, }) } + + /// For f-strings, only consider the quotes inside string-literals but ignore + /// quotes inside expressions (except inside the format spec). This allows both the outer and the nested literals + /// to make the optimal local-choice to reduce the total number of quotes necessary. + /// This doesn't require any pre 312 special handling because an expression + /// can never contain the outer quote character, not even escaped: + /// ```python + /// f"{'escaping a quote like this \" is a syntax error pre 312'}" + /// ``` + fn merge_fstring_elements( + self, + elements: &FStringElements, + flags: FStringFlags, + context: &PyFormatContext, + preferred_quote: Quote, + ) -> Self { + let mut merged = self; + + for element in elements { + match element { + FStringElement::Literal(literal) => { + merged = merged + .merge(&QuoteMetadata::from_str( + context.source().slice(literal), + flags.into(), + preferred_quote, + )) + .expect("Merge to succeed because all parts have the same flags"); + } + FStringElement::Expression(expression) => { + if let Some(spec) = expression.format_spec.as_deref() { + if expression.debug_text.is_none() { + merged = merged.merge_fstring_elements( + &spec.elements, + flags, + context, + preferred_quote, + ); + } + } + } + } + } + + merged + } } #[derive(Copy, Clone, Debug)] @@ -513,7 +529,7 @@ impl QuoteMetadataKind { /// Computes if a raw string uses the preferred quote. If it does, then it's not possible /// to change the quote style because it would require escaping which isn't possible in raw strings. - fn raw(text: &str, preferred: Quote, triple_quoted: bool) -> Self { + fn raw(text: &str, preferred: Quote, triple_quotes: TripleQuotes) -> Self { let mut chars = text.chars().peekable(); let preferred_quote_char = preferred.as_char(); @@ -525,7 +541,7 @@ impl QuoteMetadataKind { } // `"` or `'` Some(c) if c == preferred_quote_char => { - if !triple_quoted { + if triple_quotes.is_no() { break true; } @@ -604,8 +620,6 @@ pub(crate) fn normalize_string( start_offset: usize, new_flags: AnyStringFlags, escape_braces: bool, - flip_nested_fstring_quotes: bool, - format_f_string: bool, ) -> Cow<str> { // The normalized string if `input` is not yet normalized. // `output` must remain empty if `input` is already normalized. @@ -622,9 +636,6 @@ pub(crate) fn normalize_string( let is_raw = new_flags.is_raw_string(); - let is_fstring = !format_f_string && new_flags.is_f_string(); - let mut formatted_value_nesting = 0u32; - while let Some((index, c)) = chars.next() { if matches!(c, '{' | '}') { if escape_braces { @@ -633,17 +644,6 @@ pub(crate) fn normalize_string( output.push(c); last_index = index + c.len_utf8(); continue; - } else if is_fstring { - if chars.peek().copied().is_some_and(|(_, next)| next == c) { - // Skip over the second character of the double braces - chars.next(); - } else if c == '{' { - formatted_value_nesting += 1; - } else { - // Safe to assume that `c == '}'` here because of the matched pattern above - formatted_value_nesting = formatted_value_nesting.saturating_sub(1); - } - continue; } } @@ -679,7 +679,7 @@ pub(crate) fn normalize_string( output.push_str(&input[last_index..escape_start_offset]); output.push_str(normalised); last_index = escape_start_offset + normalised.len(); - }; + } // Move the `chars` iterator passed the escape sequence. // Simply reassigning `chars` doesn't work because the indices` would @@ -691,8 +691,7 @@ pub(crate) fn normalize_string( } if !new_flags.is_triple_quoted() { - #[allow(clippy::if_same_then_else)] - if next == opposite_quote && formatted_value_nesting == 0 { + if next == opposite_quote { // Remove the escape by ending before the backslash and starting again with the quote chars.next(); output.push_str(&input[last_index..index]); @@ -703,23 +702,12 @@ pub(crate) fn normalize_string( } } } - } else if !new_flags.is_triple_quoted() - && c == preferred_quote - && formatted_value_nesting == 0 - { + } else if !new_flags.is_triple_quoted() && c == preferred_quote { // Escape the quote output.push_str(&input[last_index..index]); output.push('\\'); output.push(c); last_index = index + preferred_quote.len_utf8(); - } else if c == preferred_quote - && flip_nested_fstring_quotes - && formatted_value_nesting > 0 - { - // Flip the quotes - output.push_str(&input[last_index..index]); - output.push(opposite_quote); - last_index = index + preferred_quote.len_utf8(); } } } @@ -747,7 +735,7 @@ impl<'str> CharIndicesWithOffset<'str> { } } -impl<'str> Iterator for CharIndicesWithOffset<'str> { +impl Iterator for CharIndicesWithOffset<'_> { type Item = (usize, char); fn next(&mut self) -> Option<Self::Item> { @@ -891,33 +879,66 @@ pub(super) fn is_fstring_with_quoted_debug_expression( fstring: &FString, context: &PyFormatContext, ) -> bool { - if fstring.elements.expressions().any(|expression| { + fstring.elements.expressions().any(|expression| { if expression.debug_text.is_some() { let content = context.source().slice(expression); - match fstring.flags.quote_style() { - Quote::Single => { - if fstring.flags.is_triple_quoted() { - content.contains(r#"""""#) - } else { - content.contains('"') - } - } - Quote::Double => { - if fstring.flags.is_triple_quoted() { - content.contains("'''") - } else { - content.contains('\'') - } - } - } + contains_opposite_quote(content, fstring.flags.into()) } else { false } - }) { - return true; + }) +} + +/// Returns `true` if `string` has any f-string expression element (direct or nested) with a debug expression and a format spec +/// that contains the opposite quote. It's important to preserve the quote style for those f-strings +/// because changing the quote style would result in invalid syntax. +/// +/// ```python +/// f'{1=: "abcd \'\'}' +/// f'{x=:a{y:"abcd"}}' +/// f'{x=:a{y:{z:"abcd"}}}' +/// ``` +pub(super) fn is_fstring_with_quoted_format_spec_and_debug( + fstring: &FString, + context: &PyFormatContext, +) -> bool { + fn has_format_spec_with_opposite_quote( + elements: &FStringElements, + flags: FStringFlags, + context: &PyFormatContext, + in_debug: bool, + ) -> bool { + elements.iter().any(|element| match element { + FStringElement::Literal(literal) => { + let content = context.source().slice(literal); + + in_debug && contains_opposite_quote(content, flags.into()) + } + FStringElement::Expression(expression) => { + expression.format_spec.as_deref().is_some_and(|spec| { + has_format_spec_with_opposite_quote( + &spec.elements, + flags, + context, + in_debug || expression.debug_text.is_some(), + ) + }) + } + }) } - false + fstring.elements.expressions().any(|expression| { + if let Some(spec) = expression.format_spec.as_deref() { + return has_format_spec_with_opposite_quote( + &spec.elements, + fstring.flags, + context, + expression.debug_text.is_some(), + ); + } + + false + }) } /// Tests if the `fstring` contains any triple quoted string, byte, or f-string literal that @@ -997,15 +1018,48 @@ pub(super) fn is_fstring_with_triple_quoted_literal_expression_containing_quotes visitor.found } +fn contains_opposite_quote(content: &str, flags: AnyStringFlags) -> bool { + if flags.is_triple_quoted() { + match flags.quote_style() { + Quote::Single => content.contains(r#"""""#), + Quote::Double => content.contains("'''"), + } + } else { + let mut rest = content; + + while let Some(index) = rest.find(flags.quote_style().opposite().as_char()) { + // Quotes in raw strings can't be escaped + if flags.is_raw_string() { + return true; + } + + // Only if the quote isn't escaped + if rest[..index] + .chars() + .rev() + .take_while(|c| *c == '\\') + .count() + % 2 + == 0 + { + return true; + } + + rest = &rest[index + flags.quote_style().opposite().as_char().len_utf8()..]; + } + + false + } +} + #[cfg(test)] mod tests { use std::borrow::Cow; - use ruff_python_ast::str_prefix::FStringPrefix; use ruff_python_ast::{ - str::Quote, - str_prefix::{AnyStringPrefix, ByteStringPrefix}, AnyStringFlags, + str::{Quote, TripleQuotes}, + str_prefix::{AnyStringPrefix, ByteStringPrefix}, }; use crate::string::normalize_string; @@ -1032,37 +1086,11 @@ mod tests { AnyStringFlags::new( AnyStringPrefix::Bytes(ByteStringPrefix::Regular), Quote::Double, - false, + TripleQuotes::No, ), false, - false, - true, ); assert_eq!(r"\x89\x50\x4e\x47\x0d\x0a\x1a\x0a", &normalized); } - - #[test] - fn normalize_nested_fstring() { - let input = - r#"With single quote: ' {my_dict['foo']} With double quote: " {my_dict["bar"]}"#; - - let normalized = normalize_string( - input, - 0, - AnyStringFlags::new( - AnyStringPrefix::Format(FStringPrefix::Regular), - Quote::Double, - false, - ), - false, - true, - false, - ); - - assert_eq!( - "With single quote: ' {my_dict['foo']} With double quote: \\\" {my_dict['bar']}", - &normalized - ); - } } diff --git a/crates/ruff_python_formatter/src/type_param/type_params.rs b/crates/ruff_python_formatter/src/type_param/type_params.rs index 8743fb46b8d22..e243dc600657f 100644 --- a/crates/ruff_python_formatter/src/type_param/type_params.rs +++ b/crates/ruff_python_formatter/src/type_param/type_params.rs @@ -1,5 +1,4 @@ use ruff_formatter::FormatResult; -use ruff_python_ast::AstNode; use ruff_python_ast::TypeParams; use ruff_text_size::Ranged; @@ -21,7 +20,7 @@ impl FormatNodeRule<TypeParams> for FormatTypeParams { // c, // ] = ... let comments = f.context().comments().clone(); - let dangling_comments = comments.dangling(item.as_any_node_ref()); + let dangling_comments = comments.dangling(item); let items = format_with(|f| { f.join_comma_separated(item.end()) diff --git a/crates/ruff_python_formatter/src/verbatim.rs b/crates/ruff_python_formatter/src/verbatim.rs index 942eda70c859d..98022572485d9 100644 --- a/crates/ruff_python_formatter/src/verbatim.rs +++ b/crates/ruff_python_formatter/src/verbatim.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use std::iter::FusedIterator; use std::slice::Iter; -use ruff_formatter::{write, FormatError}; +use ruff_formatter::{FormatError, write}; use ruff_python_ast::AnyNodeRef; use ruff_python_ast::Stmt; use ruff_python_parser::{self as parser, TokenKind}; @@ -11,7 +11,7 @@ use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; use crate::comments::format::{empty_lines, format_comment}; -use crate::comments::{leading_comments, trailing_comments, SourceComment}; +use crate::comments::{SourceComment, leading_comments, trailing_comments}; use crate::prelude::*; use crate::statement::clause::ClauseHeader; use crate::statement::suite::SuiteChildStatement; @@ -478,7 +478,7 @@ enum SuppressionComments<'a> { /// Any following `fmt: off` comment if any. /// * `None`: The suppression ends here (for good) /// * `Some`: A `fmt: off`..`fmt: on` .. `fmt: off` sequence. The suppression continues after - /// the `fmt: off` comment. + /// the `fmt: off` comment. format_off_comment: Option<&'a SourceComment>, }, @@ -487,7 +487,7 @@ enum SuppressionComments<'a> { /// Comments that all fall into the formatted range. Formatted { - #[allow(unused)] + #[expect(unused)] comments: &'a [SourceComment], }, } @@ -787,7 +787,7 @@ impl<'a> LogicalLinesIter<'a> { } } -impl<'a> Iterator for LogicalLinesIter<'a> { +impl Iterator for LogicalLinesIter<'_> { type Item = FormatResult<LogicalLine>; fn next(&mut self) -> Option<Self::Item> { @@ -798,13 +798,13 @@ impl<'a> Iterator for LogicalLinesIter<'a> { Some(token) if token.kind() == TokenKind::Unknown => { return Some(Err(FormatError::syntax_error( "Unexpected token when lexing verbatim statement range.", - ))) + ))); } Some(token) => match token.kind() { TokenKind::Newline => break (token.start(), token.end()), // Ignore if inside an expression TokenKind::NonLogicalNewline if parens == 0 => { - break (token.start(), token.end()) + break (token.start(), token.end()); } TokenKind::Lbrace | TokenKind::Lpar | TokenKind::Lsqb => { parens = parens.saturating_add(1); @@ -841,7 +841,7 @@ impl<'a> Iterator for LogicalLinesIter<'a> { } } -impl<'a> FusedIterator for LogicalLinesIter<'a> {} +impl FusedIterator for LogicalLinesIter<'_> {} /// A logical line or a comment (or form feed only) line struct LogicalLine { diff --git a/crates/ruff_python_formatter/tests/fixtures.rs b/crates/ruff_python_formatter/tests/fixtures.rs index 0c4da466eeaf1..7a42e93c52e92 100644 --- a/crates/ruff_python_formatter/tests/fixtures.rs +++ b/crates/ruff_python_formatter/tests/fixtures.rs @@ -1,20 +1,22 @@ +use crate::normalizer::Normalizer; +use itertools::Itertools; +use ruff_formatter::FormatOptions; +use ruff_python_ast::comparable::ComparableMod; +use ruff_python_formatter::{PreviewMode, PyFormatOptions, format_module_source, format_range}; +use ruff_python_parser::{ParseOptions, UnsupportedSyntaxError, parse}; +use ruff_source_file::{LineIndex, OneIndexed}; +use ruff_text_size::{Ranged, TextRange, TextSize}; +use rustc_hash::FxHashMap; +use similar::TextDiff; use std::borrow::Cow; +use std::collections::hash_map::Entry; use std::fmt::{Formatter, Write}; +use std::hash::{DefaultHasher, Hash, Hasher}; use std::io::BufReader; use std::ops::Range; use std::path::Path; use std::{fmt, fs}; -use similar::TextDiff; - -use crate::normalizer::Normalizer; -use ruff_formatter::FormatOptions; -use ruff_python_ast::comparable::ComparableMod; -use ruff_python_formatter::{format_module_source, format_range, PreviewMode, PyFormatOptions}; -use ruff_python_parser::{parse, AsMode}; -use ruff_source_file::{LineIndex, OneIndexed}; -use ruff_text_size::{TextRange, TextSize}; - mod normalizer; #[test] @@ -26,8 +28,9 @@ fn black_compatibility() { let options: PyFormatOptions = if let Ok(options_file) = fs::File::open(&options_path) { let reader = BufReader::new(options_file); - serde_json::from_reader(reader) - .unwrap_or_else(|_| panic!("Option file {options_path:?} to be a valid Json file")) + serde_json::from_reader(reader).unwrap_or_else(|_| { + panic!("Expected option file {options_path:?} to be a valid Json file") + }) } else { PyFormatOptions::from_extension(input_path) }; @@ -177,16 +180,15 @@ fn format() { let test_file = |input_path: &Path| { let content = fs::read_to_string(input_path).unwrap(); - let options = PyFormatOptions::from_extension(input_path); - let formatted_code = format_file(&content, &options, input_path); - let mut snapshot = format!("## Input\n{}", CodeFrame::new("python", &content)); - let options_path = input_path.with_extension("options.json"); - if let Ok(options_file) = fs::File::open(options_path) { + + if let Ok(options_file) = fs::File::open(&options_path) { let reader = BufReader::new(options_file); let options: Vec<PyFormatOptions> = - serde_json::from_reader(reader).expect("Options to be a valid Json file"); + serde_json::from_reader(reader).unwrap_or_else(|_| { + panic!("Expected option file {options_path:?} to be a valid Json file") + }); writeln!(snapshot, "## Outputs").unwrap(); @@ -228,6 +230,9 @@ fn format() { } } else { // We want to capture the differences in the preview style in our fixtures + let options = PyFormatOptions::from_extension(input_path); + let formatted_code = format_file(&content, &options, input_path); + let options_preview = options.with_preview(PreviewMode::Enabled); let formatted_preview = format_file(&content, &options_preview, input_path); @@ -376,7 +381,7 @@ Formatted twice: } } -/// Ensure that formatting doesn't change the AST. +/// Ensure that formatting doesn't change the AST and doesn't introduce any new unsupported syntax errors. /// /// Like Black, there are a few exceptions to this "invariant" which are encoded in /// [`NormalizedMod`] and related structs. Namely, formatting can change indentation within strings, @@ -390,16 +395,53 @@ fn ensure_unchanged_ast( let source_type = options.source_type(); // Parse the unformatted code. - let mut unformatted_ast = parse(unformatted_code, source_type.as_mode()) - .expect("Unformatted code to be valid syntax") - .into_syntax(); + let unformatted_parsed = parse( + unformatted_code, + ParseOptions::from(source_type).with_target_version(options.target_version()), + ) + .expect("Unformatted code to be valid syntax"); + + let unformatted_unsupported_syntax_errors = + collect_unsupported_syntax_errors(unformatted_parsed.unsupported_syntax_errors()); + let mut unformatted_ast = unformatted_parsed.into_syntax(); + Normalizer.visit_module(&mut unformatted_ast); let unformatted_ast = ComparableMod::from(&unformatted_ast); // Parse the formatted code. - let mut formatted_ast = parse(formatted_code, source_type.as_mode()) - .expect("Formatted code to be valid syntax") - .into_syntax(); + let formatted_parsed = parse( + formatted_code, + ParseOptions::from(source_type).with_target_version(options.target_version()), + ) + .expect("Formatted code to be valid syntax"); + + // Assert that there are no new unsupported syntax errors + let mut formatted_unsupported_syntax_errors = + collect_unsupported_syntax_errors(formatted_parsed.unsupported_syntax_errors()); + + formatted_unsupported_syntax_errors + .retain(|fingerprint, _| !unformatted_unsupported_syntax_errors.contains_key(fingerprint)); + + if !formatted_unsupported_syntax_errors.is_empty() { + let index = LineIndex::from_source_text(formatted_code); + panic!( + "Formatted code `{}` introduced new unsupported syntax errors:\n---\n{}\n---", + input_path.display(), + formatted_unsupported_syntax_errors + .into_values() + .map(|error| { + let location = index.line_column(error.start(), formatted_code); + format!( + "{row}:{col} {error}", + row = location.line, + col = location.column + ) + }) + .join("\n") + ); + } + + let mut formatted_ast = formatted_parsed.into_syntax(); Normalizer.visit_module(&mut formatted_ast); let formatted_ast = ComparableMod::from(&formatted_ast); @@ -473,7 +515,7 @@ magic-trailing-comma = {magic_trailing_comma:?} docstring-code = {docstring_code:?} docstring-code-line-width = {docstring_code_line_width:?} preview = {preview:?} -target_version = {target_version:?} +target_version = {target_version} source_type = {source_type:?}"#, indent_style = self.0.indent_style(), indent_width = self.0.indent_width().value(), @@ -489,3 +531,49 @@ source_type = {source_type:?}"#, ) } } + +/// Collects the unsupported syntax errors and assigns a unique hash to each error. +fn collect_unsupported_syntax_errors( + errors: &[UnsupportedSyntaxError], +) -> FxHashMap<u64, UnsupportedSyntaxError> { + let mut collected = FxHashMap::default(); + + for error in errors { + let mut error_fingerprint = fingerprint_unsupported_syntax_error(error, 0); + + // Make sure that we do not get a fingerprint that is already in use + // by adding in the previously generated one. + loop { + match collected.entry(error_fingerprint) { + Entry::Occupied(_) => { + error_fingerprint = + fingerprint_unsupported_syntax_error(error, error_fingerprint); + } + Entry::Vacant(entry) => { + entry.insert(error.clone()); + break; + } + } + } + } + + collected +} + +fn fingerprint_unsupported_syntax_error(error: &UnsupportedSyntaxError, salt: u64) -> u64 { + let mut hasher = DefaultHasher::new(); + + let UnsupportedSyntaxError { + kind, + target_version, + // Don't hash the range because the location between the formatted and unformatted code + // is likely to be different + range: _, + } = error; + + salt.hash(&mut hasher); + kind.hash(&mut hasher); + target_version.hash(&mut hasher); + + hasher.finish() +} diff --git a/crates/ruff_python_formatter/tests/normalizer.rs b/crates/ruff_python_formatter/tests/normalizer.rs index b83a8cee0c35b..2786082cfefd7 100644 --- a/crates/ruff_python_formatter/tests/normalizer.rs +++ b/crates/ruff_python_formatter/tests/normalizer.rs @@ -4,12 +4,12 @@ use { regex::Regex, }; -use ruff_python_ast::visitor::transformer; use ruff_python_ast::visitor::transformer::Transformer; use ruff_python_ast::{ self as ast, BytesLiteralFlags, Expr, FStringElement, FStringFlags, FStringLiteralElement, - FStringPart, Stmt, StringFlags, StringLiteralFlags, + FStringPart, Stmt, StringFlags, }; +use ruff_python_ast::{StringLiteralFlags, visitor::transformer}; use ruff_text_size::{Ranged, TextRange}; /// A struct to normalize AST nodes for the purpose of comparing formatted representations for @@ -79,9 +79,9 @@ impl Transformer for Normalizer { if can_join { string.value = ast::StringLiteralValue::single(ast::StringLiteral { - value: string.value.to_str().to_string().into_boxed_str(), + value: Box::from(string.value.to_str()), range: string.range, - flags: StringLiteralFlags::default(), + flags: StringLiteralFlags::empty(), }); } } @@ -97,7 +97,7 @@ impl Transformer for Normalizer { bytes.value = ast::BytesLiteralValue::single(ast::BytesLiteral { value: bytes.value.bytes().collect(), range: bytes.range, - flags: BytesLiteralFlags::default(), + flags: BytesLiteralFlags::empty(), }); } } @@ -181,7 +181,7 @@ impl Transformer for Normalizer { fstring.value = ast::FStringValue::single(ast::FString { elements: collector.elements.into(), range: fstring.range, - flags: FStringFlags::default(), + flags: FStringFlags::empty(), }); } } diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__allow_empty_first_line.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__allow_empty_first_line.py.snap index 4931cdf636af8..570ca11b2956b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__allow_empty_first_line.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__allow_empty_first_line.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/allow_empty_first_line.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__backslash_before_indent.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__backslash_before_indent.py.snap index f00bd36029330..89cae6545b7ee 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__backslash_before_indent.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__backslash_before_indent.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/backslash_before_indent.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__class_blank_parentheses.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__class_blank_parentheses.py.snap index 2ad0c329cfbef..391c1c06049fd 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__class_blank_parentheses.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__class_blank_parentheses.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/class_blank_parentheses.py +snapshot_kind: text --- ## Input @@ -115,5 +116,3 @@ class NormalClass: sum = first + second return sum ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comment_after_escaped_newline.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comment_after_escaped_newline.py.snap index 9d7369e3f1904..1e219b56306c8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comment_after_escaped_newline.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comment_after_escaped_newline.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comment_after_escaped_newline.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments2.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments2.py.snap index 941cb240fac8a..44b7651d1b723 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments2.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comments2.py +snapshot_kind: text --- ## Input @@ -613,5 +614,3 @@ instruction() # comment with bad spacing # END COMMENTS # MORE END COMMENTS ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments6.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments6.py.snap index f1bc3b617373d..f91b33c700785 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments6.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments6.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comments6.py +snapshot_kind: text --- ## Input @@ -435,5 +436,3 @@ call_to_some_function_asdf( aaaaaaaaaaaaa, bbbbbbbbb = map(list, map(itertools.chain.from_iterable, zip(*items))) # type: ignore[arg-type] ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments9.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments9.py.snap index 85d3044bacef4..01992d7f8ad69 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments9.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments9.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comments9.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_blocks.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_blocks.py.snap index 7524d7c7a7717..c2f3898b2f92d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_blocks.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_blocks.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comments_in_blocks.py +snapshot_kind: text --- ## Input @@ -378,5 +379,3 @@ if ( ): print("Foo") ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_double_parens.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_double_parens.py.snap index a60996419c422..6253b7309fbb5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_double_parens.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__comments_in_double_parens.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/comments_in_double_parens.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition.py.snap index c1c42e11bbb3d..17b2ace0e4947 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/composition.py +snapshot_kind: text --- ## Input @@ -193,41 +194,7 @@ class C: ```diff --- Black +++ Ruff -@@ -110,19 +110,20 @@ - value, is_going_to_be="too long to fit in a single line", srsly=True - ), "Not what we expected" - -- assert { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } == expected, ( -- "Not what we expected and the message is too long to fit in one line" -- ) -+ assert ( -+ { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ } -+ == expected -+ ), "Not what we expected and the message is too long to fit in one line" - - assert expected( - value, is_going_to_be="too long to fit in a single line", srsly=True -@@ -161,9 +162,7 @@ +@@ -161,9 +161,7 @@ 8 STORE_ATTR 0 (x) 10 LOAD_CONST 0 (None) 12 RETURN_VALUE @@ -355,20 +322,19 @@ class C: value, is_going_to_be="too long to fit in a single line", srsly=True ), "Not what we expected" - assert ( - { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - == expected - ), "Not what we expected and the message is too long to fit in one line" + assert { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + } == expected, ( + "Not what we expected and the message is too long to fit in one line" + ) assert expected( value, is_going_to_be="too long to fit in a single line", srsly=True @@ -610,5 +576,3 @@ class C: } ) ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition_no_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition_no_trailing_comma.py.snap index 6a9570acf64ef..b49c9b9f6d105 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition_no_trailing_comma.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__composition_no_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/composition_no_trailing_comma.py +snapshot_kind: text --- ## Input @@ -193,41 +194,7 @@ class C: ```diff --- Black +++ Ruff -@@ -110,19 +110,20 @@ - value, is_going_to_be="too long to fit in a single line", srsly=True - ), "Not what we expected" - -- assert { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } == expected, ( -- "Not what we expected and the message is too long to fit in one line" -- ) -+ assert ( -+ { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ } -+ == expected -+ ), "Not what we expected and the message is too long to fit in one line" - - assert expected( - value, is_going_to_be="too long to fit in a single line", srsly=True -@@ -161,9 +162,7 @@ +@@ -161,9 +161,7 @@ 8 STORE_ATTR 0 (x) 10 LOAD_CONST 0 (None) 12 RETURN_VALUE @@ -355,20 +322,19 @@ class C: value, is_going_to_be="too long to fit in a single line", srsly=True ), "Not what we expected" - assert ( - { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - == expected - ), "Not what we expected and the message is too long to fit in one line" + assert { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + } == expected, ( + "Not what we expected and the message is too long to fit in one line" + ) assert expected( value, is_going_to_be="too long to fit in a single line", srsly=True diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__conditional_expression.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__conditional_expression.py.snap index 87ff831191008..9375616352049 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__conditional_expression.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__conditional_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/conditional_expression.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_39.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_39.py.snap deleted file mode 100644 index bda34193b2dc0..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_39.py.snap +++ /dev/null @@ -1,340 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_39.py ---- -## Input - -```python -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -# Leading comment -with \ - make_context_manager1() as cm1, \ - make_context_manager2(), \ - make_context_manager3() as cm3, \ - make_context_manager4() \ -: - pass - - -with \ - new_new_new1() as cm1, \ - new_new_new2() \ -: - pass - - -with ( - new_new_new1() as cm1, - new_new_new2() -): - pass - - -# Leading comment. -with ( - # First comment. - new_new_new1() as cm1, - # Second comment. - new_new_new2() - # Last comment. -): - pass - - -with \ - this_is_a_very_long_call(looong_arg1=looong_value1, looong_arg2=looong_value2) as cm1, \ - this_is_a_very_long_call(looong_arg1=looong_value1, looong_arg2=looong_value2, looong_arg3=looong_value3, looong_arg4=looong_value4) as cm2 \ -: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass - - -with xxxxxxxx.some_kind_of_method( - some_argument=[ - "first", - "second", - "third", - ] -).another_method() as cmd: - pass - - -async def func(): - async with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ - : - pass - - async with some_function( - argument1, argument2, argument3="some_value" - ) as some_cm, some_other_function( - argument1, argument2, argument3="some_value" - ): - pass -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,19 +1,9 @@ --with ( -- make_context_manager1() as cm1, -- make_context_manager2() as cm2, -- make_context_manager3() as cm3, -- make_context_manager4() as cm4, --): -+with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - - # Leading comment --with ( -- make_context_manager1() as cm1, -- make_context_manager2(), -- make_context_manager3() as cm3, -- make_context_manager4(), --): -+with make_context_manager1() as cm1, make_context_manager2(), make_context_manager3() as cm3, make_context_manager4(): - pass - - -@@ -36,25 +26,21 @@ - pass - - --with ( -- this_is_a_very_long_call( -- looong_arg1=looong_value1, looong_arg2=looong_value2 -- ) as cm1, -- this_is_a_very_long_call( -- looong_arg1=looong_value1, -- looong_arg2=looong_value2, -- looong_arg3=looong_value3, -- looong_arg4=looong_value4, -- ) as cm2, --): -+with this_is_a_very_long_call( -+ looong_arg1=looong_value1, looong_arg2=looong_value2 -+) as cm1, this_is_a_very_long_call( -+ looong_arg1=looong_value1, -+ looong_arg2=looong_value2, -+ looong_arg3=looong_value3, -+ looong_arg4=looong_value4, -+) as cm2: - pass - - --with ( -- mock.patch.object(self.my_runner, "first_method", autospec=True) as mock_run_adb, -- mock.patch.object( -- self.my_runner, "second_method", autospec=True, return_value="foo" -- ), -+with mock.patch.object( -+ self.my_runner, "first_method", autospec=True -+) as mock_run_adb, mock.patch.object( -+ self.my_runner, "second_method", autospec=True, return_value="foo" - ): - pass - -@@ -70,16 +56,10 @@ - - - async def func(): -- async with ( -- make_context_manager1() as cm1, -- make_context_manager2() as cm2, -- make_context_manager3() as cm3, -- make_context_manager4() as cm4, -- ): -+ async with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - -- async with ( -- some_function(argument1, argument2, argument3="some_value") as some_cm, -- some_other_function(argument1, argument2, argument3="some_value"), -- ): -+ async with some_function( -+ argument1, argument2, argument3="some_value" -+ ) as some_cm, some_other_function(argument1, argument2, argument3="some_value"): - pass -``` - -## Ruff Output - -```python -with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - -# Leading comment -with make_context_manager1() as cm1, make_context_manager2(), make_context_manager3() as cm3, make_context_manager4(): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -# Leading comment. -with ( - # First comment. - new_new_new1() as cm1, - # Second comment. - new_new_new2(), - # Last comment. -): - pass - - -with this_is_a_very_long_call( - looong_arg1=looong_value1, looong_arg2=looong_value2 -) as cm1, this_is_a_very_long_call( - looong_arg1=looong_value1, - looong_arg2=looong_value2, - looong_arg3=looong_value3, - looong_arg4=looong_value4, -) as cm2: - pass - - -with mock.patch.object( - self.my_runner, "first_method", autospec=True -) as mock_run_adb, mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" -): - pass - - -with xxxxxxxx.some_kind_of_method( - some_argument=[ - "first", - "second", - "third", - ] -).another_method() as cmd: - pass - - -async def func(): - async with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - async with some_function( - argument1, argument2, argument3="some_value" - ) as some_cm, some_other_function(argument1, argument2, argument3="some_value"): - pass -``` - -## Black Output - -```python -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass - - -# Leading comment -with ( - make_context_manager1() as cm1, - make_context_manager2(), - make_context_manager3() as cm3, - make_context_manager4(), -): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass - - -# Leading comment. -with ( - # First comment. - new_new_new1() as cm1, - # Second comment. - new_new_new2(), - # Last comment. -): - pass - - -with ( - this_is_a_very_long_call( - looong_arg1=looong_value1, looong_arg2=looong_value2 - ) as cm1, - this_is_a_very_long_call( - looong_arg1=looong_value1, - looong_arg2=looong_value2, - looong_arg3=looong_value3, - looong_arg4=looong_value4, - ) as cm2, -): - pass - - -with ( - mock.patch.object(self.my_runner, "first_method", autospec=True) as mock_run_adb, - mock.patch.object( - self.my_runner, "second_method", autospec=True, return_value="foo" - ), -): - pass - - -with xxxxxxxx.some_kind_of_method( - some_argument=[ - "first", - "second", - "third", - ] -).another_method() as cmd: - pass - - -async def func(): - async with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, - ): - pass - - async with ( - some_function(argument1, argument2, argument3="some_value") as some_cm, - some_other_function(argument1, argument2, argument3="some_value"), - ): - pass -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_autodetect_39.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_autodetect_39.py.snap deleted file mode 100644 index c6ec010b2ad8f..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__context_managers_autodetect_39.py.snap +++ /dev/null @@ -1,79 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/context_managers_autodetect_39.py ---- -## Input - -```python -# This file uses parenthesized context managers introduced in Python 3.9. - - -with \ - make_context_manager1() as cm1, \ - make_context_manager2() as cm2, \ - make_context_manager3() as cm3, \ - make_context_manager4() as cm4 \ -: - pass - - -with ( - new_new_new1() as cm1, - new_new_new2() -): - pass -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,12 +1,7 @@ - # This file uses parenthesized context managers introduced in Python 3.9. - - --with ( -- make_context_manager1() as cm1, -- make_context_manager2() as cm2, -- make_context_manager3() as cm3, -- make_context_manager4() as cm4, --): -+with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - -``` - -## Ruff Output - -```python -# This file uses parenthesized context managers introduced in Python 3.9. - - -with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4: - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass -``` - -## Black Output - -```python -# This file uses parenthesized context managers introduced in Python 3.9. - - -with ( - make_context_manager1() as cm1, - make_context_manager2() as cm2, - make_context_manager3() as cm3, - make_context_manager4() as cm4, -): - pass - - -with new_new_new1() as cm1, new_new_new2(): - pass -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__docstring_no_string_normalization.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__docstring_no_string_normalization.py.snap index 17915fd54dd78..dbbed9446c222 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__docstring_no_string_normalization.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__docstring_no_string_normalization.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/docstring_no_string_normalization.py +snapshot_kind: text --- ## Input @@ -461,5 +462,3 @@ def multiline_backslash_3(): ''' already escaped \\''' ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__dummy_implementations.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__dummy_implementations.py.snap index c5887596aeebb..126cf40280333 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__dummy_implementations.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__dummy_implementations.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/dummy_implementations.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__empty_lines.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__empty_lines.py.snap index 2ce5876a9512d..5bf19e9b0b865 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__empty_lines.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__empty_lines.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/empty_lines.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__expression.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__expression.py.snap index 5b60337c94cda..428e8065f5ccd 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__expression.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/expression.py +snapshot_kind: text --- ## Input @@ -275,6 +276,19 @@ last_call() ) # note: no trailing comma pre-3.6 call(*gidgets[:2]) call(a, *gidgets[:2]) +@@ -251,9 +251,9 @@ + print(**{1: 3} if False else {x: x for x in range(3)}) + print(*lambda x: x) + assert not Test, "Short message" +-assert this is ComplexTest and not requirements.fit_in_a_single_line( +- force=False +-), "Short message" ++assert this is ComplexTest and not requirements.fit_in_a_single_line(force=False), ( ++ "Short message" ++) + assert parens is TooMany + for (x,) in (1,), (2,), (3,): + ... ``` ## Ruff Output @@ -533,9 +547,9 @@ print(*[] or [1]) print(**{1: 3} if False else {x: x for x in range(3)}) print(*lambda x: x) assert not Test, "Short message" -assert this is ComplexTest and not requirements.fit_in_a_single_line( - force=False -), "Short message" +assert this is ComplexTest and not requirements.fit_in_a_single_line(force=False), ( + "Short message" +) assert parens is TooMany for (x,) in (1,), (2,), (3,): ... @@ -1028,5 +1042,3 @@ bbbb >> bbbb * bbbb last_call() # standalone comment at ENDMARKER ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__f_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__f_docstring.py.snap new file mode 100644 index 0000000000000..d23137efd4d4b --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__f_docstring.py.snap @@ -0,0 +1,66 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/f_docstring.py +--- +## Input + +```python +def foo(e): + f""" {'.'.join(e)}""" + +def bar(e): + f"{'.'.join(e)}" + +def baz(e): + F""" {'.'.join(e)}""" +``` + +## Black Differences + +```diff +--- Black ++++ Ruff +@@ -1,5 +1,5 @@ + def foo(e): +- f""" {'.'.join(e)}""" ++ f""" {".".join(e)}""" + + + def bar(e): +@@ -7,4 +7,4 @@ + + + def baz(e): +- f""" {'.'.join(e)}""" ++ f""" {".".join(e)}""" +``` + +## Ruff Output + +```python +def foo(e): + f""" {".".join(e)}""" + + +def bar(e): + f"{'.'.join(e)}" + + +def baz(e): + f""" {".".join(e)}""" +``` + +## Black Output + +```python +def foo(e): + f""" {'.'.join(e)}""" + + +def bar(e): + f"{'.'.join(e)}" + + +def baz(e): + f""" {'.'.join(e)}""" +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff.py.snap index a14ed936006f5..3b862b14af35a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtonoff.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff4.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff4.py.snap index 9162f859213cc..05bf9bd0bd929 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff4.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff4.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtonoff4.py +snapshot_kind: text --- ## Input @@ -93,5 +94,3 @@ def f(): def f(): pass ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff5.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff5.py.snap index 37aedd195561c..4d5f61df8e168 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff5.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtonoff5.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtonoff5.py +snapshot_kind: text --- ## Input @@ -104,7 +105,7 @@ elif unformatted: - "=foo.bar.:main", - # fmt: on - ] # Includes an formatted indentation. -+ "foo-bar" "=foo.bar.:main", ++ "foo-bar=foo.bar.:main", + # fmt: on + ] # Includes an formatted indentation. }, @@ -128,7 +129,7 @@ setup( entry_points={ # fmt: off "console_scripts": [ - "foo-bar" "=foo.bar.:main", + "foo-bar=foo.bar.:main", # fmt: on ] # Includes an formatted indentation. }, diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtpass_imports.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtpass_imports.py.snap index 6a8042f10d6c1..339b409336676 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtpass_imports.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtpass_imports.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtpass_imports.py +snapshot_kind: text --- ## Input @@ -89,5 +90,3 @@ import sys import tempfile import zoneinfo ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip5.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip5.py.snap index 325b315501abd..5b426a3b86d35 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip5.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip5.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtskip5.py +snapshot_kind: text --- ## Input @@ -59,5 +60,3 @@ if ( else: print("I'm bad") ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip9.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip9.py.snap index bb8af9d4231ab..3479ea65e32c9 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip9.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fmtskip9.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fmtskip9.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__form_feeds.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__form_feeds.py.snap index e6625b01a7e41..183c6a3b53670 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__form_feeds.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__form_feeds.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/form_feeds.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fstring.py.snap new file mode 100644 index 0000000000000..82def26815384 --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__fstring.py.snap @@ -0,0 +1,74 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/fstring.py +--- +## Input + +```python +f"f-string without formatted values is just a string" +f"{{NOT a formatted value}}" +f"{{NOT 'a' \"formatted\" \"value\"}}" +f"some f-string with {a} {few():.2f} {formatted.values!r}" +f'some f-string with {a} {few(""):.2f} {formatted.values!r}' +f"{f'''{'nested'} inner'''} outer" +f"\"{f'{nested} inner'}\" outer" +f"space between opening braces: { {a for a in (1, 2, 3)}}" +f'Hello \'{tricky + "example"}\'' +f"Tried directories {str(rootdirs)} \ +but none started with prefix {parentdir_prefix}" +``` + +## Black Differences + +```diff +--- Black ++++ Ruff +@@ -2,10 +2,10 @@ + f"{{NOT a formatted value}}" + f'{{NOT \'a\' "formatted" "value"}}' + f"some f-string with {a} {few():.2f} {formatted.values!r}" +-f'some f-string with {a} {few(""):.2f} {formatted.values!r}' +-f"{f'''{'nested'} inner'''} outer" +-f"\"{f'{nested} inner'}\" outer" +-f"space between opening braces: { {a for a in (1, 2, 3)}}" +-f'Hello \'{tricky + "example"}\'' ++f"some f-string with {a} {few(''):.2f} {formatted.values!r}" ++f"{f'''{"nested"} inner'''} outer" ++f'"{f"{nested} inner"}" outer' ++f"space between opening braces: { {a for a in (1, 2, 3)} }" ++f"Hello '{tricky + 'example'}'" + f"Tried directories {str(rootdirs)} \ + but none started with prefix {parentdir_prefix}" +``` + +## Ruff Output + +```python +f"f-string without formatted values is just a string" +f"{{NOT a formatted value}}" +f'{{NOT \'a\' "formatted" "value"}}' +f"some f-string with {a} {few():.2f} {formatted.values!r}" +f"some f-string with {a} {few(''):.2f} {formatted.values!r}" +f"{f'''{"nested"} inner'''} outer" +f'"{f"{nested} inner"}" outer' +f"space between opening braces: { {a for a in (1, 2, 3)} }" +f"Hello '{tricky + 'example'}'" +f"Tried directories {str(rootdirs)} \ +but none started with prefix {parentdir_prefix}" +``` + +## Black Output + +```python +f"f-string without formatted values is just a string" +f"{{NOT a formatted value}}" +f'{{NOT \'a\' "formatted" "value"}}' +f"some f-string with {a} {few():.2f} {formatted.values!r}" +f'some f-string with {a} {few(""):.2f} {formatted.values!r}' +f"{f'''{'nested'} inner'''} outer" +f"\"{f'{nested} inner'}\" outer" +f"space between opening braces: { {a for a in (1, 2, 3)}}" +f'Hello \'{tricky + "example"}\'' +f"Tried directories {str(rootdirs)} \ +but none started with prefix {parentdir_prefix}" +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__funcdef_return_type_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__funcdef_return_type_trailing_comma.py.snap index 7266806c08aa3..bb65a5389a083 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__funcdef_return_type_trailing_comma.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__funcdef_return_type_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/funcdef_return_type_trailing_comma.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function.py.snap index 83dfa7e0b8d1d..e9d860a053ed6 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/function.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function2.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function2.py.snap index a9ffd5a3f9a17..74185d8f06b4a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function2.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/function2.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function_trailing_comma.py.snap index 480f37a879e77..0cb75bf9be5fd 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function_trailing_comma.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__function_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/function_trailing_comma.py +snapshot_kind: text --- ## Input @@ -131,6 +132,19 @@ variable: ( ```diff --- Black +++ Ruff +@@ -52,9 +52,9 @@ + pass + + +-def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( +- Set["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"] +-): ++def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ ++ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ++]: + json = { + "k": { + "k2": { @@ -130,9 +130,7 @@ def foo() -> ( @@ -224,9 +238,9 @@ def f( pass -def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( - Set["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"] -): +def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ + "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +]: json = { "k": { "k2": { diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__ignore_pyi.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__ignore_pyi.pyi.snap index 0d405b5b573a2..c356a5f72041d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__ignore_pyi.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__ignore_pyi.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/ignore_pyi.pyi +snapshot_kind: text --- ## Input @@ -86,5 +87,3 @@ def h(): ... # bye ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__keep_newline_after_match.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__keep_newline_after_match.py.snap index 5e015547895b6..e329414749fa6 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__keep_newline_after_match.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__keep_newline_after_match.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/keep_newline_after_match.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_diff_edge_case.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_diff_edge_case.py.snap index bdfd173c802f1..d52718d348a5d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_diff_edge_case.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_diff_edge_case.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_diff_edge_case.py +snapshot_kind: text --- ## Input @@ -70,5 +71,3 @@ print("format me") print("format me") print("format me") ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_fmt_off_decorator.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_fmt_off_decorator.py.snap index a6e07024ed9dc..6ce20220d385a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_fmt_off_decorator.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__line_ranges_fmt_off_decorator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/line_ranges_fmt_off_decorator.py +snapshot_kind: text --- ## Input @@ -101,5 +102,3 @@ class MyClass: def func(): pass ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__long_strings_flag_disabled.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__long_strings_flag_disabled.py.snap index 97505058f4bf0..dc0aecbac21ac 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__long_strings_flag_disabled.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__long_strings_flag_disabled.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/long_strings_flag_disabled.py +snapshot_kind: text --- ## Input @@ -308,33 +309,52 @@ long_unmergable_string_with_pragma = ( ```diff --- Black +++ Ruff -@@ -167,13 +167,9 @@ +@@ -167,14 +167,14 @@ triple_quote_string = """This is a really really really long triple quote string assignment and it should not be touched.""" -assert ( - some_type_of_boolean_expression -), "Followed by a really really really long string that is used to provide context to the AssertionError exception." -+assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception." ++assert some_type_of_boolean_expression, ( ++ "Followed by a really really really long string that is used to provide context to the AssertionError exception." ++) -assert ( - some_type_of_boolean_expression -), "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format( -+assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format( - "formatting" +- "formatting" ++assert some_type_of_boolean_expression, ( ++ "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format( ++ "formatting" ++ ) ) -@@ -256,9 +252,7 @@ + assert some_type_of_boolean_expression, ( +@@ -255,10 +255,8 @@ + + " that has been " + CONCATENATED + "using the '+' operator." - ) +-) -annotated_variable: Final = ( - "This is a large string that has a type annotation attached to it. A type annotation should NOT stop a long string from being wrapped." --) + ) +annotated_variable: Final = "This is a large string that has a type annotation attached to it. A type annotation should NOT stop a long string from being wrapped." annotated_variable: Literal["fakse_literal"] = ( "This is a large string that has a type annotation attached to it. A type annotation should NOT stop a long string from being wrapped." ) +@@ -267,9 +265,9 @@ + backslashes = "This is a really long string with \"embedded\" double quotes and 'single' quotes that also handles checking for an even number of backslashes \\\\" + backslashes = "This is a really 'long' string with \"embedded double quotes\" and 'single' quotes that also handles checking for an odd number of backslashes \\\", like this...\\\\\\" + +-short_string = "Hi" " there." ++short_string = "Hi there." + +-func_call(short_string=("Hi" " there.")) ++func_call(short_string=("Hi there.")) + + raw_strings = r"Don't" " get" r" merged" " unless they are all raw." + ``` ## Ruff Output @@ -509,10 +529,14 @@ pragma_comment_string2 = "Lines which end with an inline pragma comment of the f triple_quote_string = """This is a really really really long triple quote string assignment and it should not be touched.""" -assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception." +assert some_type_of_boolean_expression, ( + "Followed by a really really really long string that is used to provide context to the AssertionError exception." +) -assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format( - "formatting" +assert some_type_of_boolean_expression, ( + "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format( + "formatting" + ) ) assert some_type_of_boolean_expression, ( @@ -603,9 +627,9 @@ backslashes = "This is a really long string with \"embedded\" double quotes and backslashes = "This is a really long string with \"embedded\" double quotes and 'single' quotes that also handles checking for an even number of backslashes \\\\" backslashes = "This is a really 'long' string with \"embedded double quotes\" and 'single' quotes that also handles checking for an odd number of backslashes \\\", like this...\\\\\\" -short_string = "Hi" " there." +short_string = "Hi there." -func_call(short_string=("Hi" " there.")) +func_call(short_string=("Hi there.")) raw_strings = r"Don't" " get" r" merged" " unless they are all raw." diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__multiline_consecutive_open_parentheses_ignore.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__multiline_consecutive_open_parentheses_ignore.py.snap index 45a41abfe2ea4..53c85e1a0467e 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__multiline_consecutive_open_parentheses_ignore.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__multiline_consecutive_open_parentheses_ignore.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/multiline_consecutive_open_parentheses_ignore.py +snapshot_kind: text --- ## Input @@ -87,5 +88,3 @@ print("111") # type: ignore print("111") # type: ignore print("111") # type: ignore ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__nested_stub.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__nested_stub.pyi.snap index 5eed350fd7dbc..1e05f95d0ef22 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__nested_stub.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__nested_stub.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/nested_stub.pyi +snapshot_kind: text --- ## Input @@ -141,5 +142,3 @@ class TopLevel: field = 1 ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__no_blank_line_before_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__no_blank_line_before_docstring.py.snap index 5d175b9b9b37f..379f746fae540 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__no_blank_line_before_docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__no_blank_line_before_docstring.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/no_blank_line_before_docstring.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_style.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_style.py.snap index 06422b3718754..84ace274238c7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_style.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_style.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_style.py +snapshot_kind: text --- ## Input @@ -182,5 +183,3 @@ match match(): ): pass ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_trailing_comma.py.snap index 8800ffc4edee4..79f1cf71b49fe 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_trailing_comma.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_trailing_comma.py.snap @@ -26,7 +26,7 @@ match more := (than, one), indeed,: ```diff --- Black +++ Ruff -@@ -8,13 +8,16 @@ +@@ -8,7 +8,10 @@ pass @@ -37,15 +37,7 @@ match more := (than, one), indeed,: +): case _, (5, 6): pass -- case ( -+ case [ - [[5], (6)], - [7], -- ): -+ ]: - pass - case _: - pass + case ( ``` ## Ruff Output @@ -67,10 +59,10 @@ match ( ): case _, (5, 6): pass - case [ + case ( [[5], (6)], [7], - ]: + ): pass case _: pass diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_with_if_stmt.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_with_if_stmt.py.snap index 02f6b0636a1f1..1e74d2e322837 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_with_if_stmt.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_with_if_stmt.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/pattern_matching_with_if_stmt.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep604_union_types_line_breaks.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep604_union_types_line_breaks.py.snap index f5eba916b275a..dc61db96dcfdb 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep604_union_types_line_breaks.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep604_union_types_line_breaks.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep604_union_types_line_breaks.py +snapshot_kind: text --- ## Input @@ -26,7 +27,7 @@ z: (Short z: (int) = 2.3 z: ((int)) = foo() -# In case I go for not enforcing parantheses, this might get improved at the same time +# In case I go for not enforcing parentheses, this might get improved at the same time x = ( z == 9999999999999999999999999999999999999999 @@ -165,7 +166,7 @@ z: Short | Short2 | Short3 | Short4 = 8 z: int = 2.3 z: int = foo() -# In case I go for not enforcing parantheses, this might get improved at the same time +# In case I go for not enforcing parentheses, this might get improved at the same time x = ( z == 9999999999999999999999999999999999999999 @@ -269,7 +270,7 @@ z: Short | Short2 | Short3 | Short4 = 8 z: int = 2.3 z: int = foo() -# In case I go for not enforcing parantheses, this might get improved at the same time +# In case I go for not enforcing parentheses, this might get improved at the same time x = ( z == 9999999999999999999999999999999999999999 diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_572_remove_parens.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_572_remove_parens.py.snap new file mode 100644 index 0000000000000..08e513bc17aaa --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_572_remove_parens.py.snap @@ -0,0 +1,241 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_572_remove_parens.py +--- +## Input + +```python +if (foo := 0): + pass + +if (foo := 1): + pass + +if (y := 5 + 5): + pass + +y = (x := 0) + +y += (x := 0) + +(y := 5 + 5) + +test: int = (test2 := 2) + +a, b = (test := (1, 2)) + +# see also https://github.com/psf/black/issues/2139 +assert (foo := 42 - 12) + +foo(x=(y := f(x))) + + +def foo(answer=(p := 42)): + ... + + +def foo2(answer: (p := 42) = 5): + ... + + +lambda: (x := 1) + +a[(x := 12)] +a[:(x := 13)] + +# we don't touch expressions in f-strings but if we do one day, don't break 'em +f'{(x:=10)}' + + +def a(): + return (x := 3) + await (b := 1) + yield (a := 2) + raise (c := 3) + +def this_is_so_dumb() -> (please := no): + pass + +async def await_the_walrus(): + with (x := y): + pass + + with (x := y) as z, (a := b) as c: + pass + + with (x := await y): + pass + + with (x := await a, y := await b): + pass + + with ((x := await a, y := await b)): + pass + + with (x := await a), (y := await b): + pass +``` + +## Black Differences + +```diff +--- Black ++++ Ruff +@@ -35,7 +35,7 @@ + a[: (x := 13)] + + # we don't touch expressions in f-strings but if we do one day, don't break 'em +-f"{(x:=10)}" ++f"{(x := 10)}" + + + def a(): +``` + +## Ruff Output + +```python +if foo := 0: + pass + +if foo := 1: + pass + +if y := 5 + 5: + pass + +y = (x := 0) + +y += (x := 0) + +(y := 5 + 5) + +test: int = (test2 := 2) + +a, b = (test := (1, 2)) + +# see also https://github.com/psf/black/issues/2139 +assert (foo := 42 - 12) + +foo(x=(y := f(x))) + + +def foo(answer=(p := 42)): ... + + +def foo2(answer: (p := 42) = 5): ... + + +lambda: (x := 1) + +a[(x := 12)] +a[: (x := 13)] + +# we don't touch expressions in f-strings but if we do one day, don't break 'em +f"{(x := 10)}" + + +def a(): + return (x := 3) + await (b := 1) + yield (a := 2) + raise (c := 3) + + +def this_is_so_dumb() -> (please := no): + pass + + +async def await_the_walrus(): + with (x := y): + pass + + with (x := y) as z, (a := b) as c: + pass + + with (x := await y): + pass + + with (x := await a, y := await b): + pass + + with (x := await a, y := await b): + pass + + with (x := await a), (y := await b): + pass +``` + +## Black Output + +```python +if foo := 0: + pass + +if foo := 1: + pass + +if y := 5 + 5: + pass + +y = (x := 0) + +y += (x := 0) + +(y := 5 + 5) + +test: int = (test2 := 2) + +a, b = (test := (1, 2)) + +# see also https://github.com/psf/black/issues/2139 +assert (foo := 42 - 12) + +foo(x=(y := f(x))) + + +def foo(answer=(p := 42)): ... + + +def foo2(answer: (p := 42) = 5): ... + + +lambda: (x := 1) + +a[(x := 12)] +a[: (x := 13)] + +# we don't touch expressions in f-strings but if we do one day, don't break 'em +f"{(x:=10)}" + + +def a(): + return (x := 3) + await (b := 1) + yield (a := 2) + raise (c := 3) + + +def this_is_so_dumb() -> (please := no): + pass + + +async def await_the_walrus(): + with (x := y): + pass + + with (x := y) as z, (a := b) as c: + pass + + with (x := await y): + pass + + with (x := await a, y := await b): + pass + + with (x := await a, y := await b): + pass + + with (x := await a), (y := await b): + pass +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_701.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_701.py.snap index 1a7bc07b67945..1b074e6b45c67 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_701.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pep_701.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/pep_701.py +snapshot_kind: text --- ## Input @@ -148,15 +149,155 @@ rf"\{"a"}" ```diff --- Black +++ Ruff -@@ -119,7 +119,7 @@ +@@ -11,16 +11,14 @@ + # edge case: FSTRING_MIDDLE containing only whitespace should not be stripped + x = f"{a} {b}" + +-x = f"foo { +- 2 + 2 +-} bar baz" ++x = f"foo {2 + 2} bar baz" + +-x = f"foo {{ {"a {2 + 2} b"}bar {{ baz" ++x = f"foo {{ {'a {2 + 2} b'}bar {{ baz" ++x = f"foo {{ {f'a {2 + 2} b'}bar {{ baz" + x = f"foo {{ {f'a {2 + 2} b'}bar {{ baz" +-x = f"foo {{ {f"a {2 + 2} b"}bar {{ baz" + + x = f"foo {{ {f'a {f"a {2 + 2} b"} b'}bar {{ baz" +-x = f"foo {{ {f"a {f"a {2 + 2} b"} b"}bar {{ baz" ++x = f"foo {{ {f'a {f"a {2 + 2} b"} b'}bar {{ baz" + + x = """foo {{ {2 + 2}bar + baz""" +@@ -28,74 +26,62 @@ + + x = f"""foo {{ {2 + 2}bar {{ baz""" + +-x = f"""foo {{ { +- 2 + 2 +-}bar {{ baz""" ++x = f"""foo {{ {2 + 2}bar {{ baz""" + + +-x = f"""foo {{ { +- 2 + 2 +-}bar ++x = f"""foo {{ {2 + 2}bar + baz""" + + x = f"""foo {{ a + foo {2 + 2}bar {{ baz + + x = f"foo {{ { +- 2 + 2 # comment +- }bar" ++ 2 + 2 # comment ++}bar" + + {{ baz + + }} buzz + +- {print("abc" + "def" +-)} ++ {print("abc" + "def")} + abc""" + + # edge case: end triple quotes at index zero +-f"""foo {2+2} bar ++f"""foo {2 + 2} bar + """ + +-f' \' {f"'"} \' ' +-f" \" {f'"'} \" " ++f" ' {f"'"} ' " ++f' " {f'"'} " ' + +-x = f"a{2+2:=^72}b" +-x = f"a{2+2:x}b" ++x = f"a{2 + 2:=^72}b" ++x = f"a{2 + 2:x}b" + + rf"foo" + rf"{foo}" + + f"{x:{y}d}" + +-x = f"a{2+2:=^{x}}b" +-x = f"a{2+2:=^{foo(x+y**2):something else}}b" +-x = f"a{2+2:=^{foo(x+y**2):something else}one more}b" +-f"{(abc:=10)}" ++x = f"a{2 + 2:=^{x}}b" ++x = f"a{2 + 2:=^{foo(x + y**2):something else}}b" ++x = f"a{2 + 2:=^{foo(x + y**2):something else}one more}b" ++f"{(abc := 10)}" + +-f"This is a really long string, but just make sure that you reflow fstrings { +- 2+2:d +-}" +-f"This is a really long string, but just make sure that you reflow fstrings correctly {2+2:d}" ++f"This is a really long string, but just make sure that you reflow fstrings {2 + 2:d}" ++f"This is a really long string, but just make sure that you reflow fstrings correctly {2 + 2:d}" + + f"{2+2=}" + f"{2+2 = }" + f"{ 2 + 2 = }" + +-f"""foo { +- datetime.datetime.now():%Y ++f"""foo {datetime.datetime.now():%Y + %m + %d + }""" + +-f"{ +-X +-!r +-}" ++f"{X!r}" + + raise ValueError( +- "xxxxxxxxxxxIncorrect --line-ranges format, expect START-END, found" +- f" {lines_str!r}" ++ f"xxxxxxxxxxxIncorrect --line-ranges format, expect START-END, found {lines_str!r}" ) - f"{1:{f'{2}'}}" --f"{1:{f'{2}'}}" -+f'{1:{f'{2}'}}' - f"{1:{2}d}" + f"`escape` only permitted in {{'html', 'latex', 'latex-math'}}, \ +@@ -105,8 +91,10 @@ + rf"\{{\}}" + + f""" +- WITH {f''' +- {1}_cte AS ()'''} ++ WITH { ++ f''' ++ {1}_cte AS ()''' ++} + """ + + value: str = f"""foo +@@ -124,13 +112,15 @@ f'{{\\"kind\\":\\"ConfigMap\\",\\"metadata\\":{{\\"annotations\\":{{}},\\"name\\":\\"cluster-info\\",\\"namespace\\":\\"amazon-cloudwatch\\"}}}}' + +-f"""{''' +-'''}""" ++f"""{ ++ ''' ++''' ++}""" + +-f"{'\''}" +-f"{f'\''}" ++f"{"'"}" ++f"{f"'"}" + + f"{1}\{{" + f"{2} foo \{{[\}}" + f"\{3}" +-rf"\{"a"}" ++rf"\{'a'}" ``` ## Ruff Output @@ -175,16 +316,14 @@ x = f"""foo {{ {2 + 2}bar {{ baz""" # edge case: FSTRING_MIDDLE containing only whitespace should not be stripped x = f"{a} {b}" -x = f"foo { - 2 + 2 -} bar baz" +x = f"foo {2 + 2} bar baz" -x = f"foo {{ {"a {2 + 2} b"}bar {{ baz" +x = f"foo {{ {'a {2 + 2} b'}bar {{ baz" +x = f"foo {{ {f'a {2 + 2} b'}bar {{ baz" x = f"foo {{ {f'a {2 + 2} b'}bar {{ baz" -x = f"foo {{ {f"a {2 + 2} b"}bar {{ baz" x = f"foo {{ {f'a {f"a {2 + 2} b"} b'}bar {{ baz" -x = f"foo {{ {f"a {f"a {2 + 2} b"} b"}bar {{ baz" +x = f"foo {{ {f'a {f"a {2 + 2} b"} b'}bar {{ baz" x = """foo {{ {2 + 2}bar baz""" @@ -192,74 +331,62 @@ baz""" x = f"""foo {{ {2 + 2}bar {{ baz""" -x = f"""foo {{ { - 2 + 2 -}bar {{ baz""" +x = f"""foo {{ {2 + 2}bar {{ baz""" -x = f"""foo {{ { - 2 + 2 -}bar +x = f"""foo {{ {2 + 2}bar baz""" x = f"""foo {{ a foo {2 + 2}bar {{ baz x = f"foo {{ { - 2 + 2 # comment - }bar" + 2 + 2 # comment +}bar" {{ baz }} buzz - {print("abc" + "def" -)} + {print("abc" + "def")} abc""" # edge case: end triple quotes at index zero -f"""foo {2+2} bar +f"""foo {2 + 2} bar """ -f' \' {f"'"} \' ' -f" \" {f'"'} \" " +f" ' {f"'"} ' " +f' " {f'"'} " ' -x = f"a{2+2:=^72}b" -x = f"a{2+2:x}b" +x = f"a{2 + 2:=^72}b" +x = f"a{2 + 2:x}b" rf"foo" rf"{foo}" f"{x:{y}d}" -x = f"a{2+2:=^{x}}b" -x = f"a{2+2:=^{foo(x+y**2):something else}}b" -x = f"a{2+2:=^{foo(x+y**2):something else}one more}b" -f"{(abc:=10)}" +x = f"a{2 + 2:=^{x}}b" +x = f"a{2 + 2:=^{foo(x + y**2):something else}}b" +x = f"a{2 + 2:=^{foo(x + y**2):something else}one more}b" +f"{(abc := 10)}" -f"This is a really long string, but just make sure that you reflow fstrings { - 2+2:d -}" -f"This is a really long string, but just make sure that you reflow fstrings correctly {2+2:d}" +f"This is a really long string, but just make sure that you reflow fstrings {2 + 2:d}" +f"This is a really long string, but just make sure that you reflow fstrings correctly {2 + 2:d}" f"{2+2=}" f"{2+2 = }" f"{ 2 + 2 = }" -f"""foo { - datetime.datetime.now():%Y +f"""foo {datetime.datetime.now():%Y %m %d }""" -f"{ -X -!r -}" +f"{X!r}" raise ValueError( - "xxxxxxxxxxxIncorrect --line-ranges format, expect START-END, found" - f" {lines_str!r}" + f"xxxxxxxxxxxIncorrect --line-ranges format, expect START-END, found {lines_str!r}" ) f"`escape` only permitted in {{'html', 'latex', 'latex-math'}}, \ @@ -269,8 +396,10 @@ x = f"\N{GREEK CAPITAL LETTER DELTA} \N{SNOWMAN} {x}" rf"\{{\}}" f""" - WITH {f''' - {1}_cte AS ()'''} + WITH { + f''' + {1}_cte AS ()''' +} """ value: str = f"""foo @@ -283,21 +412,23 @@ log( ) f"{1:{f'{2}'}}" -f'{1:{f'{2}'}}' +f"{1:{f'{2}'}}" f"{1:{2}d}" f'{{\\"kind\\":\\"ConfigMap\\",\\"metadata\\":{{\\"annotations\\":{{}},\\"name\\":\\"cluster-info\\",\\"namespace\\":\\"amazon-cloudwatch\\"}}}}' -f"""{''' -'''}""" +f"""{ + ''' +''' +}""" -f"{'\''}" -f"{f'\''}" +f"{"'"}" +f"{f"'"}" f"{1}\{{" f"{2} foo \{{[\}}" f"\{3}" -rf"\{"a"}" +rf"\{'a'}" ``` ## Black Output diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__prefer_rhs_split.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__prefer_rhs_split.py.snap index d20c2a8d20456..db71513a87cb7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__prefer_rhs_split.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__prefer_rhs_split.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/prefer_rhs_split.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line.py.snap deleted file mode 100644 index 7ff5d6d32d55b..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line.py.snap +++ /dev/null @@ -1,326 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line.py ---- -## Input - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 - -def quux(): - - new_line = here - - -class Cls: - - def method(self): - - pass - - -async def async_fn(): - - """Docstring.""" - - -@decorated -async def async_fn(): - - """Docstring.""" - - -def top_level( - a: int, - b: str, -) -> Whatever[Generic, Something]: - - def nested(x: int) -> int: - pass -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -5,7 +5,6 @@ - - # Here we go - if x: -- - # This is also now fine - a = 123 - -@@ -14,52 +13,41 @@ - a = 123 - - if y: -- - while True: -- - """ - Long comment here - """ - a = 123 - - if z: -- - for _ in range(100): - a = 123 - else: -- - try: -- - # this should be ok - a = 123 - except: -- - """also this""" - a = 123 - - - def bar(): -- - if x: - a = 123 - - - def baz(): -- - # OK - if x: - a = 123 - - - def quux(): -- - new_line = here - - - class Cls: -- - def method(self): -- - pass - - -@@ -76,6 +64,5 @@ - a: int, - b: str, - ) -> Whatever[Generic, Something]: -- - def nested(x: int) -> int: - pass -``` - -## Ruff Output - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - while True: - """ - Long comment here - """ - a = 123 - - if z: - for _ in range(100): - a = 123 - else: - try: - # this should be ok - a = 123 - except: - """also this""" - a = 123 - - -def bar(): - if x: - a = 123 - - -def baz(): - # OK - if x: - a = 123 - - -def quux(): - new_line = here - - -class Cls: - def method(self): - pass - - -async def async_fn(): - """Docstring.""" - - -@decorated -async def async_fn(): - """Docstring.""" - - -def top_level( - a: int, - b: str, -) -> Whatever[Generic, Something]: - def nested(x: int) -> int: - pass -``` - -## Black Output - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 - - -def quux(): - - new_line = here - - -class Cls: - - def method(self): - - pass - - -async def async_fn(): - """Docstring.""" - - -@decorated -async def async_fn(): - """Docstring.""" - - -def top_level( - a: int, - b: str, -) -> Whatever[Generic, Something]: - - def nested(x: int) -> int: - pass -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line_in_special_cases.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line_in_special_cases.py.snap deleted file mode 100644 index 2dce9bc3af03b..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_allow_empty_first_line_in_special_cases.py.snap +++ /dev/null @@ -1,218 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_allow_empty_first_line_in_special_cases.py ---- -## Input - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -5,7 +5,6 @@ - - # Here we go - if x: -- - # This is also now fine - a = 123 - -@@ -14,38 +13,30 @@ - a = 123 - - if y: -- - while True: -- - """ - Long comment here - """ - a = 123 - - if z: -- - for _ in range(100): - a = 123 - else: -- - try: -- - # this should be ok - a = 123 - except: -- - """also this""" - a = 123 - - - def bar(): -- - if x: - a = 123 - - - def baz(): -- - # OK - if x: - a = 123 -``` - -## Ruff Output - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - while True: - """ - Long comment here - """ - a = 123 - - if z: - for _ in range(100): - a = 123 - else: - try: - # this should be ok - a = 123 - except: - """also this""" - a = 123 - - -def bar(): - if x: - a = 123 - - -def baz(): - # OK - if x: - a = 123 -``` - -## Black Output - -```python -def foo(): - """ - Docstring - """ - - # Here we go - if x: - - # This is also now fine - a = 123 - - else: - # But not necessary - a = 123 - - if y: - - while True: - - """ - Long comment here - """ - a = 123 - - if z: - - for _ in range(100): - a = 123 - else: - - try: - - # this should be ok - a = 123 - except: - - """also this""" - a = 123 - - -def bar(): - - if x: - a = 123 - - -def baz(): - - # OK - if x: - a = 123 -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit.py.snap index 1d93012d9b90d..ec8b567c4c61a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_cantfit.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit_string.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit_string.py.snap index 84a256884497d..b4901425ff5b1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit_string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_cantfit_string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_cantfit_string.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_comments7.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_comments7.py.snap index 337c78698d551..36f29c9177329 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_comments7.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_comments7.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_comments7.py +snapshot_kind: text --- ## Input @@ -596,5 +597,3 @@ square = Square(4) # type: Optional[Square] ), ] ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_docstring_no_string_normalization.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_docstring_no_string_normalization.py.snap deleted file mode 100644 index 70b323e49317e..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_docstring_no_string_normalization.py.snap +++ /dev/null @@ -1,68 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_docstring_no_string_normalization.py ---- -## Input - -```python -def do_not_touch_this_prefix(): - R"""There was a bug where docstring prefixes would be normalized even with -S.""" - - -def do_not_touch_this_prefix2(): - FR'There was a bug where docstring prefixes would be normalized even with -S.' - - -def do_not_touch_this_prefix3(): - u'''There was a bug where docstring prefixes would be normalized even with -S.''' -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -3,8 +3,8 @@ - - - def do_not_touch_this_prefix2(): -- FR'There was a bug where docstring prefixes would be normalized even with -S.' -+ Rf"There was a bug where docstring prefixes would be normalized even with -S." - - - def do_not_touch_this_prefix3(): -- u'''There was a bug where docstring prefixes would be normalized even with -S.''' -+ """There was a bug where docstring prefixes would be normalized even with -S.""" -``` - -## Ruff Output - -```python -def do_not_touch_this_prefix(): - R"""There was a bug where docstring prefixes would be normalized even with -S.""" - - -def do_not_touch_this_prefix2(): - Rf"There was a bug where docstring prefixes would be normalized even with -S." - - -def do_not_touch_this_prefix3(): - """There was a bug where docstring prefixes would be normalized even with -S.""" -``` - -## Black Output - -```python -def do_not_touch_this_prefix(): - R"""There was a bug where docstring prefixes would be normalized even with -S.""" - - -def do_not_touch_this_prefix2(): - FR'There was a bug where docstring prefixes would be normalized even with -S.' - - -def do_not_touch_this_prefix3(): - u'''There was a bug where docstring prefixes would be normalized even with -S.''' -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_form_feeds.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_form_feeds.py.snap deleted file mode 100644 index 09b03d396a174..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_form_feeds.py.snap +++ /dev/null @@ -1,458 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_form_feeds.py ---- -## Input - -```python -# Warning! This file contains form feeds (ASCII 0x0C, often represented by \f or ^L). -# These may be invisible in your editor: ensure you can see them before making changes here. - -# There's one at the start that'll get stripped - -# Comment and statement processing is different enough that we'll test variations of both -# contexts here - -# - - -# - - -# - - - -# - - - -# - - - -# - - -# - - - -# - -# - -# - - \ -# -pass - -pass - - -pass - - -pass - - - -pass - - - -pass - - - -pass - - -pass - - - -pass - -pass - -pass - - -# form feed after a dedent -def foo(): - pass - -pass - - -# form feeds are prohibited inside blocks, or on a line with nonwhitespace - def bar( a = 1 ,b : bool = False ) : - - - pass - - -class Baz: - - def __init__(self): - pass - - - def something(self): - pass - - - -# -pass -pass # -a = 1 - # - pass - a = 1 - -a = [ - -] - -# as internal whitespace of a comment is allowed but why -"form feed literal in a string is okay " - -# form feeds at the very end get removed. -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -5,62 +5,62 @@ - - # Comment and statement processing is different enough that we'll test variations of both - # contexts here -- -+ - # - -- -+ - # - -- -+ - # - -- -+ - # - -- -+ - # - -- -+ - # - -- -+ - # - -- -+ - # -- -+ - # -- -+ - # - - # - pass -- -+ - pass - -- -+ - pass - -- -+ - pass - -- -+ - pass - -- -+ - pass - -- -+ - pass - -- -+ - pass - -- -+ - pass -- -+ - pass -- -+ - pass - - -@@ -68,25 +68,23 @@ - def foo(): - pass - -- -+ - pass - - - # form feeds are prohibited inside blocks, or on a line with nonwhitespace - def bar(a=1, b: bool = False): -- - pass - - - class Baz: -- - def __init__(self): - pass - - def something(self): - pass - -- -+ - # - pass - pass # -``` - -## Ruff Output - -```python -# Warning! This file contains form feeds (ASCII 0x0C, often represented by \f or ^L). -# These may be invisible in your editor: ensure you can see them before making changes here. - -# There's one at the start that'll get stripped - -# Comment and statement processing is different enough that we'll test variations of both -# contexts here - -# - - -# - - -# - - -# - - -# - - -# - - -# - - -# - -# - -# - -# -pass - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - -pass - -pass - - -# form feed after a dedent -def foo(): - pass - - -pass - - -# form feeds are prohibited inside blocks, or on a line with nonwhitespace -def bar(a=1, b: bool = False): - pass - - -class Baz: - def __init__(self): - pass - - def something(self): - pass - - -# -pass -pass # -a = 1 -# -pass -a = 1 - -a = [] - -# as internal whitespace of a comment is allowed but why -"form feed literal in a string is okay " - -# form feeds at the very end get removed. -``` - -## Black Output - -```python -# Warning! This file contains form feeds (ASCII 0x0C, often represented by \f or ^L). -# These may be invisible in your editor: ensure you can see them before making changes here. - -# There's one at the start that'll get stripped - -# Comment and statement processing is different enough that we'll test variations of both -# contexts here - -# - - -# - - -# - - -# - - -# - - -# - - -# - - -# - -# - -# - -# -pass - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - - -pass - -pass - -pass - - -# form feed after a dedent -def foo(): - pass - - -pass - - -# form feeds are prohibited inside blocks, or on a line with nonwhitespace -def bar(a=1, b: bool = False): - - pass - - -class Baz: - - def __init__(self): - pass - - def something(self): - pass - - -# -pass -pass # -a = 1 -# -pass -a = 1 - -a = [] - -# as internal whitespace of a comment is allowed but why -"form feed literal in a string is okay " - -# form feeds at the very end get removed. -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets.py.snap index 71af123619c80..54e349c355a49 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_hug_parens_with_braces_and_square_brackets.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets_no_ll1.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets_no_ll1.py.snap index fd23c5a68477b..52818e7ae37de 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets_no_ll1.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_hug_parens_with_braces_and_square_brackets_no_ll1.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_hug_parens_with_braces_and_square_brackets_no_ll1.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_dict_values.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_dict_values.py.snap index b5afd447b3f3c..f67963611384e 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_dict_values.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_dict_values.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_dict_values.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings.py.snap index fa0173187df9c..3b7b47cb747b9 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_strings.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__east_asian_width.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__east_asian_width.py.snap index 7ba67786746f8..89247fa1f066f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__east_asian_width.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__east_asian_width.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_strings__east_asian_width.py +snapshot_kind: text --- ## Input @@ -71,5 +72,3 @@ japanese = ( "改行が要る文字列" ) ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__edge_case.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__edge_case.py.snap index 4db3fa039c2a8..8da88e25b65f8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__edge_case.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__edge_case.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_strings__edge_case.py +snapshot_kind: text --- ## Input @@ -336,5 +337,3 @@ msg += ( ) msg += "This long string should not be split at any point ever since it is just righttt" ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__regression.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__regression.py.snap index fc3857c2b45b2..7f61408c3cf01 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__regression.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__regression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_strings__regression.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__type_annotations.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__type_annotations.py.snap index da32d342f0cd2..4ae72f1717107 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__type_annotations.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_long_strings__type_annotations.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_long_strings__type_annotations.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_multiline_strings.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_multiline_strings.py.snap index 68b0202991a58..8d58214ce1829 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_multiline_strings.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_multiline_strings.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_multiline_strings.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_pattern_matching_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_pattern_matching_trailing_comma.py.snap deleted file mode 100644 index 257d3e63f6003..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_pattern_matching_trailing_comma.py.snap +++ /dev/null @@ -1,104 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_pattern_matching_trailing_comma.py ---- -## Input - -```python -match maybe, multiple: - case perhaps, 5: - pass - case perhaps, 6,: - pass - - -match more := (than, one), indeed,: - case _, (5, 6): - pass - case [[5], (6)], [7],: - pass - case _: - pass -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -8,13 +8,16 @@ - pass - - --match more := (than, one), indeed,: -+match ( -+ more := (than, one), -+ indeed, -+): - case _, (5, 6): - pass -- case ( -+ case [ - [[5], (6)], - [7], -- ): -+ ]: - pass - case _: - pass -``` - -## Ruff Output - -```python -match maybe, multiple: - case perhaps, 5: - pass - case ( - perhaps, - 6, - ): - pass - - -match ( - more := (than, one), - indeed, -): - case _, (5, 6): - pass - case [ - [[5], (6)], - [7], - ]: - pass - case _: - pass -``` - -## Black Output - -```python -match maybe, multiple: - case perhaps, 5: - pass - case ( - perhaps, - 6, - ): - pass - - -match more := (than, one), indeed,: - case _, (5, 6): - pass - case ( - [[5], (6)], - [7], - ): - pass - case _: - pass -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_percent_precedence.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_percent_precedence.py.snap deleted file mode 100644 index 01f401e99a11a..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_percent_precedence.py.snap +++ /dev/null @@ -1,99 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_percent_precedence.py ---- -## Input - -```python -("" % a) ** 2 -("" % a)[0] -("" % a)() -("" % a).b - -2 * ("" % a) -2 @ ("" % a) -2 / ("" % a) -2 // ("" % a) -2 % ("" % a) -+("" % a) -b + ("" % a) --("" % a) -b - ("" % a) -b + -("" % a) -~("" % a) -2 ** ("" % a) -await ("" % a) -b[("" % a)] -b(("" % a)) -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -9,9 +9,9 @@ - 2 // ("" % a) - 2 % ("" % a) - +("" % a) --b + "" % a -+b + ("" % a) - -("" % a) --b - "" % a -+b - ("" % a) - b + -("" % a) - ~("" % a) - 2 ** ("" % a) -``` - -## Ruff Output - -```python -("" % a) ** 2 -("" % a)[0] -("" % a)() -("" % a).b - -2 * ("" % a) -2 @ ("" % a) -2 / ("" % a) -2 // ("" % a) -2 % ("" % a) -+("" % a) -b + ("" % a) --("" % a) -b - ("" % a) -b + -("" % a) -~("" % a) -2 ** ("" % a) -await ("" % a) -b[("" % a)] -b(("" % a)) -``` - -## Black Output - -```python -("" % a) ** 2 -("" % a)[0] -("" % a)() -("" % a).b - -2 * ("" % a) -2 @ ("" % a) -2 / ("" % a) -2 // ("" % a) -2 % ("" % a) -+("" % a) -b + "" % a --("" % a) -b - "" % a -b + -("" % a) -~("" % a) -2 ** ("" % a) -await ("" % a) -b[("" % a)] -b(("" % a)) -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_prefer_rhs_split.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_prefer_rhs_split.py.snap deleted file mode 100644 index e799efc3145f6..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_prefer_rhs_split.py.snap +++ /dev/null @@ -1,354 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_prefer_rhs_split.py ---- -## Input - -```python -first_item, second_item = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure it works when the RHS only has one pair of (optional) parens. -first_item, second_item = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -# Make sure chaining assignments work. -first_item, second_item, third_item, forth_item = m["everything"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure when the RHS's first split at the non-optional paren fits, -# we split there instead of the outer RHS optional paren. -first_item, second_item = some_looooooooong_module.some_loooooog_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = everything = some_looooong_function_name( - first_argument, second_argument, third_argument -) - - -# Make sure unsplittable type ignore won't be moved. -some_kind_of_table[some_key] = util.some_function( # type: ignore # noqa: E501 - some_arg -).intersection(pk_cols) - -some_kind_of_table[ - some_key -] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - -some_kind_of_table[ - some_key # type: ignore # noqa: E501 -] = lambda obj: obj.some_long_named_method() - - -# Make when when the left side of assignment plus the opening paren "... = (" is -# exactly line length limit + 1, it won't be split like that. -xxxxxxxxx_yyy_zzzzzzzz[ - xx.xxxxxx(x_yyy_zzzzzz.xxxxx[0]), x_yyy_zzzzzz.xxxxxx(xxxx=1) -] = 1 - - -# Right side of assignment contains un-nested pairs of inner parens. -some_kind_of_instance.some_kind_of_map[a_key] = ( - isinstance(some_var, SomeClass) - and table.something_and_something != table.something_else -) or ( - isinstance(some_other_var, BaseClass) and table.something != table.some_other_thing -) - -# Multiple targets -a = b = ( - ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) - -a = b = c = d = e = f = g = ( - hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh -) = i = j = ( - kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk -) - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = c - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = ( - cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -60,9 +60,7 @@ - some_arg - ).intersection(pk_cols) - --some_kind_of_table[ -- some_key --] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 -+some_kind_of_table[some_key] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - - some_kind_of_table[ - some_key # type: ignore # noqa: E501 -``` - -## Ruff Output - -```python -first_item, second_item = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure it works when the RHS only has one pair of (optional) parens. -first_item, second_item = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -# Make sure chaining assignments work. -first_item, second_item, third_item, forth_item = m["everything"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure when the RHS's first split at the non-optional paren fits, -# we split there instead of the outer RHS optional paren. -first_item, second_item = some_looooooooong_module.some_loooooog_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = everything = some_looooong_function_name( - first_argument, second_argument, third_argument -) - - -# Make sure unsplittable type ignore won't be moved. -some_kind_of_table[some_key] = util.some_function( # type: ignore # noqa: E501 - some_arg -).intersection(pk_cols) - -some_kind_of_table[some_key] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - -some_kind_of_table[ - some_key # type: ignore # noqa: E501 -] = lambda obj: obj.some_long_named_method() - - -# Make when when the left side of assignment plus the opening paren "... = (" is -# exactly line length limit + 1, it won't be split like that. -xxxxxxxxx_yyy_zzzzzzzz[ - xx.xxxxxx(x_yyy_zzzzzz.xxxxx[0]), x_yyy_zzzzzz.xxxxxx(xxxx=1) -] = 1 - - -# Right side of assignment contains un-nested pairs of inner parens. -some_kind_of_instance.some_kind_of_map[a_key] = ( - isinstance(some_var, SomeClass) - and table.something_and_something != table.something_else -) or ( - isinstance(some_other_var, BaseClass) and table.something != table.some_other_thing -) - -# Multiple targets -a = b = ( - ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) - -a = b = c = d = e = f = g = ( - hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh -) = i = j = ( - kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk -) - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = c - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = ( - cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd -``` - -## Black Output - -```python -first_item, second_item = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure it works when the RHS only has one pair of (optional) parens. -first_item, second_item = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -some_dict["with_a_long_key"] = ( - some_looooooooong_module.SomeClass.some_looooooooooooooong_variable_name -) - -# Make sure chaining assignments work. -first_item, second_item, third_item, forth_item = m["everything"] = ( - some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument - ) -) - -# Make sure when the RHS's first split at the non-optional paren fits, -# we split there instead of the outer RHS optional paren. -first_item, second_item = some_looooooooong_module.some_loooooog_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = some_looooooooong_module.some_looooooooooooooong_function_name( - first_argument, second_argument, third_argument -) - -( - first_item, - second_item, - third_item, - forth_item, - fifth_item, - last_item_very_loooooong, -) = everything = some_looooong_function_name( - first_argument, second_argument, third_argument -) - - -# Make sure unsplittable type ignore won't be moved. -some_kind_of_table[some_key] = util.some_function( # type: ignore # noqa: E501 - some_arg -).intersection(pk_cols) - -some_kind_of_table[ - some_key -] = lambda obj: obj.some_long_named_method() # type: ignore # noqa: E501 - -some_kind_of_table[ - some_key # type: ignore # noqa: E501 -] = lambda obj: obj.some_long_named_method() - - -# Make when when the left side of assignment plus the opening paren "... = (" is -# exactly line length limit + 1, it won't be split like that. -xxxxxxxxx_yyy_zzzzzzzz[ - xx.xxxxxx(x_yyy_zzzzzz.xxxxx[0]), x_yyy_zzzzzz.xxxxxx(xxxx=1) -] = 1 - - -# Right side of assignment contains un-nested pairs of inner parens. -some_kind_of_instance.some_kind_of_map[a_key] = ( - isinstance(some_var, SomeClass) - and table.something_and_something != table.something_else -) or ( - isinstance(some_other_var, BaseClass) and table.something != table.some_other_thing -) - -# Multiple targets -a = b = ( - ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) - -a = b = c = d = e = f = g = ( - hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh -) = i = j = ( - kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk -) - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = c - -a = ( - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -) = ( - cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc -) = ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_return_annotation_brackets_string.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_return_annotation_brackets_string.py.snap index 5f43f1a7d20b5..1ccd1c50c1eba 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_return_annotation_brackets_string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_return_annotation_brackets_string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_return_annotation_brackets_string.py +snapshot_kind: text --- ## Input @@ -64,5 +65,3 @@ def frobnicate( ) -> "ThisIsTrulyUnreasonablyExtremelyLongClassName | list[ThisIsTrulyUnreasonablyExtremelyLongClassName]": pass ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_single_line_format_skip_with_multiple_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_single_line_format_skip_with_multiple_comments.py.snap deleted file mode 100644 index 848e9fe3e254d..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__preview_single_line_format_skip_with_multiple_comments.py.snap +++ /dev/null @@ -1,63 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_single_line_format_skip_with_multiple_comments.py ---- -## Input - -```python -foo = 123 # fmt: skip # noqa: E501 # pylint -bar = ( - 123 , - ( 1 + 5 ) # pylint # fmt:skip -) -baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -skip_will_not_work = "a" + "b" # pylint fmt:skip -skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,8 +1,8 @@ - foo = 123 # fmt: skip # noqa: E501 # pylint - bar = ( -- 123 , -- ( 1 + 5 ) # pylint # fmt:skip -+ 123, -+ (1 + 5), # pylint # fmt:skip - ) --baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -+baz = "a" + "b" # pylint; fmt: skip; noqa: E501 - skip_will_not_work = "a" + "b" # pylint fmt:skip - skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it -``` - -## Ruff Output - -```python -foo = 123 # fmt: skip # noqa: E501 # pylint -bar = ( - 123, - (1 + 5), # pylint # fmt:skip -) -baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -skip_will_not_work = "a" + "b" # pylint fmt:skip -skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it -``` - -## Black Output - -```python -foo = 123 # fmt: skip # noqa: E501 # pylint -bar = ( - 123 , - ( 1 + 5 ) # pylint # fmt:skip -) -baz = "a" + "b" # pylint; fmt: skip; noqa: E501 -skip_will_not_work = "a" + "b" # pylint fmt:skip -skip_will_not_work2 = "a" + "b" # some text; fmt:skip happens to be part of it -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring.py.snap index bc66189376a79..6a3a797325de5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/raw_docstring.py +snapshot_kind: text --- ## Input @@ -75,5 +76,3 @@ class SingleQuotes: class UpperCaseR: R"""Raw""" ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring_no_string_normalization.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring_no_string_normalization.py.snap index b9c8f50f337cd..969951c8c5161 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring_no_string_normalization.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__raw_docstring_no_string_normalization.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/raw_docstring_no_string_normalization.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_await_parens.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_await_parens.py.snap index 284e85189ee12..cb67f5b1bb73b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_await_parens.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_await_parens.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_await_parens.py +snapshot_kind: text --- ## Input @@ -341,5 +342,3 @@ async def main(): await a[b] await a[b**c] ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_except_parens.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_except_parens.py.snap index 55f1e953849c3..8cea5eb67b6a7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_except_parens.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_except_parens.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_except_parens.py +snapshot_kind: text --- ## Input @@ -151,5 +152,3 @@ except ( ) as err: raise err ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_for_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_for_brackets.py.snap index 5b98ee4d7f870..3dd8cc5a5aa0c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_for_brackets.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_for_brackets.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_for_brackets.py +snapshot_kind: text --- ## Input @@ -105,5 +106,3 @@ for ( for k, v in d.items(): print(k, v) ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_newline_after_code_block_open.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_newline_after_code_block_open.py.snap index ca73f90ad32cc..8ebaf95ff543a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_newline_after_code_block_open.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_newline_after_code_block_open.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_newline_after_code_block_open.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_redundant_parens_in_case_guard.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_redundant_parens_in_case_guard.py.snap index d848db4ce8a89..2f8e6eb01e4be 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_redundant_parens_in_case_guard.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_redundant_parens_in_case_guard.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/remove_redundant_parens_in_case_guard.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__return_annotation_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__return_annotation_brackets.py.snap index 660fd0b731079..4737f385276f1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__return_annotation_brackets.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__return_annotation_brackets.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/return_annotation_brackets.py +snapshot_kind: text --- ## Input @@ -126,39 +127,7 @@ def foo(a,b) -> tuple[int, int, int,]: return 2 * a -@@ -99,25 +107,31 @@ - return 2 - - --def foo() -> tuple[ -- loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, -- loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, -- loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, --]: -+def foo() -> ( -+ tuple[ -+ loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, -+ loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, -+ loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, -+ ] -+): - return 2 - - - # Magic trailing comma example --def foo() -> tuple[ -- int, -- int, -- int, --]: -+def foo() -> ( -+ tuple[ -+ int, -+ int, -+ int, -+ ] -+): - return 2 +@@ -117,7 +125,9 @@ # Magic trailing comma example, with params @@ -283,24 +252,20 @@ def foo() -> tuple[int, int, int]: return 2 -def foo() -> ( - tuple[ - loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, - loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, - loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, - ] -): +def foo() -> tuple[ + loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, + loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, + loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong, +]: return 2 # Magic trailing comma example -def foo() -> ( - tuple[ - int, - int, - int, - ] -): +def foo() -> tuple[ + int, + int, + int, +]: return 2 diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__single_line_format_skip_with_multiple_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__single_line_format_skip_with_multiple_comments.py.snap index 644db86aea51e..dfb256c9cb18a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__single_line_format_skip_with_multiple_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__single_line_format_skip_with_multiple_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/single_line_format_skip_with_multiple_comments.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__stub.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__stub.pyi.snap index 13083c6ed09b3..4ac0d13469ee4 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__stub.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__stub.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/stub.pyi +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__torture.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__torture.py.snap index 3ad322d6b770a..574e3545e694b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__torture.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__torture.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/torture.py +snapshot_kind: text --- ## Input @@ -180,5 +181,3 @@ assert a_function( which_is_eighty_eight_in_this_case_plus_a_bit_more, ) == {"x": "this need to pass the line limit as well", "b": "but only by a little bit"} ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__trailing_commas_in_leading_parts.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__trailing_commas_in_leading_parts.py.snap index 27cdd32b80c32..7c3a12698a34c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__trailing_commas_in_leading_parts.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__trailing_commas_in_leading_parts.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/trailing_commas_in_leading_parts.py +snapshot_kind: text --- ## Input @@ -63,11 +64,9 @@ assert xxxxxxxxx.xxxxxxxxx.xxxxxxxxx( -assert xxxxxxxxx.xxxxxxxxx.xxxxxxxxx( - xxxxxxxxx -).xxxxxxxxxxxxxxxxxx(), ( -- "xxx {xxxxxxxxx} xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --) -+assert ( -+ xxxxxxxxx.xxxxxxxxx.xxxxxxxxx(xxxxxxxxx).xxxxxxxxxxxxxxxxxx() -+), "xxx {xxxxxxxxx} xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ++assert xxxxxxxxx.xxxxxxxxx.xxxxxxxxx(xxxxxxxxx).xxxxxxxxxxxxxxxxxx(), ( + "xxx {xxxxxxxxx} xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + ) ``` ## Ruff Output @@ -116,9 +115,9 @@ assert ( ) # Regression test for https://github.com/psf/black/issues/3414. -assert ( - xxxxxxxxx.xxxxxxxxx.xxxxxxxxx(xxxxxxxxx).xxxxxxxxxxxxxxxxxx() -), "xxx {xxxxxxxxx} xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +assert xxxxxxxxx.xxxxxxxxx.xxxxxxxxx(xxxxxxxxx).xxxxxxxxxxxxxxxxxx(), ( + "xxx {xxxxxxxxx} xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +) ``` ## Black Output diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__tupleassign.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__tupleassign.py.snap index 654b488efe275..5909adb872a8c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__tupleassign.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__tupleassign.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/tupleassign.py +snapshot_kind: text --- ## Input @@ -63,5 +64,3 @@ this_will_be_wrapped_in_parens, = struct.unpack(b"12345678901234567890") (a,) = call() ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__type_param_defaults.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__type_param_defaults.py.snap index 19c55af550f6e..3910a7cf567a9 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__type_param_defaults.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__type_param_defaults.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/type_param_defaults.py +snapshot_kind: text --- ## Input diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@conditional_expression.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@conditional_expression.py.snap deleted file mode 100644 index 8a1f4efdd8bb1..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@conditional_expression.py.snap +++ /dev/null @@ -1,334 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/conditional_expression.py ---- -## Input - -```python -long_kwargs_single_line = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -multiline_kwargs_indented = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -imploding_kwargs = my_function( - foo="test, this is a sample value", - bar=a - if foo - else b, - baz="hello, this is a another value", -) - -imploding_line = ( - 1 - if 1 + 1 == 2 - else 0 -) - -exploding_line = "hello this is a slightly long string" if some_long_value_name_foo_bar_baz else "this one is a little shorter" - -positional_argument_test(some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz) - -def weird_default_argument(x=some_long_value_name_foo_bar_baz - if SOME_CONSTANT - else some_fallback_value_foo_bar_baz): - pass - -nested = "hello this is a slightly long string" if (some_long_value_name_foo_bar_baz if - nesting_test_expressions else some_fallback_value_foo_bar_baz) \ - else "this one is a little shorter" - -generator_expression = ( - some_long_value_name_foo_bar_baz if some_boolean_variable else some_fallback_value_foo_bar_baz for some_boolean_variable in some_iterable -) - - -def limit_offset_sql(self, low_mark, high_mark): - """Return LIMIT/OFFSET SQL clause.""" - limit, offset = self._get_limit_offset_params(low_mark, high_mark) - return " ".join( - sql - for sql in ( - "LIMIT %d" % limit if limit else None, - ("OFFSET %d" % offset) if offset else None, - ) - if sql - ) - - -def something(): - clone._iterable_class = ( - NamedValuesListIterable - if named - else FlatValuesListIterable - if flat - else ValuesListIterable - ) -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,20 +1,16 @@ - long_kwargs_single_line = my_function( - foo="test, this is a sample value", -- bar=( -- some_long_value_name_foo_bar_baz -- if some_boolean_variable -- else some_fallback_value_foo_bar_baz -- ), -+ bar=some_long_value_name_foo_bar_baz -+ if some_boolean_variable -+ else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", - ) - - multiline_kwargs_indented = my_function( - foo="test, this is a sample value", -- bar=( -- some_long_value_name_foo_bar_baz -- if some_boolean_variable -- else some_fallback_value_foo_bar_baz -- ), -+ bar=some_long_value_name_foo_bar_baz -+ if some_boolean_variable -+ else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", - ) - -@@ -40,11 +36,9 @@ - - - def weird_default_argument( -- x=( -- some_long_value_name_foo_bar_baz -- if SOME_CONSTANT -- else some_fallback_value_foo_bar_baz -- ), -+ x=some_long_value_name_foo_bar_baz -+ if SOME_CONSTANT -+ else some_fallback_value_foo_bar_baz, - ): - pass - -@@ -60,11 +54,9 @@ - ) - - generator_expression = ( -- ( -- some_long_value_name_foo_bar_baz -- if some_boolean_variable -- else some_fallback_value_foo_bar_baz -- ) -+ some_long_value_name_foo_bar_baz -+ if some_boolean_variable -+ else some_fallback_value_foo_bar_baz - for some_boolean_variable in some_iterable - ) - -@@ -86,5 +78,7 @@ - clone._iterable_class = ( - NamedValuesListIterable - if named -- else FlatValuesListIterable if flat else ValuesListIterable -+ else FlatValuesListIterable -+ if flat -+ else ValuesListIterable - ) -``` - -## Ruff Output - -```python -long_kwargs_single_line = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -multiline_kwargs_indented = my_function( - foo="test, this is a sample value", - bar=some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz, - baz="hello, this is a another value", -) - -imploding_kwargs = my_function( - foo="test, this is a sample value", - bar=a if foo else b, - baz="hello, this is a another value", -) - -imploding_line = 1 if 1 + 1 == 2 else 0 - -exploding_line = ( - "hello this is a slightly long string" - if some_long_value_name_foo_bar_baz - else "this one is a little shorter" -) - -positional_argument_test( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz -) - - -def weird_default_argument( - x=some_long_value_name_foo_bar_baz - if SOME_CONSTANT - else some_fallback_value_foo_bar_baz, -): - pass - - -nested = ( - "hello this is a slightly long string" - if ( - some_long_value_name_foo_bar_baz - if nesting_test_expressions - else some_fallback_value_foo_bar_baz - ) - else "this one is a little shorter" -) - -generator_expression = ( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - for some_boolean_variable in some_iterable -) - - -def limit_offset_sql(self, low_mark, high_mark): - """Return LIMIT/OFFSET SQL clause.""" - limit, offset = self._get_limit_offset_params(low_mark, high_mark) - return " ".join( - sql - for sql in ( - "LIMIT %d" % limit if limit else None, - ("OFFSET %d" % offset) if offset else None, - ) - if sql - ) - - -def something(): - clone._iterable_class = ( - NamedValuesListIterable - if named - else FlatValuesListIterable - if flat - else ValuesListIterable - ) -``` - -## Black Output - -```python -long_kwargs_single_line = my_function( - foo="test, this is a sample value", - bar=( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ), - baz="hello, this is a another value", -) - -multiline_kwargs_indented = my_function( - foo="test, this is a sample value", - bar=( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ), - baz="hello, this is a another value", -) - -imploding_kwargs = my_function( - foo="test, this is a sample value", - bar=a if foo else b, - baz="hello, this is a another value", -) - -imploding_line = 1 if 1 + 1 == 2 else 0 - -exploding_line = ( - "hello this is a slightly long string" - if some_long_value_name_foo_bar_baz - else "this one is a little shorter" -) - -positional_argument_test( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz -) - - -def weird_default_argument( - x=( - some_long_value_name_foo_bar_baz - if SOME_CONSTANT - else some_fallback_value_foo_bar_baz - ), -): - pass - - -nested = ( - "hello this is a slightly long string" - if ( - some_long_value_name_foo_bar_baz - if nesting_test_expressions - else some_fallback_value_foo_bar_baz - ) - else "this one is a little shorter" -) - -generator_expression = ( - ( - some_long_value_name_foo_bar_baz - if some_boolean_variable - else some_fallback_value_foo_bar_baz - ) - for some_boolean_variable in some_iterable -) - - -def limit_offset_sql(self, low_mark, high_mark): - """Return LIMIT/OFFSET SQL clause.""" - limit, offset = self._get_limit_offset_params(low_mark, high_mark) - return " ".join( - sql - for sql in ( - "LIMIT %d" % limit if limit else None, - ("OFFSET %d" % offset) if offset else None, - ) - if sql - ) - - -def something(): - clone._iterable_class = ( - NamedValuesListIterable - if named - else FlatValuesListIterable if flat else ValuesListIterable - ) -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__blackd_diff.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__blackd_diff.py.snap index 5a0a7e590e16a..075d453d3d37a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__blackd_diff.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__blackd_diff.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/blackd_diff.py +snapshot_kind: text --- ## Input @@ -51,5 +52,3 @@ def abc (): print( "Incorrect formatting" ) ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__debug_visitor.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__debug_visitor.py.snap index 36233a64ec31c..6befff92a39ec 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__debug_visitor.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__debug_visitor.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/debug_visitor.py +snapshot_kind: text --- ## Input @@ -150,5 +151,3 @@ class DebugVisitor(Visitor[T]): v: DebugVisitor[None] = DebugVisitor() list(v.visit(lib2to3_parse(code))) ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__force_pyi.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__force_pyi.py.snap deleted file mode 100644 index 6a1fd9706d5d5..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__force_pyi.py.snap +++ /dev/null @@ -1,180 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/force_pyi.py ---- -## Input - -```python -from typing import Union - -@bird -def zoo(): ... - -class A: ... -@bar -class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg : List[str]) -> None: ... - -class C: ... -@hmm -class D: ... -class E: ... - -@baz -def foo() -> None: - ... - -class F (A , C): ... -def spam() -> None: ... - -@overload -def spam(arg: str) -> str: ... - -var : int = 1 - -def eggs() -> Union[str, int]: ... -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,32 +1,45 @@ - from typing import Union - -+ - @bird - def zoo(): ... - -+ - class A: ... - -+ - @bar - class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg: List[str]) -> None: ... - -+ - class C: ... - -+ - @hmm - class D: ... - -+ - class E: ... - -+ - @baz - def foo() -> None: ... - -+ - class F(A, C): ... - -+ - def spam() -> None: ... -+ -+ - @overload - def spam(arg: str) -> str: ... - -+ - var: int = 1 - -+ - def eggs() -> Union[str, int]: ... -``` - -## Ruff Output - -```python -from typing import Union - - -@bird -def zoo(): ... - - -class A: ... - - -@bar -class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg: List[str]) -> None: ... - - -class C: ... - - -@hmm -class D: ... - - -class E: ... - - -@baz -def foo() -> None: ... - - -class F(A, C): ... - - -def spam() -> None: ... - - -@overload -def spam(arg: str) -> str: ... - - -var: int = 1 - - -def eggs() -> Union[str, int]: ... -``` - -## Black Output - -```python -from typing import Union - -@bird -def zoo(): ... - -class A: ... - -@bar -class B: - def BMethod(self) -> None: ... - @overload - def BMethod(self, arg: List[str]) -> None: ... - -class C: ... - -@hmm -class D: ... - -class E: ... - -@baz -def foo() -> None: ... - -class F(A, C): ... - -def spam() -> None: ... -@overload -def spam(arg: str) -> str: ... - -var: int = 1 - -def eggs() -> Union[str, int]: ... -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__string_quotes.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__string_quotes.py.snap index 41d92b73c6b58..aa69aab3af88f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__string_quotes.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@miscellaneous__string_quotes.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/black/miscellaneous/string_quotes.py +snapshot_kind: text --- ## Input @@ -70,7 +71,15 @@ f"\"{a}\"{'hello' * b}\"{c}\"" ```diff --- Black +++ Ruff -@@ -25,7 +25,12 @@ +@@ -18,14 +18,19 @@ + quote""" + f"just a normal {f} string" + f"""This is a triple-quoted {f}-string""" +-f'MOAR {" ".join([])}' + f"MOAR {' '.join([])}" ++f"MOAR {' '.join([])}" + r"raw string ftw" + r"Date d\'expiration:(.*)" r'Tricky "quote' r"Not-so-tricky \"quote" rf"{yay}" @@ -84,6 +93,25 @@ f"\"{a}\"{'hello' * b}\"{c}\"" re.compile(r'[\\"]') "x = ''; y = \"\"" "x = '''; y = \"\"" +@@ -40,14 +45,14 @@ + '\\""' + "\\''" + "Lots of \\\\\\\\'quotes'" +-f'{y * " "} \'{z}\'' ++f"{y * ' '} '{z}'" + f"{{y * \" \"}} '{z}'" +-f'\'{z}\' {y * " "}' ++f"'{z}' {y * ' '}" + f"{y * x} '{z}'" + "'{z}' {y * \" \"}" + "{y * x} '{z}'" + + # We must bail out if changing the quotes would introduce backslashes in f-string + # expressions. xref: https://github.com/psf/black/issues/2348 +-f"\"{b}\"{' ' * (long-len(b)+1)}: \"{sts}\",\n" +-f"\"{a}\"{'hello' * b}\"{c}\"" ++f'"{b}"{" " * (long - len(b) + 1)}: "{sts}",\n' ++f'"{a}"{"hello" * b}"{c}"' ``` ## Ruff Output @@ -109,7 +137,7 @@ f"\"{a}\"{'hello' * b}\"{c}\"" quote""" f"just a normal {f} string" f"""This is a triple-quoted {f}-string""" -f'MOAR {" ".join([])}' +f"MOAR {' '.join([])}" f"MOAR {' '.join([])}" r"raw string ftw" r"Date d\'expiration:(.*)" @@ -136,17 +164,17 @@ re.compile(r'[\\"]') '\\""' "\\''" "Lots of \\\\\\\\'quotes'" -f'{y * " "} \'{z}\'' +f"{y * ' '} '{z}'" f"{{y * \" \"}} '{z}'" -f'\'{z}\' {y * " "}' +f"'{z}' {y * ' '}" f"{y * x} '{z}'" "'{z}' {y * \" \"}" "{y * x} '{z}'" # We must bail out if changing the quotes would introduce backslashes in f-string # expressions. xref: https://github.com/psf/black/issues/2348 -f"\"{b}\"{' ' * (long-len(b)+1)}: \"{sts}\",\n" -f"\"{a}\"{'hello' * b}\"{c}\"" +f'"{b}"{" " * (long - len(b) + 1)}: "{sts}",\n' +f'"{a}"{"hello" * b}"{c}"' ``` ## Black Output @@ -206,5 +234,3 @@ f"{y * x} '{z}'" f"\"{b}\"{' ' * (long-len(b)+1)}: \"{sts}\",\n" f"\"{a}\"{'hello' * b}\"{c}\"" ``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@raw_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@raw_docstring.py.snap deleted file mode 100644 index 833cc46882f7c..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@raw_docstring.py.snap +++ /dev/null @@ -1,86 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/raw_docstring.py ---- -## Input - -```python -# flags: --preview --skip-string-normalization -class C: - - r"""Raw""" - -def f(): - - r"""Raw""" - -class SingleQuotes: - - - r'''Raw''' - -class UpperCaseR: - R"""Raw""" -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -1,3 +1,4 @@ -+# flags: --preview --skip-string-normalization - class C: - r"""Raw""" - -@@ -7,7 +8,7 @@ - - - class SingleQuotes: -- r'''Raw''' -+ r"""Raw""" - - - class UpperCaseR: -``` - -## Ruff Output - -```python -# flags: --preview --skip-string-normalization -class C: - r"""Raw""" - - -def f(): - r"""Raw""" - - -class SingleQuotes: - r"""Raw""" - - -class UpperCaseR: - R"""Raw""" -``` - -## Black Output - -```python -class C: - r"""Raw""" - - -def f(): - r"""Raw""" - - -class SingleQuotes: - r'''Raw''' - - -class UpperCaseR: - R"""Raw""" -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@simple_cases__preview_hug_parens_with_braces_and_square_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/black_compatibility@simple_cases__preview_hug_parens_with_braces_and_square_brackets.py.snap deleted file mode 100644 index df9471aac22dc..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/black_compatibility@simple_cases__preview_hug_parens_with_braces_and_square_brackets.py.snap +++ /dev/null @@ -1,543 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/preview_hug_parens_with_braces_and_square_brackets.py ---- -## Input - -```python -def foo_brackets(request): - return JsonResponse( - { - "var_1": foo, - "var_2": bar, - } - ) - -def foo_square_brackets(request): - return JsonResponse( - [ - "var_1", - "var_2", - ] - ) - -func({"a": 37, "b": 42, "c": 927, "aaaaaaaaaaaaaaaaaaaaaaaaa": 11111111111111111111111111111111111111111}) - -func(["random_string_number_one","random_string_number_two","random_string_number_three","random_string_number_four"]) - -func( - { - # expand me - 'a':37, - 'b':42, - 'c':927 - } -) - -func( - [ - 'a', - 'b', - 'c', - ] -) - -func( - [ - 'a', - 'b', - 'c', - ], -) - -func( # a - [ # b - "c", # c - "d", # d - "e", # e - ] # f -) # g - -func( # a - { # b - "c": 1, # c - "d": 2, # d - "e": 3, # e - } # f -) # g - -func( - # preserve me - [ - "c", - "d", - "e", - ] -) - -func( - [ # preserve me but hug brackets - "c", - "d", - "e", - ] -) - -func( - [ - # preserve me but hug brackets - "c", - "d", - "e", - ] -) - -func( - [ - "c", - # preserve me but hug brackets - "d", - "e", - ] -) - -func( - [ - "c", - "d", - "e", - # preserve me but hug brackets - ] -) - -func( - [ - "c", - "d", - "e", - ] # preserve me but hug brackets -) - -func( - [ - "c", - "d", - "e", - ] - # preserve me -) - -func([x for x in "short line"]) -func([x for x in "long line long line long line long line long line long line long line"]) -func([x for x in [x for x in "long line long line long line long line long line long line long line"]]) - -func({"short line"}) -func({"long line", "long long line", "long long long line", "long long long long line", "long long long long long line"}) -func({{"long line", "long long line", "long long long line", "long long long long line", "long long long long long line"}}) - -foooooooooooooooooooo( - [{c: n + 1 for c in range(256)} for n in range(100)] + [{}], {size} -) - -baaaaaaaaaaaaar( - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {x}, "a string", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -) - -foo(*["long long long long long line", "long long long long long line", "long long long long long line"]) - -foo(*[str(i) for i in range(100000000000000000000000000000000000000000000000000000000000)]) -``` - -## Black Differences - -```diff ---- Black -+++ Ruff -@@ -47,17 +47,21 @@ - ], - ) - --func([ # a # b -- "c", # c -- "d", # d -- "e", # e --]) # f # g -+func( # a -+ [ # b -+ "c", # c -+ "d", # d -+ "e", # e -+ ] # f -+) # g - --func({ # a # b -- "c": 1, # c -- "d": 2, # d -- "e": 3, # e --}) # f # g -+func( # a -+ { # b -+ "c": 1, # c -+ "d": 2, # d -+ "e": 3, # e -+ } # f -+) # g - - func( - # preserve me -@@ -95,11 +99,13 @@ - # preserve me but hug brackets - ]) - --func([ -- "c", -- "d", -- "e", --]) # preserve me but hug brackets -+func( -+ [ -+ "c", -+ "d", -+ "e", -+ ] # preserve me but hug brackets -+) - - func( - [ -``` - -## Ruff Output - -```python -def foo_brackets(request): - return JsonResponse({ - "var_1": foo, - "var_2": bar, - }) - - -def foo_square_brackets(request): - return JsonResponse([ - "var_1", - "var_2", - ]) - - -func({ - "a": 37, - "b": 42, - "c": 927, - "aaaaaaaaaaaaaaaaaaaaaaaaa": 11111111111111111111111111111111111111111, -}) - -func([ - "random_string_number_one", - "random_string_number_two", - "random_string_number_three", - "random_string_number_four", -]) - -func({ - # expand me - "a": 37, - "b": 42, - "c": 927, -}) - -func([ - "a", - "b", - "c", -]) - -func( - [ - "a", - "b", - "c", - ], -) - -func( # a - [ # b - "c", # c - "d", # d - "e", # e - ] # f -) # g - -func( # a - { # b - "c": 1, # c - "d": 2, # d - "e": 3, # e - } # f -) # g - -func( - # preserve me - [ - "c", - "d", - "e", - ] -) - -func([ # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - "c", - # preserve me but hug brackets - "d", - "e", -]) - -func([ - "c", - "d", - "e", - # preserve me but hug brackets -]) - -func( - [ - "c", - "d", - "e", - ] # preserve me but hug brackets -) - -func( - [ - "c", - "d", - "e", - ] - # preserve me -) - -func([x for x in "short line"]) -func([ - x for x in "long line long line long line long line long line long line long line" -]) -func([ - x - for x in [ - x - for x in "long line long line long line long line long line long line long line" - ] -]) - -func({"short line"}) -func({ - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", -}) -func({ - { - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", - } -}) - -foooooooooooooooooooo( - [{c: n + 1 for c in range(256)} for n in range(100)] + [{}], {size} -) - -baaaaaaaaaaaaar( - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {x}, "a string", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -) - -foo(*[ - "long long long long long line", - "long long long long long line", - "long long long long long line", -]) - -foo(*[ - str(i) for i in range(100000000000000000000000000000000000000000000000000000000000) -]) -``` - -## Black Output - -```python -def foo_brackets(request): - return JsonResponse({ - "var_1": foo, - "var_2": bar, - }) - - -def foo_square_brackets(request): - return JsonResponse([ - "var_1", - "var_2", - ]) - - -func({ - "a": 37, - "b": 42, - "c": 927, - "aaaaaaaaaaaaaaaaaaaaaaaaa": 11111111111111111111111111111111111111111, -}) - -func([ - "random_string_number_one", - "random_string_number_two", - "random_string_number_three", - "random_string_number_four", -]) - -func({ - # expand me - "a": 37, - "b": 42, - "c": 927, -}) - -func([ - "a", - "b", - "c", -]) - -func( - [ - "a", - "b", - "c", - ], -) - -func([ # a # b - "c", # c - "d", # d - "e", # e -]) # f # g - -func({ # a # b - "c": 1, # c - "d": 2, # d - "e": 3, # e -}) # f # g - -func( - # preserve me - [ - "c", - "d", - "e", - ] -) - -func([ # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - # preserve me but hug brackets - "c", - "d", - "e", -]) - -func([ - "c", - # preserve me but hug brackets - "d", - "e", -]) - -func([ - "c", - "d", - "e", - # preserve me but hug brackets -]) - -func([ - "c", - "d", - "e", -]) # preserve me but hug brackets - -func( - [ - "c", - "d", - "e", - ] - # preserve me -) - -func([x for x in "short line"]) -func([ - x for x in "long line long line long line long line long line long line long line" -]) -func([ - x - for x in [ - x - for x in "long line long line long line long line long line long line long line" - ] -]) - -func({"short line"}) -func({ - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", -}) -func({ - { - "long line", - "long long line", - "long long long line", - "long long long long line", - "long long long long long line", - } -}) - -foooooooooooooooooooo( - [{c: n + 1 for c in range(256)} for n in range(100)] + [{}], {size} -) - -baaaaaaaaaaaaar( - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {x}, "a string", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -) - -foo(*[ - "long long long long long line", - "long long long long long line", - "long long long long long line", -]) - -foo(*[ - str(i) for i in range(100000000000000000000000000000000000000000000000000000000000) -]) -``` - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@blank_line_before_class_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@blank_line_before_class_docstring.py.snap index 9f3a01f99c2f8..58cfb7e492610 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@blank_line_before_class_docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@blank_line_before_class_docstring.py.snap @@ -56,7 +56,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -92,6 +92,3 @@ class DocstringWithComment4: """This is a docstring.""" ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@carriage_return__string.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@carriage_return__string.py.snap index 97df9f7e82e15..aeb2348f71572 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@carriage_return__string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@carriage_return__string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/carriage_return/string.py +snapshot_kind: text --- ## Input ```python @@ -21,6 +22,3 @@ backslashes or newline characters." String \" """ ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring.py.snap index 5a9741d3b8516..9ca83e81deeb2 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring.py.snap @@ -175,7 +175,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -351,7 +351,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -527,7 +527,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -703,7 +703,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -879,7 +879,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_chaperones.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_chaperones.py.snap new file mode 100644 index 0000000000000..a70158a84ed18 --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_chaperones.py.snap @@ -0,0 +1,195 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_chaperones.py +--- +## Input +```python +def a1(): + """Needs chaperone\\" """ + +def a2(): + """Needs chaperone\\\ """ + +def a3(): + """Needs chaperone" """ + +def a4(): + """Needs chaperone\ """ + +def a5(): + """Needs chaperone\\\\\ """ + +def a6(): + """Needs chaperone\"" """ + +def a7(): + """Doesn't need chaperone\"""" + +def a8(): + """Doesn't need chaperone\'""" + +def a9(): + """Doesn't need chaperone\\\"""" + +def a10(): + """Doesn't need chaperone\\\'""" + +def a11(): + """Doesn't need chaperone; all slashes escaped\\\\""" + +def a12(): + """Doesn't need chaperone\\""" + +def a12(): + """Doesn't need "chaperone" with contained quotes""" + +def a13(): + """Doesn't need chaperone\\\"\"\"""" + +def a14(): + """Multiline docstring + doesn't need chaperone + """ + +def a15(): + """Multiline docstring + doesn't need chaperone\ + """ + +def a16(): + """Multiline docstring with + odd number of backslashes don't need chaperone\\\ + """ + +def a17(): + """Multiline docstring with + even number of backslashes don't need chaperone\\\\ + """ + +def a18(): + r"""Raw multiline docstring + doesn't need chaperone\ + """ +``` + +## Output +```python +def a1(): + """Needs chaperone\\" """ + + +def a2(): + """Needs chaperone\\\ """ + + +def a3(): + """Needs chaperone" """ + + +def a4(): + """Needs chaperone\ """ + + +def a5(): + """Needs chaperone\\\\\ """ + + +def a6(): + """Needs chaperone\"" """ + + +def a7(): + """Doesn't need chaperone\" """ + + +def a8(): + """Doesn't need chaperone\'""" + + +def a9(): + """Doesn't need chaperone\\\" """ + + +def a10(): + """Doesn't need chaperone\\\'""" + + +def a11(): + """Doesn't need chaperone; all slashes escaped\\\\""" + + +def a12(): + """Doesn't need chaperone\\""" + + +def a12(): + """Doesn't need "chaperone" with contained quotes""" + + +def a13(): + """Doesn't need chaperone\\\"\"\" """ + + +def a14(): + """Multiline docstring + doesn't need chaperone + """ + + +def a15(): + """Multiline docstring + doesn't need chaperone\ + """ + + +def a16(): + """Multiline docstring with + odd number of backslashes don't need chaperone\\\ + """ + + +def a17(): + """Multiline docstring with + even number of backslashes don't need chaperone\\\\ + """ + + +def a18(): + r"""Raw multiline docstring + doesn't need chaperone\ + """ +``` + + +## Preview changes +```diff +--- Stable ++++ Preview +@@ -23,7 +23,7 @@ + + + def a7(): +- """Doesn't need chaperone\" """ ++ """Doesn't need chaperone\"""" + + + def a8(): +@@ -31,7 +31,7 @@ + + + def a9(): +- """Doesn't need chaperone\\\" """ ++ """Doesn't need chaperone\\\"""" + + + def a10(): +@@ -51,7 +51,7 @@ + + + def a13(): +- """Doesn't need chaperone\\\"\"\" """ ++ """Doesn't need chaperone\\\"\"\"""" + + + def a14(): +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples.py.snap index f1e571e0eae14..024d662e0ae6b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples.py.snap @@ -1368,7 +1368,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -2740,7 +2740,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -4112,7 +4112,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -5484,7 +5484,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -6856,7 +6856,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -8221,7 +8221,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -9586,7 +9586,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -10960,7 +10960,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -12325,7 +12325,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = 60 preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -13699,7 +13699,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -15051,6 +15051,3 @@ def markdown_skipped_rst_directive(): """ pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_crlf.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_crlf.py.snap index cc1c3b7e527c2..9b1dc4ba525f8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_crlf.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_crlf.py.snap @@ -27,7 +27,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -42,6 +42,3 @@ def doctest_line_ending(): """ pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_dynamic_line_width.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_dynamic_line_width.py.snap index fd884666c438c..7112865500923 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_dynamic_line_width.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_code_examples_dynamic_line_width.py.snap @@ -308,7 +308,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -615,7 +615,9 @@ def length_doctest(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -630,7 +632,9 @@ def length_doctest_underindent(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -648,7 +652,9 @@ def length_markdown(): Example: ``` - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) ``` """ @@ -658,7 +664,9 @@ def length_rst(): """ Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) """ pass @@ -669,7 +677,9 @@ def length_rst_in_section(): Examples: Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ) """ pass ``` @@ -694,11 +704,13 @@ def length_rst_in_section(): """ -@@ -300,7 +302,28 @@ +@@ -300,9 +302,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -724,11 +736,13 @@ def length_rst_in_section(): 20 """ -@@ -315,7 +338,28 @@ +@@ -317,9 +338,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -754,11 +768,13 @@ def length_rst_in_section(): 20 """ -@@ -333,7 +377,29 @@ +@@ -337,9 +377,29 @@ Example: ``` -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -785,11 +801,13 @@ def length_rst_in_section(): ``` """ -@@ -343,7 +409,29 @@ +@@ -349,9 +409,29 @@ """ Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -816,11 +834,13 @@ def length_rst_in_section(): """ pass -@@ -354,6 +442,27 @@ +@@ -362,8 +442,27 @@ Examples: Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ) + length([ + 1, + 2, @@ -859,7 +879,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -1156,7 +1176,9 @@ def length_doctest(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -1171,7 +1193,9 @@ def length_doctest_underindent(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -1189,7 +1213,9 @@ def length_markdown(): Example: ``` - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) ``` """ @@ -1199,7 +1225,9 @@ def length_rst(): """ Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) """ pass @@ -1210,7 +1238,9 @@ def length_rst_in_section(): Examples: Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ) """ pass ``` @@ -1220,11 +1250,13 @@ def length_rst_in_section(): ```diff --- Stable +++ Preview -@@ -290,7 +290,28 @@ +@@ -290,9 +290,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -1250,11 +1282,13 @@ def length_rst_in_section(): 20 """ -@@ -305,7 +326,28 @@ +@@ -307,9 +326,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -1280,11 +1314,13 @@ def length_rst_in_section(): 20 """ -@@ -323,7 +365,29 @@ +@@ -327,9 +365,29 @@ Example: ``` -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -1311,11 +1347,13 @@ def length_rst_in_section(): ``` """ -@@ -333,7 +397,29 @@ +@@ -339,9 +397,29 @@ """ Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -1342,11 +1380,13 @@ def length_rst_in_section(): """ pass -@@ -344,6 +430,27 @@ +@@ -352,8 +430,27 @@ Examples: Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ) + length([ + 1, + 2, @@ -1385,7 +1425,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -1692,7 +1732,9 @@ def length_doctest(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -1707,7 +1749,9 @@ def length_doctest_underindent(): Integer length of the list of numbers. Example: - >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + >>> length( + ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ... ) 20 """ @@ -1725,7 +1769,9 @@ def length_markdown(): Example: ``` - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) ``` """ @@ -1735,7 +1781,9 @@ def length_rst(): """ Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] + ) """ pass @@ -1746,7 +1794,9 @@ def length_rst_in_section(): Examples: Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + length( + [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] + ) """ pass ``` @@ -1771,11 +1821,13 @@ def length_rst_in_section(): """ -@@ -300,7 +302,28 @@ +@@ -300,9 +302,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -1801,11 +1853,13 @@ def length_rst_in_section(): 20 """ -@@ -315,7 +338,28 @@ +@@ -317,9 +338,28 @@ Integer length of the list of numbers. Example: -- >>> length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- >>> length( +- ... [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ... ) + >>> length([ + ... 1, + ... 2, @@ -1831,11 +1885,13 @@ def length_rst_in_section(): 20 """ -@@ -333,7 +377,29 @@ +@@ -337,9 +377,29 @@ Example: ``` -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -1862,11 +1918,13 @@ def length_rst_in_section(): ``` """ -@@ -343,7 +409,29 @@ +@@ -349,9 +409,29 @@ """ Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] +- ) + length([ + 1, + 2, @@ -1893,11 +1951,13 @@ def length_rst_in_section(): """ pass -@@ -354,6 +442,27 @@ +@@ -362,8 +442,27 @@ Examples: Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- length( +- [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] +- ) + length([ + 1, + 2, @@ -1936,7 +1996,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -2821,7 +2881,30 @@ def length_rst_in_section(): Examples: Do cool stuff:: - length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) + length( + [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + ] + ) """ pass ``` @@ -3062,11 +3145,34 @@ def length_rst_in_section(): """ pass -@@ -878,6 +872,27 @@ +@@ -878,29 +872,27 @@ Examples: Do cool stuff:: -- length([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]) +- length( +- [ +- 1, +- 2, +- 3, +- 4, +- 5, +- 6, +- 7, +- 8, +- 9, +- 10, +- 11, +- 12, +- 13, +- 14, +- 15, +- 16, +- 17, +- 18, +- 19, +- 20, +- ] +- ) + length([ + 1, + 2, diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_newlines.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_newlines.py.snap index ee05a1d3338b8..dfa63ea82e8f5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_newlines.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_newlines.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_newlines.py +snapshot_kind: text --- ## Input ```python @@ -120,6 +121,3 @@ def test7(): """ ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_non_visible_characters.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_non_visible_characters.py.snap index 9029655d5a8ed..ae7ba4d031abb 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_non_visible_characters.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_non_visible_characters.py.snap @@ -1,10 +1,11 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_non_visible_characters.py +snapshot_kind: text --- ## Input ```python -# Regresssion test for https://github.com/astral-sh/ruff/issues/11724 +# Regression test for https://github.com/astral-sh/ruff/issues/11724 '''  @@ -14,7 +15,7 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_ ## Output ```python -# Regresssion test for https://github.com/astral-sh/ruff/issues/11724 +# Regression test for https://github.com/astral-sh/ruff/issues/11724 """  diff --git a/crates/ruff_python_formatter/tests/snapshots/format@docstring_tab_indentation.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@docstring_tab_indentation.py.snap index 01089b0c964cb..a7e5f5d84fc47 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@docstring_tab_indentation.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@docstring_tab_indentation.py.snap @@ -90,7 +90,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -184,7 +184,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -265,6 +265,3 @@ def ascii_art(): d e """ ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@empty_multiple_trailing_newlines.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@empty_multiple_trailing_newlines.py.snap index 3346623b73176..500a70557705d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@empty_multiple_trailing_newlines.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@empty_multiple_trailing_newlines.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_multiple_trailing_newlines.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@empty_now_newline.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@empty_now_newline.py.snap index cc9ebfcc7e754..4d3261a9d4288 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@empty_now_newline.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@empty_now_newline.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_now_newline.py +snapshot_kind: text --- ## Input ```python @@ -9,6 +10,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_now_ ## Output ```python ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@empty_trailing_newline.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@empty_trailing_newline.py.snap index 6caaf01e0e091..0e5082e40da7b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@empty_trailing_newline.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@empty_trailing_newline.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_trailing_newline.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@empty_whitespace.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@empty_whitespace.py.snap index 48184db5a3257..92ad1d52a8f6a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@empty_whitespace.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@empty_whitespace.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_whitespace.py +snapshot_kind: text --- ## Input ```python @@ -9,6 +10,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/empty_whit ## Output ```python ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__annotated_assign.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__annotated_assign.py.snap index 0ce76c87517d4..9afbb316f15d5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__annotated_assign.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__annotated_assign.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/annotated_assign.py +snapshot_kind: text --- ## Input ```python @@ -32,6 +33,3 @@ b: list[ int, ] = [1, 2] ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__attribute.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__attribute.py.snap index bbcc0efd95af9..89ce7d237b16d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__attribute.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__attribute.py.snap @@ -158,6 +158,23 @@ result = ( f(111111111111111111111111111111111111111111111111111111111111111111111111111111111) + 1 ).bit_length() + + +# Regression test for https://github.com/astral-sh/ruff/issues/16151 +result = ( + (await query_the_thing(mypy_doesnt_understand)) # type: ignore[x] + .foo() + .bar() +) + +( + ( + a # trailing end-of-line + # trailing own-line + ) # trailing closing parentheses + # dangling before dot + .b # trailing end-of-line +) ``` ## Output @@ -294,7 +311,21 @@ result = ( f(111111111111111111111111111111111111111111111111111111111111111111111111111111111) + 1 ).bit_length() -``` +# Regression test for https://github.com/astral-sh/ruff/issues/16151 +result = ( + (await query_the_thing(mypy_doesnt_understand)) # type: ignore[x] + .foo() + .bar() +) +( + ( + a # trailing end-of-line + # trailing own-line + ) # trailing closing parentheses + # dangling before dot + .b # trailing end-of-line +) +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__await.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__await.py.snap index 9a9a7da7cbeb8..de396cccfbddc 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__await.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__await.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/await.py +snapshot_kind: text --- ## Input ```python @@ -141,6 +142,3 @@ test_data = await ( .to_list() ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary.py.snap index 1d59b5b13a1bc..9a5b9d1882001 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary.py.snap @@ -424,6 +424,19 @@ if True: "permissions to manage this role, or else members of this role won't receive " "a notification." ) + +# This f-string should be flattened +xxxxxxxxxxxxxxxx = f"aaaaaaaaaaaaaaaaaaaaa { + expression } bbbbbbbbbbbbbbbbbbbbbbbb" + ( + yyyyyyyyyyyyyy + zzzzzzzzzzz +) + +# This is not a multiline f-string, but the expression is too long so it should be +# wrapped in parentheses. +f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) +aaaaaaaaaaa = f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) ``` ## Output @@ -896,7 +909,22 @@ if True: "permissions to manage this role, or else members of this role won't receive " "a notification." ) -``` - +# This f-string should be flattened +xxxxxxxxxxxxxxxx = f"aaaaaaaaaaaaaaaaaaaaa {expression} bbbbbbbbbbbbbbbbbbbbbbbb" + ( + yyyyyyyyyyyyyy + zzzzzzzzzzz +) +# This is not a multiline f-string, but the expression is too long so it should be +# wrapped in parentheses. +( + f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) +) +aaaaaaaaaaa = ( + f"hellooooooooooooooooooooooo \ + worlddddddddddddddddddddddddddddddddd" + + (aaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbb) +) +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_implicit_string.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_implicit_string.py.snap index 585f222d40096..f05c74e3d1cd7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_implicit_string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_implicit_string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary_implicit_string.py +snapshot_kind: text --- ## Input ```python @@ -398,27 +399,9 @@ c = ( "dddddddddddddddddddddddddd" % aaaaaaaaaaaa + x ) -"a" "b" "c" + "d" "e" + "f" "g" + "h" "i" "j" +"abc" + "de" + "fg" + "hij" class EC2REPATH: - f.write("Pathway name" + "\t" "Database Identifier" + "\t" "Source database" + "\n") -``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -197,8 +197,8 @@ - "dddddddddddddddddddddddddd" % aaaaaaaaaaaa + x - ) - --"a" "b" "c" + "d" "e" + "f" "g" + "h" "i" "j" -+"abc" + "de" + "fg" + "hij" - - - class EC2REPATH: -- f.write("Pathway name" + "\t" "Database Identifier" + "\t" "Source database" + "\n") -+ f.write("Pathway name" + "\tDatabase Identifier" + "\tSource database" + "\n") + f.write("Pathway name" + "\tDatabase Identifier" + "\tSource database" + "\n") ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_pow_spacing.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_pow_spacing.py.snap index f54dfeb51cfd8..cfe64811727ad 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_pow_spacing.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__binary_pow_spacing.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/binary_pow_spacing.py +snapshot_kind: text --- ## Input ```python @@ -29,6 +30,3 @@ None**None # Space "a" ** "b" ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__boolean_operation.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__boolean_operation.py.snap index 74c03816e94ba..592c5446781be 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__boolean_operation.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__boolean_operation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/boolean_operation.py +snapshot_kind: text --- ## Input ```python @@ -401,6 +402,3 @@ if ( ): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__bytes.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__bytes.py.snap index 852c7b92282a9..0e9e65cf924c1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__bytes.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__bytes.py.snap @@ -140,7 +140,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -210,9 +210,9 @@ String \"\"\" # String continuation -b"Let's" b"start" b"with" b"a" b"simple" b"example" +b"Let'sstartwithasimpleexample" -b"Let's" b"start" b"with" b"a" b"simple" b"example" b"now repeat after me:" b"I am confident" b"I am confident" b"I am confident" b"I am confident" b"I am confident" +b"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" ( b"Let's" @@ -279,39 +279,12 @@ test_particular = [ ] # Parenthesized string continuation with messed up indentation -{"key": ([], b"a" b"b" b"c")} +{"key": ([], b"abc")} b"Unicode Escape sequence don't apply to bytes: \N{0x} \u{ABCD} \U{ABCDEFGH}" ``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -63,9 +63,9 @@ - - # String continuation - --b"Let's" b"start" b"with" b"a" b"simple" b"example" -+b"Let'sstartwithasimpleexample" - --b"Let's" b"start" b"with" b"a" b"simple" b"example" b"now repeat after me:" b"I am confident" b"I am confident" b"I am confident" b"I am confident" b"I am confident" -+b"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" - - ( - b"Let's" -@@ -132,6 +132,6 @@ - ] - - # Parenthesized string continuation with messed up indentation --{"key": ([], b"a" b"b" b"c")} -+{"key": ([], b"abc")} - - b"Unicode Escape sequence don't apply to bytes: \N{0x} \u{ABCD} \U{ABCDEFGH}" -``` - - ### Output 2 ``` indent-style = space @@ -323,7 +296,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -393,9 +366,9 @@ String \"\"\" # String continuation -b"Let's" b'start' b'with' b'a' b'simple' b'example' +b"Let'sstartwithasimpleexample" -b"Let's" b'start' b'with' b'a' b'simple' b'example' b'now repeat after me:' b'I am confident' b'I am confident' b'I am confident' b'I am confident' b'I am confident' +b"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" ( b"Let's" @@ -462,34 +435,7 @@ test_particular = [ ] # Parenthesized string continuation with messed up indentation -{'key': ([], b'a' b'b' b'c')} +{'key': ([], b'abc')} b"Unicode Escape sequence don't apply to bytes: \N{0x} \u{ABCD} \U{ABCDEFGH}" ``` - - -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -63,9 +63,9 @@ - - # String continuation - --b"Let's" b'start' b'with' b'a' b'simple' b'example' -+b"Let'sstartwithasimpleexample" - --b"Let's" b'start' b'with' b'a' b'simple' b'example' b'now repeat after me:' b'I am confident' b'I am confident' b'I am confident' b'I am confident' b'I am confident' -+b"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" - - ( - b"Let's" -@@ -132,6 +132,6 @@ - ] - - # Parenthesized string continuation with messed up indentation --{'key': ([], b'a' b'b' b'c')} -+{'key': ([], b'abc')} - - b"Unicode Escape sequence don't apply to bytes: \N{0x} \u{ABCD} \U{ABCDEFGH}" -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__call.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__call.py.snap index 1b35bce81b919..6b5d7bfa99fe5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__call.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__call.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/call.py +snapshot_kind: text --- ## Input ```python @@ -556,6 +557,3 @@ result = ( result = (object[complicate_caller])("argument").a["b"].test(argument) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__compare.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__compare.py.snap index 314a53513b8ba..431223f6b4173 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__compare.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__compare.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/compare.py +snapshot_kind: text --- ## Input ```python @@ -418,6 +419,3 @@ c = ( "b" > b ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__dict.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__dict.py.snap index 6ecda476dd956..1575a817d2da1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__dict.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__dict.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/dict.py +snapshot_kind: text --- ## Input ```python @@ -256,6 +257,3 @@ query = { ): [clause for kf_pair in queries for clause in kf_pair["fragment"]] } ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__dict_comp.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__dict_comp.py.snap index 56181cd10a05d..fefd84ab8166c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__dict_comp.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__dict_comp.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/dict_comp.py +snapshot_kind: text --- ## Input ```python @@ -403,6 +404,3 @@ query = { for key, queries in self._filters.items() } ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring.py.snap index af2a324aa36a0..b357a01b9f6cb 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring.py.snap @@ -319,6 +319,321 @@ f"{ # comment 26 # comment 28 } woah {x}" +# Assignment statement + +# Even though this f-string has multiline expression, thus allowing us to break it at the +# curly braces, the f-string fits on a single line if it's moved inside the parentheses. +# We should prefer doing that instead. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" + +# Same as above +xxxxxxx = f"{ + {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} +}" + +# Similar to the previous example, but the f-string will exceed the line length limit, +# we shouldn't add any parentheses here. +xxxxxxx = f"{ + {'aaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} +}" + +# Same as above but with an inline comment. The f-string should be formatted inside the +# parentheses and the comment should be part of the line inside the parentheses. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment + +# Similar to the previous example but this time parenthesizing doesn't work because it +# exceeds the line length. So, avoid parenthesizing this f-string. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# Similar to the previous example but we start with the parenthesized layout. This should +# remove the parentheses and format the f-string on a single line. This shows that the +# final layout for the formatter is same for this and the previous case. The only +# difference is that in the previous case the expression is already mulitline which means +# the formatter can break it further at the curly braces. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment loooooooong +) + +# The following f-strings are going to break because of the trailing comma so we should +# avoid using the best fit layout and instead use the default layout. +# left-to-right +aaaa = f"aaaa {[ + 1, 2, +]} bbbb" +# right-to-left +aaaa, bbbb = f"aaaa {[ + 1, 2, +]} bbbb" + +# Using the right-to-left assignment statement variant. +aaaaaaaaaaaaaaaaaa, bbbbbbbbbbb = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeee" # comment + +# Here, the f-string layout is flat but it exceeds the line length limit. This shouldn't +# try the custom best fit layout because the f-string doesn't have any split points. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +# Same as above but without the parentheses to test that it gets formatted to the same +# layout as the previous example. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" + +# But, the following f-string does have a split point because of the multiline expression. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbb + cccccccccccccccccccccc + dddddddddddddddddddddddddddd} ddddddddddddddddddd" +) + +# This is an implicitly concatenated f-string but it cannot be joined because otherwise +# it'll exceed the line length limit. So, the two f-strings will be inside parentheses +# instead and the inline comment should be outside the parentheses. +a = f"test{ + expression +}flat" f"can be { + joined +} togethereeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# Similar to the above example but this fits within the line length limit. +a = f"test{ + expression +}flat" f"can be { + joined +} togethereeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# The following test cases are adopted from implicit string concatenation but for a +# single f-string instead. + +# Don't inline f-strings that contain expressions that are guaranteed to split, e.g. because of a magic trailing comma +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment +) + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = (f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ +[a,] +}moreeeeeeeeeeeeeeeeeeee" # comment +) + +# Don't inline f-strings that contain commented expressions +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{[ + a # comment + ]}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{[ + a # comment + ]}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# Don't inline f-strings with multiline debug expressions or format specifiers +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + + b=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaa[aaaaaaaaaaa] = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# This is not a multiline f-string even though it has a newline after the format specifier. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest" # comment +) + +# The newline is only considered when it's a tripled-quoted f-string. +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +aaaaaaaaaaaaaaaaaa = ( + f"""testeeeeeeeeeeeeeeeeeeeeeeeee{ + a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment +) + +# Remove the parentheses here +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{[a, b, + # comment + ]}moee" # comment +) +# ... but not here because of the ownline comment +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{[a, b, + ]}moee" + # comment +) + +# F-strings in other positions + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if ( + f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + }" +): pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { # comment + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": pass + +if f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if ( + f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + }" +): + pass + +if f"aaaaaaaaaaa {[ttttteeeeeeeeest,]} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +# For loops +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeee": + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# With statements +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeee": + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# Assert statements +assert f"aaaaaaaaa{ + expression}bbbbbbbbbbbb", f"cccccccccc{ + expression}dddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{ + expression}dddddddddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{expression}dddddddddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccccccccccccccccc { + expression} dddddddddddddddddddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"cccccccccccccccccccccccccccccccc {expression} ddddddddddddddddddddddddddddddddddddd" + +# F-strings as a single argument to a call expression to test whether it's huggable or not. +call(f"{ + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"{ + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"{ # comment + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee +}") + +call(f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""") + +call(f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""") + +call( + f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""" +) + +call(f"{ + aaaaaa + + '''test + more''' +}") + # Indentation # What should be the indentation? @@ -352,6 +667,76 @@ _ = ( f'This string uses double quotes in an expression {"it's a quote"}' f'This f-string does not use any quotes.' ) + +# Regression test for https://github.com/astral-sh/ruff/issues/14487 +f"aaaaaaaaaaaaaaaaaaaaaaaaaa {10**27} bbbbbbbbbbbbbbbbbbbbbbbbbb ccccccccccccccccccccccccc" + +# Regression test for https://github.com/astral-sh/ruff/issues/14778 +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' 'a' if True else ""}" +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' 'a' if True else ""}" + +# Quotes reuse +f"{'a'}" + +# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes +f'foo {10 + len("bar")=}' +f'''foo {10 + len("""bar""")=}''' + +# 312+, it's okay to change the quotes here without creating an invalid f-string +f'{"""other " """}' +f'{"""other " """ + "more"}' +f'{b"""other " """}' +f'{f"""other " """}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 +f'{1: hy "user"}' +f'{1:hy "user"}' +f'{1: abcd "{1}" }' +f'{1: abcd "{'aa'}" }' +f'{1=: "abcd {'aa'}}' +f'{x:a{z:hy "user"}} \'\'\'' + +# Changing the outer quotes is fine because the format-spec is in a nested expression. +f'{f'{z=:hy "user"}'} \'\'\'' + + +# We have to be careful about changing the quotes if the f-string has a debug expression because it is inserted verbatim. +f'{1=: "abcd \'\'}' # Don't change the outer quotes, or it results in a syntax error +f'{1=: abcd \'\'}' # Changing the quotes here is fine because the inner quotes aren't the opposite quotes +f'{1=: abcd \"\"}' # Changing the quotes here is fine because the inner quotes are escaped +# Don't change the quotes in the following cases: +f'{x=:hy "user"} \'\'\'' +f'{x=:a{y:hy "user"}} \'\'\'' +f'{x=:a{y:{z:hy "user"}}} \'\'\'' +f'{x:a{y=:{z:hy "user"}}} \'\'\'' + +# This is fine because the debug expression and format spec are in a nested expression + +f"""{1=: "this" is fine}""" +f'''{1=: "this" is fine}''' # Change quotes to double quotes because they're preferred +f'{1=: {'ab"cd"'}}' # It's okay if the quotes are in an expression part. + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15459 +print(f"{ {1, 2, 3} - {2} }") +print(f"{ {1: 2}.keys() }") +print(f"{({1, 2, 3}) - ({2})}") +print(f"{1, 2, {3} }") +print(f"{(1, 2, {3})}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15535 +print(f"{ {}, }") # A single item tuple gets parenthesized +print(f"{ {}.values(), }") +print(f"{ {}, 1 }") # A tuple with multiple elements doesn't get parenthesized +print(f"{ # Tuple with multiple elements that doesn't fit on a single line gets parenthesized + {}, 1, +}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15536 +print(f"{ {}, 1, }") ``` ## Outputs @@ -366,7 +751,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -517,9 +902,9 @@ x = f"aaaaa { {'aaaaaa', 'bbbbbbb', 'ccccccccc'}:.3f} bbbbbb" # But, in this case, we would split the expression itself because it exceeds the line # length limit so we need not add the extra space. -xxxxxxx = f"{ - {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbb', 'ccccccccccccccccccccc'} -}" +xxxxxxx = ( + f"{ {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbb', 'ccccccccccccccccccccc'} }" +) # And, split the expression itself because it exceeds the line length. xxxxxxx = f"{ { @@ -694,6 +1079,356 @@ f"{ # comment 26 # comment 28 } woah {x}" +# Assignment statement + +# Even though this f-string has multiline expression, thus allowing us to break it at the +# curly braces, the f-string fits on a single line if it's moved inside the parentheses. +# We should prefer doing that instead. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" +) + +# Same as above +xxxxxxx = ( + f"{ {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} }" +) + +# Similar to the previous example, but the f-string will exceed the line length limit, +# we shouldn't add any parentheses here. +xxxxxxx = f"{ + { + 'aaaaaaaaaaaaaaaaaaaaaaaaa', + 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', + 'cccccccccccccccccccccccccc', + } +}" + +# Same as above but with an inline comment. The f-string should be formatted inside the +# parentheses and the comment should be part of the line inside the parentheses. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment +) + +# Similar to the previous example but this time parenthesizing doesn't work because it +# exceeds the line length. So, avoid parenthesizing this f-string. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# Similar to the previous example but we start with the parenthesized layout. This should +# remove the parentheses and format the f-string on a single line. This shows that the +# final layout for the formatter is same for this and the previous case. The only +# difference is that in the previous case the expression is already mulitline which means +# the formatter can break it further at the curly braces. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# The following f-strings are going to break because of the trailing comma so we should +# avoid using the best fit layout and instead use the default layout. +# left-to-right +aaaa = f"aaaa { + [ + 1, + 2, + ] +} bbbb" +# right-to-left +aaaa, bbbb = f"aaaa { + [ + 1, + 2, + ] +} bbbb" + +# Using the right-to-left assignment statement variant. +aaaaaaaaaaaaaaaaaa, bbbbbbbbbbb = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment +) + +# Here, the f-string layout is flat but it exceeds the line length limit. This shouldn't +# try the custom best fit layout because the f-string doesn't have any split points. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +# Same as above but without the parentheses to test that it gets formatted to the same +# layout as the previous example. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) + +# But, the following f-string does have a split point because of the multiline expression. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc +} ddddddddddddddddddd" +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaaaaaaaaaaaaa + + bbbbbbbbbbbbbbbbbbbbb + + cccccccccccccccccccccc + + dddddddddddddddddddddddddddd +} ddddddddddddddddddd" + +# This is an implicitly concatenated f-string but it cannot be joined because otherwise +# it'll exceed the line length limit. So, the two f-strings will be inside parentheses +# instead and the inline comment should be outside the parentheses. +a = ( + f"test{expression}flat" + f"can be {joined} togethereeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +) # inline + +# Similar to the above example but this fits within the line length limit. +a = f"test{expression}flatcan be {joined} togethereeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# The following test cases are adopted from implicit string concatenation but for a +# single f-string instead. + +# Don't inline f-strings that contain expressions that are guaranteed to split, e.g. because of a magic trailing comma +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +# Don't inline f-strings that contain commented expressions +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a # comment + ] +}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a # comment + ] +}moreeeeeeeeeeeeeeeeeetest" # comment + +# Don't inline f-strings with multiline debug expressions or format specifiers +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + + b=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment + +# This is not a multiline f-string even though it has a newline after the format specifier. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# The newline is only considered when it's a tripled-quoted f-string. +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +# Remove the parentheses here +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + b, + # comment + ] +}moee" # comment +# ... but not here because of the ownline comment +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + b, + ] + }moee" + # comment +) + +# F-strings in other positions + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { # comment + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +# For loops +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# With statements +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# Assert statements +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccc{expression}dddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{ + expression +}dddddddddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", ( + f"cccccccccccccccc{expression}dddddddddddddddd" +) + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression +}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert ( + f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" +), f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression +}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccccccccccccccccc { + expression +} dddddddddddddddddddddddddd" + +assert ( + f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" +), ( + f"cccccccccccccccccccccccccccccccc {expression} ddddddddddddddddddddddddddddddddddddd" +) + +# F-strings as a single argument to a call expression to test whether it's huggable or not. +call(f"{testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}") + +call( + f"{testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}" +) + +call( + f"{ # comment + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }" +) + +call( + f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""" +) + +call( + f"""aaaaaaaaaaaaaaaa bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""" +) + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment +}""") + +call( + f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""" +) + +call( + f"{ + aaaaaa + + '''test + more''' + }" +) + # Indentation # What should be the indentation? @@ -727,6 +1462,81 @@ _ = ( f"This string uses double quotes in an expression {"it's a quote"}" f"This f-string does not use any quotes." ) + +# Regression test for https://github.com/astral-sh/ruff/issues/14487 +f"aaaaaaaaaaaaaaaaaaaaaaaaaa {10**27} bbbbbbbbbbbbbbbbbbbbbbbbbb ccccccccccccccccccccccccc" + +# Regression test for https://github.com/astral-sh/ruff/issues/14778 +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' if True else ''}" +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' if True else ''}" + +# Quotes reuse +f"{'a'}" + +# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes +f'foo {10 + len("bar")=}' +f'''foo {10 + len("""bar""")=}''' + +# 312+, it's okay to change the quotes here without creating an invalid f-string +f'{"""other " """}' +f'{"""other " """ + "more"}' +f'{b"""other " """}' +f'{f"""other " """}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 +f'{1: hy "user"}' +f'{1:hy "user"}' +f'{1: abcd "{1}" }' +f'{1: abcd "{"aa"}" }' +f'{1=: "abcd {'aa'}}' +f"{x:a{z:hy \"user\"}} '''" + +# Changing the outer quotes is fine because the format-spec is in a nested expression. +f"{f'{z=:hy "user"}'} '''" + + +# We have to be careful about changing the quotes if the f-string has a debug expression because it is inserted verbatim. +f'{1=: "abcd \'\'}' # Don't change the outer quotes, or it results in a syntax error +f"{1=: abcd \'\'}" # Changing the quotes here is fine because the inner quotes aren't the opposite quotes +f"{1=: abcd \"\"}" # Changing the quotes here is fine because the inner quotes are escaped +# Don't change the quotes in the following cases: +f'{x=:hy "user"} \'\'\'' +f'{x=:a{y:hy "user"}} \'\'\'' +f'{x=:a{y:{z:hy "user"}}} \'\'\'' +f'{x:a{y=:{z:hy "user"}}} \'\'\'' + +# This is fine because the debug expression and format spec are in a nested expression + +f"""{1=: "this" is fine}""" +f"""{1=: "this" is fine}""" # Change quotes to double quotes because they're preferred +f'{1=: {'ab"cd"'}}' # It's okay if the quotes are in an expression part. + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15459 +print(f"{ {1, 2, 3} - {2} }") +print(f"{ {1: 2}.keys() }") +print(f"{({1, 2, 3}) - ({2})}") +print(f"{1, 2, {3}}") +print(f"{(1, 2, {3})}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15535 +print(f"{({},)}") # A single item tuple gets parenthesized +print(f"{({}.values(),)}") +print(f"{ {}, 1 }") # A tuple with multiple elements doesn't get parenthesized +print( + f"{ # Tuple with multiple elements that doesn't fit on a single line gets parenthesized + ( + {}, + 1, + ) + }" +) + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15536 +print(f"{ {}, 1 }") ``` @@ -741,12 +1551,12 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` ```python -(f"{one}" f"{two}") +(f"{one}{two}") rf"Not-so-tricky \"quote" @@ -754,13 +1564,13 @@ rf"Not-so-tricky \"quote" # Regression test for fstrings dropping comments result_f = ( "Traceback (most recent call last):\n" - f' File "{__file__}", line {lineno_f+5}, in _check_recursive_traceback_display\n' + f' File "{__file__}", line {lineno_f + 5}, in _check_recursive_traceback_display\n' " f()\n" - f' File "{__file__}", line {lineno_f+1}, in f\n' + f' File "{__file__}", line {lineno_f + 1}, in f\n' " f()\n" - f' File "{__file__}", line {lineno_f+1}, in f\n' + f' File "{__file__}", line {lineno_f + 1}, in f\n' " f()\n" - f' File "{__file__}", line {lineno_f+1}, in f\n' + f' File "{__file__}", line {lineno_f + 1}, in f\n' " f()\n" # XXX: The following line changes depending on whether the tests # are run through the interactive interpreter or with -m @@ -786,7 +1596,7 @@ result_f = ( ) ( - f"{1}" f"{2}" # comment 3 + f"{1}{2}" # comment 3 ) ( @@ -815,29 +1625,31 @@ z = f"""a{""}b""" f'''c{1}d"""e''' x = f"{a}" x = f"{ a = }" -x = f"{ # comment 6 - a }" +x = f"{ # comment 6 + a +}" x = f"{ # comment 7 a = }" # Remove the parentheses as adding them doesn't make then fit within the line length limit. # This is similar to how we format it before f-string formatting. -aaaaaaaaaaa = f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd } cccccccccc" +aaaaaaaaaaa = f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd} cccccccccc" # Here, we would use the best fit layout to put the f-string indented on the next line # similar to the next example. aaaaaaaaaaa = ( - f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc } cccccccccc" + f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc} cccccccccc" ) aaaaaaaaaaa = ( - f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc } cccccccccc" + f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc} cccccccccc" ) # This should never add the optional parentheses because even after adding them, the # f-string exceeds the line length limit. -x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" } ccccccccccccccc" +x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {'bbbbbbbbbbbbbbbbbbbbbbbbbbbbb'} ccccccccccccccc" x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" = } ccccccccccccccc" -x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 8 - "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" } ccccccccccccccc" +x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 8 + 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbb' +} ccccccccccccccc" x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 9 "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" = } ccccccccccccccc" x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 9 @@ -846,35 +1658,41 @@ x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 9 # Multiple larger expressions which exceeds the line length limit. Here, we need to decide # whether to split at the first or second expression. This should work similarly to the # assignment statement formatting where we split from right to left in preview mode. -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc {ddddddddddddddd} eeeeeeeeeeeeee" # The above example won't split but when we start introducing line breaks: +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { + ddddddddddddddd +} eeeeeeeeeeeeee" +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { + ddddddddddddddd +} eeeeeeeeeeeeee" +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { + ddddddddddddddd +} eeeeeeeeeeeeee" +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { + ddddddddddddddd +} eeeeeeeeeeeeee" + +# But, in case comments are present, we would split at the expression containing the +# comments: x = f"aaaaaaaaaaaa { - bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb - } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { - ddddddddddddddd } eeeeeeeeeeeeee" -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd - } eeeeeeeeeeeeee" - -# But, in case comments are present, we would split at the expression containing the -# comments: -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb # comment 10 - } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" -x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb - } cccccccccccccccccccc { # comment 11 - ddddddddddddddd } eeeeeeeeeeeeee" + bbbbbbbbbbbbbb # comment 10 +} cccccccccccccccccccc {ddddddddddddddd} eeeeeeeeeeeeee" +x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { # comment 11 + ddddddddddddddd +} eeeeeeeeeeeeee" # Here, the expression part itself starts with a curly brace so we need to add an extra # space between the opening curly brace and the expression. x = f"{ {'x': 1, 'y': 2} }" # Although the extra space isn't required before the ending curly brace, we add it for # consistency. -x = f"{ {'x': 1, 'y': 2}}" +x = f"{ {'x': 1, 'y': 2} }" x = f"{ {'x': 1, 'y': 2} = }" x = f"{ # comment 12 - {'x': 1, 'y': 2} }" + {'x': 1, 'y': 2} +}" x = f"{ # comment 13 {'x': 1, 'y': 2} = }" # But, if there's a format specifier or a conversion flag then we don't need to add @@ -884,12 +1702,16 @@ x = f"aaaaa { {'aaaaaa', 'bbbbbbb', 'ccccccccc'}:.3f} bbbbbb" # But, in this case, we would split the expression itself because it exceeds the line # length limit so we need not add the extra space. -xxxxxxx = f"{ - {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbb', 'ccccccccccccccccccccc'} -}" +xxxxxxx = ( + f"{ {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbb', 'ccccccccccccccccccccc'} }" +) # And, split the expression itself because it exceeds the line length. xxxxxxx = f"{ - {'aaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} + { + 'aaaaaaaaaaaaaaaaaaaaaaaaa', + 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', + 'cccccccccccccccccccccccccc', + } }" ############################################################################################# @@ -899,7 +1721,7 @@ f"foo 'bar' {x}" f'foo "bar" {x}' f'foo "bar" {x}' f"foo 'bar' {x}" -f"foo {"bar"}" +f"foo {'bar'}" f"single quoted '{x}' double quoted \"{x}\"" # Same number of quotes => use preferred quote style f'single quote \' {x} double quoted "{x}"' # More double quotes => use single quotes @@ -911,22 +1733,22 @@ rf"flip quotes {x}" # Use preferred quotes, because raw string contains now quo # Here, the formatter will remove the escapes which is correct because they aren't allowed # pre 3.12. This means we can assume that the f-string is used in the context of 3.12. -f"foo {'\'bar\''}" -f"foo {'\"bar\"'}" +f"foo {"'bar'"}" +f"foo {'"bar"'}" # Quotes inside the expressions have no impact on the quote selection of the outer string. # Required so that the following two examples result in the same formatting. -f'foo {10 + len("bar")}' +f"foo {10 + len('bar')}" f"foo {10 + len('bar')}" # Pre 312, preserve the outer quotes if the f-string contains quotes in the debug expression f'foo {10 + len("bar")=}' -f'''foo {10 + len('''bar''')=}''' +f"""foo {10 + len('''bar''')=}""" f"""foo {10 + len('bar')=}""" # Fine to change the quotes because it uses triple quotes # Triple-quoted strings # It's ok to use the same quote char for the inner string if it's single-quoted. -f"""test {'inner'}""" +f"""test {"inner"}""" f"""test {"inner"}""" # But if the inner string is also triple-quoted then we should preserve the existing quotes. f"""test {'''inner'''}""" @@ -938,7 +1760,7 @@ f'{b"""other " """}' f'{f"""other " """}' # Not valid Pre 3.12 -f"""test {f'inner {'''inner inner'''}'}""" +f"""test {f"inner {'''inner inner'''}"}""" f"""test {f'''inner {"""inner inner"""}'''}""" # Magic trailing comma @@ -950,63 +1772,66 @@ f"""test {f'''inner {"""inner inner"""}'''}""" f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee']} aaaaaaa" # And, if the trailing comma is already present, we still need to remove it. -f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee',]} aaaaaaa" +f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee']} aaaaaaa" # Keep this Multiline by breaking it at the square brackets. -f"""aaaaaa {[ - xxxxxxxx, - yyyyyyyy, -]} ccc""" +f"""aaaaaa { + [ + xxxxxxxx, + yyyyyyyy, + ] +} ccc""" # Add the magic trailing comma because the elements don't fit within the line length limit # when collapsed. -f"aaaaaa {[ - xxxxxxxxxxxx, - xxxxxxxxxxxx, - xxxxxxxxxxxx, - xxxxxxxxxxxx, - xxxxxxxxxxxx, - xxxxxxxxxxxx, - yyyyyyyyyyyy -]} ccccccc" +f"aaaaaa { + [ + xxxxxxxxxxxx, + xxxxxxxxxxxx, + xxxxxxxxxxxx, + xxxxxxxxxxxx, + xxxxxxxxxxxx, + xxxxxxxxxxxx, + yyyyyyyyyyyy, + ] +} ccccccc" # Remove the parentheses because they aren't required xxxxxxxxxxxxxxx = f"aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbb { - xxxxxxxxxxx # comment 14 - + yyyyyyyyyy - } dddddddddd" + xxxxxxxxxxx # comment 14 + + yyyyyyyyyy +} dddddddddd" # Comments # No comments should be dropped! -f"{ # comment 15 +f"{ # comment 15 # comment 16 - foo # comment 17 + foo # comment 17 # comment 18 }" # comment 19 # comment 20 # Single-quoted f-strings with a format specificer can be multiline f"aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc { - variable:.3f} ddddddddddddddd eeeeeeee" + variable:.3f +} ddddddddddddddd eeeeeeee" # But, if it's triple-quoted then we can't or the format specificer will have a # trailing newline -f"""aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc { - variable:.3f} ddddddddddddddd eeeeeeee""" +f"""aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc {variable:.3f} ddddddddddddddd eeeeeeee""" # But, we can break the ones which don't have a format specifier -f"""fooooooooooooooooooo barrrrrrrrrrrrrrrrrrr { - xxxxxxxxxxxxxxx:.3f} aaaaaaaaaaaaaaaaa { xxxxxxxxxxxxxxxxxxxx } bbbbbbbbbbbb""" +f"""fooooooooooooooooooo barrrrrrrrrrrrrrrrrrr {xxxxxxxxxxxxxxx:.3f} aaaaaaaaaaaaaaaaa { + xxxxxxxxxxxxxxxxxxxx +} bbbbbbbbbbbb""" # Throw in a random comment in it but surprise, this is not a comment but just a text # which is part of the format specifier -aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa { - aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f +aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f # comment } cccccccccc""" -aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa { - aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f +aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f # comment} cccccccccc""" # Conversion flags @@ -1014,24 +1839,21 @@ aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa { # This is not a valid Python code because of the additional whitespace between the `!` # and conversion type. But, our parser isn't strict about this. This should probably be # removed once we have a strict parser. -x = f"aaaaaaaaa { x ! r }" +x = f"aaaaaaaaa {x!r}" # Even in the case of debug expressions, we only need to preserve the whitespace within # the expression part of the replacement field. -x = f"aaaaaaaaa { x = ! r }" +x = f"aaaaaaaaa { x = !r}" # Combine conversion flags with format specifiers -x = f"{x = ! s - :>0 - - }" +x = f"{x = !s:>0}" # This is interesting. There can be a comment after the format specifier but only if it's # on it's own line. Refer to https://github.com/astral-sh/ruff/pull/7787 for more details. # We'll format is as trailing comments. -x = f"{x !s - :>0 - # comment 21 - }" +x = f"{ + x!s:>0 + # comment 21 +}" x = f""" { # comment 22 @@ -1040,23 +1862,373 @@ x = f""" # Here, the debug expression is in a nested f-string so we should start preserving # whitespaces from that point onwards. This means we should format the outer f-string. -x = f"""{"foo " + # comment 24 - f"{ x = +x = f"""{ + "foo " # comment 24 + + f"{ x = - }" # comment 25 - } + }" # comment 25 +} """ # Mix of various features. f"{ # comment 26 - foo # after foo - :>{ - x # after x - } + foo:>{ # after foo + x # after x + } # comment 27 # comment 28 } woah {x}" +# Assignment statement + +# Even though this f-string has multiline expression, thus allowing us to break it at the +# curly braces, the f-string fits on a single line if it's moved inside the parentheses. +# We should prefer doing that instead. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" +) + +# Same as above +xxxxxxx = ( + f"{ {'aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} }" +) + +# Similar to the previous example, but the f-string will exceed the line length limit, +# we shouldn't add any parentheses here. +xxxxxxx = f"{ + { + 'aaaaaaaaaaaaaaaaaaaaaaaaa', + 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', + 'cccccccccccccccccccccccccc', + } +}" + +# Same as above but with an inline comment. The f-string should be formatted inside the +# parentheses and the comment should be part of the line inside the parentheses. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment +) + +# Similar to the previous example but this time parenthesizing doesn't work because it +# exceeds the line length. So, avoid parenthesizing this f-string. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# Similar to the previous example but we start with the parenthesized layout. This should +# remove the parentheses and format the f-string on a single line. This shows that the +# final layout for the formatter is same for this and the previous case. The only +# difference is that in the previous case the expression is already mulitline which means +# the formatter can break it further at the curly braces. +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment loooooooong + +# The following f-strings are going to break because of the trailing comma so we should +# avoid using the best fit layout and instead use the default layout. +# left-to-right +aaaa = f"aaaa { + [ + 1, + 2, + ] +} bbbb" +# right-to-left +aaaa, bbbb = f"aaaa { + [ + 1, + 2, + ] +} bbbb" + +# Using the right-to-left assignment statement variant. +aaaaaaaaaaaaaaaaaa, bbbbbbbbbbb = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeee" # comment +) + +# Here, the f-string layout is flat but it exceeds the line length limit. This shouldn't +# try the custom best fit layout because the f-string doesn't have any split points. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) +# Same as above but without the parentheses to test that it gets formatted to the same +# layout as the previous example. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = ( + f"aaaaaaaaaaaaaaaaaaa {aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc} ddddddddddddddddddd" +) + +# But, the following f-string does have a split point because of the multiline expression. +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaa + bbbbbbbbbbb + cccccccccccccc +} ddddddddddddddddddd" +aaaaaaaaaaaa["bbbbbbbbbbbbbbbb"] = f"aaaaaaaaaaaaaaaaaaa { + aaaaaaaaaaaaaaaaaaaa + + bbbbbbbbbbbbbbbbbbbbb + + cccccccccccccccccccccc + + dddddddddddddddddddddddddddd +} ddddddddddddddddddd" + +# This is an implicitly concatenated f-string but it cannot be joined because otherwise +# it'll exceed the line length limit. So, the two f-strings will be inside parentheses +# instead and the inline comment should be outside the parentheses. +a = ( + f"test{expression}flat" + f"can be {joined} togethereeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +) # inline + +# Similar to the above example but this fits within the line length limit. +a = f"test{expression}flatcan be {joined} togethereeeeeeeeeeeeeeeeeeeeeeeeeee" # inline + +# The following test cases are adopted from implicit string concatenation but for a +# single f-string instead. + +# Don't inline f-strings that contain expressions that are guaranteed to split, e.g. because of a magic trailing comma +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + ] +}moreeeeeeeeeeeeeeeeeeee" # comment + +# Don't inline f-strings that contain commented expressions +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a # comment + ] +}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a # comment + ] +}moreeeeeeeeeeeeeeeeeetest" # comment + +# Don't inline f-strings with multiline debug expressions or format specifiers +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + + b=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{ + a=}moreeeeeeeeeeeeeeeeeetest" # comment + +aaaaa[aaaaaaaaaaa] = f"testeeeeeeeeeeeeeeeeeeeeeeeee{a + =}moreeeeeeeeeeeeeeeeeetest" # comment + +# This is not a multiline f-string even though it has a newline after the format specifier. +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f}moreeeeeeeeeeeeeeeeeetest" # comment +) + +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f}moreeeeeeeeeeeeeeeeeetest" # comment +) + +# The newline is only considered when it's a tripled-quoted f-string. +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +aaaaaaaaaaaaaaaaaa = f"""testeeeeeeeeeeeeeeeeeeeeeeeee{a:.3f + }moreeeeeeeeeeeeeeeeeetest""" # comment + +# Remove the parentheses here +aaaaaaaaaaaaaaaaaa = f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + b, + # comment + ] +}moee" # comment +# ... but not here because of the ownline comment +aaaaaaaaaaaaaaaaaa = ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + [ + a, + b, + ] + }moee" + # comment +) + +# F-strings in other positions + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}": + pass + +if f"aaaaaaaaaaa {ttttteeeeeeeeest} more { # comment + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +if f"aaaaaaaaaaa { + [ + ttttteeeeeeeeest, + ] +} more { + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +}": + pass + +# For loops +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +for a in f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +for a in ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# With statements +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +with f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{ + expression +}moreeeeeeeeeeeeeeeeeeeeeeeeeeeeee": + pass + +with ( + f"testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee{expression}moreeeeeeeeeeeeeeeeeeeeeeeeeeeee" +): + pass + +# Assert statements +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccc{expression}dddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", f"cccccccccccccccc{ + expression +}dddddddddddddddd" + +assert f"aaaaaaaaa{expression}bbbbbbbbbbbb", ( + f"cccccccccccccccc{expression}dddddddddddddddd" +) + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression +}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccc{expression}dddddddddd" + +assert ( + f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" +), f"ccccccc{expression}dddddddddd" + +assert f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{ + expression +}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", f"ccccccccccccccccccccc { + expression +} dddddddddddddddddddddddddd" + +assert ( + f"aaaaaaaaaaaaaaaaaaaaaaaaaaa{expression}bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" +), ( + f"cccccccccccccccccccccccccccccccc {expression} ddddddddddddddddddddddddddddddddddddd" +) + +# F-strings as a single argument to a call expression to test whether it's huggable or not. +call(f"{testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}") + +call( + f"{testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}" +) + +call( + f"{ # comment + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }" +) + +call( + f"""aaaaaaaaaaaaaaaa bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""" +) + +call( + f"""aaaaaaaaaaaaaaaa bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + }""" +) + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb {testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee}""") + +call(f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment +}""") + +call( + f"""aaaaaaaaaaaaaaaa + bbbbbbbbbb { + testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee # comment + }""" +) + +call( + f"{ + aaaaaa + + '''test + more''' + }" +) + # Indentation # What should be the indentation? @@ -1066,427 +2238,103 @@ if indent0: if indent2: foo = f"""hello world hello { - f"aaaaaaa { - [ - 'aaaaaaaaaaaaaaaaaaaaa', - 'bbbbbbbbbbbbbbbbbbbbb', - 'ccccccccccccccccccccc', - 'ddddddddddddddddddddd' - ] - } bbbbbbbb" + - [ - 'aaaaaaaaaaaaaaaaaaaaa', - 'bbbbbbbbbbbbbbbbbbbbb', - 'ccccccccccccccccccccc', - 'ddddddddddddddddddddd' - ] - } -------- + f"aaaaaaa { + [ + 'aaaaaaaaaaaaaaaaaaaaa', + 'bbbbbbbbbbbbbbbbbbbbb', + 'ccccccccccccccccccccc', + 'ddddddddddddddddddddd', + ] + } bbbbbbbb" + + [ + "aaaaaaaaaaaaaaaaaaaaa", + "bbbbbbbbbbbbbbbbbbbbb", + "ccccccccccccccccccccc", + "ddddddddddddddddddddd", + ] + } -------- """ # Implicit concatenated f-string containing quotes _ = ( - 'This string should change its quotes to double quotes' - f'This string uses double quotes in an expression {"it's a quote"}' - f'This f-string does not use any quotes.' + "This string should change its quotes to double quotes" + f"This string uses double quotes in an expression {"it's a quote"}" + f"This f-string does not use any quotes." +) + +# Regression test for https://github.com/astral-sh/ruff/issues/14487 +f"aaaaaaaaaaaaaaaaaaaaaaaaaa {10**27} bbbbbbbbbbbbbbbbbbbbbbbbbb ccccccccccccccccccccccccc" + +# Regression test for https://github.com/astral-sh/ruff/issues/14778 +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' if True else ''}" +f"{'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' if True else ''}" + +# Quotes reuse +f"{'a'}" + +# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes +f'foo {10 + len("bar")=}' +f'''foo {10 + len("""bar""")=}''' + +# 312+, it's okay to change the quotes here without creating an invalid f-string +f'{"""other " """}' +f'{"""other " """ + "more"}' +f'{b"""other " """}' +f'{f"""other " """}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 +f'{1: hy "user"}' +f'{1:hy "user"}' +f'{1: abcd "{1}" }' +f'{1: abcd "{"aa"}" }' +f'{1=: "abcd {'aa'}}' +f"{x:a{z:hy \"user\"}} '''" + +# Changing the outer quotes is fine because the format-spec is in a nested expression. +f"{f'{z=:hy "user"}'} '''" + + +# We have to be careful about changing the quotes if the f-string has a debug expression because it is inserted verbatim. +f'{1=: "abcd \'\'}' # Don't change the outer quotes, or it results in a syntax error +f"{1=: abcd \'\'}" # Changing the quotes here is fine because the inner quotes aren't the opposite quotes +f"{1=: abcd \"\"}" # Changing the quotes here is fine because the inner quotes are escaped +# Don't change the quotes in the following cases: +f'{x=:hy "user"} \'\'\'' +f'{x=:a{y:hy "user"}} \'\'\'' +f'{x=:a{y:{z:hy "user"}}} \'\'\'' +f'{x:a{y=:{z:hy "user"}}} \'\'\'' + +# This is fine because the debug expression and format spec are in a nested expression + +f"""{1=: "this" is fine}""" +f"""{1=: "this" is fine}""" # Change quotes to double quotes because they're preferred +f'{1=: {'ab"cd"'}}' # It's okay if the quotes are in an expression part. + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15459 +print(f"{ {1, 2, 3} - {2} }") +print(f"{ {1: 2}.keys() }") +print(f"{({1, 2, 3}) - ({2})}") +print(f"{1, 2, {3}}") +print(f"{(1, 2, {3})}") + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15535 +print(f"{({},)}") # A single item tuple gets parenthesized +print(f"{({}.values(),)}") +print(f"{ {}, 1 }") # A tuple with multiple elements doesn't get parenthesized +print( + f"{ # Tuple with multiple elements that doesn't fit on a single line gets parenthesized + ( + {}, + 1, + ) + }" ) -``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -1,4 +1,4 @@ --(f"{one}" f"{two}") -+(f"{one}{two}") - - - rf"Not-so-tricky \"quote" -@@ -6,13 +6,13 @@ - # Regression test for fstrings dropping comments - result_f = ( - "Traceback (most recent call last):\n" -- f' File "{__file__}", line {lineno_f+5}, in _check_recursive_traceback_display\n' -+ f' File "{__file__}", line {lineno_f + 5}, in _check_recursive_traceback_display\n' - " f()\n" -- f' File "{__file__}", line {lineno_f+1}, in f\n' -+ f' File "{__file__}", line {lineno_f + 1}, in f\n' - " f()\n" -- f' File "{__file__}", line {lineno_f+1}, in f\n' -+ f' File "{__file__}", line {lineno_f + 1}, in f\n' - " f()\n" -- f' File "{__file__}", line {lineno_f+1}, in f\n' -+ f' File "{__file__}", line {lineno_f + 1}, in f\n' - " f()\n" - # XXX: The following line changes depending on whether the tests - # are run through the interactive interpreter or with -m -@@ -38,7 +38,7 @@ - ) - - ( -- f"{1}" f"{2}" # comment 3 -+ f"{1}{2}" # comment 3 - ) - - ( -@@ -67,29 +67,31 @@ - x = f"{a}" - x = f"{ - a = }" --x = f"{ # comment 6 -- a }" -+x = f"{ # comment 6 -+ a -+}" - x = f"{ # comment 7 - a = }" - - # Remove the parentheses as adding them doesn't make then fit within the line length limit. - # This is similar to how we format it before f-string formatting. --aaaaaaaaaaa = f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd } cccccccccc" -+aaaaaaaaaaa = f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd} cccccccccc" - # Here, we would use the best fit layout to put the f-string indented on the next line - # similar to the next example. - aaaaaaaaaaa = ( -- f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc } cccccccccc" -+ f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc} cccccccccc" - ) - aaaaaaaaaaa = ( -- f"asaaaaaaaaaaaaaaaa { aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc } cccccccccc" -+ f"asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc} cccccccccc" - ) - - # This should never add the optional parentheses because even after adding them, the - # f-string exceeds the line length limit. --x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" } ccccccccccccccc" -+x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa {'bbbbbbbbbbbbbbbbbbbbbbbbbbbbb'} ccccccccccccccc" - x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" = } ccccccccccccccc" --x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 8 -- "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" } ccccccccccccccc" -+x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 8 -+ 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbb' -+} ccccccccccccccc" - x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 9 - "bbbbbbbbbbbbbbbbbbbbbbbbbbbbb" = } ccccccccccccccc" - x = f"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa { # comment 9 -@@ -98,35 +100,41 @@ - # Multiple larger expressions which exceeds the line length limit. Here, we need to decide - # whether to split at the first or second expression. This should work similarly to the - # assignment statement formatting where we split from right to left in preview mode. --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc {ddddddddddddddd} eeeeeeeeeeeeee" - - # The above example won't split but when we start introducing line breaks: --x = f"aaaaaaaaaaaa { -- bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb -- } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { -- ddddddddddddddd } eeeeeeeeeeeeee" --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb } cccccccccccccccccccc { ddddddddddddddd -- } eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { -+ ddddddddddddddd -+} eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { -+ ddddddddddddddd -+} eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { -+ ddddddddddddddd -+} eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { -+ ddddddddddddddd -+} eeeeeeeeeeeeee" - - # But, in case comments are present, we would split at the expression containing the - # comments: --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb # comment 10 -- } cccccccccccccccccccc { ddddddddddddddd } eeeeeeeeeeeeee" --x = f"aaaaaaaaaaaa { bbbbbbbbbbbbbb -- } cccccccccccccccccccc { # comment 11 -- ddddddddddddddd } eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa { -+ bbbbbbbbbbbbbb # comment 10 -+} cccccccccccccccccccc {ddddddddddddddd} eeeeeeeeeeeeee" -+x = f"aaaaaaaaaaaa {bbbbbbbbbbbbbb} cccccccccccccccccccc { # comment 11 -+ ddddddddddddddd -+} eeeeeeeeeeeeee" - - # Here, the expression part itself starts with a curly brace so we need to add an extra - # space between the opening curly brace and the expression. - x = f"{ {'x': 1, 'y': 2} }" - # Although the extra space isn't required before the ending curly brace, we add it for - # consistency. --x = f"{ {'x': 1, 'y': 2}}" -+x = f"{ {'x': 1, 'y': 2} }" - x = f"{ {'x': 1, 'y': 2} = }" - x = f"{ # comment 12 -- {'x': 1, 'y': 2} }" -+ {'x': 1, 'y': 2} -+}" - x = f"{ # comment 13 - {'x': 1, 'y': 2} = }" - # But, if there's a format specifier or a conversion flag then we don't need to add -@@ -141,7 +149,11 @@ - }" - # And, split the expression itself because it exceeds the line length. - xxxxxxx = f"{ -- {'aaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccccccccc'} -+ { -+ 'aaaaaaaaaaaaaaaaaaaaaaaaa', -+ 'bbbbbbbbbbbbbbbbbbbbbbbbbbb', -+ 'cccccccccccccccccccccccccc', -+ } - }" - - ############################################################################################# -@@ -151,7 +163,7 @@ - f'foo "bar" {x}' - f'foo "bar" {x}' - f"foo 'bar' {x}" --f"foo {"bar"}" -+f"foo {'bar'}" - - f"single quoted '{x}' double quoted \"{x}\"" # Same number of quotes => use preferred quote style - f'single quote \' {x} double quoted "{x}"' # More double quotes => use single quotes -@@ -163,23 +175,23 @@ - - # Here, the formatter will remove the escapes which is correct because they aren't allowed - # pre 3.12. This means we can assume that the f-string is used in the context of 3.12. --f"foo {'\'bar\''}" --f"foo {'\"bar\"'}" -+f"foo {"'bar'"}" -+f"foo {'"bar"'}" - - # Quotes inside the expressions have no impact on the quote selection of the outer string. - # Required so that the following two examples result in the same formatting. --f'foo {10 + len("bar")}' - f"foo {10 + len('bar')}" -+f"foo {10 + len('bar')}" - - # Pre 312, preserve the outer quotes if the f-string contains quotes in the debug expression - f'foo {10 + len("bar")=}' --f'''foo {10 + len('''bar''')=}''' -+f"""foo {10 + len('''bar''')=}""" - f"""foo {10 + len('bar')=}""" # Fine to change the quotes because it uses triple quotes - - # Triple-quoted strings - # It's ok to use the same quote char for the inner string if it's single-quoted. --f"""test {'inner'}""" - f"""test {"inner"}""" -+f"""test {"inner"}""" - # But if the inner string is also triple-quoted then we should preserve the existing quotes. - f"""test {'''inner'''}""" - -@@ -190,7 +202,7 @@ - f'{f"""other " """}' - - # Not valid Pre 3.12 --f"""test {f'inner {'''inner inner'''}'}""" -+f"""test {f"inner {'''inner inner'''}"}""" - f"""test {f'''inner {"""inner inner"""}'''}""" - - # Magic trailing comma -@@ -202,63 +214,66 @@ - f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee']} aaaaaaa" - - # And, if the trailing comma is already present, we still need to remove it. --f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee',]} aaaaaaa" -+f"aaaaaaa {['aaaaaaaaaaaaaaa', 'bbbbbbbbbbbbb', 'ccccccccccccccccc', 'ddddddddddddddd', 'eeeeeeeeeeeeee']} aaaaaaa" - - # Keep this Multiline by breaking it at the square brackets. --f"""aaaaaa {[ -- xxxxxxxx, -- yyyyyyyy, --]} ccc""" -+f"""aaaaaa { -+ [ -+ xxxxxxxx, -+ yyyyyyyy, -+ ] -+} ccc""" - - # Add the magic trailing comma because the elements don't fit within the line length limit - # when collapsed. --f"aaaaaa {[ -- xxxxxxxxxxxx, -- xxxxxxxxxxxx, -- xxxxxxxxxxxx, -- xxxxxxxxxxxx, -- xxxxxxxxxxxx, -- xxxxxxxxxxxx, -- yyyyyyyyyyyy --]} ccccccc" -+f"aaaaaa { -+ [ -+ xxxxxxxxxxxx, -+ xxxxxxxxxxxx, -+ xxxxxxxxxxxx, -+ xxxxxxxxxxxx, -+ xxxxxxxxxxxx, -+ xxxxxxxxxxxx, -+ yyyyyyyyyyyy, -+ ] -+} ccccccc" - - # Remove the parentheses because they aren't required - xxxxxxxxxxxxxxx = f"aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbb { -- xxxxxxxxxxx # comment 14 -- + yyyyyyyyyy -- } dddddddddd" -+ xxxxxxxxxxx # comment 14 -+ + yyyyyyyyyy -+} dddddddddd" - - # Comments - - # No comments should be dropped! --f"{ # comment 15 -+f"{ # comment 15 - # comment 16 -- foo # comment 17 -+ foo # comment 17 - # comment 18 - }" # comment 19 - # comment 20 - - # Single-quoted f-strings with a format specificer can be multiline - f"aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc { -- variable:.3f} ddddddddddddddd eeeeeeee" -+ variable:.3f -+} ddddddddddddddd eeeeeeee" - - # But, if it's triple-quoted then we can't or the format specificer will have a - # trailing newline --f"""aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc { -- variable:.3f} ddddddddddddddd eeeeeeee""" -+f"""aaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb ccccccccccc {variable:.3f} ddddddddddddddd eeeeeeee""" - - # But, we can break the ones which don't have a format specifier --f"""fooooooooooooooooooo barrrrrrrrrrrrrrrrrrr { -- xxxxxxxxxxxxxxx:.3f} aaaaaaaaaaaaaaaaa { xxxxxxxxxxxxxxxxxxxx } bbbbbbbbbbbb""" -+f"""fooooooooooooooooooo barrrrrrrrrrrrrrrrrrr {xxxxxxxxxxxxxxx:.3f} aaaaaaaaaaaaaaaaa { -+ xxxxxxxxxxxxxxxxxxxx -+} bbbbbbbbbbbb""" - - # Throw in a random comment in it but surprise, this is not a comment but just a text - # which is part of the format specifier --aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa { -- aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f -+aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f - # comment - } cccccccccc""" --aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa { -- aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f -+aaaaaaaaaaa = f"""asaaaaaaaaaaaaaaaa {aaaaaaaaaaaa + bbbbbbbbbbbb + ccccccccccccccc + dddddddd:.3f - # comment} cccccccccc""" - - # Conversion flags -@@ -266,24 +281,21 @@ - # This is not a valid Python code because of the additional whitespace between the `!` - # and conversion type. But, our parser isn't strict about this. This should probably be - # removed once we have a strict parser. --x = f"aaaaaaaaa { x ! r }" -+x = f"aaaaaaaaa {x!r}" - - # Even in the case of debug expressions, we only need to preserve the whitespace within - # the expression part of the replacement field. --x = f"aaaaaaaaa { x = ! r }" -+x = f"aaaaaaaaa { x = !r}" - - # Combine conversion flags with format specifiers --x = f"{x = ! s -- :>0 -- -- }" -+x = f"{x = !s:>0}" - # This is interesting. There can be a comment after the format specifier but only if it's - # on it's own line. Refer to https://github.com/astral-sh/ruff/pull/7787 for more details. - # We'll format is as trailing comments. --x = f"{x !s -- :>0 -- # comment 21 -- }" -+x = f"{ -+ x!s:>0 -+ # comment 21 -+}" - - x = f""" - { # comment 22 -@@ -292,19 +304,19 @@ - - # Here, the debug expression is in a nested f-string so we should start preserving - # whitespaces from that point onwards. This means we should format the outer f-string. --x = f"""{"foo " + # comment 24 -- f"{ x = -+x = f"""{ -+ "foo " # comment 24 -+ + f"{ x = - -- }" # comment 25 -- } -+ }" # comment 25 -+} - """ - - # Mix of various features. - f"{ # comment 26 -- foo # after foo -- :>{ -- x # after x -- } -+ foo:>{ # after foo -+ x # after x -+ } - # comment 27 - # comment 28 - } woah {x}" -@@ -318,27 +330,27 @@ - if indent2: - foo = f"""hello world - hello { -- f"aaaaaaa { -- [ -- 'aaaaaaaaaaaaaaaaaaaaa', -- 'bbbbbbbbbbbbbbbbbbbbb', -- 'ccccccccccccccccccccc', -- 'ddddddddddddddddddddd' -- ] -- } bbbbbbbb" + -- [ -- 'aaaaaaaaaaaaaaaaaaaaa', -- 'bbbbbbbbbbbbbbbbbbbbb', -- 'ccccccccccccccccccccc', -- 'ddddddddddddddddddddd' -- ] -- } -------- -+ f"aaaaaaa { -+ [ -+ 'aaaaaaaaaaaaaaaaaaaaa', -+ 'bbbbbbbbbbbbbbbbbbbbb', -+ 'ccccccccccccccccccccc', -+ 'ddddddddddddddddddddd', -+ ] -+ } bbbbbbbb" -+ + [ -+ "aaaaaaaaaaaaaaaaaaaaa", -+ "bbbbbbbbbbbbbbbbbbbbb", -+ "ccccccccccccccccccccc", -+ "ddddddddddddddddddddd", -+ ] -+ } -------- - """ - - - # Implicit concatenated f-string containing quotes - _ = ( -- 'This string should change its quotes to double quotes' -- f'This string uses double quotes in an expression {"it's a quote"}' -- f'This f-string does not use any quotes.' -+ "This string should change its quotes to double quotes" -+ f"This string uses double quotes in an expression {"it's a quote"}" -+ f"This f-string does not use any quotes." - ) +# Regression tests for https://github.com/astral-sh/ruff/issues/15536 +print(f"{ {}, 1 }") ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_preview.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_preview.py.snap new file mode 100644 index 0000000000000..508eda3e94cb7 --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_preview.py.snap @@ -0,0 +1,66 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_preview.py +--- +## Input +```python +# This test is in its own file because it results in AST changes on stable. +# We don't plan to fix it on stable because we plan on promoting f-string formatting soon. + +# Regression test for https://github.com/astral-sh/ruff/issues/14766 +# Don't change the casing of the escaped characters in the f-string because it would be observable in the debug expression. +# >>> f"{r"\xFF"=}" +# 'r"ÿ"=\'\\\\xFF\'' +# >>> f"{r"\xff"=}" +# 'r"ÿ"=\'\\\\xff\'' +f"{r"\xFF"=}" +f"{r"\xff"=}" + + +# Test for https://github.com/astral-sh/ruff/issues/14926 +# We could change the casing of the escaped characters in non-raw f-string because Python interprets the inner string +# before printing it as a debug expression. For now, we decided not to change the casing because it's fairly complicated +# to implement and it seems uncommon (debug expressions are uncommon, escapes are uncommon). +# These two strings could be formatted to the same output but we currently don't do that. +f"{"\xFF\N{space}"=}" +f"{"\xff\N{SPACE}"=}" +``` + +## Outputs +### Output 1 +``` +indent-style = space +line-width = 88 +indent-width = 4 +quote-style = Double +line-ending = LineFeed +magic-trailing-comma = Respect +docstring-code = Disabled +docstring-code-line-width = "dynamic" +preview = Enabled +target_version = 3.9 +source_type = Python +``` + +```python +# This test is in its own file because it results in AST changes on stable. +# We don't plan to fix it on stable because we plan on promoting f-string formatting soon. + +# Regression test for https://github.com/astral-sh/ruff/issues/14766 +# Don't change the casing of the escaped characters in the f-string because it would be observable in the debug expression. +# >>> f"{r"\xFF"=}" +# 'r"ÿ"=\'\\\\xFF\'' +# >>> f"{r"\xff"=}" +# 'r"ÿ"=\'\\\\xff\'' +f"{r"\xFF"=}" +f"{r"\xff"=}" + + +# Test for https://github.com/astral-sh/ruff/issues/14926 +# We could change the casing of the escaped characters in non-raw f-string because Python interprets the inner string +# before printing it as a debug expression. For now, we decided not to change the casing because it's fairly complicated +# to implement and it seems uncommon (debug expressions are uncommon, escapes are uncommon). +# These two strings could be formatted to the same output but we currently don't do that. +f"{"\xFF\N{space}"=}" +f"{"\xff\N{SPACE}"=}" +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_py312.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_py312.py.snap deleted file mode 100644 index 75b2a13bdc59e..0000000000000 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__fstring_py312.py.snap +++ /dev/null @@ -1,84 +0,0 @@ ---- -source: crates/ruff_python_formatter/tests/fixtures.rs -input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring_py312.py ---- -## Input -```python -# This file contains test cases only for cases where the logic tests for whether -# the target version is 3.12 or later. A user can have 3.12 syntax even if the target -# version isn't set. - -# Quotes reuse -f"{'a'}" - -# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes -f'foo {10 + len("bar")=}' -f'''foo {10 + len("""bar""")=}''' - -# 312+, it's okay to change the quotes here without creating an invalid f-string -f'{"""other " """}' -f'{"""other " """ + "more"}' -f'{b"""other " """}' -f'{f"""other " """}' - -``` - -## Outputs -### Output 1 -``` -indent-style = space -line-width = 88 -indent-width = 4 -quote-style = Double -line-ending = LineFeed -magic-trailing-comma = Respect -docstring-code = Disabled -docstring-code-line-width = "dynamic" -preview = Disabled -target_version = Py312 -source_type = Python -``` - -```python -# This file contains test cases only for cases where the logic tests for whether -# the target version is 3.12 or later. A user can have 3.12 syntax even if the target -# version isn't set. - -# Quotes reuse -f"{'a'}" - -# 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes -f'foo {10 + len("bar")=}' -f'''foo {10 + len("""bar""")=}''' - -# 312+, it's okay to change the quotes here without creating an invalid f-string -f'{"""other " """}' -f'{"""other " """ + "more"}' -f'{b"""other " """}' -f'{f"""other " """}' -``` - - -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -6,11 +6,11 @@ - f"{'a'}" - - # 312+, it's okay to change the outer quotes even when there's a debug expression using the same quotes --f'foo {10 + len("bar")=}' --f'''foo {10 + len("""bar""")=}''' -+f"foo {10 + len("bar")=}" -+f"""foo {10 + len("""bar""")=}""" - - # 312+, it's okay to change the quotes here without creating an invalid f-string --f'{"""other " """}' --f'{"""other " """ + "more"}' --f'{b"""other " """}' --f'{f"""other " """}' -+f"{'''other " '''}" -+f"{'''other " ''' + 'more'}" -+f"{b'''other " '''}" -+f"{f'''other " '''}" -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__generator_exp.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__generator_exp.py.snap index 4818acca87919..d19ce0f393f42 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__generator_exp.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__generator_exp.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/generator_exp.py +snapshot_kind: text --- ## Input ```python @@ -159,6 +160,3 @@ tuple( ) ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__hug.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__hug.py.snap index d620e52c60546..0d15585887633 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__hug.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__hug.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/hug.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__if.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__if.py.snap index e73a5515f3771..cd1823865eb8d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__if.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__if.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/if.py +snapshot_kind: text --- ## Input ```python @@ -241,6 +242,3 @@ def something(): ) ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string.py.snap index bfab700e2e3f2..c2e7f51ca16cc 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string.py.snap @@ -61,7 +61,7 @@ b"aaaaaaaaa" b"bbbbbbbbbbbbbbbbbbbb" # Join # F-strings ############################################################################## -# Escape `{` and `}` when marging an f-string with a string +# Escape `{` and `}` when merging an f-string with a string "a {not_a_variable}" f"b {10}" "c" # Join, and break expressions @@ -102,7 +102,7 @@ f"{f'''test ' '''}" f'{f"""other " """}' f"{10 + len('bar')=}" f"{10 + len('bar')=}" f"{10 + len('bar')=}" f'no debug{10}' f"{10 + len('bar')=}" -# We can't savely merge this pre Python 3.12 without altering the debug expression. +# We can't safely merge this pre Python 3.12 without altering the debug expression. f"{10 + len('bar')=}" f'{10 + len("bar")=}' @@ -265,7 +265,7 @@ def short_docstring(): "Implicit" "concatenated" "docstring" def long_docstring(): - "Loooooooooooooooooooooong" "doooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiing" "exceding the line width" "but it should be concatenated anyways because it is single line" + "Loooooooooooooooooooooong" "doooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiing" "exceeding the line width" "but it should be concatenated anyways because it is single line" def docstring_with_leading_whitespace(): " This is a " "implicit" "concatenated" "docstring" @@ -325,24 +325,37 @@ assert False, "Implicit concatenated stringuses {} layout on {} format"[ assert False, +"Implicit concatenated string" "uses {} layout on {} format".format( "Multiline", "first" ) -``` -## Outputs -### Output 1 -``` -indent-style = space -line-width = 88 -indent-width = 4 -quote-style = Double -line-ending = LineFeed -magic-trailing-comma = Respect -docstring-code = Disabled -docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py38 -source_type = Python + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 + +"a" f'{1=: "abcd \'\'}' +f'{1=: "abcd \'\'}' "a" +f'{1=: "abcd \'\'}' f"{1=: 'abcd \"\"}" + +# These strings contains escaped newline characters and should be joined, they are +# not multiline strings. +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd" +b"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" b"cccccccccccccc \ + ddddddddddddddddddd" +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd" # comment 1 +(f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" "cccccccccccccc \ + ddddddddddddddddddd") # comment 2 +( + f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" # comment 3 + "cccccccccccccc \ + ddddddddddddddddddd" # comment 4 +) ``` +## Output ```python "aaaaaaaaabbbbbbbbbbbbbbbbbbbb" # Join @@ -399,7 +412,7 @@ b"aaaaaaaaabbbbbbbbbbbbbbbbbbbb" # Join # F-strings ############################################################################## -# Escape `{` and `}` when marging an f-string with a string +# Escape `{` and `}` when merging an f-string with a string f"a {{not_a_variable}}b {10}c" # Join, and break expressions @@ -435,7 +448,7 @@ f"{f'''test ' '''}" f'{f"""other " """}' f"{10 + len('bar')=}{10 + len('bar')=}" f"{10 + len('bar')=}no debug{10}{10 + len('bar')=}" -# We can't savely merge this pre Python 3.12 without altering the debug expression. +# We can't safely merge this pre Python 3.12 without altering the debug expression. f"{10 + len('bar')=}" f'{10 + len("bar")=}' @@ -588,12 +601,9 @@ assert ( ############################################################################## # Use can_omit_optional_parentheses layout to avoid an instability where the formatter # picks the can_omit_optional_parentheses layout when the strings are joined. -if f"implicitconcatenatedstring" + f"implicitconcadddddddddddedring" * len([ - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, -]): +if f"implicitconcatenatedstring" + f"implicitconcadddddddddddedring" * len( + [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] +): pass # Keep parenthesizing multiline - implicit concatenated strings @@ -662,7 +672,7 @@ def short_docstring(): def long_docstring(): - "Loooooooooooooooooooooongdoooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiingexceding the line widthbut it should be concatenated anyways because it is single line" + "Loooooooooooooooooooooongdoooooooooooooooooooocstriiiiiiiiiiiiiiiiiiiiiiiiiiiiiiingexceeding the line widthbut it should be concatenated anyways because it is single line" def docstring_with_leading_whitespace(): @@ -732,4 +742,58 @@ assert False, "Implicit concatenated stringuses {} layout on {} format"[ assert False, +"Implicit concatenated stringuses {} layout on {} format".format( "Multiline", "first" ) + + +# Regression tests for https://github.com/astral-sh/ruff/issues/13935 + +f'a{1=: "abcd \'\'}' +f'{1=: "abcd \'\'}a' +f'{1=: "abcd \'\'}' f"{1=: 'abcd \"\"}" + +# These strings contains escaped newline characters and should be joined, they are +# not multiline strings. +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbbcccccccccccccc \ + ddddddddddddddddddd" +b"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbbcccccccccccccc \ + ddddddddddddddddddd" +f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbbcccccccccccccc \ + ddddddddddddddddddd" # comment 1 +( + f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" + "cccccccccccccc \ + ddddddddddddddddddd" +) # comment 2 +( + f"aaaaaaaaaaaaaaaa \ + bbbbbbbbbbb" # comment 3 + "cccccccccccccc \ + ddddddddddddddddddd" # comment 4 +) +``` + + +## Preview changes +```diff +--- Stable ++++ Preview +@@ -242,9 +242,12 @@ + ############################################################################## + # Use can_omit_optional_parentheses layout to avoid an instability where the formatter + # picks the can_omit_optional_parentheses layout when the strings are joined. +-if f"implicitconcatenatedstring" + f"implicitconcadddddddddddedring" * len( +- [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] +-): ++if f"implicitconcatenatedstring" + f"implicitconcadddddddddddedring" * len([ ++ aaaaaa, ++ bbbbbbbbbbbbbbbb, ++ cccccccccccccccccc, ++ ddddddddddddddddddddddddddd, ++]): + pass + + # Keep parenthesizing multiline - implicit concatenated strings ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_assignment.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_assignment.py.snap index 046264fe539e3..7133eb0b8c117 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_assignment.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_assignment.py.snap @@ -297,24 +297,92 @@ aaaaa[aaaaaaaaaaa] = ( f"testeeeeeeeeeeeeeeeeeeeeeeeee{a =}" "moreeeeeeeeeeeeeeeeeetest" # comment ) -``` -## Outputs -### Output 1 -``` -indent-style = space -line-width = 88 -indent-width = 4 -quote-style = Double -line-ending = LineFeed -magic-trailing-comma = Respect -docstring-code = Disabled -docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py38 -source_type = Python -``` +# Trailing last-part comments + +a = ( + "a" + "b" # belongs to `b` +) + +a: Literal[str] = ( + "a" + "b" # belongs to `b` +) + +a += ( + "a" + "b" # belongs to `b` +) + +a = ( + r"a" + r"b" # belongs to `b` +) + +a = ( + "a" + "b" +) # belongs to the assignment + +a = ((( + "a" + "b" # belongs to `b` +))) + +a = ((( + "a" + "b" +) # belongs to the f-string expression +)) + +a = ( + "a" "b" # belongs to the f-string expression +) + +a = ( + "a" "b" + # belongs to the f-string expression +) + +# There's no "right" answer if some parts are on the same line while others are on separate lines. +# This is likely a comment for one of the last two parts but could also just be a comment for the entire f-string expression. +# Because there's no right answer, follow what we do elsewhere and associate the comment with the outer-most node which +# is the f-string expression. +a = ( + "a" + "b" "ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" # belongs to the f-string expression +) + +logger.error( + f"Failed to run task {task} for job" + f"with id {str(job.id)}" # type: ignore[union-attr] +) + +a = (10 + + "Exception in {call_back_name} " + f"'{msg}'" # belongs to binary operation +) + +a = 10 + ( + "Exception in {call_back_name} " + f"'{msg}'" # belongs to f-string +) + +self._attr_unique_id = ( + f"{self._device.temperature.group_address_state}_" + f"{self._device.target_temperature.group_address_state}_" + f"{self._device.target_temperature.group_address}_" + f"{self._device._setpoint_shift.group_address}" # noqa: SLF001 +) + +return ( + f"Exception in {call_back_name} when handling msg on " + f"'{msg.topic}': '{msg.payload}'" # type: ignore[str-bytes-safe] +)``` + +## Output ```python ## Implicit concatenated strings with a trailing comment but a non splittable target. @@ -634,4 +702,77 @@ aaaaa[aaaaaaaaaaa] = ( =}" "moreeeeeeeeeeeeeeeeeetest" # comment ) + + +# Trailing last-part comments + +a = ( + "a" + "b" # belongs to `b` +) + +a: Literal[str] = ( + "a" + "b" # belongs to `b` +) + +a += ( + "a" + "b" # belongs to `b` +) + +a = ( + r"a" + r"b" # belongs to `b` +) + +a = "ab" # belongs to the assignment + +a = ( + "a" + "b" # belongs to `b` +) + +a = "ab" # belongs to the f-string expression + +a = "ab" # belongs to the f-string expression + +a = ( + "ab" + # belongs to the f-string expression +) + +# There's no "right" answer if some parts are on the same line while others are on separate lines. +# This is likely a comment for one of the last two parts but could also just be a comment for the entire f-string expression. +# Because there's no right answer, follow what we do elsewhere and associate the comment with the outer-most node which +# is the f-string expression. +a = ( + "a" + "b" + "ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" +) # belongs to the f-string expression + +logger.error( + f"Failed to run task {task} for jobwith id {str(job.id)}" # type: ignore[union-attr] +) + +a = ( + 10 + f"Exception in {{call_back_name}} '{msg}'" # belongs to binary operation +) + +a = 10 + ( + f"Exception in {{call_back_name}} '{msg}'" # belongs to f-string +) + +self._attr_unique_id = ( + f"{self._device.temperature.group_address_state}_" + f"{self._device.target_temperature.group_address_state}_" + f"{self._device.target_temperature.group_address}_" + f"{self._device._setpoint_shift.group_address}" # noqa: SLF001 +) + +return ( + f"Exception in {call_back_name} when handling msg on " + f"'{msg.topic}': '{msg.payload}'" # type: ignore[str-bytes-safe] +) ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_preserve.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_preserve.py.snap index 72e46d20bf8af..a9d9f10827ea8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_preserve.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__join_implicit_concatenated_string_preserve.py.snap @@ -17,6 +17,15 @@ a = "different '" 'quote "are fine"' # join # Already invalid Pre Python 312 f"{'Hy "User"'}" f'{"Hy 'User'"}' + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15514 +params = {} +string = "this is my string with " f'"{params.get("mine")}"' +string = f'"{params.get("mine")} ' f"with {'nested single quoted string'}" +string = f"{'''inner ' '''}" f'{"""inner " """}' +string = f"{10 + len('bar')=}" f"{10 + len('bar')=}" +string = f"{10 + len('bar')=}" f'{10 + len("bar")=}' ``` ## Outputs @@ -30,8 +39,8 @@ line-ending = LineFeed magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py38 +preview = Disabled +target_version = 3.9 source_type = Python ``` @@ -49,6 +58,15 @@ a = "different 'quote \"are fine\"" # join # Already invalid Pre Python 312 f"{'Hy "User"'}{"Hy 'User'"}" + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15514 +params = {} +string = f"this is my string with \"{params.get('mine')}\"" +string = f'"{params.get("mine")} with {"nested single quoted string"}' +string = f"{'''inner ' '''}" f'{"""inner " """}' +string = f"{10 + len('bar')=}{10 + len('bar')=}" +string = f"{10 + len('bar')=}" f'{10 + len("bar")=}' ``` @@ -62,8 +80,8 @@ line-ending = LineFeed magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py312 +preview = Disabled +target_version = 3.12 source_type = Python ``` @@ -81,4 +99,13 @@ a = "different 'quote \"are fine\"" # join # Already invalid Pre Python 312 f"{'Hy "User"'}{"Hy 'User'"}" + + +# Regression tests for https://github.com/astral-sh/ruff/issues/15514 +params = {} +string = f"this is my string with \"{params.get("mine")}\"" +string = f'"{params.get("mine")} with {'nested single quoted string'}' +string = f"{'''inner ' '''}{"""inner " """}" +string = f"{10 + len('bar')=}{10 + len('bar')=}" +string = f"{10 + len('bar')=}{10 + len("bar")=}" ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__lambda.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__lambda.py.snap index e9874be9def3d..03332c6f924e4 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__lambda.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__lambda.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/lambda.py +snapshot_kind: text --- ## Input ```python @@ -473,6 +474,3 @@ def a(): g=10, ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__list.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__list.py.snap index b798984c65a8e..4fbc4185fc167 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__list.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__list.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/list.py +snapshot_kind: text --- ## Input ```python @@ -127,6 +128,3 @@ c1 = [ # trailing open bracket ), ] # outer comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__list_comp.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__list_comp.py.snap index ca2f9d45d2b34..0dcdb03493723 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__list_comp.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__list_comp.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/list_comp.py +snapshot_kind: text --- ## Input ```python @@ -322,24 +323,20 @@ aaaaaaaaaaaaaaaaaaaaa = [ # Leading expression comments: y = [ a - for - ( + for ( # comment a - ) in - ( + ) in ( # comment x ) - if - ( + if ( # asdasd "askldaklsdnmklasmdlkasmdlkasmdlkasmdasd" != "as,mdnaskldmlkasdmlaksdmlkasdlkasdm" and "zxcm,.nzxclm,zxnckmnzxckmnzxczxc" != "zxcasdasdlmnasdlknaslkdnmlaskdm" ) - if - ( + if ( # comment x ) @@ -382,39 +379,3 @@ y = [ x ] ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -142,24 +142,20 @@ - # Leading expression comments: - y = [ - a -- for -- ( -+ for ( - # comment - a -- ) in -- ( -+ ) in ( - # comment - x - ) -- if -- ( -+ if ( - # asdasd - "askldaklsdnmklasmdlkasmdlkasmdlkasmdasd" - != "as,mdnaskldmlkasdmlaksdmlkasdlkasdm" - and "zxcm,.nzxclm,zxnckmnzxckmnzxczxc" != "zxcasdasdlmnasdlknaslkdnmlaskdm" - ) -- if -- ( -+ if ( - # comment - x - ) -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__named_expr.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__named_expr.py.snap index 0425268563b40..5e2c2087b636c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__named_expr.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__named_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/named_expr.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__number.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__number.py.snap index fe8a33ef8e8e0..349ea964aa6ca 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__number.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__number.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/number.py +snapshot_kind: text --- ## Input ```python @@ -23,6 +24,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression 1.0e1 1.1e1 ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__optional_parentheses_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__optional_parentheses_comments.py.snap index d577bea205aee..1b3497db8a16f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__optional_parentheses_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__optional_parentheses_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/optional_parentheses_comments.py +snapshot_kind: text --- ## Input ```python @@ -419,6 +420,3 @@ def test6(): # 89 characters parenthesized (collapse) return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbvvvvvvvv # c ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__set_comp.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__set_comp.py.snap index b73d9a599e793..179af7f4cd69b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__set_comp.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__set_comp.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/set_comp.py +snapshot_kind: text --- ## Input ```python @@ -123,6 +124,3 @@ selected_choices = { if str(v) not in self.choices.field.empty_values } ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__slice.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__slice.py.snap index 7e12e244743c1..1d2eec247c997 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__slice.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__slice.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/slice.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__split_empty_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__split_empty_brackets.py.snap index 2c9fb1d380816..65fa97cca4ee0 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__split_empty_brackets.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__split_empty_brackets.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/split_empty_brackets.py +snapshot_kind: text --- ## Input ```python @@ -212,6 +213,3 @@ response = await sync_to_async( return await self.http_client.fetch( f"http://127.0.0.1:{self.port}{path}", ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__starred.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__starred.py.snap index 225242f0342fc..dc468322ebcad 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__starred.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__starred.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/starred.py +snapshot_kind: text --- ## Input ```python @@ -99,6 +100,3 @@ call( ), ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__string.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__string.py.snap index 3303732eb9434..953b2c34cbc8b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__string.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__string.py.snap @@ -144,6 +144,80 @@ a = f"""\x1F""" a = """\x1F""" a = """\\x1F""" a = """\\\x1F""" + + +############################################################################## +# Implicit concatenated strings +############################################################################## + +# In preview, don't collapse implicit concatenated strings that can't be joined into a single string +# and that are multiline in the source. + +( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" +) + +( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + "cccccccccccccccccccccc" +) + +( + """aaaaaaaaa""" + """bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{ + 10}aaaaa""" + fr"""bbbbbbbbbbbbbbbbbbbb""" +) + +if ( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" + ) + ["aaaaaaaaaa", "bbbbbbbbbbbbbbbb"]: ... + + + +# In preview, keep implicit concatenated strings on a single line if they fit and are not separate by line breaks in the source +( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" +) + +r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + +( + f"aaaa{ + 10}aaaaa" fr"bbbbbbbbbbbbbbbbbbbb" +) + +( + r"""aaaaaaaaa""" r"""bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{ + 10}aaaaa""" fr"""bbbbbbbbbbbbbbbbbbbb""" +) + +# In docstring positions +def docstring(): + ( + r"aaaaaaaaa" + "bbbbbbbbbbbbbbbbbbbb" + ) + +def docstring_flat(): + ( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + ) + +def docstring_flat_overlong(): + ( + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + ) ``` ## Outputs @@ -158,7 +232,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -235,9 +309,9 @@ String \"\"\" # String continuation -"Let's" "start" "with" "a" "simple" "example" +"Let'sstartwithasimpleexample" -"Let's" "start" "with" "a" "simple" "example" "now repeat after me:" "I am confident" "I am confident" "I am confident" "I am confident" "I am confident" +"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" ( "Let's" @@ -304,7 +378,7 @@ test_particular = [ ] # Parenthesized string continuation with messed up indentation -{"key": ([], "a" "b" "c")} +{"key": ([], "abc")} # Regression test for https://github.com/astral-sh/ruff/issues/5893 @@ -328,34 +402,72 @@ a = f"""\x1f""" a = """\x1f""" a = """\\x1F""" a = """\\\x1f""" -``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -70,9 +70,9 @@ - - # String continuation - --"Let's" "start" "with" "a" "simple" "example" -+"Let'sstartwithasimpleexample" - --"Let's" "start" "with" "a" "simple" "example" "now repeat after me:" "I am confident" "I am confident" "I am confident" "I am confident" "I am confident" -+"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" - - ( - "Let's" -@@ -139,7 +139,7 @@ - ] - - # Parenthesized string continuation with messed up indentation --{"key": ([], "a" "b" "c")} -+{"key": ([], "abc")} - - - # Regression test for https://github.com/astral-sh/ruff/issues/5893 +############################################################################## +# Implicit concatenated strings +############################################################################## + +# In preview, don't collapse implicit concatenated strings that can't be joined into a single string +# and that are multiline in the source. + +( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" +) + +( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" + "cccccccccccccccccccccc" +) + +( + """aaaaaaaaa""" + """bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{10}aaaaa""" + rf"""bbbbbbbbbbbbbbbbbbbb""" +) + +if ( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbb" +) + ["aaaaaaaaaa", "bbbbbbbbbbbbbbbb"]: + ... + + +# In preview, keep implicit concatenated strings on a single line if they fit and are not separate by line breaks in the source +(r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb") + +r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + +(f"aaaa{10}aaaaa" rf"bbbbbbbbbbbbbbbbbbbb") + +(r"""aaaaaaaaa""" r"""bbbbbbbbbbbbbbbbbbbb""") + +(f"""aaaa{10}aaaaa""" rf"""bbbbbbbbbbbbbbbbbbbb""") + + +# In docstring positions +def docstring(): + ( + r"aaaaaaaaa" + "bbbbbbbbbbbbbbbbbbbb" + ) + + +def docstring_flat(): + r"aaaaaaaaa" r"bbbbbbbbbbbbbbbbbbbb" + + +def docstring_flat_overlong(): + ( + r"aaaaaaaaa" + r"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + ) ``` @@ -370,7 +482,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -447,9 +559,9 @@ String \"\"\" # String continuation -"Let's" 'start' 'with' 'a' 'simple' 'example' +"Let'sstartwithasimpleexample" -"Let's" 'start' 'with' 'a' 'simple' 'example' 'now repeat after me:' 'I am confident' 'I am confident' 'I am confident' 'I am confident' 'I am confident' +"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" ( "Let's" @@ -516,7 +628,7 @@ test_particular = [ ] # Parenthesized string continuation with messed up indentation -{'key': ([], 'a' 'b' 'c')} +{'key': ([], 'abc')} # Regression test for https://github.com/astral-sh/ruff/issues/5893 @@ -540,32 +652,70 @@ a = f"""\x1f""" a = """\x1f""" a = """\\x1F""" a = """\\\x1f""" -``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -70,9 +70,9 @@ - - # String continuation - --"Let's" 'start' 'with' 'a' 'simple' 'example' -+"Let'sstartwithasimpleexample" - --"Let's" 'start' 'with' 'a' 'simple' 'example' 'now repeat after me:' 'I am confident' 'I am confident' 'I am confident' 'I am confident' 'I am confident' -+"Let'sstartwithasimpleexamplenow repeat after me:I am confidentI am confidentI am confidentI am confidentI am confident" - - ( - "Let's" -@@ -139,7 +139,7 @@ - ] - - # Parenthesized string continuation with messed up indentation --{'key': ([], 'a' 'b' 'c')} -+{'key': ([], 'abc')} - - - # Regression test for https://github.com/astral-sh/ruff/issues/5893 +############################################################################## +# Implicit concatenated strings +############################################################################## + +# In preview, don't collapse implicit concatenated strings that can't be joined into a single string +# and that are multiline in the source. + +( + r'aaaaaaaaa' + r'bbbbbbbbbbbbbbbbbbbb' +) + +( + r'aaaaaaaaa' + r'bbbbbbbbbbbbbbbbbbbb' + 'cccccccccccccccccccccc' +) + +( + """aaaaaaaaa""" + """bbbbbbbbbbbbbbbbbbbb""" +) + +( + f"""aaaa{10}aaaaa""" + rf"""bbbbbbbbbbbbbbbbbbbb""" +) + +if ( + r'aaaaaaaaa' + r'bbbbbbbbbbbbbbbbbbbb' +) + ['aaaaaaaaaa', 'bbbbbbbbbbbbbbbb']: + ... + + +# In preview, keep implicit concatenated strings on a single line if they fit and are not separate by line breaks in the source +(r'aaaaaaaaa' r'bbbbbbbbbbbbbbbbbbbb') + +r'aaaaaaaaa' r'bbbbbbbbbbbbbbbbbbbb' + +(f'aaaa{10}aaaaa' rf'bbbbbbbbbbbbbbbbbbbb') + +(r"""aaaaaaaaa""" r"""bbbbbbbbbbbbbbbbbbbb""") + +(f"""aaaa{10}aaaaa""" rf"""bbbbbbbbbbbbbbbbbbbb""") + + +# In docstring positions +def docstring(): + ( + r'aaaaaaaaa' + 'bbbbbbbbbbbbbbbbbbbb' + ) + + +def docstring_flat(): + r'aaaaaaaaa' r'bbbbbbbbbbbbbbbbbbbb' + + +def docstring_flat_overlong(): + ( + r'aaaaaaaaa' + r'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb' + ) ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__subscript.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__subscript.py.snap index 71fee09c216ba..4a97d4ebe8ca0 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__subscript.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__subscript.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/subscript.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__tuple.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__tuple.py.snap index 1aa67094d507f..00489faf9c5b1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__tuple.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__tuple.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/tuple.py +snapshot_kind: text --- ## Input ```python @@ -283,6 +284,3 @@ i1 = ( "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", ) # This should break ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__unary.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__unary.py.snap index 0d80fc1a258b6..67f54f9da90a7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__unary.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__unary.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/unary.py +snapshot_kind: text --- ## Input ```python @@ -415,6 +416,3 @@ def foo(): ): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__unsplittable.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__unsplittable.py.snap index a40713b2d1f4c..647fded93d4f7 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__unsplittable.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__unsplittable.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/unsplittable.py +snapshot_kind: text --- ## Input ```python @@ -217,6 +218,3 @@ def f(): True ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__yield.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__yield.py.snap index 0649b92081271..8f0589d5c3170 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__yield.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__yield.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/yield.py +snapshot_kind: text --- ## Input ```python @@ -209,7 +210,7 @@ yield ( ) ) -yield "Cache key will cause errors if used with memcached: %r " "(longer than %s)" % ( +yield "Cache key will cause errors if used with memcached: %r (longer than %s)" % ( key, MEMCACHE_MAX_KEY_LENGTH, ) @@ -227,8 +228,7 @@ yield ( "Django to create, modify, and delete the table" ) yield ( - "# Feel free to rename the models, but don't rename db_table values or " - "field names." + "# Feel free to rename the models, but don't rename db_table values or field names." ) yield ( @@ -240,8 +240,7 @@ yield ( "Django to create, modify, and delete the table" ) yield ( - "# Feel free to rename the models, but don't rename db_table values or " - "field names." + "# Feel free to rename the models, but don't rename db_table values or field names." ) # Regression test for: https://github.com/astral-sh/ruff/issues/7420 @@ -277,39 +276,3 @@ result = yield ( print((yield x)) ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -78,7 +78,7 @@ - ) - ) - --yield "Cache key will cause errors if used with memcached: %r " "(longer than %s)" % ( -+yield "Cache key will cause errors if used with memcached: %r (longer than %s)" % ( - key, - MEMCACHE_MAX_KEY_LENGTH, - ) -@@ -96,8 +96,7 @@ - "Django to create, modify, and delete the table" - ) - yield ( -- "# Feel free to rename the models, but don't rename db_table values or " -- "field names." -+ "# Feel free to rename the models, but don't rename db_table values or field names." - ) - - yield ( -@@ -109,8 +108,7 @@ - "Django to create, modify, and delete the table" - ) - yield ( -- "# Feel free to rename the models, but don't rename db_table values or " -- "field names." -+ "# Feel free to rename the models, but don't rename db_table values or field names." - ) - - # Regression test for: https://github.com/astral-sh/ruff/issues/7420 -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@expression__yield_from.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@expression__yield_from.py.snap index cfbea8ba9aab5..dd3e64383f30a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@expression__yield_from.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@expression__yield_from.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/yield_from.py +snapshot_kind: text --- ## Input ```python @@ -69,6 +70,3 @@ def foo(): yield (yield from l) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__comments.py.snap index a84753bdf6ecf..6522d4e8ff9b3 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/comments.py +snapshot_kind: text --- ## Input ```python @@ -65,6 +66,3 @@ def test(): # fmt: off # a trailing comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__empty_file.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__empty_file.py.snap index ea604491f3237..98272aa0c35b0 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__empty_file.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__empty_file.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/empty_file.py +snapshot_kind: text --- ## Input ```python @@ -19,6 +20,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off # fmt: on ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_docstring.py.snap index 7c1a60237fcb4..c7775aba83819 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_docstring.py.snap @@ -37,7 +37,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -75,7 +75,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -100,6 +100,3 @@ def test(): and_this + gets + formatted + too ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_deep_nested_trailing_comment.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_deep_nested_trailing_comment.py.snap index 474830dfe139b..7adb22ee55407 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_deep_nested_trailing_comment.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_deep_nested_trailing_comment.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/fmt_off_unclosed_deep_nested_trailing_comment.py +snapshot_kind: text --- ## Input ```python @@ -25,6 +26,3 @@ if True: if False: x: int # Optional[int] ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_trailing_comment.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_trailing_comment.py.snap index 2fb64fea20688..e615c7b69773f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_trailing_comment.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__fmt_off_unclosed_trailing_comment.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/fmt_off_unclosed_trailing_comment.py +snapshot_kind: text --- ## Input ```python @@ -25,6 +26,3 @@ from dataclasses import dataclass class A: x: int # Optional[int] ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__form_feed.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__form_feed.py.snap index e5fb8812dc73c..1ce5808e85707 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__form_feed.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__form_feed.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/form_feed.py +snapshot_kind: text --- ## Input ```python @@ -24,6 +25,3 @@ def test(): def test(): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__indent.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__indent.py.snap index f0f8cce20ba52..8fd14d663462f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__indent.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__indent.py.snap @@ -18,7 +18,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -37,7 +37,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -56,12 +56,9 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` ```python ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__last_statement.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__last_statement.py.snap index 311edae5520f0..973ed62808186 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__last_statement.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__last_statement.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/last_statement.py +snapshot_kind: text --- ## Input ```python @@ -30,6 +31,3 @@ def test(): a + b # formatted ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__mixed_space_and_tab.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__mixed_space_and_tab.py.snap index 1fe337eadba55..99bde1d1d63ec 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__mixed_space_and_tab.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__mixed_space_and_tab.py.snap @@ -33,7 +33,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -68,7 +68,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -103,7 +103,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -125,6 +125,3 @@ not_fixed # fmt: on ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__newlines.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__newlines.py.snap index 9faec5b646aac..3d84932a69e18 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__newlines.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__newlines.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/newlines.py +snapshot_kind: text --- ## Input ```python @@ -85,6 +86,3 @@ def func(): def func(): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__no_fmt_on.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__no_fmt_on.py.snap index f66b8bad7d6a7..5174d25c8d8c1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__no_fmt_on.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__no_fmt_on.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/no_fmt_on.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__off_on_off_on.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__off_on_off_on.py.snap index c06d40dd9cd30..0d3da965aac2c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__off_on_off_on.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__off_on_off_on.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/off_on_off_on.py +snapshot_kind: text --- ## Input ```python @@ -151,6 +152,3 @@ def test (): a + b ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__simple.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__simple.py.snap index 727884cef73e7..7a80aaacce654 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__simple.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__simple.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/simple.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_comments.py.snap index c56a1c47b23cb..a4eb13b410ffa 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/trailing_comments.py +snapshot_kind: text --- ## Input ```python @@ -90,6 +91,3 @@ def test3 (): # fmt: on ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_semicolon.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_semicolon.py.snap index 1fba95d615401..22a0a82413cf9 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_semicolon.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__trailing_semicolon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/trailing_semicolon.py +snapshot_kind: text --- ## Input ```python @@ -64,6 +65,3 @@ a = 10 # fmt: off last_statement_with_semi ; ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__yapf.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__yapf.py.snap index 7f3b39a0c4cae..77fe95026a586 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__yapf.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_on_off__yapf.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/yapf.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__decorators.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__decorators.py.snap index 563c35b5d4536..6e2192b520556 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__decorators.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__decorators.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/decorators.py +snapshot_kind: text --- ## Input ```python @@ -71,6 +72,3 @@ class Foo: # fmt: skip def foo(): # fmt: skip pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__docstrings.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__docstrings.py.snap index 72456f720c067..d473520c8a715 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__docstrings.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__docstrings.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/docstrings.py +snapshot_kind: text --- ## Input ```python @@ -35,6 +36,3 @@ def test(): and_this + gets + formatted + too ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__match.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__match.py.snap index 9d8481a05830b..1381d6e25da5a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__match.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__match.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/match.py +snapshot_kind: text --- ## Input ```python @@ -158,6 +159,3 @@ match point: case Point(x, y): print(f"Point is not on the diagonal.") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__or_else.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__or_else.py.snap index d68da5658d630..a4d535404b346 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__or_else.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__or_else.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/or_else.py +snapshot_kind: text --- ## Input ```python @@ -71,6 +72,3 @@ else : # fmt: skip finally : # fmt: skip finally_call() ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__parentheses.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__parentheses.py.snap index 27719c174afc6..7515f3c86081f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__parentheses.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__parentheses.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/parentheses.py +snapshot_kind: text --- ## Input ```python @@ -49,6 +50,3 @@ if ( # trailing open parentheses comment ) and y: # fmt: skip pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__reason.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__reason.py.snap index 296742a0acd6e..7ad73e82677f4 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__reason.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__reason.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/reason.py +snapshot_kind: text --- ## Input ```python @@ -27,6 +28,3 @@ x = 1 # fmt: skip reason x = 1 # fmt: skip - reason x = 1 # fmt: skip; noqa ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__trailing_semi.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__trailing_semi.py.snap index 55c9a112e843a..f059e4257faee 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__trailing_semi.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__trailing_semi.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/trailing_semi.py +snapshot_kind: text --- ## Input ```python @@ -29,6 +30,3 @@ x = 1 # ; # fmt: skip _ # unrelated semicolon ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__type_params.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__type_params.py.snap index e38376ca8dabe..93eb2442bd76d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__type_params.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@fmt_skip__type_params.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_skip/type_params.py +snapshot_kind: text --- ## Input ```python @@ -89,6 +90,3 @@ def test [ ] () -> str: # fmt: skip ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@form_feed.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@form_feed.py.snap index c6a5a26dbfa04..a461554f7d755 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@form_feed.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@form_feed.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/form_feed.py +snapshot_kind: text --- ## Input ```python @@ -21,6 +22,3 @@ if symbol is not None: else: pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment1.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment1.py.snap index 34f9219fb3577..3a74d69888866 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment1.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment1.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/module_dangling_comment1.py +snapshot_kind: text --- ## Input ```python @@ -15,6 +16,3 @@ __all__ = ["X", "XK", "Xatom", "Xcursorfont", "Xutil", "display", "error", "rdb" # Shared types throughout the stub ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment2.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment2.py.snap index 768e829c77089..1bce6a4e14012 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment2.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@module_dangling_comment2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/module_dangling_comment2.py +snapshot_kind: text --- ## Input ```python @@ -13,6 +14,3 @@ __all__ = ["X", "XK", "Xatom", "Xcursorfont", "Xutil", "display", "error", "rdb" __all__ = ["X", "XK", "Xatom", "Xcursorfont", "Xutil", "display", "error", "rdb"] # Shared types throughout the stub ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@multiline_string_deviations.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@multiline_string_deviations.py.snap index b04238a5ca7bf..c4fde9b127423 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@multiline_string_deviations.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@multiline_string_deviations.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/multiline_string_deviations.py +snapshot_kind: text --- ## Input ```python @@ -105,6 +106,3 @@ generated_readme = ( """.strip().format(project_name) ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@newlines.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@newlines.py.snap index 292918d126272..84bd4283c469e 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@newlines.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@newlines.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/newlines.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@newlines.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@newlines.pyi.snap index 121c3bb85e2d7..f19605db1c071 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@newlines.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@newlines.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/newlines.pyi +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@notebook_docstring.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@notebook_docstring.py.snap index ffda594e165bf..6018c9fc26a27 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@notebook_docstring.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@notebook_docstring.py.snap @@ -24,7 +24,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Ipynb ``` @@ -48,7 +48,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -60,6 +60,3 @@ Ruff should leave it as is "another normal string" ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__call_chains.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__call_chains.py.snap index 1dfd3e8f7c79d..4da30d36320ec 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__call_chains.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__call_chains.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/parentheses/call_chains.py +snapshot_kind: text --- ## Input ```python @@ -466,6 +467,3 @@ max_message_id = ( .baz() ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__expression_parentheses_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__expression_parentheses_comments.py.snap index 625d83e17178c..5e8e826231f3b 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__expression_parentheses_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__expression_parentheses_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/parentheses/expression_parentheses_comments.py +snapshot_kind: text --- ## Input ```python @@ -218,6 +219,3 @@ x = ( 1 ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__nested.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__nested.py.snap index 3616fa2267daf..e05c287ef6c43 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__nested.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__nested.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/parentheses/nested.py +snapshot_kind: text --- ## Input ```python @@ -133,6 +134,3 @@ b3 = ( () ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_empty.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_empty.py.snap index 7969cd7b7d29c..4559988d60ea2 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_empty.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_empty.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/parentheses/opening_parentheses_comment_empty.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_value.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_value.py.snap index 2dc81368793b1..56389699348bb 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_value.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@parentheses__opening_parentheses_comment_value.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/parentheses/opening_parentheses_comment_value.py +snapshot_kind: text --- ## Input ```python @@ -346,6 +347,3 @@ f5 = { # f5 i: i**2 for i in range(10) } ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@pattern__pattern_maybe_parenthesize.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@pattern__pattern_maybe_parenthesize.py.snap index 89c82dd396ddd..533245670b8e3 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@pattern__pattern_maybe_parenthesize.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@pattern__pattern_maybe_parenthesize.py.snap @@ -294,7 +294,15 @@ match x: ]: pass - +match a, b: + case [], []: + ... + case [], _: + ... + case _, []: + ... + case _, _: + ... ``` @@ -303,31 +311,43 @@ match x: # Patterns that use BestFit should be parenthesized if they exceed the configured line width # but fit within parentheses. match x: - case "averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPar": + case ( + "averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPar" + ): pass match x: - case b"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa": + case ( + b"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa" + ): pass match x: - case f"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa": + case ( + f"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa" + ): pass match x: - case 5444444444444444444444444444444444444444444444444444444444444444444444444444444j: + case ( + 5444444444444444444444444444444444444444444444444444444444444444444444444444444j + ): pass match x: - case 5444444444444444444444444444444444444444444444444444444444444444444444444444444: + case ( + 5444444444444444444444444444444444444444444444444444444444444444444444444444444 + ): pass match x: - case 5.44444444444444444444444444444444444444444444444444444444444444444444444444444: + case ( + 5.44444444444444444444444444444444444444444444444444444444444444444444444444444 + ): pass @@ -384,108 +404,89 @@ match x: match x: - case "an implicit concatenated" "string literal" "in a match case" "that goes over multiple lines": + case ( + "an implicit concatenated" + "string literal" + "in a match case" + "that goes over multiple lines" + ): pass ## Patterns ending with a sequence, mapping, class, or parenthesized pattern should break the parenthesized-like pattern first match x: - case ( - A - | [ - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, - ] - ): + case A | [ + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ]: pass match x: - case ( - A - | ( - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, - ) + case A | ( + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, ): pass match x: - case ( - A - | { - "a": aaaaaa, - "b": bbbbbbbbbbbbbbbb, - "c": cccccccccccccccccc, - "d": ddddddddddddddddddddddddddd, - } - ): + case A | { + "a": aaaaaa, + "b": bbbbbbbbbbbbbbbb, + "c": cccccccccccccccccc, + "d": ddddddddddddddddddddddddddd, + }: pass match x: - case ( - A - | Class( - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, - ) + case A | Class( + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, ): pass match x: - case ( - A - | ( - aaaaaaaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbbbbbbbb.cccccccccccccccccccccccccccc.ddddddddddddddddddddddd - ) + case A | ( + aaaaaaaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbbbbbbbb.cccccccccccccccccccccccccccc.ddddddddddddddddddddddd ): pass ## Patterns starting with a sequence, mapping, class, or parenthesized pattern should break the parenthesized-like pattern first match x: - case ( - [ - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, - ] - | A - ): + case [ + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ] | A: pass match x: case ( - ( - aaaaaa, - bbbbbbbbbbbbbbbb, - cccccccccccccccccc, - ddddddddddddddddddddddddddd, - ) - | A - ): + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ) | A: pass match x: - case ( - { - "a": aaaaaa, - "b": bbbbbbbbbbbbbbbb, - "c": cccccccccccccccccc, - "d": ddddddddddddddddddddddddddd, - } - | A - ): + case { + "a": aaaaaa, + "b": bbbbbbbbbbbbbbbb, + "c": cccccccccccccccccc, + "d": ddddddddddddddddddddddddddd, + } | A: pass @@ -502,8 +503,7 @@ match x: ## Not for non-parenthesized sequence patterns match x: case ( - (1) - | aaaaaaaaaaaaaaaaaaaaaaaaaaaa, + (1) | aaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, ccccccccccccccccccccccccccccccccc, ): @@ -522,448 +522,91 @@ match x: ## Always use parentheses for implicitly concatenated strings match x: - case ( - "implicit" "concatenated" "string" - | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] - ): + case "implicitconcatenatedstring" | [ + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ]: pass match x: - case ( - b"implicit" b"concatenated" b"string" - | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] - ): + case b"implicitconcatenatedstring" | [ + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ]: pass match x: - case ( - f"implicit" "concatenated" "string" - | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] - ): + case f"implicitconcatenatedstring" | [ + aaaaaa, + bbbbbbbbbbbbbbbb, + cccccccccccccccccc, + ddddddddddddddddddddddddddd, + ]: pass ## Complex number expressions and unary expressions match x: - case ( - 4 - 3j - | [ - aaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbb, - cccccccccccccccccccccccccccccccccccccccc, - ] - ): + case 4 - 3j | [ + aaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbbbbb, + cccccccccccccccccccccccccccccccccccccccc, + ]: pass match x: - case ( - 4 + 3j - | [ - aaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbb, - cccccccccccccccccccccccccccccccccccccccc, - ] - ): + case 4 + 3j | [ + aaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbbbbb, + cccccccccccccccccccccccccccccccccccccccc, + ]: pass match x: - case ( - -1 - | [ - aaaaaaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, - ccccccccccccccccccccccccccccccccc, - ] - ): + case -1 | [ + aaaaaaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, + ccccccccccccccccccccccccccccccccc, + ]: pass ### Parenthesized patterns match x: - case ( - (1) - | [ - aaaaaaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, - ccccccccccccccccccccccccccccccccc, - ] - ): + case (1) | [ + aaaaaaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, + ccccccccccccccccccccccccccccccccc, + ]: pass match x: - case ( - ( # comment - 1 - ) - | [ - aaaaaaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, - ccccccccccccccccccccccccccccccccc, - ] - ): + case ( # comment + 1 + ) | [ + aaaaaaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, + ccccccccccccccccccccccccccccccccc, + ]: pass -``` - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -1,31 +1,43 @@ - # Patterns that use BestFit should be parenthesized if they exceed the configured line width - # but fit within parentheses. - match x: -- case "averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPar": -+ case ( -+ "averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPar" -+ ): - pass - - - match x: -- case b"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa": -+ case ( -+ b"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa" -+ ): - pass - - match x: -- case f"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa": -+ case ( -+ f"averyLongStringThatGetsParenthesizedOnceItExceedsTheConfiguredLineWidthFitsPa" -+ ): - pass - - - match x: -- case 5444444444444444444444444444444444444444444444444444444444444444444444444444444j: -+ case ( -+ 5444444444444444444444444444444444444444444444444444444444444444444444444444444j -+ ): - pass - - - match x: -- case 5444444444444444444444444444444444444444444444444444444444444444444444444444444: -+ case ( -+ 5444444444444444444444444444444444444444444444444444444444444444444444444444444 -+ ): - pass - - - match x: -- case 5.44444444444444444444444444444444444444444444444444444444444444444444444444444: -+ case ( -+ 5.44444444444444444444444444444444444444444444444444444444444444444444444444444 -+ ): - pass - - -@@ -82,108 +94,89 @@ - - - match x: -- case "an implicit concatenated" "string literal" "in a match case" "that goes over multiple lines": -+ case ( -+ "an implicit concatenated" -+ "string literal" -+ "in a match case" -+ "that goes over multiple lines" -+ ): - pass - - - ## Patterns ending with a sequence, mapping, class, or parenthesized pattern should break the parenthesized-like pattern first - match x: -- case ( -- A -- | [ -- aaaaaa, -- bbbbbbbbbbbbbbbb, -- cccccccccccccccccc, -- ddddddddddddddddddddddddddd, -- ] -- ): -+ case A | [ -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ]: - pass - - match x: -- case ( -- A -- | ( -- aaaaaa, -- bbbbbbbbbbbbbbbb, -- cccccccccccccccccc, -- ddddddddddddddddddddddddddd, -- ) -+ case A | ( -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, - ): - pass - - - match x: -- case ( -- A -- | { -- "a": aaaaaa, -- "b": bbbbbbbbbbbbbbbb, -- "c": cccccccccccccccccc, -- "d": ddddddddddddddddddddddddddd, -- } -- ): -+ case A | { -+ "a": aaaaaa, -+ "b": bbbbbbbbbbbbbbbb, -+ "c": cccccccccccccccccc, -+ "d": ddddddddddddddddddddddddddd, -+ }: - pass - - - match x: -- case ( -- A -- | Class( -- aaaaaa, -- bbbbbbbbbbbbbbbb, -- cccccccccccccccccc, -- ddddddddddddddddddddddddddd, -- ) -+ case A | Class( -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, - ): - pass - - - match x: -- case ( -- A -- | ( -- aaaaaaaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbbbbbbbb.cccccccccccccccccccccccccccc.ddddddddddddddddddddddd -- ) -+ case A | ( -+ aaaaaaaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbbbbbbbb.cccccccccccccccccccccccccccc.ddddddddddddddddddddddd - ): - pass - - - ## Patterns starting with a sequence, mapping, class, or parenthesized pattern should break the parenthesized-like pattern first - match x: -- case ( -- [ -- aaaaaa, -- bbbbbbbbbbbbbbbb, -- cccccccccccccccccc, -- ddddddddddddddddddddddddddd, -- ] -- | A -- ): -+ case [ -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ] | A: - pass - - match x: - case ( -- ( -- aaaaaa, -- bbbbbbbbbbbbbbbb, -- cccccccccccccccccc, -- ddddddddddddddddddddddddddd, -- ) -- | A -- ): -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ) | A: - pass - - - match x: -- case ( -- { -- "a": aaaaaa, -- "b": bbbbbbbbbbbbbbbb, -- "c": cccccccccccccccccc, -- "d": ddddddddddddddddddddddddddd, -- } -- | A -- ): -+ case { -+ "a": aaaaaa, -+ "b": bbbbbbbbbbbbbbbb, -+ "c": cccccccccccccccccc, -+ "d": ddddddddddddddddddddddddddd, -+ } | A: - pass - - -@@ -200,8 +193,7 @@ - ## Not for non-parenthesized sequence patterns - match x: - case ( -- (1) -- | aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -+ (1) | aaaaaaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, - ccccccccccccccccccccccccccccccccc, - ): -@@ -220,89 +212,80 @@ - - ## Always use parentheses for implicitly concatenated strings - match x: -- case ( -- "implicit" "concatenated" "string" -- | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] -- ): -+ case "implicitconcatenatedstring" | [ -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ]: - pass - - - match x: -- case ( -- b"implicit" b"concatenated" b"string" -- | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] -- ): -+ case b"implicitconcatenatedstring" | [ -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ]: - pass - - - match x: -- case ( -- f"implicit" "concatenated" "string" -- | [aaaaaa, bbbbbbbbbbbbbbbb, cccccccccccccccccc, ddddddddddddddddddddddddddd] -- ): -+ case f"implicitconcatenatedstring" | [ -+ aaaaaa, -+ bbbbbbbbbbbbbbbb, -+ cccccccccccccccccc, -+ ddddddddddddddddddddddddddd, -+ ]: - pass - - - ## Complex number expressions and unary expressions - - match x: -- case ( -- 4 - 3j -- | [ -- aaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbbbbb, -- cccccccccccccccccccccccccccccccccccccccc, -- ] -- ): -+ case 4 - 3j | [ -+ aaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbbbbb, -+ cccccccccccccccccccccccccccccccccccccccc, -+ ]: - pass - - - match x: -- case ( -- 4 + 3j -- | [ -- aaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbbbbb, -- cccccccccccccccccccccccccccccccccccccccc, -- ] -- ): -+ case 4 + 3j | [ -+ aaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbbbbb, -+ cccccccccccccccccccccccccccccccccccccccc, -+ ]: - pass - - - match x: -- case ( -- -1 -- | [ -- aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -- ccccccccccccccccccccccccccccccccc, -- ] -- ): -+ case -1 | [ -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -+ ccccccccccccccccccccccccccccccccc, -+ ]: - pass - - - ### Parenthesized patterns - match x: -- case ( -- (1) -- | [ -- aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -- ccccccccccccccccccccccccccccccccc, -- ] -- ): -+ case (1) | [ -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -+ ccccccccccccccccccccccccccccccccc, -+ ]: - pass - - - match x: -- case ( -- ( # comment -- 1 -- ) -- | [ -- aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -- ccccccccccccccccccccccccccccccccc, -- ] -- ): -+ case ( # comment -+ 1 -+ ) | [ -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, -+ ccccccccccccccccccccccccccccccccc, -+ ]: - pass +match a, b: + case [], []: + ... + case [], _: + ... + case _, []: + ... + case _, _: + ... ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@pattern_match_regression_brackets.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@pattern_match_regression_brackets.py.snap new file mode 100644 index 0000000000000..ac0c88e972b05 --- /dev/null +++ b/crates/ruff_python_formatter/tests/snapshots/format@pattern_match_regression_brackets.py.snap @@ -0,0 +1,27 @@ +--- +source: crates/ruff_python_formatter/tests/fixtures.rs +input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/pattern_match_regression_brackets.py +--- +## Input +```python +# Ruff in some cases added brackets around tuples in some cases; deviating from Black. +# Ensure we don't revert already-applied formats with the fix. +# See https://github.com/astral-sh/ruff/pull/18147 +match a, b: + case [[], []]: + ... + case [[], _]: + ... +``` + +## Output +```python +# Ruff in some cases added brackets around tuples in some cases; deviating from Black. +# Ensure we don't revert already-applied formats with the fix. +# See https://github.com/astral-sh/ruff/pull/18147 +match a, b: + case [[], []]: + ... + case [[], _]: + ... +``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap index 96c34a25aaa4d..3557b8c4781b5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap @@ -84,7 +84,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -167,7 +167,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -237,6 +237,3 @@ def f(): collections.defaultdict(list) ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@quote_style.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@quote_style.py.snap index 68e97d27f0bc7..b79b0ead6e0e9 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@quote_style.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@quote_style.py.snap @@ -68,7 +68,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -108,10 +108,10 @@ rb"""rb double triple""" rb"""br single triple""" rb"""br double triple""" -'single1' 'single2' -'single1' 'double2' -'double1' 'single2' -'double1' 'double2' +'single1single2' +'single1double2' +'double1single2' +'double1double2' def docstring_single_triple(): @@ -131,28 +131,6 @@ def docstring_single(): ``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -33,10 +33,10 @@ - rb"""br single triple""" - rb"""br double triple""" - --'single1' 'single2' --'single1' 'double2' --'double1' 'single2' --'double1' 'double2' -+'single1single2' -+'single1double2' -+'double1single2' -+'double1double2' - - - def docstring_single_triple(): -``` - - ### Output 2 ``` indent-style = space @@ -164,7 +142,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -204,10 +182,10 @@ rb"""rb double triple""" rb"""br single triple""" rb"""br double triple""" -"single1" "single2" -"single1" "double2" -"double1" "single2" -"double1" "double2" +"single1single2" +"single1double2" +"double1single2" +"double1double2" def docstring_single_triple(): @@ -227,28 +205,6 @@ def docstring_single(): ``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -33,10 +33,10 @@ - rb"""br single triple""" - rb"""br double triple""" - --"single1" "single2" --"single1" "double2" --"double1" "single2" --"double1" "double2" -+"single1single2" -+"single1double2" -+"double1single2" -+"double1double2" - - - def docstring_single_triple(): -``` - - ### Output 3 ``` indent-style = space @@ -260,7 +216,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -300,10 +256,10 @@ rb"""rb double triple""" rb'''br single triple''' rb"""br double triple""" -'single1' 'single2' -'single1' "double2" -"double1" 'single2' -"double1" "double2" +'single1single2' +'single1double2' +"double1single2" +"double1double2" def docstring_single_triple(): @@ -321,25 +277,3 @@ def docstring_double(): def docstring_single(): 'single' ``` - - -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -33,10 +33,10 @@ - rb'''br single triple''' - rb"""br double triple""" - --'single1' 'single2' --'single1' "double2" --"double1" 'single2' --"double1" "double2" -+'single1single2' -+'single1double2' -+"double1single2" -+"double1double2" - - - def docstring_single_triple(): -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__ancestory.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__ancestory.py.snap index d309ad631139d..f95db3007bfc3 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__ancestory.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__ancestory.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/ancestory.py +snapshot_kind: text --- ## Input ```python @@ -48,6 +49,3 @@ def test_empty_lines (): print(" Do not format this") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__clause_header.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__clause_header.py.snap index 8238248983928..8f16a68d08d6a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__clause_header.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__clause_header.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/clause_header.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__comment_only_range.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__comment_only_range.py.snap index d69ceb6c42eac..ab845ad185272 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__comment_only_range.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__comment_only_range.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/comment_only_range.py +snapshot_kind: text --- ## Input ```python @@ -21,6 +22,3 @@ def test (): print("Do not format this" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__decorators.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__decorators.py.snap index 4b39451a05a5f..9c7cb5ae45c3d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__decorators.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__decorators.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/decorators.py +snapshot_kind: text --- ## Input ```python @@ -54,6 +55,3 @@ def test( a): print("after" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__docstring_code_examples.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__docstring_code_examples.py.snap index 13e46604e5151..0cb72a9fb45f8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__docstring_code_examples.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__docstring_code_examples.py.snap @@ -121,7 +121,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -273,7 +273,7 @@ magic-trailing-comma = Respect docstring-code = Enabled docstring-code-line-width = 88 preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -386,6 +386,3 @@ if True: foo, bar, quux = this_is_a_long_line(lion, giraffe, hippo, zeba, lemur, penguin, monkey) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_file.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_file.py.snap index ec7310c6095b8..7d3842db52a49 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_file.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_file.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/empty_file.py +snapshot_kind: text --- ## Input ```python @@ -9,6 +10,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_form ## Output ```python ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_range.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_range.py.snap index 4f4a1acd1a88b..b2f3ea5843afa 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_range.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__empty_range.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/empty_range.py +snapshot_kind: text --- ## Input ```python @@ -13,6 +14,3 @@ def test(): def test(): print( "test" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__end_of_file.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__end_of_file.py.snap index 2ef6ce2bab207..8e07b71f75b7d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__end_of_file.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__end_of_file.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/end_of_file.py +snapshot_kind: text --- ## Input ```python @@ -9,6 +10,3 @@ a + b<RANGE_START><RANGE_END>``` ## Output ```python a + b``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__fmt_on_off.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__fmt_on_off.py.snap index 5ddf8a65cbd37..6f657b60d737f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__fmt_on_off.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__fmt_on_off.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/fmt_on_off.py +snapshot_kind: text --- ## Input ```python @@ -57,6 +58,3 @@ class MyClass: def outside_formatting_range (self): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__indent.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__indent.py.snap index bf1c74c0c760d..669f8f5eb52ac 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__indent.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__indent.py.snap @@ -81,7 +81,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -160,7 +160,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -239,7 +239,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -305,6 +305,3 @@ def test6 (): print(3 + 4) print("Format to fix indentation") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_comments.py.snap index 9297aa57fd7d6..a3efadc515fca 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/leading_comments.py +snapshot_kind: text --- ## Input ```python @@ -77,6 +78,3 @@ def test3 (): print( "unformatted" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_trailing_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_trailing_comments.py.snap index 37fe8c31459f2..1390dc17a8b7c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_trailing_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__leading_trailing_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/leading_trailing_comments.py +snapshot_kind: text --- ## Input ```python @@ -41,6 +42,3 @@ def test (): print("Do not format this 2" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__module.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__module.py.snap index 652bc2a60562f..74c420c5b20a3 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__module.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__module.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/module.py +snapshot_kind: text --- ## Input ```python @@ -29,6 +30,3 @@ print("still in range") print("After range end" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__parentheses.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__parentheses.py.snap index 09ead4c89d270..38ae52f175f26 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__parentheses.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__parentheses.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/parentheses.py +snapshot_kind: text --- ## Input ```python @@ -36,6 +37,3 @@ def format_range_after_inserted_parens (): a and item.sizing_mode is None and item.width_policy == "auto" and item.height_policy == "automatic" print("Format this") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__range_narrowing.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__range_narrowing.py.snap index 55ee3b708d0d7..d7fbe53c9afb6 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__range_narrowing.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__range_narrowing.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/range_narrowing.py +snapshot_kind: text --- ## Input ```python @@ -25,6 +26,3 @@ def test (): print("nor this" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__regressions.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__regressions.py.snap index 914a83b6e59b9..66151a4b7a96e 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__regressions.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__regressions.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/regressions.py +snapshot_kind: text --- ## Input ```python @@ -166,6 +167,3 @@ def test_start (): def new_function_inserted_after_test_start(): print("This should get formatted") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__same_line_body.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__same_line_body.py.snap index b637a77a23062..1f29bc3488995 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__same_line_body.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__same_line_body.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/same_line_body.py +snapshot_kind: text --- ## Input ```python @@ -19,10 +20,10 @@ print("after" ) # The if header and the print statement together are longer than 100 characters. # The print statement should either be wrapped to fit at the end of the if statement, or be converted to a # suite body -if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be intented" )<RANGE_END> +if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be indented" )<RANGE_END> -# This print statement is too-long even when intented. It should be wrapped -if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be intented", "more content to make it exceed the 88 chars limit")<RANGE_END> +# This print statement is too long even when indented. It should be wrapped +if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: <RANGE_START>print("aaaa long body, should wrap or be indented", "more content to make it exceed the 88 chars limit")<RANGE_END> ``` ## Output @@ -47,15 +48,12 @@ print("after" ) # The print statement should either be wrapped to fit at the end of the if statement, or be converted to a # suite body if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: - print("aaaa long body, should wrap or be intented") + print("aaaa long body, should wrap or be indented") -# This print statement is too-long even when intented. It should be wrapped +# This print statement is too long even when indented. It should be wrapped if aaaaaaaaaaaa + bbbbbbbbbbbbbb + cccccccccccccccccc + ddd: print( - "aaaa long body, should wrap or be intented", + "aaaa long body, should wrap or be indented", "more content to make it exceed the 88 chars limit", ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__stub.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__stub.pyi.snap index 9af561285833f..d2ec8f05d87f5 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__stub.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__stub.pyi.snap @@ -33,8 +33,8 @@ line-ending = LineFeed magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py38 +preview = Disabled +target_version = 3.9 source_type = Stub ``` @@ -56,6 +56,3 @@ class Test4: class Test4: ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__trailing_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__trailing_comments.py.snap index 9e6a775af7ffc..33c059d881eb0 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__trailing_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__trailing_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/trailing_comments.py +snapshot_kind: text --- ## Input ```python @@ -69,6 +70,3 @@ def test3 (): print( "world" ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__whitespace_only_range.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__whitespace_only_range.py.snap index 4e22fa6805a04..26548ab5f3318 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__whitespace_only_range.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@range_formatting__whitespace_only_range.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/range_formatting/whitespace_only_range.py +snapshot_kind: text --- ## Input ```python @@ -20,6 +21,3 @@ def test(): def test_formatted(): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@skip_magic_trailing_comma.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@skip_magic_trailing_comma.py.snap index 11509f72146c0..12521c94333fb 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@skip_magic_trailing_comma.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@skip_magic_trailing_comma.py.snap @@ -51,7 +51,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -109,7 +109,7 @@ magic-trailing-comma = Ignore docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -146,6 +146,3 @@ x2 = lambda y,: 1 with a: # magic trailing comma ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__ann_assign.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__ann_assign.py.snap index 05c361381644a..eb4b02773c10f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__ann_assign.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__ann_assign.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/ann_assign.py +snapshot_kind: text --- ## Input ```python @@ -65,6 +66,3 @@ class DefaultRunner: DefaultTaskRunner ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__assert.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__assert.py.snap index 2bc958df25c17..8f4bf41d65d73 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__assert.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__assert.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assert.py +snapshot_kind: text --- ## Input ```python @@ -211,50 +212,47 @@ assert ( def test(): - assert ( - { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - == expected - ), "Not what we expected and the message is too long to fit ineeeeee one line" + assert { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + } == expected, ( + "Not what we expected and the message is too long to fit ineeeeee one line" + ) - assert ( - { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - == expected - ), "Not what we expected and the message is too long to fit in one lineeeee" + assert { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + } == expected, ( + "Not what we expected and the message is too long to fit in one lineeeee" + ) - assert ( - { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - == expected - ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeee" + assert { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + } == expected, ( + "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeee" + ) assert ( { @@ -284,7 +282,9 @@ def test(): key9: value9, } == expectedeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee - ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeee" + ), ( + "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeee" + ) assert expected == { key1: value1, @@ -298,20 +298,19 @@ def test(): key9: value9, }, "Not what we expected and the message is too long to fit ineeeeee one line" - assert ( - expected - == { - key1: value1, - key2: value2, - key3: value3, - key4: value4, - key5: value5, - key6: value6, - key7: value7, - key8: value8, - key9: value9, - } - ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeeeeee" + assert expected == { + key1: value1, + key2: value2, + key3: value3, + key4: value4, + key5: value5, + key6: value6, + key7: value7, + key8: value8, + key9: value9, + }, ( + "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeeeeee" + ) assert ( expectedeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee @@ -341,7 +340,9 @@ def test(): key8: value8, key9: value9, } - ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeee" + ), ( + "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeee" + ) # Test for https://github.com/astral-sh/ruff/issues/7246 @@ -360,156 +361,3 @@ assert package.files == [ }, ] ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -30,50 +30,47 @@ - - - def test(): -- assert ( -- { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } -- == expected -- ), "Not what we expected and the message is too long to fit ineeeeee one line" -+ assert { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ } == expected, ( -+ "Not what we expected and the message is too long to fit ineeeeee one line" -+ ) - -- assert ( -- { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } -- == expected -- ), "Not what we expected and the message is too long to fit in one lineeeee" -+ assert { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ } == expected, ( -+ "Not what we expected and the message is too long to fit in one lineeeee" -+ ) - -- assert ( -- { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } -- == expected -- ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeee" -+ assert { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ } == expected, ( -+ "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeee" -+ ) - - assert ( - { -@@ -103,7 +100,9 @@ - key9: value9, - } - == expectedeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee -- ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeee" -+ ), ( -+ "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeee" -+ ) - - assert expected == { - key1: value1, -@@ -117,20 +116,19 @@ - key9: value9, - }, "Not what we expected and the message is too long to fit ineeeeee one line" - -- assert ( -- expected -- == { -- key1: value1, -- key2: value2, -- key3: value3, -- key4: value4, -- key5: value5, -- key6: value6, -- key7: value7, -- key8: value8, -- key9: value9, -- } -- ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeeeeee" -+ assert expected == { -+ key1: value1, -+ key2: value2, -+ key3: value3, -+ key4: value4, -+ key5: value5, -+ key6: value6, -+ key7: value7, -+ key8: value8, -+ key9: value9, -+ }, ( -+ "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeeeeeeee" -+ ) - - assert ( - expectedeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee -@@ -160,7 +158,9 @@ - key8: value8, - key9: value9, - } -- ), "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeee" -+ ), ( -+ "Not what we expected and the message is too long to fit in one lineeeeeeeeeeeeeee" -+ ) - - - # Test for https://github.com/astral-sh/ruff/issues/7246 -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__assign.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__assign.py.snap index 832fadbd6b32e..81529c8997d7c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__assign.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__assign.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assign.py +snapshot_kind: text --- ## Input ```python @@ -163,6 +164,3 @@ c = b[dddddd, aaaaaa] = ( # comment ) = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__assignment_split_value_first.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__assignment_split_value_first.py.snap index 0bd2c2c1d141e..126735dac8eef 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__assignment_split_value_first.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__assignment_split_value_first.py.snap @@ -241,22 +241,7 @@ type A[VeryLongTypeNameThatShouldBreakFirstToTheRightBeforeSplitngtinthatExceeds ``` -## Outputs -### Output 1 -``` -indent-style = space -line-width = 88 -indent-width = 4 -quote-style = Double -line-ending = LineFeed -magic-trailing-comma = Respect -docstring-code = Disabled -docstring-code-line-width = "dynamic" -preview = Enabled -target_version = Py38 -source_type = Python -``` - +## Output ```python ####### # Unsplittable target and value diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__aug_assign.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__aug_assign.py.snap index 583b2f7c63d63..404bd305022ac 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__aug_assign.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__aug_assign.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/aug_assign.py +snapshot_kind: text --- ## Input ```python @@ -20,6 +21,3 @@ greeting += ( % len(name) ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__break.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__break.py.snap index f7e6ec7f46b88..9bc6b02966fc6 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__break.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__break.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/break.py +snapshot_kind: text --- ## Input ```python @@ -19,6 +20,3 @@ while True: # block comment break # break comment # post comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__class_definition.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__class_definition.py.snap index db9773291b2c0..2bf875ea663a1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__class_definition.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__class_definition.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/class_definition.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__delete.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__delete.py.snap index 931b4a6da72d1..588f6fe42b544 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__delete.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__delete.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/delete.py +snapshot_kind: text --- ## Input ```python @@ -232,6 +233,3 @@ del ( # dangling end of line comment # dangling own line comment ) # trailing statement comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__ellipsis.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__ellipsis.pyi.snap index 89bab19aef384..b69087e003f66 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__ellipsis.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__ellipsis.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/ellipsis.pyi +snapshot_kind: text --- ## Input ```python @@ -197,6 +198,3 @@ try: ... # comment except: ... # comment finally: ... # comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__for.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__for.py.snap index fbf7fb7e754f2..484a0dee914cf 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__for.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__for.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/for.py +snapshot_kind: text --- ## Input ```python @@ -161,6 +162,3 @@ for ( ) in relations.items(): pass ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__function.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__function.py.snap index 64eaa01b0b974..be06b9daf64d3 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__function.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__function.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/function.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__global.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__global.py.snap index 27743bbf794ad..f963dd53b8ebf 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__global.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__global.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/global.py +snapshot_kind: text --- ## Input ```python @@ -46,6 +47,3 @@ def f(): def f(): global analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model # end-of-line comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__if.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__if.py.snap index 9bc4576203c3f..7becf78515cfd 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__if.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__if.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/if.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__import.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__import.py.snap index 00ab19b271bc6..960d24aa2819d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__import.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__import.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/import.py +snapshot_kind: text --- ## Input ```python @@ -187,6 +188,3 @@ import os # comment x = 1 ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__import_from.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__import_from.py.snap index d650fd8548119..45626f76cd8cf 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__import_from.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__import_from.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/import_from.py +snapshot_kind: text --- ## Input ```python @@ -120,6 +121,3 @@ from a import ( # comment from tqdm.auto import tqdm ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__long_type_annotations.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__long_type_annotations.py.snap index 39bde3ee75bc6..a7fff93b31ca2 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__long_type_annotations.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__long_type_annotations.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/long_type_annotations.py +snapshot_kind: text --- ## Input ```python @@ -347,6 +348,3 @@ nested_comment: None | [ str ] = None ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__match.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__match.py.snap index e12a5cf5a646c..852740fa6dea4 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__match.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__match.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/match.py +snapshot_kind: text --- ## Input ```python @@ -694,7 +695,7 @@ match newlines: case "case comment with newlines" if foo == 2: # second pass - case "one", "newline" if (foo := 1): # third + case "one", "newline" if foo := 1: # third pass case "two newlines": @@ -707,7 +708,9 @@ match newlines: match long_lines: - case "this is a long line for if condition" if aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2: # comment + case "this is a long line for if condition" if ( + aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2 + ): # comment pass case "this is a long line for if condition with parentheses" if ( @@ -718,7 +721,7 @@ match long_lines: case "named expressions aren't special" if foo := 1: pass - case "named expressions aren't that special" if (foo := 1): + case "named expressions aren't that special" if foo := 1: pass case "but with already broken long lines" if ( @@ -726,9 +729,9 @@ match long_lines: ): # another comment pass - case { - "long_long_long_key": str(long_long_long_key) - } if value := "long long long long long long long long long long long value": + case {"long_long_long_key": str(long_long_long_key)} if ( + value := "long long long long long long long long long long long value" + ): pass @@ -823,7 +826,9 @@ match pattern_singleton: # trailing own 2 ): pass - case True: # trailing + case ( + True # trailing + ): pass case False: pass @@ -874,7 +879,9 @@ match foo: 1 ): y = 1 - case 1: # comment + case ( + 1 # comment + ): y = 1 case ( 1 @@ -1132,11 +1139,8 @@ match pattern_match_or: pass case ( - ( - a # trailing - ) - | (b) - ): + a # trailing + ) | (b): pass case a | b | c: @@ -1150,8 +1154,7 @@ match pattern_match_or: pass case ( # end of line - a - | b + a | b # own line ): pass @@ -1283,98 +1286,3 @@ match guard_comments: ): pass ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -69,7 +69,7 @@ - case "case comment with newlines" if foo == 2: # second - pass - -- case "one", "newline" if (foo := 1): # third -+ case "one", "newline" if foo := 1: # third - pass - - case "two newlines": -@@ -82,7 +82,9 @@ - - - match long_lines: -- case "this is a long line for if condition" if aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2: # comment -+ case "this is a long line for if condition" if ( -+ aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2 -+ ): # comment - pass - - case "this is a long line for if condition with parentheses" if ( -@@ -93,7 +95,7 @@ - case "named expressions aren't special" if foo := 1: - pass - -- case "named expressions aren't that special" if (foo := 1): -+ case "named expressions aren't that special" if foo := 1: - pass - - case "but with already broken long lines" if ( -@@ -101,9 +103,9 @@ - ): # another comment - pass - -- case { -- "long_long_long_key": str(long_long_long_key) -- } if value := "long long long long long long long long long long long value": -+ case {"long_long_long_key": str(long_long_long_key)} if ( -+ value := "long long long long long long long long long long long value" -+ ): - pass - - -@@ -198,7 +200,9 @@ - # trailing own 2 - ): - pass -- case True: # trailing -+ case ( -+ True # trailing -+ ): - pass - case False: - pass -@@ -249,7 +253,9 @@ - 1 - ): - y = 1 -- case 1: # comment -+ case ( -+ 1 # comment -+ ): - y = 1 - case ( - 1 -@@ -507,11 +513,8 @@ - pass - - case ( -- ( -- a # trailing -- ) -- | (b) -- ): -+ a # trailing -+ ) | (b): - pass - - case a | b | c: -@@ -525,8 +528,7 @@ - pass - - case ( # end of line -- a -- | b -+ a | b - # own line - ): - pass -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__module_comment.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__module_comment.py.snap index 075458da5ac73..ac5e757c1b1de 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__module_comment.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__module_comment.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/module_comment.py +snapshot_kind: text --- ## Input ```python @@ -14,6 +15,3 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/ ```python # hehehe >:)a ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__nonlocal.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__nonlocal.py.snap index c9fc2a5993a84..cddbf5c2c3b7c 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__nonlocal.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__nonlocal.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/nonlocal.py +snapshot_kind: text --- ## Input ```python @@ -46,6 +47,3 @@ def f(): def f(): nonlocal analyze_featuremap_layer, analyze_featuremapcompression_layer, analyze_latencies_post, analyze_motions_layer, analyze_size_model # end-of-line comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__raise.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__raise.py.snap index 0e5676f0b4c93..ba7b568f51512 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__raise.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__raise.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/raise.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__return.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__return.py.snap index 8ea03f92116a8..01f442e54584f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__return.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__return.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return.py +snapshot_kind: text --- ## Input ```python @@ -119,6 +120,3 @@ def f(): output.getvalue().encode("utf-8----------------"), ) ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_annotation.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_annotation.py.snap index 86f834791af1f..7bf5ec858f3fa 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_annotation.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_annotation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_annotation.py +snapshot_kind: text --- ## Input ```python @@ -335,32 +336,24 @@ def f[aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]( # Breaking return type annotations. Black adds parentheses if the parameters are # empty; otherwise, it leverages the expressions own parentheses if possible. -def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( - Set[ - "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" - ] -): ... +def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ + "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +]: ... -def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( - Set[ - "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" - ] -): ... +def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ + "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +]: ... -def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( - Set[ - "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" - ] -): ... +def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ + "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +]: ... -def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( - Set[ - "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" - ] -): ... +def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ + "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +]: ... def xxxxxxxxxxxxxxxxxxxxxxxxxxxx( @@ -461,11 +454,8 @@ def xxxxxxxxxxxxxxxxxxxxxxxxxxxx( ): ... -def double() -> ( - first_item - and foo.bar.baz().bop( - 1, - ) +def double() -> first_item and foo.bar.baz().bop( + 1, ): return 2 * a @@ -519,69 +509,3 @@ def process_board_action( ) -> Optional[Tuple[str, str]]: pass ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -131,32 +131,24 @@ - - # Breaking return type annotations. Black adds parentheses if the parameters are - # empty; otherwise, it leverages the expressions own parentheses if possible. --def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( -- Set[ -- "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -- ] --): ... -+def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ -+ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -+]: ... - - --def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( -- Set[ -- "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -- ] --): ... -+def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ -+ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -+]: ... - - --def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( -- Set[ -- "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -- ] --): ... -+def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ -+ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -+]: ... - - --def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> ( -- Set[ -- "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -- ] --): ... -+def xxxxxxxxxxxxxxxxxxxxxxxxxxxx() -> Set[ -+ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -+]: ... - - - def xxxxxxxxxxxxxxxxxxxxxxxxxxxx( -@@ -257,11 +249,8 @@ - ): ... - - --def double() -> ( -- first_item -- and foo.bar.baz().bop( -- 1, -- ) -+def double() -> first_item and foo.bar.baz().bop( -+ 1, - ): - return 2 * a - -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_no_parameters.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_no_parameters.py.snap index 01cc4a19ebf42..7c0350306c19a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_no_parameters.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_no_parameters.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_no_parameters.py +snapshot_kind: text --- ## Input ```python @@ -244,11 +245,9 @@ def test_return_union_with_elements_exceeding_length() -> ( ######################################################################################### -def test_return_multiline_string_type_annotation() -> ( - """str +def test_return_multiline_string_type_annotation() -> """str | list[str] -""" -): +""": pass @@ -266,12 +265,12 @@ def test_return_multiline_string_binary_expression_return_type_annotation() -> ( ######################################################################################### -def test_implicit_concatenated_string_return_type() -> "str" "bbbbbbbbbbbbbbbb": +def test_implicit_concatenated_string_return_type() -> "strbbbbbbbbbbbbbbbb": pass def test_overlong_implicit_concatenated_string_return_type() -> ( - "liiiiiiiiiiiisssssst[str]" "bbbbbbbbbbbbbbbb" + "liiiiiiiiiiiisssssst[str]bbbbbbbbbbbbbbbb" ): pass @@ -294,9 +293,9 @@ def no_parameters_subscript_return_type() -> list[str]: # 1. Black tries to keep the list flat by parenthesizing the list as shown below even when the `list` identifier # fits on the header line. IMO, this adds unnecessary parentheses that can be avoided # and supporting it requires extra complexity (best_fitting! layout) -def no_parameters_overlong_subscript_return_type_with_single_element() -> ( - list[xxxxxxxxxxxxxxxxxxxxx] -): +def no_parameters_overlong_subscript_return_type_with_single_element() -> list[ + xxxxxxxxxxxxxxxxxxxxx +]: pass @@ -305,23 +304,18 @@ def no_parameters_overlong_subscript_return_type_with_single_element() -> ( # `list[`. It is also inconsistent with how subscripts are normally formatted where it first tries to fit the entire subscript, # then splits after `list[` but keeps all elements on a single line, and finally, splits after each element. # IMO: Splitting after the `list[` and trying to keep the elements together when possible seems more consistent. -def no_parameters_subscript_return_type_multiple_elements() -> ( - list[ - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, - ] -): +def no_parameters_subscript_return_type_multiple_elements() -> list[ + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +]: pass # Black removes the parentheses even the elements exceed the configured line width. # So does Ruff. -def no_parameters_subscript_return_type_multiple_overlong_elements() -> ( - list[ - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, - ] -): +def no_parameters_subscript_return_type_multiple_overlong_elements() -> list[ + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, +]: pass @@ -340,11 +334,9 @@ def no_parameters_subscriptreturn_type_with_overlong_value_() -> ( # `no_parameters_subscript_return_type_multiple_overlong_elements` shows. However, it doesn't # when the subscript contains a single element. Black then keeps the parentheses. # Ruff removes the parentheses in this case for consistency. -def no_parameters_overlong_subscript_return_type_with_overlong_single_element() -> ( - list[ - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - ] -): +def no_parameters_overlong_subscript_return_type_with_overlong_single_element() -> list[ + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +]: pass @@ -353,13 +345,10 @@ def no_parameters_overlong_subscript_return_type_with_overlong_single_element() ######################################################################################### -def test_binary_expression_return_type_annotation() -> ( - aaaaaaaaaaaaaaaaaaaaaaaaaa - > [ - aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, - bbbbbbbbbbbbbbbbbbbbbbbbb, - ] -): +def test_binary_expression_return_type_annotation() -> aaaaaaaaaaaaaaaaaaaaaaaaaa > [ + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, + bbbbbbbbbbbbbbbbbbbbbbbbb, +]: pass @@ -369,139 +358,9 @@ def test_binary_expression_return_type_annotation() -> ( # Don't paranthesize lists -def f() -> ( - [ - a, - b, - ] -): +def f() -> [ + a, + b, +]: pass ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -58,11 +58,9 @@ - ######################################################################################### - - --def test_return_multiline_string_type_annotation() -> ( -- """str -+def test_return_multiline_string_type_annotation() -> """str - | list[str] --""" --): -+""": - pass - - -@@ -80,12 +78,12 @@ - ######################################################################################### - - --def test_implicit_concatenated_string_return_type() -> "str" "bbbbbbbbbbbbbbbb": -+def test_implicit_concatenated_string_return_type() -> "strbbbbbbbbbbbbbbbb": - pass - - - def test_overlong_implicit_concatenated_string_return_type() -> ( -- "liiiiiiiiiiiisssssst[str]" "bbbbbbbbbbbbbbbb" -+ "liiiiiiiiiiiisssssst[str]bbbbbbbbbbbbbbbb" - ): - pass - -@@ -108,9 +106,9 @@ - # 1. Black tries to keep the list flat by parenthesizing the list as shown below even when the `list` identifier - # fits on the header line. IMO, this adds unnecessary parentheses that can be avoided - # and supporting it requires extra complexity (best_fitting! layout) --def no_parameters_overlong_subscript_return_type_with_single_element() -> ( -- list[xxxxxxxxxxxxxxxxxxxxx] --): -+def no_parameters_overlong_subscript_return_type_with_single_element() -> list[ -+ xxxxxxxxxxxxxxxxxxxxx -+]: - pass - - -@@ -119,23 +117,18 @@ - # `list[`. It is also inconsistent with how subscripts are normally formatted where it first tries to fit the entire subscript, - # then splits after `list[` but keeps all elements on a single line, and finally, splits after each element. - # IMO: Splitting after the `list[` and trying to keep the elements together when possible seems more consistent. --def no_parameters_subscript_return_type_multiple_elements() -> ( -- list[ -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -- ] --): -+def no_parameters_subscript_return_type_multiple_elements() -> list[ -+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -+]: - pass - - - # Black removes the parentheses even the elements exceed the configured line width. - # So does Ruff. --def no_parameters_subscript_return_type_multiple_overlong_elements() -> ( -- list[ -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -- ] --): -+def no_parameters_subscript_return_type_multiple_overlong_elements() -> list[ -+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, -+]: - pass - - -@@ -154,11 +147,9 @@ - # `no_parameters_subscript_return_type_multiple_overlong_elements` shows. However, it doesn't - # when the subscript contains a single element. Black then keeps the parentheses. - # Ruff removes the parentheses in this case for consistency. --def no_parameters_overlong_subscript_return_type_with_overlong_single_element() -> ( -- list[ -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -- ] --): -+def no_parameters_overlong_subscript_return_type_with_overlong_single_element() -> list[ -+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -+]: - pass - - -@@ -167,13 +158,10 @@ - ######################################################################################### - - --def test_binary_expression_return_type_annotation() -> ( -- aaaaaaaaaaaaaaaaaaaaaaaaaa -- > [ -- aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, -- bbbbbbbbbbbbbbbbbbbbbbbbb, -- ] --): -+def test_binary_expression_return_type_annotation() -> aaaaaaaaaaaaaaaaaaaaaaaaaa > [ -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, -+ bbbbbbbbbbbbbbbbbbbbbbbbb, -+]: - pass - - -@@ -183,10 +171,8 @@ - - - # Don't paranthesize lists --def f() -> ( -- [ -- a, -- b, -- ] --): -+def f() -> [ -+ a, -+ b, -+]: - pass -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_parameters.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_parameters.py.snap index 20d605b884317..5f80f70e82d3a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_parameters.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__return_type_parameters.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/return_type_parameters.py +snapshot_kind: text --- ## Input ```python @@ -60,7 +61,7 @@ def test_return_union_with_elements_exceeding_length( ######################################################################################### -# Multiline stirngs (NeedsParentheses::Never) +# Multiline strings (NeedsParentheses::Never) ######################################################################################### @@ -259,7 +260,7 @@ def test_return_union_with_elements_exceeding_length( ######################################################################################### -# Multiline stirngs (NeedsParentheses::Never) +# Multiline strings (NeedsParentheses::Never) ######################################################################################### @@ -287,13 +288,13 @@ def test_return_multiline_string_binary_expression_return_type_annotation( ######################################################################################### -def test_implicit_concatenated_string_return_type(a) -> "str" "bbbbbbbbbbbbbbbb": +def test_implicit_concatenated_string_return_type(a) -> "strbbbbbbbbbbbbbbbb": pass def test_overlong_implicit_concatenated_string_return_type( a, -) -> "liiiiiiiiiiiisssssst[str]" "bbbbbbbbbbbbbbbb": +) -> "liiiiiiiiiiiisssssst[str]bbbbbbbbbbbbbbbb": pass @@ -412,26 +413,3 @@ def test_return_multiline_string_binary_expression_return_type_annotation( ]: pass ``` - - -## Preview changes -```diff ---- Stable -+++ Preview -@@ -82,13 +82,13 @@ - ######################################################################################### - - --def test_implicit_concatenated_string_return_type(a) -> "str" "bbbbbbbbbbbbbbbb": -+def test_implicit_concatenated_string_return_type(a) -> "strbbbbbbbbbbbbbbbb": - pass - - - def test_overlong_implicit_concatenated_string_return_type( - a, --) -> "liiiiiiiiiiiisssssst[str]" "bbbbbbbbbbbbbbbb": -+) -> "liiiiiiiiiiiisssssst[str]bbbbbbbbbbbbbbbb": - pass - - -``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__stub_functions_trailing_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__stub_functions_trailing_comments.py.snap index 39b3ecb94b1a8..9bfe8fe8fd27d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__stub_functions_trailing_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__stub_functions_trailing_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/stub_functions_trailing_comments.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.py.snap index ad0b0871dd379..7eb73c644654d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/top_level.py +snapshot_kind: text --- ## Input ```python @@ -102,6 +103,3 @@ def quux(): def quuz(): """Some docstring.""" ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.pyi.snap index 851369179a4f9..1d6dd85093e32 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__top_level.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/top_level.pyi +snapshot_kind: text --- ## Input ```python @@ -160,6 +161,3 @@ class EllipsisWithLeadingComment: # leading ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__try.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__try.py.snap index fad6dd510e4ca..fc6fcf4406c90 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__try.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__try.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/try.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__type_alias.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__type_alias.py.snap index a62550da9c42e..f406cf6ef189f 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__type_alias.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__type_alias.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/type_alias.py +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__while.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__while.py.snap index bc72ff726039c..6217656ddab79 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__while.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__while.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/while.py +snapshot_kind: text --- ## Input ```python @@ -70,6 +71,3 @@ while ( ): # comment print("Do something") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__with.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__with.py.snap index 53f0860195b1e..bb04ae9560584 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__with.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__with.py.snap @@ -334,6 +334,45 @@ with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb if True: with anyio.CancelScope(shield=True) if get_running_loop() else contextlib.nullcontext() as b: pass + + +# Regression test for https://github.com/astral-sh/ruff/issues/14001 +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( # trailing comment + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( + ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + ) + # Bar +): + pass ``` ## Outputs @@ -348,7 +387,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.8 source_type = Python ``` @@ -404,7 +443,9 @@ with ( with a: # should remove brackets pass -with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as c: +with ( + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +) as c: pass @@ -569,7 +610,9 @@ with ( # outer comment pass # Breaking of with items. -with test as ( # bar # foo +with ( + test # bar +) as ( # foo # test foo ): @@ -581,7 +624,9 @@ with test as ( ): pass -with test as ( # bar # foo # baz +with ( + test # bar +) as ( # foo # baz # test foo ): @@ -634,7 +679,9 @@ with ( ) as b: pass -with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b: +with ( + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +) as b: pass with ( @@ -677,15 +724,19 @@ if True: pass if True: - with anyio.CancelScope( - shield=True - ) if get_running_loop() else contextlib.nullcontext(): + with ( + anyio.CancelScope(shield=True) + if get_running_loop() + else contextlib.nullcontext() + ): pass if True: - with anyio.CancelScope( - shield=True - ) if get_running_loop() else contextlib.nullcontext() as c: + with ( + anyio.CancelScope(shield=True) + if get_running_loop() + else contextlib.nullcontext() + ) as c: pass with Child(aaaaaaaaa, bbbbbbbbbbbbbbb, cccccc), Document( @@ -699,120 +750,60 @@ with open( ): pass -with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb: +with ( + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +): pass -with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b: +with ( + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +) as b: pass if True: - with anyio.CancelScope( - shield=True - ) if get_running_loop() else contextlib.nullcontext() as b: + with ( + anyio.CancelScope(shield=True) + if get_running_loop() + else contextlib.nullcontext() + ) as b: pass -``` -#### Preview changes -```diff ---- Stable -+++ Preview -@@ -49,7 +49,9 @@ - with a: # should remove brackets - pass - --with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as c: -+with ( -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -+) as c: - pass - - -@@ -214,7 +216,9 @@ - pass - - # Breaking of with items. --with test as ( # bar # foo -+with ( -+ test # bar -+) as ( # foo - # test - foo - ): -@@ -226,7 +230,9 @@ - ): - pass - --with test as ( # bar # foo # baz -+with ( -+ test # bar -+) as ( # foo # baz - # test - foo - ): -@@ -279,7 +285,9 @@ - ) as b: - pass - --with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b: -+with ( -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -+) as b: - pass - - with ( -@@ -322,15 +330,19 @@ - pass - - if True: -- with anyio.CancelScope( -- shield=True -- ) if get_running_loop() else contextlib.nullcontext(): -+ with ( -+ anyio.CancelScope(shield=True) -+ if get_running_loop() -+ else contextlib.nullcontext() -+ ): - pass - - if True: -- with anyio.CancelScope( -- shield=True -- ) if get_running_loop() else contextlib.nullcontext() as c: -+ with ( -+ anyio.CancelScope(shield=True) -+ if get_running_loop() -+ else contextlib.nullcontext() -+ ) as c: - pass - - with Child(aaaaaaaaa, bbbbbbbbbbbbbbb, cccccc), Document( -@@ -344,14 +356,20 @@ - ): - pass - --with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb: -+with ( -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -+): - pass - --with aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb as b: -+with ( -+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb -+) as b: - pass - - if True: -- with anyio.CancelScope( -- shield=True -- ) if get_running_loop() else contextlib.nullcontext() as b: -+ with ( -+ anyio.CancelScope(shield=True) -+ if get_running_loop() -+ else contextlib.nullcontext() -+ ) as b: - pass +# Regression test for https://github.com/astral-sh/ruff/issues/14001 +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( # trailing comment + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass ``` @@ -827,7 +818,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py39 +target_version = 3.9 source_type = Python ``` @@ -1237,4 +1228,41 @@ if True: else contextlib.nullcontext() as b ): pass + + +# Regression test for https://github.com/astral-sh/ruff/issues/14001 +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( # trailing comment + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass + + +with ( + open( + "some/path.txt", + "rb", + ) + if True + else open("other/path.txt") + # Bar +): + pass ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@statement__with_39.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@statement__with_39.py.snap index 7dd1f089bbf05..f38e1658a203d 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@statement__with_39.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@statement__with_39.py.snap @@ -110,7 +110,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py39 +target_version = 3.9 source_type = Python ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class.pyi.snap index b1b154f8dc74a..1d7b8c76363ca 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class.pyi.snap @@ -201,7 +201,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py38 +target_version = 3.9 source_type = Stub ``` diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class_eof.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class_eof.pyi.snap index 18410103151b7..55485257f392e 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class_eof.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__blank_line_after_nested_stub_class_eof.pyi.snap @@ -35,7 +35,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Enabled -target_version = Py38 +target_version = 3.9 source_type = Stub ``` @@ -55,6 +55,3 @@ class Top: # comment ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__comments.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__comments.pyi.snap index 299b986fd2058..53d613c936c73 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__comments.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__comments.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/stub_files/comments.pyi +snapshot_kind: text --- ## Input ```python @@ -23,6 +24,3 @@ class SupportsAnext: class SupportsDunderLT: def __init__(self): ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__nesting.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__nesting.pyi.snap index 68fd2614d4fc1..9a7263a2a741a 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__nesting.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__nesting.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/stub_files/nesting.pyi +snapshot_kind: text --- ## Input ```python @@ -70,6 +71,3 @@ if sys.version_info > (3, 7): def f2(self) -> str: ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__suite.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__suite.pyi.snap index 7c2b8c94b05a6..289958372a381 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__suite.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__suite.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/stub_files/suite.pyi +snapshot_kind: text --- ## Input ```python diff --git a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__top_level.pyi.snap b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__top_level.pyi.snap index d34c36b1a387d..563fe96da4e23 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@stub_files__top_level.pyi.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@stub_files__top_level.pyi.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/stub_files/top_level.pyi +snapshot_kind: text --- ## Input ```python @@ -42,6 +43,3 @@ class LockType3: ... @final class LockType4: ... ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@tab_width.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@tab_width.py.snap index 48b59ad92e8bb..ab1caa6805825 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@tab_width.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@tab_width.py.snap @@ -26,7 +26,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -53,7 +53,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -83,7 +83,7 @@ magic-trailing-comma = Respect docstring-code = Disabled docstring-code-line-width = "dynamic" preview = Disabled -target_version = Py38 +target_version = 3.9 source_type = Python ``` @@ -103,6 +103,3 @@ source_type = Python # Fits with tab width 8 (1 + " 012345678901234567890123456789012345678901234567890123456789012345678901") ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@trailing_comments.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@trailing_comments.py.snap index 9dd7fade23961..d3d09022ea7d1 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@trailing_comments.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@trailing_comments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/trailing_comments.py +snapshot_kind: text --- ## Input ```python @@ -75,6 +76,3 @@ i = "" #   type: Add space before two leading NBSP # A noqa as `#\u{A0}\u{A0}noqa` becomes `# \u{A0}noqa` i = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" #  noqa ``` - - - diff --git a/crates/ruff_python_formatter/tests/snapshots/format@trivia.py.snap b/crates/ruff_python_formatter/tests/snapshots/format@trivia.py.snap index 598ee13df18fc..6945bd28ee6c8 100644 --- a/crates/ruff_python_formatter/tests/snapshots/format@trivia.py.snap +++ b/crates/ruff_python_formatter/tests/snapshots/format@trivia.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_formatter/tests/fixtures.rs input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/trivia.py +snapshot_kind: text --- ## Input ```python @@ -75,6 +76,3 @@ while b == 20: e = 50 # one empty line before ``` - - - diff --git a/crates/ruff_python_index/src/indexer.rs b/crates/ruff_python_index/src/indexer.rs index bf1d53c64d9f3..82f913f484949 100644 --- a/crates/ruff_python_index/src/indexer.rs +++ b/crates/ruff_python_index/src/indexer.rs @@ -4,7 +4,7 @@ use ruff_python_ast::Stmt; use ruff_python_parser::{TokenKind, Tokens}; use ruff_python_trivia::{ - has_leading_content, has_trailing_content, is_python_whitespace, CommentRanges, + CommentRanges, has_leading_content, has_trailing_content, is_python_whitespace, }; use ruff_source_file::LineRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; @@ -53,7 +53,7 @@ impl Indexer { continuation_lines.push(line_start); // SAFETY: Safe because of the len assertion at the top of the function. - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] { line_start = prev_end + TextSize::new((index + 1) as u32); } diff --git a/crates/ruff_python_literal/src/cformat.rs b/crates/ruff_python_literal/src/cformat.rs index 30f591a6ddc20..5427e7a854c57 100644 --- a/crates/ruff_python_literal/src/cformat.rs +++ b/crates/ruff_python_literal/src/cformat.rs @@ -89,11 +89,11 @@ impl From<CFormatQuantity> for CFormatPrecision { bitflags! { #[derive(Copy, Clone, Debug, PartialEq)] pub struct CConversionFlags: u32 { - const ALTERNATE_FORM = 0b0000_0001; - const ZERO_PAD = 0b0000_0010; - const LEFT_ADJUST = 0b0000_0100; - const BLANK_SIGN = 0b0000_1000; - const SIGN_CHAR = 0b0001_0000; + const ALTERNATE_FORM = 1 << 0; + const ZERO_PAD = 1 << 1; + const LEFT_ADJUST = 1 << 2; + const BLANK_SIGN = 1 << 3; + const SIGN_CHAR = 1 << 4; } } @@ -241,7 +241,7 @@ where Ok((format_type, c)) } -#[allow(clippy::cast_possible_wrap)] +#[expect(clippy::cast_possible_wrap)] fn parse_quantity<T, I>(iter: &mut ParseIter<I>) -> Result<Option<CFormatQuantity>, ParsingError> where T: Into<char> + Copy, diff --git a/crates/ruff_python_literal/src/escape.rs b/crates/ruff_python_literal/src/escape.rs index 8aaab507c376c..0d9d8577abc0b 100644 --- a/crates/ruff_python_literal/src/escape.rs +++ b/crates/ruff_python_literal/src/escape.rs @@ -1,4 +1,7 @@ -use ruff_python_ast::str::Quote; +use ruff_python_ast::{ + BytesLiteralFlags, StringFlags, StringLiteralFlags, + str::{Quote, TripleQuotes}, +}; pub struct EscapeLayout { pub quote: Quote, @@ -60,23 +63,32 @@ impl<'a> UnicodeEscape<'a> { Self::with_preferred_quote(source, Quote::Single) } #[inline] - pub fn str_repr<'r>(&'a self) -> StrRepr<'r, 'a> { - StrRepr(self) + pub fn str_repr<'r>(&'a self, triple_quotes: TripleQuotes) -> StrRepr<'r, 'a> { + StrRepr { + escape: self, + triple_quotes, + } } } -pub struct StrRepr<'r, 'a>(&'r UnicodeEscape<'a>); +pub struct StrRepr<'r, 'a> { + escape: &'r UnicodeEscape<'a>, + triple_quotes: TripleQuotes, +} impl StrRepr<'_, '_> { pub fn write(&self, formatter: &mut impl std::fmt::Write) -> std::fmt::Result { - let quote = self.0.layout().quote.as_char(); - formatter.write_char(quote)?; - self.0.write_body(formatter)?; - formatter.write_char(quote) + let flags = StringLiteralFlags::empty() + .with_quote_style(self.escape.layout().quote) + .with_triple_quotes(self.triple_quotes); + formatter.write_str(flags.quote_str())?; + self.escape.write_body(formatter)?; + formatter.write_str(flags.quote_str())?; + Ok(()) } pub fn to_string(&self) -> Option<String> { - let mut s = String::with_capacity(self.0.layout().len?); + let mut s = String::with_capacity(self.escape.layout().len?); self.write(&mut s).unwrap(); Some(s) } @@ -91,11 +103,7 @@ impl std::fmt::Display for StrRepr<'_, '_> { impl UnicodeEscape<'_> { const REPR_RESERVED_LEN: usize = 2; // for quotes - #[allow( - clippy::cast_possible_wrap, - clippy::cast_possible_truncation, - clippy::cast_sign_loss - )] + #[expect(clippy::cast_possible_wrap, clippy::cast_sign_loss)] pub fn repr_layout(source: &str, preferred_quote: Quote) -> EscapeLayout { Self::output_layout_with_checker(source, preferred_quote, |a, b| { Some((a as isize).checked_add(b as isize)? as usize) @@ -202,7 +210,7 @@ impl UnicodeEscape<'_> { } } -impl<'a> Escape for UnicodeEscape<'a> { +impl Escape for UnicodeEscape<'_> { fn source_len(&self) -> usize { self.source.len() } @@ -244,17 +252,16 @@ impl<'a> AsciiEscape<'a> { Self::with_preferred_quote(source, Quote::Single) } #[inline] - pub fn bytes_repr<'r>(&'a self) -> BytesRepr<'r, 'a> { - BytesRepr(self) + pub fn bytes_repr<'r>(&'a self, triple_quotes: TripleQuotes) -> BytesRepr<'r, 'a> { + BytesRepr { + escape: self, + triple_quotes, + } } } impl AsciiEscape<'_> { - #[allow( - clippy::cast_possible_wrap, - clippy::cast_possible_truncation, - clippy::cast_sign_loss - )] + #[expect(clippy::cast_possible_wrap, clippy::cast_sign_loss)] pub fn repr_layout(source: &[u8], preferred_quote: Quote) -> EscapeLayout { Self::output_layout_with_checker(source, preferred_quote, 3, |a, b| { Some((a as isize).checked_add(b as isize)? as usize) @@ -337,7 +344,7 @@ impl AsciiEscape<'_> { } } -impl<'a> Escape for AsciiEscape<'a> { +impl Escape for AsciiEscape<'_> { fn source_len(&self) -> usize { self.source.len() } @@ -360,19 +367,26 @@ impl<'a> Escape for AsciiEscape<'a> { } } -pub struct BytesRepr<'r, 'a>(&'r AsciiEscape<'a>); +pub struct BytesRepr<'r, 'a> { + escape: &'r AsciiEscape<'a>, + triple_quotes: TripleQuotes, +} impl BytesRepr<'_, '_> { pub fn write(&self, formatter: &mut impl std::fmt::Write) -> std::fmt::Result { - let quote = self.0.layout().quote.as_char(); + let flags = BytesLiteralFlags::empty() + .with_quote_style(self.escape.layout().quote) + .with_triple_quotes(self.triple_quotes); + formatter.write_char('b')?; - formatter.write_char(quote)?; - self.0.write_body(formatter)?; - formatter.write_char(quote) + formatter.write_str(flags.quote_str())?; + self.escape.write_body(formatter)?; + formatter.write_str(flags.quote_str())?; + Ok(()) } pub fn to_string(&self) -> Option<String> { - let mut s = String::with_capacity(self.0.layout().len?); + let mut s = String::with_capacity(self.escape.layout().len?); self.write(&mut s).unwrap(); Some(s) } diff --git a/crates/ruff_python_parser/CONTRIBUTING.md b/crates/ruff_python_parser/CONTRIBUTING.md index 1cb58a9958c88..90209ada782e0 100644 --- a/crates/ruff_python_parser/CONTRIBUTING.md +++ b/crates/ruff_python_parser/CONTRIBUTING.md @@ -58,25 +58,20 @@ cargo test --package ruff_python_parser The Ruff project includes a Python-based fuzzer that can be used to run the parser on randomly generated (but syntactically valid) Python source code files. -To run the fuzzer, first install the required dependencies: +To run the fuzzer, execute the following command +(requires [`uv`](https://github.com/astral-sh/uv) to be installed): ```sh -uv pip install -r scripts/fuzz-parser/requirements.txt +uvx --from ./python/py-fuzzer fuzz ``` -Then, run the fuzzer with the following command: - -```sh -python scripts/fuzz-parser/fuzz.py -``` - -Refer to the [fuzz.py](https://github.com/astral-sh/ruff/blob/main/scripts/fuzz-parser/fuzz.py) +Refer to the [py-fuzzer](https://github.com/astral-sh/ruff/blob/main/python/py-fuzzer/fuzz.py) script for more information or use the `--help` flag to see the available options. #### CI The fuzzer is run as part of the CI pipeline. The purpose of running the fuzzer in the CI is to -catch any regresssions introduced by any new changes to the parser. This is why the fuzzer is run on +catch any regressions introduced by any new changes to the parser. This is why the fuzzer is run on the same set of seeds on every run. ## Benchmarks diff --git a/crates/ruff_python_parser/Cargo.toml b/crates/ruff_python_parser/Cargo.toml index a74a93143e28d..e6e96335bc9e6 100644 --- a/crates/ruff_python_parser/Cargo.toml +++ b/crates/ruff_python_parser/Cargo.toml @@ -28,11 +28,14 @@ unicode_names2 = { workspace = true } unicode-normalization = { workspace = true } [dev-dependencies] +ruff_annotate_snippets = { workspace = true } +ruff_python_ast = { workspace = true, features = ["serde"] } ruff_source_file = { workspace = true } -annotate-snippets = { workspace = true } anyhow = { workspace = true } insta = { workspace = true, features = ["glob"] } +serde = { workspace = true } +serde_json = { workspace = true } walkdir = { workspace = true } [lints] diff --git a/crates/ruff_python_parser/resources/inline/err/args_unparenthesized_generator.py b/crates/ruff_python_parser/resources/inline/err/args_unparenthesized_generator.py index 45f01b2ea20d0..2252aae5db5ba 100644 --- a/crates/ruff_python_parser/resources/inline/err/args_unparenthesized_generator.py +++ b/crates/ruff_python_parser/resources/inline/err/args_unparenthesized_generator.py @@ -1,2 +1,3 @@ sum(x for x in range(10), 5) total(1, 2, x for x in range(5), 6) +sum(x for x in range(10),) diff --git a/crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_value_expr.py b/crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_value_expr.py index c8cf8e64ee749..0ffad964a2a30 100644 --- a/crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_value_expr.py +++ b/crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_value_expr.py @@ -1,5 +1,5 @@ -x = *a and b -x = *yield x -x = *yield from x -x = *lambda x: x +x = (*a and b,) +x = (42, *yield x) +x = (42, *yield from x) +x = (*lambda x: x,) x = x := 1 diff --git a/crates/ruff_python_parser/resources/inline/err/assign_stmt_starred_expr_value.py b/crates/ruff_python_parser/resources/inline/err/assign_stmt_starred_expr_value.py new file mode 100644 index 0000000000000..8b3169540758f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/assign_stmt_starred_expr_value.py @@ -0,0 +1,4 @@ +_ = *[42] +_ = *{42} +_ = *list() +_ = *(p + q) diff --git a/crates/ruff_python_parser/resources/inline/err/class_type_params_py311.py b/crates/ruff_python_parser/resources/inline/err/class_type_params_py311.py new file mode 100644 index 0000000000000..31cf933a6eb3f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/class_type_params_py311.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.11"} +class Foo[S: (str, bytes), T: float, *Ts, **P]: ... +class Foo[]: ... diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_class.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_class.py new file mode 100644 index 0000000000000..e3353576a5bd0 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_class.py @@ -0,0 +1,2 @@ +class __debug__: ... # class name +class C[__debug__]: ... # type parameter name diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_function.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_function.py new file mode 100644 index 0000000000000..5e1da14f26569 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_function.py @@ -0,0 +1,3 @@ +def __debug__(): ... # function name +def f[__debug__](): ... # type parameter name +def f(__debug__): ... # parameter name diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_import.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_import.py new file mode 100644 index 0000000000000..1be1ef9b02da5 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_import.py @@ -0,0 +1,4 @@ +import __debug__ +import debug as __debug__ +from x import __debug__ +from x import debug as __debug__ diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_match.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_match.py new file mode 100644 index 0000000000000..de52d4457749a --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_match.py @@ -0,0 +1,2 @@ +match x: + case __debug__: ... diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_try.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_try.py new file mode 100644 index 0000000000000..ac2b58e2d0809 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_try.py @@ -0,0 +1,2 @@ +try: ... +except Exception as __debug__: ... diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_type_alias.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_type_alias.py new file mode 100644 index 0000000000000..0bc36f332832c --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_type_alias.py @@ -0,0 +1,2 @@ +type __debug__ = list[int] # visited as an Expr but still flagged +type Debug[__debug__] = str diff --git a/crates/ruff_python_parser/resources/inline/err/debug_shadow_with.py b/crates/ruff_python_parser/resources/inline/err/debug_shadow_with.py new file mode 100644 index 0000000000000..5b872fc3ce4f2 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/debug_shadow_with.py @@ -0,0 +1 @@ +with open("foo.txt") as __debug__: ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_await_expression_py38.py b/crates/ruff_python_parser/resources/inline/err/decorator_await_expression_py38.py new file mode 100644 index 0000000000000..a84e92d8dff3e --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_await_expression_py38.py @@ -0,0 +1,4 @@ +# parse_options: { "target-version": "3.8" } +async def foo(): + @await bar + def baz(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_dict_literal_py38.py b/crates/ruff_python_parser/resources/inline/err/decorator_dict_literal_py38.py new file mode 100644 index 0000000000000..ab802e9754b5f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_dict_literal_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@{3: 3} +def bar(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_expression_py38.py b/crates/ruff_python_parser/resources/inline/err/decorator_expression_py38.py new file mode 100644 index 0000000000000..9889848e9fa96 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_expression_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@buttons[0].clicked.connect +def spam(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_float_literal_py38.py b/crates/ruff_python_parser/resources/inline/err/decorator_float_literal_py38.py new file mode 100644 index 0000000000000..64f444d6eb564 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_float_literal_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@3.14 +def bar(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_named_expression_py37.py b/crates/ruff_python_parser/resources/inline/err/decorator_named_expression_py37.py new file mode 100644 index 0000000000000..cff401f921fdf --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_named_expression_py37.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.7" } +@(x := lambda x: x)(foo) +def bar(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/decorator_non_toplevel_call_expression_py38.py b/crates/ruff_python_parser/resources/inline/err/decorator_non_toplevel_call_expression_py38.py new file mode 100644 index 0000000000000..16ecd93239002 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/decorator_non_toplevel_call_expression_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@foo().bar() +def baz(): ... diff --git a/crates/ruff_python_parser/resources/inline/err/del_debug_py39.py b/crates/ruff_python_parser/resources/inline/err/del_debug_py39.py new file mode 100644 index 0000000000000..52c876401d05a --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/del_debug_py39.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.9"} +del __debug__ diff --git a/crates/ruff_python_parser/resources/inline/err/duplicate_match_class_attr.py b/crates/ruff_python_parser/resources/inline/err/duplicate_match_class_attr.py new file mode 100644 index 0000000000000..3721777993278 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/duplicate_match_class_attr.py @@ -0,0 +1,6 @@ +match x: + case Class(x=1, x=2): ... + case [Class(x=1, x=2)]: ... + case {"x": x, "y": Foo(x=1, x=2)}: ... + case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... + case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... diff --git a/crates/ruff_python_parser/resources/inline/err/duplicate_match_key.py b/crates/ruff_python_parser/resources/inline/err/duplicate_match_key.py new file mode 100644 index 0000000000000..f6e4b8a7f0870 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/duplicate_match_key.py @@ -0,0 +1,22 @@ +match x: + case {"x": 1, "x": 2}: ... + case {b"x": 1, b"x": 2}: ... + case {0: 1, 0: 2}: ... + case {1.0: 1, 1.0: 2}: ... + case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... + case {True: 1, True: 2}: ... + case {None: 1, None: 2}: ... + case { + """x + y + z + """: 1, + """x + y + z + """: 2}: ... + case {"x": 1, "x": 2, "x": 3}: ... + case {0: 1, "x": 1, 0: 2, "x": 2}: ... + case [{"x": 1, "x": 2}]: ... + case Foo(x=1, y={"x": 1, "x": 2}): ... + case [Foo(x=1), Foo(x=1, y={"x": 1, "x": 2})]: ... diff --git a/crates/ruff_python_parser/resources/inline/err/duplicate_type_parameter_names.py b/crates/ruff_python_parser/resources/inline/err/duplicate_type_parameter_names.py new file mode 100644 index 0000000000000..938111c120cf6 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/duplicate_type_parameter_names.py @@ -0,0 +1,7 @@ +type Alias[T, T] = ... +def f[T, T](t: T): ... +class C[T, T]: ... +type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... +def f[T, T, T](): ... # two errors +def f[T, *T](): ... # star is still duplicate +def f[T, **T](): ... # as is double star diff --git a/crates/ruff_python_parser/resources/inline/err/except_star_py310.py b/crates/ruff_python_parser/resources/inline/err/except_star_py310.py new file mode 100644 index 0000000000000..b681632543b94 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/except_star_py310.py @@ -0,0 +1,5 @@ +# parse_options: {"target-version": "3.10"} +try: ... +except* ValueError: ... +except* KeyError: ... +except * Error: ... diff --git a/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple.py b/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple.py deleted file mode 100644 index e1ca280b7692b..0000000000000 --- a/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple.py +++ /dev/null @@ -1,12 +0,0 @@ -try: - pass -except x, y: - pass -except x, y as exc: - pass -try: - pass -except* x, y: - pass -except* x, y as eg: - pass diff --git a/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_as.py b/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_as.py new file mode 100644 index 0000000000000..4e2122b1d5463 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_as.py @@ -0,0 +1,8 @@ +try: + pass +except x, y as exc: + pass +try: + pass +except* x, y as eg: + pass diff --git a/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_no_as_py313.py b/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_no_as_py313.py new file mode 100644 index 0000000000000..11da8cf313f01 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_no_as_py313.py @@ -0,0 +1,9 @@ +# parse_options: {"target-version": "3.13"} +try: + pass +except x, y: + pass +try: + pass +except* x, y: + pass diff --git a/crates/ruff_python_parser/resources/inline/err/for_iter_unpack_py38.py b/crates/ruff_python_parser/resources/inline/err/for_iter_unpack_py38.py new file mode 100644 index 0000000000000..ef95a49cb55ea --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/for_iter_unpack_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +for x in *a, b: ... +for x in a, *b: ... +for x in *a, *b: ... diff --git a/crates/ruff_python_parser/resources/inline/err/function_type_params_py311.py b/crates/ruff_python_parser/resources/inline/err/function_type_params_py311.py new file mode 100644 index 0000000000000..2d9604058c46b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/function_type_params_py311.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.11"} +def foo[T](): ... +def foo[](): ... diff --git a/crates/ruff_python_parser/resources/inline/err/invalid_annotation_class.py b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_class.py new file mode 100644 index 0000000000000..9e484e34a4dba --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_class.py @@ -0,0 +1,7 @@ +class F[T](y := list): ... +class I[T]((yield 1)): ... +class J[T]((yield from 1)): ... +class K[T: (yield 1)]: ... # yield in TypeVar +class L[T: (x := 1)]: ... # named expr in TypeVar +class M[T]((await 1)): ... +class N[T: (await 1)]: ... diff --git a/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function.py b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function.py new file mode 100644 index 0000000000000..91f354ef5c49a --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function.py @@ -0,0 +1,20 @@ +def d[T]() -> (await 1): ... +def e[T](arg: (await 1)): ... +def f[T]() -> (y := 3): ... +def g[T](arg: (x := 1)): ... +def h[T](x: (yield 1)): ... +def j[T]() -> (yield 1): ... +def l[T](x: (yield from 1)): ... +def n[T]() -> (yield from 1): ... +def p[T: (yield 1)](): ... # yield in TypeVar bound +def q[T = (yield 1)](): ... # yield in TypeVar default +def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default +def s[**Ts = (yield 1)](): ... # yield in ParamSpec default +def t[T: (x := 1)](): ... # named expr in TypeVar bound +def u[T = (x := 1)](): ... # named expr in TypeVar default +def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default +def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default +def t[T: (await 1)](): ... # await in TypeVar bound +def u[T = (await 1)](): ... # await in TypeVar default +def v[*Ts = (await 1)](): ... # await in TypeVarTuple default +def w[**Ts = (await 1)](): ... # await in ParamSpec default diff --git a/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function_py314.py b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function_py314.py new file mode 100644 index 0000000000000..4a0193b17395d --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_function_py314.py @@ -0,0 +1,11 @@ +# parse_options: {"target-version": "3.14"} +def f() -> (y := 3): ... +def g(arg: (x := 1)): ... +def outer(): + def i(x: (yield 1)): ... + def k() -> (yield 1): ... + def m(x: (yield from 1)): ... + def o() -> (yield from 1): ... +async def outer(): + def f() -> (await 1): ... + def g(arg: (await 1)): ... diff --git a/crates/ruff_python_parser/resources/inline/err/invalid_annotation_py314.py b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_py314.py new file mode 100644 index 0000000000000..ae647575d734f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_py314.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.14"} +a: (x := 1) +def outer(): + b: (yield 1) + c: (yield from 1) +async def outer(): + d: (await 1) diff --git a/crates/ruff_python_parser/resources/inline/err/invalid_annotation_type_alias.py b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_type_alias.py new file mode 100644 index 0000000000000..1ce79ce4de118 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/invalid_annotation_type_alias.py @@ -0,0 +1,8 @@ +type X[T: (yield 1)] = int # TypeVar bound +type X[T = (yield 1)] = int # TypeVar default +type X[*Ts = (yield 1)] = int # TypeVarTuple default +type X[**Ts = (yield 1)] = int # ParamSpec default +type Y = (yield 1) # yield in value +type Y = (x := 1) # named expr in value +type Y[T: (await 1)] = int # await in bound +type Y = (await 1) # await in value diff --git a/crates/ruff_python_parser/resources/inline/err/irrefutable_case_pattern.py b/crates/ruff_python_parser/resources/inline/err/irrefutable_case_pattern.py new file mode 100644 index 0000000000000..0af2d7e14b623 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/irrefutable_case_pattern.py @@ -0,0 +1,12 @@ +match x: + case var: ... # capture pattern + case 2: ... +match x: + case _: ... + case 2: ... # wildcard pattern +match x: + case var1 as var2: ... # as pattern with irrefutable left-hand side + case 2: ... +match x: + case enum.variant | var: ... # or pattern with irrefutable part + case 2: ... diff --git a/crates/ruff_python_parser/resources/inline/err/iter_unpack_return_py37.py b/crates/ruff_python_parser/resources/inline/err/iter_unpack_return_py37.py new file mode 100644 index 0000000000000..5e382adf1f2b3 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/iter_unpack_return_py37.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.7"} +rest = (4, 5, 6) +def f(): return 1, 2, 3, *rest diff --git a/crates/ruff_python_parser/resources/inline/err/iter_unpack_yield_py37.py b/crates/ruff_python_parser/resources/inline/err/iter_unpack_yield_py37.py new file mode 100644 index 0000000000000..974c9d81e06d9 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/iter_unpack_yield_py37.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.7"} +rest = (4, 5, 6) +def g(): yield 1, 2, 3, *rest +def h(): yield 1, (yield 2, *rest), 3 diff --git a/crates/ruff_python_parser/resources/inline/err/match_before_py310.py b/crates/ruff_python_parser/resources/inline/err/match_before_py310.py new file mode 100644 index 0000000000000..7cf41cdeced6c --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/match_before_py310.py @@ -0,0 +1,4 @@ +# parse_options: { "target-version": "3.9" } +match 2: + case 1: + pass diff --git a/crates/ruff_python_parser/resources/inline/err/multiple_assignment_in_case_pattern.py b/crates/ruff_python_parser/resources/inline/err/multiple_assignment_in_case_pattern.py new file mode 100644 index 0000000000000..b5e00fba2ec61 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/multiple_assignment_in_case_pattern.py @@ -0,0 +1,10 @@ +match 2: + case [y, z, y]: ... # MatchSequence + case [y, z, *y]: ... # MatchSequence + case [y, y, y]: ... # MatchSequence multiple + case {1: x, 2: x}: ... # MatchMapping duplicate pattern + case {1: x, **x}: ... # MatchMapping duplicate in **rest + case Class(x, x): ... # MatchClass positional + case Class(y=x, z=x): ... # MatchClass keyword + case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr + case x as x: ... # MatchAs diff --git a/crates/ruff_python_parser/resources/inline/err/named_expr_slice.py b/crates/ruff_python_parser/resources/inline/err/named_expr_slice.py new file mode 100644 index 0000000000000..c0afba07f6487 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/named_expr_slice.py @@ -0,0 +1,4 @@ +# even after 3.9, an unparenthesized named expression is not allowed in a slice +lst[x:=1:-1] +lst[1:x:=1] +lst[1:3:x:=1] diff --git a/crates/ruff_python_parser/resources/inline/err/named_expr_slice_parse_error.py b/crates/ruff_python_parser/resources/inline/err/named_expr_slice_parse_error.py new file mode 100644 index 0000000000000..275c6a18d1a78 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/named_expr_slice_parse_error.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.8"} +# before 3.9, only emit the parse error, not the unsupported syntax error +lst[x:=1:-1] diff --git a/crates/ruff_python_parser/resources/inline/err/nested_async_comprehension_py310.py b/crates/ruff_python_parser/resources/inline/err/nested_async_comprehension_py310.py new file mode 100644 index 0000000000000..132dfa3c7d4f8 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/nested_async_comprehension_py310.py @@ -0,0 +1,6 @@ +# parse_options: {"target-version": "3.10"} +async def f(): return [[x async for x in foo(n)] for n in range(3)] # list +async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict +async def h(): return [{x async for x in foo(n)} for n in range(3)] # set +async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] +async def j(): return [([y for y in range(1)], [z async for z in range(2)]) for x in range(5)] diff --git a/crates/ruff_python_parser/resources/inline/err/nonlocal_declaration_at_module_level.py b/crates/ruff_python_parser/resources/inline/err/nonlocal_declaration_at_module_level.py new file mode 100644 index 0000000000000..b7ed1ba1b0b9e --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/nonlocal_declaration_at_module_level.py @@ -0,0 +1,2 @@ +nonlocal x +nonlocal x, y diff --git a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_empty.py b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_empty.py index 07127b5f052d5..f6f2b5577aca3 100644 --- a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_empty.py +++ b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_empty.py @@ -1 +1,2 @@ -nonlocal +def _(): + nonlocal diff --git a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_expression.py b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_expression.py index 303cb88b61d23..46854180075b6 100644 --- a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_expression.py +++ b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_expression.py @@ -1 +1,2 @@ -nonlocal x + 1 +def _(): + nonlocal x + 1 diff --git a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_trailing_comma.py b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_trailing_comma.py index 24acf55245280..d0742c873124d 100644 --- a/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_trailing_comma.py +++ b/crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_trailing_comma.py @@ -1,3 +1,4 @@ -nonlocal , -nonlocal x, -nonlocal x, y, +def _(): + nonlocal , + nonlocal x, + nonlocal x, y, diff --git a/crates/ruff_python_parser/resources/inline/err/param_with_star_annotation_py310.py b/crates/ruff_python_parser/resources/inline/err/param_with_star_annotation_py310.py new file mode 100644 index 0000000000000..39cf903ce69d9 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/param_with_star_annotation_py310.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.10"} +def foo(*args: *Ts): ... diff --git a/crates/ruff_python_parser/resources/inline/err/parenthesized_context_manager_py38.py b/crates/ruff_python_parser/resources/inline/err/parenthesized_context_manager_py38.py new file mode 100644 index 0000000000000..81065e49b14a4 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/parenthesized_context_manager_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +with (foo as x, bar as y): ... +with (foo, bar as y): ... +with (foo as x, bar): ... diff --git a/crates/ruff_python_parser/resources/inline/err/parenthesized_kwarg_py38.py b/crates/ruff_python_parser/resources/inline/err/parenthesized_kwarg_py38.py new file mode 100644 index 0000000000000..bb74eb0b7b15b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/parenthesized_kwarg_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +f((a)=1) +f((a) = 1) +f( ( a ) = 1) diff --git a/crates/ruff_python_parser/resources/inline/err/pep701_f_string_py311.py b/crates/ruff_python_parser/resources/inline/err/pep701_f_string_py311.py new file mode 100644 index 0000000000000..91d8d8a6c4383 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/pep701_f_string_py311.py @@ -0,0 +1,12 @@ +# parse_options: {"target-version": "3.11"} +f'Magic wand: { bag['wand'] }' # nested quotes +f"{'\n'.join(a)}" # escape sequence +f'''A complex trick: { + bag['bag'] # comment +}''' +f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting +f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +f"test {a \ + } more" # line continuation +f"""{f"""{x}"""}""" # mark the whole triple quote +f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors diff --git a/crates/ruff_python_parser/resources/inline/err/pos_only_py37.py b/crates/ruff_python_parser/resources/inline/err/pos_only_py37.py new file mode 100644 index 0000000000000..cd47c569acda1 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/pos_only_py37.py @@ -0,0 +1,5 @@ +# parse_options: {"target-version": "3.7"} +def foo(a, /): ... +def foo(a, /, b, /): ... +def foo(a, *args, /, b): ... +def foo(a, //): ... diff --git a/crates/ruff_python_parser/resources/inline/err/raise_stmt_from_without_exc.py b/crates/ruff_python_parser/resources/inline/err/raise_stmt_from_without_exc.py new file mode 100644 index 0000000000000..eb306042c2bcc --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/raise_stmt_from_without_exc.py @@ -0,0 +1,2 @@ +raise from exc +raise from None diff --git a/crates/ruff_python_parser/resources/inline/err/rebound_comprehension_variable.py b/crates/ruff_python_parser/resources/inline/err/rebound_comprehension_variable.py new file mode 100644 index 0000000000000..6717c22333db5 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/rebound_comprehension_variable.py @@ -0,0 +1,9 @@ +[(a := 0) for a in range(0)] +{(a := 0) for a in range(0)} +{(a := 0): val for a in range(0)} +{key: (a := 0) for a in range(0)} +((a := 0) for a in range(0)) +[[(a := 0)] for a in range(0)] +[(a := 0) for b in range (0) for a in range(0)] +[(a := 0) for a in range (0) for b in range(0)] +[((a := 0), (b := 1)) for a in range (0) for b in range(0)] diff --git a/crates/ruff_python_parser/resources/inline/err/single_star_for.py b/crates/ruff_python_parser/resources/inline/err/single_star_for.py new file mode 100644 index 0000000000000..4258906ca6375 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/single_star_for.py @@ -0,0 +1,2 @@ +for _ in *x: ... +for *x in xs: ... diff --git a/crates/ruff_python_parser/resources/inline/err/single_star_return.py b/crates/ruff_python_parser/resources/inline/err/single_star_return.py new file mode 100644 index 0000000000000..0b66f7c1d1fad --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/single_star_return.py @@ -0,0 +1 @@ +def f(): return *x diff --git a/crates/ruff_python_parser/resources/inline/err/single_star_yield.py b/crates/ruff_python_parser/resources/inline/err/single_star_yield.py new file mode 100644 index 0000000000000..f4f4eb0159e06 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/single_star_yield.py @@ -0,0 +1 @@ +def f(): yield *x diff --git a/crates/ruff_python_parser/resources/inline/err/single_starred_assignment_target.py b/crates/ruff_python_parser/resources/inline/err/single_starred_assignment_target.py new file mode 100644 index 0000000000000..703c2fef96a9f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/single_starred_assignment_target.py @@ -0,0 +1 @@ +*a = (1,) diff --git a/crates/ruff_python_parser/resources/inline/err/star_index_py310.py b/crates/ruff_python_parser/resources/inline/err/star_index_py310.py new file mode 100644 index 0000000000000..df2725db746f6 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/star_index_py310.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.10"} +lst[*index] # simple index +class Array(Generic[DType, *Shape]): ... # motivating example from the PEP +lst[a, *b, c] # different positions +lst[a, b, *c] # different positions +lst[*a, *b] # multiple unpacks +array[3:5, *idxs] # mixed with slices diff --git a/crates/ruff_python_parser/resources/inline/err/star_slices.py b/crates/ruff_python_parser/resources/inline/err/star_slices.py new file mode 100644 index 0000000000000..67c7a354f1530 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/star_slices.py @@ -0,0 +1 @@ +array[*start:*end] diff --git a/crates/ruff_python_parser/resources/inline/err/try_stmt_mixed_except_kind.py b/crates/ruff_python_parser/resources/inline/err/try_stmt_mixed_except_kind.py new file mode 100644 index 0000000000000..e9be12b340af1 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/try_stmt_mixed_except_kind.py @@ -0,0 +1,22 @@ +try: + pass +except: + pass +except* ExceptionGroup: + pass +try: + pass +except* ExceptionGroup: + pass +except: + pass +try: + pass +except: + pass +except: + pass +except* ExceptionGroup: + pass +except* ExceptionGroup: + pass diff --git a/crates/ruff_python_parser/resources/inline/err/tuple_context_manager_py38.py b/crates/ruff_python_parser/resources/inline/err/tuple_context_manager_py38.py new file mode 100644 index 0000000000000..bdc0639602820 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/tuple_context_manager_py38.py @@ -0,0 +1,13 @@ +# parse_options: {"target-version": "3.8"} +# these cases are _syntactically_ valid before Python 3.9 because the `with` item +# is parsed as a tuple, but this will always cause a runtime error, so we flag it +# anyway +with (foo, bar): ... +with ( + open('foo.txt')) as foo: ... +with ( + foo, + bar, + baz, +): ... +with (foo,): ... diff --git a/crates/ruff_python_parser/resources/inline/err/type_param_default_py312.py b/crates/ruff_python_parser/resources/inline/err/type_param_default_py312.py new file mode 100644 index 0000000000000..c30f9943299f7 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/type_param_default_py312.py @@ -0,0 +1,5 @@ +# parse_options: {"target-version": "3.12"} +type X[T = int] = int +def f[T = int](): ... +class C[T = int](): ... +class D[S, T = int, U = uint](): ... diff --git a/crates/ruff_python_parser/resources/inline/err/type_stmt_py311.py b/crates/ruff_python_parser/resources/inline/err/type_stmt_py311.py new file mode 100644 index 0000000000000..37a11f089913b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/type_stmt_py311.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.11"} +type x = int diff --git a/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_index_py38.py b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_index_py38.py new file mode 100644 index 0000000000000..6ea69e2ba2671 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_index_py38.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.8"} +lst[x:=1] diff --git a/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_comp_py38.py b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_comp_py38.py new file mode 100644 index 0000000000000..b18e0db1c0b87 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_comp_py38.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.8"} +{last := x for x in range(3)} diff --git a/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_literal_py38.py b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_literal_py38.py new file mode 100644 index 0000000000000..373ed6210fa5d --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_literal_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +{x := 1, 2, 3} +{1, x := 2, 3} +{1, 2, x := 3} diff --git a/crates/ruff_python_parser/resources/inline/err/walrus_py37.py b/crates/ruff_python_parser/resources/inline/err/walrus_py37.py new file mode 100644 index 0000000000000..a577f344bd8f9 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/walrus_py37.py @@ -0,0 +1,2 @@ +# parse_options: { "target-version": "3.7" } +(x := 1) diff --git a/crates/ruff_python_parser/resources/inline/err/write_to_debug_expr.py b/crates/ruff_python_parser/resources/inline/err/write_to_debug_expr.py new file mode 100644 index 0000000000000..e312f7bd3ef63 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/err/write_to_debug_expr.py @@ -0,0 +1,4 @@ +del __debug__ +del x, y, __debug__, z +__debug__ = 1 +x, y, __debug__, z = 1, 2, 3, 4 diff --git a/crates/ruff_python_parser/resources/inline/ok/all_async_comprehension_py310.py b/crates/ruff_python_parser/resources/inline/ok/all_async_comprehension_py310.py new file mode 100644 index 0000000000000..36b12b7562857 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/all_async_comprehension_py310.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.10"} +async def test(): return [[x async for x in elements(n)] async for n in range(3)] diff --git a/crates/ruff_python_parser/resources/inline/ok/args_unparenthesized_generator.py b/crates/ruff_python_parser/resources/inline/ok/args_unparenthesized_generator.py index ecadabd4e33f1..a42c0867fb283 100644 --- a/crates/ruff_python_parser/resources/inline/ok/args_unparenthesized_generator.py +++ b/crates/ruff_python_parser/resources/inline/ok/args_unparenthesized_generator.py @@ -1 +1,3 @@ +zip((x for x in range(10)), (y for y in range(10))) sum(x for x in range(10)) +sum((x for x in range(10)),) diff --git a/crates/ruff_python_parser/resources/inline/ok/assign_stmt_starred_expr_value.py b/crates/ruff_python_parser/resources/inline/ok/assign_stmt_starred_expr_value.py new file mode 100644 index 0000000000000..2e8a1919b07b6 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/assign_stmt_starred_expr_value.py @@ -0,0 +1,4 @@ +_ = 4 +_ = [4] +_ = (*[1],) +_ = *[1], diff --git a/crates/ruff_python_parser/resources/inline/ok/class_keyword_in_case_pattern.py b/crates/ruff_python_parser/resources/inline/ok/class_keyword_in_case_pattern.py new file mode 100644 index 0000000000000..2852450d5847d --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/class_keyword_in_case_pattern.py @@ -0,0 +1,2 @@ +match 2: + case Class(x=x): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/class_type_params_py312.py b/crates/ruff_python_parser/resources/inline/ok/class_type_params_py312.py new file mode 100644 index 0000000000000..c167ad6d56e0e --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/class_type_params_py312.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.12"} +class Foo[S: (str, bytes), T: float, *Ts, **P]: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/debug_rename_import.py b/crates/ruff_python_parser/resources/inline/ok/debug_rename_import.py new file mode 100644 index 0000000000000..3dc3ca5fee089 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/debug_rename_import.py @@ -0,0 +1,3 @@ +import __debug__ as debug +from __debug__ import Some +from x import __debug__ as debug diff --git a/crates/ruff_python_parser/resources/inline/ok/decorator_await_expression_py39.py b/crates/ruff_python_parser/resources/inline/ok/decorator_await_expression_py39.py new file mode 100644 index 0000000000000..dcd8ed69b17c5 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/decorator_await_expression_py39.py @@ -0,0 +1,4 @@ +# parse_options: { "target-version": "3.9" } +async def foo(): + @await bar + def baz(): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/decorator_expression_dotted_ident_py38.py b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_dotted_ident_py38.py new file mode 100644 index 0000000000000..dc6bad99a7e8d --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_dotted_ident_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@buttons.clicked.connect +def spam(): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/decorator_expression_eval_hack_py38.py b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_eval_hack_py38.py new file mode 100644 index 0000000000000..2cfeed264057d --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_eval_hack_py38.py @@ -0,0 +1,3 @@ +# parse_options: { "target-version": "3.8" } +@eval("buttons[0].clicked.connect") +def spam(): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/decorator_expression_identity_hack_py38.py b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_identity_hack_py38.py new file mode 100644 index 0000000000000..704c3156e92c3 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_identity_hack_py38.py @@ -0,0 +1,4 @@ +# parse_options: { "target-version": "3.8" } +def _(x): return x +@_(buttons[0].clicked.connect) +def spam(): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/decorator_expression_py39.py b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_py39.py new file mode 100644 index 0000000000000..f4c93cf9413fa --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/decorator_expression_py39.py @@ -0,0 +1,5 @@ +# parse_options: { "target-version": "3.9" } +@buttons[0].clicked.connect +def spam(): ... +@(x := lambda x: x)(foo) +def bar(): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/del_debug_py38.py b/crates/ruff_python_parser/resources/inline/ok/del_debug_py38.py new file mode 100644 index 0000000000000..da9223e997e43 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/del_debug_py38.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.8"} +del __debug__ diff --git a/crates/ruff_python_parser/resources/inline/ok/duplicate_match_key_attr.py b/crates/ruff_python_parser/resources/inline/ok/duplicate_match_key_attr.py new file mode 100644 index 0000000000000..fab6ed6c06807 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/duplicate_match_key_attr.py @@ -0,0 +1,2 @@ +match x: + case {x.a: 1, x.a: 2}: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/except_star_py311.py b/crates/ruff_python_parser/resources/inline/ok/except_star_py311.py new file mode 100644 index 0000000000000..2aafd897f3f86 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/except_star_py311.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.11"} +try: ... +except* ValueError: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/except_stmt_unparenthesized_tuple_no_as_py314.py b/crates/ruff_python_parser/resources/inline/ok/except_stmt_unparenthesized_tuple_no_as_py314.py new file mode 100644 index 0000000000000..6d646a7de5397 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/except_stmt_unparenthesized_tuple_no_as_py314.py @@ -0,0 +1,9 @@ +# parse_options: {"target-version": "3.14"} +try: + pass +except x, y: + pass +try: + pass +except* x, y: + pass diff --git a/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py38.py b/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py38.py new file mode 100644 index 0000000000000..88b3af5c4817e --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +for x in (*a, b): ... +for x in ( a, *b): ... +for x in (*a, *b): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py39.py b/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py39.py new file mode 100644 index 0000000000000..1ce6a6b12feee --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py39.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.9"} +for x in *a, b: ... +for x in a, *b: ... +for x in *a, *b: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/function_def_valid_return_expr.py b/crates/ruff_python_parser/resources/inline/ok/function_def_valid_return_expr.py index 7fb5dadfebea8..603e510a34e95 100644 --- a/crates/ruff_python_parser/resources/inline/ok/function_def_valid_return_expr.py +++ b/crates/ruff_python_parser/resources/inline/ok/function_def_valid_return_expr.py @@ -1,4 +1,3 @@ def foo() -> int | str: ... def foo() -> lambda x: x: ... -def foo() -> (yield x): ... def foo() -> int if True else str: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/function_type_params_py312.py b/crates/ruff_python_parser/resources/inline/ok/function_type_params_py312.py new file mode 100644 index 0000000000000..32f36b0be02c5 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/function_type_params_py312.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.12"} +def foo[T](): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/irrefutable_case_pattern_at_end.py b/crates/ruff_python_parser/resources/inline/ok/irrefutable_case_pattern_at_end.py new file mode 100644 index 0000000000000..6c7be2cf48bcb --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/irrefutable_case_pattern_at_end.py @@ -0,0 +1,9 @@ +match x: + case 2: ... + case var: ... +match x: + case 2: ... + case _: ... +match x: + case var if True: ... # don't try to refute a guarded pattern + case 2: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py37.py b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py37.py new file mode 100644 index 0000000000000..b12330e2d1c2f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py37.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.7"} +rest = (4, 5, 6) +def f(): return (1, 2, 3, *rest) diff --git a/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py38.py b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py38.py new file mode 100644 index 0000000000000..7ed1afde8844b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py38.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.8"} +rest = (4, 5, 6) +def f(): return 1, 2, 3, *rest diff --git a/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py37.py b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py37.py new file mode 100644 index 0000000000000..3595931df9a8b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py37.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.7"} +rest = (4, 5, 6) +def g(): yield (1, 2, 3, *rest) diff --git a/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py38.py b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py38.py new file mode 100644 index 0000000000000..f108ca2e66a99 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py38.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.8"} +rest = (4, 5, 6) +def g(): yield 1, 2, 3, *rest +def h(): yield 1, (yield 2, *rest), 3 diff --git a/crates/ruff_python_parser/resources/inline/ok/match_after_py310.py b/crates/ruff_python_parser/resources/inline/ok/match_after_py310.py new file mode 100644 index 0000000000000..3c6690f1ae214 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/match_after_py310.py @@ -0,0 +1,4 @@ +# parse_options: { "target-version": "3.10" } +match 2: + case 1: + pass diff --git a/crates/ruff_python_parser/resources/inline/ok/match_as_pattern.py b/crates/ruff_python_parser/resources/inline/ok/match_as_pattern.py index 378ec61b9928d..4a5e11c63bccd 100644 --- a/crates/ruff_python_parser/resources/inline/ok/match_as_pattern.py +++ b/crates/ruff_python_parser/resources/inline/ok/match_as_pattern.py @@ -1,3 +1,4 @@ match foo: case foo_bar: ... +match foo: case _: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/match_as_pattern_soft_keyword.py b/crates/ruff_python_parser/resources/inline/ok/match_as_pattern_soft_keyword.py index c434aa5c8171d..cc99b1421e503 100644 --- a/crates/ruff_python_parser/resources/inline/ok/match_as_pattern_soft_keyword.py +++ b/crates/ruff_python_parser/resources/inline/ok/match_as_pattern_soft_keyword.py @@ -1,4 +1,6 @@ match foo: case case: ... +match foo: case match: ... +match foo: case type: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/match_sequence_pattern_terminator.py b/crates/ruff_python_parser/resources/inline/ok/match_sequence_pattern_terminator.py index 8ee7b74d737c6..a5439d5bd96d7 100644 --- a/crates/ruff_python_parser/resources/inline/ok/match_sequence_pattern_terminator.py +++ b/crates/ruff_python_parser/resources/inline/ok/match_sequence_pattern_terminator.py @@ -1,5 +1,5 @@ match subject: - case a: ... case a if x: ... case a, b: ... case a, b if x: ... + case a: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/multiple_assignment_in_case_pattern.py b/crates/ruff_python_parser/resources/inline/ok/multiple_assignment_in_case_pattern.py new file mode 100644 index 0000000000000..05b1908b246d6 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/multiple_assignment_in_case_pattern.py @@ -0,0 +1,2 @@ +match 2: + case Class(x) | [x] | x: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py310.py b/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py310.py new file mode 100644 index 0000000000000..9d4441be94adb --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py310.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.10"} +async def f(): + [_ for n in range(3)] + [_ async for n in range(3)] +async def f(): + def g(): ... + [_ async for n in range(3)] diff --git a/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py311.py b/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py311.py new file mode 100644 index 0000000000000..b591eda48aa34 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py311.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.11"} +async def f(): return [[x async for x in foo(n)] for n in range(3)] # list +async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict +async def h(): return [{x async for x in foo(n)} for n in range(3)] # set diff --git a/crates/ruff_python_parser/resources/inline/ok/non_duplicate_type_parameter_names.py b/crates/ruff_python_parser/resources/inline/ok/non_duplicate_type_parameter_names.py new file mode 100644 index 0000000000000..e27b6d417caf0 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/non_duplicate_type_parameter_names.py @@ -0,0 +1,5 @@ +type Alias[T] = list[T] +def f[T](t: T): ... +class C[T]: ... +class C[T, U, V]: ... +type Alias[T, U: str, V: (str, bytes), *Ts, **P, D = default] = ... diff --git a/crates/ruff_python_parser/resources/inline/ok/non_rebound_comprehension_variable.py b/crates/ruff_python_parser/resources/inline/ok/non_rebound_comprehension_variable.py new file mode 100644 index 0000000000000..a8300b13df286 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/non_rebound_comprehension_variable.py @@ -0,0 +1 @@ +[a := 0 for x in range(0)] diff --git a/crates/ruff_python_parser/resources/inline/ok/nonlocal_declaration_at_module_level.py b/crates/ruff_python_parser/resources/inline/ok/nonlocal_declaration_at_module_level.py new file mode 100644 index 0000000000000..8f51257d0e03b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/nonlocal_declaration_at_module_level.py @@ -0,0 +1,2 @@ +def _(): + nonlocal x diff --git a/crates/ruff_python_parser/resources/inline/ok/nonlocal_stmt.py b/crates/ruff_python_parser/resources/inline/ok/nonlocal_stmt.py index 7f652bb0a69f1..81caa434cb26f 100644 --- a/crates/ruff_python_parser/resources/inline/ok/nonlocal_stmt.py +++ b/crates/ruff_python_parser/resources/inline/ok/nonlocal_stmt.py @@ -1,2 +1,3 @@ -nonlocal x -nonlocal x, y, z +def _(): + nonlocal x + nonlocal x, y, z diff --git a/crates/ruff_python_parser/resources/inline/ok/param_with_annotation.py b/crates/ruff_python_parser/resources/inline/ok/param_with_annotation.py index 404be13e781aa..e109ecaebc34f 100644 --- a/crates/ruff_python_parser/resources/inline/ok/param_with_annotation.py +++ b/crates/ruff_python_parser/resources/inline/ok/param_with_annotation.py @@ -1,4 +1,3 @@ def foo(arg: int): ... def foo(arg: lambda x: x): ... -def foo(arg: (yield x)): ... def foo(arg: (x := int)): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py310.py b/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py310.py new file mode 100644 index 0000000000000..0f754ea1acedf --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py310.py @@ -0,0 +1,9 @@ +# parse_options: {"target-version": "3.10"} +# regression tests for https://github.com/astral-sh/ruff/issues/16874 +# starred parameters are fine, just not the annotation +from typing import Annotated, Literal +def foo(*args: Ts): ... +def foo(*x: Literal["this should allow arbitrary strings"]): ... +def foo(*x: Annotated[str, "this should allow arbitrary strings"]): ... +def foo(*args: str, **kwds: int): ... +def union(*x: A | B): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py311.py b/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py311.py new file mode 100644 index 0000000000000..4ba49a293a87b --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py311.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.11"} +def foo(*args: *Ts): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/parenthesized_context_manager_py39.py b/crates/ruff_python_parser/resources/inline/ok/parenthesized_context_manager_py39.py new file mode 100644 index 0000000000000..9a0e6466d8c56 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/parenthesized_context_manager_py39.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.9"} +with (foo as x, bar as y): ... +with (foo, bar as y): ... +with (foo as x, bar): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/parenthesized_kwarg_py37.py b/crates/ruff_python_parser/resources/inline/ok/parenthesized_kwarg_py37.py new file mode 100644 index 0000000000000..6b3d964f7832e --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/parenthesized_kwarg_py37.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.7"} +f((a)=1) diff --git a/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_index_py38.py b/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_index_py38.py new file mode 100644 index 0000000000000..2d4b3d8fcd947 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_index_py38.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.8"} +lst[(x:=1)] diff --git a/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_py38.py b/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_py38.py new file mode 100644 index 0000000000000..ff189e99415f5 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_py38.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.8"} +{(x := 1), 2, 3} +{(last := x) for x in range(3)} diff --git a/crates/ruff_python_parser/resources/inline/ok/parenthesized_star_index_py310.py b/crates/ruff_python_parser/resources/inline/ok/parenthesized_star_index_py310.py new file mode 100644 index 0000000000000..9b31dd927468c --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/parenthesized_star_index_py310.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.10"} +out[(*(slice(None) for _ in range(2)), *ind)] = 1 diff --git a/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py311.py b/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py311.py new file mode 100644 index 0000000000000..40c0958df6b68 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py311.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.11"} +f"outer {'# not a comment'}" +f'outer {x:{"# not a comment"} }' +f"""{f'''{f'{"# not a comment"}'}'''}""" +f"""{f'''# before expression {f'# aro{f"#{1+1}#"}und #'}'''} # after expression""" +f"escape outside of \t {expr}\n" +f"test\"abcd" diff --git a/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py312.py b/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py312.py new file mode 100644 index 0000000000000..8a8b7a469dc76 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py312.py @@ -0,0 +1,10 @@ +# parse_options: {"target-version": "3.12"} +f'Magic wand: { bag['wand'] }' # nested quotes +f"{'\n'.join(a)}" # escape sequence +f'''A complex trick: { + bag['bag'] # comment +}''' +f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting +f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +f"test {a \ + } more" # line continuation diff --git a/crates/ruff_python_parser/resources/inline/ok/pos_only_py38.py b/crates/ruff_python_parser/resources/inline/ok/pos_only_py38.py new file mode 100644 index 0000000000000..fb4afdb425a6f --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/pos_only_py38.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.8"} +def foo(a, /): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/read_from_debug.py b/crates/ruff_python_parser/resources/inline/ok/read_from_debug.py new file mode 100644 index 0000000000000..f8681e74f0110 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/read_from_debug.py @@ -0,0 +1,2 @@ +if __debug__: ... +x = __debug__ diff --git a/crates/ruff_python_parser/resources/inline/ok/single_star_in_tuple.py b/crates/ruff_python_parser/resources/inline/ok/single_star_in_tuple.py new file mode 100644 index 0000000000000..5604a521efd12 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/single_star_in_tuple.py @@ -0,0 +1,4 @@ +def f(): yield (*x,) +def f(): return (*x,) +for _ in (*x,): ... +for (*x,) in xs: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/single_starred_assignment_target.py b/crates/ruff_python_parser/resources/inline/ok/single_starred_assignment_target.py new file mode 100644 index 0000000000000..b0c434ef59d81 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/single_starred_assignment_target.py @@ -0,0 +1,3 @@ +(*a,) = (1,) +*a, = (1,) +[*a] = (1,) diff --git a/crates/ruff_python_parser/resources/inline/ok/star_index_py311.py b/crates/ruff_python_parser/resources/inline/ok/star_index_py311.py new file mode 100644 index 0000000000000..2374c77f61637 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/star_index_py311.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.11"} +lst[*index] # simple index +class Array(Generic[DType, *Shape]): ... # motivating example from the PEP +lst[a, *b, c] # different positions +lst[a, b, *c] # different positions +lst[*a, *b] # multiple unpacks +array[3:5, *idxs] # mixed with slices diff --git a/crates/ruff_python_parser/resources/inline/ok/tuple_context_manager_py38.py b/crates/ruff_python_parser/resources/inline/ok/tuple_context_manager_py38.py new file mode 100644 index 0000000000000..c93d3c7e9a6fa --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/tuple_context_manager_py38.py @@ -0,0 +1,6 @@ +# parse_options: {"target-version": "3.8"} +with ( + foo, + bar, + baz, +) as tup: ... diff --git a/crates/ruff_python_parser/resources/inline/ok/type_param_default_py313.py b/crates/ruff_python_parser/resources/inline/ok/type_param_default_py313.py new file mode 100644 index 0000000000000..d7c174eacaa48 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/type_param_default_py313.py @@ -0,0 +1,4 @@ +# parse_options: {"target-version": "3.13"} +type X[T = int] = int +def f[T = int](): ... +class C[T = int](): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/type_stmt_py312.py b/crates/ruff_python_parser/resources/inline/ok/type_stmt_py312.py new file mode 100644 index 0000000000000..f2e3aee5d7202 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/type_stmt_py312.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.12"} +type x = int diff --git a/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_index_py39.py b/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_index_py39.py new file mode 100644 index 0000000000000..813f1eb15cdf6 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_index_py39.py @@ -0,0 +1,2 @@ +# parse_options: {"target-version": "3.9"} +lst[x:=1] diff --git a/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_py39.py b/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_py39.py new file mode 100644 index 0000000000000..1b1bf189dc770 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_py39.py @@ -0,0 +1,3 @@ +# parse_options: {"target-version": "3.9"} +{x := 1, 2, 3} +{last := x for x in range(3)} diff --git a/crates/ruff_python_parser/resources/inline/ok/valid_annotation_class.py b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_class.py new file mode 100644 index 0000000000000..e8baa9996a380 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_class.py @@ -0,0 +1,6 @@ +class F(y := list): ... +def f(): + class G((yield 1)): ... + class H((yield from 1)): ... +async def f(): + class G((await 1)): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/valid_annotation_function_py313.py b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_function_py313.py new file mode 100644 index 0000000000000..366d224295d33 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_function_py313.py @@ -0,0 +1,11 @@ +# parse_options: {"target-version": "3.13"} +def f() -> (y := 3): ... +def g(arg: (x := 1)): ... +def outer(): + def i(x: (yield 1)): ... + def k() -> (yield 1): ... + def m(x: (yield from 1)): ... + def o() -> (yield from 1): ... +async def outer(): + def f() -> (await 1): ... + def g(arg: (await 1)): ... diff --git a/crates/ruff_python_parser/resources/inline/ok/valid_annotation_py313.py b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_py313.py new file mode 100644 index 0000000000000..63b09790b4590 --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/valid_annotation_py313.py @@ -0,0 +1,7 @@ +# parse_options: {"target-version": "3.13"} +a: (x := 1) +def outer(): + b: (yield 1) + c: (yield from 1) +async def outer(): + d: (await 1) diff --git a/crates/ruff_python_parser/resources/inline/ok/walrus_py38.py b/crates/ruff_python_parser/resources/inline/ok/walrus_py38.py new file mode 100644 index 0000000000000..819b99dec79ac --- /dev/null +++ b/crates/ruff_python_parser/resources/inline/ok/walrus_py38.py @@ -0,0 +1,2 @@ +# parse_options: { "target-version": "3.8" } +(x := 1) diff --git a/crates/ruff_python_parser/resources/invalid/expressions/parenthesized/tuple_starred_expr.py b/crates/ruff_python_parser/resources/invalid/expressions/parenthesized/tuple_starred_expr.py index 1a87159f0aaae..e3998d7ccec05 100644 --- a/crates/ruff_python_parser/resources/invalid/expressions/parenthesized/tuple_starred_expr.py +++ b/crates/ruff_python_parser/resources/invalid/expressions/parenthesized/tuple_starred_expr.py @@ -1,5 +1,5 @@ # For tuple expression, the minimum binding power of star expression is bitwise or. -# Test the first and any other element as the there are two separate calls. +# Test the first and any other element as there are two separate calls. (*x in y, z, *x in y) (*not x, z, *not x) diff --git a/crates/ruff_python_parser/resources/valid/expressions/arguments.py b/crates/ruff_python_parser/resources/valid/expressions/arguments.py index 012db5016c98d..5cd5c0922c2d4 100644 --- a/crates/ruff_python_parser/resources/valid/expressions/arguments.py +++ b/crates/ruff_python_parser/resources/valid/expressions/arguments.py @@ -32,7 +32,7 @@ # Named expression call(x := 1) -call(x := 1 for x in iter) +call(x := 1 for i in iter) # Starred expressions call(*x and y) diff --git a/crates/ruff_python_parser/resources/valid/expressions/yield.py b/crates/ruff_python_parser/resources/valid/expressions/yield.py index 331662a88d2c5..3d790bfadc4e1 100644 --- a/crates/ruff_python_parser/resources/valid/expressions/yield.py +++ b/crates/ruff_python_parser/resources/valid/expressions/yield.py @@ -10,7 +10,5 @@ yield (x, y) yield x == y yield (x := 1) -yield *y yield x, *y yield *x, -yield *x | y diff --git a/crates/ruff_python_parser/resources/valid/statement/assignment.py b/crates/ruff_python_parser/resources/valid/statement/assignment.py index b987f1c3dcd22..7e0b458335020 100644 --- a/crates/ruff_python_parser/resources/valid/statement/assignment.py +++ b/crates/ruff_python_parser/resources/valid/statement/assignment.py @@ -14,8 +14,6 @@ # This last group of tests checks that assignments we expect to be parsed # (including some interesting ones) continue to be parsed successfully. -*foo = 42 - [x, y, z] = [1, 2, 3] (x, y, z) = (1, 2, 3) @@ -39,7 +37,7 @@ foo = 42 -[] = *data -() = *data +[] = (*data,) +() = (*data,) a, b = ab a = b = c \ No newline at end of file diff --git a/crates/ruff_python_parser/resources/valid/statement/for.py b/crates/ruff_python_parser/resources/valid/statement/for.py index fa0c07252e427..b985f30b497aa 100644 --- a/crates/ruff_python_parser/resources/valid/statement/for.py +++ b/crates/ruff_python_parser/resources/valid/statement/for.py @@ -22,19 +22,9 @@ for (a, b) in iter: pass -for target in *x.attr: - pass - for target in [1, 2]: pass -for *target in a, b, c,: - pass -else: - pass - -for target in *x | y: ... -for target in *await x: ... for target in await x: ... for target in lambda x: x: ... for target in x if True else y: ... diff --git a/crates/ruff_python_parser/resources/valid/statement/match.py b/crates/ruff_python_parser/resources/valid/statement/match.py index c230b3734cf51..b7307ea5f6342 100644 --- a/crates/ruff_python_parser/resources/valid/statement/match.py +++ b/crates/ruff_python_parser/resources/valid/statement/match.py @@ -243,18 +243,21 @@ match x: case a: ... +match x: case a as b: ... +match x: case 1 | 2 as two: ... case 1 + 3j as sum: ... case a.b as ab: ... - case _: - ... case _ as x: ... +match x: + case _: + ... # PatternMatchSequence match x: diff --git a/crates/ruff_python_parser/resources/valid/statement/return.py b/crates/ruff_python_parser/resources/valid/statement/return.py index 78d865112a37c..266fae1eae5ae 100644 --- a/crates/ruff_python_parser/resources/valid/statement/return.py +++ b/crates/ruff_python_parser/resources/valid/statement/return.py @@ -1,7 +1,5 @@ return return x -return *x -return *x | y return *x, *y return (x := 1) return None diff --git a/crates/ruff_python_parser/src/error.rs b/crates/ruff_python_parser/src/error.rs index 98efdf52e2e48..2620f67c77ba6 100644 --- a/crates/ruff_python_parser/src/error.rs +++ b/crates/ruff_python_parser/src/error.rs @@ -1,12 +1,13 @@ -use std::fmt; +use std::fmt::{self, Display}; -use ruff_text_size::TextRange; +use ruff_python_ast::PythonVersion; +use ruff_text_size::{Ranged, TextRange}; use crate::TokenKind; /// Represents represent errors that occur during parsing and are /// returned by the `parse_*` functions. -#[derive(Debug, PartialEq, Clone)] +#[derive(Debug, PartialEq, Eq, Clone)] pub struct ParseError { pub error: ParseErrorType, pub location: TextRange, @@ -48,7 +49,7 @@ impl ParseError { } /// Represents the different types of errors that can occur during parsing of an f-string. -#[derive(Debug, Clone, PartialEq)] +#[derive(Debug, Clone, PartialEq, Eq)] pub enum FStringErrorType { /// Expected a right brace after an opened left brace. UnclosedLbrace, @@ -84,7 +85,7 @@ impl std::fmt::Display for FStringErrorType { } /// Represents the different types of errors that can occur during parsing. -#[derive(Debug, PartialEq, Clone)] +#[derive(Debug, PartialEq, Eq, Clone)] pub enum ParseErrorType { /// An unexpected error occurred. OtherError(String), @@ -125,8 +126,6 @@ pub enum ParseErrorType { /// A default value was found for a `*` or `**` parameter. VarParameterWithDefault, - /// A duplicate parameter was found in a function definition or lambda expression. - DuplicateParameter(String), /// A keyword argument was repeated. DuplicateKeywordArgumentError(String), @@ -193,7 +192,7 @@ impl std::fmt::Display for ParseErrorType { ParseErrorType::ExpectedToken { found, expected } => { write!(f, "Expected {expected}, found {found}",) } - ParseErrorType::Lexical(ref lex_error) => write!(f, "{lex_error}"), + ParseErrorType::Lexical(lex_error) => write!(f, "{lex_error}"), ParseErrorType::SimpleStatementsOnSameLine => { f.write_str("Simple statements must be separated by newlines or semicolons") } @@ -284,16 +283,13 @@ impl std::fmt::Display for ParseErrorType { f.write_str("Invalid augmented assignment target") } ParseErrorType::InvalidDeleteTarget => f.write_str("Invalid delete target"), - ParseErrorType::DuplicateParameter(arg_name) => { - write!(f, "Duplicate parameter {arg_name:?}") - } ParseErrorType::DuplicateKeywordArgumentError(arg_name) => { write!(f, "Duplicate keyword argument {arg_name:?}") } ParseErrorType::UnexpectedIpythonEscapeCommand => { f.write_str("IPython escape commands are only allowed in `Mode::Ipython`") } - ParseErrorType::FStringError(ref fstring_error) => { + ParseErrorType::FStringError(fstring_error) => { write!(f, "f-string: {fstring_error}") } ParseErrorType::UnexpectedExpressionToken => { @@ -361,7 +357,7 @@ impl std::fmt::Display for LexicalError { } /// Represents the different types of errors that can occur during lexing. -#[derive(Debug, Clone, PartialEq)] +#[derive(Debug, Clone, PartialEq, Eq)] pub enum LexicalErrorType { // TODO: Can probably be removed, the places it is used seem to be able // to use the `UnicodeError` variant instead. @@ -426,6 +422,599 @@ impl std::fmt::Display for LexicalErrorType { } } +/// Represents a version-related syntax error detected during parsing. +/// +/// An example of a version-related error is the use of a `match` statement before Python 3.10, when +/// it was first introduced. See [`UnsupportedSyntaxErrorKind`] for other kinds of errors. +#[derive(Debug, PartialEq, Clone)] +pub struct UnsupportedSyntaxError { + pub kind: UnsupportedSyntaxErrorKind, + pub range: TextRange, + /// The target [`PythonVersion`] for which this error was detected. + pub target_version: PythonVersion, +} + +impl Ranged for UnsupportedSyntaxError { + fn range(&self) -> TextRange { + self.range + } +} + +/// The type of tuple unpacking for [`UnsupportedSyntaxErrorKind::StarTuple`]. +#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)] +pub enum StarTupleKind { + Return, + Yield, +} + +/// The type of PEP 701 f-string error for [`UnsupportedSyntaxErrorKind::Pep701FString`]. +#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)] +pub enum FStringKind { + Backslash, + Comment, + NestedQuote, +} + +#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)] +pub enum UnparenthesizedNamedExprKind { + SequenceIndex, + SetLiteral, + SetComprehension, +} + +#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)] +pub enum UnsupportedSyntaxErrorKind { + Match, + Walrus, + ExceptStar, + /// Represents the use of an unparenthesized named expression (`:=`) in a set literal, set + /// comprehension, or sequence index before Python 3.10. + /// + /// ## Examples + /// + /// These are allowed on Python 3.10: + /// + /// ```python + /// {x := 1, 2, 3} # set literal + /// {last := x for x in range(3)} # set comprehension + /// lst[x := 1] # sequence index + /// ``` + /// + /// But on Python 3.9 the named expression needs to be parenthesized: + /// + /// ```python + /// {(x := 1), 2, 3} # set literal + /// {(last := x) for x in range(3)} # set comprehension + /// lst[(x := 1)] # sequence index + /// ``` + /// + /// However, unparenthesized named expressions are never allowed in slices: + /// + /// ```python + /// lst[x:=1:-1] # syntax error + /// lst[1:x:=1] # syntax error + /// lst[1:3:x:=1] # syntax error + /// + /// lst[(x:=1):-1] # ok + /// lst[1:(x:=1)] # ok + /// lst[1:3:(x:=1)] # ok + /// ``` + /// + /// ## References + /// + /// - [Python 3.10 Other Language Changes](https://docs.python.org/3/whatsnew/3.10.html#other-language-changes) + UnparenthesizedNamedExpr(UnparenthesizedNamedExprKind), + + /// Represents the use of a parenthesized keyword argument name after Python 3.8. + /// + /// ## Example + /// + /// From [BPO 34641] it sounds like this was only accidentally supported and was removed when + /// noticed. Code like this used to be valid: + /// + /// ```python + /// f((a)=1) + /// ``` + /// + /// After Python 3.8, you have to omit the parentheses around `a`: + /// + /// ```python + /// f(a=1) + /// ``` + /// + /// [BPO 34641]: https://github.com/python/cpython/issues/78822 + ParenthesizedKeywordArgumentName, + + /// Represents the use of unparenthesized tuple unpacking in a `return` statement or `yield` + /// expression before Python 3.8. + /// + /// ## Examples + /// + /// Before Python 3.8, this syntax was allowed: + /// + /// ```python + /// rest = (4, 5, 6) + /// + /// def f(): + /// t = 1, 2, 3, *rest + /// return t + /// + /// def g(): + /// t = 1, 2, 3, *rest + /// yield t + /// ``` + /// + /// But this was not: + /// + /// ```python + /// rest = (4, 5, 6) + /// + /// def f(): + /// return 1, 2, 3, *rest + /// + /// def g(): + /// yield 1, 2, 3, *rest + /// ``` + /// + /// Instead, parentheses were required in the `return` and `yield` cases: + /// + /// ```python + /// rest = (4, 5, 6) + /// + /// def f(): + /// return (1, 2, 3, *rest) + /// + /// def g(): + /// yield (1, 2, 3, *rest) + /// ``` + /// + /// This was reported in [BPO 32117] and updated in Python 3.8 to allow the unparenthesized + /// form. + /// + /// [BPO 32117]: https://github.com/python/cpython/issues/76298 + StarTuple(StarTupleKind), + + /// Represents the use of a "relaxed" [PEP 614] decorator before Python 3.9. + /// + /// ## Examples + /// + /// Prior to Python 3.9, decorators were defined to be [`dotted_name`]s, optionally followed by + /// an argument list. For example: + /// + /// ```python + /// @buttons.clicked.connect + /// def foo(): ... + /// + /// @buttons.clicked.connect(1, 2, 3) + /// def foo(): ... + /// ``` + /// + /// As pointed out in the PEP, this prevented reasonable extensions like subscripts: + /// + /// ```python + /// buttons = [QPushButton(f'Button {i}') for i in range(10)] + /// + /// @buttons[0].clicked.connect + /// def spam(): ... + /// ``` + /// + /// Python 3.9 removed these restrictions and expanded the [decorator grammar] to include any + /// assignment expression and include cases like the example above. + /// + /// [PEP 614]: https://peps.python.org/pep-0614/ + /// [`dotted_name`]: https://docs.python.org/3.8/reference/compound_stmts.html#grammar-token-dotted-name + /// [decorator grammar]: https://docs.python.org/3/reference/compound_stmts.html#grammar-token-python-grammar-decorator + RelaxedDecorator(RelaxedDecoratorError), + + /// Represents the use of a [PEP 570] positional-only parameter before Python 3.8. + /// + /// ## Examples + /// + /// Python 3.8 added the `/` syntax for marking preceding parameters as positional-only: + /// + /// ```python + /// def foo(a, b, /, c): ... + /// ``` + /// + /// This means `a` and `b` in this case can only be provided by position, not by name. In other + /// words, this code results in a `TypeError` at runtime: + /// + /// ```pycon + /// >>> def foo(a, b, /, c): ... + /// ... + /// >>> foo(a=1, b=2, c=3) + /// Traceback (most recent call last): + /// File "<python-input-3>", line 1, in <module> + /// foo(a=1, b=2, c=3) + /// ~~~^^^^^^^^^^^^^^^ + /// TypeError: foo() got some positional-only arguments passed as keyword arguments: 'a, b' + /// ``` + /// + /// [PEP 570]: https://peps.python.org/pep-0570/ + PositionalOnlyParameter, + + /// Represents the use of a [type parameter list] before Python 3.12. + /// + /// ## Examples + /// + /// Before Python 3.12, generic parameters had to be declared separately using a class like + /// [`typing.TypeVar`], which could then be used in a function or class definition: + /// + /// ```python + /// from typing import Generic, TypeVar + /// + /// T = TypeVar("T") + /// + /// def f(t: T): ... + /// class C(Generic[T]): ... + /// ``` + /// + /// [PEP 695], included in Python 3.12, introduced the new type parameter syntax, which allows + /// these to be written more compactly and without a separate type variable: + /// + /// ```python + /// def f[T](t: T): ... + /// class C[T]: ... + /// ``` + /// + /// [type parameter list]: https://docs.python.org/3/reference/compound_stmts.html#type-parameter-lists + /// [PEP 695]: https://peps.python.org/pep-0695/ + /// [`typing.TypeVar`]: https://docs.python.org/3/library/typing.html#typevar + TypeParameterList, + TypeAliasStatement, + TypeParamDefault, + + /// Represents the use of a [PEP 701] f-string before Python 3.12. + /// + /// ## Examples + /// + /// As described in the PEP, each of these cases were invalid before Python 3.12: + /// + /// ```python + /// # nested quotes + /// f'Magic wand: { bag['wand'] }' + /// + /// # escape characters + /// f"{'\n'.join(a)}" + /// + /// # comments + /// f'''A complex trick: { + /// bag['bag'] # recursive bags! + /// }''' + /// + /// # arbitrary nesting + /// f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" + /// ``` + /// + /// These restrictions were lifted in Python 3.12, meaning that all of these examples are now + /// valid. + /// + /// [PEP 701]: https://peps.python.org/pep-0701/ + Pep701FString(FStringKind), + + /// Represents the use of a parenthesized `with` item before Python 3.9. + /// + /// ## Examples + /// + /// As described in [BPO 12782], `with` uses like this were not allowed on Python 3.8: + /// + /// ```python + /// with (open("a_really_long_foo") as foo, + /// open("a_really_long_bar") as bar): + /// pass + /// ``` + /// + /// because parentheses were not allowed within the `with` statement itself (see [this comment] + /// in particular). However, parenthesized expressions were still allowed, including the cases + /// below, so the issue can be pretty subtle and relates specifically to parenthesized items + /// with `as` bindings. + /// + /// ```python + /// with (foo, bar): ... # okay + /// with ( + /// open('foo.txt')) as foo: ... # also okay + /// with ( + /// foo, + /// bar, + /// baz, + /// ): ... # also okay, just a tuple + /// with ( + /// foo, + /// bar, + /// baz, + /// ) as tup: ... # also okay, binding the tuple + /// ``` + /// + /// This restriction was lifted in 3.9 but formally included in the [release notes] for 3.10. + /// + /// [BPO 12782]: https://github.com/python/cpython/issues/56991 + /// [this comment]: https://github.com/python/cpython/issues/56991#issuecomment-1093555141 + /// [release notes]: https://docs.python.org/3/whatsnew/3.10.html#summary-release-highlights + ParenthesizedContextManager, + + /// Represents the use of a [PEP 646] star expression in an index. + /// + /// ## Examples + /// + /// Before Python 3.11, star expressions were not allowed in index/subscript operations (within + /// square brackets). This restriction was lifted in [PEP 646] to allow for star-unpacking of + /// `typing.TypeVarTuple`s, also added in Python 3.11. As such, this is the primary motivating + /// example from the PEP: + /// + /// ```python + /// from typing import TypeVar, TypeVarTuple + /// + /// DType = TypeVar('DType') + /// Shape = TypeVarTuple('Shape') + /// + /// class Array(Generic[DType, *Shape]): ... + /// ``` + /// + /// But it applies to simple indexing as well: + /// + /// ```python + /// vector[*x] + /// array[a, *b] + /// ``` + /// + /// [PEP 646]: https://peps.python.org/pep-0646/#change-1-star-expressions-in-indexes + StarExpressionInIndex, + + /// Represents the use of a [PEP 646] star annotations in a function definition. + /// + /// ## Examples + /// + /// Before Python 3.11, star annotations were not allowed in function definitions. This + /// restriction was lifted in [PEP 646] to allow type annotations for `typing.TypeVarTuple`, + /// also added in Python 3.11: + /// + /// ```python + /// from typing import TypeVarTuple + /// + /// Ts = TypeVarTuple('Ts') + /// + /// def foo(*args: *Ts): ... + /// ``` + /// + /// Unlike [`UnsupportedSyntaxErrorKind::StarExpressionInIndex`], this does not include any + /// other annotation positions: + /// + /// ```python + /// x: *Ts # Syntax error + /// def foo(x: *Ts): ... # Syntax error + /// ``` + /// + /// [PEP 646]: https://peps.python.org/pep-0646/#change-2-args-as-a-typevartuple + StarAnnotation, + + /// Represents the use of tuple unpacking in a `for` statement iterator clause before Python + /// 3.9. + /// + /// ## Examples + /// + /// Like [`UnsupportedSyntaxErrorKind::StarTuple`] in `return` and `yield` statements, prior to + /// Python 3.9, tuple unpacking in the iterator clause of a `for` statement required + /// parentheses: + /// + /// ```python + /// # valid on Python 3.8 and earlier + /// for i in (*a, *b): ... + /// ``` + /// + /// Omitting the parentheses was invalid: + /// + /// ```python + /// for i in *a, *b: ... # SyntaxError + /// ``` + /// + /// This was changed as part of the [PEG parser rewrite] included in Python 3.9 but not + /// documented directly until the [Python 3.11 release]. + /// + /// [PEG parser rewrite]: https://peps.python.org/pep-0617/ + /// [Python 3.11 release]: https://docs.python.org/3/whatsnew/3.11.html#other-language-changes + UnparenthesizedUnpackInFor, + /// Represents the use of multiple exception names in an except clause without an `as` binding, before Python 3.14. + /// + /// ## Examples + /// Before Python 3.14, catching multiple exceptions required + /// parentheses like so: + /// + /// ```python + /// try: + /// ... + /// except (ExceptionA, ExceptionB, ExceptionC): + /// ... + /// ``` + /// + /// Starting with Python 3.14, thanks to [PEP 758], it was permitted + /// to omit the parentheses: + /// + /// ```python + /// try: + /// ... + /// except ExceptionA, ExceptionB, ExceptionC: + /// ... + /// ``` + /// + /// However, parentheses are still required in the presence of an `as`: + /// + /// ```python + /// try: + /// ... + /// except (ExceptionA, ExceptionB, ExceptionC) as e: + /// ... + /// ``` + /// + /// + /// [PEP 758]: https://peps.python.org/pep-0758/ + UnparenthesizedExceptionTypes, +} + +impl Display for UnsupportedSyntaxError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let kind = match self.kind { + UnsupportedSyntaxErrorKind::Match => "Cannot use `match` statement", + UnsupportedSyntaxErrorKind::Walrus => "Cannot use named assignment expression (`:=`)", + UnsupportedSyntaxErrorKind::ExceptStar => "Cannot use `except*`", + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SequenceIndex, + ) => "Cannot use unparenthesized assignment expression in a sequence index", + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SetLiteral, + ) => "Cannot use unparenthesized assignment expression as an element in a set literal", + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SetComprehension, + ) => { + "Cannot use unparenthesized assignment expression as an element in a set comprehension" + } + UnsupportedSyntaxErrorKind::ParenthesizedKeywordArgumentName => { + "Cannot use parenthesized keyword argument name" + } + UnsupportedSyntaxErrorKind::StarTuple(StarTupleKind::Return) => { + "Cannot use iterable unpacking in return statements" + } + UnsupportedSyntaxErrorKind::StarTuple(StarTupleKind::Yield) => { + "Cannot use iterable unpacking in yield expressions" + } + UnsupportedSyntaxErrorKind::RelaxedDecorator(relaxed_decorator_error) => { + return match relaxed_decorator_error { + RelaxedDecoratorError::CallExpression => { + write!( + f, + "Cannot use a call expression in a decorator on Python {} \ + unless it is the top-level expression or it occurs \ + in the argument list of a top-level call expression \ + (relaxed decorator syntax was {changed})", + self.target_version, + changed = self.kind.changed_version(), + ) + } + RelaxedDecoratorError::Other(description) => write!( + f, + "Cannot use {description} outside function call arguments in a decorator on Python {} \ + (syntax was {changed})", + self.target_version, + changed = self.kind.changed_version(), + ), + }; + } + UnsupportedSyntaxErrorKind::PositionalOnlyParameter => { + "Cannot use positional-only parameter separator" + } + UnsupportedSyntaxErrorKind::TypeParameterList => "Cannot use type parameter lists", + UnsupportedSyntaxErrorKind::TypeAliasStatement => "Cannot use `type` alias statement", + UnsupportedSyntaxErrorKind::TypeParamDefault => { + "Cannot set default type for a type parameter" + } + UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::Backslash) => { + "Cannot use an escape sequence (backslash) in f-strings" + } + UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::Comment) => { + "Cannot use comments in f-strings" + } + UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::NestedQuote) => { + "Cannot reuse outer quote character in f-strings" + } + UnsupportedSyntaxErrorKind::ParenthesizedContextManager => { + "Cannot use parentheses within a `with` statement" + } + UnsupportedSyntaxErrorKind::StarExpressionInIndex => { + "Cannot use star expression in index" + } + UnsupportedSyntaxErrorKind::StarAnnotation => "Cannot use star annotation", + UnsupportedSyntaxErrorKind::UnparenthesizedUnpackInFor => { + "Cannot use iterable unpacking in `for` statements" + } + UnsupportedSyntaxErrorKind::UnparenthesizedExceptionTypes => { + "Multiple exception types must be parenthesized" + } + }; + + write!( + f, + "{kind} on Python {} (syntax was {changed})", + self.target_version, + changed = self.kind.changed_version(), + ) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum RelaxedDecoratorError { + CallExpression, + Other(&'static str), +} + +/// Represents the kind of change in Python syntax between versions. +enum Change { + Added(PythonVersion), + Removed(PythonVersion), +} + +impl Display for Change { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Change::Added(version) => write!(f, "added in Python {version}"), + Change::Removed(version) => write!(f, "removed in Python {version}"), + } + } +} + +impl UnsupportedSyntaxErrorKind { + /// Returns the Python version when the syntax associated with this error was changed, and the + /// type of [`Change`] (added or removed). + const fn changed_version(self) -> Change { + match self { + UnsupportedSyntaxErrorKind::Match => Change::Added(PythonVersion::PY310), + UnsupportedSyntaxErrorKind::Walrus => Change::Added(PythonVersion::PY38), + UnsupportedSyntaxErrorKind::ExceptStar => Change::Added(PythonVersion::PY311), + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr(_) => { + Change::Added(PythonVersion::PY39) + } + UnsupportedSyntaxErrorKind::StarTuple(_) => Change::Added(PythonVersion::PY38), + UnsupportedSyntaxErrorKind::RelaxedDecorator { .. } => { + Change::Added(PythonVersion::PY39) + } + UnsupportedSyntaxErrorKind::PositionalOnlyParameter => { + Change::Added(PythonVersion::PY38) + } + UnsupportedSyntaxErrorKind::ParenthesizedKeywordArgumentName => { + Change::Removed(PythonVersion::PY38) + } + UnsupportedSyntaxErrorKind::TypeParameterList => Change::Added(PythonVersion::PY312), + UnsupportedSyntaxErrorKind::TypeAliasStatement => Change::Added(PythonVersion::PY312), + UnsupportedSyntaxErrorKind::TypeParamDefault => Change::Added(PythonVersion::PY313), + UnsupportedSyntaxErrorKind::Pep701FString(_) => Change::Added(PythonVersion::PY312), + UnsupportedSyntaxErrorKind::ParenthesizedContextManager => { + Change::Added(PythonVersion::PY39) + } + UnsupportedSyntaxErrorKind::StarExpressionInIndex => { + Change::Added(PythonVersion::PY311) + } + UnsupportedSyntaxErrorKind::StarAnnotation => Change::Added(PythonVersion::PY311), + UnsupportedSyntaxErrorKind::UnparenthesizedUnpackInFor => { + Change::Added(PythonVersion::PY39) + } + UnsupportedSyntaxErrorKind::UnparenthesizedExceptionTypes => { + Change::Added(PythonVersion::PY314) + } + } + } + + /// Returns whether or not this kind of syntax is unsupported on `target_version`. + pub(crate) fn is_unsupported(self, target_version: PythonVersion) -> bool { + match self.changed_version() { + Change::Added(version) => target_version < version, + Change::Removed(version) => target_version >= version, + } + } + + /// Returns `true` if this kind of syntax is supported on `target_version`. + pub(crate) fn is_supported(self, target_version: PythonVersion) -> bool { + !self.is_unsupported(target_version) + } +} + #[cfg(target_pointer_width = "64")] mod sizes { use crate::error::{LexicalError, LexicalErrorType}; diff --git a/crates/ruff_python_parser/src/lexer.rs b/crates/ruff_python_parser/src/lexer.rs index 4bc4bb43194ac..9e3d47f89007e 100644 --- a/crates/ruff_python_parser/src/lexer.rs +++ b/crates/ruff_python_parser/src/lexer.rs @@ -17,12 +17,12 @@ use ruff_python_ast::{Int, IpyEscapeKind, StringFlags}; use ruff_python_trivia::is_python_whitespace; use ruff_text_size::{TextLen, TextRange, TextSize}; +use crate::Mode; use crate::error::{FStringErrorType, LexicalError, LexicalErrorType}; use crate::lexer::cursor::{Cursor, EOF_CHAR}; use crate::lexer::fstring::{FStringContext, FStrings, FStringsCheckpoint}; use crate::lexer::indentation::{Indentation, Indentations, IndentationsCheckpoint}; use crate::token::{TokenFlags, TokenKind, TokenValue}; -use crate::Mode; mod cursor; mod fstring; @@ -84,15 +84,21 @@ impl<'src> Lexer<'src> { "Lexer only supports files with a size up to 4GB" ); + let (state, nesting) = if mode == Mode::ParenthesizedExpression { + (State::Other, 1) + } else { + (State::AfterNewline, 0) + }; + let mut lexer = Lexer { source, cursor: Cursor::new(source), - state: State::AfterNewline, + state, current_kind: TokenKind::EndOfFile, current_range: TextRange::empty(start_offset), current_value: TokenValue::None, current_flags: TokenFlags::empty(), - nesting: 0, + nesting, indentations: Indentations::default(), pending_indentation: None, mode, @@ -240,17 +246,18 @@ impl<'src> Lexer<'src> { self.cursor.bump(); if self.cursor.eat_char('\r') { self.cursor.eat_char('\n'); - } else if self.cursor.is_eof() { - return Some(self.push_error(LexicalError::new( - LexicalErrorType::Eof, - self.token_range(), - ))); } else if !self.cursor.eat_char('\n') { return Some(self.push_error(LexicalError::new( LexicalErrorType::LineContinuationError, TextRange::at(self.offset() - '\\'.text_len(), '\\'.text_len()), ))); } + if self.cursor.is_eof() { + return Some(self.push_error(LexicalError::new( + LexicalErrorType::Eof, + self.token_range(), + ))); + } indentation = Indentation::root(); } // Form feed @@ -274,7 +281,7 @@ impl<'src> Lexer<'src> { } fn handle_indentation(&mut self, indentation: Indentation) -> Option<TokenKind> { - let token = match self.indentations.current().try_compare(indentation) { + match self.indentations.current().try_compare(indentation) { // Dedent Ok(Ordering::Greater) => { self.pending_indentation = Some(indentation); @@ -284,7 +291,7 @@ impl<'src> Lexer<'src> { LexicalErrorType::IndentationError, self.token_range(), ))); - }; + } // The lexer might've eaten some whitespaces to calculate the `indentation`. For // example: @@ -311,15 +318,11 @@ impl<'src> Lexer<'src> { self.indentations.indent(indentation); Some(TokenKind::Indent) } - Err(_) => { - return Some(self.push_error(LexicalError::new( - LexicalErrorType::IndentationError, - self.token_range(), - ))); - } - }; - - token + Err(_) => Some(self.push_error(LexicalError::new( + LexicalErrorType::IndentationError, + self.token_range(), + ))), + } } fn skip_whitespace(&mut self) -> Result<(), LexicalError> { @@ -335,14 +338,15 @@ impl<'src> Lexer<'src> { self.cursor.bump(); if self.cursor.eat_char('\r') { self.cursor.eat_char('\n'); - } else if self.cursor.is_eof() { - return Err(LexicalError::new(LexicalErrorType::Eof, self.token_range())); } else if !self.cursor.eat_char('\n') { return Err(LexicalError::new( LexicalErrorType::LineContinuationError, TextRange::at(self.offset() - '\\'.text_len(), '\\'.text_len()), )); } + if self.cursor.is_eof() { + return Err(LexicalError::new(LexicalErrorType::Eof, self.token_range())); + } } // Form feed '\x0C' => { @@ -573,7 +577,7 @@ impl<'src> Lexer<'src> { fstring.try_end_format_spec(self.nesting); } TokenKind::NonLogicalNewline - } + }; } '\r' => { self.cursor.eat_char('\n'); @@ -1065,7 +1069,7 @@ impl<'src> Lexer<'src> { if first_digit_or_dot != '.' { number.push(first_digit_or_dot); self.radix_run(&mut number, Radix::Decimal); - }; + } let is_float = if first_digit_or_dot == '.' || self.cursor.eat_char('.') { number.push('.'); @@ -1148,7 +1152,7 @@ impl<'src> Lexer<'src> { return self.push_error(LexicalError::new( LexicalErrorType::OtherError(format!("{err:?}").into_boxed_str()), self.token_range(), - )) + )); } }; self.current_value = TokenValue::Int(value); @@ -1250,7 +1254,7 @@ impl<'src> Lexer<'src> { // `IpyEscapeKind::Magic` and `IpyEscapeKind::Help` because of the initial `%` and `??` // tokens. if question_count > 2 - || value.chars().last().map_or(true, is_python_whitespace) + || value.chars().last().is_none_or(is_python_whitespace) || !matches!(self.cursor.first(), '\n' | '\r' | EOF_CHAR) { // Not a help end escape command, so continue with the lexing. @@ -1309,7 +1313,11 @@ impl<'src> Lexer<'src> { fn consume_end(&mut self) -> TokenKind { // We reached end of file. // First of all, we need all nestings to be finished. - if self.nesting > 0 { + // For Mode::ParenthesizedExpression we start with nesting level 1. + // So we check if we end with that level. + let init_nesting = u32::from(self.mode == Mode::ParenthesizedExpression); + + if self.nesting > init_nesting { // Reset the nesting to avoid going into infinite loop. self.nesting = 0; return self.push_error(LexicalError::new(LexicalErrorType::Eof, self.token_range())); @@ -1447,7 +1455,7 @@ impl<'src> Lexer<'src> { /// Retrieves the current offset of the cursor within the source code. // SAFETY: Lexer doesn't allow files larger than 4GB - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] #[inline] fn offset(&self) -> TextSize { TextSize::new(self.source.len() as u32) - self.cursor.text_len() @@ -1944,8 +1952,7 @@ def f(arg=%timeit a = b): #[test] fn test_numbers() { - let source = - "0x2f 0o12 0b1101 0 123 123_45_67_890 0.2 1e+2 2.1e3 2j 2.2j 000 0x995DC9BBDF1939FA 0x995DC9BBDF1939FA995DC9BBDF1939FA"; + let source = "0x2f 0o12 0b1101 0 123 123_45_67_890 0.2 1e+2 2.1e3 2j 2.2j 000 0x995DC9BBDF1939FA 0x995DC9BBDF1939FA995DC9BBDF1939FA"; assert_snapshot!(lex_source(source)); } @@ -2202,6 +2209,46 @@ if first: assert_snapshot!(triple_quoted_eol(WINDOWS_EOL)); } + fn line_continuation_at_eof_after_newline(eol: &str) -> LexerOutput { + let source = format!(r"\{eol}"); + lex_invalid(&source, Mode::Module) + } + + #[test] + fn test_line_continuation_at_eof_after_newline_unix_eol() { + assert_snapshot!(line_continuation_at_eof_after_newline(UNIX_EOL)); + } + + #[test] + fn test_line_continuation_at_eof_after_newline_mac_eol() { + assert_snapshot!(line_continuation_at_eof_after_newline(MAC_EOL)); + } + + #[test] + fn test_line_continuation_at_eof_after_newline_windows_eol() { + assert_snapshot!(line_continuation_at_eof_after_newline(WINDOWS_EOL)); + } + + fn line_continuation_at_eof(eol: &str) -> LexerOutput { + let source = format!(r"1, \{eol}"); + lex_invalid(&source, Mode::Module) + } + + #[test] + fn test_line_continuation_at_eof_unix_eol() { + assert_snapshot!(line_continuation_at_eof(UNIX_EOL)); + } + + #[test] + fn test_line_continuation_at_eof_mac_eol() { + assert_snapshot!(line_continuation_at_eof(MAC_EOL)); + } + + #[test] + fn test_line_continuation_at_eof_windows_eol() { + assert_snapshot!(line_continuation_at_eof(WINDOWS_EOL)); + } + // This test case is to just make sure that the lexer doesn't go into // infinite loop on invalid input. #[test] diff --git a/crates/ruff_python_parser/src/lexer/cursor.rs b/crates/ruff_python_parser/src/lexer/cursor.rs index d1107f18ef2b1..413d648ca00b2 100644 --- a/crates/ruff_python_parser/src/lexer/cursor.rs +++ b/crates/ruff_python_parser/src/lexer/cursor.rs @@ -62,7 +62,7 @@ impl<'src> Cursor<'src> { /// /// Use [`Cursor::rest`] to get the remaining text. // SAFETY: The `source.text_len` call in `new` would panic if the string length is larger than a `u32`. - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] pub(super) fn text_len(&self) -> TextSize { TextSize::new(self.chars.as_str().len() as u32) } diff --git a/crates/ruff_python_parser/src/lib.rs b/crates/ruff_python_parser/src/lib.rs index df11678118000..eae7ea75ab841 100644 --- a/crates/ruff_python_parser/src/lib.rs +++ b/crates/ruff_python_parser/src/lib.rs @@ -63,22 +63,28 @@ //! [lexical analysis]: https://en.wikipedia.org/wiki/Lexical_analysis //! [parsing]: https://en.wikipedia.org/wiki/Parsing //! [lexer]: crate::lexer - use std::iter::FusedIterator; use std::ops::Deref; -pub use crate::error::{FStringErrorType, LexicalErrorType, ParseError, ParseErrorType}; +pub use crate::error::{ + FStringErrorType, LexicalErrorType, ParseError, ParseErrorType, UnsupportedSyntaxError, + UnsupportedSyntaxErrorKind, +}; +pub use crate::parser::ParseOptions; pub use crate::token::{Token, TokenKind}; use crate::parser::Parser; -use ruff_python_ast::{Expr, Mod, ModExpression, ModModule, PySourceType, Suite}; +use ruff_python_ast::{ + Expr, Mod, ModExpression, ModModule, PySourceType, StringFlags, StringLiteral, Suite, +}; use ruff_python_trivia::CommentRanges; use ruff_text_size::{Ranged, TextRange, TextSize}; mod error; pub mod lexer; mod parser; +pub mod semantic_errors; mod string; mod token; mod token_set; @@ -108,7 +114,7 @@ pub mod typing; /// assert!(module.is_ok()); /// ``` pub fn parse_module(source: &str) -> Result<Parsed<ModModule>, ParseError> { - Parser::new(source, Mode::Module) + Parser::new(source, ParseOptions::from(Mode::Module)) .parse() .try_into_module() .unwrap() @@ -131,7 +137,7 @@ pub fn parse_module(source: &str) -> Result<Parsed<ModModule>, ParseError> { /// assert!(expr.is_ok()); /// ``` pub fn parse_expression(source: &str) -> Result<Parsed<ModExpression>, ParseError> { - Parser::new(source, Mode::Expression) + Parser::new(source, ParseOptions::from(Mode::Expression)) .parse() .try_into_expression() .unwrap() @@ -159,18 +165,81 @@ pub fn parse_expression_range( range: TextRange, ) -> Result<Parsed<ModExpression>, ParseError> { let source = &source[..range.end().to_usize()]; - Parser::new_starts_at(source, Mode::Expression, range.start()) + Parser::new_starts_at(source, range.start(), ParseOptions::from(Mode::Expression)) .parse() .try_into_expression() .unwrap() .into_result() } -/// Parse the given Python source code using the specified [`Mode`]. +/// Parses a Python expression as if it is parenthesized. +/// +/// It behaves similarly to [`parse_expression_range`] but allows what would be valid within parenthesis +/// +/// # Example +/// +/// Parsing an expression that would be valid within parenthesis: +/// +/// ``` +/// use ruff_python_parser::parse_parenthesized_expression_range; +/// # use ruff_text_size::{TextRange, TextSize}; +/// +/// let parsed = parse_parenthesized_expression_range("'''\n int | str'''", TextRange::new(TextSize::new(3), TextSize::new(14))); +/// assert!(parsed.is_ok()); +pub fn parse_parenthesized_expression_range( + source: &str, + range: TextRange, +) -> Result<Parsed<ModExpression>, ParseError> { + let source = &source[..range.end().to_usize()]; + let parsed = Parser::new_starts_at( + source, + range.start(), + ParseOptions::from(Mode::ParenthesizedExpression), + ) + .parse(); + parsed.try_into_expression().unwrap().into_result() +} + +/// Parses a Python expression from a string annotation. +/// +/// # Example +/// +/// Parsing a string annotation: +/// +/// ``` +/// use ruff_python_parser::parse_string_annotation; +/// use ruff_python_ast::{StringLiteral, StringLiteralFlags}; +/// use ruff_text_size::{TextRange, TextSize}; +/// +/// let string = StringLiteral { +/// value: "'''\n int | str'''".to_string().into_boxed_str(), +/// flags: StringLiteralFlags::empty(), +/// range: TextRange::new(TextSize::new(0), TextSize::new(16)), +/// }; +/// let parsed = parse_string_annotation("'''\n int | str'''", &string); +/// assert!(!parsed.is_ok()); +/// ``` +pub fn parse_string_annotation( + source: &str, + string: &StringLiteral, +) -> Result<Parsed<ModExpression>, ParseError> { + let range = string + .range() + .add_start(string.flags.opener_len()) + .sub_end(string.flags.closer_len()); + let source = &source[..range.end().to_usize()]; + if string.flags.is_triple_quoted() { + parse_parenthesized_expression_range(source, range) + } else { + parse_expression_range(source, range) + } +} + +/// Parse the given Python source code using the specified [`ParseOptions`]. /// -/// This function is the most general function to parse Python code. Based on the [`Mode`] supplied, -/// it can be used to parse a single expression, a full Python program, an interactive expression -/// or a Python program containing IPython escape commands. +/// This function is the most general function to parse Python code. Based on the [`Mode`] supplied +/// via the [`ParseOptions`], it can be used to parse a single expression, a full Python program, +/// an interactive expression or a Python program containing IPython escape commands. /// /// # Example /// @@ -178,16 +247,16 @@ pub fn parse_expression_range( /// parsing: /// /// ``` -/// use ruff_python_parser::{Mode, parse}; +/// use ruff_python_parser::{parse, Mode, ParseOptions}; /// -/// let parsed = parse("1 + 2", Mode::Expression); +/// let parsed = parse("1 + 2", ParseOptions::from(Mode::Expression)); /// assert!(parsed.is_ok()); /// ``` /// /// Alternatively, we can parse a full Python program consisting of multiple lines: /// /// ``` -/// use ruff_python_parser::{Mode, parse}; +/// use ruff_python_parser::{parse, Mode, ParseOptions}; /// /// let source = r#" /// class Greeter: @@ -195,39 +264,39 @@ pub fn parse_expression_range( /// def greet(self): /// print("Hello, world!") /// "#; -/// let parsed = parse(source, Mode::Module); +/// let parsed = parse(source, ParseOptions::from(Mode::Module)); /// assert!(parsed.is_ok()); /// ``` /// /// Additionally, we can parse a Python program containing IPython escapes: /// /// ``` -/// use ruff_python_parser::{Mode, parse}; +/// use ruff_python_parser::{parse, Mode, ParseOptions}; /// /// let source = r#" /// %timeit 1 + 2 /// ?str.replace /// !ls /// "#; -/// let parsed = parse(source, Mode::Ipython); +/// let parsed = parse(source, ParseOptions::from(Mode::Ipython)); /// assert!(parsed.is_ok()); /// ``` -pub fn parse(source: &str, mode: Mode) -> Result<Parsed<Mod>, ParseError> { - parse_unchecked(source, mode).into_result() +pub fn parse(source: &str, options: ParseOptions) -> Result<Parsed<Mod>, ParseError> { + parse_unchecked(source, options).into_result() } -/// Parse the given Python source code using the specified [`Mode`]. +/// Parse the given Python source code using the specified [`ParseOptions`]. /// /// This is same as the [`parse`] function except that it doesn't check for any [`ParseError`] /// and returns the [`Parsed`] as is. -pub fn parse_unchecked(source: &str, mode: Mode) -> Parsed<Mod> { - Parser::new(source, mode).parse() +pub fn parse_unchecked(source: &str, options: ParseOptions) -> Parsed<Mod> { + Parser::new(source, options).parse() } /// Parse the given Python source code using the specified [`PySourceType`]. pub fn parse_unchecked_source(source: &str, source_type: PySourceType) -> Parsed<ModModule> { // SAFETY: Safe because `PySourceType` always parses to a `ModModule` - Parser::new(source, source_type.as_mode()) + Parser::new(source, ParseOptions::from(source_type)) .parse() .try_into_module() .unwrap() @@ -239,6 +308,7 @@ pub struct Parsed<T> { syntax: T, tokens: Tokens, errors: Vec<ParseError>, + unsupported_syntax_errors: Vec<UnsupportedSyntaxError>, } impl<T> Parsed<T> { @@ -257,6 +327,11 @@ impl<T> Parsed<T> { &self.errors } + /// Returns a list of version-related syntax errors found during parsing. + pub fn unsupported_syntax_errors(&self) -> &[UnsupportedSyntaxError] { + &self.unsupported_syntax_errors + } + /// Consumes the [`Parsed`] output and returns the contained syntax node. pub fn into_syntax(self) -> T { self.syntax @@ -267,15 +342,47 @@ impl<T> Parsed<T> { self.errors } - /// Returns `true` if the parsed source code is valid i.e., it has no syntax errors. - pub fn is_valid(&self) -> bool { + /// Returns `true` if the parsed source code is valid i.e., it has no [`ParseError`]s. + /// + /// Note that this does not include version-related [`UnsupportedSyntaxError`]s. + /// + /// See [`Parsed::has_no_syntax_errors`] for a version that takes these into account. + pub fn has_valid_syntax(&self) -> bool { self.errors.is_empty() } + /// Returns `true` if the parsed source code is invalid i.e., it has [`ParseError`]s. + /// + /// Note that this does not include version-related [`UnsupportedSyntaxError`]s. + /// + /// See [`Parsed::has_no_syntax_errors`] for a version that takes these into account. + pub fn has_invalid_syntax(&self) -> bool { + !self.has_valid_syntax() + } + + /// Returns `true` if the parsed source code does not contain any [`ParseError`]s *or* + /// [`UnsupportedSyntaxError`]s. + /// + /// See [`Parsed::has_valid_syntax`] for a version specific to [`ParseError`]s. + pub fn has_no_syntax_errors(&self) -> bool { + self.has_valid_syntax() && self.unsupported_syntax_errors.is_empty() + } + + /// Returns `true` if the parsed source code contains any [`ParseError`]s *or* + /// [`UnsupportedSyntaxError`]s. + /// + /// See [`Parsed::has_invalid_syntax`] for a version specific to [`ParseError`]s. + pub fn has_syntax_errors(&self) -> bool { + !self.has_no_syntax_errors() + } + /// Returns the [`Parsed`] output as a [`Result`], returning [`Ok`] if it has no syntax errors, /// or [`Err`] containing the first [`ParseError`] encountered. + /// + /// Note that any [`unsupported_syntax_errors`](Parsed::unsupported_syntax_errors) will not + /// cause [`Err`] to be returned. pub fn as_result(&self) -> Result<&Parsed<T>, &[ParseError]> { - if self.is_valid() { + if self.has_valid_syntax() { Ok(self) } else { Err(&self.errors) @@ -284,8 +391,11 @@ impl<T> Parsed<T> { /// Consumes the [`Parsed`] output and returns a [`Result`] which is [`Ok`] if it has no syntax /// errors, or [`Err`] containing the first [`ParseError`] encountered. + /// + /// Note that any [`unsupported_syntax_errors`](Parsed::unsupported_syntax_errors) will not + /// cause [`Err`] to be returned. pub(crate) fn into_result(self) -> Result<Parsed<T>, ParseError> { - if self.is_valid() { + if self.has_valid_syntax() { Ok(self) } else { Err(self.into_errors().into_iter().next().unwrap()) @@ -307,6 +417,7 @@ impl Parsed<Mod> { syntax: module, tokens: self.tokens, errors: self.errors, + unsupported_syntax_errors: self.unsupported_syntax_errors, }), Mod::Expression(_) => None, } @@ -326,6 +437,7 @@ impl Parsed<Mod> { syntax: expression, tokens: self.tokens, errors: self.errors, + unsupported_syntax_errors: self.unsupported_syntax_errors, }), } } @@ -445,6 +557,86 @@ impl Tokens { } } + /// Searches the token(s) at `offset`. + /// + /// Returns [`TokenAt::Between`] if `offset` points directly inbetween two tokens + /// (the left token ends at `offset` and the right token starts at `offset`). + /// + /// + /// ## Examples + /// + /// [Playground](https://play.ruff.rs/f3ad0a55-5931-4a13-96c7-b2b8bfdc9a2e?secondary=Tokens) + /// + /// ``` + /// # use ruff_python_ast::PySourceType; + /// # use ruff_python_parser::{Token, TokenAt, TokenKind}; + /// # use ruff_text_size::{Ranged, TextSize}; + /// + /// let source = r#" + /// def test(arg): + /// arg.call() + /// if True: + /// pass + /// print("true") + /// "#.trim(); + /// + /// let parsed = ruff_python_parser::parse_unchecked_source(source, PySourceType::Python); + /// let tokens = parsed.tokens(); + /// + /// let collect_tokens = |offset: TextSize| { + /// tokens.at_offset(offset).into_iter().map(|t| (t.kind(), &source[t.range()])).collect::<Vec<_>>() + /// }; + /// + /// assert_eq!(collect_tokens(TextSize::new(4)), vec! [(TokenKind::Name, "test")]); + /// assert_eq!(collect_tokens(TextSize::new(6)), vec! [(TokenKind::Name, "test")]); + /// // between `arg` and `.` + /// assert_eq!(collect_tokens(TextSize::new(22)), vec! [(TokenKind::Name, "arg"), (TokenKind::Dot, ".")]); + /// assert_eq!(collect_tokens(TextSize::new(36)), vec! [(TokenKind::If, "if")]); + /// // Before the dedent token + /// assert_eq!(collect_tokens(TextSize::new(57)), vec! []); + /// ``` + pub fn at_offset(&self, offset: TextSize) -> TokenAt { + match self.binary_search_by_key(&offset, ruff_text_size::Ranged::start) { + // The token at `index` starts exactly at `offset. + // ```python + // object.attribute + // ^ OFFSET + // ``` + Ok(index) => { + let token = self[index]; + // `token` starts exactly at `offset`. Test if the offset is right between + // `token` and the previous token (if there's any) + if let Some(previous) = index.checked_sub(1).map(|idx| self[idx]) { + if previous.end() == offset { + return TokenAt::Between(previous, token); + } + } + + TokenAt::Single(token) + } + + // No token found that starts exactly at the given offset. But it's possible that + // the token starting before `offset` fully encloses `offset` (it's end range ends after `offset`). + // ```python + // object.attribute + // ^ OFFSET + // # or + // if True: + // print("test") + // ^ OFFSET + // ``` + Err(index) => { + if let Some(previous) = index.checked_sub(1).map(|idx| self[idx]) { + if previous.range().contains_inclusive(offset) { + return TokenAt::Single(previous); + } + } + + TokenAt::None + } + } + } + /// Returns a slice of tokens after the given [`TextSize`] offset. /// /// If the given offset is between two tokens, the returned slice will start from the following @@ -497,6 +689,40 @@ impl Deref for Tokens { } } +/// A token that encloses a given offset or ends exactly at it. +#[derive(Debug, Clone)] +pub enum TokenAt { + /// There's no token at the given offset + None, + + /// There's a single token at the given offset. + Single(Token), + + /// The offset falls exactly between two tokens. E.g. `CURSOR` in `call<CURSOR>(arguments)` is + /// positioned exactly between the `call` and `(` tokens. + Between(Token, Token), +} + +impl Iterator for TokenAt { + type Item = Token; + + fn next(&mut self) -> Option<Self::Item> { + match *self { + TokenAt::None => None, + TokenAt::Single(token) => { + *self = TokenAt::None; + Some(token) + } + TokenAt::Between(first, second) => { + *self = TokenAt::Single(second); + Some(first) + } + } + } +} + +impl FusedIterator for TokenAt {} + impl From<&Tokens> for CommentRanges { fn from(tokens: &Tokens) -> Self { let mut ranges = vec![]; @@ -582,6 +808,11 @@ pub enum Mode { /// The code consists of a single expression. Expression, + /// The code consists of a single expression and is parsed as if it is parenthesized. The parentheses themselves aren't required. + /// This allows for having valid multiline expression without the need of parentheses + /// and is specifically useful for parsing string annotations. + ParenthesizedExpression, + /// The code consists of a sequence of statements which can include the /// escape commands that are part of IPython syntax. /// diff --git a/crates/ruff_python_parser/src/parser/expression.rs b/crates/ruff_python_parser/src/parser/expression.rs index 62b42b6c5eefc..3a3d91ce7540b 100644 --- a/crates/ruff_python_parser/src/parser/expression.rs +++ b/crates/ruff_python_parser/src/parser/expression.rs @@ -7,16 +7,19 @@ use rustc_hash::{FxBuildHasher, FxHashSet}; use ruff_python_ast::name::Name; use ruff_python_ast::{ self as ast, BoolOp, CmpOp, ConversionFlag, Expr, ExprContext, FStringElement, FStringElements, - IpyEscapeKind, Number, Operator, UnaryOp, + IpyEscapeKind, Number, Operator, OperatorPrecedence, StringFlags, UnaryOp, }; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use crate::error::{FStringKind, StarTupleKind, UnparenthesizedNamedExprKind}; use crate::parser::progress::ParserProgress; -use crate::parser::{helpers, FunctionKind, Parser}; -use crate::string::{parse_fstring_literal_element, parse_string_literal, StringType}; +use crate::parser::{FunctionKind, Parser, helpers}; +use crate::string::{StringType, parse_fstring_literal_element, parse_string_literal}; use crate::token::{TokenKind, TokenValue}; use crate::token_set::TokenSet; -use crate::{FStringErrorType, Mode, ParseErrorType}; +use crate::{ + FStringErrorType, Mode, ParseErrorType, UnsupportedSyntaxError, UnsupportedSyntaxErrorKind, +}; use super::{FStringElementsKind, Parenthesized, RecoveryContextKind}; @@ -225,7 +228,7 @@ impl<'src> Parser<'src> { /// /// [Python grammar]: https://docs.python.org/3/reference/grammar.html fn parse_simple_expression(&mut self, context: ExpressionContext) -> ParsedExpr { - self.parse_binary_expression_or_higher(OperatorPrecedence::Initial, context) + self.parse_binary_expression_or_higher(OperatorPrecedence::None, context) } /// Parses a binary expression using the [Pratt parsing algorithm]. @@ -357,7 +360,7 @@ impl<'src> Parser<'src> { TokenKind::Star => { let starred_expr = self.parse_starred_expression(context); - if left_precedence > OperatorPrecedence::Initial + if left_precedence > OperatorPrecedence::None || !context.is_starred_expression_allowed() { self.add_error(ParseErrorType::InvalidStarredExpressionUsage, &starred_expr); @@ -390,7 +393,7 @@ impl<'src> Parser<'src> { TokenKind::Yield => { let expr = self.parse_yield_expression(); - if left_precedence > OperatorPrecedence::Initial + if left_precedence > OperatorPrecedence::None || !context.is_yield_expression_allowed() { self.add_error(ParseErrorType::InvalidYieldExpressionUsage, &expr); @@ -632,7 +635,7 @@ impl<'src> Parser<'src> { /// If the parser isn't position at a `(` token. /// /// See: <https://docs.python.org/3/reference/expressions.html#calls> - fn parse_call_expression(&mut self, func: Expr, start: TextSize) -> ast::ExprCall { + pub(super) fn parse_call_expression(&mut self, func: Expr, start: TextSize) -> ast::ExprCall { let arguments = self.parse_arguments(); ast::ExprCall { @@ -658,95 +661,120 @@ impl<'src> Parser<'src> { let mut seen_keyword_argument = false; // foo = 1 let mut seen_keyword_unpacking = false; // **foo - self.parse_comma_separated_list(RecoveryContextKind::Arguments, |parser| { - let argument_start = parser.node_start(); - if parser.eat(TokenKind::DoubleStar) { - let value = parser.parse_conditional_expression_or_higher(); - - keywords.push(ast::Keyword { - arg: None, - value: value.expr, - range: parser.node_range(argument_start), - }); - - seen_keyword_unpacking = true; - } else { - let start = parser.node_start(); - let mut parsed_expr = parser - .parse_named_expression_or_higher(ExpressionContext::starred_conditional()); - - match parser.current_token_kind() { - TokenKind::Async | TokenKind::For => { - if parsed_expr.is_unparenthesized_starred_expr() { - parser.add_error( - ParseErrorType::IterableUnpackingInComprehension, - &parsed_expr, - ); - } - - parsed_expr = Expr::Generator(parser.parse_generator_expression( - parsed_expr.expr, - start, - Parenthesized::No, - )) - .into(); - } - _ => { - if seen_keyword_unpacking && parsed_expr.is_unparenthesized_starred_expr() { - parser.add_error( - ParseErrorType::InvalidArgumentUnpackingOrder, - &parsed_expr, - ); - } - } - } - - if parser.eat(TokenKind::Equal) { - seen_keyword_argument = true; - let arg = if let Expr::Name(ident_expr) = parsed_expr.expr { - ast::Identifier { - id: ident_expr.id, - range: ident_expr.range, - } - } else { - // TODO(dhruvmanila): Parser shouldn't drop the `parsed_expr` if it's - // not a name expression. We could add the expression into `args` but - // that means the error is a missing comma instead. - parser.add_error( - ParseErrorType::OtherError("Expected a parameter name".to_string()), - &parsed_expr, - ); - ast::Identifier { - id: Name::empty(), - range: parsed_expr.range(), - } - }; - + let has_trailing_comma = + self.parse_comma_separated_list(RecoveryContextKind::Arguments, |parser| { + let argument_start = parser.node_start(); + if parser.eat(TokenKind::DoubleStar) { let value = parser.parse_conditional_expression_or_higher(); keywords.push(ast::Keyword { - arg: Some(arg), + arg: None, value: value.expr, range: parser.node_range(argument_start), }); + + seen_keyword_unpacking = true; } else { - if !parsed_expr.is_unparenthesized_starred_expr() { - if seen_keyword_unpacking { - parser.add_error( - ParseErrorType::PositionalAfterKeywordUnpacking, - &parsed_expr, - ); - } else if seen_keyword_argument { + let start = parser.node_start(); + let mut parsed_expr = parser + .parse_named_expression_or_higher(ExpressionContext::starred_conditional()); + + match parser.current_token_kind() { + TokenKind::Async | TokenKind::For => { + if parsed_expr.is_unparenthesized_starred_expr() { + parser.add_error( + ParseErrorType::IterableUnpackingInComprehension, + &parsed_expr, + ); + } + + parsed_expr = Expr::Generator(parser.parse_generator_expression( + parsed_expr.expr, + start, + Parenthesized::No, + )) + .into(); + } + _ => { + if seen_keyword_unpacking + && parsed_expr.is_unparenthesized_starred_expr() + { + parser.add_error( + ParseErrorType::InvalidArgumentUnpackingOrder, + &parsed_expr, + ); + } + } + } + + let arg_range = parser.node_range(start); + if parser.eat(TokenKind::Equal) { + seen_keyword_argument = true; + let arg = if let ParsedExpr { + expr: Expr::Name(ident_expr), + is_parenthesized, + } = parsed_expr + { + // test_ok parenthesized_kwarg_py37 + // # parse_options: {"target-version": "3.7"} + // f((a)=1) + + // test_err parenthesized_kwarg_py38 + // # parse_options: {"target-version": "3.8"} + // f((a)=1) + // f((a) = 1) + // f( ( a ) = 1) + + if is_parenthesized { + parser.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::ParenthesizedKeywordArgumentName, + arg_range, + ); + } + + ast::Identifier { + id: ident_expr.id, + range: ident_expr.range, + } + } else { + // TODO(dhruvmanila): Parser shouldn't drop the `parsed_expr` if it's + // not a name expression. We could add the expression into `args` but + // that means the error is a missing comma instead. parser.add_error( - ParseErrorType::PositionalAfterKeywordArgument, + ParseErrorType::OtherError("Expected a parameter name".to_string()), &parsed_expr, ); + ast::Identifier { + id: Name::empty(), + range: parsed_expr.range(), + } + }; + + let value = parser.parse_conditional_expression_or_higher(); + + keywords.push(ast::Keyword { + arg: Some(arg), + value: value.expr, + range: parser.node_range(argument_start), + }); + } else { + if !parsed_expr.is_unparenthesized_starred_expr() { + if seen_keyword_unpacking { + parser.add_error( + ParseErrorType::PositionalAfterKeywordUnpacking, + &parsed_expr, + ); + } else if seen_keyword_argument { + parser.add_error( + ParseErrorType::PositionalAfterKeywordArgument, + &parsed_expr, + ); + } } + args.push(parsed_expr.expr); } - args.push(parsed_expr.expr); } - } - }); + }); self.expect(TokenKind::Rpar); @@ -756,7 +784,7 @@ impl<'src> Parser<'src> { keywords: keywords.into_boxed_slice(), }; - self.validate_arguments(&arguments); + self.validate_arguments(&arguments, has_trailing_comma); arguments } @@ -830,6 +858,44 @@ impl<'src> Parser<'src> { self.expect(TokenKind::Rsqb); + // test_ok star_index_py311 + // # parse_options: {"target-version": "3.11"} + // lst[*index] # simple index + // class Array(Generic[DType, *Shape]): ... # motivating example from the PEP + // lst[a, *b, c] # different positions + // lst[a, b, *c] # different positions + // lst[*a, *b] # multiple unpacks + // array[3:5, *idxs] # mixed with slices + + // test_err star_index_py310 + // # parse_options: {"target-version": "3.10"} + // lst[*index] # simple index + // class Array(Generic[DType, *Shape]): ... # motivating example from the PEP + // lst[a, *b, c] # different positions + // lst[a, b, *c] # different positions + // lst[*a, *b] # multiple unpacks + // array[3:5, *idxs] # mixed with slices + + // test_err star_slices + // array[*start:*end] + + // test_ok parenthesized_star_index_py310 + // # parse_options: {"target-version": "3.10"} + // out[(*(slice(None) for _ in range(2)), *ind)] = 1 + if let Expr::Tuple(ast::ExprTuple { + elts, + parenthesized: false, + .. + }) = &slice + { + for elt in elts.iter().filter(|elt| elt.is_starred_expr()) { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::StarExpressionInIndex, + elt.range(), + ); + } + } + ast::ExprSubscript { value: Box::new(value), slice: Box::new(slice), @@ -848,15 +914,48 @@ impl<'src> Parser<'src> { const STEP_END_SET: TokenSet = TokenSet::new([TokenKind::Comma, TokenKind::Rsqb]).union(NEWLINE_EOF_SET); + // test_err named_expr_slice + // # even after 3.9, an unparenthesized named expression is not allowed in a slice + // lst[x:=1:-1] + // lst[1:x:=1] + // lst[1:3:x:=1] + + // test_err named_expr_slice_parse_error + // # parse_options: {"target-version": "3.8"} + // # before 3.9, only emit the parse error, not the unsupported syntax error + // lst[x:=1:-1] + let start = self.node_start(); let lower = if self.at_expr() { let lower = self.parse_named_expression_or_higher(ExpressionContext::starred_conditional()); + + // This means we're in a subscript. if self.at_ts(NEWLINE_EOF_SET.union([TokenKind::Rsqb, TokenKind::Comma].into())) { + // test_ok parenthesized_named_expr_index_py38 + // # parse_options: {"target-version": "3.8"} + // lst[(x:=1)] + + // test_ok unparenthesized_named_expr_index_py39 + // # parse_options: {"target-version": "3.9"} + // lst[x:=1] + + // test_err unparenthesized_named_expr_index_py38 + // # parse_options: {"target-version": "3.8"} + // lst[x:=1] + if lower.is_unparenthesized_named_expr() { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SequenceIndex, + ), + lower.range(), + ); + } return lower.expr; } + // Now we know we're in a slice. if !lower.is_parenthesized { match lower.expr { Expr::Starred(_) => { @@ -1308,13 +1407,89 @@ impl<'src> Parser<'src> { self.expect(TokenKind::FStringEnd); + // test_ok pep701_f_string_py312 + // # parse_options: {"target-version": "3.12"} + // f'Magic wand: { bag['wand'] }' # nested quotes + // f"{'\n'.join(a)}" # escape sequence + // f'''A complex trick: { + // bag['bag'] # comment + // }''' + // f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + // f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes + // f"test {a \ + // } more" # line continuation + + // test_ok pep701_f_string_py311 + // # parse_options: {"target-version": "3.11"} + // f"outer {'# not a comment'}" + // f'outer {x:{"# not a comment"} }' + // f"""{f'''{f'{"# not a comment"}'}'''}""" + // f"""{f'''# before expression {f'# aro{f"#{1+1}#"}und #'}'''} # after expression""" + // f"escape outside of \t {expr}\n" + // f"test\"abcd" + + // test_err pep701_f_string_py311 + // # parse_options: {"target-version": "3.11"} + // f'Magic wand: { bag['wand'] }' # nested quotes + // f"{'\n'.join(a)}" # escape sequence + // f'''A complex trick: { + // bag['bag'] # comment + // }''' + // f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + // f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes + // f"test {a \ + // } more" # line continuation + // f"""{f"""{x}"""}""" # mark the whole triple quote + // f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + + let range = self.node_range(start); + + if !self.options.target_version.supports_pep_701() { + let quote_bytes = flags.quote_str().as_bytes(); + let quote_len = flags.quote_len(); + for expr in elements.expressions() { + for slash_position in memchr::memchr_iter(b'\\', self.source[expr.range].as_bytes()) + { + let slash_position = TextSize::try_from(slash_position).unwrap(); + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::Backslash), + TextRange::at(expr.range.start() + slash_position, '\\'.text_len()), + ); + } + + if let Some(quote_position) = + memchr::memmem::find(self.source[expr.range].as_bytes(), quote_bytes) + { + let quote_position = TextSize::try_from(quote_position).unwrap(); + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::NestedQuote), + TextRange::at(expr.range.start() + quote_position, quote_len), + ); + } + } + + self.check_fstring_comments(range); + } + ast::FString { elements, - range: self.node_range(start), + range, flags: ast::FStringFlags::from(flags), } } + /// Check `range` for comment tokens and report an `UnsupportedSyntaxError` for each one found. + fn check_fstring_comments(&mut self, range: TextRange) { + self.unsupported_syntax_errors + .extend(self.tokens.in_range(range).iter().filter_map(|token| { + token.kind().is_comment().then_some(UnsupportedSyntaxError { + kind: UnsupportedSyntaxErrorKind::Pep701FString(FStringKind::Comment), + range: token.range(), + target_version: self.options.target_version, + }) + })); + } + /// Parses a list of f-string elements. /// /// # Panics @@ -1607,6 +1782,26 @@ impl<'src> Parser<'src> { ParseErrorType::IterableUnpackingInComprehension, &key_or_element, ); + } else if key_or_element.is_unparenthesized_named_expr() { + // test_ok parenthesized_named_expr_py38 + // # parse_options: {"target-version": "3.8"} + // {(x := 1), 2, 3} + // {(last := x) for x in range(3)} + + // test_ok unparenthesized_named_expr_py39 + // # parse_options: {"target-version": "3.9"} + // {x := 1, 2, 3} + // {last := x for x in range(3)} + + // test_err unparenthesized_named_expr_set_comp_py38 + // # parse_options: {"target-version": "3.8"} + // {last := x for x in range(3)} + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SetComprehension, + ), + key_or_element.range(), + ); } Expr::SetComp(self.parse_set_comprehension_expression(key_or_element.expr, start)) @@ -1645,7 +1840,7 @@ impl<'src> Parser<'src> { )) } } - _ => Expr::Set(self.parse_set_expression(key_or_element.expr, start)), + _ => Expr::Set(self.parse_set_expression(key_or_element, start)), } } @@ -1795,19 +1990,42 @@ impl<'src> Parser<'src> { /// Parses a set expression. /// /// See: <https://docs.python.org/3/reference/expressions.html#set-displays> - fn parse_set_expression(&mut self, first_element: Expr, start: TextSize) -> ast::ExprSet { + fn parse_set_expression(&mut self, first_element: ParsedExpr, start: TextSize) -> ast::ExprSet { if !self.at_sequence_end() { self.expect(TokenKind::Comma); } - let mut elts = vec![first_element]; + // test_err unparenthesized_named_expr_set_literal_py38 + // # parse_options: {"target-version": "3.8"} + // {x := 1, 2, 3} + // {1, x := 2, 3} + // {1, 2, x := 3} - self.parse_comma_separated_list(RecoveryContextKind::SetElements, |parser| { - elts.push( - parser - .parse_named_expression_or_higher(ExpressionContext::starred_bitwise_or()) - .expr, + if first_element.is_unparenthesized_named_expr() { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SetLiteral, + ), + first_element.range(), ); + } + + let mut elts = vec![first_element.expr]; + + self.parse_comma_separated_list(RecoveryContextKind::SetElements, |parser| { + let parsed_expr = + parser.parse_named_expression_or_higher(ExpressionContext::starred_bitwise_or()); + + if parsed_expr.is_unparenthesized_named_expr() { + parser.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::UnparenthesizedNamedExpr( + UnparenthesizedNamedExprKind::SetLiteral, + ), + parsed_expr.range(), + ); + } + + elts.push(parsed_expr.expr); }); self.expect(TokenKind::Rbrace); @@ -1899,7 +2117,7 @@ impl<'src> Parser<'src> { self.expect(TokenKind::For); } else { self.bump(TokenKind::For); - }; + } let mut target = self.parse_expression_list(ExpressionContext::starred_conditional().with_in_excluded()); @@ -2089,10 +2307,30 @@ impl<'src> Parser<'src> { } let value = self.at_expr().then(|| { - Box::new( - self.parse_expression_list(ExpressionContext::starred_bitwise_or()) - .expr, - ) + let parsed_expr = self.parse_expression_list(ExpressionContext::starred_bitwise_or()); + + // test_ok iter_unpack_yield_py37 + // # parse_options: {"target-version": "3.7"} + // rest = (4, 5, 6) + // def g(): yield (1, 2, 3, *rest) + + // test_ok iter_unpack_yield_py38 + // # parse_options: {"target-version": "3.8"} + // rest = (4, 5, 6) + // def g(): yield 1, 2, 3, *rest + // def h(): yield 1, (yield 2, *rest), 3 + + // test_err iter_unpack_yield_py37 + // # parse_options: {"target-version": "3.7"} + // rest = (4, 5, 6) + // def g(): yield 1, 2, 3, *rest + // def h(): yield 1, (yield 2, *rest), 3 + self.check_tuple_unpacking( + &parsed_expr, + UnsupportedSyntaxErrorKind::StarTuple(StarTupleKind::Yield), + ); + + Box::new(parsed_expr.expr) }); Expr::Yield(ast::ExprYield { @@ -2161,10 +2399,22 @@ impl<'src> Parser<'src> { let value = self.parse_conditional_expression_or_higher(); + let range = self.node_range(start); + + // test_err walrus_py37 + // # parse_options: { "target-version": "3.7" } + // (x := 1) + + // test_ok walrus_py38 + // # parse_options: { "target-version": "3.8" } + // (x := 1) + + self.add_unsupported_syntax_error(UnsupportedSyntaxErrorKind::Walrus, range); + ast::ExprNamed { target: Box::new(target), value: Box::new(value.expr), - range: self.node_range(start), + range, } } @@ -2265,7 +2515,7 @@ impl<'src> Parser<'src> { value, }; - if self.mode != Mode::Ipython { + if self.options.mode != Mode::Ipython { self.add_error(ParseErrorType::UnexpectedIpythonEscapeCommand, &command); } @@ -2274,9 +2524,9 @@ impl<'src> Parser<'src> { /// Performs the following validations on the function call arguments: /// 1. There aren't any duplicate keyword argument - /// 2. If there are more than one argument (positional or keyword), all generator expressions - /// present should be parenthesized. - fn validate_arguments(&mut self, arguments: &ast::Arguments) { + /// 2. If there are more than one argument (positional or keyword) or a single argument with a + /// trailing comma, all generator expressions present should be parenthesized. + fn validate_arguments(&mut self, arguments: &ast::Arguments, has_trailing_comma: bool) { let mut all_arg_names = FxHashSet::with_capacity_and_hasher(arguments.keywords.len(), FxBuildHasher); @@ -2294,7 +2544,7 @@ impl<'src> Parser<'src> { } } - if arguments.len() > 1 { + if has_trailing_comma || arguments.len() > 1 { for arg in &*arguments.args { if let Some(ast::ExprGenerator { range, @@ -2303,11 +2553,14 @@ impl<'src> Parser<'src> { }) = arg.as_generator_expr() { // test_ok args_unparenthesized_generator + // zip((x for x in range(10)), (y for y in range(10))) // sum(x for x in range(10)) + // sum((x for x in range(10)),) // test_err args_unparenthesized_generator // sum(x for x in range(10), 5) // total(1, 2, x for x in range(5), 6) + // sum(x for x in range(10),) self.add_error(ParseErrorType::UnparenthesizedGeneratorExpression, range); } } @@ -2326,6 +2579,11 @@ impl ParsedExpr { pub(super) const fn is_unparenthesized_starred_expr(&self) -> bool { !self.is_parenthesized && self.expr.is_starred_expr() } + + #[inline] + pub(super) const fn is_unparenthesized_named_expr(&self) -> bool { + !self.is_parenthesized && self.expr.is_named_expr() + } } impl From<Expr> for ParsedExpr { @@ -2353,57 +2611,6 @@ impl Ranged for ParsedExpr { } } -/// Represents the precedence levels for various operators and expressions of Python. -/// Variants at the top have lower precedence and variants at the bottom have -/// higher precedence. -/// -/// Note: Some expressions like if-else, named expression (`:=`), lambda, subscription, -/// slicing, call and attribute reference expressions, that are mentioned in the link -/// below are better handled in other parts of the parser. -/// -/// See: <https://docs.python.org/3/reference/expressions.html#operator-precedence> -#[derive(Debug, Ord, Eq, PartialEq, PartialOrd, Copy, Clone)] -pub(super) enum OperatorPrecedence { - /// The initial precedence when parsing an expression. - Initial, - /// Precedence of boolean `or` operator. - Or, - /// Precedence of boolean `and` operator. - And, - /// Precedence of boolean `not` unary operator. - Not, - /// Precedence of comparisons operators (`<`, `<=`, `>`, `>=`, `!=`, `==`), - /// memberships tests (`in`, `not in`) and identity tests (`is` `is not`). - ComparisonsMembershipIdentity, - /// Precedence of `Bitwise OR` (`|`) operator. - BitOr, - /// Precedence of `Bitwise XOR` (`^`) operator. - BitXor, - /// Precedence of `Bitwise AND` (`&`) operator. - BitAnd, - /// Precedence of left and right shift operators (`<<`, `>>`). - LeftRightShift, - /// Precedence of addition (`+`) and subtraction (`-`) operators. - AddSub, - /// Precedence of multiplication (`*`), matrix multiplication (`@`), division (`/`), floor - /// division (`//`) and remainder operators (`%`). - MulDivRemain, - /// Precedence of positive (`+`), negative (`-`), `Bitwise NOT` (`~`) unary operators. - PosNegBitNot, - /// Precedence of exponentiation operator (`**`). - Exponent, - /// Precedence of `await` expression. - Await, -} - -impl OperatorPrecedence { - /// Returns `true` if the precedence is right-associative i.e., the operations are evaluated - /// from right to left. - fn is_right_associative(self) -> bool { - matches!(self, OperatorPrecedence::Exponent) - } -} - #[derive(Debug)] enum BinaryLikeOperator { Boolean(BoolOp), @@ -2435,45 +2642,6 @@ impl BinaryLikeOperator { } } -impl From<BoolOp> for OperatorPrecedence { - #[inline] - fn from(op: BoolOp) -> Self { - match op { - BoolOp::And => OperatorPrecedence::And, - BoolOp::Or => OperatorPrecedence::Or, - } - } -} - -impl From<UnaryOp> for OperatorPrecedence { - #[inline] - fn from(op: UnaryOp) -> Self { - match op { - UnaryOp::Not => OperatorPrecedence::Not, - _ => OperatorPrecedence::PosNegBitNot, - } - } -} - -impl From<Operator> for OperatorPrecedence { - #[inline] - fn from(op: Operator) -> Self { - match op { - Operator::Add | Operator::Sub => OperatorPrecedence::AddSub, - Operator::Mult - | Operator::Div - | Operator::FloorDiv - | Operator::Mod - | Operator::MatMult => OperatorPrecedence::MulDivRemain, - Operator::BitAnd => OperatorPrecedence::BitAnd, - Operator::BitOr => OperatorPrecedence::BitOr, - Operator::BitXor => OperatorPrecedence::BitXor, - Operator::LShift | Operator::RShift => OperatorPrecedence::LeftRightShift, - Operator::Pow => OperatorPrecedence::Exponent, - } - } -} - /// Represents the precedence used for parsing the value part of a starred expression. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub(super) enum StarredExpressionPrecedence { diff --git a/crates/ruff_python_parser/src/parser/helpers.rs b/crates/ruff_python_parser/src/parser/helpers.rs index d4846d9039ee4..e7a0e426c244c 100644 --- a/crates/ruff_python_parser/src/parser/helpers.rs +++ b/crates/ruff_python_parser/src/parser/helpers.rs @@ -1,6 +1,7 @@ -use ruff_python_ast::{self as ast, CmpOp, Expr, ExprContext}; +use ruff_python_ast::{self as ast, CmpOp, Expr, ExprContext, Number}; +use ruff_text_size::{Ranged, TextRange}; -use crate::TokenKind; +use crate::{TokenKind, error::RelaxedDecoratorError}; /// Set the `ctx` for `Expr::Id`, `Expr::Attribute`, `Expr::Subscript`, `Expr::Starred`, /// `Expr::Tuple` and `Expr::List`. If `expr` is either `Expr::Tuple` or `Expr::List`, @@ -43,3 +44,60 @@ pub(super) const fn token_kind_to_cmp_op(tokens: [TokenKind; 2]) -> Option<CmpOp _ => return None, }) } + +/// Helper for `parse_decorators` to determine if `expr` is a [`dotted_name`] from the decorator +/// grammar before Python 3.9. +/// +/// Returns `Some((error, range))` if `expr` is not a `dotted_name`, or `None` if it is a `dotted_name`. +/// +/// [`dotted_name`]: https://docs.python.org/3.8/reference/compound_stmts.html#grammar-token-dotted-name +pub(super) fn detect_invalid_pre_py39_decorator_node( + expr: &Expr, +) -> Option<(RelaxedDecoratorError, TextRange)> { + let description = match expr { + Expr::Name(_) => return None, + + Expr::Attribute(attribute) => { + return detect_invalid_pre_py39_decorator_node(&attribute.value); + } + + Expr::Call(_) => return Some((RelaxedDecoratorError::CallExpression, expr.range())), + + Expr::NumberLiteral(number) => match &number.value { + Number::Int(_) => "an int literal", + Number::Float(_) => "a float literal", + Number::Complex { .. } => "a complex literal", + }, + + Expr::BoolOp(_) => "boolean expression", + Expr::BinOp(_) => "binary-operation expression", + Expr::UnaryOp(_) => "unary-operation expression", + Expr::Await(_) => "`await` expression", + Expr::Lambda(_) => "lambda expression", + Expr::If(_) => "conditional expression", + Expr::Dict(_) => "a dict literal", + Expr::Set(_) => "a set literal", + Expr::List(_) => "a list literal", + Expr::Tuple(_) => "a tuple literal", + Expr::Starred(_) => "starred expression", + Expr::Slice(_) => "slice expression", + Expr::BytesLiteral(_) => "a bytes literal", + Expr::StringLiteral(_) => "a string literal", + Expr::EllipsisLiteral(_) => "an ellipsis literal", + Expr::NoneLiteral(_) => "a `None` literal", + Expr::BooleanLiteral(_) => "a boolean literal", + Expr::ListComp(_) => "a list comprehension", + Expr::SetComp(_) => "a set comprehension", + Expr::DictComp(_) => "a dict comprehension", + Expr::Generator(_) => "generator expression", + Expr::Yield(_) => "`yield` expression", + Expr::YieldFrom(_) => "`yield from` expression", + Expr::Compare(_) => "comparison expression", + Expr::FString(_) => "f-string", + Expr::Named(_) => "assignment expression", + Expr::Subscript(_) => "subscript expression", + Expr::IpyEscapeCommand(_) => "IPython escape command", + }; + + Some((RelaxedDecoratorError::Other(description), expr.range())) +} diff --git a/crates/ruff_python_parser/src/parser/mod.rs b/crates/ruff_python_parser/src/parser/mod.rs index 08c85f7a07148..19596364a8347 100644 --- a/crates/ruff_python_parser/src/parser/mod.rs +++ b/crates/ruff_python_parser/src/parser/mod.rs @@ -5,16 +5,20 @@ use bitflags::bitflags; use ruff_python_ast::{Mod, ModExpression, ModModule}; use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::error::UnsupportedSyntaxError; use crate::parser::expression::ExpressionContext; use crate::parser::progress::{ParserProgress, TokenId}; use crate::token::TokenValue; use crate::token_set::TokenSet; use crate::token_source::{TokenSource, TokenSourceCheckpoint}; -use crate::{Mode, ParseError, ParseErrorType, TokenKind}; +use crate::{Mode, ParseError, ParseErrorType, TokenKind, UnsupportedSyntaxErrorKind}; use crate::{Parsed, Tokens}; +pub use crate::parser::options::ParseOptions; + mod expression; mod helpers; +mod options; mod pattern; mod progress; mod recovery; @@ -32,8 +36,11 @@ pub(crate) struct Parser<'src> { /// Stores all the syntax errors found during the parsing. errors: Vec<ParseError>, - /// Specify the mode in which the code will be parsed. - mode: Mode, + /// Stores non-fatal syntax errors found during parsing, such as version-related errors. + unsupported_syntax_errors: Vec<UnsupportedSyntaxError>, + + /// Options for how the code will be parsed. + options: ParseOptions, /// The ID of the current token. This is used to track the progress of the parser /// to avoid infinite loops when the parser is stuck. @@ -51,18 +58,23 @@ pub(crate) struct Parser<'src> { impl<'src> Parser<'src> { /// Create a new parser for the given source code. - pub(crate) fn new(source: &'src str, mode: Mode) -> Self { - Parser::new_starts_at(source, mode, TextSize::new(0)) + pub(crate) fn new(source: &'src str, options: ParseOptions) -> Self { + Parser::new_starts_at(source, TextSize::new(0), options) } /// Create a new parser for the given source code which starts parsing at the given offset. - pub(crate) fn new_starts_at(source: &'src str, mode: Mode, start_offset: TextSize) -> Self { - let tokens = TokenSource::from_source(source, mode, start_offset); + pub(crate) fn new_starts_at( + source: &'src str, + start_offset: TextSize, + options: ParseOptions, + ) -> Self { + let tokens = TokenSource::from_source(source, options.mode, start_offset); Parser { - mode, + options, source, errors: Vec::new(), + unsupported_syntax_errors: Vec::new(), tokens, recovery_context: RecoveryContext::empty(), prev_token_end: TextSize::new(0), @@ -73,8 +85,10 @@ impl<'src> Parser<'src> { /// Consumes the [`Parser`] and returns the parsed [`Parsed`]. pub(crate) fn parse(mut self) -> Parsed<Mod> { - let syntax = match self.mode { - Mode::Expression => Mod::Expression(self.parse_single_expression()), + let syntax = match self.options.mode { + Mode::Expression | Mode::ParenthesizedExpression => { + Mod::Expression(self.parse_single_expression()) + } Mode::Module | Mode::Ipython => Mod::Module(self.parse_module()), }; @@ -157,6 +171,7 @@ impl<'src> Parser<'src> { syntax, tokens: Tokens::new(tokens), errors: parse_errors, + unsupported_syntax_errors: self.unsupported_syntax_errors, }; } @@ -188,6 +203,7 @@ impl<'src> Parser<'src> { syntax, tokens: Tokens::new(tokens), errors: merged, + unsupported_syntax_errors: self.unsupported_syntax_errors, } } @@ -422,6 +438,18 @@ impl<'src> Parser<'src> { inner(&mut self.errors, error, ranged.range()); } + /// Add an [`UnsupportedSyntaxError`] with the given [`UnsupportedSyntaxErrorKind`] and + /// [`TextRange`] if its minimum version is less than [`Parser::target_version`]. + fn add_unsupported_syntax_error(&mut self, kind: UnsupportedSyntaxErrorKind, range: TextRange) { + if kind.is_unsupported(self.options.target_version) { + self.unsupported_syntax_errors.push(UnsupportedSyntaxError { + kind, + range, + target_version: self.options.target_version, + }); + } + } + /// Returns `true` if the current token is of the given kind. fn at(&self, kind: TokenKind) -> bool { self.current_token_kind() == kind @@ -511,17 +539,19 @@ impl<'src> Parser<'src> { } /// Parses a comma separated list of elements where each element is parsed - /// sing the given `parse_element` function. + /// using the given `parse_element` function. /// /// The difference between this function and `parse_comma_separated_list_into_vec` /// is that this function does not return the parsed elements. Instead, it is the /// caller's responsibility to handle the parsed elements. This is the reason /// that the `parse_element` parameter is bound to [`FnMut`] instead of [`Fn`]. + /// + /// Returns `true` if there is a trailing comma present. fn parse_comma_separated_list( &mut self, recovery_context_kind: RecoveryContextKind, mut parse_element: impl FnMut(&mut Parser<'src>), - ) { + ) -> bool { let mut progress = ParserProgress::default(); let saved_context = self.recovery_context; @@ -631,6 +661,8 @@ impl<'src> Parser<'src> { } self.recovery_context = saved_context; + + trailing_comma_range.is_some() } #[cold] @@ -649,6 +681,7 @@ impl<'src> Parser<'src> { ParserCheckpoint { tokens: self.tokens.checkpoint(), errors_position: self.errors.len(), + unsupported_syntax_errors_position: self.unsupported_syntax_errors.len(), current_token_id: self.current_token_id, prev_token_end: self.prev_token_end, recovery_context: self.recovery_context, @@ -660,6 +693,7 @@ impl<'src> Parser<'src> { let ParserCheckpoint { tokens, errors_position, + unsupported_syntax_errors_position, current_token_id, prev_token_end, recovery_context, @@ -667,6 +701,8 @@ impl<'src> Parser<'src> { self.tokens.rewind(tokens); self.errors.truncate(errors_position); + self.unsupported_syntax_errors + .truncate(unsupported_syntax_errors_position); self.current_token_id = current_token_id; self.prev_token_end = prev_token_end; self.recovery_context = recovery_context; @@ -676,6 +712,7 @@ impl<'src> Parser<'src> { struct ParserCheckpoint { tokens: TokenSourceCheckpoint, errors_position: usize, + unsupported_syntax_errors_position: usize, current_token_id: TokenId, prev_token_end: TextSize, recovery_context: RecoveryContext, @@ -1027,10 +1064,10 @@ impl RecoveryContextKind { None => { // test_ok match_sequence_pattern_terminator // match subject: - // case a: ... // case a if x: ... // case a, b: ... // case a, b if x: ... + // case a: ... matches!(p.current_token_kind(), TokenKind::Colon | TokenKind::If) .then_some(ListTerminatorKind::Regular) } diff --git a/crates/ruff_python_parser/src/parser/options.rs b/crates/ruff_python_parser/src/parser/options.rs new file mode 100644 index 0000000000000..ec87a72d1e481 --- /dev/null +++ b/crates/ruff_python_parser/src/parser/options.rs @@ -0,0 +1,59 @@ +use ruff_python_ast::{PySourceType, PythonVersion}; + +use crate::{AsMode, Mode}; + +/// Options for controlling how a source file is parsed. +/// +/// You can construct a [`ParseOptions`] directly from a [`Mode`]: +/// +/// ``` +/// use ruff_python_parser::{Mode, ParseOptions}; +/// +/// let options = ParseOptions::from(Mode::Module); +/// ``` +/// +/// or from a [`PySourceType`] +/// +/// ``` +/// use ruff_python_ast::PySourceType; +/// use ruff_python_parser::ParseOptions; +/// +/// let options = ParseOptions::from(PySourceType::Python); +/// ``` +#[derive(Clone, Debug)] +pub struct ParseOptions { + /// Specify the mode in which the code will be parsed. + pub(crate) mode: Mode, + /// Target version for detecting version-related syntax errors. + pub(crate) target_version: PythonVersion, +} + +impl ParseOptions { + #[must_use] + pub fn with_target_version(mut self, target_version: PythonVersion) -> Self { + self.target_version = target_version; + self + } + + pub fn target_version(&self) -> PythonVersion { + self.target_version + } +} + +impl From<Mode> for ParseOptions { + fn from(mode: Mode) -> Self { + Self { + mode, + target_version: PythonVersion::default(), + } + } +} + +impl From<PySourceType> for ParseOptions { + fn from(source_type: PySourceType) -> Self { + Self { + mode: source_type.as_mode(), + target_version: PythonVersion::default(), + } + } +} diff --git a/crates/ruff_python_parser/src/parser/pattern.rs b/crates/ruff_python_parser/src/parser/pattern.rs index 0685913e3b655..ced1627461ba2 100644 --- a/crates/ruff_python_parser/src/parser/pattern.rs +++ b/crates/ruff_python_parser/src/parser/pattern.rs @@ -2,11 +2,11 @@ use ruff_python_ast::name::Name; use ruff_python_ast::{self as ast, Expr, ExprContext, Number, Operator, Pattern, Singleton}; use ruff_text_size::{Ranged, TextSize}; +use crate::ParseErrorType; use crate::parser::progress::ParserProgress; -use crate::parser::{recovery, Parser, RecoveryContextKind, SequenceMatchPatternParentheses}; +use crate::parser::{Parser, RecoveryContextKind, SequenceMatchPatternParentheses, recovery}; use crate::token::{TokenKind, TokenValue}; use crate::token_set::TokenSet; -use crate::ParseErrorType; use super::expression::ExpressionContext; @@ -49,7 +49,7 @@ const MAPPING_PATTERN_START_SET: TokenSet = TokenSet::new([ ]) .union(LITERAL_PATTERN_START_SET); -impl<'src> Parser<'src> { +impl Parser<'_> { /// Returns `true` if the current token is a valid start of a pattern. pub(super) fn at_pattern_start(&self) -> bool { self.at_ts(PATTERN_START_SET) || self.at_soft_keyword() @@ -488,13 +488,16 @@ impl<'src> Parser<'src> { // test_ok match_as_pattern_soft_keyword // match foo: // case case: ... + // match foo: // case match: ... + // match foo: // case type: ... let ident = self.parse_identifier(); // test_ok match_as_pattern // match foo: // case foo_bar: ... + // match foo: // case _: ... Pattern::MatchAs(ast::PatternMatchAs { range: ident.range, diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax1.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax1.snap index a3b74e9fadbb3..39c3600ad34b8 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax1.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax1.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: error +snapshot_kind: text --- ParseError { error: UnexpectedExpressionToken, diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax2.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax2.snap index ba26114dd8478..ce4545a6990e8 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax2.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax2.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: error +snapshot_kind: text --- ParseError { error: UnexpectedExpressionToken, diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax3.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax3.snap index ba26114dd8478..ce4545a6990e8 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax3.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_invalid_syntax3.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: error +snapshot_kind: text --- ParseError { error: UnexpectedExpressionToken, diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_valid_syntax.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_valid_syntax.snap index a3f88a0bb02f5..29cb09b85afc3 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_valid_syntax.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__expr_mode_valid_syntax.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: parsed.expr() +snapshot_kind: text --- Name( ExprName { diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__ipython_escape_commands.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__ipython_escape_commands.snap index d365ad36534c5..e5566ded21993 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__ipython_escape_commands.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__ipython_escape_commands.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: parsed.syntax() +snapshot_kind: text --- Module( ModModule { diff --git a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__unicode_aliases.snap b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__unicode_aliases.snap index 12dbd525ae5c4..fe8e440c17582 100644 --- a/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__unicode_aliases.snap +++ b/crates/ruff_python_parser/src/parser/snapshots/ruff_python_parser__parser__tests__unicode_aliases.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/parser/tests.rs expression: suite +snapshot_kind: text --- [ Assign( diff --git a/crates/ruff_python_parser/src/parser/statement.rs b/crates/ruff_python_parser/src/parser/statement.rs index e10487e18c9c3..1eb59b25b6a57 100644 --- a/crates/ruff_python_parser/src/parser/statement.rs +++ b/crates/ruff_python_parser/src/parser/statement.rs @@ -1,25 +1,25 @@ use compact_str::CompactString; -use std::fmt::Display; - -use rustc_hash::{FxBuildHasher, FxHashSet}; +use std::fmt::{Display, Write}; use ruff_python_ast::name::Name; use ruff_python_ast::{ - self as ast, ExceptHandler, Expr, ExprContext, IpyEscapeKind, Operator, Stmt, WithItem, + self as ast, ExceptHandler, Expr, ExprContext, IpyEscapeKind, Operator, PythonVersion, Stmt, + WithItem, }; -use ruff_text_size::{Ranged, TextSize}; +use ruff_text_size::{Ranged, TextRange, TextSize}; -use crate::parser::expression::{ParsedExpr, EXPR_SET}; +use crate::error::StarTupleKind; +use crate::parser::expression::{EXPR_SET, ParsedExpr}; use crate::parser::progress::ParserProgress; use crate::parser::{ - helpers, FunctionKind, Parser, RecoveryContext, RecoveryContextKind, WithItemKind, + FunctionKind, Parser, RecoveryContext, RecoveryContextKind, WithItemKind, helpers, }; use crate::token::{TokenKind, TokenValue}; use crate::token_set::TokenSet; -use crate::{Mode, ParseErrorType}; +use crate::{Mode, ParseErrorType, UnsupportedSyntaxErrorKind}; -use super::expression::ExpressionContext; use super::Parenthesized; +use super::expression::ExpressionContext; /// Tokens that represent compound statements. const COMPOUND_STMT_SET: TokenSet = TokenSet::new([ @@ -304,7 +304,7 @@ impl<'src> Parser<'src> { op, start, )) - } else if self.mode == Mode::Ipython && self.at(TokenKind::Question) { + } else if self.options.mode == Mode::Ipython && self.at(TokenKind::Question) { Stmt::IpyEscapeCommand( self.parse_ipython_help_end_escape_command_statement(&parsed_expr), ) @@ -388,10 +388,28 @@ impl<'src> Parser<'src> { // return x := 1 // return *x and y let value = self.at_expr().then(|| { - Box::new( - self.parse_expression_list(ExpressionContext::starred_bitwise_or()) - .expr, - ) + let parsed_expr = self.parse_expression_list(ExpressionContext::starred_bitwise_or()); + + // test_ok iter_unpack_return_py37 + // # parse_options: {"target-version": "3.7"} + // rest = (4, 5, 6) + // def f(): return (1, 2, 3, *rest) + + // test_ok iter_unpack_return_py38 + // # parse_options: {"target-version": "3.8"} + // rest = (4, 5, 6) + // def f(): return 1, 2, 3, *rest + + // test_err iter_unpack_return_py37 + // # parse_options: {"target-version": "3.7"} + // rest = (4, 5, 6) + // def f(): return 1, 2, 3, *rest + self.check_tuple_unpacking( + &parsed_expr, + UnsupportedSyntaxErrorKind::StarTuple(StarTupleKind::Return), + ); + + Box::new(parsed_expr.expr) }); ast::StmtReturn { @@ -400,6 +418,35 @@ impl<'src> Parser<'src> { } } + /// Report [`UnsupportedSyntaxError`]s for each starred element in `expr` if it is an + /// unparenthesized tuple. + /// + /// This method can be used to check for tuple unpacking in `return`, `yield`, and `for` + /// statements, which are only allowed after [Python 3.8] and [Python 3.9], respectively. + /// + /// [Python 3.8]: https://github.com/python/cpython/issues/76298 + /// [Python 3.9]: https://github.com/python/cpython/issues/90881 + pub(super) fn check_tuple_unpacking(&mut self, expr: &Expr, kind: UnsupportedSyntaxErrorKind) { + if kind.is_supported(self.options.target_version) { + return; + } + + let Expr::Tuple(ast::ExprTuple { + elts, + parenthesized: false, + .. + }) = expr + else { + return; + }; + + for elt in elts { + if elt.is_starred_expr() { + self.add_unsupported_syntax_error(kind, elt.range()); + } + } + } + /// Parses a `raise` statement. /// /// # Panics @@ -411,31 +458,44 @@ impl<'src> Parser<'src> { let start = self.node_start(); self.bump(TokenKind::Raise); - let exc = if self.at(TokenKind::Newline) { - None - } else { - // test_err raise_stmt_invalid_exc - // raise *x - // raise yield x - // raise x := 1 - let exc = self.parse_expression_list(ExpressionContext::default()); - - if let Some(ast::ExprTuple { - parenthesized: false, - .. - }) = exc.as_tuple_expr() - { - // test_err raise_stmt_unparenthesized_tuple_exc - // raise x, - // raise x, y - // raise x, y from z - self.add_error(ParseErrorType::UnparenthesizedTupleExpression, &exc); + let exc = match self.current_token_kind() { + TokenKind::Newline => None, + TokenKind::From => { + // test_err raise_stmt_from_without_exc + // raise from exc + // raise from None + self.add_error( + ParseErrorType::OtherError( + "Exception missing in `raise` statement with cause".to_string(), + ), + self.current_token_range(), + ); + None } + _ => { + // test_err raise_stmt_invalid_exc + // raise *x + // raise yield x + // raise x := 1 + let exc = self.parse_expression_list(ExpressionContext::default()); + + if let Some(ast::ExprTuple { + parenthesized: false, + .. + }) = exc.as_tuple_expr() + { + // test_err raise_stmt_unparenthesized_tuple_exc + // raise x, + // raise x, y + // raise x, y from z + self.add_error(ParseErrorType::UnparenthesizedTupleExpression, &exc); + } - Some(Box::new(exc.expr)) + Some(Box::new(exc.expr)) + } }; - let cause = (exc.is_some() && self.eat(TokenKind::From)).then(|| { + let cause = self.eat(TokenKind::From).then(|| { // test_err raise_stmt_invalid_cause // raise x from *y // raise x from yield y @@ -837,12 +897,14 @@ impl<'src> Parser<'src> { self.bump(TokenKind::Nonlocal); // test_err nonlocal_stmt_trailing_comma - // nonlocal , - // nonlocal x, - // nonlocal x, y, + // def _(): + // nonlocal , + // nonlocal x, + // nonlocal x, y, // test_err nonlocal_stmt_expression - // nonlocal x + 1 + // def _(): + // nonlocal x + 1 let names = self.parse_comma_separated_list_into_vec( RecoveryContextKind::Identifiers, Parser::parse_identifier, @@ -850,7 +912,8 @@ impl<'src> Parser<'src> { if names.is_empty() { // test_err nonlocal_stmt_empty - // nonlocal + // def _(): + // nonlocal self.add_error( ParseErrorType::EmptyNonlocalNames, self.current_token_range(), @@ -858,8 +921,9 @@ impl<'src> Parser<'src> { } // test_ok nonlocal_stmt - // nonlocal x - // nonlocal x, y, z + // def _(): + // nonlocal x + // nonlocal x, y, z ast::StmtNonlocal { range: self.node_range(start), names, @@ -875,8 +939,22 @@ impl<'src> Parser<'src> { /// See: <https://docs.python.org/3/reference/simple_stmts.html#the-type-statement> fn parse_type_alias_statement(&mut self) -> ast::StmtTypeAlias { let start = self.node_start(); + let type_range = self.current_token_range(); self.bump(TokenKind::Type); + // test_ok type_stmt_py312 + // # parse_options: {"target-version": "3.12"} + // type x = int + + // test_err type_stmt_py311 + // # parse_options: {"target-version": "3.11"} + // type x = int + + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::TypeAliasStatement, + type_range, + ); + let mut name = Expr::Name(self.parse_name()); helpers::set_expr_ctx(&mut name, ExprContext::Store); @@ -898,7 +976,7 @@ impl<'src> Parser<'src> { ast::StmtTypeAlias { name: Box::new(name), - type_params, + type_params: type_params.map(Box::new), value: Box::new(value.expr), range: self.node_range(start), } @@ -919,7 +997,7 @@ impl<'src> Parser<'src> { }; let range = self.node_range(start); - if self.mode != Mode::Ipython { + if self.options.mode != Mode::Ipython { self.add_error(ParseErrorType::UnexpectedIpythonEscapeCommand, range); } @@ -952,7 +1030,7 @@ impl<'src> Parser<'src> { .. }) = &**slice { - buffer.push_str(&format!("{integer}")); + let _ = write!(buffer, "{integer}"); } else { parser.add_error( ParseErrorType::OtherError( @@ -1049,10 +1127,10 @@ impl<'src> Parser<'src> { // a + b // test_err assign_stmt_invalid_value_expr - // x = *a and b - // x = *yield x - // x = *yield from x - // x = *lambda x: x + // x = (*a and b,) + // x = (42, *yield x) + // x = (42, *yield from x) + // x = (*lambda x: x,) // x = x := 1 let mut value = @@ -1332,14 +1410,12 @@ impl<'src> Parser<'src> { self.bump(TokenKind::Try); self.expect(TokenKind::Colon); - let mut is_star = false; + let mut is_star: Option<bool> = None; let try_body = self.parse_body(Clause::Try); let has_except = self.at(TokenKind::Except); - // TODO(dhruvmanila): Raise syntax error if there are both 'except' and 'except*' - // on the same 'try' // test_err try_stmt_mixed_except_kind // try: // pass @@ -1353,11 +1429,39 @@ impl<'src> Parser<'src> { // pass // except: // pass + // try: + // pass + // except: + // pass + // except: + // pass + // except* ExceptionGroup: + // pass + // except* ExceptionGroup: + // pass + let mut mixed_except_ranges = Vec::new(); let handlers = self.parse_clauses(Clause::Except, |p| { let (handler, kind) = p.parse_except_clause(); - is_star |= kind.is_star(); + if let ExceptClauseKind::Star(range) = kind { + p.add_unsupported_syntax_error(UnsupportedSyntaxErrorKind::ExceptStar, range); + } + if is_star.is_none() { + is_star = Some(kind.is_star()); + } else if is_star != Some(kind.is_star()) { + mixed_except_ranges.push(handler.range()); + } handler }); + // Empty handler has `is_star` false. + let is_star = is_star.unwrap_or_default(); + for handler_err_range in mixed_except_ranges { + self.add_error( + ParseErrorType::OtherError( + "Cannot have both 'except' and 'except*' on the same 'try'".to_string(), + ), + handler_err_range, + ); + } // test_err try_stmt_misspelled_except // try: @@ -1421,6 +1525,18 @@ impl<'src> Parser<'src> { ); } + // test_ok except_star_py311 + // # parse_options: {"target-version": "3.11"} + // try: ... + // except* ValueError: ... + + // test_err except_star_py310 + // # parse_options: {"target-version": "3.10"} + // try: ... + // except* ValueError: ... + // except* KeyError: ... + // except * Error: ... + ast::StmtTry { body: try_body, handlers, @@ -1440,8 +1556,9 @@ impl<'src> Parser<'src> { let start = self.node_start(); self.bump(TokenKind::Except); + let star_token_range = self.current_token_range(); let block_kind = if self.eat(TokenKind::Star) { - ExceptClauseKind::Star + ExceptClauseKind::Star(star_token_range) } else { ExceptClauseKind::Normal }; @@ -1464,25 +1581,50 @@ impl<'src> Parser<'src> { .. }) ) { - // test_err except_stmt_unparenthesized_tuple - // try: - // pass - // except x, y: - // pass - // except x, y as exc: - // pass - // try: - // pass - // except* x, y: - // pass - // except* x, y as eg: - // pass - self.add_error( - ParseErrorType::OtherError( - "Multiple exception types must be parenthesized".to_string(), - ), - &parsed_expr, - ); + if self.at(TokenKind::As) { + // test_err except_stmt_unparenthesized_tuple_as + // try: + // pass + // except x, y as exc: + // pass + // try: + // pass + // except* x, y as eg: + // pass + self.add_error( + ParseErrorType::OtherError( + "Multiple exception types must be parenthesized when using `as`" + .to_string(), + ), + &parsed_expr, + ); + } else { + // test_err except_stmt_unparenthesized_tuple_no_as_py313 + // # parse_options: {"target-version": "3.13"} + // try: + // pass + // except x, y: + // pass + // try: + // pass + // except* x, y: + // pass + + // test_ok except_stmt_unparenthesized_tuple_no_as_py314 + // # parse_options: {"target-version": "3.14"} + // try: + // pass + // except x, y: + // pass + // try: + // pass + // except* x, y: + // pass + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::UnparenthesizedExceptionTypes, + parsed_expr.range(), + ); + } } Some(Box::new(parsed_expr.expr)) } else { @@ -1622,6 +1764,28 @@ impl<'src> Parser<'src> { // for target in x := 1: ... let iter = self.parse_expression_list(ExpressionContext::starred_bitwise_or()); + // test_ok for_iter_unpack_py39 + // # parse_options: {"target-version": "3.9"} + // for x in *a, b: ... + // for x in a, *b: ... + // for x in *a, *b: ... + + // test_ok for_iter_unpack_py38 + // # parse_options: {"target-version": "3.8"} + // for x in (*a, b): ... + // for x in ( a, *b): ... + // for x in (*a, *b): ... + + // test_err for_iter_unpack_py38 + // # parse_options: {"target-version": "3.8"} + // for x in *a, b: ... + // for x in a, *b: ... + // for x in *a, *b: ... + self.check_tuple_unpacking( + &iter, + UnsupportedSyntaxErrorKind::UnparenthesizedUnpackInFor, + ); + self.expect(TokenKind::Colon); let body = self.parse_body(Clause::For); @@ -1720,6 +1884,21 @@ impl<'src> Parser<'src> { // x = 10 let type_params = self.try_parse_type_params(); + // test_ok function_type_params_py312 + // # parse_options: {"target-version": "3.12"} + // def foo[T](): ... + + // test_err function_type_params_py311 + // # parse_options: {"target-version": "3.11"} + // def foo[T](): ... + // def foo[](): ... + if let Some(ast::TypeParams { range, .. }) = &type_params { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::TypeParameterList, + *range, + ); + } + // test_ok function_def_parameter_range // def foo( // first: int, @@ -1739,7 +1918,6 @@ impl<'src> Parser<'src> { // test_ok function_def_valid_return_expr // def foo() -> int | str: ... // def foo() -> lambda x: x: ... - // def foo() -> (yield x): ... // def foo() -> int if True else str: ... // test_err function_def_invalid_return_expr @@ -1834,6 +2012,21 @@ impl<'src> Parser<'src> { // x = 10 let type_params = self.try_parse_type_params(); + // test_ok class_type_params_py312 + // # parse_options: {"target-version": "3.12"} + // class Foo[S: (str, bytes), T: float, *Ts, **P]: ... + + // test_err class_type_params_py311 + // # parse_options: {"target-version": "3.11"} + // class Foo[S: (str, bytes), T: float, *Ts, **P]: ... + // class Foo[]: ... + if let Some(ast::TypeParams { range, .. }) = &type_params { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::TypeParameterList, + *range, + ); + } + // test_ok class_def_arguments // class Foo: ... // class Foo(): ... @@ -1899,8 +2092,49 @@ impl<'src> Parser<'src> { return vec![]; } + let open_paren_range = self.current_token_range(); + if self.at(TokenKind::Lpar) { if let Some(items) = self.try_parse_parenthesized_with_items() { + // test_ok tuple_context_manager_py38 + // # parse_options: {"target-version": "3.8"} + // with ( + // foo, + // bar, + // baz, + // ) as tup: ... + + // test_err tuple_context_manager_py38 + // # parse_options: {"target-version": "3.8"} + // # these cases are _syntactically_ valid before Python 3.9 because the `with` item + // # is parsed as a tuple, but this will always cause a runtime error, so we flag it + // # anyway + // with (foo, bar): ... + // with ( + // open('foo.txt')) as foo: ... + // with ( + // foo, + // bar, + // baz, + // ): ... + // with (foo,): ... + + // test_ok parenthesized_context_manager_py39 + // # parse_options: {"target-version": "3.9"} + // with (foo as x, bar as y): ... + // with (foo, bar as y): ... + // with (foo as x, bar): ... + + // test_err parenthesized_context_manager_py38 + // # parse_options: {"target-version": "3.8"} + // with (foo as x, bar as y): ... + // with (foo, bar as y): ... + // with (foo as x, bar): ... + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::ParenthesizedContextManager, + open_paren_range, + ); + self.expect(TokenKind::Rpar); items } else { @@ -2140,7 +2374,7 @@ impl<'src> Parser<'src> { /// it's used in the context of a subscript expression or as a list expression: /// /// ```python - /// # Subcript expression; `match` is an identifier + /// # Subscript expression; `match` is an identifier /// match[x] /// /// # List expression; `match` is a keyword @@ -2221,11 +2455,27 @@ impl<'src> Parser<'src> { let start = self.node_start(); self.bump(TokenKind::Match); + let match_range = self.node_range(start); + let subject = self.parse_match_subject_expression(); self.expect(TokenKind::Colon); let cases = self.parse_match_body(); + // test_err match_before_py310 + // # parse_options: { "target-version": "3.9" } + // match 2: + // case 1: + // pass + + // test_ok match_after_py310 + // # parse_options: { "target-version": "3.10" } + // match 2: + // case 1: + // pass + + self.add_unsupported_syntax_error(UnsupportedSyntaxErrorKind::Match, match_range); + ast::StmtMatch { subject: Box::new(subject), cases, @@ -2487,6 +2737,84 @@ impl<'src> Parser<'src> { let decorator_start = self.node_start(); self.bump(TokenKind::At); + let parsed_expr = self.parse_named_expression_or_higher(ExpressionContext::default()); + + if self.options.target_version < PythonVersion::PY39 { + // test_ok decorator_expression_dotted_ident_py38 + // # parse_options: { "target-version": "3.8" } + // @buttons.clicked.connect + // def spam(): ... + + // test_ok decorator_expression_identity_hack_py38 + // # parse_options: { "target-version": "3.8" } + // def _(x): return x + // @_(buttons[0].clicked.connect) + // def spam(): ... + + // test_ok decorator_expression_eval_hack_py38 + // # parse_options: { "target-version": "3.8" } + // @eval("buttons[0].clicked.connect") + // def spam(): ... + + // test_ok decorator_expression_py39 + // # parse_options: { "target-version": "3.9" } + // @buttons[0].clicked.connect + // def spam(): ... + // @(x := lambda x: x)(foo) + // def bar(): ... + + // test_err decorator_expression_py38 + // # parse_options: { "target-version": "3.8" } + // @buttons[0].clicked.connect + // def spam(): ... + + // test_err decorator_named_expression_py37 + // # parse_options: { "target-version": "3.7" } + // @(x := lambda x: x)(foo) + // def bar(): ... + + // test_err decorator_dict_literal_py38 + // # parse_options: { "target-version": "3.8" } + // @{3: 3} + // def bar(): ... + + // test_err decorator_float_literal_py38 + // # parse_options: { "target-version": "3.8" } + // @3.14 + // def bar(): ... + + // test_ok decorator_await_expression_py39 + // # parse_options: { "target-version": "3.9" } + // async def foo(): + // @await bar + // def baz(): ... + + // test_err decorator_await_expression_py38 + // # parse_options: { "target-version": "3.8" } + // async def foo(): + // @await bar + // def baz(): ... + + // test_err decorator_non_toplevel_call_expression_py38 + // # parse_options: { "target-version": "3.8" } + // @foo().bar() + // def baz(): ... + + let relaxed_decorator_error = match &parsed_expr.expr { + Expr::Call(expr_call) => { + helpers::detect_invalid_pre_py39_decorator_node(&expr_call.func) + } + expr => helpers::detect_invalid_pre_py39_decorator_node(expr), + }; + + if let Some((error, range)) = relaxed_decorator_error { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::RelaxedDecorator(error), + range, + ); + } + } + // test_err decorator_invalid_expression // @*x // @(*x) @@ -2494,7 +2822,6 @@ impl<'src> Parser<'src> { // @yield x // @yield from x // def foo(): ... - let parsed_expr = self.parse_named_expression_or_higher(ExpressionContext::default()); decorators.push(ast::Decorator { expression: parsed_expr.expr, @@ -2650,15 +2977,41 @@ impl<'src> Parser<'src> { // def foo(*args: *int or str): ... // def foo(*args: *yield x): ... // # def foo(*args: **int): ... - self.parse_conditional_expression_or_higher_impl( + let parsed_expr = self.parse_conditional_expression_or_higher_impl( ExpressionContext::starred_bitwise_or(), - ) + ); + + // test_ok param_with_star_annotation_py311 + // # parse_options: {"target-version": "3.11"} + // def foo(*args: *Ts): ... + + // test_ok param_with_star_annotation_py310 + // # parse_options: {"target-version": "3.10"} + // # regression tests for https://github.com/astral-sh/ruff/issues/16874 + // # starred parameters are fine, just not the annotation + // from typing import Annotated, Literal + // def foo(*args: Ts): ... + // def foo(*x: Literal["this should allow arbitrary strings"]): ... + // def foo(*x: Annotated[str, "this should allow arbitrary strings"]): ... + // def foo(*args: str, **kwds: int): ... + // def union(*x: A | B): ... + + // test_err param_with_star_annotation_py310 + // # parse_options: {"target-version": "3.10"} + // def foo(*args: *Ts): ... + if parsed_expr.is_starred_expr() { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::StarAnnotation, + parsed_expr.range(), + ); + } + + parsed_expr } AllowStarAnnotation::No => { // test_ok param_with_annotation // def foo(arg: int): ... // def foo(arg: lambda x: x): ... - // def foo(arg: (yield x)): ... // def foo(arg: (x := int)): ... // test_err param_with_invalid_annotation @@ -2938,6 +3291,21 @@ impl<'src> Parser<'src> { // first time, otherwise it's a user error. std::mem::swap(&mut parameters.args, &mut parameters.posonlyargs); seen_positional_only_separator = true; + + // test_ok pos_only_py38 + // # parse_options: {"target-version": "3.8"} + // def foo(a, /): ... + + // test_err pos_only_py37 + // # parse_options: {"target-version": "3.7"} + // def foo(a, /): ... + // def foo(a, /, b, /): ... + // def foo(a, *args, /, b): ... + // def foo(a, //): ... + parser.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::PositionalOnlyParameter, + slash_range, + ); } last_keyword_only_separator_range = None; @@ -2998,10 +3366,6 @@ impl<'src> Parser<'src> { parameters.range = self.node_range(start); - // test_err params_duplicate_names - // def foo(a, a=10, *a, a, a: str, **a): ... - self.validate_parameters(¶meters); - parameters } @@ -3175,6 +3539,7 @@ impl<'src> Parser<'src> { None }; + let equal_token_start = self.node_start(); let default = if self.eat(TokenKind::Equal) { if self.at_expr() { // test_err type_param_type_var_invalid_default_expr @@ -3200,6 +3565,26 @@ impl<'src> Parser<'src> { None }; + // test_ok type_param_default_py313 + // # parse_options: {"target-version": "3.13"} + // type X[T = int] = int + // def f[T = int](): ... + // class C[T = int](): ... + + // test_err type_param_default_py312 + // # parse_options: {"target-version": "3.12"} + // type X[T = int] = int + // def f[T = int](): ... + // class C[T = int](): ... + // class D[S, T = int, U = uint](): ... + + if default.is_some() { + self.add_unsupported_syntax_error( + UnsupportedSyntaxErrorKind::TypeParamDefault, + self.node_range(equal_token_start), + ); + } + ast::TypeParam::TypeVar(ast::TypeParamTypeVar { range: self.node_range(start), name, @@ -3268,25 +3653,6 @@ impl<'src> Parser<'src> { } } - /// Validate that the given parameters doesn't have any duplicate names. - /// - /// Report errors for all the duplicate names found. - fn validate_parameters(&mut self, parameters: &ast::Parameters) { - let mut all_arg_names = - FxHashSet::with_capacity_and_hasher(parameters.len(), FxBuildHasher); - - for parameter in parameters { - let range = parameter.name().range(); - let param_name = parameter.name().as_str(); - if !all_arg_names.insert(param_name) { - self.add_error( - ParseErrorType::DuplicateParameter(param_name.to_string()), - range, - ); - } - } - } - /// Classify the `match` soft keyword token. /// /// # Panics @@ -3583,12 +3949,14 @@ enum ExceptClauseKind { /// A normal except clause e.g., `except Exception as e: ...`. Normal, /// An except clause with a star e.g., `except *: ...`. - Star, + /// + /// Contains the star's [`TextRange`] for error reporting. + Star(TextRange), } impl ExceptClauseKind { const fn is_star(self) -> bool { - matches!(self, ExceptClauseKind::Star) + matches!(self, ExceptClauseKind::Star(..)) } } diff --git a/crates/ruff_python_parser/src/parser/tests.rs b/crates/ruff_python_parser/src/parser/tests.rs index 09bc41e7f7b66..778637597cfe8 100644 --- a/crates/ruff_python_parser/src/parser/tests.rs +++ b/crates/ruff_python_parser/src/parser/tests.rs @@ -1,11 +1,11 @@ -use crate::{parse, parse_expression, parse_module, Mode}; +use crate::{Mode, ParseOptions, parse, parse_expression, parse_module}; #[test] fn test_modes() { let source = "a[0][1][2][3][4]"; - assert!(parse(source, Mode::Expression).is_ok()); - assert!(parse(source, Mode::Module).is_ok()); + assert!(parse(source, ParseOptions::from(Mode::Expression)).is_ok()); + assert!(parse(source, ParseOptions::from(Mode::Module)).is_ok()); } #[test] @@ -129,7 +129,7 @@ foo.bar[0].baz[1]?? foo.bar[0].baz[2].egg?? " .trim(), - Mode::Ipython, + ParseOptions::from(Mode::Ipython), ) .unwrap(); insta::assert_debug_snapshot!(parsed.syntax()); diff --git a/crates/ruff_python_parser/src/semantic_errors.rs b/crates/ruff_python_parser/src/semantic_errors.rs new file mode 100644 index 0000000000000..0996ea4644bc1 --- /dev/null +++ b/crates/ruff_python_parser/src/semantic_errors.rs @@ -0,0 +1,1797 @@ +//! [`SemanticSyntaxChecker`] for AST-based syntax errors. +//! +//! This checker is not responsible for traversing the AST itself. Instead, its +//! [`SemanticSyntaxChecker::visit_stmt`] and [`SemanticSyntaxChecker::visit_expr`] methods should +//! be called in a parent `Visitor`'s `visit_stmt` and `visit_expr` methods, respectively. +use std::fmt::Display; + +use ruff_python_ast::{ + self as ast, Expr, ExprContext, IrrefutablePatternKind, Pattern, PythonVersion, Stmt, StmtExpr, + StmtImportFrom, + comparable::ComparableExpr, + visitor::{Visitor, walk_expr}, +}; +use ruff_text_size::{Ranged, TextRange, TextSize}; +use rustc_hash::{FxBuildHasher, FxHashSet}; + +#[derive(Debug, Default)] +pub struct SemanticSyntaxChecker { + /// The checker has traversed past the `__future__` import boundary. + /// + /// For example, the checker could be visiting `x` in: + /// + /// ```python + /// from __future__ import annotations + /// + /// import os + /// + /// x: int = 1 + /// ``` + /// + /// Python considers it a syntax error to import from `__future__` after any other + /// non-`__future__`-importing statements. + seen_futures_boundary: bool, + + /// The checker has traversed past the module docstring boundary (i.e. seen any statement in the + /// module). + seen_module_docstring_boundary: bool, +} + +impl SemanticSyntaxChecker { + pub fn new() -> Self { + Self::default() + } +} + +impl SemanticSyntaxChecker { + fn add_error<Ctx: SemanticSyntaxContext>( + context: &Ctx, + kind: SemanticSyntaxErrorKind, + range: TextRange, + ) { + context.report_semantic_error(SemanticSyntaxError { + kind, + range, + python_version: context.python_version(), + }); + } + + fn check_stmt<Ctx: SemanticSyntaxContext>(&mut self, stmt: &ast::Stmt, ctx: &Ctx) { + match stmt { + Stmt::ImportFrom(StmtImportFrom { range, module, .. }) => { + if self.seen_futures_boundary && matches!(module.as_deref(), Some("__future__")) { + Self::add_error(ctx, SemanticSyntaxErrorKind::LateFutureImport, *range); + } + } + Stmt::Match(match_stmt) => { + Self::irrefutable_match_case(match_stmt, ctx); + for case in &match_stmt.cases { + let mut visitor = MatchPatternVisitor { + names: FxHashSet::default(), + ctx, + }; + visitor.visit_pattern(&case.pattern); + } + } + Stmt::FunctionDef(ast::StmtFunctionDef { + type_params, + parameters, + .. + }) => { + if let Some(type_params) = type_params { + Self::duplicate_type_parameter_name(type_params, ctx); + } + Self::duplicate_parameter_name(parameters, ctx); + } + Stmt::ClassDef(ast::StmtClassDef { type_params, .. }) + | Stmt::TypeAlias(ast::StmtTypeAlias { type_params, .. }) => { + if let Some(type_params) = type_params { + Self::duplicate_type_parameter_name(type_params, ctx); + } + } + Stmt::Assign(ast::StmtAssign { targets, value, .. }) => { + if let [Expr::Starred(ast::ExprStarred { range, .. })] = targets.as_slice() { + // test_ok single_starred_assignment_target + // (*a,) = (1,) + // *a, = (1,) + // [*a] = (1,) + + // test_err single_starred_assignment_target + // *a = (1,) + Self::add_error( + ctx, + SemanticSyntaxErrorKind::SingleStarredAssignment, + *range, + ); + } + + // test_ok assign_stmt_starred_expr_value + // _ = 4 + // _ = [4] + // _ = (*[1],) + // _ = *[1], + + // test_err assign_stmt_starred_expr_value + // _ = *[42] + // _ = *{42} + // _ = *list() + // _ = *(p + q) + Self::invalid_star_expression(value, ctx); + } + Stmt::Return(ast::StmtReturn { value, range }) => { + if let Some(value) = value { + // test_err single_star_return + // def f(): return *x + Self::invalid_star_expression(value, ctx); + } + if !ctx.in_function_scope() { + Self::add_error(ctx, SemanticSyntaxErrorKind::ReturnOutsideFunction, *range); + } + } + Stmt::For(ast::StmtFor { + target, + iter, + is_async, + .. + }) => { + // test_err single_star_for + // for _ in *x: ... + // for *x in xs: ... + Self::invalid_star_expression(target, ctx); + Self::invalid_star_expression(iter, ctx); + if *is_async { + Self::await_outside_async_function( + ctx, + stmt, + AwaitOutsideAsyncFunctionKind::AsyncFor, + ); + } + } + Stmt::With(ast::StmtWith { is_async: true, .. }) => { + Self::await_outside_async_function( + ctx, + stmt, + AwaitOutsideAsyncFunctionKind::AsyncWith, + ); + } + Stmt::Nonlocal(ast::StmtNonlocal { range, .. }) => { + // test_ok nonlocal_declaration_at_module_level + // def _(): + // nonlocal x + + // test_err nonlocal_declaration_at_module_level + // nonlocal x + // nonlocal x, y + if ctx.in_module_scope() { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::NonlocalDeclarationAtModuleLevel, + *range, + ); + } + } + _ => {} + } + + Self::debug_shadowing(stmt, ctx); + Self::check_annotation(stmt, ctx); + } + + fn check_annotation<Ctx: SemanticSyntaxContext>(stmt: &ast::Stmt, ctx: &Ctx) { + match stmt { + Stmt::AnnAssign(ast::StmtAnnAssign { annotation, .. }) => { + if ctx.python_version() > PythonVersion::PY313 { + // test_ok valid_annotation_py313 + // # parse_options: {"target-version": "3.13"} + // a: (x := 1) + // def outer(): + // b: (yield 1) + // c: (yield from 1) + // async def outer(): + // d: (await 1) + + // test_err invalid_annotation_py314 + // # parse_options: {"target-version": "3.14"} + // a: (x := 1) + // def outer(): + // b: (yield 1) + // c: (yield from 1) + // async def outer(): + // d: (await 1) + let mut visitor = InvalidExpressionVisitor { + position: InvalidExpressionPosition::TypeAnnotation, + ctx, + }; + visitor.visit_expr(annotation); + } + } + Stmt::FunctionDef(ast::StmtFunctionDef { + type_params, + parameters, + returns, + .. + }) => { + // test_ok valid_annotation_function_py313 + // # parse_options: {"target-version": "3.13"} + // def f() -> (y := 3): ... + // def g(arg: (x := 1)): ... + // def outer(): + // def i(x: (yield 1)): ... + // def k() -> (yield 1): ... + // def m(x: (yield from 1)): ... + // def o() -> (yield from 1): ... + // async def outer(): + // def f() -> (await 1): ... + // def g(arg: (await 1)): ... + + // test_err invalid_annotation_function_py314 + // # parse_options: {"target-version": "3.14"} + // def f() -> (y := 3): ... + // def g(arg: (x := 1)): ... + // def outer(): + // def i(x: (yield 1)): ... + // def k() -> (yield 1): ... + // def m(x: (yield from 1)): ... + // def o() -> (yield from 1): ... + // async def outer(): + // def f() -> (await 1): ... + // def g(arg: (await 1)): ... + + // test_err invalid_annotation_function + // def d[T]() -> (await 1): ... + // def e[T](arg: (await 1)): ... + // def f[T]() -> (y := 3): ... + // def g[T](arg: (x := 1)): ... + // def h[T](x: (yield 1)): ... + // def j[T]() -> (yield 1): ... + // def l[T](x: (yield from 1)): ... + // def n[T]() -> (yield from 1): ... + // def p[T: (yield 1)](): ... # yield in TypeVar bound + // def q[T = (yield 1)](): ... # yield in TypeVar default + // def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default + // def s[**Ts = (yield 1)](): ... # yield in ParamSpec default + // def t[T: (x := 1)](): ... # named expr in TypeVar bound + // def u[T = (x := 1)](): ... # named expr in TypeVar default + // def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default + // def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default + // def t[T: (await 1)](): ... # await in TypeVar bound + // def u[T = (await 1)](): ... # await in TypeVar default + // def v[*Ts = (await 1)](): ... # await in TypeVarTuple default + // def w[**Ts = (await 1)](): ... # await in ParamSpec default + let mut visitor = InvalidExpressionVisitor { + position: InvalidExpressionPosition::TypeAnnotation, + ctx, + }; + if let Some(type_params) = type_params { + visitor.visit_type_params(type_params); + } + // the __future__ annotation error takes precedence over the generic error + if ctx.future_annotations_or_stub() || ctx.python_version() > PythonVersion::PY313 { + visitor.position = InvalidExpressionPosition::TypeAnnotation; + } else if type_params.is_some() { + visitor.position = InvalidExpressionPosition::GenericDefinition; + } else { + return; + } + for param in parameters + .iter() + .filter_map(ast::AnyParameterRef::annotation) + { + visitor.visit_expr(param); + } + if let Some(returns) = returns { + visitor.visit_expr(returns); + } + } + Stmt::ClassDef(ast::StmtClassDef { + type_params: Some(type_params), + arguments, + .. + }) => { + // test_ok valid_annotation_class + // class F(y := list): ... + // def f(): + // class G((yield 1)): ... + // class H((yield from 1)): ... + // async def f(): + // class G((await 1)): ... + + // test_err invalid_annotation_class + // class F[T](y := list): ... + // class I[T]((yield 1)): ... + // class J[T]((yield from 1)): ... + // class K[T: (yield 1)]: ... # yield in TypeVar + // class L[T: (x := 1)]: ... # named expr in TypeVar + // class M[T]((await 1)): ... + // class N[T: (await 1)]: ... + let mut visitor = InvalidExpressionVisitor { + position: InvalidExpressionPosition::TypeAnnotation, + ctx, + }; + visitor.visit_type_params(type_params); + if let Some(arguments) = arguments { + visitor.position = InvalidExpressionPosition::GenericDefinition; + visitor.visit_arguments(arguments); + } + } + Stmt::TypeAlias(ast::StmtTypeAlias { + type_params, value, .. + }) => { + // test_err invalid_annotation_type_alias + // type X[T: (yield 1)] = int # TypeVar bound + // type X[T = (yield 1)] = int # TypeVar default + // type X[*Ts = (yield 1)] = int # TypeVarTuple default + // type X[**Ts = (yield 1)] = int # ParamSpec default + // type Y = (yield 1) # yield in value + // type Y = (x := 1) # named expr in value + // type Y[T: (await 1)] = int # await in bound + // type Y = (await 1) # await in value + let mut visitor = InvalidExpressionVisitor { + position: InvalidExpressionPosition::TypeAlias, + ctx, + }; + visitor.visit_expr(value); + if let Some(type_params) = type_params { + visitor.visit_type_params(type_params); + } + } + _ => {} + } + } + + /// Emit a [`SemanticSyntaxErrorKind::InvalidStarExpression`] if `expr` is starred. + fn invalid_star_expression<Ctx: SemanticSyntaxContext>(expr: &Expr, ctx: &Ctx) { + // test_ok single_star_in_tuple + // def f(): yield (*x,) + // def f(): return (*x,) + // for _ in (*x,): ... + // for (*x,) in xs: ... + if expr.is_starred_expr() { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::InvalidStarExpression, + expr.range(), + ); + } + } + + /// Check for [`SemanticSyntaxErrorKind::WriteToDebug`] in `stmt`. + fn debug_shadowing<Ctx: SemanticSyntaxContext>(stmt: &ast::Stmt, ctx: &Ctx) { + match stmt { + Stmt::FunctionDef(ast::StmtFunctionDef { + name, + type_params, + parameters, + .. + }) => { + // test_err debug_shadow_function + // def __debug__(): ... # function name + // def f[__debug__](): ... # type parameter name + // def f(__debug__): ... # parameter name + Self::check_identifier(name, ctx); + if let Some(type_params) = type_params { + for type_param in type_params.iter() { + Self::check_identifier(type_param.name(), ctx); + } + } + for parameter in parameters { + Self::check_identifier(parameter.name(), ctx); + } + } + Stmt::ClassDef(ast::StmtClassDef { + name, type_params, .. + }) => { + // test_err debug_shadow_class + // class __debug__: ... # class name + // class C[__debug__]: ... # type parameter name + Self::check_identifier(name, ctx); + if let Some(type_params) = type_params { + for type_param in type_params.iter() { + Self::check_identifier(type_param.name(), ctx); + } + } + } + Stmt::TypeAlias(ast::StmtTypeAlias { + type_params: Some(type_params), + .. + }) => { + // test_err debug_shadow_type_alias + // type __debug__ = list[int] # visited as an Expr but still flagged + // type Debug[__debug__] = str + for type_param in type_params.iter() { + Self::check_identifier(type_param.name(), ctx); + } + } + Stmt::Import(ast::StmtImport { names, .. }) + | Stmt::ImportFrom(ast::StmtImportFrom { names, .. }) => { + // test_err debug_shadow_import + // import __debug__ + // import debug as __debug__ + // from x import __debug__ + // from x import debug as __debug__ + + // test_ok debug_rename_import + // import __debug__ as debug + // from __debug__ import Some + // from x import __debug__ as debug + for name in names { + match &name.asname { + Some(asname) => Self::check_identifier(asname, ctx), + None => Self::check_identifier(&name.name, ctx), + } + } + } + Stmt::Try(ast::StmtTry { handlers, .. }) => { + // test_err debug_shadow_try + // try: ... + // except Exception as __debug__: ... + for handler in handlers + .iter() + .filter_map(ast::ExceptHandler::as_except_handler) + { + if let Some(name) = &handler.name { + Self::check_identifier(name, ctx); + } + } + } + // test_err debug_shadow_with + // with open("foo.txt") as __debug__: ... + _ => {} + } + } + + /// Check if `ident` is equal to `__debug__` and emit a + /// [`SemanticSyntaxErrorKind::WriteToDebug`] if so. + fn check_identifier<Ctx: SemanticSyntaxContext>(ident: &ast::Identifier, ctx: &Ctx) { + if ident.id == "__debug__" { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::WriteToDebug(WriteToDebugKind::Store), + ident.range, + ); + } + } + + fn duplicate_type_parameter_name<Ctx: SemanticSyntaxContext>( + type_params: &ast::TypeParams, + ctx: &Ctx, + ) { + if type_params.len() < 2 { + return; + } + + for (i, type_param) in type_params.iter().enumerate() { + if type_params + .iter() + .take(i) + .any(|t| t.name().id == type_param.name().id) + { + // test_ok non_duplicate_type_parameter_names + // type Alias[T] = list[T] + // def f[T](t: T): ... + // class C[T]: ... + // class C[T, U, V]: ... + // type Alias[T, U: str, V: (str, bytes), *Ts, **P, D = default] = ... + + // test_err duplicate_type_parameter_names + // type Alias[T, T] = ... + // def f[T, T](t: T): ... + // class C[T, T]: ... + // type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... + // def f[T, T, T](): ... # two errors + // def f[T, *T](): ... # star is still duplicate + // def f[T, **T](): ... # as is double star + Self::add_error( + ctx, + SemanticSyntaxErrorKind::DuplicateTypeParameter, + type_param.range(), + ); + } + } + } + + fn duplicate_parameter_name<Ctx: SemanticSyntaxContext>( + parameters: &ast::Parameters, + ctx: &Ctx, + ) { + if parameters.len() < 2 { + return; + } + + let mut all_arg_names = + FxHashSet::with_capacity_and_hasher(parameters.len(), FxBuildHasher); + + for parameter in parameters { + let range = parameter.name().range(); + let param_name = parameter.name().as_str(); + if !all_arg_names.insert(param_name) { + // test_err params_duplicate_names + // def foo(a, a=10, *a, a, a: str, **a): ... + Self::add_error( + ctx, + SemanticSyntaxErrorKind::DuplicateParameter(param_name.to_string()), + range, + ); + } + } + } + + fn irrefutable_match_case<Ctx: SemanticSyntaxContext>(stmt: &ast::StmtMatch, ctx: &Ctx) { + // test_ok irrefutable_case_pattern_at_end + // match x: + // case 2: ... + // case var: ... + // match x: + // case 2: ... + // case _: ... + // match x: + // case var if True: ... # don't try to refute a guarded pattern + // case 2: ... + + // test_err irrefutable_case_pattern + // match x: + // case var: ... # capture pattern + // case 2: ... + // match x: + // case _: ... + // case 2: ... # wildcard pattern + // match x: + // case var1 as var2: ... # as pattern with irrefutable left-hand side + // case 2: ... + // match x: + // case enum.variant | var: ... # or pattern with irrefutable part + // case 2: ... + for case in stmt + .cases + .iter() + .rev() + .skip(1) + .filter_map(|case| match case.guard { + Some(_) => None, + None => case.pattern.irrefutable_pattern(), + }) + { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::IrrefutableCasePattern(case.kind), + case.range, + ); + } + } + + /// Check `stmt` for semantic syntax errors and update the checker's internal state. + /// + /// Note that this method should only be called when traversing `stmt` *and* its children. For + /// example, if traversal of function bodies needs to be deferred, avoid calling `visit_stmt` on + /// the function itself until the deferred body is visited too. Failing to defer `visit_stmt` in + /// this case will break any internal state that depends on function scopes, such as `async` + /// context detection. + pub fn visit_stmt<Ctx: SemanticSyntaxContext>(&mut self, stmt: &ast::Stmt, ctx: &Ctx) { + // check for errors + self.check_stmt(stmt, ctx); + + // update internal state + match stmt { + Stmt::Expr(StmtExpr { value, .. }) + if !self.seen_module_docstring_boundary && value.is_string_literal_expr() => {} + Stmt::ImportFrom(StmtImportFrom { module, .. }) => { + // Allow __future__ imports until we see a non-__future__ import. + if !matches!(module.as_deref(), Some("__future__")) { + self.seen_futures_boundary = true; + } + } + Stmt::FunctionDef(_) => { + self.seen_futures_boundary = true; + } + _ => { + self.seen_futures_boundary = true; + } + } + + self.seen_module_docstring_boundary = true; + } + + /// Check `expr` for semantic syntax errors and update the checker's internal state. + pub fn visit_expr<Ctx: SemanticSyntaxContext>(&mut self, expr: &Expr, ctx: &Ctx) { + match expr { + Expr::ListComp(ast::ExprListComp { + elt, generators, .. + }) + | Expr::SetComp(ast::ExprSetComp { + elt, generators, .. + }) => { + Self::check_generator_expr(elt, generators, ctx); + Self::async_comprehension_in_sync_comprehension(ctx, generators); + for generator in generators.iter().filter(|g| g.is_async) { + Self::await_outside_async_function( + ctx, + generator, + AwaitOutsideAsyncFunctionKind::AsyncComprehension, + ); + } + } + Expr::DictComp(ast::ExprDictComp { + key, + value, + generators, + .. + }) => { + Self::check_generator_expr(key, generators, ctx); + Self::check_generator_expr(value, generators, ctx); + Self::async_comprehension_in_sync_comprehension(ctx, generators); + for generator in generators.iter().filter(|g| g.is_async) { + Self::await_outside_async_function( + ctx, + generator, + AwaitOutsideAsyncFunctionKind::AsyncComprehension, + ); + } + } + Expr::Generator(ast::ExprGenerator { + elt, generators, .. + }) => { + Self::check_generator_expr(elt, generators, ctx); + // Note that `await_outside_async_function` is not called here because generators + // are evaluated lazily. See the note in the function for more details. + } + Expr::Name(ast::ExprName { + range, + id, + ctx: expr_ctx, + }) => { + // test_err write_to_debug_expr + // del __debug__ + // del x, y, __debug__, z + // __debug__ = 1 + // x, y, __debug__, z = 1, 2, 3, 4 + + // test_err del_debug_py39 + // # parse_options: {"target-version": "3.9"} + // del __debug__ + + // test_ok del_debug_py38 + // # parse_options: {"target-version": "3.8"} + // del __debug__ + + // test_ok read_from_debug + // if __debug__: ... + // x = __debug__ + if id == "__debug__" { + match expr_ctx { + ExprContext::Store => Self::add_error( + ctx, + SemanticSyntaxErrorKind::WriteToDebug(WriteToDebugKind::Store), + *range, + ), + ExprContext::Del => { + let version = ctx.python_version(); + if version >= PythonVersion::PY39 { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::WriteToDebug( + WriteToDebugKind::Delete(version), + ), + *range, + ); + } + } + _ => {} + } + } + + // PLE0118 + if let Some(stmt) = ctx.global(id) { + let start = stmt.start(); + if expr.start() < start { + Self::add_error( + ctx, + SemanticSyntaxErrorKind::LoadBeforeGlobalDeclaration { + name: id.to_string(), + start, + }, + expr.range(), + ); + } + } + } + Expr::Yield(ast::ExprYield { value, .. }) => { + if let Some(value) = value { + // test_err single_star_yield + // def f(): yield *x + Self::invalid_star_expression(value, ctx); + } + Self::yield_outside_function(ctx, expr, YieldOutsideFunctionKind::Yield); + } + Expr::YieldFrom(_) => { + Self::yield_outside_function(ctx, expr, YieldOutsideFunctionKind::YieldFrom); + } + Expr::Await(_) => { + Self::yield_outside_function(ctx, expr, YieldOutsideFunctionKind::Await); + Self::await_outside_async_function(ctx, expr, AwaitOutsideAsyncFunctionKind::Await); + } + Expr::Lambda(ast::ExprLambda { + parameters: Some(parameters), + .. + }) => { + Self::duplicate_parameter_name(parameters, ctx); + } + _ => {} + } + } + + /// PLE1142 + fn await_outside_async_function<Ctx: SemanticSyntaxContext, Node: Ranged>( + ctx: &Ctx, + node: Node, + kind: AwaitOutsideAsyncFunctionKind, + ) { + if ctx.in_async_context() { + return; + } + // `await` is allowed at the top level of a Jupyter notebook. + // See: https://ipython.readthedocs.io/en/stable/interactive/autoawait.html. + if ctx.in_module_scope() && ctx.in_notebook() { + return; + } + // Generators are evaluated lazily, so you can use `await` in them. For example: + // + // ```python + // # This is valid + // def f(): + // (await x for x in y) + // (x async for x in y) + // + // # This is invalid + // def f(): + // (x for x in await y) + // [await x for x in y] + // ``` + // + // This check is required in addition to avoiding calling this function in `visit_expr` + // because the generator scope applies to nested parts of the `Expr::Generator` that are + // visited separately. + if ctx.in_generator_scope() { + return; + } + Self::add_error( + ctx, + SemanticSyntaxErrorKind::AwaitOutsideAsyncFunction(kind), + node.range(), + ); + } + + /// F704 + fn yield_outside_function<Ctx: SemanticSyntaxContext>( + ctx: &Ctx, + expr: &Expr, + kind: YieldOutsideFunctionKind, + ) { + // We are intentionally not inspecting the async status of the scope for now to mimic F704. + // await-outside-async is PLE1142 instead, so we'll end up emitting both syntax errors for + // cases that trigger F704 + + if ctx.in_function_scope() { + return; + } + + if kind.is_await() { + // `await` is allowed at the top level of a Jupyter notebook. + // See: https://ipython.readthedocs.io/en/stable/interactive/autoawait.html. + if ctx.in_module_scope() && ctx.in_notebook() { + return; + } + if ctx.in_await_allowed_context() { + return; + } + } else if ctx.in_yield_allowed_context() { + return; + } + + Self::add_error( + ctx, + SemanticSyntaxErrorKind::YieldOutsideFunction(kind), + expr.range(), + ); + } + + /// Add a [`SyntaxErrorKind::ReboundComprehensionVariable`] if `expr` rebinds an iteration + /// variable in `generators`. + fn check_generator_expr<Ctx: SemanticSyntaxContext>( + expr: &Expr, + comprehensions: &[ast::Comprehension], + ctx: &Ctx, + ) { + let rebound_variables = { + let mut visitor = ReboundComprehensionVisitor { + comprehensions, + rebound_variables: Vec::new(), + }; + visitor.visit_expr(expr); + visitor.rebound_variables + }; + + // TODO(brent) with multiple diagnostic ranges, we could mark both the named expr (current) + // and the name expr being rebound + for range in rebound_variables { + // test_err rebound_comprehension_variable + // [(a := 0) for a in range(0)] + // {(a := 0) for a in range(0)} + // {(a := 0): val for a in range(0)} + // {key: (a := 0) for a in range(0)} + // ((a := 0) for a in range(0)) + // [[(a := 0)] for a in range(0)] + // [(a := 0) for b in range (0) for a in range(0)] + // [(a := 0) for a in range (0) for b in range(0)] + // [((a := 0), (b := 1)) for a in range (0) for b in range(0)] + + // test_ok non_rebound_comprehension_variable + // [a := 0 for x in range(0)] + Self::add_error( + ctx, + SemanticSyntaxErrorKind::ReboundComprehensionVariable, + range, + ); + } + } + + fn async_comprehension_in_sync_comprehension<Ctx: SemanticSyntaxContext>( + ctx: &Ctx, + generators: &[ast::Comprehension], + ) { + let python_version = ctx.python_version(); + if python_version >= PythonVersion::PY311 { + return; + } + // async allowed at notebook top-level + if ctx.in_notebook() && ctx.in_module_scope() { + return; + } + if !ctx.in_sync_comprehension() { + return; + } + for generator in generators.iter().filter(|generator| generator.is_async) { + // test_ok nested_async_comprehension_py311 + // # parse_options: {"target-version": "3.11"} + // async def f(): return [[x async for x in foo(n)] for n in range(3)] # list + // async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict + // async def h(): return [{x async for x in foo(n)} for n in range(3)] # set + + // test_ok nested_async_comprehension_py310 + // # parse_options: {"target-version": "3.10"} + // async def f(): + // [_ for n in range(3)] + // [_ async for n in range(3)] + // async def f(): + // def g(): ... + // [_ async for n in range(3)] + + // test_ok all_async_comprehension_py310 + // # parse_options: {"target-version": "3.10"} + // async def test(): return [[x async for x in elements(n)] async for n in range(3)] + + // test_err nested_async_comprehension_py310 + // # parse_options: {"target-version": "3.10"} + // async def f(): return [[x async for x in foo(n)] for n in range(3)] # list + // async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict + // async def h(): return [{x async for x in foo(n)} for n in range(3)] # set + // async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] + // async def j(): return [([y for y in range(1)], [z async for z in range(2)]) for x in range(5)] + Self::add_error( + ctx, + SemanticSyntaxErrorKind::AsyncComprehensionInSyncComprehension(python_version), + generator.range, + ); + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct SemanticSyntaxError { + pub kind: SemanticSyntaxErrorKind, + pub range: TextRange, + pub python_version: PythonVersion, +} + +impl Display for SemanticSyntaxError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match &self.kind { + SemanticSyntaxErrorKind::LateFutureImport => { + f.write_str("__future__ imports must be at the top of the file") + } + SemanticSyntaxErrorKind::ReboundComprehensionVariable => { + f.write_str("assignment expression cannot rebind comprehension variable") + } + SemanticSyntaxErrorKind::DuplicateTypeParameter => { + f.write_str("duplicate type parameter") + } + SemanticSyntaxErrorKind::MultipleCaseAssignment(name) => { + write!(f, "multiple assignments to name `{name}` in pattern") + } + SemanticSyntaxErrorKind::IrrefutableCasePattern(kind) => match kind { + // These error messages are taken from CPython's syntax errors + IrrefutablePatternKind::Name(name) => { + write!( + f, + "name capture `{name}` makes remaining patterns unreachable" + ) + } + IrrefutablePatternKind::Wildcard => { + f.write_str("wildcard makes remaining patterns unreachable") + } + }, + SemanticSyntaxErrorKind::SingleStarredAssignment => { + f.write_str("starred assignment target must be in a list or tuple") + } + SemanticSyntaxErrorKind::WriteToDebug(kind) => match kind { + WriteToDebugKind::Store => f.write_str("cannot assign to `__debug__`"), + WriteToDebugKind::Delete(python_version) => { + write!( + f, + "cannot delete `__debug__` on Python {python_version} (syntax was removed in 3.9)" + ) + } + }, + SemanticSyntaxErrorKind::InvalidExpression(kind, position) => { + write!(f, "{kind} cannot be used within a {position}") + } + SemanticSyntaxErrorKind::DuplicateMatchKey(key) => { + write!( + f, + "mapping pattern checks duplicate key `{}`", + EscapeDefault(key) + ) + } + SemanticSyntaxErrorKind::DuplicateMatchClassAttribute(name) => { + write!(f, "attribute name `{name}` repeated in class pattern",) + } + SemanticSyntaxErrorKind::LoadBeforeGlobalDeclaration { name, start: _ } => { + write!(f, "name `{name}` is used prior to global declaration") + } + SemanticSyntaxErrorKind::InvalidStarExpression => { + f.write_str("Starred expression cannot be used here") + } + SemanticSyntaxErrorKind::AsyncComprehensionInSyncComprehension(python_version) => { + write!( + f, + "cannot use an asynchronous comprehension inside of a synchronous comprehension \ + on Python {python_version} (syntax was added in 3.11)", + ) + } + SemanticSyntaxErrorKind::YieldOutsideFunction(kind) => { + write!(f, "`{kind}` statement outside of a function") + } + SemanticSyntaxErrorKind::ReturnOutsideFunction => { + f.write_str("`return` statement outside of a function") + } + SemanticSyntaxErrorKind::AwaitOutsideAsyncFunction(kind) => { + write!(f, "{kind} outside of an asynchronous function") + } + SemanticSyntaxErrorKind::DuplicateParameter(name) => { + write!(f, r#"Duplicate parameter "{name}""#) + } + SemanticSyntaxErrorKind::NonlocalDeclarationAtModuleLevel => { + write!(f, "nonlocal declaration not allowed at module level") + } + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum SemanticSyntaxErrorKind { + /// Represents the use of a `__future__` import after the beginning of a file. + /// + /// ## Examples + /// + /// ```python + /// from pathlib import Path + /// + /// from __future__ import annotations + /// ``` + /// + /// This corresponds to the [`late-future-import`] (`F404`) rule in ruff. + /// + /// [`late-future-import`]: https://docs.astral.sh/ruff/rules/late-future-import/ + LateFutureImport, + + /// Represents the rebinding of the iteration variable of a list, set, or dict comprehension or + /// a generator expression. + /// + /// ## Examples + /// + /// ```python + /// [(a := 0) for a in range(0)] + /// {(a := 0) for a in range(0)} + /// {(a := 0): val for a in range(0)} + /// {key: (a := 0) for a in range(0)} + /// ((a := 0) for a in range(0)) + /// ``` + ReboundComprehensionVariable, + + /// Represents a duplicate type parameter name in a function definition, class definition, or + /// type alias statement. + /// + /// ## Examples + /// + /// ```python + /// type Alias[T, T] = ... + /// def f[T, T](t: T): ... + /// class C[T, T]: ... + /// ``` + DuplicateTypeParameter, + + /// Represents a duplicate binding in a `case` pattern of a `match` statement. + /// + /// ## Examples + /// + /// ```python + /// match x: + /// case [x, y, x]: ... + /// case x as x: ... + /// case Class(x=1, x=2): ... + /// ``` + MultipleCaseAssignment(ast::name::Name), + + /// Represents an irrefutable `case` pattern before the last `case` in a `match` statement. + /// + /// According to the [Python reference], "a match statement may have at most one irrefutable + /// case block, and it must be last." + /// + /// ## Examples + /// + /// ```python + /// match x: + /// case value: ... # irrefutable capture pattern + /// case other: ... + /// + /// match x: + /// case _: ... # irrefutable wildcard pattern + /// case other: ... + /// ``` + /// + /// [Python reference]: https://docs.python.org/3/reference/compound_stmts.html#irrefutable-case-blocks + IrrefutableCasePattern(IrrefutablePatternKind), + + /// Represents a single starred assignment target outside of a tuple or list. + /// + /// ## Examples + /// + /// ```python + /// *a = (1,) # SyntaxError + /// ``` + /// + /// A starred assignment target can only occur within a tuple or list: + /// + /// ```python + /// b, *a = 1, 2, 3 + /// (*a,) = 1, 2, 3 + /// [*a] = 1, 2, 3 + /// ``` + SingleStarredAssignment, + + /// Represents a write to `__debug__`. This includes simple assignments and deletions as well + /// other kinds of statements that can introduce bindings, such as type parameters in functions, + /// classes, and aliases, `match` arms, and imports, among others. + /// + /// ## Examples + /// + /// ```python + /// del __debug__ + /// __debug__ = False + /// def f(__debug__): ... + /// class C[__debug__]: ... + /// ``` + /// + /// See [BPO 45000] for more information. + /// + /// [BPO 45000]: https://github.com/python/cpython/issues/89163 + WriteToDebug(WriteToDebugKind), + + /// Represents the use of an invalid expression kind in one of several locations. + /// + /// The kinds include `yield` and `yield from` expressions and named expressions, and locations + /// include type parameter bounds and defaults, type annotations, type aliases, and base class + /// lists. + /// + /// ## Examples + /// + /// ```python + /// type X[T: (yield 1)] = int + /// type Y = (yield 1) + /// def f[T](x: int) -> (y := 3): return x + /// ``` + InvalidExpression(InvalidExpressionKind, InvalidExpressionPosition), + + /// Represents a duplicate key in a `match` mapping pattern. + /// + /// The [CPython grammar] allows keys in mapping patterns to be literals or attribute accesses: + /// + /// ```text + /// key_value_pattern: + /// | (literal_expr | attr) ':' pattern + /// ``` + /// + /// But only literals are checked for duplicates: + /// + /// ```pycon + /// >>> match x: + /// ... case {"x": 1, "x": 2}: ... + /// ... + /// File "<python-input-160>", line 2 + /// case {"x": 1, "x": 2}: ... + /// ^^^^^^^^^^^^^^^^ + /// SyntaxError: mapping pattern checks duplicate key ('x') + /// >>> match x: + /// ... case {x.a: 1, x.a: 2}: ... + /// ... + /// >>> + /// ``` + /// + /// ## Examples + /// + /// ```python + /// match x: + /// case {"x": 1, "x": 2}: ... + /// ``` + /// + /// [CPython grammar]: https://docs.python.org/3/reference/grammar.html + DuplicateMatchKey(String), + + /// Represents a duplicate attribute name in a `match` class pattern. + /// + /// ## Examples + /// + /// ```python + /// match x: + /// case Class(x=1, x=2): ... + /// ``` + DuplicateMatchClassAttribute(ast::name::Name), + + /// Represents the use of a `global` variable before its `global` declaration. + /// + /// ## Examples + /// + /// ```python + /// counter = 1 + /// def increment(): + /// print(f"Adding 1 to {counter}") + /// global counter + /// counter += 1 + /// ``` + /// + /// ## Known Issues + /// + /// Note that the order in which the parts of a `try` statement are visited was changed in 3.13, + /// as tracked in Python issue [#111123]. For example, this code was valid on Python 3.12: + /// + /// ```python + /// a = 10 + /// def g(): + /// try: + /// 1 / 0 + /// except: + /// a = 1 + /// else: + /// global a + /// ``` + /// + /// While this more intuitive behavior aligned with the textual order was a syntax error: + /// + /// ```python + /// a = 10 + /// def f(): + /// try: + /// pass + /// except: + /// global a + /// else: + /// a = 1 # SyntaxError: name 'a' is assigned to before global declaration + /// ``` + /// + /// This was reversed in version 3.13 to make the second case valid and the first case a syntax + /// error. We intentionally enforce the 3.13 ordering, regardless of the Python version, which + /// will lead to both false positives and false negatives on 3.12 code that takes advantage of + /// the old behavior. However, as mentioned in the Python issue, we expect code relying on this + /// to be very rare and not worth the additional complexity to detect. + /// + /// [#111123]: https://github.com/python/cpython/issues/111123 + LoadBeforeGlobalDeclaration { name: String, start: TextSize }, + + /// Represents the use of a starred expression in an invalid location, such as a `return` or + /// `yield` statement. + /// + /// ## Examples + /// + /// ```python + /// def f(): return *x + /// def f(): yield *x + /// for _ in *x: ... + /// for *x in xs: ... + /// ``` + InvalidStarExpression, + + /// Represents the use of an asynchronous comprehension inside of a synchronous comprehension + /// before Python 3.11. + /// + /// ## Examples + /// + /// Before Python 3.11, code like this produces a syntax error because of the implicit function + /// scope introduced by the outer comprehension: + /// + /// ```python + /// async def elements(n): yield n + /// + /// async def test(): return { n: [x async for x in elements(n)] for n in range(3)} + /// ``` + /// + /// This was discussed in [BPO 33346] and fixed in Python 3.11. + /// + /// [BPO 33346]: https://github.com/python/cpython/issues/77527 + AsyncComprehensionInSyncComprehension(PythonVersion), + + /// Represents the use of `yield`, `yield from`, or `await` outside of a function scope. + /// + /// + /// ## Examples + /// + /// `yield` and `yield from` are only allowed if the immediately-enclosing scope is a function + /// or lambda and not allowed otherwise: + /// + /// ```python + /// yield 1 # error + /// + /// def f(): + /// [(yield 1) for x in y] # error + /// ``` + /// + /// `await` is additionally allowed in comprehensions, if the comprehension itself is in a + /// function scope: + /// + /// ```python + /// await 1 # error + /// + /// async def f(): + /// await 1 # okay + /// [await 1 for x in y] # also okay + /// ``` + /// + /// This last case _is_ an error, but it has to do with the lambda not being an async function. + /// For the sake of this error kind, this is okay. + /// + /// ## References + /// + /// See [PEP 255] for details on `yield`, [PEP 380] for the extension to `yield from`, [PEP 492] + /// for async-await syntax, and [PEP 530] for async comprehensions. + /// + /// [PEP 255]: https://peps.python.org/pep-0255/ + /// [PEP 380]: https://peps.python.org/pep-0380/ + /// [PEP 492]: https://peps.python.org/pep-0492/ + /// [PEP 530]: https://peps.python.org/pep-0530/ + YieldOutsideFunction(YieldOutsideFunctionKind), + + /// Represents the use of `return` outside of a function scope. + ReturnOutsideFunction, + + /// Represents the use of `await`, `async for`, or `async with` outside of an asynchronous + /// function. + /// + /// ## Examples + /// + /// ```python + /// def f(): + /// await 1 # error + /// async for x in y: ... # error + /// async with x: ... # error + /// ``` + AwaitOutsideAsyncFunction(AwaitOutsideAsyncFunctionKind), + + /// Represents a duplicate parameter name in a function or lambda expression. + /// + /// ## Examples + /// + /// ```python + /// def f(x, x): ... + /// lambda x, x: ... + /// ``` + DuplicateParameter(String), + + /// Represents a nonlocal declaration at module level + NonlocalDeclarationAtModuleLevel, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum AwaitOutsideAsyncFunctionKind { + Await, + AsyncFor, + AsyncWith, + AsyncComprehension, +} + +impl Display for AwaitOutsideAsyncFunctionKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + AwaitOutsideAsyncFunctionKind::Await => "`await`", + AwaitOutsideAsyncFunctionKind::AsyncFor => "`async for`", + AwaitOutsideAsyncFunctionKind::AsyncWith => "`async with`", + AwaitOutsideAsyncFunctionKind::AsyncComprehension => "asynchronous comprehension", + }) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum YieldOutsideFunctionKind { + Yield, + YieldFrom, + Await, +} + +impl YieldOutsideFunctionKind { + pub fn is_await(&self) -> bool { + matches!(self, Self::Await) + } +} + +impl Display for YieldOutsideFunctionKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + YieldOutsideFunctionKind::Yield => "yield", + YieldOutsideFunctionKind::YieldFrom => "yield from", + YieldOutsideFunctionKind::Await => "await", + }) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum InvalidExpressionPosition { + TypeVarBound, + TypeVarDefault, + TypeVarTupleDefault, + ParamSpecDefault, + TypeAnnotation, + GenericDefinition, + TypeAlias, +} + +impl Display for InvalidExpressionPosition { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + InvalidExpressionPosition::TypeVarBound => "TypeVar bound", + InvalidExpressionPosition::TypeVarDefault => "TypeVar default", + InvalidExpressionPosition::TypeVarTupleDefault => "TypeVarTuple default", + InvalidExpressionPosition::ParamSpecDefault => "ParamSpec default", + InvalidExpressionPosition::TypeAnnotation => "type annotation", + InvalidExpressionPosition::GenericDefinition => "generic definition", + InvalidExpressionPosition::TypeAlias => "type alias", + }) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum InvalidExpressionKind { + Yield, + NamedExpr, + Await, +} + +impl Display for InvalidExpressionKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + InvalidExpressionKind::Yield => "yield expression", + InvalidExpressionKind::NamedExpr => "named expression", + InvalidExpressionKind::Await => "await expression", + }) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum WriteToDebugKind { + Store, + Delete(PythonVersion), +} + +/// Searches for the first named expression (`x := y`) rebinding one of the `iteration_variables` in +/// a comprehension or generator expression. +struct ReboundComprehensionVisitor<'a> { + comprehensions: &'a [ast::Comprehension], + rebound_variables: Vec<TextRange>, +} + +impl Visitor<'_> for ReboundComprehensionVisitor<'_> { + fn visit_expr(&mut self, expr: &Expr) { + if let Expr::Named(ast::ExprNamed { target, .. }) = expr { + if let Expr::Name(ast::ExprName { id, range, .. }) = &**target { + if self.comprehensions.iter().any(|comp| { + comp.target + .as_name_expr() + .is_some_and(|name| name.id == *id) + }) { + self.rebound_variables.push(*range); + } + } + } + walk_expr(self, expr); + } +} + +struct MatchPatternVisitor<'a, Ctx> { + names: FxHashSet<&'a ast::name::Name>, + ctx: &'a Ctx, +} + +impl<'a, Ctx: SemanticSyntaxContext> MatchPatternVisitor<'a, Ctx> { + fn visit_pattern(&mut self, pattern: &'a Pattern) { + // test_ok class_keyword_in_case_pattern + // match 2: + // case Class(x=x): ... + + // test_err multiple_assignment_in_case_pattern + // match 2: + // case [y, z, y]: ... # MatchSequence + // case [y, z, *y]: ... # MatchSequence + // case [y, y, y]: ... # MatchSequence multiple + // case {1: x, 2: x}: ... # MatchMapping duplicate pattern + // case {1: x, **x}: ... # MatchMapping duplicate in **rest + // case Class(x, x): ... # MatchClass positional + // case Class(y=x, z=x): ... # MatchClass keyword + // case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr + // case x as x: ... # MatchAs + match pattern { + Pattern::MatchValue(_) | Pattern::MatchSingleton(_) => {} + Pattern::MatchStar(ast::PatternMatchStar { name, .. }) => { + if let Some(name) = name { + self.insert(name); + } + } + Pattern::MatchSequence(ast::PatternMatchSequence { patterns, .. }) => { + for pattern in patterns { + self.visit_pattern(pattern); + } + } + Pattern::MatchMapping(ast::PatternMatchMapping { + keys, + patterns, + rest, + .. + }) => { + for pattern in patterns { + self.visit_pattern(pattern); + } + if let Some(rest) = rest { + self.insert(rest); + } + + let mut seen = FxHashSet::default(); + for key in keys + .iter() + // complex numbers (`1 + 2j`) are allowed as keys but are not literals + // because they are represented as a `BinOp::Add` between a real number and + // an imaginary number + .filter(|key| key.is_literal_expr() || key.is_bin_op_expr()) + { + if !seen.insert(ComparableExpr::from(key)) { + let key_range = key.range(); + let duplicate_key = self.ctx.source()[key_range].to_string(); + // test_ok duplicate_match_key_attr + // match x: + // case {x.a: 1, x.a: 2}: ... + + // test_err duplicate_match_key + // match x: + // case {"x": 1, "x": 2}: ... + // case {b"x": 1, b"x": 2}: ... + // case {0: 1, 0: 2}: ... + // case {1.0: 1, 1.0: 2}: ... + // case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... + // case {True: 1, True: 2}: ... + // case {None: 1, None: 2}: ... + // case { + // """x + // y + // z + // """: 1, + // """x + // y + // z + // """: 2}: ... + // case {"x": 1, "x": 2, "x": 3}: ... + // case {0: 1, "x": 1, 0: 2, "x": 2}: ... + // case [{"x": 1, "x": 2}]: ... + // case Foo(x=1, y={"x": 1, "x": 2}): ... + // case [Foo(x=1), Foo(x=1, y={"x": 1, "x": 2})]: ... + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::DuplicateMatchKey(duplicate_key), + key_range, + ); + } + } + } + Pattern::MatchClass(ast::PatternMatchClass { arguments, .. }) => { + for pattern in &arguments.patterns { + self.visit_pattern(pattern); + } + let mut seen = FxHashSet::default(); + for keyword in &arguments.keywords { + if !seen.insert(&keyword.attr.id) { + // test_err duplicate_match_class_attr + // match x: + // case Class(x=1, x=2): ... + // case [Class(x=1, x=2)]: ... + // case {"x": x, "y": Foo(x=1, x=2)}: ... + // case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... + // case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::DuplicateMatchClassAttribute( + keyword.attr.id.clone(), + ), + keyword.attr.range, + ); + } + self.visit_pattern(&keyword.pattern); + } + } + Pattern::MatchAs(ast::PatternMatchAs { pattern, name, .. }) => { + if let Some(pattern) = pattern { + self.visit_pattern(pattern); + } + if let Some(name) = name { + self.insert(name); + } + } + Pattern::MatchOr(ast::PatternMatchOr { patterns, .. }) => { + // each of these patterns should be visited separately because patterns can only be + // duplicated within a single arm of the or pattern. For example, the case below is + // a valid pattern. + + // test_ok multiple_assignment_in_case_pattern + // match 2: + // case Class(x) | [x] | x: ... + for pattern in patterns { + let mut visitor = Self { + names: FxHashSet::default(), + ctx: self.ctx, + }; + visitor.visit_pattern(pattern); + } + } + } + } + + /// Add an identifier to the set of visited names in `self` and emit a [`SemanticSyntaxError`] + /// if `ident` has already been seen. + fn insert(&mut self, ident: &'a ast::Identifier) { + if !self.names.insert(&ident.id) { + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::MultipleCaseAssignment(ident.id.clone()), + ident.range(), + ); + } + // test_err debug_shadow_match + // match x: + // case __debug__: ... + SemanticSyntaxChecker::check_identifier(ident, self.ctx); + } +} + +struct InvalidExpressionVisitor<'a, Ctx> { + /// Context used for emitting errors. + ctx: &'a Ctx, + + position: InvalidExpressionPosition, +} + +impl<Ctx> Visitor<'_> for InvalidExpressionVisitor<'_, Ctx> +where + Ctx: SemanticSyntaxContext, +{ + fn visit_expr(&mut self, expr: &Expr) { + match expr { + Expr::Named(ast::ExprNamed { range, .. }) => { + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::InvalidExpression( + InvalidExpressionKind::NamedExpr, + self.position, + ), + *range, + ); + } + Expr::Yield(ast::ExprYield { range, .. }) + | Expr::YieldFrom(ast::ExprYieldFrom { range, .. }) => { + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::InvalidExpression( + InvalidExpressionKind::Yield, + self.position, + ), + *range, + ); + } + Expr::Await(ast::ExprAwait { range, .. }) => { + SemanticSyntaxChecker::add_error( + self.ctx, + SemanticSyntaxErrorKind::InvalidExpression( + InvalidExpressionKind::Await, + self.position, + ), + *range, + ); + } + _ => {} + } + ast::visitor::walk_expr(self, expr); + } + + fn visit_type_param(&mut self, type_param: &ast::TypeParam) { + match type_param { + ast::TypeParam::TypeVar(ast::TypeParamTypeVar { bound, default, .. }) => { + if let Some(expr) = bound { + self.position = InvalidExpressionPosition::TypeVarBound; + self.visit_expr(expr); + } + if let Some(expr) = default { + self.position = InvalidExpressionPosition::TypeVarDefault; + self.visit_expr(expr); + } + } + ast::TypeParam::TypeVarTuple(ast::TypeParamTypeVarTuple { default, .. }) => { + if let Some(expr) = default { + self.position = InvalidExpressionPosition::TypeVarTupleDefault; + self.visit_expr(expr); + } + } + ast::TypeParam::ParamSpec(ast::TypeParamParamSpec { default, .. }) => { + if let Some(expr) = default { + self.position = InvalidExpressionPosition::ParamSpecDefault; + self.visit_expr(expr); + } + } + } + } +} + +/// Information needed from a parent visitor to emit semantic syntax errors. +/// +/// Note that the `in_*_scope` methods should refer to the immediately-enclosing scope. For example, +/// `in_function_scope` should return true for this case: +/// +/// ```python +/// def f(): +/// x # here +/// ``` +/// +/// but not for this case: +/// +/// ```python +/// def f(): +/// class C: +/// x # here +/// ``` +/// +/// In contrast, the `in_*_context` methods should traverse parent scopes. For example, +/// `in_function_context` should return true for this case: +/// +/// ```python +/// def f(): +/// [x # here +/// for x in range(3)] +/// ``` +/// +/// but not here: +/// +/// ```python +/// def f(): +/// class C: +/// x # here, classes break function scopes +/// ``` +pub trait SemanticSyntaxContext { + /// Returns `true` if `__future__`-style type annotations are enabled. + fn future_annotations_or_stub(&self) -> bool; + + /// The target Python version for detecting backwards-incompatible syntax changes. + fn python_version(&self) -> PythonVersion; + + /// Returns the source text under analysis. + fn source(&self) -> &str; + + /// Return the [`TextRange`] at which a name is declared as `global` in the current scope. + fn global(&self, name: &str) -> Option<TextRange>; + + /// Returns `true` if the visitor is currently in an async context, i.e. an async function. + fn in_async_context(&self) -> bool; + + /// Returns `true` if the visitor is currently in a context where the `await` keyword is + /// allowed. + /// + /// Note that this is method is primarily used to report `YieldOutsideFunction` errors for + /// `await` outside function scopes, irrespective of their async status. As such, this differs + /// from `in_async_context` in two ways: + /// + /// 1. `await` is allowed in a lambda, despite it not being async + /// 2. `await` is allowed in any function, regardless of its async status + /// + /// In short, only nested class definitions should cause this method to return `false`, for + /// example: + /// + /// ```python + /// def f(): + /// await 1 # okay, in a function + /// class C: + /// await 1 # error + /// ``` + /// + /// See the trait-level documentation for more details. + fn in_await_allowed_context(&self) -> bool; + + /// Returns `true` if the visitor is currently in a context where `yield` and `yield from` + /// expressions are allowed. + /// + /// Yield expressions are allowed only in: + /// 1. Function definitions + /// 2. Lambda expressions + /// + /// Unlike `await`, yield is not allowed in: + /// - Comprehensions (list, set, dict) + /// - Generator expressions + /// - Class definitions + /// + /// This method should traverse parent scopes to check if the closest relevant scope + /// is a function or lambda, and that no disallowed context (class, comprehension, generator) + /// intervenes. For example: + /// + /// ```python + /// def f(): + /// yield 1 # okay, in a function + /// lambda: (yield 1) # okay, in a lambda + /// + /// [(yield 1) for x in range(3)] # error, in a comprehension + /// ((yield 1) for x in range(3)) # error, in a generator expression + /// class C: + /// yield 1 # error, in a class within a function + /// ``` + /// + fn in_yield_allowed_context(&self) -> bool; + + /// Returns `true` if the visitor is currently inside of a synchronous comprehension. + /// + /// This method is necessary because `in_async_context` only checks for the nearest, enclosing + /// function to determine the (a)sync context. Instead, this method will search all enclosing + /// scopes until it finds a sync comprehension. As a result, the two methods will typically be + /// used together. + fn in_sync_comprehension(&self) -> bool; + + /// Returns `true` if the visitor is at the top-level module scope. + fn in_module_scope(&self) -> bool; + + /// Returns `true` if the visitor is in a function scope. + fn in_function_scope(&self) -> bool; + + /// Returns `true` if the visitor is in a generator scope. + /// + /// Note that this refers to an `Expr::Generator` precisely, not to comprehensions more + /// generally. + fn in_generator_scope(&self) -> bool; + + /// Returns `true` if the source file is a Jupyter notebook. + fn in_notebook(&self) -> bool; + + fn report_semantic_error(&self, error: SemanticSyntaxError); +} + +/// Modified version of [`std::str::EscapeDefault`] that does not escape single or double quotes. +struct EscapeDefault<'a>(&'a str); + +impl Display for EscapeDefault<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + use std::fmt::Write; + + for c in self.0.chars() { + match c { + '\'' | '\"' => f.write_char(c)?, + _ => write!(f, "{}", c.escape_default())?, + } + } + Ok(()) + } +} diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__assignment.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__assignment.snap index 4a1d92e345dfb..40f35557b822d 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__assignment.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__assignment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom.snap index f8ffac258640e..2717980245281 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset.snap index ae884918e10cf..1c53c8171b846 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_source_with_offset(source, TextSize::new(7))" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset_edge.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset_edge.snap index e7376dbf3b121..5302fb97c6a5a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset_edge.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__bom_with_offset_edge.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_source_with_offset(source, TextSize::new(11))" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_mac_eol.snap index 9e3a9cee5a8a8..3e90872a528fa 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: comment_until_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_unix_eol.snap index 6b884348b1f3d..d7a257a84f991 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: comment_until_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_windows_eol.snap index fa240892394c2..5db83a7a6c308 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__comment_until_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: comment_until_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__dedent_after_whitespace.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__dedent_after_whitespace.snap index 52f55ab814a36..6b5d886d4ce64 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__dedent_after_whitespace.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__dedent_after_whitespace.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_mac_eol.snap index ccb4c9f10783f..88cc1d1d912b0 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_mac_eol.snap index 974da6fd829d6..ec925b42c665b 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_tabs_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_unix_eol.snap index 1e0460ca79639..dd7745835f9e0 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_tabs_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_windows_eol.snap index 6c431603c10ae..63dc87cdc2003 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_tabs_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_tabs_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_unix_eol.snap index 220b1d6e01f51..6a142d584bb73 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_windows_eol.snap index 3aee0e3cb69b7..cca104025a642 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__double_dedent_with_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: double_dedent_with_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__emoji_identifier.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__emoji_identifier.snap index 0a9bec6cf95b6..8912d40c32cd3 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__emoji_identifier.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__emoji_identifier.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_invalid(source, Mode::Module)" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_fstrings.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_fstrings.snap index 2e6c623f951b1..61c557e47b38d 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_fstrings.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_fstrings.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_ipython_escape_command.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_ipython_escape_command.snap index 848e576a83c3c..a66566b446f01 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_ipython_escape_command.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__empty_ipython_escape_command.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__escape_unicode_name.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__escape_unicode_name.snap index baa500ccb78b2..5e3bc9cb3b6ca 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__escape_unicode_name.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__escape_unicode_name.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring.snap index 9bb046096b514..3a56937bcc65a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_comments.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_comments.snap index 32c1e8d641f4e..dae04a5f0ca85 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_comments.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_comments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_conversion.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_conversion.snap index 134d038e21a7c..80a868327786f 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_conversion.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_conversion.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape.snap index 081742afc5376..7aae96b72fc6a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_braces.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_braces.snap index a225b449f5f40..3cfba863a21c0 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_braces.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_braces.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_raw.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_raw.snap index f0efc08a4ff16..0e14fbb35de4f 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_raw.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_escape_raw.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_expression_multiline.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_expression_multiline.snap index e3726a139cf23..c7fd18b79a8c3 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_expression_multiline.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_expression_multiline.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_multiline.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_multiline.snap index c69eddd664510..95c43f76d1184 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_multiline.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_multiline.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode.snap index 0f729e45f8b93..2ae41093603b1 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode_raw.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode_raw.snap index 3f678f2a81856..b37611f0dab32 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode_raw.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_named_unicode_raw.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_nested.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_nested.snap index 1aff2fa9086e9..de3e6d60f2777 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_nested.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_nested.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_parentheses.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_parentheses.snap index 1212187d91f06..287d62d08a42c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_parentheses.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_parentheses.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_prefix.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_prefix.snap index f134fe8d99a10..2ee601197ccff 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_prefix.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_prefix.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_mac_eol.snap index bb5f4d7597dd5..5476c1fa02ab0 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: fstring_single_quote_escape_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_unix_eol.snap index ace6850825be5..19e0346f43483 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: fstring_single_quote_escape_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_windows_eol.snap index a3b11f3d6b896..c4f595a38927c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_single_quote_escape_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: fstring_single_quote_escape_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_format_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_format_spec.snap index a4df0afe76013..400f81636f8dd 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_format_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_format_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_ipy_escape_command.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_ipy_escape_command.snap index 2ca6afe74c8d2..f48c742e6d26a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_ipy_escape_command.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_ipy_escape_command.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_lambda_expression.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_lambda_expression.snap index fedc3ab67ce2b..265afe8c79f66 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_lambda_expression.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_lambda_expression.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_multiline_format_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_multiline_format_spec.snap index a48bb8b3c2664..341455e1f2326 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_multiline_format_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_multiline_format_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_named_expression.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_named_expression.snap index d202f0fa66697..8f83f01d571ec 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_named_expression.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_named_expression.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_nul_char.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_nul_char.snap index 2620cb6cc86dd..73b431eccc1c5 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_nul_char.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__fstring_with_nul_char.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_mac_eol.snap index 60a396cb45373..9c6494542bcbb 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: indentation_with_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_unix_eol.snap index e7eda48572a91..4ffc52ad9930f 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: indentation_with_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_windows_eol.snap index d5966f6c555b4..e53ec3ae319fc 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__indentation_with_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: indentation_with_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_big.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_big.snap index 189a89b5b8f05..2b34a9903de92 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_big.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_big.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_invalid(source, Mode::Module)" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_small.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_small.snap index 50a1a1564fd46..607a466967691 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_small.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__invalid_leading_zero_small.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_invalid(source, Mode::Module)" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command.snap index 87c81113472b2..758824dcebc5a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_assignment.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_assignment.snap index 232b1d850f8b9..0466d36499202 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_assignment.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_assignment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_indentation.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_indentation.snap index add0a353641c7..ca986e3a04d8c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_indentation.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_indentation.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_mac_eol.snap index 913af5854f759..ac912f1716dfd 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_unix_eol.snap index 4710ed4bc1bcb..f6ff576adc5a8 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_windows_eol.snap index 0e9e3bde728cb..344bf237bbc3e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_mac_eol_and_eof.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_mac_eol_and_eof.snap index 1d842b60d1bc4..695022e09f44e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_mac_eol_and_eof.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_mac_eol_and_eof.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_with_eol_and_eof(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_unix_eol_and_eof.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_unix_eol_and_eof.snap index 13d4cf600fa4c..4b75406242343 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_unix_eol_and_eof.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_unix_eol_and_eof.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_with_eol_and_eof(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_windows_eol_and_eof.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_windows_eol_and_eof.snap index b70e615c07d5d..54eae10f2c31a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_windows_eol_and_eof.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_escape_command_line_continuation_with_windows_eol_and_eof.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: ipython_escape_command_line_continuation_with_eol_and_eof(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_help_end_escape_command.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_help_end_escape_command.snap index 69e13c03bd415..f4413ed56bedf 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_help_end_escape_command.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__ipython_help_end_escape_command.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_empty.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_empty.snap index 8aa9156f9f863..6cd63d62b810a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_empty.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_empty.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(&source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_long.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_long.snap index b583477cdb01b..a3cc233123083 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_long.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_long.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(&source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_single_whitespace.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_single_whitespace.snap index 0c4d6c8372ea1..ab484bbdd031a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_single_whitespace.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_single_whitespace.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(&source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_whitespace.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_whitespace.snap index f2e37aa31d803..027d1d6cafe34 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_whitespace.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_comment_whitespace.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(&source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_mac_eol.snap new file mode 100644 index 0000000000000..80e6fcfcf0777 --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_mac_eol.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof_after_newline(MAC_EOL) +--- +## Tokens +``` +[ + ( + Unknown, + 0..2, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 0..2, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_unix_eol.snap new file mode 100644 index 0000000000000..d0a13f68593c3 --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_unix_eol.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof_after_newline(UNIX_EOL) +--- +## Tokens +``` +[ + ( + Unknown, + 0..2, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 0..2, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_windows_eol.snap new file mode 100644 index 0000000000000..8001fa8ee485f --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_after_newline_windows_eol.snap @@ -0,0 +1,22 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof_after_newline(WINDOWS_EOL) +--- +## Tokens +``` +[ + ( + Unknown, + 0..3, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 0..3, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_mac_eol.snap new file mode 100644 index 0000000000000..22104ae35b450 --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_mac_eol.snap @@ -0,0 +1,36 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof(MAC_EOL) +--- +## Tokens +``` +[ + ( + Int( + 1, + ), + 0..1, + ), + ( + Comma, + 1..2, + ), + ( + Unknown, + 2..5, + ), + ( + Newline, + 5..5, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 2..5, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_unix_eol.snap new file mode 100644 index 0000000000000..8e61cceafe25e --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_unix_eol.snap @@ -0,0 +1,36 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof(UNIX_EOL) +--- +## Tokens +``` +[ + ( + Int( + 1, + ), + 0..1, + ), + ( + Comma, + 1..2, + ), + ( + Unknown, + 2..5, + ), + ( + Newline, + 5..5, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 2..5, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_windows_eol.snap new file mode 100644 index 0000000000000..bca2a7153c8db --- /dev/null +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__line_continuation_at_eof_windows_eol.snap @@ -0,0 +1,36 @@ +--- +source: crates/ruff_python_parser/src/lexer.rs +expression: line_continuation_at_eof(WINDOWS_EOL) +--- +## Tokens +``` +[ + ( + Int( + 1, + ), + 0..1, + ), + ( + Comma, + 1..2, + ), + ( + Unknown, + 2..6, + ), + ( + Newline, + 6..6, + ), +] +``` +## Errors +``` +[ + LexicalError { + error: Eof, + location: 2..6, + }, +] +``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__logical_newline_line_comment.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__logical_newline_line_comment.snap index 151f5dedd49f7..63eaf712c1706 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__logical_newline_line_comment.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__logical_newline_line_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__match_softkeyword_in_notebook.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__match_softkeyword_in_notebook.snap index a8c2f875ea84e..c27d0b2419e74 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__match_softkeyword_in_notebook.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__match_softkeyword_in_notebook.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_jupyter_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_mac_eol.snap index f9e862dc9fa37..b3b0180cf9426 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: newline_in_brackets_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_unix_eol.snap index 82230da340b53..57cf72a871a2d 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: newline_in_brackets_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_windows_eol.snap index b1901506c7525..2db482fb792ba 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__newline_in_brackets_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: newline_in_brackets_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__non_logical_newline_in_string_continuation.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__non_logical_newline_in_string_continuation.snap index 48356832bc59a..947c612cc9a9c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__non_logical_newline_in_string_continuation.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__non_logical_newline_in_string_continuation.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__numbers.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__numbers.snap index ee49b4ab2745b..f957d1f50bb8e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__numbers.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__numbers.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__operators.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__operators.snap index 3a241f6c7c0a0..3c0b9abbf4624 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__operators.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__operators.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string.snap index c045c602e2601..909c5edd9b087 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: lex_source(source) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_mac_eol.snap index 3df752853be80..47c35076b362f 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: string_continuation_with_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_unix_eol.snap index e7413d10023d6..94f8a1dbc4161 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: string_continuation_with_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_windows_eol.snap index ac945e5acee61..906eb37fafad0 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__string_continuation_with_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: string_continuation_with_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__tet_too_low_dedent.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__tet_too_low_dedent.snap index 166877fd0e188..e5dd55522e924 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__tet_too_low_dedent.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__tet_too_low_dedent.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: "lex_invalid(source, Mode::Module)" +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_mac_eol.snap index 6dcccf3fdbbc7..70820bcf5d7d3 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: triple_quoted_eol(MAC_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_unix_eol.snap index 70f9c06af3412..7b5186928154d 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: triple_quoted_eol(UNIX_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_windows_eol.snap index 8dcdd0461c476..c53f4f93fcfa5 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__lexer__tests__triple_quoted_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/lexer.rs expression: triple_quoted_eol(WINDOWS_EOL) +snapshot_kind: text --- ## Tokens ``` diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__backspace_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__backspace_alias.snap index 0de05e40c1739..84fbc3cae0ecd 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__backspace_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__backspace_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__bell_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__bell_alias.snap index 1908b77a61e40..4cfaed6c05d26 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__bell_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__bell_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__carriage_return_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__carriage_return_alias.snap index 2768101d4e242..9fce7955def23 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__carriage_return_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__carriage_return_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__character_tabulation_with_justification_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__character_tabulation_with_justification_alias.snap index 5541c02008cf6..9f6bf06e28248 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__character_tabulation_with_justification_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__character_tabulation_with_justification_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__delete_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__delete_alias.snap index ae82c459bf271..9a8831f2dbaf5 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__delete_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__delete_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__dont_panic_on_8_in_octal_escape.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__dont_panic_on_8_in_octal_escape.snap index cb104bf04527f..3fd84081eb8d9 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__dont_panic_on_8_in_octal_escape.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__dont_panic_on_8_in_octal_escape.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Assign( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__double_quoted_byte.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__double_quoted_byte.snap index 57a9e8453df3c..fd003b6a4af61 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__double_quoted_byte.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__double_quoted_byte.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_alias.snap index 5d12fcf17a4a2..d924ebd21a712 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_char_in_byte_literal.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_char_in_byte_literal.snap index 0938c2e966b0e..e830dd89ea42c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_char_in_byte_literal.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_char_in_byte_literal.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_octet.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_octet.snap index b1d9bc5d1dfc0..cf13defcb6a26 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_octet.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__escape_octet.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__form_feed_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__form_feed_alias.snap index 169580478a201..bd6d96055975e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__form_feed_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__form_feed_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_constant_range.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_constant_range.snap index 1fb97ef52c06a..99985450fdc24 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_constant_range.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_constant_range.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_character.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_character.snap index ac60d76a170db..2721f57e773e9 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_character.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_character.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_newline.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_newline.snap index 0c9226d1bc0f0..44b3a5dcad767 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_newline.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_escaped_newline.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_line_continuation.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_line_continuation.snap index c4309c2577625..898ff2d34766c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_line_continuation.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_line_continuation.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base.snap index f7b2fe35ad03c..1f21cd2286ed3 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base_more.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base_more.snap index 378a47ac0b1fb..9a6ed3225841a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base_more.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_base_more.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_format.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_format.snap index e1fe9b94f7cf0..8c786dbbd14ce 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_format.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_parse_self_documenting_format.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_unescaped_newline.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_unescaped_newline.snap index 19af05c8817fd..eedba2c8bcc06 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_unescaped_newline.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__fstring_unescaped_newline.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__hts_alias.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__hts_alias.snap index 53588d5dc85cf..c65231cc33bdf 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__hts_alias.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__hts_alias.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_byte_literal_error.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_byte_literal_error.snap index cfd2346294c99..ee80a30310a25 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_byte_literal_error.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_byte_literal_error.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: error +snapshot_kind: text --- ParseError { error: Lexical( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_literal.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_literal.snap index 05ba4616d513a..ea4afbab7e774 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_literal.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_literal.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: error +snapshot_kind: text --- ParseError { error: Lexical( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_name_error.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_name_error.snap index d657f5063d684..ce1df14dc86b2 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_name_error.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__invalid_unicode_name_error.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: error +snapshot_kind: text --- ParseError { error: Lexical( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_lbrace_error.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_lbrace_error.snap index fec204c0dffd1..5b61d84958c9e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_lbrace_error.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_lbrace_error.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: error +snapshot_kind: text --- ParseError { error: Lexical( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_rbrace_error.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_rbrace_error.snap index c052b292f5670..20927a8b12233 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_rbrace_error.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__missing_unicode_rbrace_error.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: error +snapshot_kind: text --- ParseError { error: Lexical( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_empty_fstring.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_empty_fstring.snap index 5b96c7e0fad37..ffd0191500176 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_empty_fstring.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_empty_fstring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: "parse_suite(r#\"f\"\"\"#).unwrap()" +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_1.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_1.snap index e5a9defe32cec..983da17da44fc 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_1.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_1.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_2.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_2.snap index e5a9defe32cec..983da17da44fc 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_2.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_2.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_3.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_3.snap index 80271443bf2a7..8479de9437c00 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_3.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_3.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_4.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_4.snap index db9e2af4d59a1..56a819bd717cb 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_4.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_f_string_concat_4.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring.snap index d482341170889..4ec8dc27becaf 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_equals.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_equals.snap index e543128f90b63..58821196bd95e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_equals.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_equals.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_concatenation_string_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_concatenation_string_spec.snap index 1ffe597771925..9e5b4a2fc88f7 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_concatenation_string_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_concatenation_string_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_spec.snap index 0a3252e55a2e8..28e6e4a2a1d65 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_string_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_string_spec.snap index e93879ed2e5e1..9dae288239476 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_string_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_nested_string_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_equals.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_equals.snap index 217f80fa04e35..d5884e9d75424 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_equals.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_equals.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_nested_spec.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_nested_spec.snap index 013a9e508cbf3..738b731a411e9 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_nested_spec.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_not_nested_spec.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_prec_space.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_prec_space.snap index aae76973564d3..e1d2941dc5f13 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_prec_space.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_prec_space.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_trailing_space.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_trailing_space.snap index d571a2b65a4f2..e5857594c1b45 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_trailing_space.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_self_doc_trailing_space.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_yield_expr.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_yield_expr.snap index 6f08477802bf6..3dca1cc84b74a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_yield_expr.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_fstring_yield_expr.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_concat.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_concat.snap index 916b964cc8497..11f5a0bd1f674 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_concat.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_concat.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_triple_quotes_with_kind.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_triple_quotes_with_kind.snap index 03698da5d6afc..cdf62c658ad5b 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_triple_quotes_with_kind.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_string_triple_quotes_with_kind.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_1.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_1.snap index cdea22b209b4c..2d864494e595c 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_1.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_1.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_2.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_2.snap index d4f17c4620678..e3bafd8a1f461 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_2.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_f_string_concat_2.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_1.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_1.snap index 2630c0747f0af..ea637bffc3384 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_1.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_1.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_2.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_2.snap index 6aebfcab16a3d..7748193e5befa 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_2.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__parse_u_string_concat_2.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_1.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_1.snap index aca165c1ee243..68da7f5aaa72e 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_1.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_1.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_2.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_2.snap index 283c38784b4df..6cf0a69a02074 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_2.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_byte_literal_2.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_fstring.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_fstring.snap index b82aeffc63e08..ff531b735e42a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_fstring.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__raw_fstring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__single_quoted_byte.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__single_quoted_byte.snap index 38f8bd2264f1c..921213a707749 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__single_quoted_byte.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__single_quoted_byte.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_mac_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_mac_eol.snap index 15a9ecaf44d12..67456edf4fa4a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_mac_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_mac_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_unix_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_unix_eol.snap index 15a9ecaf44d12..67456edf4fa4a 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_unix_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_unix_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_windows_eol.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_windows_eol.snap index 81cb221ae59d4..46afa1625beb9 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_windows_eol.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__string_parser_escaped_windows_eol.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs -expression: parse_ast +expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__triple_quoted_raw_fstring.snap b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__triple_quoted_raw_fstring.snap index 519c65e04cc0c..1d0ed68bc340b 100644 --- a/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__triple_quoted_raw_fstring.snap +++ b/crates/ruff_python_parser/src/snapshots/ruff_python_parser__string__tests__triple_quoted_raw_fstring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/src/string.rs expression: suite +snapshot_kind: text --- [ Expr( diff --git a/crates/ruff_python_parser/src/string.rs b/crates/ruff_python_parser/src/string.rs index e2b08d1c078d5..7ae24798e3194 100644 --- a/crates/ruff_python_parser/src/string.rs +++ b/crates/ruff_python_parser/src/string.rs @@ -125,7 +125,7 @@ impl StringParser { return Err(LexicalError::new( LexicalErrorType::UnicodeError, TextRange::empty(self.position()), - )) + )); } } } @@ -471,7 +471,7 @@ mod tests { use ruff_python_ast::Suite; use crate::error::LexicalErrorType; - use crate::{parse_module, FStringErrorType, ParseError, ParseErrorType, Parsed}; + use crate::{FStringErrorType, ParseError, ParseErrorType, Parsed, parse_module}; const WINDOWS_EOL: &str = "\r\n"; const MAC_EOL: &str = "\r"; diff --git a/crates/ruff_python_parser/src/token.rs b/crates/ruff_python_parser/src/token.rs index 9c240f4964e5b..193aecac51266 100644 --- a/crates/ruff_python_parser/src/token.rs +++ b/crates/ruff_python_parser/src/token.rs @@ -10,7 +10,7 @@ use std::fmt; use bitflags::bitflags; use ruff_python_ast::name::Name; -use ruff_python_ast::str::Quote; +use ruff_python_ast::str::{Quote, TripleQuotes}; use ruff_python_ast::str_prefix::{ AnyStringPrefix, ByteStringPrefix, FStringPrefix, StringLiteralPrefix, }; @@ -50,8 +50,7 @@ impl Token { /// /// If it isn't a string or any f-string tokens. pub fn is_triple_quoted_string(self) -> bool { - assert!(self.is_any_string()); - self.flags.is_triple_quoted() + self.unwrap_string_flags().is_triple_quoted() } /// Returns the [`Quote`] style for the current string token of any kind. @@ -60,8 +59,26 @@ impl Token { /// /// If it isn't a string or any f-string tokens. pub fn string_quote_style(self) -> Quote { - assert!(self.is_any_string()); - self.flags.quote_style() + self.unwrap_string_flags().quote_style() + } + + /// Returns the [`AnyStringFlags`] style for the current string token of any kind. + /// + /// # Panics + /// + /// If it isn't a string or any f-string tokens. + pub fn unwrap_string_flags(self) -> AnyStringFlags { + self.string_flags() + .unwrap_or_else(|| panic!("token to be a string")) + } + + /// Returns true if the current token is a string and it is raw. + pub fn string_flags(self) -> Option<AnyStringFlags> { + if self.is_any_string() { + Some(self.flags.as_any_string_flags()) + } else { + None + } } /// Returns `true` if this is any kind of string token. @@ -401,6 +418,12 @@ impl TokenKind { matches!(self, TokenKind::Comment | TokenKind::NonLogicalNewline) } + /// Returns `true` if this is a comment token. + #[inline] + pub const fn is_comment(&self) -> bool { + matches!(self, TokenKind::Comment) + } + #[inline] pub const fn is_arithmetic(self) -> bool { matches!( @@ -718,8 +741,12 @@ impl StringFlags for TokenFlags { } } - fn is_triple_quoted(self) -> bool { - self.intersects(TokenFlags::TRIPLE_QUOTED_STRING) + fn triple_quotes(self) -> TripleQuotes { + if self.intersects(TokenFlags::TRIPLE_QUOTED_STRING) { + TripleQuotes::Yes + } else { + TripleQuotes::No + } } fn prefix(self) -> AnyStringPrefix { @@ -766,11 +793,6 @@ impl TokenFlags { pub(crate) const fn is_raw_string(self) -> bool { self.intersects(TokenFlags::RAW_STRING) } - - /// Converts this type to [`AnyStringFlags`], setting the equivalent flags. - pub(crate) fn as_any_string_flags(self) -> AnyStringFlags { - AnyStringFlags::new(self.prefix(), self.quote_style(), self.is_triple_quoted()) - } } #[derive(Clone, Debug, Default)] diff --git a/crates/ruff_python_parser/src/token_source.rs b/crates/ruff_python_parser/src/token_source.rs index 4851879c89731..26088c7a1209d 100644 --- a/crates/ruff_python_parser/src/token_source.rs +++ b/crates/ruff_python_parser/src/token_source.rs @@ -1,9 +1,9 @@ use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::Mode; use crate::error::LexicalError; use crate::lexer::{Lexer, LexerCheckpoint}; use crate::token::{Token, TokenFlags, TokenKind, TokenValue}; -use crate::Mode; /// Token source for the parser that skips over any trivia tokens. #[derive(Debug)] @@ -166,6 +166,21 @@ impl<'src> TokenSource<'src> { self.tokens.truncate(tokens_position); } + /// Returns a slice of [`Token`] that are within the given `range`. + pub(crate) fn in_range(&self, range: TextRange) -> &[Token] { + let start = self + .tokens + .iter() + .rposition(|tok| tok.start() == range.start()); + let end = self.tokens.iter().rposition(|tok| tok.end() == range.end()); + + let (Some(start), Some(end)) = (start, end) else { + return &self.tokens; + }; + + &self.tokens[start..=end] + } + /// Consumes the token source, returning the collected tokens, comment ranges, and any errors /// encountered during lexing. The token collection includes both the trivia and non-trivia /// tokens. @@ -195,7 +210,7 @@ pub(crate) struct TokenSourceCheckpoint { /// of `contents`. /// /// See [#9546](https://github.com/astral-sh/ruff/pull/9546) for a more detailed explanation. -#[allow(dead_code)] +#[expect(dead_code)] fn allocate_tokens_vec(contents: &str) -> Vec<Token> { let lower_bound = contents.len().saturating_mul(15) / 100; Vec::with_capacity(lower_bound) diff --git a/crates/ruff_python_parser/src/typing.rs b/crates/ruff_python_parser/src/typing.rs index 76e25ac880bd2..e0c690c3dd70d 100644 --- a/crates/ruff_python_parser/src/typing.rs +++ b/crates/ruff_python_parser/src/typing.rs @@ -1,11 +1,10 @@ //! This module takes care of parsing a type annotation. use ruff_python_ast::relocate::relocate_expr; -use ruff_python_ast::str::raw_contents; -use ruff_python_ast::{Expr, ExprStringLiteral, ModExpression, StringFlags, StringLiteral}; +use ruff_python_ast::{Expr, ExprStringLiteral, ModExpression, StringLiteral}; use ruff_text_size::Ranged; -use crate::{parse_expression, parse_expression_range, ParseError, Parsed}; +use crate::{ParseError, Parsed, parse_expression, parse_string_annotation}; type AnnotationParseResult = Result<ParsedAnnotation, ParseError>; @@ -57,14 +56,10 @@ pub fn parse_type_annotation( string_expr: &ExprStringLiteral, source: &str, ) -> AnnotationParseResult { - let expr_text = &source[string_expr.range()]; - - if let [string_literal] = string_expr.value.as_slice() { + if let Some(string_literal) = string_expr.as_single_part_string() { // Compare the raw contents (without quotes) of the expression with the parsed contents // contained in the string literal. - if raw_contents(expr_text) - .is_some_and(|raw_contents| raw_contents == string_literal.as_str()) - { + if &source[string_literal.content_range()] == string_literal.as_str() { parse_simple_type_annotation(string_literal, source) } else { // The raw contents of the string doesn't match the parsed content. This could be the @@ -81,12 +76,8 @@ fn parse_simple_type_annotation( string_literal: &StringLiteral, source: &str, ) -> AnnotationParseResult { - let range_excluding_quotes = string_literal - .range() - .add_start(string_literal.flags.opener_len()) - .sub_end(string_literal.flags.closer_len()); Ok(ParsedAnnotation { - parsed: parse_expression_range(source, range_excluding_quotes)?, + parsed: parse_string_annotation(source, string_literal)?, kind: AnnotationKind::Simple, }) } diff --git a/crates/ruff_python_parser/tests/fixtures.rs b/crates/ruff_python_parser/tests/fixtures.rs index 893695fa94f5b..9284e312dbacb 100644 --- a/crates/ruff_python_parser/tests/fixtures.rs +++ b/crates/ruff_python_parser/tests/fixtures.rs @@ -1,14 +1,17 @@ +use std::cell::RefCell; use std::cmp::Ordering; use std::fmt::{Formatter, Write}; use std::fs; use std::path::Path; -use annotate_snippets::display_list::{DisplayList, FormatOptions}; -use annotate_snippets::snippet::{AnnotationType, Slice, Snippet, SourceAnnotation}; - -use ruff_python_ast::visitor::source_order::{walk_module, SourceOrderVisitor, TraversalSignal}; -use ruff_python_ast::{AnyNodeRef, Mod}; -use ruff_python_parser::{parse_unchecked, Mode, ParseErrorType, Token}; +use ruff_annotate_snippets::{Level, Renderer, Snippet}; +use ruff_python_ast::visitor::Visitor; +use ruff_python_ast::visitor::source_order::{SourceOrderVisitor, TraversalSignal, walk_module}; +use ruff_python_ast::{self as ast, AnyNodeRef, Mod, PythonVersion}; +use ruff_python_parser::semantic_errors::{ + SemanticSyntaxChecker, SemanticSyntaxContext, SemanticSyntaxError, +}; +use ruff_python_parser::{Mode, ParseErrorType, ParseOptions, Token, parse_unchecked}; use ruff_source_file::{LineIndex, OneIndexed, SourceCode}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; @@ -36,9 +39,12 @@ fn inline_err() { /// Snapshots the AST. fn test_valid_syntax(input_path: &Path) { let source = fs::read_to_string(input_path).expect("Expected test file to exist"); - let parsed = parse_unchecked(&source, Mode::Module); + let options = extract_options(&source).unwrap_or_else(|| { + ParseOptions::from(Mode::Module).with_target_version(PythonVersion::latest()) + }); + let parsed = parse_unchecked(&source, options.clone()); - if !parsed.is_valid() { + if parsed.has_syntax_errors() { let line_index = LineIndex::from_source_text(&source); let source_code = SourceCode::new(&source, &line_index); @@ -57,6 +63,19 @@ fn test_valid_syntax(input_path: &Path) { .unwrap(); } + for error in parsed.unsupported_syntax_errors() { + writeln!( + &mut message, + "{}\n", + CodeFrame { + range: error.range, + error: &ParseErrorType::OtherError(error.to_string()), + source_code: &source_code, + } + ) + .unwrap(); + } + panic!("{input_path:?}: {message}"); } @@ -67,6 +86,39 @@ fn test_valid_syntax(input_path: &Path) { writeln!(&mut output, "## AST").unwrap(); writeln!(&mut output, "\n```\n{:#?}\n```", parsed.syntax()).unwrap(); + let parsed = parsed.try_into_module().expect("Parsed with Mode::Module"); + + let mut visitor = + SemanticSyntaxCheckerVisitor::new(&source).with_python_version(options.target_version()); + + for stmt in parsed.suite() { + visitor.visit_stmt(stmt); + } + + let semantic_syntax_errors = visitor.into_diagnostics(); + + if !semantic_syntax_errors.is_empty() { + let mut message = "Expected no semantic syntax errors for a valid program:\n".to_string(); + + let line_index = LineIndex::from_source_text(&source); + let source_code = SourceCode::new(&source, &line_index); + + for error in semantic_syntax_errors { + writeln!( + &mut message, + "{}\n", + CodeFrame { + range: error.range, + error: &ParseErrorType::OtherError(error.to_string()), + source_code: &source_code, + } + ) + .unwrap(); + } + + panic!("{input_path:?}: {message}"); + } + insta::with_settings!({ omit_expression => true, input_file => input_path, @@ -80,12 +132,10 @@ fn test_valid_syntax(input_path: &Path) { /// Snapshots the AST and the error messages. fn test_invalid_syntax(input_path: &Path) { let source = fs::read_to_string(input_path).expect("Expected test file to exist"); - let parsed = parse_unchecked(&source, Mode::Module); - - assert!( - !parsed.is_valid(), - "{input_path:?}: Expected parser to generate at least one syntax error for a program containing syntax errors." - ); + let options = extract_options(&source).unwrap_or_else(|| { + ParseOptions::from(Mode::Module).with_target_version(PythonVersion::latest()) + }); + let parsed = parse_unchecked(&source, options.clone()); validate_tokens(parsed.tokens(), source.text_len(), input_path); validate_ast(parsed.syntax(), source.text_len(), input_path); @@ -94,11 +144,13 @@ fn test_invalid_syntax(input_path: &Path) { writeln!(&mut output, "## AST").unwrap(); writeln!(&mut output, "\n```\n{:#?}\n```", parsed.syntax()).unwrap(); - writeln!(&mut output, "## Errors\n").unwrap(); - let line_index = LineIndex::from_source_text(&source); let source_code = SourceCode::new(&source, &line_index); + if !parsed.errors().is_empty() { + writeln!(&mut output, "## Errors\n").unwrap(); + } + for error in parsed.errors() { writeln!( &mut output, @@ -112,6 +164,56 @@ fn test_invalid_syntax(input_path: &Path) { .unwrap(); } + if !parsed.unsupported_syntax_errors().is_empty() { + writeln!(&mut output, "## Unsupported Syntax Errors\n").unwrap(); + } + + for error in parsed.unsupported_syntax_errors() { + writeln!( + &mut output, + "{}\n", + CodeFrame { + range: error.range, + error: &ParseErrorType::OtherError(error.to_string()), + source_code: &source_code, + } + ) + .unwrap(); + } + + let parsed = parsed.try_into_module().expect("Parsed with Mode::Module"); + + let mut visitor = + SemanticSyntaxCheckerVisitor::new(&source).with_python_version(options.target_version()); + + for stmt in parsed.suite() { + visitor.visit_stmt(stmt); + } + + let semantic_syntax_errors = visitor.into_diagnostics(); + + assert!( + parsed.has_syntax_errors() || !semantic_syntax_errors.is_empty(), + "{input_path:?}: Expected parser to generate at least one syntax error for a program containing syntax errors." + ); + + if !semantic_syntax_errors.is_empty() { + writeln!(&mut output, "## Semantic Syntax Errors\n").unwrap(); + } + + for error in semantic_syntax_errors { + writeln!( + &mut output, + "{}\n", + CodeFrame { + range: error.range, + error: &ParseErrorType::OtherError(error.to_string()), + source_code: &source_code, + } + ) + .unwrap(); + } + insta::with_settings!({ omit_expression => true, input_file => input_path, @@ -121,23 +223,70 @@ fn test_invalid_syntax(input_path: &Path) { }); } +/// Copy of [`ParseOptions`] for deriving [`Deserialize`] with serde as a dev-dependency. +#[derive(serde::Deserialize)] +#[serde(rename_all = "kebab-case")] +struct JsonParseOptions { + #[serde(default)] + mode: JsonMode, + #[serde(default)] + target_version: PythonVersion, +} + +/// Copy of [`Mode`] for deserialization. +#[derive(Default, serde::Deserialize)] +#[serde(rename_all = "kebab-case")] +enum JsonMode { + #[default] + Module, + Expression, + ParenthesizedExpression, + Ipython, +} + +impl From<JsonParseOptions> for ParseOptions { + fn from(value: JsonParseOptions) -> Self { + let mode = match value.mode { + JsonMode::Module => Mode::Module, + JsonMode::Expression => Mode::Expression, + JsonMode::ParenthesizedExpression => Mode::ParenthesizedExpression, + JsonMode::Ipython => Mode::Ipython, + }; + Self::from(mode).with_target_version(value.target_version) + } +} + +/// Extract [`ParseOptions`] from an initial pragma line, if present. +/// +/// For example, +/// +/// ```python +/// # parse_options: { "target-version": "3.10" } +/// def f(): ... +fn extract_options(source: &str) -> Option<ParseOptions> { + let header = source.lines().next()?; + let (_label, options) = header.split_once("# parse_options: ")?; + let options: Option<JsonParseOptions> = serde_json::from_str(options.trim()).ok(); + options.map(ParseOptions::from) +} + // Test that is intentionally ignored by default. // Use it for quickly debugging a parser issue. #[test] #[ignore] -#[allow(clippy::print_stdout)] +#[expect(clippy::print_stdout)] fn parser_quick_test() { let source = "\ f'{' f'{foo!r' "; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); println!("AST:\n----\n{:#?}", parsed.syntax()); println!("Tokens:\n-------\n{:#?}", parsed.tokens()); - if !parsed.is_valid() { + if parsed.has_invalid_syntax() { println!("Errors:\n-------"); let line_index = LineIndex::from_source_text(source); @@ -203,33 +352,18 @@ impl std::fmt::Display for CodeFrame<'_> { .source_code .slice(TextRange::new(start_offset, end_offset)); - let start_char = source[TextRange::up_to(annotation_range.start())] - .chars() - .count(); - - let char_length = source[annotation_range].chars().count(); let label = format!("Syntax Error: {error}", error = self.error); - let snippet = Snippet { - title: None, - slices: vec![Slice { - source, - line_start: start_index.get(), - annotations: vec![SourceAnnotation { - label: &label, - annotation_type: AnnotationType::Error, - range: (start_char, start_char + char_length), - }], - // The origin (file name, line number, and column number) is already encoded - // in the `label`. - origin: None, - fold: false, - }], - footer: Vec::new(), - opt: FormatOptions::default(), - }; - - writeln!(f, "{message}", message = DisplayList::from(snippet)) + let span = usize::from(annotation_range.start())..usize::from(annotation_range.end()); + let annotation = Level::Error.span(span).label(&label); + let snippet = Snippet::source(source) + .line_start(start_index.get()) + .annotation(annotation) + .fold(false); + let message = Level::None.title("").snippet(snippet); + let renderer = Renderer::plain().cut_indicator("…"); + let rendered = renderer.render(message); + writeln!(f, "{rendered}") } } @@ -299,7 +433,9 @@ impl<'ast> SourceOrderVisitor<'ast> for ValidateAstVisitor<'ast> { ); if let Some(previous) = self.previous { - assert_ne!(previous.range().ordering(node.range()), Ordering::Greater, + assert_ne!( + previous.range().ordering(node.range()), + Ordering::Greater, "{path}: The ranges of the nodes are not strictly increasing when traversing the AST in pre-order.\nPrevious node: {previous:#?}\n\nCurrent node: {node:#?}\n\nRoot: {root:#?}", path = self.test_path.display(), root = self.parents.first() @@ -307,7 +443,8 @@ impl<'ast> SourceOrderVisitor<'ast> for ValidateAstVisitor<'ast> { } if let Some(parent) = self.parents.last() { - assert!(parent.range().contains_range(node.range()), + assert!( + parent.range().contains_range(node.range()), "{path}: The range of the parent node does not fully enclose the range of the child node.\nParent node: {parent:#?}\n\nChild node: {node:#?}\n\nRoot: {root:#?}", path = self.test_path.display(), root = self.parents.first() @@ -325,3 +462,189 @@ impl<'ast> SourceOrderVisitor<'ast> for ValidateAstVisitor<'ast> { self.previous = Some(node); } } + +enum Scope { + Module, + Function, + Comprehension { is_async: bool }, + Class, +} + +struct SemanticSyntaxCheckerVisitor<'a> { + checker: SemanticSyntaxChecker, + diagnostics: RefCell<Vec<SemanticSyntaxError>>, + python_version: PythonVersion, + source: &'a str, + scopes: Vec<Scope>, +} + +impl<'a> SemanticSyntaxCheckerVisitor<'a> { + fn new(source: &'a str) -> Self { + Self { + checker: SemanticSyntaxChecker::new(), + diagnostics: RefCell::default(), + python_version: PythonVersion::default(), + source, + scopes: vec![Scope::Module], + } + } + + #[must_use] + fn with_python_version(mut self, python_version: PythonVersion) -> Self { + self.python_version = python_version; + self + } + + fn into_diagnostics(self) -> Vec<SemanticSyntaxError> { + self.diagnostics.into_inner() + } + + fn with_semantic_checker(&mut self, f: impl FnOnce(&mut SemanticSyntaxChecker, &Self)) { + let mut checker = std::mem::take(&mut self.checker); + f(&mut checker, self); + self.checker = checker; + } +} + +impl SemanticSyntaxContext for SemanticSyntaxCheckerVisitor<'_> { + fn future_annotations_or_stub(&self) -> bool { + false + } + + fn python_version(&self) -> PythonVersion { + self.python_version + } + + fn report_semantic_error(&self, error: SemanticSyntaxError) { + self.diagnostics.borrow_mut().push(error); + } + + fn source(&self) -> &str { + self.source + } + + fn global(&self, _name: &str) -> Option<TextRange> { + None + } + + fn in_async_context(&self) -> bool { + true + } + + fn in_sync_comprehension(&self) -> bool { + for scope in &self.scopes { + if let Scope::Comprehension { is_async: false } = scope { + return true; + } + } + false + } + + fn in_module_scope(&self) -> bool { + self.scopes.len() == 1 + } + + fn in_function_scope(&self) -> bool { + true + } + + fn in_notebook(&self) -> bool { + false + } + + fn in_await_allowed_context(&self) -> bool { + true + } + + fn in_yield_allowed_context(&self) -> bool { + true + } + + fn in_generator_scope(&self) -> bool { + true + } +} + +impl Visitor<'_> for SemanticSyntaxCheckerVisitor<'_> { + fn visit_stmt(&mut self, stmt: &ast::Stmt) { + self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context)); + match stmt { + ast::Stmt::ClassDef(ast::StmtClassDef { + arguments, + body, + decorator_list, + type_params, + .. + }) => { + for decorator in decorator_list { + self.visit_decorator(decorator); + } + if let Some(type_params) = type_params { + self.visit_type_params(type_params); + } + if let Some(arguments) = arguments { + self.visit_arguments(arguments); + } + self.scopes.push(Scope::Class); + self.visit_body(body); + self.scopes.pop().unwrap(); + } + ast::Stmt::FunctionDef(ast::StmtFunctionDef { .. }) => { + self.scopes.push(Scope::Function); + ast::visitor::walk_stmt(self, stmt); + self.scopes.pop().unwrap(); + } + _ => { + ast::visitor::walk_stmt(self, stmt); + } + } + } + + fn visit_expr(&mut self, expr: &ast::Expr) { + self.with_semantic_checker(|semantic, context| semantic.visit_expr(expr, context)); + match expr { + ast::Expr::Lambda(_) => { + self.scopes.push(Scope::Function); + ast::visitor::walk_expr(self, expr); + self.scopes.pop().unwrap(); + } + ast::Expr::ListComp(ast::ExprListComp { + elt, generators, .. + }) + | ast::Expr::SetComp(ast::ExprSetComp { + elt, generators, .. + }) + | ast::Expr::Generator(ast::ExprGenerator { + elt, generators, .. + }) => { + for comprehension in generators { + self.visit_comprehension(comprehension); + } + self.scopes.push(Scope::Comprehension { + is_async: generators.iter().any(|generator| generator.is_async), + }); + self.visit_expr(elt); + self.scopes.pop().unwrap(); + } + ast::Expr::DictComp(ast::ExprDictComp { + key, + value, + generators, + .. + }) => { + for comprehension in generators { + self.visit_comprehension(comprehension); + } + self.scopes.push(Scope::Comprehension { + is_async: generators.iter().any(|generator| generator.is_async), + }); + self.visit_expr(key); + self.visit_expr(value); + self.scopes.pop().unwrap(); + } + _ => { + ast::visitor::walk_expr(self, expr); + } + } + } +} diff --git a/crates/ruff_python_parser/tests/generate_inline_tests.rs b/crates/ruff_python_parser/tests/generate_inline_tests.rs index 7f71d74717e3b..908f7c6337a5d 100644 --- a/crates/ruff_python_parser/tests/generate_inline_tests.rs +++ b/crates/ruff_python_parser/tests/generate_inline_tests.rs @@ -22,7 +22,7 @@ fn project_root() -> PathBuf { #[test] fn generate_inline_tests() -> Result<()> { - let parser_dir = project_root().join("crates/ruff_python_parser/src/parser"); + let parser_dir = project_root().join("crates/ruff_python_parser/src/"); let tests = TestCollection::try_from(parser_dir.as_path())?; let mut test_files = TestFiles::default(); diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_annotation.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_annotation.py.snap index 79252b34afdbd..76f99c4e88020 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_annotation.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_annotation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/ann_assign_stmt_invalid_annotation.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_target.py.snap index 2807b901727b5..9bd4841679c93 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/ann_assign_stmt_invalid_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_value.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_value.py.snap index 714c5d29f5524..f37b524ee3717 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_value.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_invalid_value.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/ann_assign_stmt_invalid_value.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_missing_rhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_missing_rhs.py.snap index 96a57dfeb1525..dfd20d1d11e07 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_missing_rhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_missing_rhs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/ann_assign_stmt_missing_rhs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_type_alias_annotation.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_type_alias_annotation.py.snap index f94c3c08e6b63..304d630374a0a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_type_alias_annotation.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@ann_assign_stmt_type_alias_annotation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/ann_assign_stmt_type_alias_annotation.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@args_unparenthesized_generator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@args_unparenthesized_generator.py.snap index 653de136451b2..b4050ccf1348f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@args_unparenthesized_generator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@args_unparenthesized_generator.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/inline/err/args_unparenthesized_ ``` Module( ModModule { - range: 0..65, + range: 0..92, body: [ Expr( StmtExpr { @@ -193,6 +193,82 @@ Module( ), }, ), + Expr( + StmtExpr { + range: 65..91, + value: Call( + ExprCall { + range: 65..91, + func: Name( + ExprName { + range: 65..68, + id: Name("sum"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 68..91, + args: [ + Generator( + ExprGenerator { + range: 69..89, + elt: Name( + ExprName { + range: 69..70, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 71..89, + target: Name( + ExprName { + range: 75..76, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 80..89, + func: Name( + ExprName { + range: 80..85, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 85..89, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 86..88, + value: Int( + 10, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: false, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ), ], }, ) @@ -203,6 +279,7 @@ Module( 1 | sum(x for x in range(10), 5) | ^^^^^^^^^^^^^^^^^^^^ Syntax Error: Unparenthesized generator expression cannot be used here 2 | total(1, 2, x for x in range(5), 6) +3 | sum(x for x in range(10),) | @@ -210,4 +287,13 @@ Module( 1 | sum(x for x in range(10), 5) 2 | total(1, 2, x for x in range(5), 6) | ^^^^^^^^^^^^^^^^^^^ Syntax Error: Unparenthesized generator expression cannot be used here +3 | sum(x for x in range(10),) + | + + + | +1 | sum(x for x in range(10), 5) +2 | total(1, 2, x for x in range(5), 6) +3 | sum(x for x in range(10),) + | ^^^^^^^^^^^^^^^^^^^^ Syntax Error: Unparenthesized generator expression cannot be used here | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_msg.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_msg.py.snap index 2b54821ece7f1..0de6bbd3f82f9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_msg.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_msg.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assert_empty_msg.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_test.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_test.py.snap index 14ef5d77dbb3e..24dfb690d2c7d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_test.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_empty_test.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assert_empty_test.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_msg_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_msg_expr.py.snap index e2966c3197e1c..557cbe6bf3f37 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_msg_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_msg_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assert_invalid_msg_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_test_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_test_expr.py.snap index 5135617f8187a..afe4aca2ba14c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_test_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assert_invalid_test_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assert_invalid_test_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_target.py.snap index 98770afc2fbc4..8f47b9c0422d7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_value_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_value_expr.py.snap index 3dd710665ea47..78ea01ad7e616 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_value_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_invalid_value_expr.py.snap @@ -7,11 +7,11 @@ input_file: crates/ruff_python_parser/resources/inline/err/assign_stmt_invalid_v ``` Module( ModModule { - range: 0..72, + range: 0..90, body: [ Assign( StmtAssign { - range: 0..12, + range: 0..15, targets: [ Name( ExprName { @@ -21,164 +21,216 @@ Module( }, ), ], - value: Starred( - ExprStarred { - range: 4..12, - value: BoolOp( - ExprBoolOp { - range: 5..12, - op: And, - values: [ - Name( - ExprName { - range: 5..6, - id: Name("a"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 11..12, - id: Name("b"), - ctx: Load, + value: Tuple( + ExprTuple { + range: 4..15, + elts: [ + Starred( + ExprStarred { + range: 5..13, + value: BoolOp( + ExprBoolOp { + range: 6..13, + op: And, + values: [ + Name( + ExprName { + range: 6..7, + id: Name("a"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 12..13, + id: Name("b"), + ctx: Load, + }, + ), + ], }, ), - ], - }, - ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 13..25, + range: 16..34, targets: [ Name( ExprName { - range: 13..14, + range: 16..17, id: Name("x"), ctx: Store, }, ), ], - value: Starred( - ExprStarred { - range: 17..25, - value: Yield( - ExprYield { - range: 18..25, - value: Some( - Name( - ExprName { - range: 24..25, - id: Name("x"), - ctx: Load, + value: Tuple( + ExprTuple { + range: 20..34, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 21..23, + value: Int( + 42, + ), + }, + ), + Starred( + ExprStarred { + range: 25..33, + value: Yield( + ExprYield { + range: 26..33, + value: Some( + Name( + ExprName { + range: 32..33, + id: Name("x"), + ctx: Load, + }, + ), + ), }, ), - ), - }, - ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 26..43, + range: 35..58, targets: [ Name( ExprName { - range: 26..27, + range: 35..36, id: Name("x"), ctx: Store, }, ), ], - value: Starred( - ExprStarred { - range: 30..43, - value: YieldFrom( - ExprYieldFrom { - range: 31..43, - value: Name( - ExprName { - range: 42..43, - id: Name("x"), - ctx: Load, - }, - ), - }, - ), + value: Tuple( + ExprTuple { + range: 39..58, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 40..42, + value: Int( + 42, + ), + }, + ), + Starred( + ExprStarred { + range: 44..57, + value: YieldFrom( + ExprYieldFrom { + range: 45..57, + value: Name( + ExprName { + range: 56..57, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 44..60, + range: 59..78, targets: [ Name( ExprName { - range: 44..45, + range: 59..60, id: Name("x"), ctx: Store, }, ), ], - value: Starred( - ExprStarred { - range: 48..60, - value: Lambda( - ExprLambda { - range: 49..60, - parameters: Some( - Parameters { - range: 56..57, - posonlyargs: [], - args: [ - ParameterWithDefault { - range: 56..57, - parameter: Parameter { - range: 56..57, - name: Identifier { - id: Name("x"), - range: 56..57, - }, - annotation: None, + value: Tuple( + ExprTuple { + range: 63..78, + elts: [ + Starred( + ExprStarred { + range: 64..76, + value: Lambda( + ExprLambda { + range: 65..76, + parameters: Some( + Parameters { + range: 72..73, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 72..73, + parameter: Parameter { + range: 72..73, + name: Identifier { + id: Name("x"), + range: 72..73, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, }, - default: None, - }, - ], - vararg: None, - kwonlyargs: [], - kwarg: None, - }, - ), - body: Name( - ExprName { - range: 59..60, - id: Name("x"), - ctx: Load, - }, - ), - }, - ), + ), + body: Name( + ExprName { + range: 75..76, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 61..66, + range: 79..84, targets: [ Name( ExprName { - range: 61..62, + range: 79..80, id: Name("x"), ctx: Store, }, @@ -186,7 +238,7 @@ Module( ], value: Name( ExprName { - range: 65..66, + range: 83..84, id: Name("x"), ctx: Load, }, @@ -195,10 +247,10 @@ Module( ), Expr( StmtExpr { - range: 70..71, + range: 88..89, value: NumberLiteral( ExprNumberLiteral { - range: 70..71, + range: 88..89, value: Int( 1, ), @@ -213,44 +265,44 @@ Module( ## Errors | -1 | x = *a and b - | ^^^^^^^ Syntax Error: Boolean expression cannot be used here -2 | x = *yield x -3 | x = *yield from x +1 | x = (*a and b,) + | ^^^^^^^ Syntax Error: Boolean expression cannot be used here +2 | x = (42, *yield x) +3 | x = (42, *yield from x) | | -1 | x = *a and b -2 | x = *yield x - | ^^^^^^^ Syntax Error: Yield expression cannot be used here -3 | x = *yield from x -4 | x = *lambda x: x +1 | x = (*a and b,) +2 | x = (42, *yield x) + | ^^^^^^^ Syntax Error: Yield expression cannot be used here +3 | x = (42, *yield from x) +4 | x = (*lambda x: x,) | | -1 | x = *a and b -2 | x = *yield x -3 | x = *yield from x - | ^^^^^^^^^^^^ Syntax Error: Yield expression cannot be used here -4 | x = *lambda x: x +1 | x = (*a and b,) +2 | x = (42, *yield x) +3 | x = (42, *yield from x) + | ^^^^^^^^^^^^ Syntax Error: Yield expression cannot be used here +4 | x = (*lambda x: x,) 5 | x = x := 1 | | -2 | x = *yield x -3 | x = *yield from x -4 | x = *lambda x: x - | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here +2 | x = (42, *yield x) +3 | x = (42, *yield from x) +4 | x = (*lambda x: x,) + | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here 5 | x = x := 1 | | -3 | x = *yield from x -4 | x = *lambda x: x +3 | x = (42, *yield from x) +4 | x = (*lambda x: x,) 5 | x = x := 1 | ^^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_keyword_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_keyword_target.py.snap index 262d2032216fc..0ed0320576257 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_keyword_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_keyword_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assign_stmt_keyword_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_missing_rhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_missing_rhs.py.snap index 0622530818dff..35e1921645262 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_missing_rhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_missing_rhs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/assign_stmt_missing_rhs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_starred_expr_value.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_starred_expr_value.py.snap new file mode 100644 index 0000000000000..220f6e607436a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@assign_stmt_starred_expr_value.py.snap @@ -0,0 +1,197 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/assign_stmt_starred_expr_value.py +--- +## AST + +``` +Module( + ModModule { + range: 0..45, + body: [ + Assign( + StmtAssign { + range: 0..9, + targets: [ + Name( + ExprName { + range: 0..1, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Starred( + ExprStarred { + range: 4..9, + value: List( + ExprList { + range: 5..9, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 6..8, + value: Int( + 42, + ), + }, + ), + ], + ctx: Load, + }, + ), + ctx: Load, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 10..19, + targets: [ + Name( + ExprName { + range: 10..11, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Starred( + ExprStarred { + range: 14..19, + value: Set( + ExprSet { + range: 15..19, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 16..18, + value: Int( + 42, + ), + }, + ), + ], + }, + ), + ctx: Load, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 20..31, + targets: [ + Name( + ExprName { + range: 20..21, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Starred( + ExprStarred { + range: 24..31, + value: Call( + ExprCall { + range: 25..31, + func: Name( + ExprName { + range: 25..29, + id: Name("list"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 29..31, + args: [], + keywords: [], + }, + }, + ), + ctx: Load, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 32..44, + targets: [ + Name( + ExprName { + range: 32..33, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Starred( + ExprStarred { + range: 36..44, + value: BinOp( + ExprBinOp { + range: 38..43, + left: Name( + ExprName { + range: 38..39, + id: Name("p"), + ctx: Load, + }, + ), + op: Add, + right: Name( + ExprName { + range: 42..43, + id: Name("q"), + ctx: Load, + }, + ), + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | _ = *[42] + | ^^^^^ Syntax Error: Starred expression cannot be used here +2 | _ = *{42} +3 | _ = *list() + | + + + | +1 | _ = *[42] +2 | _ = *{42} + | ^^^^^ Syntax Error: Starred expression cannot be used here +3 | _ = *list() +4 | _ = *(p + q) + | + + + | +1 | _ = *[42] +2 | _ = *{42} +3 | _ = *list() + | ^^^^^^^ Syntax Error: Starred expression cannot be used here +4 | _ = *(p + q) + | + + + | +2 | _ = *{42} +3 | _ = *list() +4 | _ = *(p + q) + | ^^^^^^^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@async_unexpected_token.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@async_unexpected_token.py.snap index fb98de4ff4197..678e667d880d7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@async_unexpected_token.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@async_unexpected_token.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/async_unexpected_token.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_target.py.snap index e70d651f0e166..17b749427a549 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/aug_assign_stmt_invalid_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_value.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_value.py.snap index 84441297a0e97..cd6e0380f9566 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_value.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_invalid_value.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/aug_assign_stmt_invalid_value.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_missing_rhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_missing_rhs.py.snap index 36e0931320811..d2ba825987081 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_missing_rhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@aug_assign_stmt_missing_rhs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/aug_assign_stmt_missing_rhs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@case_expect_indented_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@case_expect_indented_block.py.snap index 9e736f17352f1..48c0bba70c1fe 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@case_expect_indented_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@case_expect_indented_block.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/case_expect_indented_block.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_empty_body.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_empty_body.py.snap index 2e9bbb95f4277..29be135fec38d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_empty_body.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_empty_body.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/class_def_empty_body.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_missing_name.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_missing_name.py.snap index a6a65bf577c8f..05c4ed0abcc3b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_missing_name.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_missing_name.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/class_def_missing_name.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_unclosed_type_param_list.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_unclosed_type_param_list.py.snap index 039c40e65e199..bcbd8a0224d82 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_unclosed_type_param_list.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_def_unclosed_type_param_list.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/class_def_unclosed_type_param_list.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_type_params_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_type_params_py311.py.snap new file mode 100644 index 0000000000000..60c7fd49741e2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@class_type_params_py311.py.snap @@ -0,0 +1,174 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/class_type_params_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..113, + body: [ + ClassDef( + StmtClassDef { + range: 44..95, + decorator_list: [], + name: Identifier { + id: Name("Foo"), + range: 50..53, + }, + type_params: Some( + TypeParams { + range: 53..90, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 54..69, + name: Identifier { + id: Name("S"), + range: 54..55, + }, + bound: Some( + Tuple( + ExprTuple { + range: 57..69, + elts: [ + Name( + ExprName { + range: 58..61, + id: Name("str"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 63..68, + id: Name("bytes"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 71..79, + name: Identifier { + id: Name("T"), + range: 71..72, + }, + bound: Some( + Name( + ExprName { + range: 74..79, + id: Name("float"), + ctx: Load, + }, + ), + ), + default: None, + }, + ), + TypeVarTuple( + TypeParamTypeVarTuple { + range: 81..84, + name: Identifier { + id: Name("Ts"), + range: 82..84, + }, + default: None, + }, + ), + ParamSpec( + TypeParamParamSpec { + range: 86..89, + name: Identifier { + id: Name("P"), + range: 88..89, + }, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 92..95, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 92..95, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 96..112, + decorator_list: [], + name: Identifier { + id: Name("Foo"), + range: 102..105, + }, + type_params: Some( + TypeParams { + range: 105..107, + type_params: [], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 109..112, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 109..112, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | class Foo[S: (str, bytes), T: float, *Ts, **P]: ... +3 | class Foo[]: ... + | ^ Syntax Error: Type parameter list cannot be empty + | + + +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | class Foo[S: (str, bytes), T: float, *Ts, **P]: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Syntax Error: Cannot use type parameter lists on Python 3.11 (syntax was added in Python 3.12) +3 | class Foo[]: ... + | + + + | +1 | # parse_options: {"target-version": "3.11"} +2 | class Foo[S: (str, bytes), T: float, *Ts, **P]: ... +3 | class Foo[]: ... + | ^^ Syntax Error: Cannot use type parameter lists on Python 3.11 (syntax was added in Python 3.12) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_indented_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_indented_block.py.snap index 5290039f5e0c4..44bc4b2b510a6 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_indented_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_indented_block.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/clause_expect_indented_block.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_single_statement.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_single_statement.py.snap index e7068ac10fc02..6ed8d3277491b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_single_statement.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@clause_expect_single_statement.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/clause_expect_single_statement.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma.py.snap index 035ba2045cd20..fee330ecc28b2 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/comma_separated_missing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma_between_elements.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma_between_elements.py.snap index 78474e6cbb8b5..39ffd3982ff4c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma_between_elements.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_comma_between_elements.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/comma_separated_missing_comma_between_elements.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_element_between_commas.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_element_between_commas.py.snap index c68307d59f079..799432dc3f042 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_element_between_commas.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_element_between_commas.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/comma_separated_missing_element_between_commas.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_first_element.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_first_element.py.snap index 65bb9f79c9684..59fb82a1e5c4d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_first_element.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comma_separated_missing_first_element.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/comma_separated_missing_first_element.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comprehension_missing_for_after_async.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comprehension_missing_for_after_async.py.snap index 57fa3e1227f36..8713ae5f80d9e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comprehension_missing_for_after_async.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@comprehension_missing_for_after_async.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/comprehension_missing_for_after_async.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_class.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_class.py.snap new file mode 100644 index 0000000000000..251a2c6c28119 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_class.py.snap @@ -0,0 +1,94 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_class.py +--- +## AST + +``` +Module( + ModModule { + range: 0..82, + body: [ + ClassDef( + StmtClassDef { + range: 0..20, + decorator_list: [], + name: Identifier { + id: Name("__debug__"), + range: 6..15, + }, + type_params: None, + arguments: None, + body: [ + Expr( + StmtExpr { + range: 17..20, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 17..20, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 35..58, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 41..42, + }, + type_params: Some( + TypeParams { + range: 42..53, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 43..52, + name: Identifier { + id: Name("__debug__"), + range: 43..52, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 55..58, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 55..58, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | class __debug__: ... # class name + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +2 | class C[__debug__]: ... # type parameter name + | + + + | +1 | class __debug__: ... # class name +2 | class C[__debug__]: ... # type parameter name + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_function.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_function.py.snap new file mode 100644 index 0000000000000..517c64d7fb58b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_function.py.snap @@ -0,0 +1,168 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_function.py +--- +## AST + +``` +Module( + ModModule { + range: 0..125, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..20, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("__debug__"), + range: 4..13, + }, + type_params: None, + parameters: Parameters { + range: 13..15, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 17..20, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 17..20, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 38..61, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 42..43, + }, + type_params: Some( + TypeParams { + range: 43..54, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 44..53, + name: Identifier { + id: Name("__debug__"), + range: 44..53, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 54..56, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 85..106, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 89..90, + }, + type_params: None, + parameters: Parameters { + range: 90..101, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 91..100, + parameter: Parameter { + range: 91..100, + name: Identifier { + id: Name("__debug__"), + range: 91..100, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 103..106, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 103..106, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | def __debug__(): ... # function name + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +2 | def f[__debug__](): ... # type parameter name +3 | def f(__debug__): ... # parameter name + | + + + | +1 | def __debug__(): ... # function name +2 | def f[__debug__](): ... # type parameter name + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +3 | def f(__debug__): ... # parameter name + | + + + | +1 | def __debug__(): ... # function name +2 | def f[__debug__](): ... # type parameter name +3 | def f(__debug__): ... # parameter name + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_import.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_import.py.snap new file mode 100644 index 0000000000000..9cbb40853132a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_import.py.snap @@ -0,0 +1,133 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_import.py +--- +## AST + +``` +Module( + ModModule { + range: 0..100, + body: [ + Import( + StmtImport { + range: 0..16, + names: [ + Alias { + range: 7..16, + name: Identifier { + id: Name("__debug__"), + range: 7..16, + }, + asname: None, + }, + ], + }, + ), + Import( + StmtImport { + range: 17..42, + names: [ + Alias { + range: 24..42, + name: Identifier { + id: Name("debug"), + range: 24..29, + }, + asname: Some( + Identifier { + id: Name("__debug__"), + range: 33..42, + }, + ), + }, + ], + }, + ), + ImportFrom( + StmtImportFrom { + range: 43..66, + module: Some( + Identifier { + id: Name("x"), + range: 48..49, + }, + ), + names: [ + Alias { + range: 57..66, + name: Identifier { + id: Name("__debug__"), + range: 57..66, + }, + asname: None, + }, + ], + level: 0, + }, + ), + ImportFrom( + StmtImportFrom { + range: 67..99, + module: Some( + Identifier { + id: Name("x"), + range: 72..73, + }, + ), + names: [ + Alias { + range: 81..99, + name: Identifier { + id: Name("debug"), + range: 81..86, + }, + asname: Some( + Identifier { + id: Name("__debug__"), + range: 90..99, + }, + ), + }, + ], + level: 0, + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | import __debug__ + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +2 | import debug as __debug__ +3 | from x import __debug__ + | + + + | +1 | import __debug__ +2 | import debug as __debug__ + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +3 | from x import __debug__ +4 | from x import debug as __debug__ + | + + + | +1 | import __debug__ +2 | import debug as __debug__ +3 | from x import __debug__ + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +4 | from x import debug as __debug__ + | + + + | +2 | import debug as __debug__ +3 | from x import __debug__ +4 | from x import debug as __debug__ + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_match.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_match.py.snap new file mode 100644 index 0000000000000..2b23fee0c414a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_match.py.snap @@ -0,0 +1,64 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_match.py +--- +## AST + +``` +Module( + ModModule { + range: 0..33, + body: [ + Match( + StmtMatch { + range: 0..32, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..32, + pattern: MatchAs( + PatternMatchAs { + range: 18..27, + pattern: None, + name: Some( + Identifier { + id: Name("__debug__"), + range: 18..27, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 29..32, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 29..32, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | match x: +2 | case __debug__: ... + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_try.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_try.py.snap new file mode 100644 index 0000000000000..d965f5306a693 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_try.py.snap @@ -0,0 +1,76 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_try.py +--- +## AST + +``` +Module( + ModModule { + range: 0..44, + body: [ + Try( + StmtTry { + range: 0..43, + body: [ + Expr( + StmtExpr { + range: 5..8, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 5..8, + }, + ), + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 9..43, + type_: Some( + Name( + ExprName { + range: 16..25, + id: Name("Exception"), + ctx: Load, + }, + ), + ), + name: Some( + Identifier { + id: Name("__debug__"), + range: 29..38, + }, + ), + body: [ + Expr( + StmtExpr { + range: 40..43, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 40..43, + }, + ), + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | try: ... +2 | except Exception as __debug__: ... + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_type_alias.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_type_alias.py.snap new file mode 100644 index 0000000000000..2817caa8c4c1e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_type_alias.py.snap @@ -0,0 +1,99 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_type_alias.py +--- +## AST + +``` +Module( + ModModule { + range: 0..95, + body: [ + TypeAlias( + StmtTypeAlias { + range: 0..26, + name: Name( + ExprName { + range: 5..14, + id: Name("__debug__"), + ctx: Store, + }, + ), + type_params: None, + value: Subscript( + ExprSubscript { + range: 17..26, + value: Name( + ExprName { + range: 17..21, + id: Name("list"), + ctx: Load, + }, + ), + slice: Name( + ExprName { + range: 22..25, + id: Name("int"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 67..94, + name: Name( + ExprName { + range: 72..77, + id: Name("Debug"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 77..88, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 78..87, + name: Identifier { + id: Name("__debug__"), + range: 78..87, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 91..94, + id: Name("str"), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | type __debug__ = list[int] # visited as an Expr but still flagged + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +2 | type Debug[__debug__] = str + | + + + | +1 | type __debug__ = list[int] # visited as an Expr but still flagged +2 | type Debug[__debug__] = str + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_with.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_with.py.snap new file mode 100644 index 0000000000000..51a3a7cc6446e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@debug_shadow_with.py.snap @@ -0,0 +1,89 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/debug_shadow_with.py +--- +## AST + +``` +Module( + ModModule { + range: 0..39, + body: [ + With( + StmtWith { + range: 0..38, + is_async: false, + items: [ + WithItem { + range: 5..33, + context_expr: Call( + ExprCall { + range: 5..20, + func: Name( + ExprName { + range: 5..9, + id: Name("open"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 9..20, + args: [ + StringLiteral( + ExprStringLiteral { + range: 10..19, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 10..19, + value: "foo.txt", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + keywords: [], + }, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 24..33, + id: Name("__debug__"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 35..38, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 35..38, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | with open("foo.txt") as __debug__: ... + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_await_expression_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_await_expression_py38.py.snap new file mode 100644 index 0000000000000..e86f1ea1f1d86 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_await_expression_py38.py.snap @@ -0,0 +1,96 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_await_expression_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..96, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..95, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 55..58, + }, + type_params: None, + parameters: Parameters { + range: 58..60, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 66..95, + is_async: false, + decorator_list: [ + Decorator { + range: 66..76, + expression: Await( + ExprAwait { + range: 67..76, + value: Name( + ExprName { + range: 73..76, + id: Name("bar"), + ctx: Load, + }, + ), + }, + ), + }, + ], + name: Identifier { + id: Name("baz"), + range: 85..88, + }, + type_params: None, + parameters: Parameters { + range: 88..90, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 92..95, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 92..95, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.8" } +2 | async def foo(): +3 | @await bar + | ^^^^^^^^^ Syntax Error: Cannot use `await` expression outside function call arguments in a decorator on Python 3.8 (syntax was added in Python 3.9) +4 | def baz(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_dict_literal_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_dict_literal_py38.py.snap new file mode 100644 index 0000000000000..e42d100e1f14f --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_dict_literal_py38.py.snap @@ -0,0 +1,87 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_dict_literal_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..68, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..67, + is_async: false, + decorator_list: [ + Decorator { + range: 45..52, + expression: Dict( + ExprDict { + range: 46..52, + items: [ + DictItem { + key: Some( + NumberLiteral( + ExprNumberLiteral { + range: 47..48, + value: Int( + 3, + ), + }, + ), + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 50..51, + value: Int( + 3, + ), + }, + ), + }, + ], + }, + ), + }, + ], + name: Identifier { + id: Name("bar"), + range: 57..60, + }, + type_params: None, + parameters: Parameters { + range: 60..62, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 64..67, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 64..67, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.8" } +2 | @{3: 3} + | ^^^^^^ Syntax Error: Cannot use a dict literal outside function call arguments in a decorator on Python 3.8 (syntax was added in Python 3.9) +3 | def bar(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_expression_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_expression_py38.py.snap new file mode 100644 index 0000000000000..d530df39de0cf --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_expression_py38.py.snap @@ -0,0 +1,101 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_expression_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..89, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..88, + is_async: false, + decorator_list: [ + Decorator { + range: 45..72, + expression: Attribute( + ExprAttribute { + range: 46..72, + value: Attribute( + ExprAttribute { + range: 46..64, + value: Subscript( + ExprSubscript { + range: 46..56, + value: Name( + ExprName { + range: 46..53, + id: Name("buttons"), + ctx: Load, + }, + ), + slice: NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 0, + ), + }, + ), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("clicked"), + range: 57..64, + }, + ctx: Load, + }, + ), + attr: Identifier { + id: Name("connect"), + range: 65..72, + }, + ctx: Load, + }, + ), + }, + ], + name: Identifier { + id: Name("spam"), + range: 77..81, + }, + type_params: None, + parameters: Parameters { + range: 81..83, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 85..88, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 85..88, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.8" } +2 | @buttons[0].clicked.connect + | ^^^^^^^^^^ Syntax Error: Cannot use subscript expression outside function call arguments in a decorator on Python 3.8 (syntax was added in Python 3.9) +3 | def spam(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_float_literal_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_float_literal_py38.py.snap new file mode 100644 index 0000000000000..8f2af04e27591 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_float_literal_py38.py.snap @@ -0,0 +1,68 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_float_literal_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..66, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..65, + is_async: false, + decorator_list: [ + Decorator { + range: 45..50, + expression: NumberLiteral( + ExprNumberLiteral { + range: 46..50, + value: Float( + 3.14, + ), + }, + ), + }, + ], + name: Identifier { + id: Name("bar"), + range: 55..58, + }, + type_params: None, + parameters: Parameters { + range: 58..60, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 62..65, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 62..65, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.8" } +2 | @3.14 + | ^^^^ Syntax Error: Cannot use a float literal outside function call arguments in a decorator on Python 3.8 (syntax was added in Python 3.9) +3 | def bar(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_invalid_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_invalid_expression.py.snap index b6e1f3f84f1f4..b89a8c6132395 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_invalid_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_invalid_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/decorator_invalid_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_expression.py.snap index 8920f84aded59..38f833d0402da 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/decorator_missing_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_newline.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_newline.py.snap index fdbe569f7fce9..98cda543d8d29 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_newline.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_missing_newline.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/decorator_missing_newline.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_named_expression_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_named_expression_py37.py.snap new file mode 100644 index 0000000000000..fbbef25495456 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_named_expression_py37.py.snap @@ -0,0 +1,133 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_named_expression_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..85, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..84, + is_async: false, + decorator_list: [ + Decorator { + range: 45..69, + expression: Call( + ExprCall { + range: 46..69, + func: Named( + ExprNamed { + range: 47..63, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + value: Lambda( + ExprLambda { + range: 52..63, + parameters: Some( + Parameters { + range: 59..60, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 59..60, + parameter: Parameter { + range: 59..60, + name: Identifier { + id: Name("x"), + range: 59..60, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + ), + body: Name( + ExprName { + range: 62..63, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + }, + ), + arguments: Arguments { + range: 64..69, + args: [ + Name( + ExprName { + range: 65..68, + id: Name("foo"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ], + name: Identifier { + id: Name("bar"), + range: 74..77, + }, + type_params: None, + parameters: Parameters { + range: 77..79, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 81..84, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 81..84, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.7" } +2 | @(x := lambda x: x)(foo) + | ^^^^^^^^^^^^^^^^ Syntax Error: Cannot use named assignment expression (`:=`) on Python 3.7 (syntax was added in Python 3.8) +3 | def bar(): ... + | + + + | +1 | # parse_options: { "target-version": "3.7" } +2 | @(x := lambda x: x)(foo) + | ^^^^^^^^^^^^^^^^ Syntax Error: Cannot use assignment expression outside function call arguments in a decorator on Python 3.7 (syntax was added in Python 3.9) +3 | def bar(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_non_toplevel_call_expression_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_non_toplevel_call_expression_py38.py.snap new file mode 100644 index 0000000000000..2374561e1678d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_non_toplevel_call_expression_py38.py.snap @@ -0,0 +1,97 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/decorator_non_toplevel_call_expression_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..73, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..72, + is_async: false, + decorator_list: [ + Decorator { + range: 45..57, + expression: Call( + ExprCall { + range: 46..57, + func: Attribute( + ExprAttribute { + range: 46..55, + value: Call( + ExprCall { + range: 46..51, + func: Name( + ExprName { + range: 46..49, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 49..51, + args: [], + keywords: [], + }, + }, + ), + attr: Identifier { + id: Name("bar"), + range: 52..55, + }, + ctx: Load, + }, + ), + arguments: Arguments { + range: 55..57, + args: [], + keywords: [], + }, + }, + ), + }, + ], + name: Identifier { + id: Name("baz"), + range: 62..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 69..72, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 69..72, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.8" } +2 | @foo().bar() + | ^^^^^ Syntax Error: Cannot use a call expression in a decorator on Python 3.8 unless it is the top-level expression or it occurs in the argument list of a top-level call expression (relaxed decorator syntax was added in Python 3.9) +3 | def baz(): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_unexpected_token.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_unexpected_token.py.snap index 3b1efc7102869..8e3126c2e33c5 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_unexpected_token.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@decorator_unexpected_token.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/decorator_unexpected_token.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_debug_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_debug_py39.py.snap new file mode 100644 index 0000000000000..6909999bfed48 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_debug_py39.py.snap @@ -0,0 +1,36 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/del_debug_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..57, + body: [ + Delete( + StmtDelete { + range: 43..56, + targets: [ + Name( + ExprName { + range: 47..56, + id: Name("__debug__"), + ctx: Del, + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | # parse_options: {"target-version": "3.9"} +2 | del __debug__ + | ^^^^^^^^^ Syntax Error: cannot delete `__debug__` on Python 3.9 (syntax was removed in 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_incomplete_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_incomplete_target.py.snap index 4019e44237003..b17df25feb8d7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_incomplete_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_incomplete_target.py.snap @@ -121,4 +121,5 @@ Module( | 3 | del x, y[ 4 | z + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_stmt_empty.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_stmt_empty.py.snap index f36083fc0c055..da814920189fd 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_stmt_empty.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@del_stmt_empty.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/del_stmt_empty.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@dotted_name_multiple_dots.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@dotted_name_multiple_dots.py.snap index a84773ff80c71..281c71c151fe7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@dotted_name_multiple_dots.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@dotted_name_multiple_dots.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/dotted_name_multiple_dots.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_class_attr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_class_attr.py.snap new file mode 100644 index 0000000000000..f4d1b42821b52 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_class_attr.py.snap @@ -0,0 +1,715 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/duplicate_match_class_attr.py +--- +## AST + +``` +Module( + ModModule { + range: 0..231, + body: [ + Match( + StmtMatch { + range: 0..230, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..38, + pattern: MatchClass( + PatternMatchClass { + range: 18..33, + cls: Name( + ExprName { + range: 18..23, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 23..33, + patterns: [], + keywords: [ + PatternKeyword { + range: 24..27, + attr: Identifier { + id: Name("x"), + range: 24..25, + }, + pattern: MatchValue( + PatternMatchValue { + range: 26..27, + value: NumberLiteral( + ExprNumberLiteral { + range: 26..27, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 29..32, + attr: Identifier { + id: Name("x"), + range: 29..30, + }, + pattern: MatchValue( + PatternMatchValue { + range: 31..32, + value: NumberLiteral( + ExprNumberLiteral { + range: 31..32, + value: Int( + 2, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 35..38, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 35..38, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 43..70, + pattern: MatchSequence( + PatternMatchSequence { + range: 48..65, + patterns: [ + MatchClass( + PatternMatchClass { + range: 49..64, + cls: Name( + ExprName { + range: 49..54, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 54..64, + patterns: [], + keywords: [ + PatternKeyword { + range: 55..58, + attr: Identifier { + id: Name("x"), + range: 55..56, + }, + pattern: MatchValue( + PatternMatchValue { + range: 57..58, + value: NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 60..63, + attr: Identifier { + id: Name("x"), + range: 60..61, + }, + pattern: MatchValue( + PatternMatchValue { + range: 62..63, + value: NumberLiteral( + ExprNumberLiteral { + range: 62..63, + value: Int( + 2, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 67..70, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 67..70, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 75..113, + pattern: MatchMapping( + PatternMatchMapping { + range: 80..108, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 81..84, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 81..84, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 89..92, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 89..92, + value: "y", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchAs( + PatternMatchAs { + range: 86..87, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 86..87, + }, + ), + }, + ), + MatchClass( + PatternMatchClass { + range: 94..107, + cls: Name( + ExprName { + range: 94..97, + id: Name("Foo"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 97..107, + patterns: [], + keywords: [ + PatternKeyword { + range: 98..101, + attr: Identifier { + id: Name("x"), + range: 98..99, + }, + pattern: MatchValue( + PatternMatchValue { + range: 100..101, + value: NumberLiteral( + ExprNumberLiteral { + range: 100..101, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 103..106, + attr: Identifier { + id: Name("x"), + range: 103..104, + }, + pattern: MatchValue( + PatternMatchValue { + range: 105..106, + value: NumberLiteral( + ExprNumberLiteral { + range: 105..106, + value: Int( + 2, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 110..113, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 110..113, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 118..162, + pattern: MatchSequence( + PatternMatchSequence { + range: 123..157, + patterns: [ + MatchMapping( + PatternMatchMapping { + range: 124..126, + keys: [], + patterns: [], + rest: None, + }, + ), + MatchMapping( + PatternMatchMapping { + range: 128..156, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 129..132, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 129..132, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 137..140, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 137..140, + value: "y", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchAs( + PatternMatchAs { + range: 134..135, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 134..135, + }, + ), + }, + ), + MatchClass( + PatternMatchClass { + range: 142..155, + cls: Name( + ExprName { + range: 142..145, + id: Name("Foo"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 145..155, + patterns: [], + keywords: [ + PatternKeyword { + range: 146..149, + attr: Identifier { + id: Name("x"), + range: 146..147, + }, + pattern: MatchValue( + PatternMatchValue { + range: 148..149, + value: NumberLiteral( + ExprNumberLiteral { + range: 148..149, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 151..154, + attr: Identifier { + id: Name("x"), + range: 151..152, + }, + pattern: MatchValue( + PatternMatchValue { + range: 153..154, + value: NumberLiteral( + ExprNumberLiteral { + range: 153..154, + value: Int( + 2, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + ], + rest: None, + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 159..162, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 159..162, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 167..230, + pattern: MatchClass( + PatternMatchClass { + range: 172..225, + cls: Name( + ExprName { + range: 172..177, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 177..225, + patterns: [], + keywords: [ + PatternKeyword { + range: 178..181, + attr: Identifier { + id: Name("x"), + range: 178..179, + }, + pattern: MatchValue( + PatternMatchValue { + range: 180..181, + value: NumberLiteral( + ExprNumberLiteral { + range: 180..181, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 183..201, + attr: Identifier { + id: Name("d"), + range: 183..184, + }, + pattern: MatchMapping( + PatternMatchMapping { + range: 185..201, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 186..189, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 186..189, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 194..197, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 194..197, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 191..192, + value: NumberLiteral( + ExprNumberLiteral { + range: 191..192, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 199..200, + value: NumberLiteral( + ExprNumberLiteral { + range: 199..200, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + }, + PatternKeyword { + range: 203..224, + attr: Identifier { + id: Name("other"), + range: 203..208, + }, + pattern: MatchClass( + PatternMatchClass { + range: 209..224, + cls: Name( + ExprName { + range: 209..214, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 214..224, + patterns: [], + keywords: [ + PatternKeyword { + range: 215..218, + attr: Identifier { + id: Name("x"), + range: 215..216, + }, + pattern: MatchValue( + PatternMatchValue { + range: 217..218, + value: NumberLiteral( + ExprNumberLiteral { + range: 217..218, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 220..223, + attr: Identifier { + id: Name("x"), + range: 220..221, + }, + pattern: MatchValue( + PatternMatchValue { + range: 222..223, + value: NumberLiteral( + ExprNumberLiteral { + range: 222..223, + value: Int( + 2, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + }, + ], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 227..230, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 227..230, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | match x: +2 | case Class(x=1, x=2): ... + | ^ Syntax Error: attribute name `x` repeated in class pattern +3 | case [Class(x=1, x=2)]: ... +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... + | + + + | +1 | match x: +2 | case Class(x=1, x=2): ... +3 | case [Class(x=1, x=2)]: ... + | ^ Syntax Error: attribute name `x` repeated in class pattern +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... +5 | case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... + | + + + | +2 | case Class(x=1, x=2): ... +3 | case [Class(x=1, x=2)]: ... +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... + | ^ Syntax Error: attribute name `x` repeated in class pattern +5 | case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... +6 | case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... + | + + + | +3 | case [Class(x=1, x=2)]: ... +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... +5 | case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... + | ^ Syntax Error: attribute name `x` repeated in class pattern +6 | case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... + | + + + | +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... +5 | case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... +6 | case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` + | + + + | +4 | case {"x": x, "y": Foo(x=1, x=2)}: ... +5 | case [{}, {"x": x, "y": Foo(x=1, x=2)}]: ... +6 | case Class(x=1, d={"x": 1, "x": 2}, other=Class(x=1, x=2)): ... + | ^ Syntax Error: attribute name `x` repeated in class pattern + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_key.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_key.py.snap new file mode 100644 index 0000000000000..4d4dbc2eca418 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_match_key.py.snap @@ -0,0 +1,1461 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/duplicate_match_key.py +--- +## AST + +``` +Module( + ModModule { + range: 0..533, + body: [ + Match( + StmtMatch { + range: 0..532, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..39, + pattern: MatchMapping( + PatternMatchMapping { + range: 18..34, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 19..22, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 19..22, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 27..30, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 27..30, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 24..25, + value: NumberLiteral( + ExprNumberLiteral { + range: 24..25, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 32..33, + value: NumberLiteral( + ExprNumberLiteral { + range: 32..33, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 36..39, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 36..39, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 44..72, + pattern: MatchMapping( + PatternMatchMapping { + range: 49..67, + keys: [ + BytesLiteral( + ExprBytesLiteral { + range: 50..54, + value: BytesLiteralValue { + inner: Single( + BytesLiteral { + range: 50..54, + value: [ + 120, + ], + flags: BytesLiteralFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + BytesLiteral( + ExprBytesLiteral { + range: 59..63, + value: BytesLiteralValue { + inner: Single( + BytesLiteral { + range: 59..63, + value: [ + 120, + ], + flags: BytesLiteralFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 56..57, + value: NumberLiteral( + ExprNumberLiteral { + range: 56..57, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 65..66, + value: NumberLiteral( + ExprNumberLiteral { + range: 65..66, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 69..72, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 69..72, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 77..99, + pattern: MatchMapping( + PatternMatchMapping { + range: 82..94, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 83..84, + value: Int( + 0, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 89..90, + value: Int( + 0, + ), + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 86..87, + value: NumberLiteral( + ExprNumberLiteral { + range: 86..87, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 92..93, + value: NumberLiteral( + ExprNumberLiteral { + range: 92..93, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 96..99, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 96..99, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 104..130, + pattern: MatchMapping( + PatternMatchMapping { + range: 109..125, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 110..113, + value: Float( + 1.0, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 118..121, + value: Float( + 1.0, + ), + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 115..116, + value: NumberLiteral( + ExprNumberLiteral { + range: 115..116, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 123..124, + value: NumberLiteral( + ExprNumberLiteral { + range: 123..124, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 127..130, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 127..130, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 135..171, + pattern: MatchMapping( + PatternMatchMapping { + range: 140..166, + keys: [ + BinOp( + ExprBinOp { + range: 141..149, + left: NumberLiteral( + ExprNumberLiteral { + range: 141..144, + value: Float( + 1.0, + ), + }, + ), + op: Add, + right: NumberLiteral( + ExprNumberLiteral { + range: 147..149, + value: Complex { + real: 0.0, + imag: 2.0, + }, + }, + ), + }, + ), + BinOp( + ExprBinOp { + range: 154..162, + left: NumberLiteral( + ExprNumberLiteral { + range: 154..157, + value: Float( + 1.0, + ), + }, + ), + op: Add, + right: NumberLiteral( + ExprNumberLiteral { + range: 160..162, + value: Complex { + real: 0.0, + imag: 2.0, + }, + }, + ), + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 151..152, + value: NumberLiteral( + ExprNumberLiteral { + range: 151..152, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 164..165, + value: NumberLiteral( + ExprNumberLiteral { + range: 164..165, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 168..171, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 168..171, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 176..204, + pattern: MatchMapping( + PatternMatchMapping { + range: 181..199, + keys: [ + BooleanLiteral( + ExprBooleanLiteral { + range: 182..186, + value: true, + }, + ), + BooleanLiteral( + ExprBooleanLiteral { + range: 191..195, + value: true, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 188..189, + value: NumberLiteral( + ExprNumberLiteral { + range: 188..189, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 197..198, + value: NumberLiteral( + ExprNumberLiteral { + range: 197..198, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 201..204, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 201..204, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 209..237, + pattern: MatchMapping( + PatternMatchMapping { + range: 214..232, + keys: [ + NoneLiteral( + ExprNoneLiteral { + range: 215..219, + }, + ), + NoneLiteral( + ExprNoneLiteral { + range: 224..228, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 221..222, + value: NumberLiteral( + ExprNumberLiteral { + range: 221..222, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 230..231, + value: NumberLiteral( + ExprNumberLiteral { + range: 230..231, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 234..237, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 234..237, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 242..319, + pattern: MatchMapping( + PatternMatchMapping { + range: 247..314, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 253..277, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 253..277, + value: "x\n y\n z\n ", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: true, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 286..310, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 286..310, + value: "x\n y\n z\n ", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: true, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 279..280, + value: NumberLiteral( + ExprNumberLiteral { + range: 279..280, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 312..313, + value: NumberLiteral( + ExprNumberLiteral { + range: 312..313, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 316..319, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 316..319, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 324..358, + pattern: MatchMapping( + PatternMatchMapping { + range: 329..353, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 330..333, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 330..333, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 338..341, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 338..341, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 346..349, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 346..349, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 335..336, + value: NumberLiteral( + ExprNumberLiteral { + range: 335..336, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 343..344, + value: NumberLiteral( + ExprNumberLiteral { + range: 343..344, + value: Int( + 2, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 351..352, + value: NumberLiteral( + ExprNumberLiteral { + range: 351..352, + value: Int( + 3, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 355..358, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 355..358, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 363..401, + pattern: MatchMapping( + PatternMatchMapping { + range: 368..396, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 369..370, + value: Int( + 0, + ), + }, + ), + StringLiteral( + ExprStringLiteral { + range: 375..378, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 375..378, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 383..384, + value: Int( + 0, + ), + }, + ), + StringLiteral( + ExprStringLiteral { + range: 389..392, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 389..392, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 372..373, + value: NumberLiteral( + ExprNumberLiteral { + range: 372..373, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 380..381, + value: NumberLiteral( + ExprNumberLiteral { + range: 380..381, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 386..387, + value: NumberLiteral( + ExprNumberLiteral { + range: 386..387, + value: Int( + 2, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 394..395, + value: NumberLiteral( + ExprNumberLiteral { + range: 394..395, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 398..401, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 398..401, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 406..434, + pattern: MatchSequence( + PatternMatchSequence { + range: 411..429, + patterns: [ + MatchMapping( + PatternMatchMapping { + range: 412..428, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 413..416, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 413..416, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 421..424, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 421..424, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 418..419, + value: NumberLiteral( + ExprNumberLiteral { + range: 418..419, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 426..427, + value: NumberLiteral( + ExprNumberLiteral { + range: 426..427, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 431..434, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 431..434, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 439..477, + pattern: MatchClass( + PatternMatchClass { + range: 444..472, + cls: Name( + ExprName { + range: 444..447, + id: Name("Foo"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 447..472, + patterns: [], + keywords: [ + PatternKeyword { + range: 448..451, + attr: Identifier { + id: Name("x"), + range: 448..449, + }, + pattern: MatchValue( + PatternMatchValue { + range: 450..451, + value: NumberLiteral( + ExprNumberLiteral { + range: 450..451, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 453..471, + attr: Identifier { + id: Name("y"), + range: 453..454, + }, + pattern: MatchMapping( + PatternMatchMapping { + range: 455..471, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 456..459, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 456..459, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 464..467, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 464..467, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 461..462, + value: NumberLiteral( + ExprNumberLiteral { + range: 461..462, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 469..470, + value: NumberLiteral( + ExprNumberLiteral { + range: 469..470, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + }, + ], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 474..477, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 474..477, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 482..532, + pattern: MatchSequence( + PatternMatchSequence { + range: 487..527, + patterns: [ + MatchClass( + PatternMatchClass { + range: 488..496, + cls: Name( + ExprName { + range: 488..491, + id: Name("Foo"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 491..496, + patterns: [], + keywords: [ + PatternKeyword { + range: 492..495, + attr: Identifier { + id: Name("x"), + range: 492..493, + }, + pattern: MatchValue( + PatternMatchValue { + range: 494..495, + value: NumberLiteral( + ExprNumberLiteral { + range: 494..495, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ], + }, + }, + ), + MatchClass( + PatternMatchClass { + range: 498..526, + cls: Name( + ExprName { + range: 498..501, + id: Name("Foo"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 501..526, + patterns: [], + keywords: [ + PatternKeyword { + range: 502..505, + attr: Identifier { + id: Name("x"), + range: 502..503, + }, + pattern: MatchValue( + PatternMatchValue { + range: 504..505, + value: NumberLiteral( + ExprNumberLiteral { + range: 504..505, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + PatternKeyword { + range: 507..525, + attr: Identifier { + id: Name("y"), + range: 507..508, + }, + pattern: MatchMapping( + PatternMatchMapping { + range: 509..525, + keys: [ + StringLiteral( + ExprStringLiteral { + range: 510..513, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 510..513, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 518..521, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 518..521, + value: "x", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 515..516, + value: NumberLiteral( + ExprNumberLiteral { + range: 515..516, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 523..524, + value: NumberLiteral( + ExprNumberLiteral { + range: 523..524, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + }, + ], + }, + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 529..532, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 529..532, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | match x: +2 | case {"x": 1, "x": 2}: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +3 | case {b"x": 1, b"x": 2}: ... +4 | case {0: 1, 0: 2}: ... + | + + + | +1 | match x: +2 | case {"x": 1, "x": 2}: ... +3 | case {b"x": 1, b"x": 2}: ... + | ^^^^ Syntax Error: mapping pattern checks duplicate key `b"x"` +4 | case {0: 1, 0: 2}: ... +5 | case {1.0: 1, 1.0: 2}: ... + | + + + | +2 | case {"x": 1, "x": 2}: ... +3 | case {b"x": 1, b"x": 2}: ... +4 | case {0: 1, 0: 2}: ... + | ^ Syntax Error: mapping pattern checks duplicate key `0` +5 | case {1.0: 1, 1.0: 2}: ... +6 | case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... + | + + + | +3 | case {b"x": 1, b"x": 2}: ... +4 | case {0: 1, 0: 2}: ... +5 | case {1.0: 1, 1.0: 2}: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `1.0` +6 | case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... +7 | case {True: 1, True: 2}: ... + | + + + | +4 | case {0: 1, 0: 2}: ... +5 | case {1.0: 1, 1.0: 2}: ... +6 | case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... + | ^^^^^^^^ Syntax Error: mapping pattern checks duplicate key `1.0 + 2j` +7 | case {True: 1, True: 2}: ... +8 | case {None: 1, None: 2}: ... + | + + + | +5 | case {1.0: 1, 1.0: 2}: ... +6 | case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... +7 | case {True: 1, True: 2}: ... + | ^^^^ Syntax Error: mapping pattern checks duplicate key `True` +8 | case {None: 1, None: 2}: ... +9 | case { + | + + + | + 6 | case {1.0 + 2j: 1, 1.0 + 2j: 2}: ... + 7 | case {True: 1, True: 2}: ... + 8 | case {None: 1, None: 2}: ... + | ^^^^ Syntax Error: mapping pattern checks duplicate key `None` + 9 | case { +10 | """x + | + + + | +12 | z +13 | """: 1, +14 | / """x +15 | | y +16 | | z +17 | | """: 2}: ... + | |_______^ Syntax Error: mapping pattern checks duplicate key `"""x\n y\n z\n """` +18 | case {"x": 1, "x": 2, "x": 3}: ... +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... + | + + + | +16 | z +17 | """: 2}: ... +18 | case {"x": 1, "x": 2, "x": 3}: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... +20 | case [{"x": 1, "x": 2}]: ... + | + + + | +16 | z +17 | """: 2}: ... +18 | case {"x": 1, "x": 2, "x": 3}: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... +20 | case [{"x": 1, "x": 2}]: ... + | + + + | +17 | """: 2}: ... +18 | case {"x": 1, "x": 2, "x": 3}: ... +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... + | ^ Syntax Error: mapping pattern checks duplicate key `0` +20 | case [{"x": 1, "x": 2}]: ... +21 | case Foo(x=1, y={"x": 1, "x": 2}): ... + | + + + | +17 | """: 2}: ... +18 | case {"x": 1, "x": 2, "x": 3}: ... +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +20 | case [{"x": 1, "x": 2}]: ... +21 | case Foo(x=1, y={"x": 1, "x": 2}): ... + | + + + | +18 | case {"x": 1, "x": 2, "x": 3}: ... +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... +20 | case [{"x": 1, "x": 2}]: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +21 | case Foo(x=1, y={"x": 1, "x": 2}): ... +22 | case [Foo(x=1), Foo(x=1, y={"x": 1, "x": 2})]: ... + | + + + | +19 | case {0: 1, "x": 1, 0: 2, "x": 2}: ... +20 | case [{"x": 1, "x": 2}]: ... +21 | case Foo(x=1, y={"x": 1, "x": 2}): ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` +22 | case [Foo(x=1), Foo(x=1, y={"x": 1, "x": 2})]: ... + | + + + | +20 | case [{"x": 1, "x": 2}]: ... +21 | case Foo(x=1, y={"x": 1, "x": 2}): ... +22 | case [Foo(x=1), Foo(x=1, y={"x": 1, "x": 2})]: ... + | ^^^ Syntax Error: mapping pattern checks duplicate key `"x"` + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_type_parameter_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_type_parameter_names.py.snap new file mode 100644 index 0000000000000..88b7f1ffb791a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@duplicate_type_parameter_names.py.snap @@ -0,0 +1,589 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/duplicate_type_parameter_names.py +--- +## AST + +``` +Module( + ModModule { + range: 0..261, + body: [ + TypeAlias( + StmtTypeAlias { + range: 0..22, + name: Name( + ExprName { + range: 5..10, + id: Name("Alias"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 10..16, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 11..12, + name: Identifier { + id: Name("T"), + range: 11..12, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 14..15, + name: Identifier { + id: Name("T"), + range: 14..15, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 19..22, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 23..45, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 27..28, + }, + type_params: Some( + TypeParams { + range: 28..34, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 29..30, + name: Identifier { + id: Name("T"), + range: 29..30, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 32..33, + name: Identifier { + id: Name("T"), + range: 32..33, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 34..40, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 35..39, + parameter: Parameter { + range: 35..39, + name: Identifier { + id: Name("t"), + range: 35..36, + }, + annotation: Some( + Name( + ExprName { + range: 38..39, + id: Name("T"), + ctx: Load, + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 42..45, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 42..45, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 46..64, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 52..53, + }, + type_params: Some( + TypeParams { + range: 53..59, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 54..55, + name: Identifier { + id: Name("T"), + range: 54..55, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 57..58, + name: Identifier { + id: Name("T"), + range: 57..58, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 61..64, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 61..64, + }, + ), + }, + ), + ], + }, + ), + TypeAlias( + StmtTypeAlias { + range: 65..132, + name: Name( + ExprName { + range: 70..75, + id: Name("Alias"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 75..126, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 76..77, + name: Identifier { + id: Name("T"), + range: 76..77, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 79..85, + name: Identifier { + id: Name("U"), + range: 79..80, + }, + bound: Some( + Name( + ExprName { + range: 82..85, + id: Name("str"), + ctx: Load, + }, + ), + ), + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 87..102, + name: Identifier { + id: Name("V"), + range: 87..88, + }, + bound: Some( + Tuple( + ExprTuple { + range: 90..102, + elts: [ + Name( + ExprName { + range: 91..94, + id: Name("str"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 96..101, + id: Name("bytes"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + default: None, + }, + ), + TypeVarTuple( + TypeParamTypeVarTuple { + range: 104..107, + name: Identifier { + id: Name("Ts"), + range: 105..107, + }, + default: None, + }, + ), + ParamSpec( + TypeParamParamSpec { + range: 109..112, + name: Identifier { + id: Name("P"), + range: 111..112, + }, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 114..125, + name: Identifier { + id: Name("T"), + range: 114..115, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 118..125, + id: Name("default"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 129..132, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 133..154, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 137..138, + }, + type_params: Some( + TypeParams { + range: 138..147, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 139..140, + name: Identifier { + id: Name("T"), + range: 139..140, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 142..143, + name: Identifier { + id: Name("T"), + range: 142..143, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 145..146, + name: Identifier { + id: Name("T"), + range: 145..146, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 147..149, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 151..154, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 151..154, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 169..188, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 173..174, + }, + type_params: Some( + TypeParams { + range: 174..181, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 175..176, + name: Identifier { + id: Name("T"), + range: 175..176, + }, + bound: None, + default: None, + }, + ), + TypeVarTuple( + TypeParamTypeVarTuple { + range: 178..180, + name: Identifier { + id: Name("T"), + range: 179..180, + }, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 181..183, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 185..188, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 185..188, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 218..238, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 222..223, + }, + type_params: Some( + TypeParams { + range: 223..231, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 224..225, + name: Identifier { + id: Name("T"), + range: 224..225, + }, + bound: None, + default: None, + }, + ), + ParamSpec( + TypeParamParamSpec { + range: 227..230, + name: Identifier { + id: Name("T"), + range: 229..230, + }, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 231..233, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 235..238, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 235..238, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | type Alias[T, T] = ... + | ^ Syntax Error: duplicate type parameter +2 | def f[T, T](t: T): ... +3 | class C[T, T]: ... + | + + + | +1 | type Alias[T, T] = ... +2 | def f[T, T](t: T): ... + | ^ Syntax Error: duplicate type parameter +3 | class C[T, T]: ... +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... + | + + + | +1 | type Alias[T, T] = ... +2 | def f[T, T](t: T): ... +3 | class C[T, T]: ... + | ^ Syntax Error: duplicate type parameter +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... +5 | def f[T, T, T](): ... # two errors + | + + + | +2 | def f[T, T](t: T): ... +3 | class C[T, T]: ... +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... + | ^^^^^^^^^^^ Syntax Error: duplicate type parameter +5 | def f[T, T, T](): ... # two errors +6 | def f[T, *T](): ... # star is still duplicate + | + + + | +3 | class C[T, T]: ... +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... +5 | def f[T, T, T](): ... # two errors + | ^ Syntax Error: duplicate type parameter +6 | def f[T, *T](): ... # star is still duplicate +7 | def f[T, **T](): ... # as is double star + | + + + | +3 | class C[T, T]: ... +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... +5 | def f[T, T, T](): ... # two errors + | ^ Syntax Error: duplicate type parameter +6 | def f[T, *T](): ... # star is still duplicate +7 | def f[T, **T](): ... # as is double star + | + + + | +4 | type Alias[T, U: str, V: (str, bytes), *Ts, **P, T = default] = ... +5 | def f[T, T, T](): ... # two errors +6 | def f[T, *T](): ... # star is still duplicate + | ^^ Syntax Error: duplicate type parameter +7 | def f[T, **T](): ... # as is double star + | + + + | +5 | def f[T, T, T](): ... # two errors +6 | def f[T, *T](): ... # star is still duplicate +7 | def f[T, **T](): ... # as is double star + | ^^^ Syntax Error: duplicate type parameter + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_star_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_star_py310.py.snap new file mode 100644 index 0000000000000..070d99e74df7f --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_star_py310.py.snap @@ -0,0 +1,145 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/except_star_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..126, + body: [ + Try( + StmtTry { + range: 44..125, + body: [ + Expr( + StmtExpr { + range: 49..52, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 49..52, + }, + ), + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 53..76, + type_: Some( + Name( + ExprName { + range: 61..71, + id: Name("ValueError"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Expr( + StmtExpr { + range: 73..76, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 73..76, + }, + ), + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 77..98, + type_: Some( + Name( + ExprName { + range: 85..93, + id: Name("KeyError"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Expr( + StmtExpr { + range: 95..98, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 95..98, + }, + ), + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 99..125, + type_: Some( + Name( + ExprName { + range: 115..120, + id: Name("Error"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Expr( + StmtExpr { + range: 122..125, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 122..125, + }, + ), + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.10"} +2 | try: ... +3 | except* ValueError: ... + | ^ Syntax Error: Cannot use `except*` on Python 3.10 (syntax was added in Python 3.11) +4 | except* KeyError: ... +5 | except * Error: ... + | + + + | +2 | try: ... +3 | except* ValueError: ... +4 | except* KeyError: ... + | ^ Syntax Error: Cannot use `except*` on Python 3.10 (syntax was added in Python 3.11) +5 | except * Error: ... + | + + + | +3 | except* ValueError: ... +4 | except* KeyError: ... +5 | except * Error: ... + | ^ Syntax Error: Cannot use `except*` on Python 3.10 (syntax was added in Python 3.11) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_invalid_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_invalid_expression.py.snap index dacd5f5d78d07..3409ecda78583 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_invalid_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_invalid_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_invalid_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_as_name.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_as_name.py.snap index 433c42b6c3e8e..309e29e699f14 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_as_name.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_as_name.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_missing_as_name.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception.py.snap index 6462ff889845b..16e649cc7d26c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_missing_exception.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception_and_as_name.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception_and_as_name.py.snap index 20805396e65ee..ad463555ea040 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception_and_as_name.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_missing_exception_and_as_name.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_missing_exception_and_as_name.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple.py.snap deleted file mode 100644 index 7b4a51d0d8c50..0000000000000 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple.py.snap +++ /dev/null @@ -1,250 +0,0 @@ ---- -source: crates/ruff_python_parser/tests/fixtures.rs -input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple.py ---- -## AST - -``` -Module( - ModModule { - range: 0..131, - body: [ - Try( - StmtTry { - range: 0..64, - body: [ - Pass( - StmtPass { - range: 9..13, - }, - ), - ], - handlers: [ - ExceptHandler( - ExceptHandlerExceptHandler { - range: 14..35, - type_: Some( - Tuple( - ExprTuple { - range: 21..25, - elts: [ - Name( - ExprName { - range: 21..22, - id: Name("x"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 24..25, - id: Name("y"), - ctx: Load, - }, - ), - ], - ctx: Load, - parenthesized: false, - }, - ), - ), - name: None, - body: [ - Pass( - StmtPass { - range: 31..35, - }, - ), - ], - }, - ), - ExceptHandler( - ExceptHandlerExceptHandler { - range: 36..64, - type_: Some( - Tuple( - ExprTuple { - range: 43..47, - elts: [ - Name( - ExprName { - range: 43..44, - id: Name("x"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 46..47, - id: Name("y"), - ctx: Load, - }, - ), - ], - ctx: Load, - parenthesized: false, - }, - ), - ), - name: Some( - Identifier { - id: Name("exc"), - range: 51..54, - }, - ), - body: [ - Pass( - StmtPass { - range: 60..64, - }, - ), - ], - }, - ), - ], - orelse: [], - finalbody: [], - is_star: false, - }, - ), - Try( - StmtTry { - range: 65..130, - body: [ - Pass( - StmtPass { - range: 74..78, - }, - ), - ], - handlers: [ - ExceptHandler( - ExceptHandlerExceptHandler { - range: 79..101, - type_: Some( - Tuple( - ExprTuple { - range: 87..91, - elts: [ - Name( - ExprName { - range: 87..88, - id: Name("x"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 90..91, - id: Name("y"), - ctx: Load, - }, - ), - ], - ctx: Load, - parenthesized: false, - }, - ), - ), - name: None, - body: [ - Pass( - StmtPass { - range: 97..101, - }, - ), - ], - }, - ), - ExceptHandler( - ExceptHandlerExceptHandler { - range: 102..130, - type_: Some( - Tuple( - ExprTuple { - range: 110..114, - elts: [ - Name( - ExprName { - range: 110..111, - id: Name("x"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 113..114, - id: Name("y"), - ctx: Load, - }, - ), - ], - ctx: Load, - parenthesized: false, - }, - ), - ), - name: Some( - Identifier { - id: Name("eg"), - range: 118..120, - }, - ), - body: [ - Pass( - StmtPass { - range: 126..130, - }, - ), - ], - }, - ), - ], - orelse: [], - finalbody: [], - is_star: true, - }, - ), - ], - }, -) -``` -## Errors - - | -1 | try: -2 | pass -3 | except x, y: - | ^^^^ Syntax Error: Multiple exception types must be parenthesized -4 | pass -5 | except x, y as exc: - | - - - | -3 | except x, y: -4 | pass -5 | except x, y as exc: - | ^^^^ Syntax Error: Multiple exception types must be parenthesized -6 | pass -7 | try: - | - - - | - 7 | try: - 8 | pass - 9 | except* x, y: - | ^^^^ Syntax Error: Multiple exception types must be parenthesized -10 | pass -11 | except* x, y as eg: - | - - - | - 9 | except* x, y: -10 | pass -11 | except* x, y as eg: - | ^^^^ Syntax Error: Multiple exception types must be parenthesized -12 | pass - | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_as.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_as.py.snap new file mode 100644 index 0000000000000..928495cb4dde9 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_as.py.snap @@ -0,0 +1,154 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_as.py +--- +## AST + +``` +Module( + ModModule { + range: 0..86, + body: [ + Try( + StmtTry { + range: 0..42, + body: [ + Pass( + StmtPass { + range: 9..13, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 14..42, + type_: Some( + Tuple( + ExprTuple { + range: 21..25, + elts: [ + Name( + ExprName { + range: 21..22, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 24..25, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: Some( + Identifier { + id: Name("exc"), + range: 29..32, + }, + ), + body: [ + Pass( + StmtPass { + range: 38..42, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + Try( + StmtTry { + range: 43..85, + body: [ + Pass( + StmtPass { + range: 52..56, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 57..85, + type_: Some( + Tuple( + ExprTuple { + range: 65..69, + elts: [ + Name( + ExprName { + range: 65..66, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 68..69, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: Some( + Identifier { + id: Name("eg"), + range: 73..75, + }, + ), + body: [ + Pass( + StmtPass { + range: 81..85, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + ], + }, +) +``` +## Errors + + | +1 | try: +2 | pass +3 | except x, y as exc: + | ^^^^ Syntax Error: Multiple exception types must be parenthesized when using `as` +4 | pass +5 | try: + | + + + | +5 | try: +6 | pass +7 | except* x, y as eg: + | ^^^^ Syntax Error: Multiple exception types must be parenthesized when using `as` +8 | pass + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_no_as_py313.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_no_as_py313.py.snap new file mode 100644 index 0000000000000..1a74da4a6767c --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@except_stmt_unparenthesized_tuple_no_as_py313.py.snap @@ -0,0 +1,144 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/except_stmt_unparenthesized_tuple_no_as_py313.py +--- +## AST + +``` +Module( + ModModule { + range: 0..117, + body: [ + Try( + StmtTry { + range: 44..79, + body: [ + Pass( + StmtPass { + range: 53..57, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 58..79, + type_: Some( + Tuple( + ExprTuple { + range: 65..69, + elts: [ + Name( + ExprName { + range: 65..66, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 68..69, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 75..79, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + Try( + StmtTry { + range: 80..116, + body: [ + Pass( + StmtPass { + range: 89..93, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 94..116, + type_: Some( + Tuple( + ExprTuple { + range: 102..106, + elts: [ + Name( + ExprName { + range: 102..103, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 105..106, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 112..116, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +2 | try: +3 | pass +4 | except x, y: + | ^^^^ Syntax Error: Multiple exception types must be parenthesized on Python 3.13 (syntax was added in Python 3.14) +5 | pass +6 | try: + | + + + | +6 | try: +7 | pass +8 | except* x, y: + | ^^^^ Syntax Error: Multiple exception types must be parenthesized on Python 3.13 (syntax was added in Python 3.14) +9 | pass + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__double_starred.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__double_starred.py.snap index 5a3276c6a44a6..4ef425440b982 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__double_starred.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__double_starred.py.snap @@ -200,14 +200,14 @@ Module( 2 | call(** *x) 3 | call(***x) | ^^ Syntax Error: Starred expression cannot be used here -4 | +4 | 5 | call(**x := 1) | | 3 | call(***x) -4 | +4 | 5 | call(**x := 1) | ^^ Syntax Error: Expected ',', found ':=' | @@ -215,7 +215,7 @@ Module( | 3 | call(***x) -4 | +4 | 5 | call(**x := 1) | ^ Syntax Error: Positional argument cannot follow keyword argument unpacking | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__duplicate_keyword_arguments.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__duplicate_keyword_arguments.py.snap index 2b70f716d5e09..d31cfdfc0b694 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__duplicate_keyword_arguments.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__duplicate_keyword_arguments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/duplicate_keyword_arguments.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_expression.py.snap index 421422c823901..46cb028b2a619 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_expression.py.snap @@ -178,14 +178,14 @@ Module( 1 | call(x + y = 1) 2 | call(x := 1 = 1) | ^^^^^^ Syntax Error: Expected a parameter name -3 | +3 | 4 | call(yield x) | | 2 | call(x := 1 = 1) -3 | +3 | 4 | call(yield x) | ^^^^^^^ Syntax Error: Yield expression cannot be used here 5 | call(yield from x) diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_keyword_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_keyword_expression.py.snap index ed40594a67d8b..1f990885a4eb7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_keyword_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_keyword_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/invalid_keyword_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_order.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_order.py.snap index 88887650f1226..b4a999a44874e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_order.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__invalid_order.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/invalid_order.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_argument.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_argument.py.snap index dab4a4db50d54..2fd99bd6cb3f0 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_argument.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_argument.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/missing_argument.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_comma.py.snap index 229848f77fb8b..43abd82cae46c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/missing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_expression.py.snap index ca673d00fe313..1c86ec46e3621 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__missing_expression.py.snap @@ -161,6 +161,6 @@ Module( 2 | call(x = ) 3 | call(*, y) | ^ Syntax Error: Expected an expression -4 | +4 | 5 | foo | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__starred.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__starred.py.snap index f538b700391f1..3c1e2f02bbb3c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__starred.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__starred.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/arguments/starred.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_0.py.snap index 4f8681244d93f..0ea8939500055 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_0.py.snap @@ -68,7 +68,7 @@ Module( | 1 | call( | ^ Syntax Error: Expected ')', found newline -2 | +2 | 3 | def foo(): 4 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_1.py.snap index 3654bb9411da4..af8a140c61834 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_1.py.snap @@ -76,7 +76,7 @@ Module( | 1 | call(x | ^ Syntax Error: Expected ')', found newline -2 | +2 | 3 | def foo(): 4 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_2.py.snap index 2b49a046b2c39..d41c5727a7bab 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__arguments__unclosed_2.py.snap @@ -76,7 +76,7 @@ Module( | 1 | call(x, | ^ Syntax Error: Expected ')', found newline -2 | +2 | 3 | def foo(): 4 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__invalid_member.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__invalid_member.py.snap index 17e22755330f6..0ab3721b7a554 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__invalid_member.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__invalid_member.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/attribute/invalid_member.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__multiple_dots.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__multiple_dots.py.snap index d9b4b66168968..a6c1f3f614e50 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__multiple_dots.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__multiple_dots.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/attribute/multiple_dots.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__no_member.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__no_member.py.snap index d2eed0a8e53c2..440c42423fefe 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__no_member.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__attribute__no_member.py.snap @@ -76,7 +76,7 @@ Module( 2 | first. | ^ Syntax Error: Expected an identifier 3 | second -4 | +4 | 5 | # No member access after the dot. | @@ -84,5 +84,5 @@ Module( | 5 | # No member access after the dot. 6 | last. - | Syntax Error: Expected an identifier + | ^ Syntax Error: Expected an identifier | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_0.py.snap index 0164501aa5f09..747e1c7a79539 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_0.py.snap @@ -61,6 +61,6 @@ Module( 1 | # No expression after `await`, an expression on another line 2 | await | ^ Syntax Error: Expected an expression -3 | +3 | 4 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_1.py.snap index 57dc152f35cea..7d67f0e7008b6 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__no_expression_1.py.snap @@ -64,7 +64,7 @@ Module( 1 | # No expression after `await`, a statement on another line 2 | await | ^ Syntax Error: Expected an expression -3 | +3 | 4 | def foo(): 5 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__recover.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__recover.py.snap index e07ab46242c93..87c433552a4a5 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__recover.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__await__recover.py.snap @@ -248,7 +248,7 @@ Module( 4 | # Nested await 5 | await await x | ^^^^^^^ Syntax Error: Await expression cannot be used here -6 | +6 | 7 | # Starred expressions | @@ -266,7 +266,7 @@ Module( 8 | await *x 9 | await (*x) | ^^ Syntax Error: Starred expression cannot be used here -10 | +10 | 11 | # Invalid expression as per precedence | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__invalid_rhs_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__invalid_rhs_expression.py.snap index 81f73870150ca..cb65ebee14364 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__invalid_rhs_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__invalid_rhs_expression.py.snap @@ -103,14 +103,14 @@ Module( | 1 | x + lambda y: y | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -2 | +2 | 3 | x - yield y | | 1 | x + lambda y: y -2 | +2 | 3 | x - yield y | ^^^^^^^ Syntax Error: Yield expression cannot be used here | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_lhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_lhs.py.snap index f244c636ad2d6..7e9d24594d17e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_lhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_lhs.py.snap @@ -57,6 +57,6 @@ Module( | 1 | / y | ^ Syntax Error: Expected a statement -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_0.py.snap index a766ceda9cf18..9f84e4249e785 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_0.py.snap @@ -71,6 +71,6 @@ Module( | 1 | 0 + | ^ Syntax Error: Expected an expression -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_1.py.snap index 1a5e9fb0386aa..2951642fe3f0b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__missing_rhs_1.py.snap @@ -99,6 +99,6 @@ Module( | 1 | 1 + 2 - 3 * | ^ Syntax Error: Expected an expression -2 | +2 | 3 | 4 + 5 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__multiple_ops.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__multiple_ops.py.snap index 24db57185b3bc..2bcbe82a7e502 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__multiple_ops.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__multiple_ops.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bin_op/multiple_ops.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__named_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__named_expression.py.snap index 89624a06e8d80..f38974105d4b6 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__named_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__named_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bin_op/named_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__starred_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__starred_expression.py.snap index 65f2ce048de3d..cc1cc268ad3dd 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__starred_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bin_op__starred_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bin_op/starred_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__invalid_rhs_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__invalid_rhs_expression.py.snap index 2268d3a7b0ca6..9b4a04616ca2a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__invalid_rhs_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__invalid_rhs_expression.py.snap @@ -107,14 +107,14 @@ Module( | 1 | x and lambda y: y | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -2 | +2 | 3 | x or yield y | | 1 | x and lambda y: y -2 | +2 | 3 | x or yield y | ^^^^^^^ Syntax Error: Yield expression cannot be used here | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_lhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_lhs.py.snap index bba4257d31040..6818a4a9bf688 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_lhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_lhs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bool_op/missing_lhs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_rhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_rhs.py.snap index 92a7651203541..34a82c7f26085 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_rhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__missing_rhs.py.snap @@ -72,6 +72,6 @@ Module( | 1 | x and | ^ Syntax Error: Expected an expression -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__named_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__named_expression.py.snap index 782763d0daa52..c7af1705281fa 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__named_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__named_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bool_op/named_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__starred_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__starred_expression.py.snap index cc1e7edfccdb9..76db7d093a211 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__starred_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__bool_op__starred_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/bool_op/starred_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_order.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_order.py.snap index 964cd9c9e8f0e..efd6a63b4df80 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_order.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_order.py.snap @@ -133,7 +133,7 @@ Module( | 1 | x in not y | ^^^^^ Syntax Error: Boolean 'not' expression cannot be used here -2 | +2 | 3 | # `=>` instead of `>=` | @@ -142,7 +142,7 @@ Module( 3 | # `=>` instead of `>=` 4 | x => y | ^ Syntax Error: Expected an expression -5 | +5 | 6 | # Same here as well, `not` without `in` is considered to be a unary operator | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_rhs_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_rhs_expression.py.snap index 415395193d922..7fac7231c751e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_rhs_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__invalid_rhs_expression.py.snap @@ -111,14 +111,14 @@ Module( | 1 | x not in lambda y: y | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -2 | +2 | 3 | x == yield y | | 1 | x not in lambda y: y -2 | +2 | 3 | x == yield y | ^^^^^^^ Syntax Error: Yield expression cannot be used here | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_lhs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_lhs.py.snap index d726803994ff5..755eb042a5979 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_lhs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_lhs.py.snap @@ -57,6 +57,6 @@ Module( | 1 | > y | ^ Syntax Error: Expected a statement -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_0.py.snap index d704cd736da69..135f76de35938 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_0.py.snap @@ -74,6 +74,6 @@ Module( | 1 | x > | ^ Syntax Error: Expected an expression -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_1.py.snap index cce5b0d788676..f61bcb3b89129 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_1.py.snap @@ -76,7 +76,7 @@ Module( 1 | # Without the `in`, this is considered to be a unary `not` 2 | x not | ^^^ Syntax Error: Simple statements must be separated by newlines or semicolons -3 | +3 | 4 | 1 + 2 | @@ -85,6 +85,6 @@ Module( 1 | # Without the `in`, this is considered to be a unary `not` 2 | x not | ^ Syntax Error: Expected an expression -3 | +3 | 4 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_2.py.snap index cf0cae2ef6c22..e530d30468f2e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__missing_rhs_2.py.snap @@ -74,6 +74,6 @@ Module( | 1 | x is not | ^ Syntax Error: Expected an expression -2 | +2 | 3 | 1 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__multiple_equals.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__multiple_equals.py.snap index 9a5bab9af83ed..d3879e17a80c7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__multiple_equals.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__multiple_equals.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/compare/multiple_equals.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__named_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__named_expression.py.snap index 2d3c0dbb8c585..27be524dd397c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__named_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__named_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/compare/named_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__starred_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__starred_expression.py.snap index 0988005a771b0..61e69b69f969f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__starred_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__compare__starred_expression.py.snap @@ -166,14 +166,14 @@ Module( 1 | x >= *y 2 | x not in *y | ^^ Syntax Error: Starred expression cannot be used here -3 | +3 | 4 | *x < y | | 2 | x not in *y -3 | +3 | 4 | *x < y | ^^^^^ Syntax Error: Comparison expression cannot be used here 5 | *x is not y diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__comprehension.py.snap index aca3cd963c47c..6d06ef0c123f9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__comprehension.py.snap @@ -748,7 +748,7 @@ Module( 4 | {x: y for call() in y} 5 | {x: y for {a, b} in y} | ^^^^^^ Syntax Error: Invalid assignment target -6 | +6 | 7 | # Invalid iter | @@ -786,7 +786,7 @@ Module( 10 | {x: y for x in yield from y} 11 | {x: y for x in lambda y: y} | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -12 | +12 | 13 | # Invalid if | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star.py.snap index 98af41e0dd157..18f34772fa4e0 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star.py.snap @@ -481,7 +481,7 @@ Module( | 2 | # the ones which are higher than that. -3 | +3 | 4 | {**x := 1} | ^^ Syntax Error: Expected ',', found ':=' 5 | {a: 1, **x if True else y} @@ -491,7 +491,7 @@ Module( | 2 | # the ones which are higher than that. -3 | +3 | 4 | {**x := 1} | ^ Syntax Error: Expected ':', found '}' 5 | {a: 1, **x if True else y} diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star_comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star_comprehension.py.snap index d6aae33ea7ca9..2cdfca37149d4 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star_comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__double_star_comprehension.py.snap @@ -110,49 +110,49 @@ Module( | 2 | # it's actually a comprehension. -3 | +3 | 4 | {**x: y for x, y in data} | ^ Syntax Error: Expected an expression or a '}' -5 | +5 | 6 | # TODO(dhruvmanila): This test case fails because there's no way to represent `**y` | | 2 | # it's actually a comprehension. -3 | +3 | 4 | {**x: y for x, y in data} | ^^^ Syntax Error: Expected ':', found 'for' -5 | +5 | 6 | # TODO(dhruvmanila): This test case fails because there's no way to represent `**y` | | 2 | # it's actually a comprehension. -3 | +3 | 4 | {**x: y for x, y in data} | ^ Syntax Error: Expected ',', found name -5 | +5 | 6 | # TODO(dhruvmanila): This test case fails because there's no way to represent `**y` | | 2 | # it's actually a comprehension. -3 | +3 | 4 | {**x: y for x, y in data} | ^ Syntax Error: Expected ':', found ',' -5 | +5 | 6 | # TODO(dhruvmanila): This test case fails because there's no way to represent `**y` | | 2 | # it's actually a comprehension. -3 | +3 | 4 | {**x: y for x, y in data} | ^ Syntax Error: Expected ':', found '}' -5 | +5 | 6 | # TODO(dhruvmanila): This test case fails because there's no way to represent `**y` | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_0.py.snap index 4d8b3e3e6c397..45b456fe189ec 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_0.py.snap @@ -75,7 +75,7 @@ Module( | 1 | {x: -2 | +2 | 3 | def foo(): | ^^^ Syntax Error: Expected an identifier, but found a keyword 'def' that cannot be used here 4 | pass @@ -84,7 +84,7 @@ Module( | 1 | {x: -2 | +2 | 3 | def foo(): | ^^^ Syntax Error: Expected ',', found name 4 | pass @@ -101,5 +101,5 @@ Module( | 3 | def foo(): 4 | pass - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_1.py.snap index 6705246116c97..67b4fca986ec0 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_1.py.snap @@ -62,7 +62,7 @@ Module( | 1 | {x: -2 | +2 | 3 | 1 + 2 - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_2.py.snap index 00cc3d110cbc7..99ceea07ed510 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__missing_closing_brace_2.py.snap @@ -77,7 +77,7 @@ Module( | 1 | {x: 1, | ^ Syntax Error: Expected '}', found newline -2 | +2 | 3 | def foo(): 4 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_0.py.snap index 81078747c88b9..b3123ce9b0317 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_0.py.snap @@ -122,19 +122,19 @@ Module( | 1 | # Unparenthesized named expression not allowed in key -2 | +2 | 3 | {x := 1: y, z := 2: a} | ^^^^^^ Syntax Error: Unparenthesized named expression cannot be used here -4 | +4 | 5 | x + y | | 1 | # Unparenthesized named expression not allowed in key -2 | +2 | 3 | {x := 1: y, z := 2: a} | ^^ Syntax Error: Expected ':', found ':=' -4 | +4 | 5 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_1.py.snap index 4776fda92b7bf..dd7855f8b4791 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__named_expression_1.py.snap @@ -128,39 +128,39 @@ Module( | 1 | # Unparenthesized named expression not allowed in value -2 | +2 | 3 | {x: y := 1, z: a := 2} | ^^ Syntax Error: Expected ',', found ':=' -4 | +4 | 5 | x + y | | 1 | # Unparenthesized named expression not allowed in value -2 | +2 | 3 | {x: y := 1, z: a := 2} | ^ Syntax Error: Expected ':', found ',' -4 | +4 | 5 | x + y | | 1 | # Unparenthesized named expression not allowed in value -2 | +2 | 3 | {x: y := 1, z: a := 2} | ^^ Syntax Error: Expected ',', found ':=' -4 | +4 | 5 | x + y | | 1 | # Unparenthesized named expression not allowed in value -2 | +2 | 3 | {x: y := 1, z: a := 2} | ^ Syntax Error: Expected ':', found '}' -4 | +4 | 5 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__recover.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__recover.py.snap index bbb7c91204228..71d01983722cc 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__recover.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__dict__recover.py.snap @@ -421,30 +421,30 @@ Module( | 1 | # Test cases for dictionary expressions where the parser recovers from a syntax error. -2 | +2 | 3 | {,} | ^ Syntax Error: Expected an expression -4 | +4 | 5 | {1: 2,,3: 4} | | 3 | {,} -4 | +4 | 5 | {1: 2,,3: 4} | ^ Syntax Error: Expected an expression or a '}' -6 | +6 | 7 | {1: 2,,} | | 5 | {1: 2,,3: 4} -6 | +6 | 7 | {1: 2,,} | ^ Syntax Error: Expected an expression or a '}' -8 | +8 | 9 | # Missing comma | @@ -453,7 +453,7 @@ Module( 9 | # Missing comma 10 | {1: 2 3: 4} | ^ Syntax Error: Expected ',', found int -11 | +11 | 12 | # No value | @@ -462,7 +462,7 @@ Module( 12 | # No value 13 | {1: } | ^ Syntax Error: Expected an expression -14 | +14 | 15 | # No value for double star unpacking | @@ -480,7 +480,7 @@ Module( 16 | {**} 17 | {x: y, **, a: b} | ^ Syntax Error: Expected an expression -18 | +18 | 19 | # This is not a double star unpacking | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_identifiers.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_identifiers.py.snap index c3bf1599c0a06..7a4f5b3f5d643 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_identifiers.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_identifiers.py.snap @@ -88,7 +88,7 @@ Module( 2 | # comment 🐶 3 | ) | ^ Syntax Error: Expected a statement -4 | +4 | 5 | a = (🐶 + | @@ -98,7 +98,7 @@ Module( 2 | # comment 🐶 3 | ) | ^ Syntax Error: Expected a statement -4 | +4 | 5 | a = (🐶 + 6 | # comment | @@ -106,7 +106,7 @@ Module( | 3 | ) -4 | +4 | 5 | a = (🐶 + | ^^ Syntax Error: Got unexpected token 🐶 6 | # comment diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_statement.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_statement.py.snap index 7956a34adb77f..8738dedd6d3e4 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_statement.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__emoji_statement.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/emoji_statement.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_0.py.snap index d1405f41f78f7..380694740073e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_0.py.snap @@ -78,7 +78,7 @@ Module( 1 | # Missing orelse expression, followed by a statement 2 | x if expr else | ^ Syntax Error: Expected an expression -3 | +3 | 4 | def foo(): 5 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_1.py.snap index 218a36f34cfa0..21c4bce330eef 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_orelse_expr_1.py.snap @@ -77,6 +77,6 @@ Module( 1 | # Missing orelse expression, followed by an expression 2 | x if expr else | ^ Syntax Error: Expected an expression -3 | +3 | 4 | 1 + 1 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_0.py.snap index fe3c7bc22a39a..e621d76610c15 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_0.py.snap @@ -78,7 +78,7 @@ Module( 1 | # Missing test expression, followed by a statement 2 | x if | ^ Syntax Error: Expected an expression -3 | +3 | 4 | def foo(): 5 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_1.py.snap index 7efd57df11d0f..1289e838434a5 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__missing_test_expr_1.py.snap @@ -77,6 +77,6 @@ Module( 1 | # Missing test expression, followed by an expression 2 | x if | ^ Syntax Error: Expected an expression -3 | +3 | 4 | 1 + 1 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__recover.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__recover.py.snap index c610719116df7..dd35e9a27d710 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__recover.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__if__recover.py.snap @@ -329,7 +329,7 @@ Module( 4 | x if yield x else y 5 | x if yield from x else y | ^^^^^^^^^^^^ Syntax Error: Yield expression cannot be used here -6 | +6 | 7 | # Invalid orelse expression | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_default_parameters.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_default_parameters.py.snap index e0ae6e6e4a29e..3d9df97c4640e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_default_parameters.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_default_parameters.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/lambda_default_parameters.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_duplicate_parameters.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_duplicate_parameters.py.snap index 3d017d058b9f5..6ea4a192edaf1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_duplicate_parameters.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__lambda_duplicate_parameters.py.snap @@ -284,55 +284,57 @@ Module( ``` ## Errors + | +7 | lambda a, *a: 1 +8 | +9 | lambda a, *, **a: 1 + | ^^^ Syntax Error: Expected one or more keyword parameter after '*' separator + | + + +## Semantic Syntax Errors + | 1 | lambda a, a: 1 | ^ Syntax Error: Duplicate parameter "a" -2 | +2 | 3 | lambda a, *, a: 1 | | 1 | lambda a, a: 1 -2 | +2 | 3 | lambda a, *, a: 1 | ^ Syntax Error: Duplicate parameter "a" -4 | +4 | 5 | lambda a, a=20: 1 | | 3 | lambda a, *, a: 1 -4 | +4 | 5 | lambda a, a=20: 1 | ^ Syntax Error: Duplicate parameter "a" -6 | +6 | 7 | lambda a, *a: 1 | | 5 | lambda a, a=20: 1 -6 | +6 | 7 | lambda a, *a: 1 | ^ Syntax Error: Duplicate parameter "a" -8 | +8 | 9 | lambda a, *, **a: 1 | | 7 | lambda a, *a: 1 -8 | -9 | lambda a, *, **a: 1 - | ^^^ Syntax Error: Expected one or more keyword parameter after '*' separator - | - - - | -7 | lambda a, *a: 1 -8 | +8 | 9 | lambda a, *, **a: 1 | ^ Syntax Error: Duplicate parameter "a" | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__comprehension.py.snap index be422050d77ae..124079789dd45 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__comprehension.py.snap @@ -679,7 +679,7 @@ Module( 1 | # Iterable unpacking not allowed 2 | [*x for x in y] | ^^ Syntax Error: Iterable unpacking cannot be used in a comprehension -3 | +3 | 4 | # Invalid target | @@ -717,7 +717,7 @@ Module( 7 | [x for call() in y] 8 | [x for {a, b} in y] | ^^^^^^ Syntax Error: Invalid assignment target - 9 | + 9 | 10 | # Invalid iter | @@ -755,7 +755,7 @@ Module( 13 | [x for x in yield from y] 14 | [x for x in lambda y: y] | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -15 | +15 | 16 | # Invalid if | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_0.py.snap index e7ec874488ffb..efe0f9aaa32cb 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_0.py.snap @@ -37,7 +37,7 @@ Module( | 1 | # Missing closing bracket 0: No elements -2 | +2 | 3 | [ - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_1.py.snap index 1c59c84935b60..20f04c756cc78 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_1.py.snap @@ -50,7 +50,7 @@ Module( | 4 | [ -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_2.py.snap index 529c718a506e6..c253897cdee8f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_2.py.snap @@ -58,7 +58,7 @@ Module( | 4 | [1, -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_3.py.snap index 604af52d20be3..9a64dd38fcd62 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__missing_closing_bracket_3.py.snap @@ -74,10 +74,10 @@ Module( | 2 | # token starts a statement. -3 | +3 | 4 | [1, 2 | ^ Syntax Error: Expected ']', found newline -5 | +5 | 6 | def foo(): 7 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__recover.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__recover.py.snap index 7b981e1dd44cf..a3979fcf8a6da 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__recover.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__recover.py.snap @@ -241,30 +241,30 @@ Module( | 1 | # Test cases for list expressions where the parser recovers from a syntax error. -2 | +2 | 3 | [,] | ^ Syntax Error: Expected an expression -4 | +4 | 5 | [1,,2] | | 3 | [,] -4 | +4 | 5 | [1,,2] | ^ Syntax Error: Expected an expression or a ']' -6 | +6 | 7 | [1,,] | | 5 | [1,,2] -6 | +6 | 7 | [1,,] | ^ Syntax Error: Expected an expression or a ']' -8 | +8 | 9 | # Missing comma | @@ -273,7 +273,7 @@ Module( 9 | # Missing comma 10 | [1 2] | ^ Syntax Error: Expected ',', found int -11 | +11 | 12 | # Dictionary element in a list | @@ -282,7 +282,7 @@ Module( 12 | # Dictionary element in a list 13 | [1: 2] | ^ Syntax Error: Expected an expression or a ']' -14 | +14 | 15 | # Missing expression | @@ -291,24 +291,24 @@ Module( 15 | # Missing expression 16 | [1, x + ] | ^ Syntax Error: Expected an expression -17 | +17 | 18 | [1; 2] | | 16 | [1, x + ] -17 | +17 | 18 | [1; 2] | ^ Syntax Error: Expected an expression or a ']' -19 | +19 | 20 | [*] | | 18 | [1; 2] -19 | +19 | 20 | [*] | ^ Syntax Error: Expected an expression | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__star_expression_precedence.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__star_expression_precedence.py.snap index edc30e1d71571..97dfb3722e30c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__star_expression_precedence.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__list__star_expression_precedence.py.snap @@ -393,7 +393,7 @@ Module( | 1 | # For list expression, the minimum binding power of star expression is bitwise or. -2 | +2 | 3 | [(*x), y] | ^^ Syntax Error: Starred expression cannot be used here 4 | [*x in y, z] diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__invalid_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__invalid_target.py.snap index 6d494f709cf6a..c10ee4aac896e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__invalid_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__invalid_target.py.snap @@ -177,7 +177,7 @@ Module( | 1 | # Assignment expression target can only be an identifier -2 | +2 | 3 | (x.y := 1) | ^^^ Syntax Error: Assignment expression target must be an identifier 4 | (x[y] := 1) diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_0.py.snap index 242e26e5f6fac..33371ac311523 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_0.py.snap @@ -29,7 +29,7 @@ Module( | 1 | # There are no parentheses, so this isn't parsed as named expression. -2 | +2 | 3 | x := | ^^ Syntax Error: Expected a statement | @@ -37,7 +37,7 @@ Module( | 1 | # There are no parentheses, so this isn't parsed as named expression. -2 | +2 | 3 | x := - | Syntax Error: Expected a statement + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_1.py.snap index 253880c410e0c..7fbfdf4dc9204 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_1.py.snap @@ -41,7 +41,7 @@ Module( | 1 | # EOF after the `:=` token -2 | +2 | 3 | (x := - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_2.py.snap index 30608f4b8ab8b..77c7726c6944e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_2.py.snap @@ -72,7 +72,7 @@ Module( | 3 | (x := -4 | +4 | 5 | def foo(): | ^^^ Syntax Error: Expected an identifier, but found a keyword 'def' that cannot be used here 6 | pass @@ -81,7 +81,7 @@ Module( | 3 | (x := -4 | +4 | 5 | def foo(): | ^^^ Syntax Error: Expected ')', found name 6 | pass @@ -98,5 +98,5 @@ Module( | 5 | def foo(): 6 | pass - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_3.py.snap index 53e9b2fba0426..1ec0d5d924e36 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_3.py.snap @@ -54,7 +54,7 @@ Module( | 4 | (x := -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_4.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_4.py.snap index 7a1537006a3d6..8f056e9ec54ba 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_4.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__named__missing_expression_4.py.snap @@ -66,9 +66,9 @@ Module( | 1 | # No expression on the right side of the assignment expression -2 | +2 | 3 | (x := ) | ^ Syntax Error: Expected an expression -4 | +4 | 5 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__generator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__generator.py.snap index 3fa1fc2f2e201..f547981164cd1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__generator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__generator.py.snap @@ -140,5 +140,5 @@ Module( | 1 | (*x for x in y) 2 | (x := 1, for x in y) - | Syntax Error: Expected a statement + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_0.py.snap index c2acf808fa7ea..7b610ed0d11b4 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_0.py.snap @@ -29,7 +29,7 @@ Module( | 1 | # Missing closing parentheses 0: No elements -2 | +2 | 3 | ( - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_1.py.snap index 2cac7005580ec..02ff2cf395a0f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_1.py.snap @@ -42,7 +42,7 @@ Module( | 4 | ( -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_2.py.snap index e10df7aafa422..b793308c04bef 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_2.py.snap @@ -59,7 +59,7 @@ Module( | 4 | (1, -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_3.py.snap index ad99ccea89b8a..9afe7ee6e72b1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__missing_closing_paren_3.py.snap @@ -75,10 +75,10 @@ Module( | 2 | # token starts a statement. -3 | +3 | 4 | (1, 2 | ^ Syntax Error: Expected ')', found newline -5 | +5 | 6 | def foo(): 7 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__parenthesized.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__parenthesized.py.snap index b8fd6f0455467..c61c600e25c38 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__parenthesized.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__parenthesized.py.snap @@ -62,7 +62,7 @@ Module( 1 | # Starred expression isn't allowed in a parenthesized expression. 2 | (*x) | ^^ Syntax Error: Starred expression cannot be used here -3 | +3 | 4 | # Unparenthesized named expression is allowed. | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple.py.snap index eac91f1998f84..e62134566929b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple.py.snap @@ -250,30 +250,30 @@ Module( | 1 | # Test cases for tuple expressions where the parser recovers from a syntax error. -2 | +2 | 3 | (,) | ^ Syntax Error: Expected an expression -4 | +4 | 5 | (1,,2) | | 3 | (,) -4 | +4 | 5 | (1,,2) | ^ Syntax Error: Expected an expression or a ')' -6 | +6 | 7 | (1,,) | | 5 | (1,,2) -6 | +6 | 7 | (1,,) | ^ Syntax Error: Expected an expression or a ')' -8 | +8 | 9 | # Missing comma | @@ -282,7 +282,7 @@ Module( 9 | # Missing comma 10 | (1 2) | ^ Syntax Error: Expected ')', found int -11 | +11 | 12 | # Dictionary element in a list | @@ -291,7 +291,7 @@ Module( 9 | # Missing comma 10 | (1 2) | ^ Syntax Error: Expected a statement -11 | +11 | 12 | # Dictionary element in a list | @@ -300,7 +300,7 @@ Module( 9 | # Missing comma 10 | (1 2) | ^ Syntax Error: Expected a statement -11 | +11 | 12 | # Dictionary element in a list 13 | (1: 2) | @@ -310,7 +310,7 @@ Module( 12 | # Dictionary element in a list 13 | (1: 2) | ^ Syntax Error: Expected ')', found ':' -14 | +14 | 15 | # Missing expression | @@ -319,7 +319,7 @@ Module( 12 | # Dictionary element in a list 13 | (1: 2) | ^ Syntax Error: Invalid annotated assignment target -14 | +14 | 15 | # Missing expression | @@ -328,7 +328,7 @@ Module( 12 | # Dictionary element in a list 13 | (1: 2) | ^ Syntax Error: Expected a statement -14 | +14 | 15 | # Missing expression | @@ -337,7 +337,7 @@ Module( 12 | # Dictionary element in a list 13 | (1: 2) | ^ Syntax Error: Expected a statement -14 | +14 | 15 | # Missing expression 16 | (1, x + ) | @@ -347,37 +347,37 @@ Module( 15 | # Missing expression 16 | (1, x + ) | ^ Syntax Error: Expected an expression -17 | +17 | 18 | (1; 2) | | 16 | (1, x + ) -17 | +17 | 18 | (1; 2) | ^ Syntax Error: Expected ')', found ';' -19 | +19 | 20 | # Unparenthesized named expression is not allowed | | 16 | (1, x + ) -17 | +17 | 18 | (1; 2) | ^ Syntax Error: Expected a statement -19 | +19 | 20 | # Unparenthesized named expression is not allowed | | 16 | (1, x + ) -17 | +17 | 18 | (1; 2) | ^ Syntax Error: Expected a statement -19 | +19 | 20 | # Unparenthesized named expression is not allowed 21 | x, y := 2, z | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple_starred_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple_starred_expr.py.snap index 5133374b14b0c..a81a6db84be53 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple_starred_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__parenthesized__tuple_starred_expr.py.snap @@ -7,24 +7,24 @@ input_file: crates/ruff_python_parser/resources/invalid/expressions/parenthesize ``` Module( ModModule { - range: 0..536, + range: 0..532, body: [ Expr( StmtExpr { - range: 161..182, + range: 157..178, value: Tuple( ExprTuple { - range: 161..182, + range: 157..178, elts: [ Starred( ExprStarred { - range: 162..169, + range: 158..165, value: Compare( ExprCompare { - range: 163..169, + range: 159..165, left: Name( ExprName { - range: 163..164, + range: 159..160, id: Name("x"), ctx: Load, }, @@ -35,7 +35,7 @@ Module( comparators: [ Name( ExprName { - range: 168..169, + range: 164..165, id: Name("y"), ctx: Load, }, @@ -48,20 +48,20 @@ Module( ), Name( ExprName { - range: 171..172, + range: 167..168, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 174..181, + range: 170..177, value: Compare( ExprCompare { - range: 175..181, + range: 171..177, left: Name( ExprName { - range: 175..176, + range: 171..172, id: Name("x"), ctx: Load, }, @@ -72,7 +72,7 @@ Module( comparators: [ Name( ExprName { - range: 180..181, + range: 176..177, id: Name("y"), ctx: Load, }, @@ -92,21 +92,21 @@ Module( ), Expr( StmtExpr { - range: 183..202, + range: 179..198, value: Tuple( ExprTuple { - range: 183..202, + range: 179..198, elts: [ Starred( ExprStarred { - range: 184..190, + range: 180..186, value: UnaryOp( ExprUnaryOp { - range: 185..190, + range: 181..186, op: Not, operand: Name( ExprName { - range: 189..190, + range: 185..186, id: Name("x"), ctx: Load, }, @@ -118,21 +118,21 @@ Module( ), Name( ExprName { - range: 192..193, + range: 188..189, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 195..201, + range: 191..197, value: UnaryOp( ExprUnaryOp { - range: 196..201, + range: 192..197, op: Not, operand: Name( ExprName { - range: 200..201, + range: 196..197, id: Name("x"), ctx: Load, }, @@ -151,29 +151,29 @@ Module( ), Expr( StmtExpr { - range: 203..226, + range: 199..222, value: Tuple( ExprTuple { - range: 203..226, + range: 199..222, elts: [ Starred( ExprStarred { - range: 204..212, + range: 200..208, value: BoolOp( ExprBoolOp { - range: 205..212, + range: 201..208, op: And, values: [ Name( ExprName { - range: 205..206, + range: 201..202, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 211..212, + range: 207..208, id: Name("y"), ctx: Load, }, @@ -186,29 +186,29 @@ Module( ), Name( ExprName { - range: 214..215, + range: 210..211, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 217..225, + range: 213..221, value: BoolOp( ExprBoolOp { - range: 218..225, + range: 214..221, op: And, values: [ Name( ExprName { - range: 218..219, + range: 214..215, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 224..225, + range: 220..221, id: Name("y"), ctx: Load, }, @@ -228,29 +228,29 @@ Module( ), Expr( StmtExpr { - range: 227..248, + range: 223..244, value: Tuple( ExprTuple { - range: 227..248, + range: 223..244, elts: [ Starred( ExprStarred { - range: 228..235, + range: 224..231, value: BoolOp( ExprBoolOp { - range: 229..235, + range: 225..231, op: Or, values: [ Name( ExprName { - range: 229..230, + range: 225..226, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 234..235, + range: 230..231, id: Name("y"), ctx: Load, }, @@ -263,29 +263,29 @@ Module( ), Name( ExprName { - range: 237..238, + range: 233..234, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 240..247, + range: 236..243, value: BoolOp( ExprBoolOp { - range: 241..247, + range: 237..243, op: Or, values: [ Name( ExprName { - range: 241..242, + range: 237..238, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 246..247, + range: 242..243, id: Name("y"), ctx: Load, }, @@ -305,33 +305,33 @@ Module( ), Expr( StmtExpr { - range: 249..290, + range: 245..286, value: Tuple( ExprTuple { - range: 249..290, + range: 245..286, elts: [ Starred( ExprStarred { - range: 250..267, + range: 246..263, value: If( ExprIf { - range: 251..267, + range: 247..263, test: BooleanLiteral( ExprBooleanLiteral { - range: 256..260, + range: 252..256, value: true, }, ), body: Name( ExprName { - range: 251..252, + range: 247..248, id: Name("x"), ctx: Load, }, ), orelse: Name( ExprName { - range: 266..267, + range: 262..263, id: Name("y"), ctx: Load, }, @@ -343,33 +343,33 @@ Module( ), Name( ExprName { - range: 269..270, + range: 265..266, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 272..289, + range: 268..285, value: If( ExprIf { - range: 273..289, + range: 269..285, test: BooleanLiteral( ExprBooleanLiteral { - range: 278..282, + range: 274..278, value: true, }, ), body: Name( ExprName { - range: 273..274, + range: 269..270, id: Name("x"), ctx: Load, }, ), orelse: Name( ExprName { - range: 288..289, + range: 284..285, id: Name("y"), ctx: Load, }, @@ -388,29 +388,29 @@ Module( ), Expr( StmtExpr { - range: 291..322, + range: 287..318, value: Tuple( ExprTuple { - range: 291..322, + range: 287..318, elts: [ Starred( ExprStarred { - range: 292..304, + range: 288..300, value: Lambda( ExprLambda { - range: 293..304, + range: 289..300, parameters: Some( Parameters { - range: 300..301, + range: 296..297, posonlyargs: [], args: [ ParameterWithDefault { - range: 300..301, + range: 296..297, parameter: Parameter { - range: 300..301, + range: 296..297, name: Identifier { id: Name("x"), - range: 300..301, + range: 296..297, }, annotation: None, }, @@ -424,7 +424,7 @@ Module( ), body: Name( ExprName { - range: 303..304, + range: 299..300, id: Name("x"), ctx: Load, }, @@ -436,29 +436,29 @@ Module( ), Name( ExprName { - range: 306..307, + range: 302..303, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 309..321, + range: 305..317, value: Lambda( ExprLambda { - range: 310..321, + range: 306..317, parameters: Some( Parameters { - range: 317..318, + range: 313..314, posonlyargs: [], args: [ ParameterWithDefault { - range: 317..318, + range: 313..314, parameter: Parameter { - range: 317..318, + range: 313..314, name: Identifier { id: Name("x"), - range: 317..318, + range: 313..314, }, annotation: None, }, @@ -472,7 +472,7 @@ Module( ), body: Name( ExprName { - range: 320..321, + range: 316..317, id: Name("x"), ctx: Load, }, @@ -491,20 +491,20 @@ Module( ), Expr( StmtExpr { - range: 323..344, + range: 319..340, value: Tuple( ExprTuple { - range: 323..344, + range: 319..340, elts: [ Named( ExprNamed { - range: 324..331, + range: 320..327, target: Starred( ExprStarred { - range: 324..326, + range: 320..322, value: Name( ExprName { - range: 325..326, + range: 321..322, id: Name("x"), ctx: Store, }, @@ -514,7 +514,7 @@ Module( ), value: NumberLiteral( ExprNumberLiteral { - range: 330..331, + range: 326..327, value: Int( 2, ), @@ -524,20 +524,20 @@ Module( ), Name( ExprName { - range: 333..334, + range: 329..330, id: Name("z"), ctx: Load, }, ), Named( ExprNamed { - range: 336..343, + range: 332..339, target: Starred( ExprStarred { - range: 336..338, + range: 332..334, value: Name( ExprName { - range: 337..338, + range: 333..334, id: Name("x"), ctx: Store, }, @@ -547,7 +547,7 @@ Module( ), value: NumberLiteral( ExprNumberLiteral { - range: 342..343, + range: 338..339, value: Int( 2, ), @@ -564,20 +564,20 @@ Module( ), Expr( StmtExpr { - range: 367..386, + range: 363..382, value: Tuple( ExprTuple { - range: 367..386, + range: 363..382, elts: [ Starred( ExprStarred { - range: 367..374, + range: 363..370, value: Compare( ExprCompare { - range: 368..374, + range: 364..370, left: Name( ExprName { - range: 368..369, + range: 364..365, id: Name("x"), ctx: Load, }, @@ -588,7 +588,7 @@ Module( comparators: [ Name( ExprName { - range: 373..374, + range: 369..370, id: Name("y"), ctx: Load, }, @@ -601,20 +601,20 @@ Module( ), Name( ExprName { - range: 376..377, + range: 372..373, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 379..386, + range: 375..382, value: Compare( ExprCompare { - range: 380..386, + range: 376..382, left: Name( ExprName { - range: 380..381, + range: 376..377, id: Name("x"), ctx: Load, }, @@ -625,7 +625,7 @@ Module( comparators: [ Name( ExprName { - range: 385..386, + range: 381..382, id: Name("y"), ctx: Load, }, @@ -645,21 +645,21 @@ Module( ), Expr( StmtExpr { - range: 387..404, + range: 383..400, value: Tuple( ExprTuple { - range: 387..404, + range: 383..400, elts: [ Starred( ExprStarred { - range: 387..393, + range: 383..389, value: UnaryOp( ExprUnaryOp { - range: 388..393, + range: 384..389, op: Not, operand: Name( ExprName { - range: 392..393, + range: 388..389, id: Name("x"), ctx: Load, }, @@ -671,21 +671,21 @@ Module( ), Name( ExprName { - range: 395..396, + range: 391..392, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 398..404, + range: 394..400, value: UnaryOp( ExprUnaryOp { - range: 399..404, + range: 395..400, op: Not, operand: Name( ExprName { - range: 403..404, + range: 399..400, id: Name("x"), ctx: Load, }, @@ -704,29 +704,29 @@ Module( ), Expr( StmtExpr { - range: 405..426, + range: 401..422, value: Tuple( ExprTuple { - range: 405..426, + range: 401..422, elts: [ Starred( ExprStarred { - range: 405..413, + range: 401..409, value: BoolOp( ExprBoolOp { - range: 406..413, + range: 402..409, op: And, values: [ Name( ExprName { - range: 406..407, + range: 402..403, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 412..413, + range: 408..409, id: Name("y"), ctx: Load, }, @@ -739,29 +739,29 @@ Module( ), Name( ExprName { - range: 415..416, + range: 411..412, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 418..426, + range: 414..422, value: BoolOp( ExprBoolOp { - range: 419..426, + range: 415..422, op: And, values: [ Name( ExprName { - range: 419..420, + range: 415..416, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 425..426, + range: 421..422, id: Name("y"), ctx: Load, }, @@ -781,29 +781,29 @@ Module( ), Expr( StmtExpr { - range: 427..446, + range: 423..442, value: Tuple( ExprTuple { - range: 427..446, + range: 423..442, elts: [ Starred( ExprStarred { - range: 427..434, + range: 423..430, value: BoolOp( ExprBoolOp { - range: 428..434, + range: 424..430, op: Or, values: [ Name( ExprName { - range: 428..429, + range: 424..425, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 433..434, + range: 429..430, id: Name("y"), ctx: Load, }, @@ -816,29 +816,29 @@ Module( ), Name( ExprName { - range: 436..437, + range: 432..433, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 439..446, + range: 435..442, value: BoolOp( ExprBoolOp { - range: 440..446, + range: 436..442, op: Or, values: [ Name( ExprName { - range: 440..441, + range: 436..437, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 445..446, + range: 441..442, id: Name("y"), ctx: Load, }, @@ -858,33 +858,33 @@ Module( ), Expr( StmtExpr { - range: 447..486, + range: 443..482, value: Tuple( ExprTuple { - range: 447..486, + range: 443..482, elts: [ Starred( ExprStarred { - range: 447..464, + range: 443..460, value: If( ExprIf { - range: 448..464, + range: 444..460, test: BooleanLiteral( ExprBooleanLiteral { - range: 453..457, + range: 449..453, value: true, }, ), body: Name( ExprName { - range: 448..449, + range: 444..445, id: Name("x"), ctx: Load, }, ), orelse: Name( ExprName { - range: 463..464, + range: 459..460, id: Name("y"), ctx: Load, }, @@ -896,33 +896,33 @@ Module( ), Name( ExprName { - range: 466..467, + range: 462..463, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 469..486, + range: 465..482, value: If( ExprIf { - range: 470..486, + range: 466..482, test: BooleanLiteral( ExprBooleanLiteral { - range: 475..479, + range: 471..475, value: true, }, ), body: Name( ExprName { - range: 470..471, + range: 466..467, id: Name("x"), ctx: Load, }, ), orelse: Name( ExprName { - range: 485..486, + range: 481..482, id: Name("y"), ctx: Load, }, @@ -941,29 +941,29 @@ Module( ), Expr( StmtExpr { - range: 487..516, + range: 483..512, value: Tuple( ExprTuple { - range: 487..516, + range: 483..512, elts: [ Starred( ExprStarred { - range: 487..499, + range: 483..495, value: Lambda( ExprLambda { - range: 488..499, + range: 484..495, parameters: Some( Parameters { - range: 495..496, + range: 491..492, posonlyargs: [], args: [ ParameterWithDefault { - range: 495..496, + range: 491..492, parameter: Parameter { - range: 495..496, + range: 491..492, name: Identifier { id: Name("x"), - range: 495..496, + range: 491..492, }, annotation: None, }, @@ -977,7 +977,7 @@ Module( ), body: Name( ExprName { - range: 498..499, + range: 494..495, id: Name("x"), ctx: Load, }, @@ -989,29 +989,29 @@ Module( ), Name( ExprName { - range: 501..502, + range: 497..498, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 504..516, + range: 500..512, value: Lambda( ExprLambda { - range: 505..516, + range: 501..512, parameters: Some( Parameters { - range: 512..513, + range: 508..509, posonlyargs: [], args: [ ParameterWithDefault { - range: 512..513, + range: 508..509, parameter: Parameter { - range: 512..513, + range: 508..509, name: Identifier { id: Name("x"), - range: 512..513, + range: 508..509, }, annotation: None, }, @@ -1025,7 +1025,7 @@ Module( ), body: Name( ExprName { - range: 515..516, + range: 511..512, id: Name("x"), ctx: Load, }, @@ -1044,13 +1044,13 @@ Module( ), Expr( StmtExpr { - range: 517..519, + range: 513..515, value: Starred( ExprStarred { - range: 517..519, + range: 513..515, value: Name( ExprName { - range: 518..519, + range: 514..515, id: Name("x"), ctx: Load, }, @@ -1062,14 +1062,14 @@ Module( ), Expr( StmtExpr { - range: 523..536, + range: 519..532, value: Tuple( ExprTuple { - range: 523..536, + range: 519..532, elts: [ NumberLiteral( ExprNumberLiteral { - range: 523..524, + range: 519..520, value: Int( 2, ), @@ -1077,17 +1077,17 @@ Module( ), Name( ExprName { - range: 526..527, + range: 522..523, id: Name("z"), ctx: Load, }, ), Starred( ExprStarred { - range: 529..531, + range: 525..527, value: Name( ExprName { - range: 530..531, + range: 526..527, id: Name("x"), ctx: Load, }, @@ -1097,7 +1097,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 535..536, + range: 531..532, value: Int( 2, ), @@ -1117,8 +1117,8 @@ Module( ## Errors | -2 | # Test the first and any other element as the there are two separate calls. -3 | +2 | # Test the first and any other element as there are two separate calls. +3 | 4 | (*x in y, z, *x in y) | ^^^^^^ Syntax Error: Comparison expression cannot be used here 5 | (*not x, z, *not x) @@ -1127,8 +1127,8 @@ Module( | -2 | # Test the first and any other element as the there are two separate calls. -3 | +2 | # Test the first and any other element as there are two separate calls. +3 | 4 | (*x in y, z, *x in y) | ^^^^^^ Syntax Error: Comparison expression cannot be used here 5 | (*not x, z, *not x) diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__comprehension.py.snap index 576ede44ac669..b692643db9843 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__comprehension.py.snap @@ -679,7 +679,7 @@ Module( 1 | # Iterable unpacking not allowed 2 | {*x for x in y} | ^^ Syntax Error: Iterable unpacking cannot be used in a comprehension -3 | +3 | 4 | # Invalid target | @@ -717,7 +717,7 @@ Module( 7 | {x for call() in y} 8 | {x for {a, b} in y} | ^^^^^^ Syntax Error: Invalid assignment target - 9 | + 9 | 10 | # Invalid iter | @@ -755,7 +755,7 @@ Module( 13 | {x for x in yield from y} 14 | {x for x in lambda y: y} | ^^^^^^^^^^^ Syntax Error: Lambda expression cannot be used here -15 | +15 | 16 | # Invalid if | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_0.py.snap index 5dfdee390976e..6b082389bac73 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_0.py.snap @@ -36,7 +36,7 @@ Module( | 1 | # Missing closing curly brace 0: No elements -2 | +2 | 3 | { - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_1.py.snap index 4d1c8c9301098..3df9492f91909 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_1.py.snap @@ -49,7 +49,7 @@ Module( | 4 | { -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_2.py.snap index e428dc35acd33..101fbf0b1ab90 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_2.py.snap @@ -57,7 +57,7 @@ Module( | 4 | {1, -5 | +5 | 6 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_3.py.snap index 51c9034fc9e05..f0ac8ba0d955f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__missing_closing_curly_brace_3.py.snap @@ -73,10 +73,10 @@ Module( | 2 | # token starts a statement. -3 | +3 | 4 | {1, 2 | ^ Syntax Error: Expected '}', found newline -5 | +5 | 6 | def foo(): 7 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__recover.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__recover.py.snap index 90a625582e810..6df00c1bc5d31 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__recover.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__recover.py.snap @@ -238,30 +238,30 @@ Module( | 3 | # These are same as for the list expressions. -4 | +4 | 5 | {,} | ^ Syntax Error: Expected an expression -6 | +6 | 7 | {1,,2} | | 5 | {,} -6 | +6 | 7 | {1,,2} | ^ Syntax Error: Expected an expression or a '}' -8 | +8 | 9 | {1,,} | | 7 | {1,,2} - 8 | + 8 | 9 | {1,,} | ^ Syntax Error: Expected an expression or a '}' -10 | +10 | 11 | # Missing comma | @@ -270,7 +270,7 @@ Module( 11 | # Missing comma 12 | {1 2} | ^ Syntax Error: Expected ',', found int -13 | +13 | 14 | # Dictionary element in a list | @@ -279,24 +279,24 @@ Module( 17 | # Missing expression 18 | {1, x + } | ^ Syntax Error: Expected an expression -19 | +19 | 20 | {1; 2} | | 18 | {1, x + } -19 | +19 | 20 | {1; 2} | ^ Syntax Error: Expected an expression or a '}' -21 | +21 | 22 | [*] | | 20 | {1; 2} -21 | +21 | 22 | [*] | ^ Syntax Error: Expected an expression | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__star_expression_precedence.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__star_expression_precedence.py.snap index d8b2fc78374db..5fd3b81e29e4f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__star_expression_precedence.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__set__star_expression_precedence.py.snap @@ -385,7 +385,7 @@ Module( | 1 | # For set expression, the minimum binding power of star expression is bitwise or. -2 | +2 | 3 | {(*x), y} | ^^ Syntax Error: Starred expression cannot be used here 4 | {*x in y, z} diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__invalid_slice_element.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__invalid_slice_element.py.snap index 26b2d038fff59..598a1ba08e83a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__invalid_slice_element.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__invalid_slice_element.py.snap @@ -254,7 +254,7 @@ Module( | 1 | x[x := 1:] | ^^^^^^ Syntax Error: Unparenthesized named expression cannot be used here -2 | +2 | 3 | # Starred expression | @@ -282,7 +282,7 @@ Module( 5 | x[:*x] 6 | x[::*x] | ^^ Syntax Error: Starred expression cannot be used here -7 | +7 | 8 | # Empty slice | @@ -291,7 +291,7 @@ Module( 8 | # Empty slice 9 | x[] | ^ Syntax Error: Expected index or slice expression -10 | +10 | 11 | # Mixed starred expression and named expression | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_0.py.snap index 3d89a70be471b..6491277ca7bcb 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_0.py.snap @@ -64,7 +64,7 @@ Module( | 1 | x[: -2 | +2 | 3 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_1.py.snap index e7173c5ea1fd6..10505cb6cb40c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__subscript__unclosed_slice_1.py.snap @@ -82,7 +82,7 @@ Module( | 1 | x[:: -2 | +2 | 3 | def foo(): | ^^^ Syntax Error: Expected an identifier, but found a keyword 'def' that cannot be used here 4 | pass @@ -91,7 +91,7 @@ Module( | 1 | x[:: -2 | +2 | 3 | def foo(): | ^^^ Syntax Error: Expected ']', found name 4 | pass @@ -108,5 +108,5 @@ Module( | 3 | def foo(): 4 | pass - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary.py.snap index b5f566d249772..379c262e15bd5 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/unary.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__named_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__named_expression.py.snap index be7d7154c7b7d..feeb3a56e814f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__named_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__named_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/expressions/unary/named_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_0.py.snap index 835f04ff2ed8f..3ea59b57e8614 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_0.py.snap @@ -61,6 +61,6 @@ Module( | 1 | not | ^ Syntax Error: Expected an expression -2 | +2 | 3 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_1.py.snap index a6ff514626a6b..62d13301c9fa8 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__unary__no_expression_1.py.snap @@ -61,6 +61,6 @@ Module( | 1 | + | ^ Syntax Error: Expected an expression -2 | +2 | 3 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__named_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__named_expression.py.snap index 1d6a889540eb6..84e07f14e90b9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__named_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__named_expression.py.snap @@ -103,14 +103,14 @@ Module( 1 | # Unparenthesized named expressions are not allowed 2 | yield x := 1 | ^^ Syntax Error: Expected a statement -3 | +3 | 4 | yield 1, x := 2, 3 | | 2 | yield x := 1 -3 | +3 | 4 | yield 1, x := 2, 3 | ^^ Syntax Error: Expected ',', found ':=' | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__star_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__star_expression.py.snap index 119f774e10329..0045d8615f349 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__star_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield__star_expression.py.snap @@ -100,14 +100,25 @@ Module( 1 | # Cannot use starred expression here 2 | yield (*x) | ^^ Syntax Error: Starred expression cannot be used here -3 | +3 | 4 | yield *x and y, z | | 2 | yield (*x) -3 | +3 | 4 | yield *x and y, z | ^^^^^^^ Syntax Error: Boolean expression cannot be used here | + + +## Semantic Syntax Errors + + | +1 | # Cannot use starred expression here +2 | yield (*x) + | ^^ Syntax Error: Starred expression cannot be used here +3 | +4 | yield *x and y, z + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__starred_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__starred_expression.py.snap index d222e225b6004..4adf70d811ce3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__starred_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__starred_expression.py.snap @@ -79,7 +79,7 @@ Module( | 1 | # Yield from doesn't allow top-level starred expression unlike yield -2 | +2 | 3 | yield from *x | ^^ Syntax Error: Starred expression cannot be used here 4 | yield from *x, y diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__unparenthesized.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__unparenthesized.py.snap index 2423b977365b8..40ffb45e66079 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__unparenthesized.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@expressions__yield_from__unparenthesized.py.snap @@ -136,7 +136,7 @@ Module( 1 | # Unparenthesized named expression 2 | yield from x := 1 | ^^ Syntax Error: Expected a statement -3 | +3 | 4 | # Unparenthesized tuple expression | @@ -145,7 +145,7 @@ Module( 4 | # Unparenthesized tuple expression 5 | yield from x, y | ^^^^ Syntax Error: Unparenthesized tuple expression cannot be used here -6 | +6 | 7 | # This is a tuple expression parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_empty_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_empty_expression.py.snap index 5a731cc3454d7..76a48f2197271 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_empty_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_empty_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_empty_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_name_tok.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_name_tok.py.snap index 91e43094e0249..4a635ad345086 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_name_tok.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_name_tok.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_invalid_conversion_flag_name_tok.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_other_tok.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_other_tok.py.snap index 97b365a8dd233..2f36142537edc 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_other_tok.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_conversion_flag_other_tok.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_invalid_conversion_flag_other_tok.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_starred_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_starred_expr.py.snap index 95e958e547eaa..e02a5c22b872e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_starred_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_invalid_starred_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_invalid_starred_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_lambda_without_parentheses.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_lambda_without_parentheses.py.snap index 254276e9787c7..05f1e2e3ff779 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_lambda_without_parentheses.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_lambda_without_parentheses.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_lambda_without_parentheses.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace.py.snap index 1ea72f64018b6..7714d9e16286f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace.py.snap @@ -223,7 +223,7 @@ Module( | 1 | f"{" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 2 | f"{foo!r" 3 | f"{foo=" | @@ -231,7 +231,7 @@ Module( | 1 | f"{" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 2 | f"{foo!r" 3 | f"{foo=" | @@ -249,7 +249,7 @@ Module( | 1 | f"{" 2 | f"{foo!r" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 3 | f"{foo=" 4 | f"{" | @@ -258,7 +258,7 @@ Module( | 1 | f"{" 2 | f"{foo!r" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 3 | f"{foo=" 4 | f"{" | @@ -277,7 +277,7 @@ Module( | 1 | f"{" 2 | f"{foo!r" - | Syntax Error: Expected FStringEnd, found Unknown + | ^ Syntax Error: Expected FStringEnd, found Unknown 3 | f"{foo=" 4 | f"{" | @@ -297,7 +297,7 @@ Module( 1 | f"{" 2 | f"{foo!r" 3 | f"{foo=" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 4 | f"{" 5 | f"""{""" | @@ -307,7 +307,7 @@ Module( 1 | f"{" 2 | f"{foo!r" 3 | f"{foo=" - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 4 | f"{" 5 | f"""{""" | @@ -341,10 +341,12 @@ Module( | 4 | f"{" 5 | f"""{""" + | ^ Syntax Error: unexpected EOF while parsing | | 4 | f"{" 5 | f"""{""" + | ^ Syntax Error: f-string: unterminated string | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace_in_format_spec.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace_in_format_spec.py.snap index 0ee92326b2d19..c72b2029e9572 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace_in_format_spec.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@f_string_unclosed_lbrace_in_format_spec.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/f_string_unclosed_lbrace_in_format_spec.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_iter_unpack_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_iter_unpack_py38.py.snap new file mode 100644 index 0000000000000..f4a68c5000ba0 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_iter_unpack_py38.py.snap @@ -0,0 +1,220 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/for_iter_unpack_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..106, + body: [ + For( + StmtFor { + range: 43..63, + is_async: false, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 52..58, + elts: [ + Starred( + ExprStarred { + range: 52..54, + value: Name( + ExprName { + range: 53..54, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Name( + ExprName { + range: 57..58, + id: Name("b"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 60..63, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 60..63, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 64..84, + is_async: false, + target: Name( + ExprName { + range: 68..69, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 74..79, + elts: [ + Name( + ExprName { + range: 74..75, + id: Name("a"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 77..79, + value: Name( + ExprName { + range: 78..79, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 81..84, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 81..84, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 85..105, + is_async: false, + target: Name( + ExprName { + range: 89..90, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 94..100, + elts: [ + Starred( + ExprStarred { + range: 94..96, + value: Name( + ExprName { + range: 95..96, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 98..100, + value: Name( + ExprName { + range: 99..100, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 102..105, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 102..105, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | for x in *a, b: ... + | ^^ Syntax Error: Cannot use iterable unpacking in `for` statements on Python 3.8 (syntax was added in Python 3.9) +3 | for x in a, *b: ... +4 | for x in *a, *b: ... + | + + + | +1 | # parse_options: {"target-version": "3.8"} +2 | for x in *a, b: ... +3 | for x in a, *b: ... + | ^^ Syntax Error: Cannot use iterable unpacking in `for` statements on Python 3.8 (syntax was added in Python 3.9) +4 | for x in *a, *b: ... + | + + + | +2 | for x in *a, b: ... +3 | for x in a, *b: ... +4 | for x in *a, *b: ... + | ^^ Syntax Error: Cannot use iterable unpacking in `for` statements on Python 3.8 (syntax was added in Python 3.9) + | + + + | +2 | for x in *a, b: ... +3 | for x in a, *b: ... +4 | for x in *a, *b: ... + | ^^ Syntax Error: Cannot use iterable unpacking in `for` statements on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_iter_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_iter_expr.py.snap index 4561e00279930..f83966eb9282a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_iter_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_iter_expr.py.snap @@ -181,3 +181,13 @@ Module( 3 | for target in x := 1: ... | ^ Syntax Error: Invalid annotated assignment target | + + +## Semantic Syntax Errors + + | +1 | for x in *a and b: ... + | ^^^^^^^^ Syntax Error: Starred expression cannot be used here +2 | for x in yield a: ... +3 | for target in x := 1: ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target.py.snap index a3907addee1de..b34450098f0c1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target.py.snap @@ -461,3 +461,25 @@ Module( 7 | for [x, 1, y, *["a"]] in z: ... | ^^^ Syntax Error: Invalid assignment target | + + +## Semantic Syntax Errors + + | +1 | for 1 in x: ... +2 | for "a" in x: ... +3 | for *x and y in z: ... + | ^^^^^^^^ Syntax Error: Starred expression cannot be used here +4 | for *x | y in z: ... +5 | for await x in z: ... + | + + + | +2 | for "a" in x: ... +3 | for *x and y in z: ... +4 | for *x | y in z: ... + | ^^^^^^ Syntax Error: Starred expression cannot be used here +5 | for await x in z: ... +6 | for yield x in y: ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_binary_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_binary_expr.py.snap index d6f322b122946..0a6052ee9de52 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_binary_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_binary_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/for_stmt_invalid_target_binary_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_in_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_in_keyword.py.snap index c8c43ae82cbd4..6e47652cc1177 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_in_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_invalid_target_in_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/for_stmt_invalid_target_in_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_in_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_in_keyword.py.snap index f90a68d9d63a2..3390046c352a1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_in_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_in_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/for_stmt_missing_in_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_iter.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_iter.py.snap index e130d85caa56f..240f900f06f95 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_iter.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_iter.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/for_stmt_missing_iter.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_target.py.snap index f72bfdd6ab2da..3c819fc4722e6 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@for_stmt_missing_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/for_stmt_missing_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_dotted_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_dotted_names.py.snap index 2e9373eb81688..36a0203b9b6f3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_dotted_names.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_dotted_names.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_dotted_names.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_empty_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_empty_names.py.snap index 02849ea1d4488..fcc56371ed6d1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_empty_names.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_empty_names.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_empty_names.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_module.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_module.py.snap index 71b24a22c4679..fcf455d6ba23d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_module.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_module.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_missing_module.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_rpar.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_rpar.py.snap index 3b6968126a1d0..582bd2f14ec70 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_rpar.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_missing_rpar.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_missing_rpar.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_star_with_other_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_star_with_other_names.py.snap index ca8f658ba1ef5..93824bef84498 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_star_with_other_names.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_star_with_other_names.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_star_with_other_names.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_unparenthesized_trailing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_unparenthesized_trailing_comma.py.snap index 02ff0ff97462c..6dbfd32f09872 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_unparenthesized_trailing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@from_import_unparenthesized_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/from_import_unparenthesized_trailing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_empty_body.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_empty_body.py.snap index 9a132ab9f50b2..1fa49e573cda7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_empty_body.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_empty_body.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/function_def_empty_body.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_identifier.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_identifier.py.snap index d8ee81f34b5a2..12a4a4625a3ea 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_identifier.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_identifier.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/function_def_missing_identifier.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_return_type.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_return_type.py.snap index 994e34c5ce9ee..3552186e7a219 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_return_type.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_missing_return_type.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/function_def_missing_return_type.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_parameter_list.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_parameter_list.py.snap index 1b2fef4c05ecf..bc3b151c5e388 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_parameter_list.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_parameter_list.py.snap @@ -230,4 +230,5 @@ Module( | 4 | def foo(a: int, b: str 5 | x = 10 + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_type_param_list.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_type_param_list.py.snap index c7bf44d05c9a9..8cc11d43fc00c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_type_param_list.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unclosed_type_param_list.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/function_def_unclosed_type_param_list.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unparenthesized_return_types.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unparenthesized_return_types.py.snap index 0cfd37fb16f35..ef7baf9f917c7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unparenthesized_return_types.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_def_unparenthesized_return_types.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/function_def_unparenthesized_return_types.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_type_params_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_type_params_py311.py.snap new file mode 100644 index 0000000000000..80edd73d05ae2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@function_type_params_py311.py.snap @@ -0,0 +1,129 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/function_type_params_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..79, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..61, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 48..51, + }, + type_params: Some( + TypeParams { + range: 51..54, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 52..53, + name: Identifier { + id: Name("T"), + range: 52..53, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 54..56, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 62..78, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 66..69, + }, + type_params: Some( + TypeParams { + range: 69..71, + type_params: [], + }, + ), + parameters: Parameters { + range: 71..73, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 75..78, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 75..78, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | def foo[T](): ... +3 | def foo[](): ... + | ^ Syntax Error: Type parameter list cannot be empty + | + + +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | def foo[T](): ... + | ^^^ Syntax Error: Cannot use type parameter lists on Python 3.11 (syntax was added in Python 3.12) +3 | def foo[](): ... + | + + + | +1 | # parse_options: {"target-version": "3.11"} +2 | def foo[T](): ... +3 | def foo[](): ... + | ^^ Syntax Error: Cannot use type parameter lists on Python 3.11 (syntax was added in Python 3.12) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_empty.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_empty.py.snap index 687d4df198832..6a89da1d79623 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_empty.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_empty.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/global_stmt_empty.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_expression.py.snap index a9271abcd3b39..b2305e0df7414 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_expression.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/global_stmt_expression.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_trailing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_trailing_comma.py.snap index 008d13eb1a8dc..b6c872e3996ce 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_trailing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@global_stmt_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/global_stmt_trailing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_elif_missing_colon.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_elif_missing_colon.py.snap index 5353c7589bbd4..d891db30aeb0e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_elif_missing_colon.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_elif_missing_colon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_elif_missing_colon.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_empty_body.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_empty_body.py.snap index 4e11284a27598..9b30c83a9f2bf 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_empty_body.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_empty_body.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_empty_body.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_elif_test_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_elif_test_expr.py.snap index f83040060e0d2..dbc135744a766 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_elif_test_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_elif_test_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_invalid_elif_test_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_test_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_test_expr.py.snap index d5c0dfe0e1659..558aa9bdbc2fa 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_test_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_invalid_test_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_invalid_test_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_colon.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_colon.py.snap index 0038d2d015326..b97e20e9bcfe9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_colon.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_colon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_missing_colon.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_test.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_test.py.snap index 790cf6f41a3d9..bc2a35ae1d0a1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_test.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_missing_test.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/if_stmt_missing_test.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_misspelled_elif.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_misspelled_elif.py.snap index f67bc96ce73e3..b8d421961c8f6 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_misspelled_elif.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@if_stmt_misspelled_elif.py.snap @@ -89,8 +89,8 @@ Module( | 3 | elf: 4 | pass + | ^ Syntax Error: Expected a statement 5 | else: - | Syntax Error: Expected a statement 6 | pass | @@ -124,4 +124,5 @@ Module( | 5 | else: 6 | pass + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string.py.snap index 2f6c6423e18b7..2ba54bef2f7d5 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string.py.snap @@ -173,6 +173,6 @@ Module( 1 | 'hello' 'world 2 | 1 + 1 3 | 'hello' f'world {x} - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 4 | 2 + 2 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string_multiline.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string_multiline.py.snap index 9479f931659bb..cdfccb44422a7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string_multiline.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@implicitly_concatenated_unterminated_string_multiline.py.snap @@ -188,7 +188,7 @@ Module( 1 | ( 2 | 'hello' 3 | f'world {x} - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 4 | ) 5 | 1 + 1 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_alias_missing_asname.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_alias_missing_asname.py.snap index 6a88db4d7b6d6..230ad97b22181 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_alias_missing_asname.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_alias_missing_asname.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/import_alias_missing_asname.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_empty.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_empty.py.snap index f63fa83d70d00..ad8888e518ced 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_empty.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_empty.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/import_stmt_empty.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_parenthesized_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_parenthesized_names.py.snap index 3b8a41be099f0..a9509f3d16f56 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_parenthesized_names.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_parenthesized_names.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/import_stmt_parenthesized_names.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_star_import.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_star_import.py.snap index 3cd6de4d7ef8d..70f4c3c14095b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_star_import.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_star_import.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/import_stmt_star_import.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_trailing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_trailing_comma.py.snap index aeccfea75ae89..f5ab95692d9c1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_trailing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@import_stmt_trailing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/import_stmt_trailing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_class.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_class.py.snap new file mode 100644 index 0000000000000..a53ebf2fd2576 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_class.py.snap @@ -0,0 +1,505 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/invalid_annotation_class.py +--- +## AST + +``` +Module( + ModModule { + range: 0..247, + body: [ + ClassDef( + StmtClassDef { + range: 0..26, + decorator_list: [], + name: Identifier { + id: Name("F"), + range: 6..7, + }, + type_params: Some( + TypeParams { + range: 7..10, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 8..9, + name: Identifier { + id: Name("T"), + range: 8..9, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 10..21, + args: [ + Named( + ExprNamed { + range: 11..20, + target: Name( + ExprName { + range: 11..12, + id: Name("y"), + ctx: Store, + }, + ), + value: Name( + ExprName { + range: 16..20, + id: Name("list"), + ctx: Load, + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 23..26, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 23..26, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 27..53, + decorator_list: [], + name: Identifier { + id: Name("I"), + range: 33..34, + }, + type_params: Some( + TypeParams { + range: 34..37, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 35..36, + name: Identifier { + id: Name("T"), + range: 35..36, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 37..48, + args: [ + Yield( + ExprYield { + range: 39..46, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 45..46, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 50..53, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 50..53, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 54..85, + decorator_list: [], + name: Identifier { + id: Name("J"), + range: 60..61, + }, + type_params: Some( + TypeParams { + range: 61..64, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 62..63, + name: Identifier { + id: Name("T"), + range: 62..63, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 64..80, + args: [ + YieldFrom( + ExprYieldFrom { + range: 66..78, + value: NumberLiteral( + ExprNumberLiteral { + range: 77..78, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 82..85, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 82..85, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 86..112, + decorator_list: [], + name: Identifier { + id: Name("K"), + range: 92..93, + }, + type_params: Some( + TypeParams { + range: 93..107, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 94..106, + name: Identifier { + id: Name("T"), + range: 94..95, + }, + bound: Some( + Yield( + ExprYield { + range: 98..105, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 104..105, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 109..112, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 109..112, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 137..162, + decorator_list: [], + name: Identifier { + id: Name("L"), + range: 143..144, + }, + type_params: Some( + TypeParams { + range: 144..157, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 145..156, + name: Identifier { + id: Name("T"), + range: 145..146, + }, + bound: Some( + Named( + ExprNamed { + range: 149..155, + target: Name( + ExprName { + range: 149..150, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 154..155, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 159..162, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 159..162, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 193..219, + decorator_list: [], + name: Identifier { + id: Name("M"), + range: 199..200, + }, + type_params: Some( + TypeParams { + range: 200..203, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 201..202, + name: Identifier { + id: Name("T"), + range: 201..202, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 203..214, + args: [ + Await( + ExprAwait { + range: 205..212, + value: NumberLiteral( + ExprNumberLiteral { + range: 211..212, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 216..219, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 216..219, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 220..246, + decorator_list: [], + name: Identifier { + id: Name("N"), + range: 226..227, + }, + type_params: Some( + TypeParams { + range: 227..241, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 228..240, + name: Identifier { + id: Name("T"), + range: 228..229, + }, + bound: Some( + Await( + ExprAwait { + range: 232..239, + value: NumberLiteral( + ExprNumberLiteral { + range: 238..239, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 243..246, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 243..246, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | class F[T](y := list): ... + | ^^^^^^^^^ Syntax Error: named expression cannot be used within a generic definition +2 | class I[T]((yield 1)): ... +3 | class J[T]((yield from 1)): ... + | + + + | +1 | class F[T](y := list): ... +2 | class I[T]((yield 1)): ... + | ^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition +3 | class J[T]((yield from 1)): ... +4 | class K[T: (yield 1)]: ... # yield in TypeVar + | + + + | +1 | class F[T](y := list): ... +2 | class I[T]((yield 1)): ... +3 | class J[T]((yield from 1)): ... + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition +4 | class K[T: (yield 1)]: ... # yield in TypeVar +5 | class L[T: (x := 1)]: ... # named expr in TypeVar + | + + + | +2 | class I[T]((yield 1)): ... +3 | class J[T]((yield from 1)): ... +4 | class K[T: (yield 1)]: ... # yield in TypeVar + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar bound +5 | class L[T: (x := 1)]: ... # named expr in TypeVar +6 | class M[T]((await 1)): ... + | + + + | +3 | class J[T]((yield from 1)): ... +4 | class K[T: (yield 1)]: ... # yield in TypeVar +5 | class L[T: (x := 1)]: ... # named expr in TypeVar + | ^^^^^^ Syntax Error: named expression cannot be used within a TypeVar bound +6 | class M[T]((await 1)): ... +7 | class N[T: (await 1)]: ... + | + + + | +4 | class K[T: (yield 1)]: ... # yield in TypeVar +5 | class L[T: (x := 1)]: ... # named expr in TypeVar +6 | class M[T]((await 1)): ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a generic definition +7 | class N[T: (await 1)]: ... + | + + + | +5 | class L[T: (x := 1)]: ... # named expr in TypeVar +6 | class M[T]((await 1)): ... +7 | class N[T: (await 1)]: ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a TypeVar bound + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function.py.snap new file mode 100644 index 0000000000000..b21adb9b16ba2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function.py.snap @@ -0,0 +1,1589 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/invalid_annotation_function.py +--- +## AST + +``` +Module( + ModModule { + range: 0..987, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..28, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("d"), + range: 4..5, + }, + type_params: Some( + TypeParams { + range: 5..8, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 6..7, + name: Identifier { + id: Name("T"), + range: 6..7, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 8..10, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Await( + ExprAwait { + range: 15..22, + value: NumberLiteral( + ExprNumberLiteral { + range: 21..22, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 25..28, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 25..28, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 29..58, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("e"), + range: 33..34, + }, + type_params: Some( + TypeParams { + range: 34..37, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 35..36, + name: Identifier { + id: Name("T"), + range: 35..36, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 37..53, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 38..52, + parameter: Parameter { + range: 38..52, + name: Identifier { + id: Name("arg"), + range: 38..41, + }, + annotation: Some( + Await( + ExprAwait { + range: 44..51, + value: NumberLiteral( + ExprNumberLiteral { + range: 50..51, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 55..58, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 55..58, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 59..86, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 63..64, + }, + type_params: Some( + TypeParams { + range: 64..67, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 65..66, + name: Identifier { + id: Name("T"), + range: 65..66, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 67..69, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Named( + ExprNamed { + range: 74..80, + target: Name( + ExprName { + range: 74..75, + id: Name("y"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 79..80, + value: Int( + 3, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 83..86, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 83..86, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 87..115, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 91..92, + }, + type_params: Some( + TypeParams { + range: 92..95, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 93..94, + name: Identifier { + id: Name("T"), + range: 93..94, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 95..110, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 96..109, + parameter: Parameter { + range: 96..109, + name: Identifier { + id: Name("arg"), + range: 96..99, + }, + annotation: Some( + Named( + ExprNamed { + range: 102..108, + target: Name( + ExprName { + range: 102..103, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 107..108, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 112..115, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 112..115, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 116..143, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("h"), + range: 120..121, + }, + type_params: Some( + TypeParams { + range: 121..124, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 122..123, + name: Identifier { + id: Name("T"), + range: 122..123, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 124..138, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 125..137, + parameter: Parameter { + range: 125..137, + name: Identifier { + id: Name("x"), + range: 125..126, + }, + annotation: Some( + Yield( + ExprYield { + range: 129..136, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 135..136, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 140..143, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 140..143, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 144..172, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("j"), + range: 148..149, + }, + type_params: Some( + TypeParams { + range: 149..152, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 150..151, + name: Identifier { + id: Name("T"), + range: 150..151, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 152..154, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Yield( + ExprYield { + range: 159..166, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 165..166, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 169..172, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 169..172, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 173..205, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("l"), + range: 177..178, + }, + type_params: Some( + TypeParams { + range: 178..181, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 179..180, + name: Identifier { + id: Name("T"), + range: 179..180, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 181..200, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 182..199, + parameter: Parameter { + range: 182..199, + name: Identifier { + id: Name("x"), + range: 182..183, + }, + annotation: Some( + YieldFrom( + ExprYieldFrom { + range: 186..198, + value: NumberLiteral( + ExprNumberLiteral { + range: 197..198, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 202..205, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 202..205, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 206..239, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("n"), + range: 210..211, + }, + type_params: Some( + TypeParams { + range: 211..214, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 212..213, + name: Identifier { + id: Name("T"), + range: 212..213, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 214..216, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + YieldFrom( + ExprYieldFrom { + range: 221..233, + value: NumberLiteral( + ExprNumberLiteral { + range: 232..233, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 236..239, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 236..239, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 240..266, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("p"), + range: 244..245, + }, + type_params: Some( + TypeParams { + range: 245..259, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 246..258, + name: Identifier { + id: Name("T"), + range: 246..247, + }, + bound: Some( + Yield( + ExprYield { + range: 250..257, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 256..257, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 259..261, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 263..266, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 263..266, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 297..324, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("q"), + range: 301..302, + }, + type_params: Some( + TypeParams { + range: 302..317, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 303..316, + name: Identifier { + id: Name("T"), + range: 303..304, + }, + bound: None, + default: Some( + Yield( + ExprYield { + range: 308..315, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 314..315, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 317..319, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 321..324, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 321..324, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 356..385, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("r"), + range: 360..361, + }, + type_params: Some( + TypeParams { + range: 361..378, + type_params: [ + TypeVarTuple( + TypeParamTypeVarTuple { + range: 362..377, + name: Identifier { + id: Name("Ts"), + range: 363..365, + }, + default: Some( + Yield( + ExprYield { + range: 369..376, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 375..376, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 378..380, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 382..385, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 382..385, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 420..450, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("s"), + range: 424..425, + }, + type_params: Some( + TypeParams { + range: 425..443, + type_params: [ + ParamSpec( + TypeParamParamSpec { + range: 426..442, + name: Identifier { + id: Name("Ts"), + range: 428..430, + }, + default: Some( + Yield( + ExprYield { + range: 434..441, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 440..441, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 443..445, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 447..450, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 447..450, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 481..506, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("t"), + range: 485..486, + }, + type_params: Some( + TypeParams { + range: 486..499, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 487..498, + name: Identifier { + id: Name("T"), + range: 487..488, + }, + bound: Some( + Named( + ExprNamed { + range: 491..497, + target: Name( + ExprName { + range: 491..492, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 496..497, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 499..501, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 503..506, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 503..506, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 543..569, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("u"), + range: 547..548, + }, + type_params: Some( + TypeParams { + range: 548..562, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 549..561, + name: Identifier { + id: Name("T"), + range: 549..550, + }, + bound: None, + default: Some( + Named( + ExprNamed { + range: 554..560, + target: Name( + ExprName { + range: 554..555, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 559..560, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 562..564, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 566..569, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 566..569, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 607..635, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("v"), + range: 611..612, + }, + type_params: Some( + TypeParams { + range: 612..628, + type_params: [ + TypeVarTuple( + TypeParamTypeVarTuple { + range: 613..627, + name: Identifier { + id: Name("Ts"), + range: 614..616, + }, + default: Some( + Named( + ExprNamed { + range: 620..626, + target: Name( + ExprName { + range: 620..621, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 625..626, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 628..630, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 632..635, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 632..635, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 676..705, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("w"), + range: 680..681, + }, + type_params: Some( + TypeParams { + range: 681..698, + type_params: [ + ParamSpec( + TypeParamParamSpec { + range: 682..697, + name: Identifier { + id: Name("Ts"), + range: 684..686, + }, + default: Some( + Named( + ExprNamed { + range: 690..696, + target: Name( + ExprName { + range: 690..691, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 695..696, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 698..700, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 702..705, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 702..705, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 742..768, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("t"), + range: 746..747, + }, + type_params: Some( + TypeParams { + range: 747..761, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 748..760, + name: Identifier { + id: Name("T"), + range: 748..749, + }, + bound: Some( + Await( + ExprAwait { + range: 752..759, + value: NumberLiteral( + ExprNumberLiteral { + range: 758..759, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 761..763, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 765..768, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 765..768, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 800..827, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("u"), + range: 804..805, + }, + type_params: Some( + TypeParams { + range: 805..820, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 806..819, + name: Identifier { + id: Name("T"), + range: 806..807, + }, + bound: None, + default: Some( + Await( + ExprAwait { + range: 811..818, + value: NumberLiteral( + ExprNumberLiteral { + range: 817..818, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 820..822, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 824..827, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 824..827, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 860..889, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("v"), + range: 864..865, + }, + type_params: Some( + TypeParams { + range: 865..882, + type_params: [ + TypeVarTuple( + TypeParamTypeVarTuple { + range: 866..881, + name: Identifier { + id: Name("Ts"), + range: 867..869, + }, + default: Some( + Await( + ExprAwait { + range: 873..880, + value: NumberLiteral( + ExprNumberLiteral { + range: 879..880, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 882..884, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 886..889, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 886..889, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 925..955, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("w"), + range: 929..930, + }, + type_params: Some( + TypeParams { + range: 930..948, + type_params: [ + ParamSpec( + TypeParamParamSpec { + range: 931..947, + name: Identifier { + id: Name("Ts"), + range: 933..935, + }, + default: Some( + Await( + ExprAwait { + range: 939..946, + value: NumberLiteral( + ExprNumberLiteral { + range: 945..946, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 948..950, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 952..955, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 952..955, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | def d[T]() -> (await 1): ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a generic definition +2 | def e[T](arg: (await 1)): ... +3 | def f[T]() -> (y := 3): ... + | + + + | +1 | def d[T]() -> (await 1): ... +2 | def e[T](arg: (await 1)): ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a generic definition +3 | def f[T]() -> (y := 3): ... +4 | def g[T](arg: (x := 1)): ... + | + + + | +1 | def d[T]() -> (await 1): ... +2 | def e[T](arg: (await 1)): ... +3 | def f[T]() -> (y := 3): ... + | ^^^^^^ Syntax Error: named expression cannot be used within a generic definition +4 | def g[T](arg: (x := 1)): ... +5 | def h[T](x: (yield 1)): ... + | + + + | +2 | def e[T](arg: (await 1)): ... +3 | def f[T]() -> (y := 3): ... +4 | def g[T](arg: (x := 1)): ... + | ^^^^^^ Syntax Error: named expression cannot be used within a generic definition +5 | def h[T](x: (yield 1)): ... +6 | def j[T]() -> (yield 1): ... + | + + + | +3 | def f[T]() -> (y := 3): ... +4 | def g[T](arg: (x := 1)): ... +5 | def h[T](x: (yield 1)): ... + | ^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition +6 | def j[T]() -> (yield 1): ... +7 | def l[T](x: (yield from 1)): ... + | + + + | +4 | def g[T](arg: (x := 1)): ... +5 | def h[T](x: (yield 1)): ... +6 | def j[T]() -> (yield 1): ... + | ^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition +7 | def l[T](x: (yield from 1)): ... +8 | def n[T]() -> (yield from 1): ... + | + + + | +5 | def h[T](x: (yield 1)): ... +6 | def j[T]() -> (yield 1): ... +7 | def l[T](x: (yield from 1)): ... + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition +8 | def n[T]() -> (yield from 1): ... +9 | def p[T: (yield 1)](): ... # yield in TypeVar bound + | + + + | + 6 | def j[T]() -> (yield 1): ... + 7 | def l[T](x: (yield from 1)): ... + 8 | def n[T]() -> (yield from 1): ... + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a generic definition + 9 | def p[T: (yield 1)](): ... # yield in TypeVar bound +10 | def q[T = (yield 1)](): ... # yield in TypeVar default + | + + + | + 7 | def l[T](x: (yield from 1)): ... + 8 | def n[T]() -> (yield from 1): ... + 9 | def p[T: (yield 1)](): ... # yield in TypeVar bound + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar bound +10 | def q[T = (yield 1)](): ... # yield in TypeVar default +11 | def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default + | + + + | + 8 | def n[T]() -> (yield from 1): ... + 9 | def p[T: (yield 1)](): ... # yield in TypeVar bound +10 | def q[T = (yield 1)](): ... # yield in TypeVar default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar default +11 | def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default +12 | def s[**Ts = (yield 1)](): ... # yield in ParamSpec default + | + + + | + 9 | def p[T: (yield 1)](): ... # yield in TypeVar bound +10 | def q[T = (yield 1)](): ... # yield in TypeVar default +11 | def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVarTuple default +12 | def s[**Ts = (yield 1)](): ... # yield in ParamSpec default +13 | def t[T: (x := 1)](): ... # named expr in TypeVar bound + | + + + | +10 | def q[T = (yield 1)](): ... # yield in TypeVar default +11 | def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default +12 | def s[**Ts = (yield 1)](): ... # yield in ParamSpec default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a ParamSpec default +13 | def t[T: (x := 1)](): ... # named expr in TypeVar bound +14 | def u[T = (x := 1)](): ... # named expr in TypeVar default + | + + + | +11 | def r[*Ts = (yield 1)](): ... # yield in TypeVarTuple default +12 | def s[**Ts = (yield 1)](): ... # yield in ParamSpec default +13 | def t[T: (x := 1)](): ... # named expr in TypeVar bound + | ^^^^^^ Syntax Error: named expression cannot be used within a TypeVar bound +14 | def u[T = (x := 1)](): ... # named expr in TypeVar default +15 | def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default + | + + + | +12 | def s[**Ts = (yield 1)](): ... # yield in ParamSpec default +13 | def t[T: (x := 1)](): ... # named expr in TypeVar bound +14 | def u[T = (x := 1)](): ... # named expr in TypeVar default + | ^^^^^^ Syntax Error: named expression cannot be used within a TypeVar default +15 | def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default +16 | def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default + | + + + | +13 | def t[T: (x := 1)](): ... # named expr in TypeVar bound +14 | def u[T = (x := 1)](): ... # named expr in TypeVar default +15 | def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default + | ^^^^^^ Syntax Error: named expression cannot be used within a TypeVarTuple default +16 | def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default +17 | def t[T: (await 1)](): ... # await in TypeVar bound + | + + + | +14 | def u[T = (x := 1)](): ... # named expr in TypeVar default +15 | def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default +16 | def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default + | ^^^^^^ Syntax Error: named expression cannot be used within a ParamSpec default +17 | def t[T: (await 1)](): ... # await in TypeVar bound +18 | def u[T = (await 1)](): ... # await in TypeVar default + | + + + | +15 | def v[*Ts = (x := 1)](): ... # named expr in TypeVarTuple default +16 | def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default +17 | def t[T: (await 1)](): ... # await in TypeVar bound + | ^^^^^^^ Syntax Error: await expression cannot be used within a TypeVar bound +18 | def u[T = (await 1)](): ... # await in TypeVar default +19 | def v[*Ts = (await 1)](): ... # await in TypeVarTuple default + | + + + | +16 | def w[**Ts = (x := 1)](): ... # named expr in ParamSpec default +17 | def t[T: (await 1)](): ... # await in TypeVar bound +18 | def u[T = (await 1)](): ... # await in TypeVar default + | ^^^^^^^ Syntax Error: await expression cannot be used within a TypeVar default +19 | def v[*Ts = (await 1)](): ... # await in TypeVarTuple default +20 | def w[**Ts = (await 1)](): ... # await in ParamSpec default + | + + + | +17 | def t[T: (await 1)](): ... # await in TypeVar bound +18 | def u[T = (await 1)](): ... # await in TypeVar default +19 | def v[*Ts = (await 1)](): ... # await in TypeVarTuple default + | ^^^^^^^ Syntax Error: await expression cannot be used within a TypeVarTuple default +20 | def w[**Ts = (await 1)](): ... # await in ParamSpec default + | + + + | +18 | def u[T = (await 1)](): ... # await in TypeVar default +19 | def v[*Ts = (await 1)](): ... # await in TypeVarTuple default +20 | def w[**Ts = (await 1)](): ... # await in ParamSpec default + | ^^^^^^^ Syntax Error: await expression cannot be used within a ParamSpec default + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function_py314.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function_py314.py.snap new file mode 100644 index 0000000000000..49533fb33fce2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_function_py314.py.snap @@ -0,0 +1,583 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/invalid_annotation_function_py314.py +--- +## AST + +``` +Module( + ModModule { + range: 0..316, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..68, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 48..49, + }, + type_params: None, + parameters: Parameters { + range: 49..51, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Named( + ExprNamed { + range: 56..62, + target: Name( + ExprName { + range: 56..57, + id: Name("y"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 61..62, + value: Int( + 3, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 65..68, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 65..68, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 69..94, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 73..74, + }, + type_params: None, + parameters: Parameters { + range: 74..89, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 75..88, + parameter: Parameter { + range: 75..88, + name: Identifier { + id: Name("arg"), + range: 75..78, + }, + annotation: Some( + Named( + ExprNamed { + range: 81..87, + target: Name( + ExprName { + range: 81..82, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 86..87, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 91..94, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 91..94, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 95..235, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 99..104, + }, + type_params: None, + parameters: Parameters { + range: 104..106, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 112..136, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("i"), + range: 116..117, + }, + type_params: None, + parameters: Parameters { + range: 117..131, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 118..130, + parameter: Parameter { + range: 118..130, + name: Identifier { + id: Name("x"), + range: 118..119, + }, + annotation: Some( + Yield( + ExprYield { + range: 122..129, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 128..129, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 133..136, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 133..136, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 141..166, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("k"), + range: 145..146, + }, + type_params: None, + parameters: Parameters { + range: 146..148, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Yield( + ExprYield { + range: 153..160, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 159..160, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 163..166, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 163..166, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 171..200, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("m"), + range: 175..176, + }, + type_params: None, + parameters: Parameters { + range: 176..195, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 177..194, + parameter: Parameter { + range: 177..194, + name: Identifier { + id: Name("x"), + range: 177..178, + }, + annotation: Some( + YieldFrom( + ExprYieldFrom { + range: 181..193, + value: NumberLiteral( + ExprNumberLiteral { + range: 192..193, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 197..200, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 197..200, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 205..235, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("o"), + range: 209..210, + }, + type_params: None, + parameters: Parameters { + range: 210..212, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + YieldFrom( + ExprYieldFrom { + range: 217..229, + value: NumberLiteral( + ExprNumberLiteral { + range: 228..229, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 232..235, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 232..235, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 236..315, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 246..251, + }, + type_params: None, + parameters: Parameters { + range: 251..253, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 259..284, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 263..264, + }, + type_params: None, + parameters: Parameters { + range: 264..266, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Await( + ExprAwait { + range: 271..278, + value: NumberLiteral( + ExprNumberLiteral { + range: 277..278, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 281..284, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 281..284, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 289..315, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 293..294, + }, + type_params: None, + parameters: Parameters { + range: 294..310, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 295..309, + parameter: Parameter { + range: 295..309, + name: Identifier { + id: Name("arg"), + range: 295..298, + }, + annotation: Some( + Await( + ExprAwait { + range: 301..308, + value: NumberLiteral( + ExprNumberLiteral { + range: 307..308, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 312..315, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 312..315, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | # parse_options: {"target-version": "3.14"} +2 | def f() -> (y := 3): ... + | ^^^^^^ Syntax Error: named expression cannot be used within a type annotation +3 | def g(arg: (x := 1)): ... +4 | def outer(): + | + + + | +1 | # parse_options: {"target-version": "3.14"} +2 | def f() -> (y := 3): ... +3 | def g(arg: (x := 1)): ... + | ^^^^^^ Syntax Error: named expression cannot be used within a type annotation +4 | def outer(): +5 | def i(x: (yield 1)): ... + | + + + | +3 | def g(arg: (x := 1)): ... +4 | def outer(): +5 | def i(x: (yield 1)): ... + | ^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation +6 | def k() -> (yield 1): ... +7 | def m(x: (yield from 1)): ... + | + + + | +4 | def outer(): +5 | def i(x: (yield 1)): ... +6 | def k() -> (yield 1): ... + | ^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation +7 | def m(x: (yield from 1)): ... +8 | def o() -> (yield from 1): ... + | + + + | +5 | def i(x: (yield 1)): ... +6 | def k() -> (yield 1): ... +7 | def m(x: (yield from 1)): ... + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation +8 | def o() -> (yield from 1): ... +9 | async def outer(): + | + + + | + 6 | def k() -> (yield 1): ... + 7 | def m(x: (yield from 1)): ... + 8 | def o() -> (yield from 1): ... + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation + 9 | async def outer(): +10 | def f() -> (await 1): ... + | + + + | + 8 | def o() -> (yield from 1): ... + 9 | async def outer(): +10 | def f() -> (await 1): ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a type annotation +11 | def g(arg: (await 1)): ... + | + + + | + 9 | async def outer(): +10 | def f() -> (await 1): ... +11 | def g(arg: (await 1)): ... + | ^^^^^^^ Syntax Error: await expression cannot be used within a type annotation + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_py314.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_py314.py.snap new file mode 100644 index 0000000000000..113edf8f44105 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_py314.py.snap @@ -0,0 +1,215 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/invalid_annotation_py314.py +--- +## AST + +``` +Module( + ModModule { + range: 0..144, + body: [ + AnnAssign( + StmtAnnAssign { + range: 44..55, + target: Name( + ExprName { + range: 44..45, + id: Name("a"), + ctx: Store, + }, + ), + annotation: Named( + ExprNamed { + range: 48..54, + target: Name( + ExprName { + range: 48..49, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 53..54, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + FunctionDef( + StmtFunctionDef { + range: 56..107, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 60..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + AnnAssign( + StmtAnnAssign { + range: 73..85, + target: Name( + ExprName { + range: 73..74, + id: Name("b"), + ctx: Store, + }, + ), + annotation: Yield( + ExprYield { + range: 77..84, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 83..84, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + value: None, + simple: true, + }, + ), + AnnAssign( + StmtAnnAssign { + range: 90..107, + target: Name( + ExprName { + range: 90..91, + id: Name("c"), + ctx: Store, + }, + ), + annotation: YieldFrom( + ExprYieldFrom { + range: 94..106, + value: NumberLiteral( + ExprNumberLiteral { + range: 105..106, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 108..143, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 118..123, + }, + type_params: None, + parameters: Parameters { + range: 123..125, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + AnnAssign( + StmtAnnAssign { + range: 131..143, + target: Name( + ExprName { + range: 131..132, + id: Name("d"), + ctx: Store, + }, + ), + annotation: Await( + ExprAwait { + range: 135..142, + value: NumberLiteral( + ExprNumberLiteral { + range: 141..142, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | # parse_options: {"target-version": "3.14"} +2 | a: (x := 1) + | ^^^^^^ Syntax Error: named expression cannot be used within a type annotation +3 | def outer(): +4 | b: (yield 1) + | + + + | +2 | a: (x := 1) +3 | def outer(): +4 | b: (yield 1) + | ^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation +5 | c: (yield from 1) +6 | async def outer(): + | + + + | +3 | def outer(): +4 | b: (yield 1) +5 | c: (yield from 1) + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a type annotation +6 | async def outer(): +7 | d: (await 1) + | + + + | +5 | c: (yield from 1) +6 | async def outer(): +7 | d: (await 1) + | ^^^^^^^ Syntax Error: await expression cannot be used within a type annotation + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_type_alias.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_type_alias.py.snap new file mode 100644 index 0000000000000..8b4e9638b59c3 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_annotation_type_alias.py.snap @@ -0,0 +1,437 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/invalid_annotation_type_alias.py +--- +## AST + +``` +Module( + ModModule { + range: 0..406, + body: [ + TypeAlias( + StmtTypeAlias { + range: 0..26, + name: Name( + ExprName { + range: 5..6, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 6..20, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 7..19, + name: Identifier { + id: Name("T"), + range: 7..8, + }, + bound: Some( + Yield( + ExprYield { + range: 11..18, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 17..18, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 23..26, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 48..75, + name: Name( + ExprName { + range: 53..54, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 54..69, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 55..68, + name: Identifier { + id: Name("T"), + range: 55..56, + }, + bound: None, + default: Some( + Yield( + ExprYield { + range: 60..67, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 66..67, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 72..75, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 98..127, + name: Name( + ExprName { + range: 103..104, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 104..121, + type_params: [ + TypeVarTuple( + TypeParamTypeVarTuple { + range: 105..120, + name: Identifier { + id: Name("Ts"), + range: 106..108, + }, + default: Some( + Yield( + ExprYield { + range: 112..119, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 118..119, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 124..127, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 153..183, + name: Name( + ExprName { + range: 158..159, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 159..177, + type_params: [ + ParamSpec( + TypeParamParamSpec { + range: 160..176, + name: Identifier { + id: Name("Ts"), + range: 162..164, + }, + default: Some( + Yield( + ExprYield { + range: 168..175, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 174..175, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 180..183, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 205..223, + name: Name( + ExprName { + range: 210..211, + id: Name("Y"), + ctx: Store, + }, + ), + type_params: None, + value: Yield( + ExprYield { + range: 215..222, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 221..222, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 254..271, + name: Name( + ExprName { + range: 259..260, + id: Name("Y"), + ctx: Store, + }, + ), + type_params: None, + value: Named( + ExprNamed { + range: 264..270, + target: Name( + ExprName { + range: 264..265, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 269..270, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 308..334, + name: Name( + ExprName { + range: 313..314, + id: Name("Y"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 314..328, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 315..327, + name: Identifier { + id: Name("T"), + range: 315..316, + }, + bound: Some( + Await( + ExprAwait { + range: 319..326, + value: NumberLiteral( + ExprNumberLiteral { + range: 325..326, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + default: None, + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 331..334, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + TypeAlias( + StmtTypeAlias { + range: 357..375, + name: Name( + ExprName { + range: 362..363, + id: Name("Y"), + ctx: Store, + }, + ), + type_params: None, + value: Await( + ExprAwait { + range: 367..374, + value: NumberLiteral( + ExprNumberLiteral { + range: 373..374, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | type X[T: (yield 1)] = int # TypeVar bound + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar bound +2 | type X[T = (yield 1)] = int # TypeVar default +3 | type X[*Ts = (yield 1)] = int # TypeVarTuple default + | + + + | +1 | type X[T: (yield 1)] = int # TypeVar bound +2 | type X[T = (yield 1)] = int # TypeVar default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar default +3 | type X[*Ts = (yield 1)] = int # TypeVarTuple default +4 | type X[**Ts = (yield 1)] = int # ParamSpec default + | + + + | +1 | type X[T: (yield 1)] = int # TypeVar bound +2 | type X[T = (yield 1)] = int # TypeVar default +3 | type X[*Ts = (yield 1)] = int # TypeVarTuple default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVarTuple default +4 | type X[**Ts = (yield 1)] = int # ParamSpec default +5 | type Y = (yield 1) # yield in value + | + + + | +2 | type X[T = (yield 1)] = int # TypeVar default +3 | type X[*Ts = (yield 1)] = int # TypeVarTuple default +4 | type X[**Ts = (yield 1)] = int # ParamSpec default + | ^^^^^^^ Syntax Error: yield expression cannot be used within a ParamSpec default +5 | type Y = (yield 1) # yield in value +6 | type Y = (x := 1) # named expr in value + | + + + | +3 | type X[*Ts = (yield 1)] = int # TypeVarTuple default +4 | type X[**Ts = (yield 1)] = int # ParamSpec default +5 | type Y = (yield 1) # yield in value + | ^^^^^^^ Syntax Error: yield expression cannot be used within a type alias +6 | type Y = (x := 1) # named expr in value +7 | type Y[T: (await 1)] = int # await in bound + | + + + | +4 | type X[**Ts = (yield 1)] = int # ParamSpec default +5 | type Y = (yield 1) # yield in value +6 | type Y = (x := 1) # named expr in value + | ^^^^^^ Syntax Error: named expression cannot be used within a type alias +7 | type Y[T: (await 1)] = int # await in bound +8 | type Y = (await 1) # await in value + | + + + | +5 | type Y = (yield 1) # yield in value +6 | type Y = (x := 1) # named expr in value +7 | type Y[T: (await 1)] = int # await in bound + | ^^^^^^^ Syntax Error: await expression cannot be used within a TypeVar bound +8 | type Y = (await 1) # await in value + | + + + | +6 | type Y = (x := 1) # named expr in value +7 | type Y[T: (await 1)] = int # await in bound +8 | type Y = (await 1) # await in value + | ^^^^^^^ Syntax Error: await expression cannot be used within a type alias + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_byte_literal.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_byte_literal.py.snap index e8cbf9ac5d609..0cb2a556d7b94 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_byte_literal.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_byte_literal.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/invalid_byte_literal.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_del_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_del_target.py.snap index 28880171aa95e..c3731e868d969 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_del_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_del_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/invalid_del_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_fstring_literal_element.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_fstring_literal_element.py.snap index 58211f349bab3..790a2e91ca9db 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_fstring_literal_element.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_fstring_literal_element.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/invalid_fstring_literal_element.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_string_literal.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_string_literal.py.snap index 4847bbe2ef3e6..f459755d73f0a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_string_literal.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@invalid_string_literal.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/invalid_string_literal.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@irrefutable_case_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@irrefutable_case_pattern.py.snap new file mode 100644 index 0000000000000..ca46e5e687880 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@irrefutable_case_pattern.py.snap @@ -0,0 +1,374 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/irrefutable_case_pattern.py +--- +## AST + +``` +Module( + ModModule { + range: 0..317, + body: [ + Match( + StmtMatch { + range: 0..61, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..26, + pattern: MatchAs( + PatternMatchAs { + range: 18..21, + pattern: None, + name: Some( + Identifier { + id: Name("var"), + range: 18..21, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 23..26, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 23..26, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 50..61, + pattern: MatchValue( + PatternMatchValue { + range: 55..56, + value: NumberLiteral( + ExprNumberLiteral { + range: 55..56, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ], + }, + ), + Match( + StmtMatch { + range: 62..102, + subject: Name( + ExprName { + range: 68..69, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 75..86, + pattern: MatchAs( + PatternMatchAs { + range: 80..81, + pattern: None, + name: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 83..86, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 83..86, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 91..102, + pattern: MatchValue( + PatternMatchValue { + range: 96..97, + value: NumberLiteral( + ExprNumberLiteral { + range: 96..97, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 99..102, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 99..102, + }, + ), + }, + ), + ], + }, + ], + }, + ), + Match( + StmtMatch { + range: 125..222, + subject: Name( + ExprName { + range: 131..132, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 138..160, + pattern: MatchAs( + PatternMatchAs { + range: 143..155, + pattern: Some( + MatchAs( + PatternMatchAs { + range: 143..147, + pattern: None, + name: Some( + Identifier { + id: Name("var1"), + range: 143..147, + }, + ), + }, + ), + ), + name: Some( + Identifier { + id: Name("var2"), + range: 151..155, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 157..160, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 157..160, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 211..222, + pattern: MatchValue( + PatternMatchValue { + range: 216..217, + value: NumberLiteral( + ExprNumberLiteral { + range: 216..217, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 219..222, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 219..222, + }, + ), + }, + ), + ], + }, + ], + }, + ), + Match( + StmtMatch { + range: 223..316, + subject: Name( + ExprName { + range: 229..230, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 236..264, + pattern: MatchOr( + PatternMatchOr { + range: 241..259, + patterns: [ + MatchValue( + PatternMatchValue { + range: 241..253, + value: Attribute( + ExprAttribute { + range: 241..253, + value: Name( + ExprName { + range: 241..245, + id: Name("enum"), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("variant"), + range: 246..253, + }, + ctx: Load, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 256..259, + pattern: None, + name: Some( + Identifier { + id: Name("var"), + range: 256..259, + }, + ), + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 261..264, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 261..264, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 305..316, + pattern: MatchValue( + PatternMatchValue { + range: 310..311, + value: NumberLiteral( + ExprNumberLiteral { + range: 310..311, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 313..316, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 313..316, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | match x: +2 | case var: ... # capture pattern + | ^^^ Syntax Error: name capture `var` makes remaining patterns unreachable +3 | case 2: ... +4 | match x: + | + + + | +3 | case 2: ... +4 | match x: +5 | case _: ... + | ^ Syntax Error: wildcard makes remaining patterns unreachable +6 | case 2: ... # wildcard pattern +7 | match x: + | + + + | + 6 | case 2: ... # wildcard pattern + 7 | match x: + 8 | case var1 as var2: ... # as pattern with irrefutable left-hand side + | ^^^^ Syntax Error: name capture `var1` makes remaining patterns unreachable + 9 | case 2: ... +10 | match x: + | + + + | + 9 | case 2: ... +10 | match x: +11 | case enum.variant | var: ... # or pattern with irrefutable part + | ^^^ Syntax Error: name capture `var` makes remaining patterns unreachable +12 | case 2: ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_return_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_return_py37.py.snap new file mode 100644 index 0000000000000..0aa69e8be1803 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_return_py37.py.snap @@ -0,0 +1,146 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/iter_unpack_return_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..91, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..90, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 69..90, + value: Some( + Tuple( + ExprTuple { + range: 76..90, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 76..77, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 79..80, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 82..83, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 85..90, + value: Name( + ExprName { + range: 86..90, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.7"} +2 | rest = (4, 5, 6) +3 | def f(): return 1, 2, 3, *rest + | ^^^^^ Syntax Error: Cannot use iterable unpacking in return statements on Python 3.7 (syntax was added in Python 3.8) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_yield_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_yield_py37.py.snap new file mode 100644 index 0000000000000..44b0fe51e34c8 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@iter_unpack_yield_py37.py.snap @@ -0,0 +1,257 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/iter_unpack_yield_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..128, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..89, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 69..89, + value: Yield( + ExprYield { + range: 69..89, + value: Some( + Tuple( + ExprTuple { + range: 75..89, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 75..76, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 78..79, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 81..82, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 84..89, + value: Name( + ExprName { + range: 85..89, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 90..127, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("h"), + range: 94..95, + }, + type_params: None, + parameters: Parameters { + range: 95..97, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 99..127, + value: Yield( + ExprYield { + range: 99..127, + value: Some( + Tuple( + ExprTuple { + range: 105..127, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 105..106, + value: Int( + 1, + ), + }, + ), + Yield( + ExprYield { + range: 109..123, + value: Some( + Tuple( + ExprTuple { + range: 115..123, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 115..116, + value: Int( + 2, + ), + }, + ), + Starred( + ExprStarred { + range: 118..123, + value: Name( + ExprName { + range: 119..123, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 126..127, + value: Int( + 3, + ), + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.7"} +2 | rest = (4, 5, 6) +3 | def g(): yield 1, 2, 3, *rest + | ^^^^^ Syntax Error: Cannot use iterable unpacking in yield expressions on Python 3.7 (syntax was added in Python 3.8) +4 | def h(): yield 1, (yield 2, *rest), 3 + | + + + | +2 | rest = (4, 5, 6) +3 | def g(): yield 1, 2, 3, *rest +4 | def h(): yield 1, (yield 2, *rest), 3 + | ^^^^^ Syntax Error: Cannot use iterable unpacking in yield expressions on Python 3.7 (syntax was added in Python 3.8) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_starred_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_starred_expr.py.snap index bbea803b8dc21..98b0ef84a3e3d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_starred_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_starred_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/lambda_body_with_starred_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_yield_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_yield_expr.py.snap index 072a112e0cf4e..fe4a4b01abd51 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_yield_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@lambda_body_with_yield_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/lambda_body_with_yield_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_before_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_before_py310.py.snap new file mode 100644 index 0000000000000..a951295d8a809 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_before_py310.py.snap @@ -0,0 +1,63 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/match_before_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..79, + body: [ + Match( + StmtMatch { + range: 45..78, + subject: NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 2, + ), + }, + ), + cases: [ + MatchCase { + range: 58..78, + pattern: MatchValue( + PatternMatchValue { + range: 63..64, + value: NumberLiteral( + ExprNumberLiteral { + range: 63..64, + value: Int( + 1, + ), + }, + ), + }, + ), + guard: None, + body: [ + Pass( + StmtPass { + range: 74..78, + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.9" } +2 | match 2: + | ^^^^^ Syntax Error: Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10) +3 | case 1: +4 | pass + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword.py.snap index 309fb36a80be0..81e020fe54a61 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_classify_as_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword_or_identifier.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword_or_identifier.py.snap index 7d49c6ad3ca5f..9681e681bba8b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword_or_identifier.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_classify_as_keyword_or_identifier.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_classify_as_keyword_or_identifier.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_expected_colon.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_expected_colon.py.snap index 4b4f623995ac8..42e2347dd2fc3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_expected_colon.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_expected_colon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_expected_colon.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expect_indented_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expect_indented_block.py.snap index 8964f5715f630..5ba948d16b052 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expect_indented_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expect_indented_block.py.snap @@ -62,4 +62,5 @@ Module( | 1 | match foo: 2 | case _: ... + | ^ Syntax Error: Expected dedent, found end of file | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expected_case_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expected_case_block.py.snap index aacdafae78173..2844e904f7156 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expected_case_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_expected_case_block.py.snap @@ -112,8 +112,8 @@ Module( | 1 | match x: 2 | x = 1 + | ^ Syntax Error: Expected a statement 3 | match x: - | Syntax Error: Expected a statement 4 | match y: 5 | case _: ... | @@ -131,4 +131,5 @@ Module( | 4 | match y: 5 | case _: ... + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_guard_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_guard_expr.py.snap index d6414cd19885d..5028df2a0d252 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_guard_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_guard_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_stmt_invalid_guard_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_subject_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_subject_expr.py.snap index b66638023e68f..e7e2359f8363b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_subject_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_invalid_subject_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_stmt_invalid_subject_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_guard_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_guard_expr.py.snap index 2b4abbd6375fc..2dbcec05b1263 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_guard_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_guard_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_stmt_missing_guard_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_pattern.py.snap index da43e7947ca32..81183473ca969 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_pattern.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_missing_pattern.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_stmt_missing_pattern.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_no_newline_before_case.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_no_newline_before_case.py.snap index ca54385407968..6a9ba216b3a0c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_no_newline_before_case.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_no_newline_before_case.py.snap @@ -60,4 +60,5 @@ Module( | 1 | match foo: case _: ... + | ^ Syntax Error: Expected dedent, found end of file | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_single_starred_subject.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_single_starred_subject.py.snap index 6926b0bda064c..affa89318ac75 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_single_starred_subject.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@match_stmt_single_starred_subject.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/match_stmt_single_starred_subject.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@mixed_bytes_and_non_bytes_literals.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@mixed_bytes_and_non_bytes_literals.py.snap index 0a8782484f1b4..07d4518fcc44f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@mixed_bytes_and_non_bytes_literals.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@mixed_bytes_and_non_bytes_literals.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/mixed_bytes_and_non_bytes_literals.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_assignment_in_case_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_assignment_in_case_pattern.py.snap new file mode 100644 index 0000000000000..c47d0febba18f --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_assignment_in_case_pattern.py.snap @@ -0,0 +1,718 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/multiple_assignment_in_case_pattern.py +--- +## AST + +``` +Module( + ModModule { + range: 0..456, + body: [ + Match( + StmtMatch { + range: 0..444, + subject: NumberLiteral( + ExprNumberLiteral { + range: 6..7, + value: Int( + 2, + ), + }, + ), + cases: [ + MatchCase { + range: 13..32, + pattern: MatchSequence( + PatternMatchSequence { + range: 18..27, + patterns: [ + MatchAs( + PatternMatchAs { + range: 19..20, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 19..20, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 22..23, + pattern: None, + name: Some( + Identifier { + id: Name("z"), + range: 22..23, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 25..26, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 25..26, + }, + ), + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 29..32, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 29..32, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 54..74, + pattern: MatchSequence( + PatternMatchSequence { + range: 59..69, + patterns: [ + MatchAs( + PatternMatchAs { + range: 60..61, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 60..61, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 63..64, + pattern: None, + name: Some( + Identifier { + id: Name("z"), + range: 63..64, + }, + ), + }, + ), + MatchStar( + PatternMatchStar { + range: 66..68, + name: Some( + Identifier { + id: Name("y"), + range: 67..68, + }, + ), + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 71..74, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 71..74, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 96..115, + pattern: MatchSequence( + PatternMatchSequence { + range: 101..110, + patterns: [ + MatchAs( + PatternMatchAs { + range: 102..103, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 102..103, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 105..106, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 105..106, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 108..109, + pattern: None, + name: Some( + Identifier { + id: Name("y"), + range: 108..109, + }, + ), + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 112..115, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 112..115, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 146..168, + pattern: MatchMapping( + PatternMatchMapping { + range: 151..163, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 152..153, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 158..159, + value: Int( + 2, + ), + }, + ), + ], + patterns: [ + MatchAs( + PatternMatchAs { + range: 155..156, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 155..156, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 161..162, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 161..162, + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 165..168, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 165..168, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 207..228, + pattern: MatchMapping( + PatternMatchMapping { + range: 212..223, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 213..214, + value: Int( + 1, + ), + }, + ), + ], + patterns: [ + MatchAs( + PatternMatchAs { + range: 216..217, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 216..217, + }, + ), + }, + ), + ], + rest: Some( + Identifier { + id: Name("x"), + range: 221..222, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 225..228, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 225..228, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 269..290, + pattern: MatchClass( + PatternMatchClass { + range: 274..285, + cls: Name( + ExprName { + range: 274..279, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 279..285, + patterns: [ + MatchAs( + PatternMatchAs { + range: 280..281, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 280..281, + }, + ), + }, + ), + MatchAs( + PatternMatchAs { + range: 283..284, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 283..284, + }, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 287..290, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 287..290, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 320..345, + pattern: MatchClass( + PatternMatchClass { + range: 325..340, + cls: Name( + ExprName { + range: 325..330, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 330..340, + patterns: [], + keywords: [ + PatternKeyword { + range: 331..334, + attr: Identifier { + id: Name("y"), + range: 331..332, + }, + pattern: MatchAs( + PatternMatchAs { + range: 333..334, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 333..334, + }, + ), + }, + ), + }, + PatternKeyword { + range: 336..339, + attr: Identifier { + id: Name("z"), + range: 336..337, + }, + pattern: MatchAs( + PatternMatchAs { + range: 338..339, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 338..339, + }, + ), + }, + ), + }, + ], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 342..345, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 342..345, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 372..412, + pattern: MatchOr( + PatternMatchOr { + range: 377..407, + patterns: [ + MatchSequence( + PatternMatchSequence { + range: 377..380, + patterns: [ + MatchAs( + PatternMatchAs { + range: 378..379, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 378..379, + }, + ), + }, + ), + ], + }, + ), + MatchMapping( + PatternMatchMapping { + range: 383..389, + keys: [ + NumberLiteral( + ExprNumberLiteral { + range: 384..385, + value: Int( + 1, + ), + }, + ), + ], + patterns: [ + MatchAs( + PatternMatchAs { + range: 387..388, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 387..388, + }, + ), + }, + ), + ], + rest: None, + }, + ), + MatchClass( + PatternMatchClass { + range: 392..407, + cls: Name( + ExprName { + range: 392..397, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 397..407, + patterns: [], + keywords: [ + PatternKeyword { + range: 398..401, + attr: Identifier { + id: Name("y"), + range: 398..399, + }, + pattern: MatchAs( + PatternMatchAs { + range: 400..401, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 400..401, + }, + ), + }, + ), + }, + PatternKeyword { + range: 403..406, + attr: Identifier { + id: Name("z"), + range: 403..404, + }, + pattern: MatchAs( + PatternMatchAs { + range: 405..406, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 405..406, + }, + ), + }, + ), + }, + ], + }, + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 409..412, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 409..412, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 428..444, + pattern: MatchAs( + PatternMatchAs { + range: 433..439, + pattern: Some( + MatchAs( + PatternMatchAs { + range: 433..434, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 433..434, + }, + ), + }, + ), + ), + name: Some( + Identifier { + id: Name("x"), + range: 438..439, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 441..444, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 441..444, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | match 2: +2 | case [y, z, y]: ... # MatchSequence + | ^ Syntax Error: multiple assignments to name `y` in pattern +3 | case [y, z, *y]: ... # MatchSequence +4 | case [y, y, y]: ... # MatchSequence multiple + | + + + | +1 | match 2: +2 | case [y, z, y]: ... # MatchSequence +3 | case [y, z, *y]: ... # MatchSequence + | ^ Syntax Error: multiple assignments to name `y` in pattern +4 | case [y, y, y]: ... # MatchSequence multiple +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern + | + + + | +2 | case [y, z, y]: ... # MatchSequence +3 | case [y, z, *y]: ... # MatchSequence +4 | case [y, y, y]: ... # MatchSequence multiple + | ^ Syntax Error: multiple assignments to name `y` in pattern +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern +6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest + | + + + | +2 | case [y, z, y]: ... # MatchSequence +3 | case [y, z, *y]: ... # MatchSequence +4 | case [y, y, y]: ... # MatchSequence multiple + | ^ Syntax Error: multiple assignments to name `y` in pattern +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern +6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest + | + + + | +3 | case [y, z, *y]: ... # MatchSequence +4 | case [y, y, y]: ... # MatchSequence multiple +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern + | ^ Syntax Error: multiple assignments to name `x` in pattern +6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest +7 | case Class(x, x): ... # MatchClass positional + | + + + | +4 | case [y, y, y]: ... # MatchSequence multiple +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern +6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest + | ^ Syntax Error: multiple assignments to name `x` in pattern +7 | case Class(x, x): ... # MatchClass positional +8 | case Class(y=x, z=x): ... # MatchClass keyword + | + + + | +5 | case {1: x, 2: x}: ... # MatchMapping duplicate pattern +6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest +7 | case Class(x, x): ... # MatchClass positional + | ^ Syntax Error: multiple assignments to name `x` in pattern +8 | case Class(y=x, z=x): ... # MatchClass keyword +9 | case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr + | + + + | + 6 | case {1: x, **x}: ... # MatchMapping duplicate in **rest + 7 | case Class(x, x): ... # MatchClass positional + 8 | case Class(y=x, z=x): ... # MatchClass keyword + | ^ Syntax Error: multiple assignments to name `x` in pattern + 9 | case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr +10 | case x as x: ... # MatchAs + | + + + | + 7 | case Class(x, x): ... # MatchClass positional + 8 | case Class(y=x, z=x): ... # MatchClass keyword + 9 | case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr + | ^ Syntax Error: multiple assignments to name `x` in pattern +10 | case x as x: ... # MatchAs + | + + + | + 8 | case Class(y=x, z=x): ... # MatchClass keyword + 9 | case [x] | {1: x} | Class(y=x, z=x): ... # MatchOr +10 | case x as x: ... # MatchAs + | ^ Syntax Error: multiple assignments to name `x` in pattern + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_clauses_on_same_line.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_clauses_on_same_line.py.snap index 652815a142627..f67856c23fbd2 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_clauses_on_same_line.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@multiple_clauses_on_same_line.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/multiple_clauses_on_same_line.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice.py.snap new file mode 100644 index 0000000000000..815b74f88cd78 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice.py.snap @@ -0,0 +1,258 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/named_expr_slice.py +--- +## AST + +``` +Module( + ModModule { + range: 0..119, + body: [ + Expr( + StmtExpr { + range: 80..92, + value: Subscript( + ExprSubscript { + range: 80..92, + value: Name( + ExprName { + range: 80..83, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Slice( + ExprSlice { + range: 84..91, + lower: Some( + Named( + ExprNamed { + range: 84..88, + target: Name( + ExprName { + range: 84..85, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 87..88, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + upper: Some( + UnaryOp( + ExprUnaryOp { + range: 89..91, + op: USub, + operand: NumberLiteral( + ExprNumberLiteral { + range: 90..91, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + step: None, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 93..100, + value: Subscript( + ExprSubscript { + range: 93..100, + value: Name( + ExprName { + range: 93..96, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Slice( + ExprSlice { + range: 97..100, + lower: Some( + NumberLiteral( + ExprNumberLiteral { + range: 97..98, + value: Int( + 1, + ), + }, + ), + ), + upper: Some( + Name( + ExprName { + range: 99..100, + id: Name("x"), + ctx: Load, + }, + ), + ), + step: None, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 102..103, + value: NumberLiteral( + ExprNumberLiteral { + range: 102..103, + value: Int( + 1, + ), + }, + ), + }, + ), + Expr( + StmtExpr { + range: 105..114, + value: Subscript( + ExprSubscript { + range: 105..114, + value: Name( + ExprName { + range: 105..108, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Slice( + ExprSlice { + range: 109..114, + lower: Some( + NumberLiteral( + ExprNumberLiteral { + range: 109..110, + value: Int( + 1, + ), + }, + ), + ), + upper: Some( + NumberLiteral( + ExprNumberLiteral { + range: 111..112, + value: Int( + 3, + ), + }, + ), + ), + step: Some( + Name( + ExprName { + range: 113..114, + id: Name("x"), + ctx: Load, + }, + ), + ), + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 116..117, + value: NumberLiteral( + ExprNumberLiteral { + range: 116..117, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + }, +) +``` +## Errors + + | +1 | # even after 3.9, an unparenthesized named expression is not allowed in a slice +2 | lst[x:=1:-1] + | ^^^^ Syntax Error: Unparenthesized named expression cannot be used here +3 | lst[1:x:=1] +4 | lst[1:3:x:=1] + | + + + | +1 | # even after 3.9, an unparenthesized named expression is not allowed in a slice +2 | lst[x:=1:-1] +3 | lst[1:x:=1] + | ^^ Syntax Error: Expected ']', found ':=' +4 | lst[1:3:x:=1] + | + + + | +1 | # even after 3.9, an unparenthesized named expression is not allowed in a slice +2 | lst[x:=1:-1] +3 | lst[1:x:=1] + | ^ Syntax Error: Expected a statement +4 | lst[1:3:x:=1] + | + + + | +1 | # even after 3.9, an unparenthesized named expression is not allowed in a slice +2 | lst[x:=1:-1] +3 | lst[1:x:=1] + | ^ Syntax Error: Expected a statement +4 | lst[1:3:x:=1] + | + + + | +2 | lst[x:=1:-1] +3 | lst[1:x:=1] +4 | lst[1:3:x:=1] + | ^^ Syntax Error: Expected ']', found ':=' + | + + + | +2 | lst[x:=1:-1] +3 | lst[1:x:=1] +4 | lst[1:3:x:=1] + | ^ Syntax Error: Expected a statement + | + + + | +2 | lst[x:=1:-1] +3 | lst[1:x:=1] +4 | lst[1:3:x:=1] + | ^ Syntax Error: Expected a statement + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice_parse_error.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice_parse_error.py.snap new file mode 100644 index 0000000000000..d0166af2f4f0e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@named_expr_slice_parse_error.py.snap @@ -0,0 +1,85 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/named_expr_slice_parse_error.py +--- +## AST + +``` +Module( + ModModule { + range: 0..130, + body: [ + Expr( + StmtExpr { + range: 117..129, + value: Subscript( + ExprSubscript { + range: 117..129, + value: Name( + ExprName { + range: 117..120, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Slice( + ExprSlice { + range: 121..128, + lower: Some( + Named( + ExprNamed { + range: 121..125, + target: Name( + ExprName { + range: 121..122, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 124..125, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + upper: Some( + UnaryOp( + ExprUnaryOp { + range: 126..128, + op: USub, + operand: NumberLiteral( + ExprNumberLiteral { + range: 127..128, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + step: None, + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | # before 3.9, only emit the parse error, not the unsupported syntax error +3 | lst[x:=1:-1] + | ^^^^ Syntax Error: Unparenthesized named expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nested_async_comprehension_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nested_async_comprehension_py310.py.snap new file mode 100644 index 0000000000000..cec50a8151184 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nested_async_comprehension_py310.py.snap @@ -0,0 +1,823 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/nested_async_comprehension_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..467, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..111, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 54..55, + }, + type_params: None, + parameters: Parameters { + range: 55..57, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 59..111, + value: Some( + ListComp( + ExprListComp { + range: 66..111, + elt: ListComp( + ExprListComp { + range: 67..92, + elt: Name( + ExprName { + range: 68..69, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 70..91, + target: Name( + ExprName { + range: 80..81, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 85..91, + func: Name( + ExprName { + range: 85..88, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 88..91, + args: [ + Name( + ExprName { + range: 89..90, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 93..110, + target: Name( + ExprName { + range: 97..98, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 102..110, + func: Name( + ExprName { + range: 102..107, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 107..110, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 108..109, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 122..192, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 132..133, + }, + type_params: None, + parameters: Parameters { + range: 133..135, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 137..192, + value: Some( + ListComp( + ExprListComp { + range: 144..192, + elt: DictComp( + ExprDictComp { + range: 145..173, + key: Name( + ExprName { + range: 146..147, + id: Name("x"), + ctx: Load, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 149..150, + value: Int( + 1, + ), + }, + ), + generators: [ + Comprehension { + range: 151..172, + target: Name( + ExprName { + range: 161..162, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 166..172, + func: Name( + ExprName { + range: 166..169, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 169..172, + args: [ + Name( + ExprName { + range: 170..171, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 174..191, + target: Name( + ExprName { + range: 178..179, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 183..191, + func: Name( + ExprName { + range: 183..188, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 188..191, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 189..190, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 200..267, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("h"), + range: 210..211, + }, + type_params: None, + parameters: Parameters { + range: 211..213, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 215..267, + value: Some( + ListComp( + ExprListComp { + range: 222..267, + elt: SetComp( + ExprSetComp { + range: 223..248, + elt: Name( + ExprName { + range: 224..225, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 226..247, + target: Name( + ExprName { + range: 236..237, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 241..247, + func: Name( + ExprName { + range: 241..244, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 244..247, + args: [ + Name( + ExprName { + range: 245..246, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 249..266, + target: Name( + ExprName { + range: 253..254, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 258..266, + func: Name( + ExprName { + range: 258..263, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 263..266, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 264..265, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 277..371, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("i"), + range: 287..288, + }, + type_params: None, + parameters: Parameters { + range: 288..290, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 292..371, + value: Some( + ListComp( + ExprListComp { + range: 299..371, + elt: Tuple( + ExprTuple { + range: 300..352, + elts: [ + ListComp( + ExprListComp { + range: 301..328, + elt: Name( + ExprName { + range: 302..303, + id: Name("y"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 304..327, + target: Name( + ExprName { + range: 314..315, + id: Name("y"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 319..327, + func: Name( + ExprName { + range: 319..324, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 324..327, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 325..326, + value: Int( + 1, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + ListComp( + ExprListComp { + range: 330..351, + elt: Name( + ExprName { + range: 331..332, + id: Name("z"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 333..350, + target: Name( + ExprName { + range: 337..338, + id: Name("z"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 342..350, + func: Name( + ExprName { + range: 342..347, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 347..350, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 348..349, + value: Int( + 2, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + generators: [ + Comprehension { + range: 353..370, + target: Name( + ExprName { + range: 357..358, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 362..370, + func: Name( + ExprName { + range: 362..367, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 367..370, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 368..369, + value: Int( + 5, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 372..466, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("j"), + range: 382..383, + }, + type_params: None, + parameters: Parameters { + range: 383..385, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 387..466, + value: Some( + ListComp( + ExprListComp { + range: 394..466, + elt: Tuple( + ExprTuple { + range: 395..447, + elts: [ + ListComp( + ExprListComp { + range: 396..417, + elt: Name( + ExprName { + range: 397..398, + id: Name("y"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 399..416, + target: Name( + ExprName { + range: 403..404, + id: Name("y"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 408..416, + func: Name( + ExprName { + range: 408..413, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 413..416, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 414..415, + value: Int( + 1, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ListComp( + ExprListComp { + range: 419..446, + elt: Name( + ExprName { + range: 420..421, + id: Name("z"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 422..445, + target: Name( + ExprName { + range: 432..433, + id: Name("z"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 437..445, + func: Name( + ExprName { + range: 437..442, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 442..445, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 443..444, + value: Int( + 2, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + generators: [ + Comprehension { + range: 448..465, + target: Name( + ExprName { + range: 452..453, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 457..465, + func: Name( + ExprName { + range: 457..462, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 462..465, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 463..464, + value: Int( + 5, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | # parse_options: {"target-version": "3.10"} +2 | async def f(): return [[x async for x in foo(n)] for n in range(3)] # list + | ^^^^^^^^^^^^^^^^^^^^^ Syntax Error: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) +3 | async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict +4 | async def h(): return [{x async for x in foo(n)} for n in range(3)] # set + | + + + | +1 | # parse_options: {"target-version": "3.10"} +2 | async def f(): return [[x async for x in foo(n)] for n in range(3)] # list +3 | async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict + | ^^^^^^^^^^^^^^^^^^^^^ Syntax Error: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) +4 | async def h(): return [{x async for x in foo(n)} for n in range(3)] # set +5 | async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] + | + + + | +2 | async def f(): return [[x async for x in foo(n)] for n in range(3)] # list +3 | async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict +4 | async def h(): return [{x async for x in foo(n)} for n in range(3)] # set + | ^^^^^^^^^^^^^^^^^^^^^ Syntax Error: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) +5 | async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] +6 | async def j(): return [([y for y in range(1)], [z async for z in range(2)]) for x in range(5)] + | + + + | +3 | async def g(): return [{x: 1 async for x in foo(n)} for n in range(3)] # dict +4 | async def h(): return [{x async for x in foo(n)} for n in range(3)] # set +5 | async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] + | ^^^^^^^^^^^^^^^^^^^^^^^ Syntax Error: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) +6 | async def j(): return [([y for y in range(1)], [z async for z in range(2)]) for x in range(5)] + | + + + | +4 | async def h(): return [{x async for x in foo(n)} for n in range(3)] # set +5 | async def i(): return [([y async for y in range(1)], [z for z in range(2)]) for x in range(5)] +6 | async def j(): return [([y for y in range(1)], [z async for z in range(2)]) for x in range(5)] + | ^^^^^^^^^^^^^^^^^^^^^^^ Syntax Error: cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@node_range_with_gaps.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@node_range_with_gaps.py.snap index 7326c3c1a81fe..e6364e6c4c577 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@node_range_with_gaps.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@node_range_with_gaps.py.snap @@ -119,4 +119,5 @@ Module( | 2 | def bar(): ... 3 | def baz + | ^ Syntax Error: Expected ')', found end of file | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_declaration_at_module_level.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_declaration_at_module_level.py.snap new file mode 100644 index 0000000000000..8b63405c85239 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_declaration_at_module_level.py.snap @@ -0,0 +1,55 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/nonlocal_declaration_at_module_level.py +--- +## AST + +``` +Module( + ModModule { + range: 0..25, + body: [ + Nonlocal( + StmtNonlocal { + range: 0..10, + names: [ + Identifier { + id: Name("x"), + range: 9..10, + }, + ], + }, + ), + Nonlocal( + StmtNonlocal { + range: 11..24, + names: [ + Identifier { + id: Name("x"), + range: 20..21, + }, + Identifier { + id: Name("y"), + range: 23..24, + }, + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | nonlocal x + | ^^^^^^^^^^ Syntax Error: nonlocal declaration not allowed at module level +2 | nonlocal x, y + | + + + | +1 | nonlocal x +2 | nonlocal x, y + | ^^^^^^^^^^^^^ Syntax Error: nonlocal declaration not allowed at module level + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_empty.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_empty.py.snap index 63bb39d57c6fd..67c9ca6335fa2 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_empty.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_empty.py.snap @@ -7,12 +7,35 @@ input_file: crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_empty.p ``` Module( ModModule { - range: 0..9, + range: 0..22, body: [ - Nonlocal( - StmtNonlocal { - range: 0..8, - names: [], + FunctionDef( + StmtFunctionDef { + range: 0..21, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Nonlocal( + StmtNonlocal { + range: 13..21, + names: [], + }, + ), + ], }, ), ], @@ -22,6 +45,7 @@ Module( ## Errors | -1 | nonlocal - | ^ Syntax Error: Nonlocal statement must have at least one name +1 | def _(): +2 | nonlocal + | ^ Syntax Error: Nonlocal statement must have at least one name | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_expression.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_expression.py.snap index 1f46cd034fbaf..b5d768d9a32e3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_expression.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_expression.py.snap @@ -7,38 +7,61 @@ input_file: crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_express ``` Module( ModModule { - range: 0..15, + range: 0..28, body: [ - Nonlocal( - StmtNonlocal { - range: 0..10, - names: [ - Identifier { - id: Name("x"), - range: 9..10, - }, + FunctionDef( + StmtFunctionDef { + range: 0..27, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Nonlocal( + StmtNonlocal { + range: 13..23, + names: [ + Identifier { + id: Name("x"), + range: 22..23, + }, + ], + }, + ), + Expr( + StmtExpr { + range: 24..27, + value: UnaryOp( + ExprUnaryOp { + range: 24..27, + op: UAdd, + operand: NumberLiteral( + ExprNumberLiteral { + range: 26..27, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ), ], }, ), - Expr( - StmtExpr { - range: 11..14, - value: UnaryOp( - ExprUnaryOp { - range: 11..14, - op: UAdd, - operand: NumberLiteral( - ExprNumberLiteral { - range: 13..14, - value: Int( - 1, - ), - }, - ), - }, - ), - }, - ), ], }, ) @@ -46,6 +69,7 @@ Module( ## Errors | -1 | nonlocal x + 1 - | ^ Syntax Error: Simple statements must be separated by newlines or semicolons +1 | def _(): +2 | nonlocal x + 1 + | ^ Syntax Error: Simple statements must be separated by newlines or semicolons | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_trailing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_trailing_comma.py.snap index 67e6ac6f7826f..ee76a9c939bb7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_trailing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@nonlocal_stmt_trailing_comma.py.snap @@ -7,37 +7,60 @@ input_file: crates/ruff_python_parser/resources/inline/err/nonlocal_stmt_trailin ``` Module( ModModule { - range: 0..38, + range: 0..59, body: [ - Nonlocal( - StmtNonlocal { - range: 0..10, - names: [], - }, - ), - Nonlocal( - StmtNonlocal { - range: 11..22, - names: [ - Identifier { - id: Name("x"), - range: 20..21, - }, - ], - }, - ), - Nonlocal( - StmtNonlocal { - range: 23..37, - names: [ - Identifier { - id: Name("x"), - range: 32..33, - }, - Identifier { - id: Name("y"), - range: 35..36, - }, + FunctionDef( + StmtFunctionDef { + range: 0..58, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Nonlocal( + StmtNonlocal { + range: 13..23, + names: [], + }, + ), + Nonlocal( + StmtNonlocal { + range: 28..39, + names: [ + Identifier { + id: Name("x"), + range: 37..38, + }, + ], + }, + ), + Nonlocal( + StmtNonlocal { + range: 44..58, + names: [ + Identifier { + id: Name("x"), + range: 53..54, + }, + Identifier { + id: Name("y"), + range: 56..57, + }, + ], + }, + ), ], }, ), @@ -48,32 +71,35 @@ Module( ## Errors | -1 | nonlocal , - | ^ Syntax Error: Expected an identifier -2 | nonlocal x, -3 | nonlocal x, y, +1 | def _(): +2 | nonlocal , + | ^ Syntax Error: Expected an identifier +3 | nonlocal x, +4 | nonlocal x, y, | | -1 | nonlocal , - | ^ Syntax Error: Nonlocal statement must have at least one name -2 | nonlocal x, -3 | nonlocal x, y, +1 | def _(): +2 | nonlocal , + | ^ Syntax Error: Nonlocal statement must have at least one name +3 | nonlocal x, +4 | nonlocal x, y, | | -1 | nonlocal , -2 | nonlocal x, - | ^ Syntax Error: Trailing comma not allowed -3 | nonlocal x, y, +1 | def _(): +2 | nonlocal , +3 | nonlocal x, + | ^ Syntax Error: Trailing comma not allowed +4 | nonlocal x, y, | | -1 | nonlocal , -2 | nonlocal x, -3 | nonlocal x, y, - | ^ Syntax Error: Trailing comma not allowed +2 | nonlocal , +3 | nonlocal x, +4 | nonlocal x, y, + | ^ Syntax Error: Trailing comma not allowed | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_annotation.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_annotation.py.snap index 215fbe03dc835..b0d2dec14add7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_annotation.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_annotation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/param_missing_annotation.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_default.py.snap index 0ed6b9d9ba566..f263e09822eff 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_missing_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/param_missing_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_invalid_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_invalid_default.py.snap index b26f96cb7aa23..6bbc3b41f52fa 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_invalid_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_invalid_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/param_with_invalid_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_star_annotation_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_star_annotation_py310.py.snap new file mode 100644 index 0000000000000..ef87ca461ff9d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@param_with_star_annotation_py310.py.snap @@ -0,0 +1,78 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/param_with_star_annotation_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..69, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..68, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 48..51, + }, + type_params: None, + parameters: Parameters { + range: 51..63, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 52..62, + name: Identifier { + id: Name("args"), + range: 53..57, + }, + annotation: Some( + Starred( + ExprStarred { + range: 59..62, + value: Name( + ExprName { + range: 60..62, + id: Name("Ts"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 65..68, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 65..68, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.10"} +2 | def foo(*args: *Ts): ... + | ^^^ Syntax Error: Cannot use star annotation on Python 3.10 (syntax was added in Python 3.11) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_duplicate_names.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_duplicate_names.py.snap index 2ae962eaaadd8..50e5e76378f26 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_duplicate_names.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_duplicate_names.py.snap @@ -131,7 +131,7 @@ Module( }, ) ``` -## Errors +## Semantic Syntax Errors | 1 | def foo(a, a=10, *a, a, a: str, **a): ... diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_expected_after_star_separator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_expected_after_star_separator.py.snap index 4e068b2b641a0..9a1f540021a7e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_expected_after_star_separator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_expected_after_star_separator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_expected_after_star_separator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_kwarg_after_star_separator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_kwarg_after_star_separator.py.snap index 947b84535b813..3decf036cf2ed 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_kwarg_after_star_separator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_kwarg_after_star_separator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_kwarg_after_star_separator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_kwargs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_kwargs.py.snap index dae60bc1861d1..6fa8e4a41d19a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_kwargs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_kwargs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_multiple_kwargs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_slash_separator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_slash_separator.py.snap index 4c16a418beefc..5c081e0e49828 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_slash_separator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_slash_separator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_multiple_slash_separator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_star_separator.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_star_separator.py.snap index 3b3be63cf6eba..68c9459f96df1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_star_separator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_star_separator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_multiple_star_separator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_varargs.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_varargs.py.snap index eb15f21b12726..4e350369bf888 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_varargs.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_multiple_varargs.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_multiple_varargs.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_no_arg_before_slash.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_no_arg_before_slash.py.snap index 1e21ad9cffcdd..0a3233a0be0a7 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_no_arg_before_slash.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_no_arg_before_slash.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_no_arg_before_slash.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_non_default_after_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_non_default_after_default.py.snap index 7a8bfb02667da..b8ce121d93bcc 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_non_default_after_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_non_default_after_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_non_default_after_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_after_slash.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_after_slash.py.snap index 3537459b4815f..e1bb0c58b95bd 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_after_slash.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_after_slash.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_star_after_slash.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_separator_after_star_param.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_separator_after_star_param.py.snap index 4bf045bfe2bb0..0521d51896083 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_separator_after_star_param.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_star_separator_after_star_param.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_star_separator_after_star_param.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_keyword_with_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_keyword_with_default.py.snap index 592ed1aee9e92..9bde14d96327e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_keyword_with_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_keyword_with_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_var_keyword_with_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_positional_with_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_positional_with_default.py.snap index 6d7e25d0ed922..cafb4857d2a91 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_positional_with_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@params_var_positional_with_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/params_var_positional_with_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_context_manager_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_context_manager_py38.py.snap new file mode 100644 index 0000000000000..0cc6748cbb185 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_context_manager_py38.py.snap @@ -0,0 +1,199 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/parenthesized_context_manager_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..126, + body: [ + With( + StmtWith { + range: 43..73, + is_async: false, + items: [ + WithItem { + range: 49..57, + context_expr: Name( + ExprName { + range: 49..52, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 56..57, + id: Name("x"), + ctx: Store, + }, + ), + ), + }, + WithItem { + range: 59..67, + context_expr: Name( + ExprName { + range: 59..62, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 66..67, + id: Name("y"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 70..73, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 70..73, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 74..99, + is_async: false, + items: [ + WithItem { + range: 80..83, + context_expr: Name( + ExprName { + range: 80..83, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: None, + }, + WithItem { + range: 85..93, + context_expr: Name( + ExprName { + range: 85..88, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 92..93, + id: Name("y"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 96..99, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 96..99, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 100..125, + is_async: false, + items: [ + WithItem { + range: 106..114, + context_expr: Name( + ExprName { + range: 106..109, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 113..114, + id: Name("x"), + ctx: Store, + }, + ), + ), + }, + WithItem { + range: 116..119, + context_expr: Name( + ExprName { + range: 116..119, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: None, + }, + ], + body: [ + Expr( + StmtExpr { + range: 122..125, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 122..125, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | with (foo as x, bar as y): ... + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) +3 | with (foo, bar as y): ... +4 | with (foo as x, bar): ... + | + + + | +1 | # parse_options: {"target-version": "3.8"} +2 | with (foo as x, bar as y): ... +3 | with (foo, bar as y): ... + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) +4 | with (foo as x, bar): ... + | + + + | +2 | with (foo as x, bar as y): ... +3 | with (foo, bar as y): ... +4 | with (foo as x, bar): ... + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_kwarg_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_kwarg_py38.py.snap new file mode 100644 index 0000000000000..4b55ae1a8a6ff --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@parenthesized_kwarg_py38.py.snap @@ -0,0 +1,161 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/parenthesized_kwarg_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..77, + body: [ + Expr( + StmtExpr { + range: 43..51, + value: Call( + ExprCall { + range: 43..51, + func: Name( + ExprName { + range: 43..44, + id: Name("f"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 44..51, + args: [], + keywords: [ + Keyword { + range: 45..50, + arg: Some( + Identifier { + id: Name("a"), + range: 46..47, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 49..50, + value: Int( + 1, + ), + }, + ), + }, + ], + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 52..62, + value: Call( + ExprCall { + range: 52..62, + func: Name( + ExprName { + range: 52..53, + id: Name("f"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 53..62, + args: [], + keywords: [ + Keyword { + range: 54..61, + arg: Some( + Identifier { + id: Name("a"), + range: 55..56, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 60..61, + value: Int( + 1, + ), + }, + ), + }, + ], + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 63..76, + value: Call( + ExprCall { + range: 63..76, + func: Name( + ExprName { + range: 63..64, + id: Name("f"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 64..76, + args: [], + keywords: [ + Keyword { + range: 66..75, + arg: Some( + Identifier { + id: Name("a"), + range: 68..69, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 74..75, + value: Int( + 1, + ), + }, + ), + }, + ], + }, + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | f((a)=1) + | ^^^ Syntax Error: Cannot use parenthesized keyword argument name on Python 3.8 (syntax was removed in Python 3.8) +3 | f((a) = 1) +4 | f( ( a ) = 1) + | + + + | +1 | # parse_options: {"target-version": "3.8"} +2 | f((a)=1) +3 | f((a) = 1) + | ^^^ Syntax Error: Cannot use parenthesized keyword argument name on Python 3.8 (syntax was removed in Python 3.8) +4 | f( ( a ) = 1) + | + + + | +2 | f((a)=1) +3 | f((a) = 1) +4 | f( ( a ) = 1) + | ^^^^^ Syntax Error: Cannot use parenthesized keyword argument name on Python 3.8 (syntax was removed in Python 3.8) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pep701_f_string_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pep701_f_string_py311.py.snap new file mode 100644 index 0000000000000..5ac816ecc872b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pep701_f_string_py311.py.snap @@ -0,0 +1,929 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/pep701_f_string_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..549, + body: [ + Expr( + StmtExpr { + range: 44..74, + value: FString( + ExprFString { + range: 44..74, + value: FStringValue { + inner: Single( + FString( + FString { + range: 44..74, + elements: [ + Literal( + FStringLiteralElement { + range: 46..58, + value: "Magic wand: ", + }, + ), + Expression( + FStringExpressionElement { + range: 58..73, + expression: Subscript( + ExprSubscript { + range: 60..71, + value: Name( + ExprName { + range: 60..63, + id: Name("bag"), + ctx: Load, + }, + ), + slice: StringLiteral( + ExprStringLiteral { + range: 64..70, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 64..70, + value: "wand", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 95..112, + value: FString( + ExprFString { + range: 95..112, + value: FStringValue { + inner: Single( + FString( + FString { + range: 95..112, + elements: [ + Expression( + FStringExpressionElement { + range: 97..111, + expression: Call( + ExprCall { + range: 98..110, + func: Attribute( + ExprAttribute { + range: 98..107, + value: StringLiteral( + ExprStringLiteral { + range: 98..102, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 98..102, + value: "\n", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + attr: Identifier { + id: Name("join"), + range: 103..107, + }, + ctx: Load, + }, + ), + arguments: Arguments { + range: 107..110, + args: [ + Name( + ExprName { + range: 108..109, + id: Name("a"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 148..220, + value: FString( + ExprFString { + range: 148..220, + value: FStringValue { + inner: Single( + FString( + FString { + range: 148..220, + elements: [ + Literal( + FStringLiteralElement { + range: 152..169, + value: "A complex trick: ", + }, + ), + Expression( + FStringExpressionElement { + range: 169..217, + expression: Subscript( + ExprSubscript { + range: 175..185, + value: Name( + ExprName { + range: 175..178, + id: Name("bag"), + ctx: Load, + }, + ), + slice: StringLiteral( + ExprStringLiteral { + range: 179..184, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 179..184, + value: "bag", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 221..254, + value: FString( + ExprFString { + range: 221..254, + value: FStringValue { + inner: Single( + FString( + FString { + range: 221..254, + elements: [ + Expression( + FStringExpressionElement { + range: 223..253, + expression: FString( + ExprFString { + range: 224..252, + value: FStringValue { + inner: Single( + FString( + FString { + range: 224..252, + elements: [ + Expression( + FStringExpressionElement { + range: 226..251, + expression: FString( + ExprFString { + range: 227..250, + value: FStringValue { + inner: Single( + FString( + FString { + range: 227..250, + elements: [ + Expression( + FStringExpressionElement { + range: 229..249, + expression: FString( + ExprFString { + range: 230..248, + value: FStringValue { + inner: Single( + FString( + FString { + range: 230..248, + elements: [ + Expression( + FStringExpressionElement { + range: 232..247, + expression: FString( + ExprFString { + range: 233..246, + value: FStringValue { + inner: Single( + FString( + FString { + range: 233..246, + elements: [ + Expression( + FStringExpressionElement { + range: 235..245, + expression: FString( + ExprFString { + range: 236..244, + value: FStringValue { + inner: Single( + FString( + FString { + range: 236..244, + elements: [ + Expression( + FStringExpressionElement { + range: 238..243, + expression: BinOp( + ExprBinOp { + range: 239..242, + left: NumberLiteral( + ExprNumberLiteral { + range: 239..240, + value: Int( + 1, + ), + }, + ), + op: Add, + right: NumberLiteral( + ExprNumberLiteral { + range: 241..242, + value: Int( + 1, + ), + }, + ), + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 276..310, + value: FString( + ExprFString { + range: 276..310, + value: FStringValue { + inner: Single( + FString( + FString { + range: 276..310, + elements: [ + Expression( + FStringExpressionElement { + range: 278..303, + expression: FString( + ExprFString { + range: 279..302, + value: FStringValue { + inner: Single( + FString( + FString { + range: 279..302, + elements: [ + Expression( + FStringExpressionElement { + range: 283..293, + expression: StringLiteral( + ExprStringLiteral { + range: 284..292, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 284..292, + value: "nested", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 293..299, + value: " inner", + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 303..309, + value: " outer", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 336..359, + value: FString( + ExprFString { + range: 336..359, + value: FStringValue { + inner: Single( + FString( + FString { + range: 336..359, + elements: [ + Literal( + FStringLiteralElement { + range: 338..343, + value: "test ", + }, + ), + Expression( + FStringExpressionElement { + range: 343..353, + expression: Name( + ExprName { + range: 344..345, + id: Name("a"), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 353..358, + value: " more", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 403..422, + value: FString( + ExprFString { + range: 403..422, + value: FStringValue { + inner: Single( + FString( + FString { + range: 403..422, + elements: [ + Expression( + FStringExpressionElement { + range: 407..419, + expression: FString( + ExprFString { + range: 408..418, + value: FStringValue { + inner: Single( + FString( + FString { + range: 408..418, + elements: [ + Expression( + FStringExpressionElement { + range: 412..415, + expression: Name( + ExprName { + range: 413..414, + id: Name("x"), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 468..502, + value: FString( + ExprFString { + range: 468..502, + value: FStringValue { + inner: Single( + FString( + FString { + range: 468..502, + elements: [ + Expression( + FStringExpressionElement { + range: 470..501, + expression: Call( + ExprCall { + range: 471..500, + func: Attribute( + ExprAttribute { + range: 471..480, + value: StringLiteral( + ExprStringLiteral { + range: 471..475, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 471..475, + value: "\n", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + attr: Identifier { + id: Name("join"), + range: 476..480, + }, + ctx: Load, + }, + ), + arguments: Arguments { + range: 480..500, + args: [ + List( + ExprList { + range: 481..499, + elts: [ + StringLiteral( + ExprStringLiteral { + range: 482..486, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 482..486, + value: "\t", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 488..492, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 488..492, + value: "\u{b}", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 494..498, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 494..498, + value: "\r", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | f'Magic wand: { bag['wand'] }' # nested quotes + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +3 | f"{'\n'.join(a)}" # escape sequence +4 | f'''A complex trick: { + | + + + | +1 | # parse_options: {"target-version": "3.11"} +2 | f'Magic wand: { bag['wand'] }' # nested quotes +3 | f"{'\n'.join(a)}" # escape sequence + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) +4 | f'''A complex trick: { +5 | bag['bag'] # comment + | + + + | +3 | f"{'\n'.join(a)}" # escape sequence +4 | f'''A complex trick: { +5 | bag['bag'] # comment + | ^^^^^^^^^ Syntax Error: Cannot use comments in f-strings on Python 3.11 (syntax was added in Python 3.12) +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | + + + | +5 | bag['bag'] # comment +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +9 | f"test {a \ + | + + + | +5 | bag['bag'] # comment +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +9 | f"test {a \ + | + + + | +5 | bag['bag'] # comment +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +9 | f"test {a \ + | + + + | +5 | bag['bag'] # comment +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +9 | f"test {a \ + | + + + | +5 | bag['bag'] # comment +6 | }''' +7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes +9 | f"test {a \ + | + + + | + 6 | }''' + 7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + 8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes + | ^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) + 9 | f"test {a \ +10 | } more" # line continuation + | + + + | + 7 | f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" # arbitrary nesting + 8 | f"{f'''{"nested"} inner'''} outer" # nested (triple) quotes + 9 | f"test {a \ + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote + | + + + | + 9 | f"test {a \ +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote + | ^^^ Syntax Error: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) +12 | f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + | + + + | +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote +12 | f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) + | + + + | +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote +12 | f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) + | + + + | +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote +12 | f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) + | + + + | +10 | } more" # line continuation +11 | f"""{f"""{x}"""}""" # mark the whole triple quote +12 | f"{'\n'.join(['\t', '\v', '\r'])}" # multiple escape sequences, multiple errors + | ^ Syntax Error: Cannot use an escape sequence (backslash) in f-strings on Python 3.11 (syntax was added in Python 3.12) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pos_only_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pos_only_py37.py.snap new file mode 100644 index 0000000000000..adb8b30bc14dd --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@pos_only_py37.py.snap @@ -0,0 +1,291 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/pos_only_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..136, + body: [ + FunctionDef( + StmtFunctionDef { + range: 43..61, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 47..50, + }, + type_params: None, + parameters: Parameters { + range: 50..56, + posonlyargs: [ + ParameterWithDefault { + range: 51..52, + parameter: Parameter { + range: 51..52, + name: Identifier { + id: Name("a"), + range: 51..52, + }, + annotation: None, + }, + default: None, + }, + ], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 62..86, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 66..69, + }, + type_params: None, + parameters: Parameters { + range: 69..81, + posonlyargs: [ + ParameterWithDefault { + range: 70..71, + parameter: Parameter { + range: 70..71, + name: Identifier { + id: Name("a"), + range: 70..71, + }, + annotation: None, + }, + default: None, + }, + ], + args: [ + ParameterWithDefault { + range: 76..77, + parameter: Parameter { + range: 76..77, + name: Identifier { + id: Name("b"), + range: 76..77, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 83..86, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 83..86, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 87..115, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 91..94, + }, + type_params: None, + parameters: Parameters { + range: 94..110, + posonlyargs: [ + ParameterWithDefault { + range: 95..96, + parameter: Parameter { + range: 95..96, + name: Identifier { + id: Name("a"), + range: 95..96, + }, + annotation: None, + }, + default: None, + }, + ], + args: [], + vararg: Some( + Parameter { + range: 98..103, + name: Identifier { + id: Name("args"), + range: 99..103, + }, + annotation: None, + }, + ), + kwonlyargs: [ + ParameterWithDefault { + range: 108..109, + parameter: Parameter { + range: 108..109, + name: Identifier { + id: Name("b"), + range: 108..109, + }, + annotation: None, + }, + default: None, + }, + ], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 112..115, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 112..115, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 116..135, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 120..123, + }, + type_params: None, + parameters: Parameters { + range: 123..130, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 124..125, + parameter: Parameter { + range: 124..125, + name: Identifier { + id: Name("a"), + range: 124..125, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 132..135, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 132..135, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Errors + + | +1 | # parse_options: {"target-version": "3.7"} +2 | def foo(a, /): ... +3 | def foo(a, /, b, /): ... + | ^ Syntax Error: Only one '/' separator allowed +4 | def foo(a, *args, /, b): ... +5 | def foo(a, //): ... + | + + + | +2 | def foo(a, /): ... +3 | def foo(a, /, b, /): ... +4 | def foo(a, *args, /, b): ... + | ^ Syntax Error: '/' parameter must appear before '*' parameter +5 | def foo(a, //): ... + | + + + | +3 | def foo(a, /, b, /): ... +4 | def foo(a, *args, /, b): ... +5 | def foo(a, //): ... + | ^^ Syntax Error: Expected ',', found '//' + | + + +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.7"} +2 | def foo(a, /): ... + | ^ Syntax Error: Cannot use positional-only parameter separator on Python 3.7 (syntax was added in Python 3.8) +3 | def foo(a, /, b, /): ... +4 | def foo(a, *args, /, b): ... + | + + + | +1 | # parse_options: {"target-version": "3.7"} +2 | def foo(a, /): ... +3 | def foo(a, /, b, /): ... + | ^ Syntax Error: Cannot use positional-only parameter separator on Python 3.7 (syntax was added in Python 3.8) +4 | def foo(a, *args, /, b): ... +5 | def foo(a, //): ... + | + + + | +2 | def foo(a, /): ... +3 | def foo(a, /, b, /): ... +4 | def foo(a, *args, /, b): ... + | ^ Syntax Error: Cannot use positional-only parameter separator on Python 3.7 (syntax was added in Python 3.8) +5 | def foo(a, //): ... + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_from_without_exc.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_from_without_exc.py.snap new file mode 100644 index 0000000000000..bfd31fbf6dc4c --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_from_without_exc.py.snap @@ -0,0 +1,57 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/raise_stmt_from_without_exc.py +--- +## AST + +``` +Module( + ModModule { + range: 0..31, + body: [ + Raise( + StmtRaise { + range: 0..14, + exc: None, + cause: Some( + Name( + ExprName { + range: 11..14, + id: Name("exc"), + ctx: Load, + }, + ), + ), + }, + ), + Raise( + StmtRaise { + range: 15..30, + exc: None, + cause: Some( + NoneLiteral( + ExprNoneLiteral { + range: 26..30, + }, + ), + ), + }, + ), + ], + }, +) +``` +## Errors + + | +1 | raise from exc + | ^^^^ Syntax Error: Exception missing in `raise` statement with cause +2 | raise from None + | + + + | +1 | raise from exc +2 | raise from None + | ^^^^ Syntax Error: Exception missing in `raise` statement with cause + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_cause.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_cause.py.snap index 9791d1587c1ea..5d6d3eef90d22 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_cause.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_cause.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/raise_stmt_invalid_cause.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_exc.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_exc.py.snap index 1bc1f4ae38161..3bb6f03074036 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_exc.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_invalid_exc.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/raise_stmt_invalid_exc.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_cause.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_cause.py.snap index 812e245d45244..c000ffe470775 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_cause.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_cause.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/raise_stmt_unparenthesized_tuple_cause.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_exc.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_exc.py.snap index 529daca484bdb..a5bd41c66eb8c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_exc.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@raise_stmt_unparenthesized_tuple_exc.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/raise_stmt_unparenthesized_tuple_exc.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token.py.snap index 3fab1c73c4864..48dc7f7866b8d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token.py.snap @@ -707,8 +707,8 @@ Module( 13 | # There are multiple non-logical newlines (blank lines) in the `if` body 14 | if call(foo | ^ Syntax Error: Expected ')', found newline -15 | -16 | +15 | +16 | 17 | def bar(): | @@ -774,7 +774,7 @@ Module( | 49 | # F-strings uses normal list parsing, so test those as well 50 | if call(f"hello {x - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 51 | def bar(): 52 | pass | @@ -792,7 +792,7 @@ Module( | 49 | # F-strings uses normal list parsing, so test those as well 50 | if call(f"hello {x - | Syntax Error: Expected FStringEnd, found Unknown + | ^ Syntax Error: Expected FStringEnd, found Unknown 51 | def bar(): 52 | pass | @@ -834,5 +834,5 @@ Module( 55 | if call(f"hello 56 | def bar(): 57 | pass - | Syntax Error: Expected a statement + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_mac_eol.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_mac_eol.py.snap index ae531a84c9e80..e9879e5ba3305 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_mac_eol.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_mac_eol.py.snap @@ -100,5 +100,5 @@ Module( | 1 | if call(foo, [a, b def bar(): pass - | Syntax Error: Expected ']', found NonLogicalNewline + | ^ Syntax Error: Expected ']', found NonLogicalNewline | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_windows_eol.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_windows_eol.py.snap index a0bb006446740..31bb3a87f2044 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_windows_eol.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lex_logical_token_windows_eol.py.snap @@ -99,9 +99,8 @@ Module( ## Errors | -1 | if call(foo, [a, b - | ___________________^ -2 | | def bar(): - | |_^ Syntax Error: Expected ']', found NonLogicalNewline -3 | pass +1 | if call(foo, [a, b + | ^ Syntax Error: Expected ']', found NonLogicalNewline +2 | def bar(): +3 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__fstring_format_spec_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__fstring_format_spec_1.py.snap index 19a53beeb7c9d..dbc237b1d3ac0 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__fstring_format_spec_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__fstring_format_spec_1.py.snap @@ -300,7 +300,7 @@ Module( 5 | f'middle {'string':\ 6 | 'format spec'} | ^ Syntax Error: f-string: expecting '}' -7 | +7 | 8 | f'middle {'string':\\ | @@ -309,7 +309,7 @@ Module( 5 | f'middle {'string':\ 6 | 'format spec'} | ^^^^^^ Syntax Error: Simple statements must be separated by newlines or semicolons -7 | +7 | 8 | f'middle {'string':\\ | @@ -318,7 +318,7 @@ Module( 5 | f'middle {'string':\ 6 | 'format spec'} | ^^^^ Syntax Error: Simple statements must be separated by newlines or semicolons -7 | +7 | 8 | f'middle {'string':\\ | @@ -327,7 +327,7 @@ Module( 5 | f'middle {'string':\ 6 | 'format spec'} | ^^ Syntax Error: missing closing quote in string literal -7 | +7 | 8 | f'middle {'string':\\ | @@ -336,7 +336,7 @@ Module( 5 | f'middle {'string':\ 6 | 'format spec'} | ^ Syntax Error: Expected a statement -7 | +7 | 8 | f'middle {'string':\\ 9 | 'format spec'} | @@ -344,9 +344,9 @@ Module( | 6 | 'format spec'} -7 | +7 | 8 | f'middle {'string':\\ - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 9 | 'format spec'} | @@ -355,7 +355,7 @@ Module( 8 | f'middle {'string':\\ 9 | 'format spec'} | ^^^^^^^^ Syntax Error: Unexpected indentation -10 | +10 | 11 | f'middle {'string':\\\ | @@ -364,7 +364,7 @@ Module( 8 | f'middle {'string':\\ 9 | 'format spec'} | ^ Syntax Error: Expected a statement -10 | +10 | 11 | f'middle {'string':\\\ | @@ -373,7 +373,7 @@ Module( 8 | f'middle {'string':\\ 9 | 'format spec'} | ^ Syntax Error: Expected a statement -10 | +10 | 11 | f'middle {'string':\\\ 12 | 'format spec'} | @@ -381,9 +381,9 @@ Module( | 9 | 'format spec'} -10 | +10 | + | ^ Syntax Error: Expected a statement 11 | f'middle {'string':\\\ - | Syntax Error: Expected a statement 12 | 'format spec'} | @@ -419,5 +419,5 @@ Module( | 11 | f'middle {'string':\\\ 12 | 'format spec'} - | Syntax Error: Expected a statement + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_1.py.snap index c0853fa67c81b..abeaef0f131ae 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_1.py.snap @@ -83,7 +83,7 @@ Module( | 1 | call(a, b, \\\ | ^ Syntax Error: Expected a newline after line continuation character -2 | +2 | 3 | def bar(): | @@ -91,14 +91,14 @@ Module( | 1 | call(a, b, \\\ | ^ Syntax Error: Expected a newline after line continuation character -2 | +2 | 3 | def bar(): | | 1 | call(a, b, \\\ -2 | +2 | | ^ Syntax Error: Expected ')', found newline 3 | def bar(): 4 | pass diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_windows_eol.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_windows_eol.py.snap index 618e14d6131e7..935f436e821bd 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_windows_eol.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__line_continuation_windows_eol.py.snap @@ -81,10 +81,9 @@ Module( ## Errors | -1 | call(a, b, # comment \ - | _______________________^ -2 | | - | |_^ Syntax Error: Expected ')', found newline -3 | def bar(): -4 | pass +1 | call(a, b, # comment \ + | ^ Syntax Error: Expected ')', found newline +2 | +3 | def bar(): +4 | pass | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_1.py.snap index 92b3156f984c5..472a8579cc596 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_1.py.snap @@ -64,7 +64,7 @@ Module( | 3 | # https://github.com/astral-sh/ruff/issues/11929 -4 | +4 | 5 | f"""hello {x # comment | ___________________________^ 6 | | y = 1 @@ -81,7 +81,7 @@ Module( | 3 | # https://github.com/astral-sh/ruff/issues/11929 -4 | +4 | 5 | f"""hello {x # comment | ___________________________^ 6 | | y = 1 @@ -92,5 +92,5 @@ Module( | 5 | f"""hello {x # comment 6 | y = 1 - | Syntax Error: Expected a statement + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_2.py.snap index e41ff841620b0..ccf98eb430ac1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/re_lexing/triple_quoted_fstring_2.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_3.py.snap index 04335263b3c37..4e4ba407eeaa2 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@re_lexing__triple_quoted_fstring_3.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/re_lexing/triple_quoted_fstring_3.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@rebound_comprehension_variable.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@rebound_comprehension_variable.py.snap new file mode 100644 index 0000000000000..d4093c88394d3 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@rebound_comprehension_variable.py.snap @@ -0,0 +1,903 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/rebound_comprehension_variable.py +--- +## AST + +``` +Module( + ModModule { + range: 0..342, + body: [ + Expr( + StmtExpr { + range: 0..28, + value: ListComp( + ExprListComp { + range: 0..28, + elt: Named( + ExprNamed { + range: 2..8, + target: Name( + ExprName { + range: 2..3, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 7..8, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 10..27, + target: Name( + ExprName { + range: 14..15, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 19..27, + func: Name( + ExprName { + range: 19..24, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 24..27, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 25..26, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 29..57, + value: SetComp( + ExprSetComp { + range: 29..57, + elt: Named( + ExprNamed { + range: 31..37, + target: Name( + ExprName { + range: 31..32, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 36..37, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 39..56, + target: Name( + ExprName { + range: 43..44, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 48..56, + func: Name( + ExprName { + range: 48..53, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 53..56, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 58..91, + value: DictComp( + ExprDictComp { + range: 58..91, + key: Named( + ExprNamed { + range: 60..66, + target: Name( + ExprName { + range: 60..61, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 65..66, + value: Int( + 0, + ), + }, + ), + }, + ), + value: Name( + ExprName { + range: 69..72, + id: Name("val"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 73..90, + target: Name( + ExprName { + range: 77..78, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 82..90, + func: Name( + ExprName { + range: 82..87, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 87..90, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 88..89, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 92..125, + value: DictComp( + ExprDictComp { + range: 92..125, + key: Name( + ExprName { + range: 93..96, + id: Name("key"), + ctx: Load, + }, + ), + value: Named( + ExprNamed { + range: 99..105, + target: Name( + ExprName { + range: 99..100, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 104..105, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 107..124, + target: Name( + ExprName { + range: 111..112, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 116..124, + func: Name( + ExprName { + range: 116..121, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 121..124, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 122..123, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 126..154, + value: Generator( + ExprGenerator { + range: 126..154, + elt: Named( + ExprNamed { + range: 128..134, + target: Name( + ExprName { + range: 128..129, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 133..134, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 136..153, + target: Name( + ExprName { + range: 140..141, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 145..153, + func: Name( + ExprName { + range: 145..150, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 150..153, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 151..152, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: true, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 155..185, + value: ListComp( + ExprListComp { + range: 155..185, + elt: List( + ExprList { + range: 156..166, + elts: [ + Named( + ExprNamed { + range: 158..164, + target: Name( + ExprName { + range: 158..159, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 163..164, + value: Int( + 0, + ), + }, + ), + }, + ), + ], + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 167..184, + target: Name( + ExprName { + range: 171..172, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 176..184, + func: Name( + ExprName { + range: 176..181, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 181..184, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 182..183, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 186..233, + value: ListComp( + ExprListComp { + range: 186..233, + elt: Named( + ExprNamed { + range: 188..194, + target: Name( + ExprName { + range: 188..189, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 193..194, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 196..214, + target: Name( + ExprName { + range: 200..201, + id: Name("b"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 205..214, + func: Name( + ExprName { + range: 205..210, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 211..214, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 212..213, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + Comprehension { + range: 215..232, + target: Name( + ExprName { + range: 219..220, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 224..232, + func: Name( + ExprName { + range: 224..229, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 229..232, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 230..231, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 234..281, + value: ListComp( + ExprListComp { + range: 234..281, + elt: Named( + ExprNamed { + range: 236..242, + target: Name( + ExprName { + range: 236..237, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 241..242, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 244..262, + target: Name( + ExprName { + range: 248..249, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 253..262, + func: Name( + ExprName { + range: 253..258, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 259..262, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 260..261, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + Comprehension { + range: 263..280, + target: Name( + ExprName { + range: 267..268, + id: Name("b"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 272..280, + func: Name( + ExprName { + range: 272..277, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 277..280, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 278..279, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 282..341, + value: ListComp( + ExprListComp { + range: 282..341, + elt: Tuple( + ExprTuple { + range: 283..303, + elts: [ + Named( + ExprNamed { + range: 285..291, + target: Name( + ExprName { + range: 285..286, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 290..291, + value: Int( + 0, + ), + }, + ), + }, + ), + Named( + ExprNamed { + range: 295..301, + target: Name( + ExprName { + range: 295..296, + id: Name("b"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 300..301, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + generators: [ + Comprehension { + range: 304..322, + target: Name( + ExprName { + range: 308..309, + id: Name("a"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 313..322, + func: Name( + ExprName { + range: 313..318, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 319..322, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 320..321, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + Comprehension { + range: 323..340, + target: Name( + ExprName { + range: 327..328, + id: Name("b"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 332..340, + func: Name( + ExprName { + range: 332..337, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 337..340, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 338..339, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | [(a := 0) for a in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +2 | {(a := 0) for a in range(0)} +3 | {(a := 0): val for a in range(0)} + | + + + | +1 | [(a := 0) for a in range(0)] +2 | {(a := 0) for a in range(0)} + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +3 | {(a := 0): val for a in range(0)} +4 | {key: (a := 0) for a in range(0)} + | + + + | +1 | [(a := 0) for a in range(0)] +2 | {(a := 0) for a in range(0)} +3 | {(a := 0): val for a in range(0)} + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +4 | {key: (a := 0) for a in range(0)} +5 | ((a := 0) for a in range(0)) + | + + + | +2 | {(a := 0) for a in range(0)} +3 | {(a := 0): val for a in range(0)} +4 | {key: (a := 0) for a in range(0)} + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +5 | ((a := 0) for a in range(0)) +6 | [[(a := 0)] for a in range(0)] + | + + + | +3 | {(a := 0): val for a in range(0)} +4 | {key: (a := 0) for a in range(0)} +5 | ((a := 0) for a in range(0)) + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +6 | [[(a := 0)] for a in range(0)] +7 | [(a := 0) for b in range (0) for a in range(0)] + | + + + | +4 | {key: (a := 0) for a in range(0)} +5 | ((a := 0) for a in range(0)) +6 | [[(a := 0)] for a in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +7 | [(a := 0) for b in range (0) for a in range(0)] +8 | [(a := 0) for a in range (0) for b in range(0)] + | + + + | +5 | ((a := 0) for a in range(0)) +6 | [[(a := 0)] for a in range(0)] +7 | [(a := 0) for b in range (0) for a in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +8 | [(a := 0) for a in range (0) for b in range(0)] +9 | [((a := 0), (b := 1)) for a in range (0) for b in range(0)] + | + + + | +6 | [[(a := 0)] for a in range(0)] +7 | [(a := 0) for b in range (0) for a in range(0)] +8 | [(a := 0) for a in range (0) for b in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable +9 | [((a := 0), (b := 1)) for a in range (0) for b in range(0)] + | + + + | +7 | [(a := 0) for b in range (0) for a in range(0)] +8 | [(a := 0) for a in range (0) for b in range(0)] +9 | [((a := 0), (b := 1)) for a in range (0) for b in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable + | + + + | +7 | [(a := 0) for b in range (0) for a in range(0)] +8 | [(a := 0) for a in range (0) for b in range(0)] +9 | [((a := 0), (b := 1)) for a in range (0) for b in range(0)] + | ^ Syntax Error: assignment expression cannot rebind comprehension variable + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@return_stmt_invalid_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@return_stmt_invalid_expr.py.snap index 855ddd3692ed7..a6518b0d868c9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@return_stmt_invalid_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@return_stmt_invalid_expr.py.snap @@ -180,3 +180,21 @@ Module( 5 | return *x and y | ^^^^^^^ Syntax Error: Boolean expression cannot be used here | + + +## Semantic Syntax Errors + + | +1 | return * + | ^ Syntax Error: Starred expression cannot be used here +2 | return yield x +3 | return yield from x + | + + + | +3 | return yield from x +4 | return x := 1 +5 | return *x and y + | ^^^^^^^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line.py.snap index 9f142a7f3098f..b1abaaa51346d 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/simple_and_compound_stmt_on_same_line.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line_in_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line_in_block.py.snap index da202a0eee36c..2973bbb41cc84 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line_in_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_and_compound_stmt_on_same_line_in_block.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/simple_and_compound_stmt_on_same_line_in_block.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line.py.snap index 249e3eeaf2b7e..9bfaeb67a2f09 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/simple_stmts_on_same_line.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line_in_block.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line_in_block.py.snap index 36445719b498c..9f66a28749026 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line_in_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@simple_stmts_on_same_line_in_block.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/simple_stmts_on_same_line_in_block.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_for.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_for.py.snap new file mode 100644 index 0000000000000..a5699bbc2b90b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_for.py.snap @@ -0,0 +1,107 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/single_star_for.py +--- +## AST + +``` +Module( + ModModule { + range: 0..35, + body: [ + For( + StmtFor { + range: 0..16, + is_async: false, + target: Name( + ExprName { + range: 4..5, + id: Name("_"), + ctx: Store, + }, + ), + iter: Starred( + ExprStarred { + range: 9..11, + value: Name( + ExprName { + range: 10..11, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + body: [ + Expr( + StmtExpr { + range: 13..16, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 13..16, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 17..34, + is_async: false, + target: Starred( + ExprStarred { + range: 21..23, + value: Name( + ExprName { + range: 22..23, + id: Name("x"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + iter: Name( + ExprName { + range: 27..29, + id: Name("xs"), + ctx: Load, + }, + ), + body: [ + Expr( + StmtExpr { + range: 31..34, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 31..34, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | for _ in *x: ... + | ^^ Syntax Error: Starred expression cannot be used here +2 | for *x in xs: ... + | + + + | +1 | for _ in *x: ... +2 | for *x in xs: ... + | ^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_return.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_return.py.snap new file mode 100644 index 0000000000000..91feb561c855d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_return.py.snap @@ -0,0 +1,64 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/single_star_return.py +--- +## AST + +``` +Module( + ModModule { + range: 0..19, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..18, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 9..18, + value: Some( + Starred( + ExprStarred { + range: 16..18, + value: Name( + ExprName { + range: 17..18, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | def f(): return *x + | ^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_yield.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_yield.py.snap new file mode 100644 index 0000000000000..d89940beaa525 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_star_yield.py.snap @@ -0,0 +1,69 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/single_star_yield.py +--- +## AST + +``` +Module( + ModModule { + range: 0..18, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..17, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 9..17, + value: Yield( + ExprYield { + range: 9..17, + value: Some( + Starred( + ExprStarred { + range: 15..17, + value: Name( + ExprName { + range: 16..17, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | def f(): yield *x + | ^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_starred_assignment_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_starred_assignment_target.py.snap new file mode 100644 index 0000000000000..406d8532da4c7 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@single_starred_assignment_target.py.snap @@ -0,0 +1,58 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/single_starred_assignment_target.py +--- +## AST + +``` +Module( + ModModule { + range: 0..10, + body: [ + Assign( + StmtAssign { + range: 0..9, + targets: [ + Starred( + ExprStarred { + range: 0..2, + value: Name( + ExprName { + range: 1..2, + id: Name("a"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 5..9, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 6..7, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | *a = (1,) + | ^^ Syntax Error: starred assignment target must be in a list or tuple + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_index_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_index_py310.py.snap new file mode 100644 index 0000000000000..0f06b4ecff29e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_index_py310.py.snap @@ -0,0 +1,420 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/star_index_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..293, + body: [ + Expr( + StmtExpr { + range: 44..55, + value: Subscript( + ExprSubscript { + range: 44..55, + value: Name( + ExprName { + range: 44..47, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 48..54, + elts: [ + Starred( + ExprStarred { + range: 48..54, + value: Name( + ExprName { + range: 49..54, + id: Name("index"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + ClassDef( + StmtClassDef { + range: 72..112, + decorator_list: [], + name: Identifier { + id: Name("Array"), + range: 78..83, + }, + type_params: None, + arguments: Some( + Arguments { + range: 83..107, + args: [ + Subscript( + ExprSubscript { + range: 84..106, + value: Name( + ExprName { + range: 84..91, + id: Name("Generic"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 92..105, + elts: [ + Name( + ExprName { + range: 92..97, + id: Name("DType"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 99..105, + value: Name( + ExprName { + range: 100..105, + id: Name("Shape"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 109..112, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 109..112, + }, + ), + }, + ), + ], + }, + ), + Expr( + StmtExpr { + range: 148..161, + value: Subscript( + ExprSubscript { + range: 148..161, + value: Name( + ExprName { + range: 148..151, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 152..160, + elts: [ + Name( + ExprName { + range: 152..153, + id: Name("a"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 155..157, + value: Name( + ExprName { + range: 156..157, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Name( + ExprName { + range: 159..160, + id: Name("c"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 185..198, + value: Subscript( + ExprSubscript { + range: 185..198, + value: Name( + ExprName { + range: 185..188, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 189..197, + elts: [ + Name( + ExprName { + range: 189..190, + id: Name("a"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 192..193, + id: Name("b"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 195..197, + value: Name( + ExprName { + range: 196..197, + id: Name("c"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 222..233, + value: Subscript( + ExprSubscript { + range: 222..233, + value: Name( + ExprName { + range: 222..225, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 226..232, + elts: [ + Starred( + ExprStarred { + range: 226..228, + value: Name( + ExprName { + range: 227..228, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 230..232, + value: Name( + ExprName { + range: 231..232, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 254..271, + value: Subscript( + ExprSubscript { + range: 254..271, + value: Name( + ExprName { + range: 254..259, + id: Name("array"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 260..270, + elts: [ + Slice( + ExprSlice { + range: 260..263, + lower: Some( + NumberLiteral( + ExprNumberLiteral { + range: 260..261, + value: Int( + 3, + ), + }, + ), + ), + upper: Some( + NumberLiteral( + ExprNumberLiteral { + range: 262..263, + value: Int( + 5, + ), + }, + ), + ), + step: None, + }, + ), + Starred( + ExprStarred { + range: 265..270, + value: Name( + ExprName { + range: 266..270, + id: Name("idxs"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.10"} +2 | lst[*index] # simple index + | ^^^^^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +3 | class Array(Generic[DType, *Shape]): ... # motivating example from the PEP +4 | lst[a, *b, c] # different positions + | + + + | +1 | # parse_options: {"target-version": "3.10"} +2 | lst[*index] # simple index +3 | class Array(Generic[DType, *Shape]): ... # motivating example from the PEP + | ^^^^^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +4 | lst[a, *b, c] # different positions +5 | lst[a, b, *c] # different positions + | + + + | +2 | lst[*index] # simple index +3 | class Array(Generic[DType, *Shape]): ... # motivating example from the PEP +4 | lst[a, *b, c] # different positions + | ^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +5 | lst[a, b, *c] # different positions +6 | lst[*a, *b] # multiple unpacks + | + + + | +3 | class Array(Generic[DType, *Shape]): ... # motivating example from the PEP +4 | lst[a, *b, c] # different positions +5 | lst[a, b, *c] # different positions + | ^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +6 | lst[*a, *b] # multiple unpacks +7 | array[3:5, *idxs] # mixed with slices + | + + + | +4 | lst[a, *b, c] # different positions +5 | lst[a, b, *c] # different positions +6 | lst[*a, *b] # multiple unpacks + | ^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +7 | array[3:5, *idxs] # mixed with slices + | + + + | +4 | lst[a, *b, c] # different positions +5 | lst[a, b, *c] # different positions +6 | lst[*a, *b] # multiple unpacks + | ^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) +7 | array[3:5, *idxs] # mixed with slices + | + + + | +5 | lst[a, b, *c] # different positions +6 | lst[*a, *b] # multiple unpacks +7 | array[3:5, *idxs] # mixed with slices + | ^^^^^ Syntax Error: Cannot use star expression in index on Python 3.10 (syntax was added in Python 3.11) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_slices.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_slices.py.snap new file mode 100644 index 0000000000000..de033a8afe37b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@star_slices.py.snap @@ -0,0 +1,81 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/star_slices.py +--- +## AST + +``` +Module( + ModModule { + range: 0..19, + body: [ + Expr( + StmtExpr { + range: 0..18, + value: Subscript( + ExprSubscript { + range: 0..18, + value: Name( + ExprName { + range: 0..5, + id: Name("array"), + ctx: Load, + }, + ), + slice: Slice( + ExprSlice { + range: 6..17, + lower: Some( + Starred( + ExprStarred { + range: 6..12, + value: Name( + ExprName { + range: 7..12, + id: Name("start"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + upper: Some( + Starred( + ExprStarred { + range: 13..17, + value: Name( + ExprName { + range: 14..17, + id: Name("end"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + step: None, + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Errors + + | +1 | array[*start:*end] + | ^^^^^^ Syntax Error: Starred expression cannot be used here + | + + + | +1 | array[*start:*end] + | ^^^^ Syntax Error: Starred expression cannot be used here + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__function_type_parameters.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__function_type_parameters.py.snap index 74c0737192489..0c547eb7b4826 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__function_type_parameters.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__function_type_parameters.py.snap @@ -323,57 +323,57 @@ Module( | 9 | # on following lines. -10 | +10 | 11 | def keyword[A, await](): ... | ^^^^^ Syntax Error: Expected an identifier, but found a keyword 'await' that cannot be used here -12 | +12 | 13 | def not_a_type_param[A, |, B](): ... | | 11 | def keyword[A, await](): ... -12 | +12 | 13 | def not_a_type_param[A, |, B](): ... | ^ Syntax Error: Expected ',', found '|' -14 | +14 | 15 | def multiple_commas[A,,B](): ... | | 11 | def keyword[A, await](): ... -12 | +12 | 13 | def not_a_type_param[A, |, B](): ... | ^ Syntax Error: Expected a type parameter or the end of the type parameter list -14 | +14 | 15 | def multiple_commas[A,,B](): ... | | 13 | def not_a_type_param[A, |, B](): ... -14 | +14 | 15 | def multiple_commas[A,,B](): ... | ^ Syntax Error: Expected a type parameter or the end of the type parameter list -16 | +16 | 17 | def multiple_trailing_commas[A,,](): ... | | 15 | def multiple_commas[A,,B](): ... -16 | +16 | 17 | def multiple_trailing_commas[A,,](): ... | ^ Syntax Error: Expected a type parameter or the end of the type parameter list -18 | +18 | 19 | def multiple_commas_and_recovery[A,,100](): ... | | 17 | def multiple_trailing_commas[A,,](): ... -18 | +18 | 19 | def multiple_commas_and_recovery[A,,100](): ... | ^ Syntax Error: Expected a type parameter or the end of the type parameter list | @@ -381,7 +381,7 @@ Module( | 17 | def multiple_trailing_commas[A,,](): ... -18 | +18 | 19 | def multiple_commas_and_recovery[A,,100](): ... | ^^^ Syntax Error: Expected ']', found int | @@ -389,7 +389,7 @@ Module( | 17 | def multiple_trailing_commas[A,,](): ... -18 | +18 | 19 | def multiple_commas_and_recovery[A,,100](): ... | ^ Syntax Error: Expected newline, found ']' | @@ -397,7 +397,7 @@ Module( | 17 | def multiple_trailing_commas[A,,](): ... -18 | +18 | 19 | def multiple_commas_and_recovery[A,,100](): ... | ^^ Syntax Error: Only single target (not tuple) can be annotated | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_closing_parentheses.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_closing_parentheses.py.snap index 7170e28dbedb5..ea5649412f7d1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_closing_parentheses.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_closing_parentheses.py.snap @@ -76,4 +76,5 @@ Module( | 2 | if True)): 3 | pass + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_indent.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_indent.py.snap index b5aee39941586..76a3ff101f677 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_indent.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__if_extra_indent.py.snap @@ -91,14 +91,14 @@ Module( 3 | pass 4 | a + b | ^^^^^^^^ Syntax Error: Unexpected indentation -5 | +5 | 6 | pass | | 6 | pass -7 | +7 | + | ^ Syntax Error: Expected a statement 8 | a = 10 - | Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_assignment_targets.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_assignment_targets.py.snap index 93d999de17484..153ed4c2512d1 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_assignment_targets.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_assignment_targets.py.snap @@ -1382,30 +1382,30 @@ Module( | 3 | # rejected by the parser. e.g., `5 = 3`, `5 += 3`, `(5): int = 3`. -4 | +4 | 5 | 5 = 3 | ^ Syntax Error: Invalid assignment target -6 | +6 | 7 | 5 += 3 | | 5 | 5 = 3 -6 | +6 | 7 | 5 += 3 | ^ Syntax Error: Invalid augmented assignment target -8 | +8 | 9 | (5): int = 3 | | 7 | 5 += 3 - 8 | + 8 | 9 | (5): int = 3 | ^ Syntax Error: Invalid annotated assignment target -10 | +10 | 11 | # Now we exhaustively test all possible cases where assignment can fail. | @@ -1573,14 +1573,14 @@ Module( 27 | a < b < c = 42 28 | foo() = 42 | ^^^^^ Syntax Error: Invalid assignment target -29 | +29 | 30 | f"{quux}" = 42 | | 28 | foo() = 42 -29 | +29 | 30 | f"{quux}" = 42 | ^^^^^^^^^ Syntax Error: Invalid assignment target 31 | f"{foo} and {bar}" = 42 @@ -1591,14 +1591,14 @@ Module( 30 | f"{quux}" = 42 31 | f"{foo} and {bar}" = 42 | ^^^^^^^^^^^^^^^^^^ Syntax Error: Invalid assignment target -32 | +32 | 33 | "foo" = 42 | | 31 | f"{foo} and {bar}" = 42 -32 | +32 | 33 | "foo" = 42 | ^^^^^ Syntax Error: Invalid assignment target 34 | b"foo" = 42 @@ -1690,3 +1690,15 @@ Module( 42 | (x, foo(), y) = (42, 42, 42) | ^^^^^ Syntax Error: Invalid assignment target | + + +## Semantic Syntax Errors + + | +37 | None = 42 +38 | ... = 42 +39 | *foo() = 42 + | ^^^^^^ Syntax Error: starred assignment target must be in a list or tuple +40 | [x, foo(), y] = [42, 42, 42] +41 | [[a, b], [[42]], d] = [[1, 2], [[3]], 4] + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_augmented_assignment_target.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_augmented_assignment_target.py.snap index c2a5904fdd5d4..4fa30fed7b61a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_augmented_assignment_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__invalid_augmented_assignment_target.py.snap @@ -1277,7 +1277,7 @@ Module( | 2 | # assignment targets. -3 | +3 | 4 | x or y += 42 | ^^^^^^ Syntax Error: Invalid augmented assignment target 5 | (x := 5) += 42 @@ -1438,14 +1438,14 @@ Module( 19 | a < b < c += 42 20 | foo() += 42 | ^^^^^ Syntax Error: Invalid augmented assignment target -21 | +21 | 22 | f"{quux}" += 42 | | 20 | foo() += 42 -21 | +21 | 22 | f"{quux}" += 42 | ^^^^^^^^^ Syntax Error: Invalid augmented assignment target 23 | f"{foo} and {bar}" += 42 @@ -1456,14 +1456,14 @@ Module( 22 | f"{quux}" += 42 23 | f"{foo} and {bar}" += 42 | ^^^^^^^^^^^^^^^^^^ Syntax Error: Invalid augmented assignment target -24 | +24 | 25 | "foo" += 42 | | 23 | f"{foo} and {bar}" += 42 -24 | +24 | 25 | "foo" += 42 | ^^^^^ Syntax Error: Invalid augmented assignment target 26 | b"foo" += 42 diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_0.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_0.py.snap index dc4b2f014ac71..45f7c9abf7617 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_0.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_0.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/as_pattern_0.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_1.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_1.py.snap index 33420817cfa55..a2e2631cab94f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_1.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/as_pattern_1.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_2.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_2.py.snap index 876b3f9e0277b..1607c5185fb0f 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_2.py.snap @@ -123,4 +123,5 @@ Module( | 4 | case x as y + 1j: 5 | pass + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_3.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_3.py.snap index b85e698131648..cf7490e5fd2fb 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_3.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_3.py.snap @@ -151,4 +151,5 @@ Module( | 4 | case {(x as y): 1}: 5 | pass + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_4.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_4.py.snap index 8504acd1c44e9..a05914e033363 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_4.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__as_pattern_4.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/as_pattern_4.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_class_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_class_pattern.py.snap index 516051a1fd77e..9bbae6b7802b3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_class_pattern.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_class_pattern.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/invalid_class_pattern.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_lhs_or_rhs_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_lhs_or_rhs_pattern.py.snap index 36411e6e8a3a9..4ff98106389ff 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_lhs_or_rhs_pattern.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_lhs_or_rhs_pattern.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/invalid_lhs_or_rhs_pattern.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_mapping_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_mapping_pattern.py.snap index 9140a01656a08..dddbd65f4a589 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_mapping_pattern.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__invalid_mapping_pattern.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/invalid_mapping_pattern.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__star_pattern_usage.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__star_pattern_usage.py.snap index 229fca0ccdbe7..fa73b40cf644b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__star_pattern_usage.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__star_pattern_usage.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/star_pattern_usage.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__unary_add_usage.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__unary_add_usage.py.snap index 5aef2aa00c4c6..f4dfce5b70480 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__unary_add_usage.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__match__unary_add_usage.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/invalid/statements/match/unary_add_usage.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__ambiguous_lpar_with_items.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__ambiguous_lpar_with_items.py.snap index fc798e5a57a7a..e05f49c03b445 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__ambiguous_lpar_with_items.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__ambiguous_lpar_with_items.py.snap @@ -1361,7 +1361,7 @@ Module( | 2 | # These cases should raise the correct syntax error and recover properly. -3 | +3 | 4 | with (item1, item2),: ... | ^ Syntax Error: Trailing comma not allowed 5 | with (item1, item2), as f: ... @@ -1451,7 +1451,7 @@ Module( 11 | with (x for x in range(10), item): ... 12 | with (item, x for x in range(10)): ... | ^^^ Syntax Error: Expected ')', found 'for' -13 | +13 | 14 | # Make sure the parser doesn't report the same error twice | @@ -1461,7 +1461,7 @@ Module( 11 | with (x for x in range(10), item): ... 12 | with (item, x for x in range(10)): ... | ^ Syntax Error: Expected ':', found ')' -13 | +13 | 14 | # Make sure the parser doesn't report the same error twice | @@ -1471,7 +1471,7 @@ Module( 11 | with (x for x in range(10), item): ... 12 | with (item, x for x in range(10)): ... | ^ Syntax Error: Expected a statement -13 | +13 | 14 | # Make sure the parser doesn't report the same error twice | @@ -1480,14 +1480,14 @@ Module( 14 | # Make sure the parser doesn't report the same error twice 15 | with ((*item)): ... | ^^^^^ Syntax Error: Starred expression cannot be used here -16 | +16 | 17 | with (*x for x in iter, item): ... | | 15 | with ((*item)): ... -16 | +16 | 17 | with (*x for x in iter, item): ... | ^^ Syntax Error: Iterable unpacking cannot be used in a comprehension 18 | with (item1, *x for x in iter, item2): ... @@ -1497,7 +1497,7 @@ Module( | 15 | with ((*item)): ... -16 | +16 | 17 | with (*x for x in iter, item): ... | ^ Syntax Error: Expected ')', found ',' 18 | with (item1, *x for x in iter, item2): ... @@ -1507,7 +1507,7 @@ Module( | 15 | with ((*item)): ... -16 | +16 | 17 | with (*x for x in iter, item): ... | ^ Syntax Error: Expected ',', found ')' 18 | with (item1, *x for x in iter, item2): ... @@ -1606,7 +1606,7 @@ Module( 24 | with (x as f, y) as f: ... 25 | with (x for x in iter as y): ... | ^^ Syntax Error: Expected ')', found 'as' -26 | +26 | 27 | # The inner `(...)` is parsed as parenthesized expression | @@ -1616,7 +1616,7 @@ Module( 24 | with (x as f, y) as f: ... 25 | with (x for x in iter as y): ... | ^ Syntax Error: Expected ',', found ')' -26 | +26 | 27 | # The inner `(...)` is parsed as parenthesized expression | @@ -1625,7 +1625,7 @@ Module( 27 | # The inner `(...)` is parsed as parenthesized expression 28 | with ((item as f)): ... | ^^ Syntax Error: Expected ')', found 'as' -29 | +29 | 30 | with (item as f), x: ... | @@ -1634,7 +1634,7 @@ Module( 27 | # The inner `(...)` is parsed as parenthesized expression 28 | with ((item as f)): ... | ^ Syntax Error: Expected ':', found ')' -29 | +29 | 30 | with (item as f), x: ... | @@ -1643,14 +1643,14 @@ Module( 27 | # The inner `(...)` is parsed as parenthesized expression 28 | with ((item as f)): ... | ^ Syntax Error: Expected a statement -29 | +29 | 30 | with (item as f), x: ... | | 28 | with ((item as f)): ... -29 | +29 | 30 | with (item as f), x: ... | ^ Syntax Error: Expected ':', found ',' 31 | with (item as f1) as f2: ... diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__empty_with_items.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__empty_with_items.py.snap index 4020ae4c6f667..9d3a53afb0bca 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__empty_with_items.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__empty_with_items.py.snap @@ -61,9 +61,9 @@ Module( | 2 | # The parser should recover from this syntax error. -3 | +3 | 4 | with : ... | ^ Syntax Error: Expected the start of an expression after `with` keyword -5 | +5 | 6 | x + y | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar.py.snap index d57dd4fa5391c..e389ad74809d9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar.py.snap @@ -64,14 +64,14 @@ Module( | 1 | with (: | ^ Syntax Error: Expected an expression -2 | +2 | 3 | x + y | | 1 | with (: -2 | +2 | 3 | x + y - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar_eof.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar_eof.py.snap index d6bbc87fdf0ae..057cb44426006 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar_eof.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unclosed_ambiguous_lpar_eof.py.snap @@ -37,5 +37,5 @@ Module( | 1 | with ( - | Syntax Error: unexpected EOF while parsing + | ^ Syntax Error: unexpected EOF while parsing | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unparenthesized_with_items.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unparenthesized_with_items.py.snap index 49acdd3d36702..7182e64ab16f0 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unparenthesized_with_items.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@statements__with__unparenthesized_with_items.py.snap @@ -297,7 +297,7 @@ Module( | 1 | # For parenthesized with items test cases, refer to `./ambiguous_lpar_with_items.py` -2 | +2 | 3 | with item,: pass | ^ Syntax Error: Trailing comma not allowed 4 | with item as x,: pass diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_invalid_order.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_invalid_order.py.snap index 76f082556d5e8..f3525218f438c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_invalid_order.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_invalid_order.py.snap @@ -80,4 +80,5 @@ Module( | 5 | else: 6 | pass + | ^ Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_missing_except_finally.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_missing_except_finally.py.snap index 7ed96148484eb..df9779babddc4 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_missing_except_finally.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_missing_except_finally.py.snap @@ -66,4 +66,5 @@ Module( | 5 | else: 6 | pass + | ^ Syntax Error: Expected `except` or `finally` after `try` block | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_misspelled_except.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_misspelled_except.py.snap index 3e669c93b2458..93dc9f223d15a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_misspelled_except.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_misspelled_except.py.snap @@ -197,8 +197,8 @@ Module( | 3 | exept: # spellchecker:disable-line 4 | pass + | ^ Syntax Error: Expected a statement 5 | finally: - | Syntax Error: Expected a statement 6 | pass 7 | a = 1 | @@ -238,8 +238,8 @@ Module( | 5 | finally: 6 | pass + | ^ Syntax Error: Expected a statement 7 | a = 1 - | Syntax Error: Expected a statement 8 | try: 9 | pass | @@ -267,6 +267,6 @@ Module( | 12 | exept: # spellchecker:disable-line 13 | pass + | ^ Syntax Error: Expected a statement 14 | b = 1 - | Syntax Error: Expected a statement | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_mixed_except_kind.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_mixed_except_kind.py.snap new file mode 100644 index 0000000000000..0117d56216854 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@try_stmt_mixed_except_kind.py.snap @@ -0,0 +1,252 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/try_stmt_mixed_except_kind.py +--- +## AST + +``` +Module( + ModModule { + range: 0..242, + body: [ + Try( + StmtTry { + range: 0..63, + body: [ + Pass( + StmtPass { + range: 9..13, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 14..30, + type_: None, + name: None, + body: [ + Pass( + StmtPass { + range: 26..30, + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 31..63, + type_: Some( + Name( + ExprName { + range: 39..53, + id: Name("ExceptionGroup"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 59..63, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + Try( + StmtTry { + range: 64..127, + body: [ + Pass( + StmtPass { + range: 73..77, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 78..110, + type_: Some( + Name( + ExprName { + range: 86..100, + id: Name("ExceptionGroup"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 106..110, + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 111..127, + type_: None, + name: None, + body: [ + Pass( + StmtPass { + range: 123..127, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + Try( + StmtTry { + range: 128..241, + body: [ + Pass( + StmtPass { + range: 137..141, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 142..158, + type_: None, + name: None, + body: [ + Pass( + StmtPass { + range: 154..158, + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 159..175, + type_: None, + name: None, + body: [ + Pass( + StmtPass { + range: 171..175, + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 176..208, + type_: Some( + Name( + ExprName { + range: 184..198, + id: Name("ExceptionGroup"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 204..208, + }, + ), + ], + }, + ), + ExceptHandler( + ExceptHandlerExceptHandler { + range: 209..241, + type_: Some( + Name( + ExprName { + range: 217..231, + id: Name("ExceptionGroup"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 237..241, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + ], + }, +) +``` +## Errors + + | +3 | except: +4 | pass +5 | / except* ExceptionGroup: +6 | | pass + | |________^ Syntax Error: Cannot have both 'except' and 'except*' on the same 'try' +7 | try: +8 | pass + | + + + | + 9 | except* ExceptionGroup: +10 | pass +11 | / except: +12 | | pass + | |________^ Syntax Error: Cannot have both 'except' and 'except*' on the same 'try' +13 | try: +14 | pass + | + + + | +17 | except: +18 | pass +19 | / except* ExceptionGroup: +20 | | pass + | |________^ Syntax Error: Cannot have both 'except' and 'except*' on the same 'try' +21 | except* ExceptionGroup: +22 | pass + | + + + | +19 | except* ExceptionGroup: +20 | pass +21 | / except* ExceptionGroup: +22 | | pass + | |________^ Syntax Error: Cannot have both 'except' and 'except*' on the same 'try' + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@tuple_context_manager_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@tuple_context_manager_py38.py.snap new file mode 100644 index 0000000000000..4cb4a0a1bc59d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@tuple_context_manager_py38.py.snap @@ -0,0 +1,237 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/tuple_context_manager_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..327, + body: [ + With( + StmtWith { + range: 216..236, + is_async: false, + items: [ + WithItem { + range: 222..225, + context_expr: Name( + ExprName { + range: 222..225, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: None, + }, + WithItem { + range: 227..230, + context_expr: Name( + ExprName { + range: 227..230, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: None, + }, + ], + body: [ + Expr( + StmtExpr { + range: 233..236, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 233..236, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 237..274, + is_async: false, + items: [ + WithItem { + range: 242..269, + context_expr: Call( + ExprCall { + range: 246..261, + func: Name( + ExprName { + range: 246..250, + id: Name("open"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 250..261, + args: [ + StringLiteral( + ExprStringLiteral { + range: 251..260, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 251..260, + value: "foo.txt", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + keywords: [], + }, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 266..269, + id: Name("foo"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 271..274, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 271..274, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 275..309, + is_async: false, + items: [ + WithItem { + range: 284..287, + context_expr: Name( + ExprName { + range: 284..287, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: None, + }, + WithItem { + range: 291..294, + context_expr: Name( + ExprName { + range: 291..294, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: None, + }, + WithItem { + range: 298..301, + context_expr: Name( + ExprName { + range: 298..301, + id: Name("baz"), + ctx: Load, + }, + ), + optional_vars: None, + }, + ], + body: [ + Expr( + StmtExpr { + range: 306..309, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 306..309, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 310..326, + is_async: false, + items: [ + WithItem { + range: 316..319, + context_expr: Name( + ExprName { + range: 316..319, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: None, + }, + ], + body: [ + Expr( + StmtExpr { + range: 323..326, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 323..326, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +3 | # is parsed as a tuple, but this will always cause a runtime error, so we flag it +4 | # anyway +5 | with (foo, bar): ... + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) +6 | with ( +7 | open('foo.txt')) as foo: ... + | + + + | + 6 | with ( + 7 | open('foo.txt')) as foo: ... + 8 | with ( + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) + 9 | foo, +10 | bar, + | + + + | +11 | baz, +12 | ): ... +13 | with (foo,): ... + | ^ Syntax Error: Cannot use parentheses within a `with` statement on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_incomplete_stmt.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_incomplete_stmt.py.snap index 6d0087f3914ff..8878c1663a8b9 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_incomplete_stmt.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_incomplete_stmt.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_alias_incomplete_stmt.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_invalid_value_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_invalid_value_expr.py.snap index 18d1aa88e9a6b..3b1d5c40abd1c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_invalid_value_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_alias_invalid_value_expr.py.snap @@ -158,3 +158,23 @@ Module( 4 | type x = x := 1 | ^^ Syntax Error: Expected a statement | + + +## Semantic Syntax Errors + + | +1 | type x = *y +2 | type x = yield y + | ^^^^^^^ Syntax Error: yield expression cannot be used within a type alias +3 | type x = yield from y +4 | type x = x := 1 + | + + + | +1 | type x = *y +2 | type x = yield y +3 | type x = yield from y + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a type alias +4 | type x = x := 1 + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_default_py312.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_default_py312.py.snap new file mode 100644 index 0000000000000..68d3ff052490d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_default_py312.py.snap @@ -0,0 +1,302 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/type_param_default_py312.py +--- +## AST + +``` +Module( + ModModule { + range: 0..149, + body: [ + TypeAlias( + StmtTypeAlias { + range: 44..65, + name: Name( + ExprName { + range: 49..50, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 50..59, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 51..58, + name: Identifier { + id: Name("T"), + range: 51..52, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 55..58, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 62..65, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 66..87, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 70..71, + }, + type_params: Some( + TypeParams { + range: 71..80, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 72..79, + name: Identifier { + id: Name("T"), + range: 72..73, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 76..79, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 80..82, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 84..87, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 84..87, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 88..111, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 94..95, + }, + type_params: Some( + TypeParams { + range: 95..104, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 96..103, + name: Identifier { + id: Name("T"), + range: 96..97, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 100..103, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 104..106, + args: [], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 108..111, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 108..111, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 112..148, + decorator_list: [], + name: Identifier { + id: Name("D"), + range: 118..119, + }, + type_params: Some( + TypeParams { + range: 119..141, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 120..121, + name: Identifier { + id: Name("S"), + range: 120..121, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 123..130, + name: Identifier { + id: Name("T"), + range: 123..124, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 127..130, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + TypeVar( + TypeParamTypeVar { + range: 132..140, + name: Identifier { + id: Name("U"), + range: 132..133, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 136..140, + id: Name("uint"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 141..143, + args: [], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 145..148, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 145..148, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.12"} +2 | type X[T = int] = int + | ^^^^^ Syntax Error: Cannot set default type for a type parameter on Python 3.12 (syntax was added in Python 3.13) +3 | def f[T = int](): ... +4 | class C[T = int](): ... + | + + + | +1 | # parse_options: {"target-version": "3.12"} +2 | type X[T = int] = int +3 | def f[T = int](): ... + | ^^^^^ Syntax Error: Cannot set default type for a type parameter on Python 3.12 (syntax was added in Python 3.13) +4 | class C[T = int](): ... +5 | class D[S, T = int, U = uint](): ... + | + + + | +2 | type X[T = int] = int +3 | def f[T = int](): ... +4 | class C[T = int](): ... + | ^^^^^ Syntax Error: Cannot set default type for a type parameter on Python 3.12 (syntax was added in Python 3.13) +5 | class D[S, T = int, U = uint](): ... + | + + + | +3 | def f[T = int](): ... +4 | class C[T = int](): ... +5 | class D[S, T = int, U = uint](): ... + | ^^^^^ Syntax Error: Cannot set default type for a type parameter on Python 3.12 (syntax was added in Python 3.13) + | + + + | +3 | def f[T = int](): ... +4 | class C[T = int](): ... +5 | class D[S, T = int, U = uint](): ... + | ^^^^^^ Syntax Error: Cannot set default type for a type parameter on Python 3.12 (syntax was added in Python 3.13) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_invalid_bound_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_invalid_bound_expr.py.snap index 0189a0298a22c..6de003c4146fa 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_invalid_bound_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_invalid_bound_expr.py.snap @@ -256,3 +256,23 @@ Module( 4 | type X[T: x := int] = int | ^^ Syntax Error: Expected ',', found ':=' | + + +## Semantic Syntax Errors + + | +1 | type X[T: *int] = int +2 | type X[T: yield x] = int + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar bound +3 | type X[T: yield from x] = int +4 | type X[T: x := int] = int + | + + + | +1 | type X[T: *int] = int +2 | type X[T: yield x] = int +3 | type X[T: yield from x] = int + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar bound +4 | type X[T: x := int] = int + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_missing_bound.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_missing_bound.py.snap index a862c5c00fab0..0e9672fd1c34c 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_missing_bound.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_missing_bound.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_missing_bound.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_bound.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_bound.py.snap index 0a397668bfd26..79c0ae76890c3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_bound.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_bound.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_param_spec_bound.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_invalid_default_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_invalid_default_expr.py.snap index 2b72b38ec4852..757545ca6efca 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_invalid_default_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_invalid_default_expr.py.snap @@ -312,3 +312,24 @@ Module( 5 | type X[**P = *int] = int | ^^^^ Syntax Error: Starred expression cannot be used here | + + +## Semantic Syntax Errors + + | +1 | type X[**P = *int] = int +2 | type X[**P = yield x] = int + | ^^^^^^^ Syntax Error: yield expression cannot be used within a ParamSpec default +3 | type X[**P = yield from x] = int +4 | type X[**P = x := int] = int + | + + + | +1 | type X[**P = *int] = int +2 | type X[**P = yield x] = int +3 | type X[**P = yield from x] = int + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a ParamSpec default +4 | type X[**P = x := int] = int +5 | type X[**P = *int] = int + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_missing_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_missing_default.py.snap index 8f0e5d21d679f..8ed2eb4c05040 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_missing_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_param_spec_missing_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_param_spec_missing_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_invalid_default_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_invalid_default_expr.py.snap index cd92900925e73..9d93c799c78e4 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_invalid_default_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_invalid_default_expr.py.snap @@ -377,3 +377,34 @@ Module( 6 | type X[T: int = *int] = int | ^^^^ Syntax Error: Starred expression cannot be used here | + + +## Semantic Syntax Errors + + | +1 | type X[T = *int] = int +2 | type X[T = yield x] = int + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar default +3 | type X[T = (yield x)] = int +4 | type X[T = yield from x] = int + | + + + | +1 | type X[T = *int] = int +2 | type X[T = yield x] = int +3 | type X[T = (yield x)] = int + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar default +4 | type X[T = yield from x] = int +5 | type X[T = x := int] = int + | + + + | +2 | type X[T = yield x] = int +3 | type X[T = (yield x)] = int +4 | type X[T = yield from x] = int + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVar default +5 | type X[T = x := int] = int +6 | type X[T: int = *int] = int + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_missing_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_missing_default.py.snap index 520d99051313b..1547b5dd007f3 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_missing_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_missing_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_type_var_missing_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_bound.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_bound.py.snap index 7eef158c8eccb..3e6e16fa6f5de 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_bound.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_bound.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_type_var_tuple_bound.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_invalid_default_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_invalid_default_expr.py.snap index 93a91038fe881..61860a15efe40 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_invalid_default_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_invalid_default_expr.py.snap @@ -319,3 +319,24 @@ Module( 5 | type X[*Ts = x := int] = int | ^^ Syntax Error: Expected ',', found ':=' | + + +## Semantic Syntax Errors + + | +1 | type X[*Ts = *int] = int +2 | type X[*Ts = *int or str] = int +3 | type X[*Ts = yield x] = int + | ^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVarTuple default +4 | type X[*Ts = yield from x] = int +5 | type X[*Ts = x := int] = int + | + + + | +2 | type X[*Ts = *int or str] = int +3 | type X[*Ts = yield x] = int +4 | type X[*Ts = yield from x] = int + | ^^^^^^^^^^^^ Syntax Error: yield expression cannot be used within a TypeVarTuple default +5 | type X[*Ts = x := int] = int + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_missing_default.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_missing_default.py.snap index 289b8bb50c7c3..17303b668739a 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_missing_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_param_type_var_tuple_missing_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_param_type_var_tuple_missing_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_params_empty.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_params_empty.py.snap index 7bd405e6cb63c..fff0c28aa0033 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_params_empty.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_params_empty.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/type_params_empty.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_stmt_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_stmt_py311.py.snap new file mode 100644 index 0000000000000..dfb7a15121bce --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@type_stmt_py311.py.snap @@ -0,0 +1,42 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/type_stmt_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..57, + body: [ + TypeAlias( + StmtTypeAlias { + range: 44..56, + name: Name( + ExprName { + range: 49..50, + id: Name("x"), + ctx: Store, + }, + ), + type_params: None, + value: Name( + ExprName { + range: 53..56, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.11"} +2 | type x = int + | ^^^^ Syntax Error: Cannot use `type` alias statement on Python 3.11 (syntax was added in Python 3.12) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_index_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_index_py38.py.snap new file mode 100644 index 0000000000000..55d81b949d7cd --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_index_py38.py.snap @@ -0,0 +1,60 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_index_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..53, + body: [ + Expr( + StmtExpr { + range: 43..52, + value: Subscript( + ExprSubscript { + range: 43..52, + value: Name( + ExprName { + range: 43..46, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Named( + ExprNamed { + range: 47..51, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 50..51, + value: Int( + 1, + ), + }, + ), + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | lst[x:=1] + | ^^^^ Syntax Error: Cannot use unparenthesized assignment expression in a sequence index on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_comp_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_comp_py38.py.snap new file mode 100644 index 0000000000000..a608f55121787 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_comp_py38.py.snap @@ -0,0 +1,91 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_comp_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..73, + body: [ + Expr( + StmtExpr { + range: 43..72, + value: SetComp( + ExprSetComp { + range: 43..72, + elt: Named( + ExprNamed { + range: 44..53, + target: Name( + ExprName { + range: 44..48, + id: Name("last"), + ctx: Store, + }, + ), + value: Name( + ExprName { + range: 52..53, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + generators: [ + Comprehension { + range: 54..71, + target: Name( + ExprName { + range: 58..59, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 63..71, + func: Name( + ExprName { + range: 63..68, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 68..71, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 69..70, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | {last := x for x in range(3)} + | ^^^^^^^^^ Syntax Error: Cannot use unparenthesized assignment expression as an element in a set comprehension on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_literal_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_literal_py38.py.snap new file mode 100644 index 0000000000000..d03f0ebe48f06 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unparenthesized_named_expr_set_literal_py38.py.snap @@ -0,0 +1,185 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/unparenthesized_named_expr_set_literal_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..88, + body: [ + Expr( + StmtExpr { + range: 43..57, + value: Set( + ExprSet { + range: 43..57, + elts: [ + Named( + ExprNamed { + range: 44..50, + target: Name( + ExprName { + range: 44..45, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 49..50, + value: Int( + 1, + ), + }, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 52..53, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 55..56, + value: Int( + 3, + ), + }, + ), + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 58..72, + value: Set( + ExprSet { + range: 58..72, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 59..60, + value: Int( + 1, + ), + }, + ), + Named( + ExprNamed { + range: 62..68, + target: Name( + ExprName { + range: 62..63, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 67..68, + value: Int( + 2, + ), + }, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 70..71, + value: Int( + 3, + ), + }, + ), + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 73..87, + value: Set( + ExprSet { + range: 73..87, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 74..75, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 77..78, + value: Int( + 2, + ), + }, + ), + Named( + ExprNamed { + range: 80..86, + target: Name( + ExprName { + range: 80..81, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 85..86, + value: Int( + 3, + ), + }, + ), + }, + ), + ], + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: {"target-version": "3.8"} +2 | {x := 1, 2, 3} + | ^^^^^^ Syntax Error: Cannot use unparenthesized assignment expression as an element in a set literal on Python 3.8 (syntax was added in Python 3.9) +3 | {1, x := 2, 3} +4 | {1, 2, x := 3} + | + + + | +1 | # parse_options: {"target-version": "3.8"} +2 | {x := 1, 2, 3} +3 | {1, x := 2, 3} + | ^^^^^^ Syntax Error: Cannot use unparenthesized assignment expression as an element in a set literal on Python 3.8 (syntax was added in Python 3.9) +4 | {1, 2, x := 3} + | + + + | +2 | {x := 1, 2, 3} +3 | {1, x := 2, 3} +4 | {1, 2, x := 3} + | ^^^^^^ Syntax Error: Cannot use unparenthesized assignment expression as an element in a set literal on Python 3.8 (syntax was added in Python 3.9) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unterminated_fstring_newline_recovery.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unterminated_fstring_newline_recovery.py.snap index 671610d094cfe..c2c29483fd578 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unterminated_fstring_newline_recovery.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@unterminated_fstring_newline_recovery.py.snap @@ -315,7 +315,7 @@ Module( 1 | f"hello 2 | 1 + 1 3 | f"hello {x - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 4 | 2 + 2 5 | f"hello {x: | @@ -335,7 +335,7 @@ Module( 1 | f"hello 2 | 1 + 1 3 | f"hello {x - | Syntax Error: Expected FStringEnd, found Unknown + | ^ Syntax Error: Expected FStringEnd, found Unknown 4 | 2 + 2 5 | f"hello {x: | @@ -345,7 +345,7 @@ Module( 3 | f"hello {x 4 | 2 + 2 5 | f"hello {x: - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 6 | 3 + 3 7 | f"hello {x} | @@ -355,6 +355,6 @@ Module( 5 | f"hello {x: 6 | 3 + 3 7 | f"hello {x} - | Syntax Error: f-string: unterminated string + | ^ Syntax Error: f-string: unterminated string 8 | 4 + 4 | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@walrus_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@walrus_py37.py.snap new file mode 100644 index 0000000000000..402445a7f6d10 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@walrus_py37.py.snap @@ -0,0 +1,47 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/walrus_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..54, + body: [ + Expr( + StmtExpr { + range: 45..53, + value: Named( + ExprNamed { + range: 46..52, + target: Name( + ExprName { + range: 46..47, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ), + ], + }, +) +``` +## Unsupported Syntax Errors + + | +1 | # parse_options: { "target-version": "3.7" } +2 | (x := 1) + | ^^^^^^ Syntax Error: Cannot use named assignment expression (`:=`) on Python 3.7 (syntax was added in Python 3.8) + | diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_invalid_test_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_invalid_test_expr.py.snap index 0db4304449ad9..0e8d49ac7517b 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_invalid_test_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_invalid_test_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/while_stmt_invalid_test_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_colon.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_colon.py.snap index 4f0bdeffb3012..39dfbec62b919 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_colon.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_colon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/while_stmt_missing_colon.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_test.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_test.py.snap index 87534e7c81f72..59871538d36fc 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_test.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@while_stmt_missing_test.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/while_stmt_missing_test.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_colon.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_colon.py.snap index e7b496148997b..c73b00b2b3b0e 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_colon.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_colon.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/with_items_parenthesized_missing_colon.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_comma.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_comma.py.snap index 5fb688d6275b4..817874cdbed27 100644 --- a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_comma.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@with_items_parenthesized_missing_comma.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/err/with_items_parenthesized_missing_comma.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/invalid_syntax@write_to_debug_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@write_to_debug_expr.py.snap new file mode 100644 index 0000000000000..617675786f5c5 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/invalid_syntax@write_to_debug_expr.py.snap @@ -0,0 +1,205 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/err/write_to_debug_expr.py +--- +## AST + +``` +Module( + ModModule { + range: 0..83, + body: [ + Delete( + StmtDelete { + range: 0..13, + targets: [ + Name( + ExprName { + range: 4..13, + id: Name("__debug__"), + ctx: Del, + }, + ), + ], + }, + ), + Delete( + StmtDelete { + range: 14..36, + targets: [ + Name( + ExprName { + range: 18..19, + id: Name("x"), + ctx: Del, + }, + ), + Name( + ExprName { + range: 21..22, + id: Name("y"), + ctx: Del, + }, + ), + Name( + ExprName { + range: 24..33, + id: Name("__debug__"), + ctx: Del, + }, + ), + Name( + ExprName { + range: 35..36, + id: Name("z"), + ctx: Del, + }, + ), + ], + }, + ), + Assign( + StmtAssign { + range: 37..50, + targets: [ + Name( + ExprName { + range: 37..46, + id: Name("__debug__"), + ctx: Store, + }, + ), + ], + value: NumberLiteral( + ExprNumberLiteral { + range: 49..50, + value: Int( + 1, + ), + }, + ), + }, + ), + Assign( + StmtAssign { + range: 51..82, + targets: [ + Tuple( + ExprTuple { + range: 51..69, + elts: [ + Name( + ExprName { + range: 51..52, + id: Name("x"), + ctx: Store, + }, + ), + Name( + ExprName { + range: 54..55, + id: Name("y"), + ctx: Store, + }, + ), + Name( + ExprName { + range: 57..66, + id: Name("__debug__"), + ctx: Store, + }, + ), + Name( + ExprName { + range: 68..69, + id: Name("z"), + ctx: Store, + }, + ), + ], + ctx: Store, + parenthesized: false, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 72..82, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 72..73, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 75..76, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 78..79, + value: Int( + 3, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 81..82, + value: Int( + 4, + ), + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + }, + ), + ], + }, +) +``` +## Semantic Syntax Errors + + | +1 | del __debug__ + | ^^^^^^^^^ Syntax Error: cannot delete `__debug__` on Python 3.13 (syntax was removed in 3.9) +2 | del x, y, __debug__, z +3 | __debug__ = 1 + | + + + | +1 | del __debug__ +2 | del x, y, __debug__, z + | ^^^^^^^^^ Syntax Error: cannot delete `__debug__` on Python 3.13 (syntax was removed in 3.9) +3 | __debug__ = 1 +4 | x, y, __debug__, z = 1, 2, 3, 4 + | + + + | +1 | del __debug__ +2 | del x, y, __debug__, z +3 | __debug__ = 1 + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` +4 | x, y, __debug__, z = 1, 2, 3, 4 + | + + + | +2 | del x, y, __debug__, z +3 | __debug__ = 1 +4 | x, y, __debug__, z = 1, 2, 3, 4 + | ^^^^^^^^^ Syntax Error: cannot assign to `__debug__` + | diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@all_async_comprehension_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@all_async_comprehension_py310.py.snap new file mode 100644 index 0000000000000..85cb132698689 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@all_async_comprehension_py310.py.snap @@ -0,0 +1,141 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/all_async_comprehension_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..126, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..125, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("test"), + range: 54..58, + }, + type_params: None, + parameters: Parameters { + range: 58..60, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 62..125, + value: Some( + ListComp( + ExprListComp { + range: 69..125, + elt: ListComp( + ExprListComp { + range: 70..100, + elt: Name( + ExprName { + range: 71..72, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 73..99, + target: Name( + ExprName { + range: 83..84, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 88..99, + func: Name( + ExprName { + range: 88..96, + id: Name("elements"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 96..99, + args: [ + Name( + ExprName { + range: 97..98, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 101..124, + target: Name( + ExprName { + range: 111..112, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 116..124, + func: Name( + ExprName { + range: 116..121, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 121..124, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 122..123, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_binary_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_binary_expr.py.snap index 3f93607ce7a07..bfcd7c88d8e6f 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_binary_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_binary_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/ambiguous_lpar_with_items_binary_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_if_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_if_expr.py.snap index 97bf4a9334a69..22de70bfc86e4 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_if_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ambiguous_lpar_with_items_if_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/ambiguous_lpar_with_items_if_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ann_assign_stmt_simple_target.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ann_assign_stmt_simple_target.py.snap index ec8255148eca0..8dbc86f99307d 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@ann_assign_stmt_simple_target.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@ann_assign_stmt_simple_target.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/ann_assign_stmt_simple_target.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@args_unparenthesized_generator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@args_unparenthesized_generator.py.snap index 1be3f89dd1118..043e187b9df33 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@args_unparenthesized_generator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@args_unparenthesized_generator.py.snap @@ -7,60 +7,189 @@ input_file: crates/ruff_python_parser/resources/inline/ok/args_unparenthesized_g ``` Module( ModModule { - range: 0..26, + range: 0..107, body: [ Expr( StmtExpr { - range: 0..25, + range: 0..51, value: Call( ExprCall { - range: 0..25, + range: 0..51, func: Name( ExprName { range: 0..3, + id: Name("zip"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 3..51, + args: [ + Generator( + ExprGenerator { + range: 4..26, + elt: Name( + ExprName { + range: 5..6, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 7..25, + target: Name( + ExprName { + range: 11..12, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 16..25, + func: Name( + ExprName { + range: 16..21, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 21..25, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 22..24, + value: Int( + 10, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: true, + }, + ), + Generator( + ExprGenerator { + range: 28..50, + elt: Name( + ExprName { + range: 29..30, + id: Name("y"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 31..49, + target: Name( + ExprName { + range: 35..36, + id: Name("y"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 40..49, + func: Name( + ExprName { + range: 40..45, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 45..49, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 46..48, + value: Int( + 10, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: true, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 52..77, + value: Call( + ExprCall { + range: 52..77, + func: Name( + ExprName { + range: 52..55, id: Name("sum"), ctx: Load, }, ), arguments: Arguments { - range: 3..25, + range: 55..77, args: [ Generator( ExprGenerator { - range: 4..24, + range: 56..76, elt: Name( ExprName { - range: 4..5, + range: 56..57, id: Name("x"), ctx: Load, }, ), generators: [ Comprehension { - range: 6..24, + range: 58..76, target: Name( ExprName { - range: 10..11, + range: 62..63, id: Name("x"), ctx: Store, }, ), iter: Call( ExprCall { - range: 15..24, + range: 67..76, func: Name( ExprName { - range: 15..20, + range: 67..72, id: Name("range"), ctx: Load, }, ), arguments: Arguments { - range: 20..24, + range: 72..76, args: [ NumberLiteral( ExprNumberLiteral { - range: 21..23, + range: 73..75, value: Int( 10, ), @@ -85,6 +214,82 @@ Module( ), }, ), + Expr( + StmtExpr { + range: 78..106, + value: Call( + ExprCall { + range: 78..106, + func: Name( + ExprName { + range: 78..81, + id: Name("sum"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 81..106, + args: [ + Generator( + ExprGenerator { + range: 82..104, + elt: Name( + ExprName { + range: 83..84, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 85..103, + target: Name( + ExprName { + range: 89..90, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 94..103, + func: Name( + ExprName { + range: 94..99, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 99..103, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 100..102, + value: Int( + 10, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: true, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ), ], }, ) diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_stmt_starred_expr_value.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_stmt_starred_expr_value.py.snap new file mode 100644 index 0000000000000..5b5bf36875ed7 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_stmt_starred_expr_value.py.snap @@ -0,0 +1,157 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/assign_stmt_starred_expr_value.py +--- +## AST + +``` +Module( + ModModule { + range: 0..36, + body: [ + Assign( + StmtAssign { + range: 0..5, + targets: [ + Name( + ExprName { + range: 0..1, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: NumberLiteral( + ExprNumberLiteral { + range: 4..5, + value: Int( + 4, + ), + }, + ), + }, + ), + Assign( + StmtAssign { + range: 6..13, + targets: [ + Name( + ExprName { + range: 6..7, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: List( + ExprList { + range: 10..13, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 11..12, + value: Int( + 4, + ), + }, + ), + ], + ctx: Load, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 14..25, + targets: [ + Name( + ExprName { + range: 14..15, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 18..25, + elts: [ + Starred( + ExprStarred { + range: 19..23, + value: List( + ExprList { + range: 20..23, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 21..22, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 26..35, + targets: [ + Name( + ExprName { + range: 26..27, + id: Name("_"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 30..35, + elts: [ + Starred( + ExprStarred { + range: 30..34, + value: List( + ExprList { + range: 31..34, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 32..33, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_targets_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_targets_terminator.py.snap index d74795461d8f3..f188573e18146 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_targets_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@assign_targets_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/assign_targets_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_for_statement.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_for_statement.py.snap index 0a355ffeed733..dc8808567876c 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_for_statement.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_for_statement.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/async_for_statement.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_function_definition.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_function_definition.py.snap index e5e1e9a8eae58..1ec8e02a7c166 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_function_definition.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_function_definition.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/async_function_definition.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_with_statement.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_with_statement.py.snap index e1886955dd2f4..2e7e68961ee63 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_with_statement.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@async_with_statement.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/async_with_statement.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_def_arguments.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_def_arguments.py.snap index 32b37cdae5227..37e765799fed3 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_def_arguments.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_def_arguments.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/class_def_arguments.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_keyword_in_case_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_keyword_in_case_pattern.py.snap new file mode 100644 index 0000000000000..99fc05f67b6a3 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_keyword_in_case_pattern.py.snap @@ -0,0 +1,83 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/class_keyword_in_case_pattern.py +--- +## AST + +``` +Module( + ModModule { + range: 0..34, + body: [ + Match( + StmtMatch { + range: 0..33, + subject: NumberLiteral( + ExprNumberLiteral { + range: 6..7, + value: Int( + 2, + ), + }, + ), + cases: [ + MatchCase { + range: 13..33, + pattern: MatchClass( + PatternMatchClass { + range: 18..28, + cls: Name( + ExprName { + range: 18..23, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 23..28, + patterns: [], + keywords: [ + PatternKeyword { + range: 24..27, + attr: Identifier { + id: Name("x"), + range: 24..25, + }, + pattern: MatchAs( + PatternMatchAs { + range: 26..27, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 26..27, + }, + ), + }, + ), + }, + ], + }, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 30..33, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 30..33, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_type_params_py312.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_type_params_py312.py.snap new file mode 100644 index 0000000000000..8ca2d420378d4 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@class_type_params_py312.py.snap @@ -0,0 +1,119 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/class_type_params_py312.py +--- +## AST + +``` +Module( + ModModule { + range: 0..96, + body: [ + ClassDef( + StmtClassDef { + range: 44..95, + decorator_list: [], + name: Identifier { + id: Name("Foo"), + range: 50..53, + }, + type_params: Some( + TypeParams { + range: 53..90, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 54..69, + name: Identifier { + id: Name("S"), + range: 54..55, + }, + bound: Some( + Tuple( + ExprTuple { + range: 57..69, + elts: [ + Name( + ExprName { + range: 58..61, + id: Name("str"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 63..68, + id: Name("bytes"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 71..79, + name: Identifier { + id: Name("T"), + range: 71..72, + }, + bound: Some( + Name( + ExprName { + range: 74..79, + id: Name("float"), + ctx: Load, + }, + ), + ), + default: None, + }, + ), + TypeVarTuple( + TypeParamTypeVarTuple { + range: 81..84, + name: Identifier { + id: Name("Ts"), + range: 82..84, + }, + default: None, + }, + ), + ParamSpec( + TypeParamParamSpec { + range: 86..89, + name: Identifier { + id: Name("P"), + range: 88..89, + }, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 92..95, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 92..95, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@comma_separated_regular_list_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@comma_separated_regular_list_terminator.py.snap index 9561ce301b122..78f64ab6bdce9 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@comma_separated_regular_list_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@comma_separated_regular_list_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/comma_separated_regular_list_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@debug_rename_import.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@debug_rename_import.py.snap new file mode 100644 index 0000000000000..6289f59327824 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@debug_rename_import.py.snap @@ -0,0 +1,84 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/debug_rename_import.py +--- +## AST + +``` +Module( + ModModule { + range: 0..86, + body: [ + Import( + StmtImport { + range: 0..25, + names: [ + Alias { + range: 7..25, + name: Identifier { + id: Name("__debug__"), + range: 7..16, + }, + asname: Some( + Identifier { + id: Name("debug"), + range: 20..25, + }, + ), + }, + ], + }, + ), + ImportFrom( + StmtImportFrom { + range: 26..52, + module: Some( + Identifier { + id: Name("__debug__"), + range: 31..40, + }, + ), + names: [ + Alias { + range: 48..52, + name: Identifier { + id: Name("Some"), + range: 48..52, + }, + asname: None, + }, + ], + level: 0, + }, + ), + ImportFrom( + StmtImportFrom { + range: 53..85, + module: Some( + Identifier { + id: Name("x"), + range: 58..59, + }, + ), + names: [ + Alias { + range: 67..85, + name: Identifier { + id: Name("__debug__"), + range: 67..76, + }, + asname: Some( + Identifier { + id: Name("debug"), + range: 80..85, + }, + ), + }, + ], + level: 0, + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_async_function.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_async_function.py.snap index 7f9dac2758a4a..53f7aff8e8507 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_async_function.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_async_function.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/decorator_async_function.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_await_expression_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_await_expression_py39.py.snap new file mode 100644 index 0000000000000..20b6b6d6dfb47 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_await_expression_py39.py.snap @@ -0,0 +1,87 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/decorator_await_expression_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..96, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..95, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 55..58, + }, + type_params: None, + parameters: Parameters { + range: 58..60, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 66..95, + is_async: false, + decorator_list: [ + Decorator { + range: 66..76, + expression: Await( + ExprAwait { + range: 67..76, + value: Name( + ExprName { + range: 73..76, + id: Name("bar"), + ctx: Load, + }, + ), + }, + ), + }, + ], + name: Identifier { + id: Name("baz"), + range: 85..88, + }, + type_params: None, + parameters: Parameters { + range: 88..90, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 92..95, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 92..95, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_dotted_ident_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_dotted_ident_py38.py.snap new file mode 100644 index 0000000000000..c18f2aa994db4 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_dotted_ident_py38.py.snap @@ -0,0 +1,79 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/decorator_expression_dotted_ident_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..86, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..85, + is_async: false, + decorator_list: [ + Decorator { + range: 45..69, + expression: Attribute( + ExprAttribute { + range: 46..69, + value: Attribute( + ExprAttribute { + range: 46..61, + value: Name( + ExprName { + range: 46..53, + id: Name("buttons"), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("clicked"), + range: 54..61, + }, + ctx: Load, + }, + ), + attr: Identifier { + id: Name("connect"), + range: 62..69, + }, + ctx: Load, + }, + ), + }, + ], + name: Identifier { + id: Name("spam"), + range: 74..78, + }, + type_params: None, + parameters: Parameters { + range: 78..80, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 82..85, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 82..85, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_eval_hack_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_eval_hack_py38.py.snap new file mode 100644 index 0000000000000..ff8fce644ff08 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_eval_hack_py38.py.snap @@ -0,0 +1,88 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/decorator_expression_eval_hack_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..97, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..96, + is_async: false, + decorator_list: [ + Decorator { + range: 45..80, + expression: Call( + ExprCall { + range: 46..80, + func: Name( + ExprName { + range: 46..50, + id: Name("eval"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 50..80, + args: [ + StringLiteral( + ExprStringLiteral { + range: 51..79, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 51..79, + value: "buttons[0].clicked.connect", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ], + name: Identifier { + id: Name("spam"), + range: 85..89, + }, + type_params: None, + parameters: Parameters { + range: 89..91, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 93..96, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 93..96, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_identity_hack_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_identity_hack_py38.py.snap new file mode 100644 index 0000000000000..cedb9372d8c7d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_identity_hack_py38.py.snap @@ -0,0 +1,161 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/decorator_expression_identity_hack_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..111, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..63, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 49..50, + }, + type_params: None, + parameters: Parameters { + range: 50..53, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 51..52, + parameter: Parameter { + range: 51..52, + name: Identifier { + id: Name("x"), + range: 51..52, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 55..63, + value: Some( + Name( + ExprName { + range: 62..63, + id: Name("x"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 64..110, + is_async: false, + decorator_list: [ + Decorator { + range: 64..94, + expression: Call( + ExprCall { + range: 65..94, + func: Name( + ExprName { + range: 65..66, + id: Name("_"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 66..94, + args: [ + Attribute( + ExprAttribute { + range: 67..93, + value: Attribute( + ExprAttribute { + range: 67..85, + value: Subscript( + ExprSubscript { + range: 67..77, + value: Name( + ExprName { + range: 67..74, + id: Name("buttons"), + ctx: Load, + }, + ), + slice: NumberLiteral( + ExprNumberLiteral { + range: 75..76, + value: Int( + 0, + ), + }, + ), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("clicked"), + range: 78..85, + }, + ctx: Load, + }, + ), + attr: Identifier { + id: Name("connect"), + range: 86..93, + }, + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ], + name: Identifier { + id: Name("spam"), + range: 99..103, + }, + type_params: None, + parameters: Parameters { + range: 103..105, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 107..110, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 107..110, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_py39.py.snap new file mode 100644 index 0000000000000..50c0502003ea5 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@decorator_expression_py39.py.snap @@ -0,0 +1,195 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/decorator_expression_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..129, + body: [ + FunctionDef( + StmtFunctionDef { + range: 45..88, + is_async: false, + decorator_list: [ + Decorator { + range: 45..72, + expression: Attribute( + ExprAttribute { + range: 46..72, + value: Attribute( + ExprAttribute { + range: 46..64, + value: Subscript( + ExprSubscript { + range: 46..56, + value: Name( + ExprName { + range: 46..53, + id: Name("buttons"), + ctx: Load, + }, + ), + slice: NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 0, + ), + }, + ), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("clicked"), + range: 57..64, + }, + ctx: Load, + }, + ), + attr: Identifier { + id: Name("connect"), + range: 65..72, + }, + ctx: Load, + }, + ), + }, + ], + name: Identifier { + id: Name("spam"), + range: 77..81, + }, + type_params: None, + parameters: Parameters { + range: 81..83, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 85..88, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 85..88, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 89..128, + is_async: false, + decorator_list: [ + Decorator { + range: 89..113, + expression: Call( + ExprCall { + range: 90..113, + func: Named( + ExprNamed { + range: 91..107, + target: Name( + ExprName { + range: 91..92, + id: Name("x"), + ctx: Store, + }, + ), + value: Lambda( + ExprLambda { + range: 96..107, + parameters: Some( + Parameters { + range: 103..104, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 103..104, + parameter: Parameter { + range: 103..104, + name: Identifier { + id: Name("x"), + range: 103..104, + }, + annotation: None, + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + ), + body: Name( + ExprName { + range: 106..107, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + }, + ), + arguments: Arguments { + range: 108..113, + args: [ + Name( + ExprName { + range: 109..112, + id: Name("foo"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + }, + ], + name: Identifier { + id: Name("bar"), + range: 118..121, + }, + type_params: None, + parameters: Parameters { + range: 121..123, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 125..128, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 125..128, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_debug_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_debug_py38.py.snap new file mode 100644 index 0000000000000..1ba0db0c2d533 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_debug_py38.py.snap @@ -0,0 +1,29 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/del_debug_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..57, + body: [ + Delete( + StmtDelete { + range: 43..56, + targets: [ + Name( + ExprName { + range: 47..56, + id: Name("__debug__"), + ctx: Del, + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_targets_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_targets_terminator.py.snap index ee24dd07e7550..8c0830ab6e402 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_targets_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@del_targets_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/del_targets_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@dotted_name_normalized_spaces.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@dotted_name_normalized_spaces.py.snap index 356e3792857f1..2d63a9baf1433 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@dotted_name_normalized_spaces.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@dotted_name_normalized_spaces.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/dotted_name_normalized_spaces.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@duplicate_match_key_attr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@duplicate_match_key_attr.py.snap new file mode 100644 index 0000000000000..56b342c8b5eb2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@duplicate_match_key_attr.py.snap @@ -0,0 +1,115 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/duplicate_match_key_attr.py +--- +## AST + +``` +Module( + ModModule { + range: 0..40, + body: [ + Match( + StmtMatch { + range: 0..39, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..39, + pattern: MatchMapping( + PatternMatchMapping { + range: 18..34, + keys: [ + Attribute( + ExprAttribute { + range: 19..22, + value: Name( + ExprName { + range: 19..20, + id: Name("x"), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("a"), + range: 21..22, + }, + ctx: Load, + }, + ), + Attribute( + ExprAttribute { + range: 27..30, + value: Name( + ExprName { + range: 27..28, + id: Name("x"), + ctx: Load, + }, + ), + attr: Identifier { + id: Name("a"), + range: 29..30, + }, + ctx: Load, + }, + ), + ], + patterns: [ + MatchValue( + PatternMatchValue { + range: 24..25, + value: NumberLiteral( + ExprNumberLiteral { + range: 24..25, + value: Int( + 1, + ), + }, + ), + }, + ), + MatchValue( + PatternMatchValue { + range: 32..33, + value: NumberLiteral( + ExprNumberLiteral { + range: 32..33, + value: Int( + 2, + ), + }, + ), + }, + ), + ], + rest: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 36..39, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 36..39, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_star_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_star_py311.py.snap new file mode 100644 index 0000000000000..f0a6018f84d55 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_star_py311.py.snap @@ -0,0 +1,64 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/except_star_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..77, + body: [ + Try( + StmtTry { + range: 44..76, + body: [ + Expr( + StmtExpr { + range: 49..52, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 49..52, + }, + ), + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 53..76, + type_: Some( + Name( + ExprName { + range: 61..71, + id: Name("ValueError"), + ctx: Load, + }, + ), + ), + name: None, + body: [ + Expr( + StmtExpr { + range: 73..76, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 73..76, + }, + ), + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_as_name_soft_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_as_name_soft_keyword.py.snap index f94b60ff29646..c27aa0a2e9139 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_as_name_soft_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_as_name_soft_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/except_stmt_as_name_soft_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_unparenthesized_tuple_no_as_py314.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_unparenthesized_tuple_no_as_py314.py.snap new file mode 100644 index 0000000000000..044e166fa61e4 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@except_stmt_unparenthesized_tuple_no_as_py314.py.snap @@ -0,0 +1,125 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/except_stmt_unparenthesized_tuple_no_as_py314.py +--- +## AST + +``` +Module( + ModModule { + range: 0..117, + body: [ + Try( + StmtTry { + range: 44..79, + body: [ + Pass( + StmtPass { + range: 53..57, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 58..79, + type_: Some( + Tuple( + ExprTuple { + range: 65..69, + elts: [ + Name( + ExprName { + range: 65..66, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 68..69, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 75..79, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: false, + }, + ), + Try( + StmtTry { + range: 80..116, + body: [ + Pass( + StmtPass { + range: 89..93, + }, + ), + ], + handlers: [ + ExceptHandler( + ExceptHandlerExceptHandler { + range: 94..116, + type_: Some( + Tuple( + ExprTuple { + range: 102..106, + elts: [ + Name( + ExprName { + range: 102..103, + id: Name("x"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 105..106, + id: Name("y"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + name: None, + body: [ + Pass( + StmtPass { + range: 112..116, + }, + ), + ], + }, + ), + ], + orelse: [], + finalbody: [], + is_star: true, + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__arguments.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__arguments.py.snap index be722844ec285..a7b3283c41e66 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__arguments.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__arguments.py.snap @@ -1158,7 +1158,7 @@ Module( target: Name( ExprName { range: 562..563, - id: Name("x"), + id: Name("i"), ctx: Store, }, ), diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__attribute.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__attribute.py.snap index 18528873b51ec..2a37d0a8a9da0 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__attribute.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__attribute.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/attribute.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__await.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__await.py.snap index 89a451aebba6e..e5351ffe1e94e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__await.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__await.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/await.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__bool_op.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__bool_op.py.snap index d1cc881f7fa23..53f4b05b7a1cc 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__bool_op.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__bool_op.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/bool_op.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__call.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__call.py.snap index b65a20feb6971..a83f3774421b0 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__call.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__call.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/call.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__compare.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__compare.py.snap index abdf83ff7f0c3..ec86643e38054 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__compare.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__compare.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/compare.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary.py.snap index 6a3ec4f15217f..705faf5d2c801 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/dictionary.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary_comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary_comprehension.py.snap index 6cda239001f00..ea7d3324bc499 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary_comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__dictionary_comprehension.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/dictionary_comprehension.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__f_string.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__f_string.py.snap index 011f027e163ca..2fe8ea2855641 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__f_string.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__f_string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/f_string.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__generator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__generator.py.snap index b40fccc33aca3..d93aef523add5 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__generator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__generator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/generator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__if.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__if.py.snap index 6bbdd72b0ab5e..5cca4b3a1bac3 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__if.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__if.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/if.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__lambda.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__lambda.py.snap index 75ce5de1a7aeb..a21cc82b8a316 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__lambda.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__lambda.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/lambda.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list.py.snap index 82745bd5d6b76..ae3fc6d22cbfd 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/list.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list_comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list_comprehension.py.snap index 8d4bd9f912742..b81ae4169e2b1 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list_comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__list_comprehension.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/list_comprehension.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__name.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__name.py.snap index cb22e7e03cfe2..dd9d18e848b94 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__name.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__name.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/name.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__named.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__named.py.snap index 1a8216e067977..098a337277648 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__named.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__named.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/named.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__number_literal.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__number_literal.py.snap index e5527f4a6d035..64d1e63f40b2e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__number_literal.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__number_literal.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/number_literal.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__parenthesized.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__parenthesized.py.snap index 82afb5a34ca12..f5a6858f1d4d7 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__parenthesized.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__parenthesized.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/parenthesized.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set.py.snap index cff618b029407..f8ed36c227da7 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/set.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set_comprehension.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set_comprehension.py.snap index 306eb2d153c82..5365de4ac2dfe 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set_comprehension.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__set_comprehension.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/set_comprehension.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__slice.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__slice.py.snap index a282c8d2a65a6..2f33310702852 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__slice.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__slice.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/slice.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__starred.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__starred.py.snap index 4cb6dab7b77df..3d1f786a8c23f 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__starred.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__starred.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/starred.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__string.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__string.py.snap index 85db63784d707..6cddb0139928a 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__string.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__string.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/string.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__subscript.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__subscript.py.snap index 23929c13facf3..23d49419b20da 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__subscript.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__subscript.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/subscript.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__tuple.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__tuple.py.snap index 5b1045b1961a8..e8a88a1b9da76 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__tuple.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__tuple.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/tuple.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__unary_op.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__unary_op.py.snap index 32622f70b8045..6e164b817fcf3 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__unary_op.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__unary_op.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/unary_op.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield.py.snap index dc9d2aa3ca062..063373e6a3da3 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/valid/expressions/yield.py ``` Module( ModModule { - range: 0..188, + range: 0..166, body: [ Expr( StmtExpr { @@ -384,53 +384,28 @@ Module( ), Expr( StmtExpr { - range: 144..152, + range: 144..155, value: Yield( ExprYield { - range: 144..152, - value: Some( - Starred( - ExprStarred { - range: 150..152, - value: Name( - ExprName { - range: 151..152, - id: Name("y"), - ctx: Load, - }, - ), - ctx: Load, - }, - ), - ), - }, - ), - }, - ), - Expr( - StmtExpr { - range: 153..164, - value: Yield( - ExprYield { - range: 153..164, + range: 144..155, value: Some( Tuple( ExprTuple { - range: 159..164, + range: 150..155, elts: [ Name( ExprName { - range: 159..160, + range: 150..151, id: Name("x"), ctx: Load, }, ), Starred( ExprStarred { - range: 162..164, + range: 153..155, value: Name( ExprName { - range: 163..164, + range: 154..155, id: Name("y"), ctx: Load, }, @@ -450,21 +425,21 @@ Module( ), Expr( StmtExpr { - range: 165..174, + range: 156..165, value: Yield( ExprYield { - range: 165..174, + range: 156..165, value: Some( Tuple( ExprTuple { - range: 171..174, + range: 162..165, elts: [ Starred( ExprStarred { - range: 171..173, + range: 162..164, value: Name( ExprName { - range: 172..173, + range: 163..164, id: Name("x"), ctx: Load, }, @@ -482,44 +457,6 @@ Module( ), }, ), - Expr( - StmtExpr { - range: 175..187, - value: Yield( - ExprYield { - range: 175..187, - value: Some( - Starred( - ExprStarred { - range: 181..187, - value: BinOp( - ExprBinOp { - range: 182..187, - left: Name( - ExprName { - range: 182..183, - id: Name("x"), - ctx: Load, - }, - ), - op: BitOr, - right: Name( - ExprName { - range: 186..187, - id: Name("y"), - ctx: Load, - }, - ), - }, - ), - ctx: Load, - }, - ), - ), - }, - ), - }, - ), ], }, ) diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield_from.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield_from.py.snap index 7bbc2b19c577a..d35161d5fce1b 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield_from.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@expressions__yield_from.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/expressions/yield_from.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_in_target_valid_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_in_target_valid_expr.py.snap index 96cbefeb69350..82261413967ea 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_in_target_valid_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_in_target_valid_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/for_in_target_valid_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py38.py.snap new file mode 100644 index 0000000000000..892b22f86a3a1 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py38.py.snap @@ -0,0 +1,186 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..112, + body: [ + For( + StmtFor { + range: 43..65, + is_async: false, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 52..60, + elts: [ + Starred( + ExprStarred { + range: 53..55, + value: Name( + ExprName { + range: 54..55, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Name( + ExprName { + range: 58..59, + id: Name("b"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + body: [ + Expr( + StmtExpr { + range: 62..65, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 62..65, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 66..88, + is_async: false, + target: Name( + ExprName { + range: 70..71, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 75..83, + elts: [ + Name( + ExprName { + range: 77..78, + id: Name("a"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 80..82, + value: Name( + ExprName { + range: 81..82, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + body: [ + Expr( + StmtExpr { + range: 85..88, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 85..88, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 89..111, + is_async: false, + target: Name( + ExprName { + range: 93..94, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 98..106, + elts: [ + Starred( + ExprStarred { + range: 99..101, + value: Name( + ExprName { + range: 100..101, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 103..105, + value: Name( + ExprName { + range: 104..105, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + body: [ + Expr( + StmtExpr { + range: 108..111, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 108..111, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py39.py.snap new file mode 100644 index 0000000000000..ac67500fd781a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@for_iter_unpack_py39.py.snap @@ -0,0 +1,186 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/for_iter_unpack_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..106, + body: [ + For( + StmtFor { + range: 43..63, + is_async: false, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 52..58, + elts: [ + Starred( + ExprStarred { + range: 52..54, + value: Name( + ExprName { + range: 53..54, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Name( + ExprName { + range: 57..58, + id: Name("b"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 60..63, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 60..63, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 64..84, + is_async: false, + target: Name( + ExprName { + range: 68..69, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 74..79, + elts: [ + Name( + ExprName { + range: 74..75, + id: Name("a"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 77..79, + value: Name( + ExprName { + range: 78..79, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 81..84, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 81..84, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 85..105, + is_async: false, + target: Name( + ExprName { + range: 89..90, + id: Name("x"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 94..100, + elts: [ + Starred( + ExprStarred { + range: 94..96, + value: Name( + ExprName { + range: 95..96, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 98..100, + value: Name( + ExprName { + range: 99..100, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + body: [ + Expr( + StmtExpr { + range: 102..105, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 102..105, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_no_space.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_no_space.py.snap index f0ec9ce11206a..52b37be22a3f1 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_no_space.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_no_space.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/from_import_no_space.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_soft_keyword_module_name.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_soft_keyword_module_name.py.snap index f4926008389c8..9b5dde8170a24 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_soft_keyword_module_name.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_soft_keyword_module_name.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/from_import_soft_keyword_module_name.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_stmt_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_stmt_terminator.py.snap index bb3a49d76895d..ec6c1d92dc39a 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_stmt_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@from_import_stmt_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/from_import_stmt_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@fstring_format_spec_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@fstring_format_spec_terminator.py.snap index 754e602e6fc3d..1e672a1ce1945 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@fstring_format_spec_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@fstring_format_spec_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/fstring_format_spec_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parameter_range.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parameter_range.py.snap index 1aac8eadc4970..17d571227aed7 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parameter_range.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parameter_range.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/function_def_parameter_range.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parenthesized_return_types.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parenthesized_return_types.py.snap index 1a2e627a0a9cb..7076142333c7d 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parenthesized_return_types.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_parenthesized_return_types.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/function_def_parenthesized_return_types.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_valid_return_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_valid_return_expr.py.snap index 4bc923b6ac106..f4bd699f74239 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_valid_return_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_def_valid_return_expr.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/inline/ok/function_def_valid_ret ``` Module( ModModule { - range: 0..125, + range: 0..97, body: [ FunctionDef( StmtFunctionDef { @@ -134,7 +134,7 @@ Module( ), FunctionDef( StmtFunctionDef { - range: 58..85, + range: 58..96, is_async: false, decorator_list: [], name: Identifier { @@ -150,74 +150,26 @@ Module( kwonlyargs: [], kwarg: None, }, - returns: Some( - Yield( - ExprYield { - range: 72..79, - value: Some( - Name( - ExprName { - range: 78..79, - id: Name("x"), - ctx: Load, - }, - ), - ), - }, - ), - ), - body: [ - Expr( - StmtExpr { - range: 82..85, - value: EllipsisLiteral( - ExprEllipsisLiteral { - range: 82..85, - }, - ), - }, - ), - ], - }, - ), - FunctionDef( - StmtFunctionDef { - range: 86..124, - is_async: false, - decorator_list: [], - name: Identifier { - id: Name("foo"), - range: 90..93, - }, - type_params: None, - parameters: Parameters { - range: 93..95, - posonlyargs: [], - args: [], - vararg: None, - kwonlyargs: [], - kwarg: None, - }, returns: Some( If( ExprIf { - range: 99..119, + range: 71..91, test: BooleanLiteral( ExprBooleanLiteral { - range: 106..110, + range: 78..82, value: true, }, ), body: Name( ExprName { - range: 99..102, + range: 71..74, id: Name("int"), ctx: Load, }, ), orelse: Name( ExprName { - range: 116..119, + range: 88..91, id: Name("str"), ctx: Load, }, @@ -228,10 +180,10 @@ Module( body: [ Expr( StmtExpr { - range: 121..124, + range: 93..96, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 121..124, + range: 93..96, }, ), }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_type_params_py312.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_type_params_py312.py.snap new file mode 100644 index 0000000000000..ed6c0528a6835 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@function_type_params_py312.py.snap @@ -0,0 +1,65 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/function_type_params_py312.py +--- +## AST + +``` +Module( + ModModule { + range: 0..62, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..61, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 48..51, + }, + type_params: Some( + TypeParams { + range: 51..54, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 52..53, + name: Identifier { + id: Name("T"), + range: 52..53, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 54..56, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@global_stmt.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@global_stmt.py.snap index e7710f07b7688..24c5d44be2c4b 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@global_stmt.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@global_stmt.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/global_stmt.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_as_name_soft_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_as_name_soft_keyword.py.snap index 782ca0132f9bc..f5e2f2da77c85 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_as_name_soft_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_as_name_soft_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/import_as_name_soft_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_stmt_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_stmt_terminator.py.snap index d29e3330c7da2..0d1775d267d0d 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_stmt_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@import_stmt_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/import_stmt_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@irrefutable_case_pattern_at_end.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@irrefutable_case_pattern_at_end.py.snap new file mode 100644 index 0000000000000..0d818e98ea794 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@irrefutable_case_pattern_at_end.py.snap @@ -0,0 +1,230 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/irrefutable_case_pattern_at_end.py +--- +## AST + +``` +Module( + ModModule { + range: 0..176, + body: [ + Match( + StmtMatch { + range: 0..42, + subject: Name( + ExprName { + range: 6..7, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 13..24, + pattern: MatchValue( + PatternMatchValue { + range: 18..19, + value: NumberLiteral( + ExprNumberLiteral { + range: 18..19, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 21..24, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 21..24, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 29..42, + pattern: MatchAs( + PatternMatchAs { + range: 34..37, + pattern: None, + name: Some( + Identifier { + id: Name("var"), + range: 34..37, + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 39..42, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 39..42, + }, + ), + }, + ), + ], + }, + ], + }, + ), + Match( + StmtMatch { + range: 43..83, + subject: Name( + ExprName { + range: 49..50, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 56..67, + pattern: MatchValue( + PatternMatchValue { + range: 61..62, + value: NumberLiteral( + ExprNumberLiteral { + range: 61..62, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 64..67, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 64..67, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 72..83, + pattern: MatchAs( + PatternMatchAs { + range: 77..78, + pattern: None, + name: None, + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 80..83, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 80..83, + }, + ), + }, + ), + ], + }, + ], + }, + ), + Match( + StmtMatch { + range: 84..175, + subject: Name( + ExprName { + range: 90..91, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ + MatchCase { + range: 97..118, + pattern: MatchAs( + PatternMatchAs { + range: 102..105, + pattern: None, + name: Some( + Identifier { + id: Name("var"), + range: 102..105, + }, + ), + }, + ), + guard: Some( + BooleanLiteral( + ExprBooleanLiteral { + range: 109..113, + value: true, + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 115..118, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 115..118, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 164..175, + pattern: MatchValue( + PatternMatchValue { + range: 169..170, + value: NumberLiteral( + ExprNumberLiteral { + range: 169..170, + value: Int( + 2, + ), + }, + ), + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 172..175, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 172..175, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py37.py.snap new file mode 100644 index 0000000000000..a925e03d2ee82 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py37.py.snap @@ -0,0 +1,138 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..93, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..92, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 69..92, + value: Some( + Tuple( + ExprTuple { + range: 76..92, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 77..78, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 80..81, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 83..84, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 86..91, + value: Name( + ExprName { + range: 87..91, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py38.py.snap new file mode 100644 index 0000000000000..d1fbfcc158f7b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_return_py38.py.snap @@ -0,0 +1,138 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/iter_unpack_return_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..91, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..90, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 69..90, + value: Some( + Tuple( + ExprTuple { + range: 76..90, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 76..77, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 79..80, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 82..83, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 85..90, + value: Name( + ExprName { + range: 86..90, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py37.py.snap new file mode 100644 index 0000000000000..e27bc0edc092b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py37.py.snap @@ -0,0 +1,143 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..92, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..91, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 69..91, + value: Yield( + ExprYield { + range: 69..91, + value: Some( + Tuple( + ExprTuple { + range: 75..91, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 76..77, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 79..80, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 82..83, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 85..90, + value: Name( + ExprName { + range: 86..90, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py38.py.snap new file mode 100644 index 0000000000000..4aa3293a645db --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@iter_unpack_yield_py38.py.snap @@ -0,0 +1,240 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/iter_unpack_yield_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..128, + body: [ + Assign( + StmtAssign { + range: 43..59, + targets: [ + Name( + ExprName { + range: 43..47, + id: Name("rest"), + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 50..59, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 4, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 5, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 6, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 60..89, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 64..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 69..89, + value: Yield( + ExprYield { + range: 69..89, + value: Some( + Tuple( + ExprTuple { + range: 75..89, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 75..76, + value: Int( + 1, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 78..79, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 81..82, + value: Int( + 3, + ), + }, + ), + Starred( + ExprStarred { + range: 84..89, + value: Name( + ExprName { + range: 85..89, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 90..127, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("h"), + range: 94..95, + }, + type_params: None, + parameters: Parameters { + range: 95..97, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 99..127, + value: Yield( + ExprYield { + range: 99..127, + value: Some( + Tuple( + ExprTuple { + range: 105..127, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 105..106, + value: Int( + 1, + ), + }, + ), + Yield( + ExprYield { + range: 109..123, + value: Some( + Tuple( + ExprTuple { + range: 115..123, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 115..116, + value: Int( + 2, + ), + }, + ), + Starred( + ExprStarred { + range: 118..123, + value: Name( + ExprName { + range: 119..123, + id: Name("rest"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 126..127, + value: Int( + 3, + ), + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_no_parameters.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_no_parameters.py.snap index 5b8eb039c3e36..6ecfea43d1d61 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_no_parameters.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_no_parameters.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/lambda_with_no_parameters.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_valid_body.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_valid_body.py.snap index f8854872e1f8a..61366ad154bb1 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_valid_body.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@lambda_with_valid_body.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/lambda_with_valid_body.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_after_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_after_py310.py.snap new file mode 100644 index 0000000000000..7c12a5fce7488 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_after_py310.py.snap @@ -0,0 +1,54 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/match_after_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..80, + body: [ + Match( + StmtMatch { + range: 46..79, + subject: NumberLiteral( + ExprNumberLiteral { + range: 52..53, + value: Int( + 2, + ), + }, + ), + cases: [ + MatchCase { + range: 59..79, + pattern: MatchValue( + PatternMatchValue { + range: 64..65, + value: NumberLiteral( + ExprNumberLiteral { + range: 64..65, + value: Int( + 1, + ), + }, + ), + }, + ), + guard: None, + body: [ + Pass( + StmtPass { + range: 75..79, + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern.py.snap index 621d2013c02de..8f967d7704c24 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern.py.snap @@ -7,11 +7,11 @@ input_file: crates/ruff_python_parser/resources/inline/ok/match_as_pattern.py ``` Module( ModModule { - range: 0..49, + range: 0..60, body: [ Match( StmtMatch { - range: 0..48, + range: 0..32, subject: Name( ExprName { range: 6..9, @@ -48,11 +48,25 @@ Module( ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 33..59, + subject: Name( + ExprName { + range: 39..42, + id: Name("foo"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 37..48, + range: 48..59, pattern: MatchAs( PatternMatchAs { - range: 42..43, + range: 53..54, pattern: None, name: None, }, @@ -61,10 +75,10 @@ Module( body: [ Expr( StmtExpr { - range: 45..48, + range: 56..59, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 45..48, + range: 56..59, }, ), }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern_soft_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern_soft_keyword.py.snap index 1270f7562b043..fd3c2f1ed1a4e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern_soft_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_as_pattern_soft_keyword.py.snap @@ -7,11 +7,11 @@ input_file: crates/ruff_python_parser/resources/inline/ok/match_as_pattern_soft_ ``` Module( ModModule { - range: 0..69, + range: 0..91, body: [ Match( StmtMatch { - range: 0..68, + range: 0..29, subject: Name( ExprName { range: 6..9, @@ -48,16 +48,30 @@ Module( ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 30..60, + subject: Name( + ExprName { + range: 36..39, + id: Name("foo"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 34..49, + range: 45..60, pattern: MatchAs( PatternMatchAs { - range: 39..44, + range: 50..55, pattern: None, name: Some( Identifier { id: Name("match"), - range: 39..44, + range: 50..55, }, ), }, @@ -66,26 +80,40 @@ Module( body: [ Expr( StmtExpr { - range: 46..49, + range: 57..60, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 46..49, + range: 57..60, }, ), }, ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 61..90, + subject: Name( + ExprName { + range: 67..70, + id: Name("foo"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 54..68, + range: 76..90, pattern: MatchAs( PatternMatchAs { - range: 59..63, + range: 81..85, pattern: None, name: Some( Identifier { id: Name("type"), - range: 59..63, + range: 81..85, }, ), }, @@ -94,10 +122,10 @@ Module( body: [ Expr( StmtExpr { - range: 65..68, + range: 87..90, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 65..68, + range: 87..90, }, ), }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_attr_pattern_soft_keyword.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_attr_pattern_soft_keyword.py.snap index 924f3b9f1b4ee..833fa6d042cd1 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_attr_pattern_soft_keyword.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_attr_pattern_soft_keyword.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_attr_pattern_soft_keyword.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_1.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_1.py.snap index 14eee06124b0d..5e454f2909e29 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_1.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_classify_as_identifier_1.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_2.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_2.py.snap index 7dfcfdd389100..f80bb85b577df 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_identifier_2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_classify_as_identifier_2.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_1.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_1.py.snap index 628936b631eed..044de1e15736e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_1.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_1.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_classify_as_keyword_1.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_2.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_2.py.snap index a467ea1997c13..d82c8dc0e1c85 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_2.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_2.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_classify_as_keyword_2.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_or_identifier.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_or_identifier.py.snap index fa466c931a3fd..1c15bbba25b50 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_or_identifier.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_classify_as_keyword_or_identifier.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_classify_as_keyword_or_identifier.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_parentheses_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_parentheses_terminator.py.snap index 582fa2aeb80c3..965e821ef377e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_parentheses_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_parentheses_terminator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_sequence_pattern_parentheses_terminator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_terminator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_terminator.py.snap index e97bfca642719..df1137b501fab 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_terminator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_sequence_pattern_terminator.py.snap @@ -21,7 +21,7 @@ Module( ), cases: [ MatchCase { - range: 19..30, + range: 19..35, pattern: MatchAs( PatternMatchAs { range: 24..25, @@ -34,38 +34,10 @@ Module( ), }, ), - guard: None, - body: [ - Expr( - StmtExpr { - range: 27..30, - value: EllipsisLiteral( - ExprEllipsisLiteral { - range: 27..30, - }, - ), - }, - ), - ], - }, - MatchCase { - range: 35..51, - pattern: MatchAs( - PatternMatchAs { - range: 40..41, - pattern: None, - name: Some( - Identifier { - id: Name("a"), - range: 40..41, - }, - ), - }, - ), guard: Some( Name( ExprName { - range: 45..46, + range: 29..30, id: Name("x"), ctx: Load, }, @@ -74,10 +46,10 @@ Module( body: [ Expr( StmtExpr { - range: 48..51, + range: 32..35, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 48..51, + range: 32..35, }, ), }, @@ -85,31 +57,31 @@ Module( ], }, MatchCase { - range: 56..70, + range: 40..54, pattern: MatchSequence( PatternMatchSequence { - range: 61..65, + range: 45..49, patterns: [ MatchAs( PatternMatchAs { - range: 61..62, + range: 45..46, pattern: None, name: Some( Identifier { id: Name("a"), - range: 61..62, + range: 45..46, }, ), }, ), MatchAs( PatternMatchAs { - range: 64..65, + range: 48..49, pattern: None, name: Some( Identifier { id: Name("b"), - range: 64..65, + range: 48..49, }, ), }, @@ -121,10 +93,10 @@ Module( body: [ Expr( StmtExpr { - range: 67..70, + range: 51..54, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 67..70, + range: 51..54, }, ), }, @@ -132,31 +104,31 @@ Module( ], }, MatchCase { - range: 75..94, + range: 59..78, pattern: MatchSequence( PatternMatchSequence { - range: 80..84, + range: 64..68, patterns: [ MatchAs( PatternMatchAs { - range: 80..81, + range: 64..65, pattern: None, name: Some( Identifier { id: Name("a"), - range: 80..81, + range: 64..65, }, ), }, ), MatchAs( PatternMatchAs { - range: 83..84, + range: 67..68, pattern: None, name: Some( Identifier { id: Name("b"), - range: 83..84, + range: 67..68, }, ), }, @@ -167,12 +139,40 @@ Module( guard: Some( Name( ExprName { - range: 88..89, + range: 72..73, id: Name("x"), ctx: Load, }, ), ), + body: [ + Expr( + StmtExpr { + range: 75..78, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 75..78, + }, + ), + }, + ), + ], + }, + MatchCase { + range: 83..94, + pattern: MatchAs( + PatternMatchAs { + range: 88..89, + pattern: None, + name: Some( + Identifier { + id: Name("a"), + range: 88..89, + }, + ), + }, + ), + guard: None, body: [ Expr( StmtExpr { diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_subject_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_subject_expr.py.snap index 06a266c5fb2db..fd8bd905dc4ba 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_subject_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_subject_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_stmt_subject_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_valid_guard_expr.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_valid_guard_expr.py.snap index 2707f21e7aaaa..17ac4a2fa65ff 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_valid_guard_expr.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@match_stmt_valid_guard_expr.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/match_stmt_valid_guard_expr.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@multiple_assignment_in_case_pattern.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@multiple_assignment_in_case_pattern.py.snap new file mode 100644 index 0000000000000..a12c28b913544 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@multiple_assignment_in_case_pattern.py.snap @@ -0,0 +1,115 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/multiple_assignment_in_case_pattern.py +snapshot_kind: text +--- +## AST + +``` +Module( + ModModule { + range: 0..42, + body: [ + Match( + StmtMatch { + range: 0..41, + subject: NumberLiteral( + ExprNumberLiteral { + range: 6..7, + value: Int( + 2, + ), + }, + ), + cases: [ + MatchCase { + range: 13..41, + pattern: MatchOr( + PatternMatchOr { + range: 18..36, + patterns: [ + MatchClass( + PatternMatchClass { + range: 18..26, + cls: Name( + ExprName { + range: 18..23, + id: Name("Class"), + ctx: Load, + }, + ), + arguments: PatternArguments { + range: 23..26, + patterns: [ + MatchAs( + PatternMatchAs { + range: 24..25, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 24..25, + }, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + MatchSequence( + PatternMatchSequence { + range: 29..32, + patterns: [ + MatchAs( + PatternMatchAs { + range: 30..31, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 30..31, + }, + ), + }, + ), + ], + }, + ), + MatchAs( + PatternMatchAs { + range: 35..36, + pattern: None, + name: Some( + Identifier { + id: Name("x"), + range: 35..36, + }, + ), + }, + ), + ], + }, + ), + guard: None, + body: [ + Expr( + StmtExpr { + range: 38..41, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 38..41, + }, + ), + }, + ), + ], + }, + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py310.py.snap new file mode 100644 index 0000000000000..2fb0f626fe0a0 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py310.py.snap @@ -0,0 +1,265 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..181, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..116, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 54..55, + }, + type_params: None, + parameters: Parameters { + range: 55..57, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 63..84, + value: ListComp( + ExprListComp { + range: 63..84, + elt: Name( + ExprName { + range: 64..65, + id: Name("_"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 66..83, + target: Name( + ExprName { + range: 70..71, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 75..83, + func: Name( + ExprName { + range: 75..80, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 80..83, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 81..82, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 89..116, + value: ListComp( + ExprListComp { + range: 89..116, + elt: Name( + ExprName { + range: 90..91, + id: Name("_"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 92..115, + target: Name( + ExprName { + range: 102..103, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 107..115, + func: Name( + ExprName { + range: 107..112, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 112..115, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 113..114, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 117..180, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 127..128, + }, + type_params: None, + parameters: Parameters { + range: 128..130, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 136..148, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 140..141, + }, + type_params: None, + parameters: Parameters { + range: 141..143, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 145..148, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 145..148, + }, + ), + }, + ), + ], + }, + ), + Expr( + StmtExpr { + range: 153..180, + value: ListComp( + ExprListComp { + range: 153..180, + elt: Name( + ExprName { + range: 154..155, + id: Name("_"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 156..179, + target: Name( + ExprName { + range: 166..167, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 171..179, + func: Name( + ExprName { + range: 171..176, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 176..179, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 177..178, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py311.py.snap new file mode 100644 index 0000000000000..b0fc9d849b97b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nested_async_comprehension_py311.py.snap @@ -0,0 +1,401 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/nested_async_comprehension_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..277, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..111, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 54..55, + }, + type_params: None, + parameters: Parameters { + range: 55..57, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 59..111, + value: Some( + ListComp( + ExprListComp { + range: 66..111, + elt: ListComp( + ExprListComp { + range: 67..92, + elt: Name( + ExprName { + range: 68..69, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 70..91, + target: Name( + ExprName { + range: 80..81, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 85..91, + func: Name( + ExprName { + range: 85..88, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 88..91, + args: [ + Name( + ExprName { + range: 89..90, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 93..110, + target: Name( + ExprName { + range: 97..98, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 102..110, + func: Name( + ExprName { + range: 102..107, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 107..110, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 108..109, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 122..192, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 132..133, + }, + type_params: None, + parameters: Parameters { + range: 133..135, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 137..192, + value: Some( + ListComp( + ExprListComp { + range: 144..192, + elt: DictComp( + ExprDictComp { + range: 145..173, + key: Name( + ExprName { + range: 146..147, + id: Name("x"), + ctx: Load, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 149..150, + value: Int( + 1, + ), + }, + ), + generators: [ + Comprehension { + range: 151..172, + target: Name( + ExprName { + range: 161..162, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 166..172, + func: Name( + ExprName { + range: 166..169, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 169..172, + args: [ + Name( + ExprName { + range: 170..171, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 174..191, + target: Name( + ExprName { + range: 178..179, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 183..191, + func: Name( + ExprName { + range: 183..188, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 188..191, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 189..190, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 200..267, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("h"), + range: 210..211, + }, + type_params: None, + parameters: Parameters { + range: 211..213, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 215..267, + value: Some( + ListComp( + ExprListComp { + range: 222..267, + elt: SetComp( + ExprSetComp { + range: 223..248, + elt: Name( + ExprName { + range: 224..225, + id: Name("x"), + ctx: Load, + }, + ), + generators: [ + Comprehension { + range: 226..247, + target: Name( + ExprName { + range: 236..237, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 241..247, + func: Name( + ExprName { + range: 241..244, + id: Name("foo"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 244..247, + args: [ + Name( + ExprName { + range: 245..246, + id: Name("n"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: true, + }, + ], + }, + ), + generators: [ + Comprehension { + range: 249..266, + target: Name( + ExprName { + range: 253..254, + id: Name("n"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 258..266, + func: Name( + ExprName { + range: 258..263, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 263..266, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 264..265, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_duplicate_type_parameter_names.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_duplicate_type_parameter_names.py.snap new file mode 100644 index 0000000000000..766ff4bc236cd --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_duplicate_type_parameter_names.py.snap @@ -0,0 +1,368 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/non_duplicate_type_parameter_names.py +--- +## AST + +``` +Module( + ModModule { + range: 0..150, + body: [ + TypeAlias( + StmtTypeAlias { + range: 0..23, + name: Name( + ExprName { + range: 5..10, + id: Name("Alias"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 10..13, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 11..12, + name: Identifier { + id: Name("T"), + range: 11..12, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + value: Subscript( + ExprSubscript { + range: 16..23, + value: Name( + ExprName { + range: 16..20, + id: Name("list"), + ctx: Load, + }, + ), + slice: Name( + ExprName { + range: 21..22, + id: Name("T"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 24..43, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 28..29, + }, + type_params: Some( + TypeParams { + range: 29..32, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 30..31, + name: Identifier { + id: Name("T"), + range: 30..31, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + parameters: Parameters { + range: 32..38, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 33..37, + parameter: Parameter { + range: 33..37, + name: Identifier { + id: Name("t"), + range: 33..34, + }, + annotation: Some( + Name( + ExprName { + range: 36..37, + id: Name("T"), + ctx: Load, + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 40..43, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 40..43, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 44..59, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 50..51, + }, + type_params: Some( + TypeParams { + range: 51..54, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 52..53, + name: Identifier { + id: Name("T"), + range: 52..53, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 56..59, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 56..59, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 60..81, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 66..67, + }, + type_params: Some( + TypeParams { + range: 67..76, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 68..69, + name: Identifier { + id: Name("T"), + range: 68..69, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 71..72, + name: Identifier { + id: Name("U"), + range: 71..72, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 74..75, + name: Identifier { + id: Name("V"), + range: 74..75, + }, + bound: None, + default: None, + }, + ), + ], + }, + ), + arguments: None, + body: [ + Expr( + StmtExpr { + range: 78..81, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 78..81, + }, + ), + }, + ), + ], + }, + ), + TypeAlias( + StmtTypeAlias { + range: 82..149, + name: Name( + ExprName { + range: 87..92, + id: Name("Alias"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 92..143, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 93..94, + name: Identifier { + id: Name("T"), + range: 93..94, + }, + bound: None, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 96..102, + name: Identifier { + id: Name("U"), + range: 96..97, + }, + bound: Some( + Name( + ExprName { + range: 99..102, + id: Name("str"), + ctx: Load, + }, + ), + ), + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 104..119, + name: Identifier { + id: Name("V"), + range: 104..105, + }, + bound: Some( + Tuple( + ExprTuple { + range: 107..119, + elts: [ + Name( + ExprName { + range: 108..111, + id: Name("str"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 113..118, + id: Name("bytes"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + default: None, + }, + ), + TypeVarTuple( + TypeParamTypeVarTuple { + range: 121..124, + name: Identifier { + id: Name("Ts"), + range: 122..124, + }, + default: None, + }, + ), + ParamSpec( + TypeParamParamSpec { + range: 126..129, + name: Identifier { + id: Name("P"), + range: 128..129, + }, + default: None, + }, + ), + TypeVar( + TypeParamTypeVar { + range: 131..142, + name: Identifier { + id: Name("D"), + range: 131..132, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 135..142, + id: Name("default"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 146..149, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_rebound_comprehension_variable.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_rebound_comprehension_variable.py.snap new file mode 100644 index 0000000000000..8c2d4b83431f4 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@non_rebound_comprehension_variable.py.snap @@ -0,0 +1,85 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/non_rebound_comprehension_variable.py +--- +## AST + +``` +Module( + ModModule { + range: 0..27, + body: [ + Expr( + StmtExpr { + range: 0..26, + value: ListComp( + ExprListComp { + range: 0..26, + elt: Named( + ExprNamed { + range: 1..7, + target: Name( + ExprName { + range: 1..2, + id: Name("a"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 6..7, + value: Int( + 0, + ), + }, + ), + }, + ), + generators: [ + Comprehension { + range: 8..25, + target: Name( + ExprName { + range: 12..13, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 17..25, + func: Name( + ExprName { + range: 17..22, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 22..25, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 23..24, + value: Int( + 0, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_declaration_at_module_level.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_declaration_at_module_level.py.snap new file mode 100644 index 0000000000000..b1646e4b6cc09 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_declaration_at_module_level.py.snap @@ -0,0 +1,49 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/nonlocal_declaration_at_module_level.py +--- +## AST + +``` +Module( + ModModule { + range: 0..24, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..23, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Nonlocal( + StmtNonlocal { + range: 13..23, + names: [ + Identifier { + id: Name("x"), + range: 22..23, + }, + ], + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_stmt.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_stmt.py.snap index e9a65e64debad..f7b7d0a1c8cbf 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_stmt.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@nonlocal_stmt.py.snap @@ -7,35 +7,58 @@ input_file: crates/ruff_python_parser/resources/inline/ok/nonlocal_stmt.py ``` Module( ModModule { - range: 0..28, + range: 0..45, body: [ - Nonlocal( - StmtNonlocal { - range: 0..10, - names: [ - Identifier { - id: Name("x"), - range: 9..10, - }, - ], - }, - ), - Nonlocal( - StmtNonlocal { - range: 11..27, - names: [ - Identifier { - id: Name("x"), - range: 20..21, - }, - Identifier { - id: Name("y"), - range: 23..24, - }, - Identifier { - id: Name("z"), - range: 26..27, - }, + FunctionDef( + StmtFunctionDef { + range: 0..44, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("_"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Nonlocal( + StmtNonlocal { + range: 13..23, + names: [ + Identifier { + id: Name("x"), + range: 22..23, + }, + ], + }, + ), + Nonlocal( + StmtNonlocal { + range: 28..44, + names: [ + Identifier { + id: Name("x"), + range: 37..38, + }, + Identifier { + id: Name("y"), + range: 40..41, + }, + Identifier { + id: Name("z"), + range: 43..44, + }, + ], + }, + ), ], }, ), diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__atom.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__atom.py.snap index 292c50ca52eca..1fa2f56ed587a 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__atom.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__atom.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/other/atom.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__decorator.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__decorator.py.snap index 932d2c2acd5e3..fd32829f6c6af 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__decorator.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@other__decorator.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/other/decorator.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_annotation.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_annotation.py.snap index 86bba2f1be2cd..c3d622ebb0e10 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_annotation.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_annotation.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/inline/ok/param_with_annotation. ``` Module( ModModule { - range: 0..113, + range: 0..84, body: [ FunctionDef( StmtFunctionDef { @@ -147,7 +147,7 @@ Module( ), FunctionDef( StmtFunctionDef { - range: 54..82, + range: 54..83, is_async: false, decorator_list: [], name: Identifier { @@ -156,92 +156,31 @@ Module( }, type_params: None, parameters: Parameters { - range: 61..77, + range: 61..78, posonlyargs: [], args: [ ParameterWithDefault { - range: 62..76, + range: 62..77, parameter: Parameter { - range: 62..76, + range: 62..77, name: Identifier { id: Name("arg"), range: 62..65, }, - annotation: Some( - Yield( - ExprYield { - range: 68..75, - value: Some( - Name( - ExprName { - range: 74..75, - id: Name("x"), - ctx: Load, - }, - ), - ), - }, - ), - ), - }, - default: None, - }, - ], - vararg: None, - kwonlyargs: [], - kwarg: None, - }, - returns: None, - body: [ - Expr( - StmtExpr { - range: 79..82, - value: EllipsisLiteral( - ExprEllipsisLiteral { - range: 79..82, - }, - ), - }, - ), - ], - }, - ), - FunctionDef( - StmtFunctionDef { - range: 83..112, - is_async: false, - decorator_list: [], - name: Identifier { - id: Name("foo"), - range: 87..90, - }, - type_params: None, - parameters: Parameters { - range: 90..107, - posonlyargs: [], - args: [ - ParameterWithDefault { - range: 91..106, - parameter: Parameter { - range: 91..106, - name: Identifier { - id: Name("arg"), - range: 91..94, - }, annotation: Some( Named( ExprNamed { - range: 97..105, + range: 68..76, target: Name( ExprName { - range: 97..98, + range: 68..69, id: Name("x"), ctx: Store, }, ), value: Name( ExprName { - range: 102..105, + range: 73..76, id: Name("int"), ctx: Load, }, @@ -261,10 +200,10 @@ Module( body: [ Expr( StmtExpr { - range: 109..112, + range: 80..83, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 109..112, + range: 80..83, }, ), }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_default.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_default.py.snap index 672d824c615c2..62383e628332c 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_default.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_default.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/param_with_default.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation.py.snap index 2965ea8635a59..bcf3af426dfa2 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py310.py.snap new file mode 100644 index 0000000000000..ad415e1657979 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py310.py.snap @@ -0,0 +1,389 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py310.py +--- +## AST + +``` +Module( + ModModule { + range: 0..432, + body: [ + ImportFrom( + StmtImportFrom { + range: 169..206, + module: Some( + Identifier { + id: Name("typing"), + range: 174..180, + }, + ), + names: [ + Alias { + range: 188..197, + name: Identifier { + id: Name("Annotated"), + range: 188..197, + }, + asname: None, + }, + Alias { + range: 199..206, + name: Identifier { + id: Name("Literal"), + range: 199..206, + }, + asname: None, + }, + ], + level: 0, + }, + ), + FunctionDef( + StmtFunctionDef { + range: 207..230, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 211..214, + }, + type_params: None, + parameters: Parameters { + range: 214..225, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 215..224, + name: Identifier { + id: Name("args"), + range: 216..220, + }, + annotation: Some( + Name( + ExprName { + range: 222..224, + id: Name("Ts"), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 227..230, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 227..230, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 231..295, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 235..238, + }, + type_params: None, + parameters: Parameters { + range: 238..290, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 239..289, + name: Identifier { + id: Name("x"), + range: 240..241, + }, + annotation: Some( + Subscript( + ExprSubscript { + range: 243..289, + value: Name( + ExprName { + range: 243..250, + id: Name("Literal"), + ctx: Load, + }, + ), + slice: StringLiteral( + ExprStringLiteral { + range: 251..288, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 251..288, + value: "this should allow arbitrary strings", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 292..295, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 292..295, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 296..367, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 300..303, + }, + type_params: None, + parameters: Parameters { + range: 303..362, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 304..361, + name: Identifier { + id: Name("x"), + range: 305..306, + }, + annotation: Some( + Subscript( + ExprSubscript { + range: 308..361, + value: Name( + ExprName { + range: 308..317, + id: Name("Annotated"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 318..360, + elts: [ + Name( + ExprName { + range: 318..321, + id: Name("str"), + ctx: Load, + }, + ), + StringLiteral( + ExprStringLiteral { + range: 323..360, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 323..360, + value: "this should allow arbitrary strings", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 364..367, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 364..367, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 368..405, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 372..375, + }, + type_params: None, + parameters: Parameters { + range: 375..400, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 376..386, + name: Identifier { + id: Name("args"), + range: 377..381, + }, + annotation: Some( + Name( + ExprName { + range: 383..386, + id: Name("str"), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: Some( + Parameter { + range: 388..399, + name: Identifier { + id: Name("kwds"), + range: 390..394, + }, + annotation: Some( + Name( + ExprName { + range: 396..399, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 402..405, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 402..405, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 406..431, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("union"), + range: 410..415, + }, + type_params: None, + parameters: Parameters { + range: 415..426, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 416..425, + name: Identifier { + id: Name("x"), + range: 417..418, + }, + annotation: Some( + BinOp( + ExprBinOp { + range: 420..425, + left: Name( + ExprName { + range: 420..421, + id: Name("A"), + ctx: Load, + }, + ), + op: BitOr, + right: Name( + ExprName { + range: 424..425, + id: Name("B"), + ctx: Load, + }, + ), + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 428..431, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 428..431, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py311.py.snap new file mode 100644 index 0000000000000..7156b308c55d2 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@param_with_star_annotation_py311.py.snap @@ -0,0 +1,71 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/param_with_star_annotation_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..69, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..68, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 48..51, + }, + type_params: None, + parameters: Parameters { + range: 51..63, + posonlyargs: [], + args: [], + vararg: Some( + Parameter { + range: 52..62, + name: Identifier { + id: Name("args"), + range: 53..57, + }, + annotation: Some( + Starred( + ExprStarred { + range: 59..62, + value: Name( + ExprName { + range: 60..62, + id: Name("Ts"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ), + }, + ), + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 65..68, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 65..68, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_non_default_after_star.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_non_default_after_star.py.snap index fc7d497209afd..4c6a5faaeb102 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_non_default_after_star.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_non_default_after_star.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/params_non_default_after_star.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_seen_keyword_only_param_after_star.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_seen_keyword_only_param_after_star.py.snap index 2a20137386b78..a01d1c06653ed 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_seen_keyword_only_param_after_star.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@params_seen_keyword_only_param_after_star.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/params_seen_keyword_only_param_after_star.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_context_manager_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_context_manager_py39.py.snap new file mode 100644 index 0000000000000..fa05d59e24897 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_context_manager_py39.py.snap @@ -0,0 +1,173 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/parenthesized_context_manager_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..126, + body: [ + With( + StmtWith { + range: 43..73, + is_async: false, + items: [ + WithItem { + range: 49..57, + context_expr: Name( + ExprName { + range: 49..52, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 56..57, + id: Name("x"), + ctx: Store, + }, + ), + ), + }, + WithItem { + range: 59..67, + context_expr: Name( + ExprName { + range: 59..62, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 66..67, + id: Name("y"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 70..73, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 70..73, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 74..99, + is_async: false, + items: [ + WithItem { + range: 80..83, + context_expr: Name( + ExprName { + range: 80..83, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: None, + }, + WithItem { + range: 85..93, + context_expr: Name( + ExprName { + range: 85..88, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 92..93, + id: Name("y"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 96..99, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 96..99, + }, + ), + }, + ), + ], + }, + ), + With( + StmtWith { + range: 100..125, + is_async: false, + items: [ + WithItem { + range: 106..114, + context_expr: Name( + ExprName { + range: 106..109, + id: Name("foo"), + ctx: Load, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 113..114, + id: Name("x"), + ctx: Store, + }, + ), + ), + }, + WithItem { + range: 116..119, + context_expr: Name( + ExprName { + range: 116..119, + id: Name("bar"), + ctx: Load, + }, + ), + optional_vars: None, + }, + ], + body: [ + Expr( + StmtExpr { + range: 122..125, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 122..125, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_kwarg_py37.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_kwarg_py37.py.snap new file mode 100644 index 0000000000000..bb42e78d8c5a9 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_kwarg_py37.py.snap @@ -0,0 +1,55 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/parenthesized_kwarg_py37.py +--- +## AST + +``` +Module( + ModModule { + range: 0..52, + body: [ + Expr( + StmtExpr { + range: 43..51, + value: Call( + ExprCall { + range: 43..51, + func: Name( + ExprName { + range: 43..44, + id: Name("f"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 44..51, + args: [], + keywords: [ + Keyword { + range: 45..50, + arg: Some( + Identifier { + id: Name("a"), + range: 46..47, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 49..50, + value: Int( + 1, + ), + }, + ), + }, + ], + }, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_index_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_index_py38.py.snap new file mode 100644 index 0000000000000..c8e09fd54a995 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_index_py38.py.snap @@ -0,0 +1,53 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_index_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..55, + body: [ + Expr( + StmtExpr { + range: 43..54, + value: Subscript( + ExprSubscript { + range: 43..54, + value: Name( + ExprName { + range: 43..46, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Named( + ExprNamed { + range: 48..52, + target: Name( + ExprName { + range: 48..49, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 1, + ), + }, + ), + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_py38.py.snap new file mode 100644 index 0000000000000..18a6f2406c045 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_named_expr_py38.py.snap @@ -0,0 +1,132 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/parenthesized_named_expr_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..92, + body: [ + Expr( + StmtExpr { + range: 43..59, + value: Set( + ExprSet { + range: 43..59, + elts: [ + Named( + ExprNamed { + range: 45..51, + target: Name( + ExprName { + range: 45..46, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 50..51, + value: Int( + 1, + ), + }, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 54..55, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 57..58, + value: Int( + 3, + ), + }, + ), + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 60..91, + value: SetComp( + ExprSetComp { + range: 60..91, + elt: Named( + ExprNamed { + range: 62..71, + target: Name( + ExprName { + range: 62..66, + id: Name("last"), + ctx: Store, + }, + ), + value: Name( + ExprName { + range: 70..71, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + generators: [ + Comprehension { + range: 73..90, + target: Name( + ExprName { + range: 77..78, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 82..90, + func: Name( + ExprName { + range: 82..87, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 87..90, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 88..89, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_star_index_py310.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_star_index_py310.py.snap new file mode 100644 index 0000000000000..10df276256e0c --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@parenthesized_star_index_py310.py.snap @@ -0,0 +1,141 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/parenthesized_star_index_py310.py +snapshot_kind: text +--- +## AST + +``` +Module( + ModModule { + range: 0..94, + body: [ + Assign( + StmtAssign { + range: 44..93, + targets: [ + Subscript( + ExprSubscript { + range: 44..89, + value: Name( + ExprName { + range: 44..47, + id: Name("out"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 48..88, + elts: [ + Starred( + ExprStarred { + range: 49..81, + value: Generator( + ExprGenerator { + range: 50..81, + elt: Call( + ExprCall { + range: 51..62, + func: Name( + ExprName { + range: 51..56, + id: Name("slice"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 56..62, + args: [ + NoneLiteral( + ExprNoneLiteral { + range: 57..61, + }, + ), + ], + keywords: [], + }, + }, + ), + generators: [ + Comprehension { + range: 63..80, + target: Name( + ExprName { + range: 67..68, + id: Name("_"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 72..80, + func: Name( + ExprName { + range: 72..77, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 77..80, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 78..79, + value: Int( + 2, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + parenthesized: true, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 83..87, + value: Name( + ExprName { + range: 84..87, + id: Name("ind"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ctx: Store, + }, + ), + ], + value: NumberLiteral( + ExprNumberLiteral { + range: 92..93, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py311.py.snap new file mode 100644 index 0000000000000..d4dcb42151531 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py311.py.snap @@ -0,0 +1,532 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..278, + body: [ + Expr( + StmtExpr { + range: 44..72, + value: FString( + ExprFString { + range: 44..72, + value: FStringValue { + inner: Single( + FString( + FString { + range: 44..72, + elements: [ + Literal( + FStringLiteralElement { + range: 46..52, + value: "outer ", + }, + ), + Expression( + FStringExpressionElement { + range: 52..71, + expression: StringLiteral( + ExprStringLiteral { + range: 53..70, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 53..70, + value: "# not a comment", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 73..106, + value: FString( + ExprFString { + range: 73..106, + value: FStringValue { + inner: Single( + FString( + FString { + range: 73..106, + elements: [ + Literal( + FStringLiteralElement { + range: 75..81, + value: "outer ", + }, + ), + Expression( + FStringExpressionElement { + range: 81..105, + expression: Name( + ExprName { + range: 82..83, + id: Name("x"), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: Some( + FStringFormatSpec { + range: 84..104, + elements: [ + Expression( + FStringExpressionElement { + range: 84..103, + expression: StringLiteral( + ExprStringLiteral { + range: 85..102, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 85..102, + value: "# not a comment", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 103..104, + value: " ", + }, + ), + ], + }, + ), + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 107..147, + value: FString( + ExprFString { + range: 107..147, + value: FStringValue { + inner: Single( + FString( + FString { + range: 107..147, + elements: [ + Expression( + FStringExpressionElement { + range: 111..144, + expression: FString( + ExprFString { + range: 112..143, + value: FStringValue { + inner: Single( + FString( + FString { + range: 112..143, + elements: [ + Expression( + FStringExpressionElement { + range: 116..140, + expression: FString( + ExprFString { + range: 117..139, + value: FStringValue { + inner: Single( + FString( + FString { + range: 117..139, + elements: [ + Expression( + FStringExpressionElement { + range: 119..138, + expression: StringLiteral( + ExprStringLiteral { + range: 120..137, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 120..137, + value: "# not a comment", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 148..230, + value: FString( + ExprFString { + range: 148..230, + value: FStringValue { + inner: Single( + FString( + FString { + range: 148..230, + elements: [ + Expression( + FStringExpressionElement { + range: 152..208, + expression: FString( + ExprFString { + range: 153..207, + value: FStringValue { + inner: Single( + FString( + FString { + range: 153..207, + elements: [ + Literal( + FStringLiteralElement { + range: 157..177, + value: "# before expression ", + }, + ), + Expression( + FStringExpressionElement { + range: 177..204, + expression: FString( + ExprFString { + range: 178..203, + value: FStringValue { + inner: Single( + FString( + FString { + range: 178..203, + elements: [ + Literal( + FStringLiteralElement { + range: 180..185, + value: "# aro", + }, + ), + Expression( + FStringExpressionElement { + range: 185..197, + expression: FString( + ExprFString { + range: 186..196, + value: FStringValue { + inner: Single( + FString( + FString { + range: 186..196, + elements: [ + Literal( + FStringLiteralElement { + range: 188..189, + value: "#", + }, + ), + Expression( + FStringExpressionElement { + range: 189..194, + expression: BinOp( + ExprBinOp { + range: 190..193, + left: NumberLiteral( + ExprNumberLiteral { + range: 190..191, + value: Int( + 1, + ), + }, + ), + op: Add, + right: NumberLiteral( + ExprNumberLiteral { + range: 192..193, + value: Int( + 1, + ), + }, + ), + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 194..195, + value: "#", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 197..202, + value: "und #", + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 208..227, + value: " # after expression", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 231..263, + value: FString( + ExprFString { + range: 231..263, + value: FStringValue { + inner: Single( + FString( + FString { + range: 231..263, + elements: [ + Literal( + FStringLiteralElement { + range: 233..254, + value: "escape outside of \t ", + }, + ), + Expression( + FStringExpressionElement { + range: 254..260, + expression: Name( + ExprName { + range: 255..259, + id: Name("expr"), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 260..262, + value: "\n", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 264..277, + value: FString( + ExprFString { + range: 264..277, + value: FStringValue { + inner: Single( + FString( + FString { + range: 264..277, + elements: [ + Literal( + FStringLiteralElement { + range: 266..276, + value: "test\"abcd", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py312.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py312.py.snap new file mode 100644 index 0000000000000..c9eea808228f5 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pep701_f_string_py312.py.snap @@ -0,0 +1,584 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/pep701_f_string_py312.py +--- +## AST + +``` +Module( + ModModule { + range: 0..403, + body: [ + Expr( + StmtExpr { + range: 44..74, + value: FString( + ExprFString { + range: 44..74, + value: FStringValue { + inner: Single( + FString( + FString { + range: 44..74, + elements: [ + Literal( + FStringLiteralElement { + range: 46..58, + value: "Magic wand: ", + }, + ), + Expression( + FStringExpressionElement { + range: 58..73, + expression: Subscript( + ExprSubscript { + range: 60..71, + value: Name( + ExprName { + range: 60..63, + id: Name("bag"), + ctx: Load, + }, + ), + slice: StringLiteral( + ExprStringLiteral { + range: 64..70, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 64..70, + value: "wand", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 95..112, + value: FString( + ExprFString { + range: 95..112, + value: FStringValue { + inner: Single( + FString( + FString { + range: 95..112, + elements: [ + Expression( + FStringExpressionElement { + range: 97..111, + expression: Call( + ExprCall { + range: 98..110, + func: Attribute( + ExprAttribute { + range: 98..107, + value: StringLiteral( + ExprStringLiteral { + range: 98..102, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 98..102, + value: "\n", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + attr: Identifier { + id: Name("join"), + range: 103..107, + }, + ctx: Load, + }, + ), + arguments: Arguments { + range: 107..110, + args: [ + Name( + ExprName { + range: 108..109, + id: Name("a"), + ctx: Load, + }, + ), + ], + keywords: [], + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 148..220, + value: FString( + ExprFString { + range: 148..220, + value: FStringValue { + inner: Single( + FString( + FString { + range: 148..220, + elements: [ + Literal( + FStringLiteralElement { + range: 152..169, + value: "A complex trick: ", + }, + ), + Expression( + FStringExpressionElement { + range: 169..217, + expression: Subscript( + ExprSubscript { + range: 175..185, + value: Name( + ExprName { + range: 175..178, + id: Name("bag"), + ctx: Load, + }, + ), + slice: StringLiteral( + ExprStringLiteral { + range: 179..184, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 179..184, + value: "bag", + flags: StringLiteralFlags { + quote_style: Single, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 221..254, + value: FString( + ExprFString { + range: 221..254, + value: FStringValue { + inner: Single( + FString( + FString { + range: 221..254, + elements: [ + Expression( + FStringExpressionElement { + range: 223..253, + expression: FString( + ExprFString { + range: 224..252, + value: FStringValue { + inner: Single( + FString( + FString { + range: 224..252, + elements: [ + Expression( + FStringExpressionElement { + range: 226..251, + expression: FString( + ExprFString { + range: 227..250, + value: FStringValue { + inner: Single( + FString( + FString { + range: 227..250, + elements: [ + Expression( + FStringExpressionElement { + range: 229..249, + expression: FString( + ExprFString { + range: 230..248, + value: FStringValue { + inner: Single( + FString( + FString { + range: 230..248, + elements: [ + Expression( + FStringExpressionElement { + range: 232..247, + expression: FString( + ExprFString { + range: 233..246, + value: FStringValue { + inner: Single( + FString( + FString { + range: 233..246, + elements: [ + Expression( + FStringExpressionElement { + range: 235..245, + expression: FString( + ExprFString { + range: 236..244, + value: FStringValue { + inner: Single( + FString( + FString { + range: 236..244, + elements: [ + Expression( + FStringExpressionElement { + range: 238..243, + expression: BinOp( + ExprBinOp { + range: 239..242, + left: NumberLiteral( + ExprNumberLiteral { + range: 239..240, + value: Int( + 1, + ), + }, + ), + op: Add, + right: NumberLiteral( + ExprNumberLiteral { + range: 241..242, + value: Int( + 1, + ), + }, + ), + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 276..310, + value: FString( + ExprFString { + range: 276..310, + value: FStringValue { + inner: Single( + FString( + FString { + range: 276..310, + elements: [ + Expression( + FStringExpressionElement { + range: 278..303, + expression: FString( + ExprFString { + range: 279..302, + value: FStringValue { + inner: Single( + FString( + FString { + range: 279..302, + elements: [ + Expression( + FStringExpressionElement { + range: 283..293, + expression: StringLiteral( + ExprStringLiteral { + range: 284..292, + value: StringLiteralValue { + inner: Single( + StringLiteral { + range: 284..292, + value: "nested", + flags: StringLiteralFlags { + quote_style: Double, + prefix: Empty, + triple_quoted: false, + }, + }, + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 293..299, + value: " inner", + }, + ), + ], + flags: FStringFlags { + quote_style: Single, + prefix: Regular, + triple_quoted: true, + }, + }, + ), + ), + }, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 303..309, + value: " outer", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 336..359, + value: FString( + ExprFString { + range: 336..359, + value: FStringValue { + inner: Single( + FString( + FString { + range: 336..359, + elements: [ + Literal( + FStringLiteralElement { + range: 338..343, + value: "test ", + }, + ), + Expression( + FStringExpressionElement { + range: 343..353, + expression: Name( + ExprName { + range: 344..345, + id: Name("a"), + ctx: Load, + }, + ), + debug_text: None, + conversion: None, + format_spec: None, + }, + ), + Literal( + FStringLiteralElement { + range: 353..358, + value: " more", + }, + ), + ], + flags: FStringFlags { + quote_style: Double, + prefix: Regular, + triple_quoted: false, + }, + }, + ), + ), + }, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@pos_only_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pos_only_py38.py.snap new file mode 100644 index 0000000000000..2e5f4b9e98a9a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@pos_only_py38.py.snap @@ -0,0 +1,61 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/pos_only_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..62, + body: [ + FunctionDef( + StmtFunctionDef { + range: 43..61, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("foo"), + range: 47..50, + }, + type_params: None, + parameters: Parameters { + range: 50..56, + posonlyargs: [ + ParameterWithDefault { + range: 51..52, + parameter: Parameter { + range: 51..52, + name: Identifier { + id: Name("a"), + range: 51..52, + }, + annotation: None, + }, + default: None, + }, + ], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 58..61, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 58..61, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@read_from_debug.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@read_from_debug.py.snap new file mode 100644 index 0000000000000..5bfd7c4128930 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@read_from_debug.py.snap @@ -0,0 +1,61 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/read_from_debug.py +--- +## AST + +``` +Module( + ModModule { + range: 0..32, + body: [ + If( + StmtIf { + range: 0..17, + test: Name( + ExprName { + range: 3..12, + id: Name("__debug__"), + ctx: Load, + }, + ), + body: [ + Expr( + StmtExpr { + range: 14..17, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 14..17, + }, + ), + }, + ), + ], + elif_else_clauses: [], + }, + ), + Assign( + StmtAssign { + range: 18..31, + targets: [ + Name( + ExprName { + range: 18..19, + id: Name("x"), + ctx: Store, + }, + ), + ], + value: Name( + ExprName { + range: 22..31, + id: Name("__debug__"), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_in_block.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_in_block.py.snap index 0caee363a4166..a819e56517279 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_in_block.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_in_block.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/simple_stmts_in_block.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_with_semicolons.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_with_semicolons.py.snap index 9b2a2f698fc91..2588cbfe7624a 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_with_semicolons.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@simple_stmts_with_semicolons.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/simple_stmts_with_semicolons.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_star_in_tuple.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_star_in_tuple.py.snap new file mode 100644 index 0000000000000..ae3a5f8fc470b --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_star_in_tuple.py.snap @@ -0,0 +1,220 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/single_star_in_tuple.py +--- +## AST + +``` +Module( + ModModule { + range: 0..84, + body: [ + FunctionDef( + StmtFunctionDef { + range: 0..20, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 4..5, + }, + type_params: None, + parameters: Parameters { + range: 5..7, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 9..20, + value: Yield( + ExprYield { + range: 9..20, + value: Some( + Tuple( + ExprTuple { + range: 15..20, + elts: [ + Starred( + ExprStarred { + range: 16..18, + value: Name( + ExprName { + range: 17..18, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 21..42, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 25..26, + }, + type_params: None, + parameters: Parameters { + range: 26..28, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Return( + StmtReturn { + range: 30..42, + value: Some( + Tuple( + ExprTuple { + range: 37..42, + elts: [ + Starred( + ExprStarred { + range: 38..40, + value: Name( + ExprName { + range: 39..40, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + ), + }, + ), + ], + }, + ), + For( + StmtFor { + range: 43..62, + is_async: false, + target: Name( + ExprName { + range: 47..48, + id: Name("_"), + ctx: Store, + }, + ), + iter: Tuple( + ExprTuple { + range: 52..57, + elts: [ + Starred( + ExprStarred { + range: 53..55, + value: Name( + ExprName { + range: 54..55, + id: Name("x"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + body: [ + Expr( + StmtExpr { + range: 59..62, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 59..62, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + For( + StmtFor { + range: 63..83, + is_async: false, + target: Tuple( + ExprTuple { + range: 67..72, + elts: [ + Starred( + ExprStarred { + range: 68..70, + value: Name( + ExprName { + range: 69..70, + id: Name("x"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + ], + ctx: Store, + parenthesized: true, + }, + ), + iter: Name( + ExprName { + range: 76..78, + id: Name("xs"), + ctx: Load, + }, + ), + body: [ + Expr( + StmtExpr { + range: 80..83, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 80..83, + }, + ), + }, + ), + ], + orelse: [], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_starred_assignment_target.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_starred_assignment_target.py.snap new file mode 100644 index 0000000000000..bd1289f2b39c0 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@single_starred_assignment_target.py.snap @@ -0,0 +1,152 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/single_starred_assignment_target.py +--- +## AST + +``` +Module( + ModModule { + range: 0..36, + body: [ + Assign( + StmtAssign { + range: 0..12, + targets: [ + Tuple( + ExprTuple { + range: 0..5, + elts: [ + Starred( + ExprStarred { + range: 1..3, + value: Name( + ExprName { + range: 2..3, + id: Name("a"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + ], + ctx: Store, + parenthesized: true, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 8..12, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 9..10, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 13..23, + targets: [ + Tuple( + ExprTuple { + range: 13..16, + elts: [ + Starred( + ExprStarred { + range: 13..15, + value: Name( + ExprName { + range: 14..15, + id: Name("a"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + ], + ctx: Store, + parenthesized: false, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 19..23, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 20..21, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + Assign( + StmtAssign { + range: 24..35, + targets: [ + List( + ExprList { + range: 24..28, + elts: [ + Starred( + ExprStarred { + range: 25..27, + value: Name( + ExprName { + range: 26..27, + id: Name("a"), + ctx: Store, + }, + ), + ctx: Store, + }, + ), + ], + ctx: Store, + }, + ), + ], + value: Tuple( + ExprTuple { + range: 31..35, + elts: [ + NumberLiteral( + ExprNumberLiteral { + range: 32..33, + value: Int( + 1, + ), + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@star_index_py311.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@star_index_py311.py.snap new file mode 100644 index 0000000000000..241edaeadd8f8 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@star_index_py311.py.snap @@ -0,0 +1,355 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/star_index_py311.py +--- +## AST + +``` +Module( + ModModule { + range: 0..293, + body: [ + Expr( + StmtExpr { + range: 44..55, + value: Subscript( + ExprSubscript { + range: 44..55, + value: Name( + ExprName { + range: 44..47, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 48..54, + elts: [ + Starred( + ExprStarred { + range: 48..54, + value: Name( + ExprName { + range: 49..54, + id: Name("index"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + ClassDef( + StmtClassDef { + range: 72..112, + decorator_list: [], + name: Identifier { + id: Name("Array"), + range: 78..83, + }, + type_params: None, + arguments: Some( + Arguments { + range: 83..107, + args: [ + Subscript( + ExprSubscript { + range: 84..106, + value: Name( + ExprName { + range: 84..91, + id: Name("Generic"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 92..105, + elts: [ + Name( + ExprName { + range: 92..97, + id: Name("DType"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 99..105, + value: Name( + ExprName { + range: 100..105, + id: Name("Shape"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 109..112, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 109..112, + }, + ), + }, + ), + ], + }, + ), + Expr( + StmtExpr { + range: 148..161, + value: Subscript( + ExprSubscript { + range: 148..161, + value: Name( + ExprName { + range: 148..151, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 152..160, + elts: [ + Name( + ExprName { + range: 152..153, + id: Name("a"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 155..157, + value: Name( + ExprName { + range: 156..157, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Name( + ExprName { + range: 159..160, + id: Name("c"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 185..198, + value: Subscript( + ExprSubscript { + range: 185..198, + value: Name( + ExprName { + range: 185..188, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 189..197, + elts: [ + Name( + ExprName { + range: 189..190, + id: Name("a"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 192..193, + id: Name("b"), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 195..197, + value: Name( + ExprName { + range: 196..197, + id: Name("c"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 222..233, + value: Subscript( + ExprSubscript { + range: 222..233, + value: Name( + ExprName { + range: 222..225, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 226..232, + elts: [ + Starred( + ExprStarred { + range: 226..228, + value: Name( + ExprName { + range: 227..228, + id: Name("a"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + Starred( + ExprStarred { + range: 230..232, + value: Name( + ExprName { + range: 231..232, + id: Name("b"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + Expr( + StmtExpr { + range: 254..271, + value: Subscript( + ExprSubscript { + range: 254..271, + value: Name( + ExprName { + range: 254..259, + id: Name("array"), + ctx: Load, + }, + ), + slice: Tuple( + ExprTuple { + range: 260..270, + elts: [ + Slice( + ExprSlice { + range: 260..263, + lower: Some( + NumberLiteral( + ExprNumberLiteral { + range: 260..261, + value: Int( + 3, + ), + }, + ), + ), + upper: Some( + NumberLiteral( + ExprNumberLiteral { + range: 262..263, + value: Int( + 5, + ), + }, + ), + ), + step: None, + }, + ), + Starred( + ExprStarred { + range: 265..270, + value: Name( + ExprName { + range: 266..270, + id: Name("idxs"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: false, + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__ambiguous_lpar_with_items.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__ambiguous_lpar_with_items.py.snap index fd059ae0e28ad..48d299be48416 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__ambiguous_lpar_with_items.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__ambiguous_lpar_with_items.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/ambiguous_lpar_with_items.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__annotated_assignment.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__annotated_assignment.py.snap index 52cf9055be13d..493f3ba3d1437 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__annotated_assignment.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__annotated_assignment.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/annotated_assignment.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assert.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assert.py.snap index efffa253aa5a9..1dce325d01c29 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assert.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assert.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/assert.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assignment.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assignment.py.snap index da466356e5199..606a9ea32422b 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assignment.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__assignment.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/valid/statement/assignment.py ``` Module( ModModule { - range: 0..734, + range: 0..729, body: [ Assign( StmtAssign { @@ -369,57 +369,29 @@ Module( ), Assign( StmtAssign { - range: 259..268, - targets: [ - Starred( - ExprStarred { - range: 259..263, - value: Name( - ExprName { - range: 260..263, - id: Name("foo"), - ctx: Store, - }, - ), - ctx: Store, - }, - ), - ], - value: NumberLiteral( - ExprNumberLiteral { - range: 266..268, - value: Int( - 42, - ), - }, - ), - }, - ), - Assign( - StmtAssign { - range: 270..291, + range: 259..280, targets: [ List( ExprList { - range: 270..279, + range: 259..268, elts: [ Name( ExprName { - range: 271..272, + range: 260..261, id: Name("x"), ctx: Store, }, ), Name( ExprName { - range: 274..275, + range: 263..264, id: Name("y"), ctx: Store, }, ), Name( ExprName { - range: 277..278, + range: 266..267, id: Name("z"), ctx: Store, }, @@ -431,11 +403,11 @@ Module( ], value: List( ExprList { - range: 282..291, + range: 271..280, elts: [ NumberLiteral( ExprNumberLiteral { - range: 283..284, + range: 272..273, value: Int( 1, ), @@ -443,7 +415,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 286..287, + range: 275..276, value: Int( 2, ), @@ -451,7 +423,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 289..290, + range: 278..279, value: Int( 3, ), @@ -465,29 +437,29 @@ Module( ), Assign( StmtAssign { - range: 293..314, + range: 282..303, targets: [ Tuple( ExprTuple { - range: 293..302, + range: 282..291, elts: [ Name( ExprName { - range: 294..295, + range: 283..284, id: Name("x"), ctx: Store, }, ), Name( ExprName { - range: 297..298, + range: 286..287, id: Name("y"), ctx: Store, }, ), Name( ExprName { - range: 300..301, + range: 289..290, id: Name("z"), ctx: Store, }, @@ -500,11 +472,11 @@ Module( ], value: Tuple( ExprTuple { - range: 305..314, + range: 294..303, elts: [ NumberLiteral( ExprNumberLiteral { - range: 306..307, + range: 295..296, value: Int( 1, ), @@ -512,7 +484,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 309..310, + range: 298..299, value: Int( 2, ), @@ -520,7 +492,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 312..313, + range: 301..302, value: Int( 3, ), @@ -535,21 +507,21 @@ Module( ), Assign( StmtAssign { - range: 315..324, + range: 304..313, targets: [ Subscript( ExprSubscript { - range: 315..319, + range: 304..308, value: Name( ExprName { - range: 315..316, + range: 304..305, id: Name("x"), ctx: Load, }, ), slice: NumberLiteral( ExprNumberLiteral { - range: 317..318, + range: 306..307, value: Int( 0, ), @@ -561,7 +533,7 @@ Module( ], value: NumberLiteral( ExprNumberLiteral { - range: 322..324, + range: 311..313, value: Int( 42, ), @@ -571,14 +543,14 @@ Module( ), Assign( StmtAssign { - range: 421..430, + range: 410..419, targets: [ Subscript( ExprSubscript { - range: 421..425, + range: 410..414, value: NumberLiteral( ExprNumberLiteral { - range: 421..422, + range: 410..411, value: Int( 5, ), @@ -586,7 +558,7 @@ Module( ), slice: NumberLiteral( ExprNumberLiteral { - range: 423..424, + range: 412..413, value: Int( 0, ), @@ -598,7 +570,7 @@ Module( ], value: NumberLiteral( ExprNumberLiteral { - range: 428..430, + range: 417..419, value: Int( 42, ), @@ -608,25 +580,25 @@ Module( ), Assign( StmtAssign { - range: 431..444, + range: 420..433, targets: [ Subscript( ExprSubscript { - range: 431..437, + range: 420..426, value: Name( ExprName { - range: 431..432, + range: 420..421, id: Name("x"), ctx: Load, }, ), slice: Slice( ExprSlice { - range: 433..436, + range: 422..425, lower: Some( NumberLiteral( ExprNumberLiteral { - range: 433..434, + range: 422..423, value: Int( 1, ), @@ -636,7 +608,7 @@ Module( upper: Some( NumberLiteral( ExprNumberLiteral { - range: 435..436, + range: 424..425, value: Int( 2, ), @@ -652,11 +624,11 @@ Module( ], value: List( ExprList { - range: 440..444, + range: 429..433, elts: [ NumberLiteral( ExprNumberLiteral { - range: 441..443, + range: 430..432, value: Int( 42, ), @@ -670,14 +642,14 @@ Module( ), Assign( StmtAssign { - range: 540..553, + range: 529..542, targets: [ Subscript( ExprSubscript { - range: 540..546, + range: 529..535, value: NumberLiteral( ExprNumberLiteral { - range: 540..541, + range: 529..530, value: Int( 5, ), @@ -685,11 +657,11 @@ Module( ), slice: Slice( ExprSlice { - range: 542..545, + range: 531..534, lower: Some( NumberLiteral( ExprNumberLiteral { - range: 542..543, + range: 531..532, value: Int( 1, ), @@ -699,7 +671,7 @@ Module( upper: Some( NumberLiteral( ExprNumberLiteral { - range: 544..545, + range: 533..534, value: Int( 2, ), @@ -715,11 +687,11 @@ Module( ], value: List( ExprList { - range: 549..553, + range: 538..542, elts: [ NumberLiteral( ExprNumberLiteral { - range: 550..552, + range: 539..541, value: Int( 42, ), @@ -733,21 +705,21 @@ Module( ), Assign( StmtAssign { - range: 555..567, + range: 544..556, targets: [ Attribute( ExprAttribute { - range: 555..562, + range: 544..551, value: Name( ExprName { - range: 555..558, + range: 544..547, id: Name("foo"), ctx: Load, }, ), attr: Identifier { id: Name("bar"), - range: 559..562, + range: 548..551, }, ctx: Store, }, @@ -755,7 +727,7 @@ Module( ], value: NumberLiteral( ExprNumberLiteral { - range: 565..567, + range: 554..556, value: Int( 42, ), @@ -765,18 +737,18 @@ Module( ), Assign( StmtAssign { - range: 669..681, + range: 658..670, targets: [ Attribute( ExprAttribute { - range: 669..676, + range: 658..665, value: StringLiteral( ExprStringLiteral { - range: 669..674, + range: 658..663, value: StringLiteralValue { inner: Single( StringLiteral { - range: 669..674, + range: 658..663, value: "foo", flags: StringLiteralFlags { quote_style: Double, @@ -790,7 +762,7 @@ Module( ), attr: Identifier { id: Name("y"), - range: 675..676, + range: 664..665, }, ctx: Store, }, @@ -798,7 +770,7 @@ Module( ], value: NumberLiteral( ExprNumberLiteral { - range: 679..681, + range: 668..670, value: Int( 42, ), @@ -808,11 +780,11 @@ Module( ), Assign( StmtAssign { - range: 683..691, + range: 672..680, targets: [ Name( ExprName { - range: 683..686, + range: 672..675, id: Name("foo"), ctx: Store, }, @@ -820,7 +792,7 @@ Module( ], value: NumberLiteral( ExprNumberLiteral { - range: 689..691, + range: 678..680, value: Int( 42, ), @@ -830,77 +802,95 @@ Module( ), Assign( StmtAssign { - range: 693..703, + range: 682..695, targets: [ List( ExprList { - range: 693..695, + range: 682..684, elts: [], ctx: Store, }, ), ], - value: Starred( - ExprStarred { - range: 698..703, - value: Name( - ExprName { - range: 699..703, - id: Name("data"), - ctx: Load, - }, - ), + value: Tuple( + ExprTuple { + range: 687..695, + elts: [ + Starred( + ExprStarred { + range: 688..693, + value: Name( + ExprName { + range: 689..693, + id: Name("data"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 704..714, + range: 696..709, targets: [ Tuple( ExprTuple { - range: 704..706, + range: 696..698, elts: [], ctx: Store, parenthesized: true, }, ), ], - value: Starred( - ExprStarred { - range: 709..714, - value: Name( - ExprName { - range: 710..714, - id: Name("data"), - ctx: Load, - }, - ), + value: Tuple( + ExprTuple { + range: 701..709, + elts: [ + Starred( + ExprStarred { + range: 702..707, + value: Name( + ExprName { + range: 703..707, + id: Name("data"), + ctx: Load, + }, + ), + ctx: Load, + }, + ), + ], ctx: Load, + parenthesized: true, }, ), }, ), Assign( StmtAssign { - range: 715..724, + range: 710..719, targets: [ Tuple( ExprTuple { - range: 715..719, + range: 710..714, elts: [ Name( ExprName { - range: 715..716, + range: 710..711, id: Name("a"), ctx: Store, }, ), Name( ExprName { - range: 718..719, + range: 713..714, id: Name("b"), ctx: Store, }, @@ -913,7 +903,7 @@ Module( ], value: Name( ExprName { - range: 722..724, + range: 717..719, id: Name("ab"), ctx: Load, }, @@ -922,18 +912,18 @@ Module( ), Assign( StmtAssign { - range: 725..734, + range: 720..729, targets: [ Name( ExprName { - range: 725..726, + range: 720..721, id: Name("a"), ctx: Store, }, ), Name( ExprName { - range: 729..730, + range: 724..725, id: Name("b"), ctx: Store, }, @@ -941,7 +931,7 @@ Module( ], value: Name( ExprName { - range: 733..734, + range: 728..729, id: Name("c"), ctx: Load, }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__augmented_assignment.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__augmented_assignment.py.snap index 6b5b9e25823b5..da75ead75c817 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__augmented_assignment.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__augmented_assignment.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/augmented_assignment.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__class.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__class.py.snap index 1bf6e9f03e411..8a6c4d8e8764b 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__class.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__class.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/class.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__delete.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__delete.py.snap index ac37e09701198..fbb6d09bf2b0f 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__delete.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__delete.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/delete.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__for.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__for.py.snap index 721da442b2dbe..fa69892a4a011 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__for.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__for.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/valid/statement/for.py ``` Module( ModModule { - range: 0..660, + range: 0..523, body: [ For( StmtFor { @@ -376,7 +376,7 @@ Module( ), For( StmtFor { - range: 264..295, + range: 264..294, is_async: false, target: Name( ExprName { @@ -385,57 +385,13 @@ Module( ctx: Store, }, ), - iter: Starred( - ExprStarred { - range: 278..285, - value: Attribute( - ExprAttribute { - range: 279..285, - value: Name( - ExprName { - range: 279..280, - id: Name("x"), - ctx: Load, - }, - ), - attr: Identifier { - id: Name("attr"), - range: 281..285, - }, - ctx: Load, - }, - ), - ctx: Load, - }, - ), - body: [ - Pass( - StmtPass { - range: 291..295, - }, - ), - ], - orelse: [], - }, - ), - For( - StmtFor { - range: 297..327, - is_async: false, - target: Name( - ExprName { - range: 301..307, - id: Name("target"), - ctx: Store, - }, - ), iter: List( ExprList { - range: 311..317, + range: 278..284, elts: [ NumberLiteral( ExprNumberLiteral { - range: 312..313, + range: 279..280, value: Int( 1, ), @@ -443,7 +399,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 315..316, + range: 282..283, value: Int( 2, ), @@ -456,166 +412,7 @@ Module( body: [ Pass( StmtPass { - range: 323..327, - }, - ), - ], - orelse: [], - }, - ), - For( - StmtFor { - range: 329..377, - is_async: false, - target: Starred( - ExprStarred { - range: 333..340, - value: Name( - ExprName { - range: 334..340, - id: Name("target"), - ctx: Store, - }, - ), - ctx: Store, - }, - ), - iter: Tuple( - ExprTuple { - range: 344..352, - elts: [ - Name( - ExprName { - range: 344..345, - id: Name("a"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 347..348, - id: Name("b"), - ctx: Load, - }, - ), - Name( - ExprName { - range: 350..351, - id: Name("c"), - ctx: Load, - }, - ), - ], - ctx: Load, - parenthesized: false, - }, - ), - body: [ - Pass( - StmtPass { - range: 358..362, - }, - ), - ], - orelse: [ - Pass( - StmtPass { - range: 373..377, - }, - ), - ], - }, - ), - For( - StmtFor { - range: 379..404, - is_async: false, - target: Name( - ExprName { - range: 383..389, - id: Name("target"), - ctx: Store, - }, - ), - iter: Starred( - ExprStarred { - range: 393..399, - value: BinOp( - ExprBinOp { - range: 394..399, - left: Name( - ExprName { - range: 394..395, - id: Name("x"), - ctx: Load, - }, - ), - op: BitOr, - right: Name( - ExprName { - range: 398..399, - id: Name("y"), - ctx: Load, - }, - ), - }, - ), - ctx: Load, - }, - ), - body: [ - Expr( - StmtExpr { - range: 401..404, - value: EllipsisLiteral( - ExprEllipsisLiteral { - range: 401..404, - }, - ), - }, - ), - ], - orelse: [], - }, - ), - For( - StmtFor { - range: 405..432, - is_async: false, - target: Name( - ExprName { - range: 409..415, - id: Name("target"), - ctx: Store, - }, - ), - iter: Starred( - ExprStarred { - range: 419..427, - value: Await( - ExprAwait { - range: 420..427, - value: Name( - ExprName { - range: 426..427, - id: Name("x"), - ctx: Load, - }, - ), - }, - ), - ctx: Load, - }, - ), - body: [ - Expr( - StmtExpr { - range: 429..432, - value: EllipsisLiteral( - ExprEllipsisLiteral { - range: 429..432, - }, - ), + range: 290..294, }, ), ], @@ -624,21 +421,21 @@ Module( ), For( StmtFor { - range: 433..459, + range: 296..322, is_async: false, target: Name( ExprName { - range: 437..443, + range: 300..306, id: Name("target"), ctx: Store, }, ), iter: Await( ExprAwait { - range: 447..454, + range: 310..317, value: Name( ExprName { - range: 453..454, + range: 316..317, id: Name("x"), ctx: Load, }, @@ -648,10 +445,10 @@ Module( body: [ Expr( StmtExpr { - range: 456..459, + range: 319..322, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 456..459, + range: 319..322, }, ), }, @@ -662,30 +459,30 @@ Module( ), For( StmtFor { - range: 460..490, + range: 323..353, is_async: false, target: Name( ExprName { - range: 464..470, + range: 327..333, id: Name("target"), ctx: Store, }, ), iter: Lambda( ExprLambda { - range: 474..485, + range: 337..348, parameters: Some( Parameters { - range: 481..482, + range: 344..345, posonlyargs: [], args: [ ParameterWithDefault { - range: 481..482, + range: 344..345, parameter: Parameter { - range: 481..482, + range: 344..345, name: Identifier { id: Name("x"), - range: 481..482, + range: 344..345, }, annotation: None, }, @@ -699,7 +496,7 @@ Module( ), body: Name( ExprName { - range: 484..485, + range: 347..348, id: Name("x"), ctx: Load, }, @@ -709,10 +506,10 @@ Module( body: [ Expr( StmtExpr { - range: 487..490, + range: 350..353, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 487..490, + range: 350..353, }, ), }, @@ -723,34 +520,34 @@ Module( ), For( StmtFor { - range: 491..526, + range: 354..389, is_async: false, target: Name( ExprName { - range: 495..501, + range: 358..364, id: Name("target"), ctx: Store, }, ), iter: If( ExprIf { - range: 505..521, + range: 368..384, test: BooleanLiteral( ExprBooleanLiteral { - range: 510..514, + range: 373..377, value: true, }, ), body: Name( ExprName { - range: 505..506, + range: 368..369, id: Name("x"), ctx: Load, }, ), orelse: Name( ExprName { - range: 520..521, + range: 383..384, id: Name("y"), ctx: Load, }, @@ -760,10 +557,10 @@ Module( body: [ Expr( StmtExpr { - range: 523..526, + range: 386..389, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 523..526, + range: 386..389, }, ), }, @@ -774,10 +571,10 @@ Module( ), If( StmtIf { - range: 528..659, + range: 391..522, test: Name( ExprName { - range: 531..532, + range: 394..395, id: Name("x"), ctx: Load, }, @@ -785,18 +582,18 @@ Module( body: [ For( StmtFor { - range: 538..570, + range: 401..433, is_async: false, target: Name( ExprName { - range: 542..548, + range: 405..411, id: Name("target"), ctx: Store, }, ), iter: Name( ExprName { - range: 552..556, + range: 415..419, id: Name("iter"), ctx: Load, }, @@ -804,7 +601,7 @@ Module( body: [ Pass( StmtPass { - range: 566..570, + range: 429..433, }, ), ], @@ -814,12 +611,12 @@ Module( ], elif_else_clauses: [ ElifElseClause { - range: 645..659, + range: 508..522, test: None, body: [ Pass( StmtPass { - range: 655..659, + range: 518..522, }, ), ], diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__from_import.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__from_import.py.snap index 1fa1095351b46..3fa6228749039 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__from_import.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__from_import.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/from_import.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__function.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__function.py.snap index 2124ada639c52..0dbedd8e92761 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__function.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__function.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/function.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__if.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__if.py.snap index 3a30796835ed2..592cb88bad05e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__if.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__if.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/if.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__import.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__import.py.snap index b1eac233db12c..37d5ef833ac36 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__import.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__import.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/import.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__match.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__match.py.snap index 23a67df7633d5..ec88a56393c91 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__match.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__match.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/valid/statement/match.py ``` Module( ModModule { - range: 0..5743, + range: 0..5770, body: [ Match( StmtMatch { @@ -5143,7 +5143,7 @@ Module( ), Match( StmtMatch { - range: 3946..4163, + range: 3946..3978, subject: Name( ExprName { range: 3952..3953, @@ -5180,20 +5180,34 @@ Module( ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 3979..4016, + subject: Name( + ExprName { + range: 3985..3986, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 3983..4007, + range: 3992..4016, pattern: MatchAs( PatternMatchAs { - range: 3988..3994, + range: 3997..4003, pattern: Some( MatchAs( PatternMatchAs { - range: 3988..3989, + range: 3997..3998, pattern: None, name: Some( Identifier { id: Name("a"), - range: 3988..3989, + range: 3997..3998, }, ), }, @@ -5202,7 +5216,7 @@ Module( name: Some( Identifier { id: Name("b"), - range: 3993..3994, + range: 4002..4003, }, ), }, @@ -5211,32 +5225,46 @@ Module( body: [ Expr( StmtExpr { - range: 4004..4007, + range: 4013..4016, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4004..4007, + range: 4013..4016, }, ), }, ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 4017..4157, + subject: Name( + ExprName { + range: 4023..4024, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 4012..4042, + range: 4030..4060, pattern: MatchAs( PatternMatchAs { - range: 4017..4029, + range: 4035..4047, pattern: Some( MatchOr( PatternMatchOr { - range: 4017..4022, + range: 4035..4040, patterns: [ MatchValue( PatternMatchValue { - range: 4017..4018, + range: 4035..4036, value: NumberLiteral( ExprNumberLiteral { - range: 4017..4018, + range: 4035..4036, value: Int( 1, ), @@ -5246,10 +5274,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4021..4022, + range: 4039..4040, value: NumberLiteral( ExprNumberLiteral { - range: 4021..4022, + range: 4039..4040, value: Int( 2, ), @@ -5264,7 +5292,7 @@ Module( name: Some( Identifier { id: Name("two"), - range: 4026..4029, + range: 4044..4047, }, ), }, @@ -5273,10 +5301,10 @@ Module( body: [ Expr( StmtExpr { - range: 4039..4042, + range: 4057..4060, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4039..4042, + range: 4057..4060, }, ), }, @@ -5284,20 +5312,20 @@ Module( ], }, MatchCase { - range: 4047..4078, + range: 4065..4096, pattern: MatchAs( PatternMatchAs { - range: 4052..4065, + range: 4070..4083, pattern: Some( MatchValue( PatternMatchValue { - range: 4052..4058, + range: 4070..4076, value: BinOp( ExprBinOp { - range: 4052..4058, + range: 4070..4076, left: NumberLiteral( ExprNumberLiteral { - range: 4052..4053, + range: 4070..4071, value: Int( 1, ), @@ -5306,7 +5334,7 @@ Module( op: Add, right: NumberLiteral( ExprNumberLiteral { - range: 4056..4058, + range: 4074..4076, value: Complex { real: 0.0, imag: 3.0, @@ -5321,7 +5349,7 @@ Module( name: Some( Identifier { id: Name("sum"), - range: 4062..4065, + range: 4080..4083, }, ), }, @@ -5330,10 +5358,10 @@ Module( body: [ Expr( StmtExpr { - range: 4075..4078, + range: 4093..4096, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4075..4078, + range: 4093..4096, }, ), }, @@ -5341,27 +5369,27 @@ Module( ], }, MatchCase { - range: 4083..4110, + range: 4101..4128, pattern: MatchAs( PatternMatchAs { - range: 4088..4097, + range: 4106..4115, pattern: Some( MatchValue( PatternMatchValue { - range: 4088..4091, + range: 4106..4109, value: Attribute( ExprAttribute { - range: 4088..4091, + range: 4106..4109, value: Name( ExprName { - range: 4088..4089, + range: 4106..4107, id: Name("a"), ctx: Load, }, ), attr: Identifier { id: Name("b"), - range: 4090..4091, + range: 4108..4109, }, ctx: Load, }, @@ -5372,7 +5400,7 @@ Module( name: Some( Identifier { id: Name("ab"), - range: 4095..4097, + range: 4113..4115, }, ), }, @@ -5381,10 +5409,10 @@ Module( body: [ Expr( StmtExpr { - range: 4107..4110, + range: 4125..4128, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4107..4110, + range: 4125..4128, }, ), }, @@ -5392,58 +5420,72 @@ Module( ], }, MatchCase { - range: 4115..4134, + range: 4133..4157, pattern: MatchAs( PatternMatchAs { - range: 4120..4121, - pattern: None, - name: None, + range: 4138..4144, + pattern: Some( + MatchAs( + PatternMatchAs { + range: 4138..4139, + pattern: None, + name: None, + }, + ), + ), + name: Some( + Identifier { + id: Name("x"), + range: 4143..4144, + }, + ), }, ), guard: None, body: [ Expr( StmtExpr { - range: 4131..4134, + range: 4154..4157, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4131..4134, + range: 4154..4157, }, ), }, ), ], }, + ], + }, + ), + Match( + StmtMatch { + range: 4158..4190, + subject: Name( + ExprName { + range: 4164..4165, + id: Name("x"), + ctx: Load, + }, + ), + cases: [ MatchCase { - range: 4139..4163, + range: 4171..4190, pattern: MatchAs( PatternMatchAs { - range: 4144..4150, - pattern: Some( - MatchAs( - PatternMatchAs { - range: 4144..4145, - pattern: None, - name: None, - }, - ), - ), - name: Some( - Identifier { - id: Name("x"), - range: 4149..4150, - }, - ), + range: 4176..4177, + pattern: None, + name: None, }, ), guard: None, body: [ Expr( StmtExpr { - range: 4160..4163, + range: 4187..4190, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4160..4163, + range: 4187..4190, }, ), }, @@ -5455,27 +5497,27 @@ Module( ), Match( StmtMatch { - range: 4188..4439, + range: 4215..4466, subject: Name( ExprName { - range: 4194..4195, + range: 4221..4222, id: Name("x"), ctx: Load, }, ), cases: [ MatchCase { - range: 4201..4226, + range: 4228..4253, pattern: MatchSequence( PatternMatchSequence { - range: 4206..4213, + range: 4233..4240, patterns: [ MatchValue( PatternMatchValue { - range: 4206..4207, + range: 4233..4234, value: NumberLiteral( ExprNumberLiteral { - range: 4206..4207, + range: 4233..4234, value: Int( 1, ), @@ -5485,10 +5527,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4209..4210, + range: 4236..4237, value: NumberLiteral( ExprNumberLiteral { - range: 4209..4210, + range: 4236..4237, value: Int( 2, ), @@ -5498,10 +5540,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4212..4213, + range: 4239..4240, value: NumberLiteral( ExprNumberLiteral { - range: 4212..4213, + range: 4239..4240, value: Int( 3, ), @@ -5516,10 +5558,10 @@ Module( body: [ Expr( StmtExpr { - range: 4223..4226, + range: 4250..4253, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4223..4226, + range: 4250..4253, }, ), }, @@ -5527,17 +5569,17 @@ Module( ], }, MatchCase { - range: 4231..4259, + range: 4258..4286, pattern: MatchSequence( PatternMatchSequence { - range: 4236..4246, + range: 4263..4273, patterns: [ MatchValue( PatternMatchValue { - range: 4237..4238, + range: 4264..4265, value: NumberLiteral( ExprNumberLiteral { - range: 4237..4238, + range: 4264..4265, value: Int( 1, ), @@ -5547,10 +5589,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4240..4241, + range: 4267..4268, value: NumberLiteral( ExprNumberLiteral { - range: 4240..4241, + range: 4267..4268, value: Int( 2, ), @@ -5560,10 +5602,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4243..4244, + range: 4270..4271, value: NumberLiteral( ExprNumberLiteral { - range: 4243..4244, + range: 4270..4271, value: Int( 3, ), @@ -5578,10 +5620,10 @@ Module( body: [ Expr( StmtExpr { - range: 4256..4259, + range: 4283..4286, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4256..4259, + range: 4283..4286, }, ), }, @@ -5589,20 +5631,20 @@ Module( ], }, MatchCase { - range: 4264..4304, + range: 4291..4331, pattern: MatchSequence( PatternMatchSequence { - range: 4269..4291, + range: 4296..4318, patterns: [ MatchValue( PatternMatchValue { - range: 4270..4276, + range: 4297..4303, value: BinOp( ExprBinOp { - range: 4270..4276, + range: 4297..4303, left: NumberLiteral( ExprNumberLiteral { - range: 4270..4271, + range: 4297..4298, value: Int( 1, ), @@ -5611,7 +5653,7 @@ Module( op: Add, right: NumberLiteral( ExprNumberLiteral { - range: 4274..4276, + range: 4301..4303, value: Complex { real: 0.0, imag: 2.0, @@ -5624,38 +5666,38 @@ Module( ), MatchAs( PatternMatchAs { - range: 4278..4279, + range: 4305..4306, pattern: None, name: Some( Identifier { id: Name("a"), - range: 4278..4279, + range: 4305..4306, }, ), }, ), MatchSingleton( PatternMatchSingleton { - range: 4281..4285, + range: 4308..4312, value: None, }, ), MatchValue( PatternMatchValue { - range: 4287..4290, + range: 4314..4317, value: Attribute( ExprAttribute { - range: 4287..4290, + range: 4314..4317, value: Name( ExprName { - range: 4287..4288, + range: 4314..4315, id: Name("a"), ctx: Load, }, ), attr: Identifier { id: Name("b"), - range: 4289..4290, + range: 4316..4317, }, ctx: Load, }, @@ -5669,10 +5711,10 @@ Module( body: [ Expr( StmtExpr { - range: 4301..4304, + range: 4328..4331, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4301..4304, + range: 4328..4331, }, ), }, @@ -5680,25 +5722,25 @@ Module( ], }, MatchCase { - range: 4309..4343, + range: 4336..4370, pattern: MatchAs( PatternMatchAs { - range: 4314..4330, + range: 4341..4357, pattern: Some( MatchSequence( PatternMatchSequence { - range: 4314..4325, + range: 4341..4352, patterns: [ MatchAs( PatternMatchAs { - range: 4315..4321, + range: 4342..4348, pattern: Some( MatchValue( PatternMatchValue { - range: 4315..4316, + range: 4342..4343, value: NumberLiteral( ExprNumberLiteral { - range: 4315..4316, + range: 4342..4343, value: Int( 1, ), @@ -5710,19 +5752,19 @@ Module( name: Some( Identifier { id: Name("X"), - range: 4320..4321, + range: 4347..4348, }, ), }, ), MatchAs( PatternMatchAs { - range: 4323..4324, + range: 4350..4351, pattern: None, name: Some( Identifier { id: Name("b"), - range: 4323..4324, + range: 4350..4351, }, ), }, @@ -5734,7 +5776,7 @@ Module( name: Some( Identifier { id: Name("S"), - range: 4329..4330, + range: 4356..4357, }, ), }, @@ -5743,10 +5785,10 @@ Module( body: [ Expr( StmtExpr { - range: 4340..4343, + range: 4367..4370, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4340..4343, + range: 4367..4370, }, ), }, @@ -5754,17 +5796,17 @@ Module( ], }, MatchCase { - range: 4348..4380, + range: 4375..4407, pattern: MatchSequence( PatternMatchSequence { - range: 4353..4367, + range: 4380..4394, patterns: [ MatchValue( PatternMatchValue { - range: 4354..4355, + range: 4381..4382, value: NumberLiteral( ExprNumberLiteral { - range: 4354..4355, + range: 4381..4382, value: Int( 1, ), @@ -5774,10 +5816,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4357..4358, + range: 4384..4385, value: NumberLiteral( ExprNumberLiteral { - range: 4357..4358, + range: 4384..4385, value: Int( 2, ), @@ -5787,13 +5829,13 @@ Module( ), MatchValue( PatternMatchValue { - range: 4360..4366, + range: 4387..4393, value: BinOp( ExprBinOp { - range: 4360..4366, + range: 4387..4393, left: NumberLiteral( ExprNumberLiteral { - range: 4360..4361, + range: 4387..4388, value: Int( 3, ), @@ -5802,7 +5844,7 @@ Module( op: Add, right: NumberLiteral( ExprNumberLiteral { - range: 4364..4366, + range: 4391..4393, value: Complex { real: 0.0, imag: 1.0, @@ -5820,10 +5862,10 @@ Module( body: [ Expr( StmtExpr { - range: 4377..4380, + range: 4404..4407, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4377..4380, + range: 4404..4407, }, ), }, @@ -5831,21 +5873,21 @@ Module( ], }, MatchCase { - range: 4385..4413, + range: 4412..4440, pattern: MatchSequence( PatternMatchSequence { - range: 4390..4400, + range: 4417..4427, patterns: [ MatchSequence( PatternMatchSequence { - range: 4391..4396, + range: 4418..4423, patterns: [ MatchValue( PatternMatchValue { - range: 4392..4393, + range: 4419..4420, value: NumberLiteral( ExprNumberLiteral { - range: 4392..4393, + range: 4419..4420, value: Int( 1, ), @@ -5855,10 +5897,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4394..4395, + range: 4421..4422, value: NumberLiteral( ExprNumberLiteral { - range: 4394..4395, + range: 4421..4422, value: Int( 2, ), @@ -5871,10 +5913,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4398..4399, + range: 4425..4426, value: NumberLiteral( ExprNumberLiteral { - range: 4398..4399, + range: 4425..4426, value: Int( 3, ), @@ -5889,10 +5931,10 @@ Module( body: [ Expr( StmtExpr { - range: 4410..4413, + range: 4437..4440, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4410..4413, + range: 4437..4440, }, ), }, @@ -5900,17 +5942,17 @@ Module( ], }, MatchCase { - range: 4418..4439, + range: 4445..4466, pattern: MatchSequence( PatternMatchSequence { - range: 4423..4426, + range: 4450..4453, patterns: [ MatchValue( PatternMatchValue { - range: 4424..4425, + range: 4451..4452, value: NumberLiteral( ExprNumberLiteral { - range: 4424..4425, + range: 4451..4452, value: Int( 1, ), @@ -5925,10 +5967,10 @@ Module( body: [ Expr( StmtExpr { - range: 4436..4439, + range: 4463..4466, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4436..4439, + range: 4463..4466, }, ), }, @@ -5940,28 +5982,28 @@ Module( ), Match( StmtMatch { - range: 4460..4589, + range: 4487..4616, subject: Name( ExprName { - range: 4466..4467, + range: 4493..4494, id: Name("x"), ctx: Load, }, ), cases: [ MatchCase { - range: 4473..4494, + range: 4500..4521, pattern: MatchSequence( PatternMatchSequence { - range: 4478..4481, + range: 4505..4508, patterns: [ MatchStar( PatternMatchStar { - range: 4478..4480, + range: 4505..4507, name: Some( Identifier { id: Name("a"), - range: 4479..4480, + range: 4506..4507, }, ), }, @@ -5973,10 +6015,10 @@ Module( body: [ Expr( StmtExpr { - range: 4491..4494, + range: 4518..4521, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4491..4494, + range: 4518..4521, }, ), }, @@ -5984,14 +6026,14 @@ Module( ], }, MatchCase { - range: 4499..4520, + range: 4526..4547, pattern: MatchSequence( PatternMatchSequence { - range: 4504..4507, + range: 4531..4534, patterns: [ MatchStar( PatternMatchStar { - range: 4504..4506, + range: 4531..4533, name: None, }, ), @@ -6002,10 +6044,10 @@ Module( body: [ Expr( StmtExpr { - range: 4517..4520, + range: 4544..4547, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4517..4520, + range: 4544..4547, }, ), }, @@ -6013,17 +6055,17 @@ Module( ], }, MatchCase { - range: 4525..4556, + range: 4552..4583, pattern: MatchSequence( PatternMatchSequence { - range: 4530..4543, + range: 4557..4570, patterns: [ MatchValue( PatternMatchValue { - range: 4531..4532, + range: 4558..4559, value: NumberLiteral( ExprNumberLiteral { - range: 4531..4532, + range: 4558..4559, value: Int( 1, ), @@ -6033,10 +6075,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4534..4535, + range: 4561..4562, value: NumberLiteral( ExprNumberLiteral { - range: 4534..4535, + range: 4561..4562, value: Int( 2, ), @@ -6046,11 +6088,11 @@ Module( ), MatchStar( PatternMatchStar { - range: 4537..4542, + range: 4564..4569, name: Some( Identifier { id: Name("rest"), - range: 4538..4542, + range: 4565..4569, }, ), }, @@ -6062,10 +6104,10 @@ Module( body: [ Expr( StmtExpr { - range: 4553..4556, + range: 4580..4583, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4553..4556, + range: 4580..4583, }, ), }, @@ -6073,23 +6115,23 @@ Module( ], }, MatchCase { - range: 4561..4589, + range: 4588..4616, pattern: MatchSequence( PatternMatchSequence { - range: 4566..4576, + range: 4593..4603, patterns: [ MatchStar( PatternMatchStar { - range: 4567..4569, + range: 4594..4596, name: None, }, ), MatchValue( PatternMatchValue { - range: 4571..4572, + range: 4598..4599, value: NumberLiteral( ExprNumberLiteral { - range: 4571..4572, + range: 4598..4599, value: Int( 1, ), @@ -6099,10 +6141,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4574..4575, + range: 4601..4602, value: NumberLiteral( ExprNumberLiteral { - range: 4574..4575, + range: 4601..4602, value: Int( 2, ), @@ -6117,10 +6159,10 @@ Module( body: [ Expr( StmtExpr { - range: 4586..4589, + range: 4613..4616, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4586..4589, + range: 4613..4616, }, ), }, @@ -6132,29 +6174,29 @@ Module( ), Match( StmtMatch { - range: 4611..4883, + range: 4638..4910, subject: Name( ExprName { - range: 4617..4618, + range: 4644..4645, id: Name("x"), ctx: Load, }, ), cases: [ MatchCase { - range: 4624..4649, + range: 4651..4676, pattern: MatchClass( PatternMatchClass { - range: 4629..4636, + range: 4656..4663, cls: Name( ExprName { - range: 4629..4634, + range: 4656..4661, id: Name("Point"), ctx: Load, }, ), arguments: PatternArguments { - range: 4634..4636, + range: 4661..4663, patterns: [], keywords: [], }, @@ -6164,10 +6206,10 @@ Module( body: [ Expr( StmtExpr { - range: 4646..4649, + range: 4673..4676, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4646..4649, + range: 4673..4676, }, ), }, @@ -6175,39 +6217,39 @@ Module( ], }, MatchCase { - range: 4654..4683, + range: 4681..4710, pattern: MatchClass( PatternMatchClass { - range: 4659..4670, + range: 4686..4697, cls: Attribute( ExprAttribute { - range: 4659..4668, + range: 4686..4695, value: Attribute( ExprAttribute { - range: 4659..4662, + range: 4686..4689, value: Name( ExprName { - range: 4659..4660, + range: 4686..4687, id: Name("a"), ctx: Load, }, ), attr: Identifier { id: Name("b"), - range: 4661..4662, + range: 4688..4689, }, ctx: Load, }, ), attr: Identifier { id: Name("Point"), - range: 4663..4668, + range: 4690..4695, }, ctx: Load, }, ), arguments: PatternArguments { - range: 4668..4670, + range: 4695..4697, patterns: [], keywords: [], }, @@ -6217,10 +6259,10 @@ Module( body: [ Expr( StmtExpr { - range: 4680..4683, + range: 4707..4710, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4680..4683, + range: 4707..4710, }, ), }, @@ -6228,33 +6270,33 @@ Module( ], }, MatchCase { - range: 4688..4718, + range: 4715..4745, pattern: MatchClass( PatternMatchClass { - range: 4693..4705, + range: 4720..4732, cls: Name( ExprName { - range: 4693..4700, + range: 4720..4727, id: Name("Point2D"), ctx: Load, }, ), arguments: PatternArguments { - range: 4700..4705, + range: 4727..4732, patterns: [], keywords: [ PatternKeyword { - range: 4701..4704, + range: 4728..4731, attr: Identifier { id: Name("x"), - range: 4701..4702, + range: 4728..4729, }, pattern: MatchValue( PatternMatchValue { - range: 4703..4704, + range: 4730..4731, value: NumberLiteral( ExprNumberLiteral { - range: 4703..4704, + range: 4730..4731, value: Int( 0, ), @@ -6271,10 +6313,10 @@ Module( body: [ Expr( StmtExpr { - range: 4715..4718, + range: 4742..4745, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4715..4718, + range: 4742..4745, }, ), }, @@ -6282,33 +6324,33 @@ Module( ], }, MatchCase { - range: 4723..4759, + range: 4750..4786, pattern: MatchClass( PatternMatchClass { - range: 4728..4746, + range: 4755..4773, cls: Name( ExprName { - range: 4728..4735, + range: 4755..4762, id: Name("Point2D"), ctx: Load, }, ), arguments: PatternArguments { - range: 4735..4746, + range: 4762..4773, patterns: [], keywords: [ PatternKeyword { - range: 4736..4739, + range: 4763..4766, attr: Identifier { id: Name("x"), - range: 4736..4737, + range: 4763..4764, }, pattern: MatchValue( PatternMatchValue { - range: 4738..4739, + range: 4765..4766, value: NumberLiteral( ExprNumberLiteral { - range: 4738..4739, + range: 4765..4766, value: Int( 0, ), @@ -6318,17 +6360,17 @@ Module( ), }, PatternKeyword { - range: 4741..4744, + range: 4768..4771, attr: Identifier { id: Name("y"), - range: 4741..4742, + range: 4768..4769, }, pattern: MatchValue( PatternMatchValue { - range: 4743..4744, + range: 4770..4771, value: NumberLiteral( ExprNumberLiteral { - range: 4743..4744, + range: 4770..4771, value: Int( 0, ), @@ -6345,10 +6387,10 @@ Module( body: [ Expr( StmtExpr { - range: 4756..4759, + range: 4783..4786, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4756..4759, + range: 4783..4786, }, ), }, @@ -6356,26 +6398,26 @@ Module( ], }, MatchCase { - range: 4764..4795, + range: 4791..4822, pattern: MatchClass( PatternMatchClass { - range: 4769..4782, + range: 4796..4809, cls: Name( ExprName { - range: 4769..4776, + range: 4796..4803, id: Name("Point2D"), ctx: Load, }, ), arguments: PatternArguments { - range: 4776..4782, + range: 4803..4809, patterns: [ MatchValue( PatternMatchValue { - range: 4777..4778, + range: 4804..4805, value: NumberLiteral( ExprNumberLiteral { - range: 4777..4778, + range: 4804..4805, value: Int( 0, ), @@ -6385,10 +6427,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4780..4781, + range: 4807..4808, value: NumberLiteral( ExprNumberLiteral { - range: 4780..4781, + range: 4807..4808, value: Int( 1, ), @@ -6405,10 +6447,10 @@ Module( body: [ Expr( StmtExpr { - range: 4792..4795, + range: 4819..4822, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4792..4795, + range: 4819..4822, }, ), }, @@ -6416,30 +6458,30 @@ Module( ], }, MatchCase { - range: 4800..4838, + range: 4827..4865, pattern: MatchClass( PatternMatchClass { - range: 4805..4825, + range: 4832..4852, cls: Name( ExprName { - range: 4805..4812, + range: 4832..4839, id: Name("Point2D"), ctx: Load, }, ), arguments: PatternArguments { - range: 4812..4825, + range: 4839..4852, patterns: [ MatchSequence( PatternMatchSequence { - range: 4813..4819, + range: 4840..4846, patterns: [ MatchValue( PatternMatchValue { - range: 4814..4815, + range: 4841..4842, value: NumberLiteral( ExprNumberLiteral { - range: 4814..4815, + range: 4841..4842, value: Int( 0, ), @@ -6449,10 +6491,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4817..4818, + range: 4844..4845, value: NumberLiteral( ExprNumberLiteral { - range: 4817..4818, + range: 4844..4845, value: Int( 1, ), @@ -6466,17 +6508,17 @@ Module( ], keywords: [ PatternKeyword { - range: 4821..4824, + range: 4848..4851, attr: Identifier { id: Name("y"), - range: 4821..4822, + range: 4848..4849, }, pattern: MatchValue( PatternMatchValue { - range: 4823..4824, + range: 4850..4851, value: NumberLiteral( ExprNumberLiteral { - range: 4823..4824, + range: 4850..4851, value: Int( 1, ), @@ -6493,10 +6535,10 @@ Module( body: [ Expr( StmtExpr { - range: 4835..4838, + range: 4862..4865, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4835..4838, + range: 4862..4865, }, ), }, @@ -6504,37 +6546,37 @@ Module( ], }, MatchCase { - range: 4843..4883, + range: 4870..4910, pattern: MatchClass( PatternMatchClass { - range: 4848..4870, + range: 4875..4897, cls: Name( ExprName { - range: 4848..4855, + range: 4875..4882, id: Name("Point2D"), ctx: Load, }, ), arguments: PatternArguments { - range: 4855..4870, + range: 4882..4897, patterns: [], keywords: [ PatternKeyword { - range: 4856..4864, + range: 4883..4891, attr: Identifier { id: Name("x"), - range: 4856..4857, + range: 4883..4884, }, pattern: MatchSequence( PatternMatchSequence { - range: 4858..4864, + range: 4885..4891, patterns: [ MatchValue( PatternMatchValue { - range: 4859..4860, + range: 4886..4887, value: NumberLiteral( ExprNumberLiteral { - range: 4859..4860, + range: 4886..4887, value: Int( 0, ), @@ -6544,10 +6586,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4862..4863, + range: 4889..4890, value: NumberLiteral( ExprNumberLiteral { - range: 4862..4863, + range: 4889..4890, value: Int( 1, ), @@ -6560,17 +6602,17 @@ Module( ), }, PatternKeyword { - range: 4866..4869, + range: 4893..4896, attr: Identifier { id: Name("y"), - range: 4866..4867, + range: 4893..4894, }, pattern: MatchValue( PatternMatchValue { - range: 4868..4869, + range: 4895..4896, value: NumberLiteral( ExprNumberLiteral { - range: 4868..4869, + range: 4895..4896, value: Int( 1, ), @@ -6587,10 +6629,10 @@ Module( body: [ Expr( StmtExpr { - range: 4880..4883, + range: 4907..4910, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4880..4883, + range: 4907..4910, }, ), }, @@ -6602,20 +6644,20 @@ Module( ), Match( StmtMatch { - range: 4907..5001, + range: 4934..5028, subject: Named( ExprNamed { - range: 4913..4919, + range: 4940..4946, target: Name( ExprName { - range: 4913..4914, + range: 4940..4941, id: Name("x"), ctx: Store, }, ), value: Name( ExprName { - range: 4918..4919, + range: 4945..4946, id: Name("b"), ctx: Load, }, @@ -6624,14 +6666,14 @@ Module( ), cases: [ MatchCase { - range: 4925..4949, + range: 4952..4976, pattern: MatchMapping( PatternMatchMapping { - range: 4930..4936, + range: 4957..4963, keys: [ NumberLiteral( ExprNumberLiteral { - range: 4931..4932, + range: 4958..4959, value: Int( 1, ), @@ -6641,7 +6683,7 @@ Module( patterns: [ MatchAs( PatternMatchAs { - range: 4934..4935, + range: 4961..4962, pattern: None, name: None, }, @@ -6654,10 +6696,10 @@ Module( body: [ Expr( StmtExpr { - range: 4946..4949, + range: 4973..4976, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4946..4949, + range: 4973..4976, }, ), }, @@ -6665,18 +6707,18 @@ Module( ], }, MatchCase { - range: 4954..5001, + range: 4981..5028, pattern: MatchMapping( PatternMatchMapping { - range: 4959..4988, + range: 4986..5015, keys: [ StringLiteral( ExprStringLiteral { - range: 4960..4962, + range: 4987..4989, value: StringLiteralValue { inner: Single( StringLiteral { - range: 4960..4962, + range: 4987..4989, value: "", flags: StringLiteralFlags { quote_style: Single, @@ -6690,33 +6732,33 @@ Module( ), NoneLiteral( ExprNoneLiteral { - range: 4967..4971, + range: 4994..4998, }, ), ], patterns: [ MatchAs( PatternMatchAs { - range: 4964..4965, + range: 4991..4992, pattern: None, name: Some( Identifier { id: Name("a"), - range: 4964..4965, + range: 4991..4992, }, ), }, ), MatchSequence( PatternMatchSequence { - range: 4973..4979, + range: 5000..5006, patterns: [ MatchValue( PatternMatchValue { - range: 4974..4975, + range: 5001..5002, value: NumberLiteral( ExprNumberLiteral { - range: 4974..4975, + range: 5001..5002, value: Int( 1, ), @@ -6726,10 +6768,10 @@ Module( ), MatchValue( PatternMatchValue { - range: 4977..4978, + range: 5004..5005, value: NumberLiteral( ExprNumberLiteral { - range: 4977..4978, + range: 5004..5005, value: Int( 2, ), @@ -6744,7 +6786,7 @@ Module( rest: Some( Identifier { id: Name("rest"), - range: 4983..4987, + range: 5010..5014, }, ), }, @@ -6753,10 +6795,10 @@ Module( body: [ Expr( StmtExpr { - range: 4998..5001, + range: 5025..5028, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 4998..5001, + range: 5025..5028, }, ), }, @@ -6768,25 +6810,25 @@ Module( ), Match( StmtMatch { - range: 5019..5079, + range: 5046..5106, subject: Name( ExprName { - range: 5025..5026, + range: 5052..5053, id: Name("y"), ctx: Load, }, ), cases: [ MatchCase { - range: 5032..5053, + range: 5059..5080, pattern: MatchAs( PatternMatchAs { - range: 5037..5038, + range: 5064..5065, pattern: None, name: Some( Identifier { id: Name("a"), - range: 5037..5038, + range: 5064..5065, }, ), }, @@ -6794,17 +6836,17 @@ Module( guard: Some( Named( ExprNamed { - range: 5042..5048, + range: 5069..5075, target: Name( ExprName { - range: 5042..5043, + range: 5069..5070, id: Name("b"), ctx: Store, }, ), value: Name( ExprName { - range: 5047..5048, + range: 5074..5075, id: Name("c"), ctx: Load, }, @@ -6815,10 +6857,10 @@ Module( body: [ Expr( StmtExpr { - range: 5050..5053, + range: 5077..5080, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 5050..5053, + range: 5077..5080, }, ), }, @@ -6826,15 +6868,15 @@ Module( ], }, MatchCase { - range: 5058..5079, + range: 5085..5106, pattern: MatchAs( PatternMatchAs { - range: 5063..5064, + range: 5090..5091, pattern: None, name: Some( Identifier { id: Name("e"), - range: 5063..5064, + range: 5090..5091, }, ), }, @@ -6842,10 +6884,10 @@ Module( guard: Some( Compare( ExprCompare { - range: 5069..5074, + range: 5096..5101, left: NumberLiteral( ExprNumberLiteral { - range: 5069..5070, + range: 5096..5097, value: Int( 1, ), @@ -6857,7 +6899,7 @@ Module( comparators: [ NumberLiteral( ExprNumberLiteral { - range: 5073..5074, + range: 5100..5101, value: Int( 2, ), @@ -6870,10 +6912,10 @@ Module( body: [ Expr( StmtExpr { - range: 5076..5079, + range: 5103..5106, value: EllipsisLiteral( ExprEllipsisLiteral { - range: 5076..5079, + range: 5103..5106, }, ), }, @@ -6885,20 +6927,20 @@ Module( ), Expr( StmtExpr { - range: 5108..5123, + range: 5135..5150, value: Tuple( ExprTuple { - range: 5108..5123, + range: 5135..5150, elts: [ BinOp( ExprBinOp { - range: 5108..5120, + range: 5135..5147, left: BinOp( ExprBinOp { - range: 5108..5116, + range: 5135..5143, left: Name( ExprName { - range: 5108..5113, + range: 5135..5140, id: Name("match"), ctx: Load, }, @@ -6906,7 +6948,7 @@ Module( op: Mult, right: Name( ExprName { - range: 5115..5116, + range: 5142..5143, id: Name("a"), ctx: Load, }, @@ -6916,7 +6958,7 @@ Module( op: Add, right: Name( ExprName { - range: 5119..5120, + range: 5146..5147, id: Name("b"), ctx: Load, }, @@ -6925,7 +6967,7 @@ Module( ), Name( ExprName { - range: 5122..5123, + range: 5149..5150, id: Name("c"), ctx: Load, }, @@ -6939,17 +6981,17 @@ Module( ), Expr( StmtExpr { - range: 5149..5166, + range: 5176..5193, value: Tuple( ExprTuple { - range: 5149..5166, + range: 5176..5193, elts: [ BinOp( ExprBinOp { - range: 5149..5163, + range: 5176..5190, left: Name( ExprName { - range: 5149..5154, + range: 5176..5181, id: Name("match"), ctx: Load, }, @@ -6957,10 +6999,10 @@ Module( op: Mult, right: BinOp( ExprBinOp { - range: 5157..5162, + range: 5184..5189, left: Name( ExprName { - range: 5157..5158, + range: 5184..5185, id: Name("a"), ctx: Load, }, @@ -6968,7 +7010,7 @@ Module( op: Add, right: Name( ExprName { - range: 5161..5162, + range: 5188..5189, id: Name("b"), ctx: Load, }, @@ -6979,7 +7021,7 @@ Module( ), Name( ExprName { - range: 5165..5166, + range: 5192..5193, id: Name("c"), ctx: Load, }, @@ -6993,29 +7035,29 @@ Module( ), Expr( StmtExpr { - range: 5192..5209, + range: 5219..5236, value: Call( ExprCall { - range: 5192..5209, + range: 5219..5236, func: Name( ExprName { - range: 5192..5197, + range: 5219..5224, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5198..5209, + range: 5225..5236, args: [ Starred( ExprStarred { - range: 5199..5205, + range: 5226..5232, value: BinOp( ExprBinOp { - range: 5200..5205, + range: 5227..5232, left: Name( ExprName { - range: 5200..5201, + range: 5227..5228, id: Name("a"), ctx: Load, }, @@ -7023,7 +7065,7 @@ Module( op: Add, right: Name( ExprName { - range: 5204..5205, + range: 5231..5232, id: Name("b"), ctx: Load, }, @@ -7035,7 +7077,7 @@ Module( ), Name( ExprName { - range: 5207..5208, + range: 5234..5235, id: Name("c"), ctx: Load, }, @@ -7049,16 +7091,16 @@ Module( ), Expr( StmtExpr { - range: 5236..5252, + range: 5263..5279, value: BinOp( ExprBinOp { - range: 5236..5252, + range: 5263..5279, left: BinOp( ExprBinOp { - range: 5236..5248, + range: 5263..5275, left: Name( ExprName { - range: 5236..5241, + range: 5263..5268, id: Name("match"), ctx: Load, }, @@ -7066,10 +7108,10 @@ Module( op: Sub, right: BinOp( ExprBinOp { - range: 5243..5248, + range: 5270..5275, left: Name( ExprName { - range: 5243..5244, + range: 5270..5271, id: Name("a"), ctx: Load, }, @@ -7077,7 +7119,7 @@ Module( op: Mult, right: Name( ExprName { - range: 5247..5248, + range: 5274..5275, id: Name("b"), ctx: Load, }, @@ -7089,7 +7131,7 @@ Module( op: Add, right: Name( ExprName { - range: 5251..5252, + range: 5278..5279, id: Name("c"), ctx: Load, }, @@ -7100,16 +7142,16 @@ Module( ), Expr( StmtExpr { - range: 5279..5297, + range: 5306..5324, value: BinOp( ExprBinOp { - range: 5279..5297, + range: 5306..5324, left: BinOp( ExprBinOp { - range: 5279..5293, + range: 5306..5320, left: Name( ExprName { - range: 5279..5284, + range: 5306..5311, id: Name("match"), ctx: Load, }, @@ -7117,10 +7159,10 @@ Module( op: Sub, right: BinOp( ExprBinOp { - range: 5287..5292, + range: 5314..5319, left: Name( ExprName { - range: 5287..5288, + range: 5314..5315, id: Name("a"), ctx: Load, }, @@ -7128,7 +7170,7 @@ Module( op: Mult, right: Name( ExprName { - range: 5291..5292, + range: 5318..5319, id: Name("b"), ctx: Load, }, @@ -7140,7 +7182,7 @@ Module( op: Add, right: Name( ExprName { - range: 5296..5297, + range: 5323..5324, id: Name("c"), ctx: Load, }, @@ -7151,33 +7193,33 @@ Module( ), Expr( StmtExpr { - range: 5324..5342, + range: 5351..5369, value: BinOp( ExprBinOp { - range: 5324..5342, + range: 5351..5369, left: BinOp( ExprBinOp { - range: 5324..5338, + range: 5351..5365, left: Call( ExprCall { - range: 5324..5334, + range: 5351..5361, func: Name( ExprName { - range: 5324..5329, + range: 5351..5356, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5330..5334, + range: 5357..5361, args: [ UnaryOp( ExprUnaryOp { - range: 5331..5333, + range: 5358..5360, op: USub, operand: Name( ExprName { - range: 5332..5333, + range: 5359..5360, id: Name("a"), ctx: Load, }, @@ -7192,7 +7234,7 @@ Module( op: Mult, right: Name( ExprName { - range: 5337..5338, + range: 5364..5365, id: Name("b"), ctx: Load, }, @@ -7202,7 +7244,7 @@ Module( op: Add, right: Name( ExprName { - range: 5341..5342, + range: 5368..5369, id: Name("c"), ctx: Load, }, @@ -7213,22 +7255,22 @@ Module( ), Expr( StmtExpr { - range: 5370..5380, + range: 5397..5407, value: Attribute( ExprAttribute { - range: 5370..5380, + range: 5397..5407, value: Call( ExprCall { - range: 5370..5378, + range: 5397..5405, func: Name( ExprName { - range: 5370..5375, + range: 5397..5402, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5376..5378, + range: 5403..5405, args: [], keywords: [], }, @@ -7236,7 +7278,7 @@ Module( ), attr: Identifier { id: Name("a"), - range: 5379..5380, + range: 5406..5407, }, ctx: Load, }, @@ -7245,26 +7287,26 @@ Module( ), Expr( StmtExpr { - range: 5397..5409, + range: 5424..5436, value: Attribute( ExprAttribute { - range: 5397..5409, + range: 5424..5436, value: Call( ExprCall { - range: 5397..5407, + range: 5424..5434, func: Name( ExprName { - range: 5397..5402, + range: 5424..5429, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5403..5407, + range: 5430..5434, args: [ Tuple( ExprTuple { - range: 5404..5406, + range: 5431..5433, elts: [], ctx: Load, parenthesized: true, @@ -7277,7 +7319,7 @@ Module( ), attr: Identifier { id: Name("a"), - range: 5408..5409, + range: 5435..5436, }, ctx: Load, }, @@ -7286,26 +7328,26 @@ Module( ), Expr( StmtExpr { - range: 5428..5441, + range: 5455..5468, value: Attribute( ExprAttribute { - range: 5428..5441, + range: 5455..5468, value: Call( ExprCall { - range: 5428..5439, + range: 5455..5466, func: Name( ExprName { - range: 5428..5433, + range: 5455..5460, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5434..5439, + range: 5461..5466, args: [ Tuple( ExprTuple { - range: 5435..5437, + range: 5462..5464, elts: [], ctx: Load, parenthesized: true, @@ -7318,7 +7360,7 @@ Module( ), attr: Identifier { id: Name("a"), - range: 5440..5441, + range: 5467..5468, }, ctx: Load, }, @@ -7327,23 +7369,23 @@ Module( ), Expr( StmtExpr { - range: 5460..5471, + range: 5487..5498, value: Attribute( ExprAttribute { - range: 5460..5471, + range: 5487..5498, value: Subscript( ExprSubscript { - range: 5460..5469, + range: 5487..5496, value: Name( ExprName { - range: 5460..5465, + range: 5487..5492, id: Name("match"), ctx: Load, }, ), slice: Name( ExprName { - range: 5467..5468, + range: 5494..5495, id: Name("a"), ctx: Load, }, @@ -7353,7 +7395,7 @@ Module( ), attr: Identifier { id: Name("b"), - range: 5470..5471, + range: 5497..5498, }, ctx: Load, }, @@ -7362,27 +7404,27 @@ Module( ), Expr( StmtExpr { - range: 5489..5501, + range: 5516..5528, value: Attribute( ExprAttribute { - range: 5489..5501, + range: 5516..5528, value: Subscript( ExprSubscript { - range: 5489..5499, + range: 5516..5526, value: Name( ExprName { - range: 5489..5494, + range: 5516..5521, id: Name("match"), ctx: Load, }, ), slice: Tuple( ExprTuple { - range: 5496..5498, + range: 5523..5525, elts: [ Name( ExprName { - range: 5496..5497, + range: 5523..5524, id: Name("a"), ctx: Load, }, @@ -7397,7 +7439,7 @@ Module( ), attr: Identifier { id: Name("b"), - range: 5500..5501, + range: 5527..5528, }, ctx: Load, }, @@ -7406,27 +7448,27 @@ Module( ), Expr( StmtExpr { - range: 5542..5556, + range: 5569..5583, value: Attribute( ExprAttribute { - range: 5542..5556, + range: 5569..5583, value: Subscript( ExprSubscript { - range: 5542..5554, + range: 5569..5581, value: Name( ExprName { - range: 5542..5547, + range: 5569..5574, id: Name("match"), ctx: Load, }, ), slice: Tuple( ExprTuple { - range: 5549..5553, + range: 5576..5580, elts: [ Name( ExprName { - range: 5550..5551, + range: 5577..5578, id: Name("a"), ctx: Load, }, @@ -7441,7 +7483,7 @@ Module( ), attr: Identifier { id: Name("b"), - range: 5555..5556, + range: 5582..5583, }, ctx: Load, }, @@ -7450,22 +7492,22 @@ Module( ), Expr( StmtExpr { - range: 5577..5594, + range: 5604..5621, value: Subscript( ExprSubscript { - range: 5577..5594, + range: 5604..5621, value: Call( ExprCall { - range: 5577..5584, + range: 5604..5611, func: Name( ExprName { - range: 5577..5582, + range: 5604..5609, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5582..5584, + range: 5609..5611, args: [], keywords: [], }, @@ -7473,11 +7515,11 @@ Module( ), slice: Slice( ExprSlice { - range: 5585..5593, + range: 5612..5620, lower: Some( Name( ExprName { - range: 5585..5586, + range: 5612..5613, id: Name("a"), ctx: Load, }, @@ -7486,7 +7528,7 @@ Module( upper: Some( Name( ExprName { - range: 5592..5593, + range: 5619..5620, id: Name("b"), ctx: Load, }, @@ -7502,20 +7544,20 @@ Module( ), If( StmtIf { - range: 5614..5633, + range: 5641..5660, test: Named( ExprNamed { - range: 5617..5627, + range: 5644..5654, target: Name( ExprName { - range: 5617..5622, + range: 5644..5649, id: Name("match"), ctx: Store, }, ), value: NumberLiteral( ExprNumberLiteral { - range: 5626..5627, + range: 5653..5654, value: Int( 1, ), @@ -7526,7 +7568,7 @@ Module( body: [ Pass( StmtPass { - range: 5629..5633, + range: 5656..5660, }, ), ], @@ -7535,23 +7577,23 @@ Module( ), Match( StmtMatch { - range: 5634..5688, + range: 5661..5715, subject: Name( ExprName { - range: 5640..5645, + range: 5667..5672, id: Name("match"), ctx: Load, }, ), cases: [ MatchCase { - range: 5651..5663, + range: 5678..5690, pattern: MatchValue( PatternMatchValue { - range: 5656..5657, + range: 5683..5684, value: NumberLiteral( ExprNumberLiteral { - range: 5656..5657, + range: 5683..5684, value: Int( 1, ), @@ -7563,19 +7605,19 @@ Module( body: [ Pass( StmtPass { - range: 5659..5663, + range: 5686..5690, }, ), ], }, MatchCase { - range: 5668..5688, + range: 5695..5715, pattern: MatchValue( PatternMatchValue { - range: 5673..5674, + range: 5700..5701, value: NumberLiteral( ExprNumberLiteral { - range: 5673..5674, + range: 5700..5701, value: Int( 2, ), @@ -7587,7 +7629,7 @@ Module( body: [ Pass( StmtPass { - range: 5684..5688, + range: 5711..5715, }, ), ], @@ -7597,11 +7639,11 @@ Module( ), Assign( StmtAssign { - range: 5689..5725, + range: 5716..5752, targets: [ Name( ExprName { - range: 5689..5694, + range: 5716..5721, id: Name("match"), ctx: Store, }, @@ -7609,19 +7651,19 @@ Module( ], value: Lambda( ExprLambda { - range: 5697..5725, + range: 5724..5752, parameters: Some( Parameters { - range: 5704..5709, + range: 5731..5736, posonlyargs: [], args: [ ParameterWithDefault { - range: 5704..5709, + range: 5731..5736, parameter: Parameter { - range: 5704..5709, + range: 5731..5736, name: Identifier { id: Name("query"), - range: 5704..5709, + range: 5731..5736, }, annotation: None, }, @@ -7635,10 +7677,10 @@ Module( ), body: Compare( ExprCompare { - range: 5711..5725, + range: 5738..5752, left: Name( ExprName { - range: 5711..5716, + range: 5738..5743, id: Name("query"), ctx: Load, }, @@ -7649,7 +7691,7 @@ Module( comparators: [ Name( ExprName { - range: 5720..5725, + range: 5747..5752, id: Name("event"), ctx: Load, }, @@ -7663,36 +7705,36 @@ Module( ), Expr( StmtExpr { - range: 5726..5742, + range: 5753..5769, value: Call( ExprCall { - range: 5726..5742, + range: 5753..5769, func: Name( ExprName { - range: 5726..5731, + range: 5753..5758, id: Name("print"), ctx: Load, }, ), arguments: Arguments { - range: 5731..5742, + range: 5758..5769, args: [ Call( ExprCall { - range: 5732..5741, + range: 5759..5768, func: Name( ExprName { - range: 5732..5737, + range: 5759..5764, id: Name("match"), ctx: Load, }, ), arguments: Arguments { - range: 5737..5741, + range: 5764..5768, args: [ NumberLiteral( ExprNumberLiteral { - range: 5738..5740, + range: 5765..5767, value: Int( 12, ), diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__raise.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__raise.py.snap index 72c23fa3eb2a3..1796953d2ae17 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__raise.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__raise.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/raise.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__return.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__return.py.snap index 0d95c4a3b9e40..162b1c9c347de 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__return.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__return.py.snap @@ -7,7 +7,7 @@ input_file: crates/ruff_python_parser/resources/valid/statement/return.py ``` Module( ModModule { - range: 0..191, + range: 0..167, body: [ Return( StmtReturn { @@ -31,71 +31,18 @@ Module( ), Return( StmtReturn { - range: 16..25, - value: Some( - Starred( - ExprStarred { - range: 23..25, - value: Name( - ExprName { - range: 24..25, - id: Name("x"), - ctx: Load, - }, - ), - ctx: Load, - }, - ), - ), - }, - ), - Return( - StmtReturn { - range: 26..39, - value: Some( - Starred( - ExprStarred { - range: 33..39, - value: BinOp( - ExprBinOp { - range: 34..39, - left: Name( - ExprName { - range: 34..35, - id: Name("x"), - ctx: Load, - }, - ), - op: BitOr, - right: Name( - ExprName { - range: 38..39, - id: Name("y"), - ctx: Load, - }, - ), - }, - ), - ctx: Load, - }, - ), - ), - }, - ), - Return( - StmtReturn { - range: 40..53, + range: 16..29, value: Some( Tuple( ExprTuple { - range: 47..53, + range: 23..29, elts: [ Starred( ExprStarred { - range: 47..49, + range: 23..25, value: Name( ExprName { - range: 48..49, + range: 24..25, id: Name("x"), ctx: Load, }, @@ -105,10 +52,10 @@ Module( ), Starred( ExprStarred { - range: 51..53, + range: 27..29, value: Name( ExprName { - range: 52..53, + range: 28..29, id: Name("y"), ctx: Load, }, @@ -126,21 +73,21 @@ Module( ), Return( StmtReturn { - range: 54..69, + range: 30..45, value: Some( Named( ExprNamed { - range: 62..68, + range: 38..44, target: Name( ExprName { - range: 62..63, + range: 38..39, id: Name("x"), ctx: Store, }, ), value: NumberLiteral( ExprNumberLiteral { - range: 67..68, + range: 43..44, value: Int( 1, ), @@ -153,11 +100,11 @@ Module( ), Return( StmtReturn { - range: 70..81, + range: 46..57, value: Some( NoneLiteral( ExprNoneLiteral { - range: 77..81, + range: 53..57, }, ), ), @@ -165,23 +112,23 @@ Module( ), Return( StmtReturn { - range: 82..96, + range: 58..72, value: Some( BoolOp( ExprBoolOp { - range: 89..96, + range: 65..72, op: And, values: [ Name( ExprName { - range: 89..90, + range: 65..66, id: Name("x"), ctx: Load, }, ), Name( ExprName { - range: 95..96, + range: 71..72, id: Name("y"), ctx: Load, }, @@ -194,14 +141,14 @@ Module( ), Return( StmtReturn { - range: 97..109, + range: 73..85, value: Some( Compare( ExprCompare { - range: 104..109, + range: 80..85, left: NumberLiteral( ExprNumberLiteral { - range: 104..105, + range: 80..81, value: Int( 1, ), @@ -213,7 +160,7 @@ Module( comparators: [ NumberLiteral( ExprNumberLiteral { - range: 108..109, + range: 84..85, value: Int( 2, ), @@ -227,15 +174,15 @@ Module( ), Return( StmtReturn { - range: 110..122, + range: 86..98, value: Some( Tuple( ExprTuple { - range: 117..122, + range: 93..98, elts: [ NumberLiteral( ExprNumberLiteral { - range: 117..118, + range: 93..94, value: Int( 1, ), @@ -243,7 +190,7 @@ Module( ), NumberLiteral( ExprNumberLiteral { - range: 120..121, + range: 96..97, value: Int( 2, ), @@ -259,20 +206,20 @@ Module( ), Return( StmtReturn { - range: 123..136, + range: 99..112, value: Some( Call( ExprCall { - range: 130..136, + range: 106..112, func: Name( ExprName { - range: 130..134, + range: 106..110, id: Name("call"), ctx: Load, }, ), arguments: Arguments { - range: 134..136, + range: 110..112, args: [], keywords: [], }, @@ -283,30 +230,30 @@ Module( ), Return( StmtReturn { - range: 137..156, + range: 113..132, value: Some( Call( ExprCall { - range: 144..156, + range: 120..132, func: Attribute( ExprAttribute { - range: 144..154, + range: 120..130, value: Name( ExprName { - range: 144..148, + range: 120..124, id: Name("attr"), ctx: Load, }, ), attr: Identifier { id: Name("value"), - range: 149..154, + range: 125..130, }, ctx: Load, }, ), arguments: Arguments { - range: 154..156, + range: 130..132, args: [], keywords: [], }, @@ -317,14 +264,14 @@ Module( ), Return( StmtReturn { - range: 157..171, + range: 133..147, value: Some( Await( ExprAwait { - range: 164..171, + range: 140..147, value: Name( ExprName { - range: 170..171, + range: 146..147, id: Name("x"), ctx: Load, }, @@ -336,23 +283,23 @@ Module( ), Return( StmtReturn { - range: 172..190, + range: 148..166, value: Some( Lambda( ExprLambda { - range: 179..190, + range: 155..166, parameters: Some( Parameters { - range: 186..187, + range: 162..163, posonlyargs: [], args: [ ParameterWithDefault { - range: 186..187, + range: 162..163, parameter: Parameter { - range: 186..187, + range: 162..163, name: Identifier { id: Name("x"), - range: 186..187, + range: 162..163, }, annotation: None, }, @@ -366,7 +313,7 @@ Module( ), body: Name( ExprName { - range: 189..190, + range: 165..166, id: Name("y"), ctx: Load, }, diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__simple.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__simple.py.snap index 24b5e0e5e4287..31c90f21190e9 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__simple.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__simple.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/simple.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__try.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__try.py.snap index 52ddc068aa6c0..3f799c4d6b0de 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__try.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__try.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/try.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__type.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__type.py.snap index 66cb26caef939..817ab6399e0e5 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__type.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__type.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/type.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__while.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__while.py.snap index 5ffa7409f8635..a70b73cc90e20 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__while.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__while.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/while.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__with.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__with.py.snap index a47b5f485f90e..260f39d072d03 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__with.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@statement__with.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/valid/statement/with.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@tuple_context_manager_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@tuple_context_manager_py38.py.snap new file mode 100644 index 0000000000000..70180394159ad --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@tuple_context_manager_py38.py.snap @@ -0,0 +1,77 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/tuple_context_manager_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..85, + body: [ + With( + StmtWith { + range: 43..84, + is_async: false, + items: [ + WithItem { + range: 48..79, + context_expr: Tuple( + ExprTuple { + range: 48..72, + elts: [ + Name( + ExprName { + range: 52..55, + id: Name("foo"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 59..62, + id: Name("bar"), + ctx: Load, + }, + ), + Name( + ExprName { + range: 66..69, + id: Name("baz"), + ctx: Load, + }, + ), + ], + ctx: Load, + parenthesized: true, + }, + ), + optional_vars: Some( + Name( + ExprName { + range: 76..79, + id: Name("tup"), + ctx: Store, + }, + ), + ), + }, + ], + body: [ + Expr( + StmtExpr { + range: 81..84, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 81..84, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_default_py313.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_default_py313.py.snap new file mode 100644 index 0000000000000..010da9ab55202 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_default_py313.py.snap @@ -0,0 +1,173 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/type_param_default_py313.py +--- +## AST + +``` +Module( + ModModule { + range: 0..112, + body: [ + TypeAlias( + StmtTypeAlias { + range: 44..65, + name: Name( + ExprName { + range: 49..50, + id: Name("X"), + ctx: Store, + }, + ), + type_params: Some( + TypeParams { + range: 50..59, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 51..58, + name: Identifier { + id: Name("T"), + range: 51..52, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 55..58, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + value: Name( + ExprName { + range: 62..65, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + FunctionDef( + StmtFunctionDef { + range: 66..87, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 70..71, + }, + type_params: Some( + TypeParams { + range: 71..80, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 72..79, + name: Identifier { + id: Name("T"), + range: 72..73, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 76..79, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + parameters: Parameters { + range: 80..82, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 84..87, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 84..87, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 88..111, + decorator_list: [], + name: Identifier { + id: Name("C"), + range: 94..95, + }, + type_params: Some( + TypeParams { + range: 95..104, + type_params: [ + TypeVar( + TypeParamTypeVar { + range: 96..103, + name: Identifier { + id: Name("T"), + range: 96..97, + }, + bound: None, + default: Some( + Name( + ExprName { + range: 100..103, + id: Name("int"), + ctx: Load, + }, + ), + ), + }, + ), + ], + }, + ), + arguments: Some( + Arguments { + range: 104..106, + args: [], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 108..111, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 108..111, + }, + ), + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_param_spec.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_param_spec.py.snap index 50f272c73da85..ad273b844ca88 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_param_spec.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_param_spec.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/type_param_param_spec.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var.py.snap index 79f83f99f8187..5f5cf396a8aae 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/type_param_type_var.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var_tuple.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var_tuple.py.snap index 0c3ef6ff94a4d..93e16848e431e 100644 --- a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var_tuple.py.snap +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_param_type_var_tuple.py.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_parser/tests/fixtures.rs input_file: crates/ruff_python_parser/resources/inline/ok/type_param_type_var_tuple.py +snapshot_kind: text --- ## AST diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_stmt_py312.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_stmt_py312.py.snap new file mode 100644 index 0000000000000..62eeead56c1fc --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@type_stmt_py312.py.snap @@ -0,0 +1,35 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/type_stmt_py312.py +--- +## AST + +``` +Module( + ModModule { + range: 0..57, + body: [ + TypeAlias( + StmtTypeAlias { + range: 44..56, + name: Name( + ExprName { + range: 49..50, + id: Name("x"), + ctx: Store, + }, + ), + type_params: None, + value: Name( + ExprName { + range: 53..56, + id: Name("int"), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_index_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_index_py39.py.snap new file mode 100644 index 0000000000000..e3329425de8f7 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_index_py39.py.snap @@ -0,0 +1,53 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_index_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..53, + body: [ + Expr( + StmtExpr { + range: 43..52, + value: Subscript( + ExprSubscript { + range: 43..52, + value: Name( + ExprName { + range: 43..46, + id: Name("lst"), + ctx: Load, + }, + ), + slice: Named( + ExprNamed { + range: 47..51, + target: Name( + ExprName { + range: 47..48, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 50..51, + value: Int( + 1, + ), + }, + ), + }, + ), + ctx: Load, + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_py39.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_py39.py.snap new file mode 100644 index 0000000000000..33d284c9b569a --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@unparenthesized_named_expr_py39.py.snap @@ -0,0 +1,132 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/unparenthesized_named_expr_py39.py +--- +## AST + +``` +Module( + ModModule { + range: 0..88, + body: [ + Expr( + StmtExpr { + range: 43..57, + value: Set( + ExprSet { + range: 43..57, + elts: [ + Named( + ExprNamed { + range: 44..50, + target: Name( + ExprName { + range: 44..45, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 49..50, + value: Int( + 1, + ), + }, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 52..53, + value: Int( + 2, + ), + }, + ), + NumberLiteral( + ExprNumberLiteral { + range: 55..56, + value: Int( + 3, + ), + }, + ), + ], + }, + ), + }, + ), + Expr( + StmtExpr { + range: 58..87, + value: SetComp( + ExprSetComp { + range: 58..87, + elt: Named( + ExprNamed { + range: 59..68, + target: Name( + ExprName { + range: 59..63, + id: Name("last"), + ctx: Store, + }, + ), + value: Name( + ExprName { + range: 67..68, + id: Name("x"), + ctx: Load, + }, + ), + }, + ), + generators: [ + Comprehension { + range: 69..86, + target: Name( + ExprName { + range: 73..74, + id: Name("x"), + ctx: Store, + }, + ), + iter: Call( + ExprCall { + range: 78..86, + func: Name( + ExprName { + range: 78..83, + id: Name("range"), + ctx: Load, + }, + ), + arguments: Arguments { + range: 83..86, + args: [ + NumberLiteral( + ExprNumberLiteral { + range: 84..85, + value: Int( + 3, + ), + }, + ), + ], + keywords: [], + }, + }, + ), + ifs: [], + is_async: false, + }, + ], + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_class.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_class.py.snap new file mode 100644 index 0000000000000..feeea973fbc0d --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_class.py.snap @@ -0,0 +1,245 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/valid_annotation_class.py +--- +## AST + +``` +Module( + ModModule { + range: 0..137, + body: [ + ClassDef( + StmtClassDef { + range: 0..23, + decorator_list: [], + name: Identifier { + id: Name("F"), + range: 6..7, + }, + type_params: None, + arguments: Some( + Arguments { + range: 7..18, + args: [ + Named( + ExprNamed { + range: 8..17, + target: Name( + ExprName { + range: 8..9, + id: Name("y"), + ctx: Store, + }, + ), + value: Name( + ExprName { + range: 13..17, + id: Name("list"), + ctx: Load, + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 20..23, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 20..23, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 24..93, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 28..29, + }, + type_params: None, + parameters: Parameters { + range: 29..31, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + ClassDef( + StmtClassDef { + range: 37..60, + decorator_list: [], + name: Identifier { + id: Name("G"), + range: 43..44, + }, + type_params: None, + arguments: Some( + Arguments { + range: 44..55, + args: [ + Yield( + ExprYield { + range: 46..53, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 52..53, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 57..60, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 57..60, + }, + ), + }, + ), + ], + }, + ), + ClassDef( + StmtClassDef { + range: 65..93, + decorator_list: [], + name: Identifier { + id: Name("H"), + range: 71..72, + }, + type_params: None, + arguments: Some( + Arguments { + range: 72..88, + args: [ + YieldFrom( + ExprYieldFrom { + range: 74..86, + value: NumberLiteral( + ExprNumberLiteral { + range: 85..86, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 90..93, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 90..93, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 94..136, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 104..105, + }, + type_params: None, + parameters: Parameters { + range: 105..107, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + ClassDef( + StmtClassDef { + range: 113..136, + decorator_list: [], + name: Identifier { + id: Name("G"), + range: 119..120, + }, + type_params: None, + arguments: Some( + Arguments { + range: 120..131, + args: [ + Await( + ExprAwait { + range: 122..129, + value: NumberLiteral( + ExprNumberLiteral { + range: 128..129, + value: Int( + 1, + ), + }, + ), + }, + ), + ], + keywords: [], + }, + ), + body: [ + Expr( + StmtExpr { + range: 133..136, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 133..136, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_function_py313.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_function_py313.py.snap new file mode 100644 index 0000000000000..1a58dffba2596 --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_function_py313.py.snap @@ -0,0 +1,507 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/valid_annotation_function_py313.py +--- +## AST + +``` +Module( + ModModule { + range: 0..316, + body: [ + FunctionDef( + StmtFunctionDef { + range: 44..68, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 48..49, + }, + type_params: None, + parameters: Parameters { + range: 49..51, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Named( + ExprNamed { + range: 56..62, + target: Name( + ExprName { + range: 56..57, + id: Name("y"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 61..62, + value: Int( + 3, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 65..68, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 65..68, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 69..94, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 73..74, + }, + type_params: None, + parameters: Parameters { + range: 74..89, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 75..88, + parameter: Parameter { + range: 75..88, + name: Identifier { + id: Name("arg"), + range: 75..78, + }, + annotation: Some( + Named( + ExprNamed { + range: 81..87, + target: Name( + ExprName { + range: 81..82, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 86..87, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 91..94, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 91..94, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 95..235, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 99..104, + }, + type_params: None, + parameters: Parameters { + range: 104..106, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 112..136, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("i"), + range: 116..117, + }, + type_params: None, + parameters: Parameters { + range: 117..131, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 118..130, + parameter: Parameter { + range: 118..130, + name: Identifier { + id: Name("x"), + range: 118..119, + }, + annotation: Some( + Yield( + ExprYield { + range: 122..129, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 128..129, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 133..136, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 133..136, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 141..166, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("k"), + range: 145..146, + }, + type_params: None, + parameters: Parameters { + range: 146..148, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Yield( + ExprYield { + range: 153..160, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 159..160, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 163..166, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 163..166, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 171..200, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("m"), + range: 175..176, + }, + type_params: None, + parameters: Parameters { + range: 176..195, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 177..194, + parameter: Parameter { + range: 177..194, + name: Identifier { + id: Name("x"), + range: 177..178, + }, + annotation: Some( + YieldFrom( + ExprYieldFrom { + range: 181..193, + value: NumberLiteral( + ExprNumberLiteral { + range: 192..193, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 197..200, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 197..200, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 205..235, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("o"), + range: 209..210, + }, + type_params: None, + parameters: Parameters { + range: 210..212, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + YieldFrom( + ExprYieldFrom { + range: 217..229, + value: NumberLiteral( + ExprNumberLiteral { + range: 228..229, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 232..235, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 232..235, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 236..315, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 246..251, + }, + type_params: None, + parameters: Parameters { + range: 251..253, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + FunctionDef( + StmtFunctionDef { + range: 259..284, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("f"), + range: 263..264, + }, + type_params: None, + parameters: Parameters { + range: 264..266, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: Some( + Await( + ExprAwait { + range: 271..278, + value: NumberLiteral( + ExprNumberLiteral { + range: 277..278, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + body: [ + Expr( + StmtExpr { + range: 281..284, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 281..284, + }, + ), + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 289..315, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("g"), + range: 293..294, + }, + type_params: None, + parameters: Parameters { + range: 294..310, + posonlyargs: [], + args: [ + ParameterWithDefault { + range: 295..309, + parameter: Parameter { + range: 295..309, + name: Identifier { + id: Name("arg"), + range: 295..298, + }, + annotation: Some( + Await( + ExprAwait { + range: 301..308, + value: NumberLiteral( + ExprNumberLiteral { + range: 307..308, + value: Int( + 1, + ), + }, + ), + }, + ), + ), + }, + default: None, + }, + ], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + Expr( + StmtExpr { + range: 312..315, + value: EllipsisLiteral( + ExprEllipsisLiteral { + range: 312..315, + }, + ), + }, + ), + ], + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_py313.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_py313.py.snap new file mode 100644 index 0000000000000..9119467d8466e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@valid_annotation_py313.py.snap @@ -0,0 +1,178 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/valid_annotation_py313.py +--- +## AST + +``` +Module( + ModModule { + range: 0..144, + body: [ + AnnAssign( + StmtAnnAssign { + range: 44..55, + target: Name( + ExprName { + range: 44..45, + id: Name("a"), + ctx: Store, + }, + ), + annotation: Named( + ExprNamed { + range: 48..54, + target: Name( + ExprName { + range: 48..49, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 53..54, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + FunctionDef( + StmtFunctionDef { + range: 56..107, + is_async: false, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 60..65, + }, + type_params: None, + parameters: Parameters { + range: 65..67, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + AnnAssign( + StmtAnnAssign { + range: 73..85, + target: Name( + ExprName { + range: 73..74, + id: Name("b"), + ctx: Store, + }, + ), + annotation: Yield( + ExprYield { + range: 77..84, + value: Some( + NumberLiteral( + ExprNumberLiteral { + range: 83..84, + value: Int( + 1, + ), + }, + ), + ), + }, + ), + value: None, + simple: true, + }, + ), + AnnAssign( + StmtAnnAssign { + range: 90..107, + target: Name( + ExprName { + range: 90..91, + id: Name("c"), + ctx: Store, + }, + ), + annotation: YieldFrom( + ExprYieldFrom { + range: 94..106, + value: NumberLiteral( + ExprNumberLiteral { + range: 105..106, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + ], + }, + ), + FunctionDef( + StmtFunctionDef { + range: 108..143, + is_async: true, + decorator_list: [], + name: Identifier { + id: Name("outer"), + range: 118..123, + }, + type_params: None, + parameters: Parameters { + range: 123..125, + posonlyargs: [], + args: [], + vararg: None, + kwonlyargs: [], + kwarg: None, + }, + returns: None, + body: [ + AnnAssign( + StmtAnnAssign { + range: 131..143, + target: Name( + ExprName { + range: 131..132, + id: Name("d"), + ctx: Store, + }, + ), + annotation: Await( + ExprAwait { + range: 135..142, + value: NumberLiteral( + ExprNumberLiteral { + range: 141..142, + value: Int( + 1, + ), + }, + ), + }, + ), + value: None, + simple: true, + }, + ), + ], + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_parser/tests/snapshots/valid_syntax@walrus_py38.py.snap b/crates/ruff_python_parser/tests/snapshots/valid_syntax@walrus_py38.py.snap new file mode 100644 index 0000000000000..b0dfb2c4db18e --- /dev/null +++ b/crates/ruff_python_parser/tests/snapshots/valid_syntax@walrus_py38.py.snap @@ -0,0 +1,40 @@ +--- +source: crates/ruff_python_parser/tests/fixtures.rs +input_file: crates/ruff_python_parser/resources/inline/ok/walrus_py38.py +--- +## AST + +``` +Module( + ModModule { + range: 0..54, + body: [ + Expr( + StmtExpr { + range: 45..53, + value: Named( + ExprNamed { + range: 46..52, + target: Name( + ExprName { + range: 46..47, + id: Name("x"), + ctx: Store, + }, + ), + value: NumberLiteral( + ExprNumberLiteral { + range: 51..52, + value: Int( + 1, + ), + }, + ), + }, + ), + }, + ), + ], + }, +) +``` diff --git a/crates/ruff_python_resolver/src/implicit_imports.rs b/crates/ruff_python_resolver/src/implicit_imports.rs index 693b6572ca6a1..afa81d27ba8ef 100644 --- a/crates/ruff_python_resolver/src/implicit_imports.rs +++ b/crates/ruff_python_resolver/src/implicit_imports.rs @@ -55,7 +55,7 @@ impl ImplicitImports { // Always prefer stub files over non-stub files. if submodules .get(name) - .map_or(true, |implicit_import| !implicit_import.is_stub_file) + .is_none_or(|implicit_import| !implicit_import.is_stub_file) { submodules.insert( name.to_string(), diff --git a/crates/ruff_python_resolver/src/import_result.rs b/crates/ruff_python_resolver/src/import_result.rs index ddeab06c85aa5..b0556d06fce84 100644 --- a/crates/ruff_python_resolver/src/import_result.rs +++ b/crates/ruff_python_resolver/src/import_result.rs @@ -6,7 +6,7 @@ use crate::implicit_imports::ImplicitImports; use crate::py_typed::PyTypedInfo; #[derive(Debug, Clone, PartialEq, Eq)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub(crate) struct ImportResult { /// Whether the import name was relative (e.g., ".foo"). pub(crate) is_relative: bool, @@ -76,7 +76,7 @@ pub(crate) struct ImportResult { /// If the import resolved to a type hint (i.e., a `.pyi` file), then /// a non-type-hint resolution will be stored here. - #[allow(clippy::struct_field_names)] + #[expect(clippy::struct_field_names)] pub(crate) non_stub_import_result: Option<Box<ImportResult>>, /// Information extracted from the `py.typed` in the package used to diff --git a/crates/ruff_python_resolver/src/lib.rs b/crates/ruff_python_resolver/src/lib.rs index 91993cadefe35..f4d5992ac0389 100644 --- a/crates/ruff_python_resolver/src/lib.rs +++ b/crates/ruff_python_resolver/src/lib.rs @@ -15,7 +15,7 @@ mod search; #[cfg(test)] mod tests { - use std::fs::{create_dir_all, File}; + use std::fs::{File, create_dir_all}; use std::io::{self, Write}; use std::path::{Path, PathBuf}; @@ -625,7 +625,7 @@ mod tests { let result = resolve_options(file2, "file1", root, ResolverOptions::default()); - debug!("result: {:?}", result); + debug!("result: {result:?}"); assert!(!result.is_import_found); diff --git a/crates/ruff_python_resolver/src/native_module.rs b/crates/ruff_python_resolver/src/native_module.rs index fe4f41276aa23..6cb0b97efce65 100644 --- a/crates/ruff_python_resolver/src/native_module.rs +++ b/crates/ruff_python_resolver/src/native_module.rs @@ -31,7 +31,7 @@ pub(crate) fn is_native_module_file_name(module_name: &str, file_name: &Path) -> .is_some_and(is_native_module_file_extension) { return false; - }; + } // The file must represent the module name. native_module_name(file_name) == Some(module_name) diff --git a/crates/ruff_python_resolver/src/resolver.rs b/crates/ruff_python_resolver/src/resolver.rs index 7bbab3535f6ab..5f97733663b30 100644 --- a/crates/ruff_python_resolver/src/resolver.rs +++ b/crates/ruff_python_resolver/src/resolver.rs @@ -12,7 +12,7 @@ use crate::import_result::{ImportResult, ImportType}; use crate::module_descriptor::ImportModuleDescriptor; use crate::{host, native_module, py_typed, search}; -#[allow(clippy::fn_params_excessive_bools)] +#[expect(clippy::fn_params_excessive_bools)] fn resolve_module_descriptor( root: &Path, module_descriptor: &ImportModuleDescriptor, @@ -206,7 +206,7 @@ fn resolve_module_descriptor( /// defined in [PEP 420]. /// /// [PEP 420]: https://peps.python.org/pep-0420/ -#[allow(clippy::fn_params_excessive_bools)] +#[expect(clippy::fn_params_excessive_bools)] fn resolve_absolute_import( root: &Path, module_descriptor: &ImportModuleDescriptor, @@ -392,7 +392,7 @@ fn resolve_best_absolute_import<Host: host::Host>( if allow_pyi && !module_descriptor.name_parts.is_empty() { // Check for a stdlib typeshed file. - debug!("Looking for typeshed stdlib path: {}", import_name); + debug!("Looking for typeshed stdlib path: {import_name}"); if let Some(mut typeshed_stdilib_import) = find_typeshed_path(module_descriptor, true, config, host) { @@ -401,7 +401,7 @@ fn resolve_best_absolute_import<Host: host::Host>( } // Check for a third-party typeshed file. - debug!("Looking for typeshed third-party path: {}", import_name); + debug!("Looking for typeshed third-party path: {import_name}"); if let Some(mut typeshed_third_party_import) = find_typeshed_path(module_descriptor, false, config, host) { @@ -505,7 +505,7 @@ fn pick_best_import( best_import_so_far } else { new_import - } + }; } _ => {} } @@ -582,7 +582,7 @@ fn pick_best_import( best_import_so_far } else { new_import - } + }; } _ => {} } diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_explicit_native_module.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_explicit_native_module.snap index 69186a0145a78..195c5aa002ef6 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_explicit_native_module.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_explicit_native_module.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_first_party.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_first_party.snap index 47e0ef7c88e9a..e171965662593 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_first_party.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_first_party.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_implicit_native_module.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_implicit_native_module.snap index 262aa50fc1877..97a2fb547be78 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_implicit_native_module.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_implicit_native_module.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_namespace_package.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_namespace_package.snap index 1c9132b9bf701..5749d8157705d 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_namespace_package.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_namespace_package.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_standard_library.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_standard_library.snap index 47299f3218cb7..561a79df02227 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_standard_library.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_standard_library.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_stub_file.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_stub_file.snap index 92d74bcb20dad..8b5c084c238a4 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_stub_file.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_stub_file.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_third_party.snap b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_third_party.snap index 138f4f71cadff..f625b0cce98dc 100644 --- a/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_third_party.snap +++ b/crates/ruff_python_resolver/src/snapshots/ruff_python_resolver__tests__airflow_third_party.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_resolver/src/lib.rs expression: result +snapshot_kind: text --- ImportResult { is_relative: false, diff --git a/crates/ruff_python_semantic/Cargo.toml b/crates/ruff_python_semantic/Cargo.toml index e939bbf656de4..8005ec824f222 100644 --- a/crates/ruff_python_semantic/Cargo.toml +++ b/crates/ruff_python_semantic/Cargo.toml @@ -24,8 +24,11 @@ is-macro = { workspace = true } rustc-hash = { workspace = true } schemars = { workspace = true, optional = true } serde = { workspace = true, optional = true } +smallvec = { workspace = true } [dev-dependencies] +insta = { workspace = true, features = ["filters", "json", "redactions"] } +test-case = { workspace = true } ruff_python_parser = { workspace = true } [lints] diff --git a/crates/ruff_python_semantic/resources/test/fixtures/cfg/jumps.py b/crates/ruff_python_semantic/resources/test/fixtures/cfg/jumps.py new file mode 100644 index 0000000000000..5156ef63475e5 --- /dev/null +++ b/crates/ruff_python_semantic/resources/test/fixtures/cfg/jumps.py @@ -0,0 +1,18 @@ +def only_return(): + return + +def after_return(): + return 1 + print("unreachable") + print("and this") + +def after_raise(): + raise ValueError + print("unreachable") + print("and this") + +def multiple_returns(): + return 1 + print("unreachable") + return 2 + print("and this") diff --git a/crates/ruff_python_semantic/resources/test/fixtures/cfg/no_flow.py b/crates/ruff_python_semantic/resources/test/fixtures/cfg/no_flow.py new file mode 100644 index 0000000000000..1d973444551ed --- /dev/null +++ b/crates/ruff_python_semantic/resources/test/fixtures/cfg/no_flow.py @@ -0,0 +1,24 @@ +def func(): ... + + +def func(): + pass + + +def func(): + x = 1 + x = 2 + + +def func(): + foo() + + +def func(): + from foo import bar + + class C: + a = 1 + + c = C() + del c diff --git a/crates/ruff_python_semantic/src/analyze/class.rs b/crates/ruff_python_semantic/src/analyze/class.rs index eac8de46052c7..0cb3a8a7f65e1 100644 --- a/crates/ruff_python_semantic/src/analyze/class.rs +++ b/crates/ruff_python_semantic/src/analyze/class.rs @@ -1,10 +1,16 @@ +use std::collections::VecDeque; + use rustc_hash::FxHashSet; +use crate::analyze::typing; use crate::{BindingId, SemanticModel}; use ruff_python_ast as ast; use ruff_python_ast::helpers::map_subscript; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::Expr; +use ruff_python_ast::{ + ExceptHandler, Expr, ExprName, ExprStarred, ExprSubscript, ExprTuple, Stmt, StmtFor, StmtIf, + StmtMatch, StmtTry, StmtWhile, StmtWith, +}; /// Return `true` if any base class matches a [`QualifiedName`] predicate. pub fn any_qualified_base_class( @@ -12,7 +18,7 @@ pub fn any_qualified_base_class( semantic: &SemanticModel, func: &dyn Fn(QualifiedName) -> bool, ) -> bool { - any_base_class(class_def, semantic, &|expr| { + any_base_class(class_def, semantic, &mut |expr| { semantic .resolve_qualified_name(map_subscript(expr)) .is_some_and(func) @@ -23,12 +29,12 @@ pub fn any_qualified_base_class( pub fn any_base_class( class_def: &ast::StmtClassDef, semantic: &SemanticModel, - func: &dyn Fn(&Expr) -> bool, + func: &mut dyn FnMut(&Expr) -> bool, ) -> bool { fn inner( class_def: &ast::StmtClassDef, semantic: &SemanticModel, - func: &dyn Fn(&Expr) -> bool, + func: &mut dyn FnMut(&Expr) -> bool, seen: &mut FxHashSet<BindingId>, ) -> bool { class_def.bases().iter().any(|expr| { @@ -66,46 +72,222 @@ pub fn any_base_class( inner(class_def, semantic, func, &mut FxHashSet::default()) } -/// Return `true` if any base class matches an [`ast::StmtClassDef`] predicate. +/// Returns an iterator over all base classes, beginning with the +/// given class. +/// +/// The traversal of the class hierarchy is breadth-first, since +/// this graph tends to have small width but could be rather deep. +pub fn iter_super_class<'stmt>( + class_def: &'stmt ast::StmtClassDef, + semantic: &'stmt SemanticModel, +) -> impl Iterator<Item = &'stmt ast::StmtClassDef> { + struct SuperClassIterator<'stmt> { + semantic: &'stmt SemanticModel<'stmt>, + to_visit: VecDeque<&'stmt ast::StmtClassDef>, + seen: FxHashSet<BindingId>, + } + + impl<'a> Iterator for SuperClassIterator<'a> { + type Item = &'a ast::StmtClassDef; + + fn next(&mut self) -> Option<Self::Item> { + let current = self.to_visit.pop_front()?; + + // Add all base classes to the to_visit list + for expr in current.bases() { + if let Some(id) = self.semantic.lookup_attribute(map_subscript(expr)) { + if self.seen.insert(id) { + let binding = self.semantic.binding(id); + if let Some(base_class) = binding + .kind + .as_class_definition() + .map(|id| &self.semantic.scopes[*id]) + .and_then(|scope| scope.kind.as_class()) + { + self.to_visit.push_back(base_class); + } + } + } + } + Some(current) + } + } + + SuperClassIterator { + semantic, + to_visit: VecDeque::from([class_def]), + seen: FxHashSet::default(), + } +} + +/// Return `true` if any base class, including the given class, +/// matches an [`ast::StmtClassDef`] predicate. pub fn any_super_class( class_def: &ast::StmtClassDef, semantic: &SemanticModel, func: &dyn Fn(&ast::StmtClassDef) -> bool, ) -> bool { - fn inner( - class_def: &ast::StmtClassDef, - semantic: &SemanticModel, - func: &dyn Fn(&ast::StmtClassDef) -> bool, - seen: &mut FxHashSet<BindingId>, + iter_super_class(class_def, semantic).any(func) +} + +#[derive(Clone, Debug)] +pub struct ClassMemberDeclaration<'a> { + kind: ClassMemberKind<'a>, + boundness: ClassMemberBoundness, +} + +impl<'a> ClassMemberDeclaration<'a> { + pub fn kind(&self) -> &ClassMemberKind<'a> { + &self.kind + } + + pub fn boundness(&self) -> ClassMemberBoundness { + self.boundness + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ClassMemberBoundness { + PossiblyUnbound, + Bound, +} + +impl ClassMemberBoundness { + pub const fn is_bound(self) -> bool { + matches!(self, Self::Bound) + } + + pub const fn is_possibly_unbound(self) -> bool { + matches!(self, Self::PossiblyUnbound) + } +} + +#[derive(Copy, Clone, Debug)] +pub enum ClassMemberKind<'a> { + Assign(&'a ast::StmtAssign), + AnnAssign(&'a ast::StmtAnnAssign), + FunctionDef(&'a ast::StmtFunctionDef), +} + +pub fn any_member_declaration( + class: &ast::StmtClassDef, + func: &mut dyn FnMut(ClassMemberDeclaration) -> bool, +) -> bool { + fn any_stmt_in_body( + body: &[Stmt], + func: &mut dyn FnMut(ClassMemberDeclaration) -> bool, + boundness: ClassMemberBoundness, ) -> bool { - // If the function itself matches the pattern, then this does too. - if func(class_def) { - return true; - } + body.iter().any(|stmt| { + let kind = match stmt { + Stmt::FunctionDef(function_def) => Some(ClassMemberKind::FunctionDef(function_def)), + Stmt::Assign(assign) => Some(ClassMemberKind::Assign(assign)), + Stmt::AnnAssign(assign) => Some(ClassMemberKind::AnnAssign(assign)), + Stmt::With(StmtWith { body, .. }) => { + if any_stmt_in_body(body, func, ClassMemberBoundness::PossiblyUnbound) { + return true; + } - // Otherwise, check every base class. - class_def.bases().iter().any(|expr| { - // If the base class extends a class that matches the pattern, then this does too. - if let Some(id) = semantic.lookup_attribute(map_subscript(expr)) { - if seen.insert(id) { - let binding = semantic.binding(id); - if let Some(base_class) = binding - .kind - .as_class_definition() - .map(|id| &semantic.scopes[*id]) - .and_then(|scope| scope.kind.as_class()) + None + } + + Stmt::For(StmtFor { body, orelse, .. }) + | Stmt::While(StmtWhile { body, orelse, .. }) => { + if any_stmt_in_body(body, func, ClassMemberBoundness::PossiblyUnbound) + || any_stmt_in_body(orelse, func, ClassMemberBoundness::PossiblyUnbound) { - if inner(base_class, semantic, func, seen) { - return true; - } + return true; + } + + None + } + + Stmt::If(StmtIf { + body, + elif_else_clauses, + .. + }) => { + if any_stmt_in_body(body, func, ClassMemberBoundness::PossiblyUnbound) + || elif_else_clauses.iter().any(|it| { + any_stmt_in_body(&it.body, func, ClassMemberBoundness::PossiblyUnbound) + }) + { + return true; } + None + } + + Stmt::Match(StmtMatch { cases, .. }) => { + if cases.iter().any(|it| { + any_stmt_in_body(&it.body, func, ClassMemberBoundness::PossiblyUnbound) + }) { + return true; + } + + None + } + + Stmt::Try(StmtTry { + body, + handlers, + orelse, + finalbody, + .. + }) => { + if any_stmt_in_body(body, func, ClassMemberBoundness::PossiblyUnbound) + || any_stmt_in_body(orelse, func, ClassMemberBoundness::PossiblyUnbound) + || any_stmt_in_body(finalbody, func, ClassMemberBoundness::PossiblyUnbound) + || handlers.iter().any(|ExceptHandler::ExceptHandler(it)| { + any_stmt_in_body(&it.body, func, ClassMemberBoundness::PossiblyUnbound) + }) + { + return true; + } + + None + } + // Technically, a method can be defined using a few more methods: + // + // ```python + // class C1: + // # Import + // import __eq__ # Callable module + // # ImportFrom + // from module import __eq__ # Top level callable + // # ExprNamed + // (__eq__ := lambda self, other: True) + // ``` + // + // Those cases are not yet supported because they're rare. + Stmt::ClassDef(_) + | Stmt::Return(_) + | Stmt::Delete(_) + | Stmt::AugAssign(_) + | Stmt::TypeAlias(_) + | Stmt::Raise(_) + | Stmt::Assert(_) + | Stmt::Import(_) + | Stmt::ImportFrom(_) + | Stmt::Global(_) + | Stmt::Nonlocal(_) + | Stmt::Expr(_) + | Stmt::Pass(_) + | Stmt::Break(_) + | Stmt::Continue(_) + | Stmt::IpyEscapeCommand(_) => None, + }; + + if let Some(kind) = kind { + if func(ClassMemberDeclaration { kind, boundness }) { + return true; } } + false }) } - inner(class_def, semantic, func, &mut FxHashSet::default()) + any_stmt_in_body(&class.body, func, ClassMemberBoundness::Bound) } /// Return `true` if `class_def` is a class that has one or more enum classes in its mro @@ -121,12 +303,30 @@ pub fn is_enumeration(class_def: &ast::StmtClassDef, semantic: &SemanticModel) - }) } -/// Returns `true` if the given class is a metaclass. -pub fn is_metaclass(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> bool { - any_base_class(class_def, semantic, &|expr| match expr { +/// Whether or not a class is a metaclass. Constructed by [`is_metaclass`]. +#[derive(Debug, PartialEq, Eq, Clone, Copy)] +pub enum IsMetaclass { + Yes, + No, + Maybe, +} + +impl IsMetaclass { + pub const fn is_yes(self) -> bool { + matches!(self, IsMetaclass::Yes) + } +} + +/// Returns `IsMetaclass::Yes` if the given class is definitely a metaclass, +/// `IsMetaclass::No` if it's definitely *not* a metaclass, and +/// `IsMetaclass::Maybe` otherwise. +pub fn is_metaclass(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> IsMetaclass { + let mut maybe = false; + let is_base_class = any_base_class(class_def, semantic, &mut |expr| match expr { Expr::Call(ast::ExprCall { func, arguments, .. }) => { + maybe = true; // Ex) `class Foo(type(Protocol)): ...` arguments.len() == 1 && semantic.match_builtin_expr(func.as_ref(), "type") } @@ -144,5 +344,65 @@ pub fn is_metaclass(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> | ["enum", "EnumMeta" | "EnumType"] ) }), + }); + + match (is_base_class, maybe) { + (true, true) => IsMetaclass::Maybe, + (true, false) => IsMetaclass::Yes, + (false, _) => IsMetaclass::No, + } +} + +/// Returns true if a class might be generic. +/// +/// A class is considered generic if at least one of its direct bases +/// is subscripted with a `TypeVar`-like, +/// or if it is defined using PEP 695 syntax. +/// +/// Therefore, a class *might* be generic if it uses PEP-695 syntax +/// or at least one of its direct bases is a subscript expression that +/// is subscripted with an object that *might* be a `TypeVar`-like. +pub fn might_be_generic(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> bool { + if class_def.type_params.is_some() { + return true; + } + + class_def.bases().iter().any(|base| { + let Expr::Subscript(ExprSubscript { slice, .. }) = base else { + return false; + }; + + let Expr::Tuple(ExprTuple { elts, .. }) = slice.as_ref() else { + return expr_might_be_typevar_like(slice, semantic); + }; + + elts.iter() + .any(|elt| expr_might_be_typevar_like(elt, semantic)) }) } + +fn expr_might_be_typevar_like(expr: &Expr, semantic: &SemanticModel) -> bool { + is_known_typevar(expr, semantic) || expr_might_be_old_style_typevar_like(expr, semantic) +} + +fn is_known_typevar(expr: &Expr, semantic: &SemanticModel) -> bool { + semantic.match_typing_expr(expr, "AnyStr") +} + +fn expr_might_be_old_style_typevar_like(expr: &Expr, semantic: &SemanticModel) -> bool { + match expr { + Expr::Attribute(..) => true, + Expr::Name(name) => might_be_old_style_typevar_like(name, semantic), + Expr::Starred(ExprStarred { value, .. }) => { + expr_might_be_old_style_typevar_like(value, semantic) + } + _ => false, + } +} + +fn might_be_old_style_typevar_like(name: &ExprName, semantic: &SemanticModel) -> bool { + let Some(binding) = semantic.only_binding(name).map(|id| semantic.binding(id)) else { + return !semantic.has_builtin_binding(&name.id); + }; + typing::is_type_var_like(binding, semantic) +} diff --git a/crates/ruff_python_semantic/src/analyze/function_type.rs b/crates/ruff_python_semantic/src/analyze/function_type.rs index a9ba29c0e5128..be9cac6c60c13 100644 --- a/crates/ruff_python_semantic/src/analyze/function_type.rs +++ b/crates/ruff_python_semantic/src/analyze/function_type.rs @@ -11,6 +11,9 @@ pub enum FunctionType { Method, ClassMethod, StaticMethod, + /// `__new__` is an implicit static method but + /// is treated similarly to class methods for several lint rules + NewMethod, } /// Classify a function based on its scope, name, and decorators. @@ -24,23 +27,28 @@ pub fn classify( ) -> FunctionType { if !parent_scope.kind.is_class() { return FunctionType::Function; - }; + } if decorator_list .iter() .any(|decorator| is_static_method(decorator, semantic, staticmethod_decorators)) { FunctionType::StaticMethod - } else if matches!(name, "__new__" | "__init_subclass__" | "__class_getitem__") // Special-case class method, like `__new__`. - || decorator_list.iter().any(|decorator| is_class_method(decorator, semantic, classmethod_decorators)) + } else if decorator_list + .iter() + .any(|decorator| is_class_method(decorator, semantic, classmethod_decorators)) { FunctionType::ClassMethod } else { - // It's an instance method. - FunctionType::Method + match name { + "__new__" => FunctionType::NewMethod, // Implicit static method. + "__init_subclass__" | "__class_getitem__" => FunctionType::ClassMethod, // Implicit class methods. + _ => FunctionType::Method, // Default to instance method. + } } } /// Return `true` if a [`Decorator`] is indicative of a static method. +/// Note: Implicit static methods like `__new__` are not considered. fn is_static_method( decorator: &Decorator, semantic: &SemanticModel, @@ -81,6 +89,7 @@ fn is_static_method( } /// Return `true` if a [`Decorator`] is indicative of a class method. +/// Note: Implicit class methods like `__init_subclass__` and `__class_getitem__` are not considered. fn is_class_method( decorator: &Decorator, semantic: &SemanticModel, diff --git a/crates/ruff_python_semantic/src/analyze/imports.rs b/crates/ruff_python_semantic/src/analyze/imports.rs index 162cb6e653a94..60313eba14e1f 100644 --- a/crates/ruff_python_semantic/src/analyze/imports.rs +++ b/crates/ruff_python_semantic/src/analyze/imports.rs @@ -8,33 +8,37 @@ use crate::SemanticModel; /// import sys /// /// sys.path.append("../") +/// sys.path += ["../"] /// ``` pub fn is_sys_path_modification(stmt: &Stmt, semantic: &SemanticModel) -> bool { - let Stmt::Expr(ast::StmtExpr { value, range: _ }) = stmt else { - return false; - }; - let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() else { - return false; - }; - semantic - .resolve_qualified_name(func.as_ref()) - .is_some_and(|qualified_name| { - matches!( - qualified_name.segments(), - [ - "sys", - "path", - "append" - | "insert" - | "extend" - | "remove" - | "pop" - | "clear" - | "reverse" - | "sort" - ] - ) - }) + match stmt { + Stmt::Expr(ast::StmtExpr { value, range: _ }) => match value.as_ref() { + Expr::Call(ast::ExprCall { func, .. }) => semantic + .resolve_qualified_name(func.as_ref()) + .is_some_and(|qualified_name| { + matches!( + qualified_name.segments(), + [ + "sys", + "path", + "append" + | "insert" + | "extend" + | "remove" + | "pop" + | "clear" + | "reverse" + | "sort" + ] + ) + }), + _ => false, + }, + Stmt::AugAssign(ast::StmtAugAssign { target, .. }) => semantic + .resolve_qualified_name(map_subscript(target)) + .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["sys", "path"])), + _ => false, + } } /// Returns `true` if a [`Stmt`] is an `os.environ` modification, as in: @@ -102,3 +106,44 @@ pub fn is_matplotlib_activation(stmt: &Stmt, semantic: &SemanticModel) -> bool { .resolve_qualified_name(func.as_ref()) .is_some_and(|qualified_name| matches!(qualified_name.segments(), ["matplotlib", "use"])) } + +/// Returns `true` if a [`Stmt`] is a `pytest.importorskip()` call, as in: +/// ```python +/// import pytest +/// +/// pytest.importorskip("foo.bar") +/// ``` +pub fn is_pytest_importorskip(stmt: &Stmt, semantic: &SemanticModel) -> bool { + let Stmt::Expr(ast::StmtExpr { value, .. }) = stmt else { + return false; + }; + let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() else { + return false; + }; + + semantic + .resolve_qualified_name(func.as_ref()) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["pytest", "importorskip"]) + }) +} + +/// Returns `true` if a [`Stmt`] is a dynamic modification of the Python +/// module search path, e.g., +/// ```python +/// import site +/// +/// site.addsitedir(...) +/// ``` +pub fn is_site_sys_path_modification(stmt: &Stmt, semantic: &SemanticModel) -> bool { + if let Stmt::Expr(ast::StmtExpr { value, .. }) = stmt { + if let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() { + return semantic + .resolve_qualified_name(func.as_ref()) + .is_some_and(|qualified_name| { + matches!(qualified_name.segments(), ["site", "addsitedir"]) + }); + } + } + false +} diff --git a/crates/ruff_python_semantic/src/analyze/type_inference.rs b/crates/ruff_python_semantic/src/analyze/type_inference.rs index 6f7dfb0469a2c..d25e0f7e7a1d5 100644 --- a/crates/ruff_python_semantic/src/analyze/type_inference.rs +++ b/crates/ruff_python_semantic/src/analyze/type_inference.rs @@ -113,33 +113,29 @@ impl From<&Expr> for ResolvedPythonType { // Unary operators. Expr::UnaryOp(ast::ExprUnaryOp { operand, op, .. }) => match op { - UnaryOp::Invert => { - return match ResolvedPythonType::from(operand.as_ref()) { - ResolvedPythonType::Atom(PythonType::Number( - NumberLike::Bool | NumberLike::Integer, - )) => ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)), - ResolvedPythonType::Atom(_) => ResolvedPythonType::TypeError, - _ => ResolvedPythonType::Unknown, - } - } + UnaryOp::Invert => match ResolvedPythonType::from(operand.as_ref()) { + ResolvedPythonType::Atom(PythonType::Number( + NumberLike::Bool | NumberLike::Integer, + )) => ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)), + ResolvedPythonType::Atom(_) => ResolvedPythonType::TypeError, + _ => ResolvedPythonType::Unknown, + }, // Ex) `not 1.0` UnaryOp::Not => ResolvedPythonType::Atom(PythonType::Number(NumberLike::Bool)), // Ex) `+1` or `-1` - UnaryOp::UAdd | UnaryOp::USub => { - return match ResolvedPythonType::from(operand.as_ref()) { - ResolvedPythonType::Atom(PythonType::Number(number)) => { - ResolvedPythonType::Atom(PythonType::Number( - if number == NumberLike::Bool { - NumberLike::Integer - } else { - number - }, - )) - } - ResolvedPythonType::Atom(_) => ResolvedPythonType::TypeError, - _ => ResolvedPythonType::Unknown, + UnaryOp::UAdd | UnaryOp::USub => match ResolvedPythonType::from(operand.as_ref()) { + ResolvedPythonType::Atom(PythonType::Number(number)) => { + ResolvedPythonType::Atom(PythonType::Number( + if number == NumberLike::Bool { + NumberLike::Integer + } else { + number + }, + )) } - } + ResolvedPythonType::Atom(_) => ResolvedPythonType::TypeError, + _ => ResolvedPythonType::Unknown, + }, }, // Binary operators. @@ -221,11 +217,11 @@ impl From<&Expr> for ResolvedPythonType { ) { // Ex) `"Hello" % "world"` (ResolvedPythonType::Atom(PythonType::String), _) => { - return ResolvedPythonType::Atom(PythonType::String) + return ResolvedPythonType::Atom(PythonType::String); } // Ex) `b"Hello" % b"world"` (ResolvedPythonType::Atom(PythonType::Bytes), _) => { - return ResolvedPythonType::Atom(PythonType::Bytes) + return ResolvedPythonType::Atom(PythonType::Bytes); } // Ex) `1 % 2` ( @@ -238,12 +234,39 @@ impl From<&Expr> for ResolvedPythonType { } _ => {} }, + Operator::Mult => match ( + ResolvedPythonType::from(left.as_ref()), + ResolvedPythonType::from(right.as_ref()), + ) { + // Ex) `2 * 4` + ( + ResolvedPythonType::Atom(PythonType::Number(left)), + ResolvedPythonType::Atom(PythonType::Number(right)), + ) => { + return ResolvedPythonType::Atom(PythonType::Number( + left.coerce(right), + )); + } + // Ex) `"1" * 2` or `2 * "1"` + ( + ResolvedPythonType::Atom(PythonType::String), + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)), + ) + | ( + ResolvedPythonType::Atom(PythonType::Number(NumberLike::Integer)), + ResolvedPythonType::Atom(PythonType::String), + ) => return ResolvedPythonType::Atom(PythonType::String), + (ResolvedPythonType::Atom(_), ResolvedPythonType::Atom(_)) => { + return ResolvedPythonType::TypeError; + } + _ => {} + }, // Standard arithmetic operators, which coerce to the "highest" number type. - Operator::Mult | Operator::FloorDiv | Operator::Pow => match ( + Operator::FloorDiv | Operator::Pow => match ( ResolvedPythonType::from(left.as_ref()), ResolvedPythonType::from(right.as_ref()), ) { - // Ex) `1 - 2` + // Ex) `2 ** 4` ( ResolvedPythonType::Atom(PythonType::Number(left)), ResolvedPythonType::Atom(PythonType::Number(right)), @@ -429,7 +452,7 @@ impl NumberLike { #[cfg(test)] mod tests { use ruff_python_ast::ModExpression; - use ruff_python_parser::{parse_expression, Parsed}; + use ruff_python_parser::{Parsed, parse_expression}; use crate::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; @@ -480,6 +503,14 @@ mod tests { ResolvedPythonType::from(parse("1.0 * 2j").expr()), ResolvedPythonType::Atom(PythonType::Number(NumberLike::Complex)) ); + assert_eq!( + ResolvedPythonType::from(parse("'AA' * 2").expr()), + ResolvedPythonType::Atom(PythonType::String) + ); + assert_eq!( + ResolvedPythonType::from(parse("4 * 'AA'").expr()), + ResolvedPythonType::Atom(PythonType::String) + ); assert_eq!( ResolvedPythonType::from(parse("1 / True").expr()), ResolvedPythonType::Atom(PythonType::Number(NumberLike::Float)) diff --git a/crates/ruff_python_semantic/src/analyze/typing.rs b/crates/ruff_python_semantic/src/analyze/typing.rs index d915bfa8b6901..90594a15efe65 100644 --- a/crates/ruff_python_semantic/src/analyze/typing.rs +++ b/crates/ruff_python_semantic/src/analyze/typing.rs @@ -1,15 +1,21 @@ //! Analysis rules for the `typing` module. -use ruff_python_ast::helpers::{any_over_expr, is_const_false, map_subscript}; +use ruff_python_ast::helpers::{any_over_expr, map_subscript}; +use ruff_python_ast::identifier::Identifier; use ruff_python_ast::name::QualifiedName; -use ruff_python_ast::{self as ast, Expr, Int, Operator, ParameterWithDefault, Parameters, Stmt}; +use ruff_python_ast::{ + self as ast, Expr, ExprCall, ExprName, Operator, ParameterWithDefault, Parameters, Stmt, + StmtAssign, +}; use ruff_python_stdlib::typing::{ as_pep_585_generic, has_pep_585_generic, is_immutable_generic_type, is_immutable_non_generic_type, is_immutable_return_type, is_literal_member, is_mutable_return_type, is_pep_593_generic_member, is_pep_593_generic_type, is_standard_library_generic, is_standard_library_generic_member, is_standard_library_literal, + is_typed_dict, is_typed_dict_member, }; use ruff_text_size::Ranged; +use smallvec::{SmallVec, smallvec}; use crate::analyze::type_inference::{NumberLike, PythonType, ResolvedPythonType}; use crate::model::SemanticModel; @@ -24,6 +30,7 @@ pub enum Callable { NamedTuple, TypedDict, MypyExtension, + TypeAliasType, } #[derive(Debug, Copy, Clone)] @@ -34,6 +41,18 @@ pub enum SubscriptKind { Generic, /// A subscript of the form `typing.Annotated[int, "foo"]`, i.e., a PEP 593 annotation. PEP593Annotation, + /// A subscript of the form `typing.TypedDict[{"key": Type}]`, i.e., a [PEP 764] annotation. + /// + /// [PEP 764]: https://github.com/python/peps/pull/4082 + TypedDict, +} + +pub fn is_known_to_be_of_type_dict(semantic: &SemanticModel, expr: &ExprName) -> bool { + let Some(binding) = semantic.only_binding(expr).map(|id| semantic.binding(id)) else { + return false; + }; + + is_dict(binding, semantic) } pub fn match_annotated_subscript<'a>( @@ -62,6 +81,10 @@ pub fn match_annotated_subscript<'a>( return Some(SubscriptKind::PEP593Annotation); } + if is_typed_dict(qualified_name.segments()) { + return Some(SubscriptKind::TypedDict); + } + for module in typing_modules { let module_qualified_name = QualifiedName::user_defined(module); if qualified_name.starts_with(&module_qualified_name) { @@ -75,6 +98,9 @@ pub fn match_annotated_subscript<'a>( if is_pep_593_generic_member(member) { return Some(SubscriptKind::PEP593Annotation); } + if is_typed_dict_member(member) { + return Some(SubscriptKind::TypedDict); + } } } } @@ -226,9 +252,7 @@ pub fn is_immutable_annotation( .is_some_and(|qualified_name| { is_immutable_non_generic_type(qualified_name.segments()) || is_immutable_generic_type(qualified_name.segments()) - || extend_immutable_calls - .iter() - .any(|target| qualified_name == *target) + || extend_immutable_calls.contains(&qualified_name) }) } Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => semantic @@ -279,15 +303,63 @@ pub fn is_immutable_func( extend_immutable_calls: &[QualifiedName], ) -> bool { semantic - .resolve_qualified_name(func) + .resolve_qualified_name(map_subscript(func)) .is_some_and(|qualified_name| { is_immutable_return_type(qualified_name.segments()) - || extend_immutable_calls - .iter() - .any(|target| qualified_name == *target) + || extend_immutable_calls.contains(&qualified_name) }) } +/// Return `true` if `name` is bound to the `typing.NewType` call where the original type is +/// immutable. +/// +/// For example: +/// ```python +/// from typing import NewType +/// +/// UserId = NewType("UserId", int) +/// ``` +/// +/// Here, `name` would be `UserId`. +pub fn is_immutable_newtype_call( + name: &ast::ExprName, + semantic: &SemanticModel, + extend_immutable_calls: &[QualifiedName], +) -> bool { + let Some(binding) = semantic.only_binding(name).map(|id| semantic.binding(id)) else { + return false; + }; + + if !binding.kind.is_assignment() { + return false; + } + + let Some(Stmt::Assign(StmtAssign { value, .. })) = binding.statement(semantic) else { + return false; + }; + + let Expr::Call(ExprCall { + func, arguments, .. + }) = value.as_ref() + else { + return false; + }; + + if !semantic.match_typing_expr(func, "NewType") { + return false; + } + + if arguments.len() != 2 { + return false; + } + + let Some(original_type) = arguments.find_argument_value("tp", 1) else { + return false; + }; + + is_immutable_annotation(original_type, semantic, extend_immutable_calls) +} + /// Return `true` if `func` is a function that returns a mutable value. pub fn is_mutable_func(func: &Expr, semantic: &SemanticModel) -> bool { semantic @@ -306,7 +378,7 @@ pub fn is_mutable_expr(expr: &Expr, semantic: &SemanticModel) -> bool { | Expr::ListComp(_) | Expr::DictComp(_) | Expr::SetComp(_) => true, - Expr::Call(ast::ExprCall { func, .. }) => is_mutable_func(func, semantic), + Expr::Call(ast::ExprCall { func, .. }) => is_mutable_func(map_subscript(func), semantic), _ => false, } } @@ -315,28 +387,19 @@ pub fn is_mutable_expr(expr: &Expr, semantic: &SemanticModel) -> bool { pub fn is_type_checking_block(stmt: &ast::StmtIf, semantic: &SemanticModel) -> bool { let ast::StmtIf { test, .. } = stmt; - // Ex) `if False:` - if is_const_false(test) { - return true; - } - - // Ex) `if 0:` - if matches!( - test.as_ref(), - Expr::NumberLiteral(ast::ExprNumberLiteral { - value: ast::Number::Int(Int::ZERO), - .. - }) - ) { - return true; - } - - // Ex) `if typing.TYPE_CHECKING:` - if semantic.match_typing_expr(test, "TYPE_CHECKING") { - return true; + match test.as_ref() { + // As long as the symbol's name is "TYPE_CHECKING" we will treat it like `typing.TYPE_CHECKING` + // for this specific check even if it's defined somewhere else, like the current module. + // Ex) `if TYPE_CHECKING:` + Expr::Name(ast::ExprName { id, .. }) => { + id == "TYPE_CHECKING" + // Ex) `if TC:` with `from typing import TYPE_CHECKING as TC` + || semantic.match_typing_expr(test, "TYPE_CHECKING") + } + // Ex) `if typing.TYPE_CHECKING:` + Expr::Attribute(ast::ExprAttribute { attr, .. }) => attr == "TYPE_CHECKING", + _ => false, } - - false } /// Returns `true` if the [`ast::StmtIf`] is a version-checking block (e.g., `if sys.version_info >= ...:`). @@ -373,7 +436,7 @@ where ) where F: FnMut(&'a Expr, &'a Expr), { - // Ex) x | y + // Ex) `x | y` if let Expr::BinOp(ast::ExprBinOp { op: Operator::BitOr, left, @@ -396,17 +459,21 @@ where return; } - // Ex) Union[x, y] + // Ex) `Union[x, y]` if let Expr::Subscript(ast::ExprSubscript { value, slice, .. }) = expr { if semantic.match_typing_expr(value, "Union") { if let Expr::Tuple(tuple) = &**slice { // Traverse each element of the tuple within the union recursively to handle cases - // such as `Union[..., Union[...]] + // such as `Union[..., Union[...]]` tuple .iter() .for_each(|elem| inner(func, semantic, elem, Some(expr))); return; } + + // Ex) `Union[Union[a, b]]` and `Union[a | b | c]` + inner(func, semantic, slice, Some(expr)); + return; } } @@ -435,18 +502,19 @@ where ) where F: FnMut(&'a Expr, &'a Expr), { - // Ex) Literal[x, y] + // Ex) `Literal[x, y]` if let Expr::Subscript(ast::ExprSubscript { value, slice, .. }) = expr { if semantic.match_typing_expr(value, "Literal") { match &**slice { Expr::Tuple(tuple) => { // Traverse each element of the tuple within the literal recursively to handle cases - // such as `Literal[..., Literal[...]] + // such as `Literal[..., Literal[...]]` for element in tuple { inner(func, semantic, element, Some(expr)); } } other => { + // Ex) `Literal[Literal[...]]` inner(func, semantic, other, Some(expr)); } } @@ -475,7 +543,7 @@ pub trait TypeChecker { /// NOTE: this function doesn't perform more serious type inference, so it won't be able /// to understand if the value gets initialized from a call to a function always returning /// lists. This also implies no interfile analysis. -fn check_type<T: TypeChecker>(binding: &Binding, semantic: &SemanticModel) -> bool { +pub fn check_type<T: TypeChecker>(binding: &Binding, semantic: &SemanticModel) -> bool { match binding.kind { BindingKind::Assignment => match binding.statement(semantic) { // Given: @@ -546,7 +614,7 @@ fn check_type<T: TypeChecker>(binding: &Binding, semantic: &SemanticModel) -> bo let Some(parameter) = find_parameter(parameters, binding) else { return false; }; - let Some(ref annotation) = parameter.parameter.annotation else { + let Some(annotation) = parameter.annotation() else { return false; }; T::match_annotation(annotation, semantic) @@ -567,6 +635,18 @@ fn check_type<T: TypeChecker>(binding: &Binding, semantic: &SemanticModel) -> bo _ => false, }, + BindingKind::FunctionDefinition(_) => match binding.statement(semantic) { + // ```python + // def foo() -> int: + // ... + // ``` + Some(Stmt::FunctionDef(ast::StmtFunctionDef { returns, .. })) => returns + .as_ref() + .is_some_and(|return_ann| T::match_annotation(return_ann, semantic)), + + _ => false, + }, + _ => false, } } @@ -644,6 +724,22 @@ impl BuiltinTypeChecker for SetChecker { const EXPR_TYPE: PythonType = PythonType::Set; } +struct StringChecker; + +impl BuiltinTypeChecker for StringChecker { + const BUILTIN_TYPE_NAME: &'static str = "str"; + const TYPING_NAME: Option<&'static str> = None; + const EXPR_TYPE: PythonType = PythonType::String; +} + +struct BytesChecker; + +impl BuiltinTypeChecker for BytesChecker { + const BUILTIN_TYPE_NAME: &'static str = "bytes"; + const TYPING_NAME: Option<&'static str> = None; + const EXPR_TYPE: PythonType = PythonType::Bytes; +} + struct TupleChecker; impl BuiltinTypeChecker for TupleChecker { @@ -660,6 +756,14 @@ impl BuiltinTypeChecker for IntChecker { const EXPR_TYPE: PythonType = PythonType::Number(NumberLike::Integer); } +struct FloatChecker; + +impl BuiltinTypeChecker for FloatChecker { + const BUILTIN_TYPE_NAME: &'static str = "float"; + const TYPING_NAME: Option<&'static str> = None; + const EXPR_TYPE: PythonType = PythonType::Number(NumberLike::Float); +} + pub struct IoBaseChecker; impl TypeChecker for IoBaseChecker { @@ -736,6 +840,106 @@ impl TypeChecker for IoBaseChecker { } } +pub struct PathlibPathChecker; + +impl PathlibPathChecker { + fn is_pathlib_path_constructor(semantic: &SemanticModel, expr: &Expr) -> bool { + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return false; + }; + + matches!( + qualified_name.segments(), + [ + "pathlib", + "Path" + | "PosixPath" + | "PurePath" + | "PurePosixPath" + | "PureWindowsPath" + | "WindowsPath" + ] + ) + } +} + +impl TypeChecker for PathlibPathChecker { + fn match_annotation(annotation: &Expr, semantic: &SemanticModel) -> bool { + Self::is_pathlib_path_constructor(semantic, annotation) + } + + fn match_initializer(initializer: &Expr, semantic: &SemanticModel) -> bool { + let Expr::Call(ast::ExprCall { func, .. }) = initializer else { + return false; + }; + + Self::is_pathlib_path_constructor(semantic, func) + } +} + +pub struct FastApiRouteChecker; + +impl FastApiRouteChecker { + fn is_fastapi_route_constructor(semantic: &SemanticModel, expr: &Expr) -> bool { + let Some(qualified_name) = semantic.resolve_qualified_name(expr) else { + return false; + }; + + matches!( + qualified_name.segments(), + ["fastapi", "FastAPI" | "APIRouter"] + ) + } +} + +impl TypeChecker for FastApiRouteChecker { + fn match_annotation(annotation: &Expr, semantic: &SemanticModel) -> bool { + Self::is_fastapi_route_constructor(semantic, annotation) + } + + fn match_initializer(initializer: &Expr, semantic: &SemanticModel) -> bool { + let Expr::Call(ast::ExprCall { func, .. }) = initializer else { + return false; + }; + + Self::is_fastapi_route_constructor(semantic, func) + } +} + +pub struct TypeVarLikeChecker; + +impl TypeVarLikeChecker { + /// Returns `true` if an [`Expr`] is a `TypeVar`, `TypeVarTuple`, or `ParamSpec` call. + /// + /// See also [`ruff_linter::rules::flake8_pyi::rules::simple_defaults::is_type_var_like_call`]. + fn is_type_var_like_call(expr: &Expr, semantic: &SemanticModel) -> bool { + let Expr::Call(ast::ExprCall { func, .. }) = expr else { + return false; + }; + let Some(qualified_name) = semantic.resolve_qualified_name(func) else { + return false; + }; + + matches!( + qualified_name.segments(), + [ + "typing" | "typing_extensions", + "TypeVar" | "TypeVarTuple" | "ParamSpec" + ] + ) + } +} + +impl TypeChecker for TypeVarLikeChecker { + fn match_annotation(_annotation: &Expr, _semantic: &SemanticModel) -> bool { + false + } + + fn match_initializer(initializer: &Expr, semantic: &SemanticModel) -> bool { + Self::is_type_var_like_call(initializer, semantic) + } +} + /// Test whether the given binding can be considered a list. /// /// For this, we check what value might be associated with it through it's initialization and @@ -774,6 +978,21 @@ pub fn is_int(binding: &Binding, semantic: &SemanticModel) -> bool { check_type::<IntChecker>(binding, semantic) } +/// Test whether the given binding can be considered an instance of `float`. +pub fn is_float(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<FloatChecker>(binding, semantic) +} + +/// Test whether the given binding can be considered an instance of `str`. +pub fn is_string(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<StringChecker>(binding, semantic) +} + +/// Test whether the given binding can be considered an instance of `bytes`. +pub fn is_bytes(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<BytesChecker>(binding, semantic) +} + /// Test whether the given binding can be considered a set. /// /// For this, we check what value might be associated with it through it's initialization and @@ -819,6 +1038,21 @@ pub fn is_io_base_expr(expr: &Expr, semantic: &SemanticModel) -> bool { IoBaseChecker::match_initializer(expr, semantic) } +/// Test whether the given binding can be considered a `pathlib.PurePath` +/// or an instance of a subclass thereof. +pub fn is_pathlib_path(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<PathlibPathChecker>(binding, semantic) +} + +pub fn is_fastapi_route(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<FastApiRouteChecker>(binding, semantic) +} + +/// Test whether the given binding is for an old-style `TypeVar`, `TypeVarTuple` or a `ParamSpec`. +pub fn is_type_var_like(binding: &Binding, semantic: &SemanticModel) -> bool { + check_type::<TypeVarLikeChecker>(binding, semantic) +} + /// Find the [`ParameterWithDefault`] corresponding to the given [`Binding`]. #[inline] fn find_parameter<'a>( @@ -827,7 +1061,7 @@ fn find_parameter<'a>( ) -> Option<&'a ParameterWithDefault> { parameters .iter_non_variadic_params() - .find(|arg| arg.parameter.name.range() == binding.range()) + .find(|param| param.identifier() == binding.range()) } /// Return the [`QualifiedName`] of the value to which the given [`Expr`] is assigned, if any. @@ -841,23 +1075,43 @@ fn find_parameter<'a>( /// ``` /// /// This function will return `["asyncio", "get_running_loop"]` for the `loop` binding. +/// +/// This function will also automatically expand attribute accesses, so given: +/// ```python +/// from module import AppContainer +/// +/// container = AppContainer() +/// container.app.get(...) +/// ``` +/// +/// This function will return `["module", "AppContainer", "app", "get"]` for the +/// attribute access `container.app.get`. pub fn resolve_assignment<'a>( expr: &'a Expr, semantic: &'a SemanticModel<'a>, ) -> Option<QualifiedName<'a>> { - let name = expr.as_name_expr()?; + // Resolve any attribute chain. + let mut head_expr = expr; + let mut reversed_tail: SmallVec<[_; 4]> = smallvec![]; + while let Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = head_expr { + head_expr = value; + reversed_tail.push(attr.as_str()); + } + + // Resolve the left-most name, e.g. `foo` in `foo.bar.baz` to a qualified name, + // then append the attributes. + let name = head_expr.as_name_expr()?; let binding_id = semantic.resolve_name(name)?; let statement = semantic.binding(binding_id).statement(semantic)?; match statement { - Stmt::Assign(ast::StmtAssign { value, .. }) => { - let ast::ExprCall { func, .. } = value.as_call_expr()?; - semantic.resolve_qualified_name(func) - } - Stmt::AnnAssign(ast::StmtAnnAssign { + Stmt::Assign(ast::StmtAssign { value, .. }) + | Stmt::AnnAssign(ast::StmtAnnAssign { value: Some(value), .. }) => { let ast::ExprCall { func, .. } = value.as_call_expr()?; - semantic.resolve_qualified_name(func) + + let qualified_name = semantic.resolve_qualified_name(func)?; + Some(qualified_name.extend_members(reversed_tail.into_iter().rev())) } _ => None, } @@ -889,7 +1143,7 @@ pub fn find_assigned_value<'a>(symbol: &str, semantic: &'a SemanticModel<'a>) -> /// /// This function will return a `NumberLiteral` with value `Int(42)` when called with `foo` and a /// `StringLiteral` with value `"str"` when called with `bla`. -#[allow(clippy::single_match)] +#[expect(clippy::single_match)] pub fn find_binding_value<'a>(binding: &Binding, semantic: &'a SemanticModel) -> Option<&'a Expr> { match binding.kind { // Ex) `x := 1` @@ -907,7 +1161,7 @@ pub fn find_binding_value<'a>(binding: &Binding, semantic: &'a SemanticModel) -> Some(Stmt::Assign(ast::StmtAssign { value, targets, .. })) => { return targets .iter() - .find_map(|target| match_value(binding, target, value)) + .find_map(|target| match_value(binding, target, value)); } Some(Stmt::AnnAssign(ast::StmtAnnAssign { value: Some(value), @@ -985,7 +1239,7 @@ fn match_target<'a>(binding: &Binding, targets: &[Expr], values: &'a [Expr]) -> } } _ => (), - }; + } } Expr::Name(name) => { if name.range() == binding.range() { diff --git a/crates/ruff_python_semantic/src/binding.rs b/crates/ruff_python_semantic/src/binding.rs index 87c887fc0f1da..e762d5d95cd16 100644 --- a/crates/ruff_python_semantic/src/binding.rs +++ b/crates/ruff_python_semantic/src/binding.rs @@ -4,17 +4,17 @@ use std::ops::{Deref, DerefMut}; use bitflags::bitflags; use crate::all::DunderAllName; -use ruff_index::{newtype_index, IndexSlice, IndexVec}; +use ruff_index::{IndexSlice, IndexVec, newtype_index}; use ruff_python_ast::helpers::extract_handled_exceptions; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::{Ranged, TextRange}; +use crate::ScopeId; use crate::context::ExecutionContext; use crate::model::SemanticModel; use crate::nodes::NodeId; use crate::reference::ResolvedReferenceId; -use crate::ScopeId; #[derive(Debug, Clone)] pub struct Binding<'a> { @@ -135,6 +135,44 @@ impl<'a> Binding<'a> { self.flags.contains(BindingFlags::IN_EXCEPT_HANDLER) } + /// Return `true` if this [`Binding`] took place inside an `assert` statement, + /// e.g. `y` in: + /// ```python + /// assert (y := x**2), y + /// ``` + pub const fn in_assert_statement(&self) -> bool { + self.flags.contains(BindingFlags::IN_ASSERT_STATEMENT) + } + + /// Return `true` if this [`Binding`] represents a [PEP 613] type alias + /// e.g. `OptString` in: + /// ```python + /// from typing import TypeAlias + /// + /// OptString: TypeAlias = str | None + /// ``` + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + pub const fn is_annotated_type_alias(&self) -> bool { + self.flags.intersects(BindingFlags::ANNOTATED_TYPE_ALIAS) + } + + /// Return `true` if this [`Binding`] represents a [PEP 695] type alias + /// e.g. `OptString` in: + /// ```python + /// type OptString = str | None + /// ``` + /// + /// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias + pub const fn is_deferred_type_alias(&self) -> bool { + self.flags.intersects(BindingFlags::DEFERRED_TYPE_ALIAS) + } + + /// Return `true` if this [`Binding`] represents either kind of type alias + pub const fn is_type_alias(&self) -> bool { + self.flags.intersects(BindingFlags::TYPE_ALIAS) + } + /// Return `true` if this binding "redefines" the given binding, as per Pyflake's definition of /// redefinition. pub fn redefines(&self, existing: &Binding) -> bool { @@ -237,6 +275,15 @@ impl<'a> Binding<'a> { .map(|statement_id| semantic.statement(statement_id)) } + /// Returns the expression in which the binding was defined + /// (e.g. for the binding `x` in `y = (x := 1)`, return the node representing `x := 1`). + /// + /// This is only really applicable for assignment expressions. + pub fn expression<'b>(&self, semantic: &SemanticModel<'b>) -> Option<&'b ast::Expr> { + self.source + .and_then(|expression_id| semantic.parent_expression(expression_id)) + } + /// Returns the range of the binding's parent. pub fn parent_range(&self, semantic: &SemanticModel) -> Option<TextRange> { self.statement(semantic).and_then(|parent| { @@ -366,6 +413,27 @@ bitflags! { /// y = 42 /// ``` const IN_EXCEPT_HANDLER = 1 << 10; + + /// The binding represents a [PEP 613] explicit type alias. + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + const ANNOTATED_TYPE_ALIAS = 1 << 11; + + /// The binding represents a [PEP 695] type statement + /// + /// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias + const DEFERRED_TYPE_ALIAS = 1 << 12; + + /// The binding took place inside an `assert` statement + /// + /// For example, `x` in the following snippet: + /// ```python + /// assert (x := y**2) > 42, x + /// ``` + const IN_ASSERT_STATEMENT = 1 << 13; + + /// The binding represents any type alias. + const TYPE_ALIAS = Self::ANNOTATED_TYPE_ALIAS.bits() | Self::DEFERRED_TYPE_ALIAS.bits(); } } @@ -377,7 +445,7 @@ impl Ranged for Binding<'_> { /// ID uniquely identifying a [Binding] in a program. /// -/// Using a `u32` to identify [Binding]s should is sufficient because Ruff only supports documents with a +/// Using a `u32` to identify [Binding]s should be sufficient because Ruff only supports documents with a /// size smaller than or equal to `u32::max`. A document with the size of `u32::max` must have fewer than `u32::max` /// bindings because bindings must be separated by whitespace (and have an assignment). #[newtype_index] @@ -404,7 +472,7 @@ impl<'a> Deref for Bindings<'a> { } } -impl<'a> DerefMut for Bindings<'a> { +impl DerefMut for Bindings<'_> { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } @@ -609,10 +677,10 @@ pub enum BindingKind<'a> { bitflags! { #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] pub struct Exceptions: u8 { - const NAME_ERROR = 0b0000_0001; - const MODULE_NOT_FOUND_ERROR = 0b0000_0010; - const IMPORT_ERROR = 0b0000_0100; - const ATTRIBUTE_ERROR = 0b000_100; + const NAME_ERROR = 1 << 0; + const MODULE_NOT_FOUND_ERROR = 1 << 1; + const IMPORT_ERROR = 1 << 2; + const ATTRIBUTE_ERROR = 1 << 3; } } @@ -646,6 +714,15 @@ pub trait Imported<'a> { /// Returns the member name of the imported symbol. For a straight import, this is equivalent /// to the qualified name; for a `from` import, this is the name of the imported symbol. fn member_name(&self) -> Cow<'a, str>; + + /// Returns the source module of the imported symbol. + /// + /// For example: + /// + /// - `import foo` returns `["foo"]` + /// - `import foo.bar` returns `["foo","bar"]` + /// - `from foo import bar` returns `["foo"]` + fn source_name(&self) -> &[&'a str]; } impl<'a> Imported<'a> for Import<'a> { @@ -663,6 +740,10 @@ impl<'a> Imported<'a> for Import<'a> { fn member_name(&self) -> Cow<'a, str> { Cow::Owned(self.qualified_name().to_string()) } + + fn source_name(&self) -> &[&'a str] { + self.qualified_name.segments() + } } impl<'a> Imported<'a> for SubmoduleImport<'a> { @@ -680,6 +761,10 @@ impl<'a> Imported<'a> for SubmoduleImport<'a> { fn member_name(&self) -> Cow<'a, str> { Cow::Owned(self.qualified_name().to_string()) } + + fn source_name(&self) -> &[&'a str] { + self.qualified_name.segments() + } } impl<'a> Imported<'a> for FromImport<'a> { @@ -697,6 +782,10 @@ impl<'a> Imported<'a> for FromImport<'a> { fn member_name(&self) -> Cow<'a, str> { Cow::Borrowed(self.qualified_name.segments()[self.qualified_name.segments().len() - 1]) } + + fn source_name(&self) -> &[&'a str] { + self.module_name() + } } /// A wrapper around an import [`BindingKind`] that can be any of the three types of imports. @@ -707,7 +796,7 @@ pub enum AnyImport<'a, 'ast> { FromImport(&'a FromImport<'ast>), } -impl<'a, 'ast> Imported<'ast> for AnyImport<'a, 'ast> { +impl<'ast> Imported<'ast> for AnyImport<'_, 'ast> { fn qualified_name(&self) -> &QualifiedName<'ast> { match self { Self::Import(import) => import.qualified_name(), @@ -731,6 +820,14 @@ impl<'a, 'ast> Imported<'ast> for AnyImport<'a, 'ast> { Self::FromImport(import) => import.member_name(), } } + + fn source_name(&self) -> &[&'ast str] { + match self { + Self::Import(import) => import.source_name(), + Self::SubmoduleImport(import) => import.source_name(), + Self::FromImport(import) => import.source_name(), + } + } } #[cfg(test)] diff --git a/crates/ruff_python_semantic/src/branches.rs b/crates/ruff_python_semantic/src/branches.rs index 477f5522a65e7..d3fa0622f1a46 100644 --- a/crates/ruff_python_semantic/src/branches.rs +++ b/crates/ruff_python_semantic/src/branches.rs @@ -1,6 +1,6 @@ use std::ops::Index; -use ruff_index::{newtype_index, IndexVec}; +use ruff_index::{IndexVec, newtype_index}; /// ID uniquely identifying a branch in a program. /// diff --git a/crates/ruff_python_semantic/src/cfg/graph.rs b/crates/ruff_python_semantic/src/cfg/graph.rs new file mode 100644 index 0000000000000..59acb348ebabb --- /dev/null +++ b/crates/ruff_python_semantic/src/cfg/graph.rs @@ -0,0 +1,322 @@ +use ruff_index::{IndexVec, newtype_index}; +use ruff_python_ast::Stmt; +use ruff_text_size::{Ranged, TextRange}; +use smallvec::{SmallVec, smallvec}; + +/// Returns the control flow graph associated to an array of statements +pub fn build_cfg(stmts: &[Stmt]) -> ControlFlowGraph<'_> { + let mut builder = CFGBuilder::with_capacity(stmts.len()); + builder.process_stmts(stmts); + builder.finish() +} + +/// Control flow graph +#[derive(Debug)] +pub struct ControlFlowGraph<'stmt> { + /// Basic blocks - the nodes of the control flow graph + blocks: IndexVec<BlockId, BlockData<'stmt>>, + /// Entry point to the control flow graph + initial: BlockId, + /// Terminal block - will always be empty + terminal: BlockId, +} + +impl<'stmt> ControlFlowGraph<'stmt> { + /// Index of entry point to the control flow graph + pub fn initial(&self) -> BlockId { + self.initial + } + + /// Index of terminal block + pub fn terminal(&self) -> BlockId { + self.terminal + } + + /// Number of basic blocks, or nodes, in the graph + pub fn num_blocks(&self) -> usize { + self.blocks.len() + } + + /// Returns the statements comprising the basic block at the given index + pub fn stmts(&self, block: BlockId) -> &'stmt [Stmt] { + self.blocks[block].stmts + } + + /// Returns the range of the statements comprising the basic block at the given index + pub fn range(&self, block: BlockId) -> TextRange { + self.blocks[block].range() + } + + /// Returns the [`Edges`] going out of the basic block at the given index + pub fn outgoing(&self, block: BlockId) -> &Edges { + &self.blocks[block].out + } + + /// Returns an iterator over the indices of the direct predecessors of the block at the given index + pub fn predecessors(&self, block: BlockId) -> impl ExactSizeIterator<Item = BlockId> + '_ { + self.blocks[block].parents.iter().copied() + } + + /// Returns the [`BlockKind`] of the block at the given index + pub(crate) fn kind(&self, block: BlockId) -> BlockKind { + self.blocks[block].kind + } +} + +#[newtype_index] +pub struct BlockId; + +/// Holds the data of a basic block. A basic block consists of a collection of +/// [`Stmt`]s, together with outgoing edges to other basic blocks. +#[derive(Debug, Default)] +struct BlockData<'stmt> { + kind: BlockKind, + /// Slice of statements regarded as executing unconditionally in order + stmts: &'stmt [Stmt], + /// Outgoing edges, indicating possible paths of execution after the + /// block has concluded + out: Edges, + /// Collection of indices for basic blocks having the current + /// block as the target of an edge + parents: SmallVec<[BlockId; 2]>, +} + +impl Ranged for BlockData<'_> { + fn range(&self) -> TextRange { + let Some(first) = self.stmts.first() else { + return TextRange::default(); + }; + let Some(last) = self.stmts.last() else { + return TextRange::default(); + }; + + TextRange::new(first.start(), last.end()) + } +} + +#[derive(Debug, Default, Clone, Copy)] +pub(crate) enum BlockKind { + #[default] + Generic, + /// Entry point of the control flow graph + Start, + /// Terminal block for the control flow graph + Terminal, +} + +/// Holds a collection of edges. Each edge is determined by: +/// - a [`Condition`] for traversing the edge, and +/// - a target block, specified by its [`BlockId`]. +/// +/// The conditions and targets are kept in two separate +/// vectors which must always be kept the same length. +#[derive(Debug, Default, Clone)] +pub struct Edges { + conditions: SmallVec<[Condition; 4]>, + targets: SmallVec<[BlockId; 4]>, +} + +impl Edges { + /// Creates an unconditional edge to the target block + fn always(target: BlockId) -> Self { + Self { + conditions: smallvec![Condition::Always], + targets: smallvec![target], + } + } + + /// Returns iterator over indices of blocks targeted by given edges + pub fn targets(&self) -> impl ExactSizeIterator<Item = BlockId> + '_ { + self.targets.iter().copied() + } + + /// Returns iterator over [`Condition`]s which must be satisfied to traverse corresponding edge + pub fn conditions(&self) -> impl ExactSizeIterator<Item = &Condition> { + self.conditions.iter() + } + + fn is_empty(&self) -> bool { + self.targets.is_empty() + } + + pub fn filter_targets_by_conditions<'a, T: FnMut(&Condition) -> bool + 'a>( + &'a self, + mut predicate: T, + ) -> impl Iterator<Item = BlockId> + 'a { + self.conditions() + .zip(self.targets()) + .filter(move |(cond, _)| predicate(cond)) + .map(|(_, block)| block) + } +} + +/// Represents a condition to be tested in a multi-way branch +#[derive(Debug, Clone)] +pub enum Condition { + /// Unconditional edge + Always, +} + +struct CFGBuilder<'stmt> { + /// Control flow graph under construction + cfg: ControlFlowGraph<'stmt>, + /// Current basic block index + current: BlockId, + /// Exit block index for current control flow + exit: BlockId, +} + +impl<'stmt> CFGBuilder<'stmt> { + /// Returns [`CFGBuilder`] with vector of blocks initialized at given capacity and with both initial and terminal blocks populated. + fn with_capacity(capacity: usize) -> Self { + let mut blocks = IndexVec::with_capacity(capacity); + let initial = blocks.push(BlockData { + kind: BlockKind::Start, + ..BlockData::default() + }); + let terminal = blocks.push(BlockData { + kind: BlockKind::Terminal, + ..BlockData::default() + }); + + Self { + cfg: ControlFlowGraph { + blocks, + initial, + terminal, + }, + current: initial, + exit: terminal, + } + } + + /// Runs the core logic for the builder. + fn process_stmts(&mut self, stmts: &'stmt [Stmt]) { + // SAFETY With notation as below, we always maintain the invariant + // `start <= end + 1`. Since `end <= stmts.len() -1` we conclude that + // `start <= stmts.len()`. It is therefore always safe to use `start` as + // the beginning of a range for the purposes of slicing into `stmts`. + let mut start = 0; + for (end, stmt) in stmts.iter().enumerate() { + let cache_exit = self.exit(); + match stmt { + Stmt::FunctionDef(_) + | Stmt::ClassDef(_) + | Stmt::Assign(_) + | Stmt::AugAssign(_) + | Stmt::AnnAssign(_) + | Stmt::TypeAlias(_) + | Stmt::Import(_) + | Stmt::ImportFrom(_) + | Stmt::Global(_) + | Stmt::Nonlocal(_) + | Stmt::Expr(_) + | Stmt::Pass(_) + | Stmt::Delete(_) + | Stmt::IpyEscapeCommand(_) => {} + // Loops + Stmt::While(_) => {} + Stmt::For(_) => {} + + // Switch statements + Stmt::If(_) => {} + Stmt::Match(_) => {} + + // Exception handling statements + Stmt::Try(_) => {} + Stmt::With(_) => {} + + // Jumps + Stmt::Return(_) => { + let edges = Edges::always(self.cfg.terminal()); + self.set_current_block_stmts(&stmts[start..=end]); + self.set_current_block_edges(edges); + start = end + 1; + + if stmts.get(start).is_some() { + let next_block = self.new_block(); + self.move_to(next_block); + } + } + Stmt::Break(_) => {} + Stmt::Continue(_) => {} + Stmt::Raise(_) => { + let edges = Edges::always(self.cfg.terminal()); + self.set_current_block_stmts(&stmts[start..=end]); + self.set_current_block_edges(edges); + start = end + 1; + + if stmts.get(start).is_some() { + let next_block = self.new_block(); + self.move_to(next_block); + } + } + + // An `assert` is a mixture of a switch and a jump. + Stmt::Assert(_) => {} + } + // Restore exit + self.update_exit(cache_exit); + } + // It can happen that we have statements left over + // and not yet occupying a block. In that case, + // `self.current` should be pointing to an empty block + // and we push the remaining statements to it here. + if start < stmts.len() { + self.set_current_block_stmts(&stmts[start..]); + } + // Add edge to exit if not already present + if self.cfg.blocks[self.current].out.is_empty() { + let edges = Edges::always(self.exit()); + self.set_current_block_edges(edges); + } + self.move_to(self.exit()); + } + + /// Returns finished control flow graph + fn finish(self) -> ControlFlowGraph<'stmt> { + self.cfg + } + + /// Current exit block, which may change during construction + fn exit(&self) -> BlockId { + self.exit + } + + /// Point the current exit to block at provided index + fn update_exit(&mut self, new_exit: BlockId) { + self.exit = new_exit; + } + + /// Moves current block to provided index + fn move_to(&mut self, block: BlockId) { + self.current = block; + } + + /// Makes new block and returns index + fn new_block(&mut self) -> BlockId { + self.cfg.blocks.push(BlockData::default()) + } + + /// Populates the current basic block with the given set of statements. + /// + /// This should only be called once on any given block. + fn set_current_block_stmts(&mut self, stmts: &'stmt [Stmt]) { + debug_assert!( + self.cfg.blocks[self.current].stmts.is_empty(), + "Attempting to set statements on an already populated basic block." + ); + self.cfg.blocks[self.current].stmts = stmts; + } + + /// Draws provided edges out of the current basic block. + /// + /// This should only be called once on any given block. + fn set_current_block_edges(&mut self, edges: Edges) { + debug_assert!( + self.cfg.blocks[self.current].out.is_empty(), + "Attempting to set edges on a basic block that already has an outgoing edge." + ); + self.cfg.blocks[self.current].out = edges; + } +} diff --git a/crates/ruff_python_semantic/src/cfg/mod.rs b/crates/ruff_python_semantic/src/cfg/mod.rs new file mode 100644 index 0000000000000..43ea9aebd7095 --- /dev/null +++ b/crates/ruff_python_semantic/src/cfg/mod.rs @@ -0,0 +1,62 @@ +pub mod graph; +pub mod visualize; + +#[cfg(test)] +mod tests { + use std::fmt::Write; + use std::fs; + use std::path::PathBuf; + + use crate::cfg::graph::build_cfg; + use crate::cfg::visualize::draw_cfg; + use insta; + + use ruff_python_parser::parse_module; + use ruff_text_size::Ranged; + use test_case::test_case; + + #[test_case("no_flow.py")] + #[test_case("jumps.py")] + fn control_flow_graph(filename: &str) { + let path = PathBuf::from("resources/test/fixtures/cfg").join(filename); + let source = fs::read_to_string(path).expect("failed to read file"); + let stmts = parse_module(&source) + .unwrap_or_else(|err| panic!("failed to parse source: '{source}': {err}")) + .into_suite(); + + let mut output = String::new(); + + for (i, stmt) in stmts.into_iter().enumerate() { + let func = stmt.as_function_def_stmt().expect( + "Snapshot test for control flow graph should consist only of function definitions", + ); + let cfg = build_cfg(&func.body); + + let mermaid_graph = draw_cfg(cfg, &source); + writeln!( + output, + "## Function {}\n\ + ### Source\n\ + ```python\n\ + {}\n\ + ```\n\n\ + ### Control Flow Graph\n\ + ```mermaid\n\ + {}\n\ + ```\n", + i, + &source[func.range()], + mermaid_graph, + ) + .unwrap(); + } + + insta::with_settings!({ + omit_expression => true, + input_file => filename, + description => "This is a Mermaid graph. You can use https://mermaid.live to visualize it as a diagram." + }, { + insta::assert_snapshot!(format!("{filename}.md"), output); + }); + } +} diff --git a/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__jumps.py.md.snap b/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__jumps.py.md.snap new file mode 100644 index 0000000000000..9ab021b5ea1b3 --- /dev/null +++ b/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__jumps.py.md.snap @@ -0,0 +1,81 @@ +--- +source: crates/ruff_python_semantic/src/cfg/mod.rs +description: "This is a Mermaid graph. You can use https://mermaid.live to visualize it as a diagram." +--- +## Function 0 +### Source +```python +def only_return(): + return +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["return"] + node1((("EXIT"))) + node0==>node1 +``` + +## Function 1 +### Source +```python +def after_return(): + return 1 + print("unreachable") + print("and this") +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["return 1"] + node1((("EXIT"))) + node2["print(#quot;unreachable#quot;) +print(#quot;and this#quot;)"] + node0==>node1 + node2==>node1 +``` + +## Function 2 +### Source +```python +def after_raise(): + raise ValueError + print("unreachable") + print("and this") +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["raise ValueError"] + node1((("EXIT"))) + node2["print(#quot;unreachable#quot;) +print(#quot;and this#quot;)"] + node0==>node1 + node2==>node1 +``` + +## Function 3 +### Source +```python +def multiple_returns(): + return 1 + print("unreachable") + return 2 + print("and this") +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["return 1"] + node1((("EXIT"))) + node2["print(#quot;unreachable#quot;) +return 2"] + node3["print(#quot;and this#quot;)"] + node0==>node1 + node2==>node1 + node3==>node1 +``` diff --git a/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__no_flow.py.md.snap b/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__no_flow.py.md.snap new file mode 100644 index 0000000000000..29c03fc310a55 --- /dev/null +++ b/crates/ruff_python_semantic/src/cfg/snapshots/ruff_python_semantic__cfg__tests__no_flow.py.md.snap @@ -0,0 +1,89 @@ +--- +source: crates/ruff_python_semantic/src/cfg/mod.rs +description: "This is a Mermaid graph. You can use https://mermaid.live to visualize it as a diagram." +--- +## Function 0 +### Source +```python +def func(): ... +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["..."] + node1((("EXIT"))) + node0==>node1 +``` + +## Function 1 +### Source +```python +def func(): + pass +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["pass"] + node1((("EXIT"))) + node0==>node1 +``` + +## Function 2 +### Source +```python +def func(): + x = 1 + x = 2 +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["x = 1 +x = 2"] + node1((("EXIT"))) + node0==>node1 +``` + +## Function 3 +### Source +```python +def func(): + foo() +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["foo()"] + node1((("EXIT"))) + node0==>node1 +``` + +## Function 4 +### Source +```python +def func(): + from foo import bar + + class C: + a = 1 + + c = C() + del c +``` + +### Control Flow Graph +```mermaid +flowchart TD + node0["from foo import bar +class C: + a = 1 +c = C() +del c"] + node1((("EXIT"))) + node0==>node1 +``` diff --git a/crates/ruff_python_semantic/src/cfg/visualize.rs b/crates/ruff_python_semantic/src/cfg/visualize.rs new file mode 100644 index 0000000000000..64c9b18106300 --- /dev/null +++ b/crates/ruff_python_semantic/src/cfg/visualize.rs @@ -0,0 +1,244 @@ +//! Heavily inspired by rustc data structures +use ruff_index::Idx; +use ruff_text_size::Ranged; +use std::fmt::{self, Display}; + +use crate::cfg::graph::{BlockId, BlockKind, Condition, ControlFlowGraph}; + +/// Returns control flow graph in Mermaid syntax. +pub fn draw_cfg(graph: ControlFlowGraph, source: &str) -> String { + CFGWithSource::new(graph, source).draw_graph() +} + +trait MermaidGraph<'a>: DirectedGraph<'a> { + fn draw_node(&self, node: Self::Node) -> MermaidNode; + fn draw_edges(&self, node: Self::Node) -> impl Iterator<Item = (Self::Node, MermaidEdge)>; + + fn draw_graph(&self) -> String { + let mut graph = Vec::new(); + + // Begin mermaid graph. + graph.push("flowchart TD".to_string()); + + // Draw nodes + let num_nodes = self.num_nodes(); + for idx in 0..num_nodes { + let node = Self::Node::new(idx); + graph.push(format!("\tnode{}{}", idx, &self.draw_node(node))); + } + + // Draw edges + for idx in 0..num_nodes { + graph.extend( + self.draw_edges(Self::Node::new(idx)) + .map(|(end_idx, edge)| format!("\tnode{}{}node{}", idx, edge, end_idx.index())), + ); + } + graph.join("\n") + } +} + +pub struct MermaidNode { + shape: MermaidNodeShape, + content: String, +} + +impl MermaidNode { + pub fn with_content(content: String) -> Self { + Self { + shape: MermaidNodeShape::default(), + content, + } + } + + fn mermaid_write_quoted_str(f: &mut fmt::Formatter<'_>, value: &str) -> fmt::Result { + let mut parts = value.split('"'); + if let Some(v) = parts.next() { + write!(f, "{v}")?; + } + for v in parts { + write!(f, "#quot;{v}")?; + } + Ok(()) + } +} + +impl Display for MermaidNode { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let (open, close) = self.shape.open_close(); + write!(f, "{open}\"")?; + if self.content.is_empty() { + write!(f, "empty")?; + } else { + MermaidNode::mermaid_write_quoted_str(f, &self.content)?; + } + write!(f, "\"{close}") + } +} + +#[derive(Debug, Default)] +pub enum MermaidNodeShape { + #[default] + Rectangle, + DoubleRectangle, + RoundedRectangle, + Stadium, + Circle, + DoubleCircle, + Asymmetric, + Rhombus, + Hexagon, + Parallelogram, + Trapezoid, +} + +impl MermaidNodeShape { + fn open_close(&self) -> (&'static str, &'static str) { + match self { + Self::Rectangle => ("[", "]"), + Self::DoubleRectangle => ("[[", "]]"), + Self::RoundedRectangle => ("(", ")"), + Self::Stadium => ("([", "])"), + Self::Circle => ("((", "))"), + Self::DoubleCircle => ("(((", ")))"), + Self::Asymmetric => (">", "]"), + Self::Rhombus => ("{", "}"), + Self::Hexagon => ("{{", "}}"), + Self::Parallelogram => ("[/", "/]"), + Self::Trapezoid => ("[/", "\\]"), + } + } +} + +#[derive(Debug, Default)] +pub struct MermaidEdge { + kind: MermaidEdgeKind, + content: String, +} + +impl Display for MermaidEdge { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + if self.content.is_empty() { + write!(f, "{}", self.kind) + } else { + write!(f, "{}|\"{}\"|", self.kind, self.content) + } + } +} + +#[derive(Debug, Default)] +pub enum MermaidEdgeKind { + #[default] + Arrow, + DottedArrow, + ThickArrow, + BidirectionalArrow, +} + +impl Display for MermaidEdgeKind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + MermaidEdgeKind::Arrow => write!(f, "-->"), + MermaidEdgeKind::DottedArrow => write!(f, "-..->"), + MermaidEdgeKind::ThickArrow => write!(f, "==>"), + MermaidEdgeKind::BidirectionalArrow => write!(f, "<-->"), + } + } +} + +pub trait DirectedGraph<'a> { + type Node: Idx; + + fn num_nodes(&self) -> usize; + fn start_node(&self) -> Self::Node; + fn successors(&self, node: Self::Node) -> impl ExactSizeIterator<Item = Self::Node> + '_; +} + +struct CFGWithSource<'stmt> { + cfg: ControlFlowGraph<'stmt>, + source: &'stmt str, +} + +impl<'stmt> CFGWithSource<'stmt> { + fn new(cfg: ControlFlowGraph<'stmt>, source: &'stmt str) -> Self { + Self { cfg, source } + } +} + +impl<'stmt> DirectedGraph<'stmt> for CFGWithSource<'stmt> { + type Node = BlockId; + + fn num_nodes(&self) -> usize { + self.cfg.num_blocks() + } + + fn start_node(&self) -> Self::Node { + self.cfg.initial() + } + + fn successors(&self, node: Self::Node) -> impl ExactSizeIterator<Item = Self::Node> + '_ { + self.cfg.outgoing(node).targets() + } +} + +impl<'stmt> MermaidGraph<'stmt> for CFGWithSource<'stmt> { + fn draw_node(&self, node: Self::Node) -> MermaidNode { + let statements: Vec<String> = self + .cfg + .stmts(node) + .iter() + .map(|stmt| self.source[stmt.range()].to_string()) + .collect(); + let content = match self.cfg.kind(node) { + BlockKind::Generic => { + if statements.is_empty() { + "EMPTY".to_string() + } else { + statements.join("\n") + } + } + BlockKind::Start => { + if statements.is_empty() { + "START".to_string() + } else { + statements.join("\n") + } + } + BlockKind::Terminal => { + return MermaidNode { + content: "EXIT".to_string(), + shape: MermaidNodeShape::DoubleCircle, + }; + } + }; + + MermaidNode::with_content(content) + } + + fn draw_edges(&self, node: Self::Node) -> impl Iterator<Item = (Self::Node, MermaidEdge)> { + let edge_data = self.cfg.outgoing(node); + edge_data + .targets() + .zip(edge_data.conditions()) + .map(|(target, condition)| { + let edge = match condition { + Condition::Always => { + if target == self.cfg.terminal() { + MermaidEdge { + kind: MermaidEdgeKind::ThickArrow, + content: String::new(), + } + } else { + MermaidEdge { + kind: MermaidEdgeKind::Arrow, + content: String::new(), + } + } + } + }; + (target, edge) + }) + .collect::<Vec<_>>() + .into_iter() + } +} diff --git a/crates/ruff_python_semantic/src/definition.rs b/crates/ruff_python_semantic/src/definition.rs index 3a14a0be4aaf2..245bd101793c6 100644 --- a/crates/ruff_python_semantic/src/definition.rs +++ b/crates/ruff_python_semantic/src/definition.rs @@ -5,17 +5,17 @@ use std::fmt::Debug; use std::ops::Deref; use std::path::Path; -use ruff_index::{newtype_index, IndexSlice, IndexVec}; +use ruff_index::{IndexSlice, IndexVec, newtype_index}; use ruff_python_ast::name::QualifiedName; use ruff_python_ast::{self as ast, Stmt, StmtFunctionDef}; use ruff_text_size::{Ranged, TextRange}; +use crate::SemanticModel; use crate::analyze::visibility::{ - class_visibility, function_visibility, is_property, method_visibility, module_visibility, - Visibility, + Visibility, class_visibility, function_visibility, is_property, method_visibility, + module_visibility, }; use crate::model::all::DunderAllName; -use crate::SemanticModel; /// Id uniquely identifying a definition in a program. #[newtype_index] diff --git a/crates/ruff_python_semantic/src/globals.rs b/crates/ruff_python_semantic/src/globals.rs index a3c27db8a3e57..9f9ff62566d67 100644 --- a/crates/ruff_python_semantic/src/globals.rs +++ b/crates/ruff_python_semantic/src/globals.rs @@ -8,8 +8,8 @@ use ruff_python_ast::{self as ast, Stmt}; use ruff_text_size::{Ranged, TextRange}; use rustc_hash::FxHashMap; -use ruff_index::{newtype_index, IndexVec}; -use ruff_python_ast::statement_visitor::{walk_stmt, StatementVisitor}; +use ruff_index::{IndexVec, newtype_index}; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; /// Id uniquely identifying the set of global names for a given scope. #[newtype_index] diff --git a/crates/ruff_python_semantic/src/imports.rs b/crates/ruff_python_semantic/src/imports.rs index 6e7d1a0eaacc9..fd4d682336242 100644 --- a/crates/ruff_python_semantic/src/imports.rs +++ b/crates/ruff_python_semantic/src/imports.rs @@ -43,7 +43,7 @@ impl NameImports { impl NameImport { /// Returns the name under which the member is bound (e.g., given `from foo import bar as baz`, returns `baz`). - fn bound_name(&self) -> &str { + pub fn bound_name(&self) -> &str { match self { NameImport::Import(import) => { import.name.as_name.as_deref().unwrap_or(&import.name.name) @@ -56,8 +56,8 @@ impl NameImport { } } - /// Returns the [`QualifiedName`] of the imported name (e.g., given `import foo import bar as baz`, returns `["foo", "bar"]`). - fn qualified_name(&self) -> QualifiedName { + /// Returns the [`QualifiedName`] of the imported name (e.g., given `from foo import bar as baz`, returns `["foo", "bar"]`). + pub fn qualified_name(&self) -> QualifiedName { match self { NameImport::Import(import) => QualifiedName::user_defined(&import.name.name), NameImport::ImportFrom(import_from) => collect_import_from_member( @@ -209,7 +209,7 @@ impl<'de> serde::de::Deserialize<'de> for NameImports { struct AnyNameImportsVisitor; - impl<'de> serde::de::Visitor<'de> for AnyNameImportsVisitor { + impl serde::de::Visitor<'_> for AnyNameImportsVisitor { type Value = NameImports; fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result { @@ -273,7 +273,7 @@ impl schemars::JsonSchema for NameImports { "NameImports".to_string() } - fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { + fn json_schema(_gen: &mut schemars::r#gen::SchemaGenerator) -> schemars::schema::Schema { schemars::schema::SchemaObject { instance_type: Some(schemars::schema::InstanceType::String.into()), ..Default::default() diff --git a/crates/ruff_python_semantic/src/lib.rs b/crates/ruff_python_semantic/src/lib.rs index 30128e23a5894..38d6da47014cf 100644 --- a/crates/ruff_python_semantic/src/lib.rs +++ b/crates/ruff_python_semantic/src/lib.rs @@ -1,6 +1,7 @@ pub mod analyze; mod binding; mod branches; +pub mod cfg; mod context; mod definition; mod globals; diff --git a/crates/ruff_python_semantic/src/model.rs b/crates/ruff_python_semantic/src/model.rs index 7c7967e80e36c..73be405167492 100644 --- a/crates/ruff_python_semantic/src/model.rs +++ b/crates/ruff_python_semantic/src/model.rs @@ -1,3 +1,4 @@ +use std::collections::HashSet; use std::path::Path; use bitflags::bitflags; @@ -5,9 +6,10 @@ use rustc_hash::FxHashMap; use ruff_python_ast::helpers::from_relative_import; use ruff_python_ast::name::{QualifiedName, UnqualifiedName}; -use ruff_python_ast::{self as ast, Expr, ExprContext, Operator, PySourceType, Stmt}; +use ruff_python_ast::{self as ast, Expr, ExprContext, ExprName, PySourceType, Stmt}; use ruff_text_size::{Ranged, TextRange, TextSize}; +use crate::Imported; use crate::binding::{ Binding, BindingFlags, BindingId, BindingKind, Bindings, Exceptions, FromImport, Import, SubmoduleImport, @@ -22,7 +24,6 @@ use crate::reference::{ UnresolvedReferenceFlags, UnresolvedReferences, }; use crate::scope::{Scope, ScopeId, ScopeKind, Scopes}; -use crate::Imported; pub mod all; @@ -265,13 +266,22 @@ impl<'a> SemanticModel<'a> { self.shadowed_bindings.get(&binding_id).copied() } - /// Return `true` if `member` is bound as a builtin. + /// Return `true` if `member` is bound as a builtin *in the scope we are currently visiting*. /// /// Note that a "builtin binding" does *not* include explicit lookups via the `builtins` /// module, e.g. `import builtins; builtins.open`. It *only* includes the bindings /// that are pre-populated in Python's global scope before any imports have taken place. pub fn has_builtin_binding(&self, member: &str) -> bool { - self.lookup_symbol(member) + self.has_builtin_binding_in_scope(member, self.scope_id) + } + + /// Return `true` if `member` is bound as a builtin *in a given scope*. + /// + /// Note that a "builtin binding" does *not* include explicit lookups via the `builtins` + /// module, e.g. `import builtins; builtins.open`. It *only* includes the bindings + /// that are pre-populated in Python's global scope before any imports have taken place. + pub fn has_builtin_binding_in_scope(&self, member: &str, scope: ScopeId) -> bool { + self.lookup_symbol_in_scope(member, scope, false) .map(|binding_id| &self.bindings[binding_id]) .is_some_and(|binding| binding.kind.is_builtin()) } @@ -325,18 +335,24 @@ impl<'a> SemanticModel<'a> { } /// Return `true` if `member` is an "available" symbol, i.e., a symbol that has not been bound - /// in the current scope, or in any containing scope. + /// in the current scope currently being visited, or in any containing scope. pub fn is_available(&self, member: &str) -> bool { - self.lookup_symbol(member) + self.is_available_in_scope(member, self.scope_id) + } + + /// Return `true` if `member` is an "available" symbol in a given scope, i.e., + /// a symbol that has not been bound in that current scope, or in any containing scope. + pub fn is_available_in_scope(&self, member: &str, scope_id: ScopeId) -> bool { + self.lookup_symbol_in_scope(member, scope_id, false) .map(|binding_id| &self.bindings[binding_id]) - .map_or(true, |binding| binding.kind.is_builtin()) + .is_none_or(|binding| binding.kind.is_builtin()) } /// Resolve a `del` reference to `symbol` at `range`. pub fn resolve_del(&mut self, symbol: &str, range: TextRange) { let is_unbound = self.scopes[self.scope_id] .get(symbol) - .map_or(true, |binding_id| { + .is_none_or(|binding_id| { // Treat the deletion of a name as a reference to that name. self.add_local_reference(binding_id, ExprContext::Del, range); self.bindings[binding_id].is_unbound() @@ -352,10 +368,252 @@ impl<'a> SemanticModel<'a> { } } + fn resolve_binding( + &mut self, + binding_id: BindingId, + name_expr: &ExprName, + scope_id: ScopeId, + ) -> Option<ReadResult> { + let reference_id = self.resolved_references.push( + self.scope_id, + self.node_id, + ExprContext::Load, + self.flags, + name_expr.range, + ); + + self.bindings[binding_id].references.push(reference_id); + + if let Some(binding_id) = + self.resolve_submodule(name_expr.id.as_str(), scope_id, binding_id) + { + let reference_id = self.resolved_references.push( + self.scope_id, + self.node_id, + ExprContext::Load, + self.flags, + name_expr.range, + ); + self.bindings[binding_id].references.push(reference_id); + } + + match self.bindings[binding_id].kind { + // If it's a type annotation, don't treat it as resolved. For example, given: + // + // ```python + // name: str + // print(name) + // ``` + // + // The `name` in `print(name)` should be treated as unresolved, but the `name` in + // `name: str` should be treated as used. + // + // Stub files are an exception. In a stub file, it _is_ considered valid to + // resolve to a type annotation. + BindingKind::Annotation if !self.in_stub_file() => None, + + // If it's a deletion, don't treat it as resolved, since the name is now + // unbound. For example, given: + // + // ```python + // x = 1 + // del x + // print(x) + // ``` + // + // The `x` in `print(x)` should be treated as unresolved. + // + // Similarly, given: + // + // ```python + // try: + // pass + // except ValueError as x: + // pass + // + // print(x) + // + // The `x` in `print(x)` should be treated as unresolved. + BindingKind::Deletion | BindingKind::UnboundException(None) => { + self.unresolved_references.push( + name_expr.range, + self.exceptions(), + UnresolvedReferenceFlags::empty(), + ); + Some(ReadResult::UnboundLocal(binding_id)) + } + + BindingKind::ConditionalDeletion(binding_id) => { + self.unresolved_references.push( + name_expr.range, + self.exceptions(), + UnresolvedReferenceFlags::empty(), + ); + Some(ReadResult::UnboundLocal(binding_id)) + } + + // If we hit an unbound exception that shadowed a bound name, resole to the + // bound name. For example, given: + // + // ```python + // x = 1 + // + // try: + // pass + // except ValueError as x: + // pass + // + // print(x) + // ``` + // + // The `x` in `print(x)` should resolve to the `x` in `x = 1`. + BindingKind::UnboundException(Some(binding_id)) => { + // Mark the binding as used. + let reference_id = self.resolved_references.push( + self.scope_id, + self.node_id, + ExprContext::Load, + self.flags, + name_expr.range, + ); + self.bindings[binding_id].references.push(reference_id); + + // Mark any submodule aliases as used. + if let Some(binding_id) = + self.resolve_submodule(name_expr.id.as_str(), scope_id, binding_id) + { + let reference_id = self.resolved_references.push( + self.scope_id, + self.node_id, + ExprContext::Load, + self.flags, + name_expr.range, + ); + self.bindings[binding_id].references.push(reference_id); + } + + self.resolved_names.insert(name_expr.into(), binding_id); + Some(ReadResult::Resolved(binding_id)) + } + + BindingKind::Global(Some(binding_id)) | BindingKind::Nonlocal(binding_id, _) => { + // Mark the shadowed binding as used. + let reference_id = self.resolved_references.push( + self.scope_id, + self.node_id, + ExprContext::Load, + self.flags, + name_expr.range, + ); + self.bindings[binding_id].references.push(reference_id); + + // Treat it as resolved. + self.resolved_names.insert(name_expr.into(), binding_id); + Some(ReadResult::Resolved(binding_id)) + } + + _ => { + // Otherwise, treat it as resolved. + self.resolved_names.insert(name_expr.into(), binding_id); + Some(ReadResult::Resolved(binding_id)) + } + } + } + + /// Resolve a `load` reference to an [`ast::ExprAttribute`]. + pub fn resolve_attribute_load(&mut self, attribute: &ast::ExprAttribute) -> ReadResult { + let mut name_segments = vec![attribute.attr.id.as_str()]; + let mut current_expr = &*attribute.value; + let mut result = None; + let mut is_name_exist = false; + let mut already_checked_imports: HashSet<String> = HashSet::new(); + + while let Expr::Attribute(expr_attr) = current_expr { + name_segments.push(expr_attr.attr.id.as_str()); + current_expr = &expr_attr.value; + } + + let name_expr = if let Expr::Name(ref expr_name) = current_expr { + name_segments.push(expr_name.id.as_str()); + Some(expr_name) + } else { + return ReadResult::NotFound; + }; + + name_segments.reverse(); + let full_name = name_segments.join("."); + + let binding_ids: Vec<_> = self + .scopes + .ancestor_ids(self.scope_id) + .flat_map(|scope_id| { + self.scopes[scope_id] + .get_all(name_expr.unwrap().id.as_str()) + .into_iter() + .map(move |binding_id| (binding_id, scope_id)) + }) + .collect(); + + for (binding_id, scope_id) in &binding_ids { + if let BindingKind::SubmoduleImport(binding_kind) = &self.binding(*binding_id).kind { + if binding_kind.qualified_name.to_string() == full_name { + if let Some(result) = + self.resolve_binding(*binding_id, name_expr.unwrap(), *scope_id) + { + return result; + } + } + } + if let BindingKind::Import(_) = &self.binding(*binding_id).kind { + is_name_exist = true; + } + } + + // TODO: need to move the block implementation to resolve_load, but carefully + // start check module import + for (binding_id, scope_id) in &binding_ids { + let Some(import) = self.binding(*binding_id).as_any_import() else { + continue; + }; + let name = &import + .qualified_name() + .to_string() + .split('.') + .next() + .unwrap_or("") + .to_owned(); + + match self.bindings[*binding_id].kind { + BindingKind::SubmoduleImport(_) if !is_name_exist => continue, + BindingKind::WithItemVar => continue, + BindingKind::SubmoduleImport(_) => { + result = self.resolve_binding(*binding_id, name_expr.unwrap(), *scope_id); + } + BindingKind::Import(_) => { + if already_checked_imports.contains(&name.to_string()) { + continue; + } + already_checked_imports.insert(name.to_string()); + + result = self.resolve_binding(*binding_id, name_expr.unwrap(), *scope_id); + } + _ => {} + } + } + // end check module import + + if let Some(result) = result { + result + } else { + ReadResult::NotFound + } + } + /// Resolve a `load` reference to an [`ast::ExprName`]. pub fn resolve_load(&mut self, name: &ast::ExprName) -> ReadResult { // PEP 563 indicates that if a forward reference can be resolved in the module scope, we // should prefer it over local resolutions. + if self.in_forward_reference() { if let Some(binding_id) = self.scopes.global().get(name.id.as_str()) { if !self.bindings[binding_id].is_unbound() { @@ -392,9 +650,17 @@ impl<'a> SemanticModel<'a> { let mut seen_function = false; let mut import_starred = false; let mut class_variables_visible = true; - for (index, scope_id) in self.scopes.ancestor_ids(self.scope_id).enumerate() { + + let ancestor_scope_ids: Vec<_> = self.scopes.ancestor_ids(self.scope_id).collect(); + + for (index, scope_id) in ancestor_scope_ids.into_iter().enumerate() { let scope = &self.scopes[scope_id]; - if scope.kind.is_class() { + let is_class = scope.kind.is_class(); + let is_function = scope.kind.is_function(); + let uses_star_imports = scope.uses_star_imports(); + let mut is_name = false; + + if is_class { // Allow usages of `__class__` within methods, e.g.: // // ```python @@ -430,154 +696,35 @@ impl<'a> SemanticModel<'a> { class_variables_visible = scope.kind.is_type() && index == 0; if let Some(binding_id) = scope.get(name.id.as_str()) { - // Mark the binding as used. - let reference_id = self.resolved_references.push( - self.scope_id, - self.node_id, - ExprContext::Load, - self.flags, - name.range, - ); - self.bindings[binding_id].references.push(reference_id); - - // Mark any submodule aliases as used. - if let Some(binding_id) = - self.resolve_submodule(name.id.as_str(), scope_id, binding_id) - { - let reference_id = self.resolved_references.push( - self.scope_id, - self.node_id, - ExprContext::Load, - self.flags, - name.range, - ); - self.bindings[binding_id].references.push(reference_id); - } - - match self.bindings[binding_id].kind { - // If it's a type annotation, don't treat it as resolved. For example, given: - // - // ```python - // name: str - // print(name) - // ``` - // - // The `name` in `print(name)` should be treated as unresolved, but the `name` in - // `name: str` should be treated as used. - // - // Stub files are an exception. In a stub file, it _is_ considered valid to - // resolve to a type annotation. - BindingKind::Annotation if !self.in_stub_file() => continue, - - // If it's a deletion, don't treat it as resolved, since the name is now - // unbound. For example, given: - // - // ```python - // x = 1 - // del x - // print(x) - // ``` - // - // The `x` in `print(x)` should be treated as unresolved. - // - // Similarly, given: - // - // ```python - // try: - // pass - // except ValueError as x: - // pass - // - // print(x) - // - // The `x` in `print(x)` should be treated as unresolved. - BindingKind::Deletion | BindingKind::UnboundException(None) => { - self.unresolved_references.push( - name.range, - self.exceptions(), - UnresolvedReferenceFlags::empty(), - ); - return ReadResult::UnboundLocal(binding_id); + // Return solved if there is at least one import with a submodule + for temp_binding_id in scope.get_all(name.id.as_str()) { + if let BindingKind::Import(_) = &self.bindings[temp_binding_id].kind { + is_name = true; } + } - BindingKind::ConditionalDeletion(binding_id) => { - self.unresolved_references.push( - name.range, - self.exceptions(), - UnresolvedReferenceFlags::empty(), - ); - return ReadResult::UnboundLocal(binding_id); - } - - // If we hit an unbound exception that shadowed a bound name, resole to the - // bound name. For example, given: - // - // ```python - // x = 1 - // - // try: - // pass - // except ValueError as x: - // pass - // - // print(x) - // ``` - // - // The `x` in `print(x)` should resolve to the `x` in `x = 1`. - BindingKind::UnboundException(Some(binding_id)) => { - // Mark the binding as used. - let reference_id = self.resolved_references.push( - self.scope_id, - self.node_id, - ExprContext::Load, - self.flags, - name.range, - ); - self.bindings[binding_id].references.push(reference_id); - - // Mark any submodule aliases as used. - if let Some(binding_id) = - self.resolve_submodule(name.id.as_str(), scope_id, binding_id) - { - let reference_id = self.resolved_references.push( - self.scope_id, - self.node_id, - ExprContext::Load, - self.flags, - name.range, - ); - self.bindings[binding_id].references.push(reference_id); + // Todo: Move the implementation here + for temp_binding_id in scope.get_all(name.id.as_str()) { + if let BindingKind::SubmoduleImport(_) = &self.bindings[temp_binding_id].kind { + if !is_name { + return ReadResult::NotFound; } - self.resolved_names.insert(name.into(), binding_id); - return ReadResult::Resolved(binding_id); - } - - BindingKind::Global(Some(binding_id)) - | BindingKind::Nonlocal(binding_id, _) => { - // Mark the shadowed binding as used. - let reference_id = self.resolved_references.push( - self.scope_id, - self.node_id, - ExprContext::Load, - self.flags, - name.range, - ); - self.bindings[binding_id].references.push(reference_id); - - // Treat it as resolved. - self.resolved_names.insert(name.into(), binding_id); - return ReadResult::Resolved(binding_id); + for reference_id in self.bindings[temp_binding_id].references() { + if self.resolved_references[reference_id] + .range() + .contains_range(self.bindings[temp_binding_id].range) + { + return ReadResult::Resolved(temp_binding_id); + } + } } + } - _ => { - // Otherwise, treat it as resolved. - self.resolved_names.insert(name.into(), binding_id); - return ReadResult::Resolved(binding_id); - } + if let Some(res) = self.resolve_binding(binding_id, name, scope_id) { + return res; } } - // Allow usages of `__module__` and `__qualname__` within class scopes, e.g.: // // ```python @@ -593,14 +740,14 @@ impl<'a> SemanticModel<'a> { // __qualname__ = "Bar" // print(__qualname__) // ``` - if index == 0 && scope.kind.is_class() { + if index == 0 && is_class { if matches!(name.id.as_str(), "__module__" | "__qualname__") { return ReadResult::ImplicitGlobal; } } - seen_function |= scope.kind.is_function(); - import_starred = import_starred || scope.uses_star_imports(); + seen_function |= is_function; + import_starred = import_starred || uses_star_imports; } if import_starred { @@ -620,10 +767,22 @@ impl<'a> SemanticModel<'a> { } } - /// Lookup a symbol in the current scope. This is a carbon copy of [`Self::resolve_load`], but - /// doesn't add any read references to the resolved symbol. + /// Lookup a symbol in the current scope. pub fn lookup_symbol(&self, symbol: &str) -> Option<BindingId> { - if self.in_forward_reference() { + self.lookup_symbol_in_scope(symbol, self.scope_id, self.in_forward_reference()) + } + + /// Lookup a symbol in a certain scope + /// + /// This is a carbon copy of [`Self::resolve_load`], but + /// doesn't add any read references to the resolved symbol. + pub fn lookup_symbol_in_scope( + &self, + symbol: &str, + scope_id: ScopeId, + in_forward_reference: bool, + ) -> Option<BindingId> { + if in_forward_reference { if let Some(binding_id) = self.scopes.global().get(symbol) { if !self.bindings[binding_id].is_unbound() { return Some(binding_id); @@ -633,7 +792,7 @@ impl<'a> SemanticModel<'a> { let mut seen_function = false; let mut class_variables_visible = true; - for (index, scope_id) in self.scopes.ancestor_ids(self.scope_id).enumerate() { + for (index, scope_id) in self.scopes.ancestor_ids(scope_id).enumerate() { let scope = &self.scopes[scope_id]; if scope.kind.is_class() { if seen_function && matches!(symbol, "__class__") { @@ -645,6 +804,7 @@ impl<'a> SemanticModel<'a> { } class_variables_visible = scope.kind.is_type() && index == 0; + seen_function |= scope.kind.is_function(); if let Some(binding_id) = scope.get(symbol) { match self.bindings[binding_id].kind { @@ -661,8 +821,173 @@ impl<'a> SemanticModel<'a> { return None; } } + } + + None + } + + /// Simulates a runtime load of a given [`ast::ExprName`]. + /// + /// This should not be run until after all the bindings have been visited. + /// + /// The main purpose of this method and what makes this different + /// from methods like [`SemanticModel::lookup_symbol`] and + /// [`SemanticModel::resolve_name`] is that it may be used + /// to perform speculative name lookups. + /// + /// In most cases a load can be accurately modeled simply by calling + /// [`SemanticModel::resolve_name`] at the right time during semantic + /// analysis, however for speculative lookups this is not the case, + /// since we're aiming to change the semantic meaning of our load. + /// E.g. we want to check what would happen if we changed a forward + /// reference to an immediate load or vice versa. + /// + /// Use caution when utilizing this method, since it was primarily designed + /// to work for speculative lookups from within type definitions, which + /// happen to share some nice properties, where attaching each binding + /// to a range in the source code and ordering those bindings based on + /// that range is a good enough approximation of which bindings are + /// available at runtime for which reference. + /// + /// References from within an [`ast::Comprehension`] can produce incorrect + /// results when referring to a [`BindingKind::NamedExprAssignment`]. + pub fn simulate_runtime_load( + &self, + name: &ast::ExprName, + typing_only_bindings_status: TypingOnlyBindingsStatus, + ) -> Option<BindingId> { + self.simulate_runtime_load_at_location_in_scope( + name.id.as_str(), + name.range, + self.scope_id, + typing_only_bindings_status, + ) + } + + /// Simulates a runtime load of the given symbol. + /// + /// This should not be run until after all the bindings have been visited. + /// + /// The main purpose of this method and what makes this different from + /// [`SemanticModel::lookup_symbol_in_scope`] is that it may be used to + /// perform speculative name lookups. + /// + /// In most cases a load can be accurately modeled simply by calling + /// [`SemanticModel::lookup_symbol`] at the right time during semantic + /// analysis, however for speculative lookups this is not the case, + /// since we're aiming to change the semantic meaning of our load. + /// E.g. we want to check what would happen if we changed a forward + /// reference to an immediate load or vice versa. + /// + /// Use caution when utilizing this method, since it was primarily designed + /// to work for speculative lookups from within type definitions, which + /// happen to share some nice properties, where attaching each binding + /// to a range in the source code and ordering those bindings based on + /// that range is a good enough approximation of which bindings are + /// available at runtime for which reference. + /// + /// References from within an [`ast::Comprehension`] can produce incorrect + /// results when referring to a [`BindingKind::NamedExprAssignment`]. + pub fn simulate_runtime_load_at_location_in_scope( + &self, + symbol: &str, + symbol_range: TextRange, + scope_id: ScopeId, + typing_only_bindings_status: TypingOnlyBindingsStatus, + ) -> Option<BindingId> { + let mut seen_function = false; + let mut class_variables_visible = true; + let mut source_order_sensitive_lookup = true; + for (index, scope_id) in self.scopes.ancestor_ids(scope_id).enumerate() { + let scope = &self.scopes[scope_id]; + + // Only once we leave a function scope and its enclosing type scope should + // we stop doing source-order lookups. We could e.g. have nested classes + // where we lookup symbols from the innermost class scope, which can only see + // things from the outer class(es) that have been defined before the inner + // class. Source-order lookups take advantage of the fact that most of the + // bindings are created sequentially in source order, so if we want to + // determine whether or not a given reference can refer to another binding + // we can look at their text ranges to check whether or not the binding + // could actually be referred to. This is not as robust as back-tracking + // the AST, since that can properly take care of the few out-of order + // corner-cases, but back-tracking the AST from the reference to the binding + // is a lot more expensive than comparing a pair of text ranges. + if seen_function && !scope.kind.is_type() { + source_order_sensitive_lookup = false; + } + + if scope.kind.is_class() { + if seen_function && matches!(symbol, "__class__") { + return None; + } + if !class_variables_visible { + continue; + } + } + class_variables_visible = scope.kind.is_type() && index == 0; seen_function |= scope.kind.is_function(); + + if let Some(binding_id) = scope.get(symbol) { + if source_order_sensitive_lookup { + // we need to look through all the shadowed bindings + // since we may be shadowing a source-order accurate + // runtime binding with a source-order inaccurate one + for shadowed_id in scope.shadowed_bindings(binding_id) { + let binding = &self.bindings[shadowed_id]; + if typing_only_bindings_status.is_disallowed() + && binding.context.is_typing() + { + continue; + } + if let BindingKind::Annotation + | BindingKind::Deletion + | BindingKind::UnboundException(..) + | BindingKind::ConditionalDeletion(..) = binding.kind + { + continue; + } + + // This ensures we perform the correct source-order lookup, + // since the ranges for these two types of bindings are trimmed + // to just the target, but the name is not available until the + // end of the entire statement + let binding_range = match binding.statement(self) { + Some(Stmt::Assign(stmt)) => stmt.range(), + Some(Stmt::AnnAssign(stmt)) => stmt.range(), + Some(Stmt::ClassDef(stmt)) => stmt.range(), + _ => binding.range, + }; + + if binding_range.ordering(symbol_range).is_lt() { + return Some(shadowed_id); + } + } + } else { + let candidate_id = match self.bindings[binding_id].kind { + BindingKind::Annotation => continue, + BindingKind::Deletion | BindingKind::UnboundException(None) => return None, + BindingKind::ConditionalDeletion(binding_id) => binding_id, + BindingKind::UnboundException(Some(binding_id)) => binding_id, + _ => binding_id, + }; + + if typing_only_bindings_status.is_disallowed() + && self.bindings[candidate_id].context.is_typing() + { + continue; + } + + return Some(candidate_id); + } + } + + if index == 0 && scope.kind.is_class() { + if matches!(symbol, "__module__" | "__qualname__") { + return None; + } + } } None @@ -735,6 +1060,13 @@ impl<'a> SemanticModel<'a> { return None; } + if !submodule + .qualified_name() + .starts_with(import.qualified_name()) + { + return None; + } + Some(binding_id) } @@ -818,24 +1150,21 @@ impl<'a> SemanticModel<'a> { let value_name = UnqualifiedName::from_expr(value)?; let (_, tail) = value_name.segments().split_first()?; - let resolved: QualifiedName = if qualified_name - .segments() - .first() - .map_or(false, |segment| *segment == ".") - { - from_relative_import( - self.module.qualified_name()?, - qualified_name.segments(), - tail, - )? - } else { - qualified_name - .segments() - .iter() - .chain(tail) - .copied() - .collect() - }; + let resolved: QualifiedName = + if qualified_name.segments().first().copied() == Some(".") { + from_relative_import( + self.module.qualified_name()?, + qualified_name.segments(), + tail, + )? + } else { + qualified_name + .segments() + .iter() + .chain(tail) + .copied() + .collect() + }; Some(resolved) } BindingKind::Builtin => { @@ -1266,24 +1595,32 @@ impl<'a> SemanticModel<'a> { "anyio" => self.seen.insert(Modules::ANYIO), "builtins" => self.seen.insert(Modules::BUILTINS), "collections" => self.seen.insert(Modules::COLLECTIONS), + "copy" => self.seen.insert(Modules::COPY), "contextvars" => self.seen.insert(Modules::CONTEXTVARS), "dataclasses" => self.seen.insert(Modules::DATACLASSES), "datetime" => self.seen.insert(Modules::DATETIME), "django" => self.seen.insert(Modules::DJANGO), "fastapi" => self.seen.insert(Modules::FASTAPI), + "flask" => self.seen.insert(Modules::FLASK), "logging" => self.seen.insert(Modules::LOGGING), + "markupsafe" => self.seen.insert(Modules::MARKUPSAFE), "mock" => self.seen.insert(Modules::MOCK), "numpy" => self.seen.insert(Modules::NUMPY), "os" => self.seen.insert(Modules::OS), "pandas" => self.seen.insert(Modules::PANDAS), "pytest" => self.seen.insert(Modules::PYTEST), "re" => self.seen.insert(Modules::RE), + "regex" => self.seen.insert(Modules::REGEX), "six" => self.seen.insert(Modules::SIX), "subprocess" => self.seen.insert(Modules::SUBPROCESS), "tarfile" => self.seen.insert(Modules::TARFILE), "trio" => self.seen.insert(Modules::TRIO), "typing" => self.seen.insert(Modules::TYPING), "typing_extensions" => self.seen.insert(Modules::TYPING_EXTENSIONS), + "attr" | "attrs" => self.seen.insert(Modules::ATTRS), + "airflow" => self.seen.insert(Modules::AIRFLOW), + "hashlib" => self.seen.insert(Modules::HASHLIB), + "crypt" => self.seen.insert(Modules::CRYPT), _ => {} } } @@ -1305,24 +1642,48 @@ impl<'a> SemanticModel<'a> { /// Set the [`Globals`] for the current [`Scope`]. pub fn set_globals(&mut self, globals: Globals<'a>) { - // If any global bindings don't already exist in the global scope, add them. - for (name, range) in globals.iter() { - if self - .global_scope() - .get(name) - .map_or(true, |binding_id| self.bindings[binding_id].is_unbound()) - { - let id = self.bindings.push(Binding { - kind: BindingKind::Assignment, - range: *range, - references: Vec::new(), - scope: self.scope_id, - source: self.node_id, - context: self.execution_context(), - exceptions: self.exceptions(), - flags: BindingFlags::empty(), - }); - self.global_scope_mut().add(name, id); + // If any global bindings don't already exist in the global scope, add them, unless we are + // also in the global scope, where we don't want these to count as definitions for rules + // like `undefined-name` (F821). For example, adding bindings in the top-level scope causes + // a false negative in cases like this: + // + // ```python + // global x + // + // def f(): + // print(x) # F821 false negative + // ``` + // + // On the other hand, failing to add bindings in non-top-level scopes causes false + // positives: + // + // ```python + // def f(): + // global foo + // import foo + // + // def g(): + // foo.is_used() # F821 false positive + // ``` + if !self.at_top_level() { + for (name, range) in globals.iter() { + if self + .global_scope() + .get(name) + .is_none_or(|binding_id| self.bindings[binding_id].is_unbound()) + { + let id = self.bindings.push(Binding { + kind: BindingKind::Assignment, + range: *range, + references: Vec::new(), + scope: ScopeId::global(), + source: self.node_id, + context: self.execution_context(), + exceptions: self.exceptions(), + flags: BindingFlags::empty(), + }); + self.global_scope_mut().add(name, id); + } } } @@ -1379,38 +1740,48 @@ impl<'a> SemanticModel<'a> { /// Return `true` if the model is in a nested union expression (e.g., the inner `Union` in /// `Union[Union[int, str], float]`). pub fn in_nested_union(&self) -> bool { - // Ex) `Union[Union[int, str], float]` - if self - .current_expression_grandparent() - .and_then(Expr::as_subscript_expr) - .is_some_and(|parent| self.match_typing_expr(&parent.value, "Union")) - { - return true; - } - - // Ex) `int | Union[str, float]` - if self.current_expression_parent().is_some_and(|parent| { - matches!( - parent, - Expr::BinOp(ast::ExprBinOp { - op: Operator::BitOr, - .. - }) - ) - }) { - return true; + let mut parent_expressions = self.current_expressions().skip(1); + + match parent_expressions.next() { + // The parent expression is of the inner union is a single `typing.Union`. + // Ex) `Union[Union[a, b]]` + Some(Expr::Subscript(parent)) => self.match_typing_expr(&parent.value, "Union"), + // The parent expression is of the inner union is a tuple with two or more + // comma-separated elements and the parent of that tuple is a `typing.Union`. + // Ex) `Union[Union[a, b], Union[c, d]]` + Some(Expr::Tuple(_)) => parent_expressions + .next() + .and_then(Expr::as_subscript_expr) + .is_some_and(|grandparent| self.match_typing_expr(&grandparent.value, "Union")), + // The parent expression of the inner union is a PEP604-style union. + // Ex) `a | b | c` or `Union[a, b] | c` + // In contrast to `typing.Union`, PEP604-style unions are always binary operations, e.g. + // the expression `a | b | c` is represented by two binary unions: `(a | b) | c`. + Some(Expr::BinOp(bin_op)) => bin_op.op.is_bit_or(), + // Not a nested union otherwise. + _ => false, } - - false } /// Return `true` if the model is in a nested literal expression (e.g., the inner `Literal` in /// `Literal[Literal[int, str], float]`). pub fn in_nested_literal(&self) -> bool { - // Ex) `Literal[Literal[int, str], float]` - self.current_expression_grandparent() - .and_then(Expr::as_subscript_expr) - .is_some_and(|parent| self.match_typing_expr(&parent.value, "Literal")) + let mut parent_expressions = self.current_expressions().skip(1); + + match parent_expressions.next() { + // The parent expression of the current `Literal` is a tuple, and the + // grandparent is a `Literal`. + // Ex) `Literal[Literal[str], Literal[int]]` + Some(Expr::Tuple(_)) => parent_expressions + .next() + .and_then(Expr::as_subscript_expr) + .is_some_and(|grandparent| self.match_typing_expr(&grandparent.value, "Literal")), + // The parent expression of the current `Literal` is also a `Literal`. + // Ex) `Literal[Literal[str]]` + Some(Expr::Subscript(parent)) => self.match_typing_expr(&parent.value, "Literal"), + // Not a nested literal otherwise + _ => false, + } } /// Returns `true` if `left` and `right` are in the same branches of an `if`, `match`, or @@ -1656,11 +2027,52 @@ impl<'a> SemanticModel<'a> { || (self.in_future_type_definition() && self.in_typing_only_annotation()) } + /// Return `true` if the model is visiting the value expression + /// of a [PEP 613] type alias. + /// + /// For example: + /// ```python + /// from typing import TypeAlias + /// + /// OptStr: TypeAlias = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + pub const fn in_annotated_type_alias_value(&self) -> bool { + self.flags + .intersects(SemanticModelFlags::ANNOTATED_TYPE_ALIAS) + } + + /// Return `true` if the model is visiting the value expression + /// of a [PEP 695] type alias. + /// + /// For example: + /// ```python + /// type OptStr = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias + pub const fn in_deferred_type_alias_value(&self) -> bool { + self.flags + .intersects(SemanticModelFlags::DEFERRED_TYPE_ALIAS) + } + + /// Return `true` if the model is visiting the value expression of + /// either kind of type alias. + pub const fn in_type_alias_value(&self) -> bool { + self.flags.intersects(SemanticModelFlags::TYPE_ALIAS) + } + /// Return `true` if the model is in an exception handler. pub const fn in_exception_handler(&self) -> bool { self.flags.intersects(SemanticModelFlags::EXCEPTION_HANDLER) } + /// Return `true` if the model is in an `assert` statement. + pub const fn in_assert_statement(&self) -> bool { + self.flags.intersects(SemanticModelFlags::ASSERT_STATEMENT) + } + /// Return `true` if the model is in an f-string. pub const fn in_f_string(&self) -> bool { self.flags.intersects(SemanticModelFlags::F_STRING) @@ -1706,16 +2118,16 @@ impl<'a> SemanticModel<'a> { .intersects(SemanticModelFlags::ATTRIBUTE_DOCSTRING) } + /// Return `true` if the model is in a `@no_type_check` context. + pub const fn in_no_type_check(&self) -> bool { + self.flags.intersects(SemanticModelFlags::NO_TYPE_CHECK) + } + /// Return `true` if the model has traversed past the "top-of-file" import boundary. pub const fn seen_import_boundary(&self) -> bool { self.flags.intersects(SemanticModelFlags::IMPORT_BOUNDARY) } - /// Return `true` if the model has traverse past the `__future__` import boundary. - pub const fn seen_futures_boundary(&self) -> bool { - self.flags.intersects(SemanticModelFlags::FUTURES_BOUNDARY) - } - /// Return `true` if the model has traversed past the module docstring boundary. pub const fn seen_module_docstring_boundary(&self) -> bool { self.flags @@ -1739,12 +2151,6 @@ impl<'a> SemanticModel<'a> { .intersects(SemanticModelFlags::NAMED_EXPRESSION_ASSIGNMENT) } - /// Return `true` if the model is in a comprehension assignment (e.g., `_ for x in y`). - pub const fn in_comprehension_assignment(&self) -> bool { - self.flags - .intersects(SemanticModelFlags::COMPREHENSION_ASSIGNMENT) - } - /// Return `true` if the model is visiting the r.h.s. of an `__all__` definition /// (e.g. `"foo"` in `__all__ = ["foo"]`) pub const fn in_dunder_all_definition(&self) -> bool { @@ -1830,6 +2236,32 @@ impl ShadowedBinding { } } +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum TypingOnlyBindingsStatus { + Allowed, + Disallowed, +} + +impl TypingOnlyBindingsStatus { + pub const fn is_allowed(self) -> bool { + matches!(self, TypingOnlyBindingsStatus::Allowed) + } + + pub const fn is_disallowed(self) -> bool { + matches!(self, TypingOnlyBindingsStatus::Disallowed) + } +} + +impl From<bool> for TypingOnlyBindingsStatus { + fn from(value: bool) -> Self { + if value { + TypingOnlyBindingsStatus::Allowed + } else { + TypingOnlyBindingsStatus::Disallowed + } + } +} + bitflags! { /// A select list of Python modules that the semantic model can explicitly track. #[derive(Debug)] @@ -1856,6 +2288,14 @@ bitflags! { const CONTEXTVARS = 1 << 19; const ANYIO = 1 << 20; const FASTAPI = 1 << 21; + const COPY = 1 << 22; + const MARKUPSAFE = 1 << 23; + const FLASK = 1 << 24; + const ATTRS = 1 << 25; + const REGEX = 1 << 26; + const AIRFLOW = 1 << 27; + const HASHLIB = 1 << 28; + const CRYPT = 1 << 29; } } @@ -2056,21 +2496,6 @@ bitflags! { /// ``` const IMPORT_BOUNDARY = 1 << 13; - /// The model has traversed past the `__future__` import boundary. - /// - /// For example, the model could be visiting `x` in: - /// ```python - /// from __future__ import annotations - /// - /// import os - /// - /// x: int = 1 - /// ``` - /// - /// Python considers it a syntax error to import from `__future__` after - /// any other non-`__future__`-importing statements. - const FUTURES_BOUNDARY = 1 << 14; - /// The model is in a file that has `from __future__ import annotations` /// at the top of the module. /// @@ -2082,10 +2507,10 @@ bitflags! { /// def f(x: int) -> int: /// ... /// ``` - const FUTURE_ANNOTATIONS = 1 << 15; + const FUTURE_ANNOTATIONS = 1 << 14; /// The model is in a Python stub file (i.e., a `.pyi` file). - const STUB_FILE = 1 << 16; + const STUB_FILE = 1 << 15; /// `__future__`-style type annotations are enabled in this model. /// That could be because it's a stub file, @@ -2101,7 +2526,7 @@ bitflags! { /// /// x: int = 1 /// ``` - const MODULE_DOCSTRING_BOUNDARY = 1 << 17; + const MODULE_DOCSTRING_BOUNDARY = 1 << 16; /// The model is in a (deferred) [type parameter definition]. /// @@ -2125,7 +2550,7 @@ bitflags! { /// not when we "pass by" it when initially traversing the source tree. /// /// [type parameter definition]: https://docs.python.org/3/reference/executionmodel.html#annotation-scopes - const TYPE_PARAM_DEFINITION = 1 << 18; + const TYPE_PARAM_DEFINITION = 1 << 17; /// The model is in a named expression assignment. /// @@ -2133,15 +2558,7 @@ bitflags! { /// ```python /// if (x := 1): ... /// ``` - const NAMED_EXPRESSION_ASSIGNMENT = 1 << 19; - - /// The model is in a comprehension variable assignment. - /// - /// For example, the model could be visiting `x` in: - /// ```python - /// [_ for x in range(10)] - /// ``` - const COMPREHENSION_ASSIGNMENT = 1 << 20; + const NAMED_EXPRESSION_ASSIGNMENT = 1 << 18; /// The model is in a docstring as described in [PEP 257]. /// @@ -2162,7 +2579,7 @@ bitflags! { /// ``` /// /// [PEP 257]: https://peps.python.org/pep-0257/#what-is-a-docstring - const PEP_257_DOCSTRING = 1 << 21; + const PEP_257_DOCSTRING = 1 << 19; /// The model is visiting the r.h.s. of a module-level `__all__` definition. /// @@ -2174,7 +2591,7 @@ bitflags! { /// __all__ = ("bar",) /// __all__ += ("baz,") /// ``` - const DUNDER_ALL_DEFINITION = 1 << 22; + const DUNDER_ALL_DEFINITION = 1 << 20; /// The model is in an f-string replacement field. /// @@ -2183,7 +2600,7 @@ bitflags! { /// ```python /// f"first {x} second {y}" /// ``` - const F_STRING_REPLACEMENT_FIELD = 1 << 23; + const F_STRING_REPLACEMENT_FIELD = 1 << 21; /// The model is visiting the bases tuple of a class. /// @@ -2193,11 +2610,11 @@ bitflags! { /// class Baz(Foo, Bar): /// pass /// ``` - const CLASS_BASE = 1 << 24; + const CLASS_BASE = 1 << 22; /// The model is visiting a class base that was initially deferred /// while traversing the AST. (This only happens in stub files.) - const DEFERRED_CLASS_BASE = 1 << 25; + const DEFERRED_CLASS_BASE = 1 << 23; /// The model is in an attribute docstring. /// @@ -2222,7 +2639,54 @@ bitflags! { /// static-analysis tools. /// /// [PEP 257]: https://peps.python.org/pep-0257/#what-is-a-docstring - const ATTRIBUTE_DOCSTRING = 1 << 26; + const ATTRIBUTE_DOCSTRING = 1 << 24; + + /// The model is in the value expression of a [PEP 613] explicit type alias. + /// + /// For example: + /// ```python + /// from typing import TypeAlias + /// + /// OptStr: TypeAlias = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + const ANNOTATED_TYPE_ALIAS = 1 << 25; + + /// The model is in the value expression of a [PEP 695] type statement. + /// + /// For example: + /// ```python + /// type OptStr = str | None # We're visiting the RHS + /// ``` + /// + /// [PEP 695]: https://peps.python.org/pep-0695/#generic-type-alias + const DEFERRED_TYPE_ALIAS = 1 << 26; + + /// The model is visiting an `assert` statement. + /// + /// For example, the model might be visiting `y` in + /// ```python + /// assert (y := x**2) > 42, y + /// ``` + const ASSERT_STATEMENT = 1 << 27; + + /// The model is in a [`@no_type_check`] context. + /// + /// This is used to skip type checking when the `@no_type_check` decorator is found. + /// + /// For example (adapted from [#13824]): + /// ```python + /// from typing import no_type_check + /// + /// @no_type_check + /// def fn(arg: "A") -> "R": + /// pass + /// ``` + /// + /// [no_type_check]: https://docs.python.org/3/library/typing.html#typing.no_type_check + /// [#13824]: https://github.com/astral-sh/ruff/issues/13824 + const NO_TYPE_CHECK = 1 << 28; /// The context is in any type annotation. const ANNOTATION = Self::TYPING_ONLY_ANNOTATION.bits() | Self::RUNTIME_EVALUATED_ANNOTATION.bits() | Self::RUNTIME_REQUIRED_ANNOTATION.bits(); @@ -2240,6 +2704,9 @@ bitflags! { /// The context is in a typing-only context. const TYPING_CONTEXT = Self::TYPE_CHECKING_BLOCK.bits() | Self::TYPING_ONLY_ANNOTATION.bits() | Self::STRING_TYPE_DEFINITION.bits() | Self::TYPE_PARAM_DEFINITION.bits(); + + /// The context is in any type alias. + const TYPE_ALIAS = Self::ANNOTATED_TYPE_ALIAS.bits() | Self::DEFERRED_TYPE_ALIAS.bits(); } } diff --git a/crates/ruff_python_semantic/src/model/all.rs b/crates/ruff_python_semantic/src/model/all.rs index d757823fba3ed..ba2d1ddb3c41f 100644 --- a/crates/ruff_python_semantic/src/model/all.rs +++ b/crates/ruff_python_semantic/src/model/all.rs @@ -2,7 +2,7 @@ use bitflags::bitflags; -use ruff_python_ast::{self as ast, helpers::map_subscript, Expr, Stmt}; +use ruff_python_ast::{self as ast, Expr, Stmt, helpers::map_subscript}; use ruff_text_size::{Ranged, TextRange}; use crate::SemanticModel; @@ -70,7 +70,7 @@ impl Ranged for DunderAllDefinition<'_> { } } -impl<'a> SemanticModel<'a> { +impl SemanticModel<'_> { /// Extract the names bound to a given __all__ assignment. pub fn extract_dunder_all_names<'expr>( &self, diff --git a/crates/ruff_python_semantic/src/nodes.rs b/crates/ruff_python_semantic/src/nodes.rs index 37bd797442eb0..d1e6358ad9984 100644 --- a/crates/ruff_python_semantic/src/nodes.rs +++ b/crates/ruff_python_semantic/src/nodes.rs @@ -1,6 +1,6 @@ use std::ops::Index; -use ruff_index::{newtype_index, IndexVec}; +use ruff_index::{IndexVec, newtype_index}; use ruff_python_ast::{Expr, Stmt}; use ruff_text_size::{Ranged, TextRange}; @@ -79,7 +79,7 @@ impl<'a> Index<NodeId> for Nodes<'a> { /// /// TODO(charlie): Replace with [`ruff_python_ast::AnyNodeRef`]. This requires migrating /// the rest of the codebase to use [`ruff_python_ast::AnyNodeRef`] and related abstractions, -/// like [`ruff_python_ast::ExpressionRef`] instead of [`Expr`]. +/// like [`ruff_python_ast::ExprRef`] instead of [`Expr`]. #[derive(Copy, Clone, Debug, PartialEq)] pub enum NodeRef<'a> { Stmt(&'a Stmt), diff --git a/crates/ruff_python_semantic/src/reference.rs b/crates/ruff_python_semantic/src/reference.rs index 1b9b7364b0b27..0c5cfd69457b0 100644 --- a/crates/ruff_python_semantic/src/reference.rs +++ b/crates/ruff_python_semantic/src/reference.rs @@ -2,7 +2,7 @@ use std::ops::Deref; use bitflags::bitflags; -use ruff_index::{newtype_index, IndexSlice, IndexVec}; +use ruff_index::{IndexSlice, IndexVec, newtype_index}; use ruff_python_ast::ExprContext; use ruff_text_size::{Ranged, TextRange}; @@ -63,28 +63,15 @@ impl ResolvedReference { .intersects(SemanticModelFlags::RUNTIME_EVALUATED_ANNOTATION) } - /// Return `true` if the context is in a "simple" string type definition. - pub const fn in_simple_string_type_definition(&self) -> bool { + /// Return `true` if the context is in a string type definition. + pub const fn in_string_type_definition(&self) -> bool { self.flags - .intersects(SemanticModelFlags::SIMPLE_STRING_TYPE_DEFINITION) + .intersects(SemanticModelFlags::STRING_TYPE_DEFINITION) } - /// Return `true` if the context is in a "complex" string type definition. - pub const fn in_complex_string_type_definition(&self) -> bool { - self.flags - .intersects(SemanticModelFlags::COMPLEX_STRING_TYPE_DEFINITION) - } - - /// Return `true` if the context is in a `__future__` type definition. - pub const fn in_future_type_definition(&self) -> bool { - self.flags - .intersects(SemanticModelFlags::FUTURE_TYPE_DEFINITION) - } - - /// Return `true` if the context is in any kind of deferred type definition. - pub const fn in_deferred_type_definition(&self) -> bool { - self.flags - .intersects(SemanticModelFlags::DEFERRED_TYPE_DEFINITION) + /// Return `true` if the context is in any kind of type definition. + pub const fn in_type_definition(&self) -> bool { + self.flags.intersects(SemanticModelFlags::TYPE_DEFINITION) } /// Return `true` if the context is in a type-checking block. @@ -98,6 +85,19 @@ impl ResolvedReference { self.flags .intersects(SemanticModelFlags::DUNDER_ALL_DEFINITION) } + + /// Return `true` if the context is in the r.h.s. of a [PEP 613] type alias. + /// + /// [PEP 613]: https://peps.python.org/pep-0613/ + pub const fn in_annotated_type_alias_value(&self) -> bool { + self.flags + .intersects(SemanticModelFlags::ANNOTATED_TYPE_ALIAS) + } + + /// Return `true` if the context is inside an `assert` statement + pub const fn in_assert_statement(&self) -> bool { + self.flags.intersects(SemanticModelFlags::ASSERT_STATEMENT) + } } impl Ranged for ResolvedReference { diff --git a/crates/ruff_python_semantic/src/scope.rs b/crates/ruff_python_semantic/src/scope.rs index a7a69fd555390..0ac31f26cc5e8 100644 --- a/crates/ruff_python_semantic/src/scope.rs +++ b/crates/ruff_python_semantic/src/scope.rs @@ -4,7 +4,7 @@ use bitflags::bitflags; use ruff_python_ast as ast; use rustc_hash::FxHashMap; -use ruff_index::{newtype_index, Idx, IndexSlice, IndexVec}; +use ruff_index::{Idx, IndexSlice, IndexVec, newtype_index}; use crate::binding::BindingId; use crate::globals::GlobalsId; @@ -170,13 +170,24 @@ bitflags! { pub enum ScopeKind<'a> { Class(&'a ast::StmtClassDef), Function(&'a ast::StmtFunctionDef), - Generator, + Generator { + kind: GeneratorKind, + is_async: bool, + }, Module, /// A Python 3.12+ [annotation scope](https://docs.python.org/3/reference/executionmodel.html#annotation-scopes) Type, Lambda(&'a ast::ExprLambda), } +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum GeneratorKind { + Generator, + ListComprehension, + DictComprehension, + SetComprehension, +} + /// Id uniquely identifying a scope in a program. /// /// Using a `u32` is sufficient because Ruff only supports parsing documents with a size of max `u32::max` @@ -247,7 +258,7 @@ impl<'a> Deref for Scopes<'a> { } } -impl<'a> DerefMut for Scopes<'a> { +impl DerefMut for Scopes<'_> { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } diff --git a/crates/ruff_python_stdlib/Cargo.toml b/crates/ruff_python_stdlib/Cargo.toml index 19d5df0328f43..43f08f874bd33 100644 --- a/crates/ruff_python_stdlib/Cargo.toml +++ b/crates/ruff_python_stdlib/Cargo.toml @@ -13,6 +13,7 @@ license = { workspace = true } [lib] [dependencies] +bitflags = { workspace = true } unicode-ident = { workspace = true } [lints] diff --git a/crates/ruff_python_stdlib/src/builtins.rs b/crates/ruff_python_stdlib/src/builtins.rs index 020029de9e5a7..02830f9360c9c 100644 --- a/crates/ruff_python_stdlib/src/builtins.rs +++ b/crates/ruff_python_stdlib/src/builtins.rs @@ -379,9 +379,9 @@ pub fn is_python_builtin(name: &str, minor_version: u8, is_notebook: bool) -> bo | "type" | "vars" | "zip" - ) | (10..=13, "EncodingWarning" | "aiter" | "anext") - | (11..=13, "BaseExceptionGroup" | "ExceptionGroup") - | (13, "PythonFinalizationError") + ) | (10.., "EncodingWarning" | "aiter" | "anext") + | (11.., "BaseExceptionGroup" | "ExceptionGroup") + | (13.., "PythonFinalizationError") ) } @@ -489,8 +489,8 @@ pub fn is_exception(name: &str, minor_version: u8) -> bool { | "SyntaxWarning" | "UnicodeWarning" | "UserWarning" - ) | (10..=13, "EncodingWarning") - | (11..=13, "BaseExceptionGroup" | "ExceptionGroup") - | (13, "PythonFinalizationError") + ) | (10.., "EncodingWarning") + | (11.., "BaseExceptionGroup" | "ExceptionGroup") + | (13.., "PythonFinalizationError") ) } diff --git a/crates/ruff_python_stdlib/src/keyword.rs b/crates/ruff_python_stdlib/src/keyword.rs index 7f361c0b6988f..6057a0d9cf1dc 100644 --- a/crates/ruff_python_stdlib/src/keyword.rs +++ b/crates/ruff_python_stdlib/src/keyword.rs @@ -1,5 +1,5 @@ // See: https://github.com/python/cpython/blob/9d692841691590c25e6cf5b2250a594d3bf54825/Lib/keyword.py#L18 -pub(crate) fn is_keyword(name: &str) -> bool { +pub fn is_keyword(name: &str) -> bool { matches!( name, "False" diff --git a/crates/ruff_python_stdlib/src/lib.rs b/crates/ruff_python_stdlib/src/lib.rs index 009aebe0d4c4b..a57f4315d6eec 100644 --- a/crates/ruff_python_stdlib/src/lib.rs +++ b/crates/ruff_python_stdlib/src/lib.rs @@ -3,6 +3,7 @@ pub mod future; pub mod identifiers; pub mod keyword; pub mod logging; +pub mod open_mode; pub mod path; pub mod str; pub mod sys; diff --git a/crates/ruff_python_stdlib/src/open_mode.rs b/crates/ruff_python_stdlib/src/open_mode.rs new file mode 100644 index 0000000000000..e2257ebe73541 --- /dev/null +++ b/crates/ruff_python_stdlib/src/open_mode.rs @@ -0,0 +1,146 @@ +bitflags::bitflags! { + #[derive(Copy, Clone, Debug, PartialEq, Eq)] + pub struct OpenMode: u8 { + /// `r` + const READ = 1 << 0; + /// `w` + const WRITE = 1 << 1; + /// `a` + const APPEND = 1 << 2; + /// `x` + const CREATE = 1 << 3; + /// `b` + const BINARY = 1 << 4; + /// `t` + const TEXT = 1 << 5; + /// `+` + const PLUS = 1 << 6; + /// `U` + const UNIVERSAL_NEWLINES = 1 << 7; + } +} + +impl OpenMode { + /// Parse an [`OpenMode`] from a sequence of characters. + pub fn from_chars(chars: impl Iterator<Item = char>) -> Result<Self, String> { + let mut open_mode = OpenMode::empty(); + for c in chars { + let flag = OpenMode::try_from(c)?; + if flag.intersects(open_mode) { + return Err(format!("Open mode contains duplicate flag: `{c}`")); + } + open_mode.insert(flag); + } + + // Both text and binary mode cannot be set at the same time. + if open_mode.contains(OpenMode::TEXT | OpenMode::BINARY) { + return Err( + "Open mode cannot contain both text (`t`) and binary (`b`) flags".to_string(), + ); + } + + // The `U` mode is only valid with `r`. + if open_mode.contains(OpenMode::UNIVERSAL_NEWLINES) + && open_mode.intersects(OpenMode::WRITE | OpenMode::APPEND | OpenMode::CREATE) + { + return Err("Open mode cannot contain the universal newlines (`U`) flag with write (`w`), append (`a`), or create (`x`) flags".to_string()); + } + + // Otherwise, reading, writing, creating, and appending are mutually exclusive. + if [ + OpenMode::READ | OpenMode::UNIVERSAL_NEWLINES, + OpenMode::WRITE, + OpenMode::CREATE, + OpenMode::APPEND, + ] + .into_iter() + .filter(|flag| open_mode.intersects(*flag)) + .count() + != 1 + { + return Err("Open mode must contain exactly one of the following flags: read (`r`), write (`w`), create (`x`), or append (`a`)".to_string()); + } + + Ok(open_mode) + } + + /// Remove any redundant flags from the open mode. + #[must_use] + pub fn reduce(self) -> Self { + let mut open_mode = self; + + // `t` is always redundant. + open_mode.remove(Self::TEXT); + + // `U` is always redundant. + open_mode.remove(Self::UNIVERSAL_NEWLINES); + + // `r` is redundant, unless `b` or `+` is also set, in which case, we need one of `w`, `a`, `r`, or `x`. + if open_mode.intersects(Self::BINARY | Self::PLUS) { + if !open_mode.intersects(Self::WRITE | Self::CREATE | Self::APPEND) { + open_mode.insert(Self::READ); + } + } else { + open_mode.remove(Self::READ); + } + + open_mode + } +} + +/// Write the [`OpenMode`] as a string. +impl std::fmt::Display for OpenMode { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + if self.contains(OpenMode::READ) { + write!(f, "r")?; + } + if self.contains(OpenMode::WRITE) { + write!(f, "w")?; + } + if self.contains(OpenMode::APPEND) { + write!(f, "a")?; + } + if self.contains(OpenMode::CREATE) { + write!(f, "x")?; + } + if self.contains(OpenMode::UNIVERSAL_NEWLINES) { + write!(f, "U")?; + } + if self.contains(OpenMode::BINARY) { + write!(f, "b")?; + } + if self.contains(OpenMode::TEXT) { + write!(f, "t")?; + } + if self.contains(OpenMode::PLUS) { + write!(f, "+")?; + } + Ok(()) + } +} + +impl TryFrom<char> for OpenMode { + type Error = String; + + fn try_from(value: char) -> Result<Self, Self::Error> { + match value { + 'r' => Ok(Self::READ), + 'w' => Ok(Self::WRITE), + 'a' => Ok(Self::APPEND), + 'x' => Ok(Self::CREATE), + 'b' => Ok(Self::BINARY), + 't' => Ok(Self::TEXT), + '+' => Ok(Self::PLUS), + 'U' => Ok(Self::UNIVERSAL_NEWLINES), + _ => Err(format!("Invalid open mode flag: `{value}`")), + } + } +} + +impl TryFrom<&str> for OpenMode { + type Error = String; + + fn try_from(value: &str) -> Result<Self, Self::Error> { + OpenMode::from_chars(value.chars()) + } +} diff --git a/crates/ruff_python_stdlib/src/str.rs b/crates/ruff_python_stdlib/src/str.rs index 048b2e59296cc..fe6936f41e820 100644 --- a/crates/ruff_python_stdlib/src/str.rs +++ b/crates/ruff_python_stdlib/src/str.rs @@ -28,7 +28,7 @@ pub fn is_lowercase(s: &str) -> bool { _ => { return s[i..] .chars() - .all(|c| c.is_lowercase() || !c.is_alphabetic()) + .all(|c| c.is_lowercase() || !c.is_alphabetic()); } } } @@ -65,7 +65,7 @@ pub fn is_uppercase(s: &str) -> bool { _ => { return s[i..] .chars() - .all(|c| c.is_uppercase() || !c.is_alphabetic()) + .all(|c| c.is_uppercase() || !c.is_alphabetic()); } } } diff --git a/crates/ruff_python_stdlib/src/sys/builtin_modules.rs b/crates/ruff_python_stdlib/src/sys/builtin_modules.rs index 6000857a2f821..9fce83d0ef8c8 100644 --- a/crates/ruff_python_stdlib/src/sys/builtin_modules.rs +++ b/crates/ruff_python_stdlib/src/sys/builtin_modules.rs @@ -9,7 +9,7 @@ /// modules. /// /// [builtin module]: https://docs.python.org/3/library/sys.html#sys.builtin_module_names -#[allow(clippy::unnested_or_patterns)] +#[expect(clippy::unnested_or_patterns)] pub fn is_builtin_module(minor_version: u8, module: &str) -> bool { matches!( (minor_version, module), diff --git a/crates/ruff_python_stdlib/src/sys/known_stdlib.rs b/crates/ruff_python_stdlib/src/sys/known_stdlib.rs index 7c08ebe800aac..4ab64366fc400 100644 --- a/crates/ruff_python_stdlib/src/sys/known_stdlib.rs +++ b/crates/ruff_python_stdlib/src/sys/known_stdlib.rs @@ -23,7 +23,6 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "_collections" | "_collections_abc" | "_compat_pickle" - | "_compression" | "_contextvars" | "_csv" | "_ctypes" @@ -285,6 +284,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { ) | ( 7, "_bootlocale" + | "_compression" | "_crypt" | "_dummy_thread" | "_msi" @@ -324,6 +324,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { ) | ( 8, "_bootlocale" + | "_compression" | "_crypt" | "_dummy_thread" | "_msi" @@ -368,6 +369,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { "_aix_support" | "_bootlocale" | "_bootsubprocess" + | "_compression" | "_crypt" | "_msi" | "_peg_parser" @@ -399,7 +401,6 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "nntplib" | "ossaudiodev" | "parser" - | "peg_parser" | "pipes" | "smtpd" | "sndhdr" @@ -414,6 +415,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { 10, "_aix_support" | "_bootsubprocess" + | "_compression" | "_crypt" | "_msi" | "_posixshmem" @@ -460,6 +462,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "__phello_alias__" | "_aix_support" | "_bootsubprocess" + | "_compression" | "_crypt" | "_msi" | "_posixshmem" @@ -507,6 +510,7 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "__hello_only__" | "__phello_alias__" | "_aix_support" + | "_compression" | "_crypt" | "_msi" | "_posixshmem" @@ -554,7 +558,9 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "__phello_alias__" | "_aix_support" | "_android_support" + | "_apple_support" | "_colorize" + | "_compression" | "_interpchannels" | "_interpqueues" | "_interpreters" @@ -583,6 +589,50 @@ pub fn is_known_standard_library(minor_version: u8, module: &str) -> bool { | "tomllib" | "xxlimited_35" | "zoneinfo" + ) | ( + 14, + "__hello_alias__" + | "__hello_only__" + | "__phello_alias__" + | "_aix_support" + | "_android_support" + | "_apple_support" + | "_ast_unparse" + | "_colorize" + | "_hmac" + | "_interpchannels" + | "_interpqueues" + | "_interpreters" + | "_ios_support" + | "_opcode_metadata" + | "_posixshmem" + | "_py_warnings" + | "_pydatetime" + | "_pylong" + | "_pyrepl" + | "_remote_debugging" + | "_sha2" + | "_statistics" + | "_suggestions" + | "_sysconfig" + | "_testcapi_datetime" + | "_testclinic" + | "_testclinic_limited" + | "_testinternalcapi" + | "_testlimitedcapi" + | "_testsinglephase" + | "_tokenize" + | "_types" + | "_typing" + | "_wmi" + | "_zoneinfo" + | "_zstd" + | "annotationlib" + | "compression" + | "graphlib" + | "tomllib" + | "xxlimited_35" + | "zoneinfo" ) ) } diff --git a/crates/ruff_python_stdlib/src/typing.rs b/crates/ruff_python_stdlib/src/typing.rs index ef250d2df68cf..54dd23093199d 100644 --- a/crates/ruff_python_stdlib/src/typing.rs +++ b/crates/ruff_python_stdlib/src/typing.rs @@ -126,6 +126,13 @@ pub fn is_pep_593_generic_type(qualified_name: &[&str]) -> bool { ) } +pub fn is_typed_dict(qualified_name: &[&str]) -> bool { + matches!( + qualified_name, + ["typing" | "typing_extensions", "TypedDict"] + ) +} + /// Returns `true` if a call path is `Literal`. pub fn is_standard_library_literal(qualified_name: &[&str]) -> bool { matches!(qualified_name, ["typing" | "typing_extensions", "Literal"]) @@ -216,6 +223,15 @@ pub fn is_pep_593_generic_member(member: &str) -> bool { matches!(member, "Annotated") } +/// Returns `true` if a name matches that of `TypedDict`. +/// +/// See: <https://docs.python.org/3/library/typing.html> +pub fn is_typed_dict_member(member: &str) -> bool { + // Constructed by taking every pattern from `is_pep_593_generic`, removing all but + // the last element in each pattern, and de-duplicating the values. + matches!(member, "TypedDict") +} + /// Returns `true` if a name matches that of the `Literal` generic. pub fn is_literal_member(member: &str) -> bool { matches!(member, "Literal") diff --git a/crates/ruff_python_trivia/src/comments.rs b/crates/ruff_python_trivia/src/comments.rs index 6eb42c26f3074..bd9d14b85fda6 100644 --- a/crates/ruff_python_trivia/src/comments.rs +++ b/crates/ruff_python_trivia/src/comments.rs @@ -1,6 +1,6 @@ use ruff_text_size::TextRange; -use crate::{is_python_whitespace, PythonWhitespace}; +use crate::{PythonWhitespace, is_python_whitespace}; #[derive(Copy, Clone, Eq, PartialEq, Debug)] pub enum SuppressionKind { diff --git a/crates/ruff_python_trivia/src/cursor.rs b/crates/ruff_python_trivia/src/cursor.rs index c06d83156549d..8ab9c37d41f4b 100644 --- a/crates/ruff_python_trivia/src/cursor.rs +++ b/crates/ruff_python_trivia/src/cursor.rs @@ -56,10 +56,8 @@ impl<'a> Cursor<'a> { self.chars.clone().next_back().unwrap_or(EOF_CHAR) } - // SAFETY: The `source.text_len` call in `new` would panic if the string length is larger than a `u32`. - #[allow(clippy::cast_possible_truncation)] pub fn text_len(&self) -> TextSize { - TextSize::new(self.chars.as_str().len() as u32) + self.chars.as_str().text_len() } pub fn token_len(&self) -> TextSize { @@ -94,6 +92,33 @@ impl<'a> Cursor<'a> { } } + /// Eats the next two characters if they are `c1` and `c2`. Does not + /// consume any input otherwise, even if the first character matches. + pub fn eat_char2(&mut self, c1: char, c2: char) -> bool { + let mut chars = self.chars.clone(); + if chars.next() == Some(c1) && chars.next() == Some(c2) { + self.bump(); + self.bump(); + true + } else { + false + } + } + + /// Eats the next three characters if they are `c1`, `c2` and `c3` + /// Does not consume any input otherwise, even if the first character matches. + pub fn eat_char3(&mut self, c1: char, c2: char, c3: char) -> bool { + let mut chars = self.chars.clone(); + if chars.next() == Some(c1) && chars.next() == Some(c2) && chars.next() == Some(c3) { + self.bump(); + self.bump(); + self.bump(); + true + } else { + false + } + } + pub fn eat_char_back(&mut self, c: char) -> bool { if self.last() == c { self.bump_back(); @@ -103,6 +128,16 @@ impl<'a> Cursor<'a> { } } + /// Eats the next character if `predicate` returns `true`. + pub fn eat_if(&mut self, mut predicate: impl FnMut(char) -> bool) -> bool { + if predicate(self.first()) && !self.is_eof() { + self.bump(); + true + } else { + false + } + } + /// Eats symbols while predicate returns true or until the end of file is reached. pub fn eat_while(&mut self, mut predicate: impl FnMut(char) -> bool) { // It was tried making optimized version of this for eg. line comments, but diff --git a/crates/ruff_python_trivia/src/tokenizer.rs b/crates/ruff_python_trivia/src/tokenizer.rs index 9b42665235f5b..8b59197b77d69 100644 --- a/crates/ruff_python_trivia/src/tokenizer.rs +++ b/crates/ruff_python_trivia/src/tokenizer.rs @@ -2,7 +2,7 @@ use unicode_ident::{is_xid_continue, is_xid_start}; use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; -use crate::{is_python_whitespace, Cursor}; +use crate::{Cursor, is_python_whitespace}; /// Searches for the first non-trivia character after `offset`. /// @@ -30,7 +30,7 @@ pub fn find_only_token_in_range( let token = tokens.next().expect("Expected a token"); debug_assert_eq!(token.kind(), token_kind); let mut tokens = tokens.skip_while(|token| token.kind == SimpleTokenKind::LParen); - #[allow(clippy::debug_assert_with_mut_call)] + #[expect(clippy::debug_assert_with_mut_call)] { debug_assert_eq!(tokens.next(), None); } @@ -114,7 +114,7 @@ pub fn lines_after_ignoring_trivia(offset: TextSize, code: &str) -> u32 { /// Counts the empty lines after `offset`, ignoring any trailing trivia on the same line as /// `offset`. -#[allow(clippy::cast_possible_truncation)] +#[expect(clippy::cast_possible_truncation)] pub fn lines_after_ignoring_end_of_line_trivia(offset: TextSize, code: &str) -> u32 { // SAFETY: We don't support files greater than 4GB, so casting to u32 is safe. SimpleTokenizer::starts_at(offset, code) @@ -249,13 +249,13 @@ pub enum SimpleTokenKind { /// `;` Semi, - /// '/' + /// `/` Slash, - /// '*' + /// `*` Star, - /// `.`. + /// `.` Dot, /// `+` diff --git a/crates/ruff_python_trivia_integration_tests/tests/block_comments.rs b/crates/ruff_python_trivia_integration_tests/tests/block_comments.rs index 13bec0bc43da6..b522350c890d4 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/block_comments.rs +++ b/crates/ruff_python_trivia_integration_tests/tests/block_comments.rs @@ -1,4 +1,4 @@ -use ruff_python_parser::{parse_unchecked, Mode}; +use ruff_python_parser::{Mode, ParseOptions, parse_unchecked}; use ruff_python_trivia::CommentRanges; use ruff_text_size::TextSize; @@ -6,7 +6,7 @@ use ruff_text_size::TextSize; fn block_comments_two_line_block_at_start() { // arrange let source = "# line 1\n# line 2\n"; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -20,7 +20,7 @@ fn block_comments_two_line_block_at_start() { fn block_comments_indented_block() { // arrange let source = " # line 1\n # line 2\n"; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -34,7 +34,7 @@ fn block_comments_indented_block() { fn block_comments_single_line_is_not_a_block() { // arrange let source = "\n"; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -48,7 +48,7 @@ fn block_comments_single_line_is_not_a_block() { fn block_comments_lines_with_code_not_a_block() { // arrange let source = "x = 1 # line 1\ny = 2 # line 2\n"; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -62,7 +62,7 @@ fn block_comments_lines_with_code_not_a_block() { fn block_comments_sequential_lines_not_in_block() { // arrange let source = " # line 1\n # line 2\n"; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -81,7 +81,7 @@ fn block_comments_lines_in_triple_quotes_not_a_block() { # line 2 """ "#; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act @@ -117,7 +117,7 @@ y = 2 # do not form a block comment # therefore do not form a block comment """ "#; - let parsed = parse_unchecked(source, Mode::Module); + let parsed = parse_unchecked(source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); // act diff --git a/crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs b/crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs index b609294855be2..b26218732b47e 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs +++ b/crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs @@ -1,8 +1,8 @@ use insta::assert_debug_snapshot; -use ruff_python_parser::{parse_unchecked, Mode}; -use ruff_python_trivia::{lines_after, lines_before, CommentRanges, SimpleToken, SimpleTokenizer}; +use ruff_python_parser::{Mode, ParseOptions, parse_unchecked}; use ruff_python_trivia::{BackwardsTokenizer, SimpleTokenKind}; +use ruff_python_trivia::{CommentRanges, SimpleToken, SimpleTokenizer, lines_after, lines_before}; use ruff_text_size::{TextLen, TextRange, TextSize}; struct TokenizationTestCase { @@ -22,7 +22,7 @@ impl TokenizationTestCase { } fn tokenize_reverse(&self) -> Vec<SimpleToken> { - let parsed = parse_unchecked(self.source, Mode::Module); + let parsed = parse_unchecked(self.source, ParseOptions::from(Mode::Module)); let comment_ranges = CommentRanges::from(parsed.tokens()); BackwardsTokenizer::new(self.source, self.range, &comment_ranges).collect() } diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__Reverse.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__Reverse.snap index 7763ffb690faa..f4614ed26f4d1 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__Reverse.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__Reverse.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_single_quoted_string.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_single_quoted_string.snap index 36ea89df615a6..699e3130c59ff 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_single_quoted_string.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_single_quoted_string.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_triple_quoted_string.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_triple_quoted_string.snap index a794749cff8b7..8e87897557278 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_triple_quoted_string.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__comment_containing_triple_quoted_string.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__empty_string_literal.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__empty_string_literal.snap index 1d420e049fff8..a933106fb5892 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__empty_string_literal.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__empty_string_literal.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_ending_in_non_start_char.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_ending_in_non_start_char.snap index 32e4f33792166..8a103b0b326ba 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_ending_in_non_start_char.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_ending_in_non_start_char.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_starting_with_string_kind.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_starting_with_string_kind.snap index 04086f5524d95..2f53b7c310ede 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_starting_with_string_kind.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__identifier_starting_with_string_kind.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__ignore_word_with_only_id_continuing_chars.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__ignore_word_with_only_id_continuing_chars.snap index a1248f3b41757..cde01b5c9229f 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__ignore_word_with_only_id_continuing_chars.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__ignore_word_with_only_id_continuing_chars.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_containing_comment.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_containing_comment.snap index 913b78999147b..9ea71461d791f 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_containing_comment.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_containing_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_implicit_concatenation.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_implicit_concatenation.snap index 88771f8ce203c..126ec9b8e61a9 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_implicit_concatenation.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__single_quoted_multiline_string_implicit_concatenation.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_followed_by_multiple_comments.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_followed_by_multiple_comments.snap index 2c623fbaad788..94eea3583ed75 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_followed_by_multiple_comments.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_followed_by_multiple_comments.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_byte_kind.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_byte_kind.snap index 13e26326e639b..719d4e66f2d3b 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_byte_kind.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_byte_kind.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_double_escaped_backslash.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_double_escaped_backslash.snap index 84ac21254d58a..a98f8fe692ad7 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_double_escaped_backslash.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_double_escaped_backslash.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_escaped_quote.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_escaped_quote.snap index 1bf0706e3aa8d..94db4e41925a3 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_escaped_quote.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_escaped_quote.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_invalid_kind.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_invalid_kind.snap index cdcaad2ccb9ec..1fe760036d3cc 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_invalid_kind.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_invalid_kind.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_kind.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_kind.snap index 4f20942cc6adb..4a90600501e50 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_kind.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__string_with_kind.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_bogus.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_bogus.snap index ab66aa9c11246..a93275d7eb576 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_bogus.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_bogus.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_comma.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_comma.snap index be4f7308d7119..1696508a86877 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_comma.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_comma.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_continuation.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_continuation.snap index 801a7a65dda01..841305918aa96 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_continuation.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_continuation.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_eq.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_eq.snap index 4bab77b6815ba..59556fbcd12a5 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_eq.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_eq.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_invalid_operators.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_invalid_operators.snap index 78f03749431e5..9815b84346453 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_invalid_operators.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_invalid_operators.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_multichar.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_multichar.snap index 4cc2111b55a17..38da7f9ddf1bb 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_multichar.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_multichar.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_not_eq.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_not_eq.snap index e2db4103477f9..313f9770d5c60 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_not_eq.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_not_eq.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_operators.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_operators.snap index e0430a95530c5..cc6069484861d 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_operators.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_operators.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_parentheses.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_parentheses.snap index 0e3bedccd50e1..7eccb8ed6d1d9 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_parentheses.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_parentheses.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_slash.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_slash.snap index 43c5d6d815586..74a0a87d3ffb7 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_slash.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_slash.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_substring.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_substring.snap index d3b74a107450e..0961dcbc6d235 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_substring.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_substring.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_trivia.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_trivia.snap index 4872572e9183a..f2683c4796148 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_trivia.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tokenize_trivia.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tricky_unicode.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tricky_unicode.snap index bc8a977653192..5ac529b3448aa 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tricky_unicode.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__tricky_unicode.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokens() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__triple_quoted_multiline_string_containing_comment.snap b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__triple_quoted_multiline_string_containing_comment.snap index e2081323a1975..174a2521f9135 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__triple_quoted_multiline_string_containing_comment.snap +++ b/crates/ruff_python_trivia_integration_tests/tests/snapshots/simple_tokenizer__triple_quoted_multiline_string_containing_comment.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_python_trivia_integration_tests/tests/simple_tokenizer.rs expression: test_case.tokenize_reverse() +snapshot_kind: text --- [ SimpleToken { diff --git a/crates/ruff_python_trivia_integration_tests/tests/whitespace.rs b/crates/ruff_python_trivia_integration_tests/tests/whitespace.rs index feb2268615f4b..630ee6da4d7e6 100644 --- a/crates/ruff_python_trivia_integration_tests/tests/whitespace.rs +++ b/crates/ruff_python_trivia_integration_tests/tests/whitespace.rs @@ -1,4 +1,4 @@ -use ruff_python_parser::{parse_module, ParseError}; +use ruff_python_parser::{ParseError, parse_module}; use ruff_python_trivia::has_trailing_content; use ruff_text_size::Ranged; diff --git a/crates/ruff_server/Cargo.toml b/crates/ruff_server/Cargo.toml index c9678e1a12b32..5b7e682d07d3e 100644 --- a/crates/ruff_server/Cargo.toml +++ b/crates/ruff_server/Cargo.toml @@ -38,8 +38,10 @@ serde = { workspace = true } serde_json = { workspace = true } shellexpand = { workspace = true } thiserror = { workspace = true } +toml = { workspace = true } tracing = { workspace = true } -tracing-subscriber = { workspace = true } +tracing-log = { workspace = true } +tracing-subscriber = { workspace = true, features = ["chrono"] } [dev-dependencies] insta = { workspace = true } diff --git a/crates/ruff_server/resources/test/fixtures/settings/inline_configuration.json b/crates/ruff_server/resources/test/fixtures/settings/inline_configuration.json new file mode 100644 index 0000000000000..50460eb0b350b --- /dev/null +++ b/crates/ruff_server/resources/test/fixtures/settings/inline_configuration.json @@ -0,0 +1,16 @@ +{ + "settings": { + "configuration": { + "line-length": 100, + "lint": { + "extend-select": ["I001"] + }, + "format": { + "quote-style": "single" + } + }, + "lint": { + "extendSelect": ["RUF001"] + } + } +} diff --git a/crates/ruff_server/src/edit.rs b/crates/ruff_server/src/edit.rs index 3a7ffb4e3eb73..d0dfb91ae3e25 100644 --- a/crates/ruff_server/src/edit.rs +++ b/crates/ruff_server/src/edit.rs @@ -31,6 +31,16 @@ pub enum PositionEncoding { UTF8, } +impl From<PositionEncoding> for ruff_source_file::PositionEncoding { + fn from(value: PositionEncoding) -> Self { + match value { + PositionEncoding::UTF8 => Self::Utf8, + PositionEncoding::UTF16 => Self::Utf16, + PositionEncoding::UTF32 => Self::Utf32, + } + } +} + /// A unique document ID, derived from a URL passed as part of an LSP request. /// This document ID can point to either be a standalone Python file, a full notebook, or a cell within a notebook. #[derive(Clone, Debug)] diff --git a/crates/ruff_server/src/edit/notebook.rs b/crates/ruff_server/src/edit/notebook.rs index 7e0c65e9174f3..154628d862639 100644 --- a/crates/ruff_server/src/edit/notebook.rs +++ b/crates/ruff_server/src/edit/notebook.rs @@ -118,7 +118,7 @@ impl NotebookDocument { // This is required because of the way the `NotebookCell` is modelled. We include // the `TextDocument` within the `NotebookCell` so when it's deleted, the // corresponding `TextDocument` is removed as well. But, when cells are - // re-oredered, the change request doesn't provide the actual contents of the cell. + // re-ordered, the change request doesn't provide the actual contents of the cell. // Instead, it only provides that (a) these cell URIs were removed, and (b) these // cell URIs were added. // https://github.com/astral-sh/ruff/issues/12573 @@ -136,17 +136,15 @@ impl NotebookDocument { // provide the actual contents of the cells, so we'll initialize them with empty // contents. for cell in structure.array.cells.into_iter().flatten().rev() { - if let Some(text_document) = deleted_cells.remove(&cell.document) { - let version = text_document.version(); - self.cells.push(NotebookCell::new( - cell, - text_document.into_contents(), - version, - )); - } else { - self.cells - .insert(start, NotebookCell::new(cell, String::new(), 0)); - } + let (content, version) = + if let Some(text_document) = deleted_cells.remove(&cell.document) { + let version = text_document.version(); + (text_document.into_contents(), version) + } else { + (String::new(), 0) + }; + self.cells + .insert(start, NotebookCell::new(cell, content, version)); } // Third, register the new cells in the index and update existing ones that came @@ -243,3 +241,115 @@ impl NotebookCell { } } } + +#[cfg(test)] +mod tests { + use super::NotebookDocument; + + enum TestCellContent { + #[expect(dead_code)] + Markup(String), + Code(String), + } + + fn create_test_url(index: usize) -> lsp_types::Url { + lsp_types::Url::parse(&format!("cell:/test.ipynb#{index}")).unwrap() + } + + fn create_test_notebook(test_cells: Vec<TestCellContent>) -> NotebookDocument { + let mut cells = Vec::with_capacity(test_cells.len()); + let mut cell_documents = Vec::with_capacity(test_cells.len()); + + for (index, test_cell) in test_cells.into_iter().enumerate() { + let url = create_test_url(index); + match test_cell { + TestCellContent::Markup(content) => { + cells.push(lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Markup, + document: url.clone(), + metadata: None, + execution_summary: None, + }); + cell_documents.push(lsp_types::TextDocumentItem { + uri: url, + language_id: "markdown".to_owned(), + version: 0, + text: content, + }); + } + TestCellContent::Code(content) => { + cells.push(lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: url.clone(), + metadata: None, + execution_summary: None, + }); + cell_documents.push(lsp_types::TextDocumentItem { + uri: url, + language_id: "python".to_owned(), + version: 0, + text: content, + }); + } + } + } + + NotebookDocument::new(0, cells, serde_json::Map::default(), cell_documents).unwrap() + } + + /// This test case checks that for a notebook with three code cells, when the client sends a + /// change request to swap the first two cells, the notebook document is updated correctly. + /// + /// The swap operation as a change request is represented as deleting the first two cells and + /// adding them back in the reverse order. + #[test] + fn swap_cells() { + let mut notebook = create_test_notebook(vec![ + TestCellContent::Code("cell = 0".to_owned()), + TestCellContent::Code("cell = 1".to_owned()), + TestCellContent::Code("cell = 2".to_owned()), + ]); + + notebook + .update( + Some(lsp_types::NotebookDocumentCellChange { + structure: Some(lsp_types::NotebookDocumentCellChangeStructure { + array: lsp_types::NotebookCellArrayChange { + start: 0, + delete_count: 2, + cells: Some(vec![ + lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: create_test_url(1), + metadata: None, + execution_summary: None, + }, + lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: create_test_url(0), + metadata: None, + execution_summary: None, + }, + ]), + }, + did_open: None, + did_close: None, + }), + data: None, + text_content: None, + }), + None, + 1, + crate::PositionEncoding::default(), + ) + .unwrap(); + + assert_eq!( + notebook.make_ruff_notebook().source_code(), + "cell = 1 +cell = 0 +cell = 2 +" + ); + } +} diff --git a/crates/ruff_server/src/edit/range.rs b/crates/ruff_server/src/edit/range.rs index 9ccef9e67de03..91b461751e44e 100644 --- a/crates/ruff_server/src/edit/range.rs +++ b/crates/ruff_server/src/edit/range.rs @@ -1,10 +1,10 @@ -use super::notebook; use super::PositionEncoding; +use super::notebook; use lsp_types as types; use ruff_notebook::NotebookIndex; -use ruff_source_file::OneIndexed; -use ruff_source_file::{LineIndex, SourceLocation}; -use ruff_text_size::{TextRange, TextSize}; +use ruff_source_file::LineIndex; +use ruff_source_file::{OneIndexed, SourceLocation}; +use ruff_text_size::TextRange; pub(crate) struct NotebookRange { pub(crate) cell: notebook::CellId, @@ -13,7 +13,7 @@ pub(crate) struct NotebookRange { pub(crate) trait RangeExt { fn to_text_range(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) - -> TextRange; + -> TextRange; } pub(crate) trait ToRangeExt { @@ -38,76 +38,43 @@ impl RangeExt for lsp_types::Range { index: &LineIndex, encoding: PositionEncoding, ) -> TextRange { - let start_line = index.line_range( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.line)), + let start = index.offset( + SourceLocation { + line: OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.line)), + character_offset: OneIndexed::from_zero_indexed(u32_index_to_usize( + self.start.character, + )), + }, text, + encoding.into(), ); - let end_line = index.line_range( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.line)), + let end = index.offset( + SourceLocation { + line: OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.line)), + character_offset: OneIndexed::from_zero_indexed(u32_index_to_usize( + self.end.character, + )), + }, text, + encoding.into(), ); - let (start_column_offset, end_column_offset) = match encoding { - PositionEncoding::UTF8 => ( - TextSize::new(self.start.character), - TextSize::new(self.end.character), - ), - - PositionEncoding::UTF16 => { - // Fast path for ASCII only documents - if index.is_ascii() { - ( - TextSize::new(self.start.character), - TextSize::new(self.end.character), - ) - } else { - // UTF16 encodes characters either as one or two 16 bit words. - // The position in `range` is the 16-bit word offset from the start of the line (and not the character offset) - // UTF-16 with a text that may use variable-length characters. - ( - utf8_column_offset(self.start.character, &text[start_line]), - utf8_column_offset(self.end.character, &text[end_line]), - ) - } - } - PositionEncoding::UTF32 => { - // UTF-32 uses 4 bytes for each character. Meaning, the position in range is a character offset. - return TextRange::new( - index.offset( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.line)), - OneIndexed::from_zero_indexed(u32_index_to_usize(self.start.character)), - text, - ), - index.offset( - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.line)), - OneIndexed::from_zero_indexed(u32_index_to_usize(self.end.character)), - text, - ), - ); - } - }; - - TextRange::new( - start_line.start() + start_column_offset.clamp(TextSize::new(0), start_line.end()), - end_line.start() + end_column_offset.clamp(TextSize::new(0), end_line.end()), - ) + TextRange::new(start, end) } } impl ToRangeExt for TextRange { fn to_range(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) -> types::Range { types::Range { - start: source_location_to_position(&offset_to_source_location( + start: source_location_to_position(&index.source_location( self.start(), text, - index, - encoding, + encoding.into(), )), - end: source_location_to_position(&offset_to_source_location( + end: source_location_to_position(&index.source_location( self.end(), text, - index, - encoding, + encoding.into(), )), } } @@ -119,26 +86,26 @@ impl ToRangeExt for TextRange { notebook_index: &NotebookIndex, encoding: PositionEncoding, ) -> NotebookRange { - let start = offset_to_source_location(self.start(), text, source_index, encoding); - let mut end = offset_to_source_location(self.end(), text, source_index, encoding); - let starting_cell = notebook_index.cell(start.row); + let start = source_index.source_location(self.start(), text, encoding.into()); + let mut end = source_index.source_location(self.end(), text, encoding.into()); + let starting_cell = notebook_index.cell(start.line); // weird edge case here - if the end of the range is where the newline after the cell got added (making it 'out of bounds') // we need to move it one character back (which should place it at the end of the last line). // we test this by checking if the ending offset is in a different (or nonexistent) cell compared to the cell of the starting offset. - if notebook_index.cell(end.row) != starting_cell { - end.row = end.row.saturating_sub(1); - end.column = offset_to_source_location( - self.end().checked_sub(1.into()).unwrap_or_default(), - text, - source_index, - encoding, - ) - .column; + if notebook_index.cell(end.line) != starting_cell { + end.line = end.line.saturating_sub(1); + end.character_offset = source_index + .source_location( + self.end().checked_sub(1.into()).unwrap_or_default(), + text, + encoding.into(), + ) + .character_offset; } - let start = source_location_to_position(¬ebook_index.translate_location(&start)); - let end = source_location_to_position(¬ebook_index.translate_location(&end)); + let start = source_location_to_position(¬ebook_index.translate_source_location(&start)); + let end = source_location_to_position(¬ebook_index.translate_source_location(&end)); NotebookRange { cell: starting_cell @@ -149,67 +116,10 @@ impl ToRangeExt for TextRange { } } -/// Converts a UTF-16 code unit offset for a given line into a UTF-8 column number. -fn utf8_column_offset(utf16_code_unit_offset: u32, line: &str) -> TextSize { - let mut utf8_code_unit_offset = TextSize::new(0); - - let mut i = 0u32; - - for c in line.chars() { - if i >= utf16_code_unit_offset { - break; - } - - // Count characters encoded as two 16 bit words as 2 characters. - { - utf8_code_unit_offset += - TextSize::new(u32::try_from(c.len_utf8()).expect("utf8 len always <=4")); - i += u32::try_from(c.len_utf16()).expect("utf16 len always <=2"); - } - } - - utf8_code_unit_offset -} - -fn offset_to_source_location( - offset: TextSize, - text: &str, - index: &LineIndex, - encoding: PositionEncoding, -) -> SourceLocation { - match encoding { - PositionEncoding::UTF8 => { - let row = index.line_index(offset); - let column = offset - index.line_start(row, text); - - SourceLocation { - column: OneIndexed::from_zero_indexed(column.to_usize()), - row, - } - } - PositionEncoding::UTF16 => { - let row = index.line_index(offset); - - let column = if index.is_ascii() { - (offset - index.line_start(row, text)).to_usize() - } else { - let up_to_line = &text[TextRange::new(index.line_start(row, text), offset)]; - up_to_line.encode_utf16().count() - }; - - SourceLocation { - column: OneIndexed::from_zero_indexed(column), - row, - } - } - PositionEncoding::UTF32 => index.source_location(offset, text), - } -} - fn source_location_to_position(location: &SourceLocation) -> types::Position { types::Position { - line: u32::try_from(location.row.to_zero_indexed()).expect("row usize fits in u32"), - character: u32::try_from(location.column.to_zero_indexed()) + line: u32::try_from(location.line.to_zero_indexed()).expect("row usize fits in u32"), + character: u32::try_from(location.character_offset.to_zero_indexed()) .expect("character usize fits in u32"), } } diff --git a/crates/ruff_server/src/edit/text_document.rs b/crates/ruff_server/src/edit/text_document.rs index f709adf48cf18..e5d00ff0cf176 100644 --- a/crates/ruff_server/src/edit/text_document.rs +++ b/crates/ruff_server/src/edit/text_document.rs @@ -82,9 +82,11 @@ impl TextDocument { new_version: DocumentVersion, encoding: PositionEncoding, ) { - if let [lsp_types::TextDocumentContentChangeEvent { - range: None, text, .. - }] = changes.as_slice() + if let [ + lsp_types::TextDocumentContentChangeEvent { + range: None, text, .. + }, + ] = changes.as_slice() { tracing::debug!("Fast path - replacing entire document"); self.modify(|contents, version| { @@ -94,7 +96,6 @@ impl TextDocument { return; } - let old_contents = self.contents().to_string(); let mut new_contents = self.contents().to_string(); let mut active_index = self.index().clone(); @@ -115,15 +116,11 @@ impl TextDocument { new_contents = change; } - if new_contents != old_contents { - active_index = LineIndex::from_source_text(&new_contents); - } + active_index = LineIndex::from_source_text(&new_contents); } self.modify_with_manual_index(|contents, version, index| { - if contents != &new_contents { - *index = active_index; - } + *index = active_index; *contents = new_contents; *version = new_version; }); @@ -153,3 +150,75 @@ impl TextDocument { debug_assert!(self.version >= old_version); } } + +#[cfg(test)] +mod tests { + use crate::{PositionEncoding, TextDocument}; + use lsp_types::{Position, TextDocumentContentChangeEvent}; + + #[test] + fn redo_edit() { + let mut document = TextDocument::new( + r#"""" +测试comment +一些测试内容 +""" +import click + + +@click.group() +def interface(): + pas +"# + .to_string(), + 0, + ); + + // Add an `s`, remove it again (back to the original code), and then re-add the `s` + document.apply_changes( + vec![ + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 7), + )), + range_length: Some(0), + text: "s".to_string(), + }, + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 8), + )), + range_length: Some(1), + text: String::new(), + }, + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 7), + )), + range_length: Some(0), + text: "s".to_string(), + }, + ], + 1, + PositionEncoding::UTF16, + ); + + assert_eq!( + &document.contents, + r#"""" +测试comment +一些测试内容 +""" +import click + + +@click.group() +def interface(): + pass +"# + ); + } +} diff --git a/crates/ruff_server/src/fix.rs b/crates/ruff_server/src/fix.rs index 2b80f80a8fea4..a427b44228342 100644 --- a/crates/ruff_server/src/fix.rs +++ b/crates/ruff_server/src/fix.rs @@ -2,21 +2,21 @@ use std::borrow::Cow; use rustc_hash::FxHashMap; +use crate::{ + PositionEncoding, + edit::{Replacement, ToRangeExt}, + resolve::is_document_excluded_for_linting, + session::DocumentQuery, +}; +use ruff_linter::package::PackageRoot; use ruff_linter::{ - linter::{FixerResult, LinterResult}, + linter::FixerResult, packaging::detect_package_root, - settings::{flags, types::UnsafeFixes, LinterSettings}, + settings::{LinterSettings, flags}, }; use ruff_notebook::SourceValue; use ruff_source_file::LineIndex; -use crate::{ - edit::{Replacement, ToRangeExt}, - resolve::is_document_excluded, - session::DocumentQuery, - PositionEncoding, -}; - /// A simultaneous fix made across a single text document or among an arbitrary /// number of notebook cells. pub(crate) type Fixes = FxHashMap<lsp_types::Url, Vec<lsp_types::TextEdit>>; @@ -27,17 +27,15 @@ pub(crate) fn fix_all( encoding: PositionEncoding, ) -> crate::Result<Fixes> { let source_kind = query.make_source_kind(); - - let file_resolver_settings = query.settings().file_resolver(); + let settings = query.settings(); let document_path = query.file_path(); // If the document is excluded, return an empty list of fixes. let package = if let Some(document_path) = document_path.as_ref() { - if is_document_excluded( + if is_document_excluded_for_linting( document_path, - file_resolver_settings, - Some(linter_settings), - None, + &settings.file_resolver, + linter_settings, query.text_document_language_id(), ) { return Ok(Fixes::default()); @@ -49,6 +47,7 @@ pub(crate) fn fix_all( .expect("a path to a document should have a parent path"), &linter_settings.namespace_packages, ) + .map(PackageRoot::root) } else { None }; @@ -63,21 +62,19 @@ pub(crate) fn fix_all( // which is inconsistent with how `ruff check --fix` works. let FixerResult { transformed, - result: LinterResult { - has_syntax_error, .. - }, + result, .. } = ruff_linter::linter::lint_fix( &query.virtual_file_path(), package, flags::Noqa::Enabled, - UnsafeFixes::Disabled, + settings.unsafe_fixes, linter_settings, &source_kind, source_type, )?; - if has_syntax_error { + if result.has_invalid_syntax() { // If there's a syntax error, then there won't be any fixes to apply. return Ok(Fixes::default()); } diff --git a/crates/ruff_server/src/format.rs b/crates/ruff_server/src/format.rs index a2257ccedfc88..c2398ce020267 100644 --- a/crates/ruff_server/src/format.rs +++ b/crates/ruff_server/src/format.rs @@ -1,6 +1,8 @@ +use std::path::Path; + use ruff_formatter::PrintedRange; use ruff_python_ast::PySourceType; -use ruff_python_formatter::{format_module_source, FormatModuleError}; +use ruff_python_formatter::{FormatModuleError, format_module_source}; use ruff_text_size::TextRange; use ruff_workspace::FormatterSettings; @@ -10,8 +12,10 @@ pub(crate) fn format( document: &TextDocument, source_type: PySourceType, formatter_settings: &FormatterSettings, + path: Option<&Path>, ) -> crate::Result<Option<String>> { - let format_options = formatter_settings.to_format_options(source_type, document.contents()); + let format_options = + formatter_settings.to_format_options(source_type, document.contents(), path); match format_module_source(document.contents(), format_options) { Ok(formatted) => { let formatted = formatted.into_code(); @@ -36,8 +40,10 @@ pub(crate) fn format_range( source_type: PySourceType, formatter_settings: &FormatterSettings, range: TextRange, + path: Option<&Path>, ) -> crate::Result<Option<PrintedRange>> { - let format_options = formatter_settings.to_format_options(source_type, document.contents()); + let format_options = + formatter_settings.to_format_options(source_type, document.contents(), path); match ruff_python_formatter::format_range(document.contents(), range, format_options) { Ok(formatted) => { @@ -56,3 +62,146 @@ pub(crate) fn format_range( Err(err) => Err(err.into()), } } + +#[cfg(test)] +mod tests { + use std::path::Path; + + use insta::assert_snapshot; + use ruff_linter::settings::types::{CompiledPerFileTargetVersionList, PerFileTargetVersion}; + use ruff_python_ast::{PySourceType, PythonVersion}; + use ruff_text_size::{TextRange, TextSize}; + use ruff_workspace::FormatterSettings; + + use crate::TextDocument; + use crate::format::{format, format_range}; + + #[test] + fn format_per_file_version() { + let document = TextDocument::new(r#" +with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open("a_really_long_baz") as baz: + pass +"#.to_string(), 0); + let per_file_target_version = + CompiledPerFileTargetVersionList::resolve(vec![PerFileTargetVersion::new( + "test.py".to_string(), + PythonVersion::PY310, + Some(Path::new(".")), + )]) + .unwrap(); + let result = format( + &document, + PySourceType::Python, + &FormatterSettings { + unresolved_target_version: PythonVersion::PY38, + per_file_target_version, + ..Default::default() + }, + Some(Path::new("test.py")), + ) + .expect("Expected no errors when formatting") + .expect("Expected formatting changes"); + + assert_snapshot!(result, @r#" + with ( + open("a_really_long_foo") as foo, + open("a_really_long_bar") as bar, + open("a_really_long_baz") as baz, + ): + pass + "#); + + // same as above but without the per_file_target_version override + let result = format( + &document, + PySourceType::Python, + &FormatterSettings { + unresolved_target_version: PythonVersion::PY38, + ..Default::default() + }, + Some(Path::new("test.py")), + ) + .expect("Expected no errors when formatting") + .expect("Expected formatting changes"); + + assert_snapshot!(result, @r#" + with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open( + "a_really_long_baz" + ) as baz: + pass + "#); + } + + #[test] + fn format_per_file_version_range() -> anyhow::Result<()> { + // prepare a document with formatting changes before and after the intended range (the + // context manager) + let document = TextDocument::new(r#" +def fn(x: str) -> Foo | Bar: return foobar(x) + +with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open("a_really_long_baz") as baz: + pass + +sys.exit( +1 +) +"#.to_string(), 0); + + let start = document.contents().find("with").unwrap(); + let end = document.contents().find("pass").unwrap() + "pass".len(); + let range = TextRange::new(TextSize::try_from(start)?, TextSize::try_from(end)?); + + let per_file_target_version = + CompiledPerFileTargetVersionList::resolve(vec![PerFileTargetVersion::new( + "test.py".to_string(), + PythonVersion::PY310, + Some(Path::new(".")), + )]) + .unwrap(); + let result = format_range( + &document, + PySourceType::Python, + &FormatterSettings { + unresolved_target_version: PythonVersion::PY38, + per_file_target_version, + ..Default::default() + }, + range, + Some(Path::new("test.py")), + ) + .expect("Expected no errors when formatting") + .expect("Expected formatting changes"); + + assert_snapshot!(result.as_code(), @r#" + with ( + open("a_really_long_foo") as foo, + open("a_really_long_bar") as bar, + open("a_really_long_baz") as baz, + ): + pass + "#); + + // same as above but without the per_file_target_version override + let result = format_range( + &document, + PySourceType::Python, + &FormatterSettings { + unresolved_target_version: PythonVersion::PY38, + ..Default::default() + }, + range, + Some(Path::new("test.py")), + ) + .expect("Expected no errors when formatting") + .expect("Expected formatting changes"); + + assert_snapshot!(result.as_code(), @r#" + with open("a_really_long_foo") as foo, open("a_really_long_bar") as bar, open( + "a_really_long_baz" + ) as baz: + pass + "#); + + Ok(()) + } +} diff --git a/crates/ruff_server/src/lib.rs b/crates/ruff_server/src/lib.rs index ff0dc7ddb59b2..44d5e1bb52181 100644 --- a/crates/ruff_server/src/lib.rs +++ b/crates/ruff_server/src/lib.rs @@ -2,8 +2,9 @@ pub use edit::{DocumentKey, NotebookDocument, PositionEncoding, TextDocument}; use lsp_types::CodeActionKind; -pub use server::{Server, Workspace, Workspaces}; +pub use server::Server; pub use session::{ClientSettings, DocumentQuery, DocumentSnapshot, Session}; +pub use workspace::{Workspace, Workspaces}; #[macro_use] mod message; @@ -12,10 +13,11 @@ mod edit; mod fix; mod format; mod lint; +mod logging; mod resolve; mod server; mod session; -mod trace; +mod workspace; pub(crate) const SERVER_NAME: &str = "ruff"; pub(crate) const DIAGNOSTIC_NAME: &str = "Ruff"; diff --git a/crates/ruff_server/src/lint.rs b/crates/ruff_server/src/lint.rs index cb3fe3499b35d..9ad6be5276251 100644 --- a/crates/ruff_server/src/lint.rs +++ b/crates/ruff_server/src/lint.rs @@ -3,35 +3,37 @@ use rustc_hash::FxHashMap; use serde::{Deserialize, Serialize}; -use ruff_diagnostics::{Applicability, Diagnostic, DiagnosticKind, Edit, Fix}; +use crate::{ + DIAGNOSTIC_NAME, PositionEncoding, + edit::{NotebookRange, ToRangeExt}, + resolve::is_document_excluded_for_linting, + session::DocumentQuery, +}; +use ruff_diagnostics::{Applicability, Edit, Fix}; use ruff_linter::{ - directives::{extract_directives, Flags}, + Locator, + codes::Rule, + directives::{Flags, extract_directives}, generate_noqa_edits, linter::check_path, + message::Message, + package::PackageRoot, packaging::detect_package_root, - registry::AsRule, settings::flags, source_kind::SourceKind, - Locator, }; use ruff_notebook::Notebook; use ruff_python_codegen::Stylist; use ruff_python_index::Indexer; -use ruff_python_parser::ParseError; +use ruff_python_parser::ParseOptions; use ruff_source_file::LineIndex; use ruff_text_size::{Ranged, TextRange}; -use crate::{ - edit::{NotebookRange, ToRangeExt}, - resolve::is_document_excluded, - session::DocumentQuery, - PositionEncoding, DIAGNOSTIC_NAME, -}; - /// This is serialized on the diagnostic `data` field. #[derive(Serialize, Deserialize, Debug, Clone)] pub(crate) struct AssociatedDiagnosticData { - pub(crate) kind: DiagnosticKind, + /// The message describing what the fix does, if it exists, or the diagnostic name otherwise. + pub(crate) title: String, /// Edits to fix the diagnostic. If this is empty, a fix /// does not exist. pub(crate) edits: Vec<lsp_types::TextEdit>, @@ -67,17 +69,15 @@ pub(crate) fn check( show_syntax_errors: bool, ) -> DiagnosticsMap { let source_kind = query.make_source_kind(); - let file_resolver_settings = query.settings().file_resolver(); - let linter_settings = query.settings().linter(); + let settings = query.settings(); let document_path = query.file_path(); // If the document is excluded, return an empty list of diagnostics. let package = if let Some(document_path) = document_path.as_ref() { - if is_document_excluded( + if is_document_excluded_for_linting( document_path, - file_resolver_settings, - Some(linter_settings), - None, + &settings.file_resolver, + &settings.linter, query.text_document_language_id(), ) { return DiagnosticsMap::default(); @@ -87,16 +87,28 @@ pub(crate) fn check( document_path .parent() .expect("a path to a document should have a parent path"), - &linter_settings.namespace_packages, + &settings.linter.namespace_packages, ) + .map(PackageRoot::root) } else { None }; let source_type = query.source_type(); + let target_version = if let Some(path) = &document_path { + settings.linter.resolve_target_version(path) + } else { + settings.linter.unresolved_target_version + }; + + let parse_options = + ParseOptions::from(source_type).with_target_version(target_version.parser_version()); + // Parse once. - let parsed = ruff_python_parser::parse_unchecked_source(source_kind.source_code(), source_type); + let parsed = ruff_python_parser::parse_unchecked(source_kind.source_code(), parse_options) + .try_into_module() + .expect("PySourceType always parses to a ModModule"); // Map row and column locations to byte slices (lazily). let locator = Locator::new(source_kind.source_code()); @@ -111,26 +123,27 @@ pub(crate) fn check( let directives = extract_directives(parsed.tokens(), Flags::all(), &locator, &indexer); // Generate checks. - let diagnostics = check_path( + let messages = check_path( &query.virtual_file_path(), package, &locator, &stylist, &indexer, &directives, - linter_settings, + &settings.linter, flags::Noqa::Enabled, &source_kind, source_type, &parsed, + target_version, ); let noqa_edits = generate_noqa_edits( &query.virtual_file_path(), - &diagnostics, + &messages, &locator, indexer.comment_ranges(), - &linter_settings.external, + &settings.linter.external, &directives.noqa_line_for, stylist.line_ending(), ); @@ -149,34 +162,32 @@ pub(crate) fn check( .or_default(); } - let lsp_diagnostics = diagnostics - .into_iter() - .zip(noqa_edits) - .map(|(diagnostic, noqa_edit)| { - to_lsp_diagnostic( - diagnostic, - &noqa_edit, - &source_kind, - locator.to_index(), - encoding, - ) - }); - - let lsp_diagnostics = lsp_diagnostics.chain( - show_syntax_errors - .then(|| { - parsed.errors().iter().map(|parse_error| { - parse_error_to_lsp_diagnostic( - parse_error, - &source_kind, - locator.to_index(), - encoding, - ) - }) - }) + let lsp_diagnostics = + messages .into_iter() - .flatten(), - ); + .zip(noqa_edits) + .filter_map(|(message, noqa_edit)| match message.to_rule() { + Some(rule) => Some(to_lsp_diagnostic( + rule, + &message, + noqa_edit, + &source_kind, + locator.to_index(), + encoding, + )), + None => { + if show_syntax_errors { + Some(syntax_error_to_lsp_diagnostic( + &message, + &source_kind, + locator.to_index(), + encoding, + )) + } else { + None + } + } + }); if let Some(notebook) = query.as_notebook() { for (index, diagnostic) in lsp_diagnostics { @@ -205,6 +216,7 @@ pub(crate) fn fixes_for_diagnostics( ) -> crate::Result<Vec<DiagnosticFix>> { diagnostics .into_iter() + .filter(|diagnostic| diagnostic.source.as_deref() == Some(DIAGNOSTIC_NAME)) .map(move |mut diagnostic| { let Some(data) = diagnostic.data.take() else { return Ok(None); @@ -217,10 +229,7 @@ pub(crate) fn fixes_for_diagnostics( Ok(Some(DiagnosticFix { fixed_diagnostic, code: associated_data.code, - title: associated_data - .kind - .suggestion - .unwrap_or(associated_data.kind.name), + title: associated_data.title, noqa_edit: associated_data.noqa_edit, edits: associated_data.edits, })) @@ -232,27 +241,24 @@ pub(crate) fn fixes_for_diagnostics( /// Generates an LSP diagnostic with an associated cell index for the diagnostic to go in. /// If the source kind is a text document, the cell index will always be `0`. fn to_lsp_diagnostic( - diagnostic: Diagnostic, - noqa_edit: &Option<Edit>, + rule: Rule, + diagnostic: &Message, + noqa_edit: Option<Edit>, source_kind: &SourceKind, index: &LineIndex, encoding: PositionEncoding, ) -> (usize, lsp_types::Diagnostic) { - let Diagnostic { - kind, - range: diagnostic_range, - fix, - .. - } = diagnostic; - - let rule = kind.rule(); + let diagnostic_range = diagnostic.range(); + let name = diagnostic.name(); + let body = diagnostic.body().to_string(); + let fix = diagnostic.fix(); + let suggestion = diagnostic.suggestion(); let fix = fix.and_then(|fix| fix.applies(Applicability::Unsafe).then_some(fix)); let data = (fix.is_some() || noqa_edit.is_some()) .then(|| { let edits = fix - .as_ref() .into_iter() .flat_map(Fix::edits) .map(|edit| lsp_types::TextEdit { @@ -260,12 +266,12 @@ fn to_lsp_diagnostic( new_text: edit.content().unwrap_or_default().to_string(), }) .collect(); - let noqa_edit = noqa_edit.as_ref().map(|noqa_edit| lsp_types::TextEdit { + let noqa_edit = noqa_edit.map(|noqa_edit| lsp_types::TextEdit { range: diagnostic_edit_range(noqa_edit.range(), source_kind, index, encoding), - new_text: noqa_edit.content().unwrap_or_default().to_string(), + new_text: noqa_edit.into_content().unwrap_or_default().into_string(), }); serde_json::to_value(AssociatedDiagnosticData { - kind: kind.clone(), + title: suggestion.unwrap_or(name).to_string(), noqa_edit, edits, code: rule.noqa_code().to_string(), @@ -304,15 +310,15 @@ fn to_lsp_diagnostic( }) }), source: Some(DIAGNOSTIC_NAME.into()), - message: kind.body, + message: body, related_information: None, data, }, ) } -fn parse_error_to_lsp_diagnostic( - parse_error: &ParseError, +fn syntax_error_to_lsp_diagnostic( + syntax_error: &Message, source_kind: &SourceKind, index: &LineIndex, encoding: PositionEncoding, @@ -321,7 +327,7 @@ fn parse_error_to_lsp_diagnostic( let cell: usize; if let Some(notebook_index) = source_kind.as_ipy_notebook().map(Notebook::index) { - NotebookRange { cell, range } = parse_error.location.to_notebook_range( + NotebookRange { cell, range } = syntax_error.range().to_notebook_range( source_kind.source_code(), index, notebook_index, @@ -329,8 +335,8 @@ fn parse_error_to_lsp_diagnostic( ); } else { cell = usize::default(); - range = parse_error - .location + range = syntax_error + .range() .to_range(source_kind.source_code(), index, encoding); } @@ -343,7 +349,7 @@ fn parse_error_to_lsp_diagnostic( code: None, code_description: None, source: Some(DIAGNOSTIC_NAME.into()), - message: format!("SyntaxError: {}", &parse_error.error), + message: syntax_error.body().to_string(), related_information: None, data: None, }, @@ -378,7 +384,8 @@ fn tags(code: &str) -> Option<Vec<lsp_types::DiagnosticTag>> { match code { // F401: <module> imported but unused // F841: local variable <name> is assigned to but never used - "F401" | "F841" => Some(vec![lsp_types::DiagnosticTag::UNNECESSARY]), + // RUF059: Unused unpacked variable + "F401" | "F841" | "RUF059" => Some(vec![lsp_types::DiagnosticTag::UNNECESSARY]), _ => None, } } diff --git a/crates/ruff_server/src/logging.rs b/crates/ruff_server/src/logging.rs new file mode 100644 index 0000000000000..6d3700eca2163 --- /dev/null +++ b/crates/ruff_server/src/logging.rs @@ -0,0 +1,120 @@ +//! The logging system for `ruff server`. +//! +//! Log messages are controlled by the `logLevel` setting which defaults to `"info"`. Log messages +//! are written to `stderr` by default, which should appear in the logs for most LSP clients. A +//! `logFile` path can also be specified in the settings, and output will be directed there +//! instead. +use core::str; +use serde::Deserialize; +use std::{path::PathBuf, str::FromStr, sync::Arc}; +use tracing::level_filters::LevelFilter; +use tracing_subscriber::{ + Layer, + fmt::{format::FmtSpan, time::ChronoLocal, writer::BoxMakeWriter}, + layer::SubscriberExt, +}; + +pub(crate) fn init_logging(log_level: LogLevel, log_file: Option<&std::path::Path>) { + let log_file = log_file + .map(|path| { + // this expands `logFile` so that tildes and environment variables + // are replaced with their values, if possible. + if let Some(expanded) = shellexpand::full(&path.to_string_lossy()) + .ok() + .and_then(|path| PathBuf::from_str(&path).ok()) + { + expanded + } else { + path.to_path_buf() + } + }) + .and_then(|path| { + std::fs::OpenOptions::new() + .create(true) + .append(true) + .open(&path) + .map_err(|err| { + #[expect(clippy::print_stderr)] + { + eprintln!( + "Failed to open file at {} for logging: {err}", + path.display() + ); + } + }) + .ok() + }); + + let logger = match log_file { + Some(file) => BoxMakeWriter::new(Arc::new(file)), + None => BoxMakeWriter::new(std::io::stderr), + }; + + let is_trace_level = log_level == LogLevel::Trace; + let subscriber = tracing_subscriber::Registry::default().with( + tracing_subscriber::fmt::layer() + .with_timer(ChronoLocal::new("%Y-%m-%d %H:%M:%S.%f".to_string())) + .with_thread_names(is_trace_level) + .with_target(is_trace_level) + .with_ansi(false) + .with_writer(logger) + .with_span_events(FmtSpan::ENTER) + .with_filter(LogLevelFilter { filter: log_level }), + ); + + tracing::subscriber::set_global_default(subscriber) + .expect("should be able to set global default subscriber"); + + tracing_log::LogTracer::init().unwrap(); +} + +/// The log level for the server as provided by the client during initialization. +/// +/// The default log level is `info`. +#[derive(Clone, Copy, Debug, Deserialize, Default, PartialEq, Eq, PartialOrd, Ord)] +#[serde(rename_all = "lowercase")] +pub(crate) enum LogLevel { + Error, + Warn, + #[default] + Info, + Debug, + Trace, +} + +impl LogLevel { + fn trace_level(self) -> tracing::Level { + match self { + Self::Error => tracing::Level::ERROR, + Self::Warn => tracing::Level::WARN, + Self::Info => tracing::Level::INFO, + Self::Debug => tracing::Level::DEBUG, + Self::Trace => tracing::Level::TRACE, + } + } +} + +/// Filters out traces which have a log level lower than the `logLevel` set by the client. +struct LogLevelFilter { + filter: LogLevel, +} + +impl<S> tracing_subscriber::layer::Filter<S> for LogLevelFilter { + fn enabled( + &self, + meta: &tracing::Metadata<'_>, + _: &tracing_subscriber::layer::Context<'_, S>, + ) -> bool { + let filter = if meta.target().starts_with("ruff") { + self.filter.trace_level() + } else { + tracing::Level::INFO + }; + + meta.level() <= &filter + } + + fn max_level_hint(&self) -> Option<tracing::level_filters::LevelFilter> { + Some(LevelFilter::from_level(self.filter.trace_level())) + } +} diff --git a/crates/ruff_server/src/message.rs b/crates/ruff_server/src/message.rs index ef692e3561488..1b007ea38c5c2 100644 --- a/crates/ruff_server/src/message.rs +++ b/crates/ruff_server/src/message.rs @@ -40,15 +40,15 @@ pub(super) fn try_show_message( /// Sends a request to display an error to the client with a formatted message. The error is sent /// in a `window/showMessage` notification. macro_rules! show_err_msg { - ($msg:expr$(, $($arg:tt),*)?) => { - crate::message::show_message(::core::format_args!($msg, $($($arg),*)?).to_string(), lsp_types::MessageType::ERROR) + ($msg:expr$(, $($arg:tt)*)?) => { + crate::message::show_message(::core::format_args!($msg$(, $($arg)*)?).to_string(), lsp_types::MessageType::ERROR) }; } /// Sends a request to display a warning to the client with a formatted message. The warning is /// sent in a `window/showMessage` notification. macro_rules! show_warn_msg { - ($msg:expr$(, $($arg:tt),*)?) => { - crate::message::show_message(::core::format_args!($msg, $($($arg),*)?).to_string(), lsp_types::MessageType::WARNING) + ($msg:expr$(, $($arg:tt)*)?) => { + crate::message::show_message(::core::format_args!($msg$(, $($arg)*)?).to_string(), lsp_types::MessageType::WARNING) }; } diff --git a/crates/ruff_server/src/resolve.rs b/crates/ruff_server/src/resolve.rs index 580592416ee09..905512342f21e 100644 --- a/crates/ruff_server/src/resolve.rs +++ b/crates/ruff_server/src/resolve.rs @@ -6,6 +6,38 @@ use ruff_workspace::{FileResolverSettings, FormatterSettings}; use crate::edit::LanguageId; +/// Return `true` if the document at the given [`Path`] should be excluded from linting. +pub(crate) fn is_document_excluded_for_linting( + path: &Path, + resolver_settings: &FileResolverSettings, + linter_settings: &LinterSettings, + language_id: Option<LanguageId>, +) -> bool { + is_document_excluded( + path, + resolver_settings, + Some(linter_settings), + None, + language_id, + ) +} + +/// Return `true` if the document at the given [`Path`] should be excluded from formatting. +pub(crate) fn is_document_excluded_for_formatting( + path: &Path, + resolver_settings: &FileResolverSettings, + formatter_settings: &FormatterSettings, + language_id: Option<LanguageId>, +) -> bool { + is_document_excluded( + path, + resolver_settings, + None, + Some(formatter_settings), + language_id, + ) +} + /// Return `true` if the document at the given [`Path`] should be excluded. /// /// The tool-specific settings should be provided if the request for the document is specific to @@ -16,7 +48,9 @@ use crate::edit::LanguageId; /// 1. Check for global `exclude` and `extend-exclude` options along with tool specific `exclude` /// option (`lint.exclude`, `format.exclude`). /// 2. Check for global `include` and `extend-include` options. -pub(crate) fn is_document_excluded( +/// 3. Check if the language ID is Python, in which case the document is included. +/// 4. If none of the above conditions are met, the document is excluded. +fn is_document_excluded( path: &Path, resolver_settings: &FileResolverSettings, linter_settings: Option<&LinterSettings>, @@ -25,8 +59,7 @@ pub(crate) fn is_document_excluded( ) -> bool { if let Some(exclusion) = match_any_exclusion( path, - &resolver_settings.exclude, - &resolver_settings.extend_exclude, + resolver_settings, linter_settings.map(|s| &*s.exclude), formatter_settings.map(|s| &*s.exclude), ) { @@ -34,11 +67,7 @@ pub(crate) fn is_document_excluded( return true; } - if let Some(inclusion) = match_any_inclusion( - path, - &resolver_settings.include, - &resolver_settings.extend_include, - ) { + if let Some(inclusion) = match_any_inclusion(path, resolver_settings) { tracing::debug!("Included path via `{}`: {}", inclusion, path.display()); false } else if let Some(LanguageId::Python) = language_id { diff --git a/crates/ruff_server/src/server.rs b/crates/ruff_server/src/server.rs index b098b292e0c13..6614565f034f5 100644 --- a/crates/ruff_server/src/server.rs +++ b/crates/ruff_server/src/server.rs @@ -3,14 +3,11 @@ use lsp_server as lsp; use lsp_types as types; use lsp_types::InitializeParams; -use lsp_types::WorkspaceFolder; use std::num::NonZeroUsize; -use std::ops::Deref; // The new PanicInfoHook name requires MSRV >= 1.82 -#[allow(deprecated)] +#[expect(deprecated)] use std::panic::PanicInfo; use std::str::FromStr; -use thiserror::Error; use types::ClientCapabilities; use types::CodeActionKind; use types::CodeActionOptions; @@ -24,20 +21,18 @@ use types::OneOf; use types::TextDocumentSyncCapability; use types::TextDocumentSyncKind; use types::TextDocumentSyncOptions; -use types::Url; use types::WorkDoneProgressOptions; use types::WorkspaceFoldersServerCapabilities; use self::connection::Connection; use self::connection::ConnectionInitializer; -use self::schedule::event_loop_thread; use self::schedule::Scheduler; use self::schedule::Task; +use self::schedule::event_loop_thread; +use crate::PositionEncoding; use crate::session::AllSettings; -use crate::session::ClientSettings; use crate::session::Session; -use crate::session::WorkspaceSettingsMap; -use crate::PositionEncoding; +use crate::workspace::Workspaces; mod api; mod client; @@ -64,6 +59,7 @@ impl Server { let client_capabilities = init_params.capabilities; let position_encoding = Self::find_best_position_encoding(&client_capabilities); + let server_capabilities = Self::server_capabilities(position_encoding); let connection = connection.initialize_finish( @@ -73,16 +69,11 @@ impl Server { crate::version(), )?; - if let Some(trace) = init_params.trace { - crate::trace::set_trace_value(trace); - } - crate::message::init_messenger(connection.make_sender()); let InitializeParams { initialization_options, workspace_folders, - client_info, .. } = init_params; @@ -98,14 +89,9 @@ impl Server { workspace_settings, } = all_settings; - crate::trace::init_tracing( - connection.make_sender(), - global_settings - .tracing - .log_level - .unwrap_or(crate::trace::LogLevel::Info), + crate::logging::init_logging( + global_settings.tracing.log_level.unwrap_or_default(), global_settings.tracing.log_file.as_deref(), - client_info.as_ref(), ); let workspaces = Workspaces::from_workspace_folders( @@ -113,6 +99,8 @@ impl Server { workspace_settings.unwrap_or_default(), )?; + tracing::debug!("Negotiated position encoding: {position_encoding:?}"); + Ok(Self { connection, worker_threads, @@ -128,7 +116,7 @@ impl Server { pub fn run(self) -> crate::Result<()> { // The new PanicInfoHook name requires MSRV >= 1.82 - #[allow(deprecated)] + #[expect(deprecated)] type PanicHook = Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send>; struct RestorePanicHook { hook: Option<PanicHook>, @@ -182,7 +170,6 @@ impl Server { .join() } - #[allow(clippy::needless_pass_by_value)] // this is because we aren't using `next_request_id` yet. fn event_loop( connection: &Connection, client_capabilities: &ClientCapabilities, @@ -261,10 +248,14 @@ impl Server { if let Err(err) = scheduler .request::<lsp_types::request::RegisterCapability>(params, response_handler) { - tracing::error!("An error occurred when trying to register the configuration file watcher: {err}"); + tracing::error!( + "An error occurred when trying to register the configuration file watcher: {err}" + ); } } else { - tracing::warn!("LSP client does not support dynamic capability registration - automatic configuration reloading will not be available."); + tracing::warn!( + "LSP client does not support dynamic capability registration - automatic configuration reloading will not be available." + ); } } @@ -457,122 +448,3 @@ impl FromStr for SupportedCommand { }) } } - -#[derive(Debug)] -pub struct Workspaces(Vec<Workspace>); - -impl Workspaces { - pub fn new(workspaces: Vec<Workspace>) -> Self { - Self(workspaces) - } - - /// Create the workspaces from the provided workspace folders as provided by the client during - /// initialization. - fn from_workspace_folders( - workspace_folders: Option<Vec<WorkspaceFolder>>, - mut workspace_settings: WorkspaceSettingsMap, - ) -> std::result::Result<Workspaces, WorkspacesError> { - let mut client_settings_for_url = |url: &Url| { - workspace_settings.remove(url).unwrap_or_else(|| { - tracing::info!( - "No workspace settings found for {}, using default settings", - url - ); - ClientSettings::default() - }) - }; - - let workspaces = - if let Some(folders) = workspace_folders.filter(|folders| !folders.is_empty()) { - folders - .into_iter() - .map(|folder| { - let settings = client_settings_for_url(&folder.uri); - Workspace::new(folder.uri).with_settings(settings) - }) - .collect() - } else { - let current_dir = std::env::current_dir().map_err(WorkspacesError::Io)?; - tracing::info!( - "No workspace(s) were provided during initialization. \ - Using the current working directory as a default workspace: {}", - current_dir.display() - ); - let uri = Url::from_file_path(current_dir) - .map_err(|()| WorkspacesError::InvalidCurrentDir)?; - let settings = client_settings_for_url(&uri); - vec![Workspace::default(uri).with_settings(settings)] - }; - - Ok(Workspaces(workspaces)) - } -} - -impl Deref for Workspaces { - type Target = [Workspace]; - - fn deref(&self) -> &Self::Target { - &self.0 - } -} - -#[derive(Error, Debug)] -enum WorkspacesError { - #[error(transparent)] - Io(#[from] std::io::Error), - #[error("Failed to create a URL from the current working directory")] - InvalidCurrentDir, -} - -#[derive(Debug)] -pub struct Workspace { - /// The [`Url`] pointing to the root of the workspace. - url: Url, - /// The client settings for this workspace. - settings: Option<ClientSettings>, - /// Whether this is the default workspace as created by the server. This will be the case when - /// no workspace folders were provided during initialization. - is_default: bool, -} - -impl Workspace { - /// Create a new workspace with the given root URL. - pub fn new(url: Url) -> Self { - Self { - url, - settings: None, - is_default: false, - } - } - - /// Create a new default workspace with the given root URL. - pub fn default(url: Url) -> Self { - Self { - url, - settings: None, - is_default: true, - } - } - - /// Set the client settings for this workspace. - #[must_use] - pub fn with_settings(mut self, settings: ClientSettings) -> Self { - self.settings = Some(settings); - self - } - - /// Returns the root URL of the workspace. - pub(crate) fn url(&self) -> &Url { - &self.url - } - - /// Returns the client settings for this workspace. - pub(crate) fn settings(&self) -> Option<&ClientSettings> { - self.settings.as_ref() - } - - /// Returns true if this is the default workspace. - pub(crate) fn is_default(&self) -> bool { - self.is_default - } -} diff --git a/crates/ruff_server/src/server/api.rs b/crates/ruff_server/src/server/api.rs index 459ae8fe8f645..aa419c6348d81 100644 --- a/crates/ruff_server/src/server/api.rs +++ b/crates/ruff_server/src/server/api.rs @@ -11,7 +11,7 @@ use requests as request; use self::traits::{NotificationHandler, RequestHandler}; -use super::{client::Responder, schedule::BackgroundSchedule, Result}; +use super::{Result, client::Responder, schedule::BackgroundSchedule}; /// Defines the `document_url` method for implementers of [`traits::Notification`] and [`traits::Request`], /// given the parameter type used by the implementer. @@ -29,18 +29,14 @@ pub(super) fn request<'a>(req: server::Request) -> Task<'a> { let id = req.id.clone(); match req.method.as_str() { - request::CodeActions::METHOD => background_request_task::<request::CodeActions>( - req, - BackgroundSchedule::LatencySensitive, - ), + request::CodeActions::METHOD => { + background_request_task::<request::CodeActions>(req, BackgroundSchedule::Worker) + } request::CodeActionResolve::METHOD => { background_request_task::<request::CodeActionResolve>(req, BackgroundSchedule::Worker) } request::DocumentDiagnostic::METHOD => { - background_request_task::<request::DocumentDiagnostic>( - req, - BackgroundSchedule::LatencySensitive, - ) + background_request_task::<request::DocumentDiagnostic>(req, BackgroundSchedule::Worker) } request::ExecuteCommand::METHOD => local_request_task::<request::ExecuteCommand>(req), request::Format::METHOD => { @@ -93,9 +89,6 @@ pub(super) fn notification<'a>(notif: server::Notification) -> Task<'a> { notification::DidCloseNotebook::METHOD => { local_notification_task::<notification::DidCloseNotebook>(notif) } - notification::SetTrace::METHOD => { - local_notification_task::<notification::SetTrace>(notif) - } method => { tracing::warn!("Received notification {method} which does not have a handler."); return Task::nothing(); @@ -103,7 +96,9 @@ pub(super) fn notification<'a>(notif: server::Notification) -> Task<'a> { } .unwrap_or_else(|err| { tracing::error!("Encountered error when routing notification: {err}"); - show_err_msg!("Ruff failed to handle a notification from the editor. Check the logs for more details."); + show_err_msg!( + "Ruff failed to handle a notification from the editor. Check the logs for more details." + ); Task::nothing() }) } @@ -113,6 +108,7 @@ fn local_request_task<'a, R: traits::SyncRequestHandler>( ) -> super::Result<Task<'a>> { let (id, params) = cast_request::<R>(req)?; Ok(Task::local(|session, notifier, requester, responder| { + let _span = tracing::trace_span!("request", %id, method = R::METHOD).entered(); let result = R::run(session, notifier, requester, params); respond::<R>(id, result, &responder); })) @@ -129,6 +125,7 @@ fn background_request_task<'a, R: traits::BackgroundDocumentRequestHandler>( return Box::new(|_, _| {}); }; Box::new(move |notifier, responder| { + let _span = tracing::trace_span!("request", %id, method = R::METHOD).entered(); let result = R::run_with_snapshot(snapshot, notifier, params); respond::<R>(id, result, &responder); }) @@ -140,6 +137,7 @@ fn local_notification_task<'a, N: traits::SyncNotificationHandler>( ) -> super::Result<Task<'a>> { let (id, params) = cast_notification::<N>(notif)?; Ok(Task::local(move |session, notifier, requester, _| { + let _span = tracing::trace_span!("notification", method = N::METHOD).entered(); if let Err(err) = N::run(session, notifier, requester, params) { tracing::error!("An error occurred while running {id}: {err}"); show_err_msg!("Ruff encountered a problem. Check the logs for more details."); @@ -147,7 +145,7 @@ fn local_notification_task<'a, N: traits::SyncNotificationHandler>( })) } -#[allow(dead_code)] +#[expect(dead_code)] fn background_notification_thread<'a, N: traits::BackgroundDocumentNotificationHandler>( req: server::Notification, schedule: BackgroundSchedule, @@ -159,6 +157,7 @@ fn background_notification_thread<'a, N: traits::BackgroundDocumentNotificationH return Box::new(|_, _| {}); }; Box::new(move |notifier, _| { + let _span = tracing::trace_span!("notification", method = N::METHOD).entered(); if let Err(err) = N::run_with_snapshot(snapshot, notifier, params) { tracing::error!("An error occurred while running {id}: {err}"); show_err_msg!("Ruff encountered a problem. Check the logs for more details."); @@ -205,7 +204,7 @@ fn respond<Req>( Req: traits::RequestHandler, { if let Err(err) = &result { - tracing::error!("An error occurred with result ID {id}: {err}"); + tracing::error!("An error occurred with request ID {id}: {err}"); show_err_msg!("Ruff encountered a problem. Check the logs for more details."); } if let Err(err) = responder.respond(id, result) { diff --git a/crates/ruff_server/src/server/api/notifications.rs b/crates/ruff_server/src/server/api/notifications.rs index feb7771c22408..ade0c2fbd510f 100644 --- a/crates/ruff_server/src/server/api/notifications.rs +++ b/crates/ruff_server/src/server/api/notifications.rs @@ -8,7 +8,6 @@ mod did_close; mod did_close_notebook; mod did_open; mod did_open_notebook; -mod set_trace; use super::traits::{NotificationHandler, SyncNotificationHandler}; pub(super) use cancel::Cancel; @@ -21,4 +20,3 @@ pub(super) use did_close::DidClose; pub(super) use did_close_notebook::DidCloseNotebook; pub(super) use did_open::DidOpen; pub(super) use did_open_notebook::DidOpenNotebook; -pub(super) use set_trace::SetTrace; diff --git a/crates/ruff_server/src/server/api/notifications/cancel.rs b/crates/ruff_server/src/server/api/notifications/cancel.rs index d9d011c3f7b32..a88fb30d1ad83 100644 --- a/crates/ruff_server/src/server/api/notifications/cancel.rs +++ b/crates/ruff_server/src/server/api/notifications/cancel.rs @@ -1,5 +1,5 @@ -use crate::server::client::{Notifier, Requester}; use crate::server::Result; +use crate::server::client::{Notifier, Requester}; use crate::session::Session; use lsp_types as types; use lsp_types::notification as notif; diff --git a/crates/ruff_server/src/server/api/notifications/did_change.rs b/crates/ruff_server/src/server/api/notifications/did_change.rs index 27ee65a3a12bc..d9b7d7092d9dc 100644 --- a/crates/ruff_server/src/server/api/notifications/did_change.rs +++ b/crates/ruff_server/src/server/api/notifications/did_change.rs @@ -1,7 +1,7 @@ -use crate::server::api::diagnostics::publish_diagnostics_for_document; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::publish_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_server::ErrorCode; use lsp_types as types; @@ -33,7 +33,7 @@ impl super::SyncNotificationHandler for DidChange { .update_text_document(&key, content_changes, new_version) .with_failure_code(ErrorCode::InternalError)?; - // Publish diagnostics if the client doesnt support pull diagnostics + // Publish diagnostics if the client doesn't support pull diagnostics if !session.resolved_client_capabilities().pull_diagnostics { let snapshot = session.take_snapshot(key.into_url()).unwrap(); publish_diagnostics_for_document(&snapshot, ¬ifier)?; diff --git a/crates/ruff_server/src/server/api/notifications/did_change_configuration.rs b/crates/ruff_server/src/server/api/notifications/did_change_configuration.rs index 9a2e5af99c739..ccfd30ddb07ec 100644 --- a/crates/ruff_server/src/server/api/notifications/did_change_configuration.rs +++ b/crates/ruff_server/src/server/api/notifications/did_change_configuration.rs @@ -1,5 +1,5 @@ -use crate::server::client::{Notifier, Requester}; use crate::server::Result; +use crate::server::client::{Notifier, Requester}; use crate::session::Session; use lsp_types as types; use lsp_types::notification as notif; diff --git a/crates/ruff_server/src/server/api/notifications/did_change_notebook.rs b/crates/ruff_server/src/server/api/notifications/did_change_notebook.rs index 97f12f4e1798b..d96b4ea97a4ce 100644 --- a/crates/ruff_server/src/server/api/notifications/did_change_notebook.rs +++ b/crates/ruff_server/src/server/api/notifications/did_change_notebook.rs @@ -1,7 +1,7 @@ -use crate::server::api::diagnostics::publish_diagnostics_for_document; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::publish_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_server::ErrorCode; use lsp_types as types; diff --git a/crates/ruff_server/src/server/api/notifications/did_change_watched_files.rs b/crates/ruff_server/src/server/api/notifications/did_change_watched_files.rs index 8c2e232bda484..a05ee1f2728e4 100644 --- a/crates/ruff_server/src/server/api/notifications/did_change_watched_files.rs +++ b/crates/ruff_server/src/server/api/notifications/did_change_watched_files.rs @@ -1,8 +1,8 @@ -use crate::server::api::diagnostics::publish_diagnostics_for_document; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::publish_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; use crate::server::schedule::Task; -use crate::server::Result; use crate::session::Session; use lsp_types as types; use lsp_types::notification as notif; @@ -20,9 +20,7 @@ impl super::SyncNotificationHandler for DidChangeWatchedFiles { requester: &mut Requester, params: types::DidChangeWatchedFilesParams, ) -> Result<()> { - for change in ¶ms.changes { - session.reload_settings(&change.uri); - } + session.reload_settings(¶ms.changes); if !params.changes.is_empty() { if session.resolved_client_capabilities().workspace_refresh { diff --git a/crates/ruff_server/src/server/api/notifications/did_change_workspace.rs b/crates/ruff_server/src/server/api/notifications/did_change_workspace.rs index a10b376a64de6..2e9dd7cb1d043 100644 --- a/crates/ruff_server/src/server/api/notifications/did_change_workspace.rs +++ b/crates/ruff_server/src/server/api/notifications/did_change_workspace.rs @@ -1,6 +1,6 @@ +use crate::server::Result; use crate::server::api::LSPResult; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_types as types; use lsp_types::notification as notif; diff --git a/crates/ruff_server/src/server/api/notifications/did_close.rs b/crates/ruff_server/src/server/api/notifications/did_close.rs index 491fa06c3d0ae..1448243f2b135 100644 --- a/crates/ruff_server/src/server/api/notifications/did_close.rs +++ b/crates/ruff_server/src/server/api/notifications/did_close.rs @@ -1,7 +1,7 @@ -use crate::server::api::diagnostics::clear_diagnostics_for_document; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::clear_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_types as types; use lsp_types::notification as notif; diff --git a/crates/ruff_server/src/server/api/notifications/did_close_notebook.rs b/crates/ruff_server/src/server/api/notifications/did_close_notebook.rs index 913ccf5d4a234..e675a4ddbe875 100644 --- a/crates/ruff_server/src/server/api/notifications/did_close_notebook.rs +++ b/crates/ruff_server/src/server/api/notifications/did_close_notebook.rs @@ -1,6 +1,6 @@ +use crate::server::Result; use crate::server::api::LSPResult; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_types::notification as notif; use lsp_types::{self as types, NotebookDocumentIdentifier}; diff --git a/crates/ruff_server/src/server/api/notifications/did_open.rs b/crates/ruff_server/src/server/api/notifications/did_open.rs index 848269aa6bd9a..6d8e7b4b110ea 100644 --- a/crates/ruff_server/src/server/api/notifications/did_open.rs +++ b/crates/ruff_server/src/server/api/notifications/did_open.rs @@ -1,9 +1,9 @@ -use crate::server::api::diagnostics::publish_diagnostics_for_document; +use crate::TextDocument; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::publish_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; -use crate::TextDocument; use lsp_types as types; use lsp_types::notification as notif; @@ -32,7 +32,7 @@ impl super::SyncNotificationHandler for DidOpen { session.open_text_document(uri.clone(), document); - // Publish diagnostics if the client doesnt support pull diagnostics + // Publish diagnostics if the client doesn't support pull diagnostics if !session.resolved_client_capabilities().pull_diagnostics { let snapshot = session .take_snapshot(uri.clone()) diff --git a/crates/ruff_server/src/server/api/notifications/did_open_notebook.rs b/crates/ruff_server/src/server/api/notifications/did_open_notebook.rs index 4cd21c35fce2a..d8cda99c42499 100644 --- a/crates/ruff_server/src/server/api/notifications/did_open_notebook.rs +++ b/crates/ruff_server/src/server/api/notifications/did_open_notebook.rs @@ -1,8 +1,8 @@ use crate::edit::NotebookDocument; -use crate::server::api::diagnostics::publish_diagnostics_for_document; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::diagnostics::publish_diagnostics_for_document; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; use lsp_server::ErrorCode; use lsp_types as types; diff --git a/crates/ruff_server/src/server/api/notifications/set_trace.rs b/crates/ruff_server/src/server/api/notifications/set_trace.rs deleted file mode 100644 index 9223d9e42b237..0000000000000 --- a/crates/ruff_server/src/server/api/notifications/set_trace.rs +++ /dev/null @@ -1,23 +0,0 @@ -use crate::server::client::{Notifier, Requester}; -use crate::server::Result; -use crate::session::Session; -use lsp_types as types; -use lsp_types::notification as notif; - -pub(crate) struct SetTrace; - -impl super::NotificationHandler for SetTrace { - type NotificationType = notif::SetTrace; -} - -impl super::SyncNotificationHandler for SetTrace { - fn run( - _session: &mut Session, - _notifier: Notifier, - _requester: &mut Requester, - params: types::SetTraceParams, - ) -> Result<()> { - crate::trace::set_trace_value(params.value); - Ok(()) - } -} diff --git a/crates/ruff_server/src/server/api/requests/code_action.rs b/crates/ruff_server/src/server/api/requests/code_action.rs index 255cfdf0adcba..8edd92ba64c9e 100644 --- a/crates/ruff_server/src/server/api/requests/code_action.rs +++ b/crates/ruff_server/src/server/api/requests/code_action.rs @@ -3,13 +3,13 @@ use lsp_types::{self as types, request as req}; use rustc_hash::FxHashSet; use types::{CodeActionKind, CodeActionOrCommand}; +use crate::DIAGNOSTIC_NAME; use crate::edit::WorkspaceEditTracker; -use crate::lint::{fixes_for_diagnostics, DiagnosticFix}; -use crate::server::api::LSPResult; +use crate::lint::{DiagnosticFix, fixes_for_diagnostics}; use crate::server::SupportedCodeAction; -use crate::server::{client::Notifier, Result}; +use crate::server::api::LSPResult; +use crate::server::{Result, client::Notifier}; use crate::session::DocumentSnapshot; -use crate::DIAGNOSTIC_NAME; use super::code_action_resolve::{resolve_edit_for_fix_all, resolve_edit_for_organize_imports}; @@ -48,7 +48,15 @@ impl super::BackgroundDocumentRequestHandler for CodeActions { if snapshot.client_settings().fix_all() { if supported_code_actions.contains(&SupportedCodeAction::SourceFixAll) { - response.push(fix_all(&snapshot).with_failure_code(ErrorCode::InternalError)?); + if snapshot.is_notebook_cell() { + // This is ignore here because the client requests this code action for each + // cell in parallel and the server would send a workspace edit with the same + // content which would result in applying the same edit multiple times + // resulting in (possibly) duplicate code. + tracing::debug!("Ignoring `source.fixAll` code action for a notebook cell"); + } else { + response.push(fix_all(&snapshot).with_failure_code(ErrorCode::InternalError)?); + } } else if supported_code_actions.contains(&SupportedCodeAction::NotebookSourceFixAll) { response .push(notebook_fix_all(&snapshot).with_failure_code(ErrorCode::InternalError)?); @@ -57,8 +65,19 @@ impl super::BackgroundDocumentRequestHandler for CodeActions { if snapshot.client_settings().organize_imports() { if supported_code_actions.contains(&SupportedCodeAction::SourceOrganizeImports) { - response - .push(organize_imports(&snapshot).with_failure_code(ErrorCode::InternalError)?); + if snapshot.is_notebook_cell() { + // This is ignore here because the client requests this code action for each + // cell in parallel and the server would send a workspace edit with the same + // content which would result in applying the same edit multiple times + // resulting in (possibly) duplicate code. + tracing::debug!( + "Ignoring `source.organizeImports` code action for a notebook cell" + ); + } else { + response.push( + organize_imports(&snapshot).with_failure_code(ErrorCode::InternalError)?, + ); + } } else if supported_code_actions .contains(&SupportedCodeAction::NotebookSourceOrganizeImports) { diff --git a/crates/ruff_server/src/server/api/requests/code_action_resolve.rs b/crates/ruff_server/src/server/api/requests/code_action_resolve.rs index 7cf9a1df3fb67..e77ef8092e605 100644 --- a/crates/ruff_server/src/server/api/requests/code_action_resolve.rs +++ b/crates/ruff_server/src/server/api/requests/code_action_resolve.rs @@ -5,13 +5,13 @@ use lsp_types::{self as types, request as req}; use ruff_linter::codes::Rule; +use crate::PositionEncoding; use crate::edit::WorkspaceEditTracker; use crate::fix::Fixes; -use crate::server::api::LSPResult; use crate::server::SupportedCodeAction; -use crate::server::{client::Notifier, Result}; +use crate::server::api::LSPResult; +use crate::server::{Result, client::Notifier}; use crate::session::{DocumentQuery, DocumentSnapshot, ResolvedClientCapabilities}; -use crate::PositionEncoding; pub(crate) struct CodeActionResolve; @@ -50,6 +50,21 @@ impl super::BackgroundDocumentRequestHandler for CodeActionResolve { .with_failure_code(ErrorCode::InvalidParams); }; + match action_kind { + SupportedCodeAction::SourceFixAll | SupportedCodeAction::SourceOrganizeImports + if snapshot.is_notebook_cell() => + { + // This should never occur because we ignore generating these code actions for a + // notebook cell in the `textDocument/codeAction` request handler. + return Err(anyhow::anyhow!( + "Code action resolver cannot resolve {:?} for a notebook cell", + action_kind.to_kind().as_str() + )) + .with_failure_code(ErrorCode::InvalidParams); + } + _ => {} + } + action.edit = match action_kind { SupportedCodeAction::SourceFixAll | SupportedCodeAction::NotebookSourceFixAll => Some( resolve_edit_for_fix_all( @@ -93,7 +108,7 @@ pub(super) fn fix_all_edit( query: &DocumentQuery, encoding: PositionEncoding, ) -> crate::Result<Fixes> { - crate::fix::fix_all(query, query.settings().linter(), encoding) + crate::fix::fix_all(query, &query.settings().linter, encoding) } pub(super) fn resolve_edit_for_organize_imports( @@ -110,7 +125,7 @@ pub(super) fn organize_imports_edit( query: &DocumentQuery, encoding: PositionEncoding, ) -> crate::Result<Fixes> { - let mut linter_settings = query.settings().linter().clone(); + let mut linter_settings = query.settings().linter.clone(); linter_settings.rules = [ Rule::UnsortedImports, // I001 Rule::MissingRequiredImport, // I002 diff --git a/crates/ruff_server/src/server/api/requests/diagnostic.rs b/crates/ruff_server/src/server/api/requests/diagnostic.rs index e3a4fd0f4a78b..48d5783b1e0ee 100644 --- a/crates/ruff_server/src/server/api/requests/diagnostic.rs +++ b/crates/ruff_server/src/server/api/requests/diagnostic.rs @@ -1,5 +1,5 @@ use crate::server::api::diagnostics::generate_diagnostics; -use crate::server::{client::Notifier, Result}; +use crate::server::{Result, client::Notifier}; use crate::session::DocumentSnapshot; use lsp_types::{self as types, request as req}; use types::{ diff --git a/crates/ruff_server/src/server/api/requests/execute_command.rs b/crates/ruff_server/src/server/api/requests/execute_command.rs index c27da9453e602..600a65fb78abb 100644 --- a/crates/ruff_server/src/server/api/requests/execute_command.rs +++ b/crates/ruff_server/src/server/api/requests/execute_command.rs @@ -1,14 +1,15 @@ +use std::fmt::Write; use std::str::FromStr; use crate::edit::WorkspaceEditTracker; use crate::server::api::LSPResult; use crate::server::schedule::Task; -use crate::server::{client, SupportedCommand}; +use crate::server::{SupportedCommand, client}; use crate::session::Session; -use crate::DIAGNOSTIC_NAME; +use crate::{DIAGNOSTIC_NAME, DocumentKey}; use crate::{edit::DocumentVersion, server}; use lsp_server::ErrorCode; -use lsp_types::{self as types, request as req}; +use lsp_types::{self as types, TextDocumentIdentifier, request as req}; use serde::Deserialize; pub(crate) struct ExecuteCommand; @@ -19,6 +20,17 @@ struct Argument { version: DocumentVersion, } +/// The argument schema for the `ruff.printDebugInformation` command. +#[derive(Default, Deserialize)] +#[serde(rename_all = "camelCase")] +struct DebugCommandArgument { + /// The URI of the document to print debug information for. + /// + /// When provided, both document-specific debug information and global information are printed. + /// If not provided ([None]), only global debug information is printed. + text_document: Option<TextDocumentIdentifier>, +} + impl super::RequestHandler for ExecuteCommand { type RequestType = req::ExecuteCommand; } @@ -26,7 +38,7 @@ impl super::RequestHandler for ExecuteCommand { impl super::SyncRequestHandler for ExecuteCommand { fn run( session: &mut Session, - notifier: client::Notifier, + _notifier: client::Notifier, requester: &mut client::Requester, params: types::ExecuteCommandParams, ) -> server::Result<Option<serde_json::Value>> { @@ -34,14 +46,16 @@ impl super::SyncRequestHandler for ExecuteCommand { .with_failure_code(ErrorCode::InvalidParams)?; if command == SupportedCommand::Debug { - let output = debug_information(session); - notifier - .notify::<types::notification::LogMessage>(types::LogMessageParams { - message: output, - typ: types::MessageType::INFO, - }) - .with_failure_code(ErrorCode::InternalError)?; - return Ok(None); + // TODO: Currently we only use the first argument i.e., the first document that's + // provided but we could expand this to consider all *open* documents. + let argument: DebugCommandArgument = params.arguments.into_iter().next().map_or_else( + || Ok(DebugCommandArgument::default()), + |value| serde_json::from_value(value).with_failure_code(ErrorCode::InvalidParams), + )?; + return Ok(Some(serde_json::Value::String( + debug_information(session, argument.text_document) + .with_failure_code(ErrorCode::InternalError)?, + ))); } // check if we can apply a workspace edit @@ -134,23 +148,71 @@ fn apply_edit( ) } -fn debug_information(session: &Session) -> String { +/// Returns a string with debug information about the session and the document at the given URI. +fn debug_information( + session: &Session, + text_document: Option<TextDocumentIdentifier>, +) -> crate::Result<String> { let executable = std::env::current_exe() .map(|path| format!("{}", path.display())) .unwrap_or_else(|_| "<unavailable>".to_string()); - format!( - "executable = {executable} + + let mut buffer = String::new(); + + writeln!( + buffer, + "Global: +executable = {executable} version = {version} -encoding = {encoding:?} -open_document_count = {doc_count} -active_workspace_count = {workspace_count} -configuration_files = {config_files:?} -{client_capabilities}", +position_encoding = {encoding:?} +workspace_root_folders = {workspace_folders:#?} +indexed_configuration_files = {config_files:#?} +open_documents_len = {open_documents_len} +client_capabilities = {client_capabilities:#?} +", version = crate::version(), encoding = session.encoding(), + workspace_folders = session.workspace_root_folders().collect::<Vec<_>>(), + config_files = session.config_file_paths().collect::<Vec<_>>(), + open_documents_len = session.open_documents_len(), client_capabilities = session.resolved_client_capabilities(), - doc_count = session.num_documents(), - workspace_count = session.num_workspaces(), - config_files = session.list_config_files() - ) + )?; + + if let Some(TextDocumentIdentifier { uri }) = text_document { + let Some(snapshot) = session.take_snapshot(uri.clone()) else { + writeln!(buffer, "Unable to take a snapshot of the document at {uri}")?; + return Ok(buffer); + }; + let query = snapshot.query(); + + writeln!( + buffer, + "Open document: +uri = {uri} +kind = {kind} +version = {version} +client_settings = {client_settings:#?} +config_path = {config_path:?} +{settings} + ", + uri = uri.clone(), + kind = match session.key_from_url(uri) { + DocumentKey::Notebook(_) => "Notebook", + DocumentKey::NotebookCell(_) => "NotebookCell", + DocumentKey::Text(_) => "Text", + }, + version = query.version(), + client_settings = snapshot.client_settings(), + config_path = query.settings().path(), + settings = query.settings(), + )?; + } else { + writeln!( + buffer, + "global_client_settings = {:#?}", + session.global_client_settings() + )?; + } + + Ok(buffer) } diff --git a/crates/ruff_server/src/server/api/requests/format.rs b/crates/ruff_server/src/server/api/requests/format.rs index 853be16618a6a..e4fbc86ab1a56 100644 --- a/crates/ruff_server/src/server/api/requests/format.rs +++ b/crates/ruff_server/src/server/api/requests/format.rs @@ -1,3 +1,4 @@ +use anyhow::Context; use lsp_types::{self as types, request as req}; use types::TextEdit; @@ -5,9 +6,9 @@ use ruff_source_file::LineIndex; use crate::edit::{Replacement, ToRangeExt}; use crate::fix::Fixes; -use crate::resolve::is_document_excluded; +use crate::resolve::is_document_excluded_for_formatting; use crate::server::api::LSPResult; -use crate::server::{client::Notifier, Result}; +use crate::server::{Result, client::Notifier}; use crate::session::{DocumentQuery, DocumentSnapshot}; use crate::{PositionEncoding, TextDocument}; @@ -64,7 +65,8 @@ pub(super) fn format_document(snapshot: &DocumentSnapshot) -> Result<super::Form let text_document = snapshot .query() .as_single_document() - .expect("format should only be called on text documents or notebook cells"); + .context("Failed to get text document for the format request") + .unwrap(); let query = snapshot.query(); format_text_document( text_document, @@ -80,16 +82,15 @@ fn format_text_document( encoding: PositionEncoding, is_notebook: bool, ) -> Result<super::FormatResponse> { - let file_resolver_settings = query.settings().file_resolver(); - let formatter_settings = query.settings().formatter(); + let settings = query.settings(); // If the document is excluded, return early. - if let Some(file_path) = query.file_path() { - if is_document_excluded( - &file_path, - file_resolver_settings, - None, - Some(formatter_settings), + let file_path = query.file_path(); + if let Some(file_path) = &file_path { + if is_document_excluded_for_formatting( + file_path, + &settings.file_resolver, + &settings.formatter, text_document.language_id(), ) { return Ok(None); @@ -97,8 +98,13 @@ fn format_text_document( } let source = text_document.contents(); - let formatted = crate::format::format(text_document, query.source_type(), formatter_settings) - .with_failure_code(lsp_server::ErrorCode::InternalError)?; + let formatted = crate::format::format( + text_document, + query.source_type(), + &settings.formatter, + file_path.as_deref(), + ) + .with_failure_code(lsp_server::ErrorCode::InternalError)?; let Some(mut formatted) = formatted else { return Ok(None); }; diff --git a/crates/ruff_server/src/server/api/requests/format_range.rs b/crates/ruff_server/src/server/api/requests/format_range.rs index 2eb8ea5ab749c..5f18af9737f5d 100644 --- a/crates/ruff_server/src/server/api/requests/format_range.rs +++ b/crates/ruff_server/src/server/api/requests/format_range.rs @@ -1,9 +1,10 @@ -use lsp_types::{self as types, request as req, Range}; +use anyhow::Context; +use lsp_types::{self as types, Range, request as req}; use crate::edit::{RangeExt, ToRangeExt}; -use crate::resolve::is_document_excluded; +use crate::resolve::is_document_excluded_for_formatting; use crate::server::api::LSPResult; -use crate::server::{client::Notifier, Result}; +use crate::server::{Result, client::Notifier}; use crate::session::{DocumentQuery, DocumentSnapshot}; use crate::{PositionEncoding, TextDocument}; @@ -32,7 +33,8 @@ fn format_document_range( let text_document = snapshot .query() .as_single_document() - .expect("format should only be called on text documents or notebook cells"); + .context("Failed to get text document for the format range request") + .unwrap(); let query = snapshot.query(); format_text_document_range(text_document, range, query, snapshot.encoding()) } @@ -44,16 +46,15 @@ fn format_text_document_range( query: &DocumentQuery, encoding: PositionEncoding, ) -> Result<super::FormatResponse> { - let file_resolver_settings = query.settings().file_resolver(); - let formatter_settings = query.settings().formatter(); + let settings = query.settings(); // If the document is excluded, return early. - if let Some(file_path) = query.file_path() { - if is_document_excluded( - &file_path, - file_resolver_settings, - None, - Some(formatter_settings), + let file_path = query.file_path(); + if let Some(file_path) = &file_path { + if is_document_excluded_for_formatting( + file_path, + &settings.file_resolver, + &settings.formatter, text_document.language_id(), ) { return Ok(None); @@ -66,8 +67,9 @@ fn format_text_document_range( let formatted_range = crate::format::format_range( text_document, query.source_type(), - formatter_settings, + &settings.formatter, range, + file_path.as_deref(), ) .with_failure_code(lsp_server::ErrorCode::InternalError)?; diff --git a/crates/ruff_server/src/server/api/requests/hover.rs b/crates/ruff_server/src/server/api/requests/hover.rs index d982b497a312e..209dbf6c45862 100644 --- a/crates/ruff_server/src/server/api/requests/hover.rs +++ b/crates/ruff_server/src/server/api/requests/hover.rs @@ -1,10 +1,12 @@ -use crate::server::{client::Notifier, Result}; +use crate::server::{Result, client::Notifier}; use crate::session::DocumentSnapshot; +use anyhow::Context; use lsp_types::{self as types, request as req}; use regex::Regex; use ruff_diagnostics::FixAvailability; use ruff_linter::registry::{Linter, Rule, RuleNamespace}; use ruff_source_file::OneIndexed; +use std::fmt::Write; pub(crate) struct Hover; @@ -33,7 +35,8 @@ pub(crate) fn hover( let document = snapshot .query() .as_single_document() - .expect("hover should only be called on text documents or notebook cells"); + .context("Failed to get text document for the hover request") + .unwrap(); let line_number: usize = position .position .line @@ -82,12 +85,16 @@ pub(crate) fn hover( fn format_rule_text(rule: Rule) -> String { let mut output = String::new(); - output.push_str(&format!("# {} ({})", rule.as_ref(), rule.noqa_code())); + let _ = write!(&mut output, "# {} ({})", rule.as_ref(), rule.noqa_code()); output.push('\n'); output.push('\n'); let (linter, _) = Linter::parse_code(&rule.noqa_code().to_string()).unwrap(); - output.push_str(&format!("Derived from the **{}** linter.", linter.name())); + let _ = write!( + &mut output, + "Derived from the **{}** linter.", + linter.name() + ); output.push('\n'); output.push('\n'); diff --git a/crates/ruff_server/src/server/client.rs b/crates/ruff_server/src/server/client.rs index bd12f86d78e5c..e136bc98d44b8 100644 --- a/crates/ruff_server/src/server/client.rs +++ b/crates/ruff_server/src/server/client.rs @@ -4,7 +4,7 @@ use lsp_server::{Notification, RequestId}; use rustc_hash::FxHashMap; use serde_json::Value; -use super::{schedule::Task, ClientSender}; +use super::{ClientSender, schedule::Task}; type ResponseBuilder<'s> = Box<dyn FnOnce(lsp_server::Response) -> Task<'s>>; @@ -26,7 +26,7 @@ pub(crate) struct Requester<'s> { response_handlers: FxHashMap<lsp_server::RequestId, ResponseBuilder<'s>>, } -impl<'s> Client<'s> { +impl Client<'_> { pub(super) fn new(sender: ClientSender) -> Self { Self { notifier: Notifier(sender.clone()), @@ -48,7 +48,7 @@ impl<'s> Client<'s> { } } -#[allow(dead_code)] // we'll need to use `Notifier` in the future +#[expect(dead_code)] // we'll need to use `Notifier` in the future impl Notifier { pub(crate) fn notify<N>(&self, params: N::Params) -> crate::Result<()> where diff --git a/crates/ruff_server/src/server/connection.rs b/crates/ruff_server/src/server/connection.rs index c04567c57ae84..029a34c931f59 100644 --- a/crates/ruff_server/src/server/connection.rs +++ b/crates/ruff_server/src/server/connection.rs @@ -91,19 +91,42 @@ impl Connection { self.sender .send(lsp::Response::new_ok(id.clone(), ()).into())?; tracing::info!("Shutdown request received. Waiting for an exit notification..."); - match self.receiver.recv_timeout(std::time::Duration::from_secs(30))? { - lsp::Message::Notification(lsp::Notification { method, .. }) if method == lsp_types::notification::Exit::METHOD => { - tracing::info!("Exit notification received. Server shutting down..."); - Ok(true) - }, - message => anyhow::bail!("Server received unexpected message {message:?} while waiting for exit notification") + + loop { + match &self + .receiver + .recv_timeout(std::time::Duration::from_secs(30))? + { + lsp::Message::Notification(lsp::Notification { method, .. }) + if method == lsp_types::notification::Exit::METHOD => + { + tracing::info!("Exit notification received. Server shutting down..."); + return Ok(true); + } + lsp::Message::Request(lsp::Request { id, method, .. }) => { + tracing::warn!( + "Server received unexpected request {method} ({id}) while waiting for exit notification", + ); + self.sender.send(lsp::Message::Response(lsp::Response::new_err( + id.clone(), + lsp::ErrorCode::InvalidRequest as i32, + "Server received unexpected request while waiting for exit notification".to_string(), + )))?; + } + message => { + tracing::warn!( + "Server received unexpected message while waiting for exit notification: {message:?}" + ); + } + } } } lsp::Message::Notification(lsp::Notification { method, .. }) if method == lsp_types::notification::Exit::METHOD => { - tracing::error!("Server received an exit notification before a shutdown request was sent. Exiting..."); - Ok(true) + anyhow::bail!( + "Server received an exit notification before a shutdown request was sent. Exiting..." + ); } _ => Ok(false), } diff --git a/crates/ruff_server/src/server/schedule.rs b/crates/ruff_server/src/server/schedule.rs index f03570686aa4a..ec6204dd6225e 100644 --- a/crates/ruff_server/src/server/schedule.rs +++ b/crates/ruff_server/src/server/schedule.rs @@ -12,7 +12,7 @@ use self::{ thread::ThreadPriority, }; -use super::{client::Client, ClientSender}; +use super::{ClientSender, client::Client}; /// The event loop thread is actually a secondary thread that we spawn from the /// _actual_ main thread. This secondary thread has a larger stack size diff --git a/crates/ruff_server/src/server/schedule/task.rs b/crates/ruff_server/src/server/schedule/task.rs index fdba5e3991d9a..e34b22ed6919f 100644 --- a/crates/ruff_server/src/server/schedule/task.rs +++ b/crates/ruff_server/src/server/schedule/task.rs @@ -19,9 +19,11 @@ pub(in crate::server) enum BackgroundSchedule { /// for formatting actions. This is a high priority thread. Fmt, /// The task should be run on the general high-priority background - /// thread. + /// thread. Reserved for actions caused by the user typing (e.g.syntax highlighting). + #[expect(dead_code)] LatencySensitive, /// The task should be run on a regular-priority background thread. + /// The default for any request that isn't in the critical path of the user typing. #[default] Worker, } diff --git a/crates/ruff_server/src/server/schedule/thread/pool.rs b/crates/ruff_server/src/server/schedule/thread/pool.rs index ea654a11d2af4..98728bba8fa13 100644 --- a/crates/ruff_server/src/server/schedule/thread/pool.rs +++ b/crates/ruff_server/src/server/schedule/thread/pool.rs @@ -16,8 +16,8 @@ use std::{ num::NonZeroUsize, sync::{ - atomic::{AtomicUsize, Ordering}, Arc, + atomic::{AtomicUsize, Ordering}, }, }; @@ -106,7 +106,7 @@ impl Pool { self.job_sender.send(job).unwrap(); } - #[allow(dead_code)] + #[expect(dead_code)] pub(super) fn len(&self) -> usize { self.extant_tasks.load(Ordering::SeqCst) } diff --git a/crates/ruff_server/src/server/schedule/thread/priority.rs b/crates/ruff_server/src/server/schedule/thread/priority.rs index e6a555242fcb7..65b6e3d984908 100644 --- a/crates/ruff_server/src/server/schedule/thread/priority.rs +++ b/crates/ruff_server/src/server/schedule/thread/priority.rs @@ -183,14 +183,14 @@ mod imp { QoSClass::Background => libc::qos_class_t::QOS_CLASS_BACKGROUND, }; - #[allow(unsafe_code)] + #[expect(unsafe_code)] let code = unsafe { libc::pthread_set_qos_class_self_np(c, 0) }; if code == 0 { return; } - #[allow(unsafe_code)] + #[expect(unsafe_code)] let errno = unsafe { *libc::__error() }; match errno { @@ -223,10 +223,10 @@ mod imp { } pub(super) fn get_current_thread_qos_class() -> Option<QoSClass> { - #[allow(unsafe_code)] + #[expect(unsafe_code)] let current_thread = unsafe { libc::pthread_self() }; let mut qos_class_raw = libc::qos_class_t::QOS_CLASS_UNSPECIFIED; - #[allow(unsafe_code)] + #[expect(unsafe_code)] let code = unsafe { libc::pthread_get_qos_class_np(current_thread, &mut qos_class_raw, std::ptr::null_mut()) }; @@ -241,7 +241,7 @@ mod imp { // ones which we cannot handle anyway // // 0: https://github.com/apple-oss-distributions/libpthread/blob/67e155c94093be9a204b69637d198eceff2c7c46/src/qos.c#L171-L177 - #[allow(unsafe_code)] + #[expect(unsafe_code)] let errno = unsafe { *libc::__error() }; unreachable!("`pthread_get_qos_class_np` failed unexpectedly (os error {errno})"); } diff --git a/crates/ruff_server/src/session.rs b/crates/ruff_server/src/session.rs index 23a60f26ff2e6..00fd9d6013c03 100644 --- a/crates/ruff_server/src/session.rs +++ b/crates/ruff_server/src/session.rs @@ -1,11 +1,13 @@ //! Data model, state management, and configuration resolution. +use std::path::Path; use std::sync::Arc; -use lsp_types::{ClientCapabilities, NotebookDocumentCellChange, Url}; +use lsp_types::{ClientCapabilities, FileEvent, NotebookDocumentCellChange, Url}; +use settings::ResolvedClientSettings; use crate::edit::{DocumentKey, DocumentVersion, NotebookDocument}; -use crate::server::Workspaces; +use crate::workspace::Workspaces; use crate::{PositionEncoding, TextDocument}; pub(crate) use self::capabilities::ResolvedClientCapabilities; @@ -131,9 +133,9 @@ impl Session { Ok(()) } - /// Reloads the settings index - pub(crate) fn reload_settings(&mut self, changed_url: &Url) { - self.index.reload_settings(changed_url); + /// Reloads the settings index based on the provided changes. + pub(crate) fn reload_settings(&mut self, changes: &[FileEvent]) { + self.index.reload_settings(changes); } /// Open a workspace folder at the given `url`. @@ -147,24 +149,32 @@ impl Session { Ok(()) } - pub(crate) fn num_documents(&self) -> usize { - self.index.num_documents() + pub(crate) fn resolved_client_capabilities(&self) -> &ResolvedClientCapabilities { + &self.resolved_client_capabilities } - pub(crate) fn num_workspaces(&self) -> usize { - self.index.num_workspaces() + pub(crate) fn encoding(&self) -> PositionEncoding { + self.position_encoding } - pub(crate) fn list_config_files(&self) -> Vec<&std::path::Path> { - self.index.list_config_files() + /// Returns an iterator over the paths to the configuration files in the index. + pub(crate) fn config_file_paths(&self) -> impl Iterator<Item = &Path> { + self.index.config_file_paths() } - pub(crate) fn resolved_client_capabilities(&self) -> &ResolvedClientCapabilities { - &self.resolved_client_capabilities + /// Returns the resolved global client settings. + pub(crate) fn global_client_settings(&self) -> ResolvedClientSettings { + ResolvedClientSettings::global(&self.global_settings) } - pub(crate) fn encoding(&self) -> PositionEncoding { - self.position_encoding + /// Returns the number of open documents in the session. + pub(crate) fn open_documents_len(&self) -> usize { + self.index.open_documents_len() + } + + /// Returns an iterator over the workspace root folders in the session. + pub(crate) fn workspace_root_folders(&self) -> impl Iterator<Item = &Path> { + self.index.workspace_root_folders() } } @@ -184,4 +194,15 @@ impl DocumentSnapshot { pub(crate) fn encoding(&self) -> PositionEncoding { self.position_encoding } + + /// Returns `true` if this snapshot represents a notebook cell. + pub(crate) const fn is_notebook_cell(&self) -> bool { + matches!( + &self.document_ref, + index::DocumentQuery::Notebook { + cell_url: Some(_), + .. + } + ) + } } diff --git a/crates/ruff_server/src/session/capabilities.rs b/crates/ruff_server/src/session/capabilities.rs index 001931f9e8bae..83ab1dba63b65 100644 --- a/crates/ruff_server/src/session/capabilities.rs +++ b/crates/ruff_server/src/session/capabilities.rs @@ -2,7 +2,7 @@ use lsp_types::ClientCapabilities; use ruff_linter::display_settings; #[derive(Debug, Clone, PartialEq, Eq, Default)] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub(crate) struct ResolvedClientCapabilities { pub(crate) code_action_deferred_edit_resolution: bool, pub(crate) apply_edit: bool, @@ -37,18 +37,12 @@ impl ResolvedClientCapabilities { .and_then(|workspace_edit| workspace_edit.document_changes) .unwrap_or_default(); - let workspace_refresh = true; - - // TODO(jane): Once the bug involving workspace.diagnostic(s) deserialization has been fixed, - // uncomment this. - /* let workspace_refresh = client_capabilities .workspace .as_ref() - .and_then(|workspace| workspace.diagnostic.as_ref()) + .and_then(|workspace| workspace.diagnostics.as_ref()) .and_then(|diagnostic| diagnostic.refresh_support) .unwrap_or_default(); - */ let pull_diagnostics = client_capabilities .text_document diff --git a/crates/ruff_server/src/session/index.rs b/crates/ruff_server/src/session/index.rs index a4adbd4a17ccb..8f1993e12c97b 100644 --- a/crates/ruff_server/src/session/index.rs +++ b/crates/ruff_server/src/session/index.rs @@ -4,19 +4,20 @@ use std::path::PathBuf; use std::{collections::BTreeMap, path::Path, sync::Arc}; use anyhow::anyhow; -use lsp_types::Url; -use rustc_hash::FxHashMap; +use lsp_types::{FileEvent, Url}; +use rustc_hash::{FxHashMap, FxHashSet}; +use thiserror::Error; pub(crate) use ruff_settings::RuffSettings; use crate::edit::LanguageId; -use crate::server::{Workspace, Workspaces}; +use crate::workspace::{Workspace, Workspaces}; use crate::{ - edit::{DocumentKey, DocumentVersion, NotebookDocument}, PositionEncoding, TextDocument, + edit::{DocumentKey, DocumentVersion, NotebookDocument}, }; -use super::{settings::ResolvedClientSettings, ClientSettings}; +use super::{ClientSettings, settings::ResolvedClientSettings}; mod ruff_settings; @@ -124,7 +125,7 @@ impl Index { DocumentKey::NotebookCell(url) } else if Path::new(url.path()) .extension() - .map_or(false, |ext| ext.eq_ignore_ascii_case("ipynb")) + .is_some_and(|ext| ext.eq_ignore_ascii_case("ipynb")) { DocumentKey::Notebook(url) } else { @@ -176,21 +177,6 @@ impl Index { .register_workspace(&Workspace::new(url), global_settings) } - pub(super) fn num_documents(&self) -> usize { - self.documents.len() - } - - pub(super) fn num_workspaces(&self) -> usize { - self.settings.len() - } - - pub(super) fn list_config_files(&self) -> Vec<&Path> { - self.settings - .values() - .flat_map(|WorkspaceSettings { ruff_settings, .. }| ruff_settings.list_files()) - .collect() - } - pub(super) fn close_workspace_folder(&mut self, workspace_url: &Url) -> crate::Result<()> { let workspace_path = workspace_url.to_file_path().map_err(|()| { anyhow!("Failed to convert workspace URL to file path: {workspace_url}") @@ -263,31 +249,48 @@ impl Index { Some(controller.make_ref(cell_url, url, document_settings)) } - /// Reloads relevant existing settings files based on a changed settings file path. - pub(super) fn reload_settings(&mut self, changed_url: &Url) { - let Ok(changed_path) = changed_url.to_file_path() else { - // Files that don't map to a path can't be a workspace configuration file. - return; - }; + /// Reload the settings for all the workspace folders that contain the changed files. + /// + /// This method avoids re-indexing the same workspace multiple times if multiple files + /// belonging to the same workspace have been changed. + /// + /// The file events are expected to only contain paths that map to configuration files. This is + /// registered in [`try_register_capabilities`] method. + /// + /// [`try_register_capabilities`]: crate::server::Server::try_register_capabilities + pub(super) fn reload_settings(&mut self, changes: &[FileEvent]) { + let mut indexed = FxHashSet::default(); + + for change in changes { + let Ok(changed_path) = change.uri.to_file_path() else { + // Files that don't map to a path can't be a workspace configuration file. + return; + }; - let Some(enclosing_folder) = changed_path.parent() else { - return; - }; + let Some(enclosing_folder) = changed_path.parent() else { + return; + }; - for (root, settings) in self - .settings - .range_mut(..=enclosing_folder.to_path_buf()) - .rev() - { - if !enclosing_folder.starts_with(root) { - break; - } + for (root, settings) in self + .settings + .range_mut(..=enclosing_folder.to_path_buf()) + .rev() + { + if !enclosing_folder.starts_with(root) { + break; + } - settings.ruff_settings = ruff_settings::RuffSettingsIndex::new( - root, - settings.client_settings.editor_settings(), - false, - ); + if indexed.contains(root) { + continue; + } + indexed.insert(root.clone()); + + settings.ruff_settings = ruff_settings::RuffSettingsIndex::new( + root, + settings.client_settings.editor_settings(), + false, + ); + } } } @@ -386,6 +389,23 @@ impl Index { .next_back() .map(|(_, settings)| settings) } + + /// Returns an iterator over the workspace root folders contained in this index. + pub(super) fn workspace_root_folders(&self) -> impl Iterator<Item = &Path> { + self.settings.keys().map(PathBuf::as_path) + } + + /// Returns the number of open documents. + pub(super) fn open_documents_len(&self) -> usize { + self.documents.len() + } + + /// Returns an iterator over the paths to the configuration files in the index. + pub(super) fn config_file_paths(&self) -> impl Iterator<Item = &Path> { + self.settings + .values() + .flat_map(|WorkspaceSettings { ruff_settings, .. }| ruff_settings.config_file_paths()) + } } /// Maps a workspace folder root to its settings. @@ -497,7 +517,6 @@ impl DocumentController { } } - #[allow(dead_code)] pub(crate) fn as_text(&self) -> Option<&TextDocument> { match self { Self::Text(document) => Some(document), @@ -540,7 +559,7 @@ impl DocumentQuery { ruff_linter::source_kind::SourceKind::Python(document.contents().to_string()) } Self::Notebook { notebook, .. } => { - ruff_linter::source_kind::SourceKind::IpyNotebook(notebook.make_ruff_notebook()) + ruff_linter::source_kind::SourceKind::ipy_notebook(notebook.make_ruff_notebook()) } } } @@ -597,16 +616,24 @@ impl DocumentQuery { /// Attempt to access the single inner text document selected by the query. /// If this query is selecting an entire notebook document, this will return `None`. - pub(crate) fn as_single_document(&self) -> Option<&TextDocument> { + pub(crate) fn as_single_document(&self) -> Result<&TextDocument, SingleDocumentError> { match self { - Self::Text { document, .. } => Some(document), + Self::Text { document, .. } => Ok(document), Self::Notebook { notebook, + file_url, cell_url: cell_uri, .. - } => cell_uri - .as_ref() - .and_then(|cell_uri| notebook.cell_document_by_uri(cell_uri)), + } => { + if let Some(cell_uri) = cell_uri { + let cell = notebook + .cell_document_by_uri(cell_uri) + .ok_or_else(|| SingleDocumentError::CellDoesNotExist(cell_uri.clone()))?; + Ok(cell) + } else { + Err(SingleDocumentError::Notebook(file_url.clone())) + } + } } } @@ -618,3 +645,11 @@ impl DocumentQuery { } } } + +#[derive(Debug, Error)] +pub(crate) enum SingleDocumentError { + #[error("Expected a single text document, but found a notebook document: {0}")] + Notebook(Url), + #[error("Cell with URL {0} does not exist in the internal notebook document")] + CellDoesNotExist(Url), +} diff --git a/crates/ruff_server/src/session/index/ruff_settings.rs b/crates/ruff_server/src/session/index/ruff_settings.rs index 8a783f4497fec..3156d6e0f0793 100644 --- a/crates/ruff_server/src/session/index/ruff_settings.rs +++ b/crates/ruff_server/src/session/index/ruff_settings.rs @@ -1,34 +1,48 @@ use std::collections::BTreeMap; +use std::ops::Deref; use std::path::{Path, PathBuf}; -use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; +use std::sync::atomic::{AtomicBool, Ordering}; use anyhow::Context; use ignore::{WalkBuilder, WalkState}; -use ruff_linter::{ - display_settings, fs::normalize_path_to, settings::types::FilePattern, - settings::types::PreviewMode, -}; +use ruff_linter::settings::types::GlobPath; +use ruff_linter::{settings::types::FilePattern, settings::types::PreviewMode}; +use ruff_workspace::Settings; +use ruff_workspace::pyproject::find_fallback_target_version; use ruff_workspace::resolver::match_exclusion; use ruff_workspace::{ configuration::{Configuration, FormatConfiguration, LintConfiguration, RuleSelection}, pyproject::{find_user_settings_toml, settings_toml}, - resolver::{ConfigurationTransformer, Relativity}, + resolver::ConfigurationTransformer, }; -use crate::session::settings::{ConfigurationPreference, ResolvedEditorSettings}; +use crate::session::settings::{ + ConfigurationPreference, ResolvedConfiguration, ResolvedEditorSettings, +}; +#[derive(Debug)] pub struct RuffSettings { /// The path to this configuration file, used for debugging. /// The default fallback configuration does not have a file path. path: Option<PathBuf>, - /// Settings used to manage file inclusion and exclusion. - file_resolver: ruff_workspace::FileResolverSettings, - /// Settings to pass into the Ruff linter. - linter: ruff_linter::settings::LinterSettings, - /// Settings to pass into the Ruff formatter. - formatter: ruff_workspace::FormatterSettings, + /// The resolved settings. + settings: Settings, +} + +impl RuffSettings { + pub(crate) fn path(&self) -> Option<&Path> { + self.path.as_deref() + } +} + +impl Deref for RuffSettings { + type Target = Settings; + + fn deref(&self) -> &Settings { + &self.settings + } } pub(super) struct RuffSettingsIndex { @@ -39,63 +53,94 @@ pub(super) struct RuffSettingsIndex { impl std::fmt::Display for RuffSettings { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - display_settings! { - formatter = f, - fields = [ - self.file_resolver, - self.linter, - self.formatter - ] - } - Ok(()) + std::fmt::Display::fmt(&self.settings, f) } } impl RuffSettings { + /// Constructs [`RuffSettings`] by attempting to resolve settings from a user-provided + /// configuration file, such as `pyproject.toml` or `ruff.toml`, within the + /// user's workspace. + /// + /// In the absence of a valid configuration file, it gracefully falls back to + /// editor-only settings. pub(crate) fn fallback(editor_settings: &ResolvedEditorSettings, root: &Path) -> RuffSettings { - let mut path = None; - let fallback = find_user_settings_toml() + struct FallbackTransformer<'a> { + inner: EditorConfigurationTransformer<'a>, + } + + impl ConfigurationTransformer for FallbackTransformer<'_> { + fn transform(&self, mut configuration: Configuration) -> Configuration { + let fallback = find_fallback_target_version(self.inner.1); + if let Some(fallback) = fallback { + tracing::debug!( + "Derived `target-version` from found `requires-python`: {fallback:?}" + ); + configuration.target_version = Some(fallback.into()); + } + + self.inner.transform(configuration) + } + } + + find_user_settings_toml() .and_then(|user_settings| { - let settings = ruff_workspace::resolver::resolve_root_settings( + tracing::debug!( + "Loading settings from user configuration file: `{}`", + user_settings.display() + ); + ruff_workspace::resolver::resolve_root_settings( &user_settings, - Relativity::Cwd, - &EditorConfigurationTransformer(editor_settings, root), + &FallbackTransformer { + inner: EditorConfigurationTransformer(editor_settings, root), + }, + ruff_workspace::resolver::ConfigurationOrigin::UserSettings, ) - .ok(); - path = Some(user_settings); - settings + .ok() + .map(|settings| RuffSettings { + path: Some(user_settings), + settings, + }) }) .unwrap_or_else(|| { - let default_configuration = Configuration::default(); - EditorConfigurationTransformer(editor_settings, root) - .transform(default_configuration) - .into_settings(root) - .expect( - "editor configuration should merge successfully with default configuration", - ) - }); - - RuffSettings { - path, - file_resolver: fallback.file_resolver, - formatter: fallback.formatter, - linter: fallback.linter, - } - } + let fallback = find_fallback_target_version(root); + if let Some(fallback) = fallback { + tracing::debug!( + "Derived `target-version` from found `requires-python` for fallback configuration: {fallback:?}" + ); + } - /// Return the [`ruff_workspace::FileResolverSettings`] for this [`RuffSettings`]. - pub(crate) fn file_resolver(&self) -> &ruff_workspace::FileResolverSettings { - &self.file_resolver + let configuration = Configuration { + target_version: fallback.map(Into::into), + ..Configuration::default() + }; + Self::with_editor_settings(editor_settings, root, configuration).expect( + "editor configuration should merge successfully with default configuration", + ) + }) } - /// Return the [`ruff_linter::settings::LinterSettings`] for this [`RuffSettings`]. - pub(crate) fn linter(&self) -> &ruff_linter::settings::LinterSettings { - &self.linter + /// Constructs [`RuffSettings`] by merging the editor-defined settings with the + /// default configuration. + fn editor_only(editor_settings: &ResolvedEditorSettings, root: &Path) -> RuffSettings { + Self::with_editor_settings(editor_settings, root, Configuration::default()) + .expect("editor configuration should merge successfully with default configuration") } - /// Return the [`ruff_workspace::FormatterSettings`] for this [`RuffSettings`]. - pub(crate) fn formatter(&self) -> &ruff_workspace::FormatterSettings { - &self.formatter + /// Merges the `configuration` with the editor defined settings. + fn with_editor_settings( + editor_settings: &ResolvedEditorSettings, + root: &Path, + configuration: Configuration, + ) -> anyhow::Result<RuffSettings> { + let settings = EditorConfigurationTransformer(editor_settings, root) + .transform(configuration) + .into_settings(root)?; + + Ok(RuffSettings { + path: None, + settings, + }) } } @@ -115,9 +160,22 @@ impl RuffSettingsIndex { editor_settings: &ResolvedEditorSettings, is_default_workspace: bool, ) -> Self { + if editor_settings.configuration_preference == ConfigurationPreference::EditorOnly { + tracing::debug!( + "Using editor-only settings for workspace: {} (skipped indexing)", + root.display() + ); + return RuffSettingsIndex { + index: BTreeMap::default(), + fallback: Arc::new(RuffSettings::editor_only(editor_settings, root)), + }; + } + + tracing::debug!("Indexing settings for workspace: {}", root.display()); + let mut has_error = false; - let mut index = BTreeMap::default(); let mut respect_gitignore = None; + let mut index = BTreeMap::default(); // If this is *not* the default workspace, then we should skip the workspace root itself // because it will be resolved when walking the workspace directory tree. This is done by @@ -131,19 +189,18 @@ impl RuffSettingsIndex { Ok(Some(pyproject)) => { match ruff_workspace::resolver::resolve_root_settings( &pyproject, - Relativity::Parent, &EditorConfigurationTransformer(editor_settings, root), + ruff_workspace::resolver::ConfigurationOrigin::Ancestor, ) { Ok(settings) => { + tracing::debug!("Loaded settings from: `{}`", pyproject.display()); respect_gitignore = Some(settings.file_resolver.respect_gitignore); index.insert( directory.to_path_buf(), Arc::new(RuffSettings { path: Some(pyproject), - file_resolver: settings.file_resolver, - linter: settings.linter, - formatter: settings.formatter, + settings, }), ); break; @@ -186,10 +243,9 @@ impl RuffSettingsIndex { // means for different editors. if is_default_workspace { if has_error { - let root = root.display(); show_err_msg!( - "Error while resolving settings from workspace {root}. \ - Please refer to the logs for more details.", + "Error while resolving settings from workspace {}. Please refer to the logs for more details.", + root.display() ); } @@ -199,7 +255,7 @@ impl RuffSettingsIndex { // Add any settings within the workspace itself let mut builder = WalkBuilder::new(root); builder.standard_filters( - respect_gitignore.unwrap_or_else(|| fallback.file_resolver().respect_gitignore), + respect_gitignore.unwrap_or_else(|| fallback.file_resolver.respect_gitignore), ); builder.hidden(false); builder.threads( @@ -258,17 +314,20 @@ impl RuffSettingsIndex { Ok(Some(pyproject)) => { match ruff_workspace::resolver::resolve_root_settings( &pyproject, - Relativity::Parent, &EditorConfigurationTransformer(editor_settings, root), + ruff_workspace::resolver::ConfigurationOrigin::Ancestor, ) { Ok(settings) => { + tracing::debug!( + "Loaded settings from: `{}` for `{}`", + pyproject.display(), + directory.display() + ); index.write().unwrap().insert( directory, Arc::new(RuffSettings { path: Some(pyproject), - file_resolver: settings.file_resolver, - linter: settings.linter, - formatter: settings.formatter, + settings, }), ); } @@ -300,9 +359,9 @@ impl RuffSettingsIndex { }); if has_error.load(Ordering::Relaxed) { - let root = root.display(); show_err_msg!( - "Error while resolving settings from workspace {root}. Please refer to the logs for more details.", + "Error while resolving settings from workspace {}. Please refer to the logs for more details.", + root.display() ); } @@ -321,20 +380,21 @@ impl RuffSettingsIndex { .clone() } - pub(crate) fn list_files(&self) -> impl Iterator<Item = &Path> { + pub(super) fn fallback(&self) -> Arc<RuffSettings> { + self.fallback.clone() + } + + /// Returns an iterator over the paths to the configuration files in the index. + pub(crate) fn config_file_paths(&self) -> impl Iterator<Item = &Path> { self.index .values() .filter_map(|settings| settings.path.as_deref()) } - - pub(super) fn fallback(&self) -> Arc<RuffSettings> { - self.fallback.clone() - } } struct EditorConfigurationTransformer<'a>(&'a ResolvedEditorSettings, &'a Path); -impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> { +impl ConfigurationTransformer for EditorConfigurationTransformer<'_> { fn transform(&self, filesystem_configuration: Configuration) -> Configuration { let ResolvedEditorSettings { configuration, @@ -369,7 +429,7 @@ impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> { exclude .into_iter() .map(|pattern| { - let absolute = normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -378,13 +438,39 @@ impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> { ..Configuration::default() }; - // Merge in the editor-specified configuration file, if it exists. - let editor_configuration = if let Some(config_file_path) = configuration { - match open_configuration_file(&config_file_path) { - Ok(config_from_file) => editor_configuration.combine(config_from_file), - Err(err) => { - tracing::error!("Unable to find editor-specified configuration file: {err}"); - editor_configuration + // Merge in the editor-specified configuration. + let editor_configuration = if let Some(configuration) = configuration { + match configuration { + ResolvedConfiguration::FilePath(path) => { + tracing::debug!( + "Combining settings from editor-specified configuration file at: {}", + path.display() + ); + match open_configuration_file(&path) { + Ok(config_from_file) => editor_configuration.combine(config_from_file), + err => { + tracing::error!( + "{:?}", + err.context("Unable to load editor-specified configuration file") + .unwrap_err() + ); + editor_configuration + } + } + } + ResolvedConfiguration::Inline(options) => { + tracing::debug!( + "Combining settings from editor-specified inline configuration" + ); + match Configuration::from_options(*options, None, project_root) { + Ok(configuration) => editor_configuration.combine(configuration), + Err(err) => { + tracing::error!( + "Unable to load editor-specified inline configuration: {err:?}", + ); + editor_configuration + } + } } } } else { @@ -406,8 +492,8 @@ impl<'a> ConfigurationTransformer for EditorConfigurationTransformer<'a> { fn open_configuration_file(config_path: &Path) -> crate::Result<Configuration> { ruff_workspace::resolver::resolve_configuration( config_path, - Relativity::Parent, &IdentityTransformer, + ruff_workspace::resolver::ConfigurationOrigin::UserSpecified, ) } @@ -418,3 +504,47 @@ impl ConfigurationTransformer for IdentityTransformer { config } } + +#[cfg(test)] +mod tests { + use ruff_linter::line_width::LineLength; + use ruff_workspace::options::Options; + + use super::*; + + /// This test ensures that the inline configuration is correctly applied to the configuration. + #[test] + fn inline_settings() { + let editor_settings = ResolvedEditorSettings { + configuration: Some(ResolvedConfiguration::Inline(Box::new(Options { + line_length: Some(LineLength::try_from(120).unwrap()), + ..Default::default() + }))), + ..Default::default() + }; + + let config = EditorConfigurationTransformer(&editor_settings, Path::new("/src/project")) + .transform(Configuration::default()); + + assert_eq!(config.line_length.unwrap().value(), 120); + } + + /// This test ensures that between the inline configuration and specific settings, the specific + /// settings is prioritized. + #[test] + fn inline_and_specific_settings_resolution_order() { + let editor_settings = ResolvedEditorSettings { + configuration: Some(ResolvedConfiguration::Inline(Box::new(Options { + line_length: Some(LineLength::try_from(120).unwrap()), + ..Default::default() + }))), + line_length: Some(LineLength::try_from(100).unwrap()), + ..Default::default() + }; + + let config = EditorConfigurationTransformer(&editor_settings, Path::new("/src/project")) + .transform(Configuration::default()); + + assert_eq!(config.line_length.unwrap().value(), 100); + } +} diff --git a/crates/ruff_server/src/session/settings.rs b/crates/ruff_server/src/session/settings.rs index 10616fb2eda6c..f251594a0aa33 100644 --- a/crates/ruff_server/src/session/settings.rs +++ b/crates/ruff_server/src/session/settings.rs @@ -3,8 +3,13 @@ use std::{ops::Deref, path::PathBuf, str::FromStr}; use lsp_types::Url; use rustc_hash::FxHashMap; use serde::Deserialize; +use serde_json::{Map, Value}; +use thiserror::Error; -use ruff_linter::{line_width::LineLength, RuleSelector}; +use ruff_linter::RuleSelector; +use ruff_linter::line_width::LineLength; +use ruff_linter::rule_selector::ParseError; +use ruff_workspace::options::Options; /// Maps a workspace URI to its associated client settings. Used during server initialization. pub(crate) type WorkspaceSettingsMap = FxHashMap<Url, ClientSettings>; @@ -14,7 +19,7 @@ pub(crate) type WorkspaceSettingsMap = FxHashMap<Url, ClientSettings>; /// sends them. #[derive(Clone, Debug)] #[cfg_attr(test, derive(PartialEq, Eq))] -#[allow(clippy::struct_excessive_bools)] +#[expect(clippy::struct_excessive_bools)] pub(crate) struct ResolvedClientSettings { fix_all: bool, organize_imports: bool, @@ -29,9 +34,9 @@ pub(crate) struct ResolvedClientSettings { /// LSP client settings. These fields are optional because we don't want to override file-based linter/formatting settings /// if these were un-set. #[derive(Clone, Debug)] -#[cfg_attr(test, derive(PartialEq, Eq))] +#[cfg_attr(test, derive(Default, PartialEq, Eq))] pub(crate) struct ResolvedEditorSettings { - pub(super) configuration: Option<PathBuf>, + pub(super) configuration: Option<ResolvedConfiguration>, pub(super) lint_preview: Option<bool>, pub(super) format_preview: Option<bool>, pub(super) select: Option<Vec<RuleSelector>>, @@ -42,6 +47,48 @@ pub(crate) struct ResolvedEditorSettings { pub(super) configuration_preference: ConfigurationPreference, } +/// The resolved configuration from the client settings. +#[derive(Clone, Debug)] +#[cfg_attr(test, derive(PartialEq, Eq))] +pub(crate) enum ResolvedConfiguration { + FilePath(PathBuf), + Inline(Box<Options>), +} + +impl TryFrom<&ClientConfiguration> for ResolvedConfiguration { + type Error = ResolvedConfigurationError; + + fn try_from(value: &ClientConfiguration) -> Result<Self, Self::Error> { + match value { + ClientConfiguration::String(path) => Ok(ResolvedConfiguration::FilePath( + PathBuf::from(shellexpand::full(path)?.as_ref()), + )), + ClientConfiguration::Object(map) => { + let options = toml::Table::try_from(map)?.try_into::<Options>()?; + if options.extend.is_some() { + Err(ResolvedConfigurationError::ExtendNotSupported) + } else { + Ok(ResolvedConfiguration::Inline(Box::new(options))) + } + } + } + } +} + +/// An error that can occur when trying to resolve the `configuration` value from the client +/// settings. +#[derive(Debug, Error)] +pub(crate) enum ResolvedConfigurationError { + #[error(transparent)] + EnvVarLookupError(#[from] shellexpand::LookupError<std::env::VarError>), + #[error("error serializing configuration to TOML: {0}")] + InvalidToml(#[from] toml::ser::Error), + #[error(transparent)] + InvalidRuffSchema(#[from] toml::de::Error), + #[error("using `extend` is unsupported for inline configuration")] + ExtendNotSupported, +} + /// Determines how multiple conflicting configurations should be resolved - in this /// case, the configuration from the client settings and configuration from local /// `.toml` files (aka 'workspace' configuration). @@ -57,12 +104,23 @@ pub(crate) enum ConfigurationPreference { EditorOnly, } +/// A direct representation of of `configuration` schema within the client settings. +#[derive(Debug, Deserialize)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(untagged)] +enum ClientConfiguration { + /// A path to a configuration file. + String(String), + /// An object containing the configuration options. + Object(Map<String, Value>), +} + /// This is a direct representation of the settings schema sent by the client. #[derive(Debug, Deserialize, Default)] #[cfg_attr(test, derive(PartialEq, Eq))] #[serde(rename_all = "camelCase")] pub struct ClientSettings { - configuration: Option<String>, + configuration: Option<ClientConfiguration>, fix_all: Option<bool>, organize_imports: Option<bool>, lint: Option<LintOptions>, @@ -104,7 +162,7 @@ impl ClientSettings { #[cfg_attr(test, derive(PartialEq, Eq))] #[serde(rename_all = "camelCase")] pub(crate) struct TracingSettings { - pub(crate) log_level: Option<crate::trace::LogLevel>, + pub(crate) log_level: Option<crate::logging::LogLevel>, /// Path to the log file - tildes and environment variables are supported. pub(crate) log_file: Option<PathBuf>, } @@ -263,7 +321,9 @@ impl ResolvedClientSettings { } fn new_impl(all_settings: &[&ClientSettings]) -> Self { - Self { + let mut contains_invalid_settings = false; + + let settings = Self { fix_all: Self::resolve_or(all_settings, |settings| settings.fix_all, true), organize_imports: Self::resolve_or( all_settings, @@ -306,11 +366,18 @@ impl ResolvedClientSettings { ), editor_settings: ResolvedEditorSettings { configuration: Self::resolve_optional(all_settings, |settings| { - settings - .configuration - .as_ref() - .and_then(|config_path| shellexpand::full(config_path).ok()) - .map(|config_path| PathBuf::from(config_path.as_ref())) + settings.configuration.as_ref().and_then(|configuration| { + match ResolvedConfiguration::try_from(configuration) { + Ok(configuration) => Some(configuration), + Err(err) => { + tracing::error!( + "Failed to load settings from `configuration`: {err}" + ); + contains_invalid_settings = true; + None + } + } + }) }), lint_preview: Self::resolve_optional(all_settings, |settings| { settings.lint.as_ref()?.preview @@ -319,34 +386,25 @@ impl ResolvedClientSettings { settings.format.as_ref()?.preview }), select: Self::resolve_optional(all_settings, |settings| { - settings - .lint - .as_ref()? - .select - .as_ref()? - .iter() - .map(|rule| RuleSelector::from_str(rule).ok()) - .collect() + Self::resolve_rules( + settings.lint.as_ref()?.select.as_ref()?, + RuleSelectorKey::Select, + &mut contains_invalid_settings, + ) }), extend_select: Self::resolve_optional(all_settings, |settings| { - settings - .lint - .as_ref()? - .extend_select - .as_ref()? - .iter() - .map(|rule| RuleSelector::from_str(rule).ok()) - .collect() + Self::resolve_rules( + settings.lint.as_ref()?.extend_select.as_ref()?, + RuleSelectorKey::ExtendSelect, + &mut contains_invalid_settings, + ) }), ignore: Self::resolve_optional(all_settings, |settings| { - settings - .lint - .as_ref()? - .ignore - .as_ref()? - .iter() - .map(|rule| RuleSelector::from_str(rule).ok()) - .collect() + Self::resolve_rules( + settings.lint.as_ref()?.ignore.as_ref()?, + RuleSelectorKey::Ignore, + &mut contains_invalid_settings, + ) }), exclude: Self::resolve_optional(all_settings, |settings| settings.exclude.clone()), line_length: Self::resolve_optional(all_settings, |settings| settings.line_length), @@ -356,7 +414,34 @@ impl ResolvedClientSettings { ConfigurationPreference::EditorFirst, ), }, + }; + + if contains_invalid_settings { + show_err_msg!( + "Ruff received invalid settings from the editor. Refer to the logs for more information." + ); + } + + settings + } + + fn resolve_rules( + rules: &[String], + key: RuleSelectorKey, + contains_invalid_settings: &mut bool, + ) -> Option<Vec<RuleSelector>> { + let (mut known, mut unknown) = (vec![], vec![]); + for rule in rules { + match RuleSelector::from_str(rule) { + Ok(selector) => known.push(selector), + Err(ParseError::Unknown(_)) => unknown.push(rule), + } + } + if !unknown.is_empty() { + *contains_invalid_settings = true; + tracing::error!("Unknown rule selectors found in `{key}`: {unknown:?}"); } + if known.is_empty() { None } else { Some(known) } } /// Attempts to resolve a setting using a list of available client settings as sources. @@ -365,7 +450,7 @@ impl ResolvedClientSettings { /// Use [`ResolvedClientSettings::resolve_or`] for settings that should have default values. fn resolve_optional<T>( all_settings: &[&ClientSettings], - get: impl Fn(&ClientSettings) -> Option<T>, + get: impl FnMut(&ClientSettings) -> Option<T>, ) -> Option<T> { all_settings.iter().map(Deref::deref).find_map(get) } @@ -384,6 +469,23 @@ impl ResolvedClientSettings { } } +#[derive(Copy, Clone)] +enum RuleSelectorKey { + Select, + ExtendSelect, + Ignore, +} + +impl std::fmt::Display for RuleSelectorKey { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + RuleSelectorKey::Select => f.write_str("lint.select"), + RuleSelectorKey::ExtendSelect => f.write_str("lint.extendSelect"), + RuleSelectorKey::Ignore => f.write_str("lint.ignore"), + } + } +} + impl ResolvedClientSettings { pub(crate) fn fix_all(&self) -> bool { self.fix_all @@ -425,6 +527,10 @@ impl Default for InitializationOptions { #[cfg(test)] mod tests { use insta::assert_debug_snapshot; + use ruff_python_formatter::QuoteStyle; + use ruff_workspace::options::{ + FormatOptions as RuffFormatOptions, LintCommonOptions, LintOptions, + }; use serde::de::DeserializeOwned; #[cfg(not(windows))] @@ -445,6 +551,9 @@ mod tests { const EMPTY_MULTIPLE_WORKSPACE_INIT_OPTIONS_FIXTURE: &str = include_str!("../../resources/test/fixtures/settings/empty_multiple_workspace.json"); + const INLINE_CONFIGURATION_FIXTURE: &str = + include_str!("../../resources/test/fixtures/settings/inline_configuration.json"); + fn deserialize_fixture<T: DeserializeOwned>(content: &str) -> T { serde_json::from_str(content).expect("test fixture JSON should deserialize") } @@ -735,7 +844,7 @@ mod tests { fn test_global_only_init_options_deserialize() { let options: InitializationOptions = deserialize_fixture(GLOBAL_ONLY_INIT_OPTIONS_FIXTURE); - assert_debug_snapshot!(options, @r###" + assert_debug_snapshot!(options, @r#" GlobalOnly { settings: ClientSettings { configuration: None, @@ -789,7 +898,7 @@ mod tests { }, }, } - "###); + "#); } #[test] @@ -855,4 +964,48 @@ mod tests { all_settings.set_preview(true); assert_preview_all_settings(&all_settings, true); } + + #[test] + fn inline_configuration() { + let options: InitializationOptions = deserialize_fixture(INLINE_CONFIGURATION_FIXTURE); + + let AllSettings { + global_settings, + workspace_settings: None, + } = AllSettings::from_init_options(options) + else { + panic!("Expected global settings only"); + }; + + assert_eq!( + ResolvedClientSettings::global(&global_settings), + ResolvedClientSettings { + fix_all: true, + organize_imports: true, + lint_enable: true, + disable_rule_comment_enable: true, + fix_violation_enable: true, + show_syntax_errors: true, + editor_settings: ResolvedEditorSettings { + configuration: Some(ResolvedConfiguration::Inline(Box::new(Options { + line_length: Some(LineLength::try_from(100).unwrap()), + lint: Some(LintOptions { + common: LintCommonOptions { + extend_select: Some(vec![RuleSelector::from_str("I001").unwrap()]), + ..Default::default() + }, + ..Default::default() + }), + format: Some(RuffFormatOptions { + quote_style: Some(QuoteStyle::Single), + ..Default::default() + }), + ..Default::default() + }))), + extend_select: Some(vec![RuleSelector::from_str("RUF001").unwrap()]), + ..Default::default() + } + } + ); + } } diff --git a/crates/ruff_server/src/trace.rs b/crates/ruff_server/src/trace.rs deleted file mode 100644 index 7bd27747ef3fb..0000000000000 --- a/crates/ruff_server/src/trace.rs +++ /dev/null @@ -1,221 +0,0 @@ -//! The tracing system for `ruff server`. -//! -//! Traces are controlled by the `logLevel` setting, along with the -//! trace level set through the LSP. On VS Code, the trace level can -//! also be set with `ruff.trace.server`. A trace level of `messages` or -//! `verbose` will enable tracing - otherwise, no traces will be shown. -//! -//! `logLevel` can be used to configure the level of tracing that is shown. -//! By default, `logLevel` is set to `"info"`. -//! -//! The server also supports the `RUFF_TRACE` environment variable, which will -//! override the trace value provided by the LSP client. Use this if there's no good way -//! to set the trace value through your editor's configuration. -//! -//! Tracing will write to `stderr` by default, which should appear in the logs for most LSP clients. -//! A `logFile` path can also be specified in the settings, and output will be directed there instead. -use core::str; -use lsp_server::{Message, Notification}; -use lsp_types::{ - notification::{LogTrace, Notification as _}, - ClientInfo, TraceValue, -}; -use serde::Deserialize; -use std::{ - io::{Error as IoError, ErrorKind, Write}, - path::PathBuf, - str::FromStr, - sync::{Arc, Mutex, OnceLock}, -}; -use tracing::level_filters::LevelFilter; -use tracing_subscriber::{ - fmt::{time::Uptime, writer::BoxMakeWriter, MakeWriter}, - layer::SubscriberExt, - Layer, -}; - -use crate::server::ClientSender; - -const TRACE_ENV_KEY: &str = "RUFF_TRACE"; - -static LOGGING_SENDER: OnceLock<ClientSender> = OnceLock::new(); - -static TRACE_VALUE: Mutex<lsp_types::TraceValue> = Mutex::new(lsp_types::TraceValue::Off); - -pub(crate) fn set_trace_value(trace_value: TraceValue) { - let mut global_trace_value = TRACE_VALUE - .lock() - .expect("trace value mutex should be available"); - *global_trace_value = trace_value; -} - -// A tracing writer that uses LSPs logTrace method. -struct TraceLogWriter; - -impl Write for TraceLogWriter { - fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { - let message = str::from_utf8(buf).map_err(|e| IoError::new(ErrorKind::InvalidData, e))?; - LOGGING_SENDER - .get() - .expect("logging sender should be initialized at this point") - .send(Message::Notification(Notification { - method: LogTrace::METHOD.to_owned(), - params: serde_json::json!({ - "message": message - }), - })) - .map_err(|e| IoError::new(ErrorKind::Other, e))?; - Ok(buf.len()) - } - - fn flush(&mut self) -> std::io::Result<()> { - Ok(()) - } -} - -impl<'a> MakeWriter<'a> for TraceLogWriter { - type Writer = Self; - - fn make_writer(&'a self) -> Self::Writer { - Self - } -} - -pub(crate) fn init_tracing( - sender: ClientSender, - log_level: LogLevel, - log_file: Option<&std::path::Path>, - client: Option<&ClientInfo>, -) { - LOGGING_SENDER - .set(sender) - .expect("logging sender should only be initialized once"); - - let log_file = log_file - .map(|path| { - // this expands `logFile` so that tildes and environment variables - // are replaced with their values, if possible. - if let Some(expanded) = shellexpand::full(&path.to_string_lossy()) - .ok() - .and_then(|path| PathBuf::from_str(&path).ok()) - { - expanded - } else { - path.to_path_buf() - } - }) - .and_then(|path| { - std::fs::OpenOptions::new() - .create(true) - .append(true) - .open(&path) - .map_err(|err| { - #[allow(clippy::print_stderr)] - { - eprintln!( - "Failed to open file at {} for logging: {err}", - path.display() - ); - } - }) - .ok() - }); - - let logger = match log_file { - Some(file) => BoxMakeWriter::new(Arc::new(file)), - None => { - if client.is_some_and(|client| { - client.name.starts_with("Zed") || client.name.starts_with("Visual Studio Code") - }) { - BoxMakeWriter::new(TraceLogWriter) - } else { - BoxMakeWriter::new(std::io::stderr) - } - } - }; - let subscriber = tracing_subscriber::Registry::default().with( - tracing_subscriber::fmt::layer() - .with_timer(Uptime::default()) - .with_thread_names(true) - .with_ansi(false) - .with_writer(logger) - .with_filter(TraceLevelFilter) - .with_filter(LogLevelFilter { filter: log_level }), - ); - - tracing::subscriber::set_global_default(subscriber) - .expect("should be able to set global default subscriber"); -} - -#[derive(Clone, Copy, Debug, Deserialize, Default, PartialEq, Eq, PartialOrd, Ord)] -#[serde(rename_all = "lowercase")] -pub(crate) enum LogLevel { - #[default] - Error, - Warn, - Info, - Debug, - Trace, -} - -impl LogLevel { - fn trace_level(self) -> tracing::Level { - match self { - Self::Error => tracing::Level::ERROR, - Self::Warn => tracing::Level::WARN, - Self::Info => tracing::Level::INFO, - Self::Debug => tracing::Level::DEBUG, - Self::Trace => tracing::Level::TRACE, - } - } -} - -/// Filters out traces which have a log level lower than the `logLevel` set by the client. -struct LogLevelFilter { - filter: LogLevel, -} - -/// Filters out traces if the trace value set by the client is `off`. -struct TraceLevelFilter; - -impl<S> tracing_subscriber::layer::Filter<S> for LogLevelFilter { - fn enabled( - &self, - meta: &tracing::Metadata<'_>, - _: &tracing_subscriber::layer::Context<'_, S>, - ) -> bool { - let filter = if meta.target().starts_with("ruff") { - self.filter.trace_level() - } else { - tracing::Level::INFO - }; - - meta.level() <= &filter - } - - fn max_level_hint(&self) -> Option<tracing::level_filters::LevelFilter> { - Some(LevelFilter::from_level(self.filter.trace_level())) - } -} - -impl<S> tracing_subscriber::layer::Filter<S> for TraceLevelFilter { - fn enabled( - &self, - _: &tracing::Metadata<'_>, - _: &tracing_subscriber::layer::Context<'_, S>, - ) -> bool { - trace_value() != lsp_types::TraceValue::Off - } -} - -#[inline] -fn trace_value() -> lsp_types::TraceValue { - std::env::var(TRACE_ENV_KEY) - .ok() - .and_then(|trace| serde_json::from_value(serde_json::Value::String(trace)).ok()) - .unwrap_or_else(|| { - *TRACE_VALUE - .lock() - .expect("trace value mutex should be available") - }) -} diff --git a/crates/ruff_server/src/workspace.rs b/crates/ruff_server/src/workspace.rs new file mode 100644 index 0000000000000..d264d1e602e1f --- /dev/null +++ b/crates/ruff_server/src/workspace.rs @@ -0,0 +1,126 @@ +use std::ops::Deref; + +use lsp_types::{Url, WorkspaceFolder}; +use thiserror::Error; + +use crate::ClientSettings; +use crate::session::WorkspaceSettingsMap; + +#[derive(Debug)] +pub struct Workspaces(Vec<Workspace>); + +impl Workspaces { + pub fn new(workspaces: Vec<Workspace>) -> Self { + Self(workspaces) + } + + /// Create the workspaces from the provided workspace folders as provided by the client during + /// initialization. + pub(crate) fn from_workspace_folders( + workspace_folders: Option<Vec<WorkspaceFolder>>, + mut workspace_settings: WorkspaceSettingsMap, + ) -> std::result::Result<Workspaces, WorkspacesError> { + let mut client_settings_for_url = |url: &Url| { + workspace_settings.remove(url).unwrap_or_else(|| { + tracing::info!( + "No workspace settings found for {}, using default settings", + url + ); + ClientSettings::default() + }) + }; + + let workspaces = + if let Some(folders) = workspace_folders.filter(|folders| !folders.is_empty()) { + folders + .into_iter() + .map(|folder| { + let settings = client_settings_for_url(&folder.uri); + Workspace::new(folder.uri).with_settings(settings) + }) + .collect() + } else { + let current_dir = std::env::current_dir().map_err(WorkspacesError::Io)?; + tracing::info!( + "No workspace(s) were provided during initialization. \ + Using the current working directory as a default workspace: {}", + current_dir.display() + ); + let uri = Url::from_file_path(current_dir) + .map_err(|()| WorkspacesError::InvalidCurrentDir)?; + let settings = client_settings_for_url(&uri); + vec![Workspace::default(uri).with_settings(settings)] + }; + + Ok(Workspaces(workspaces)) + } +} + +impl Deref for Workspaces { + type Target = [Workspace]; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +#[derive(Error, Debug)] +pub(crate) enum WorkspacesError { + #[error(transparent)] + Io(#[from] std::io::Error), + #[error("Failed to create a URL from the current working directory")] + InvalidCurrentDir, +} + +#[derive(Debug)] +pub struct Workspace { + /// The [`Url`] pointing to the root of the workspace. + url: Url, + /// The client settings for this workspace. + settings: Option<ClientSettings>, + /// Whether this is the default workspace as created by the server. This will be the case when + /// no workspace folders were provided during initialization. + is_default: bool, +} + +impl Workspace { + /// Create a new workspace with the given root URL. + pub fn new(url: Url) -> Self { + Self { + url, + settings: None, + is_default: false, + } + } + + /// Create a new default workspace with the given root URL. + pub fn default(url: Url) -> Self { + Self { + url, + settings: None, + is_default: true, + } + } + + /// Set the client settings for this workspace. + #[must_use] + pub fn with_settings(mut self, settings: ClientSettings) -> Self { + self.settings = Some(settings); + self + } + + /// Returns the root URL of the workspace. + pub(crate) fn url(&self) -> &Url { + &self.url + } + + /// Returns the client settings for this workspace. + pub(crate) fn settings(&self) -> Option<&ClientSettings> { + self.settings.as_ref() + } + + /// Returns true if this is the default workspace. + pub(crate) fn is_default(&self) -> bool { + self.is_default + } +} diff --git a/crates/ruff_server/tests/notebook.rs b/crates/ruff_server/tests/notebook.rs index d9e3f690b12f7..64222fd04be9a 100644 --- a/crates/ruff_server/tests/notebook.rs +++ b/crates/ruff_server/tests/notebook.rs @@ -32,10 +32,10 @@ fn super_resolution_overview() { &ClientCapabilities::default(), ruff_server::PositionEncoding::UTF16, ClientSettings::default(), - &Workspaces::new(vec![Workspace::new( - lsp_types::Url::from_file_path(file_path.parent().unwrap()).unwrap(), - ) - .with_settings(ClientSettings::default())]), + &Workspaces::new(vec![ + Workspace::new(lsp_types::Url::from_file_path(file_path.parent().unwrap()).unwrap()) + .with_settings(ClientSettings::default()), + ]), ) .unwrap(); diff --git a/crates/ruff_server/tests/snapshots/document__delete_lines_pandas_html.snap b/crates/ruff_server/tests/snapshots/document__delete_lines_pandas_html.snap index 2ba81d2007ece..47cb6406fb6f7 100644 --- a/crates/ruff_server/tests/snapshots/document__delete_lines_pandas_html.snap +++ b/crates/ruff_server/tests/snapshots/document__delete_lines_pandas_html.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_server/tests/document.rs expression: document.contents() +snapshot_kind: text --- # +------------------------------------------------------------+ # | Code adopted from: | @@ -1230,4 +1231,3 @@ def read_html( dtype_backend=dtype_backend, storage_options=storage_options, ) - diff --git a/crates/ruff_server/tests/snapshots/notebook__changed_notebook.snap b/crates/ruff_server/tests/snapshots/notebook__changed_notebook.snap index a90e2166783a5..f13e4a8694fe1 100644 --- a/crates/ruff_server/tests/snapshots/notebook__changed_notebook.snap +++ b/crates/ruff_server/tests/snapshots/notebook__changed_notebook.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_server/tests/notebook.rs expression: notebook_source(snapshot.query().as_notebook().unwrap()) +snapshot_kind: text --- # @title Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/crates/ruff_server/tests/snapshots/notebook__initial_notebook.snap b/crates/ruff_server/tests/snapshots/notebook__initial_notebook.snap index 29a2872058416..4e60599cbf20a 100644 --- a/crates/ruff_server/tests/snapshots/notebook__initial_notebook.snap +++ b/crates/ruff_server/tests/snapshots/notebook__initial_notebook.snap @@ -1,6 +1,7 @@ --- source: crates/ruff_server/tests/notebook.rs expression: notebook_source(¬ebook) +snapshot_kind: text --- #@title Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/crates/ruff_source_file/src/lib.rs b/crates/ruff_source_file/src/lib.rs index 5bf43e3a1d493..4df0b2a20aee0 100644 --- a/crates/ruff_source_file/src/lib.rs +++ b/crates/ruff_source_file/src/lib.rs @@ -7,18 +7,18 @@ use serde::{Deserialize, Serialize}; use ruff_text_size::{Ranged, TextRange, TextSize}; -pub use crate::line_index::{LineIndex, OneIndexed}; +pub use crate::line_index::{LineIndex, OneIndexed, PositionEncoding}; pub use crate::line_ranges::LineRanges; pub use crate::newlines::{ - find_newline, Line, LineEnding, NewlineWithTrailingNewline, UniversalNewlineIterator, - UniversalNewlines, + Line, LineEnding, NewlineWithTrailingNewline, UniversalNewlineIterator, UniversalNewlines, + find_newline, }; mod line_index; mod line_ranges; mod newlines; -/// Gives access to the source code of a file and allows mapping between [`TextSize`] and [`SourceLocation`]. +/// Gives access to the source code of a file and allows mapping between [`TextSize`] and [`LineColumn`]. #[derive(Debug)] pub struct SourceCode<'src, 'index> { text: &'src str, @@ -33,10 +33,20 @@ impl<'src, 'index> SourceCode<'src, 'index> { } } - /// Computes the one indexed row and column numbers for `offset`. + /// Computes the one indexed line and column numbers for `offset`, skipping any potential BOM. #[inline] - pub fn source_location(&self, offset: TextSize) -> SourceLocation { - self.index.source_location(offset, self.text) + pub fn line_column(&self, offset: TextSize) -> LineColumn { + self.index.line_column(offset, self.text) + } + + #[inline] + pub fn source_location( + &self, + offset: TextSize, + position_encoding: PositionEncoding, + ) -> SourceLocation { + self.index + .source_location(offset, self.text, position_encoding) } #[inline] @@ -185,7 +195,7 @@ impl SourceFile { } } - fn index(&self) -> &LineIndex { + pub fn index(&self) -> &LineIndex { self.inner .line_index .get_or_init(|| LineIndex::from_source_text(self.source_text())) @@ -229,34 +239,62 @@ impl PartialEq for SourceFileInner { impl Eq for SourceFileInner {} -#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] +/// The line and column of an offset in a source file. +/// +/// See [`LineIndex::line_column`] for more information. +#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] -pub struct SourceLocation { - pub row: OneIndexed, +pub struct LineColumn { + /// The line in the source text. + pub line: OneIndexed, + /// The column (UTF scalar values) relative to the start of the line except any + /// potential BOM on the first line. pub column: OneIndexed, } -impl Default for SourceLocation { +impl Default for LineColumn { fn default() -> Self { Self { - row: OneIndexed::MIN, + line: OneIndexed::MIN, column: OneIndexed::MIN, } } } -impl Debug for SourceLocation { +impl Debug for LineColumn { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - f.debug_struct("SourceLocation") - .field("row", &self.row.get()) + f.debug_struct("LineColumn") + .field("line", &self.line.get()) .field("column", &self.column.get()) .finish() } } -impl std::fmt::Display for SourceLocation { +impl std::fmt::Display for LineColumn { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - write!(f, "{row}:{column}", row = self.row, column = self.column) + write!(f, "{line}:{column}", line = self.line, column = self.column) + } +} + +/// A position into a source file represented by the line number and the offset to that character relative to the start of that line. +#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)] +#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] +pub struct SourceLocation { + /// The line in the source text. + pub line: OneIndexed, + /// The offset from the start of the line to the character. + /// + /// This can be a byte offset, the number of UTF16 code points, or the UTF8 code units, depending on the + /// [`PositionEncoding`] used. + pub character_offset: OneIndexed, +} + +impl Default for SourceLocation { + fn default() -> Self { + Self { + line: OneIndexed::MIN, + character_offset: OneIndexed::MIN, + } } } diff --git a/crates/ruff_source_file/src/line_index.rs b/crates/ruff_source_file/src/line_index.rs index e9d211ca5c1ff..54d82b1ab94d2 100644 --- a/crates/ruff_source_file/src/line_index.rs +++ b/crates/ruff_source_file/src/line_index.rs @@ -5,13 +5,12 @@ use std::ops::Deref; use std::str::FromStr; use std::sync::Arc; +use crate::{LineColumn, SourceLocation}; use ruff_text_size::{TextLen, TextRange, TextSize}; #[cfg(feature = "serde")] use serde::{Deserialize, Serialize}; -use crate::SourceLocation; - -/// Index for fast [byte offset](TextSize) to [`SourceLocation`] conversions. +/// Index for fast [byte offset](TextSize) to [`LineColumn`] conversions. /// /// Cloning a [`LineIndex`] is cheap because it only requires bumping a reference count. #[derive(Clone, Eq, PartialEq)] @@ -44,7 +43,7 @@ impl LineIndex { b'\r' if bytes.get(i + 1) == Some(&b'\n') => continue, b'\n' | b'\r' => { // SAFETY: Assertion above guarantees `i <= u32::MAX` - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] line_starts.push(TextSize::from(i as u32) + TextSize::from(1)); } _ => {} @@ -66,60 +65,146 @@ impl LineIndex { self.inner.kind } - /// Returns the row and column index for an offset. + /// Returns the line and column number for an UTF-8 byte offset. + /// + /// The `column` number is the nth-character of the line, except for the first line + /// where it doesn't include the UTF-8 BOM marker at the start of the file. + /// + /// ### BOM handling + /// + /// For files starting with a UTF-8 BOM marker, the byte offsets + /// in the range `0...3` are all mapped to line 0 and column 0. + /// Because of this, the conversion isn't losless. /// /// ## Examples /// /// ``` /// # use ruff_text_size::TextSize; - /// # use ruff_source_file::{LineIndex, OneIndexed, SourceLocation}; - /// let source = "def a():\n pass"; - /// let index = LineIndex::from_source_text(source); + /// # use ruff_source_file::{LineIndex, OneIndexed, LineColumn}; + /// let source = format!("\u{FEFF}{}", "def a():\n pass"); + /// let index = LineIndex::from_source_text(&source); /// + /// // Before BOM, maps to after BOM /// assert_eq!( - /// index.source_location(TextSize::from(0), source), - /// SourceLocation { row: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(0) } + /// index.line_column(TextSize::from(0), &source), + /// LineColumn { line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(0) } /// ); /// + /// // After BOM, maps to after BOM /// assert_eq!( - /// index.source_location(TextSize::from(4), source), - /// SourceLocation { row: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(4) } + /// index.line_column(TextSize::from(3), &source), + /// LineColumn { line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(0) } + /// ); + /// + /// assert_eq!( + /// index.line_column(TextSize::from(7), &source), + /// LineColumn { line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(4) } /// ); /// assert_eq!( - /// index.source_location(TextSize::from(13), source), - /// SourceLocation { row: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(4) } + /// index.line_column(TextSize::from(16), &source), + /// LineColumn { line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(4) } /// ); /// ``` /// /// ## Panics /// - /// If the offset is out of bounds. - pub fn source_location(&self, offset: TextSize, content: &str) -> SourceLocation { - match self.line_starts().binary_search(&offset) { - // Offset is at the start of a line - Ok(row) => SourceLocation { - row: OneIndexed::from_zero_indexed(row), - column: OneIndexed::from_zero_indexed(0), - }, - Err(next_row) => { - // SAFETY: Safe because the index always contains an entry for the offset 0 - let row = next_row - 1; - let mut line_start = self.line_starts()[row]; - - let column = if self.kind().is_ascii() { - usize::from(offset) - usize::from(line_start) - } else { - // Don't count the BOM character as a column. - if line_start == TextSize::from(0) && content.starts_with('\u{feff}') { - line_start = '\u{feff}'.text_len(); - } + /// If the byte offset isn't within the bounds of `content`. + pub fn line_column(&self, offset: TextSize, content: &str) -> LineColumn { + let location = self.source_location(offset, content, PositionEncoding::Utf32); + + // Don't count the BOM character as a column, but only on the first line. + let column = if location.line.to_zero_indexed() == 0 && content.starts_with('\u{feff}') { + location.character_offset.saturating_sub(1) + } else { + location.character_offset + }; - content[TextRange::new(line_start, offset)].chars().count() - }; + LineColumn { + line: location.line, + column, + } + } + + /// Given a UTF-8 byte offset, returns the line and character offset according to the given encoding. + /// + /// ### BOM handling + /// + /// Unlike [`Self::line_column`], this method does not skip the BOM character at the start of the file. + /// This allows for bidirectional mapping between [`SourceLocation`] and [`TextSize`] (see [`Self::offset`]). + /// + /// ## Examples + /// + /// ``` + /// # use ruff_text_size::TextSize; + /// # use ruff_source_file::{LineIndex, OneIndexed, LineColumn, SourceLocation, PositionEncoding, Line}; + /// let source = format!("\u{FEFF}{}", "def a():\n pass"); + /// let index = LineIndex::from_source_text(&source); + /// + /// // Before BOM, maps to character 0 + /// assert_eq!( + /// index.source_location(TextSize::from(0), &source, PositionEncoding::Utf32), + /// SourceLocation { line: OneIndexed::from_zero_indexed(0), character_offset: OneIndexed::from_zero_indexed(0) } + /// ); + /// + /// // After BOM, maps to after BOM + /// assert_eq!( + /// index.source_location(TextSize::from(3), &source, PositionEncoding::Utf32), + /// SourceLocation { line: OneIndexed::from_zero_indexed(0), character_offset: OneIndexed::from_zero_indexed(1) } + /// ); + /// + /// assert_eq!( + /// index.source_location(TextSize::from(7), &source, PositionEncoding::Utf32), + /// SourceLocation { line: OneIndexed::from_zero_indexed(0), character_offset: OneIndexed::from_zero_indexed(5) } + /// ); + /// assert_eq!( + /// index.source_location(TextSize::from(16), &source, PositionEncoding::Utf32), + /// SourceLocation { line: OneIndexed::from_zero_indexed(1), character_offset: OneIndexed::from_zero_indexed(4) } + /// ); + /// ``` + /// + /// ## Panics + /// + /// If the UTF-8 byte offset is out of bounds of `text`. + pub fn source_location( + &self, + offset: TextSize, + text: &str, + encoding: PositionEncoding, + ) -> SourceLocation { + let line = self.line_index(offset); + let line_start = self.line_start(line, text); + + if self.is_ascii() { + return SourceLocation { + line, + character_offset: OneIndexed::from_zero_indexed((offset - line_start).to_usize()), + }; + } + match encoding { + PositionEncoding::Utf8 => { + let character_offset = offset - line_start; SourceLocation { - row: OneIndexed::from_zero_indexed(row), - column: OneIndexed::from_zero_indexed(column), + line, + character_offset: OneIndexed::from_zero_indexed(character_offset.to_usize()), + } + } + PositionEncoding::Utf16 => { + let up_to_character = &text[TextRange::new(line_start, offset)]; + let character = up_to_character.encode_utf16().count(); + + SourceLocation { + line, + character_offset: OneIndexed::from_zero_indexed(character), + } + } + PositionEncoding::Utf32 => { + let up_to_character = &text[TextRange::new(line_start, offset)]; + let character = up_to_character.chars().count(); + + SourceLocation { + line, + character_offset: OneIndexed::from_zero_indexed(character), } } } @@ -141,7 +226,7 @@ impl LineIndex { /// /// ``` /// # use ruff_text_size::TextSize; - /// # use ruff_source_file::{LineIndex, OneIndexed, SourceLocation}; + /// # use ruff_source_file::{LineIndex, OneIndexed, LineColumn}; /// let source = "def a():\n pass"; /// let index = LineIndex::from_source_text(source); /// @@ -221,83 +306,211 @@ impl LineIndex { } } - /// Returns the [byte offset](TextSize) at `line` and `column`. + /// Returns the [UTF-8 byte offset](TextSize) at `line` and `character` where character is counted using the given encoding. /// /// ## Examples /// - /// ### ASCII + /// ### ASCII only source text /// /// ``` - /// use ruff_source_file::{LineIndex, OneIndexed}; - /// use ruff_text_size::TextSize; + /// # use ruff_source_file::{SourceLocation, LineIndex, OneIndexed, PositionEncoding}; + /// # use ruff_text_size::TextSize; /// let source = r#"a = 4 /// c = "some string" /// x = b"#; /// /// let index = LineIndex::from_source_text(source); /// - /// // First line, first column - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(0), OneIndexed::from_zero_indexed(0), source), TextSize::new(0)); + /// // First line, first character + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(0), + /// character_offset: OneIndexed::from_zero_indexed(0) + /// }, + /// source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(0) + /// ); /// - /// // Second line, 4th column - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(1), OneIndexed::from_zero_indexed(4), source), TextSize::new(10)); + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(1), + /// character_offset: OneIndexed::from_zero_indexed(4) + /// }, + /// source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(10) + /// ); /// /// // Offset past the end of the first line - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(0), OneIndexed::from_zero_indexed(10), source), TextSize::new(6)); + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(0), + /// character_offset: OneIndexed::from_zero_indexed(10) + /// }, + /// source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(6) + /// ); /// /// // Offset past the end of the file - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(3), OneIndexed::from_zero_indexed(0), source), TextSize::new(29)); + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(3), + /// character_offset: OneIndexed::from_zero_indexed(0) + /// }, + /// source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(29) + /// ); /// ``` /// - /// ### UTF8 + /// ### Non-ASCII source text /// /// ``` - /// use ruff_source_file::{LineIndex, OneIndexed}; + /// use ruff_source_file::{LineIndex, OneIndexed, SourceLocation, PositionEncoding}; /// use ruff_text_size::TextSize; - /// let source = r#"a = 4 + /// let source = format!("\u{FEFF}{}", r#"a = 4 /// c = "❤️" - /// x = b"#; + /// x = b"#); /// - /// let index = LineIndex::from_source_text(source); + /// let index = LineIndex::from_source_text(&source); + /// + /// // First line, first character, points at the BOM + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(0), + /// character_offset: OneIndexed::from_zero_indexed(0) + /// }, + /// &source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(0) + /// ); + /// + /// // First line, after the BOM + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(0), + /// character_offset: OneIndexed::from_zero_indexed(1) + /// }, + /// &source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(3) + /// ); /// - /// // First line, first column - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(0), OneIndexed::from_zero_indexed(0), source), TextSize::new(0)); + /// // second line, 7th character, after emoji, UTF32 + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(1), + /// character_offset: OneIndexed::from_zero_indexed(7) + /// }, + /// &source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(20) + /// ); + /// + /// // Second line, 7th character, after emoji, UTF 16 + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(1), + /// character_offset: OneIndexed::from_zero_indexed(7) + /// }, + /// &source, + /// PositionEncoding::Utf16, + /// ), + /// TextSize::new(20) + /// ); /// - /// // Third line, 2nd column, after emoji - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(2), OneIndexed::from_zero_indexed(1), source), TextSize::new(20)); /// /// // Offset past the end of the second line - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(1), OneIndexed::from_zero_indexed(10), source), TextSize::new(19)); + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(1), + /// character_offset: OneIndexed::from_zero_indexed(10) + /// }, + /// &source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(22) + /// ); /// /// // Offset past the end of the file - /// assert_eq!(index.offset(OneIndexed::from_zero_indexed(3), OneIndexed::from_zero_indexed(0), source), TextSize::new(24)); + /// assert_eq!( + /// index.offset( + /// SourceLocation { + /// line: OneIndexed::from_zero_indexed(3), + /// character_offset: OneIndexed::from_zero_indexed(0) + /// }, + /// &source, + /// PositionEncoding::Utf32, + /// ), + /// TextSize::new(27) + /// ); /// ``` - /// - pub fn offset(&self, line: OneIndexed, column: OneIndexed, contents: &str) -> TextSize { + pub fn offset( + &self, + position: SourceLocation, + text: &str, + position_encoding: PositionEncoding, + ) -> TextSize { // If start-of-line position after last line - if line.to_zero_indexed() > self.line_starts().len() { - return contents.text_len(); + if position.line.to_zero_indexed() > self.line_starts().len() { + return text.text_len(); } - let line_range = self.line_range(line, contents); + let line_range = self.line_range(position.line, text); - match self.kind() { - IndexKind::Ascii => { - line_range.start() - + TextSize::try_from(column.to_zero_indexed()) - .unwrap_or(line_range.len()) - .clamp(TextSize::new(0), line_range.len()) - } - IndexKind::Utf8 => { - let rest = &contents[line_range]; - let column_offset: TextSize = rest + let character_offset = position.character_offset.to_zero_indexed(); + let character_byte_offset = if self.is_ascii() { + TextSize::try_from(character_offset).unwrap() + } else { + let line = &text[line_range]; + + match position_encoding { + PositionEncoding::Utf8 => { + TextSize::try_from(position.character_offset.to_zero_indexed()).unwrap() + } + PositionEncoding::Utf16 => { + let mut byte_offset = TextSize::new(0); + let mut utf16_code_unit_offset = 0; + + for c in line.chars() { + if utf16_code_unit_offset >= character_offset { + break; + } + + // Count characters encoded as two 16 bit words as 2 characters. + byte_offset += c.text_len(); + utf16_code_unit_offset += c.len_utf16(); + } + + byte_offset + } + PositionEncoding::Utf32 => line .chars() - .take(column.to_zero_indexed()) + .take(position.character_offset.to_zero_indexed()) .map(ruff_text_size::TextLen::text_len) - .sum(); - line_range.start() + column_offset + .sum(), } - } + }; + + line_range.start() + character_byte_offset.clamp(TextSize::new(0), line_range.len()) } /// Returns the [byte offsets](TextSize) for every line @@ -430,12 +643,25 @@ impl FromStr for OneIndexed { } } +#[derive(Copy, Clone, Debug)] +pub enum PositionEncoding { + /// Character offsets count the number of bytes from the start of the line. + Utf8, + + /// Character offsets count the number of UTF-16 code units from the start of the line. + Utf16, + + /// Character offsets count the number of UTF-32 code points units (the same as number of characters in Rust) + /// from the start of the line. + Utf32, +} + #[cfg(test)] mod tests { use ruff_text_size::TextSize; use crate::line_index::LineIndex; - use crate::{OneIndexed, SourceLocation}; + use crate::{LineColumn, OneIndexed}; #[test] fn ascii_index() { @@ -466,30 +692,30 @@ mod tests { let index = LineIndex::from_source_text(contents); // First row. - let loc = index.source_location(TextSize::from(2), contents); + let loc = index.line_column(TextSize::from(2), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(2) } ); // Second row. - let loc = index.source_location(TextSize::from(6), contents); + let loc = index.line_column(TextSize::from(6), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); - let loc = index.source_location(TextSize::from(11), contents); + let loc = index.line_column(TextSize::from(11), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(5) } ); @@ -502,23 +728,23 @@ mod tests { assert_eq!(index.line_starts(), &[TextSize::from(0), TextSize::from(6)]); assert_eq!( - index.source_location(TextSize::from(4), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + index.line_column(TextSize::from(4), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(4) } ); assert_eq!( - index.source_location(TextSize::from(6), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(6), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); assert_eq!( - index.source_location(TextSize::from(7), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(7), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(1) } ); @@ -531,23 +757,23 @@ mod tests { assert_eq!(index.line_starts(), &[TextSize::from(0), TextSize::from(7)]); assert_eq!( - index.source_location(TextSize::from(4), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + index.line_column(TextSize::from(4), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(4) } ); assert_eq!( - index.source_location(TextSize::from(7), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(7), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); assert_eq!( - index.source_location(TextSize::from(8), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(8), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(1) } ); @@ -598,23 +824,23 @@ mod tests { // Second ' assert_eq!( - index.source_location(TextSize::from(9), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + index.line_column(TextSize::from(9), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(6) } ); assert_eq!( - index.source_location(TextSize::from(11), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(11), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); assert_eq!( - index.source_location(TextSize::from(12), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(12), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(1) } ); @@ -632,23 +858,23 @@ mod tests { // Second ' assert_eq!( - index.source_location(TextSize::from(9), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + index.line_column(TextSize::from(9), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(6) } ); assert_eq!( - index.source_location(TextSize::from(12), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(12), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); assert_eq!( - index.source_location(TextSize::from(13), contents), - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + index.line_column(TextSize::from(13), contents), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(1) } ); @@ -664,49 +890,49 @@ mod tests { ); // First row. - let loc = index.source_location(TextSize::from(0), contents); + let loc = index.line_column(TextSize::from(0), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(0) } ); - let loc = index.source_location(TextSize::from(5), contents); + let loc = index.line_column(TextSize::from(5), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(5) } ); - let loc = index.source_location(TextSize::from(8), contents); + let loc = index.line_column(TextSize::from(8), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(0), + LineColumn { + line: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(6) } ); // Second row. - let loc = index.source_location(TextSize::from(10), contents); + let loc = index.line_column(TextSize::from(10), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) } ); // One-past-the-end. - let loc = index.source_location(TextSize::from(15), contents); + let loc = index.line_column(TextSize::from(15), contents); assert_eq!( loc, - SourceLocation { - row: OneIndexed::from_zero_indexed(1), + LineColumn { + line: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(5) } ); diff --git a/crates/ruff_source_file/src/line_ranges.rs b/crates/ruff_source_file/src/line_ranges.rs index 7fb7a50d6b3e2..77c19837fbc01 100644 --- a/crates/ruff_source_file/src/line_ranges.rs +++ b/crates/ruff_source_file/src/line_ranges.rs @@ -295,6 +295,44 @@ pub trait LineRanges { /// ## Panics /// If the start or end of `range` is out of bounds. fn full_lines_str(&self, range: TextRange) -> &str; + + /// The number of lines `range` spans. + /// + /// ## Examples + /// + /// ``` + /// # use ruff_text_size::{Ranged, TextRange}; + /// # use ruff_source_file::LineRanges; + /// + /// assert_eq!("a\nb".count_lines(TextRange::up_to(1.into())), 0); + /// assert_eq!("a\nb\r\nc".count_lines(TextRange::up_to(3.into())), 1, "Up to the end of the second line"); + /// assert_eq!("a\nb\r\nc".count_lines(TextRange::up_to(4.into())), 2, "In between the line break characters"); + /// assert_eq!("a\nb\r\nc".count_lines(TextRange::up_to(5.into())), 2); + /// assert_eq!("Single line".count_lines(TextRange::up_to(13.into())), 0); + /// assert_eq!("out\nof\nbounds end".count_lines(TextRange::up_to(55.into())), 2); + /// ``` + fn count_lines(&self, range: TextRange) -> u32 { + let mut count = 0; + let mut line_end = self.line_end(range.start()); + + loop { + let next_line_start = self.full_line_end(line_end); + + // Reached the end of the string + if next_line_start == line_end { + break count; + } + + // Range ends at the line boundary + if line_end >= range.end() { + break count; + } + + count += 1; + + line_end = self.line_end(next_line_start); + } + } } impl LineRanges for str { diff --git a/crates/ruff_source_file/src/newlines.rs b/crates/ruff_source_file/src/newlines.rs index deb6d8469031a..1078750b35806 100644 --- a/crates/ruff_source_file/src/newlines.rs +++ b/crates/ruff_source_file/src/newlines.rs @@ -322,7 +322,7 @@ impl LineEnding { } } - #[allow(clippy::len_without_is_empty)] + #[expect(clippy::len_without_is_empty)] pub const fn len(&self) -> usize { match self { LineEnding::Lf | LineEnding::Cr => 1, diff --git a/crates/ruff_text_size/Cargo.toml b/crates/ruff_text_size/Cargo.toml index d51954503b68e..19de4864640bc 100644 --- a/crates/ruff_text_size/Cargo.toml +++ b/crates/ruff_text_size/Cargo.toml @@ -2,8 +2,13 @@ name = "ruff_text_size" version = "0.0.0" publish = false -edition = "2021" -rust-version = "1.67.1" +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } [dependencies] serde = { workspace = true, optional = true } diff --git a/crates/ruff_text_size/src/range.rs b/crates/ruff_text_size/src/range.rs index aa51734549837..f2767c3d75b8c 100644 --- a/crates/ruff_text_size/src/range.rs +++ b/crates/ruff_text_size/src/range.rs @@ -44,6 +44,7 @@ impl TextRange { /// assert_eq!(range.len(), end - start); /// ``` #[inline] + #[track_caller] pub const fn new(start: TextSize, end: TextSize) -> TextRange { assert!(start.raw <= end.raw); TextRange { start, end } diff --git a/crates/ruff_text_size/src/schemars_impls.rs b/crates/ruff_text_size/src/schemars_impls.rs index a1c7fa3618b98..4bc9ba2e01dc2 100644 --- a/crates/ruff_text_size/src/schemars_impls.rs +++ b/crates/ruff_text_size/src/schemars_impls.rs @@ -6,17 +6,17 @@ //! bindings to the Workspace API use crate::{TextRange, TextSize}; -use schemars::{gen::SchemaGenerator, schema::Schema, JsonSchema}; +use schemars::{JsonSchema, r#gen::SchemaGenerator, schema::Schema}; impl JsonSchema for TextSize { fn schema_name() -> String { String::from("TextSize") } - fn json_schema(gen: &mut SchemaGenerator) -> Schema { + fn json_schema(r#gen: &mut SchemaGenerator) -> Schema { // TextSize is represented as a raw u32, see serde_impls.rs for the // actual implementation - <u32>::json_schema(gen) + <u32>::json_schema(r#gen) } } @@ -25,9 +25,9 @@ impl JsonSchema for TextRange { String::from("TextRange") } - fn json_schema(gen: &mut SchemaGenerator) -> Schema { + fn json_schema(r#gen: &mut SchemaGenerator) -> Schema { // TextSize is represented as (TextSize, TextSize), see serde_impls.rs // for the actual implementation - <(TextSize, TextSize)>::json_schema(gen) + <(TextSize, TextSize)>::json_schema(r#gen) } } diff --git a/crates/ruff_text_size/src/serde_impls.rs b/crates/ruff_text_size/src/serde_impls.rs index b6885d674ac2c..7558e9769e417 100644 --- a/crates/ruff_text_size/src/serde_impls.rs +++ b/crates/ruff_text_size/src/serde_impls.rs @@ -1,6 +1,6 @@ use { crate::{TextRange, TextSize}, - serde::{de, Deserialize, Deserializer, Serialize, Serializer}, + serde::{Deserialize, Deserializer, Serialize, Serializer, de}, }; impl Serialize for TextSize { @@ -31,7 +31,7 @@ impl Serialize for TextRange { } impl<'de> Deserialize<'de> for TextRange { - #[allow(clippy::nonminimal_bool)] + #[expect(clippy::nonminimal_bool)] fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>, diff --git a/crates/ruff_text_size/src/traits.rs b/crates/ruff_text_size/src/traits.rs index 0ea015135a3fe..69b0f647b5dde 100644 --- a/crates/ruff_text_size/src/traits.rs +++ b/crates/ruff_text_size/src/traits.rs @@ -31,7 +31,7 @@ impl TextLen for &'_ String { impl Sealed for char {} impl TextLen for char { #[inline] - #[allow(clippy::cast_possible_truncation)] + #[expect(clippy::cast_possible_truncation)] fn text_len(self) -> TextSize { (self.len_utf8() as u32).into() } diff --git a/crates/ruff_text_size/tests/serde.rs b/crates/ruff_text_size/tests/serde.rs index 0d8f9d4a6af12..606b4168335e9 100644 --- a/crates/ruff_text_size/tests/serde.rs +++ b/crates/ruff_text_size/tests/serde.rs @@ -1,6 +1,6 @@ use { ruff_text_size::{TextRange, TextSize}, - serde_test::{assert_de_tokens_error, assert_tokens, Token}, + serde_test::{Token, assert_de_tokens_error, assert_tokens}, std::ops, }; diff --git a/crates/ruff_wasm/Cargo.toml b/crates/ruff_wasm/Cargo.toml index d203947df3efd..15623862c3261 100644 --- a/crates/ruff_wasm/Cargo.toml +++ b/crates/ruff_wasm/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ruff_wasm" -version = "0.7.1" +version = "0.11.10" publish = false authors = { workspace = true } edition = { workspace = true } @@ -35,6 +35,9 @@ console_error_panic_hook = { workspace = true, optional = true } console_log = { workspace = true } js-sys = { workspace = true } log = { workspace = true } +# Not a direct dependency but required to enable the `wasm_js` feature. +# See https://docs.rs/getrandom/latest/getrandom/#webassembly-support +getrandom = { workspace = true, features = ["wasm_js"] } serde = { workspace = true } serde-wasm-bindgen = { workspace = true } wasm-bindgen = { workspace = true } diff --git a/crates/ruff_wasm/src/lib.rs b/crates/ruff_wasm/src/lib.rs index 04d2e568b4903..55c339c53c41b 100644 --- a/crates/ruff_wasm/src/lib.rs +++ b/crates/ruff_wasm/src/lib.rs @@ -1,37 +1,36 @@ use std::path::Path; use js_sys::Error; +use ruff_linter::settings::types::PythonVersion; use serde::{Deserialize, Serialize}; use wasm_bindgen::prelude::*; use ruff_formatter::printer::SourceMapGeneration; use ruff_formatter::{FormatResult, Formatted, IndentStyle}; +use ruff_linter::Locator; use ruff_linter::directives; use ruff_linter::line_width::{IndentWidth, LineLength}; use ruff_linter::linter::check_path; -use ruff_linter::registry::AsRule; -use ruff_linter::settings::types::PythonVersion; -use ruff_linter::settings::{flags, DEFAULT_SELECTORS, DUMMY_VARIABLE_RGX}; +use ruff_linter::settings::{DEFAULT_SELECTORS, DUMMY_VARIABLE_RGX, flags}; use ruff_linter::source_kind::SourceKind; -use ruff_linter::Locator; use ruff_python_ast::{Mod, PySourceType}; use ruff_python_codegen::Stylist; -use ruff_python_formatter::{format_module_ast, pretty_comments, PyFormatContext, QuoteStyle}; +use ruff_python_formatter::{PyFormatContext, QuoteStyle, format_module_ast, pretty_comments}; use ruff_python_index::Indexer; -use ruff_python_parser::{parse, parse_unchecked, parse_unchecked_source, Mode, Parsed}; +use ruff_python_parser::{Mode, ParseOptions, Parsed, parse, parse_unchecked}; use ruff_python_trivia::CommentRanges; -use ruff_source_file::SourceLocation; +use ruff_source_file::{LineColumn, OneIndexed}; use ruff_text_size::Ranged; +use ruff_workspace::Settings; use ruff_workspace::configuration::Configuration; use ruff_workspace::options::{FormatOptions, LintCommonOptions, LintOptions, Options}; -use ruff_workspace::Settings; #[wasm_bindgen(typescript_custom_section)] const TYPES: &'static str = r#" export interface Diagnostic { code: string | null; message: string; - location: { + start_location: { row: number; column: number; }; @@ -53,15 +52,15 @@ export interface Diagnostic { }; }[]; } | null; -}; +} "#; #[derive(Serialize, Deserialize, Eq, PartialEq, Debug)] pub struct ExpandedMessage { pub code: Option<String>, pub message: String, - pub location: SourceLocation, - pub end_location: SourceLocation, + pub start_location: Location, + pub end_location: Location, pub fix: Option<ExpandedFix>, } @@ -73,8 +72,8 @@ pub struct ExpandedFix { #[derive(Serialize, Deserialize, Eq, PartialEq, Debug)] struct ExpandedEdit { - location: SourceLocation, - end_location: SourceLocation, + location: Location, + end_location: Location, content: Option<String>, } @@ -161,8 +160,15 @@ impl Workspace { // TODO(dhruvmanila): Support Jupyter Notebooks let source_kind = SourceKind::Python(contents.to_string()); + // Use the unresolved version because we don't have a file path. + let target_version = self.settings.linter.unresolved_target_version; + // Parse once. - let parsed = parse_unchecked_source(source_kind.source_code(), source_type); + let options = + ParseOptions::from(source_type).with_target_version(target_version.parser_version()); + let parsed = parse_unchecked(source_kind.source_code(), options) + .try_into_module() + .expect("`PySourceType` always parses to a `ModModule`."); // Map row and column locations to byte slices (lazily). let locator = Locator::new(contents); @@ -182,7 +188,7 @@ impl Workspace { ); // Generate checks. - let diagnostics = check_path( + let messages = check_path( Path::new("<filename>"), None, &locator, @@ -194,47 +200,44 @@ impl Workspace { &source_kind, source_type, &parsed, + target_version, ); let source_code = locator.to_source_code(); - let messages: Vec<ExpandedMessage> = diagnostics + let messages: Vec<ExpandedMessage> = messages .into_iter() - .map(|diagnostic| { - let start_location = source_code.source_location(diagnostic.start()); - let end_location = source_code.source_location(diagnostic.end()); - - ExpandedMessage { - code: Some(diagnostic.kind.rule().noqa_code().to_string()), - message: diagnostic.kind.body, - location: start_location, - end_location, - fix: diagnostic.fix.map(|fix| ExpandedFix { - message: diagnostic.kind.suggestion, - edits: fix - .edits() - .iter() - .map(|edit| ExpandedEdit { - location: source_code.source_location(edit.start()), - end_location: source_code.source_location(edit.end()), - content: edit.content().map(ToString::to_string), - }) - .collect(), - }), + .map(|msg| { + let message = msg.body().to_string(); + let range = msg.range(); + match msg.to_noqa_code() { + Some(code) => ExpandedMessage { + code: Some(code.to_string()), + message, + start_location: source_code.line_column(range.start()).into(), + end_location: source_code.line_column(range.end()).into(), + fix: msg.fix().map(|fix| ExpandedFix { + message: msg.suggestion().map(ToString::to_string), + edits: fix + .edits() + .iter() + .map(|edit| ExpandedEdit { + location: source_code.line_column(edit.start()).into(), + end_location: source_code.line_column(edit.end()).into(), + content: edit.content().map(ToString::to_string), + }) + .collect(), + }), + }, + None => ExpandedMessage { + code: None, + message, + start_location: source_code.line_column(range.start()).into(), + end_location: source_code.line_column(range.end()).into(), + fix: None, + }, } }) - .chain(parsed.errors().iter().map(|parse_error| { - let start_location = source_code.source_location(parse_error.location.start()); - let end_location = source_code.source_location(parse_error.location.end()); - - ExpandedMessage { - code: None, - message: format!("SyntaxError: {}", parse_error.error), - location: start_location, - end_location, - fix: None, - } - })) .collect(); serde_wasm_bindgen::to_value(&messages).map_err(into_error) @@ -264,13 +267,13 @@ impl Workspace { /// Parses the content and returns its AST pub fn parse(&self, contents: &str) -> Result<String, Error> { - let parsed = parse_unchecked(contents, Mode::Module); + let parsed = parse_unchecked(contents, ParseOptions::from(Mode::Module)); Ok(format!("{:#?}", parsed.into_syntax())) } pub fn tokens(&self, contents: &str) -> Result<String, Error> { - let parsed = parse_unchecked(contents, Mode::Module); + let parsed = parse_unchecked(contents, ParseOptions::from(Mode::Module)); Ok(format!("{:#?}", parsed.tokens().as_ref())) } @@ -288,7 +291,7 @@ struct ParsedModule<'a> { impl<'a> ParsedModule<'a> { fn from_source(source_code: &'a str) -> Result<Self, Error> { - let parsed = parse(source_code, Mode::Module).map_err(into_error)?; + let parsed = parse(source_code, ParseOptions::from(Mode::Module)).map_err(into_error)?; let comment_ranges = CommentRanges::from(parsed.tokens()); Ok(Self { source_code, @@ -301,7 +304,7 @@ impl<'a> ParsedModule<'a> { // TODO(konstin): Add an options for py/pyi to the UI (2/2) let options = settings .formatter - .to_format_options(PySourceType::default(), self.source_code) + .to_format_options(PySourceType::default(), self.source_code, None) .with_source_map_generation(SourceMapGeneration::Enabled); format_module_ast( @@ -312,3 +315,18 @@ impl<'a> ParsedModule<'a> { ) } } + +#[derive(Serialize, Deserialize, Eq, PartialEq, Debug)] +pub struct Location { + pub row: OneIndexed, + pub column: OneIndexed, +} + +impl From<LineColumn> for Location { + fn from(value: LineColumn) -> Self { + Self { + row: value.line, + column: value.column, + } + } +} diff --git a/crates/ruff_wasm/tests/api.rs b/crates/ruff_wasm/tests/api.rs index 50811299fc307..32177e6bb6361 100644 --- a/crates/ruff_wasm/tests/api.rs +++ b/crates/ruff_wasm/tests/api.rs @@ -3,8 +3,8 @@ use wasm_bindgen_test::wasm_bindgen_test; use ruff_linter::registry::Rule; -use ruff_source_file::{OneIndexed, SourceLocation}; -use ruff_wasm::{ExpandedMessage, Workspace}; +use ruff_source_file::OneIndexed; +use ruff_wasm::{ExpandedMessage, Location, Workspace}; macro_rules! check { ($source:expr, $config:expr, $expected:expr) => {{ @@ -27,11 +27,11 @@ fn empty_config() { [ExpandedMessage { code: Some(Rule::IfTuple.noqa_code().to_string()), message: "If test is a tuple, which is always `True`".to_string(), - location: SourceLocation { + start_location: Location { row: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(3) }, - end_location: SourceLocation { + end_location: Location { row: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(9) }, @@ -48,11 +48,11 @@ fn syntax_error() { [ExpandedMessage { code: None, message: "SyntaxError: Expected an expression".to_string(), - location: SourceLocation { + start_location: Location { row: OneIndexed::from_zero_indexed(0), column: OneIndexed::from_zero_indexed(3) }, - end_location: SourceLocation { + end_location: Location { row: OneIndexed::from_zero_indexed(1), column: OneIndexed::from_zero_indexed(0) }, @@ -61,6 +61,27 @@ fn syntax_error() { ); } +#[wasm_bindgen_test] +fn unsupported_syntax_error() { + check!( + "match 2:\n case 1: ...", + r#"{"preview": true, "target-version": "py39"}"#, + [ExpandedMessage { + code: None, + message: "SyntaxError: Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10)".to_string(), + start_location: Location { + row: OneIndexed::from_zero_indexed(0), + column: OneIndexed::from_zero_indexed(0) + }, + end_location: Location { + row: OneIndexed::from_zero_indexed(0), + column: OneIndexed::from_zero_indexed(5) + }, + fix: None, + }] + ); +} + #[wasm_bindgen_test] fn partial_config() { check!("if (1, 2):\n pass", r#"{"ignore": ["F"]}"#, []); diff --git a/crates/ruff_workspace/Cargo.toml b/crates/ruff_workspace/Cargo.toml index df81cd034764a..f1c8f09b8393c 100644 --- a/crates/ruff_workspace/Cargo.toml +++ b/crates/ruff_workspace/Cargo.toml @@ -18,14 +18,17 @@ ruff_formatter = { workspace = true } ruff_graph = { workspace = true, features = ["serde", "schemars"] } ruff_linter = { workspace = true } ruff_macros = { workspace = true } +ruff_options_metadata = { workspace = true } ruff_python_ast = { workspace = true } ruff_python_formatter = { workspace = true, features = ["serde"] } ruff_python_semantic = { workspace = true, features = ["serde"] } +ruff_python_stdlib = { workspace = true } ruff_source_file = { workspace = true } anyhow = { workspace = true } colored = { workspace = true } ignore = { workspace = true } +indexmap = { workspace = true } is-macro = { workspace = true } itertools = { workspace = true } log = { workspace = true } @@ -57,7 +60,12 @@ ignored = ["colored"] [features] default = [] -schemars = ["dep:schemars", "ruff_formatter/schemars", "ruff_python_formatter/schemars", "ruff_python_semantic/schemars"] +schemars = [ + "dep:schemars", + "ruff_formatter/schemars", + "ruff_python_formatter/schemars", + "ruff_python_semantic/schemars", +] [lints] workspace = true diff --git a/crates/ruff_workspace/src/configuration.rs b/crates/ruff_workspace/src/configuration.rs index 40aebcdc4f425..684a2b434dfa0 100644 --- a/crates/ruff_workspace/src/configuration.rs +++ b/crates/ruff_workspace/src/configuration.rs @@ -5,12 +5,12 @@ use std::borrow::Cow; use std::collections::BTreeMap; use std::env::VarError; -use std::num::{NonZeroU16, NonZeroU8}; +use std::num::{NonZeroU8, NonZeroU16}; use std::path::{Path, PathBuf}; use std::str::FromStr; -use anyhow::{anyhow, Result}; -use glob::{glob, GlobError, Paths, PatternError}; +use anyhow::{Context, Result, anyhow}; +use glob::{GlobError, Paths, PatternError, glob}; use itertools::Itertools; use regex::Regex; use rustc_hash::{FxHashMap, FxHashSet}; @@ -23,20 +23,24 @@ use ruff_formatter::IndentStyle; use ruff_graph::{AnalyzeSettings, Direction}; use ruff_linter::line_width::{IndentWidth, LineLength}; use ruff_linter::registry::RuleNamespace; -use ruff_linter::registry::{Rule, RuleSet, INCOMPATIBLE_CODES}; +use ruff_linter::registry::{INCOMPATIBLE_CODES, Rule, RuleSet}; use ruff_linter::rule_selector::{PreviewOptions, Specificity}; -use ruff_linter::rules::pycodestyle; +use ruff_linter::rules::{flake8_import_conventions, isort, pycodestyle}; use ruff_linter::settings::fix_safety_table::FixSafetyTable; use ruff_linter::settings::rule_table::RuleTable; use ruff_linter::settings::types::{ - CompiledPerFileIgnoreList, ExtensionMapping, FilePattern, FilePatternSet, OutputFormat, - PerFileIgnore, PreviewMode, PythonVersion, RequiredVersion, UnsafeFixes, + CompiledPerFileIgnoreList, CompiledPerFileTargetVersionList, ExtensionMapping, FilePattern, + FilePatternSet, GlobPath, OutputFormat, PerFileIgnore, PerFileTargetVersion, PreviewMode, + RequiredVersion, UnsafeFixes, +}; +use ruff_linter::settings::{ + DEFAULT_SELECTORS, DUMMY_VARIABLE_RGX, LinterSettings, TASK_TAGS, TargetVersion, }; -use ruff_linter::settings::{LinterSettings, DEFAULT_SELECTORS, DUMMY_VARIABLE_RGX, TASK_TAGS}; use ruff_linter::{ - fs, warn_user_once, warn_user_once_by_id, warn_user_once_by_message, RuleSelector, - RUFF_PKG_VERSION, + RUFF_PKG_VERSION, RuleSelector, fs, warn_user_once, warn_user_once_by_id, + warn_user_once_by_message, }; +use ruff_python_ast as ast; use ruff_python_formatter::{ DocstringCode, DocstringCodeLineWidth, MagicTrailingComma, QuoteStyle, }; @@ -49,10 +53,10 @@ use crate::options::{ Flake8QuotesOptions, Flake8SelfOptions, Flake8TidyImportsOptions, Flake8TypeCheckingOptions, Flake8UnusedArgumentsOptions, FormatOptions, IsortOptions, LintCommonOptions, LintOptions, McCabeOptions, Options, Pep8NamingOptions, PyUpgradeOptions, PycodestyleOptions, - PydocstyleOptions, PyflakesOptions, PylintOptions, RuffOptions, + PydoclintOptions, PydocstyleOptions, PyflakesOptions, PylintOptions, RuffOptions, }; use crate::settings::{ - FileResolverSettings, FormatterSettings, LineEnding, Settings, EXCLUDE, INCLUDE, + EXCLUDE, FileResolverSettings, FormatterSettings, INCLUDE, LineEnding, Settings, }; #[derive(Clone, Debug, Default)] @@ -136,7 +140,8 @@ pub struct Configuration { pub builtins: Option<Vec<String>>, pub namespace_packages: Option<Vec<PathBuf>>, pub src: Option<Vec<PathBuf>>, - pub target_version: Option<PythonVersion>, + pub target_version: Option<ast::PythonVersion>, + pub per_file_target_version: Option<Vec<PerFileTargetVersion>>, // Global formatting options pub line_length: Option<LineLength>, @@ -161,6 +166,7 @@ impl Configuration { } } + let linter_target_version = TargetVersion(self.target_version); let target_version = self.target_version.unwrap_or_default(); let global_preview = self.preview.unwrap_or_default(); @@ -173,19 +179,17 @@ impl Configuration { PreviewMode::Enabled => ruff_python_formatter::PreviewMode::Enabled, }; + let per_file_target_version = CompiledPerFileTargetVersionList::resolve( + self.per_file_target_version.unwrap_or_default(), + ) + .context("failed to resolve `per-file-target-version` table")?; + let formatter = FormatterSettings { exclude: FilePatternSet::try_from_iter(format.exclude.unwrap_or_default())?, extension: self.extension.clone().unwrap_or_default(), preview: format_preview, - target_version: match target_version { - PythonVersion::Py37 => ruff_python_formatter::PythonVersion::Py37, - PythonVersion::Py38 => ruff_python_formatter::PythonVersion::Py38, - PythonVersion::Py39 => ruff_python_formatter::PythonVersion::Py39, - PythonVersion::Py310 => ruff_python_formatter::PythonVersion::Py310, - PythonVersion::Py311 => ruff_python_formatter::PythonVersion::Py311, - PythonVersion::Py312 => ruff_python_formatter::PythonVersion::Py312, - PythonVersion::Py313 => ruff_python_formatter::PythonVersion::Py313, - }, + unresolved_target_version: target_version, + per_file_target_version: per_file_target_version.clone(), line_width: self .line_length .map_or(format_defaults.line_width, |length| { @@ -232,6 +236,21 @@ impl Configuration { let line_length = self.line_length.unwrap_or_default(); + let rules = lint.as_rule_table(lint_preview)?; + + // LinterSettings validation + let isort = lint + .isort + .map(IsortOptions::try_into_settings) + .transpose()? + .unwrap_or_default(); + let flake8_import_conventions = lint + .flake8_import_conventions + .map(Flake8ImportConventionsOptions::into_settings) + .unwrap_or_default(); + + conflicting_import_settings(&isort, &flake8_import_conventions)?; + Ok(Settings { cache_dir: self .cache_dir @@ -257,13 +276,13 @@ impl Configuration { project_root: project_root.to_path_buf(), }, - #[allow(deprecated)] linter: LinterSettings { - rules: lint.as_rule_table(lint_preview)?, + rules, exclude: FilePatternSet::try_from_iter(lint.exclude.unwrap_or_default())?, extension: self.extension.unwrap_or_default(), preview: lint_preview, - target_version, + unresolved_target_version: linter_target_version, + per_file_target_version, project_root: project_root.to_path_buf(), allowed_confusables: lint .allowed_confusables @@ -310,7 +329,7 @@ impl Configuration { .unwrap_or_default(), flake8_bandit: lint .flake8_bandit - .map(Flake8BanditOptions::into_settings) + .map(|flake8_bandit| flake8_bandit.into_settings(lint.ruff.as_ref())) .unwrap_or_default(), flake8_boolean_trap: lint .flake8_boolean_trap @@ -341,10 +360,7 @@ impl Configuration { .flake8_implicit_str_concat .map(Flake8ImplicitStrConcatOptions::into_settings) .unwrap_or_default(), - flake8_import_conventions: lint - .flake8_import_conventions - .map(Flake8ImportConventionsOptions::into_settings) - .unwrap_or_default(), + flake8_import_conventions, flake8_pytest_style: lint .flake8_pytest_style .map(Flake8PytestStyleOptions::try_into_settings) @@ -374,11 +390,7 @@ impl Configuration { .flake8_gettext .map(Flake8GetTextOptions::into_settings) .unwrap_or_default(), - isort: lint - .isort - .map(IsortOptions::try_into_settings) - .transpose()? - .unwrap_or_default(), + isort, mccabe: lint .mccabe .map(McCabeOptions::into_settings) @@ -396,6 +408,10 @@ impl Configuration { ..pycodestyle::settings::Settings::default() } }, + pydoclint: lint + .pydoclint + .map(PydoclintOptions::into_settings) + .unwrap_or_default(), pydocstyle: lint .pydocstyle .map(PydocstyleOptions::into_settings) @@ -416,6 +432,7 @@ impl Configuration { .ruff .map(RuffOptions::into_settings) .unwrap_or_default(), + typing_extensions: lint.typing_extensions.unwrap_or(true), }, formatter, @@ -458,7 +475,7 @@ impl Configuration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -477,7 +494,7 @@ impl Configuration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -489,7 +506,7 @@ impl Configuration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -499,7 +516,7 @@ impl Configuration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -523,7 +540,19 @@ impl Configuration { .src .map(|src| resolve_src(&src, project_root)) .transpose()?, - target_version: options.target_version, + target_version: options.target_version.map(ast::PythonVersion::from), + per_file_target_version: options.per_file_target_version.map(|versions| { + versions + .into_iter() + .map(|(pattern, version)| { + PerFileTargetVersion::new( + pattern, + ast::PythonVersion::from(version), + Some(project_root), + ) + }) + .collect() + }), // `--extension` is a hidden command-line argument that isn't supported in configuration // files at present. extension: None, @@ -571,6 +600,9 @@ impl Configuration { show_fixes: self.show_fixes.or(config.show_fixes), src: self.src.or(config.src), target_version: self.target_version.or(config.target_version), + per_file_target_version: self + .per_file_target_version + .or(config.per_file_target_version), preview: self.preview.or(config.preview), extension: self.extension.or(config.extension), @@ -604,6 +636,7 @@ pub struct LintConfiguration { pub logger_objects: Option<Vec<String>>, pub task_tags: Option<Vec<String>>, pub typing_modules: Option<Vec<String>>, + pub typing_extensions: Option<bool>, // Plugins pub flake8_annotations: Option<Flake8AnnotationsOptions>, @@ -627,6 +660,7 @@ pub struct LintConfiguration { pub mccabe: Option<McCabeOptions>, pub pep8_naming: Option<Pep8NamingOptions>, pub pycodestyle: Option<PycodestyleOptions>, + pub pydoclint: Option<PydoclintOptions>, pub pydocstyle: Option<PydocstyleOptions>, pub pyflakes: Option<PyflakesOptions>, pub pylint: Option<PylintOptions>, @@ -636,7 +670,7 @@ pub struct LintConfiguration { impl LintConfiguration { fn from_options(options: LintOptions, project_root: &Path) -> Result<Self> { - #[allow(deprecated)] + #[expect(deprecated)] let ignore = options .common .ignore @@ -644,7 +678,7 @@ impl LintConfiguration { .flatten() .chain(options.common.extend_ignore.into_iter().flatten()) .collect(); - #[allow(deprecated)] + #[expect(deprecated)] let unfixable = options .common .unfixable @@ -653,10 +687,12 @@ impl LintConfiguration { .chain(options.common.extend_unfixable.into_iter().flatten()) .collect(); - #[allow(deprecated)] + #[expect(deprecated)] let ignore_init_module_imports = { if options.common.ignore_init_module_imports.is_some() { - warn_user_once!("The `ignore-init-module-imports` option is deprecated and will be removed in a future release. Ruff's handling of imports in `__init__.py` files has been improved (in preview) and unused imports will always be flagged."); + warn_user_once!( + "The `ignore-init-module-imports` option is deprecated and will be removed in a future release. Ruff's handling of imports in `__init__.py` files has been improved (in preview) and unused imports will always be flagged." + ); } options.common.ignore_init_module_imports }; @@ -666,7 +702,7 @@ impl LintConfiguration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -716,6 +752,7 @@ impl LintConfiguration { task_tags: options.common.task_tags, logger_objects: options.common.logger_objects, typing_modules: options.common.typing_modules, + typing_extensions: options.typing_extensions, // Plugins flake8_annotations: options.common.flake8_annotations, @@ -739,6 +776,7 @@ impl LintConfiguration { mccabe: options.common.mccabe, pep8_naming: options.common.pep8_naming, pycodestyle: options.common.pycodestyle, + pydoclint: options.pydoclint, pydocstyle: options.common.pydocstyle, pyflakes: options.common.pyflakes, pylint: options.common.pylint, @@ -775,6 +813,7 @@ impl LintConfiguration { let mut redirects = FxHashMap::default(); let mut deprecated_selectors = FxHashSet::default(); let mut removed_selectors = FxHashSet::default(); + let mut removed_ignored_rules = FxHashSet::default(); let mut ignored_preview_selectors = FxHashSet::default(); // Track which docstring rules are specifically enabled @@ -926,7 +965,11 @@ impl LintConfiguration { // Removed rules if selector.is_exact() { if selector.all_rules().all(|rule| rule.is_removed()) { - removed_selectors.insert(selector); + if kind.is_disable() { + removed_ignored_rules.insert(selector); + } else { + removed_selectors.insert(selector); + } } } @@ -968,6 +1011,20 @@ impl LintConfiguration { } } + if !removed_ignored_rules.is_empty() { + let mut rules = String::new(); + for selection in removed_ignored_rules.iter().sorted() { + let (prefix, code) = selection.prefix_and_code(); + rules.push_str("\n - "); + rules.push_str(prefix); + rules.push_str(code); + } + rules.push('\n'); + warn_user_once_by_message!( + "The following rules have been removed and ignoring them has no effect:{rules}" + ); + } + for (from, target) in redirects.iter().sorted_by_key(|item| item.0) { // TODO(martin): This belongs into the ruff crate. warn_user_once_by_id!( @@ -981,13 +1038,9 @@ impl LintConfiguration { if preview.mode.is_disabled() { for selection in deprecated_selectors.iter().sorted() { let (prefix, code) = selection.prefix_and_code(); - let rule = format!("{prefix}{code}"); - let mut message = - format!("Rule `{rule}` is deprecated and will be removed in a future release."); - if matches!(rule.as_str(), "E999") { - message.push_str(" Syntax errors will always be shown regardless of whether this rule is selected or not."); - } - warn_user_once_by_message!("{message}"); + warn_user_once_by_message!( + "Rule `{prefix}{code}` is deprecated and will be removed in a future release." + ); } } else { let deprecated_selectors = deprecated_selectors.iter().sorted().collect::<Vec<_>>(); @@ -995,7 +1048,9 @@ impl LintConfiguration { [] => (), [selection] => { let (prefix, code) = selection.prefix_and_code(); - return Err(anyhow!("Selection of deprecated rule `{prefix}{code}` is not allowed when preview is enabled.")); + return Err(anyhow!( + "Selection of deprecated rule `{prefix}{code}` is not allowed when preview is enabled." + )); } [..] => { let mut message = "Selection of deprecated rules is not allowed when preview is enabled. Remove selection of:".to_string(); @@ -1118,11 +1173,13 @@ impl LintConfiguration { mccabe: self.mccabe.combine(config.mccabe), pep8_naming: self.pep8_naming.combine(config.pep8_naming), pycodestyle: self.pycodestyle.combine(config.pycodestyle), + pydoclint: self.pydoclint.combine(config.pydoclint), pydocstyle: self.pydocstyle.combine(config.pydocstyle), pyflakes: self.pyflakes.combine(config.pyflakes), pylint: self.pylint.combine(config.pylint), pyupgrade: self.pyupgrade.combine(config.pyupgrade), ruff: self.ruff.combine(config.ruff), + typing_extensions: self.typing_extensions.or(config.typing_extensions), } } } @@ -1142,7 +1199,6 @@ pub struct FormatConfiguration { } impl FormatConfiguration { - #[allow(clippy::needless_pass_by_value)] pub fn from_options(options: FormatOptions, project_root: &Path) -> Result<Self> { Ok(Self { // `--extension` is a hidden command-line argument that isn't supported in configuration @@ -1152,7 +1208,7 @@ impl FormatConfiguration { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -1180,7 +1236,6 @@ impl FormatConfiguration { } #[must_use] - #[allow(clippy::needless_pass_by_value)] pub fn combine(self, config: Self) -> Self { Self { exclude: self.exclude.or(config.exclude), @@ -1209,14 +1264,13 @@ pub struct AnalyzeConfiguration { } impl AnalyzeConfiguration { - #[allow(clippy::needless_pass_by_value)] pub fn from_options(options: AnalyzeOptions, project_root: &Path) -> Result<Self> { Ok(Self { exclude: options.exclude.map(|paths| { paths .into_iter() .map(|pattern| { - let absolute = fs::normalize_path_to(&pattern, project_root); + let absolute = GlobPath::normalize(&pattern, project_root); FilePattern::User(pattern, absolute) }) .collect() @@ -1236,7 +1290,6 @@ impl AnalyzeConfiguration { } #[must_use] - #[allow(clippy::needless_pass_by_value)] pub fn combine(self, config: Self) -> Self { Self { exclude: self.exclude.or(config.exclude), @@ -1288,7 +1341,7 @@ fn warn_about_deprecated_top_level_lint_options( top_level_options: &LintCommonOptions, path: Option<&Path>, ) { - #[allow(deprecated)] + #[expect(deprecated)] let LintCommonOptions { allowed_confusables, dummy_variable_rgx, @@ -1538,17 +1591,56 @@ fn warn_about_deprecated_top_level_lint_options( ); } +/// Detect conflicts between I002 (missing-required-import) and ICN001 (unconventional-import-alias) +fn conflicting_import_settings( + isort: &isort::settings::Settings, + flake8_import_conventions: &flake8_import_conventions::settings::Settings, +) -> Result<()> { + use std::fmt::Write; + let mut err_body = String::new(); + for required_import in &isort.required_imports { + // Ex: `from foo import bar as baz` OR `import foo.bar as baz` + // - qualified name: `foo.bar` + // - bound name: `baz` + // - conflicts with: `{"foo.bar":"buzz"}` + // - does not conflict with either of + // - `{"bar":"buzz"}` + // - `{"foo.bar":"baz"}` + let qualified_name = required_import.qualified_name().to_string(); + let bound_name = required_import.bound_name(); + let Some(alias) = flake8_import_conventions.aliases.get(&qualified_name) else { + continue; + }; + if alias != bound_name { + writeln!(err_body, " - `{qualified_name}` -> `{alias}`").unwrap(); + } + } + + if !err_body.is_empty() { + return Err(anyhow!( + "Required import specified in `lint.isort.required-imports` (I002) \ + conflicts with the required import alias specified in either \ + `lint.flake8-import-conventions.aliases` or \ + `lint.flake8-import-conventions.extend-aliases` (ICN001):\ + \n{err_body}\n\ + Help: Remove the required import or alias from your configuration." + )); + } + + Ok(()) +} + #[cfg(test)] mod tests { use std::str::FromStr; use anyhow::Result; + use ruff_linter::RuleSelector; use ruff_linter::codes::{Flake8Copyright, Pycodestyle, Refurb}; use ruff_linter::registry::{Linter, Rule, RuleSet}; use ruff_linter::rule_selector::PreviewOptions; use ruff_linter::settings::types::PreviewMode; - use ruff_linter::RuleSelector; use crate::configuration::{LintConfiguration, RuleSelection}; use crate::options::PydocstyleOptions; @@ -1556,7 +1648,7 @@ mod tests { const PREVIEW_RULES: &[Rule] = &[ Rule::ReimplementedStarmap, Rule::SliceCopy, - Rule::TooManyPublicMethods, + Rule::ClassAsDataStructure, Rule::TooManyPublicMethods, Rule::UnnecessaryEnumerate, Rule::MathConstant, @@ -1569,7 +1661,6 @@ mod tests { Rule::BlankLinesBeforeNestedDefinition, ]; - #[allow(clippy::needless_pass_by_value)] fn resolve_rules( selections: impl IntoIterator<Item = RuleSelection>, preview: Option<PreviewOptions>, @@ -1613,7 +1704,6 @@ mod tests { Rule::AmbiguousClassName, Rule::AmbiguousFunctionName, Rule::IOError, - Rule::SyntaxError, Rule::TabIndentation, Rule::TrailingWhitespace, Rule::MissingNewlineAtEndOfFile, diff --git a/crates/ruff_workspace/src/lib.rs b/crates/ruff_workspace/src/lib.rs index 5307429613704..bc8505c34627f 100644 --- a/crates/ruff_workspace/src/lib.rs +++ b/crates/ruff_workspace/src/lib.rs @@ -3,7 +3,6 @@ pub mod options; pub mod pyproject; pub mod resolver; -pub mod options_base; mod settings; pub use settings::{FileResolverSettings, FormatterSettings, Settings}; diff --git a/crates/ruff_workspace/src/options.rs b/crates/ruff_workspace/src/options.rs index 6e87221f4be2c..b68fc08ea9682 100644 --- a/crates/ruff_workspace/src/options.rs +++ b/crates/ruff_workspace/src/options.rs @@ -1,11 +1,11 @@ use regex::Regex; use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet}; -use serde::{Deserialize, Serialize}; -use std::collections::BTreeMap; +use serde::de::{self}; +use serde::{Deserialize, Deserializer, Serialize}; +use std::collections::{BTreeMap, BTreeSet}; use std::path::PathBuf; use strum::IntoEnumIterator; -use crate::options_base::{OptionsMetadata, Visit}; use crate::settings::LineEnding; use ruff_formatter::IndentStyle; use ruff_graph::Direction; @@ -24,16 +24,18 @@ use ruff_linter::rules::{ flake8_copyright, flake8_errmsg, flake8_gettext, flake8_implicit_str_concat, flake8_import_conventions, flake8_pytest_style, flake8_quotes, flake8_self, flake8_tidy_imports, flake8_type_checking, flake8_unused_arguments, isort, mccabe, pep8_naming, - pycodestyle, pydocstyle, pyflakes, pylint, pyupgrade, ruff, + pycodestyle, pydoclint, pydocstyle, pyflakes, pylint, pyupgrade, ruff, }; use ruff_linter::settings::types::{ IdentifierPattern, OutputFormat, PythonVersion, RequiredVersion, }; -use ruff_linter::{warn_user_once, RuleSelector}; +use ruff_linter::{RuleSelector, warn_user_once}; use ruff_macros::{CombineOptions, OptionsMetadata}; +use ruff_options_metadata::{OptionsMetadata, Visit}; use ruff_python_ast::name::Name; use ruff_python_formatter::{DocstringCodeLineWidth, QuoteStyle}; use ruff_python_semantic::NameImports; +use ruff_python_stdlib::identifiers::is_identifier; #[derive(Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, Serialize, Deserialize)] #[serde(deny_unknown_fields, rename_all = "kebab-case")] @@ -310,9 +312,11 @@ pub struct Options { /// ``` /// /// If both are specified, `target-version` takes precedence over - /// `requires-python`. + /// `requires-python`. See [_Inferring the Python version_](https://docs.astral.sh/ruff/configuration/#inferring-the-python-version) + /// for a complete description of how the `target-version` is determined + /// when left unspecified. /// - /// Note that a stub file can [sometimes make use of a typing feature](https://typing.readthedocs.io/en/latest/spec/distributing.html#syntax) + /// Note that a stub file can [sometimes make use of a typing feature](https://typing.python.org/en/latest/spec/distributing.html#syntax) /// before it is available at runtime, as long as the stub does not make /// use of new *syntax*. For example, a type checker will understand /// `int | str` in a stub as being a `Union` type annotation, even if the @@ -322,8 +326,8 @@ pub struct Options { /// file than it would for an equivalent runtime file with the same target /// version. #[option( - default = r#""py38""#, - value_type = r#""py37" | "py38" | "py39" | "py310" | "py311" | "py312""#, + default = r#""py39""#, + value_type = r#""py37" | "py38" | "py39" | "py310" | "py311" | "py312" | "py313""#, example = r#" # Always generate Python 3.7-compatible code. target-version = "py37" @@ -331,6 +335,29 @@ pub struct Options { )] pub target_version: Option<PythonVersion>, + /// A list of mappings from glob-style file pattern to Python version to use when checking the + /// corresponding file(s). + /// + /// This may be useful for overriding the global Python version settings in `target-version` or + /// `requires-python` for a subset of files. For example, if you have a project with a minimum + /// supported Python version of 3.9 but a subdirectory of developer scripts that want to use a + /// newer feature like the `match` statement from Python 3.10, you can use + /// `per-file-target-version` to specify `"developer_scripts/*.py" = "py310"`. + /// + /// This setting is used by the linter to enforce any enabled version-specific lint rules, as + /// well as by the formatter for any version-specific formatting options, such as parenthesizing + /// context managers on Python 3.10+. + #[option( + default = "{}", + value_type = "dict[str, PythonVersion]", + scope = "per-file-target-version", + example = r#" + # Override the project-wide Python version for a developer scripts directory: + "scripts/**.py" = "py312" + "# + )] + pub per_file_target_version: Option<FxHashMap<String, PythonVersion>>, + /// The directories to consider when resolving first- vs. third-party /// imports. /// @@ -339,7 +366,7 @@ pub struct Options { /// 1. The directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the "project root"). /// 2. The `"src"` subdirectory of the project root. /// - /// These defaults ensure that uv supports both flat layouts and `src` layouts out-of-the-box. + /// These defaults ensure that Ruff supports both flat layouts and `src` layouts out-of-the-box. /// (If a configuration file is explicitly provided (e.g., via the `--config` command-line /// flag), the current working directory will be considered the project root.) /// @@ -436,7 +463,11 @@ pub struct Options { /// Options specified in the `lint` section take precedence over the deprecated top-level settings. #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[derive(Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, Serialize, Deserialize)] -#[serde(deny_unknown_fields, rename_all = "kebab-case")] +#[serde( + from = "LintOptionsWire", + deny_unknown_fields, + rename_all = "kebab-case" +)] pub struct LintOptions { #[serde(flatten)] pub common: LintCommonOptions, @@ -463,6 +494,10 @@ pub struct LintOptions { )] pub exclude: Option<Vec<String>>, + /// Options for the `pydoclint` plugin. + #[option_group] + pub pydoclint: Option<PydoclintOptions>, + /// Options for the `ruff` plugin #[option_group] pub ruff: Option<RuffOptions>, @@ -478,6 +513,22 @@ pub struct LintOptions { "# )] pub preview: Option<bool>, + + /// Whether to allow imports from the third-party `typing_extensions` module for Python versions + /// before a symbol was added to the first-party `typing` module. + /// + /// Many rules try to import symbols from the `typing` module but fall back to + /// `typing_extensions` for earlier versions of Python. This option can be used to disable this + /// fallback behavior in cases where `typing_extensions` is not installed. + #[option( + default = "true", + value_type = "bool", + example = r#" + # Disable `typing_extensions` imports + typing-extensions = false + "# + )] + pub typing_extensions: Option<bool>, } /// Newtype wrapper for [`LintCommonOptions`] that allows customizing the JSON schema and omitting the fields from the [`OptionsMetadata`]. @@ -505,10 +556,10 @@ impl schemars::JsonSchema for DeprecatedTopLevelLintOptions { "DeprecatedTopLevelLintOptions" )) } - fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { + fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> schemars::schema::Schema { use schemars::schema::Schema; - let common_schema = LintCommonOptions::json_schema(gen); + let common_schema = LintCommonOptions::json_schema(generator); let mut schema_obj = common_schema.into_object(); if let Some(object) = schema_obj.object.as_mut() { @@ -646,7 +697,8 @@ pub struct LintCommonOptions { /// /// When breaking ties between enabled and disabled rules (via `select` and /// `ignore`, respectively), more specific prefixes override less - /// specific prefixes. + /// specific prefixes. `ignore` takes precedence over `select` if the same + /// prefix appears in both. #[option( default = "[]", value_type = "list[RuleSelector]", @@ -732,7 +784,8 @@ pub struct LintCommonOptions { /// /// When breaking ties between enabled and disabled rules (via `select` and /// `ignore`, respectively), more specific prefixes override less - /// specific prefixes. + /// specific prefixes. `ignore` takes precedence over `select` if the + /// same prefix appears in both. #[option( default = r#"["E4", "E7", "E9", "F"]"#, value_type = "list[RuleSelector]", @@ -932,6 +985,7 @@ pub struct LintCommonOptions { // WARNING: Don't add new options to this type. Add them to `LintOptions` instead. } +/// Options for the `flake8-annotations` plugin. #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[derive( Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, CombineOptions, Serialize, Deserialize, @@ -1001,13 +1055,14 @@ impl Flake8AnnotationsOptions { } } +/// Options for the `flake8-bandit` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] #[serde(deny_unknown_fields, rename_all = "kebab-case")] #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct Flake8BanditOptions { - /// A list of directories to consider temporary. + /// A list of directories to consider temporary (see `S108`). #[option( default = "[\"/tmp\", \"/var/tmp\", \"/dev/shm\"]", value_type = "list[str]", @@ -1016,7 +1071,7 @@ pub struct Flake8BanditOptions { pub hardcoded_tmp_directory: Option<Vec<String>>, /// A list of directories to consider temporary, in addition to those - /// specified by [`hardcoded-tmp-directory`](#lint_flake8-bandit_hardcoded-tmp-directory). + /// specified by [`hardcoded-tmp-directory`](#lint_flake8-bandit_hardcoded-tmp-directory) (see `S108`). #[option( default = "[]", value_type = "list[str]", @@ -1033,10 +1088,57 @@ pub struct Flake8BanditOptions { example = "check-typed-exception = true" )] pub check_typed_exception: Option<bool>, + + /// A list of additional callable names that behave like + /// [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup). + /// + /// Expects to receive a list of fully-qualified names (e.g., `webhelpers.html.literal`, rather than + /// `literal`). + #[option( + default = "[]", + value_type = "list[str]", + example = "extend-markup-names = [\"webhelpers.html.literal\", \"my_package.Markup\"]" + )] + pub extend_markup_names: Option<Vec<String>>, + + /// A list of callable names, whose result may be safely passed into + /// [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup). + /// + /// Expects to receive a list of fully-qualified names (e.g., `bleach.clean`, rather than `clean`). + /// + /// This setting helps you avoid false positives in code like: + /// + /// ```python + /// from bleach import clean + /// from markupsafe import Markup + /// + /// cleaned_markup = Markup(clean(some_user_input)) + /// ``` + /// + /// Where the use of [`bleach.clean`](https://bleach.readthedocs.io/en/latest/clean.html) + /// usually ensures that there's no XSS vulnerability. + /// + /// Although it is not recommended, you may also use this setting to whitelist other + /// kinds of calls, e.g. calls to i18n translation functions, where how safe that is + /// will depend on the implementation and how well the translations are audited. + /// + /// Another common use-case is to wrap the output of functions that generate markup + /// like [`xml.etree.ElementTree.tostring`](https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring) + /// or template rendering engines where sanitization of potential user input is either + /// already baked in or has to happen before rendering. + #[option( + default = "[]", + value_type = "list[str]", + example = "allowed-markup-calls = [\"bleach.clean\", \"my_package.sanitize\"]" + )] + pub allowed_markup_calls: Option<Vec<String>>, } impl Flake8BanditOptions { - pub fn into_settings(self) -> ruff_linter::rules::flake8_bandit::settings::Settings { + pub fn into_settings( + self, + ruff_options: Option<&RuffOptions>, + ) -> ruff_linter::rules::flake8_bandit::settings::Settings { ruff_linter::rules::flake8_bandit::settings::Settings { hardcoded_tmp_directory: self .hardcoded_tmp_directory @@ -1045,10 +1147,25 @@ impl Flake8BanditOptions { .chain(self.hardcoded_tmp_directory_extend.unwrap_or_default()) .collect(), check_typed_exception: self.check_typed_exception.unwrap_or(false), + extend_markup_names: self + .extend_markup_names + .or_else(|| { + #[expect(deprecated)] + ruff_options.and_then(|options| options.extend_markup_names.clone()) + }) + .unwrap_or_default(), + allowed_markup_calls: self + .allowed_markup_calls + .or_else(|| { + #[expect(deprecated)] + ruff_options.and_then(|options| options.allowed_markup_calls.clone()) + }) + .unwrap_or_default(), } } } +/// Options for the `flake8-boolean-trap` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1075,6 +1192,7 @@ impl Flake8BooleanTrapOptions { } } +/// Options for the `flake8-bugbear` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1105,36 +1223,111 @@ impl Flake8BugbearOptions { } } } + +/// Options for the `flake8-builtins` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] #[serde(deny_unknown_fields, rename_all = "kebab-case")] #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct Flake8BuiltinsOptions { + /// DEPRECATED: This option has been renamed to `ignorelist`. Use `ignorelist` instead. + /// + /// Ignore list of builtins. + /// + /// This option is ignored if both `ignorelist` and `builtins-ignorelist` are set. #[option( default = r#"[]"#, value_type = "list[str]", example = "builtins-ignorelist = [\"id\"]" )] - /// Ignore list of builtins. + #[deprecated( + since = "0.10.0", + note = "`builtins-ignorelist` has been renamed to `ignorelist`. Use that instead." + )] pub builtins_ignorelist: Option<Vec<String>>, + + /// Ignore list of builtins. #[option( default = r#"[]"#, value_type = "list[str]", - example = "builtins-allowed-modules = [\"id\"]" + example = "ignorelist = [\"id\"]" )] + pub ignorelist: Option<Vec<String>>, + + /// DEPRECATED: This option has been renamed to `allowed-modules`. Use `allowed-modules` instead. + /// /// List of builtin module names to allow. + /// + /// This option is ignored if both `allowed-modules` and `builtins-allowed-modules` are set. + #[option( + default = r#"[]"#, + value_type = "list[str]", + example = "builtins-allowed-modules = [\"secrets\"]" + )] + #[deprecated( + since = "0.10.0", + note = "`builtins-allowed-modules` has been renamed to `allowed-modules`. Use that instead." + )] pub builtins_allowed_modules: Option<Vec<String>>, + + /// List of builtin module names to allow. + #[option( + default = r#"[]"#, + value_type = "list[str]", + example = "allowed-modules = [\"secrets\"]" + )] + pub allowed_modules: Option<Vec<String>>, + + /// DEPRECATED: This option has been renamed to `strict-checking`. Use `strict-checking` instead. + /// + /// Compare module names instead of full module paths. + /// + /// This option is ignored if both `strict-checking` and `builtins-strict-checking` are set. + #[option( + default = r#"false"#, + value_type = "bool", + example = "builtins-strict-checking = true" + )] + #[deprecated( + since = "0.10.0", + note = "`builtins-strict-checking` has been renamed to `strict-checking`. Use that instead." + )] + pub builtins_strict_checking: Option<bool>, + + /// Compare module names instead of full module paths. + /// + /// Used by [`A005` - `stdlib-module-shadowing`](https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/). + #[option( + default = r#"false"#, + value_type = "bool", + example = "strict-checking = true" + )] + pub strict_checking: Option<bool>, } impl Flake8BuiltinsOptions { pub fn into_settings(self) -> ruff_linter::rules::flake8_builtins::settings::Settings { + #[expect(deprecated)] ruff_linter::rules::flake8_builtins::settings::Settings { - builtins_ignorelist: self.builtins_ignorelist.unwrap_or_default(), - builtins_allowed_modules: self.builtins_allowed_modules.unwrap_or_default(), + ignorelist: self + .ignorelist + .or(self.builtins_ignorelist) + .unwrap_or_default(), + allowed_modules: self + .allowed_modules + .or(self.builtins_allowed_modules) + .unwrap_or_default(), + strict_checking: self + .strict_checking + .or(self.builtins_strict_checking) + // use the old default of true on non-preview + .unwrap_or_default(), } } } + +/// Options for the `flake8-comprehensions` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1160,6 +1353,7 @@ impl Flake8ComprehensionsOptions { } } +/// Options for the `flake8-copyright` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1215,6 +1409,7 @@ impl Flake8CopyrightOptions { } } +/// Options for the `flake8-errmsg` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1234,6 +1429,7 @@ impl Flake8ErrMsgOptions { } } +/// Options for the `flake8-gettext` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1271,6 +1467,7 @@ impl Flake8GetTextOptions { } } +/// Options for the `flake8-implicit-str-concat` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1305,6 +1502,7 @@ impl Flake8ImplicitStrConcatOptions { } } +/// Options for the `flake8-import-conventions` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1314,7 +1512,7 @@ pub struct Flake8ImportConventionsOptions { /// The conventional aliases for imports. These aliases can be extended by /// the [`extend-aliases`](#lint_flake8-import-conventions_extend-aliases) option. #[option( - default = r#"{"altair": "alt", "matplotlib": "mpl", "matplotlib.pyplot": "plt", "numpy": "np", "pandas": "pd", "seaborn": "sns", "tensorflow": "tf", "tkinter": "tk", "holoviews": "hv", "panel": "pn", "plotly.express": "px", "polars": "pl", "pyarrow": "pa", "xml.etree.ElementTree": "ET"}"#, + default = r#"{"altair": "alt", "matplotlib": "mpl", "matplotlib.pyplot": "plt", "numpy": "np", "numpy.typing": "npt", "pandas": "pd", "seaborn": "sns", "tensorflow": "tf", "tkinter": "tk", "holoviews": "hv", "panel": "pn", "plotly.express": "px", "polars": "pl", "pyarrow": "pa", "xml.etree.ElementTree": "ET"}"#, value_type = "dict[str, str]", scope = "aliases", example = r#" @@ -1327,7 +1525,7 @@ pub struct Flake8ImportConventionsOptions { scipy = "sp" "# )] - pub aliases: Option<FxHashMap<String, String>>, + pub aliases: Option<FxHashMap<ModuleName, Alias>>, /// A mapping from module to conventional import alias. These aliases will /// be added to the [`aliases`](#lint_flake8-import-conventions_aliases) mapping. @@ -1340,7 +1538,7 @@ pub struct Flake8ImportConventionsOptions { "dask.dataframe" = "dd" "# )] - pub extend_aliases: Option<FxHashMap<String, String>>, + pub extend_aliases: Option<FxHashMap<ModuleName, Alias>>, /// A mapping from module to its banned import aliases. #[option( @@ -1370,14 +1568,84 @@ pub struct Flake8ImportConventionsOptions { pub banned_from: Option<FxHashSet<String>>, } +#[derive(Clone, Debug, PartialEq, Eq, Hash, Default, Serialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct ModuleName(String); + +impl ModuleName { + pub fn into_string(self) -> String { + self.0 + } +} + +impl<'de> Deserialize<'de> for ModuleName { + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> + where + D: Deserializer<'de>, + { + let name = String::deserialize(deserializer)?; + if name.is_empty() || name.split('.').any(|part| !is_identifier(part)) { + Err(de::Error::invalid_value( + de::Unexpected::Str(&name), + &"a sequence of Python identifiers delimited by periods", + )) + } else { + Ok(Self(name)) + } + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash, Default, Serialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct Alias(String); + +impl Alias { + pub fn into_string(self) -> String { + self.0 + } +} + +impl<'de> Deserialize<'de> for Alias { + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> + where + D: Deserializer<'de>, + { + let name = String::deserialize(deserializer)?; + // Assigning to "__debug__" is a SyntaxError + // see the note here: + // https://docs.python.org/3/library/constants.html#debug__ + if &*name == "__debug__" { + return Err(de::Error::invalid_value( + de::Unexpected::Str(&name), + &"an assignable Python identifier", + )); + } + if is_identifier(&name) { + Ok(Self(name)) + } else { + Err(de::Error::invalid_value( + de::Unexpected::Str(&name), + &"a Python identifier", + )) + } + } +} + impl Flake8ImportConventionsOptions { pub fn into_settings(self) -> flake8_import_conventions::settings::Settings { - let mut aliases = match self.aliases { - Some(options_aliases) => options_aliases, + let mut aliases: FxHashMap<String, String> = match self.aliases { + Some(options_aliases) => options_aliases + .into_iter() + .map(|(module, alias)| (module.into_string(), alias.into_string())) + .collect(), None => flake8_import_conventions::settings::default_aliases(), }; if let Some(extend_aliases) = self.extend_aliases { - aliases.extend(extend_aliases); + aliases.extend( + extend_aliases + .into_iter() + .map(|(module, alias)| (module.into_string(), alias.into_string())), + ); } flake8_import_conventions::settings::Settings { @@ -1387,6 +1655,8 @@ impl Flake8ImportConventionsOptions { } } } + +/// Options for the `flake8-pytest-style` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1487,6 +1757,38 @@ pub struct Flake8PytestStyleOptions { example = "mark-parentheses = true" )] pub mark_parentheses: Option<bool>, + + /// List of warning names that require a match= parameter in a + /// `pytest.warns()` call. + /// + /// Supports glob patterns. For more information on the glob syntax, refer + /// to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax). + #[option( + default = r#"["Warning", "UserWarning", "DeprecationWarning"]"#, + value_type = "list[str]", + example = "warns-require-match-for = [\"requests.RequestsWarning\"]" + )] + pub warns_require_match_for: Option<Vec<String>>, + + /// List of additional warning names that require a match= parameter in a + /// `pytest.warns()` call. This extends the default list of warnings that + /// require a match= parameter. + /// + /// This option is useful if you want to extend the default list of warnings + /// that require a match= parameter without having to specify the entire + /// list. + /// + /// Note that this option does not remove any warnings from the default + /// list. + /// + /// Supports glob patterns. For more information on the glob syntax, refer + /// to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax). + #[option( + default = "[]", + value_type = "list[str]", + example = "warns-extend-require-match-for = [\"requests.RequestsWarning\"]" + )] + pub warns_extend_require_match_for: Option<Vec<String>>, } impl Flake8PytestStyleOptions { @@ -1519,10 +1821,33 @@ impl Flake8PytestStyleOptions { .map_err(SettingsError::InvalidRaisesExtendRequireMatchFor)? .unwrap_or_default(), mark_parentheses: self.mark_parentheses.unwrap_or_default(), + warns_require_match_for: self + .warns_require_match_for + .map(|patterns| { + patterns + .into_iter() + .map(|pattern| IdentifierPattern::new(&pattern)) + .collect() + }) + .transpose() + .map_err(SettingsError::InvalidWarnsRequireMatchFor)? + .unwrap_or_else(flake8_pytest_style::settings::default_broad_warnings), + warns_extend_require_match_for: self + .warns_extend_require_match_for + .map(|patterns| { + patterns + .into_iter() + .map(|pattern| IdentifierPattern::new(&pattern)) + .collect() + }) + .transpose() + .map_err(SettingsError::InvalidWarnsExtendRequireMatchFor)? + .unwrap_or_default(), }) } } +/// Options for the `flake8-quotes` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1595,6 +1920,7 @@ impl Flake8QuotesOptions { } } +/// Options for the `flake8_self` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1635,6 +1961,7 @@ impl Flake8SelfOptions { } } +/// Options for the `flake8-tidy-imports` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1692,6 +2019,7 @@ impl Flake8TidyImportsOptions { } } +/// Options for the `flake8-type-checking` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1746,6 +2074,21 @@ pub struct Flake8TypeCheckingOptions { /// /// Common examples include Pydantic's `@pydantic.validate_call` decorator /// (for functions) and attrs' `@attrs.define` decorator (for classes). + /// + /// This also supports framework decorators like FastAPI's `fastapi.FastAPI.get` + /// which will work across assignments in the same module. + /// + /// For example: + /// ```python + /// import fastapi + /// + /// app = FastAPI("app") + /// + /// @app.get("/home") + /// def home() -> str: ... + /// ``` + /// + /// Here `app.get` will correctly be identified as `fastapi.FastAPI.get`. #[option( default = "[]", value_type = "list[str]", @@ -1821,6 +2164,7 @@ impl Flake8TypeCheckingOptions { } } +/// Options for the `flake8-unused-arguments` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -1844,6 +2188,7 @@ impl Flake8UnusedArgumentsOptions { } } +/// Options for the `isort` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2098,7 +2443,7 @@ pub struct IsortOptions { /// Use `-1` for automatic determination. /// /// Ruff uses at most one blank line after imports in typing stub files (files with `.pyi` extension) in accordance to - /// the typing style recommendations ([source](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines)). + /// the typing style recommendations ([source](https://typing.python.org/en/latest/guides/writing_stubs.html#blank-lines)). /// /// When using the formatter, only the values `-1`, `1`, and `2` are compatible because /// it enforces at least one empty and at most two empty lines after imports. @@ -2325,7 +2670,9 @@ impl IsortOptions { let force_sort_within_sections = self.force_sort_within_sections.unwrap_or_default(); let lines_between_types = self.lines_between_types.unwrap_or_default(); if force_sort_within_sections && lines_between_types != 0 { - warn_user_once!("`lines-between-types` is ignored when `force-sort-within-sections` is set to `true`"); + warn_user_once!( + "`lines-between-types` is ignored when `force-sort-within-sections` is set to `true`" + ); } // Extract any configuration options that deal with user-defined sections. @@ -2491,6 +2838,7 @@ impl IsortOptions { } } +/// Options for the `mccabe` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2519,6 +2867,7 @@ impl McCabeOptions { } } +/// Options for the `pep8-naming` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2611,6 +2960,7 @@ impl Pep8NamingOptions { } } +/// Options for the `pycodestyle` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2685,6 +3035,7 @@ impl PycodestyleOptions { } } +/// Options for the `pydocstyle` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2763,6 +3114,16 @@ pub struct PydocstyleOptions { "# )] pub property_decorators: Option<Vec<String>>, + + /// If set to `true`, ignore missing documentation for `*args` and `**kwargs` parameters. + #[option( + default = r#"false"#, + value_type = "bool", + example = r#" + ignore-var-parameters = true + "# + )] + pub ignore_var_parameters: Option<bool>, } impl PydocstyleOptions { @@ -2771,15 +3132,48 @@ impl PydocstyleOptions { convention, ignore_decorators, property_decorators, + ignore_var_parameters: ignore_variadics, } = self; - pydocstyle::settings::Settings::new( + pydocstyle::settings::Settings { convention, - ignore_decorators.unwrap_or_default(), - property_decorators.unwrap_or_default(), - ) + ignore_decorators: BTreeSet::from_iter(ignore_decorators.unwrap_or_default()), + property_decorators: BTreeSet::from_iter(property_decorators.unwrap_or_default()), + ignore_var_parameters: ignore_variadics.unwrap_or_default(), + } } } +/// Options for the `pydoclint` plugin. +#[derive( + Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, +)] +#[serde(deny_unknown_fields, rename_all = "kebab-case")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct PydoclintOptions { + /// Skip docstrings which fit on a single line. + /// + /// Note: The corresponding setting in `pydoclint` + /// is named `skip-checking-short-docstrings`. + #[option( + default = r#"false"#, + value_type = "bool", + example = r#" + # Skip docstrings which fit on a single line. + ignore-one-line-docstrings = true + "# + )] + pub ignore_one_line_docstrings: Option<bool>, +} + +impl PydoclintOptions { + pub fn into_settings(self) -> pydoclint::settings::Settings { + pydoclint::settings::Settings { + ignore_one_line_docstrings: self.ignore_one_line_docstrings.unwrap_or_default(), + } + } +} + +/// Options for the `pyflakes` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2824,6 +3218,7 @@ impl PyflakesOptions { } } +/// Options for the `pylint` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2933,6 +3328,7 @@ impl PylintOptions { } } +/// Options for the `pyupgrade` plugin. #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -2988,6 +3384,7 @@ impl PyUpgradeOptions { } } +/// Options for the `ruff` plugin #[derive( Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize, OptionsMetadata, CombineOptions, )] @@ -3005,6 +3402,58 @@ pub struct RuffOptions { "# )] pub parenthesize_tuple_in_subscript: Option<bool>, + + /// A list of additional callable names that behave like + /// [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup). + /// + /// Expects to receive a list of fully-qualified names (e.g., `webhelpers.html.literal`, rather than + /// `literal`). + #[option( + default = "[]", + value_type = "list[str]", + example = "extend-markup-names = [\"webhelpers.html.literal\", \"my_package.Markup\"]" + )] + #[deprecated( + since = "0.10.0", + note = "The `extend-markup-names` option has been moved to the `flake8-bandit` section of the configuration." + )] + pub extend_markup_names: Option<Vec<String>>, + + /// A list of callable names, whose result may be safely passed into + /// [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup). + /// + /// Expects to receive a list of fully-qualified names (e.g., `bleach.clean`, rather than `clean`). + /// + /// This setting helps you avoid false positives in code like: + /// + /// ```python + /// from bleach import clean + /// from markupsafe import Markup + /// + /// cleaned_markup = Markup(clean(some_user_input)) + /// ``` + /// + /// Where the use of [`bleach.clean`](https://bleach.readthedocs.io/en/latest/clean.html) + /// usually ensures that there's no XSS vulnerability. + /// + /// Although it is not recommended, you may also use this setting to whitelist other + /// kinds of calls, e.g. calls to i18n translation functions, where how safe that is + /// will depend on the implementation and how well the translations are audited. + /// + /// Another common use-case is to wrap the output of functions that generate markup + /// like [`xml.etree.ElementTree.tostring`](https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring) + /// or template rendering engines where sanitization of potential user input is either + /// already baked in or has to happen before rendering. + #[option( + default = "[]", + value_type = "list[str]", + example = "allowed-markup-calls = [\"bleach.clean\", \"my_package.sanitize\"]" + )] + #[deprecated( + since = "0.10.0", + note = "The `allowed-markup-names` option has been moved to the `flake8-bandit` section of the configuration." + )] + pub allowed_markup_calls: Option<Vec<String>>, } impl RuffOptions { @@ -3375,20 +3824,192 @@ pub struct AnalyzeOptions { "# )] pub detect_string_imports: Option<bool>, - /// A map from file path to the list of file paths or globs that should be considered - /// dependencies of that file, regardless of whether relevant imports are detected. + /// A map from file path to the list of Python or non-Python file paths or globs that should be + /// considered dependencies of that file, regardless of whether relevant imports are detected. #[option( default = "{}", + scope = "include-dependencies", value_type = "dict[str, list[str]]", example = r#" - include-dependencies = { - "foo/bar.py": ["foo/baz/*.py"], - } + "foo/bar.py" = ["foo/baz/*.py"] + "foo/baz/reader.py" = ["configs/bar.json"] "# )] pub include_dependencies: Option<BTreeMap<PathBuf, Vec<String>>>, } +/// Like [`LintCommonOptions`], but with any `#[serde(flatten)]` fields inlined. This leads to far, +/// far better error messages when deserializing. +#[derive(Debug, Clone, Default, Deserialize)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +pub struct LintOptionsWire { + // common: LintCommonOptions + allowed_confusables: Option<Vec<char>>, + dummy_variable_rgx: Option<String>, + extend_ignore: Option<Vec<RuleSelector>>, + extend_select: Option<Vec<RuleSelector>>, + extend_fixable: Option<Vec<RuleSelector>>, + extend_unfixable: Option<Vec<RuleSelector>>, + external: Option<Vec<String>>, + fixable: Option<Vec<RuleSelector>>, + ignore: Option<Vec<RuleSelector>>, + extend_safe_fixes: Option<Vec<RuleSelector>>, + extend_unsafe_fixes: Option<Vec<RuleSelector>>, + ignore_init_module_imports: Option<bool>, + logger_objects: Option<Vec<String>>, + select: Option<Vec<RuleSelector>>, + explicit_preview_rules: Option<bool>, + task_tags: Option<Vec<String>>, + typing_modules: Option<Vec<String>>, + unfixable: Option<Vec<RuleSelector>>, + flake8_annotations: Option<Flake8AnnotationsOptions>, + flake8_bandit: Option<Flake8BanditOptions>, + flake8_boolean_trap: Option<Flake8BooleanTrapOptions>, + flake8_bugbear: Option<Flake8BugbearOptions>, + flake8_builtins: Option<Flake8BuiltinsOptions>, + flake8_comprehensions: Option<Flake8ComprehensionsOptions>, + flake8_copyright: Option<Flake8CopyrightOptions>, + flake8_errmsg: Option<Flake8ErrMsgOptions>, + flake8_quotes: Option<Flake8QuotesOptions>, + flake8_self: Option<Flake8SelfOptions>, + flake8_tidy_imports: Option<Flake8TidyImportsOptions>, + flake8_type_checking: Option<Flake8TypeCheckingOptions>, + flake8_gettext: Option<Flake8GetTextOptions>, + flake8_implicit_str_concat: Option<Flake8ImplicitStrConcatOptions>, + flake8_import_conventions: Option<Flake8ImportConventionsOptions>, + flake8_pytest_style: Option<Flake8PytestStyleOptions>, + flake8_unused_arguments: Option<Flake8UnusedArgumentsOptions>, + isort: Option<IsortOptions>, + mccabe: Option<McCabeOptions>, + pep8_naming: Option<Pep8NamingOptions>, + pycodestyle: Option<PycodestyleOptions>, + pydocstyle: Option<PydocstyleOptions>, + pyflakes: Option<PyflakesOptions>, + pylint: Option<PylintOptions>, + pyupgrade: Option<PyUpgradeOptions>, + per_file_ignores: Option<FxHashMap<String, Vec<RuleSelector>>>, + extend_per_file_ignores: Option<FxHashMap<String, Vec<RuleSelector>>>, + + exclude: Option<Vec<String>>, + pydoclint: Option<PydoclintOptions>, + ruff: Option<RuffOptions>, + preview: Option<bool>, + typing_extensions: Option<bool>, +} + +impl From<LintOptionsWire> for LintOptions { + fn from(value: LintOptionsWire) -> LintOptions { + let LintOptionsWire { + allowed_confusables, + dummy_variable_rgx, + extend_ignore, + extend_select, + extend_fixable, + extend_unfixable, + external, + fixable, + ignore, + extend_safe_fixes, + extend_unsafe_fixes, + ignore_init_module_imports, + logger_objects, + select, + explicit_preview_rules, + task_tags, + typing_modules, + unfixable, + flake8_annotations, + flake8_bandit, + flake8_boolean_trap, + flake8_bugbear, + flake8_builtins, + flake8_comprehensions, + flake8_copyright, + flake8_errmsg, + flake8_quotes, + flake8_self, + flake8_tidy_imports, + flake8_type_checking, + flake8_gettext, + flake8_implicit_str_concat, + flake8_import_conventions, + flake8_pytest_style, + flake8_unused_arguments, + isort, + mccabe, + pep8_naming, + pycodestyle, + pydocstyle, + pyflakes, + pylint, + pyupgrade, + per_file_ignores, + extend_per_file_ignores, + exclude, + pydoclint, + ruff, + preview, + typing_extensions, + } = value; + + LintOptions { + #[expect(deprecated)] + common: LintCommonOptions { + allowed_confusables, + dummy_variable_rgx, + extend_ignore, + extend_select, + extend_fixable, + extend_unfixable, + external, + fixable, + ignore, + extend_safe_fixes, + extend_unsafe_fixes, + ignore_init_module_imports, + logger_objects, + select, + explicit_preview_rules, + task_tags, + typing_modules, + unfixable, + flake8_annotations, + flake8_bandit, + flake8_boolean_trap, + flake8_bugbear, + flake8_builtins, + flake8_comprehensions, + flake8_copyright, + flake8_errmsg, + flake8_quotes, + flake8_self, + flake8_tidy_imports, + flake8_type_checking, + flake8_gettext, + flake8_implicit_str_concat, + flake8_import_conventions, + flake8_pytest_style, + flake8_unused_arguments, + isort, + mccabe, + pep8_naming, + pycodestyle, + pydocstyle, + pyflakes, + pylint, + pyupgrade, + per_file_ignores, + extend_per_file_ignores, + }, + exclude, + pydoclint, + ruff, + preview, + typing_extensions, + } + } +} + #[cfg(test)] mod tests { use crate::options::Flake8SelfOptions; diff --git a/crates/ruff_workspace/src/options_base.rs b/crates/ruff_workspace/src/options_base.rs deleted file mode 100644 index 7b2c2d405e3e5..0000000000000 --- a/crates/ruff_workspace/src/options_base.rs +++ /dev/null @@ -1,418 +0,0 @@ -use serde::{Serialize, Serializer}; -use std::collections::BTreeMap; - -use std::fmt::{Debug, Display, Formatter}; - -/// Visits [`OptionsMetadata`]. -/// -/// An instance of [`Visit`] represents the logic for inspecting an object's options metadata. -pub trait Visit { - /// Visits an [`OptionField`] value named `name`. - fn record_field(&mut self, name: &str, field: OptionField); - - /// Visits an [`OptionSet`] value named `name`. - fn record_set(&mut self, name: &str, group: OptionSet); -} - -/// Returns metadata for its options. -pub trait OptionsMetadata { - /// Visits the options metadata of this object by calling `visit` for each option. - fn record(visit: &mut dyn Visit); - - fn documentation() -> Option<&'static str> { - None - } - - /// Returns the extracted metadata. - fn metadata() -> OptionSet - where - Self: Sized + 'static, - { - OptionSet::of::<Self>() - } -} - -impl<T> OptionsMetadata for Option<T> -where - T: OptionsMetadata, -{ - fn record(visit: &mut dyn Visit) { - T::record(visit); - } -} - -/// Metadata of an option that can either be a [`OptionField`] or [`OptionSet`]. -#[derive(Clone, PartialEq, Eq, Debug, Serialize)] -#[serde(untagged)] -pub enum OptionEntry { - /// A single option. - Field(OptionField), - - /// A set of options. - Set(OptionSet), -} - -impl Display for OptionEntry { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - match self { - OptionEntry::Set(set) => std::fmt::Display::fmt(set, f), - OptionEntry::Field(field) => std::fmt::Display::fmt(&field, f), - } - } -} - -/// A set of options. -/// -/// It extracts the options by calling the [`OptionsMetadata::record`] of a type implementing -/// [`OptionsMetadata`]. -#[derive(Copy, Clone, Eq, PartialEq)] -pub struct OptionSet { - record: fn(&mut dyn Visit), - doc: fn() -> Option<&'static str>, -} - -impl OptionSet { - pub fn of<T>() -> Self - where - T: OptionsMetadata + 'static, - { - Self { - record: T::record, - doc: T::documentation, - } - } - - /// Visits the options in this set by calling `visit` for each option. - pub fn record(&self, visit: &mut dyn Visit) { - let record = self.record; - record(visit); - } - - pub fn documentation(&self) -> Option<&'static str> { - let documentation = self.doc; - documentation() - } - - /// Returns `true` if this set has an option that resolves to `name`. - /// - /// The name can be separated by `.` to find a nested option. - /// - /// ## Examples - /// - /// ### Test for the existence of a child option - /// - /// ```rust - /// # use ruff_workspace::options_base::{OptionField, OptionsMetadata, Visit}; - /// - /// struct WithOptions; - /// - /// impl OptionsMetadata for WithOptions { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("ignore-git-ignore", OptionField { - /// doc: "Whether Ruff should respect the gitignore file", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None, - /// }); - /// } - /// } - /// - /// assert!(WithOptions::metadata().has("ignore-git-ignore")); - /// assert!(!WithOptions::metadata().has("does-not-exist")); - /// ``` - /// ### Test for the existence of a nested option - /// - /// ```rust - /// # use ruff_workspace::options_base::{OptionField, OptionsMetadata, Visit}; - /// - /// struct Root; - /// - /// impl OptionsMetadata for Root { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("ignore-git-ignore", OptionField { - /// doc: "Whether Ruff should respect the gitignore file", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None - /// }); - /// - /// visit.record_set("format", Nested::metadata()); - /// } - /// } - /// - /// struct Nested; - /// - /// impl OptionsMetadata for Nested { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("hard-tabs", OptionField { - /// doc: "Use hard tabs for indentation and spaces for alignment.", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None - /// }); - /// } - /// } - /// - /// assert!(Root::metadata().has("format.hard-tabs")); - /// assert!(!Root::metadata().has("format.spaces")); - /// assert!(!Root::metadata().has("lint.hard-tabs")); - /// ``` - pub fn has(&self, name: &str) -> bool { - self.find(name).is_some() - } - - /// Returns `Some` if this set has an option that resolves to `name` and `None` otherwise. - /// - /// The name can be separated by `.` to find a nested option. - /// - /// ## Examples - /// - /// ### Find a child option - /// - /// ```rust - /// # use ruff_workspace::options_base::{OptionEntry, OptionField, OptionsMetadata, Visit}; - /// - /// struct WithOptions; - /// - /// static IGNORE_GIT_IGNORE: OptionField = OptionField { - /// doc: "Whether Ruff should respect the gitignore file", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None - /// }; - /// - /// impl OptionsMetadata for WithOptions { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("ignore-git-ignore", IGNORE_GIT_IGNORE.clone()); - /// } - /// } - /// - /// assert_eq!(WithOptions::metadata().find("ignore-git-ignore"), Some(OptionEntry::Field(IGNORE_GIT_IGNORE.clone()))); - /// assert_eq!(WithOptions::metadata().find("does-not-exist"), None); - /// ``` - /// ### Find a nested option - /// - /// ```rust - /// # use ruff_workspace::options_base::{OptionEntry, OptionField, OptionsMetadata, Visit}; - /// - /// static HARD_TABS: OptionField = OptionField { - /// doc: "Use hard tabs for indentation and spaces for alignment.", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None - /// }; - /// - /// struct Root; - /// - /// impl OptionsMetadata for Root { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("ignore-git-ignore", OptionField { - /// doc: "Whether Ruff should respect the gitignore file", - /// default: "false", - /// value_type: "bool", - /// example: "", - /// scope: None, - /// deprecated: None - /// }); - /// - /// visit.record_set("format", Nested::metadata()); - /// } - /// } - /// - /// struct Nested; - /// - /// impl OptionsMetadata for Nested { - /// fn record(visit: &mut dyn Visit) { - /// visit.record_field("hard-tabs", HARD_TABS.clone()); - /// } - /// } - /// - /// assert_eq!(Root::metadata().find("format.hard-tabs"), Some(OptionEntry::Field(HARD_TABS.clone()))); - /// assert_eq!(Root::metadata().find("format"), Some(OptionEntry::Set(Nested::metadata()))); - /// assert_eq!(Root::metadata().find("format.spaces"), None); - /// assert_eq!(Root::metadata().find("lint.hard-tabs"), None); - /// ``` - pub fn find(&self, name: &str) -> Option<OptionEntry> { - struct FindOptionVisitor<'a> { - option: Option<OptionEntry>, - parts: std::str::Split<'a, char>, - needle: &'a str, - } - - impl Visit for FindOptionVisitor<'_> { - fn record_set(&mut self, name: &str, set: OptionSet) { - if self.option.is_none() && name == self.needle { - if let Some(next) = self.parts.next() { - self.needle = next; - set.record(self); - } else { - self.option = Some(OptionEntry::Set(set)); - } - } - } - - fn record_field(&mut self, name: &str, field: OptionField) { - if self.option.is_none() && name == self.needle { - if self.parts.next().is_none() { - self.option = Some(OptionEntry::Field(field)); - } - } - } - } - - let mut parts = name.split('.'); - - if let Some(first) = parts.next() { - let mut visitor = FindOptionVisitor { - parts, - needle: first, - option: None, - }; - - self.record(&mut visitor); - visitor.option - } else { - None - } - } -} - -/// Visitor that writes out the names of all fields and sets. -struct DisplayVisitor<'fmt, 'buf> { - f: &'fmt mut Formatter<'buf>, - result: std::fmt::Result, -} - -impl<'fmt, 'buf> DisplayVisitor<'fmt, 'buf> { - fn new(f: &'fmt mut Formatter<'buf>) -> Self { - Self { f, result: Ok(()) } - } - - fn finish(self) -> std::fmt::Result { - self.result - } -} - -impl Visit for DisplayVisitor<'_, '_> { - fn record_set(&mut self, name: &str, _: OptionSet) { - self.result = self.result.and_then(|()| writeln!(self.f, "{name}")); - } - - fn record_field(&mut self, name: &str, field: OptionField) { - self.result = self.result.and_then(|()| { - write!(self.f, "{name}")?; - - if field.deprecated.is_some() { - write!(self.f, " (deprecated)")?; - } - - writeln!(self.f) - }); - } -} - -impl Display for OptionSet { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - let mut visitor = DisplayVisitor::new(f); - self.record(&mut visitor); - visitor.finish() - } -} - -struct SerializeVisitor<'a> { - entries: &'a mut BTreeMap<String, OptionField>, -} - -impl<'a> Visit for SerializeVisitor<'a> { - fn record_set(&mut self, name: &str, set: OptionSet) { - // Collect the entries of the set. - let mut entries = BTreeMap::new(); - let mut visitor = SerializeVisitor { - entries: &mut entries, - }; - set.record(&mut visitor); - - // Insert the set into the entries. - for (key, value) in entries { - self.entries.insert(format!("{name}.{key}"), value); - } - } - - fn record_field(&mut self, name: &str, field: OptionField) { - self.entries.insert(name.to_string(), field); - } -} - -impl Serialize for OptionSet { - fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> - where - S: Serializer, - { - let mut entries = BTreeMap::new(); - let mut visitor = SerializeVisitor { - entries: &mut entries, - }; - self.record(&mut visitor); - entries.serialize(serializer) - } -} - -impl Debug for OptionSet { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - Display::fmt(self, f) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Serialize)] -pub struct OptionField { - pub doc: &'static str, - /// Ex) `"false"` - pub default: &'static str, - /// Ex) `"bool"` - pub value_type: &'static str, - /// Ex) `"per-file-ignores"` - pub scope: Option<&'static str>, - pub example: &'static str, - pub deprecated: Option<Deprecated>, -} - -#[derive(Debug, Clone, Eq, PartialEq, Serialize)] -pub struct Deprecated { - pub since: Option<&'static str>, - pub message: Option<&'static str>, -} - -impl Display for OptionField { - fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - writeln!(f, "{}", self.doc)?; - writeln!(f)?; - writeln!(f, "Default value: {}", self.default)?; - writeln!(f, "Type: {}", self.value_type)?; - - if let Some(deprecated) = &self.deprecated { - write!(f, "Deprecated")?; - - if let Some(since) = deprecated.since { - write!(f, " (since {since})")?; - } - - if let Some(message) = deprecated.message { - write!(f, ": {message}")?; - } - - writeln!(f)?; - } - - writeln!(f, "Example usage:\n```toml\n{}\n```", self.example) - } -} diff --git a/crates/ruff_workspace/src/pyproject.rs b/crates/ruff_workspace/src/pyproject.rs index 6c3bc74c4bb9c..f849487aa55ca 100644 --- a/crates/ruff_workspace/src/pyproject.rs +++ b/crates/ruff_workspace/src/pyproject.rs @@ -4,8 +4,9 @@ use std::path::{Path, PathBuf}; use anyhow::{Context, Result}; use log::debug; -use pep440_rs::VersionSpecifiers; +use pep440_rs::{Operator, Version, VersionSpecifiers}; use serde::{Deserialize, Serialize}; +use strum::IntoEnumIterator; use ruff_linter::settings::types::PythonVersion; @@ -41,18 +42,18 @@ impl Pyproject { /// Parse a `ruff.toml` file. fn parse_ruff_toml<P: AsRef<Path>>(path: P) -> Result<Options> { - let contents = std::fs::read_to_string(path.as_ref()) - .with_context(|| format!("Failed to read {}", path.as_ref().display()))?; - toml::from_str(&contents) - .with_context(|| format!("Failed to parse {}", path.as_ref().display())) + let path = path.as_ref(); + let contents = std::fs::read_to_string(path) + .with_context(|| format!("Failed to read {}", path.display()))?; + toml::from_str(&contents).with_context(|| format!("Failed to parse {}", path.display())) } /// Parse a `pyproject.toml` file. fn parse_pyproject_toml<P: AsRef<Path>>(path: P) -> Result<Pyproject> { - let contents = std::fs::read_to_string(path.as_ref()) - .with_context(|| format!("Failed to read {}", path.as_ref().display()))?; - toml::from_str(&contents) - .with_context(|| format!("Failed to parse {}", path.as_ref().display())) + let path = path.as_ref(); + let contents = std::fs::read_to_string(path) + .with_context(|| format!("Failed to read {}", path.display()))?; + toml::from_str(&contents).with_context(|| format!("Failed to parse {}", path.display())) } /// Return `true` if a `pyproject.toml` contains a `[tool.ruff]` section. @@ -64,20 +65,21 @@ pub fn ruff_enabled<P: AsRef<Path>>(path: P) -> Result<bool> { /// Return the path to the `pyproject.toml` or `ruff.toml` file in a given /// directory. pub fn settings_toml<P: AsRef<Path>>(path: P) -> Result<Option<PathBuf>> { + let path = path.as_ref(); // Check for `.ruff.toml`. - let ruff_toml = path.as_ref().join(".ruff.toml"); + let ruff_toml = path.join(".ruff.toml"); if ruff_toml.is_file() { return Ok(Some(ruff_toml)); } // Check for `ruff.toml`. - let ruff_toml = path.as_ref().join("ruff.toml"); + let ruff_toml = path.join("ruff.toml"); if ruff_toml.is_file() { return Ok(Some(ruff_toml)); } // Check for `pyproject.toml`. - let pyproject_toml = path.as_ref().join("pyproject.toml"); + let pyproject_toml = path.join("pyproject.toml"); if pyproject_toml.is_file() && ruff_enabled(&pyproject_toml)? { return Ok(Some(pyproject_toml)); } @@ -96,6 +98,17 @@ pub fn find_settings_toml<P: AsRef<Path>>(path: P) -> Result<Option<PathBuf>> { Ok(None) } +/// Derive target version from `required-version` in `pyproject.toml`, if +/// such a file exists in an ancestor directory. +pub fn find_fallback_target_version<P: AsRef<Path>>(path: P) -> Option<PythonVersion> { + for directory in path.as_ref().ancestors() { + if let Some(fallback) = get_fallback_target_version(directory) { + return Some(fallback); + } + } + None +} + /// Find the path to the user-specific `pyproject.toml` or `ruff.toml`, if it /// exists. #[cfg(not(target_arch = "wasm32"))] @@ -140,9 +153,13 @@ pub fn find_user_settings_toml() -> Option<PathBuf> { } /// Load `Options` from a `pyproject.toml` or `ruff.toml` file. -pub(super) fn load_options<P: AsRef<Path>>(path: P) -> Result<Options> { - if path.as_ref().ends_with("pyproject.toml") { - let pyproject = parse_pyproject_toml(&path)?; +pub(super) fn load_options<P: AsRef<Path>>( + path: P, + version_strategy: &TargetVersionStrategy, +) -> Result<Options> { + let path = path.as_ref(); + if path.ends_with("pyproject.toml") { + let pyproject = parse_pyproject_toml(path)?; let mut ruff = pyproject .tool .and_then(|tool| tool.ruff) @@ -150,23 +167,106 @@ pub(super) fn load_options<P: AsRef<Path>>(path: P) -> Result<Options> { if ruff.target_version.is_none() { if let Some(project) = pyproject.project { if let Some(requires_python) = project.requires_python { - ruff.target_version = - PythonVersion::get_minimum_supported_version(&requires_python); + ruff.target_version = get_minimum_supported_version(&requires_python); } } } Ok(ruff) } else { - let ruff = parse_ruff_toml(path); - if let Ok(ruff) = &ruff { + let mut ruff = parse_ruff_toml(path); + if let Ok(ref mut ruff) = ruff { if ruff.target_version.is_none() { - debug!("`project.requires_python` in `pyproject.toml` will not be used to set `target_version` when using `ruff.toml`."); + debug!("No `target-version` found in `ruff.toml`"); + match version_strategy { + TargetVersionStrategy::UseDefault => {} + TargetVersionStrategy::RequiresPythonFallback => { + if let Some(dir) = path.parent() { + let fallback = get_fallback_target_version(dir); + if let Some(version) = fallback { + debug!( + "Derived `target-version` from `requires-python` in `pyproject.toml`: {version:?}" + ); + } else { + debug!( + "No `pyproject.toml` with `requires-python` in same directory; `target-version` unspecified" + ); + } + ruff.target_version = fallback; + } + } + } } } ruff } } +/// Extract `target-version` from `pyproject.toml` in the given directory +/// if the file exists and has `requires-python`. +fn get_fallback_target_version(dir: &Path) -> Option<PythonVersion> { + let pyproject_path = dir.join("pyproject.toml"); + if !pyproject_path.exists() { + return None; + } + let parsed_pyproject = parse_pyproject_toml(&pyproject_path); + + let pyproject = match parsed_pyproject { + Ok(pyproject) => pyproject, + Err(err) => { + debug!("Failed to find fallback `target-version` due to: {err}"); + return None; + } + }; + + if let Some(project) = pyproject.project { + if let Some(requires_python) = project.requires_python { + return get_minimum_supported_version(&requires_python); + } + } + None +} + +/// Infer the minimum supported [`PythonVersion`] from a `requires-python` specifier. +fn get_minimum_supported_version(requires_version: &VersionSpecifiers) -> Option<PythonVersion> { + /// Truncate a version to its major and minor components. + fn major_minor(version: &Version) -> Option<Version> { + let major = version.release().first()?; + let minor = version.release().get(1)?; + Some(Version::new([major, minor])) + } + + // Extract the minimum supported version from the specifiers. + let minimum_version = requires_version + .iter() + .filter(|specifier| { + matches!( + specifier.operator(), + Operator::Equal + | Operator::EqualStar + | Operator::ExactEqual + | Operator::TildeEqual + | Operator::GreaterThan + | Operator::GreaterThanEqual + ) + }) + .filter_map(|specifier| major_minor(specifier.version())) + .min()?; + + debug!("Detected minimum supported `requires-python` version: {minimum_version}"); + + // Find the Python version that matches the minimum supported version. + PythonVersion::iter().find(|version| Version::from(*version) == minimum_version) +} + +/// Strategy for handling missing `target-version` in configuration. +#[derive(Debug)] +pub(super) enum TargetVersionStrategy { + /// Use default `target-version` + UseDefault, + /// Derive from `requires-python` if available + RequiresPythonFallback, +} + #[cfg(test)] mod tests { use std::fs; @@ -180,8 +280,8 @@ mod tests { use ruff_linter::line_width::LineLength; use ruff_linter::settings::types::PatternPrefixPair; - use crate::options::{LintCommonOptions, LintOptions, Options}; - use crate::pyproject::{find_settings_toml, parse_pyproject_toml, Pyproject, Tools}; + use crate::options::{Flake8BuiltinsOptions, LintCommonOptions, LintOptions, Options}; + use crate::pyproject::{Pyproject, Tools, find_settings_toml, parse_pyproject_toml}; #[test] @@ -291,33 +391,88 @@ ignore = ["E501"] }) ); - assert!(toml::from_str::<Pyproject>( - r" + let pyproject: Pyproject = toml::from_str( + r#" +[tool.ruff.lint.flake8-builtins] +builtins-allowed-modules = ["asyncio"] +builtins-ignorelist = ["argparse", 'typing'] +builtins-strict-checking = true +allowed-modules = ['sys'] +ignorelist = ["os", 'io'] +strict-checking = false +"#, + )?; + + #[expect(deprecated)] + let expected = Flake8BuiltinsOptions { + builtins_allowed_modules: Some(vec!["asyncio".to_string()]), + allowed_modules: Some(vec!["sys".to_string()]), + + builtins_ignorelist: Some(vec!["argparse".to_string(), "typing".to_string()]), + ignorelist: Some(vec!["os".to_string(), "io".to_string()]), + + builtins_strict_checking: Some(true), + strict_checking: Some(false), + }; + + assert_eq!( + pyproject.tool, + Some(Tools { + ruff: Some(Options { + lint: Some(LintOptions { + common: LintCommonOptions { + flake8_builtins: Some(expected.clone()), + ..LintCommonOptions::default() + }, + ..LintOptions::default() + }), + ..Options::default() + }) + }) + ); + + let settings = expected.into_settings(); + + assert_eq!(settings.allowed_modules, vec!["sys".to_string()]); + assert_eq!( + settings.ignorelist, + vec!["os".to_string(), "io".to_string()] + ); + assert!(!settings.strict_checking); + + assert!( + toml::from_str::<Pyproject>( + r" [tool.black] [tool.ruff] line_length = 79 ", - ) - .is_err()); + ) + .is_err() + ); - assert!(toml::from_str::<Pyproject>( - r#" + assert!( + toml::from_str::<Pyproject>( + r#" [tool.black] [tool.ruff.lint] select = ["E123"] "#, - ) - .is_err()); + ) + .is_err() + ); - assert!(toml::from_str::<Pyproject>( - r" + assert!( + toml::from_str::<Pyproject>( + r" [tool.black] [tool.ruff] line-length = 79 other-attribute = 1 ", - ) - .is_err()); + ) + .is_err() + ); Ok(()) } diff --git a/crates/ruff_workspace/src/resolver.rs b/crates/ruff_workspace/src/resolver.rs index ae9f46f1a97b8..84a31ebbeea4f 100644 --- a/crates/ruff_workspace/src/resolver.rs +++ b/crates/ruff_workspace/src/resolver.rs @@ -2,11 +2,12 @@ //! filesystem. use std::cmp::Ordering; +use std::collections::BTreeSet; use std::ffi::OsStr; use std::path::{Path, PathBuf}; use std::sync::RwLock; -use anyhow::Result; +use anyhow::{Context, Result}; use anyhow::{anyhow, bail}; use globset::{Candidate, GlobSet}; use ignore::{DirEntry, Error, ParallelVisitor, WalkBuilder, WalkState}; @@ -18,12 +19,13 @@ use path_slash::PathExt; use rustc_hash::{FxHashMap, FxHashSet}; use ruff_linter::fs; +use ruff_linter::package::PackageRoot; use ruff_linter::packaging::is_package; use crate::configuration::Configuration; -use crate::pyproject; -use crate::pyproject::settings_toml; +use crate::pyproject::{TargetVersionStrategy, settings_toml}; use crate::settings::Settings; +use crate::{FileResolverSettings, pyproject}; /// The configuration information from a `pyproject.toml` file. #[derive(Debug)] @@ -147,8 +149,8 @@ impl<'a> Resolver<'a> { fn add(&mut self, path: &Path, settings: Settings) { self.settings.push(settings); - // normalize the path to use `/` separators and escape the '{' and '}' characters, - // which matchit uses for routing parameters + // Normalize the path to use `/` separators and escape the '{' and '}' characters, + // which matchit uses for routing parameters. let path = path.to_slash_lossy().replace('{', "{{").replace('}', "}}"); match self @@ -181,7 +183,10 @@ impl<'a> Resolver<'a> { } /// Return a mapping from Python package to its package root. - pub fn package_roots(&'a self, files: &[&'a Path]) -> FxHashMap<&'a Path, Option<&'a Path>> { + pub fn package_roots( + &'a self, + files: &[&'a Path], + ) -> FxHashMap<&'a Path, Option<PackageRoot<'a>>> { // Pre-populate the module cache, since the list of files could (but isn't // required to) contain some `__init__.py` files. let mut package_cache: FxHashMap<&Path, bool> = FxHashMap::default(); @@ -200,7 +205,7 @@ impl<'a> Resolver<'a> { .any(|settings| !settings.linter.namespace_packages.is_empty()); // Search for the package root for each file. - let mut package_roots: FxHashMap<&Path, Option<&Path>> = FxHashMap::default(); + let mut package_roots: FxHashMap<&Path, Option<PackageRoot<'_>>> = FxHashMap::default(); for file in files { if let Some(package) = file.parent() { package_roots.entry(package).or_insert_with(|| { @@ -210,10 +215,41 @@ impl<'a> Resolver<'a> { &[] }; detect_package_root_with_cache(package, namespace_packages, &mut package_cache) + .map(|path| PackageRoot::Root { path }) }); } } + // Discard any nested roots. + // + // For example, if `./foo/__init__.py` is a root, and then `./foo/bar` is empty, and + // `./foo/bar/baz/__init__.py` was detected as a root, we should only consider + // `./foo/__init__.py`. + let mut non_roots = FxHashSet::default(); + let mut router: Router<&Path> = Router::new(); + for root in package_roots + .values() + .flatten() + .copied() + .map(PackageRoot::path) + .collect::<BTreeSet<_>>() + { + // Normalize the path to use `/` separators and escape the '{' and '}' characters, + // which matchit uses for routing parameters. + let path = root.to_slash_lossy().replace('{', "{{").replace('}', "}}"); + if let Ok(matched) = router.at_mut(&path) { + debug!( + "Ignoring nested package root: {} (under {})", + root.display(), + matched.value.display() + ); + package_roots.insert(root, Some(PackageRoot::nested(root))); + non_roots.insert(root); + } else { + let _ = router.insert(format!("{path}/{{*filepath}}"), root); + } + } + package_roots } @@ -265,19 +301,55 @@ pub trait ConfigurationTransformer { // resolving the "default" configuration). pub fn resolve_configuration( pyproject: &Path, - relativity: Relativity, transformer: &dyn ConfigurationTransformer, + origin: ConfigurationOrigin, ) -> Result<Configuration> { - let mut seen = FxHashSet::default(); - let mut stack = vec![]; + let relativity = Relativity::from(origin); + let mut configurations = indexmap::IndexMap::new(); let mut next = Some(fs::normalize_path(pyproject)); while let Some(path) = next { - if seen.contains(&path) { - bail!("Circular dependency detected in pyproject.toml"); + if configurations.contains_key(&path) { + bail!(format!( + "Circular configuration detected: {chain}", + chain = configurations + .keys() + .chain([&path]) + .map(|p| format!("`{}`", p.display())) + .join(" extends "), + )); } // Resolve the current path. - let options = pyproject::load_options(&path)?; + let version_strategy = + if configurations.is_empty() && matches!(origin, ConfigurationOrigin::Ancestor) { + // For configurations that are discovered by + // walking back from a file, we will attempt to + // infer the `target-version` if it is missing + TargetVersionStrategy::RequiresPythonFallback + } else { + // In all other cases (e.g. for configurations + // inherited via `extend`, or user-level settings) + // we do not attempt to infer a missing `target-version` + TargetVersionStrategy::UseDefault + }; + let options = pyproject::load_options(&path, &version_strategy).with_context(|| { + if configurations.is_empty() { + format!( + "Failed to load configuration `{path}`", + path = path.display() + ) + } else { + let chain = configurations + .keys() + .chain([&path]) + .map(|p| format!("`{}`", p.display())) + .join(" extends "); + format!( + "Failed to load extended configuration `{path}` ({chain})", + path = path.display() + ) + } + })?; let project_root = relativity.resolve(&path); let configuration = Configuration::from_options(options, Some(&path), project_root)?; @@ -293,14 +365,13 @@ pub fn resolve_configuration( // Keep track of (1) the paths we've already resolved (to avoid cycles), and (2) // the base configuration for every path. - seen.insert(path); - stack.push(configuration); + configurations.insert(path, configuration); } // Merge the configurations, in order. - stack.reverse(); - let mut configuration = stack.pop().unwrap(); - while let Some(extend) = stack.pop() { + let mut configurations = configurations.into_values(); + let mut configuration = configurations.next().unwrap(); + for extend in configurations { configuration = configuration.combine(extend); } Ok(transformer.transform(configuration)) @@ -310,10 +381,12 @@ pub fn resolve_configuration( /// `pyproject.toml`. fn resolve_scoped_settings<'a>( pyproject: &'a Path, - relativity: Relativity, transformer: &dyn ConfigurationTransformer, + origin: ConfigurationOrigin, ) -> Result<(&'a Path, Settings)> { - let configuration = resolve_configuration(pyproject, relativity, transformer)?; + let relativity = Relativity::from(origin); + + let configuration = resolve_configuration(pyproject, transformer, origin)?; let project_root = relativity.resolve(pyproject); let settings = configuration.into_settings(project_root)?; Ok((project_root, settings)) @@ -323,13 +396,37 @@ fn resolve_scoped_settings<'a>( /// configuration with the given [`ConfigurationTransformer`]. pub fn resolve_root_settings( pyproject: &Path, - relativity: Relativity, transformer: &dyn ConfigurationTransformer, + origin: ConfigurationOrigin, ) -> Result<Settings> { - let (_project_root, settings) = resolve_scoped_settings(pyproject, relativity, transformer)?; + let (_project_root, settings) = resolve_scoped_settings(pyproject, transformer, origin)?; Ok(settings) } +#[derive(Debug, Clone, Copy)] +/// How the configuration is provided. +pub enum ConfigurationOrigin { + /// Origin is unknown to the caller + Unknown, + /// User specified path to specific configuration file + UserSpecified, + /// User-level configuration (e.g. in `~/.config/ruff/pyproject.toml`) + UserSettings, + /// In parent or higher ancestor directory of path + Ancestor, +} + +impl From<ConfigurationOrigin> for Relativity { + fn from(value: ConfigurationOrigin) -> Self { + match value { + ConfigurationOrigin::Unknown => Self::Parent, + ConfigurationOrigin::UserSpecified => Self::Cwd, + ConfigurationOrigin::UserSettings => Self::Cwd, + ConfigurationOrigin::Ancestor => Self::Parent, + } + } +} + /// Find all Python (`.py`, `.pyi` and `.ipynb` files) in a set of paths. pub fn python_files_in_path<'a>( paths: &[PathBuf], @@ -353,8 +450,11 @@ pub fn python_files_in_path<'a>( for ancestor in path.ancestors() { if seen.insert(ancestor) { if let Some(pyproject) = settings_toml(ancestor)? { - let (root, settings) = - resolve_scoped_settings(&pyproject, Relativity::Parent, transformer)?; + let (root, settings) = resolve_scoped_settings( + &pyproject, + transformer, + ConfigurationOrigin::Ancestor, + )?; resolver.add(root, settings); // We found the closest configuration. break; @@ -478,18 +578,18 @@ impl ParallelVisitor for PythonFilesVisitor<'_, '_> { &file_basename, &settings.file_resolver.exclude, ) { - debug!("Ignored path via `exclude`: {:?}", path); + debug!("Ignored path via `exclude`: {path:?}"); return WalkState::Skip; } else if match_candidate_exclusion( &file_path, &file_basename, &settings.file_resolver.extend_exclude, ) { - debug!("Ignored path via `extend-exclude`: {:?}", path); + debug!("Ignored path via `extend-exclude`: {path:?}"); return WalkState::Skip; } } else { - debug!("Ignored path due to error in parsing: {:?}", path); + debug!("Ignored path due to error in parsing: {path:?}"); return WalkState::Skip; } } @@ -506,8 +606,8 @@ impl ParallelVisitor for PythonFilesVisitor<'_, '_> { match settings_toml(entry.path()) { Ok(Some(pyproject)) => match resolve_scoped_settings( &pyproject, - Relativity::Parent, self.transformer, + ConfigurationOrigin::Ancestor, ) { Ok((root, settings)) => { self.global.resolver.write().unwrap().add(root, settings); @@ -530,7 +630,7 @@ impl ParallelVisitor for PythonFilesVisitor<'_, '_> { match result { Ok(entry) => { // Ignore directories - let resolved = if entry.file_type().map_or(true, |ft| ft.is_dir()) { + let resolved = if entry.file_type().is_none_or(|ft| ft.is_dir()) { None } else if entry.depth() == 0 { // Accept all files that are passed-in directly. @@ -541,10 +641,10 @@ impl ParallelVisitor for PythonFilesVisitor<'_, '_> { let resolver = self.global.resolver.read().unwrap(); let settings = resolver.resolve(path); if settings.file_resolver.include.is_match(path) { - debug!("Included path via `include`: {:?}", path); + debug!("Included path via `include`: {path:?}"); Some(ResolvedFile::Nested(entry.into_path())) } else if settings.file_resolver.extend_include.is_match(path) { - debug!("Included path via `extend-include`: {:?}", path); + debug!("Included path via `extend-include`: {path:?}"); Some(ResolvedFile::Nested(entry.into_path())) } else { None @@ -567,7 +667,7 @@ impl ParallelVisitor for PythonFilesVisitor<'_, '_> { impl Drop for PythonFilesVisitor<'_, '_> { fn drop(&mut self) { let mut merged = self.global.merged.lock().unwrap(); - let (ref mut files, ref mut error) = &mut *merged; + let (files, error) = &mut *merged; if files.is_empty() { *files = std::mem::take(&mut self.local_files); @@ -641,7 +741,7 @@ pub fn python_file_at_path( for ancestor in path.ancestors() { if let Some(pyproject) = settings_toml(ancestor)? { let (root, settings) = - resolve_scoped_settings(&pyproject, Relativity::Parent, transformer)?; + resolve_scoped_settings(&pyproject, transformer, ConfigurationOrigin::Unknown)?; resolver.add(root, settings); break; } @@ -665,14 +765,14 @@ fn is_file_excluded(path: &Path, resolver: &Resolver) -> bool { &file_basename, &settings.file_resolver.exclude, ) { - debug!("Ignored path via `exclude`: {:?}", path); + debug!("Ignored path via `exclude`: {path:?}"); return true; } else if match_candidate_exclusion( &file_path, &file_basename, &settings.file_resolver.extend_exclude, ) { - debug!("Ignored path via `extend-exclude`: {:?}", path); + debug!("Ignored path via `extend-exclude`: {path:?}"); return true; } } else { @@ -742,8 +842,7 @@ impl std::fmt::Display for ExclusionKind { /// any of the exclusion criteria. pub fn match_any_exclusion( path: &Path, - exclude: &GlobSet, - extend_exclude: &GlobSet, + resolver_settings: &FileResolverSettings, lint_exclude: Option<&GlobSet>, format_exclude: Option<&GlobSet>, ) -> Option<ExclusionKind> { @@ -751,10 +850,10 @@ pub fn match_any_exclusion( if let Some(basename) = path.file_name() { let path = Candidate::new(path); let basename = Candidate::new(basename); - if match_candidate_exclusion(&path, &basename, exclude) { + if match_candidate_exclusion(&path, &basename, &resolver_settings.exclude) { return Some(ExclusionKind::Exclude); } - if match_candidate_exclusion(&path, &basename, extend_exclude) { + if match_candidate_exclusion(&path, &basename, &resolver_settings.extend_exclude) { return Some(ExclusionKind::ExtendExclude); } if let Some(lint_exclude) = lint_exclude { @@ -768,6 +867,11 @@ pub fn match_any_exclusion( } } } + if path == resolver_settings.project_root { + // Bail out; we'd end up past the project root on the next iteration + // (excludes etc. are thus "rooted" to the project). + break; + } } None } @@ -793,12 +897,11 @@ impl std::fmt::Display for InclusionKind { /// criteria. pub fn match_any_inclusion( path: &Path, - include: &GlobSet, - extend_include: &GlobSet, + resolver_settings: &FileResolverSettings, ) -> Option<InclusionKind> { - if include.is_match(path) { + if resolver_settings.include.is_match(path) { Some(InclusionKind::Include) - } else if extend_include.is_match(path) { + } else if resolver_settings.extend_include.is_match(path) { Some(InclusionKind::ExtendInclude) } else { None @@ -807,7 +910,7 @@ pub fn match_any_inclusion( #[cfg(test)] mod tests { - use std::fs::{create_dir, File}; + use std::fs::{File, create_dir}; use std::path::Path; use anyhow::Result; @@ -816,14 +919,14 @@ mod tests { use path_absolutize::Absolutize; use tempfile::TempDir; - use ruff_linter::settings::types::FilePattern; + use ruff_linter::settings::types::{FilePattern, GlobPath}; use crate::configuration::Configuration; use crate::pyproject::find_settings_toml; use crate::resolver::{ - is_file_excluded, match_exclusion, python_files_in_path, resolve_root_settings, - ConfigurationTransformer, PyprojectConfig, PyprojectDiscoveryStrategy, Relativity, - ResolvedFile, Resolver, + ConfigurationOrigin, ConfigurationTransformer, PyprojectConfig, PyprojectDiscoveryStrategy, + ResolvedFile, Resolver, is_file_excluded, match_exclusion, python_files_in_path, + resolve_root_settings, }; use crate::settings::Settings; use crate::tests::test_resource_path; @@ -843,8 +946,8 @@ mod tests { PyprojectDiscoveryStrategy::Hierarchical, resolve_root_settings( &find_settings_toml(&package_root)?.unwrap(), - Relativity::Parent, &NoOpTransformer, + ConfigurationOrigin::Ancestor, )?, None, ); @@ -911,13 +1014,8 @@ mod tests { let project_root = Path::new("/tmp/"); let path = Path::new("foo").absolutize_from(project_root).unwrap(); - let exclude = FilePattern::User( - "foo".to_string(), - Path::new("foo") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), - ); + let exclude = + FilePattern::User("foo".to_string(), GlobPath::normalize("foo", project_root)); let file_path = &path; let file_basename = path.file_name().unwrap(); assert!(match_exclusion( @@ -927,13 +1025,8 @@ mod tests { )); let path = Path::new("foo/bar").absolutize_from(project_root).unwrap(); - let exclude = FilePattern::User( - "bar".to_string(), - Path::new("bar") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), - ); + let exclude = + FilePattern::User("bar".to_string(), GlobPath::normalize("bar", project_root)); let file_path = &path; let file_basename = path.file_name().unwrap(); assert!(match_exclusion( @@ -947,10 +1040,7 @@ mod tests { .unwrap(); let exclude = FilePattern::User( "baz.py".to_string(), - Path::new("baz.py") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), + GlobPath::normalize("baz.py", project_root), ); let file_path = &path; let file_basename = path.file_name().unwrap(); @@ -963,10 +1053,7 @@ mod tests { let path = Path::new("foo/bar").absolutize_from(project_root).unwrap(); let exclude = FilePattern::User( "foo/bar".to_string(), - Path::new("foo/bar") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), + GlobPath::normalize("foo/bar", project_root), ); let file_path = &path; let file_basename = path.file_name().unwrap(); @@ -981,10 +1068,7 @@ mod tests { .unwrap(); let exclude = FilePattern::User( "foo/bar/baz.py".to_string(), - Path::new("foo/bar/baz.py") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), + GlobPath::normalize("foo/bar/baz.py", project_root), ); let file_path = &path; let file_basename = path.file_name().unwrap(); @@ -999,10 +1083,7 @@ mod tests { .unwrap(); let exclude = FilePattern::User( "foo/bar/*.py".to_string(), - Path::new("foo/bar/*.py") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), + GlobPath::normalize("foo/bar/*.py", project_root), ); let file_path = &path; let file_basename = path.file_name().unwrap(); @@ -1015,13 +1096,8 @@ mod tests { let path = Path::new("foo/bar/baz.py") .absolutize_from(project_root) .unwrap(); - let exclude = FilePattern::User( - "baz".to_string(), - Path::new("baz") - .absolutize_from(project_root) - .unwrap() - .to_path_buf(), - ); + let exclude = + FilePattern::User("baz".to_string(), GlobPath::normalize("baz", project_root)); let file_path = &path; let file_basename = path.file_name().unwrap(); assert!(!match_exclusion( diff --git a/crates/ruff_workspace/src/settings.rs b/crates/ruff_workspace/src/settings.rs index 451d9d8a104ae..a20bee0c9d486 100644 --- a/crates/ruff_workspace/src/settings.rs +++ b/crates/ruff_workspace/src/settings.rs @@ -3,12 +3,13 @@ use ruff_cache::cache_dir; use ruff_formatter::{FormatOptions, IndentStyle, IndentWidth, LineWidth}; use ruff_graph::AnalyzeSettings; use ruff_linter::display_settings; +use ruff_linter::settings::LinterSettings; use ruff_linter::settings::types::{ - ExtensionMapping, FilePattern, FilePatternSet, OutputFormat, UnsafeFixes, + CompiledPerFileTargetVersionList, ExtensionMapping, FilePattern, FilePatternSet, OutputFormat, + UnsafeFixes, }; -use ruff_linter::settings::LinterSettings; use ruff_macros::CacheKey; -use ruff_python_ast::PySourceType; +use ruff_python_ast::{PySourceType, PythonVersion}; use ruff_python_formatter::{ DocstringCode, DocstringCodeLineWidth, MagicTrailingComma, PreviewMode, PyFormatOptions, QuoteStyle, @@ -18,7 +19,6 @@ use std::fmt; use std::path::{Path, PathBuf}; #[derive(Debug, CacheKey)] -#[allow(clippy::struct_excessive_bools)] pub struct Settings { #[cache_key(ignore)] pub cache_dir: PathBuf, @@ -164,7 +164,17 @@ pub struct FormatterSettings { pub exclude: FilePatternSet, pub extension: ExtensionMapping, pub preview: PreviewMode, - pub target_version: ruff_python_formatter::PythonVersion, + /// The non-path-resolved Python version specified by the `target-version` input option. + /// + /// See [`FormatterSettings::resolve_target_version`] for a way to obtain the Python version for + /// a given file, while respecting the overrides in `per_file_target_version`. + pub unresolved_target_version: PythonVersion, + /// Path-specific overrides to `unresolved_target_version`. + /// + /// See [`FormatterSettings::resolve_target_version`] for a way to check a given [`Path`] + /// against these patterns, while falling back to `unresolved_target_version` if none of them + /// match. + pub per_file_target_version: CompiledPerFileTargetVersionList, pub line_width: LineWidth, @@ -182,7 +192,16 @@ pub struct FormatterSettings { } impl FormatterSettings { - pub fn to_format_options(&self, source_type: PySourceType, source: &str) -> PyFormatOptions { + pub fn to_format_options( + &self, + source_type: PySourceType, + source: &str, + path: Option<&Path>, + ) -> PyFormatOptions { + let target_version = path + .map(|path| self.resolve_target_version(path)) + .unwrap_or(self.unresolved_target_version); + let line_ending = match self.line_ending { LineEnding::Lf => ruff_formatter::printer::LineEnding::LineFeed, LineEnding::CrLf => ruff_formatter::printer::LineEnding::CarriageReturnLineFeed, @@ -205,7 +224,7 @@ impl FormatterSettings { }; PyFormatOptions::from_source_type(source_type) - .with_target_version(self.target_version) + .with_target_version(target_version) .with_indent_style(self.indent_style) .with_indent_width(self.indent_width) .with_quote_style(self.quote_style) @@ -216,6 +235,17 @@ impl FormatterSettings { .with_docstring_code(self.docstring_code_format) .with_docstring_code_line_width(self.docstring_code_line_width) } + + /// Resolve the [`PythonVersion`] to use for formatting. + /// + /// This method respects the per-file version overrides in + /// [`FormatterSettings::per_file_target_version`] and falls back on + /// [`FormatterSettings::unresolved_target_version`] if none of the override patterns match. + pub fn resolve_target_version(&self, path: &Path) -> PythonVersion { + self.per_file_target_version + .is_match(path) + .unwrap_or(self.unresolved_target_version) + } } impl Default for FormatterSettings { @@ -225,7 +255,8 @@ impl Default for FormatterSettings { Self { exclude: FilePatternSet::default(), extension: ExtensionMapping::default(), - target_version: default_options.target_version(), + unresolved_target_version: default_options.target_version(), + per_file_target_version: CompiledPerFileTargetVersionList::default(), preview: PreviewMode::Disabled, line_width: default_options.line_width(), line_ending: LineEnding::Auto, @@ -247,7 +278,8 @@ impl fmt::Display for FormatterSettings { namespace = "formatter", fields = [ self.exclude, - self.target_version | debug, + self.unresolved_target_version, + self.per_file_target_version, self.preview, self.line_width, self.line_ending, diff --git a/crates/ty/CONTRIBUTING.md b/crates/ty/CONTRIBUTING.md new file mode 100644 index 0000000000000..de7bedb705223 --- /dev/null +++ b/crates/ty/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Contributing to ty + +Welcome! We're happy to have you here. Thank you in advance for your contribution to ty. + +> [!NOTE] +> +> This guide is for ty. If you're looking to contribute to Ruff, please see +> [the Ruff contributing guide](../../CONTRIBUTING.md). + +## The Basics + +We welcome contributions in the form of pull requests. + +For small changes (e.g., bug fixes), feel free to submit a PR. + +For larger changes (e.g. new diagnostics, new functionality, new configuration options), consider +creating an [**issue**](https://github.com/astral-sh/ty/issues) outlining your proposed change. +You can also join us on [Discord](https://discord.com/invite/astral-sh) to discuss your idea with the +community. We've labeled [beginner-friendly tasks](https://github.com/astral-sh/ty/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) +in the issue tracker, along with [bugs](https://github.com/astral-sh/ty/issues?q=is%3Aissue+is%3Aopen+label%3Abug) +that are ready for contributions. + +### Prerequisites + +ty is written in Rust. You'll need to install the +[Rust toolchain](https://www.rust-lang.org/tools/install) for development. + +You'll need [uv](https://docs.astral.sh/uv/getting-started/installation/) (or `pipx` and `pip`) to +run Python utility commands. + +You can optionally install pre-commit hooks to automatically run the validation checks +when making a commit: + +```shell +uv tool install pre-commit +pre-commit install +``` + +We recommend [nextest](https://nexte.st/) to run ty's test suite (via `cargo nextest run`), +though it's not strictly necessary: + +```shell +cargo install cargo-nextest --locked +``` + +Throughout this guide, any usages of `cargo test` can be replaced with `cargo nextest run`, +if you choose to install `nextest`. + +### Development + +After cloning the repository, run ty locally from the repository root with: + +```shell +cargo run --bin ty -- check --project /path/to/project/ +``` + +Prior to opening a pull request, ensure that your code has been auto-formatted, +and that it passes both the lint and test validation checks: + +```shell +cargo clippy --workspace --all-targets --all-features -- -D warnings # Rust linting +cargo test # Rust testing +uvx pre-commit run --all-files --show-diff-on-failure # Rust and Python formatting, Markdown and Python linting, etc. +``` + +These checks will run on GitHub Actions when you open your pull request, but running them locally +will save you time and expedite the merge process. + +If you're using VS Code, you can also install the recommended [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) extension to get these checks while editing. + +Include the text `[ty]` at the beginning of your pull request title, to distinguish ty pull requests +from Ruff ones. + +Your pull request will be reviewed by a maintainer, which may involve a few rounds of iteration +prior to merging. + +### Debugging ty + +ty can optionally emit extensive tracing output, which can be very useful in understanding its +operation and debugging issues; see [`crates/ty/docs/tracing.md`](./docs/tracing.md) for details. + +### Project Structure + +The codebase is structured as a monorepo with a [flat crate structure](https://matklad.github.io/2021/08/22/large-rust-workspaces.html), +such that all crates are contained in a flat `crates` directory. + +The vast majority of ty's code lives in the `ty_python_semantic` crate (located at +`crates/ty_python_semantic`). As a contributor, that's the crate that'll probably be most relevant +to you. + +At the time of writing, the repository includes the following ty-specific crates (in addition to +crates shared with Ruff, such as `ruff_db`, `ruff_python_ast`, and `ruff_python_parser`): + +- `ty_python_semantic`: The core type checker, which includes the type inference engine and + semantic analysis. +- `ty_test`: The Markdown-based test framework for ty, "mdtest". +- `ty`: The command-line interface. +- `ty_ide`: IDE features (hover, go-to-definition, autocomplete) for the language server. +- `ty_project`: Discovery and representation of a Python project to be checked by ty. +- `ty_server`: The ty language server. +- `ty_vendored`: A vendored copy of [typeshed](https://github.com/python/typeshed), which holds type + annotations for the Python standard library. +- `ty_wasm`: library crate for exposing ty as a WebAssembly module. Powers the + [ty Playground](https://play.ty.dev/). + +## Writing tests + +Core type checking tests are written as Markdown code blocks. +They can be found in [`crates/ty_python_semantic/resources/mdtest`][resources-mdtest]. +See [`crates/ty_test/README.md`][mdtest-readme] for more information +on the test framework itself. + +Any ty pull request to improve ty's type inference or type checking logic should include mdtests +demonstrating the effect of the change. + +We write mdtests in a "literate" style, with prose explaining the motivation of each test, and any +context necessary to understand the feature being demonstrated. + +### Property tests + +ty uses property-based testing to test the core type relations. These tests are located in +[`crates/ty_python_semantic/src/types/property_tests.rs`](../ty_python_semantic/src/types/property_tests.rs). + +The property tests do not run in CI on every PR, just once daily. It is advisable to run them +locally after modifying core type relation methods (`is_subtype_of`, `is_equivalent_to`, etc.) to +ensure that the changes do not break any of the properties. + +## Ecosystem CI (mypy-primer) + +GitHub Actions will run your changes against a number of real-world projects from GitHub and +report on any linter or formatter differences. See [`crates/ty/docs/mypy_primer.md`](./docs/mypy_primer.md) +for instructions on running these checks locally. + +## Coding guidelines + +We use the [Salsa](https:://github.com/salsa-rs/salsa) library for incremental computation. Many +methods take a Salsa database (usually `db: &'db dyn Db`) as an argument. This should always be the +first argument (or second after `self`). + +[mdtest-readme]: ../ty_test/README.md +[resources-mdtest]: ../ty_python_semantic/resources/mdtest diff --git a/crates/ty/Cargo.toml b/crates/ty/Cargo.toml new file mode 100644 index 0000000000000..cd287501fbbaf --- /dev/null +++ b/crates/ty/Cargo.toml @@ -0,0 +1,52 @@ +[package] +name = "ty" +version = "0.0.0" +# required for correct pypi metadata +homepage = "https://github.com/astral-sh/ty/" +documentation = "https://github.com/astral-sh/ty/" +# Releases occur in this other repository! +repository = "https://github.com/astral-sh/ty/" +edition.workspace = true +rust-version.workspace = true +authors.workspace = true +license.workspace = true + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +ruff_db = { workspace = true, features = ["os", "cache"] } +ruff_python_ast = { workspace = true } +ty_python_semantic = { workspace = true } +ty_project = { workspace = true, features = ["zstd"] } +ty_server = { workspace = true } + +anyhow = { workspace = true } +argfile = { workspace = true } +clap = { workspace = true, features = ["wrap_help", "string"] } +clap_complete_command = { workspace = true } +colored = { workspace = true } +countme = { workspace = true, features = ["enable"] } +crossbeam = { workspace = true } +ctrlc = { version = "3.4.4" } +indicatif = { workspace = true } +jiff = { workspace = true } +rayon = { workspace = true } +salsa = { workspace = true } +tracing = { workspace = true, features = ["release_max_level_debug"] } +tracing-subscriber = { workspace = true } +tracing-flame = { workspace = true } +wild = { workspace = true } + +[dev-dependencies] +ruff_db = { workspace = true, features = ["testing"] } +ruff_python_trivia = { workspace = true } + +insta = { workspace = true, features = ["filters"] } +insta-cmd = { workspace = true } +filetime = { workspace = true } +regex = { workspace = true } +tempfile = { workspace = true } +toml = { workspace = true } + +[lints] +workspace = true diff --git a/crates/ty/README.md b/crates/ty/README.md new file mode 100644 index 0000000000000..fb98292a0f8c1 --- /dev/null +++ b/crates/ty/README.md @@ -0,0 +1,9 @@ +# ty + +ty is an extremely fast type checker. +Currently, it is a work-in-progress and not ready for production use. + +The Rust code for ty lives in this repository; see [CONTRIBUTING.md](CONTRIBUTING.md) for more +information on contributing to ty. + +See [the ty repo](https://github.com/astral-sh/ty) for ty documentation and releases. diff --git a/crates/ty/build.rs b/crates/ty/build.rs new file mode 100644 index 0000000000000..98df7eae015c5 --- /dev/null +++ b/crates/ty/build.rs @@ -0,0 +1,134 @@ +use std::{ + fs, + path::{Path, PathBuf}, + process::Command, +}; + +fn main() { + // The workspace root directory is not available without walking up the tree + // https://github.com/rust-lang/cargo/issues/3946 + let workspace_root = Path::new(&std::env::var("CARGO_MANIFEST_DIR").unwrap()) + .join("..") + .join("..") + .join(".."); + + version_info(&workspace_root); + commit_info(&workspace_root); + + let target = std::env::var("TARGET").unwrap(); + println!("cargo::rustc-env=RUST_HOST_TARGET={target}"); +} + +/// Retrieve the version from the `dist-workspace.toml` file and set `TY_VERSION`. +fn version_info(workspace_root: &Path) { + let dist_file = workspace_root.join("dist-workspace.toml"); + if !dist_file.exists() { + return; + } + + println!("cargo:rerun-if-changed={}", dist_file.display()); + + let dist_file = fs::read_to_string(dist_file); + if let Ok(dist_file) = dist_file { + let lines = dist_file.lines(); + for line in lines { + if line.starts_with("version =") { + let (_key, version) = line.split_once('=').unwrap(); + println!( + "cargo::rustc-env=TY_VERSION={}", + version.trim().trim_matches('"') + ); + break; + } + } + } +} + +/// Retrieve commit information from the Git repository. +fn commit_info(workspace_root: &Path) { + // If not in a git repository, do not attempt to retrieve commit information + let git_dir = workspace_root.join(".git"); + if !git_dir.exists() { + return; + } + + if let Some(git_head_path) = git_head(&git_dir) { + println!("cargo:rerun-if-changed={}", git_head_path.display()); + + let git_head_contents = fs::read_to_string(git_head_path); + if let Ok(git_head_contents) = git_head_contents { + // The contents are either a commit or a reference in the following formats + // - "<commit>" when the head is detached + // - "ref <ref>" when working on a branch + // If a commit, checking if the HEAD file has changed is sufficient + // If a ref, we need to add the head file for that ref to rebuild on commit + let mut git_ref_parts = git_head_contents.split_whitespace(); + git_ref_parts.next(); + if let Some(git_ref) = git_ref_parts.next() { + let git_ref_path = git_dir.join(git_ref); + println!("cargo:rerun-if-changed={}", git_ref_path.display()); + } + } + } + + let output = match Command::new("git") + .arg("log") + .arg("-1") + .arg("--date=short") + .arg("--abbrev=9") + .arg("--format=%H %h %cd %(describe:tags)") + .current_dir(workspace_root) + .output() + { + Ok(output) if output.status.success() => output, + _ => return, + }; + let stdout = String::from_utf8(output.stdout).unwrap(); + let mut parts = stdout.split_whitespace(); + let mut next = || parts.next().unwrap(); + let _commit_hash = next(); + println!("cargo::rustc-env=TY_COMMIT_SHORT_HASH={}", next()); + println!("cargo::rustc-env=TY_COMMIT_DATE={}", next()); + + // Describe can fail for some commits + // https://git-scm.com/docs/pretty-formats#Documentation/pretty-formats.txt-emdescribeoptionsem + if let Some(describe) = parts.next() { + let mut describe_parts = describe.split('-'); + let last_tag = describe_parts.next().unwrap(); + + println!("cargo::rustc-env=TY_LAST_TAG={last_tag}"); + + // If this is the tagged commit, this component will be missing + println!( + "cargo::rustc-env=TY_LAST_TAG_DISTANCE={}", + describe_parts.next().unwrap_or("0") + ); + } +} + +fn git_head(git_dir: &Path) -> Option<PathBuf> { + // The typical case is a standard git repository. + let git_head_path = git_dir.join("HEAD"); + if git_head_path.exists() { + return Some(git_head_path); + } + if !git_dir.is_file() { + return None; + } + // If `.git/HEAD` doesn't exist and `.git` is actually a file, + // then let's try to attempt to read it as a worktree. If it's + // a worktree, then its contents will look like this, e.g.: + // + // gitdir: /home/andrew/astral/uv/main/.git/worktrees/pr2 + // + // And the HEAD file we want to watch will be at: + // + // /home/andrew/astral/uv/main/.git/worktrees/pr2/HEAD + let contents = fs::read_to_string(git_dir).ok()?; + let (label, worktree_path) = contents.split_once(':')?; + if label != "gitdir" { + return None; + } + let worktree_path = worktree_path.trim(); + Some(PathBuf::from(worktree_path)) +} diff --git a/crates/ty/docs/.gitattributes b/crates/ty/docs/.gitattributes new file mode 100644 index 0000000000000..5d0bdac7feb36 --- /dev/null +++ b/crates/ty/docs/.gitattributes @@ -0,0 +1,3 @@ +rules.md -diff linguist-generated=true text=auto eol=lf +cli.md -diff linguist-generated=true text=auto eol=lf +configuration.md -diff linguist-generated=true text=auto eol=lf diff --git a/crates/ty/docs/cli.md b/crates/ty/docs/cli.md new file mode 100644 index 0000000000000..61d2e392f769c --- /dev/null +++ b/crates/ty/docs/cli.md @@ -0,0 +1,144 @@ +# CLI Reference + +## ty + +An extremely fast Python type checker. + +<h3 class="cli-reference">Usage</h3> + +``` +ty <COMMAND> +``` + +<h3 class="cli-reference">Commands</h3> + +<dl class="cli-reference"><dt><a href="#ty-check"><code>ty check</code></a></dt><dd><p>Check a project for type errors</p></dd> +<dt><a href="#ty-server"><code>ty server</code></a></dt><dd><p>Start the language server</p></dd> +<dt><a href="#ty-version"><code>ty version</code></a></dt><dd><p>Display ty's version</p></dd> +<dt><a href="#ty-help"><code>ty help</code></a></dt><dd><p>Print this message or the help of the given subcommand(s)</p></dd> +</dl> + +## ty check + +Check a project for type errors + +<h3 class="cli-reference">Usage</h3> + +``` +ty check [OPTIONS] [PATH]... +``` + +<h3 class="cli-reference">Arguments</h3> + +<dl class="cli-reference"><dt id="ty-check--paths"><a href="#ty-check--paths"><code>PATHS</code></a></dt><dd><p>List of files or directories to check [default: the project root]</p> +</dd></dl> + +<h3 class="cli-reference">Options</h3> + +<dl class="cli-reference"><dt id="ty-check--color"><a href="#ty-check--color"><code>--color</code></a> <i>when</i></dt><dd><p>Control when colored output is used</p> +<p>Possible values:</p> +<ul> +<li><code>auto</code>: Display colors if the output goes to an interactive terminal</li> +<li><code>always</code>: Always display colors</li> +<li><code>never</code>: Never display colors</li> +</ul></dd><dt id="ty-check--config"><a href="#ty-check--config"><code>--config</code></a>, <code>-c</code> <i>config-option</i></dt><dd><p>A TOML <code><KEY> = <VALUE></code> pair</p> +</dd><dt id="ty-check--error"><a href="#ty-check--error"><code>--error</code></a> <i>rule</i></dt><dd><p>Treat the given rule as having severity 'error'. Can be specified multiple times.</p> +</dd><dt id="ty-check--error-on-warning"><a href="#ty-check--error-on-warning"><code>--error-on-warning</code></a></dt><dd><p>Use exit code 1 if there are any warning-level diagnostics</p> +</dd><dt id="ty-check--exit-zero"><a href="#ty-check--exit-zero"><code>--exit-zero</code></a></dt><dd><p>Always use exit code 0, even when there are error-level diagnostics</p> +</dd><dt id="ty-check--extra-search-path"><a href="#ty-check--extra-search-path"><code>--extra-search-path</code></a> <i>path</i></dt><dd><p>Additional path to use as a module-resolution source (can be passed multiple times)</p> +</dd><dt id="ty-check--help"><a href="#ty-check--help"><code>--help</code></a>, <code>-h</code></dt><dd><p>Print help (see a summary with '-h')</p> +</dd><dt id="ty-check--ignore"><a href="#ty-check--ignore"><code>--ignore</code></a> <i>rule</i></dt><dd><p>Disables the rule. Can be specified multiple times.</p> +</dd><dt id="ty-check--output-format"><a href="#ty-check--output-format"><code>--output-format</code></a> <i>output-format</i></dt><dd><p>The format to use for printing diagnostic messages</p> +<p>Possible values:</p> +<ul> +<li><code>full</code>: Print diagnostics verbosely, with context and helpful hints</li> +<li><code>concise</code>: Print diagnostics concisely, one per line</li> +</ul></dd><dt id="ty-check--project"><a href="#ty-check--project"><code>--project</code></a> <i>project</i></dt><dd><p>Run the command within the given project directory.</p> +<p>All <code>pyproject.toml</code> files will be discovered by walking up the directory tree from the given project directory, as will the project's virtual environment (<code>.venv</code>) unless the <code>venv-path</code> option is set.</p> +<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p> +</dd><dt id="ty-check--python"><a href="#ty-check--python"><code>--python</code></a> <i>path</i></dt><dd><p>Path to the Python environment.</p> +<p>ty uses the Python environment to resolve type information and third-party dependencies.</p> +<p>If not specified, ty will attempt to infer it from the <code>VIRTUAL_ENV</code> environment variable or discover a <code>.venv</code> directory in the project root or working directory.</p> +<p>If a path to a Python interpreter is provided, e.g., <code>.venv/bin/python3</code>, ty will attempt to find an environment two directories up from the interpreter's path, e.g., <code>.venv</code>. At this time, ty does not invoke the interpreter to determine the location of the environment. This means that ty will not resolve dynamic executables such as a shim.</p> +<p>ty will search in the resolved environments's <code>site-packages</code> directories for type information and third-party imports.</p> +</dd><dt id="ty-check--python-platform"><a href="#ty-check--python-platform"><code>--python-platform</code></a>, <code>--platform</code> <i>platform</i></dt><dd><p>Target platform to assume when resolving types.</p> +<p>This is used to specialize the type of <code>sys.platform</code> and will affect the visibility of platform-specific functions and attributes. If the value is set to <code>all</code>, no assumptions are made about the target platform. If unspecified, the current system's platform will be used.</p> +</dd><dt id="ty-check--python-version"><a href="#ty-check--python-version"><code>--python-version</code></a>, <code>--target-version</code> <i>version</i></dt><dd><p>Python version to assume when resolving types.</p> +<p>The Python version affects allowed syntax, type definitions of the standard library, and type definitions of first- and third-party modules that are conditional on the Python version.</p> +<p>By default, the Python version is inferred as the lower bound of the project's <code>requires-python</code> field from the <code>pyproject.toml</code>, if available. Otherwise, the latest stable version supported by ty is used, which is currently 3.13.</p> +<p>ty will not infer the Python version from the Python environment at this time.</p> +<p>Possible values:</p> +<ul> +<li><code>3.7</code></li> +<li><code>3.8</code></li> +<li><code>3.9</code></li> +<li><code>3.10</code></li> +<li><code>3.11</code></li> +<li><code>3.12</code></li> +<li><code>3.13</code></li> +</ul></dd><dt id="ty-check--respect-ignore-files"><a href="#ty-check--respect-ignore-files"><code>--respect-ignore-files</code></a></dt><dd><p>Respect file exclusions via <code>.gitignore</code> and other standard ignore files. Use <code>--no-respect-gitignore</code> to disable</p> +</dd><dt id="ty-check--typeshed"><a href="#ty-check--typeshed"><code>--typeshed</code></a>, <code>--custom-typeshed-dir</code> <i>path</i></dt><dd><p>Custom directory to use for stdlib typeshed stubs</p> +</dd><dt id="ty-check--verbose"><a href="#ty-check--verbose"><code>--verbose</code></a>, <code>-v</code></dt><dd><p>Use verbose output (or <code>-vv</code> and <code>-vvv</code> for more verbose output)</p> +</dd><dt id="ty-check--warn"><a href="#ty-check--warn"><code>--warn</code></a> <i>rule</i></dt><dd><p>Treat the given rule as having severity 'warn'. Can be specified multiple times.</p> +</dd><dt id="ty-check--watch"><a href="#ty-check--watch"><code>--watch</code></a>, <code>-W</code></dt><dd><p>Watch files for changes and recheck files related to the changed files</p> +</dd></dl> + +## ty server + +Start the language server + +<h3 class="cli-reference">Usage</h3> + +``` +ty server +``` + +<h3 class="cli-reference">Options</h3> + +<dl class="cli-reference"><dt id="ty-server--help"><a href="#ty-server--help"><code>--help</code></a>, <code>-h</code></dt><dd><p>Print help</p> +</dd></dl> + +## ty version + +Display ty's version + +<h3 class="cli-reference">Usage</h3> + +``` +ty version +``` + +<h3 class="cli-reference">Options</h3> + +<dl class="cli-reference"><dt id="ty-version--help"><a href="#ty-version--help"><code>--help</code></a>, <code>-h</code></dt><dd><p>Print help</p> +</dd></dl> + +## ty generate-shell-completion + +Generate shell completion + +<h3 class="cli-reference">Usage</h3> + +``` +ty generate-shell-completion <SHELL> +``` + +<h3 class="cli-reference">Arguments</h3> + +<dl class="cli-reference"><dt id="ty-generate-shell-completion--shell"><a href="#ty-generate-shell-completion--shell"><code>SHELL</code></a></dt></dl> + +<h3 class="cli-reference">Options</h3> + +<dl class="cli-reference"><dt id="ty-generate-shell-completion--help"><a href="#ty-generate-shell-completion--help"><code>--help</code></a>, <code>-h</code></dt><dd><p>Print help</p> +</dd></dl> + +## ty help + +Print this message or the help of the given subcommand(s) + +<h3 class="cli-reference">Usage</h3> + +``` +ty help [COMMAND] +``` + diff --git a/crates/ty/docs/configuration.md b/crates/ty/docs/configuration.md new file mode 100644 index 0000000000000..1d18d9d093bb5 --- /dev/null +++ b/crates/ty/docs/configuration.md @@ -0,0 +1,226 @@ +# Configuration +#### `respect-ignore-files` + +Whether to automatically exclude files that are ignored by `.ignore`, +`.gitignore`, `.git/info/exclude`, and global `gitignore` files. +Enabled by default. + +**Default value**: `true` + +**Type**: `bool` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty] +respect-ignore-files = false +``` + +--- + +#### `rules` + +Configures the enabled rules and their severity. + +See [the rules documentation](https://ty.dev/rules) for a list of all available rules. + +Valid severities are: + +* `ignore`: Disable the rule. +* `warn`: Enable the rule and create a warning diagnostic. +* `error`: Enable the rule and create an error diagnostic. + ty will exit with a non-zero code if any error diagnostics are emitted. + +**Default value**: `{...}` + +**Type**: `dict[RuleName, "ignore" | "warn" | "error"]` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.rules] +possibly-unresolved-reference = "warn" +division-by-zero = "ignore" +``` + +--- + +## `environment` + +#### `extra-paths` + +List of user-provided paths that should take first priority in the module resolution. +Examples in other type checkers are mypy's `MYPYPATH` environment variable, +or pyright's `stubPath` configuration setting. + +**Default value**: `[]` + +**Type**: `list[str]` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.environment] +extra-paths = ["~/shared/my-search-path"] +``` + +--- + +#### `python` + +Path to the Python installation from which ty resolves type information and third-party dependencies. + +ty will search in the path's `site-packages` directories for type information and +third-party imports. + +This option is commonly used to specify the path to a virtual environment. + +**Default value**: `null` + +**Type**: `str` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.environment] +python = "./.venv" +``` + +--- + +#### `python-platform` + +Specifies the target platform that will be used to analyze the source code. +If specified, ty will understand conditions based on comparisons with `sys.platform`, such +as are commonly found in typeshed to reflect the differing contents of the standard library across platforms. + +If no platform is specified, ty will use the current platform: +- `win32` for Windows +- `darwin` for macOS +- `android` for Android +- `ios` for iOS +- `linux` for everything else + +**Default value**: `<current-platform>` + +**Type**: `"win32" | "darwin" | "android" | "ios" | "linux" | str` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.environment] +# Tailor type stubs and conditionalized type definitions to windows. +python-platform = "win32" +``` + +--- + +#### `python-version` + +Specifies the version of Python that will be used to analyze the source code. +The version should be specified as a string in the format `M.m` where `M` is the major version +and `m` is the minor (e.g. `"3.0"` or `"3.6"`). +If a version is provided, ty will generate errors if the source code makes use of language features +that are not supported in that version. +It will also understand conditionals based on comparisons with `sys.version_info`, such +as are commonly found in typeshed to reflect the differing contents of the standard +library across Python versions. + +**Default value**: `"3.13"` + +**Type**: `"3.7" | "3.8" | "3.9" | "3.10" | "3.11" | "3.12" | "3.13" | <major>.<minor>` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.environment] +python-version = "3.12" +``` + +--- + +#### `typeshed` + +Optional path to a "typeshed" directory on disk for us to use for standard-library types. +If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib, +bundled as a zip file in the binary + +**Default value**: `null` + +**Type**: `str` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.environment] +typeshed = "/path/to/custom/typeshed" +``` + +--- + +## `src` + +#### `root` + +The root of the project, used for finding first-party modules. + +If left unspecified, ty will try to detect common project layouts and initialize `src.root` accordingly: + +* if a `./src` directory exists, include `.` and `./src` in the first party search path (src layout or flat) +* if a `./<project-name>/<project-name>` directory exists, include `.` and `./<project-name>` in the first party search path +* otherwise, default to `.` (flat layout) + +**Default value**: `null` + +**Type**: `str` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.src] +root = "./app" +``` + +--- + +## `terminal` + +#### `error-on-warning` + +Use exit code 1 if there are any warning-level diagnostics. + +Defaults to `false`. + +**Default value**: `false` + +**Type**: `bool` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.terminal] +# Error if ty emits any warning-level diagnostics. +error-on-warning = true +``` + +--- + +#### `output-format` + +The format to use for printing diagnostic messages. + +Defaults to `full`. + +**Default value**: `full` + +**Type**: `full | concise` + +**Example usage** (`pyproject.toml`): + +```toml +[tool.ty.terminal] +output-format = "concise" +``` + +--- + diff --git a/crates/ty/docs/mypy_primer.md b/crates/ty/docs/mypy_primer.md new file mode 100644 index 0000000000000..95345c6282bee --- /dev/null +++ b/crates/ty/docs/mypy_primer.md @@ -0,0 +1,60 @@ +# Running `mypy_primer` + +## Basics + +`mypy_primer` can be run using `uvx --from "…" mypy_primer`. For example, to see the help message, run: + +```sh +uvx --from "git+https://github.com/hauntsaninja/mypy_primer" mypy_primer -h +``` + +Alternatively, you can install the forked version of `mypy_primer` using: + +```sh +uv tool install "git+https://github.com/hauntsaninja/mypy_primer" +``` + +and then run it using `uvx mypy_primer` or just `mypy_primer`, if your `PATH` is set up accordingly (see: [Tool executables]). + +## Showing the diagnostics diff between two Git revisions + +To show the diagnostics diff between two Git revisions (e.g. your feature branch and `main`), run: + +```sh +mypy_primer \ + --type-checker ty \ + --old origin/main \ + --new my/feature \ + --debug \ + --output concise \ + --project-selector '/black$' +``` + +This will show the diagnostics diff for the `black` project between the `main` branch and your `my/feature` branch. To run the +diff for all projects we currently enable in CI, use `--project-selector "/($(paste -s -d'|' crates/ty_python_semantic/resources/primer/good.txt))\$"`. + +You can also take a look at the [full list of ecosystem projects]. Note that some of them might still need a `ty_paths` configuration +option to work correctly. + +## Avoiding recompilation + +If you want to run `mypy_primer` repeatedly, e.g. for different projects, but for the same combination of `--old` and `--new`, you +can use set the `MYPY_PRIMER_NO_REBUILD` environment variable to avoid recompilation of ty: + +```sh +MYPY_PRIMER_NO_REBUILD=1 mypy_primer … +``` + +## Running from a local copy of the repository + +If you are working on a local branch, you can use `mypy_primer`'s `--repo` option to specify the path to your local copy of the `ruff` repository. +This allows `mypy_primer` to check out local branches: + +```sh +mypy_primer --repo /path/to/ruff --old origin/main --new my/local-branch … +``` + +Note that you might need to clean up `/tmp/mypy_primer` in order for this to work correctly. + +[full list of ecosystem projects]: https://github.com/hauntsaninja/mypy_primer/blob/master/mypy_primer/projects.py +[tool executables]: https://docs.astral.sh/uv/concepts/tools/#tool-executables diff --git a/crates/ty/docs/rules.md b/crates/ty/docs/rules.md new file mode 100644 index 0000000000000..ca0fdf429fb22 --- /dev/null +++ b/crates/ty/docs/rules.md @@ -0,0 +1,1849 @@ +# Rules + +## `byte-string-type-annotation` + +**Default level**: error + +<details> +<summary>detects byte strings in type annotation positions</summary> + +### What it does +Checks for byte-strings in type annotation positions. + +### Why is this bad? +Static analysis tools like ty can't analyse type annotations that use byte-string notation. + +### Examples +```python +def test(): -> b"int": + ... +``` + +Use instead: +```python +def test(): -> "int": + ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20byte-string-type-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L36) +</details> + +## `call-non-callable` + +**Default level**: error + +<details> +<summary>detects calls to non-callable objects</summary> + +### What it does +Checks for calls to non-callable objects. + +### Why is this bad? +Calling a non-callable object will raise a `TypeError` at runtime. + +### Examples +```python +4() # TypeError: 'int' object is not callable +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20call-non-callable) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L90) +</details> + +## `conflicting-argument-forms` + +**Default level**: error + +<details> +<summary>detects when an argument is used as both a value and a type form in a call</summary> + +### What it does +Checks whether an argument is used as both a value and a type form in a call. + +### Why is this bad? +Such calls have confusing semantics and often indicate a logic error. + +### Examples +```python +from typing import reveal_type +from ty_extensions import is_fully_static + +if flag: + f = repr # Expects a value +else: + f = is_fully_static # Expects a type form + +f(int) # error +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20conflicting-argument-forms) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L121) +</details> + +## `conflicting-declarations` + +**Default level**: error + +<details> +<summary>detects conflicting declarations</summary> + +### What it does +Checks whether a variable has been declared as two conflicting types. + +### Why is this bad +A variable with two conflicting declarations likely indicates a mistake. +Moreover, it could lead to incorrect or ill-defined type inference for +other code that relies on these variables. + +### Examples +```python +if b: + a: int +else: + a: str + +a = 1 +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20conflicting-declarations) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L147) +</details> + +## `conflicting-metaclass` + +**Default level**: error + +<details> +<summary>detects conflicting metaclasses</summary> + +### What it does +Checks for class definitions where the metaclass of the class +being created would not be a subclass of the metaclasses of +all the class's bases. + +### Why is it bad? +Such a class definition raises a `TypeError` at runtime. + +### Examples +```python +class M1(type): ... +class M2(type): ... +class A(metaclass=M1): ... +class B(metaclass=M2): ... + +## TypeError: metaclass conflict +class C(A, B): ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20conflicting-metaclass) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L172) +</details> + +## `cyclic-class-definition` + +**Default level**: error + +<details> +<summary>detects cyclic class definitions</summary> + +### What it does +Checks for class definitions in stub files that inherit +(directly or indirectly) from themselves. + +### Why is it bad? +Although forward references are natively supported in stub files, +inheritance cycles are still disallowed, as it is impossible to +resolve a consistent [method resolution order] for a class that +inherits from itself. + +### Examples +```python +## foo.pyi +class A(B): ... +class B(A): ... +``` + +[method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20cyclic-class-definition) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L198) +</details> + +## `duplicate-base` + +**Default level**: error + +<details> +<summary>detects class definitions with duplicate bases</summary> + +### What it does +Checks for class definitions with duplicate bases. + +### Why is this bad? +Class definitions with duplicate bases raise `TypeError` at runtime. + +### Examples +```python +class A: ... + +## TypeError: duplicate base class +class B(A, A): ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20duplicate-base) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L242) +</details> + +## `escape-character-in-forward-annotation` + +**Default level**: error + +<details> +<summary>detects forward type annotations with escape characters</summary> + +TODO #14889 + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20escape-character-in-forward-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L120) +</details> + +## `fstring-type-annotation` + +**Default level**: error + +<details> +<summary>detects F-strings in type annotation positions</summary> + +### What it does +Checks for f-strings in type annotation positions. + +### Why is this bad? +Static analysis tools like ty can't analyse type annotations that use f-string notation. + +### Examples +```python +def test(): -> f"int": + ... +``` + +Use instead: +```python +def test(): -> "int": + ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20fstring-type-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L11) +</details> + +## `implicit-concatenated-string-type-annotation` + +**Default level**: error + +<details> +<summary>detects implicit concatenated strings in type annotations</summary> + +### What it does +Checks for implicit concatenated strings in type annotation positions. + +### Why is this bad? +Static analysis tools like ty can't analyse type annotations that use implicit concatenated strings. + +### Examples +```python +def test(): -> "Literal[" "5" "]": + ... +``` + +Use instead: +```python +def test(): -> "Literal[5]": + ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20implicit-concatenated-string-type-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L86) +</details> + +## `incompatible-slots` + +**Default level**: error + +<details> +<summary>detects class definitions whose MRO has conflicting <code>__slots__</code></summary> + +### What it does +Checks for classes whose bases define incompatible `__slots__`. + +### Why is this bad? +Inheriting from bases with incompatible `__slots__`s +will lead to a `TypeError` at runtime. + +Classes with no or empty `__slots__` are always compatible: + +```python +class A: ... +class B: + __slots__ = () +class C: + __slots__ = ("a", "b") + +## fine +class D(A, B, C): ... +``` + +Multiple inheritance from more than one different class +defining non-empty `__slots__` is not allowed: + +```python +class A: + __slots__ = ("a", "b") + +class B: + __slots__ = ("a", "b") # Even if the values are the same + +## TypeError: multiple bases have instance lay-out conflict +class C(A, B): ... +``` + +### Known problems +Dynamic (not tuple or string literal) `__slots__` are not checked. +Additionally, classes inheriting from built-in classes with implicit layouts +like `str` or `int` are also not checked. + +```pycon +>>> hasattr(int, "__slots__") +False +>>> hasattr(str, "__slots__") +False +>>> class A(int, str): ... +Traceback (most recent call last): + File "<python-input-0>", line 1, in <module> + class A(int, str): ... +TypeError: multiple bases have instance lay-out conflict +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20incompatible-slots) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L263) +</details> + +## `inconsistent-mro` + +**Default level**: error + +<details> +<summary>detects class definitions with an inconsistent MRO</summary> + +### What it does +Checks for classes with an inconsistent [method resolution order] (MRO). + +### Why is this bad? +Classes with an inconsistent MRO will raise a `TypeError` at runtime. + +### Examples +```python +class A: ... +class B(A): ... + +## TypeError: Cannot create a consistent method resolution order +class C(A, B): ... +``` + +[method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20inconsistent-mro) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L349) +</details> + +## `index-out-of-bounds` + +**Default level**: error + +<details> +<summary>detects index out of bounds errors</summary> + +### What it does +Checks for attempts to use an out of bounds index to get an item from +a container. + +### Why is this bad? +Using an out of bounds index will raise an `IndexError` at runtime. + +### Examples +```python +t = (0, 1, 2) +t[3] # IndexError: tuple index out of range +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20index-out-of-bounds) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L373) +</details> + +## `invalid-argument-type` + +**Default level**: error + +<details> +<summary>detects call arguments whose type is not assignable to the corresponding typed parameter</summary> + +### What it does +Detects call arguments whose type is not assignable to the corresponding typed parameter. + +### Why is this bad? +Passing an argument of a type the function (or callable object) does not accept violates +the expectations of the function author and may cause unexpected runtime errors within the +body of the function. + +### Examples +```python +def func(x: int): ... +func("foo") # error: [invalid-argument-type] +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-argument-type) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L393) +</details> + +## `invalid-assignment` + +**Default level**: error + +<details> +<summary>detects invalid assignments</summary> + +### What it does +Checks for assignments where the type of the value +is not [assignable to] the type of the assignee. + +### Why is this bad? +Such assignments break the rules of the type system and +weaken a type checker's ability to accurately reason about your code. + +### Examples +```python +a: int = '' +``` + +[assignable to]: https://typing.python.org/en/latest/spec/glossary.html#term-assignable + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-assignment) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L433) +</details> + +## `invalid-attribute-access` + +**Default level**: error + +<details> +<summary>Invalid attribute access</summary> + +### What it does +Checks for assignments to class variables from instances +and assignments to instance variables from its class. + +### Why is this bad? +Incorrect assignments break the rules of the type system and +weaken a type checker's ability to accurately reason about your code. + +### Examples +```python +class C: + class_var: ClassVar[int] = 1 + instance_var: int + +C.class_var = 3 # okay +C().class_var = 3 # error: Cannot assign to class variable + +C().instance_var = 3 # okay +C.instance_var = 3 # error: Cannot assign to instance variable +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-attribute-access) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1381) +</details> + +## `invalid-base` + +**Default level**: error + +<details> +<summary>detects class bases that will cause the class definition to raise an exception at runtime</summary> + +### What it does +Checks for class definitions that have bases which are not instances of `type`. + +### Why is this bad? +Class definitions with bases like this will lead to `TypeError` being raised at runtime. + +### Examples +```python +class A(42): ... # error: [invalid-base] +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-base) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L455) +</details> + +## `invalid-context-manager` + +**Default level**: error + +<details> +<summary>detects expressions used in with statements that don't implement the context manager protocol</summary> + +### What it does +Checks for expressions used in `with` statements +that do not implement the context manager protocol. + +### Why is this bad? +Such a statement will raise `TypeError` at runtime. + +### Examples +```python +## TypeError: 'int' object does not support the context manager protocol +with 1: + print(2) +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-context-manager) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L506) +</details> + +## `invalid-declaration` + +**Default level**: error + +<details> +<summary>detects invalid declarations</summary> + +### What it does +Checks for declarations where the inferred type of an existing symbol +is not [assignable to] its post-hoc declared type. + +### Why is this bad? +Such declarations break the rules of the type system and +weaken a type checker's ability to accurately reason about your code. + +### Examples +```python +a = 1 +a: str +``` + +[assignable to]: https://typing.python.org/en/latest/spec/glossary.html#term-assignable + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-declaration) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L527) +</details> + +## `invalid-exception-caught` + +**Default level**: error + +<details> +<summary>detects exception handlers that catch classes that do not inherit from <code>BaseException</code></summary> + +### What it does +Checks for exception handlers that catch non-exception classes. + +### Why is this bad? +Catching classes that do not inherit from `BaseException` will raise a TypeError at runtime. + +### Example +```python +try: + 1 / 0 +except 1: + ... +``` + +Use instead: +```python +try: + 1 / 0 +except ZeroDivisionError: + ... +``` + +### References +- [Python documentation: except clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) +- [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions) + +### Ruff rule + This rule corresponds to Ruff's [`except-with-non-exception-classes` (`B030`)](https://docs.astral.sh/ruff/rules/except-with-non-exception-classes) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-exception-caught) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L550) +</details> + +## `invalid-generic-class` + +**Default level**: error + +<details> +<summary>detects invalid generic classes</summary> + +### What it does +Checks for the creation of invalid generic classes + +### Why is this bad? +There are several requirements that you must follow when defining a generic class. + +### Examples +```python +from typing import Generic, TypeVar + +T = TypeVar("T") # okay + +## error: class uses both PEP-695 syntax and legacy syntax +class C[U](Generic[T]): ... +``` + +### References +- [Typing spec: Generics](https://typing.python.org/en/latest/spec/generics.html#introduction) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-generic-class) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L586) +</details> + +## `invalid-legacy-type-variable` + +**Default level**: error + +<details> +<summary>detects invalid legacy type variables</summary> + +### What it does +Checks for the creation of invalid legacy `TypeVar`s + +### Why is this bad? +There are several requirements that you must follow when creating a legacy `TypeVar`. + +### Examples +```python +from typing import TypeVar + +T = TypeVar("T") # okay +Q = TypeVar("S") # error: TypeVar name must match the variable it's assigned to +T = TypeVar("T") # error: TypeVars should not be redefined + +## error: TypeVar must be immediately assigned to a variable +def f(t: TypeVar("U")): ... +``` + +### References +- [Typing spec: Generics](https://typing.python.org/en/latest/spec/generics.html#introduction) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-legacy-type-variable) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L612) +</details> + +## `invalid-metaclass` + +**Default level**: error + +<details> +<summary>detects invalid <code>metaclass=</code> arguments</summary> + +### What it does +Checks for arguments to `metaclass=` that are invalid. + +### Why is this bad? +Python allows arbitrary expressions to be used as the argument to `metaclass=`. +These expressions, however, need to be callable and accept the same arguments +as `type.__new__`. + +### Example + +```python +def f(): ... + +## TypeError: f() takes 0 positional arguments but 3 were given +class B(metaclass=f): ... +``` + +### References +- [Python documentation: Metaclasses](https://docs.python.org/3/reference/datamodel.html#metaclasses) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-metaclass) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L661) +</details> + +## `invalid-overload` + +**Default level**: error + +<details> +<summary>detects invalid <code>@overload</code> usages</summary> + +### What it does +Checks for various invalid `@overload` usages. + +### Why is this bad? +The `@overload` decorator is used to define functions and methods that accepts different +combinations of arguments and return different types based on the arguments passed. This is +mainly beneficial for type checkers. But, if the `@overload` usage is invalid, the type +checker may not be able to provide correct type information. + +### Example + +Defining only one overload: + +```py +from typing import overload + +@overload +def foo(x: int) -> int: ... +def foo(x: int | None) -> int | None: + return x +``` + +Or, not providing an implementation for the overloaded definition: + +```py +from typing import overload + +@overload +def foo() -> None: ... +@overload +def foo(x: int) -> int: ... +``` + +### References +- [Python documentation: `@overload`](https://docs.python.org/3/library/typing.html#typing.overload) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-overload) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L688) +</details> + +## `invalid-parameter-default` + +**Default level**: error + +<details> +<summary>detects default values that can't be assigned to the parameter's annotated type</summary> + +### What it does +Checks for default values that can't be +assigned to the parameter's annotated type. + +### Why is this bad? +This breaks the rules of the type system and +weakens a type checker's ability to accurately reason about your code. + +### Examples +```python +def f(a: int = ''): ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-parameter-default) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L731) +</details> + +## `invalid-protocol` + +**Default level**: error + +<details> +<summary>detects invalid protocol class definitions</summary> + +### What it does +Checks for invalidly defined protocol classes. + +### Why is this bad? +An invalidly defined protocol class may lead to the type checker inferring +unexpected things. It may also lead to `TypeError`s at runtime. + +### Examples +A `Protocol` class cannot inherit from a non-`Protocol` class; +this raises a `TypeError` at runtime: + +```pycon +>>> from typing import Protocol +>>> class Foo(int, Protocol): ... +... +Traceback (most recent call last): + File "<python-input-1>", line 1, in <module> + class Foo(int, Protocol): ... +TypeError: Protocols can only inherit from other protocols, got <class 'int'> +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-protocol) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L321) +</details> + +## `invalid-raise` + +**Default level**: error + +<details> +<summary>detects <code>raise</code> statements that raise invalid exceptions or use invalid causes</summary> + +Checks for `raise` statements that raise non-exceptions or use invalid +causes for their raised exceptions. + +### Why is this bad? +Only subclasses or instances of `BaseException` can be raised. +For an exception's cause, the same rules apply, except that `None` is also +permitted. Violating these rules results in a `TypeError` at runtime. + +### Examples +```python +def f(): + try: + something() + except NameError: + raise "oops!" from f + +def g(): + raise NotImplemented from 42 +``` + +Use instead: +```python +def f(): + try: + something() + except NameError as e: + raise RuntimeError("oops!") from e + +def g(): + raise NotImplementedError from None +``` + +### References +- [Python documentation: The `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#raise) +- [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-raise) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L751) +</details> + +## `invalid-return-type` + +**Default level**: error + +<details> +<summary>detects returned values that can't be assigned to the function's annotated return type</summary> + +### What it does +Detects returned values that can't be assigned to the function's annotated return type. + +### Why is this bad? +Returning an object of a type incompatible with the annotated return type may cause confusion to the user calling the function. + +### Examples +```python +def func() -> int: + return "a" # error: [invalid-return-type] +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-return-type) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L414) +</details> + +## `invalid-super-argument` + +**Default level**: error + +<details> +<summary>detects invalid arguments for <code>super()</code></summary> + +### What it does +Detects `super()` calls where: +- the first argument is not a valid class literal, or +- the second argument is not an instance or subclass of the first argument. + +### Why is this bad? +`super(type, obj)` expects: +- the first argument to be a class, +- and the second argument to satisfy one of the following: + - `isinstance(obj, type)` is `True` + - `issubclass(obj, type)` is `True` + +Violating this relationship will raise a `TypeError` at runtime. + +### Examples +```python +class A: + ... +class B(A): + ... + +super(A, B()) # it's okay! `A` satisfies `isinstance(B(), A)` + +super(A(), B()) # error: `A()` is not a class + +super(B, A()) # error: `A()` does not satisfy `isinstance(A(), B)` +super(B, A) # error: `A` does not satisfy `issubclass(A, B)` +``` + +### References +- [Python documentation: super()](https://docs.python.org/3/library/functions.html#super) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-super-argument) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L794) +</details> + +## `invalid-syntax-in-forward-annotation` + +**Default level**: error + +<details> +<summary>detects invalid syntax in forward annotations</summary> + +TODO #14889 + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-syntax-in-forward-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L111) +</details> + +## `invalid-type-alias-type` + +**Default level**: error + +<details> +<summary>detects invalid TypeAliasType definitions</summary> + +### What it does +Checks for the creation of invalid `TypeAliasType`s + +### Why is this bad? +There are several requirements that you must follow when creating a `TypeAliasType`. + +### Examples +```python +from typing import TypeAliasType + +IntOrStr = TypeAliasType("IntOrStr", int | str) # okay +NewAlias = TypeAliasType(get_name(), int) # error: TypeAliasType name must be a string literal +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-type-alias-type) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L640) +</details> + +## `invalid-type-checking-constant` + +**Default level**: error + +<details> +<summary>detects invalid <code>TYPE_CHECKING</code> constant assignments</summary> + +### What it does +Checks for a value other than `False` assigned to the `TYPE_CHECKING` variable, or an +annotation not assignable from `bool`. + +### Why is this bad? +The name `TYPE_CHECKING` is reserved for a flag that can be used to provide conditional +code seen only by the type checker, and not at runtime. Normally this flag is imported from +`typing` or `typing_extensions`, but it can also be defined locally. If defined locally, it +must be assigned the value `False` at runtime; the type checker will consider its value to +be `True`. If annotated, it must be annotated as a type that can accept `bool` values. + +### Examples +```python +TYPE_CHECKING: str +TYPE_CHECKING = '' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-type-checking-constant) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L833) +</details> + +## `invalid-type-form` + +**Default level**: error + +<details> +<summary>detects invalid type forms</summary> + +### What it does +Checks for expressions that are used as [type expressions] +but cannot validly be interpreted as such. + +### Why is this bad? +Such expressions cannot be understood by ty. +In some cases, they might raise errors at runtime. + +### Examples +```python +from typing import Annotated + +a: type[1] # `1` is not a type +b: Annotated[int] # `Annotated` expects at least two arguments +``` +[type expressions]: https://typing.python.org/en/latest/spec/annotations.html#type-and-annotation-expressions + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-type-form) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L857) +</details> + +## `invalid-type-variable-constraints` + +**Default level**: error + +<details> +<summary>detects invalid type variable constraints</summary> + +### What it does +Checks for constrained [type variables] with only one constraint. + +### Why is this bad? +A constrained type variable must have at least two constraints. + +### Examples +```python +from typing import TypeVar + +T = TypeVar('T', str) # invalid constrained TypeVar +``` + +Use instead: +```python +T = TypeVar('T', str, int) # valid constrained TypeVar +## or +T = TypeVar('T', bound=str) # valid bound TypeVar +``` + +[type variables]: https://docs.python.org/3/library/typing.html#typing.TypeVar + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-type-variable-constraints) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L881) +</details> + +## `missing-argument` + +**Default level**: error + +<details> +<summary>detects missing required arguments in a call</summary> + +### What it does +Checks for missing required arguments in a call. + +### Why is this bad? +Failing to provide a required argument will raise a `TypeError` at runtime. + +### Examples +```python +def func(x: int): ... +func() # TypeError: func() missing 1 required positional argument: 'x' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20missing-argument) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L910) +</details> + +## `no-matching-overload` + +**Default level**: error + +<details> +<summary>detects calls that do not match any overload</summary> + +### What it does +Checks for calls to an overloaded function that do not match any of the overloads. + +### Why is this bad? +Failing to provide the correct arguments to one of the overloads will raise a `TypeError` +at runtime. + +### Examples +```python +@overload +def func(x: int): ... +@overload +def func(x: bool): ... +func("string") # error: [no-matching-overload] +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20no-matching-overload) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L929) +</details> + +## `non-subscriptable` + +**Default level**: error + +<details> +<summary>detects subscripting objects that do not support subscripting</summary> + +### What it does +Checks for subscripting objects that do not support subscripting. + +### Why is this bad? +Subscripting an object that does not support it will raise a `TypeError` at runtime. + +### Examples +```python +4[1] # TypeError: 'int' object is not subscriptable +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20non-subscriptable) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L952) +</details> + +## `not-iterable` + +**Default level**: error + +<details> +<summary>detects iteration over an object that is not iterable</summary> + +### What it does +Checks for objects that are not iterable but are used in a context that requires them to be. + +### Why is this bad? +Iterating over an object that is not iterable will raise a `TypeError` at runtime. + +### Examples + +```python +for i in 34: # TypeError: 'int' object is not iterable + pass +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20not-iterable) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L970) +</details> + +## `parameter-already-assigned` + +**Default level**: error + +<details> +<summary>detects multiple arguments for the same parameter</summary> + +### What it does +Checks for calls which provide more than one argument for a single parameter. + +### Why is this bad? +Providing multiple values for a single parameter will raise a `TypeError` at runtime. + +### Examples + +```python +def f(x: int) -> int: ... + +f(1, x=2) # Error raised here +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20parameter-already-assigned) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1021) +</details> + +## `raw-string-type-annotation` + +**Default level**: error + +<details> +<summary>detects raw strings in type annotation positions</summary> + +### What it does +Checks for raw-strings in type annotation positions. + +### Why is this bad? +Static analysis tools like ty can't analyse type annotations that use raw-string notation. + +### Examples +```python +def test(): -> r"int": + ... +``` + +Use instead: +```python +def test(): -> "int": + ... +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20raw-string-type-annotation) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fstring_annotation.rs#L61) +</details> + +## `static-assert-error` + +**Default level**: error + +<details> +<summary>Failed static assertion</summary> + +### What it does +Makes sure that the argument of `static_assert` is statically known to be true. + +### Why is this bad? +A `static_assert` call represents an explicit request from the user +for the type checker to emit an error if the argument cannot be verified +to evaluate to `True` in a boolean context. + +### Examples +```python +from ty_extensions import static_assert + +static_assert(1 + 1 == 3) # error: evaluates to `False` + +static_assert(int(2.0 * 3.0) == 6) # error: does not have a statically known truthiness +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20static-assert-error) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1357) +</details> + +## `subclass-of-final-class` + +**Default level**: error + +<details> +<summary>detects subclasses of final classes</summary> + +### What it does +Checks for classes that subclass final classes. + +### Why is this bad? +Decorating a class with `@final` declares to the type checker that it should not be subclassed. + +### Example + +```python +from typing import final + +@final +class A: ... +class B(A): ... # Error raised here +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20subclass-of-final-class) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1112) +</details> + +## `too-many-positional-arguments` + +**Default level**: error + +<details> +<summary>detects calls passing too many positional arguments</summary> + +### What it does +Checks for calls that pass more positional arguments than the callable can accept. + +### Why is this bad? +Passing too many positional arguments will raise `TypeError` at runtime. + +### Example + +```python +def f(): ... + +f("foo") # Error raised here +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20too-many-positional-arguments) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1157) +</details> + +## `type-assertion-failure` + +**Default level**: error + +<details> +<summary>detects failed type assertions</summary> + +### What it does +Checks for `assert_type()` and `assert_never()` calls where the actual type +is not the same as the asserted type. + +### Why is this bad? +`assert_type()` allows confirming the inferred type of a certain value. + +### Example + +```python +def _(x: int): + assert_type(x, int) # fine + assert_type(x, str) # error: Actual type does not match asserted type +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20type-assertion-failure) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1135) +</details> + +## `unavailable-implicit-super-arguments` + +**Default level**: error + +<details> +<summary>detects invalid <code>super()</code> calls where implicit arguments are unavailable.</summary> + +### What it does +Detects invalid `super()` calls where implicit arguments like the enclosing class or first method argument are unavailable. + +### Why is this bad? +When `super()` is used without arguments, Python tries to find two things: +the nearest enclosing class and the first argument of the immediately enclosing function (typically self or cls). +If either of these is missing, the call will fail at runtime with a `RuntimeError`. + +### Examples +```python +super() # error: no enclosing class or function found + +def func(): + super() # error: no enclosing class or first argument exists + +class A: + f = super() # error: no enclosing function to provide the first argument + + def method(self): + def nested(): + super() # error: first argument does not exist in this nested function + + lambda: super() # error: first argument does not exist in this lambda + + (super() for _ in range(10)) # error: argument is not available in generator expression + + super() # okay! both enclosing class and first argument are available +``` + +### References +- [Python documentation: super()](https://docs.python.org/3/library/functions.html#super) + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unavailable-implicit-super-arguments) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1178) +</details> + +## `unknown-argument` + +**Default level**: error + +<details> +<summary>detects unknown keyword arguments in calls</summary> + +### What it does +Checks for keyword arguments in calls that don't match any parameter of the callable. + +### Why is this bad? +Providing an unknown keyword argument will raise `TypeError` at runtime. + +### Example + +```python +def f(x: int) -> int: ... + +f(x=1, y=2) # Error raised here +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unknown-argument) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1235) +</details> + +## `unresolved-attribute` + +**Default level**: error + +<details> +<summary>detects references to unresolved attributes</summary> + +### What it does +Checks for unresolved attributes. + +### Why is this bad? +Accessing an unbound attribute will raise an `AttributeError` at runtime. +An unresolved attribute is not guaranteed to exist from the type alone, +so this could also indicate that the object is not of the type that the user expects. + +### Examples +```python +class A: ... + +A().foo # AttributeError: 'A' object has no attribute 'foo' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unresolved-attribute) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1256) +</details> + +## `unresolved-import` + +**Default level**: error + +<details> +<summary>detects unresolved imports</summary> + +### What it does +Checks for import statements for which the module cannot be resolved. + +### Why is this bad? +Importing a module that cannot be resolved will raise a `ModuleNotFoundError` +at runtime. + +### Examples +```python +import foo # ModuleNotFoundError: No module named 'foo' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unresolved-import) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1278) +</details> + +## `unresolved-reference` + +**Default level**: error + +<details> +<summary>detects references to names that are not defined</summary> + +### What it does +Checks for references to names that are not defined. + +### Why is this bad? +Using an undefined variable will raise a `NameError` at runtime. + +### Example + +```python +print(x) # NameError: name 'x' is not defined +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unresolved-reference) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1297) +</details> + +## `unsupported-bool-conversion` + +**Default level**: error + +<details> +<summary>detects boolean conversion where the object incorrectly implements <code>__bool__</code></summary> + +### What it does +Checks for bool conversions where the object doesn't correctly implement `__bool__`. + +### Why is this bad? +If an exception is raised when you attempt to evaluate the truthiness of an object, +using the object in a boolean context will fail at runtime. + +### Examples + +```python +class NotBoolable: + __bool__ = None + +b1 = NotBoolable() +b2 = NotBoolable() + +if b1: # exception raised here + pass + +b1 and b2 # exception raised here +not b1 # exception raised here +b1 < b2 < b1 # exception raised here +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unsupported-bool-conversion) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L990) +</details> + +## `unsupported-operator` + +**Default level**: error + +<details> +<summary>detects binary, unary, or comparison expressions where the operands don't support the operator</summary> + +### What it does +Checks for binary expressions, comparisons, and unary expressions where +the operands don't support the operator. + +### Why is this bad? +Attempting to use an unsupported operator will raise a `TypeError` at +runtime. + +### Examples +```python +class A: ... + +A() + A() # TypeError: unsupported operand type(s) for +: 'A' and 'A' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unsupported-operator) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1316) +</details> + +## `zero-stepsize-in-slice` + +**Default level**: error + +<details> +<summary>detects a slice step size of zero</summary> + +### What it does +Checks for step size 0 in slices. + +### Why is this bad? +A slice with a step size of zero will raise a `ValueError` at runtime. + +### Examples +```python +l = list(range(10)) +l[1:10:0] # ValueError: slice step cannot be zero +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20zero-stepsize-in-slice) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1338) +</details> + +## `call-possibly-unbound-method` + +**Default level**: warn + +<details> +<summary>detects calls to possibly unbound methods</summary> + +### What it does +Checks for calls to possibly unbound methods. + +### Why is this bad? +Calling an unbound method will raise an `AttributeError` at runtime. + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20call-possibly-unbound-method) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L108) +</details> + +## `invalid-ignore-comment` + +**Default level**: warn + +<details> +<summary>detects ignore comments that use invalid syntax</summary> + +### What it does +Checks for `type: ignore` and `ty: ignore` comments that are syntactically incorrect. + +### Why is this bad? +A syntactically incorrect ignore comment is probably a mistake and is useless. + +### Examples +```py +a = 20 / 0 # type: ignoree +``` + +Use instead: + +```py +a = 20 / 0 # type: ignore +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20invalid-ignore-comment) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Fsuppression.rs#L65) +</details> + +## `possibly-unbound-attribute` + +**Default level**: warn + +<details> +<summary>detects references to possibly unbound attributes</summary> + +### What it does +Checks for possibly unbound attributes. + +### Why is this bad? +Attempting to access an unbound attribute will raise an `AttributeError` at runtime. + +### Examples +```python +class A: + if b: + c = 0 + +A.c # AttributeError: type object 'A' has no attribute 'c' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20possibly-unbound-attribute) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1042) +</details> + +## `possibly-unbound-import` + +**Default level**: warn + +<details> +<summary>detects possibly unbound imports</summary> + +### What it does +Checks for imports of symbols that may be unbound. + +### Why is this bad? +Importing an unbound module or name will raise a `ModuleNotFoundError` +or `ImportError` at runtime. + +### Examples +```python +## module.py +import datetime + +if datetime.date.today().weekday() != 6: + a = 1 + +## main.py +from module import a # ImportError: cannot import name 'a' from 'module' +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20possibly-unbound-import) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1064) +</details> + +## `redundant-cast` + +**Default level**: warn + +<details> +<summary>detects redundant <code>cast</code> calls</summary> + +### What it does +Detects redundant `cast` calls where the value already has the target type. + +### Why is this bad? +These casts have no effect and can be removed. + +### Example +```python +def f() -> int: + return 10 + +cast(int, f()) # Redundant +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20redundant-cast) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1409) +</details> + +## `undefined-reveal` + +**Default level**: warn + +<details> +<summary>detects usages of <code>reveal_type</code> without importing it</summary> + +### What it does +Checks for calls to `reveal_type` without importing it. + +### Why is this bad? +Using `reveal_type` without importing it will raise a `NameError` at runtime. + +### Examples +```python +reveal_type(1) # NameError: name 'reveal_type' is not defined +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20undefined-reveal) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1217) +</details> + +## `unknown-rule` + +**Default level**: warn + +<details> +<summary>detects <code>ty: ignore</code> comments that reference unknown rules</summary> + +### What it does +Checks for `ty: ignore[code]` where `code` isn't a known lint rule. + +### Why is this bad? +A `ty: ignore[code]` directive with a `code` that doesn't match +any known rule will not suppress any type errors, and is probably a mistake. + +### Examples +```py +a = 20 / 0 # ty: ignore[division-by-zer] +``` + +Use instead: + +```py +a = 20 / 0 # ty: ignore[division-by-zero] +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unknown-rule) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Fsuppression.rs#L40) +</details> + +## `unsupported-base` + +**Default level**: warn + +<details> +<summary>detects class bases that are unsupported as ty could not feasibly calculate the class's MRO</summary> + +### What it does +Checks for class definitions that have bases which are unsupported by ty. + +### Why is this bad? +If a class has a base that is an instance of a complex type such as a union type, +ty will not be able to resolve the [method resolution order] (MRO) for the class. +This will lead to an inferior understanding of your codebase and unpredictable +type-checking behavior. + +### Examples +```python +import datetime + +class A: ... +class B: ... + +if datetime.date.today().weekday() != 6: + C = A +else: + C = B + +class D(C): ... # error: [unsupported-base] +``` + +[method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unsupported-base) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L473) +</details> + +## `division-by-zero` + +**Default level**: ignore + +<details> +<summary>detects division by zero</summary> + +### What it does +It detects division by zero. + +### Why is this bad? +Dividing by zero raises a `ZeroDivisionError` at runtime. + +### Examples +```python +5 / 0 +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20division-by-zero) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L224) +</details> + +## `possibly-unresolved-reference` + +**Default level**: ignore + +<details> +<summary>detects references to possibly undefined names</summary> + +### What it does +Checks for references to names that are possibly not defined. + +### Why is this bad? +Using an undefined variable will raise a `NameError` at runtime. + +### Example + +```python +for i in range(0): + x = i + +print(x) # NameError: name 'x' is not defined +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20possibly-unresolved-reference) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Ftypes%2Fdiagnostic.rs#L1090) +</details> + +## `unused-ignore-comment` + +**Default level**: ignore + +<details> +<summary>detects unused <code>type: ignore</code> comments</summary> + +### What it does +Checks for `type: ignore` or `ty: ignore` directives that are no longer applicable. + +### Why is this bad? +A `type: ignore` directive that no longer matches any diagnostic violations is likely +included by mistake, and should be removed to avoid confusion. + +### Examples +```py +a = 20 / 2 # ty: ignore[division-by-zero] +``` + +Use instead: + +```py +a = 20 / 2 +``` + +### Links +* [Related issues](https://github.com/astral-sh/ty/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20unused-ignore-comment) +* [View source](https://github.com/astral-sh/ruff/blob/main/crates%2Fty_python_semantic%2Fsrc%2Fsuppression.rs#L15) +</details> + diff --git a/crates/red_knot/docs/tracing-flamegraph.png b/crates/ty/docs/tracing-flamegraph.png similarity index 100% rename from crates/red_knot/docs/tracing-flamegraph.png rename to crates/ty/docs/tracing-flamegraph.png diff --git a/crates/ty/docs/tracing.md b/crates/ty/docs/tracing.md new file mode 100644 index 0000000000000..898b8271d1f23 --- /dev/null +++ b/crates/ty/docs/tracing.md @@ -0,0 +1,140 @@ +# Tracing + +Traces are a useful tool to narrow down the location of a bug or, at least, to understand why the compiler is doing a +particular thing. +Note, tracing messages with severity `debug` or greater are user-facing. They should be phrased accordingly. +Tracing spans are only shown when using `-vvv`. + +## Verbosity levels + +The CLI supports different verbosity levels. + +- default: Only show errors and warnings. +- `-v` activates `info!`: Show generally useful information such as paths of configuration files, detected platform, + etc., but it's not a lot of messages, it's something you'll activate in CI by default. cargo build e.g. shows you + which packages are fresh. +- `-vv` activates `debug!` and timestamps: This should be enough information to get to the bottom of bug reports. When + you're processing many packages or files, you'll get pages and pages of output, but each line is link to a specific + action or state change. +- `-vvv` activates `trace!` (only in debug builds) and shows tracing-spans: At this level, you're logging everything. + Most of this is wasted, it's really slow, we dump e.g. the entire resolution graph. Only useful to developers, and you + almost certainly want to use `TY_LOG` to filter it down to the area your investigating. + +## Better logging with `TY_LOG` and `TY_MAX_PARALLELISM` + +By default, the CLI shows messages from the `ruff` and `ty` crates. Tracing messages from other crates are not shown. +The `TY_LOG` environment variable allows you to customize which messages are shown by specifying one +or +more [filter directives](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives). + +The `TY_MAX_PARALLELISM` environment variable, meanwhile, can be used to control the level of parallelism ty uses. +By default, ty will attempt to parallelize its work so that multiple files are checked simultaneously, +but this can result in a confused logging output where messages from different threads are intertwined and non +determinism. +To switch off parallelism entirely and have more readable logs, use `TY_MAX_PARALLELISM=1` (or `RAYON_NUM_THREADS=1`). + +### Examples + +#### Show all debug messages + +Shows debug messages from all crates. + +```bash +TY_LOG=debug +``` + +#### Show salsa query execution messages + +Show the salsa `execute: my_query` messages in addition to all ty messages. + +```bash +TY_LOG=ruff=trace,ty=trace,salsa=info +``` + +#### Show typing traces + +Only show traces for the `ty_python_semantic::types` module. + +```bash +TY_LOG="ty_python_semantic::types" +``` + +Note: Ensure that you use `-vvv` to see tracing spans. + +#### Show messages for a single file + +Shows all messages that are inside of a span for a specific file. + +```bash +TY_LOG=ty[{file=/home/micha/astral/test/x.py}]=trace +``` + +**Note**: Tracing still shows all spans because tracing can't know at the time of entering the span +whether one if its children has the file `x.py`. + +**Note**: Salsa currently logs the entire memoized values. In our case, the source text and parsed AST. +This very quickly leads to extremely long outputs. + +## Tracing and Salsa + +Be mindful about using `tracing` in Salsa queries, especially when using `warn` or `error` because it isn't guaranteed +that the query will execute after restoring from a persistent cache. In which case the user won't see the message. + +For example, don't use `tracing` to show the user a message when generating a lint violation failed +because the message would only be shown when linting the file the first time, but not on subsequent analysis +runs or when restoring from a persistent cache. This can be confusing for users because they +don't understand why a specific lint violation isn't raised. Instead, change your +query to return the failure as part of the query's result or use a Salsa accumulator. + +## Tracing in tests + +You can use `ruff_db::testing::setup_logging` or `ruff_db::testing::setup_logging_with_filter` to set up logging in +tests. + +```rust +use ruff_db::testing::setup_logging; + +#[test] +fn test() { + let _logging = setup_logging(); + + tracing::info!("This message will be printed to stderr"); +} +``` + +Note: Most test runners capture stderr and only show its output when a test fails. + +Note also that `setup_logging` only sets up logging for the current thread because +[`set_global_default`](https://docs.rs/tracing/latest/tracing/subscriber/fn.set_global_default.html) can only be +called **once**. + +## Release builds + +`trace!` events are removed in release builds. + +## Profiling + +ty generates a folded stack trace to the current directory named `tracing.folded` when setting the environment variable +`TY_LOG_PROFILE` to `1` or `true`. + +```bash +TY_LOG_PROFILE=1 ty -- --current-directory=../test -vvv +``` + +You can convert the textual representation into a visual one using `inferno`. + +```shell +cargo install inferno +``` + +```shell +# flamegraph +cat tracing.folded | inferno-flamegraph > tracing-flamegraph.svg + +# flamechart +cat tracing.folded | inferno-flamegraph --flamechart > tracing-flamechart.svg +``` + +![Example flamegraph](./tracing-flamegraph.png) + +See [`tracing-flame`](https://crates.io/crates/tracing-flame) for more details. diff --git a/crates/ty/src/args.rs b/crates/ty/src/args.rs new file mode 100644 index 0000000000000..9321319fad4ce --- /dev/null +++ b/crates/ty/src/args.rs @@ -0,0 +1,376 @@ +use crate::logging::Verbosity; +use crate::python_version::PythonVersion; +use clap::error::ErrorKind; +use clap::{ArgAction, ArgMatches, Error, Parser}; +use ruff_db::system::SystemPathBuf; +use ty_project::combine::Combine; +use ty_project::metadata::options::{EnvironmentOptions, Options, TerminalOptions}; +use ty_project::metadata::value::{RangedValue, RelativePathBuf, ValueSource}; +use ty_python_semantic::lint; + +#[derive(Debug, Parser)] +#[command(author, name = "ty", about = "An extremely fast Python type checker.")] +#[command(long_version = crate::version::version())] +pub struct Cli { + #[command(subcommand)] + pub(crate) command: Command, +} + +#[allow(clippy::large_enum_variant)] +#[derive(Debug, clap::Subcommand)] +pub(crate) enum Command { + /// Check a project for type errors. + Check(CheckCommand), + + /// Start the language server + Server, + + /// Display ty's version + Version, + + /// Generate shell completion + #[clap(hide = true)] + GenerateShellCompletion { shell: clap_complete_command::Shell }, +} + +#[derive(Debug, Parser)] +pub(crate) struct CheckCommand { + /// List of files or directories to check. + #[clap( + help = "List of files or directories to check [default: the project root]", + value_name = "PATH" + )] + pub paths: Vec<SystemPathBuf>, + + /// Run the command within the given project directory. + /// + /// All `pyproject.toml` files will be discovered by walking up the directory tree from the given project directory, + /// as will the project's virtual environment (`.venv`) unless the `venv-path` option is set. + /// + /// Other command-line arguments (such as relative paths) will be resolved relative to the current working directory. + #[arg(long, value_name = "PROJECT")] + pub(crate) project: Option<SystemPathBuf>, + + /// Path to the Python environment. + /// + /// ty uses the Python environment to resolve type information and third-party dependencies. + /// + /// If not specified, ty will attempt to infer it from the `VIRTUAL_ENV` environment variable or + /// discover a `.venv` directory in the project root or working directory. + /// + /// If a path to a Python interpreter is provided, e.g., `.venv/bin/python3`, ty will attempt to + /// find an environment two directories up from the interpreter's path, e.g., `.venv`. At this + /// time, ty does not invoke the interpreter to determine the location of the environment. This + /// means that ty will not resolve dynamic executables such as a shim. + /// + /// ty will search in the resolved environments's `site-packages` directories for type + /// information and third-party imports. + #[arg(long, value_name = "PATH")] + pub(crate) python: Option<SystemPathBuf>, + + /// Custom directory to use for stdlib typeshed stubs. + #[arg(long, value_name = "PATH", alias = "custom-typeshed-dir")] + pub(crate) typeshed: Option<SystemPathBuf>, + + /// Additional path to use as a module-resolution source (can be passed multiple times). + #[arg(long, value_name = "PATH")] + pub(crate) extra_search_path: Option<Vec<SystemPathBuf>>, + + /// Python version to assume when resolving types. + /// + /// The Python version affects allowed syntax, type definitions of the standard library, and + /// type definitions of first- and third-party modules that are conditional on the Python version. + /// + /// By default, the Python version is inferred as the lower bound of the project's + /// `requires-python` field from the `pyproject.toml`, if available. Otherwise, the latest + /// stable version supported by ty is used, which is currently 3.13. + /// + /// ty will not infer the Python version from the Python environment at this time. + #[arg(long, value_name = "VERSION", alias = "target-version")] + pub(crate) python_version: Option<PythonVersion>, + + /// Target platform to assume when resolving types. + /// + /// This is used to specialize the type of `sys.platform` and will affect the visibility + /// of platform-specific functions and attributes. If the value is set to `all`, no + /// assumptions are made about the target platform. If unspecified, the current system's + /// platform will be used. + #[arg(long, value_name = "PLATFORM", alias = "platform")] + pub(crate) python_platform: Option<String>, + + #[clap(flatten)] + pub(crate) verbosity: Verbosity, + + #[clap(flatten)] + pub(crate) rules: RulesArg, + + #[clap(flatten)] + pub(crate) config: ConfigsArg, + + /// The format to use for printing diagnostic messages. + #[arg(long)] + pub(crate) output_format: Option<OutputFormat>, + + /// Control when colored output is used. + #[arg(long, value_name = "WHEN")] + pub(crate) color: Option<TerminalColor>, + + /// Use exit code 1 if there are any warning-level diagnostics. + #[arg(long, conflicts_with = "exit_zero", default_missing_value = "true", num_args=0..1)] + pub(crate) error_on_warning: Option<bool>, + + /// Always use exit code 0, even when there are error-level diagnostics. + #[arg(long)] + pub(crate) exit_zero: bool, + + /// Watch files for changes and recheck files related to the changed files. + #[arg(long, short = 'W')] + pub(crate) watch: bool, + + /// Respect file exclusions via `.gitignore` and other standard ignore files. + /// Use `--no-respect-gitignore` to disable. + #[arg( + long, + overrides_with("no_respect_ignore_files"), + help_heading = "File selection", + default_missing_value = "true", + num_args = 0..1 + )] + respect_ignore_files: Option<bool>, + #[clap(long, overrides_with("respect_ignore_files"), hide = true)] + no_respect_ignore_files: bool, +} + +impl CheckCommand { + pub(crate) fn into_options(self) -> Options { + let rules = if self.rules.is_empty() { + None + } else { + Some( + self.rules + .into_iter() + .map(|(rule, level)| (RangedValue::cli(rule), RangedValue::cli(level))) + .collect(), + ) + }; + + // --no-respect-gitignore defaults to false and is set true by CLI flag. If passed, override config file + // Otherwise, only pass this through if explicitly set (don't default to anything here to + // make sure that doesn't take precedence over an explicitly-set config file value) + let respect_ignore_files = self + .no_respect_ignore_files + .then_some(false) + .or(self.respect_ignore_files); + let options = Options { + environment: Some(EnvironmentOptions { + python_version: self + .python_version + .map(|version| RangedValue::cli(version.into())), + python_platform: self + .python_platform + .map(|platform| RangedValue::cli(platform.into())), + python: self.python.map(RelativePathBuf::cli), + typeshed: self.typeshed.map(RelativePathBuf::cli), + extra_paths: self.extra_search_path.map(|extra_search_paths| { + extra_search_paths + .into_iter() + .map(RelativePathBuf::cli) + .collect() + }), + }), + terminal: Some(TerminalOptions { + output_format: self + .output_format + .map(|output_format| RangedValue::cli(output_format.into())), + error_on_warning: self.error_on_warning, + }), + rules, + respect_ignore_files, + ..Default::default() + }; + // Merge with options passed in via --config + options.combine(self.config.into_options().unwrap_or_default()) + } +} + +/// A list of rules to enable or disable with a given severity. +/// +/// This type is used to parse the `--error`, `--warn`, and `--ignore` arguments +/// while preserving the order in which they were specified (arguments last override previous severities). +#[derive(Debug)] +pub(crate) struct RulesArg(Vec<(String, lint::Level)>); + +impl RulesArg { + fn is_empty(&self) -> bool { + self.0.is_empty() + } + + fn into_iter(self) -> impl Iterator<Item = (String, lint::Level)> { + self.0.into_iter() + } +} + +impl clap::FromArgMatches for RulesArg { + fn from_arg_matches(matches: &ArgMatches) -> Result<Self, Error> { + let mut rules = Vec::new(); + + for (level, arg_id) in [ + (lint::Level::Ignore, "ignore"), + (lint::Level::Warn, "warn"), + (lint::Level::Error, "error"), + ] { + let indices = matches.indices_of(arg_id).into_iter().flatten(); + let levels = matches.get_many::<String>(arg_id).into_iter().flatten(); + rules.extend( + indices + .zip(levels) + .map(|(index, rule)| (index, rule, level)), + ); + } + + // Sort by their index so that values specified later override earlier ones. + rules.sort_by_key(|(index, _, _)| *index); + + Ok(Self( + rules + .into_iter() + .map(|(_, rule, level)| (rule.to_owned(), level)) + .collect(), + )) + } + + fn update_from_arg_matches(&mut self, matches: &ArgMatches) -> Result<(), Error> { + self.0 = Self::from_arg_matches(matches)?.0; + Ok(()) + } +} + +impl clap::Args for RulesArg { + fn augment_args(cmd: clap::Command) -> clap::Command { + const HELP_HEADING: &str = "Enabling / disabling rules"; + + cmd.arg( + clap::Arg::new("error") + .long("error") + .action(ArgAction::Append) + .help("Treat the given rule as having severity 'error'. Can be specified multiple times.") + .value_name("RULE") + .help_heading(HELP_HEADING), + ) + .arg( + clap::Arg::new("warn") + .long("warn") + .action(ArgAction::Append) + .help("Treat the given rule as having severity 'warn'. Can be specified multiple times.") + .value_name("RULE") + .help_heading(HELP_HEADING), + ) + .arg( + clap::Arg::new("ignore") + .long("ignore") + .action(ArgAction::Append) + .help("Disables the rule. Can be specified multiple times.") + .value_name("RULE") + .help_heading(HELP_HEADING), + ) + } + + fn augment_args_for_update(cmd: clap::Command) -> clap::Command { + Self::augment_args(cmd) + } +} + +/// The diagnostic output format. +#[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] +pub enum OutputFormat { + /// Print diagnostics verbosely, with context and helpful hints. + /// + /// Diagnostic messages may include additional context and + /// annotations on the input to help understand the message. + #[default] + #[value(name = "full")] + Full, + /// Print diagnostics concisely, one per line. + /// + /// This will guarantee that each diagnostic is printed on + /// a single line. Only the most important or primary aspects + /// of the diagnostic are included. Contextual information is + /// dropped. + #[value(name = "concise")] + Concise, +} + +impl From<OutputFormat> for ruff_db::diagnostic::DiagnosticFormat { + fn from(format: OutputFormat) -> ruff_db::diagnostic::DiagnosticFormat { + match format { + OutputFormat::Full => Self::Full, + OutputFormat::Concise => Self::Concise, + } + } +} + +/// Control when colored output is used. +#[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] +pub(crate) enum TerminalColor { + /// Display colors if the output goes to an interactive terminal. + #[default] + Auto, + + /// Always display colors. + Always, + + /// Never display colors. + Never, +} +/// A TOML `<KEY> = <VALUE>` pair +/// (such as you might find in a `ty.toml` configuration file) +/// overriding a specific configuration option. +/// Overrides of individual settings using this option always take precedence +/// over all configuration files. +#[derive(Debug, Clone)] +pub(crate) struct ConfigsArg(Option<Options>); + +impl clap::FromArgMatches for ConfigsArg { + fn from_arg_matches(matches: &ArgMatches) -> Result<Self, Error> { + let combined = matches + .get_many::<String>("config") + .into_iter() + .flatten() + .map(|s| { + Options::from_toml_str(s, ValueSource::Cli) + .map_err(|err| Error::raw(ErrorKind::InvalidValue, err.to_string())) + }) + .collect::<Result<Vec<_>, _>>()? + .into_iter() + .reduce(|acc, item| item.combine(acc)); + Ok(Self(combined)) + } + + fn update_from_arg_matches(&mut self, matches: &ArgMatches) -> Result<(), Error> { + self.0 = Self::from_arg_matches(matches)?.0; + Ok(()) + } +} + +impl clap::Args for ConfigsArg { + fn augment_args(cmd: clap::Command) -> clap::Command { + cmd.arg( + clap::Arg::new("config") + .short('c') + .long("config") + .value_name("CONFIG_OPTION") + .help("A TOML `<KEY> = <VALUE>` pair") + .action(ArgAction::Append), + ) + } + + fn augment_args_for_update(cmd: clap::Command) -> clap::Command { + Self::augment_args(cmd) + } +} + +impl ConfigsArg { + pub(crate) fn into_options(self) -> Option<Options> { + self.0 + } +} diff --git a/crates/ty/src/lib.rs b/crates/ty/src/lib.rs new file mode 100644 index 0000000000000..443f61602eb36 --- /dev/null +++ b/crates/ty/src/lib.rs @@ -0,0 +1,443 @@ +mod args; +mod logging; +mod python_version; +mod version; + +pub use args::Cli; + +use std::io::{self, BufWriter, Write, stdout}; +use std::process::{ExitCode, Termination}; + +use anyhow::Result; +use std::sync::Mutex; + +use crate::args::{CheckCommand, Command, TerminalColor}; +use crate::logging::setup_tracing; +use anyhow::{Context, anyhow}; +use clap::{CommandFactory, Parser}; +use colored::Colorize; +use crossbeam::channel as crossbeam_channel; +use rayon::ThreadPoolBuilder; +use ruff_db::Upcast; +use ruff_db::diagnostic::{Diagnostic, DisplayDiagnosticConfig, Severity}; +use ruff_db::max_parallelism; +use ruff_db::system::{OsSystem, SystemPath, SystemPathBuf}; +use salsa::plumbing::ZalsaDatabase; +use ty_project::metadata::options::Options; +use ty_project::watch::ProjectWatcher; +use ty_project::{Db, DummyReporter, Reporter, watch}; +use ty_project::{ProjectDatabase, ProjectMetadata}; +use ty_server::run_server; + +pub fn run() -> anyhow::Result<ExitStatus> { + setup_rayon(); + + let args = wild::args_os(); + let args = argfile::expand_args_from(args, argfile::parse_fromfile, argfile::PREFIX) + .context("Failed to read CLI arguments from file")?; + let args = Cli::parse_from(args); + + match args.command { + Command::Server => run_server().map(|()| ExitStatus::Success), + Command::Check(check_args) => run_check(check_args), + Command::Version => version().map(|()| ExitStatus::Success), + Command::GenerateShellCompletion { shell } => { + shell.generate(&mut Cli::command(), &mut stdout()); + Ok(ExitStatus::Success) + } + } +} + +pub(crate) fn version() -> Result<()> { + let mut stdout = BufWriter::new(io::stdout().lock()); + let version_info = crate::version::version(); + writeln!(stdout, "ty {}", &version_info)?; + Ok(()) +} + +fn run_check(args: CheckCommand) -> anyhow::Result<ExitStatus> { + set_colored_override(args.color); + + let verbosity = args.verbosity.level(); + countme::enable(verbosity.is_trace()); + let _guard = setup_tracing(verbosity, args.color.unwrap_or_default())?; + + tracing::warn!( + "ty is pre-release software and not ready for production use. \ + Expect to encounter bugs, missing features, and fatal errors.", + ); + + tracing::debug!("Version: {}", version::version()); + + // The base path to which all CLI arguments are relative to. + let cwd = { + let cwd = std::env::current_dir().context("Failed to get the current working directory")?; + SystemPathBuf::from_path_buf(cwd) + .map_err(|path| { + anyhow!( + "The current working directory `{}` contains non-Unicode characters. ty only supports Unicode paths.", + path.display() + ) + })? + }; + + let project_path = args + .project + .as_ref() + .map(|project| { + if project.as_std_path().is_dir() { + Ok(SystemPath::absolute(project, &cwd)) + } else { + Err(anyhow!( + "Provided project path `{project}` is not a directory" + )) + } + }) + .transpose()? + .unwrap_or_else(|| cwd.clone()); + + let check_paths: Vec<_> = args + .paths + .iter() + .map(|path| SystemPath::absolute(path, &cwd)) + .collect(); + + let system = OsSystem::new(cwd); + let watch = args.watch; + let exit_zero = args.exit_zero; + + let cli_options = args.into_options(); + let mut project_metadata = ProjectMetadata::discover(&project_path, &system)?; + project_metadata.apply_cli_options(cli_options.clone()); + project_metadata.apply_configuration_files(&system)?; + + let mut db = ProjectDatabase::new(project_metadata, system)?; + + if !check_paths.is_empty() { + db.project().set_included_paths(&mut db, check_paths); + } + + let (main_loop, main_loop_cancellation_token) = MainLoop::new(cli_options); + + // Listen to Ctrl+C and abort the watch mode. + let main_loop_cancellation_token = Mutex::new(Some(main_loop_cancellation_token)); + ctrlc::set_handler(move || { + let mut lock = main_loop_cancellation_token.lock().unwrap(); + + if let Some(token) = lock.take() { + token.stop(); + } + })?; + + let exit_status = if watch { + main_loop.watch(&mut db)? + } else { + main_loop.run(&mut db)? + }; + + tracing::trace!("Counts for entire CLI run:\n{}", countme::get_all()); + + std::mem::forget(db); + + if exit_zero { + Ok(ExitStatus::Success) + } else { + Ok(exit_status) + } +} + +#[derive(Copy, Clone)] +pub enum ExitStatus { + /// Checking was successful and there were no errors. + Success = 0, + + /// Checking was successful but there were errors. + Failure = 1, + + /// Checking failed due to an invocation error (e.g. the current directory no longer exists, incorrect CLI arguments, ...) + Error = 2, + + /// Internal ty error (panic, or any other error that isn't due to the user using the + /// program incorrectly or transient environment errors). + InternalError = 101, +} + +impl Termination for ExitStatus { + fn report(self) -> ExitCode { + ExitCode::from(self as u8) + } +} + +struct MainLoop { + /// Sender that can be used to send messages to the main loop. + sender: crossbeam_channel::Sender<MainLoopMessage>, + + /// Receiver for the messages sent **to** the main loop. + receiver: crossbeam_channel::Receiver<MainLoopMessage>, + + /// The file system watcher, if running in watch mode. + watcher: Option<ProjectWatcher>, + + cli_options: Options, +} + +impl MainLoop { + fn new(cli_options: Options) -> (Self, MainLoopCancellationToken) { + let (sender, receiver) = crossbeam_channel::bounded(10); + + ( + Self { + sender: sender.clone(), + receiver, + watcher: None, + cli_options, + }, + MainLoopCancellationToken { sender }, + ) + } + + fn watch(mut self, db: &mut ProjectDatabase) -> Result<ExitStatus> { + tracing::debug!("Starting watch mode"); + let sender = self.sender.clone(); + let watcher = watch::directory_watcher(move |event| { + sender.send(MainLoopMessage::ApplyChanges(event)).unwrap(); + })?; + + self.watcher = Some(ProjectWatcher::new(watcher, db)); + + // Do not show progress bars with `--watch`, indicatif does not seem to + // handle cancelling independent progress bars very well. + self.run_with_progress::<DummyReporter>(db)?; + + Ok(ExitStatus::Success) + } + + fn run(self, db: &mut ProjectDatabase) -> Result<ExitStatus> { + self.run_with_progress::<IndicatifReporter>(db) + } + + fn run_with_progress<R>(mut self, db: &mut ProjectDatabase) -> Result<ExitStatus> + where + R: Reporter + Default + 'static, + { + self.sender.send(MainLoopMessage::CheckWorkspace).unwrap(); + + let result = self.main_loop::<R>(db); + + tracing::debug!("Exiting main loop"); + + result + } + + fn main_loop<R>(&mut self, db: &mut ProjectDatabase) -> Result<ExitStatus> + where + R: Reporter + Default + 'static, + { + // Schedule the first check. + tracing::debug!("Starting main loop"); + + let mut revision = 0u64; + + while let Ok(message) = self.receiver.recv() { + match message { + MainLoopMessage::CheckWorkspace => { + let db = db.clone(); + let sender = self.sender.clone(); + let mut reporter = R::default(); + + // Spawn a new task that checks the project. This needs to be done in a separate thread + // to prevent blocking the main loop here. + rayon::spawn(move || { + match db.check_with_reporter(&mut reporter) { + Ok(result) => { + // Send the result back to the main loop for printing. + sender + .send(MainLoopMessage::CheckCompleted { result, revision }) + .unwrap(); + } + Err(cancelled) => { + tracing::debug!("Check has been cancelled: {cancelled:?}"); + } + } + }); + } + + MainLoopMessage::CheckCompleted { + result, + revision: check_revision, + } => { + let terminal_settings = db.project().settings(db).terminal(); + let display_config = DisplayDiagnosticConfig::default() + .format(terminal_settings.output_format) + .color(colored::control::SHOULD_COLORIZE.should_colorize()); + + if check_revision == revision { + if db.project().files(db).is_empty() { + tracing::warn!("No python files found under the given path(s)"); + } + + let mut stdout = stdout().lock(); + + if result.is_empty() { + writeln!(stdout, "{}", "All checks passed!".green().bold())?; + + if self.watcher.is_none() { + return Ok(ExitStatus::Success); + } + } else { + let mut max_severity = Severity::Info; + let diagnostics_count = result.len(); + + for diagnostic in result { + write!( + stdout, + "{}", + diagnostic.display(&db.upcast(), &display_config) + )?; + + max_severity = max_severity.max(diagnostic.severity()); + } + + writeln!( + stdout, + "Found {} diagnostic{}", + diagnostics_count, + if diagnostics_count > 1 { "s" } else { "" } + )?; + + if max_severity.is_fatal() { + tracing::warn!( + "A fatal error occurred while checking some files. Not all project files were analyzed. See the diagnostics list above for details." + ); + } + + if self.watcher.is_none() { + return Ok(match max_severity { + Severity::Info => ExitStatus::Success, + Severity::Warning => { + if terminal_settings.error_on_warning { + ExitStatus::Failure + } else { + ExitStatus::Success + } + } + Severity::Error => ExitStatus::Failure, + Severity::Fatal => ExitStatus::InternalError, + }); + } + } + } else { + tracing::debug!( + "Discarding check result for outdated revision: current: {revision}, result revision: {check_revision}" + ); + } + + tracing::trace!("Counts after last check:\n{}", countme::get_all()); + } + + MainLoopMessage::ApplyChanges(changes) => { + revision += 1; + // Automatically cancels any pending queries and waits for them to complete. + db.apply_changes(changes, Some(&self.cli_options)); + if let Some(watcher) = self.watcher.as_mut() { + watcher.update(db); + } + self.sender.send(MainLoopMessage::CheckWorkspace).unwrap(); + } + MainLoopMessage::Exit => { + // Cancel any pending queries and wait for them to complete. + // TODO: Don't use Salsa internal APIs + // [Zulip-Thread](https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries) + let _ = db.zalsa_mut(); + return Ok(ExitStatus::Success); + } + } + + tracing::debug!("Waiting for next main loop message."); + } + + Ok(ExitStatus::Success) + } +} + +/// A progress reporter for `ty check`. +#[derive(Default)] +struct IndicatifReporter(Option<indicatif::ProgressBar>); + +impl ty_project::Reporter for IndicatifReporter { + fn set_files(&mut self, files: usize) { + let progress = indicatif::ProgressBar::new(files as u64); + progress.set_style( + indicatif::ProgressStyle::with_template( + "{msg:8.dim} {bar:60.green/dim} {pos}/{len} files", + ) + .unwrap() + .progress_chars("--"), + ); + progress.set_message("Checking"); + + self.0 = Some(progress); + } + + fn report_file(&self, _file: &ruff_db::files::File) { + if let Some(ref progress_bar) = self.0 { + progress_bar.inc(1); + } + } +} + +#[derive(Debug)] +struct MainLoopCancellationToken { + sender: crossbeam_channel::Sender<MainLoopMessage>, +} + +impl MainLoopCancellationToken { + fn stop(self) { + self.sender.send(MainLoopMessage::Exit).unwrap(); + } +} + +/// Message sent from the orchestrator to the main loop. +#[derive(Debug)] +enum MainLoopMessage { + CheckWorkspace, + CheckCompleted { + /// The diagnostics that were found during the check. + result: Vec<Diagnostic>, + revision: u64, + }, + ApplyChanges(Vec<watch::ChangeEvent>), + Exit, +} + +fn set_colored_override(color: Option<TerminalColor>) { + let Some(color) = color else { + return; + }; + + match color { + TerminalColor::Auto => { + colored::control::unset_override(); + } + TerminalColor::Always => { + colored::control::set_override(true); + } + TerminalColor::Never => { + colored::control::set_override(false); + } + } +} + +/// Initializes the global rayon thread pool to never use more than `TY_MAX_PARALLELISM` threads. +fn setup_rayon() { + ThreadPoolBuilder::default() + .num_threads(max_parallelism().get()) + // Use a reasonably large stack size to avoid running into stack overflows too easily. The + // size was chosen in such a way as to still be able to handle large expressions involving + // binary operators (x + x + … + x) both during the AST walk in semantic index building as + // well as during type checking. Using this stack size, we can handle handle expressions + // that are several times larger than the corresponding limits in existing type checkers. + .stack_size(16 * 1024 * 1024) + .build_global() + .unwrap(); +} diff --git a/crates/ty/src/logging.rs b/crates/ty/src/logging.rs new file mode 100644 index 0000000000000..ce10e183e8dcc --- /dev/null +++ b/crates/ty/src/logging.rs @@ -0,0 +1,264 @@ +//! Sets up logging for ty + +use crate::args::TerminalColor; +use anyhow::Context; +use colored::Colorize; +use std::fmt; +use std::fs::File; +use std::io::{BufWriter, IsTerminal}; +use tracing::{Event, Subscriber}; +use tracing_subscriber::EnvFilter; +use tracing_subscriber::filter::LevelFilter; +use tracing_subscriber::fmt::format::Writer; +use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields}; +use tracing_subscriber::registry::LookupSpan; + +/// Logging flags to `#[command(flatten)]` into your CLI +#[derive(clap::Args, Debug, Clone, Default)] +#[command(about = None, long_about = None)] +pub(crate) struct Verbosity { + #[arg( + long, + short = 'v', + help = "Use verbose output (or `-vv` and `-vvv` for more verbose output)", + action = clap::ArgAction::Count, + global = true, + )] + verbose: u8, +} + +impl Verbosity { + /// Returns the verbosity level based on the number of `-v` flags. + /// + /// Returns `None` if the user did not specify any verbosity flags. + pub(crate) fn level(&self) -> VerbosityLevel { + match self.verbose { + 0 => VerbosityLevel::Default, + 1 => VerbosityLevel::Verbose, + 2 => VerbosityLevel::ExtraVerbose, + _ => VerbosityLevel::Trace, + } + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] +pub(crate) enum VerbosityLevel { + /// Default output level. Only shows Ruff and ty events up to the [`WARN`](tracing::Level::WARN). + Default, + + /// Enables verbose output. Emits Ruff and ty events up to the [`INFO`](tracing::Level::INFO). + /// Corresponds to `-v`. + Verbose, + + /// Enables a more verbose tracing format and emits Ruff and ty events up to [`DEBUG`](tracing::Level::DEBUG). + /// Corresponds to `-vv` + ExtraVerbose, + + /// Enables all tracing events and uses a tree-like output format. Corresponds to `-vvv`. + Trace, +} + +impl VerbosityLevel { + const fn level_filter(self) -> LevelFilter { + match self { + VerbosityLevel::Default => LevelFilter::WARN, + VerbosityLevel::Verbose => LevelFilter::INFO, + VerbosityLevel::ExtraVerbose => LevelFilter::DEBUG, + VerbosityLevel::Trace => LevelFilter::TRACE, + } + } + + pub(crate) const fn is_trace(self) -> bool { + matches!(self, VerbosityLevel::Trace) + } + + pub(crate) const fn is_extra_verbose(self) -> bool { + matches!(self, VerbosityLevel::ExtraVerbose) + } +} + +pub(crate) fn setup_tracing( + level: VerbosityLevel, + color: TerminalColor, +) -> anyhow::Result<TracingGuard> { + use tracing_subscriber::prelude::*; + + // The `TY_LOG` environment variable overrides the default log level. + let filter = if let Ok(log_env_variable) = std::env::var("TY_LOG") { + EnvFilter::builder() + .parse(log_env_variable) + .context("Failed to parse directives specified in TY_LOG environment variable.")? + } else { + match level { + VerbosityLevel::Default => { + // Show warning traces + EnvFilter::default().add_directive(LevelFilter::WARN.into()) + } + level => { + let level_filter = level.level_filter(); + + // Show info|debug|trace events, but allow `TY_LOG` to override + let filter = EnvFilter::default().add_directive( + format!("ty={level_filter}") + .parse() + .expect("Hardcoded directive to be valid"), + ); + + filter.add_directive( + format!("ruff={level_filter}") + .parse() + .expect("Hardcoded directive to be valid"), + ) + } + } + }; + + let (profiling_layer, guard) = setup_profile(); + + let registry = tracing_subscriber::registry() + .with(filter) + .with(profiling_layer); + + let ansi = match color { + TerminalColor::Auto => { + colored::control::SHOULD_COLORIZE.should_colorize() && std::io::stderr().is_terminal() + } + TerminalColor::Always => true, + TerminalColor::Never => false, + }; + + if level.is_trace() { + let subscriber = registry.with( + tracing_subscriber::fmt::layer() + .event_format(tracing_subscriber::fmt::format().pretty()) + .with_thread_ids(true) + .with_ansi(ansi) + .with_writer(std::io::stderr), + ); + + subscriber.init(); + } else { + let subscriber = registry.with( + tracing_subscriber::fmt::layer() + .event_format(TyFormat { + display_level: true, + display_timestamp: level.is_extra_verbose(), + show_spans: false, + }) + .with_ansi(ansi) + .with_writer(std::io::stderr), + ); + + subscriber.init(); + } + + Ok(TracingGuard { + _flame_guard: guard, + }) +} + +#[expect(clippy::type_complexity)] +fn setup_profile<S>() -> ( + Option<tracing_flame::FlameLayer<S, BufWriter<File>>>, + Option<tracing_flame::FlushGuard<BufWriter<File>>>, +) +where + S: Subscriber + for<'span> LookupSpan<'span>, +{ + if let Ok("1" | "true") = std::env::var("TY_LOG_PROFILE").as_deref() { + let (layer, guard) = tracing_flame::FlameLayer::with_file("tracing.folded") + .expect("Flame layer to be created"); + (Some(layer), Some(guard)) + } else { + (None, None) + } +} + +pub(crate) struct TracingGuard { + _flame_guard: Option<tracing_flame::FlushGuard<BufWriter<File>>>, +} + +struct TyFormat { + display_timestamp: bool, + display_level: bool, + show_spans: bool, +} + +/// See <https://docs.rs/tracing-subscriber/0.3.18/src/tracing_subscriber/fmt/format/mod.rs.html#1026-1156> +impl<S, N> FormatEvent<S, N> for TyFormat +where + S: Subscriber + for<'a> LookupSpan<'a>, + N: for<'a> FormatFields<'a> + 'static, +{ + fn format_event( + &self, + ctx: &FmtContext<'_, S, N>, + mut writer: Writer<'_>, + event: &Event<'_>, + ) -> fmt::Result { + let meta = event.metadata(); + let ansi = writer.has_ansi_escapes(); + + if self.display_timestamp { + let timestamp = jiff::Zoned::now() + .strftime("%Y-%m-%d %H:%M:%S.%f") + .to_string(); + if ansi { + write!(writer, "{} ", timestamp.dimmed())?; + } else { + write!( + writer, + "{} ", + jiff::Zoned::now().strftime("%Y-%m-%d %H:%M:%S.%f") + )?; + } + } + + if self.display_level { + let level = meta.level(); + // Same colors as tracing + if ansi { + let formatted_level = level.to_string(); + match *level { + tracing::Level::TRACE => { + write!(writer, "{} ", formatted_level.purple().bold())?; + } + tracing::Level::DEBUG => write!(writer, "{} ", formatted_level.blue().bold())?, + tracing::Level::INFO => write!(writer, "{} ", formatted_level.green().bold())?, + tracing::Level::WARN => write!(writer, "{} ", formatted_level.yellow().bold())?, + tracing::Level::ERROR => write!(writer, "{} ", level.to_string().red().bold())?, + } + } else { + write!(writer, "{level} ")?; + } + } + + if self.show_spans { + let span = event.parent(); + let mut seen = false; + + let span = span + .and_then(|id| ctx.span(id)) + .or_else(|| ctx.lookup_current()); + + let scope = span.into_iter().flat_map(|span| span.scope().from_root()); + + for span in scope { + seen = true; + if ansi { + write!(writer, "{}:", span.metadata().name().bold())?; + } else { + write!(writer, "{}:", span.metadata().name())?; + } + } + + if seen { + writer.write_char(' ')?; + } + } + + ctx.field_format().format_fields(writer.by_ref(), event)?; + + writeln!(writer) + } +} diff --git a/crates/ty/src/main.rs b/crates/ty/src/main.rs new file mode 100644 index 0000000000000..6dbae583feb56 --- /dev/null +++ b/crates/ty/src/main.rs @@ -0,0 +1,33 @@ +use colored::Colorize; +use std::io; +use ty::{ExitStatus, run}; + +pub fn main() -> ExitStatus { + run().unwrap_or_else(|error| { + use io::Write; + + // Use `writeln` instead of `eprintln` to avoid panicking when the stderr pipe is broken. + let mut stderr = io::stderr().lock(); + + // This communicates that this isn't a linter error but ty itself hard-errored for + // some reason (e.g. failed to resolve the configuration) + writeln!(stderr, "{}", "ty failed".red().bold()).ok(); + // Currently we generally only see one error, but e.g. with io errors when resolving + // the configuration it is help to chain errors ("resolving configuration failed" -> + // "failed to read file: subdir/pyproject.toml") + for cause in error.chain() { + // Exit "gracefully" on broken pipe errors. + // + // See: https://github.com/BurntSushi/ripgrep/blob/bf63fe8f258afc09bae6caa48f0ae35eaf115005/crates/core/main.rs#L47C1-L61C14 + if let Some(ioerr) = cause.downcast_ref::<io::Error>() { + if ioerr.kind() == io::ErrorKind::BrokenPipe { + return ExitStatus::Success; + } + } + + writeln!(stderr, " {} {cause}", "Cause:".bold()).ok(); + } + + ExitStatus::Error + }) +} diff --git a/crates/ty/src/python_version.rs b/crates/ty/src/python_version.rs new file mode 100644 index 0000000000000..09ce15f526b1a --- /dev/null +++ b/crates/ty/src/python_version.rs @@ -0,0 +1,68 @@ +/// Enumeration of all supported Python versions +/// +/// TODO: unify with the `PythonVersion` enum in the linter/formatter crates? +#[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] +pub enum PythonVersion { + #[value(name = "3.7")] + Py37, + #[value(name = "3.8")] + Py38, + #[default] + #[value(name = "3.9")] + Py39, + #[value(name = "3.10")] + Py310, + #[value(name = "3.11")] + Py311, + #[value(name = "3.12")] + Py312, + #[value(name = "3.13")] + Py313, +} + +impl PythonVersion { + const fn as_str(self) -> &'static str { + match self { + Self::Py37 => "3.7", + Self::Py38 => "3.8", + Self::Py39 => "3.9", + Self::Py310 => "3.10", + Self::Py311 => "3.11", + Self::Py312 => "3.12", + Self::Py313 => "3.13", + } + } +} + +impl std::fmt::Display for PythonVersion { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} + +impl From<PythonVersion> for ruff_python_ast::PythonVersion { + fn from(value: PythonVersion) -> Self { + match value { + PythonVersion::Py37 => Self::PY37, + PythonVersion::Py38 => Self::PY38, + PythonVersion::Py39 => Self::PY39, + PythonVersion::Py310 => Self::PY310, + PythonVersion::Py311 => Self::PY311, + PythonVersion::Py312 => Self::PY312, + PythonVersion::Py313 => Self::PY313, + } + } +} + +#[cfg(test)] +mod tests { + use crate::python_version::PythonVersion; + + #[test] + fn same_default_as_python_version() { + assert_eq!( + ruff_python_ast::PythonVersion::from(PythonVersion::default()), + ruff_python_ast::PythonVersion::default() + ); + } +} diff --git a/crates/ty/src/version.rs b/crates/ty/src/version.rs new file mode 100644 index 0000000000000..d063de5277c97 --- /dev/null +++ b/crates/ty/src/version.rs @@ -0,0 +1,126 @@ +//! Code for representing ty's release version number. +use std::fmt; + +/// Information about the git repository where ty was built from. +pub(crate) struct CommitInfo { + short_commit_hash: String, + commit_date: String, + commits_since_last_tag: u32, + last_tag: Option<String>, +} + +/// ty's version. +pub(crate) struct VersionInfo { + /// ty's version, such as "0.5.1" + version: String, + /// Information about the git commit we may have been built from. + /// + /// `None` if not built from a git repo or if retrieval failed. + commit_info: Option<CommitInfo>, +} + +impl fmt::Display for VersionInfo { + /// Formatted version information: `<version>[+<commits>] (<commit> <date>)` + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.version)?; + + if let Some(ref ci) = self.commit_info { + if ci.commits_since_last_tag > 0 { + write!(f, "+{}", ci.commits_since_last_tag)?; + } + write!(f, " ({} {})", ci.short_commit_hash, ci.commit_date)?; + } + + Ok(()) + } +} + +impl From<VersionInfo> for clap::builder::Str { + fn from(val: VersionInfo) -> Self { + val.to_string().into() + } +} + +/// Returns information about ty's version. +pub(crate) fn version() -> VersionInfo { + // Environment variables are only read at compile-time + macro_rules! option_env_str { + ($name:expr) => { + option_env!($name).map(|s| s.to_string()) + }; + } + + // Commit info is pulled from git and set by `build.rs` + let commit_info = option_env_str!("TY_COMMIT_SHORT_HASH").map(|short_commit_hash| CommitInfo { + short_commit_hash, + commit_date: option_env_str!("TY_COMMIT_DATE").unwrap(), + commits_since_last_tag: option_env_str!("TY_LAST_TAG_DISTANCE") + .as_deref() + .map_or(0, |value| value.parse::<u32>().unwrap_or(0)), + last_tag: option_env_str!("TY_LAST_TAG"), + }); + + // The version is pulled from `dist-workspace.toml` and set by `build.rs` + let version = option_env_str!("TY_VERSION").unwrap_or_else(|| { + // If missing, using the last tag + commit_info + .as_ref() + .and_then(|info| { + info.last_tag.as_ref().map(|tag| { + tag.strip_prefix("v") + .map(std::string::ToString::to_string) + .unwrap_or(tag.clone()) + }) + }) + .unwrap_or("unknown".to_string()) + }); + + VersionInfo { + version, + commit_info, + } +} + +#[cfg(test)] +mod tests { + use insta::assert_snapshot; + + use super::{CommitInfo, VersionInfo}; + + #[test] + fn version_formatting() { + let version = VersionInfo { + version: "0.0.0".to_string(), + commit_info: None, + }; + assert_snapshot!(version, @"0.0.0"); + } + + #[test] + fn version_formatting_with_commit_info() { + let version = VersionInfo { + version: "0.0.0".to_string(), + commit_info: Some(CommitInfo { + short_commit_hash: "53b0f5d92".to_string(), + commit_date: "2023-10-19".to_string(), + commits_since_last_tag: 0, + last_tag: None, + }), + }; + assert_snapshot!(version, @"0.0.0 (53b0f5d92 2023-10-19)"); + } + + #[test] + fn version_formatting_with_commits_since_last_tag() { + let version = VersionInfo { + version: "0.0.0".to_string(), + commit_info: Some(CommitInfo { + short_commit_hash: "53b0f5d92".to_string(), + commit_date: "2023-10-19".to_string(), + commits_since_last_tag: 24, + last_tag: None, + }), + }; + assert_snapshot!(version, @"0.0.0+24 (53b0f5d92 2023-10-19)"); + } +} diff --git a/crates/ty/tests/cli.rs b/crates/ty/tests/cli.rs new file mode 100644 index 0000000000000..c0a510a1438c6 --- /dev/null +++ b/crates/ty/tests/cli.rs @@ -0,0 +1,1617 @@ +use anyhow::Context; +use insta::internals::SettingsBindDropGuard; +use insta_cmd::{assert_cmd_snapshot, get_cargo_bin}; +use ruff_python_ast::PythonVersion; +use std::fmt::Write; +use std::path::{Path, PathBuf}; +use std::process::Command; +use tempfile::TempDir; + +#[test] +fn test_run_in_sub_directory() -> anyhow::Result<()> { + let case = TestCase::with_files([("test.py", "~"), ("subdir/nothing", "")])?; + assert_cmd_snapshot!(case.command().current_dir(case.root().join("subdir")).arg(".."), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[invalid-syntax] + --> <temp_dir>/test.py:1:2 + | + 1 | ~ + | ^ Expected an expression + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + Ok(()) +} + +#[test] +fn test_include_hidden_files_by_default() -> anyhow::Result<()> { + let case = TestCase::with_files([(".test.py", "~")])?; + assert_cmd_snapshot!(case.command(), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[invalid-syntax] + --> .test.py:1:2 + | + 1 | ~ + | ^ Expected an expression + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + Ok(()) +} + +#[test] +fn test_respect_ignore_files() -> anyhow::Result<()> { + // First test that the default option works correctly (the file is skipped) + let case = TestCase::with_files([(".ignore", "test.py"), ("test.py", "~")])?; + assert_cmd_snapshot!(case.command(), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + WARN No python files found under the given path(s) + "); + + // Test that we can set to false via CLI + assert_cmd_snapshot!(case.command().arg("--no-respect-ignore-files"), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[invalid-syntax] + --> test.py:1:2 + | + 1 | ~ + | ^ Expected an expression + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + // Test that we can set to false via config file + case.write_file("ty.toml", "respect-ignore-files = false")?; + assert_cmd_snapshot!(case.command(), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[invalid-syntax] + --> test.py:1:2 + | + 1 | ~ + | ^ Expected an expression + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + // Ensure CLI takes precedence + case.write_file("ty.toml", "respect-ignore-files = true")?; + assert_cmd_snapshot!(case.command().arg("--no-respect-ignore-files"), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[invalid-syntax] + --> test.py:1:2 + | + 1 | ~ + | ^ Expected an expression + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + Ok(()) +} +/// Specifying an option on the CLI should take precedence over the same setting in the +/// project's configuration. Here, this is tested for the Python version. +#[test] +fn config_override_python_version() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.environment] + python-version = "3.11" + "#, + ), + ( + "test.py", + r#" + import sys + + # Access `sys.last_exc` that was only added in Python 3.12 + print(sys.last_exc) + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command(), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-attribute]: Type `<module 'sys'>` has no attribute `last_exc` + --> test.py:5:7 + | + 4 | # Access `sys.last_exc` that was only added in Python 3.12 + 5 | print(sys.last_exc) + | ^^^^^^^^^^^^ + | + info: rule `unresolved-attribute` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + assert_cmd_snapshot!(case.command().arg("--python-version").arg("3.12"), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// Same as above, but for the Python platform. +#[test] +fn config_override_python_platform() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.environment] + python-platform = "linux" + "#, + ), + ( + "test.py", + r#" + import sys + from typing_extensions import reveal_type + + reveal_type(sys.platform) + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command(), @r#" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type]: Revealed type + --> test.py:5:13 + | + 3 | from typing_extensions import reveal_type + 4 | + 5 | reveal_type(sys.platform) + | ^^^^^^^^^^^^ `Literal["linux"]` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "#); + + assert_cmd_snapshot!(case.command().arg("--python-platform").arg("all"), @r" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type]: Revealed type + --> test.py:5:13 + | + 3 | from typing_extensions import reveal_type + 4 | + 5 | reveal_type(sys.platform) + | ^^^^^^^^^^^^ `LiteralString` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn config_file_annotation_showing_where_python_version_set() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.environment] + python-version = "3.8" + "#, + ), + ( + "test.py", + r#" + aiter + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command(), @r#" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-reference]: Name `aiter` used when not defined + --> test.py:2:1 + | + 2 | aiter + | ^^^^^ + | + info: `aiter` was added as a builtin in Python 3.10 + info: Python 3.8 was assumed when resolving types + --> pyproject.toml:3:18 + | + 2 | [tool.ty.environment] + 3 | python-version = "3.8" + | ^^^^^ Python 3.8 assumed due to this configuration setting + | + info: rule `unresolved-reference` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "#); + + assert_cmd_snapshot!(case.command().arg("--python-version=3.9"), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-reference]: Name `aiter` used when not defined + --> test.py:2:1 + | + 2 | aiter + | ^^^^^ + | + info: `aiter` was added as a builtin in Python 3.10 + info: Python 3.9 was assumed when resolving types because it was specified on the command line + info: rule `unresolved-reference` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// Paths specified on the CLI are relative to the current working directory and not the project root. +/// +/// We test this by adding an extra search path from the CLI to the libs directory when +/// running the CLI from the child directory (using relative paths). +/// +/// Project layout: +/// ``` +/// - libs +/// |- utils.py +/// - child +/// | - test.py +/// - pyproject.toml +/// ``` +/// +/// And the command is run in the `child` directory. +#[test] +fn cli_arguments_are_relative_to_the_current_directory() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.environment] + python-version = "3.11" + "#, + ), + ( + "libs/utils.py", + r#" + def add(a: int, b: int) -> int: + return a + b + "#, + ), + ( + "child/test.py", + r#" + from utils import add + + stat = add(10, 15) + "#, + ), + ])?; + + // Make sure that the CLI fails when the `libs` directory is not in the search path. + assert_cmd_snapshot!(case.command().current_dir(case.root().join("child")), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-import]: Cannot resolve imported module `utils` + --> test.py:2:6 + | + 2 | from utils import add + | ^^^^^ + 3 | + 4 | stat = add(10, 15) + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + assert_cmd_snapshot!(case.command().current_dir(case.root().join("child")).arg("--extra-search-path").arg("../libs"), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// Paths specified in a configuration file are relative to the project root. +/// +/// We test this by adding `libs` (as a relative path) to the extra search path in the configuration and run +/// the CLI from a subdirectory. +/// +/// Project layout: +/// ``` +/// - libs +/// |- utils.py +/// - child +/// | - test.py +/// - pyproject.toml +/// ``` +#[test] +fn paths_in_configuration_files_are_relative_to_the_project_root() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.environment] + python-version = "3.11" + extra-paths = ["libs"] + "#, + ), + ( + "libs/utils.py", + r#" + def add(a: int, b: int) -> int: + return a + b + "#, + ), + ( + "child/test.py", + r#" + from utils import add + + stat = add(10, 15) + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command().current_dir(case.root().join("child")), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// The rule severity can be changed in the configuration file +#[test] +fn configuration_rule_severity() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + y = 4 / 0 + + for a in range(0, int(y)): + x = a + + prin(x) # unresolved-reference + "#, + )?; + + // Assert that there's an `unresolved-reference` diagnostic (error). + assert_cmd_snapshot!(case.command(), @r###" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-reference]: Name `prin` used when not defined + --> test.py:7:1 + | + 5 | x = a + 6 | + 7 | prin(x) # unresolved-reference + | ^^^^ + | + info: rule `unresolved-reference` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "###); + + case.write_file( + "pyproject.toml", + r#" + [tool.ty.rules] + division-by-zero = "warn" # promote to warn + unresolved-reference = "ignore" + "#, + )?; + + assert_cmd_snapshot!(case.command(), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[division-by-zero]: Cannot divide object of type `Literal[4]` by zero + --> test.py:2:5 + | + 2 | y = 4 / 0 + | ^^^^^ + 3 | + 4 | for a in range(0, int(y)): + | + info: rule `division-by-zero` was selected in the configuration file + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// The rule severity can be changed using `--ignore`, `--warn`, and `--error` +#[test] +fn cli_rule_severity() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + import does_not_exit + + y = 4 / 0 + + for a in range(0, int(y)): + x = a + + prin(x) # unresolved-reference + "#, + )?; + + // Assert that there's an `unresolved-reference` diagnostic (error) + // and an unresolved-import (error) diagnostic by default. + assert_cmd_snapshot!(case.command(), @r###" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-import]: Cannot resolve imported module `does_not_exit` + --> test.py:2:8 + | + 2 | import does_not_exit + | ^^^^^^^^^^^^^ + 3 | + 4 | y = 4 / 0 + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + error[unresolved-reference]: Name `prin` used when not defined + --> test.py:9:1 + | + 7 | x = a + 8 | + 9 | prin(x) # unresolved-reference + | ^^^^ + | + info: rule `unresolved-reference` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "###); + + assert_cmd_snapshot!( + case + .command() + .arg("--ignore") + .arg("unresolved-reference") + .arg("--warn") + .arg("division-by-zero") + .arg("--warn") + .arg("unresolved-import"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unresolved-import]: Cannot resolve imported module `does_not_exit` + --> test.py:2:8 + | + 2 | import does_not_exit + | ^^^^^^^^^^^^^ + 3 | + 4 | y = 4 / 0 + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` was selected on the command line + + warning[division-by-zero]: Cannot divide object of type `Literal[4]` by zero + --> test.py:4:5 + | + 2 | import does_not_exit + 3 | + 4 | y = 4 / 0 + | ^^^^^ + 5 | + 6 | for a in range(0, int(y)): + | + info: rule `division-by-zero` was selected on the command line + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + " + ); + + Ok(()) +} + +/// The rule severity can be changed using `--ignore`, `--warn`, and `--error` and +/// values specified last override previous severities. +#[test] +fn cli_rule_severity_precedence() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + y = 4 / 0 + + for a in range(0, int(y)): + x = a + + prin(x) # unresolved-reference + "#, + )?; + + // Assert that there's a `unresolved-reference` diagnostic (error) by default. + assert_cmd_snapshot!(case.command(), @r###" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-reference]: Name `prin` used when not defined + --> test.py:7:1 + | + 5 | x = a + 6 | + 7 | prin(x) # unresolved-reference + | ^^^^ + | + info: rule `unresolved-reference` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "###); + + assert_cmd_snapshot!( + case + .command() + .arg("--warn") + .arg("unresolved-reference") + .arg("--warn") + .arg("division-by-zero") + .arg("--ignore") + .arg("unresolved-reference"), + @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[division-by-zero]: Cannot divide object of type `Literal[4]` by zero + --> test.py:2:5 + | + 2 | y = 4 / 0 + | ^^^^^ + 3 | + 4 | for a in range(0, int(y)): + | + info: rule `division-by-zero` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + " + ); + + Ok(()) +} + +/// ty warns about unknown rules specified in a configuration file +#[test] +fn configuration_unknown_rules() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "pyproject.toml", + r#" + [tool.ty.rules] + division-by-zer = "warn" # incorrect rule name + "#, + ), + ("test.py", "print(10)"), + ])?; + + assert_cmd_snapshot!(case.command(), @r#" + success: true + exit_code: 0 + ----- stdout ----- + warning[unknown-rule] + --> pyproject.toml:3:1 + | + 2 | [tool.ty.rules] + 3 | division-by-zer = "warn" # incorrect rule name + | ^^^^^^^^^^^^^^^ Unknown lint rule `division-by-zer` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "#); + + Ok(()) +} + +/// ty warns about unknown rules specified in a CLI argument +#[test] +fn cli_unknown_rules() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", "print(10)")?; + + assert_cmd_snapshot!(case.command().arg("--ignore").arg("division-by-zer"), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unknown-rule]: Unknown lint rule `division-by-zer` + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_only_warnings() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", r"print(x) # [unresolved-reference]")?; + + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference"), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_only_info() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + from typing_extensions import reveal_type + reveal_type(1) + "#, + )?; + + assert_cmd_snapshot!(case.command(), @r" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type]: Revealed type + --> test.py:3:13 + | + 2 | from typing_extensions import reveal_type + 3 | reveal_type(1) + | ^ `Literal[1]` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_only_info_and_error_on_warning_is_true() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + from typing_extensions import reveal_type + reveal_type(1) + "#, + )?; + + assert_cmd_snapshot!(case.command().arg("--error-on-warning"), @r" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type]: Revealed type + --> test.py:3:13 + | + 2 | from typing_extensions import reveal_type + 3 | reveal_type(1) + | ^ `Literal[1]` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_no_errors_but_error_on_warning_is_true() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", r"print(x) # [unresolved-reference]")?; + + assert_cmd_snapshot!(case.command().arg("--error-on-warning").arg("--warn").arg("unresolved-reference"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_no_errors_but_error_on_warning_is_enabled_in_configuration() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ("test.py", r"print(x) # [unresolved-reference]"), + ( + "ty.toml", + r#" + [terminal] + error-on-warning = true + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_both_warnings_and_errors() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + print(x) # [unresolved-reference] + print(4[1]) # [non-subscriptable] + "#, + )?; + + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:2:7 + | + 2 | print(x) # [unresolved-reference] + | ^ + 3 | print(4[1]) # [non-subscriptable] + | + info: rule `unresolved-reference` was selected on the command line + + error[non-subscriptable]: Cannot subscript object of type `Literal[4]` with no `__getitem__` method + --> test.py:3:7 + | + 2 | print(x) # [unresolved-reference] + 3 | print(4[1]) # [non-subscriptable] + | ^ + | + info: rule `non-subscriptable` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_both_warnings_and_errors_and_error_on_warning_is_true() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r###" + print(x) # [unresolved-reference] + print(4[1]) # [non-subscriptable] + "###, + )?; + + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference").arg("--error-on-warning"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:2:7 + | + 2 | print(x) # [unresolved-reference] + | ^ + 3 | print(4[1]) # [non-subscriptable] + | + info: rule `unresolved-reference` was selected on the command line + + error[non-subscriptable]: Cannot subscript object of type `Literal[4]` with no `__getitem__` method + --> test.py:3:7 + | + 2 | print(x) # [unresolved-reference] + 3 | print(4[1]) # [non-subscriptable] + | ^ + | + info: rule `non-subscriptable` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn exit_code_exit_zero_is_true() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + print(x) # [unresolved-reference] + print(4[1]) # [non-subscriptable] + "#, + )?; + + assert_cmd_snapshot!(case.command().arg("--exit-zero").arg("--warn").arg("unresolved-reference"), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:2:7 + | + 2 | print(x) # [unresolved-reference] + | ^ + 3 | print(4[1]) # [non-subscriptable] + | + info: rule `unresolved-reference` was selected on the command line + + error[non-subscriptable]: Cannot subscript object of type `Literal[4]` with no `__getitem__` method + --> test.py:3:7 + | + 2 | print(x) # [unresolved-reference] + 3 | print(4[1]) # [non-subscriptable] + | ^ + | + info: rule `non-subscriptable` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn user_configuration() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "project/ty.toml", + r#" + [rules] + division-by-zero = "warn" + "#, + ), + ( + "project/main.py", + r#" + y = 4 / 0 + + for a in range(0, int(y)): + x = a + + prin(x) + "#, + ), + ])?; + + let config_directory = case.root().join("home/.config"); + let config_env_var = if cfg!(windows) { + "APPDATA" + } else { + "XDG_CONFIG_HOME" + }; + + assert_cmd_snapshot!( + case.command().current_dir(case.root().join("project")).env(config_env_var, config_directory.as_os_str()), + @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[division-by-zero]: Cannot divide object of type `Literal[4]` by zero + --> main.py:2:5 + | + 2 | y = 4 / 0 + | ^^^^^ + 3 | + 4 | for a in range(0, int(y)): + | + info: rule `division-by-zero` was selected in the configuration file + + error[unresolved-reference]: Name `prin` used when not defined + --> main.py:7:1 + | + 5 | x = a + 6 | + 7 | prin(x) + | ^^^^ + | + info: rule `unresolved-reference` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + " + ); + + // The user-level configuration sets the severity for `unresolved-reference` to warn. + // Changing the level for `division-by-zero` has no effect, because the project-level configuration + // has higher precedence. + case.write_file( + config_directory.join("ty/ty.toml"), + r#" + [rules] + division-by-zero = "error" + unresolved-reference = "warn" + "#, + )?; + + assert_cmd_snapshot!( + case.command().current_dir(case.root().join("project")).env(config_env_var, config_directory.as_os_str()), + @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[division-by-zero]: Cannot divide object of type `Literal[4]` by zero + --> main.py:2:5 + | + 2 | y = 4 / 0 + | ^^^^^ + 3 | + 4 | for a in range(0, int(y)): + | + info: rule `division-by-zero` was selected in the configuration file + + warning[unresolved-reference]: Name `prin` used when not defined + --> main.py:7:1 + | + 5 | x = a + 6 | + 7 | prin(x) + | ^^^^ + | + info: rule `unresolved-reference` was selected in the configuration file + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + " + ); + + Ok(()) +} + +#[test] +fn check_specific_paths() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "project/main.py", + r#" + y = 4 / 0 # error: division-by-zero + "#, + ), + ( + "project/tests/test_main.py", + r#" + import does_not_exist # error: unresolved-import + "#, + ), + ( + "project/other.py", + r#" + from main2 import z # error: unresolved-import + + print(z) + "#, + ), + ])?; + + assert_cmd_snapshot!( + case.command(), + @r###" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-import]: Cannot resolve imported module `main2` + --> project/other.py:2:6 + | + 2 | from main2 import z # error: unresolved-import + | ^^^^^ + 3 | + 4 | print(z) + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + error[unresolved-import]: Cannot resolve imported module `does_not_exist` + --> project/tests/test_main.py:2:8 + | + 2 | import does_not_exist # error: unresolved-import + | ^^^^^^^^^^^^^^ + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "### + ); + + // Now check only the `tests` and `other.py` files. + // We should no longer see any diagnostics related to `main.py`. + assert_cmd_snapshot!( + case.command().arg("project/tests").arg("project/other.py"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-import]: Cannot resolve imported module `main2` + --> project/other.py:2:6 + | + 2 | from main2 import z # error: unresolved-import + | ^^^^^ + 3 | + 4 | print(z) + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + error[unresolved-import]: Cannot resolve imported module `does_not_exist` + --> project/tests/test_main.py:2:8 + | + 2 | import does_not_exist # error: unresolved-import + | ^^^^^^^^^^^^^^ + | + info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment + info: rule `unresolved-import` is enabled by default + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + " + ); + + Ok(()) +} + +#[test] +fn check_non_existing_path() -> anyhow::Result<()> { + let case = TestCase::with_files([])?; + + let mut settings = insta::Settings::clone_current(); + settings.add_filter( + ®ex::escape("The system cannot find the path specified. (os error 3)"), + "No such file or directory (os error 2)", + ); + let _s = settings.bind_to_scope(); + + assert_cmd_snapshot!( + case.command().arg("project/main.py").arg("project/tests"), + @r" + success: false + exit_code: 1 + ----- stdout ----- + error[io]: `<temp_dir>/project/main.py`: No such file or directory (os error 2) + + error[io]: `<temp_dir>/project/tests`: No such file or directory (os error 2) + + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + WARN No python files found under the given path(s) + " + ); + + Ok(()) +} + +#[test] +fn concise_diagnostics() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + print(x) # [unresolved-reference] + print(4[1]) # [non-subscriptable] + "#, + )?; + + assert_cmd_snapshot!(case.command().arg("--output-format=concise").arg("--warn").arg("unresolved-reference"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference] test.py:2:7: Name `x` used when not defined + error[non-subscriptable] test.py:3:7: Cannot subscript object of type `Literal[4]` with no `__getitem__` method + Found 2 diagnostics + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +/// This tests the diagnostic format for revealed type. +/// +/// This test was introduced because changes were made to +/// how the revealed type diagnostic was constructed and +/// formatted in "verbose" mode. But it required extra +/// logic to ensure the concise version didn't regress on +/// information content. So this test was introduced to +/// capture that. +#[test] +fn concise_revealed_type() -> anyhow::Result<()> { + let case = TestCase::with_file( + "test.py", + r#" + from typing_extensions import reveal_type + + x = "hello" + reveal_type(x) + "#, + )?; + + assert_cmd_snapshot!(case.command().arg("--output-format=concise"), @r#" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type] test.py:5:13: Revealed type: `Literal["hello"]` + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "#); + + Ok(()) +} + +#[test] +fn can_handle_large_binop_expressions() -> anyhow::Result<()> { + let mut content = String::new(); + writeln!( + &mut content, + " + from typing_extensions import reveal_type + total = 1{plus_one_repeated} + reveal_type(total) + ", + plus_one_repeated = " + 1".repeat(2000 - 1) + )?; + + let case = TestCase::with_file("test.py", &ruff_python_trivia::textwrap::dedent(&content))?; + + assert_cmd_snapshot!(case.command(), @r" + success: true + exit_code: 0 + ----- stdout ----- + info[revealed-type]: Revealed type + --> test.py:4:13 + | + 2 | from typing_extensions import reveal_type + 3 | total = 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1... + 4 | reveal_type(total) + | ^^^^^ `Literal[2000]` + | + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn defaults_to_a_new_python_version() -> anyhow::Result<()> { + let case = TestCase::with_files([ + ( + "ty.toml", + &*format!( + r#" + [environment] + python-version = "{}" + python-platform = "linux" + "#, + PythonVersion::default() + ), + ), + ( + "main.py", + r#" + import os + + os.grantpt(1) # only available on unix, Python 3.13 or newer + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command(), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-attribute]: Type `<module 'os'>` has no attribute `grantpt` + --> main.py:4:1 + | + 2 | import os + 3 | + 4 | os.grantpt(1) # only available on unix, Python 3.13 or newer + | ^^^^^^^^^^ + | + info: rule `unresolved-attribute` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + // Use default (which should be latest supported) + let case = TestCase::with_files([ + ( + "ty.toml", + r#" + [environment] + python-platform = "linux" + "#, + ), + ( + "main.py", + r#" + import os + + os.grantpt(1) # only available on unix, Python 3.13 or newer + "#, + ), + ])?; + + assert_cmd_snapshot!(case.command(), @r" + success: true + exit_code: 0 + ----- stdout ----- + All checks passed! + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn cli_config_args_toml_string_basic() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", r"print(x) # [unresolved-reference]")?; + + // Long flag + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference").arg("--config").arg("terminal.error-on-warning=true"), @r" + success: false + exit_code: 1 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + // Short flag + assert_cmd_snapshot!(case.command().arg("-c").arg("terminal.error-on-warning=true"), @r" + success: false + exit_code: 1 + ----- stdout ----- + error[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` is enabled by default + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn cli_config_args_overrides_knot_toml() -> anyhow::Result<()> { + let case = TestCase::with_files(vec![ + ( + "knot.toml", + r#" + [terminal] + error-on-warning = true + "#, + ), + ("test.py", r"print(x) # [unresolved-reference]"), + ])?; + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference").arg("--config").arg("terminal.error-on-warning=false"), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn cli_config_args_later_overrides_earlier() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", r"print(x) # [unresolved-reference]")?; + assert_cmd_snapshot!(case.command().arg("--warn").arg("unresolved-reference").arg("--config").arg("terminal.error-on-warning=true").arg("--config").arg("terminal.error-on-warning=false"), @r" + success: true + exit_code: 0 + ----- stdout ----- + warning[unresolved-reference]: Name `x` used when not defined + --> test.py:1:7 + | + 1 | print(x) # [unresolved-reference] + | ^ + | + info: rule `unresolved-reference` was selected on the command line + + Found 1 diagnostic + + ----- stderr ----- + WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. + "); + + Ok(()) +} + +#[test] +fn cli_config_args_invalid_option() -> anyhow::Result<()> { + let case = TestCase::with_file("test.py", r"print(1)")?; + assert_cmd_snapshot!(case.command().arg("--config").arg("bad-option=true"), @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: TOML parse error at line 1, column 1 + | + 1 | bad-option=true + | ^^^^^^^^^^ + unknown field `bad-option`, expected one of `environment`, `src`, `rules`, `terminal`, `respect-ignore-files` + + + Usage: ty <COMMAND> + + For more information, try '--help'. + "); + + Ok(()) +} + +struct TestCase { + _temp_dir: TempDir, + _settings_scope: SettingsBindDropGuard, + project_dir: PathBuf, +} + +impl TestCase { + fn new() -> anyhow::Result<Self> { + let temp_dir = TempDir::new()?; + + // Canonicalize the tempdir path because macos uses symlinks for tempdirs + // and that doesn't play well with our snapshot filtering. + let project_dir = temp_dir + .path() + .canonicalize() + .context("Failed to canonicalize project path")?; + + let mut settings = insta::Settings::clone_current(); + settings.add_filter(&tempdir_filter(&project_dir), "<temp_dir>/"); + settings.add_filter(r#"\\(\w\w|\s|\.|")"#, "/$1"); + + let settings_scope = settings.bind_to_scope(); + + Ok(Self { + project_dir, + _temp_dir: temp_dir, + _settings_scope: settings_scope, + }) + } + + fn with_files<'a>(files: impl IntoIterator<Item = (&'a str, &'a str)>) -> anyhow::Result<Self> { + let case = Self::new()?; + case.write_files(files)?; + Ok(case) + } + + fn with_file(path: impl AsRef<Path>, content: &str) -> anyhow::Result<Self> { + let case = Self::new()?; + case.write_file(path, content)?; + Ok(case) + } + + fn write_files<'a>( + &self, + files: impl IntoIterator<Item = (&'a str, &'a str)>, + ) -> anyhow::Result<()> { + for (path, content) in files { + self.write_file(path, content)?; + } + + Ok(()) + } + + fn write_file(&self, path: impl AsRef<Path>, content: &str) -> anyhow::Result<()> { + let path = path.as_ref(); + let path = self.project_dir.join(path); + + if let Some(parent) = path.parent() { + std::fs::create_dir_all(parent) + .with_context(|| format!("Failed to create directory `{}`", parent.display()))?; + } + std::fs::write(&path, &*ruff_python_trivia::textwrap::dedent(content)) + .with_context(|| format!("Failed to write file `{path}`", path = path.display()))?; + + Ok(()) + } + + fn root(&self) -> &Path { + &self.project_dir + } + + fn command(&self) -> Command { + let mut command = Command::new(get_cargo_bin("ty")); + command.current_dir(&self.project_dir).arg("check"); + command + } +} + +fn tempdir_filter(path: &Path) -> String { + format!(r"{}\\?/?", regex::escape(path.to_str().unwrap())) +} diff --git a/crates/ty/tests/file_watching.rs b/crates/ty/tests/file_watching.rs new file mode 100644 index 0000000000000..c8f3a186b0040 --- /dev/null +++ b/crates/ty/tests/file_watching.rs @@ -0,0 +1,1879 @@ +use std::collections::HashSet; +use std::io::Write; +use std::time::{Duration, Instant}; + +use anyhow::{Context, anyhow}; +use ruff_db::files::{File, FileError, system_path_to_file}; +use ruff_db::source::source_text; +use ruff_db::system::{ + OsSystem, System, SystemPath, SystemPathBuf, UserConfigDirectoryOverrideGuard, file_time_now, +}; +use ruff_db::{Db as _, Upcast}; +use ruff_python_ast::PythonVersion; +use ty_project::metadata::options::{EnvironmentOptions, Options}; +use ty_project::metadata::pyproject::{PyProject, Tool}; +use ty_project::metadata::value::{RangedValue, RelativePathBuf}; +use ty_project::watch::{ChangeEvent, ProjectWatcher, directory_watcher}; +use ty_project::{Db, ProjectDatabase, ProjectMetadata}; +use ty_python_semantic::{ModuleName, PythonPlatform, resolve_module}; + +struct TestCase { + db: ProjectDatabase, + watcher: Option<ProjectWatcher>, + changes_receiver: crossbeam::channel::Receiver<Vec<ChangeEvent>>, + /// The temporary directory that contains the test files. + /// We need to hold on to it in the test case or the temp files get deleted. + _temp_dir: tempfile::TempDir, + root_dir: SystemPathBuf, +} + +impl TestCase { + fn project_path(&self, relative: impl AsRef<SystemPath>) -> SystemPathBuf { + SystemPath::absolute(relative, self.db.project().root(&self.db)) + } + + fn root_path(&self) -> &SystemPath { + &self.root_dir + } + + fn db(&self) -> &ProjectDatabase { + &self.db + } + + #[track_caller] + fn stop_watch<M>(&mut self, matcher: M) -> Vec<ChangeEvent> + where + M: MatchEvent, + { + // track_caller is unstable for lambdas -> That's why this is a fn + #[track_caller] + fn panic_with_formatted_events(events: Vec<ChangeEvent>) -> Vec<ChangeEvent> { + panic!( + "Didn't observe the expected event. The following events occurred:\n{}", + events + .into_iter() + .map(|event| format!(" - {event:?}")) + .collect::<Vec<_>>() + .join("\n") + ) + } + + self.try_stop_watch(matcher, Duration::from_secs(10)) + .unwrap_or_else(panic_with_formatted_events) + } + + fn try_stop_watch<M>( + &mut self, + mut matcher: M, + timeout: Duration, + ) -> Result<Vec<ChangeEvent>, Vec<ChangeEvent>> + where + M: MatchEvent, + { + tracing::debug!("Try stopping watch with timeout {:?}", timeout); + + let watcher = self + .watcher + .take() + .expect("Cannot call `stop_watch` more than once"); + + let start = Instant::now(); + let mut all_events = Vec::new(); + + loop { + let events = self + .changes_receiver + .recv_timeout(Duration::from_millis(100)) + .unwrap_or_default(); + + if events + .iter() + .any(|event| matcher.match_event(event) || event.is_rescan()) + { + all_events.extend(events); + break; + } + + all_events.extend(events); + + if start.elapsed() > timeout { + return Err(all_events); + } + } + + watcher.flush(); + tracing::debug!("Flushed file watcher"); + watcher.stop(); + tracing::debug!("Stopping file watcher"); + + // Consume remaining events + for event in &self.changes_receiver { + all_events.extend(event); + } + + Ok(all_events) + } + + fn take_watch_changes<M: MatchEvent>(&self, matcher: M) -> Vec<ChangeEvent> { + self.try_take_watch_changes(matcher, Duration::from_secs(10)) + .expect("Expected watch changes but observed none") + } + + fn try_take_watch_changes<M: MatchEvent>( + &self, + mut matcher: M, + timeout: Duration, + ) -> Result<Vec<ChangeEvent>, Vec<ChangeEvent>> { + let watcher = self + .watcher + .as_ref() + .expect("Cannot call `try_take_watch_changes` after `stop_watch`"); + + let start = Instant::now(); + let mut all_events = Vec::new(); + + loop { + let events = self + .changes_receiver + .recv_timeout(Duration::from_millis(100)) + .unwrap_or_default(); + + if events + .iter() + .any(|event| matcher.match_event(event) || event.is_rescan()) + { + all_events.extend(events); + break; + } + + all_events.extend(events); + + if start.elapsed() > timeout { + return Err(all_events); + } + } + + while let Ok(event) = self + .changes_receiver + .recv_timeout(Duration::from_millis(10)) + { + all_events.extend(event); + watcher.flush(); + } + + Ok(all_events) + } + + fn apply_changes(&mut self, changes: Vec<ChangeEvent>) { + self.db.apply_changes(changes, None); + } + + fn update_options(&mut self, options: Options) -> anyhow::Result<()> { + std::fs::write( + self.project_path("pyproject.toml").as_std_path(), + toml::to_string(&PyProject { + project: None, + tool: Some(Tool { ty: Some(options) }), + }) + .context("Failed to serialize options")?, + ) + .context("Failed to write configuration")?; + + let changes = self.take_watch_changes(event_for_file("pyproject.toml")); + self.apply_changes(changes); + + if let Some(watcher) = &mut self.watcher { + watcher.update(&self.db); + assert!(!watcher.has_errored_paths()); + } + + Ok(()) + } + + #[track_caller] + fn assert_indexed_project_files(&self, expected: impl IntoIterator<Item = File>) { + let mut expected: HashSet<_> = expected.into_iter().collect(); + + let actual = self.db().project().files(self.db()); + for file in &actual { + assert!( + expected.remove(&file), + "Indexed project files contains '{}' which was not expected.", + file.path(self.db()) + ); + } + + if !expected.is_empty() { + let paths: Vec<_> = expected + .iter() + .map(|file| file.path(self.db()).as_str()) + .collect(); + panic!( + "Indexed project files are missing the following files: {:?}", + paths.join(", ") + ); + } + } + + fn system_file(&self, path: impl AsRef<SystemPath>) -> Result<File, FileError> { + system_path_to_file(self.db(), path.as_ref()) + } +} + +trait MatchEvent { + fn match_event(&mut self, event: &ChangeEvent) -> bool; +} + +fn event_for_file(name: &str) -> impl MatchEvent + '_ { + |event: &ChangeEvent| event.file_name() == Some(name) +} + +impl<F> MatchEvent for F +where + F: FnMut(&ChangeEvent) -> bool, +{ + fn match_event(&mut self, event: &ChangeEvent) -> bool { + (*self)(event) + } +} + +trait Setup { + fn setup(self, context: &mut SetupContext) -> anyhow::Result<()>; +} + +struct SetupContext<'a> { + system: &'a OsSystem, + root_path: &'a SystemPath, + options: Option<Options>, + included_paths: Option<Vec<SystemPathBuf>>, +} + +impl<'a> SetupContext<'a> { + fn system(&self) -> &'a OsSystem { + self.system + } + + fn join_project_path(&self, relative: impl AsRef<SystemPath>) -> SystemPathBuf { + self.project_path().join(relative) + } + + fn project_path(&self) -> &SystemPath { + self.system.current_directory() + } + + fn root_path(&self) -> &'a SystemPath { + self.root_path + } + + fn join_root_path(&self, relative: impl AsRef<SystemPath>) -> SystemPathBuf { + self.root_path().join(relative) + } + + fn write_project_file( + &self, + relative_path: impl AsRef<SystemPath>, + content: &str, + ) -> anyhow::Result<()> { + let relative_path = relative_path.as_ref(); + let absolute_path = self.join_project_path(relative_path); + Self::write_file_impl(absolute_path, content) + } + + fn write_file( + &self, + relative_path: impl AsRef<SystemPath>, + content: &str, + ) -> anyhow::Result<()> { + let relative_path = relative_path.as_ref(); + let absolute_path = self.join_root_path(relative_path); + Self::write_file_impl(absolute_path, content) + } + + fn write_file_impl(path: impl AsRef<SystemPath>, content: &str) -> anyhow::Result<()> { + let path = path.as_ref(); + if let Some(parent) = path.parent() { + std::fs::create_dir_all(parent) + .with_context(|| format!("Failed to create parent directory for file `{path}`"))?; + } + + let mut file = std::fs::File::create(path.as_std_path()) + .with_context(|| format!("Failed to open file `{path}`"))?; + file.write_all(content.as_bytes()) + .with_context(|| format!("Failed to write to file `{path}`"))?; + file.sync_data()?; + + Ok(()) + } + + fn set_options(&mut self, options: Options) { + self.options = Some(options); + } + + fn set_included_paths(&mut self, paths: Vec<SystemPathBuf>) { + self.included_paths = Some(paths); + } +} + +impl<const N: usize, P> Setup for [(P, &'static str); N] +where + P: AsRef<SystemPath>, +{ + fn setup(self, context: &mut SetupContext) -> anyhow::Result<()> { + for (relative_path, content) in self { + context.write_project_file(relative_path, content)?; + } + + Ok(()) + } +} + +impl<F> Setup for F +where + F: FnOnce(&mut SetupContext) -> anyhow::Result<()>, +{ + fn setup(self, context: &mut SetupContext) -> anyhow::Result<()> { + self(context) + } +} + +fn setup<F>(setup_files: F) -> anyhow::Result<TestCase> +where + F: Setup, +{ + let temp_dir = tempfile::tempdir()?; + + let root_path = SystemPath::from_std_path(temp_dir.path()).ok_or_else(|| { + anyhow!( + "Temporary directory `{}` is not a valid UTF-8 path.", + temp_dir.path().display() + ) + })?; + + let root_path = SystemPathBuf::from_utf8_path_buf( + root_path + .as_utf8_path() + .canonicalize_utf8() + .with_context(|| "Failed to canonicalize root path.")?, + ) + .simplified() + .to_path_buf(); + + let project_path = root_path.join("project"); + + std::fs::create_dir_all(project_path.as_std_path()) + .with_context(|| format!("Failed to create project directory `{project_path}`"))?; + + let system = OsSystem::new(&project_path); + let mut setup_context = SetupContext { + system: &system, + root_path: &root_path, + options: None, + included_paths: None, + }; + + setup_files + .setup(&mut setup_context) + .context("Failed to setup test files")?; + + if let Some(options) = setup_context.options { + std::fs::write( + project_path.join("pyproject.toml").as_std_path(), + toml::to_string(&PyProject { + project: None, + tool: Some(Tool { ty: Some(options) }), + }) + .context("Failed to serialize options")?, + ) + .context("Failed to write configuration")?; + } + + let included_paths = setup_context.included_paths; + + let mut project = ProjectMetadata::discover(&project_path, &system)?; + project.apply_configuration_files(&system)?; + + let program_settings = project.to_program_settings(&system); + + for path in program_settings + .search_paths + .extra_paths + .iter() + .chain(program_settings.search_paths.custom_typeshed.as_ref()) + { + std::fs::create_dir_all(path.as_std_path()) + .with_context(|| format!("Failed to create search path `{path}`"))?; + } + + let mut db = ProjectDatabase::new(project, system)?; + + if let Some(included_paths) = included_paths { + db.project().set_included_paths(&mut db, included_paths); + } + + let (sender, receiver) = crossbeam::channel::unbounded(); + let watcher = directory_watcher(move |events| sender.send(events).unwrap()) + .with_context(|| "Failed to create directory watcher")?; + + let watcher = ProjectWatcher::new(watcher, &db); + assert!(!watcher.has_errored_paths()); + + let test_case = TestCase { + db, + changes_receiver: receiver, + watcher: Some(watcher), + _temp_dir: temp_dir, + root_dir: root_path, + }; + + // Sometimes the file watcher reports changes for events that happened before the watcher was started. + // Do a best effort at dropping these events. + let _ = + test_case.try_take_watch_changes(|_event: &ChangeEvent| true, Duration::from_millis(100)); + + Ok(test_case) +} + +/// Updates the content of a file and ensures that the last modified file time is updated. +fn update_file(path: impl AsRef<SystemPath>, content: &str) -> anyhow::Result<()> { + let path = path.as_ref().as_std_path(); + + let metadata = path.metadata()?; + let last_modified_time = filetime::FileTime::from_last_modification_time(&metadata); + + let mut file = std::fs::OpenOptions::new() + .create(false) + .write(true) + .truncate(true) + .open(path)?; + file.write_all(content.as_bytes())?; + + loop { + file.sync_all()?; + + let modified_time = filetime::FileTime::from_last_modification_time(&path.metadata()?); + + if modified_time != last_modified_time { + break Ok(()); + } + + std::thread::sleep(Duration::from_nanos(10)); + + filetime::set_file_handle_times(&file, None, Some(file_time_now()))?; + } +} + +#[test] +fn new_file() -> anyhow::Result<()> { + let mut case = setup([("bar.py", "")])?; + let bar_path = case.project_path("bar.py"); + let bar_file = case.system_file(&bar_path).unwrap(); + let foo_path = case.project_path("foo.py"); + + assert_eq!(case.system_file(&foo_path), Err(FileError::NotFound)); + case.assert_indexed_project_files([bar_file]); + + std::fs::write(foo_path.as_std_path(), "print('Hello')")?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + let foo = case.system_file(&foo_path).expect("foo.py to exist."); + + case.assert_indexed_project_files([bar_file, foo]); + + Ok(()) +} + +#[test] +fn new_ignored_file() -> anyhow::Result<()> { + let mut case = setup([("bar.py", ""), (".ignore", "foo.py")])?; + let bar_path = case.project_path("bar.py"); + let bar_file = case.system_file(&bar_path).unwrap(); + let foo_path = case.project_path("foo.py"); + + assert_eq!(case.system_file(&foo_path), Err(FileError::NotFound)); + case.assert_indexed_project_files([bar_file]); + + std::fs::write(foo_path.as_std_path(), "print('Hello')")?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + assert!(case.system_file(&foo_path).is_ok()); + case.assert_indexed_project_files([bar_file]); + + Ok(()) +} + +#[test] +fn new_non_project_file() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + context.write_project_file("bar.py", "")?; + context.set_options(Options { + environment: Some(EnvironmentOptions { + extra_paths: Some(vec![RelativePathBuf::cli( + context.join_root_path("site_packages"), + )]), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + Ok(()) + })?; + + let bar_path = case.project_path("bar.py"); + let bar_file = case.system_file(&bar_path).unwrap(); + + case.assert_indexed_project_files([bar_file]); + + // Add a file to site packages + let black_path = case.root_path().join("site_packages/black.py"); + std::fs::write(black_path.as_std_path(), "print('Hello')")?; + + let changes = case.stop_watch(event_for_file("black.py")); + + case.apply_changes(changes); + + assert!(case.system_file(&black_path).is_ok()); + + // The file should not have been added to the project files + case.assert_indexed_project_files([bar_file]); + + Ok(()) +} + +#[test] +fn new_files_with_explicit_included_paths() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + context.write_project_file("src/main.py", "")?; + context.write_project_file("src/sub/__init__.py", "")?; + context.write_project_file("src/test.py", "")?; + context.set_included_paths(vec![ + context.join_project_path("src/main.py"), + context.join_project_path("src/sub"), + ]); + Ok(()) + })?; + + let main_path = case.project_path("src/main.py"); + let main_file = case.system_file(&main_path).unwrap(); + + let sub_init_path = case.project_path("src/sub/__init__.py"); + let sub_init = case.system_file(&sub_init_path).unwrap(); + + case.assert_indexed_project_files([main_file, sub_init]); + + // Write a new file to `sub` which is an included path + let sub_a_path = case.project_path("src/sub/a.py"); + std::fs::write(sub_a_path.as_std_path(), "print('Hello')")?; + + // and write a second file in the root directory -- this should not be included + let test2_path = case.project_path("src/test2.py"); + std::fs::write(test2_path.as_std_path(), "print('Hello')")?; + + let changes = case.stop_watch(event_for_file("test2.py")); + + case.apply_changes(changes); + + let sub_a_file = case.system_file(&sub_a_path).expect("sub/a.py to exist"); + + case.assert_indexed_project_files([main_file, sub_init, sub_a_file]); + + Ok(()) +} + +#[test] +fn new_file_in_included_out_of_project_directory() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + context.write_project_file("src/main.py", "")?; + context.write_project_file("script.py", "")?; + context.write_file("outside_project/a.py", "")?; + + context.set_included_paths(vec![ + context.join_root_path("outside_project"), + context.join_project_path("src"), + ]); + Ok(()) + })?; + + let main_path = case.project_path("src/main.py"); + let main_file = case.system_file(&main_path).unwrap(); + + let outside_a_path = case.root_path().join("outside_project/a.py"); + let outside_a = case.system_file(&outside_a_path).unwrap(); + + case.assert_indexed_project_files([outside_a, main_file]); + + // Write a new file to `src` which should be watched + let src_a = case.project_path("src/a.py"); + std::fs::write(src_a.as_std_path(), "print('Hello')")?; + + // and write a second file to `outside_project` which should be watched too + let outside_b_path = case.root_path().join("outside_project/b.py"); + std::fs::write(outside_b_path.as_std_path(), "print('Hello')")?; + + // and a third file in the project's root that should not be included + let script2_path = case.project_path("script2.py"); + std::fs::write(script2_path.as_std_path(), "print('Hello')")?; + + let changes = case.stop_watch(event_for_file("script2.py")); + + case.apply_changes(changes); + + let src_a_file = case.system_file(&src_a).unwrap(); + let outside_b_file = case.system_file(&outside_b_path).unwrap(); + + // The file should not have been added to the project files + case.assert_indexed_project_files([main_file, outside_a, outside_b_file, src_a_file]); + + Ok(()) +} + +#[test] +fn changed_file() -> anyhow::Result<()> { + let foo_source = "print('Hello, world!')"; + let mut case = setup([("foo.py", foo_source)])?; + let foo_path = case.project_path("foo.py"); + + let foo = case.system_file(&foo_path)?; + assert_eq!(source_text(case.db(), foo).as_str(), foo_source); + case.assert_indexed_project_files([foo]); + + update_file(&foo_path, "print('Version 2')")?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + assert!(!changes.is_empty()); + + case.apply_changes(changes); + + assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 2')"); + case.assert_indexed_project_files([foo]); + + Ok(()) +} + +#[test] +fn deleted_file() -> anyhow::Result<()> { + let foo_source = "print('Hello, world!')"; + let mut case = setup([("foo.py", foo_source)])?; + let foo_path = case.project_path("foo.py"); + + let foo = case.system_file(&foo_path)?; + + assert!(foo.exists(case.db())); + case.assert_indexed_project_files([foo]); + + std::fs::remove_file(foo_path.as_std_path())?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + assert!(!foo.exists(case.db())); + case.assert_indexed_project_files([]); + + Ok(()) +} + +/// Tests the case where a file is moved from inside a watched directory to a directory that is not watched. +/// +/// This matches the behavior of deleting a file in VS code. +#[test] +fn move_file_to_trash() -> anyhow::Result<()> { + let foo_source = "print('Hello, world!')"; + let mut case = setup([("foo.py", foo_source)])?; + let foo_path = case.project_path("foo.py"); + + let trash_path = case.root_path().join(".trash"); + std::fs::create_dir_all(trash_path.as_std_path())?; + + let foo = case.system_file(&foo_path)?; + + assert!(foo.exists(case.db())); + case.assert_indexed_project_files([foo]); + + std::fs::rename( + foo_path.as_std_path(), + trash_path.join("foo.py").as_std_path(), + )?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + assert!(!foo.exists(case.db())); + case.assert_indexed_project_files([]); + + Ok(()) +} + +/// Move a file from a non-project (non-watched) location into the project. +#[test] +fn move_file_to_project() -> anyhow::Result<()> { + let mut case = setup([("bar.py", "")])?; + let bar_path = case.project_path("bar.py"); + let bar = case.system_file(&bar_path).unwrap(); + + let foo_path = case.root_path().join("foo.py"); + std::fs::write(foo_path.as_std_path(), "")?; + + let foo_in_project = case.project_path("foo.py"); + + assert!(case.system_file(&foo_path).is_ok()); + case.assert_indexed_project_files([bar]); + + std::fs::rename(foo_path.as_std_path(), foo_in_project.as_std_path())?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + let foo_in_project = case.system_file(&foo_in_project)?; + + assert!(foo_in_project.exists(case.db())); + case.assert_indexed_project_files([bar, foo_in_project]); + + Ok(()) +} + +/// Rename a project file. +#[test] +fn rename_file() -> anyhow::Result<()> { + let mut case = setup([("foo.py", "")])?; + let foo_path = case.project_path("foo.py"); + let bar_path = case.project_path("bar.py"); + + let foo = case.system_file(&foo_path)?; + + case.assert_indexed_project_files([foo]); + + std::fs::rename(foo_path.as_std_path(), bar_path.as_std_path())?; + + let changes = case.stop_watch(event_for_file("bar.py")); + + case.apply_changes(changes); + + assert!(!foo.exists(case.db())); + + let bar = case.system_file(&bar_path)?; + + assert!(bar.exists(case.db())); + case.assert_indexed_project_files([bar]); + + Ok(()) +} + +#[test] +fn directory_moved_to_project() -> anyhow::Result<()> { + let mut case = setup([("bar.py", "import sub.a")])?; + let bar = case.system_file(case.project_path("bar.py")).unwrap(); + + let sub_original_path = case.root_path().join("sub"); + let init_original_path = sub_original_path.join("__init__.py"); + let a_original_path = sub_original_path.join("a.py"); + + std::fs::create_dir(sub_original_path.as_std_path()) + .with_context(|| "Failed to create sub directory")?; + std::fs::write(init_original_path.as_std_path(), "") + .with_context(|| "Failed to create __init__.py")?; + std::fs::write(a_original_path.as_std_path(), "").with_context(|| "Failed to create a.py")?; + + let sub_a_module = resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap(), + ); + + assert_eq!(sub_a_module, None); + case.assert_indexed_project_files([bar]); + + let sub_new_path = case.project_path("sub"); + std::fs::rename(sub_original_path.as_std_path(), sub_new_path.as_std_path()) + .with_context(|| "Failed to move sub directory")?; + + let changes = case.stop_watch(event_for_file("sub")); + + case.apply_changes(changes); + + let init_file = case + .system_file(sub_new_path.join("__init__.py")) + .expect("__init__.py to exist"); + let a_file = case + .system_file(sub_new_path.join("a.py")) + .expect("a.py to exist"); + + // `import sub.a` should now resolve + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_some() + ); + + case.assert_indexed_project_files([bar, init_file, a_file]); + + Ok(()) +} + +#[test] +fn directory_moved_to_trash() -> anyhow::Result<()> { + let mut case = setup([ + ("bar.py", "import sub.a"), + ("sub/__init__.py", ""), + ("sub/a.py", ""), + ])?; + let bar = case.system_file(case.project_path("bar.py")).unwrap(); + + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_some() + ); + + let sub_path = case.project_path("sub"); + let init_file = case + .system_file(sub_path.join("__init__.py")) + .expect("__init__.py to exist"); + let a_file = case + .system_file(sub_path.join("a.py")) + .expect("a.py to exist"); + + case.assert_indexed_project_files([bar, init_file, a_file]); + + std::fs::create_dir(case.root_path().join(".trash").as_std_path())?; + let trashed_sub = case.root_path().join(".trash/sub"); + std::fs::rename(sub_path.as_std_path(), trashed_sub.as_std_path()) + .with_context(|| "Failed to move the sub directory to the trash")?; + + let changes = case.stop_watch(event_for_file("sub")); + + case.apply_changes(changes); + + // `import sub.a` should no longer resolve + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_none() + ); + + assert!(!init_file.exists(case.db())); + assert!(!a_file.exists(case.db())); + + case.assert_indexed_project_files([bar]); + + Ok(()) +} + +#[test] +fn directory_renamed() -> anyhow::Result<()> { + let mut case = setup([ + ("bar.py", "import sub.a"), + ("sub/__init__.py", ""), + ("sub/a.py", ""), + ])?; + + let bar = case.system_file(case.project_path("bar.py")).unwrap(); + + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_some() + ); + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("foo.baz").unwrap() + ) + .is_none() + ); + + let sub_path = case.project_path("sub"); + let sub_init = case + .system_file(sub_path.join("__init__.py")) + .expect("__init__.py to exist"); + let sub_a = case + .system_file(sub_path.join("a.py")) + .expect("a.py to exist"); + + case.assert_indexed_project_files([bar, sub_init, sub_a]); + + let foo_baz = case.project_path("foo/baz"); + + std::fs::create_dir(case.project_path("foo").as_std_path())?; + std::fs::rename(sub_path.as_std_path(), foo_baz.as_std_path()) + .with_context(|| "Failed to move the sub directory")?; + + // Linux and windows only emit an event for the newly created root directory, but not for every new component. + let changes = case.stop_watch(event_for_file("sub")); + + case.apply_changes(changes); + + // `import sub.a` should no longer resolve + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_none() + ); + // `import foo.baz` should now resolve + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("foo.baz").unwrap() + ) + .is_some() + ); + + // The old paths are no longer tracked + assert!(!sub_init.exists(case.db())); + assert!(!sub_a.exists(case.db())); + + let foo_baz_init = case + .system_file(foo_baz.join("__init__.py")) + .expect("__init__.py to exist"); + let foo_baz_a = case + .system_file(foo_baz.join("a.py")) + .expect("a.py to exist"); + + // The new paths are synced + + assert!(foo_baz_init.exists(case.db())); + assert!(foo_baz_a.exists(case.db())); + + case.assert_indexed_project_files([bar, foo_baz_init, foo_baz_a]); + + Ok(()) +} + +#[test] +fn directory_deleted() -> anyhow::Result<()> { + let mut case = setup([ + ("bar.py", "import sub.a"), + ("sub/__init__.py", ""), + ("sub/a.py", ""), + ])?; + + let bar = case.system_file(case.project_path("bar.py")).unwrap(); + + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_some() + ); + + let sub_path = case.project_path("sub"); + + let init_file = case + .system_file(sub_path.join("__init__.py")) + .expect("__init__.py to exist"); + let a_file = case + .system_file(sub_path.join("a.py")) + .expect("a.py to exist"); + case.assert_indexed_project_files([bar, init_file, a_file]); + + std::fs::remove_dir_all(sub_path.as_std_path()) + .with_context(|| "Failed to remove the sub directory")?; + + let changes = case.stop_watch(event_for_file("sub")); + + case.apply_changes(changes); + + // `import sub.a` should no longer resolve + assert!( + resolve_module( + case.db().upcast(), + &ModuleName::new_static("sub.a").unwrap() + ) + .is_none() + ); + + assert!(!init_file.exists(case.db())); + assert!(!a_file.exists(case.db())); + case.assert_indexed_project_files([bar]); + + Ok(()) +} + +#[test] +fn search_path() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + context.write_project_file("bar.py", "import sub.a")?; + + context.set_options(Options { + environment: Some(EnvironmentOptions { + extra_paths: Some(vec![RelativePathBuf::cli( + context.join_root_path("site_packages"), + )]), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + Ok(()) + })?; + + let site_packages = case.root_path().join("site_packages"); + + assert_eq!( + resolve_module(case.db(), &ModuleName::new("a").unwrap()), + None + ); + + std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; + + let changes = case.stop_watch(event_for_file("a.py")); + + case.apply_changes(changes); + + assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_some()); + case.assert_indexed_project_files([case.system_file(case.project_path("bar.py")).unwrap()]); + + Ok(()) +} + +#[test] +fn add_search_path() -> anyhow::Result<()> { + let mut case = setup([("bar.py", "import sub.a")])?; + + let site_packages = case.project_path("site_packages"); + std::fs::create_dir_all(site_packages.as_std_path())?; + + assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_none()); + + // Register site-packages as a search path. + case.update_options(Options { + environment: Some(EnvironmentOptions { + extra_paths: Some(vec![RelativePathBuf::cli("site_packages")]), + ..EnvironmentOptions::default() + }), + ..Options::default() + }) + .expect("Search path settings to be valid"); + + std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; + + let changes = case.stop_watch(event_for_file("a.py")); + + case.apply_changes(changes); + + assert!(resolve_module(case.db().upcast(), &ModuleName::new_static("a").unwrap()).is_some()); + + Ok(()) +} + +#[test] +fn remove_search_path() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + context.write_project_file("bar.py", "import sub.a")?; + context.set_options(Options { + environment: Some(EnvironmentOptions { + extra_paths: Some(vec![RelativePathBuf::cli( + context.join_root_path("site_packages"), + )]), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + Ok(()) + })?; + + // Remove site packages from the search path settings. + let site_packages = case.root_path().join("site_packages"); + + case.update_options(Options { + environment: None, + ..Options::default() + }) + .expect("Search path settings to be valid"); + + std::fs::write(site_packages.join("a.py").as_std_path(), "class A: ...")?; + + let changes = case.try_stop_watch(|_: &ChangeEvent| true, Duration::from_millis(100)); + + assert_eq!(changes, Err(vec![])); + + Ok(()) +} + +#[test] +fn change_python_version_and_platform() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + // `sys.last_exc` is a Python 3.12 only feature + // `os.getegid()` is Unix only + context.write_project_file( + "bar.py", + r#" +import sys +import os +print(sys.last_exc, os.getegid()) +"#, + )?; + context.set_options(Options { + environment: Some(EnvironmentOptions { + python_version: Some(RangedValue::cli(PythonVersion::PY311)), + python_platform: Some(RangedValue::cli(PythonPlatform::Identifier( + "win32".to_string(), + ))), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + Ok(()) + })?; + + let diagnostics = case.db.check().context("Failed to check project.")?; + + assert_eq!(diagnostics.len(), 2); + assert_eq!( + diagnostics[0].primary_message(), + "Type `<module 'sys'>` has no attribute `last_exc`" + ); + assert_eq!( + diagnostics[1].primary_message(), + "Type `<module 'os'>` has no attribute `getegid`" + ); + + // Change the python version + case.update_options(Options { + environment: Some(EnvironmentOptions { + python_version: Some(RangedValue::cli(PythonVersion::PY312)), + python_platform: Some(RangedValue::cli(PythonPlatform::Identifier( + "linux".to_string(), + ))), + ..EnvironmentOptions::default() + }), + ..Options::default() + }) + .expect("Search path settings to be valid"); + + let diagnostics = case.db.check().context("Failed to check project.")?; + assert!(diagnostics.is_empty()); + + Ok(()) +} + +#[test] +fn changed_versions_file() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + std::fs::write( + context.join_project_path("bar.py").as_std_path(), + "import sub.a", + )?; + std::fs::create_dir_all(context.join_root_path("typeshed/stdlib").as_std_path())?; + std::fs::write( + context + .join_root_path("typeshed/stdlib/VERSIONS") + .as_std_path(), + "", + )?; + std::fs::write( + context + .join_root_path("typeshed/stdlib/os.pyi") + .as_std_path(), + "# not important", + )?; + + context.set_options(Options { + environment: Some(EnvironmentOptions { + typeshed: Some(RelativePathBuf::cli(context.join_root_path("typeshed"))), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + Ok(()) + })?; + + // Unset the custom typeshed directory. + assert_eq!( + resolve_module(case.db(), &ModuleName::new("os").unwrap()), + None + ); + + std::fs::write( + case.root_path() + .join("typeshed/stdlib/VERSIONS") + .as_std_path(), + "os: 3.0-", + )?; + + let changes = case.stop_watch(event_for_file("VERSIONS")); + + case.apply_changes(changes); + + assert!(resolve_module(case.db(), &ModuleName::new("os").unwrap()).is_some()); + + Ok(()) +} + +/// Watch a project that contains two files where one file is a hardlink to another. +/// +/// Setup: +/// ```text +/// - project +/// |- foo.py +/// |- bar.py (hard link to foo.py) +/// ``` +/// +/// # Linux +/// `inotify` only emits a single change event for the file that was changed. +/// Other files that point to the same inode (hardlinks) won't get updated. +/// +/// For reference: VS Code and PyCharm have the same behavior where the results for one of the +/// files are stale. +/// +/// # Windows +/// I haven't found any documentation that states the notification behavior on Windows but what +/// we're seeing is that Windows only emits a single event, similar to Linux. +#[test] +fn hard_links_in_project() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + let foo_path = context.join_project_path("foo.py"); + std::fs::write(foo_path.as_std_path(), "print('Version 1')")?; + + // Create a hardlink to `foo` + let bar_path = context.join_project_path("bar.py"); + std::fs::hard_link(foo_path.as_std_path(), bar_path.as_std_path()) + .context("Failed to create hard link from foo.py -> bar.py")?; + + Ok(()) + })?; + + let foo_path = case.project_path("foo.py"); + let foo = case.system_file(&foo_path).unwrap(); + let bar_path = case.project_path("bar.py"); + let bar = case.system_file(&bar_path).unwrap(); + + assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 1')"); + assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 1')"); + case.assert_indexed_project_files([bar, foo]); + + // Write to the hard link target. + update_file(foo_path, "print('Version 2')").context("Failed to update foo.py")?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 2')"); + + // macOS is the only platform that emits events for every hardlink. + if cfg!(target_os = "macos") { + assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 2')"); + } + + Ok(()) +} + +/// Watch a project that contains one file that is a hardlink to a file outside the project. +/// +/// Setup: +/// ```text +/// - foo.py +/// - project +/// |- bar.py (hard link to /foo.py) +/// ``` +/// +/// # Linux +/// inotiyf doesn't support observing changes to hard linked files. +/// +/// > Note: when monitoring a directory, events are not generated for +/// > the files inside the directory when the events are performed via +/// > a pathname (i.e., a link) that lies outside the monitored +/// > directory. [source](https://man7.org/linux/man-pages/man7/inotify.7.html) +/// +/// # Windows +/// > Retrieves information that describes the changes within the specified directory. +/// +/// [source](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-readdirectorychangesw) +/// +/// My interpretation of this is that Windows doesn't support observing changes made to +/// hard linked files outside the project. +#[test] +#[cfg_attr( + target_os = "linux", + ignore = "inotify doesn't support observing changes to hard linked files." +)] +#[cfg_attr( + target_os = "windows", + ignore = "windows doesn't support observing changes to hard linked files." +)] +fn hard_links_to_target_outside_project() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + let foo_path = context.join_root_path("foo.py"); + std::fs::write(foo_path.as_std_path(), "print('Version 1')")?; + + // Create a hardlink to `foo` + let bar_path = context.join_project_path("bar.py"); + std::fs::hard_link(foo_path.as_std_path(), bar_path.as_std_path()) + .context("Failed to create hard link from foo.py -> bar.py")?; + + Ok(()) + })?; + + let foo_path = case.root_path().join("foo.py"); + let foo = case.system_file(&foo_path).unwrap(); + let bar_path = case.project_path("bar.py"); + let bar = case.system_file(&bar_path).unwrap(); + + assert_eq!(source_text(case.db(), foo).as_str(), "print('Version 1')"); + assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 1')"); + + // Write to the hard link target. + update_file(foo_path, "print('Version 2')").context("Failed to update foo.py")?; + + let changes = case.stop_watch(ChangeEvent::is_changed); + + case.apply_changes(changes); + + assert_eq!(source_text(case.db(), bar).as_str(), "print('Version 2')"); + + Ok(()) +} + +#[cfg(unix)] +mod unix { + //! Tests that make use of unix specific file-system features. + use super::*; + + /// Changes the metadata of the only file in the project. + #[test] + fn changed_metadata() -> anyhow::Result<()> { + use std::os::unix::fs::PermissionsExt; + + let mut case = setup([("foo.py", "")])?; + let foo_path = case.project_path("foo.py"); + + let foo = case.system_file(&foo_path)?; + assert_eq!( + foo.permissions(case.db()), + Some( + std::fs::metadata(foo_path.as_std_path()) + .unwrap() + .permissions() + .mode() + ) + ); + + std::fs::set_permissions( + foo_path.as_std_path(), + std::fs::Permissions::from_mode(0o777), + ) + .with_context(|| "Failed to set file permissions.")?; + + let changes = case.stop_watch(event_for_file("foo.py")); + + case.apply_changes(changes); + + assert_eq!( + foo.permissions(case.db()), + Some( + std::fs::metadata(foo_path.as_std_path()) + .unwrap() + .permissions() + .mode() + ) + ); + + Ok(()) + } + + /// A project path is a symlink to a file outside the project. + /// + /// Setup: + /// ```text + /// - bar + /// |- baz.py + /// + /// - project + /// |- bar -> /bar + /// ``` + /// + /// # macOS + /// This test case isn't supported on macOS. + /// macOS uses `FSEvents` and `FSEvents` doesn't emit an event if a file in a symlinked directory is changed. + /// + /// > Generally speaking, when working with file system event notifications, you will probably want to use lstat, + /// > because changes to the underlying file will not result in a change notification for the directory containing + /// > the symbolic link to that file. However, if you are working with a controlled file structure in + /// > which symbolic links always point within your watched tree, you might have reason to use stat. + /// + /// [source](https://developer.apple.com/library/archive/documentation/Darwin/Conceptual/FSEvents_ProgGuide/UsingtheFSEventsFramework/UsingtheFSEventsFramework.html#//apple_ref/doc/uid/TP40005289-CH4-SW4) + /// + /// Pyright also does not support this case. + #[test] + #[cfg_attr( + target_os = "macos", + ignore = "FSEvents doesn't emit change events for symlinked directories outside of the watched paths." + )] + fn symlink_target_outside_watched_paths() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + // Set up the symlink target. + let link_target = context.join_root_path("bar"); + std::fs::create_dir_all(link_target.as_std_path()) + .context("Failed to create link target directory")?; + let baz_original = link_target.join("baz.py"); + std::fs::write(baz_original.as_std_path(), "def baz(): ...") + .context("Failed to write link target file")?; + + // Create a symlink inside the project + let bar = context.join_project_path("bar"); + std::os::unix::fs::symlink(link_target.as_std_path(), bar.as_std_path()) + .context("Failed to create symlink to bar package")?; + + Ok(()) + })?; + + let baz = resolve_module( + case.db().upcast(), + &ModuleName::new_static("bar.baz").unwrap(), + ) + .expect("Expected bar.baz to exist in site-packages."); + let baz_project = case.project_path("bar/baz.py"); + let baz_file = baz.file().unwrap(); + + assert_eq!(source_text(case.db(), baz_file).as_str(), "def baz(): ..."); + assert_eq!( + baz_file.path(case.db()).as_system_path(), + Some(&*baz_project) + ); + + let baz_original = case.root_path().join("bar/baz.py"); + + // Write to the symlink target. + update_file(baz_original, "def baz(): print('Version 2')") + .context("Failed to update bar/baz.py")?; + + let changes = case.take_watch_changes(event_for_file("baz.py")); + + case.apply_changes(changes); + + assert_eq!( + source_text(case.db(), baz_file).as_str(), + "def baz(): print('Version 2')" + ); + + // Write to the symlink source. + update_file(baz_project, "def baz(): print('Version 3')") + .context("Failed to update bar/baz.py")?; + + let changes = case.stop_watch(event_for_file("baz.py")); + + case.apply_changes(changes); + + assert_eq!( + source_text(case.db(), baz_file).as_str(), + "def baz(): print('Version 3')" + ); + + Ok(()) + } + + /// Project contains a symlink to another directory inside the project. + /// Changes to files in the symlinked directory should be reflected + /// to all files. + /// + /// Setup: + /// ```text + /// - project + /// | - bar -> /project/patched/bar + /// | + /// | - patched + /// | |-- bar + /// | | |- baz.py + /// | + /// |-- foo.py + /// ``` + #[test] + fn symlink_inside_project() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + // Set up the symlink target. + let link_target = context.join_project_path("patched/bar"); + std::fs::create_dir_all(link_target.as_std_path()) + .context("Failed to create link target directory")?; + let baz_original = link_target.join("baz.py"); + std::fs::write(baz_original.as_std_path(), "def baz(): ...") + .context("Failed to write link target file")?; + + // Create a symlink inside site-packages + let bar_in_project = context.join_project_path("bar"); + std::os::unix::fs::symlink(link_target.as_std_path(), bar_in_project.as_std_path()) + .context("Failed to create symlink to bar package")?; + + Ok(()) + })?; + + let baz = resolve_module( + case.db().upcast(), + &ModuleName::new_static("bar.baz").unwrap(), + ) + .expect("Expected bar.baz to exist in site-packages."); + let baz_file = baz.file().unwrap(); + let bar_baz = case.project_path("bar/baz.py"); + + let patched_bar_baz = case.project_path("patched/bar/baz.py"); + let patched_bar_baz_file = case.system_file(&patched_bar_baz).unwrap(); + + assert_eq!( + source_text(case.db(), patched_bar_baz_file).as_str(), + "def baz(): ..." + ); + + assert_eq!(source_text(case.db(), baz_file).as_str(), "def baz(): ..."); + assert_eq!(baz_file.path(case.db()).as_system_path(), Some(&*bar_baz)); + + case.assert_indexed_project_files([patched_bar_baz_file]); + + // Write to the symlink target. + update_file(&patched_bar_baz, "def baz(): print('Version 2')") + .context("Failed to update bar/baz.py")?; + + let changes = case.stop_watch(event_for_file("baz.py")); + + case.apply_changes(changes); + + // The file watcher is guaranteed to emit one event for the changed file, but it isn't specified + // if the event is emitted for the "original" or linked path because both paths are watched. + // The best we can assert here is that one of the files should have been updated. + // + // In a perfect world, the file watcher would emit two events, one for the original file and + // one for the symlink. I tried parcel/watcher, node's `fs.watch` and `chokidar` and + // only `chokidar seems to support it (used by Pyright). + // + // I further tested how good editor support is for symlinked files and it is not good ;) + // * VS Code doesn't update the file content if a file gets changed through a symlink + // * PyCharm doesn't update diagnostics if a symlinked module is changed (same as ty). + // + // That's why I think it's fine to not support this case for now. + + let patched_baz_text = source_text(case.db(), patched_bar_baz_file); + let did_update_patched_baz = patched_baz_text.as_str() == "def baz(): print('Version 2')"; + + let bar_baz_text = source_text(case.db(), baz_file); + let did_update_bar_baz = bar_baz_text.as_str() == "def baz(): print('Version 2')"; + + assert!( + did_update_patched_baz || did_update_bar_baz, + "Expected one of the files to be updated but neither file was updated.\nOriginal: {patched_baz_text}\nSymlinked: {bar_baz_text}", + patched_baz_text = patched_baz_text.as_str(), + bar_baz_text = bar_baz_text.as_str() + ); + + case.assert_indexed_project_files([patched_bar_baz_file]); + Ok(()) + } + + /// A module search path is a symlink. + /// + /// Setup: + /// ```text + /// - site-packages + /// | - bar/baz.py + /// + /// - project + /// |-- .venv/lib/python3.12/site-packages -> /site-packages + /// | + /// |-- foo.py + /// ``` + #[test] + fn symlinked_module_search_path() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + // Set up the symlink target. + let site_packages = context.join_root_path("site-packages"); + let bar = site_packages.join("bar"); + std::fs::create_dir_all(bar.as_std_path()).context("Failed to create bar directory")?; + let baz_original = bar.join("baz.py"); + std::fs::write(baz_original.as_std_path(), "def baz(): ...") + .context("Failed to write baz.py")?; + + // Symlink the site packages in the venv to the global site packages + let venv_site_packages = + context.join_project_path(".venv/lib/python3.12/site-packages"); + std::fs::create_dir_all(venv_site_packages.parent().unwrap()) + .context("Failed to create .venv directory")?; + std::os::unix::fs::symlink( + site_packages.as_std_path(), + venv_site_packages.as_std_path(), + ) + .context("Failed to create symlink to site-packages")?; + + context.set_options(Options { + environment: Some(EnvironmentOptions { + extra_paths: Some(vec![RelativePathBuf::cli( + ".venv/lib/python3.12/site-packages", + )]), + python_version: Some(RangedValue::cli(PythonVersion::PY312)), + ..EnvironmentOptions::default() + }), + ..Options::default() + }); + + Ok(()) + })?; + + let baz = resolve_module( + case.db().upcast(), + &ModuleName::new_static("bar.baz").unwrap(), + ) + .expect("Expected bar.baz to exist in site-packages."); + let baz_site_packages_path = + case.project_path(".venv/lib/python3.12/site-packages/bar/baz.py"); + let baz_site_packages = case.system_file(&baz_site_packages_path).unwrap(); + let baz_original = case.root_path().join("site-packages/bar/baz.py"); + let baz_original_file = case.system_file(&baz_original).unwrap(); + + assert_eq!( + source_text(case.db(), baz_original_file).as_str(), + "def baz(): ..." + ); + + assert_eq!( + source_text(case.db(), baz_site_packages).as_str(), + "def baz(): ..." + ); + assert_eq!( + baz.file().unwrap().path(case.db()).as_system_path(), + Some(&*baz_original) + ); + + case.assert_indexed_project_files([]); + + // Write to the symlink target. + update_file(&baz_original, "def baz(): print('Version 2')") + .context("Failed to update bar/baz.py")?; + + let changes = case.stop_watch(event_for_file("baz.py")); + + case.apply_changes(changes); + + assert_eq!( + source_text(case.db(), baz_original_file).as_str(), + "def baz(): print('Version 2')" + ); + + // It would be nice if this is supported but the underlying file system watchers + // only emit a single event. For reference + // * VS Code doesn't update the file content if a file gets changed through a symlink + // * PyCharm doesn't update diagnostics if a symlinked module is changed (same as ty). + // We could add support for it by keeping a reverse map from `real_path` to symlinked path but + // it doesn't seem worth doing considering that as prominent tools like PyCharm don't support it. + // Pyright does support it, thanks to chokidar. + assert_ne!( + source_text(case.db(), baz_site_packages).as_str(), + "def baz(): print('Version 2')" + ); + + case.assert_indexed_project_files([]); + + Ok(()) + } +} + +#[test] +fn nested_projects_delete_root() -> anyhow::Result<()> { + let mut case = setup(|context: &mut SetupContext| { + std::fs::write( + context.join_project_path("pyproject.toml").as_std_path(), + r#" + [project] + name = "inner" + + [tool.ty] + "#, + )?; + + std::fs::write( + context.join_root_path("pyproject.toml").as_std_path(), + r#" + [project] + name = "outer" + + [tool.ty] + "#, + )?; + + Ok(()) + })?; + + assert_eq!(case.db().project().root(case.db()), &*case.project_path("")); + + std::fs::remove_file(case.project_path("pyproject.toml").as_std_path())?; + + let changes = case.stop_watch(ChangeEvent::is_deleted); + + case.apply_changes(changes); + + // It should now pick up the outer project. + assert_eq!(case.db().project().root(case.db()), case.root_path()); + + Ok(()) +} + +#[test] +fn changes_to_user_configuration() -> anyhow::Result<()> { + let mut _config_dir_override: Option<UserConfigDirectoryOverrideGuard> = None; + + let mut case = setup(|context: &mut SetupContext| { + std::fs::write( + context.join_project_path("pyproject.toml").as_std_path(), + r#" + [project] + name = "test" + "#, + )?; + + std::fs::write( + context.join_project_path("foo.py").as_std_path(), + "a = 10 / 0", + )?; + + let config_directory = context.join_root_path("home/.config"); + std::fs::create_dir_all(config_directory.join("ty").as_std_path())?; + std::fs::write( + config_directory.join("ty/ty.toml").as_std_path(), + r#" + [rules] + division-by-zero = "ignore" + "#, + )?; + + _config_dir_override = Some( + context + .system() + .with_user_config_directory(Some(config_directory)), + ); + + Ok(()) + })?; + + let foo = case + .system_file(case.project_path("foo.py")) + .expect("foo.py to exist"); + let diagnostics = case + .db() + .check_file(foo) + .context("Failed to check project.")?; + + assert!( + diagnostics.is_empty(), + "Expected no diagnostics but got: {diagnostics:#?}" + ); + + // Enable division-by-zero in the user configuration with warning severity + update_file( + case.root_path().join("home/.config/ty/ty.toml"), + r#" + [rules] + division-by-zero = "warn" + "#, + )?; + + let changes = case.stop_watch(event_for_file("ty.toml")); + + case.apply_changes(changes); + + let diagnostics = case + .db() + .check_file(foo) + .context("Failed to check project.")?; + + assert!( + diagnostics.len() == 1, + "Expected exactly one diagnostic but got: {diagnostics:#?}" + ); + + Ok(()) +} + +/// Tests that renaming a file from `lib.py` to `Lib.py` is correctly reflected. +/// +/// This test currently fails on case-insensitive systems because `Files` is case-sensitive +/// but the `System::metadata` call isn't. This means that +/// ty considers both `Lib.py` and `lib.py` to exist when only `lib.py` does +/// +/// The incoming change events then are no-ops because they don't change either file's +/// status nor does it update their last modified time (renaming a file doesn't bump it's +/// last modified timestamp). +/// +/// Fixing this requires to either make `Files` case-insensitive and store the +/// real-case path (if it differs) on `File` or make `Files` use a +/// case-sensitive `System::metadata` call. This does open the question if all +/// `System` calls should be case sensitive. This would be the most consistent +/// but might be hard to pull off. +/// +/// What the right solution is also depends on if ty itself should be case +/// sensitive or not. E.g. should `include="src"` be case sensitive on all systems +/// or only on case-sensitive systems? +/// +/// Lastly, whatever solution we pick must also work well with VS Code which, +/// unfortunately ,doesn't propagate casing-only renames. +/// <https://github.com/rust-lang/rust-analyzer/issues/9581> +#[ignore] +#[test] +fn rename_files_casing_only() -> anyhow::Result<()> { + let mut case = setup([("lib.py", "class Foo: ...")])?; + + assert!( + resolve_module(case.db(), &ModuleName::new("lib").unwrap()).is_some(), + "Expected `lib` module to exist." + ); + assert_eq!( + resolve_module(case.db(), &ModuleName::new("Lib").unwrap()), + None, + "Expected `Lib` module not to exist" + ); + + // Now rename `lib.py` to `Lib.py` + if case.db().system().case_sensitivity().is_case_sensitive() { + std::fs::rename( + case.project_path("lib.py").as_std_path(), + case.project_path("Lib.py").as_std_path(), + ) + .context("Failed to rename `lib.py` to `Lib.py`")?; + } else { + // On case-insensitive file systems, renaming a file to a different casing is a no-op. + // Rename to a different name first + std::fs::rename( + case.project_path("lib.py").as_std_path(), + case.project_path("temp.py").as_std_path(), + ) + .context("Failed to rename `lib.py` to `temp.py`")?; + + std::fs::rename( + case.project_path("temp.py").as_std_path(), + case.project_path("Lib.py").as_std_path(), + ) + .context("Failed to rename `temp.py` to `Lib.py`")?; + } + + let changes = case.stop_watch(event_for_file("Lib.py")); + case.apply_changes(changes); + + // Resolving `lib` should now fail but `Lib` should now succeed + assert_eq!( + resolve_module(case.db(), &ModuleName::new("lib").unwrap()), + None, + "Expected `lib` module to no longer exist." + ); + + assert!( + resolve_module(case.db(), &ModuleName::new("Lib").unwrap()).is_some(), + "Expected `Lib` module to exist" + ); + + Ok(()) +} diff --git a/crates/ty_ide/Cargo.toml b/crates/ty_ide/Cargo.toml new file mode 100644 index 0000000000000..52a585bd80c42 --- /dev/null +++ b/crates/ty_ide/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "ty_ide" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } + +[dependencies] +ruff_db = { workspace = true } +ruff_python_ast = { workspace = true } +ruff_python_parser = { workspace = true } +ruff_text_size = { workspace = true } +ty_python_semantic = { workspace = true } + +rustc-hash = { workspace = true } +salsa = { workspace = true } +smallvec = { workspace = true } +tracing = { workspace = true } + +[dev-dependencies] +ty_vendored = { workspace = true } + +insta = { workspace = true, features = ["filters"] } + +[lints] +workspace = true diff --git a/crates/ty_ide/src/completion.rs b/crates/ty_ide/src/completion.rs new file mode 100644 index 0000000000000..2082b14a4d64e --- /dev/null +++ b/crates/ty_ide/src/completion.rs @@ -0,0 +1,40 @@ +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_python_ast::visitor::source_order::SourceOrderVisitor; +use ruff_python_ast::{AnyNodeRef, Identifier}; +use ruff_text_size::TextSize; + +use crate::Db; + +#[derive(Debug, Clone)] +pub struct Completion { + pub label: String, +} + +pub fn completion(db: &dyn Db, file: File, _offset: TextSize) -> Vec<Completion> { + let parsed = parsed_module(db.upcast(), file); + identifiers(parsed.syntax().into()) + .into_iter() + .map(|label| Completion { label }) + .collect() +} + +fn identifiers(node: AnyNodeRef) -> Vec<String> { + struct Visitor { + identifiers: Vec<String>, + } + + impl<'a> SourceOrderVisitor<'a> for Visitor { + fn visit_identifier(&mut self, id: &'a Identifier) { + self.identifiers.push(id.id.as_str().to_string()); + } + } + + let mut visitor = Visitor { + identifiers: vec![], + }; + node.visit_source_order(&mut visitor); + visitor.identifiers.sort(); + visitor.identifiers.dedup(); + visitor.identifiers +} diff --git a/crates/ty_ide/src/db.rs b/crates/ty_ide/src/db.rs new file mode 100644 index 0000000000000..ff91bb3377b56 --- /dev/null +++ b/crates/ty_ide/src/db.rs @@ -0,0 +1,137 @@ +use ruff_db::{Db as SourceDb, Upcast}; +use ty_python_semantic::Db as SemanticDb; + +#[salsa::db] +pub trait Db: SemanticDb + Upcast<dyn SemanticDb> + Upcast<dyn SourceDb> {} + +#[cfg(test)] +pub(crate) mod tests { + use std::sync::{Arc, Mutex}; + + use super::Db; + use ruff_db::files::{File, Files}; + use ruff_db::system::{DbWithTestSystem, System, TestSystem}; + use ruff_db::vendored::VendoredFileSystem; + use ruff_db::{Db as SourceDb, Upcast}; + use ty_python_semantic::lint::{LintRegistry, RuleSelection}; + use ty_python_semantic::{Db as SemanticDb, Program, default_lint_registry}; + + type Events = Arc<Mutex<Vec<salsa::Event>>>; + + #[salsa::db] + #[derive(Clone)] + pub(crate) struct TestDb { + storage: salsa::Storage<Self>, + files: Files, + system: TestSystem, + vendored: VendoredFileSystem, + events: Events, + rule_selection: Arc<RuleSelection>, + } + + #[expect(dead_code)] + impl TestDb { + pub(crate) fn new() -> Self { + let events = Events::default(); + Self { + storage: salsa::Storage::new(Some(Box::new({ + let events = events.clone(); + move |event| { + tracing::trace!("event: {event:?}"); + let mut events = events.lock().unwrap(); + events.push(event); + } + }))), + system: TestSystem::default(), + vendored: ty_vendored::file_system().clone(), + events, + files: Files::default(), + rule_selection: Arc::new(RuleSelection::from_registry(default_lint_registry())), + } + } + + /// Takes the salsa events. + pub(crate) fn take_salsa_events(&mut self) -> Vec<salsa::Event> { + let mut events = self.events.lock().unwrap(); + + std::mem::take(&mut *events) + } + + /// Clears the salsa events. + /// + /// ## Panics + /// If there are any pending salsa snapshots. + pub(crate) fn clear_salsa_events(&mut self) { + self.take_salsa_events(); + } + } + + impl DbWithTestSystem for TestDb { + fn test_system(&self) -> &TestSystem { + &self.system + } + + fn test_system_mut(&mut self) -> &mut TestSystem { + &mut self.system + } + } + + #[salsa::db] + impl SourceDb for TestDb { + fn vendored(&self) -> &VendoredFileSystem { + &self.vendored + } + + fn system(&self) -> &dyn System { + &self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> ruff_python_ast::PythonVersion { + Program::get(self).python_version(self) + } + } + + impl Upcast<dyn SourceDb> for TestDb { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } + } + + impl Upcast<dyn SemanticDb> for TestDb { + fn upcast(&self) -> &(dyn SemanticDb + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut dyn SemanticDb { + self + } + } + + #[salsa::db] + impl SemanticDb for TestDb { + fn is_file_open(&self, file: File) -> bool { + !file.path(self).is_vendored_path() + } + + fn rule_selection(&self) -> &RuleSelection { + &self.rule_selection + } + + fn lint_registry(&self) -> &LintRegistry { + default_lint_registry() + } + } + + #[salsa::db] + impl Db for TestDb {} + + #[salsa::db] + impl salsa::Database for TestDb {} +} diff --git a/crates/ty_ide/src/find_node.rs b/crates/ty_ide/src/find_node.rs new file mode 100644 index 0000000000000..c1dfecc4c392d --- /dev/null +++ b/crates/ty_ide/src/find_node.rs @@ -0,0 +1,106 @@ +use ruff_python_ast::AnyNodeRef; +use ruff_python_ast::visitor::source_order::{SourceOrderVisitor, TraversalSignal}; +use ruff_text_size::{Ranged, TextRange}; +use std::fmt; +use std::fmt::Formatter; + +/// Returns the node with a minimal range that fully contains `range`. +/// +/// If `range` is empty and falls within a parser *synthesized* node generated during error recovery, +/// then the first node with the given range is returned. +/// +/// ## Panics +/// Panics if `range` is not contained within `root`. +pub(crate) fn covering_node(root: AnyNodeRef, range: TextRange) -> CoveringNode { + struct Visitor<'a> { + range: TextRange, + found: bool, + ancestors: Vec<AnyNodeRef<'a>>, + } + + impl<'a> SourceOrderVisitor<'a> for Visitor<'a> { + fn enter_node(&mut self, node: AnyNodeRef<'a>) -> TraversalSignal { + // If the node fully contains the range, than it is a possible match but traverse into its children + // to see if there's a node with a narrower range. + if !self.found && node.range().contains_range(self.range) { + self.ancestors.push(node); + TraversalSignal::Traverse + } else { + TraversalSignal::Skip + } + } + + fn leave_node(&mut self, node: AnyNodeRef<'a>) { + if !self.found && self.ancestors.last() == Some(&node) { + self.found = true; + } + } + } + + assert!( + root.range().contains_range(range), + "Range is not contained within root" + ); + + let mut visitor = Visitor { + range, + found: false, + ancestors: Vec::new(), + }; + + root.visit_source_order(&mut visitor); + + let minimal = visitor.ancestors.pop().unwrap_or(root); + CoveringNode { + node: minimal, + ancestors: visitor.ancestors, + } +} + +/// The node with a minimal range that fully contains the search range. +pub(crate) struct CoveringNode<'a> { + /// The node with a minimal range that fully contains the search range. + node: AnyNodeRef<'a>, + + /// The node's ancestor (the spine up to the root). + ancestors: Vec<AnyNodeRef<'a>>, +} + +impl<'a> CoveringNode<'a> { + pub(crate) fn node(&self) -> AnyNodeRef<'a> { + self.node + } + + /// Returns the node's parent. + pub(crate) fn parent(&self) -> Option<AnyNodeRef<'a>> { + self.ancestors.last().copied() + } + + /// Finds the minimal node that fully covers the range and fulfills the given predicate. + pub(crate) fn find(mut self, f: impl Fn(AnyNodeRef<'a>) -> bool) -> Result<Self, Self> { + if f(self.node) { + return Ok(self); + } + + match self.ancestors.iter().rposition(|node| f(*node)) { + Some(index) => { + let node = self.ancestors[index]; + self.ancestors.truncate(index); + + Ok(Self { + node, + ancestors: self.ancestors, + }) + } + None => Err(self), + } + } +} + +impl fmt::Debug for CoveringNode<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + f.debug_tuple("NodeWithAncestors") + .field(&self.node) + .finish() + } +} diff --git a/crates/ty_ide/src/goto.rs b/crates/ty_ide/src/goto.rs new file mode 100644 index 0000000000000..eaac8473c5afb --- /dev/null +++ b/crates/ty_ide/src/goto.rs @@ -0,0 +1,885 @@ +use crate::find_node::covering_node; +use crate::{Db, HasNavigationTargets, NavigationTargets, RangedValue}; +use ruff_db::files::{File, FileRange}; +use ruff_db::parsed::{ParsedModule, parsed_module}; +use ruff_python_ast::{self as ast, AnyNodeRef}; +use ruff_python_parser::TokenKind; +use ruff_text_size::{Ranged, TextRange, TextSize}; +use ty_python_semantic::types::Type; +use ty_python_semantic::{HasType, SemanticModel}; + +pub fn goto_type_definition( + db: &dyn Db, + file: File, + offset: TextSize, +) -> Option<RangedValue<NavigationTargets>> { + let parsed = parsed_module(db.upcast(), file); + let goto_target = find_goto_target(parsed, offset)?; + + let model = SemanticModel::new(db.upcast(), file); + let ty = goto_target.inferred_type(&model)?; + + tracing::debug!( + "Inferred type of covering node is {}", + ty.display(db.upcast()) + ); + + let navigation_targets = ty.navigation_targets(db); + + Some(RangedValue { + range: FileRange::new(file, goto_target.range()), + value: navigation_targets, + }) +} + +#[derive(Clone, Copy, Debug)] +pub(crate) enum GotoTarget<'a> { + Expression(ast::ExprRef<'a>), + FunctionDef(&'a ast::StmtFunctionDef), + ClassDef(&'a ast::StmtClassDef), + Parameter(&'a ast::Parameter), + Alias(&'a ast::Alias), + + /// Go to on the module name of an import from + /// ```py + /// from foo import bar + /// ^^^ + /// ``` + ImportedModule(&'a ast::StmtImportFrom), + + /// Go to on the exception handler variable + /// ```py + /// try: ... + /// except Exception as e: ... + /// ^ + /// ``` + ExceptVariable(&'a ast::ExceptHandlerExceptHandler), + + /// Go to on a keyword argument + /// ```py + /// test(a = 1) + /// ^ + /// ``` + KeywordArgument(&'a ast::Keyword), + + /// Go to on the rest parameter of a pattern match + /// + /// ```py + /// match x: + /// case {"a": a, "b": b, **rest}: ... + /// ^^^^ + /// ``` + PatternMatchRest(&'a ast::PatternMatchMapping), + + /// Go to on a keyword argument of a class pattern + /// + /// ```py + /// match Point3D(0, 0, 0): + /// case Point3D(x=0, y=0, z=0): ... + /// ^ ^ ^ + /// ``` + PatternKeywordArgument(&'a ast::PatternKeyword), + + /// Go to on a pattern star argument + /// + /// ```py + /// match array: + /// case [*args]: ... + /// ^^^^ + PatternMatchStarName(&'a ast::PatternMatchStar), + + /// Go to on the name of a pattern match as pattern + /// + /// ```py + /// match x: + /// case [x] as y: ... + /// ^ + PatternMatchAsName(&'a ast::PatternMatchAs), + + /// Go to on the name of a type variable + /// + /// ```py + /// type Alias[T: int = bool] = list[T] + /// ^ + /// ``` + TypeParamTypeVarName(&'a ast::TypeParamTypeVar), + + /// Go to on the name of a type param spec + /// + /// ```py + /// type Alias[**P = [int, str]] = Callable[P, int] + /// ^ + /// ``` + TypeParamParamSpecName(&'a ast::TypeParamParamSpec), + + /// Go to on the name of a type var tuple + /// + /// ```py + /// type Alias[*Ts = ()] = tuple[*Ts] + /// ^^ + /// ``` + TypeParamTypeVarTupleName(&'a ast::TypeParamTypeVarTuple), + + NonLocal { + identifier: &'a ast::Identifier, + }, + Globals { + identifier: &'a ast::Identifier, + }, +} + +impl<'db> GotoTarget<'db> { + pub(crate) fn inferred_type(self, model: &SemanticModel<'db>) -> Option<Type<'db>> { + let ty = match self { + GotoTarget::Expression(expression) => expression.inferred_type(model), + GotoTarget::FunctionDef(function) => function.inferred_type(model), + GotoTarget::ClassDef(class) => class.inferred_type(model), + GotoTarget::Parameter(parameter) => parameter.inferred_type(model), + GotoTarget::Alias(alias) => alias.inferred_type(model), + GotoTarget::ExceptVariable(except) => except.inferred_type(model), + GotoTarget::KeywordArgument(argument) => { + // TODO: Pyright resolves the declared type of the matching parameter. This seems more accurate + // than using the inferred value. + argument.value.inferred_type(model) + } + // TODO: Support identifier targets + GotoTarget::PatternMatchRest(_) + | GotoTarget::PatternKeywordArgument(_) + | GotoTarget::PatternMatchStarName(_) + | GotoTarget::PatternMatchAsName(_) + | GotoTarget::ImportedModule(_) + | GotoTarget::TypeParamTypeVarName(_) + | GotoTarget::TypeParamParamSpecName(_) + | GotoTarget::TypeParamTypeVarTupleName(_) + | GotoTarget::NonLocal { .. } + | GotoTarget::Globals { .. } => return None, + }; + + Some(ty) + } +} + +impl Ranged for GotoTarget<'_> { + fn range(&self) -> TextRange { + match self { + GotoTarget::Expression(expression) => expression.range(), + GotoTarget::FunctionDef(function) => function.name.range, + GotoTarget::ClassDef(class) => class.name.range, + GotoTarget::Parameter(parameter) => parameter.name.range, + GotoTarget::Alias(alias) => alias.name.range, + GotoTarget::ImportedModule(module) => module.module.as_ref().unwrap().range, + GotoTarget::ExceptVariable(except) => except.name.as_ref().unwrap().range, + GotoTarget::KeywordArgument(keyword) => keyword.arg.as_ref().unwrap().range, + GotoTarget::PatternMatchRest(rest) => rest.rest.as_ref().unwrap().range, + GotoTarget::PatternKeywordArgument(keyword) => keyword.attr.range, + GotoTarget::PatternMatchStarName(star) => star.name.as_ref().unwrap().range, + GotoTarget::PatternMatchAsName(as_name) => as_name.name.as_ref().unwrap().range, + GotoTarget::TypeParamTypeVarName(type_var) => type_var.name.range, + GotoTarget::TypeParamParamSpecName(spec) => spec.name.range, + GotoTarget::TypeParamTypeVarTupleName(tuple) => tuple.name.range, + GotoTarget::NonLocal { identifier, .. } => identifier.range, + GotoTarget::Globals { identifier, .. } => identifier.range, + } + } +} + +pub(crate) fn find_goto_target(parsed: &ParsedModule, offset: TextSize) -> Option<GotoTarget> { + let token = parsed + .tokens() + .at_offset(offset) + .max_by_key(|token| match token.kind() { + TokenKind::Name + | TokenKind::String + | TokenKind::Complex + | TokenKind::Float + | TokenKind::Int => 1, + _ => 0, + })?; + + let covering_node = covering_node(parsed.syntax().into(), token.range()) + .find(|node| node.is_identifier() || node.is_expression()) + .ok()?; + + tracing::trace!("Covering node is of kind {:?}", covering_node.node().kind()); + + match covering_node.node() { + AnyNodeRef::Identifier(identifier) => match covering_node.parent() { + Some(AnyNodeRef::StmtFunctionDef(function)) => Some(GotoTarget::FunctionDef(function)), + Some(AnyNodeRef::StmtClassDef(class)) => Some(GotoTarget::ClassDef(class)), + Some(AnyNodeRef::Parameter(parameter)) => Some(GotoTarget::Parameter(parameter)), + Some(AnyNodeRef::Alias(alias)) => Some(GotoTarget::Alias(alias)), + Some(AnyNodeRef::StmtImportFrom(from)) => Some(GotoTarget::ImportedModule(from)), + Some(AnyNodeRef::ExceptHandlerExceptHandler(handler)) => { + Some(GotoTarget::ExceptVariable(handler)) + } + Some(AnyNodeRef::Keyword(keyword)) => Some(GotoTarget::KeywordArgument(keyword)), + Some(AnyNodeRef::PatternMatchMapping(mapping)) => { + Some(GotoTarget::PatternMatchRest(mapping)) + } + Some(AnyNodeRef::PatternKeyword(keyword)) => { + Some(GotoTarget::PatternKeywordArgument(keyword)) + } + Some(AnyNodeRef::PatternMatchStar(star)) => { + Some(GotoTarget::PatternMatchStarName(star)) + } + Some(AnyNodeRef::PatternMatchAs(as_pattern)) => { + Some(GotoTarget::PatternMatchAsName(as_pattern)) + } + Some(AnyNodeRef::TypeParamTypeVar(var)) => Some(GotoTarget::TypeParamTypeVarName(var)), + Some(AnyNodeRef::TypeParamParamSpec(bound)) => { + Some(GotoTarget::TypeParamParamSpecName(bound)) + } + Some(AnyNodeRef::TypeParamTypeVarTuple(var_tuple)) => { + Some(GotoTarget::TypeParamTypeVarTupleName(var_tuple)) + } + Some(AnyNodeRef::ExprAttribute(attribute)) => { + Some(GotoTarget::Expression(attribute.into())) + } + Some(AnyNodeRef::StmtNonlocal(_)) => Some(GotoTarget::NonLocal { identifier }), + Some(AnyNodeRef::StmtGlobal(_)) => Some(GotoTarget::Globals { identifier }), + None => None, + Some(parent) => { + tracing::debug!( + "Missing `GoToTarget` for identifier with parent {:?}", + parent.kind() + ); + None + } + }, + + node => node.as_expr_ref().map(GotoTarget::Expression), + } +} + +#[cfg(test)] +mod tests { + use crate::tests::{CursorTest, IntoDiagnostic, cursor_test}; + use crate::{NavigationTarget, goto_type_definition}; + use insta::assert_snapshot; + use ruff_db::diagnostic::{ + Annotation, Diagnostic, DiagnosticId, LintName, Severity, Span, SubDiagnostic, + }; + use ruff_db::files::FileRange; + use ruff_text_size::Ranged; + + #[test] + fn goto_type_of_expression_with_class_type() { + let test = cursor_test( + r#" + class Test: ... + + a<CURSOR>b = Test() + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:2:19 + | + 2 | class Test: ... + | ^^^^ + 3 | + 4 | ab = Test() + | + info: Source + --> main.py:4:13 + | + 2 | class Test: ... + 3 | + 4 | ab = Test() + | ^^ + | + "); + } + + #[test] + fn goto_type_of_expression_with_function_type() { + let test = cursor_test( + r#" + def foo(a, b): ... + + ab = foo + + a<CURSOR>b + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:2:17 + | + 2 | def foo(a, b): ... + | ^^^ + 3 | + 4 | ab = foo + | + info: Source + --> main.py:6:13 + | + 4 | ab = foo + 5 | + 6 | ab + | ^^ + | + "); + } + + #[test] + fn goto_type_of_expression_with_union_type() { + let test = cursor_test( + r#" + + def foo(a, b): ... + + def bar(a, b): ... + + if random.choice(): + a = foo + else: + a = bar + + a<CURSOR> + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:3:17 + | + 3 | def foo(a, b): ... + | ^^^ + 4 | + 5 | def bar(a, b): ... + | + info: Source + --> main.py:12:13 + | + 10 | a = bar + 11 | + 12 | a + | ^ + | + + info[goto-type-definition]: Type definition + --> main.py:5:17 + | + 3 | def foo(a, b): ... + 4 | + 5 | def bar(a, b): ... + | ^^^ + 6 | + 7 | if random.choice(): + | + info: Source + --> main.py:12:13 + | + 10 | a = bar + 11 | + 12 | a + | ^ + | + "); + } + + #[test] + fn goto_type_of_expression_with_module() { + let mut test = cursor_test( + r#" + import lib + + lib<CURSOR> + "#, + ); + + test.write_file("lib.py", "a = 10").unwrap(); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> lib.py:1:1 + | + 1 | a = 10 + | ^^^^^^ + | + info: Source + --> main.py:4:13 + | + 2 | import lib + 3 | + 4 | lib + | ^^^ + | + "); + } + + #[test] + fn goto_type_of_expression_with_literal_type() { + let test = cursor_test( + r#" + a: str = "test" + + a<CURSOR> + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:4:13 + | + 2 | a: str = "test" + 3 | + 4 | a + | ^ + | + "###); + } + #[test] + fn goto_type_of_expression_with_literal_node() { + let test = cursor_test( + r#" + a: str = "te<CURSOR>st" + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:2:22 + | + 2 | a: str = "test" + | ^^^^^^ + | + "###); + } + + #[test] + fn goto_type_of_expression_with_type_var_type() { + let test = cursor_test( + r#" + type Alias[T: int = bool] = list[T<CURSOR>] + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:2:24 + | + 2 | type Alias[T: int = bool] = list[T] + | ^ + | + info: Source + --> main.py:2:46 + | + 2 | type Alias[T: int = bool] = list[T] + | ^ + | + "); + } + + #[test] + fn goto_type_of_expression_with_type_param_spec() { + let test = cursor_test( + r#" + type Alias[**P = [int, str]] = Callable[P<CURSOR>, int] + "#, + ); + + // TODO: Goto type definition currently doesn't work for type param specs + // because the inference doesn't support them yet. + // This snapshot should show a single target pointing to `T` + assert_snapshot!(test.goto_type_definition(), @"No type definitions found"); + } + + #[test] + fn goto_type_of_expression_with_type_var_tuple() { + let test = cursor_test( + r#" + type Alias[*Ts = ()] = tuple[*Ts<CURSOR>] + "#, + ); + + // TODO: Goto type definition currently doesn't work for type var tuples + // because the inference doesn't support them yet. + // This snapshot should show a single target pointing to `T` + assert_snapshot!(test.goto_type_definition(), @"No type definitions found"); + } + + #[test] + fn goto_type_of_bare_type_alias_type() { + let test = cursor_test( + r#" + from typing_extensions import TypeAliasType + + Alias = TypeAliasType("Alias", tuple[int, int]) + + Alias<CURSOR> + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r#" + info[goto-type-definition]: Type definition + --> main.py:4:13 + | + 2 | from typing_extensions import TypeAliasType + 3 | + 4 | Alias = TypeAliasType("Alias", tuple[int, int]) + | ^^^^^ + 5 | + 6 | Alias + | + info: Source + --> main.py:6:13 + | + 4 | Alias = TypeAliasType("Alias", tuple[int, int]) + 5 | + 6 | Alias + | ^^^^^ + | + "#); + } + + #[test] + fn goto_type_on_keyword_argument() { + let test = cursor_test( + r#" + def test(a: str): ... + + test(a<CURSOR>= "123") + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:4:18 + | + 2 | def test(a: str): ... + 3 | + 4 | test(a= "123") + | ^ + | + "###); + } + + #[test] + fn goto_type_on_incorrectly_typed_keyword_argument() { + let test = cursor_test( + r#" + def test(a: str): ... + + test(a<CURSOR>= 123) + "#, + ); + + // TODO: This should jump to `str` and not `int` because + // the keyword is typed as a string. It's only the passed argument that + // is an int. Navigating to `str` would match pyright's behavior. + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:238:7 + | + 236 | _LiteralInteger = _PositiveInteger | _NegativeInteger | Literal[0] # noqa: Y026 # TODO: Use TypeAlias once mypy bugs are fixed + 237 | + 238 | class int: + | ^^^ + 239 | @overload + 240 | def __new__(cls, x: ConvertibleToInt = ..., /) -> Self: ... + | + info: Source + --> main.py:4:18 + | + 2 | def test(a: str): ... + 3 | + 4 | test(a= 123) + | ^ + | + "###); + } + + #[test] + fn goto_type_on_kwargs() { + let test = cursor_test( + r#" + def f(name: str): ... + +kwargs = { "name": "test"} + +f(**kwargs<CURSOR>) + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:1096:7 + | + 1094 | def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + 1095 | + 1096 | class dict(MutableMapping[_KT, _VT]): + | ^^^^ + 1097 | # __init__ should be kept roughly in line with `collections.UserDict.__init__`, which has similar semantics + 1098 | # Also multiprocessing.managers.SyncManager.dict() + | + info: Source + --> main.py:6:5 + | + 4 | kwargs = { "name": "test"} + 5 | + 6 | f(**kwargs) + | ^^^^^^ + | + "###); + } + + #[test] + fn goto_type_of_expression_with_builtin() { + let test = cursor_test( + r#" + def foo(a: str): + a<CURSOR> + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:3:17 + | + 2 | def foo(a: str): + 3 | a + | ^ + | + "###); + } + + #[test] + fn goto_type_definition_cursor_between_object_and_attribute() { + let test = cursor_test( + r#" + class X: + def foo(a, b): ... + + x = X() + + x<CURSOR>.foo() + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:2:19 + | + 2 | class X: + | ^ + 3 | def foo(a, b): ... + | + info: Source + --> main.py:7:13 + | + 5 | x = X() + 6 | + 7 | x.foo() + | ^ + | + "); + } + + #[test] + fn goto_between_call_arguments() { + let test = cursor_test( + r#" + def foo(a, b): ... + + foo<CURSOR>() + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r" + info[goto-type-definition]: Type definition + --> main.py:2:17 + | + 2 | def foo(a, b): ... + | ^^^ + 3 | + 4 | foo() + | + info: Source + --> main.py:4:13 + | + 2 | def foo(a, b): ... + 3 | + 4 | foo() + | ^^^ + | + "); + } + + #[test] + fn goto_type_narrowing() { + let test = cursor_test( + r#" + def foo(a: str | None, b): + if a is not None: + print(a<CURSOR>) + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:4:27 + | + 2 | def foo(a: str | None, b): + 3 | if a is not None: + 4 | print(a) + | ^ + | + "###); + } + + #[test] + fn goto_type_none() { + let test = cursor_test( + r#" + def foo(a: str | None, b): + a<CURSOR> + "#, + ); + + assert_snapshot!(test.goto_type_definition(), @r###" + info[goto-type-definition]: Type definition + --> stdlib/types.pyi:680:11 + | + 678 | if sys.version_info >= (3, 10): + 679 | @final + 680 | class NoneType: + | ^^^^^^^^ + 681 | def __bool__(self) -> Literal[False]: ... + | + info: Source + --> main.py:3:17 + | + 2 | def foo(a: str | None, b): + 3 | a + | ^ + | + + info[goto-type-definition]: Type definition + --> stdlib/builtins.pyi:445:7 + | + 443 | def __getitem__(self, key: int, /) -> str | int | None: ... + 444 | + 445 | class str(Sequence[str]): + | ^^^ + 446 | @overload + 447 | def __new__(cls, object: object = ...) -> Self: ... + | + info: Source + --> main.py:3:17 + | + 2 | def foo(a: str | None, b): + 3 | a + | ^ + | + "###); + } + + impl CursorTest { + fn goto_type_definition(&self) -> String { + let Some(targets) = goto_type_definition(&self.db, self.file, self.cursor_offset) + else { + return "No goto target found".to_string(); + }; + + if targets.is_empty() { + return "No type definitions found".to_string(); + } + + let source = targets.range; + self.render_diagnostics( + targets + .into_iter() + .map(|target| GotoTypeDefinitionDiagnostic::new(source, &target)), + ) + } + } + + struct GotoTypeDefinitionDiagnostic { + source: FileRange, + target: FileRange, + } + + impl GotoTypeDefinitionDiagnostic { + fn new(source: FileRange, target: &NavigationTarget) -> Self { + Self { + source, + target: FileRange::new(target.file(), target.focus_range()), + } + } + } + + impl IntoDiagnostic for GotoTypeDefinitionDiagnostic { + fn into_diagnostic(self) -> Diagnostic { + let mut source = SubDiagnostic::new(Severity::Info, "Source"); + source.annotate(Annotation::primary( + Span::from(self.source.file()).with_range(self.source.range()), + )); + + let mut main = Diagnostic::new( + DiagnosticId::Lint(LintName::of("goto-type-definition")), + Severity::Info, + "Type definition".to_string(), + ); + main.annotate(Annotation::primary( + Span::from(self.target.file()).with_range(self.target.range()), + )); + main.sub(source); + + main + } + } +} diff --git a/crates/ty_ide/src/hover.rs b/crates/ty_ide/src/hover.rs new file mode 100644 index 0000000000000..6509b4bf76a23 --- /dev/null +++ b/crates/ty_ide/src/hover.rs @@ -0,0 +1,782 @@ +use crate::goto::{GotoTarget, find_goto_target}; +use crate::{Db, MarkupKind, RangedValue}; +use ruff_db::files::{File, FileRange}; +use ruff_db::parsed::parsed_module; +use ruff_text_size::{Ranged, TextSize}; +use std::fmt; +use std::fmt::Formatter; +use ty_python_semantic::SemanticModel; +use ty_python_semantic::types::Type; + +pub fn hover(db: &dyn Db, file: File, offset: TextSize) -> Option<RangedValue<Hover>> { + let parsed = parsed_module(db.upcast(), file); + let goto_target = find_goto_target(parsed, offset)?; + + if let GotoTarget::Expression(expr) = goto_target { + if expr.is_literal_expr() { + return None; + } + } + + let model = SemanticModel::new(db.upcast(), file); + let ty = goto_target.inferred_type(&model)?; + + tracing::debug!( + "Inferred type of covering node is {}", + ty.display(db.upcast()) + ); + + // TODO: Add documentation of the symbol (not the type's definition). + // TODO: Render the symbol's signature instead of just its type. + let contents = vec![HoverContent::Type(ty)]; + + Some(RangedValue { + range: FileRange::new(file, goto_target.range()), + value: Hover { contents }, + }) +} + +pub struct Hover<'db> { + contents: Vec<HoverContent<'db>>, +} + +impl<'db> Hover<'db> { + /// Renders the hover to a string using the specified markup kind. + pub const fn display<'a>(&'a self, db: &'a dyn Db, kind: MarkupKind) -> DisplayHover<'a> { + DisplayHover { + db, + hover: self, + kind, + } + } + + fn iter(&self) -> std::slice::Iter<'_, HoverContent<'db>> { + self.contents.iter() + } +} + +impl<'db> IntoIterator for Hover<'db> { + type Item = HoverContent<'db>; + type IntoIter = std::vec::IntoIter<Self::Item>; + + fn into_iter(self) -> Self::IntoIter { + self.contents.into_iter() + } +} + +impl<'a, 'db> IntoIterator for &'a Hover<'db> { + type Item = &'a HoverContent<'db>; + type IntoIter = std::slice::Iter<'a, HoverContent<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.iter() + } +} + +pub struct DisplayHover<'a> { + db: &'a dyn Db, + hover: &'a Hover<'a>, + kind: MarkupKind, +} + +impl fmt::Display for DisplayHover<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let mut first = true; + for content in &self.hover.contents { + if !first { + self.kind.horizontal_line().fmt(f)?; + } + + content.display(self.db, self.kind).fmt(f)?; + first = false; + } + + Ok(()) + } +} + +#[derive(Debug, Clone, Eq, PartialEq)] +pub enum HoverContent<'db> { + Type(Type<'db>), +} + +impl<'db> HoverContent<'db> { + fn display(&self, db: &'db dyn Db, kind: MarkupKind) -> DisplayHoverContent<'_, 'db> { + DisplayHoverContent { + db, + content: self, + kind, + } + } +} + +pub(crate) struct DisplayHoverContent<'a, 'db> { + db: &'db dyn Db, + content: &'a HoverContent<'db>, + kind: MarkupKind, +} + +impl fmt::Display for DisplayHoverContent<'_, '_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self.content { + HoverContent::Type(ty) => self + .kind + .fenced_code_block(ty.display(self.db.upcast()), "text") + .fmt(f), + } + } +} + +#[cfg(test)] +mod tests { + use crate::tests::{CursorTest, cursor_test}; + use crate::{MarkupKind, hover}; + use insta::assert_snapshot; + use ruff_db::Upcast; + use ruff_db::diagnostic::{ + Annotation, Diagnostic, DiagnosticFormat, DiagnosticId, DisplayDiagnosticConfig, LintName, + Severity, Span, + }; + use ruff_text_size::{Ranged, TextRange}; + + #[test] + fn hover_basic() { + let test = cursor_test( + r#" + a = 10 + + a<CURSOR> + "#, + ); + + assert_snapshot!(test.hover(), @r" + Literal[10] + --------------------------------------------- + ```text + Literal[10] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:9 + | + 2 | a = 10 + 3 | + 4 | a + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_member() { + let test = cursor_test( + r#" + class Foo: + a: int = 10 + + def __init__(a: int, b: str): + self.a = a + self.b: str = b + + foo = Foo() + foo.<CURSOR>a + "#, + ); + + assert_snapshot!(test.hover(), @r" + int + --------------------------------------------- + ```text + int + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:10:9 + | + 9 | foo = Foo() + 10 | foo.a + | ^^^^- + | | | + | | Cursor offset + | source + | + "); + } + + #[test] + fn hover_function_typed_variable() { + let test = cursor_test( + r#" + def foo(a, b): ... + + foo<CURSOR> + "#, + ); + + assert_snapshot!(test.hover(), @r" + def foo(a, b) -> Unknown + --------------------------------------------- + ```text + def foo(a, b) -> Unknown + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:13 + | + 2 | def foo(a, b): ... + 3 | + 4 | foo + | ^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_binary_expression() { + let test = cursor_test( + r#" + def foo(a: int, b: int, c: int): + a + b ==<CURSOR> c + "#, + ); + + assert_snapshot!(test.hover(), @r" + bool + --------------------------------------------- + ```text + bool + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:3:17 + | + 2 | def foo(a: int, b: int, c: int): + 3 | a + b == c + | ^^^^^^^^-^ + | | | + | | Cursor offset + | source + | + "); + } + + #[test] + fn hover_keyword_parameter() { + let test = cursor_test( + r#" + def test(a: int): ... + + test(a<CURSOR>= 123) + "#, + ); + + // TODO: This should reveal `int` because the user hovers over the parameter and not the value. + assert_snapshot!(test.hover(), @r" + Literal[123] + --------------------------------------------- + ```text + Literal[123] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:18 + | + 2 | def test(a: int): ... + 3 | + 4 | test(a= 123) + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_union() { + let test = cursor_test( + r#" + + def foo(a, b): ... + + def bar(a, b): ... + + if random.choice([True, False]): + a = foo + else: + a = bar + + a<CURSOR> + "#, + ); + + assert_snapshot!(test.hover(), @r" + (def foo(a, b) -> Unknown) | (def bar(a, b) -> Unknown) + --------------------------------------------- + ```text + (def foo(a, b) -> Unknown) | (def bar(a, b) -> Unknown) + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:12:13 + | + 10 | a = bar + 11 | + 12 | a + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_module() { + let mut test = cursor_test( + r#" + import lib + + li<CURSOR>b + "#, + ); + + test.write_file("lib.py", "a = 10").unwrap(); + + assert_snapshot!(test.hover(), @r" + <module 'lib'> + --------------------------------------------- + ```text + <module 'lib'> + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:13 + | + 2 | import lib + 3 | + 4 | lib + | ^^- + | | | + | | Cursor offset + | source + | + "); + } + + #[test] + fn hover_type_of_expression_with_type_var_type() { + let test = cursor_test( + r#" + type Alias[T: int = bool] = list[T<CURSOR>] + "#, + ); + + assert_snapshot!(test.hover(), @r" + T + --------------------------------------------- + ```text + T + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:2:46 + | + 2 | type Alias[T: int = bool] = list[T] + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_type_of_expression_with_type_param_spec() { + let test = cursor_test( + r#" + type Alias[**P = [int, str]] = Callable[P<CURSOR>, int] + "#, + ); + + assert_snapshot!(test.hover(), @r" + @Todo + --------------------------------------------- + ```text + @Todo + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:2:53 + | + 2 | type Alias[**P = [int, str]] = Callable[P, int] + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_type_of_expression_with_type_var_tuple() { + let test = cursor_test( + r#" + type Alias[*Ts = ()] = tuple[*Ts<CURSOR>] + "#, + ); + + assert_snapshot!(test.hover(), @r" + @Todo + --------------------------------------------- + ```text + @Todo + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:2:43 + | + 2 | type Alias[*Ts = ()] = tuple[*Ts] + | ^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_variable_assignment() { + let test = cursor_test( + r#" + value<CURSOR> = 1 + "#, + ); + + assert_snapshot!(test.hover(), @r" + Literal[1] + --------------------------------------------- + ```text + Literal[1] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:2:13 + | + 2 | value = 1 + | ^^^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_augmented_assignment() { + let test = cursor_test( + r#" + value = 1 + value<CURSOR> += 2 + "#, + ); + + // We currently show the *previous* value of the variable (1), not the new one (3). + // Showing the new value might be more intuitive for some users, but the actual 'use' + // of the `value` symbol here in read-context is `1`. This comment mainly exists to + // signal that it might be okay to revisit this in the future and reveal 3 instead. + assert_snapshot!(test.hover(), @r" + Literal[1] + --------------------------------------------- + ```text + Literal[1] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:3:13 + | + 2 | value = 1 + 3 | value += 2 + | ^^^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_attribute_assignment() { + let test = cursor_test( + r#" + class C: + attr: int = 1 + + C.attr<CURSOR> = 2 + "#, + ); + + assert_snapshot!(test.hover(), @r" + Literal[2] + --------------------------------------------- + ```text + Literal[2] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:5:13 + | + 3 | attr: int = 1 + 4 | + 5 | C.attr = 2 + | ^^^^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_augmented_attribute_assignment() { + let test = cursor_test( + r#" + class C: + attr = 1 + + C.attr<CURSOR> += 2 + "#, + ); + + // See the comment in the `hover_augmented_assignment` test above. The same + // reasoning applies here. + assert_snapshot!(test.hover(), @r" + Unknown | Literal[1] + --------------------------------------------- + ```text + Unknown | Literal[1] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:5:13 + | + 3 | attr = 1 + 4 | + 5 | C.attr += 2 + | ^^^^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_annotated_assignment() { + let test = cursor_test( + r#" + class Foo: + a<CURSOR>: int + "#, + ); + + assert_snapshot!(test.hover(), @r" + int + --------------------------------------------- + ```text + int + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:3:13 + | + 2 | class Foo: + 3 | a: int + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_annotated_assignment_with_rhs() { + let test = cursor_test( + r#" + class Foo: + a<CURSOR>: int = 1 + "#, + ); + + assert_snapshot!(test.hover(), @r" + Literal[1] + --------------------------------------------- + ```text + Literal[1] + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:3:13 + | + 2 | class Foo: + 3 | a: int = 1 + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_annotated_attribute_assignment() { + let test = cursor_test( + r#" + class Foo: + def __init__(self, a: int): + self.a<CURSOR>: int = a + "#, + ); + + assert_snapshot!(test.hover(), @r" + int + --------------------------------------------- + ```text + int + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:17 + | + 2 | class Foo: + 3 | def __init__(self, a: int): + 4 | self.a: int = a + | ^^^^^^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_type_narrowing() { + let test = cursor_test( + r#" + def foo(a: str | None, b): + if a is not None: + print(a<CURSOR>) + "#, + ); + + assert_snapshot!(test.hover(), @r" + str + --------------------------------------------- + ```text + str + ``` + --------------------------------------------- + info[hover]: Hovered content is + --> main.py:4:27 + | + 2 | def foo(a: str | None, b): + 3 | if a is not None: + 4 | print(a) + | ^- Cursor offset + | | + | source + | + "); + } + + #[test] + fn hover_whitespace() { + let test = cursor_test( + r#" + class C: + <CURSOR> + foo: str = 'bar' + "#, + ); + + assert_snapshot!(test.hover(), @"Hover provided no content"); + } + + #[test] + fn hover_literal_int() { + let test = cursor_test( + r#" + print( + 0 + 1<CURSOR> + ) + "#, + ); + + assert_snapshot!(test.hover(), @"Hover provided no content"); + } + + #[test] + fn hover_literal_ellipsis() { + let test = cursor_test( + r#" + print( + .<CURSOR>.. + ) + "#, + ); + + assert_snapshot!(test.hover(), @"Hover provided no content"); + } + + #[test] + fn hover_docstring() { + let test = cursor_test( + r#" + def f(): + """Lorem ipsum dolor sit amet.<CURSOR>""" + "#, + ); + + assert_snapshot!(test.hover(), @"Hover provided no content"); + } + + impl CursorTest { + fn hover(&self) -> String { + use std::fmt::Write; + + let Some(hover) = hover(&self.db, self.file, self.cursor_offset) else { + return "Hover provided no content".to_string(); + }; + + let source = hover.range; + + let mut buf = String::new(); + + write!( + &mut buf, + "{plaintext}{line}{markdown}{line}", + plaintext = hover.display(&self.db, MarkupKind::PlainText), + line = MarkupKind::PlainText.horizontal_line(), + markdown = hover.display(&self.db, MarkupKind::Markdown), + ) + .unwrap(); + + let config = DisplayDiagnosticConfig::default() + .color(false) + .format(DiagnosticFormat::Full); + + let mut diagnostic = Diagnostic::new( + DiagnosticId::Lint(LintName::of("hover")), + Severity::Info, + "Hovered content is", + ); + diagnostic.annotate( + Annotation::primary(Span::from(source.file()).with_range(source.range())) + .message("source"), + ); + diagnostic.annotate( + Annotation::secondary( + Span::from(source.file()).with_range(TextRange::empty(self.cursor_offset)), + ) + .message("Cursor offset"), + ); + + write!(buf, "{}", diagnostic.display(&self.db.upcast(), &config)).unwrap(); + + buf + } + } +} diff --git a/crates/ty_ide/src/inlay_hints.rs b/crates/ty_ide/src/inlay_hints.rs new file mode 100644 index 0000000000000..4539b54308bef --- /dev/null +++ b/crates/ty_ide/src/inlay_hints.rs @@ -0,0 +1,279 @@ +use crate::Db; +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_python_ast::visitor::source_order::{self, SourceOrderVisitor, TraversalSignal}; +use ruff_python_ast::{AnyNodeRef, Expr, Stmt}; +use ruff_text_size::{Ranged, TextRange, TextSize}; +use std::fmt; +use std::fmt::Formatter; +use ty_python_semantic::types::Type; +use ty_python_semantic::{HasType, SemanticModel}; + +#[derive(Debug, Clone, Eq, PartialEq)] +pub struct InlayHint<'db> { + pub position: TextSize, + pub content: InlayHintContent<'db>, +} + +impl<'db> InlayHint<'db> { + pub const fn display(&self, db: &'db dyn Db) -> DisplayInlayHint<'_, 'db> { + self.content.display(db) + } +} + +#[derive(Debug, Clone, Eq, PartialEq)] +pub enum InlayHintContent<'db> { + Type(Type<'db>), + ReturnType(Type<'db>), +} + +impl<'db> InlayHintContent<'db> { + pub const fn display(&self, db: &'db dyn Db) -> DisplayInlayHint<'_, 'db> { + DisplayInlayHint { db, hint: self } + } +} + +pub struct DisplayInlayHint<'a, 'db> { + db: &'db dyn Db, + hint: &'a InlayHintContent<'db>, +} + +impl fmt::Display for DisplayInlayHint<'_, '_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self.hint { + InlayHintContent::Type(ty) => { + write!(f, ": {}", ty.display(self.db.upcast())) + } + InlayHintContent::ReturnType(ty) => { + write!(f, " -> {}", ty.display(self.db.upcast())) + } + } + } +} + +pub fn inlay_hints(db: &dyn Db, file: File, range: TextRange) -> Vec<InlayHint<'_>> { + let mut visitor = InlayHintVisitor::new(db, file, range); + + let ast = parsed_module(db.upcast(), file); + + visitor.visit_body(ast.suite()); + + visitor.hints +} + +struct InlayHintVisitor<'db> { + model: SemanticModel<'db>, + hints: Vec<InlayHint<'db>>, + in_assignment: bool, + range: TextRange, +} + +impl<'db> InlayHintVisitor<'db> { + fn new(db: &'db dyn Db, file: File, range: TextRange) -> Self { + Self { + model: SemanticModel::new(db.upcast(), file), + hints: Vec::new(), + in_assignment: false, + range, + } + } + + fn add_type_hint(&mut self, position: TextSize, ty: Type<'db>) { + self.hints.push(InlayHint { + position, + content: InlayHintContent::Type(ty), + }); + } +} + +impl SourceOrderVisitor<'_> for InlayHintVisitor<'_> { + fn enter_node(&mut self, node: AnyNodeRef<'_>) -> TraversalSignal { + if self.range.intersect(node.range()).is_some() { + TraversalSignal::Traverse + } else { + TraversalSignal::Skip + } + } + + fn visit_stmt(&mut self, stmt: &Stmt) { + let node = AnyNodeRef::from(stmt); + + if !self.enter_node(node).is_traverse() { + return; + } + + match stmt { + Stmt::Assign(assign) => { + self.in_assignment = true; + for target in &assign.targets { + self.visit_expr(target); + } + self.in_assignment = false; + + return; + } + // TODO + Stmt::FunctionDef(_) => {} + Stmt::For(_) => {} + Stmt::Expr(_) => { + // Don't traverse into expression statements because we don't show any hints. + return; + } + _ => {} + } + + source_order::walk_stmt(self, stmt); + } + + fn visit_expr(&mut self, expr: &'_ Expr) { + if !self.in_assignment { + return; + } + + match expr { + Expr::Name(name) => { + if name.ctx.is_store() { + let ty = expr.inferred_type(&self.model); + self.add_type_hint(expr.range().end(), ty); + } + } + _ => { + source_order::walk_expr(self, expr); + } + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + use insta::assert_snapshot; + use ruff_db::{ + files::{File, system_path_to_file}, + source::source_text, + }; + use ruff_text_size::TextSize; + + use crate::db::tests::TestDb; + + use ruff_db::system::{DbWithWritableSystem, SystemPathBuf}; + use ty_python_semantic::{ + Program, ProgramSettings, PythonPath, PythonPlatform, PythonVersionWithSource, + SearchPathSettings, + }; + + pub(super) fn inlay_hint_test(source: &str) -> InlayHintTest { + const START: &str = "<START>"; + const END: &str = "<END>"; + + let mut db = TestDb::new(); + + let start = source.find(START); + let end = source + .find(END) + .map(|x| if start.is_some() { x - START.len() } else { x }) + .unwrap_or(source.len()); + + let range = TextRange::new( + TextSize::try_from(start.unwrap_or_default()).unwrap(), + TextSize::try_from(end).unwrap(), + ); + + let source = source.replace(START, ""); + let source = source.replace(END, ""); + + db.write_file("main.py", source) + .expect("write to memory file system to be successful"); + + let file = system_path_to_file(&db, "main.py").expect("newly written file to existing"); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![SystemPathBuf::from("/")], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![]), + }, + }, + ) + .expect("Default settings to be valid"); + + InlayHintTest { db, file, range } + } + + pub(super) struct InlayHintTest { + pub(super) db: TestDb, + pub(super) file: File, + pub(super) range: TextRange, + } + + impl InlayHintTest { + fn inlay_hints(&self) -> String { + let hints = inlay_hints(&self.db, self.file, self.range); + + let mut buf = source_text(&self.db, self.file).as_str().to_string(); + + let mut offset = 0; + + for hint in hints { + let end_position = (hint.position.to_u32() as usize) + offset; + let hint_str = format!("[{}]", hint.display(&self.db)); + buf.insert_str(end_position, &hint_str); + offset += hint_str.len(); + } + + buf + } + } + + #[test] + fn test_assign_statement() { + let test = inlay_hint_test("x = 1"); + + assert_snapshot!(test.inlay_hints(), @r" + x[: Literal[1]] = 1 + "); + } + + #[test] + fn test_tuple_assignment() { + let test = inlay_hint_test("x, y = (1, 'abc')"); + + assert_snapshot!(test.inlay_hints(), @r#" + x[: Literal[1]], y[: Literal["abc"]] = (1, 'abc') + "#); + } + + #[test] + fn test_nested_tuple_assignment() { + let test = inlay_hint_test("x, (y, z) = (1, ('abc', 2))"); + + assert_snapshot!(test.inlay_hints(), @r#" + x[: Literal[1]], (y[: Literal["abc"]], z[: Literal[2]]) = (1, ('abc', 2)) + "#); + } + + #[test] + fn test_assign_statement_with_type_annotation() { + let test = inlay_hint_test("x: int = 1"); + + assert_snapshot!(test.inlay_hints(), @r" + x: int = 1 + "); + } + + #[test] + fn test_assign_statement_out_of_range() { + let test = inlay_hint_test("<START>x = 1<END>\ny = 2"); + + assert_snapshot!(test.inlay_hints(), @r" + x[: Literal[1]] = 1 + y = 2 + "); + } +} diff --git a/crates/ty_ide/src/lib.rs b/crates/ty_ide/src/lib.rs new file mode 100644 index 0000000000000..e403996788d1d --- /dev/null +++ b/crates/ty_ide/src/lib.rs @@ -0,0 +1,301 @@ +mod completion; +mod db; +mod find_node; +mod goto; +mod hover; +mod inlay_hints; +mod markup; + +pub use completion::completion; +pub use db::Db; +pub use goto::goto_type_definition; +pub use hover::hover; +pub use inlay_hints::inlay_hints; +pub use markup::MarkupKind; + +use ruff_db::files::{File, FileRange}; +use ruff_text_size::{Ranged, TextRange}; +use rustc_hash::FxHashSet; +use std::ops::{Deref, DerefMut}; +use ty_python_semantic::types::{Type, TypeDefinition}; + +/// Information associated with a text range. +#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)] +pub struct RangedValue<T> { + pub range: FileRange, + pub value: T, +} + +impl<T> RangedValue<T> { + pub fn file_range(&self) -> FileRange { + self.range + } +} + +impl<T> Deref for RangedValue<T> { + type Target = T; + + fn deref(&self) -> &Self::Target { + &self.value + } +} + +impl<T> DerefMut for RangedValue<T> { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.value + } +} + +impl<T> IntoIterator for RangedValue<T> +where + T: IntoIterator, +{ + type Item = T::Item; + type IntoIter = T::IntoIter; + + fn into_iter(self) -> Self::IntoIter { + self.value.into_iter() + } +} + +/// Target to which the editor can navigate to. +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct NavigationTarget { + file: File, + + /// The range that should be focused when navigating to the target. + /// + /// This is typically not the full range of the node. For example, it's the range of the class's name in a class definition. + /// + /// The `focus_range` must be fully covered by `full_range`. + focus_range: TextRange, + + /// The range covering the entire target. + full_range: TextRange, +} + +impl NavigationTarget { + pub fn file(&self) -> File { + self.file + } + + pub fn focus_range(&self) -> TextRange { + self.focus_range + } + + pub fn full_range(&self) -> TextRange { + self.full_range + } +} + +#[derive(Debug, Clone)] +pub struct NavigationTargets(smallvec::SmallVec<[NavigationTarget; 1]>); + +impl NavigationTargets { + fn single(target: NavigationTarget) -> Self { + Self(smallvec::smallvec![target]) + } + + fn empty() -> Self { + Self(smallvec::SmallVec::new()) + } + + fn unique(targets: impl IntoIterator<Item = NavigationTarget>) -> Self { + let unique: FxHashSet<_> = targets.into_iter().collect(); + if unique.is_empty() { + Self::empty() + } else { + let mut targets = unique.into_iter().collect::<Vec<_>>(); + targets.sort_by_key(|target| (target.file, target.focus_range.start())); + Self(targets.into()) + } + } + + fn iter(&self) -> std::slice::Iter<'_, NavigationTarget> { + self.0.iter() + } + + #[cfg(test)] + fn is_empty(&self) -> bool { + self.0.is_empty() + } +} + +impl IntoIterator for NavigationTargets { + type Item = NavigationTarget; + type IntoIter = smallvec::IntoIter<[NavigationTarget; 1]>; + + fn into_iter(self) -> Self::IntoIter { + self.0.into_iter() + } +} + +impl<'a> IntoIterator for &'a NavigationTargets { + type Item = &'a NavigationTarget; + type IntoIter = std::slice::Iter<'a, NavigationTarget>; + + fn into_iter(self) -> Self::IntoIter { + self.iter() + } +} + +impl FromIterator<NavigationTarget> for NavigationTargets { + fn from_iter<T: IntoIterator<Item = NavigationTarget>>(iter: T) -> Self { + Self::unique(iter) + } +} + +pub trait HasNavigationTargets { + fn navigation_targets(&self, db: &dyn Db) -> NavigationTargets; +} + +impl HasNavigationTargets for Type<'_> { + fn navigation_targets(&self, db: &dyn Db) -> NavigationTargets { + match self { + Type::Union(union) => union + .iter(db.upcast()) + .flat_map(|target| target.navigation_targets(db)) + .collect(), + + Type::Intersection(intersection) => { + // Only consider the positive elements because the negative elements are mainly from narrowing constraints. + let mut targets = intersection + .iter_positive(db.upcast()) + .filter(|ty| !ty.is_unknown()); + + let Some(first) = targets.next() else { + return NavigationTargets::empty(); + }; + + match targets.next() { + Some(_) => { + // If there are multiple types in the intersection, we can't navigate to a single one + // because the type is the intersection of all those types. + NavigationTargets::empty() + } + None => first.navigation_targets(db), + } + } + + ty => ty + .definition(db.upcast()) + .map(|definition| definition.navigation_targets(db)) + .unwrap_or_else(NavigationTargets::empty), + } + } +} + +impl HasNavigationTargets for TypeDefinition<'_> { + fn navigation_targets(&self, db: &dyn Db) -> NavigationTargets { + let Some(full_range) = self.full_range(db.upcast()) else { + return NavigationTargets::empty(); + }; + + NavigationTargets::single(NavigationTarget { + file: full_range.file(), + focus_range: self.focus_range(db.upcast()).unwrap_or(full_range).range(), + full_range: full_range.range(), + }) + } +} + +#[cfg(test)] +mod tests { + use crate::db::tests::TestDb; + use insta::internals::SettingsBindDropGuard; + use ruff_db::Upcast; + use ruff_db::diagnostic::{Diagnostic, DiagnosticFormat, DisplayDiagnosticConfig}; + use ruff_db::files::{File, system_path_to_file}; + use ruff_db::system::{DbWithWritableSystem, SystemPath, SystemPathBuf}; + use ruff_text_size::TextSize; + use ty_python_semantic::{ + Program, ProgramSettings, PythonPath, PythonPlatform, PythonVersionWithSource, + SearchPathSettings, + }; + + pub(super) fn cursor_test(source: &str) -> CursorTest { + let mut db = TestDb::new(); + let cursor_offset = source.find("<CURSOR>").expect( + "`source`` should contain a `<CURSOR>` marker, indicating the position of the cursor.", + ); + + let mut content = source[..cursor_offset].to_string(); + content.push_str(&source[cursor_offset + "<CURSOR>".len()..]); + + db.write_file("main.py", &content) + .expect("write to memory file system to be successful"); + + let file = system_path_to_file(&db, "main.py").expect("newly written file to existing"); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![SystemPathBuf::from("/")], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![]), + }, + }, + ) + .expect("Default settings to be valid"); + + let mut insta_settings = insta::Settings::clone_current(); + insta_settings.add_filter(r#"\\(\w\w|\s|\.|")"#, "/$1"); + // Filter out TODO types because they are different between debug and release builds. + insta_settings.add_filter(r"@Todo\(.+\)", "@Todo"); + + let insta_settings_guard = insta_settings.bind_to_scope(); + + CursorTest { + db, + cursor_offset: TextSize::try_from(cursor_offset) + .expect("source to be smaller than 4GB"), + file, + _insta_settings_guard: insta_settings_guard, + } + } + + pub(super) struct CursorTest { + pub(super) db: TestDb, + pub(super) cursor_offset: TextSize, + pub(super) file: File, + _insta_settings_guard: SettingsBindDropGuard, + } + + impl CursorTest { + pub(super) fn write_file( + &mut self, + path: impl AsRef<SystemPath>, + content: &str, + ) -> std::io::Result<()> { + self.db.write_file(path, content) + } + + pub(super) fn render_diagnostics<I, D>(&self, diagnostics: I) -> String + where + I: IntoIterator<Item = D>, + D: IntoDiagnostic, + { + use std::fmt::Write; + + let mut buf = String::new(); + + let config = DisplayDiagnosticConfig::default() + .color(false) + .format(DiagnosticFormat::Full); + for diagnostic in diagnostics { + let diag = diagnostic.into_diagnostic(); + write!(buf, "{}", diag.display(&self.db.upcast(), &config)).unwrap(); + } + + buf + } + } + + pub(super) trait IntoDiagnostic { + fn into_diagnostic(self) -> Diagnostic; + } +} diff --git a/crates/ty_ide/src/markup.rs b/crates/ty_ide/src/markup.rs new file mode 100644 index 0000000000000..129489eb0b238 --- /dev/null +++ b/crates/ty_ide/src/markup.rs @@ -0,0 +1,66 @@ +use std::fmt; +use std::fmt::Formatter; + +#[derive(Debug, Copy, Clone, Eq, PartialEq)] +pub enum MarkupKind { + PlainText, + Markdown, +} + +impl MarkupKind { + pub(crate) const fn fenced_code_block<T>(self, code: T, language: &str) -> FencedCodeBlock<T> + where + T: fmt::Display, + { + FencedCodeBlock { + language, + code, + kind: self, + } + } + + pub(crate) const fn horizontal_line(self) -> HorizontalLine { + HorizontalLine { kind: self } + } +} + +pub(crate) struct FencedCodeBlock<'a, T> { + language: &'a str, + code: T, + kind: MarkupKind, +} + +impl<T> fmt::Display for FencedCodeBlock<'_, T> +where + T: fmt::Display, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self.kind { + MarkupKind::PlainText => self.code.fmt(f), + MarkupKind::Markdown => write!( + f, + "```{language}\n{code}\n```", + language = self.language, + code = self.code + ), + } + } +} + +#[derive(Debug, Copy, Clone)] +pub(crate) struct HorizontalLine { + kind: MarkupKind, +} + +impl fmt::Display for HorizontalLine { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self.kind { + MarkupKind::PlainText => { + f.write_str("\n---------------------------------------------\n") + } + MarkupKind::Markdown => { + write!(f, "\n---\n") + } + } + } +} diff --git a/crates/ty_project/Cargo.toml b/crates/ty_project/Cargo.toml new file mode 100644 index 0000000000000..c6e30a6abc225 --- /dev/null +++ b/crates/ty_project/Cargo.toml @@ -0,0 +1,53 @@ +[package] +name = "ty_project" +version = "0.0.0" +edition.workspace = true +rust-version.workspace = true +homepage.workspace = true +documentation.workspace = true +repository.workspace = true +authors.workspace = true +license.workspace = true + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +ruff_cache = { workspace = true } +ruff_db = { workspace = true, features = ["cache", "serde"] } +ruff_macros = { workspace = true } +ruff_options_metadata = { workspace = true } +ruff_python_ast = { workspace = true, features = ["serde"] } +ruff_python_formatter = { workspace = true, optional = true } +ruff_text_size = { workspace = true } +ty_ide = { workspace = true } +ty_python_semantic = { workspace = true, features = ["serde"] } +ty_vendored = { workspace = true } + +anyhow = { workspace = true } +crossbeam = { workspace = true } +glob = { workspace = true } +notify = { workspace = true } +pep440_rs = { workspace = true, features = ["version-ranges"] } +rayon = { workspace = true } +rustc-hash = { workspace = true } +salsa = { workspace = true } +schemars = { workspace = true, optional = true } +serde = { workspace = true } +thiserror = { workspace = true } +toml = { workspace = true } +tracing = { workspace = true } + +[dev-dependencies] +ruff_db = { workspace = true, features = ["testing"] } +glob = { workspace = true } +insta = { workspace = true, features = ["redactions", "ron"] } + +[features] +default = ["zstd"] +deflate = ["ty_vendored/deflate"] +schemars = ["dep:schemars", "ruff_db/schemars", "ty_python_semantic/schemars"] +zstd = ["ty_vendored/zstd"] +format = ["ruff_python_formatter"] + +[lints] +workspace = true diff --git a/crates/red_knot_workspace/resources/test/corpus/00_const.py b/crates/ty_project/resources/test/corpus/00_const.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/00_const.py rename to crates/ty_project/resources/test/corpus/00_const.py diff --git a/crates/red_knot_workspace/resources/test/corpus/00_empty.py b/crates/ty_project/resources/test/corpus/00_empty.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/00_empty.py rename to crates/ty_project/resources/test/corpus/00_empty.py diff --git a/crates/red_knot_workspace/resources/test/corpus/00_expr_discard.py b/crates/ty_project/resources/test/corpus/00_expr_discard.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/00_expr_discard.py rename to crates/ty_project/resources/test/corpus/00_expr_discard.py diff --git a/crates/red_knot_workspace/resources/test/corpus/00_expr_var1.py b/crates/ty_project/resources/test/corpus/00_expr_var1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/00_expr_var1.py rename to crates/ty_project/resources/test/corpus/00_expr_var1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/01_expr_unary.py b/crates/ty_project/resources/test/corpus/01_expr_unary.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/01_expr_unary.py rename to crates/ty_project/resources/test/corpus/01_expr_unary.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_attr.py b/crates/ty_project/resources/test/corpus/02_expr_attr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_attr.py rename to crates/ty_project/resources/test/corpus/02_expr_attr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_attr_multiline.py b/crates/ty_project/resources/test/corpus/02_expr_attr_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_attr_multiline.py rename to crates/ty_project/resources/test/corpus/02_expr_attr_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_attr_multiline_assign.py b/crates/ty_project/resources/test/corpus/02_expr_attr_multiline_assign.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_attr_multiline_assign.py rename to crates/ty_project/resources/test/corpus/02_expr_attr_multiline_assign.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_bin_bool.py b/crates/ty_project/resources/test/corpus/02_expr_bin_bool.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_bin_bool.py rename to crates/ty_project/resources/test/corpus/02_expr_bin_bool.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_binary.py b/crates/ty_project/resources/test/corpus/02_expr_binary.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_binary.py rename to crates/ty_project/resources/test/corpus/02_expr_binary.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_bool_op_multiline.py b/crates/ty_project/resources/test/corpus/02_expr_bool_op_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_bool_op_multiline.py rename to crates/ty_project/resources/test/corpus/02_expr_bool_op_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_bool_op_multiline2.py b/crates/ty_project/resources/test/corpus/02_expr_bool_op_multiline2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_bool_op_multiline2.py rename to crates/ty_project/resources/test/corpus/02_expr_bool_op_multiline2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_rel.py b/crates/ty_project/resources/test/corpus/02_expr_rel.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_rel.py rename to crates/ty_project/resources/test/corpus/02_expr_rel.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_rel_multiple.py b/crates/ty_project/resources/test/corpus/02_expr_rel_multiple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_rel_multiple.py rename to crates/ty_project/resources/test/corpus/02_expr_rel_multiple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/02_expr_subscr.py b/crates/ty_project/resources/test/corpus/02_expr_subscr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/02_expr_subscr.py rename to crates/ty_project/resources/test/corpus/02_expr_subscr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_dict.py b/crates/ty_project/resources/test/corpus/03_dict.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_dict.py rename to crates/ty_project/resources/test/corpus/03_dict.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_dict_ex.py b/crates/ty_project/resources/test/corpus/03_dict_ex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_dict_ex.py rename to crates/ty_project/resources/test/corpus/03_dict_ex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_dict_literal_large.py b/crates/ty_project/resources/test/corpus/03_dict_literal_large.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_dict_literal_large.py rename to crates/ty_project/resources/test/corpus/03_dict_literal_large.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_dict_unpack_huge.py b/crates/ty_project/resources/test/corpus/03_dict_unpack_huge.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_dict_unpack_huge.py rename to crates/ty_project/resources/test/corpus/03_dict_unpack_huge.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_list.py b/crates/ty_project/resources/test/corpus/03_list.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_list.py rename to crates/ty_project/resources/test/corpus/03_list.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_list_ex.py b/crates/ty_project/resources/test/corpus/03_list_ex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_list_ex.py rename to crates/ty_project/resources/test/corpus/03_list_ex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_list_large.py b/crates/ty_project/resources/test/corpus/03_list_large.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_list_large.py rename to crates/ty_project/resources/test/corpus/03_list_large.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_set.py b/crates/ty_project/resources/test/corpus/03_set.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_set.py rename to crates/ty_project/resources/test/corpus/03_set.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_set_multi.py b/crates/ty_project/resources/test/corpus/03_set_multi.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_set_multi.py rename to crates/ty_project/resources/test/corpus/03_set_multi.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_slice.py b/crates/ty_project/resources/test/corpus/03_slice.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_slice.py rename to crates/ty_project/resources/test/corpus/03_slice.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_slice_ext.py b/crates/ty_project/resources/test/corpus/03_slice_ext.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_slice_ext.py rename to crates/ty_project/resources/test/corpus/03_slice_ext.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_tuple.py b/crates/ty_project/resources/test/corpus/03_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_tuple.py rename to crates/ty_project/resources/test/corpus/03_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/03_tuple_ex.py b/crates/ty_project/resources/test/corpus/03_tuple_ex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/03_tuple_ex.py rename to crates/ty_project/resources/test/corpus/03_tuple_ex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign.py b/crates/ty_project/resources/test/corpus/04_assign.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign.py rename to crates/ty_project/resources/test/corpus/04_assign.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_attr.py b/crates/ty_project/resources/test/corpus/04_assign_attr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_attr.py rename to crates/ty_project/resources/test/corpus/04_assign_attr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_attr_func.py b/crates/ty_project/resources/test/corpus/04_assign_attr_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_attr_func.py rename to crates/ty_project/resources/test/corpus/04_assign_attr_func.py diff --git a/crates/ty_project/resources/test/corpus/04_assign_invalid_target.py b/crates/ty_project/resources/test/corpus/04_assign_invalid_target.py new file mode 120000 index 0000000000000..8d551b9f78d09 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/04_assign_invalid_target.py @@ -0,0 +1 @@ +../../../../ruff_python_parser/resources/invalid/statements/invalid_assignment_targets.py \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_named_expr.py b/crates/ty_project/resources/test/corpus/04_assign_named_expr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_named_expr.py rename to crates/ty_project/resources/test/corpus/04_assign_named_expr.py diff --git a/crates/ty_project/resources/test/corpus/04_assign_named_expr_invalid_target.py b/crates/ty_project/resources/test/corpus/04_assign_named_expr_invalid_target.py new file mode 120000 index 0000000000000..c751f9658700a --- /dev/null +++ b/crates/ty_project/resources/test/corpus/04_assign_named_expr_invalid_target.py @@ -0,0 +1 @@ +../../../../ruff_python_parser/resources/invalid/expressions/named/invalid_target.py \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_subscr.py b/crates/ty_project/resources/test/corpus/04_assign_subscr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_subscr.py rename to crates/ty_project/resources/test/corpus/04_assign_subscr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_unpack.py b/crates/ty_project/resources/test/corpus/04_assign_unpack.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_unpack.py rename to crates/ty_project/resources/test/corpus/04_assign_unpack.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_unpack_ex.py b/crates/ty_project/resources/test/corpus/04_assign_unpack_ex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_unpack_ex.py rename to crates/ty_project/resources/test/corpus/04_assign_unpack_ex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_assign_unpack_tuple.py b/crates/ty_project/resources/test/corpus/04_assign_unpack_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_assign_unpack_tuple.py rename to crates/ty_project/resources/test/corpus/04_assign_unpack_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_aug_assign.py b/crates/ty_project/resources/test/corpus/04_aug_assign.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_aug_assign.py rename to crates/ty_project/resources/test/corpus/04_aug_assign.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_aug_assign_attr_multiline.py b/crates/ty_project/resources/test/corpus/04_aug_assign_attr_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_aug_assign_attr_multiline.py rename to crates/ty_project/resources/test/corpus/04_aug_assign_attr_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/04_aug_assign_attr_sub.py b/crates/ty_project/resources/test/corpus/04_aug_assign_attr_sub.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/04_aug_assign_attr_sub.py rename to crates/ty_project/resources/test/corpus/04_aug_assign_attr_sub.py diff --git a/crates/ty_project/resources/test/corpus/04_aug_assign_invalid_target.py b/crates/ty_project/resources/test/corpus/04_aug_assign_invalid_target.py new file mode 120000 index 0000000000000..f3ebd5de4abc3 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/04_aug_assign_invalid_target.py @@ -0,0 +1 @@ +../../../../ruff_python_parser/resources/invalid/statements/invalid_augmented_assignment_target.py \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall.py b/crates/ty_project/resources/test/corpus/05_funcall.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall.py rename to crates/ty_project/resources/test/corpus/05_funcall.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_1.py b/crates/ty_project/resources/test/corpus/05_funcall_1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_1.py rename to crates/ty_project/resources/test/corpus/05_funcall_1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_2.py b/crates/ty_project/resources/test/corpus/05_funcall_2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_2.py rename to crates/ty_project/resources/test/corpus/05_funcall_2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_in_multiline_tuple.py b/crates/ty_project/resources/test/corpus/05_funcall_in_multiline_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_in_multiline_tuple.py rename to crates/ty_project/resources/test/corpus/05_funcall_in_multiline_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_kw.py b/crates/ty_project/resources/test/corpus/05_funcall_kw.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_kw.py rename to crates/ty_project/resources/test/corpus/05_funcall_kw.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_kw_many.py b/crates/ty_project/resources/test/corpus/05_funcall_kw_many.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_kw_many.py rename to crates/ty_project/resources/test/corpus/05_funcall_kw_many.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_kw_pos.py b/crates/ty_project/resources/test/corpus/05_funcall_kw_pos.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_kw_pos.py rename to crates/ty_project/resources/test/corpus/05_funcall_kw_pos.py diff --git a/crates/red_knot_workspace/resources/test/corpus/05_funcall_method_multiline.py b/crates/ty_project/resources/test/corpus/05_funcall_method_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/05_funcall_method_multiline.py rename to crates/ty_project/resources/test/corpus/05_funcall_method_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_kwargs.py b/crates/ty_project/resources/test/corpus/06_funcall_kwargs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_kwargs.py rename to crates/ty_project/resources/test/corpus/06_funcall_kwargs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_many_args.py b/crates/ty_project/resources/test/corpus/06_funcall_many_args.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_many_args.py rename to crates/ty_project/resources/test/corpus/06_funcall_many_args.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_starargs_ex.py b/crates/ty_project/resources/test/corpus/06_funcall_starargs_ex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_starargs_ex.py rename to crates/ty_project/resources/test/corpus/06_funcall_starargs_ex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs.py b/crates/ty_project/resources/test/corpus/06_funcall_varargs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs.py rename to crates/ty_project/resources/test/corpus/06_funcall_varargs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs_kwargs.py b/crates/ty_project/resources/test/corpus/06_funcall_varargs_kwargs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs_kwargs.py rename to crates/ty_project/resources/test/corpus/06_funcall_varargs_kwargs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs_kwargs_mixed.py b/crates/ty_project/resources/test/corpus/06_funcall_varargs_kwargs_mixed.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/06_funcall_varargs_kwargs_mixed.py rename to crates/ty_project/resources/test/corpus/06_funcall_varargs_kwargs_mixed.py diff --git a/crates/red_knot_workspace/resources/test/corpus/07_ifexpr.py b/crates/ty_project/resources/test/corpus/07_ifexpr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/07_ifexpr.py rename to crates/ty_project/resources/test/corpus/07_ifexpr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/07_ifexpr_multiline.py b/crates/ty_project/resources/test/corpus/07_ifexpr_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/07_ifexpr_multiline.py rename to crates/ty_project/resources/test/corpus/07_ifexpr_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/07_ifexpr_multiline2.py b/crates/ty_project/resources/test/corpus/07_ifexpr_multiline2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/07_ifexpr_multiline2.py rename to crates/ty_project/resources/test/corpus/07_ifexpr_multiline2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/08_del.py b/crates/ty_project/resources/test/corpus/08_del.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/08_del.py rename to crates/ty_project/resources/test/corpus/08_del.py diff --git a/crates/red_knot_workspace/resources/test/corpus/08_del_multi.py b/crates/ty_project/resources/test/corpus/08_del_multi.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/08_del_multi.py rename to crates/ty_project/resources/test/corpus/08_del_multi.py diff --git a/crates/red_knot_workspace/resources/test/corpus/09_pass.py b/crates/ty_project/resources/test/corpus/09_pass.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/09_pass.py rename to crates/ty_project/resources/test/corpus/09_pass.py diff --git a/crates/red_knot_workspace/resources/test/corpus/10_if.py b/crates/ty_project/resources/test/corpus/10_if.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/10_if.py rename to crates/ty_project/resources/test/corpus/10_if.py diff --git a/crates/red_knot_workspace/resources/test/corpus/10_if_chained_compare.py b/crates/ty_project/resources/test/corpus/10_if_chained_compare.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/10_if_chained_compare.py rename to crates/ty_project/resources/test/corpus/10_if_chained_compare.py diff --git a/crates/red_knot_workspace/resources/test/corpus/10_if_false.py b/crates/ty_project/resources/test/corpus/10_if_false.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/10_if_false.py rename to crates/ty_project/resources/test/corpus/10_if_false.py diff --git a/crates/ty_project/resources/test/corpus/10_if_invalid.py b/crates/ty_project/resources/test/corpus/10_if_invalid.py new file mode 100644 index 0000000000000..fc8fca60263b1 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/10_if_invalid.py @@ -0,0 +1 @@ +x if $z diff --git a/crates/red_knot_workspace/resources/test/corpus/10_if_true.py b/crates/ty_project/resources/test/corpus/10_if_true.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/10_if_true.py rename to crates/ty_project/resources/test/corpus/10_if_true.py diff --git a/crates/red_knot_workspace/resources/test/corpus/10_if_with_named_expr.py b/crates/ty_project/resources/test/corpus/10_if_with_named_expr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/10_if_with_named_expr.py rename to crates/ty_project/resources/test/corpus/10_if_with_named_expr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/11_if_else.py b/crates/ty_project/resources/test/corpus/11_if_else.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/11_if_else.py rename to crates/ty_project/resources/test/corpus/11_if_else.py diff --git a/crates/red_knot_workspace/resources/test/corpus/11_if_else_deeply_nested_for.py b/crates/ty_project/resources/test/corpus/11_if_else_deeply_nested_for.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/11_if_else_deeply_nested_for.py rename to crates/ty_project/resources/test/corpus/11_if_else_deeply_nested_for.py diff --git a/crates/red_knot_workspace/resources/test/corpus/11_if_else_false.py b/crates/ty_project/resources/test/corpus/11_if_else_false.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/11_if_else_false.py rename to crates/ty_project/resources/test/corpus/11_if_else_false.py diff --git a/crates/red_knot_workspace/resources/test/corpus/11_if_else_true.py b/crates/ty_project/resources/test/corpus/11_if_else_true.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/11_if_else_true.py rename to crates/ty_project/resources/test/corpus/11_if_else_true.py diff --git a/crates/red_knot_workspace/resources/test/corpus/12_if_elif.py b/crates/ty_project/resources/test/corpus/12_if_elif.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/12_if_elif.py rename to crates/ty_project/resources/test/corpus/12_if_elif.py diff --git a/crates/red_knot_workspace/resources/test/corpus/12_if_elif_else.py b/crates/ty_project/resources/test/corpus/12_if_elif_else.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/12_if_elif_else.py rename to crates/ty_project/resources/test/corpus/12_if_elif_else.py diff --git a/crates/red_knot_workspace/resources/test/corpus/13_ifelse_complex1.py b/crates/ty_project/resources/test/corpus/13_ifelse_complex1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/13_ifelse_complex1.py rename to crates/ty_project/resources/test/corpus/13_ifelse_complex1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/13_ifelse_many.py b/crates/ty_project/resources/test/corpus/13_ifelse_many.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/13_ifelse_many.py rename to crates/ty_project/resources/test/corpus/13_ifelse_many.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while.py b/crates/ty_project/resources/test/corpus/15_while.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while.py rename to crates/ty_project/resources/test/corpus/15_while.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_break.py b/crates/ty_project/resources/test/corpus/15_while_break.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_break.py rename to crates/ty_project/resources/test/corpus/15_while_break.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_break_in_finally.py b/crates/ty_project/resources/test/corpus/15_while_break_in_finally.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_break_in_finally.py rename to crates/ty_project/resources/test/corpus/15_while_break_in_finally.py diff --git a/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_class.py b/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_class.py new file mode 100644 index 0000000000000..934ec4dc17642 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_class.py @@ -0,0 +1,6 @@ +while True: + + class A: + x: int + + break diff --git a/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_func.py b/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_func.py new file mode 100644 index 0000000000000..83e818f80ec63 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/15_while_break_invalid_in_func.py @@ -0,0 +1,6 @@ +while True: + + def b(): + x: int + + break diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_break_non_empty.py b/crates/ty_project/resources/test/corpus/15_while_break_non_empty.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_break_non_empty.py rename to crates/ty_project/resources/test/corpus/15_while_break_non_empty.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_break_non_exit.py b/crates/ty_project/resources/test/corpus/15_while_break_non_exit.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_break_non_exit.py rename to crates/ty_project/resources/test/corpus/15_while_break_non_exit.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_continue.py b/crates/ty_project/resources/test/corpus/15_while_continue.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_continue.py rename to crates/ty_project/resources/test/corpus/15_while_continue.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_false.py b/crates/ty_project/resources/test/corpus/15_while_false.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_false.py rename to crates/ty_project/resources/test/corpus/15_while_false.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_infinite.py b/crates/ty_project/resources/test/corpus/15_while_infinite.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_infinite.py rename to crates/ty_project/resources/test/corpus/15_while_infinite.py diff --git a/crates/red_knot_workspace/resources/test/corpus/15_while_true.py b/crates/ty_project/resources/test/corpus/15_while_true.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/15_while_true.py rename to crates/ty_project/resources/test/corpus/15_while_true.py diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for.py b/crates/ty_project/resources/test/corpus/16_for.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for.py rename to crates/ty_project/resources/test/corpus/16_for.py diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for_break.py b/crates/ty_project/resources/test/corpus/16_for_break.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for_break.py rename to crates/ty_project/resources/test/corpus/16_for_break.py diff --git a/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_class.py b/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_class.py new file mode 100644 index 0000000000000..9f6aa028021fe --- /dev/null +++ b/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_class.py @@ -0,0 +1,6 @@ +for _ in range(1): + + class A: + x: int + + break diff --git a/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_func.py b/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_func.py new file mode 100644 index 0000000000000..a4cf76e29f162 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/16_for_break_invalid_in_func.py @@ -0,0 +1,6 @@ +for _ in range(1): + + def b(): + x: int + + break diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for_continue.py b/crates/ty_project/resources/test/corpus/16_for_continue.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for_continue.py rename to crates/ty_project/resources/test/corpus/16_for_continue.py diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for_else.py b/crates/ty_project/resources/test/corpus/16_for_else.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for_else.py rename to crates/ty_project/resources/test/corpus/16_for_else.py diff --git a/crates/ty_project/resources/test/corpus/16_for_invalid.py b/crates/ty_project/resources/test/corpus/16_for_invalid.py new file mode 100644 index 0000000000000..54578ea3b3fb8 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/16_for_invalid.py @@ -0,0 +1 @@ +for diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for_list_literal.py b/crates/ty_project/resources/test/corpus/16_for_list_literal.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for_list_literal.py rename to crates/ty_project/resources/test/corpus/16_for_list_literal.py diff --git a/crates/red_knot_workspace/resources/test/corpus/16_for_nested_ifs.py b/crates/ty_project/resources/test/corpus/16_for_nested_ifs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/16_for_nested_ifs.py rename to crates/ty_project/resources/test/corpus/16_for_nested_ifs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/20_lambda.py b/crates/ty_project/resources/test/corpus/20_lambda.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/20_lambda.py rename to crates/ty_project/resources/test/corpus/20_lambda.py diff --git a/crates/red_knot_workspace/resources/test/corpus/20_lambda_const.py b/crates/ty_project/resources/test/corpus/20_lambda_const.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/20_lambda_const.py rename to crates/ty_project/resources/test/corpus/20_lambda_const.py diff --git a/crates/red_knot_workspace/resources/test/corpus/20_lambda_default_arg.py b/crates/ty_project/resources/test/corpus/20_lambda_default_arg.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/20_lambda_default_arg.py rename to crates/ty_project/resources/test/corpus/20_lambda_default_arg.py diff --git a/crates/red_knot_workspace/resources/test/corpus/20_lambda_ifelse.py b/crates/ty_project/resources/test/corpus/20_lambda_ifelse.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/20_lambda_ifelse.py rename to crates/ty_project/resources/test/corpus/20_lambda_ifelse.py diff --git a/crates/red_knot_workspace/resources/test/corpus/21_func1.py b/crates/ty_project/resources/test/corpus/21_func1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/21_func1.py rename to crates/ty_project/resources/test/corpus/21_func1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/21_func1_ret.py b/crates/ty_project/resources/test/corpus/21_func1_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/21_func1_ret.py rename to crates/ty_project/resources/test/corpus/21_func1_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/21_func_assign.py b/crates/ty_project/resources/test/corpus/21_func_assign.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/21_func_assign.py rename to crates/ty_project/resources/test/corpus/21_func_assign.py diff --git a/crates/red_knot_workspace/resources/test/corpus/21_func_assign2.py b/crates/ty_project/resources/test/corpus/21_func_assign2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/21_func_assign2.py rename to crates/ty_project/resources/test/corpus/21_func_assign2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/22_func_arg.py b/crates/ty_project/resources/test/corpus/22_func_arg.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/22_func_arg.py rename to crates/ty_project/resources/test/corpus/22_func_arg.py diff --git a/crates/red_knot_workspace/resources/test/corpus/22_func_vararg.py b/crates/ty_project/resources/test/corpus/22_func_vararg.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/22_func_vararg.py rename to crates/ty_project/resources/test/corpus/22_func_vararg.py diff --git a/crates/red_knot_workspace/resources/test/corpus/23_func_ret.py b/crates/ty_project/resources/test/corpus/23_func_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/23_func_ret.py rename to crates/ty_project/resources/test/corpus/23_func_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/23_func_ret_val.py b/crates/ty_project/resources/test/corpus/23_func_ret_val.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/23_func_ret_val.py rename to crates/ty_project/resources/test/corpus/23_func_ret_val.py diff --git a/crates/red_knot_workspace/resources/test/corpus/24_func_if_ret.py b/crates/ty_project/resources/test/corpus/24_func_if_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/24_func_if_ret.py rename to crates/ty_project/resources/test/corpus/24_func_if_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/24_func_ifelse_ret.py b/crates/ty_project/resources/test/corpus/24_func_ifelse_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/24_func_ifelse_ret.py rename to crates/ty_project/resources/test/corpus/24_func_ifelse_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/24_func_ifnot_ret.py b/crates/ty_project/resources/test/corpus/24_func_ifnot_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/24_func_ifnot_ret.py rename to crates/ty_project/resources/test/corpus/24_func_ifnot_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/25_func_annotations.py b/crates/ty_project/resources/test/corpus/25_func_annotations.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/25_func_annotations.py rename to crates/ty_project/resources/test/corpus/25_func_annotations.py diff --git a/crates/red_knot_workspace/resources/test/corpus/25_func_annotations_nested.py b/crates/ty_project/resources/test/corpus/25_func_annotations_nested.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/25_func_annotations_nested.py rename to crates/ty_project/resources/test/corpus/25_func_annotations_nested.py diff --git a/crates/red_knot_workspace/resources/test/corpus/25_func_annotations_same_name.py b/crates/ty_project/resources/test/corpus/25_func_annotations_same_name.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/25_func_annotations_same_name.py rename to crates/ty_project/resources/test/corpus/25_func_annotations_same_name.py diff --git a/crates/red_knot_workspace/resources/test/corpus/25_func_annotations_scope.py b/crates/ty_project/resources/test/corpus/25_func_annotations_scope.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/25_func_annotations_scope.py rename to crates/ty_project/resources/test/corpus/25_func_annotations_scope.py diff --git a/crates/ty_project/resources/test/corpus/25_func_annotations_starred.py b/crates/ty_project/resources/test/corpus/25_func_annotations_starred.py new file mode 100644 index 0000000000000..f48393b640d42 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/25_func_annotations_starred.py @@ -0,0 +1,8 @@ +# Regression test for https://github.com/astral-sh/ruff/issues/14115 +# +# This is invalid syntax, but should not lead to a crash. + +def f() -> *int: ... + + +f() diff --git a/crates/red_knot_workspace/resources/test/corpus/26_func_const_defaults.py b/crates/ty_project/resources/test/corpus/26_func_const_defaults.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/26_func_const_defaults.py rename to crates/ty_project/resources/test/corpus/26_func_const_defaults.py diff --git a/crates/red_knot_workspace/resources/test/corpus/26_func_defaults_same_name.py b/crates/ty_project/resources/test/corpus/26_func_defaults_same_name.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/26_func_defaults_same_name.py rename to crates/ty_project/resources/test/corpus/26_func_defaults_same_name.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic.py b/crates/ty_project/resources/test/corpus/27_func_generic.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic.py rename to crates/ty_project/resources/test/corpus/27_func_generic.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_bound.py b/crates/ty_project/resources/test/corpus/27_func_generic_bound.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_bound.py rename to crates/ty_project/resources/test/corpus/27_func_generic_bound.py diff --git a/crates/ty_project/resources/test/corpus/27_func_generic_constraint.py b/crates/ty_project/resources/test/corpus/27_func_generic_constraint.py new file mode 100644 index 0000000000000..763eea48276b2 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/27_func_generic_constraint.py @@ -0,0 +1,5 @@ +def foo[T: (str, bytes)](x: T) -> T: + ... + +def bar[T: (str,)](x: T) -> T: + ... diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_default.py b/crates/ty_project/resources/test/corpus/27_func_generic_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_default.py rename to crates/ty_project/resources/test/corpus/27_func_generic_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_paramspec.py b/crates/ty_project/resources/test/corpus/27_func_generic_paramspec.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_paramspec.py rename to crates/ty_project/resources/test/corpus/27_func_generic_paramspec.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_paramspec_default.py b/crates/ty_project/resources/test/corpus/27_func_generic_paramspec_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_paramspec_default.py rename to crates/ty_project/resources/test/corpus/27_func_generic_paramspec_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_tuple.py b/crates/ty_project/resources/test/corpus/27_func_generic_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_tuple.py rename to crates/ty_project/resources/test/corpus/27_func_generic_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/27_func_generic_tuple_default.py b/crates/ty_project/resources/test/corpus/27_func_generic_tuple_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/27_func_generic_tuple_default.py rename to crates/ty_project/resources/test/corpus/27_func_generic_tuple_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/30_func_enclosed.py b/crates/ty_project/resources/test/corpus/30_func_enclosed.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/30_func_enclosed.py rename to crates/ty_project/resources/test/corpus/30_func_enclosed.py diff --git a/crates/red_knot_workspace/resources/test/corpus/30_func_enclosed_many.py b/crates/ty_project/resources/test/corpus/30_func_enclosed_many.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/30_func_enclosed_many.py rename to crates/ty_project/resources/test/corpus/30_func_enclosed_many.py diff --git a/crates/red_knot_workspace/resources/test/corpus/31_func_global.py b/crates/ty_project/resources/test/corpus/31_func_global.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/31_func_global.py rename to crates/ty_project/resources/test/corpus/31_func_global.py diff --git a/crates/red_knot_workspace/resources/test/corpus/31_func_global_annotated_later.py b/crates/ty_project/resources/test/corpus/31_func_global_annotated_later.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/31_func_global_annotated_later.py rename to crates/ty_project/resources/test/corpus/31_func_global_annotated_later.py diff --git a/crates/red_knot_workspace/resources/test/corpus/31_func_nonlocal.py b/crates/ty_project/resources/test/corpus/31_func_nonlocal.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/31_func_nonlocal.py rename to crates/ty_project/resources/test/corpus/31_func_nonlocal.py diff --git a/crates/red_knot_workspace/resources/test/corpus/32_func_global_nested.py b/crates/ty_project/resources/test/corpus/32_func_global_nested.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/32_func_global_nested.py rename to crates/ty_project/resources/test/corpus/32_func_global_nested.py diff --git a/crates/red_knot_workspace/resources/test/corpus/33_func_with_docstring_optimizable_tuple_and_return.py b/crates/ty_project/resources/test/corpus/33_func_with_docstring_optimizable_tuple_and_return.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/33_func_with_docstring_optimizable_tuple_and_return.py rename to crates/ty_project/resources/test/corpus/33_func_with_docstring_optimizable_tuple_and_return.py diff --git a/crates/red_knot_workspace/resources/test/corpus/40_import.py b/crates/ty_project/resources/test/corpus/40_import.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/40_import.py rename to crates/ty_project/resources/test/corpus/40_import.py diff --git a/crates/red_knot_workspace/resources/test/corpus/41_from_import.py b/crates/ty_project/resources/test/corpus/41_from_import.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/41_from_import.py rename to crates/ty_project/resources/test/corpus/41_from_import.py diff --git a/crates/red_knot_workspace/resources/test/corpus/42_import_from_dot.py b/crates/ty_project/resources/test/corpus/42_import_from_dot.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/42_import_from_dot.py rename to crates/ty_project/resources/test/corpus/42_import_from_dot.py diff --git a/crates/red_knot_workspace/resources/test/corpus/50_yield.py b/crates/ty_project/resources/test/corpus/50_yield.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/50_yield.py rename to crates/ty_project/resources/test/corpus/50_yield.py diff --git a/crates/red_knot_workspace/resources/test/corpus/51_gen_comp.py b/crates/ty_project/resources/test/corpus/51_gen_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/51_gen_comp.py rename to crates/ty_project/resources/test/corpus/51_gen_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/51_gen_comp2.py b/crates/ty_project/resources/test/corpus/51_gen_comp2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/51_gen_comp2.py rename to crates/ty_project/resources/test/corpus/51_gen_comp2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/52_gen_comp_if.py b/crates/ty_project/resources/test/corpus/52_gen_comp_if.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/52_gen_comp_if.py rename to crates/ty_project/resources/test/corpus/52_gen_comp_if.py diff --git a/crates/red_knot_workspace/resources/test/corpus/53_dict_comp.py b/crates/ty_project/resources/test/corpus/53_dict_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/53_dict_comp.py rename to crates/ty_project/resources/test/corpus/53_dict_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/53_list_comp.py b/crates/ty_project/resources/test/corpus/53_list_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/53_list_comp.py rename to crates/ty_project/resources/test/corpus/53_list_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/53_list_comp_method.py b/crates/ty_project/resources/test/corpus/53_list_comp_method.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/53_list_comp_method.py rename to crates/ty_project/resources/test/corpus/53_list_comp_method.py diff --git a/crates/red_knot_workspace/resources/test/corpus/53_set_comp.py b/crates/ty_project/resources/test/corpus/53_set_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/53_set_comp.py rename to crates/ty_project/resources/test/corpus/53_set_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/54_list_comp_func.py b/crates/ty_project/resources/test/corpus/54_list_comp_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/54_list_comp_func.py rename to crates/ty_project/resources/test/corpus/54_list_comp_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/54_list_comp_lambda.py b/crates/ty_project/resources/test/corpus/54_list_comp_lambda.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/54_list_comp_lambda.py rename to crates/ty_project/resources/test/corpus/54_list_comp_lambda.py diff --git a/crates/red_knot_workspace/resources/test/corpus/54_list_comp_lambda_listcomp.py b/crates/ty_project/resources/test/corpus/54_list_comp_lambda_listcomp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/54_list_comp_lambda_listcomp.py rename to crates/ty_project/resources/test/corpus/54_list_comp_lambda_listcomp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/54_list_comp_recur_func.py b/crates/ty_project/resources/test/corpus/54_list_comp_recur_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/54_list_comp_recur_func.py rename to crates/ty_project/resources/test/corpus/54_list_comp_recur_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/55_list_comp_nested.py b/crates/ty_project/resources/test/corpus/55_list_comp_nested.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/55_list_comp_nested.py rename to crates/ty_project/resources/test/corpus/55_list_comp_nested.py diff --git a/crates/red_knot_workspace/resources/test/corpus/56_yield_from.py b/crates/ty_project/resources/test/corpus/56_yield_from.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/56_yield_from.py rename to crates/ty_project/resources/test/corpus/56_yield_from.py diff --git a/crates/red_knot_workspace/resources/test/corpus/57_await.py b/crates/ty_project/resources/test/corpus/57_await.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/57_await.py rename to crates/ty_project/resources/test/corpus/57_await.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for.py b/crates/ty_project/resources/test/corpus/58_async_for.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for.py rename to crates/ty_project/resources/test/corpus/58_async_for.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_break.py b/crates/ty_project/resources/test/corpus/58_async_for_break.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_break.py rename to crates/ty_project/resources/test/corpus/58_async_for_break.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_continue.py b/crates/ty_project/resources/test/corpus/58_async_for_continue.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_continue.py rename to crates/ty_project/resources/test/corpus/58_async_for_continue.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_dict_comp.py b/crates/ty_project/resources/test/corpus/58_async_for_dict_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_dict_comp.py rename to crates/ty_project/resources/test/corpus/58_async_for_dict_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_else.py b/crates/ty_project/resources/test/corpus/58_async_for_else.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_else.py rename to crates/ty_project/resources/test/corpus/58_async_for_else.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_gen_comp.py b/crates/ty_project/resources/test/corpus/58_async_for_gen_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_gen_comp.py rename to crates/ty_project/resources/test/corpus/58_async_for_gen_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_list_comp.py b/crates/ty_project/resources/test/corpus/58_async_for_list_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_list_comp.py rename to crates/ty_project/resources/test/corpus/58_async_for_list_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/58_async_for_set_comp.py b/crates/ty_project/resources/test/corpus/58_async_for_set_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/58_async_for_set_comp.py rename to crates/ty_project/resources/test/corpus/58_async_for_set_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/59_async_with.py b/crates/ty_project/resources/test/corpus/59_async_with.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/59_async_with.py rename to crates/ty_project/resources/test/corpus/59_async_with.py diff --git a/crates/red_knot_workspace/resources/test/corpus/59_async_with_nested_with.py b/crates/ty_project/resources/test/corpus/59_async_with_nested_with.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/59_async_with_nested_with.py rename to crates/ty_project/resources/test/corpus/59_async_with_nested_with.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_except.py b/crates/ty_project/resources/test/corpus/60_try_except.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_except.py rename to crates/ty_project/resources/test/corpus/60_try_except.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_except2.py b/crates/ty_project/resources/test/corpus/60_try_except2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_except2.py rename to crates/ty_project/resources/test/corpus/60_try_except2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_except_bare.py b/crates/ty_project/resources/test/corpus/60_try_except_bare.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_except_bare.py rename to crates/ty_project/resources/test/corpus/60_try_except_bare.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_finally.py b/crates/ty_project/resources/test/corpus/60_try_finally.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_finally.py rename to crates/ty_project/resources/test/corpus/60_try_finally.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_finally_codeobj.py b/crates/ty_project/resources/test/corpus/60_try_finally_codeobj.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_finally_codeobj.py rename to crates/ty_project/resources/test/corpus/60_try_finally_codeobj.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_finally_cond.py b/crates/ty_project/resources/test/corpus/60_try_finally_cond.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_finally_cond.py rename to crates/ty_project/resources/test/corpus/60_try_finally_cond.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_finally_for.py b/crates/ty_project/resources/test/corpus/60_try_finally_for.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_finally_for.py rename to crates/ty_project/resources/test/corpus/60_try_finally_for.py diff --git a/crates/red_knot_workspace/resources/test/corpus/60_try_finally_ret.py b/crates/ty_project/resources/test/corpus/60_try_finally_ret.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/60_try_finally_ret.py rename to crates/ty_project/resources/test/corpus/60_try_finally_ret.py diff --git a/crates/red_knot_workspace/resources/test/corpus/61_try_except_finally.py b/crates/ty_project/resources/test/corpus/61_try_except_finally.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/61_try_except_finally.py rename to crates/ty_project/resources/test/corpus/61_try_except_finally.py diff --git a/crates/red_knot_workspace/resources/test/corpus/62_try_except_as.py b/crates/ty_project/resources/test/corpus/62_try_except_as.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/62_try_except_as.py rename to crates/ty_project/resources/test/corpus/62_try_except_as.py diff --git a/crates/red_knot_workspace/resources/test/corpus/62_try_except_break.py b/crates/ty_project/resources/test/corpus/62_try_except_break.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/62_try_except_break.py rename to crates/ty_project/resources/test/corpus/62_try_except_break.py diff --git a/crates/red_knot_workspace/resources/test/corpus/62_try_except_cond.py b/crates/ty_project/resources/test/corpus/62_try_except_cond.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/62_try_except_cond.py rename to crates/ty_project/resources/test/corpus/62_try_except_cond.py diff --git a/crates/red_knot_workspace/resources/test/corpus/62_try_except_double_nested_inside_if_else.py b/crates/ty_project/resources/test/corpus/62_try_except_double_nested_inside_if_else.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/62_try_except_double_nested_inside_if_else.py rename to crates/ty_project/resources/test/corpus/62_try_except_double_nested_inside_if_else.py diff --git a/crates/red_knot_workspace/resources/test/corpus/62_try_except_return.py b/crates/ty_project/resources/test/corpus/62_try_except_return.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/62_try_except_return.py rename to crates/ty_project/resources/test/corpus/62_try_except_return.py diff --git a/crates/red_knot_workspace/resources/test/corpus/63_raise.py b/crates/ty_project/resources/test/corpus/63_raise.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/63_raise.py rename to crates/ty_project/resources/test/corpus/63_raise.py diff --git a/crates/red_knot_workspace/resources/test/corpus/63_raise_func.py b/crates/ty_project/resources/test/corpus/63_raise_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/63_raise_func.py rename to crates/ty_project/resources/test/corpus/63_raise_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/63_raise_x.py b/crates/ty_project/resources/test/corpus/63_raise_x.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/63_raise_x.py rename to crates/ty_project/resources/test/corpus/63_raise_x.py diff --git a/crates/red_knot_workspace/resources/test/corpus/63_raise_x_from_y.py b/crates/ty_project/resources/test/corpus/63_raise_x_from_y.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/63_raise_x_from_y.py rename to crates/ty_project/resources/test/corpus/63_raise_x_from_y.py diff --git a/crates/red_knot_workspace/resources/test/corpus/64_assert.py b/crates/ty_project/resources/test/corpus/64_assert.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/64_assert.py rename to crates/ty_project/resources/test/corpus/64_assert.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with.py b/crates/ty_project/resources/test/corpus/67_with.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with.py rename to crates/ty_project/resources/test/corpus/67_with.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_as.py b/crates/ty_project/resources/test/corpus/67_with_as.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_as.py rename to crates/ty_project/resources/test/corpus/67_with_as.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_as_func.py b/crates/ty_project/resources/test/corpus/67_with_as_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_as_func.py rename to crates/ty_project/resources/test/corpus/67_with_as_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_cond_return.py b/crates/ty_project/resources/test/corpus/67_with_cond_return.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_cond_return.py rename to crates/ty_project/resources/test/corpus/67_with_cond_return.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_inside_try_finally_multiple_terminal_elif.py b/crates/ty_project/resources/test/corpus/67_with_inside_try_finally_multiple_terminal_elif.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_inside_try_finally_multiple_terminal_elif.py rename to crates/ty_project/resources/test/corpus/67_with_inside_try_finally_multiple_terminal_elif.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_inside_try_finally_preceding_terminal_except.py b/crates/ty_project/resources/test/corpus/67_with_inside_try_finally_preceding_terminal_except.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_inside_try_finally_preceding_terminal_except.py rename to crates/ty_project/resources/test/corpus/67_with_inside_try_finally_preceding_terminal_except.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_multi_exit.py b/crates/ty_project/resources/test/corpus/67_with_multi_exit.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_multi_exit.py rename to crates/ty_project/resources/test/corpus/67_with_multi_exit.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_non_name_target.py b/crates/ty_project/resources/test/corpus/67_with_non_name_target.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_non_name_target.py rename to crates/ty_project/resources/test/corpus/67_with_non_name_target.py diff --git a/crates/red_knot_workspace/resources/test/corpus/67_with_return.py b/crates/ty_project/resources/test/corpus/67_with_return.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/67_with_return.py rename to crates/ty_project/resources/test/corpus/67_with_return.py diff --git a/crates/red_knot_workspace/resources/test/corpus/68_with2.py b/crates/ty_project/resources/test/corpus/68_with2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/68_with2.py rename to crates/ty_project/resources/test/corpus/68_with2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue1.py b/crates/ty_project/resources/test/corpus/69_for_try_except_continue1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue1.py rename to crates/ty_project/resources/test/corpus/69_for_try_except_continue1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue2.py b/crates/ty_project/resources/test/corpus/69_for_try_except_continue2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue2.py rename to crates/ty_project/resources/test/corpus/69_for_try_except_continue2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue3.py b/crates/ty_project/resources/test/corpus/69_for_try_except_continue3.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/69_for_try_except_continue3.py rename to crates/ty_project/resources/test/corpus/69_for_try_except_continue3.py diff --git a/crates/red_knot_workspace/resources/test/corpus/70_class.py b/crates/ty_project/resources/test/corpus/70_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/70_class.py rename to crates/ty_project/resources/test/corpus/70_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/70_class_base.py b/crates/ty_project/resources/test/corpus/70_class_base.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/70_class_base.py rename to crates/ty_project/resources/test/corpus/70_class_base.py diff --git a/crates/red_knot_workspace/resources/test/corpus/70_class_doc_str.py b/crates/ty_project/resources/test/corpus/70_class_doc_str.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/70_class_doc_str.py rename to crates/ty_project/resources/test/corpus/70_class_doc_str.py diff --git a/crates/red_knot_workspace/resources/test/corpus/71_class_meth.py b/crates/ty_project/resources/test/corpus/71_class_meth.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/71_class_meth.py rename to crates/ty_project/resources/test/corpus/71_class_meth.py diff --git a/crates/red_knot_workspace/resources/test/corpus/71_class_var.py b/crates/ty_project/resources/test/corpus/71_class_var.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/71_class_var.py rename to crates/ty_project/resources/test/corpus/71_class_var.py diff --git a/crates/red_knot_workspace/resources/test/corpus/72_class_mix.py b/crates/ty_project/resources/test/corpus/72_class_mix.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/72_class_mix.py rename to crates/ty_project/resources/test/corpus/72_class_mix.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic.py b/crates/ty_project/resources/test/corpus/73_class_generic.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic.py rename to crates/ty_project/resources/test/corpus/73_class_generic.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_bounds.py b/crates/ty_project/resources/test/corpus/73_class_generic_bounds.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_bounds.py rename to crates/ty_project/resources/test/corpus/73_class_generic_bounds.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_constraints.py b/crates/ty_project/resources/test/corpus/73_class_generic_constraints.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_constraints.py rename to crates/ty_project/resources/test/corpus/73_class_generic_constraints.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_defaults.py b/crates/ty_project/resources/test/corpus/73_class_generic_defaults.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_defaults.py rename to crates/ty_project/resources/test/corpus/73_class_generic_defaults.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_paramspec.py b/crates/ty_project/resources/test/corpus/73_class_generic_paramspec.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_paramspec.py rename to crates/ty_project/resources/test/corpus/73_class_generic_paramspec.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_paramspec_default.py b/crates/ty_project/resources/test/corpus/73_class_generic_paramspec_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_paramspec_default.py rename to crates/ty_project/resources/test/corpus/73_class_generic_paramspec_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_tuple.py b/crates/ty_project/resources/test/corpus/73_class_generic_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_tuple.py rename to crates/ty_project/resources/test/corpus/73_class_generic_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/73_class_generic_tuple_default.py b/crates/ty_project/resources/test/corpus/73_class_generic_tuple_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/73_class_generic_tuple_default.py rename to crates/ty_project/resources/test/corpus/73_class_generic_tuple_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/74_class_kwargs.py b/crates/ty_project/resources/test/corpus/74_class_kwargs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/74_class_kwargs.py rename to crates/ty_project/resources/test/corpus/74_class_kwargs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/74_class_kwargs_2.py b/crates/ty_project/resources/test/corpus/74_class_kwargs_2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/74_class_kwargs_2.py rename to crates/ty_project/resources/test/corpus/74_class_kwargs_2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/74_class_super.py b/crates/ty_project/resources/test/corpus/74_class_super.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/74_class_super.py rename to crates/ty_project/resources/test/corpus/74_class_super.py diff --git a/crates/red_knot_workspace/resources/test/corpus/74_class_super_nested.py b/crates/ty_project/resources/test/corpus/74_class_super_nested.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/74_class_super_nested.py rename to crates/ty_project/resources/test/corpus/74_class_super_nested.py diff --git a/crates/red_knot_workspace/resources/test/corpus/74_just_super.py b/crates/ty_project/resources/test/corpus/74_just_super.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/74_just_super.py rename to crates/ty_project/resources/test/corpus/74_just_super.py diff --git a/crates/red_knot_workspace/resources/test/corpus/75_classderef.py b/crates/ty_project/resources/test/corpus/75_classderef.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/75_classderef.py rename to crates/ty_project/resources/test/corpus/75_classderef.py diff --git a/crates/red_knot_workspace/resources/test/corpus/75_classderef_no.py b/crates/ty_project/resources/test/corpus/75_classderef_no.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/75_classderef_no.py rename to crates/ty_project/resources/test/corpus/75_classderef_no.py diff --git a/crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal1.py b/crates/ty_project/resources/test/corpus/76_class_nonlocal1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal1.py rename to crates/ty_project/resources/test/corpus/76_class_nonlocal1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal2.py b/crates/ty_project/resources/test/corpus/76_class_nonlocal2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal2.py rename to crates/ty_project/resources/test/corpus/76_class_nonlocal2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal3.py b/crates/ty_project/resources/test/corpus/76_class_nonlocal3.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal3.py rename to crates/ty_project/resources/test/corpus/76_class_nonlocal3.py diff --git a/crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal4.py b/crates/ty_project/resources/test/corpus/76_class_nonlocal4.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal4.py rename to crates/ty_project/resources/test/corpus/76_class_nonlocal4.py diff --git a/crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal5.py b/crates/ty_project/resources/test/corpus/76_class_nonlocal5.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/76_class_nonlocal5.py rename to crates/ty_project/resources/test/corpus/76_class_nonlocal5.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__.py b/crates/ty_project/resources/test/corpus/77_class__class__.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__.py rename to crates/ty_project/resources/test/corpus/77_class__class__.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__nested.py b/crates/ty_project/resources/test/corpus/77_class__class__nested.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__nested.py rename to crates/ty_project/resources/test/corpus/77_class__class__nested.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__no_class.py b/crates/ty_project/resources/test/corpus/77_class__class__no_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__no_class.py rename to crates/ty_project/resources/test/corpus/77_class__class__no_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__nonlocals.py b/crates/ty_project/resources/test/corpus/77_class__class__nonlocals.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__nonlocals.py rename to crates/ty_project/resources/test/corpus/77_class__class__nonlocals.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__nonlocals_2.py b/crates/ty_project/resources/test/corpus/77_class__class__nonlocals_2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__nonlocals_2.py rename to crates/ty_project/resources/test/corpus/77_class__class__nonlocals_2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__param.py b/crates/ty_project/resources/test/corpus/77_class__class__param.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__param.py rename to crates/ty_project/resources/test/corpus/77_class__class__param.py diff --git a/crates/red_knot_workspace/resources/test/corpus/77_class__class__param_lambda.py b/crates/ty_project/resources/test/corpus/77_class__class__param_lambda.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/77_class__class__param_lambda.py rename to crates/ty_project/resources/test/corpus/77_class__class__param_lambda.py diff --git a/crates/red_knot_workspace/resources/test/corpus/78_class_body_cond.py b/crates/ty_project/resources/test/corpus/78_class_body_cond.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/78_class_body_cond.py rename to crates/ty_project/resources/test/corpus/78_class_body_cond.py diff --git a/crates/red_knot_workspace/resources/test/corpus/78_class_dec.py b/crates/ty_project/resources/test/corpus/78_class_dec.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/78_class_dec.py rename to crates/ty_project/resources/test/corpus/78_class_dec.py diff --git a/crates/red_knot_workspace/resources/test/corpus/78_class_dec_member.py b/crates/ty_project/resources/test/corpus/78_class_dec_member.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/78_class_dec_member.py rename to crates/ty_project/resources/test/corpus/78_class_dec_member.py diff --git a/crates/red_knot_workspace/resources/test/corpus/78_class_dec_member_func.py b/crates/ty_project/resources/test/corpus/78_class_dec_member_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/78_class_dec_member_func.py rename to crates/ty_project/resources/test/corpus/78_class_dec_member_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/79_metaclass.py b/crates/ty_project/resources/test/corpus/79_metaclass.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/79_metaclass.py rename to crates/ty_project/resources/test/corpus/79_metaclass.py diff --git a/crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs1.py b/crates/ty_project/resources/test/corpus/80_func_kwonlyargs1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs1.py rename to crates/ty_project/resources/test/corpus/80_func_kwonlyargs1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs2.py b/crates/ty_project/resources/test/corpus/80_func_kwonlyargs2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs2.py rename to crates/ty_project/resources/test/corpus/80_func_kwonlyargs2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs3.py b/crates/ty_project/resources/test/corpus/80_func_kwonlyargs3.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/80_func_kwonlyargs3.py rename to crates/ty_project/resources/test/corpus/80_func_kwonlyargs3.py diff --git a/crates/red_knot_workspace/resources/test/corpus/81_func_kwonlyargs_defaults.py b/crates/ty_project/resources/test/corpus/81_func_kwonlyargs_defaults.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/81_func_kwonlyargs_defaults.py rename to crates/ty_project/resources/test/corpus/81_func_kwonlyargs_defaults.py diff --git a/crates/ty_project/resources/test/corpus/83_jupyter_notebook_ipython_magic.ipynb b/crates/ty_project/resources/test/corpus/83_jupyter_notebook_ipython_magic.ipynb new file mode 120000 index 0000000000000..82df885aaa183 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/83_jupyter_notebook_ipython_magic.ipynb @@ -0,0 +1 @@ +../../../../ruff_notebook/resources/test/fixtures/jupyter/unused_variable.ipynb \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match.py b/crates/ty_project/resources/test/corpus/85_match.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match.py rename to crates/ty_project/resources/test/corpus/85_match.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_as.py b/crates/ty_project/resources/test/corpus/85_match_as.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_as.py rename to crates/ty_project/resources/test/corpus/85_match_as.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_attr.py b/crates/ty_project/resources/test/corpus/85_match_attr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_attr.py rename to crates/ty_project/resources/test/corpus/85_match_attr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_class.py b/crates/ty_project/resources/test/corpus/85_match_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_class.py rename to crates/ty_project/resources/test/corpus/85_match_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_default.py b/crates/ty_project/resources/test/corpus/85_match_default.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_default.py rename to crates/ty_project/resources/test/corpus/85_match_default.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_guard.py b/crates/ty_project/resources/test/corpus/85_match_guard.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_guard.py rename to crates/ty_project/resources/test/corpus/85_match_guard.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_guard_with_named_expr.py b/crates/ty_project/resources/test/corpus/85_match_guard_with_named_expr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_guard_with_named_expr.py rename to crates/ty_project/resources/test/corpus/85_match_guard_with_named_expr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_in_func.py b/crates/ty_project/resources/test/corpus/85_match_in_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_in_func.py rename to crates/ty_project/resources/test/corpus/85_match_in_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_in_func_with_rest.py b/crates/ty_project/resources/test/corpus/85_match_in_func_with_rest.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_in_func_with_rest.py rename to crates/ty_project/resources/test/corpus/85_match_in_func_with_rest.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_in_func_with_star.py b/crates/ty_project/resources/test/corpus/85_match_in_func_with_star.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_in_func_with_star.py rename to crates/ty_project/resources/test/corpus/85_match_in_func_with_star.py diff --git a/crates/ty_project/resources/test/corpus/85_match_invalid.py b/crates/ty_project/resources/test/corpus/85_match_invalid.py new file mode 100644 index 0000000000000..d4cc9c9825a4b --- /dev/null +++ b/crates/ty_project/resources/test/corpus/85_match_invalid.py @@ -0,0 +1,3 @@ +match some_int: + case x:=2: + pass diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_mapping.py b/crates/ty_project/resources/test/corpus/85_match_mapping.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_mapping.py rename to crates/ty_project/resources/test/corpus/85_match_mapping.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_mapping_subpattern.py b/crates/ty_project/resources/test/corpus/85_match_mapping_subpattern.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_mapping_subpattern.py rename to crates/ty_project/resources/test/corpus/85_match_mapping_subpattern.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_or.py b/crates/ty_project/resources/test/corpus/85_match_or.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_or.py rename to crates/ty_project/resources/test/corpus/85_match_or.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_sequence.py b/crates/ty_project/resources/test/corpus/85_match_sequence.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_sequence.py rename to crates/ty_project/resources/test/corpus/85_match_sequence.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_sequence_wildcard.py b/crates/ty_project/resources/test/corpus/85_match_sequence_wildcard.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_sequence_wildcard.py rename to crates/ty_project/resources/test/corpus/85_match_sequence_wildcard.py diff --git a/crates/red_knot_workspace/resources/test/corpus/85_match_singleton.py b/crates/ty_project/resources/test/corpus/85_match_singleton.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/85_match_singleton.py rename to crates/ty_project/resources/test/corpus/85_match_singleton.py diff --git a/crates/ty_project/resources/test/corpus/88_regression_generic_method_with_nested_function.py b/crates/ty_project/resources/test/corpus/88_regression_generic_method_with_nested_function.py new file mode 100644 index 0000000000000..055f2c1721f49 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/88_regression_generic_method_with_nested_function.py @@ -0,0 +1,9 @@ +# Regression test for an issue that came up while working +# on https://github.com/astral-sh/ruff/pull/17769 + +class C: + def method[T](self, x: T) -> T: + def inner(): + self.attr = 1 + +C().attr diff --git a/crates/ty_project/resources/test/corpus/88_regression_issue_17792.py b/crates/ty_project/resources/test/corpus/88_regression_issue_17792.py new file mode 100644 index 0000000000000..c9977a8397bb2 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/88_regression_issue_17792.py @@ -0,0 +1,15 @@ +# Regression test for https://github.com/astral-sh/ruff/issues/17792 + +from __future__ import annotations + + +class C: ... + + +def f(arg: C): + pass + + +x, _ = f(1) + +assert x diff --git a/crates/ty_project/resources/test/corpus/88_regression_tuple_type_short_circuit.py b/crates/ty_project/resources/test/corpus/88_regression_tuple_type_short_circuit.py new file mode 100644 index 0000000000000..9c69e71cc3672 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/88_regression_tuple_type_short_circuit.py @@ -0,0 +1,17 @@ +""" +Regression test that makes sure we do not short-circuit here after +determining that the overall type will be `Never` and still infer +a type for the second tuple element `2`. + +Relevant discussion: +https://github.com/astral-sh/ruff/pull/15218#discussion_r1900811073 +""" + +from typing_extensions import Never + + +def never() -> Never: + return never() + + +(never(), 2) diff --git a/crates/ty_project/resources/test/corpus/89_type_alias.py b/crates/ty_project/resources/test/corpus/89_type_alias.py new file mode 100644 index 0000000000000..3acd9fb91e0d7 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/89_type_alias.py @@ -0,0 +1,2 @@ +type foo = int +type ListOrSet[T] = list[T] | set[T] diff --git a/crates/ty_project/resources/test/corpus/89_type_alias_invalid_bound.py b/crates/ty_project/resources/test/corpus/89_type_alias_invalid_bound.py new file mode 120000 index 0000000000000..5dfcadebb0d17 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/89_type_alias_invalid_bound.py @@ -0,0 +1 @@ +../../../../ruff_python_parser/resources/inline/err/type_param_invalid_bound_expr.py \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/90_docstring_class.py b/crates/ty_project/resources/test/corpus/90_docstring_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/90_docstring_class.py rename to crates/ty_project/resources/test/corpus/90_docstring_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/90_docstring_func.py b/crates/ty_project/resources/test/corpus/90_docstring_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/90_docstring_func.py rename to crates/ty_project/resources/test/corpus/90_docstring_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/90_docstring_mod.py b/crates/ty_project/resources/test/corpus/90_docstring_mod.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/90_docstring_mod.py rename to crates/ty_project/resources/test/corpus/90_docstring_mod.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers1.py b/crates/ty_project/resources/test/corpus/91_line_numbers1.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers1.py rename to crates/ty_project/resources/test/corpus/91_line_numbers1.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers2.py b/crates/ty_project/resources/test/corpus/91_line_numbers2.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers2.py rename to crates/ty_project/resources/test/corpus/91_line_numbers2.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers2_comp.py b/crates/ty_project/resources/test/corpus/91_line_numbers2_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers2_comp.py rename to crates/ty_project/resources/test/corpus/91_line_numbers2_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers3.py b/crates/ty_project/resources/test/corpus/91_line_numbers3.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers3.py rename to crates/ty_project/resources/test/corpus/91_line_numbers3.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers4.py b/crates/ty_project/resources/test/corpus/91_line_numbers4.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers4.py rename to crates/ty_project/resources/test/corpus/91_line_numbers4.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers_dict.py b/crates/ty_project/resources/test/corpus/91_line_numbers_dict.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers_dict.py rename to crates/ty_project/resources/test/corpus/91_line_numbers_dict.py diff --git a/crates/red_knot_workspace/resources/test/corpus/91_line_numbers_dict_comp.py b/crates/ty_project/resources/test/corpus/91_line_numbers_dict_comp.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/91_line_numbers_dict_comp.py rename to crates/ty_project/resources/test/corpus/91_line_numbers_dict_comp.py diff --git a/crates/red_knot_workspace/resources/test/corpus/92_qual_class_in_class.py b/crates/ty_project/resources/test/corpus/92_qual_class_in_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/92_qual_class_in_class.py rename to crates/ty_project/resources/test/corpus/92_qual_class_in_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/92_qual_class_in_func.py b/crates/ty_project/resources/test/corpus/92_qual_class_in_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/92_qual_class_in_func.py rename to crates/ty_project/resources/test/corpus/92_qual_class_in_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/93_deadcode.py b/crates/ty_project/resources/test/corpus/93_deadcode.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/93_deadcode.py rename to crates/ty_project/resources/test/corpus/93_deadcode.py diff --git a/crates/red_knot_workspace/resources/test/corpus/94_strformat.py b/crates/ty_project/resources/test/corpus/94_strformat.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/94_strformat.py rename to crates/ty_project/resources/test/corpus/94_strformat.py diff --git a/crates/red_knot_workspace/resources/test/corpus/94_strformat_complex.py b/crates/ty_project/resources/test/corpus/94_strformat_complex.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/94_strformat_complex.py rename to crates/ty_project/resources/test/corpus/94_strformat_complex.py diff --git a/crates/red_knot_workspace/resources/test/corpus/94_strformat_conv.py b/crates/ty_project/resources/test/corpus/94_strformat_conv.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/94_strformat_conv.py rename to crates/ty_project/resources/test/corpus/94_strformat_conv.py diff --git a/crates/ty_project/resources/test/corpus/94_strformat_conversion.py b/crates/ty_project/resources/test/corpus/94_strformat_conversion.py new file mode 100644 index 0000000000000..adf563cf77c73 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/94_strformat_conversion.py @@ -0,0 +1,3 @@ +msg = "hello" + +f"{msg!r:>{10+10}}" diff --git a/crates/red_knot_workspace/resources/test/corpus/94_strformat_spec.py b/crates/ty_project/resources/test/corpus/94_strformat_spec.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/94_strformat_spec.py rename to crates/ty_project/resources/test/corpus/94_strformat_spec.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_assign_subscript_no_rhs.py b/crates/ty_project/resources/test/corpus/95_annotation_assign_subscript_no_rhs.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_assign_subscript_no_rhs.py rename to crates/ty_project/resources/test/corpus/95_annotation_assign_subscript_no_rhs.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_assign_tuple.py b/crates/ty_project/resources/test/corpus/95_annotation_assign_tuple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_assign_tuple.py rename to crates/ty_project/resources/test/corpus/95_annotation_assign_tuple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_class.py b/crates/ty_project/resources/test/corpus/95_annotation_class.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_class.py rename to crates/ty_project/resources/test/corpus/95_annotation_class.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_class_multiline.py b/crates/ty_project/resources/test/corpus/95_annotation_class_multiline.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_class_multiline.py rename to crates/ty_project/resources/test/corpus/95_annotation_class_multiline.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_class_no_value.py b/crates/ty_project/resources/test/corpus/95_annotation_class_no_value.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_class_no_value.py rename to crates/ty_project/resources/test/corpus/95_annotation_class_no_value.py diff --git a/crates/ty_project/resources/test/corpus/95_annotation_fstring_invalid.py b/crates/ty_project/resources/test/corpus/95_annotation_fstring_invalid.py new file mode 100644 index 0000000000000..119b52201cd7c --- /dev/null +++ b/crates/ty_project/resources/test/corpus/95_annotation_fstring_invalid.py @@ -0,0 +1 @@ +x: f"Literal[{1 + 2}]" = 3 diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_func.py b/crates/ty_project/resources/test/corpus/95_annotation_func.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_func.py rename to crates/ty_project/resources/test/corpus/95_annotation_func.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_func_future.py b/crates/ty_project/resources/test/corpus/95_annotation_func_future.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_func_future.py rename to crates/ty_project/resources/test/corpus/95_annotation_func_future.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_global.py b/crates/ty_project/resources/test/corpus/95_annotation_global.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_global.py rename to crates/ty_project/resources/test/corpus/95_annotation_global.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_global_simple.py b/crates/ty_project/resources/test/corpus/95_annotation_global_simple.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_global_simple.py rename to crates/ty_project/resources/test/corpus/95_annotation_global_simple.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_local_attr.py b/crates/ty_project/resources/test/corpus/95_annotation_local_attr.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_local_attr.py rename to crates/ty_project/resources/test/corpus/95_annotation_local_attr.py diff --git a/crates/red_knot_workspace/resources/test/corpus/95_annotation_module.py b/crates/ty_project/resources/test/corpus/95_annotation_module.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/95_annotation_module.py rename to crates/ty_project/resources/test/corpus/95_annotation_module.py diff --git a/crates/ty_project/resources/test/corpus/95_annotation_string_tuple.py b/crates/ty_project/resources/test/corpus/95_annotation_string_tuple.py new file mode 100644 index 0000000000000..84681b729e3b1 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/95_annotation_string_tuple.py @@ -0,0 +1 @@ +t: "tuple[list[int]]" diff --git a/crates/ty_project/resources/test/corpus/95_annotation_union.py b/crates/ty_project/resources/test/corpus/95_annotation_union.py new file mode 100644 index 0000000000000..79be74b631193 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/95_annotation_union.py @@ -0,0 +1,3 @@ +from typing import Union + +x: Union[int, str] = 1 diff --git a/crates/red_knot_workspace/resources/test/corpus/96_debug.py b/crates/ty_project/resources/test/corpus/96_debug.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/96_debug.py rename to crates/ty_project/resources/test/corpus/96_debug.py diff --git a/crates/red_knot_workspace/resources/test/corpus/97_global_nonlocal_store.py b/crates/ty_project/resources/test/corpus/97_global_nonlocal_store.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/97_global_nonlocal_store.py rename to crates/ty_project/resources/test/corpus/97_global_nonlocal_store.py diff --git a/crates/red_knot_workspace/resources/test/corpus/98_ann_assign_annotation_future_annotations.py b/crates/ty_project/resources/test/corpus/98_ann_assign_annotation_future_annotations.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/98_ann_assign_annotation_future_annotations.py rename to crates/ty_project/resources/test/corpus/98_ann_assign_annotation_future_annotations.py diff --git a/crates/red_knot_workspace/resources/test/corpus/98_ann_assign_annotation_wrong_future.py b/crates/ty_project/resources/test/corpus/98_ann_assign_annotation_wrong_future.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/98_ann_assign_annotation_wrong_future.py rename to crates/ty_project/resources/test/corpus/98_ann_assign_annotation_wrong_future.py diff --git a/crates/ty_project/resources/test/corpus/98_ann_assign_invalid_target.py b/crates/ty_project/resources/test/corpus/98_ann_assign_invalid_target.py new file mode 120000 index 0000000000000..ebc265cfa2500 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/98_ann_assign_invalid_target.py @@ -0,0 +1 @@ +../../../../ruff_python_parser/resources/inline/err/ann_assign_stmt_invalid_target.py \ No newline at end of file diff --git a/crates/red_knot_workspace/resources/test/corpus/98_ann_assign_simple_annotation.py b/crates/ty_project/resources/test/corpus/98_ann_assign_simple_annotation.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/98_ann_assign_simple_annotation.py rename to crates/ty_project/resources/test/corpus/98_ann_assign_simple_annotation.py diff --git a/crates/red_knot_workspace/resources/test/corpus/99_empty_jump_target_insts.py b/crates/ty_project/resources/test/corpus/99_empty_jump_target_insts.py similarity index 100% rename from crates/red_knot_workspace/resources/test/corpus/99_empty_jump_target_insts.py rename to crates/ty_project/resources/test/corpus/99_empty_jump_target_insts.py diff --git a/crates/ty_project/resources/test/corpus/cycle_narrowing_constraints.py b/crates/ty_project/resources/test/corpus/cycle_narrowing_constraints.py new file mode 100644 index 0000000000000..4c92601b558ab --- /dev/null +++ b/crates/ty_project/resources/test/corpus/cycle_narrowing_constraints.py @@ -0,0 +1,15 @@ +# Regression test for https://github.com/astral-sh/ruff/issues/17215 +# panicked in commit 1a6a10b30 +# error message: +# dependency graph cycle querying all_narrowing_constraints_for_expression(Id(8591)) + +def f(a: A, b: B, c: C): + unknown_a: UA = make_unknown() + unknown_b: UB = make_unknown() + unknown_c: UC = make_unknown() + unknown_d: UD = make_unknown() + + if unknown_a and unknown_b: + if unknown_c: + if unknown_d: + return a, b, c diff --git a/crates/ty_project/resources/test/corpus/cycle_negative_narrowing_constraints.py b/crates/ty_project/resources/test/corpus/cycle_negative_narrowing_constraints.py new file mode 100644 index 0000000000000..bb7890785fe03 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/cycle_negative_narrowing_constraints.py @@ -0,0 +1,22 @@ +# Regression test for https://github.com/astral-sh/ruff/issues/17215 +# panicked in commit 1a6a10b30 +# error message: +# dependency graph cycle querying all_negative_narrowing_constraints_for_expression(Id(859f)) + +def f(f1: bool, f2: bool, f3: bool, f4: bool): + o1: UnknownClass = make_o() + o2: UnknownClass = make_o() + o3: UnknownClass = make_o() + o4: UnknownClass = make_o() + + if f1 and f2 and f3 and f4: + if o1 == o2: + return None + if o2 == o3: + return None + if o3 == o4: + return None + if o4 == o1: + return None + + return o1, o2, o3, o4 diff --git a/crates/ty_project/resources/test/corpus/except_handler_with_Any_bound_typevar.py b/crates/ty_project/resources/test/corpus/except_handler_with_Any_bound_typevar.py new file mode 100644 index 0000000000000..a951d5034fc31 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/except_handler_with_Any_bound_typevar.py @@ -0,0 +1,14 @@ +def name_1[name_0: name_0](name_2: name_0): + try: + pass + except name_2: + pass + +from typing import Any + +def name_2[T: Any](x: T): + try: + pass + except x: + pass + diff --git a/crates/ty_project/resources/test/corpus/self_referential_function_annotation.py b/crates/ty_project/resources/test/corpus/self_referential_function_annotation.py new file mode 100644 index 0000000000000..5bbb1beb11557 --- /dev/null +++ b/crates/ty_project/resources/test/corpus/self_referential_function_annotation.py @@ -0,0 +1,4 @@ +from __future__ import annotations + +def foo(a: foo()): + pass diff --git a/crates/ty_project/src/combine.rs b/crates/ty_project/src/combine.rs new file mode 100644 index 0000000000000..69d6eae9db73e --- /dev/null +++ b/crates/ty_project/src/combine.rs @@ -0,0 +1,191 @@ +use std::{collections::HashMap, hash::BuildHasher}; + +use ruff_db::system::SystemPathBuf; +use ruff_python_ast::PythonVersion; +use ty_python_semantic::{PythonPath, PythonPlatform}; + +/// Combine two values, preferring the values in `self`. +/// +/// The logic should follow that of Cargo's `config.toml`: +/// +/// > If a key is specified in multiple config files, the values will get merged together. +/// > Numbers, strings, and booleans will use the value in the deeper config directory taking +/// > precedence over ancestor directories, where the home directory is the lowest priority. +/// > Arrays will be joined together with higher precedence items being placed later in the +/// > merged array. +/// +/// ## uv Compatibility +/// +/// The merging behavior differs from uv in that values with higher precedence in arrays +/// are placed later in the merged array. This is because we want to support overriding +/// earlier values and values from other configurations, including unsetting them. +/// For example: patterns coming last in file inclusion and exclusion patterns +/// allow overriding earlier patterns, matching the `gitignore` behavior. +/// Generally speaking, it feels more intuitive if later values override earlier values +/// than the other way around: `ty --exclude png --exclude "!important.png"`. +/// +/// The main downside of this approach is that the ordering can be surprising in cases +/// where the option has a "first match" semantic and not a "last match" wins. +/// One such example is `extra-paths` where the semantics is given by Python: +/// the module on the first matching search path wins. +/// +/// ```toml +/// [environment] +/// extra-paths = ["b", "c"] +/// ``` +/// +/// ```bash +/// ty --extra-paths a +/// ``` +/// +/// That's why a user might expect that this configuration results in `["a", "b", "c"]`, +/// because the CLI has higher precedence. However, the current implementation results in a +/// resolved extra search path of `["b", "c", "a"]`, which means `a` will be tried last. +/// +/// There's an argument here that the user should be able to specify the order of the paths, +/// because only then is the user in full control of where to insert the path when specifying `extra-paths` +/// in multiple sources. +/// +/// ## Macro +/// You can automatically derive `Combine` for structs with named fields by using `derive(ruff_macros::Combine)`. +pub trait Combine { + #[must_use] + fn combine(mut self, other: Self) -> Self + where + Self: Sized, + { + self.combine_with(other); + self + } + + fn combine_with(&mut self, other: Self); +} + +impl<T> Combine for Option<T> +where + T: Combine, +{ + fn combine(self, other: Self) -> Self + where + Self: Sized, + { + match (self, other) { + (Some(a), Some(b)) => Some(a.combine(b)), + (None, Some(b)) => Some(b), + (a, _) => a, + } + } + + fn combine_with(&mut self, other: Self) { + match (self, other) { + (Some(a), Some(b)) => { + a.combine_with(b); + } + (a @ None, Some(b)) => { + *a = Some(b); + } + _ => {} + } + } +} + +impl<T> Combine for Vec<T> { + fn combine_with(&mut self, mut other: Self) { + // `self` takes precedence over `other` but values with higher precedence must be placed after. + // Swap the vectors so that `other` is the one that gets extended, so that the values of `self` come after. + std::mem::swap(self, &mut other); + self.extend(other); + } +} + +impl<K, V, S> Combine for HashMap<K, V, S> +where + K: Eq + std::hash::Hash, + S: BuildHasher, +{ + fn combine_with(&mut self, mut other: Self) { + // `self` takes precedence over `other` but `extend` overrides existing values. + // Swap the hash maps so that `self` is the one that gets extended. + std::mem::swap(self, &mut other); + self.extend(other); + } +} + +/// Implements [`Combine`] for a value that always returns `self` when combined with another value. +macro_rules! impl_noop_combine { + ($name:ident) => { + impl Combine for $name { + #[inline(always)] + fn combine_with(&mut self, _other: Self) {} + + #[inline(always)] + fn combine(self, _other: Self) -> Self { + self + } + } + }; +} + +impl_noop_combine!(SystemPathBuf); +impl_noop_combine!(PythonPlatform); +impl_noop_combine!(PythonPath); +impl_noop_combine!(PythonVersion); + +// std types +impl_noop_combine!(bool); +impl_noop_combine!(usize); +impl_noop_combine!(u8); +impl_noop_combine!(u16); +impl_noop_combine!(u32); +impl_noop_combine!(u64); +impl_noop_combine!(u128); +impl_noop_combine!(isize); +impl_noop_combine!(i8); +impl_noop_combine!(i16); +impl_noop_combine!(i32); +impl_noop_combine!(i64); +impl_noop_combine!(i128); +impl_noop_combine!(String); + +#[cfg(test)] +mod tests { + use crate::combine::Combine; + use std::collections::HashMap; + + #[test] + fn combine_option() { + assert_eq!(Some(1).combine(Some(2)), Some(1)); + assert_eq!(None.combine(Some(2)), Some(2)); + assert_eq!(Some(1).combine(None), Some(1)); + } + + #[test] + fn combine_vec() { + assert_eq!(None.combine(Some(vec![1, 2, 3])), Some(vec![1, 2, 3])); + assert_eq!(Some(vec![1, 2, 3]).combine(None), Some(vec![1, 2, 3])); + assert_eq!( + Some(vec![1, 2, 3]).combine(Some(vec![4, 5, 6])), + Some(vec![4, 5, 6, 1, 2, 3]) + ); + } + + #[test] + fn combine_map() { + let a: HashMap<u32, _> = HashMap::from_iter([(1, "a"), (2, "a"), (3, "a")]); + let b: HashMap<u32, _> = HashMap::from_iter([(0, "b"), (2, "b"), (5, "b")]); + + assert_eq!(None.combine(Some(b.clone())), Some(b.clone())); + assert_eq!(Some(a.clone()).combine(None), Some(a.clone())); + assert_eq!( + Some(a).combine(Some(b)), + Some(HashMap::from_iter([ + (0, "b"), + // The value from `a` takes precedence + (1, "a"), + (2, "a"), + (3, "a"), + (5, "b") + ])) + ); + } +} diff --git a/crates/ty_project/src/db.rs b/crates/ty_project/src/db.rs new file mode 100644 index 0000000000000..ecbd3f65a8c67 --- /dev/null +++ b/crates/ty_project/src/db.rs @@ -0,0 +1,360 @@ +use std::panic::{AssertUnwindSafe, RefUnwindSafe}; +use std::sync::Arc; + +use crate::{DEFAULT_LINT_REGISTRY, DummyReporter}; +use crate::{Project, ProjectMetadata, Reporter}; +use ruff_db::diagnostic::Diagnostic; +use ruff_db::files::{File, Files}; +use ruff_db::system::System; +use ruff_db::vendored::VendoredFileSystem; +use ruff_db::{Db as SourceDb, Upcast}; +use salsa::plumbing::ZalsaDatabase; +use salsa::{Cancelled, Event}; +use ty_ide::Db as IdeDb; +use ty_python_semantic::lint::{LintRegistry, RuleSelection}; +use ty_python_semantic::{Db as SemanticDb, Program}; + +mod changes; + +#[salsa::db] +pub trait Db: SemanticDb + Upcast<dyn SemanticDb> { + fn project(&self) -> Project; +} + +#[salsa::db] +#[derive(Clone)] +pub struct ProjectDatabase { + project: Option<Project>, + storage: salsa::Storage<ProjectDatabase>, + files: Files, + system: Arc<dyn System + Send + Sync + RefUnwindSafe>, +} + +impl ProjectDatabase { + pub fn new<S>(project_metadata: ProjectMetadata, system: S) -> anyhow::Result<Self> + where + S: System + 'static + Send + Sync + RefUnwindSafe, + { + let mut db = Self { + project: None, + storage: salsa::Storage::new(if tracing::enabled!(tracing::Level::TRACE) { + Some(Box::new({ + move |event: Event| { + if matches!(event.kind, salsa::EventKind::WillCheckCancellation) { + return; + } + + tracing::trace!("Salsa event: {event:?}"); + } + })) + } else { + None + }), + files: Files::default(), + system: Arc::new(system), + }; + + // TODO: Use the `program_settings` to compute the key for the database's persistent + // cache and load the cache if it exists. + // we may want to have a dedicated method for this? + + // Initialize the `Program` singleton + let program_settings = project_metadata.to_program_settings(db.system()); + Program::from_settings(&db, program_settings)?; + + db.project = Some(Project::from_metadata(&db, project_metadata)); + + Ok(db) + } + + /// Checks all open files in the project and its dependencies. + pub fn check(&self) -> Result<Vec<Diagnostic>, Cancelled> { + let mut reporter = DummyReporter; + let reporter = AssertUnwindSafe(&mut reporter as &mut dyn Reporter); + self.with_db(|db| db.project().check(db, reporter)) + } + + /// Checks all open files in the project and its dependencies, using the given reporter. + pub fn check_with_reporter( + &self, + reporter: &mut dyn Reporter, + ) -> Result<Vec<Diagnostic>, Cancelled> { + let reporter = AssertUnwindSafe(reporter); + self.with_db(|db| db.project().check(db, reporter)) + } + + #[tracing::instrument(level = "debug", skip(self))] + pub fn check_file(&self, file: File) -> Result<Vec<Diagnostic>, Cancelled> { + self.with_db(|db| self.project().check_file(db, file)) + } + + /// Returns a mutable reference to the system. + /// + /// WARNING: Triggers a new revision, canceling other database handles. This can lead to deadlock. + pub fn system_mut(&mut self) -> &mut dyn System { + // TODO: Use a more official method to cancel other queries. + // https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries + let _ = self.zalsa_mut(); + + Arc::get_mut(&mut self.system) + .expect("ref count should be 1 because `zalsa_mut` drops all other DB references.") + } + + pub(crate) fn with_db<F, T>(&self, f: F) -> Result<T, Cancelled> + where + F: FnOnce(&ProjectDatabase) -> T + std::panic::UnwindSafe, + { + Cancelled::catch(|| f(self)) + } +} + +impl Upcast<dyn SemanticDb> for ProjectDatabase { + fn upcast(&self) -> &(dyn SemanticDb + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut (dyn SemanticDb + 'static) { + self + } +} + +impl Upcast<dyn SourceDb> for ProjectDatabase { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } +} + +impl Upcast<dyn IdeDb> for ProjectDatabase { + fn upcast(&self) -> &(dyn IdeDb + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut (dyn IdeDb + 'static) { + self + } +} + +impl Upcast<dyn Db> for ProjectDatabase { + fn upcast(&self) -> &(dyn Db + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut (dyn Db + 'static) { + self + } +} + +#[salsa::db] +impl IdeDb for ProjectDatabase {} + +#[salsa::db] +impl SemanticDb for ProjectDatabase { + fn is_file_open(&self, file: File) -> bool { + let Some(project) = &self.project else { + return false; + }; + + project.is_file_open(self, file) + } + + fn rule_selection(&self) -> &RuleSelection { + self.project().rules(self) + } + + fn lint_registry(&self) -> &LintRegistry { + &DEFAULT_LINT_REGISTRY + } +} + +#[salsa::db] +impl SourceDb for ProjectDatabase { + fn vendored(&self) -> &VendoredFileSystem { + ty_vendored::file_system() + } + + fn system(&self) -> &dyn System { + &*self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> ruff_python_ast::PythonVersion { + Program::get(self).python_version(self) + } +} + +#[salsa::db] +impl salsa::Database for ProjectDatabase {} + +#[salsa::db] +impl Db for ProjectDatabase { + fn project(&self) -> Project { + self.project.unwrap() + } +} + +#[cfg(feature = "format")] +mod format { + use crate::ProjectDatabase; + use ruff_db::Upcast; + use ruff_db::files::File; + use ruff_python_formatter::{Db as FormatDb, PyFormatOptions}; + + #[salsa::db] + impl FormatDb for ProjectDatabase { + fn format_options(&self, file: File) -> PyFormatOptions { + let source_ty = file.source_type(self); + PyFormatOptions::from_source_type(source_ty) + } + } + + impl Upcast<dyn FormatDb> for ProjectDatabase { + fn upcast(&self) -> &(dyn FormatDb + 'static) { + self + } + + fn upcast_mut(&mut self) -> &mut (dyn FormatDb + 'static) { + self + } + } +} + +#[cfg(test)] +pub(crate) mod tests { + use std::sync::{Arc, Mutex}; + + use ruff_db::files::Files; + use ruff_db::system::{DbWithTestSystem, System, TestSystem}; + use ruff_db::vendored::VendoredFileSystem; + use ruff_db::{Db as SourceDb, Upcast}; + use ty_python_semantic::lint::{LintRegistry, RuleSelection}; + use ty_python_semantic::{Db as SemanticDb, Program}; + + use crate::DEFAULT_LINT_REGISTRY; + use crate::db::Db; + use crate::{Project, ProjectMetadata}; + + type Events = Arc<Mutex<Vec<salsa::Event>>>; + + #[salsa::db] + #[derive(Clone)] + pub(crate) struct TestDb { + storage: salsa::Storage<Self>, + events: Events, + files: Files, + system: TestSystem, + vendored: VendoredFileSystem, + project: Option<Project>, + } + + impl TestDb { + pub(crate) fn new(project: ProjectMetadata) -> Self { + let events = Events::default(); + let mut db = Self { + storage: salsa::Storage::new(Some(Box::new({ + let events = events.clone(); + move |event| { + let mut events = events.lock().unwrap(); + events.push(event); + } + }))), + system: TestSystem::default(), + vendored: ty_vendored::file_system().clone(), + files: Files::default(), + events, + project: None, + }; + + let project = Project::from_metadata(&db, project); + db.project = Some(project); + db + } + } + + impl TestDb { + /// Takes the salsa events. + pub(crate) fn take_salsa_events(&mut self) -> Vec<salsa::Event> { + let mut events = self.events.lock().unwrap(); + + std::mem::take(&mut *events) + } + } + + impl DbWithTestSystem for TestDb { + fn test_system(&self) -> &TestSystem { + &self.system + } + + fn test_system_mut(&mut self) -> &mut TestSystem { + &mut self.system + } + } + + #[salsa::db] + impl SourceDb for TestDb { + fn vendored(&self) -> &VendoredFileSystem { + &self.vendored + } + + fn system(&self) -> &dyn System { + &self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> ruff_python_ast::PythonVersion { + Program::get(self).python_version(self) + } + } + + impl Upcast<dyn SemanticDb> for TestDb { + fn upcast(&self) -> &(dyn SemanticDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SemanticDb + 'static) { + self + } + } + + impl Upcast<dyn SourceDb> for TestDb { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } + } + + #[salsa::db] + impl ty_python_semantic::Db for TestDb { + fn is_file_open(&self, file: ruff_db::files::File) -> bool { + !file.path(self).is_vendored_path() + } + + fn rule_selection(&self) -> &RuleSelection { + self.project().rules(self) + } + + fn lint_registry(&self) -> &LintRegistry { + &DEFAULT_LINT_REGISTRY + } + } + + #[salsa::db] + impl Db for TestDb { + fn project(&self) -> Project { + self.project.unwrap() + } + } + + #[salsa::db] + impl salsa::Database for TestDb {} +} diff --git a/crates/ty_project/src/db/changes.rs b/crates/ty_project/src/db/changes.rs new file mode 100644 index 0000000000000..cf36a1946a687 --- /dev/null +++ b/crates/ty_project/src/db/changes.rs @@ -0,0 +1,242 @@ +use crate::db::{Db, ProjectDatabase}; +use crate::metadata::options::Options; +use crate::watch::{ChangeEvent, CreatedKind, DeletedKind}; +use crate::{Project, ProjectMetadata}; +use std::collections::BTreeSet; + +use crate::walk::ProjectFilesWalker; +use ruff_db::Db as _; +use ruff_db::files::{File, Files}; +use ruff_db::system::SystemPath; +use rustc_hash::FxHashSet; +use ty_python_semantic::Program; + +impl ProjectDatabase { + #[tracing::instrument(level = "debug", skip(self, changes, cli_options))] + pub fn apply_changes(&mut self, changes: Vec<ChangeEvent>, cli_options: Option<&Options>) { + let mut project = self.project(); + let project_root = project.root(self).to_path_buf(); + let program = Program::get(self); + let custom_stdlib_versions_path = program + .custom_stdlib_search_path(self) + .map(|path| path.join("VERSIONS")); + + // Are there structural changes to the project + let mut project_changed = false; + // Changes to a custom stdlib path's VERSIONS + let mut custom_stdlib_change = false; + // Paths that were added + let mut added_paths = FxHashSet::default(); + + // Deduplicate the `sync` calls. Many file watchers emit multiple events for the same path. + let mut synced_files = FxHashSet::default(); + let mut sync_recursively = BTreeSet::default(); + + let mut sync_path = |db: &mut ProjectDatabase, path: &SystemPath| { + if synced_files.insert(path.to_path_buf()) { + File::sync_path(db, path); + } + }; + + for change in changes { + tracing::trace!("Handle change: {:?}", change); + + if let Some(path) = change.system_path() { + if matches!( + path.file_name(), + Some(".gitignore" | ".ignore" | "ty.toml" | "pyproject.toml") + ) { + // Changes to ignore files or settings can change the project structure or add/remove files. + project_changed = true; + + continue; + } + + if Some(path) == custom_stdlib_versions_path.as_deref() { + custom_stdlib_change = true; + } + } + + match change { + ChangeEvent::Changed { path, kind: _ } | ChangeEvent::Opened(path) => { + sync_path(self, &path); + } + + ChangeEvent::Created { kind, path } => { + match kind { + CreatedKind::File => sync_path(self, &path), + CreatedKind::Directory | CreatedKind::Any => { + sync_recursively.insert(path.clone()); + } + } + + // Unlike other files, it's not only important to update the status of existing + // and known `File`s (`sync_recursively`), it's also important to discover new files + // that were added in the project's root (or any of the paths included for checking). + // + // This is important because `Project::check` iterates over all included files. + // The code below walks the `added_paths` and adds all files that + // should be included in the project. We can skip this check for + // paths that aren't part of the project or shouldn't be included + // when checking the project. + if project.is_path_included(self, &path) { + if self.system().is_file(&path) { + // Add the parent directory because `walkdir` always visits explicitly passed files + // even if they match an exclude filter. + added_paths.insert(path.parent().unwrap().to_path_buf()); + } else { + added_paths.insert(path); + } + } + } + + ChangeEvent::Deleted { kind, path } => { + let is_file = match kind { + DeletedKind::File => true, + DeletedKind::Directory => { + // file watchers emit an event for every deleted file. No need to scan the entire dir. + continue; + } + DeletedKind::Any => self + .files + .try_system(self, &path) + .is_some_and(|file| file.exists(self)), + }; + + if is_file { + sync_path(self, &path); + + if let Some(file) = self.files().try_system(self, &path) { + project.remove_file(self, file); + } + } else { + sync_recursively.insert(path.clone()); + + if custom_stdlib_versions_path + .as_ref() + .is_some_and(|versions_path| versions_path.starts_with(&path)) + { + custom_stdlib_change = true; + } + + if project.is_path_included(self, &path) || path == project_root { + // TODO: Shouldn't it be enough to simply traverse the project files and remove all + // that start with the given path? + tracing::debug!( + "Reload project because of a path that could have been a directory." + ); + + // Perform a full-reload in case the deleted directory contained the pyproject.toml. + // We may want to make this more clever in the future, to e.g. iterate over the + // indexed files and remove the once that start with the same path, unless + // the deleted path is the project configuration. + project_changed = true; + } + } + } + + ChangeEvent::CreatedVirtual(path) | ChangeEvent::ChangedVirtual(path) => { + File::sync_virtual_path(self, &path); + } + + ChangeEvent::DeletedVirtual(path) => { + if let Some(virtual_file) = self.files().try_virtual_file(&path) { + virtual_file.close(self); + } + } + + ChangeEvent::Rescan => { + project_changed = true; + Files::sync_all(self); + sync_recursively.clear(); + break; + } + } + } + + let sync_recursively = sync_recursively.into_iter(); + let mut last = None; + + for path in sync_recursively { + // Avoid re-syncing paths that are sub-paths of each other. + if let Some(last) = &last { + if path.starts_with(last) { + continue; + } + } + + Files::sync_recursively(self, &path); + last = Some(path); + } + + if project_changed { + match ProjectMetadata::discover(&project_root, self.system()) { + Ok(mut metadata) => { + if let Some(cli_options) = cli_options { + metadata.apply_cli_options(cli_options.clone()); + } + + if let Err(error) = metadata.apply_configuration_files(self.system()) { + tracing::error!( + "Failed to apply configuration files, continuing without applying them: {error}" + ); + } + + let program_settings = metadata.to_program_settings(self.system()); + + let program = Program::get(self); + if let Err(error) = program.update_from_settings(self, program_settings) { + tracing::error!( + "Failed to update the program settings, keeping the old program settings: {error}" + ); + } + + if metadata.root() == project.root(self) { + tracing::debug!("Reloading project after structural change"); + project.reload(self, metadata); + } else { + tracing::debug!("Replace project after structural change"); + project = Project::from_metadata(self, metadata); + self.project = Some(project); + } + } + Err(error) => { + tracing::error!( + "Failed to load project, keeping old project configuration: {error}" + ); + } + } + + return; + } else if custom_stdlib_change { + let search_paths = project + .metadata(self) + .to_program_settings(self.system()) + .search_paths; + + if let Err(error) = program.update_search_paths(self, &search_paths) { + tracing::error!("Failed to set the new search paths: {error}"); + } + } + + let diagnostics = if let Some(walker) = ProjectFilesWalker::incremental(self, added_paths) { + // Use directory walking to discover newly added files. + let (files, diagnostics) = walker.collect_vec(self); + + for file in files { + project.add_file(self, file); + } + + diagnostics + } else { + Vec::new() + }; + + // Note: We simply replace all IO related diagnostics here. This isn't ideal, because + // it removes IO errors that may still be relevant. However, tracking IO errors correctly + // across revisions doesn't feel essential, considering that they're rare. However, we could + // implement a `BTreeMap` or similar and only prune the diagnostics from paths that we've + // re-scanned (or that were removed etc). + project.replace_index_diagnostics(self, diagnostics); + } +} diff --git a/crates/ty_project/src/files.rs b/crates/ty_project/src/files.rs new file mode 100644 index 0000000000000..3021aa6143805 --- /dev/null +++ b/crates/ty_project/src/files.rs @@ -0,0 +1,300 @@ +use std::marker::PhantomData; +use std::ops::Deref; +use std::sync::Arc; + +use rustc_hash::FxHashSet; +use salsa::Setter; + +use ruff_db::files::File; + +use crate::db::Db; +use crate::{IOErrorDiagnostic, Project}; + +/// The indexed files of a project. +/// +/// The indexing happens lazily, but the files are then cached for subsequent reads. +/// +/// ## Implementation +/// The implementation uses internal mutability to transition between the lazy and indexed state +/// without triggering a new salsa revision. This is safe because the initial indexing happens on first access, +/// so no query can be depending on the contents of the indexed files before that. All subsequent mutations to +/// the indexed files must go through `IndexedMut`, which uses the Salsa setter `package.set_file_set` to +/// ensure that Salsa always knows when the set of indexed files have changed. +#[derive(Debug)] +pub struct IndexedFiles { + state: std::sync::Mutex<State>, +} + +impl IndexedFiles { + pub fn lazy() -> Self { + Self { + state: std::sync::Mutex::new(State::Lazy), + } + } + + fn indexed(inner: Arc<IndexedInner>) -> Self { + Self { + state: std::sync::Mutex::new(State::Indexed(inner)), + } + } + + pub(super) fn get(&self) -> Index { + let state = self.state.lock().unwrap(); + + match &*state { + State::Lazy => Index::Lazy(LazyFiles { files: state }), + State::Indexed(inner) => Index::Indexed(Indexed { + inner: Arc::clone(inner), + _lifetime: PhantomData, + }), + } + } + + pub(super) fn is_lazy(&self) -> bool { + matches!(*self.state.lock().unwrap(), State::Lazy) + } + + /// Returns a mutable view on the index that allows cheap in-place mutations. + /// + /// The changes are automatically written back to the database once the view is dropped. + pub(super) fn indexed_mut(db: &mut dyn Db, project: Project) -> Option<IndexedMut> { + // Calling `zalsa_mut` cancels all pending salsa queries. This ensures that there are no pending + // reads to the file set. + // TODO: Use a non-internal API instead https://salsa.zulipchat.com/#narrow/stream/333573-salsa-3.2E0/topic/Expose.20an.20API.20to.20cancel.20other.20queries + let _ = db.as_dyn_database_mut().zalsa_mut(); + + // Replace the state with lazy. The `IndexedMut` guard restores the state + // to `State::Indexed` or sets a new `PackageFiles` when it gets dropped to ensure the state + // is restored to how it has been before replacing the value. + // + // It isn't necessary to hold on to the lock after this point: + // * The above call to `zalsa_mut` guarantees that there's exactly **one** DB reference. + // * `Indexed` has a `'db` lifetime, and this method requires a `&mut db`. + // This means that there can't be any pending reference to `Indexed` because Rust + // doesn't allow borrowing `db` as mutable (to call this method) and immutable (`Indexed<'db>`) at the same time. + // There can't be any other `Indexed<'db>` references created by clones of this DB because + // all clones must have been dropped at this point and the `Indexed` + // can't outlive the database (constrained by the `db` lifetime). + let state = { + let files = project.file_set(db); + let mut locked = files.state.lock().unwrap(); + std::mem::replace(&mut *locked, State::Lazy) + }; + + let indexed = match state { + // If it's already lazy, just return. We also don't need to restore anything because the + // replace above was a no-op. + State::Lazy => return None, + State::Indexed(indexed) => indexed, + }; + + Some(IndexedMut { + db: Some(db), + project, + indexed, + did_change: false, + }) + } +} + +impl Default for IndexedFiles { + fn default() -> Self { + Self::lazy() + } +} + +#[derive(Debug)] +enum State { + /// The files of a package haven't been indexed yet. + Lazy, + + /// The files are indexed. Stores the known files of a package. + Indexed(Arc<IndexedInner>), +} + +pub(super) enum Index<'db> { + /// The index has not yet been computed. Allows inserting the files. + Lazy(LazyFiles<'db>), + + Indexed(Indexed<'db>), +} + +/// Package files that have not been indexed yet. +pub(super) struct LazyFiles<'db> { + files: std::sync::MutexGuard<'db, State>, +} + +impl<'db> LazyFiles<'db> { + /// Sets the indexed files of a package to `files`. + pub(super) fn set( + mut self, + files: FxHashSet<File>, + diagnostics: Vec<IOErrorDiagnostic>, + ) -> Indexed<'db> { + let files = Indexed { + inner: Arc::new(IndexedInner { files, diagnostics }), + _lifetime: PhantomData, + }; + *self.files = State::Indexed(Arc::clone(&files.inner)); + files + } +} + +/// The indexed files of the project. +/// +/// Note: This type is intentionally non-cloneable. Making it cloneable requires +/// revisiting the locking behavior in [`IndexedFiles::indexed_mut`]. +#[derive(Debug)] +pub struct Indexed<'db> { + inner: Arc<IndexedInner>, + // Preserve the lifetime of `PackageFiles`. + _lifetime: PhantomData<&'db ()>, +} + +#[derive(Debug)] +struct IndexedInner { + files: FxHashSet<File>, + diagnostics: Vec<IOErrorDiagnostic>, +} + +impl Indexed<'_> { + pub(super) fn diagnostics(&self) -> &[IOErrorDiagnostic] { + &self.inner.diagnostics + } + + pub(super) fn len(&self) -> usize { + self.inner.files.len() + } +} + +impl Deref for Indexed<'_> { + type Target = FxHashSet<File>; + + fn deref(&self) -> &Self::Target { + &self.inner.files + } +} + +pub(super) type IndexedIter<'a> = std::iter::Copied<std::collections::hash_set::Iter<'a, File>>; + +impl<'a> IntoIterator for &'a Indexed<'_> { + type Item = File; + type IntoIter = IndexedIter<'a>; + + fn into_iter(self) -> Self::IntoIter { + self.inner.files.iter().copied() + } +} + +/// A Mutable view of a project's indexed files. +/// +/// Allows in-place mutation of the files without deep cloning the hash set. +/// The changes are written back when the mutable view is dropped or by calling [`Self::set`] manually. +pub(super) struct IndexedMut<'db> { + db: Option<&'db mut dyn Db>, + project: Project, + indexed: Arc<IndexedInner>, + did_change: bool, +} + +impl IndexedMut<'_> { + pub(super) fn insert(&mut self, file: File) -> bool { + if self.inner_mut().files.insert(file) { + self.did_change = true; + true + } else { + false + } + } + + pub(super) fn remove(&mut self, file: File) -> bool { + if self.inner_mut().files.remove(&file) { + self.did_change = true; + true + } else { + false + } + } + + pub(super) fn set_diagnostics(&mut self, diagnostics: Vec<IOErrorDiagnostic>) { + self.inner_mut().diagnostics = diagnostics; + } + + fn inner_mut(&mut self) -> &mut IndexedInner { + Arc::get_mut(&mut self.indexed) + .expect("All references to `FilesSet` should have been dropped") + } + + fn set_impl(&mut self) { + let Some(db) = self.db.take() else { + return; + }; + + let indexed = Arc::clone(&self.indexed); + + if self.did_change { + // If there are changes, set the new file_set to trigger a salsa revision change. + self.project + .set_file_set(db) + .to(IndexedFiles::indexed(indexed)); + } else { + // The `indexed_mut` replaced the `state` with Lazy. Restore it back to the indexed state. + *self.project.file_set(db).state.lock().unwrap() = State::Indexed(indexed); + } + } +} + +impl Drop for IndexedMut<'_> { + fn drop(&mut self) { + self.set_impl(); + } +} + +#[cfg(test)] +mod tests { + use rustc_hash::FxHashSet; + + use crate::ProjectMetadata; + use crate::db::Db; + use crate::db::tests::TestDb; + use crate::files::Index; + use ruff_db::files::system_path_to_file; + use ruff_db::system::{DbWithWritableSystem as _, SystemPathBuf}; + use ruff_python_ast::name::Name; + + #[test] + fn re_entrance() -> anyhow::Result<()> { + let metadata = ProjectMetadata::new(Name::new_static("test"), SystemPathBuf::from("/test")); + let mut db = TestDb::new(metadata); + + db.write_file("test.py", "")?; + + let project = db.project(); + + let file = system_path_to_file(&db, "test.py").unwrap(); + + let files = match project.file_set(&db).get() { + Index::Lazy(lazy) => lazy.set(FxHashSet::from_iter([file]), Vec::new()), + Index::Indexed(files) => files, + }; + + // Calling files a second time should not dead-lock. + // This can e.g. happen when `check_file` iterates over all files and + // `is_file_open` queries the open files. + let files_2 = project.file_set(&db).get(); + + match files_2 { + Index::Lazy(_) => { + panic!("Expected indexed files, got lazy files"); + } + Index::Indexed(files_2) => { + assert_eq!( + files_2.iter().collect::<Vec<_>>(), + files.iter().collect::<Vec<_>>() + ); + } + } + + Ok(()) + } +} diff --git a/crates/ty_project/src/lib.rs b/crates/ty_project/src/lib.rs new file mode 100644 index 0000000000000..bbe84382af79e --- /dev/null +++ b/crates/ty_project/src/lib.rs @@ -0,0 +1,722 @@ +#![allow(clippy::ref_option)] + +use crate::metadata::options::OptionDiagnostic; +use crate::walk::{ProjectFilesFilter, ProjectFilesWalker}; +pub use db::{Db, ProjectDatabase}; +use files::{Index, Indexed, IndexedFiles}; +use metadata::settings::Settings; +pub use metadata::{ProjectDiscoveryError, ProjectMetadata}; +use ruff_db::diagnostic::{ + Annotation, Diagnostic, DiagnosticId, Severity, Span, SubDiagnostic, create_parse_diagnostic, + create_unsupported_syntax_diagnostic, +}; +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_db::source::{SourceTextError, source_text}; +use ruff_db::system::{SystemPath, SystemPathBuf}; +use rustc_hash::FxHashSet; +use salsa::Durability; +use salsa::Setter; +use std::backtrace::BacktraceStatus; +use std::panic::{AssertUnwindSafe, UnwindSafe}; +use std::sync::Arc; +use thiserror::Error; +use tracing::error; +use ty_python_semantic::lint::{LintRegistry, LintRegistryBuilder, RuleSelection}; +use ty_python_semantic::register_lints; +use ty_python_semantic::types::check_types; + +pub mod combine; + +mod db; +mod files; +pub mod metadata; +mod walk; +pub mod watch; + +pub static DEFAULT_LINT_REGISTRY: std::sync::LazyLock<LintRegistry> = + std::sync::LazyLock::new(default_lints_registry); + +pub fn default_lints_registry() -> LintRegistry { + let mut builder = LintRegistryBuilder::default(); + register_lints(&mut builder); + builder.build() +} + +/// The project as a Salsa ingredient. +/// +/// ## How is a project different from a program? +/// There are two (related) motivations: +/// +/// 1. Program is defined in `ruff_db` and it can't reference the settings types for the linter and formatter +/// without introducing a cyclic dependency. The project is defined in a higher level crate +/// where it can reference these setting types. +/// 2. Running `ruff check` with different target versions results in different programs (settings) but +/// it remains the same project. That's why program is a narrowed view of the project only +/// holding on to the most fundamental settings required for checking. +#[salsa::input] +pub struct Project { + /// The files that are open in the project. + /// + /// Setting the open files to a non-`None` value changes `check` to only check the + /// open files rather than all files in the project. + #[returns(as_deref)] + #[default] + open_fileset: Option<Arc<FxHashSet<File>>>, + + /// The first-party files of this project. + #[default] + #[returns(ref)] + file_set: IndexedFiles, + + /// The metadata describing the project, including the unresolved options. + #[returns(ref)] + pub metadata: ProjectMetadata, + + /// The resolved project settings. + #[returns(ref)] + pub settings: Settings, + + /// The paths that should be included when checking this project. + /// + /// The default (when this list is empty) is to include all files in the project root + /// (that satisfy the configured include and exclude patterns). + /// However, it's sometimes desired to only check a subset of the project, e.g. to see + /// the diagnostics for a single file or a folder. + /// + /// This list gets initialized by the paths passed to `ty check <paths>` + /// + /// ## How is this different from `open_files`? + /// + /// The `included_paths` is closely related to `open_files`. The only difference is that + /// `open_files` is already a resolved set of files whereas `included_paths` is only a list of paths + /// that are resolved to files by indexing them. The other difference is that + /// new files added to any directory in `included_paths` will be indexed and added to the project + /// whereas `open_files` needs to be updated manually (e.g. by the IDE). + /// + /// In short, `open_files` is cheaper in contexts where the set of files is known, like + /// in an IDE when the user only wants to check the open tabs. This could be modeled + /// with `included_paths` too but it would require an explicit walk dir step that's simply unnecessary. + #[default] + #[returns(deref)] + included_paths_list: Vec<SystemPathBuf>, + + /// Diagnostics that were generated when resolving the project settings. + #[returns(deref)] + settings_diagnostics: Vec<OptionDiagnostic>, +} + +/// A progress reporter. +pub trait Reporter: Send + Sync { + /// Initialize the reporter with the number of files. + fn set_files(&mut self, files: usize); + + /// Report the completion of a given file. + fn report_file(&self, file: &File); +} + +/// A no-op implementation of [`Reporter`]. +#[derive(Default)] +pub struct DummyReporter; + +impl Reporter for DummyReporter { + fn set_files(&mut self, _files: usize) {} + fn report_file(&self, _file: &File) {} +} + +#[salsa::tracked] +impl Project { + pub fn from_metadata(db: &dyn Db, metadata: ProjectMetadata) -> Self { + let (settings, settings_diagnostics) = metadata.options().to_settings(db); + + Project::builder(metadata, settings, settings_diagnostics) + .durability(Durability::MEDIUM) + .open_fileset_durability(Durability::LOW) + .file_set_durability(Durability::LOW) + .new(db) + } + + pub fn root(self, db: &dyn Db) -> &SystemPath { + self.metadata(db).root() + } + + pub fn name(self, db: &dyn Db) -> &str { + self.metadata(db).name() + } + + /// Returns the resolved linter rules for the project. + /// + /// This is a salsa query to prevent re-computing queries if other, unrelated + /// settings change. For example, we don't want that changing the terminal settings + /// invalidates any type checking queries. + #[salsa::tracked(returns(deref))] + pub fn rules(self, db: &dyn Db) -> Arc<RuleSelection> { + self.settings(db).to_rules() + } + + /// Returns `true` if `path` is both part of the project and included (see `included_paths_list`). + /// + /// Unlike [Self::files], this method does not respect `.gitignore` files. It only checks + /// the project's include and exclude settings as well as the paths that were passed to `ty check <paths>`. + /// This means, that this method is an over-approximation of `Self::files` and may return `true` for paths + /// that won't be included when checking the project because they're ignored in a `.gitignore` file. + pub fn is_path_included(self, db: &dyn Db, path: &SystemPath) -> bool { + ProjectFilesFilter::from_project(db, self).is_included(path) + } + + pub fn reload(self, db: &mut dyn Db, metadata: ProjectMetadata) { + tracing::debug!("Reloading project"); + assert_eq!(self.root(db), metadata.root()); + + if &metadata != self.metadata(db) { + let (settings, settings_diagnostics) = metadata.options().to_settings(db); + + if self.settings(db) != &settings { + self.set_settings(db).to(settings); + } + + if self.settings_diagnostics(db) != settings_diagnostics { + self.set_settings_diagnostics(db).to(settings_diagnostics); + } + + self.set_metadata(db).to(metadata); + } + + self.reload_files(db); + } + + /// Checks all open files in the project and its dependencies. + pub(crate) fn check( + self, + db: &ProjectDatabase, + mut reporter: AssertUnwindSafe<&mut dyn Reporter>, + ) -> Vec<Diagnostic> { + let project_span = tracing::debug_span!("Project::check"); + let _span = project_span.enter(); + + tracing::debug!("Checking project '{name}'", name = self.name(db)); + + let mut diagnostics: Vec<Diagnostic> = Vec::new(); + diagnostics.extend( + self.settings_diagnostics(db) + .iter() + .map(OptionDiagnostic::to_diagnostic), + ); + + let files = ProjectFiles::new(db, self); + reporter.set_files(files.len()); + + diagnostics.extend( + files + .diagnostics() + .iter() + .map(IOErrorDiagnostic::to_diagnostic), + ); + + let file_diagnostics = std::sync::Mutex::new(vec![]); + + { + let db = db.clone(); + let file_diagnostics = &file_diagnostics; + let project_span = &project_span; + let reporter = &reporter; + + rayon::scope(move |scope| { + for file in &files { + let db = db.clone(); + scope.spawn(move |_| { + let check_file_span = + tracing::debug_span!(parent: project_span, "check_file", ?file); + let _entered = check_file_span.entered(); + + let result = check_file_impl(&db, file); + file_diagnostics.lock().unwrap().extend(result); + + reporter.report_file(&file); + }); + } + }); + } + + let mut file_diagnostics = file_diagnostics.into_inner().unwrap(); + file_diagnostics.sort_by(|left, right| { + left.rendering_sort_key(db) + .cmp(&right.rendering_sort_key(db)) + }); + diagnostics.extend(file_diagnostics); + diagnostics + } + + pub(crate) fn check_file(self, db: &dyn Db, file: File) -> Vec<Diagnostic> { + let mut file_diagnostics: Vec<_> = self + .settings_diagnostics(db) + .iter() + .map(OptionDiagnostic::to_diagnostic) + .collect(); + + let check_diagnostics = check_file_impl(db, file); + file_diagnostics.extend(check_diagnostics); + + file_diagnostics + } + + /// Opens a file in the project. + /// + /// This changes the behavior of `check` to only check the open files rather than all files in the project. + pub fn open_file(self, db: &mut dyn Db, file: File) { + tracing::debug!("Opening file `{}`", file.path(db)); + + let mut open_files = self.take_open_files(db); + open_files.insert(file); + self.set_open_files(db, open_files); + } + + /// Closes a file in the project. + pub fn close_file(self, db: &mut dyn Db, file: File) -> bool { + tracing::debug!("Closing file `{}`", file.path(db)); + + let mut open_files = self.take_open_files(db); + let removed = open_files.remove(&file); + + if removed { + self.set_open_files(db, open_files); + } + + removed + } + + pub fn set_included_paths(self, db: &mut dyn Db, paths: Vec<SystemPathBuf>) { + tracing::debug!("Setting included paths: {paths}", paths = paths.len()); + + self.set_included_paths_list(db).to(paths); + self.reload_files(db); + } + + /// Returns the paths that should be checked. + /// + /// The default is to check the entire project in which case this method returns + /// the project root. However, users can specify to only check specific sub-folders or + /// even files of a project by using `ty check <paths>`. In that case, this method + /// returns the provided absolute paths. + /// + /// Note: The CLI doesn't prohibit users from specifying paths outside the project root. + /// This can be useful to check arbitrary files, but it isn't something we recommend. + /// We should try to support this use case but it's okay if there are some limitations around it. + fn included_paths_or_root(self, db: &dyn Db) -> &[SystemPathBuf] { + match self.included_paths_list(db) { + [] => std::slice::from_ref(&self.metadata(db).root), + paths => paths, + } + } + + /// Returns the open files in the project or `None` if the entire project should be checked. + pub fn open_files(self, db: &dyn Db) -> Option<&FxHashSet<File>> { + self.open_fileset(db) + } + + /// Sets the open files in the project. + /// + /// This changes the behavior of `check` to only check the open files rather than all files in the project. + #[tracing::instrument(level = "debug", skip(self, db))] + pub fn set_open_files(self, db: &mut dyn Db, open_files: FxHashSet<File>) { + tracing::debug!("Set open project files (count: {})", open_files.len()); + + self.set_open_fileset(db).to(Some(Arc::new(open_files))); + } + + /// This takes the open files from the project and returns them. + /// + /// This changes the behavior of `check` to check all files in the project instead of just the open files. + fn take_open_files(self, db: &mut dyn Db) -> FxHashSet<File> { + tracing::debug!("Take open project files"); + + // Salsa will cancel any pending queries and remove its own reference to `open_files` + // so that the reference counter to `open_files` now drops to 1. + let open_files = self.set_open_fileset(db).to(None); + + if let Some(open_files) = open_files { + Arc::try_unwrap(open_files).unwrap() + } else { + FxHashSet::default() + } + } + + /// Returns `true` if the file is open in the project. + /// + /// A file is considered open when: + /// * explicitly set as an open file using [`open_file`](Self::open_file) + /// * It has a [`SystemPath`] and belongs to a package's `src` files + /// * It has a [`SystemVirtualPath`](ruff_db::system::SystemVirtualPath) + pub fn is_file_open(self, db: &dyn Db, file: File) -> bool { + let path = file.path(db); + + // Try to return early to avoid adding a dependency on `open_files` or `file_set` which + // both have a durability of `LOW`. + if path.is_vendored_path() { + return false; + } + + if let Some(open_files) = self.open_files(db) { + open_files.contains(&file) + } else if file.path(db).is_system_path() { + self.files(db).contains(&file) + } else { + file.path(db).is_system_virtual_path() + } + } + + #[tracing::instrument(level = "debug", skip(self, db))] + pub fn remove_file(self, db: &mut dyn Db, file: File) { + tracing::debug!( + "Removing file `{}` from project `{}`", + file.path(db), + self.name(db) + ); + + let Some(mut index) = IndexedFiles::indexed_mut(db, self) else { + return; + }; + + index.remove(file); + } + + pub fn add_file(self, db: &mut dyn Db, file: File) { + tracing::debug!( + "Adding file `{}` to project `{}`", + file.path(db), + self.name(db) + ); + + let Some(mut index) = IndexedFiles::indexed_mut(db, self) else { + return; + }; + + index.insert(file); + } + + /// Replaces the diagnostics from indexing the project files with `diagnostics`. + /// + /// This is a no-op if the project files haven't been indexed yet. + pub fn replace_index_diagnostics(self, db: &mut dyn Db, diagnostics: Vec<IOErrorDiagnostic>) { + let Some(mut index) = IndexedFiles::indexed_mut(db, self) else { + return; + }; + + index.set_diagnostics(diagnostics); + } + + /// Returns the files belonging to this project. + pub fn files(self, db: &dyn Db) -> Indexed<'_> { + let files = self.file_set(db); + + match files.get() { + Index::Lazy(vacant) => { + let _entered = + tracing::debug_span!("Project::index_files", project = %self.name(db)) + .entered(); + + let walker = ProjectFilesWalker::new(db); + let (files, diagnostics) = walker.collect_set(db); + + tracing::info!("Indexed {} file(s)", files.len()); + vacant.set(files, diagnostics) + } + Index::Indexed(indexed) => indexed, + } + } + + pub fn reload_files(self, db: &mut dyn Db) { + tracing::debug!("Reloading files for project `{}`", self.name(db)); + + if !self.file_set(db).is_lazy() { + // Force a re-index of the files in the next revision. + self.set_file_set(db).to(IndexedFiles::lazy()); + } + } +} + +fn check_file_impl(db: &dyn Db, file: File) -> Vec<Diagnostic> { + let mut diagnostics: Vec<Diagnostic> = Vec::new(); + + // Abort checking if there are IO errors. + let source = source_text(db.upcast(), file); + + if let Some(read_error) = source.read_error() { + diagnostics.push( + IOErrorDiagnostic { + file: Some(file), + error: read_error.clone().into(), + } + .to_diagnostic(), + ); + return diagnostics; + } + + let parsed = parsed_module(db.upcast(), file); + diagnostics.extend( + parsed + .errors() + .iter() + .map(|error| create_parse_diagnostic(file, error)), + ); + + diagnostics.extend( + parsed + .unsupported_syntax_errors() + .iter() + .map(|error| create_unsupported_syntax_diagnostic(file, error)), + ); + + { + let db = AssertUnwindSafe(db); + match catch(&**db, file, || check_types(db.upcast(), file)) { + Ok(Some(type_check_diagnostics)) => { + diagnostics.extend(type_check_diagnostics.into_iter().cloned()); + } + Ok(None) => {} + Err(diagnostic) => diagnostics.push(diagnostic), + } + } + + diagnostics.sort_unstable_by_key(|diagnostic| { + diagnostic + .primary_span() + .and_then(|span| span.range()) + .unwrap_or_default() + .start() + }); + + diagnostics +} + +#[derive(Debug)] +enum ProjectFiles<'a> { + OpenFiles(&'a FxHashSet<File>), + Indexed(files::Indexed<'a>), +} + +impl<'a> ProjectFiles<'a> { + fn new(db: &'a dyn Db, project: Project) -> Self { + if let Some(open_files) = project.open_files(db) { + ProjectFiles::OpenFiles(open_files) + } else { + ProjectFiles::Indexed(project.files(db)) + } + } + + fn diagnostics(&self) -> &[IOErrorDiagnostic] { + match self { + ProjectFiles::OpenFiles(_) => &[], + ProjectFiles::Indexed(indexed) => indexed.diagnostics(), + } + } + + fn len(&self) -> usize { + match self { + ProjectFiles::OpenFiles(open_files) => open_files.len(), + ProjectFiles::Indexed(indexed) => indexed.len(), + } + } +} + +impl<'a> IntoIterator for &'a ProjectFiles<'a> { + type Item = File; + type IntoIter = ProjectFilesIter<'a>; + + fn into_iter(self) -> Self::IntoIter { + match self { + ProjectFiles::OpenFiles(files) => ProjectFilesIter::OpenFiles(files.iter()), + ProjectFiles::Indexed(indexed) => ProjectFilesIter::Indexed { + files: indexed.into_iter(), + }, + } + } +} + +enum ProjectFilesIter<'db> { + OpenFiles(std::collections::hash_set::Iter<'db, File>), + Indexed { files: files::IndexedIter<'db> }, +} + +impl Iterator for ProjectFilesIter<'_> { + type Item = File; + + fn next(&mut self) -> Option<Self::Item> { + match self { + ProjectFilesIter::OpenFiles(files) => files.next().copied(), + ProjectFilesIter::Indexed { files } => files.next(), + } + } +} + +#[derive(Debug, Clone)] +pub struct IOErrorDiagnostic { + file: Option<File>, + error: IOErrorKind, +} + +impl IOErrorDiagnostic { + fn to_diagnostic(&self) -> Diagnostic { + let mut diag = Diagnostic::new(DiagnosticId::Io, Severity::Error, &self.error); + if let Some(file) = self.file { + diag.annotate(Annotation::primary(Span::from(file))); + } + diag + } +} + +#[derive(Error, Debug, Clone)] +enum IOErrorKind { + #[error(transparent)] + Walk(#[from] walk::WalkError), + + #[error(transparent)] + SourceText(#[from] SourceTextError), +} + +fn catch<F, R>(db: &dyn Db, file: File, f: F) -> Result<Option<R>, Diagnostic> +where + F: FnOnce() -> R + UnwindSafe, +{ + match ruff_db::panic::catch_unwind(|| { + // Ignore salsa errors + salsa::Cancelled::catch(f).ok() + }) { + Ok(result) => Ok(result), + Err(error) => { + use std::fmt::Write; + let mut message = String::new(); + message.push_str("Panicked"); + + if let Some(location) = error.location { + let _ = write!(&mut message, " at {location}"); + } + + let _ = write!( + &mut message, + " when checking `{file}`", + file = file.path(db) + ); + + if let Some(payload) = error.payload.as_str() { + let _ = write!(&mut message, ": `{payload}`"); + } + + let mut diagnostic = Diagnostic::new(DiagnosticId::Panic, Severity::Fatal, message); + diagnostic.sub(SubDiagnostic::new( + Severity::Info, + "This indicates a bug in ty.", + )); + + let report_message = "If you could open an issue at https://github.com/astral-sh/ty/issues/new?title=%5Bpanic%5D, we'd be very appreciative!"; + diagnostic.sub(SubDiagnostic::new(Severity::Info, report_message)); + diagnostic.sub(SubDiagnostic::new( + Severity::Info, + format!( + "Platform: {os} {arch}", + os = std::env::consts::OS, + arch = std::env::consts::ARCH + ), + )); + diagnostic.sub(SubDiagnostic::new( + Severity::Info, + format!( + "Args: {args:?}", + args = std::env::args().collect::<Vec<_>>() + ), + )); + + if let Some(backtrace) = error.backtrace { + match backtrace.status() { + BacktraceStatus::Disabled => { + diagnostic.sub(SubDiagnostic::new( + Severity::Info, + "run with `RUST_BACKTRACE=1` environment variable to show the full backtrace information", + )); + } + BacktraceStatus::Captured => { + diagnostic.sub(SubDiagnostic::new( + Severity::Info, + format!("Backtrace:\n{backtrace}"), + )); + } + _ => {} + } + } + + if let Some(backtrace) = error.salsa_backtrace { + salsa::attach(db, || { + diagnostic.sub(SubDiagnostic::new(Severity::Info, backtrace.to_string())); + }); + } + + Err(diagnostic) + } + } +} + +#[cfg(test)] +mod tests { + use crate::db::tests::TestDb; + use crate::{ProjectMetadata, check_file_impl}; + use ruff_db::files::system_path_to_file; + use ruff_db::source::source_text; + use ruff_db::system::{DbWithTestSystem, DbWithWritableSystem as _, SystemPath, SystemPathBuf}; + use ruff_db::testing::assert_function_query_was_not_run; + use ruff_python_ast::name::Name; + use ty_python_semantic::types::check_types; + use ty_python_semantic::{ + Program, ProgramSettings, PythonPlatform, PythonVersionWithSource, SearchPathSettings, + }; + + #[test] + fn check_file_skips_type_checking_when_file_cant_be_read() -> ruff_db::system::Result<()> { + let project = ProjectMetadata::new(Name::new_static("test"), SystemPathBuf::from("/")); + let mut db = TestDb::new(project); + let path = SystemPath::new("test.py"); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings::new(vec![SystemPathBuf::from(".")]), + }, + ) + .expect("Failed to configure program settings"); + + db.write_file(path, "x = 10")?; + let file = system_path_to_file(&db, path).unwrap(); + + // Now the file gets deleted before we had a chance to read its source text. + db.memory_file_system().remove_file(path)?; + file.sync(&mut db); + + assert_eq!(source_text(&db, file).as_str(), ""); + assert_eq!( + check_file_impl(&db, file) + .into_iter() + .map(|diagnostic| diagnostic.primary_message().to_string()) + .collect::<Vec<_>>(), + vec!["Failed to read file: No such file or directory".to_string()] + ); + + let events = db.take_salsa_events(); + assert_function_query_was_not_run(&db, check_types, file, &events); + + // The user now creates a new file with an empty text. The source text + // content returned by `source_text` remains unchanged, but the diagnostics should get updated. + db.write_file(path, "").unwrap(); + + assert_eq!(source_text(&db, file).as_str(), ""); + assert_eq!( + check_file_impl(&db, file) + .into_iter() + .map(|diagnostic| diagnostic.primary_message().to_string()) + .collect::<Vec<_>>(), + vec![] as Vec<String> + ); + + Ok(()) + } +} diff --git a/crates/ty_project/src/metadata.rs b/crates/ty_project/src/metadata.rs new file mode 100644 index 0000000000000..71bc12264c8e3 --- /dev/null +++ b/crates/ty_project/src/metadata.rs @@ -0,0 +1,1045 @@ +use configuration_file::{ConfigurationFile, ConfigurationFileError}; +use ruff_db::system::{System, SystemPath, SystemPathBuf}; +use ruff_python_ast::name::Name; +use std::sync::Arc; +use thiserror::Error; +use ty_python_semantic::ProgramSettings; + +use crate::combine::Combine; +use crate::metadata::pyproject::{Project, PyProject, PyProjectError, ResolveRequiresPythonError}; +use crate::metadata::value::ValueSource; +pub use options::Options; +use options::TyTomlError; + +mod configuration_file; +pub mod options; +pub mod pyproject; +pub mod settings; +pub mod value; + +#[derive(Debug, PartialEq, Eq)] +#[cfg_attr(test, derive(serde::Serialize))] +pub struct ProjectMetadata { + pub(super) name: Name, + + pub(super) root: SystemPathBuf, + + /// The raw options + pub(super) options: Options, + + /// Paths of configurations other than the project's configuration that were combined into [`Self::options`]. + /// + /// This field stores the paths of the configuration files, mainly for + /// knowing which files to watch for changes. + /// + /// The path ordering doesn't imply precedence. + #[cfg_attr(test, serde(skip_serializing_if = "Vec::is_empty"))] + pub(super) extra_configuration_paths: Vec<SystemPathBuf>, +} + +impl ProjectMetadata { + /// Creates a project with the given name and root that uses the default options. + pub fn new(name: Name, root: SystemPathBuf) -> Self { + Self { + name, + root, + extra_configuration_paths: Vec::default(), + options: Options::default(), + } + } + + /// Loads a project from a `pyproject.toml` file. + pub(crate) fn from_pyproject( + pyproject: PyProject, + root: SystemPathBuf, + ) -> Result<Self, ResolveRequiresPythonError> { + Self::from_options( + pyproject.tool.and_then(|tool| tool.ty).unwrap_or_default(), + root, + pyproject.project.as_ref(), + ) + } + + /// Loads a project from a set of options with an optional pyproject-project table. + pub fn from_options( + mut options: Options, + root: SystemPathBuf, + project: Option<&Project>, + ) -> Result<Self, ResolveRequiresPythonError> { + let name = project + .and_then(|project| project.name.as_deref()) + .map(|name| Name::new(&**name)) + .unwrap_or_else(|| Name::new(root.file_name().unwrap_or("root"))); + + // If the `options` don't specify a python version but the `project.requires-python` field is set, + // use that as a lower bound instead. + if let Some(project) = project { + if options + .environment + .as_ref() + .is_none_or(|env| env.python_version.is_none()) + { + if let Some(requires_python) = project.resolve_requires_python_lower_bound()? { + let mut environment = options.environment.unwrap_or_default(); + environment.python_version = Some(requires_python); + options.environment = Some(environment); + } + } + } + + Ok(Self { + name, + root, + options, + extra_configuration_paths: Vec::new(), + }) + } + + /// Discovers the closest project at `path` and returns its metadata. + /// + /// The algorithm traverses upwards in the `path`'s ancestor chain and uses the following precedence + /// the resolve the project's root. + /// + /// 1. The closest `pyproject.toml` with a `tool.ty` section or `ty.toml`. + /// 1. The closest `pyproject.toml`. + /// 1. Fallback to use `path` as the root and use the default settings. + pub fn discover( + path: &SystemPath, + system: &dyn System, + ) -> Result<ProjectMetadata, ProjectDiscoveryError> { + tracing::debug!("Searching for a project in '{path}'"); + + if !system.is_directory(path) { + return Err(ProjectDiscoveryError::NotADirectory(path.to_path_buf())); + } + + let mut closest_project: Option<ProjectMetadata> = None; + + for project_root in path.ancestors() { + let pyproject_path = project_root.join("pyproject.toml"); + + let pyproject = if let Ok(pyproject_str) = system.read_to_string(&pyproject_path) { + match PyProject::from_toml_str( + &pyproject_str, + ValueSource::File(Arc::new(pyproject_path.clone())), + ) { + Ok(pyproject) => Some(pyproject), + Err(error) => { + return Err(ProjectDiscoveryError::InvalidPyProject { + path: pyproject_path, + source: Box::new(error), + }); + } + } + } else { + None + }; + + // A `ty.toml` takes precedence over a `pyproject.toml`. + let ty_toml_path = project_root.join("ty.toml"); + if let Ok(ty_str) = system.read_to_string(&ty_toml_path) { + let options = match Options::from_toml_str( + &ty_str, + ValueSource::File(Arc::new(ty_toml_path.clone())), + ) { + Ok(options) => options, + Err(error) => { + return Err(ProjectDiscoveryError::InvalidTyToml { + path: ty_toml_path, + source: Box::new(error), + }); + } + }; + + if pyproject + .as_ref() + .is_some_and(|project| project.ty().is_some()) + { + // TODO: Consider using a diagnostic here + tracing::warn!( + "Ignoring the `tool.ty` section in `{pyproject_path}` because `{ty_toml_path}` takes precedence." + ); + } + + tracing::debug!("Found project at '{}'", project_root); + + let metadata = ProjectMetadata::from_options( + options, + project_root.to_path_buf(), + pyproject + .as_ref() + .and_then(|pyproject| pyproject.project.as_ref()), + ) + .map_err(|err| { + ProjectDiscoveryError::InvalidRequiresPythonConstraint { + source: err, + path: pyproject_path, + } + })?; + + return Ok(metadata); + } + + if let Some(pyproject) = pyproject { + let has_ty_section = pyproject.ty().is_some(); + let metadata = + ProjectMetadata::from_pyproject(pyproject, project_root.to_path_buf()) + .map_err( + |err| ProjectDiscoveryError::InvalidRequiresPythonConstraint { + source: err, + path: pyproject_path, + }, + )?; + + if has_ty_section { + tracing::debug!("Found project at '{}'", project_root); + + return Ok(metadata); + } + + // Not a project itself, keep looking for an enclosing project. + if closest_project.is_none() { + closest_project = Some(metadata); + } + } + } + + // No project found, but maybe a pyproject.toml was found. + let metadata = if let Some(closest_project) = closest_project { + tracing::debug!( + "Project without `tool.ty` section: '{}'", + closest_project.root() + ); + + closest_project + } else { + tracing::debug!( + "The ancestor directories contain no `pyproject.toml`. Falling back to a virtual project." + ); + + // Create a project with a default configuration + Self::new( + path.file_name().unwrap_or("root").into(), + path.to_path_buf(), + ) + }; + + Ok(metadata) + } + + pub fn root(&self) -> &SystemPath { + &self.root + } + + pub fn name(&self) -> &str { + &self.name + } + + pub fn options(&self) -> &Options { + &self.options + } + + pub fn extra_configuration_paths(&self) -> &[SystemPathBuf] { + &self.extra_configuration_paths + } + + pub fn to_program_settings(&self, system: &dyn System) -> ProgramSettings { + self.options + .to_program_settings(self.root(), self.name(), system) + } + + /// Combine the project options with the CLI options where the CLI options take precedence. + pub fn apply_cli_options(&mut self, options: Options) { + self.options = options.combine(std::mem::take(&mut self.options)); + } + + /// Applies the options from the configuration files to the project's options. + /// + /// This includes: + /// + /// * The user-level configuration + pub fn apply_configuration_files( + &mut self, + system: &dyn System, + ) -> Result<(), ConfigurationFileError> { + if let Some(user) = ConfigurationFile::user(system)? { + tracing::debug!( + "Applying user-level configuration loaded from `{path}`.", + path = user.path() + ); + self.apply_configuration_file(user); + } + + Ok(()) + } + + /// Applies a lower-precedence configuration files to the project's options. + fn apply_configuration_file(&mut self, options: ConfigurationFile) { + self.extra_configuration_paths + .push(options.path().to_owned()); + self.options.combine_with(options.into_options()); + } +} + +#[derive(Debug, Error)] +pub enum ProjectDiscoveryError { + #[error("project path '{0}' is not a directory")] + NotADirectory(SystemPathBuf), + + #[error("{path} is not a valid `pyproject.toml`: {source}")] + InvalidPyProject { + source: Box<PyProjectError>, + path: SystemPathBuf, + }, + + #[error("{path} is not a valid `ty.toml`: {source}")] + InvalidTyToml { + source: Box<TyTomlError>, + path: SystemPathBuf, + }, + + #[error("Invalid `requires-python` version specifier (`{path}`): {source}")] + InvalidRequiresPythonConstraint { + source: ResolveRequiresPythonError, + path: SystemPathBuf, + }, +} + +#[cfg(test)] +mod tests { + //! Integration tests for project discovery + + use anyhow::{Context, anyhow}; + use insta::assert_ron_snapshot; + use ruff_db::system::{SystemPathBuf, TestSystem}; + use ruff_python_ast::PythonVersion; + + use crate::{ProjectDiscoveryError, ProjectMetadata}; + + #[test] + fn project_without_pyproject() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([(root.join("foo.py"), ""), (root.join("bar.py"), "")]) + .context("Failed to write files")?; + + let project = + ProjectMetadata::discover(&root, &system).context("Failed to discover project")?; + + assert_eq!(project.root(), &*root); + + with_escaped_paths(|| { + assert_ron_snapshot!(&project, @r#" + ProjectMetadata( + name: Name("app"), + root: "/app", + options: Options(), + ) + "#); + }); + + Ok(()) + } + + #[test] + fn project_with_pyproject() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "backend" + + "#, + ), + (root.join("db/__init__.py"), ""), + ]) + .context("Failed to write files")?; + + let project = + ProjectMetadata::discover(&root, &system).context("Failed to discover project")?; + + assert_eq!(project.root(), &*root); + + with_escaped_paths(|| { + assert_ron_snapshot!(&project, @r#" + ProjectMetadata( + name: Name("backend"), + root: "/app", + options: Options(), + ) + "#); + }); + + // Discovering the same package from a subdirectory should give the same result + let from_src = ProjectMetadata::discover(&root.join("db"), &system) + .context("Failed to discover project from src sub-directory")?; + + assert_eq!(from_src, project); + + Ok(()) + } + + #[test] + fn project_with_invalid_pyproject() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "backend" + + [tool.ty + "#, + ), + (root.join("db/__init__.py"), ""), + ]) + .context("Failed to write files")?; + + let Err(error) = ProjectMetadata::discover(&root, &system) else { + return Err(anyhow!( + "Expected project discovery to fail because of invalid syntax in the pyproject.toml" + )); + }; + + assert_error_eq( + &error, + r#"/app/pyproject.toml is not a valid `pyproject.toml`: TOML parse error at line 5, column 29 + | +5 | [tool.ty + | ^ +invalid table header +expected `.`, `]` +"#, + ); + + Ok(()) + } + + #[test] + fn nested_projects_in_sub_project() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "project-root" + + [tool.ty.src] + root = "src" + "#, + ), + ( + root.join("packages/a/pyproject.toml"), + r#" + [project] + name = "nested-project" + + [tool.ty.src] + root = "src" + "#, + ), + ]) + .context("Failed to write files")?; + + let sub_project = ProjectMetadata::discover(&root.join("packages/a"), &system)?; + + with_escaped_paths(|| { + assert_ron_snapshot!(sub_project, @r#" + ProjectMetadata( + name: Name("nested-project"), + root: "/app/packages/a", + options: Options( + src: Some(SrcOptions( + root: Some("src"), + )), + ), + ) + "#); + }); + + Ok(()) + } + + #[test] + fn nested_projects_in_root_project() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "project-root" + + [tool.ty.src] + root = "src" + "#, + ), + ( + root.join("packages/a/pyproject.toml"), + r#" + [project] + name = "nested-project" + + [tool.ty.src] + root = "src" + "#, + ), + ]) + .context("Failed to write files")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + with_escaped_paths(|| { + assert_ron_snapshot!(root, @r#" + ProjectMetadata( + name: Name("project-root"), + root: "/app", + options: Options( + src: Some(SrcOptions( + root: Some("src"), + )), + ), + ) + "#); + }); + + Ok(()) + } + + #[test] + fn nested_projects_without_ty_sections() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "project-root" + "#, + ), + ( + root.join("packages/a/pyproject.toml"), + r#" + [project] + name = "nested-project" + "#, + ), + ]) + .context("Failed to write files")?; + + let sub_project = ProjectMetadata::discover(&root.join("packages/a"), &system)?; + + with_escaped_paths(|| { + assert_ron_snapshot!(sub_project, @r#" + ProjectMetadata( + name: Name("nested-project"), + root: "/app/packages/a", + options: Options(), + ) + "#); + }); + + Ok(()) + } + + #[test] + fn nested_projects_with_outer_ty_section() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "project-root" + + [tool.ty.environment] + python-version = "3.10" + "#, + ), + ( + root.join("packages/a/pyproject.toml"), + r#" + [project] + name = "nested-project" + "#, + ), + ]) + .context("Failed to write files")?; + + let root = ProjectMetadata::discover(&root.join("packages/a"), &system)?; + + with_escaped_paths(|| { + assert_ron_snapshot!(root, @r#" + ProjectMetadata( + name: Name("project-root"), + root: "/app", + options: Options( + environment: Some(EnvironmentOptions( + r#python-version: Some("3.10"), + )), + ), + ) + "#); + }); + + Ok(()) + } + + /// A `ty.toml` takes precedence over any `pyproject.toml`. + /// + /// However, the `pyproject.toml` is still loaded to get the project name and, in the future, + /// the requires-python constraint. + #[test] + fn project_with_ty_and_pyproject_toml() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_files_all([ + ( + root.join("pyproject.toml"), + r#" + [project] + name = "super-app" + requires-python = ">=3.12" + + [tool.ty.src] + root = "this_option_is_ignored" + "#, + ), + ( + root.join("ty.toml"), + r#" + [src] + root = "src" + "#, + ), + ]) + .context("Failed to write files")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + with_escaped_paths(|| { + assert_ron_snapshot!(root, @r#" + ProjectMetadata( + name: Name("super-app"), + root: "/app", + options: Options( + environment: Some(EnvironmentOptions( + r#python-version: Some("3.12"), + )), + src: Some(SrcOptions( + root: Some("src"), + )), + ), + ) + "#); + }); + + Ok(()) + } + #[test] + fn requires_python_major_minor() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">=3.12" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::PY312) + ); + + Ok(()) + } + + #[test] + fn requires_python_major_only() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">=3" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::from((3, 0))) + ); + + Ok(()) + } + + /// A `requires-python` constraint with major, minor and patch can be simplified + /// to major and minor (e.g. 3.12.1 -> 3.12). + #[test] + fn requires_python_major_minor_patch() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">=3.12.8" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::PY312) + ); + + Ok(()) + } + + #[test] + fn requires_python_beta_version() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">= 3.13.0b0" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::PY313) + ); + + Ok(()) + } + + #[test] + fn requires_python_greater_than_major_minor() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + # This is somewhat nonsensical because 3.12.1 > 3.12 is true. + # That's why simplifying the constraint to >= 3.12 is correct + requires-python = ">3.12" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::PY312) + ); + + Ok(()) + } + + /// `python-version` takes precedence if both `requires-python` and `python-version` are configured. + #[test] + fn requires_python_and_python_version() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">=3.12" + + [tool.ty.environment] + python-version = "3.10" + "#, + ) + .context("Failed to write file")?; + + let root = ProjectMetadata::discover(&root, &system)?; + + assert_eq!( + root.options + .environment + .unwrap_or_default() + .python_version + .as_deref(), + Some(&PythonVersion::PY310) + ); + + Ok(()) + } + + #[test] + fn requires_python_less_than() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = "<3.12" + "#, + ) + .context("Failed to write file")?; + + let Err(error) = ProjectMetadata::discover(&root, &system) else { + return Err(anyhow!( + "Expected project discovery to fail because the `requires-python` doesn't specify a lower bound (it only specifies an upper bound)." + )); + }; + + assert_error_eq( + &error, + "Invalid `requires-python` version specifier (`/app/pyproject.toml`): value `<3.12` does not contain a lower bound. Add a lower bound to indicate the minimum compatible Python version (e.g., `>=3.13`) or specify a version in `environment.python-version`.", + ); + + Ok(()) + } + + #[test] + fn requires_python_no_specifiers() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = "" + "#, + ) + .context("Failed to write file")?; + + let Err(error) = ProjectMetadata::discover(&root, &system) else { + return Err(anyhow!( + "Expected project discovery to fail because the `requires-python` specifiers are empty and don't define a lower bound." + )); + }; + + assert_error_eq( + &error, + "Invalid `requires-python` version specifier (`/app/pyproject.toml`): value `` does not contain a lower bound. Add a lower bound to indicate the minimum compatible Python version (e.g., `>=3.13`) or specify a version in `environment.python-version`.", + ); + + Ok(()) + } + + #[test] + fn requires_python_too_large_major_version() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("pyproject.toml"), + r#" + [project] + requires-python = ">=999.0" + "#, + ) + .context("Failed to write file")?; + + let Err(error) = ProjectMetadata::discover(&root, &system) else { + return Err(anyhow!( + "Expected project discovery to fail because of the requires-python major version that is larger than 255." + )); + }; + + assert_error_eq( + &error, + "Invalid `requires-python` version specifier (`/app/pyproject.toml`): The major version `999` is larger than the maximum supported value 255", + ); + + Ok(()) + } + + #[test] + fn no_src_root_src_layout() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("src/main.py"), + r#" + print("Hello, world!") + "#, + ) + .context("Failed to write file")?; + + let metadata = ProjectMetadata::discover(&root, &system)?; + let settings = metadata + .options + .to_program_settings(&root, "my_package", &system); + + assert_eq!( + settings.search_paths.src_roots, + vec![root.clone(), root.join("src")] + ); + + Ok(()) + } + + #[test] + fn no_src_root_package_layout() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("psycopg/psycopg/main.py"), + r#" + print("Hello, world!") + "#, + ) + .context("Failed to write file")?; + + let metadata = ProjectMetadata::discover(&root, &system)?; + let settings = metadata + .options + .to_program_settings(&root, "psycopg", &system); + + assert_eq!( + settings.search_paths.src_roots, + vec![root.clone(), root.join("psycopg")] + ); + + Ok(()) + } + + #[test] + fn no_src_root_flat_layout() -> anyhow::Result<()> { + let system = TestSystem::default(); + let root = SystemPathBuf::from("/app"); + + system + .memory_file_system() + .write_file_all( + root.join("my_package/main.py"), + r#" + print("Hello, world!") + "#, + ) + .context("Failed to write file")?; + + let metadata = ProjectMetadata::discover(&root, &system)?; + let settings = metadata + .options + .to_program_settings(&root, "my_package", &system); + + assert_eq!(settings.search_paths.src_roots, vec![root]); + + Ok(()) + } + + #[track_caller] + fn assert_error_eq(error: &ProjectDiscoveryError, message: &str) { + assert_eq!(error.to_string().replace('\\', "/"), message); + } + + fn with_escaped_paths<R>(f: impl FnOnce() -> R) -> R { + let mut settings = insta::Settings::clone_current(); + settings.add_dynamic_redaction(".root", |content, _path| { + content.as_str().unwrap().replace('\\', "/") + }); + + settings.bind(f) + } +} diff --git a/crates/ty_project/src/metadata/configuration_file.rs b/crates/ty_project/src/metadata/configuration_file.rs new file mode 100644 index 0000000000000..4190d2cd8b8f6 --- /dev/null +++ b/crates/ty_project/src/metadata/configuration_file.rs @@ -0,0 +1,69 @@ +use std::sync::Arc; + +use ruff_db::system::{System, SystemPath, SystemPathBuf}; +use thiserror::Error; + +use crate::metadata::value::ValueSource; + +use super::options::{Options, TyTomlError}; + +/// A `ty.toml` configuration file with the options it contains. +pub(crate) struct ConfigurationFile { + path: SystemPathBuf, + options: Options, +} + +impl ConfigurationFile { + /// Loads the user-level configuration file if it exists. + /// + /// Returns `None` if the file does not exist or if the concept of user-level configurations + /// doesn't exist on `system`. + pub(crate) fn user(system: &dyn System) -> Result<Option<Self>, ConfigurationFileError> { + let Some(configuration_directory) = system.user_config_directory() else { + return Ok(None); + }; + + let ty_toml_path = configuration_directory.join("ty").join("ty.toml"); + + tracing::debug!( + "Searching for a user-level configuration at `{path}`", + path = &ty_toml_path + ); + + let Ok(ty_toml_str) = system.read_to_string(&ty_toml_path) else { + return Ok(None); + }; + + match Options::from_toml_str( + &ty_toml_str, + ValueSource::File(Arc::new(ty_toml_path.clone())), + ) { + Ok(options) => Ok(Some(Self { + path: ty_toml_path, + options, + })), + Err(error) => Err(ConfigurationFileError::InvalidTyToml { + source: Box::new(error), + path: ty_toml_path, + }), + } + } + + /// Returns the path to the configuration file. + pub(crate) fn path(&self) -> &SystemPath { + &self.path + } + + pub(crate) fn into_options(self) -> Options { + self.options + } +} + +#[derive(Debug, Error)] +pub enum ConfigurationFileError { + #[error("{path} is not a valid `ty.toml`: {source}")] + InvalidTyToml { + source: Box<TyTomlError>, + path: SystemPathBuf, + }, +} diff --git a/crates/ty_project/src/metadata/options.rs b/crates/ty_project/src/metadata/options.rs new file mode 100644 index 0000000000000..00bab6dd9575d --- /dev/null +++ b/crates/ty_project/src/metadata/options.rs @@ -0,0 +1,552 @@ +use crate::Db; +use crate::metadata::value::{RangedValue, RelativePathBuf, ValueSource, ValueSourceGuard}; +use ruff_db::diagnostic::{Annotation, Diagnostic, DiagnosticFormat, DiagnosticId, Severity, Span}; +use ruff_db::files::system_path_to_file; +use ruff_db::system::{System, SystemPath}; +use ruff_macros::{Combine, OptionsMetadata}; +use ruff_python_ast::PythonVersion; +use rustc_hash::FxHashMap; +use serde::{Deserialize, Serialize}; +use std::fmt::Debug; +use thiserror::Error; +use ty_python_semantic::lint::{GetLintError, Level, LintSource, RuleSelection}; +use ty_python_semantic::{ + ProgramSettings, PythonPath, PythonPlatform, PythonVersionSource, PythonVersionWithSource, + SearchPathSettings, +}; + +use super::settings::{Settings, TerminalSettings}; + +#[derive( + Debug, Default, Clone, PartialEq, Eq, Combine, Serialize, Deserialize, OptionsMetadata, +)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct Options { + /// Configures the type checking environment. + #[option_group] + #[serde(skip_serializing_if = "Option::is_none")] + pub environment: Option<EnvironmentOptions>, + + #[serde(skip_serializing_if = "Option::is_none")] + #[option_group] + pub src: Option<SrcOptions>, + + /// Configures the enabled rules and their severity. + /// + /// See [the rules documentation](https://ty.dev/rules) for a list of all available rules. + /// + /// Valid severities are: + /// + /// * `ignore`: Disable the rule. + /// * `warn`: Enable the rule and create a warning diagnostic. + /// * `error`: Enable the rule and create an error diagnostic. + /// ty will exit with a non-zero code if any error diagnostics are emitted. + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"{...}"#, + value_type = r#"dict[RuleName, "ignore" | "warn" | "error"]"#, + example = r#" + [tool.ty.rules] + possibly-unresolved-reference = "warn" + division-by-zero = "ignore" + "# + )] + pub rules: Option<Rules>, + + #[serde(skip_serializing_if = "Option::is_none")] + #[option_group] + pub terminal: Option<TerminalOptions>, + + /// Whether to automatically exclude files that are ignored by `.ignore`, + /// `.gitignore`, `.git/info/exclude`, and global `gitignore` files. + /// Enabled by default. + #[option( + default = r#"true"#, + value_type = r#"bool"#, + example = r#" + respect-ignore-files = false + "# + )] + #[serde(skip_serializing_if = "Option::is_none")] + pub respect_ignore_files: Option<bool>, +} + +impl Options { + pub fn from_toml_str(content: &str, source: ValueSource) -> Result<Self, TyTomlError> { + let _guard = ValueSourceGuard::new(source, true); + let options = toml::from_str(content)?; + Ok(options) + } + + pub fn deserialize_with<'de, D>(source: ValueSource, deserializer: D) -> Result<Self, D::Error> + where + D: serde::Deserializer<'de>, + { + let _guard = ValueSourceGuard::new(source, false); + Self::deserialize(deserializer) + } + + pub(crate) fn to_program_settings( + &self, + project_root: &SystemPath, + project_name: &str, + system: &dyn System, + ) -> ProgramSettings { + let python_version = self + .environment + .as_ref() + .and_then(|env| env.python_version.as_ref()) + .map(|ranged_version| PythonVersionWithSource { + version: **ranged_version, + source: match ranged_version.source() { + ValueSource::Cli => PythonVersionSource::Cli, + ValueSource::File(path) => { + PythonVersionSource::File(path.clone(), ranged_version.range()) + } + }, + }) + .unwrap_or_default(); + let python_platform = self + .environment + .as_ref() + .and_then(|env| env.python_platform.as_deref().cloned()) + .unwrap_or_else(|| { + let default = PythonPlatform::default(); + tracing::info!("Defaulting to python-platform `{default}`"); + default + }); + ProgramSettings { + python_version, + python_platform, + search_paths: self.to_search_path_settings(project_root, project_name, system), + } + } + + fn to_search_path_settings( + &self, + project_root: &SystemPath, + project_name: &str, + system: &dyn System, + ) -> SearchPathSettings { + let src_roots = if let Some(src_root) = self.src.as_ref().and_then(|src| src.root.as_ref()) + { + vec![src_root.absolute(project_root, system)] + } else { + let src = project_root.join("src"); + + if system.is_directory(&src) { + // Default to `src` and the project root if `src` exists and the root hasn't been specified. + // This corresponds to the `src-layout` + tracing::debug!( + "Including `./src` in `src.root` because a `./src` directory exists" + ); + vec![project_root.to_path_buf(), src] + } else if system.is_directory(&project_root.join(project_name).join(project_name)) { + // `src-layout` but when the folder isn't called `src` but has the same name as the project. + // For example, the "src" folder for `psycopg` is called `psycopg` and the python files are in `psycopg/psycopg/_adapters_map.py` + tracing::debug!( + "Including `./{project_name}` in `src.root` because a `./{project_name}/{project_name}` directory exists" + ); + + vec![project_root.to_path_buf(), project_root.join(project_name)] + } else { + // Default to a [flat project structure](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/). + tracing::debug!("Defaulting `src.root` to `.`"); + vec![project_root.to_path_buf()] + } + }; + + let (extra_paths, python, typeshed) = self + .environment + .as_ref() + .map(|env| { + ( + env.extra_paths.clone(), + env.python.clone(), + env.typeshed.clone(), + ) + }) + .unwrap_or_default(); + + SearchPathSettings { + extra_paths: extra_paths + .unwrap_or_default() + .into_iter() + .map(|path| path.absolute(project_root, system)) + .collect(), + src_roots, + custom_typeshed: typeshed.map(|path| path.absolute(project_root, system)), + python_path: python + .map(|python_path| { + PythonPath::from_cli_flag(python_path.absolute(project_root, system)) + }) + .or_else(|| { + std::env::var("VIRTUAL_ENV") + .ok() + .map(PythonPath::from_virtual_env_var) + }) + .unwrap_or_else(|| PythonPath::Discover(project_root.to_path_buf())), + } + } + + #[must_use] + pub(crate) fn to_settings(&self, db: &dyn Db) -> (Settings, Vec<OptionDiagnostic>) { + let (rules, diagnostics) = self.to_rule_selection(db); + + let mut settings = Settings::new(rules, self.respect_ignore_files); + + if let Some(terminal) = self.terminal.as_ref() { + settings.set_terminal(TerminalSettings { + output_format: terminal + .output_format + .as_deref() + .copied() + .unwrap_or_default(), + error_on_warning: terminal.error_on_warning.unwrap_or_default(), + }); + } + + (settings, diagnostics) + } + + #[must_use] + fn to_rule_selection(&self, db: &dyn Db) -> (RuleSelection, Vec<OptionDiagnostic>) { + let registry = db.lint_registry(); + let mut diagnostics = Vec::new(); + + // Initialize the selection with the defaults + let mut selection = RuleSelection::from_registry(registry); + + let rules = self + .rules + .as_ref() + .into_iter() + .flat_map(|rules| rules.inner.iter()); + + for (rule_name, level) in rules { + let source = rule_name.source(); + match registry.get(rule_name) { + Ok(lint) => { + let lint_source = match source { + ValueSource::File(_) => LintSource::File, + ValueSource::Cli => LintSource::Cli, + }; + if let Ok(severity) = Severity::try_from(**level) { + selection.enable(lint, severity, lint_source); + } else { + selection.disable(lint); + } + } + Err(error) => { + // `system_path_to_file` can return `Err` if the file was deleted since the configuration + // was read. This should be rare and it should be okay to default to not showing a configuration + // file in that case. + let file = source + .file() + .and_then(|path| system_path_to_file(db.upcast(), path).ok()); + + // TODO: Add a note if the value was configured on the CLI + let diagnostic = match error { + GetLintError::Unknown(_) => OptionDiagnostic::new( + DiagnosticId::UnknownRule, + format!("Unknown lint rule `{rule_name}`"), + Severity::Warning, + ), + GetLintError::PrefixedWithCategory { suggestion, .. } => { + OptionDiagnostic::new( + DiagnosticId::UnknownRule, + format!( + "Unknown lint rule `{rule_name}`. Did you mean `{suggestion}`?" + ), + Severity::Warning, + ) + } + + GetLintError::Removed(_) => OptionDiagnostic::new( + DiagnosticId::UnknownRule, + format!("Unknown lint rule `{rule_name}`"), + Severity::Warning, + ), + }; + + let span = file.map(Span::from).map(|span| { + if let Some(range) = rule_name.range() { + span.with_range(range) + } else { + span + } + }); + diagnostics.push(diagnostic.with_span(span)); + } + } + } + + (selection, diagnostics) + } +} + +#[derive( + Debug, Default, Clone, Eq, PartialEq, Combine, Serialize, Deserialize, OptionsMetadata, +)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct EnvironmentOptions { + /// Specifies the version of Python that will be used to analyze the source code. + /// The version should be specified as a string in the format `M.m` where `M` is the major version + /// and `m` is the minor (e.g. `"3.0"` or `"3.6"`). + /// If a version is provided, ty will generate errors if the source code makes use of language features + /// that are not supported in that version. + /// It will also understand conditionals based on comparisons with `sys.version_info`, such + /// as are commonly found in typeshed to reflect the differing contents of the standard + /// library across Python versions. + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#""3.13""#, + value_type = r#""3.7" | "3.8" | "3.9" | "3.10" | "3.11" | "3.12" | "3.13" | <major>.<minor>"#, + example = r#" + python-version = "3.12" + "# + )] + pub python_version: Option<RangedValue<PythonVersion>>, + + /// Specifies the target platform that will be used to analyze the source code. + /// If specified, ty will understand conditions based on comparisons with `sys.platform`, such + /// as are commonly found in typeshed to reflect the differing contents of the standard library across platforms. + /// + /// If no platform is specified, ty will use the current platform: + /// - `win32` for Windows + /// - `darwin` for macOS + /// - `android` for Android + /// - `ios` for iOS + /// - `linux` for everything else + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"<current-platform>"#, + value_type = r#""win32" | "darwin" | "android" | "ios" | "linux" | str"#, + example = r#" + # Tailor type stubs and conditionalized type definitions to windows. + python-platform = "win32" + "# + )] + pub python_platform: Option<RangedValue<PythonPlatform>>, + + /// List of user-provided paths that should take first priority in the module resolution. + /// Examples in other type checkers are mypy's `MYPYPATH` environment variable, + /// or pyright's `stubPath` configuration setting. + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"[]"#, + value_type = "list[str]", + example = r#" + extra-paths = ["~/shared/my-search-path"] + "# + )] + pub extra_paths: Option<Vec<RelativePathBuf>>, + + /// Optional path to a "typeshed" directory on disk for us to use for standard-library types. + /// If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib, + /// bundled as a zip file in the binary + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"null"#, + value_type = "str", + example = r#" + typeshed = "/path/to/custom/typeshed" + "# + )] + pub typeshed: Option<RelativePathBuf>, + + /// Path to the Python installation from which ty resolves type information and third-party dependencies. + /// + /// ty will search in the path's `site-packages` directories for type information and + /// third-party imports. + /// + /// This option is commonly used to specify the path to a virtual environment. + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"null"#, + value_type = "str", + example = r#" + python = "./.venv" + "# + )] + pub python: Option<RelativePathBuf>, +} + +#[derive( + Debug, Default, Clone, Eq, PartialEq, Combine, Serialize, Deserialize, OptionsMetadata, +)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct SrcOptions { + /// The root of the project, used for finding first-party modules. + /// + /// If left unspecified, ty will try to detect common project layouts and initialize `src.root` accordingly: + /// + /// * if a `./src` directory exists, include `.` and `./src` in the first party search path (src layout or flat) + /// * if a `./<project-name>/<project-name>` directory exists, include `.` and `./<project-name>` in the first party search path + /// * otherwise, default to `.` (flat layout) + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"null"#, + value_type = "str", + example = r#" + root = "./app" + "# + )] + pub root: Option<RelativePathBuf>, +} + +#[derive(Debug, Default, Clone, Eq, PartialEq, Combine, Serialize, Deserialize)] +#[serde(rename_all = "kebab-case", transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct Rules { + #[cfg_attr(feature = "schemars", schemars(with = "schema::Rules"))] + inner: FxHashMap<RangedValue<String>, RangedValue<Level>>, +} + +impl FromIterator<(RangedValue<String>, RangedValue<Level>)> for Rules { + fn from_iter<T: IntoIterator<Item = (RangedValue<String>, RangedValue<Level>)>>( + iter: T, + ) -> Self { + Self { + inner: iter.into_iter().collect(), + } + } +} + +#[derive( + Debug, Default, Clone, Eq, PartialEq, Combine, Serialize, Deserialize, OptionsMetadata, +)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct TerminalOptions { + /// The format to use for printing diagnostic messages. + /// + /// Defaults to `full`. + #[serde(skip_serializing_if = "Option::is_none")] + #[option( + default = r#"full"#, + value_type = "full | concise", + example = r#" + output-format = "concise" + "# + )] + pub output_format: Option<RangedValue<DiagnosticFormat>>, + /// Use exit code 1 if there are any warning-level diagnostics. + /// + /// Defaults to `false`. + #[option( + default = r#"false"#, + value_type = "bool", + example = r#" + # Error if ty emits any warning-level diagnostics. + error-on-warning = true + "# + )] + pub error_on_warning: Option<bool>, +} + +#[cfg(feature = "schemars")] +mod schema { + use crate::DEFAULT_LINT_REGISTRY; + use schemars::JsonSchema; + use schemars::r#gen::SchemaGenerator; + use schemars::schema::{ + InstanceType, Metadata, ObjectValidation, Schema, SchemaObject, SubschemaValidation, + }; + use ty_python_semantic::lint::Level; + + pub(super) struct Rules; + + impl JsonSchema for Rules { + fn schema_name() -> String { + "Rules".to_string() + } + + fn json_schema(generator: &mut SchemaGenerator) -> Schema { + let registry = &*DEFAULT_LINT_REGISTRY; + + let level_schema = generator.subschema_for::<Level>(); + + let properties: schemars::Map<String, Schema> = registry + .lints() + .iter() + .map(|lint| { + ( + lint.name().to_string(), + Schema::Object(SchemaObject { + metadata: Some(Box::new(Metadata { + title: Some(lint.summary().to_string()), + description: Some(lint.documentation()), + deprecated: lint.status.is_deprecated(), + default: Some(lint.default_level.to_string().into()), + ..Metadata::default() + })), + subschemas: Some(Box::new(SubschemaValidation { + one_of: Some(vec![level_schema.clone()]), + ..Default::default() + })), + ..Default::default() + }), + ) + }) + .collect(); + + Schema::Object(SchemaObject { + instance_type: Some(InstanceType::Object.into()), + object: Some(Box::new(ObjectValidation { + properties, + // Allow unknown rules: ty will warn about them. + // It gives a better experience when using an older ty version because + // the schema will not deny rules that have been removed in newer versions. + additional_properties: Some(Box::new(level_schema)), + ..ObjectValidation::default() + })), + + ..Default::default() + }) + } + } +} + +#[derive(Error, Debug)] +pub enum TyTomlError { + #[error(transparent)] + TomlSyntax(#[from] toml::de::Error), +} + +#[derive(Debug, PartialEq, Eq, Clone)] +pub struct OptionDiagnostic { + id: DiagnosticId, + message: String, + severity: Severity, + span: Option<Span>, +} + +impl OptionDiagnostic { + pub fn new(id: DiagnosticId, message: String, severity: Severity) -> Self { + Self { + id, + message, + severity, + span: None, + } + } + + #[must_use] + fn with_span(self, span: Option<Span>) -> Self { + OptionDiagnostic { span, ..self } + } + + pub(crate) fn to_diagnostic(&self) -> Diagnostic { + if let Some(ref span) = self.span { + let mut diag = Diagnostic::new(self.id, self.severity, ""); + diag.annotate(Annotation::primary(span.clone()).message(&self.message)); + diag + } else { + Diagnostic::new(self.id, self.severity, &self.message) + } + } +} diff --git a/crates/ty_project/src/metadata/pyproject.rs b/crates/ty_project/src/metadata/pyproject.rs new file mode 100644 index 0000000000000..21dd5f02380d4 --- /dev/null +++ b/crates/ty_project/src/metadata/pyproject.rs @@ -0,0 +1,270 @@ +use crate::metadata::options::Options; +use crate::metadata::value::{RangedValue, ValueSource, ValueSourceGuard}; +use pep440_rs::{Version, VersionSpecifiers, release_specifiers_to_ranges}; +use ruff_python_ast::PythonVersion; +use serde::{Deserialize, Deserializer, Serialize}; +use std::collections::Bound; +use std::ops::Deref; +use thiserror::Error; + +/// A `pyproject.toml` as specified in PEP 517. +#[derive(Deserialize, Serialize, Debug, Default, Clone)] +#[serde(rename_all = "kebab-case")] +pub struct PyProject { + /// PEP 621-compliant project metadata. + pub project: Option<Project>, + /// Tool-specific metadata. + pub tool: Option<Tool>, +} + +impl PyProject { + pub(crate) fn ty(&self) -> Option<&Options> { + self.tool.as_ref().and_then(|tool| tool.ty.as_ref()) + } +} + +#[derive(Error, Debug)] +pub enum PyProjectError { + #[error(transparent)] + TomlSyntax(#[from] toml::de::Error), +} + +impl PyProject { + pub(crate) fn from_toml_str( + content: &str, + source: ValueSource, + ) -> Result<Self, PyProjectError> { + let _guard = ValueSourceGuard::new(source, true); + toml::from_str(content).map_err(PyProjectError::TomlSyntax) + } +} + +/// PEP 621 project metadata (`project`). +/// +/// See <https://packaging.python.org/en/latest/specifications/pyproject-toml>. +#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)] +#[serde(rename_all = "kebab-case")] +pub struct Project { + /// The name of the project + /// + /// Note: Intentionally option to be more permissive during deserialization. + /// `PackageMetadata::from_pyproject` reports missing names. + pub name: Option<RangedValue<PackageName>>, + /// The version of the project + pub version: Option<RangedValue<Version>>, + /// The Python versions this project is compatible with. + pub requires_python: Option<RangedValue<VersionSpecifiers>>, +} + +impl Project { + pub(super) fn resolve_requires_python_lower_bound( + &self, + ) -> Result<Option<RangedValue<PythonVersion>>, ResolveRequiresPythonError> { + let Some(requires_python) = self.requires_python.as_ref() else { + return Ok(None); + }; + + tracing::debug!("Resolving requires-python constraint: `{requires_python}`"); + + let ranges = release_specifiers_to_ranges((**requires_python).clone()); + let Some((lower, _)) = ranges.bounding_range() else { + return Ok(None); + }; + + let version = match lower { + // Ex) `>=3.10.1` -> `>=3.10` + Bound::Included(version) => version, + + // Ex) `>3.10.1` -> `>=3.10` or `>3.10` -> `>=3.10` + // The second example looks obscure at first but it is required because + // `3.10.1 > 3.10` is true but we only have two digits here. So including 3.10 is the + // right move. Overall, using `>` without a patch release is most likely bogus. + Bound::Excluded(version) => version, + + // Ex) `<3.10` or `` + Bound::Unbounded => { + return Err(ResolveRequiresPythonError::NoLowerBound( + requires_python.to_string(), + )); + } + }; + + // Take the major and minor version + let mut versions = version.release().iter().take(2); + + let Some(major) = versions.next().copied() else { + return Ok(None); + }; + + let minor = versions.next().copied().unwrap_or_default(); + + tracing::debug!("Resolved requires-python constraint to: {major}.{minor}"); + + let major = + u8::try_from(major).map_err(|_| ResolveRequiresPythonError::TooLargeMajor(major))?; + let minor = + u8::try_from(minor).map_err(|_| ResolveRequiresPythonError::TooLargeMinor(minor))?; + + Ok(Some( + requires_python + .clone() + .map_value(|_| PythonVersion::from((major, minor))), + )) + } +} + +#[derive(Debug, Error)] +pub enum ResolveRequiresPythonError { + #[error("The major version `{0}` is larger than the maximum supported value 255")] + TooLargeMajor(u64), + #[error("The minor version `{0}` is larger than the maximum supported value 255")] + TooLargeMinor(u64), + #[error( + "value `{0}` does not contain a lower bound. Add a lower bound to indicate the minimum compatible Python version (e.g., `>=3.13`) or specify a version in `environment.python-version`." + )] + NoLowerBound(String), +} + +#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Eq)] +#[serde(rename_all = "kebab-case")] +pub struct Tool { + pub ty: Option<Options>, +} + +/// The normalized name of a package. +/// +/// Converts the name to lowercase and collapses runs of `-`, `_`, and `.` down to a single `-`. +/// For example, `---`, `.`, and `__` are all converted to a single `-`. +/// +/// See: <https://packaging.python.org/en/latest/specifications/name-normalization/> +#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)] +pub struct PackageName(String); + +impl PackageName { + /// Create a validated, normalized package name. + pub(crate) fn new(name: String) -> Result<Self, InvalidPackageNameError> { + if name.is_empty() { + return Err(InvalidPackageNameError::Empty); + } + + if name.starts_with(['-', '_', '.']) { + return Err(InvalidPackageNameError::NonAlphanumericStart( + name.chars().next().unwrap(), + )); + } + + if name.ends_with(['-', '_', '.']) { + return Err(InvalidPackageNameError::NonAlphanumericEnd( + name.chars().last().unwrap(), + )); + } + + let Some(start) = name.find(|c: char| { + !c.is_ascii() || c.is_ascii_uppercase() || matches!(c, '-' | '_' | '.') + }) else { + return Ok(Self(name)); + }; + + let (already_normalized, maybe_normalized) = name.split_at(start); + + let mut normalized = String::with_capacity(name.len()); + normalized.push_str(already_normalized); + let mut last = None; + + for c in maybe_normalized.chars() { + if !c.is_ascii() { + return Err(InvalidPackageNameError::InvalidCharacter(c)); + } + + if c.is_ascii_uppercase() { + normalized.push(c.to_ascii_lowercase()); + } else if matches!(c, '-' | '_' | '.') { + if matches!(last, Some('-' | '_' | '.')) { + // Only keep a single instance of `-`, `_` and `.` + } else { + normalized.push('-'); + } + } else { + normalized.push(c); + } + + last = Some(c); + } + + Ok(Self(normalized)) + } + + /// Returns the underlying package name. + pub(crate) fn as_str(&self) -> &str { + &self.0 + } +} + +impl From<PackageName> for String { + fn from(value: PackageName) -> Self { + value.0 + } +} + +impl<'de> Deserialize<'de> for PackageName { + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + Self::new(s).map_err(serde::de::Error::custom) + } +} + +impl std::fmt::Display for PackageName { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.0.fmt(f) + } +} + +impl Deref for PackageName { + type Target = str; + fn deref(&self) -> &Self::Target { + self.as_str() + } +} + +#[derive(Error, Debug)] +pub(crate) enum InvalidPackageNameError { + #[error("name must start with letter or number but it starts with '{0}'")] + NonAlphanumericStart(char), + #[error("name must end with letter or number but it ends with '{0}'")] + NonAlphanumericEnd(char), + #[error( + "valid name consists only of ASCII letters and numbers, period, underscore and hyphen but name contains '{0}'" + )] + InvalidCharacter(char), + #[error("name must not be empty")] + Empty, +} + +#[cfg(test)] +mod tests { + use super::PackageName; + + #[test] + fn normalize() { + let inputs = [ + "friendly-bard", + "Friendly-Bard", + "FRIENDLY-BARD", + "friendly.bard", + "friendly_bard", + "friendly--bard", + "friendly-.bard", + "FrIeNdLy-._.-bArD", + ]; + + for input in inputs { + assert_eq!( + PackageName::new(input.to_string()).unwrap(), + PackageName::new("friendly-bard".to_string()).unwrap(), + ); + } + } +} diff --git a/crates/ty_project/src/metadata/settings.rs b/crates/ty_project/src/metadata/settings.rs new file mode 100644 index 0000000000000..b635c5470de8d --- /dev/null +++ b/crates/ty_project/src/metadata/settings.rs @@ -0,0 +1,62 @@ +use std::sync::Arc; + +use ruff_db::diagnostic::DiagnosticFormat; +use ty_python_semantic::lint::RuleSelection; + +/// The resolved [`super::Options`] for the project. +/// +/// Unlike [`super::Options`], the struct has default values filled in and +/// uses representations that are optimized for reads (instead of preserving the source representation). +/// It's also not required that this structure precisely resembles the TOML schema, although +/// it's encouraged to use a similar structure. +/// +/// It's worth considering to adding a salsa query for specific settings to +/// limit the blast radius when only some settings change. For example, +/// changing the terminal settings shouldn't invalidate any core type-checking queries. +/// This can be achieved by adding a salsa query for the type checking specific settings. +/// +/// Settings that are part of [`ty_python_semantic::ProgramSettings`] are not included here. +#[derive(Clone, Debug, Eq, PartialEq)] +pub struct Settings { + rules: Arc<RuleSelection>, + + terminal: TerminalSettings, + + respect_ignore_files: bool, +} + +impl Settings { + pub fn new(rules: RuleSelection, respect_ignore_files: Option<bool>) -> Self { + Self { + rules: Arc::new(rules), + terminal: TerminalSettings::default(), + respect_ignore_files: respect_ignore_files.unwrap_or(true), + } + } + + pub fn rules(&self) -> &RuleSelection { + &self.rules + } + + pub fn respect_ignore_files(&self) -> bool { + self.respect_ignore_files + } + + pub fn to_rules(&self) -> Arc<RuleSelection> { + self.rules.clone() + } + + pub fn terminal(&self) -> &TerminalSettings { + &self.terminal + } + + pub fn set_terminal(&mut self, terminal: TerminalSettings) { + self.terminal = terminal; + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Default)] +pub struct TerminalSettings { + pub output_format: DiagnosticFormat, + pub error_on_warning: bool, +} diff --git a/crates/ty_project/src/metadata/value.rs b/crates/ty_project/src/metadata/value.rs new file mode 100644 index 0000000000000..b73c59a3e7e63 --- /dev/null +++ b/crates/ty_project/src/metadata/value.rs @@ -0,0 +1,346 @@ +use crate::Db; +use crate::combine::Combine; +use ruff_db::system::{System, SystemPath, SystemPathBuf}; +use ruff_macros::Combine; +use ruff_text_size::{TextRange, TextSize}; +use serde::{Deserialize, Deserializer}; +use std::cell::RefCell; +use std::cmp::Ordering; +use std::fmt; +use std::hash::{Hash, Hasher}; +use std::ops::{Deref, DerefMut}; +use std::sync::Arc; +use toml::Spanned; + +#[derive(Clone, Debug)] +pub enum ValueSource { + /// Value loaded from a project's configuration file. + /// + /// Ideally, we'd use [`ruff_db::files::File`] but we can't because the database hasn't been + /// created when loading the configuration. + File(Arc<SystemPathBuf>), + + /// The value comes from a CLI argument, while it's left open if specified using a short argument, + /// long argument (`--extra-paths`) or `--config key=value`. + Cli, +} + +impl ValueSource { + pub fn file(&self) -> Option<&SystemPath> { + match self { + ValueSource::File(path) => Some(&**path), + ValueSource::Cli => None, + } + } +} + +thread_local! { + /// Serde doesn't provide any easy means to pass a value to a [`Deserialize`] implementation, + /// but we want to associate each deserialized [`RelativePath`] with the source from + /// which it originated. We use a thread local variable to work around this limitation. + /// + /// Use the [`ValueSourceGuard`] to initialize the thread local before calling into any + /// deserialization code. It ensures that the thread local variable gets cleaned up + /// once deserialization is done (once the guard gets dropped). + static VALUE_SOURCE: RefCell<Option<(ValueSource, bool)>> = const { RefCell::new(None) }; +} + +/// Guard to safely change the [`VALUE_SOURCE`] for the current thread. +#[must_use] +pub(super) struct ValueSourceGuard { + prev_value: Option<(ValueSource, bool)>, +} + +impl ValueSourceGuard { + pub(super) fn new(source: ValueSource, is_toml: bool) -> Self { + let prev = VALUE_SOURCE.replace(Some((source, is_toml))); + Self { prev_value: prev } + } +} + +impl Drop for ValueSourceGuard { + fn drop(&mut self) { + VALUE_SOURCE.set(self.prev_value.take()); + } +} + +/// A value that "remembers" where it comes from (source) and its range in source. +/// +/// ## Equality, Hash, and Ordering +/// The equality, hash, and ordering are solely based on the value. They disregard the value's range +/// or source. +/// +/// This ensures that two resolved configurations are identical even if the position of a value has changed +/// or if the values were loaded from different sources. +#[derive(Clone, serde::Serialize)] +#[serde(transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct RangedValue<T> { + value: T, + #[serde(skip)] + source: ValueSource, + + /// The byte range of `value` in `source`. + /// + /// Can be `None` because not all sources support a range. + /// For example, arguments provided on the CLI won't have a range attached. + #[serde(skip)] + range: Option<TextRange>, +} + +impl<T> RangedValue<T> { + pub fn new(value: T, source: ValueSource) -> Self { + Self::with_range(value, source, TextRange::default()) + } + + pub fn cli(value: T) -> Self { + Self::with_range(value, ValueSource::Cli, TextRange::default()) + } + + pub fn with_range(value: T, source: ValueSource, range: TextRange) -> Self { + Self { + value, + range: Some(range), + source, + } + } + + pub fn range(&self) -> Option<TextRange> { + self.range + } + + pub fn source(&self) -> &ValueSource { + &self.source + } + + #[must_use] + pub fn with_source(mut self, source: ValueSource) -> Self { + self.source = source; + self + } + + #[must_use] + pub fn map_value<R>(self, f: impl FnOnce(T) -> R) -> RangedValue<R> { + RangedValue { + value: f(self.value), + source: self.source, + range: self.range, + } + } + + pub fn into_inner(self) -> T { + self.value + } +} + +impl<T> Combine for RangedValue<T> { + fn combine(self, _other: Self) -> Self + where + Self: Sized, + { + self + } + fn combine_with(&mut self, _other: Self) {} +} + +impl<T> IntoIterator for RangedValue<T> +where + T: IntoIterator, +{ + type Item = T::Item; + type IntoIter = T::IntoIter; + fn into_iter(self) -> Self::IntoIter { + self.value.into_iter() + } +} + +// The type already has an `iter` method thanks to `Deref`. +#[expect(clippy::into_iter_without_iter)] +impl<'a, T> IntoIterator for &'a RangedValue<T> +where + &'a T: IntoIterator, +{ + type Item = <&'a T as IntoIterator>::Item; + type IntoIter = <&'a T as IntoIterator>::IntoIter; + fn into_iter(self) -> Self::IntoIter { + self.value.into_iter() + } +} + +// The type already has a `into_iter_mut` method thanks to `DerefMut`. +#[expect(clippy::into_iter_without_iter)] +impl<'a, T> IntoIterator for &'a mut RangedValue<T> +where + &'a mut T: IntoIterator, +{ + type Item = <&'a mut T as IntoIterator>::Item; + type IntoIter = <&'a mut T as IntoIterator>::IntoIter; + fn into_iter(self) -> Self::IntoIter { + self.value.into_iter() + } +} + +impl<T> fmt::Debug for RangedValue<T> +where + T: fmt::Debug, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.value.fmt(f) + } +} + +impl<T> fmt::Display for RangedValue<T> +where + T: fmt::Display, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.value.fmt(f) + } +} + +impl<T> Deref for RangedValue<T> { + type Target = T; + fn deref(&self) -> &Self::Target { + &self.value + } +} + +impl<T> DerefMut for RangedValue<T> { + fn deref_mut(&mut self) -> &mut T { + &mut self.value + } +} + +impl<T, U: ?Sized> AsRef<U> for RangedValue<T> +where + T: AsRef<U>, +{ + fn as_ref(&self) -> &U { + self.value.as_ref() + } +} + +impl<T: PartialEq> PartialEq for RangedValue<T> { + fn eq(&self, other: &Self) -> bool { + self.value.eq(&other.value) + } +} + +impl<T: PartialEq<T>> PartialEq<T> for RangedValue<T> { + fn eq(&self, other: &T) -> bool { + self.value.eq(other) + } +} + +impl<T: Eq> Eq for RangedValue<T> {} + +impl<T: Hash> Hash for RangedValue<T> { + fn hash<H: Hasher>(&self, state: &mut H) { + self.value.hash(state); + } +} + +impl<T: PartialOrd> PartialOrd for RangedValue<T> { + fn partial_cmp(&self, other: &Self) -> Option<Ordering> { + self.value.partial_cmp(&other.value) + } +} + +impl<T: PartialOrd<T>> PartialOrd<T> for RangedValue<T> { + fn partial_cmp(&self, other: &T) -> Option<Ordering> { + self.value.partial_cmp(other) + } +} + +impl<T: Ord> Ord for RangedValue<T> { + fn cmp(&self, other: &Self) -> Ordering { + self.value.cmp(&other.value) + } +} + +impl<'de, T> Deserialize<'de> for RangedValue<T> +where + T: Deserialize<'de>, +{ + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> + where + D: Deserializer<'de>, + { + VALUE_SOURCE.with_borrow(|source| { + let (source, has_span) = source.clone().unwrap(); + + if has_span { + let spanned: Spanned<T> = Spanned::deserialize(deserializer)?; + let span = spanned.span(); + let range = TextRange::new( + TextSize::try_from(span.start) + .expect("Configuration file to be smaller than 4GB"), + TextSize::try_from(span.end) + .expect("Configuration file to be smaller than 4GB"), + ); + + Ok(Self::with_range(spanned.into_inner(), source, range)) + } else { + Ok(Self::new(T::deserialize(deserializer)?, source)) + } + }) + } +} + +/// A possibly relative path in a configuration file. +/// +/// Relative paths in configuration files or from CLI options +/// require different anchoring: +/// +/// * CLI: The path is relative to the current working directory +/// * Configuration file: The path is relative to the project's root. +#[derive( + Debug, + Clone, + serde::Serialize, + serde::Deserialize, + PartialEq, + Eq, + PartialOrd, + Ord, + Hash, + Combine, +)] +#[serde(transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct RelativePathBuf(RangedValue<SystemPathBuf>); + +impl RelativePathBuf { + pub fn new(path: impl AsRef<SystemPath>, source: ValueSource) -> Self { + Self(RangedValue::new(path.as_ref().to_path_buf(), source)) + } + + pub fn cli(path: impl AsRef<SystemPath>) -> Self { + Self::new(path, ValueSource::Cli) + } + + /// Returns the relative path as specified by the user. + pub fn path(&self) -> &SystemPath { + &self.0 + } + + /// Returns the owned relative path. + pub fn into_path_buf(self) -> SystemPathBuf { + self.0.into_inner() + } + + /// Resolves the absolute path for `self` based on its origin. + pub fn absolute_with_db(&self, db: &dyn Db) -> SystemPathBuf { + self.absolute(db.project().root(db), db.system()) + } + + /// Resolves the absolute path for `self` based on its origin. + pub fn absolute(&self, project_root: &SystemPath, system: &dyn System) -> SystemPathBuf { + let relative_to = match &self.0.source { + ValueSource::File(_) => project_root, + ValueSource::Cli => system.current_directory(), + }; + + SystemPath::absolute(&self.0, relative_to) + } +} diff --git a/crates/ty_project/src/walk.rs b/crates/ty_project/src/walk.rs new file mode 100644 index 0000000000000..e6d7f7fdc33c3 --- /dev/null +++ b/crates/ty_project/src/walk.rs @@ -0,0 +1,260 @@ +use crate::{Db, IOErrorDiagnostic, IOErrorKind, Project}; +use ruff_db::files::{File, system_path_to_file}; +use ruff_db::system::walk_directory::{ErrorKind, WalkDirectoryBuilder, WalkState}; +use ruff_db::system::{FileType, SystemPath, SystemPathBuf}; +use ruff_python_ast::PySourceType; +use rustc_hash::{FxBuildHasher, FxHashSet}; +use std::path::PathBuf; +use thiserror::Error; + +/// Filter that decides which files are included in the project. +/// +/// In the future, this will hold a reference to the `include` and `exclude` pattern. +/// +/// This struct mainly exists because `dyn Db` isn't `Send` or `Sync`, making it impossible +/// to access fields from within the walker. +#[derive(Default, Debug)] +pub(crate) struct ProjectFilesFilter<'a> { + /// The same as [`Project::included_paths_or_root`]. + included_paths: &'a [SystemPathBuf], + + /// The filter skips checking if the path is in `included_paths` if set to `true`. + /// + /// Skipping this check is useful when the walker only walks over `included_paths`. + skip_included_paths: bool, +} + +impl<'a> ProjectFilesFilter<'a> { + pub(crate) fn from_project(db: &'a dyn Db, project: Project) -> Self { + Self { + included_paths: project.included_paths_or_root(db), + skip_included_paths: false, + } + } + + /// Returns `true` if a file is part of the project and included in the paths to check. + /// + /// A file is included in the checked files if it is a sub path of the project's root + /// (when no CLI path arguments are specified) or if it is a sub path of any path provided on the CLI (`ty check <paths>`) AND: + /// + /// * It matches a positive `include` pattern and isn't excluded by a later negative `include` pattern. + /// * It doesn't match a positive `exclude` pattern or is re-included by a later negative `exclude` pattern. + /// + /// ## Note + /// + /// This method may return `true` for files that don't end up being included when walking the + /// project tree because it doesn't consider `.gitignore` and other ignore files when deciding + /// if a file's included. + pub(crate) fn is_included(&self, path: &SystemPath) -> bool { + #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] + enum CheckPathMatch { + /// The path is a partial match of the checked path (it's a sub path) + Partial, + + /// The path matches a check path exactly. + Full, + } + + let m = if self.skip_included_paths { + Some(CheckPathMatch::Partial) + } else { + self.included_paths + .iter() + .filter_map(|included_path| { + if let Ok(relative_path) = path.strip_prefix(included_path) { + // Exact matches are always included + if relative_path.as_str().is_empty() { + Some(CheckPathMatch::Full) + } else { + Some(CheckPathMatch::Partial) + } + } else { + None + } + }) + .max() + }; + + match m { + None => false, + Some(CheckPathMatch::Partial) => { + // TODO: For partial matches, only include the file if it is included by the project's include/exclude settings. + true + } + Some(CheckPathMatch::Full) => true, + } + } +} + +pub(crate) struct ProjectFilesWalker<'a> { + walker: WalkDirectoryBuilder, + + filter: ProjectFilesFilter<'a>, +} + +impl<'a> ProjectFilesWalker<'a> { + pub(crate) fn new(db: &'a dyn Db) -> Self { + let project = db.project(); + + let mut filter = ProjectFilesFilter::from_project(db, project); + // It's unnecessary to filter on included paths because it only iterates over those to start with. + filter.skip_included_paths = true; + + Self::from_paths(db, project.included_paths_or_root(db), filter) + .expect("included_paths_or_root to never return an empty iterator") + } + + /// Creates a walker for indexing the project files incrementally. + /// + /// The main difference to a full project walk is that `paths` may contain paths + /// that aren't part of the included files. + pub(crate) fn incremental<P>(db: &'a dyn Db, paths: impl IntoIterator<Item = P>) -> Option<Self> + where + P: AsRef<SystemPath>, + { + let project = db.project(); + + let filter = ProjectFilesFilter::from_project(db, project); + + Self::from_paths(db, paths, filter) + } + + fn from_paths<P>( + db: &'a dyn Db, + paths: impl IntoIterator<Item = P>, + filter: ProjectFilesFilter<'a>, + ) -> Option<Self> + where + P: AsRef<SystemPath>, + { + let mut paths = paths.into_iter(); + + let mut walker = db + .system() + .walk_directory(paths.next()?.as_ref()) + .standard_filters(db.project().settings(db).respect_ignore_files()) + .ignore_hidden(false); + + for path in paths { + walker = walker.add(path); + } + + Some(Self { walker, filter }) + } + + /// Walks the project paths and collects the paths of all files that + /// are included in the project. + pub(crate) fn walk_paths(self) -> (Vec<SystemPathBuf>, Vec<IOErrorDiagnostic>) { + let paths = std::sync::Mutex::new(Vec::new()); + let diagnostics = std::sync::Mutex::new(Vec::new()); + + self.walker.run(|| { + Box::new(|entry| { + match entry { + Ok(entry) => { + if !self.filter.is_included(entry.path()) { + tracing::debug!("Ignoring not-included path: {}", entry.path()); + return WalkState::Skip; + } + + // Skip over any non python files to avoid creating too many entries in `Files`. + match entry.file_type() { + FileType::File => { + if entry + .path() + .extension() + .and_then(PySourceType::try_from_extension) + .is_some() + { + let mut paths = paths.lock().unwrap(); + paths.push(entry.into_path()); + } + } + FileType::Directory | FileType::Symlink => {} + } + } + Err(error) => match error.kind() { + ErrorKind::Loop { .. } => { + unreachable!("Loops shouldn't be possible without following symlinks.") + } + ErrorKind::Io { path, err } => { + let mut diagnostics = diagnostics.lock().unwrap(); + let error = if let Some(path) = path { + WalkError::IOPathError { + path: path.clone(), + error: err.to_string(), + } + } else { + WalkError::IOError { + error: err.to_string(), + } + }; + + diagnostics.push(IOErrorDiagnostic { + file: None, + error: IOErrorKind::Walk(error), + }); + } + ErrorKind::NonUtf8Path { path } => { + diagnostics.lock().unwrap().push(IOErrorDiagnostic { + file: None, + error: IOErrorKind::Walk(WalkError::NonUtf8Path { + path: path.clone(), + }), + }); + } + }, + } + + WalkState::Continue + }) + }); + + ( + paths.into_inner().unwrap(), + diagnostics.into_inner().unwrap(), + ) + } + + pub(crate) fn collect_vec(self, db: &dyn Db) -> (Vec<File>, Vec<IOErrorDiagnostic>) { + let (paths, diagnostics) = self.walk_paths(); + + ( + paths + .into_iter() + .filter_map(move |path| { + // If this returns `None`, then the file was deleted between the `walk_directory` call and now. + // We can ignore this. + system_path_to_file(db.upcast(), &path).ok() + }) + .collect(), + diagnostics, + ) + } + + pub(crate) fn collect_set(self, db: &dyn Db) -> (FxHashSet<File>, Vec<IOErrorDiagnostic>) { + let (paths, diagnostics) = self.walk_paths(); + + let mut files = FxHashSet::with_capacity_and_hasher(paths.len(), FxBuildHasher); + + for path in paths { + if let Ok(file) = system_path_to_file(db.upcast(), &path) { + files.insert(file); + } + } + + (files, diagnostics) + } +} + +#[derive(Error, Debug, Clone)] +pub(crate) enum WalkError { + #[error("`{path}`: {error}")] + IOPathError { path: SystemPathBuf, error: String }, + + #[error("Failed to walk project directory: {error}")] + IOError { error: String }, + + #[error("`{path}` is not a valid UTF-8 path")] + NonUtf8Path { path: PathBuf }, +} diff --git a/crates/red_knot_workspace/src/watch.rs b/crates/ty_project/src/watch.rs similarity index 86% rename from crates/red_knot_workspace/src/watch.rs rename to crates/ty_project/src/watch.rs index a0d120882206b..9a7c62837c5c0 100644 --- a/crates/red_knot_workspace/src/watch.rs +++ b/crates/ty_project/src/watch.rs @@ -1,9 +1,9 @@ +pub use project_watcher::ProjectWatcher; use ruff_db::system::{SystemPath, SystemPathBuf, SystemVirtualPathBuf}; -pub use watcher::{directory_watcher, EventHandler, Watcher}; -pub use workspace_watcher::WorkspaceWatcher; +pub use watcher::{EventHandler, Watcher, directory_watcher}; +mod project_watcher; mod watcher; -mod workspace_watcher; /// Classification of a file system change event. /// @@ -81,6 +81,22 @@ impl ChangeEvent { _ => None, } } + + pub const fn is_rescan(&self) -> bool { + matches!(self, ChangeEvent::Rescan) + } + + pub const fn is_created(&self) -> bool { + matches!(self, ChangeEvent::Created { .. }) + } + + pub const fn is_changed(&self) -> bool { + matches!(self, ChangeEvent::Changed { .. }) + } + + pub const fn is_deleted(&self) -> bool { + matches!(self, ChangeEvent::Deleted { .. }) + } } /// Classification of an event that creates a new path. diff --git a/crates/ty_project/src/watch/project_watcher.rs b/crates/ty_project/src/watch/project_watcher.rs new file mode 100644 index 0000000000000..56b4f4faac921 --- /dev/null +++ b/crates/ty_project/src/watch/project_watcher.rs @@ -0,0 +1,168 @@ +use std::fmt::{Formatter, Write}; +use std::hash::Hasher; + +use tracing::info; + +use ruff_cache::{CacheKey, CacheKeyHasher}; +use ruff_db::Upcast; +use ruff_db::system::{SystemPath, SystemPathBuf}; +use ty_python_semantic::system_module_search_paths; + +use crate::db::{Db, ProjectDatabase}; +use crate::watch::Watcher; + +/// Wrapper around a [`Watcher`] that watches the relevant paths of a project. +pub struct ProjectWatcher { + watcher: Watcher, + + /// The paths that need to be watched. This includes paths for which setting up file watching failed. + watched_paths: Vec<SystemPathBuf>, + + /// True if registering a watcher for any path failed. + has_errored_paths: bool, + + /// Cache key over the paths that need watching. It allows short-circuiting if the paths haven't changed. + cache_key: Option<u64>, +} + +impl ProjectWatcher { + /// Create a new project watcher. + pub fn new(watcher: Watcher, db: &ProjectDatabase) -> Self { + let mut watcher = Self { + watcher, + watched_paths: Vec::new(), + cache_key: None, + has_errored_paths: false, + }; + + watcher.update(db); + + watcher + } + + pub fn update(&mut self, db: &ProjectDatabase) { + let search_paths: Vec<_> = system_module_search_paths(db.upcast()).collect(); + let project_path = db.project().root(db); + + let new_cache_key = Self::compute_cache_key(project_path, &search_paths); + + if self.cache_key == Some(new_cache_key) { + return; + } + + // Unregister all watch paths because ordering is important for linux because + // it only emits an event for the last added watcher if a subtree is covered by multiple watchers. + // A path can be covered by multiple watchers if a subdirectory symlinks to a path that's covered by another watch path: + // ```text + // - bar + // - baz.py + // - project + // - bar -> /bar + // - foo.py + // ``` + for path in self.watched_paths.drain(..) { + if let Err(error) = self.watcher.unwatch(&path) { + info!("Failed to remove the file watcher for path `{path}`: {error}"); + } + } + + self.has_errored_paths = false; + + let config_paths = db + .project() + .metadata(db) + .extra_configuration_paths() + .iter() + .map(SystemPathBuf::as_path); + + // Watch both the project root and any paths provided by the user on the CLI (removing any redundant nested paths). + // This is necessary to observe changes to files that are outside the project root. + // We always need to watch the project root to observe changes to its configuration. + let included_paths = ruff_db::system::deduplicate_nested_paths( + std::iter::once(project_path).chain( + db.project() + .included_paths_list(db) + .iter() + .map(SystemPathBuf::as_path), + ), + ); + + // Find the non-overlapping module search paths and filter out paths that are already covered by the project. + // Module search paths are already canonicalized. + let unique_module_paths = ruff_db::system::deduplicate_nested_paths( + search_paths + .into_iter() + .filter(|path| !path.starts_with(project_path)), + ); + + // Now add the new paths, first starting with the project path and then + // adding the library search paths, and finally the paths for configurations. + for path in included_paths + .chain(unique_module_paths) + .chain(config_paths) + { + // Log a warning. It's not worth aborting if registering a single folder fails because + // Ruff otherwise stills works as expected. + if let Err(error) = self.watcher.watch(path) { + // TODO: Log a user-facing warning. + tracing::warn!( + "Failed to setup watcher for path `{path}`: {error}. You have to restart Ruff after making changes to files under this path or you might see stale results." + ); + self.has_errored_paths = true; + } else { + self.watched_paths.push(path.to_path_buf()); + } + } + + info!( + "Set up file watchers for {}", + DisplayWatchedPaths { + paths: &self.watched_paths + } + ); + + self.cache_key = Some(new_cache_key); + } + + fn compute_cache_key(project_root: &SystemPath, search_paths: &[&SystemPath]) -> u64 { + let mut cache_key_hasher = CacheKeyHasher::new(); + search_paths.cache_key(&mut cache_key_hasher); + project_root.cache_key(&mut cache_key_hasher); + + cache_key_hasher.finish() + } + + /// Returns `true` if setting up watching for any path failed. + pub fn has_errored_paths(&self) -> bool { + self.has_errored_paths + } + + pub fn flush(&self) { + self.watcher.flush(); + } + + pub fn stop(self) { + self.watcher.stop(); + } +} + +struct DisplayWatchedPaths<'a> { + paths: &'a [SystemPathBuf], +} + +impl std::fmt::Display for DisplayWatchedPaths<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_char('[')?; + + let mut iter = self.paths.iter(); + if let Some(first) = iter.next() { + write!(f, "\"{first}\"")?; + + for path in iter { + write!(f, ", \"{path}\"")?; + } + } + + f.write_char(']') + } +} diff --git a/crates/red_knot_workspace/src/watch/watcher.rs b/crates/ty_project/src/watch/watcher.rs similarity index 96% rename from crates/red_knot_workspace/src/watch/watcher.rs rename to crates/ty_project/src/watch/watcher.rs index ef6ee2fdd2cd6..f3789a526b9e9 100644 --- a/crates/red_knot_workspace/src/watch/watcher.rs +++ b/crates/ty_project/src/watch/watcher.rs @@ -1,5 +1,5 @@ use notify::event::{CreateKind, MetadataKind, ModifyKind, RemoveKind, RenameMode}; -use notify::{recommended_watcher, EventKind, RecommendedWatcher, RecursiveMode, Watcher as _}; +use notify::{EventKind, RecommendedWatcher, RecursiveMode, Watcher as _, recommended_watcher}; use ruff_db::system::{SystemPath, SystemPathBuf}; @@ -186,7 +186,7 @@ impl Debouncer { } } - #[allow(clippy::unused_self, clippy::needless_pass_by_value)] + #[expect(clippy::unused_self, clippy::needless_pass_by_value)] fn add_error(&mut self, error: notify::Error) { // Micha: I skimmed through some of notify's source code and it seems the most common errors // are IO errors. All other errors should really only happen when adding or removing a watched folders. @@ -210,7 +210,15 @@ impl Debouncer { } let kind = event.kind; - let path = match SystemPathBuf::from_path_buf(event.paths.into_iter().next().unwrap()) { + + // There are cases where paths can be empty. + // https://github.com/astral-sh/ruff/issues/14222 + let Some(path) = event.paths.into_iter().next() else { + tracing::debug!("Ignoring change event with kind '{kind:?}' without a path",); + return; + }; + + let path = match SystemPathBuf::from_path_buf(path) { Ok(path) => path, Err(path) => { tracing::debug!( diff --git a/crates/ty_project/tests/check.rs b/crates/ty_project/tests/check.rs new file mode 100644 index 0000000000000..36f8b16f1be38 --- /dev/null +++ b/crates/ty_project/tests/check.rs @@ -0,0 +1,301 @@ +use anyhow::{Context, anyhow}; +use ruff_db::files::{File, system_path_to_file}; +use ruff_db::parsed::parsed_module; +use ruff_db::system::{SystemPath, SystemPathBuf, TestSystem}; +use ruff_python_ast::visitor::source_order; +use ruff_python_ast::visitor::source_order::SourceOrderVisitor; +use ruff_python_ast::{ + self as ast, Alias, Comprehension, Expr, Parameter, ParameterWithDefault, Stmt, +}; +use ty_project::{ProjectDatabase, ProjectMetadata}; +use ty_python_semantic::{HasType, SemanticModel}; + +fn setup_db(project_root: &SystemPath, system: TestSystem) -> anyhow::Result<ProjectDatabase> { + let project = ProjectMetadata::discover(project_root, &system)?; + ProjectDatabase::new(project, system) +} + +fn get_cargo_workspace_root() -> anyhow::Result<SystemPathBuf> { + Ok(SystemPathBuf::from(String::from_utf8( + std::process::Command::new("cargo") + .args(["locate-project", "--workspace", "--message-format", "plain"]) + .output()? + .stdout, + )?) + .parent() + .unwrap() + .to_owned()) +} + +/// Test that all snippets in testcorpus can be checked without panic (except for [`KNOWN_FAILURES`]) +#[test] +fn corpus_no_panic() -> anyhow::Result<()> { + let crate_root = String::from(env!("CARGO_MANIFEST_DIR")); + run_corpus_tests(&format!("{crate_root}/resources/test/corpus/**/*.py")) +} + +#[test] +fn parser_no_panic() -> anyhow::Result<()> { + let workspace_root = get_cargo_workspace_root()?; + run_corpus_tests(&format!( + "{workspace_root}/crates/ruff_python_parser/resources/**/*.py" + )) +} + +#[test] +fn linter_af_no_panic() -> anyhow::Result<()> { + let workspace_root = get_cargo_workspace_root()?; + run_corpus_tests(&format!( + "{workspace_root}/crates/ruff_linter/resources/test/fixtures/[a-f]*/**/*.py" + )) +} + +#[test] +fn linter_gz_no_panic() -> anyhow::Result<()> { + let workspace_root = get_cargo_workspace_root()?; + run_corpus_tests(&format!( + "{workspace_root}/crates/ruff_linter/resources/test/fixtures/[g-z]*/**/*.py" + )) +} + +#[test] +#[ignore = "Enable running once there are fewer failures"] +fn linter_stubs_no_panic() -> anyhow::Result<()> { + let workspace_root = get_cargo_workspace_root()?; + run_corpus_tests(&format!( + "{workspace_root}/crates/ruff_linter/resources/test/fixtures/**/*.pyi" + )) +} + +#[test] +#[ignore = "Enable running over typeshed stubs once there are fewer failures"] +fn typeshed_no_panic() -> anyhow::Result<()> { + let workspace_root = get_cargo_workspace_root()?; + run_corpus_tests(&format!( + "{workspace_root}/crates/ty_vendored/vendor/typeshed/**/*.pyi" + )) +} + +#[expect(clippy::print_stdout)] +fn run_corpus_tests(pattern: &str) -> anyhow::Result<()> { + let root = SystemPathBuf::from("/src"); + + let system = TestSystem::default(); + let memory_fs = system.memory_file_system(); + memory_fs.create_directory_all(root.as_ref())?; + + let mut db = setup_db(&root, system.clone())?; + + let workspace_root = get_cargo_workspace_root()?; + let workspace_root = workspace_root.to_string(); + + let corpus = glob::glob(pattern).context("Failed to compile pattern")?; + + for path in corpus { + let path = path.context("Failed to glob path")?; + let path = SystemPathBuf::from_path_buf(path).map_err(|path| { + anyhow!( + "Failed to convert path '{path}' to system path", + path = path.display() + ) + })?; + + let relative_path = path.strip_prefix(&workspace_root)?; + + let (py_expected_to_fail, pyi_expected_to_fail) = KNOWN_FAILURES + .iter() + .find_map(|(path, py_fail, pyi_fail)| { + if *path == relative_path.as_str().replace('\\', "/") { + Some((*py_fail, *pyi_fail)) + } else { + None + } + }) + .unwrap_or((false, false)); + + let source = path.as_path(); + let source_filename = source.file_name().unwrap(); + + let code = std::fs::read_to_string(source)?; + + let mut check_with_file_name = |path: &SystemPath| { + memory_fs.write_file_all(path, &code).unwrap(); + File::sync_path(&mut db, path); + + // this test is only asserting that we can pull every expression type without a panic + // (and some non-expressions that clearly define a single type) + let file = system_path_to_file(&db, path).unwrap(); + + let result = std::panic::catch_unwind(|| pull_types(&db, file)); + + let expected_to_fail = if path.extension().map(|e| e == "pyi").unwrap_or(false) { + pyi_expected_to_fail + } else { + py_expected_to_fail + }; + if let Err(err) = result { + if !expected_to_fail { + println!( + "Check failed for {relative_path:?}. Consider fixing it or adding it to KNOWN_FAILURES" + ); + std::panic::resume_unwind(err); + } + } else { + assert!( + !expected_to_fail, + "Expected to panic, but did not. Consider removing this path from KNOWN_FAILURES" + ); + } + + memory_fs.remove_file(path).unwrap(); + file.sync(&mut db); + }; + + if source.extension() == Some("pyi") { + println!("checking {relative_path}"); + let pyi_dest = root.join(source_filename); + check_with_file_name(&pyi_dest); + } else { + println!("checking {relative_path}"); + let py_dest = root.join(source_filename); + check_with_file_name(&py_dest); + + let pyi_dest = root.join(format!("{source_filename}i")); + println!("re-checking as stub file: {pyi_dest}"); + check_with_file_name(&pyi_dest); + } + } + + Ok(()) +} + +fn pull_types(db: &ProjectDatabase, file: File) { + let mut visitor = PullTypesVisitor::new(db, file); + + let ast = parsed_module(db, file); + + visitor.visit_body(ast.suite()); +} + +struct PullTypesVisitor<'db> { + model: SemanticModel<'db>, +} + +impl<'db> PullTypesVisitor<'db> { + fn new(db: &'db ProjectDatabase, file: File) -> Self { + Self { + model: SemanticModel::new(db, file), + } + } + + fn visit_target(&mut self, target: &Expr) { + match target { + Expr::List(ast::ExprList { elts, .. }) | Expr::Tuple(ast::ExprTuple { elts, .. }) => { + for element in elts { + self.visit_target(element); + } + } + _ => self.visit_expr(target), + } + } +} + +impl SourceOrderVisitor<'_> for PullTypesVisitor<'_> { + fn visit_stmt(&mut self, stmt: &Stmt) { + match stmt { + Stmt::FunctionDef(function) => { + let _ty = function.inferred_type(&self.model); + } + Stmt::ClassDef(class) => { + let _ty = class.inferred_type(&self.model); + } + Stmt::Assign(assign) => { + for target in &assign.targets { + self.visit_target(target); + } + self.visit_expr(&assign.value); + return; + } + Stmt::For(for_stmt) => { + self.visit_target(&for_stmt.target); + self.visit_expr(&for_stmt.iter); + self.visit_body(&for_stmt.body); + self.visit_body(&for_stmt.orelse); + return; + } + Stmt::With(with_stmt) => { + for item in &with_stmt.items { + if let Some(target) = &item.optional_vars { + self.visit_target(target); + } + self.visit_expr(&item.context_expr); + } + + self.visit_body(&with_stmt.body); + return; + } + Stmt::AnnAssign(_) + | Stmt::Return(_) + | Stmt::Delete(_) + | Stmt::AugAssign(_) + | Stmt::TypeAlias(_) + | Stmt::While(_) + | Stmt::If(_) + | Stmt::Match(_) + | Stmt::Raise(_) + | Stmt::Try(_) + | Stmt::Assert(_) + | Stmt::Import(_) + | Stmt::ImportFrom(_) + | Stmt::Global(_) + | Stmt::Nonlocal(_) + | Stmt::Expr(_) + | Stmt::Pass(_) + | Stmt::Break(_) + | Stmt::Continue(_) + | Stmt::IpyEscapeCommand(_) => {} + } + + source_order::walk_stmt(self, stmt); + } + + fn visit_expr(&mut self, expr: &Expr) { + let _ty = expr.inferred_type(&self.model); + + source_order::walk_expr(self, expr); + } + + fn visit_comprehension(&mut self, comprehension: &Comprehension) { + self.visit_expr(&comprehension.iter); + self.visit_target(&comprehension.target); + for if_expr in &comprehension.ifs { + self.visit_expr(if_expr); + } + } + + fn visit_parameter(&mut self, parameter: &Parameter) { + let _ty = parameter.inferred_type(&self.model); + + source_order::walk_parameter(self, parameter); + } + + fn visit_parameter_with_default(&mut self, parameter_with_default: &ParameterWithDefault) { + let _ty = parameter_with_default.inferred_type(&self.model); + + source_order::walk_parameter_with_default(self, parameter_with_default); + } + + fn visit_alias(&mut self, alias: &Alias) { + let _ty = alias.inferred_type(&self.model); + + source_order::walk_alias(self, alias); + } +} + +/// Whether or not the .py/.pyi version of this file is expected to fail +#[rustfmt::skip] +const KNOWN_FAILURES: &[(&str, bool, bool)] = &[ + // Fails with too-many-cycle-iterations due to a self-referential + // type alias, see https://github.com/astral-sh/ty/issues/256 + ("crates/ruff_linter/resources/test/fixtures/pyflakes/F401_34.py", true, true), +]; diff --git a/crates/ty_python_semantic/Cargo.toml b/crates/ty_python_semantic/Cargo.toml new file mode 100644 index 0000000000000..91e26b8fb5b28 --- /dev/null +++ b/crates/ty_python_semantic/Cargo.toml @@ -0,0 +1,65 @@ +[package] +name = "ty_python_semantic" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } + +[dependencies] +ruff_db = { workspace = true } +ruff_index = { workspace = true, features = ["salsa"] } +ruff_macros = { workspace = true } +ruff_python_ast = { workspace = true, features = ["salsa"] } +ruff_python_parser = { workspace = true } +ruff_python_stdlib = { workspace = true } +ruff_source_file = { workspace = true } +ruff_text_size = { workspace = true } +ruff_python_literal = { workspace = true } +ruff_python_trivia = { workspace = true } + +anyhow = { workspace = true } +bitflags = { workspace = true } +camino = { workspace = true } +compact_str = { workspace = true } +countme = { workspace = true } +drop_bomb = { workspace = true } +indexmap = { workspace = true } +itertools = { workspace = true } +ordermap = { workspace = true } +salsa = { workspace = true, features = ["compact_str"] } +thiserror = { workspace = true } +tracing = { workspace = true } +rustc-hash = { workspace = true } +hashbrown = { workspace = true } +schemars = { workspace = true, optional = true } +serde = { workspace = true, optional = true } +smallvec = { workspace = true } +static_assertions = { workspace = true } +test-case = { workspace = true } +memchr = { workspace = true } +strum = { workspace = true } +strum_macros = { workspace = true } + +[dev-dependencies] +ruff_db = { workspace = true, features = ["testing", "os"] } +ruff_python_parser = { workspace = true } +ty_test = { workspace = true } +ty_vendored = { workspace = true } + +anyhow = { workspace = true } +dir-test = { workspace = true } +insta = { workspace = true } +tempfile = { workspace = true } +quickcheck = { version = "1.0.3", default-features = false } +quickcheck_macros = { version = "1.0.0" } + +[features] +serde = ["ruff_db/serde", "dep:serde", "ruff_python_ast/serde"] + +[lints] +workspace = true diff --git a/crates/red_knot_python_semantic/build.rs b/crates/ty_python_semantic/build.rs similarity index 100% rename from crates/red_knot_python_semantic/build.rs rename to crates/ty_python_semantic/build.rs diff --git a/crates/ty_python_semantic/mdtest.py b/crates/ty_python_semantic/mdtest.py new file mode 100644 index 0000000000000..e238c9ce89f65 --- /dev/null +++ b/crates/ty_python_semantic/mdtest.py @@ -0,0 +1,236 @@ +"""A runner for Markdown-based tests for ty""" +# /// script +# requires-python = ">=3.11" +# dependencies = [ +# "rich", +# "watchfiles", +# ] +# /// + +from __future__ import annotations + +import json +import os +import subprocess +from pathlib import Path +from typing import Final, Literal, Never, assert_never + +from rich.console import Console +from watchfiles import Change, watch + +CRATE_NAME: Final = "ty_python_semantic" +CRATE_ROOT: Final = Path(__file__).resolve().parent +TY_VENDORED: Final = CRATE_ROOT.parent / "ty_vendored" +DIRS_TO_WATCH: Final = ( + CRATE_ROOT, + TY_VENDORED, + CRATE_ROOT.parent / "ty_test/src", +) +MDTEST_DIR: Final = CRATE_ROOT / "resources" / "mdtest" + + +class MDTestRunner: + mdtest_executable: Path | None + console: Console + + def __init__(self) -> None: + self.mdtest_executable = None + self.console = Console() + + def _run_cargo_test(self, *, message_format: Literal["human", "json"]) -> str: + return subprocess.check_output( + [ + "cargo", + "test", + "--package", + CRATE_NAME, + "--no-run", + "--color=always", + "--message-format", + message_format, + ], + cwd=CRATE_ROOT, + env=dict(os.environ, CLI_COLOR="1"), + stderr=subprocess.STDOUT, + text=True, + ) + + def _recompile_tests( + self, status_message: str, *, message_on_success: bool = True + ) -> bool: + with self.console.status(status_message): + # Run it with 'human' format in case there are errors: + try: + self._run_cargo_test(message_format="human") + except subprocess.CalledProcessError as e: + print(e.output) + return False + + # Run it again with 'json' format to find the mdtest executable: + try: + json_output = self._run_cargo_test(message_format="json") + except subprocess.CalledProcessError as _: + # `cargo test` can still fail if something changed in between the two runs. + # Here we don't have a human-readable output, so just show a generic message: + self.console.print("[red]Error[/red]: Failed to compile tests") + return False + + if json_output: + self._get_executable_path_from_json(json_output) + + if message_on_success: + self.console.print("[dim]Tests compiled successfully[/dim]") + return True + + def _get_executable_path_from_json(self, json_output: str) -> None: + for json_line in json_output.splitlines(): + try: + data = json.loads(json_line) + except json.JSONDecodeError: + continue + if data.get("target", {}).get("name") == "mdtest": + self.mdtest_executable = Path(data["executable"]) + break + else: + raise RuntimeError( + "Could not find mdtest executable after successful compilation" + ) + + def _run_mdtest( + self, arguments: list[str] | None = None, *, capture_output: bool = False + ) -> subprocess.CompletedProcess: + assert self.mdtest_executable is not None + + arguments = arguments or [] + return subprocess.run( + [self.mdtest_executable, *arguments], + cwd=CRATE_ROOT, + env=dict(os.environ, CLICOLOR_FORCE="1"), + capture_output=capture_output, + text=True, + check=False, + ) + + def _run_mdtests_for_file(self, markdown_file: Path) -> None: + path_mangled = ( + markdown_file.as_posix() + .replace("/", "_") + .replace("-", "_") + .removesuffix(".md") + ) + test_name = f"mdtest__{path_mangled}" + + output = self._run_mdtest(["--exact", test_name], capture_output=True) + + if output.returncode == 0: + if "running 0 tests\n" in output.stdout: + self.console.log( + f"[yellow]Warning[/yellow]: No tests were executed with filter '{test_name}'" + ) + else: + self.console.print( + f"Test for [bold green]{markdown_file}[/bold green] succeeded" + ) + else: + self.console.print() + self.console.rule( + f"Test for [bold red]{markdown_file}[/bold red] failed", + style="gray", + ) + self._print_trimmed_cargo_test_output( + output.stdout + output.stderr, test_name + ) + + def _print_trimmed_cargo_test_output(self, output: str, test_name: str) -> None: + # Skip 'cargo test' boilerplate at the beginning: + lines = output.splitlines() + start_index = 0 + for i, line in enumerate(lines): + if f"{test_name} stdout" in line: + start_index = i + break + + for line in lines[start_index + 1 :]: + if "MDTEST_TEST_FILTER" in line: + continue + if line.strip() == "-" * 50: + # Skip 'cargo test' boilerplate at the end + break + + print(line) + + def watch(self) -> Never: + self._recompile_tests("Compiling tests...", message_on_success=False) + self._run_mdtest() + self.console.print("[dim]Ready to watch for changes...[/dim]") + + for changes in watch(*DIRS_TO_WATCH): + new_md_files = set() + changed_md_files = set() + rust_code_has_changed = False + vendored_typeshed_has_changed = False + + for change, path_str in changes: + path = Path(path_str) + + match path.suffix: + case ".rs": + rust_code_has_changed = True + case ".pyi" if path.is_relative_to(TY_VENDORED): + vendored_typeshed_has_changed = True + case ".md": + pass + case _: + continue + + try: + relative_path = Path(path).relative_to(MDTEST_DIR) + except ValueError: + continue + + match change: + case Change.added: + # When saving a file, some editors (looking at you, Vim) might first + # save the file with a temporary name (e.g. `file.md~`) and then rename + # it to the final name. This creates a `deleted` and `added` change. + # We treat those files as `changed` here. + if (Change.deleted, path_str) in changes: + changed_md_files.add(relative_path) + else: + new_md_files.add(relative_path) + case Change.modified: + changed_md_files.add(relative_path) + case Change.deleted: + # No need to do anything when a Markdown test is deleted + pass + case _ as unreachable: + assert_never(unreachable) + + if rust_code_has_changed: + if self._recompile_tests("Rust code has changed, recompiling tests..."): + self._run_mdtest() + elif vendored_typeshed_has_changed: + if self._recompile_tests( + "Vendored typeshed has changed, recompiling tests..." + ): + self._run_mdtest() + elif new_md_files: + files = " ".join(file.as_posix() for file in new_md_files) + self._recompile_tests( + f"New Markdown test [yellow]{files}[/yellow] detected, recompiling tests..." + ) + + for path in new_md_files | changed_md_files: + self._run_mdtests_for_file(path) + + +def main() -> None: + try: + runner = MDTestRunner() + runner.watch() + except KeyboardInterrupt: + print() + + +if __name__ == "__main__": + main() diff --git a/crates/ty_python_semantic/mdtest.py.lock b/crates/ty_python_semantic/mdtest.py.lock new file mode 100644 index 0000000000000..13fa2a235e7d9 --- /dev/null +++ b/crates/ty_python_semantic/mdtest.py.lock @@ -0,0 +1,141 @@ +version = 1 +requires-python = ">=3.11" + +[manifest] +requirements = [ + { name = "rich" }, + { name = "watchfiles" }, +] + +[[package]] +name = "anyio" +version = "4.8.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "idna" }, + { name = "sniffio" }, + { name = "typing-extensions", marker = "python_full_version < '3.13'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a3/73/199a98fc2dae33535d6b8e8e6ec01f8c1d76c9adb096c6b7d64823038cde/anyio-4.8.0.tar.gz", hash = "sha256:1d9fe889df5212298c0c0723fa20479d1b94883a2df44bd3897aa91083316f7a", size = 181126 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/46/eb/e7f063ad1fec6b3178a3cd82d1a3c4de82cccf283fc42746168188e1cdd5/anyio-4.8.0-py3-none-any.whl", hash = "sha256:b5011f270ab5eb0abf13385f851315585cc37ef330dd88e27ec3d34d651fd47a", size = 96041 }, +] + +[[package]] +name = "idna" +version = "3.10" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f1/70/7703c29685631f5a7590aa73f1f1d3fa9a380e654b86af429e0934a32f7d/idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9", size = 190490 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442 }, +] + +[[package]] +name = "markdown-it-py" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mdurl" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/38/71/3b932df36c1a044d397a1f92d1cf91ee0a503d91e470cbd670aa66b07ed0/markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb", size = 74596 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f/markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", size = 87528 }, +] + +[[package]] +name = "mdurl" +version = "0.1.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979 }, +] + +[[package]] +name = "pygments" +version = "2.19.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7c/2d/c3338d48ea6cc0feb8446d8e6937e1408088a72a39937982cc6111d17f84/pygments-2.19.1.tar.gz", hash = "sha256:61c16d2a8576dc0649d9f39e089b5f02bcd27fba10d8fb4dcc28173f7a45151f", size = 4968581 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8a/0b/9fcc47d19c48b59121088dd6da2488a49d5f72dacf8262e2790a1d2c7d15/pygments-2.19.1-py3-none-any.whl", hash = "sha256:9ea1544ad55cecf4b8242fab6dd35a93bbce657034b0611ee383099054ab6d8c", size = 1225293 }, +] + +[[package]] +name = "rich" +version = "13.9.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown-it-py" }, + { name = "pygments" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ab/3a/0316b28d0761c6734d6bc14e770d85506c986c85ffb239e688eeaab2c2bc/rich-13.9.4.tar.gz", hash = "sha256:439594978a49a09530cff7ebc4b5c7103ef57baf48d5ea3184f21d9a2befa098", size = 223149 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/19/71/39c7c0d87f8d4e6c020a393182060eaefeeae6c01dab6a84ec346f2567df/rich-13.9.4-py3-none-any.whl", hash = "sha256:6049d5e6ec054bf2779ab3358186963bac2ea89175919d699e378b99738c2a90", size = 242424 }, +] + +[[package]] +name = "sniffio" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a2/87/a6771e1546d97e7e041b6ae58d80074f81b7d5121207425c964ddf5cfdbd/sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc", size = 20372 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e9/44/75a9c9421471a6c4805dbf2356f7c181a29c1879239abab1ea2cc8f38b40/sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2", size = 10235 }, +] + +[[package]] +name = "typing-extensions" +version = "4.12.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/df/db/f35a00659bc03fec321ba8bce9420de607a1d37f8342eee1863174c69557/typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8", size = 85321 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/26/9f/ad63fc0248c5379346306f8668cda6e2e2e9c95e01216d2b8ffd9ff037d0/typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d", size = 37438 }, +] + +[[package]] +name = "watchfiles" +version = "1.0.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "anyio" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f5/26/c705fc77d0a9ecdb9b66f1e2976d95b81df3cae518967431e7dbf9b5e219/watchfiles-1.0.4.tar.gz", hash = "sha256:6ba473efd11062d73e4f00c2b730255f9c1bdd73cd5f9fe5b5da8dbd4a717205", size = 94625 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0f/bb/8461adc4b1fed009546fb797fc0d5698dcfe5e289cb37e1b8f16a93cdc30/watchfiles-1.0.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:2a9f93f8439639dc244c4d2902abe35b0279102bca7bbcf119af964f51d53c19", size = 394869 }, + { url = "https://files.pythonhosted.org/packages/55/88/9ebf36b3547176d1709c320de78c1fa3263a46be31b5b1267571d9102686/watchfiles-1.0.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9eea33ad8c418847dd296e61eb683cae1c63329b6d854aefcd412e12d94ee235", size = 384905 }, + { url = "https://files.pythonhosted.org/packages/03/8a/04335ce23ef78d8c69f0913e8b20cf7d9233e3986543aeef95ef2d6e43d2/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:31f1a379c9dcbb3f09cf6be1b7e83b67c0e9faabed0471556d9438a4a4e14202", size = 449944 }, + { url = "https://files.pythonhosted.org/packages/17/4e/c8d5dcd14fe637f4633616dabea8a4af0a10142dccf3b43e0f081ba81ab4/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ab594e75644421ae0a2484554832ca5895f8cab5ab62de30a1a57db460ce06c6", size = 456020 }, + { url = "https://files.pythonhosted.org/packages/5e/74/3e91e09e1861dd7fbb1190ce7bd786700dc0fbc2ccd33bb9fff5de039229/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fc2eb5d14a8e0d5df7b36288979176fbb39672d45184fc4b1c004d7c3ce29317", size = 482983 }, + { url = "https://files.pythonhosted.org/packages/a1/3d/e64de2d1ce4eb6a574fd78ce3a28c279da263be9ef3cfcab6f708df192f2/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3f68d8e9d5a321163ddacebe97091000955a1b74cd43724e346056030b0bacee", size = 520320 }, + { url = "https://files.pythonhosted.org/packages/2c/bd/52235f7063b57240c66a991696ed27e2a18bd6fcec8a1ea5a040b70d0611/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f9ce064e81fe79faa925ff03b9f4c1a98b0bbb4a1b8c1b015afa93030cb21a49", size = 500988 }, + { url = "https://files.pythonhosted.org/packages/3a/b0/ff04194141a5fe650c150400dd9e42667916bc0f52426e2e174d779b8a74/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b77d5622ac5cc91d21ae9c2b284b5d5c51085a0bdb7b518dba263d0af006132c", size = 452573 }, + { url = "https://files.pythonhosted.org/packages/3d/9d/966164332c5a178444ae6d165082d4f351bd56afd9c3ec828eecbf190e6a/watchfiles-1.0.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1941b4e39de9b38b868a69b911df5e89dc43767feeda667b40ae032522b9b5f1", size = 615114 }, + { url = "https://files.pythonhosted.org/packages/94/df/f569ae4c1877f96ad4086c153a8eee5a19a3b519487bf5c9454a3438c341/watchfiles-1.0.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:4f8c4998506241dedf59613082d1c18b836e26ef2a4caecad0ec41e2a15e4226", size = 613076 }, + { url = "https://files.pythonhosted.org/packages/15/ae/8ce5f29e65d5fa5790e3c80c289819c55e12be2e1b9f5b6a0e55e169b97d/watchfiles-1.0.4-cp311-cp311-win32.whl", hash = "sha256:4ebbeca9360c830766b9f0df3640b791be569d988f4be6c06d6fae41f187f105", size = 271013 }, + { url = "https://files.pythonhosted.org/packages/a4/c6/79dc4a7c598a978e5fafa135090aaf7bbb03b8dec7bada437dfbe578e7ed/watchfiles-1.0.4-cp311-cp311-win_amd64.whl", hash = "sha256:05d341c71f3d7098920f8551d4df47f7b57ac5b8dad56558064c3431bdfc0b74", size = 284229 }, + { url = "https://files.pythonhosted.org/packages/37/3d/928633723211753f3500bfb138434f080363b87a1b08ca188b1ce54d1e05/watchfiles-1.0.4-cp311-cp311-win_arm64.whl", hash = "sha256:32b026a6ab64245b584acf4931fe21842374da82372d5c039cba6bf99ef722f3", size = 276824 }, + { url = "https://files.pythonhosted.org/packages/5b/1a/8f4d9a1461709756ace48c98f07772bc6d4519b1e48b5fa24a4061216256/watchfiles-1.0.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:229e6ec880eca20e0ba2f7e2249c85bae1999d330161f45c78d160832e026ee2", size = 391345 }, + { url = "https://files.pythonhosted.org/packages/bc/d2/6750b7b3527b1cdaa33731438432e7238a6c6c40a9924049e4cebfa40805/watchfiles-1.0.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5717021b199e8353782dce03bd8a8f64438832b84e2885c4a645f9723bf656d9", size = 381515 }, + { url = "https://files.pythonhosted.org/packages/4e/17/80500e42363deef1e4b4818729ed939aaddc56f82f4e72b2508729dd3c6b/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0799ae68dfa95136dde7c472525700bd48777875a4abb2ee454e3ab18e9fc712", size = 449767 }, + { url = "https://files.pythonhosted.org/packages/10/37/1427fa4cfa09adbe04b1e97bced19a29a3462cc64c78630787b613a23f18/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:43b168bba889886b62edb0397cab5b6490ffb656ee2fcb22dec8bfeb371a9e12", size = 455677 }, + { url = "https://files.pythonhosted.org/packages/c5/7a/39e9397f3a19cb549a7d380412fd9e507d4854eddc0700bfad10ef6d4dba/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fb2c46e275fbb9f0c92e7654b231543c7bbfa1df07cdc4b99fa73bedfde5c844", size = 482219 }, + { url = "https://files.pythonhosted.org/packages/45/2d/7113931a77e2ea4436cad0c1690c09a40a7f31d366f79c6f0a5bc7a4f6d5/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:857f5fc3aa027ff5e57047da93f96e908a35fe602d24f5e5d8ce64bf1f2fc733", size = 518830 }, + { url = "https://files.pythonhosted.org/packages/f9/1b/50733b1980fa81ef3c70388a546481ae5fa4c2080040100cd7bf3bf7b321/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:55ccfd27c497b228581e2838d4386301227fc0cb47f5a12923ec2fe4f97b95af", size = 497997 }, + { url = "https://files.pythonhosted.org/packages/2b/b4/9396cc61b948ef18943e7c85ecfa64cf940c88977d882da57147f62b34b1/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5c11ea22304d17d4385067588123658e9f23159225a27b983f343fcffc3e796a", size = 452249 }, + { url = "https://files.pythonhosted.org/packages/fb/69/0c65a5a29e057ad0dc691c2fa6c23b2983c7dabaa190ba553b29ac84c3cc/watchfiles-1.0.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:74cb3ca19a740be4caa18f238298b9d472c850f7b2ed89f396c00a4c97e2d9ff", size = 614412 }, + { url = "https://files.pythonhosted.org/packages/7f/b9/319fcba6eba5fad34327d7ce16a6b163b39741016b1996f4a3c96b8dd0e1/watchfiles-1.0.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:c7cce76c138a91e720d1df54014a047e680b652336e1b73b8e3ff3158e05061e", size = 611982 }, + { url = "https://files.pythonhosted.org/packages/f1/47/143c92418e30cb9348a4387bfa149c8e0e404a7c5b0585d46d2f7031b4b9/watchfiles-1.0.4-cp312-cp312-win32.whl", hash = "sha256:b045c800d55bc7e2cadd47f45a97c7b29f70f08a7c2fa13241905010a5493f94", size = 271822 }, + { url = "https://files.pythonhosted.org/packages/ea/94/b0165481bff99a64b29e46e07ac2e0df9f7a957ef13bec4ceab8515f44e3/watchfiles-1.0.4-cp312-cp312-win_amd64.whl", hash = "sha256:c2acfa49dd0ad0bf2a9c0bb9a985af02e89345a7189be1efc6baa085e0f72d7c", size = 285441 }, + { url = "https://files.pythonhosted.org/packages/11/de/09fe56317d582742d7ca8c2ca7b52a85927ebb50678d9b0fa8194658f536/watchfiles-1.0.4-cp312-cp312-win_arm64.whl", hash = "sha256:22bb55a7c9e564e763ea06c7acea24fc5d2ee5dfc5dafc5cfbedfe58505e9f90", size = 277141 }, + { url = "https://files.pythonhosted.org/packages/08/98/f03efabec64b5b1fa58c0daab25c68ef815b0f320e54adcacd0d6847c339/watchfiles-1.0.4-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:8012bd820c380c3d3db8435e8cf7592260257b378b649154a7948a663b5f84e9", size = 390954 }, + { url = "https://files.pythonhosted.org/packages/16/09/4dd49ba0a32a45813debe5fb3897955541351ee8142f586303b271a02b40/watchfiles-1.0.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:aa216f87594f951c17511efe5912808dfcc4befa464ab17c98d387830ce07b60", size = 381133 }, + { url = "https://files.pythonhosted.org/packages/76/59/5aa6fc93553cd8d8ee75c6247763d77c02631aed21551a97d94998bf1dae/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:62c9953cf85529c05b24705639ffa390f78c26449e15ec34d5339e8108c7c407", size = 449516 }, + { url = "https://files.pythonhosted.org/packages/4c/aa/df4b6fe14b6317290b91335b23c96b488d365d65549587434817e06895ea/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7cf684aa9bba4cd95ecb62c822a56de54e3ae0598c1a7f2065d51e24637a3c5d", size = 454820 }, + { url = "https://files.pythonhosted.org/packages/5e/71/185f8672f1094ce48af33252c73e39b48be93b761273872d9312087245f6/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f44a39aee3cbb9b825285ff979ab887a25c5d336e5ec3574f1506a4671556a8d", size = 481550 }, + { url = "https://files.pythonhosted.org/packages/85/d7/50ebba2c426ef1a5cb17f02158222911a2e005d401caf5d911bfca58f4c4/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a38320582736922be8c865d46520c043bff350956dfc9fbaee3b2df4e1740a4b", size = 518647 }, + { url = "https://files.pythonhosted.org/packages/f0/7a/4c009342e393c545d68987e8010b937f72f47937731225b2b29b7231428f/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:39f4914548b818540ef21fd22447a63e7be6e24b43a70f7642d21f1e73371590", size = 497547 }, + { url = "https://files.pythonhosted.org/packages/0f/7c/1cf50b35412d5c72d63b2bf9a4fffee2e1549a245924960dd087eb6a6de4/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f12969a3765909cf5dc1e50b2436eb2c0e676a3c75773ab8cc3aa6175c16e902", size = 452179 }, + { url = "https://files.pythonhosted.org/packages/d6/a9/3db1410e1c1413735a9a472380e4f431ad9a9e81711cda2aaf02b7f62693/watchfiles-1.0.4-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:0986902677a1a5e6212d0c49b319aad9cc48da4bd967f86a11bde96ad9676ca1", size = 614125 }, + { url = "https://files.pythonhosted.org/packages/f2/e1/0025d365cf6248c4d1ee4c3d2e3d373bdd3f6aff78ba4298f97b4fad2740/watchfiles-1.0.4-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:308ac265c56f936636e3b0e3f59e059a40003c655228c131e1ad439957592303", size = 611911 }, + { url = "https://files.pythonhosted.org/packages/55/55/035838277d8c98fc8c917ac9beeb0cd6c59d675dc2421df5f9fcf44a0070/watchfiles-1.0.4-cp313-cp313-win32.whl", hash = "sha256:aee397456a29b492c20fda2d8961e1ffb266223625346ace14e4b6d861ba9c80", size = 271152 }, + { url = "https://files.pythonhosted.org/packages/f0/e5/96b8e55271685ddbadc50ce8bc53aa2dff278fb7ac4c2e473df890def2dc/watchfiles-1.0.4-cp313-cp313-win_amd64.whl", hash = "sha256:d6097538b0ae5c1b88c3b55afa245a66793a8fec7ada6755322e465fb1a0e8cc", size = 285216 }, +] diff --git a/crates/ty_python_semantic/resources/README.md b/crates/ty_python_semantic/resources/README.md new file mode 100644 index 0000000000000..ea0a69f18cd1d --- /dev/null +++ b/crates/ty_python_semantic/resources/README.md @@ -0,0 +1,4 @@ +Markdown files within the `mdtest/` subdirectory are tests of type inference and type checking; +executed by the `tests/mdtest.rs` integration test. + +See `crates/ty_test/README.md` for documentation of this test format. diff --git a/crates/ty_python_semantic/resources/mdtest/.mdformat.toml b/crates/ty_python_semantic/resources/mdtest/.mdformat.toml new file mode 100644 index 0000000000000..0163082076afe --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/.mdformat.toml @@ -0,0 +1 @@ +wrap = 100 diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/annotated.md b/crates/ty_python_semantic/resources/mdtest/annotations/annotated.md new file mode 100644 index 0000000000000..ed566b859edb5 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/annotated.md @@ -0,0 +1,92 @@ +# `Annotated` + +`Annotated` attaches arbitrary metadata to a given type. + +## Usages + +`Annotated[T, ...]` is equivalent to `T`: All metadata arguments are simply ignored. + +```py +from typing_extensions import Annotated + +def _(x: Annotated[int, "foo"]): + reveal_type(x) # revealed: int + +def _(x: Annotated[int, lambda: 0 + 1 * 2 // 3, _(4)]): + reveal_type(x) # revealed: int + +def _(x: Annotated[int, "arbitrary", "metadata", "elements", "are", "fine"]): + reveal_type(x) # revealed: int + +def _(x: Annotated[tuple[str, int], bytes]): + reveal_type(x) # revealed: tuple[str, int] +``` + +## Parameterization + +It is invalid to parameterize `Annotated` with less than two arguments. + +```py +from typing_extensions import Annotated + +# error: [invalid-type-form] "`typing.Annotated` requires at least two arguments when used in a type expression" +def _(x: Annotated): + reveal_type(x) # revealed: Unknown + +def _(flag: bool): + if flag: + X = Annotated + else: + X = bool + + # error: [invalid-type-form] "`typing.Annotated` requires at least two arguments when used in a type expression" + def f(y: X): + reveal_type(y) # revealed: Unknown | bool + +# error: [invalid-type-form] "`typing.Annotated` requires at least two arguments when used in a type expression" +def _(x: Annotated | bool): + reveal_type(x) # revealed: Unknown | bool + +# error: [invalid-type-form] +def _(x: Annotated[()]): + reveal_type(x) # revealed: Unknown + +# error: [invalid-type-form] +def _(x: Annotated[int]): + # `Annotated[T]` is invalid and will raise an error at runtime, + # but we treat it the same as `T` to provide better diagnostics later on. + # The subscription itself is still reported, regardless. + # Same for the `(int,)` form below. + reveal_type(x) # revealed: int + +# error: [invalid-type-form] +def _(x: Annotated[(int,)]): + reveal_type(x) # revealed: int +``` + +## Inheritance + +### Correctly parameterized + +Inheriting from `Annotated[T, ...]` is equivalent to inheriting from `T` itself. + +```py +from typing_extensions import Annotated + +class C(Annotated[int, "foo"]): ... + +# TODO: Should be `tuple[Literal[C], Literal[int], Literal[object]]` +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, @Todo(Inference of subscript on special form), <class 'object'>] +``` + +### Not parameterized + +```py +from typing_extensions import Annotated + +# At runtime, this is an error. +# error: [invalid-base] +class C(Annotated): ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, Unknown, <class 'object'>] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/any.md b/crates/ty_python_semantic/resources/mdtest/annotations/any.md new file mode 100644 index 0000000000000..d4b1e6f502224 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/any.md @@ -0,0 +1,150 @@ +# Any + +## Annotation + +`typing.Any` is a way to name the Any type. + +```py +from typing import Any + +x: Any = 1 +x = "foo" + +def f(): + reveal_type(x) # revealed: Any +``` + +## Aliased to a different name + +If you alias `typing.Any` to another name, we still recognize that as a spelling of the Any type. + +```py +from typing import Any as RenamedAny + +x: RenamedAny = 1 +x = "foo" + +def f(): + reveal_type(x) # revealed: Any +``` + +## Shadowed class + +If you define your own class named `Any`, using that in a type expression refers to your class, and +isn't a spelling of the Any type. + +```py +class Any: ... + +x: Any + +def f(): + reveal_type(x) # revealed: Any + +# This verifies that we're not accidentally seeing typing.Any, since str is assignable +# to that but not to our locally defined class. +y: Any = "not an Any" # error: [invalid-assignment] +``` + +## Subclasses of `Any` + +The spec allows you to define subclasses of `Any`. + +`SubclassOfAny` has an unknown superclass, which might be `int`. The assignment to `x` should not be +allowed, even when the unknown superclass is `int`. The assignment to `y` should be allowed, since +`Subclass` might have `int` as a superclass, and is therefore assignable to `int`. + +```py +from typing import Any + +class SubclassOfAny(Any): ... + +reveal_type(SubclassOfAny.__mro__) # revealed: tuple[<class 'SubclassOfAny'>, Any, <class 'object'>] + +x: SubclassOfAny = 1 # error: [invalid-assignment] +y: int = SubclassOfAny() +``` + +`SubclassOfAny` should not be assignable to a final class though, because `SubclassOfAny` could not +possibly be a subclass of `FinalClass`: + +```py +from typing import final + +@final +class FinalClass: ... + +f: FinalClass = SubclassOfAny() # error: [invalid-assignment] + +@final +class OtherFinalClass: ... + +f: FinalClass | OtherFinalClass = SubclassOfAny() # error: [invalid-assignment] +``` + +A subclass of `Any` can also be assigned to arbitrary `Callable` and `Protocol` types: + +```py +from typing import Callable, Any, Protocol + +def takes_callable1(f: Callable): + f() + +takes_callable1(SubclassOfAny()) + +def takes_callable2(f: Callable[[int], None]): + f(1) + +takes_callable2(SubclassOfAny()) + +class CallbackProtocol(Protocol): + def __call__(self, x: int, /) -> None: ... + +def takes_callback_proto(f: CallbackProtocol): + f(1) + +takes_callback_proto(SubclassOfAny()) + +class OtherProtocol(Protocol): + x: int + @property + def foo(self) -> bytes: ... + @foo.setter + def foo(self, x: str) -> None: ... + +def takes_other_protocol(f: OtherProtocol): ... + +takes_other_protocol(SubclassOfAny()) +``` + +A subclass of `Any` cannot be assigned to literal types, since those can not be subclassed: + +```py +from typing import Any, Literal + +class MockAny(Any): + pass + +x: Literal[1] = MockAny() # error: [invalid-assignment] +``` + +A use case where subclasses of `Any` come up is in mocking libraries, where the mock object should +be assignable to (almost) any type: + +```py +from unittest.mock import MagicMock + +x: int = MagicMock() +``` + +## Invalid + +`Any` cannot be parameterized: + +```py +from typing import Any + +# error: [invalid-type-form] "Type `typing.Any` expected no type parameter" +def f(x: Any[int]): + reveal_type(x) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/callable.md b/crates/ty_python_semantic/resources/mdtest/annotations/callable.md new file mode 100644 index 0000000000000..dc27fdb7d4f74 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/callable.md @@ -0,0 +1,308 @@ +# Callable + +References: + +- <https://typing.python.org/en/latest/spec/callables.html#callable> + +Note that `typing.Callable` is deprecated at runtime, in favour of `collections.abc.Callable` (see: +<https://docs.python.org/3/library/typing.html#deprecated-aliases>). However, removal of +`typing.Callable` is not currently planned, and the canonical location of the stub for the symbol in +typeshed is still `typing.pyi`. + +## Invalid forms + +The `Callable` special form requires _exactly_ two arguments where the first argument is either a +parameter type list, parameter specification, `typing.Concatenate`, or `...` and the second argument +is the return type. Here, we explore various invalid forms. + +### Empty + +A bare `Callable` without any type arguments: + +```py +from typing import Callable + +def _(c: Callable): + reveal_type(c) # revealed: (...) -> Unknown +``` + +### Invalid parameter type argument + +When it's not a list: + +```py +from typing import Callable + +# error: [invalid-type-form] "The first argument to `Callable` must be either a list of types, ParamSpec, Concatenate, or `...`" +def _(c: Callable[int, str]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +Or, when it's a literal type: + +```py +# error: [invalid-type-form] "The first argument to `Callable` must be either a list of types, ParamSpec, Concatenate, or `...`" +def _(c: Callable[42, str]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +Or, when one of the parameter type is invalid in the list: + +```py +# error: [invalid-type-form] "Int literals are not allowed in this context in a type expression" +# error: [invalid-type-form] "Boolean literals are not allowed in this context in a type expression" +def _(c: Callable[[int, 42, str, False], None]): + # revealed: (int, Unknown, str, Unknown, /) -> None + reveal_type(c) +``` + +### Missing return type + +Using a parameter list: + +```py +from typing import Callable + +# error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" +def _(c: Callable[[int, str]]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +Or, an ellipsis: + +```py +# error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" +def _(c: Callable[...]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +Or something else that's invalid in a type expression generally: + +```py +# fmt: off + +def _(c: Callable[ # error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" + {1, 2} # error: [invalid-type-form] "The first argument to `Callable` must be either a list of types, ParamSpec, Concatenate, or `...`" + ] + ): + reveal_type(c) # revealed: (...) -> Unknown +``` + +### More than two arguments + +We can't reliably infer the callable type if there are more then 2 arguments because we don't know +which argument corresponds to either the parameters or the return type. + +```py +from typing import Callable + +# error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" +def _(c: Callable[[int], str, str]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +### List as the second argument + +```py +from typing import Callable + +# fmt: off + +def _(c: Callable[ + int, # error: [invalid-type-form] "The first argument to `Callable` must be either a list of types, ParamSpec, Concatenate, or `...`" + [str] # error: [invalid-type-form] "List literals are not allowed in this context in a type expression" + ] + ): + reveal_type(c) # revealed: (...) -> Unknown +``` + +### List as both arguments + +```py +from typing import Callable + +# error: [invalid-type-form] "List literals are not allowed in this context in a type expression" +def _(c: Callable[[int], [str]]): + reveal_type(c) # revealed: (int, /) -> Unknown +``` + +### Three list arguments + +```py +from typing import Callable + +# fmt: off + + +def _(c: Callable[ # error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" + [int], + [str], # error: [invalid-type-form] "List literals are not allowed in this context in a type expression" + [bytes] # error: [invalid-type-form] "List literals are not allowed in this context in a type expression" + ] + ): + reveal_type(c) # revealed: (...) -> Unknown +``` + +## Simple + +A simple `Callable` with multiple parameters and a return type: + +```py +from typing import Callable + +def _(c: Callable[[int, str], int]): + reveal_type(c) # revealed: (int, str, /) -> int +``` + +## Union + +```py +from typing import Callable, Union + +def _( + c: Callable[[Union[int, str]], int] | None, + d: None | Callable[[Union[int, str]], int], + e: None | Callable[[Union[int, str]], int] | int, +): + reveal_type(c) # revealed: ((int | str, /) -> int) | None + reveal_type(d) # revealed: None | ((int | str, /) -> int) + reveal_type(e) # revealed: None | ((int | str, /) -> int) | int +``` + +## Intersection + +```py +from typing import Callable, Union +from ty_extensions import Intersection, Not + +def _( + c: Intersection[Callable[[Union[int, str]], int], int], + d: Intersection[int, Callable[[Union[int, str]], int]], + e: Intersection[int, Callable[[Union[int, str]], int], str], + f: Intersection[Not[Callable[[int, str], Intersection[int, str]]]], +): + reveal_type(c) # revealed: ((int | str, /) -> int) & int + reveal_type(d) # revealed: int & ((int | str, /) -> int) + reveal_type(e) # revealed: int & ((int | str, /) -> int) & str + reveal_type(f) # revealed: ~((int, str, /) -> int & str) +``` + +## Nested + +A nested `Callable` as one of the parameter types: + +```py +from typing import Callable + +def _(c: Callable[[Callable[[int], str]], int]): + reveal_type(c) # revealed: ((int, /) -> str, /) -> int +``` + +And, as the return type: + +```py +def _(c: Callable[[int, str], Callable[[int], int]]): + reveal_type(c) # revealed: (int, str, /) -> (int, /) -> int +``` + +## Gradual form + +The `Callable` special form supports the use of `...` in place of the list of parameter types. This +is a [gradual form] indicating that the type is consistent with any input signature: + +```py +from typing import Callable + +def gradual_form(c: Callable[..., str]): + reveal_type(c) # revealed: (...) -> str +``` + +## Using `typing.Concatenate` + +Using `Concatenate` as the first argument to `Callable`: + +```py +from typing_extensions import Callable, Concatenate + +def _(c: Callable[Concatenate[int, str, ...], int]): + # TODO: Should reveal the correct signature + reveal_type(c) # revealed: (...) -> int +``` + +And, as one of the parameter types: + +```py +def _(c: Callable[[Concatenate[int, str, ...], int], int]): + # TODO: Should reveal the correct signature + reveal_type(c) # revealed: (...) -> int +``` + +## Using `typing.ParamSpec` + +```toml +[environment] +python-version = "3.12" +``` + +Using a `ParamSpec` in a `Callable` annotation: + +```py +from typing_extensions import Callable + +def _[**P1](c: Callable[P1, int]): + reveal_type(P1.args) # revealed: @Todo(ParamSpec) + reveal_type(P1.kwargs) # revealed: @Todo(ParamSpec) + + # TODO: Signature should be (**P1) -> int + reveal_type(c) # revealed: (...) -> int +``` + +And, using the legacy syntax: + +```py +from typing_extensions import ParamSpec + +P2 = ParamSpec("P2") + +# TODO: Not an error; remove once `ParamSpec` is supported +# error: [invalid-type-form] +def _(c: Callable[P2, int]): + reveal_type(c) # revealed: (...) -> Unknown +``` + +## Using `typing.Unpack` + +Using the unpack operator (`*`): + +```py +from typing_extensions import Callable, TypeVarTuple + +Ts = TypeVarTuple("Ts") + +def _(c: Callable[[int, *Ts], int]): + # TODO: Should reveal the correct signature + reveal_type(c) # revealed: (...) -> int +``` + +And, using the legacy syntax using `Unpack`: + +```py +from typing_extensions import Unpack + +def _(c: Callable[[int, Unpack[Ts]], int]): + # TODO: Should reveal the correct signature + reveal_type(c) # revealed: (...) -> int +``` + +## Member lookup + +```py +from typing import Callable + +def _(c: Callable[[int], int]): + reveal_type(c.__init__) # revealed: def __init__(self) -> None + reveal_type(c.__class__) # revealed: type + reveal_type(c.__call__) # revealed: (int, /) -> int +``` + +[gradual form]: https://typing.python.org/en/latest/spec/glossary.html#term-gradual-form diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/deferred.md b/crates/ty_python_semantic/resources/mdtest/annotations/deferred.md new file mode 100644 index 0000000000000..8db8d9040920a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/deferred.md @@ -0,0 +1,179 @@ +# Deferred annotations + +## Deferred annotations in stubs always resolve + +`mod.pyi`: + +```pyi +def get_foo() -> Foo: ... +class Foo: ... +``` + +```py +from mod import get_foo + +reveal_type(get_foo()) # revealed: Foo +``` + +## Deferred annotations in regular code fail + +In (regular) source files, annotations are *not* deferred. This also tests that imports from +`__future__` that are not `annotations` are ignored. + +```py +from __future__ import with_statement as annotations + +# error: [unresolved-reference] +def get_foo() -> Foo: ... + +class Foo: ... + +reveal_type(get_foo()) # revealed: Unknown +``` + +## Deferred annotations in regular code with `__future__.annotations` + +If `__future__.annotations` is imported, annotations *are* deferred. + +```py +from __future__ import annotations + +def get_foo() -> Foo: + return Foo() + +class Foo: ... + +reveal_type(get_foo()) # revealed: Foo +``` + +## Deferred self-reference annotations in a class definition + +```toml +[environment] +python-version = "3.12" +``` + +```py +from __future__ import annotations + +class Foo: + this: Foo + # error: [unresolved-reference] + _ = Foo() + # error: [unresolved-reference] + [Foo for _ in range(1)] + a = int + + def f(self, x: Foo): + reveal_type(x) # revealed: Foo + + def g(self) -> Foo: + _: Foo = self + return self + + class Bar: + foo: Foo + b = int + + def f(self, x: Foo): + return self + # error: [unresolved-reference] + def g(self) -> Bar: + return self + # error: [unresolved-reference] + def h[T: Bar](self): + pass + + class Baz[T: Foo]: + pass + + # error: [unresolved-reference] + type S = a + type T = b + + def h[T: Bar](): + # error: [unresolved-reference] + return Bar() + type Baz = Foo +``` + +## Non-deferred self-reference annotations in a class definition + +```toml +[environment] +python-version = "3.12" +``` + +```py +class Foo: + # error: [unresolved-reference] + this: Foo + ok: "Foo" + # error: [unresolved-reference] + _ = Foo() + # error: [unresolved-reference] + [Foo for _ in range(1)] + a = int + + # error: [unresolved-reference] + def f(self, x: Foo): + reveal_type(x) # revealed: Unknown + # error: [unresolved-reference] + def g(self) -> Foo: + _: Foo = self + return self + + class Bar: + # error: [unresolved-reference] + foo: Foo + b = int + + # error: [unresolved-reference] + def f(self, x: Foo): + return self + # error: [unresolved-reference] + def g(self) -> Bar: + return self + # error: [unresolved-reference] + def h[T: Bar](self): + pass + + class Baz[T: Foo]: + pass + + # error: [unresolved-reference] + type S = a + type T = b + + def h[T: Bar](): + # error: [unresolved-reference] + return Bar() + type Qux = Foo + +def _(): + class C: + # error: [unresolved-reference] + def f(self) -> C: + return self +``` + +## Base class references + +### Not deferred by __future__.annotations + +```py +from __future__ import annotations + +class A(B): # error: [unresolved-reference] + pass + +class B: + pass +``` + +### Deferred in stub files + +```pyi +class A(B): ... +class B: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/int_float_complex.md b/crates/ty_python_semantic/resources/mdtest/annotations/int_float_complex.md new file mode 100644 index 0000000000000..e32bb5d108d21 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/int_float_complex.md @@ -0,0 +1,90 @@ +# Special cases for int/float/complex in annotations + +In order to support common use cases, an annotation of `float` actually means `int | float`, and an +annotation of `complex` actually means `int | float | complex`. See +[the specification](https://typing.python.org/en/latest/spec/special-types.html#special-cases-for-float-and-complex) + +## float + +An annotation of `float` means `int | float`, so `int` is assignable to it: + +```py +def takes_float(x: float): + pass + +def passes_int_to_float(x: int): + # no error! + takes_float(x) +``` + +It also applies to variable annotations: + +```py +def assigns_int_to_float(x: int): + # no error! + y: float = x +``` + +It doesn't work the other way around: + +```py +def takes_int(x: int): + pass + +def passes_float_to_int(x: float): + # error: [invalid-argument-type] + takes_int(x) + +def assigns_float_to_int(x: float): + # error: [invalid-assignment] + y: int = x +``` + +Unlike other type checkers, we choose not to obfuscate this special case by displaying `int | float` +as just `float`; we display the actual type: + +```py +def f(x: float): + reveal_type(x) # revealed: int | float +``` + +## complex + +An annotation of `complex` means `int | float | complex`, so `int` and `float` are both assignable +to it (but not the other way around): + +```py +def takes_complex(x: complex): + pass + +def passes_to_complex(x: float, y: int): + # no errors! + takes_complex(x) + takes_complex(y) + +def assigns_to_complex(x: float, y: int): + # no errors! + a: complex = x + b: complex = y + +def takes_int(x: int): + pass + +def takes_float(x: float): + pass + +def passes_complex(x: complex): + # error: [invalid-argument-type] + takes_int(x) + # error: [invalid-argument-type] + takes_float(x) + +def assigns_complex(x: complex): + # error: [invalid-assignment] + y: int = x + # error: [invalid-assignment] + z: float = x + +def f(x: complex): + reveal_type(x) # revealed: int | float | complex +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/invalid.md b/crates/ty_python_semantic/resources/mdtest/annotations/invalid.md new file mode 100644 index 0000000000000..ed4571330e8f3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/invalid.md @@ -0,0 +1,147 @@ +# Tests for invalid types in type expressions + +## Invalid types are rejected + +Many types are illegal in the context of a type expression: + +```py +import typing +from ty_extensions import AlwaysTruthy, AlwaysFalsy +from typing_extensions import Literal, Never + +class A: ... + +def _( + a: type[int], + b: AlwaysTruthy, + c: AlwaysFalsy, + d: Literal[True], + e: Literal["bar"], + f: Literal[b"foo"], + g: tuple[int, str], + h: Never, + i: int, + j: A, +): + def foo(): ... + def invalid( + a_: a, # error: [invalid-type-form] "Variable of type `type[int]` is not allowed in a type expression" + b_: b, # error: [invalid-type-form] + c_: c, # error: [invalid-type-form] + d_: d, # error: [invalid-type-form] + e_: e, # error: [invalid-type-form] + f_: f, # error: [invalid-type-form] + g_: g, # error: [invalid-type-form] + h_: h, # error: [invalid-type-form] + i_: typing, # error: [invalid-type-form] + j_: foo, # error: [invalid-type-form] + k_: i, # error: [invalid-type-form] "Variable of type `int` is not allowed in a type expression" + l_: j, # error: [invalid-type-form] "Variable of type `A` is not allowed in a type expression" + ): + reveal_type(a_) # revealed: Unknown + reveal_type(b_) # revealed: Unknown + reveal_type(c_) # revealed: Unknown + reveal_type(d_) # revealed: Unknown + reveal_type(e_) # revealed: Unknown + reveal_type(f_) # revealed: Unknown + reveal_type(g_) # revealed: Unknown + reveal_type(h_) # revealed: Unknown + reveal_type(i_) # revealed: Unknown + reveal_type(j_) # revealed: Unknown +``` + +## Invalid AST nodes + +```py +def bar() -> None: + return None + +async def outer(): # avoid unrelated syntax errors on yield, yield from, and await + def _( + a: 1, # error: [invalid-type-form] "Int literals are not allowed in this context in a type expression" + b: 2.3, # error: [invalid-type-form] "Float literals are not allowed in type expressions" + c: 4j, # error: [invalid-type-form] "Complex literals are not allowed in type expressions" + d: True, # error: [invalid-type-form] "Boolean literals are not allowed in this context in a type expression" + e: int | b"foo", # error: [invalid-type-form] "Bytes literals are not allowed in this context in a type expression" + f: 1 and 2, # error: [invalid-type-form] "Boolean operations are not allowed in type expressions" + g: 1 or 2, # error: [invalid-type-form] "Boolean operations are not allowed in type expressions" + h: (foo := 1), # error: [invalid-type-form] "Named expressions are not allowed in type expressions" + i: not 1, # error: [invalid-type-form] "Unary operations are not allowed in type expressions" + j: lambda: 1, # error: [invalid-type-form] "`lambda` expressions are not allowed in type expressions" + k: 1 if True else 2, # error: [invalid-type-form] "`if` expressions are not allowed in type expressions" + l: await 1, # error: [invalid-type-form] "`await` expressions are not allowed in type expressions" + m: (yield 1), # error: [invalid-type-form] "`yield` expressions are not allowed in type expressions" + n: (yield from [1]), # error: [invalid-type-form] "`yield from` expressions are not allowed in type expressions" + o: 1 < 2, # error: [invalid-type-form] "Comparison expressions are not allowed in type expressions" + p: bar(), # error: [invalid-type-form] "Function calls are not allowed in type expressions" + q: int | f"foo", # error: [invalid-type-form] "F-strings are not allowed in type expressions" + r: [1, 2, 3][1:2], # error: [invalid-type-form] "Slices are not allowed in type expressions" + ): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown + reveal_type(d) # revealed: Unknown + reveal_type(e) # revealed: int | Unknown + reveal_type(f) # revealed: Unknown + reveal_type(g) # revealed: Unknown + reveal_type(h) # revealed: Unknown + reveal_type(i) # revealed: Unknown + reveal_type(j) # revealed: Unknown + reveal_type(k) # revealed: Unknown + reveal_type(p) # revealed: Unknown + reveal_type(q) # revealed: int | Unknown + reveal_type(r) # revealed: @Todo(unknown type subscript) +``` + +## Invalid Collection based AST nodes + +```py +def _( + a: {1: 2}, # error: [invalid-type-form] "Dict literals are not allowed in type expressions" + b: {1, 2}, # error: [invalid-type-form] "Set literals are not allowed in type expressions" + c: {k: v for k, v in [(1, 2)]}, # error: [invalid-type-form] "Dict comprehensions are not allowed in type expressions" + d: [k for k in [1, 2]], # error: [invalid-type-form] "List comprehensions are not allowed in type expressions" + e: {k for k in [1, 2]}, # error: [invalid-type-form] "Set comprehensions are not allowed in type expressions" + f: (k for k in [1, 2]), # error: [invalid-type-form] "Generator expressions are not allowed in type expressions" + g: [int, str], # error: [invalid-type-form] "List literals are not allowed in this context in a type expression" +): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown + reveal_type(d) # revealed: Unknown + reveal_type(e) # revealed: Unknown + reveal_type(f) # revealed: Unknown + reveal_type(g) # revealed: Unknown +``` + +## Diagnostics for common errors + +<!-- snapshot-diagnostics --> + +### Module-literal used when you meant to use a class from that module + +It's pretty common in Python to accidentally use a module-literal type in a type expression when you +*meant* to use a class by the same name that comes from that module. We emit a nice subdiagnostic +for this case: + +`foo.py`: + +```py +import datetime + +def f(x: datetime): ... # error: [invalid-type-form] +``` + +`PIL/Image.py`: + +```py +class Image: ... +``` + +`bar.py`: + +```py +from PIL import Image + +def g(x: Image): ... # error: [invalid-type-form] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/literal.md b/crates/ty_python_semantic/resources/mdtest/annotations/literal.md new file mode 100644 index 0000000000000..865bf073f1fdd --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/literal.md @@ -0,0 +1,162 @@ +# Literal + +<https://typing.python.org/en/latest/spec/literal.html#literals> + +## Parameterization + +```py +from typing import Literal +from enum import Enum + +mode: Literal["w", "r"] +a1: Literal[26] +a2: Literal[0x1A] +a3: Literal[-4] +a4: Literal["hello world"] +a5: Literal[b"hello world"] +a6: Literal[True] +a7: Literal[None] +a8: Literal[Literal[1]] + +class Color(Enum): + RED = 0 + GREEN = 1 + BLUE = 2 + +b1: Literal[Color.RED] + +def f(): + reveal_type(mode) # revealed: Literal["w", "r"] + reveal_type(a1) # revealed: Literal[26] + reveal_type(a2) # revealed: Literal[26] + reveal_type(a3) # revealed: Literal[-4] + reveal_type(a4) # revealed: Literal["hello world"] + reveal_type(a5) # revealed: Literal[b"hello world"] + reveal_type(a6) # revealed: Literal[True] + reveal_type(a7) # revealed: None + reveal_type(a8) # revealed: Literal[1] + # TODO: This should be Color.RED + reveal_type(b1) # revealed: @Todo(Attribute access on enum classes) + +# error: [invalid-type-form] +invalid1: Literal[3 + 4] +# error: [invalid-type-form] +invalid2: Literal[4 + 3j] +# error: [invalid-type-form] +invalid3: Literal[(3, 4)] + +hello = "hello" +invalid4: Literal[ + 1 + 2, # error: [invalid-type-form] + "foo", + hello, # error: [invalid-type-form] + (1, 2, 3), # error: [invalid-type-form] +] +``` + +## Shortening unions of literals + +When a Literal is parameterized with more than one value, it’s treated as exactly to equivalent to +the union of those types. + +```py +from typing import Literal + +def x( + a1: Literal[Literal[Literal[1, 2, 3], "foo"], 5, None], + a2: Literal["w"] | Literal["r"], + a3: Literal[Literal["w"], Literal["r"], Literal[Literal["w+"]]], + a4: Literal[True] | Literal[1, 2] | Literal["foo"], +): + reveal_type(a1) # revealed: Literal[1, 2, 3, 5, "foo"] | None + reveal_type(a2) # revealed: Literal["w", "r"] + reveal_type(a3) # revealed: Literal["w", "r", "w+"] + reveal_type(a4) # revealed: Literal[True, 1, 2, "foo"] +``` + +## Display of heterogeneous unions of literals + +```py +from typing import Literal, Union + +def foo(x: int) -> int: + return x + 1 + +def bar(s: str) -> str: + return s + +class A: ... +class B: ... + +def union_example( + x: Union[ + # unknown type + # error: [unresolved-reference] + y, + Literal[-1], + Literal["A"], + Literal[b"A"], + Literal[b"\x00"], + Literal[b"\x07"], + Literal[0], + Literal[1], + Literal["B"], + Literal["foo"], + Literal["bar"], + Literal["B"], + Literal[True], + None, + ], +): + reveal_type(x) # revealed: Unknown | Literal[-1, 0, 1, "A", "B", "foo", "bar", b"A", b"\x00", b"\x07", True] | None +``` + +## Detecting Literal outside typing and typing_extensions + +Only Literal that is defined in typing and typing_extension modules is detected as the special +Literal. + +`other.pyi`: + +```pyi +from typing import _SpecialForm + +Literal: _SpecialForm +``` + +```py +from other import Literal + +# TODO: can we add a subdiagnostic here saying something like: +# +# `other.Literal` and `typing.Literal` have similar names, but are different symbols and don't have the same semantics +# +# ? +# +# error: [invalid-type-form] "Int literals are not allowed in this context in a type expression" +a1: Literal[26] + +def f(): + reveal_type(a1) # revealed: @Todo(unknown type subscript) +``` + +## Detecting typing_extensions.Literal + +```py +from typing_extensions import Literal + +a1: Literal[26] + +def f(): + reveal_type(a1) # revealed: Literal[26] +``` + +## Invalid + +```py +from typing import Literal + +# error: [invalid-type-form] "`typing.Literal` requires at least one argument when used in a type expression" +def _(x: Literal): + reveal_type(x) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/literal_string.md b/crates/ty_python_semantic/resources/mdtest/annotations/literal_string.md new file mode 100644 index 0000000000000..0496dbb4ce402 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/literal_string.md @@ -0,0 +1,152 @@ +# `LiteralString` + +`LiteralString` represents a string that is either defined directly within the source code or is +made up of such components. + +Parts of the testcases defined here were adapted from [the specification's examples][1]. + +## Usages + +### Valid places + +It can be used anywhere a type is accepted: + +```py +from typing_extensions import LiteralString + +x: LiteralString + +def f(): + reveal_type(x) # revealed: LiteralString +``` + +### Within `Literal` + +`LiteralString` cannot be used within `Literal`: + +```py +from typing_extensions import Literal, LiteralString + +bad_union: Literal["hello", LiteralString] # error: [invalid-type-form] +bad_nesting: Literal[LiteralString] # error: [invalid-type-form] +``` + +### Parameterized + +`LiteralString` cannot be parameterized. + +```py +from typing_extensions import LiteralString + +# error: [invalid-type-form] +a: LiteralString[str] + +# error: [invalid-type-form] +# error: [unresolved-reference] "Name `foo` used when not defined" +b: LiteralString["foo"] +``` + +### As a base class + +Subclassing `LiteralString` leads to a runtime error. + +```py +from typing_extensions import LiteralString + +class C(LiteralString): ... # error: [invalid-base] +``` + +## Inference + +### Common operations + +```py +from typing_extensions import LiteralString + +foo: LiteralString = "foo" +reveal_type(foo) # revealed: Literal["foo"] + +bar: LiteralString = "bar" +reveal_type(foo + bar) # revealed: Literal["foobar"] + +baz: LiteralString = "baz" +baz += foo +reveal_type(baz) # revealed: Literal["bazfoo"] + +qux = (foo, bar) +reveal_type(qux) # revealed: tuple[Literal["foo"], Literal["bar"]] + +reveal_type(foo.join(qux)) # revealed: LiteralString + +template: LiteralString = "{}, {}" +reveal_type(template) # revealed: Literal["{}, {}"] +reveal_type(template.format(foo, bar)) # revealed: LiteralString +``` + +### Assignability + +`Literal[""]` is assignable to `LiteralString`, and `LiteralString` is assignable to `str`, but not +vice versa. + +```py +from typing_extensions import Literal, LiteralString + +def _(flag: bool): + foo_1: Literal["foo"] = "foo" + bar_1: LiteralString = foo_1 # fine + + foo_2 = "foo" if flag else "bar" + reveal_type(foo_2) # revealed: Literal["foo", "bar"] + bar_2: LiteralString = foo_2 # fine + + foo_3: LiteralString = "foo" * 1_000_000_000 + bar_3: str = foo_2 # fine + + baz_1: str = repr(object()) + qux_1: LiteralString = baz_1 # error: [invalid-assignment] + + baz_2: LiteralString = "baz" * 1_000_000_000 + qux_2: Literal["qux"] = baz_2 # error: [invalid-assignment] + + baz_3 = "foo" if flag else 1 + reveal_type(baz_3) # revealed: Literal["foo", 1] + qux_3: LiteralString = baz_3 # error: [invalid-assignment] +``` + +### Narrowing + +```py +from typing_extensions import LiteralString + +lorem: LiteralString = "lorem" * 1_000_000_000 + +reveal_type(lorem) # revealed: LiteralString + +if lorem == "ipsum": + reveal_type(lorem) # revealed: Literal["ipsum"] + +reveal_type(lorem) # revealed: LiteralString + +if "" < lorem == "ipsum": + reveal_type(lorem) # revealed: Literal["ipsum"] +``` + +## `typing.LiteralString` + +`typing.LiteralString` is only available in Python 3.11 and later: + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import LiteralString + +x: LiteralString = "foo" + +def f(): + reveal_type(x) # revealed: LiteralString +``` + +[1]: https://typing.python.org/en/latest/spec/literal.html#literalstring diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/never.md b/crates/ty_python_semantic/resources/mdtest/annotations/never.md new file mode 100644 index 0000000000000..81efd2d864ed1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/never.md @@ -0,0 +1,75 @@ +# NoReturn & Never + +`NoReturn` is used to annotate the return type for functions that never return. `Never` is the +bottom type, representing the empty set of Python objects. These two annotations can be used +interchangeably. + +## Function Return Type Annotation + +```py +from typing import NoReturn + +def stop() -> NoReturn: + raise RuntimeError("no way") + +# revealed: Never +reveal_type(stop()) +``` + +## Assignment + +```py +from typing_extensions import NoReturn, Never, Any + +# error: [invalid-type-form] "Type `typing.Never` expected no type parameter" +x: Never[int] +a1: NoReturn +a2: Never +b1: Any +b2: int + +def f(): + # revealed: Never + reveal_type(a1) + # revealed: Never + reveal_type(a2) + + # Never is assignable to all types. + v1: int = a1 + v2: str = a1 + # Other types are not assignable to Never except for Never (and Any). + v3: Never = b1 + v4: Never = a2 + v5: Any = b2 + # error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to `Never`" + v6: Never = 1 +``` + +## `typing.Never` + +`typing.Never` is only available in Python 3.11 and later. + +### Python 3.11 + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Never + +reveal_type(Never) # revealed: typing.Never +``` + +### Python 3.10 + +```toml +[environment] +python-version = "3.10" +``` + +```py +# error: [unresolved-import] +from typing import Never +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/new_types.md b/crates/ty_python_semantic/resources/mdtest/annotations/new_types.md new file mode 100644 index 0000000000000..5dc14964ccb73 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/new_types.md @@ -0,0 +1,24 @@ +# NewType + +Currently, ty doesn't support `typing.NewType` in type annotations. + +## Valid forms + +```py +from typing_extensions import NewType +from types import GenericAlias + +X = GenericAlias(type, ()) +A = NewType("A", int) +# TODO: typeshed for `typing.GenericAlias` uses `type` for the first argument. `NewType` should be special-cased +# to be compatible with `type` +# error: [invalid-argument-type] "Argument to function `__new__` is incorrect: Expected `type`, found `NewType`" +B = GenericAlias(A, ()) + +def _( + a: A, + b: B, +): + reveal_type(a) # revealed: @Todo(Support for `typing.NewType` instances in type expressions) + reveal_type(b) # revealed: @Todo(Support for `typing.GenericAlias` instances in type expressions) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/optional.md b/crates/ty_python_semantic/resources/mdtest/annotations/optional.md new file mode 100644 index 0000000000000..654c88b19908b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/optional.md @@ -0,0 +1,57 @@ +# Optional + +## Annotation + +`typing.Optional` is equivalent to using the type with a None in a Union. + +```py +from typing import Optional + +a: Optional[int] +a1: Optional[bool] +a2: Optional[Optional[bool]] +a3: Optional[None] + +def f(): + # revealed: int | None + reveal_type(a) + # revealed: bool | None + reveal_type(a1) + # revealed: bool | None + reveal_type(a2) + # revealed: None + reveal_type(a3) +``` + +## Assignment + +```py +from typing import Optional + +a: Optional[int] = 1 +a = None +# error: [invalid-assignment] "Object of type `Literal[""]` is not assignable to `int | None`" +a = "" +``` + +## Typing Extensions + +```py +from typing_extensions import Optional + +a: Optional[int] + +def f(): + # revealed: int | None + reveal_type(a) +``` + +## Invalid + +```py +from typing import Optional + +# error: [invalid-type-form] "`typing.Optional` requires exactly one argument when used in a type expression" +def f(x: Optional) -> None: + reveal_type(x) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/self.md b/crates/ty_python_semantic/resources/mdtest/annotations/self.md new file mode 100644 index 0000000000000..8a99fac64c860 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/self.md @@ -0,0 +1,207 @@ +# Self + +`Self` is treated as if it were a `TypeVar` bound to the class it's being used on. + +`typing.Self` is only available in Python 3.11 and later. + +## Methods + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self + +class Shape: + def set_scale(self: Self, scale: float) -> Self: + reveal_type(self) # revealed: Self + return self + + def nested_type(self: Self) -> list[Self]: + return [self] + + def nested_func(self: Self) -> Self: + def inner() -> Self: + reveal_type(self) # revealed: Self + return self + return inner() + + def implicit_self(self) -> Self: + # TODO: first argument in a method should be considered as "typing.Self" + reveal_type(self) # revealed: Unknown + return self + +reveal_type(Shape().nested_type()) # revealed: list[Shape] +reveal_type(Shape().nested_func()) # revealed: Shape + +class Circle(Shape): + def set_scale(self: Self, scale: float) -> Self: + reveal_type(self) # revealed: Self + return self + +class Outer: + class Inner: + def foo(self: Self) -> Self: + reveal_type(self) # revealed: Self + return self +``` + +## typing_extensions + +```toml +[environment] +python-version = "3.10" +``` + +```py +from typing_extensions import Self + +class C: + def method(self: Self) -> Self: + return self + +reveal_type(C().method()) # revealed: C +``` + +## Class Methods + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self, TypeVar + +class Shape: + def foo(self: Self) -> Self: + return self + + @classmethod + def bar(cls: type[Self]) -> Self: + # TODO: type[Shape] + reveal_type(cls) # revealed: @Todo(unsupported type[X] special form) + return cls() + +class Circle(Shape): ... + +reveal_type(Shape().foo()) # revealed: Shape +# TODO: Shape +reveal_type(Shape.bar()) # revealed: Unknown +``` + +## Attributes + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self + +class LinkedList: + value: int + next_node: Self + + def next(self: Self) -> Self: + reveal_type(self.value) # revealed: int + return self.next_node + +reveal_type(LinkedList().next()) # revealed: LinkedList +``` + +## Generic Classes + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self, Generic, TypeVar + +T = TypeVar("T") + +class Container(Generic[T]): + value: T + def set_value(self: Self, value: T) -> Self: + return self + +int_container: Container[int] = Container[int]() +reveal_type(int_container) # revealed: Container[int] +reveal_type(int_container.set_value(1)) # revealed: Container[int] +``` + +## Protocols + +TODO: <https://typing.python.org/en/latest/spec/generics.html#use-in-protocols> + +## Annotations + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self + +class Shape: + def union(self: Self, other: Self | None): + reveal_type(other) # revealed: Self | None + return self +``` + +## Invalid Usage + +`Self` cannot be used in the signature of a function or variable. + +```toml +[environment] +python-version = "3.11" +``` + +```py +from typing import Self, Generic, TypeVar + +T = TypeVar("T") + +# error: [invalid-type-form] +def x(s: Self): ... + +# error: [invalid-type-form] +b: Self + +# TODO: "Self" cannot be used in a function with a `self` or `cls` parameter that has a type annotation other than "Self" +class Foo: + # TODO: rejected Self because self has a different type + def has_existing_self_annotation(self: T) -> Self: + return self # error: [invalid-return-type] + + def return_concrete_type(self) -> Self: + # TODO: tell user to use "Foo" instead of "Self" + # error: [invalid-return-type] + return Foo() + + @staticmethod + # TODO: reject because of staticmethod + def make() -> Self: + # error: [invalid-return-type] + return Foo() + +class Bar(Generic[T]): + foo: T + def bar(self) -> T: + return self.foo + +# error: [invalid-type-form] +class Baz(Bar[Self]): ... + +class MyMetaclass(type): + # TODO: rejected + def __new__(cls) -> Self: + return super().__new__(cls) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/starred.md b/crates/ty_python_semantic/resources/mdtest/annotations/starred.md new file mode 100644 index 0000000000000..3bb3de68bf7db --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/starred.md @@ -0,0 +1,22 @@ +# Starred expression annotations + +```toml +[environment] +python-version = "3.11" +``` + +Type annotations for `*args` can be starred expressions themselves: + +```py +from typing_extensions import TypeVarTuple + +Ts = TypeVarTuple("Ts") + +def append_int(*args: *Ts) -> tuple[*Ts, int]: + reveal_type(args) # revealed: @Todo(PEP 646) + + return (*args, 1) + +# TODO should be tuple[Literal[True], Literal["a"], int] +reveal_type(append_int(True, "a")) # revealed: @Todo(PEP 646) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/stdlib_typing_aliases.md b/crates/ty_python_semantic/resources/mdtest/annotations/stdlib_typing_aliases.md new file mode 100644 index 0000000000000..94d6a9ec7fe81 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/stdlib_typing_aliases.md @@ -0,0 +1,135 @@ +# Typing-module aliases to other stdlib classes + +The `typing` module has various aliases to other stdlib classes. These are a legacy feature, but +still need to be supported by a type checker. + +## Correspondence + +All of the following symbols can be mapped one-to-one with the actual type: + +```py +import typing + +def f( + list_bare: typing.List, + list_parametrized: typing.List[int], + dict_bare: typing.Dict, + dict_parametrized: typing.Dict[int, str], + set_bare: typing.Set, + set_parametrized: typing.Set[int], + frozen_set_bare: typing.FrozenSet, + frozen_set_parametrized: typing.FrozenSet[str], + chain_map_bare: typing.ChainMap, + chain_map_parametrized: typing.ChainMap[str, int], + counter_bare: typing.Counter, + counter_parametrized: typing.Counter[int], + default_dict_bare: typing.DefaultDict, + default_dict_parametrized: typing.DefaultDict[str, int], + deque_bare: typing.Deque, + deque_parametrized: typing.Deque[str], + ordered_dict_bare: typing.OrderedDict, + ordered_dict_parametrized: typing.OrderedDict[int, str], +): + reveal_type(list_bare) # revealed: list[Unknown] + # TODO: revealed: list[int] + reveal_type(list_parametrized) # revealed: list[Unknown] + + reveal_type(dict_bare) # revealed: dict[Unknown, Unknown] + # TODO: revealed: dict[int, str] + reveal_type(dict_parametrized) # revealed: dict[Unknown, Unknown] + + reveal_type(set_bare) # revealed: set[Unknown] + # TODO: revealed: set[int] + reveal_type(set_parametrized) # revealed: set[Unknown] + + # TODO: revealed: frozenset[Unknown] + reveal_type(frozen_set_bare) # revealed: frozenset[Unknown] + # TODO: revealed: frozenset[str] + reveal_type(frozen_set_parametrized) # revealed: frozenset[Unknown] + + reveal_type(chain_map_bare) # revealed: ChainMap[Unknown, Unknown] + # TODO: revealed: ChainMap[str, int] + reveal_type(chain_map_parametrized) # revealed: ChainMap[Unknown, Unknown] + + reveal_type(counter_bare) # revealed: Counter[Unknown] + # TODO: revealed: Counter[int] + reveal_type(counter_parametrized) # revealed: Counter[Unknown] + + reveal_type(default_dict_bare) # revealed: defaultdict[Unknown, Unknown] + # TODO: revealed: defaultdict[str, int] + reveal_type(default_dict_parametrized) # revealed: defaultdict[Unknown, Unknown] + + reveal_type(deque_bare) # revealed: deque[Unknown] + # TODO: revealed: deque[str] + reveal_type(deque_parametrized) # revealed: deque[Unknown] + + reveal_type(ordered_dict_bare) # revealed: OrderedDict[Unknown, Unknown] + # TODO: revealed: OrderedDict[int, str] + reveal_type(ordered_dict_parametrized) # revealed: OrderedDict[Unknown, Unknown] +``` + +## Inheritance + +The aliases can be inherited from. Some of these are still partially or wholly TODOs. + +```py +import typing + +#################### +### Built-ins +#################### + +class ListSubclass(typing.List): ... + +# revealed: tuple[<class 'ListSubclass'>, <class 'list[Unknown]'>, <class 'MutableSequence[Unknown]'>, <class 'Sequence[Unknown]'>, <class 'Reversible[Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(ListSubclass.__mro__) + +class DictSubclass(typing.Dict): ... + +# TODO: should not have multiple `Generic[]` elements +# revealed: tuple[<class 'DictSubclass'>, <class 'dict[Unknown, Unknown]'>, <class 'MutableMapping[Unknown, Unknown]'>, <class 'Mapping[Unknown, Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], typing.Generic[_KT, _VT_co], <class 'object'>] +reveal_type(DictSubclass.__mro__) + +class SetSubclass(typing.Set): ... + +# revealed: tuple[<class 'SetSubclass'>, <class 'set[Unknown]'>, <class 'MutableSet[Unknown]'>, <class 'AbstractSet[Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(SetSubclass.__mro__) + +class FrozenSetSubclass(typing.FrozenSet): ... + +# revealed: tuple[<class 'FrozenSetSubclass'>, <class 'frozenset[Unknown]'>, <class 'AbstractSet[Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(FrozenSetSubclass.__mro__) + +#################### +### `collections` +#################### + +class ChainMapSubclass(typing.ChainMap): ... + +# TODO: should not have multiple `Generic[]` elements +# revealed: tuple[<class 'ChainMapSubclass'>, <class 'ChainMap[Unknown, Unknown]'>, <class 'MutableMapping[Unknown, Unknown]'>, <class 'Mapping[Unknown, Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], typing.Generic[_KT, _VT_co], <class 'object'>] +reveal_type(ChainMapSubclass.__mro__) + +class CounterSubclass(typing.Counter): ... + +# TODO: Should have one `Generic[]` element, not three(!) +# revealed: tuple[<class 'CounterSubclass'>, <class 'Counter[Unknown]'>, <class 'dict[Unknown, int]'>, <class 'MutableMapping[Unknown, int]'>, <class 'Mapping[Unknown, int]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], typing.Generic[_KT, _VT_co], typing.Generic[_T], <class 'object'>] +reveal_type(CounterSubclass.__mro__) + +class DefaultDictSubclass(typing.DefaultDict): ... + +# TODO: Should not have multiple `Generic[]` elements +# revealed: tuple[<class 'DefaultDictSubclass'>, <class 'defaultdict[Unknown, Unknown]'>, <class 'dict[Unknown, Unknown]'>, <class 'MutableMapping[Unknown, Unknown]'>, <class 'Mapping[Unknown, Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], typing.Generic[_KT, _VT_co], <class 'object'>] +reveal_type(DefaultDictSubclass.__mro__) + +class DequeSubclass(typing.Deque): ... + +# revealed: tuple[<class 'DequeSubclass'>, <class 'deque[Unknown]'>, <class 'MutableSequence[Unknown]'>, <class 'Sequence[Unknown]'>, <class 'Reversible[Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(DequeSubclass.__mro__) + +class OrderedDictSubclass(typing.OrderedDict): ... + +# TODO: Should not have multiple `Generic[]` elements +# revealed: tuple[<class 'OrderedDictSubclass'>, <class 'OrderedDict[Unknown, Unknown]'>, <class 'dict[Unknown, Unknown]'>, <class 'MutableMapping[Unknown, Unknown]'>, <class 'Mapping[Unknown, Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], typing.Generic[_KT, _VT_co], <class 'object'>] +reveal_type(OrderedDictSubclass.__mro__) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/string.md b/crates/ty_python_semantic/resources/mdtest/annotations/string.md new file mode 100644 index 0000000000000..f44c000855ea6 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/string.md @@ -0,0 +1,212 @@ +# String annotations + +## Simple + +```py +def f(v: "int"): + reveal_type(v) # revealed: int +``` + +## Nested + +```py +def f(v: "'int'"): + reveal_type(v) # revealed: int +``` + +## Type expression + +```py +def f1(v: "int | str", w: "tuple[int, str]"): + reveal_type(v) # revealed: int | str + reveal_type(w) # revealed: tuple[int, str] +``` + +## Partial + +```py +def f(v: tuple[int, "str"]): + reveal_type(v) # revealed: tuple[int, str] +``` + +## Deferred + +```py +def f(v: "Foo"): + reveal_type(v) # revealed: Foo + +class Foo: ... +``` + +## Deferred (undefined) + +```py +# error: [unresolved-reference] +def f(v: "Foo"): + reveal_type(v) # revealed: Unknown +``` + +## Partial deferred + +```py +def f(v: int | "Foo"): + reveal_type(v) # revealed: int | Foo + +class Foo: ... +``` + +## `typing.Literal` + +```py +from typing import Literal + +def f1(v: Literal["Foo", "Bar"], w: 'Literal["Foo", "Bar"]'): + reveal_type(v) # revealed: Literal["Foo", "Bar"] + reveal_type(w) # revealed: Literal["Foo", "Bar"] + +class Foo: ... +``` + +## Various string kinds + +```py +def f1( + # error: [raw-string-type-annotation] "Type expressions cannot use raw string literal" + a: r"int", + # error: [fstring-type-annotation] "Type expressions cannot use f-strings" + b: f"int", + # error: [byte-string-type-annotation] "Type expressions cannot use bytes literal" + c: b"int", + d: "int", + # error: [implicit-concatenated-string-type-annotation] "Type expressions cannot span multiple string literals" + e: "in" "t", + # error: [escape-character-in-forward-annotation] "Type expressions cannot contain escape characters" + f: "\N{LATIN SMALL LETTER I}nt", + # error: [escape-character-in-forward-annotation] "Type expressions cannot contain escape characters" + g: "\x69nt", + h: """int""", + # error: [byte-string-type-annotation] "Type expressions cannot use bytes literal" + i: "b'int'", +): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown + reveal_type(d) # revealed: int + reveal_type(e) # revealed: Unknown + reveal_type(f) # revealed: Unknown + reveal_type(g) # revealed: Unknown + reveal_type(h) # revealed: int + reveal_type(i) # revealed: Unknown +``` + +## Various string kinds in `typing.Literal` + +```py +from typing import Literal + +def f(v: Literal["a", r"b", b"c", "d" "e", "\N{LATIN SMALL LETTER F}", "\x67", """h"""]): + reveal_type(v) # revealed: Literal["a", "b", "de", "f", "g", "h", b"c"] +``` + +## Class variables + +```py +MyType = int + +class Aliases: + MyType = str + + forward: "MyType" = "value" + not_forward: MyType = "value" + +reveal_type(Aliases.forward) # revealed: str +reveal_type(Aliases.not_forward) # revealed: str +``` + +## Annotated assignment + +```py +a: "int" = 1 +b: "'int'" = 1 +c: "Foo" +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to `Foo`" +d: "Foo" = 1 + +class Foo: ... + +c = Foo() + +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[1] +reveal_type(c) # revealed: Foo +reveal_type(d) # revealed: Foo +``` + +## Parameter + +TODO: Add tests once parameter inference is supported + +## Invalid expressions + +The expressions in these string annotations aren't valid expressions in this context but we +shouldn't panic. + +```py +a: "1 or 2" +b: "(x := 1)" +c: "1 + 2" +d: "lambda x: x" +e: "x if True else y" +f: "{'a': 1, 'b': 2}" +g: "{1, 2}" +h: "[i for i in range(5)]" +i: "{i for i in range(5)}" +j: "{i: i for i in range(5)}" +k: "(i for i in range(5))" +l: "await 1" +# error: [invalid-syntax-in-forward-annotation] +m: "yield 1" +# error: [invalid-syntax-in-forward-annotation] +n: "yield from 1" +o: "1 < 2" +p: "call()" +r: "[1, 2]" +s: "(1, 2)" +``` + +## Multi line annotation + +Quoted type annotations should be parsed as if surrounded by parentheses. + +```py +def valid( + a1: """( + int | + str + ) + """, + a2: """ + int | + str + """, +): + reveal_type(a1) # revealed: int | str + reveal_type(a2) # revealed: int | str + +def invalid( + # error: [invalid-syntax-in-forward-annotation] + a1: """ + int | +str) +""", + # error: [invalid-syntax-in-forward-annotation] + a2: """ + int) | +str +""", + # error: [invalid-syntax-in-forward-annotation] + a3: """ + (int)) """, +): + pass +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/union.md b/crates/ty_python_semantic/resources/mdtest/annotations/union.md new file mode 100644 index 0000000000000..e4d47a3a94e81 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/union.md @@ -0,0 +1,88 @@ +# Union + +## Annotation + +`typing.Union` can be used to construct union types in the same way as the `|` operator. + +```py +from typing import Union + +a: Union[int, str] +a1: Union[int, bool] +a2: Union[int, Union[bytes, str]] +a3: Union[int, None] +a4: Union[Union[bytes, str]] +a5: Union[int] +a6: Union[()] + +def f(): + # revealed: int | str + reveal_type(a) + # Since bool is a subtype of int we simplify to int here. But we do allow assigning boolean values (see below). + # revealed: int + reveal_type(a1) + # revealed: int | bytes | str + reveal_type(a2) + # revealed: int | None + reveal_type(a3) + # revealed: bytes | str + reveal_type(a4) + # revealed: int + reveal_type(a5) + # revealed: Never + reveal_type(a6) +``` + +## Assignment + +```py +from typing import Union + +a: Union[int, str] +a = 1 +a = "" +a1: Union[int, bool] +a1 = 1 +a1 = True +# error: [invalid-assignment] "Object of type `Literal[b""]` is not assignable to `int | str`" +a = b"" +``` + +## Typing Extensions + +```py +from typing_extensions import Union + +a: Union[int, str] + +def f(): + # revealed: int | str + reveal_type(a) +``` + +## Invalid + +```py +from typing import Union + +# error: [invalid-type-form] "`typing.Union` requires at least one argument when used in a type expression" +def f(x: Union) -> None: + reveal_type(x) # revealed: Unknown +``` + +## Implicit type aliases using new-style unions + +We don't recognise these as type aliases yet, but we also don't emit false-positive diagnostics if +you use them in type expressions: + +```toml +[environment] +python-version = "3.10" +``` + +```py +X = int | str + +def f(y: X): + reveal_type(y) # revealed: @Todo(Support for `types.UnionType` instances in type expressions) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_forms.md b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_forms.md new file mode 100644 index 0000000000000..3887d9bb8455e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_forms.md @@ -0,0 +1,98 @@ +# Unsupported special forms + +## Not yet supported + +Several special forms are unsupported by ty currently. However, we also don't emit false-positive +errors if you use one in an annotation: + +```py +from typing_extensions import Self, TypeVarTuple, Unpack, TypeGuard, TypeIs, Concatenate, ParamSpec, TypeAlias, Callable, TypeVar + +P = ParamSpec("P") +Ts = TypeVarTuple("Ts") +R_co = TypeVar("R_co", covariant=True) + +Alias: TypeAlias = int + +def f(*args: Unpack[Ts]) -> tuple[Unpack[Ts]]: + reveal_type(args) # revealed: tuple[@Todo(`Unpack[]` special form), ...] + reveal_type(Alias) # revealed: @Todo(Support for `typing.TypeAlias`) + +def g() -> TypeGuard[int]: ... +def h() -> TypeIs[int]: ... +def i(callback: Callable[Concatenate[int, P], R_co], *args: P.args, **kwargs: P.kwargs) -> R_co: + reveal_type(args) # revealed: tuple[@Todo(Support for `typing.ParamSpec`), ...] + reveal_type(kwargs) # revealed: dict[str, @Todo(Support for `typing.ParamSpec`)] + return callback(42, *args, **kwargs) + +class Foo: + def method(self, x: Self): + reveal_type(x) # revealed: Self +``` + +## Type expressions + +One thing that is supported is error messages for using special forms in type expressions. + +```py +from typing_extensions import Unpack, TypeGuard, TypeIs, Concatenate, ParamSpec, Generic + +def _( + a: Unpack, # error: [invalid-type-form] "`typing.Unpack` requires exactly one argument when used in a type expression" + b: TypeGuard, # error: [invalid-type-form] "`typing.TypeGuard` requires exactly one argument when used in a type expression" + c: TypeIs, # error: [invalid-type-form] "`typing.TypeIs` requires exactly one argument when used in a type expression" + d: Concatenate, # error: [invalid-type-form] "`typing.Concatenate` requires at least two arguments when used in a type expression" + e: ParamSpec, + f: Generic, # error: [invalid-type-form] "`typing.Generic` is not allowed in type expressions" +) -> None: + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown + reveal_type(d) # revealed: Unknown + + def foo(a_: e) -> None: + reveal_type(a_) # revealed: @Todo(Support for `typing.ParamSpec`) +``` + +## Inheritance + +You can't inherit from most of these. `typing.Callable` is an exception. + +```py +from typing import Callable +from typing_extensions import Self, Unpack, TypeGuard, TypeIs, Concatenate, Generic + +class A(Self): ... # error: [invalid-base] +class B(Unpack): ... # error: [invalid-base] +class C(TypeGuard): ... # error: [invalid-base] +class D(TypeIs): ... # error: [invalid-base] +class E(Concatenate): ... # error: [invalid-base] +class F(Callable): ... +class G(Generic): ... # error: [invalid-base] "Cannot inherit from plain `Generic`" + +reveal_type(F.__mro__) # revealed: tuple[<class 'F'>, @Todo(Support for Callable as a base class), <class 'object'>] +``` + +## Subscriptability + +```toml +[environment] +python-version = "3.12" +``` + +Some of these are not subscriptable: + +```py +from typing_extensions import Self, TypeAlias, TypeVar + +T = TypeVar("T") + +# error: [invalid-type-form] "Special form `typing.TypeAlias` expected no type parameter" +X: TypeAlias[T] = int + +class Foo[T]: + # error: [invalid-type-form] "Special form `typing.Self` expected no type parameter" + # error: [invalid-type-form] "Special form `typing.Self` expected no type parameter" + def method(self: Self[int]) -> Self[int]: + reveal_type(self) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_types.md b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_types.md new file mode 100644 index 0000000000000..dc22ac2539cb7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_special_types.md @@ -0,0 +1,18 @@ +# Unsupported special types + +We do not understand the functional syntax for creating `NamedTuple`s, `TypedDict`s or `Enum`s yet. +But we also do not emit false positives when these are used in type expressions. + +```py +import collections +import enum +import typing + +MyEnum = enum.Enum("MyEnum", ["foo", "bar", "baz"]) +MyIntEnum = enum.IntEnum("MyIntEnum", ["foo", "bar", "baz"]) +MyTypedDict = typing.TypedDict("MyTypedDict", {"foo": int}) +MyNamedTuple1 = typing.NamedTuple("MyNamedTuple1", [("foo", int)]) +MyNamedTuple2 = collections.namedtuple("MyNamedTuple2", ["foo"]) + +def f(a: MyEnum, b: MyTypedDict, c: MyNamedTuple1, d: MyNamedTuple2): ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_type_qualifiers.md b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_type_qualifiers.md new file mode 100644 index 0000000000000..271b6fd014c3c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/annotations/unsupported_type_qualifiers.md @@ -0,0 +1,59 @@ +# Unsupported type qualifiers + +## Not yet fully supported + +Several type qualifiers are unsupported by ty currently. However, we also don't emit false-positive +errors if you use one in an annotation: + +```py +from typing_extensions import Final, Required, NotRequired, ReadOnly, TypedDict + +X: Final = 42 +Y: Final[int] = 42 + +class Bar(TypedDict): + x: Required[int] + y: NotRequired[str] + z: ReadOnly[bytes] +``` + +## Type expressions + +One thing that is supported is error messages for using type qualifiers in type expressions. + +```py +from typing_extensions import Final, ClassVar, Required, NotRequired, ReadOnly + +def _( + a: ( + Final # error: [invalid-type-form] "Type qualifier `typing.Final` is not allowed in type expressions (only in annotation expressions)" + | int + ), + b: ( + ClassVar # error: [invalid-type-form] "Type qualifier `typing.ClassVar` is not allowed in type expressions (only in annotation expressions)" + | int + ), + c: Required, # error: [invalid-type-form] "Type qualifier `typing.Required` is not allowed in type expressions (only in annotation expressions, and only with exactly one argument)" + d: NotRequired, # error: [invalid-type-form] "Type qualifier `typing.NotRequired` is not allowed in type expressions (only in annotation expressions, and only with exactly one argument)" + e: ReadOnly, # error: [invalid-type-form] "Type qualifier `typing.ReadOnly` is not allowed in type expressions (only in annotation expressions, and only with exactly one argument)" +) -> None: + reveal_type(a) # revealed: Unknown | int + reveal_type(b) # revealed: Unknown | int + reveal_type(c) # revealed: Unknown + reveal_type(d) # revealed: Unknown + reveal_type(e) # revealed: Unknown +``` + +## Inheritance + +You can't inherit from a type qualifier. + +```py +from typing_extensions import Final, ClassVar, Required, NotRequired, ReadOnly + +class A(Final): ... # error: [invalid-base] +class B(ClassVar): ... # error: [invalid-base] +class C(Required): ... # error: [invalid-base] +class D(NotRequired): ... # error: [invalid-base] +class E(ReadOnly): ... # error: [invalid-base] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/assignment/annotations.md b/crates/ty_python_semantic/resources/mdtest/assignment/annotations.md new file mode 100644 index 0000000000000..91d945436405f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/assignment/annotations.md @@ -0,0 +1,164 @@ +# Assignment with annotations + +## Annotation only transparent to local inference + +```py +x = 1 +x: int +y = x + +reveal_type(y) # revealed: Literal[1] +``` + +## Violates own annotation + +```py +x: int = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]` is not assignable to `int`" +``` + +## Violates previous annotation + +```py +x: int +x = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]` is not assignable to `int`" +``` + +## Tuple annotations are understood + +```toml +[environment] +python-version = "3.12" +``` + +`module.py`: + +```py +from typing_extensions import Unpack + +a: tuple[()] = () +b: tuple[int] = (42,) +c: tuple[str, int] = ("42", 42) +d: tuple[tuple[str, str], tuple[int, int]] = (("foo", "foo"), (42, 42)) +e: tuple[str, ...] = () +f: tuple[str, *tuple[int, ...], bytes] = ("42", b"42") +g: tuple[str, Unpack[tuple[int, ...]], bytes] = ("42", b"42") +h: tuple[list[int], list[int]] = ([], []) +i: tuple[str | int, str | int] = (42, 42) +j: tuple[str | int] = (42,) +``` + +`script.py`: + +```py +from module import a, b, c, d, e, f, g, h, i, j + +reveal_type(a) # revealed: tuple[()] +reveal_type(b) # revealed: tuple[int] +reveal_type(c) # revealed: tuple[str, int] +reveal_type(d) # revealed: tuple[tuple[str, str], tuple[int, int]] +reveal_type(e) # revealed: tuple[str, ...] + +reveal_type(f) # revealed: @Todo(PEP 646) +reveal_type(g) # revealed: @Todo(PEP 646) + +reveal_type(h) # revealed: tuple[list[int], list[int]] +reveal_type(i) # revealed: tuple[str | int, str | int] +reveal_type(j) # revealed: tuple[str | int] +``` + +## Incorrect tuple assignments are complained about + +```py +# error: [invalid-assignment] "Object of type `tuple[Literal[1], Literal[2]]` is not assignable to `tuple[()]`" +a: tuple[()] = (1, 2) + +# error: [invalid-assignment] "Object of type `tuple[Literal["foo"]]` is not assignable to `tuple[int]`" +b: tuple[int] = ("foo",) + +# error: [invalid-assignment] "Object of type `tuple[list[Unknown], Literal["foo"]]` is not assignable to `tuple[str | int, str]`" +c: tuple[str | int, str] = ([], "foo") +``` + +## PEP-604 annotations are supported + +```py +def foo(v: str | int | None, w: str | str | None, x: str | str): + reveal_type(v) # revealed: str | int | None + reveal_type(w) # revealed: str | None + reveal_type(x) # revealed: str +``` + +## PEP-604 in non-type-expression context + +### In Python 3.10 and later + +```toml +[environment] +python-version = "3.10" +``` + +```py +IntOrStr = int | str +``` + +### Earlier versions + +<!-- snapshot-diagnostics --> + +```toml +[environment] +python-version = "3.9" +``` + +```py +# error: [unsupported-operator] +IntOrStr = int | str +``` + +## Attribute expressions in type annotations are understood + +```py +import builtins + +int = "foo" +a: builtins.int = 42 + +# error: [invalid-assignment] "Object of type `Literal["bar"]` is not assignable to `int`" +b: builtins.int = "bar" + +c: builtins.tuple[builtins.tuple[builtins.int, builtins.int], builtins.int] = ((42, 42), 42) + +# error: [invalid-assignment] "Object of type `Literal["foo"]` is not assignable to `tuple[tuple[int, int], int]`" +c: builtins.tuple[builtins.tuple[builtins.int, builtins.int], builtins.int] = "foo" +``` + +## Future annotations are deferred + +```py +from __future__ import annotations + +x: Foo + +class Foo: ... + +x = Foo() +reveal_type(x) # revealed: Foo +``` + +## Annotations in stub files are deferred + +```pyi +x: Foo + +class Foo: ... + +x = Foo() +reveal_type(x) # revealed: Foo +``` + +## Annotated assignments in stub files are inferred correctly + +```pyi +x: int = 1 +reveal_type(x) # revealed: Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/assignment/augmented.md b/crates/ty_python_semantic/resources/mdtest/assignment/augmented.md new file mode 100644 index 0000000000000..ceac281fff835 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/assignment/augmented.md @@ -0,0 +1,182 @@ +# Augmented assignment + +## Basic + +```py +x = 3 +x -= 1 +reveal_type(x) # revealed: Literal[2] + +x = 1.0 +x /= 2 +reveal_type(x) # revealed: int | float + +x = (1, 2) +x += (3, 4) +reveal_type(x) # revealed: tuple[Literal[1], Literal[2], Literal[3], Literal[4]] +``` + +## Dunder methods + +```py +class C: + def __isub__(self, other: int) -> str: + return "Hello, world!" + +x = C() +x -= 1 +reveal_type(x) # revealed: str + +class C: + def __iadd__(self, other: str) -> int: + return 1 + +x = C() +x += "Hello" +reveal_type(x) # revealed: int +``` + +## Unsupported types + +```py +class C: + def __isub__(self, other: str) -> int: + return 42 + +x = C() +# error: [unsupported-operator] "Operator `-=` is unsupported between objects of type `C` and `Literal[1]`" +x -= 1 + +reveal_type(x) # revealed: int +``` + +## Method union + +```py +def _(flag: bool): + class Foo: + if flag: + def __iadd__(self, other: int) -> str: + return "Hello, world!" + else: + def __iadd__(self, other: int) -> int: + return 42 + + f = Foo() + f += 12 + + reveal_type(f) # revealed: str | int +``` + +## Partially bound `__iadd__` + +```py +def _(flag: bool): + class Foo: + if flag: + def __iadd__(self, other: str) -> int: + return 42 + + f = Foo() + + # error: [unsupported-operator] "Operator `+=` is unsupported between objects of type `Foo` and `Literal["Hello, world!"]`" + f += "Hello, world!" + + reveal_type(f) # revealed: int | Unknown +``` + +## Partially bound with `__add__` + +```py +def _(flag: bool): + class Foo: + def __add__(self, other: str) -> str: + return "Hello, world!" + if flag: + def __iadd__(self, other: str) -> int: + return 42 + + f = Foo() + f += "Hello, world!" + + reveal_type(f) # revealed: int | str +``` + +## Partially bound target union + +```py +def _(flag1: bool, flag2: bool): + class Foo: + def __add__(self, other: int) -> str: + return "Hello, world!" + if flag1: + def __iadd__(self, other: int) -> int: + return 42 + + if flag2: + f = Foo() + else: + f = 42.0 + f += 12 + + reveal_type(f) # revealed: int | str | float +``` + +## Target union + +```py +def _(flag: bool): + class Foo: + def __iadd__(self, other: int) -> str: + return "Hello, world!" + + if flag: + f = Foo() + else: + f = 42 + f += 12 + + reveal_type(f) # revealed: str | Literal[54] +``` + +## Partially bound target union with `__add__` + +```py +def f(flag: bool, flag2: bool): + class Foo: + def __add__(self, other: int) -> str: + return "Hello, world!" + if flag: + def __iadd__(self, other: int) -> int: + return 42 + + class Bar: + def __add__(self, other: int) -> bytes: + return b"Hello, world!" + + def __iadd__(self, other: int) -> float: + return 42.0 + + if flag2: + f = Foo() + else: + f = Bar() + f += 12 + + reveal_type(f) # revealed: int | str | float +``` + +## Implicit dunder calls on class objects + +```py +class Meta(type): + def __iadd__(cls, other: int) -> str: + return "" + +class C(metaclass=Meta): ... + +cls = C +cls += 1 + +reveal_type(cls) # revealed: str +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/assignment/multi_target.md b/crates/ty_python_semantic/resources/mdtest/assignment/multi_target.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/assignment/multi_target.md rename to crates/ty_python_semantic/resources/mdtest/assignment/multi_target.md diff --git a/crates/ty_python_semantic/resources/mdtest/assignment/unbound.md b/crates/ty_python_semantic/resources/mdtest/assignment/unbound.md new file mode 100644 index 0000000000000..06be0b4d863ea --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/assignment/unbound.md @@ -0,0 +1,20 @@ +# Unbound + +## Unbound + +```py +x = foo # error: [unresolved-reference] "Name `foo` used when not defined" +foo = 1 + +# No error `unresolved-reference` diagnostic is reported for `x`. This is +# desirable because we would get a lot of cascading errors even though there +# is only one root cause (the unbound variable `foo`). + +# revealed: Unknown +reveal_type(x) +``` + +Note: in this particular example, one could argue that the most likely error would be a wrong order +of the `x`/`foo` definitions, and so it could be desirable to infer `Literal[1]` for the type of +`x`. On the other hand, there might be a variable `fob` a little higher up in this file, and the +actual error might have been just a typo. Inferring `Unknown` thus seems like the safest option. diff --git a/crates/red_knot_python_semantic/resources/mdtest/assignment/walrus.md b/crates/ty_python_semantic/resources/mdtest/assignment/walrus.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/assignment/walrus.md rename to crates/ty_python_semantic/resources/mdtest/assignment/walrus.md diff --git a/crates/ty_python_semantic/resources/mdtest/attributes.md b/crates/ty_python_semantic/resources/mdtest/attributes.md new file mode 100644 index 0000000000000..e04c00f729419 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/attributes.md @@ -0,0 +1,2031 @@ +# Attributes + +Tests for attribute access on various kinds of types. + +## Class and instance variables + +### Pure instance variables + +#### Variable only declared/bound in `__init__` + +Variables only declared and/or bound in `__init__` are pure instance variables. They cannot be +accessed on the class itself. + +```py +class C: + def __init__(self, param: int | None, flag: bool = False) -> None: + value = 1 if flag else "a" + self.inferred_from_value = value + self.inferred_from_other_attribute = self.inferred_from_value + self.inferred_from_param = param + self.declared_only: bytes + self.declared_and_bound: bool = True + if flag: + self.possibly_undeclared_unbound: str = "possibly set in __init__" + +c_instance = C(1) + +reveal_type(c_instance.inferred_from_value) # revealed: Unknown | Literal[1, "a"] + +# TODO: Same here. This should be `Unknown | Literal[1, "a"]` +reveal_type(c_instance.inferred_from_other_attribute) # revealed: Unknown + +# There is no special handling of attributes that are (directly) assigned to a declared parameter, +# which means we union with `Unknown` here, since the attribute itself is not declared. This is +# something that we might want to change in the future. +# +# See https://github.com/astral-sh/ruff/issues/15960 for a related discussion. +reveal_type(c_instance.inferred_from_param) # revealed: Unknown | int | None + +reveal_type(c_instance.declared_only) # revealed: bytes + +reveal_type(c_instance.declared_and_bound) # revealed: bool + +# error: [possibly-unbound-attribute] +reveal_type(c_instance.possibly_undeclared_unbound) # revealed: str + +# This assignment is fine, as we infer `Unknown | Literal[1, "a"]` for `inferred_from_value`. +c_instance.inferred_from_value = "value set on instance" + +# This assignment is also fine: +c_instance.declared_and_bound = False + +# error: [invalid-assignment] "Object of type `Literal["incompatible"]` is not assignable to attribute `declared_and_bound` of type `bool`" +c_instance.declared_and_bound = "incompatible" + +# mypy shows no error here, but pyright raises "reportAttributeAccessIssue" +# error: [unresolved-attribute] "Attribute `inferred_from_value` can only be accessed on instances, not on the class object `<class 'C'>` itself." +reveal_type(C.inferred_from_value) # revealed: Unknown + +# mypy shows no error here, but pyright raises "reportAttributeAccessIssue" +# error: [invalid-attribute-access] "Cannot assign to instance attribute `inferred_from_value` from the class object `<class 'C'>`" +C.inferred_from_value = "overwritten on class" + +# This assignment is fine: +c_instance.declared_and_bound = False + +# TODO: After this assignment to the attribute within this scope, we may eventually want to narrow +# the `bool` type (see above) for this instance variable to `Literal[False]` here. This is unsound +# in general (we don't know what else happened to `c_instance` between the assignment and the use +# here), but mypy and pyright support this. In conclusion, this could be `bool` but should probably +# be `Literal[False]`. +reveal_type(c_instance.declared_and_bound) # revealed: bool +``` + +#### Variable declared in class body and possibly bound in `__init__` + +The same rule applies even if the variable is *declared* (not bound!) in the class body: it is still +a pure instance variable. + +```py +class C: + declared_and_bound: str | None + + def __init__(self) -> None: + self.declared_and_bound = "value set in __init__" + +c_instance = C() + +reveal_type(c_instance.declared_and_bound) # revealed: str | None + +# Note that both mypy and pyright show no error in this case! So we may reconsider this in +# the future, if it turns out to produce too many false positives. We currently emit: +# error: [unresolved-attribute] "Attribute `declared_and_bound` can only be accessed on instances, not on the class object `<class 'C'>` itself." +reveal_type(C.declared_and_bound) # revealed: Unknown + +# Same as above. Mypy and pyright do not show an error here. +# error: [invalid-attribute-access] "Cannot assign to instance attribute `declared_and_bound` from the class object `<class 'C'>`" +C.declared_and_bound = "overwritten on class" + +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `declared_and_bound` of type `str | None`" +c_instance.declared_and_bound = 1 +``` + +#### Variable declared in class body and not bound anywhere + +If a variable is declared in the class body but not bound anywhere, we still consider it a pure +instance variable and allow access to it via instances. + +```py +class C: + only_declared: str + +c_instance = C() + +reveal_type(c_instance.only_declared) # revealed: str + +# Mypy and pyright do not show an error here. We treat this as a pure instance variable. +# error: [unresolved-attribute] "Attribute `only_declared` can only be accessed on instances, not on the class object `<class 'C'>` itself." +reveal_type(C.only_declared) # revealed: Unknown + +# error: [invalid-attribute-access] "Cannot assign to instance attribute `only_declared` from the class object `<class 'C'>`" +C.only_declared = "overwritten on class" +``` + +#### Mixed declarations/bindings in class body and `__init__` + +```py +class C: + only_declared_in_body: str | None + declared_in_body_and_init: str | None + + declared_in_body_defined_in_init: str | None + + bound_in_body_declared_in_init = "a" + + bound_in_body_and_init = None + + def __init__(self, flag) -> None: + self.only_declared_in_init: str | None + self.declared_in_body_and_init: str | None = None + + self.declared_in_body_defined_in_init = "a" + + self.bound_in_body_declared_in_init: str | None + + if flag: + self.bound_in_body_and_init = "a" + +c_instance = C(True) + +reveal_type(c_instance.only_declared_in_body) # revealed: str | None +reveal_type(c_instance.only_declared_in_init) # revealed: str | None +reveal_type(c_instance.declared_in_body_and_init) # revealed: str | None + +reveal_type(c_instance.declared_in_body_defined_in_init) # revealed: str | None + +# TODO: This should be `str | None`. Fixing this requires an overhaul of the `Symbol` API, +# which is planned in https://github.com/astral-sh/ruff/issues/14297 +reveal_type(c_instance.bound_in_body_declared_in_init) # revealed: Unknown | str | None + +reveal_type(c_instance.bound_in_body_and_init) # revealed: Unknown | None | Literal["a"] +``` + +#### Variable defined in non-`__init__` method + +We also recognize pure instance variables if they are defined in a method that is not `__init__`. + +```py +class C: + def __init__(self, param: int | None, flag: bool = False) -> None: + self.initialize(param, flag) + + def initialize(self, param: int | None, flag: bool) -> None: + value = 1 if flag else "a" + self.inferred_from_value = value + self.inferred_from_other_attribute = self.inferred_from_value + self.inferred_from_param = param + self.declared_only: bytes + self.declared_and_bound: bool = True + +c_instance = C(1) + +reveal_type(c_instance.inferred_from_value) # revealed: Unknown | Literal[1, "a"] + +# TODO: Should be `Unknown | Literal[1, "a"]` +reveal_type(c_instance.inferred_from_other_attribute) # revealed: Unknown + +reveal_type(c_instance.inferred_from_param) # revealed: Unknown | int | None + +reveal_type(c_instance.declared_only) # revealed: bytes + +reveal_type(c_instance.declared_and_bound) # revealed: bool + +# error: [unresolved-attribute] "Attribute `inferred_from_value` can only be accessed on instances, not on the class object `<class 'C'>` itself." +reveal_type(C.inferred_from_value) # revealed: Unknown + +# error: [invalid-attribute-access] "Cannot assign to instance attribute `inferred_from_value` from the class object `<class 'C'>`" +C.inferred_from_value = "overwritten on class" +``` + +#### Variable defined in multiple methods + +If we see multiple un-annotated assignments to a single attribute (`self.x` below), we build the +union of all inferred types (and `Unknown`). If we see multiple conflicting declarations of the same +attribute, that should be an error. + +```py +def get_int() -> int: + return 0 + +def get_str() -> str: + return "a" + +class C: + z: int + + def __init__(self) -> None: + self.x = get_int() + self.y: int = 1 + + def other_method(self): + self.x = get_str() + + # TODO: this redeclaration should be an error + self.y: str = "a" + + # TODO: this redeclaration should be an error + self.z: str = "a" + +c_instance = C() + +reveal_type(c_instance.x) # revealed: Unknown | int | str +reveal_type(c_instance.y) # revealed: int +reveal_type(c_instance.z) # revealed: int +``` + +#### Attributes defined in multi-target assignments + +```py +class C: + def __init__(self) -> None: + self.a = self.b = 1 + +c_instance = C() + +reveal_type(c_instance.a) # revealed: Unknown | Literal[1] +reveal_type(c_instance.b) # revealed: Unknown | Literal[1] +``` + +#### Augmented assignments + +```py +class Weird: + def __iadd__(self, other: None) -> str: + return "a" + +class C: + def __init__(self) -> None: + self.w = Weird() + self.w += None + +# TODO: Mypy and pyright do not support this, but it would be great if we could +# infer `Unknown | str` or at least `Unknown | Weird | str` here. +reveal_type(C().w) # revealed: Unknown | Weird +``` + +#### Attributes defined in tuple unpackings + +```py +def returns_tuple() -> tuple[int, str]: + return (1, "a") + +class C: + a1, b1 = (1, "a") + c1, d1 = returns_tuple() + + def __init__(self) -> None: + self.a2, self.b2 = (1, "a") + self.c2, self.d2 = returns_tuple() + +c_instance = C() + +reveal_type(c_instance.a1) # revealed: Unknown | Literal[1] +reveal_type(c_instance.b1) # revealed: Unknown | Literal["a"] +reveal_type(c_instance.c1) # revealed: Unknown | int +reveal_type(c_instance.d1) # revealed: Unknown | str + +reveal_type(c_instance.a2) # revealed: Unknown | Literal[1] + +reveal_type(c_instance.b2) # revealed: Unknown | Literal["a"] + +reveal_type(c_instance.c2) # revealed: Unknown | int +reveal_type(c_instance.d2) # revealed: Unknown | str +``` + +#### Starred assignments + +```py +class C: + def __init__(self) -> None: + self.a, *self.b = (1, 2, 3) + +c_instance = C() +reveal_type(c_instance.a) # revealed: Unknown | Literal[1] +reveal_type(c_instance.b) # revealed: Unknown +``` + +#### Attributes defined in for-loop (unpacking) + +```py +class IntIterator: + def __next__(self) -> int: + return 1 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +class TupleIterator: + def __next__(self) -> tuple[int, str]: + return (1, "a") + +class TupleIterable: + def __iter__(self) -> TupleIterator: + return TupleIterator() + +class NonIterable: ... + +class C: + def __init__(self): + for self.x in IntIterable(): + pass + + for _, self.y in TupleIterable(): + pass + + # TODO: We should emit a diagnostic here + for self.z in NonIterable(): + pass + +# Iterable might be empty +# error: [possibly-unbound-attribute] +reveal_type(C().x) # revealed: Unknown | int +# error: [possibly-unbound-attribute] +reveal_type(C().y) # revealed: Unknown | str +``` + +#### Attributes defined in `with` statements + +```py +class ContextManager: + def __enter__(self) -> int | None: + return 1 + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +class C: + def __init__(self) -> None: + with ContextManager() as self.x: + pass + +c_instance = C() + +reveal_type(c_instance.x) # revealed: Unknown | int | None +``` + +#### Attributes defined in `with` statements, but with unpacking + +```py +class ContextManager: + def __enter__(self) -> tuple[int | None, int]: + return 1, 2 + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +class C: + def __init__(self) -> None: + with ContextManager() as (self.x, self.y): + pass + +c_instance = C() + +reveal_type(c_instance.x) # revealed: Unknown | int | None +reveal_type(c_instance.y) # revealed: Unknown | int +``` + +#### Attributes defined in comprehensions + +```py +class IntIterator: + def __next__(self) -> int: + return 1 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +class TupleIterator: + def __next__(self) -> tuple[int, str]: + return (1, "a") + +class TupleIterable: + def __iter__(self) -> TupleIterator: + return TupleIterator() + +class C: + def __init__(self) -> None: + [... for self.a in IntIterable()] + [... for (self.b, self.c) in TupleIterable()] + [... for self.d in IntIterable() for self.e in IntIterable()] + +c_instance = C() + +reveal_type(c_instance.a) # revealed: Unknown | int +reveal_type(c_instance.b) # revealed: Unknown | int +reveal_type(c_instance.c) # revealed: Unknown | str +reveal_type(c_instance.d) # revealed: Unknown | int +reveal_type(c_instance.e) # revealed: Unknown | int +``` + +#### Conditionally declared / bound attributes + +Attributes are possibly unbound if they, or the method to which they are added are conditionally +declared / bound. + +```py +def flag() -> bool: + return True + +class C: + def f(self) -> None: + if flag(): + self.a1: str | None = "a" + self.b1 = 1 + if flag(): + def f(self) -> None: + self.a2: str | None = "a" + self.b2 = 1 + +c_instance = C() + +# error: [possibly-unbound-attribute] +reveal_type(c_instance.a1) # revealed: str | None +# error: [possibly-unbound-attribute] +reveal_type(c_instance.a2) # revealed: str | None +# error: [possibly-unbound-attribute] +reveal_type(c_instance.b1) # revealed: Unknown | Literal[1] +# error: [possibly-unbound-attribute] +reveal_type(c_instance.b2) # revealed: Unknown | Literal[1] +``` + +#### Methods that does not use `self` as a first parameter + +```py +class C: + # This might trigger a stylistic lint like `invalid-first-argument-name-for-method`, but + # it should be supported in general: + def __init__(this) -> None: + this.declared_and_bound: str | None = "a" + +reveal_type(C().declared_and_bound) # revealed: str | None +``` + +#### Aliased `self` parameter + +```py +class C: + def __init__(self) -> None: + this = self + this.declared_and_bound: str | None = "a" + +# This would ideally be `str | None`, but mypy/pyright don't support this either, +# so `Unknown` + a diagnostic is also fine. +# error: [unresolved-attribute] +reveal_type(C().declared_and_bound) # revealed: Unknown +``` + +#### Static methods do not influence implicitly defined attributes + +```py +class Other: + x: int + +class C: + @staticmethod + def f(other: Other) -> None: + other.x = 1 + +# error: [unresolved-attribute] +reveal_type(C.x) # revealed: Unknown + +# TODO: this should raise `unresolved-attribute` as well, and the type should be `Unknown` +reveal_type(C().x) # revealed: Unknown | Literal[1] + +# This also works if `staticmethod` is aliased: + +my_staticmethod = staticmethod + +class D: + @my_staticmethod + def f(other: Other) -> None: + other.x = 1 + +# error: [unresolved-attribute] +reveal_type(D.x) # revealed: Unknown + +# TODO: this should raise `unresolved-attribute` as well, and the type should be `Unknown` +reveal_type(D().x) # revealed: Unknown | Literal[1] +``` + +If `staticmethod` is something else, that should not influence the behavior: + +```py +def staticmethod(f): + return f + +class C: + @staticmethod + def f(self) -> None: + self.x = 1 + +reveal_type(C().x) # revealed: Unknown | Literal[1] +``` + +And if `staticmethod` is fully qualified, that should also be recognized: + +```py +import builtins + +class Other: + x: int + +class C: + @builtins.staticmethod + def f(other: Other) -> None: + other.x = 1 + +# error: [unresolved-attribute] +reveal_type(C.x) # revealed: Unknown + +# TODO: this should raise `unresolved-attribute` as well, and the type should be `Unknown` +reveal_type(C().x) # revealed: Unknown | Literal[1] +``` + +#### Attributes defined in statically-known-to-be-false branches + +```py +class C: + def __init__(self) -> None: + # We use a "significantly complex" condition here (instead of just `False`) + # for a proper comparison with mypy and pyright, which distinguish between + # conditions that can be resolved from a simple pattern matching and those + # that need proper type inference. + if (2 + 3) < 4: + self.x: str = "a" + +# error: [unresolved-attribute] +reveal_type(C().x) # revealed: Unknown +``` + +```py +class C: + def __init__(self, cond: bool) -> None: + if True: + self.a = 1 + else: + self.a = "a" + + if False: + self.b = 2 + + if cond: + return + + self.c = 3 + + self.d = 4 + self.d = 5 + + def set_c(self, c: str) -> None: + self.c = c + if False: + def set_e(self, e: str) -> None: + self.e = e + +reveal_type(C(True).a) # revealed: Unknown | Literal[1] +# error: [unresolved-attribute] +reveal_type(C(True).b) # revealed: Unknown +reveal_type(C(True).c) # revealed: Unknown | Literal[3] | str +# TODO: this attribute is possibly unbound +reveal_type(C(True).d) # revealed: Unknown | Literal[5] +# error: [unresolved-attribute] +reveal_type(C(True).e) # revealed: Unknown +``` + +#### Attributes considered always bound + +```py +class C: + def __init__(self, cond: bool): + self.x = 1 + if cond: + raise ValueError("Something went wrong") + + # We consider this attribute is always bound. + # This is because, it is not possible to access a partially-initialized object by normal means. + self.y = 2 + +reveal_type(C(False).x) # revealed: Unknown | Literal[1] +reveal_type(C(False).y) # revealed: Unknown | Literal[2] + +class C: + def __init__(self, b: bytes) -> None: + self.b = b + + try: + s = b.decode() + except UnicodeDecodeError: + raise ValueError("Invalid UTF-8 sequence") + + self.s = s + +reveal_type(C(b"abc").b) # revealed: Unknown | bytes +reveal_type(C(b"abc").s) # revealed: Unknown | str + +class C: + def __init__(self, iter) -> None: + self.x = 1 + + for _ in iter: + pass + + # The for-loop may not stop, + # but we consider the subsequent attributes to be definitely-bound. + self.y = 2 + +reveal_type(C([]).x) # revealed: Unknown | Literal[1] +reveal_type(C([]).y) # revealed: Unknown | Literal[2] +``` + +#### Diagnostics are reported for the right-hand side of attribute assignments + +```py +class C: + def __init__(self) -> None: + # error: [too-many-positional-arguments] + # error: [invalid-argument-type] + self.x: int = len(1, 2, 3) +``` + +### Pure class variables (`ClassVar`) + +#### Annotated with `ClassVar` type qualifier + +Class variables annotated with the [`typing.ClassVar`] type qualifier are pure class variables. They +cannot be overwritten on instances, but they can be accessed on instances. + +For more details, see the [typing spec on `ClassVar`]. + +```py +from typing import ClassVar + +class C: + pure_class_variable1: ClassVar[str] = "value in class body" + pure_class_variable2: ClassVar = 1 + + def method(self): + # TODO: this should be an error + self.pure_class_variable1 = "value set through instance" + +reveal_type(C.pure_class_variable1) # revealed: str + +# TODO: Should be `Unknown | Literal[1]`. +reveal_type(C.pure_class_variable2) # revealed: Unknown + +c_instance = C() + +# It is okay to access a pure class variable on an instance. +reveal_type(c_instance.pure_class_variable1) # revealed: str + +# TODO: Should be `Unknown | Literal[1]`. +reveal_type(c_instance.pure_class_variable2) # revealed: Unknown + +# error: [invalid-attribute-access] "Cannot assign to ClassVar `pure_class_variable1` from an instance of type `C`" +c_instance.pure_class_variable1 = "value set on instance" + +C.pure_class_variable1 = "overwritten on class" + +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `pure_class_variable1` of type `str`" +C.pure_class_variable1 = 1 + +class Subclass(C): + pure_class_variable1: ClassVar[str] = "overwritten on subclass" + +reveal_type(Subclass.pure_class_variable1) # revealed: str +``` + +#### Variable only mentioned in a class method + +We also consider a class variable to be a pure class variable if it is only mentioned in a class +method. + +```py +class C: + @classmethod + def class_method(cls): + cls.pure_class_variable = "value set in class method" + +# for a more realistic example, let's actually call the method +C.class_method() + +# TODO: We currently plan to support this and show no error here. +# mypy shows an error here, pyright does not. +# error: [unresolved-attribute] +reveal_type(C.pure_class_variable) # revealed: Unknown + +# TODO: should be no error when descriptor protocol is supported +# and the assignment is properly attributed to the class method. +# error: [invalid-attribute-access] "Cannot assign to instance attribute `pure_class_variable` from the class object `<class 'C'>`" +C.pure_class_variable = "overwritten on class" + +# TODO: should be `Unknown | Literal["value set in class method"]` or +# Literal["overwritten on class"]`, once/if we support local narrowing. +# error: [unresolved-attribute] +reveal_type(C.pure_class_variable) # revealed: Unknown + +c_instance = C() +reveal_type(c_instance.pure_class_variable) # revealed: Unknown | Literal["value set in class method"] + +# TODO: should raise an error. +c_instance.pure_class_variable = "value set on instance" +``` + +### Instance variables with class-level default values + +These are instance attributes, but the fact that we can see that they have a binding (not a +declaration) in the class body means that reading the value from the class directly is also +permitted. This is the only difference for these attributes as opposed to "pure" instance +attributes. + +#### Basic + +```py +class C: + variable_with_class_default1: str = "value in class body" + variable_with_class_default2 = 1 + + def instance_method(self): + self.variable_with_class_default1 = "value set in instance method" + +reveal_type(C.variable_with_class_default1) # revealed: str + +reveal_type(C.variable_with_class_default2) # revealed: Unknown | Literal[1] + +c_instance = C() + +reveal_type(c_instance.variable_with_class_default1) # revealed: str +reveal_type(c_instance.variable_with_class_default2) # revealed: Unknown | Literal[1] + +c_instance.variable_with_class_default1 = "value set on instance" + +reveal_type(C.variable_with_class_default1) # revealed: str + +# TODO: Could be Literal["value set on instance"], or still `str` if we choose not to +# narrow the type. +reveal_type(c_instance.variable_with_class_default1) # revealed: str + +C.variable_with_class_default1 = "overwritten on class" + +# TODO: Could be `Literal["overwritten on class"]`, or still `str` if we choose not to +# narrow the type. +reveal_type(C.variable_with_class_default1) # revealed: str + +# TODO: should still be `Literal["value set on instance"]`, or `str`. +reveal_type(c_instance.variable_with_class_default1) # revealed: str +``` + +#### Descriptor attributes as class variables + +Whether they are explicitly qualified as `ClassVar`, or just have a class level default, we treat +descriptor attributes as class variables. This test mainly makes sure that we do *not* treat them as +instance variables. This would lead to a different outcome, since the `__get__` method would not be +called (the descriptor protocol is not invoked for instance variables). + +```py +from typing import ClassVar + +class Descriptor: + def __get__(self, instance, owner) -> int: + return 42 + +class C: + a: ClassVar[Descriptor] + b: Descriptor = Descriptor() + c: ClassVar[Descriptor] = Descriptor() + +reveal_type(C().a) # revealed: int +reveal_type(C().b) # revealed: int +reveal_type(C().c) # revealed: int +``` + +### Inheritance of class/instance attributes + +#### Instance variable defined in a base class + +```py +class Base: + declared_in_body: int | None = 1 + + base_class_attribute_1: str | None + base_class_attribute_2: str | None + base_class_attribute_3: str | None + + def __init__(self) -> None: + self.defined_in_init: str | None = "value in base" + +class Intermediate(Base): + # Redeclaring base class attributes with the *same *type is fine: + base_class_attribute_1: str | None = None + + # Redeclaring them with a *narrower type* is unsound, because modifications + # through a `Base` reference could violate that constraint. + # + # Mypy does not report an error here, but pyright does: "… overrides symbol + # of same name in class "Base". Variable is mutable so its type is invariant" + # + # We should introduce a diagnostic for this. Whether or not that should be + # enabled by default can still be discussed. + # + # TODO: This should be an error + base_class_attribute_2: str + + # Redeclaring attributes with a *wider type* directly violates LSP. + # + # In this case, both mypy and pyright report an error. + # + # TODO: This should be an error + base_class_attribute_3: str | int | None + +class Derived(Intermediate): ... + +reveal_type(Derived.declared_in_body) # revealed: int | None + +reveal_type(Derived().declared_in_body) # revealed: int | None + +reveal_type(Derived().defined_in_init) # revealed: str | None +``` + +## Accessing attributes on class objects + +When accessing attributes on class objects, they are always looked up on the type of the class +object first, i.e. on the metaclass: + +```py +from typing import Literal + +class Meta1: + attr: Literal["metaclass value"] = "metaclass value" + +class C1(metaclass=Meta1): ... + +reveal_type(C1.attr) # revealed: Literal["metaclass value"] +``` + +However, the metaclass attribute only takes precedence over a class-level attribute if it is a data +descriptor. If it is a non-data descriptor or a normal attribute, the class-level attribute is used +instead (see the [descriptor protocol tests] for data/non-data descriptor attributes): + +```py +class Meta2: + attr: str = "metaclass value" + +class C2(metaclass=Meta2): + attr: Literal["class value"] = "class value" + +reveal_type(C2.attr) # revealed: Literal["class value"] +``` + +If the class-level attribute is only partially defined, we union the metaclass attribute with the +class-level attribute: + +```py +def _(flag: bool): + class Meta3: + attr1 = "metaclass value" + attr2: Literal["metaclass value"] = "metaclass value" + + class C3(metaclass=Meta3): + if flag: + attr1 = "class value" + # TODO: Neither mypy nor pyright show an error here, but we could consider emitting a conflicting-declaration diagnostic here. + attr2: Literal["class value"] = "class value" + + reveal_type(C3.attr1) # revealed: Unknown | Literal["metaclass value", "class value"] + reveal_type(C3.attr2) # revealed: Literal["metaclass value", "class value"] +``` + +If the *metaclass* attribute is only partially defined, we emit a `possibly-unbound-attribute` +diagnostic: + +```py +def _(flag: bool): + class Meta4: + if flag: + attr1: str = "metaclass value" + + class C4(metaclass=Meta4): ... + # error: [possibly-unbound-attribute] + reveal_type(C4.attr1) # revealed: str +``` + +Finally, if both the metaclass attribute and the class-level attribute are only partially defined, +we union them and emit a `possibly-unbound-attribute` diagnostic: + +```py +def _(flag1: bool, flag2: bool): + class Meta5: + if flag1: + attr1 = "metaclass value" + + class C5(metaclass=Meta5): + if flag2: + attr1 = "class value" + + # error: [possibly-unbound-attribute] + reveal_type(C5.attr1) # revealed: Unknown | Literal["metaclass value", "class value"] +``` + +## Unions of attributes + +If the (meta)class is a union type or if the attribute on the (meta) class has a union type, we +infer those union types accordingly: + +```py +def _(flag: bool): + if flag: + class C1: + x = 1 + y: int = 1 + + else: + class C1: + x = 2 + y: int | str = "b" + + reveal_type(C1.x) # revealed: Unknown | Literal[1, 2] + reveal_type(C1.y) # revealed: int | str + + C1.y = 100 + # error: [invalid-assignment] "Object of type `Literal["problematic"]` is not assignable to attribute `y` on type `<class 'C1'> | <class 'C1'>`" + C1.y = "problematic" + + class C2: + if flag: + x = 3 + y: int = 3 + else: + x = 4 + y: int | str = "d" + + reveal_type(C2.x) # revealed: Unknown | Literal[3, 4] + reveal_type(C2.y) # revealed: int | str + + C2.y = 100 + # error: [invalid-assignment] "Object of type `None` is not assignable to attribute `y` of type `int | str`" + C2.y = None + # TODO: should be an error, needs more sophisticated union handling in `validate_attribute_assignment` + C2.y = "problematic" + + if flag: + class Meta3(type): + x = 5 + y: int = 5 + + else: + class Meta3(type): + x = 6 + y: int | str = "f" + + class C3(metaclass=Meta3): ... + reveal_type(C3.x) # revealed: Unknown | Literal[5, 6] + reveal_type(C3.y) # revealed: int | str + + C3.y = 100 + # error: [invalid-assignment] "Object of type `None` is not assignable to attribute `y` of type `int | str`" + C3.y = None + # TODO: should be an error, needs more sophisticated union handling in `validate_attribute_assignment` + C3.y = "problematic" + + class Meta4(type): + if flag: + x = 7 + y: int = 7 + else: + x = 8 + y: int | str = "h" + + class C4(metaclass=Meta4): ... + reveal_type(C4.x) # revealed: Unknown | Literal[7, 8] + reveal_type(C4.y) # revealed: int | str + + C4.y = 100 + # error: [invalid-assignment] "Object of type `None` is not assignable to attribute `y` of type `int | str`" + C4.y = None + # TODO: should be an error, needs more sophisticated union handling in `validate_attribute_assignment` + C4.y = "problematic" +``` + +## Unions with possibly unbound paths + +### Definite boundness within a class + +In this example, the `x` attribute is not defined in the `C2` element of the union: + +```py +def _(flag1: bool, flag2: bool): + class C1: + x = 1 + + class C2: ... + + class C3: + x = 3 + + C = C1 if flag1 else C2 if flag2 else C3 + + # error: [possibly-unbound-attribute] "Attribute `x` on type `<class 'C1'> | <class 'C2'> | <class 'C3'>` is possibly unbound" + reveal_type(C.x) # revealed: Unknown | Literal[1, 3] + + # error: [invalid-assignment] "Object of type `Literal[100]` is not assignable to attribute `x` on type `<class 'C1'> | <class 'C2'> | <class 'C3'>`" + C.x = 100 + + # error: [possibly-unbound-attribute] "Attribute `x` on type `C1 | C2 | C3` is possibly unbound" + reveal_type(C().x) # revealed: Unknown | Literal[1, 3] + + # error: [invalid-assignment] "Object of type `Literal[100]` is not assignable to attribute `x` on type `C1 | C2 | C3`" + C().x = 100 +``` + +### Possibly-unbound within a class + +We raise the same diagnostic if the attribute is possibly-unbound in at least one element of the +union: + +```py +def _(flag: bool, flag1: bool, flag2: bool): + class C1: + x = 1 + + class C2: + if flag: + x = 2 + + class C3: + x = 3 + + C = C1 if flag1 else C2 if flag2 else C3 + + # error: [possibly-unbound-attribute] "Attribute `x` on type `<class 'C1'> | <class 'C2'> | <class 'C3'>` is possibly unbound" + reveal_type(C.x) # revealed: Unknown | Literal[1, 2, 3] + + # error: [possibly-unbound-attribute] + C.x = 100 + + # Note: we might want to consider ignoring possibly-unbound diagnostics for instance attributes eventually, + # see the "Possibly unbound/undeclared instance attribute" section below. + # error: [possibly-unbound-attribute] "Attribute `x` on type `C1 | C2 | C3` is possibly unbound" + reveal_type(C().x) # revealed: Unknown | Literal[1, 2, 3] + + # error: [possibly-unbound-attribute] + C().x = 100 +``` + +### Possibly-unbound within gradual types + +```py +from typing import Any + +def _(flag: bool): + class Base: + x: Any + + class Derived(Base): + if flag: + # Redeclaring `x` with a more static type is okay in terms of LSP. + x: int + + reveal_type(Derived().x) # revealed: int | Any + + Derived().x = 1 + Derived().x = "a" +``` + +### Attribute possibly unbound on a subclass but not on a superclass + +```py +def _(flag: bool): + class Foo: + x = 1 + + class Bar(Foo): + if flag: + x = 2 + + reveal_type(Bar.x) # revealed: Unknown | Literal[2, 1] + Bar.x = 3 + + reveal_type(Bar().x) # revealed: Unknown | Literal[2, 1] + Bar().x = 3 +``` + +### Attribute possibly unbound on a subclass and on a superclass + +```py +def _(flag: bool): + class Foo: + if flag: + x = 1 + + class Bar(Foo): + if flag: + x = 2 + + # error: [possibly-unbound-attribute] + reveal_type(Bar.x) # revealed: Unknown | Literal[2, 1] + + # error: [possibly-unbound-attribute] + Bar.x = 3 + + # error: [possibly-unbound-attribute] + reveal_type(Bar().x) # revealed: Unknown | Literal[2, 1] + + # error: [possibly-unbound-attribute] + Bar().x = 3 +``` + +### Possibly unbound/undeclared instance attribute + +#### Possibly unbound and undeclared + +```py +def _(flag: bool): + class Foo: + if flag: + x: int + + def __init(self): + if flag: + self.x = 1 + + # error: [possibly-unbound-attribute] + reveal_type(Foo().x) # revealed: int | Unknown + + # error: [possibly-unbound-attribute] + Foo().x = 1 +``` + +#### Possibly unbound + +```py +def _(flag: bool): + class Foo: + def __init(self): + if flag: + self.x = 1 + self.y = "a" + else: + self.y = "b" + + # error: [possibly-unbound-attribute] + reveal_type(Foo().x) # revealed: Unknown | Literal[1] + + # error: [possibly-unbound-attribute] + Foo().x = 2 + + reveal_type(Foo().y) # revealed: Unknown | Literal["a", "b"] + Foo().y = "c" +``` + +### Unions with all paths unbound + +If the symbol is unbound in all elements of the union, we detect that: + +```py +def _(flag: bool): + class C1: ... + class C2: ... + C = C1 if flag else C2 + + # error: [unresolved-attribute] "Type `<class 'C1'> | <class 'C2'>` has no attribute `x`" + reveal_type(C.x) # revealed: Unknown + + # TODO: This should ideally be a `unresolved-attribute` error. We need better union + # handling in `validate_attribute_assignment` for this. + # error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `x` on type `<class 'C1'> | <class 'C2'>`" + C.x = 1 +``` + +## Inherited class attributes + +### Basic + +```py +class A: + X = "foo" + +class B(A): ... +class C(B): ... + +reveal_type(C.X) # revealed: Unknown | Literal["foo"] + +C.X = "bar" +``` + +### Multiple inheritance + +```py +class O: ... + +class F(O): + X = 56 + +class E(O): + X = 42 + +class D(O): ... +class C(D, F): ... +class B(E, D): ... +class A(B, C): ... + +# revealed: tuple[<class 'A'>, <class 'B'>, <class 'E'>, <class 'C'>, <class 'D'>, <class 'F'>, <class 'O'>, <class 'object'>] +reveal_type(A.__mro__) + +# `E` is earlier in the MRO than `F`, so we should use the type of `E.X` +reveal_type(A.X) # revealed: Unknown | Literal[42] + +A.X = 100 +``` + +## Intersections of attributes + +### Attribute only available on one element + +```py +from ty_extensions import Intersection + +class A: + x: int = 1 + +class B: ... + +def _(a_and_b: Intersection[A, B]): + reveal_type(a_and_b.x) # revealed: int + + a_and_b.x = 2 + +# Same for class objects +def _(a_and_b: Intersection[type[A], type[B]]): + reveal_type(a_and_b.x) # revealed: int + + a_and_b.x = 2 +``` + +### Attribute available on both elements + +```py +from ty_extensions import Intersection + +class P: ... +class Q: ... +class R(P, Q): ... + +class A: + x: P = P() + +class B: + x: Q = Q() + +def _(a_and_b: Intersection[A, B]): + reveal_type(a_and_b.x) # revealed: P & Q + a_and_b.x = R() + +# Same for class objects +def _(a_and_b: Intersection[type[A], type[B]]): + reveal_type(a_and_b.x) # revealed: P & Q + a_and_b.x = R() +``` + +### Possible unboundness + +```py +from ty_extensions import Intersection + +class P: ... +class Q: ... +class R(P, Q): ... + +def _(flag: bool): + class A1: + if flag: + x: P = P() + + class B1: ... + + def inner1(a_and_b: Intersection[A1, B1]): + # error: [possibly-unbound-attribute] + reveal_type(a_and_b.x) # revealed: P + + # error: [possibly-unbound-attribute] + a_and_b.x = R() + # Same for class objects + def inner1_class(a_and_b: Intersection[type[A1], type[B1]]): + # error: [possibly-unbound-attribute] + reveal_type(a_and_b.x) # revealed: P + + # error: [possibly-unbound-attribute] + a_and_b.x = R() + + class A2: + if flag: + x: P = P() + + class B1: + x: Q = Q() + + def inner2(a_and_b: Intersection[A2, B1]): + reveal_type(a_and_b.x) # revealed: P & Q + + # TODO: this should not be an error, we need better intersection + # handling in `validate_attribute_assignment` for this + # error: [possibly-unbound-attribute] + a_and_b.x = R() + # Same for class objects + def inner2_class(a_and_b: Intersection[type[A2], type[B1]]): + reveal_type(a_and_b.x) # revealed: P & Q + + class A3: + if flag: + x: P = P() + + class B3: + if flag: + x: Q = Q() + + def inner3(a_and_b: Intersection[A3, B3]): + # error: [possibly-unbound-attribute] + reveal_type(a_and_b.x) # revealed: P & Q + + # error: [possibly-unbound-attribute] + a_and_b.x = R() + # Same for class objects + def inner3_class(a_and_b: Intersection[type[A3], type[B3]]): + # error: [possibly-unbound-attribute] + reveal_type(a_and_b.x) # revealed: P & Q + + # error: [possibly-unbound-attribute] + a_and_b.x = R() + + class A4: ... + class B4: ... + + def inner4(a_and_b: Intersection[A4, B4]): + # error: [unresolved-attribute] + reveal_type(a_and_b.x) # revealed: Unknown + + # error: [invalid-assignment] + a_and_b.x = R() + # Same for class objects + def inner4_class(a_and_b: Intersection[type[A4], type[B4]]): + # error: [unresolved-attribute] + reveal_type(a_and_b.x) # revealed: Unknown + + # error: [invalid-assignment] + a_and_b.x = R() +``` + +### Intersection of implicit instance attributes + +```py +from ty_extensions import Intersection + +class P: ... +class Q: ... + +class A: + def __init__(self): + self.x: P = P() + +class B: + def __init__(self): + self.x: Q = Q() + +def _(a_and_b: Intersection[A, B]): + reveal_type(a_and_b.x) # revealed: P & Q +``` + +## Attribute access on `Any` + +The union of the set of types that `Any` could materialise to is equivalent to `object`. It follows +from this that attribute access on `Any` resolves to `Any` if the attribute does not exist on +`object` -- but if the attribute *does* exist on `object`, the type of the attribute is +`<type as it exists on object> & Any`. + +```py +from typing import Any + +class Foo(Any): ... + +reveal_type(Foo.bar) # revealed: Any +reveal_type(Foo.__repr__) # revealed: (def __repr__(self) -> str) & Any +``` + +Similar principles apply if `Any` appears in the middle of an inheritance hierarchy: + +```py +from typing import ClassVar, Literal + +class A: + x: ClassVar[Literal[1]] = 1 + +class B(Any): ... +class C(B, A): ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'B'>, Any, <class 'A'>, <class 'object'>] +reveal_type(C.x) # revealed: Literal[1] & Any +``` + +## Classes with custom `__getattr__` methods + +### Basic + +If a type provides a custom `__getattr__` method, we use the return type of that method as the type +for unknown attributes. Consider the following `CustomGetAttr` class: + +```py +from typing import Literal + +def flag() -> bool: + return True + +class GetAttrReturnType: ... + +class CustomGetAttr: + class_attr: int = 1 + + if flag(): + possibly_unbound: bytes = b"a" + + def __init__(self) -> None: + self.instance_attr: str = "a" + + def __getattr__(self, name: str) -> GetAttrReturnType: + return GetAttrReturnType() +``` + +We can access arbitrary attributes on instances of this class, and the type of the attribute will be +`GetAttrReturnType`: + +```py +c = CustomGetAttr() + +reveal_type(c.whatever) # revealed: GetAttrReturnType +``` + +If an attribute is defined on the class, it takes precedence over the `__getattr__` method: + +```py +reveal_type(c.class_attr) # revealed: int +``` + +If the class attribute is possibly unbound, we union the type of the attribute with the fallback +type of the `__getattr__` method: + +```py +reveal_type(c.possibly_unbound) # revealed: bytes | GetAttrReturnType +``` + +Instance attributes also take precedence over the `__getattr__` method: + +```py +# Note: we could attempt to union with the fallback type of `__getattr__` here, as we currently do not +# attempt to determine if instance attributes are always bound or not. Neither mypy nor pyright do this, +# so it's not a priority. +reveal_type(c.instance_attr) # revealed: str +``` + +Importantly, `__getattr__` is only called if attributes are accessed on instances, not if they are +accessed on the class itself: + +```py +# error: [unresolved-attribute] +CustomGetAttr.whatever +``` + +### Type of the `name` parameter + +If the `name` parameter of the `__getattr__` method is annotated with a (union of) literal type(s), +we only consider the attribute access to be valid if the accessed attribute is one of them: + +```py +from typing import Literal + +class Date: + def __getattr__(self, name: Literal["day", "month", "year"]) -> int: + return 0 + +date = Date() + +reveal_type(date.day) # revealed: int +reveal_type(date.month) # revealed: int +reveal_type(date.year) # revealed: int + +# error: [unresolved-attribute] "Type `Date` has no attribute `century`" +reveal_type(date.century) # revealed: Unknown +``` + +### `argparse.Namespace` + +A standard library example of a class with a custom `__getattr__` method is `argparse.Namespace`: + +```py +import argparse + +def _(ns: argparse.Namespace): + reveal_type(ns.whatever) # revealed: Any +``` + +## Classes with custom `__setattr__` methods + +### Basic + +If a type provides a custom `__setattr__` method, we use the parameter type of that method as the +type to validate attribute assignments. Consider the following `CustomSetAttr` class: + +```py +class CustomSetAttr: + def __setattr__(self, name: str, value: int) -> None: + pass +``` + +We can set arbitrary attributes on instances of this class: + +```py +c = CustomSetAttr() + +c.whatever = 42 +``` + +### Type of the `name` parameter + +If the `name` parameter of the `__setattr__` method is annotated with a (union of) literal type(s), +we only consider the attribute assignment to be valid if the assigned attribute is one of them: + +```py +from typing import Literal + +class Date: + def __setattr__(self, name: Literal["day", "month", "year"], value: int) -> None: + pass + +date = Date() +date.day = 8 +date.month = 4 +date.year = 2025 + +# error: [unresolved-attribute] "Can not assign object of `Literal["UTC"]` to attribute `tz` on type `Date` with custom `__setattr__` method." +date.tz = "UTC" +``` + +### `argparse.Namespace` + +A standard library example of a class with a custom `__setattr__` method is `argparse.Namespace`: + +```py +import argparse + +def _(ns: argparse.Namespace): + ns.whatever = 42 +``` + +## Objects of all types have a `__class__` method + +The type of `x.__class__` is the same as `x`'s meta-type. `x.__class__` is always the same value as +`type(x)`. + +```py +import typing_extensions + +reveal_type(typing_extensions.__class__) # revealed: <class 'ModuleType'> +reveal_type(type(typing_extensions)) # revealed: <class 'ModuleType'> + +a = 42 +reveal_type(a.__class__) # revealed: <class 'int'> +reveal_type(type(a)) # revealed: <class 'int'> + +b = "42" +reveal_type(b.__class__) # revealed: <class 'str'> + +c = b"42" +reveal_type(c.__class__) # revealed: <class 'bytes'> + +d = True +reveal_type(d.__class__) # revealed: <class 'bool'> + +e = (42, 42) +reveal_type(e.__class__) # revealed: <class 'tuple'> + +def f(a: int, b: typing_extensions.LiteralString, c: int | str, d: type[str]): + reveal_type(a.__class__) # revealed: type[int] + reveal_type(type(a)) # revealed: type[int] + + reveal_type(b.__class__) # revealed: <class 'str'> + reveal_type(type(b)) # revealed: <class 'str'> + + reveal_type(c.__class__) # revealed: type[int] | type[str] + reveal_type(type(c)) # revealed: type[int] | type[str] + + # `type[type]`, a.k.a., either the class `type` or some subclass of `type`. + # It would be incorrect to infer `Literal[type]` here, + # as `c` could be some subclass of `str` with a custom metaclass. + # All we know is that the metaclass must be a (non-strict) subclass of `type`. + reveal_type(d.__class__) # revealed: type[type] + +reveal_type(f.__class__) # revealed: <class 'FunctionType'> + +class Foo: ... + +reveal_type(Foo.__class__) # revealed: <class 'type'> +``` + +## Module attributes + +### Basic + +`mod.py`: + +```py +global_symbol: str = "a" +``` + +```py +import mod + +reveal_type(mod.global_symbol) # revealed: str +mod.global_symbol = "b" + +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `global_symbol` of type `str`" +mod.global_symbol = 1 + +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `global_symbol` of type `str`" +(_, mod.global_symbol) = (..., 1) + +# TODO: this should be an error, but we do not understand list unpackings yet. +[_, mod.global_symbol] = [1, 2] + +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +# error: [invalid-assignment] "Object of type `int` is not assignable to attribute `global_symbol` of type `str`" +for mod.global_symbol in IntIterable(): + pass +``` + +### Nested module attributes + +`outer/__init__.py`: + +```py +``` + +`outer/nested/__init__.py`: + +```py +``` + +`outer/nested/inner.py`: + +```py +class Outer: + class Nested: + class Inner: + attr: int = 1 +``` + +```py +import outer.nested.inner + +reveal_type(outer.nested.inner.Outer.Nested.Inner.attr) # revealed: int + +# error: [invalid-assignment] +outer.nested.inner.Outer.Nested.Inner.attr = "a" +``` + +## Literal types + +### Function-literal attributes + +Most attribute accesses on function-literal types are delegated to `types.FunctionType`, since all +functions are instances of that class: + +```py +def f(): ... + +reveal_type(f.__defaults__) # revealed: tuple[Any, ...] | None +reveal_type(f.__kwdefaults__) # revealed: dict[str, Any] | None +``` + +Some attributes are special-cased, however: + +```py +reveal_type(f.__get__) # revealed: <method-wrapper `__get__` of `f`> +reveal_type(f.__call__) # revealed: <method-wrapper `__call__` of `f`> +``` + +### Int-literal attributes + +Most attribute accesses on int-literal types are delegated to `builtins.int`, since all literal +integers are instances of that class: + +```py +reveal_type((2).bit_length) # revealed: bound method Literal[2].bit_length() -> int +reveal_type((2).denominator) # revealed: Literal[1] +``` + +Some attributes are special-cased, however: + +```py +reveal_type((2).numerator) # revealed: Literal[2] +reveal_type((2).real) # revealed: Literal[2] +``` + +### Bool-literal attributes + +Most attribute accesses on bool-literal types are delegated to `builtins.bool`, since all literal +bools are instances of that class: + +```py +# revealed: Overload[(value: bool, /) -> bool, (value: int, /) -> int] +reveal_type(True.__and__) +# revealed: Overload[(value: bool, /) -> bool, (value: int, /) -> int] +reveal_type(False.__or__) +``` + +Some attributes are special-cased, however: + +```py +reveal_type(True.numerator) # revealed: Literal[1] +reveal_type(False.real) # revealed: Literal[0] +``` + +### Bytes-literal attributes + +All attribute access on literal `bytes` types is currently delegated to `builtins.bytes`: + +```py +# revealed: bound method Literal[b"foo"].join(iterable_of_bytes: Iterable[@Todo(Support for `typing.TypeAlias`)], /) -> bytes +reveal_type(b"foo".join) +# revealed: bound method Literal[b"foo"].endswith(suffix: @Todo(Support for `typing.TypeAlias`) | tuple[@Todo(Support for `typing.TypeAlias`), ...], start: SupportsIndex | None = ellipsis, end: SupportsIndex | None = ellipsis, /) -> bool +reveal_type(b"foo".endswith) +``` + +## Instance attribute edge cases + +### Assignment to attribute that does not correspond to the instance + +```py +class Other: + x: int = 1 + +class C: + def __init__(self, other: Other) -> None: + other.x = 1 + +def f(c: C): + # error: [unresolved-attribute] + reveal_type(c.x) # revealed: Unknown +``` + +### Nested classes + +```py +class Outer: + def __init__(self): + self.x: int = 1 + + class Middle: + # has no 'x' attribute + + class Inner: + def __init__(self): + self.x: str = "a" + +reveal_type(Outer().x) # revealed: int + +# error: [unresolved-attribute] +Outer.Middle().x + +reveal_type(Outer.Middle.Inner().x) # revealed: str +``` + +### Shadowing of `self` + +```py +class Other: + x: int = 1 + +class C: + def __init__(self) -> None: + # Redeclaration of self. `self` does not refer to the instance anymore. + self: Other = Other() + self.x: int = 1 + +# TODO: this should be an error +C().x +``` + +### Assignment to `self` after nested function + +```py +class Other: + x: str = "a" + +class C: + def __init__(self) -> None: + def nested_function(self: Other): + self.x = "b" + self.x: int = 1 + +reveal_type(C().x) # revealed: int +``` + +### Assignment to `self` from nested function + +```py +class C: + def __init__(self) -> None: + def set_attribute(value: str): + self.x: str = value + set_attribute("a") + +# TODO: ideally, this would be `str`. Mypy supports this, pyright does not. +# error: [unresolved-attribute] +reveal_type(C().x) # revealed: Unknown +``` + +### Accessing attributes on `Never` + +Arbitrary attributes can be accessed on `Never` without emitting any errors: + +```py +from typing_extensions import Never + +def f(never: Never): + reveal_type(never.arbitrary_attribute) # revealed: Never + + # Assigning `Never` to an attribute on `Never` is also allowed: + never.another_attribute = never +``` + +### Cyclic implicit attributes + +Inferring types for undeclared implicit attributes can be cyclic: + +```py +class C: + def __init__(self): + self.x = 1 + + def copy(self, other: "C"): + self.x = other.x + +reveal_type(C().x) # revealed: Unknown | Literal[1] +``` + +If the only assignment to a name is cyclic, we just infer `Unknown` for that attribute: + +```py +class D: + def copy(self, other: "D"): + self.x = other.x + +reveal_type(D().x) # revealed: Unknown +``` + +If there is an annotation for a name, we don't try to infer any type from the RHS of assignments to +that name, so these cases don't trigger any cycle: + +```py +class E: + def __init__(self): + self.x: int = 1 + + def copy(self, other: "E"): + self.x = other.x + +reveal_type(E().x) # revealed: int + +class F: + def __init__(self): + self.x = 1 + + def copy(self, other: "F"): + self.x: int = other.x + +reveal_type(F().x) # revealed: int + +class G: + def copy(self, other: "G"): + self.x: int = other.x + +reveal_type(G().x) # revealed: int +``` + +We can even handle cycles involving multiple classes: + +```py +class A: + def __init__(self): + self.x = 1 + + def copy(self, other: "B"): + self.x = other.x + +class B: + def copy(self, other: "A"): + self.x = other.x + +reveal_type(B().x) # revealed: Unknown | Literal[1] +reveal_type(A().x) # revealed: Unknown | Literal[1] +``` + +This case additionally tests our union/intersection simplification logic: + +```py +class H: + def __init__(self): + self.x = 1 + + def copy(self, other: "H"): + self.x = other.x or self.x +``` + +### Builtin types attributes + +This test can probably be removed eventually, but we currently include it because we do not yet +understand generic bases and protocols, and we want to make sure that we can still use builtin types +in our tests in the meantime. See the corresponding TODO in `Type::static_member` for more +information. + +```py +class C: + a_int: int = 1 + a_str: str = "a" + a_bytes: bytes = b"a" + a_bool: bool = True + a_float: float = 1.0 + a_complex: complex = 1 + 1j + a_tuple: tuple[int] = (1,) + a_range: range = range(1) + a_slice: slice = slice(1) + a_type: type = int + a_none: None = None + +reveal_type(C.a_int) # revealed: int +reveal_type(C.a_str) # revealed: str +reveal_type(C.a_bytes) # revealed: bytes +reveal_type(C.a_bool) # revealed: bool +reveal_type(C.a_float) # revealed: int | float +reveal_type(C.a_complex) # revealed: int | float | complex +reveal_type(C.a_tuple) # revealed: tuple[int] +reveal_type(C.a_range) # revealed: range +# TODO: revealed: slice[Any, Literal[1], Any] +reveal_type(C.a_slice) # revealed: slice[Any, Any, Any] +reveal_type(C.a_type) # revealed: type +reveal_type(C.a_none) # revealed: None +``` + +### Generic methods + +We also detect implicit instance attributes on methods that are themselves generic. We have an extra +test for this because generic functions have an extra type-params scope in between the function body +scope and the outer scope, so we need to make sure that our implementation can still recognize `f` +as a method of `C` here: + +```toml +[environment] +python-version = "3.12" +``` + +```py +class C: + def f[T](self, t: T) -> T: + self.x: int = 1 + return t + +reveal_type(C().x) # revealed: int +``` + +## Enum classes + +Enums are not supported yet; attribute access on an enum class is inferred as `Todo`. + +```py +import enum + +reveal_type(enum.Enum.__members__) # revealed: @Todo(Attribute access on enum classes) + +class Foo(enum.Enum): + BAR = 1 + +reveal_type(Foo.BAR) # revealed: @Todo(Attribute access on enum classes) +reveal_type(Foo.BAR.value) # revealed: @Todo(Attribute access on enum classes) +reveal_type(Foo.__members__) # revealed: @Todo(Attribute access on enum classes) +``` + +## References + +Some of the tests in the *Class and instance variables* section draw inspiration from +[pyright's documentation] on this topic. + +[descriptor protocol tests]: descriptor_protocol.md +[pyright's documentation]: https://microsoft.github.io/pyright/#/type-concepts-advanced?id=class-and-instance-variables +[typing spec on `classvar`]: https://typing.python.org/en/latest/spec/class-compat.html#classvar +[`typing.classvar`]: https://docs.python.org/3/library/typing.html#typing.ClassVar diff --git a/crates/ty_python_semantic/resources/mdtest/binary/booleans.md b/crates/ty_python_semantic/resources/mdtest/binary/booleans.md new file mode 100644 index 0000000000000..6bfca0ecce5ed --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/booleans.md @@ -0,0 +1,105 @@ +## Binary operations on booleans + +## Basic Arithmetic + +We try to be precise and all operations except for division will result in Literal type. + +```py +a = True +b = False + +reveal_type(a + a) # revealed: Literal[2] +reveal_type(a + b) # revealed: Literal[1] +reveal_type(b + a) # revealed: Literal[1] +reveal_type(b + b) # revealed: Literal[0] + +reveal_type(a - a) # revealed: Literal[0] +reveal_type(a - b) # revealed: Literal[1] +reveal_type(b - a) # revealed: Literal[-1] +reveal_type(b - b) # revealed: Literal[0] + +reveal_type(a * a) # revealed: Literal[1] +reveal_type(a * b) # revealed: Literal[0] +reveal_type(b * a) # revealed: Literal[0] +reveal_type(b * b) # revealed: Literal[0] + +reveal_type(a % a) # revealed: Literal[0] +reveal_type(b % a) # revealed: Literal[0] + +reveal_type(a // a) # revealed: Literal[1] +reveal_type(b // a) # revealed: Literal[0] + +reveal_type(a**a) # revealed: Literal[1] +reveal_type(a**b) # revealed: Literal[1] +reveal_type(b**a) # revealed: Literal[0] +reveal_type(b**b) # revealed: Literal[1] + +# Division +reveal_type(a / a) # revealed: float +reveal_type(b / a) # revealed: float +b / b # error: [division-by-zero] "Cannot divide object of type `Literal[False]` by zero" +a / b # error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" + +# bitwise OR +reveal_type(a | a) # revealed: Literal[True] +reveal_type(a | b) # revealed: Literal[True] +reveal_type(b | a) # revealed: Literal[True] +reveal_type(b | b) # revealed: Literal[False] + +# bitwise AND +reveal_type(a & a) # revealed: Literal[True] +reveal_type(a & b) # revealed: Literal[False] +reveal_type(b & a) # revealed: Literal[False] +reveal_type(b & b) # revealed: Literal[False] + +# bitwise XOR +reveal_type(a ^ a) # revealed: Literal[False] +reveal_type(a ^ b) # revealed: Literal[True] +reveal_type(b ^ a) # revealed: Literal[True] +reveal_type(b ^ b) # revealed: Literal[False] +``` + +## Arithmetic with a variable + +```py +def _(a: bool): + def lhs_is_int(x: int): + reveal_type(x + a) # revealed: int + reveal_type(x - a) # revealed: int + reveal_type(x * a) # revealed: int + reveal_type(x // a) # revealed: int + reveal_type(x / a) # revealed: int | float + reveal_type(x % a) # revealed: int + + def rhs_is_int(x: int): + reveal_type(a + x) # revealed: int + reveal_type(a - x) # revealed: int + reveal_type(a * x) # revealed: int + reveal_type(a // x) # revealed: int + reveal_type(a / x) # revealed: int | float + reveal_type(a % x) # revealed: int + + def lhs_is_bool(x: bool): + reveal_type(x + a) # revealed: int + reveal_type(x - a) # revealed: int + reveal_type(x * a) # revealed: int + reveal_type(x // a) # revealed: int + reveal_type(x / a) # revealed: int | float + reveal_type(x % a) # revealed: int + + def rhs_is_bool(x: bool): + reveal_type(a + x) # revealed: int + reveal_type(a - x) # revealed: int + reveal_type(a * x) # revealed: int + reveal_type(a // x) # revealed: int + reveal_type(a / x) # revealed: int | float + reveal_type(a % x) # revealed: int + + def both_are_bool(x: bool, y: bool): + reveal_type(x + y) # revealed: int + reveal_type(x - y) # revealed: int + reveal_type(x * y) # revealed: int + reveal_type(x // y) # revealed: int + reveal_type(x / y) # revealed: int | float + reveal_type(x % y) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/binary/classes.md b/crates/ty_python_semantic/resources/mdtest/binary/classes.md new file mode 100644 index 0000000000000..89dceef0e28b1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/classes.md @@ -0,0 +1,27 @@ +# Binary operations on classes + +## Union of two classes + +Unioning two classes via the `|` operator is only available in Python 3.10 and later. + +```toml +[environment] +python-version = "3.10" +``` + +```py +class A: ... +class B: ... + +reveal_type(A | B) # revealed: UnionType +``` + +## Union of two classes (prior to 3.10) + +```py +class A: ... +class B: ... + +# error: "Operator `|` is unsupported between objects of type `<class 'A'>` and `<class 'B'>`" +reveal_type(A | B) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/binary/custom.md b/crates/ty_python_semantic/resources/mdtest/binary/custom.md new file mode 100644 index 0000000000000..d2587b7a75807 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/custom.md @@ -0,0 +1,379 @@ +# Custom binary operations + +## Class instances + +```py +from typing import Literal + +class Yes: + def __add__(self, other) -> Literal["+"]: + return "+" + + def __sub__(self, other) -> Literal["-"]: + return "-" + + def __mul__(self, other) -> Literal["*"]: + return "*" + + def __matmul__(self, other) -> Literal["@"]: + return "@" + + def __truediv__(self, other) -> Literal["/"]: + return "/" + + def __mod__(self, other) -> Literal["%"]: + return "%" + + def __pow__(self, other) -> Literal["**"]: + return "**" + + def __lshift__(self, other) -> Literal["<<"]: + return "<<" + + def __rshift__(self, other) -> Literal[">>"]: + return ">>" + + def __or__(self, other) -> Literal["|"]: + return "|" + + def __xor__(self, other) -> Literal["^"]: + return "^" + + def __and__(self, other) -> Literal["&"]: + return "&" + + def __floordiv__(self, other) -> Literal["//"]: + return "//" + +class Sub(Yes): ... +class No: ... + +# Yes implements all of the dunder methods. +reveal_type(Yes() + Yes()) # revealed: Literal["+"] +reveal_type(Yes() - Yes()) # revealed: Literal["-"] +reveal_type(Yes() * Yes()) # revealed: Literal["*"] +reveal_type(Yes() @ Yes()) # revealed: Literal["@"] +reveal_type(Yes() / Yes()) # revealed: Literal["/"] +reveal_type(Yes() % Yes()) # revealed: Literal["%"] +reveal_type(Yes() ** Yes()) # revealed: Literal["**"] +reveal_type(Yes() << Yes()) # revealed: Literal["<<"] +reveal_type(Yes() >> Yes()) # revealed: Literal[">>"] +reveal_type(Yes() | Yes()) # revealed: Literal["|"] +reveal_type(Yes() ^ Yes()) # revealed: Literal["^"] +reveal_type(Yes() & Yes()) # revealed: Literal["&"] +reveal_type(Yes() // Yes()) # revealed: Literal["//"] + +# Sub inherits Yes's implementation of the dunder methods. +reveal_type(Sub() + Sub()) # revealed: Literal["+"] +reveal_type(Sub() - Sub()) # revealed: Literal["-"] +reveal_type(Sub() * Sub()) # revealed: Literal["*"] +reveal_type(Sub() @ Sub()) # revealed: Literal["@"] +reveal_type(Sub() / Sub()) # revealed: Literal["/"] +reveal_type(Sub() % Sub()) # revealed: Literal["%"] +reveal_type(Sub() ** Sub()) # revealed: Literal["**"] +reveal_type(Sub() << Sub()) # revealed: Literal["<<"] +reveal_type(Sub() >> Sub()) # revealed: Literal[">>"] +reveal_type(Sub() | Sub()) # revealed: Literal["|"] +reveal_type(Sub() ^ Sub()) # revealed: Literal["^"] +reveal_type(Sub() & Sub()) # revealed: Literal["&"] +reveal_type(Sub() // Sub()) # revealed: Literal["//"] + +# No does not implement any of the dunder methods. +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `No` and `No`" +reveal_type(No() + No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `-` is unsupported between objects of type `No` and `No`" +reveal_type(No() - No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `*` is unsupported between objects of type `No` and `No`" +reveal_type(No() * No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `@` is unsupported between objects of type `No` and `No`" +reveal_type(No() @ No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `/` is unsupported between objects of type `No` and `No`" +reveal_type(No() / No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `%` is unsupported between objects of type `No` and `No`" +reveal_type(No() % No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `**` is unsupported between objects of type `No` and `No`" +reveal_type(No() ** No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `<<` is unsupported between objects of type `No` and `No`" +reveal_type(No() << No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `>>` is unsupported between objects of type `No` and `No`" +reveal_type(No() >> No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `|` is unsupported between objects of type `No` and `No`" +reveal_type(No() | No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `^` is unsupported between objects of type `No` and `No`" +reveal_type(No() ^ No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `&` is unsupported between objects of type `No` and `No`" +reveal_type(No() & No()) # revealed: Unknown +# error: [unsupported-operator] "Operator `//` is unsupported between objects of type `No` and `No`" +reveal_type(No() // No()) # revealed: Unknown + +# Yes does not implement any of the reflected dunder methods. +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() + Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `-` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() - Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `*` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() * Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `@` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() @ Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `/` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() / Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `%` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() % Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `**` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() ** Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `<<` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() << Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `>>` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() >> Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `|` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() | Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `^` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() ^ Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `&` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() & Yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `//` is unsupported between objects of type `No` and `Yes`" +reveal_type(No() // Yes()) # revealed: Unknown +``` + +## Subclass reflections override superclass dunders + +```py +from typing import Literal + +class Yes: + def __add__(self, other) -> Literal["+"]: + return "+" + + def __sub__(self, other) -> Literal["-"]: + return "-" + + def __mul__(self, other) -> Literal["*"]: + return "*" + + def __matmul__(self, other) -> Literal["@"]: + return "@" + + def __truediv__(self, other) -> Literal["/"]: + return "/" + + def __mod__(self, other) -> Literal["%"]: + return "%" + + def __pow__(self, other) -> Literal["**"]: + return "**" + + def __lshift__(self, other) -> Literal["<<"]: + return "<<" + + def __rshift__(self, other) -> Literal[">>"]: + return ">>" + + def __or__(self, other) -> Literal["|"]: + return "|" + + def __xor__(self, other) -> Literal["^"]: + return "^" + + def __and__(self, other) -> Literal["&"]: + return "&" + + def __floordiv__(self, other) -> Literal["//"]: + return "//" + +class Sub(Yes): + def __radd__(self, other) -> Literal["r+"]: + return "r+" + + def __rsub__(self, other) -> Literal["r-"]: + return "r-" + + def __rmul__(self, other) -> Literal["r*"]: + return "r*" + + def __rmatmul__(self, other) -> Literal["r@"]: + return "r@" + + def __rtruediv__(self, other) -> Literal["r/"]: + return "r/" + + def __rmod__(self, other) -> Literal["r%"]: + return "r%" + + def __rpow__(self, other) -> Literal["r**"]: + return "r**" + + def __rlshift__(self, other) -> Literal["r<<"]: + return "r<<" + + def __rrshift__(self, other) -> Literal["r>>"]: + return "r>>" + + def __ror__(self, other) -> Literal["r|"]: + return "r|" + + def __rxor__(self, other) -> Literal["r^"]: + return "r^" + + def __rand__(self, other) -> Literal["r&"]: + return "r&" + + def __rfloordiv__(self, other) -> Literal["r//"]: + return "r//" + +class No: + def __radd__(self, other) -> Literal["r+"]: + return "r+" + + def __rsub__(self, other) -> Literal["r-"]: + return "r-" + + def __rmul__(self, other) -> Literal["r*"]: + return "r*" + + def __rmatmul__(self, other) -> Literal["r@"]: + return "r@" + + def __rtruediv__(self, other) -> Literal["r/"]: + return "r/" + + def __rmod__(self, other) -> Literal["r%"]: + return "r%" + + def __rpow__(self, other) -> Literal["r**"]: + return "r**" + + def __rlshift__(self, other) -> Literal["r<<"]: + return "r<<" + + def __rrshift__(self, other) -> Literal["r>>"]: + return "r>>" + + def __ror__(self, other) -> Literal["r|"]: + return "r|" + + def __rxor__(self, other) -> Literal["r^"]: + return "r^" + + def __rand__(self, other) -> Literal["r&"]: + return "r&" + + def __rfloordiv__(self, other) -> Literal["r//"]: + return "r//" + +# Subclass reflected dunder methods take precedence over the superclass's regular dunders. +reveal_type(Yes() + Sub()) # revealed: Literal["r+"] +reveal_type(Yes() - Sub()) # revealed: Literal["r-"] +reveal_type(Yes() * Sub()) # revealed: Literal["r*"] +reveal_type(Yes() @ Sub()) # revealed: Literal["r@"] +reveal_type(Yes() / Sub()) # revealed: Literal["r/"] +reveal_type(Yes() % Sub()) # revealed: Literal["r%"] +reveal_type(Yes() ** Sub()) # revealed: Literal["r**"] +reveal_type(Yes() << Sub()) # revealed: Literal["r<<"] +reveal_type(Yes() >> Sub()) # revealed: Literal["r>>"] +reveal_type(Yes() | Sub()) # revealed: Literal["r|"] +reveal_type(Yes() ^ Sub()) # revealed: Literal["r^"] +reveal_type(Yes() & Sub()) # revealed: Literal["r&"] +reveal_type(Yes() // Sub()) # revealed: Literal["r//"] + +# But for an unrelated class, the superclass regular dunders are used. +reveal_type(Yes() + No()) # revealed: Literal["+"] +reveal_type(Yes() - No()) # revealed: Literal["-"] +reveal_type(Yes() * No()) # revealed: Literal["*"] +reveal_type(Yes() @ No()) # revealed: Literal["@"] +reveal_type(Yes() / No()) # revealed: Literal["/"] +reveal_type(Yes() % No()) # revealed: Literal["%"] +reveal_type(Yes() ** No()) # revealed: Literal["**"] +reveal_type(Yes() << No()) # revealed: Literal["<<"] +reveal_type(Yes() >> No()) # revealed: Literal[">>"] +reveal_type(Yes() | No()) # revealed: Literal["|"] +reveal_type(Yes() ^ No()) # revealed: Literal["^"] +reveal_type(Yes() & No()) # revealed: Literal["&"] +reveal_type(Yes() // No()) # revealed: Literal["//"] +``` + +## Classes + +Dunder methods defined in a class are available to instances of that class, but not to the class +itself. (For these operators to work on the class itself, they would have to be defined on the +class's type, i.e. `type`.) + +```py +from typing import Literal + +class Yes: + def __add__(self, other) -> Literal["+"]: + return "+" + +class Sub(Yes): ... +class No: ... + +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `<class 'Yes'>` and `<class 'Yes'>`" +reveal_type(Yes + Yes) # revealed: Unknown +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `<class 'Sub'>` and `<class 'Sub'>`" +reveal_type(Sub + Sub) # revealed: Unknown +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `<class 'No'>` and `<class 'No'>`" +reveal_type(No + No) # revealed: Unknown +``` + +## Subclass + +```py +from typing import Literal + +class Yes: + def __add__(self, other) -> Literal["+"]: + return "+" + +class Sub(Yes): ... +class No: ... + +def yes() -> type[Yes]: + return Yes + +def sub() -> type[Sub]: + return Sub + +def no() -> type[No]: + return No + +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `type[Yes]` and `type[Yes]`" +reveal_type(yes() + yes()) # revealed: Unknown +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `type[Sub]` and `type[Sub]`" +reveal_type(sub() + sub()) # revealed: Unknown +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `type[No]` and `type[No]`" +reveal_type(no() + no()) # revealed: Unknown +``` + +## Function literals + +```py +def f(): + pass + +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f + f) # revealed: Unknown +# error: [unsupported-operator] "Operator `-` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f - f) # revealed: Unknown +# error: [unsupported-operator] "Operator `*` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f * f) # revealed: Unknown +# error: [unsupported-operator] "Operator `@` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f @ f) # revealed: Unknown +# error: [unsupported-operator] "Operator `/` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f / f) # revealed: Unknown +# error: [unsupported-operator] "Operator `%` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f % f) # revealed: Unknown +# error: [unsupported-operator] "Operator `**` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f**f) # revealed: Unknown +# error: [unsupported-operator] "Operator `<<` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f << f) # revealed: Unknown +# error: [unsupported-operator] "Operator `>>` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f >> f) # revealed: Unknown +# error: [unsupported-operator] "Operator `|` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f | f) # revealed: Unknown +# error: [unsupported-operator] "Operator `^` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f ^ f) # revealed: Unknown +# error: [unsupported-operator] "Operator `&` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f & f) # revealed: Unknown +# error: [unsupported-operator] "Operator `//` is unsupported between objects of type `def f() -> Unknown` and `def f() -> Unknown`" +reveal_type(f // f) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/binary/instances.md b/crates/ty_python_semantic/resources/mdtest/binary/instances.md new file mode 100644 index 0000000000000..c27e70ed76e0f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/instances.md @@ -0,0 +1,474 @@ +# Binary operations on instances + +Binary operations in Python are implemented by means of magic double-underscore methods. + +For references, see: + +- <https://snarky.ca/unravelling-binary-arithmetic-operations-in-python/> +- <https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types> + +## Operations + +We support inference for all Python's binary operators: `+`, `-`, `*`, `@`, `/`, `//`, `%`, `**`, +`<<`, `>>`, `&`, `^`, and `|`. + +```py +class A: + def __add__(self, other) -> "A": + return self + + def __sub__(self, other) -> "A": + return self + + def __mul__(self, other) -> "A": + return self + + def __matmul__(self, other) -> "A": + return self + + def __truediv__(self, other) -> "A": + return self + + def __floordiv__(self, other) -> "A": + return self + + def __mod__(self, other) -> "A": + return self + + def __pow__(self, other) -> "A": + return self + + def __lshift__(self, other) -> "A": + return self + + def __rshift__(self, other) -> "A": + return self + + def __and__(self, other) -> "A": + return self + + def __xor__(self, other) -> "A": + return self + + def __or__(self, other) -> "A": + return self + +class B: ... + +reveal_type(A() + B()) # revealed: A +reveal_type(A() - B()) # revealed: A +reveal_type(A() * B()) # revealed: A +reveal_type(A() @ B()) # revealed: A +reveal_type(A() / B()) # revealed: A +reveal_type(A() // B()) # revealed: A +reveal_type(A() % B()) # revealed: A +reveal_type(A() ** B()) # revealed: A +reveal_type(A() << B()) # revealed: A +reveal_type(A() >> B()) # revealed: A +reveal_type(A() & B()) # revealed: A +reveal_type(A() ^ B()) # revealed: A +reveal_type(A() | B()) # revealed: A +``` + +## Reflected + +We also support inference for reflected operations: + +```py +class A: + def __radd__(self, other) -> "A": + return self + + def __rsub__(self, other) -> "A": + return self + + def __rmul__(self, other) -> "A": + return self + + def __rmatmul__(self, other) -> "A": + return self + + def __rtruediv__(self, other) -> "A": + return self + + def __rfloordiv__(self, other) -> "A": + return self + + def __rmod__(self, other) -> "A": + return self + + def __rpow__(self, other) -> "A": + return self + + def __rlshift__(self, other) -> "A": + return self + + def __rrshift__(self, other) -> "A": + return self + + def __rand__(self, other) -> "A": + return self + + def __rxor__(self, other) -> "A": + return self + + def __ror__(self, other) -> "A": + return self + +class B: ... + +reveal_type(B() + A()) # revealed: A +reveal_type(B() - A()) # revealed: A +reveal_type(B() * A()) # revealed: A +reveal_type(B() @ A()) # revealed: A +reveal_type(B() / A()) # revealed: A +reveal_type(B() // A()) # revealed: A +reveal_type(B() % A()) # revealed: A +reveal_type(B() ** A()) # revealed: A +reveal_type(B() << A()) # revealed: A +reveal_type(B() >> A()) # revealed: A +reveal_type(B() & A()) # revealed: A +reveal_type(B() ^ A()) # revealed: A +reveal_type(B() | A()) # revealed: A +``` + +## Returning a different type + +The magic methods aren't required to return the type of `self`: + +```py +class A: + def __add__(self, other) -> int: + return 1 + + def __rsub__(self, other) -> int: + return 1 + +class B: ... + +reveal_type(A() + B()) # revealed: int +reveal_type(B() - A()) # revealed: int +``` + +## Non-reflected precedence in general + +In general, if the left-hand side defines `__add__` and the right-hand side defines `__radd__` and +the right-hand side is not a subtype of the left-hand side, `lhs.__add__` will take precedence: + +```py +class A: + def __add__(self, other: "B") -> int: + return 42 + +class B: + def __radd__(self, other: "A") -> str: + return "foo" + +reveal_type(A() + B()) # revealed: int + +# Edge case: C is a subtype of C, *but* if the two sides are of *equal* types, +# the lhs *still* takes precedence +class C: + def __add__(self, other: "C") -> int: + return 42 + + def __radd__(self, other: "C") -> str: + return "foo" + +reveal_type(C() + C()) # revealed: int +``` + +## Reflected precedence for subtypes (in some cases) + +If the right-hand operand is a subtype of the left-hand operand and has a different implementation +of the reflected method, the reflected method on the right-hand operand takes precedence. + +```py +class A: + def __add__(self, other) -> str: + return "foo" + + def __radd__(self, other) -> str: + return "foo" + +class MyString(str): ... + +class B(A): + def __radd__(self, other) -> MyString: + return MyString() + +reveal_type(A() + B()) # revealed: MyString + +# N.B. Still a subtype of `A`, even though `A` does not appear directly in the class's `__bases__` +class C(B): ... + +reveal_type(A() + C()) # revealed: MyString +``` + +## Reflected precedence 2 + +If the right-hand operand is a subtype of the left-hand operand, but does not override the reflected +method, the left-hand operand's non-reflected method still takes precedence: + +```py +class A: + def __add__(self, other) -> str: + return "foo" + + def __radd__(self, other) -> int: + return 42 + +class B(A): ... + +reveal_type(A() + B()) # revealed: str +``` + +## Only reflected supported + +For example, at runtime, `(1).__add__(1.2)` is `NotImplemented`, but `(1.2).__radd__(1) == 2.2`, +meaning that `1 + 1.2` succeeds at runtime (producing `2.2`). The runtime tries the second one only +if the first one returns `NotImplemented` to signal failure. + +Typeshed and other stubs annotate dunder-method calls that would return `NotImplemented` as being +"illegal" calls. `int.__add__` is annotated as only "accepting" `int`s, even though it +strictly-speaking "accepts" any other object without raising an exception -- it will simply return +`NotImplemented`, allowing the runtime to try the `__radd__` method of the right-hand operand as +well. + +```py +class A: + def __sub__(self, other: "A") -> "A": + return A() + +class B: + def __rsub__(self, other: A) -> "B": + return B() + +reveal_type(A() - B()) # revealed: B +``` + +## Callable instances as dunders + +Believe it or not, this is supported at runtime: + +```py +class A: + def __call__(self, other) -> int: + return 42 + +class B: + __add__ = A() + +reveal_type(B() + B()) # revealed: Unknown | int +``` + +Note that we union with `Unknown` here because `__add__` is not declared. We do infer just `int` if +the callable is declared: + +```py +class B2: + __add__: A = A() + +reveal_type(B2() + B2()) # revealed: int +``` + +## Integration test: numbers from typeshed + +We get less precise results from binary operations on float/complex literals due to the special case +for annotations of `float` or `complex`, which applies also to return annotations for typeshed +dunder methods. Perhaps we could have a special-case on the special-case, to exclude these typeshed +return annotations from the widening, and preserve a bit more precision here? + +```py +reveal_type(3j + 3.14) # revealed: int | float | complex +reveal_type(4.2 + 42) # revealed: int | float +reveal_type(3j + 3) # revealed: int | float | complex +reveal_type(3.14 + 3j) # revealed: int | float | complex +reveal_type(42 + 4.2) # revealed: int | float +reveal_type(3 + 3j) # revealed: int | float | complex + +def _(x: bool, y: int): + reveal_type(x + y) # revealed: int + reveal_type(4.2 + x) # revealed: int | float + reveal_type(y + 4.12) # revealed: int | float +``` + +## With literal types + +When we have a literal type for one operand, we're able to fall back to the instance handling for +its instance super-type. + +```py +class A: + def __add__(self, other) -> "A": + return self + + def __radd__(self, other) -> "A": + return self + +reveal_type(A() + 1) # revealed: A +reveal_type(1 + A()) # revealed: A + +reveal_type(A() + "foo") # revealed: A +reveal_type("foo" + A()) # revealed: A + +reveal_type(A() + b"foo") # revealed: A +# TODO should be `A` since `bytes.__add__` doesn't support `A` instances +reveal_type(b"foo" + A()) # revealed: bytes + +reveal_type(A() + ()) # revealed: A +reveal_type(() + A()) # revealed: A + +literal_string_instance = "foo" * 1_000_000_000 +# the test is not testing what it's meant to be testing if this isn't a `LiteralString`: +reveal_type(literal_string_instance) # revealed: LiteralString + +reveal_type(A() + literal_string_instance) # revealed: A +reveal_type(literal_string_instance + A()) # revealed: A +``` + +## Operations involving instances of classes inheriting from `Any` + +`Any` and `Unknown` represent a set of possible runtime objects, wherein the bounds of the set are +unknown. Whether the left-hand operand's dunder or the right-hand operand's reflected dunder depends +on whether the right-hand operand is an instance of a class that is a subclass of the left-hand +operand's class and overrides the reflected dunder. In the following example, because of the +unknowable nature of `Any`/`Unknown`, we must consider both possibilities: `Any`/`Unknown` might +resolve to an unknown third class that inherits from `X` and overrides `__radd__`; but it also might +not. Thus, the correct answer here for the `reveal_type` is `int | Unknown`. + +```py +from does_not_exist import Foo # error: [unresolved-import] + +reveal_type(Foo) # revealed: Unknown + +class X: + def __add__(self, other: object) -> int: + return 42 + +class Y(Foo): ... + +# TODO: Should be `int | Unknown`; see above discussion. +reveal_type(X() + Y()) # revealed: int +``` + +## Operations involving types with invalid `__bool__` methods + +<!-- snapshot-diagnostics --> + +```py +class NotBoolable: + __bool__: int = 3 + +a = NotBoolable() + +# error: [unsupported-bool-conversion] +10 and a and True +``` + +## Operations on class objects + +When operating on class objects, the corresponding dunder methods are looked up on the metaclass. + +```py +from __future__ import annotations + +class Meta(type): + def __add__(self, other: Meta) -> int: + return 1 + + def __lt__(self, other: Meta) -> bool: + return True + + def __getitem__(self, key: int) -> str: + return "a" + +class A(metaclass=Meta): ... +class B(metaclass=Meta): ... + +reveal_type(A + B) # revealed: int +# error: [unsupported-operator] "Operator `-` is unsupported between objects of type `<class 'A'>` and `<class 'B'>`" +reveal_type(A - B) # revealed: Unknown + +reveal_type(A < B) # revealed: bool +reveal_type(A > B) # revealed: bool + +# error: [unsupported-operator] "Operator `<=` is not supported for types `<class 'A'>` and `<class 'B'>`" +reveal_type(A <= B) # revealed: Unknown + +reveal_type(A[0]) # revealed: str +``` + +## Unsupported + +### Dunder as instance attribute + +The magic method must exist on the class, not just on the instance: + +```py +def add_impl(self, other) -> int: + return 1 + +class A: + def __init__(self): + self.__add__ = add_impl + +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `A` and `A`" +# revealed: Unknown +reveal_type(A() + A()) +``` + +### Missing dunder + +```py +class A: ... + +# error: [unsupported-operator] +# revealed: Unknown +reveal_type(A() + A()) +``` + +### Wrong position + +A left-hand dunder method doesn't apply for the right-hand operand, or vice versa: + +```py +class A: + def __add__(self, other) -> int: + return 1 + +class B: + def __radd__(self, other) -> int: + return 1 + +class C: ... + +# error: [unsupported-operator] +# revealed: Unknown +reveal_type(C() + A()) + +# error: [unsupported-operator] +# revealed: Unknown +reveal_type(B() + C()) +``` + +### Reflected dunder is not tried between two objects of the same type + +For the specific case where the left-hand operand is the exact same type as the right-hand operand, +the reflected dunder of the right-hand operand is not tried; the runtime short-circuits after trying +the unreflected dunder of the left-hand operand. For context, see +[this mailing list discussion](https://mail.python.org/archives/list/python-dev@python.org/thread/7NZUCODEAPQFMRFXYRMGJXDSIS3WJYIV/). + +```py +class Foo: + def __radd__(self, other: "Foo") -> "Foo": + return self + +# error: [unsupported-operator] +# revealed: Unknown +reveal_type(Foo() + Foo()) +``` + +### Wrong type + +TODO: check signature and error if `other` is the wrong type diff --git a/crates/ty_python_semantic/resources/mdtest/binary/integers.md b/crates/ty_python_semantic/resources/mdtest/binary/integers.md new file mode 100644 index 0000000000000..d7e920ed0efc1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/integers.md @@ -0,0 +1,115 @@ +# Binary operations on integers + +## Basic Arithmetic + +```py +reveal_type(2 + 1) # revealed: Literal[3] +reveal_type(3 - 4) # revealed: Literal[-1] +reveal_type(3 * -1) # revealed: Literal[-3] +reveal_type(-3 // 3) # revealed: Literal[-1] +reveal_type(-3 / 3) # revealed: float +reveal_type(5 % 3) # revealed: Literal[2] +reveal_type(3 | 4) # revealed: Literal[7] +reveal_type(5 & 6) # revealed: Literal[4] +reveal_type(7 ^ 2) # revealed: Literal[5] + +# error: [unsupported-operator] "Operator `+` is unsupported between objects of type `Literal[2]` and `Literal["f"]`" +reveal_type(2 + "f") # revealed: Unknown + +def lhs(x: int): + reveal_type(x + 1) # revealed: int + reveal_type(x - 4) # revealed: int + reveal_type(x * -1) # revealed: int + reveal_type(x // 3) # revealed: int + reveal_type(x / 3) # revealed: int | float + reveal_type(x % 3) # revealed: int + +def rhs(x: int): + reveal_type(2 + x) # revealed: int + reveal_type(3 - x) # revealed: int + reveal_type(3 * x) # revealed: int + reveal_type(-3 // x) # revealed: int + reveal_type(-3 / x) # revealed: int | float + reveal_type(5 % x) # revealed: int + +def both(x: int): + reveal_type(x + x) # revealed: int + reveal_type(x - x) # revealed: int + reveal_type(x * x) # revealed: int + reveal_type(x // x) # revealed: int + reveal_type(x / x) # revealed: int | float + reveal_type(x % x) # revealed: int +``` + +## Power + +For power if the result fits in the int literal type it will be a Literal type. Otherwise the +outcome is int. + +```py +largest_u32 = 4_294_967_295 +reveal_type(2**2) # revealed: Literal[4] +reveal_type(1 ** (largest_u32 + 1)) # revealed: int +reveal_type(2**largest_u32) # revealed: int + +def variable(x: int): + reveal_type(x**2) # revealed: int + # TODO: should be `Any` (overload 5 on `__pow__`), requires correct overload matching + reveal_type(2**x) # revealed: int + # TODO: should be `Any` (overload 5 on `__pow__`), requires correct overload matching + reveal_type(x**x) # revealed: int +``` + +If the second argument is \<0, a `float` is returned at runtime. If the first argument is \<0 but +the second argument is >=0, an `int` is still returned: + +```py +reveal_type(1**0) # revealed: Literal[1] +reveal_type(0**1) # revealed: Literal[0] +reveal_type(0**0) # revealed: Literal[1] +reveal_type((-1) ** 2) # revealed: Literal[1] +reveal_type(2 ** (-1)) # revealed: float +reveal_type((-1) ** (-1)) # revealed: float +``` + +## Division by Zero + +This error is really outside the current Python type system, because e.g. `int.__truediv__` and +friends are not annotated to indicate that it's an error, and we don't even have a facility to +permit such an annotation. So arguably divide-by-zero should be a lint error rather than a type +checker error. But we choose to go ahead and error in the cases that are very likely to be an error: +dividing something typed as `int` or `float` by something known to be `Literal[0]`. + +This isn't _definitely_ an error, because the object typed as `int` or `float` could be an instance +of a custom subclass which overrides division behavior to handle zero without error. But if this +unusual case occurs, the error can be avoided by explicitly typing the dividend as that safe custom +subclass; we only emit the error if the LHS type is exactly `int` or `float`, not if its a subclass. + +```py +a = 1 / 0 # error: "Cannot divide object of type `Literal[1]` by zero" +reveal_type(a) # revealed: float + +b = 2 // 0 # error: "Cannot floor divide object of type `Literal[2]` by zero" +reveal_type(b) # revealed: int + +c = 3 % 0 # error: "Cannot reduce object of type `Literal[3]` modulo zero" +reveal_type(c) # revealed: int + +# error: "Cannot divide object of type `int` by zero" +reveal_type(int() / 0) # revealed: int | float + +# error: "Cannot divide object of type `Literal[1]` by zero" +reveal_type(1 / False) # revealed: float +# error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" +True / False +# error: [division-by-zero] "Cannot divide object of type `Literal[True]` by zero" +bool(1) / False + +# error: "Cannot divide object of type `float` by zero" +reveal_type(1.0 / 0) # revealed: int | float + +class MyInt(int): ... + +# No error for a subclass of int +reveal_type(MyInt(3) / 0) # revealed: int | float +``` diff --git a/crates/ty_python_semantic/resources/mdtest/binary/tuples.md b/crates/ty_python_semantic/resources/mdtest/binary/tuples.md new file mode 100644 index 0000000000000..78279831fd4ca --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/tuples.md @@ -0,0 +1,22 @@ +# Binary operations on tuples + +## Concatenation for heterogeneous tuples + +```py +reveal_type((1, 2) + (3, 4)) # revealed: tuple[Literal[1], Literal[2], Literal[3], Literal[4]] +reveal_type(() + (1, 2)) # revealed: tuple[Literal[1], Literal[2]] +reveal_type((1, 2) + ()) # revealed: tuple[Literal[1], Literal[2]] +reveal_type(() + ()) # revealed: tuple[()] + +def _(x: tuple[int, str], y: tuple[None, tuple[int]]): + reveal_type(x + y) # revealed: tuple[int, str, None, tuple[int]] + reveal_type(y + x) # revealed: tuple[None, tuple[int], int, str] +``` + +## Concatenation for homogeneous tuples + +```py +def _(x: tuple[int, ...], y: tuple[str, ...]): + reveal_type(x + y) # revealed: tuple[int | str, ...] + reveal_type(x + (1, 2)) # revealed: tuple[int, ...] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/binary/unions.md b/crates/ty_python_semantic/resources/mdtest/binary/unions.md new file mode 100644 index 0000000000000..1ec0794cc4db7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/binary/unions.md @@ -0,0 +1,59 @@ +# Binary operations on union types + +Binary operations on union types are only available if they are supported for all possible +combinations of types: + +```py +def f1(i: int, u: int | None): + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `int` and `int | None`" + reveal_type(i + u) # revealed: Unknown + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `int | None` and `int`" + reveal_type(u + i) # revealed: Unknown +``` + +`int` can be added to `int`, and `str` can be added to `str`, but expressions of type `int | str` +cannot be added, because that would require addition of `int` and `str` or vice versa: + +```py +def f2(i: int, s: str, int_or_str: int | str): + i + i + s + s + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `int | str` and `int | str`" + reveal_type(int_or_str + int_or_str) # revealed: Unknown +``` + +However, if an operation is supported for all possible combinations, the result will be a union of +the possible outcomes: + +```py +from typing import Literal + +def f3(two_or_three: Literal[2, 3], a_or_b: Literal["a", "b"]): + reveal_type(two_or_three + two_or_three) # revealed: Literal[4, 5, 6] + reveal_type(two_or_three**two_or_three) # revealed: Literal[4, 8, 9, 27] + + reveal_type(a_or_b + a_or_b) # revealed: Literal["aa", "ab", "ba", "bb"] + + reveal_type(two_or_three * a_or_b) # revealed: Literal["aa", "bb", "aaa", "bbb"] +``` + +We treat a type annotation of `float` as a union of `int` and `float`, so union handling is relevant +here: + +```py +def f4(x: float, y: float): + reveal_type(x + y) # revealed: int | float + reveal_type(x - y) # revealed: int | float + reveal_type(x * y) # revealed: int | float + reveal_type(x / y) # revealed: int | float + reveal_type(x // y) # revealed: int | float + reveal_type(x % y) # revealed: int | float +``` + +If any of the union elements leads to a division by zero, we will report an error: + +```py +def f5(m: int, n: Literal[-1, 0, 1]): + # error: [division-by-zero] "Cannot divide object of type `int` by zero" + return m / n +``` diff --git a/crates/ty_python_semantic/resources/mdtest/boolean/short_circuit.md b/crates/ty_python_semantic/resources/mdtest/boolean/short_circuit.md new file mode 100644 index 0000000000000..f77eea2d3140f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/boolean/short_circuit.md @@ -0,0 +1,67 @@ +# Short-Circuit Evaluation + +## Not all boolean expressions must be evaluated + +In `or` expressions, if the left-hand side is truthy, the right-hand side is not evaluated. +Similarly, in `and` expressions, if the left-hand side is falsy, the right-hand side is not +evaluated. + +```py +def _(flag: bool): + if flag or (x := 1): + # error: [possibly-unresolved-reference] + reveal_type(x) # revealed: Literal[1] + + if flag and (x := 1): + # error: [possibly-unresolved-reference] + reveal_type(x) # revealed: Literal[1] +``` + +## First expression is always evaluated + +```py +def _(flag: bool): + if (x := 1) or flag: + reveal_type(x) # revealed: Literal[1] + + if (x := 1) and flag: + reveal_type(x) # revealed: Literal[1] +``` + +## Statically known truthiness + +```py +if True or (x := 1): + # error: [unresolved-reference] + reveal_type(x) # revealed: Unknown + +if True and (x := 1): + reveal_type(x) # revealed: Literal[1] +``` + +## Later expressions can always use variables from earlier expressions + +```py +def _(flag: bool): + flag or (x := 1) or reveal_type(x) # revealed: Never + + # error: [unresolved-reference] + flag or reveal_type(y) or (y := 1) # revealed: Unknown +``` + +## Nested expressions + +```py +def _(flag1: bool, flag2: bool): + if flag1 or ((x := 1) and flag2): + # error: [possibly-unresolved-reference] + reveal_type(x) # revealed: Literal[1] + + if ((y := 1) and flag1) or flag2: + reveal_type(y) # revealed: Literal[1] + + # error: [possibly-unresolved-reference] + if (flag1 and (z := 1)) or reveal_type(z): # revealed: Literal[1] + # error: [possibly-unresolved-reference] + reveal_type(z) # revealed: Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/boundness_declaredness/public.md b/crates/ty_python_semantic/resources/mdtest/boundness_declaredness/public.md new file mode 100644 index 0000000000000..ab4f3ff0de064 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/boundness_declaredness/public.md @@ -0,0 +1,357 @@ +# Boundness and declaredness: public uses + +This document demonstrates how type-inference and diagnostics work for *public* uses of a symbol, +that is, a use of a symbol from another scope. If a symbol has a declared type in its local scope +(e.g. `int`), we use that as the symbol's "public type" (the type of the symbol from the perspective +of other scopes) even if there is a more precise local inferred type for the symbol (`Literal[1]`). + +If a symbol has no declared type, we use the union of `Unknown` with the inferred type as the public +type. If there is no declaration, then the symbol can be reassigned to any type from another scope; +the union with `Unknown` reflects that its type must at least be as large as the type of the +assigned value, but could be arbitrarily larger. + +We test the whole matrix of possible boundness and declaredness states. The current behavior is +summarized in the following table, while the tests below demonstrate each case. Note that some of +this behavior is questionable and might change in the future. See the TODOs in `symbol_by_id` +(`types.rs`) and [this issue](https://github.com/astral-sh/ruff/issues/14297) for more information. +In particular, we should raise errors in the "possibly-undeclared-and-unbound" as well as the +"undeclared-and-possibly-unbound" cases (marked with a "?"). + +| **Public type** | declared | possibly-undeclared | undeclared | +| ---------------- | ------------ | -------------------------- | ----------------------- | +| bound | `T_declared` | `T_declared \| T_inferred` | `Unknown \| T_inferred` | +| possibly-unbound | `T_declared` | `T_declared \| T_inferred` | `Unknown \| T_inferred` | +| unbound | `T_declared` | `T_declared` | `Unknown` | + +| **Diagnostic** | declared | possibly-undeclared | undeclared | +| ---------------- | -------- | ------------------------- | ------------------- | +| bound | | | | +| possibly-unbound | | `possibly-unbound-import` | ? | +| unbound | | ? | `unresolved-import` | + +## Declared + +### Declared and bound + +If a symbol has a declared type (`int`), we use that even if there is a more precise inferred type +(`Literal[1]`), or a conflicting inferred type (`str` vs. `Literal[2]` below): + +`mod.py`: + +```py +from typing import Any + +def any() -> Any: ... + +a: int = 1 +b: str = 2 # error: [invalid-assignment] +c: Any = 3 +d: int = any() +``` + +```py +from mod import a, b, c, d + +reveal_type(a) # revealed: int +reveal_type(b) # revealed: str +reveal_type(c) # revealed: Any +reveal_type(d) # revealed: int +``` + +### Declared and possibly unbound + +If a symbol is declared and *possibly* unbound, we trust that other module and use the declared type +without raising an error. + +`mod.py`: + +```py +from typing import Any + +def any() -> Any: ... +def flag() -> bool: + return True + +a: int +b: str +c: Any +d: int + +if flag: + a = 1 + b = 2 # error: [invalid-assignment] + c = 3 + d = any() +``` + +```py +from mod import a, b, c, d + +reveal_type(a) # revealed: int +reveal_type(b) # revealed: str +reveal_type(c) # revealed: Any +reveal_type(d) # revealed: int +``` + +### Declared and unbound + +Similarly, if a symbol is declared but unbound, we do not raise an error. We trust that this symbol +is available somehow and simply use the declared type. + +`mod.py`: + +```py +from typing import Any + +a: int +b: Any +``` + +```py +from mod import a, b + +reveal_type(a) # revealed: int +reveal_type(b) # revealed: Any +``` + +## Possibly undeclared + +### Possibly undeclared and bound + +If a symbol is possibly undeclared but definitely bound, we use the union of the declared and +inferred types: + +`mod.py`: + +```py +from typing import Any + +def any() -> Any: ... +def flag() -> bool: + return True + +a = 1 +b = 2 +c = 3 +d = any() +if flag(): + a: int + b: Any + c: str # error: [invalid-declaration] + d: int +``` + +```py +from mod import a, b, c, d + +reveal_type(a) # revealed: int +reveal_type(b) # revealed: Literal[2] | Any +reveal_type(c) # revealed: Literal[3] | Unknown +reveal_type(d) # revealed: Any | int + +# External modifications of `a` that violate the declared type are not allowed: +# error: [invalid-assignment] +a = None +``` + +### Possibly undeclared and possibly unbound + +If a symbol is possibly undeclared and possibly unbound, we also use the union of the declared and +inferred types. This case is interesting because the "possibly declared" definition might not be the +same as the "possibly bound" definition (symbol `b`). Note that we raise a `possibly-unbound-import` +error for both `a` and `b`: + +`mod.py`: + +```py +from typing import Any + +def flag() -> bool: + return True + +if flag(): + a: Any = 1 + b = 2 +else: + b: str +``` + +```py +# error: [possibly-unbound-import] +# error: [possibly-unbound-import] +from mod import a, b + +reveal_type(a) # revealed: Literal[1] | Any +reveal_type(b) # revealed: Literal[2] | str + +# External modifications of `b` that violate the declared type are not allowed: +# error: [invalid-assignment] +b = None +``` + +### Possibly undeclared and unbound + +If a symbol is possibly undeclared and definitely unbound, we currently do not raise an error. This +seems inconsistent when compared to the case just above. + +`mod.py`: + +```py +def flag() -> bool: + return True + +if flag(): + a: int +``` + +```py +# TODO: this should raise an error. Once we fix this, update the section description and the table +# on top of this document. +from mod import a + +reveal_type(a) # revealed: int + +# External modifications to `a` that violate the declared type are not allowed: +# error: [invalid-assignment] +a = None +``` + +## Undeclared + +### Undeclared but bound + +If a symbol is *undeclared*, we use the union of `Unknown` with the inferred type. Note that we +treat this case differently from the case where a symbol is implicitly declared with `Unknown`, +possibly due to the usage of an unknown name in the annotation: + +`mod.py`: + +```py +# Undeclared: +a = 1 + +# Implicitly declared with `Unknown`, due to the usage of an unknown name in the annotation: +b: SomeUnknownName = 1 # error: [unresolved-reference] +``` + +```py +from mod import a, b + +reveal_type(a) # revealed: Unknown | Literal[1] +reveal_type(b) # revealed: Unknown + +# All external modifications of `a` are allowed: +a = None +``` + +### Undeclared and possibly unbound + +If a symbol is undeclared and *possibly* unbound, we currently do not raise an error. This seems +inconsistent when compared to the "possibly-undeclared-and-possibly-unbound" case. + +`mod.py`: + +```py +def flag() -> bool: + return True + +if flag: + a = 1 + b: SomeUnknownName = 1 # error: [unresolved-reference] +``` + +```py +# TODO: this should raise an error. Once we fix this, update the section description and the table +# on top of this document. +from mod import a, b + +reveal_type(a) # revealed: Unknown | Literal[1] +reveal_type(b) # revealed: Unknown + +# All external modifications of `a` are allowed: +a = None +``` + +### Undeclared and unbound + +If a symbol is undeclared *and* unbound, we infer `Unknown` and raise an error. + +`mod.py`: + +```py +if False: + a: int = 1 +``` + +```py +# error: [unresolved-import] +from mod import a + +reveal_type(a) # revealed: Unknown + +# Modifications allowed in this case: +a = None +``` + +## In stub files + +In stub files, we have a minor modification to the rules above: we do not union with `Unknown` for +undeclared symbols. + +### Undeclared and bound + +`mod.pyi`: + +```pyi +MyInt = int + +class C: + MyStr = str +``` + +```py +from mod import MyInt, C + +reveal_type(MyInt) # revealed: <class 'int'> +reveal_type(C.MyStr) # revealed: <class 'str'> +``` + +### Undeclared and possibly unbound + +`mod.pyi`: + +```pyi +def flag() -> bool: + return True + +if flag(): + MyInt = int + + class C: + MyStr = str +``` + +```py +# error: [possibly-unbound-import] +# error: [possibly-unbound-import] +from mod import MyInt, C + +reveal_type(MyInt) # revealed: <class 'int'> +reveal_type(C.MyStr) # revealed: <class 'str'> +``` + +### Undeclared and unbound + +`mod.pyi`: + +```pyi +if False: + MyInt = int +``` + +```py +# error: [unresolved-import] +from mod import MyInt + +reveal_type(MyInt) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/annotation.md b/crates/ty_python_semantic/resources/mdtest/call/annotation.md new file mode 100644 index 0000000000000..937d4226fc4a9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/annotation.md @@ -0,0 +1,43 @@ +# `typing.Callable` + +```py +from typing import Callable + +def _(c: Callable[[], int]): + reveal_type(c()) # revealed: int + +def _(c: Callable[[int, str], int]): + reveal_type(c(1, "a")) # revealed: int + + # error: [invalid-argument-type] "Argument is incorrect: Expected `int`, found `Literal["a"]`" + # error: [invalid-argument-type] "Argument is incorrect: Expected `str`, found `Literal[1]`" + reveal_type(c("a", 1)) # revealed: int +``` + +The `Callable` annotation can only be used to describe positional-only parameters. + +```py +def _(c: Callable[[int, str], None]): + # error: [unknown-argument] "Argument `a` does not match any known parameter" + # error: [unknown-argument] "Argument `b` does not match any known parameter" + # error: [missing-argument] "No arguments provided for required parameters 1, 2" + reveal_type(c(a=1, b="b")) # revealed: None +``` + +If the annotation uses a gradual form (`...`) for the parameter list, then it can accept any kind of +parameter with any type. + +```py +def _(c: Callable[..., int]): + reveal_type(c()) # revealed: int + reveal_type(c(1)) # revealed: int + reveal_type(c(1, "str", False, a=[1, 2], b=(3, 4))) # revealed: int +``` + +An invalid `Callable` form can accept any parameters and will return `Unknown`. + +```py +# error: [invalid-type-form] +def _(c: Callable[42, str]): + reveal_type(c()) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/builtins.md b/crates/ty_python_semantic/resources/mdtest/call/builtins.md new file mode 100644 index 0000000000000..a2bee55560036 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/builtins.md @@ -0,0 +1,101 @@ +# Calling builtins + +## `bool` with incorrect arguments + +```py +class NotBool: + __bool__ = None + +# error: [too-many-positional-arguments] "Too many positional arguments to class `bool`: expected 1, got 2" +bool(1, 2) + +# TODO: We should emit an `unsupported-bool-conversion` error here because the argument doesn't implement `__bool__` correctly. +bool(NotBool()) +``` + +## Calls to `type()` + +A single-argument call to `type()` returns an object that has the argument's meta-type. (This is +tested more extensively in `crates/ty_python_semantic/resources/mdtest/attributes.md`, alongside the +tests for the `__class__` attribute.) + +```py +reveal_type(type(1)) # revealed: <class 'int'> +``` + +But a three-argument call to type creates a dynamic instance of the `type` class: + +```py +class Base: ... + +reveal_type(type("Foo", (), {})) # revealed: type + +reveal_type(type("Foo", (Base,), {"attr": 1})) # revealed: type +``` + +Other numbers of arguments are invalid + +```py +# error: [no-matching-overload] "No overload of class `type` matches arguments" +type("Foo", ()) + +# error: [no-matching-overload] "No overload of class `type` matches arguments" +type("Foo", (), {}, weird_other_arg=42) +``` + +The following calls are also invalid, due to incorrect argument types: + +```py +class Base: ... + +# error: [no-matching-overload] "No overload of class `type` matches arguments" +type(b"Foo", (), {}) + +# error: [no-matching-overload] "No overload of class `type` matches arguments" +type("Foo", Base, {}) + +# error: [no-matching-overload] "No overload of class `type` matches arguments" +type("Foo", (1, 2), {}) + +# TODO: this should be an error +type("Foo", (Base,), {b"attr": 1}) +``` + +## Calls to `str()` + +### Valid calls + +```py +str() +str("") +str(b"") +str(1) +str(object=1) + +str(b"M\xc3\xbcsli", "utf-8") +str(b"M\xc3\xbcsli", "utf-8", "replace") + +str(b"M\x00\xfc\x00s\x00l\x00i\x00", encoding="utf-16") +str(b"M\x00\xfc\x00s\x00l\x00i\x00", encoding="utf-16", errors="ignore") + +str(bytearray.fromhex("4d c3 bc 73 6c 69"), "utf-8") +str(bytearray(), "utf-8") + +str(encoding="utf-8", object=b"M\xc3\xbcsli") +str(b"", errors="replace") +str(encoding="utf-8") +str(errors="replace") +``` + +### Invalid calls + +```py +str(1, 2) # error: [no-matching-overload] +str(o=1) # error: [no-matching-overload] + +# First argument is not a bytes-like object: +str("Müsli", "utf-8") # error: [no-matching-overload] + +# Second argument is not a valid encoding: +str(b"M\xc3\xbcsli", b"utf-8") # error: [no-matching-overload] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/callable_instance.md b/crates/ty_python_semantic/resources/mdtest/call/callable_instance.md new file mode 100644 index 0000000000000..d6e36e061f908 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/callable_instance.md @@ -0,0 +1,127 @@ +# Callable instance + +## Dunder call + +```py +class Multiplier: + def __init__(self, factor: int): + self.factor = factor + + def __call__(self, number: int) -> int: + return number * self.factor + +a = Multiplier(2)(3) +reveal_type(a) # revealed: int + +class Unit: ... + +b = Unit()(3.0) # error: "Object of type `Unit` is not callable" +reveal_type(b) # revealed: Unknown +``` + +## Possibly unbound `__call__` method + +```py +def _(flag: bool): + class PossiblyNotCallable: + if flag: + def __call__(self) -> int: + return 1 + + a = PossiblyNotCallable() + result = a() # error: "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" + reveal_type(result) # revealed: int +``` + +## Possibly unbound callable + +```py +def _(flag: bool): + if flag: + class PossiblyUnbound: + def __call__(self) -> int: + return 1 + + # error: [possibly-unresolved-reference] + a = PossiblyUnbound() + reveal_type(a()) # revealed: int +``` + +## Non-callable `__call__` + +```py +class NonCallable: + __call__ = 1 + +a = NonCallable() +# error: [call-non-callable] "Object of type `Literal[1]` is not callable" +reveal_type(a()) # revealed: Unknown +``` + +## Possibly non-callable `__call__` + +```py +def _(flag: bool): + class NonCallable: + if flag: + __call__ = 1 + else: + def __call__(self) -> int: + return 1 + + a = NonCallable() + # error: [call-non-callable] "Object of type `Literal[1]` is not callable" + reveal_type(a()) # revealed: Unknown | int +``` + +## Call binding errors + +### Wrong argument type + +```py +class C: + def __call__(self, x: int) -> int: + return 1 + +c = C() + +# error: 15 [invalid-argument-type] "Argument to bound method `__call__` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(c("foo")) # revealed: int +``` + +### Wrong argument type on `self` + +```py +class C: + # TODO this definition should also be an error; `C` must be assignable to type of `self` + def __call__(self: int) -> int: + return 1 + +c = C() + +# error: 13 [invalid-argument-type] "Argument to bound method `__call__` is incorrect: Expected `int`, found `C`" +reveal_type(c()) # revealed: int +``` + +## Union over callables + +### Possibly unbound `__call__` + +```py +def outer(cond1: bool): + class Test: + if cond1: + def __call__(self): ... + + class Other: + def __call__(self): ... + + def inner(cond2: bool): + if cond2: + a = Test() + else: + a = Other() + + # error: [call-non-callable] "Object of type `Test` is not callable (possibly unbound `__call__` method)" + a() +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/constructor.md b/crates/ty_python_semantic/resources/mdtest/call/constructor.md new file mode 100644 index 0000000000000..0e89cb5d32e57 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/constructor.md @@ -0,0 +1,432 @@ +# Constructor + +When classes are instantiated, Python calls the metaclass's `__call__` method. The metaclass of most +Python classes is the class `builtins.type`. + +`type.__call__` calls the `__new__` method of the class, which is responsible for creating the +instance. `__init__` is then called on the constructed instance with the same arguments that were +passed to `__new__`. + +Both `__new__` and `__init__` are looked up using the descriptor protocol, i.e., `__get__` is called +if these attributes are descriptors. `__new__` is always treated as a static method, i.e., `cls` is +passed as the first argument. `__init__` has no special handling; it is fetched as a bound method +and called just like any other dunder method. + +`type.__call__` does other things too, but this is not yet handled by us. + +Since every class has `object` in it's MRO, the default implementations are `object.__new__` and +`object.__init__`. They have some special behavior, namely: + +- If neither `__new__` nor `__init__` are defined anywhere in the MRO of class (except for + `object`), no arguments are accepted and `TypeError` is raised if any are passed. +- If `__new__` is defined but `__init__` is not, `object.__init__` will allow arbitrary arguments! + +As of today there are a number of behaviors that we do not support: + +- `__new__` is assumed to return an instance of the class on which it is called +- User defined `__call__` on metaclass is ignored + +## Creating an instance of the `object` class itself + +Test the behavior of the `object` class itself. As implementation has to ignore `object` own methods +as defined in typeshed due to behavior not expressible in typeshed (see above how `__init__` behaves +differently depending on whether `__new__` is defined or not), we have to test the behavior of +`object` itself. + +```py +reveal_type(object()) # revealed: object + +# error: [too-many-positional-arguments] "Too many positional arguments to class `object`: expected 0, got 1" +reveal_type(object(1)) # revealed: object +``` + +## No init or new + +```py +class Foo: ... + +reveal_type(Foo()) # revealed: Foo + +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 1, got 2" +reveal_type(Foo(1)) # revealed: Foo +``` + +## `__new__` present on the class itself + +```py +class Foo: + def __new__(cls, x: int) -> "Foo": + return object.__new__(cls) + +reveal_type(Foo(1)) # revealed: Foo + +# error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" +reveal_type(Foo()) # revealed: Foo +# error: [too-many-positional-arguments] "Too many positional arguments to function `__new__`: expected 2, got 3" +reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## `__new__` present on a superclass + +If the `__new__` method is defined on a superclass, we can still infer the signature of the +constructor from it. + +```py +from typing_extensions import Self + +class Base: + def __new__(cls, x: int) -> Self: + return cls() + +class Foo(Base): ... + +reveal_type(Foo(1)) # revealed: Foo + +# error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" +reveal_type(Foo()) # revealed: Foo +# error: [too-many-positional-arguments] "Too many positional arguments to function `__new__`: expected 2, got 3" +reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## Conditional `__new__` + +```py +def _(flag: bool) -> None: + class Foo: + if flag: + def __new__(cls, x: int): ... + else: + def __new__(cls, x: int, y: int = 1): ... + + reveal_type(Foo(1)) # revealed: Foo + # error: [invalid-argument-type] "Argument to function `__new__` is incorrect: Expected `int`, found `Literal["1"]`" + # error: [invalid-argument-type] "Argument to function `__new__` is incorrect: Expected `int`, found `Literal["1"]`" + reveal_type(Foo("1")) # revealed: Foo + # error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" + # error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" + reveal_type(Foo()) # revealed: Foo + # error: [too-many-positional-arguments] "Too many positional arguments to function `__new__`: expected 2, got 3" + reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## A descriptor in place of `__new__` + +```py +class SomeCallable: + def __call__(self, cls, x: int) -> "Foo": + obj = object.__new__(cls) + obj.x = x + return obj + +class Descriptor: + def __get__(self, instance, owner) -> SomeCallable: + return SomeCallable() + +class Foo: + __new__: Descriptor = Descriptor() + +reveal_type(Foo(1)) # revealed: Foo +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" +reveal_type(Foo()) # revealed: Foo +``` + +## A callable instance in place of `__new__` + +### Bound + +```py +class Callable: + def __call__(self, cls, x: int) -> "Foo": + return object.__new__(cls) + +class Foo: + __new__ = Callable() + +reveal_type(Foo(1)) # revealed: Foo +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" +reveal_type(Foo()) # revealed: Foo +``` + +### Possibly Unbound + +#### Possibly unbound `__new__` method + +```py +def _(flag: bool) -> None: + class Foo: + if flag: + def __new__(cls): + return object.__new__(cls) + + # error: [call-possibly-unbound-method] + reveal_type(Foo()) # revealed: Foo + + # error: [call-possibly-unbound-method] + # error: [too-many-positional-arguments] + reveal_type(Foo(1)) # revealed: Foo +``` + +#### Possibly unbound `__call__` on `__new__` callable + +```py +def _(flag: bool) -> None: + class Callable: + if flag: + def __call__(self, cls, x: int) -> "Foo": + return object.__new__(cls) + + class Foo: + __new__ = Callable() + + # error: [call-non-callable] "Object of type `Callable` is not callable (possibly unbound `__call__` method)" + reveal_type(Foo(1)) # revealed: Foo + # TODO should be - error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" + # but we currently infer the signature of `__call__` as unknown, so it accepts any arguments + # error: [call-non-callable] "Object of type `Callable` is not callable (possibly unbound `__call__` method)" + reveal_type(Foo()) # revealed: Foo +``` + +## `__init__` present on the class itself + +If the class has an `__init__` method, we can infer the signature of the constructor from it. + +```py +class Foo: + def __init__(self, x: int): ... + +reveal_type(Foo(1)) # revealed: Foo + +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo()) # revealed: Foo +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 2, got 3" +reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## `__init__` present on a superclass + +If the `__init__` method is defined on a superclass, we can still infer the signature of the +constructor from it. + +```py +class Base: + def __init__(self, x: int): ... + +class Foo(Base): ... + +reveal_type(Foo(1)) # revealed: Foo + +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo()) # revealed: Foo +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 2, got 3" +reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## Conditional `__init__` + +```py +def _(flag: bool) -> None: + class Foo: + if flag: + def __init__(self, x: int): ... + else: + def __init__(self, x: int, y: int = 1): ... + + reveal_type(Foo(1)) # revealed: Foo + # error: [invalid-argument-type] "Argument to bound method `__init__` is incorrect: Expected `int`, found `Literal["1"]`" + # error: [invalid-argument-type] "Argument to bound method `__init__` is incorrect: Expected `int`, found `Literal["1"]`" + reveal_type(Foo("1")) # revealed: Foo + # error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" + # error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" + reveal_type(Foo()) # revealed: Foo + # error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 2, got 3" + reveal_type(Foo(1, 2)) # revealed: Foo +``` + +## A descriptor in place of `__init__` + +```py +class SomeCallable: + # TODO: at runtime `__init__` is checked to return `None` and + # a `TypeError` is raised if it doesn't. However, apparently + # this is not true when the descriptor is used as `__init__`. + # However, we may still want to check this. + def __call__(self, x: int) -> str: + return "a" + +class Descriptor: + def __get__(self, instance, owner) -> SomeCallable: + return SomeCallable() + +class Foo: + __init__: Descriptor = Descriptor() + +reveal_type(Foo(1)) # revealed: Foo +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" +reveal_type(Foo()) # revealed: Foo +``` + +## A callable instance in place of `__init__` + +### Bound + +```py +class Callable: + def __call__(self, x: int) -> None: + pass + +class Foo: + __init__ = Callable() + +reveal_type(Foo(1)) # revealed: Foo +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" +reveal_type(Foo()) # revealed: Foo +``` + +### Possibly Unbound + +```py +def _(flag: bool) -> None: + class Callable: + if flag: + def __call__(self, x: int) -> None: + pass + + class Foo: + __init__ = Callable() + + # error: [call-non-callable] "Object of type `Callable` is not callable (possibly unbound `__call__` method)" + reveal_type(Foo(1)) # revealed: Foo + # TODO should be - error: [missing-argument] "No argument provided for required parameter `x` of bound method `__call__`" + # but we currently infer the signature of `__call__` as unknown, so it accepts any arguments + # error: [call-non-callable] "Object of type `Callable` is not callable (possibly unbound `__call__` method)" + reveal_type(Foo()) # revealed: Foo +``` + +## `__new__` and `__init__` both present + +### Identical signatures + +A common case is to have `__new__` and `__init__` with identical signatures (except for the first +argument). We report errors for both `__new__` and `__init__` if the arguments are incorrect. + +At runtime `__new__` is called first and will fail without executing `__init__` if the arguments are +incorrect. However, we decided that it is better to report errors for both methods, since after +fixing the `__new__` method, the user may forget to fix the `__init__` method. + +```py +class Foo: + def __new__(cls, x: int) -> "Foo": + return object.__new__(cls) + + def __init__(self, x: int): ... + +# error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo()) # revealed: Foo + +reveal_type(Foo(1)) # revealed: Foo +``` + +### Compatible signatures + +But they can also be compatible, but not identical. We should correctly report errors only for the +mthod that would fail. + +```py +class Foo: + def __new__(cls, *args, **kwargs): + return object.__new__(cls) + + def __init__(self, x: int) -> None: + self.x = x + +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo()) # revealed: Foo +reveal_type(Foo(1)) # revealed: Foo + +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 2, got 3" +reveal_type(Foo(1, 2)) # revealed: Foo +``` + +### Incompatible signatures + +```py +import abc + +class Foo: + def __new__(cls) -> "Foo": + return object.__new__(cls) + + def __init__(self, x): + self.x = 42 + +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo()) # revealed: Foo + +# error: [too-many-positional-arguments] "Too many positional arguments to function `__new__`: expected 1, got 2" +reveal_type(Foo(42)) # revealed: Foo + +class Foo2: + def __new__(cls, x) -> "Foo2": + return object.__new__(cls) + + def __init__(self): + pass + +# error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" +reveal_type(Foo2()) # revealed: Foo2 + +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 1, got 2" +reveal_type(Foo2(42)) # revealed: Foo2 + +class Foo3(metaclass=abc.ABCMeta): + def __new__(cls) -> "Foo3": + return object.__new__(cls) + + def __init__(self, x): + self.x = 42 + +# error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" +reveal_type(Foo3()) # revealed: Foo3 + +# error: [too-many-positional-arguments] "Too many positional arguments to function `__new__`: expected 1, got 2" +reveal_type(Foo3(42)) # revealed: Foo3 + +class Foo4(metaclass=abc.ABCMeta): + def __new__(cls, x) -> "Foo4": + return object.__new__(cls) + + def __init__(self): + pass + +# error: [missing-argument] "No argument provided for required parameter `x` of function `__new__`" +reveal_type(Foo4()) # revealed: Foo4 + +# error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 1, got 2" +reveal_type(Foo4(42)) # revealed: Foo4 +``` + +### Lookup of `__new__` + +The `__new__` method is always invoked on the class itself, never on the metaclass. This is +different from how other dunder methods like `__lt__` are implicitly called (always on the +meta-type, never on the type itself). + +```py +from typing_extensions import Literal + +class Meta(type): + def __new__(mcls, name, bases, namespace, /, **kwargs): + return super().__new__(mcls, name, bases, namespace) + + def __lt__(cls, other) -> Literal[True]: + return True + +class C(metaclass=Meta): ... + +# No error is raised here, since we don't implicitly call `Meta.__new__` +reveal_type(C()) # revealed: C + +# Meta.__lt__ is implicitly called here: +reveal_type(C < C) # revealed: Literal[True] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/dunder.md b/crates/ty_python_semantic/resources/mdtest/call/dunder.md new file mode 100644 index 0000000000000..1f31f8bbdda64 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/dunder.md @@ -0,0 +1,241 @@ +# Dunder calls + +## Introduction + +This test suite explains and documents how dunder methods are looked up and called. Throughout the +document, we use `__getitem__` as an example, but the same principles apply to other dunder methods. + +Dunder methods are implicitly called when using certain syntax. For example, the index operator +`obj[key]` calls the `__getitem__` method under the hood. Exactly *how* a dunder method is looked up +and called works slightly different from regular methods. Dunder methods are not looked up on `obj` +directly, but rather on `type(obj)`. But in many ways, they still *act* as if they were called on +`obj` directly. If the `__getitem__` member of `type(obj)` is a descriptor, it is called with `obj` +as the `instance` argument to `__get__`. A desugared version of `obj[key]` is roughly equivalent to +`getitem_desugared(obj, key)` as defined below: + +```py +from typing import Any + +def find_name_in_mro(typ: type, name: str) -> Any: + # See implementation in https://docs.python.org/3/howto/descriptor.html#invocation-from-an-instance + pass + +def getitem_desugared(obj: object, key: object) -> object: + getitem_callable = find_name_in_mro(type(obj), "__getitem__") + if hasattr(getitem_callable, "__get__"): + getitem_callable = getitem_callable.__get__(obj, type(obj)) + + return getitem_callable(key) +``` + +In the following tests, we demonstrate that we implement this behavior correctly. + +## Operating on class objects + +If we invoke a dunder method on a class, it is looked up on the *meta* class, since any class is an +instance of its metaclass: + +```py +class Meta(type): + def __getitem__(cls, key: int) -> str: + return str(key) + +class DunderOnMetaclass(metaclass=Meta): + pass + +reveal_type(DunderOnMetaclass[0]) # revealed: str +``` + +If the dunder method is only present on the class itself, it will not be called: + +```py +class ClassWithNormalDunder: + def __getitem__(self, key: int) -> str: + return str(key) + +# error: [non-subscriptable] +ClassWithNormalDunder[0] +``` + +## Operating on instances + +When invoking a dunder method on an instance of a class, it is looked up on the class: + +```py +class ClassWithNormalDunder: + def __getitem__(self, key: int) -> str: + return str(key) + +class_with_normal_dunder = ClassWithNormalDunder() + +reveal_type(class_with_normal_dunder[0]) # revealed: str +``` + +Which can be demonstrated by trying to attach a dunder method to an instance, which will not work: + +```py +def external_getitem(instance, key: int) -> str: + return str(key) + +class ThisFails: + def __init__(self): + self.__getitem__ = external_getitem + +this_fails = ThisFails() + +# error: [non-subscriptable] "Cannot subscript object of type `ThisFails` with no `__getitem__` method" +reveal_type(this_fails[0]) # revealed: Unknown +``` + +However, the attached dunder method *can* be called if accessed directly: + +```py +reveal_type(this_fails.__getitem__(this_fails, 0)) # revealed: Unknown | str +``` + +The instance-level method is also not called when the class-level method is present: + +```py +def external_getitem1(instance, key) -> str: + return "a" + +def external_getitem2(key) -> int: + return 1 + +def _(flag: bool): + class ThisFails: + if flag: + __getitem__ = external_getitem1 + + def __init__(self): + self.__getitem__ = external_getitem2 + + this_fails = ThisFails() + + # error: [call-possibly-unbound-method] + reveal_type(this_fails[0]) # revealed: Unknown | str +``` + +## When the dunder is not a method + +A dunder can also be a non-method callable: + +```py +class SomeCallable: + def __call__(self, key: int) -> str: + return str(key) + +class ClassWithNonMethodDunder: + __getitem__: SomeCallable = SomeCallable() + +class_with_callable_dunder = ClassWithNonMethodDunder() + +reveal_type(class_with_callable_dunder[0]) # revealed: str +``` + +## Dunders are looked up using the descriptor protocol + +Here, we demonstrate that the descriptor protocol is invoked when looking up a dunder method. Note +that the `instance` argument is on object of type `ClassWithDescriptorDunder`: + +```py +from __future__ import annotations + +class SomeCallable: + def __call__(self, key: int) -> str: + return str(key) + +class Descriptor: + def __get__(self, instance: ClassWithDescriptorDunder, owner: type[ClassWithDescriptorDunder]) -> SomeCallable: + return SomeCallable() + +class ClassWithDescriptorDunder: + __getitem__: Descriptor = Descriptor() + +class_with_descriptor_dunder = ClassWithDescriptorDunder() + +reveal_type(class_with_descriptor_dunder[0]) # revealed: str +``` + +## Dunders can not be overwritten on instances + +If we attempt to overwrite a dunder method on an instance, it does not affect the behavior of +implicit dunder calls: + +```py +class C: + def __getitem__(self, key: int) -> str: + return str(key) + + def f(self): + # TODO: This should emit an `invalid-assignment` diagnostic once we understand the type of `self` + self.__getitem__ = None + +# This is still fine, and simply calls the `__getitem__` method on the class +reveal_type(C()[0]) # revealed: str +``` + +## Calling a union of dunder methods + +```py +def _(flag: bool): + class C: + if flag: + def __getitem__(self, key: int) -> str: + return str(key) + else: + def __getitem__(self, key: int) -> bytes: + return bytes() + + c = C() + reveal_type(c[0]) # revealed: str | bytes + + if flag: + class D: + def __getitem__(self, key: int) -> str: + return str(key) + + else: + class D: + def __getitem__(self, key: int) -> bytes: + return bytes() + + d = D() + reveal_type(d[0]) # revealed: str | bytes +``` + +## Calling a union of types without dunder methods + +We add instance attributes here to make sure that we don't treat the implicit dunder calls here like +regular method calls. + +```py +def external_getitem(instance, key: int) -> str: + return str(key) + +class NotSubscriptable1: + def __init__(self, value: int): + self.__getitem__ = external_getitem + +class NotSubscriptable2: + def __init__(self, value: int): + self.__getitem__ = external_getitem + +def _(union: NotSubscriptable1 | NotSubscriptable2): + # error: [non-subscriptable] + union[0] +``` + +## Calling a possibly-unbound dunder method + +```py +def _(flag: bool): + class C: + if flag: + def __getitem__(self, key: int) -> str: + return str(key) + + c = C() + # error: [call-possibly-unbound-method] + reveal_type(c[0]) # revealed: str +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/function.md b/crates/ty_python_semantic/resources/mdtest/call/function.md new file mode 100644 index 0000000000000..e6e4771050140 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/function.md @@ -0,0 +1,335 @@ +# Call expression + +## Simple + +```py +def get_int() -> int: + return 42 + +reveal_type(get_int()) # revealed: int +``` + +## Async + +```py +async def get_int_async() -> int: + return 42 + +# TODO: we don't yet support `types.CoroutineType`, should be generic `Coroutine[Any, Any, int]` +reveal_type(get_int_async()) # revealed: @Todo(generic types.CoroutineType) +``` + +## Generic + +```toml +[environment] +python-version = "3.12" +``` + +```py +def get_int[T]() -> int: + return 42 + +reveal_type(get_int()) # revealed: int +``` + +## Decorated + +```py +from typing import Callable + +def foo() -> int: + return 42 + +def decorator(func) -> Callable[[], int]: + return foo + +@decorator +def bar() -> str: + return "bar" + +reveal_type(bar()) # revealed: int +``` + +## Invalid callable + +```py +nonsense = 123 +x = nonsense() # error: "Object of type `Literal[123]` is not callable" +``` + +## Potentially unbound function + +```py +def _(flag: bool): + if flag: + def foo() -> int: + return 42 + # error: [possibly-unresolved-reference] + reveal_type(foo()) # revealed: int +``` + +## Wrong argument type + +### Positional argument, positional-or-keyword parameter + +```py +def f(x: int) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f("foo")) # revealed: int +``` + +### Positional argument, positional-only parameter + +```py +def f(x: int, /) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f("foo")) # revealed: int +``` + +### Positional argument, variadic parameter + +```py +def f(*args: int) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f("foo")) # revealed: int +``` + +### Keyword argument, positional-or-keyword parameter + +```py +def f(x: int) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f(x="foo")) # revealed: int +``` + +### Keyword argument, keyword-only parameter + +```py +def f(*, x: int) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f(x="foo")) # revealed: int +``` + +### Keyword argument, keywords parameter + +```py +def f(**kwargs: int) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +reveal_type(f(x="foo")) # revealed: int +``` + +### Correctly match keyword out-of-order + +```py +def f(x: int = 1, y: str = "foo") -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `str`, found `Literal[2]`" +# error: 20 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["bar"]`" +reveal_type(f(y=2, x="bar")) # revealed: int +``` + +## Too many positional arguments + +### One too many + +```py +def f() -> int: + return 1 + +# error: 15 [too-many-positional-arguments] "Too many positional arguments to function `f`: expected 0, got 1" +reveal_type(f("foo")) # revealed: int +``` + +### Two too many + +```py +def f() -> int: + return 1 + +# error: 15 [too-many-positional-arguments] "Too many positional arguments to function `f`: expected 0, got 2" +reveal_type(f("foo", "bar")) # revealed: int +``` + +### No too-many-positional if variadic is taken + +```py +def f(*args: int) -> int: + return 1 + +reveal_type(f(1, 2, 3)) # revealed: int +``` + +### Multiple keyword arguments map to keyword variadic parameter + +```py +def f(**kwargs: int) -> int: + return 1 + +reveal_type(f(foo=1, bar=2)) # revealed: int +``` + +## Missing arguments + +### No defaults or variadic + +```py +def f(x: int) -> int: + return 1 + +# error: 13 [missing-argument] "No argument provided for required parameter `x` of function `f`" +reveal_type(f()) # revealed: int +``` + +### With default + +```py +def f(x: int, y: str = "foo") -> int: + return 1 + +# error: 13 [missing-argument] "No argument provided for required parameter `x` of function `f`" +reveal_type(f()) # revealed: int +``` + +### Defaulted argument is not required + +```py +def f(x: int = 1) -> int: + return 1 + +reveal_type(f()) # revealed: int +``` + +### With variadic + +```py +def f(x: int, *y: str) -> int: + return 1 + +# error: 13 [missing-argument] "No argument provided for required parameter `x` of function `f`" +reveal_type(f()) # revealed: int +``` + +### Variadic argument is not required + +```py +def f(*args: int) -> int: + return 1 + +reveal_type(f()) # revealed: int +``` + +### Keywords argument is not required + +```py +def f(**kwargs: int) -> int: + return 1 + +reveal_type(f()) # revealed: int +``` + +### Multiple + +```py +def f(x: int, y: int) -> int: + return 1 + +# error: 13 [missing-argument] "No arguments provided for required parameters `x`, `y` of function `f`" +reveal_type(f()) # revealed: int +``` + +## Unknown argument + +```py +def f(x: int) -> int: + return 1 + +# error: 20 [unknown-argument] "Argument `y` does not match any known parameter of function `f`" +reveal_type(f(x=1, y=2)) # revealed: int +``` + +## Parameter already assigned + +```py +def f(x: int) -> int: + return 1 + +# error: 18 [parameter-already-assigned] "Multiple values provided for parameter `x` of function `f`" +reveal_type(f(1, x=2)) # revealed: int +``` + +## Special functions + +Some functions require special handling in type inference. Here, we make sure that we still emit +proper diagnostics in case of missing or superfluous arguments. + +### `reveal_type` + +```py +from typing_extensions import reveal_type + +# error: [missing-argument] "No argument provided for required parameter `obj` of function `reveal_type`" +reveal_type() + +# error: [too-many-positional-arguments] "Too many positional arguments to function `reveal_type`: expected 1, got 2" +reveal_type(1, 2) +``` + +### `static_assert` + +```py +from ty_extensions import static_assert + +# error: [missing-argument] "No argument provided for required parameter `condition` of function `static_assert`" +static_assert() + +# error: [too-many-positional-arguments] "Too many positional arguments to function `static_assert`: expected 2, got 3" +static_assert(True, 2, 3) +``` + +### `len` + +```py +# error: [missing-argument] "No argument provided for required parameter `obj` of function `len`" +len() + +# error: [too-many-positional-arguments] "Too many positional arguments to function `len`: expected 1, got 2" +len([], 1) +``` + +### Type API predicates + +```py +from ty_extensions import is_subtype_of, is_fully_static + +# error: [missing-argument] +is_subtype_of() + +# error: [missing-argument] +is_subtype_of(int) + +# error: [too-many-positional-arguments] +is_subtype_of(int, int, int) + +# error: [too-many-positional-arguments] +is_subtype_of(int, int, int, int) + +# error: [missing-argument] +is_fully_static() + +# error: [too-many-positional-arguments] +is_fully_static(int, int) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/getattr_static.md b/crates/ty_python_semantic/resources/mdtest/call/getattr_static.md new file mode 100644 index 0000000000000..fc54aefd00c75 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/getattr_static.md @@ -0,0 +1,152 @@ +# `inspect.getattr_static` + +## Basic usage + +`inspect.getattr_static` is a function that returns attributes of an object without invoking the +descriptor protocol (for caveats, see the [official documentation]). + +Consider the following example: + +```py +import inspect + +class Descriptor: + def __get__(self, instance, owner) -> str: + return "a" + +class C: + normal: int = 1 + descriptor: Descriptor = Descriptor() +``` + +If we access attributes on an instance of `C` as usual, the descriptor protocol is invoked, and we +get a type of `str` for the `descriptor` attribute: + +```py +c = C() + +reveal_type(c.normal) # revealed: int +reveal_type(c.descriptor) # revealed: str +``` + +However, if we use `inspect.getattr_static`, we can see the underlying `Descriptor` type: + +```py +reveal_type(inspect.getattr_static(c, "normal")) # revealed: int +reveal_type(inspect.getattr_static(c, "descriptor")) # revealed: Descriptor +``` + +For non-existent attributes, a default value can be provided: + +```py +reveal_type(inspect.getattr_static(C, "normal", "default-arg")) # revealed: int +reveal_type(inspect.getattr_static(C, "non_existent", "default-arg")) # revealed: Literal["default-arg"] +``` + +When a non-existent attribute is accessed without a default value, the runtime raises an +`AttributeError`. We could emit a diagnostic for this case, but that is currently not supported: + +```py +# TODO: we could emit a diagnostic here +reveal_type(inspect.getattr_static(C, "non_existent")) # revealed: Never +``` + +We can access attributes on objects of all kinds: + +```py +import sys + +reveal_type(inspect.getattr_static(sys, "dont_write_bytecode")) # revealed: bool +# revealed: def getattr_static(obj: object, attr: str, default: Any | None = ellipsis) -> Any +reveal_type(inspect.getattr_static(inspect, "getattr_static")) + +reveal_type(inspect.getattr_static(1, "real")) # revealed: property +``` + +(Implicit) instance attributes can also be accessed through `inspect.getattr_static`: + +```py +class D: + def __init__(self) -> None: + self.instance_attr: int = 1 + +reveal_type(inspect.getattr_static(D(), "instance_attr")) # revealed: int +``` + +And attributes on metaclasses can be accessed when probing the class: + +```py +class Meta(type): + attr: int = 1 + +class E(metaclass=Meta): ... + +reveal_type(inspect.getattr_static(E, "attr")) # revealed: int +``` + +Metaclass attributes can not be added when probing an instance of the class: + +```py +reveal_type(inspect.getattr_static(E(), "attr", "non_existent")) # revealed: Literal["non_existent"] +``` + +## Error cases + +We can only infer precise types if the attribute is a literal string. In all other cases, we fall +back to `Any`: + +```py +import inspect + +class C: + x: int = 1 + +def _(attr_name: str): + reveal_type(inspect.getattr_static(C(), attr_name)) # revealed: Any + reveal_type(inspect.getattr_static(C(), attr_name, 1)) # revealed: Any +``` + +But we still detect errors in the number or type of arguments: + +```py +# error: [missing-argument] "No arguments provided for required parameters `obj`, `attr` of function `getattr_static`" +inspect.getattr_static() + +# error: [missing-argument] "No argument provided for required parameter `attr`" +inspect.getattr_static(C()) + +# error: [invalid-argument-type] "Argument to function `getattr_static` is incorrect: Expected `str`, found `Literal[1]`" +inspect.getattr_static(C(), 1) + +# error: [too-many-positional-arguments] "Too many positional arguments to function `getattr_static`: expected 3, got 4" +inspect.getattr_static(C(), "x", "default-arg", "one too many") +``` + +## Possibly unbound attributes + +```py +import inspect + +def _(flag: bool): + class C: + if flag: + x: int = 1 + + reveal_type(inspect.getattr_static(C, "x", "default")) # revealed: int | Literal["default"] +``` + +## Gradual types + +```py +import inspect +from typing import Any + +def _(a: Any, tuple_of_any: tuple[Any]): + reveal_type(inspect.getattr_static(a, "x", "default")) # revealed: Any | Literal["default"] + + # TODO: Ideally, this would just be `def index(self, value: Any, start: SupportsIndex = Literal[0], stop: SupportsIndex = int, /) -> int` + # revealed: (def index(self, value: Any, start: SupportsIndex = Literal[0], stop: SupportsIndex = int, /) -> int) | Literal["default"] + reveal_type(inspect.getattr_static(tuple_of_any, "index", "default")) +``` + +[official documentation]: https://docs.python.org/3/library/inspect.html#inspect.getattr_static diff --git a/crates/ty_python_semantic/resources/mdtest/call/invalid_syntax.md b/crates/ty_python_semantic/resources/mdtest/call/invalid_syntax.md new file mode 100644 index 0000000000000..3d88ff2ebf1a1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/invalid_syntax.md @@ -0,0 +1,44 @@ +# Invalid signatures + +## Multiple arguments with the same name + +We always map a keyword argument to the first parameter of that name. + +```py +# error: [invalid-syntax] "Duplicate parameter "x"" +def f(x: int, x: str) -> int: + return 1 + +# error: 13 [missing-argument] "No argument provided for required parameter `x` of function `f`" +# error: 18 [parameter-already-assigned] "Multiple values provided for parameter `x` of function `f`" +reveal_type(f(1, x=2)) # revealed: int +``` + +## Positional after non-positional + +When parameter kinds are given in an invalid order, we emit a diagnostic and implicitly reorder them +to the valid order: + +```py +# error: [invalid-syntax] "Parameter cannot follow var-keyword parameter" +def f(**kw: int, x: str) -> int: + return 1 + +# error: 15 [invalid-argument-type] "Argument to function `f` is incorrect: Expected `str`, found `Literal[1]`" +reveal_type(f(1)) # revealed: int +``` + +## Non-defaulted after defaulted + +We emit a syntax diagnostic for this, but it doesn't cause any problems for binding. + +```py +# error: [invalid-syntax] "Parameter without a default cannot follow a parameter with a default" +def f(x: int = 1, y: str) -> int: + return 1 + +reveal_type(f(y="foo")) # revealed: int +# error: [invalid-argument-type] "Argument to function `f` is incorrect: Expected `int`, found `Literal["foo"]`" +# error: [missing-argument] "No argument provided for required parameter `y` of function `f`" +reveal_type(f("foo")) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/methods.md b/crates/ty_python_semantic/resources/mdtest/call/methods.md new file mode 100644 index 0000000000000..e6fde2e2617e0 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/methods.md @@ -0,0 +1,433 @@ +# Methods + +## Background: Functions as descriptors + +> Note: See also this related section in the descriptor guide: [Functions and methods]. + +Say we have a simple class `C` with a function definition `f` inside its body: + +```py +class C: + def f(self, x: int) -> str: + return "a" +``` + +Whenever we access the `f` attribute through the class object itself (`C.f`) or through an instance +(`C().f`), this access happens via the descriptor protocol. Functions are (non-data) descriptors +because they implement a `__get__` method. This is crucial in making sure that method calls work as +expected. In general, the signature of the `__get__` method in the descriptor protocol is +`__get__(self, instance, owner)`. The `self` argument is the descriptor object itself (`f`). The +passed value for the `instance` argument depends on whether the attribute is accessed from the class +object (in which case it is `None`), or from an instance (in which case it is the instance of type +`C`). The `owner` argument is the class itself (`C` of type `Literal[C]`). To summarize: + +- `C.f` is equivalent to `getattr_static(C, "f").__get__(None, C)` +- `C().f` is equivalent to `getattr_static(C, "f").__get__(C(), C)` + +Here, `inspect.getattr_static` is used to bypass the descriptor protocol and directly access the +function attribute. The way the special `__get__` method *on functions* works is as follows. In the +former case, if the `instance` argument is `None`, `__get__` simply returns the function itself. In +the latter case, it returns a *bound method* object: + +```py +from inspect import getattr_static + +reveal_type(getattr_static(C, "f")) # revealed: def f(self, x: int) -> str + +reveal_type(getattr_static(C, "f").__get__) # revealed: <method-wrapper `__get__` of `f`> + +reveal_type(getattr_static(C, "f").__get__(None, C)) # revealed: def f(self, x: int) -> str +reveal_type(getattr_static(C, "f").__get__(C(), C)) # revealed: bound method C.f(x: int) -> str +``` + +In conclusion, this is why we see the following two types when accessing the `f` attribute on the +class object `C` and on an instance `C()`: + +```py +reveal_type(C.f) # revealed: def f(self, x: int) -> str +reveal_type(C().f) # revealed: bound method C.f(x: int) -> str +``` + +A bound method is a callable object that contains a reference to the `instance` that it was called +on (can be inspected via `__self__`), and the function object that it refers to (can be inspected +via `__func__`): + +```py +bound_method = C().f + +reveal_type(bound_method.__self__) # revealed: C +reveal_type(bound_method.__func__) # revealed: def f(self, x: int) -> str +``` + +When we call the bound method, the `instance` is implicitly passed as the first argument (`self`): + +```py +reveal_type(C().f(1)) # revealed: str +reveal_type(bound_method(1)) # revealed: str +``` + +When we call the function object itself, we need to pass the `instance` explicitly: + +```py +C.f(1) # error: [missing-argument] + +reveal_type(C.f(C(), 1)) # revealed: str +``` + +When we access methods from derived classes, they will be bound to instances of the derived class: + +```py +class D(C): + pass + +reveal_type(D().f) # revealed: bound method D.f(x: int) -> str +``` + +If we access an attribute on a bound method object itself, it will defer to `types.MethodType`: + +```py +reveal_type(bound_method.__hash__) # revealed: bound method MethodType.__hash__() -> int +``` + +If an attribute is not available on the bound method object, it will be looked up on the underlying +function object. We model this explicitly, which means that we can access `__kwdefaults__` on bound +methods, even though it is not available on `types.MethodType`: + +```py +reveal_type(bound_method.__kwdefaults__) # revealed: dict[str, Any] | None +``` + +## Basic method calls on class objects and instances + +```py +class Base: + def method_on_base(self, x: int | None) -> str: + return "a" + +class Derived(Base): + def method_on_derived(self, x: bytes) -> tuple[int, str]: + return (1, "a") + +reveal_type(Base().method_on_base(1)) # revealed: str +reveal_type(Base.method_on_base(Base(), 1)) # revealed: str + +Base().method_on_base("incorrect") # error: [invalid-argument-type] +Base().method_on_base() # error: [missing-argument] +Base().method_on_base(1, 2) # error: [too-many-positional-arguments] + +reveal_type(Derived().method_on_base(1)) # revealed: str +reveal_type(Derived().method_on_derived(b"abc")) # revealed: tuple[int, str] +reveal_type(Derived.method_on_base(Derived(), 1)) # revealed: str +reveal_type(Derived.method_on_derived(Derived(), b"abc")) # revealed: tuple[int, str] +``` + +## Method calls on literals + +### Boolean literals + +```py +reveal_type(True.bit_length()) # revealed: int +reveal_type(True.as_integer_ratio()) # revealed: tuple[int, Literal[1]] +``` + +### Integer literals + +```py +reveal_type((42).bit_length()) # revealed: int +``` + +### String literals + +```py +reveal_type("abcde".find("abc")) # revealed: int +reveal_type("foo".encode(encoding="utf-8")) # revealed: bytes + +"abcde".find(123) # error: [invalid-argument-type] +``` + +### Bytes literals + +```py +reveal_type(b"abcde".startswith(b"abc")) # revealed: bool +``` + +## Method calls on `LiteralString` + +```py +from typing_extensions import LiteralString + +def f(s: LiteralString) -> None: + reveal_type(s.find("a")) # revealed: int +``` + +## Method calls on `tuple` + +```py +def f(t: tuple[int, str]) -> None: + reveal_type(t.index("a")) # revealed: int +``` + +## Method calls on unions + +```py +from typing import Any + +class A: + def f(self) -> int: + return 1 + +class B: + def f(self) -> str: + return "a" + +def f(a_or_b: A | B, any_or_a: Any | A): + reveal_type(a_or_b.f) # revealed: (bound method A.f() -> int) | (bound method B.f() -> str) + reveal_type(a_or_b.f()) # revealed: int | str + + reveal_type(any_or_a.f) # revealed: Any | (bound method A.f() -> int) + reveal_type(any_or_a.f()) # revealed: Any | int +``` + +## Method calls on `KnownInstance` types + +```toml +[environment] +python-version = "3.12" +``` + +```py +type IntOrStr = int | str + +reveal_type(IntOrStr.__or__) # revealed: bound method typing.TypeAliasType.__or__(right: Any) -> _SpecialForm +``` + +## Error cases: Calling `__get__` for methods + +The `__get__` method on `types.FunctionType` has the following overloaded signature in typeshed: + +```pyi +from types import FunctionType, MethodType +from typing import overload + +@overload +def __get__(self, instance: None, owner: type, /) -> FunctionType: ... +@overload +def __get__(self, instance: object, owner: type | None = None, /) -> MethodType: ... +``` + +Here, we test that this signature is enforced correctly: + +```py +from inspect import getattr_static + +class C: + def f(self, x: int) -> str: + return "a" + +method_wrapper = getattr_static(C, "f").__get__ + +reveal_type(method_wrapper) # revealed: <method-wrapper `__get__` of `f`> + +# All of these are fine: +method_wrapper(C(), C) +method_wrapper(C()) +method_wrapper(C(), None) +method_wrapper(None, C) + +# Passing `None` without an `owner` argument is an +# error: [no-matching-overload] "No overload of method wrapper `__get__` of function `f` matches arguments" +method_wrapper(None) + +# Passing something that is not assignable to `type` as the `owner` argument is an +# error: [no-matching-overload] "No overload of method wrapper `__get__` of function `f` matches arguments" +method_wrapper(None, 1) + +# Passing `None` as the `owner` argument when `instance` is `None` is an +# error: [no-matching-overload] "No overload of method wrapper `__get__` of function `f` matches arguments" +method_wrapper(None, None) + +# Calling `__get__` without any arguments is an +# error: [no-matching-overload] "No overload of method wrapper `__get__` of function `f` matches arguments" +method_wrapper() + +# Calling `__get__` with too many positional arguments is an +# error: [no-matching-overload] "No overload of method wrapper `__get__` of function `f` matches arguments" +method_wrapper(C(), C, "one too many") +``` + +## Fallback to metaclass + +When a method is accessed on a class object, it is looked up on the metaclass if it is not found on +the class itself. This also creates a bound method that is bound to the class object itself: + +```py +from __future__ import annotations + +class Meta(type): + def f(cls, arg: int) -> str: + return "a" + +class C(metaclass=Meta): + pass + +reveal_type(C.f) # revealed: bound method <class 'C'>.f(arg: int) -> str +reveal_type(C.f(1)) # revealed: str +``` + +The method `f` can not be accessed from an instance of the class: + +```py +# error: [unresolved-attribute] "Type `C` has no attribute `f`" +C().f +``` + +A metaclass function can be shadowed by a method on the class: + +```py +from typing import Any, Literal + +class D(metaclass=Meta): + def f(arg: int) -> Literal["a"]: + return "a" + +reveal_type(D.f(1)) # revealed: Literal["a"] +``` + +If the class method is possibly unbound, we union the return types: + +```py +def flag() -> bool: + return True + +class E(metaclass=Meta): + if flag(): + def f(arg: int) -> Any: + return "a" + +reveal_type(E.f(1)) # revealed: str | Any +``` + +## `@classmethod` + +### Basic + +When a `@classmethod` attribute is accessed, it returns a bound method object, even when accessed on +the class object itself: + +```py +from __future__ import annotations + +class C: + @classmethod + def f(cls: type[C], x: int) -> str: + return "a" + +reveal_type(C.f) # revealed: bound method <class 'C'>.f(x: int) -> str +reveal_type(C().f) # revealed: bound method type[C].f(x: int) -> str +``` + +The `cls` method argument is then implicitly passed as the first argument when calling the method: + +```py +reveal_type(C.f(1)) # revealed: str +reveal_type(C().f(1)) # revealed: str +``` + +When the class method is called incorrectly, we detect it: + +```py +C.f("incorrect") # error: [invalid-argument-type] +C.f() # error: [missing-argument] +C.f(1, 2) # error: [too-many-positional-arguments] +``` + +If the `cls` parameter is wrongly annotated, we emit an error at the call site: + +```py +class D: + @classmethod + def f(cls: D): + # This function is wrongly annotated, it should be `type[D]` instead of `D` + pass + +# error: [invalid-argument-type] "Argument to bound method `f` is incorrect: Expected `D`, found `<class 'D'>`" +D.f() +``` + +When a class method is accessed on a derived class, it is bound to that derived class: + +```py +class Derived(C): + pass + +reveal_type(Derived.f) # revealed: bound method <class 'Derived'>.f(x: int) -> str +reveal_type(Derived().f) # revealed: bound method type[Derived].f(x: int) -> str + +reveal_type(Derived.f(1)) # revealed: str +reveal_type(Derived().f(1)) # revealed: str +``` + +### Accessing the classmethod as a static member + +Accessing a `@classmethod`-decorated function at runtime returns a `classmethod` object. We +currently don't model this explicitly: + +```py +from inspect import getattr_static + +class C: + @classmethod + def f(cls): ... + +reveal_type(getattr_static(C, "f")) # revealed: def f(cls) -> Unknown +reveal_type(getattr_static(C, "f").__get__) # revealed: <method-wrapper `__get__` of `f`> +``` + +But we correctly model how the `classmethod` descriptor works: + +```py +reveal_type(getattr_static(C, "f").__get__(None, C)) # revealed: bound method <class 'C'>.f() -> Unknown +reveal_type(getattr_static(C, "f").__get__(C(), C)) # revealed: bound method <class 'C'>.f() -> Unknown +reveal_type(getattr_static(C, "f").__get__(C())) # revealed: bound method type[C].f() -> Unknown +``` + +The `owner` argument takes precedence over the `instance` argument: + +```py +reveal_type(getattr_static(C, "f").__get__("dummy", C)) # revealed: bound method <class 'C'>.f() -> Unknown +``` + +### Classmethods mixed with other decorators + +```toml +[environment] +python-version = "3.12" +``` + +When a `@classmethod` is additionally decorated with another decorator, it is still treated as a +class method: + +```py +from __future__ import annotations + +def does_nothing[T](f: T) -> T: + return f + +class C: + @classmethod + @does_nothing + def f1(cls: type[C], x: int) -> str: + return "a" + + @does_nothing + @classmethod + def f2(cls: type[C], x: int) -> str: + return "a" + +reveal_type(C.f1(1)) # revealed: str +reveal_type(C().f1(1)) # revealed: str +reveal_type(C.f2(1)) # revealed: str +reveal_type(C().f2(1)) # revealed: str +``` + +[functions and methods]: https://docs.python.org/3/howto/descriptor.html#functions-and-methods diff --git a/crates/ty_python_semantic/resources/mdtest/call/never.md b/crates/ty_python_semantic/resources/mdtest/call/never.md new file mode 100644 index 0000000000000..a8a149c48eb3f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/never.md @@ -0,0 +1,12 @@ +# Never is callable + +The type `Never` is callable with an arbitrary set of arguments. The result is always `Never`. + +```py +from typing_extensions import Never + +def f(never: Never): + reveal_type(never()) # revealed: Never + reveal_type(never(1)) # revealed: Never + reveal_type(never(1, "a", never, x=None)) # revealed: Never +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/str_startswith.md b/crates/ty_python_semantic/resources/mdtest/call/str_startswith.md new file mode 100644 index 0000000000000..643f174763504 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/str_startswith.md @@ -0,0 +1,50 @@ +# `str.startswith` + +We special-case `str.startswith` to allow inference of precise Boolean literal types, because those +are used in [`sys.platform` checks]. + +```py +reveal_type("abc".startswith("")) # revealed: Literal[True] +reveal_type("abc".startswith("a")) # revealed: Literal[True] +reveal_type("abc".startswith("ab")) # revealed: Literal[True] +reveal_type("abc".startswith("abc")) # revealed: Literal[True] + +reveal_type("abc".startswith("abcd")) # revealed: Literal[False] +reveal_type("abc".startswith("bc")) # revealed: Literal[False] + +reveal_type("AbC".startswith("")) # revealed: Literal[True] +reveal_type("AbC".startswith("A")) # revealed: Literal[True] +reveal_type("AbC".startswith("Ab")) # revealed: Literal[True] +reveal_type("AbC".startswith("AbC")) # revealed: Literal[True] + +reveal_type("AbC".startswith("a")) # revealed: Literal[False] +reveal_type("AbC".startswith("aB")) # revealed: Literal[False] + +reveal_type("".startswith("")) # revealed: Literal[True] + +reveal_type("".startswith(" ")) # revealed: Literal[False] +``` + +Make sure that we fall back to `bool` for more complex cases: + +```py +reveal_type("abc".startswith("b", 1)) # revealed: bool +reveal_type("abc".startswith("bc", 1, 3)) # revealed: bool + +reveal_type("abc".startswith(("a", "x"))) # revealed: bool +``` + +And similiarly, we should still infer `bool` if the instance or the prefix are not string literals: + +```py +from typing_extensions import LiteralString + +def _(string_instance: str, literalstring: LiteralString): + reveal_type(string_instance.startswith("a")) # revealed: bool + reveal_type(literalstring.startswith("a")) # revealed: bool + + reveal_type("a".startswith(string_instance)) # revealed: bool + reveal_type("a".startswith(literalstring)) # revealed: bool +``` + +[`sys.platform` checks]: https://docs.python.org/3/library/sys.html#sys.platform diff --git a/crates/ty_python_semantic/resources/mdtest/call/subclass_of.md b/crates/ty_python_semantic/resources/mdtest/call/subclass_of.md new file mode 100644 index 0000000000000..544c4c7c90bb0 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/subclass_of.md @@ -0,0 +1,52 @@ +# Call `type[...]` + +## Single class + +### Trivial constructor + +```py +class C: ... + +def _(subclass_of_c: type[C]): + reveal_type(subclass_of_c()) # revealed: C +``` + +### Non-trivial constructor + +```py +class C: + def __init__(self, x: int): ... + +def _(subclass_of_c: type[C]): + reveal_type(subclass_of_c(1)) # revealed: C + + # error: [invalid-argument-type] "Argument to bound method `__init__` is incorrect: Expected `int`, found `Literal["a"]`" + reveal_type(subclass_of_c("a")) # revealed: C + # error: [missing-argument] "No argument provided for required parameter `x` of bound method `__init__`" + reveal_type(subclass_of_c()) # revealed: C + # error: [too-many-positional-arguments] "Too many positional arguments to bound method `__init__`: expected 2, got 3" + reveal_type(subclass_of_c(1, 2)) # revealed: C +``` + +## Dynamic base + +```py +from typing import Any +from ty_extensions import Unknown + +def _(subclass_of_any: type[Any], subclass_of_unknown: type[Unknown]): + reveal_type(subclass_of_any()) # revealed: Any + reveal_type(subclass_of_any("any", "args", 1, 2)) # revealed: Any + reveal_type(subclass_of_unknown()) # revealed: Unknown + reveal_type(subclass_of_unknown("any", "args", 1, 2)) # revealed: Unknown +``` + +## Unions of classes + +```py +class A: ... +class B: ... + +def _(subclass_of_ab: type[A | B]): + reveal_type(subclass_of_ab()) # revealed: A | B +``` diff --git a/crates/ty_python_semantic/resources/mdtest/call/union.md b/crates/ty_python_semantic/resources/mdtest/call/union.md new file mode 100644 index 0000000000000..5edbdb29819b6 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/call/union.md @@ -0,0 +1,253 @@ +# Unions in calls + +## Union of return types + +```py +def _(flag: bool): + if flag: + def f() -> int: + return 1 + else: + def f() -> str: + return "foo" + reveal_type(f()) # revealed: int | str +``` + +## Calling with an unknown union + +```py +from nonexistent import f # error: [unresolved-import] "Cannot resolve imported module `nonexistent`" + +def coinflip() -> bool: + return True + +if coinflip(): + def f() -> int: + return 1 + +reveal_type(f()) # revealed: Unknown | int +``` + +## Non-callable elements in a union + +Calling a union with a non-callable element should emit a diagnostic. + +```py +def _(flag: bool): + if flag: + f = 1 + else: + def f() -> int: + return 1 + x = f() # error: [call-non-callable] "Object of type `Literal[1]` is not callable" + reveal_type(x) # revealed: Unknown | int +``` + +## Multiple non-callable elements in a union + +Calling a union with multiple non-callable elements should mention all of them in the diagnostic. + +```py +def _(flag: bool, flag2: bool): + if flag: + f = 1 + elif flag2: + f = "foo" + else: + def f() -> int: + return 1 + # error: [call-non-callable] "Object of type `Literal[1]` is not callable" + # error: [call-non-callable] "Object of type `Literal["foo"]` is not callable" + # revealed: Unknown | int + reveal_type(f()) +``` + +## All non-callable union elements + +Calling a union with no callable elements can emit a simpler diagnostic. + +```py +def _(flag: bool): + if flag: + f = 1 + else: + f = "foo" + + x = f() # error: [call-non-callable] "Object of type `Literal[1, "foo"]` is not callable" + reveal_type(x) # revealed: Unknown +``` + +## Mismatching signatures + +Calling a union where the arguments don't match the signature of all variants. + +```py +def f1(a: int) -> int: + return a + +def f2(a: str) -> str: + return a + +def _(flag: bool): + if flag: + f = f1 + else: + f = f2 + + # error: [invalid-argument-type] "Argument to function `f2` is incorrect: Expected `str`, found `Literal[3]`" + x = f(3) + reveal_type(x) # revealed: int | str +``` + +## Any non-callable variant + +```py +def f1(a: int): ... +def _(flag: bool): + if flag: + f = f1 + else: + f = "This is a string literal" + + # error: [call-non-callable] "Object of type `Literal["This is a string literal"]` is not callable" + x = f(3) + reveal_type(x) # revealed: Unknown +``` + +## Union of binding errors + +```py +def f1(): ... +def f2(): ... +def _(flag: bool): + if flag: + f = f1 + else: + f = f2 + + # error: [too-many-positional-arguments] "Too many positional arguments to function `f1`: expected 0, got 1" + # error: [too-many-positional-arguments] "Too many positional arguments to function `f2`: expected 0, got 1" + x = f(3) + reveal_type(x) # revealed: Unknown +``` + +## One not-callable, one wrong argument + +```py +class C: ... + +def f1(): ... +def _(flag: bool): + if flag: + f = f1 + else: + f = C() + + # error: [too-many-positional-arguments] "Too many positional arguments to function `f1`: expected 0, got 1" + # error: [call-non-callable] "Object of type `C` is not callable" + x = f(3) + reveal_type(x) # revealed: Unknown +``` + +## Union including a special-cased function + +```py +def _(flag: bool): + if flag: + f = str + else: + f = repr + reveal_type(str("string")) # revealed: Literal["string"] + reveal_type(repr("string")) # revealed: Literal["'string'"] + reveal_type(f("string")) # revealed: Literal["string", "'string'"] +``` + +## Unions with literals and negations + +```py +from typing import Literal +from ty_extensions import Not, AlwaysFalsy, static_assert, is_subtype_of, is_assignable_to + +static_assert(is_subtype_of(Literal["a", ""], Literal["a", ""] | Not[AlwaysFalsy])) +static_assert(is_subtype_of(Not[AlwaysFalsy], Literal["", "a"] | Not[AlwaysFalsy])) +static_assert(is_subtype_of(Literal["a", ""], Not[AlwaysFalsy] | Literal["a", ""])) +static_assert(is_subtype_of(Not[AlwaysFalsy], Not[AlwaysFalsy] | Literal["a", ""])) + +static_assert(is_subtype_of(Literal["a", ""], Literal["a", ""] | Not[Literal[""]])) +static_assert(is_subtype_of(Not[Literal[""]], Literal["a", ""] | Not[Literal[""]])) +static_assert(is_subtype_of(Literal["a", ""], Not[Literal[""]] | Literal["a", ""])) +static_assert(is_subtype_of(Not[Literal[""]], Not[Literal[""]] | Literal["a", ""])) + +def _( + a: Literal["a", ""] | Not[AlwaysFalsy], + b: Literal["a", ""] | Not[Literal[""]], + c: Literal[""] | Not[Literal[""]], + d: Not[Literal[""]] | Literal[""], + e: Literal["a"] | Not[Literal["a"]], + f: Literal[b"b"] | Not[Literal[b"b"]], + g: Not[Literal[b"b"]] | Literal[b"b"], + h: Literal[42] | Not[Literal[42]], + i: Not[Literal[42]] | Literal[42], +): + reveal_type(a) # revealed: Literal[""] | ~AlwaysFalsy + reveal_type(b) # revealed: object + reveal_type(c) # revealed: object + reveal_type(d) # revealed: object + reveal_type(e) # revealed: object + reveal_type(f) # revealed: object + reveal_type(g) # revealed: object + reveal_type(h) # revealed: object + reveal_type(i) # revealed: object +``` + +## Cannot use an argument as both a value and a type form + +```py +from ty_extensions import is_fully_static + +def _(flag: bool): + if flag: + f = repr + else: + f = is_fully_static + # error: [conflicting-argument-forms] "Argument is used as both a value and a type form in call" + reveal_type(f(int)) # revealed: str | Literal[True] +``` + +## Size limit on unions of literals + +Beyond a certain size, large unions of literal types collapse to their nearest super-type (`int`, +`bytes`, `str`). + +```py +from typing import Literal + +def _(literals_2: Literal[0, 1], b: bool, flag: bool): + literals_4 = 2 * literals_2 + literals_2 # Literal[0, 1, 2, 3] + literals_16 = 4 * literals_4 + literals_4 # Literal[0, 1, .., 15] + literals_64 = 4 * literals_16 + literals_4 # Literal[0, 1, .., 63] + literals_128 = 2 * literals_64 + literals_2 # Literal[0, 1, .., 127] + + # Going beyond the MAX_UNION_LITERALS limit (currently 200): + literals_256 = 16 * literals_16 + literals_16 + reveal_type(literals_256) # revealed: int + + # Going beyond the limit when another type is already part of the union + bool_and_literals_128 = b if flag else literals_128 # bool | Literal[0, 1, ..., 127] + literals_128_shifted = literals_128 + 128 # Literal[128, 129, ..., 255] + + # Now union the two: + reveal_type(bool_and_literals_128 if flag else literals_128_shifted) # revealed: int +``` + +## Simplifying gradually-equivalent types + +If two types are gradually equivalent, we can keep just one of them in a union: + +```py +from typing import Any, Union +from ty_extensions import Intersection, Not + +def _(x: Union[Intersection[Any, Not[int]], Intersection[Any, Not[int]]]): + reveal_type(x) # revealed: Any & ~int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/class/super.md b/crates/ty_python_semantic/resources/mdtest/class/super.md new file mode 100644 index 0000000000000..ecffca0fb65d1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/class/super.md @@ -0,0 +1,410 @@ +# Super + +Python defines the terms _bound super object_ and _unbound super object_. + +An **unbound super object** is created when `super` is called with only one argument. (e.g. +`super(A)`). This object may later be bound using the `super.__get__` method. However, this form is +rarely used in practice. + +A **bound super object** is created either by calling `super(pivot_class, owner)` or by using the +implicit form `super()`, where both the pivot class and the owner are inferred. This is the most +common usage. + +## Basic Usage + +### Explicit Super Object + +`super(pivot_class, owner)` performs attribute lookup along the MRO, starting immediately after the +specified pivot class. + +```py +class A: + def a(self): ... + aa: int = 1 + +class B(A): + def b(self): ... + bb: int = 2 + +class C(B): + def c(self): ... + cc: int = 3 + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'B'>, <class 'A'>, <class 'object'>] + +super(C, C()).a +super(C, C()).b +# error: [unresolved-attribute] "Type `<super: <class 'C'>, C>` has no attribute `c`" +super(C, C()).c + +super(B, C()).a +# error: [unresolved-attribute] "Type `<super: <class 'B'>, C>` has no attribute `b`" +super(B, C()).b +# error: [unresolved-attribute] "Type `<super: <class 'B'>, C>` has no attribute `c`" +super(B, C()).c + +# error: [unresolved-attribute] "Type `<super: <class 'A'>, C>` has no attribute `a`" +super(A, C()).a +# error: [unresolved-attribute] "Type `<super: <class 'A'>, C>` has no attribute `b`" +super(A, C()).b +# error: [unresolved-attribute] "Type `<super: <class 'A'>, C>` has no attribute `c`" +super(A, C()).c + +reveal_type(super(C, C()).a) # revealed: bound method C.a() -> Unknown +reveal_type(super(C, C()).b) # revealed: bound method C.b() -> Unknown +reveal_type(super(C, C()).aa) # revealed: int +reveal_type(super(C, C()).bb) # revealed: int +``` + +### Implicit Super Object + +The implicit form `super()` is same as `super(__class__, <first argument>)`. The `__class__` refers +to the class that contains the function where `super()` is used. The first argument refers to the +current method’s first parameter (typically `self` or `cls`). + +```py +from __future__ import annotations + +class A: + def __init__(self, a: int): ... + @classmethod + def f(cls): ... + +class B(A): + def __init__(self, a: int): + # TODO: Once `Self` is supported, this should be `<super: <class 'B'>, B>` + reveal_type(super()) # revealed: <super: <class 'B'>, Unknown> + super().__init__(a) + + @classmethod + def f(cls): + # TODO: Once `Self` is supported, this should be `<super: <class 'B'>, <class 'B'>>` + reveal_type(super()) # revealed: <super: <class 'B'>, Unknown> + super().f() + +super(B, B(42)).__init__(42) +super(B, B).f() +``` + +### Unbound Super Object + +Calling `super(cls)` without a second argument returns an _unbound super object_. This is treated as +a plain `super` instance and does not support name lookup via the MRO. + +```py +class A: + a: int = 42 + +class B(A): ... + +reveal_type(super(B)) # revealed: super + +# error: [unresolved-attribute] "Type `super` has no attribute `a`" +super(B).a +``` + +## Attribute Assignment + +`super()` objects do not allow attribute assignment — even if the attribute is resolved +successfully. + +```py +class A: + a: int = 3 + +class B(A): ... + +reveal_type(super(B, B()).a) # revealed: int +# error: [invalid-assignment] "Cannot assign to attribute `a` on type `<super: <class 'B'>, B>`" +super(B, B()).a = 3 +# error: [invalid-assignment] "Cannot assign to attribute `a` on type `super`" +super(B).a = 5 +``` + +## Dynamic Types + +If any of the arguments is dynamic, we cannot determine the MRO to traverse. When accessing a +member, it should effectively behave like a dynamic type. + +```py +class A: + a: int = 1 + +def f(x): + reveal_type(x) # revealed: Unknown + + reveal_type(super(x, x)) # revealed: <super: Unknown, Unknown> + reveal_type(super(A, x)) # revealed: <super: <class 'A'>, Unknown> + reveal_type(super(x, A())) # revealed: <super: Unknown, A> + + reveal_type(super(x, x).a) # revealed: Unknown + reveal_type(super(A, x).a) # revealed: Unknown + reveal_type(super(x, A()).a) # revealed: Unknown +``` + +## Implicit `super()` in Complex Structure + +```py +from __future__ import annotations + +class A: + def test(self): + reveal_type(super()) # revealed: <super: <class 'A'>, Unknown> + + class B: + def test(self): + reveal_type(super()) # revealed: <super: <class 'B'>, Unknown> + + class C(A.B): + def test(self): + reveal_type(super()) # revealed: <super: <class 'C'>, Unknown> + + def inner(t: C): + reveal_type(super()) # revealed: <super: <class 'B'>, C> + lambda x: reveal_type(super()) # revealed: <super: <class 'B'>, Unknown> +``` + +## Built-ins and Literals + +```py +reveal_type(super(bool, True)) # revealed: <super: <class 'bool'>, bool> +reveal_type(super(bool, bool())) # revealed: <super: <class 'bool'>, bool> +reveal_type(super(int, bool())) # revealed: <super: <class 'int'>, bool> +reveal_type(super(int, 3)) # revealed: <super: <class 'int'>, int> +reveal_type(super(str, "")) # revealed: <super: <class 'str'>, str> +``` + +## Descriptor Behavior with Super + +Accessing attributes through `super` still invokes descriptor protocol. However, the behavior can +differ depending on whether the second argument to `super` is a class or an instance. + +```py +class A: + def a1(self): ... + @classmethod + def a2(cls): ... + +class B(A): ... + +# A.__dict__["a1"].__get__(B(), B) +reveal_type(super(B, B()).a1) # revealed: bound method B.a1() -> Unknown +# A.__dict__["a2"].__get__(B(), B) +reveal_type(super(B, B()).a2) # revealed: bound method type[B].a2() -> Unknown + +# A.__dict__["a1"].__get__(None, B) +reveal_type(super(B, B).a1) # revealed: def a1(self) -> Unknown +# A.__dict__["a2"].__get__(None, B) +reveal_type(super(B, B).a2) # revealed: bound method <class 'B'>.a2() -> Unknown +``` + +## Union of Supers + +When the owner is a union type, `super()` is built separately for each branch, and the resulting +super objects are combined into a union. + +```py +class A: ... + +class B: + b: int = 42 + +class C(A, B): ... +class D(B, A): ... + +def f(x: C | D): + reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'A'>, <class 'B'>, <class 'object'>] + reveal_type(D.__mro__) # revealed: tuple[<class 'D'>, <class 'B'>, <class 'A'>, <class 'object'>] + + s = super(A, x) + reveal_type(s) # revealed: <super: <class 'A'>, C> | <super: <class 'A'>, D> + + # error: [possibly-unbound-attribute] "Attribute `b` on type `<super: <class 'A'>, C> | <super: <class 'A'>, D>` is possibly unbound" + s.b + +def f(flag: bool): + x = str() if flag else str("hello") + reveal_type(x) # revealed: Literal["", "hello"] + reveal_type(super(str, x)) # revealed: <super: <class 'str'>, str> + +def f(x: int | str): + # error: [invalid-super-argument] "`str` is not an instance or subclass of `<class 'int'>` in `super(<class 'int'>, str)` call" + super(int, x) +``` + +Even when `super()` is constructed separately for each branch of a union, it should behave correctly +in all cases. + +```py +def f(flag: bool): + if flag: + class A: + x = 1 + y: int = 1 + + a: str = "hello" + + class B(A): ... + s = super(B, B()) + else: + class C: + x = 2 + y: int | str = "test" + + class D(C): ... + s = super(D, D()) + + reveal_type(s) # revealed: <super: <class 'B'>, B> | <super: <class 'D'>, D> + + reveal_type(s.x) # revealed: Unknown | Literal[1, 2] + reveal_type(s.y) # revealed: int | str + + # error: [possibly-unbound-attribute] "Attribute `a` on type `<super: <class 'B'>, B> | <super: <class 'D'>, D>` is possibly unbound" + reveal_type(s.a) # revealed: str +``` + +## Supers with Generic Classes + +```toml +[environment] +python-version = "3.12" +``` + +```py +from ty_extensions import TypeOf, static_assert, is_subtype_of + +class A[T]: + def f(self, a: T) -> T: + return a + +class B[T](A[T]): + def f(self, b: T) -> T: + return super().f(b) +``` + +## Invalid Usages + +### Unresolvable `super()` Calls + +If an appropriate class and argument cannot be found, a runtime error will occur. + +```py +from __future__ import annotations + +# error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" +reveal_type(super()) # revealed: Unknown + +def f(): + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + super() + +# No first argument in its scope +class A: + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + s = super() + + def f(self): + def g(): + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + super() + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + lambda: super() + + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + (super() for _ in range(10)) + + @staticmethod + def h(): + # error: [unavailable-implicit-super-arguments] "Cannot determine implicit arguments for 'super()' in this context" + super() +``` + +### Failing Condition Checks + +```toml +[environment] +python-version = "3.12" +``` + +`super()` requires its first argument to be a valid class, and its second argument to be either an +instance or a subclass of the first. If either condition is violated, a `TypeError` is raised at +runtime. + +```py +def f(x: int): + # error: [invalid-super-argument] "`int` is not a valid class" + super(x, x) + + type IntAlias = int + # error: [invalid-super-argument] "`typing.TypeAliasType` is not a valid class" + super(IntAlias, 0) + +# error: [invalid-super-argument] "`Literal[""]` is not an instance or subclass of `<class 'int'>` in `super(<class 'int'>, Literal[""])` call" +# revealed: Unknown +reveal_type(super(int, str())) + +# error: [invalid-super-argument] "`<class 'str'>` is not an instance or subclass of `<class 'int'>` in `super(<class 'int'>, <class 'str'>)` call" +# revealed: Unknown +reveal_type(super(int, str)) + +class A: ... +class B(A): ... + +# error: [invalid-super-argument] "`A` is not an instance or subclass of `<class 'B'>` in `super(<class 'B'>, A)` call" +# revealed: Unknown +reveal_type(super(B, A())) + +# error: [invalid-super-argument] "`object` is not an instance or subclass of `<class 'B'>` in `super(<class 'B'>, object)` call" +# revealed: Unknown +reveal_type(super(B, object())) + +# error: [invalid-super-argument] "`<class 'A'>` is not an instance or subclass of `<class 'B'>` in `super(<class 'B'>, <class 'A'>)` call" +# revealed: Unknown +reveal_type(super(B, A)) + +# error: [invalid-super-argument] "`<class 'object'>` is not an instance or subclass of `<class 'B'>` in `super(<class 'B'>, <class 'object'>)` call" +# revealed: Unknown +reveal_type(super(B, object)) + +super(object, object()).__class__ +``` + +### Instance Member Access via `super` + +Accessing instance members through `super()` is not allowed. + +```py +from __future__ import annotations + +class A: + def __init__(self, a: int): + self.a = a + +class B(A): + def __init__(self, a: int): + super().__init__(a) + # TODO: Once `Self` is supported, this should raise `unresolved-attribute` error + super().a + +# error: [unresolved-attribute] "Type `<super: <class 'B'>, B>` has no attribute `a`" +super(B, B(42)).a +``` + +### Dunder Method Resolution + +Dunder methods defined in the `owner` (from `super(pivot_class, owner)`) should not affect the super +object itself. In other words, `super` should not be treated as if it inherits attributes of the +`owner`. + +```py +class A: + def __getitem__(self, key: int) -> int: + return 42 + +class B(A): ... + +reveal_type(A()[0]) # revealed: int +reveal_type(super(B, B()).__getitem__) # revealed: bound method B.__getitem__(key: int) -> int +# error: [non-subscriptable] "Cannot subscript object of type `<super: <class 'B'>, B>` with no `__getitem__` method" +super(B, B())[0] +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/comparison/byte_literals.md b/crates/ty_python_semantic/resources/mdtest/comparison/byte_literals.md similarity index 96% rename from crates/red_knot_python_semantic/resources/mdtest/comparison/byte_literals.md rename to crates/ty_python_semantic/resources/mdtest/comparison/byte_literals.md index 27aee9f1c8005..2a76e5b227504 100644 --- a/crates/red_knot_python_semantic/resources/mdtest/comparison/byte_literals.md +++ b/crates/ty_python_semantic/resources/mdtest/comparison/byte_literals.md @@ -1,7 +1,7 @@ # Comparison: Byte literals -These tests assert that we infer precise `Literal` types for comparisons between objects -inferred as having `Literal` bytes types: +These tests assert that we infer precise `Literal` types for comparisons between objects inferred as +having `Literal` bytes types: ```py reveal_type(b"abc" == b"abc") # revealed: Literal[True] diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/identity.md b/crates/ty_python_semantic/resources/mdtest/comparison/identity.md new file mode 100644 index 0000000000000..a636307a1dbfa --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/identity.md @@ -0,0 +1,33 @@ +# Identity tests + +```py +class A: ... + +def _(a1: A, a2: A, o: object): + n1 = None + n2 = None + + reveal_type(a1 is a1) # revealed: bool + reveal_type(a1 is a2) # revealed: bool + + reveal_type(n1 is n1) # revealed: Literal[True] + reveal_type(n1 is n2) # revealed: Literal[True] + + reveal_type(a1 is n1) # revealed: Literal[False] + reveal_type(n1 is a1) # revealed: Literal[False] + + reveal_type(a1 is o) # revealed: bool + reveal_type(n1 is o) # revealed: bool + + reveal_type(a1 is not a1) # revealed: bool + reveal_type(a1 is not a2) # revealed: bool + + reveal_type(n1 is not n1) # revealed: Literal[False] + reveal_type(n1 is not n2) # revealed: Literal[False] + + reveal_type(a1 is not n1) # revealed: Literal[True] + reveal_type(n1 is not a1) # revealed: Literal[True] + + reveal_type(a1 is not o) # revealed: bool + reveal_type(n1 is not o) # revealed: bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/instances/membership_test.md b/crates/ty_python_semantic/resources/mdtest/comparison/instances/membership_test.md new file mode 100644 index 0000000000000..b28d0d04fa9bf --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/instances/membership_test.md @@ -0,0 +1,204 @@ +# Comparison: Membership Test + +In Python, the term "membership test operators" refers to the operators `in` and `not in`. To +customize their behavior, classes can implement one of the special methods `__contains__`, +`__iter__`, or `__getitem__`. + +For references, see: + +- <https://docs.python.org/3/reference/expressions.html#membership-test-details> +- <https://docs.python.org/3/reference/datamodel.html#object.__contains__> +- <https://snarky.ca/unravelling-membership-testing/> + +## Implements `__contains__` + +Classes can support membership tests by implementing the `__contains__` method: + +```py +class A: + def __contains__(self, item: str) -> bool: + return True + +reveal_type("hello" in A()) # revealed: bool +reveal_type("hello" not in A()) # revealed: bool +# error: [unsupported-operator] "Operator `in` is not supported for types `int` and `A`, in comparing `Literal[42]` with `A`" +reveal_type(42 in A()) # revealed: bool +# error: [unsupported-operator] "Operator `not in` is not supported for types `int` and `A`, in comparing `Literal[42]` with `A`" +reveal_type(42 not in A()) # revealed: bool +``` + +## Implements `__iter__` + +Classes that don't implement `__contains__`, but do implement `__iter__`, also support containment +checks; the needle will be sought in their iterated items: + +```py +class StringIterator: + def __next__(self) -> str: + return "foo" + +class A: + def __iter__(self) -> StringIterator: + return StringIterator() + +reveal_type("hello" in A()) # revealed: bool +reveal_type("hello" not in A()) # revealed: bool +reveal_type(42 in A()) # revealed: bool +reveal_type(42 not in A()) # revealed: bool +``` + +## Implements `__getitems__` + +The final fallback is to implement `__getitem__` for integer keys. Python will call `__getitem__` +with `0`, `1`, `2`... until either the needle is found (leading the membership test to evaluate to +`True`) or `__getitem__` raises `IndexError` (the raised exception is swallowed, but results in the +membership test evaluating to `False`). + +```py +class A: + def __getitem__(self, key: int) -> str: + return "foo" + +reveal_type("hello" in A()) # revealed: bool +reveal_type("hello" not in A()) # revealed: bool +reveal_type(42 in A()) # revealed: bool +reveal_type(42 not in A()) # revealed: bool +``` + +## Wrong Return Type + +Python coerces the results of containment checks to `bool`, even if `__contains__` returns a +non-bool: + +```py +class A: + def __contains__(self, item: str) -> str: + return "foo" + +reveal_type("hello" in A()) # revealed: bool +reveal_type("hello" not in A()) # revealed: bool +``` + +## Literal Result for `in` and `not in` + +`__contains__` with a literal return type may result in a `BooleanLiteral` outcome. + +```py +from typing import Literal + +class AlwaysTrue: + def __contains__(self, item: int) -> Literal[1]: + return 1 + +class AlwaysFalse: + def __contains__(self, item: int) -> Literal[""]: + return "" + +reveal_type(42 in AlwaysTrue()) # revealed: Literal[True] +reveal_type(42 not in AlwaysTrue()) # revealed: Literal[False] + +reveal_type(42 in AlwaysFalse()) # revealed: Literal[False] +reveal_type(42 not in AlwaysFalse()) # revealed: Literal[True] +``` + +## No Fallback for `__contains__` + +If `__contains__` is implemented, checking membership of a type it doesn't accept is an error; it +doesn't result in a fallback to `__iter__` or `__getitem__`: + +```py +class CheckContains: ... +class CheckIter: ... +class CheckGetItem: ... + +class CheckIterIterator: + def __next__(self) -> CheckIter: + return CheckIter() + +class A: + def __contains__(self, item: CheckContains) -> bool: + return True + + def __iter__(self) -> CheckIterIterator: + return CheckIterIterator() + + def __getitem__(self, key: int) -> CheckGetItem: + return CheckGetItem() + +reveal_type(CheckContains() in A()) # revealed: bool + +# error: [unsupported-operator] "Operator `in` is not supported for types `CheckIter` and `A`" +reveal_type(CheckIter() in A()) # revealed: bool +# error: [unsupported-operator] "Operator `in` is not supported for types `CheckGetItem` and `A`" +reveal_type(CheckGetItem() in A()) # revealed: bool + +class B: + def __iter__(self) -> CheckIterIterator: + return CheckIterIterator() + + def __getitem__(self, key: int) -> CheckGetItem: + return CheckGetItem() + +reveal_type(CheckIter() in B()) # revealed: bool +# Always use `__iter__`, regardless of iterated type; there's no NotImplemented +# in this case, so there's no fallback to `__getitem__` +reveal_type(CheckGetItem() in B()) # revealed: bool +``` + +## Invalid Old-Style Iteration + +If `__getitem__` is implemented but does not accept integer arguments, then the membership test is +not supported and should trigger a diagnostic. + +```py +class A: + def __getitem__(self, key: str) -> str: + return "foo" + +# error: [unsupported-operator] "Operator `in` is not supported for types `int` and `A`, in comparing `Literal[42]` with `A`" +reveal_type(42 in A()) # revealed: bool +# error: [unsupported-operator] "Operator `in` is not supported for types `str` and `A`, in comparing `Literal["hello"]` with `A`" +reveal_type("hello" in A()) # revealed: bool +``` + +## Return type that doesn't implement `__bool__` correctly + +`in` and `not in` operations will fail at runtime if the object on the right-hand side of the +operation has a `__contains__` method that returns a type which is not convertible to `bool`. This +is because of the way these operations are handled by the Python interpreter at runtime. If we +assume that `y` is an object that has a `__contains__` method, the Python expression `x in y` +desugars to a `contains(y, x)` call, where `contains` looks something like this: + +```ignore +def contains(y, x): + return bool(type(y).__contains__(y, x)) +``` + +where the `bool()` conversion itself implicitly calls `__bool__` under the hood. + +TODO: Ideally the message would explain to the user what's wrong. E.g, + +```ignore +error: [operator] cannot use `in` operator on object of type `WithContains` + note: This is because the `in` operator implicitly calls `WithContains.__contains__`, but `WithContains.__contains__` is invalidly defined + note: `WithContains.__contains__` is invalidly defined because it returns an instance of `NotBoolable`, which cannot be evaluated in a boolean context + note: `NotBoolable` cannot be evaluated in a boolean context because its `__bool__` attribute is not callable +``` + +It may also be more appropriate to use `unsupported-operator` as the error code. + +<!-- snapshot-diagnostics --> + +```py +class NotBoolable: + __bool__: int = 3 + +class WithContains: + def __contains__(self, item) -> NotBoolable: + return NotBoolable() + +# error: [unsupported-bool-conversion] +10 in WithContains() +# error: [unsupported-bool-conversion] +10 not in WithContains() +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md b/crates/ty_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md new file mode 100644 index 0000000000000..f6fda97032a89 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md @@ -0,0 +1,391 @@ +# Comparison: Rich Comparison + +Rich comparison operations (`==`, `!=`, `<`, `<=`, `>`, `>=`) in Python are implemented through +double-underscore methods that allow customization of comparison behavior. + +For references, see: + +- <https://docs.python.org/3/reference/datamodel.html#object.__lt__> +- <https://snarky.ca/unravelling-rich-comparison-operators/> + +## Rich Comparison Dunder Implementations For Same Class + +Classes can support rich comparison by implementing dunder methods like `__eq__`, `__ne__`, etc. The +most common case involves implementing these methods for the same type: + +```py +from __future__ import annotations + +class EqReturnType: ... +class NeReturnType: ... +class LtReturnType: ... +class LeReturnType: ... +class GtReturnType: ... +class GeReturnType: ... + +class A: + def __eq__(self, other: A) -> EqReturnType: + return EqReturnType() + + def __ne__(self, other: A) -> NeReturnType: + return NeReturnType() + + def __lt__(self, other: A) -> LtReturnType: + return LtReturnType() + + def __le__(self, other: A) -> LeReturnType: + return LeReturnType() + + def __gt__(self, other: A) -> GtReturnType: + return GtReturnType() + + def __ge__(self, other: A) -> GeReturnType: + return GeReturnType() + +reveal_type(A() == A()) # revealed: EqReturnType +reveal_type(A() != A()) # revealed: NeReturnType +reveal_type(A() < A()) # revealed: LtReturnType +reveal_type(A() <= A()) # revealed: LeReturnType +reveal_type(A() > A()) # revealed: GtReturnType +reveal_type(A() >= A()) # revealed: GeReturnType +``` + +## Rich Comparison Dunder Implementations for Other Class + +In some cases, classes may implement rich comparison dunder methods for comparisons with a different +type: + +```py +from __future__ import annotations + +class EqReturnType: ... +class NeReturnType: ... +class LtReturnType: ... +class LeReturnType: ... +class GtReturnType: ... +class GeReturnType: ... + +class A: + def __eq__(self, other: B) -> EqReturnType: + return EqReturnType() + + def __ne__(self, other: B) -> NeReturnType: + return NeReturnType() + + def __lt__(self, other: B) -> LtReturnType: + return LtReturnType() + + def __le__(self, other: B) -> LeReturnType: + return LeReturnType() + + def __gt__(self, other: B) -> GtReturnType: + return GtReturnType() + + def __ge__(self, other: B) -> GeReturnType: + return GeReturnType() + +class B: ... + +reveal_type(A() == B()) # revealed: EqReturnType +reveal_type(A() != B()) # revealed: NeReturnType +reveal_type(A() < B()) # revealed: LtReturnType +reveal_type(A() <= B()) # revealed: LeReturnType +reveal_type(A() > B()) # revealed: GtReturnType +reveal_type(A() >= B()) # revealed: GeReturnType +``` + +## Reflected Comparisons + +Fallback to the right-hand side’s comparison methods occurs when the left-hand side does not define +them. Note: class `B` has its own `__eq__` and `__ne__` methods to override those of `object`, but +these methods will be ignored here because they require a mismatched operand type. + +```py +from __future__ import annotations + +class EqReturnType: ... +class NeReturnType: ... +class LtReturnType: ... +class LeReturnType: ... +class GtReturnType: ... +class GeReturnType: ... + +class A: + def __eq__(self, other: B) -> EqReturnType: + return EqReturnType() + + def __ne__(self, other: B) -> NeReturnType: + return NeReturnType() + + def __lt__(self, other: B) -> LtReturnType: + return LtReturnType() + + def __le__(self, other: B) -> LeReturnType: + return LeReturnType() + + def __gt__(self, other: B) -> GtReturnType: + return GtReturnType() + + def __ge__(self, other: B) -> GeReturnType: + return GeReturnType() + +class Unrelated: ... + +class B: + # To override builtins.object.__eq__ and builtins.object.__ne__ + # TODO these should emit an invalid override diagnostic + def __eq__(self, other: Unrelated) -> B: + return B() + + def __ne__(self, other: Unrelated) -> B: + return B() + +# Because `object.__eq__` and `object.__ne__` accept `object` in typeshed, +# this can only happen with an invalid override of these methods, +# but we still support it. +reveal_type(B() == A()) # revealed: EqReturnType +reveal_type(B() != A()) # revealed: NeReturnType + +reveal_type(B() < A()) # revealed: GtReturnType +reveal_type(B() <= A()) # revealed: GeReturnType + +reveal_type(B() > A()) # revealed: LtReturnType +reveal_type(B() >= A()) # revealed: LeReturnType + +class C: + def __gt__(self, other: C) -> EqReturnType: + return EqReturnType() + + def __ge__(self, other: C) -> NeReturnType: + return NeReturnType() + +reveal_type(C() < C()) # revealed: EqReturnType +reveal_type(C() <= C()) # revealed: NeReturnType +``` + +## Reflected Comparisons with Subclasses + +When subclasses override comparison methods, these overridden methods take precedence over those in +the parent class. Class `B` inherits from `A` and redefines comparison methods to return types other +than `A`. + +```py +from __future__ import annotations + +class EqReturnType: ... +class NeReturnType: ... +class LtReturnType: ... +class LeReturnType: ... +class GtReturnType: ... +class GeReturnType: ... + +class A: + def __eq__(self, other: A) -> A: + return A() + + def __ne__(self, other: A) -> A: + return A() + + def __lt__(self, other: A) -> A: + return A() + + def __le__(self, other: A) -> A: + return A() + + def __gt__(self, other: A) -> A: + return A() + + def __ge__(self, other: A) -> A: + return A() + +class B(A): + def __eq__(self, other: A) -> EqReturnType: + return EqReturnType() + + def __ne__(self, other: A) -> NeReturnType: + return NeReturnType() + + def __lt__(self, other: A) -> LtReturnType: + return LtReturnType() + + def __le__(self, other: A) -> LeReturnType: + return LeReturnType() + + def __gt__(self, other: A) -> GtReturnType: + return GtReturnType() + + def __ge__(self, other: A) -> GeReturnType: + return GeReturnType() + +reveal_type(A() == B()) # revealed: EqReturnType +reveal_type(A() != B()) # revealed: NeReturnType + +reveal_type(A() < B()) # revealed: GtReturnType +reveal_type(A() <= B()) # revealed: GeReturnType + +reveal_type(A() > B()) # revealed: LtReturnType +reveal_type(A() >= B()) # revealed: LeReturnType +``` + +## Reflected Comparisons with Subclass But Falls Back to LHS + +In the case of a subclass, the right-hand side has priority. However, if the overridden dunder +method has an mismatched type to operand, the comparison will fall back to the left-hand side. + +```py +from __future__ import annotations + +class A: + def __lt__(self, other: A) -> A: + return A() + + def __gt__(self, other: A) -> A: + return A() + +class B(A): + def __lt__(self, other: int) -> B: + return B() + + def __gt__(self, other: int) -> B: + return B() + +reveal_type(A() < B()) # revealed: A +reveal_type(A() > B()) # revealed: A +``` + +## Operations involving instances of classes inheriting from `Any` + +`Any` and `Unknown` represent a set of possible runtime objects, wherein the bounds of the set are +unknown. Whether the left-hand operand's dunder or the right-hand operand's reflected dunder depends +on whether the right-hand operand is an instance of a class that is a subclass of the left-hand +operand's class and overrides the reflected dunder. In the following example, because of the +unknowable nature of `Any`/`Unknown`, we must consider both possibilities: `Any`/`Unknown` might +resolve to an unknown third class that inherits from `X` and overrides `__gt__`; but it also might +not. Thus, the correct answer here for the `reveal_type` is `int | Unknown`. + +(This test is referenced from `mdtest/binary/instances.md`) + +```py +from does_not_exist import Foo # error: [unresolved-import] + +reveal_type(Foo) # revealed: Unknown + +class X: + def __lt__(self, other: object) -> int: + return 42 + +class Y(Foo): ... + +# TODO: Should be `int | Unknown`; see above discussion. +reveal_type(X() < Y()) # revealed: int +``` + +## Equality and Inequality Fallback + +This test confirms that `==` and `!=` comparisons default to identity comparisons (`is`, `is not`) +when argument types do not match the method signature. + +Please refer to the [docs](https://docs.python.org/3/reference/datamodel.html#object.__eq__) + +```py +from __future__ import annotations + +class A: + # TODO both these overrides should emit invalid-override diagnostic + def __eq__(self, other: int) -> A: + return A() + + def __ne__(self, other: int) -> A: + return A() + +reveal_type(A() == A()) # revealed: bool +reveal_type(A() != A()) # revealed: bool +``` + +## Object Comparisons with Typeshed + +```py +class A: ... + +reveal_type(A() == object()) # revealed: bool +reveal_type(A() != object()) # revealed: bool +reveal_type(object() == A()) # revealed: bool +reveal_type(object() != A()) # revealed: bool + +# error: [unsupported-operator] "Operator `<` is not supported for types `A` and `object`" +# revealed: Unknown +reveal_type(A() < object()) +``` + +## Numbers Comparison with typeshed + +```py +reveal_type(1 == 1.0) # revealed: bool +reveal_type(1 != 1.0) # revealed: bool +reveal_type(1 < 1.0) # revealed: bool +reveal_type(1 <= 1.0) # revealed: bool +reveal_type(1 > 1.0) # revealed: bool +reveal_type(1 >= 1.0) # revealed: bool + +reveal_type(1 == 2j) # revealed: bool +reveal_type(1 != 2j) # revealed: bool + +# error: [unsupported-operator] "Operator `<` is not supported for types `int` and `complex`, in comparing `Literal[1]` with `complex`" +reveal_type(1 < 2j) # revealed: Unknown +# error: [unsupported-operator] "Operator `<=` is not supported for types `int` and `complex`, in comparing `Literal[1]` with `complex`" +reveal_type(1 <= 2j) # revealed: Unknown +# error: [unsupported-operator] "Operator `>` is not supported for types `int` and `complex`, in comparing `Literal[1]` with `complex`" +reveal_type(1 > 2j) # revealed: Unknown +# error: [unsupported-operator] "Operator `>=` is not supported for types `int` and `complex`, in comparing `Literal[1]` with `complex`" +reveal_type(1 >= 2j) # revealed: Unknown + +def f(x: bool, y: int): + reveal_type(x < y) # revealed: bool + reveal_type(y < x) # revealed: bool + reveal_type(4.2 < x) # revealed: bool + reveal_type(x < 4.2) # revealed: bool +``` + +## Chained comparisons with objects that don't implement `__bool__` correctly + +<!-- snapshot-diagnostics --> + +Python implicitly calls `bool` on the comparison result of preceding elements (but not for the last +element) of a chained comparison. + +```py +class NotBoolable: + __bool__: int = 3 + +class Comparable: + def __lt__(self, item) -> NotBoolable: + return NotBoolable() + + def __gt__(self, item) -> NotBoolable: + return NotBoolable() + +# error: [unsupported-bool-conversion] +10 < Comparable() < 20 +# error: [unsupported-bool-conversion] +10 < Comparable() < Comparable() + +Comparable() < Comparable() # fine +``` + +## Callables as comparison dunders + +```py +from typing import Literal + +class AlwaysTrue: + def __call__(self, other: object) -> Literal[True]: + return True + +class A: + __eq__: AlwaysTrue = AlwaysTrue() + __lt__: AlwaysTrue = AlwaysTrue() + +reveal_type(A() == A()) # revealed: Literal[True] +reveal_type(A() < A()) # revealed: Literal[True] +reveal_type(A() > A()) # revealed: Literal[True] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/integers.md b/crates/ty_python_semantic/resources/mdtest/comparison/integers.md new file mode 100644 index 0000000000000..eeccd6a60a461 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/integers.md @@ -0,0 +1,27 @@ +# Comparison: Integers + +## Integer literals + +```py +reveal_type(1 == 1 == True) # revealed: Literal[True] +reveal_type(1 == 1 == 2 == 4) # revealed: Literal[False] +reveal_type(False < True <= 2 < 3 != 6) # revealed: Literal[True] +reveal_type(1 < 1) # revealed: Literal[False] +reveal_type(1 > 1) # revealed: Literal[False] +reveal_type(1 is 1) # revealed: bool +reveal_type(1 is not 1) # revealed: bool +reveal_type(1 is 2) # revealed: Literal[False] +reveal_type(1 is not 7) # revealed: Literal[True] +# error: [unsupported-operator] "Operator `<=` is not supported for types `int` and `str`, in comparing `Literal[1]` with `Literal[""]`" +reveal_type(1 <= "" and 0 < 1) # revealed: (Unknown & ~AlwaysTruthy) | Literal[True] +``` + +## Integer instance + +```py +# TODO: implement lookup of `__eq__` on typeshed `int` stub. +def _(a: int, b: int): + reveal_type(1 == a) # revealed: bool + reveal_type(9 < a) # revealed: bool + reveal_type(a < b) # revealed: bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/intersections.md b/crates/ty_python_semantic/resources/mdtest/comparison/intersections.md new file mode 100644 index 0000000000000..f1750dde1f479 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/intersections.md @@ -0,0 +1,150 @@ +# Comparison: Intersections + +## Positive contributions + +If we have an intersection type `A & B` and we get a definitive true/false answer for one of the +types, we can infer that the result for the intersection type is also true/false: + +```py +from typing import Literal + +class Base: + def __gt__(self, other) -> bool: + return False + +class Child1(Base): + def __eq__(self, other) -> Literal[True]: + return True + +class Child2(Base): ... + +def _(x: Base): + c1 = Child1() + + # Create an intersection type through narrowing: + if isinstance(x, Child1): + if isinstance(x, Child2): + reveal_type(x) # revealed: Child1 & Child2 + + reveal_type(x == 1) # revealed: Literal[True] + + # Other comparison operators fall back to the base type: + reveal_type(x > 1) # revealed: bool + reveal_type(x is c1) # revealed: bool +``` + +## Negative contributions + +Negative contributions to the intersection type only allow simplifications in a few special cases +(equality and identity comparisons). + +### Equality comparisons + +#### Literal strings + +```py +x = "x" * 1_000_000_000 +y = "y" * 1_000_000_000 +reveal_type(x) # revealed: LiteralString + +if x != "abc": + reveal_type(x) # revealed: LiteralString & ~Literal["abc"] + + # TODO: This should be `Literal[False]` + reveal_type(x == "abc") # revealed: bool + # TODO: This should be `Literal[False]` + reveal_type("abc" == x) # revealed: bool + reveal_type(x == "something else") # revealed: bool + reveal_type("something else" == x) # revealed: bool + + # TODO: This should be `Literal[True]` + reveal_type(x != "abc") # revealed: bool + # TODO: This should be `Literal[True]` + reveal_type("abc" != x) # revealed: bool + reveal_type(x != "something else") # revealed: bool + reveal_type("something else" != x) # revealed: bool + + reveal_type(x == y) # revealed: bool + reveal_type(y == x) # revealed: bool + reveal_type(x != y) # revealed: bool + reveal_type(y != x) # revealed: bool + + reveal_type(x >= "abc") # revealed: bool + reveal_type("abc" >= x) # revealed: bool + + reveal_type(x in "abc") # revealed: bool + reveal_type("abc" in x) # revealed: bool +``` + +#### Integers + +```py +def _(x: int): + if x != 1: + reveal_type(x) # revealed: int & ~Literal[1] + + reveal_type(x != 1) # revealed: bool + reveal_type(x != 2) # revealed: bool + + reveal_type(x == 1) # revealed: bool + reveal_type(x == 2) # revealed: bool +``` + +### Identity comparisons + +```py +class A: ... + +def _(o: object): + a = A() + n = None + + if o is not None: + reveal_type(o) # revealed: ~None + reveal_type(o is n) # revealed: Literal[False] + reveal_type(o is not n) # revealed: Literal[True] +``` + +## Diagnostics + +### Unsupported operators for positive contributions + +Raise an error if any of the positive contributions to the intersection type are unsupported for the +given operator: + +```py +class Container: + def __contains__(self, x) -> bool: + return False + +class NonContainer: ... + +def _(x: object): + if isinstance(x, Container): + if isinstance(x, NonContainer): + reveal_type(x) # revealed: Container & NonContainer + + # error: [unsupported-operator] "Operator `in` is not supported for types `int` and `NonContainer`" + reveal_type(2 in x) # revealed: bool +``` + +### Unsupported operators for negative contributions + +Do *not* raise an error if any of the negative contributions to the intersection type are +unsupported for the given operator: + +```py +class Container: + def __contains__(self, x) -> bool: + return False + +class NonContainer: ... + +def _(x: object): + if isinstance(x, Container): + if not isinstance(x, NonContainer): + reveal_type(x) # revealed: Container & ~NonContainer + + # No error here! + reveal_type(2 in x) # revealed: bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/non_bool_returns.md b/crates/ty_python_semantic/resources/mdtest/comparison/non_bool_returns.md new file mode 100644 index 0000000000000..2da190aa5d6d5 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/non_bool_returns.md @@ -0,0 +1,47 @@ +# Comparison: Non boolean returns + +Walking through examples: + +- `a = A() < B() < C()` + + 1. `A() < B() and B() < C()` - split in N comparison + 1. `A()` and `B()` - evaluate outcome types + 1. `bool` and `bool` - evaluate truthiness + 1. `A | B` - union of "first true" types + +- `b = 0 < 1 < A() < 3` + + 1. `0 < 1 and 1 < A() and A() < 3` - split in N comparison + 1. `True` and `bool` and `A` - evaluate outcome types + 1. `True` and `bool` and `bool` - evaluate truthiness + 1. `bool | A` - union of "true" types + +- `c = 10 < 0 < A() < B() < C()` short-circuit to False + +```py +from __future__ import annotations + +class A: + def __lt__(self, other) -> A: + return self + + def __gt__(self, other) -> bool: + return False + +class B: + def __lt__(self, other) -> B: + return self + +class C: + def __lt__(self, other) -> C: + return self + +x = A() < B() < C() +reveal_type(x) # revealed: (A & ~AlwaysTruthy) | B + +y = 0 < 1 < A() < 3 +reveal_type(y) # revealed: Literal[False] | A + +z = 10 < 0 < A() < B() < C() +reveal_type(z) # revealed: Literal[False] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/strings.md b/crates/ty_python_semantic/resources/mdtest/comparison/strings.md new file mode 100644 index 0000000000000..80015b6a257dc --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/strings.md @@ -0,0 +1,19 @@ +# Comparison: Strings + +## String literals + +```py +def _(x: str): + reveal_type("abc" == "abc") # revealed: Literal[True] + reveal_type("ab_cd" <= "ab_ce") # revealed: Literal[True] + reveal_type("abc" in "ab cd") # revealed: Literal[False] + reveal_type("" not in "hello") # revealed: Literal[False] + reveal_type("--" is "--") # revealed: bool + reveal_type("A" is "B") # revealed: Literal[False] + reveal_type("--" is not "--") # revealed: bool + reveal_type("A" is not "B") # revealed: Literal[True] + reveal_type(x < "...") # revealed: bool + + # ensure we're not comparing the interned salsa symbols, which compare by order of declaration. + reveal_type("ab" < "ab_cd") # revealed: Literal[True] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/tuples.md b/crates/ty_python_semantic/resources/mdtest/comparison/tuples.md new file mode 100644 index 0000000000000..03169ef851621 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/tuples.md @@ -0,0 +1,394 @@ +# Comparison: Tuples + +## Heterogeneous + +For tuples like `tuple[int, str, Literal[1]]` + +### Value Comparisons + +"Value Comparisons" refers to the operators: `==`, `!=`, `<`, `<=`, `>`, `>=` + +#### Results without Ambiguity + +Cases where the result can be definitively inferred as a `BooleanLiteral`. + +```py +a = (1, "test", (3, 13), True) +b = (1, "test", (3, 14), False) + +reveal_type(a == a) # revealed: Literal[True] +reveal_type(a != a) # revealed: Literal[False] +reveal_type(a < a) # revealed: Literal[False] +reveal_type(a <= a) # revealed: Literal[True] +reveal_type(a > a) # revealed: Literal[False] +reveal_type(a >= a) # revealed: Literal[True] + +reveal_type(a == b) # revealed: Literal[False] +reveal_type(a != b) # revealed: Literal[True] +reveal_type(a < b) # revealed: Literal[True] +reveal_type(a <= b) # revealed: Literal[True] +reveal_type(a > b) # revealed: Literal[False] +reveal_type(a >= b) # revealed: Literal[False] +``` + +Even when tuples have different lengths, comparisons should be handled appropriately. + +```py +a = (1, 2, 3) +b = (1, 2, 3, 4) + +reveal_type(a == b) # revealed: Literal[False] +reveal_type(a != b) # revealed: Literal[True] +reveal_type(a < b) # revealed: Literal[True] +reveal_type(a <= b) # revealed: Literal[True] +reveal_type(a > b) # revealed: Literal[False] +reveal_type(a >= b) # revealed: Literal[False] + +c = ("a", "b", "c", "d") +d = ("a", "b", "c") + +reveal_type(c == d) # revealed: Literal[False] +reveal_type(c != d) # revealed: Literal[True] +reveal_type(c < d) # revealed: Literal[False] +reveal_type(c <= d) # revealed: Literal[False] +reveal_type(c > d) # revealed: Literal[True] +reveal_type(c >= d) # revealed: Literal[True] +``` + +#### Results with Ambiguity + +```py +def _(x: bool, y: int): + a = (x,) + b = (y,) + + reveal_type(a == a) # revealed: bool + reveal_type(a != a) # revealed: bool + reveal_type(a < a) # revealed: bool + reveal_type(a <= a) # revealed: bool + reveal_type(a > a) # revealed: bool + reveal_type(a >= a) # revealed: bool + + reveal_type(a == b) # revealed: bool + reveal_type(a != b) # revealed: bool + reveal_type(a < b) # revealed: bool + reveal_type(a <= b) # revealed: bool + reveal_type(a > b) # revealed: bool + reveal_type(a >= b) # revealed: bool +``` + +#### Comparison Unsupported + +If two tuples contain types that do not support comparison, the result may be `Unknown`. However, +`==` and `!=` are exceptions and can still provide definite results. + +```py +a = (1, 2) +b = (1, "hello") + +# TODO: should be Literal[False], once we implement (in)equality for mismatched literals +reveal_type(a == b) # revealed: bool + +# TODO: should be Literal[True], once we implement (in)equality for mismatched literals +reveal_type(a != b) # revealed: bool + +# error: [unsupported-operator] "Operator `<` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]`" +reveal_type(a < b) # revealed: Unknown +# error: [unsupported-operator] "Operator `<=` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]`" +reveal_type(a <= b) # revealed: Unknown +# error: [unsupported-operator] "Operator `>` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]`" +reveal_type(a > b) # revealed: Unknown +# error: [unsupported-operator] "Operator `>=` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]`" +reveal_type(a >= b) # revealed: Unknown +``` + +However, if the lexicographic comparison completes without reaching a point where str and int are +compared, Python will still produce a result based on the prior elements. + +```py +a = (1, 2) +b = (999999, "hello") + +reveal_type(a == b) # revealed: Literal[False] +reveal_type(a != b) # revealed: Literal[True] +reveal_type(a < b) # revealed: Literal[True] +reveal_type(a <= b) # revealed: Literal[True] +reveal_type(a > b) # revealed: Literal[False] +reveal_type(a >= b) # revealed: Literal[False] +``` + +#### Matryoshka Tuples + +```py +a = (1, True, "Hello") +b = (a, a, a) +c = (b, b, b) + +reveal_type(c == c) # revealed: Literal[True] +reveal_type(c != c) # revealed: Literal[False] +reveal_type(c < c) # revealed: Literal[False] +reveal_type(c <= c) # revealed: Literal[True] +reveal_type(c > c) # revealed: Literal[False] +reveal_type(c >= c) # revealed: Literal[True] +``` + +#### Non Boolean Rich Comparisons + +Rich comparison methods defined in a class affect tuple comparisons as well. Proper type inference +should be possible even in cases where these methods return non-boolean types. + +Note: Tuples use lexicographic comparisons. If the `==` result for all paired elements in the tuple +is True, the comparison then considers the tuple’s length. Regardless of the return type of the +dunder methods, the final result can still be a boolean value. + +(+cpython: For tuples, `==` and `!=` always produce boolean results, regardless of the return type +of the dunder methods.) + +```py +from __future__ import annotations + +class EqReturnType: ... +class NeReturnType: ... +class LtReturnType: ... +class LeReturnType: ... +class GtReturnType: ... +class GeReturnType: ... + +class A: + def __eq__(self, o: object) -> EqReturnType: + return EqReturnType() + + def __ne__(self, o: object) -> NeReturnType: + return NeReturnType() + + def __lt__(self, o: A) -> LtReturnType: + return LtReturnType() + + def __le__(self, o: A) -> LeReturnType: + return LeReturnType() + + def __gt__(self, o: A) -> GtReturnType: + return GtReturnType() + + def __ge__(self, o: A) -> GeReturnType: + return GeReturnType() + +a = (A(), A()) + +reveal_type(a == a) # revealed: bool +reveal_type(a != a) # revealed: bool +reveal_type(a < a) # revealed: LtReturnType | Literal[False] +reveal_type(a <= a) # revealed: LeReturnType | Literal[True] +reveal_type(a > a) # revealed: GtReturnType | Literal[False] +reveal_type(a >= a) # revealed: GeReturnType | Literal[True] + +# If lexicographic comparison is finished before comparing A() +b = ("1_foo", A()) +c = ("2_bar", A()) + +reveal_type(b == c) # revealed: Literal[False] +reveal_type(b != c) # revealed: Literal[True] +reveal_type(b < c) # revealed: Literal[True] +reveal_type(b <= c) # revealed: Literal[True] +reveal_type(b > c) # revealed: Literal[False] +reveal_type(b >= c) # revealed: Literal[False] + +class LtReturnTypeOnB: ... + +class B: + def __lt__(self, o: B) -> LtReturnTypeOnB: + return LtReturnTypeOnB() + +reveal_type((A(), B()) < (A(), B())) # revealed: LtReturnType | LtReturnTypeOnB | Literal[False] +``` + +#### Special Handling of Eq and NotEq in Lexicographic Comparisons + +> Example: `(<int instance>, "foo") == (<int instance>, "bar")` + +`Eq` and `NotEq` have unique behavior compared to other operators in lexicographic comparisons. +Specifically, for `Eq`, if any non-equal pair exists within the tuples being compared, we can +immediately conclude that the tuples are not equal. Conversely, for `NotEq`, if any non-equal pair +exists, we can determine that the tuples are unequal. + +In contrast, with operators like `<` and `>`, the comparison must consider each pair of elements +sequentially, and the final outcome might remain ambiguous until all pairs are compared. + +```py +def _(x: str, y: int): + reveal_type("foo" == "bar") # revealed: Literal[False] + reveal_type(("foo",) == ("bar",)) # revealed: Literal[False] + reveal_type((4, "foo") == (4, "bar")) # revealed: Literal[False] + reveal_type((y, "foo") == (y, "bar")) # revealed: Literal[False] + + a = (x, y, "foo") + + reveal_type(a == a) # revealed: bool + reveal_type(a != a) # revealed: bool + reveal_type(a < a) # revealed: bool + reveal_type(a <= a) # revealed: bool + reveal_type(a > a) # revealed: bool + reveal_type(a >= a) # revealed: bool + + b = (x, y, "bar") + + reveal_type(a == b) # revealed: Literal[False] + reveal_type(a != b) # revealed: Literal[True] + reveal_type(a < b) # revealed: bool + reveal_type(a <= b) # revealed: bool + reveal_type(a > b) # revealed: bool + reveal_type(a >= b) # revealed: bool + + c = (x, y, "foo", "different_length") + + reveal_type(a == c) # revealed: Literal[False] + reveal_type(a != c) # revealed: Literal[True] + reveal_type(a < c) # revealed: bool + reveal_type(a <= c) # revealed: bool + reveal_type(a > c) # revealed: bool + reveal_type(a >= c) # revealed: bool +``` + +#### Error Propagation + +Errors occurring within a tuple comparison should propagate outward. However, if the tuple +comparison can clearly conclude before encountering an error, the error should not be raised. + +```py +def _(n: int, s: str): + class A: ... + # error: [unsupported-operator] "Operator `<` is not supported for types `A` and `A`" + A() < A() + # error: [unsupported-operator] "Operator `<=` is not supported for types `A` and `A`" + A() <= A() + # error: [unsupported-operator] "Operator `>` is not supported for types `A` and `A`" + A() > A() + # error: [unsupported-operator] "Operator `>=` is not supported for types `A` and `A`" + A() >= A() + + a = (0, n, A()) + + # error: [unsupported-operator] "Operator `<` is not supported for types `A` and `A`, in comparing `tuple[Literal[0], int, A]` with `tuple[Literal[0], int, A]`" + reveal_type(a < a) # revealed: Unknown + # error: [unsupported-operator] "Operator `<=` is not supported for types `A` and `A`, in comparing `tuple[Literal[0], int, A]` with `tuple[Literal[0], int, A]`" + reveal_type(a <= a) # revealed: Unknown + # error: [unsupported-operator] "Operator `>` is not supported for types `A` and `A`, in comparing `tuple[Literal[0], int, A]` with `tuple[Literal[0], int, A]`" + reveal_type(a > a) # revealed: Unknown + # error: [unsupported-operator] "Operator `>=` is not supported for types `A` and `A`, in comparing `tuple[Literal[0], int, A]` with `tuple[Literal[0], int, A]`" + reveal_type(a >= a) # revealed: Unknown + + # Comparison between `a` and `b` should only involve the first elements, `Literal[0]` and `Literal[99999]`, + # and should terminate immediately. + b = (99999, n, A()) + + reveal_type(a < b) # revealed: Literal[True] + reveal_type(a <= b) # revealed: Literal[True] + reveal_type(a > b) # revealed: Literal[False] + reveal_type(a >= b) # revealed: Literal[False] +``` + +### Membership Test Comparisons + +"Membership Test Comparisons" refers to the operators `in` and `not in`. + +```py +def _(n: int): + a = (1, 2) + b = ((3, 4), (1, 2)) + c = ((1, 2, 3), (4, 5, 6)) + d = ((n, n), (n, n)) + + reveal_type(a in b) # revealed: Literal[True] + reveal_type(a not in b) # revealed: Literal[False] + + reveal_type(a in c) # revealed: Literal[False] + reveal_type(a not in c) # revealed: Literal[True] + + reveal_type(a in d) # revealed: bool + reveal_type(a not in d) # revealed: bool +``` + +### Identity Comparisons + +"Identity Comparisons" refers to `is` and `is not`. + +```py +a = (1, 2) +b = ("a", "b") +c = (1, 2, 3) + +reveal_type(a is (1, 2)) # revealed: bool +reveal_type(a is not (1, 2)) # revealed: bool + +# TODO should be Literal[False] once we implement comparison of mismatched literal types +reveal_type(a is b) # revealed: bool +# TODO should be Literal[True] once we implement comparison of mismatched literal types +reveal_type(a is not b) # revealed: bool + +reveal_type(a is c) # revealed: Literal[False] +reveal_type(a is not c) # revealed: Literal[True] +``` + +## Homogeneous + +For tuples like `tuple[int, ...]`, `tuple[Any, ...]` + +// TODO + +## Chained comparisons with elements that incorrectly implement `__bool__` + +<!-- snapshot-diagnostics --> + +For an operation `A() < A()` to succeed at runtime, the `A.__lt__` method does not necessarily need +to return an object that is convertible to a `bool`. However, the return type _does_ need to be +convertible to a `bool` for the operation `A() < A() < A()` (a _chained_ comparison) to succeed. +This is because `A() < A() < A()` desugars to something like this, which involves several implicit +conversions to `bool`: + +```ignore +def compute_chained_comparison(): + a1 = A() + a2 = A() + first_comparison = a1 < a2 + return first_comparison and (a2 < A()) +``` + +```py +class NotBoolable: + __bool__: int = 5 + +class Comparable: + def __lt__(self, other) -> NotBoolable: + return NotBoolable() + + def __gt__(self, other) -> NotBoolable: + return NotBoolable() + +a = (1, Comparable()) +b = (1, Comparable()) + +# error: [unsupported-bool-conversion] +a < b < b + +a < b # fine +``` + +## Equality with elements that incorrectly implement `__bool__` + +<!-- snapshot-diagnostics --> + +Python does not generally attempt to coerce the result of `==` and `!=` operations between two +arbitrary objects to a `bool`, but a comparison of tuples will fail if the result of comparing any +pair of elements at equivalent positions cannot be converted to a `bool`: + +```py +class NotBoolable: + __bool__: None = None + +class A: + def __eq__(self, other) -> NotBoolable: + return NotBoolable() + +# error: [unsupported-bool-conversion] +(A(),) == (A(),) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/unions.md b/crates/ty_python_semantic/resources/mdtest/comparison/unions.md new file mode 100644 index 0000000000000..56924ecc7fad0 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/unions.md @@ -0,0 +1,79 @@ +# Comparison: Unions + +## Union on one side of the comparison + +Comparisons on union types need to consider all possible cases: + +```py +def _(flag: bool): + one_or_two = 1 if flag else 2 + + reveal_type(one_or_two <= 2) # revealed: Literal[True] + reveal_type(one_or_two <= 1) # revealed: bool + reveal_type(one_or_two <= 0) # revealed: Literal[False] + + reveal_type(2 >= one_or_two) # revealed: Literal[True] + reveal_type(1 >= one_or_two) # revealed: bool + reveal_type(0 >= one_or_two) # revealed: Literal[False] + + reveal_type(one_or_two < 1) # revealed: Literal[False] + reveal_type(one_or_two < 2) # revealed: bool + reveal_type(one_or_two < 3) # revealed: Literal[True] + + reveal_type(one_or_two > 0) # revealed: Literal[True] + reveal_type(one_or_two > 1) # revealed: bool + reveal_type(one_or_two > 2) # revealed: Literal[False] + + reveal_type(one_or_two == 3) # revealed: Literal[False] + reveal_type(one_or_two == 1) # revealed: bool + + reveal_type(one_or_two != 3) # revealed: Literal[True] + reveal_type(one_or_two != 1) # revealed: bool + + a_or_ab = "a" if flag else "ab" + + reveal_type(a_or_ab in "ab") # revealed: Literal[True] + reveal_type("a" in a_or_ab) # revealed: Literal[True] + + reveal_type("c" not in a_or_ab) # revealed: Literal[True] + reveal_type("a" not in a_or_ab) # revealed: Literal[False] + + reveal_type("b" in a_or_ab) # revealed: bool + reveal_type("b" not in a_or_ab) # revealed: bool + + one_or_none = 1 if flag else None + + reveal_type(one_or_none is None) # revealed: bool + reveal_type(one_or_none is not None) # revealed: bool +``` + +## Union on both sides of the comparison + +With unions on both sides, we need to consider the full cross product of options when building the +resulting (union) type: + +```py +def _(flag_s: bool, flag_l: bool): + small = 1 if flag_s else 2 + large = 2 if flag_l else 3 + + reveal_type(small <= large) # revealed: Literal[True] + reveal_type(small >= large) # revealed: bool + + reveal_type(small < large) # revealed: bool + reveal_type(small > large) # revealed: Literal[False] +``` + +## Unsupported operations + +Make sure we emit a diagnostic if *any* of the possible comparisons is unsupported. For now, we fall +back to `bool` for the result type instead of trying to infer something more precise from the other +(supported) variants: + +```py +def _(flag: bool): + x = [1, 2] if flag else 1 + + result = 1 in x # error: "Operator `in` is not supported" + reveal_type(result) # revealed: bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comparison/unsupported.md b/crates/ty_python_semantic/resources/mdtest/comparison/unsupported.md new file mode 100644 index 0000000000000..f3e57c886d103 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comparison/unsupported.md @@ -0,0 +1,32 @@ +# Comparison: Unsupported operators + +```py +def _(flag: bool, flag1: bool, flag2: bool): + class A: ... + a = 1 in 7 # error: "Operator `in` is not supported for types `Literal[1]` and `Literal[7]`" + reveal_type(a) # revealed: bool + + b = 0 not in 10 # error: "Operator `not in` is not supported for types `Literal[0]` and `Literal[10]`" + reveal_type(b) # revealed: bool + + # error: [unsupported-operator] "Operator `<` is not supported for types `object` and `int`, in comparing `object` with `Literal[5]`" + c = object() < 5 + reveal_type(c) # revealed: Unknown + + # error: [unsupported-operator] "Operator `<` is not supported for types `int` and `object`, in comparing `Literal[5]` with `object`" + d = 5 < object() + reveal_type(d) # revealed: Unknown + + int_literal_or_str_literal = 1 if flag else "foo" + # error: "Operator `in` is not supported for types `Literal[42]` and `Literal[1]`, in comparing `Literal[42]` with `Literal[1, "foo"]`" + e = 42 in int_literal_or_str_literal + reveal_type(e) # revealed: bool + + # error: [unsupported-operator] "Operator `<` is not supported for types `int` and `str`, in comparing `tuple[Literal[1], Literal[2]]` with `tuple[Literal[1], Literal["hello"]]`" + f = (1, 2) < (1, "hello") + reveal_type(f) # revealed: Unknown + + # error: [unsupported-operator] "Operator `<` is not supported for types `A` and `A`, in comparing `tuple[bool, A]` with `tuple[bool, A]`" + g = (flag1, A()) < (flag2, A()) + reveal_type(g) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comprehensions/basic.md b/crates/ty_python_semantic/resources/mdtest/comprehensions/basic.md new file mode 100644 index 0000000000000..a32244c09abb4 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comprehensions/basic.md @@ -0,0 +1,152 @@ +# Comprehensions + +## Basic comprehensions + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +# revealed: int +[reveal_type(x) for x in IntIterable()] + +class IteratorOfIterables: + def __next__(self) -> IntIterable: + return IntIterable() + +class IterableOfIterables: + def __iter__(self) -> IteratorOfIterables: + return IteratorOfIterables() + +# revealed: tuple[int, IntIterable] +[reveal_type((x, y)) for y in IterableOfIterables() for x in y] + +# revealed: int +{reveal_type(x): 0 for x in IntIterable()} + +# revealed: int +{0: reveal_type(x) for x in IntIterable()} +``` + +## Nested comprehension + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +# revealed: tuple[int, int] +[[reveal_type((x, y)) for x in IntIterable()] for y in IntIterable()] +``` + +## Comprehension referencing outer comprehension + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +class IteratorOfIterables: + def __next__(self) -> IntIterable: + return IntIterable() + +class IterableOfIterables: + def __iter__(self) -> IteratorOfIterables: + return IteratorOfIterables() + +# revealed: tuple[int, IntIterable] +[[reveal_type((x, y)) for x in y] for y in IterableOfIterables()] +``` + +## Comprehension with unbound iterable + +Iterating over an unbound iterable yields `Unknown`: + +```py +# error: [unresolved-reference] "Name `x` used when not defined" +# revealed: Unknown +[reveal_type(z) for z in x] + +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +# error: [not-iterable] "Object of type `int` is not iterable" +# revealed: tuple[int, Unknown] +[reveal_type((x, z)) for x in IntIterable() for z in x] +``` + +## Starred expressions + +Starred expressions must be iterable + +```py +class NotIterable: ... + +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +# This is fine: +x = [*Iterable()] + +# error: [not-iterable] "Object of type `NotIterable` is not iterable" +y = [*NotIterable()] +``` + +## Async comprehensions + +### Basic + +```py +class AsyncIterator: + async def __anext__(self) -> int: + return 42 + +class AsyncIterable: + def __aiter__(self) -> AsyncIterator: + return AsyncIterator() + +async def _(): + # revealed: @Todo(async iterables/iterators) + [reveal_type(x) async for x in AsyncIterable()] +``` + +### Invalid async comprehension + +This tests that we understand that `async` comprehensions do *not* work according to the synchronous +iteration protocol + +```py +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +async def _(): + # revealed: @Todo(async iterables/iterators) + [reveal_type(x) async for x in Iterable()] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/comprehensions/invalid_syntax.md b/crates/ty_python_semantic/resources/mdtest/comprehensions/invalid_syntax.md new file mode 100644 index 0000000000000..20c71be1718db --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/comprehensions/invalid_syntax.md @@ -0,0 +1,43 @@ +# Comprehensions with invalid syntax + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +# Missing 'in' keyword. + +# It's reasonably clear here what they *meant* to write, +# so we'll still infer the correct type: + +# error: [invalid-syntax] "Expected 'in', found name" +# revealed: int +[reveal_type(a) for a IntIterable()] + + +# Missing iteration variable + +# error: [invalid-syntax] "Expected an identifier, but found a keyword 'in' that cannot be used here" +# error: [invalid-syntax] "Expected 'in', found name" +# error: [unresolved-reference] +# revealed: Unknown +[reveal_type(b) for in IntIterable()] + + +# Missing iterable + +# error: [invalid-syntax] "Expected an expression" +# revealed: Unknown +[reveal_type(c) for c in] + + +# Missing 'in' keyword and missing iterable + +# error: [invalid-syntax] "Expected 'in', found ']'" +# revealed: Unknown +[reveal_type(d) for d] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/conditional/if_expression.md b/crates/ty_python_semantic/resources/mdtest/conditional/if_expression.md new file mode 100644 index 0000000000000..48b912cce13f9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/conditional/if_expression.md @@ -0,0 +1,47 @@ +# If expressions + +## Simple if-expression + +```py +def _(flag: bool): + x = 1 if flag else 2 + reveal_type(x) # revealed: Literal[1, 2] +``` + +## If-expression with walrus operator + +```py +def _(flag: bool): + y = 0 + z = 0 + x = (y := 1) if flag else (z := 2) + reveal_type(x) # revealed: Literal[1, 2] + reveal_type(y) # revealed: Literal[0, 1] + reveal_type(z) # revealed: Literal[0, 2] +``` + +## Nested if-expression + +```py +def _(flag: bool, flag2: bool): + x = 1 if flag else 2 if flag2 else 3 + reveal_type(x) # revealed: Literal[1, 2, 3] +``` + +## None + +```py +def _(flag: bool): + x = 1 if flag else None + reveal_type(x) # revealed: Literal[1] | None +``` + +## Condition with object that implements `__bool__` incorrectly + +```py +class NotBoolable: + __bool__: int = 3 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +3 if NotBoolable() else 4 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/conditional/if_statement.md b/crates/ty_python_semantic/resources/mdtest/conditional/if_statement.md new file mode 100644 index 0000000000000..c7a8c7732b4dd --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/conditional/if_statement.md @@ -0,0 +1,163 @@ +# If statements + +## Simple if + +```py +def _(flag: bool): + y = 1 + y = 2 + + if flag: + y = 3 + + reveal_type(y) # revealed: Literal[2, 3] +``` + +## Simple if-elif-else + +```py +def _(flag: bool, flag2: bool): + y = 1 + y = 2 + + if flag: + y = 3 + elif flag2: + y = 4 + else: + r = y + y = 5 + s = y + x = y + + reveal_type(x) # revealed: Literal[3, 4, 5] + + # revealed: Literal[2] + # error: [possibly-unresolved-reference] + reveal_type(r) + + # revealed: Literal[5] + # error: [possibly-unresolved-reference] + reveal_type(s) +``` + +## Single symbol across if-elif-else + +```py +def _(flag: bool, flag2: bool): + if flag: + y = 1 + elif flag2: + y = 2 + else: + y = 3 + + reveal_type(y) # revealed: Literal[1, 2, 3] +``` + +## if-elif-else without else assignment + +```py +def _(flag: bool, flag2: bool): + y = 0 + + if flag: + y = 1 + elif flag2: + y = 2 + else: + pass + + reveal_type(y) # revealed: Literal[0, 1, 2] +``` + +## if-elif-else with intervening assignment + +```py +def _(flag: bool, flag2: bool): + y = 0 + + if flag: + y = 1 + z = 3 + elif flag2: + y = 2 + else: + pass + + reveal_type(y) # revealed: Literal[0, 1, 2] +``` + +## Nested if statement + +```py +def _(flag: bool, flag2: bool): + y = 0 + + if flag: + if flag2: + y = 1 + + reveal_type(y) # revealed: Literal[0, 1] +``` + +## if-elif without else + +```py +def _(flag: bool, flag2: bool): + y = 1 + y = 2 + + if flag: + y = 3 + elif flag2: + y = 4 + + reveal_type(y) # revealed: Literal[2, 3, 4] +``` + +## if-elif with assignment expressions in tests + +```py +def check(x: int) -> bool: + return bool(x) + +if check(x := 1): + x = 2 +elif check(x := 3): + x = 4 + +reveal_type(x) # revealed: Literal[2, 3, 4] +``` + +## constraints apply to later test expressions + +```py +def check(x) -> bool: + return bool(x) + +def _(flag: bool): + x = 1 if flag else None + y = 0 + + if x is None: + pass + elif check(y := x): + pass + + reveal_type(y) # revealed: Literal[0, 1] +``` + +## Condition with object that implements `__bool__` incorrectly + +```py +class NotBoolable: + __bool__: int = 3 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +if NotBoolable(): + ... +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +elif NotBoolable(): + ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/conditional/match.md b/crates/ty_python_semantic/resources/mdtest/conditional/match.md new file mode 100644 index 0000000000000..4947de76b9f9d --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/conditional/match.md @@ -0,0 +1,302 @@ +# Pattern matching + +```toml +[environment] +python-version = "3.10" +``` + +## With wildcard + +```py +def _(target: int): + match target: + case 1: + y = 2 + case _: + y = 3 + + reveal_type(y) # revealed: Literal[2, 3] +``` + +## Without wildcard + +```py +def _(target: int): + match target: + case 1: + y = 2 + case 2: + y = 3 + + # revealed: Literal[2, 3] + # error: [possibly-unresolved-reference] + reveal_type(y) +``` + +## Basic match + +```py +def _(target: int): + y = 1 + y = 2 + + match target: + case 1: + y = 3 + case 2: + y = 4 + + reveal_type(y) # revealed: Literal[2, 3, 4] +``` + +## Value match + +A value pattern matches based on equality: the first `case` branch here will be taken if `subject` +is equal to `2`, even if `subject` is not an instance of `int`. We can't know whether `C` here has a +custom `__eq__` implementation that might cause it to compare equal to `2`, so we have to consider +the possibility that the `case` branch might be taken even though the type `C` is disjoint from the +type `Literal[2]`. + +This leads us to infer `Literal[1, 3]` as the type of `y` after the `match` statement, rather than +`Literal[1]`: + +```py +from typing import final + +@final +class C: + pass + +def _(subject: C): + y = 1 + match subject: + case 2: + y = 3 + reveal_type(y) # revealed: Literal[1, 3] +``` + +## Class match + +A `case` branch with a class pattern is taken if the subject is an instance of the given class, and +all subpatterns in the class pattern match. + +```py +from typing import final + +class Foo: + pass + +class FooSub(Foo): + pass + +class Bar: + pass + +@final +class Baz: + pass + +def _(target: FooSub): + y = 1 + + match target: + case Baz(): + y = 2 + case Foo(): + y = 3 + case Bar(): + y = 4 + + reveal_type(y) # revealed: Literal[3] + +def _(target: FooSub): + y = 1 + + match target: + case Baz(): + y = 2 + case Bar(): + y = 3 + case Foo(): + y = 4 + + reveal_type(y) # revealed: Literal[3, 4] + +def _(target: FooSub | str): + y = 1 + + match target: + case Baz(): + y = 2 + case Foo(): + y = 3 + case Bar(): + y = 4 + + reveal_type(y) # revealed: Literal[1, 3, 4] +``` + +## Singleton match + +Singleton patterns are matched based on identity, not equality comparisons or `isinstance()` checks. + +```py +from typing import Literal + +def _(target: Literal[True, False]): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + # TODO: with exhaustiveness checking, this should be Literal[2, 3] + reveal_type(y) # revealed: Literal[1, 2, 3] + +def _(target: bool): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + # TODO: with exhaustiveness checking, this should be Literal[2, 3] + reveal_type(y) # revealed: Literal[1, 2, 3] + +def _(target: None): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + reveal_type(y) # revealed: Literal[4] + +def _(target: None | Literal[True]): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + # TODO: with exhaustiveness checking, this should be Literal[2, 4] + reveal_type(y) # revealed: Literal[1, 2, 4] + +# bool is an int subclass +def _(target: int): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + reveal_type(y) # revealed: Literal[1, 2, 3] + +def _(target: str): + y = 1 + + match target: + case True: + y = 2 + case False: + y = 3 + case None: + y = 4 + + reveal_type(y) # revealed: Literal[1] +``` + +## Or match + +A `|` pattern matches if any of the subpatterns match. + +```py +from typing import Literal, final + +def _(target: Literal["foo", "baz"]): + y = 1 + + match target: + case "foo" | "bar": + y = 2 + case "baz": + y = 3 + + # TODO: with exhaustiveness, this should be Literal[2, 3] + reveal_type(y) # revealed: Literal[1, 2, 3] + +def _(target: None): + y = 1 + + match target: + case None | 3: + y = 2 + case "foo" | 4 | True: + y = 3 + + reveal_type(y) # revealed: Literal[2] + +@final +class Baz: + pass + +def _(target: int | None | float): + y = 1 + + match target: + case None | 3: + y = 2 + case Baz(): + y = 3 + + reveal_type(y) # revealed: Literal[1, 2] + +def _(target: None | str): + y = 1 + + match target: + case Baz() | True | False: + y = 2 + case int(): + y = 3 + + reveal_type(y) # revealed: Literal[1, 3] +``` + +## Guard with object that implements `__bool__` incorrectly + +```py +class NotBoolable: + __bool__: int = 3 + +def _(target: int, flag: NotBoolable): + y = 1 + match target: + # error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" + case 1 if flag: + y = 2 + case 2: + y = 3 + + reveal_type(y) # revealed: Literal[1, 2, 3] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/cycle.md b/crates/ty_python_semantic/resources/mdtest/cycle.md new file mode 100644 index 0000000000000..0bd3b5b2a6df4 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/cycle.md @@ -0,0 +1,33 @@ +# Cycles + +## Function signature + +Deferred annotations can result in cycles in resolving a function signature: + +```py +from __future__ import annotations + +# error: [invalid-type-form] +def f(x: f): + pass + +reveal_type(f) # revealed: def f(x: Unknown) -> Unknown +``` + +## Unpacking + +See: <https://github.com/astral-sh/ty/issues/364> + +```py +class Point: + def __init__(self, x: int = 0, y: int = 0) -> None: + self.x = x + self.y = y + + def replace_with(self, other: "Point") -> None: + self.x, self.y = other.x, other.y + +p = Point() +reveal_type(p.x) # revealed: Unknown | int +reveal_type(p.y) # revealed: Unknown | int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/dataclass_transform.md b/crates/ty_python_semantic/resources/mdtest/dataclass_transform.md new file mode 100644 index 0000000000000..879557ad3c6dc --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/dataclass_transform.md @@ -0,0 +1,291 @@ +# `typing.dataclass_transform` + +```toml +[environment] +python-version = "3.12" +``` + +`dataclass_transform` is a decorator that can be used to let type checkers know that a function, +class, or metaclass is a `dataclass`-like construct. + +## Basic example + +```py +from typing_extensions import dataclass_transform + +@dataclass_transform() +def my_dataclass[T](cls: type[T]) -> type[T]: + # modify cls + return cls + +@my_dataclass +class Person: + name: str + age: int | None = None + +Person("Alice", 20) +Person("Bob", None) +Person("Bob") + +# error: [missing-argument] +Person() +``` + +## Decorating decorators that take parameters themselves + +If we want our `dataclass`-like decorator to also take parameters, that is also possible: + +```py +from typing_extensions import dataclass_transform, Callable + +@dataclass_transform() +def versioned_class[T](*, version: int = 1): + def decorator(cls): + # modify cls + return cls + return decorator + +@versioned_class(version=2) +class Person: + name: str + age: int | None = None + +Person("Alice", 20) + +# error: [missing-argument] +Person() +``` + +We properly type-check the arguments to the decorator: + +```py +from typing_extensions import dataclass_transform, Callable + +# error: [invalid-argument-type] +@versioned_class(version="a string") +class C: + name: str +``` + +## Types of decorators + +The examples from this section are straight from the Python documentation on +[`typing.dataclass_transform`]. + +### Decorating a decorator function + +```py +from typing_extensions import dataclass_transform + +@dataclass_transform() +def create_model[T](cls: type[T]) -> type[T]: + ... + return cls + +@create_model +class CustomerModel: + id: int + name: str + +CustomerModel(id=1, name="Test") +``` + +### Decorating a metaclass + +```py +from typing_extensions import dataclass_transform + +@dataclass_transform() +class ModelMeta(type): ... + +class ModelBase(metaclass=ModelMeta): ... + +class CustomerModel(ModelBase): + id: int + name: str + +CustomerModel(id=1, name="Test") + +# error: [missing-argument] +CustomerModel() +``` + +### Decorating a base class + +```py +from typing_extensions import dataclass_transform + +@dataclass_transform() +class ModelBase: ... + +class CustomerModel(ModelBase): + id: int + name: str + +# TODO: this is not supported yet +# error: [unknown-argument] +# error: [unknown-argument] +CustomerModel(id=1, name="Test") +``` + +## Arguments to `dataclass_transform` + +### `eq_default` + +`eq=True/False` does not have a observable effect (apart from a minor change regarding whether +`other` is positional-only or not, which is not modelled at the moment). + +### `order_default` + +The `order_default` argument controls whether methods such as `__lt__` are generated by default. +This can be overwritten using the `order` argument to the custom decorator: + +```py +from typing_extensions import dataclass_transform + +@dataclass_transform() +def normal(*, order: bool = False): + raise NotImplementedError + +@dataclass_transform(order_default=False) +def order_default_false(*, order: bool = False): + raise NotImplementedError + +@dataclass_transform(order_default=True) +def order_default_true(*, order: bool = True): + raise NotImplementedError + +@normal +class Normal: + inner: int + +Normal(1) < Normal(2) # error: [unsupported-operator] + +@normal(order=True) +class NormalOverwritten: + inner: int + +NormalOverwritten(1) < NormalOverwritten(2) + +@order_default_false +class OrderFalse: + inner: int + +OrderFalse(1) < OrderFalse(2) # error: [unsupported-operator] + +@order_default_false(order=True) +class OrderFalseOverwritten: + inner: int + +OrderFalseOverwritten(1) < OrderFalseOverwritten(2) + +@order_default_true +class OrderTrue: + inner: int + +OrderTrue(1) < OrderTrue(2) + +@order_default_true(order=False) +class OrderTrueOverwritten: + inner: int + +# error: [unsupported-operator] +OrderTrueOverwritten(1) < OrderTrueOverwritten(2) +``` + +### `kw_only_default` + +To do + +### `field_specifiers` + +To do + +## Overloaded dataclass-like decorators + +In the case of an overloaded decorator, the `dataclass_transform` decorator can be applied to the +implementation, or to *one* of the overloads. + +### Applying `dataclass_transform` to the implementation + +```py +from typing_extensions import dataclass_transform, TypeVar, Callable, overload + +T = TypeVar("T", bound=type) + +@overload +def versioned_class( + cls: T, + *, + version: int = 1, +) -> T: ... +@overload +def versioned_class( + *, + version: int = 1, +) -> Callable[[T], T]: ... +@dataclass_transform() +def versioned_class( + cls: T | None = None, + *, + version: int = 1, +) -> T | Callable[[T], T]: + raise NotImplementedError + +@versioned_class +class D1: + x: str + +@versioned_class(version=2) +class D2: + x: str + +D1("a") +D2("a") + +D1(1.2) # error: [invalid-argument-type] +D2(1.2) # error: [invalid-argument-type] +``` + +### Applying `dataclass_transform` to an overload + +```py +from typing_extensions import dataclass_transform, TypeVar, Callable, overload + +T = TypeVar("T", bound=type) + +@overload +@dataclass_transform() +def versioned_class( + cls: T, + *, + version: int = 1, +) -> T: ... +@overload +def versioned_class( + *, + version: int = 1, +) -> Callable[[T], T]: ... +def versioned_class( + cls: T | None = None, + *, + version: int = 1, +) -> T | Callable[[T], T]: + raise NotImplementedError + +@versioned_class +class D1: + x: str + +@versioned_class(version=2) +class D2: + x: str + +D1("a") +D2("a") + +D1(1.2) # error: [invalid-argument-type] +D2(1.2) # error: [invalid-argument-type] +``` + +[`typing.dataclass_transform`]: https://docs.python.org/3/library/typing.html#typing.dataclass_transform diff --git a/crates/ty_python_semantic/resources/mdtest/dataclasses.md b/crates/ty_python_semantic/resources/mdtest/dataclasses.md new file mode 100644 index 0000000000000..fcbe3f6c1b120 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/dataclasses.md @@ -0,0 +1,830 @@ +# Dataclasses + +## Basic + +Decorating a class with `@dataclass` is a convenient way to add special methods such as `__init__`, +`__repr__`, and `__eq__` to a class. The following example shows the basic usage of the `@dataclass` +decorator. By default, only the three mentioned methods are generated. + +```py +from dataclasses import dataclass + +@dataclass +class Person: + name: str + age: int | None = None + +alice1 = Person("Alice", 30) +alice2 = Person(name="Alice", age=30) +alice3 = Person(age=30, name="Alice") +alice4 = Person("Alice", age=30) + +reveal_type(alice1) # revealed: Person +reveal_type(type(alice1)) # revealed: type[Person] + +reveal_type(alice1.name) # revealed: str +reveal_type(alice1.age) # revealed: int | None + +reveal_type(repr(alice1)) # revealed: str + +reveal_type(alice1 == alice2) # revealed: bool +reveal_type(alice1 == "Alice") # revealed: bool + +bob = Person("Bob") +bob2 = Person("Bob", None) +bob3 = Person(name="Bob") +bob4 = Person(name="Bob", age=None) +``` + +The signature of the `__init__` method is generated based on the classes attributes. The following +calls are not valid: + +```py +# error: [missing-argument] +Person() + +# error: [too-many-positional-arguments] +Person("Eve", 20, "too many arguments") + +# error: [invalid-argument-type] +Person("Eve", "string instead of int") + +# error: [invalid-argument-type] +# error: [invalid-argument-type] +Person(20, "Eve") +``` + +## Signature of `__init__` + +TODO: All of the following tests are missing the `self` argument in the `__init__` signature. + +Declarations in the class body are used to generate the signature of the `__init__` method. If the +attributes are not just declarations, but also bindings, the type inferred from bindings is used as +the default value. + +```py +from dataclasses import dataclass + +@dataclass +class D: + x: int + y: str = "default" + z: int | None = 1 + 2 + +reveal_type(D.__init__) # revealed: (x: int, y: str = Literal["default"], z: int | None = Literal[3]) -> None +``` + +This also works if the declaration and binding are split: + +```py +@dataclass +class D: + x: int | None + x = None + +reveal_type(D.__init__) # revealed: (x: int | None = None) -> None +``` + +Non-fully static types are handled correctly: + +```py +from typing import Any + +@dataclass +class C: + x: Any + y: int | Any + z: tuple[int, Any] + +reveal_type(C.__init__) # revealed: (x: Any, y: int | Any, z: tuple[int, Any]) -> None +``` + +Variables without annotations are ignored: + +```py +@dataclass +class D: + x: int + y = 1 + +reveal_type(D.__init__) # revealed: (x: int) -> None +``` + +If attributes without default values are declared after attributes with default values, a +`TypeError` will be raised at runtime. Ideally, we would emit a diagnostic in that case: + +```py +@dataclass +class D: + x: int = 1 + # TODO: this should be an error: field without default defined after field with default + y: str +``` + +Pure class attributes (`ClassVar`) are not included in the signature of `__init__`: + +```py +from typing import ClassVar + +@dataclass +class D: + x: int + y: ClassVar[str] = "default" + z: bool + +reveal_type(D.__init__) # revealed: (x: int, z: bool) -> None + +d = D(1, True) +reveal_type(d.x) # revealed: int +reveal_type(d.y) # revealed: str +reveal_type(d.z) # revealed: bool +``` + +Function declarations do not affect the signature of `__init__`: + +```py +@dataclass +class D: + x: int + + def y(self) -> str: + return "" + +reveal_type(D.__init__) # revealed: (x: int) -> None +``` + +And neither do nested class declarations: + +```py +@dataclass +class D: + x: int + + class Nested: + y: str + +reveal_type(D.__init__) # revealed: (x: int) -> None +``` + +But if there is a variable annotation with a function or class literal type, the signature of +`__init__` will include this field: + +```py +from ty_extensions import TypeOf + +class SomeClass: ... + +def some_function() -> None: ... +@dataclass +class D: + function_literal: TypeOf[some_function] + class_literal: TypeOf[SomeClass] + class_subtype_of: type[SomeClass] + +# revealed: (function_literal: def some_function() -> None, class_literal: <class 'SomeClass'>, class_subtype_of: type[SomeClass]) -> None +reveal_type(D.__init__) +``` + +More realistically, dataclasses can have `Callable` attributes: + +```py +from typing import Callable + +@dataclass +class D: + c: Callable[[int], str] + +reveal_type(D.__init__) # revealed: (c: (int, /) -> str) -> None +``` + +Implicit instance attributes do not affect the signature of `__init__`: + +```py +@dataclass +class D: + x: int + + def f(self, y: str) -> None: + self.y: str = y + +reveal_type(D(1).y) # revealed: str + +reveal_type(D.__init__) # revealed: (x: int) -> None +``` + +Annotating expressions does not lead to an entry in `__annotations__` at runtime, and so it wouldn't +be included in the signature of `__init__`. This is a case that we currently don't detect: + +```py +@dataclass +class D: + # (x) is an expression, not a "simple name" + (x): int = 1 + +# TODO: should ideally not include a `x` parameter +reveal_type(D.__init__) # revealed: (x: int = Literal[1]) -> None +``` + +## `@dataclass` calls with arguments + +The `@dataclass` decorator can take several arguments to customize the existence of the generated +methods. The following test makes sure that we still treat the class as a dataclass if (the default) +arguments are passed in: + +```py +from dataclasses import dataclass + +@dataclass(init=True, repr=True, eq=True) +class Person: + name: str + age: int | None = None + +alice = Person("Alice", 30) +reveal_type(repr(alice)) # revealed: str +reveal_type(alice == alice) # revealed: bool +``` + +If `init` is set to `False`, no `__init__` method is generated: + +```py +from dataclasses import dataclass + +@dataclass(init=False) +class C: + x: int + +C() # Okay + +# error: [too-many-positional-arguments] +C(1) + +repr(C()) + +C() == C() +``` + +## Other dataclass parameters + +### `repr` + +A custom `__repr__` method is generated by default. It can be disabled by passing `repr=False`, but +in that case `__repr__` is still available via `object.__repr__`: + +```py +from dataclasses import dataclass + +@dataclass(repr=False) +class WithoutRepr: + x: int + +reveal_type(WithoutRepr(1).__repr__) # revealed: bound method WithoutRepr.__repr__() -> str +``` + +### `eq` + +The same is true for `__eq__`. Setting `eq=False` disables the generated `__eq__` method, but +`__eq__` is still available via `object.__eq__`: + +```py +from dataclasses import dataclass + +@dataclass(eq=False) +class WithoutEq: + x: int + +reveal_type(WithoutEq(1) == WithoutEq(2)) # revealed: bool +``` + +### `order` + +```toml +[environment] +python-version = "3.12" +``` + +`order` is set to `False` by default. If `order=True`, `__lt__`, `__le__`, `__gt__`, and `__ge__` +methods will be generated: + +```py +from dataclasses import dataclass + +@dataclass +class WithoutOrder: + x: int + +WithoutOrder(1) < WithoutOrder(2) # error: [unsupported-operator] +WithoutOrder(1) <= WithoutOrder(2) # error: [unsupported-operator] +WithoutOrder(1) > WithoutOrder(2) # error: [unsupported-operator] +WithoutOrder(1) >= WithoutOrder(2) # error: [unsupported-operator] + +@dataclass(order=True) +class WithOrder: + x: int + +WithOrder(1) < WithOrder(2) +WithOrder(1) <= WithOrder(2) +WithOrder(1) > WithOrder(2) +WithOrder(1) >= WithOrder(2) +``` + +Comparisons are only allowed for `WithOrder` instances: + +```py +WithOrder(1) < 2 # error: [unsupported-operator] +WithOrder(1) <= 2 # error: [unsupported-operator] +WithOrder(1) > 2 # error: [unsupported-operator] +WithOrder(1) >= 2 # error: [unsupported-operator] +``` + +This also works for generic dataclasses: + +```py +from dataclasses import dataclass + +@dataclass(order=True) +class GenericWithOrder[T]: + x: T + +GenericWithOrder[int](1) < GenericWithOrder[int](1) + +GenericWithOrder[int](1) < GenericWithOrder[str]("a") # error: [unsupported-operator] +``` + +If a class already defines one of the comparison methods, a `TypeError` is raised at runtime. +Ideally, we would emit a diagnostic in that case: + +```py +@dataclass(order=True) +class AlreadyHasCustomDunderLt: + x: int + + # TODO: Ideally, we would emit a diagnostic here + def __lt__(self, other: object) -> bool: + return False +``` + +### `unsafe_hash` + +To do + +### `frozen` + +If true (the default is False), assigning to fields will generate a diagnostic. + +```py +from dataclasses import dataclass + +@dataclass(frozen=True) +class MyFrozenClass: + x: int + +frozen_instance = MyFrozenClass(1) +frozen_instance.x = 2 # error: [invalid-assignment] +``` + +If `__setattr__()` or `__delattr__()` is defined in the class, we should emit a diagnostic. + +```py +from dataclasses import dataclass + +@dataclass(frozen=True) +class MyFrozenClass: + x: int + + # TODO: Emit a diagnostic here + def __setattr__(self, name: str, value: object) -> None: ... + + # TODO: Emit a diagnostic here + def __delattr__(self, name: str) -> None: ... +``` + +This also works for generic dataclasses: + +```toml +[environment] +python-version = "3.12" +``` + +```py +from dataclasses import dataclass + +@dataclass(frozen=True) +class MyFrozenGeneric[T]: + x: T + +frozen_instance = MyFrozenGeneric[int](1) +frozen_instance.x = 2 # error: [invalid-assignment] +``` + +When attempting to mutate an unresolved attribute on a frozen dataclass, only `unresolved-attribute` +is emitted: + +```py +from dataclasses import dataclass + +@dataclass(frozen=True) +class MyFrozenClass: ... + +frozen = MyFrozenClass() +frozen.x = 2 # error: [unresolved-attribute] +``` + +### `match_args` + +To do + +### `kw_only` + +To do + +### `slots` + +To do + +### `weakref_slot` + +To do + +## Inheritance + +### Normal class inheriting from a dataclass + +```py +from dataclasses import dataclass + +@dataclass +class Base: + x: int + +class Derived(Base): ... + +d = Derived(1) # OK +reveal_type(d.x) # revealed: int +``` + +### Dataclass inheriting from normal class + +```py +from dataclasses import dataclass + +class Base: + x: int = 1 + +@dataclass +class Derived(Base): + y: str + +d = Derived("a") + +# error: [too-many-positional-arguments] +# error: [invalid-argument-type] +Derived(1, "a") +``` + +### Dataclass inheriting from another dataclass + +```py +from dataclasses import dataclass + +@dataclass +class Base: + x: int + y: str + +@dataclass +class Derived(Base): + z: bool + +d = Derived(1, "a", True) # OK + +reveal_type(d.x) # revealed: int +reveal_type(d.y) # revealed: str +reveal_type(d.z) # revealed: bool + +# error: [missing-argument] +Derived(1, "a") + +# error: [missing-argument] +Derived(True) +``` + +### Overwriting attributes from base class + +The following example comes from the +[Python documentation](https://docs.python.org/3/library/dataclasses.html#inheritance). The `x` +attribute appears just once in the `__init__` signature, and the default value is taken from the +derived class + +```py +from dataclasses import dataclass +from typing import Any + +@dataclass +class Base: + x: Any = 15.0 + y: int = 0 + +@dataclass +class C(Base): + z: int = 10 + x: int = 15 + +reveal_type(C.__init__) # revealed: (x: int = Literal[15], y: int = Literal[0], z: int = Literal[10]) -> None +``` + +## Generic dataclasses + +```toml +[environment] +python-version = "3.12" +``` + +```py +from dataclasses import dataclass + +@dataclass +class DataWithDescription[T]: + data: T + description: str + +reveal_type(DataWithDescription[int]) # revealed: <class 'DataWithDescription[int]'> + +d_int = DataWithDescription[int](1, "description") # OK +reveal_type(d_int.data) # revealed: int +reveal_type(d_int.description) # revealed: str + +# error: [invalid-argument-type] +DataWithDescription[int](None, "description") +``` + +## Descriptor-typed fields + +### Same type in `__get__` and `__set__` + +For the following descriptor, the return type of `__get__` and the type of the `value` parameter in +`__set__` are the same. The generated `__init__` method takes an argument of this type (instead of +the type of the descriptor), and the default value is also of this type: + +```py +from typing import overload +from dataclasses import dataclass + +class UppercaseString: + _value: str = "" + + def __get__(self, instance: object, owner: None | type) -> str: + return self._value + + def __set__(self, instance: object, value: str) -> None: + self._value = value.upper() + +@dataclass +class C: + upper: UppercaseString = UppercaseString() + +reveal_type(C.__init__) # revealed: (upper: str = str) -> None + +c = C("abc") +reveal_type(c.upper) # revealed: str + +# This is also okay: +C() + +# error: [invalid-argument-type] +C(1) + +# error: [too-many-positional-arguments] +C("a", "b") +``` + +### Different types in `__get__` and `__set__` + +In general, the type of the `__init__` parameter is determined by the `value` parameter type of the +`__set__` method (`str` in the example below). However, the default value is generated by calling +the descriptor's `__get__` method as if it had been called on the class itself, i.e. passing `None` +for the `instance` argument. + +```py +from typing import Literal, overload +from dataclasses import dataclass + +class ConvertToLength: + _len: int = 0 + + @overload + def __get__(self, instance: None, owner: type) -> Literal[""]: ... + @overload + def __get__(self, instance: object, owner: type | None) -> int: ... + def __get__(self, instance: object | None, owner: type | None) -> str | int: + if instance is None: + return "" + + return self._len + + def __set__(self, instance, value: str) -> None: + self._len = len(value) + +@dataclass +class C: + converter: ConvertToLength = ConvertToLength() + +reveal_type(C.__init__) # revealed: (converter: str = Literal[""]) -> None + +c = C("abc") +reveal_type(c.converter) # revealed: int + +# This is also okay: +C() + +# error: [invalid-argument-type] +C(1) + +# error: [too-many-positional-arguments] +C("a", "b") +``` + +### With overloaded `__set__` method + +If the `__set__` method is overloaded, we determine the type for the `__init__` parameter as the +union of all possible `value` parameter types: + +```py +from typing import overload +from dataclasses import dataclass + +class AcceptsStrAndInt: + def __get__(self, instance, owner) -> int: + return 0 + + @overload + def __set__(self, instance: object, value: str) -> None: ... + @overload + def __set__(self, instance: object, value: int) -> None: ... + def __set__(self, instance: object, value) -> None: + pass + +@dataclass +class C: + field: AcceptsStrAndInt = AcceptsStrAndInt() + +reveal_type(C.__init__) # revealed: (field: str | int = int) -> None +``` + +## `dataclasses.field` + +To do + +## `dataclass.fields` + +Dataclasses have a special `__dataclass_fields__` class variable member. The `DataclassInstance` +protocol checks for the presence of this attribute. It is used in the `dataclasses.fields` and +`dataclasses.asdict` functions, for example: + +```py +from dataclasses import dataclass, fields, asdict + +@dataclass +class Foo: + x: int + +foo = Foo(1) + +reveal_type(foo.__dataclass_fields__) # revealed: dict[str, Field[Any]] +reveal_type(fields(Foo)) # revealed: tuple[Field[Any], ...] +reveal_type(asdict(foo)) # revealed: dict[str, Any] +``` + +The class objects themselves also have a `__dataclass_fields__` attribute: + +```py +reveal_type(Foo.__dataclass_fields__) # revealed: dict[str, Field[Any]] +``` + +They can be passed into `fields` as well, because it also accepts `type[DataclassInstance]` +arguments: + +```py +reveal_type(fields(Foo)) # revealed: tuple[Field[Any], ...] +``` + +But calling `asdict` on the class object is not allowed: + +```py +# TODO: this should be a invalid-argument-type error, but we don't properly check the +# types (and more importantly, the `ClassVar` type qualifier) of protocol members yet. +asdict(Foo) +``` + +## Other special cases + +### `dataclasses.dataclass` + +We also understand dataclasses if they are decorated with the fully qualified name: + +```py +import dataclasses + +@dataclasses.dataclass +class C: + x: str + +reveal_type(C.__init__) # revealed: (x: str) -> None +``` + +### Dataclass with custom `__init__` method + +If a class already defines `__init__`, it is not replaced by the `dataclass` decorator. + +```py +from dataclasses import dataclass + +@dataclass(init=True) +class C: + x: str + + def __init__(self, x: int) -> None: + self.x = str(x) + +C(1) # OK + +# error: [invalid-argument-type] +C("a") +``` + +Similarly, if we set `init=False`, we still recognize the custom `__init__` method: + +```py +@dataclass(init=False) +class D: + def __init__(self, x: int) -> None: + self.x = str(x) + +D(1) # OK +D() # error: [missing-argument] +``` + +### Accessing instance attributes on the class itself + +Just like for normal classes, accessing instance attributes on the class itself is not allowed: + +```py +from dataclasses import dataclass + +@dataclass +class C: + x: int + +# error: [unresolved-attribute] "Attribute `x` can only be accessed on instances, not on the class object `<class 'C'>` itself." +C.x +``` + +### Return type of `dataclass(...)` + +A call like `dataclass(order=True)` returns a callable itself, which is then used as the decorator. +We can store the callable in a variable and later use it as a decorator: + +```py +from dataclasses import dataclass + +dataclass_with_order = dataclass(order=True) + +reveal_type(dataclass_with_order) # revealed: <decorator produced by dataclass-like function> + +@dataclass_with_order +class C: + x: int + +C(1) < C(2) # ok +``` + +### Using `dataclass` as a function + +To do + +## Internals + +The `dataclass` decorator returns the class itself. This means that the type of `Person` is `type`, +and attributes like the MRO are unchanged: + +```py +from dataclasses import dataclass + +@dataclass +class Person: + name: str + age: int | None = None + +reveal_type(type(Person)) # revealed: <class 'type'> +reveal_type(Person.__mro__) # revealed: tuple[<class 'Person'>, <class 'object'>] +``` + +The generated methods have the following signatures: + +```py +# TODO: `self` is missing here +reveal_type(Person.__init__) # revealed: (name: str, age: int | None = None) -> None + +reveal_type(Person.__repr__) # revealed: def __repr__(self) -> str + +reveal_type(Person.__eq__) # revealed: def __eq__(self, value: object, /) -> bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/declaration/error.md b/crates/ty_python_semantic/resources/mdtest/declaration/error.md new file mode 100644 index 0000000000000..3f435d8e5d700 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/declaration/error.md @@ -0,0 +1,75 @@ +# Errors while declaring + +## Violates previous assignment + +```py +x = 1 +x: str # error: [invalid-declaration] "Cannot declare type `str` for inferred type `Literal[1]`" +``` + +## Incompatible declarations + +```py +def _(flag: bool): + if flag: + x: str + else: + x: int + + x = 1 # error: [conflicting-declarations] "Conflicting declared types for `x`: str, int" +``` + +## Incompatible declarations for 2 (out of 3) types + +```py +def _(flag1: bool, flag2: bool): + if flag1: + x: str + elif flag2: + x: int + + # Here, the declared type for `x` is `int | str | Unknown`. + x = 1 # error: [conflicting-declarations] "Conflicting declared types for `x`: str, int" +``` + +## Incompatible declarations with bad assignment + +```py +def _(flag: bool): + if flag: + x: str + else: + x: int + + # error: [conflicting-declarations] + # error: [invalid-assignment] + x = b"foo" +``` + +## No errors + +Currently, we avoid raising the conflicting-declarations for the following cases: + +### Partial declarations + +```py +def _(flag: bool): + if flag: + x: int + + x = 1 +``` + +### Partial declarations in try-except + +Refer to <https://github.com/astral-sh/ruff/issues/13966> + +```py +def _(): + try: + x: int = 1 + except: + x = 2 + + x = 3 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/decorators.md b/crates/ty_python_semantic/resources/mdtest/decorators.md new file mode 100644 index 0000000000000..f92eca800360e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/decorators.md @@ -0,0 +1,237 @@ +# Decorators + +Decorators are a way to modify function and class behavior. A decorator is a callable that takes the +function or class as an argument and returns a modified version of it. + +## Basic example + +A decorated function definition is conceptually similar to `def f(x): ...` followed by +`f = decorator(f)`. This means that the type of a decorated function is the same as the return type +of the decorator (which does not necessarily need to be a callable type): + +```py +def custom_decorator(f) -> int: + return 1 + +@custom_decorator +def f(x): ... + +reveal_type(f) # revealed: int +``` + +## Type-annotated decorator + +More commonly, a decorator returns a modified callable type: + +```py +from typing import Callable + +def ensure_positive(wrapped: Callable[[int], bool]) -> Callable[[int], bool]: + return lambda x: wrapped(x) and x > 0 + +@ensure_positive +def even(x: int) -> bool: + return x % 2 == 0 + +reveal_type(even) # revealed: (int, /) -> bool +reveal_type(even(4)) # revealed: bool +``` + +## Decorators which take arguments + +Decorators can be arbitrary expressions. This is often useful when the decorator itself takes +arguments: + +```py +from typing import Callable + +def ensure_larger_than(lower_bound: int) -> Callable[[Callable[[int], bool]], Callable[[int], bool]]: + def decorator(wrapped: Callable[[int], bool]) -> Callable[[int], bool]: + return lambda x: wrapped(x) and x >= lower_bound + return decorator + +@ensure_larger_than(10) +def even(x: int) -> bool: + return x % 2 == 0 + +reveal_type(even) # revealed: (int, /) -> bool +reveal_type(even(14)) # revealed: bool +``` + +## Multiple decorators + +Multiple decorators can be applied to a single function. They are applied in "bottom-up" order, +meaning that the decorator closest to the function definition is applied first: + +```py +def maps_to_str(f) -> str: + return "a" + +def maps_to_int(f) -> int: + return 1 + +def maps_to_bytes(f) -> bytes: + return b"a" + +@maps_to_str +@maps_to_int +@maps_to_bytes +def f(x): ... + +reveal_type(f) # revealed: str +``` + +## Decorating with a class + +When a function is decorated with a class-based decorator, the decorated function turns into an +instance of the class (see also: [properties](properties.md)). Attributes of the class can be +accessed on the decorated function. + +```py +class accept_strings: + custom_attribute: str = "a" + + def __init__(self, f): + self.f = f + + def __call__(self, x: str | int) -> bool: + return self.f(int(x)) + +@accept_strings +def even(x: int) -> bool: + return x > 0 + +reveal_type(even) # revealed: accept_strings +reveal_type(even.custom_attribute) # revealed: str +reveal_type(even("1")) # revealed: bool +reveal_type(even(1)) # revealed: bool + +# error: [invalid-argument-type] +even(None) +``` + +## Common decorator patterns + +### `functools.wraps` + +This test mainly makes sure that we do not emit any diagnostics in a case where the decorator is +implemented using `functools.wraps`. + +```py +from typing import Callable +from functools import wraps + +def custom_decorator(f) -> Callable[[int], str]: + @wraps(f) + def wrapper(*args, **kwargs): + print("Calling decorated function") + return f(*args, **kwargs) + return wrapper + +@custom_decorator +def f(x: int) -> str: + return str(x) + +reveal_type(f) # revealed: (int, /) -> str +``` + +### `functools.cache` + +```py +from functools import cache + +@cache +def f(x: int) -> int: + return x**2 + +# TODO: Should be `_lru_cache_wrapper[int]` +reveal_type(f) # revealed: _lru_cache_wrapper[Unknown] + +# TODO: Should be `int` +reveal_type(f(1)) # revealed: Unknown +``` + +## Lambdas as decorators + +```py +@lambda f: f +def g(x: int) -> str: + return "a" + +# TODO: This should be `Literal[g]` or `(int, /) -> str` +reveal_type(g) # revealed: Unknown +``` + +## Error cases + +### Unknown decorator + +```py +# error: [unresolved-reference] "Name `unknown_decorator` used when not defined" +@unknown_decorator +def f(x): ... + +reveal_type(f) # revealed: Unknown +``` + +### Error in the decorator expression + +```py +# error: [unsupported-operator] +@(1 + "a") +def f(x): ... + +reveal_type(f) # revealed: Unknown +``` + +### Non-callable decorator + +```py +non_callable = 1 + +# error: [call-non-callable] "Object of type `Literal[1]` is not callable" +@non_callable +def f(x): ... + +reveal_type(f) # revealed: Unknown +``` + +### Wrong signature + +#### Wrong argument type + +Here, we emit a diagnostic since `wrong_signature` takes an `int` instead of a callable type as the +first argument: + +```py +def wrong_signature(f: int) -> str: + return "a" + +# error: [invalid-argument-type] "Argument to function `wrong_signature` is incorrect: Expected `int`, found `def f(x) -> Unknown`" +@wrong_signature +def f(x): ... + +reveal_type(f) # revealed: str +``` + +#### Wrong number of arguments + +Decorators need to be callable with a single argument. If they are not, we emit a diagnostic: + +```py +def takes_two_arguments(f, g) -> str: + return "a" + +# error: [missing-argument] "No argument provided for required parameter `g` of function `takes_two_arguments`" +@takes_two_arguments +def f(x): ... + +reveal_type(f) # revealed: str + +def takes_no_argument() -> str: + return "a" + +# error: [too-many-positional-arguments] "Too many positional arguments to function `takes_no_argument`: expected 0, got 1" +@takes_no_argument +def g(x): ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/descriptor_protocol.md b/crates/ty_python_semantic/resources/mdtest/descriptor_protocol.md new file mode 100644 index 0000000000000..cc9661b54f6a8 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/descriptor_protocol.md @@ -0,0 +1,800 @@ +# Descriptor protocol + +[Descriptors] let objects customize attribute lookup, storage, and deletion. + +A descriptor is an attribute value that has one of the methods in the descriptor protocol. Those +methods are `__get__()`, `__set__()`, and `__delete__()`. If any of those methods are defined for an +attribute, it is said to be a descriptor. + +## Basic properties + +### Example + +An introductory example, modeled after a [simple example] in the primer on descriptors, involving a +descriptor that returns a constant value: + +```py +from typing import Literal + +class Ten: + def __get__(self, instance: object, owner: type | None = None) -> Literal[10]: + return 10 + + def __set__(self, instance: object, value: Literal[10]) -> None: + pass + +class C: + ten: Ten = Ten() + +c = C() + +reveal_type(c.ten) # revealed: Literal[10] + +reveal_type(C.ten) # revealed: Literal[10] + +# This is fine: +c.ten = 10 + +# error: [invalid-assignment] "Invalid assignment to data descriptor attribute `ten` on type `C` with custom `__set__` method" +c.ten = 11 +``` + +When assigning to the `ten` attribute from the class object, we get an error. The descriptor +protocol is *not* triggered in this case. Since the attribute is declared as `Ten` in the class +body, we do not allow these assignments, preventing users from accidentally overwriting the data +descriptor, which is what would happen at runtime: + +```py +# error: [invalid-assignment] "Object of type `Literal[10]` is not assignable to attribute `ten` of type `Ten`" +C.ten = 10 +# error: [invalid-assignment] "Object of type `Literal[11]` is not assignable to attribute `ten` of type `Ten`" +C.ten = 11 +``` + +### Different types for `__get__` and `__set__` + +The return type of `__get__` and the value type of `__set__` can be different: + +```py +class FlexibleInt: + def __init__(self): + self._value: int | None = None + + def __get__(self, instance: object, owner: type | None = None) -> int | None: + return self._value + + def __set__(self, instance: object, value: int | str) -> None: + self._value = int(value) + +class C: + flexible_int: FlexibleInt = FlexibleInt() + +c = C() + +reveal_type(c.flexible_int) # revealed: int | None + +c.flexible_int = 42 # okay +c.flexible_int = "42" # also okay! + +reveal_type(c.flexible_int) # revealed: int | None + +# error: [invalid-assignment] "Invalid assignment to data descriptor attribute `flexible_int` on type `C` with custom `__set__` method" +c.flexible_int = None # not okay + +reveal_type(c.flexible_int) # revealed: int | None +``` + +### Data and non-data descriptors + +Descriptors that define `__set__` or `__delete__` are called *data descriptors*. An example of a +data descriptor is a `property` with a setter and/or a deleter. Descriptors that only define +`__get__`, meanwhile, are called *non-data descriptors*. Examples include functions, `classmethod` +or `staticmethod`. + +The precedence chain for attribute access is (1) data descriptors, (2) instance attributes, and (3) +non-data descriptors. + +```py +from typing import Literal + +class DataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["data"]: + return "data" + + def __set__(self, instance: object, value: int) -> None: + pass + +class NonDataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["non-data"]: + return "non-data" + +class C: + data_descriptor = DataDescriptor() + non_data_descriptor = NonDataDescriptor() + + def f(self): + # This explains why data descriptors come first in the precedence chain. If + # instance attributes would take priority, we would override the descriptor + # here. Instead, this calls `DataDescriptor.__set__`, i.e. it does not affect + # the type of the `data_descriptor` attribute. + self.data_descriptor = 1 + + # However, for non-data descriptors, instance attributes do take precedence. + # So it is possible to override them. + self.non_data_descriptor = 1 + +c = C() + +reveal_type(c.data_descriptor) # revealed: Unknown | Literal["data"] + +reveal_type(c.non_data_descriptor) # revealed: Unknown | Literal["non-data", 1] + +reveal_type(C.data_descriptor) # revealed: Unknown | Literal["data"] + +reveal_type(C.non_data_descriptor) # revealed: Unknown | Literal["non-data"] + +# It is possible to override data descriptors via class objects. The following +# assignment does not call `DataDescriptor.__set__`. For this reason, we infer +# `Unknown | …` for all (descriptor) attributes. +C.data_descriptor = "something else" # This is okay +``` + +### Partial fall back + +Our implementation of the descriptor protocol takes into account that symbols can be possibly +unbound. In those cases, we fall back to lower precedence steps of the descriptor protocol and union +all possible results accordingly. We start by defining a data and a non-data descriptor: + +```py +from typing import Literal + +class DataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["data"]: + return "data" + + def __set__(self, instance: object, value: int) -> None: + pass + +class NonDataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["non-data"]: + return "non-data" +``` + +Then, we demonstrate that we fall back to an instance attribute if a data descriptor is possibly +unbound: + +```py +def f1(flag: bool): + class C1: + if flag: + attr = DataDescriptor() + + def f(self): + self.attr = "normal" + + reveal_type(C1().attr) # revealed: Unknown | Literal["data", "normal"] + + # Assigning to the attribute also causes no `possibly-unbound` diagnostic: + C1().attr = 1 +``` + +We never treat implicit instance attributes as definitely bound, so we fall back to the non-data +descriptor here: + +```py +class C2: + def f(self): + self.attr = "normal" + attr = NonDataDescriptor() + +reveal_type(C2().attr) # revealed: Unknown | Literal["non-data", "normal"] + +# Assignments always go to the instance attribute in this case +C2().attr = 1 +``` + +### Descriptors only work when used as class variables + +Descriptors only work when used as class variables. When put in instances, they have no effect. + +```py +from typing import Literal + +class Ten: + def __get__(self, instance: object, owner: type | None = None) -> Literal[10]: + return 10 + +class C: + def __init__(self): + self.ten: Ten = Ten() + +reveal_type(C().ten) # revealed: Ten + +C().ten = Ten() + +# The instance attribute is declared as `Ten`, so this is an +# error: [invalid-assignment] "Object of type `Literal[10]` is not assignable to attribute `ten` of type `Ten`" +C().ten = 10 +``` + +## Descriptor protocol for class objects + +When attributes are accessed on a class object, the following [precedence chain] is used: + +- Data descriptor on the metaclass +- Data or non-data descriptor on the class +- Class attribute +- Non-data descriptor on the metaclass +- Metaclass attribute + +To verify this, we define a data and a non-data descriptor: + +```py +from typing import Literal, Any + +class DataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["data"]: + return "data" + + def __set__(self, instance: object, value: int) -> None: + pass + +class NonDataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["non-data"]: + return "non-data" +``` + +First, we make sure that the descriptors are correctly accessed when defined on the metaclass or the +class: + +```py +class Meta1(type): + meta_data_descriptor: DataDescriptor = DataDescriptor() + meta_non_data_descriptor: NonDataDescriptor = NonDataDescriptor() + +class C1(metaclass=Meta1): + class_data_descriptor: DataDescriptor = DataDescriptor() + class_non_data_descriptor: NonDataDescriptor = NonDataDescriptor() + +reveal_type(C1.meta_data_descriptor) # revealed: Literal["data"] +reveal_type(C1.meta_non_data_descriptor) # revealed: Literal["non-data"] + +reveal_type(C1.class_data_descriptor) # revealed: Literal["data"] +reveal_type(C1.class_non_data_descriptor) # revealed: Literal["non-data"] +``` + +Assignments to class object attribute only trigger the descriptor protocol if the data descriptor is +on the metaclass: + +```py +C1.meta_data_descriptor = 1 + +# error: [invalid-assignment] "Invalid assignment to data descriptor attribute `meta_data_descriptor` on type `<class 'C1'>` with custom `__set__` method" +C1.meta_data_descriptor = "invalid" +``` + +When writing to a class-level data descriptor from the class object itself, the descriptor protocol +is *not* triggered (this is in contrast to what happens when you read class-level descriptor +attributes!). So the following assignment does not call `__set__`. At runtime, the assignment would +overwrite the data descriptor, but the attribute is declared as `DataDescriptor` in the class body, +so we do not allow this: + +```py +# error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to attribute `class_data_descriptor` of type `DataDescriptor`" +C1.class_data_descriptor = 1 +``` + +We now demonstrate that a *metaclass data descriptor* takes precedence over all class-level +attributes: + +```py +class Meta2(type): + meta_data_descriptor1: DataDescriptor = DataDescriptor() + meta_data_descriptor2: DataDescriptor = DataDescriptor() + +class ClassLevelDataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> Literal["class level data descriptor"]: + return "class level data descriptor" + + def __set__(self, instance: object, value: str) -> None: + pass + +class C2(metaclass=Meta2): + meta_data_descriptor1: Literal["value on class"] = "value on class" + meta_data_descriptor2: ClassLevelDataDescriptor = ClassLevelDataDescriptor() + +reveal_type(C2.meta_data_descriptor1) # revealed: Literal["data"] +reveal_type(C2.meta_data_descriptor2) # revealed: Literal["data"] + +C2.meta_data_descriptor1 = 1 +C2.meta_data_descriptor2 = 1 + +# error: [invalid-assignment] +C2.meta_data_descriptor1 = "invalid" +# error: [invalid-assignment] +C2.meta_data_descriptor2 = "invalid" +``` + +On the other hand, normal metaclass attributes and metaclass non-data descriptors are shadowed by +class-level attributes (descriptor or not): + +```py +class Meta3(type): + meta_attribute1: Literal["value on metaclass"] = "value on metaclass" + meta_attribute2: Literal["value on metaclass"] = "value on metaclass" + meta_non_data_descriptor1: NonDataDescriptor = NonDataDescriptor() + meta_non_data_descriptor2: NonDataDescriptor = NonDataDescriptor() + +class C3(metaclass=Meta3): + meta_attribute1: Literal["value on class"] = "value on class" + meta_attribute2: ClassLevelDataDescriptor = ClassLevelDataDescriptor() + meta_non_data_descriptor1: Literal["value on class"] = "value on class" + meta_non_data_descriptor2: ClassLevelDataDescriptor = ClassLevelDataDescriptor() + +reveal_type(C3.meta_attribute1) # revealed: Literal["value on class"] +reveal_type(C3.meta_attribute2) # revealed: Literal["class level data descriptor"] +reveal_type(C3.meta_non_data_descriptor1) # revealed: Literal["value on class"] +reveal_type(C3.meta_non_data_descriptor2) # revealed: Literal["class level data descriptor"] +``` + +Finally, metaclass attributes and metaclass non-data descriptors are only accessible when they are +not shadowed by class-level attributes: + +```py +class Meta4(type): + meta_attribute: Literal["value on metaclass"] = "value on metaclass" + meta_non_data_descriptor: NonDataDescriptor = NonDataDescriptor() + +class C4(metaclass=Meta4): ... + +reveal_type(C4.meta_attribute) # revealed: Literal["value on metaclass"] +reveal_type(C4.meta_non_data_descriptor) # revealed: Literal["non-data"] +``` + +When a metaclass data descriptor is possibly unbound, we union the result type of its `__get__` +method with an underlying class level attribute, if present: + +```py +def _(flag: bool): + class Meta5(type): + if flag: + meta_data_descriptor1: DataDescriptor = DataDescriptor() + meta_data_descriptor2: DataDescriptor = DataDescriptor() + + class C5(metaclass=Meta5): + meta_data_descriptor1: Literal["value on class"] = "value on class" + + reveal_type(C5.meta_data_descriptor1) # revealed: Literal["data", "value on class"] + # error: [possibly-unbound-attribute] + reveal_type(C5.meta_data_descriptor2) # revealed: Literal["data"] + + # TODO: We currently emit two diagnostics here, corresponding to the two states of `flag`. The diagnostics are not + # wrong, but they could be subsumed under a higher-level diagnostic. + + # error: [invalid-assignment] "Invalid assignment to data descriptor attribute `meta_data_descriptor1` on type `<class 'C5'>` with custom `__set__` method" + # error: [invalid-assignment] "Object of type `None` is not assignable to attribute `meta_data_descriptor1` of type `Literal["value on class"]`" + C5.meta_data_descriptor1 = None + + # error: [possibly-unbound-attribute] + C5.meta_data_descriptor2 = 1 +``` + +When a class-level attribute is possibly unbound, we union its (descriptor protocol) type with the +metaclass attribute (unless it's a data descriptor, which always takes precedence): + +```py +from typing import Any + +def _(flag: bool): + class Meta6(type): + attribute1: DataDescriptor = DataDescriptor() + attribute2: NonDataDescriptor = NonDataDescriptor() + attribute3: Literal["value on metaclass"] = "value on metaclass" + + class C6(metaclass=Meta6): + if flag: + attribute1: Literal["value on class"] = "value on class" + attribute2: Literal["value on class"] = "value on class" + attribute3: Literal["value on class"] = "value on class" + attribute4: Literal["value on class"] = "value on class" + + reveal_type(C6.attribute1) # revealed: Literal["data"] + reveal_type(C6.attribute2) # revealed: Literal["non-data", "value on class"] + reveal_type(C6.attribute3) # revealed: Literal["value on metaclass", "value on class"] + # error: [possibly-unbound-attribute] + reveal_type(C6.attribute4) # revealed: Literal["value on class"] +``` + +Finally, we can also have unions of various types of attributes: + +```py +def _(flag: bool): + class Meta7(type): + if flag: + union_of_metaclass_attributes: Literal[1] = 1 + union_of_metaclass_data_descriptor_and_attribute: DataDescriptor = DataDescriptor() + else: + union_of_metaclass_attributes: Literal[2] = 2 + union_of_metaclass_data_descriptor_and_attribute: Literal[2] = 2 + + class C7(metaclass=Meta7): + if flag: + union_of_class_attributes: Literal[1] = 1 + union_of_class_data_descriptor_and_attribute: DataDescriptor = DataDescriptor() + else: + union_of_class_attributes: Literal[2] = 2 + union_of_class_data_descriptor_and_attribute: Literal[2] = 2 + + reveal_type(C7.union_of_metaclass_attributes) # revealed: Literal[1, 2] + reveal_type(C7.union_of_metaclass_data_descriptor_and_attribute) # revealed: Literal["data", 2] + reveal_type(C7.union_of_class_attributes) # revealed: Literal[1, 2] + reveal_type(C7.union_of_class_data_descriptor_and_attribute) # revealed: Literal["data", 2] + + C7.union_of_metaclass_attributes = 2 if flag else 1 + C7.union_of_metaclass_data_descriptor_and_attribute = 2 if flag else 100 + C7.union_of_class_attributes = 2 if flag else 1 + C7.union_of_class_data_descriptor_and_attribute = 2 if flag else DataDescriptor() +``` + +## Descriptors distinguishing between class and instance access + +Overloads can be used to distinguish between when a descriptor is accessed on a class object and +when it is accessed on an instance. A real-world example of this is the `__get__` method on +`types.FunctionType`. + +```py +from typing_extensions import Literal, LiteralString, overload + +class Descriptor: + @overload + def __get__(self, instance: None, owner: type, /) -> Literal["called on class object"]: ... + @overload + def __get__(self, instance: object, owner: type | None = None, /) -> Literal["called on instance"]: ... + def __get__(self, instance, owner=None, /) -> LiteralString: + if instance: + return "called on instance" + else: + return "called on class object" + +class C: + d: Descriptor = Descriptor() + +reveal_type(C.d) # revealed: Literal["called on class object"] + +reveal_type(C().d) # revealed: Literal["called on instance"] +``` + +## Descriptor protocol for dunder methods + +Dunder methods are always looked up on the meta-type. There is no instance fallback. This means that +an implicit dunder call on an instance-like object will not only look up the dunder method on the +class object, without considering instance attributes. And an implicit dunder call on a class object +will look up the dunder method on the metaclass, without considering class attributes. + +```py +class SomeCallable: + def __call__(self, x: int) -> str: + return "a" + +class Descriptor: + def __get__(self, instance: object, owner: type | None = None) -> SomeCallable: + return SomeCallable() + +class B: + __call__: Descriptor = Descriptor() + +b_instance = B() +reveal_type(b_instance(1)) # revealed: str + +b_instance("bla") # error: [invalid-argument-type] +``` + +## Special descriptors + +### Built-in `property` descriptor + +The built-in `property` decorator creates a descriptor. The names for attribute reads/writes are +determined by the return type of the `name` method and the parameter type of the setter, +respectively. + +```py +class C: + _name: str | None = None + + @property + def name(self) -> str: + return self._name or "Unset" + + @name.setter + def name(self, value: str | None) -> None: + self._value = value + +c = C() + +reveal_type(c._name) # revealed: str | None +reveal_type(c.name) # revealed: str +reveal_type(C.name) # revealed: property + +c.name = "new" +c.name = None + +# error: [invalid-assignment] "Invalid assignment to data descriptor attribute `name` on type `C` with custom `__set__` method" +c.name = 42 +``` + +### Built-in `classmethod` descriptor + +Similarly to `property`, `classmethod` decorator creates an implicit descriptor that binds the first +argument to the class instead of the instance. + +```py +class C: + def __init__(self, value: str) -> None: + self._name: str = value + + @classmethod + def factory(cls, value: str) -> "C": + return cls(value) + + @classmethod + def get_name(cls) -> str: + return cls.__name__ + +c1 = C.factory("test") # okay + +reveal_type(c1) # revealed: C + +reveal_type(C.get_name()) # revealed: str + +reveal_type(C("42").get_name()) # revealed: str +``` + +### Functions as descriptors + +Functions are descriptors because they implement a `__get__` method. This is crucial in making sure +that method calls work as expected. See [this test suite](./call/methods.md) for more information. +Here, we only demonstrate how `__get__` works on functions: + +```py +from inspect import getattr_static + +def f(x: object) -> str: + return "a" + +reveal_type(f) # revealed: def f(x: object) -> str +reveal_type(f.__get__) # revealed: <method-wrapper `__get__` of `f`> +reveal_type(f.__get__(None, type(f))) # revealed: def f(x: object) -> str +reveal_type(f.__get__(None, type(f))(1)) # revealed: str + +wrapper_descriptor = getattr_static(f, "__get__") + +reveal_type(wrapper_descriptor) # revealed: <wrapper-descriptor `__get__` of `function` objects> +reveal_type(wrapper_descriptor(f, None, type(f))) # revealed: def f(x: object) -> str + +# Attribute access on the method-wrapper `f.__get__` falls back to `MethodWrapperType`: +reveal_type(f.__get__.__hash__) # revealed: bound method MethodWrapperType.__hash__() -> int + +# Attribute access on the wrapper-descriptor falls back to `WrapperDescriptorType`: +reveal_type(wrapper_descriptor.__qualname__) # revealed: str +``` + +We can also bind the free function `f` to an instance of a class `C`: + +```py +class C: ... + +bound_method = wrapper_descriptor(f, C(), C) + +reveal_type(bound_method) # revealed: bound method C.f() -> str +``` + +We can then call it, and the instance of `C` is implicitly passed to the first parameter of `f` +(`x`): + +```py +reveal_type(bound_method()) # revealed: str +``` + +Finally, we test some error cases for the call to the wrapper descriptor: + +```py +# Calling the wrapper descriptor without any arguments is an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor() + +# Calling it without the `instance` argument is an also an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor(f) + +# Calling it without the `owner` argument if `instance` is not `None` is an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor(f, None) + +# But calling it with an instance is fine (in this case, the `owner` argument is optional): +wrapper_descriptor(f, C()) + +# Calling it with something that is not a `FunctionType` as the first argument is an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor(1, None, type(f)) + +# Calling it with something that is not a `type` as the `owner` argument is an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor(f, None, f) + +# Calling it with too many positional arguments is an +# error: [no-matching-overload] "No overload of wrapper descriptor `FunctionType.__get__` matches arguments" +wrapper_descriptor(f, None, type(f), "one too many") +``` + +## Error handling and edge cases + +### `__get__` is called with correct arguments + +This test makes sure that we call `__get__` with the right argument types for various scenarios: + +```py +from __future__ import annotations + +class TailoredForClassObjectAccess: + def __get__(self, instance: None, owner: type[C]) -> int: + return 1 + +class TailoredForInstanceAccess: + def __get__(self, instance: C, owner: type[C] | None = None) -> str: + return "a" + +class TailoredForMetaclassAccess: + def __get__(self, instance: type[C], owner: type[Meta]) -> bytes: + return b"a" + +class Meta(type): + metaclass_access: TailoredForMetaclassAccess = TailoredForMetaclassAccess() + +class C(metaclass=Meta): + class_object_access: TailoredForClassObjectAccess = TailoredForClassObjectAccess() + instance_access: TailoredForInstanceAccess = TailoredForInstanceAccess() + +reveal_type(C.class_object_access) # revealed: int +reveal_type(C().instance_access) # revealed: str +reveal_type(C.metaclass_access) # revealed: bytes + +# TODO: These should emit a diagnostic +reveal_type(C().class_object_access) # revealed: TailoredForClassObjectAccess +reveal_type(C.instance_access) # revealed: TailoredForInstanceAccess +``` + +### Descriptors with incorrect `__get__` signature + +```py +class Descriptor: + # `__get__` method with missing parameters: + def __get__(self) -> int: + return 1 + +class C: + descriptor: Descriptor = Descriptor() + +# TODO: This should be an error +reveal_type(C.descriptor) # revealed: Descriptor + +# TODO: This should be an error +reveal_type(C().descriptor) # revealed: Descriptor +``` + +### Undeclared descriptor arguments + +If a descriptor attribute is not declared, we union with `Unknown`, just like for regular +attributes, since that attribute could be overwritten externally. Even a data descriptor with a +`__set__` method can be overwritten when accessed through a class object. + +```py +class Descriptor: + def __get__(self, instance: object, owner: type | None = None) -> int: + return 1 + + def __set__(self, instance: object, value: int) -> None: + pass + +class C: + descriptor = Descriptor() + +C.descriptor = "something else" + +# This could also be `Literal["something else"]` if we support narrowing of attribute types based on assignments +reveal_type(C.descriptor) # revealed: Unknown | int +``` + +### Possibly unbound descriptor attributes + +```py +class DataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> int: + return 1 + + def __set__(self, instance: int, value) -> None: + pass + +class NonDataDescriptor: + def __get__(self, instance: object, owner: type | None = None) -> int: + return 1 + +def _(flag: bool): + class PossiblyUnbound: + if flag: + non_data: NonDataDescriptor = NonDataDescriptor() + data: DataDescriptor = DataDescriptor() + + # error: [possibly-unbound-attribute] "Attribute `non_data` on type `<class 'PossiblyUnbound'>` is possibly unbound" + reveal_type(PossiblyUnbound.non_data) # revealed: int + + # error: [possibly-unbound-attribute] "Attribute `non_data` on type `PossiblyUnbound` is possibly unbound" + reveal_type(PossiblyUnbound().non_data) # revealed: int + + # error: [possibly-unbound-attribute] "Attribute `data` on type `<class 'PossiblyUnbound'>` is possibly unbound" + reveal_type(PossiblyUnbound.data) # revealed: int + + # error: [possibly-unbound-attribute] "Attribute `data` on type `PossiblyUnbound` is possibly unbound" + reveal_type(PossiblyUnbound().data) # revealed: int +``` + +### Possibly-unbound `__get__` method + +```py +def _(flag: bool): + class MaybeDescriptor: + if flag: + def __get__(self, instance: object, owner: type | None = None) -> int: + return 1 + + class C: + descriptor: MaybeDescriptor = MaybeDescriptor() + + reveal_type(C.descriptor) # revealed: int | MaybeDescriptor + + reveal_type(C().descriptor) # revealed: int | MaybeDescriptor +``` + +### Descriptors with non-function `__get__` callables that are descriptors themselves + +The descriptor protocol is recursive, i.e. looking up `__get__` can involve triggering the +descriptor protocol on the callable's `__call__` method: + +```py +from __future__ import annotations + +class ReturnedCallable2: + def __call__(self, descriptor: Descriptor1, instance: None, owner: type[C]) -> int: + return 1 + +class ReturnedCallable1: + def __call__(self, descriptor: Descriptor2, instance: Callable1, owner: type[Callable1]) -> ReturnedCallable2: + return ReturnedCallable2() + +class Callable3: + def __call__(self, descriptor: Descriptor3, instance: Callable2, owner: type[Callable2]) -> ReturnedCallable1: + return ReturnedCallable1() + +class Descriptor3: + __get__: Callable3 = Callable3() + +class Callable2: + __call__: Descriptor3 = Descriptor3() + +class Descriptor2: + __get__: Callable2 = Callable2() + +class Callable1: + __call__: Descriptor2 = Descriptor2() + +class Descriptor1: + __get__: Callable1 = Callable1() + +class C: + d: Descriptor1 = Descriptor1() + +reveal_type(C.d) # revealed: int +``` + +[descriptors]: https://docs.python.org/3/howto/descriptor.html +[precedence chain]: https://github.com/python/cpython/blob/3.13/Objects/typeobject.c#L5393-L5481 +[simple example]: https://docs.python.org/3/howto/descriptor.html#simple-example-a-descriptor-that-returns-a-constant diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md new file mode 100644 index 0000000000000..83db02c2be8e2 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md @@ -0,0 +1,149 @@ +# Attribute assignment + +<!-- snapshot-diagnostics --> + +This test suite demonstrates various kinds of diagnostics that can be emitted in a +`obj.attr = value` assignment. + +## Instance attributes with class-level defaults + +These can be set on instances and on class objects. + +```py +class C: + attr: int = 0 + +instance = C() +instance.attr = 1 # fine +instance.attr = "wrong" # error: [invalid-assignment] + +C.attr = 1 # fine +C.attr = "wrong" # error: [invalid-assignment] +``` + +## Pure instance attributes + +These can only be set on instances. When trying to set them on class objects, we generate a useful +diagnostic that mentions that the attribute is only available on instances. + +```py +class C: + def __init__(self): + self.attr: int = 0 + +instance = C() +instance.attr = 1 # fine +instance.attr = "wrong" # error: [invalid-assignment] + +C.attr = 1 # error: [invalid-attribute-access] +``` + +## `ClassVar`s + +These can only be set on class objects. When trying to set them on instances, we generate a useful +diagnostic that mentions that the attribute is only available on class objects. + +```py +from typing import ClassVar + +class C: + attr: ClassVar[int] = 0 + +C.attr = 1 # fine +C.attr = "wrong" # error: [invalid-assignment] + +instance = C() +instance.attr = 1 # error: [invalid-attribute-access] +``` + +## Unknown attributes + +When trying to set an attribute that is not defined, we also emit errors: + +```py +class C: ... + +C.non_existent = 1 # error: [unresolved-attribute] + +instance = C() +instance.non_existent = 1 # error: [unresolved-attribute] +``` + +## Possibly-unbound attributes + +When trying to set an attribute that is not defined in all branches, we emit errors: + +```py +def _(flag: bool) -> None: + class C: + if flag: + attr: int = 0 + + C.attr = 1 # error: [possibly-unbound-attribute] + + instance = C() + instance.attr = 1 # error: [possibly-unbound-attribute] +``` + +## Data descriptors + +When assigning to a data descriptor attribute, we implicitly call the descriptor's `__set__` method. +This can lead to various kinds of diagnostics. + +### Invalid argument type + +```py +class Descriptor: + def __set__(self, instance: object, value: int) -> None: + pass + +class C: + attr: Descriptor = Descriptor() + +instance = C() +instance.attr = 1 # fine + +# TODO: ideally, we would mention why this is an invalid assignment (wrong argument type for `value` parameter) +instance.attr = "wrong" # error: [invalid-assignment] +``` + +### Invalid `__set__` method signature + +```py +class WrongDescriptor: + def __set__(self, instance: object, value: int, extra: int) -> None: + pass + +class C: + attr: WrongDescriptor = WrongDescriptor() + +instance = C() + +# TODO: ideally, we would mention why this is an invalid assignment (wrong number of arguments for `__set__`) +instance.attr = 1 # error: [invalid-assignment] +``` + +## Setting attributes on union types + +```py +def _(flag: bool) -> None: + if flag: + class C1: + attr: int = 0 + + else: + class C1: + attr: str = "" + + # TODO: The error message here could be improved to explain why the assignment fails. + C1.attr = 1 # error: [invalid-assignment] + + class C2: + if flag: + attr: int = 0 + else: + attr: str = "" + + # TODO: This should be an error + C2.attr = 1 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md new file mode 100644 index 0000000000000..794c29b6b96fe --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md @@ -0,0 +1,197 @@ +# Invalid argument type diagnostics + +<!-- snapshot-diagnostics --> + +## Basic + +This is a basic test demonstrating that a diagnostic points to the function definition corresponding +to the invalid argument. + +```py +def foo(x: int) -> int: + return x * x + +foo("hello") # error: [invalid-argument-type] +``` + +## Different source order + +This is like the basic test, except we put the call site above the function definition. + +```py +def bar(): + foo("hello") # error: [invalid-argument-type] + +def foo(x: int) -> int: + return x * x +``` + +## Different files + +This tests that a diagnostic can point to a function definition in a different file in which an +invalid call site was found. + +`package.py`: + +```py +def foo(x: int) -> int: + return x * x +``` + +```py +import package + +package.foo("hello") # error: [invalid-argument-type] +``` + +## Many parameters + +This checks that a diagnostic renders reasonably when there are multiple parameters. + +```py +def foo(x: int, y: int, z: int) -> int: + return x * y * z + +foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +## Many parameters across multiple lines + +This checks that a diagnostic renders reasonably when there are multiple parameters spread out +across multiple lines. + +```py +def foo( + x: int, + y: int, + z: int, +) -> int: + return x * y * z + +foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +## Many parameters with multiple invalid arguments + +This checks that a diagnostic renders reasonably when there are multiple parameters and multiple +invalid argument types. + +```py +def foo(x: int, y: int, z: int) -> int: + return x * y * z + +# error: [invalid-argument-type] +# error: [invalid-argument-type] +# error: [invalid-argument-type] +foo("a", "b", "c") +``` + +At present (2025-02-18), this renders three different diagnostic messages. But arguably, these could +all be folded into one diagnostic. Fixing this requires at least better support for multi-spans in +the diagnostic model and possibly also how diagnostics are emitted by the type checker itself. + +## Test calling a function whose type is vendored from `typeshed` + +This tests that diagnostic rendering is reasonable when the function being called is from the +standard library. + +```py +import json + +json.loads(5) # error: [invalid-argument-type] +``` + +## Tests for a variety of argument types + +These tests check that diagnostic output is reasonable regardless of the kinds of arguments used in +a function definition. + +### Only positional + +Tests a function definition with only positional parameters. + +```py +def foo(x: int, y: int, z: int, /) -> int: + return x * y * z + +foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +### Variadic arguments + +Tests a function definition with variadic arguments. + +```py +def foo(*numbers: int) -> int: + return len(numbers) + +foo(1, 2, 3, "hello", 5) # error: [invalid-argument-type] +``` + +### Keyword only arguments + +Tests a function definition with keyword-only arguments. + +```py +def foo(x: int, y: int, *, z: int = 0) -> int: + return x * y * z + +foo(1, 2, z="hello") # error: [invalid-argument-type] +``` + +### One keyword argument + +Tests a function definition with keyword-only arguments. + +```py +def foo(x: int, y: int, z: int = 0) -> int: + return x * y * z + +foo(1, 2, "hello") # error: [invalid-argument-type] +``` + +### Variadic keyword arguments + +```py +def foo(**numbers: int) -> int: + return len(numbers) + +foo(a=1, b=2, c=3, d="hello", e=5) # error: [invalid-argument-type] +``` + +### Mix of arguments + +Tests a function definition with multiple different kinds of arguments. + +```py +def foo(x: int, /, y: int, *, z: int = 0) -> int: + return x * y * z + +foo(1, 2, z="hello") # error: [invalid-argument-type] +``` + +### Synthetic arguments + +Tests a function call with synthetic arguments. + +```py +class C: + def __call__(self, x: int) -> int: + return 1 + +c = C() +c("wrong") # error: [invalid-argument-type] +``` + +## Calls to methods + +Tests that we also see a reference to a function if the callable is a bound method. + +```py +class C: + def square(self, x: int) -> int: + return x * x + +c = C() +c.square("hello") # error: [invalid-argument-type] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md new file mode 100644 index 0000000000000..19627f8351043 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md @@ -0,0 +1,306 @@ +# No matching overload diagnostics + +<!-- snapshot-diagnostics --> + +## Calls to overloaded functions + +```py +from typing import overload + +@overload +def f(x: int) -> int: ... +@overload +def f(x: str) -> str: ... +def f(x: int | str) -> int | str: + return x + +f(b"foo") # error: [no-matching-overload] +``` + +## Call to function with many unmatched overloads + +Note that it would be fine to use `pow` here as an example of a routine with many overloads, but at +time of writing (2025-05-14), ty doesn't support some of the type signatures of those overloads. +Which in turn makes snapshotting a bit annoying, since the output can depend on how ty is compiled +(because of how `Todo` types are dealt with when `debug_assertions` is enabled versus disabled). + +```py +from typing import overload + +class Foo: ... + +@overload +def foo(a: int, b: int, c: int): ... +@overload +def foo(a: str, b: int, c: int): ... +@overload +def foo(a: int, b: str, c: int): ... +@overload +def foo(a: int, b: int, c: str): ... +@overload +def foo(a: str, b: str, c: int): ... +@overload +def foo(a: int, b: str, c: str): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: int, b: int, c: int): ... +@overload +def foo(a: float, b: int, c: int): ... +@overload +def foo(a: int, b: float, c: int): ... +@overload +def foo(a: int, b: int, c: float): ... +@overload +def foo(a: float, b: float, c: int): ... +@overload +def foo(a: int, b: float, c: float): ... +@overload +def foo(a: float, b: float, c: float): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: float, b: str, c: str): ... +@overload +def foo(a: str, b: float, c: str): ... +@overload +def foo(a: str, b: str, c: float): ... +@overload +def foo(a: float, b: float, c: str): ... +@overload +def foo(a: str, b: float, c: float): ... +@overload +def foo(a: float, b: float, c: float): ... +def foo(a, b, c): ... + +foo(Foo(), Foo()) # error: [no-matching-overload] +``` + +## Call to function with too many unmatched overloads + +This is like the above example, but has an excessive number of overloads to the point that ty will +cut off the list in the diagnostic and emit a message stating the number of omitted overloads. + +```py +from typing import overload + +class Foo: ... + +@overload +def foo(a: int, b: int, c: int): ... +@overload +def foo(a: str, b: int, c: int): ... +@overload +def foo(a: int, b: str, c: int): ... +@overload +def foo(a: int, b: int, c: str): ... +@overload +def foo(a: str, b: str, c: int): ... +@overload +def foo(a: int, b: str, c: str): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: int, b: int, c: int): ... +@overload +def foo(a: float, b: int, c: int): ... +@overload +def foo(a: int, b: float, c: int): ... +@overload +def foo(a: int, b: int, c: float): ... +@overload +def foo(a: float, b: float, c: int): ... +@overload +def foo(a: int, b: float, c: float): ... +@overload +def foo(a: float, b: float, c: float): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: float, b: str, c: str): ... +@overload +def foo(a: str, b: float, c: str): ... +@overload +def foo(a: str, b: str, c: float): ... +@overload +def foo(a: float, b: float, c: str): ... +@overload +def foo(a: str, b: float, c: float): ... +@overload +def foo(a: float, b: float, c: float): ... +@overload +def foo(a: list[int], b: list[int], c: list[int]): ... +@overload +def foo(a: list[str], b: list[int], c: list[int]): ... +@overload +def foo(a: list[int], b: list[str], c: list[int]): ... +@overload +def foo(a: list[int], b: list[int], c: list[str]): ... +@overload +def foo(a: list[str], b: list[str], c: list[int]): ... +@overload +def foo(a: list[int], b: list[str], c: list[str]): ... +@overload +def foo(a: list[str], b: list[str], c: list[str]): ... +@overload +def foo(a: list[int], b: list[int], c: list[int]): ... +@overload +def foo(a: list[float], b: list[int], c: list[int]): ... +@overload +def foo(a: list[int], b: list[float], c: list[int]): ... +@overload +def foo(a: list[int], b: list[int], c: list[float]): ... +@overload +def foo(a: list[float], b: list[float], c: list[int]): ... +@overload +def foo(a: list[int], b: list[float], c: list[float]): ... +@overload +def foo(a: list[float], b: list[float], c: list[float]): ... +@overload +def foo(a: list[str], b: list[str], c: list[str]): ... +@overload +def foo(a: list[float], b: list[str], c: list[str]): ... +@overload +def foo(a: list[str], b: list[float], c: list[str]): ... +@overload +def foo(a: list[str], b: list[str], c: list[float]): ... +@overload +def foo(a: list[float], b: list[float], c: list[str]): ... +@overload +def foo(a: list[str], b: list[float], c: list[float]): ... +@overload +def foo(a: list[float], b: list[float], c: list[float]): ... +@overload +def foo(a: bool, b: bool, c: bool): ... +@overload +def foo(a: str, b: bool, c: bool): ... +@overload +def foo(a: bool, b: str, c: bool): ... +@overload +def foo(a: bool, b: bool, c: str): ... +@overload +def foo(a: str, b: str, c: bool): ... +@overload +def foo(a: bool, b: str, c: str): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: int, b: int, c: int): ... +@overload +def foo(a: bool, b: int, c: int): ... +@overload +def foo(a: int, b: bool, c: int): ... +@overload +def foo(a: int, b: int, c: bool): ... +@overload +def foo(a: bool, b: bool, c: int): ... +@overload +def foo(a: int, b: bool, c: bool): ... +@overload +def foo(a: str, b: str, c: str): ... +@overload +def foo(a: float, b: bool, c: bool): ... +@overload +def foo(a: bool, b: float, c: bool): ... +@overload +def foo(a: bool, b: bool, c: float): ... +@overload +def foo(a: float, b: float, c: bool): ... +@overload +def foo(a: bool, b: float, c: float): ... +def foo(a, b, c): ... + +foo(Foo(), Foo()) # error: [no-matching-overload] +``` + +## Calls to overloaded functions with lots of parameters + +```py +from typing import overload + +@overload +def f( + lion: int, + turtle: int, + tortoise: int, + goat: int, + capybara: int, + chicken: int, + ostrich: int, + gorilla: int, + giraffe: int, + condor: int, + kangaroo: int, + anaconda: int, + tarantula: int, + millipede: int, + leopard: int, + hyena: int, +) -> int: ... +@overload +def f( + lion: str, + turtle: str, + tortoise: str, + goat: str, + capybara: str, + chicken: str, + ostrich: str, + gorilla: str, + giraffe: str, + condor: str, + kangaroo: str, + anaconda: str, + tarantula: str, + millipede: str, + leopard: str, + hyena: str, +) -> str: ... +def f( + lion: int | str, + turtle: int | str, + tortoise: int | str, + goat: int | str, + capybara: int | str, + chicken: int | str, + ostrict: int | str, + gorilla: int | str, + giraffe: int | str, + condor: int | str, + kangaroo: int | str, + anaconda: int | str, + tarantula: int | str, + millipede: int | str, + leopard: int | str, + hyena: int | str, +) -> int | str: + return 0 + +f(b"foo") # error: [no-matching-overload] +``` + +## A method call with unmatched overloads + +```py +from typing import overload + +class Foo: + @overload + def bar(self, x: int) -> int: ... + @overload + def bar(self, x: str) -> str: ... + def bar(self, x: int | str) -> int | str: + return x + +foo = Foo() +foo.bar(b"wat") # error: [no-matching-overload] +``` + +## A class constructor with unmatched overloads + +TODO: At time of writing (2025-05-15), this has non-ideal diagnostics that doesn't show the +unmatched overloads. + +```py +type() # error: [no-matching-overload] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/semantic_syntax_errors.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/semantic_syntax_errors.md new file mode 100644 index 0000000000000..0edba939b5f87 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/semantic_syntax_errors.md @@ -0,0 +1,349 @@ +# Semantic syntax error diagnostics + +## `async` comprehensions in synchronous comprehensions + +### Python 3.10 + +<!-- snapshot-diagnostics --> + +Before Python 3.11, `async` comprehensions could not be used within outer sync comprehensions, even +within an `async` function ([CPython issue](https://github.com/python/cpython/issues/77527)): + +```toml +[environment] +python-version = "3.10" +``` + +```py +async def elements(n): + yield n + +async def f(): + # error: 19 [invalid-syntax] "cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11)" + return {n: [x async for x in elements(n)] for n in range(3)} +``` + +If all of the comprehensions are `async`, on the other hand, the code was still valid: + +```py +async def test(): + return [[x async for x in elements(n)] async for n in range(3)] +``` + +These are a couple of tricky but valid cases to check that nested scope handling is wired up +correctly in the `SemanticSyntaxContext` trait: + +```py +async def f(): + [x for x in [1]] and [x async for x in elements(1)] + +async def f(): + def g(): + pass + [x async for x in elements(1)] +``` + +### Python 3.11 + +All of these same examples are valid after Python 3.11: + +```toml +[environment] +python-version = "3.11" +``` + +```py +async def elements(n): + yield n + +async def f(): + return {n: [x async for x in elements(n)] for n in range(3)} +``` + +## Late `__future__` import + +```py +from collections import namedtuple + +# error: [invalid-syntax] "__future__ imports must be at the top of the file" +from __future__ import print_function +``` + +## Invalid annotation + +This one might be a bit redundant with the `invalid-type-form` error. + +```toml +[environment] +python-version = "3.12" +``` + +```py +from __future__ import annotations + +# error: [invalid-type-form] "Named expressions are not allowed in type expressions" +# error: [invalid-syntax] "named expression cannot be used within a type annotation" +def f() -> (y := 3): ... +``` + +## Duplicate `match` key + +```toml +[environment] +python-version = "3.10" +``` + +```py +match 2: + # error: [invalid-syntax] "mapping pattern checks duplicate key `"x"`" + case {"x": 1, "x": 2}: + ... +``` + +## Duplicate `match` class attribute + +Attribute names in class patterns must be unique: + +```toml +[environment] +python-version = "3.10" +``` + +```py +class Point: + pass + +obj = Point() +match obj: + # error: [invalid-syntax] "attribute name `x` repeated in class pattern" + case Point(x=1, x=2): + pass +``` + +## `return`, `yield`, `yield from`, and `await` outside function + +```py +# error: [invalid-syntax] "`return` statement outside of a function" +return + +# error: [invalid-syntax] "`yield` statement outside of a function" +yield + +# error: [invalid-syntax] "`yield from` statement outside of a function" +yield from [] + +# error: [invalid-syntax] "`await` statement outside of a function" +# error: [invalid-syntax] "`await` outside of an asynchronous function" +await 1 + +def f(): + # error: [invalid-syntax] "`await` outside of an asynchronous function" + await 1 +``` + +Generators are evaluated lazily, so `await` is allowed, even outside of a function. + +```py +async def g(): + yield 1 + +(x async for x in g()) +``` + +## Rebound comprehension variable + +Walrus operators cannot rebind variables already in use as iterators: + +```py +# error: [invalid-syntax] "assignment expression cannot rebind comprehension variable" +[x := 2 for x in range(10)] + +# error: [invalid-syntax] "assignment expression cannot rebind comprehension variable" +{y := 5 for y in range(10)} +``` + +## Multiple case assignments + +Variable names in pattern matching must be unique within a single pattern: + +```toml +[environment] +python-version = "3.10" +``` + +```py +x = [1, 2] +match x: + # error: [invalid-syntax] "multiple assignments to name `a` in pattern" + case [a, a]: + pass + case _: + pass + +d = {"key": "value"} +match d: + # error: [invalid-syntax] "multiple assignments to name `b` in pattern" + case {"key": b, "other": b}: + pass +``` + +## Duplicate type parameter + +Type parameter names must be unique in a generic class or function definition: + +```toml +[environment] +python-version = "3.12" +``` + +```py +# error: [invalid-syntax] "duplicate type parameter" +class C[T, T]: + pass + +# error: [invalid-syntax] "duplicate type parameter" +def f[X, Y, X](): + pass +``` + +## Invalid star expression + +Star expressions can't be used in certain contexts: + +```py +def func(): + # error: [invalid-syntax] "Starred expression cannot be used here" + return *[1, 2, 3] + +def gen(): + # error: [invalid-syntax] "Starred expression cannot be used here" + yield * [1, 2, 3] + +# error: [invalid-syntax] "Starred expression cannot be used here" +for *x in range(10): + pass + +# error: [invalid-syntax] "Starred expression cannot be used here" +for x in *range(10): + pass +``` + +## Irrefutable case pattern + +Irrefutable patterns, i.e. wildcard or capture patterns, must be the last case in a match statement. +Following case statements are unreachable. + +```toml +[environment] +python-version = "3.12" +``` + +```py +value = 5 + +match value: + # error: [invalid-syntax] "wildcard makes remaining patterns unreachable" + case _: # Irrefutable wildcard pattern + pass + case 5: + pass + +match value: + # error: [invalid-syntax] "name capture `variable` makes remaining patterns unreachable" + case variable: # Irrefutable capture pattern + pass + case 10: + pass +``` + +## Single starred assignment + +Starred assignment targets cannot appear by themselves. They must be in the context of a list or +tuple. + +```py +# error: [invalid-syntax] "starred assignment target must be in a list or tuple" +*a = [1, 2, 3, 4] +``` + +## Write to debug + +The special Python builtin `__debug__` should not be modified. + +```toml +[environment] +python-version = "3.12" +``` + +```py +# error: [invalid-syntax] "cannot assign to `__debug__`" +__debug__ = False + +# error: [invalid-syntax] "cannot assign to `__debug__`" +def process(__debug__): + pass + +# error: [invalid-syntax] "cannot assign to `__debug__`" +class Generic[__debug__]: + pass +``` + +## Invalid expression + +Certain expressions like `yield` or inlined walrus assignments are not valid in specific contexts. + +```toml +[environment] +python-version = "3.12" +``` + +```py +def _(): + # error: [invalid-type-form] "`yield` expressions are not allowed in type expressions" + # error: [invalid-syntax] "yield expression cannot be used within a TypeVar bound" + type X[T: (yield 1)] = int + +def _(): + # error: [invalid-type-form] "`yield` expressions are not allowed in type expressions" + # error: [invalid-syntax] "yield expression cannot be used within a type alias" + type Y = (yield 1) + +# error: [invalid-type-form] "Named expressions are not allowed in type expressions" +# error: [invalid-syntax] "named expression cannot be used within a generic definition" +def f[T](x: int) -> (y := 3): + return x + +def _(): + # error: [invalid-syntax] "yield expression cannot be used within a generic definition" + class C[T]((yield from [object])): + pass +``` + +## `await` outside async function + +This error includes `await`, `async for`, `async with`, and `async` comprehensions. + +```py +async def elements(n): + yield n + +def _(): + # error: [invalid-syntax] "`await` outside of an asynchronous function" + await 1 + # error: [invalid-syntax] "`async for` outside of an asynchronous function" + async for _ in elements(1): + ... + # error: [invalid-syntax] "`async with` outside of an asynchronous function" + async with elements(1) as x: + ... + # error: [invalid-syntax] "asynchronous comprehension outside of an asynchronous function" + [x async for x in elements(1)] +``` + +## Load before `global` declaration + +```py +def f(): + x = 1 + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/shadowing.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/shadowing.md new file mode 100644 index 0000000000000..c63631c1e43a7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/shadowing.md @@ -0,0 +1,19 @@ +# Shadowing + +<!-- snapshot-diagnostics --> + +## Implicit class shadowing + +```py +class C: ... + +C = 1 # error: [invalid-assignment] +``` + +## Implicit function shadowing + +```py +def f(): ... + +f = 1 # error: [invalid-assignment] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md new file mode 100644 index 0000000000000..e009c137a3fc6 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md @@ -0,0 +1,128 @@ +# Calling a union of function types + +<!-- snapshot-diagnostics --> + +```toml +[environment] +python-version = "3.12" +``` + +## A smaller scale example + +```py +def f1() -> int: + return 0 + +def f2(name: str) -> int: + return 0 + +def _(flag: bool): + if flag: + f = f1 + else: + f = f2 + # error: [too-many-positional-arguments] + # error: [invalid-argument-type] + x = f(3) +``` + +## Multiple variants but only one is invalid + +This test in particular demonstrates some of the smarts of this diagnostic. Namely, since only one +variant is invalid, additional context specific to that variant is added to the diagnostic output. +(If more than one variant is invalid, then this additional context is elided to avoid overwhelming +the end user.) + +```py +def f1(a: int) -> int: + return 0 + +def f2(name: str) -> int: + return 0 + +def _(flag: bool): + if flag: + f = f1 + else: + f = f2 + # error: [invalid-argument-type] + x = f(3) +``` + +## Try to cover all possible reasons + +These tests is likely to become stale over time, but this was added when the union-specific +diagnostic was initially created. In each test, we try to cover as much as we can. This is mostly +just ensuring that we get test coverage for each of the possible diagnostic messages. + +### Cover non-keyword related reasons + +```py +from inspect import getattr_static + +def f1() -> int: + return 0 + +def f2(name: str) -> int: + return 0 + +def f3(a: int, b: int) -> int: + return 0 + +def f4[T: str](x: T) -> int: + return 0 + +class OverloadExample: + def f(self, x: str) -> int: + return 0 + +f5 = getattr_static(OverloadExample, "f").__get__ + +def _(n: int): + class PossiblyNotCallable: + if n == 0: + def __call__(self) -> int: + return 0 + + if n == 0: + f = f1 + elif n == 1: + f = f2 + elif n == 2: + f = f3 + elif n == 3: + f = f4 + elif n == 4: + f = 5 + elif n == 5: + f = f5 + else: + f = PossiblyNotCallable() + # error: [too-many-positional-arguments] + # error: [invalid-argument-type] "Argument to function `f2` is incorrect: Expected `str`, found `Literal[3]`" + # error: [missing-argument] + # error: [invalid-argument-type] "Argument to function `f4` is incorrect: Argument type `Literal[3]` does not satisfy upper bound of type variable `T`" + # error: [call-non-callable] "Object of type `Literal[5]` is not callable" + # error: [no-matching-overload] + # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" + x = f(3) +``` + +### Cover keyword argument related reasons + +```py +def any(*args, **kwargs) -> int: + return 0 + +def f1(name: str) -> int: + return 0 + +def _(n: int): + if n == 0: + f = f1 + else: + f = any + # error: [parameter-already-assigned] + # error: [unknown-argument] + y = f("foo", name="bar", unknown="quux") +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md new file mode 100644 index 0000000000000..3c731106f332c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md @@ -0,0 +1,27 @@ +# Unpacking + +<!-- snapshot-diagnostics --> + +## Right hand side not iterable + +```py +a, b = 1 # error: [not-iterable] +``` + +## Exactly too many values to unpack + +```py +a, b = (1, 2, 3) # error: [invalid-assignment] +``` + +## Exactly too few values to unpack + +```py +a, b = (1,) # error: [invalid-assignment] +``` + +## Too few values to unpack + +```py +[a, *b, c, d] = (1, 2) # error: [invalid-assignment] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md new file mode 100644 index 0000000000000..c07a3a2067141 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md @@ -0,0 +1,87 @@ +# Unresolved import diagnostics + +<!-- snapshot-diagnostics --> + +## Using `from` with an unresolvable module + +This example demonstrates the diagnostic when a `from` style import is used with a module that could +not be found: + +```py +from does_not_exist import add # error: [unresolved-import] + +stat = add(10, 15) +``` + +## Using `from` with too many leading dots + +This example demonstrates the diagnostic when a `from` style import is used with a presumptively +valid path, but where there are too many leading dots. + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +def add(x, y): + return x + y +``` + +`package/subpackage/subsubpackage/__init__.py`: + +```py +from ....foo import add # error: [unresolved-import] + +stat = add(10, 15) +``` + +## Using `from` with an unknown current module + +This is another case handled separately in ty, where a `.` provokes relative module name resolution, +but where the module name is not resolvable. + +```py +from .does_not_exist import add # error: [unresolved-import] + +stat = add(10, 15) +``` + +## Using `from` with an unknown nested module + +Like the previous test, but with sub-modules to ensure the span is correct. + +```py +from .does_not_exist.foo.bar import add # error: [unresolved-import] + +stat = add(10, 15) +``` + +## Using `from` with a resolvable module but unresolvable item + +This ensures that diagnostics for an unresolvable item inside a resolvable import highlight the item +and not the entire `from ... import ...` statement. + +`a.py`: + +```py +does_exist1 = 1 +does_exist2 = 2 +``` + +```py +from a import does_exist1, does_not_exist, does_exist2 # error: [unresolved-import] +``` + +## An unresolvable import that does not use `from` + +This ensures that an unresolvable `import ...` statement highlights just the module name and not the +entire statement. + +```py +import does_not_exist # error: [unresolved-import] + +x = does_not_exist.foo +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_reference.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_reference.md new file mode 100644 index 0000000000000..6be987a4e2eb4 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_reference.md @@ -0,0 +1,14 @@ +# Diagnostics for unresolved references + +## New builtin used on old Python version + +<!-- snapshot-diagnostics --> + +```toml +[environment] +python-version = "3.9" +``` + +```py +aiter # error: [unresolved-reference] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md new file mode 100644 index 0000000000000..9cb91b89fdaff --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md @@ -0,0 +1,61 @@ +<!-- snapshot-diagnostics --> + +# Different ways that `unsupported-bool-conversion` can occur + +## Has a `__bool__` method, but has incorrect parameters + +```py +class NotBoolable: + def __bool__(self, foo): + return False + +a = NotBoolable() + +# error: [unsupported-bool-conversion] +10 and a and True +``` + +## Has a `__bool__` method, but has an incorrect return type + +```py +class NotBoolable: + def __bool__(self) -> str: + return "wat" + +a = NotBoolable() + +# error: [unsupported-bool-conversion] +10 and a and True +``` + +## Has a `__bool__` attribute, but it's not callable + +```py +class NotBoolable: + __bool__: int = 3 + +a = NotBoolable() + +# error: [unsupported-bool-conversion] +10 and a and True +``` + +## Part of a union where at least one member has incorrect `__bool__` method + +```py +class NotBoolable1: + def __bool__(self) -> str: + return "wat" + +class NotBoolable2: + pass + +class NotBoolable3: + __bool__: int = 3 + +def get() -> NotBoolable1 | NotBoolable2 | NotBoolable3: + return NotBoolable2() + +# error: [unsupported-bool-conversion] +10 and get() and True +``` diff --git a/crates/ty_python_semantic/resources/mdtest/diagnostics/version_related_syntax_errors.md b/crates/ty_python_semantic/resources/mdtest/diagnostics/version_related_syntax_errors.md new file mode 100644 index 0000000000000..0a35fe4153c00 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/diagnostics/version_related_syntax_errors.md @@ -0,0 +1,37 @@ +# Version-related syntax error diagnostics + +## `match` statement + +The `match` statement was introduced in Python 3.10. + +### Before 3.10 + +<!-- snapshot-diagnostics --> + +We should emit a syntax error before 3.10. + +```toml +[environment] +python-version = "3.9" +``` + +```py +match 2: # error: 1 [invalid-syntax] "Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10)" + case 1: + print("it's one") +``` + +### After 3.10 + +On or after 3.10, no error should be reported. + +```toml +[environment] +python-version = "3.10" +``` + +```py +match 2: + case 1: + print("it's one") +``` diff --git a/crates/ty_python_semantic/resources/mdtest/directives/assert_never.md b/crates/ty_python_semantic/resources/mdtest/directives/assert_never.md new file mode 100644 index 0000000000000..958f2c04f905b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/directives/assert_never.md @@ -0,0 +1,113 @@ +# `assert_never` + +## Basic functionality + +<!-- snapshot-diagnostics --> + +`assert_never` makes sure that the type of the argument is `Never`. If it is not, a +`type-assertion-failure` diagnostic is emitted. + +```py +from typing_extensions import assert_never, Never, Any +from ty_extensions import Unknown + +def _(never: Never, any_: Any, unknown: Unknown, flag: bool): + assert_never(never) # fine + + assert_never(0) # error: [type-assertion-failure] + assert_never("") # error: [type-assertion-failure] + assert_never(None) # error: [type-assertion-failure] + assert_never([]) # error: [type-assertion-failure] + assert_never({}) # error: [type-assertion-failure] + assert_never(()) # error: [type-assertion-failure] + assert_never(1 if flag else never) # error: [type-assertion-failure] + + assert_never(any_) # error: [type-assertion-failure] + assert_never(unknown) # error: [type-assertion-failure] +``` + +## Use case: Type narrowing and exhaustiveness checking + +```toml +[environment] +python-version = "3.10" +``` + +`assert_never` can be used in combination with type narrowing as a way to make sure that all cases +are handled in a series of `isinstance` checks or other narrowing patterns that are supported. + +```py +from typing_extensions import assert_never, Literal + +class A: ... +class B: ... +class C: ... + +def if_else_isinstance_success(obj: A | B): + if isinstance(obj, A): + pass + elif isinstance(obj, B): + pass + elif isinstance(obj, C): + pass + else: + assert_never(obj) + +def if_else_isinstance_error(obj: A | B): + if isinstance(obj, A): + pass + # B is missing + elif isinstance(obj, C): + pass + else: + # error: [type-assertion-failure] "Argument does not have asserted type `Never`" + assert_never(obj) + +def if_else_singletons_success(obj: Literal[1, "a"] | None): + if obj == 1: + pass + elif obj == "a": + pass + elif obj is None: + pass + else: + assert_never(obj) + +def if_else_singletons_error(obj: Literal[1, "a"] | None): + if obj == 1: + pass + elif obj is "A": # "A" instead of "a" + pass + elif obj is None: + pass + else: + # error: [type-assertion-failure] "Argument does not have asserted type `Never`" + assert_never(obj) + +def match_singletons_success(obj: Literal[1, "a"] | None): + match obj: + case 1: + pass + case "a": + pass + case None: + pass + case _ as obj: + # TODO: Ideally, we would not emit an error here + # error: [type-assertion-failure] "Argument does not have asserted type `Never`" + assert_never(obj) + +def match_singletons_error(obj: Literal[1, "a"] | None): + match obj: + case 1: + pass + case "A": # "A" instead of "a" + pass + case None: + pass + case _ as obj: + # TODO: We should emit an error here, but the message should + # show the type `Literal["a"]` instead of `@Todo(…)`. + # error: [type-assertion-failure] "Argument does not have asserted type `Never`" + assert_never(obj) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/directives/assert_type.md b/crates/ty_python_semantic/resources/mdtest/directives/assert_type.md new file mode 100644 index 0000000000000..07ad5d555b07e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/directives/assert_type.md @@ -0,0 +1,140 @@ +# `assert_type` + +## Basic + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import assert_type + +def _(x: int): + assert_type(x, int) # fine + assert_type(x, str) # error: [type-assertion-failure] +``` + +## Narrowing + +The asserted type is checked against the inferred type, not the declared type. + +```toml +[environment] +python-version = "3.10" +``` + +```py +from typing_extensions import assert_type + +def _(x: int | str): + if isinstance(x, int): + reveal_type(x) # revealed: int + assert_type(x, int) # fine +``` + +## Equivalence + +The actual type must match the asserted type precisely. + +```py +from typing import Any, Type, Union +from typing_extensions import assert_type + +# Subtype does not count +def _(x: bool): + assert_type(x, int) # error: [type-assertion-failure] + +def _(a: type[int], b: type[Any]): + assert_type(a, type[Any]) # error: [type-assertion-failure] + assert_type(b, type[int]) # error: [type-assertion-failure] + +# The expression constructing the type is not taken into account +def _(a: type[int]): + assert_type(a, Type[int]) # fine +``` + +## Gradual types + +```py +from typing import Any +from typing_extensions import Literal, assert_type + +from ty_extensions import Unknown + +# Any and Unknown are considered equivalent +def _(a: Unknown, b: Any): + reveal_type(a) # revealed: Unknown + assert_type(a, Any) # fine + + reveal_type(b) # revealed: Any + assert_type(b, Unknown) # fine + +def _(a: type[Unknown], b: type[Any]): + reveal_type(a) # revealed: type[Unknown] + assert_type(a, type[Any]) # fine + + reveal_type(b) # revealed: type[Any] + assert_type(b, type[Unknown]) # fine +``` + +## Tuples + +Tuple types with the same elements are the same. + +```py +from typing_extensions import Any, assert_type + +from ty_extensions import Unknown + +def _(a: tuple[int, str, bytes]): + assert_type(a, tuple[int, str, bytes]) # fine + + assert_type(a, tuple[int, str]) # error: [type-assertion-failure] + assert_type(a, tuple[int, str, bytes, None]) # error: [type-assertion-failure] + assert_type(a, tuple[int, bytes, str]) # error: [type-assertion-failure] + +def _(a: tuple[Any, ...], b: tuple[Unknown, ...]): + assert_type(a, tuple[Any, ...]) # fine + assert_type(a, tuple[Unknown, ...]) # fine + + assert_type(b, tuple[Unknown, ...]) # fine + assert_type(b, tuple[Any, ...]) # fine +``` + +## Unions + +Unions with the same elements are the same, regardless of order. + +```toml +[environment] +python-version = "3.10" +``` + +```py +from typing_extensions import assert_type + +def _(a: str | int): + assert_type(a, str | int) + assert_type(a, int | str) +``` + +## Intersections + +Intersections are the same when their positive and negative parts are respectively the same, +regardless of order. + +```py +from typing_extensions import assert_type + +from ty_extensions import Intersection, Not + +class A: ... +class B: ... +class C: ... +class D: ... + +def _(a: A): + if isinstance(a, B) and not isinstance(a, C) and not isinstance(a, D): + reveal_type(a) # revealed: A & B & ~C & ~D + + assert_type(a, Intersection[A, B, Not[C], Not[D]]) + assert_type(a, Intersection[B, A, Not[D], Not[C]]) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/directives/cast.md b/crates/ty_python_semantic/resources/mdtest/directives/cast.md new file mode 100644 index 0000000000000..6943eceee6c9b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/directives/cast.md @@ -0,0 +1,80 @@ +# `cast` + +`cast()` takes two arguments, one type and one value, and returns a value of the given type. + +The (inferred) type of the value and the given type do not need to have any correlation. + +```py +from typing import Literal, cast, Any + +reveal_type(True) # revealed: Literal[True] +reveal_type(cast(str, True)) # revealed: str +reveal_type(cast("str", True)) # revealed: str + +reveal_type(cast(int | str, 1)) # revealed: int | str + +reveal_type(cast(val="foo", typ=int)) # revealed: int + +# error: [invalid-type-form] +reveal_type(cast(Literal, True)) # revealed: Unknown + +# error: [invalid-type-form] +reveal_type(cast(1, True)) # revealed: Unknown + +# error: [missing-argument] "No argument provided for required parameter `val` of function `cast`" +cast(str) +# error: [too-many-positional-arguments] "Too many positional arguments to function `cast`: expected 2, got 3" +cast(str, b"ar", "foo") + +def function_returning_int() -> int: + return 10 + +# error: [redundant-cast] "Value is already of type `int`" +cast(int, function_returning_int()) + +def function_returning_any() -> Any: + return "blah" + +# error: [redundant-cast] "Value is already of type `Any`" +cast(Any, function_returning_any()) +``` + +Complex type expressions (which may be unsupported) do not lead to spurious `[redundant-cast]` +diagnostics. + +```py +from typing import Callable + +def f(x: Callable[[dict[str, int]], None], y: tuple[dict[str, int]]): + a = cast(Callable[[list[bytes]], None], x) + b = cast(tuple[list[bytes]], y) +``` + +A cast from `Todo` or `Unknown` to `Any` is not considered a "redundant cast": even if these are +understood as gradually equivalent types by ty, they are understood as different types by human +readers of ty's output. For `Unknown` in particular, we may consider it differently in the context +of some opt-in diagnostics, as it indicates that the gradual type has come about due to an invalid +annotation, missing annotation or missing type argument somewhere. + +A cast from `Unknown` to `Todo` or `Any` is also not considered a "redundant cast", as this breaks +the gradual guarantee and leads to cascading errors when an object is inferred as having type +`Unknown` due to a missing import or similar. + +```py +from ty_extensions import Unknown + +def f(x: Any, y: Unknown, z: Any | str | int): + a = cast(dict[str, Any], x) + reveal_type(a) # revealed: dict[str, Any] + + b = cast(Any, y) + reveal_type(b) # revealed: Any + + c = cast(Unknown, y) + reveal_type(c) # revealed: Unknown + + d = cast(Unknown, x) + reveal_type(d) # revealed: Unknown + + e = cast(str | int | Any, z) # error: [redundant-cast] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/doc/README.md b/crates/ty_python_semantic/resources/mdtest/doc/README.md new file mode 100644 index 0000000000000..0168c8339c2e7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/doc/README.md @@ -0,0 +1,2 @@ +This directory contains user-facing documentation, but also doubles as an extended test suite that +makes sure that our documentation stays up to date. diff --git a/crates/ty_python_semantic/resources/mdtest/doc/public_type_undeclared_symbols.md b/crates/ty_python_semantic/resources/mdtest/doc/public_type_undeclared_symbols.md new file mode 100644 index 0000000000000..50e73bef0f928 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/doc/public_type_undeclared_symbols.md @@ -0,0 +1,125 @@ +# Public type of undeclared symbols + +## Summary + +One major deviation from the behavior of existing Python type checkers is our handling of 'public' +types for undeclared symbols. This is best illustrated with an example: + +```py +class Wrapper: + value = None + +wrapper = Wrapper() + +reveal_type(wrapper.value) # revealed: Unknown | None + +wrapper.value = 1 +``` + +Mypy and Pyright both infer a type of `None` for the type of `wrapper.value`. Consequently, both +tools emit an error when trying to assign `1` to `wrapper.value`. But there is nothing wrong with +this program. Emitting an error here violates the [gradual guarantee] which states that *"Removing +type annotations (making the program more dynamic) should not result in additional static type +errors."*: If `value` were annotated with `int | None` here, Mypy and Pyright would not emit any +errors. + +By inferring `Unknown | None` instead, we allow arbitrary values to be assigned to `wrapper.value`. +This is a deliberate choice to prevent false positive errors on untyped code. + +More generally, we infer `Unknown | T_inferred` for undeclared symbols, where `T_inferred` is the +inferred type of the right-hand side of the assignment. This gradual type represents an *unknown* +fully-static type that is *at least as large as* `T_inferred`. It accurately describes our static +knowledge about this type. In the example above, we don't know what values `wrapper.value` could +possibly contain, but we *do know* that `None` is a possibility. This allows us to catch errors +where `wrapper.value` is used in a way that is incompatible with `None`: + +```py +def accepts_int(i: int) -> None: + pass + +def f(w: Wrapper) -> None: + # This is fine + v: int | None = w.value + + # This function call is incorrect, because `w.value` could be `None`. We therefore emit the following + # error: "Argument to function `accepts_int` is incorrect: Expected `int`, found `Unknown | None`" + c = accepts_int(w.value) +``` + +## Explicit lack of knowledge + +The following example demonstrates how Mypy and Pyright's type inference of fully-static types in +these situations can lead to false-negatives, even though everything appears to be (statically) +typed. To make this a bit more realistic, imagine that `OptionalInt` is imported from an external, +untyped module: + +`optional_int.py`: + +```py +class OptionalInt: + value = 10 + +def reset(o): + o.value = None +``` + +It is then used like this: + +```py +from optional_int import OptionalInt, reset + +o = OptionalInt() +reset(o) # Oh no... + +# Mypy and Pyright infer a fully-static type of `int` here, which appears to make the +# subsequent division operation safe -- but it is not. We infer the following type: +reveal_type(o.value) # revealed: Unknown | Literal[10] + +print(o.value // 2) # Runtime error! +``` + +We do not catch this mistake either, but we accurately reflect our lack of knowledge about +`o.value`. Together with a possible future type-checker mode that would detect the prevalence of +dynamic types, this could help developers catch such mistakes. + +## Stricter behavior + +Users can always opt in to stricter behavior by adding type annotations. For the `OptionalInt` +class, this would probably be: + +```py +class OptionalInt: + value: int | None = 10 + +o = OptionalInt() + +# The following public type is now +# revealed: int | None +reveal_type(o.value) + +# Incompatible assignments are now caught: +# error: "Object of type `Literal["a"]` is not assignable to attribute `value` of type `int | None`" +o.value = "a" +``` + +## What is meant by 'public' type? + +We apply different semantics depending on whether a symbol is accessed from the same scope in which +it was originally defined, or whether it is accessed from an external scope. External scopes will +see the symbol's "public type", which has been discussed above. But within the same scope the symbol +was defined in, we use a narrower type of `T_inferred` for undeclared symbols. This is because, from +the perspective of this scope, there is no way that the value of the symbol could have been +reassigned from external scopes. For example: + +```py +class Wrapper: + value = None + + # Type as seen from the same scope: + reveal_type(value) # revealed: None + +# Type as seen from another scope: +reveal_type(Wrapper.value) # revealed: Unknown | None +``` + +[gradual guarantee]: https://typing.python.org/en/latest/spec/concepts.html#the-gradual-guarantee diff --git a/crates/ty_python_semantic/resources/mdtest/exception/basic.md b/crates/ty_python_semantic/resources/mdtest/exception/basic.md new file mode 100644 index 0000000000000..7e4ebcd4b4c4c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/exception/basic.md @@ -0,0 +1,242 @@ +# Exception Handling + +## Single Exception + +```py +import re + +try: + help() +except NameError as e: + reveal_type(e) # revealed: NameError +except re.error as f: + reveal_type(f) # revealed: error +``` + +## Unknown type in except handler does not cause spurious diagnostic + +```py +from nonexistent_module import foo # error: [unresolved-import] + +try: + help() +except foo as e: + reveal_type(foo) # revealed: Unknown + reveal_type(e) # revealed: Unknown +``` + +## Multiple Exceptions in a Tuple + +```py +EXCEPTIONS = (AttributeError, TypeError) + +try: + help() +except (RuntimeError, OSError) as e: + reveal_type(e) # revealed: RuntimeError | OSError +except EXCEPTIONS as f: + reveal_type(f) # revealed: AttributeError | TypeError +``` + +## Dynamic exception types + +```py +def foo( + x: type[AttributeError], + y: tuple[type[OSError], type[RuntimeError]], + z: tuple[type[BaseException], ...], + zz: tuple[type[TypeError | RuntimeError], ...], + zzz: type[BaseException] | tuple[type[BaseException], ...], +): + try: + help() + except x as e: + reveal_type(e) # revealed: AttributeError + except y as f: + reveal_type(f) # revealed: OSError | RuntimeError + except z as g: + reveal_type(g) # revealed: BaseException + except zz as h: + reveal_type(h) # revealed: TypeError | RuntimeError + except zzz as i: + reveal_type(i) # revealed: BaseException +``` + +We do not emit an `invalid-exception-caught` if a class is caught that has `Any` or `Unknown` in its +MRO, as the dynamic element in the MRO could materialize to some subclass of `BaseException`: + +```py +from compat import BASE_EXCEPTION_CLASS # error: [unresolved-import] "Cannot resolve imported module `compat`" + +class Error(BASE_EXCEPTION_CLASS): ... + +try: + ... +except Error as err: + ... +``` + +## Exception with no captured type + +```py +try: + {}.get("foo") +except TypeError: + pass +``` + +## Exception which catches typevar + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing import Callable + +def silence[T: type[BaseException]]( + func: Callable[[], None], + exception_type: T, +): + try: + func() + except exception_type as e: + reveal_type(e) # revealed: T'instance + +def silence2[T: ( + type[ValueError], + type[TypeError], +)](func: Callable[[], None], exception_type: T,): + try: + func() + except exception_type as e: + reveal_type(e) # revealed: T'instance +``` + +## Invalid exception handlers + +```py +try: + pass +# error: [invalid-exception-caught] "Cannot catch object of type `Literal[3]` in an exception handler (must be a `BaseException` subclass or a tuple of `BaseException` subclasses)" +except 3 as e: + reveal_type(e) # revealed: Unknown + +try: + pass +# error: [invalid-exception-caught] "Cannot catch object of type `Literal["foo"]` in an exception handler (must be a `BaseException` subclass or a tuple of `BaseException` subclasses)" +# error: [invalid-exception-caught] "Cannot catch object of type `Literal[b"bar"]` in an exception handler (must be a `BaseException` subclass or a tuple of `BaseException` subclasses)" +except (ValueError, OSError, "foo", b"bar") as e: + reveal_type(e) # revealed: ValueError | OSError | Unknown + +def foo( + x: type[str], + y: tuple[type[OSError], type[RuntimeError], int], + z: tuple[type[str], ...], +): + try: + help() + # error: [invalid-exception-caught] + except x as e: + reveal_type(e) # revealed: Unknown + # error: [invalid-exception-caught] + except y as f: + reveal_type(f) # revealed: OSError | RuntimeError | Unknown + # error: [invalid-exception-caught] + except z as g: + reveal_type(g) # revealed: Unknown + +try: + {}.get("foo") +# error: [invalid-exception-caught] +except int: + pass +``` + +## Object raised is not an exception + +```py +try: + raise AttributeError() # fine +except: + ... + +try: + raise FloatingPointError # fine +except: + ... + +try: + raise 1 # error: [invalid-raise] +except: + ... + +try: + raise int # error: [invalid-raise] +except: + ... + +def _(e: Exception | type[Exception]): + raise e # fine + +def _(e: Exception | type[Exception] | None): + raise e # error: [invalid-raise] +``` + +## Exception cause is not an exception + +```py +def _(): + try: + raise EOFError() from GeneratorExit # fine + except: + ... + +def _(): + try: + raise StopIteration from MemoryError() # fine + except: + ... + +def _(): + try: + raise BufferError() from None # fine + except: + ... + +def _(): + try: + raise ZeroDivisionError from False # error: [invalid-raise] + except: + ... + +def _(): + try: + raise SystemExit from bool() # error: [invalid-raise] + except: + ... + +def _(): + try: + raise + except KeyboardInterrupt as e: # fine + reveal_type(e) # revealed: KeyboardInterrupt + raise LookupError from e # fine + +def _(): + try: + raise + except int as e: # error: [invalid-exception-caught] + reveal_type(e) # revealed: Unknown + raise KeyError from e + +def _(e: Exception | type[Exception]): + raise ModuleNotFoundError from e # fine + +def _(e: Exception | type[Exception] | None): + raise IndexError from e # fine + +def _(e: int | None): + raise IndexError from e # error: [invalid-raise] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/exception/control_flow.md b/crates/ty_python_semantic/resources/mdtest/exception/control_flow.md new file mode 100644 index 0000000000000..fe1e253c31757 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/exception/control_flow.md @@ -0,0 +1,611 @@ +# Control flow for exception handlers + +These tests assert that we understand the possible "definition states" (which symbols might or might +not be defined) in the various branches of a `try`/`except`/`else`/`finally` block. + +For a full writeup on the semantics of exception handlers, see [this document][1]. + +The tests throughout this Markdown document use functions with names starting with `could_raise_*` +to mark definitions that might or might not succeed (as the function could raise an exception). A +type checker must assume that any arbitrary function call could raise an exception in Python; this +is just a naming convention used in these tests for clarity, and to future-proof the tests against +possible future improvements whereby certain statements or expressions could potentially be inferred +as being incapable of causing an exception to be raised. + +## A single bare `except` + +Consider the following `try`/`except` block, with a single bare `except:`. There are different types +for the variable `x` in the two branches of this block, and we can't determine which branch might +have been taken from the perspective of code following this block. The inferred type after the +block's conclusion is therefore the union of the type at the end of the `try` suite (`str`) and the +type at the end of the `except` suite (`Literal[2]`). + +*Within* the `except` suite, we must infer a union of all possible "definition states" we could have +been in at any point during the `try` suite. This is because control flow could have jumped to the +`except` suite without any of the `try`-suite definitions successfully completing, with only *some* +of the `try`-suite definitions successfully completing, or indeed with *all* of them successfully +completing. The type of `x` at the beginning of the `except` suite in this example is therefore +`Literal[1] | str`, taking into account that we might have jumped to the `except` suite before the +`x = could_raise_returns_str()` redefinition, but we *also* could have jumped to the `except` suite +*after* that redefinition. + +```py +def could_raise_returns_str() -> str: + return "foo" + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +except: + reveal_type(x) # revealed: Literal[1] | str + x = 2 + reveal_type(x) # revealed: Literal[2] + +reveal_type(x) # revealed: str | Literal[2] +``` + +If `x` has the same type at the end of both branches, however, the branches unify and `x` is not +inferred as having a union type following the `try`/`except` block: + +```py +x = 1 + +try: + x = could_raise_returns_str() +except: + x = could_raise_returns_str() + +reveal_type(x) # revealed: str +``` + +## A non-bare `except` + +For simple `try`/`except` blocks, an `except TypeError:` handler has the same control flow semantics +as an `except:` handler. An `except TypeError:` handler will not catch *all* exceptions: if this is +the only handler, it opens up the possibility that an exception might occur that would not be +handled. However, as described in [the document on exception-handling semantics][1], that would lead +to termination of the scope. It's therefore irrelevant to consider this possibility when it comes to +control-flow analysis. + +```py +def could_raise_returns_str() -> str: + return "foo" + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +except TypeError: + reveal_type(x) # revealed: Literal[1] | str + x = 2 + reveal_type(x) # revealed: Literal[2] + +reveal_type(x) # revealed: str | Literal[2] +``` + +## Multiple `except` branches + +If the scope reaches the final `reveal_type` call in this example, either the `try`-block suite of +statements was executed in its entirety, or exactly one `except` suite was executed in its entirety. +The inferred type of `x` at this point is the union of the types at the end of the three suites: + +- At the end of `try`, `type(x) == str` +- At the end of `except TypeError`, `x == 2` +- At the end of `except ValueError`, `x == 3` + +```py +def could_raise_returns_str() -> str: + return "foo" + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +except TypeError: + reveal_type(x) # revealed: Literal[1] | str + x = 2 + reveal_type(x) # revealed: Literal[2] +except ValueError: + reveal_type(x) # revealed: Literal[1] | str + x = 3 + reveal_type(x) # revealed: Literal[3] + +reveal_type(x) # revealed: str | Literal[2, 3] +``` + +## Exception handlers with `else` branches (but no `finally`) + +If we reach the `reveal_type` call at the end of this scope, either the `try` and `else` suites were +both executed in their entireties, or the `except` suite was executed in its entirety. The type of +`x` at this point is the union of the type at the end of the `else` suite and the type at the end of +the `except` suite: + +- At the end of `else`, `x == 3` +- At the end of `except`, `x == 2` + +```py +def could_raise_returns_str() -> str: + return "foo" + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +except TypeError: + reveal_type(x) # revealed: Literal[1] | str + x = 2 + reveal_type(x) # revealed: Literal[2] +else: + reveal_type(x) # revealed: str + x = 3 + reveal_type(x) # revealed: Literal[3] + +reveal_type(x) # revealed: Literal[2, 3] +``` + +For a block that has multiple `except` branches and an `else` branch, the same principle applies. In +order to reach the final `reveal_type` call, either exactly one of the `except` suites must have +been executed in its entirety, or the `try` suite and the `else` suite must both have been executed +in their entireties: + +```py +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +except TypeError: + reveal_type(x) # revealed: Literal[1] | str + x = 2 + reveal_type(x) # revealed: Literal[2] +except ValueError: + reveal_type(x) # revealed: Literal[1] | str + x = 3 + reveal_type(x) # revealed: Literal[3] +else: + reveal_type(x) # revealed: str + x = 4 + reveal_type(x) # revealed: Literal[4] + +reveal_type(x) # revealed: Literal[2, 3, 4] +``` + +## Exception handlers with `finally` branches (but no `except` branches) + +A `finally` suite is *always* executed. As such, if we reach the `reveal_type` call at the end of +this example, we know that `x` *must* have been reassigned to `2` during the `finally` suite. The +type of `x` at the end of the example is therefore `Literal[2]`: + +```py +def could_raise_returns_str() -> str: + return "foo" + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +finally: + x = 2 + reveal_type(x) # revealed: Literal[2] + +reveal_type(x) # revealed: Literal[2] +``` + +If `x` was *not* redefined in the `finally` suite, however, things are somewhat more complicated. If +we reach the final `reveal_type` call, unlike the state when we're visiting the `finally` suite, we +know that the `try`-block suite ran to completion. This means that there are fewer possible states +at this point than there were when we were inside the `finally` block. + +(Our current model does *not* correctly infer the types *inside* `finally` suites, however; this is +still a TODO item for us.) + +```py +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_str() + reveal_type(x) # revealed: str +finally: + # TODO: should be Literal[1] | str + reveal_type(x) # revealed: str + +reveal_type(x) # revealed: str +``` + +## Combining an `except` branch with a `finally` branch + +As previously stated, we do not yet have accurate inference for types *inside* `finally` suites. +When we do, however, we will have to take account of the following possibilities inside `finally` +suites: + +- The `try` suite could have run to completion +- Or we could have jumped from halfway through the `try` suite to an `except` suite, and the + `except` suite ran to completion +- Or we could have jumped from halfway through the `try` suite straight to the `finally` suite due + to an unhandled exception +- Or we could have jumped from halfway through the `try` suite to an `except` suite, only for an + exception raised in the `except` suite to cause us to jump to the `finally` suite before the + `except` suite ran to completion + +```py +class A: ... +class B: ... +class C: ... + +def could_raise_returns_A() -> A: + return A() + +def could_raise_returns_B() -> B: + return B() + +def could_raise_returns_C() -> C: + return C() + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A +except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C +finally: + # TODO: should be `Literal[1] | A | B | C` + reveal_type(x) # revealed: A | C + x = 2 + reveal_type(x) # revealed: Literal[2] + +reveal_type(x) # revealed: Literal[2] +``` + +Now for an example without a redefinition in the `finally` suite. As before, there *should* be fewer +possibilities after completion of the `finally` suite than there were during the `finally` suite +itself. (In some control-flow possibilities, some exceptions were merely *suspended* during the +`finally` suite; these lead to the scope's termination following the conclusion of the `finally` +suite.) + +```py +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A +except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C +finally: + # TODO: should be `Literal[1] | A | B | C` + reveal_type(x) # revealed: A | C + +reveal_type(x) # revealed: A | C +``` + +An example with multiple `except` branches and a `finally` branch: + +```py +class D: ... +class E: ... + +def could_raise_returns_D() -> D: + return D() + +def could_raise_returns_E() -> E: + return E() + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A +except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C +except ValueError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_D() + reveal_type(x) # revealed: D + x = could_raise_returns_E() + reveal_type(x) # revealed: E +finally: + # TODO: should be `Literal[1] | A | B | C | D | E` + reveal_type(x) # revealed: A | C | E + +reveal_type(x) # revealed: A | C | E +``` + +## Combining `except`, `else` and `finally` branches + +If the exception handler has an `else` branch, we must also take into account the possibility that +control flow could have jumped to the `finally` suite from partway through the `else` suite due to +an exception raised *there*. + +```py +class A: ... +class B: ... +class C: ... +class D: ... +class E: ... + +def could_raise_returns_A() -> A: + return A() + +def could_raise_returns_B() -> B: + return B() + +def could_raise_returns_C() -> C: + return C() + +def could_raise_returns_D() -> D: + return D() + +def could_raise_returns_E() -> E: + return E() + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A +except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C +else: + reveal_type(x) # revealed: A + x = could_raise_returns_D() + reveal_type(x) # revealed: D + x = could_raise_returns_E() + reveal_type(x) # revealed: E +finally: + # TODO: should be `Literal[1] | A | B | C | D | E` + reveal_type(x) # revealed: C | E + +reveal_type(x) # revealed: C | E +``` + +The same again, this time with multiple `except` branches: + +```py +class F: ... +class G: ... + +def could_raise_returns_F() -> F: + return F() + +def could_raise_returns_G() -> G: + return G() + +x = 1 + +try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A +except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C +except ValueError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_D() + reveal_type(x) # revealed: D + x = could_raise_returns_E() + reveal_type(x) # revealed: E +else: + reveal_type(x) # revealed: A + x = could_raise_returns_F() + reveal_type(x) # revealed: F + x = could_raise_returns_G() + reveal_type(x) # revealed: G +finally: + # TODO: should be `Literal[1] | A | B | C | D | E | F | G` + reveal_type(x) # revealed: C | E | G + +reveal_type(x) # revealed: C | E | G +``` + +## Nested `try`/`except` blocks + +It would take advanced analysis, which we are not yet capable of, to be able to determine that an +exception handler always suppresses all exceptions. This is partly because it is possible for +statements in `except`, `else` and `finally` suites to raise exceptions as well as statements in +`try` suites. This means that if an exception handler is nested inside the `try` statement of an +enclosing exception handler, it should (at least for now) be treated the same as any other node: as +a suite containing statements that could possibly raise exceptions, which would lead to control flow +jumping out of that suite prior to the suite running to completion. + +```py +class A: ... +class B: ... +class C: ... +class D: ... +class E: ... +class F: ... +class G: ... +class H: ... +class I: ... +class J: ... +class K: ... + +def could_raise_returns_A() -> A: + return A() + +def could_raise_returns_B() -> B: + return B() + +def could_raise_returns_C() -> C: + return C() + +def could_raise_returns_D() -> D: + return D() + +def could_raise_returns_E() -> E: + return E() + +def could_raise_returns_F() -> F: + return F() + +def could_raise_returns_G() -> G: + return G() + +def could_raise_returns_H() -> H: + return H() + +def could_raise_returns_I() -> I: + return I() + +def could_raise_returns_J() -> J: + return J() + +def could_raise_returns_K() -> K: + return K() + +x = 1 + +try: + try: + reveal_type(x) # revealed: Literal[1] + x = could_raise_returns_A() + reveal_type(x) # revealed: A + except TypeError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + x = could_raise_returns_C() + reveal_type(x) # revealed: C + except ValueError: + reveal_type(x) # revealed: Literal[1] | A + x = could_raise_returns_D() + reveal_type(x) # revealed: D + x = could_raise_returns_E() + reveal_type(x) # revealed: E + else: + reveal_type(x) # revealed: A + x = could_raise_returns_F() + reveal_type(x) # revealed: F + x = could_raise_returns_G() + reveal_type(x) # revealed: G + finally: + # TODO: should be `Literal[1] | A | B | C | D | E | F | G` + reveal_type(x) # revealed: C | E | G + x = 2 + reveal_type(x) # revealed: Literal[2] + reveal_type(x) # revealed: Literal[2] +except: + reveal_type(x) # revealed: Literal[1, 2] | A | B | C | D | E | F | G + x = could_raise_returns_H() + reveal_type(x) # revealed: H + x = could_raise_returns_I() + reveal_type(x) # revealed: I +else: + reveal_type(x) # revealed: Literal[2] + x = could_raise_returns_J() + reveal_type(x) # revealed: J + x = could_raise_returns_K() + reveal_type(x) # revealed: K +finally: + # TODO: should be `Literal[1, 2] | A | B | C | D | E | F | G | H | I | J | K` + reveal_type(x) # revealed: I | K + +# Either one `except` branch or the `else` +# must have been taken and completed to get here: +reveal_type(x) # revealed: I | K +``` + +## Nested scopes inside `try` blocks + +Shadowing a variable in an inner scope has no effect on type inference of the variable by that name +in the outer scope: + +```py +class A: ... +class B: ... +class C: ... +class D: ... +class E: ... + +def could_raise_returns_A() -> A: + return A() + +def could_raise_returns_B() -> B: + return B() + +def could_raise_returns_C() -> C: + return C() + +def could_raise_returns_D() -> D: + return D() + +def could_raise_returns_E() -> E: + return E() + +x = 1 + +try: + + def foo(param=could_raise_returns_A()): + x = could_raise_returns_A() + + try: + reveal_type(x) # revealed: A + x = could_raise_returns_B() + reveal_type(x) # revealed: B + except: + reveal_type(x) # revealed: A | B + x = could_raise_returns_C() + reveal_type(x) # revealed: C + x = could_raise_returns_D() + reveal_type(x) # revealed: D + finally: + # TODO: should be `A | B | C | D` + reveal_type(x) # revealed: B | D + reveal_type(x) # revealed: B | D + x = foo + reveal_type(x) # revealed: def foo(param=A) -> Unknown +except: + reveal_type(x) # revealed: Literal[1] | (def foo(param=A) -> Unknown) + + class Bar: + x = could_raise_returns_E() + reveal_type(x) # revealed: E + + x = Bar + reveal_type(x) # revealed: <class 'Bar'> +finally: + # TODO: should be `Literal[1] | <class 'foo'> | <class 'Bar'>` + reveal_type(x) # revealed: (def foo(param=A) -> Unknown) | <class 'Bar'> + +reveal_type(x) # revealed: (def foo(param=A) -> Unknown) | <class 'Bar'> +``` + +[1]: https://astral-sh.notion.site/Exception-handler-control-flow-11348797e1ca80bb8ce1e9aedbbe439d diff --git a/crates/ty_python_semantic/resources/mdtest/exception/except_star.md b/crates/ty_python_semantic/resources/mdtest/exception/except_star.md new file mode 100644 index 0000000000000..36ccd7d82a3e9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/exception/except_star.md @@ -0,0 +1,72 @@ +# `except*` + +`except*` is only available in Python 3.11 and later: + +```toml +[environment] +python-version = "3.11" +``` + +## `except*` with `BaseException` + +```py +try: + help() +except* BaseException as e: + reveal_type(e) # revealed: BaseExceptionGroup[BaseException] +``` + +## `except*` with specific exception + +```py +try: + help() +except* OSError as e: + reveal_type(e) # revealed: ExceptionGroup[OSError] +``` + +## `except*` with multiple exceptions + +```py +try: + help() +except* (TypeError, AttributeError) as e: + reveal_type(e) # revealed: ExceptionGroup[TypeError | AttributeError] +``` + +## `except*` with mix of `Exception`s and `BaseException`s + +```py +try: + help() +except* (KeyboardInterrupt, AttributeError) as e: + reveal_type(e) # revealed: BaseExceptionGroup[KeyboardInterrupt | AttributeError] +``` + +## `except*` with no captured exception type + +```py +try: + help() +except* TypeError: + pass +``` + +## Invalid `except*` handlers with or without a captured exception type + +```py +try: + help() +except* int: # error: [invalid-exception-caught] + pass + +try: + help() +except* 3 as e: # error: [invalid-exception-caught] + reveal_type(e) # revealed: BaseExceptionGroup[Unknown] + +try: + help() +except* (AttributeError, 42) as e: # error: [invalid-exception-caught] + reveal_type(e) # revealed: BaseExceptionGroup[AttributeError | Unknown] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/exception/invalid_syntax.md b/crates/ty_python_semantic/resources/mdtest/exception/invalid_syntax.md new file mode 100644 index 0000000000000..19bb7c43772f1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/exception/invalid_syntax.md @@ -0,0 +1,12 @@ +# Exception Handling + +## Invalid syntax + +```py +from typing_extensions import reveal_type + +try: + print +except as e: # error: [invalid-syntax] + reveal_type(e) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/assert.md b/crates/ty_python_semantic/resources/mdtest/expression/assert.md new file mode 100644 index 0000000000000..ddb429a576e09 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/assert.md @@ -0,0 +1,9 @@ +## Condition with object that implements `__bool__` incorrectly + +```py +class NotBoolable: + __bool__: int = 3 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +assert NotBoolable() +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/attribute.md b/crates/ty_python_semantic/resources/mdtest/expression/attribute.md new file mode 100644 index 0000000000000..43df56264cb5c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/attribute.md @@ -0,0 +1,34 @@ +# Attribute access + +## Boundness + +```py +def _(flag: bool): + class A: + always_bound: int = 1 + + if flag: + union = 1 + else: + union = "abc" + + if flag: + union_declared: int = 1 + else: + union_declared: str = "abc" + + if flag: + possibly_unbound: str = "abc" + + reveal_type(A.always_bound) # revealed: int + + reveal_type(A.union) # revealed: Unknown | Literal[1, "abc"] + + reveal_type(A.union_declared) # revealed: int | str + + # error: [possibly-unbound-attribute] "Attribute `possibly_unbound` on type `<class 'A'>` is possibly unbound" + reveal_type(A.possibly_unbound) # revealed: str + + # error: [unresolved-attribute] "Type `<class 'A'>` has no attribute `non_existent`" + reveal_type(A.non_existent) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/boolean.md b/crates/ty_python_semantic/resources/mdtest/expression/boolean.md new file mode 100644 index 0000000000000..7a9f25f637403 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/boolean.md @@ -0,0 +1,155 @@ +# Expressions + +## OR + +```py +def _(foo: str): + reveal_type(True or False) # revealed: Literal[True] + reveal_type("x" or "y" or "z") # revealed: Literal["x"] + reveal_type("" or "y" or "z") # revealed: Literal["y"] + reveal_type(False or "z") # revealed: Literal["z"] + reveal_type(False or True) # revealed: Literal[True] + reveal_type(False or False) # revealed: Literal[False] + reveal_type(foo or False) # revealed: (str & ~AlwaysFalsy) | Literal[False] + reveal_type(foo or True) # revealed: (str & ~AlwaysFalsy) | Literal[True] +``` + +## AND + +```py +def _(foo: str): + reveal_type(True and False) # revealed: Literal[False] + reveal_type(False and True) # revealed: Literal[False] + reveal_type(foo and False) # revealed: (str & ~AlwaysTruthy) | Literal[False] + reveal_type(foo and True) # revealed: (str & ~AlwaysTruthy) | Literal[True] + reveal_type("x" and "y" and "z") # revealed: Literal["z"] + reveal_type("x" and "y" and "") # revealed: Literal[""] + reveal_type("" and "y") # revealed: Literal[""] +``` + +## Simple function calls to bool + +```py +def _(flag: bool): + if flag: + x = True + else: + x = False + + reveal_type(x) # revealed: bool +``` + +## Complex + +```py +reveal_type("x" and "y" or "z") # revealed: Literal["y"] +reveal_type("x" or "y" and "z") # revealed: Literal["x"] +reveal_type("" and "y" or "z") # revealed: Literal["z"] +reveal_type("" or "y" and "z") # revealed: Literal["z"] +reveal_type("x" and "y" or "") # revealed: Literal["y"] +reveal_type("x" or "y" and "") # revealed: Literal["x"] +``` + +## `bool()` function + +## Evaluates to builtin + +`a.py`: + +```py +redefined_builtin_bool: type[bool] = bool + +def my_bool(x) -> bool: + return True +``` + +```py +from a import redefined_builtin_bool, my_bool + +reveal_type(redefined_builtin_bool(0)) # revealed: Literal[False] +reveal_type(my_bool(0)) # revealed: bool +``` + +## Truthy values + +```py +reveal_type(bool(1)) # revealed: Literal[True] +reveal_type(bool((0,))) # revealed: Literal[True] +reveal_type(bool("NON EMPTY")) # revealed: Literal[True] +reveal_type(bool(True)) # revealed: Literal[True] + +def foo(): ... + +reveal_type(bool(foo)) # revealed: Literal[True] +``` + +## Falsy values + +```py +reveal_type(bool(0)) # revealed: Literal[False] +reveal_type(bool(())) # revealed: Literal[False] +reveal_type(bool(None)) # revealed: Literal[False] +reveal_type(bool("")) # revealed: Literal[False] +reveal_type(bool(False)) # revealed: Literal[False] +reveal_type(bool()) # revealed: Literal[False] +``` + +## Ambiguous values + +```py +reveal_type(bool([])) # revealed: bool +reveal_type(bool({})) # revealed: bool +reveal_type(bool(set())) # revealed: bool +``` + +## `__bool__` returning `NoReturn` + +```py +from typing import NoReturn + +class NotBoolable: + def __bool__(self) -> NoReturn: + raise NotImplementedError("This object can't be converted to a boolean") + +# TODO: This should emit an error that `NotBoolable` can't be converted to a bool but it currently doesn't +# because `Never` is assignable to `bool`. This probably requires dead code analysis to fix. +if NotBoolable(): + ... +``` + +## Not callable `__bool__` + +```py +class NotBoolable: + __bool__: None = None + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +if NotBoolable(): + ... +``` + +## Not-boolable union + +```py +def test(cond: bool): + class NotBoolable: + __bool__: int | None = None if cond else 3 + + # error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" + if NotBoolable(): + ... +``` + +## Union with some variants implementing `__bool__` incorrectly + +```py +def test(cond: bool): + class NotBoolable: + __bool__: None = None + + a = 10 if cond else NotBoolable() + + # error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `Literal[10] | NotBoolable`" + if a: + ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/if.md b/crates/ty_python_semantic/resources/mdtest/expression/if.md new file mode 100644 index 0000000000000..50ba10270c1d3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/if.md @@ -0,0 +1,41 @@ +# If expression + +## Union + +```py +def _(flag: bool): + reveal_type(1 if flag else 2) # revealed: Literal[1, 2] +``` + +## Statically known conditions in if-expressions + +```py +reveal_type(1 if True else 2) # revealed: Literal[1] +reveal_type(1 if "not empty" else 2) # revealed: Literal[1] +reveal_type(1 if (1,) else 2) # revealed: Literal[1] +reveal_type(1 if 1 else 2) # revealed: Literal[1] + +reveal_type(1 if False else 2) # revealed: Literal[2] +reveal_type(1 if None else 2) # revealed: Literal[2] +reveal_type(1 if "" else 2) # revealed: Literal[2] +reveal_type(1 if 0 else 2) # revealed: Literal[2] +``` + +## Leaked Narrowing Constraint + +(issue #14588) + +The test inside an if expression should not affect code outside of the expression. + +```py +from typing import Literal + +def _(flag: bool): + x: Literal[42, "hello"] = 42 if flag else "hello" + + reveal_type(x) # revealed: Literal[42, "hello"] + + _ = ... if isinstance(x, str) else ... + + reveal_type(x) # revealed: Literal[42, "hello"] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/lambda.md b/crates/ty_python_semantic/resources/mdtest/expression/lambda.md new file mode 100644 index 0000000000000..dbafc217acfde --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/lambda.md @@ -0,0 +1,117 @@ +# `lambda` expression + +## No parameters + +`lambda` expressions can be defined without any parameters. + +```py +reveal_type(lambda: 1) # revealed: () -> Unknown + +# error: [unresolved-reference] +reveal_type(lambda: a) # revealed: () -> Unknown +``` + +## With parameters + +Unlike parameters in function definition, the parameters in a `lambda` expression cannot be +annotated. + +```py +reveal_type(lambda a: a) # revealed: (a) -> Unknown +reveal_type(lambda a, b: a + b) # revealed: (a, b) -> Unknown +``` + +But, it can have default values: + +```py +reveal_type(lambda a=1: a) # revealed: (a=Literal[1]) -> Unknown +reveal_type(lambda a, b=2: a) # revealed: (a, b=Literal[2]) -> Unknown +``` + +And, positional-only parameters: + +```py +reveal_type(lambda a, b, /, c: c) # revealed: (a, b, /, c) -> Unknown +``` + +And, keyword-only parameters: + +```py +reveal_type(lambda a, *, b=2, c: b) # revealed: (a, *, b=Literal[2], c) -> Unknown +``` + +And, variadic parameter: + +```py +reveal_type(lambda *args: args) # revealed: (*args) -> Unknown +``` + +And, keyword-varidic parameter: + +```py +reveal_type(lambda **kwargs: kwargs) # revealed: (**kwargs) -> Unknown +``` + +Mixing all of them together: + +```py +# revealed: (a, b, /, c=Literal[True], *args, *, d=Literal["default"], e=Literal[5], **kwargs) -> Unknown +reveal_type(lambda a, b, /, c=True, *args, d="default", e=5, **kwargs: None) +``` + +## Parameter type + +In addition to correctly inferring the `lambda` expression, the parameters should also be inferred +correctly. + +Using a parameter with no default value: + +```py +lambda x: reveal_type(x) # revealed: Unknown +``` + +Using a parameter with default value: + +```py +lambda x=1: reveal_type(x) # revealed: Unknown | Literal[1] +``` + +Using a variadic parameter: + +```py +lambda *args: reveal_type(args) # revealed: tuple[Unknown, ...] +``` + +Using a keyword-variadic parameter: + +```py +lambda **kwargs: reveal_type(kwargs) # revealed: dict[str, Unknown] +``` + +## Nested `lambda` expressions + +Here, a `lambda` expression is used as the default value for a parameter in another `lambda` +expression. + +```py +reveal_type(lambda a=lambda x, y: 0: 2) # revealed: (a=(x, y) -> Unknown) -> Unknown +``` + +## Assignment + +This does not enumerate all combinations of parameter kinds as that should be covered by the +[subtype tests for callable types](./../type_properties/is_subtype_of.md#callable). + +```py +from typing import Callable + +a1: Callable[[], None] = lambda: None +a2: Callable[[int], None] = lambda x: None +a3: Callable[[int, int], None] = lambda x, y, z=1: None +a4: Callable[[int, int], None] = lambda *args: None + +# error: [invalid-assignment] +a5: Callable[[], None] = lambda x: None +# error: [invalid-assignment] +a6: Callable[[int], None] = lambda: None +``` diff --git a/crates/ty_python_semantic/resources/mdtest/expression/len.md b/crates/ty_python_semantic/resources/mdtest/expression/len.md new file mode 100644 index 0000000000000..9fe787822bc42 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/expression/len.md @@ -0,0 +1,234 @@ +# Length (`len()`) + +## Literal and constructed iterables + +### Strings and bytes literals + +```py +reveal_type(len("no\rmal")) # revealed: Literal[6] +reveal_type(len(r"aw stri\ng")) # revealed: Literal[10] +reveal_type(len(r"conca\t" "ena\tion")) # revealed: Literal[14] +reveal_type(len(b"ytes lite" rb"al")) # revealed: Literal[11] +reveal_type(len("𝒰𝕹🄸©🕲𝕕ℇ")) # revealed: Literal[7] + +# fmt: off + +reveal_type(len( # revealed: Literal[7] + """foo +bar""" +)) + +reveal_type(len( # revealed: Literal[9] + r"""foo\r +bar""" +)) + +reveal_type(len( # revealed: Literal[7] + b"""foo +bar""" +)) +reveal_type(len( # revealed: Literal[9] + rb"""foo\r +bar""" +)) + +# fmt: on +``` + +### Tuples + +```py +reveal_type(len(())) # revealed: Literal[0] +reveal_type(len((1,))) # revealed: Literal[1] +reveal_type(len((1, 2))) # revealed: Literal[2] + +# TODO: Handle constructor calls +reveal_type(len(tuple())) # revealed: int + +# TODO: Handle star unpacks; Should be: Literal[0] +reveal_type(len((*[],))) # revealed: Literal[1] + +# fmt: off + +# TODO: Handle star unpacks; Should be: Literal[1] +reveal_type(len( # revealed: Literal[2] + ( + *[], + 1, + ) +)) + +# fmt: on + +# TODO: Handle star unpacks; Should be: Literal[2] +reveal_type(len((*[], 1, 2))) # revealed: Literal[3] + +# TODO: Handle star unpacks; Should be: Literal[0] +reveal_type(len((*[], *{}))) # revealed: Literal[2] +``` + +### Lists, sets and dictionaries + +```py +reveal_type(len([])) # revealed: int +reveal_type(len([1])) # revealed: int +reveal_type(len([1, 2])) # revealed: int +reveal_type(len([*{}, *dict()])) # revealed: int + +reveal_type(len({})) # revealed: int +reveal_type(len({**{}})) # revealed: int +reveal_type(len({**{}, **{}})) # revealed: int + +reveal_type(len({1})) # revealed: int +reveal_type(len({1, 2})) # revealed: int +reveal_type(len({*[], 2})) # revealed: int + +reveal_type(len(list())) # revealed: int +reveal_type(len(set())) # revealed: int +reveal_type(len(dict())) # revealed: int +reveal_type(len(frozenset())) # revealed: int +``` + +## `__len__` + +The returned value of `__len__` is implicitly and recursively converted to `int`. + +### Literal integers + +```py +from typing import Literal + +class Zero: + def __len__(self) -> Literal[0]: + return 0 + +class ZeroOrOne: + def __len__(self) -> Literal[0, 1]: + return 0 + +class ZeroOrTrue: + def __len__(self) -> Literal[0, True]: + return 0 + +class OneOrFalse: + def __len__(self) -> Literal[1] | Literal[False]: + return 1 + +class OneOrFoo: + def __len__(self) -> Literal[1, "foo"]: + return 1 + +class ZeroOrStr: + def __len__(self) -> Literal[0] | str: + return 0 + +reveal_type(len(Zero())) # revealed: Literal[0] +reveal_type(len(ZeroOrOne())) # revealed: Literal[0, 1] +reveal_type(len(ZeroOrTrue())) # revealed: Literal[0, 1] +reveal_type(len(OneOrFalse())) # revealed: Literal[1, 0] + +# TODO: Emit a diagnostic +reveal_type(len(OneOrFoo())) # revealed: int + +# TODO: Emit a diagnostic +reveal_type(len(ZeroOrStr())) # revealed: int +``` + +### Literal booleans + +```py +from typing import Literal + +class LiteralTrue: + def __len__(self) -> Literal[True]: + return True + +class LiteralFalse: + def __len__(self) -> Literal[False]: + return False + +reveal_type(len(LiteralTrue())) # revealed: Literal[1] +reveal_type(len(LiteralFalse())) # revealed: Literal[0] +``` + +### Enums + +```py +from enum import Enum, auto +from typing import Literal + +class SomeEnum(Enum): + AUTO = auto() + INT = 2 + STR = "4" + TUPLE = (8, "16") + INT_2 = 3_2 + +class Auto: + def __len__(self) -> Literal[SomeEnum.AUTO]: + return SomeEnum.AUTO + +class Int: + def __len__(self) -> Literal[SomeEnum.INT]: + return SomeEnum.INT + +class Str: + def __len__(self) -> Literal[SomeEnum.STR]: + return SomeEnum.STR + +class Tuple: + def __len__(self) -> Literal[SomeEnum.TUPLE]: + return SomeEnum.TUPLE + +class IntUnion: + def __len__(self) -> Literal[SomeEnum.INT, SomeEnum.INT_2]: + return SomeEnum.INT + +reveal_type(len(Auto())) # revealed: int +reveal_type(len(Int())) # revealed: int +reveal_type(len(Str())) # revealed: int +reveal_type(len(Tuple())) # revealed: int +reveal_type(len(IntUnion())) # revealed: int +``` + +### Negative integers + +```py +from typing import Literal + +class Negative: + def __len__(self) -> Literal[-1]: + return -1 + +# TODO: Emit a diagnostic +reveal_type(len(Negative())) # revealed: int +``` + +### Wrong signature + +```py +from typing import Literal + +class SecondOptionalArgument: + def __len__(self, v: int = 0) -> Literal[0]: + return 0 + +class SecondRequiredArgument: + def __len__(self, v: int) -> Literal[1]: + return 1 + +# TODO: Emit a diagnostic +reveal_type(len(SecondOptionalArgument())) # revealed: Literal[0] + +# TODO: Emit a diagnostic +reveal_type(len(SecondRequiredArgument())) # revealed: Literal[1] +``` + +### No `__len__` + +```py +class NoDunderLen: ... + +# error: [invalid-argument-type] +reveal_type(len(NoDunderLen())) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/final.md b/crates/ty_python_semantic/resources/mdtest/final.md new file mode 100644 index 0000000000000..e37cf41c8cedf --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/final.md @@ -0,0 +1,31 @@ +# Tests for the `@typing(_extensions).final` decorator + +## Cannot subclass + +Don't do this: + +```py +import typing_extensions +from typing import final + +@final +class A: ... + +class B(A): ... # error: 9 [subclass-of-final-class] "Class `B` cannot inherit from final class `A`" + +@typing_extensions.final +class C: ... + +class D(C): ... # error: [subclass-of-final-class] +class E: ... +class F: ... +class G: ... + +# fmt: off +class H( + E, + F, + A, # error: [subclass-of-final-class] + G, +): ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/function/parameters.md b/crates/ty_python_semantic/resources/mdtest/function/parameters.md new file mode 100644 index 0000000000000..eb7316fe91a2d --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/function/parameters.md @@ -0,0 +1,112 @@ +# Function parameter types + +Within a function scope, the declared type of each parameter is its annotated type (or Unknown if +not annotated). The initial inferred type is the union of the declared type with the type of the +default value expression (if any). If both are fully static types, this union should simplify to the +annotated type (since the default value type must be assignable to the annotated type, and for fully +static types this means subtype-of, which simplifies in unions). But if the annotated type is +Unknown or another non-fully-static type, the default value type may still be relevant as lower +bound. + +The variadic parameter is a variadic tuple of its annotated type; the variadic-keywords parameter is +a dictionary from strings to its annotated type. + +## Parameter kinds + +```py +from typing import Literal + +def f(a, b: int, c=1, d: int = 2, /, e=3, f: Literal[4] = 4, *args: object, g=5, h: Literal[6] = 6, **kwargs: str): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: int + reveal_type(c) # revealed: Unknown | Literal[1] + reveal_type(d) # revealed: int + reveal_type(e) # revealed: Unknown | Literal[3] + reveal_type(f) # revealed: Literal[4] + reveal_type(g) # revealed: Unknown | Literal[5] + reveal_type(h) # revealed: Literal[6] + reveal_type(args) # revealed: tuple[object, ...] + reveal_type(kwargs) # revealed: dict[str, str] +``` + +## Unannotated variadic parameters + +...are inferred as tuple of Unknown or dict from string to Unknown. + +```py +def g(*args, **kwargs): + reveal_type(args) # revealed: tuple[Unknown, ...] + reveal_type(kwargs) # revealed: dict[str, Unknown] +``` + +## Annotation is present but not a fully static type + +The default value type should be a lower bound on the inferred type. + +```py +from typing import Any + +def f(x: Any = 1): + reveal_type(x) # revealed: Any | Literal[1] +``` + +## Default value type must be assignable to annotated type + +The default value type must be assignable to the annotated type. If not, we emit a diagnostic, and +fall back to inferring the annotated type, ignoring the default value type. + +```py +# error: [invalid-parameter-default] +def f(x: int = "foo"): + reveal_type(x) # revealed: int + +# The check is assignable-to, not subtype-of, so this is fine: +from typing import Any + +def g(x: Any = "foo"): + reveal_type(x) # revealed: Any | Literal["foo"] +``` + +## Stub functions + +```toml +[environment] +python-version = "3.12" +``` + +### In Protocol + +```py +from typing import Protocol + +class Foo(Protocol): + def x(self, y: bool = ...): ... + def y[T](self, y: T = ...) -> T: ... + +class GenericFoo[T](Protocol): + def x(self, y: bool = ...) -> T: ... +``` + +### In abstract method + +```py +from abc import abstractmethod + +class Bar: + @abstractmethod + def x(self, y: bool = ...): ... + @abstractmethod + def y[T](self, y: T = ...) -> T: ... +``` + +### In function overload + +```py +from typing import overload + +@overload +def x(y: None = ...) -> None: ... +@overload +def x(y: int) -> str: ... +def x(y: int | None = None) -> str | None: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/function/return_type.md b/crates/ty_python_semantic/resources/mdtest/function/return_type.md new file mode 100644 index 0000000000000..93d4843b70c8c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/function/return_type.md @@ -0,0 +1,415 @@ +# Function return type + +When a function's return type is annotated, all return statements are checked to ensure that the +type of the returned value is assignable to the annotated return type. + +## Basic examples + +A return value assignable to the annotated return type is valid. + +```py +def f() -> int: + return 1 +``` + +The type of the value obtained by calling a function is the annotated return type, not the inferred +return type. + +```py +reveal_type(f()) # revealed: int +``` + +A `raise` is equivalent to a return of `Never`, which is assignable to any annotated return type. + +```py +def f() -> str: + raise ValueError() + +reveal_type(f()) # revealed: str +``` + +## Stub functions + +"Stub" function definitions (that is, function definitions with an empty body) are permissible in +stub files, or in a few other locations: Protocol method definitions, abstract methods, and +overloads. In this case the function body is considered to be omitted (thus no return type checking +is performed on it), not assumed to implicitly return `None`. + +A stub function's "empty" body may contain only an optional docstring, followed (optionally) by an +ellipsis (`...`) or `pass`. + +### In stub file + +```pyi +def f() -> int: ... + +def f() -> int: + pass + +def f() -> int: + """Some docstring""" + +def f() -> int: + """Some docstring""" + ... +``` + +### In Protocol + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing import Protocol, TypeVar + +class Bar(Protocol): + def f(self) -> int: ... + +class Baz(Bar): + # error: [invalid-return-type] + def f(self) -> int: ... + +T = TypeVar("T") + +class Qux(Protocol[T]): + def f(self) -> int: ... + +class Foo(Protocol): + def f[T](self, v: T) -> T: ... + +t = (Protocol, int) +reveal_type(t[0]) # revealed: typing.Protocol + +class Lorem(t[0]): + def f(self) -> int: ... +``` + +### In abstract method + +```toml +[environment] +python-version = "3.12" +``` + +```py +from abc import ABC, abstractmethod + +class Foo(ABC): + @abstractmethod + def f(self) -> int: ... + @abstractmethod + def g[T](self, x: T) -> T: ... + +class Bar[T](ABC): + @abstractmethod + def f(self) -> int: ... + @abstractmethod + def g[T](self, x: T) -> T: ... + +# error: [invalid-return-type] +def f() -> int: ... +@abstractmethod # Semantically meaningless, accepted nevertheless +def g() -> int: ... +``` + +### In overload + +```py +from typing import overload + +@overload +def f(x: int) -> int: ... +@overload +def f(x: str) -> str: ... +def f(x: int | str): + return x +``` + +## Conditional return type + +```py +def f(cond: bool) -> int: + if cond: + return 1 + else: + return 2 + +def f(cond: bool) -> int | None: + if cond: + return 1 + else: + return + +def f(cond: bool) -> int: + if cond: + return 1 + else: + raise ValueError() + +def f(cond: bool) -> str | int: + if cond: + return "a" + else: + return 1 +``` + +## Implicit return type + +```py +def f(cond: bool) -> int | None: + if cond: + return 1 + +# no implicit return +def f() -> int: + if True: + return 1 + +# no implicit return +def f(cond: bool) -> int: + cond = True + if cond: + return 1 + +def f(cond: bool) -> int: + if cond: + cond = True + else: + return 1 + if cond: + return 2 +``` + +## Invalid return type + +<!-- snapshot-diagnostics --> + +```py +# error: [invalid-return-type] +def f() -> int: + 1 + +def f() -> str: + # error: [invalid-return-type] + return 1 + +def f() -> int: + # error: [invalid-return-type] + return + +from typing import TypeVar + +T = TypeVar("T") + +# error: [invalid-return-type] +def m(x: T) -> T: ... +``` + +## Invalid return type in stub file + +<!-- snapshot-diagnostics --> + +```pyi +def f() -> int: + # error: [invalid-return-type] + return ... + +# error: [invalid-return-type] +def foo() -> int: + print("...") + ... + +# error: [invalid-return-type] +def foo() -> int: + f"""{foo} is a function that ...""" + ... +``` + +## Invalid conditional return type + +<!-- snapshot-diagnostics --> + +```py +def f(cond: bool) -> str: + if cond: + return "a" + else: + # error: [invalid-return-type] + return 1 + +def f(cond: bool) -> str: + if cond: + # error: [invalid-return-type] + return 1 + else: + # error: [invalid-return-type] + return 2 +``` + +## Invalid implicit return type + +<!-- snapshot-diagnostics --> + +```py +def f() -> None: + if False: + # error: [invalid-return-type] + return 1 + +# error: [invalid-return-type] +def f(cond: bool) -> int: + if cond: + return 1 + +# error: [invalid-return-type] +def f(cond: bool) -> int: + if cond: + raise ValueError() + +# error: [invalid-return-type] +def f(cond: bool) -> int: + if cond: + cond = False + else: + return 1 + if cond: + return 2 +``` + +## NotImplemented + +### Default Python version + +`NotImplemented` is a special symbol in Python. It is commonly used to control the fallback behavior +of special dunder methods. You can find more details in the +[documentation](https://docs.python.org/3/library/numbers.html#implementing-the-arithmetic-operations). + +```py +from __future__ import annotations + +class A: + def __add__(self, o: A) -> A: + return NotImplemented +``` + +However, as shown below, `NotImplemented` should not cause issues with the declared return type. + +```py +def f() -> int: + return NotImplemented + +def f(cond: bool) -> int: + if cond: + return 1 + else: + return NotImplemented + +def f(x: int) -> int | str: + if x < 0: + return -1 + elif x == 0: + return NotImplemented + else: + return "test" + +def f(cond: bool) -> str: + return "hello" if cond else NotImplemented + +def f(cond: bool) -> int: + # error: [invalid-return-type] "Return type does not match returned value: expected `int`, found `Literal["hello"]`" + return "hello" if cond else NotImplemented +``` + +### Python 3.10+ + +Unlike Ellipsis, `_NotImplementedType` remains in `builtins.pyi` regardless of the Python version. +Even if `builtins._NotImplementedType` is fully replaced by `types.NotImplementedType` in the +future, it should still work as expected. + +```toml +[environment] +python-version = "3.10" +``` + +```py +def f() -> int: + return NotImplemented + +def f(cond: bool) -> str: + return "hello" if cond else NotImplemented +``` + +## Generator functions + +<!-- snapshot-diagnostics --> + +A function with a `yield` or `yield from` expression anywhere in its body is a +[generator function](https://docs.python.org/3/glossary.html#term-generator). A generator function +implicitly returns an instance of `types.GeneratorType` even if it does not contain any `return` +statements. + +```py +import types +import typing + +def f() -> types.GeneratorType: + yield 42 + +def g() -> typing.Generator: + yield 42 + +def h() -> typing.Iterator: + yield 42 + +def i() -> typing.Iterable: + yield 42 + +def i2() -> typing.Generator: + yield from i() + +def j() -> str: # error: [invalid-return-type] + yield 42 +``` + +If it is an `async` function with a `yield` statement in its body, it is an +[asynchronous generator function](https://docs.python.org/3/glossary.html#term-asynchronous-generator). +An asynchronous generator function implicitly returns an instance of `types.AsyncGeneratorType` even +if it does not contain any `return` statements. + +```py +import types +import typing + +async def f() -> types.AsyncGeneratorType: + yield 42 + +async def g() -> typing.AsyncGenerator: + yield 42 + +async def h() -> typing.AsyncIterator: + yield 42 + +async def i() -> typing.AsyncIterable: + yield 42 + +async def j() -> str: # error: [invalid-return-type] + yield 42 +``` + +## Diagnostics for `invalid-return-type` on non-protocol subclasses of protocol classes + +<!-- snapshot-diagnostics --> + +We emit a nice subdiagnostic in this situation explaining the probable error here: + +```py +from typing_extensions import Protocol + +class Abstract(Protocol): + def method(self) -> str: ... + +class Concrete(Abstract): + def method(self) -> str: ... # error: [invalid-return-type] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/generics/builtins.md b/crates/ty_python_semantic/resources/mdtest/generics/builtins.md new file mode 100644 index 0000000000000..70b9c91902069 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/builtins.md @@ -0,0 +1,35 @@ +# Generic builtins + +## Variadic keyword arguments with a custom `dict` + +When we define `dict` in a custom typeshed, we must take care to define it as a generic class in the +same way as in the real typeshed. + +```toml +[environment] +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/builtins.pyi`: + +```pyi +class object: ... +class int: ... +class dict[K, V, Extra]: ... +``` + +`/typeshed/stdlib/typing_extensions.pyi`: + +```pyi +def reveal_type(obj, /): ... +``` + +If we don't, then we won't be able to infer the types of variadic keyword arguments correctly. + +```py +def f(**kwargs): + reveal_type(kwargs) # revealed: Unknown + +def g(**kwargs: int): + reveal_type(kwargs) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/generics/legacy/classes.md b/crates/ty_python_semantic/resources/mdtest/generics/legacy/classes.md new file mode 100644 index 0000000000000..66f7574243339 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/legacy/classes.md @@ -0,0 +1,598 @@ +# Generic classes: Legacy syntax + +## Defining a generic class + +At its simplest, to define a generic class using the legacy syntax, you inherit from the +`typing.Generic` special form, which is "specialized" with the generic class's type variables. + +```py +from ty_extensions import generic_context +from typing import Generic, TypeVar + +T = TypeVar("T") +S = TypeVar("S") + +class SingleTypevar(Generic[T]): ... +class MultipleTypevars(Generic[T, S]): ... + +reveal_type(generic_context(SingleTypevar)) # revealed: tuple[T] +reveal_type(generic_context(MultipleTypevars)) # revealed: tuple[T, S] +``` + +Inheriting from `Generic` multiple times yields a `duplicate-base` diagnostic, just like any other +class: + +```py +class Bad(Generic[T], Generic[T]): ... # error: [duplicate-base] + +# TODO: should emit an error (fails at runtime) +class AlsoBad(Generic[T], Generic[S]): ... +``` + +You cannot use the same typevar more than once. + +```py +# TODO: error +class RepeatedTypevar(Generic[T, T]): ... +``` + +You can only specialize `typing.Generic` with typevars (TODO: or param specs or typevar tuples). + +```py +# error: [invalid-argument-type] "`<class 'int'>` is not a valid argument to `typing.Generic`" +class GenericOfType(Generic[int]): ... +``` + +You can also define a generic class by inheriting from some _other_ generic class, and specializing +it with typevars. + +```py +class InheritedGeneric(MultipleTypevars[T, S]): ... +class InheritedGenericPartiallySpecialized(MultipleTypevars[T, int]): ... +class InheritedGenericFullySpecialized(MultipleTypevars[str, int]): ... + +reveal_type(generic_context(InheritedGeneric)) # revealed: tuple[T, S] +reveal_type(generic_context(InheritedGenericPartiallySpecialized)) # revealed: tuple[T] +reveal_type(generic_context(InheritedGenericFullySpecialized)) # revealed: None +``` + +If you don't specialize a generic base class, we use the default specialization, which maps each +typevar to its default value or `Any`. Since that base class is fully specialized, it does not make +the inheriting class generic. + +```py +class InheritedGenericDefaultSpecialization(MultipleTypevars): ... + +reveal_type(generic_context(InheritedGenericDefaultSpecialization)) # revealed: None +``` + +When inheriting from a generic class, you can optionally inherit from `typing.Generic` as well. But +if you do, you have to mention all of the typevars that you use in your other base classes. + +```py +class ExplicitInheritedGeneric(MultipleTypevars[T, S], Generic[T, S]): ... + +# error: [invalid-generic-class] "`Generic` base class must include all type variables used in other base classes" +class ExplicitInheritedGenericMissingTypevar(MultipleTypevars[T, S], Generic[T]): ... +class ExplicitInheritedGenericPartiallySpecialized(MultipleTypevars[T, int], Generic[T]): ... +class ExplicitInheritedGenericPartiallySpecializedExtraTypevar(MultipleTypevars[T, int], Generic[T, S]): ... + +# error: [invalid-generic-class] "`Generic` base class must include all type variables used in other base classes" +class ExplicitInheritedGenericPartiallySpecializedMissingTypevar(MultipleTypevars[T, int], Generic[S]): ... + +reveal_type(generic_context(ExplicitInheritedGeneric)) # revealed: tuple[T, S] +reveal_type(generic_context(ExplicitInheritedGenericPartiallySpecialized)) # revealed: tuple[T] +reveal_type(generic_context(ExplicitInheritedGenericPartiallySpecializedExtraTypevar)) # revealed: tuple[T, S] +``` + +## Specializing generic classes explicitly + +The type parameter can be specified explicitly: + +```py +from typing import Generic, Literal, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + x: T + +reveal_type(C[int]()) # revealed: C[int] +reveal_type(C[Literal[5]]()) # revealed: C[Literal[5]] +``` + +The specialization must match the generic types: + +```py +# error: [too-many-positional-arguments] "Too many positional arguments to class `C`: expected 1, got 2" +reveal_type(C[int, int]()) # revealed: Unknown +``` + +If the type variable has an upper bound, the specialized type must satisfy that bound: + +```py +from typing import Union + +BoundedT = TypeVar("BoundedT", bound=int) +BoundedByUnionT = TypeVar("BoundedByUnionT", bound=Union[int, str]) + +class Bounded(Generic[BoundedT]): ... +class BoundedByUnion(Generic[BoundedByUnionT]): ... +class IntSubclass(int): ... + +reveal_type(Bounded[int]()) # revealed: Bounded[int] +reveal_type(Bounded[IntSubclass]()) # revealed: Bounded[IntSubclass] + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Bounded` is incorrect: Expected `int`, found `str`" +reveal_type(Bounded[str]()) # revealed: Unknown + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Bounded` is incorrect: Expected `int`, found `int | str`" +reveal_type(Bounded[int | str]()) # revealed: Unknown + +reveal_type(BoundedByUnion[int]()) # revealed: BoundedByUnion[int] +reveal_type(BoundedByUnion[IntSubclass]()) # revealed: BoundedByUnion[IntSubclass] +reveal_type(BoundedByUnion[str]()) # revealed: BoundedByUnion[str] +reveal_type(BoundedByUnion[int | str]()) # revealed: BoundedByUnion[int | str] +``` + +If the type variable is constrained, the specialized type must satisfy those constraints: + +```py +ConstrainedT = TypeVar("ConstrainedT", int, str) + +class Constrained(Generic[ConstrainedT]): ... + +reveal_type(Constrained[int]()) # revealed: Constrained[int] + +# TODO: error: [invalid-argument-type] +# TODO: revealed: Constrained[Unknown] +reveal_type(Constrained[IntSubclass]()) # revealed: Constrained[IntSubclass] + +reveal_type(Constrained[str]()) # revealed: Constrained[str] + +# TODO: error: [invalid-argument-type] +# TODO: revealed: Unknown +reveal_type(Constrained[int | str]()) # revealed: Constrained[int | str] + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Constrained` is incorrect: Expected `int | str`, found `object`" +reveal_type(Constrained[object]()) # revealed: Unknown +``` + +If the type variable has a default, it can be omitted: + +```py +WithDefaultU = TypeVar("WithDefaultU", default=int) + +class WithDefault(Generic[T, WithDefaultU]): ... + +reveal_type(WithDefault[str, str]()) # revealed: WithDefault[str, str] +reveal_type(WithDefault[str]()) # revealed: WithDefault[str, int] +``` + +## Inferring generic class parameters + +We can infer the type parameter from a type context: + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + x: T + +c: C[int] = C() +# TODO: revealed: C[int] +reveal_type(c) # revealed: C[Unknown] +``` + +The typevars of a fully specialized generic class should no longer be visible: + +```py +# TODO: revealed: int +reveal_type(c.x) # revealed: Unknown +``` + +If the type parameter is not specified explicitly, and there are no constraints that let us infer a +specific type, we infer the typevar's default type: + +```py +DefaultT = TypeVar("DefaultT", default=int) + +class D(Generic[DefaultT]): ... + +reveal_type(D()) # revealed: D[int] +``` + +If a typevar does not provide a default, we use `Unknown`: + +```py +reveal_type(C()) # revealed: C[Unknown] +``` + +## Inferring generic class parameters from constructors + +If the type of a constructor parameter is a class typevar, we can use that to infer the type +parameter. The types inferred from a type context and from a constructor parameter must be +consistent with each other. + +### `__new__` only + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + def __new__(cls, x: T) -> "C[T]": + return object.__new__(cls) + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### `__init__` only + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### Identical `__new__` and `__init__` signatures + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + def __new__(cls, x: T) -> "C[T]": + return object.__new__(cls) + + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### Compatible `__new__` and `__init__` signatures + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + def __new__(cls, *args, **kwargs) -> "C[T]": + return object.__new__(cls) + + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") + +class D(Generic[T]): + def __new__(cls, x: T) -> "D[T]": + return object.__new__(cls) + + def __init__(self, *args, **kwargs) -> None: ... + +reveal_type(D(1)) # revealed: D[int] + +# error: [invalid-assignment] "Object of type `D[str]` is not assignable to `D[int]`" +wrong_innards: D[int] = D("five") +``` + +### Both present, `__new__` inherited from a generic base class + +If either method comes from a generic base class, we don't currently use its inferred specialization +to specialize the class. + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") +U = TypeVar("U") +V = TypeVar("V") + +class C(Generic[T, U]): + def __new__(cls, *args, **kwargs) -> "C[T, U]": + return object.__new__(cls) + +class D(C[V, int]): + def __init__(self, x: V) -> None: ... + +reveal_type(D(1)) # revealed: D[int] +``` + +### `__init__` is itself generic + +```py +from typing import Generic, TypeVar + +S = TypeVar("S") +T = TypeVar("T") + +class C(Generic[T]): + def __init__(self, x: T, y: S) -> None: ... + +reveal_type(C(1, 1)) # revealed: C[int] +reveal_type(C(1, "string")) # revealed: C[int] +reveal_type(C(1, True)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five", 1) +``` + +### Some `__init__` overloads only apply to certain specializations + +```py +from typing import overload, Generic, TypeVar + +T = TypeVar("T") + +class C(Generic[T]): + @overload + def __init__(self: "C[str]", x: str) -> None: ... + @overload + def __init__(self: "C[bytes]", x: bytes) -> None: ... + @overload + def __init__(self: "C[int]", x: bytes) -> None: ... + @overload + def __init__(self, x: int) -> None: ... + def __init__(self, x: str | bytes | int) -> None: ... + +reveal_type(C("string")) # revealed: C[str] +reveal_type(C(b"bytes")) # revealed: C[bytes] +reveal_type(C(12)) # revealed: C[Unknown] + +C[str]("string") +C[str](b"bytes") # error: [no-matching-overload] +C[str](12) + +C[bytes]("string") # error: [no-matching-overload] +C[bytes](b"bytes") +C[bytes](12) + +C[int]("string") # error: [no-matching-overload] +C[int](b"bytes") +C[int](12) + +C[None]("string") # error: [no-matching-overload] +C[None](b"bytes") # error: [no-matching-overload] +C[None](12) +``` + +## Generic subclass + +When a generic subclass fills its superclass's type parameter with one of its own, the actual types +propagate through: + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") +U = TypeVar("U") +V = TypeVar("V") +W = TypeVar("W") + +class Parent(Generic[T]): + x: T + +class ExplicitlyGenericChild(Parent[U], Generic[U]): ... +class ExplicitlyGenericGrandchild(ExplicitlyGenericChild[V], Generic[V]): ... +class ExplicitlyGenericGreatgrandchild(ExplicitlyGenericGrandchild[W], Generic[W]): ... +class ImplicitlyGenericChild(Parent[U]): ... +class ImplicitlyGenericGrandchild(ImplicitlyGenericChild[V]): ... +class ImplicitlyGenericGreatgrandchild(ImplicitlyGenericGrandchild[W]): ... + +reveal_type(Parent[int]().x) # revealed: int +reveal_type(ExplicitlyGenericChild[int]().x) # revealed: int +reveal_type(ImplicitlyGenericChild[int]().x) # revealed: int +reveal_type(ExplicitlyGenericGrandchild[int]().x) # revealed: int +reveal_type(ImplicitlyGenericGrandchild[int]().x) # revealed: int +reveal_type(ExplicitlyGenericGreatgrandchild[int]().x) # revealed: int +reveal_type(ImplicitlyGenericGreatgrandchild[int]().x) # revealed: int +``` + +## Generic methods + +Generic classes can contain methods that are themselves generic. The generic methods can refer to +the typevars of the enclosing generic class, and introduce new (distinct) typevars that are only in +scope for the method. + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") +U = TypeVar("U") + +class C(Generic[T]): + def method(self, u: U) -> U: + return u + +c: C[int] = C[int]() +reveal_type(c.method("string")) # revealed: Literal["string"] +``` + +## Specializations propagate + +In a specialized generic alias, the specialization is applied to the attributes and methods of the +class. + +```py +from typing import Generic, TypeVar, Protocol + +T = TypeVar("T") +U = TypeVar("U") + +class LinkedList(Generic[T]): ... + +class C(Generic[T, U]): + x: T + y: U + + def method1(self) -> T: + return self.x + + def method2(self) -> U: + return self.y + + def method3(self) -> LinkedList[T]: + return LinkedList[T]() + +c = C[int, str]() +reveal_type(c.x) # revealed: int +reveal_type(c.y) # revealed: str +reveal_type(c.method1()) # revealed: int +reveal_type(c.method2()) # revealed: str +reveal_type(c.method3()) # revealed: LinkedList[int] + +class SomeProtocol(Protocol[T]): + x: T + +class Foo: + x: int + +class D(Generic[T, U]): + x: T + y: U + + def method1(self) -> T: + return self.x + + def method2(self) -> U: + return self.y + + def method3(self) -> SomeProtocol[T]: + return Foo() + +d = D[int, str]() +reveal_type(d.x) # revealed: int +reveal_type(d.y) # revealed: str +reveal_type(d.method1()) # revealed: int +reveal_type(d.method2()) # revealed: str +reveal_type(d.method3()) # revealed: SomeProtocol[int] +reveal_type(d.method3().x) # revealed: int +``` + +When a method is overloaded, the specialization is applied to all overloads. + +```py +from typing import overload, Generic, TypeVar + +S = TypeVar("S") + +class WithOverloadedMethod(Generic[T]): + @overload + def method(self, x: T) -> T: + return x + + @overload + def method(self, x: S) -> S | T: + return x + + def method(self, x: S | T) -> S | T: + return x + +reveal_type(WithOverloadedMethod[int].method) # revealed: Overload[(self, x: int) -> int, (self, x: S) -> S | int] +``` + +## Cyclic class definitions + +### F-bounded quantification + +A class can use itself as the type parameter of one of its superclasses. (This is also known as the +[curiously recurring template pattern][crtp] or [F-bounded quantification][f-bound].) + +#### In a stub file + +Here, `Sub` is not a generic class, since it fills its superclass's type parameter (with itself). + +```pyi +from typing import Generic, TypeVar + +T = TypeVar("T") + +class Base(Generic[T]): ... +class Sub(Base[Sub]): ... + +reveal_type(Sub) # revealed: <class 'Sub'> +``` + +#### With string forward references + +A similar case can work in a non-stub file, if forward references are stringified: + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class Base(Generic[T]): ... +class Sub(Base["Sub"]): ... + +reveal_type(Sub) # revealed: <class 'Sub'> +``` + +#### Without string forward references + +In a non-stub file, without stringified forward references, this raises a `NameError`: + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +class Base(Generic[T]): ... + +# error: [unresolved-reference] +class Sub(Base[Sub]): ... +``` + +### Cyclic inheritance as a generic parameter + +```pyi +from typing import Generic, TypeVar + +T = TypeVar("T") + +class Derived(list[Derived[T]], Generic[T]): ... +``` + +### Direct cyclic inheritance + +Inheritance that would result in a cyclic MRO is detected as an error. + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +# error: [unresolved-reference] +class C(C, Generic[T]): ... + +# error: [unresolved-reference] +class D(D[int], Generic[T]): ... +``` + +[crtp]: https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern +[f-bound]: https://en.wikipedia.org/wiki/Bounded_quantification#F-bounded_quantification diff --git a/crates/ty_python_semantic/resources/mdtest/generics/legacy/functions.md b/crates/ty_python_semantic/resources/mdtest/generics/legacy/functions.md new file mode 100644 index 0000000000000..651de8c08368a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/legacy/functions.md @@ -0,0 +1,322 @@ +# Generic functions: Legacy syntax + +## Typevar must be used at least twice + +If you're only using a typevar for a single parameter, you don't need the typevar — just use +`object` (or the typevar's upper bound): + +```py +from typing import TypeVar + +T = TypeVar("T") + +# TODO: error, should be (x: object) +def typevar_not_needed(x: T) -> None: + pass + +BoundedT = TypeVar("BoundedT", bound=int) + +# TODO: error, should be (x: int) +def bounded_typevar_not_needed(x: BoundedT) -> None: + pass +``` + +Typevars are only needed if you use them more than once. For instance, to specify that two +parameters must both have the same type: + +```py +def two_params(x: T, y: T) -> T: + return x +``` + +or to specify that a return value is the same as a parameter: + +```py +def return_value(x: T) -> T: + return x +``` + +Each typevar must also appear _somewhere_ in the parameter list: + +```py +def absurd() -> T: + # There's no way to construct a T! + raise ValueError("absurd") +``` + +## Inferring generic function parameter types + +If the type of a generic function parameter is a typevar, then we can infer what type that typevar +is bound to at each call site. + +```py +from typing import TypeVar + +T = TypeVar("T") + +def f(x: T) -> T: + return x + +reveal_type(f(1)) # revealed: Literal[1] +reveal_type(f(1.0)) # revealed: float +reveal_type(f(True)) # revealed: Literal[True] +reveal_type(f("string")) # revealed: Literal["string"] +``` + +## Inferring “deep” generic parameter types + +The matching up of call arguments and discovery of constraints on typevars can be a recursive +process for arbitrarily-nested generic classes and protocols in parameters. + +TODO: Note that we can currently only infer a specialization for a generic protocol when the +argument _explicitly_ implements the protocol by listing it as a base class. + +```py +from typing import Protocol, TypeVar + +T = TypeVar("T") + +class CanIndex(Protocol[T]): + def __getitem__(self, index: int) -> T: ... + +class ExplicitlyImplements(CanIndex[T]): ... + +def takes_in_list(x: list[T]) -> list[T]: + return x + +def takes_in_protocol(x: CanIndex[T]) -> T: + return x[0] + +def deep_list(x: list[str]) -> None: + reveal_type(takes_in_list(x)) # revealed: list[str] + # TODO: revealed: str + reveal_type(takes_in_protocol(x)) # revealed: Unknown + +def deeper_list(x: list[set[str]]) -> None: + reveal_type(takes_in_list(x)) # revealed: list[set[str]] + # TODO: revealed: set[str] + reveal_type(takes_in_protocol(x)) # revealed: Unknown + +def deep_explicit(x: ExplicitlyImplements[str]) -> None: + reveal_type(takes_in_protocol(x)) # revealed: str + +def deeper_explicit(x: ExplicitlyImplements[set[str]]) -> None: + reveal_type(takes_in_protocol(x)) # revealed: set[str] + +def takes_in_type(x: type[T]) -> type[T]: + return x + +reveal_type(takes_in_type(int)) # revealed: @Todo(unsupported type[X] special form) +``` + +This also works when passing in arguments that are subclasses of the parameter type. + +```py +class Sub(list[int]): ... +class GenericSub(list[T]): ... + +reveal_type(takes_in_list(Sub())) # revealed: list[int] +# TODO: revealed: int +reveal_type(takes_in_protocol(Sub())) # revealed: Unknown + +reveal_type(takes_in_list(GenericSub[str]())) # revealed: list[str] +# TODO: revealed: str +reveal_type(takes_in_protocol(GenericSub[str]())) # revealed: Unknown + +class ExplicitSub(ExplicitlyImplements[int]): ... +class ExplicitGenericSub(ExplicitlyImplements[T]): ... + +reveal_type(takes_in_protocol(ExplicitSub())) # revealed: int +reveal_type(takes_in_protocol(ExplicitGenericSub[str]())) # revealed: str +``` + +## Inferring a bound typevar + +<!-- snapshot-diagnostics --> + +```py +from typing import TypeVar +from typing_extensions import reveal_type + +T = TypeVar("T", bound=int) + +def f(x: T) -> T: + return x + +reveal_type(f(1)) # revealed: Literal[1] +reveal_type(f(True)) # revealed: Literal[True] +# error: [invalid-argument-type] +reveal_type(f("string")) # revealed: Unknown +``` + +## Inferring a constrained typevar + +<!-- snapshot-diagnostics --> + +```py +from typing import TypeVar +from typing_extensions import reveal_type + +T = TypeVar("T", int, None) + +def f(x: T) -> T: + return x + +reveal_type(f(1)) # revealed: int +reveal_type(f(True)) # revealed: int +reveal_type(f(None)) # revealed: None +# error: [invalid-argument-type] +reveal_type(f("string")) # revealed: Unknown +``` + +## Typevar constraints + +If a type parameter has an upper bound, that upper bound constrains which types can be used for that +typevar. This effectively adds the upper bound as an intersection to every appearance of the typevar +in the function. + +```py +from typing import TypeVar + +T = TypeVar("T", bound=int) + +def good_param(x: T) -> None: + reveal_type(x) # revealed: T +``` + +If the function is annotated as returning the typevar, this means that the upper bound is _not_ +assignable to that typevar, since return types are contravariant. In `bad`, we can infer that +`x + 1` has type `int`. But `T` might be instantiated with a narrower type than `int`, and so the +return value is not guaranteed to be compatible for all `T: int`. + +```py +def good_return(x: T) -> T: + return x + +def bad_return(x: T) -> T: + # error: [invalid-return-type] "Return type does not match returned value: expected `T`, found `int`" + return x + 1 +``` + +## All occurrences of the same typevar have the same type + +If a typevar appears multiple times in a function signature, all occurrences have the same type. + +```py +from typing import TypeVar + +T = TypeVar("T") +S = TypeVar("S") + +def different_types(cond: bool, t: T, s: S) -> T: + if cond: + return t + else: + # error: [invalid-return-type] "Return type does not match returned value: expected `T`, found `S`" + return s + +def same_types(cond: bool, t1: T, t2: T) -> T: + if cond: + return t1 + else: + return t2 +``` + +## All occurrences of the same constrained typevar have the same type + +The above is true even when the typevars are constrained. Here, both `int` and `str` have `__add__` +methods that are compatible with the return type, so the `return` expression is always well-typed: + +```py +from typing import TypeVar + +T = TypeVar("T", int, str) + +def same_constrained_types(t1: T, t2: T) -> T: + # TODO: no error + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `T` and `T`" + return t1 + t2 +``` + +This is _not_ the same as a union type, because of this additional constraint that the two +occurrences have the same type. In `unions_are_different`, `t1` and `t2` might have different types, +and an `int` and a `str` cannot be added together: + +```py +def unions_are_different(t1: int | str, t2: int | str) -> int | str: + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `int | str` and `int | str`" + return t1 + t2 +``` + +## Typevar inference is a unification problem + +When inferring typevar assignments in a generic function call, we cannot simply solve constraints +eagerly for each parameter in turn. We must solve a unification problem involving all of the +parameters simultaneously. + +```py +from typing import TypeVar + +T = TypeVar("T") + +def two_params(x: T, y: T) -> T: + return x + +reveal_type(two_params("a", "b")) # revealed: Literal["a", "b"] +reveal_type(two_params("a", 1)) # revealed: Literal["a", 1] +``` + +When one of the parameters is a union, we attempt to find the smallest specialization that satisfies +all of the constraints. + +```py +def union_param(x: T | None) -> T: + if x is None: + raise ValueError + return x + +reveal_type(union_param("a")) # revealed: Literal["a"] +reveal_type(union_param(1)) # revealed: Literal[1] +reveal_type(union_param(None)) # revealed: Unknown +``` + +```py +def union_and_nonunion_params(x: T | int, y: T) -> T: + return y + +reveal_type(union_and_nonunion_params(1, "a")) # revealed: Literal["a"] +reveal_type(union_and_nonunion_params("a", "a")) # revealed: Literal["a"] +reveal_type(union_and_nonunion_params(1, 1)) # revealed: Literal[1] +reveal_type(union_and_nonunion_params(3, 1)) # revealed: Literal[1] +reveal_type(union_and_nonunion_params("a", 1)) # revealed: Literal["a", 1] +``` + +```py +S = TypeVar("S") + +def tuple_param(x: T | S, y: tuple[T, S]) -> tuple[T, S]: + return y + +reveal_type(tuple_param("a", ("a", 1))) # revealed: tuple[Literal["a"], Literal[1]] +reveal_type(tuple_param(1, ("a", 1))) # revealed: tuple[Literal["a"], Literal[1]] +``` + +## Inferring nested generic function calls + +We can infer type assignments in nested calls to multiple generic functions. If they use the same +type variable, we do not confuse the two; `T@f` and `T@g` have separate types in each example below. + +```py +from typing import TypeVar + +T = TypeVar("T") + +def f(x: T) -> tuple[T, int]: + return (x, 1) + +def g(x: T) -> T | None: + return x + +reveal_type(f(g("a"))) # revealed: tuple[Literal["a"] | None, int] +reveal_type(g(f("a"))) # revealed: tuple[Literal["a"], int] | None +``` diff --git a/crates/ty_python_semantic/resources/mdtest/generics/legacy/variables.md b/crates/ty_python_semantic/resources/mdtest/generics/legacy/variables.md new file mode 100644 index 0000000000000..35cadfd39968b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/legacy/variables.md @@ -0,0 +1,175 @@ +# Legacy type variables + +The tests in this file focus on how type variables are defined using the legacy notation. Most +_uses_ of type variables are tested in other files in this directory; we do not duplicate every test +for both type variable syntaxes. + +Unless otherwise specified, all quotations come from the [Generics] section of the typing spec. + +## Type variables + +### Defining legacy type variables + +> Generics can be parameterized by using a factory available in `typing` called `TypeVar`. + +This was the only way to create type variables prior to PEP 695/Python 3.12. It is still available +in newer Python releases. + +```py +from typing import TypeVar + +T = TypeVar("T") +reveal_type(type(T)) # revealed: <class 'TypeVar'> +reveal_type(T) # revealed: typing.TypeVar +reveal_type(T.__name__) # revealed: Literal["T"] +``` + +### Directly assigned to a variable + +> A `TypeVar()` expression must always directly be assigned to a variable (it should not be used as +> part of a larger expression). + +```py +from typing import TypeVar + +T = TypeVar("T") +# TODO: no error +# error: [invalid-legacy-type-variable] +U: TypeVar = TypeVar("U") + +# error: [invalid-legacy-type-variable] "A legacy `typing.TypeVar` must be immediately assigned to a variable" +# error: [invalid-type-form] "Function calls are not allowed in type expressions" +TestList = list[TypeVar("W")] +``` + +### `TypeVar` parameter must match variable name + +> The argument to `TypeVar()` must be a string equal to the variable name to which it is assigned. + +```py +from typing import TypeVar + +# error: [invalid-legacy-type-variable] "The name of a legacy `typing.TypeVar` (`Q`) must match the name of the variable it is assigned to (`T`)" +T = TypeVar("Q") +``` + +### No redefinition + +> Type variables must not be redefined. + +```py +from typing import TypeVar + +T = TypeVar("T") + +# TODO: error +T = TypeVar("T") +``` + +### Type variables with a default + +Note that the `__default__` property is only available in Python ≥3.13. + +```toml +[environment] +python-version = "3.13" +``` + +```py +from typing import TypeVar + +T = TypeVar("T", default=int) +reveal_type(T.__default__) # revealed: int +reveal_type(T.__bound__) # revealed: None +reveal_type(T.__constraints__) # revealed: tuple[()] + +S = TypeVar("S") +reveal_type(S.__default__) # revealed: NoDefault +``` + +### Using other typevars as a default + +```py +from typing import Generic, TypeVar, Union + +T = TypeVar("T") +U = TypeVar("U", default=T) +V = TypeVar("V", default=Union[T, U]) + +class Valid(Generic[T, U, V]): ... + +reveal_type(Valid()) # revealed: Valid[Unknown, Unknown, Unknown] +reveal_type(Valid[int]()) # revealed: Valid[int, int, int] +reveal_type(Valid[int, str]()) # revealed: Valid[int, str, int | str] +reveal_type(Valid[int, str, None]()) # revealed: Valid[int, str, None] + +# TODO: error, default value for U isn't available in the generic context +class Invalid(Generic[U]): ... +``` + +### Type variables with an upper bound + +```py +from typing import TypeVar + +T = TypeVar("T", bound=int) +reveal_type(T.__bound__) # revealed: int +reveal_type(T.__constraints__) # revealed: tuple[()] + +S = TypeVar("S") +reveal_type(S.__bound__) # revealed: None +``` + +### Type variables with constraints + +```py +from typing import TypeVar + +T = TypeVar("T", int, str) +reveal_type(T.__constraints__) # revealed: tuple[int, str] + +S = TypeVar("S") +reveal_type(S.__constraints__) # revealed: tuple[()] +``` + +### Cannot have only one constraint + +> `TypeVar` supports constraining parametric types to a fixed set of possible types...There should +> be at least two constraints, if any; specifying a single constraint is disallowed. + +```py +from typing import TypeVar + +# TODO: error: [invalid-type-variable-constraints] +T = TypeVar("T", int) +``` + +### Cannot be both covariant and contravariant + +> To facilitate the declaration of container types where covariant or contravariant type checking is +> acceptable, type variables accept keyword arguments `covariant=True` or `contravariant=True`. At +> most one of these may be passed. + +```py +from typing import TypeVar + +# error: [invalid-legacy-type-variable] +T = TypeVar("T", covariant=True, contravariant=True) +``` + +### Variance parameters must be unambiguous + +```py +from typing import TypeVar + +def cond() -> bool: + return True + +# error: [invalid-legacy-type-variable] +T = TypeVar("T", covariant=cond()) + +# error: [invalid-legacy-type-variable] +U = TypeVar("U", contravariant=cond()) +``` + +[generics]: https://typing.python.org/en/latest/spec/generics.html diff --git a/crates/ty_python_semantic/resources/mdtest/generics/legacy/variance.md b/crates/ty_python_semantic/resources/mdtest/generics/legacy/variance.md new file mode 100644 index 0000000000000..d66e2d913d284 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/legacy/variance.md @@ -0,0 +1,321 @@ +# Variance: Legacy syntax + +Type variables have a property called _variance_ that affects the subtyping and assignability +relations. Much more detail can be found in the [spec]. To summarize, each typevar is either +**covariant**, **contravariant**, **invariant**, or **bivariant**. (Note that bivariance is not +currently mentioned in the typing spec, but is a fourth case that we must consider.) + +For all of the examples below, we will consider typevars `T` and `U`, two generic classes using +those typevars `C[T]` and `D[U]`, and two types `A` and `B`. + +(Note that dynamic types like `Any` never participate in subtyping, so `C[Any]` is neither a subtype +nor supertype of any other specialization of `C`, regardless of `T`'s variance. It is, however, +assignable to any specialization of `C`, regardless of variance, via materialization.) + +## Covariance + +With a covariant typevar, subtyping and assignability are in "alignment": if `A <: B` and `C <: D`, +then `C[A] <: C[B]` and `C[A] <: D[B]`. + +Types that "produce" data on demand are covariant in their typevar. If you expect a sequence of +`int`s, someone can safely provide a sequence of `bool`s, since each `bool` element that you would +get from the sequence is a valid `int`. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any, Generic, TypeVar + +class A: ... +class B(A): ... + +T = TypeVar("T", covariant=True) +U = TypeVar("U", covariant=True) + +class C(Generic[T]): + def receive(self) -> T: + raise ValueError + +class D(C[U]): + pass + +static_assert(is_assignable_to(C[B], C[A])) +static_assert(not is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +static_assert(is_assignable_to(D[B], C[A])) +static_assert(not is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +static_assert(is_subtype_of(C[B], C[A])) +static_assert(not is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +static_assert(is_subtype_of(D[B], C[A])) +static_assert(not is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Contravariance + +With a contravariant typevar, subtyping and assignability are in "opposition": if `A <: B` and +`C <: D`, then `C[B] <: C[A]` and `D[B] <: C[A]`. + +Types that "consume" data are contravariant in their typevar. If you expect a consumer that receives +`bool`s, someone can safely provide a consumer that expects to receive `int`s, since each `bool` +that you pass into the consumer is a valid `int`. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any, Generic, TypeVar + +class A: ... +class B(A): ... + +T = TypeVar("T", contravariant=True) +U = TypeVar("U", contravariant=True) + +class C(Generic[T]): + def send(self, value: T): ... + +class D(C[U]): + pass + +static_assert(not is_assignable_to(C[B], C[A])) +static_assert(is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +static_assert(not is_assignable_to(D[B], C[A])) +static_assert(is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +static_assert(not is_subtype_of(C[B], C[A])) +static_assert(is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +static_assert(not is_subtype_of(D[B], C[A])) +static_assert(is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Invariance + +With an invariant typevar, only equivalent specializations of the generic class are subtypes of or +assignable to each other. + +This often occurs for types that are both producers _and_ consumers, like a mutable `list`. +Iterating over the elements in a list would work with a covariant typevar, just like with the +"producer" type above. Appending elements to a list would work with a contravariant typevar, just +like with the "consumer" type above. However, a typevar cannot be both covariant and contravariant +at the same time! + +If you expect a mutable list of `int`s, it's not safe for someone to provide you with a mutable list +of `bool`s, since you might try to add an element to the list: if you try to add an `int`, the list +would no longer only contain elements that are subtypes of `bool`. + +Conversely, if you expect a mutable list of `bool`s, it's not safe for someone to provide you with a +mutable list of `int`s, since you might try to extract elements from the list: you expect every +element that you extract to be a subtype of `bool`, but the list can contain any `int`. + +In the end, if you expect a mutable list, you must always be given a list of exactly that type, +since we can't know in advance which of the allowed methods you'll want to use. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any, Generic, TypeVar + +class A: ... +class B(A): ... + +T = TypeVar("T") +U = TypeVar("U") + +class C(Generic[T]): + def send(self, value: T): ... + def receive(self) -> T: + raise ValueError + +class D(C[U]): + pass + +static_assert(not is_assignable_to(C[B], C[A])) +static_assert(not is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +static_assert(not is_assignable_to(D[B], C[A])) +static_assert(not is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +static_assert(not is_subtype_of(C[B], C[A])) +static_assert(not is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +static_assert(not is_subtype_of(D[B], C[A])) +static_assert(not is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Bivariance + +With a bivariant typevar, _all_ specializations of the generic class are assignable to (and in fact, +gradually equivalent to) each other, and all fully static specializations are subtypes of (and +equivalent to) each other. + +It is not possible to construct a legacy typevar that is explicitly bivariant. + +[spec]: https://typing.python.org/en/latest/spec/generics.html#variance diff --git a/crates/ty_python_semantic/resources/mdtest/generics/pep695/classes.md b/crates/ty_python_semantic/resources/mdtest/generics/pep695/classes.md new file mode 100644 index 0000000000000..c205d4661739e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/pep695/classes.md @@ -0,0 +1,469 @@ +# Generic classes: PEP 695 syntax + +```toml +[environment] +python-version = "3.13" +``` + +## Defining a generic class + +At its simplest, to define a generic class using PEP 695 syntax, you add a list of typevars after +the class name. + +```py +from ty_extensions import generic_context + +class SingleTypevar[T]: ... +class MultipleTypevars[T, S]: ... + +reveal_type(generic_context(SingleTypevar)) # revealed: tuple[T] +reveal_type(generic_context(MultipleTypevars)) # revealed: tuple[T, S] +``` + +You cannot use the same typevar more than once. + +```py +# error: [invalid-syntax] "duplicate type parameter" +class RepeatedTypevar[T, T]: ... +``` + +You can only use typevars (TODO: or param specs or typevar tuples) in the class's generic context. + +```py +# TODO: error +class GenericOfType[int]: ... +``` + +You can also define a generic class by inheriting from some _other_ generic class, and specializing +it with typevars. With PEP 695 syntax, you must explicitly list all of the typevars that you use in +your base classes. + +```py +class InheritedGeneric[U, V](MultipleTypevars[U, V]): ... +class InheritedGenericPartiallySpecialized[U](MultipleTypevars[U, int]): ... +class InheritedGenericFullySpecialized(MultipleTypevars[str, int]): ... + +reveal_type(generic_context(InheritedGeneric)) # revealed: tuple[U, V] +reveal_type(generic_context(InheritedGenericPartiallySpecialized)) # revealed: tuple[U] +reveal_type(generic_context(InheritedGenericFullySpecialized)) # revealed: None +``` + +If you don't specialize a generic base class, we use the default specialization, which maps each +typevar to its default value or `Any`. Since that base class is fully specialized, it does not make +the inheriting class generic. + +```py +class InheritedGenericDefaultSpecialization(MultipleTypevars): ... + +reveal_type(generic_context(InheritedGenericDefaultSpecialization)) # revealed: None +``` + +You cannot use PEP-695 syntax and the legacy syntax in the same class definition. + +```py +from typing import Generic, TypeVar + +T = TypeVar("T") + +# error: [invalid-generic-class] "Cannot both inherit from `typing.Generic` and use PEP 695 type variables" +class BothGenericSyntaxes[U](Generic[T]): ... +``` + +## Specializing generic classes explicitly + +The type parameter can be specified explicitly: + +```py +from typing import Literal + +class C[T]: + x: T + +reveal_type(C[int]()) # revealed: C[int] +reveal_type(C[Literal[5]]()) # revealed: C[Literal[5]] +``` + +The specialization must match the generic types: + +```py +# error: [too-many-positional-arguments] "Too many positional arguments to class `C`: expected 1, got 2" +reveal_type(C[int, int]()) # revealed: Unknown +``` + +If the type variable has an upper bound, the specialized type must satisfy that bound: + +```py +class Bounded[T: int]: ... +class BoundedByUnion[T: int | str]: ... +class IntSubclass(int): ... + +reveal_type(Bounded[int]()) # revealed: Bounded[int] +reveal_type(Bounded[IntSubclass]()) # revealed: Bounded[IntSubclass] + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Bounded` is incorrect: Expected `int`, found `str`" +reveal_type(Bounded[str]()) # revealed: Unknown + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Bounded` is incorrect: Expected `int`, found `int | str`" +reveal_type(Bounded[int | str]()) # revealed: Unknown + +reveal_type(BoundedByUnion[int]()) # revealed: BoundedByUnion[int] +reveal_type(BoundedByUnion[IntSubclass]()) # revealed: BoundedByUnion[IntSubclass] +reveal_type(BoundedByUnion[str]()) # revealed: BoundedByUnion[str] +reveal_type(BoundedByUnion[int | str]()) # revealed: BoundedByUnion[int | str] +``` + +If the type variable is constrained, the specialized type must satisfy those constraints: + +```py +class Constrained[T: (int, str)]: ... + +reveal_type(Constrained[int]()) # revealed: Constrained[int] + +# TODO: error: [invalid-argument-type] +# TODO: revealed: Constrained[Unknown] +reveal_type(Constrained[IntSubclass]()) # revealed: Constrained[IntSubclass] + +reveal_type(Constrained[str]()) # revealed: Constrained[str] + +# TODO: error: [invalid-argument-type] +# TODO: revealed: Unknown +reveal_type(Constrained[int | str]()) # revealed: Constrained[int | str] + +# TODO: update this diagnostic to talk about type parameters and specializations +# error: [invalid-argument-type] "Argument to class `Constrained` is incorrect: Expected `int | str`, found `object`" +reveal_type(Constrained[object]()) # revealed: Unknown +``` + +If the type variable has a default, it can be omitted: + +```py +class WithDefault[T, U = int]: ... + +reveal_type(WithDefault[str, str]()) # revealed: WithDefault[str, str] +reveal_type(WithDefault[str]()) # revealed: WithDefault[str, int] +``` + +## Inferring generic class parameters + +We can infer the type parameter from a type context: + +```py +class C[T]: + x: T + +c: C[int] = C() +# TODO: revealed: C[int] +reveal_type(c) # revealed: C[Unknown] +``` + +The typevars of a fully specialized generic class should no longer be visible: + +```py +# TODO: revealed: int +reveal_type(c.x) # revealed: Unknown +``` + +If the type parameter is not specified explicitly, and there are no constraints that let us infer a +specific type, we infer the typevar's default type: + +```py +class D[T = int]: ... + +reveal_type(D()) # revealed: D[int] +``` + +If a typevar does not provide a default, we use `Unknown`: + +```py +reveal_type(C()) # revealed: C[Unknown] +``` + +## Inferring generic class parameters from constructors + +If the type of a constructor parameter is a class typevar, we can use that to infer the type +parameter. The types inferred from a type context and from a constructor parameter must be +consistent with each other. + +### `__new__` only + +```py +class C[T]: + def __new__(cls, x: T) -> "C[T]": + return object.__new__(cls) + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### `__init__` only + +```py +class C[T]: + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### Identical `__new__` and `__init__` signatures + +```py +class C[T]: + def __new__(cls, x: T) -> "C[T]": + return object.__new__(cls) + + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") +``` + +### Compatible `__new__` and `__init__` signatures + +```py +class C[T]: + def __new__(cls, *args, **kwargs) -> "C[T]": + return object.__new__(cls) + + def __init__(self, x: T) -> None: ... + +reveal_type(C(1)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five") + +class D[T]: + def __new__(cls, x: T) -> "D[T]": + return object.__new__(cls) + + def __init__(self, *args, **kwargs) -> None: ... + +reveal_type(D(1)) # revealed: D[int] + +# error: [invalid-assignment] "Object of type `D[str]` is not assignable to `D[int]`" +wrong_innards: D[int] = D("five") +``` + +### Both present, `__new__` inherited from a generic base class + +If either method comes from a generic base class, we don't currently use its inferred specialization +to specialize the class. + +```py +class C[T, U]: + def __new__(cls, *args, **kwargs) -> "C[T, U]": + return object.__new__(cls) + +class D[V](C[V, int]): + def __init__(self, x: V) -> None: ... + +reveal_type(D(1)) # revealed: D[int] +``` + +### `__init__` is itself generic + +```py +class C[T]: + def __init__[S](self, x: T, y: S) -> None: ... + +reveal_type(C(1, 1)) # revealed: C[int] +reveal_type(C(1, "string")) # revealed: C[int] +reveal_type(C(1, True)) # revealed: C[int] + +# error: [invalid-assignment] "Object of type `C[str]` is not assignable to `C[int]`" +wrong_innards: C[int] = C("five", 1) +``` + +### Some `__init__` overloads only apply to certain specializations + +```py +from typing import overload + +class C[T]: + @overload + def __init__(self: C[str], x: str) -> None: ... + @overload + def __init__(self: C[bytes], x: bytes) -> None: ... + @overload + def __init__(self: C[int], x: bytes) -> None: ... + @overload + def __init__(self, x: int) -> None: ... + def __init__(self, x: str | bytes | int) -> None: ... + +reveal_type(C("string")) # revealed: C[str] +reveal_type(C(b"bytes")) # revealed: C[bytes] +reveal_type(C(12)) # revealed: C[Unknown] + +C[str]("string") +C[str](b"bytes") # error: [no-matching-overload] +C[str](12) + +C[bytes]("string") # error: [no-matching-overload] +C[bytes](b"bytes") +C[bytes](12) + +C[int]("string") # error: [no-matching-overload] +C[int](b"bytes") +C[int](12) + +C[None]("string") # error: [no-matching-overload] +C[None](b"bytes") # error: [no-matching-overload] +C[None](12) +``` + +## Generic subclass + +When a generic subclass fills its superclass's type parameter with one of its own, the actual types +propagate through: + +```py +class Parent[T]: + x: T + +class Child[U](Parent[U]): ... +class Grandchild[V](Child[V]): ... +class Greatgrandchild[W](Child[W]): ... + +reveal_type(Parent[int]().x) # revealed: int +reveal_type(Child[int]().x) # revealed: int +reveal_type(Grandchild[int]().x) # revealed: int +reveal_type(Greatgrandchild[int]().x) # revealed: int +``` + +## Generic methods + +Generic classes can contain methods that are themselves generic. The generic methods can refer to +the typevars of the enclosing generic class, and introduce new (distinct) typevars that are only in +scope for the method. + +```py +class C[T]: + def method[U](self, u: U) -> U: + return u + # error: [unresolved-reference] + def cannot_use_outside_of_method(self, u: U): ... + + # TODO: error + def cannot_shadow_class_typevar[T](self, t: T): ... + +c: C[int] = C[int]() +reveal_type(c.method("string")) # revealed: Literal["string"] +``` + +## Specializations propagate + +In a specialized generic alias, the specialization is applied to the attributes and methods of the +class. + +```py +class LinkedList[T]: ... + +class C[T, U]: + x: T + y: U + + def method1(self) -> T: + return self.x + + def method2(self) -> U: + return self.y + + def method3(self) -> LinkedList[T]: + return LinkedList[T]() + +c = C[int, str]() +reveal_type(c.x) # revealed: int +reveal_type(c.y) # revealed: str +reveal_type(c.method1()) # revealed: int +reveal_type(c.method2()) # revealed: str +reveal_type(c.method3()) # revealed: LinkedList[int] +``` + +When a method is overloaded, the specialization is applied to all overloads. + +```py +from typing import overload + +class WithOverloadedMethod[T]: + @overload + def method(self, x: T) -> T: + return x + + @overload + def method[S](self, x: S) -> S | T: + return x + + def method[S](self, x: S | T) -> S | T: + return x + +reveal_type(WithOverloadedMethod[int].method) # revealed: Overload[(self, x: int) -> int, (self, x: S) -> S | int] +``` + +## Cyclic class definitions + +### F-bounded quantification + +A class can use itself as the type parameter of one of its superclasses. (This is also known as the +[curiously recurring template pattern][crtp] or [F-bounded quantification][f-bound].) + +#### In a stub file + +Here, `Sub` is not a generic class, since it fills its superclass's type parameter (with itself). + +```pyi +class Base[T]: ... +class Sub(Base[Sub]): ... + +reveal_type(Sub) # revealed: <class 'Sub'> +``` + +#### With string forward references + +A similar case can work in a non-stub file, if forward references are stringified: + +```py +class Base[T]: ... +class Sub(Base["Sub"]): ... + +reveal_type(Sub) # revealed: <class 'Sub'> +``` + +#### Without string forward references + +In a non-stub file, without stringified forward references, this raises a `NameError`: + +```py +class Base[T]: ... + +# error: [unresolved-reference] +class Sub(Base[Sub]): ... +``` + +### Cyclic inheritance as a generic parameter + +```pyi +class Derived[T](list[Derived[T]]): ... +``` + +### Direct cyclic inheritance + +Inheritance that would result in a cyclic MRO is detected as an error. + +```py +# error: [cyclic-class-definition] +class C[T](C): ... + +# error: [cyclic-class-definition] +class D[T](D[int]): ... +``` + +[crtp]: https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern +[f-bound]: https://en.wikipedia.org/wiki/Bounded_quantification#F-bounded_quantification diff --git a/crates/ty_python_semantic/resources/mdtest/generics/pep695/functions.md b/crates/ty_python_semantic/resources/mdtest/generics/pep695/functions.md new file mode 100644 index 0000000000000..c9357ecc26684 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/pep695/functions.md @@ -0,0 +1,343 @@ +# Generic functions: PEP 695 syntax + +```toml +[environment] +python-version = "3.12" +``` + +## Typevar must be used at least twice + +If you're only using a typevar for a single parameter, you don't need the typevar — just use +`object` (or the typevar's upper bound): + +```py +# TODO: error, should be (x: object) +def typevar_not_needed[T](x: T) -> None: + pass + +# TODO: error, should be (x: int) +def bounded_typevar_not_needed[T: int](x: T) -> None: + pass +``` + +Typevars are only needed if you use them more than once. For instance, to specify that two +parameters must both have the same type: + +```py +def two_params[T](x: T, y: T) -> T: + return x +``` + +or to specify that a return value is the same as a parameter: + +```py +def return_value[T](x: T) -> T: + return x +``` + +Each typevar must also appear _somewhere_ in the parameter list: + +```py +def absurd[T]() -> T: + # There's no way to construct a T! + raise ValueError("absurd") +``` + +## Inferring generic function parameter types + +If the type of a generic function parameter is a typevar, then we can infer what type that typevar +is bound to at each call site. + +```py +def f[T](x: T) -> T: + return x + +reveal_type(f(1)) # revealed: Literal[1] +reveal_type(f(1.0)) # revealed: float +reveal_type(f(True)) # revealed: Literal[True] +reveal_type(f("string")) # revealed: Literal["string"] +``` + +## Inferring “deep” generic parameter types + +The matching up of call arguments and discovery of constraints on typevars can be a recursive +process for arbitrarily-nested generic classes and protocols in parameters. + +TODO: Note that we can currently only infer a specialization for a generic protocol when the +argument _explicitly_ implements the protocol by listing it as a base class. + +```py +from typing import Protocol, TypeVar + +S = TypeVar("S") + +class CanIndex(Protocol[S]): + def __getitem__(self, index: int) -> S: ... + +class ExplicitlyImplements[T](CanIndex[T]): ... + +def takes_in_list[T](x: list[T]) -> list[T]: + return x + +def takes_in_protocol[T](x: CanIndex[T]) -> T: + return x[0] + +def deep_list(x: list[str]) -> None: + reveal_type(takes_in_list(x)) # revealed: list[str] + # TODO: revealed: str + reveal_type(takes_in_protocol(x)) # revealed: Unknown + +def deeper_list(x: list[set[str]]) -> None: + reveal_type(takes_in_list(x)) # revealed: list[set[str]] + # TODO: revealed: set[str] + reveal_type(takes_in_protocol(x)) # revealed: Unknown + +def deep_explicit(x: ExplicitlyImplements[str]) -> None: + reveal_type(takes_in_protocol(x)) # revealed: str + +def deeper_explicit(x: ExplicitlyImplements[set[str]]) -> None: + reveal_type(takes_in_protocol(x)) # revealed: set[str] + +def takes_in_type[T](x: type[T]) -> type[T]: + return x + +reveal_type(takes_in_type(int)) # revealed: @Todo(unsupported type[X] special form) +``` + +This also works when passing in arguments that are subclasses of the parameter type. + +```py +class Sub(list[int]): ... +class GenericSub[T](list[T]): ... + +reveal_type(takes_in_list(Sub())) # revealed: list[int] +# TODO: revealed: int +reveal_type(takes_in_protocol(Sub())) # revealed: Unknown + +reveal_type(takes_in_list(GenericSub[str]())) # revealed: list[str] +# TODO: revealed: str +reveal_type(takes_in_protocol(GenericSub[str]())) # revealed: Unknown + +class ExplicitSub(ExplicitlyImplements[int]): ... +class ExplicitGenericSub[T](ExplicitlyImplements[T]): ... + +reveal_type(takes_in_protocol(ExplicitSub())) # revealed: int +reveal_type(takes_in_protocol(ExplicitGenericSub[str]())) # revealed: str +``` + +## Inferring a bound typevar + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def f[T: int](x: T) -> T: + return x + +reveal_type(f(1)) # revealed: Literal[1] +reveal_type(f(True)) # revealed: Literal[True] +# error: [invalid-argument-type] +reveal_type(f("string")) # revealed: Unknown +``` + +## Inferring a constrained typevar + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def f[T: (int, None)](x: T) -> T: + return x + +reveal_type(f(1)) # revealed: int +reveal_type(f(True)) # revealed: int +reveal_type(f(None)) # revealed: None +# error: [invalid-argument-type] +reveal_type(f("string")) # revealed: Unknown +``` + +## Typevar constraints + +If a type parameter has an upper bound, that upper bound constrains which types can be used for that +typevar. This effectively adds the upper bound as an intersection to every appearance of the typevar +in the function. + +```py +def good_param[T: int](x: T) -> None: + reveal_type(x) # revealed: T +``` + +If the function is annotated as returning the typevar, this means that the upper bound is _not_ +assignable to that typevar, since return types are contravariant. In `bad`, we can infer that +`x + 1` has type `int`. But `T` might be instantiated with a narrower type than `int`, and so the +return value is not guaranteed to be compatible for all `T: int`. + +```py +def good_return[T: int](x: T) -> T: + return x + +def bad_return[T: int](x: T) -> T: + # error: [invalid-return-type] "Return type does not match returned value: expected `T`, found `int`" + return x + 1 +``` + +## All occurrences of the same typevar have the same type + +If a typevar appears multiple times in a function signature, all occurrences have the same type. + +```py +def different_types[T, S](cond: bool, t: T, s: S) -> T: + if cond: + return t + else: + # error: [invalid-return-type] "Return type does not match returned value: expected `T`, found `S`" + return s + +def same_types[T](cond: bool, t1: T, t2: T) -> T: + if cond: + return t1 + else: + return t2 +``` + +## All occurrences of the same constrained typevar have the same type + +The above is true even when the typevars are constrained. Here, both `int` and `str` have `__add__` +methods that are compatible with the return type, so the `return` expression is always well-typed: + +```py +def same_constrained_types[T: (int, str)](t1: T, t2: T) -> T: + # TODO: no error + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `T` and `T`" + return t1 + t2 +``` + +This is _not_ the same as a union type, because of this additional constraint that the two +occurrences have the same type. In `unions_are_different`, `t1` and `t2` might have different types, +and an `int` and a `str` cannot be added together: + +```py +def unions_are_different(t1: int | str, t2: int | str) -> int | str: + # error: [unsupported-operator] "Operator `+` is unsupported between objects of type `int | str` and `int | str`" + return t1 + t2 +``` + +## Typevar inference is a unification problem + +When inferring typevar assignments in a generic function call, we cannot simply solve constraints +eagerly for each parameter in turn. We must solve a unification problem involving all of the +parameters simultaneously. + +```py +def two_params[T](x: T, y: T) -> T: + return x + +reveal_type(two_params("a", "b")) # revealed: Literal["a", "b"] +reveal_type(two_params("a", 1)) # revealed: Literal["a", 1] +``` + +When one of the parameters is a union, we attempt to find the smallest specialization that satisfies +all of the constraints. + +```py +def union_param[T](x: T | None) -> T: + if x is None: + raise ValueError + return x + +reveal_type(union_param("a")) # revealed: Literal["a"] +reveal_type(union_param(1)) # revealed: Literal[1] +reveal_type(union_param(None)) # revealed: Unknown +``` + +```py +def union_and_nonunion_params[T](x: T | int, y: T) -> T: + return y + +reveal_type(union_and_nonunion_params(1, "a")) # revealed: Literal["a"] +reveal_type(union_and_nonunion_params("a", "a")) # revealed: Literal["a"] +reveal_type(union_and_nonunion_params(1, 1)) # revealed: Literal[1] +reveal_type(union_and_nonunion_params(3, 1)) # revealed: Literal[1] +reveal_type(union_and_nonunion_params("a", 1)) # revealed: Literal["a", 1] +``` + +```py +def tuple_param[T, S](x: T | S, y: tuple[T, S]) -> tuple[T, S]: + return y + +reveal_type(tuple_param("a", ("a", 1))) # revealed: tuple[Literal["a"], Literal[1]] +reveal_type(tuple_param(1, ("a", 1))) # revealed: tuple[Literal["a"], Literal[1]] +``` + +## Inferring nested generic function calls + +We can infer type assignments in nested calls to multiple generic functions. If they use the same +type variable, we do not confuse the two; `T@f` and `T@g` have separate types in each example below. + +```py +def f[T](x: T) -> tuple[T, int]: + return (x, 1) + +def g[T](x: T) -> T | None: + return x + +reveal_type(f(g("a"))) # revealed: tuple[Literal["a"] | None, int] +reveal_type(g(f("a"))) # revealed: tuple[Literal["a"], int] | None +``` + +## Protocols as TypeVar bounds + +Protocol types can be used as TypeVar bounds, just like nominal types. + +```py +from typing import Any, Protocol +from ty_extensions import static_assert, is_assignable_to + +class SupportsClose(Protocol): + def close(self) -> None: ... + +class ClosableFullyStaticProtocol(Protocol): + x: int + def close(self) -> None: ... + +class ClosableNonFullyStaticProtocol(Protocol): + x: Any + def close(self) -> None: ... + +class ClosableFullyStaticNominal: + x: int + def close(self) -> None: ... + +class ClosableNonFullyStaticNominal: + x: int + def close(self) -> None: ... + +class NotClosableProtocol(Protocol): ... +class NotClosableNominal: ... + +def close_and_return[T: SupportsClose](x: T) -> T: + x.close() + return x + +def f( + a: SupportsClose, + b: ClosableFullyStaticProtocol, + c: ClosableNonFullyStaticProtocol, + d: ClosableFullyStaticNominal, + e: ClosableNonFullyStaticNominal, + f: NotClosableProtocol, + g: NotClosableNominal, +): + reveal_type(close_and_return(a)) # revealed: SupportsClose + reveal_type(close_and_return(b)) # revealed: ClosableFullyStaticProtocol + reveal_type(close_and_return(c)) # revealed: ClosableNonFullyStaticProtocol + reveal_type(close_and_return(d)) # revealed: ClosableFullyStaticNominal + reveal_type(close_and_return(e)) # revealed: ClosableNonFullyStaticNominal + + # error: [invalid-argument-type] "does not satisfy upper bound" + reveal_type(close_and_return(f)) # revealed: Unknown + # error: [invalid-argument-type] "does not satisfy upper bound" + reveal_type(close_and_return(g)) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/generics/pep695/variables.md b/crates/ty_python_semantic/resources/mdtest/generics/pep695/variables.md new file mode 100644 index 0000000000000..15a7e651e6c64 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/pep695/variables.md @@ -0,0 +1,749 @@ +# PEP 695 Generics + +```toml +[environment] +python-version = "3.12" +``` + +[PEP 695] and Python 3.12 introduced new, more ergonomic syntax for type variables. + +## Type variables + +### Defining PEP 695 type variables + +PEP 695 introduces a new syntax for defining type variables. The resulting type variables are +instances of `typing.TypeVar`, just like legacy type variables. + +```py +def f[T](): + reveal_type(type(T)) # revealed: <class 'TypeVar'> + reveal_type(T) # revealed: typing.TypeVar + reveal_type(T.__name__) # revealed: Literal["T"] +``` + +### Type variables with a default + +Note that the `__default__` property is only available in Python ≥3.13. + +```toml +[environment] +python-version = "3.13" +``` + +```py +def f[T = int](): + reveal_type(T.__default__) # revealed: int + reveal_type(T.__bound__) # revealed: None + reveal_type(T.__constraints__) # revealed: tuple[()] + +def g[S](): + reveal_type(S.__default__) # revealed: NoDefault +``` + +### Using other typevars as a default + +```toml +[environment] +python-version = "3.13" +``` + +```py +class Valid[T, U = T, V = T | U]: ... + +reveal_type(Valid()) # revealed: Valid[Unknown, Unknown, Unknown] +reveal_type(Valid[int]()) # revealed: Valid[int, int, int] +reveal_type(Valid[int, str]()) # revealed: Valid[int, str, int | str] +reveal_type(Valid[int, str, None]()) # revealed: Valid[int, str, None] + +# error: [unresolved-reference] +class Invalid[S = T]: ... +``` + +### Type variables with an upper bound + +```py +def f[T: int](): + reveal_type(T.__bound__) # revealed: int + reveal_type(T.__constraints__) # revealed: tuple[()] + +def g[S](): + reveal_type(S.__bound__) # revealed: None +``` + +### Type variables with constraints + +```py +def f[T: (int, str)](): + reveal_type(T.__constraints__) # revealed: tuple[int, str] + reveal_type(T.__bound__) # revealed: None + +def g[S](): + reveal_type(S.__constraints__) # revealed: tuple[()] +``` + +### Cannot have only one constraint + +> `TypeVar` supports constraining parametric types to a fixed set of possible types...There should +> be at least two constraints, if any; specifying a single constraint is disallowed. + +```py +# error: [invalid-type-variable-constraints] "TypeVar must have at least two constrained types" +def f[T: (int,)](): + pass +``` + +## Invalid uses + +Note that many of the invalid uses of legacy typevars do not apply to PEP 695 typevars, since the +PEP 695 syntax is only allowed places where typevars are allowed. + +## Displaying typevars + +We use a suffix when displaying the typevars of a generic function or class. This helps distinguish +different uses of the same typevar. + +```py +def f[T](x: T, y: T) -> None: + # TODO: revealed: T@f + reveal_type(x) # revealed: T + +class C[T]: + def m(self, x: T) -> None: + # TODO: revealed: T@c + reveal_type(x) # revealed: T +``` + +## Fully static typevars + +We consider a typevar to be fully static unless it has a non-fully-static bound or constraint. This +is true even though a fully static typevar might be specialized to a gradual form like `Any`. (This +is similar to how you can assign an expression whose type is not fully static to a target whose type +is.) + +```py +from ty_extensions import is_fully_static, static_assert +from typing import Any + +def unbounded_unconstrained[T](t: T) -> None: + static_assert(is_fully_static(T)) + +def bounded[T: int](t: T) -> None: + static_assert(is_fully_static(T)) + +def bounded_by_gradual[T: Any](t: T) -> None: + static_assert(not is_fully_static(T)) + +def constrained[T: (int, str)](t: T) -> None: + static_assert(is_fully_static(T)) + +def constrained_by_gradual[T: (int, Any)](t: T) -> None: + static_assert(not is_fully_static(T)) +``` + +## Subtyping and assignability + +(Note: for simplicity, all of the prose in this section refers to _subtyping_ involving fully static +typevars. Unless otherwise noted, all of the claims also apply to _assignability_ involving gradual +typevars.) + +We can make no assumption about what type an unbounded, unconstrained, fully static typevar will be +specialized to. Properties are true of the typevar only if they are true for every valid +specialization. Thus, the typevar is a subtype of itself and of `object`, but not of any other type +(including other typevars). + +```py +from ty_extensions import is_assignable_to, is_subtype_of, static_assert + +class Super: ... +class Base(Super): ... +class Sub(Base): ... +class Unrelated: ... + +def unbounded_unconstrained[T, U](t: T, u: U) -> None: + static_assert(is_assignable_to(T, T)) + static_assert(is_assignable_to(T, object)) + static_assert(not is_assignable_to(T, Super)) + static_assert(is_assignable_to(U, U)) + static_assert(is_assignable_to(U, object)) + static_assert(not is_assignable_to(U, Super)) + static_assert(not is_assignable_to(T, U)) + static_assert(not is_assignable_to(U, T)) + + static_assert(is_subtype_of(T, T)) + static_assert(is_subtype_of(T, object)) + static_assert(not is_subtype_of(T, Super)) + static_assert(is_subtype_of(U, U)) + static_assert(is_subtype_of(U, object)) + static_assert(not is_subtype_of(U, Super)) + static_assert(not is_subtype_of(T, U)) + static_assert(not is_subtype_of(U, T)) +``` + +A bounded typevar is assignable to its bound, and a bounded, fully static typevar is a subtype of +its bound. (A typevar with a non-fully-static bound is itself non-fully-static, and therefore does +not participate in subtyping.) A fully static bound is not assignable to, nor a subtype of, the +typevar, since the typevar might be specialized to a smaller type. (This is true even if the bound +is a final class, since the typevar can still be specialized to `Never`.) + +```py +from typing import Any +from typing_extensions import final + +def bounded[T: Super](t: T) -> None: + static_assert(is_assignable_to(T, Super)) + static_assert(not is_assignable_to(T, Sub)) + static_assert(not is_assignable_to(Super, T)) + static_assert(not is_assignable_to(Sub, T)) + + static_assert(is_subtype_of(T, Super)) + static_assert(not is_subtype_of(T, Sub)) + static_assert(not is_subtype_of(Super, T)) + static_assert(not is_subtype_of(Sub, T)) + +def bounded_by_gradual[T: Any](t: T) -> None: + static_assert(is_assignable_to(T, Any)) + static_assert(is_assignable_to(Any, T)) + static_assert(is_assignable_to(T, Super)) + static_assert(not is_assignable_to(Super, T)) + static_assert(is_assignable_to(T, Sub)) + static_assert(not is_assignable_to(Sub, T)) + + static_assert(not is_subtype_of(T, Any)) + static_assert(not is_subtype_of(Any, T)) + static_assert(not is_subtype_of(T, Super)) + static_assert(not is_subtype_of(Super, T)) + static_assert(not is_subtype_of(T, Sub)) + static_assert(not is_subtype_of(Sub, T)) + +@final +class FinalClass: ... + +def bounded_final[T: FinalClass](t: T) -> None: + static_assert(is_assignable_to(T, FinalClass)) + static_assert(not is_assignable_to(FinalClass, T)) + + static_assert(is_subtype_of(T, FinalClass)) + static_assert(not is_subtype_of(FinalClass, T)) +``` + +Two distinct fully static typevars are not subtypes of each other, even if they have the same +bounds, since there is (still) no guarantee that they will be specialized to the same type. This is +true even if both typevars are bounded by the same final class, since you can specialize the +typevars to `Never` in addition to that final class. + +```py +def two_bounded[T: Super, U: Super](t: T, u: U) -> None: + static_assert(not is_assignable_to(T, U)) + static_assert(not is_assignable_to(U, T)) + + static_assert(not is_subtype_of(T, U)) + static_assert(not is_subtype_of(U, T)) + +def two_final_bounded[T: FinalClass, U: FinalClass](t: T, u: U) -> None: + static_assert(not is_assignable_to(T, U)) + static_assert(not is_assignable_to(U, T)) + + static_assert(not is_subtype_of(T, U)) + static_assert(not is_subtype_of(U, T)) +``` + +A constrained fully static typevar is assignable to the union of its constraints, but not to any of +the constraints individually. None of the constraints are subtypes of the typevar, though the +intersection of all of its constraints is a subtype of the typevar. + +```py +from ty_extensions import Intersection + +def constrained[T: (Base, Unrelated)](t: T) -> None: + static_assert(not is_assignable_to(T, Super)) + static_assert(not is_assignable_to(T, Base)) + static_assert(not is_assignable_to(T, Sub)) + static_assert(not is_assignable_to(T, Unrelated)) + static_assert(is_assignable_to(T, Super | Unrelated)) + static_assert(is_assignable_to(T, Base | Unrelated)) + static_assert(not is_assignable_to(T, Sub | Unrelated)) + static_assert(not is_assignable_to(Super, T)) + static_assert(not is_assignable_to(Unrelated, T)) + static_assert(not is_assignable_to(Super | Unrelated, T)) + static_assert(is_assignable_to(Intersection[Base, Unrelated], T)) + + static_assert(not is_subtype_of(T, Super)) + static_assert(not is_subtype_of(T, Base)) + static_assert(not is_subtype_of(T, Sub)) + static_assert(not is_subtype_of(T, Unrelated)) + static_assert(is_subtype_of(T, Super | Unrelated)) + static_assert(is_subtype_of(T, Base | Unrelated)) + static_assert(not is_subtype_of(T, Sub | Unrelated)) + static_assert(not is_subtype_of(Super, T)) + static_assert(not is_subtype_of(Unrelated, T)) + static_assert(not is_subtype_of(Super | Unrelated, T)) + static_assert(is_subtype_of(Intersection[Base, Unrelated], T)) + +def constrained_by_gradual[T: (Base, Any)](t: T) -> None: + static_assert(is_assignable_to(T, Super)) + static_assert(is_assignable_to(T, Base)) + static_assert(not is_assignable_to(T, Sub)) + static_assert(not is_assignable_to(T, Unrelated)) + static_assert(is_assignable_to(T, Any)) + static_assert(is_assignable_to(T, Super | Any)) + static_assert(is_assignable_to(T, Super | Unrelated)) + static_assert(not is_assignable_to(Super, T)) + static_assert(is_assignable_to(Base, T)) + static_assert(not is_assignable_to(Unrelated, T)) + static_assert(is_assignable_to(Any, T)) + static_assert(not is_assignable_to(Super | Any, T)) + static_assert(is_assignable_to(Base | Any, T)) + static_assert(not is_assignable_to(Super | Unrelated, T)) + static_assert(is_assignable_to(Intersection[Base, Unrelated], T)) + static_assert(is_assignable_to(Intersection[Base, Any], T)) + + static_assert(not is_subtype_of(T, Super)) + static_assert(not is_subtype_of(T, Base)) + static_assert(not is_subtype_of(T, Sub)) + static_assert(not is_subtype_of(T, Unrelated)) + static_assert(not is_subtype_of(T, Any)) + static_assert(not is_subtype_of(T, Super | Any)) + static_assert(not is_subtype_of(T, Super | Unrelated)) + static_assert(not is_subtype_of(Super, T)) + static_assert(not is_subtype_of(Base, T)) + static_assert(not is_subtype_of(Unrelated, T)) + static_assert(not is_subtype_of(Any, T)) + static_assert(not is_subtype_of(Super | Any, T)) + static_assert(not is_subtype_of(Base | Any, T)) + static_assert(not is_subtype_of(Super | Unrelated, T)) + static_assert(not is_subtype_of(Intersection[Base, Unrelated], T)) + static_assert(not is_subtype_of(Intersection[Base, Any], T)) +``` + +Two distinct fully static typevars are not subtypes of each other, even if they have the same +constraints, and even if any of the constraints are final. There must always be at least two +distinct constraints, meaning that there is (still) no guarantee that they will be specialized to +the same type. + +```py +def two_constrained[T: (int, str), U: (int, str)](t: T, u: U) -> None: + static_assert(not is_assignable_to(T, U)) + static_assert(not is_assignable_to(U, T)) + + static_assert(not is_subtype_of(T, U)) + static_assert(not is_subtype_of(U, T)) + +@final +class AnotherFinalClass: ... + +def two_final_constrained[T: (FinalClass, AnotherFinalClass), U: (FinalClass, AnotherFinalClass)](t: T, u: U) -> None: + static_assert(not is_assignable_to(T, U)) + static_assert(not is_assignable_to(U, T)) + + static_assert(not is_subtype_of(T, U)) + static_assert(not is_subtype_of(U, T)) +``` + +A bound or constrained typevar is a subtype of itself in a union: + +```py +def union[T: Base, U: (Base, Unrelated)](t: T, u: U) -> None: + static_assert(is_assignable_to(T, T | None)) + static_assert(is_assignable_to(U, U | None)) + + static_assert(is_subtype_of(T, T | None)) + static_assert(is_subtype_of(U, U | None)) +``` + +And an intersection of a typevar with another type is always a subtype of the TypeVar: + +```py +from ty_extensions import Intersection, Not, is_disjoint_from + +class A: ... + +def inter[T: Base, U: (Base, Unrelated)](t: T, u: U) -> None: + static_assert(is_assignable_to(Intersection[T, Unrelated], T)) + static_assert(is_subtype_of(Intersection[T, Unrelated], T)) + + static_assert(is_assignable_to(Intersection[U, A], U)) + static_assert(is_subtype_of(Intersection[U, A], U)) + + static_assert(is_disjoint_from(Not[T], T)) + static_assert(is_disjoint_from(T, Not[T])) + static_assert(is_disjoint_from(Not[U], U)) + static_assert(is_disjoint_from(U, Not[U])) +``` + +## Equivalence + +A fully static `TypeVar` is always equivalent to itself, but never to another `TypeVar`, since there +is no guarantee that they will be specialized to the same type. (This is true even if both typevars +are bounded by the same final class, since you can specialize the typevars to `Never` in addition to +that final class.) + +```py +from typing import final +from ty_extensions import is_equivalent_to, static_assert, is_gradual_equivalent_to + +@final +class FinalClass: ... + +@final +class SecondFinalClass: ... + +def f[A, B, C: FinalClass, D: FinalClass, E: (FinalClass, SecondFinalClass), F: (FinalClass, SecondFinalClass)](): + static_assert(is_equivalent_to(A, A)) + static_assert(is_equivalent_to(B, B)) + static_assert(is_equivalent_to(C, C)) + static_assert(is_equivalent_to(D, D)) + static_assert(is_equivalent_to(E, E)) + static_assert(is_equivalent_to(F, F)) + + static_assert(is_gradual_equivalent_to(A, A)) + static_assert(is_gradual_equivalent_to(B, B)) + static_assert(is_gradual_equivalent_to(C, C)) + static_assert(is_gradual_equivalent_to(D, D)) + static_assert(is_gradual_equivalent_to(E, E)) + static_assert(is_gradual_equivalent_to(F, F)) + + static_assert(not is_equivalent_to(A, B)) + static_assert(not is_equivalent_to(C, D)) + static_assert(not is_equivalent_to(E, F)) + + static_assert(not is_gradual_equivalent_to(A, B)) + static_assert(not is_gradual_equivalent_to(C, D)) + static_assert(not is_gradual_equivalent_to(E, F)) +``` + +TypeVars which have non-fully-static bounds or constraints do not participate in equivalence +relations, but do participate in gradual equivalence relations. + +```py +from typing import final, Any +from ty_extensions import is_equivalent_to, static_assert, is_gradual_equivalent_to + +# fmt: off + +def f[ + A: tuple[Any], + B: tuple[Any], + C: (tuple[Any], tuple[Any, Any]), + D: (tuple[Any], tuple[Any, Any]) +](): + static_assert(not is_equivalent_to(A, A)) + static_assert(not is_equivalent_to(B, B)) + static_assert(not is_equivalent_to(C, C)) + static_assert(not is_equivalent_to(D, D)) + + static_assert(is_gradual_equivalent_to(A, A)) + static_assert(is_gradual_equivalent_to(B, B)) + static_assert(is_gradual_equivalent_to(C, C)) + static_assert(is_gradual_equivalent_to(D, D)) + +# fmt: on +``` + +## Singletons and single-valued types + +(Note: for simplicity, all of the prose in this section refers to _singleton_ types, but all of the +claims also apply to _single-valued_ types.) + +An unbounded, unconstrained typevar is not a singleton, because it can be specialized to a +non-singleton type. + +```py +from ty_extensions import is_singleton, is_single_valued, static_assert + +def unbounded_unconstrained[T](t: T) -> None: + static_assert(not is_singleton(T)) + static_assert(not is_single_valued(T)) +``` + +A bounded typevar is not a singleton, even if its bound is a singleton, since it can still be +specialized to `Never`. + +```py +def bounded[T: None](t: T) -> None: + static_assert(not is_singleton(T)) + static_assert(not is_single_valued(T)) +``` + +A constrained typevar is a singleton if all of its constraints are singletons. (Note that you cannot +specialize a constrained typevar to a subtype of a constraint.) + +```py +from typing_extensions import Literal + +def constrained_non_singletons[T: (int, str)](t: T) -> None: + static_assert(not is_singleton(T)) + static_assert(not is_single_valued(T)) + +def constrained_singletons[T: (Literal[True], Literal[False])](t: T) -> None: + static_assert(is_singleton(T)) + +def constrained_single_valued[T: (Literal[True], tuple[()])](t: T) -> None: + static_assert(is_single_valued(T)) +``` + +## Unions involving typevars + +The union of an unbounded unconstrained typevar with any other type cannot be simplified, since +there is no guarantee what type the typevar will be specialized to. + +```py +from typing import Any + +class Super: ... +class Base(Super): ... +class Sub(Base): ... +class Unrelated: ... + +def unbounded_unconstrained[T](t: T) -> None: + def _(x: T | Super) -> None: + reveal_type(x) # revealed: T | Super + + def _(x: T | Base) -> None: + reveal_type(x) # revealed: T | Base + + def _(x: T | Sub) -> None: + reveal_type(x) # revealed: T | Sub + + def _(x: T | Unrelated) -> None: + reveal_type(x) # revealed: T | Unrelated + + def _(x: T | Any) -> None: + reveal_type(x) # revealed: T | Any +``` + +The union of a bounded typevar with its bound is that bound. (The typevar is guaranteed to be +specialized to a subtype of the bound.) The union of a bounded typevar with a subtype of its bound +cannot be simplified. (The typevar might be specialized to a different subtype of the bound.) + +```py +def bounded[T: Base](t: T) -> None: + def _(x: T | Super) -> None: + reveal_type(x) # revealed: Super + + def _(x: T | Base) -> None: + reveal_type(x) # revealed: Base + + def _(x: T | Sub) -> None: + reveal_type(x) # revealed: T | Sub + + def _(x: T | Unrelated) -> None: + reveal_type(x) # revealed: T | Unrelated + + def _(x: T | Any) -> None: + reveal_type(x) # revealed: T | Any +``` + +The union of a constrained typevar with a type depends on how that type relates to the constraints. +If all of the constraints are a subtype of that type, the union simplifies to that type. Inversely, +if the type is a subtype of every constraint, the union simplifies to the typevar. Otherwise, the +union cannot be simplified. + +```py +def constrained[T: (Base, Sub)](t: T) -> None: + def _(x: T | Super) -> None: + reveal_type(x) # revealed: Super + + def _(x: T | Base) -> None: + reveal_type(x) # revealed: Base + + def _(x: T | Sub) -> None: + reveal_type(x) # revealed: T + + def _(x: T | Unrelated) -> None: + reveal_type(x) # revealed: T | Unrelated + + def _(x: T | Any) -> None: + reveal_type(x) # revealed: T | Any +``` + +## Intersections involving typevars + +The intersection of an unbounded unconstrained typevar with any other type cannot be simplified, +since there is no guarantee what type the typevar will be specialized to. + +```py +from ty_extensions import Intersection +from typing import Any + +class Super: ... +class Base(Super): ... +class Sub(Base): ... +class Unrelated: ... + +def unbounded_unconstrained[T](t: T) -> None: + def _(x: Intersection[T, Super]) -> None: + reveal_type(x) # revealed: T & Super + + def _(x: Intersection[T, Base]) -> None: + reveal_type(x) # revealed: T & Base + + def _(x: Intersection[T, Sub]) -> None: + reveal_type(x) # revealed: T & Sub + + def _(x: Intersection[T, Unrelated]) -> None: + reveal_type(x) # revealed: T & Unrelated + + def _(x: Intersection[T, Any]) -> None: + reveal_type(x) # revealed: T & Any +``` + +The intersection of a bounded typevar with its bound or a supertype of its bound is the typevar +itself. (The typevar might be specialized to a subtype of the bound.) The intersection of a bounded +typevar with a subtype of its bound cannot be simplified. (The typevar might be specialized to a +different subtype of the bound.) The intersection of a bounded typevar with a type that is disjoint +from its bound is `Never`. + +```py +def bounded[T: Base](t: T) -> None: + def _(x: Intersection[T, Super]) -> None: + reveal_type(x) # revealed: T + + def _(x: Intersection[T, Base]) -> None: + reveal_type(x) # revealed: T + + def _(x: Intersection[T, Sub]) -> None: + reveal_type(x) # revealed: T & Sub + + def _(x: Intersection[T, None]) -> None: + reveal_type(x) # revealed: Never + + def _(x: Intersection[T, Any]) -> None: + reveal_type(x) # revealed: T & Any +``` + +Constrained typevars can be modeled using a hypothetical `OneOf` connector, where the typevar must +be specialized to _one_ of its constraints. The typevar is not the _union_ of those constraints, +since that would allow the typevar to take on values from _multiple_ constraints simultaneously. The +`OneOf` connector would not be a “type” according to a strict reading of the typing spec, since it +would not represent a single set of runtime objects; it would instead represent a _set of_ sets of +runtime objects. This is one reason we have not actually added this connector to our data model yet. +Nevertheless, describing constrained typevars this way helps explain how we simplify intersections +involving them. + +This means that when intersecting a constrained typevar with a type `T`, constraints that are +supertypes of `T` can be simplified to `T`, since intersection distributes over `OneOf`. Moreover, +constraints that are disjoint from `T` are no longer valid specializations of the typevar, since +`Never` is an identity for `OneOf`. After these simplifications, if only one constraint remains, we +can simplify the intersection as a whole to that constraint. + +```py +def constrained[T: (Base, Sub, Unrelated)](t: T) -> None: + def _(x: Intersection[T, Base]) -> None: + # With OneOf this would be OneOf[Base, Sub] + reveal_type(x) # revealed: T & Base + + def _(x: Intersection[T, Unrelated]) -> None: + reveal_type(x) # revealed: Unrelated + + def _(x: Intersection[T, Sub]) -> None: + reveal_type(x) # revealed: Sub + + def _(x: Intersection[T, None]) -> None: + reveal_type(x) # revealed: Never + + def _(x: Intersection[T, Any]) -> None: + reveal_type(x) # revealed: T & Any +``` + +We can simplify the intersection similarly when removing a type from a constrained typevar, since +this is modeled internally as an intersection with a negation. + +```py +from ty_extensions import Not + +def remove_constraint[T: (int, str, bool)](t: T) -> None: + def _(x: Intersection[T, Not[int]]) -> None: + reveal_type(x) # revealed: str & ~int + + def _(x: Intersection[T, Not[str]]) -> None: + # With OneOf this would be OneOf[int, bool] + reveal_type(x) # revealed: T & ~str + + def _(x: Intersection[T, Not[bool]]) -> None: + reveal_type(x) # revealed: T & ~bool + + def _(x: Intersection[T, Not[int], Not[str]]) -> None: + reveal_type(x) # revealed: Never + + def _(x: Intersection[T, Not[None]]) -> None: + reveal_type(x) # revealed: T + + def _(x: Intersection[T, Not[Any]]) -> None: + reveal_type(x) # revealed: T & Any +``` + +The intersection of a typevar with any other type is assignable to (and if fully static, a subtype +of) itself. + +```py +from ty_extensions import is_assignable_to, is_subtype_of, static_assert, Not + +def intersection_is_assignable[T](t: T) -> None: + static_assert(is_assignable_to(Intersection[T, None], T)) + static_assert(is_assignable_to(Intersection[T, Not[None]], T)) + + static_assert(is_subtype_of(Intersection[T, None], T)) + static_assert(is_subtype_of(Intersection[T, Not[None]], T)) +``` + +## Narrowing + +We can use narrowing expressions to eliminate some of the possibilities of a constrained typevar: + +```py +class P: ... +class Q: ... +class R: ... + +def f[T: (P, Q)](t: T) -> None: + if isinstance(t, P): + reveal_type(t) # revealed: P + p: P = t + else: + reveal_type(t) # revealed: Q & ~P + q: Q = t + + if isinstance(t, Q): + reveal_type(t) # revealed: Q + q: Q = t + else: + reveal_type(t) # revealed: P & ~Q + p: P = t + +def g[T: (P, Q, R)](t: T) -> None: + if isinstance(t, P): + reveal_type(t) # revealed: P + p: P = t + elif isinstance(t, Q): + reveal_type(t) # revealed: Q & ~P + q: Q = t + else: + reveal_type(t) # revealed: R & ~P & ~Q + r: R = t + + if isinstance(t, P): + reveal_type(t) # revealed: P + p: P = t + elif isinstance(t, Q): + reveal_type(t) # revealed: Q & ~P + q: Q = t + elif isinstance(t, R): + reveal_type(t) # revealed: R & ~P & ~Q + r: R = t + else: + reveal_type(t) # revealed: Never +``` + +If the constraints are disjoint, simplification does eliminate the redundant negative: + +```py +def h[T: (P, None)](t: T) -> None: + if t is None: + reveal_type(t) # revealed: None + p: None = t + else: + reveal_type(t) # revealed: P + p: P = t +``` + +[pep 695]: https://peps.python.org/pep-0695/ diff --git a/crates/ty_python_semantic/resources/mdtest/generics/pep695/variance.md b/crates/ty_python_semantic/resources/mdtest/generics/pep695/variance.md new file mode 100644 index 0000000000000..2e5b9507c6640 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/pep695/variance.md @@ -0,0 +1,449 @@ +# Variance: PEP 695 syntax + +```toml +[environment] +python-version = "3.12" +``` + +Type variables have a property called _variance_ that affects the subtyping and assignability +relations. Much more detail can be found in the [spec]. To summarize, each typevar is either +**covariant**, **contravariant**, **invariant**, or **bivariant**. (Note that bivariance is not +currently mentioned in the typing spec, but is a fourth case that we must consider.) + +For all of the examples below, we will consider typevars `T` and `U`, two generic classes using +those typevars `C[T]` and `D[U]`, and two types `A` and `B`. + +(Note that dynamic types like `Any` never participate in subtyping, so `C[Any]` is neither a subtype +nor supertype of any other specialization of `C`, regardless of `T`'s variance. It is, however, +assignable to any specialization of `C`, regardless of variance, via materialization.) + +## Covariance + +With a covariant typevar, subtyping and assignability are in "alignment": if `A <: B` and `C <: D`, +then `C[A] <: C[B]` and `C[A] <: D[B]`. + +Types that "produce" data on demand are covariant in their typevar. If you expect a sequence of +`int`s, someone can safely provide a sequence of `bool`s, since each `bool` element that you would +get from the sequence is a valid `int`. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any + +class A: ... +class B(A): ... + +class C[T]: + def receive(self) -> T: + raise ValueError + +class D[U](C[U]): + pass + +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(C[B], C[A])) +static_assert(not is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(D[B], C[A])) +static_assert(not is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(C[B], C[A])) +static_assert(not is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(D[B], C[A])) +static_assert(not is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Contravariance + +With a contravariant typevar, subtyping and assignability are in "opposition": if `A <: B` and +`C <: D`, then `C[B] <: C[A]` and `D[B] <: C[A]`. + +Types that "consume" data are contravariant in their typevar. If you expect a consumer that receives +`bool`s, someone can safely provide a consumer that expects to receive `int`s, since each `bool` +that you pass into the consumer is a valid `int`. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any + +class A: ... +class B(A): ... + +class C[T]: + def send(self, value: T): ... + +class D[U](C[U]): + pass + +static_assert(not is_assignable_to(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +static_assert(not is_assignable_to(D[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +static_assert(not is_subtype_of(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +static_assert(not is_subtype_of(D[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Invariance + +With an invariant typevar, only equivalent specializations of the generic class are subtypes of or +assignable to each other. + +This often occurs for types that are both producers _and_ consumers, like a mutable `list`. +Iterating over the elements in a list would work with a covariant typevar, just like with the +"producer" type above. Appending elements to a list would work with a contravariant typevar, just +like with the "consumer" type above. However, a typevar cannot be both covariant and contravariant +at the same time! + +If you expect a mutable list of `int`s, it's not safe for someone to provide you with a mutable list +of `bool`s, since you might try to add an element to the list: if you try to add an `int`, the list +would no longer only contain elements that are subtypes of `bool`. + +Conversely, if you expect a mutable list of `bool`s, it's not safe for someone to provide you with a +mutable list of `int`s, since you might try to extract elements from the list: you expect every +element that you extract to be a subtype of `bool`, but the list can contain any `int`. + +In the end, if you expect a mutable list, you must always be given a list of exactly that type, +since we can't know in advance which of the allowed methods you'll want to use. + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any + +class A: ... +class B(A): ... + +class C[T]: + def send(self, value: T): ... + def receive(self) -> T: + raise ValueError + +class D[U](C[U]): + pass + +static_assert(not is_assignable_to(C[B], C[A])) +static_assert(not is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +static_assert(not is_assignable_to(D[B], C[A])) +static_assert(not is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +static_assert(not is_subtype_of(C[B], C[A])) +static_assert(not is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +static_assert(not is_subtype_of(D[B], C[A])) +static_assert(not is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +static_assert(not is_equivalent_to(C[B], C[A])) +static_assert(not is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(C[B], C[A])) +static_assert(not is_gradual_equivalent_to(C[A], C[B])) +static_assert(not is_gradual_equivalent_to(C[A], C[Any])) +static_assert(not is_gradual_equivalent_to(C[B], C[Any])) +static_assert(not is_gradual_equivalent_to(C[Any], C[A])) +static_assert(not is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +## Bivariance + +With a bivariant typevar, _all_ specializations of the generic class are assignable to (and in fact, +gradually equivalent to) each other, and all fully static specializations are subtypes of (and +equivalent to) each other. + +This is a bit of pathological case, which really only happens when the class doesn't use the typevar +at all. (If it did, it would have to be covariant, contravariant, or invariant, depending on _how_ +the typevar was used.) + +```py +from ty_extensions import is_assignable_to, is_equivalent_to, is_gradual_equivalent_to, is_subtype_of, static_assert, Unknown +from typing import Any + +class A: ... +class B(A): ... + +class C[T]: + pass + +class D[U](C[U]): + pass + +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(C[A], C[B])) +static_assert(is_assignable_to(C[A], C[Any])) +static_assert(is_assignable_to(C[B], C[Any])) +static_assert(is_assignable_to(C[Any], C[A])) +static_assert(is_assignable_to(C[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(D[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_assignable_to(D[A], C[B])) +static_assert(is_assignable_to(D[A], C[Any])) +static_assert(is_assignable_to(D[B], C[Any])) +static_assert(is_assignable_to(D[Any], C[A])) +static_assert(is_assignable_to(D[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(C[A], C[B])) +static_assert(not is_subtype_of(C[A], C[Any])) +static_assert(not is_subtype_of(C[B], C[Any])) +static_assert(not is_subtype_of(C[Any], C[A])) +static_assert(not is_subtype_of(C[Any], C[B])) + +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(D[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_subtype_of(D[A], C[B])) +static_assert(not is_subtype_of(D[A], C[Any])) +static_assert(not is_subtype_of(D[B], C[Any])) +static_assert(not is_subtype_of(D[Any], C[A])) +static_assert(not is_subtype_of(D[Any], C[B])) + +static_assert(is_equivalent_to(C[A], C[A])) +static_assert(is_equivalent_to(C[B], C[B])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_equivalent_to(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_equivalent_to(C[A], C[B])) +static_assert(not is_equivalent_to(C[A], C[Any])) +static_assert(not is_equivalent_to(C[B], C[Any])) +static_assert(not is_equivalent_to(C[Any], C[A])) +static_assert(not is_equivalent_to(C[Any], C[B])) + +static_assert(not is_equivalent_to(D[A], C[A])) +static_assert(not is_equivalent_to(D[B], C[B])) +static_assert(not is_equivalent_to(D[B], C[A])) +static_assert(not is_equivalent_to(D[A], C[B])) +static_assert(not is_equivalent_to(D[A], C[Any])) +static_assert(not is_equivalent_to(D[B], C[Any])) +static_assert(not is_equivalent_to(D[Any], C[A])) +static_assert(not is_equivalent_to(D[Any], C[B])) + +static_assert(is_gradual_equivalent_to(C[A], C[A])) +static_assert(is_gradual_equivalent_to(C[B], C[B])) +static_assert(is_gradual_equivalent_to(C[Any], C[Any])) +static_assert(is_gradual_equivalent_to(C[Any], C[Unknown])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[B], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[A], C[B])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[A], C[Any])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[B], C[Any])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[Any], C[A])) +# TODO: no error +# error: [static-assert-error] +static_assert(is_gradual_equivalent_to(C[Any], C[B])) + +static_assert(not is_gradual_equivalent_to(D[A], C[A])) +static_assert(not is_gradual_equivalent_to(D[B], C[B])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[Unknown])) +static_assert(not is_gradual_equivalent_to(D[B], C[A])) +static_assert(not is_gradual_equivalent_to(D[A], C[B])) +static_assert(not is_gradual_equivalent_to(D[A], C[Any])) +static_assert(not is_gradual_equivalent_to(D[B], C[Any])) +static_assert(not is_gradual_equivalent_to(D[Any], C[A])) +static_assert(not is_gradual_equivalent_to(D[Any], C[B])) +``` + +[spec]: https://typing.python.org/en/latest/spec/generics.html#variance diff --git a/crates/ty_python_semantic/resources/mdtest/generics/scoping.md b/crates/ty_python_semantic/resources/mdtest/generics/scoping.md new file mode 100644 index 0000000000000..90426ff6b1e16 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/generics/scoping.md @@ -0,0 +1,291 @@ +# Scoping rules for type variables + +```toml +[environment] +python-version = "3.12" +``` + +Most of these tests come from the [Scoping rules for type variables][scoping] section of the typing +spec. + +## Typevar used outside of generic function or class + +Typevars may only be used in generic function or class definitions. + +```py +from typing import TypeVar + +T = TypeVar("T") + +# TODO: error +x: T + +class C: + # TODO: error + x: T + +def f() -> None: + # TODO: error + x: T +``` + +## Legacy typevar used multiple times + +> A type variable used in a generic function could be inferred to represent different types in the +> same code block. + +This only applies to typevars defined using the legacy syntax, since the PEP 695 syntax creates a +new distinct typevar for each occurrence. + +```py +from typing import TypeVar + +T = TypeVar("T") + +def f1(x: T) -> T: + return x + +def f2(x: T) -> T: + return x + +f1(1) +f2("a") +``` + +## Typevar inferred multiple times + +> A type variable used in a generic function could be inferred to represent different types in the +> same code block. + +This also applies to a single generic function being used multiple times, instantiating the typevar +to a different type each time. + +```py +def f[T](x: T) -> T: + return x + +reveal_type(f(1)) # revealed: Literal[1] +reveal_type(f("a")) # revealed: Literal["a"] +``` + +## Methods can mention class typevars + +> A type variable used in a method of a generic class that coincides with one of the variables that +> parameterize this class is always bound to that variable. + +```py +class C[T]: + def m1(self, x: T) -> T: + return x + + def m2(self, x: T) -> T: + return x + +c: C[int] = C[int]() +c.m1(1) +c.m2(1) +# error: [invalid-argument-type] "Argument to bound method `m2` is incorrect: Expected `int`, found `Literal["string"]`" +c.m2("string") +``` + +## Functions on generic classes are descriptors + +This repeats the tests in the [Functions as descriptors](./call/methods.md) test suite, but on a +generic class. This ensures that we are carrying any specializations through the entirety of the +descriptor protocol, which is how `self` parameters are bound to instance methods. + +```py +from inspect import getattr_static + +class C[T]: + def f(self, x: T) -> str: + return "a" + +reveal_type(getattr_static(C[int], "f")) # revealed: def f(self, x: int) -> str +reveal_type(getattr_static(C[int], "f").__get__) # revealed: <method-wrapper `__get__` of `f`> +reveal_type(getattr_static(C[int], "f").__get__(None, C[int])) # revealed: def f(self, x: int) -> str +# revealed: bound method C[int].f(x: int) -> str +reveal_type(getattr_static(C[int], "f").__get__(C[int](), C[int])) + +reveal_type(C[int].f) # revealed: def f(self, x: int) -> str +reveal_type(C[int]().f) # revealed: bound method C[int].f(x: int) -> str + +bound_method = C[int]().f +reveal_type(bound_method.__self__) # revealed: C[int] +reveal_type(bound_method.__func__) # revealed: def f(self, x: int) -> str + +reveal_type(C[int]().f(1)) # revealed: str +reveal_type(bound_method(1)) # revealed: str + +C[int].f(1) # error: [missing-argument] +reveal_type(C[int].f(C[int](), 1)) # revealed: str + +class D[U](C[U]): + pass + +reveal_type(D[int]().f) # revealed: bound method D[int].f(x: int) -> str +``` + +## Methods can mention other typevars + +> A type variable used in a method that does not match any of the variables that parameterize the +> class makes this method a generic function in that variable. + +```py +from typing import TypeVar, Generic + +T = TypeVar("T") +S = TypeVar("S") + +class Legacy(Generic[T]): + def m(self, x: T, y: S) -> S: + return y + +legacy: Legacy[int] = Legacy() +reveal_type(legacy.m(1, "string")) # revealed: Literal["string"] +``` + +With PEP 695 syntax, it is clearer that the method uses a separate typevar: + +```py +class C[T]: + def m[S](self, x: T, y: S) -> S: + return y + +c: C[int] = C() +reveal_type(c.m(1, "string")) # revealed: Literal["string"] +``` + +## Unbound typevars + +> Unbound type variables should not appear in the bodies of generic functions, or in the class +> bodies apart from method definitions. + +This is true with the legacy syntax: + +```py +from typing import TypeVar, Generic + +T = TypeVar("T") +S = TypeVar("S") + +def f(x: T) -> None: + x: list[T] = [] + # TODO: invalid-assignment error + y: list[S] = [] + +class C(Generic[T]): + # TODO: error: cannot use S if it's not in the current generic context + x: list[S] = [] + + # This is not an error, as shown in the previous test + def m(self, x: S) -> S: + return x +``` + +This is true with PEP 695 syntax, as well, though we must use the legacy syntax to define the +unbound typevars: + +`pep695.py`: + +```py +from typing import TypeVar + +S = TypeVar("S") + +def f[T](x: T) -> None: + x: list[T] = [] + # TODO: invalid assignment error + y: list[S] = [] + +class C[T]: + # TODO: error: cannot use S if it's not in the current generic context + x: list[S] = [] + + def m1(self, x: S) -> S: + return x + + def m2[S](self, x: S) -> S: + return x +``` + +## Nested formal typevars must be distinct + +Generic functions and classes can be nested in each other, but it is an error for the same typevar +to be used in nested generic definitions. + +Note that the typing spec only mentions two specific versions of this rule: + +> A generic class definition that appears inside a generic function should not use type variables +> that parameterize the generic function. + +and + +> A generic class nested in another generic class cannot use the same type variables. + +We assume that the more general form holds. + +### Generic function within generic function + +```py +def f[T](x: T, y: T) -> None: + def ok[S](a: S, b: S) -> None: ... + + # TODO: error + def bad[T](a: T, b: T) -> None: ... +``` + +### Generic method within generic class + +```py +class C[T]: + def ok[S](self, a: S, b: S) -> None: ... + + # TODO: error + def bad[T](self, a: T, b: T) -> None: ... +``` + +### Generic class within generic function + +```py +from typing import Iterable + +def f[T](x: T, y: T) -> None: + class Ok[S]: ... + # TODO: error for reuse of typevar + class Bad1[T]: ... + # TODO: error for reuse of typevar + class Bad2(Iterable[T]): ... +``` + +### Generic class within generic class + +```py +from typing import Iterable + +class C[T]: + class Ok1[S]: ... + # TODO: error for reuse of typevar + class Bad1[T]: ... + # TODO: error for reuse of typevar + class Bad2(Iterable[T]): ... +``` + +## Class scopes do not cover inner scopes + +Just like regular symbols, the typevars of a generic class are only available in that class's scope, +and are not available in nested scopes. + +```py +class C[T]: + ok1: list[T] = [] + + class Bad: + # TODO: error: cannot refer to T in nested scope + bad: list[T] = [] + + class Inner[S]: ... + ok2: Inner[T] +``` + +[scoping]: https://typing.python.org/en/latest/spec/generics.html#scoping-rules-for-type-variables diff --git a/crates/ty_python_semantic/resources/mdtest/import/basic.md b/crates/ty_python_semantic/resources/mdtest/import/basic.md new file mode 100644 index 0000000000000..60edbc392b7df --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/basic.md @@ -0,0 +1,178 @@ +# Structures + +## Class import following + +```py +from b import C as D + +E = D +reveal_type(E) # revealed: <class 'C'> +``` + +`b.py`: + +```py +class C: ... +``` + +## Module member resolution + +```py +import b + +D = b.C +reveal_type(D) # revealed: <class 'C'> +``` + +`b.py`: + +```py +class C: ... +``` + +## Nested + +```py +import a.b + +reveal_type(a.b.C) # revealed: <class 'C'> +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +class C: ... +``` + +## Deeply nested + +```py +import a.b.c + +reveal_type(a.b.c.C) # revealed: <class 'C'> +``` + +`a/__init__.py`: + +```py +``` + +`a/b/__init__.py`: + +```py +``` + +`a/b/c.py`: + +```py +class C: ... +``` + +## Nested with rename + +```py +import a.b as b + +reveal_type(b.C) # revealed: <class 'C'> +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +class C: ... +``` + +## Deeply nested with rename + +```py +import a.b.c as c + +reveal_type(c.C) # revealed: <class 'C'> +``` + +`a/__init__.py`: + +```py +``` + +`a/b/__init__.py`: + +```py +``` + +`a/b/c.py`: + +```py +class C: ... +``` + +## Unresolvable module import + +<!-- snapshot-diagnostics --> + +```py +import zqzqzqzqzqzqzq # error: [unresolved-import] "Cannot resolve imported module `zqzqzqzqzqzqzq`" +``` + +## Unresolvable submodule imports + +<!-- snapshot-diagnostics --> + +```py +# Topmost component resolvable, submodule not resolvable: +import a.foo # error: [unresolved-import] "Cannot resolve imported module `a.foo`" + +# Topmost component unresolvable: +import b.foo # error: [unresolved-import] "Cannot resolve imported module `b.foo`" +``` + +`a/__init__.py`: + +```py +``` + +## Long paths + +It's unlikely that a single module component is as long as in this example, but Windows treats paths +that are longer than 200 and something specially. This test ensures that ty can handle those paths +gracefully. + +```toml +system = "os" +``` + +`AveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPath/__init__.py`: + +```py +class Foo: ... +``` + +```py +from AveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPathAveryLongPath import ( + Foo, +) + +reveal_type(Foo()) # revealed: Foo +``` + +## Multiple objects imported from an unresolved module + +<!-- snapshot-diagnostics --> + +If multiple members are imported from a module that cannot be resolved, only a single diagnostic is +emitted for the `import from` statement: + +```py +# error: [unresolved-import] +from does_not_exist import foo, bar, baz +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/builtins.md b/crates/ty_python_semantic/resources/mdtest/import/builtins.md new file mode 100644 index 0000000000000..f8ef2a2f9a8f7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/builtins.md @@ -0,0 +1,78 @@ +# Builtins + +## Importing builtin module + +Builtin symbols can be explicitly imported: + +```py +import builtins + +reveal_type(builtins.chr) # revealed: def chr(i: SupportsIndex, /) -> str +``` + +## Implicit use of builtin + +Or used implicitly: + +```py +reveal_type(chr) # revealed: def chr(i: SupportsIndex, /) -> str +reveal_type(str) # revealed: <class 'str'> +``` + +## Builtin symbol from custom typeshed + +If we specify a custom typeshed, we can use the builtin symbol from it, and no longer access the +builtins from the "actual" vendored typeshed: + +```toml +[environment] +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/builtins.pyi`: + +```pyi +class Custom: ... + +custom_builtin: Custom +``` + +`/typeshed/stdlib/typing_extensions.pyi`: + +```pyi +def reveal_type(obj, /): ... +``` + +```py +reveal_type(custom_builtin) # revealed: Custom + +# error: [unresolved-reference] +reveal_type(str) # revealed: Unknown +``` + +## Unknown builtin (later defined) + +`foo` has a type of `Unknown` in this example, as it relies on `bar` which has not been defined at +that point: + +```toml +[environment] +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/builtins.pyi`: + +```pyi +foo = bar +bar = 1 +``` + +`/typeshed/stdlib/typing_extensions.pyi`: + +```pyi +def reveal_type(obj, /): ... +``` + +```py +reveal_type(foo) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/case_sensitive.md b/crates/ty_python_semantic/resources/mdtest/import/case_sensitive.md new file mode 100644 index 0000000000000..f822ba47e2aa9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/case_sensitive.md @@ -0,0 +1,128 @@ +# Case Sensitive Imports + +```toml +system = "os" +``` + +Python's import system is case-sensitive even on case-insensitive file system. This means, importing +a module `a` should fail if the file in the search paths is named `A.py`. See +[PEP 235](https://peps.python.org/pep-0235/). + +## Correct casing + +Importing a module where the name matches the file name's casing should succeed. + +`a.py`: + +```py +class Foo: + x: int = 1 +``` + +```python +from a import Foo + +reveal_type(Foo().x) # revealed: int +``` + +## Incorrect casing + +Importing a module where the name does not match the file name's casing should fail. + +`A.py`: + +```py +class Foo: + x: int = 1 +``` + +```python +# error: [unresolved-import] +from a import Foo +``` + +## Multiple search paths with different cased modules + +The resolved module is the first matching the file name's casing but Python falls back to later +search paths if the file name's casing does not match. + +```toml +[environment] +extra-paths = ["/search-1", "/search-2"] +``` + +`/search-1/A.py`: + +```py +class Foo: + x: int = 1 +``` + +`/search-2/a.py`: + +```py +class Bar: + x: str = "test" +``` + +```python +from A import Foo +from a import Bar + +reveal_type(Foo().x) # revealed: int +reveal_type(Bar().x) # revealed: str +``` + +## Intermediate segments + +`db/__init__.py`: + +```py +``` + +`db/a.py`: + +```py +class Foo: + x: int = 1 +``` + +`correctly_cased.py`: + +```python +from db.a import Foo + +reveal_type(Foo().x) # revealed: int +``` + +Imports where some segments are incorrectly cased should fail. + +`incorrectly_cased.py`: + +```python +# error: [unresolved-import] +from DB.a import Foo + +# error: [unresolved-import] +from DB.A import Foo + +# error: [unresolved-import] +from db.A import Foo +``` + +## Incorrect extension casing + +The extension of imported python modules must be `.py` or `.pyi` but not `.PY` or `Py` or any +variant where some characters are uppercase. + +`a.PY`: + +```py +class Foo: + x: int = 1 +``` + +```python +# error: [unresolved-import] +from a import Foo +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/conditional.md b/crates/ty_python_semantic/resources/mdtest/import/conditional.md new file mode 100644 index 0000000000000..703bf6078fd01 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/conditional.md @@ -0,0 +1,137 @@ +# Conditional imports + +## Maybe unbound + +`maybe_unbound.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + y = 3 + +x = y # error: [possibly-unresolved-reference] + +# revealed: Literal[3] +reveal_type(x) + +# revealed: Literal[3] +# error: [possibly-unresolved-reference] +reveal_type(y) +``` + +```py +# error: [possibly-unbound-import] "Member `y` of module `maybe_unbound` is possibly unbound" +from maybe_unbound import x, y + +reveal_type(x) # revealed: Unknown | Literal[3] +reveal_type(y) # revealed: Unknown | Literal[3] +``` + +## Maybe unbound annotated + +`maybe_unbound_annotated.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + y: int = 3 + +x = y # error: [possibly-unresolved-reference] + +# revealed: Literal[3] +reveal_type(x) + +# revealed: Literal[3] +# error: [possibly-unresolved-reference] +reveal_type(y) +``` + +Importing an annotated name prefers the declared type over the inferred type: + +```py +# error: [possibly-unbound-import] "Member `y` of module `maybe_unbound_annotated` is possibly unbound" +from maybe_unbound_annotated import x, y + +reveal_type(x) # revealed: Unknown | Literal[3] +reveal_type(y) # revealed: int +``` + +## Maybe undeclared + +Importing a possibly undeclared name still gives us its declared type: + +`maybe_undeclared.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + x: int +``` + +```py +from maybe_undeclared import x + +reveal_type(x) # revealed: int +``` + +## Reimport + +`c.py`: + +```py +def f(): ... +``` + +`b.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + from c import f +else: + def f(): ... +``` + +```py +from b import f + +# TODO: We should disambiguate in such cases between `b.f` and `c.f`. +reveal_type(f) # revealed: (def f() -> Unknown) | (def f() -> Unknown) +``` + +## Reimport with stub declaration + +When we have a declared type in one path and only an inferred-from-definition type in the other, we +should still be able to unify those: + +`c.pyi`: + +```pyi +x: int +``` + +`b.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + from c import x +else: + x = 1 +``` + +```py +from b import x + +reveal_type(x) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/conflicts.md b/crates/ty_python_semantic/resources/mdtest/import/conflicts.md new file mode 100644 index 0000000000000..353166220fdcd --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/conflicts.md @@ -0,0 +1,91 @@ +# Conflicting attributes and submodules + +## Via import + +```py +import a.b + +reveal_type(a.b) # revealed: <module 'a.b'> +``` + +`a/__init__.py`: + +```py +b: int = 42 +``` + +`a/b.py`: + +```py +``` + +## Via from/import + +```py +from a import b + +reveal_type(b) # revealed: int +``` + +`a/__init__.py`: + +```py +b: int = 42 +``` + +`a/b.py`: + +```py +``` + +## Via both + +```py +import a.b +from a import b + +reveal_type(b) # revealed: <module 'a.b'> +reveal_type(a.b) # revealed: <module 'a.b'> +``` + +`a/__init__.py`: + +```py +b: int = 42 +``` + +`a/b.py`: + +```py +``` + +## Via both (backwards) + +In this test, we infer a different type for `b` than the runtime behavior of the Python interpreter. +The interpreter will not load the submodule `a.b` during the `from a import b` statement, since `a` +contains a non-module attribute named `b`. (See the [definition][from-import] of a `from...import` +statement for details.) However, because our import tracking is flow-insensitive, we will see that +`a.b` is imported somewhere in the file, and therefore assume that the `from...import` statement +sees the submodule as the value of `b` instead of the integer. + +```py +from a import b +import a.b + +# Python would say `int` for `b` +reveal_type(b) # revealed: <module 'a.b'> +reveal_type(a.b) # revealed: <module 'a.b'> +``` + +`a/__init__.py`: + +```py +b: int = 42 +``` + +`a/b.py`: + +```py +``` + +[from-import]: https://docs.python.org/3/reference/simple_stmts.html#the-import-statement diff --git a/crates/ty_python_semantic/resources/mdtest/import/conventions.md b/crates/ty_python_semantic/resources/mdtest/import/conventions.md new file mode 100644 index 0000000000000..c4950b5d1cc61 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/conventions.md @@ -0,0 +1,411 @@ +# Import conventions + +This document describes the conventions for importing symbols. + +Reference: + +- <https://typing.python.org/en/latest/spec/distributing.html#import-conventions> + +## Builtins scope + +When looking up for a name, ty will fallback to using the builtins scope if the name is not found in +the global scope. The `builtins.pyi` file, that will be used to resolve any symbol in the builtins +scope, contains multiple symbols from other modules (e.g., `typing`) but those are not re-exported. + +```py +# These symbols are being imported in `builtins.pyi` but shouldn't be considered as being +# available in the builtins scope. + +# error: "Name `Literal` used when not defined" +reveal_type(Literal) # revealed: Unknown + +# error: "Name `sys` used when not defined" +reveal_type(sys) # revealed: Unknown +``` + +## Builtins import + +Similarly, trying to import the symbols from the builtins module which aren't re-exported should +also raise an error. + +```py +# error: "Module `builtins` has no member `Literal`" +# error: "Module `builtins` has no member `sys`" +from builtins import Literal, sys + +reveal_type(Literal) # revealed: Unknown +reveal_type(sys) # revealed: Unknown + +# error: "Module `math` has no member `Iterable`" +from math import Iterable + +reveal_type(Iterable) # revealed: Unknown +``` + +## Re-exported symbols in stub files + +When a symbol is re-exported, importing it should not raise an error. This tests both `import ...` +and `from ... import ...` forms. + +Note: Submodule imports in `import ...` form doesn't work because it's a syntax error. For example, +in `import os.path as os.path` the `os.path` is not a valid identifier. + +```py +from b import Any, Literal, foo + +reveal_type(Any) # revealed: typing.Any +reveal_type(Literal) # revealed: typing.Literal +reveal_type(foo) # revealed: <module 'foo'> +``` + +`b.pyi`: + +```pyi +import foo as foo +from typing import Any as Any, Literal as Literal +``` + +`foo.py`: + +```py +``` + +## Non-exported symbols in stub files + +Here, none of the symbols are being re-exported in the stub file. + +```py +# error: 15 [unresolved-import] "Module `b` has no member `foo`" +# error: 20 [unresolved-import] "Module `b` has no member `Any`" +# error: 25 [unresolved-import] "Module `b` has no member `Literal`" +from b import foo, Any, Literal + +reveal_type(Any) # revealed: Unknown +reveal_type(Literal) # revealed: Unknown +reveal_type(foo) # revealed: Unknown +``` + +`b.pyi`: + +```pyi +import foo +from typing import Any, Literal +``` + +`foo.pyi`: + +```pyi + +``` + +## Nested non-exports + +Here, a chain of modules all don't re-export an import. + +```py +# error: "Module `a` has no member `Any`" +from a import Any + +reveal_type(Any) # revealed: Unknown +``` + +`a.pyi`: + +```pyi +# error: "Module `b` has no member `Any`" +from b import Any + +reveal_type(Any) # revealed: Unknown +``` + +`b.pyi`: + +```pyi +# error: "Module `c` has no member `Any`" +from c import Any + +reveal_type(Any) # revealed: Unknown +``` + +`c.pyi`: + +```pyi +from typing import Any + +reveal_type(Any) # revealed: typing.Any +``` + +## Nested mixed re-export and not + +But, if the symbol is being re-exported explicitly in one of the modules in the chain, it should not +raise an error at that step in the chain. + +```py +# error: "Module `a` has no member `Any`" +from a import Any + +reveal_type(Any) # revealed: Unknown +``` + +`a.pyi`: + +```pyi +from b import Any + +reveal_type(Any) # revealed: Unknown +``` + +`b.pyi`: + +```pyi +# error: "Module `c` has no member `Any`" +from c import Any as Any + +reveal_type(Any) # revealed: Unknown +``` + +`c.pyi`: + +```pyi +from typing import Any + +reveal_type(Any) # revealed: typing.Any +``` + +## Exported as different name + +The re-export convention only works when the aliased name is exactly the same as the original name. + +```py +# error: "Module `a` has no member `Foo`" +from a import Foo + +reveal_type(Foo) # revealed: Unknown +``` + +`a.pyi`: + +```pyi +from b import AnyFoo as Foo + +reveal_type(Foo) # revealed: <class 'AnyFoo'> +``` + +`b.pyi`: + +```pyi +class AnyFoo: ... +``` + +## Exported using `__all__` + +Here, the symbol is re-exported using the `__all__` variable. + +```py +from a import Foo + +reveal_type(Foo) # revealed: <class 'Foo'> +``` + +`a.pyi`: + +```pyi +from b import Foo + +__all__ = ['Foo'] +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` + +## Re-exports with `__all__` + +If a symbol is re-exported via redundant alias but is not included in `__all__`, it shouldn't raise +an error when using named import. + +`named_import.py`: + +```py +from a import Foo + +reveal_type(Foo) # revealed: <class 'Foo'> +``` + +`a.pyi`: + +```pyi +from b import Foo as Foo + +__all__ = [] +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` + +However, a star import _would_ raise an error. + +`star_import.py`: + +```py +from a import * + +# error: [unresolved-reference] "Name `Foo` used when not defined" +reveal_type(Foo) # revealed: Unknown +``` + +## Re-exports in `__init__.pyi` + +Similarly, for an `__init__.pyi` (stub) file, importing a non-exported name should raise an error +but the inference would be `Unknown`. + +```py +# error: 15 "Module `a` has no member `Foo`" +# error: 20 "Module `a` has no member `c`" +from a import Foo, c, foo + +reveal_type(Foo) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(foo) # revealed: <module 'a.foo'> +``` + +`a/__init__.pyi`: + +```pyi +from .b import c +from .foo import Foo +``` + +`a/foo.pyi`: + +```pyi +class Foo: ... +``` + +`a/b/__init__.pyi`: + +```pyi + +``` + +`a/b/c.pyi`: + +```pyi + +``` + +## Conditional re-export in stub file + +The following scenarios are when a re-export happens conditionally in a stub file. + +### Global import + +```py +# error: "Member `Foo` of module `a` is possibly unbound" +from a import Foo + +reveal_type(Foo) # revealed: str +``` + +`a.pyi`: + +```pyi +from b import Foo + +def coinflip() -> bool: ... + +if coinflip(): + Foo: str = ... + +reveal_type(Foo) # revealed: <class 'Foo'> | str +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` + +### Both branch is an import + +Here, both the branches of the condition are import statements where one of them re-exports while +the other does not. + +```py +# error: "Member `Foo` of module `a` is possibly unbound" +from a import Foo + +reveal_type(Foo) # revealed: <class 'Foo'> +``` + +`a.pyi`: + +```pyi +def coinflip() -> bool: ... + +if coinflip(): + from b import Foo +else: + from b import Foo as Foo + +reveal_type(Foo) # revealed: <class 'Foo'> +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` + +### Re-export in one branch + +```py +# error: "Member `Foo` of module `a` is possibly unbound" +from a import Foo + +reveal_type(Foo) # revealed: <class 'Foo'> +``` + +`a.pyi`: + +```pyi +def coinflip() -> bool: ... + +if coinflip(): + from b import Foo as Foo +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` + +### Non-export in one branch + +```py +# error: "Module `a` has no member `Foo`" +from a import Foo + +reveal_type(Foo) # revealed: Unknown +``` + +`a.pyi`: + +```pyi +def coinflip() -> bool: ... + +if coinflip(): + from b import Foo +``` + +`b.pyi`: + +```pyi +class Foo: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/cyclic.md b/crates/ty_python_semantic/resources/mdtest/import/cyclic.md new file mode 100644 index 0000000000000..4af714c7dea14 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/cyclic.md @@ -0,0 +1,108 @@ +## Cyclic imports + +### Regression tests + +#### Issue 261 + +See: <https://github.com/astral-sh/ty/issues/261> + +`main.py`: + +```py +from foo import bar + +reveal_type(bar) # revealed: <module 'foo.bar'> +``` + +`foo/__init__.py`: + +```py +from foo import bar + +__all__ = ["bar"] +``` + +`foo/bar/__init__.py`: + +```py +# empty +``` + +#### Issue 113 + +See: <https://github.com/astral-sh/ty/issues/113> + +`main.py`: + +```py +from pkg.sub import A + +# TODO: This should be `<class 'A'>` +reveal_type(A) # revealed: Never +``` + +`pkg/outer.py`: + +```py +class A: ... +``` + +`pkg/sub/__init__.py`: + +```py +from ..outer import * +from .inner import * +``` + +`pkg/sub/inner.py`: + +```py +from pkg.sub import A +``` + +### Actual cycle + +The following example fails at runtime. Ideally, we would emit a diagnostic here. For now, we only +make sure that this does not lead to a module resolution cycle. + +`main.py`: + +```py +from module import x + +reveal_type(x) # revealed: Unknown +``` + +`module.py`: + +```py +# error: [unresolved-import] +from module import x +``` + +### Normal self-referential import + +Some modules like `sys` in typeshed import themselves. Here, we make sure that this does not lead to +cycles or unresolved imports. + +`module/__init__.py`: + +```py +import module # self-referential import + +from module.sub import x +``` + +`module/sub.py`: + +```py +x: int = 1 +``` + +`main.py`: + +```py +from module import x + +reveal_type(x) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/dunder_all.md b/crates/ty_python_semantic/resources/mdtest/import/dunder_all.md new file mode 100644 index 0000000000000..d77973265b0ac --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/dunder_all.md @@ -0,0 +1,845 @@ +# `__all__` + +Reference: +<https://typing.python.org/en/latest/spec/distributing.html#library-interface-public-and-private-symbols> + +NOTE: This file only includes the usage of `__all__` for named-imports i.e., +`from module import symbol`. For the usage of `__all__` in wildcard imports, refer to +[star.md](star.md). + +## Undefined + +`exporter.py`: + +```py +class A: ... +class B: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: None +reveal_type(dunder_all_names(exporter)) +``` + +## Global scope + +The `__all__` variable is only recognized from the global scope of the module. It is not recognized +from the local scope of a function or class. + +`exporter.py`: + +```py +__all__ = ["A"] + +def foo(): + __all__.append("B") + +class Foo: + __all__ += ["C"] + +class A: ... +class B: ... +class C: ... + +foo() +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"]] +reveal_type(dunder_all_names(exporter)) +``` + +## Supported idioms + +According to the [specification], the following idioms are supported: + +### List assignment + +`exporter.py`: + +```py +__all__ = ["A", "B"] + +class A: ... +class B: ... +``` + +`exporter_annotated.py`: + +```py +__all__: list[str] = ["C", "D"] + +class C: ... +class D: ... +``` + +`importer.py`: + +```py +import exporter +import exporter_annotated +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(exporter)) + +# revealed: tuple[Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter_annotated)) +``` + +### List assignment (shadowed) + +`exporter.py`: + +```py +__all__ = ["A", "B"] + +class A: ... +class B: ... + +__all__ = ["C", "D"] + +class C: ... +class D: ... +``` + +`exporter_annotated.py`: + +```py +__all__ = ["X"] + +class X: ... + +__all__: list[str] = ["Y", "Z"] + +class Y: ... +class Z: ... +``` + +`importer.py`: + +```py +import exporter +import exporter_annotated +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter)) + +# revealed: tuple[Literal["Y"], Literal["Z"]] +reveal_type(dunder_all_names(exporter_annotated)) +``` + +### Tuple assignment + +`exporter.py`: + +```py +__all__ = ("A", "B") + +class A: ... +class B: ... +``` + +`exporter_annotated.py`: + +```py +__all__: tuple[str, ...] = ("C", "D") + +class C: ... +class D: ... +``` + +`importer.py`: + +```py +import exporter +import exporter_annotated +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(exporter)) + +# revealed: tuple[Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter_annotated)) +``` + +### Tuple assignment (shadowed) + +`exporter.py`: + +```py +__all__ = ("A", "B") + +class A: ... +class B: ... + +__all__ = ("C", "D") + +class C: ... +class D: ... +``` + +`exporter_annotated.py`: + +```py +__all__ = ("X",) + +class X: ... + +__all__: tuple[str, ...] = ("Y", "Z") + +class Y: ... +class Z: ... +``` + +`importer.py`: + +```py +import exporter +import exporter_annotated +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter)) + +# revealed: tuple[Literal["Y"], Literal["Z"]] +reveal_type(dunder_all_names(exporter_annotated)) +``` + +### Augmenting list with a list or submodule `__all__` + +`subexporter.py`: + +```py +__all__ = ["A", "B"] + +class A: ... +class B: ... +``` + +`exporter.py`: + +```py +import subexporter + +__all__ = [] +__all__ += ["C", "D"] +__all__ += subexporter.__all__ + +class C: ... +class D: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"], Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Augmenting list with a list or submodule `__all__` (2) + +The same again, but the submodule is an attribute expression rather than a name expression: + +`exporter/__init__.py`: + +```py +``` + +`exporter/sub.py`: + +```py +__all__ = ["foo"] + +foo = 42 +``` + +`exporter/sub2.py`: + +```py +__all__ = ["bar"] + +bar = 56 +``` + +`module.py`: + +```py +import exporter.sub +import exporter.sub2 + +__all__ = [] + +if True: + __all__.extend(exporter.sub.__all__) + __all__ += exporter.sub2.__all__ +``` + +`main.py`: + +```py +import module +from ty_extensions import dunder_all_names + +reveal_type(dunder_all_names(module)) # revealed: tuple[Literal["bar"], Literal["foo"]] +``` + +### Extending with a list or submodule `__all__` + +`subexporter.py`: + +```py +__all__ = ["A", "B"] + +class A: ... +class B: ... +``` + +`exporter.py`: + +```py +import subexporter + +__all__ = [] +__all__.extend(["C", "D"]) +__all__.extend(("E", "F")) +__all__.extend({"G", "H"}) +__all__.extend(subexporter.__all__) + +class C: ... +class D: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"], Literal["C"], Literal["D"], Literal["E"], Literal["F"], Literal["G"], Literal["H"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Appending a single symbol + +`exporter.py`: + +```py +__all__ = ["A"] +__all__.append("B") + +class A: ... +class B: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Removing a single symbol + +`exporter.py`: + +```py +__all__ = ["A", "B"] +__all__.remove("A") + +# Non-existant symbol in `__all__` at this point +# TODO: This raises `ValueError` at runtime, maybe we should raise a diagnostic as well? +__all__.remove("C") + +class A: ... +class B: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["B"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Mixed + +`subexporter.py`: + +```py +__all__ = [] + +__all__ = ["A"] +__all__.append("B") +__all__.extend(["C"]) +__all__.remove("B") + +class A: ... +class B: ... +class C: ... +``` + +`exporter.py`: + +```py +import subexporter + +__all__ = [] +__all__ += ["D"] +__all__ += subexporter.__all__ + +class D: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["C"], Literal["D"]] +reveal_type(dunder_all_names(exporter)) +``` + +## Invalid + +### Unsupported idioms + +Idioms that are not mentioned in the [specification] are not recognized by `ty` and if they're used, +`__all__` is considered to be undefined for that module. This is to avoid false positives. + +`bar.py`: + +```py +__all__ = ["A", "B"] + +class A: ... +class B: ... +``` + +`foo.py`: + +```py +import bar as bar +``` + +`exporter.py`: + +```py +import foo +from ty_extensions import dunder_all_names + +__all__ = [] + +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(foo.bar)) + +# Only direct attribute access of modules are recognized +# TODO: warning diagnostic +__all__.extend(foo.bar.__all__) +# TODO: warning diagnostic +__all__ += foo.bar.__all__ + +# Augmented assignment is only allowed when the value is a list expression +# TODO: warning diagnostic +__all__ += ("C",) + +# Other methods on `list` are not recognized +# TODO: warning diagnostic +__all__.insert(0, "C") +# TODO: warning diagnostic +__all__.clear() + +__all__.append("C") +# `pop` is not valid; use `remove` instead +# TODO: warning diagnostic +__all__.pop() + +# Sets are not recognized +# TODO: warning diagnostic +__all__ = {"C", "D"} + +class C: ... +class D: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: None +reveal_type(dunder_all_names(exporter)) +``` + +### Non-string elements + +Similarly, if `__all__` contains any non-string elements, we will consider `__all__` to not be +defined for that module. This is also to avoid false positives. + +`subexporter.py`: + +```py +__all__ = ("A", "B") + +class A: ... +class B: ... +``` + +`exporter1.py`: + +```py +import subexporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(subexporter)) + +# TODO: warning diagnostic +__all__ = ("C", *subexporter.__all__) + +class C: ... +``` + +`importer.py`: + +```py +import exporter1 +from ty_extensions import dunder_all_names + +# revealed: None +reveal_type(dunder_all_names(exporter1)) +``` + +## Statically known branches + +### Python 3.10 + +```toml +[environment] +python-version = "3.10" +``` + +`exporter.py`: + +```py +import sys + +__all__ = ["AllVersion"] + +if sys.version_info >= (3, 12): + __all__ += ["Python312"] +elif sys.version_info >= (3, 11): + __all__ += ["Python311"] +else: + __all__ += ["Python310"] + +class AllVersion: ... + +if sys.version_info >= (3, 12): + class Python312: ... + +elif sys.version_info >= (3, 11): + class Python311: ... + +else: + class Python310: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["AllVersion"], Literal["Python310"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Python 3.11 + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +__all__ = ["AllVersion"] + +if sys.version_info >= (3, 12): + __all__ += ["Python312"] +elif sys.version_info >= (3, 11): + __all__ += ["Python311"] +else: + __all__ += ["Python310"] + +class AllVersion: ... + +if sys.version_info >= (3, 12): + class Python312: ... + +elif sys.version_info >= (3, 11): + class Python311: ... + +else: + class Python310: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["AllVersion"], Literal["Python311"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Python 3.12 + +```toml +[environment] +python-version = "3.12" +``` + +`exporter.py`: + +```py +import sys + +__all__ = ["AllVersion"] + +if sys.version_info >= (3, 12): + __all__ += ["Python312"] +elif sys.version_info >= (3, 11): + __all__ += ["Python311"] +else: + __all__ += ["Python310"] + +class AllVersion: ... + +if sys.version_info >= (3, 12): + class Python312: ... + +elif sys.version_info >= (3, 11): + class Python311: ... + +else: + class Python310: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["AllVersion"], Literal["Python312"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Multiple `if` statements + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +__all__ = ["AllVersion"] + +if sys.version_info >= (3, 12): + __all__ += ["Python312"] + +if sys.version_info >= (3, 11): + __all__ += ["Python311"] + +if sys.version_info >= (3, 10): + __all__ += ["Python310"] + +class AllVersion: ... + +if sys.version_info >= (3, 12): + class Python312: ... + +if sys.version_info >= (3, 11): + class Python311: ... + +if sys.version_info >= (3, 10): + class Python310: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["AllVersion"], Literal["Python310"], Literal["Python311"]] +reveal_type(dunder_all_names(exporter)) +``` + +## Origin + +`__all__` can be defined in a module mainly in the following three ways: + +### Directly in the module + +`exporter.py`: + +```py +__all__ = ["A"] + +class A: ... +``` + +`importer.py`: + +```py +import exporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Using named import + +`subexporter.py`: + +```py +__all__ = ["A"] + +class A: ... +``` + +`exporter.py`: + +```py +from subexporter import __all__ + +__all__.append("B") + +class B: ... +``` + +`importer.py`: + +```py +import exporter +import subexporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"]] +reveal_type(dunder_all_names(subexporter)) +# revealed: tuple[Literal["A"], Literal["B"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Using wildcard import (1) + +Wildcard import doesn't export `__all__` unless it is explicitly included in the `__all__` of the +module. + +`subexporter.py`: + +```py +__all__ = ["A", "__all__"] + +class A: ... +``` + +`exporter.py`: + +```py +from subexporter import * + +# TODO: Should be `list[str]` +# TODO: Should we avoid including `Unknown` for this case? +reveal_type(__all__) # revealed: Unknown | list[Unknown] + +__all__.append("B") + +class B: ... +``` + +`importer.py`: + +```py +import exporter +import subexporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"], Literal["__all__"]] +reveal_type(dunder_all_names(subexporter)) +# revealed: tuple[Literal["A"], Literal["B"], Literal["__all__"]] +reveal_type(dunder_all_names(exporter)) +``` + +### Using wildcard import (2) + +`subexporter.py`: + +```py +__all__ = ["A"] + +class A: ... +``` + +`exporter.py`: + +```py +from subexporter import * + +# error: [unresolved-reference] +reveal_type(__all__) # revealed: Unknown + +# error: [unresolved-reference] +__all__.append("B") + +class B: ... +``` + +`importer.py`: + +```py +import exporter +import subexporter +from ty_extensions import dunder_all_names + +# revealed: tuple[Literal["A"]] +reveal_type(dunder_all_names(subexporter)) +# revealed: None +reveal_type(dunder_all_names(exporter)) +``` + +[specification]: https://typing.python.org/en/latest/spec/distributing.html#library-interface-public-and-private-symbols diff --git a/crates/ty_python_semantic/resources/mdtest/import/errors.md b/crates/ty_python_semantic/resources/mdtest/import/errors.md new file mode 100644 index 0000000000000..14e785613ba35 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/errors.md @@ -0,0 +1,88 @@ +# Unresolved Imports + +## Unresolved import statement + +```py +import bar # error: "Cannot resolve imported module `bar`" + +reveal_type(bar) # revealed: Unknown +``` + +## Unresolved import from statement + +```py +from bar import baz # error: "Cannot resolve imported module `bar`" + +reveal_type(baz) # revealed: Unknown +``` + +## Unresolved import from resolved module + +`a.py`: + +```py +``` + +```py +from a import thing # error: "Module `a` has no member `thing`" + +reveal_type(thing) # revealed: Unknown +``` + +## Resolved import of symbol from unresolved import + +`a.py`: + +```py +import foo as foo # error: "Cannot resolve imported module `foo`" + +reveal_type(foo) # revealed: Unknown +``` + +Importing the unresolved import into a second file should not trigger an additional "unresolved +import" violation: + +```py +from a import foo + +reveal_type(foo) # revealed: Unknown +``` + +## No implicit shadowing + +`b.py`: + +```py +x: int +``` + +```py +from b import x + +x = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]" +``` + +## Import cycle + +`a.py`: + +```py +class A: ... + +reveal_type(A.__mro__) # revealed: tuple[<class 'A'>, <class 'object'>] +import b + +class C(b.B): ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'B'>, <class 'A'>, <class 'object'>] +``` + +`b.py`: + +```py +from a import A + +class B(A): ... + +reveal_type(B.__mro__) # revealed: tuple[<class 'B'>, <class 'A'>, <class 'object'>] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/invalid_syntax.md b/crates/ty_python_semantic/resources/mdtest/import/invalid_syntax.md new file mode 100644 index 0000000000000..6b7423f86d6f9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/invalid_syntax.md @@ -0,0 +1,35 @@ +# Invalid syntax + +## Missing module name + +```py +from import bar # error: [invalid-syntax] + +reveal_type(bar) # revealed: Unknown +``` + +## Invalid nested module import + +TODO: This is correctly flagged as an error, but we could clean up the diagnostics that we report. + +```py +# TODO: No second diagnostic +# error: [invalid-syntax] "Expected ',', found '.'" +# error: [unresolved-import] "Module `a` has no member `c`" +from a import b.c + +# TODO: Should these be inferred as Unknown? +reveal_type(b) # revealed: <module 'a.b'> +reveal_type(b.c) # revealed: int +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +c: int = 1 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/namespace.md b/crates/ty_python_semantic/resources/mdtest/import/namespace.md new file mode 100644 index 0000000000000..3b5f63e9818b3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/namespace.md @@ -0,0 +1,148 @@ +# Namespace package + +## Basic namespace package + +```toml +[environment] +python = "/.venv" +``` + +`parent/child/one.py`: + +```py +one = 1 +``` + +`/.venv/<path-to-site-packages>/parent/child/two.py`: + +```py +two = 2 +``` + +`main.py`: + +```py +import parent.child.one +import parent.child.two +``` + +`from.py` + +```py +from parent.child import one, two + +reveal_type(one) # revealed: <module 'parent.child.one'> +reveal_type(two) # revealed: <module 'parent.child.two'> +``` + +## Regular package in namespace package + +```toml +[environment] +python = "/.venv" +``` + +An adapted test case from the +[PEP420 examples](https://peps.python.org/pep-0420/#nested-namespace-packages). The +`src/parent/child` package is a regular package. Therefore, `site_packages/parent/child/two.py` +should not be resolved. + +```ignore +src + parent + child + __init__.py + one.py +.venv/site-packages + parent + child + two.py +``` + +`parent/child/__init__.py`: + +```py +``` + +`parent/child/one.py`: + +```py +one = 1 +``` + +`/.venv/<path-to-site-packages>/parent/child/two.py`: + +```py +two = 2 +``` + +`main.py`: + +```py +import parent.child.one + +import parent.child.two # error: [unresolved-import] +``` + +## Priority between file and identically named namespace package + +If there's a namespace package with the same name as a module, the module takes precedence. + +`foo.py`: + +```py +x = "module" +``` + +`foo/bar.py`: + +```py +x = "namespace" +``` + +```py +from foo import x + +reveal_type(x) # revealed: Unknown | Literal["module"] + +import foo.bar # error: [unresolved-import] +``` + +## `from` import with namespace package + +Regression test for <https://github.com/astral-sh/ty/issues/363> + +`google/cloud/pubsub_v1/__init__.py`: + +```py +class PublisherClient: ... +``` + +```py +from google.cloud import pubsub_v1 + +reveal_type(pubsub_v1.PublisherClient) # revealed: <class 'PublisherClient'> +``` + +## `from` root importing sub-packages + +Regresssion test for <https://github.com/astral-sh/ty/issues/375> + +`opentelemetry/trace/__init__.py`: + +```py +class Trace: ... +``` + +`opentelemetry/metrics/__init__.py`: + +```py +class Metric: ... +``` + +```py +from opentelemetry import trace, metrics + +reveal_type(trace) # revealed: <module 'opentelemetry.trace'> +reveal_type(metrics) # revealed: <module 'opentelemetry.metrics'> +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/relative.md b/crates/ty_python_semantic/resources/mdtest/import/relative.md new file mode 100644 index 0000000000000..9c3e303a9d73c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/relative.md @@ -0,0 +1,271 @@ +# Relative + +## Non-existent + +`package/__init__.py`: + +```py +``` + +`package/bar.py`: + +```py +from .foo import X # error: [unresolved-import] + +reveal_type(X) # revealed: Unknown +``` + +## Simple + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +X: int = 42 +``` + +`package/bar.py`: + +```py +from .foo import X + +reveal_type(X) # revealed: int +``` + +## Dotted + +`package/__init__.py`: + +```py +``` + +`package/foo/bar/baz.py`: + +```py +X: int = 42 +``` + +`package/bar.py`: + +```py +from .foo.bar.baz import X + +reveal_type(X) # revealed: int +``` + +## Bare to package + +`package/__init__.py`: + +```py +X: int = 42 +``` + +`package/bar.py`: + +```py +from . import X + +reveal_type(X) # revealed: int +``` + +## Non-existent + bare to package + +`package/bar.py`: + +```py +from . import X # error: [unresolved-import] + +reveal_type(X) # revealed: Unknown +``` + +## Dunder init + +`package/__init__.py`: + +```py +from .foo import X + +reveal_type(X) # revealed: int +``` + +`package/foo.py`: + +```py +X: int = 42 +``` + +## Non-existent + dunder init + +`package/__init__.py`: + +```py +from .foo import X # error: [unresolved-import] + +reveal_type(X) # revealed: Unknown +``` + +## Long relative import + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +X: int = 42 +``` + +`package/subpackage/subsubpackage/bar.py`: + +```py +from ...foo import X + +reveal_type(X) # revealed: int +``` + +## Unbound symbol + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +x # error: [unresolved-reference] +``` + +`package/bar.py`: + +```py +from .foo import x # error: [unresolved-import] + +reveal_type(x) # revealed: Unknown +``` + +## Bare to module + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +X: int = 42 +``` + +`package/bar.py`: + +```py +from . import foo + +reveal_type(foo.X) # revealed: int +``` + +## Non-existent + bare to module + +This test verifies that we emit an error when we try to import a symbol that is neither a submodule +nor an attribute of `package`. + +`package/__init__.py`: + +```py +``` + +`package/bar.py`: + +```py +from . import foo # error: [unresolved-import] + +reveal_type(foo) # revealed: Unknown +``` + +## Import submodule from self + +We don't currently consider `from...import` statements when building up the `imported_modules` set +in the semantic index. When accessing an attribute of a module, we only consider it a potential +submodule when that submodule name appears in the `imported_modules` set. That means that submodules +that are imported via `from...import` are not visible to our type inference if you also access that +submodule via the attribute on its parent package. + +`package/__init__.py`: + +```py +``` + +`package/foo.py`: + +```py +X: int = 42 +``` + +`package/bar.py`: + +```py +from . import foo +import package + +# error: [unresolved-attribute] "Type `<module 'package'>` has no attribute `foo`" +reveal_type(package.foo.X) # revealed: Unknown +``` + +## Relative imports at the top of a search path + +Relative imports at the top of a search path result in a runtime error: +`ImportError: attempted relative import with no known parent package`. That's why ty should disallow +them. + +`parser.py`: + +```py +X: int = 42 +``` + +`__main__.py`: + +```py +from .parser import X # error: [unresolved-import] +``` + +## Relative imports in `site-packages` + +Relative imports in `site-packages` are correctly resolved even when the `site-packages` search path +is a subdirectory of the first-party search path. Note that mdtest sets the first-party search path +to `/src/`, which is why the virtual environment in this test is a subdirectory of `/src/`, even +though this is not how a typical Python project would be structured: + +```toml +[environment] +python = "/src/.venv" +python-version = "3.13" +``` + +`/src/bar.py`: + +```py +from foo import A + +reveal_type(A) # revealed: <class 'A'> +``` + +`/src/.venv/<path-to-site-packages>/foo/__init__.py`: + +```py +from .a import A as A +``` + +`/src/.venv/<path-to-site-packages>/foo/a.py`: + +```py +class A: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/star.md b/crates/ty_python_semantic/resources/mdtest/import/star.md new file mode 100644 index 0000000000000..a20f7259ef3ff --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/star.md @@ -0,0 +1,1437 @@ +# Wildcard (`*`) imports + +See the [Python language reference for import statements]. + +## Basic functionality + +### A simple `*` import + +`exporter.py`: + +```py +X: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool +print(Y) # error: [unresolved-reference] +``` + +### Overriding an existing definition + +`exporter.py`: + +```py +X: bool = True +``` + +`importer.py`: + +```py +X = 42 +reveal_type(X) # revealed: Literal[42] + +from exporter import * + +reveal_type(X) # revealed: bool +``` + +### Overridden by a later definition + +`exporter.py`: + +```py +X: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool +X = False +reveal_type(X) # revealed: Literal[False] +``` + +### Reaching across many modules + +`a.py`: + +```py +X: bool = True +``` + +`b.py`: + +```py +from a import * +``` + +`c.py`: + +```py +from b import * +``` + +`main.py`: + +```py +from c import * + +reveal_type(X) # revealed: bool +``` + +### A wildcard import constitutes a re-export + +This is specified +[here](https://typing.python.org/en/latest/spec/distributing.html#import-conventions). + +`a.pyi`: + +```pyi +X: bool = True +``` + +`b.pyi`: + +```pyi +Y: bool = False +``` + +`c.pyi`: + +```pyi +from a import * +from b import Y +``` + +`main.py`: + +```py +# `X` is accessible because the `*` import in `c` re-exports it from `c` +from c import X + +# but `Y` is not because the `from b import Y` import does *not* constitute a re-export +from c import Y # error: [unresolved-import] +``` + +## Esoteric definitions and redefinintions + +```toml +[environment] +python-version = "3.12" +``` + +We understand all public symbols defined in an external module as being imported by a `*` import, +not just those that are defined in `StmtAssign` nodes and `StmtAnnAssign` nodes. This section +provides tests for definitions, and redefinitions, that use more esoteric AST nodes. + +### Global-scope symbols defined using walrus expressions + +`exporter.py`: + +```py +X = (Y := 3) + 4 +``` + +`b.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: Unknown | Literal[7] +reveal_type(Y) # revealed: Unknown | Literal[3] +``` + +### Global-scope symbols defined in many other ways + +`exporter.py`: + +```py +import typing +from collections import OrderedDict +from collections import OrderedDict as Foo + +A, B = 1, (C := 2) +D: (E := 4) = (F := 5) # error: [invalid-type-form] + +for G in [1]: + ... + +for (H := 4).whatever in [2]: # error: [unresolved-attribute] + ... + +class I: ... + +def J(): ... + +type K = int + +class ContextManagerThatMightNotRunToCompletion: + def __enter__(self) -> "ContextManagerThatMightNotRunToCompletion": + return self + + def __exit__(self, *args) -> typing.Literal[True]: + return True + +with ContextManagerThatMightNotRunToCompletion() as L: + U = ... + +match 42: + case {"something": M}: + ... + case [*N]: + ... + case [O]: + ... + case P | Q: # error: [invalid-syntax] "name capture `P` makes remaining patterns unreachable" + ... + case object(foo=R): + ... + +match 56: + case x if something_unresolvable: # error: [unresolved-reference] + ... + + case object(S): + ... + +match 12345: + case x if something_unresolvable: # error: [unresolved-reference] + ... + + case T: + ... + +def boolean_condition() -> bool: + return True + +if boolean_condition(): + V = ... + +while boolean_condition(): + W = ... +``` + +`importer.py`: + +```py +from exporter import * + +# fmt: off + +print(( + A, + B, + C, + D, + E, + F, + G, # error: [possibly-unresolved-reference] + H, # error: [possibly-unresolved-reference] + I, + J, + K, + L, + M, # error: [possibly-unresolved-reference] + N, # error: [possibly-unresolved-reference] + O, # error: [possibly-unresolved-reference] + P, # error: [possibly-unresolved-reference] + Q, # error: [possibly-unresolved-reference] + R, # error: [possibly-unresolved-reference] + S, # error: [possibly-unresolved-reference] + T, # error: [possibly-unresolved-reference] + U, # TODO: could emit [possibly-unresolved-reference here] (https://github.com/astral-sh/ruff/issues/16996) + V, # error: [possibly-unresolved-reference] + W, # error: [possibly-unresolved-reference] + typing, + OrderedDict, + Foo, +)) +``` + +### Esoteric possible redefinitions following definitely bound prior definitions + +There should be no complaint about the symbols being possibly unbound in `b.py` here: although the +second definition might or might not take place, each symbol is definitely bound by a prior +definition. + +`exporter.py`: + +```py +from typing import Literal + +A = 1 +B = 2 +C = 3 +D = 4 +E = 5 +F = 6 +G = 7 +H = 8 +I = 9 +J = 10 +K = 11 +L = 12 + +for A in [1]: + ... + +match 42: + case {"something": B}: + ... + case [*C]: + ... + case [D]: + ... + case E | F: # error: [invalid-syntax] "name capture `E` makes remaining patterns unreachable" + ... + case object(foo=G): + ... + case object(H): + ... + case I: + ... + +def boolean_condition() -> bool: + return True + +if boolean_condition(): + J = ... + +while boolean_condition(): + K = ... + +class ContextManagerThatMightNotRunToCompletion: + def __enter__(self) -> "ContextManagerThatMightNotRunToCompletion": + return self + + def __exit__(self, *args) -> Literal[True]: + return True + +with ContextManagerThatMightNotRunToCompletion(): + L = ... +``` + +`importer.py`: + +```py +from exporter import * + +print(A) +print(B) +print(C) +print(D) +print(E) +print(F) +print(G) +print(H) +print(I) +print(J) +print(K) +print(L) +``` + +### Esoteric possible definitions prior to definitely bound prior redefinitions + +The same principle applies here to the symbols in `b.py`. Although the first definition might or +might not take place, each symbol is definitely bound by a later definition. + +`exporter.py`: + +```py +from typing import Literal + +for A in [1]: + ... + +match 42: + case {"something": B}: + ... + case [*C]: + ... + case [D]: + ... + case E | F: # error: [invalid-syntax] "name capture `E` makes remaining patterns unreachable" + ... + case object(foo=G): + ... + case object(H): + ... + case I: + ... + +def boolean_condition() -> bool: + return True + +if boolean_condition(): + J = ... + +while boolean_condition(): + K = ... + +class ContextManagerThatMightNotRunToCompletion: + def __enter__(self) -> "ContextManagerThatMightNotRunToCompletion": + return self + + def __exit__(self, *args) -> Literal[True]: + return True + +with ContextManagerThatMightNotRunToCompletion(): + L = ... + +A = 1 +B = 2 +C = 3 +D = 4 +E = 5 +F = 6 +G = 7 +H = 8 +I = 9 +J = 10 +K = 11 +L = 12 +``` + +`importer.py`: + +```py +from exporter import * + +print(A) +print(B) +print(C) +print(D) +print(E) +print(F) +print(G) +print(H) +print(I) +print(J) +print(K) +print(L) +``` + +### Definitions in function-like scopes are not global definitions + +Except for some cases involving walrus expressions inside comprehension scopes. + +`exporter.py`: + +```py +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +[a for a in Iterable()] +{b for b in Iterable()} +{c: c for c in Iterable()} +(d for d in Iterable()) +lambda e: (f := 42) + +# Definitions created by walruses in a comprehension scope are unique; +# they "leak out" of the scope and are stored in the surrounding scope +[(g := h * 2) for h in Iterable()] +[i for j in Iterable() if (i := j - 10) > 0] +{(k := l * 2): (m := l * 3) for l in Iterable()} +list(((o := p * 2) for p in Iterable())) + +# A walrus expression nested inside several scopes *still* leaks out +# to the global scope: +[[[[(q := r) for r in Iterable()]] for _ in range(42)] for _ in range(42)] + +# A walrus inside a lambda inside a comprehension does not leak out +[(lambda s=s: (t := 42))() for s in Iterable()] +``` + +`importer.py`: + +```py +from exporter import * + +# error: [unresolved-reference] +reveal_type(a) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(b) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(c) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(d) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(e) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(f) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(h) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(j) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(p) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(r) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(s) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(t) # revealed: Unknown + +# TODO: these should all reveal `Unknown | int` and should not emit errors. +# (We don't generally model elsewhere in ty that bindings from walruses +# "leak" from comprehension scopes into outer scopes, but we should.) +# See https://github.com/astral-sh/ruff/issues/16954 +# error: [unresolved-reference] +reveal_type(g) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(i) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(k) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(m) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(o) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(q) # revealed: Unknown +``` + +### An annotation without a value is a definition in a stub but not a `.py` file + +`a.pyi`: + +```pyi +X: bool +``` + +`b.py`: + +```py +Y: bool +``` + +`c.py`: + +```py +from a import * +from b import * + +reveal_type(X) # revealed: bool +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown +``` + +## Which symbols are exported + +Not all symbols in the global namespace are considered "public". As a result, not all symbols bound +in the global namespace of an `exporter.py` module will be imported by a `from exporter import *` +statement in an `importer.py` module. The tests in this section elaborate on these semantics. + +### Global-scope names starting with underscores + +Global-scope names starting with underscores are not imported from a `*` import (unless the +exporting module has an `__all__` symbol in its global scope, and the underscore-prefixed symbols +are included in `__all__`): + +`exporter.py`: + +```py +_private: bool = False +__protected: bool = False +__dunder__: bool = False +___thunder___: bool = False + +Y: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +# error: [unresolved-reference] +reveal_type(_private) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(__protected) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(__dunder__) # revealed: Unknown +# error: [unresolved-reference] +reveal_type(___thunder___) # revealed: Unknown + +reveal_type(Y) # revealed: bool +``` + +### All public symbols are considered re-exported from `.py` files + +For `.py` files, we should consider all public symbols in the global namespace exported by that +module when considering which symbols are made available by a `*` import. Here, `b.py` does not use +the explicit `from a import X as X` syntax to explicitly mark it as publicly re-exported, and `X` is +not included in `__all__`; whether it should be considered a "public name" in module `b` is +ambiguous. + +We should consider `X` bound in `c.py`. However, we could consider adding an opt-in rule to warn the +user when they use `X` in `c.py` that it was neither included in `b.__all__` nor marked as an +explicit re-export from `b` through the "redundant alias" convention. + +`a.py`: + +```py +X: bool = True +``` + +`b.py`: + +```py +from a import X +``` + +`c.py`: + +```py +from b import * + +# TODO: we could consider an opt-in diagnostic (see prose commentary above) +reveal_type(X) # revealed: bool +``` + +### Only explicit re-exports are considered re-exported from `.pyi` files + +For `.pyi` files, we should consider all imports "private to the stub" unless they are included in +`__all__` or use the explicit `from foo import X as X` syntax. + +`a.pyi`: + +```pyi +X: bool = True +Y: bool = True +``` + +`b.pyi`: + +```pyi +from a import X, Y as Y +``` + +`c.py`: + +```py +from b import * + +# This error is correct, as `X` is not considered re-exported from module `b`: +# +# error: [unresolved-reference] +reveal_type(X) # revealed: Unknown + +reveal_type(Y) # revealed: bool +``` + +### An implicit import in a `.pyi` file later overridden by another assignment + +`a.pyi`: + +```pyi +X: bool = True +``` + +`b.pyi`: + +```pyi +from a import X + +X: bool = False +``` + +`c.py`: + +```py +from b import * + +reveal_type(X) # revealed: bool +``` + +## Visibility constraints + +If an `importer` module contains a `from exporter import *` statement in its global namespace, the +statement will *not* necessarily import *all* symbols that have definitions in `exporter.py`'s +global scope. For any given symbol in `exporter.py`'s global scope, that symbol will *only* be +imported by the `*` import if at least one definition for that symbol is visible from the *end* of +`exporter.py`'s global scope. + +For example, say that `exporter.py` contains a symbol `X` in its global scope, and the definition +for `X` in `exporter.py` has visibility constraints <code>vis<sub>1</sub></code>. The +`from exporter import *` statement in `importer.py` creates a definition for `X` in `importer`, and +there are visibility constraints <code>vis<sub>2</sub></code> on the import statement in +`importer.py`. This means that the overall visibility constraints on the `X` definnition created by +the import statement in `importer.py` will be <code>vis<sub>1</sub> AND vis<sub>2</sub></code>. + +A visibility constraint in the external module must be understood and evaluated whether or not its +truthiness can be statically determined. + +### Statically known branches in the external module + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +if sys.version_info >= (3, 11): + X: bool = True +else: + Y: bool = False + Z: int = 42 +``` + +`importer.py`: + +```py +import sys + +Z: bool = True + +from exporter import * + +reveal_type(X) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown + +# The `*` import is not considered a redefinition +# of the global variable `Z` in this module, as the symbol in +# the `a` module is in a branch that is statically known +# to be dead code given the `python-version` configuration. +# Thus this still reveals `Literal[True]`. +reveal_type(Z) # revealed: Literal[True] +``` + +### Multiple `*` imports with always-false visibility constraints + +Our understanding of visibility constraints in an external module remains accurate, even if there +are multiple `*` imports from that module. + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +if sys.version_info >= (3, 12): + Z: str = "foo" +``` + +`importer.py`: + +```py +Z = True + +from exporter import * +from exporter import * +from exporter import * + +reveal_type(Z) # revealed: Literal[True] +``` + +### Ambiguous visibility constraints + +Some constraints in the external module may resolve to an "ambiguous truthiness". For these, we +should emit `possibly-unresolved-reference` diagnostics when they are used in the module in which +the `*` import occurs. + +`exporter.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + A = 1 + B = 2 +else: + B = 3 +``` + +`importer.py`: + +```py +from exporter import * + +# error: [possibly-unresolved-reference] +reveal_type(A) # revealed: Unknown | Literal[1] + +reveal_type(B) # revealed: Unknown | Literal[2, 3] +``` + +### Visibility constraints in the importing module + +`exporter.py`: + +```py +A = 1 +``` + +`importer.py`: + +```py +def coinflip() -> bool: + return True + +if coinflip(): + from exporter import * + +# error: [possibly-unresolved-reference] +reveal_type(A) # revealed: Unknown | Literal[1] +``` + +### Visibility constraints in the exporting module *and* the importing module + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +if sys.version_info >= (3, 12): + A: bool = True + +def coinflip() -> bool: + return True + +if coinflip(): + B: bool = True +``` + +`importer.py`: + +```py +import sys + +if sys.version_info >= (3, 12): + from exporter import * + + # it's correct to have no diagnostics here as this branch is unreachable + reveal_type(A) # revealed: Unknown + reveal_type(B) # revealed: bool +else: + from exporter import * + + # error: [unresolved-reference] + reveal_type(A) # revealed: Unknown + # error: [possibly-unresolved-reference] + reveal_type(B) # revealed: bool + +# error: [unresolved-reference] +reveal_type(A) # revealed: Unknown +# error: [possibly-unresolved-reference] +reveal_type(B) # revealed: bool +``` + +## Relative `*` imports + +Relative `*` imports are also supported by Python: + +`a/__init__.py`: + +```py +``` + +`a/foo.py`: + +```py +X: bool = True +``` + +`a/bar.py`: + +```py +from .foo import * + +reveal_type(X) # revealed: bool +``` + +## Star imports with `__all__` + +If a module `x` contains `__all__`, all symbols included in `x.__all__` are imported by +`from x import *` (but no other symbols are). + +### Simple tuple `__all__` + +`exporter.py`: + +```py +__all__ = ("X", "_private", "__protected", "__dunder__", "___thunder___") + +X: bool = True +_private: bool = True +__protected: bool = True +__dunder__: bool = True +___thunder___: bool = True + +Y: bool = False +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool + +reveal_type(_private) # revealed: bool +reveal_type(__protected) # revealed: bool +reveal_type(__dunder__) # revealed: bool +reveal_type(___thunder___) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown +``` + +### Simple list `__all__` + +`exporter.py`: + +```py +__all__ = ["X"] + +X: bool = True +Y: bool = False +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown +``` + +### `__all__` with additions later on in the global scope + +The +[typing spec](https://typing.python.org/en/latest/spec/distributing.html#library-interface-public-and-private-symbols) +lists certain modifications to `__all__` that must be understood by type checkers. + +`a.py`: + +```py +FOO: bool = True + +__all__ = ["FOO"] +``` + +`b.py`: + +```py +import a +from a import * + +__all__ = ["A"] +__all__ += ["B"] +__all__.append("C") +__all__.extend(["D"]) +__all__.extend(a.__all__) + +A: bool = True +B: bool = True +C: bool = True +D: bool = True +E: bool = False +``` + +`c.py`: + +```py +from b import * + +reveal_type(A) # revealed: bool +reveal_type(B) # revealed: bool +reveal_type(C) # revealed: bool +reveal_type(D) # revealed: bool +reveal_type(FOO) # revealed: bool + +# error: [unresolved-reference] +reveal_type(E) # revealed: Unknown +``` + +### `__all__` with subtractions later on in the global scope + +Whereas there are many ways of adding to `__all__` that type checkers must support, there is only +one way of subtracting from `__all__` that type checkers are required to support: + +`exporter.py`: + +```py +__all__ = ["A", "B"] +__all__.remove("B") + +A: bool = True +B: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(A) # revealed: bool + +# error: [unresolved-reference] +reveal_type(B) # revealed: Unknown +``` + +### Invalid `__all__` + +If `a.__all__` contains a member that does not refer to a symbol with bindings in the global scope, +a wildcard import from module `a` will fail at runtime. + +TODO: Should we: + +1. Emit a diagnostic at the invalid definition of `__all__` (which will not fail at runtime)? +1. Emit a diagnostic at the star-import from the module with the invalid `__all__` (which *will* + fail at runtime)? +1. Emit a diagnostic on both? + +`exporter.py`: + +```py +__all__ = ["a", "b"] + +a = 42 +``` + +`importer.py`: + +```py +# TODO we should consider emitting a diagnostic here (see prose description above) +from exporter import * # fails with `AttributeError: module 'foo' has no attribute 'b'` at runtime +``` + +### Dynamic `__all__` + +If `__all__` contains members that are dynamically computed, we should check that all members of +`__all__` are assignable to `str`. For the purposes of evaluating `*` imports, however, we should +treat the module as though it has no `__all__` at all: all global-scope members of the module should +be considered imported by the import statement. We should probably also emit a warning telling the +user that we cannot statically determine the elements of `__all__`. + +`exporter.py`: + +```py +def f() -> str: + return "f" + +def g() -> int: + return 42 + +# TODO we should emit a warning here for the dynamically constructed `__all__` member. +__all__ = [f()] +``` + +`importer.py`: + +```py +from exporter import * + +# At runtime, `f` is imported but `g` is not; to avoid false positives, however, +# we treat `a` as though it does not have `__all__` at all, +# which would imply that both symbols would be present. +reveal_type(f) # revealed: def f() -> str +reveal_type(g) # revealed: def g() -> int +``` + +### `__all__` conditionally defined in a statically known branch + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +X: bool = True + +if sys.version_info >= (3, 11): + __all__ = ["X", "Y"] + Y: bool = True +else: + __all__ = ("Z",) + Z: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool +reveal_type(Y) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Z) # revealed: Unknown +``` + +### `__all__` conditionally defined in a statically known branch (2) + +The same example again, but with a different `python-version` set: + +```toml +[environment] +python-version = "3.10" +``` + +`exporter.py`: + +```py +import sys + +X: bool = True + +if sys.version_info >= (3, 11): + __all__ = ["X", "Y"] + Y: bool = True +else: + __all__ = ("Z",) + Z: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +# error: [unresolved-reference] +reveal_type(X) # revealed: Unknown + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown + +reveal_type(Z) # revealed: bool +``` + +### `__all__` conditionally mutated in a statically known branch + +```toml +[environment] +python-version = "3.11" +``` + +`exporter.py`: + +```py +import sys + +__all__ = [] +X: bool = True + +if sys.version_info >= (3, 11): + __all__.extend(["X", "Y"]) + Y: bool = True +else: + __all__.append("Z") + Z: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +reveal_type(X) # revealed: bool +reveal_type(Y) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Z) # revealed: Unknown +``` + +### `__all__` conditionally mutated in a statically known branch (2) + +The same example again, but with a different `python-version` set: + +```toml +[environment] +python-version = "3.10" +``` + +`exporter.py`: + +```py +import sys + +__all__ = [] +X: bool = True + +if sys.version_info >= (3, 11): + __all__.extend(["X", "Y"]) + Y: bool = True +else: + __all__.append("Z") + Z: bool = True +``` + +`importer.py`: + +```py +from exporter import * + +# error: [unresolved-reference] +reveal_type(X) # revealed: Unknown + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown + +reveal_type(Z) # revealed: bool +``` + +### Empty `__all__` + +An empty `__all__` is valid, but a `*` import from a module with an empty `__all__` results in 0 +bindings being added from the import: + +`a.py`: + +```py +X: bool = True + +__all__ = () +``` + +`b.py`: + +```py +Y: bool = True + +__all__ = [] +``` + +`c.py`: + +```py +from a import * +from b import * + +# error: [unresolved-reference] +reveal_type(X) # revealed: Unknown + +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown +``` + +### `__all__` in a stub file + +If a name is included in `__all__` in a stub file, it is considered re-exported even if it was only +defined using an import without the explicit `from foo import X as X` syntax: + +`a.pyi`: + +```pyi +X: bool = True +Y: bool = True +``` + +`b.pyi`: + +```pyi +from a import X, Y + +__all__ = ["X", "Z"] + +Z: bool = True + +Nope: bool = True +``` + +`c.py`: + +```py +from b import * + +# `X` is re-exported from `b.pyi` due to presence in `__all__` +reveal_type(X) # revealed: bool + +# This diagnostic is accurate: `Y` does not use the "redundant alias" convention in `b.pyi`, +# nor is it included in `b.__all__`, so it is not exported from `b.pyi`. It would still be +# an error if it used the "redundant alias" convention as `__all__` would take precedence. +# +# error: [unresolved-reference] +reveal_type(Y) # revealed: Unknown + +# `Z` is defined in `b.pyi` and included in `__all__` +reveal_type(Z) # revealed: bool + +# error: [unresolved-reference] +reveal_type(Nope) # revealed: Unknown +``` + +## `global` statements in non-global scopes + +A `global` statement in a nested function scope, combined with a definition in the same function +scope of the name that was declared `global`, can add a symbol to the global namespace. + +`a.py`: + +```py +def f(): + global g, h + + g: bool = True + +f() +``` + +`b.py`: + +```py +from a import * + +reveal_type(f) # revealed: def f() -> Unknown + +# TODO: we're undecided about whether we should consider this a false positive or not. +# Mutating the global scope to add a symbol from an inner scope will not *necessarily* result +# in the symbol being bound from the perspective of other modules (the function that creates +# the inner scope, and adds the symbol to the global scope, might never be called!) +# See discussion in https://github.com/astral-sh/ruff/pull/16959 +# +# error: [unresolved-reference] +reveal_type(g) # revealed: Unknown + +# this diagnostic is accurate, though! +# error: [unresolved-reference] +reveal_type(h) # revealed: Unknown +``` + +## Cyclic star imports + +Believe it or not, this code does *not* raise an exception at runtime! + +`a.py`: + +```py +from b import * + +A: bool = True +``` + +`b.py`: + +```py +from a import * + +B: bool = True +``` + +`c.py`: + +```py +from a import * + +reveal_type(A) # revealed: bool +reveal_type(B) # revealed: bool +``` + +## Integration test: `collections.abc` + +The `collections.abc` standard-library module provides a good integration test, as all its symbols +are present due to `*` imports. + +```py +import collections.abc + +reveal_type(collections.abc.Sequence) # revealed: <class 'Sequence'> +reveal_type(collections.abc.Callable) # revealed: typing.Callable +reveal_type(collections.abc.Set) # revealed: <class 'AbstractSet'> +``` + +## Invalid `*` imports + +### Unresolved module + +If the module is unresolved, we emit a diagnostic just like for any other unresolved import: + +```py +# TODO: not a great error message +from foo import * # error: [unresolved-import] "Cannot resolve imported module `foo`" +``` + +### Nested scope + +A `*` import in a nested scope are always a syntax error. Ty does not infer any bindings from them: + +`exporter.py`: + +```py +X: bool = True +``` + +`importer.py`: + +```py +def f(): + # TODO: we should emit a syntax error here (tracked by https://github.com/astral-sh/ruff/issues/17412) + from exporter import * + + # error: [unresolved-reference] + reveal_type(X) # revealed: Unknown +``` + +### `*` combined with other aliases in the list + +`a.py`: + +```py +X: bool = True +_Y: bool = False +_Z: bool = True +``` + +`b.py`: + +<!-- blacken-docs:off --> + +```py +from a import *, _Y # error: [invalid-syntax] + +# The import statement above is invalid syntax, +# but it's pretty obvious that the user wanted to do a `*` import, +# so we import all public names from `a` anyway, to minimize cascading errors +reveal_type(X) # revealed: bool +reveal_type(_Y) # revealed: bool +``` + +These tests are more to assert that we don't panic on these various kinds of invalid syntax than +anything else: + +`c.py`: + +```py +from a import *, _Y # error: [invalid-syntax] +from a import _Y, *, _Z # error: [invalid-syntax] +from a import *, _Y as fooo # error: [invalid-syntax] +from a import *, *, _Y # error: [invalid-syntax] +``` + +<!-- blacken-docs:on --> + +[python language reference for import statements]: https://docs.python.org/3/reference/simple_stmts.html#the-import-statement diff --git a/crates/ty_python_semantic/resources/mdtest/import/stub_packages.md b/crates/ty_python_semantic/resources/mdtest/import/stub_packages.md new file mode 100644 index 0000000000000..3f99e5d92b54a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/stub_packages.md @@ -0,0 +1,315 @@ +# Stub packages + +Stub packages are packages named `<package>-stubs` that provide typing stubs for `<package>`. See +[specification](https://typing.python.org/en/latest/spec/distributing.html#stub-only-packages). + +## Simple stub + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/foo-stubs/__init__.pyi`: + +```pyi +class Foo: + name: str + age: int +``` + +`/packages/foo/__init__.py`: + +```py +class Foo: ... +``` + +`main.py`: + +```py +from foo import Foo + +reveal_type(Foo().name) # revealed: str +``` + +## Stubs only + +The regular package isn't required for type checking. + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/foo-stubs/__init__.pyi`: + +```pyi +class Foo: + name: str + age: int +``` + +`main.py`: + +```py +from foo import Foo + +reveal_type(Foo().name) # revealed: str +``` + +## `-stubs` named module + +A module named `<module>-stubs` isn't a stub package. + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/foo-stubs.pyi`: + +```pyi +class Foo: + name: str + age: int +``` + +`main.py`: + +```py +from foo import Foo # error: [unresolved-import] + +reveal_type(Foo().name) # revealed: Unknown +``` + +## Namespace package in different search paths + +A namespace package with multiple stub packages spread over multiple search paths. + +```toml +[environment] +extra-paths = ["/stubs1", "/stubs2", "/packages"] +``` + +`/stubs1/shapes-stubs/polygons/pentagon.pyi`: + +```pyi +class Pentagon: + sides: int + area: float +``` + +`/stubs2/shapes-stubs/polygons/hexagon.pyi`: + +```pyi +class Hexagon: + sides: int + area: float +``` + +`/packages/shapes/polygons/pentagon.py`: + +```py +class Pentagon: ... +``` + +`/packages/shapes/polygons/hexagon.py`: + +```py +class Hexagon: ... +``` + +`main.py`: + +```py +from shapes.polygons.hexagon import Hexagon +from shapes.polygons.pentagon import Pentagon + +reveal_type(Pentagon().sides) # revealed: int +reveal_type(Hexagon().area) # revealed: int | float +``` + +## Inconsistent stub packages + +Stub packages where one is a namespace package and the other is a regular package. Module resolution +should stop after the first non-namespace stub package. This matches Pyright's behavior. + +```toml +[environment] +extra-paths = ["/stubs1", "/stubs2", "/packages"] +``` + +`/stubs1/shapes-stubs/__init__.pyi`: + +```pyi +``` + +`/stubs1/shapes-stubs/polygons/__init__.pyi`: + +```pyi +``` + +`/stubs1/shapes-stubs/polygons/pentagon.pyi`: + +```pyi +class Pentagon: + sides: int + area: float +``` + +`/stubs2/shapes-stubs/polygons/hexagon.pyi`: + +```pyi +class Hexagon: + sides: int + area: float +``` + +`/packages/shapes/polygons/pentagon.py`: + +```py +class Pentagon: ... +``` + +`/packages/shapes/polygons/hexagon.py`: + +```py +class Hexagon: ... +``` + +`main.py`: + +```py +from shapes.polygons.pentagon import Pentagon +from shapes.polygons.hexagon import Hexagon # error: [unresolved-import] + +reveal_type(Pentagon().sides) # revealed: int +reveal_type(Hexagon().area) # revealed: Unknown +``` + +## Namespace stubs for non-namespace package + +The runtime package is a regular package but the stubs are namespace packages. Pyright skips the +stub package if the "regular" package isn't a namespace package. I'm not aware that the behavior +here is specified, and using the stubs without probing the runtime package first requires slightly +fewer lookups. + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/shapes-stubs/polygons/pentagon.pyi`: + +```pyi +class Pentagon: + sides: int + area: float +``` + +`/packages/shapes-stubs/polygons/hexagon.pyi`: + +```pyi +class Hexagon: + sides: int + area: float +``` + +`/packages/shapes/__init__.py`: + +```py +``` + +`/packages/shapes/polygons/__init__.py`: + +```py +``` + +`/packages/shapes/polygons/pentagon.py`: + +```py +class Pentagon: ... +``` + +`/packages/shapes/polygons/hexagon.py`: + +```py +class Hexagon: ... +``` + +`main.py`: + +```py +from shapes.polygons.pentagon import Pentagon +from shapes.polygons.hexagon import Hexagon + +reveal_type(Pentagon().sides) # revealed: int +reveal_type(Hexagon().area) # revealed: int | float +``` + +## Stub package using `__init__.py` over `.pyi` + +It's recommended that stub packages use `__init__.pyi` files over `__init__.py` but it doesn't seem +to be an enforced convention. At least, Pyright is fine with the following. + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/shapes-stubs/__init__.py`: + +```py +class Pentagon: + sides: int + area: float + +class Hexagon: + sides: int + area: float +``` + +`/packages/shapes/__init__.py`: + +```py +class Pentagon: ... +class Hexagon: ... +``` + +`main.py`: + +```py +from shapes import Hexagon, Pentagon + +reveal_type(Pentagon().sides) # revealed: int +reveal_type(Hexagon().area) # revealed: int | float +``` + +## Relative import in stub package + +Regression test for <https://github.com/astral-sh/ty/issues/408> + +```toml +[environment] +extra-paths = ["/packages"] +``` + +`/packages/yaml-stubs/__init__.pyi`: + +```pyi +from .loader import * +``` + +`/packages/yaml-stubs/loader.pyi`: + +```pyi +class YamlLoader: ... +``` + +`main.py`: + +```py +import yaml + +reveal_type(yaml.YamlLoader) # revealed: <class 'YamlLoader'> +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/import/stubs.md b/crates/ty_python_semantic/resources/mdtest/import/stubs.md similarity index 88% rename from crates/red_knot_python_semantic/resources/mdtest/import/stubs.md rename to crates/ty_python_semantic/resources/mdtest/import/stubs.md index 151b9cc11088b..6a614ed557fab 100644 --- a/crates/red_knot_python_semantic/resources/mdtest/import/stubs.md +++ b/crates/ty_python_semantic/resources/mdtest/import/stubs.md @@ -9,7 +9,9 @@ y = x reveal_type(y) # revealed: int ``` -```py path=b.pyi +`b.pyi`: + +```pyi x: int ``` @@ -22,6 +24,8 @@ y = x reveal_type(y) # revealed: int ``` -```py path=b.py +`b.py`: + +```py x: int = 1 ``` diff --git a/crates/ty_python_semantic/resources/mdtest/import/tracking.md b/crates/ty_python_semantic/resources/mdtest/import/tracking.md new file mode 100644 index 0000000000000..f31193b7628e3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/import/tracking.md @@ -0,0 +1,118 @@ +# Tracking imported modules + +These tests depend on how we track which modules have been imported. There are currently two +characteristics of our module tracking that can lead to inaccuracies: + +- Imports are tracked on a per-file basis. At runtime, importing a submodule in one file makes that + submodule globally available via any reference to the containing package. We will flag an error + if a file tries to access a submodule without there being an import of that submodule _in that + same file_. + + This is a purposeful decision, and not one we plan to change. If a module wants to re-export some + other module that it imports, there are ways to do that (tested below) that are blessed by the + typing spec and that are visible to our file-scoped import tracking. + +- Imports are tracked flow-insensitively: submodule accesses are allowed and resolved if that + submodule is imported _anywhere in the file_. This handles the common case where all imports are + grouped at the top of the file, and is easiest to implement. We might revisit this decision and + track submodule imports flow-sensitively, in which case we will have to update the assertions in + some of these tests. + +## Import submodule later in file + +This test highlights our flow-insensitive analysis, since we access the `a.b` submodule before it +has been imported. + +```py +import a + +# Would be an error with flow-sensitive tracking +reveal_type(a.b.C) # revealed: <class 'C'> + +import a.b +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +class C: ... +``` + +## Rename a re-export + +This test highlights how import tracking is local to each file, but specifically to the file where a +containing module is first referenced. This allows the main module to see that `q.a` contains a +submodule `b`, even though `a.b` is never imported in the main module. + +```py +from q import a, b + +reveal_type(b) # revealed: <module 'a.b'> +reveal_type(b.C) # revealed: <class 'C'> + +reveal_type(a.b) # revealed: <module 'a.b'> +reveal_type(a.b.C) # revealed: <class 'C'> +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +class C: ... +``` + +`q.py`: + +```py +import a as a +import a.b as b +``` + +## Attribute overrides submodule + +Technically, either a submodule or a non-module attribute could shadow the other, depending on the +ordering of when the submodule is loaded relative to the parent module's `__init__.py` file being +evaluated. We have chosen to always have the submodule take priority. (This matches pyright's +current behavior, and opposite of mypy's current behavior.) + +```py +import sub.b +import attr.b + +# In the Python interpreter, `attr.b` is Literal[1] +reveal_type(sub.b) # revealed: <module 'sub.b'> +reveal_type(attr.b) # revealed: <module 'attr.b'> +``` + +`sub/__init__.py`: + +```py +b = 1 +``` + +`sub/b.py`: + +```py +``` + +`attr/__init__.py`: + +```py +from . import b as _ + +b = 1 +``` + +`attr/b.py`: + +```py +``` diff --git a/crates/ty_python_semantic/resources/mdtest/intersection_types.md b/crates/ty_python_semantic/resources/mdtest/intersection_types.md new file mode 100644 index 0000000000000..4accdfe3685cf --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/intersection_types.md @@ -0,0 +1,878 @@ +# Intersection types + +## Introduction + +This test suite covers certain properties of intersection types and makes sure that we can apply +various simplification strategies. We use `Intersection` (`&`) and `Not` (`~`) to construct +intersection types (note that we display negative contributions at the end; the order does not +matter): + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... + +def _( + i1: Intersection[P, Q], + i2: Intersection[P, Not[Q]], + i3: Intersection[Not[P], Q], + i4: Intersection[Not[P], Not[Q]], +) -> None: + reveal_type(i1) # revealed: P & Q + reveal_type(i2) # revealed: P & ~Q + reveal_type(i3) # revealed: Q & ~P + reveal_type(i4) # revealed: ~P & ~Q +``` + +## Notation + +Throughout this document, we use the following types as representatives for certain equivalence +classes. + +### Non-disjoint types + +We use `P`, `Q`, `R`, … to denote types that are non-disjoint: + +```py +from ty_extensions import static_assert, is_disjoint_from + +class P: ... +class Q: ... +class R: ... + +static_assert(not is_disjoint_from(P, Q)) +static_assert(not is_disjoint_from(P, R)) +static_assert(not is_disjoint_from(Q, R)) +``` + +Although `P` is not a subtype of `Q` and `Q` is not a subtype of `P`, the two types are not disjoint +because it would be possible to create a class `S` that inherits from both `P` and `Q` using +multiple inheritance. An instance of `S` would be a member of the `P` type _and_ the `Q` type. + +### Disjoint types + +We use `Literal[1]`, `Literal[2]`, … as examples of pairwise-disjoint types, and `int` as a joint +supertype of these: + +```py +from ty_extensions import static_assert, is_disjoint_from, is_subtype_of +from typing import Literal + +static_assert(is_disjoint_from(Literal[1], Literal[2])) +static_assert(is_disjoint_from(Literal[1], Literal[3])) +static_assert(is_disjoint_from(Literal[2], Literal[3])) + +static_assert(is_subtype_of(Literal[1], int)) +static_assert(is_subtype_of(Literal[2], int)) +static_assert(is_subtype_of(Literal[3], int)) +``` + +### Subtypes + +Finally, we use `A <: B <: C` and `A <: B1`, `A <: B2` to denote hierarchies of (proper) subtypes: + +```py +from ty_extensions import static_assert, is_subtype_of, is_disjoint_from + +class A: ... +class B(A): ... +class C(B): ... + +static_assert(is_subtype_of(B, A)) +static_assert(is_subtype_of(C, B)) +static_assert(is_subtype_of(C, A)) + +static_assert(not is_subtype_of(A, B)) +static_assert(not is_subtype_of(B, C)) +static_assert(not is_subtype_of(A, C)) + +class B1(A): ... +class B2(A): ... + +static_assert(is_subtype_of(B1, A)) +static_assert(is_subtype_of(B2, A)) + +static_assert(not is_subtype_of(A, B1)) +static_assert(not is_subtype_of(A, B2)) + +static_assert(not is_subtype_of(B1, B2)) +static_assert(not is_subtype_of(B2, B1)) +``` + +## Structural properties + +This section covers structural properties of intersection types and documents some decisions on how +to represent mixtures of intersections and unions. + +### Single-element intersections + +If we have an intersection with a single element, we can simplify to that element. Similarly, we +show an intersection with a single negative contribution as just the negation of that element. + +```py +from ty_extensions import Intersection, Not + +class P: ... + +def _( + i1: Intersection[P], + i2: Intersection[Not[P]], +) -> None: + reveal_type(i1) # revealed: P + reveal_type(i2) # revealed: ~P +``` + +### Flattening of nested intersections + +We eagerly flatten nested intersections types. + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... +class R: ... +class S: ... + +def positive_contributions( + i1: Intersection[P, Intersection[Q, R]], + i2: Intersection[Intersection[P, Q], R], +) -> None: + reveal_type(i1) # revealed: P & Q & R + reveal_type(i2) # revealed: P & Q & R + +def negative_contributions( + i1: Intersection[Not[P], Intersection[Not[Q], Not[R]]], + i2: Intersection[Intersection[Not[P], Not[Q]], Not[R]], +) -> None: + reveal_type(i1) # revealed: ~P & ~Q & ~R + reveal_type(i2) # revealed: ~P & ~Q & ~R + +def mixed( + i1: Intersection[P, Intersection[Not[Q], R]], + i2: Intersection[Intersection[P, Not[Q]], R], + i3: Intersection[Not[P], Intersection[Q, Not[R]]], + i4: Intersection[Intersection[Q, Not[R]], Not[P]], +) -> None: + reveal_type(i1) # revealed: P & R & ~Q + reveal_type(i2) # revealed: P & R & ~Q + reveal_type(i3) # revealed: Q & ~P & ~R + reveal_type(i4) # revealed: Q & ~R & ~P + +def multiple( + i1: Intersection[Intersection[P, Q], Intersection[R, S]], +): + reveal_type(i1) # revealed: P & Q & R & S + +def nested( + i1: Intersection[Intersection[Intersection[P, Q], R], S], + i2: Intersection[P, Intersection[Q, Intersection[R, S]]], +): + reveal_type(i1) # revealed: P & Q & R & S + reveal_type(i2) # revealed: P & Q & R & S +``` + +### Union of intersections + +We always normalize our representation to a _union of intersections_, so when we add a _union to an +intersection_, we distribute the union over the respective elements: + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... +class R: ... +class S: ... + +def _( + i1: Intersection[P, Q | R | S], + i2: Intersection[P | Q | R, S], + i3: Intersection[P | Q, R | S], +) -> None: + reveal_type(i1) # revealed: (P & Q) | (P & R) | (P & S) + reveal_type(i2) # revealed: (P & S) | (Q & S) | (R & S) + reveal_type(i3) # revealed: (P & R) | (Q & R) | (P & S) | (Q & S) + +def simplifications_for_same_elements( + i1: Intersection[P, Q | P], + i2: Intersection[Q, P | Q], + i3: Intersection[P | Q, Q | R], + i4: Intersection[P | Q, P | Q], + i5: Intersection[P | Q, Q | P], +) -> None: + # P & (Q | P) + # = P & Q | P & P + # = P & Q | P + # = P + # (because P is a supertype of P & Q) + reveal_type(i1) # revealed: P + # similar here: + reveal_type(i2) # revealed: Q + + # (P | Q) & (Q | R) + # = P & Q | P & R | Q & Q | Q & R + # = P & Q | P & R | Q | Q & R + # = Q | P & R + # (again, because Q is a supertype of P & Q and of Q & R) + reveal_type(i3) # revealed: Q | (P & R) + + # (P | Q) & (P | Q) + # = P & P | P & Q | Q & P | Q & Q + # = P | P & Q | Q + # = P | Q + reveal_type(i4) # revealed: P | Q +``` + +### Negation distributes over union + +Distribution also applies to a negation operation. This is a manifestation of one of +[De Morgan's laws], namely `~(P | Q) = ~P & ~Q`: + +```py +from ty_extensions import Not +from typing import Literal + +class P: ... +class Q: ... +class R: ... + +def _(i1: Not[P | Q], i2: Not[P | Q | R]) -> None: + reveal_type(i1) # revealed: ~P & ~Q + reveal_type(i2) # revealed: ~P & ~Q & ~R + +def example_literals(i: Not[Literal[1, 2]]) -> None: + reveal_type(i) # revealed: ~Literal[1] & ~Literal[2] +``` + +### Negation of intersections + +The other of [De Morgan's laws], `~(P & Q) = ~P | ~Q`, also holds: + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... +class R: ... + +def _( + i1: Not[Intersection[P, Q]], + i2: Not[Intersection[P, Q, R]], +) -> None: + reveal_type(i1) # revealed: ~P | ~Q + reveal_type(i2) # revealed: ~P | ~Q | ~R +``` + +### `Never` is dual to `object` + +`Never` represents the empty set of values, while `object` represents the set of all values, so +`~Never` is equivalent to `object`, and `~object` is equivalent to `Never`. This is a manifestation +of the [complement laws] of set theory. + +```py +from ty_extensions import Intersection, Not +from typing_extensions import Never + +def _( + not_never: Not[Never], + not_object: Not[object], +) -> None: + reveal_type(not_never) # revealed: object + reveal_type(not_object) # revealed: Never +``` + +### `object & ~T` is equivalent to `~T` + +A second consequence of the fact that `object` is the top type is that `object` is always redundant +in intersections, and can be eagerly simplified out. `object & P` is equivalent to `P`; +`object & ~P` is equivalent to `~P` for any type `P`. + +```py +from ty_extensions import Intersection, Not, is_equivalent_to, static_assert + +class P: ... + +static_assert(is_equivalent_to(Intersection[object, P], P)) +static_assert(is_equivalent_to(Intersection[object, Not[P]], Not[P])) +``` + +### Intersection of a type and its negation + +Continuing with more [complement laws], if we see both `P` and `~P` in an intersection, we can +simplify to `Never`, even in the presence of other types: + +```py +from ty_extensions import Intersection, Not +from typing import Any + +class P: ... +class Q: ... + +def _( + i1: Intersection[P, Not[P]], + i2: Intersection[Not[P], P], + i3: Intersection[P, Q, Not[P]], + i4: Intersection[Not[P], Q, P], + i5: Intersection[P, Any, Not[P]], + i6: Intersection[Not[P], Any, P], +) -> None: + reveal_type(i1) # revealed: Never + reveal_type(i2) # revealed: Never + reveal_type(i3) # revealed: Never + reveal_type(i4) # revealed: Never + reveal_type(i5) # revealed: Never + reveal_type(i6) # revealed: Never +``` + +### Union of a type and its negation + +Similarly, if we have both `P` and `~P` in a _union_, we can simplify that to `object`. + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... + +def _( + i1: P | Not[P], + i2: Not[P] | P, + i3: P | Q | Not[P], + i4: Not[P] | Q | P, +) -> None: + reveal_type(i1) # revealed: object + reveal_type(i2) # revealed: object + reveal_type(i3) # revealed: object + reveal_type(i4) # revealed: object +``` + +### Negation is an involution + +The final of the [complement laws] states that negating twice is equivalent to not negating at all: + +```py +from ty_extensions import Not + +class P: ... + +def _( + i1: Not[P], + i2: Not[Not[P]], + i3: Not[Not[Not[P]]], + i4: Not[Not[Not[Not[P]]]], +) -> None: + reveal_type(i1) # revealed: ~P + reveal_type(i2) # revealed: P + reveal_type(i3) # revealed: ~P + reveal_type(i4) # revealed: P +``` + +## Simplification strategies + +In this section, we present various simplification strategies that go beyond the structure of the +representation. + +### `Never` in intersections + +If we intersect with `Never`, we can simplify the whole intersection to `Never`, even if there are +dynamic types involved: + +```py +from ty_extensions import Intersection, Not +from typing_extensions import Never, Any + +class P: ... +class Q: ... + +def _( + i1: Intersection[P, Never], + i2: Intersection[Never, P], + i3: Intersection[Any, Never], + i4: Intersection[Never, Not[Any]], +) -> None: + reveal_type(i1) # revealed: Never + reveal_type(i2) # revealed: Never + reveal_type(i3) # revealed: Never + reveal_type(i4) # revealed: Never +``` + +### Simplifications using disjointness + +#### Positive contributions + +If we intersect disjoint types, we can simplify to `Never`, even in the presence of other types: + +```py +from ty_extensions import Intersection, Not +from typing import Literal, Any + +class P: ... + +def _( + i01: Intersection[Literal[1], Literal[2]], + i02: Intersection[Literal[2], Literal[1]], + i03: Intersection[Literal[1], Literal[2], P], + i04: Intersection[Literal[1], P, Literal[2]], + i05: Intersection[P, Literal[1], Literal[2]], + i06: Intersection[Literal[1], Literal[2], Any], + i07: Intersection[Literal[1], Any, Literal[2]], + i08: Intersection[Any, Literal[1], Literal[2]], +) -> None: + reveal_type(i01) # revealed: Never + reveal_type(i02) # revealed: Never + reveal_type(i03) # revealed: Never + reveal_type(i04) # revealed: Never + reveal_type(i05) # revealed: Never + reveal_type(i06) # revealed: Never + reveal_type(i07) # revealed: Never + reveal_type(i08) # revealed: Never + +# `bool` is final and can not be subclassed, so `type[bool]` is equivalent to `Literal[bool]`, which +# is disjoint from `type[str]`: +def example_type_bool_type_str( + i: Intersection[type[bool], type[str]], +) -> None: + reveal_type(i) # revealed: Never +``` + +#### Positive and negative contributions + +If we intersect a type `X` with the negation `~Y` of a disjoint type `Y`, we can remove the negative +contribution `~Y`, as `~Y` must fully contain the positive contribution `X` as a subtype: + +```py +from ty_extensions import Intersection, Not +from typing import Literal + +def _( + i1: Intersection[Literal[1], Not[Literal[2]]], + i2: Intersection[Not[Literal[2]], Literal[1]], + i3: Intersection[Literal[1], Not[Literal[2]], int], + i4: Intersection[Literal[1], int, Not[Literal[2]]], + i5: Intersection[int, Literal[1], Not[Literal[2]]], +) -> None: + reveal_type(i1) # revealed: Literal[1] + reveal_type(i2) # revealed: Literal[1] + reveal_type(i3) # revealed: Literal[1] + reveal_type(i4) # revealed: Literal[1] + reveal_type(i5) # revealed: Literal[1] + +# None is disjoint from int, so this simplification applies here +def example_none( + i1: Intersection[int, Not[None]], + i2: Intersection[Not[None], int], +) -> None: + reveal_type(i1) # revealed: int + reveal_type(i2) # revealed: int +``` + +### Simplifications using subtype relationships + +#### Positive type and positive subtype + +Subtypes are contained within their supertypes, so we can simplify intersections by removing +superfluous supertypes: + +```py +from ty_extensions import Intersection, Not +from typing import Any + +class A: ... +class B(A): ... +class C(B): ... +class Unrelated: ... + +def _( + i01: Intersection[A, B], + i02: Intersection[B, A], + i03: Intersection[A, C], + i04: Intersection[C, A], + i05: Intersection[B, C], + i06: Intersection[C, B], + i07: Intersection[A, B, C], + i08: Intersection[C, B, A], + i09: Intersection[B, C, A], + i10: Intersection[A, B, Unrelated], + i11: Intersection[B, A, Unrelated], + i12: Intersection[B, Unrelated, A], + i13: Intersection[A, Unrelated, B], + i14: Intersection[Unrelated, A, B], + i15: Intersection[Unrelated, B, A], + i16: Intersection[A, B, Any], + i17: Intersection[B, A, Any], + i18: Intersection[B, Any, A], + i19: Intersection[A, Any, B], + i20: Intersection[Any, A, B], + i21: Intersection[Any, B, A], +) -> None: + reveal_type(i01) # revealed: B + reveal_type(i02) # revealed: B + reveal_type(i03) # revealed: C + reveal_type(i04) # revealed: C + reveal_type(i05) # revealed: C + reveal_type(i06) # revealed: C + reveal_type(i07) # revealed: C + reveal_type(i08) # revealed: C + reveal_type(i09) # revealed: C + reveal_type(i10) # revealed: B & Unrelated + reveal_type(i11) # revealed: B & Unrelated + reveal_type(i12) # revealed: B & Unrelated + reveal_type(i13) # revealed: Unrelated & B + reveal_type(i14) # revealed: Unrelated & B + reveal_type(i15) # revealed: Unrelated & B + reveal_type(i16) # revealed: B & Any + reveal_type(i17) # revealed: B & Any + reveal_type(i18) # revealed: B & Any + reveal_type(i19) # revealed: Any & B + reveal_type(i20) # revealed: Any & B + reveal_type(i21) # revealed: Any & B +``` + +#### Negative type and negative subtype + +For negative contributions, this property is reversed. Here we can remove superfluous _subtypes_: + +```py +from ty_extensions import Intersection, Not +from typing import Any + +class A: ... +class B(A): ... +class C(B): ... +class Unrelated: ... + +def _( + i01: Intersection[Not[B], Not[A]], + i02: Intersection[Not[A], Not[B]], + i03: Intersection[Not[A], Not[C]], + i04: Intersection[Not[C], Not[A]], + i05: Intersection[Not[B], Not[C]], + i06: Intersection[Not[C], Not[B]], + i07: Intersection[Not[A], Not[B], Not[C]], + i08: Intersection[Not[C], Not[B], Not[A]], + i09: Intersection[Not[B], Not[C], Not[A]], + i10: Intersection[Not[B], Not[A], Unrelated], + i11: Intersection[Not[A], Not[B], Unrelated], + i12: Intersection[Not[A], Unrelated, Not[B]], + i13: Intersection[Not[B], Unrelated, Not[A]], + i14: Intersection[Unrelated, Not[A], Not[B]], + i15: Intersection[Unrelated, Not[B], Not[A]], + i16: Intersection[Not[B], Not[A], Any], + i17: Intersection[Not[A], Not[B], Any], + i18: Intersection[Not[A], Any, Not[B]], + i19: Intersection[Not[B], Any, Not[A]], + i20: Intersection[Any, Not[A], Not[B]], + i21: Intersection[Any, Not[B], Not[A]], +) -> None: + reveal_type(i01) # revealed: ~A + reveal_type(i02) # revealed: ~A + reveal_type(i03) # revealed: ~A + reveal_type(i04) # revealed: ~A + reveal_type(i05) # revealed: ~B + reveal_type(i06) # revealed: ~B + reveal_type(i07) # revealed: ~A + reveal_type(i08) # revealed: ~A + reveal_type(i09) # revealed: ~A + reveal_type(i10) # revealed: Unrelated & ~A + reveal_type(i11) # revealed: Unrelated & ~A + reveal_type(i12) # revealed: Unrelated & ~A + reveal_type(i13) # revealed: Unrelated & ~A + reveal_type(i14) # revealed: Unrelated & ~A + reveal_type(i15) # revealed: Unrelated & ~A + reveal_type(i16) # revealed: Any & ~A + reveal_type(i17) # revealed: Any & ~A + reveal_type(i18) # revealed: Any & ~A + reveal_type(i19) # revealed: Any & ~A + reveal_type(i20) # revealed: Any & ~A + reveal_type(i21) # revealed: Any & ~A +``` + +#### Negative type and multiple negative subtypes + +If there are multiple negative subtypes, all of them can be removed: + +```py +from ty_extensions import Intersection, Not + +class A: ... +class B1(A): ... +class B2(A): ... + +def _( + i1: Intersection[Not[A], Not[B1], Not[B2]], + i2: Intersection[Not[A], Not[B2], Not[B1]], + i3: Intersection[Not[B1], Not[A], Not[B2]], + i4: Intersection[Not[B1], Not[B2], Not[A]], + i5: Intersection[Not[B2], Not[A], Not[B1]], + i6: Intersection[Not[B2], Not[B1], Not[A]], +) -> None: + reveal_type(i1) # revealed: ~A + reveal_type(i2) # revealed: ~A + reveal_type(i3) # revealed: ~A + reveal_type(i4) # revealed: ~A + reveal_type(i5) # revealed: ~A + reveal_type(i6) # revealed: ~A +``` + +#### Negative type and positive subtype + +When `A` is a supertype of `B`, its negation `~A` is disjoint from `B`, so we can simplify the +intersection to `Never`: + +```py +from ty_extensions import Intersection, Not +from typing import Any + +class A: ... +class B(A): ... +class C(B): ... +class Unrelated: ... + +def _( + i1: Intersection[Not[A], B], + i2: Intersection[B, Not[A]], + i3: Intersection[Not[A], C], + i4: Intersection[C, Not[A]], + i5: Intersection[Unrelated, Not[A], B], + i6: Intersection[B, Not[A], Not[Unrelated]], + i7: Intersection[Any, Not[A], B], + i8: Intersection[B, Not[A], Not[Any]], +) -> None: + reveal_type(i1) # revealed: Never + reveal_type(i2) # revealed: Never + reveal_type(i3) # revealed: Never + reveal_type(i4) # revealed: Never + reveal_type(i5) # revealed: Never + reveal_type(i6) # revealed: Never + reveal_type(i7) # revealed: Never + reveal_type(i8) # revealed: Never +``` + +### Simplifications of `bool`, `AlwaysTruthy` and `AlwaysFalsy` + +In general, intersections with `AlwaysTruthy` and `AlwaysFalsy` cannot be simplified. Naively, you +might think that `int & AlwaysFalsy` could simplify to `Literal[0]`, but this is not the case: for +example, the `False` constant inhabits the type `int & AlwaysFalsy` (due to the fact that +`False.__class__` is `bool` at runtime, and `bool` subclasses `int`), but `False` does not inhabit +the type `Literal[0]`. + +Nonetheless, intersections of `AlwaysFalsy` or `AlwaysTruthy` with `bool` _can_ be simplified, due +to the fact that `bool` is a `@final` class at runtime that cannot be subclassed. + +```py +from ty_extensions import Intersection, Not, AlwaysTruthy, AlwaysFalsy +from typing_extensions import Literal + +class P: ... + +def f( + a: Intersection[bool, AlwaysTruthy], + b: Intersection[bool, AlwaysFalsy], + c: Intersection[bool, Not[AlwaysTruthy]], + d: Intersection[bool, Not[AlwaysFalsy]], + e: Intersection[bool, AlwaysTruthy, P], + f: Intersection[bool, AlwaysFalsy, P], + g: Intersection[bool, Not[AlwaysTruthy], P], + h: Intersection[bool, Not[AlwaysFalsy], P], +): + reveal_type(a) # revealed: Literal[True] + reveal_type(b) # revealed: Literal[False] + reveal_type(c) # revealed: Literal[False] + reveal_type(d) # revealed: Literal[True] + + # `bool & AlwaysTruthy & P` -> `Literal[True] & P` -> `Never` + reveal_type(e) # revealed: Never + reveal_type(f) # revealed: Never + reveal_type(g) # revealed: Never + reveal_type(h) # revealed: Never + +def never( + a: Intersection[Intersection[AlwaysFalsy, Not[Literal[False]]], bool], + b: Intersection[Intersection[AlwaysTruthy, Not[Literal[True]]], bool], + c: Intersection[Intersection[Literal[True], Not[AlwaysTruthy]], bool], + d: Intersection[Intersection[Literal[False], Not[AlwaysFalsy]], bool], +): + # TODO: This should be `Never` + reveal_type(a) # revealed: Literal[True] + # TODO: This should be `Never` + reveal_type(b) # revealed: Literal[False] + reveal_type(c) # revealed: Never + reveal_type(d) # revealed: Never +``` + +## Simplification of `LiteralString`, `AlwaysTruthy` and `AlwaysFalsy` + +Similarly, intersections between `LiteralString`, `AlwaysTruthy` and `AlwaysFalsy` can be +simplified, due to the fact that a `LiteralString` inhabitant is known to have `__class__` set to +exactly `str` (and not a subclass of `str`): + +```py +from ty_extensions import Intersection, Not, AlwaysTruthy, AlwaysFalsy, Unknown +from typing_extensions import LiteralString + +def f( + a: Intersection[LiteralString, AlwaysTruthy], + b: Intersection[LiteralString, AlwaysFalsy], + c: Intersection[LiteralString, Not[AlwaysTruthy]], + d: Intersection[LiteralString, Not[AlwaysFalsy]], + e: Intersection[AlwaysFalsy, LiteralString], + f: Intersection[Not[AlwaysTruthy], LiteralString], + g: Intersection[AlwaysTruthy, LiteralString], + h: Intersection[Not[AlwaysFalsy], LiteralString], + i: Intersection[Unknown, LiteralString, AlwaysFalsy], + j: Intersection[Not[AlwaysTruthy], Unknown, LiteralString], +): + reveal_type(a) # revealed: LiteralString & ~Literal[""] + reveal_type(b) # revealed: Literal[""] + reveal_type(c) # revealed: Literal[""] + reveal_type(d) # revealed: LiteralString & ~Literal[""] + reveal_type(e) # revealed: Literal[""] + reveal_type(f) # revealed: Literal[""] + reveal_type(g) # revealed: LiteralString & ~Literal[""] + reveal_type(h) # revealed: LiteralString & ~Literal[""] + reveal_type(i) # revealed: Unknown & Literal[""] + reveal_type(j) # revealed: Unknown & Literal[""] +``` + +## Addition of a type to an intersection with many non-disjoint types + +This slightly strange-looking test is a regression test for a mistake that was nearly made in a PR: +<https://github.com/astral-sh/ruff/pull/15475#discussion_r1915041987>. + +```py +from ty_extensions import AlwaysFalsy, Intersection, Unknown +from typing_extensions import Literal + +def _(x: Intersection[str, Unknown, AlwaysFalsy, Literal[""]]): + reveal_type(x) # revealed: Unknown & Literal[""] +``` + +## Non fully-static types + +### Negation of dynamic types + +`Any` represents the dynamic type, an unknown set of runtime values. The negation of that, `~Any`, +is still an unknown set of runtime values, so `~Any` is equivalent to `Any`. We therefore eagerly +simplify `~Any` to `Any` in intersections. The same applies to `Unknown`. + +```py +from ty_extensions import Intersection, Not, Unknown +from typing_extensions import Any, Never + +class P: ... + +def any( + i1: Not[Any], + i2: Intersection[P, Not[Any]], + i3: Intersection[Never, Not[Any]], +) -> None: + reveal_type(i1) # revealed: Any + reveal_type(i2) # revealed: P & Any + reveal_type(i3) # revealed: Never + +def unknown( + i1: Not[Unknown], + i2: Intersection[P, Not[Unknown]], + i3: Intersection[Never, Not[Unknown]], +) -> None: + reveal_type(i1) # revealed: Unknown + reveal_type(i2) # revealed: P & Unknown + reveal_type(i3) # revealed: Never +``` + +### Collapsing of multiple `Any`/`Unknown` contributions + +The intersection of an unknown set of runtime values with (another) unknown set of runtime values is +still an unknown set of runtime values: + +```py +from ty_extensions import Intersection, Not, Unknown +from typing_extensions import Any + +class P: ... + +def any( + i1: Intersection[Any, Any], + i2: Intersection[P, Any, Any], + i3: Intersection[Any, P, Any], + i4: Intersection[Any, Any, P], +) -> None: + reveal_type(i1) # revealed: Any + reveal_type(i2) # revealed: P & Any + reveal_type(i3) # revealed: Any & P + reveal_type(i4) # revealed: Any & P + +def unknown( + i1: Intersection[Unknown, Unknown], + i2: Intersection[P, Unknown, Unknown], + i3: Intersection[Unknown, P, Unknown], + i4: Intersection[Unknown, Unknown, P], +) -> None: + reveal_type(i1) # revealed: Unknown + reveal_type(i2) # revealed: P & Unknown + reveal_type(i3) # revealed: Unknown & P + reveal_type(i4) # revealed: Unknown & P +``` + +### No self-cancellation + +Dynamic types do not cancel each other out. Intersecting an unknown set of values with the negation +of another unknown set of values is not necessarily empty, so we keep the positive contribution: + +```py +from typing import Any +from ty_extensions import Intersection, Not, Unknown + +def any( + i1: Intersection[Any, Not[Any]], + i2: Intersection[Not[Any], Any], +) -> None: + reveal_type(i1) # revealed: Any + reveal_type(i2) # revealed: Any + +def unknown( + i1: Intersection[Unknown, Not[Unknown]], + i2: Intersection[Not[Unknown], Unknown], +) -> None: + reveal_type(i1) # revealed: Unknown + reveal_type(i2) # revealed: Unknown +``` + +### Mixed dynamic types + +Gradually-equivalent types can be simplified out of intersections: + +```py +from typing import Any +from ty_extensions import Intersection, Not, Unknown + +def mixed( + i1: Intersection[Any, Unknown], + i2: Intersection[Any, Not[Unknown]], + i3: Intersection[Not[Any], Unknown], + i4: Intersection[Not[Any], Not[Unknown]], +) -> None: + reveal_type(i1) # revealed: Any + reveal_type(i2) # revealed: Any + reveal_type(i3) # revealed: Any + reveal_type(i4) # revealed: Any +``` + +## Invalid + +```py +from ty_extensions import Intersection, Not + +# error: [invalid-type-form] "`ty_extensions.Intersection` requires at least one argument when used in a type expression" +def f(x: Intersection) -> None: + reveal_type(x) # revealed: Unknown + +# error: [invalid-type-form] "`ty_extensions.Not` requires exactly one argument when used in a type expression" +def f(x: Not) -> None: + reveal_type(x) # revealed: Unknown +``` + +[complement laws]: https://en.wikipedia.org/wiki/Complement_(set_theory) +[de morgan's laws]: https://en.wikipedia.org/wiki/De_Morgan%27s_laws diff --git a/crates/ty_python_semantic/resources/mdtest/invalid_syntax.md b/crates/ty_python_semantic/resources/mdtest/invalid_syntax.md new file mode 100644 index 0000000000000..cc90879401628 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/invalid_syntax.md @@ -0,0 +1,106 @@ +# Syntax errors + +Test cases to ensure that ty does not panic if there are syntax errors in the source code. + +The parser cannot recover from certain syntax errors completely which is why the number of syntax +errors could be more than expected in the following examples. For instance, if there's a keyword +(like `for`) in the middle of another statement (like function definition), then it's more likely +that the rest of the tokens are going to be part of the `for` statement and not the function +definition. But, it's not necessary that the remaining tokens are valid in the context of a `for` +statement. + +## Keyword as identifiers + +When keywords are used as identifiers, the parser recovers from this syntax error by emitting an +error and including the text value of the keyword to create the `Identifier` node. + +### Name expression + +#### Assignment + +```py +# error: [invalid-syntax] +pass = 1 +``` + +#### Type alias + +```py +# error: [invalid-syntax] +# error: [invalid-syntax] +type pass = 1 +``` + +#### Function definition + +```py +# error: [invalid-syntax] +# error: [invalid-syntax] +# error: [invalid-syntax] +# error: [invalid-syntax] +# error: [invalid-syntax] +def True(for): + # error: [invalid-syntax] + # error: [invalid-syntax] + pass +``` + +#### For + +```py +# error: [invalid-syntax] +# error: [invalid-syntax] +# error: [unresolved-reference] "Name `pass` used when not defined" +for while in pass: + pass +``` + +#### While + +```py +# error: [invalid-syntax] +# error: [unresolved-reference] "Name `in` used when not defined" +while in: + pass +``` + +#### Match + +```py +# error: [invalid-syntax] +# error: [invalid-syntax] +# error: [unresolved-reference] "Name `match` used when not defined" +match while: + # error: [invalid-syntax] + # error: [invalid-syntax] + # error: [invalid-syntax] + # error: [unresolved-reference] "Name `case` used when not defined" + case in: + # error: [invalid-syntax] + # error: [invalid-syntax] + pass +``` + +### Attribute expression + +```py +# TODO: Check when support for attribute expressions is added + +# error: [invalid-syntax] +# error: [unresolved-reference] "Name `foo` used when not defined" +for x in foo.pass: + pass +``` + +## Invalid annotation + +### `typing.Callable` + +```py +from typing import Callable + +# error: [invalid-syntax] "Expected index or slice expression" +# error: [invalid-type-form] "Special form `typing.Callable` expected exactly two arguments (parameter types and return type)" +def _(c: Callable[]): + reveal_type(c) # revealed: (...) -> Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/known_constants.md b/crates/ty_python_semantic/resources/mdtest/known_constants.md new file mode 100644 index 0000000000000..db53b807dcac9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/known_constants.md @@ -0,0 +1,151 @@ +# Known constants + +## `typing.TYPE_CHECKING` + +This constant is `True` when in type-checking mode, `False` otherwise. The symbol is defined to be +`False` at runtime. In typeshed, it is annotated as `bool`. This test makes sure that we infer +`Literal[True]` for it anyways. + +### Basic + +```py +from typing import TYPE_CHECKING +import typing + +reveal_type(TYPE_CHECKING) # revealed: Literal[True] +reveal_type(typing.TYPE_CHECKING) # revealed: Literal[True] +``` + +### Aliased + +Make sure that we still infer the correct type if the constant has been given a different name: + +```py +from typing import TYPE_CHECKING as TC + +reveal_type(TC) # revealed: Literal[True] +``` + +### `typing_extensions` re-export + +This should behave in the same way as `typing.TYPE_CHECKING`: + +```py +from typing_extensions import TYPE_CHECKING + +reveal_type(TYPE_CHECKING) # revealed: Literal[True] +``` + +## User-defined `TYPE_CHECKING` + +If we set `TYPE_CHECKING = False` directly instead of importing it from the `typing` module, it will +still be treated as `True` during type checking. This behavior is for compatibility with other major +type checkers, e.g. mypy and pyright. + +### With no type annotation + +```py +TYPE_CHECKING = False +reveal_type(TYPE_CHECKING) # revealed: Literal[True] +if TYPE_CHECKING: + type_checking = True +if not TYPE_CHECKING: + runtime = True + +# type_checking is treated as unconditionally assigned. +reveal_type(type_checking) # revealed: Literal[True] +# error: [unresolved-reference] +reveal_type(runtime) # revealed: Unknown +``` + +### With a type annotation + +We can also define `TYPE_CHECKING` with a type annotation. The type must be one to which `bool` can +be assigned. Even in this case, the type of `TYPE_CHECKING` is still inferred to be `Literal[True]`. + +```py +TYPE_CHECKING: bool = False +reveal_type(TYPE_CHECKING) # revealed: Literal[True] +if TYPE_CHECKING: + type_checking = True +if not TYPE_CHECKING: + runtime = True + +reveal_type(type_checking) # revealed: Literal[True] +# error: [unresolved-reference] +reveal_type(runtime) # revealed: Unknown +``` + +### Importing user-defined `TYPE_CHECKING` + +`constants.py`: + +```py +TYPE_CHECKING = False +``` + +`stub.pyi`: + +```pyi +TYPE_CHECKING: bool +# or +TYPE_CHECKING: bool = ... +``` + +```py +from constants import TYPE_CHECKING + +reveal_type(TYPE_CHECKING) # revealed: Literal[True] + +from stub import TYPE_CHECKING + +reveal_type(TYPE_CHECKING) # revealed: Literal[True] +``` + +### Invalid assignment to `TYPE_CHECKING` + +Only `False` can be assigned to `TYPE_CHECKING`; any assignment other than `False` will result in an +error. A type annotation to which `bool` is not assignable is also an error. + +```py +from typing import Literal + +# error: [invalid-type-checking-constant] +TYPE_CHECKING = True + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: bool = True + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: int = 1 + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: str = "str" + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: str = False + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: Literal[False] = False + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: Literal[True] = False +``` + +The same rules apply in a stub file: + +```pyi +from typing import Literal + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: str + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: str = False + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: Literal[False] = ... + +# error: [invalid-type-checking-constant] +TYPE_CHECKING: object = "str" +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/boolean.md b/crates/ty_python_semantic/resources/mdtest/literal/boolean.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/boolean.md rename to crates/ty_python_semantic/resources/mdtest/literal/boolean.md diff --git a/crates/ty_python_semantic/resources/mdtest/literal/bytes.md b/crates/ty_python_semantic/resources/mdtest/literal/bytes.md new file mode 100644 index 0000000000000..391eff8ad5546 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/bytes.md @@ -0,0 +1,10 @@ +# Bytes literals + +## Simple + +```py +reveal_type(b"t" b"y") # revealed: Literal[b"ty"] +reveal_type(b"hello") # revealed: Literal[b"hello"] +reveal_type(b"world" + b"!") # revealed: Literal[b"world!"] +reveal_type(b"\xff\x00") # revealed: Literal[b"\xff\x00"] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/literal/collections/dictionary.md b/crates/ty_python_semantic/resources/mdtest/literal/collections/dictionary.md new file mode 100644 index 0000000000000..37abd2b98bb20 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/collections/dictionary.md @@ -0,0 +1,7 @@ +# Dictionaries + +## Empty dictionary + +```py +reveal_type({}) # revealed: dict[Unknown, Unknown] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/literal/collections/list.md b/crates/ty_python_semantic/resources/mdtest/literal/collections/list.md new file mode 100644 index 0000000000000..53915f27c2961 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/collections/list.md @@ -0,0 +1,7 @@ +# Lists + +## Empty list + +```py +reveal_type([]) # revealed: list[Unknown] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/literal/collections/set.md b/crates/ty_python_semantic/resources/mdtest/literal/collections/set.md new file mode 100644 index 0000000000000..85acd78e3e1d2 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/collections/set.md @@ -0,0 +1,7 @@ +# Sets + +## Basic set + +```py +reveal_type({1, 2}) # revealed: set[Unknown] +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/collections/tuple.md b/crates/ty_python_semantic/resources/mdtest/literal/collections/tuple.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/collections/tuple.md rename to crates/ty_python_semantic/resources/mdtest/literal/collections/tuple.md diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/complex.md b/crates/ty_python_semantic/resources/mdtest/literal/complex.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/complex.md rename to crates/ty_python_semantic/resources/mdtest/literal/complex.md diff --git a/crates/ty_python_semantic/resources/mdtest/literal/ellipsis.md b/crates/ty_python_semantic/resources/mdtest/literal/ellipsis.md new file mode 100644 index 0000000000000..241b498372d49 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/ellipsis.md @@ -0,0 +1,23 @@ +# Ellipsis literals + +## Python 3.9 + +```toml +[environment] +python-version = "3.9" +``` + +```py +reveal_type(...) # revealed: ellipsis +``` + +## Python 3.10 + +```toml +[environment] +python-version = "3.10" +``` + +```py +reveal_type(...) # revealed: EllipsisType +``` diff --git a/crates/ty_python_semantic/resources/mdtest/literal/f_string.md b/crates/ty_python_semantic/resources/mdtest/literal/f_string.md new file mode 100644 index 0000000000000..63d43501f272a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/literal/f_string.md @@ -0,0 +1,32 @@ +# f-strings + +## Expression + +```py +from typing_extensions import Literal + +def _(x: Literal[0], y: str, z: Literal[False]): + reveal_type(f"hello") # revealed: Literal["hello"] + reveal_type(f"h {x}") # revealed: Literal["h 0"] + reveal_type("one " f"single " f"literal") # revealed: Literal["one single literal"] + reveal_type("first " f"second({x})" f" third") # revealed: Literal["first second(0) third"] + reveal_type(f"-{y}-") # revealed: str + reveal_type(f"-{y}-" f"--" "--") # revealed: str + reveal_type(f"{z} == {False} is {True}") # revealed: Literal["False == False is True"] +``` + +## Conversion Flags + +```py +string = "hello" + +# TODO: should be `Literal["'hello'"]` +reveal_type(f"{string!r}") # revealed: str +``` + +## Format Specifiers + +```py +# TODO: should be `Literal["01"]` +reveal_type(f"{1:02}") # revealed: str +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/float.md b/crates/ty_python_semantic/resources/mdtest/literal/float.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/float.md rename to crates/ty_python_semantic/resources/mdtest/literal/float.md diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/integer.md b/crates/ty_python_semantic/resources/mdtest/literal/integer.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/integer.md rename to crates/ty_python_semantic/resources/mdtest/literal/integer.md diff --git a/crates/red_knot_python_semantic/resources/mdtest/literal/string.md b/crates/ty_python_semantic/resources/mdtest/literal/string.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/literal/string.md rename to crates/ty_python_semantic/resources/mdtest/literal/string.md diff --git a/crates/ty_python_semantic/resources/mdtest/loops/async_for.md b/crates/ty_python_semantic/resources/mdtest/loops/async_for.md new file mode 100644 index 0000000000000..c0735768763e2 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/loops/async_for.md @@ -0,0 +1,45 @@ +# Async + +Async `for` loops do not work according to the synchronous iteration protocol. + +## Invalid async for loop + +```py +async def foo(): + class Iterator: + def __next__(self) -> int: + return 42 + + class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + + async for x in Iterator(): + pass + + # TODO: should reveal `Unknown` because `__aiter__` is not defined + # revealed: @Todo(async iterables/iterators) + # error: [possibly-unresolved-reference] + reveal_type(x) +``` + +## Basic async for loop + +```py +async def foo(): + class IntAsyncIterator: + async def __anext__(self) -> int: + return 42 + + class IntAsyncIterable: + def __aiter__(self) -> IntAsyncIterator: + return IntAsyncIterator() + + # TODO(Alex): async iterables/iterators! + async for x in IntAsyncIterable(): + pass + + # error: [possibly-unresolved-reference] + # revealed: @Todo(async iterables/iterators) + reveal_type(x) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/loops/for.md b/crates/ty_python_semantic/resources/mdtest/loops/for.md new file mode 100644 index 0000000000000..85f2390aa8919 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/loops/for.md @@ -0,0 +1,749 @@ +# For loops + +## Basic `for` loop + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +for x in IntIterable(): + pass + +# revealed: int +# error: [possibly-unresolved-reference] +reveal_type(x) +``` + +## With previous definition + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +x = "foo" + +for x in IntIterable(): + pass + +reveal_type(x) # revealed: Literal["foo"] | int +``` + +## With `else` (no break) + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +for x in IntIterable(): + pass +else: + x = "foo" + +reveal_type(x) # revealed: Literal["foo"] +``` + +## May `break` + +```py +class IntIterator: + def __next__(self) -> int: + return 42 + +class IntIterable: + def __iter__(self) -> IntIterator: + return IntIterator() + +for x in IntIterable(): + if x > 5: + break +else: + x = "foo" + +reveal_type(x) # revealed: int | Literal["foo"] +``` + +## With old-style iteration protocol + +```py +class OldStyleIterable: + def __getitem__(self, key: int) -> int: + return 42 + +for x in OldStyleIterable(): + pass + +# revealed: int +# error: [possibly-unresolved-reference] +reveal_type(x) +``` + +## With heterogeneous tuple + +```py +for x in (1, "a", b"foo"): + pass + +# revealed: Literal[1, "a", b"foo"] +# error: [possibly-unresolved-reference] +reveal_type(x) +``` + +## With non-callable iterator + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def _(flag: bool): + class NotIterable: + if flag: + __iter__: int = 1 + else: + __iter__: None = None + + # error: [not-iterable] + for x in NotIterable(): + pass + + # revealed: Unknown + # error: [possibly-unresolved-reference] + reveal_type(x) +``` + +## Invalid iterable + +<!-- snapshot-diagnostics --> + +```py +nonsense = 123 +for x in nonsense: # error: [not-iterable] + pass +``` + +## New over old style iteration protocol + +<!-- snapshot-diagnostics --> + +```py +class NotIterable: + def __getitem__(self, key: int) -> int: + return 42 + __iter__: None = None + +for x in NotIterable(): # error: [not-iterable] + pass +``` + +## Union type as iterable + +```py +class TestIter: + def __next__(self) -> int: + return 42 + +class Test: + def __iter__(self) -> TestIter: + return TestIter() + +class Test2: + def __iter__(self) -> TestIter: + return TestIter() + +def _(flag: bool): + for x in Test() if flag else Test2(): + reveal_type(x) # revealed: int +``` + +## Union type as iterator + +```py +class TestIter: + def __next__(self) -> int: + return 42 + +class TestIter2: + def __next__(self) -> int: + return 42 + +class Test: + def __iter__(self) -> TestIter | TestIter2: + return TestIter() + +for x in Test(): + reveal_type(x) # revealed: int +``` + +## Union type as iterable and union type as iterator + +```py +class Result1A: ... +class Result1B: ... +class Result2A: ... +class Result2B: ... +class Result3: ... +class Result4: ... + +class TestIter1: + def __next__(self) -> Result1A | Result1B: + return Result1B() + +class TestIter2: + def __next__(self) -> Result2A | Result2B: + return Result2B() + +class TestIter3: + def __next__(self) -> Result3: + return Result3() + +class TestIter4: + def __next__(self) -> Result4: + return Result4() + +class Test: + def __iter__(self) -> TestIter1 | TestIter2: + return TestIter1() + +class Test2: + def __iter__(self) -> TestIter3 | TestIter4: + return TestIter3() + +def _(flag: bool): + for x in Test() if flag else Test2(): + reveal_type(x) # revealed: Result1A | Result1B | Result2A | Result2B | Result3 | Result4 +``` + +## Union type as iterable where one union element has no `__iter__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class TestIter: + def __next__(self) -> int: + return 42 + +class Test: + def __iter__(self) -> TestIter: + return TestIter() + +def _(flag: bool): + # error: [not-iterable] + for x in Test() if flag else 42: + reveal_type(x) # revealed: int +``` + +## Union type as iterable where one union element has invalid `__iter__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class TestIter: + def __next__(self) -> int: + return 42 + +class Test: + def __iter__(self) -> TestIter: + return TestIter() + +class Test2: + def __iter__(self) -> int: + return 42 + +def _(flag: bool): + # TODO: Improve error message to state which union variant isn't iterable (https://github.com/astral-sh/ruff/issues/13989) + # error: [not-iterable] + for x in Test() if flag else Test2(): + reveal_type(x) # revealed: int +``` + +## Union type as iterator where one union element has no `__next__` method + +```py +class TestIter: + def __next__(self) -> int: + return 42 + +class Test: + def __iter__(self) -> TestIter | int: + return TestIter() + +# error: [not-iterable] "Object of type `Test` may not be iterable" +for x in Test(): + reveal_type(x) # revealed: int +``` + +## Possibly-not-callable `__iter__` method + +```py +def _(flag: bool): + class Iterator: + def __next__(self) -> int: + return 42 + + class CustomCallable: + if flag: + def __call__(self, *args, **kwargs) -> Iterator: + return Iterator() + else: + __call__: None = None + + class Iterable1: + __iter__: CustomCallable = CustomCallable() + + class Iterable2: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + else: + __iter__: None = None + + # error: [not-iterable] "Object of type `Iterable1` may not be iterable" + for x in Iterable1(): + # TODO... `int` might be ideal here? + reveal_type(x) # revealed: int | Unknown + + # error: [not-iterable] "Object of type `Iterable2` may not be iterable" + for y in Iterable2(): + # TODO... `int` might be ideal here? + reveal_type(y) # revealed: int | Unknown +``` + +## `__iter__` method with a bad signature + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self, extra_arg) -> Iterator: + return Iterator() + +# error: [not-iterable] +for x in Iterable(): + reveal_type(x) # revealed: int +``` + +## `__iter__` does not return an iterator + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Bad: + def __iter__(self) -> int: + return 42 + +# error: [not-iterable] +for x in Bad(): + reveal_type(x) # revealed: Unknown +``` + +## `__iter__` returns an object with a possibly unbound `__next__` method + +```py +def _(flag: bool): + class Iterator: + if flag: + def __next__(self) -> int: + return 42 + + class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + + # error: [not-iterable] "Object of type `Iterable` may not be iterable" + for x in Iterable(): + reveal_type(x) # revealed: int +``` + +## `__iter__` returns an iterator with an invalid `__next__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterator1: + def __next__(self, extra_arg) -> int: + return 42 + +class Iterator2: + __next__: None = None + +class Iterable1: + def __iter__(self) -> Iterator1: + return Iterator1() + +class Iterable2: + def __iter__(self) -> Iterator2: + return Iterator2() + +# error: [not-iterable] +for x in Iterable1(): + reveal_type(x) # revealed: int + +# error: [not-iterable] +for y in Iterable2(): + reveal_type(y) # revealed: Unknown +``` + +## Possibly unbound `__iter__` and bad `__getitem__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def _(flag: bool): + class Iterator: + def __next__(self) -> int: + return 42 + + class Iterable: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + # invalid signature because it only accepts a `str`, + # but the old-style iteration protocol will pass it an `int` + def __getitem__(self, key: str) -> bytes: + return bytes() + + # error: [not-iterable] + for x in Iterable(): + reveal_type(x) # revealed: int | bytes +``` + +## Possibly unbound `__iter__` and not-callable `__getitem__` + +This snippet tests that we infer the element type correctly in the following edge case: + +- `__iter__` is a method with the correct parameter spec that returns a valid iterator; BUT +- `__iter__` is possibly unbound; AND +- `__getitem__` is set to a non-callable type + +It's important that we emit a diagnostic here, but it's also important that we still use the return +type of the iterator's `__next__` method as the inferred type of `x` in the `for` loop: + +```py +def _(flag: bool): + class Iterator: + def __next__(self) -> int: + return 42 + + class Iterable: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + __getitem__: None = None + + # error: [not-iterable] "Object of type `Iterable` may not be iterable" + for x in Iterable(): + reveal_type(x) # revealed: int +``` + +## Possibly unbound `__iter__` and possibly unbound `__getitem__` + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterator: + def __next__(self) -> int: + return 42 + +def _(flag1: bool, flag2: bool): + class Iterable: + if flag1: + def __iter__(self) -> Iterator: + return Iterator() + if flag2: + def __getitem__(self, key: int) -> bytes: + return bytes() + + # error: [not-iterable] + for x in Iterable(): + reveal_type(x) # revealed: int | bytes +``` + +## No `__iter__` method and `__getitem__` is not callable + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Bad: + __getitem__: None = None + +# error: [not-iterable] +for x in Bad(): + reveal_type(x) # revealed: Unknown +``` + +## Possibly-not-callable `__getitem__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def _(flag: bool): + class CustomCallable: + if flag: + def __call__(self, *args, **kwargs) -> int: + return 42 + else: + __call__: None = None + + class Iterable1: + __getitem__: CustomCallable = CustomCallable() + + class Iterable2: + if flag: + def __getitem__(self, key: int) -> int: + return 42 + else: + __getitem__: None = None + + # error: [not-iterable] + for x in Iterable1(): + # TODO... `int` might be ideal here? + reveal_type(x) # revealed: int | Unknown + + # error: [not-iterable] + for y in Iterable2(): + # TODO... `int` might be ideal here? + reveal_type(y) # revealed: int | Unknown +``` + +## Bad `__getitem__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterable: + # invalid because it will implicitly be passed an `int` + # by the interpreter + def __getitem__(self, key: str) -> int: + return 42 + +# error: [not-iterable] +for x in Iterable(): + reveal_type(x) # revealed: int +``` + +## Possibly unbound `__iter__` but definitely bound `__getitem__` + +Here, we should not emit a diagnostic: if `__iter__` is unbound, we should fallback to +`__getitem__`: + +```py +class Iterator: + def __next__(self) -> str: + return "foo" + +def _(flag: bool): + class Iterable: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + + def __getitem__(self, key: int) -> bytes: + return b"foo" + + for x in Iterable(): + reveal_type(x) # revealed: str | bytes +``` + +## Possibly invalid `__iter__` methods + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterator: + def __next__(self) -> int: + return 42 + +def _(flag: bool): + class Iterable1: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + else: + def __iter__(self, invalid_extra_arg) -> Iterator: + return Iterator() + + # error: [not-iterable] + for x in Iterable1(): + reveal_type(x) # revealed: int + + class Iterable2: + if flag: + def __iter__(self) -> Iterator: + return Iterator() + else: + __iter__: None = None + + # error: [not-iterable] + for x in Iterable2(): + # TODO: `int` would probably be better here: + reveal_type(x) # revealed: int | Unknown +``` + +## Possibly invalid `__next__` method + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def _(flag: bool): + class Iterator1: + if flag: + def __next__(self) -> int: + return 42 + else: + def __next__(self, invalid_extra_arg) -> str: + return "foo" + + class Iterator2: + if flag: + def __next__(self) -> int: + return 42 + else: + __next__: None = None + + class Iterable1: + def __iter__(self) -> Iterator1: + return Iterator1() + + class Iterable2: + def __iter__(self) -> Iterator2: + return Iterator2() + + # error: [not-iterable] + for x in Iterable1(): + reveal_type(x) # revealed: int | str + + # error: [not-iterable] + for y in Iterable2(): + # TODO: `int` would probably be better here: + reveal_type(y) # revealed: int | Unknown +``` + +## Possibly invalid `__getitem__` methods + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +def _(flag: bool): + class Iterable1: + if flag: + def __getitem__(self, item: int) -> str: + return "foo" + else: + __getitem__: None = None + + class Iterable2: + if flag: + def __getitem__(self, item: int) -> str: + return "foo" + else: + def __getitem__(self, item: str) -> int: + return 42 + + # error: [not-iterable] + for x in Iterable1(): + # TODO: `str` might be better + reveal_type(x) # revealed: str | Unknown + + # error: [not-iterable] + for y in Iterable2(): + reveal_type(y) # revealed: str | int +``` + +## Possibly unbound `__iter__` and possibly invalid `__getitem__` + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Iterator: + def __next__(self) -> bytes: + return b"foo" + +def _(flag: bool, flag2: bool): + class Iterable1: + if flag: + def __getitem__(self, item: int) -> str: + return "foo" + else: + __getitem__: None = None + + if flag2: + def __iter__(self) -> Iterator: + return Iterator() + + class Iterable2: + if flag: + def __getitem__(self, item: int) -> str: + return "foo" + else: + def __getitem__(self, item: str) -> int: + return 42 + if flag2: + def __iter__(self) -> Iterator: + return Iterator() + + # error: [not-iterable] + for x in Iterable1(): + # TODO: `bytes | str` might be better + reveal_type(x) # revealed: bytes | str | Unknown + + # error: [not-iterable] + for y in Iterable2(): + reveal_type(y) # revealed: bytes | str | int +``` + +## Never is iterable + +```py +from typing_extensions import Never + +def f(never: Never): + for x in never: + reveal_type(x) # revealed: Never +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/loops/iterators.md b/crates/ty_python_semantic/resources/mdtest/loops/iterators.md similarity index 82% rename from crates/red_knot_python_semantic/resources/mdtest/loops/iterators.md rename to crates/ty_python_semantic/resources/mdtest/loops/iterators.md index 8ec99c9e40484..5b8c009fe33a2 100644 --- a/crates/red_knot_python_semantic/resources/mdtest/loops/iterators.md +++ b/crates/ty_python_semantic/resources/mdtest/loops/iterators.md @@ -10,7 +10,8 @@ class Iterator: return 42 class Iterable: - def __iter__(self) -> Iterator: ... + def __iter__(self) -> Iterator: + return Iterator() def generator_function(): yield from Iterable() diff --git a/crates/ty_python_semantic/resources/mdtest/loops/while_loop.md b/crates/ty_python_semantic/resources/mdtest/loops/while_loop.md new file mode 100644 index 0000000000000..5a5784b85daf1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/loops/while_loop.md @@ -0,0 +1,129 @@ +# While loops + +## Basic `while` loop + +```py +def _(flag: bool): + x = 1 + while flag: + x = 2 + + reveal_type(x) # revealed: Literal[1, 2] +``` + +## `while` with `else` (no `break`) + +```py +def _(flag: bool): + x = 1 + while flag: + x = 2 + else: + reveal_type(x) # revealed: Literal[1, 2] + x = 3 + + reveal_type(x) # revealed: Literal[3] +``` + +## `while` with `else` (may `break`) + +```py +def _(flag: bool, flag2: bool): + x = 1 + y = 0 + while flag: + x = 2 + if flag2: + y = 4 + break + else: + y = x + x = 3 + + reveal_type(x) # revealed: Literal[2, 3] + reveal_type(y) # revealed: Literal[4, 1, 2] +``` + +## Nested `while` loops + +```py +def flag() -> bool: + return True + +x = 1 + +while flag(): + x = 2 + + while flag(): + x = 3 + if flag(): + break + else: + x = 4 + + if flag(): + break +else: + x = 5 + +reveal_type(x) # revealed: Literal[3, 4, 5] +``` + +## Boundness + +Make sure that the boundness information is correctly tracked in `while` loop control flow. + +### Basic `while` loop + +```py +def _(flag: bool): + while flag: + x = 1 + + # error: [possibly-unresolved-reference] + x +``` + +### `while` with `else` (no `break`) + +```py +def _(flag: bool): + while flag: + y = 1 + else: + x = 1 + + # no error, `x` is always bound + x + # error: [possibly-unresolved-reference] + y +``` + +### `while` with `else` (may `break`) + +```py +def _(flag: bool, flag2: bool): + while flag: + x = 1 + if flag2: + break + else: + y = 1 + + # error: [possibly-unresolved-reference] + x + # error: [possibly-unresolved-reference] + y +``` + +## Condition with object that implements `__bool__` incorrectly + +```py +class NotBoolable: + __bool__: int = 3 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `NotBoolable`" +while NotBoolable(): + ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/mdtest_config.md b/crates/ty_python_semantic/resources/mdtest/mdtest_config.md new file mode 100644 index 0000000000000..6db92ff3210ef --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/mdtest_config.md @@ -0,0 +1,77 @@ +This test makes sure that `ty_test` correctly parses the TOML configuration blocks and applies the +correct settings hierarchically. + +The following configuration will be attached to the *root* section (without any heading): + +```toml +[environment] +python-version = "3.10" +``` + +# Basic + +Here, we simply make sure that we pick up the global configuration from the root section: + +```py +import sys + +reveal_type(sys.version_info[:2] == (3, 10)) # revealed: Literal[True] +``` + +# Inheritance + +## Child + +### Grandchild + +The same should work for arbitrarily nested sections: + +```py +import sys + +reveal_type(sys.version_info[:2] == (3, 10)) # revealed: Literal[True] +``` + +# Overwriting + +Here, we make sure that we can overwrite the global configuration in a child section: + +```toml +[environment] +python-version = "3.11" +``` + +```py +import sys + +reveal_type(sys.version_info[:2] == (3, 11)) # revealed: Literal[True] +``` + +# No global state + +There is no global state. This section should again use the root configuration: + +```py +import sys + +reveal_type(sys.version_info[:2] == (3, 10)) # revealed: Literal[True] +``` + +# Overwriting affects children + +Children in this section should all use the section configuration: + +```toml +[environment] +python-version = "3.12" +``` + +## Child + +### Grandchild + +```py +import sys + +reveal_type(sys.version_info[:2] == (3, 12)) # revealed: Literal[True] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/mdtest_custom_typeshed.md b/crates/ty_python_semantic/resources/mdtest/mdtest_custom_typeshed.md new file mode 100644 index 0000000000000..e436f401fbc2b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/mdtest_custom_typeshed.md @@ -0,0 +1,108 @@ +# Custom typeshed + +The `environment.typeshed` configuration option can be used to specify a custom typeshed directory +for Markdown-based tests. Custom typeshed stubs can then be placed in the specified directory using +fenced code blocks with language `pyi`, and will be used instead of the vendored copy of typeshed. + +A fenced code block with language `text` can be used to provide a `stdlib/VERSIONS` file in the +custom typeshed root. If no such file is created explicitly, it will be automatically created with +entries enabling all specified `<typeshed-root>/stdlib` files for all supported Python versions. + +## Basic example (auto-generated `VERSIONS` file) + +First, we specify `/typeshed` as the custom typeshed directory: + +```toml +[environment] +typeshed = "/typeshed" +``` + +We can then place custom stub files in `/typeshed/stdlib`, for example: + +`/typeshed/stdlib/builtins.pyi`: + +```pyi +class object: ... +class BuiltinClass: ... + +builtin_symbol: BuiltinClass +``` + +`/typeshed/stdlib/sys/__init__.pyi`: + +```pyi +version = "my custom Python" +``` + +And finally write a normal Python code block that makes use of the custom stubs: + +```py +b: BuiltinClass = builtin_symbol + +class OtherClass: ... + +o: OtherClass = builtin_symbol # error: [invalid-assignment] + +# Make sure that 'sys' has a proper entry in the auto-generated 'VERSIONS' file +import sys +``` + +## Custom `VERSIONS` file + +If we want to specify a custom `VERSIONS` file, we can do so by creating a fenced code block with +language `text`. In the following test, we set the Python version to `3.10` and then make sure that +we can *not* import `new_module` with a version requirement of `3.11-`: + +```toml +[environment] +python-version = "3.10" +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/old_module.pyi`: + +```pyi +class OldClass: ... +``` + +`/typeshed/stdlib/new_module.pyi`: + +```pyi +class NewClass: ... +``` + +`/typeshed/stdlib/VERSIONS`: + +```text +old_module: 3.0- +new_module: 3.11- +``` + +```py +from old_module import OldClass + +# error: [unresolved-import] "Cannot resolve imported module `new_module`" +from new_module import NewClass +``` + +## Using `reveal_type` with a custom typeshed + +When providing a custom typeshed directory, basic things like `reveal_type` will stop working +because we rely on being able to import it from `typing_extensions`. The actual definition of +`reveal_type` in typeshed is slightly involved (depends on generics, `TypeVar`, etc.), but a very +simple untyped definition is enough to make `reveal_type` work in tests: + +```toml +[environment] +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/typing_extensions.pyi`: + +```pyi +def reveal_type(obj, /): ... +``` + +```py +reveal_type(()) # revealed: tuple[()] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/metaclass.md b/crates/ty_python_semantic/resources/mdtest/metaclass.md new file mode 100644 index 0000000000000..3c4762fe8fefe --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/metaclass.md @@ -0,0 +1,271 @@ +## Default + +```py +class M(type): ... + +reveal_type(M.__class__) # revealed: <class 'type'> +``` + +## `object` + +```py +reveal_type(object.__class__) # revealed: <class 'type'> +``` + +## `type` + +```py +reveal_type(type.__class__) # revealed: <class 'type'> +``` + +## Basic + +```py +class M(type): ... +class B(metaclass=M): ... + +reveal_type(B.__class__) # revealed: <class 'M'> +``` + +## Invalid metaclass + +A class which doesn't inherit `type` (and/or doesn't implement a custom `__new__` accepting the same +arguments as `type.__new__`) isn't a valid metaclass. + +```py +class M: ... +class A(metaclass=M): ... + +# TODO: emit a diagnostic for the invalid metaclass +reveal_type(A.__class__) # revealed: <class 'M'> +``` + +## Linear inheritance + +If a class is a subclass of a class with a custom metaclass, then the subclass will also have that +metaclass. + +```py +class M(type): ... +class A(metaclass=M): ... +class B(A): ... + +reveal_type(B.__class__) # revealed: <class 'M'> +``` + +## Linear inheritance with PEP 695 generic class + +The same is true if the base with the metaclass is a generic class. + +```toml +[environment] +python-version = "3.13" +``` + +```py +class M(type): ... +class A[T](metaclass=M): ... +class B(A): ... +class C(A[int]): ... + +reveal_type(B.__class__) # revealed: <class 'M'> +reveal_type(C.__class__) # revealed: <class 'M'> +``` + +## Conflict (1) + +The metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its +bases. ("Strict subclass" is a synonym for "proper subclass"; a non-strict subclass can be a +subclass or the class itself.) + +```py +class M1(type): ... +class M2(type): ... +class A(metaclass=M1): ... +class B(metaclass=M2): ... + +# error: [conflicting-metaclass] "The metaclass of a derived class (`C`) must be a subclass of the metaclasses of all its bases, but `M1` (metaclass of base class `A`) and `M2` (metaclass of base class `B`) have no subclass relationship" +class C(A, B): ... + +reveal_type(C.__class__) # revealed: type[Unknown] +``` + +## Conflict (2) + +The metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its +bases. ("Strict subclass" is a synonym for "proper subclass"; a non-strict subclass can be a +subclass or the class itself.) + +```py +class M1(type): ... +class M2(type): ... +class A(metaclass=M1): ... + +# error: [conflicting-metaclass] "The metaclass of a derived class (`B`) must be a subclass of the metaclasses of all its bases, but `M2` (metaclass of `B`) and `M1` (metaclass of base class `A`) have no subclass relationship" +class B(A, metaclass=M2): ... + +reveal_type(B.__class__) # revealed: type[Unknown] +``` + +## Common metaclass + +A class has two explicit bases, both of which have the same metaclass. + +```py +class M(type): ... +class A(metaclass=M): ... +class B(metaclass=M): ... +class C(A, B): ... + +reveal_type(C.__class__) # revealed: <class 'M'> +``` + +## Metaclass metaclass + +A class has an explicit base with a custom metaclass. That metaclass itself has a custom metaclass. + +```py +class M1(type): ... +class M2(type, metaclass=M1): ... +class M3(M2): ... +class A(metaclass=M3): ... +class B(A): ... + +reveal_type(A.__class__) # revealed: <class 'M3'> +``` + +## Diamond inheritance + +```py +class M(type): ... +class M1(M): ... +class M2(M): ... +class M12(M1, M2): ... +class A(metaclass=M1): ... +class B(metaclass=M2): ... +class C(metaclass=M12): ... + +# error: [conflicting-metaclass] "The metaclass of a derived class (`D`) must be a subclass of the metaclasses of all its bases, but `M1` (metaclass of base class `A`) and `M2` (metaclass of base class `B`) have no subclass relationship" +class D(A, B, C): ... + +reveal_type(D.__class__) # revealed: type[Unknown] +``` + +## Unknown + +```py +from nonexistent_module import UnknownClass # error: [unresolved-import] + +class C(UnknownClass): ... + +# TODO: should be `type[type] & Unknown` +reveal_type(C.__class__) # revealed: <class 'type'> + +class M(type): ... +class A(metaclass=M): ... +class B(A, UnknownClass): ... + +# TODO: should be `type[M] & Unknown` +reveal_type(B.__class__) # revealed: <class 'M'> +``` + +## Duplicate + +```py +class M(type): ... +class A(metaclass=M): ... +class B(A, A): ... # error: [duplicate-base] "Duplicate base class `A`" + +reveal_type(B.__class__) # revealed: <class 'M'> +``` + +## Non-class + +When a class has an explicit `metaclass` that is not a class, but is a callable that accepts +`type.__new__` arguments, we should return the meta-type of its return type. + +```py +def f(*args, **kwargs) -> int: + return 1 + +class A(metaclass=f): ... + +# TODO: Should be `int` +reveal_type(A) # revealed: <class 'A'> +reveal_type(A.__class__) # revealed: type[int] + +def _(n: int): + # error: [invalid-metaclass] + class B(metaclass=n): ... + # TODO: Should be `Unknown` + reveal_type(B) # revealed: <class 'B'> + reveal_type(B.__class__) # revealed: type[Unknown] + +def _(flag: bool): + m = f if flag else 42 + + # error: [invalid-metaclass] + class C(metaclass=m): ... + # TODO: Should be `int | Unknown` + reveal_type(C) # revealed: <class 'C'> + reveal_type(C.__class__) # revealed: type[Unknown] + +class SignatureMismatch: ... + +# TODO: Emit a diagnostic +class D(metaclass=SignatureMismatch): ... + +# TODO: Should be `Unknown` +reveal_type(D) # revealed: <class 'D'> +# TODO: Should be `type[Unknown]` +reveal_type(D.__class__) # revealed: <class 'SignatureMismatch'> +``` + +## Cyclic + +Retrieving the metaclass of a cyclically defined class should not cause an infinite loop. + +```pyi +class A(B): ... # error: [cyclic-class-definition] +class B(C): ... # error: [cyclic-class-definition] +class C(A): ... # error: [cyclic-class-definition] + +reveal_type(A.__class__) # revealed: type[Unknown] +``` + +## PEP 695 generic + +```toml +[environment] +python-version = "3.12" +``` + +```py +class M(type): ... +class A[T: str](metaclass=M): ... + +reveal_type(A.__class__) # revealed: <class 'M'> +``` + +## Metaclasses of metaclasses + +```py +class Foo(type): ... +class Bar(type, metaclass=Foo): ... +class Baz(type, metaclass=Bar): ... +class Spam(metaclass=Baz): ... + +reveal_type(Spam.__class__) # revealed: <class 'Baz'> +reveal_type(Spam.__class__.__class__) # revealed: <class 'Bar'> +reveal_type(Spam.__class__.__class__.__class__) # revealed: <class 'Foo'> + +def test(x: Spam): + reveal_type(x.__class__) # revealed: type[Spam] + reveal_type(x.__class__.__class__) # revealed: type[Baz] + reveal_type(x.__class__.__class__.__class__) # revealed: type[Bar] + reveal_type(x.__class__.__class__.__class__.__class__) # revealed: type[Foo] + reveal_type(x.__class__.__class__.__class__.__class__.__class__) # revealed: type[type] + + # revealed: type[type] + reveal_type(x.__class__.__class__.__class__.__class__.__class__.__class__.__class__.__class__) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/mro.md b/crates/ty_python_semantic/resources/mdtest/mro.md new file mode 100644 index 0000000000000..810e716688dfc --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/mro.md @@ -0,0 +1,618 @@ +# Method Resolution Order tests + +Tests that assert that we can infer the correct type for a class's `__mro__` attribute. + +This attribute is rarely accessed directly at runtime. However, it's extremely important for *us* to +know the precise possible values of a class's Method Resolution Order, or we won't be able to infer +the correct type of attributes accessed from instances. + +For documentation on method resolution orders, see: + +- <https://docs.python.org/3/glossary.html#term-method-resolution-order> +- <https://docs.python.org/3/howto/mro.html#python-2-3-mro> + +## No bases + +```py +class C: ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'object'>] +``` + +## The special case: `object` itself + +```py +reveal_type(object.__mro__) # revealed: tuple[<class 'object'>] +``` + +## Explicit inheritance from `object` + +```py +class C(object): ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'object'>] +``` + +## Explicit inheritance from non-`object` single base + +```py +class A: ... +class B(A): ... + +reveal_type(B.__mro__) # revealed: tuple[<class 'B'>, <class 'A'>, <class 'object'>] +``` + +## Linearization of multiple bases + +```py +class A: ... +class B: ... +class C(A, B): ... + +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'A'>, <class 'B'>, <class 'object'>] +``` + +## Complex diamond inheritance (1) + +This is "ex_2" from <https://docs.python.org/3/howto/mro.html#the-end> + +```py +class O: ... +class X(O): ... +class Y(O): ... +class A(X, Y): ... +class B(Y, X): ... + +reveal_type(A.__mro__) # revealed: tuple[<class 'A'>, <class 'X'>, <class 'Y'>, <class 'O'>, <class 'object'>] +reveal_type(B.__mro__) # revealed: tuple[<class 'B'>, <class 'Y'>, <class 'X'>, <class 'O'>, <class 'object'>] +``` + +## Complex diamond inheritance (2) + +This is "ex_5" from <https://docs.python.org/3/howto/mro.html#the-end> + +```py +class O: ... +class F(O): ... +class E(O): ... +class D(O): ... +class C(D, F): ... +class B(D, E): ... +class A(B, C): ... + +# revealed: tuple[<class 'C'>, <class 'D'>, <class 'F'>, <class 'O'>, <class 'object'>] +reveal_type(C.__mro__) +# revealed: tuple[<class 'B'>, <class 'D'>, <class 'E'>, <class 'O'>, <class 'object'>] +reveal_type(B.__mro__) +# revealed: tuple[<class 'A'>, <class 'B'>, <class 'C'>, <class 'D'>, <class 'E'>, <class 'F'>, <class 'O'>, <class 'object'>] +reveal_type(A.__mro__) +``` + +## Complex diamond inheritance (3) + +This is "ex_6" from <https://docs.python.org/3/howto/mro.html#the-end> + +```py +class O: ... +class F(O): ... +class E(O): ... +class D(O): ... +class C(D, F): ... +class B(E, D): ... +class A(B, C): ... + +# revealed: tuple[<class 'C'>, <class 'D'>, <class 'F'>, <class 'O'>, <class 'object'>] +reveal_type(C.__mro__) +# revealed: tuple[<class 'B'>, <class 'E'>, <class 'D'>, <class 'O'>, <class 'object'>] +reveal_type(B.__mro__) +# revealed: tuple[<class 'A'>, <class 'B'>, <class 'E'>, <class 'C'>, <class 'D'>, <class 'F'>, <class 'O'>, <class 'object'>] +reveal_type(A.__mro__) +``` + +## Complex diamond inheritance (4) + +This is "ex_9" from <https://docs.python.org/3/howto/mro.html#the-end> + +```py +class O: ... +class A(O): ... +class B(O): ... +class C(O): ... +class D(O): ... +class E(O): ... +class K1(A, B, C): ... +class K2(D, B, E): ... +class K3(D, A): ... +class Z(K1, K2, K3): ... + +# revealed: tuple[<class 'K1'>, <class 'A'>, <class 'B'>, <class 'C'>, <class 'O'>, <class 'object'>] +reveal_type(K1.__mro__) +# revealed: tuple[<class 'K2'>, <class 'D'>, <class 'B'>, <class 'E'>, <class 'O'>, <class 'object'>] +reveal_type(K2.__mro__) +# revealed: tuple[<class 'K3'>, <class 'D'>, <class 'A'>, <class 'O'>, <class 'object'>] +reveal_type(K3.__mro__) +# revealed: tuple[<class 'Z'>, <class 'K1'>, <class 'K2'>, <class 'K3'>, <class 'D'>, <class 'A'>, <class 'B'>, <class 'C'>, <class 'E'>, <class 'O'>, <class 'object'>] +reveal_type(Z.__mro__) +``` + +## Inheritance from `Unknown` + +```py +from does_not_exist import DoesNotExist # error: [unresolved-import] + +class A(DoesNotExist): ... +class B: ... +class C: ... +class D(A, B, C): ... +class E(B, C): ... +class F(E, A): ... + +reveal_type(A.__mro__) # revealed: tuple[<class 'A'>, Unknown, <class 'object'>] +reveal_type(D.__mro__) # revealed: tuple[<class 'D'>, <class 'A'>, Unknown, <class 'B'>, <class 'C'>, <class 'object'>] +reveal_type(E.__mro__) # revealed: tuple[<class 'E'>, <class 'B'>, <class 'C'>, <class 'object'>] +# revealed: tuple[<class 'F'>, <class 'E'>, <class 'B'>, <class 'C'>, <class 'A'>, Unknown, <class 'object'>] +reveal_type(F.__mro__) +``` + +## Inheritance with intersections that include `Unknown` + +An intersection that includes `Unknown` or `Any` is permitted as long as the intersection is not +disjoint from `type`. + +```py +from does_not_exist import DoesNotExist # error: [unresolved-import] + +reveal_type(DoesNotExist) # revealed: Unknown + +if hasattr(DoesNotExist, "__mro__"): + reveal_type(DoesNotExist) # revealed: Unknown & <Protocol with members '__mro__'> + + class Foo(DoesNotExist): ... # no error! + reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + +if not isinstance(DoesNotExist, type): + reveal_type(DoesNotExist) # revealed: Unknown & ~type + + class Foo(DoesNotExist): ... # error: [unsupported-base] + reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +## Inheritance from `type[Any]` and `type[Unknown]` + +Inheritance from `type[Any]` and `type[Unknown]` is also permitted, in keeping with the gradual +guarantee: + +```py +from typing import Any +from ty_extensions import Unknown, Intersection + +def f(x: type[Any], y: Intersection[Unknown, type[Any]]): + class Foo(x): ... + reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Any, <class 'object'>] + + class Bar(y): ... + reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, Unknown, <class 'object'>] +``` + +## `__bases__` lists that cause errors at runtime + +If the class's `__bases__` cause an exception to be raised at runtime and therefore the class +creation to fail, we infer the class's `__mro__` as being `[<class>, Unknown, object]`: + +```py +# error: [inconsistent-mro] "Cannot create a consistent method resolution order (MRO) for class `Foo` with bases list `[<class 'object'>, <class 'int'>]`" +class Foo(object, int): ... + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + +class Bar(Foo): ... + +reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, <class 'Foo'>, Unknown, <class 'object'>] + +# This is the `TypeError` at the bottom of "ex_2" +# in the examples at <https://docs.python.org/3/howto/mro.html#the-end> +class O: ... +class X(O): ... +class Y(O): ... +class A(X, Y): ... +class B(Y, X): ... + +reveal_type(A.__mro__) # revealed: tuple[<class 'A'>, <class 'X'>, <class 'Y'>, <class 'O'>, <class 'object'>] +reveal_type(B.__mro__) # revealed: tuple[<class 'B'>, <class 'Y'>, <class 'X'>, <class 'O'>, <class 'object'>] + +# error: [inconsistent-mro] "Cannot create a consistent method resolution order (MRO) for class `Z` with bases list `[<class 'A'>, <class 'B'>]`" +class Z(A, B): ... + +reveal_type(Z.__mro__) # revealed: tuple[<class 'Z'>, Unknown, <class 'object'>] + +class AA(Z): ... + +reveal_type(AA.__mro__) # revealed: tuple[<class 'AA'>, <class 'Z'>, Unknown, <class 'object'>] +``` + +## `__bases__` includes a `Union` + +<!-- snapshot-diagnostics --> + +We don't support union types in a class's bases; a base must resolve to a single `ClassType`. If we +find a union type in a class's bases, we infer the class's `__mro__` as being +`[<class>, Unknown, object]`, the same as for MROs that cause errors at runtime. + +```py +from typing_extensions import reveal_type + +def returns_bool() -> bool: + return True + +class A: ... +class B: ... + +if returns_bool(): + x = A +else: + x = B + +reveal_type(x) # revealed: <class 'A'> | <class 'B'> + +# error: 11 [unsupported-base] "Unsupported class base with type `<class 'A'> | <class 'B'>`" +class Foo(x): ... + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +## `__bases__` is a union of a dynamic type and valid bases + +If a dynamic type such as `Any` or `Unknown` is one of the elements in the union, and all other +types *would be* valid class bases, we do not emit an `invalid-base` or `unsupported-base` +diagnostic, and we use the dynamic type as a base to prevent further downstream errors. + +```py +from typing import Any + +def _(flag: bool, any: Any): + if flag: + Base = any + else: + class Base: ... + + class Foo(Base): ... + reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Any, <class 'object'>] +``` + +## `__bases__` includes multiple `Union`s + +```py +def returns_bool() -> bool: + return True + +class A: ... +class B: ... +class C: ... +class D: ... + +if returns_bool(): + x = A +else: + x = B + +if returns_bool(): + y = C +else: + y = D + +reveal_type(x) # revealed: <class 'A'> | <class 'B'> +reveal_type(y) # revealed: <class 'C'> | <class 'D'> + +# error: 11 [unsupported-base] "Unsupported class base with type `<class 'A'> | <class 'B'>`" +# error: 14 [unsupported-base] "Unsupported class base with type `<class 'C'> | <class 'D'>`" +class Foo(x, y): ... + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +## `__bases__` lists that cause errors... now with `Union`s + +```py +def returns_bool() -> bool: + return True + +class O: ... +class X(O): ... +class Y(O): ... + +if returns_bool(): + foo = Y +else: + foo = object + +# error: 21 [unsupported-base] "Unsupported class base with type `<class 'Y'> | <class 'object'>`" +class PossibleError(foo, X): ... + +reveal_type(PossibleError.__mro__) # revealed: tuple[<class 'PossibleError'>, Unknown, <class 'object'>] + +class A(X, Y): ... + +reveal_type(A.__mro__) # revealed: tuple[<class 'A'>, <class 'X'>, <class 'Y'>, <class 'O'>, <class 'object'>] + +if returns_bool(): + class B(X, Y): ... + +else: + class B(Y, X): ... + +# revealed: tuple[<class 'B'>, <class 'X'>, <class 'Y'>, <class 'O'>, <class 'object'>] | tuple[<class 'B'>, <class 'Y'>, <class 'X'>, <class 'O'>, <class 'object'>] +reveal_type(B.__mro__) + +# error: 12 [unsupported-base] "Unsupported class base with type `<class 'B'> | <class 'B'>`" +class Z(A, B): ... + +reveal_type(Z.__mro__) # revealed: tuple[<class 'Z'>, Unknown, <class 'object'>] +``` + +## `__bases__` lists that include objects that are not instances of `type` + +<!-- snapshot-diagnostics --> + +```py +class Foo(2): ... # error: [invalid-base] +``` + +A base that is not an instance of `type` but does have an `__mro_entries__` method will not raise an +exception at runtime, so we issue `unsupported-base` rather than `invalid-base`: + +```py +class Foo: + def __mro_entries__(self, bases: tuple[type, ...]) -> tuple[type, ...]: + return () + +class Bar(Foo()): ... # error: [unsupported-base] +``` + +But for objects that have badly defined `__mro_entries__`, `invalid-base` is emitted rather than +`unsupported-base`: + +```py +class Bad1: + def __mro_entries__(self, bases, extra_arg): + return () + +class Bad2: + def __mro_entries__(self, bases) -> int: + return 42 + +class BadSub1(Bad1()): ... # error: [invalid-base] +class BadSub2(Bad2()): ... # error: [invalid-base] +``` + +## `__bases__` lists with duplicate bases + +<!-- snapshot-diagnostics --> + +```py +from typing_extensions import reveal_type + +class Foo(str, str): ... # error: [duplicate-base] "Duplicate base class `str`" + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + +class Spam: ... +class Eggs: ... +class Bar: ... +class Baz: ... + +# fmt: off + +# error: [duplicate-base] "Duplicate base class `Spam`" +# error: [duplicate-base] "Duplicate base class `Eggs`" +class Ham( + Spam, + Eggs, + Bar, + Baz, + Spam, + Eggs, +): ... + +# fmt: on + +reveal_type(Ham.__mro__) # revealed: tuple[<class 'Ham'>, Unknown, <class 'object'>] + +class Mushrooms: ... +class Omelette(Spam, Eggs, Mushrooms, Mushrooms): ... # error: [duplicate-base] + +reveal_type(Omelette.__mro__) # revealed: tuple[<class 'Omelette'>, Unknown, <class 'object'>] + +# fmt: off + +# error: [duplicate-base] "Duplicate base class `Eggs`" +class VeryEggyOmelette( + Eggs, + Ham, + Spam, + Eggs, + Mushrooms, + Bar, + Eggs, + Baz, + Eggs, +): ... + +# fmt: off +``` + +A `type: ignore` comment can suppress `duplicate-bases` errors if it is on the first or last line of +the class "header": + +```py +# fmt: off + +class A: ... + +class B( # type: ignore[duplicate-base] + A, + A, +): ... + +class C( + A, + A +): # type: ignore[duplicate-base] + x: int + +# fmt: on +``` + +But it will not suppress the error if it occurs in the class body, or on the duplicate base itself. +The justification for this is that it is the class definition as a whole that will raise an +exception at runtime, not a sub-expression in the class's bases list. + +```py +# fmt: off + +# error: [duplicate-base] +class D( + A, + # error: [unused-ignore-comment] + A, # type: ignore[duplicate-base] +): ... + +# error: [duplicate-base] +class E( + A, + A +): + # error: [unused-ignore-comment] + x: int # type: ignore[duplicate-base] + +# fmt: on +``` + +## `__bases__` lists with duplicate `Unknown` bases + +We do not emit errors on classes where multiple bases are inferred as `Unknown`, `Todo` or `Any`. +Usually having duplicate bases in a bases list like this would cause us to emit a diagnostic; +however, for gradual types this would break the +[gradual guarantee](https://typing.python.org/en/latest/spec/concepts.html#the-gradual-guarantee): +the dynamic base can usually be materialised to a type that would lead to a resolvable MRO. + +```py +from unresolvable_module import UnknownBase1, UnknownBase2 # error: [unresolved-import] + +reveal_type(UnknownBase1) # revealed: Unknown +reveal_type(UnknownBase2) # revealed: Unknown + +# no error here -- we respect the gradual guarantee: +class Foo(UnknownBase1, UnknownBase2): ... + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +However, if there are duplicate class elements, we do emit an error, even if there are also multiple +dynamic members. The following class definition will definitely fail, no matter what the dynamic +bases materialize to: + +```py +# error: [duplicate-base] "Duplicate base class `Foo`" +class Bar(UnknownBase1, Foo, UnknownBase2, Foo): ... + +reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, Unknown, <class 'object'>] +``` + +## Unrelated objects inferred as `Any`/`Unknown` do not have special `__mro__` attributes + +```py +from does_not_exist import unknown_object # error: [unresolved-import] + +reveal_type(unknown_object) # revealed: Unknown +reveal_type(unknown_object.__mro__) # revealed: Unknown +``` + +## Classes that inherit from themselves + +These are invalid, but we need to be able to handle them gracefully without panicking. + +```pyi +class Foo(Foo): ... # error: [cyclic-class-definition] + +reveal_type(Foo) # revealed: <class 'Foo'> +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + +class Bar: ... +class Baz: ... +class Boz(Bar, Baz, Boz): ... # error: [cyclic-class-definition] + +reveal_type(Boz) # revealed: <class 'Boz'> +reveal_type(Boz.__mro__) # revealed: tuple[<class 'Boz'>, Unknown, <class 'object'>] +``` + +## Classes with indirect cycles in their MROs + +These are similarly unlikely, but we still shouldn't crash: + +```pyi +class Foo(Bar): ... # error: [cyclic-class-definition] +class Bar(Baz): ... # error: [cyclic-class-definition] +class Baz(Foo): ... # error: [cyclic-class-definition] + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, Unknown, <class 'object'>] +reveal_type(Baz.__mro__) # revealed: tuple[<class 'Baz'>, Unknown, <class 'object'>] +``` + +## Classes with cycles in their MROs, and multiple inheritance + +```pyi +class Spam: ... +class Foo(Bar): ... # error: [cyclic-class-definition] +class Bar(Baz): ... # error: [cyclic-class-definition] +class Baz(Foo, Spam): ... # error: [cyclic-class-definition] + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, Unknown, <class 'object'>] +reveal_type(Baz.__mro__) # revealed: tuple[<class 'Baz'>, Unknown, <class 'object'>] +``` + +## Classes with cycles in their MRO, and a sub-graph + +```pyi +class FooCycle(BarCycle): ... # error: [cyclic-class-definition] +class Foo: ... +class BarCycle(FooCycle): ... # error: [cyclic-class-definition] +class Bar(Foo): ... + +# Avoid emitting the errors for these. The classes have cyclic superclasses, +# but are not themselves cyclic... +class Baz(Bar, BarCycle): ... +class Spam(Baz): ... + +reveal_type(FooCycle.__mro__) # revealed: tuple[<class 'FooCycle'>, Unknown, <class 'object'>] +reveal_type(BarCycle.__mro__) # revealed: tuple[<class 'BarCycle'>, Unknown, <class 'object'>] +reveal_type(Baz.__mro__) # revealed: tuple[<class 'Baz'>, Unknown, <class 'object'>] +reveal_type(Spam.__mro__) # revealed: tuple[<class 'Spam'>, Unknown, <class 'object'>] +``` + +## Other classes with possible cycles + +```toml +[environment] +python-version = "3.13" +``` + +```pyi +class C(C.a): ... +reveal_type(C.__class__) # revealed: <class 'type'> +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, Unknown, <class 'object'>] + +class D(D.a): + a: D +#reveal_type(D.__class__) # revealed: <class 'type'> +reveal_type(D.__mro__) # revealed: tuple[<class 'D'>, Unknown, <class 'object'>] + +class E[T](E.a): ... +#reveal_type(E.__class__) # revealed: <class 'type'> +reveal_type(E.__mro__) # revealed: tuple[<class 'E[Unknown]'>, Unknown, <class 'object'>] + +class F[T](F(), F): ... # error: [cyclic-class-definition] +#reveal_type(F.__class__) # revealed: <class 'type'> +reveal_type(F.__mro__) # revealed: tuple[<class 'F[Unknown]'>, Unknown, <class 'object'>] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/named_tuple.md b/crates/ty_python_semantic/resources/mdtest/named_tuple.md new file mode 100644 index 0000000000000..8c5a79d62f909 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/named_tuple.md @@ -0,0 +1,195 @@ +# `NamedTuple` + +`NamedTuple` is a type-safe way to define named tuples — a tuple where each field can be accessed by +name, and not just by its numeric position within the tuple: + +## `typing.NamedTuple` + +### Basics + +```py +from typing import NamedTuple + +class Person(NamedTuple): + id: int + name: str + age: int | None = None + +alice = Person(1, "Alice", 42) +alice = Person(id=1, name="Alice", age=42) +bob = Person(2, "Bob") +bob = Person(id=2, name="Bob") + +reveal_type(alice.id) # revealed: int +reveal_type(alice.name) # revealed: str +reveal_type(alice.age) # revealed: int | None + +# TODO: These should reveal the types of the fields +reveal_type(alice[0]) # revealed: Unknown +reveal_type(alice[1]) # revealed: Unknown +reveal_type(alice[2]) # revealed: Unknown + +# error: [missing-argument] +Person(3) + +# error: [too-many-positional-arguments] +Person(3, "Eve", 99, "extra") + +# error: [invalid-argument-type] +Person(id="3", name="Eve") + +# TODO: over-writing NamedTuple fields should be an error +alice.id = 42 +bob.age = None +``` + +Alternative functional syntax: + +```py +Person2 = NamedTuple("Person", [("id", int), ("name", str)]) +alice2 = Person2(1, "Alice") + +# TODO: should be an error +Person2(1) + +reveal_type(alice2.id) # revealed: @Todo(functional `NamedTuple` syntax) +reveal_type(alice2.name) # revealed: @Todo(functional `NamedTuple` syntax) +``` + +### Definition + +TODO: Fields without default values should come before fields with. + +```py +from typing import NamedTuple + +class Location(NamedTuple): + altitude: float = 0.0 + latitude: float # this should be an error + longitude: float +``` + +### Multiple Inheritance + +Multiple inheritance is not supported for `NamedTuple` classes: + +```py +from typing import NamedTuple + +# This should ideally emit a diagnostic +class C(NamedTuple, object): + id: int + name: str +``` + +### Inheriting from a `NamedTuple` + +Inheriting from a `NamedTuple` is supported, but new fields on the subclass will not be part of the +synthesized `__new__` signature: + +```py +from typing import NamedTuple + +class User(NamedTuple): + id: int + name: str + +class SuperUser(User): + level: int + +# This is fine: +alice = SuperUser(1, "Alice") +reveal_type(alice.level) # revealed: int + +# This is an error because `level` is not part of the signature: +# error: [too-many-positional-arguments] +alice = SuperUser(1, "Alice", 3) +``` + +TODO: If any fields added by the subclass conflict with those in the base class, that should be +flagged. + +```py +from typing import NamedTuple + +class User(NamedTuple): + id: int + name: str + +class SuperUser(User): + id: int # this should be an error +``` + +### Generic named tuples + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing import NamedTuple + +class Property[T](NamedTuple): + name: str + value: T + +# TODO: this should be supported (no error, revealed type of `Property[float]`) +# error: [invalid-argument-type] +reveal_type(Property("height", 3.4)) # revealed: Property[Unknown] +``` + +## Attributes on `NamedTuple` + +The following attributes are available on `NamedTuple` classes / instances: + +```py +from typing import NamedTuple + +class Person(NamedTuple): + name: str + age: int | None = None + +reveal_type(Person._field_defaults) # revealed: dict[str, Any] +reveal_type(Person._fields) # revealed: tuple[str, ...] +reveal_type(Person._make) # revealed: bound method <class 'Person'>._make(iterable: Iterable[Any]) -> Self +reveal_type(Person._asdict) # revealed: def _asdict(self) -> dict[str, Any] +reveal_type(Person._replace) # revealed: def _replace(self, **kwargs: Any) -> Self + +# TODO: should be `Person` once we support `Self` +reveal_type(Person._make(("Alice", 42))) # revealed: Unknown + +person = Person("Alice", 42) + +reveal_type(person._asdict()) # revealed: dict[str, Any] +# TODO: should be `Person` once we support `Self` +reveal_type(person._replace(name="Bob")) # revealed: Unknown +``` + +## `collections.namedtuple` + +```py +from collections import namedtuple + +Person = namedtuple("Person", ["id", "name", "age"], defaults=[None]) + +alice = Person(1, "Alice", 42) +bob = Person(2, "Bob") +``` + +## NamedTuple with custom `__getattr__` + +This is a regression test for <https://github.com/astral-sh/ty/issues/322>. Make sure that the +`__getattr__` method does not interfere with the `NamedTuple` behavior. + +```py +from typing import NamedTuple + +class Vec2(NamedTuple): + x: float = 0.0 + y: float = 0.0 + + def __getattr__(self, attrs: str): ... + +Vec2(0.0, 0.0) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/assert.md b/crates/ty_python_semantic/resources/mdtest/narrow/assert.md new file mode 100644 index 0000000000000..0fab83880ee9f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/assert.md @@ -0,0 +1,114 @@ +# Narrowing with assert statements + +## `assert` a value `is None` or `is not None` + +```py +def _(x: str | None, y: str | None): + assert x is not None + reveal_type(x) # revealed: str + assert y is None + reveal_type(y) # revealed: None +``` + +## `assert` a value is truthy or falsy + +```py +def _(x: bool, y: bool): + assert x + reveal_type(x) # revealed: Literal[True] + assert not y + reveal_type(y) # revealed: Literal[False] +``` + +## `assert` with `is` and `==` for literals + +```py +from typing import Literal + +def _(x: Literal[1, 2, 3], y: Literal[1, 2, 3]): + assert x is 2 + reveal_type(x) # revealed: Literal[2] + assert y == 2 + reveal_type(y) # revealed: Literal[2] +``` + +## `assert` with `isinstance` + +```py +def _(x: int | str): + assert isinstance(x, int) + reveal_type(x) # revealed: int +``` + +## `assert` a value `in` a tuple + +```py +from typing import Literal + +def _(x: Literal[1, 2, 3], y: Literal[1, 2, 3]): + assert x in (1, 2) + reveal_type(x) # revealed: Literal[1, 2] + assert y not in (1, 2) + reveal_type(y) # revealed: Literal[3] +``` + +## Assertions with messages + +```py +def _(x: int | None, y: int | None): + reveal_type(x) # revealed: int | None + assert x is None, reveal_type(x) # revealed: int + reveal_type(x) # revealed: None + + reveal_type(y) # revealed: int | None + assert isinstance(y, int), reveal_type(y) # revealed: None + reveal_type(y) # revealed: int +``` + +## Assertions with definitions inside the message + +```py +def one(x: int | None): + assert x is None, (y := x * 42) * reveal_type(y) # revealed: int + + # error: [unresolved-reference] + reveal_type(y) # revealed: Unknown + +def two(x: int | None, y: int | None): + assert x is None, (y := 42) * reveal_type(y) # revealed: Literal[42] + reveal_type(y) # revealed: int | None +``` + +## Assertions with `test` predicates that are statically known to always be `True` + +```py +assert True, (x := 1) + +# error: [unresolved-reference] +reveal_type(x) # revealed: Unknown + +assert False, (y := 1) + +# The `assert` statement is terminal if `test` resolves to `False`, +# so even though we know the `msg` branch will have been taken here +# (we know what the truthiness of `False is!), we also know that the +# `y` definition is not visible from this point in control flow +# (because this point in control flow is unreachable). +# We make sure that this does not emit an `[unresolved-reference]` +# diagnostic by adding a reachability constraint, +# but the inferred type is `Unknown`. +# +reveal_type(y) # revealed: Unknown +``` + +## Assertions with messages that reference definitions from the `test` + +```py +def one(x: int | None): + assert (y := x), reveal_type(y) # revealed: (int & ~AlwaysTruthy) | None + reveal_type(y) # revealed: int & ~AlwaysFalsy + +def two(x: int | None): + assert isinstance((y := x), int), reveal_type(y) # revealed: None + reveal_type(y) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/bool-call.md b/crates/ty_python_semantic/resources/mdtest/narrow/bool-call.md new file mode 100644 index 0000000000000..bf2886135431a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/bool-call.md @@ -0,0 +1,34 @@ +## Narrowing for `bool(..)` checks + +```py +def _(flag: bool): + + x = 1 if flag else None + + # valid invocation, positive + reveal_type(x) # revealed: Literal[1] | None + if bool(x is not None): + reveal_type(x) # revealed: Literal[1] + + # valid invocation, negative + reveal_type(x) # revealed: Literal[1] | None + if not bool(x is not None): + reveal_type(x) # revealed: None + + # no args/narrowing + reveal_type(x) # revealed: Literal[1] | None + if not bool(): + reveal_type(x) # revealed: Literal[1] | None + + # invalid invocation, too many positional args + reveal_type(x) # revealed: Literal[1] | None + # error: [too-many-positional-arguments] "Too many positional arguments to class `bool`: expected 1, got 2" + if bool(x is not None, 5): + reveal_type(x) # revealed: Literal[1] | None + + # invalid invocation, too many kwargs + reveal_type(x) # revealed: Literal[1] | None + # error: [unknown-argument] "Argument `y` does not match any known parameter of class `bool`" + if bool(x is not None, y=5): + reveal_type(x) # revealed: Literal[1] | None +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/boolean.md b/crates/ty_python_semantic/resources/mdtest/narrow/boolean.md new file mode 100644 index 0000000000000..17f4454ff2173 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/boolean.md @@ -0,0 +1,79 @@ +# Narrowing in boolean expressions + +In `or` expressions, the right-hand side is evaluated only if the left-hand side is **falsy**. So +when the right-hand side is evaluated, we know the left side has failed. + +Similarly, in `and` expressions, the right-hand side is evaluated only if the left-hand side is +**truthy**. So when the right-hand side is evaluated, we know the left side has succeeded. + +## Narrowing in `or` + +```py +def _(flag: bool): + class A: ... + x: A | None = A() if flag else None + + isinstance(x, A) or reveal_type(x) # revealed: None + x is None or reveal_type(x) # revealed: A + reveal_type(x) # revealed: A | None +``` + +## Narrowing in `and` + +```py +def _(flag: bool): + class A: ... + x: A | None = A() if flag else None + + isinstance(x, A) and reveal_type(x) # revealed: A + x is None and reveal_type(x) # revealed: None + reveal_type(x) # revealed: A | None +``` + +## Multiple `and` arms + +```py +def _(flag1: bool, flag2: bool, flag3: bool, flag4: bool): + class A: ... + x: A | None = A() if flag1 else None + + flag2 and isinstance(x, A) and reveal_type(x) # revealed: A + isinstance(x, A) and flag2 and reveal_type(x) # revealed: A + reveal_type(x) and isinstance(x, A) and flag3 # revealed: A | None +``` + +## Multiple `or` arms + +```py +def _(flag1: bool, flag2: bool, flag3: bool, flag4: bool): + class A: ... + x: A | None = A() if flag1 else None + + flag2 or isinstance(x, A) or reveal_type(x) # revealed: None + isinstance(x, A) or flag3 or reveal_type(x) # revealed: None + reveal_type(x) or isinstance(x, A) or flag4 # revealed: A | None +``` + +## Multiple predicates + +```py +from typing import Literal + +def _(flag1: bool, flag2: bool): + class A: ... + x: A | None | Literal[1] = A() if flag1 else None if flag2 else 1 + + x is None or isinstance(x, A) or reveal_type(x) # revealed: Literal[1] +``` + +## Mix of `and` and `or` + +```py +from typing import Literal + +def _(flag1: bool, flag2: bool): + class A: ... + x: A | None | Literal[1] = A() if flag1 else None if flag2 else 1 + + isinstance(x, A) or x is not None and reveal_type(x) # revealed: Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/boolean.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/boolean.md new file mode 100644 index 0000000000000..8b9394a380522 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/boolean.md @@ -0,0 +1,237 @@ +# Narrowing for conditionals with boolean expressions + +## Narrowing in `and` conditional + +```py +class A: ... +class B: ... + +def _(x: A | B): + if isinstance(x, A) and isinstance(x, B): + reveal_type(x) # revealed: A & B + else: + reveal_type(x) # revealed: (B & ~A) | (A & ~B) +``` + +## Arms might not add narrowing constraints + +```py +class A: ... +class B: ... + +def _(flag: bool, x: A | B): + if isinstance(x, A) and flag: + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: A | B + + if flag and isinstance(x, A): + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: A | B + + reveal_type(x) # revealed: A | B +``` + +## Statically known arms + +```py +class A: ... +class B: ... + +def _(x: A | B): + if isinstance(x, A) and True: + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: B & ~A + + if True and isinstance(x, A): + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: B & ~A + + if False and isinstance(x, A): + # TODO: should emit an `unreachable code` diagnostic + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: A | B + + if False or isinstance(x, A): + reveal_type(x) # revealed: A + else: + reveal_type(x) # revealed: B & ~A + + if True or isinstance(x, A): + reveal_type(x) # revealed: A | B + else: + # TODO: should emit an `unreachable code` diagnostic + reveal_type(x) # revealed: B & ~A + + reveal_type(x) # revealed: A | B +``` + +## The type of multiple symbols can be narrowed down + +```py +class A: ... +class B: ... + +def _(x: A | B, y: A | B): + if isinstance(x, A) and isinstance(y, B): + reveal_type(x) # revealed: A + reveal_type(y) # revealed: B + else: + # No narrowing: Only-one or both checks might have failed + reveal_type(x) # revealed: A | B + reveal_type(y) # revealed: A | B + + reveal_type(x) # revealed: A | B + reveal_type(y) # revealed: A | B +``` + +## Narrowing in `or` conditional + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C): + if isinstance(x, A) or isinstance(x, B): + reveal_type(x) # revealed: A | B + else: + reveal_type(x) # revealed: C & ~A & ~B +``` + +## In `or`, all arms should add constraint in order to narrow + +```py +class A: ... +class B: ... +class C: ... + +def _(flag: bool, x: A | B | C): + if isinstance(x, A) or isinstance(x, B) or flag: + reveal_type(x) # revealed: A | B | C + else: + reveal_type(x) # revealed: C & ~A & ~B +``` + +## in `or`, all arms should narrow the same set of symbols + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C, y: A | B | C): + if isinstance(x, A) or isinstance(y, A): + # The predicate might be satisfied by the right side, so the type of `x` can’t be narrowed down here. + reveal_type(x) # revealed: A | B | C + # The same for `y` + reveal_type(y) # revealed: A | B | C + else: + reveal_type(x) # revealed: (B & ~A) | (C & ~A) + reveal_type(y) # revealed: (B & ~A) | (C & ~A) + + if (isinstance(x, A) and isinstance(y, A)) or (isinstance(x, B) and isinstance(y, B)): + # Here, types of `x` and `y` can be narrowd since all `or` arms constraint them. + reveal_type(x) # revealed: A | B + reveal_type(y) # revealed: A | B + else: + reveal_type(x) # revealed: A | B | C + reveal_type(y) # revealed: A | B | C +``` + +## mixing `and` and `not` + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C): + if isinstance(x, B) and not isinstance(x, C): + reveal_type(x) # revealed: B & ~C + else: + # ~(B & ~C) -> ~B | C -> (A & ~B) | (C & ~B) | C -> (A & ~B) | C + reveal_type(x) # revealed: (A & ~B) | C +``` + +## mixing `or` and `not` + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C): + if isinstance(x, B) or not isinstance(x, C): + reveal_type(x) # revealed: B | (A & ~C) + else: + reveal_type(x) # revealed: C & ~B +``` + +## `or` with nested `and` + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C): + if isinstance(x, A) or (isinstance(x, B) and not isinstance(x, C)): + reveal_type(x) # revealed: A | (B & ~C) + else: + # ~(A | (B & ~C)) -> ~A & ~(B & ~C) -> ~A & (~B | C) -> (~A & C) | (~A ~ B) + reveal_type(x) # revealed: C & ~A +``` + +## `and` with nested `or` + +```py +class A: ... +class B: ... +class C: ... + +def _(x: A | B | C): + if isinstance(x, A) and (isinstance(x, B) or not isinstance(x, C)): + # A & (B | ~C) -> (A & B) | (A & ~C) + reveal_type(x) # revealed: (A & B) | (A & ~C) + else: + # ~((A & B) | (A & ~C)) -> + # ~(A & B) & ~(A & ~C) -> + # (~A | ~B) & (~A | C) -> + # [(~A | ~B) & ~A] | [(~A | ~B) & C] -> + # ~A | (~A & C) | (~B & C) -> + # ~A | (C & ~B) -> + # ~A | (C & ~B) The positive side of ~A is A | B | C -> + reveal_type(x) # revealed: (B & ~A) | (C & ~A) | (C & ~B) +``` + +## Boolean expression internal narrowing + +```py +def _(x: str | None, y: str | None): + if x is None and y is not x: + reveal_type(y) # revealed: str + + # Neither of the conditions alone is sufficient for narrowing y's type: + if x is None: + reveal_type(y) # revealed: str | None + + if y is not x: + reveal_type(y) # revealed: str | None +``` + +## Assignment expressions + +```py +def f() -> bool: + return True + +if x := f(): + reveal_type(x) # revealed: Literal[True] +else: + reveal_type(x) # revealed: Literal[False] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/elif_else.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/elif_else.md new file mode 100644 index 0000000000000..bfa741428bb8f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/elif_else.md @@ -0,0 +1,57 @@ +# Narrowing for conditionals with elif and else + +## Positive contributions become negative in elif-else blocks + +```py +def _(x: int): + if x == 1: + # cannot narrow; could be a subclass of `int` + reveal_type(x) # revealed: int + elif x == 2: + reveal_type(x) # revealed: int & ~Literal[1] + elif x != 3: + reveal_type(x) # revealed: int & ~Literal[1] & ~Literal[2] & ~Literal[3] +``` + +## Positive contributions become negative in elif-else blocks, with simplification + +```py +def _(flag1: bool, flag2: bool): + x = 1 if flag1 else 2 if flag2 else 3 + + if x == 1: + reveal_type(x) # revealed: Literal[1] + elif x == 2: + reveal_type(x) # revealed: Literal[2] + else: + reveal_type(x) # revealed: Literal[3] +``` + +## Multiple negative contributions using elif, with simplification + +```py +def _(flag1: bool, flag2: bool): + x = 1 if flag1 else 2 if flag2 else 3 + + if x != 1: + reveal_type(x) # revealed: Literal[2, 3] + elif x != 2: + reveal_type(x) # revealed: Literal[1] + elif x == 3: + reveal_type(x) # revealed: Never + else: + reveal_type(x) # revealed: Never +``` + +## Assignment expressions + +```py +def f() -> int | str | None: ... + +if isinstance(x := f(), int): + reveal_type(x) # revealed: int +elif isinstance(x, str): + reveal_type(x) # revealed: str & ~int +else: + reveal_type(x) # revealed: None +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/eq.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/eq.md new file mode 100644 index 0000000000000..4ba04803c6347 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/eq.md @@ -0,0 +1,157 @@ +# Narrowing for `!=` conditionals + +## `x != None` + +```py +def _(flag: bool): + x = None if flag else 1 + + if x != None: + reveal_type(x) # revealed: Literal[1] + else: + reveal_type(x) # revealed: None +``` + +## `!=` for other singleton types + +```py +def _(flag: bool): + x = True if flag else False + + if x != False: + reveal_type(x) # revealed: Literal[True] + else: + reveal_type(x) # revealed: Literal[False] +``` + +## `x != y` where `y` is of literal type + +```py +def _(flag: bool): + x = 1 if flag else 2 + + if x != 1: + reveal_type(x) # revealed: Literal[2] +``` + +## `x != y` where `y` is a single-valued type + +```py +def _(flag: bool): + class A: ... + class B: ... + C = A if flag else B + + if C != A: + reveal_type(C) # revealed: <class 'B'> + else: + reveal_type(C) # revealed: <class 'A'> +``` + +## `x != y` where `y` has multiple single-valued options + +```py +def _(flag1: bool, flag2: bool): + x = 1 if flag1 else 2 + y = 2 if flag2 else 3 + + if x != y: + reveal_type(x) # revealed: Literal[1, 2] + else: + reveal_type(x) # revealed: Literal[2] +``` + +## `!=` for non-single-valued types + +Only single-valued types should narrow the type: + +```py +def _(flag: bool, a: int, y: int): + x = a if flag else None + + if x != y: + reveal_type(x) # revealed: int | None +``` + +## Mix of single-valued and non-single-valued types + +```py +def _(flag1: bool, flag2: bool, a: int): + x = 1 if flag1 else 2 + y = 2 if flag2 else a + + if x != y: + reveal_type(x) # revealed: Literal[1, 2] + else: + reveal_type(x) # revealed: Literal[1, 2] +``` + +## Assignment expressions + +```py +from typing import Literal + +def f() -> Literal[1, 2, 3]: + return 1 + +if (x := f()) != 1: + reveal_type(x) # revealed: Literal[2, 3] +else: + reveal_type(x) # revealed: Literal[1] +``` + +## Union with `Any` + +```py +from typing import Any + +def _(x: Any | None, y: Any | None): + if x != 1: + reveal_type(x) # revealed: (Any & ~Literal[1]) | None + if y == 1: + reveal_type(y) # revealed: Any & ~None +``` + +## Booleans and integers + +```py +from typing import Literal + +def _(b: bool, i: Literal[1, 2]): + if b == 1: + reveal_type(b) # revealed: Literal[True] + else: + reveal_type(b) # revealed: Literal[False] + + if b == 6: + reveal_type(b) # revealed: Never + else: + reveal_type(b) # revealed: bool + + if b == 0: + reveal_type(b) # revealed: Literal[False] + else: + reveal_type(b) # revealed: Literal[True] + + if i == True: + reveal_type(i) # revealed: Literal[1] + else: + reveal_type(i) # revealed: Literal[2] +``` + +## Narrowing `LiteralString` in union + +```py +from typing_extensions import Literal, LiteralString, Any + +def _(s: LiteralString | None, t: LiteralString | Any): + if s == "foo": + reveal_type(s) # revealed: Literal["foo"] + + if s == 1: + reveal_type(s) # revealed: Never + + if t == "foo": + # TODO could be `Literal["foo"] | Any` + reveal_type(t) # revealed: LiteralString | Any +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/in.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/in.md new file mode 100644 index 0000000000000..865eb48788c01 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/in.md @@ -0,0 +1,94 @@ +# Narrowing for `in` conditionals + +## `in` for tuples + +```py +def _(x: int): + if x in (1, 2, 3): + reveal_type(x) # revealed: int + else: + reveal_type(x) # revealed: int +``` + +```py +def _(x: str): + if x in ("a", "b", "c"): + reveal_type(x) # revealed: str + else: + reveal_type(x) # revealed: str +``` + +```py +from typing import Literal + +def _(x: Literal[1, 2, "a", "b", False, b"abc"]): + if x in (1,): + reveal_type(x) # revealed: Literal[1] + elif x in (2, "a"): + reveal_type(x) # revealed: Literal[2, "a"] + elif x in (b"abc",): + reveal_type(x) # revealed: Literal[b"abc"] + elif x not in (3,): + reveal_type(x) # revealed: Literal["b", False] + else: + reveal_type(x) # revealed: Never +``` + +```py +def _(x: Literal["a", "b", "c", 1]): + if x in ("a", "b", "c", 2): + reveal_type(x) # revealed: Literal["a", "b", "c"] + else: + reveal_type(x) # revealed: Literal[1] +``` + +## `in` for `str` and literal strings + +```py +def _(x: str): + if x in "abc": + reveal_type(x) # revealed: str + else: + reveal_type(x) # revealed: str +``` + +```py +from typing import Literal + +def _(x: Literal["a", "b", "c", "d"]): + if x in "abc": + reveal_type(x) # revealed: Literal["a", "b", "c"] + else: + reveal_type(x) # revealed: Literal["d"] +``` + +```py +def _(x: Literal["a", "b", "c", "e"]): + if x in "abcd": + reveal_type(x) # revealed: Literal["a", "b", "c"] + else: + reveal_type(x) # revealed: Literal["e"] +``` + +```py +def _(x: Literal[1, "a", "b", "c", "d"]): + # error: [unsupported-operator] + if x in "abc": + reveal_type(x) # revealed: Literal["a", "b", "c"] + else: + reveal_type(x) # revealed: Literal[1, "d"] +``` + +## Assignment expressions + +```py +from typing import Literal + +def f() -> Literal[1, 2, 3]: + return 1 + +if (x := f()) in (1,): + reveal_type(x) # revealed: Literal[1] +else: + reveal_type(x) # revealed: Literal[2, 3] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is.md new file mode 100644 index 0000000000000..c7d99c48b2e4f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is.md @@ -0,0 +1,115 @@ +# Narrowing for `is` conditionals + +## `is None` + +```py +def _(flag: bool): + x = None if flag else 1 + + if x is None: + reveal_type(x) # revealed: None + else: + reveal_type(x) # revealed: Literal[1] + + reveal_type(x) # revealed: None | Literal[1] +``` + +## `is` for other types + +```py +def _(flag: bool): + class A: ... + x = A() + y = x if flag else None + + if y is x: + reveal_type(y) # revealed: A + else: + reveal_type(y) # revealed: A | None + + reveal_type(y) # revealed: A | None +``` + +## `is` in chained comparisons + +```py +def _(x_flag: bool, y_flag: bool): + x = True if x_flag else False + y = True if y_flag else False + + reveal_type(x) # revealed: bool + reveal_type(y) # revealed: bool + + if y is x is False: # Interpreted as `(y is x) and (x is False)` + reveal_type(x) # revealed: Literal[False] + reveal_type(y) # revealed: bool + else: + # The negation of the clause above is (y is not x) or (x is not False) + # So we can't narrow the type of x or y here, because each arm of the `or` could be true + reveal_type(x) # revealed: bool + reveal_type(y) # revealed: bool +``` + +## `is` in elif clause + +```py +def _(flag1: bool, flag2: bool): + x = None if flag1 else (1 if flag2 else True) + + reveal_type(x) # revealed: None | Literal[1, True] + if x is None: + reveal_type(x) # revealed: None + elif x is True: + reveal_type(x) # revealed: Literal[True] + else: + reveal_type(x) # revealed: Literal[1] +``` + +## `is` for `EllipsisType` (Python 3.10+) + +```toml +[environment] +python-version = "3.10" +``` + +```py +from types import EllipsisType + +def _(x: int | EllipsisType): + if x is ...: + reveal_type(x) # revealed: EllipsisType + else: + reveal_type(x) # revealed: int +``` + +## `is` for `EllipsisType` (Python 3.9 and below) + +```toml +[environment] +python-version = "3.9" +``` + +```py +def _(flag: bool): + x = ... if flag else 42 + + reveal_type(x) # revealed: ellipsis | Literal[42] + + if x is ...: + reveal_type(x) # revealed: ellipsis + else: + reveal_type(x) # revealed: Literal[42] +``` + +## Assignment expressions + +```py +from typing import Literal + +def f() -> Literal[1, 2] | None: ... + +if (x := f()) is None: + reveal_type(x) # revealed: None +else: + reveal_type(x) # revealed: Literal[1, 2] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is_not.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is_not.md new file mode 100644 index 0000000000000..fba62e921323b --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/is_not.md @@ -0,0 +1,95 @@ +# Narrowing for `is not` conditionals + +## `is not None` + +The type guard removes `None` from the union type: + +```py +def _(flag: bool): + x = None if flag else 1 + + if x is not None: + reveal_type(x) # revealed: Literal[1] + else: + reveal_type(x) # revealed: None + + reveal_type(x) # revealed: None | Literal[1] +``` + +## `is not` for other singleton types + +```py +def _(flag: bool): + x = True if flag else False + reveal_type(x) # revealed: bool + + if x is not False: + reveal_type(x) # revealed: Literal[True] + else: + reveal_type(x) # revealed: Literal[False] +``` + +## `is not` for non-singleton types + +Non-singleton types should *not* narrow the type: two instances of a non-singleton class may occupy +different addresses in memory even if they compare equal. + +```py +x = 345 +y = 345 + +if x is not y: + reveal_type(x) # revealed: Literal[345] +else: + reveal_type(x) # revealed: Literal[345] +``` + +## `is not` for other types + +```py +def _(flag: bool): + class A: ... + x = A() + y = x if flag else None + + if y is not x: + reveal_type(y) # revealed: A | None + else: + reveal_type(y) # revealed: A + + reveal_type(y) # revealed: A | None +``` + +## `is not` in chained comparisons + +The type guard removes `False` from the union type of the tested value only. + +```py +def _(x_flag: bool, y_flag: bool): + x = True if x_flag else False + y = True if y_flag else False + + reveal_type(x) # revealed: bool + reveal_type(y) # revealed: bool + + if y is not x is not False: # Interpreted as `(y is not x) and (x is not False)` + reveal_type(x) # revealed: Literal[True] + reveal_type(y) # revealed: bool + else: + # The negation of the clause above is (y is x) or (x is False) + # So we can't narrow the type of x or y here, because each arm of the `or` could be true + + reveal_type(x) # revealed: bool + reveal_type(y) # revealed: bool +``` + +## Assignment expressions + +```py +def f() -> int | str | None: ... + +if (x := f()) is not None: + reveal_type(x) # revealed: int | str +else: + reveal_type(x) # revealed: None +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/nested.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/nested.md new file mode 100644 index 0000000000000..6b001ea09411a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/nested.md @@ -0,0 +1,176 @@ +# Narrowing for nested conditionals + +## Multiple negative contributions + +```py +def _(x: int): + if x != 1: + if x != 2: + if x != 3: + reveal_type(x) # revealed: int & ~Literal[1] & ~Literal[2] & ~Literal[3] +``` + +## Multiple negative contributions with simplification + +```py +def _(flag1: bool, flag2: bool): + x = 1 if flag1 else 2 if flag2 else 3 + + if x != 1: + reveal_type(x) # revealed: Literal[2, 3] + if x != 2: + reveal_type(x) # revealed: Literal[3] +``` + +## elif-else blocks + +```py +def _(flag1: bool, flag2: bool): + x = 1 if flag1 else 2 if flag2 else 3 + + if x != 1: + reveal_type(x) # revealed: Literal[2, 3] + if x == 2: + reveal_type(x) # revealed: Literal[2] + elif x == 3: + reveal_type(x) # revealed: Literal[3] + else: + reveal_type(x) # revealed: Never + + elif x != 2: + reveal_type(x) # revealed: Literal[1] + else: + reveal_type(x) # revealed: Never +``` + +## Cross-scope narrowing + +Narrowing constraints are also valid in eager nested scopes (however, because class variables are +not visible from nested scopes, constraints on those variables are invalid). + +Currently they are assumed to be invalid in lazy nested scopes since there is a possibility that the +constraints may no longer be valid due to a "time lag". However, it may be possible to determine +that some of them are valid by performing a more detailed analysis (e.g. checking that the narrowing +target has not changed in all places where the function is called). + +### Narrowing constraints introduced in eager nested scopes + +```py +g: str | None = "a" + +def f(x: str | None): + def _(): + if x is not None: + reveal_type(x) # revealed: str + + if not isinstance(x, str): + reveal_type(x) # revealed: None + + if g is not None: + reveal_type(g) # revealed: str + + class C: + if x is not None: + reveal_type(x) # revealed: str + + if not isinstance(x, str): + reveal_type(x) # revealed: None + + if g is not None: + reveal_type(g) # revealed: str + + # TODO: should be str + # This could be fixed if we supported narrowing with if clauses in comprehensions. + [reveal_type(x) for _ in range(1) if x is not None] # revealed: str | None +``` + +### Narrowing constraints introduced in the outer scope + +```py +g: str | None = "a" + +def f(x: str | None): + if x is not None: + def _(): + # If there is a possibility that `x` may be rewritten after this function definition, + # the constraint `x is not None` outside the function is no longer be applicable for narrowing. + reveal_type(x) # revealed: str | None + + class C: + reveal_type(x) # revealed: str + + [reveal_type(x) for _ in range(1)] # revealed: str + + if g is not None: + def _(): + reveal_type(g) # revealed: str | None + + class D: + reveal_type(g) # revealed: str + + [reveal_type(g) for _ in range(1)] # revealed: str +``` + +### Narrowing constraints introduced in multiple scopes + +```py +from typing import Literal + +g: str | Literal[1] | None = "a" + +def f(x: str | Literal[1] | None): + class C: + if x is not None: + def _(): + if x != 1: + reveal_type(x) # revealed: str | None + + class D: + if x != 1: + reveal_type(x) # revealed: str + + # TODO: should be str + [reveal_type(x) for _ in range(1) if x != 1] # revealed: str | Literal[1] + + if g is not None: + def _(): + if g != 1: + reveal_type(g) # revealed: str | None + + class D: + if g != 1: + reveal_type(g) # revealed: str +``` + +### Narrowing constraints with bindings in class scope, and nested scopes + +```py +from typing import Literal + +g: str | Literal[1] | None = "a" + +def f(flag: bool): + class C: + (g := None) if flag else (g := None) + # `g` is always bound here, so narrowing checks don't apply to nested scopes + if g is not None: + class F: + reveal_type(g) # revealed: str | Literal[1] | None + + class C: + # this conditional binding leaves "unbound" visible, so following narrowing checks apply + None if flag else (g := None) + + if g is not None: + class F: + reveal_type(g) # revealed: str | Literal[1] + + # This class variable is not visible from the nested class scope. + g = None + + # This additional constraint is not relevant to nested scopes, since it only applies to + # a binding of `g` that they cannot see: + if g is None: + class E: + reveal_type(g) # revealed: str | Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/not.md b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/not.md new file mode 100644 index 0000000000000..c0a305d1eaf22 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/conditionals/not.md @@ -0,0 +1,29 @@ +# Narrowing for `not` conditionals + +The `not` operator negates a constraint. + +## `not is None` + +```py +def _(flag: bool): + x = None if flag else 1 + + if not x is None: + reveal_type(x) # revealed: Literal[1] + else: + reveal_type(x) # revealed: None + + reveal_type(x) # revealed: None | Literal[1] +``` + +## `not isinstance` + +```py +def _(flag: bool): + x = 1 if flag else "a" + + if not isinstance(x, (int)): + reveal_type(x) # revealed: Literal["a"] + else: + reveal_type(x) # revealed: Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/hasattr.md b/crates/ty_python_semantic/resources/mdtest/narrow/hasattr.md new file mode 100644 index 0000000000000..b15891216086f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/hasattr.md @@ -0,0 +1,38 @@ +# Narrowing using `hasattr()` + +The builtin function `hasattr()` can be used to narrow nominal and structural types. This is +accomplished using an intersection with a synthesized protocol: + +```py +from typing import final + +class Foo: ... + +@final +class Bar: ... + +def f(x: Foo): + if hasattr(x, "spam"): + reveal_type(x) # revealed: Foo & <Protocol with members 'spam'> + reveal_type(x.spam) # revealed: object + else: + reveal_type(x) # revealed: Foo & ~<Protocol with members 'spam'> + + # TODO: should error and reveal `Unknown` + reveal_type(x.spam) # revealed: @Todo(map_with_boundness: intersections with negative contributions) + + if hasattr(x, "not-an-identifier"): + reveal_type(x) # revealed: Foo + else: + reveal_type(x) # revealed: Foo + +def y(x: Bar): + if hasattr(x, "spam"): + reveal_type(x) # revealed: Never + reveal_type(x.spam) # revealed: Never + else: + reveal_type(x) # revealed: Bar + + # error: [unresolved-attribute] + reveal_type(x.spam) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/isinstance.md b/crates/ty_python_semantic/resources/mdtest/narrow/isinstance.md new file mode 100644 index 0000000000000..6eb475715a485 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/isinstance.md @@ -0,0 +1,213 @@ +# Narrowing for `isinstance` checks + +Narrowing for `isinstance(object, classinfo)` expressions. + +## `classinfo` is a single type + +```py +def _(flag: bool): + x = 1 if flag else "a" + + if isinstance(x, int): + reveal_type(x) # revealed: Literal[1] + + if isinstance(x, str): + reveal_type(x) # revealed: Literal["a"] + if isinstance(x, int): + reveal_type(x) # revealed: Never + + if isinstance(x, (int, object)): + reveal_type(x) # revealed: Literal[1, "a"] +``` + +## `classinfo` is a tuple of types + +Note: `isinstance(x, (int, str))` should not be confused with `isinstance(x, tuple[(int, str)])`. +The former is equivalent to `isinstance(x, int | str)`: + +```py +def _(flag: bool, flag1: bool, flag2: bool): + x = 1 if flag else "a" + + if isinstance(x, (int, str)): + reveal_type(x) # revealed: Literal[1, "a"] + else: + reveal_type(x) # revealed: Never + + if isinstance(x, (int, bytes)): + reveal_type(x) # revealed: Literal[1] + + if isinstance(x, (bytes, str)): + reveal_type(x) # revealed: Literal["a"] + + # No narrowing should occur if a larger type is also + # one of the possibilities: + if isinstance(x, (int, object)): + reveal_type(x) # revealed: Literal[1, "a"] + else: + reveal_type(x) # revealed: Never + + y = 1 if flag1 else "a" if flag2 else b"b" + if isinstance(y, (int, str)): + reveal_type(y) # revealed: Literal[1, "a"] + + if isinstance(y, (int, bytes)): + reveal_type(y) # revealed: Literal[1, b"b"] + + if isinstance(y, (str, bytes)): + reveal_type(y) # revealed: Literal["a", b"b"] +``` + +## `classinfo` is a nested tuple of types + +```py +def _(flag: bool): + x = 1 if flag else "a" + + if isinstance(x, (bool, (bytes, int))): + reveal_type(x) # revealed: Literal[1] + else: + reveal_type(x) # revealed: Literal["a"] +``` + +## Class types + +```py +class A: ... +class B: ... +class C: ... + +x = object() + +if isinstance(x, A): + reveal_type(x) # revealed: A + if isinstance(x, B): + reveal_type(x) # revealed: A & B + else: + reveal_type(x) # revealed: A & ~B + +if isinstance(x, (A, B)): + reveal_type(x) # revealed: A | B +elif isinstance(x, (A, C)): + reveal_type(x) # revealed: C & ~A & ~B +else: + reveal_type(x) # revealed: ~A & ~B & ~C +``` + +## No narrowing for instances of `builtins.type` + +```py +def _(flag: bool, t: type): + x = 1 if flag else "foo" + + if isinstance(x, t): + reveal_type(x) # revealed: Literal[1, "foo"] +``` + +## Do not use custom `isinstance` for narrowing + +```py +def _(flag: bool): + def isinstance(x, t): + return True + x = 1 if flag else "a" + + if isinstance(x, int): + reveal_type(x) # revealed: Literal[1, "a"] +``` + +## Do support narrowing if `isinstance` is aliased + +```py +def _(flag: bool): + isinstance_alias = isinstance + + x = 1 if flag else "a" + + if isinstance_alias(x, int): + reveal_type(x) # revealed: Literal[1] +``` + +## Do support narrowing if `isinstance` is imported + +```py +from builtins import isinstance as imported_isinstance + +def _(flag: bool): + x = 1 if flag else "a" + + if imported_isinstance(x, int): + reveal_type(x) # revealed: Literal[1] +``` + +## Do not narrow if second argument is not a type + +```py +def _(flag: bool): + x = 1 if flag else "a" + + # TODO: this should cause us to emit a diagnostic during + # type checking + if isinstance(x, "a"): + reveal_type(x) # revealed: Literal[1, "a"] + + # TODO: this should cause us to emit a diagnostic during + # type checking + if isinstance(x, "int"): + reveal_type(x) # revealed: Literal[1, "a"] +``` + +## Do not narrow if there are keyword arguments + +```py +def _(flag: bool): + x = 1 if flag else "a" + + # error: [unknown-argument] + if isinstance(x, int, foo="bar"): + reveal_type(x) # revealed: Literal[1, "a"] +``` + +## `type[]` types are narrowed as well as class-literal types + +```py +def _(x: object, y: type[int]): + if isinstance(x, y): + reveal_type(x) # revealed: int +``` + +## Adding a disjoint element to an existing intersection + +We used to incorrectly infer `Literal` booleans for some of these. + +```py +from ty_extensions import Not, Intersection, AlwaysTruthy, AlwaysFalsy + +class P: ... + +def f( + a: Intersection[P, AlwaysTruthy], + b: Intersection[P, AlwaysFalsy], + c: Intersection[P, Not[AlwaysTruthy]], + d: Intersection[P, Not[AlwaysFalsy]], +): + if isinstance(a, bool): + reveal_type(a) # revealed: Never + else: + reveal_type(a) # revealed: P & AlwaysTruthy + + if isinstance(b, bool): + reveal_type(b) # revealed: Never + else: + reveal_type(b) # revealed: P & AlwaysFalsy + + if isinstance(c, bool): + reveal_type(c) # revealed: Never + else: + reveal_type(c) # revealed: P & ~AlwaysTruthy + + if isinstance(d, bool): + reveal_type(d) # revealed: Never + else: + reveal_type(d) # revealed: P & ~AlwaysFalsy +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/issubclass.md b/crates/ty_python_semantic/resources/mdtest/narrow/issubclass.md new file mode 100644 index 0000000000000..6f8d8e82a9f3f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/issubclass.md @@ -0,0 +1,280 @@ +# Narrowing for `issubclass` checks + +Narrowing for `issubclass(class, classinfo)` expressions. + +## `classinfo` is a single type + +### Basic example + +```py +def _(flag: bool): + t = int if flag else str + + if issubclass(t, bytes): + reveal_type(t) # revealed: Never + + if issubclass(t, object): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> + + if issubclass(t, int): + reveal_type(t) # revealed: <class 'int'> + else: + reveal_type(t) # revealed: <class 'str'> + + if issubclass(t, str): + reveal_type(t) # revealed: <class 'str'> + if issubclass(t, int): + reveal_type(t) # revealed: Never +``` + +### Proper narrowing in `elif` and `else` branches + +```py +def _(flag1: bool, flag2: bool): + t = int if flag1 else str if flag2 else bytes + + if issubclass(t, int): + reveal_type(t) # revealed: <class 'int'> + else: + reveal_type(t) # revealed: <class 'str'> | <class 'bytes'> + + if issubclass(t, int): + reveal_type(t) # revealed: <class 'int'> + elif issubclass(t, str): + reveal_type(t) # revealed: <class 'str'> + else: + reveal_type(t) # revealed: <class 'bytes'> +``` + +### Multiple derived classes + +```py +class Base: ... +class Derived1(Base): ... +class Derived2(Base): ... +class Unrelated: ... + +def _(flag1: bool, flag2: bool, flag3: bool): + t1 = Derived1 if flag1 else Derived2 + + if issubclass(t1, Base): + reveal_type(t1) # revealed: <class 'Derived1'> | <class 'Derived2'> + + if issubclass(t1, Derived1): + reveal_type(t1) # revealed: <class 'Derived1'> + else: + reveal_type(t1) # revealed: <class 'Derived2'> + + t2 = Derived1 if flag2 else Base + + if issubclass(t2, Base): + reveal_type(t2) # revealed: <class 'Derived1'> | <class 'Base'> + + t3 = Derived1 if flag3 else Unrelated + + if issubclass(t3, Base): + reveal_type(t3) # revealed: <class 'Derived1'> + else: + reveal_type(t3) # revealed: <class 'Unrelated'> +``` + +### Narrowing for non-literals + +```py +class A: ... +class B: ... + +def _(t: type[object]): + if issubclass(t, A): + reveal_type(t) # revealed: type[A] + if issubclass(t, B): + reveal_type(t) # revealed: type[A] & type[B] + else: + reveal_type(t) # revealed: type & ~type[A] +``` + +### Handling of `None` + +`types.NoneType` is only available in Python 3.10 and later: + +```toml +[environment] +python-version = "3.10" +``` + +```py +from types import NoneType + +def _(flag: bool): + t = int if flag else NoneType + + if issubclass(t, NoneType): + reveal_type(t) # revealed: <class 'NoneType'> + + if issubclass(t, type(None)): + reveal_type(t) # revealed: <class 'NoneType'> +``` + +## `classinfo` contains multiple types + +### (Nested) tuples of types + +```py +class Unrelated: ... + +def _(flag1: bool, flag2: bool): + t = int if flag1 else str if flag2 else bytes + + if issubclass(t, (int, (Unrelated, (bytes,)))): + reveal_type(t) # revealed: <class 'int'> | <class 'bytes'> + else: + reveal_type(t) # revealed: <class 'str'> +``` + +## Special cases + +### Emit a diagnostic if the first argument is of wrong type + +#### Too wide + +`type[object]` is a subtype of `object`, but not every `object` can be passed as the first argument +to `issubclass`: + +```py +class A: ... + +t = object() + +# error: [invalid-argument-type] +if issubclass(t, A): + reveal_type(t) # revealed: type[A] +``` + +#### Wrong + +`Literal[1]` and `type` are entirely disjoint, so the inferred type of `Literal[1] & type[int]` is +eagerly simplified to `Never` as a result of the type narrowing in the `if issubclass(t, int)` +branch: + +```py +t = 1 + +# error: [invalid-argument-type] +if issubclass(t, int): + reveal_type(t) # revealed: Never +``` + +### Do not use custom `issubclass` for narrowing + +```py +def issubclass(c, ci): + return True + +def flag() -> bool: + return True + +t = int if flag() else str +if issubclass(t, int): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> +``` + +### Do support narrowing if `issubclass` is aliased + +```py +issubclass_alias = issubclass + +def flag() -> bool: + return True + +t = int if flag() else str +if issubclass_alias(t, int): + reveal_type(t) # revealed: <class 'int'> +``` + +### Do support narrowing if `issubclass` is imported + +```py +from builtins import issubclass as imported_issubclass + +def flag() -> bool: + return True + +t = int if flag() else str +if imported_issubclass(t, int): + reveal_type(t) # revealed: <class 'int'> +``` + +### Do not narrow if second argument is not a proper `classinfo` argument + +```py +from typing import Any + +def flag() -> bool: + return True + +t = int if flag() else str + +# TODO: this should cause us to emit a diagnostic during +# type checking +if issubclass(t, "str"): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> + +# TODO: this should cause us to emit a diagnostic during +# type checking +if issubclass(t, (bytes, "str")): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> + +# TODO: this should cause us to emit a diagnostic during +# type checking +if issubclass(t, Any): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> +``` + +### Do not narrow if there are keyword arguments + +```py +def flag() -> bool: + return True + +t = int if flag() else str + +# error: [unknown-argument] +if issubclass(t, int, foo="bar"): + reveal_type(t) # revealed: <class 'int'> | <class 'str'> +``` + +### `type[]` types are narrowed as well as class-literal types + +```py +def _(x: type, y: type[int]): + if issubclass(x, y): + reveal_type(x) # revealed: type[int] +``` + +### Disjoint `type[]` types are narrowed to `Never` + +Here, `type[UsesMeta1]` and `type[UsesMeta2]` are disjoint because a common subclass of `UsesMeta1` +and `UsesMeta2` could only exist if a common subclass of their metaclasses could exist. This is +known to be impossible due to the fact that `Meta1` is marked as `@final`. + +```py +from typing import final + +@final +class Meta1(type): ... + +class Meta2(type): ... +class UsesMeta1(metaclass=Meta1): ... +class UsesMeta2(metaclass=Meta2): ... + +def _(x: type[UsesMeta1], y: type[UsesMeta2]): + if issubclass(x, y): + reveal_type(x) # revealed: Never + else: + reveal_type(x) # revealed: type[UsesMeta1] + + if issubclass(y, x): + reveal_type(y) # revealed: Never + else: + reveal_type(y) # revealed: type[UsesMeta2] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/match.md b/crates/ty_python_semantic/resources/mdtest/narrow/match.md new file mode 100644 index 0000000000000..a1cd8842f393c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/match.md @@ -0,0 +1,212 @@ +# Narrowing for `match` statements + +```toml +[environment] +python-version = "3.10" +``` + +## Single `match` pattern + +```py +def _(flag: bool): + x = None if flag else 1 + + reveal_type(x) # revealed: None | Literal[1] + + y = 0 + + match x: + case None: + y = x + + reveal_type(y) # revealed: Literal[0] | None +``` + +## Class patterns + +```py +def get_object() -> object: + return object() + +class A: ... +class B: ... + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case A(): + reveal_type(x) # revealed: A + case B(): + reveal_type(x) # revealed: B & ~A + +reveal_type(x) # revealed: object +``` + +## Class pattern with guard + +```py +def get_object() -> object: + return object() + +class A: + def y() -> int: + return 1 + +class B: ... + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case A() if reveal_type(x): # revealed: A + pass + case B() if reveal_type(x): # revealed: B + pass + +reveal_type(x) # revealed: object +``` + +## Value patterns + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case "foo": + reveal_type(x) # revealed: Literal["foo"] + case 42: + reveal_type(x) # revealed: Literal[42] + case 6.0: + reveal_type(x) # revealed: float + case 1j: + reveal_type(x) # revealed: complex & ~float + case b"foo": + reveal_type(x) # revealed: Literal[b"foo"] + +reveal_type(x) # revealed: object +``` + +## Value patterns with guard + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case "foo" if reveal_type(x): # revealed: Literal["foo"] + pass + case 42 if reveal_type(x): # revealed: Literal[42] + pass + case 6.0 if reveal_type(x): # revealed: float + pass + case 1j if reveal_type(x): # revealed: complex + pass + case b"foo" if reveal_type(x): # revealed: Literal[b"foo"] + pass + +reveal_type(x) # revealed: object +``` + +## Or patterns + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case "foo" | 42 | None: + reveal_type(x) # revealed: Literal["foo", 42] | None + case "foo" | tuple(): + reveal_type(x) # revealed: tuple[Unknown, ...] + case True | False: + reveal_type(x) # revealed: bool + case 3.14 | 2.718 | 1.414: + reveal_type(x) # revealed: float & ~tuple[Unknown, ...] + +reveal_type(x) # revealed: object +``` + +## Or patterns with guard + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case "foo" | 42 | None if reveal_type(x): # revealed: Literal["foo", 42] | None + pass + case "foo" | tuple() if reveal_type(x): # revealed: Literal["foo"] | tuple[Unknown, ...] + pass + case True | False if reveal_type(x): # revealed: bool + pass + case 3.14 | 2.718 | 1.414 if reveal_type(x): # revealed: float + pass + +reveal_type(x) # revealed: object +``` + +## Narrowing due to guard + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case str() | float() if type(x) is str: + reveal_type(x) # revealed: str + case "foo" | 42 | None if isinstance(x, int): + reveal_type(x) # revealed: Literal[42] + case False if x: + reveal_type(x) # revealed: Never + case "foo" if x := "bar": + reveal_type(x) # revealed: Literal["bar"] + +reveal_type(x) # revealed: object +``` + +## Guard and reveal_type in guard + +```py +def get_object() -> object: + return object() + +x = get_object() + +reveal_type(x) # revealed: object + +match x: + case str() | float() if type(x) is str and reveal_type(x): # revealed: str + pass + case "foo" | 42 | None if isinstance(x, int) and reveal_type(x): # revealed: Literal[42] + pass + case False if x and reveal_type(x): # revealed: Never + pass + case "foo" if (x := "bar") and reveal_type(x): # revealed: Literal["bar"] + pass + +reveal_type(x) # revealed: object +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/post_if_statement.md b/crates/ty_python_semantic/resources/mdtest/narrow/post_if_statement.md new file mode 100644 index 0000000000000..fbbe5794d8355 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/post_if_statement.md @@ -0,0 +1,51 @@ +# Consolidating narrowed types after if statement + +## After if-else statements, narrowing has no effect if the variable is not mutated in any branch + +```py +def _(x: int | None): + if x is None: + pass + else: + pass + + reveal_type(x) # revealed: int | None +``` + +## Narrowing can have a persistent effect if the variable is mutated in one branch + +```py +def _(x: int | None): + if x is None: + x = 10 + else: + pass + + reveal_type(x) # revealed: int +``` + +## An if statement without an explicit `else` branch is equivalent to one with a no-op `else` branch + +```py +def _(x: int | None, y: int | None): + if x is None: + x = 0 + + if y is None: + pass + + reveal_type(x) # revealed: int + reveal_type(y) # revealed: int | None +``` + +## An if-elif without an explicit else branch is equivalent to one with an empty else branch + +```py +def _(x: int | None): + if x is None: + x = 0 + elif x > 50: + x = 50 + + reveal_type(x) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/truthiness.md b/crates/ty_python_semantic/resources/mdtest/narrow/truthiness.md new file mode 100644 index 0000000000000..b797ee4a16e7e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/truthiness.md @@ -0,0 +1,349 @@ +# Narrowing For Truthiness Checks (`if x` or `if not x`) + +## Value Literals + +```py +from typing import Literal + +def foo() -> Literal[0, -1, True, False, "", "foo", b"", b"bar", None] | tuple[()]: + return 0 + +x = foo() + +if x: + reveal_type(x) # revealed: Literal[-1, True, "foo", b"bar"] +else: + reveal_type(x) # revealed: Literal[0, False, "", b""] | None | tuple[()] + +if not x: + reveal_type(x) # revealed: Literal[0, False, "", b""] | None | tuple[()] +else: + reveal_type(x) # revealed: Literal[-1, True, "foo", b"bar"] + +if x and not x: + reveal_type(x) # revealed: Never +else: + reveal_type(x) # revealed: Literal[0, -1, "", "foo", b"", b"bar"] | bool | None | tuple[()] + +if not (x and not x): + reveal_type(x) # revealed: Literal[0, -1, "", "foo", b"", b"bar"] | bool | None | tuple[()] +else: + reveal_type(x) # revealed: Never + +if x or not x: + reveal_type(x) # revealed: Literal[0, -1, "", "foo", b"", b"bar"] | bool | None | tuple[()] +else: + reveal_type(x) # revealed: Never + +if not (x or not x): + reveal_type(x) # revealed: Never +else: + reveal_type(x) # revealed: Literal[0, -1, "", "foo", b"", b"bar"] | bool | None | tuple[()] + +if (isinstance(x, int) or isinstance(x, str)) and x: + reveal_type(x) # revealed: Literal[-1, True, "foo"] +else: + reveal_type(x) # revealed: Literal[b"", b"bar", 0, False, ""] | None | tuple[()] +``` + +## Function Literals + +Basically functions are always truthy. + +```py +def flag() -> bool: + return True + +def foo(hello: int) -> bytes: + return b"" + +def bar(world: str, *args, **kwargs) -> float: + return 0.0 + +x = foo if flag() else bar + +if x: + reveal_type(x) # revealed: (def foo(hello: int) -> bytes) | (def bar(world: str, *args, **kwargs) -> int | float) +else: + reveal_type(x) # revealed: Never +``` + +## Mutable Truthiness + +### Truthiness of Instances + +The boolean value of an instance is not always consistent. For example, `__bool__` can be customized +to return random values, or in the case of a `list()`, the result depends on the number of elements +in the list. Therefore, these types should not be narrowed by `if x` or `if not x`. + +```py +class A: ... +class B: ... + +def f(x: A | B): + if x: + reveal_type(x) # revealed: (A & ~AlwaysFalsy) | (B & ~AlwaysFalsy) + else: + reveal_type(x) # revealed: (A & ~AlwaysTruthy) | (B & ~AlwaysTruthy) + + if x and not x: + reveal_type(x) # revealed: (A & ~AlwaysFalsy & ~AlwaysTruthy) | (B & ~AlwaysFalsy & ~AlwaysTruthy) + else: + reveal_type(x) # revealed: A | B + + if x or not x: + reveal_type(x) # revealed: A | B + else: + reveal_type(x) # revealed: (A & ~AlwaysTruthy & ~AlwaysFalsy) | (B & ~AlwaysTruthy & ~AlwaysFalsy) +``` + +### Truthiness of Types + +Also, types may not be Truthy. This is because `__bool__` can be customized via a metaclass. +Although this is a very rare case, we may consider metaclass checks in the future to handle this +more accurately. + +```py +def flag() -> bool: + return True + +x = int if flag() else str +reveal_type(x) # revealed: <class 'int'> | <class 'str'> + +if x: + reveal_type(x) # revealed: (<class 'int'> & ~AlwaysFalsy) | (<class 'str'> & ~AlwaysFalsy) +else: + reveal_type(x) # revealed: (<class 'int'> & ~AlwaysTruthy) | (<class 'str'> & ~AlwaysTruthy) +``` + +## Determined Truthiness + +Some custom classes can have a boolean value that is consistently determined as either `True` or +`False`, regardless of the instance's state. This is achieved by defining a `__bool__` method that +always returns a fixed value. + +These types can always be fully narrowed in boolean contexts, as shown below: + +```py +from typing import Literal + +class T: + def __bool__(self) -> Literal[True]: + return True + +class F: + def __bool__(self) -> Literal[False]: + return False + +t = T() + +if t: + reveal_type(t) # revealed: T +else: + reveal_type(t) # revealed: Never + +f = F() + +if f: + reveal_type(f) # revealed: Never +else: + reveal_type(f) # revealed: F +``` + +## Narrowing Complex Intersection and Union + +```py +from typing import Literal + +class A: ... +class B: ... + +def flag() -> bool: + return True + +def instance() -> A | B: + return A() + +def literals() -> Literal[0, 42, "", "hello"]: + return 42 + +x = instance() +y = literals() + +if isinstance(x, str) and not isinstance(x, B): + reveal_type(x) # revealed: A & str & ~B + reveal_type(y) # revealed: Literal[0, 42, "", "hello"] + + z = x if flag() else y + + reveal_type(z) # revealed: (A & str & ~B) | Literal[0, 42, "", "hello"] + + if z: + reveal_type(z) # revealed: (A & str & ~B & ~AlwaysFalsy) | Literal[42, "hello"] + else: + reveal_type(z) # revealed: (A & str & ~B & ~AlwaysTruthy) | Literal[0, ""] +``` + +## Narrowing Multiple Variables + +```py +from typing import Literal + +def f(x: Literal[0, 1], y: Literal["", "hello"]): + if x and y and not x and not y: + reveal_type(x) # revealed: Never + reveal_type(y) # revealed: Never + else: + # ~(x or not x) and ~(y or not y) + reveal_type(x) # revealed: Literal[0, 1] + reveal_type(y) # revealed: Literal["", "hello"] + + if (x or not x) and (y and not y): + reveal_type(x) # revealed: Literal[0, 1] + reveal_type(y) # revealed: Never + else: + # ~(x or not x) or ~(y and not y) + reveal_type(x) # revealed: Literal[0, 1] + reveal_type(y) # revealed: Literal["", "hello"] +``` + +## Control Flow Merging + +After merging control flows, when we take the union of all constraints applied in each branch, we +should return to the original state. + +```py +class A: ... + +x = A() + +if x and not x: + y = x + reveal_type(y) # revealed: A & ~AlwaysFalsy & ~AlwaysTruthy +else: + y = x + reveal_type(y) # revealed: A + +reveal_type(y) # revealed: A +``` + +## Truthiness of classes + +```py +from typing import Literal + +class MetaAmbiguous(type): + def __bool__(self) -> bool: + return True + +class MetaFalsy(type): + def __bool__(self) -> Literal[False]: + return False + +class MetaTruthy(type): + def __bool__(self) -> Literal[True]: + return True + +class MetaDeferred(type): + def __bool__(self) -> MetaAmbiguous: + raise NotImplementedError + +class AmbiguousClass(metaclass=MetaAmbiguous): ... +class FalsyClass(metaclass=MetaFalsy): ... +class TruthyClass(metaclass=MetaTruthy): ... +class DeferredClass(metaclass=MetaDeferred): ... + +def _( + a: type[AmbiguousClass], + t: type[TruthyClass], + f: type[FalsyClass], + d: type[DeferredClass], + ta: type[TruthyClass | AmbiguousClass], + af: type[AmbiguousClass] | type[FalsyClass], + flag: bool, +): + reveal_type(ta) # revealed: type[TruthyClass] | type[AmbiguousClass] + if ta: + reveal_type(ta) # revealed: type[TruthyClass] | (type[AmbiguousClass] & ~AlwaysFalsy) + + reveal_type(af) # revealed: type[AmbiguousClass] | type[FalsyClass] + if af: + reveal_type(af) # revealed: type[AmbiguousClass] & ~AlwaysFalsy + + # error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `MetaDeferred`" + if d: + # TODO: Should be `Unknown` + reveal_type(d) # revealed: type[DeferredClass] & ~AlwaysFalsy + + tf = TruthyClass if flag else FalsyClass + reveal_type(tf) # revealed: <class 'TruthyClass'> | <class 'FalsyClass'> + + if tf: + reveal_type(tf) # revealed: <class 'TruthyClass'> + else: + reveal_type(tf) # revealed: <class 'FalsyClass'> +``` + +## Narrowing in chained boolean expressions + +```py +from typing import Literal + +class A: ... + +def _(x: Literal[0, 1]): + reveal_type(x or A()) # revealed: Literal[1] | A + reveal_type(x and A()) # revealed: Literal[0] | A + +def _(x: str): + reveal_type(x or A()) # revealed: (str & ~AlwaysFalsy) | A + reveal_type(x and A()) # revealed: (str & ~AlwaysTruthy) | A + +def _(x: bool | str): + reveal_type(x or A()) # revealed: Literal[True] | (str & ~AlwaysFalsy) | A + reveal_type(x and A()) # revealed: Literal[False] | (str & ~AlwaysTruthy) | A + +class Falsy: + def __bool__(self) -> Literal[False]: + return False + +class Truthy: + def __bool__(self) -> Literal[True]: + return True + +def _(x: Falsy | Truthy): + reveal_type(x or A()) # revealed: Truthy | A + reveal_type(x and A()) # revealed: Falsy | A + +class MetaFalsy(type): + def __bool__(self) -> Literal[False]: + return False + +class MetaTruthy(type): + def __bool__(self) -> Literal[True]: + return True + +class FalsyClass(metaclass=MetaFalsy): ... +class TruthyClass(metaclass=MetaTruthy): ... + +def _(x: type[FalsyClass] | type[TruthyClass]): + reveal_type(x or A()) # revealed: type[TruthyClass] | A + reveal_type(x and A()) # revealed: type[FalsyClass] | A +``` + +## Truthiness narrowing for `LiteralString` + +```py +from typing_extensions import LiteralString + +def _(x: LiteralString): + if x: + reveal_type(x) # revealed: LiteralString & ~Literal[""] + else: + reveal_type(x) # revealed: Literal[""] + + if not x: + reveal_type(x) # revealed: Literal[""] + else: + reveal_type(x) # revealed: LiteralString & ~Literal[""] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/type.md b/crates/ty_python_semantic/resources/mdtest/narrow/type.md new file mode 100644 index 0000000000000..c5d8bfbe1f943 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/type.md @@ -0,0 +1,156 @@ +# Narrowing for checks involving `type(x)` + +## `type(x) is C` + +```py +class A: ... +class B: ... + +def _(x: A | B): + if type(x) is A: + reveal_type(x) # revealed: A + else: + # It would be wrong to infer `B` here. The type + # of `x` could be a subclass of `A`, so we need + # to infer the full union type: + reveal_type(x) # revealed: A | B +``` + +## `type(x) is not C` + +```py +class A: ... +class B: ... + +def _(x: A | B): + if type(x) is not A: + # Same reasoning as above: no narrowing should occur here. + reveal_type(x) # revealed: A | B + else: + reveal_type(x) # revealed: A +``` + +## `type(x) == C`, `type(x) != C` + +No narrowing can occur for equality comparisons, since there might be a custom `__eq__` +implementation on the metaclass. + +TODO: Narrowing might be possible in some cases where the classes themselves are `@final` or their +metaclass is `@final`. + +```py +class IsEqualToEverything(type): + def __eq__(cls, other): + return True + +class A(metaclass=IsEqualToEverything): ... +class B(metaclass=IsEqualToEverything): ... + +def _(x: A | B): + if type(x) == A: + reveal_type(x) # revealed: A | B + + if type(x) != A: + reveal_type(x) # revealed: A | B +``` + +## No narrowing for custom `type` callable + +```py +class A: ... +class B: ... + +def type(x): + return int + +def _(x: A | B): + if type(x) is A: + reveal_type(x) # revealed: A | B + else: + reveal_type(x) # revealed: A | B +``` + +## No narrowing for multiple arguments + +No narrowing should occur if `type` is used to dynamically create a class: + +```py +def _(x: str | int): + # The following diagnostic is valid, since the three-argument form of `type` + # can only be called with `str` as the first argument. + # error: [no-matching-overload] "No overload of class `type` matches arguments" + if type(x, (), {}) is str: + reveal_type(x) # revealed: str | int + else: + reveal_type(x) # revealed: str | int +``` + +## No narrowing for keyword arguments + +`type` can't be used with a keyword argument: + +```py +def _(x: str | int): + # error: [no-matching-overload] "No overload of class `type` matches arguments" + if type(object=x) is str: + reveal_type(x) # revealed: str | int +``` + +## Narrowing if `type` is aliased + +```py +class A: ... +class B: ... + +def _(x: A | B): + alias_for_type = type + + if alias_for_type(x) is A: + reveal_type(x) # revealed: A +``` + +## Narrowing for generic classes + +```toml +[environment] +python-version = "3.13" +``` + +Note that `type` returns the runtime class of an object, which does _not_ include specializations in +the case of a generic class. (The typevars are erased.) That means we cannot narrow the type to the +specialization that we compare with; we must narrow to an unknown specialization of the generic +class. + +```py +class A[T = int]: ... +class B: ... + +def _[T](x: A | B): + if type(x) is A[str]: + reveal_type(x) # revealed: (A[int] & A[Unknown]) | (B & A[Unknown]) + else: + reveal_type(x) # revealed: A[int] | B +``` + +## Limitations + +```py +class Base: ... +class Derived(Base): ... + +def _(x: Base): + if type(x) is Base: + # Ideally, this could be narrower, but there is now way to + # express a constraint like `Base & ~ProperSubtypeOf[Base]`. + reveal_type(x) # revealed: Base +``` + +## Assignment expressions + +```py +def _(x: object): + if (y := type(x)) is bool: + reveal_type(y) # revealed: <class 'bool'> + if (type(y := x)) is bool: + reveal_type(y) # revealed: bool +``` diff --git a/crates/ty_python_semantic/resources/mdtest/narrow/while.md b/crates/ty_python_semantic/resources/mdtest/narrow/while.md new file mode 100644 index 0000000000000..af8141b6469b9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/narrow/while.md @@ -0,0 +1,61 @@ +# Narrowing in `while` loops + +We only make sure that narrowing works for `while` loops in general, we do not exhaustively test all +narrowing forms here, as they are covered in other tests. + +Note how type narrowing works subtly different from `if` ... `else`, because the negated constraint +is retained after the loop. + +## Basic `while` loop + +```py +def next_item() -> int | None: + return 1 + +x = next_item() + +while x is not None: + reveal_type(x) # revealed: int + x = next_item() + +reveal_type(x) # revealed: None +``` + +## `while` loop with `else` + +```py +def next_item() -> int | None: + return 1 + +x = next_item() + +while x is not None: + reveal_type(x) # revealed: int + x = next_item() +else: + reveal_type(x) # revealed: None + +reveal_type(x) # revealed: None +``` + +## Nested `while` loops + +```py +from typing import Literal + +def next_item() -> Literal[1, 2, 3]: + raise NotImplementedError + +x = next_item() + +while x != 1: + reveal_type(x) # revealed: Literal[2, 3] + + while x != 2: + # TODO: this should be Literal[1, 3]; Literal[3] is only correct + # in the first loop iteration + reveal_type(x) # revealed: Literal[3] + x = next_item() + + x = next_item() +``` diff --git a/crates/ty_python_semantic/resources/mdtest/overloads.md b/crates/ty_python_semantic/resources/mdtest/overloads.md new file mode 100644 index 0000000000000..c26b9cf42b8ec --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/overloads.md @@ -0,0 +1,685 @@ +# Overloads + +Reference: <https://typing.python.org/en/latest/spec/overload.html> + +## `typing.overload` + +The definition of `typing.overload` in typeshed is an identity function. + +```py +from typing import overload + +def foo(x: int) -> int: + return x + +reveal_type(foo) # revealed: def foo(x: int) -> int +bar = overload(foo) +reveal_type(bar) # revealed: def foo(x: int) -> int +``` + +## Functions + +```py +from typing import overload + +@overload +def add() -> None: ... +@overload +def add(x: int) -> int: ... +@overload +def add(x: int, y: int) -> int: ... +def add(x: int | None = None, y: int | None = None) -> int | None: + return (x or 0) + (y or 0) + +reveal_type(add) # revealed: Overload[() -> None, (x: int) -> int, (x: int, y: int) -> int] +reveal_type(add()) # revealed: None +reveal_type(add(1)) # revealed: int +reveal_type(add(1, 2)) # revealed: int +``` + +## Overriding + +These scenarios are to verify that the overloaded and non-overloaded definitions are correctly +overridden by each other. + +An overloaded function is overriding another overloaded function: + +```py +from typing import overload + +@overload +def foo() -> None: ... +@overload +def foo(x: int) -> int: ... +def foo(x: int | None = None) -> int | None: + return x + +reveal_type(foo) # revealed: Overload[() -> None, (x: int) -> int] +reveal_type(foo()) # revealed: None +reveal_type(foo(1)) # revealed: int + +@overload +def foo() -> None: ... +@overload +def foo(x: str) -> str: ... +def foo(x: str | None = None) -> str | None: + return x + +reveal_type(foo) # revealed: Overload[() -> None, (x: str) -> str] +reveal_type(foo()) # revealed: None +reveal_type(foo("")) # revealed: str +``` + +A non-overloaded function is overriding an overloaded function: + +```py +def foo(x: int) -> int: + return x + +reveal_type(foo) # revealed: def foo(x: int) -> int +``` + +An overloaded function is overriding a non-overloaded function: + +```py +reveal_type(foo) # revealed: def foo(x: int) -> int + +@overload +def foo() -> None: ... +@overload +def foo(x: bytes) -> bytes: ... +def foo(x: bytes | None = None) -> bytes | None: + return x + +reveal_type(foo) # revealed: Overload[() -> None, (x: bytes) -> bytes] +reveal_type(foo()) # revealed: None +reveal_type(foo(b"")) # revealed: bytes +``` + +## Methods + +```py +from typing import overload + +class Foo1: + @overload + def method(self) -> None: ... + @overload + def method(self, x: int) -> int: ... + def method(self, x: int | None = None) -> int | None: + return x + +foo1 = Foo1() +reveal_type(foo1.method) # revealed: Overload[() -> None, (x: int) -> int] +reveal_type(foo1.method()) # revealed: None +reveal_type(foo1.method(1)) # revealed: int + +class Foo2: + @overload + def method(self) -> None: ... + @overload + def method(self, x: str) -> str: ... + def method(self, x: str | None = None) -> str | None: + return x + +foo2 = Foo2() +reveal_type(foo2.method) # revealed: Overload[() -> None, (x: str) -> str] +reveal_type(foo2.method()) # revealed: None +reveal_type(foo2.method("")) # revealed: str +``` + +## Constructor + +```py +from typing import overload + +class Foo: + @overload + def __init__(self) -> None: ... + @overload + def __init__(self, x: int) -> None: ... + def __init__(self, x: int | None = None) -> None: + self.x = x + +foo = Foo() +reveal_type(foo) # revealed: Foo +reveal_type(foo.x) # revealed: Unknown | int | None + +foo1 = Foo(1) +reveal_type(foo1) # revealed: Foo +reveal_type(foo1.x) # revealed: Unknown | int | None +``` + +## Version specific + +Function definitions can vary between multiple Python versions. + +### Overload and non-overload (3.9) + +Here, the same function is overloaded in one version and not in another. + +```toml +[environment] +python-version = "3.9" +``` + +```py +import sys +from typing import overload + +if sys.version_info < (3, 10): + def func(x: int) -> int: + return x + +elif sys.version_info <= (3, 12): + @overload + def func() -> None: ... + @overload + def func(x: int) -> int: ... + def func(x: int | None = None) -> int | None: + return x + +reveal_type(func) # revealed: def func(x: int) -> int +func() # error: [missing-argument] +``` + +### Overload and non-overload (3.10) + +```toml +[environment] +python-version = "3.10" +``` + +```py +import sys +from typing import overload + +if sys.version_info < (3, 10): + def func(x: int) -> int: + return x + +elif sys.version_info <= (3, 12): + @overload + def func() -> None: ... + @overload + def func(x: int) -> int: ... + def func(x: int | None = None) -> int | None: + return x + +reveal_type(func) # revealed: Overload[() -> None, (x: int) -> int] +reveal_type(func()) # revealed: None +reveal_type(func(1)) # revealed: int +``` + +### Some overloads are version specific (3.9) + +```toml +[environment] +python-version = "3.9" +``` + +`overloaded.pyi`: + +```pyi +import sys +from typing import overload + +if sys.version_info >= (3, 10): + @overload + def func() -> None: ... + +@overload +def func(x: int) -> int: ... +@overload +def func(x: str) -> str: ... +``` + +`main.py`: + +```py +from overloaded import func + +reveal_type(func) # revealed: Overload[(x: int) -> int, (x: str) -> str] +func() # error: [no-matching-overload] +reveal_type(func(1)) # revealed: int +reveal_type(func("")) # revealed: str +``` + +### Some overloads are version specific (3.10) + +```toml +[environment] +python-version = "3.10" +``` + +`overloaded.pyi`: + +```pyi +import sys +from typing import overload + +@overload +def func() -> None: ... + +if sys.version_info >= (3, 10): + @overload + def func(x: int) -> int: ... + +@overload +def func(x: str) -> str: ... +``` + +`main.py`: + +```py +from overloaded import func + +reveal_type(func) # revealed: Overload[() -> None, (x: int) -> int, (x: str) -> str] +reveal_type(func()) # revealed: None +reveal_type(func(1)) # revealed: int +reveal_type(func("")) # revealed: str +``` + +## Generic + +```toml +[environment] +python-version = "3.12" +``` + +For an overloaded generic function, it's not necessary for all overloads to be generic. + +```py +from typing import overload + +@overload +def func() -> None: ... +@overload +def func[T](x: T) -> T: ... +def func[T](x: T | None = None) -> T | None: + return x + +reveal_type(func) # revealed: Overload[() -> None, (x: T) -> T] +reveal_type(func()) # revealed: None +reveal_type(func(1)) # revealed: Literal[1] +reveal_type(func("")) # revealed: Literal[""] +``` + +## Invalid + +### At least two overloads + +<!-- snapshot-diagnostics --> + +At least two `@overload`-decorated definitions must be present. + +```py +from typing import overload + +@overload +def func(x: int) -> int: ... + +# error: [invalid-overload] +def func(x: int | str) -> int | str: + return x +``` + +```pyi +from typing import overload + +@overload +# error: [invalid-overload] +def func(x: int) -> int: ... +``` + +### Overload without an implementation + +#### Regular modules + +<!-- snapshot-diagnostics --> + +In regular modules, a series of `@overload`-decorated definitions must be followed by exactly one +non-`@overload`-decorated definition (for the same function/method). + +```py +from typing import overload + +@overload +def func(x: int) -> int: ... +@overload +# error: [invalid-overload] "Overloaded non-stub function `func` must have an implementation" +def func(x: str) -> str: ... + +class Foo: + @overload + def method(self, x: int) -> int: ... + @overload + # error: [invalid-overload] "Overloaded non-stub function `method` must have an implementation" + def method(self, x: str) -> str: ... +``` + +#### Stub files + +Overload definitions within stub files are exempt from this check. + +```pyi +from typing import overload + +@overload +def func(x: int) -> int: ... +@overload +def func(x: str) -> str: ... +``` + +#### Protocols + +Overload definitions within protocols are exempt from this check. + +```py +from typing import Protocol, overload + +class Foo(Protocol): + @overload + def f(self, x: int) -> int: ... + @overload + def f(self, x: str) -> str: ... +``` + +#### Abstract methods + +Overload definitions within abstract base classes are exempt from this check. + +```py +from abc import ABC, abstractmethod +from typing import overload + +class AbstractFoo(ABC): + @overload + @abstractmethod + def f(self, x: int) -> int: ... + @overload + @abstractmethod + def f(self, x: str) -> str: ... +``` + +Using the `@abstractmethod` decorator requires that the class's metaclass is `ABCMeta` or is derived +from it. + +```py +class Foo: + @overload + @abstractmethod + def f(self, x: int) -> int: ... + @overload + @abstractmethod + # error: [invalid-overload] + def f(self, x: str) -> str: ... +``` + +And, the `@abstractmethod` decorator must be present on all the `@overload`-ed methods. + +```py +class PartialFoo1(ABC): + @overload + @abstractmethod + def f(self, x: int) -> int: ... + @overload + # error: [invalid-overload] + def f(self, x: str) -> str: ... + +class PartialFoo(ABC): + @overload + def f(self, x: int) -> int: ... + @overload + @abstractmethod + # error: [invalid-overload] + def f(self, x: str) -> str: ... +``` + +### Inconsistent decorators + +#### `@staticmethod` + +If one overload signature is decorated with `@staticmethod`, all overload signatures must be +similarly decorated. The implementation, if present, must also have a consistent decorator. + +```py +from __future__ import annotations + +from typing import overload + +class CheckStaticMethod: + # TODO: error because `@staticmethod` does not exist on all overloads + @overload + def method1(x: int) -> int: ... + @overload + def method1(x: str) -> str: ... + @staticmethod + def method1(x: int | str) -> int | str: + return x + # TODO: error because `@staticmethod` does not exist on all overloads + @overload + def method2(x: int) -> int: ... + @overload + @staticmethod + def method2(x: str) -> str: ... + @staticmethod + def method2(x: int | str) -> int | str: + return x + # TODO: error because `@staticmethod` does not exist on the implementation + @overload + @staticmethod + def method3(x: int) -> int: ... + @overload + @staticmethod + def method3(x: str) -> str: ... + def method3(x: int | str) -> int | str: + return x + + @overload + @staticmethod + def method4(x: int) -> int: ... + @overload + @staticmethod + def method4(x: str) -> str: ... + @staticmethod + def method4(x: int | str) -> int | str: + return x +``` + +#### `@classmethod` + +<!-- snapshot-diagnostics --> + +The same rules apply for `@classmethod` as for [`@staticmethod`](#staticmethod). + +```py +from __future__ import annotations + +from typing import overload + +class CheckClassMethod: + def __init__(self, x: int) -> None: + self.x = x + + @overload + @classmethod + def try_from1(cls, x: int) -> CheckClassMethod: ... + @overload + def try_from1(cls, x: str) -> None: ... + @classmethod + # error: [invalid-overload] "Overloaded function `try_from1` does not use the `@classmethod` decorator consistently" + def try_from1(cls, x: int | str) -> CheckClassMethod | None: + if isinstance(x, int): + return cls(x) + return None + + @overload + def try_from2(cls, x: int) -> CheckClassMethod: ... + @overload + @classmethod + def try_from2(cls, x: str) -> None: ... + @classmethod + # error: [invalid-overload] + def try_from2(cls, x: int | str) -> CheckClassMethod | None: + if isinstance(x, int): + return cls(x) + return None + + @overload + @classmethod + def try_from3(cls, x: int) -> CheckClassMethod: ... + @overload + @classmethod + def try_from3(cls, x: str) -> None: ... + # error: [invalid-overload] + def try_from3(cls, x: int | str) -> CheckClassMethod | None: + if isinstance(x, int): + return cls(x) + return None + + @overload + @classmethod + def try_from4(cls, x: int) -> CheckClassMethod: ... + @overload + @classmethod + def try_from4(cls, x: str) -> None: ... + @classmethod + def try_from4(cls, x: int | str) -> CheckClassMethod | None: + if isinstance(x, int): + return cls(x) + return None +``` + +#### `@final` + +<!-- snapshot-diagnostics --> + +If a `@final` decorator is supplied for a function with overloads, the decorator should be applied +only to the overload implementation if it is present. + +```py +from typing_extensions import final, overload + +class Foo: + @overload + def method1(self, x: int) -> int: ... + @overload + def method1(self, x: str) -> str: ... + @final + def method1(self, x: int | str) -> int | str: + return x + + @overload + @final + def method2(self, x: int) -> int: ... + @overload + def method2(self, x: str) -> str: ... + # error: [invalid-overload] + def method2(self, x: int | str) -> int | str: + return x + + @overload + def method3(self, x: int) -> int: ... + @overload + @final + def method3(self, x: str) -> str: ... + # error: [invalid-overload] + def method3(self, x: int | str) -> int | str: + return x +``` + +If an overload implementation isn't present (for example, in a stub file), the `@final` decorator +should be applied only to the first overload. + +```pyi +from typing_extensions import final, overload + +class Foo: + @overload + @final + def method1(self, x: int) -> int: ... + @overload + def method1(self, x: str) -> str: ... + + @overload + def method2(self, x: int) -> int: ... + @final + @overload + # error: [invalid-overload] + def method2(self, x: str) -> str: ... +``` + +#### `@override` + +<!-- snapshot-diagnostics --> + +The same rules apply for `@override` as for [`@final`](#final). + +```py +from typing_extensions import overload, override + +class Base: + @overload + def method(self, x: int) -> int: ... + @overload + def method(self, x: str) -> str: ... + def method(self, x: int | str) -> int | str: + return x + +class Sub1(Base): + @overload + def method(self, x: int) -> int: ... + @overload + def method(self, x: str) -> str: ... + @override + def method(self, x: int | str) -> int | str: + return x + +class Sub2(Base): + @overload + def method(self, x: int) -> int: ... + @overload + @override + def method(self, x: str) -> str: ... + # error: [invalid-overload] + def method(self, x: int | str) -> int | str: + return x + +class Sub3(Base): + @overload + @override + def method(self, x: int) -> int: ... + @overload + def method(self, x: str) -> str: ... + # error: [invalid-overload] + def method(self, x: int | str) -> int | str: + return x +``` + +And, similarly, in stub files: + +```pyi +from typing_extensions import overload, override + +class Base: + @overload + def method(self, x: int) -> int: ... + @overload + def method(self, x: str) -> str: ... + +class Sub1(Base): + @overload + @override + def method(self, x: int) -> int: ... + @overload + def method(self, x: str) -> str: ... + +class Sub2(Base): + @overload + def method(self, x: int) -> int: ... + @overload + @override + # error: [invalid-overload] + def method(self, x: str) -> str: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/pep695_type_aliases.md b/crates/ty_python_semantic/resources/mdtest/pep695_type_aliases.md new file mode 100644 index 0000000000000..65c4f988659b1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/pep695_type_aliases.md @@ -0,0 +1,140 @@ +# PEP 695 type aliases + +PEP 695 type aliases are only available in Python 3.12 and later: + +```toml +[environment] +python-version = "3.12" +``` + +## Basic + +```py +type IntOrStr = int | str + +reveal_type(IntOrStr) # revealed: typing.TypeAliasType +reveal_type(IntOrStr.__name__) # revealed: Literal["IntOrStr"] + +x: IntOrStr = 1 + +reveal_type(x) # revealed: Literal[1] + +def f() -> None: + reveal_type(x) # revealed: int | str +``` + +## `__value__` attribute + +```py +type IntOrStr = int | str + +reveal_type(IntOrStr.__value__) # revealed: @Todo(Support for `typing.TypeAlias`) +``` + +## Invalid assignment + +```py +type OptionalInt = int | None + +# error: [invalid-assignment] +x: OptionalInt = "1" +``` + +## Type aliases in type aliases + +```py +type IntOrStr = int | str +type IntOrStrOrBytes = IntOrStr | bytes + +x: IntOrStrOrBytes = 1 + +def f() -> None: + reveal_type(x) # revealed: int | str | bytes +``` + +## Aliased type aliases + +```py +type IntOrStr = int | str +MyIntOrStr = IntOrStr + +x: MyIntOrStr = 1 + +# error: [invalid-assignment] +y: MyIntOrStr = None +``` + +## Generic type aliases + +```py +type ListOrSet[T] = list[T] | set[T] +reveal_type(ListOrSet.__type_params__) # revealed: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] +``` + +## `TypeAliasType` properties + +Two `TypeAliasType`s are distinct and disjoint, even if they refer to the same type + +```py +from ty_extensions import static_assert, is_equivalent_to, is_disjoint_from, TypeOf + +type Alias1 = int +type Alias2 = int + +type TypeAliasType1 = TypeOf[Alias1] +type TypeAliasType2 = TypeOf[Alias2] + +static_assert(not is_equivalent_to(TypeAliasType1, TypeAliasType2)) +static_assert(is_disjoint_from(TypeAliasType1, TypeAliasType2)) +``` + +## Direct use of `TypeAliasType` + +`TypeAliasType` can also be used directly. This is useful for versions of Python prior to 3.12. + +```toml +[environment] +python-version = "3.9" +``` + +### Basic example + +```py +from typing_extensions import TypeAliasType, Union + +IntOrStr = TypeAliasType("IntOrStr", Union[int, str]) + +reveal_type(IntOrStr) # revealed: typing.TypeAliasType + +reveal_type(IntOrStr.__name__) # revealed: Literal["IntOrStr"] + +def f(x: IntOrStr) -> None: + reveal_type(x) # revealed: int | str +``` + +### Generic example + +```py +from typing_extensions import TypeAliasType, TypeVar + +T = TypeVar("T") + +IntAnd = TypeAliasType("IntAndT", tuple[int, T], type_params=(T,)) + +def f(x: IntAnd[str]) -> None: + reveal_type(x) # revealed: @Todo(Generic PEP-695 type alias) +``` + +### Error cases + +#### Name is not a string literal + +```py +from typing_extensions import TypeAliasType + +def get_name() -> str: + return "IntOrStr" + +# error: [invalid-type-alias-type] "The name of a `typing.TypeAlias` must be a string literal" +IntOrStr = TypeAliasType(get_name(), int | str) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/properties.md b/crates/ty_python_semantic/resources/mdtest/properties.md new file mode 100644 index 0000000000000..aff91ead1bc5a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/properties.md @@ -0,0 +1,305 @@ +# Properties + +`property` is a built-in class in Python that can be used to model class attributes with custom +getters, setters, and deleters. + +## Basic getter + +`property` is typically used as a decorator on a getter method. It turns the method into a property +object. When accessing the property on an instance, the descriptor protocol is invoked, which calls +the getter method: + +```py +class C: + @property + def my_property(self) -> int: + return 1 + +reveal_type(C().my_property) # revealed: int +``` + +When a property is accessed on the class directly, the descriptor protocol is also invoked, but +`property.__get__` simply returns itself in this case (when `instance` is `None`): + +```py +reveal_type(C.my_property) # revealed: property +``` + +## Getter and setter + +A property can also have a setter method, which is used to set the value of the property. The setter +method is defined using the `@<property_name>.setter` decorator. The setter method takes the value +to be set as an argument. + +```py +class C: + @property + def my_property(self) -> int: + return 1 + + @my_property.setter + def my_property(self, value: int) -> None: + pass + +c = C() +reveal_type(c.my_property) # revealed: int +c.my_property = 2 + +# error: [invalid-assignment] +c.my_property = "a" +``` + +## `property.getter` + +`property.getter` can be used to overwrite the getter method of a property. This does not overwrite +the existing setter: + +```py +class C: + @property + def my_property(self) -> int: + return 1 + + @my_property.setter + def my_property(self, value: int) -> None: + pass + + @my_property.getter + def my_property(self) -> str: + return "a" + +c = C() +reveal_type(c.my_property) # revealed: str +c.my_property = 2 + +# error: [invalid-assignment] +c.my_property = "b" +``` + +## `property.deleter` + +We do not support `property.deleter` yet, but we make sure that it does not invalidate the getter or +setter: + +```py +class C: + @property + def my_property(self) -> int: + return 1 + + @my_property.setter + def my_property(self, value: int) -> None: + pass + + @my_property.deleter + def my_property(self) -> None: + pass + +c = C() +reveal_type(c.my_property) # revealed: int +c.my_property = 2 +# error: [invalid-assignment] +c.my_property = "a" +``` + +## Failure cases + +### Attempting to write to a read-only property + +When attempting to write to a read-only property, we emit an error: + +```py +class C: + @property + def attr(self) -> int: + return 1 + +c = C() + +# error: [invalid-assignment] +c.attr = 2 +``` + +### Attempting to read a write-only property + +When attempting to read a write-only property, we emit an error: + +```py +class C: + def attr_setter(self, value: int) -> None: + pass + attr = property(fset=attr_setter) + +c = C() +c.attr = 1 + +# TODO: An error should be emitted here, and the type should be `Unknown` +# or `Never`. See https://github.com/astral-sh/ruff/issues/16298 for more +# details. +reveal_type(c.attr) # revealed: Unknown | property +``` + +### Wrong setter signature + +```py +class C: + @property + def attr(self) -> int: + return 1 + # error: [invalid-argument-type] "Argument to bound method `setter` is incorrect: Expected `(Any, Any, /) -> None`, found `def attr(self) -> None`" + @attr.setter + def attr(self) -> None: + pass +``` + +### Wrong getter signature + +```py +class C: + # error: [invalid-argument-type] "Argument to class `property` is incorrect: Expected `((Any, /) -> Any) | None`, found `def attr(self, x: int) -> int`" + @property + def attr(self, x: int) -> int: + return 1 +``` + +## Limitations + +### Manually constructed property + +Properties can also be constructed manually using the `property` class. We partially support this: + +```py +class C: + def attr_getter(self) -> int: + return 1 + attr = property(attr_getter) + +c = C() +reveal_type(c.attr) # revealed: Unknown | int +``` + +But note that we return `Unknown | int` because we did not declare the `attr` attribute. This is +consistent with how we usually treat attributes, but here, if we try to declare `attr` as +`property`, we fail to understand the property, since the `property` declaration shadows the more +precise type that we infer for `property(attr_getter)` (which includes the actual information about +the getter). + +```py +class C: + def attr_getter(self) -> int: + return 1 + attr: property = property(attr_getter) + +c = C() +reveal_type(c.attr) # revealed: Unknown +``` + +## Behind the scenes + +In this section, we trace through some of the steps that make properties work. We start with a +simple class `C` and a property `attr`: + +```py +class C: + def __init__(self): + self._attr: int = 0 + + @property + def attr(self) -> int: + return self._attr + + @attr.setter + def attr(self, value: str) -> None: + self._attr = len(value) +``` + +Next, we create an instance of `C`. As we have seen above, accessing `attr` on the instance will +return an `int`: + +```py +c = C() + +reveal_type(c.attr) # revealed: int +``` + +Behind the scenes, when we write `c.attr`, the first thing that happens is that we statically look +up the symbol `attr` on the meta-type of `c`, i.e. the class `C`. We can emulate this static lookup +using `inspect.getattr_static`, to see that `attr` is actually an instance of the `property` class: + +```py +from inspect import getattr_static + +attr_property = getattr_static(C, "attr") +reveal_type(attr_property) # revealed: property +``` + +The `property` class has a `__get__` method, which makes it a descriptor. It also has a `__set__` +method, which means that it is a *data* descriptor (if there is no setter, `__set__` is still +available but yields an `AttributeError` at runtime). + +```py +reveal_type(type(attr_property).__get__) # revealed: <wrapper-descriptor `__get__` of `property` objects> +reveal_type(type(attr_property).__set__) # revealed: <wrapper-descriptor `__set__` of `property` objects> +``` + +When we access `c.attr`, the `__get__` method of the `property` class is called, passing the +property object itself as the first argument, and the class instance `c` as the second argument. The +third argument is the "owner" which can be set to `None` or to `C` in this case: + +```py +reveal_type(type(attr_property).__get__(attr_property, c, C)) # revealed: int +reveal_type(type(attr_property).__get__(attr_property, c, None)) # revealed: int +``` + +Alternatively, the above can also be written as a method call: + +```py +reveal_type(attr_property.__get__(c, C)) # revealed: int +``` + +When we access `attr` on the class itself, the descriptor protocol is also invoked, but the instance +argument is set to `None`. When `instance` is `None`, the call to `property.__get__` returns the +property instance itself. So the following expressions are all equivalent + +```py +reveal_type(attr_property) # revealed: property +reveal_type(C.attr) # revealed: property +reveal_type(attr_property.__get__(None, C)) # revealed: property +reveal_type(type(attr_property).__get__(attr_property, None, C)) # revealed: property +``` + +When we set the property using `c.attr = "a"`, the `__set__` method of the property class is called. +This attribute access desugars to + +```py +type(attr_property).__set__(attr_property, c, "a") + +# error: [call-non-callable] "Call of wrapper descriptor `property.__set__` failed: calling the setter failed" +type(attr_property).__set__(attr_property, c, 1) +``` + +which is also equivalent to the following expressions: + +```py +attr_property.__set__(c, "a") +# error: [call-non-callable] +attr_property.__set__(c, 1) + +C.attr.__set__(c, "a") +# error: [call-non-callable] +C.attr.__set__(c, 1) +``` + +Properties also have `fget` and `fset` attributes that can be used to retrieve the original getter +and setter functions, respectively. + +```py +reveal_type(attr_property.fget) # revealed: def attr(self) -> int +reveal_type(attr_property.fget(c)) # revealed: int + +reveal_type(attr_property.fset) # revealed: def attr(self, value: str) -> None +reveal_type(attr_property.fset(c, "a")) # revealed: None + +# error: [invalid-argument-type] +attr_property.fset(c, 1) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/protocols.md b/crates/ty_python_semantic/resources/mdtest/protocols.md new file mode 100644 index 0000000000000..28b12d8d85944 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/protocols.md @@ -0,0 +1,1742 @@ +# Protocols + +> [!NOTE] +> +> See also: +> +> - The [typing specification section on protocols][typing_spec_protocols] +> - The many [protocol conformance tests] provided by the Typing Council for type checkers +> - Mypy's [documentation][mypy_protocol_docs] and [tests][mypy_protocol_tests] for protocols + +Most types in Python are *nominal* types: a fully static nominal type `X` is only a subtype of +another fully static nominal type `Y` if the class `X` is a subclass of the class `Y`. +`typing.Protocol` (or its backport, `typing_extensions.Protocol`) can be used to define *structural* +types, on the other hand: a type which is defined by its properties and behaviour. + +## Defining a protocol + +```toml +[environment] +python-version = "3.12" +``` + +A protocol is defined by inheriting from the `Protocol` class, which is annotated as an instance of +`_SpecialForm` in typeshed's stubs. + +```py +from typing import Protocol + +class MyProtocol(Protocol): ... + +reveal_type(MyProtocol.__mro__) # revealed: tuple[<class 'MyProtocol'>, typing.Protocol, typing.Generic, <class 'object'>] +``` + +Just like for any other class base, it is an error for `Protocol` to appear multiple times in a +class's bases: + +```py +class Foo(Protocol, Protocol): ... # error: [duplicate-base] + +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +Protocols can also be generic, either by including `Generic[]` in the bases list, subscripting +`Protocol` directly in the bases list, using PEP-695 type parameters, or some combination of the +above: + +```py +from typing import TypeVar, Generic + +T = TypeVar("T") + +class Bar0(Protocol[T]): + x: T + +class Bar1(Protocol[T], Generic[T]): + x: T + +class Bar2[T](Protocol): + x: T + +# error: [invalid-generic-class] "Cannot both inherit from subscripted `typing.Protocol` and use PEP 695 type variables" +class Bar3[T](Protocol[T]): + x: T +``` + +It's an error to include both bare `Protocol` and subscripted `Protocol[]` in the bases list +simultaneously: + +```py +# TODO: should emit a `[duplicate-bases]` error here: +class DuplicateBases(Protocol, Protocol[T]): + x: T + +# TODO: should not have `Protocol` or `Generic` multiple times +# revealed: tuple[<class 'DuplicateBases[Unknown]'>, typing.Protocol, typing.Generic, typing.Protocol[T], typing.Generic[T], <class 'object'>] +reveal_type(DuplicateBases.__mro__) +``` + +The introspection helper `typing(_extensions).is_protocol` can be used to verify whether a class is +a protocol class or not: + +```py +from typing_extensions import is_protocol + +reveal_type(is_protocol(MyProtocol)) # revealed: Literal[True] +reveal_type(is_protocol(Bar0)) # revealed: Literal[True] +reveal_type(is_protocol(Bar1)) # revealed: Literal[True] +reveal_type(is_protocol(Bar2)) # revealed: Literal[True] +reveal_type(is_protocol(Bar3)) # revealed: Literal[True] + +class NotAProtocol: ... + +reveal_type(is_protocol(NotAProtocol)) # revealed: Literal[False] +``` + +A type checker should follow the typeshed stubs if a non-class is passed in, and typeshed's stubs +indicate that the argument passed in must be an instance of `type`. + +```py +# We could also reasonably infer `Literal[False]` here, but it probably doesn't matter that much: +# error: [invalid-argument-type] +reveal_type(is_protocol("not a class")) # revealed: bool +``` + +For a class to be considered a protocol class, it must have `Protocol` directly in its bases tuple: +it is not sufficient for it to have `Protocol` in its MRO. + +```py +class SubclassOfMyProtocol(MyProtocol): ... + +# revealed: tuple[<class 'SubclassOfMyProtocol'>, <class 'MyProtocol'>, typing.Protocol, typing.Generic, <class 'object'>] +reveal_type(SubclassOfMyProtocol.__mro__) + +reveal_type(is_protocol(SubclassOfMyProtocol)) # revealed: Literal[False] +``` + +A protocol class may inherit from other protocols, however, as long as it re-inherits from +`Protocol`: + +```py +class SubProtocol(MyProtocol, Protocol): ... + +reveal_type(is_protocol(SubProtocol)) # revealed: Literal[True] + +class OtherProtocol(Protocol): + some_attribute: str + +class ComplexInheritance(SubProtocol, OtherProtocol, Protocol): ... + +# revealed: tuple[<class 'ComplexInheritance'>, <class 'SubProtocol'>, <class 'MyProtocol'>, <class 'OtherProtocol'>, typing.Protocol, typing.Generic, <class 'object'>] +reveal_type(ComplexInheritance.__mro__) + +reveal_type(is_protocol(ComplexInheritance)) # revealed: Literal[True] +``` + +If `Protocol` is present in the bases tuple, all other bases in the tuple must be protocol classes, +or `TypeError` is raised at runtime when the class is created. + +```py +# error: [invalid-protocol] "Protocol class `Invalid` cannot inherit from non-protocol class `NotAProtocol`" +class Invalid(NotAProtocol, Protocol): ... + +# revealed: tuple[<class 'Invalid'>, <class 'NotAProtocol'>, typing.Protocol, typing.Generic, <class 'object'>] +reveal_type(Invalid.__mro__) + +# error: [invalid-protocol] "Protocol class `AlsoInvalid` cannot inherit from non-protocol class `NotAProtocol`" +class AlsoInvalid(MyProtocol, OtherProtocol, NotAProtocol, Protocol): ... + +# revealed: tuple[<class 'AlsoInvalid'>, <class 'MyProtocol'>, <class 'OtherProtocol'>, <class 'NotAProtocol'>, typing.Protocol, typing.Generic, <class 'object'>] +reveal_type(AlsoInvalid.__mro__) +``` + +But two exceptions to this rule are `object` and `Generic`: + +```py +from typing import TypeVar, Generic + +T = TypeVar("T") + +# Note: pyright and pyrefly do not consider this to be a valid `Protocol` class, +# but mypy does (and has an explicit test for this behaviour). Mypy was the +# reference implementation for PEP-544, and its behaviour also matches the CPython +# runtime, so we choose to follow its behaviour here rather than that of the other +# type checkers. +class Fine(Protocol, object): ... + +reveal_type(Fine.__mro__) # revealed: tuple[<class 'Fine'>, typing.Protocol, typing.Generic, <class 'object'>] + +class StillFine(Protocol, Generic[T], object): ... +class EvenThis[T](Protocol, object): ... +class OrThis(Protocol[T], Generic[T]): ... +class AndThis(Protocol[T], Generic[T], object): ... +``` + +And multiple inheritance from a mix of protocol and non-protocol classes is fine as long as +`Protocol` itself is not in the bases list: + +```py +class FineAndDandy(MyProtocol, OtherProtocol, NotAProtocol): ... + +# revealed: tuple[<class 'FineAndDandy'>, <class 'MyProtocol'>, <class 'OtherProtocol'>, typing.Protocol, typing.Generic, <class 'NotAProtocol'>, <class 'object'>] +reveal_type(FineAndDandy.__mro__) +``` + +But if `Protocol` is not present in the bases list, the resulting class doesn't count as a protocol +class anymore: + +```py +reveal_type(is_protocol(FineAndDandy)) # revealed: Literal[False] +``` + +A class does not *have* to inherit from a protocol class in order for it to be considered a subtype +of that protocol (more on that below). However, classes that explicitly inherit from a protocol +class are understood as subtypes of that protocol, the same as with nominal types: + +```py +from ty_extensions import static_assert, is_subtype_of, is_assignable_to + +static_assert(is_subtype_of(SubclassOfMyProtocol, MyProtocol)) +static_assert(is_assignable_to(SubclassOfMyProtocol, MyProtocol)) + +static_assert(is_subtype_of(SubProtocol, MyProtocol)) +static_assert(is_assignable_to(SubProtocol, MyProtocol)) + +static_assert(is_subtype_of(ComplexInheritance, SubProtocol)) +static_assert(is_assignable_to(ComplexInheritance, SubProtocol)) + +static_assert(is_subtype_of(ComplexInheritance, OtherProtocol)) +static_assert(is_assignable_to(ComplexInheritance, SubProtocol)) + +static_assert(is_subtype_of(FineAndDandy, MyProtocol)) +static_assert(is_assignable_to(FineAndDandy, MyProtocol)) + +static_assert(is_subtype_of(FineAndDandy, OtherProtocol)) +static_assert(is_assignable_to(FineAndDandy, OtherProtocol)) +``` + +Note, however, that `Protocol` itself is not a type, so it is an error to pass it to `is_subtype_of` +or `is_assignable_to`: + +```py +is_subtype_of(MyProtocol, Protocol) # error: [invalid-type-form] +is_assignable_to(MyProtocol, Protocol) # error: [invalid-type-form] +``` + +And it is also an error to use `Protocol` in type expressions: + +```py +# fmt: off + +def f( + x: Protocol, # error: [invalid-type-form] "`typing.Protocol` is not allowed in type expressions" + y: type[Protocol], # TODO: should emit `[invalid-type-form]` here too +): + reveal_type(x) # revealed: Unknown + + # TODO: should be `type[Unknown]` + reveal_type(y) # revealed: @Todo(unsupported type[X] special form) + +# fmt: on +``` + +Nonetheless, `Protocol` can still be used as the second argument to `issubclass()` at runtime: + +```py +# Could also be `Literal[True]`, but `bool` is fine: +reveal_type(issubclass(MyProtocol, Protocol)) # revealed: bool +``` + +## `typing.Protocol` versus `typing_extensions.Protocol` + +`typing.Protocol` and its backport in `typing_extensions` should be treated as exactly equivalent. + +```py +import typing +import typing_extensions +from ty_extensions import static_assert, is_equivalent_to, TypeOf + +static_assert(is_equivalent_to(TypeOf[typing.Protocol], TypeOf[typing_extensions.Protocol])) +static_assert(is_equivalent_to(int | str | TypeOf[typing.Protocol], TypeOf[typing_extensions.Protocol] | str | int)) + +class Foo(typing.Protocol): + x: int + +class Bar(typing_extensions.Protocol): + x: int + +static_assert(typing_extensions.is_protocol(Foo)) +static_assert(typing_extensions.is_protocol(Bar)) +static_assert(is_equivalent_to(Foo, Bar)) +``` + +The same goes for `typing.runtime_checkable` and `typing_extensions.runtime_checkable`: + +```py +@typing_extensions.runtime_checkable +class RuntimeCheckableFoo(typing.Protocol): + x: int + +@typing.runtime_checkable +class RuntimeCheckableBar(typing_extensions.Protocol): + x: int + +static_assert(typing_extensions.is_protocol(RuntimeCheckableFoo)) +static_assert(typing_extensions.is_protocol(RuntimeCheckableBar)) +static_assert(is_equivalent_to(RuntimeCheckableFoo, RuntimeCheckableBar)) + +# These should not error because the protocols are decorated with `@runtime_checkable` +isinstance(object(), RuntimeCheckableFoo) +isinstance(object(), RuntimeCheckableBar) +``` + +However, we understand that they are not necessarily the same symbol at the same memory address at +runtime -- these reveal `bool` rather than `Literal[True]` or `Literal[False]`, which would be +incorrect: + +```py +reveal_type(typing.Protocol is typing_extensions.Protocol) # revealed: bool +reveal_type(typing.Protocol is not typing_extensions.Protocol) # revealed: bool +``` + +## Calls to protocol classes + +<!-- snapshot-diagnostics --> + +Neither `Protocol`, nor any protocol class, can be directly instantiated: + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing_extensions import Protocol, reveal_type + +# error: [call-non-callable] +reveal_type(Protocol()) # revealed: Unknown + +class MyProtocol(Protocol): + x: int + +# error: [call-non-callable] "Cannot instantiate class `MyProtocol`" +reveal_type(MyProtocol()) # revealed: MyProtocol + +class GenericProtocol[T](Protocol): + x: T + +# error: [call-non-callable] "Cannot instantiate class `GenericProtocol`" +reveal_type(GenericProtocol[int]()) # revealed: GenericProtocol[int] +``` + +But a non-protocol class can be instantiated, even if it has `Protocol` in its MRO: + +```py +class SubclassOfMyProtocol(MyProtocol): ... + +reveal_type(SubclassOfMyProtocol()) # revealed: SubclassOfMyProtocol + +class SubclassOfGenericProtocol[T](GenericProtocol[T]): ... + +reveal_type(SubclassOfGenericProtocol[int]()) # revealed: SubclassOfGenericProtocol[int] +``` + +And as a corollary, `type[MyProtocol]` can also be called: + +```py +def f(x: type[MyProtocol]): + reveal_type(x()) # revealed: MyProtocol +``` + +## Members of a protocol + +A protocol defines an interface through its *members*: if a protocol `Foo` has members `X` and `Y`, +a type `Bar` can only be a subtype of `Foo` if inhabitants of `Bar` also have attributes `X` and +`Y`. + +A protocol class defines its members through declarations in the class body. The members of a +protocol can be introspected using the function `typing.get_protocol_members`, which is backported +via `typing_extensions`. + +```py +from typing_extensions import Protocol, get_protocol_members + +class Foo(Protocol): + x: int + + @property + def y(self) -> str: + return "y" + + @property + def z(self) -> int: + return 42 + + @z.setter + def z(self, z: int) -> None: ... + def method_member(self) -> bytes: + return b"foo" + +# TODO: actually a frozenset (requires support for legacy generics) +reveal_type(get_protocol_members(Foo)) # revealed: tuple[Literal["method_member"], Literal["x"], Literal["y"], Literal["z"]] +``` + +Certain special attributes and methods are not considered protocol members at runtime, and should +not be considered protocol members by type checkers either: + +```py +class Lumberjack(Protocol): + __slots__ = () + __match_args__ = () + x: int + + def __new__(cls, x: int) -> "Lumberjack": + return object.__new__(cls) + + def __init__(self, x: int) -> None: + self.x = x + +# TODO: actually a frozenset +reveal_type(get_protocol_members(Lumberjack)) # revealed: tuple[Literal["x"]] +``` + +A sub-protocol inherits and extends the members of its superclass protocol(s): + +```py +class Bar(Protocol): + spam: str + +class Baz(Bar, Protocol): + ham: memoryview + +# TODO: actually a frozenset +reveal_type(get_protocol_members(Baz)) # revealed: tuple[Literal["ham"], Literal["spam"]] + +class Baz2(Bar, Foo, Protocol): ... + +# TODO: actually a frozenset +# revealed: tuple[Literal["method_member"], Literal["spam"], Literal["x"], Literal["y"], Literal["z"]] +reveal_type(get_protocol_members(Baz2)) +``` + +## Protocol members in statically known branches + +The list of protocol members does not include any members declared in branches that are statically +known to be unreachable: + +```toml +[environment] +python-version = "3.9" +``` + +```py +import sys +from typing_extensions import Protocol, get_protocol_members + +class Foo(Protocol): + if sys.version_info >= (3, 10): + a: int + b = 42 + def c(self) -> None: ... + else: + d: int + e = 56 + def f(self) -> None: ... + +# TODO: actually a frozenset +reveal_type(get_protocol_members(Foo)) # revealed: tuple[Literal["d"], Literal["e"], Literal["f"]] +``` + +## Invalid calls to `get_protocol_members()` + +<!-- snapshot-diagnostics --> + +Calling `get_protocol_members` on a non-protocol class raises an error at runtime: + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing_extensions import Protocol, get_protocol_members + +class NotAProtocol: ... + +get_protocol_members(NotAProtocol) # error: [invalid-argument-type] + +class AlsoNotAProtocol(NotAProtocol, object): ... + +get_protocol_members(AlsoNotAProtocol) # error: [invalid-argument-type] +``` + +The original class object must be passed to the function; a specialised version of a generic version +does not suffice: + +```py +class GenericProtocol[T](Protocol): ... + +get_protocol_members(GenericProtocol[int]) # TODO: should emit a diagnostic here (https://github.com/astral-sh/ruff/issues/17549) +``` + +## Subtyping of protocols with attribute members + +In the following example, the protocol class `HasX` defines an interface such that any other fully +static type can be said to be a subtype of `HasX` if all inhabitants of that other type have a +mutable `x` attribute of type `int`: + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing import Protocol +from ty_extensions import static_assert, is_assignable_to, is_subtype_of + +class HasX(Protocol): + x: int + +class Foo: + x: int + +static_assert(is_subtype_of(Foo, HasX)) +static_assert(is_assignable_to(Foo, HasX)) + +class FooSub(Foo): ... + +static_assert(is_subtype_of(FooSub, HasX)) +static_assert(is_assignable_to(FooSub, HasX)) + +class Bar: + x: str + +# TODO: these should pass +static_assert(not is_subtype_of(Bar, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(Bar, HasX)) # error: [static-assert-error] + +class Baz: + y: int + +static_assert(not is_subtype_of(Baz, HasX)) +static_assert(not is_assignable_to(Baz, HasX)) +``` + +Note that declaring an attribute member on a protocol mandates that the attribute must be mutable. A +type with a read-only `x` property does not satisfy the `HasX` interface; nor does a type with a +`Final` `x` attribute. The type of the attribute must also be treated as invariant due to the +attribute's mutability: + +```py +from typing import Final + +class A: + @property + def x(self) -> int: + return 42 + +# TODO: these should pass +static_assert(not is_subtype_of(A, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(A, HasX)) # error: [static-assert-error] + +class B: + x: Final = 42 + +# TODO: these should pass +static_assert(not is_subtype_of(A, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(A, HasX)) # error: [static-assert-error] + +class IntSub(int): ... + +class C: + x: IntSub + +# due to invariance, a type is only a subtype of `HasX` +# if its `x` attribute is of type *exactly* `int`: +# a subclass of `int` does not satisfy the interface +# +# TODO: these should pass +static_assert(not is_subtype_of(C, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(C, HasX)) # error: [static-assert-error] +``` + +All attributes on frozen dataclasses and namedtuples are immutable, so instances of these classes +can never be considered to inhabit a protocol that declares a mutable-attribute member: + +```py +from dataclasses import dataclass +from typing import NamedTuple + +@dataclass +class MutableDataclass: + x: int + +static_assert(is_subtype_of(MutableDataclass, HasX)) +static_assert(is_assignable_to(MutableDataclass, HasX)) + +@dataclass(frozen=True) +class ImmutableDataclass: + x: int + +# TODO: these should pass +static_assert(not is_subtype_of(ImmutableDataclass, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(ImmutableDataclass, HasX)) # error: [static-assert-error] + +class NamedTupleWithX(NamedTuple): + x: int + +# TODO: these should pass +static_assert(not is_subtype_of(NamedTupleWithX, HasX)) # error: [static-assert-error] +static_assert(not is_assignable_to(NamedTupleWithX, HasX)) # error: [static-assert-error] +``` + +However, a type with a read-write property `x` *does* satisfy the `HasX` protocol. The `HasX` +protocol only specifies what the type of `x` should be when accessed from instances; instances of +`XProperty` in the below example have a mutable attribute `x` of type `int`: + +```py +class XProperty: + _x: int + + @property + def x(self) -> int: + return self._x + + @x.setter + def x(self, x: int) -> None: + self._x = x**2 + +static_assert(is_subtype_of(XProperty, HasX)) +static_assert(is_assignable_to(XProperty, HasX)) +``` + +Attribute members on protocol classes are allowed to have default values, just like instance +attributes on other classes. Similar to nominal classes, attributes with defaults can be accessed on +the class object itself and any explicit subclasses of the protocol class. It cannot be assumed to +exist on the meta-type of any arbitrary inhabitant of the protocol type, however; an implicit +subtype of the protocol will not necessarily have a default value for the instance attribute +provided in its class body: + +```py +class HasXWithDefault(Protocol): + x: int = 42 + +reveal_type(HasXWithDefault.x) # revealed: int + +class ExplicitSubclass(HasXWithDefault): ... + +reveal_type(ExplicitSubclass.x) # revealed: int + +def f(arg: HasXWithDefault): + # TODO: should emit `[unresolved-reference]` and reveal `Unknown` + reveal_type(type(arg).x) # revealed: int +``` + +Assignments in a class body of a protocol -- of any kind -- are not permitted by ty unless the +symbol being assigned to is also explicitly declared in the protocol's class body. Note that this is +stricter validation of protocol members than many other type checkers currently apply (as of +2025/04/21). + +The reason for this strict validation is that undeclared variables in the class body would lead to +an ambiguous interface being declared by the protocol. + +```py +from typing_extensions import TypeAlias, get_protocol_members + +class MyContext: + def __enter__(self) -> int: + return 42 + + def __exit__(self, *args) -> None: ... + +class LotsOfBindings(Protocol): + a: int + a = 42 # this is fine, since `a` is declared in the class body + b: int = 56 # this is also fine, by the same principle + + type c = str # this is very strange but I can't see a good reason to disallow it + d: TypeAlias = bytes # same here + + class Nested: ... # also weird, but we should also probably allow it + class NestedProtocol(Protocol): ... # same here... + e = 72 # TODO: this should error with `[invalid-protocol]` (`e` is not declared) + + f, g = (1, 2) # TODO: this should error with `[invalid-protocol]` (`f` and `g` are not declared) + + h: int = (i := 3) # TODO: this should error with `[invalid-protocol]` (`i` is not declared) + + for j in range(42): # TODO: this should error with `[invalid-protocol]` (`j` is not declared) + pass + + with MyContext() as k: # TODO: this should error with `[invalid-protocol]` (`k` is not declared) + pass + + match object(): + case l: # TODO: this should error with `[invalid-protocol]` (`l` is not declared) + ... + +# TODO: actually a frozenset +# revealed: tuple[Literal["Nested"], Literal["NestedProtocol"], Literal["a"], Literal["b"], Literal["c"], Literal["d"], Literal["e"], Literal["f"], Literal["g"], Literal["h"], Literal["i"], Literal["j"], Literal["k"], Literal["l"]] +reveal_type(get_protocol_members(LotsOfBindings)) +``` + +Attribute members are allowed to have assignments in methods on the protocol class, just like +non-protocol classes. Unlike other classes, however, instance attributes that are not declared in +the class body are disallowed. This is mandated by [the spec][spec_protocol_members]: + +> Additional attributes *only* defined in the body of a method by assignment via `self` are not +> allowed. The rationale for this is that the protocol class implementation is often not shared by +> subtypes, so the interface should not depend on the default implementation. + +```py +class Foo(Protocol): + x: int + y: str + + def __init__(self) -> None: + self.x = 42 # fine + self.a = 56 # TODO: should emit diagnostic + self.b: int = 128 # TODO: should emit diagnostic + + def non_init_method(self) -> None: + self.y = 64 # fine + self.c = 72 # TODO: should emit diagnostic + +# Note: the list of members does not include `a`, `b` or `c`, +# as none of these attributes is declared in the class body. +# +# TODO: actually a frozenset +reveal_type(get_protocol_members(Foo)) # revealed: tuple[Literal["non_init_method"], Literal["x"], Literal["y"]] +``` + +If a member is declared in a superclass of a protocol class, it is fine for it to be assigned to in +the sub-protocol class without a redeclaration: + +```py +class Super(Protocol): + x: int + +class Sub(Super, Protocol): + x = 42 # no error here, since it's declared in the superclass + +# TODO: actually frozensets +reveal_type(get_protocol_members(Super)) # revealed: tuple[Literal["x"]] +reveal_type(get_protocol_members(Sub)) # revealed: tuple[Literal["x"]] +``` + +If a protocol has 0 members, then all other types are assignable to it, and all fully static types +are subtypes of it: + +```py +from typing import Protocol + +class UniversalSet(Protocol): ... + +static_assert(is_assignable_to(object, UniversalSet)) +static_assert(is_subtype_of(object, UniversalSet)) +``` + +Which means that `UniversalSet` here is in fact an equivalent type to `object`: + +```py +from ty_extensions import is_equivalent_to + +static_assert(is_equivalent_to(UniversalSet, object)) +``` + +`object` is a subtype of certain other protocols too. Since all fully static types (whether nominal +or structural) are subtypes of `object`, these protocols are also subtypes of `object`; and this +means that these protocols are also equivalent to `UniversalSet` and `object`: + +```py +class SupportsStr(Protocol): + def __str__(self) -> str: ... + +static_assert(is_equivalent_to(SupportsStr, UniversalSet)) +static_assert(is_equivalent_to(SupportsStr, object)) + +class SupportsClass(Protocol): + @property + def __class__(self) -> type: ... + +static_assert(is_equivalent_to(SupportsClass, UniversalSet)) +static_assert(is_equivalent_to(SupportsClass, SupportsStr)) +static_assert(is_equivalent_to(SupportsClass, object)) +``` + +If a protocol contains members that are not defined on `object`, then that protocol will (like all +types in Python) still be assignable to `object`, but `object` will not be assignable to that +protocol: + +```py +static_assert(is_assignable_to(HasX, object)) +static_assert(is_subtype_of(HasX, object)) +static_assert(not is_assignable_to(object, HasX)) +static_assert(not is_subtype_of(object, HasX)) +``` + +But `object` is the *only* fully static nominal type that a protocol type can ever be assignable to +or a subtype of: + +```py +static_assert(not is_assignable_to(HasX, Foo)) +static_assert(not is_subtype_of(HasX, Foo)) +``` + +## Equivalence of protocols + +Two protocols are considered equivalent types if they specify the same interface, even if they have +different names: + +```py +from typing import Protocol +from ty_extensions import is_equivalent_to, static_assert + +class HasX(Protocol): + x: int + +class AlsoHasX(Protocol): + x: int + +static_assert(is_equivalent_to(HasX, AlsoHasX)) +``` + +And unions containing equivalent protocols are recognised as equivalent, even when the order is not +identical: + +```py +class HasY(Protocol): + y: str + +class AlsoHasY(Protocol): + y: str + +class A: ... +class B: ... + +static_assert(is_equivalent_to(A | HasX | B | HasY, B | AlsoHasY | AlsoHasX | A)) +``` + +Protocols are considered equivalent if their members are equivalent, even if those members are +differently ordered unions: + +```py +class C: ... + +class UnionProto1(Protocol): + x: A | B | C + +class UnionProto2(Protocol): + x: C | A | B + +static_assert(is_equivalent_to(UnionProto1, UnionProto2)) +static_assert(is_equivalent_to(UnionProto1 | A | B, B | UnionProto2 | A)) +``` + +## Intersections of protocols + +An intersection of two protocol types `X` and `Y` is equivalent to a protocol type `Z` that inherits +from both `X` and `Y`: + +```py +from typing import Protocol +from ty_extensions import Intersection, static_assert, is_equivalent_to + +class HasX(Protocol): + x: int + +class HasY(Protocol): + y: str + +class HasXAndYProto(HasX, HasY, Protocol): ... + +# TODO: this should pass +static_assert(is_equivalent_to(HasXAndYProto, Intersection[HasX, HasY])) # error: [static-assert-error] +``` + +But this is only true if the subclass has `Protocol` in its explicit bases (otherwise, it is a +nominal type rather than a structural type): + +```py +class HasXAndYNominal(HasX, HasY): ... + +static_assert(not is_equivalent_to(HasXAndYNominal, Intersection[HasX, HasY])) +``` + +A protocol type `X` and a nominal type `Y` can be inferred as disjoint types if `Y` is a `@final` +type and `Y` does not satisfy the interface declared by `X`. But if `Y` is not `@final`, then this +does not hold true, since a subclass of `Y` could always provide additional methods or attributes +that would lead to it satisfying `X`'s interface: + +```py +from typing import final +from ty_extensions import is_disjoint_from + +class NotFinalNominal: ... + +@final +class FinalNominal: ... + +static_assert(not is_disjoint_from(NotFinalNominal, HasX)) +static_assert(is_disjoint_from(FinalNominal, HasX)) + +def _(arg1: Intersection[HasX, NotFinalNominal], arg2: Intersection[HasX, FinalNominal]): + reveal_type(arg1) # revealed: HasX & NotFinalNominal + reveal_type(arg2) # revealed: Never +``` + +## Satisfying a protocol's interface + +A type does not have to be an `Instance` type in order to be a subtype of a protocol. Other +protocols can be a subtype of a protocol, as can `ModuleLiteral` types, `ClassLiteral` types, and +others. Another protocol can be a subtype of `HasX` either through "explicit" (nominal) inheritance +from `HasX`, or by specifying a superset of `HasX`'s interface: + +`module.py`: + +```py +x: int = 42 +``` + +`main.py`: + +```py +import module +from typing import Protocol +from ty_extensions import is_subtype_of, is_assignable_to, static_assert, TypeOf + +class HasX(Protocol): + x: int + +# TODO: this should pass +static_assert(is_subtype_of(TypeOf[module], HasX)) # error: [static-assert-error] +static_assert(is_assignable_to(TypeOf[module], HasX)) + +class ExplicitProtocolSubtype(HasX, Protocol): + y: int + +static_assert(is_subtype_of(ExplicitProtocolSubtype, HasX)) +static_assert(is_assignable_to(ExplicitProtocolSubtype, HasX)) + +class ImplicitProtocolSubtype(Protocol): + x: int + y: str + +static_assert(is_subtype_of(ImplicitProtocolSubtype, HasX)) +static_assert(is_assignable_to(ImplicitProtocolSubtype, HasX)) + +class Meta(type): + x: int + +class UsesMeta(metaclass=Meta): ... + +# TODO: these should pass +static_assert(is_subtype_of(UsesMeta, HasX)) # error: [static-assert-error] +static_assert(is_assignable_to(UsesMeta, HasX)) # error: [static-assert-error] +``` + +## `ClassVar` attribute members + +If a protocol `ClassVarX` has a `ClassVar` attribute member `x` with type `int`, this indicates that +a readable `x` attribute must be accessible on any inhabitant of `ClassVarX`, and that a readable +`x` attribute must *also* be accessible on the *type* of that inhabitant: + +`classvars.py`: + +```py +from typing import ClassVar, Protocol +from ty_extensions import is_subtype_of, is_assignable_to, static_assert + +class ClassVarXProto(Protocol): + x: ClassVar[int] + +def f(obj: ClassVarXProto): + reveal_type(obj.x) # revealed: int + reveal_type(type(obj).x) # revealed: int + obj.x = 42 # error: [invalid-attribute-access] "Cannot assign to ClassVar `x` from an instance of type `ClassVarXProto`" + +class InstanceAttrX: + x: int + +# TODO: these should pass +static_assert(not is_assignable_to(InstanceAttrX, ClassVarXProto)) # error: [static-assert-error] +static_assert(not is_subtype_of(InstanceAttrX, ClassVarXProto)) # error: [static-assert-error] + +class PropertyX: + @property + def x(self) -> int: + return 42 + +# TODO: these should pass +static_assert(not is_assignable_to(PropertyX, ClassVarXProto)) # error: [static-assert-error] +static_assert(not is_subtype_of(PropertyX, ClassVarXProto)) # error: [static-assert-error] + +class ClassVarX: + x: ClassVar[int] = 42 + +static_assert(is_assignable_to(ClassVarX, ClassVarXProto)) +static_assert(is_subtype_of(ClassVarX, ClassVarXProto)) +``` + +This is mentioned by the +[spec](https://typing.python.org/en/latest/spec/protocol.html#protocol-members) and tested in the +[conformance suite](https://github.com/python/typing/blob/main/conformance/tests/protocols_definition.py) +as something that must be supported by type checkers: + +> To distinguish between protocol class variables and protocol instance variables, the special +> `ClassVar` annotation should be used. + +## Subtyping of protocols with property members + +A read-only property on a protocol can be satisfied by a mutable attribute, a read-only property, a +read/write property, a `Final` attribute, or a `ClassVar` attribute: + +```py +from typing import ClassVar, Final, Protocol +from ty_extensions import is_subtype_of, is_assignable_to, static_assert + +class HasXProperty(Protocol): + @property + def x(self) -> int: ... + +class XAttr: + x: int + +static_assert(is_subtype_of(XAttr, HasXProperty)) +static_assert(is_assignable_to(XAttr, HasXProperty)) + +class XReadProperty: + @property + def x(self) -> int: + return 42 + +static_assert(is_subtype_of(XReadProperty, HasXProperty)) +static_assert(is_assignable_to(XReadProperty, HasXProperty)) + +class XReadWriteProperty: + @property + def x(self) -> int: + return 42 + + @x.setter + def x(self, val: int) -> None: ... + +static_assert(is_subtype_of(XReadWriteProperty, HasXProperty)) +static_assert(is_assignable_to(XReadWriteProperty, HasXProperty)) + +class XClassVar: + x: ClassVar[int] = 42 + +static_assert(is_subtype_of(XClassVar, HasXProperty)) +static_assert(is_assignable_to(XClassVar, HasXProperty)) + +class XFinal: + x: Final = 42 + +static_assert(is_subtype_of(XFinal, HasXProperty)) +static_assert(is_assignable_to(XFinal, HasXProperty)) +``` + +A read-only property on a protocol, unlike a mutable attribute, is covariant: `XSub` in the below +example satisfies the `HasXProperty` interface even though the type of the `x` attribute on `XSub` +is a subtype of `int` rather than being exactly `int`. + +```py +class MyInt(int): ... + +class XSub: + x: MyInt + +static_assert(is_subtype_of(XSub, HasXProperty)) +static_assert(is_assignable_to(XSub, HasXProperty)) +``` + +A read/write property on a protocol, where the getter returns the same type that the setter takes, +is equivalent to a normal mutable attribute on a protocol. + +```py +class HasMutableXProperty(Protocol): + @property + def x(self) -> int: ... + @x.setter + def x(self, val: int) -> None: ... + +class XAttr: + x: int + +static_assert(is_subtype_of(XAttr, HasXProperty)) +static_assert(is_assignable_to(XAttr, HasXProperty)) + +class XReadProperty: + @property + def x(self) -> int: + return 42 + +# TODO: these should pass +static_assert(not is_subtype_of(XReadProperty, HasXProperty)) # error: [static-assert-error] +static_assert(not is_assignable_to(XReadProperty, HasXProperty)) # error: [static-assert-error] + +class XReadWriteProperty: + @property + def x(self) -> int: + return 42 + + @x.setter + def x(self, val: int) -> None: ... + +static_assert(is_subtype_of(XReadWriteProperty, HasXProperty)) +static_assert(is_assignable_to(XReadWriteProperty, HasXProperty)) + +class XSub: + x: MyInt + +# TODO: should pass +static_assert(not is_subtype_of(XSub, HasXProperty)) # error: [static-assert-error] +static_assert(not is_assignable_to(XSub, HasXProperty)) # error: [static-assert-error] +``` + +A protocol with a read/write property `x` is exactly equivalent to a protocol with a mutable +attribute `x`. Both are subtypes of a protocol with a read-only prooperty `x`: + +```py +from ty_extensions import is_equivalent_to + +class HasMutableXAttr(Protocol): + x: int + +# TODO: should pass +static_assert(is_equivalent_to(HasMutableXAttr, HasMutableXProperty)) # error: [static-assert-error] + +static_assert(is_subtype_of(HasMutableXAttr, HasXProperty)) +static_assert(is_assignable_to(HasMutableXAttr, HasXProperty)) + +static_assert(is_subtype_of(HasMutableXProperty, HasXProperty)) +static_assert(is_assignable_to(HasMutableXProperty, HasXProperty)) +``` + +A read/write property on a protocol, where the setter accepts a subtype of the type returned by the +getter, can be satisfied by a mutable attribute of any type bounded by the upper bound of the +getter-returned type and the lower bound of the setter-accepted type. + +This follows from the principle that a type `X` can only be a subtype of a given protocol if the +`X`'s behaviour is a superset of the behaviour specified by the interface declared by the protocol. +In the below example, the behaviour of an instance of `XAttr` is a superset of the behaviour +specified by the protocol `HasAsymmetricXProperty`. The protocol specifies that reading an `x` +attribute on the instance must resolve to an instance of `int` or a subclass thereof, and `XAttr` +satisfies this requirement. The protocol also specifies that you must be able to assign instances of +`MyInt` to the `x` attribute, and again this is satisfied by `XAttr`: on instances of `XAttr`, you +can assign *any* instance of `int` to the `x` attribute, and thus by extension you can assign any +instance of `IntSub` to the `x` attribute, since any instance of `IntSub` is an instance of `int`: + +```py +class HasAsymmetricXProperty(Protocol): + @property + def x(self) -> int: ... + @x.setter + def x(self, val: MyInt) -> None: ... + +class XAttr: + x: int + +static_assert(is_subtype_of(XAttr, HasAsymmetricXProperty)) +static_assert(is_assignable_to(XAttr, HasAsymmetricXProperty)) +``` + +The end conclusion of this is that the getter-returned type of a property is always covariant and +the setter-accepted type is always contravariant. The combination of these leads to invariance for a +regular mutable attribute, where the implied getter-returned and setter-accepted types are the same. + +```py +class XAttrSub: + x: MyInt + +static_assert(is_subtype_of(XAttrSub, HasAsymmetricXProperty)) +static_assert(is_assignable_to(XAttrSub, HasAsymmetricXProperty)) + +class MyIntSub(MyInt): + pass + +class XAttrSubSub: + x: MyIntSub + +# TODO: should pass +static_assert(not is_subtype_of(XAttrSubSub, HasAsymmetricXProperty)) # error: [static-assert-error] +static_assert(not is_assignable_to(XAttrSubSub, HasAsymmetricXProperty)) # error: [static-assert-error] +``` + +An asymmetric property on a protocol can also be satisfied by an asymmetric property on a nominal +class whose getter and setter types satisfy the covariant and contravariant requirements, +respectively. + +```py +class XAsymmetricProperty: + @property + def x(self) -> MyInt: + return MyInt(0) + + @x.setter + def x(self, x: int) -> None: ... + +static_assert(is_subtype_of(XAsymmetricProperty, HasAsymmetricXProperty)) +static_assert(is_assignable_to(XAsymmetricProperty, HasAsymmetricXProperty)) +``` + +A custom descriptor attribute on the nominal class will also suffice: + +```py +class Descriptor: + def __get__(self, instance, owner) -> MyInt: + return MyInt(0) + + def __set__(self, value: int) -> None: ... + +class XCustomDescriptor: + x: Descriptor = Descriptor() + +static_assert(is_subtype_of(XCustomDescriptor, HasAsymmetricXProperty)) +static_assert(is_assignable_to(XCustomDescriptor, HasAsymmetricXProperty)) +``` + +Moreover, a read-only property on a protocol can be satisfied by a nominal class that defines a +`__getattr__` method returning a suitable type. A read/write property can be satisfied by a nominal +class that defines a `__getattr__` method returning a suitable type *and* a `__setattr__` method +accepting a suitable type: + +```py +class HasGetAttr: + def __getattr__(self, attr: str) -> int: + return 42 + +static_assert(is_subtype_of(HasGetAttr, HasXProperty)) +static_assert(is_assignable_to(HasGetAttr, HasXProperty)) + +# TODO: these should pass +static_assert(not is_subtype_of(HasGetAttr, HasMutableXAttr)) # error: [static-assert-error] +static_assert(not is_subtype_of(HasGetAttr, HasMutableXAttr)) # error: [static-assert-error] + +class HasGetAttrWithUnsuitableReturn: + def __getattr__(self, attr: str) -> tuple[int, int]: + return (1, 2) + +# TODO: these should pass +static_assert(not is_subtype_of(HasGetAttrWithUnsuitableReturn, HasXProperty)) # error: [static-assert-error] +static_assert(not is_assignable_to(HasGetAttrWithUnsuitableReturn, HasXProperty)) # error: [static-assert-error] + +class HasGetAttrAndSetAttr: + def __getattr__(self, attr: str) -> MyInt: + return MyInt(0) + + def __setattr__(self, attr: str, value: int) -> None: ... + +static_assert(is_subtype_of(HasGetAttrAndSetAttr, HasXProperty)) +static_assert(is_assignable_to(HasGetAttrAndSetAttr, HasXProperty)) + +# TODO: these should pass +static_assert(is_subtype_of(HasGetAttrAndSetAttr, XAsymmetricProperty)) # error: [static-assert-error] +static_assert(is_assignable_to(HasGetAttrAndSetAttr, XAsymmetricProperty)) # error: [static-assert-error] +``` + +## Narrowing of protocols + +<!-- snapshot-diagnostics --> + +By default, a protocol class cannot be used as the second argument to `isinstance()` or +`issubclass()`, and a type checker must emit an error on such calls. However, we still narrow the +type inside these branches (this matches the behaviour of other type checkers): + +```py +from typing_extensions import Protocol, reveal_type + +class HasX(Protocol): + x: int + +def f(arg: object, arg2: type): + if isinstance(arg, HasX): # error: [invalid-argument-type] + reveal_type(arg) # revealed: HasX + else: + reveal_type(arg) # revealed: ~HasX + + if issubclass(arg2, HasX): # error: [invalid-argument-type] + reveal_type(arg2) # revealed: type[HasX] + else: + reveal_type(arg2) # revealed: type & ~type[HasX] +``` + +A protocol class decorated with `@typing(_extensions).runtime_checkable` *can* be used as the second +argument to `isisinstance()` at runtime: + +```py +from typing import runtime_checkable + +@runtime_checkable +class RuntimeCheckableHasX(Protocol): + x: int + +def f(arg: object): + if isinstance(arg, RuntimeCheckableHasX): # no error! + reveal_type(arg) # revealed: RuntimeCheckableHasX + else: + reveal_type(arg) # revealed: ~RuntimeCheckableHasX +``` + +but in order for a protocol class to be used as the second argument to `issubclass()`, it must +satisfy two conditions: + +1. It must be decorated with `@runtime_checkable` +1. It must *only* have method members (protocols with attribute members are not permitted) + +```py +@runtime_checkable +class OnlyMethodMembers(Protocol): + def method(self) -> None: ... + +def f(arg1: type, arg2: type): + if issubclass(arg1, RuntimeCheckableHasX): # TODO: should emit an error here (has non-method members) + reveal_type(arg1) # revealed: type[RuntimeCheckableHasX] + else: + reveal_type(arg1) # revealed: type & ~type[RuntimeCheckableHasX] + + if issubclass(arg2, OnlyMethodMembers): # no error! + reveal_type(arg2) # revealed: type[OnlyMethodMembers] + else: + reveal_type(arg2) # revealed: type & ~type[OnlyMethodMembers] +``` + +## Truthiness of protocol instance + +An instance of a protocol type generally has ambiguous truthiness: + +```py +from typing import Protocol + +class Foo(Protocol): + x: int + +def f(foo: Foo): + reveal_type(bool(foo)) # revealed: bool +``` + +But this is not the case if the protocol has a `__bool__` method member that returns `Literal[True]` +or `Literal[False]`: + +```py +from typing import Literal + +class Truthy(Protocol): + def __bool__(self) -> Literal[True]: ... + +class FalsyFoo(Foo, Protocol): + def __bool__(self) -> Literal[False]: ... + +class FalsyFooSubclass(FalsyFoo, Protocol): + y: str + +def g(a: Truthy, b: FalsyFoo, c: FalsyFooSubclass): + reveal_type(bool(a)) # revealed: Literal[True] + reveal_type(bool(b)) # revealed: Literal[False] + reveal_type(bool(c)) # revealed: Literal[False] +``` + +It is not sufficient for a protocol to have a callable `__bool__` instance member that returns +`Literal[True]` for it to be considered always truthy. Dunder methods are looked up on the class +rather than the instance. If a protocol `X` has an instance-attribute `__bool__` member, it is +unknowable whether that attribute can be accessed on the type of an object that satisfies `X`'s +interface: + +```py +from typing import Callable + +class InstanceAttrBool(Protocol): + __bool__: Callable[[], Literal[True]] + +def h(obj: InstanceAttrBool): + reveal_type(bool(obj)) # revealed: bool +``` + +## Fully static protocols; gradual protocols + +A protocol is only fully static if all of its members are fully static: + +```py +from typing import Protocol, Any +from ty_extensions import is_fully_static, static_assert + +class FullyStatic(Protocol): + x: int + +class NotFullyStatic(Protocol): + x: Any + +static_assert(is_fully_static(FullyStatic)) +static_assert(not is_fully_static(NotFullyStatic)) +``` + +Non-fully-static protocols do not participate in subtyping or equivalence, only assignability and +gradual equivalence: + +```py +from ty_extensions import is_subtype_of, is_assignable_to, is_equivalent_to, is_gradual_equivalent_to + +class NominalWithX: + x: int = 42 + +static_assert(is_assignable_to(NominalWithX, FullyStatic)) +static_assert(is_assignable_to(NominalWithX, NotFullyStatic)) + +static_assert(not is_subtype_of(FullyStatic, NotFullyStatic)) +static_assert(is_assignable_to(FullyStatic, NotFullyStatic)) + +static_assert(not is_subtype_of(NotFullyStatic, FullyStatic)) +static_assert(is_assignable_to(NotFullyStatic, FullyStatic)) + +static_assert(not is_subtype_of(NominalWithX, NotFullyStatic)) +static_assert(is_assignable_to(NominalWithX, NotFullyStatic)) + +static_assert(is_subtype_of(NominalWithX, FullyStatic)) + +static_assert(is_equivalent_to(FullyStatic, FullyStatic)) +static_assert(not is_equivalent_to(NotFullyStatic, NotFullyStatic)) + +static_assert(is_gradual_equivalent_to(FullyStatic, FullyStatic)) +static_assert(is_gradual_equivalent_to(NotFullyStatic, NotFullyStatic)) + +class AlsoNotFullyStatic(Protocol): + x: Any + +static_assert(not is_equivalent_to(NotFullyStatic, AlsoNotFullyStatic)) +static_assert(is_gradual_equivalent_to(NotFullyStatic, AlsoNotFullyStatic)) +``` + +Empty protocols are fully static; this follows from the fact that an empty protocol is equivalent to +the nominal type `object` (as described above): + +```py +class Empty(Protocol): ... + +static_assert(is_fully_static(Empty)) +``` + +A method member is only considered fully static if all its parameter annotations and its return +annotation are fully static: + +```py +class FullyStaticMethodMember(Protocol): + def method(self, x: int) -> str: ... + +class DynamicParameter(Protocol): + def method(self, x: Any) -> str: ... + +class DynamicReturn(Protocol): + def method(self, x: int) -> Any: ... + +static_assert(is_fully_static(FullyStaticMethodMember)) + +# TODO: these should pass +static_assert(not is_fully_static(DynamicParameter)) # error: [static-assert-error] +static_assert(not is_fully_static(DynamicReturn)) # error: [static-assert-error] +``` + +The [typing spec][spec_protocol_members] states: + +> If any parameters of a protocol method are not annotated, then their types are assumed to be `Any` + +Thus, a partially unannotated method member can also not be considered to be fully static: + +```py +class NoParameterAnnotation(Protocol): + def method(self, x) -> str: ... + +class NoReturnAnnotation(Protocol): + def method(self, x: int): ... + +# TODO: these should pass +static_assert(not is_fully_static(NoParameterAnnotation)) # error: [static-assert-error] +static_assert(not is_fully_static(NoReturnAnnotation)) # error: [static-assert-error] +``` + +## Callable protocols + +An instance of a protocol type is callable if the protocol defines a `__call__` method: + +```py +from typing import Protocol + +class CallMeMaybe(Protocol): + def __call__(self, x: int) -> str: ... + +def f(obj: CallMeMaybe): + reveal_type(obj(42)) # revealed: str + obj("bar") # error: [invalid-argument-type] +``` + +An instance of a protocol like this can be assignable to a `Callable` type, but only if it has the +right signature: + +```py +from typing import Callable +from ty_extensions import is_subtype_of, is_assignable_to, static_assert + +static_assert(is_subtype_of(CallMeMaybe, Callable[[int], str])) +static_assert(is_assignable_to(CallMeMaybe, Callable[[int], str])) +static_assert(not is_subtype_of(CallMeMaybe, Callable[[str], str])) +static_assert(not is_assignable_to(CallMeMaybe, Callable[[str], str])) +static_assert(not is_subtype_of(CallMeMaybe, Callable[[CallMeMaybe, int], str])) +static_assert(not is_assignable_to(CallMeMaybe, Callable[[CallMeMaybe, int], str])) + +def g(obj: Callable[[int], str], obj2: CallMeMaybe, obj3: Callable[[str], str]): + obj = obj2 + obj3 = obj2 # error: [invalid-assignment] +``` + +By the same token, a `Callable` type can also be assignable to a protocol-instance type if the +signature implied by the `Callable` type is assignable to the signature of the `__call__` method +specified by the protocol: + +```py +from ty_extensions import TypeOf + +class Foo(Protocol): + def __call__(self, x: int, /) -> str: ... + +static_assert(is_subtype_of(Callable[[int], str], Foo)) +static_assert(is_assignable_to(Callable[[int], str], Foo)) + +# TODO: these should pass +static_assert(not is_subtype_of(Callable[[str], str], Foo)) # error: [static-assert-error] +static_assert(not is_assignable_to(Callable[[str], str], Foo)) # error: [static-assert-error] +static_assert(not is_subtype_of(Callable[[CallMeMaybe, int], str], Foo)) # error: [static-assert-error] +static_assert(not is_assignable_to(Callable[[CallMeMaybe, int], str], Foo)) # error: [static-assert-error] + +def h(obj: Callable[[int], str], obj2: Foo, obj3: Callable[[str], str]): + obj2 = obj + + # TODO: we should emit [invalid-assignment] here because the signature of `obj3` is not assignable + # to the declared type of `obj2` + obj2 = obj3 + +def satisfies_foo(x: int) -> str: + return "foo" + +static_assert(is_subtype_of(TypeOf[satisfies_foo], Foo)) +static_assert(is_assignable_to(TypeOf[satisfies_foo], Foo)) +``` + +## Protocols are never singleton types, and are never single-valued types + +It *might* be possible to have a singleton protocol-instance type...? + +For example, `WeirdAndWacky` in the following snippet only has a single possible inhabitant: `None`! +It is thus a singleton type. However, going out of our way to recognise it as such is probably not +worth it. Such cases should anyway be exceedingly rare and/or contrived. + +```py +from typing import Protocol, Callable +from ty_extensions import is_singleton, is_single_valued + +class WeirdAndWacky(Protocol): + @property + def __class__(self) -> Callable[[], None]: ... + +reveal_type(is_singleton(WeirdAndWacky)) # revealed: Literal[False] +reveal_type(is_single_valued(WeirdAndWacky)) # revealed: Literal[False] +``` + +## Integration test: `typing.SupportsIndex` and `typing.Sized` + +`typing.SupportsIndex` and `typing.Sized` are two protocols that are very commonly used in the wild. + +```py +from typing import SupportsIndex, Sized, Literal + +def one(some_int: int, some_literal_int: Literal[1], some_indexable: SupportsIndex): + a: SupportsIndex = some_int + b: SupportsIndex = some_literal_int + c: SupportsIndex = some_indexable + +def two(some_list: list, some_tuple: tuple[int, str], some_sized: Sized): + a: Sized = some_list + b: Sized = some_tuple + c: Sized = some_sized +``` + +## Recursive protocols + +### Properties + +```py +from __future__ import annotations + +from typing import Protocol, Any +from ty_extensions import is_fully_static, static_assert, is_assignable_to, is_subtype_of, is_equivalent_to + +class RecursiveFullyStatic(Protocol): + parent: RecursiveFullyStatic + x: int + +class RecursiveNonFullyStatic(Protocol): + parent: RecursiveNonFullyStatic + x: Any + +static_assert(is_fully_static(RecursiveFullyStatic)) +static_assert(not is_fully_static(RecursiveNonFullyStatic)) + +static_assert(not is_subtype_of(RecursiveFullyStatic, RecursiveNonFullyStatic)) +static_assert(not is_subtype_of(RecursiveNonFullyStatic, RecursiveFullyStatic)) + +static_assert(is_assignable_to(RecursiveNonFullyStatic, RecursiveNonFullyStatic)) +static_assert(is_assignable_to(RecursiveFullyStatic, RecursiveNonFullyStatic)) +static_assert(is_assignable_to(RecursiveNonFullyStatic, RecursiveFullyStatic)) + +class AlsoRecursiveFullyStatic(Protocol): + parent: AlsoRecursiveFullyStatic + x: int + +static_assert(is_equivalent_to(AlsoRecursiveFullyStatic, RecursiveFullyStatic)) + +class RecursiveOptionalParent(Protocol): + parent: RecursiveOptionalParent | None + +static_assert(is_fully_static(RecursiveOptionalParent)) + +static_assert(is_assignable_to(RecursiveOptionalParent, RecursiveOptionalParent)) + +static_assert(is_assignable_to(RecursiveNonFullyStatic, RecursiveOptionalParent)) +static_assert(not is_assignable_to(RecursiveOptionalParent, RecursiveNonFullyStatic)) + +class Other(Protocol): + z: str + +def _(rec: RecursiveFullyStatic, other: Other): + reveal_type(rec.parent.parent.parent) # revealed: RecursiveFullyStatic + + rec.parent.parent.parent = rec + rec = rec.parent.parent.parent + + rec.parent.parent.parent = other # error: [invalid-assignment] + other = rec.parent.parent.parent # error: [invalid-assignment] + +class Foo(Protocol): + @property + def x(self) -> "Foo": ... + +class Bar(Protocol): + @property + def x(self) -> "Bar": ... + +# TODO: this should pass +# error: [static-assert-error] +static_assert(is_equivalent_to(Foo, Bar)) +``` + +### Nested occurrences of self-reference + +Make sure that we handle self-reference correctly, even if the self-reference appears deeply nested +within the type of a protocol member: + +```toml +[environment] +python-version = "3.12" +``` + +```py +from __future__ import annotations + +from typing import Protocol, Callable +from ty_extensions import Intersection, Not, is_fully_static, is_assignable_to, is_equivalent_to, static_assert + +class C: ... + +class GenericC[T](Protocol): + pass + +class Recursive(Protocol): + direct: Recursive + + union: None | Recursive + + intersection1: Intersection[C, Recursive] + intersection2: Intersection[C, Not[Recursive]] + + t: tuple[int, tuple[str, Recursive]] + + callable1: Callable[[int], Recursive] + callable2: Callable[[Recursive], int] + + subtype_of: type[Recursive] + + generic: GenericC[Recursive] + + def method(self, x: Recursive) -> Recursive: ... + + nested: Recursive | Callable[[Recursive | Recursive, tuple[Recursive, Recursive]], Recursive | Recursive] + +static_assert(is_fully_static(Recursive)) +static_assert(is_equivalent_to(Recursive, Recursive)) +static_assert(is_assignable_to(Recursive, Recursive)) + +def _(r: Recursive): + reveal_type(r.direct) # revealed: Recursive + reveal_type(r.union) # revealed: None | Recursive + reveal_type(r.intersection1) # revealed: C & Recursive + reveal_type(r.intersection2) # revealed: C & ~Recursive + reveal_type(r.t) # revealed: tuple[int, tuple[str, Recursive]] + reveal_type(r.callable1) # revealed: (int, /) -> Recursive + reveal_type(r.callable2) # revealed: (Recursive, /) -> int + reveal_type(r.subtype_of) # revealed: type[Recursive] + reveal_type(r.generic) # revealed: GenericC[Recursive] + reveal_type(r.method(r)) # revealed: Recursive + reveal_type(r.nested) # revealed: Recursive | ((Recursive, tuple[Recursive, Recursive], /) -> Recursive) + + reveal_type(r.method(r).callable1(1).direct.t[1][1]) # revealed: Recursive +``` + +### Regression test: narrowing with self-referential protocols + +This snippet caused us to panic on an early version of the implementation for protocols. + +```py +from typing import Protocol + +class A(Protocol): + def x(self) -> "B | A": ... + +class B(Protocol): + def y(self): ... + +obj = something_unresolvable # error: [unresolved-reference] +reveal_type(obj) # revealed: Unknown +if isinstance(obj, (B, A)): + reveal_type(obj) # revealed: (Unknown & B) | (Unknown & A) +``` + +## TODO + +Add tests for: + +- More tests for protocols inside `type[]`. [Spec reference][protocols_inside_type_spec]. +- Protocols with instance-method members, including: + - Protocols with methods that have parameters or the return type unannotated + - Protocols with methods that have parameters or the return type annotated with `Any` +- Protocols with `@classmethod` and `@staticmethod` +- Assignability of non-instance types to protocols with instance-method members (e.g. a + class-literal type can be a subtype of `Sized` if its metaclass has a `__len__` method) +- Protocols with methods that have annotated `self` parameters. + [Spec reference][self_types_protocols_spec]. +- Protocols with overloaded method members +- `super()` on nominal subtypes (explicit and implicit) of protocol classes +- [Recursive protocols][recursive_protocols_spec] +- Generic protocols +- Non-generic protocols with function-scoped generic methods +- Protocols with instance attributes annotated with `Callable` (can a nominal type with a method + satisfy that protocol, and if so in what cases?) +- Protocols decorated with `@final` +- Equivalence and subtyping between `Callable` types and protocols that define `__call__` + +[mypy_protocol_docs]: https://mypy.readthedocs.io/en/stable/protocols.html#protocols-and-structural-subtyping +[mypy_protocol_tests]: https://github.com/python/mypy/blob/master/test-data/unit/check-protocols.test +[protocol conformance tests]: https://github.com/python/typing/tree/main/conformance/tests +[protocols_inside_type_spec]: https://typing.python.org/en/latest/spec/protocol.html#type-and-class-objects-vs-protocols +[recursive_protocols_spec]: https://typing.python.org/en/latest/spec/protocol.html#recursive-protocols +[self_types_protocols_spec]: https://typing.python.org/en/latest/spec/protocol.html#self-types-in-protocols +[spec_protocol_members]: https://typing.python.org/en/latest/spec/protocol.html#protocol-members +[typing_spec_protocols]: https://typing.python.org/en/latest/spec/protocol.html diff --git a/crates/ty_python_semantic/resources/mdtest/regression/14334_diagnostics_in_wrong_file.md b/crates/ty_python_semantic/resources/mdtest/regression/14334_diagnostics_in_wrong_file.md new file mode 100644 index 0000000000000..d7d50db5e6b96 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/regression/14334_diagnostics_in_wrong_file.md @@ -0,0 +1,17 @@ +# Regression test for #14334 + +Regression test for [this issue](https://github.com/astral-sh/ruff/issues/14334). + +`base.py`: + +```py +# error: [invalid-base] +class Base(2): ... +``` + +`a.py`: + +```py +# No error here +from base import Base +``` diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/builtin.md b/crates/ty_python_semantic/resources/mdtest/scopes/builtin.md new file mode 100644 index 0000000000000..fc2ca70f97bab --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/builtin.md @@ -0,0 +1,32 @@ +# Builtin scope + +## Conditionally global or builtin + +If a builtin name is conditionally defined as a global, a name lookup should union the builtin type +with the conditionally-defined type: + +```py +def returns_bool() -> bool: + return True + +if returns_bool(): + chr: int = 1 + +def f(): + reveal_type(chr) # revealed: int | (def chr(i: SupportsIndex, /) -> str) +``` + +## Conditionally global or builtin, with annotation + +Same is true if the name is annotated: + +```py +def returns_bool() -> bool: + return True + +if returns_bool(): + chr: int = 1 + +def f(): + reveal_type(chr) # revealed: int | (def chr(i: SupportsIndex, /) -> str) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/eager.md b/crates/ty_python_semantic/resources/mdtest/scopes/eager.md new file mode 100644 index 0000000000000..bfd11b667716c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/eager.md @@ -0,0 +1,412 @@ +# Eager scopes + +Some scopes are executed eagerly: references to variables defined in enclosing scopes are resolved +_immediately_. This is in contrast to (for instance) function scopes, where those references are +resolved when the function is called. + +## Function definitions + +Function definitions are evaluated lazily. + +```py +x = 1 + +def f(): + reveal_type(x) # revealed: Unknown | Literal[2] + +x = 2 +``` + +## Class definitions + +Class definitions are evaluated eagerly. + +```py +def _(): + x = 1 + + class A: + reveal_type(x) # revealed: Literal[1] + + y = x + + x = 2 + + reveal_type(A.y) # revealed: Unknown | Literal[1] +``` + +## List comprehensions + +List comprehensions are evaluated eagerly. + +```py +def _(): + x = 1 + + # revealed: Literal[1] + [reveal_type(x) for a in range(1)] + + x = 2 +``` + +## Set comprehensions + +Set comprehensions are evaluated eagerly. + +```py +def _(): + x = 1 + + # revealed: Literal[1] + {reveal_type(x) for a in range(1)} + + x = 2 +``` + +## Dict comprehensions + +Dict comprehensions are evaluated eagerly. + +```py +def _(): + x = 1 + + # revealed: Literal[1] + {a: reveal_type(x) for a in range(1)} + + x = 2 +``` + +## Generator expressions + +Generator expressions don't necessarily run eagerly, but in practice usually they do, so assuming +they do is the better default. + +```py +def _(): + x = 1 + + # revealed: Literal[1] + list(reveal_type(x) for a in range(1)) + + x = 2 +``` + +But that does lead to incorrect results when the generator expression isn't run immediately: + +```py +def evaluated_later(): + x = 1 + + # revealed: Literal[1] + y = (reveal_type(x) for a in range(1)) + + x = 2 + + # The generator isn't evaluated until here, so at runtime, `x` will evaluate to 2, contradicting + # our inferred type. + print(next(y)) +``` + +Though note that “the iterable expression in the leftmost `for` clause is immediately evaluated” +\[[spec][generators]\]: + +```py +def iterable_evaluated_eagerly(): + x = 1 + + # revealed: Literal[1] + y = (a for a in [reveal_type(x)]) + + x = 2 + + # Even though the generator isn't evaluated until here, the first iterable was evaluated + # immediately, so our inferred type is correct. + print(next(y)) +``` + +## Top-level eager scopes + +All of the above examples behave identically when the eager scopes are directly nested in the global +scope. + +### Class definitions + +```py +x = 1 + +class A: + reveal_type(x) # revealed: Literal[1] + + y = x + +x = 2 + +reveal_type(A.y) # revealed: Unknown | Literal[1] +``` + +### List comprehensions + +```py +x = 1 + +# revealed: Literal[1] +[reveal_type(x) for a in range(1)] + +x = 2 + +# error: [unresolved-reference] +[y for a in range(1)] +y = 1 +``` + +### Set comprehensions + +```py +x = 1 + +# revealed: Literal[1] +{reveal_type(x) for a in range(1)} + +x = 2 + +# error: [unresolved-reference] +{y for a in range(1)} +y = 1 +``` + +### Dict comprehensions + +```py +x = 1 + +# revealed: Literal[1] +{a: reveal_type(x) for a in range(1)} + +x = 2 + +# error: [unresolved-reference] +{a: y for a in range(1)} +y = 1 +``` + +### Generator expressions + +```py +x = 1 + +# revealed: Literal[1] +list(reveal_type(x) for a in range(1)) + +x = 2 + +# error: [unresolved-reference] +list(y for a in range(1)) +y = 1 +``` + +`evaluated_later.py`: + +```py +x = 1 + +# revealed: Literal[1] +y = (reveal_type(x) for a in range(1)) + +x = 2 + +# The generator isn't evaluated until here, so at runtime, `x` will evaluate to 2, contradicting +# our inferred type. +print(next(y)) +``` + +`iterable_evaluated_eagerly.py`: + +```py +x = 1 + +# revealed: Literal[1] +y = (a for a in [reveal_type(x)]) + +x = 2 + +# Even though the generator isn't evaluated until here, the first iterable was evaluated +# immediately, so our inferred type is correct. +print(next(y)) +``` + +## Lazy scopes are "sticky" + +As we look through each enclosing scope when resolving a reference, lookups become lazy as soon as +we encounter any lazy scope, even if there are other eager scopes that enclose it. + +### Eager scope within eager scope + +If we don't encounter a lazy scope, lookup remains eager. The resolved binding is not necessarily in +the immediately enclosing scope. Here, the list comprehension and class definition are both eager +scopes, and we immediately resolve the use of `x` to (only) the `x = 1` binding. + +```py +def _(): + x = 1 + + class A: + # revealed: Literal[1] + [reveal_type(x) for a in range(1)] + + x = 2 +``` + +### Class definition bindings are not visible in nested scopes + +Class definitions are eager scopes, but any bindings in them are explicitly not visible to any +nested scopes. (Those nested scopes are typically (lazy) function definitions, but the rule also +applies to nested eager scopes like comprehensions and other class definitions.) + +```py +def _(): + x = 1 + + class A: + x = 4 + + # revealed: Literal[1] + [reveal_type(x) for a in range(1)] + + class B: + # revealed: Literal[1] + [reveal_type(x) for a in range(1)] + + x = 2 + +x = 1 + +def _(): + class C: + # revealed: Unknown | Literal[1] + [reveal_type(x) for _ in [1]] + x = 2 +``` + +### Eager scope within a lazy scope + +The list comprehension is an eager scope, and it is enclosed within a function definition, which is +a lazy scope. Because we pass through this lazy scope before encountering any bindings or +definitions, the lookup is lazy. + +```py +def _(): + x = 1 + + def f(): + # revealed: Unknown | Literal[2] + [reveal_type(x) for a in range(1)] + x = 2 +``` + +### Lazy scope within an eager scope + +The function definition is a lazy scope, and it is enclosed within a class definition, which is an +eager scope. Even though we pass through an eager scope before encountering any bindings or +definitions, the lookup remains lazy. + +```py +def _(): + x = 1 + + class A: + def f(): + # revealed: Unknown | Literal[2] + reveal_type(x) + + x = 2 +``` + +### Lazy scope within a lazy scope + +No matter how many lazy scopes we pass through before encountering a binding or definition, the +lookup remains lazy. + +```py +def _(): + x = 1 + + def f(): + def g(): + # revealed: Unknown | Literal[2] + reveal_type(x) + x = 2 +``` + +### Eager scope within a lazy scope within another eager scope + +We have a list comprehension (eager scope), enclosed within a function definition (lazy scope), +enclosed within a class definition (eager scope), all of which we must pass through before +encountering any binding of `x`. Even though the last scope we pass through is eager, the lookup is +lazy, since we encountered a lazy scope on the way. + +```py +def _(): + x = 1 + + class A: + def f(): + # revealed: Unknown | Literal[2] + [reveal_type(x) for a in range(1)] + + x = 2 +``` + +## Annotations + +Type annotations are sometimes deferred. When they are, the types that are referenced in an +annotation are looked up lazily, even if they occur in an eager scope. + +### Eager annotations in a Python file + +```py +from typing import ClassVar + +x = int + +class C: + var: ClassVar[x] + +reveal_type(C.var) # revealed: int + +x = str +``` + +### Deferred annotations in a Python file + +```py +from __future__ import annotations + +from typing import ClassVar + +x = int + +class C: + var: ClassVar[x] + +reveal_type(C.var) # revealed: Unknown | str + +x = str +``` + +### Deferred annotations in a stub file + +```pyi +from typing import ClassVar + +x = int + +class C: + var: ClassVar[x] + +reveal_type(C.var) # revealed: str + +x = str +``` + +[generators]: https://docs.python.org/3/reference/expressions.html#generator-expressions diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/global.md b/crates/ty_python_semantic/resources/mdtest/scopes/global.md new file mode 100644 index 0000000000000..3e4a884c6d302 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/global.md @@ -0,0 +1,213 @@ +# `global` references + +## Implicit global in function + +A name reference to a never-defined symbol in a function is implicitly a global lookup. + +```py +x = 1 + +def f(): + reveal_type(x) # revealed: Unknown | Literal[1] +``` + +## Explicit global in function + +```py +x = 1 + +def f(): + global x + reveal_type(x) # revealed: Unknown | Literal[1] +``` + +## Unassignable type in function + +```py +x: int = 1 + +def f(): + y: int = 1 + # error: [invalid-assignment] "Object of type `Literal[""]` is not assignable to `int`" + y = "" + + global x + # error: [invalid-assignment] "Object of type `Literal[""]` is not assignable to `int`" + x = "" + + global z + # error: [invalid-assignment] "Object of type `Literal[""]` is not assignable to `int`" + z = "" + +z: int +``` + +## Nested intervening scope + +A `global` statement causes lookup to skip any bindings in intervening scopes: + +```py +x: int = 1 + +def outer(): + x: str = "" + + def inner(): + global x + reveal_type(x) # revealed: int +``` + +## Narrowing + +An assignment following a `global` statement should narrow the type in the local scope after the +assignment. + +```py +x: int | None + +def f(): + global x + x = 1 + reveal_type(x) # revealed: Literal[1] +``` + +## `nonlocal` and `global` + +A binding cannot be both `nonlocal` and `global`. This should emit a semantic syntax error. CPython +marks the `nonlocal` line, while `mypy`, `pyright`, and `ruff` (`PLE0115`) mark the `global` line. + +```py +x = 1 + +def f(): + x = 1 + def g() -> None: + nonlocal x + global x # TODO: error: [invalid-syntax] "name 'x' is nonlocal and global" + x = None +``` + +## Global declaration after `global` statement + +```py +def f(): + global x + y = x + x = 1 # No error. + +x = 2 +``` + +## Semantic syntax errors + +Using a name prior to its `global` declaration in the same scope is a syntax error. + +```py +def f(): + print(x) + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + print(x) + +def f(): + global x + print(x) + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + print(x) + +def f(): + print(x) + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + print(x) + +def f(): + global x, y + print(x) + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + print(x) + +def f(): + x = 1 + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + x = 1 + +def f(): + global x + x = 1 + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + x = 1 + +def f(): + del x + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + global x, y + del x + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + del x + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + global x + del x + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + del x + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + global x, y + del x + global x, y # error: [invalid-syntax] "name `x` is used prior to global declaration" + del x + +def f(): + print(f"{x=}") + global x # error: [invalid-syntax] "name `x` is used prior to global declaration" + +# still an error in module scope +x = None +global x # error: [invalid-syntax] "name `x` is used prior to global declaration" +``` + +## Local bindings override preceding `global` bindings + +```py +x = 42 + +def f(): + global x + reveal_type(x) # revealed: Unknown | Literal[42] + x = "56" + reveal_type(x) # revealed: Literal["56"] +``` + +## Local assignment prevents falling back to the outer scope + +```py +x = 42 + +def f(): + # error: [unresolved-reference] "Name `x` used when not defined" + reveal_type(x) # revealed: Unknown + x = "56" + reveal_type(x) # revealed: Literal["56"] +``` + +## Annotating a `global` binding is a syntax error + +```py +x: int = 1 + +def f(): + global x + x: str = "foo" # TODO: error: [invalid-syntax] "annotated name 'x' can't be global" +``` diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/moduletype_attrs.md b/crates/ty_python_semantic/resources/mdtest/scopes/moduletype_attrs.md new file mode 100644 index 0000000000000..140a4ac72bacb --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/moduletype_attrs.md @@ -0,0 +1,219 @@ +# Implicit globals from `types.ModuleType` + +## Implicit `ModuleType` globals + +All modules are instances of `types.ModuleType`. If a name can't be found in any local or global +scope, we look it up as an attribute on `types.ModuleType` in typeshed before deciding that the name +is unbound. + +```py +reveal_type(__name__) # revealed: str +# Typeshed says this is str | None, but for a pure-Python on-disk module its always str +reveal_type(__file__) # revealed: str +reveal_type(__loader__) # revealed: LoaderProtocol | None +reveal_type(__package__) # revealed: str | None +reveal_type(__doc__) # revealed: str | None +reveal_type(__spec__) # revealed: ModuleSpec | None +reveal_type(__path__) # revealed: MutableSequence[str] +reveal_type(__builtins__) # revealed: Any + +import sys + +reveal_type(sys.__builtins__) # revealed: Any + +from builtins import __builtins__ as __bi__ + +reveal_type(__bi__) # revealed: Any + +class X: + reveal_type(__name__) # revealed: str + +def foo(): + reveal_type(__name__) # revealed: str +``` + +However, three attributes on `types.ModuleType` are not present as implicit module globals; these +are excluded: + +```py +# error: [unresolved-reference] +# revealed: Unknown +reveal_type(__getattr__) + +# error: [unresolved-reference] +# revealed: Unknown +reveal_type(__dict__) + +# error: [unresolved-reference] +# revealed: Unknown +reveal_type(__init__) +``` + +## `ModuleType` globals combined with explicit assignments and declarations + +A `ModuleType` attribute can be overridden in the global scope with a different type, but it must be +a type assignable to the declaration on `ModuleType` unless it is accompanied by an explicit +redeclaration: + +`module.py`: + +```py +__file__ = None +__path__: list[str] = [] +__doc__: int # error: [invalid-declaration] "Cannot declare type `int` for inferred type `str | None`" +# error: [invalid-declaration] "Cannot shadow implicit global attribute `__package__` with declaration of type `int`" +__package__: int = 42 +__spec__ = 42 # error: [invalid-assignment] "Object of type `Literal[42]` is not assignable to `ModuleSpec | None`" +``` + +`main.py`: + +```py +import module + +reveal_type(module.__file__) # revealed: Unknown | None +reveal_type(module.__path__) # revealed: list[str] +reveal_type(module.__doc__) # revealed: Unknown +reveal_type(module.__spec__) # revealed: Unknown | ModuleSpec | None + +def nested_scope(): + global __loader__ + reveal_type(__loader__) # revealed: LoaderProtocol | None + __loader__ = 56 # error: [invalid-assignment] "Object of type `Literal[56]` is not assignable to `LoaderProtocol | None`" +``` + +## Accessed as attributes + +`ModuleType` attributes can also be accessed as attributes on module-literal types. The special +attributes `__dict__` and `__init__`, and all attributes on `builtins.object`, can also be accessed +as attributes on module-literal types, despite the fact that these are inaccessible as globals from +inside the module: + +```py +import typing + +reveal_type(typing.__name__) # revealed: str +reveal_type(typing.__init__) # revealed: bound method ModuleType.__init__(name: str, doc: str | None = ellipsis) -> None + +# For a stub module, we don't know that `__file__` is a string (at runtime it may be entirely +# unset, but we follow typeshed here): +reveal_type(typing.__file__) # revealed: str | None + +# These come from `builtins.object`, not `types.ModuleType`: +reveal_type(typing.__eq__) # revealed: bound method ModuleType.__eq__(value: object, /) -> bool + +reveal_type(typing.__class__) # revealed: <class 'ModuleType'> + +reveal_type(typing.__dict__) # revealed: dict[str, Any] +``` + +Typeshed includes a fake `__getattr__` method in the stub for `types.ModuleType` to help out with +dynamic imports; but we ignore that for module-literal types where we know exactly which module +we're dealing with: + +```py +# error: [unresolved-attribute] +reveal_type(typing.__getattr__) # revealed: Unknown +``` + +## `types.ModuleType.__dict__` takes precedence over global variable `__dict__` + +It's impossible to override the `__dict__` attribute of `types.ModuleType` instances from inside the +module; we should prioritise the attribute in the `types.ModuleType` stub over a variable named +`__dict__` in the module's global namespace: + +`foo.py`: + +```py +__dict__ = "foo" + +reveal_type(__dict__) # revealed: Literal["foo"] +``` + +`bar.py`: + +```py +import foo +from foo import __dict__ as foo_dict + +reveal_type(foo.__dict__) # revealed: dict[str, Any] +reveal_type(foo_dict) # revealed: dict[str, Any] +``` + +## Conditionally global or `ModuleType` attribute + +Attributes overridden in the module namespace take priority. If a builtin name is conditionally +defined as a global, however, a name lookup should union the `ModuleType` type with the +conditionally defined type: + +```py +__file__ = "foo" + +def returns_bool() -> bool: + return True + +if returns_bool(): + __name__ = 1 # error: [invalid-assignment] "Object of type `Literal[1]` is not assignable to `str`" + +reveal_type(__file__) # revealed: Literal["foo"] +reveal_type(__name__) # revealed: str +``` + +## Conditionally global or `ModuleType` attribute, with annotation + +The same is true if the name is annotated: + +```py +# error: [invalid-declaration] "Cannot shadow implicit global attribute `__file__` with declaration of type `int`" +__file__: int = 42 + +def returns_bool() -> bool: + return True + +if returns_bool(): + # error: [invalid-declaration] "Cannot shadow implicit global attribute `__name__` with declaration of type `int`" + __name__: int = 1 + +reveal_type(__file__) # revealed: Literal[42] +reveal_type(__name__) # revealed: Literal[1] | str +``` + +## Implicit global attributes in the current module override implicit globals from builtins + +Here, we take the type of the implicit global symbol `__name__` from the `types.ModuleType` stub +(which in this custom typeshed specifies the type as `bytes`). This is because the `main` module has +an implicit `__name__` global that shadows the builtin `__name__` symbol. + +```toml +[environment] +typeshed = "/typeshed" +``` + +`/typeshed/stdlib/builtins.pyi`: + +```pyi +class object: ... +class int: ... +class bytes: ... + +__name__: int = 42 +``` + +`/typeshed/stdlib/types.pyi`: + +```pyi +class ModuleType: + __name__: bytes +``` + +`/typeshed/stdlib/typing_extensions.pyi`: + +```pyi +def reveal_type(obj, /): ... +``` + +`main.py`: + +```py +reveal_type(__name__) # revealed: bytes +``` diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/nonlocal.md b/crates/ty_python_semantic/resources/mdtest/scopes/nonlocal.md new file mode 100644 index 0000000000000..862757ce95e0e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/nonlocal.md @@ -0,0 +1,45 @@ +# Nonlocal references + +## One level up + +```py +def f(): + x = 1 + def g(): + reveal_type(x) # revealed: Unknown | Literal[1] +``` + +## Two levels up + +```py +def f(): + x = 1 + def g(): + def h(): + reveal_type(x) # revealed: Unknown | Literal[1] +``` + +## Skips class scope + +```py +def f(): + x = 1 + + class C: + x = 2 + def g(): + reveal_type(x) # revealed: Unknown | Literal[1] +``` + +## Skips annotation-only assignment + +```py +def f(): + x = 1 + def g(): + # it's pretty weird to have an annotated assignment in a function where the + # name is otherwise not defined; maybe should be an error? + x: int + def h(): + reveal_type(x) # revealed: Unknown | Literal[1] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/scopes/unbound.md b/crates/ty_python_semantic/resources/mdtest/scopes/unbound.md new file mode 100644 index 0000000000000..4a15c071e8b07 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/scopes/unbound.md @@ -0,0 +1,57 @@ +# Unbound + +## Unbound class variable + +Name lookups within a class scope fall back to globals, but lookups of class attributes don't. + +```py +def coinflip() -> bool: + return True + +flag = coinflip() +x = 1 + +class C: + y = x + if flag: + x = 2 + +# error: [possibly-unbound-attribute] "Attribute `x` on type `<class 'C'>` is possibly unbound" +reveal_type(C.x) # revealed: Unknown | Literal[2] +reveal_type(C.y) # revealed: Unknown | Literal[1] +``` + +## Possibly unbound in class and global scope + +```py +def coinflip() -> bool: + return True + +if coinflip(): + x = "abc" + +class C: + if coinflip(): + x = 1 + + # error: [possibly-unresolved-reference] + y = x + +reveal_type(C.y) # revealed: Unknown | Literal[1, "abc"] +``` + +## Unbound function local + +An unbound function local that has definitions in the scope does not fall back to globals. + +```py +x = 1 + +def f(): + # error: [unresolved-reference] + # revealed: Unknown + reveal_type(x) + x = 2 + # revealed: Literal[2] + reveal_type(x) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/shadowing/class.md b/crates/ty_python_semantic/resources/mdtest/shadowing/class.md new file mode 100644 index 0000000000000..97550ec57ca84 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/shadowing/class.md @@ -0,0 +1,19 @@ +# Classes shadowing + +## Implicit error + +```py +class C: ... + +C = 1 # error: "Implicit shadowing of class `C`" +``` + +## Explicit + +No diagnostic is raised in the case of explicit shadowing: + +```py +class C: ... + +C: int = 1 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/shadowing/function.md b/crates/ty_python_semantic/resources/mdtest/shadowing/function.md new file mode 100644 index 0000000000000..dda365e13a644 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/shadowing/function.md @@ -0,0 +1,53 @@ +# Function shadowing + +## Parameter + +Parameter `x` of type `str` is shadowed and reassigned with a new `int` value inside the function. +No diagnostics should be generated. + +```py +def f(x: str): + x: int = int(x) +``` + +## Implicit error + +```py +def f(): ... + +f = 1 # error: "Implicit shadowing of function `f`" +``` + +## Explicit shadowing + +```py +def f(): ... + +f: int = 1 +``` + +## Explicit shadowing involving `def` statements + +Since a `def` statement is a declaration, one `def` can shadow another `def`, or shadow a previous +non-`def` declaration, without error. + +```py +f = 1 +reveal_type(f) # revealed: Literal[1] + +def f(): ... + +reveal_type(f) # revealed: def f() -> Unknown + +def f(x: int) -> int: + raise NotImplementedError + +reveal_type(f) # revealed: def f(x: int) -> int + +f: int = 1 +reveal_type(f) # revealed: Literal[1] + +def f(): ... + +reveal_type(f) # revealed: def f() -> Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/shadowing/variable_declaration.md b/crates/ty_python_semantic/resources/mdtest/shadowing/variable_declaration.md new file mode 100644 index 0000000000000..8c4a9259ed5b1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/shadowing/variable_declaration.md @@ -0,0 +1,13 @@ +# Shadwing declaration + +## Shadow after incompatible declarations is OK + +```py +def _(flag: bool): + if flag: + x: str + else: + x: int + + x: bytes = b"foo" +``` diff --git a/crates/ty_python_semantic/resources/mdtest/slots.md b/crates/ty_python_semantic/resources/mdtest/slots.md new file mode 100644 index 0000000000000..05e44eb4a3e38 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/slots.md @@ -0,0 +1,217 @@ +# `__slots__` + +## Not specified and empty + +```py +class A: ... + +class B: + __slots__ = () + +class C: + __slots__ = ("lorem", "ipsum") + +class AB(A, B): ... # fine +class AC(A, C): ... # fine +class BC(B, C): ... # fine +class ABC(A, B, C): ... # fine +``` + +## Incompatible tuples + +```py +class A: + __slots__ = ("a", "b") + +class B: + __slots__ = ("c", "d") + +class C( + A, # error: [incompatible-slots] + B, # error: [incompatible-slots] +): ... +``` + +## Same value + +```py +class A: + __slots__ = ("a", "b") + +class B: + __slots__ = ("a", "b") + +class C( + A, # error: [incompatible-slots] + B, # error: [incompatible-slots] +): ... +``` + +## Strings + +```py +class A: + __slots__ = "abc" + +class B: + __slots__ = ("abc",) + +class AB( + A, # error: [incompatible-slots] + B, # error: [incompatible-slots] +): ... +``` + +## Invalid + +TODO: Emit diagnostics + +```py +class NonString1: + __slots__ = 42 + +class NonString2: + __slots__ = b"ar" + +class NonIdentifier1: + __slots__ = "42" + +class NonIdentifier2: + __slots__ = ("lorem", "42") + +class NonIdentifier3: + __slots__ = (e for e in ("lorem", "42")) +``` + +## Inheritance + +```py +class A: + __slots__ = ("a", "b") + +class B(A): ... + +class C: + __slots__ = ("c", "d") + +class D(C): ... +class E( + B, # error: [incompatible-slots] + D, # error: [incompatible-slots] +): ... +``` + +## Single solid base + +```py +class A: + __slots__ = ("a", "b") + +class B(A): ... +class C(A): ... +class D(B, A): ... # fine +class E(B, C, A): ... # fine +``` + +## Post-hoc modifications + +```py +class A: + __slots__ = () + __slots__ += ("a", "b") + +reveal_type(A.__slots__) # revealed: tuple[Literal["a"], Literal["b"]] + +class B: + __slots__ = ("c", "d") + +class C( + A, # error: [incompatible-slots] + B, # error: [incompatible-slots] +): ... +``` + +## False negatives + +### Possibly unbound + +```py +def _(flag: bool): + class A: + if flag: + __slots__ = ("a", "b") + + class B: + __slots__ = ("c", "d") + + # Might or might not be fine at runtime + class C(A, B): ... +``` + +### Bound but with different types + +```py +def _(flag: bool): + class A: + if flag: + __slots__ = ("a", "b") + else: + __slots__ = () + + class B: + __slots__ = ("c", "d") + + # Might or might not be fine at runtime + class C(A, B): ... +``` + +### Non-tuples + +```py +class A: + __slots__ = ["a", "b"] # This is treated as "dynamic" + +class B: + __slots__ = ("c", "d") + +# False negative: [incompatible-slots] +class C(A, B): ... +``` + +### Built-ins with implicit layouts + +```py +# False negative: [incompatible-slots] +class A(int, str): ... +``` + +### Diagnostic if `__slots__` is externally modified + +We special-case type inference for `__slots__` and return the pure inferred type, even if the symbol +is not declared — a case in which we union with `Unknown` for other public symbols. The reason for +this is that `__slots__` has a special handling in the runtime. Modifying it externally is actually +allowed, but those changes do not take effect. If you have a class `C` with `__slots__ = ("foo",)` +and externally set `C.__slots__ = ("bar",)`, you still can't access `C.bar`. And you can still +access `C.foo`. We therefore issue a diagnostic for such assignments: + +```py +class A: + __slots__ = ("a",) + + # Modifying `__slots__` from within the class body is fine: + __slots__ = ("a", "b") + +# No `Unknown` here: +reveal_type(A.__slots__) # revealed: tuple[Literal["a"], Literal["b"]] + +# But modifying it externally is not: + +# error: [invalid-assignment] +A.__slots__ = ("a",) + +# error: [invalid-assignment] +A.__slots__ = ("a", "b_new") + +# error: [invalid-assignment] +A.__slots__ = ("a", "b", "c") +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/annotations.md_-_Assignment_with_anno\342\200\246_-_PEP-604_in_non-type-\342\200\246_-_Earlier_versions_(f2859c9800f37c7).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/annotations.md_-_Assignment_with_anno\342\200\246_-_PEP-604_in_non-type-\342\200\246_-_Earlier_versions_(f2859c9800f37c7).snap" new file mode 100644 index 0000000000000..3cfe98c8f76e9 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/annotations.md_-_Assignment_with_anno\342\200\246_-_PEP-604_in_non-type-\342\200\246_-_Earlier_versions_(f2859c9800f37c7).snap" @@ -0,0 +1,33 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: annotations.md - Assignment with annotations - PEP-604 in non-type-expression context - Earlier versions +mdtest path: crates/ty_python_semantic/resources/mdtest/assignment/annotations.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | # error: [unsupported-operator] +2 | IntOrStr = int | str +``` + +# Diagnostics + +``` +error[unsupported-operator]: Operator `|` is unsupported between objects of type `<class 'int'>` and `<class 'str'>` + --> src/mdtest_snippet.py:2:12 + | +1 | # error: [unsupported-operator] +2 | IntOrStr = int | str + | ^^^^^^^^^ + | +info: Note that `X | Y` PEP 604 union syntax is only available in Python 3.10 and later +info: Python 3.9 was assumed when resolving types because it was specified on the command line +info: rule `unsupported-operator` is enabled by default + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/assert_never.md_-_`assert_never`_-_Basic_functionality_(78e7b52096b8d36c).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/assert_never.md_-_`assert_never`_-_Basic_functionality_(78e7b52096b8d36c).snap new file mode 100644 index 0000000000000..6b4c6d3625680 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/snapshots/assert_never.md_-_`assert_never`_-_Basic_functionality_(78e7b52096b8d36c).snap @@ -0,0 +1,189 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: assert_never.md - `assert_never` - Basic functionality +mdtest path: crates/ty_python_semantic/resources/mdtest/directives/assert_never.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import assert_never, Never, Any + 2 | from ty_extensions import Unknown + 3 | + 4 | def _(never: Never, any_: Any, unknown: Unknown, flag: bool): + 5 | assert_never(never) # fine + 6 | + 7 | assert_never(0) # error: [type-assertion-failure] + 8 | assert_never("") # error: [type-assertion-failure] + 9 | assert_never(None) # error: [type-assertion-failure] +10 | assert_never([]) # error: [type-assertion-failure] +11 | assert_never({}) # error: [type-assertion-failure] +12 | assert_never(()) # error: [type-assertion-failure] +13 | assert_never(1 if flag else never) # error: [type-assertion-failure] +14 | +15 | assert_never(any_) # error: [type-assertion-failure] +16 | assert_never(unknown) # error: [type-assertion-failure] +``` + +# Diagnostics + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:7:5 + | +5 | assert_never(never) # fine +6 | +7 | assert_never(0) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^-^ + | | + | Inferred type of argument is `Literal[0]` +8 | assert_never("") # error: [type-assertion-failure] +9 | assert_never(None) # error: [type-assertion-failure] + | +info: `Never` and `Literal[0]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:8:5 + | + 7 | assert_never(0) # error: [type-assertion-failure] + 8 | assert_never("") # error: [type-assertion-failure] + | ^^^^^^^^^^^^^--^ + | | + | Inferred type of argument is `Literal[""]` + 9 | assert_never(None) # error: [type-assertion-failure] +10 | assert_never([]) # error: [type-assertion-failure] + | +info: `Never` and `Literal[""]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:9:5 + | + 7 | assert_never(0) # error: [type-assertion-failure] + 8 | assert_never("") # error: [type-assertion-failure] + 9 | assert_never(None) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^----^ + | | + | Inferred type of argument is `None` +10 | assert_never([]) # error: [type-assertion-failure] +11 | assert_never({}) # error: [type-assertion-failure] + | +info: `Never` and `None` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:10:5 + | + 8 | assert_never("") # error: [type-assertion-failure] + 9 | assert_never(None) # error: [type-assertion-failure] +10 | assert_never([]) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^--^ + | | + | Inferred type of argument is `list[Unknown]` +11 | assert_never({}) # error: [type-assertion-failure] +12 | assert_never(()) # error: [type-assertion-failure] + | +info: `Never` and `list[Unknown]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:11:5 + | + 9 | assert_never(None) # error: [type-assertion-failure] +10 | assert_never([]) # error: [type-assertion-failure] +11 | assert_never({}) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^--^ + | | + | Inferred type of argument is `dict[Unknown, Unknown]` +12 | assert_never(()) # error: [type-assertion-failure] +13 | assert_never(1 if flag else never) # error: [type-assertion-failure] + | +info: `Never` and `dict[Unknown, Unknown]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:12:5 + | +10 | assert_never([]) # error: [type-assertion-failure] +11 | assert_never({}) # error: [type-assertion-failure] +12 | assert_never(()) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^--^ + | | + | Inferred type of argument is `tuple[()]` +13 | assert_never(1 if flag else never) # error: [type-assertion-failure] + | +info: `Never` and `tuple[()]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:13:5 + | +11 | assert_never({}) # error: [type-assertion-failure] +12 | assert_never(()) # error: [type-assertion-failure] +13 | assert_never(1 if flag else never) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^--------------------^ + | | + | Inferred type of argument is `Literal[1]` +14 | +15 | assert_never(any_) # error: [type-assertion-failure] + | +info: `Never` and `Literal[1]` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:15:5 + | +13 | assert_never(1 if flag else never) # error: [type-assertion-failure] +14 | +15 | assert_never(any_) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^----^ + | | + | Inferred type of argument is `Any` +16 | assert_never(unknown) # error: [type-assertion-failure] + | +info: `Never` and `Any` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` + +``` +error[type-assertion-failure]: Argument does not have asserted type `Never` + --> src/mdtest_snippet.py:16:5 + | +15 | assert_never(any_) # error: [type-assertion-failure] +16 | assert_never(unknown) # error: [type-assertion-failure] + | ^^^^^^^^^^^^^-------^ + | | + | Inferred type of argument is `Unknown` + | +info: `Never` and `Unknown` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/assert_type.md_-_`assert_type`_-_Basic_(c507788da2659ec9).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/assert_type.md_-_`assert_type`_-_Basic_(c507788da2659ec9).snap new file mode 100644 index 0000000000000..4b9da52c7b267 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/snapshots/assert_type.md_-_`assert_type`_-_Basic_(c507788da2659ec9).snap @@ -0,0 +1,38 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: assert_type.md - `assert_type` - Basic +mdtest path: crates/ty_python_semantic/resources/mdtest/directives/assert_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing_extensions import assert_type +2 | +3 | def _(x: int): +4 | assert_type(x, int) # fine +5 | assert_type(x, str) # error: [type-assertion-failure] +``` + +# Diagnostics + +``` +error[type-assertion-failure]: Argument does not have asserted type `str` + --> src/mdtest_snippet.py:5:5 + | +3 | def _(x: int): +4 | assert_type(x, int) # fine +5 | assert_type(x, str) # error: [type-assertion-failure] + | ^^^^^^^^^^^^-^^^^^^ + | | + | Inferred type of argument is `int` + | +info: `str` and `int` are not equivalent types +info: rule `type-assertion-failure` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_`__set__`_me\342\200\246_(116c27bd98838df7).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_`__set__`_me\342\200\246_(116c27bd98838df7).snap" new file mode 100644 index 0000000000000..3cdd4bf7acc64 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_`__set__`_me\342\200\246_(116c27bd98838df7).snap" @@ -0,0 +1,40 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Data descriptors - Invalid `__set__` method signature +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class WrongDescriptor: + 2 | def __set__(self, instance: object, value: int, extra: int) -> None: + 3 | pass + 4 | + 5 | class C: + 6 | attr: WrongDescriptor = WrongDescriptor() + 7 | + 8 | instance = C() + 9 | +10 | # TODO: ideally, we would mention why this is an invalid assignment (wrong number of arguments for `__set__`) +11 | instance.attr = 1 # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Invalid assignment to data descriptor attribute `attr` on type `C` with custom `__set__` method + --> src/mdtest_snippet.py:11:1 + | +10 | # TODO: ideally, we would mention why this is an invalid assignment (wrong number of arguments for `__set__`) +11 | instance.attr = 1 # error: [invalid-assignment] + | ^^^^^^^^^^^^^ + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_argument_typ\342\200\246_(a903c11fedbc5020).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_argument_typ\342\200\246_(a903c11fedbc5020).snap" new file mode 100644 index 0000000000000..850a5b3ceaf53 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Data_descriptors_-_Invalid_argument_typ\342\200\246_(a903c11fedbc5020).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Data descriptors - Invalid argument type +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class Descriptor: + 2 | def __set__(self, instance: object, value: int) -> None: + 3 | pass + 4 | + 5 | class C: + 6 | attr: Descriptor = Descriptor() + 7 | + 8 | instance = C() + 9 | instance.attr = 1 # fine +10 | +11 | # TODO: ideally, we would mention why this is an invalid assignment (wrong argument type for `value` parameter) +12 | instance.attr = "wrong" # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Invalid assignment to data descriptor attribute `attr` on type `C` with custom `__set__` method + --> src/mdtest_snippet.py:12:1 + | +11 | # TODO: ideally, we would mention why this is an invalid assignment (wrong argument type for `value` parameter) +12 | instance.attr = "wrong" # error: [invalid-assignment] + | ^^^^^^^^^^^^^ + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Instance_attributes_\342\200\246_(ebfb3de6d1b96b23).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Instance_attributes_\342\200\246_(ebfb3de6d1b96b23).snap" new file mode 100644 index 0000000000000..9b62b2d7ffde5 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Instance_attributes_\342\200\246_(ebfb3de6d1b96b23).snap" @@ -0,0 +1,53 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Instance attributes with class-level defaults +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: +2 | attr: int = 0 +3 | +4 | instance = C() +5 | instance.attr = 1 # fine +6 | instance.attr = "wrong" # error: [invalid-assignment] +7 | +8 | C.attr = 1 # fine +9 | C.attr = "wrong" # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Object of type `Literal["wrong"]` is not assignable to attribute `attr` of type `int` + --> src/mdtest_snippet.py:6:1 + | +4 | instance = C() +5 | instance.attr = 1 # fine +6 | instance.attr = "wrong" # error: [invalid-assignment] + | ^^^^^^^^^^^^^ +7 | +8 | C.attr = 1 # fine + | +info: rule `invalid-assignment` is enabled by default + +``` + +``` +error[invalid-assignment]: Object of type `Literal["wrong"]` is not assignable to attribute `attr` of type `int` + --> src/mdtest_snippet.py:9:1 + | +8 | C.attr = 1 # fine +9 | C.attr = "wrong" # error: [invalid-assignment] + | ^^^^^^ + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Possibly-unbound_att\342\200\246_(e5bdf78c427cb7fc).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Possibly-unbound_att\342\200\246_(e5bdf78c427cb7fc).snap" new file mode 100644 index 0000000000000..369a67a25667b --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Possibly-unbound_att\342\200\246_(e5bdf78c427cb7fc).snap" @@ -0,0 +1,53 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Possibly-unbound attributes +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def _(flag: bool) -> None: +2 | class C: +3 | if flag: +4 | attr: int = 0 +5 | +6 | C.attr = 1 # error: [possibly-unbound-attribute] +7 | +8 | instance = C() +9 | instance.attr = 1 # error: [possibly-unbound-attribute] +``` + +# Diagnostics + +``` +warning[possibly-unbound-attribute]: Attribute `attr` on type `<class 'C'>` is possibly unbound + --> src/mdtest_snippet.py:6:5 + | +4 | attr: int = 0 +5 | +6 | C.attr = 1 # error: [possibly-unbound-attribute] + | ^^^^^^ +7 | +8 | instance = C() + | +info: rule `possibly-unbound-attribute` is enabled by default + +``` + +``` +warning[possibly-unbound-attribute]: Attribute `attr` on type `C` is possibly unbound + --> src/mdtest_snippet.py:9:5 + | +8 | instance = C() +9 | instance.attr = 1 # error: [possibly-unbound-attribute] + | ^^^^^^^^^^^^^ + | +info: rule `possibly-unbound-attribute` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Pure_instance_attrib\342\200\246_(d13d57d3cc36face).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Pure_instance_attrib\342\200\246_(d13d57d3cc36face).snap" new file mode 100644 index 0000000000000..27df8aba9674e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Pure_instance_attrib\342\200\246_(d13d57d3cc36face).snap" @@ -0,0 +1,54 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Pure instance attributes +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: +2 | def __init__(self): +3 | self.attr: int = 0 +4 | +5 | instance = C() +6 | instance.attr = 1 # fine +7 | instance.attr = "wrong" # error: [invalid-assignment] +8 | +9 | C.attr = 1 # error: [invalid-attribute-access] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Object of type `Literal["wrong"]` is not assignable to attribute `attr` of type `int` + --> src/mdtest_snippet.py:7:1 + | +5 | instance = C() +6 | instance.attr = 1 # fine +7 | instance.attr = "wrong" # error: [invalid-assignment] + | ^^^^^^^^^^^^^ +8 | +9 | C.attr = 1 # error: [invalid-attribute-access] + | +info: rule `invalid-assignment` is enabled by default + +``` + +``` +error[invalid-attribute-access]: Cannot assign to instance attribute `attr` from the class object `<class 'C'>` + --> src/mdtest_snippet.py:9:1 + | +7 | instance.attr = "wrong" # error: [invalid-assignment] +8 | +9 | C.attr = 1 # error: [invalid-attribute-access] + | ^^^^^^ + | +info: rule `invalid-attribute-access` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Setting_attributes_o\342\200\246_(467e26496f4c0c13).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Setting_attributes_o\342\200\246_(467e26496f4c0c13).snap" new file mode 100644 index 0000000000000..7491ce72aecb3 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Setting_attributes_o\342\200\246_(467e26496f4c0c13).snap" @@ -0,0 +1,51 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Setting attributes on union types +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def _(flag: bool) -> None: + 2 | if flag: + 3 | class C1: + 4 | attr: int = 0 + 5 | + 6 | else: + 7 | class C1: + 8 | attr: str = "" + 9 | +10 | # TODO: The error message here could be improved to explain why the assignment fails. +11 | C1.attr = 1 # error: [invalid-assignment] +12 | +13 | class C2: +14 | if flag: +15 | attr: int = 0 +16 | else: +17 | attr: str = "" +18 | +19 | # TODO: This should be an error +20 | C2.attr = 1 +``` + +# Diagnostics + +``` +error[invalid-assignment]: Object of type `Literal[1]` is not assignable to attribute `attr` on type `<class 'C1'> | <class 'C1'>` + --> src/mdtest_snippet.py:11:5 + | +10 | # TODO: The error message here could be improved to explain why the assignment fails. +11 | C1.attr = 1 # error: [invalid-assignment] + | ^^^^^^^ +12 | +13 | class C2: + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Unknown_attributes_(368ba83a71ef2120).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Unknown_attributes_(368ba83a71ef2120).snap" new file mode 100644 index 0000000000000..c7beb2d87fba4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_Unknown_attributes_(368ba83a71ef2120).snap" @@ -0,0 +1,50 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - Unknown attributes +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: ... +2 | +3 | C.non_existent = 1 # error: [unresolved-attribute] +4 | +5 | instance = C() +6 | instance.non_existent = 1 # error: [unresolved-attribute] +``` + +# Diagnostics + +``` +error[unresolved-attribute]: Unresolved attribute `non_existent` on type `<class 'C'>`. + --> src/mdtest_snippet.py:3:1 + | +1 | class C: ... +2 | +3 | C.non_existent = 1 # error: [unresolved-attribute] + | ^^^^^^^^^^^^^^ +4 | +5 | instance = C() + | +info: rule `unresolved-attribute` is enabled by default + +``` + +``` +error[unresolved-attribute]: Unresolved attribute `non_existent` on type `C`. + --> src/mdtest_snippet.py:6:1 + | +5 | instance = C() +6 | instance.non_existent = 1 # error: [unresolved-attribute] + | ^^^^^^^^^^^^^^^^^^^^^ + | +info: rule `unresolved-attribute` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_`ClassVar`s_(8d7cca27987b099d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_`ClassVar`s_(8d7cca27987b099d).snap" new file mode 100644 index 0000000000000..f623fe78e79da --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/attribute_assignment\342\200\246_-_Attribute_assignment_-_`ClassVar`s_(8d7cca27987b099d).snap" @@ -0,0 +1,53 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: attribute_assignment.md - Attribute assignment - `ClassVar`s +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/attribute_assignment.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import ClassVar + 2 | + 3 | class C: + 4 | attr: ClassVar[int] = 0 + 5 | + 6 | C.attr = 1 # fine + 7 | C.attr = "wrong" # error: [invalid-assignment] + 8 | + 9 | instance = C() +10 | instance.attr = 1 # error: [invalid-attribute-access] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Object of type `Literal["wrong"]` is not assignable to attribute `attr` of type `int` + --> src/mdtest_snippet.py:7:1 + | +6 | C.attr = 1 # fine +7 | C.attr = "wrong" # error: [invalid-assignment] + | ^^^^^^ +8 | +9 | instance = C() + | +info: rule `invalid-assignment` is enabled by default + +``` + +``` +error[invalid-attribute-access]: Cannot assign to ClassVar `attr` from an instance of type `C` + --> src/mdtest_snippet.py:10:1 + | + 9 | instance = C() +10 | instance.attr = 1 # error: [invalid-attribute-access] + | ^^^^^^^^^^^^^ + | +info: rule `invalid-attribute-access` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Multiple_objects_imp\342\200\246_(cbfbf5ff94e6e104).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Multiple_objects_imp\342\200\246_(cbfbf5ff94e6e104).snap" new file mode 100644 index 0000000000000..38f08fabae104 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Multiple_objects_imp\342\200\246_(cbfbf5ff94e6e104).snap" @@ -0,0 +1,32 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: basic.md - Structures - Multiple objects imported from an unresolved module +mdtest path: crates/ty_python_semantic/resources/mdtest/import/basic.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | # error: [unresolved-import] +2 | from does_not_exist import foo, bar, baz +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `does_not_exist` + --> src/mdtest_snippet.py:2:6 + | +1 | # error: [unresolved-import] +2 | from does_not_exist import foo, bar, baz + | ^^^^^^^^^^^^^^ + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_module_\342\200\246_(846453deaca1071c).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_module_\342\200\246_(846453deaca1071c).snap" new file mode 100644 index 0000000000000..ac461d86ffe9a --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_module_\342\200\246_(846453deaca1071c).snap" @@ -0,0 +1,30 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: basic.md - Structures - Unresolvable module import +mdtest path: crates/ty_python_semantic/resources/mdtest/import/basic.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | import zqzqzqzqzqzqzq # error: [unresolved-import] "Cannot resolve imported module `zqzqzqzqzqzqzq`" +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `zqzqzqzqzqzqzq` + --> src/mdtest_snippet.py:1:8 + | +1 | import zqzqzqzqzqzqzq # error: [unresolved-import] "Cannot resolve imported module `zqzqzqzqzqzqzq`" + | ^^^^^^^^^^^^^^ + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_submodu\342\200\246_(4fad4be9778578b7).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_submodu\342\200\246_(4fad4be9778578b7).snap" new file mode 100644 index 0000000000000..5bf1aba66510c --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/basic.md_-_Structures_-_Unresolvable_submodu\342\200\246_(4fad4be9778578b7).snap" @@ -0,0 +1,55 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: basic.md - Structures - Unresolvable submodule imports +mdtest path: crates/ty_python_semantic/resources/mdtest/import/basic.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | # Topmost component resolvable, submodule not resolvable: +2 | import a.foo # error: [unresolved-import] "Cannot resolve imported module `a.foo`" +3 | +4 | # Topmost component unresolvable: +5 | import b.foo # error: [unresolved-import] "Cannot resolve imported module `b.foo`" +``` + +## a/__init__.py + +``` +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `a.foo` + --> src/mdtest_snippet.py:2:8 + | +1 | # Topmost component resolvable, submodule not resolvable: +2 | import a.foo # error: [unresolved-import] "Cannot resolve imported module `a.foo`" + | ^^^^^ +3 | +4 | # Topmost component unresolvable: + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` + +``` +error[unresolved-import]: Cannot resolve imported module `b.foo` + --> src/mdtest_snippet.py:5:8 + | +4 | # Topmost component unresolvable: +5 | import b.foo # error: [unresolved-import] "Cannot resolve imported module `b.foo`" + | ^^^^^ + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Bad_`__getitem__`_me\342\200\246_(3ffe352bb3a76715).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Bad_`__getitem__`_me\342\200\246_(3ffe352bb3a76715).snap" new file mode 100644 index 0000000000000..a9104c65260e0 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Bad_`__getitem__`_me\342\200\246_(3ffe352bb3a76715).snap" @@ -0,0 +1,55 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Bad `__getitem__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterable: + 4 | # invalid because it will implicitly be passed an `int` + 5 | # by the interpreter + 6 | def __getitem__(self, key: str) -> int: + 7 | return 42 + 8 | + 9 | # error: [not-iterable] +10 | for x in Iterable(): +11 | reveal_type(x) # revealed: int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable` is not iterable + --> src/mdtest_snippet.py:10:10 + | + 9 | # error: [not-iterable] +10 | for x in Iterable(): + | ^^^^^^^^^^ +11 | reveal_type(x) # revealed: int + | +info: It has no `__iter__` method and its `__getitem__` method has an incorrect signature for the old-style iteration protocol +info: `__getitem__` must be at least as permissive as `def __getitem__(self, key: int): ...` to satisfy the old-style iteration protocol +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:11:17 + | + 9 | # error: [not-iterable] +10 | for x in Iterable(): +11 | reveal_type(x) # revealed: int + | ^ `int` + | + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Invalid_iterable_(3153247bb9a9b72a).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Invalid_iterable_(3153247bb9a9b72a).snap new file mode 100644 index 0000000000000..5ccdf53de306d --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Invalid_iterable_(3153247bb9a9b72a).snap @@ -0,0 +1,34 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Invalid iterable +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | nonsense = 123 +2 | for x in nonsense: # error: [not-iterable] +3 | pass +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Literal[123]` is not iterable + --> src/mdtest_snippet.py:2:10 + | +1 | nonsense = 123 +2 | for x in nonsense: # error: [not-iterable] + | ^^^^^^^^ +3 | pass + | +info: It doesn't have an `__iter__` method or a `__getitem__` method +info: rule `not-iterable` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_New_over_old_style_i\342\200\246_(a90ba167a7c191eb).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_New_over_old_style_i\342\200\246_(a90ba167a7c191eb).snap" new file mode 100644 index 0000000000000..9a1a1fd62f2ea --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_New_over_old_style_i\342\200\246_(a90ba167a7c191eb).snap" @@ -0,0 +1,39 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - New over old style iteration protocol +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotIterable: +2 | def __getitem__(self, key: int) -> int: +3 | return 42 +4 | __iter__: None = None +5 | +6 | for x in NotIterable(): # error: [not-iterable] +7 | pass +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `NotIterable` is not iterable + --> src/mdtest_snippet.py:6:10 + | +4 | __iter__: None = None +5 | +6 | for x in NotIterable(): # error: [not-iterable] + | ^^^^^^^^^^^^^ +7 | pass + | +info: Its `__iter__` attribute has type `None`, which is not callable +info: rule `not-iterable` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_No_`__iter__`_method\342\200\246_(36425dbcbd793d2b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_No_`__iter__`_method\342\200\246_(36425dbcbd793d2b).snap" new file mode 100644 index 0000000000000..ad4ffa4b00b39 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_No_`__iter__`_method\342\200\246_(36425dbcbd793d2b).snap" @@ -0,0 +1,51 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - No `__iter__` method and `__getitem__` is not callable +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing_extensions import reveal_type +2 | +3 | class Bad: +4 | __getitem__: None = None +5 | +6 | # error: [not-iterable] +7 | for x in Bad(): +8 | reveal_type(x) # revealed: Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Bad` is not iterable + --> src/mdtest_snippet.py:7:10 + | +6 | # error: [not-iterable] +7 | for x in Bad(): + | ^^^^^ +8 | reveal_type(x) # revealed: Unknown + | +info: It has no `__iter__` method and its `__getitem__` attribute has type `None`, which is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:8:17 + | +6 | # error: [not-iterable] +7 | for x in Bad(): +8 | reveal_type(x) # revealed: Unknown + | ^ `Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly-not-callabl\342\200\246_(49a21e4b7fe6e97b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly-not-callabl\342\200\246_(49a21e4b7fe6e97b).snap" new file mode 100644 index 0000000000000..1a20384b0dd61 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly-not-callabl\342\200\246_(49a21e4b7fe6e97b).snap" @@ -0,0 +1,104 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly-not-callable `__getitem__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def _(flag: bool): + 4 | class CustomCallable: + 5 | if flag: + 6 | def __call__(self, *args, **kwargs) -> int: + 7 | return 42 + 8 | else: + 9 | __call__: None = None +10 | +11 | class Iterable1: +12 | __getitem__: CustomCallable = CustomCallable() +13 | +14 | class Iterable2: +15 | if flag: +16 | def __getitem__(self, key: int) -> int: +17 | return 42 +18 | else: +19 | __getitem__: None = None +20 | +21 | # error: [not-iterable] +22 | for x in Iterable1(): +23 | # TODO... `int` might be ideal here? +24 | reveal_type(x) # revealed: int | Unknown +25 | +26 | # error: [not-iterable] +27 | for y in Iterable2(): +28 | # TODO... `int` might be ideal here? +29 | reveal_type(y) # revealed: int | Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` may not be iterable + --> src/mdtest_snippet.py:22:14 + | +21 | # error: [not-iterable] +22 | for x in Iterable1(): + | ^^^^^^^^^^^ +23 | # TODO... `int` might be ideal here? +24 | reveal_type(x) # revealed: int | Unknown + | +info: It has no `__iter__` method and its `__getitem__` attribute is invalid +info: `__getitem__` has type `CustomCallable`, which is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:24:21 + | +22 | for x in Iterable1(): +23 | # TODO... `int` might be ideal here? +24 | reveal_type(x) # revealed: int | Unknown + | ^ `int | Unknown` +25 | +26 | # error: [not-iterable] + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` may not be iterable + --> src/mdtest_snippet.py:27:14 + | +26 | # error: [not-iterable] +27 | for y in Iterable2(): + | ^^^^^^^^^^^ +28 | # TODO... `int` might be ideal here? +29 | reveal_type(y) # revealed: int | Unknown + | +info: It has no `__iter__` method and its `__getitem__` attribute is invalid +info: `__getitem__` has type `(bound method Iterable2.__getitem__(key: int) -> int) | None`, which is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:29:21 + | +27 | for y in Iterable2(): +28 | # TODO... `int` might be ideal here? +29 | reveal_type(y) # revealed: int | Unknown + | ^ `int | Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6388761c90a0555c).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6388761c90a0555c).snap" new file mode 100644 index 0000000000000..ca18f1184a476 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6388761c90a0555c).snap" @@ -0,0 +1,104 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly invalid `__iter__` methods +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterator: + 4 | def __next__(self) -> int: + 5 | return 42 + 6 | + 7 | def _(flag: bool): + 8 | class Iterable1: + 9 | if flag: +10 | def __iter__(self) -> Iterator: +11 | return Iterator() +12 | else: +13 | def __iter__(self, invalid_extra_arg) -> Iterator: +14 | return Iterator() +15 | +16 | # error: [not-iterable] +17 | for x in Iterable1(): +18 | reveal_type(x) # revealed: int +19 | +20 | class Iterable2: +21 | if flag: +22 | def __iter__(self) -> Iterator: +23 | return Iterator() +24 | else: +25 | __iter__: None = None +26 | +27 | # error: [not-iterable] +28 | for x in Iterable2(): +29 | # TODO: `int` would probably be better here: +30 | reveal_type(x) # revealed: int | Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` may not be iterable + --> src/mdtest_snippet.py:17:14 + | +16 | # error: [not-iterable] +17 | for x in Iterable1(): + | ^^^^^^^^^^^ +18 | reveal_type(x) # revealed: int + | +info: Its `__iter__` method may have an invalid signature +info: Type of `__iter__` is `(bound method Iterable1.__iter__() -> Iterator) | (bound method Iterable1.__iter__(invalid_extra_arg) -> Iterator)` +info: Expected signature for `__iter__` is `def __iter__(self): ...` +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:18:21 + | +16 | # error: [not-iterable] +17 | for x in Iterable1(): +18 | reveal_type(x) # revealed: int + | ^ `int` +19 | +20 | class Iterable2: + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` may not be iterable + --> src/mdtest_snippet.py:28:14 + | +27 | # error: [not-iterable] +28 | for x in Iterable2(): + | ^^^^^^^^^^^ +29 | # TODO: `int` would probably be better here: +30 | reveal_type(x) # revealed: int | Unknown + | +info: Its `__iter__` attribute (with type `(bound method Iterable2.__iter__() -> Iterator) | None`) may not be callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:30:21 + | +28 | for x in Iterable2(): +29 | # TODO: `int` would probably be better here: +30 | reveal_type(x) # revealed: int | Unknown + | ^ `int | Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6805a6032e504b63).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6805a6032e504b63).snap" new file mode 100644 index 0000000000000..ba0f58ca09c5a --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(6805a6032e504b63).snap" @@ -0,0 +1,100 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly invalid `__getitem__` methods +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def _(flag: bool): + 4 | class Iterable1: + 5 | if flag: + 6 | def __getitem__(self, item: int) -> str: + 7 | return "foo" + 8 | else: + 9 | __getitem__: None = None +10 | +11 | class Iterable2: +12 | if flag: +13 | def __getitem__(self, item: int) -> str: +14 | return "foo" +15 | else: +16 | def __getitem__(self, item: str) -> int: +17 | return 42 +18 | +19 | # error: [not-iterable] +20 | for x in Iterable1(): +21 | # TODO: `str` might be better +22 | reveal_type(x) # revealed: str | Unknown +23 | +24 | # error: [not-iterable] +25 | for y in Iterable2(): +26 | reveal_type(y) # revealed: str | int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` may not be iterable + --> src/mdtest_snippet.py:20:14 + | +19 | # error: [not-iterable] +20 | for x in Iterable1(): + | ^^^^^^^^^^^ +21 | # TODO: `str` might be better +22 | reveal_type(x) # revealed: str | Unknown + | +info: It has no `__iter__` method and its `__getitem__` attribute is invalid +info: `__getitem__` has type `(bound method Iterable1.__getitem__(item: int) -> str) | None`, which is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:22:21 + | +20 | for x in Iterable1(): +21 | # TODO: `str` might be better +22 | reveal_type(x) # revealed: str | Unknown + | ^ `str | Unknown` +23 | +24 | # error: [not-iterable] + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` may not be iterable + --> src/mdtest_snippet.py:25:14 + | +24 | # error: [not-iterable] +25 | for y in Iterable2(): + | ^^^^^^^^^^^ +26 | reveal_type(y) # revealed: str | int + | +info: It has no `__iter__` method and its `__getitem__` method (with type `(bound method Iterable2.__getitem__(item: int) -> str) | (bound method Iterable2.__getitem__(item: str) -> int)`) may have an incorrect signature for the old-style iteration protocol +info: `__getitem__` must be at least as permissive as `def __getitem__(self, key: int): ...` to satisfy the old-style iteration protocol +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:26:21 + | +24 | # error: [not-iterable] +25 | for y in Iterable2(): +26 | reveal_type(y) # revealed: str | int + | ^ `str | int` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(c626bde8651b643a).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(c626bde8651b643a).snap" new file mode 100644 index 0000000000000..91c7d40dbd8c3 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_invalid_`__\342\200\246_(c626bde8651b643a).snap" @@ -0,0 +1,107 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly invalid `__next__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def _(flag: bool): + 4 | class Iterator1: + 5 | if flag: + 6 | def __next__(self) -> int: + 7 | return 42 + 8 | else: + 9 | def __next__(self, invalid_extra_arg) -> str: +10 | return "foo" +11 | +12 | class Iterator2: +13 | if flag: +14 | def __next__(self) -> int: +15 | return 42 +16 | else: +17 | __next__: None = None +18 | +19 | class Iterable1: +20 | def __iter__(self) -> Iterator1: +21 | return Iterator1() +22 | +23 | class Iterable2: +24 | def __iter__(self) -> Iterator2: +25 | return Iterator2() +26 | +27 | # error: [not-iterable] +28 | for x in Iterable1(): +29 | reveal_type(x) # revealed: int | str +30 | +31 | # error: [not-iterable] +32 | for y in Iterable2(): +33 | # TODO: `int` would probably be better here: +34 | reveal_type(y) # revealed: int | Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` may not be iterable + --> src/mdtest_snippet.py:28:14 + | +27 | # error: [not-iterable] +28 | for x in Iterable1(): + | ^^^^^^^^^^^ +29 | reveal_type(x) # revealed: int | str + | +info: Its `__iter__` method returns an object of type `Iterator1`, which may have an invalid `__next__` method +info: Expected signature for `__next__` is `def __next__(self): ...`) +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:29:21 + | +27 | # error: [not-iterable] +28 | for x in Iterable1(): +29 | reveal_type(x) # revealed: int | str + | ^ `int | str` +30 | +31 | # error: [not-iterable] + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` may not be iterable + --> src/mdtest_snippet.py:32:14 + | +31 | # error: [not-iterable] +32 | for y in Iterable2(): + | ^^^^^^^^^^^ +33 | # TODO: `int` would probably be better here: +34 | reveal_type(y) # revealed: int | Unknown + | +info: Its `__iter__` method returns an object of type `Iterator2`, which has a `__next__` attribute that may not be callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:34:21 + | +32 | for y in Iterable2(): +33 | # TODO: `int` would probably be better here: +34 | reveal_type(y) # revealed: int | Unknown + | ^ `int | Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(3b75cc467e6e012).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(3b75cc467e6e012).snap" new file mode 100644 index 0000000000000..c7ec49090296d --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(3b75cc467e6e012).snap" @@ -0,0 +1,63 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly unbound `__iter__` and bad `__getitem__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def _(flag: bool): + 4 | class Iterator: + 5 | def __next__(self) -> int: + 6 | return 42 + 7 | + 8 | class Iterable: + 9 | if flag: +10 | def __iter__(self) -> Iterator: +11 | return Iterator() +12 | # invalid signature because it only accepts a `str`, +13 | # but the old-style iteration protocol will pass it an `int` +14 | def __getitem__(self, key: str) -> bytes: +15 | return bytes() +16 | +17 | # error: [not-iterable] +18 | for x in Iterable(): +19 | reveal_type(x) # revealed: int | bytes +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable` may not be iterable + --> src/mdtest_snippet.py:18:14 + | +17 | # error: [not-iterable] +18 | for x in Iterable(): + | ^^^^^^^^^^ +19 | reveal_type(x) # revealed: int | bytes + | +info: It may not have an `__iter__` method and its `__getitem__` method has an incorrect signature for the old-style iteration protocol +info: `__getitem__` must be at least as permissive as `def __getitem__(self, key: int): ...` to satisfy the old-style iteration protocol +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:19:21 + | +17 | # error: [not-iterable] +18 | for x in Iterable(): +19 | reveal_type(x) # revealed: int | bytes + | ^ `int | bytes` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(8745233539d31200).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(8745233539d31200).snap" new file mode 100644 index 0000000000000..48013f59483b0 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(8745233539d31200).snap" @@ -0,0 +1,61 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly unbound `__iter__` and possibly unbound `__getitem__` +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterator: + 4 | def __next__(self) -> int: + 5 | return 42 + 6 | + 7 | def _(flag1: bool, flag2: bool): + 8 | class Iterable: + 9 | if flag1: +10 | def __iter__(self) -> Iterator: +11 | return Iterator() +12 | if flag2: +13 | def __getitem__(self, key: int) -> bytes: +14 | return bytes() +15 | +16 | # error: [not-iterable] +17 | for x in Iterable(): +18 | reveal_type(x) # revealed: int | bytes +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable` may not be iterable + --> src/mdtest_snippet.py:17:14 + | +16 | # error: [not-iterable] +17 | for x in Iterable(): + | ^^^^^^^^^^ +18 | reveal_type(x) # revealed: int | bytes + | +info: It may not have an `__iter__` method or a `__getitem__` method +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:18:21 + | +16 | # error: [not-iterable] +17 | for x in Iterable(): +18 | reveal_type(x) # revealed: int | bytes + | ^ `int | bytes` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(b1ce0da35c06026).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(b1ce0da35c06026).snap" new file mode 100644 index 0000000000000..9d09acef590b3 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Possibly_unbound_`__\342\200\246_(b1ce0da35c06026).snap" @@ -0,0 +1,110 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Possibly unbound `__iter__` and possibly invalid `__getitem__` +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterator: + 4 | def __next__(self) -> bytes: + 5 | return b"foo" + 6 | + 7 | def _(flag: bool, flag2: bool): + 8 | class Iterable1: + 9 | if flag: +10 | def __getitem__(self, item: int) -> str: +11 | return "foo" +12 | else: +13 | __getitem__: None = None +14 | +15 | if flag2: +16 | def __iter__(self) -> Iterator: +17 | return Iterator() +18 | +19 | class Iterable2: +20 | if flag: +21 | def __getitem__(self, item: int) -> str: +22 | return "foo" +23 | else: +24 | def __getitem__(self, item: str) -> int: +25 | return 42 +26 | if flag2: +27 | def __iter__(self) -> Iterator: +28 | return Iterator() +29 | +30 | # error: [not-iterable] +31 | for x in Iterable1(): +32 | # TODO: `bytes | str` might be better +33 | reveal_type(x) # revealed: bytes | str | Unknown +34 | +35 | # error: [not-iterable] +36 | for y in Iterable2(): +37 | reveal_type(y) # revealed: bytes | str | int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` may not be iterable + --> src/mdtest_snippet.py:31:14 + | +30 | # error: [not-iterable] +31 | for x in Iterable1(): + | ^^^^^^^^^^^ +32 | # TODO: `bytes | str` might be better +33 | reveal_type(x) # revealed: bytes | str | Unknown + | +info: It may not have an `__iter__` method and its `__getitem__` attribute (with type `(bound method Iterable1.__getitem__(item: int) -> str) | None`) may not be callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:33:21 + | +31 | for x in Iterable1(): +32 | # TODO: `bytes | str` might be better +33 | reveal_type(x) # revealed: bytes | str | Unknown + | ^ `bytes | str | Unknown` +34 | +35 | # error: [not-iterable] + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` may not be iterable + --> src/mdtest_snippet.py:36:14 + | +35 | # error: [not-iterable] +36 | for y in Iterable2(): + | ^^^^^^^^^^^ +37 | reveal_type(y) # revealed: bytes | str | int + | +info: It may not have an `__iter__` method and its `__getitem__` method (with type `(bound method Iterable2.__getitem__(item: int) -> str) | (bound method Iterable2.__getitem__(item: str) -> int)`) may have an incorrect signature for the old-style iteration protocol +info: `__getitem__` must be at least as permissive as `def __getitem__(self, key: int): ...` to satisfy the old-style iteration protocol +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:37:21 + | +35 | # error: [not-iterable] +36 | for y in Iterable2(): +37 | reveal_type(y) # revealed: bytes | str | int + | ^ `bytes | str | int` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(6177bb6d13a22241).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(6177bb6d13a22241).snap" new file mode 100644 index 0000000000000..e7ab06ed09bcc --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(6177bb6d13a22241).snap" @@ -0,0 +1,63 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Union type as iterable where one union element has invalid `__iter__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class TestIter: + 4 | def __next__(self) -> int: + 5 | return 42 + 6 | + 7 | class Test: + 8 | def __iter__(self) -> TestIter: + 9 | return TestIter() +10 | +11 | class Test2: +12 | def __iter__(self) -> int: +13 | return 42 +14 | +15 | def _(flag: bool): +16 | # TODO: Improve error message to state which union variant isn't iterable (https://github.com/astral-sh/ruff/issues/13989) +17 | # error: [not-iterable] +18 | for x in Test() if flag else Test2(): +19 | reveal_type(x) # revealed: int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Test | Test2` may not be iterable + --> src/mdtest_snippet.py:18:14 + | +16 | # TODO: Improve error message to state which union variant isn't iterable (https://github.com/astral-sh/ruff/issues/13989) +17 | # error: [not-iterable] +18 | for x in Test() if flag else Test2(): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +19 | reveal_type(x) # revealed: int + | +info: Its `__iter__` method returns an object of type `TestIter | int`, which may not have a `__next__` method +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:19:21 + | +17 | # error: [not-iterable] +18 | for x in Test() if flag else Test2(): +19 | reveal_type(x) # revealed: int + | ^ `int` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(ba36fbef63a14969).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(ba36fbef63a14969).snap" new file mode 100644 index 0000000000000..8eb966da9ddb4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_Union_type_as_iterab\342\200\246_(ba36fbef63a14969).snap" @@ -0,0 +1,58 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - Union type as iterable where one union element has no `__iter__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class TestIter: + 4 | def __next__(self) -> int: + 5 | return 42 + 6 | + 7 | class Test: + 8 | def __iter__(self) -> TestIter: + 9 | return TestIter() +10 | +11 | def _(flag: bool): +12 | # error: [not-iterable] +13 | for x in Test() if flag else 42: +14 | reveal_type(x) # revealed: int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Test | Literal[42]` may not be iterable + --> src/mdtest_snippet.py:13:14 + | +11 | def _(flag: bool): +12 | # error: [not-iterable] +13 | for x in Test() if flag else 42: + | ^^^^^^^^^^^^^^^^^^^^^^ +14 | reveal_type(x) # revealed: int + | +info: It may not have an `__iter__` method and it doesn't have a `__getitem__` method +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:14:21 + | +12 | # error: [not-iterable] +13 | for x in Test() if flag else 42: +14 | reveal_type(x) # revealed: int + | ^ `int` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_With_non-callable_it\342\200\246_(a1cdf01ad69ac37c).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_With_non-callable_it\342\200\246_(a1cdf01ad69ac37c).snap" new file mode 100644 index 0000000000000..3e5d3bf4ebf20 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_With_non-callable_it\342\200\246_(a1cdf01ad69ac37c).snap" @@ -0,0 +1,72 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - With non-callable iterator +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def _(flag: bool): + 4 | class NotIterable: + 5 | if flag: + 6 | __iter__: int = 1 + 7 | else: + 8 | __iter__: None = None + 9 | +10 | # error: [not-iterable] +11 | for x in NotIterable(): +12 | pass +13 | +14 | # revealed: Unknown +15 | # error: [possibly-unresolved-reference] +16 | reveal_type(x) +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `NotIterable` is not iterable + --> src/mdtest_snippet.py:11:14 + | +10 | # error: [not-iterable] +11 | for x in NotIterable(): + | ^^^^^^^^^^^^^ +12 | pass + | +info: Its `__iter__` attribute has type `int | None`, which is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[possibly-unresolved-reference]: Name `x` used when possibly not defined + --> src/mdtest_snippet.py:16:17 + | +14 | # revealed: Unknown +15 | # error: [possibly-unresolved-reference] +16 | reveal_type(x) + | ^ + | +info: rule `possibly-unresolved-reference` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:16:17 + | +14 | # revealed: Unknown +15 | # error: [possibly-unresolved-reference] +16 | reveal_type(x) + | ^ `Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_does_not_\342\200\246_(92e3fdd69edad63d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_does_not_\342\200\246_(92e3fdd69edad63d).snap" new file mode 100644 index 0000000000000..25942db89e132 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_does_not_\342\200\246_(92e3fdd69edad63d).snap" @@ -0,0 +1,52 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - `__iter__` does not return an iterator +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing_extensions import reveal_type +2 | +3 | class Bad: +4 | def __iter__(self) -> int: +5 | return 42 +6 | +7 | # error: [not-iterable] +8 | for x in Bad(): +9 | reveal_type(x) # revealed: Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Bad` is not iterable + --> src/mdtest_snippet.py:8:10 + | +7 | # error: [not-iterable] +8 | for x in Bad(): + | ^^^^^ +9 | reveal_type(x) # revealed: Unknown + | +info: Its `__iter__` method returns an object of type `int`, which has no `__next__` method +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:9:17 + | +7 | # error: [not-iterable] +8 | for x in Bad(): +9 | reveal_type(x) # revealed: Unknown + | ^ `Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_method_wi\342\200\246_(1136c0e783d61ba4).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_method_wi\342\200\246_(1136c0e783d61ba4).snap" new file mode 100644 index 0000000000000..e37675bbc2806 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_method_wi\342\200\246_(1136c0e783d61ba4).snap" @@ -0,0 +1,57 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - `__iter__` method with a bad signature +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterator: + 4 | def __next__(self) -> int: + 5 | return 42 + 6 | + 7 | class Iterable: + 8 | def __iter__(self, extra_arg) -> Iterator: + 9 | return Iterator() +10 | +11 | # error: [not-iterable] +12 | for x in Iterable(): +13 | reveal_type(x) # revealed: int +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable` is not iterable + --> src/mdtest_snippet.py:12:10 + | +11 | # error: [not-iterable] +12 | for x in Iterable(): + | ^^^^^^^^^^ +13 | reveal_type(x) # revealed: int + | +info: Its `__iter__` method has an invalid signature +info: Expected signature `def __iter__(self): ...` +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:13:17 + | +11 | # error: [not-iterable] +12 | for x in Iterable(): +13 | reveal_type(x) # revealed: int + | ^ `int` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_returns_a\342\200\246_(707bd02a22c4acc8).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_returns_a\342\200\246_(707bd02a22c4acc8).snap" new file mode 100644 index 0000000000000..b5c24e5283a44 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/for.md_-_For_loops_-_`__iter__`_returns_a\342\200\246_(707bd02a22c4acc8).snap" @@ -0,0 +1,96 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: for.md - For loops - `__iter__` returns an iterator with an invalid `__next__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/loops/for.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Iterator1: + 4 | def __next__(self, extra_arg) -> int: + 5 | return 42 + 6 | + 7 | class Iterator2: + 8 | __next__: None = None + 9 | +10 | class Iterable1: +11 | def __iter__(self) -> Iterator1: +12 | return Iterator1() +13 | +14 | class Iterable2: +15 | def __iter__(self) -> Iterator2: +16 | return Iterator2() +17 | +18 | # error: [not-iterable] +19 | for x in Iterable1(): +20 | reveal_type(x) # revealed: int +21 | +22 | # error: [not-iterable] +23 | for y in Iterable2(): +24 | reveal_type(y) # revealed: Unknown +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Iterable1` is not iterable + --> src/mdtest_snippet.py:19:10 + | +18 | # error: [not-iterable] +19 | for x in Iterable1(): + | ^^^^^^^^^^^ +20 | reveal_type(x) # revealed: int + | +info: Its `__iter__` method returns an object of type `Iterator1`, which has an invalid `__next__` method +info: Expected signature for `__next__` is `def __next__(self): ...` +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:20:17 + | +18 | # error: [not-iterable] +19 | for x in Iterable1(): +20 | reveal_type(x) # revealed: int + | ^ `int` +21 | +22 | # error: [not-iterable] + | + +``` + +``` +error[not-iterable]: Object of type `Iterable2` is not iterable + --> src/mdtest_snippet.py:23:10 + | +22 | # error: [not-iterable] +23 | for y in Iterable2(): + | ^^^^^^^^^^^ +24 | reveal_type(y) # revealed: Unknown + | +info: Its `__iter__` method returns an object of type `Iterator2`, which has a `__next__` attribute that is not callable +info: rule `not-iterable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:24:17 + | +22 | # error: [not-iterable] +23 | for y in Iterable2(): +24 | reveal_type(y) # revealed: Unknown + | ^ `Unknown` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_bound_ty\342\200\246_(d50204b9d91b7bd1).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_bound_ty\342\200\246_(d50204b9d91b7bd1).snap" new file mode 100644 index 0000000000000..6225e86e0369f --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_bound_ty\342\200\246_(d50204b9d91b7bd1).snap" @@ -0,0 +1,91 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: functions.md - Generic functions: Legacy syntax - Inferring a bound typevar +mdtest path: crates/ty_python_semantic/resources/mdtest/generics/legacy/functions.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import TypeVar + 2 | from typing_extensions import reveal_type + 3 | + 4 | T = TypeVar("T", bound=int) + 5 | + 6 | def f(x: T) -> T: + 7 | return x + 8 | + 9 | reveal_type(f(1)) # revealed: Literal[1] +10 | reveal_type(f(True)) # revealed: Literal[True] +11 | # error: [invalid-argument-type] +12 | reveal_type(f("string")) # revealed: Unknown +``` + +# Diagnostics + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:9:13 + | + 7 | return x + 8 | + 9 | reveal_type(f(1)) # revealed: Literal[1] + | ^^^^ `Literal[1]` +10 | reveal_type(f(True)) # revealed: Literal[True] +11 | # error: [invalid-argument-type] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:10:13 + | + 9 | reveal_type(f(1)) # revealed: Literal[1] +10 | reveal_type(f(True)) # revealed: Literal[True] + | ^^^^^^^ `Literal[True]` +11 | # error: [invalid-argument-type] +12 | reveal_type(f("string")) # revealed: Unknown + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:12:13 + | +10 | reveal_type(f(True)) # revealed: Literal[True] +11 | # error: [invalid-argument-type] +12 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^^^^ `Unknown` + | + +``` + +``` +error[invalid-argument-type]: Argument to function `f` is incorrect + --> src/mdtest_snippet.py:12:15 + | +10 | reveal_type(f(True)) # revealed: Literal[True] +11 | # error: [invalid-argument-type] +12 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^ Argument type `Literal["string"]` does not satisfy upper bound of type variable `T` + | +info: Type variable defined here + --> src/mdtest_snippet.py:4:1 + | +2 | from typing_extensions import reveal_type +3 | +4 | T = TypeVar("T", bound=int) + | ^ +5 | +6 | def f(x: T) -> T: + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_constrai\342\200\246_(48ab83f977c109b4).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_constrai\342\200\246_(48ab83f977c109b4).snap" new file mode 100644 index 0000000000000..a965047627168 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___L\342\200\246_-_Inferring_a_constrai\342\200\246_(48ab83f977c109b4).snap" @@ -0,0 +1,106 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: functions.md - Generic functions: Legacy syntax - Inferring a constrained typevar +mdtest path: crates/ty_python_semantic/resources/mdtest/generics/legacy/functions.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import TypeVar + 2 | from typing_extensions import reveal_type + 3 | + 4 | T = TypeVar("T", int, None) + 5 | + 6 | def f(x: T) -> T: + 7 | return x + 8 | + 9 | reveal_type(f(1)) # revealed: int +10 | reveal_type(f(True)) # revealed: int +11 | reveal_type(f(None)) # revealed: None +12 | # error: [invalid-argument-type] +13 | reveal_type(f("string")) # revealed: Unknown +``` + +# Diagnostics + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:9:13 + | + 7 | return x + 8 | + 9 | reveal_type(f(1)) # revealed: int + | ^^^^ `int` +10 | reveal_type(f(True)) # revealed: int +11 | reveal_type(f(None)) # revealed: None + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:10:13 + | + 9 | reveal_type(f(1)) # revealed: int +10 | reveal_type(f(True)) # revealed: int + | ^^^^^^^ `int` +11 | reveal_type(f(None)) # revealed: None +12 | # error: [invalid-argument-type] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:11:13 + | + 9 | reveal_type(f(1)) # revealed: int +10 | reveal_type(f(True)) # revealed: int +11 | reveal_type(f(None)) # revealed: None + | ^^^^^^^ `None` +12 | # error: [invalid-argument-type] +13 | reveal_type(f("string")) # revealed: Unknown + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:13:13 + | +11 | reveal_type(f(None)) # revealed: None +12 | # error: [invalid-argument-type] +13 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^^^^ `Unknown` + | + +``` + +``` +error[invalid-argument-type]: Argument to function `f` is incorrect + --> src/mdtest_snippet.py:13:15 + | +11 | reveal_type(f(None)) # revealed: None +12 | # error: [invalid-argument-type] +13 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^ Argument type `Literal["string"]` does not satisfy constraints of type variable `T` + | +info: Type variable defined here + --> src/mdtest_snippet.py:4:1 + | +2 | from typing_extensions import reveal_type +3 | +4 | T = TypeVar("T", int, None) + | ^ +5 | +6 | def f(x: T) -> T: + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_bound_ty\342\200\246_(5935d14c26afe407).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_bound_ty\342\200\246_(5935d14c26afe407).snap" new file mode 100644 index 0000000000000..fc5bb331f1b0e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_bound_ty\342\200\246_(5935d14c26afe407).snap" @@ -0,0 +1,87 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: functions.md - Generic functions: PEP 695 syntax - Inferring a bound typevar +mdtest path: crates/ty_python_semantic/resources/mdtest/generics/pep695/functions.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing_extensions import reveal_type +2 | +3 | def f[T: int](x: T) -> T: +4 | return x +5 | +6 | reveal_type(f(1)) # revealed: Literal[1] +7 | reveal_type(f(True)) # revealed: Literal[True] +8 | # error: [invalid-argument-type] +9 | reveal_type(f("string")) # revealed: Unknown +``` + +# Diagnostics + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:6:13 + | +4 | return x +5 | +6 | reveal_type(f(1)) # revealed: Literal[1] + | ^^^^ `Literal[1]` +7 | reveal_type(f(True)) # revealed: Literal[True] +8 | # error: [invalid-argument-type] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:7:13 + | +6 | reveal_type(f(1)) # revealed: Literal[1] +7 | reveal_type(f(True)) # revealed: Literal[True] + | ^^^^^^^ `Literal[True]` +8 | # error: [invalid-argument-type] +9 | reveal_type(f("string")) # revealed: Unknown + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:9:13 + | +7 | reveal_type(f(True)) # revealed: Literal[True] +8 | # error: [invalid-argument-type] +9 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^^^^ `Unknown` + | + +``` + +``` +error[invalid-argument-type]: Argument to function `f` is incorrect + --> src/mdtest_snippet.py:9:15 + | +7 | reveal_type(f(True)) # revealed: Literal[True] +8 | # error: [invalid-argument-type] +9 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^ Argument type `Literal["string"]` does not satisfy upper bound of type variable `T` + | +info: Type variable defined here + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import reveal_type +2 | +3 | def f[T: int](x: T) -> T: + | ^^^^^^ +4 | return x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_constrai\342\200\246_(d2c475fccc70a8e2).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_constrai\342\200\246_(d2c475fccc70a8e2).snap" new file mode 100644 index 0000000000000..8a961a23fcf5e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/functions.md_-_Generic_functions___P\342\200\246_-_Inferring_a_constrai\342\200\246_(d2c475fccc70a8e2).snap" @@ -0,0 +1,102 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: functions.md - Generic functions: PEP 695 syntax - Inferring a constrained typevar +mdtest path: crates/ty_python_semantic/resources/mdtest/generics/pep695/functions.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def f[T: (int, None)](x: T) -> T: + 4 | return x + 5 | + 6 | reveal_type(f(1)) # revealed: int + 7 | reveal_type(f(True)) # revealed: int + 8 | reveal_type(f(None)) # revealed: None + 9 | # error: [invalid-argument-type] +10 | reveal_type(f("string")) # revealed: Unknown +``` + +# Diagnostics + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:6:13 + | +4 | return x +5 | +6 | reveal_type(f(1)) # revealed: int + | ^^^^ `int` +7 | reveal_type(f(True)) # revealed: int +8 | reveal_type(f(None)) # revealed: None + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:7:13 + | +6 | reveal_type(f(1)) # revealed: int +7 | reveal_type(f(True)) # revealed: int + | ^^^^^^^ `int` +8 | reveal_type(f(None)) # revealed: None +9 | # error: [invalid-argument-type] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:8:13 + | + 6 | reveal_type(f(1)) # revealed: int + 7 | reveal_type(f(True)) # revealed: int + 8 | reveal_type(f(None)) # revealed: None + | ^^^^^^^ `None` + 9 | # error: [invalid-argument-type] +10 | reveal_type(f("string")) # revealed: Unknown + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:10:13 + | + 8 | reveal_type(f(None)) # revealed: None + 9 | # error: [invalid-argument-type] +10 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^^^^ `Unknown` + | + +``` + +``` +error[invalid-argument-type]: Argument to function `f` is incorrect + --> src/mdtest_snippet.py:10:15 + | + 8 | reveal_type(f(None)) # revealed: None + 9 | # error: [invalid-argument-type] +10 | reveal_type(f("string")) # revealed: Unknown + | ^^^^^^^^ Argument type `Literal["string"]` does not satisfy constraints of type variable `T` + | +info: Type variable defined here + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import reveal_type +2 | +3 | def f[T: (int, None)](x: T) -> T: + | ^^^^^^^^^^^^^^ +4 | return x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/instances.md_-_Binary_operations_on\342\200\246_-_Operations_involving\342\200\246_(492b1163b8163c05).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/instances.md_-_Binary_operations_on\342\200\246_-_Operations_involving\342\200\246_(492b1163b8163c05).snap" new file mode 100644 index 0000000000000..ac85e00fa018c --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/instances.md_-_Binary_operations_on\342\200\246_-_Operations_involving\342\200\246_(492b1163b8163c05).snap" @@ -0,0 +1,37 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: instances.md - Binary operations on instances - Operations involving types with invalid `__bool__` methods +mdtest path: crates/ty_python_semantic/resources/mdtest/binary/instances.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | __bool__: int = 3 +3 | +4 | a = NotBoolable() +5 | +6 | # error: [unsupported-bool-conversion] +7 | 10 and a and True +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:7:8 + | +6 | # error: [unsupported-bool-conversion] +7 | 10 and a and True + | ^ + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid.md_-_Tests_for_invalid_ty\342\200\246_-_Diagnostics_for_comm\342\200\246_-_Module-literal_used_\342\200\246_(652fec4fd4a6c63a).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid.md_-_Tests_for_invalid_ty\342\200\246_-_Diagnostics_for_comm\342\200\246_-_Module-literal_used_\342\200\246_(652fec4fd4a6c63a).snap" new file mode 100644 index 0000000000000..abe619e045871 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid.md_-_Tests_for_invalid_ty\342\200\246_-_Diagnostics_for_comm\342\200\246_-_Module-literal_used_\342\200\246_(652fec4fd4a6c63a).snap" @@ -0,0 +1,62 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid.md - Tests for invalid types in type expressions - Diagnostics for common errors - Module-literal used when you meant to use a class from that module +mdtest path: crates/ty_python_semantic/resources/mdtest/annotations/invalid.md +--- + +# Python source files + +## foo.py + +``` +1 | import datetime +2 | +3 | def f(x: datetime): ... # error: [invalid-type-form] +``` + +## PIL/Image.py + +``` +1 | class Image: ... +``` + +## bar.py + +``` +1 | from PIL import Image +2 | +3 | def g(x: Image): ... # error: [invalid-type-form] +``` + +# Diagnostics + +``` +error[invalid-type-form]: Variable of type `<module 'datetime'>` is not allowed in a type expression + --> src/foo.py:3:10 + | +1 | import datetime +2 | +3 | def f(x: datetime): ... # error: [invalid-type-form] + | ^^^^^^^^ + | +info: Did you mean to use the module's member `datetime.datetime` instead? +info: rule `invalid-type-form` is enabled by default + +``` + +``` +error[invalid-type-form]: Variable of type `<module 'PIL.Image'>` is not allowed in a type expression + --> src/bar.py:3:10 + | +1 | from PIL import Image +2 | +3 | def g(x: Image): ... # error: [invalid-type-form] + | ^^^^^ + | +info: Did you mean to use the module's member `Image.Image` instead? +info: rule `invalid-type-form` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Basic_(16be9d90a741761).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Basic_(16be9d90a741761).snap" new file mode 100644 index 0000000000000..2dbdf7c5250e4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Basic_(16be9d90a741761).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Basic +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int) -> int: +2 | return x * x +3 | +4 | foo("hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:5 + | +2 | return x * x +3 | +4 | foo("hello") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Calls_to_methods_(4b3b8695d519a02).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Calls_to_methods_(4b3b8695d519a02).snap" new file mode 100644 index 0000000000000..e0483e581db39 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Calls_to_methods_(4b3b8695d519a02).snap" @@ -0,0 +1,43 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Calls to methods +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: +2 | def square(self, x: int) -> int: +3 | return x * x +4 | +5 | c = C() +6 | c.square("hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to bound method `square` is incorrect + --> src/mdtest_snippet.py:6:10 + | +5 | c = C() +6 | c.square("hello") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:2:9 + | +1 | class C: +2 | def square(self, x: int) -> int: + | ^^^^^^ ------ Parameter declared here +3 | return x * x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_files_(d02c38e2dd054b4c).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_files_(d02c38e2dd054b4c).snap" new file mode 100644 index 0000000000000..f192c9723a836 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_files_(d02c38e2dd054b4c).snap" @@ -0,0 +1,47 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Different files +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## package.py + +``` +1 | def foo(x: int) -> int: +2 | return x * x +``` + +## mdtest_snippet.py + +``` +1 | import package +2 | +3 | package.foo("hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:3:13 + | +1 | import package +2 | +3 | package.foo("hello") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/package.py:1:5 + | +1 | def foo(x: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_source_ord\342\200\246_(9b0bf549733d3f0a).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_source_ord\342\200\246_(9b0bf549733d3f0a).snap" new file mode 100644 index 0000000000000..672717075387d --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Different_source_ord\342\200\246_(9b0bf549733d3f0a).snap" @@ -0,0 +1,45 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Different source order +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def bar(): +2 | foo("hello") # error: [invalid-argument-type] +3 | +4 | def foo(x: int) -> int: +5 | return x * x +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:2:9 + | +1 | def bar(): +2 | foo("hello") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` +3 | +4 | def foo(x: int) -> int: + | +info: Function defined here + --> src/mdtest_snippet.py:4:5 + | +2 | foo("hello") # error: [invalid-argument-type] +3 | +4 | def foo(x: int) -> int: + | ^^^ ------ Parameter declared here +5 | return x * x + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_(ee38fd34ceba3293).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_(ee38fd34ceba3293).snap" new file mode 100644 index 0000000000000..d26e1fe2f9c0a --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_(ee38fd34ceba3293).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Many parameters +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, y: int, z: int) -> int: +2 | return x * y * z +3 | +4 | foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:8 + | +2 | return x * y * z +3 | +4 | foo(1, "hello", 3) # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_acro\342\200\246_(1d5d112808c49e9d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_acro\342\200\246_(1d5d112808c49e9d).snap" new file mode 100644 index 0000000000000..e9e1198983d2e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_acro\342\200\246_(1d5d112808c49e9d).snap" @@ -0,0 +1,49 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Many parameters across multiple lines +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo( +2 | x: int, +3 | y: int, +4 | z: int, +5 | ) -> int: +6 | return x * y * z +7 | +8 | foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:8:8 + | +6 | return x * y * z +7 | +8 | foo(1, "hello", 3) # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo( + | ^^^ +2 | x: int, +3 | y: int, + | ------ Parameter declared here +4 | z: int, +5 | ) -> int: + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_with\342\200\246_(4bc5c16cd568b8ec).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_with\342\200\246_(4bc5c16cd568b8ec).snap" new file mode 100644 index 0000000000000..6aa878c8df62e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Many_parameters_with\342\200\246_(4bc5c16cd568b8ec).snap" @@ -0,0 +1,84 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Many parameters with multiple invalid arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, y: int, z: int) -> int: +2 | return x * y * z +3 | +4 | # error: [invalid-argument-type] +5 | # error: [invalid-argument-type] +6 | # error: [invalid-argument-type] +7 | foo("a", "b", "c") +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:7:5 + | +5 | # error: [invalid-argument-type] +6 | # error: [invalid-argument-type] +7 | foo("a", "b", "c") + | ^^^ Expected `int`, found `Literal["a"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:7:10 + | +5 | # error: [invalid-argument-type] +6 | # error: [invalid-argument-type] +7 | foo("a", "b", "c") + | ^^^ Expected `int`, found `Literal["b"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:7:15 + | +5 | # error: [invalid-argument-type] +6 | # error: [invalid-argument-type] +7 | foo("a", "b", "c") + | ^^^ Expected `int`, found `Literal["c"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int) -> int: + | ^^^ ------ Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Test_calling_a_funct\342\200\246_(3b18271a821a59b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Test_calling_a_funct\342\200\246_(3b18271a821a59b).snap" new file mode 100644 index 0000000000000..a608b1f7de9cb --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Test_calling_a_funct\342\200\246_(3b18271a821a59b).snap" @@ -0,0 +1,45 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Test calling a function whose type is vendored from `typeshed` +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | import json +2 | +3 | json.loads(5) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `loads` is incorrect + --> src/mdtest_snippet.py:3:12 + | +1 | import json +2 | +3 | json.loads(5) # error: [invalid-argument-type] + | ^ Expected `str | bytes | bytearray`, found `Literal[5]` + | +info: Function defined here + --> stdlib/json/__init__.pyi:39:5 + | +37 | **kwds: Any, +38 | ) -> None: ... +39 | def loads( + | ^^^^^ +40 | s: str | bytes | bytearray, + | -------------------------- Parameter declared here +41 | *, +42 | cls: type[JSONDecoder] | None = None, + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Keyword_only_argumen\342\200\246_(8d9f18c78137411).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Keyword_only_argumen\342\200\246_(8d9f18c78137411).snap" new file mode 100644 index 0000000000000..640a3f0d5c84a --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Keyword_only_argumen\342\200\246_(8d9f18c78137411).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Keyword only arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, y: int, *, z: int = 0) -> int: +2 | return x * y * z +3 | +4 | foo(1, 2, z="hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:11 + | +2 | return x * y * z +3 | +4 | foo(1, 2, z="hello") # error: [invalid-argument-type] + | ^^^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, *, z: int = 0) -> int: + | ^^^ ---------- Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Mix_of_arguments_(cfc64b1136058112).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Mix_of_arguments_(cfc64b1136058112).snap" new file mode 100644 index 0000000000000..b2b1b00b55a80 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Mix_of_arguments_(cfc64b1136058112).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Mix of arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, /, y: int, *, z: int = 0) -> int: +2 | return x * y * z +3 | +4 | foo(1, 2, z="hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:11 + | +2 | return x * y * z +3 | +4 | foo(1, 2, z="hello") # error: [invalid-argument-type] + | ^^^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, /, y: int, *, z: int = 0) -> int: + | ^^^ ---------- Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_One_keyword_argument_(cc34b2f7d19d427e).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_One_keyword_argument_(cc34b2f7d19d427e).snap" new file mode 100644 index 0000000000000..a43e5fa7f870d --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_One_keyword_argument_(cc34b2f7d19d427e).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - One keyword argument +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, y: int, z: int = 0) -> int: +2 | return x * y * z +3 | +4 | foo(1, 2, "hello") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:11 + | +2 | return x * y * z +3 | +4 | foo(1, 2, "hello") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int = 0) -> int: + | ^^^ ---------- Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Only_positional_(3dc93b1709eb3be9).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Only_positional_(3dc93b1709eb3be9).snap" new file mode 100644 index 0000000000000..c2647c7550542 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Only_positional_(3dc93b1709eb3be9).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Only positional +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(x: int, y: int, z: int, /) -> int: +2 | return x * y * z +3 | +4 | foo(1, "hello", 3) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:8 + | +2 | return x * y * z +3 | +4 | foo(1, "hello", 3) # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(x: int, y: int, z: int, /) -> int: + | ^^^ ------ Parameter declared here +2 | return x * y * z + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Synthetic_arguments_(4c09844bbbf47741).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Synthetic_arguments_(4c09844bbbf47741).snap" new file mode 100644 index 0000000000000..a21d9085a59bb --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Synthetic_arguments_(4c09844bbbf47741).snap" @@ -0,0 +1,43 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Synthetic arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: +2 | def __call__(self, x: int) -> int: +3 | return 1 +4 | +5 | c = C() +6 | c("wrong") # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to bound method `__call__` is incorrect + --> src/mdtest_snippet.py:6:3 + | +5 | c = C() +6 | c("wrong") # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["wrong"]` + | +info: Function defined here + --> src/mdtest_snippet.py:2:9 + | +1 | class C: +2 | def __call__(self, x: int) -> int: + | ^^^^^^^^ ------ Parameter declared here +3 | return 1 + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_arguments_(e26a3e7b2773a63b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_arguments_(e26a3e7b2773a63b).snap" new file mode 100644 index 0000000000000..bd74bf3b8db79 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_arguments_(e26a3e7b2773a63b).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Variadic arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(*numbers: int) -> int: +2 | return len(numbers) +3 | +4 | foo(1, 2, 3, "hello", 5) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:14 + | +2 | return len(numbers) +3 | +4 | foo(1, 2, 3, "hello", 5) # error: [invalid-argument-type] + | ^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(*numbers: int) -> int: + | ^^^ ------------- Parameter declared here +2 | return len(numbers) + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_keyword_arg\342\200\246_(4c855e39ea6baeaf).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_keyword_arg\342\200\246_(4c855e39ea6baeaf).snap" new file mode 100644 index 0000000000000..fe922058743a8 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/invalid_argument_typ\342\200\246_-_Invalid_argument_typ\342\200\246_-_Tests_for_a_variety_\342\200\246_-_Variadic_keyword_arg\342\200\246_(4c855e39ea6baeaf).snap" @@ -0,0 +1,41 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: invalid_argument_type.md - Invalid argument type diagnostics - Tests for a variety of argument types - Variadic keyword arguments +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/invalid_argument_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def foo(**numbers: int) -> int: +2 | return len(numbers) +3 | +4 | foo(a=1, b=2, c=3, d="hello", e=5) # error: [invalid-argument-type] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `foo` is incorrect + --> src/mdtest_snippet.py:4:20 + | +2 | return len(numbers) +3 | +4 | foo(a=1, b=2, c=3, d="hello", e=5) # error: [invalid-argument-type] + | ^^^^^^^^^ Expected `int`, found `Literal["hello"]` + | +info: Function defined here + --> src/mdtest_snippet.py:1:5 + | +1 | def foo(**numbers: int) -> int: + | ^^^ -------------- Parameter declared here +2 | return len(numbers) + | +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/membership_test.md_-_Comparison___Membersh\342\200\246_-_Return_type_that_doe\342\200\246_(feccf6b9da1e7cd3).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/membership_test.md_-_Comparison___Membersh\342\200\246_-_Return_type_that_doe\342\200\246_(feccf6b9da1e7cd3).snap" new file mode 100644 index 0000000000000..d6698b03f4b34 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/membership_test.md_-_Comparison___Membersh\342\200\246_-_Return_type_that_doe\342\200\246_(feccf6b9da1e7cd3).snap" @@ -0,0 +1,57 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: membership_test.md - Comparison: Membership Test - Return type that doesn't implement `__bool__` correctly +mdtest path: crates/ty_python_semantic/resources/mdtest/comparison/instances/membership_test.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class NotBoolable: + 2 | __bool__: int = 3 + 3 | + 4 | class WithContains: + 5 | def __contains__(self, item) -> NotBoolable: + 6 | return NotBoolable() + 7 | + 8 | # error: [unsupported-bool-conversion] + 9 | 10 in WithContains() +10 | # error: [unsupported-bool-conversion] +11 | 10 not in WithContains() +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:9:1 + | + 8 | # error: [unsupported-bool-conversion] + 9 | 10 in WithContains() + | ^^^^^^^^^^^^^^^^^^^^ +10 | # error: [unsupported-bool-conversion] +11 | 10 not in WithContains() + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:11:1 + | + 9 | 10 in WithContains() +10 | # error: [unsupported-bool-conversion] +11 | 10 not in WithContains() + | ^^^^^^^^^^^^^^^^^^^^^^^^ + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_includes\342\200\246_(d2532518c44112c8).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_includes\342\200\246_(d2532518c44112c8).snap" new file mode 100644 index 0000000000000..1b60443d4da5c --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_includes\342\200\246_(d2532518c44112c8).snap" @@ -0,0 +1,78 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: mro.md - Method Resolution Order tests - `__bases__` includes a `Union` +mdtest path: crates/ty_python_semantic/resources/mdtest/mro.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | def returns_bool() -> bool: + 4 | return True + 5 | + 6 | class A: ... + 7 | class B: ... + 8 | + 9 | if returns_bool(): +10 | x = A +11 | else: +12 | x = B +13 | +14 | reveal_type(x) # revealed: <class 'A'> | <class 'B'> +15 | +16 | # error: 11 [unsupported-base] "Unsupported class base with type `<class 'A'> | <class 'B'>`" +17 | class Foo(x): ... +18 | +19 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] +``` + +# Diagnostics + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:14:13 + | +12 | x = B +13 | +14 | reveal_type(x) # revealed: <class 'A'> | <class 'B'> + | ^ `<class 'A'> | <class 'B'>` +15 | +16 | # error: 11 [unsupported-base] "Unsupported class base with type `<class 'A'> | <class 'B'>`" + | + +``` + +``` +warning[unsupported-base]: Unsupported class base with type `<class 'A'> | <class 'B'>` + --> src/mdtest_snippet.py:17:11 + | +16 | # error: 11 [unsupported-base] "Unsupported class base with type `<class 'A'> | <class 'B'>`" +17 | class Foo(x): ... + | ^ +18 | +19 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + | +info: ty cannot resolve a consistent MRO for class `Foo` due to this base +info: Only class objects or `Any` are supported as class bases +info: rule `unsupported-base` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:19:13 + | +17 | class Foo(x): ... +18 | +19 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + | ^^^^^^^^^^^ `tuple[<class 'Foo'>, Unknown, <class 'object'>]` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_th\342\200\246_(6f8d0bf648c4b305).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_th\342\200\246_(6f8d0bf648c4b305).snap" new file mode 100644 index 0000000000000..3a7a401bb766e --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_th\342\200\246_(6f8d0bf648c4b305).snap" @@ -0,0 +1,97 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: mro.md - Method Resolution Order tests - `__bases__` lists that include objects that are not instances of `type` +mdtest path: crates/ty_python_semantic/resources/mdtest/mro.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class Foo(2): ... # error: [invalid-base] + 2 | class Foo: + 3 | def __mro_entries__(self, bases: tuple[type, ...]) -> tuple[type, ...]: + 4 | return () + 5 | + 6 | class Bar(Foo()): ... # error: [unsupported-base] + 7 | class Bad1: + 8 | def __mro_entries__(self, bases, extra_arg): + 9 | return () +10 | +11 | class Bad2: +12 | def __mro_entries__(self, bases) -> int: +13 | return 42 +14 | +15 | class BadSub1(Bad1()): ... # error: [invalid-base] +16 | class BadSub2(Bad2()): ... # error: [invalid-base] +``` + +# Diagnostics + +``` +error[invalid-base]: Invalid class base with type `Literal[2]` + --> src/mdtest_snippet.py:1:11 + | +1 | class Foo(2): ... # error: [invalid-base] + | ^ +2 | class Foo: +3 | def __mro_entries__(self, bases: tuple[type, ...]) -> tuple[type, ...]: + | +info: Definition of class `Foo` will raise `TypeError` at runtime +info: rule `invalid-base` is enabled by default + +``` + +``` +warning[unsupported-base]: Unsupported class base with type `Foo` + --> src/mdtest_snippet.py:6:11 + | +4 | return () +5 | +6 | class Bar(Foo()): ... # error: [unsupported-base] + | ^^^^^ +7 | class Bad1: +8 | def __mro_entries__(self, bases, extra_arg): + | +info: ty cannot resolve a consistent MRO for class `Bar` due to this base +info: Only class objects or `Any` are supported as class bases +info: rule `unsupported-base` is enabled by default + +``` + +``` +error[invalid-base]: Invalid class base with type `Bad1` + --> src/mdtest_snippet.py:15:15 + | +13 | return 42 +14 | +15 | class BadSub1(Bad1()): ... # error: [invalid-base] + | ^^^^^^ +16 | class BadSub2(Bad2()): ... # error: [invalid-base] + | +info: Definition of class `BadSub1` will raise `TypeError` at runtime +info: An instance type is only a valid class base if it has a valid `__mro_entries__` method +info: Type `Bad1` has an `__mro_entries__` method, but it cannot be called with the expected arguments +info: Expected a signature at least as permissive as `def __mro_entries__(self, bases: tuple[type, ...], /) -> tuple[type, ...]` +info: rule `invalid-base` is enabled by default + +``` + +``` +error[invalid-base]: Invalid class base with type `Bad2` + --> src/mdtest_snippet.py:16:15 + | +15 | class BadSub1(Bad1()): ... # error: [invalid-base] +16 | class BadSub2(Bad2()): ... # error: [invalid-base] + | ^^^^^^ + | +info: Definition of class `BadSub2` will raise `TypeError` at runtime +info: An instance type is only a valid class base if it has a valid `__mro_entries__` method +info: Type `Bad2` has an `__mro_entries__` method, but it does not return a tuple of types +info: rule `invalid-base` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_wi\342\200\246_(ea7ebc83ec359b54).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_wi\342\200\246_(ea7ebc83ec359b54).snap" new file mode 100644 index 0000000000000..fceb6462c89ec --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/mro.md_-_Method_Resolution_Or\342\200\246_-_`__bases__`_lists_wi\342\200\246_(ea7ebc83ec359b54).snap" @@ -0,0 +1,402 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: mro.md - Method Resolution Order tests - `__bases__` lists with duplicate bases +mdtest path: crates/ty_python_semantic/resources/mdtest/mro.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import reveal_type + 2 | + 3 | class Foo(str, str): ... # error: [duplicate-base] "Duplicate base class `str`" + 4 | + 5 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + 6 | + 7 | class Spam: ... + 8 | class Eggs: ... + 9 | class Bar: ... +10 | class Baz: ... +11 | +12 | # fmt: off +13 | +14 | # error: [duplicate-base] "Duplicate base class `Spam`" +15 | # error: [duplicate-base] "Duplicate base class `Eggs`" +16 | class Ham( +17 | Spam, +18 | Eggs, +19 | Bar, +20 | Baz, +21 | Spam, +22 | Eggs, +23 | ): ... +24 | +25 | # fmt: on +26 | +27 | reveal_type(Ham.__mro__) # revealed: tuple[<class 'Ham'>, Unknown, <class 'object'>] +28 | +29 | class Mushrooms: ... +30 | class Omelette(Spam, Eggs, Mushrooms, Mushrooms): ... # error: [duplicate-base] +31 | +32 | reveal_type(Omelette.__mro__) # revealed: tuple[<class 'Omelette'>, Unknown, <class 'object'>] +33 | +34 | # fmt: off +35 | +36 | # error: [duplicate-base] "Duplicate base class `Eggs`" +37 | class VeryEggyOmelette( +38 | Eggs, +39 | Ham, +40 | Spam, +41 | Eggs, +42 | Mushrooms, +43 | Bar, +44 | Eggs, +45 | Baz, +46 | Eggs, +47 | ): ... +48 | +49 | # fmt: off +50 | # fmt: off +51 | +52 | class A: ... +53 | +54 | class B( # type: ignore[duplicate-base] +55 | A, +56 | A, +57 | ): ... +58 | +59 | class C( +60 | A, +61 | A +62 | ): # type: ignore[duplicate-base] +63 | x: int +64 | +65 | # fmt: on +66 | # fmt: off +67 | +68 | # error: [duplicate-base] +69 | class D( +70 | A, +71 | # error: [unused-ignore-comment] +72 | A, # type: ignore[duplicate-base] +73 | ): ... +74 | +75 | # error: [duplicate-base] +76 | class E( +77 | A, +78 | A +79 | ): +80 | # error: [unused-ignore-comment] +81 | x: int # type: ignore[duplicate-base] +82 | +83 | # fmt: on +``` + +# Diagnostics + +``` +error[duplicate-base]: Duplicate base class `str` + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import reveal_type +2 | +3 | class Foo(str, str): ... # error: [duplicate-base] "Duplicate base class `str`" + | ^^^^^^^^^^^^^ +4 | +5 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + | +info: The definition of class `Foo` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:3:11 + | +1 | from typing_extensions import reveal_type +2 | +3 | class Foo(str, str): ... # error: [duplicate-base] "Duplicate base class `str`" + | --- ^^^ Class `str` later repeated here + | | + | Class `str` first included in bases list here +4 | +5 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:5:13 + | +3 | class Foo(str, str): ... # error: [duplicate-base] "Duplicate base class `str`" +4 | +5 | reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, Unknown, <class 'object'>] + | ^^^^^^^^^^^ `tuple[<class 'Foo'>, Unknown, <class 'object'>]` +6 | +7 | class Spam: ... + | + +``` + +``` +error[duplicate-base]: Duplicate base class `Spam` + --> src/mdtest_snippet.py:16:7 + | +14 | # error: [duplicate-base] "Duplicate base class `Spam`" +15 | # error: [duplicate-base] "Duplicate base class `Eggs`" +16 | class Ham( + | _______^ +17 | | Spam, +18 | | Eggs, +19 | | Bar, +20 | | Baz, +21 | | Spam, +22 | | Eggs, +23 | | ): ... + | |_^ +24 | +25 | # fmt: on + | +info: The definition of class `Ham` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:17:5 + | +15 | # error: [duplicate-base] "Duplicate base class `Eggs`" +16 | class Ham( +17 | Spam, + | ---- Class `Spam` first included in bases list here +18 | Eggs, +19 | Bar, +20 | Baz, +21 | Spam, + | ^^^^ Class `Spam` later repeated here +22 | Eggs, +23 | ): ... + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +error[duplicate-base]: Duplicate base class `Eggs` + --> src/mdtest_snippet.py:16:7 + | +14 | # error: [duplicate-base] "Duplicate base class `Spam`" +15 | # error: [duplicate-base] "Duplicate base class `Eggs`" +16 | class Ham( + | _______^ +17 | | Spam, +18 | | Eggs, +19 | | Bar, +20 | | Baz, +21 | | Spam, +22 | | Eggs, +23 | | ): ... + | |_^ +24 | +25 | # fmt: on + | +info: The definition of class `Ham` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:18:5 + | +16 | class Ham( +17 | Spam, +18 | Eggs, + | ---- Class `Eggs` first included in bases list here +19 | Bar, +20 | Baz, +21 | Spam, +22 | Eggs, + | ^^^^ Class `Eggs` later repeated here +23 | ): ... + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:27:13 + | +25 | # fmt: on +26 | +27 | reveal_type(Ham.__mro__) # revealed: tuple[<class 'Ham'>, Unknown, <class 'object'>] + | ^^^^^^^^^^^ `tuple[<class 'Ham'>, Unknown, <class 'object'>]` +28 | +29 | class Mushrooms: ... + | + +``` + +``` +error[duplicate-base]: Duplicate base class `Mushrooms` + --> src/mdtest_snippet.py:30:7 + | +29 | class Mushrooms: ... +30 | class Omelette(Spam, Eggs, Mushrooms, Mushrooms): ... # error: [duplicate-base] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +31 | +32 | reveal_type(Omelette.__mro__) # revealed: tuple[<class 'Omelette'>, Unknown, <class 'object'>] + | +info: The definition of class `Omelette` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:30:28 + | +29 | class Mushrooms: ... +30 | class Omelette(Spam, Eggs, Mushrooms, Mushrooms): ... # error: [duplicate-base] + | --------- ^^^^^^^^^ Class `Mushrooms` later repeated here + | | + | Class `Mushrooms` first included in bases list here +31 | +32 | reveal_type(Omelette.__mro__) # revealed: tuple[<class 'Omelette'>, Unknown, <class 'object'>] + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:32:13 + | +30 | class Omelette(Spam, Eggs, Mushrooms, Mushrooms): ... # error: [duplicate-base] +31 | +32 | reveal_type(Omelette.__mro__) # revealed: tuple[<class 'Omelette'>, Unknown, <class 'object'>] + | ^^^^^^^^^^^^^^^^ `tuple[<class 'Omelette'>, Unknown, <class 'object'>]` +33 | +34 | # fmt: off + | + +``` + +``` +error[duplicate-base]: Duplicate base class `Eggs` + --> src/mdtest_snippet.py:37:7 + | +36 | # error: [duplicate-base] "Duplicate base class `Eggs`" +37 | class VeryEggyOmelette( + | _______^ +38 | | Eggs, +39 | | Ham, +40 | | Spam, +41 | | Eggs, +42 | | Mushrooms, +43 | | Bar, +44 | | Eggs, +45 | | Baz, +46 | | Eggs, +47 | | ): ... + | |_^ +48 | +49 | # fmt: off + | +info: The definition of class `VeryEggyOmelette` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:38:5 + | +36 | # error: [duplicate-base] "Duplicate base class `Eggs`" +37 | class VeryEggyOmelette( +38 | Eggs, + | ---- Class `Eggs` first included in bases list here +39 | Ham, +40 | Spam, +41 | Eggs, + | ^^^^ Class `Eggs` later repeated here +42 | Mushrooms, +43 | Bar, +44 | Eggs, + | ^^^^ Class `Eggs` later repeated here +45 | Baz, +46 | Eggs, + | ^^^^ Class `Eggs` later repeated here +47 | ): ... + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +error[duplicate-base]: Duplicate base class `A` + --> src/mdtest_snippet.py:69:7 + | +68 | # error: [duplicate-base] +69 | class D( + | _______^ +70 | | A, +71 | | # error: [unused-ignore-comment] +72 | | A, # type: ignore[duplicate-base] +73 | | ): ... + | |_^ +74 | +75 | # error: [duplicate-base] + | +info: The definition of class `D` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:70:5 + | +68 | # error: [duplicate-base] +69 | class D( +70 | A, + | - Class `A` first included in bases list here +71 | # error: [unused-ignore-comment] +72 | A, # type: ignore[duplicate-base] + | ^ Class `A` later repeated here +73 | ): ... + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +info[unused-ignore-comment] + --> src/mdtest_snippet.py:72:9 + | +70 | A, +71 | # error: [unused-ignore-comment] +72 | A, # type: ignore[duplicate-base] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Unused blanket `type: ignore` directive +73 | ): ... + | + +``` + +``` +error[duplicate-base]: Duplicate base class `A` + --> src/mdtest_snippet.py:76:7 + | +75 | # error: [duplicate-base] +76 | class E( + | _______^ +77 | | A, +78 | | A +79 | | ): + | |_^ +80 | # error: [unused-ignore-comment] +81 | x: int # type: ignore[duplicate-base] + | +info: The definition of class `E` will raise `TypeError` at runtime + --> src/mdtest_snippet.py:77:5 + | +75 | # error: [duplicate-base] +76 | class E( +77 | A, + | - Class `A` first included in bases list here +78 | A + | ^ Class `A` later repeated here +79 | ): +80 | # error: [unused-ignore-comment] + | +info: rule `duplicate-base` is enabled by default + +``` + +``` +info[unused-ignore-comment] + --> src/mdtest_snippet.py:81:13 + | +79 | ): +80 | # error: [unused-ignore-comment] +81 | x: int # type: ignore[duplicate-base] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Unused blanket `type: ignore` directive +82 | +83 | # fmt: on + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_class_constructor_\342\200\246_(dd9f8a8f736a329).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_class_constructor_\342\200\246_(dd9f8a8f736a329).snap" new file mode 100644 index 0000000000000..9a446afe71840 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_class_constructor_\342\200\246_(dd9f8a8f736a329).snap" @@ -0,0 +1,29 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - A class constructor with unmatched overloads +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | type() # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of class `type` matches arguments + --> src/mdtest_snippet.py:1:1 + | +1 | type() # error: [no-matching-overload] + | ^^^^^^ + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_method_call_with_u\342\200\246_(31cb5f881221158e).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_method_call_with_u\342\200\246_(31cb5f881221158e).snap" new file mode 100644 index 0000000000000..66eccf602ade6 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_A_method_call_with_u\342\200\246_(31cb5f881221158e).snap" @@ -0,0 +1,63 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - A method call with unmatched overloads +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | class Foo: + 4 | @overload + 5 | def bar(self, x: int) -> int: ... + 6 | @overload + 7 | def bar(self, x: str) -> str: ... + 8 | def bar(self, x: int | str) -> int | str: + 9 | return x +10 | +11 | foo = Foo() +12 | foo.bar(b"wat") # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of bound method `bar` matches arguments + --> src/mdtest_snippet.py:12:1 + | +11 | foo = Foo() +12 | foo.bar(b"wat") # error: [no-matching-overload] + | ^^^^^^^^^^^^^^^ + | +info: First overload defined here + --> src/mdtest_snippet.py:5:9 + | +3 | class Foo: +4 | @overload +5 | def bar(self, x: int) -> int: ... + | ^^^^^^^^^^^^^^^^^^^^^^^^ +6 | @overload +7 | def bar(self, x: str) -> str: ... + | +info: Possible overloads for bound method `bar`: +info: (self, x: int) -> int +info: (self, x: str) -> str +info: Overload implementation defined here + --> src/mdtest_snippet.py:8:9 + | +6 | @overload +7 | def bar(self, x: str) -> str: ... +8 | def bar(self, x: int | str) -> int | str: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +9 | return x + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(dd80c593d9136f35).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(dd80c593d9136f35).snap" new file mode 100644 index 0000000000000..68563b01be43a --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(dd80c593d9136f35).snap" @@ -0,0 +1,120 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - Call to function with many unmatched overloads +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | class Foo: ... + 4 | + 5 | @overload + 6 | def foo(a: int, b: int, c: int): ... + 7 | @overload + 8 | def foo(a: str, b: int, c: int): ... + 9 | @overload +10 | def foo(a: int, b: str, c: int): ... +11 | @overload +12 | def foo(a: int, b: int, c: str): ... +13 | @overload +14 | def foo(a: str, b: str, c: int): ... +15 | @overload +16 | def foo(a: int, b: str, c: str): ... +17 | @overload +18 | def foo(a: str, b: str, c: str): ... +19 | @overload +20 | def foo(a: int, b: int, c: int): ... +21 | @overload +22 | def foo(a: float, b: int, c: int): ... +23 | @overload +24 | def foo(a: int, b: float, c: int): ... +25 | @overload +26 | def foo(a: int, b: int, c: float): ... +27 | @overload +28 | def foo(a: float, b: float, c: int): ... +29 | @overload +30 | def foo(a: int, b: float, c: float): ... +31 | @overload +32 | def foo(a: float, b: float, c: float): ... +33 | @overload +34 | def foo(a: str, b: str, c: str): ... +35 | @overload +36 | def foo(a: float, b: str, c: str): ... +37 | @overload +38 | def foo(a: str, b: float, c: str): ... +39 | @overload +40 | def foo(a: str, b: str, c: float): ... +41 | @overload +42 | def foo(a: float, b: float, c: str): ... +43 | @overload +44 | def foo(a: str, b: float, c: float): ... +45 | @overload +46 | def foo(a: float, b: float, c: float): ... +47 | def foo(a, b, c): ... +48 | +49 | foo(Foo(), Foo()) # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of function `foo` matches arguments + --> src/mdtest_snippet.py:49:1 + | +47 | def foo(a, b, c): ... +48 | +49 | foo(Foo(), Foo()) # error: [no-matching-overload] + | ^^^^^^^^^^^^^^^^^ + | +info: First overload defined here + --> src/mdtest_snippet.py:6:5 + | +5 | @overload +6 | def foo(a: int, b: int, c: int): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +7 | @overload +8 | def foo(a: str, b: int, c: int): ... + | +info: Possible overloads for function `foo`: +info: (a: int, b: int, c: int) -> Unknown +info: (a: str, b: int, c: int) -> Unknown +info: (a: int, b: str, c: int) -> Unknown +info: (a: int, b: int, c: str) -> Unknown +info: (a: str, b: str, c: int) -> Unknown +info: (a: int, b: str, c: str) -> Unknown +info: (a: str, b: str, c: str) -> Unknown +info: (a: int, b: int, c: int) -> Unknown +info: (a: int | float, b: int, c: int) -> Unknown +info: (a: int, b: int | float, c: int) -> Unknown +info: (a: int, b: int, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int) -> Unknown +info: (a: int, b: int | float, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int | float) -> Unknown +info: (a: str, b: str, c: str) -> Unknown +info: (a: int | float, b: str, c: str) -> Unknown +info: (a: str, b: int | float, c: str) -> Unknown +info: (a: str, b: str, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: str) -> Unknown +info: (a: str, b: int | float, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int | float) -> Unknown +info: Overload implementation defined here + --> src/mdtest_snippet.py:47:5 + | +45 | @overload +46 | def foo(a: float, b: float, c: float): ... +47 | def foo(a, b, c): ... + | ^^^^^^^^^^^^ +48 | +49 | foo(Foo(), Foo()) # error: [no-matching-overload] + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(f66e3a8a3977c472).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(f66e3a8a3977c472).snap" new file mode 100644 index 0000000000000..b14961eedf366 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Call_to_function_wit\342\200\246_(f66e3a8a3977c472).snap" @@ -0,0 +1,230 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - Call to function with too many unmatched overloads +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | class Foo: ... + 4 | + 5 | @overload + 6 | def foo(a: int, b: int, c: int): ... + 7 | @overload + 8 | def foo(a: str, b: int, c: int): ... + 9 | @overload + 10 | def foo(a: int, b: str, c: int): ... + 11 | @overload + 12 | def foo(a: int, b: int, c: str): ... + 13 | @overload + 14 | def foo(a: str, b: str, c: int): ... + 15 | @overload + 16 | def foo(a: int, b: str, c: str): ... + 17 | @overload + 18 | def foo(a: str, b: str, c: str): ... + 19 | @overload + 20 | def foo(a: int, b: int, c: int): ... + 21 | @overload + 22 | def foo(a: float, b: int, c: int): ... + 23 | @overload + 24 | def foo(a: int, b: float, c: int): ... + 25 | @overload + 26 | def foo(a: int, b: int, c: float): ... + 27 | @overload + 28 | def foo(a: float, b: float, c: int): ... + 29 | @overload + 30 | def foo(a: int, b: float, c: float): ... + 31 | @overload + 32 | def foo(a: float, b: float, c: float): ... + 33 | @overload + 34 | def foo(a: str, b: str, c: str): ... + 35 | @overload + 36 | def foo(a: float, b: str, c: str): ... + 37 | @overload + 38 | def foo(a: str, b: float, c: str): ... + 39 | @overload + 40 | def foo(a: str, b: str, c: float): ... + 41 | @overload + 42 | def foo(a: float, b: float, c: str): ... + 43 | @overload + 44 | def foo(a: str, b: float, c: float): ... + 45 | @overload + 46 | def foo(a: float, b: float, c: float): ... + 47 | @overload + 48 | def foo(a: list[int], b: list[int], c: list[int]): ... + 49 | @overload + 50 | def foo(a: list[str], b: list[int], c: list[int]): ... + 51 | @overload + 52 | def foo(a: list[int], b: list[str], c: list[int]): ... + 53 | @overload + 54 | def foo(a: list[int], b: list[int], c: list[str]): ... + 55 | @overload + 56 | def foo(a: list[str], b: list[str], c: list[int]): ... + 57 | @overload + 58 | def foo(a: list[int], b: list[str], c: list[str]): ... + 59 | @overload + 60 | def foo(a: list[str], b: list[str], c: list[str]): ... + 61 | @overload + 62 | def foo(a: list[int], b: list[int], c: list[int]): ... + 63 | @overload + 64 | def foo(a: list[float], b: list[int], c: list[int]): ... + 65 | @overload + 66 | def foo(a: list[int], b: list[float], c: list[int]): ... + 67 | @overload + 68 | def foo(a: list[int], b: list[int], c: list[float]): ... + 69 | @overload + 70 | def foo(a: list[float], b: list[float], c: list[int]): ... + 71 | @overload + 72 | def foo(a: list[int], b: list[float], c: list[float]): ... + 73 | @overload + 74 | def foo(a: list[float], b: list[float], c: list[float]): ... + 75 | @overload + 76 | def foo(a: list[str], b: list[str], c: list[str]): ... + 77 | @overload + 78 | def foo(a: list[float], b: list[str], c: list[str]): ... + 79 | @overload + 80 | def foo(a: list[str], b: list[float], c: list[str]): ... + 81 | @overload + 82 | def foo(a: list[str], b: list[str], c: list[float]): ... + 83 | @overload + 84 | def foo(a: list[float], b: list[float], c: list[str]): ... + 85 | @overload + 86 | def foo(a: list[str], b: list[float], c: list[float]): ... + 87 | @overload + 88 | def foo(a: list[float], b: list[float], c: list[float]): ... + 89 | @overload + 90 | def foo(a: bool, b: bool, c: bool): ... + 91 | @overload + 92 | def foo(a: str, b: bool, c: bool): ... + 93 | @overload + 94 | def foo(a: bool, b: str, c: bool): ... + 95 | @overload + 96 | def foo(a: bool, b: bool, c: str): ... + 97 | @overload + 98 | def foo(a: str, b: str, c: bool): ... + 99 | @overload +100 | def foo(a: bool, b: str, c: str): ... +101 | @overload +102 | def foo(a: str, b: str, c: str): ... +103 | @overload +104 | def foo(a: int, b: int, c: int): ... +105 | @overload +106 | def foo(a: bool, b: int, c: int): ... +107 | @overload +108 | def foo(a: int, b: bool, c: int): ... +109 | @overload +110 | def foo(a: int, b: int, c: bool): ... +111 | @overload +112 | def foo(a: bool, b: bool, c: int): ... +113 | @overload +114 | def foo(a: int, b: bool, c: bool): ... +115 | @overload +116 | def foo(a: str, b: str, c: str): ... +117 | @overload +118 | def foo(a: float, b: bool, c: bool): ... +119 | @overload +120 | def foo(a: bool, b: float, c: bool): ... +121 | @overload +122 | def foo(a: bool, b: bool, c: float): ... +123 | @overload +124 | def foo(a: float, b: float, c: bool): ... +125 | @overload +126 | def foo(a: bool, b: float, c: float): ... +127 | def foo(a, b, c): ... +128 | +129 | foo(Foo(), Foo()) # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of function `foo` matches arguments + --> src/mdtest_snippet.py:129:1 + | +127 | def foo(a, b, c): ... +128 | +129 | foo(Foo(), Foo()) # error: [no-matching-overload] + | ^^^^^^^^^^^^^^^^^ + | +info: First overload defined here + --> src/mdtest_snippet.py:6:5 + | +5 | @overload +6 | def foo(a: int, b: int, c: int): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ +7 | @overload +8 | def foo(a: str, b: int, c: int): ... + | +info: Possible overloads for function `foo`: +info: (a: int, b: int, c: int) -> Unknown +info: (a: str, b: int, c: int) -> Unknown +info: (a: int, b: str, c: int) -> Unknown +info: (a: int, b: int, c: str) -> Unknown +info: (a: str, b: str, c: int) -> Unknown +info: (a: int, b: str, c: str) -> Unknown +info: (a: str, b: str, c: str) -> Unknown +info: (a: int, b: int, c: int) -> Unknown +info: (a: int | float, b: int, c: int) -> Unknown +info: (a: int, b: int | float, c: int) -> Unknown +info: (a: int, b: int, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int) -> Unknown +info: (a: int, b: int | float, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int | float) -> Unknown +info: (a: str, b: str, c: str) -> Unknown +info: (a: int | float, b: str, c: str) -> Unknown +info: (a: str, b: int | float, c: str) -> Unknown +info: (a: str, b: str, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: str) -> Unknown +info: (a: str, b: int | float, c: int | float) -> Unknown +info: (a: int | float, b: int | float, c: int | float) -> Unknown +info: (a: list[int], b: list[int], c: list[int]) -> Unknown +info: (a: list[str], b: list[int], c: list[int]) -> Unknown +info: (a: list[int], b: list[str], c: list[int]) -> Unknown +info: (a: list[int], b: list[int], c: list[str]) -> Unknown +info: (a: list[str], b: list[str], c: list[int]) -> Unknown +info: (a: list[int], b: list[str], c: list[str]) -> Unknown +info: (a: list[str], b: list[str], c: list[str]) -> Unknown +info: (a: list[int], b: list[int], c: list[int]) -> Unknown +info: (a: list[int | float], b: list[int], c: list[int]) -> Unknown +info: (a: list[int], b: list[int | float], c: list[int]) -> Unknown +info: (a: list[int], b: list[int], c: list[int | float]) -> Unknown +info: (a: list[int | float], b: list[int | float], c: list[int]) -> Unknown +info: (a: list[int], b: list[int | float], c: list[int | float]) -> Unknown +info: (a: list[int | float], b: list[int | float], c: list[int | float]) -> Unknown +info: (a: list[str], b: list[str], c: list[str]) -> Unknown +info: (a: list[int | float], b: list[str], c: list[str]) -> Unknown +info: (a: list[str], b: list[int | float], c: list[str]) -> Unknown +info: (a: list[str], b: list[str], c: list[int | float]) -> Unknown +info: (a: list[int | float], b: list[int | float], c: list[str]) -> Unknown +info: (a: list[str], b: list[int | float], c: list[int | float]) -> Unknown +info: (a: list[int | float], b: list[int | float], c: list[int | float]) -> Unknown +info: (a: bool, b: bool, c: bool) -> Unknown +info: (a: str, b: bool, c: bool) -> Unknown +info: (a: bool, b: str, c: bool) -> Unknown +info: (a: bool, b: bool, c: str) -> Unknown +info: (a: str, b: str, c: bool) -> Unknown +info: (a: bool, b: str, c: str) -> Unknown +info: (a: str, b: str, c: str) -> Unknown +info: (a: int, b: int, c: int) -> Unknown +info: ... omitted 11 overloads +info: Overload implementation defined here + --> src/mdtest_snippet.py:127:5 + | +125 | @overload +126 | def foo(a: bool, b: float, c: float): ... +127 | def foo(a, b, c): ... + | ^^^^^^^^^^^^ +128 | +129 | foo(Foo(), Foo()) # error: [no-matching-overload] + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(3553d085684e16a0).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(3553d085684e16a0).snap" new file mode 100644 index 0000000000000..367bfd4dd8d03 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(3553d085684e16a0).snap" @@ -0,0 +1,61 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - Calls to overloaded functions +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | @overload + 4 | def f(x: int) -> int: ... + 5 | @overload + 6 | def f(x: str) -> str: ... + 7 | def f(x: int | str) -> int | str: + 8 | return x + 9 | +10 | f(b"foo") # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of function `f` matches arguments + --> src/mdtest_snippet.py:10:1 + | + 8 | return x + 9 | +10 | f(b"foo") # error: [no-matching-overload] + | ^^^^^^^^^ + | +info: First overload defined here + --> src/mdtest_snippet.py:4:5 + | +3 | @overload +4 | def f(x: int) -> int: ... + | ^^^^^^^^^^^^^^^^ +5 | @overload +6 | def f(x: str) -> str: ... + | +info: Possible overloads for function `f`: +info: (x: int) -> int +info: (x: str) -> str +info: Overload implementation defined here + --> src/mdtest_snippet.py:7:5 + | +5 | @overload +6 | def f(x: str) -> str: ... +7 | def f(x: int | str) -> int | str: + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +8 | return x + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(36814b28492c01d2).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(36814b28492c01d2).snap" new file mode 100644 index 0000000000000..83837288e207c --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/no_matching_overload\342\200\246_-_No_matching_overload\342\200\246_-_Calls_to_overloaded_\342\200\246_(36814b28492c01d2).snap" @@ -0,0 +1,148 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: no_matching_overload.md - No matching overload diagnostics - Calls to overloaded functions with lots of parameters +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/no_matching_overload.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | @overload + 4 | def f( + 5 | lion: int, + 6 | turtle: int, + 7 | tortoise: int, + 8 | goat: int, + 9 | capybara: int, +10 | chicken: int, +11 | ostrich: int, +12 | gorilla: int, +13 | giraffe: int, +14 | condor: int, +15 | kangaroo: int, +16 | anaconda: int, +17 | tarantula: int, +18 | millipede: int, +19 | leopard: int, +20 | hyena: int, +21 | ) -> int: ... +22 | @overload +23 | def f( +24 | lion: str, +25 | turtle: str, +26 | tortoise: str, +27 | goat: str, +28 | capybara: str, +29 | chicken: str, +30 | ostrich: str, +31 | gorilla: str, +32 | giraffe: str, +33 | condor: str, +34 | kangaroo: str, +35 | anaconda: str, +36 | tarantula: str, +37 | millipede: str, +38 | leopard: str, +39 | hyena: str, +40 | ) -> str: ... +41 | def f( +42 | lion: int | str, +43 | turtle: int | str, +44 | tortoise: int | str, +45 | goat: int | str, +46 | capybara: int | str, +47 | chicken: int | str, +48 | ostrict: int | str, +49 | gorilla: int | str, +50 | giraffe: int | str, +51 | condor: int | str, +52 | kangaroo: int | str, +53 | anaconda: int | str, +54 | tarantula: int | str, +55 | millipede: int | str, +56 | leopard: int | str, +57 | hyena: int | str, +58 | ) -> int | str: +59 | return 0 +60 | +61 | f(b"foo") # error: [no-matching-overload] +``` + +# Diagnostics + +``` +error[no-matching-overload]: No overload of function `f` matches arguments + --> src/mdtest_snippet.py:61:1 + | +59 | return 0 +60 | +61 | f(b"foo") # error: [no-matching-overload] + | ^^^^^^^^^ + | +info: First overload defined here + --> src/mdtest_snippet.py:4:5 + | + 3 | @overload + 4 | def f( + | _____^ + 5 | | lion: int, + 6 | | turtle: int, + 7 | | tortoise: int, + 8 | | goat: int, + 9 | | capybara: int, +10 | | chicken: int, +11 | | ostrich: int, +12 | | gorilla: int, +13 | | giraffe: int, +14 | | condor: int, +15 | | kangaroo: int, +16 | | anaconda: int, +17 | | tarantula: int, +18 | | millipede: int, +19 | | leopard: int, +20 | | hyena: int, +21 | | ) -> int: ... + | |________^ +22 | @overload +23 | def f( + | +info: Possible overloads for function `f`: +info: (lion: int, turtle: int, tortoise: int, goat: int, capybara: int, chicken: int, ostrich: int, gorilla: int, giraffe: int, condor: int, kangaroo: int, anaconda: int, tarantula: int, millipede: int, leopard: int, hyena: int) -> int +info: (lion: str, turtle: str, tortoise: str, goat: str, capybara: str, chicken: str, ostrich: str, gorilla: str, giraffe: str, condor: str, kangaroo: str, anaconda: str, tarantula: str, millipede: str, leopard: str, hyena: str) -> str +info: Overload implementation defined here + --> src/mdtest_snippet.py:41:5 + | +39 | hyena: str, +40 | ) -> str: ... +41 | def f( + | _____^ +42 | | lion: int | str, +43 | | turtle: int | str, +44 | | tortoise: int | str, +45 | | goat: int | str, +46 | | capybara: int | str, +47 | | chicken: int | str, +48 | | ostrict: int | str, +49 | | gorilla: int | str, +50 | | giraffe: int | str, +51 | | condor: int | str, +52 | | kangaroo: int | str, +53 | | anaconda: int | str, +54 | | tarantula: int | str, +55 | | millipede: int | str, +56 | | leopard: int | str, +57 | | hyena: int | str, +58 | | ) -> int | str: + | |______________^ +59 | return 0 + | +info: rule `no-matching-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/not.md_-_Unary_not_-_Object_that_implemen\342\200\246_(ab3f546bf004e24d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/not.md_-_Unary_not_-_Object_that_implemen\342\200\246_(ab3f546bf004e24d).snap" new file mode 100644 index 0000000000000..defb8528ec745 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/not.md_-_Unary_not_-_Object_that_implemen\342\200\246_(ab3f546bf004e24d).snap" @@ -0,0 +1,35 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: not.md - Unary not - Object that implements `__bool__` incorrectly +mdtest path: crates/ty_python_semantic/resources/mdtest/unary/not.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | __bool__: int = 3 +3 | +4 | # error: [unsupported-bool-conversion] +5 | not NotBoolable() +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:5:1 + | +4 | # error: [unsupported-bool-conversion] +5 | not NotBoolable() + | ^^^^^^^^^^^^^^^^^ + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_At_least_two_overloa\342\200\246_(84dadf8abd8f2f2).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_At_least_two_overloa\342\200\246_(84dadf8abd8f2f2).snap" new file mode 100644 index 0000000000000..e8d42bc20c3b8 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_At_least_two_overloa\342\200\246_(84dadf8abd8f2f2).snap" @@ -0,0 +1,67 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: overloads.md - Overloads - Invalid - At least two overloads +mdtest path: crates/ty_python_semantic/resources/mdtest/overloads.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing import overload +2 | +3 | @overload +4 | def func(x: int) -> int: ... +5 | +6 | # error: [invalid-overload] +7 | def func(x: int | str) -> int | str: +8 | return x +``` + +## mdtest_snippet.pyi + +``` +1 | from typing import overload +2 | +3 | @overload +4 | # error: [invalid-overload] +5 | def func(x: int) -> int: ... +``` + +# Diagnostics + +``` +error[invalid-overload]: Overloaded function `func` requires at least two overloads + --> src/mdtest_snippet.py:4:5 + | +3 | @overload +4 | def func(x: int) -> int: ... + | ---- Only one overload defined here +5 | +6 | # error: [invalid-overload] +7 | def func(x: int | str) -> int | str: + | ^^^^ +8 | return x + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: Overloaded function `func` requires at least two overloads + --> src/mdtest_snippet.pyi:5:5 + | +3 | @overload +4 | # error: [invalid-overload] +5 | def func(x: int) -> int: ... + | ---- + | | + | Only one overload defined here + | +info: rule `invalid-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@classmethod`_(aaa04d4cfa3adaba).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@classmethod`_(aaa04d4cfa3adaba).snap" new file mode 100644 index 0000000000000..a2e027157665f --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@classmethod`_(aaa04d4cfa3adaba).snap" @@ -0,0 +1,131 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: overloads.md - Overloads - Invalid - Inconsistent decorators - `@classmethod` +mdtest path: crates/ty_python_semantic/resources/mdtest/overloads.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from __future__ import annotations + 2 | + 3 | from typing import overload + 4 | + 5 | class CheckClassMethod: + 6 | def __init__(self, x: int) -> None: + 7 | self.x = x + 8 | + 9 | @overload +10 | @classmethod +11 | def try_from1(cls, x: int) -> CheckClassMethod: ... +12 | @overload +13 | def try_from1(cls, x: str) -> None: ... +14 | @classmethod +15 | # error: [invalid-overload] "Overloaded function `try_from1` does not use the `@classmethod` decorator consistently" +16 | def try_from1(cls, x: int | str) -> CheckClassMethod | None: +17 | if isinstance(x, int): +18 | return cls(x) +19 | return None +20 | +21 | @overload +22 | def try_from2(cls, x: int) -> CheckClassMethod: ... +23 | @overload +24 | @classmethod +25 | def try_from2(cls, x: str) -> None: ... +26 | @classmethod +27 | # error: [invalid-overload] +28 | def try_from2(cls, x: int | str) -> CheckClassMethod | None: +29 | if isinstance(x, int): +30 | return cls(x) +31 | return None +32 | +33 | @overload +34 | @classmethod +35 | def try_from3(cls, x: int) -> CheckClassMethod: ... +36 | @overload +37 | @classmethod +38 | def try_from3(cls, x: str) -> None: ... +39 | # error: [invalid-overload] +40 | def try_from3(cls, x: int | str) -> CheckClassMethod | None: +41 | if isinstance(x, int): +42 | return cls(x) +43 | return None +44 | +45 | @overload +46 | @classmethod +47 | def try_from4(cls, x: int) -> CheckClassMethod: ... +48 | @overload +49 | @classmethod +50 | def try_from4(cls, x: str) -> None: ... +51 | @classmethod +52 | def try_from4(cls, x: int | str) -> CheckClassMethod | None: +53 | if isinstance(x, int): +54 | return cls(x) +55 | return None +``` + +# Diagnostics + +``` +error[invalid-overload]: Overloaded function `try_from1` does not use the `@classmethod` decorator consistently + --> src/mdtest_snippet.py:13:9 + | +11 | def try_from1(cls, x: int) -> CheckClassMethod: ... +12 | @overload +13 | def try_from1(cls, x: str) -> None: ... + | --------- Missing here +14 | @classmethod +15 | # error: [invalid-overload] "Overloaded function `try_from1` does not use the `@classmethod` decorator consistently" +16 | def try_from1(cls, x: int | str) -> CheckClassMethod | None: + | ^^^^^^^^^ +17 | if isinstance(x, int): +18 | return cls(x) + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: Overloaded function `try_from2` does not use the `@classmethod` decorator consistently + --> src/mdtest_snippet.py:28:9 + | +26 | @classmethod +27 | # error: [invalid-overload] +28 | def try_from2(cls, x: int | str) -> CheckClassMethod | None: + | ^^^^^^^^^ +29 | if isinstance(x, int): +30 | return cls(x) + | + ::: src/mdtest_snippet.py:22:9 + | +21 | @overload +22 | def try_from2(cls, x: int) -> CheckClassMethod: ... + | --------- Missing here +23 | @overload +24 | @classmethod + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: Overloaded function `try_from3` does not use the `@classmethod` decorator consistently + --> src/mdtest_snippet.py:40:9 + | +38 | def try_from3(cls, x: str) -> None: ... +39 | # error: [invalid-overload] +40 | def try_from3(cls, x: int | str) -> CheckClassMethod | None: + | --------- + | | + | Missing here +41 | if isinstance(x, int): +42 | return cls(x) + | +info: rule `invalid-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@final`_(f8e529ec23a61665).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@final`_(f8e529ec23a61665).snap" new file mode 100644 index 0000000000000..6799a92a57f38 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@final`_(f8e529ec23a61665).snap" @@ -0,0 +1,114 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: overloads.md - Overloads - Invalid - Inconsistent decorators - `@final` +mdtest path: crates/ty_python_semantic/resources/mdtest/overloads.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import final, overload + 2 | + 3 | class Foo: + 4 | @overload + 5 | def method1(self, x: int) -> int: ... + 6 | @overload + 7 | def method1(self, x: str) -> str: ... + 8 | @final + 9 | def method1(self, x: int | str) -> int | str: +10 | return x +11 | +12 | @overload +13 | @final +14 | def method2(self, x: int) -> int: ... +15 | @overload +16 | def method2(self, x: str) -> str: ... +17 | # error: [invalid-overload] +18 | def method2(self, x: int | str) -> int | str: +19 | return x +20 | +21 | @overload +22 | def method3(self, x: int) -> int: ... +23 | @overload +24 | @final +25 | def method3(self, x: str) -> str: ... +26 | # error: [invalid-overload] +27 | def method3(self, x: int | str) -> int | str: +28 | return x +``` + +## mdtest_snippet.pyi + +``` + 1 | from typing_extensions import final, overload + 2 | + 3 | class Foo: + 4 | @overload + 5 | @final + 6 | def method1(self, x: int) -> int: ... + 7 | @overload + 8 | def method1(self, x: str) -> str: ... + 9 | +10 | @overload +11 | def method2(self, x: int) -> int: ... +12 | @final +13 | @overload +14 | # error: [invalid-overload] +15 | def method2(self, x: str) -> str: ... +``` + +# Diagnostics + +``` +error[invalid-overload]: `@final` decorator should be applied only to the overload implementation + --> src/mdtest_snippet.py:18:9 + | +16 | def method2(self, x: str) -> str: ... +17 | # error: [invalid-overload] +18 | def method2(self, x: int | str) -> int | str: + | ------- + | | + | Implementation defined here +19 | return x + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: `@final` decorator should be applied only to the overload implementation + --> src/mdtest_snippet.py:27:9 + | +25 | def method3(self, x: str) -> str: ... +26 | # error: [invalid-overload] +27 | def method3(self, x: int | str) -> int | str: + | ------- + | | + | Implementation defined here +28 | return x + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: `@final` decorator should be applied only to the first overload + --> src/mdtest_snippet.pyi:11:9 + | +10 | @overload +11 | def method2(self, x: int) -> int: ... + | ------- First overload defined here +12 | @final +13 | @overload +14 | # error: [invalid-overload] +15 | def method2(self, x: str) -> str: ... + | ^^^^^^^ + | +info: rule `invalid-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@override`_(2df210735ca532f9).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@override`_(2df210735ca532f9).snap" new file mode 100644 index 0000000000000..80ff3214b4b02 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Inconsistent_decorat\342\200\246_-_`@override`_(2df210735ca532f9).snap" @@ -0,0 +1,132 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: overloads.md - Overloads - Invalid - Inconsistent decorators - `@override` +mdtest path: crates/ty_python_semantic/resources/mdtest/overloads.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import overload, override + 2 | + 3 | class Base: + 4 | @overload + 5 | def method(self, x: int) -> int: ... + 6 | @overload + 7 | def method(self, x: str) -> str: ... + 8 | def method(self, x: int | str) -> int | str: + 9 | return x +10 | +11 | class Sub1(Base): +12 | @overload +13 | def method(self, x: int) -> int: ... +14 | @overload +15 | def method(self, x: str) -> str: ... +16 | @override +17 | def method(self, x: int | str) -> int | str: +18 | return x +19 | +20 | class Sub2(Base): +21 | @overload +22 | def method(self, x: int) -> int: ... +23 | @overload +24 | @override +25 | def method(self, x: str) -> str: ... +26 | # error: [invalid-overload] +27 | def method(self, x: int | str) -> int | str: +28 | return x +29 | +30 | class Sub3(Base): +31 | @overload +32 | @override +33 | def method(self, x: int) -> int: ... +34 | @overload +35 | def method(self, x: str) -> str: ... +36 | # error: [invalid-overload] +37 | def method(self, x: int | str) -> int | str: +38 | return x +``` + +## mdtest_snippet.pyi + +``` + 1 | from typing_extensions import overload, override + 2 | + 3 | class Base: + 4 | @overload + 5 | def method(self, x: int) -> int: ... + 6 | @overload + 7 | def method(self, x: str) -> str: ... + 8 | + 9 | class Sub1(Base): +10 | @overload +11 | @override +12 | def method(self, x: int) -> int: ... +13 | @overload +14 | def method(self, x: str) -> str: ... +15 | +16 | class Sub2(Base): +17 | @overload +18 | def method(self, x: int) -> int: ... +19 | @overload +20 | @override +21 | # error: [invalid-overload] +22 | def method(self, x: str) -> str: ... +``` + +# Diagnostics + +``` +error[invalid-overload]: `@override` decorator should be applied only to the overload implementation + --> src/mdtest_snippet.py:27:9 + | +25 | def method(self, x: str) -> str: ... +26 | # error: [invalid-overload] +27 | def method(self, x: int | str) -> int | str: + | ------ + | | + | Implementation defined here +28 | return x + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: `@override` decorator should be applied only to the overload implementation + --> src/mdtest_snippet.py:37:9 + | +35 | def method(self, x: str) -> str: ... +36 | # error: [invalid-overload] +37 | def method(self, x: int | str) -> int | str: + | ------ + | | + | Implementation defined here +38 | return x + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: `@override` decorator should be applied only to the first overload + --> src/mdtest_snippet.pyi:18:9 + | +16 | class Sub2(Base): +17 | @overload +18 | def method(self, x: int) -> int: ... + | ------ First overload defined here +19 | @overload +20 | @override +21 | # error: [invalid-overload] +22 | def method(self, x: str) -> str: ... + | ^^^^^^ + | +info: rule `invalid-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Overload_without_an_\342\200\246_-_Regular_modules_(5c8e81664d1c7470).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Overload_without_an_\342\200\246_-_Regular_modules_(5c8e81664d1c7470).snap" new file mode 100644 index 0000000000000..21e0603051ed7 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/overloads.md_-_Overloads_-_Invalid_-_Overload_without_an_\342\200\246_-_Regular_modules_(5c8e81664d1c7470).snap" @@ -0,0 +1,59 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: overloads.md - Overloads - Invalid - Overload without an implementation - Regular modules +mdtest path: crates/ty_python_semantic/resources/mdtest/overloads.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing import overload + 2 | + 3 | @overload + 4 | def func(x: int) -> int: ... + 5 | @overload + 6 | # error: [invalid-overload] "Overloaded non-stub function `func` must have an implementation" + 7 | def func(x: str) -> str: ... + 8 | + 9 | class Foo: +10 | @overload +11 | def method(self, x: int) -> int: ... +12 | @overload +13 | # error: [invalid-overload] "Overloaded non-stub function `method` must have an implementation" +14 | def method(self, x: str) -> str: ... +``` + +# Diagnostics + +``` +error[invalid-overload]: Overloaded non-stub function `func` must have an implementation + --> src/mdtest_snippet.py:7:5 + | +5 | @overload +6 | # error: [invalid-overload] "Overloaded non-stub function `func` must have an implementation" +7 | def func(x: str) -> str: ... + | ^^^^ +8 | +9 | class Foo: + | +info: rule `invalid-overload` is enabled by default + +``` + +``` +error[invalid-overload]: Overloaded non-stub function `method` must have an implementation + --> src/mdtest_snippet.py:14:9 + | +12 | @overload +13 | # error: [invalid-overload] "Overloaded non-stub function `method` must have an implementation" +14 | def method(self, x: str) -> str: ... + | ^^^^^^ + | +info: rule `invalid-overload` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Calls_to_protocol_cl\342\200\246_(288988036f34ddcf).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Calls_to_protocol_cl\342\200\246_(288988036f34ddcf).snap" new file mode 100644 index 0000000000000..3553f119c2242 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Calls_to_protocol_cl\342\200\246_(288988036f34ddcf).snap" @@ -0,0 +1,179 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: protocols.md - Protocols - Calls to protocol classes +mdtest path: crates/ty_python_semantic/resources/mdtest/protocols.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import Protocol, reveal_type + 2 | + 3 | # error: [call-non-callable] + 4 | reveal_type(Protocol()) # revealed: Unknown + 5 | + 6 | class MyProtocol(Protocol): + 7 | x: int + 8 | + 9 | # error: [call-non-callable] "Cannot instantiate class `MyProtocol`" +10 | reveal_type(MyProtocol()) # revealed: MyProtocol +11 | +12 | class GenericProtocol[T](Protocol): +13 | x: T +14 | +15 | # error: [call-non-callable] "Cannot instantiate class `GenericProtocol`" +16 | reveal_type(GenericProtocol[int]()) # revealed: GenericProtocol[int] +17 | class SubclassOfMyProtocol(MyProtocol): ... +18 | +19 | reveal_type(SubclassOfMyProtocol()) # revealed: SubclassOfMyProtocol +20 | +21 | class SubclassOfGenericProtocol[T](GenericProtocol[T]): ... +22 | +23 | reveal_type(SubclassOfGenericProtocol[int]()) # revealed: SubclassOfGenericProtocol[int] +24 | def f(x: type[MyProtocol]): +25 | reveal_type(x()) # revealed: MyProtocol +``` + +# Diagnostics + +``` +error[call-non-callable]: Object of type `typing.Protocol` is not callable + --> src/mdtest_snippet.py:4:13 + | +3 | # error: [call-non-callable] +4 | reveal_type(Protocol()) # revealed: Unknown + | ^^^^^^^^^^ +5 | +6 | class MyProtocol(Protocol): + | +info: rule `call-non-callable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:4:13 + | +3 | # error: [call-non-callable] +4 | reveal_type(Protocol()) # revealed: Unknown + | ^^^^^^^^^^ `Unknown` +5 | +6 | class MyProtocol(Protocol): + | + +``` + +``` +error[call-non-callable]: Cannot instantiate class `MyProtocol` + --> src/mdtest_snippet.py:10:13 + | + 9 | # error: [call-non-callable] "Cannot instantiate class `MyProtocol`" +10 | reveal_type(MyProtocol()) # revealed: MyProtocol + | ^^^^^^^^^^^^ This call will raise `TypeError` at runtime +11 | +12 | class GenericProtocol[T](Protocol): + | +info: Protocol classes cannot be instantiated + --> src/mdtest_snippet.py:6:7 + | +4 | reveal_type(Protocol()) # revealed: Unknown +5 | +6 | class MyProtocol(Protocol): + | ^^^^^^^^^^^^^^^^^^^^ `MyProtocol` declared as a protocol here +7 | x: int + | +info: rule `call-non-callable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:10:13 + | + 9 | # error: [call-non-callable] "Cannot instantiate class `MyProtocol`" +10 | reveal_type(MyProtocol()) # revealed: MyProtocol + | ^^^^^^^^^^^^ `MyProtocol` +11 | +12 | class GenericProtocol[T](Protocol): + | + +``` + +``` +error[call-non-callable]: Cannot instantiate class `GenericProtocol` + --> src/mdtest_snippet.py:16:13 + | +15 | # error: [call-non-callable] "Cannot instantiate class `GenericProtocol`" +16 | reveal_type(GenericProtocol[int]()) # revealed: GenericProtocol[int] + | ^^^^^^^^^^^^^^^^^^^^^^ This call will raise `TypeError` at runtime +17 | class SubclassOfMyProtocol(MyProtocol): ... + | +info: Protocol classes cannot be instantiated + --> src/mdtest_snippet.py:12:7 + | +10 | reveal_type(MyProtocol()) # revealed: MyProtocol +11 | +12 | class GenericProtocol[T](Protocol): + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `GenericProtocol` declared as a protocol here +13 | x: T + | +info: rule `call-non-callable` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:16:13 + | +15 | # error: [call-non-callable] "Cannot instantiate class `GenericProtocol`" +16 | reveal_type(GenericProtocol[int]()) # revealed: GenericProtocol[int] + | ^^^^^^^^^^^^^^^^^^^^^^ `GenericProtocol[int]` +17 | class SubclassOfMyProtocol(MyProtocol): ... + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:19:13 + | +17 | class SubclassOfMyProtocol(MyProtocol): ... +18 | +19 | reveal_type(SubclassOfMyProtocol()) # revealed: SubclassOfMyProtocol + | ^^^^^^^^^^^^^^^^^^^^^^ `SubclassOfMyProtocol` +20 | +21 | class SubclassOfGenericProtocol[T](GenericProtocol[T]): ... + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:23:13 + | +21 | class SubclassOfGenericProtocol[T](GenericProtocol[T]): ... +22 | +23 | reveal_type(SubclassOfGenericProtocol[int]()) # revealed: SubclassOfGenericProtocol[int] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `SubclassOfGenericProtocol[int]` +24 | def f(x: type[MyProtocol]): +25 | reveal_type(x()) # revealed: MyProtocol + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:25:17 + | +23 | reveal_type(SubclassOfGenericProtocol[int]()) # revealed: SubclassOfGenericProtocol[int] +24 | def f(x: type[MyProtocol]): +25 | reveal_type(x()) # revealed: MyProtocol + | ^^^ `MyProtocol` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Invalid_calls_to_`ge\342\200\246_(3d0c4ee818c4d8d5).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Invalid_calls_to_`ge\342\200\246_(3d0c4ee818c4d8d5).snap" new file mode 100644 index 0000000000000..8d4d21634abc4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Invalid_calls_to_`ge\342\200\246_(3d0c4ee818c4d8d5).snap" @@ -0,0 +1,84 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: protocols.md - Protocols - Invalid calls to `get_protocol_members()` +mdtest path: crates/ty_python_semantic/resources/mdtest/protocols.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import Protocol, get_protocol_members + 2 | + 3 | class NotAProtocol: ... + 4 | + 5 | get_protocol_members(NotAProtocol) # error: [invalid-argument-type] + 6 | + 7 | class AlsoNotAProtocol(NotAProtocol, object): ... + 8 | + 9 | get_protocol_members(AlsoNotAProtocol) # error: [invalid-argument-type] +10 | class GenericProtocol[T](Protocol): ... +11 | +12 | get_protocol_members(GenericProtocol[int]) # TODO: should emit a diagnostic here (https://github.com/astral-sh/ruff/issues/17549) +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Invalid argument to `get_protocol_members` + --> src/mdtest_snippet.py:5:1 + | +3 | class NotAProtocol: ... +4 | +5 | get_protocol_members(NotAProtocol) # error: [invalid-argument-type] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This call will raise `TypeError` at runtime +6 | +7 | class AlsoNotAProtocol(NotAProtocol, object): ... + | +info: Only protocol classes can be passed to `get_protocol_members` +info: `NotAProtocol` is declared here, but it is not a protocol class: + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import Protocol, get_protocol_members +2 | +3 | class NotAProtocol: ... + | ^^^^^^^^^^^^ +4 | +5 | get_protocol_members(NotAProtocol) # error: [invalid-argument-type] + | +info: A class is only a protocol class if it directly inherits from `typing.Protocol` or `typing_extensions.Protocol` +info: See https://typing.python.org/en/latest/spec/protocol.html# +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[invalid-argument-type]: Invalid argument to `get_protocol_members` + --> src/mdtest_snippet.py:9:1 + | + 7 | class AlsoNotAProtocol(NotAProtocol, object): ... + 8 | + 9 | get_protocol_members(AlsoNotAProtocol) # error: [invalid-argument-type] + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This call will raise `TypeError` at runtime +10 | class GenericProtocol[T](Protocol): ... + | +info: Only protocol classes can be passed to `get_protocol_members` +info: `AlsoNotAProtocol` is declared here, but it is not a protocol class: + --> src/mdtest_snippet.py:7:7 + | +5 | get_protocol_members(NotAProtocol) # error: [invalid-argument-type] +6 | +7 | class AlsoNotAProtocol(NotAProtocol, object): ... + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +8 | +9 | get_protocol_members(AlsoNotAProtocol) # error: [invalid-argument-type] + | +info: A class is only a protocol class if it directly inherits from `typing.Protocol` or `typing_extensions.Protocol` +info: See https://typing.python.org/en/latest/spec/protocol.html# +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Narrowing_of_protoco\342\200\246_(98257e7c2300373).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Narrowing_of_protoco\342\200\246_(98257e7c2300373).snap" new file mode 100644 index 0000000000000..65263835c3846 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/protocols.md_-_Protocols_-_Narrowing_of_protoco\342\200\246_(98257e7c2300373).snap" @@ -0,0 +1,243 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: protocols.md - Protocols - Narrowing of protocols +mdtest path: crates/ty_python_semantic/resources/mdtest/protocols.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from typing_extensions import Protocol, reveal_type + 2 | + 3 | class HasX(Protocol): + 4 | x: int + 5 | + 6 | def f(arg: object, arg2: type): + 7 | if isinstance(arg, HasX): # error: [invalid-argument-type] + 8 | reveal_type(arg) # revealed: HasX + 9 | else: +10 | reveal_type(arg) # revealed: ~HasX +11 | +12 | if issubclass(arg2, HasX): # error: [invalid-argument-type] +13 | reveal_type(arg2) # revealed: type[HasX] +14 | else: +15 | reveal_type(arg2) # revealed: type & ~type[HasX] +16 | from typing import runtime_checkable +17 | +18 | @runtime_checkable +19 | class RuntimeCheckableHasX(Protocol): +20 | x: int +21 | +22 | def f(arg: object): +23 | if isinstance(arg, RuntimeCheckableHasX): # no error! +24 | reveal_type(arg) # revealed: RuntimeCheckableHasX +25 | else: +26 | reveal_type(arg) # revealed: ~RuntimeCheckableHasX +27 | @runtime_checkable +28 | class OnlyMethodMembers(Protocol): +29 | def method(self) -> None: ... +30 | +31 | def f(arg1: type, arg2: type): +32 | if issubclass(arg1, RuntimeCheckableHasX): # TODO: should emit an error here (has non-method members) +33 | reveal_type(arg1) # revealed: type[RuntimeCheckableHasX] +34 | else: +35 | reveal_type(arg1) # revealed: type & ~type[RuntimeCheckableHasX] +36 | +37 | if issubclass(arg2, OnlyMethodMembers): # no error! +38 | reveal_type(arg2) # revealed: type[OnlyMethodMembers] +39 | else: +40 | reveal_type(arg2) # revealed: type & ~type[OnlyMethodMembers] +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Class `HasX` cannot be used as the second argument to `isinstance` + --> src/mdtest_snippet.py:7:8 + | +6 | def f(arg: object, arg2: type): +7 | if isinstance(arg, HasX): # error: [invalid-argument-type] + | ^^^^^^^^^^^^^^^^^^^^^ This call will raise `TypeError` at runtime +8 | reveal_type(arg) # revealed: HasX +9 | else: + | +info: `HasX` is declared as a protocol class, but it is not declared as runtime-checkable + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import Protocol, reveal_type +2 | +3 | class HasX(Protocol): + | ^^^^^^^^^^^^^^ `HasX` declared here +4 | x: int + | +info: A protocol class can only be used in `isinstance` checks if it is decorated with `@typing.runtime_checkable` or `@typing_extensions.runtime_checkable` +info: See https://docs.python.org/3/library/typing.html#typing.runtime_checkable +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:8:21 + | + 6 | def f(arg: object, arg2: type): + 7 | if isinstance(arg, HasX): # error: [invalid-argument-type] + 8 | reveal_type(arg) # revealed: HasX + | ^^^ `HasX` + 9 | else: +10 | reveal_type(arg) # revealed: ~HasX + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:10:21 + | + 8 | reveal_type(arg) # revealed: HasX + 9 | else: +10 | reveal_type(arg) # revealed: ~HasX + | ^^^ `~HasX` +11 | +12 | if issubclass(arg2, HasX): # error: [invalid-argument-type] + | + +``` + +``` +error[invalid-argument-type]: Class `HasX` cannot be used as the second argument to `issubclass` + --> src/mdtest_snippet.py:12:8 + | +10 | reveal_type(arg) # revealed: ~HasX +11 | +12 | if issubclass(arg2, HasX): # error: [invalid-argument-type] + | ^^^^^^^^^^^^^^^^^^^^^^ This call will raise `TypeError` at runtime +13 | reveal_type(arg2) # revealed: type[HasX] +14 | else: + | +info: `HasX` is declared as a protocol class, but it is not declared as runtime-checkable + --> src/mdtest_snippet.py:3:7 + | +1 | from typing_extensions import Protocol, reveal_type +2 | +3 | class HasX(Protocol): + | ^^^^^^^^^^^^^^ `HasX` declared here +4 | x: int + | +info: A protocol class can only be used in `issubclass` checks if it is decorated with `@typing.runtime_checkable` or `@typing_extensions.runtime_checkable` +info: See https://docs.python.org/3/library/typing.html#typing.runtime_checkable +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:13:21 + | +12 | if issubclass(arg2, HasX): # error: [invalid-argument-type] +13 | reveal_type(arg2) # revealed: type[HasX] + | ^^^^ `type[HasX]` +14 | else: +15 | reveal_type(arg2) # revealed: type & ~type[HasX] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:15:21 + | +13 | reveal_type(arg2) # revealed: type[HasX] +14 | else: +15 | reveal_type(arg2) # revealed: type & ~type[HasX] + | ^^^^ `type & ~type[HasX]` +16 | from typing import runtime_checkable + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:24:21 + | +22 | def f(arg: object): +23 | if isinstance(arg, RuntimeCheckableHasX): # no error! +24 | reveal_type(arg) # revealed: RuntimeCheckableHasX + | ^^^ `RuntimeCheckableHasX` +25 | else: +26 | reveal_type(arg) # revealed: ~RuntimeCheckableHasX + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:26:21 + | +24 | reveal_type(arg) # revealed: RuntimeCheckableHasX +25 | else: +26 | reveal_type(arg) # revealed: ~RuntimeCheckableHasX + | ^^^ `~RuntimeCheckableHasX` +27 | @runtime_checkable +28 | class OnlyMethodMembers(Protocol): + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:33:21 + | +31 | def f(arg1: type, arg2: type): +32 | if issubclass(arg1, RuntimeCheckableHasX): # TODO: should emit an error here (has non-method members) +33 | reveal_type(arg1) # revealed: type[RuntimeCheckableHasX] + | ^^^^ `type[RuntimeCheckableHasX]` +34 | else: +35 | reveal_type(arg1) # revealed: type & ~type[RuntimeCheckableHasX] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:35:21 + | +33 | reveal_type(arg1) # revealed: type[RuntimeCheckableHasX] +34 | else: +35 | reveal_type(arg1) # revealed: type & ~type[RuntimeCheckableHasX] + | ^^^^ `type & ~type[RuntimeCheckableHasX]` +36 | +37 | if issubclass(arg2, OnlyMethodMembers): # no error! + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:38:21 + | +37 | if issubclass(arg2, OnlyMethodMembers): # no error! +38 | reveal_type(arg2) # revealed: type[OnlyMethodMembers] + | ^^^^ `type[OnlyMethodMembers]` +39 | else: +40 | reveal_type(arg2) # revealed: type & ~type[OnlyMethodMembers] + | + +``` + +``` +info[revealed-type]: Revealed type + --> src/mdtest_snippet.py:40:21 + | +38 | reveal_type(arg2) # revealed: type[OnlyMethodMembers] +39 | else: +40 | reveal_type(arg2) # revealed: type & ~type[OnlyMethodMembers] + | ^^^^ `type & ~type[OnlyMethodMembers]` + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Diagnostics_for_`inv\342\200\246_(35563a74094b14d5).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Diagnostics_for_`inv\342\200\246_(35563a74094b14d5).snap" new file mode 100644 index 0000000000000..67c96c3139e5f --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Diagnostics_for_`inv\342\200\246_(35563a74094b14d5).snap" @@ -0,0 +1,48 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Diagnostics for `invalid-return-type` on non-protocol subclasses of protocol classes +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from typing_extensions import Protocol +2 | +3 | class Abstract(Protocol): +4 | def method(self) -> str: ... +5 | +6 | class Concrete(Abstract): +7 | def method(self) -> str: ... # error: [invalid-return-type] +``` + +# Diagnostics + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `str` + --> src/mdtest_snippet.py:7:25 + | +6 | class Concrete(Abstract): +7 | def method(self) -> str: ... # error: [invalid-return-type] + | ^^^ + | +info: Only functions in stub files, methods on protocol classes, or methods with `@abstractmethod` are permitted to have empty bodies +info: Class `Concrete` has `typing.Protocol` in its MRO, but it is not a protocol class +info: Only classes that directly inherit from `typing.Protocol` or `typing_extensions.Protocol` are considered protocol classes + --> src/mdtest_snippet.py:6:7 + | +4 | def method(self) -> str: ... +5 | +6 | class Concrete(Abstract): + | ^^^^^^^^^^^^^^^^^^ `Protocol` not present in `Concrete`'s immediate bases +7 | def method(self) -> str: ... # error: [invalid-return-type] + | +info: See https://typing.python.org/en/latest/spec/protocol.html# +info: rule `invalid-return-type` is enabled by default + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Generator_functions_(d9ed06b61b14fd4c).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Generator_functions_(d9ed06b61b14fd4c).snap new file mode 100644 index 0000000000000..fe49d4d2be885 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Generator_functions_(d9ed06b61b14fd4c).snap @@ -0,0 +1,87 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Generator functions +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | import types + 2 | import typing + 3 | + 4 | def f() -> types.GeneratorType: + 5 | yield 42 + 6 | + 7 | def g() -> typing.Generator: + 8 | yield 42 + 9 | +10 | def h() -> typing.Iterator: +11 | yield 42 +12 | +13 | def i() -> typing.Iterable: +14 | yield 42 +15 | +16 | def i2() -> typing.Generator: +17 | yield from i() +18 | +19 | def j() -> str: # error: [invalid-return-type] +20 | yield 42 +21 | import types +22 | import typing +23 | +24 | async def f() -> types.AsyncGeneratorType: +25 | yield 42 +26 | +27 | async def g() -> typing.AsyncGenerator: +28 | yield 42 +29 | +30 | async def h() -> typing.AsyncIterator: +31 | yield 42 +32 | +33 | async def i() -> typing.AsyncIterable: +34 | yield 42 +35 | +36 | async def j() -> str: # error: [invalid-return-type] +37 | yield 42 +``` + +# Diagnostics + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:19:12 + | +17 | yield from i() +18 | +19 | def j() -> str: # error: [invalid-return-type] + | ^^^ expected `str`, found `types.GeneratorType` +20 | yield 42 +21 | import types + | +info: Function is inferred as returning `types.GeneratorType` because it is a generator function +info: See https://docs.python.org/3/glossary.html#term-generator for more details +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:36:18 + | +34 | yield 42 +35 | +36 | async def j() -> str: # error: [invalid-return-type] + | ^^^ expected `str`, found `types.AsyncGeneratorType` +37 | yield 42 + | +info: Function is inferred as returning `types.AsyncGeneratorType` because it is an async generator function +info: See https://docs.python.org/3/glossary.html#term-asynchronous-generator for more details +info: rule `invalid-return-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_conditional_\342\200\246_(94c036c5d3803ab2).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_conditional_\342\200\246_(94c036c5d3803ab2).snap" new file mode 100644 index 0000000000000..516ed04ec67bf --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_conditional_\342\200\246_(94c036c5d3803ab2).snap" @@ -0,0 +1,91 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Invalid conditional return type +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def f(cond: bool) -> str: + 2 | if cond: + 3 | return "a" + 4 | else: + 5 | # error: [invalid-return-type] + 6 | return 1 + 7 | + 8 | def f(cond: bool) -> str: + 9 | if cond: +10 | # error: [invalid-return-type] +11 | return 1 +12 | else: +13 | # error: [invalid-return-type] +14 | return 2 +``` + +# Diagnostics + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:1:22 + | +1 | def f(cond: bool) -> str: + | --- Expected `str` because of return type +2 | if cond: +3 | return "a" +4 | else: +5 | # error: [invalid-return-type] +6 | return 1 + | ^ expected `str`, found `Literal[1]` +7 | +8 | def f(cond: bool) -> str: + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:8:22 + | + 6 | return 1 + 7 | + 8 | def f(cond: bool) -> str: + | --- Expected `str` because of return type + 9 | if cond: +10 | # error: [invalid-return-type] +11 | return 1 + | ^ expected `str`, found `Literal[1]` +12 | else: +13 | # error: [invalid-return-type] + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:14:16 + | +12 | else: +13 | # error: [invalid-return-type] +14 | return 2 + | ^ expected `str`, found `Literal[2]` + | + ::: src/mdtest_snippet.py:8:22 + | + 6 | return 1 + 7 | + 8 | def f(cond: bool) -> str: + | --- Expected `str` because of return type + 9 | if cond: +10 | # error: [invalid-return-type] + | +info: rule `invalid-return-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_implicit_ret\342\200\246_(393cb38bf7119649).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_implicit_ret\342\200\246_(393cb38bf7119649).snap" new file mode 100644 index 0000000000000..e77bd91b65ba5 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_implicit_ret\342\200\246_(393cb38bf7119649).snap" @@ -0,0 +1,99 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Invalid implicit return type +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def f() -> None: + 2 | if False: + 3 | # error: [invalid-return-type] + 4 | return 1 + 5 | + 6 | # error: [invalid-return-type] + 7 | def f(cond: bool) -> int: + 8 | if cond: + 9 | return 1 +10 | +11 | # error: [invalid-return-type] +12 | def f(cond: bool) -> int: +13 | if cond: +14 | raise ValueError() +15 | +16 | # error: [invalid-return-type] +17 | def f(cond: bool) -> int: +18 | if cond: +19 | cond = False +20 | else: +21 | return 1 +22 | if cond: +23 | return 2 +``` + +# Diagnostics + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:1:12 + | +1 | def f() -> None: + | ---- Expected `None` because of return type +2 | if False: +3 | # error: [invalid-return-type] +4 | return 1 + | ^ expected `None`, found `Literal[1]` +5 | +6 | # error: [invalid-return-type] + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.py:7:22 + | +6 | # error: [invalid-return-type] +7 | def f(cond: bool) -> int: + | ^^^ +8 | if cond: +9 | return 1 + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.py:12:22 + | +11 | # error: [invalid-return-type] +12 | def f(cond: bool) -> int: + | ^^^ +13 | if cond: +14 | raise ValueError() + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.py:17:22 + | +16 | # error: [invalid-return-type] +17 | def f(cond: bool) -> int: + | ^^^ +18 | if cond: +19 | cond = False + | +info: rule `invalid-return-type` is enabled by default + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_(a91e0c67519cd77f).snap b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_(a91e0c67519cd77f).snap new file mode 100644 index 0000000000000..d452f178202ba --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_(a91e0c67519cd77f).snap @@ -0,0 +1,96 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Invalid return type +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | # error: [invalid-return-type] + 2 | def f() -> int: + 3 | 1 + 4 | + 5 | def f() -> str: + 6 | # error: [invalid-return-type] + 7 | return 1 + 8 | + 9 | def f() -> int: +10 | # error: [invalid-return-type] +11 | return +12 | +13 | from typing import TypeVar +14 | +15 | T = TypeVar("T") +16 | +17 | # error: [invalid-return-type] +18 | def m(x: T) -> T: ... +``` + +# Diagnostics + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.py:2:12 + | +1 | # error: [invalid-return-type] +2 | def f() -> int: + | ^^^ +3 | 1 + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:5:12 + | +3 | 1 +4 | +5 | def f() -> str: + | --- Expected `str` because of return type +6 | # error: [invalid-return-type] +7 | return 1 + | ^ expected `str`, found `Literal[1]` +8 | +9 | def f() -> int: + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.py:9:12 + | + 7 | return 1 + 8 | + 9 | def f() -> int: + | --- Expected `int` because of return type +10 | # error: [invalid-return-type] +11 | return + | ^^^^^^ expected `int`, found `None` +12 | +13 | from typing import TypeVar + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `T` + --> src/mdtest_snippet.py:18:16 + | +17 | # error: [invalid-return-type] +18 | def m(x: T) -> T: ... + | ^ + | +info: rule `invalid-return-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_\342\200\246_(c3a523878447af6b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_\342\200\246_(c3a523878447af6b).snap" new file mode 100644 index 0000000000000..bf469ce066d66 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/return_type.md_-_Function_return_type_-_Invalid_return_type_\342\200\246_(c3a523878447af6b).snap" @@ -0,0 +1,74 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: return_type.md - Function return type - Invalid return type in stub file +mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md +--- + +# Python source files + +## mdtest_snippet.pyi + +``` + 1 | def f() -> int: + 2 | # error: [invalid-return-type] + 3 | return ... + 4 | + 5 | # error: [invalid-return-type] + 6 | def foo() -> int: + 7 | print("...") + 8 | ... + 9 | +10 | # error: [invalid-return-type] +11 | def foo() -> int: +12 | f"""{foo} is a function that ...""" +13 | ... +``` + +# Diagnostics + +``` +error[invalid-return-type]: Return type does not match returned value + --> src/mdtest_snippet.pyi:1:12 + | +1 | def f() -> int: + | --- Expected `int` because of return type +2 | # error: [invalid-return-type] +3 | return ... + | ^^^ expected `int`, found `ellipsis` +4 | +5 | # error: [invalid-return-type] + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.pyi:6:14 + | +5 | # error: [invalid-return-type] +6 | def foo() -> int: + | ^^^ +7 | print("...") +8 | ... + | +info: rule `invalid-return-type` is enabled by default + +``` + +``` +error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int` + --> src/mdtest_snippet.pyi:11:14 + | +10 | # error: [invalid-return-type] +11 | def foo() -> int: + | ^^^ +12 | f"""{foo} is a function that ...""" +13 | ... + | +info: rule `invalid-return-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/rich_comparison.md_-_Comparison___Rich_Com\342\200\246_-_Chained_comparisons_\342\200\246_(c391c13e2abc18a0).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/rich_comparison.md_-_Comparison___Rich_Com\342\200\246_-_Chained_comparisons_\342\200\246_(c391c13e2abc18a0).snap" new file mode 100644 index 0000000000000..e40ecc83614de --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/rich_comparison.md_-_Comparison___Rich_Com\342\200\246_-_Chained_comparisons_\342\200\246_(c391c13e2abc18a0).snap" @@ -0,0 +1,64 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: rich_comparison.md - Comparison: Rich Comparison - Chained comparisons with objects that don't implement `__bool__` correctly +mdtest path: crates/ty_python_semantic/resources/mdtest/comparison/instances/rich_comparison.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class NotBoolable: + 2 | __bool__: int = 3 + 3 | + 4 | class Comparable: + 5 | def __lt__(self, item) -> NotBoolable: + 6 | return NotBoolable() + 7 | + 8 | def __gt__(self, item) -> NotBoolable: + 9 | return NotBoolable() +10 | +11 | # error: [unsupported-bool-conversion] +12 | 10 < Comparable() < 20 +13 | # error: [unsupported-bool-conversion] +14 | 10 < Comparable() < Comparable() +15 | +16 | Comparable() < Comparable() # fine +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:12:1 + | +11 | # error: [unsupported-bool-conversion] +12 | 10 < Comparable() < 20 + | ^^^^^^^^^^^^^^^^^ +13 | # error: [unsupported-bool-conversion] +14 | 10 < Comparable() < Comparable() + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:14:1 + | +12 | 10 < Comparable() < 20 +13 | # error: [unsupported-bool-conversion] +14 | 10 < Comparable() < Comparable() + | ^^^^^^^^^^^^^^^^^ +15 | +16 | Comparable() < Comparable() # fine + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/semantic_syntax_erro\342\200\246_-_Semantic_syntax_erro\342\200\246_-_`async`_comprehensio\342\200\246_-_Python_3.10_(96aa8ec77d46553d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/semantic_syntax_erro\342\200\246_-_Semantic_syntax_erro\342\200\246_-_`async`_comprehensio\342\200\246_-_Python_3.10_(96aa8ec77d46553d).snap" new file mode 100644 index 0000000000000..e1e2deae539ef --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/semantic_syntax_erro\342\200\246_-_Semantic_syntax_erro\342\200\246_-_`async`_comprehensio\342\200\246_-_Python_3.10_(96aa8ec77d46553d).snap" @@ -0,0 +1,46 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: semantic_syntax_errors.md - Semantic syntax error diagnostics - `async` comprehensions in synchronous comprehensions - Python 3.10 +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/semantic_syntax_errors.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | async def elements(n): + 2 | yield n + 3 | + 4 | async def f(): + 5 | # error: 19 [invalid-syntax] "cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11)" + 6 | return {n: [x async for x in elements(n)] for n in range(3)} + 7 | async def test(): + 8 | return [[x async for x in elements(n)] async for n in range(3)] + 9 | async def f(): +10 | [x for x in [1]] and [x async for x in elements(1)] +11 | +12 | async def f(): +13 | def g(): +14 | pass +15 | [x async for x in elements(1)] +``` + +# Diagnostics + +``` +error[invalid-syntax] + --> src/mdtest_snippet.py:6:19 + | +4 | async def f(): +5 | # error: 19 [invalid-syntax] "cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (synt... +6 | return {n: [x async for x in elements(n)] for n in range(3)} + | ^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot use an asynchronous comprehension inside of a synchronous comprehension on Python 3.10 (syntax was added in 3.11) +7 | async def test(): +8 | return [[x async for x in elements(n)] async for n in range(3)] + | + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_class_shado\342\200\246_(c8ff9e3a079e8bd5).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_class_shado\342\200\246_(c8ff9e3a079e8bd5).snap" new file mode 100644 index 0000000000000..5109c05d9a773 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_class_shado\342\200\246_(c8ff9e3a079e8bd5).snap" @@ -0,0 +1,34 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: shadowing.md - Shadowing - Implicit class shadowing +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/shadowing.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class C: ... +2 | +3 | C = 1 # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Implicit shadowing of class `C` + --> src/mdtest_snippet.py:3:1 + | +1 | class C: ... +2 | +3 | C = 1 # error: [invalid-assignment] + | ^ + | +info: Annotate to make it explicit if this is intentional +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_function_sh\342\200\246_(a1515328b775ebc1).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_function_sh\342\200\246_(a1515328b775ebc1).snap" new file mode 100644 index 0000000000000..c9e3b2b326195 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/shadowing.md_-_Shadowing_-_Implicit_function_sh\342\200\246_(a1515328b775ebc1).snap" @@ -0,0 +1,34 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: shadowing.md - Shadowing - Implicit function shadowing +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/shadowing.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | def f(): ... +2 | +3 | f = 1 # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Implicit shadowing of function `f` + --> src/mdtest_snippet.py:3:1 + | +1 | def f(): ... +2 | +3 | f = 1 # error: [invalid-assignment] + | ^ + | +info: Annotate to make it explicit if this is intentional +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Chained_comparisons_\342\200\246_(f45f1da2f8ca693d).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Chained_comparisons_\342\200\246_(f45f1da2f8ca693d).snap" new file mode 100644 index 0000000000000..e8fe6a5285d02 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Chained_comparisons_\342\200\246_(f45f1da2f8ca693d).snap" @@ -0,0 +1,49 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: tuples.md - Comparison: Tuples - Chained comparisons with elements that incorrectly implement `__bool__` +mdtest path: crates/ty_python_semantic/resources/mdtest/comparison/tuples.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class NotBoolable: + 2 | __bool__: int = 5 + 3 | + 4 | class Comparable: + 5 | def __lt__(self, other) -> NotBoolable: + 6 | return NotBoolable() + 7 | + 8 | def __gt__(self, other) -> NotBoolable: + 9 | return NotBoolable() +10 | +11 | a = (1, Comparable()) +12 | b = (1, Comparable()) +13 | +14 | # error: [unsupported-bool-conversion] +15 | a < b < b +16 | +17 | a < b # fine +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable | Literal[False]` + --> src/mdtest_snippet.py:15:1 + | +14 | # error: [unsupported-bool-conversion] +15 | a < b < b + | ^^^^^ +16 | +17 | a < b # fine + | +info: `__bool__` on `NotBoolable | Literal[False]` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Equality_with_elemen\342\200\246_(39b614d4707c0661).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Equality_with_elemen\342\200\246_(39b614d4707c0661).snap" new file mode 100644 index 0000000000000..10cc6b703f850 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/tuples.md_-_Comparison___Tuples_-_Equality_with_elemen\342\200\246_(39b614d4707c0661).snap" @@ -0,0 +1,39 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: tuples.md - Comparison: Tuples - Equality with elements that incorrectly implement `__bool__` +mdtest path: crates/ty_python_semantic/resources/mdtest/comparison/tuples.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | __bool__: None = None +3 | +4 | class A: +5 | def __eq__(self, other) -> NotBoolable: +6 | return NotBoolable() +7 | +8 | # error: [unsupported-bool-conversion] +9 | (A(),) == (A(),) +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:9:1 + | +8 | # error: [unsupported-bool-conversion] +9 | (A(),) == (A(),) + | ^^^^^^^^^^^^^^^^ + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_A_smaller_scale_exam\342\200\246_(c24ecd8582e5eb2f).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_A_smaller_scale_exam\342\200\246_(c24ecd8582e5eb2f).snap" new file mode 100644 index 0000000000000..f332f243c3926 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_A_smaller_scale_exam\342\200\246_(c24ecd8582e5eb2f).snap" @@ -0,0 +1,70 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: union_call.md - Calling a union of function types - A smaller scale example +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def f1() -> int: + 2 | return 0 + 3 | + 4 | def f2(name: str) -> int: + 5 | return 0 + 6 | + 7 | def _(flag: bool): + 8 | if flag: + 9 | f = f1 +10 | else: +11 | f = f2 +12 | # error: [too-many-positional-arguments] +13 | # error: [invalid-argument-type] +14 | x = f(3) +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `f2` is incorrect + --> src/mdtest_snippet.py:14:11 + | +12 | # error: [too-many-positional-arguments] +13 | # error: [invalid-argument-type] +14 | x = f(3) + | ^ Expected `str`, found `Literal[3]` + | +info: Function defined here + --> src/mdtest_snippet.py:4:5 + | +2 | return 0 +3 | +4 | def f2(name: str) -> int: + | ^^ --------- Parameter declared here +5 | return 0 + | +info: Union variant `def f2(name: str) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int)` +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[too-many-positional-arguments]: Too many positional arguments to function `f1`: expected 0, got 1 + --> src/mdtest_snippet.py:14:11 + | +12 | # error: [too-many-positional-arguments] +13 | # error: [invalid-argument-type] +14 | x = f(3) + | ^ + | +info: Union variant `def f1() -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int)` +info: rule `too-many-positional-arguments` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Multiple_variants_bu\342\200\246_(d840ac443ca8ec7f).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Multiple_variants_bu\342\200\246_(d840ac443ca8ec7f).snap" new file mode 100644 index 0000000000000..4c278cbf2d12b --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Multiple_variants_bu\342\200\246_(d840ac443ca8ec7f).snap" @@ -0,0 +1,54 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: union_call.md - Calling a union of function types - Multiple variants but only one is invalid +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def f1(a: int) -> int: + 2 | return 0 + 3 | + 4 | def f2(name: str) -> int: + 5 | return 0 + 6 | + 7 | def _(flag: bool): + 8 | if flag: + 9 | f = f1 +10 | else: +11 | f = f2 +12 | # error: [invalid-argument-type] +13 | x = f(3) +``` + +# Diagnostics + +``` +error[invalid-argument-type]: Argument to function `f2` is incorrect + --> src/mdtest_snippet.py:13:11 + | +11 | f = f2 +12 | # error: [invalid-argument-type] +13 | x = f(3) + | ^ Expected `str`, found `Literal[3]` + | +info: Function defined here + --> src/mdtest_snippet.py:4:5 + | +2 | return 0 +3 | +4 | def f2(name: str) -> int: + | ^^ --------- Parameter declared here +5 | return 0 + | +info: Union variant `def f2(name: str) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1(a: int) -> int) | (def f2(name: str) -> int)` +info: rule `invalid-argument-type` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_keyword_argume\342\200\246_(ad1d489710ee2a34).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_keyword_argume\342\200\246_(ad1d489710ee2a34).snap" new file mode 100644 index 0000000000000..1224cb6610f4b --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_keyword_argume\342\200\246_(ad1d489710ee2a34).snap" @@ -0,0 +1,61 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: union_call.md - Calling a union of function types - Try to cover all possible reasons - Cover keyword argument related reasons +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | def any(*args, **kwargs) -> int: + 2 | return 0 + 3 | + 4 | def f1(name: str) -> int: + 5 | return 0 + 6 | + 7 | def _(n: int): + 8 | if n == 0: + 9 | f = f1 +10 | else: +11 | f = any +12 | # error: [parameter-already-assigned] +13 | # error: [unknown-argument] +14 | y = f("foo", name="bar", unknown="quux") +``` + +# Diagnostics + +``` +error[parameter-already-assigned]: Multiple values provided for parameter `name` of function `f1` + --> src/mdtest_snippet.py:14:18 + | +12 | # error: [parameter-already-assigned] +13 | # error: [unknown-argument] +14 | y = f("foo", name="bar", unknown="quux") + | ^^^^^^^^^^ + | +info: Union variant `def f1(name: str) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1(name: str) -> int) | (def any(*args, **kwargs) -> int)` +info: rule `parameter-already-assigned` is enabled by default + +``` + +``` +error[unknown-argument]: Argument `unknown` does not match any known parameter of function `f1` + --> src/mdtest_snippet.py:14:30 + | +12 | # error: [parameter-already-assigned] +13 | # error: [unknown-argument] +14 | y = f("foo", name="bar", unknown="quux") + | ^^^^^^^^^^^^^^ + | +info: Union variant `def f1(name: str) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1(name: str) -> int) | (def any(*args, **kwargs) -> int)` +info: rule `unknown-argument` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_non-keyword_re\342\200\246_(707b284610419a54).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_non-keyword_re\342\200\246_(707b284610419a54).snap" new file mode 100644 index 0000000000000..b8924b5134e6d --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/union_call.md_-_Calling_a_union_of_f\342\200\246_-_Try_to_cover_all_pos\342\200\246_-_Cover_non-keyword_re\342\200\246_(707b284610419a54).snap" @@ -0,0 +1,188 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: union_call.md - Calling a union of function types - Try to cover all possible reasons - Cover non-keyword related reasons +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/union_call.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | from inspect import getattr_static + 2 | + 3 | def f1() -> int: + 4 | return 0 + 5 | + 6 | def f2(name: str) -> int: + 7 | return 0 + 8 | + 9 | def f3(a: int, b: int) -> int: +10 | return 0 +11 | +12 | def f4[T: str](x: T) -> int: +13 | return 0 +14 | +15 | class OverloadExample: +16 | def f(self, x: str) -> int: +17 | return 0 +18 | +19 | f5 = getattr_static(OverloadExample, "f").__get__ +20 | +21 | def _(n: int): +22 | class PossiblyNotCallable: +23 | if n == 0: +24 | def __call__(self) -> int: +25 | return 0 +26 | +27 | if n == 0: +28 | f = f1 +29 | elif n == 1: +30 | f = f2 +31 | elif n == 2: +32 | f = f3 +33 | elif n == 3: +34 | f = f4 +35 | elif n == 4: +36 | f = 5 +37 | elif n == 5: +38 | f = f5 +39 | else: +40 | f = PossiblyNotCallable() +41 | # error: [too-many-positional-arguments] +42 | # error: [invalid-argument-type] "Argument to function `f2` is incorrect: Expected `str`, found `Literal[3]`" +43 | # error: [missing-argument] +44 | # error: [invalid-argument-type] "Argument to function `f4` is incorrect: Argument type `Literal[3]` does not satisfy upper bound of type variable `T`" +45 | # error: [call-non-callable] "Object of type `Literal[5]` is not callable" +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) +``` + +# Diagnostics + +``` +error[call-non-callable]: Object of type `Literal[5]` is not callable + --> src/mdtest_snippet.py:48:9 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^^^^ + | +info: Union variant `Literal[5]` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `call-non-callable` is enabled by default + +``` + +``` +error[call-non-callable]: Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method) + --> src/mdtest_snippet.py:48:9 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^^^^ + | +info: Union variant `PossiblyNotCallable` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `call-non-callable` is enabled by default + +``` + +``` +error[missing-argument]: No argument provided for required parameter `b` of function `f3` + --> src/mdtest_snippet.py:48:9 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^^^^ + | +info: Union variant `def f3(a: int, b: int) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `missing-argument` is enabled by default + +``` + +``` +error[no-matching-overload]: No overload of method wrapper `__get__` of function `f` matches arguments + --> src/mdtest_snippet.py:48:9 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^^^^ + | +info: Union variant `<method-wrapper `__get__` of `f`>` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `no-matching-overload` is enabled by default + +``` + +``` +error[invalid-argument-type]: Argument to function `f2` is incorrect + --> src/mdtest_snippet.py:48:11 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^ Expected `str`, found `Literal[3]` + | +info: Function defined here + --> src/mdtest_snippet.py:6:5 + | +4 | return 0 +5 | +6 | def f2(name: str) -> int: + | ^^ --------- Parameter declared here +7 | return 0 + | +info: Union variant `def f2(name: str) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[invalid-argument-type]: Argument to function `f4` is incorrect + --> src/mdtest_snippet.py:48:11 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^ Argument type `Literal[3]` does not satisfy upper bound of type variable `T` + | +info: Type variable defined here + --> src/mdtest_snippet.py:12:8 + | +10 | return 0 +11 | +12 | def f4[T: str](x: T) -> int: + | ^^^^^^ +13 | return 0 + | +info: Union variant `def f4(x: T) -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `invalid-argument-type` is enabled by default + +``` + +``` +error[too-many-positional-arguments]: Too many positional arguments to function `f1`: expected 0, got 1 + --> src/mdtest_snippet.py:48:11 + | +46 | # error: [no-matching-overload] +47 | # error: [call-non-callable] "Object of type `PossiblyNotCallable` is not callable (possibly unbound `__call__` method)" +48 | x = f(3) + | ^ + | +info: Union variant `def f1() -> int` is incompatible with this call site +info: Attempted to call union type `(def f1() -> int) | (def f2(name: str) -> int) | (def f3(a: int, b: int) -> int) | (def f4(x: T) -> int) | Literal[5] | Unknown | (<method-wrapper `__get__` of `f`>) | PossiblyNotCallable` +info: rule `too-many-positional-arguments` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_few_valu\342\200\246_(f920ea85eefe9cfe).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_few_valu\342\200\246_(f920ea85eefe9cfe).snap" new file mode 100644 index 0000000000000..55d6a1a7ea7e5 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_few_valu\342\200\246_(f920ea85eefe9cfe).snap" @@ -0,0 +1,31 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unpacking.md - Unpacking - Exactly too few values to unpack +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | a, b = (1,) # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Not enough values to unpack + --> src/mdtest_snippet.py:1:1 + | +1 | a, b = (1,) # error: [invalid-assignment] + | ^^^^ ---- Got 1 + | | + | Expected 2 + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_many_val\342\200\246_(a53a2aec02bc999).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_many_val\342\200\246_(a53a2aec02bc999).snap" new file mode 100644 index 0000000000000..8aad685ea46f9 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Exactly_too_many_val\342\200\246_(a53a2aec02bc999).snap" @@ -0,0 +1,31 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unpacking.md - Unpacking - Exactly too many values to unpack +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | a, b = (1, 2, 3) # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Too many values to unpack + --> src/mdtest_snippet.py:1:1 + | +1 | a, b = (1, 2, 3) # error: [invalid-assignment] + | ^^^^ --------- Got 3 + | | + | Expected 2 + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Right_hand_side_not_\342\200\246_(fae6e2d526396252).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Right_hand_side_not_\342\200\246_(fae6e2d526396252).snap" new file mode 100644 index 0000000000000..e26eb8fae48bc --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Right_hand_side_not_\342\200\246_(fae6e2d526396252).snap" @@ -0,0 +1,30 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unpacking.md - Unpacking - Right hand side not iterable +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | a, b = 1 # error: [not-iterable] +``` + +# Diagnostics + +``` +error[not-iterable]: Object of type `Literal[1]` is not iterable + --> src/mdtest_snippet.py:1:8 + | +1 | a, b = 1 # error: [not-iterable] + | ^ + | +info: It doesn't have an `__iter__` method or a `__getitem__` method +info: rule `not-iterable` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Too_few_values_to_un\342\200\246_(cef19e6b2b58e6a3).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Too_few_values_to_un\342\200\246_(cef19e6b2b58e6a3).snap" new file mode 100644 index 0000000000000..b20add36c4dc5 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unpacking.md_-_Unpacking_-_Too_few_values_to_un\342\200\246_(cef19e6b2b58e6a3).snap" @@ -0,0 +1,31 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unpacking.md - Unpacking - Too few values to unpack +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unpacking.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | [a, *b, c, d] = (1, 2) # error: [invalid-assignment] +``` + +# Diagnostics + +``` +error[invalid-assignment]: Not enough values to unpack + --> src/mdtest_snippet.py:1:1 + | +1 | [a, *b, c, d] = (1, 2) # error: [invalid-assignment] + | ^^^^^^^^^^^^^ ------ Got 2 + | | + | Expected 3 or more + | +info: rule `invalid-assignment` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_An_unresolvable_impo\342\200\246_(72d090df51ea97b8).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_An_unresolvable_impo\342\200\246_(72d090df51ea97b8).snap" new file mode 100644 index 0000000000000..24433124a7fa4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_An_unresolvable_impo\342\200\246_(72d090df51ea97b8).snap" @@ -0,0 +1,34 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - An unresolvable import that does not use `from` +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | import does_not_exist # error: [unresolved-import] +2 | +3 | x = does_not_exist.foo +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `does_not_exist` + --> src/mdtest_snippet.py:1:8 + | +1 | import does_not_exist # error: [unresolved-import] + | ^^^^^^^^^^^^^^ +2 | +3 | x = does_not_exist.foo + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_a_\342\200\246_(12d4a70b7fc67cc6).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_a_\342\200\246_(12d4a70b7fc67cc6).snap" new file mode 100644 index 0000000000000..2972b4a66cb71 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_a_\342\200\246_(12d4a70b7fc67cc6).snap" @@ -0,0 +1,36 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - Using `from` with a resolvable module but unresolvable item +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## a.py + +``` +1 | does_exist1 = 1 +2 | does_exist2 = 2 +``` + +## mdtest_snippet.py + +``` +1 | from a import does_exist1, does_not_exist, does_exist2 # error: [unresolved-import] +``` + +# Diagnostics + +``` +error[unresolved-import]: Module `a` has no member `does_not_exist` + --> src/mdtest_snippet.py:1:28 + | +1 | from a import does_exist1, does_not_exist, does_exist2 # error: [unresolved-import] + | ^^^^^^^^^^^^^^ + | +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(6cff507dc64a1bff).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(6cff507dc64a1bff).snap" new file mode 100644 index 0000000000000..5288e0941c30f --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(6cff507dc64a1bff).snap" @@ -0,0 +1,33 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - Using `from` with an unknown nested module +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from .does_not_exist.foo.bar import add # error: [unresolved-import] +2 | +3 | stat = add(10, 15) +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `.does_not_exist.foo.bar` + --> src/mdtest_snippet.py:1:7 + | +1 | from .does_not_exist.foo.bar import add # error: [unresolved-import] + | ^^^^^^^^^^^^^^^^^^^^^^ +2 | +3 | stat = add(10, 15) + | +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9da56616d6332a83).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9da56616d6332a83).snap" new file mode 100644 index 0000000000000..7fd8b0c264552 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9da56616d6332a83).snap" @@ -0,0 +1,33 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - Using `from` with an unknown current module +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from .does_not_exist import add # error: [unresolved-import] +2 | +3 | stat = add(10, 15) +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `.does_not_exist` + --> src/mdtest_snippet.py:1:7 + | +1 | from .does_not_exist import add # error: [unresolved-import] + | ^^^^^^^^^^^^^^ +2 | +3 | stat = add(10, 15) + | +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9fa713dfa17cc404).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9fa713dfa17cc404).snap" new file mode 100644 index 0000000000000..b1f43919dbcc7 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_an\342\200\246_(9fa713dfa17cc404).snap" @@ -0,0 +1,34 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - Using `from` with an unresolvable module +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | from does_not_exist import add # error: [unresolved-import] +2 | +3 | stat = add(10, 15) +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `does_not_exist` + --> src/mdtest_snippet.py:1:6 + | +1 | from does_not_exist import add # error: [unresolved-import] + | ^^^^^^^^^^^^^^ +2 | +3 | stat = add(10, 15) + | +info: make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_to\342\200\246_(4b8ba6ee48180cdd).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_to\342\200\246_(4b8ba6ee48180cdd).snap" new file mode 100644 index 0000000000000..ea6e6e88a1ec2 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_import.md_-_Unresolved_import_di\342\200\246_-_Using_`from`_with_to\342\200\246_(4b8ba6ee48180cdd).snap" @@ -0,0 +1,45 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_import.md - Unresolved import diagnostics - Using `from` with too many leading dots +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_import.md +--- + +# Python source files + +## package/__init__.py + +``` +``` + +## package/foo.py + +``` +1 | def add(x, y): +2 | return x + y +``` + +## package/subpackage/subsubpackage/__init__.py + +``` +1 | from ....foo import add # error: [unresolved-import] +2 | +3 | stat = add(10, 15) +``` + +# Diagnostics + +``` +error[unresolved-import]: Cannot resolve imported module `....foo` + --> src/package/subpackage/subsubpackage/__init__.py:1:10 + | +1 | from ....foo import add # error: [unresolved-import] + | ^^^ +2 | +3 | stat = add(10, 15) + | +info: rule `unresolved-import` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_reference\342\200\246_-_Diagnostics_for_unre\342\200\246_-_New_builtin_used_on_\342\200\246_(51edda0b1aebc2bf).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_reference\342\200\246_-_Diagnostics_for_unre\342\200\246_-_New_builtin_used_on_\342\200\246_(51edda0b1aebc2bf).snap" new file mode 100644 index 0000000000000..fd14c51a15ea4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unresolved_reference\342\200\246_-_Diagnostics_for_unre\342\200\246_-_New_builtin_used_on_\342\200\246_(51edda0b1aebc2bf).snap" @@ -0,0 +1,31 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unresolved_reference.md - Diagnostics for unresolved references - New builtin used on old Python version +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unresolved_reference.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | aiter # error: [unresolved-reference] +``` + +# Diagnostics + +``` +error[unresolved-reference]: Name `aiter` used when not defined + --> src/mdtest_snippet.py:1:1 + | +1 | aiter # error: [unresolved-reference] + | ^^^^^ + | +info: `aiter` was added as a builtin in Python 3.10 +info: Python 3.9 was assumed when resolving types because it was specified on the command line +info: rule `unresolved-reference` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_att\342\200\246_(2721d40bf12fe8b7).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_att\342\200\246_(2721d40bf12fe8b7).snap" new file mode 100644 index 0000000000000..343aaccc77d28 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_att\342\200\246_(2721d40bf12fe8b7).snap" @@ -0,0 +1,37 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unsupported_bool_conversion.md - Different ways that `unsupported-bool-conversion` can occur - Has a `__bool__` attribute, but it's not callable +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | __bool__: int = 3 +3 | +4 | a = NotBoolable() +5 | +6 | # error: [unsupported-bool-conversion] +7 | 10 and a and True +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:7:8 + | +6 | # error: [unsupported-bool-conversion] +7 | 10 and a and True + | ^ + | +info: `__bool__` on `NotBoolable` must be callable +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(15636dc4074e5335).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(15636dc4074e5335).snap" new file mode 100644 index 0000000000000..09343ef5d62a2 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(15636dc4074e5335).snap" @@ -0,0 +1,47 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unsupported_bool_conversion.md - Different ways that `unsupported-bool-conversion` can occur - Has a `__bool__` method, but has an incorrect return type +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | def __bool__(self) -> str: +3 | return "wat" +4 | +5 | a = NotBoolable() +6 | +7 | # error: [unsupported-bool-conversion] +8 | 10 and a and True +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:8:8 + | +7 | # error: [unsupported-bool-conversion] +8 | 10 and a and True + | ^ + | +info: `str` is not assignable to `bool` + --> src/mdtest_snippet.py:2:9 + | +1 | class NotBoolable: +2 | def __bool__(self) -> str: + | -------- ^^^ Incorrect return type + | | + | Method defined here +3 | return "wat" + | +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(ce8b8da49eaf4cda).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(ce8b8da49eaf4cda).snap" new file mode 100644 index 0000000000000..9957e4c64f38c --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Has_a_`__bool__`_met\342\200\246_(ce8b8da49eaf4cda).snap" @@ -0,0 +1,47 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unsupported_bool_conversion.md - Different ways that `unsupported-bool-conversion` can occur - Has a `__bool__` method, but has incorrect parameters +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | class NotBoolable: +2 | def __bool__(self, foo): +3 | return False +4 | +5 | a = NotBoolable() +6 | +7 | # error: [unsupported-bool-conversion] +8 | 10 and a and True +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for type `NotBoolable` + --> src/mdtest_snippet.py:8:8 + | +7 | # error: [unsupported-bool-conversion] +8 | 10 and a and True + | ^ + | +info: `__bool__` methods must only have a `self` parameter + --> src/mdtest_snippet.py:2:9 + | +1 | class NotBoolable: +2 | def __bool__(self, foo): + | --------^^^^^^^^^^^ Incorrect parameters + | | + | Method defined here +3 | return False + | +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Part_of_a_union_wher\342\200\246_(7cca8063ea43c1a).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Part_of_a_union_wher\342\200\246_(7cca8063ea43c1a).snap" new file mode 100644 index 0000000000000..22d0cc6adade4 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/unsupported_bool_con\342\200\246_-_Different_ways_that_\342\200\246_-_Part_of_a_union_wher\342\200\246_(7cca8063ea43c1a).snap" @@ -0,0 +1,44 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: unsupported_bool_conversion.md - Different ways that `unsupported-bool-conversion` can occur - Part of a union where at least one member has incorrect `__bool__` method +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/unsupported_bool_conversion.md +--- + +# Python source files + +## mdtest_snippet.py + +``` + 1 | class NotBoolable1: + 2 | def __bool__(self) -> str: + 3 | return "wat" + 4 | + 5 | class NotBoolable2: + 6 | pass + 7 | + 8 | class NotBoolable3: + 9 | __bool__: int = 3 +10 | +11 | def get() -> NotBoolable1 | NotBoolable2 | NotBoolable3: +12 | return NotBoolable2() +13 | +14 | # error: [unsupported-bool-conversion] +15 | 10 and get() and True +``` + +# Diagnostics + +``` +error[unsupported-bool-conversion]: Boolean conversion is unsupported for union `NotBoolable1 | NotBoolable2 | NotBoolable3` because `NotBoolable1` doesn't implement `__bool__` correctly + --> src/mdtest_snippet.py:15:8 + | +14 | # error: [unsupported-bool-conversion] +15 | 10 and get() and True + | ^^^^^ + | +info: rule `unsupported-bool-conversion` is enabled by default + +``` diff --git "a/crates/ty_python_semantic/resources/mdtest/snapshots/version_related_synt\342\200\246_-_Version-related_synt\342\200\246_-_`match`_statement_-_Before_3.10_(2545eaa83b635b8b).snap" "b/crates/ty_python_semantic/resources/mdtest/snapshots/version_related_synt\342\200\246_-_Version-related_synt\342\200\246_-_`match`_statement_-_Before_3.10_(2545eaa83b635b8b).snap" new file mode 100644 index 0000000000000..2500cc4544dc3 --- /dev/null +++ "b/crates/ty_python_semantic/resources/mdtest/snapshots/version_related_synt\342\200\246_-_Version-related_synt\342\200\246_-_`match`_statement_-_Before_3.10_(2545eaa83b635b8b).snap" @@ -0,0 +1,32 @@ +--- +source: crates/ty_test/src/lib.rs +expression: snapshot +--- +--- +mdtest name: version_related_syntax_errors.md - Version-related syntax error diagnostics - `match` statement - Before 3.10 +mdtest path: crates/ty_python_semantic/resources/mdtest/diagnostics/version_related_syntax_errors.md +--- + +# Python source files + +## mdtest_snippet.py + +``` +1 | match 2: # error: 1 [invalid-syntax] "Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10)" +2 | case 1: +3 | print("it's one") +``` + +# Diagnostics + +``` +error[invalid-syntax] + --> src/mdtest_snippet.py:1:1 + | +1 | match 2: # error: 1 [invalid-syntax] "Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10)" + | ^^^^^ Cannot use `match` statement on Python 3.9 (syntax was added in Python 3.10) +2 | case 1: +3 | print("it's one") + | + +``` diff --git a/crates/ty_python_semantic/resources/mdtest/statically_known_branches.md b/crates/ty_python_semantic/resources/mdtest/statically_known_branches.md new file mode 100644 index 0000000000000..63db73d206eb8 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/statically_known_branches.md @@ -0,0 +1,1521 @@ +# Statically-known branches + +## Introduction + +We have the ability to infer precise types and boundness information for symbols that are defined in +branches whose conditions we can statically determine to be always true or always false. This is +useful for `sys.version_info` branches, which can make new features available based on the Python +version: + +If we can statically determine that the condition is always true, then we can also understand that +`SomeFeature` is always bound, without raising any errors: + +```py +import sys + +class C: + if sys.version_info >= (3, 9): + SomeFeature: str = "available" + +# C.SomeFeature is unconditionally available here, because we are on Python 3.9 or newer: +reveal_type(C.SomeFeature) # revealed: str +``` + +Another scenario where this is useful is for `typing.TYPE_CHECKING` branches, which are often used +for conditional imports: + +`module.py`: + +```py +class SomeType: ... +``` + +`main.py`: + +```py +import typing + +if typing.TYPE_CHECKING: + from module import SomeType + +# `SomeType` is unconditionally available here for type checkers: +def f(s: SomeType) -> None: ... +``` + +## Common use cases + +This section makes sure that we can handle all commonly encountered patterns of static conditions. + +### `sys.version_info` + +```toml +[environment] +python-version = "3.10" +``` + +```py +import sys + +if sys.version_info >= (3, 11): + greater_equals_311 = True +elif sys.version_info >= (3, 9): + greater_equals_309 = True +else: + less_than_309 = True + +if sys.version_info[0] == 2: + python2 = True + +# error: [unresolved-reference] +greater_equals_311 + +# no error +greater_equals_309 + +# error: [unresolved-reference] +less_than_309 + +# error: [unresolved-reference] +python2 +``` + +### `sys.platform` + +```toml +[environment] +python-platform = "linux" +``` + +```py +import sys + +if sys.platform == "linux": + linux = True +elif sys.platform == "darwin": + darwin = True +else: + other = True + +# no error +linux + +# error: [unresolved-reference] +darwin + +# error: [unresolved-reference] +other +``` + +### `typing.TYPE_CHECKING` + +```py +import typing + +if typing.TYPE_CHECKING: + type_checking = True +else: + runtime = True + +# no error +type_checking + +# error: [unresolved-reference] +runtime +``` + +### Combination of `sys.platform` check and `sys.version_info` check + +```toml +[environment] +python-version = "3.10" +python-platform = "darwin" +``` + +```py +import sys + +if sys.platform == "darwin" and sys.version_info >= (3, 11): + only_platform_check_true = True +elif sys.platform == "win32" and sys.version_info >= (3, 10): + only_version_check_true = True +elif sys.platform == "linux" and sys.version_info >= (3, 11): + both_checks_false = True +elif sys.platform == "darwin" and sys.version_info >= (3, 10): + both_checks_true = True +else: + other = True + +# error: [unresolved-reference] +only_platform_check_true + +# error: [unresolved-reference] +only_version_check_true + +# error: [unresolved-reference] +both_checks_false + +# no error +both_checks_true + +# error: [unresolved-reference] +other +``` + +## Based on type inference + +For the rest of this test suite, we will mostly use `True` and `False` literals to indicate +statically known conditions, but here, we show that the results are truly based on type inference, +not some special handling of specific conditions in semantic index building. We use two modules to +demonstrate this, since semantic index building is inherently single-module: + +`module.py`: + +```py +from typing import Literal + +class AlwaysTrue: + def __bool__(self) -> Literal[True]: + return True +``` + +```py +from module import AlwaysTrue + +if AlwaysTrue(): + yes = True +else: + no = True + +# no error +yes + +# error: [unresolved-reference] +no +``` + +## If statements + +The rest of this document contains tests for various control flow elements. This section tests `if` +statements. + +### Always false + +#### If + +```py +x = 1 + +if False: + x = 2 + +reveal_type(x) # revealed: Literal[1] +``` + +#### Else + +```py +x = 1 + +if True: + pass +else: + x = 2 + +reveal_type(x) # revealed: Literal[1] +``` + +### Always true + +#### If + +```py +x = 1 + +if True: + x = 2 + +reveal_type(x) # revealed: Literal[2] +``` + +#### Else + +```py +x = 1 + +if False: + pass +else: + x = 2 + +reveal_type(x) # revealed: Literal[2] +``` + +### Ambiguous + +Just for comparison, we still infer the combined type if the condition is not statically known: + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 + +reveal_type(x) # revealed: Literal[1, 2] +``` + +### Combination of always true and always false + +```py +x = 1 + +if True: + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[2] +``` + +### `elif` branches + +#### Always false + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif False: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2, 4] +``` + +#### Always true + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif True: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2, 3] +``` + +#### Ambiguous + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif flag(): + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2, 3, 4] +``` + +#### Multiple `elif` branches, always false + +Make sure that we include bindings from all non-`False` branches: + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif flag(): + x = 3 +elif False: + x = 4 +elif False: + x = 5 +elif flag(): + x = 6 +elif flag(): + x = 7 +else: + x = 8 + +reveal_type(x) # revealed: Literal[2, 3, 6, 7, 8] +``` + +#### Multiple `elif` branches, always true + +Make sure that we only include the binding from the first `elif True` branch: + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif flag(): + x = 3 +elif True: + x = 4 +elif True: + x = 5 +elif flag(): + x = 6 +else: + x = 7 + +reveal_type(x) # revealed: Literal[2, 3, 4] +``` + +#### `elif` without `else` branch, always true + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif True: + x = 3 + +reveal_type(x) # revealed: Literal[2, 3] +``` + +#### `elif` without `else` branch, always false + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + x = 2 +elif False: + x = 3 + +reveal_type(x) # revealed: Literal[1, 2] +``` + +### Nested conditionals + +#### `if True` inside `if True` + +```py +x = 1 + +if True: + if True: + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[2] +``` + +#### `if False` inside `if True` + +```py +x = 1 + +if True: + if False: + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[1] +``` + +#### `if <bool>` inside `if True` + +```py +def flag() -> bool: + return True + +x = 1 + +if True: + if flag(): + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[1, 2] +``` + +#### `if True` inside `if <bool>` + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + if True: + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[2, 3] +``` + +#### `if True` inside `if False` ... `else` + +```py +x = 1 + +if False: + x = 2 +else: + if True: + x = 3 + +reveal_type(x) # revealed: Literal[3] +``` + +#### `if False` inside `if False` ... `else` + +```py +x = 1 + +if False: + x = 2 +else: + if False: + x = 3 + +reveal_type(x) # revealed: Literal[1] +``` + +#### `if <bool>` inside `if False` ... `else` + +```py +def flag() -> bool: + return True + +x = 1 + +if False: + x = 2 +else: + if flag(): + x = 3 + +reveal_type(x) # revealed: Literal[1, 3] +``` + +### Nested conditionals (with inner `else`) + +#### `if True` inside `if True` + +```py +x = 1 + +if True: + if True: + x = 2 + else: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2] +``` + +#### `if False` inside `if True` + +```py +x = 1 + +if True: + if False: + x = 2 + else: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[3] +``` + +#### `if <bool>` inside `if True` + +```py +def flag() -> bool: + return True + +x = 1 + +if True: + if flag(): + x = 2 + else: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2, 3] +``` + +#### `if True` inside `if <bool>` + +```py +def flag() -> bool: + return True + +x = 1 + +if flag(): + if True: + x = 2 + else: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[2, 4] +``` + +#### `if True` inside `if False` ... `else` + +```py +x = 1 + +if False: + x = 2 +else: + if True: + x = 3 + else: + x = 4 + +reveal_type(x) # revealed: Literal[3] +``` + +#### `if False` inside `if False` ... `else` + +```py +x = 1 + +if False: + x = 2 +else: + if False: + x = 3 + else: + x = 4 + +reveal_type(x) # revealed: Literal[4] +``` + +#### `if <bool>` inside `if False` ... `else` + +```py +def flag() -> bool: + return True + +x = 1 + +if False: + x = 2 +else: + if flag(): + x = 3 + else: + x = 4 + +reveal_type(x) # revealed: Literal[3, 4] +``` + +### Combination with non-conditional control flow + +#### `try` ... `except` + +##### `if True` inside `try` + +```py +def may_raise() -> None: ... + +x = 1 + +try: + may_raise() + if True: + x = 2 + else: + x = 3 +except: + x = 4 + +reveal_type(x) # revealed: Literal[2, 4] +``` + +##### `try` inside `if True` + +```py +def may_raise() -> None: ... + +x = 1 + +if True: + try: + may_raise() + x = 2 + except KeyError: + x = 3 + except ValueError: + x = 4 +else: + x = 5 + +reveal_type(x) # revealed: Literal[2, 3, 4] +``` + +##### `try` with `else` inside `if True` + +```py +def may_raise() -> None: ... + +x = 1 + +if True: + try: + may_raise() + x = 2 + except KeyError: + x = 3 + else: + x = 4 +else: + x = 5 + +reveal_type(x) # revealed: Literal[3, 4] +``` + +##### `try` with `finally` inside `if True` + +```py +def may_raise() -> None: ... + +x = 1 + +if True: + try: + may_raise() + x = 2 + except KeyError: + x = 3 + else: + x = 4 + finally: + x = 5 +else: + x = 6 + +reveal_type(x) # revealed: Literal[5] +``` + +#### `for` loops + +##### `if True` inside `for` + +```py +def iterable() -> list[object]: + return [1, ""] + +x = 1 + +for _ in iterable(): + x = 2 + if True: + x = 3 + +reveal_type(x) # revealed: Literal[1, 3] +``` + +##### `if True` inside `for` ... `else` + +```py +def iterable() -> list[object]: + return [1, ""] + +x = 1 + +for _ in iterable(): + x = 2 +else: + if True: + x = 3 + else: + x = 4 + +reveal_type(x) # revealed: Literal[3] +``` + +##### `for` inside `if True` + +```py +def iterable() -> list[object]: + return [1, ""] + +x = 1 + +if True: + for _ in iterable(): + x = 2 +else: + x = 3 + +reveal_type(x) # revealed: Literal[1, 2] +``` + +##### `for` ... `else` inside `if True` + +```py +def iterable() -> list[object]: + return [1, ""] + +x = 1 + +if True: + for _ in iterable(): + x = 2 + else: + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[3] +``` + +##### `for` loop with `break` inside `if True` + +```py +def iterable() -> list[object]: + return [1, ""] + +x = 1 + +if True: + x = 2 + for _ in iterable(): + x = 3 + break + else: + x = 4 +else: + x = 5 + +reveal_type(x) # revealed: Literal[3, 4] +``` + +## If expressions + +Note that the result type of an `if`-expression can be precisely inferred if the condition is +statically known. This is a plain type inference feature that does not need support for statically +known branches. The tests for this feature are in [expression/if.md](expression/if.md). + +The tests here make sure that we also handle assignment expressions inside `if`-expressions +correctly. + +### Type inference + +### Always true + +```py +x = (y := 1) if True else (y := 2) + +reveal_type(x) # revealed: Literal[1] +reveal_type(y) # revealed: Literal[1] +``` + +### Always false + +```py +x = (y := 1) if False else (y := 2) + +reveal_type(x) # revealed: Literal[2] +reveal_type(y) # revealed: Literal[2] +``` + +## Boolean expressions + +### Always true, `or` + +```py +(x := 1) or (x := 2) + +reveal_type(x) # revealed: Literal[1] + +(y := 1) or (y := 2) or (y := 3) or (y := 4) + +reveal_type(y) # revealed: Literal[1] +``` + +### Always true, `and` + +```py +(x := 1) and (x := 2) + +reveal_type(x) # revealed: Literal[2] + +(y := 1) and (y := 2) and (y := 3) and (y := 4) + +reveal_type(y) # revealed: Literal[4] +``` + +### Always false, `or` + +```py +(x := 0) or (x := 1) + +reveal_type(x) # revealed: Literal[1] + +(y := 0) or (y := 0) or (y := 1) or (y := 2) + +reveal_type(y) # revealed: Literal[1] +``` + +### Always false, `and` + +```py +(x := 0) and (x := 1) + +reveal_type(x) # revealed: Literal[0] + +(y := 0) and (y := 1) and (y := 2) and (y := 3) + +reveal_type(y) # revealed: Literal[0] +``` + +## While loops + +### Always false + +```py +x = 1 + +while False: + x = 2 + +reveal_type(x) # revealed: Literal[1] +``` + +### Always true + +```py +x = 1 + +while True: + x = 2 + break + +reveal_type(x) # revealed: Literal[2] +``` + +### Ambiguous + +Make sure that we still infer the combined type if the condition is not statically known: + +```py +def flag() -> bool: + return True + +x = 1 + +while flag(): + x = 2 + +reveal_type(x) # revealed: Literal[1, 2] +``` + +### `while` ... `else` + +#### `while False` + +```py +while False: + x = 1 +else: + x = 2 + +reveal_type(x) # revealed: Literal[2] +``` + +#### `while False` with `break` + +```py +x = 1 +while False: + x = 2 + break + x = 3 +else: + x = 4 + +reveal_type(x) # revealed: Literal[4] +``` + +#### `while True` + +```py +while True: + x = 1 + break +else: + x = 2 + +reveal_type(x) # revealed: Literal[1] +``` + +## `match` statements + +```toml +[environment] +python-version = "3.10" +``` + +### Single-valued types, always true + +```py +x = 1 + +match "a": + case "a": + x = 2 + case "b": + x = 3 + +reveal_type(x) # revealed: Literal[2] +``` + +### Single-valued types, always true, with wildcard pattern + +```py +x = 1 + +match "a": + case "a": + x = 2 + case "b": + x = 3 + case _: + pass + +reveal_type(x) # revealed: Literal[2] +``` + +### Single-valued types, always true, with guard + +Make sure we don't infer a static truthiness in case there is a case guard: + +```py +def flag() -> bool: + return True + +x = 1 + +match "a": + case "a" if flag(): + x = 2 + case "b": + x = 3 + case _: + pass + +reveal_type(x) # revealed: Literal[1, 2] +``` + +### Single-valued types, always false + +```py +x = 1 + +match "something else": + case "a": + x = 2 + case "b": + x = 3 + +reveal_type(x) # revealed: Literal[1] +``` + +### Single-valued types, always false, with wildcard pattern + +```py +x = 1 + +match "something else": + case "a": + x = 2 + case "b": + x = 3 + case _: + pass + +reveal_type(x) # revealed: Literal[1] +``` + +### Single-valued types, always false, with guard + +For definitely-false cases, the presence of a guard has no influence: + +```py +def flag() -> bool: + return True + +x = 1 + +match "something else": + case "a" if flag(): + x = 2 + case "b": + x = 3 + case _: + pass + +reveal_type(x) # revealed: Literal[1] +``` + +### Non-single-valued types + +```py +def _(s: str): + match s: + case "a": + x = 1 + case "b": + x = 2 + case _: + x = 3 + + reveal_type(x) # revealed: Literal[1, 2, 3] +``` + +### Matching on `sys.platform` + +```toml +[environment] +python-platform = "darwin" +python-version = "3.10" +``` + +```py +import sys + +match sys.platform: + case "linux": + linux = True + case "darwin": + darwin = True + case "win32": + win32 = True + case _: + other = True + +# error: [unresolved-reference] +linux + +# no error +darwin + +# error: [unresolved-reference] +win32 + +# error: [unresolved-reference] +other +``` + +### Matching on `sys.version_info` + +```toml +[environment] +python-version = "3.13" +``` + +```py +import sys + +minor = "too old" + +match sys.version_info.minor: + case 12: + minor = 12 + case 13: + minor = 13 + case _: + pass + +reveal_type(minor) # revealed: Literal[13] +``` + +## Conditional declarations + +### Always false + +#### `if False` + +```py +x: str + +if False: + x: int + +def f() -> None: + reveal_type(x) # revealed: str +``` + +#### `if True … else` + +```py +x: str + +if True: + pass +else: + x: int + +def f() -> None: + reveal_type(x) # revealed: str +``` + +### Always true + +#### `if True` + +```py +x: str + +if True: + x: int + +def f() -> None: + reveal_type(x) # revealed: int +``` + +#### `if False … else` + +```py +x: str + +if False: + pass +else: + x: int + +def f() -> None: + reveal_type(x) # revealed: int +``` + +### Ambiguous + +```py +def flag() -> bool: + return True + +x: str + +if flag(): + x: int + +def f() -> None: + reveal_type(x) # revealed: str | int +``` + +## Conditional function definitions + +```py +def f() -> int: + return 1 + +def g() -> int: + return 1 + +if True: + def f() -> str: + return "" + +else: + def g() -> str: + return "" + +reveal_type(f()) # revealed: str +reveal_type(g()) # revealed: int +``` + +## Conditional class definitions + +```py +if True: + class C: + x: int = 1 + +else: + class C: + x: str = "a" + +reveal_type(C.x) # revealed: int +``` + +## Conditional class attributes + +```py +class C: + if True: + x: int = 1 + else: + x: str = "a" + +reveal_type(C.x) # revealed: int +``` + +## (Un)boundness + +### Unbound, `if False` + +```py +if False: + x = 1 + +# error: [unresolved-reference] +x +``` + +### Unbound, `if True … else` + +```py +if True: + pass +else: + x = 1 + +# error: [unresolved-reference] +x +``` + +### Bound, `if True` + +```py +if True: + x = 1 + +# x is always bound, no error +x +``` + +### Bound, `if False … else` + +```py +if False: + pass +else: + x = 1 + +# x is always bound, no error +x +``` + +### Ambiguous, possibly unbound + +For comparison, we still detect definitions inside non-statically known branches as possibly +unbound: + +```py +def flag() -> bool: + return True + +if flag(): + x = 1 + +# error: [possibly-unresolved-reference] +x +``` + +### Nested conditionals + +```py +def flag() -> bool: + return True + +if False: + if True: + unbound1 = 1 + +if True: + if False: + unbound2 = 1 + +if False: + if False: + unbound3 = 1 + +if False: + if flag(): + unbound4 = 1 + +if flag(): + if False: + unbound5 = 1 + +# error: [unresolved-reference] +# error: [unresolved-reference] +# error: [unresolved-reference] +# error: [unresolved-reference] +# error: [unresolved-reference] +(unbound1, unbound2, unbound3, unbound4, unbound5) +``` + +### Chained conditionals + +```py +if False: + x = 1 +if True: + x = 2 + +# x is always bound, no error +x + +if False: + y = 1 +if True: + y = 2 + +# y is always bound, no error +y + +if False: + z = 1 +if False: + z = 2 + +# z is never bound: +# error: [unresolved-reference] +z +``` + +### Public boundness + +```py +if True: + x = 1 + +def f(): + # x is always bound, no error + x +``` + +### Imports of conditionally defined symbols + +#### Always false, unbound + +`module.py`: + +```py +if False: + symbol = 1 +``` + +```py +# error: [unresolved-import] +from module import symbol +``` + +#### Always true, bound + +`module.py`: + +```py +if True: + symbol = 1 +``` + +```py +# no error +from module import symbol +``` + +#### Ambiguous, possibly unbound + +`module.py`: + +```py +def flag() -> bool: + return True + +if flag(): + symbol = 1 +``` + +```py +# error: [possibly-unbound-import] +from module import symbol +``` + +#### Always false, undeclared + +`module.py`: + +```py +if False: + symbol: int +``` + +```py +# error: [unresolved-import] +from module import symbol + +reveal_type(symbol) # revealed: Unknown +``` + +#### Always true, declared + +`module.py`: + +```py +if True: + symbol: int +``` + +```py +# no error +from module import symbol +``` + +## Unreachable code + +A closely related feature is the ability to detect unreachable code. For example, we do not emit a +diagnostic here: + +```py +if False: + x +``` + +See [unreachable.md](unreachable.md) for more tests on this topic. diff --git a/crates/ty_python_semantic/resources/mdtest/stubs/class.md b/crates/ty_python_semantic/resources/mdtest/stubs/class.md new file mode 100644 index 0000000000000..64fe0bf48d114 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/stubs/class.md @@ -0,0 +1,47 @@ +# Class definitions in stubs + +## Cyclical class definition + +```toml +[environment] +python-version = "3.12" +``` + +In type stubs, classes can reference themselves in their base class definitions. For example, in +`typeshed`, we have `class str(Sequence[str]): ...`. + +```pyi +class Foo[T]: ... + +class Bar(Foo[Bar]): ... + +reveal_type(Bar) # revealed: <class 'Bar'> +reveal_type(Bar.__mro__) # revealed: tuple[<class 'Bar'>, <class 'Foo[Bar]'>, <class 'object'>] +``` + +## Access to attributes declared in stubs + +Unlike regular Python modules, stub files often omit the right-hand side in declarations, including +in class scope. However, from the perspective of the type checker, we have to treat them as bindings +too. That is, `symbol: type` is the same as `symbol: type = ...`. + +One implication of this is that we'll always treat symbols in class scope as safe to be accessed +from the class object itself. We'll never infer a "pure instance attribute" from a stub. + +`b.pyi`: + +```pyi +from typing import ClassVar + +class C: + class_or_instance_var: int +``` + +```py +from typing import ClassVar, Literal + +from b import C + +# No error here, since we treat `class_or_instance_var` as bound on the class. +reveal_type(C.class_or_instance_var) # revealed: int +``` diff --git a/crates/ty_python_semantic/resources/mdtest/stubs/ellipsis.md b/crates/ty_python_semantic/resources/mdtest/stubs/ellipsis.md new file mode 100644 index 0000000000000..6b147fca578d1 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/stubs/ellipsis.md @@ -0,0 +1,78 @@ +# Ellipsis + +## Function and methods + +The ellipsis literal `...` can be used as a placeholder default value for a function parameter, in a +stub file only, regardless of the type of the parameter. + +```pyi +def f(x: int = ...) -> None: + reveal_type(x) # revealed: int + +def f2(x: str = ...) -> None: + reveal_type(x) # revealed: str +``` + +## Class and module symbols + +The ellipsis literal can be assigned to a class or module symbol, regardless of its declared type, +in a stub file only. + +```pyi +y: bytes = ... +reveal_type(y) # revealed: bytes +x = ... +reveal_type(x) # revealed: Unknown + +class Foo: + y: int = ... + +reveal_type(Foo.y) # revealed: int +``` + +## Unpacking ellipsis literal in assignment + +No diagnostic is emitted if an ellipsis literal is "unpacked" in a stub file as part of an +assignment statement: + +```pyi +x, y = ... +reveal_type(x) # revealed: Unknown +reveal_type(y) # revealed: Unknown +``` + +## Unpacking ellipsis literal in for loops + +Iterating over an ellipsis literal as part of a `for` loop in a stub is invalid, however, and +results in a diagnostic: + +```pyi +# error: [not-iterable] "Object of type `ellipsis` is not iterable" +for a, b in ...: + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown +``` + +## Ellipsis usage in non stub file + +In a non-stub file, there's no special treatment of ellipsis literals. An ellipsis literal can only +be assigned if `EllipsisType` is actually assignable to the annotated type. + +```py +# error: 7 [invalid-parameter-default] "Default value of type `ellipsis` is not assignable to annotated parameter type `int`" +def f(x: int = ...) -> None: ... + +# error: 1 [invalid-assignment] "Object of type `ellipsis` is not assignable to `int`" +a: int = ... +b = ... +reveal_type(b) # revealed: ellipsis +``` + +## Use of `Ellipsis` symbol + +There is no special treatment of the builtin name `Ellipsis` in stubs, only of `...` literals. + +```pyi +# error: 7 [invalid-parameter-default] "Default value of type `ellipsis` is not assignable to annotated parameter type `int`" +def f(x: int = Ellipsis) -> None: ... +``` diff --git a/crates/ty_python_semantic/resources/mdtest/stubs/locals.md b/crates/ty_python_semantic/resources/mdtest/stubs/locals.md new file mode 100644 index 0000000000000..9852f683acb7c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/stubs/locals.md @@ -0,0 +1,17 @@ +# Declarations in stubs + +Unlike regular Python modules, stub files often declare module-global variables without initializing +them. If these symbols are then used in the same stub, applying regular logic would lead to an +undefined variable access error. + +However, from the perspective of the type checker, we should treat something like `symbol: type` the +same as `symbol: type = ...`. In other words, assume these are bindings too. + +```pyi +from typing import Literal + +CONSTANT: Literal[42] + +# No error here, even though the variable is not initialized. +uses_constant: int = CONSTANT +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/bytes.md b/crates/ty_python_semantic/resources/mdtest/subscript/bytes.md new file mode 100644 index 0000000000000..1939318c20632 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/bytes.md @@ -0,0 +1,50 @@ +# Bytes subscripts + +## Indexing + +```py +b = b"\x00abc\xff" + +reveal_type(b[0]) # revealed: Literal[0] +reveal_type(b[1]) # revealed: Literal[97] +reveal_type(b[4]) # revealed: Literal[255] + +reveal_type(b[-1]) # revealed: Literal[255] +reveal_type(b[-2]) # revealed: Literal[99] +reveal_type(b[-5]) # revealed: Literal[0] + +reveal_type(b[False]) # revealed: Literal[0] +reveal_type(b[True]) # revealed: Literal[97] + +x = b[5] # error: [index-out-of-bounds] "Index 5 is out of bounds for bytes literal `Literal[b"\x00abc\xff"]` with length 5" +reveal_type(x) # revealed: Unknown + +y = b[-6] # error: [index-out-of-bounds] "Index -6 is out of bounds for bytes literal `Literal[b"\x00abc\xff"]` with length 5" +reveal_type(y) # revealed: Unknown + +def _(n: int): + a = b"abcde"[n] + reveal_type(a) # revealed: int +``` + +## Slices + +```py +b: bytes = b"\x00abc\xff" + +reveal_type(b[0:2]) # revealed: Literal[b"\x00a"] +reveal_type(b[-3:]) # revealed: Literal[b"bc\xff"] + +b[0:4:0] # error: [zero-stepsize-in-slice] +b[:4:0] # error: [zero-stepsize-in-slice] +b[0::0] # error: [zero-stepsize-in-slice] +b[::0] # error: [zero-stepsize-in-slice] + +def _(m: int, n: int): + byte_slice1 = b[m:n] + reveal_type(byte_slice1) # revealed: bytes + +def _(s: bytes) -> bytes: + byte_slice2 = s[0:5] + return reveal_type(byte_slice2) # revealed: bytes +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/class.md b/crates/ty_python_semantic/resources/mdtest/subscript/class.md new file mode 100644 index 0000000000000..ca6f364cdd707 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/class.md @@ -0,0 +1,87 @@ +# Class subscript + +## Class getitem unbound + +```py +class NotSubscriptable: ... + +# error: "Cannot subscript object of type `<class 'NotSubscriptable'>` with no `__class_getitem__` method" +a = NotSubscriptable[0] +``` + +## Class getitem + +```py +class Identity: + def __class_getitem__(cls, item: int) -> str: + return str(item) + +reveal_type(Identity[0]) # revealed: str +``` + +## Class getitem union + +```py +def _(flag: bool): + class UnionClassGetItem: + if flag: + def __class_getitem__(cls, item: int) -> str: + return str(item) + else: + def __class_getitem__(cls, item: int) -> int: + return item + + reveal_type(UnionClassGetItem[0]) # revealed: str | int +``` + +## Class getitem with class union + +```py +def _(flag: bool): + class A: + def __class_getitem__(cls, item: int) -> str: + return str(item) + + class B: + def __class_getitem__(cls, item: int) -> int: + return item + + x = A if flag else B + + reveal_type(x) # revealed: <class 'A'> | <class 'B'> + reveal_type(x[0]) # revealed: str | int +``` + +## Class getitem with unbound method union + +```py +def _(flag: bool): + if flag: + class Spam: + def __class_getitem__(self, x: int) -> str: + return "foo" + + else: + class Spam: ... + # error: [call-possibly-unbound-method] "Method `__class_getitem__` of type `<class 'Spam'> | <class 'Spam'>` is possibly unbound" + # revealed: str + reveal_type(Spam[42]) +``` + +## TODO: Class getitem non-class union + +```py +def _(flag: bool): + if flag: + class Eggs: + def __class_getitem__(self, x: int) -> str: + return "foo" + + else: + Eggs = 1 + + a = Eggs[42] # error: "Cannot subscript object of type `<class 'Eggs'> | Literal[1]` with no `__getitem__` method" + + # TODO: should _probably_ emit `str | Unknown` + reveal_type(a) # revealed: Unknown +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/instance.md b/crates/ty_python_semantic/resources/mdtest/subscript/instance.md new file mode 100644 index 0000000000000..19a4aac66e509 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/instance.md @@ -0,0 +1,44 @@ +# Instance subscript + +## Getitem unbound + +```py +class NotSubscriptable: ... + +a = NotSubscriptable()[0] # error: "Cannot subscript object of type `NotSubscriptable` with no `__getitem__` method" +``` + +## Getitem not callable + +```py +class NotSubscriptable: + __getitem__ = None + +# error: "Method `__getitem__` of type `Unknown | None` is not callable on object of type `NotSubscriptable`" +a = NotSubscriptable()[0] +``` + +## Valid getitem + +```py +class Identity: + def __getitem__(self, index: int) -> int: + return index + +reveal_type(Identity()[0]) # revealed: int +``` + +## Getitem union + +```py +def _(flag: bool): + class Identity: + if flag: + def __getitem__(self, index: int) -> int: + return index + else: + def __getitem__(self, index: int) -> str: + return str(index) + + reveal_type(Identity()[0]) # revealed: int | str +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/lists.md b/crates/ty_python_semantic/resources/mdtest/subscript/lists.md new file mode 100644 index 0000000000000..dff1905d0d9de --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/lists.md @@ -0,0 +1,39 @@ +# List subscripts + +## Indexing into lists + +A list can be indexed into with: + +- numbers +- slices + +```py +x = [1, 2, 3] +reveal_type(x) # revealed: list[Unknown] + +# TODO reveal int +reveal_type(x[0]) # revealed: Unknown + +# TODO reveal list[int] +reveal_type(x[0:1]) # revealed: list[Unknown] + +# error: [call-non-callable] +reveal_type(x["a"]) # revealed: Unknown +``` + +## Assignments within list assignment + +In assignment, we might also have a named assignment. This should also get type checked. + +```py +x = [1, 2, 3] +x[0 if (y := 2) else 1] = 5 + +# TODO: better error than "method `__getitem__` not callable on type `list`" +# error: [call-non-callable] +x["a" if (y := 2) else 1] = 6 + +# TODO: better error than "method `__getitem__` not callable on type `list`" +# error: [call-non-callable] +x["a" if (y := 2) else "b"] = 6 +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/stepsize_zero.md b/crates/ty_python_semantic/resources/mdtest/subscript/stepsize_zero.md new file mode 100644 index 0000000000000..2d574a6aacc13 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/stepsize_zero.md @@ -0,0 +1,13 @@ +# Stepsize zero in slices + +We raise a `zero-stepsize-in-slice` diagnostic when trying to slice a literal string, bytes, or +tuple with a step size of zero (see tests in `string.md`, `bytes.md` and `tuple.md`). But we don't +want to raise this diagnostic when slicing a custom type: + +```py +class MySequence: + def __getitem__(self, s: slice) -> int: + return 0 + +MySequence()[0:1:0] # No error +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/string.md b/crates/ty_python_semantic/resources/mdtest/subscript/string.md new file mode 100644 index 0000000000000..469300c0b4eda --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/string.md @@ -0,0 +1,92 @@ +# String subscripts + +## Indexing + +```py +s = "abcde" + +reveal_type(s[0]) # revealed: Literal["a"] +reveal_type(s[1]) # revealed: Literal["b"] +reveal_type(s[-1]) # revealed: Literal["e"] +reveal_type(s[-2]) # revealed: Literal["d"] + +reveal_type(s[False]) # revealed: Literal["a"] +reveal_type(s[True]) # revealed: Literal["b"] + +a = s[8] # error: [index-out-of-bounds] "Index 8 is out of bounds for string `Literal["abcde"]` with length 5" +reveal_type(a) # revealed: Unknown + +b = s[-8] # error: [index-out-of-bounds] "Index -8 is out of bounds for string `Literal["abcde"]` with length 5" +reveal_type(b) # revealed: Unknown + +def _(n: int): + a = "abcde"[n] + reveal_type(a) # revealed: LiteralString +``` + +## Slices + +```py +def _(m: int, n: int, s2: str): + s = "abcde" + + reveal_type(s[0:0]) # revealed: Literal[""] + reveal_type(s[0:1]) # revealed: Literal["a"] + reveal_type(s[0:2]) # revealed: Literal["ab"] + reveal_type(s[0:5]) # revealed: Literal["abcde"] + reveal_type(s[0:6]) # revealed: Literal["abcde"] + reveal_type(s[1:3]) # revealed: Literal["bc"] + + reveal_type(s[-3:5]) # revealed: Literal["cde"] + reveal_type(s[-4:-2]) # revealed: Literal["bc"] + reveal_type(s[-10:10]) # revealed: Literal["abcde"] + + reveal_type(s[0:]) # revealed: Literal["abcde"] + reveal_type(s[2:]) # revealed: Literal["cde"] + reveal_type(s[5:]) # revealed: Literal[""] + reveal_type(s[:2]) # revealed: Literal["ab"] + reveal_type(s[:0]) # revealed: Literal[""] + reveal_type(s[:2]) # revealed: Literal["ab"] + reveal_type(s[:10]) # revealed: Literal["abcde"] + reveal_type(s[:]) # revealed: Literal["abcde"] + + reveal_type(s[::-1]) # revealed: Literal["edcba"] + reveal_type(s[::2]) # revealed: Literal["ace"] + reveal_type(s[-2:-5:-1]) # revealed: Literal["dcb"] + reveal_type(s[::-2]) # revealed: Literal["eca"] + reveal_type(s[-1::-3]) # revealed: Literal["eb"] + + reveal_type(s[None:2:None]) # revealed: Literal["ab"] + reveal_type(s[1:None:1]) # revealed: Literal["bcde"] + reveal_type(s[None:None:None]) # revealed: Literal["abcde"] + + start = 1 + stop = None + step = 2 + reveal_type(s[start:stop:step]) # revealed: Literal["bd"] + + reveal_type(s[False:True]) # revealed: Literal["a"] + reveal_type(s[True:3]) # revealed: Literal["bc"] + + s[0:4:0] # error: [zero-stepsize-in-slice] + s[:4:0] # error: [zero-stepsize-in-slice] + s[0::0] # error: [zero-stepsize-in-slice] + s[::0] # error: [zero-stepsize-in-slice] + + substring1 = s[m:n] + reveal_type(substring1) # revealed: LiteralString + + substring2 = s2[0:5] + reveal_type(substring2) # revealed: str +``` + +## Unsupported slice types + +```py +# TODO: It would be great if we raised an error here. This can be done once +# we have support for overloads and generics, and once typeshed has a more +# precise annotation for `str.__getitem__`, that makes use of the generic +# `slice[..]` type. We could then infer `slice[str, str]` here and see that +# it doesn't match the signature of `str.__getitem__`. +"foo"["bar":"baz"] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/subscript/tuple.md b/crates/ty_python_semantic/resources/mdtest/subscript/tuple.md new file mode 100644 index 0000000000000..fbd4434d025bf --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/subscript/tuple.md @@ -0,0 +1,119 @@ +# Tuple subscripts + +## Indexing + +```py +t = (1, "a", "b") + +reveal_type(t[0]) # revealed: Literal[1] +reveal_type(t[1]) # revealed: Literal["a"] +reveal_type(t[-1]) # revealed: Literal["b"] +reveal_type(t[-2]) # revealed: Literal["a"] + +reveal_type(t[False]) # revealed: Literal[1] +reveal_type(t[True]) # revealed: Literal["a"] + +a = t[4] # error: [index-out-of-bounds] +reveal_type(a) # revealed: Unknown + +b = t[-4] # error: [index-out-of-bounds] +reveal_type(b) # revealed: Unknown +``` + +## Slices + +```py +def _(m: int, n: int): + t = (1, "a", None, b"b") + + reveal_type(t[0:0]) # revealed: tuple[()] + reveal_type(t[0:1]) # revealed: tuple[Literal[1]] + reveal_type(t[0:2]) # revealed: tuple[Literal[1], Literal["a"]] + reveal_type(t[0:4]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + reveal_type(t[0:5]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + reveal_type(t[1:3]) # revealed: tuple[Literal["a"], None] + + reveal_type(t[-2:4]) # revealed: tuple[None, Literal[b"b"]] + reveal_type(t[-3:-1]) # revealed: tuple[Literal["a"], None] + reveal_type(t[-10:10]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + + reveal_type(t[0:]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + reveal_type(t[2:]) # revealed: tuple[None, Literal[b"b"]] + reveal_type(t[4:]) # revealed: tuple[()] + reveal_type(t[:0]) # revealed: tuple[()] + reveal_type(t[:2]) # revealed: tuple[Literal[1], Literal["a"]] + reveal_type(t[:10]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + reveal_type(t[:]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + + reveal_type(t[::-1]) # revealed: tuple[Literal[b"b"], None, Literal["a"], Literal[1]] + reveal_type(t[::2]) # revealed: tuple[Literal[1], None] + reveal_type(t[-2:-5:-1]) # revealed: tuple[None, Literal["a"], Literal[1]] + reveal_type(t[::-2]) # revealed: tuple[Literal[b"b"], Literal["a"]] + reveal_type(t[-1::-3]) # revealed: tuple[Literal[b"b"], Literal[1]] + + reveal_type(t[None:2:None]) # revealed: tuple[Literal[1], Literal["a"]] + reveal_type(t[1:None:1]) # revealed: tuple[Literal["a"], None, Literal[b"b"]] + reveal_type(t[None:None:None]) # revealed: tuple[Literal[1], Literal["a"], None, Literal[b"b"]] + + start = 1 + stop = None + step = 2 + reveal_type(t[start:stop:step]) # revealed: tuple[Literal["a"], Literal[b"b"]] + + reveal_type(t[False:True]) # revealed: tuple[Literal[1]] + reveal_type(t[True:3]) # revealed: tuple[Literal["a"], None] + + t[0:4:0] # error: [zero-stepsize-in-slice] + t[:4:0] # error: [zero-stepsize-in-slice] + t[0::0] # error: [zero-stepsize-in-slice] + t[::0] # error: [zero-stepsize-in-slice] + + tuple_slice = t[m:n] + # TODO: Should be `tuple[Literal[1, 'a', b"b"] | None, ...]` + reveal_type(tuple_slice) # revealed: tuple[Unknown, ...] +``` + +## Inheritance + +```toml +[environment] +python-version = "3.9" +``` + +```py +class A(tuple[int, str]): ... + +# revealed: tuple[<class 'A'>, <class 'tuple[@Todo(Generic tuple specializations), ...]'>, <class 'Sequence[@Todo(Generic tuple specializations)]'>, <class 'Reversible[@Todo(Generic tuple specializations)]'>, <class 'Collection[@Todo(Generic tuple specializations)]'>, <class 'Iterable[@Todo(Generic tuple specializations)]'>, <class 'Container[@Todo(Generic tuple specializations)]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(A.__mro__) +``` + +## `typing.Tuple` + +### Correspondence with `tuple` + +`typing.Tuple` can be used interchangeably with `tuple`: + +```py +from typing import Any, Tuple + +class A: ... + +def _(c: Tuple, d: Tuple[int, A], e: Tuple[Any, ...]): + reveal_type(c) # revealed: tuple[Unknown, ...] + reveal_type(d) # revealed: tuple[int, A] + reveal_type(e) # revealed: tuple[Any, ...] +``` + +### Inheritance + +Inheriting from `Tuple` results in a MRO with `builtins.tuple` and `typing.Generic`. `Tuple` itself +is not a class. + +```py +from typing import Tuple + +class C(Tuple): ... + +# revealed: tuple[<class 'C'>, <class 'tuple[Unknown, ...]'>, <class 'Sequence[Unknown]'>, <class 'Reversible[Unknown]'>, <class 'Collection[Unknown]'>, <class 'Iterable[Unknown]'>, <class 'Container[Unknown]'>, typing.Protocol[_T_co], typing.Generic[_T_co], <class 'object'>] +reveal_type(C.__mro__) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/suppressions/no_type_check.md b/crates/ty_python_semantic/resources/mdtest/suppressions/no_type_check.md new file mode 100644 index 0000000000000..37e32020613a7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/suppressions/no_type_check.md @@ -0,0 +1,122 @@ +# `@no_type_check` + +> If a type checker supports the `no_type_check` decorator for functions, it should suppress all +> type errors for the def statement and its body including any nested functions or classes. It +> should also ignore all parameter and return type annotations and treat the function as if it were +> unannotated. [source](https://typing.python.org/en/latest/spec/directives.html#no-type-check) + +## Error in the function body + +```py +from typing import no_type_check + +@no_type_check +def test() -> int: + return a + 5 +``` + +## Error in nested function + +```py +from typing import no_type_check + +@no_type_check +def test() -> int: + def nested(): + return a + 5 +``` + +## Error in nested class + +```py +from typing import no_type_check + +@no_type_check +def test() -> int: + class Nested: + def inner(self): + return a + 5 +``` + +## Error in preceding decorator + +Don't suppress diagnostics for decorators appearing before the `no_type_check` decorator. + +```py +from typing import no_type_check + +@unknown_decorator # error: [unresolved-reference] +@no_type_check +def test() -> int: + # TODO: this should not be an error + # error: [unresolved-reference] + return a + 5 +``` + +## Error in following decorator + +Unlike Pyright and mypy, suppress diagnostics appearing after the `no_type_check` decorator. We do +this because it more closely matches Python's runtime semantics of decorators. For more details, see +the discussion on the +[PR adding `@no_type_check` support](https://github.com/astral-sh/ruff/pull/15122#discussion_r1896869411). + +```py +from typing import no_type_check + +@no_type_check +@unknown_decorator +def test() -> int: + # TODO: this should not be an error + # error: [unresolved-reference] + return a + 5 +``` + +## Error in default value + +```py +from typing import no_type_check + +@no_type_check +def test(a: int = "test"): + return x + 5 +``` + +## Error in return value position + +```py +from typing import no_type_check + +@no_type_check +def test() -> Undefined: + return x + 5 +``` + +## `no_type_check` on classes isn't supported + +ty does not support decorating classes with `no_type_check`. The behaviour of `no_type_check` when +applied to classes is +[not specified currently](https://typing.python.org/en/latest/spec/directives.html#no-type-check), +and is not supported by Pyright or mypy. + +A future improvement might be to emit a diagnostic if a `no_type_check` annotation is applied to a +class. + +```py +from typing import no_type_check + +@no_type_check +class Test: + def test(self): + return a + 5 # error: [unresolved-reference] +``` + +## `type: ignore` comments in `@no_type_check` blocks + +```py +from typing import no_type_check + +@no_type_check +def test(): + # error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'unresolved-reference'" + return x + 5 # ty: ignore[unresolved-reference] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/suppressions/ty_ignore.md b/crates/ty_python_semantic/resources/mdtest/suppressions/ty_ignore.md new file mode 100644 index 0000000000000..9a1930f015684 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/suppressions/ty_ignore.md @@ -0,0 +1,191 @@ +# Suppressing errors with `ty: ignore` + +Type check errors can be suppressed by a `ty: ignore` comment on the same line as the violation. + +## Simple `ty: ignore` + +```py +a = 4 + test # ty: ignore +``` + +## Suppressing a specific code + +```py +a = 4 + test # ty: ignore[unresolved-reference] +``` + +## Unused suppression + +```py +test = 10 +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'possibly-unresolved-reference'" +a = test + 3 # ty: ignore[possibly-unresolved-reference] +``` + +## Unused suppression if the error codes don't match + +```py +# error: [unresolved-reference] +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'possibly-unresolved-reference'" +a = test + 3 # ty: ignore[possibly-unresolved-reference] +``` + +## Suppressed unused comment + +```py +# error: [unused-ignore-comment] +a = 10 / 2 # ty: ignore[division-by-zero] +a = 10 / 2 # ty: ignore[division-by-zero, unused-ignore-comment] +a = 10 / 2 # ty: ignore[unused-ignore-comment, division-by-zero] +a = 10 / 2 # ty: ignore[unused-ignore-comment] # type: ignore +a = 10 / 2 # type: ignore # ty: ignore[unused-ignore-comment] +``` + +## Unused ignore comment + +```py +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'unused-ignore-comment'" +a = 10 / 0 # ty: ignore[division-by-zero, unused-ignore-comment] +``` + +## Multiple unused comments + +Today, ty emits a diagnostic for every unused code. We might want to group the codes by comment at +some point in the future. + +```py +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'division-by-zero'" +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'unresolved-reference'" +a = 10 / 2 # ty: ignore[division-by-zero, unresolved-reference] + +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'invalid-assignment'" +# error: [unused-ignore-comment] "Unused `ty: ignore` directive: 'unresolved-reference'" +a = 10 / 0 # ty: ignore[invalid-assignment, division-by-zero, unresolved-reference] +``` + +## Multiple suppressions + +```py +# fmt: off +def test(a: f"f-string type annotation", b: b"byte-string-type-annotation"): ... # ty: ignore[fstring-type-annotation, byte-string-type-annotation] +``` + +## Can't suppress syntax errors + +<!-- blacken-docs:off --> + +```py +# error: [invalid-syntax] +# error: [unused-ignore-comment] +def test($): # ty: ignore + pass +``` + +<!-- blacken-docs:on --> + +## Can't suppress `revealed-type` diagnostics + +```py +a = 10 +# revealed: Literal[10] +# error: [unknown-rule] "Unknown rule `revealed-type`" +reveal_type(a) # ty: ignore[revealed-type] +``` + +## Extra whitespace in type ignore comments is allowed + +```py +a = 10 / 0 # ty : ignore +a = 10 / 0 # ty: ignore [ division-by-zero ] +``` + +## Whitespace is optional + +```py +# fmt: off +a = 10 / 0 #ty:ignore[division-by-zero] +``` + +## Trailing codes comma + +Trailing commas in the codes section are allowed: + +```py +a = 10 / 0 # ty: ignore[division-by-zero,] +``` + +## Invalid characters in codes + +```py +# error: [division-by-zero] +# error: [invalid-ignore-comment] "Invalid `ty: ignore` comment: expected a alphanumeric character or `-` or `_` as code" +a = 10 / 0 # ty: ignore[*-*] +``` + +## Trailing whitespace + +<!-- blacken-docs:off --> + +```py +a = 10 / 0 # ty: ignore[division-by-zero] + # ^^^^^^ trailing whitespace +``` + +<!-- blacken-docs:on --> + +## Missing comma + +A missing comma results in an invalid suppression comment. We may want to recover from this in the +future. + +```py +# error: [unresolved-reference] +# error: [invalid-ignore-comment] "Invalid `ty: ignore` comment: expected a comma separating the rule codes" +a = x / 0 # ty: ignore[division-by-zero unresolved-reference] +``` + +## Missing closing bracket + +```py +# error: [unresolved-reference] "Name `x` used when not defined" +# error: [invalid-ignore-comment] "Invalid `ty: ignore` comment: expected a comma separating the rule codes" +a = x / 2 # ty: ignore[unresolved-reference +``` + +## Empty codes + +An empty codes array suppresses no-diagnostics and is always useless + +```py +# error: [division-by-zero] +# error: [unused-ignore-comment] "Unused `ty: ignore` without a code" +a = 4 / 0 # ty: ignore[] +``` + +## File-level suppression comments + +File level suppression comments are currently intentionally unsupported because we've yet to decide +if they should use a different syntax that also supports enabling rules or changing the rule's +severity: `ty: possibly-undefined-reference=error` + +```py +# error: [unused-ignore-comment] +# ty: ignore[division-by-zero] + +a = 4 / 0 # error: [division-by-zero] +``` + +## Unknown rule + +```py +# error: [unknown-rule] "Unknown rule `is-equal-14`" +a = 10 + 4 # ty: ignore[is-equal-14] +``` + +## Code with `lint:` prefix + +```py +# error:[unknown-rule] "Unknown rule `lint:division-by-zero`. Did you mean `division-by-zero`?" +# error: [division-by-zero] +a = 10 / 0 # ty: ignore[lint:division-by-zero] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/suppressions/type_ignore.md b/crates/ty_python_semantic/resources/mdtest/suppressions/type_ignore.md new file mode 100644 index 0000000000000..43e9eedcc22fd --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/suppressions/type_ignore.md @@ -0,0 +1,161 @@ +# Suppressing errors with `type: ignore` + +Type check errors can be suppressed by a `type: ignore` comment on the same line as the violation. + +## Simple `type: ignore` + +```py +a = 4 + test # type: ignore +``` + +## Multiline ranges + +A diagnostic with a multiline range can be suppressed by a comment on the same line as the +diagnostic's start or end. This is the same behavior as Mypy's. + +```py +# fmt: off +y = ( + 4 / 0 # type: ignore +) + +y = ( + 4 / # type: ignore + 0 +) + +y = ( + 4 / + 0 # type: ignore +) +``` + +Pyright diverges from this behavior and instead applies a suppression if its range intersects with +the diagnostic range. This can be problematic for nested expressions because a suppression in a +child expression now suppresses errors in the outer expression. + +For example, the `type: ignore` comment in this example suppresses the error of adding `2` to +`"test"` and adding `"other"` to the result of the cast. + +```py +from typing import cast + +y = ( + # error: [unsupported-operator] + cast( + int, + 2 + "test", # type: ignore + ) + + "other" +) +``` + +Mypy flags the second usage. + +## Before opening parenthesis + +A suppression that applies to all errors before the opening parenthesis. + +```py +a: Test = ( # type: ignore + Test() # error: [unresolved-reference] +) # fmt: skip +``` + +## Multiline string + +```py +a: int = 4 +a = """ + This is a multiline string and the suppression is at its end +""" # type: ignore +``` + +## Line continuations + +Suppressions after a line continuation apply to all previous lines. + +```py +# fmt: off +a = test \ + + 2 # type: ignore + +a = test \ + + a \ + + 2 # type: ignore +``` + +## Codes + +Mypy supports `type: ignore[code]`. ty doesn't understand mypy's rule names. Therefore, ignore the +codes and suppress all errors. + +```py +a = test # type: ignore[name-defined] +``` + +## Nested comments + +```py +# fmt: off +a = test \ + + 2 # fmt: skip # type: ignore + +a = test \ + + 2 # type: ignore # fmt: skip +``` + +## Misspelled `type: ignore` + +```py +# error: [unresolved-reference] +# error: [invalid-ignore-comment] +a = test + 2 # type: ignoree +``` + +## Invalid - ignore on opening parentheses + +`type: ignore` comments after an opening parentheses suppress any type errors inside the parentheses +in Pyright. Neither Ruff, nor mypy support this and neither does ty. + +```py +# fmt: off +# error: [unused-ignore-comment] +a = ( # type: ignore + test + 4 # error: [unresolved-reference] +) +``` + +## File level suppression + +```py +# type: ignore + +a = 10 / 0 +b = a / 0 +``` + +## File level suppression with leading shebang + +```py +#!/usr/bin/env/python +# type: ignore + +a = 10 / 0 +b = a / 0 +``` + +## Invalid own-line suppression + +```py +""" +File level suppressions must come before any non-trivia token, +including module docstrings. +""" + +# error: [unused-ignore-comment] "Unused blanket `type: ignore` directive" +# type: ignore + +a = 10 / 0 # error: [division-by-zero] +b = a / 0 # error: [division-by-zero] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/sys_platform.md b/crates/ty_python_semantic/resources/mdtest/sys_platform.md new file mode 100644 index 0000000000000..3997cbb28bd79 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/sys_platform.md @@ -0,0 +1,58 @@ +# `sys.platform` + +## Explicit selection of `all` platforms + +When `python-platform="all"` is specified, we fall back to the type of `sys.platform` declared in +typeshed: + +```toml +[environment] +python-platform = "all" +``` + +```py +import sys + +reveal_type(sys.platform) # revealed: LiteralString +``` + +## Explicit selection of a specific platform + +```toml +[environment] +python-platform = "linux" +``` + +```py +import sys + +reveal_type(sys.platform) # revealed: Literal["linux"] +``` + +## Testing for a specific platform + +```toml +[environment] +python-platform = "freebsd8" +``` + +### Exact comparison + +```py +import sys + +reveal_type(sys.platform == "freebsd8") # revealed: Literal[True] +reveal_type(sys.platform == "linux") # revealed: Literal[False] +``` + +### Substring comparison + +It is [recommended](https://docs.python.org/3/library/sys.html#sys.platform) to use +`sys.platform.startswith(...)` for platform checks: + +```py +import sys + +reveal_type(sys.platform.startswith("freebsd")) # revealed: Literal[True] +reveal_type(sys.platform.startswith("linux")) # revealed: Literal[False] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/sys_version_info.md b/crates/ty_python_semantic/resources/mdtest/sys_version_info.md new file mode 100644 index 0000000000000..bedcdb20b9e05 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/sys_version_info.md @@ -0,0 +1,147 @@ +# `sys.version_info` + +```toml +[environment] +python-version = "3.9" +``` + +## The type of `sys.version_info` + +The type of `sys.version_info` is `sys._version_info`, at least according to typeshed's stubs (which +we treat as the single source of truth for the standard library). This is quite a complicated type +in typeshed, so there are many things we don't fully understand about the type yet; this is the +source of several TODOs in this test file. Many of these TODOs should be naturally fixed as we +implement more type-system features in the future. + +```py +import sys + +reveal_type(sys.version_info) # revealed: _version_info +``` + +## Literal types from comparisons + +Comparing `sys.version_info` with a 2-element tuple of literal integers always produces a `Literal` +type: + +```py +import sys + +reveal_type(sys.version_info >= (3, 9)) # revealed: Literal[True] +reveal_type((3, 9) <= sys.version_info) # revealed: Literal[True] + +reveal_type(sys.version_info > (3, 9)) # revealed: Literal[True] +reveal_type((3, 9) < sys.version_info) # revealed: Literal[True] + +reveal_type(sys.version_info < (3, 9)) # revealed: Literal[False] +reveal_type((3, 9) > sys.version_info) # revealed: Literal[False] + +reveal_type(sys.version_info <= (3, 9)) # revealed: Literal[False] +reveal_type((3, 9) >= sys.version_info) # revealed: Literal[False] + +reveal_type(sys.version_info == (3, 9)) # revealed: Literal[False] +reveal_type((3, 9) == sys.version_info) # revealed: Literal[False] + +reveal_type(sys.version_info != (3, 9)) # revealed: Literal[True] +reveal_type((3, 9) != sys.version_info) # revealed: Literal[True] +``` + +## Non-literal types from comparisons + +Comparing `sys.version_info` with tuples of other lengths will sometimes produce `Literal` types, +sometimes not: + +```py +import sys + +reveal_type(sys.version_info >= (3, 9, 1)) # revealed: bool +reveal_type(sys.version_info >= (3, 9, 1, "final", 0)) # revealed: bool + +# TODO: While this won't fail at runtime, the user has probably made a mistake +# if they're comparing a tuple of length >5 with `sys.version_info` +# (`sys.version_info` is a tuple of length 5). It might be worth +# emitting a lint diagnostic of some kind warning them about the probable error? +reveal_type(sys.version_info >= (3, 9, 1, "final", 0, 5)) # revealed: bool + +reveal_type(sys.version_info == (3, 8, 1, "finallllll", 0)) # revealed: Literal[False] +``` + +## Imports and aliases + +Comparisons with `sys.version_info` still produce literal types, even if the symbol is aliased to +another name: + +```py +from sys import version_info +from sys import version_info as foo + +reveal_type(version_info >= (3, 9)) # revealed: Literal[True] +reveal_type(foo >= (3, 9)) # revealed: Literal[True] + +bar = version_info +reveal_type(bar >= (3, 9)) # revealed: Literal[True] +``` + +## Non-stdlib modules named `sys` + +Only comparisons with the symbol `version_info` from the `sys` module produce literal types: + +`package/__init__.py`: + +```py +``` + +`package/sys.py`: + +```py +version_info: tuple[int, int] = (4, 2) +``` + +`package/script.py`: + +```py +from .sys import version_info + +reveal_type(version_info >= (3, 9)) # revealed: bool +``` + +## Accessing fields by name + +The fields of `sys.version_info` can be accessed by name: + +```py +import sys + +reveal_type(sys.version_info.major >= 3) # revealed: Literal[True] +reveal_type(sys.version_info.minor >= 9) # revealed: Literal[True] +reveal_type(sys.version_info.minor >= 10) # revealed: Literal[False] +``` + +But the `micro`, `releaselevel` and `serial` fields are inferred as `@Todo` until we support +properties on instance types: + +```py +reveal_type(sys.version_info.micro) # revealed: int +reveal_type(sys.version_info.releaselevel) # revealed: @Todo(Support for `typing.TypeAlias`) +reveal_type(sys.version_info.serial) # revealed: int +``` + +## Accessing fields by index/slice + +The fields of `sys.version_info` can be accessed by index or by slice: + +```py +import sys + +reveal_type(sys.version_info[0] < 3) # revealed: Literal[False] +reveal_type(sys.version_info[1] > 9) # revealed: Literal[False] + +# revealed: tuple[Literal[3], Literal[9], int, Literal["alpha", "beta", "candidate", "final"], int] +reveal_type(sys.version_info[:5]) + +reveal_type(sys.version_info[:2] >= (3, 9)) # revealed: Literal[True] +reveal_type(sys.version_info[0:2] >= (3, 10)) # revealed: Literal[False] +reveal_type(sys.version_info[:3] >= (3, 10, 1)) # revealed: Literal[False] +reveal_type(sys.version_info[3] == "final") # revealed: bool +reveal_type(sys.version_info[3] == "finalllllll") # revealed: Literal[False] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/terminal_statements.md b/crates/ty_python_semantic/resources/mdtest/terminal_statements.md new file mode 100644 index 0000000000000..016ab3d6558af --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/terminal_statements.md @@ -0,0 +1,661 @@ +# Terminal statements + +## Introduction + +Terminal statements complicate a naive control-flow analysis. + +As a simple example: + +```py +def f(cond: bool) -> str: + if cond: + x = "test" + else: + raise ValueError + return x + +def g(cond: bool): + if cond: + x = "test" + reveal_type(x) # revealed: Literal["test"] + else: + x = "terminal" + reveal_type(x) # revealed: Literal["terminal"] + raise ValueError + reveal_type(x) # revealed: Literal["test"] +``` + +In `f`, we should be able to determine that the `else` branch ends in a terminal statement, and that +the `return` statement can only be executed when the condition is true. We should therefore consider +the reference always bound, even though `x` is only bound in the true branch. + +Similarly, in `g`, we should see that the assignment of the value `"terminal"` can never be seen by +the final `reveal_type`. + +## `return` + +A `return` statement is terminal; bindings that occur before it are not visible after it. + +```py +def resolved_reference(cond: bool) -> str: + if cond: + x = "test" + else: + return "early" + return x # no possibly-unresolved-reference diagnostic! + +def return_in_then_branch(cond: bool): + if cond: + x = "terminal" + reveal_type(x) # revealed: Literal["terminal"] + return + else: + x = "test" + reveal_type(x) # revealed: Literal["test"] + reveal_type(x) # revealed: Literal["test"] + +def return_in_else_branch(cond: bool): + if cond: + x = "test" + reveal_type(x) # revealed: Literal["test"] + else: + x = "terminal" + reveal_type(x) # revealed: Literal["terminal"] + return + reveal_type(x) # revealed: Literal["test"] + +def return_in_both_branches(cond: bool): + if cond: + x = "terminal1" + reveal_type(x) # revealed: Literal["terminal1"] + return + else: + x = "terminal2" + reveal_type(x) # revealed: Literal["terminal2"] + return + +def return_in_try(cond: bool): + x = "before" + try: + if cond: + x = "test" + return + except: + # TODO: Literal["before"] + reveal_type(x) # revealed: Literal["before", "test"] + else: + reveal_type(x) # revealed: Literal["before"] + finally: + reveal_type(x) # revealed: Literal["before", "test"] + reveal_type(x) # revealed: Literal["before", "test"] + +def return_in_nested_then_branch(cond1: bool, cond2: bool): + if cond1: + x = "test1" + reveal_type(x) # revealed: Literal["test1"] + else: + if cond2: + x = "terminal" + reveal_type(x) # revealed: Literal["terminal"] + return + else: + x = "test2" + reveal_type(x) # revealed: Literal["test2"] + reveal_type(x) # revealed: Literal["test2"] + reveal_type(x) # revealed: Literal["test1", "test2"] + +def return_in_nested_else_branch(cond1: bool, cond2: bool): + if cond1: + x = "test1" + reveal_type(x) # revealed: Literal["test1"] + else: + if cond2: + x = "test2" + reveal_type(x) # revealed: Literal["test2"] + else: + x = "terminal" + reveal_type(x) # revealed: Literal["terminal"] + return + reveal_type(x) # revealed: Literal["test2"] + reveal_type(x) # revealed: Literal["test1", "test2"] + +def return_in_both_nested_branches(cond1: bool, cond2: bool): + if cond1: + x = "test" + reveal_type(x) # revealed: Literal["test"] + else: + x = "terminal0" + if cond2: + x = "terminal1" + reveal_type(x) # revealed: Literal["terminal1"] + return + else: + x = "terminal2" + reveal_type(x) # revealed: Literal["terminal2"] + return + reveal_type(x) # revealed: Literal["test"] +``` + +## `continue` + +A `continue` statement jumps back to the top of the innermost loop. This makes it terminal within +the loop body: definitions before it are not visible after it within the rest of the loop body. They +are likely visible after the loop body, since loops do not introduce new scopes. (Statically known +infinite loops are one exception — if control never leaves the loop body, bindings inside of the +loop are not visible outside of it.) + +TODO: We are not currently modeling the cyclic control flow for loops, pending fixpoint support in +Salsa. The false positives in this section are because of that, and not our terminal statement +support. See [ruff#14160](https://github.com/astral-sh/ruff/issues/14160) for more details. + +```py +def resolved_reference(cond: bool) -> str: + while True: + if cond: + x = "test" + else: + continue + return x + +def continue_in_then_branch(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "continue" + reveal_type(x) # revealed: Literal["continue"] + continue + else: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + reveal_type(x) # revealed: Literal["loop"] + # TODO: Should be Literal["before", "loop", "continue"] + reveal_type(x) # revealed: Literal["before", "loop"] + +def continue_in_else_branch(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + else: + x = "continue" + reveal_type(x) # revealed: Literal["continue"] + continue + reveal_type(x) # revealed: Literal["loop"] + # TODO: Should be Literal["before", "loop", "continue"] + reveal_type(x) # revealed: Literal["before", "loop"] + +def continue_in_both_branches(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "continue1" + reveal_type(x) # revealed: Literal["continue1"] + continue + else: + x = "continue2" + reveal_type(x) # revealed: Literal["continue2"] + continue + # TODO: Should be Literal["before", "continue1", "continue2"] + reveal_type(x) # revealed: Literal["before"] + +def continue_in_nested_then_branch(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop1" + reveal_type(x) # revealed: Literal["loop1"] + else: + if cond2: + x = "continue" + reveal_type(x) # revealed: Literal["continue"] + continue + else: + x = "loop2" + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop1", "loop2"] + # TODO: Should be Literal["before", "loop1", "loop2", "continue"] + reveal_type(x) # revealed: Literal["before", "loop1", "loop2"] + +def continue_in_nested_else_branch(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop1" + reveal_type(x) # revealed: Literal["loop1"] + else: + if cond2: + x = "loop2" + reveal_type(x) # revealed: Literal["loop2"] + else: + x = "continue" + reveal_type(x) # revealed: Literal["continue"] + continue + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop1", "loop2"] + # TODO: Should be Literal["before", "loop1", "loop2", "continue"] + reveal_type(x) # revealed: Literal["before", "loop1", "loop2"] + +def continue_in_both_nested_branches(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + else: + if cond2: + x = "continue1" + reveal_type(x) # revealed: Literal["continue1"] + continue + else: + x = "continue2" + reveal_type(x) # revealed: Literal["continue2"] + continue + reveal_type(x) # revealed: Literal["loop"] + # TODO: Should be Literal["before", "loop", "continue1", "continue2"] + reveal_type(x) # revealed: Literal["before", "loop"] +``` + +## `break` + +A `break` statement jumps to the end of the innermost loop. This makes it terminal within the loop +body: definitions before it are not visible after it within the rest of the loop body. They are +likely visible after the loop body, since loops do not introduce new scopes. (Statically known +infinite loops are one exception — if control never leaves the loop body, bindings inside of the +loop are not visible outside of it.) + +```py +def resolved_reference(cond: bool) -> str: + while True: + if cond: + x = "test" + else: + break + return x + return x # error: [unresolved-reference] + +def break_in_then_branch(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "break" + reveal_type(x) # revealed: Literal["break"] + break + else: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + reveal_type(x) # revealed: Literal["loop"] + reveal_type(x) # revealed: Literal["before", "break", "loop"] + +def break_in_else_branch(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + else: + x = "break" + reveal_type(x) # revealed: Literal["break"] + break + reveal_type(x) # revealed: Literal["loop"] + reveal_type(x) # revealed: Literal["before", "loop", "break"] + +def break_in_both_branches(cond: bool, i: int): + x = "before" + for _ in range(i): + if cond: + x = "break1" + reveal_type(x) # revealed: Literal["break1"] + break + else: + x = "break2" + reveal_type(x) # revealed: Literal["break2"] + break + reveal_type(x) # revealed: Literal["before", "break1", "break2"] + +def break_in_nested_then_branch(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop1" + reveal_type(x) # revealed: Literal["loop1"] + else: + if cond2: + x = "break" + reveal_type(x) # revealed: Literal["break"] + break + else: + x = "loop2" + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop1", "loop2"] + reveal_type(x) # revealed: Literal["before", "loop1", "break", "loop2"] + +def break_in_nested_else_branch(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop1" + reveal_type(x) # revealed: Literal["loop1"] + else: + if cond2: + x = "loop2" + reveal_type(x) # revealed: Literal["loop2"] + else: + x = "break" + reveal_type(x) # revealed: Literal["break"] + break + reveal_type(x) # revealed: Literal["loop2"] + reveal_type(x) # revealed: Literal["loop1", "loop2"] + reveal_type(x) # revealed: Literal["before", "loop1", "loop2", "break"] + +def break_in_both_nested_branches(cond1: bool, cond2: bool, i: int): + x = "before" + for _ in range(i): + if cond1: + x = "loop" + reveal_type(x) # revealed: Literal["loop"] + else: + if cond2: + x = "break1" + reveal_type(x) # revealed: Literal["break1"] + break + else: + x = "break2" + reveal_type(x) # revealed: Literal["break2"] + break + reveal_type(x) # revealed: Literal["loop"] + reveal_type(x) # revealed: Literal["before", "loop", "break1", "break2"] +``` + +## `raise` + +A `raise` statement is terminal. If it occurs in a lexically containing `try` statement, it will +jump to one of the `except` clauses (if it matches the value being raised), or to the `else` clause +(if none match). Currently, we assume definitions from before the `raise` are visible in all +`except` and `else` clauses. (In the future, we might analyze the `except` clauses to see which ones +match the value being raised, and limit visibility to those clauses.) Definitions from before the +`raise` are not visible in any `else` clause, but are visible in `except` clauses or after the +containing `try` statement (since control flow may have passed through an `except`). + +Currently we assume that an exception could be raised anywhere within a `try` block. We may want to +implement a more precise understanding of where exceptions (barring `KeyboardInterrupt` and +`MemoryError`) can and cannot actually be raised. + +```py +def raise_in_then_branch(cond: bool): + x = "before" + try: + if cond: + x = "raise" + reveal_type(x) # revealed: Literal["raise"] + raise ValueError + else: + x = "else" + reveal_type(x) # revealed: Literal["else"] + reveal_type(x) # revealed: Literal["else"] + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise", "else"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise", "else"] + else: + reveal_type(x) # revealed: Literal["else"] + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise", "else"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise", "else"] + +def raise_in_else_branch(cond: bool): + x = "before" + try: + if cond: + x = "else" + reveal_type(x) # revealed: Literal["else"] + else: + x = "raise" + reveal_type(x) # revealed: Literal["raise"] + raise ValueError + reveal_type(x) # revealed: Literal["else"] + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise"] + else: + reveal_type(x) # revealed: Literal["else"] + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise"] + +def raise_in_both_branches(cond: bool): + x = "before" + try: + if cond: + x = "raise1" + reveal_type(x) # revealed: Literal["raise1"] + raise ValueError + else: + x = "raise2" + reveal_type(x) # revealed: Literal["raise2"] + raise ValueError + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise1", "raise2"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise1", "raise2"] + else: + # This branch is unreachable, since all control flows in the `try` clause raise exceptions. + # As a result, this binding should never be reachable, since new bindings are visible only + # when they are reachable. + x = "unreachable" + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise1", "raise2"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "raise1", "raise2"] + +def raise_in_nested_then_branch(cond1: bool, cond2: bool): + x = "before" + try: + if cond1: + x = "else1" + reveal_type(x) # revealed: Literal["else1"] + else: + if cond2: + x = "raise" + reveal_type(x) # revealed: Literal["raise"] + raise ValueError + else: + x = "else2" + reveal_type(x) # revealed: Literal["else2"] + reveal_type(x) # revealed: Literal["else2"] + reveal_type(x) # revealed: Literal["else1", "else2"] + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "raise", "else2"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "raise", "else2"] + else: + reveal_type(x) # revealed: Literal["else1", "else2"] + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "raise", "else2"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "raise", "else2"] + +def raise_in_nested_else_branch(cond1: bool, cond2: bool): + x = "before" + try: + if cond1: + x = "else1" + reveal_type(x) # revealed: Literal["else1"] + else: + if cond2: + x = "else2" + reveal_type(x) # revealed: Literal["else2"] + else: + x = "raise" + reveal_type(x) # revealed: Literal["raise"] + raise ValueError + reveal_type(x) # revealed: Literal["else2"] + reveal_type(x) # revealed: Literal["else1", "else2"] + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "else2", "raise"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "else2", "raise"] + else: + reveal_type(x) # revealed: Literal["else1", "else2"] + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "else2", "raise"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else1", "else2", "raise"] + +def raise_in_both_nested_branches(cond1: bool, cond2: bool): + x = "before" + try: + if cond1: + x = "else" + reveal_type(x) # revealed: Literal["else"] + else: + if cond2: + x = "raise1" + reveal_type(x) # revealed: Literal["raise1"] + raise ValueError + else: + x = "raise2" + reveal_type(x) # revealed: Literal["raise2"] + raise ValueError + reveal_type(x) # revealed: Literal["else"] + except ValueError: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise1", "raise2"] + except: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise1", "raise2"] + else: + reveal_type(x) # revealed: Literal["else"] + finally: + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise1", "raise2"] + # Exceptions can occur anywhere, so "before" and "raise" are valid possibilities + reveal_type(x) # revealed: Literal["before", "else", "raise1", "raise2"] +``` + +## Terminal in `try` with `finally` clause + +TODO: we don't yet model that a `break` or `continue` in a `try` block will jump to a `finally` +clause before it jumps to end/start of the loop. + +```py +def f(): + x = 1 + while True: + try: + break + finally: + x = 2 + # TODO: should be Literal[2] + reveal_type(x) # revealed: Literal[1] +``` + +## Nested functions + +Free references inside of a function body refer to variables defined in the containing scope. +Function bodies are _lazy scopes_: at runtime, these references are not resolved immediately at the +point of the function definition. Instead, they are resolved _at the time of the call_, which means +that their values (and types) can be different for different invocations. For simplicity, we instead +resolve free references _at the end of the containing scope_. That means that in the examples below, +all of the `x` bindings should be visible to the `reveal_type`, regardless of where we place the +`return` statements. + +TODO: These currently produce the wrong results, but not because of our terminal statement support. +See [ruff#15777](https://github.com/astral-sh/ruff/issues/15777) for more details. + +```py +def top_level_return(cond1: bool, cond2: bool): + x = 1 + + def g(): + # TODO eliminate Unknown + reveal_type(x) # revealed: Unknown | Literal[1, 2, 3] + if cond1: + if cond2: + x = 2 + else: + x = 3 + return + +def return_from_if(cond1: bool, cond2: bool): + x = 1 + + def g(): + # TODO: Literal[1, 2, 3] + reveal_type(x) # revealed: Unknown | Literal[1] + if cond1: + if cond2: + x = 2 + else: + x = 3 + return + +def return_from_nested_if(cond1: bool, cond2: bool): + x = 1 + + def g(): + # TODO: Literal[1, 2, 3] + reveal_type(x) # revealed: Unknown | Literal[1, 3] + if cond1: + if cond2: + x = 2 + return + else: + x = 3 +``` + +## Statically known terminal statements + +We model reachability using the same visibility constraints that we use to model statically known +bounds. In this example, we see that the `return` statement is always executed, and therefore that +the `"b"` assignment is not visible to the `reveal_type`. + +```py +def _(cond: bool): + x = "a" + if cond: + x = "b" + if True: + return + + reveal_type(x) # revealed: Literal["a"] +``` + +## Bindings after a terminal statement are unreachable + +Any bindings introduced after a terminal statement are unreachable, and are currently considered not +visible. We [anticipate](https://github.com/astral-sh/ruff/issues/15797) that we want to provide a +more useful analysis for code after terminal statements. + +```py +def f(cond: bool) -> str: + x = "before" + if cond: + reveal_type(x) # revealed: Literal["before"] + return "a" + x = "after-return" + reveal_type(x) # revealed: Never + else: + x = "else" + return reveal_type(x) # revealed: Literal["else"] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_api.md b/crates/ty_python_semantic/resources/mdtest/type_api.md new file mode 100644 index 0000000000000..639bd4f83a193 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_api.md @@ -0,0 +1,469 @@ +# Type API (`ty_extensions`) + +This document describes the internal `ty_extensions` API for creating and manipulating types as well +as testing various type system properties. + +## Type extensions + +The Python language itself allows us to perform a variety of operations on types. For example, we +can build a union of types like `int | None`, or we can use type constructors such as `list[int]` +and `type[int]` to create new types. But some type-level operations that we rely on in ty, like +intersections, cannot yet be expressed in Python. The `ty_extensions` module provides the +`Intersection` and `Not` type constructors (special forms) which allow us to construct these types +directly. + +### Negation + +```py +from typing import Literal +from ty_extensions import Not, static_assert + +def negate(n1: Not[int], n2: Not[Not[int]], n3: Not[Not[Not[int]]]) -> None: + reveal_type(n1) # revealed: ~int + reveal_type(n2) # revealed: int + reveal_type(n3) # revealed: ~int + +# error: "Special form `ty_extensions.Not` expected exactly one type parameter" +n: Not[int, str] + +def static_truthiness(not_one: Not[Literal[1]]) -> None: + # TODO: `bool` is not incorrect, but these would ideally be `Literal[True]` and `Literal[False]` + # respectively, since all possible runtime objects that are created by the literal syntax `1` + # are members of the type `Literal[1]` + reveal_type(not_one is not 1) # revealed: bool + reveal_type(not_one is 1) # revealed: bool + + # But these are both `bool`, rather than `Literal[True]` or `Literal[False]` + # as there are many runtime objects that inhabit the type `~Literal[1]` + # but still compare equal to `1`. Two examples are `1.0` and `True`. + reveal_type(not_one != 1) # revealed: bool + reveal_type(not_one == 1) # revealed: bool +``` + +### Intersection + +```toml +[environment] +python-version = "3.12" +``` + +```py +from ty_extensions import Intersection, Not, is_subtype_of, static_assert +from typing_extensions import Literal, Never + +class S: ... +class T: ... + +def x(x1: Intersection[S, T], x2: Intersection[S, Not[T]]) -> None: + reveal_type(x1) # revealed: S & T + reveal_type(x2) # revealed: S & ~T + +def y(y1: Intersection[int, object], y2: Intersection[int, bool], y3: Intersection[int, Never]) -> None: + reveal_type(y1) # revealed: int + reveal_type(y2) # revealed: bool + reveal_type(y3) # revealed: Never + +def z(z1: Intersection[int, Not[Literal[1]], Not[Literal[2]]]) -> None: + reveal_type(z1) # revealed: int & ~Literal[1] & ~Literal[2] + +class A: ... +class B: ... +class C: ... + +type ABC = Intersection[A, B, C] + +static_assert(is_subtype_of(ABC, A)) +static_assert(is_subtype_of(ABC, B)) +static_assert(is_subtype_of(ABC, C)) + +class D: ... + +static_assert(not is_subtype_of(ABC, D)) +``` + +### Unknown type + +The `Unknown` type is a special type that we use to represent actually unknown types (no +annotation), as opposed to `Any` which represents an explicitly unknown type. + +```py +from ty_extensions import Unknown, static_assert, is_assignable_to, is_fully_static + +static_assert(is_assignable_to(Unknown, int)) +static_assert(is_assignable_to(int, Unknown)) + +static_assert(not is_fully_static(Unknown)) + +def explicit_unknown(x: Unknown, y: tuple[str, Unknown], z: Unknown = 1) -> None: + reveal_type(x) # revealed: Unknown + reveal_type(y) # revealed: tuple[str, Unknown] + reveal_type(z) # revealed: Unknown | Literal[1] +``` + +`Unknown` can be subclassed, just like `Any`: + +```py +class C(Unknown): ... + +# revealed: tuple[<class 'C'>, Unknown, <class 'object'>] +reveal_type(C.__mro__) + +# error: "Special form `ty_extensions.Unknown` expected no type parameter" +u: Unknown[str] +``` + +### `AlwaysTruthy` and `AlwaysFalsy` + +`AlwaysTruthy` and `AlwaysFalsy` represent the sets of all possible objects whose truthiness is +always truthy or falsy, respectively. + +They do not accept any type arguments. + +```py +from typing_extensions import Literal + +from ty_extensions import AlwaysFalsy, AlwaysTruthy, is_subtype_of, static_assert + +static_assert(is_subtype_of(Literal[True], AlwaysTruthy)) +static_assert(is_subtype_of(Literal[False], AlwaysFalsy)) + +static_assert(not is_subtype_of(int, AlwaysFalsy)) +static_assert(not is_subtype_of(str, AlwaysFalsy)) + +def _(t: AlwaysTruthy, f: AlwaysFalsy): + reveal_type(t) # revealed: AlwaysTruthy + reveal_type(f) # revealed: AlwaysFalsy + +def f( + a: AlwaysTruthy[int], # error: [invalid-type-form] + b: AlwaysFalsy[str], # error: [invalid-type-form] +): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown +``` + +## Static assertions + +### Basics + +The `ty_extensions` module provides a `static_assert` function that can be used to enforce +properties at type-check time. The function takes an arbitrary expression and raises a type error if +the expression is not of statically known truthiness. + +```py +from ty_extensions import static_assert +from typing import TYPE_CHECKING +import sys + +static_assert(True) +static_assert(False) # error: "Static assertion error: argument evaluates to `False`" + +static_assert(False or True) +static_assert(True and True) +static_assert(False or False) # error: "Static assertion error: argument evaluates to `False`" +static_assert(False and True) # error: "Static assertion error: argument evaluates to `False`" + +static_assert(1 + 1 == 2) +static_assert(1 + 1 == 3) # error: "Static assertion error: argument evaluates to `False`" + +static_assert("a" in "abc") +static_assert("d" in "abc") # error: "Static assertion error: argument evaluates to `False`" + +n = None +static_assert(n is None) + +static_assert(TYPE_CHECKING) + +static_assert(sys.version_info >= (3, 6)) +``` + +### Narrowing constraints + +Static assertions can be used to enforce narrowing constraints: + +```py +from ty_extensions import static_assert + +def f(x: int | None) -> None: + if x is not None: + static_assert(x is not None) + else: + static_assert(x is None) +``` + +### Truthy expressions + +See also: <https://docs.python.org/3/library/stdtypes.html#truth-value-testing> + +```py +from ty_extensions import static_assert + +static_assert(True) +static_assert(False) # error: "Static assertion error: argument evaluates to `False`" + +static_assert(None) # error: "Static assertion error: argument of type `None` is statically known to be falsy" + +static_assert(1) +static_assert(0) # error: "Static assertion error: argument of type `Literal[0]` is statically known to be falsy" + +static_assert((0,)) +static_assert(()) # error: "Static assertion error: argument of type `tuple[()]` is statically known to be falsy" + +static_assert("a") +static_assert("") # error: "Static assertion error: argument of type `Literal[""]` is statically known to be falsy" + +static_assert(b"a") +static_assert(b"") # error: "Static assertion error: argument of type `Literal[b""]` is statically known to be falsy" +``` + +### Error messages + +We provide various tailored error messages for wrong argument types to `static_assert`: + +```py +from ty_extensions import static_assert + +static_assert(2 * 3 == 6) + +# error: "Static assertion error: argument evaluates to `False`" +static_assert(2 * 3 == 7) + +# error: "Static assertion error: argument of type `bool` has an ambiguous static truthiness" +static_assert(int(2.0 * 3.0) == 6) + +class InvalidBoolDunder: + def __bool__(self) -> int: + return 1 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `InvalidBoolDunder`" +static_assert(InvalidBoolDunder()) +``` + +### Custom error messages + +Alternatively, users can provide custom error messages: + +```py +from ty_extensions import static_assert + +# error: "Static assertion error: I really want this to be true" +static_assert(1 + 1 == 3, "I really want this to be true") + +error_message = "A custom message " +error_message += "constructed from multiple string literals" +# error: "Static assertion error: A custom message constructed from multiple string literals" +static_assert(False, error_message) +``` + +There are limitations to what we can still infer as a string literal. In those cases, we simply fall +back to the default message: + +```py +shouted_message = "A custom message".upper() +# error: "Static assertion error: argument evaluates to `False`" +static_assert(False, shouted_message) +``` + +## Type predicates + +The `ty_extensions` module also provides predicates to test various properties of types. These are +implemented as functions that return `Literal[True]` or `Literal[False]` depending on the result of +the test. + +### Equivalence + +```py +from ty_extensions import is_equivalent_to, static_assert +from typing_extensions import Never, Union + +static_assert(is_equivalent_to(type, type[object])) +static_assert(is_equivalent_to(tuple[int, Never], Never)) +static_assert(is_equivalent_to(int | str, Union[int, str])) + +static_assert(not is_equivalent_to(int, str)) +static_assert(not is_equivalent_to(int | str, int | str | bytes)) +``` + +### Subtyping + +```py +from ty_extensions import is_subtype_of, static_assert + +static_assert(is_subtype_of(bool, int)) +static_assert(not is_subtype_of(str, int)) + +static_assert(is_subtype_of(bool, int | str)) +static_assert(is_subtype_of(str, int | str)) +static_assert(not is_subtype_of(bytes, int | str)) + +class Base: ... +class Derived(Base): ... +class Unrelated: ... + +static_assert(is_subtype_of(Derived, Base)) +static_assert(not is_subtype_of(Base, Derived)) +static_assert(is_subtype_of(Base, Base)) + +static_assert(not is_subtype_of(Unrelated, Base)) +static_assert(not is_subtype_of(Base, Unrelated)) +``` + +### Assignability + +```py +from ty_extensions import is_assignable_to, static_assert +from typing import Any + +static_assert(is_assignable_to(int, Any)) +static_assert(is_assignable_to(Any, str)) +static_assert(not is_assignable_to(int, str)) +``` + +### Disjointness + +```py +from ty_extensions import is_disjoint_from, static_assert +from typing import Literal + +static_assert(is_disjoint_from(None, int)) +static_assert(not is_disjoint_from(Literal[2] | str, int)) +``` + +### Fully static types + +```py +from ty_extensions import is_fully_static, static_assert +from typing import Any + +static_assert(is_fully_static(int | str)) +static_assert(is_fully_static(type[int])) + +static_assert(not is_fully_static(int | Any)) +static_assert(not is_fully_static(type[Any])) +``` + +### Singleton types + +```py +from ty_extensions import is_singleton, static_assert +from typing import Literal + +static_assert(is_singleton(None)) +static_assert(is_singleton(Literal[True])) + +static_assert(not is_singleton(int)) +static_assert(not is_singleton(Literal["a"])) +``` + +### Single-valued types + +```py +from ty_extensions import is_single_valued, static_assert +from typing import Literal + +static_assert(is_single_valued(None)) +static_assert(is_single_valued(Literal[True])) +static_assert(is_single_valued(Literal["a"])) + +static_assert(not is_single_valued(int)) +static_assert(not is_single_valued(Literal["a"] | Literal["b"])) +``` + +## `TypeOf` + +We use `TypeOf` to get the inferred type of an expression. This is useful when we want to refer to +it in a type expression. For example, if we want to make sure that the class literal type `str` is a +subtype of `type[str]`, we can not use `is_subtype_of(str, type[str])`, as that would test if the +type `str` itself is a subtype of `type[str]`. Instead, we can use `TypeOf[str]` to get the type of +the expression `str`: + +```py +from ty_extensions import TypeOf, is_subtype_of, static_assert + +# This is incorrect and therefore fails with ... +# error: "Static assertion error: argument evaluates to `False`" +static_assert(is_subtype_of(str, type[str])) + +# Correct, returns True: +static_assert(is_subtype_of(TypeOf[str], type[str])) + +class Base: ... +class Derived(Base): ... +``` + +`TypeOf` can also be used in annotations: + +```py +def type_of_annotation() -> None: + t1: TypeOf[Base] = Base + t2: TypeOf[Base] = Derived # error: [invalid-assignment] + + # Note how this is different from `type[…]` which includes subclasses: + s1: type[Base] = Base + s2: type[Base] = Derived # no error here + +# error: "Special form `ty_extensions.TypeOf` expected exactly one type parameter" +t: TypeOf[int, str, bytes] + +# error: [invalid-type-form] "`ty_extensions.TypeOf` requires exactly one argument when used in a type expression" +def f(x: TypeOf) -> None: + reveal_type(x) # revealed: Unknown +``` + +## `CallableTypeOf` + +The `CallableTypeOf` special form can be used to extract the `Callable` structural type inhabited by +a given callable object. This can be used to get the externally visibly signature of the object, +which can then be used to test various type properties. + +It accepts a single type parameter which is expected to be a callable object. + +```py +from ty_extensions import CallableTypeOf + +def f1(): + return + +def f2() -> int: + return 1 + +def f3(x: int, y: str) -> None: + return + +# error: [invalid-type-form] "Special form `ty_extensions.CallableTypeOf` expected exactly one type parameter" +c1: CallableTypeOf[f1, f2] + +# error: [invalid-type-form] "Expected the first argument to `ty_extensions.CallableTypeOf` to be a callable object, but got an object of type `Literal["foo"]`" +c2: CallableTypeOf["foo"] + +# error: [invalid-type-form] "`ty_extensions.CallableTypeOf` requires exactly one argument when used in a type expression" +def f(x: CallableTypeOf) -> None: + reveal_type(x) # revealed: Unknown +``` + +Using it in annotation to reveal the signature of the callable object: + +```py +class Foo: + def __init__(self, x: int) -> None: + pass + + def __call__(self, x: int) -> str: + return "foo" + +def _( + c1: CallableTypeOf[f1], + c2: CallableTypeOf[f2], + c3: CallableTypeOf[f3], + c4: CallableTypeOf[Foo], + c5: CallableTypeOf[Foo(42).__call__], +) -> None: + reveal_type(c1) # revealed: () -> Unknown + reveal_type(c2) # revealed: () -> int + reveal_type(c3) # revealed: (x: int, y: str) -> None + + # TODO: should be `(x: int) -> Foo` + reveal_type(c4) # revealed: (...) -> Foo + + reveal_type(c5) # revealed: (x: int) -> str +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_of/basic.md b/crates/ty_python_semantic/resources/mdtest/type_of/basic.md new file mode 100644 index 0000000000000..e733df9b94ec9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_of/basic.md @@ -0,0 +1,174 @@ +# type special form + +## Class literal + +```py +class A: ... + +def _(c: type[A]): + reveal_type(c) # revealed: type[A] +``` + +## Nested class literal + +```py +class A: + class B: ... + +def f(c: type[A.B]): + reveal_type(c) # revealed: type[B] +``` + +## Deeply nested class literal + +```py +class A: + class B: + class C: ... + +def f(c: type[A.B.C]): + reveal_type(c) # revealed: type[C] +``` + +## Class literal from another module + +```py +from a import A + +def f(c: type[A]): + reveal_type(c) # revealed: type[A] +``` + +`a.py`: + +```py +class A: ... +``` + +## Qualified class literal from another module + +```py +import a + +def f(c: type[a.B]): + reveal_type(c) # revealed: type[B] +``` + +`a.py`: + +```py +class B: ... +``` + +## Deeply qualified class literal from another module + +`a/test.py`: + +```py +import a.b + +def f(c: type[a.b.C]): + reveal_type(c) # revealed: type[C] +``` + +`a/__init__.py`: + +```py +``` + +`a/b.py`: + +```py +class C: ... +``` + +## New-style union of classes + +```py +class BasicUser: ... +class ProUser: ... + +class A: + class B: + class C: ... + +def _(u: type[BasicUser | ProUser | A.B.C]): + # revealed: type[BasicUser] | type[ProUser] | type[C] + reveal_type(u) +``` + +## Old-style union of classes + +```py +from typing import Union + +class BasicUser: ... +class ProUser: ... + +class A: + class B: + class C: ... + +def f(a: type[Union[BasicUser, ProUser, A.B.C]], b: type[Union[str]], c: type[Union[BasicUser, Union[ProUser, A.B.C]]]): + reveal_type(a) # revealed: type[BasicUser] | type[ProUser] | type[C] + reveal_type(b) # revealed: type[str] + reveal_type(c) # revealed: type[BasicUser] | type[ProUser] | type[C] +``` + +## New-style and old-style unions in combination + +```py +from typing import Union + +class BasicUser: ... +class ProUser: ... + +class A: + class B: + class C: ... + +def f(a: type[BasicUser | Union[ProUser, A.B.C]], b: type[Union[BasicUser | Union[ProUser, A.B.C | str]]]): + reveal_type(a) # revealed: type[BasicUser] | type[ProUser] | type[C] + reveal_type(b) # revealed: type[BasicUser] | type[ProUser] | type[C] | type[str] +``` + +## Illegal parameters + +```py +class A: ... +class B: ... + +# error: [invalid-type-form] +_: type[A, B] +``` + +## As a base class + +```py +class Foo(type[int]): ... + +# TODO: should be `tuple[<class 'Foo'>, <class 'type'>, <class 'object'>] +reveal_type(Foo.__mro__) # revealed: tuple[<class 'Foo'>, @Todo(GenericAlias instance), <class 'object'>] +``` + +## `@final` classes + +`type[]` types are eagerly converted to class-literal types if a class decorated with `@final` is +used as the type argument. This applies to standard-library classes and user-defined classes: + +```toml +[environment] +python-version = "3.10" +``` + +```py +from types import EllipsisType +from typing import final + +@final +class Foo: ... + +def _(x: type[Foo], y: type[EllipsisType]): + reveal_type(x) # revealed: <class 'Foo'> + reveal_type(y) # revealed: <class 'EllipsisType'> +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_of/dynamic.md b/crates/ty_python_semantic/resources/mdtest/type_of/dynamic.md new file mode 100644 index 0000000000000..4e59d97eae65a --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_of/dynamic.md @@ -0,0 +1,103 @@ +# `type[Any]` + +This file contains tests for non-fully-static `type[]` types, such as `type[Any]` and +`type[Unknown]`. + +## Simple + +```py +from typing import Any + +def f(x: type[Any], y: type[str]): + reveal_type(x) # revealed: type[Any] + # TODO: could be `<object.__repr__ type> & Any` + reveal_type(x.__repr__) # revealed: Any + + # type[str] and type[Any] are assignable to each other + a: type[str] = x + b: type[Any] = y + +class A: ... + +x: type[Any] = object +x: type[Any] = type +x: type[Any] = A +x: type[Any] = A() # error: [invalid-assignment] +``` + +## Bare type + +The interpretation of bare `type` is not clear: existing wording in the spec does not match the +behavior of mypy or pyright. For now we interpret it as simply "an instance of `builtins.type`", +which is equivalent to `type[object]`. This is similar to the current behavior of mypy, and pyright +in strict mode. + +```py +def f(x: type): + reveal_type(x) # revealed: type + reveal_type(x.__repr__) # revealed: bound method type.__repr__() -> str + +class A: ... + +x: type = object +x: type = type +x: type = A +x: type = A() # error: [invalid-assignment] +``` + +## type[object] != type[Any] + +```py +def f(x: type[object]): + reveal_type(x) # revealed: type + reveal_type(x.__repr__) # revealed: bound method type.__repr__() -> str + +class A: ... + +x: type[object] = object +x: type[object] = type +x: type[object] = A +x: type[object] = A() # error: [invalid-assignment] +``` + +## The type of `Any` is `type[Any]` + +`Any` represents an unknown set of possible runtime values. If `x` is of type `Any`, the type of +`x.__class__` is also unknown and remains dynamic, *except* that we know it must be a class object +of some kind. As such, the type of `x.__class__` is `type[Any]` rather than `Any`: + +```py +from typing import Any +from does_not_exist import SomethingUnknown # error: [unresolved-import] + +reveal_type(SomethingUnknown) # revealed: Unknown + +def test(x: Any, y: SomethingUnknown): + reveal_type(x.__class__) # revealed: type[Any] + reveal_type(x.__class__.__class__.__class__.__class__) # revealed: type[Any] + reveal_type(y.__class__) # revealed: type[Unknown] + reveal_type(y.__class__.__class__.__class__.__class__) # revealed: type[Unknown] +``` + +## `type[Unknown]` has similar properties to `type[Any]` + +```py +import abc +from typing import Any +from does_not_exist import SomethingUnknown # error: [unresolved-import] + +has_unknown_type = SomethingUnknown.__class__ +reveal_type(has_unknown_type) # revealed: type[Unknown] + +def test(x: type[str], y: type[Any]): + """Both `type[Any]` and `type[Unknown]` are assignable to all `type[]` types""" + a: type[Any] = x + b: type[str] = y + c: type[Any] = has_unknown_type + d: type[str] = has_unknown_type + +def test2(a: type[Any]): + """`type[Any]` and `type[Unknown]` are also assignable to all instances of `type` subclasses""" + b: abc.ABCMeta = a + b: abc.ABCMeta = has_unknown_type +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_of/typing_dot_Type.md b/crates/ty_python_semantic/resources/mdtest/type_of/typing_dot_Type.md new file mode 100644 index 0000000000000..bda56c9384185 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_of/typing_dot_Type.md @@ -0,0 +1,32 @@ +# `typing.Type` + +## Annotation + +`typing.Type` can be used interchangeably with `type`: + +```py +from typing import Type + +class A: ... + +def _(c: Type, d: Type[A]): + reveal_type(c) # revealed: type + reveal_type(d) # revealed: type[A] + c = d # fine + d = c # fine +``` + +## Inheritance + +Inheriting from `Type` results in a MRO with `builtins.type` and `typing.Generic`. `Type` itself is +not a class. + +```py +from typing import Type + +class C(Type): ... + +# Runtime value: `(C, type, typing.Generic, object)` +# TODO: Add `Generic` to the MRO +reveal_type(C.__mro__) # revealed: tuple[<class 'C'>, <class 'type'>, <class 'object'>] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_assignable_to.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_assignable_to.md new file mode 100644 index 0000000000000..597fd4a61464e --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_assignable_to.md @@ -0,0 +1,731 @@ +# Assignable-to relation + +The `is_assignable_to(S, T)` relation below checks if type `S` is assignable to type `T` (target). +This allows us to check if a type `S` can be used in a context where a type `T` is expected +(function arguments, variable assignments). See the [typing documentation] for a precise definition +of this concept. + +## Basic types + +### Fully static + +Fully static types participate in subtyping. If a type `S` is a subtype of `T`, `S` will also be +assignable to `T`. Two equivalent types are subtypes of each other: + +```py +from ty_extensions import static_assert, is_assignable_to + +class Parent: ... +class Child1(Parent): ... +class Child2(Parent): ... +class Grandchild(Child1, Child2): ... +class Unrelated: ... + +static_assert(is_assignable_to(int, int)) +static_assert(is_assignable_to(Parent, Parent)) +static_assert(is_assignable_to(Child1, Parent)) +static_assert(is_assignable_to(Grandchild, Parent)) +static_assert(is_assignable_to(Unrelated, Unrelated)) + +static_assert(not is_assignable_to(str, int)) +static_assert(not is_assignable_to(object, int)) +static_assert(not is_assignable_to(Parent, Child1)) +static_assert(not is_assignable_to(Unrelated, Parent)) +static_assert(not is_assignable_to(Child1, Child2)) +``` + +### Gradual types + +Gradual types do not participate in subtyping, but can still be assignable to other types (and +static types can be assignable to gradual types): + +```py +from ty_extensions import static_assert, is_assignable_to, Unknown +from typing import Any, Literal + +static_assert(is_assignable_to(Unknown, Literal[1])) +static_assert(is_assignable_to(Any, Literal[1])) +static_assert(is_assignable_to(Literal[1], Unknown)) +static_assert(is_assignable_to(Literal[1], Any)) + +class SubtypeOfAny(Any): ... + +static_assert(is_assignable_to(SubtypeOfAny, Any)) +static_assert(is_assignable_to(SubtypeOfAny, int)) +static_assert(is_assignable_to(Any, SubtypeOfAny)) +static_assert(not is_assignable_to(int, SubtypeOfAny)) +``` + +## Literal types + +### Boolean literals + +`Literal[True]` and `Literal[False]` are both subtypes of (and therefore assignable to) `bool`, +which is in turn a subtype of `int`: + +```py +from ty_extensions import static_assert, is_assignable_to +from typing import Literal + +static_assert(is_assignable_to(Literal[True], Literal[True])) +static_assert(is_assignable_to(Literal[True], bool)) +static_assert(is_assignable_to(Literal[True], int)) + +static_assert(not is_assignable_to(Literal[True], Literal[False])) +static_assert(not is_assignable_to(bool, Literal[True])) +``` + +### Integer literals + +```py +from ty_extensions import static_assert, is_assignable_to +from typing import Literal + +static_assert(is_assignable_to(Literal[1], Literal[1])) +static_assert(is_assignable_to(Literal[1], int)) + +static_assert(not is_assignable_to(Literal[1], Literal[2])) +static_assert(not is_assignable_to(int, Literal[1])) +static_assert(not is_assignable_to(Literal[1], str)) +``` + +### String literals and `LiteralString` + +All string-literal types are subtypes of (and therefore assignable to) `LiteralString`, which is in +turn a subtype of `str`: + +```py +from ty_extensions import static_assert, is_assignable_to +from typing_extensions import Literal, LiteralString + +static_assert(is_assignable_to(Literal["foo"], Literal["foo"])) +static_assert(is_assignable_to(Literal["foo"], LiteralString)) +static_assert(is_assignable_to(Literal["foo"], str)) + +static_assert(is_assignable_to(LiteralString, str)) + +static_assert(not is_assignable_to(Literal["foo"], Literal["bar"])) +static_assert(not is_assignable_to(str, Literal["foo"])) +static_assert(not is_assignable_to(str, LiteralString)) +``` + +### Byte literals + +```py +from ty_extensions import static_assert, is_assignable_to +from typing_extensions import Literal, LiteralString + +static_assert(is_assignable_to(Literal[b"foo"], bytes)) +static_assert(is_assignable_to(Literal[b"foo"], Literal[b"foo"])) + +static_assert(not is_assignable_to(Literal[b"foo"], str)) +static_assert(not is_assignable_to(Literal[b"foo"], LiteralString)) +static_assert(not is_assignable_to(Literal[b"foo"], Literal[b"bar"])) +static_assert(not is_assignable_to(Literal[b"foo"], Literal["foo"])) +static_assert(not is_assignable_to(Literal["foo"], Literal[b"foo"])) +``` + +### Slice literals + +The type of a slice literal is currently inferred as a specialization of `slice`. + +```py +from ty_extensions import TypeOf, is_assignable_to, static_assert + +static_assert(is_assignable_to(TypeOf[1:2:3], slice)) +static_assert(is_assignable_to(TypeOf[1:2:3], slice[int])) +``` + +## `type[…]` and class literals + +In the following tests, `TypeOf[str]` is a singleton type with a single inhabitant, the class `str`. +This contrasts with `type[str]`, which represents "all possible subclasses of `str`". + +Both `TypeOf[str]` and `type[str]` are subtypes of `type` and `type[object]`, which both represent +"all possible instances of `type`"; therefore both `type[str]` and `TypeOf[str]` are assignable to +`type`. `type[Any]`, on the other hand, represents a type of unknown size or inhabitants, but which +is known to be no larger than the set of possible objects represented by `type`. + +```py +from ty_extensions import static_assert, is_assignable_to, Unknown, TypeOf +from typing import Any + +static_assert(is_assignable_to(type, type)) +static_assert(is_assignable_to(type[object], type[object])) + +static_assert(is_assignable_to(type, type[object])) +static_assert(is_assignable_to(type[object], type)) + +static_assert(is_assignable_to(type[str], type[object])) +static_assert(is_assignable_to(TypeOf[str], type[object])) +static_assert(is_assignable_to(type[str], type)) +static_assert(is_assignable_to(TypeOf[str], type)) + +static_assert(is_assignable_to(type[str], type[str])) +static_assert(is_assignable_to(TypeOf[str], type[str])) + +static_assert(not is_assignable_to(TypeOf[int], type[str])) +static_assert(not is_assignable_to(type, type[str])) +static_assert(not is_assignable_to(type[object], type[str])) + +static_assert(is_assignable_to(type[Any], type[Any])) +static_assert(is_assignable_to(type[Any], type[object])) +static_assert(is_assignable_to(type[object], type[Any])) +static_assert(is_assignable_to(type, type[Any])) +static_assert(is_assignable_to(type[Any], type[str])) +static_assert(is_assignable_to(type[str], type[Any])) +static_assert(is_assignable_to(TypeOf[str], type[Any])) + +static_assert(is_assignable_to(type[Unknown], type[Unknown])) +static_assert(is_assignable_to(type[Unknown], type[object])) +static_assert(is_assignable_to(type[object], type[Unknown])) +static_assert(is_assignable_to(type, type[Unknown])) +static_assert(is_assignable_to(type[Unknown], type[str])) +static_assert(is_assignable_to(type[str], type[Unknown])) +static_assert(is_assignable_to(TypeOf[str], type[Unknown])) + +static_assert(is_assignable_to(type[Unknown], type[Any])) +static_assert(is_assignable_to(type[Any], type[Unknown])) + +static_assert(not is_assignable_to(object, type[Any])) +static_assert(not is_assignable_to(str, type[Any])) + +class Meta(type): ... + +static_assert(is_assignable_to(type[Any], Meta)) +static_assert(is_assignable_to(type[Unknown], Meta)) +static_assert(is_assignable_to(Meta, type[Any])) +static_assert(is_assignable_to(Meta, type[Unknown])) + +class AnyMeta(metaclass=Any): ... + +static_assert(is_assignable_to(type[AnyMeta], type)) +static_assert(is_assignable_to(type[AnyMeta], type[object])) +static_assert(is_assignable_to(type[AnyMeta], type[Any])) +``` + +## Class-literals that inherit from `Any` + +Class-literal types that inherit from `Any` are assignable to any type `T` where `T` is assignable +to `type`: + +```py +from typing import Any +from ty_extensions import is_assignable_to, static_assert, TypeOf + +def test(x: Any): + class Foo(x): ... + class Bar(Any): ... + static_assert(is_assignable_to(TypeOf[Foo], Any)) + static_assert(is_assignable_to(TypeOf[Foo], type)) + static_assert(is_assignable_to(TypeOf[Foo], type[int])) + static_assert(is_assignable_to(TypeOf[Foo], type[Any])) + + static_assert(is_assignable_to(TypeOf[Bar], Any)) + static_assert(is_assignable_to(TypeOf[Bar], type)) + static_assert(is_assignable_to(TypeOf[Bar], type[int])) + static_assert(is_assignable_to(TypeOf[Bar], type[Any])) + + static_assert(not is_assignable_to(TypeOf[Foo], int)) + static_assert(not is_assignable_to(TypeOf[Bar], int)) +``` + +This is because the `Any` element in the MRO could materialize to any subtype of `type`. + +## Heterogeneous tuple types + +```py +from ty_extensions import static_assert, is_assignable_to, AlwaysTruthy, AlwaysFalsy +from typing import Literal, Any + +static_assert(is_assignable_to(tuple[()], tuple[()])) +static_assert(is_assignable_to(tuple[int], tuple[int])) +static_assert(is_assignable_to(tuple[int], tuple[Any])) +static_assert(is_assignable_to(tuple[Any], tuple[int])) +static_assert(is_assignable_to(tuple[int, str], tuple[int, str])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[int, int])) +static_assert(is_assignable_to(tuple[Any, Literal[2]], tuple[int, int])) +static_assert(is_assignable_to(tuple[Literal[1], Any], tuple[int, int])) +static_assert(is_assignable_to(tuple[()], tuple)) +static_assert(is_assignable_to(tuple[int, str], tuple)) +static_assert(is_assignable_to(tuple[Any], tuple)) + +# TODO: It is not yet clear if we want the following two assertions to hold. +# See https://github.com/astral-sh/ruff/issues/15528 for more details. The +# short version is: We either need to special-case enforcement of the Liskov +# substitution principle on `__bool__` and `__len__` for tuple subclasses, +# or we need to negate these assertions. +static_assert(is_assignable_to(tuple[()], AlwaysFalsy)) +static_assert(is_assignable_to(tuple[int], AlwaysTruthy)) + +static_assert(not is_assignable_to(tuple[()], tuple[int])) +static_assert(not is_assignable_to(tuple[int], tuple[str])) +static_assert(not is_assignable_to(tuple[int], tuple[int, str])) +static_assert(not is_assignable_to(tuple[int, str], tuple[int])) +static_assert(not is_assignable_to(tuple[int, int], tuple[Literal[1], int])) +static_assert(not is_assignable_to(tuple[Any, Literal[2]], tuple[int, str])) +``` + +## Assignability of heterogeneous tuple types to homogeneous tuple types + +While a homogeneous tuple type is not assignable to any heterogeneous tuple types, a heterogeneous +tuple type can be assignable to a homogeneous tuple type, and homogeneous tuple types can be +assignable to `Sequence`: + +```py +from typing import Literal, Any, Sequence +from ty_extensions import static_assert, is_assignable_to, Not, AlwaysFalsy + +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[Literal[1, 2], ...])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[int, ...])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[int | str, ...])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[Any, ...])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], tuple[Not[AlwaysFalsy], ...])) +static_assert(is_assignable_to(tuple[Literal[1], Literal[2]], Sequence[int])) +static_assert(is_assignable_to(tuple[int, ...], Sequence[int])) +static_assert(is_assignable_to(tuple[int, ...], Sequence[Any])) +static_assert(is_assignable_to(tuple[Any, ...], Sequence[int])) + +static_assert(is_assignable_to(tuple[()], tuple[Literal[1, 2], ...])) +static_assert(is_assignable_to(tuple[()], tuple[int, ...])) +static_assert(is_assignable_to(tuple[()], tuple[int | str, ...])) +static_assert(is_assignable_to(tuple[()], tuple[Not[AlwaysFalsy], ...])) +static_assert(is_assignable_to(tuple[()], Sequence[int])) + +static_assert(not is_assignable_to(tuple[int, int], tuple[str, ...])) +``` + +## Union types + +```py +from ty_extensions import AlwaysTruthy, AlwaysFalsy, static_assert, is_assignable_to, Unknown +from typing_extensions import Literal, Any, LiteralString + +static_assert(is_assignable_to(int, int | str)) +static_assert(is_assignable_to(str, int | str)) +static_assert(is_assignable_to(int | str, int | str)) +static_assert(is_assignable_to(str | int, int | str)) +static_assert(is_assignable_to(Literal[1], int | str)) +static_assert(is_assignable_to(Literal[1], Unknown | str)) +static_assert(is_assignable_to(Literal[1] | Literal[2], Literal[1] | Literal[2])) +static_assert(is_assignable_to(Literal[1] | Literal[2], int)) +static_assert(is_assignable_to(Literal[1] | None, int | None)) +static_assert(is_assignable_to(Any, int | str)) +static_assert(is_assignable_to(Any | int, int)) +static_assert(is_assignable_to(str, int | Any)) + +static_assert(not is_assignable_to(int | None, int)) +static_assert(not is_assignable_to(int | None, str | None)) +static_assert(not is_assignable_to(Literal[1] | None, int)) +static_assert(not is_assignable_to(Literal[1] | None, str | None)) +static_assert(not is_assignable_to(Any | int | str, int)) + +# TODO: No errors +# error: [static-assert-error] +static_assert(is_assignable_to(bool, Literal[False] | AlwaysTruthy)) +# error: [static-assert-error] +static_assert(is_assignable_to(bool, Literal[True] | AlwaysFalsy)) +# error: [static-assert-error] +static_assert(is_assignable_to(LiteralString, Literal[""] | AlwaysTruthy)) +static_assert(not is_assignable_to(Literal[True] | AlwaysFalsy, Literal[False] | AlwaysTruthy)) +``` + +## Intersection types + +```py +from ty_extensions import static_assert, is_assignable_to, Intersection, Not, AlwaysTruthy, AlwaysFalsy +from typing_extensions import Any, Literal, final, LiteralString + +class Parent: ... +class Child1(Parent): ... +class Child2(Parent): ... +class Grandchild(Child1, Child2): ... +class Unrelated: ... + +static_assert(is_assignable_to(Intersection[Child1, Child2], Child1)) +static_assert(is_assignable_to(Intersection[Child1, Child2], Child2)) +static_assert(is_assignable_to(Intersection[Child1, Child2], Parent)) +static_assert(is_assignable_to(Intersection[Child1, Parent], Parent)) + +static_assert(is_assignable_to(Intersection[Parent, Unrelated], Parent)) +static_assert(is_assignable_to(Intersection[Child1, Unrelated], Child1)) +static_assert(is_assignable_to(Intersection[Child1, Unrelated, Child2], Intersection[Child1, Unrelated])) + +static_assert(is_assignable_to(Intersection[Child1, Not[Child2]], Child1)) +static_assert(is_assignable_to(Intersection[Child1, Not[Child2]], Parent)) +static_assert(is_assignable_to(Intersection[Child1, Not[Grandchild]], Parent)) + +static_assert(is_assignable_to(Intersection[Child1, Child2], Intersection[Child1, Child2])) +static_assert(is_assignable_to(Intersection[Child1, Child2], Intersection[Child2, Child1])) +static_assert(is_assignable_to(Grandchild, Intersection[Child1, Child2])) +static_assert(not is_assignable_to(Intersection[Child1, Child2], Intersection[Parent, Unrelated])) + +static_assert(not is_assignable_to(Parent, Intersection[Parent, Unrelated])) +static_assert(not is_assignable_to(int, Intersection[int, Not[Literal[1]]])) +# The literal `1` is not assignable to `Parent`, so the intersection of int and Parent is definitely an int that is not `1` +static_assert(is_assignable_to(Intersection[int, Parent], Intersection[int, Not[Literal[1]]])) +static_assert(not is_assignable_to(int, Not[int])) +static_assert(not is_assignable_to(int, Not[Literal[1]])) + +static_assert(is_assignable_to(Not[Parent], Not[Child1])) +static_assert(not is_assignable_to(Not[Parent], Parent)) +static_assert(not is_assignable_to(Intersection[Unrelated, Not[Parent]], Parent)) + +# Intersection with `Any` dominates the left hand side of intersections +static_assert(is_assignable_to(Intersection[Any, Parent], Parent)) +static_assert(is_assignable_to(Intersection[Any, Child1], Parent)) +static_assert(is_assignable_to(Intersection[Any, Child2, Not[Child1]], Parent)) +static_assert(is_assignable_to(Intersection[Any, Parent], Unrelated)) +static_assert(is_assignable_to(Intersection[Any, Parent], Intersection[Parent, Unrelated])) +static_assert(is_assignable_to(Intersection[Any, Parent, Unrelated], Parent)) +static_assert(is_assignable_to(Intersection[Any, Parent, Unrelated], Intersection[Parent, Unrelated])) + +# Even Any & Not[Parent] is assignable to Parent, since it could be Never +static_assert(is_assignable_to(Intersection[Any, Not[Parent]], Parent)) +static_assert(is_assignable_to(Intersection[Any, Not[Parent]], Not[Parent])) + +# Intersection with `Any` is effectively ignored on the right hand side for the sake of assignment +static_assert(is_assignable_to(Parent, Intersection[Any, Parent])) +static_assert(is_assignable_to(Parent, Parent | Intersection[Any, Unrelated])) +static_assert(is_assignable_to(Child1, Intersection[Any, Parent])) +static_assert(not is_assignable_to(Literal[1], Intersection[Any, Parent])) +static_assert(not is_assignable_to(Unrelated, Intersection[Any, Parent])) + +# Intersections with Any on both sides combine the above logic - the LHS dominates and Any is ignored on the right hand side +static_assert(is_assignable_to(Intersection[Any, Parent], Intersection[Any, Parent])) +static_assert(is_assignable_to(Intersection[Any, Unrelated], Intersection[Any, Parent])) +static_assert(is_assignable_to(Intersection[Any, Parent, Unrelated], Intersection[Any, Parent, Unrelated])) +static_assert(is_assignable_to(Intersection[Unrelated, Any], Intersection[Unrelated, Not[Any]])) +static_assert(is_assignable_to(Intersection[Literal[1], Any], Intersection[Unrelated, Not[Any]])) + +# TODO: No errors +# The condition `is_assignable_to(T & U, U)` should still be satisfied after the following transformations: +# `LiteralString & AlwaysTruthy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_assignable_to(Intersection[LiteralString, Not[Literal[""]]], AlwaysTruthy)) +# error: [static-assert-error] +static_assert(is_assignable_to(Intersection[LiteralString, Not[Literal["", "a"]]], AlwaysTruthy)) +# `LiteralString & ~AlwaysFalsy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_assignable_to(Intersection[LiteralString, Not[Literal[""]]], Not[AlwaysFalsy])) +# error: [static-assert-error] +static_assert(is_assignable_to(Intersection[LiteralString, Not[Literal["", "a"]]], Not[AlwaysFalsy])) +``` + +## General properties + +See also: our property tests in `property_tests.rs`. + +### Everything is assignable to `object` + +`object` is Python's top type; the set of all possible objects at runtime: + +```py +from ty_extensions import static_assert, is_assignable_to, Unknown +from typing import Literal, Any + +static_assert(is_assignable_to(str, object)) +static_assert(is_assignable_to(Literal[1], object)) +static_assert(is_assignable_to(object, object)) +static_assert(is_assignable_to(type, object)) +static_assert(is_assignable_to(Any, object)) +static_assert(is_assignable_to(Unknown, object)) +static_assert(is_assignable_to(type[object], object)) +static_assert(is_assignable_to(type[str], object)) +static_assert(is_assignable_to(type[Any], object)) +``` + +### Every type is assignable to `Any` / `Unknown` + +`Any` and `Unknown` are gradual types. They could materialize to any given type at runtime, and so +any type is assignable to them: + +```py +from ty_extensions import static_assert, is_assignable_to, Unknown +from typing import Literal, Any + +static_assert(is_assignable_to(str, Any)) +static_assert(is_assignable_to(Literal[1], Any)) +static_assert(is_assignable_to(object, Any)) +static_assert(is_assignable_to(type, Any)) +static_assert(is_assignable_to(Any, Any)) +static_assert(is_assignable_to(Unknown, Any)) +static_assert(is_assignable_to(type[object], Any)) +static_assert(is_assignable_to(type[str], Any)) +static_assert(is_assignable_to(type[Any], Any)) + +static_assert(is_assignable_to(str, Unknown)) +static_assert(is_assignable_to(Literal[1], Unknown)) +static_assert(is_assignable_to(object, Unknown)) +static_assert(is_assignable_to(type, Unknown)) +static_assert(is_assignable_to(Any, Unknown)) +static_assert(is_assignable_to(Unknown, Unknown)) +static_assert(is_assignable_to(type[object], Unknown)) +static_assert(is_assignable_to(type[str], Unknown)) +static_assert(is_assignable_to(type[Any], Unknown)) +``` + +### `Never` is assignable to every type + +`Never` is Python's bottom type: the empty set, a type with no inhabitants. It is therefore +assignable to any arbitrary type. + +```py +from ty_extensions import static_assert, is_assignable_to, Unknown +from typing_extensions import Never, Any, Literal + +static_assert(is_assignable_to(Never, str)) +static_assert(is_assignable_to(Never, Literal[1])) +static_assert(is_assignable_to(Never, object)) +static_assert(is_assignable_to(Never, type)) +static_assert(is_assignable_to(Never, Any)) +static_assert(is_assignable_to(Never, Unknown)) +static_assert(is_assignable_to(Never, type[object])) +static_assert(is_assignable_to(Never, type[str])) +static_assert(is_assignable_to(Never, type[Any])) +``` + +## Callable + +The examples provided below are only a subset of the possible cases and include the ones with +gradual types. The cases with fully static types and using different combinations of parameter kinds +are covered in the [subtyping tests](./is_subtype_of.md#callable). + +### Return type + +```py +from ty_extensions import CallableTypeOf, Unknown, static_assert, is_assignable_to +from typing import Any, Callable + +static_assert(is_assignable_to(Callable[[], Any], Callable[[], int])) +static_assert(is_assignable_to(Callable[[], int], Callable[[], Any])) + +static_assert(is_assignable_to(Callable[[], int], Callable[[], float])) +static_assert(not is_assignable_to(Callable[[], float], Callable[[], int])) +``` + +The return types should be checked even if the parameter types uses gradual form (`...`). + +```py +static_assert(is_assignable_to(Callable[..., int], Callable[..., float])) +static_assert(not is_assignable_to(Callable[..., float], Callable[..., int])) +``` + +And, if there is no return type, the return type is `Unknown`. + +```py +static_assert(is_assignable_to(Callable[[], Unknown], Callable[[], int])) +static_assert(is_assignable_to(Callable[[], int], Callable[[], Unknown])) +``` + +### Parameter types + +A `Callable` which uses the gradual form (`...`) for the parameter types is consistent with any +input signature. + +```py +from ty_extensions import CallableTypeOf, static_assert, is_assignable_to +from typing import Any, Callable + +static_assert(is_assignable_to(Callable[[], None], Callable[..., None])) +static_assert(is_assignable_to(Callable[..., None], Callable[..., None])) +static_assert(is_assignable_to(Callable[[int, float, str], None], Callable[..., None])) +``` + +Even if it includes any other parameter kinds. + +```py +def positional_only(a: int, b: int, /) -> None: ... +def positional_or_keyword(a: int, b: int) -> None: ... +def variadic(*args: int) -> None: ... +def keyword_only(*, a: int, b: int) -> None: ... +def keyword_variadic(**kwargs: int) -> None: ... +def mixed(a: int, /, b: int, *args: int, c: int, **kwargs: int) -> None: ... + +static_assert(is_assignable_to(CallableTypeOf[positional_only], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[positional_or_keyword], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[variadic], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[keyword_only], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[keyword_variadic], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[mixed], Callable[..., None])) +``` + +And, even if the parameters are unannotated. + +```py +def positional_only(a, b, /) -> None: ... +def positional_or_keyword(a, b) -> None: ... +def variadic(*args) -> None: ... +def keyword_only(*, a, b) -> None: ... +def keyword_variadic(**kwargs) -> None: ... +def mixed(a, /, b, *args, c, **kwargs) -> None: ... + +static_assert(is_assignable_to(CallableTypeOf[positional_only], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[positional_or_keyword], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[variadic], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[keyword_only], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[keyword_variadic], Callable[..., None])) +static_assert(is_assignable_to(CallableTypeOf[mixed], Callable[..., None])) +``` + +### Function types + +```py +from typing import Any, Callable + +def f(x: Any) -> str: + return "" + +def g(x: Any) -> int: + return 1 + +c: Callable[[Any], str] = f + +# error: [invalid-assignment] "Object of type `def g(x: Any) -> int` is not assignable to `(Any, /) -> str`" +c: Callable[[Any], str] = g +``` + +### Method types + +```py +from typing import Any, Callable + +class A: + def f(self, x: Any) -> str: + return "" + + def g(self, x: Any) -> int: + return 1 + +c: Callable[[Any], str] = A().f + +# error: [invalid-assignment] "Object of type `bound method A.g(x: Any) -> int` is not assignable to `(Any, /) -> str`" +c: Callable[[Any], str] = A().g +``` + +### Class literal types + +```py +from typing import Any, Callable + +c: Callable[[str], Any] = str +c: Callable[[str], Any] = int + +# error: [invalid-assignment] +c: Callable[[str], Any] = object +``` + +### Overloads + +`overloaded.pyi`: + +```pyi +from typing import Any, overload + +@overload +def overloaded() -> None: ... +@overload +def overloaded(a: str) -> str: ... +@overload +def overloaded(a: str, b: Any) -> str: ... +``` + +```py +from overloaded import overloaded +from typing import Any, Callable + +c: Callable[[], None] = overloaded +c: Callable[[str], str] = overloaded +c: Callable[[str, Any], Any] = overloaded +c: Callable[..., str] = overloaded + +# error: [invalid-assignment] +c: Callable[..., int] = overloaded + +# error: [invalid-assignment] +c: Callable[[int], str] = overloaded +``` + +### Classes with `__call__` + +```py +from typing import Callable, Any +from ty_extensions import static_assert, is_assignable_to + +class TakesAny: + def __call__(self, a: Any) -> str: + return "" + +class ReturnsAny: + def __call__(self, a: str) -> Any: ... + +static_assert(is_assignable_to(TakesAny, Callable[[int], str])) +static_assert(not is_assignable_to(TakesAny, Callable[[int], int])) + +static_assert(is_assignable_to(ReturnsAny, Callable[[str], int])) +static_assert(not is_assignable_to(ReturnsAny, Callable[[int], int])) + +from functools import partial + +def f(x: int, y: str) -> None: ... + +c1: Callable[[int], None] = partial(f, y="a") +``` + +## Generics + +### Assignability of generic types parameterized by gradual types + +If `Foo` is a class that is generic over a single type variable `T`, `Foo[X]` will be assignable to +`Foo[Y]` iff `X` is assignable to `Y` AND `Y` is assignable to `X`. + +This might appear to be the same principle as the "gradual equivalence" relation, but it is subtly +different. Two gradual types can be said to be "gradually equivalent" iff they have exactly the same +sets of possible materializations -- if they represent the same sets of possible types (the same +sets of sets of possible runtime objects). By this principle `int | Any` is gradually equivalent to +`Unknown | int`, since they have exactly the same sets of posisble materializations. But +`bool | Any` is not equivalent to `int`, since there are many possible materializations of +`bool | Any` that are not assignable to `int`. It is therefore *not* necessary for `X` to be +gradually equivalent to `Y` in order for `Foo[X]` to be assignable to `Foo[Y]`; it is *only* +necessary for `X` and `Y` to be mutually assignable. + +```py +from typing import Any, TypeVar, Generic +from ty_extensions import static_assert, is_assignable_to + +InvariantTypeVar = TypeVar("InvariantTypeVar") + +class Foo(Generic[InvariantTypeVar]): + x: InvariantTypeVar + +class A: ... +class B(A): ... +class C: ... + +static_assert(is_assignable_to(Foo[A], Foo[B | Any])) +static_assert(is_assignable_to(Foo[B | Any], Foo[A])) +static_assert(is_assignable_to(Foo[Foo[Any]], Foo[Foo[A | C]])) +static_assert(is_assignable_to(Foo[Foo[A | C]], Foo[Foo[Any]])) +static_assert(is_assignable_to(Foo[tuple[A]], Foo[tuple[Any] | tuple[B]])) +static_assert(is_assignable_to(Foo[tuple[Any] | tuple[B]], Foo[tuple[A]])) + +def f(obj: Foo[A]): + g(obj) + +def g(obj: Foo[B | Any]): + f(obj) + +def f2(obj: Foo[Foo[Any]]): + g2(obj) + +def g2(obj: Foo[Foo[A | C]]): + f2(obj) + +def f3(obj: Foo[tuple[Any] | tuple[B]]): + g3(obj) + +def g3(obj: Foo[tuple[A]]): + f3(obj) +``` + +[typing documentation]: https://typing.python.org/en/latest/spec/concepts.html#the-assignable-to-or-consistent-subtyping-relation diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_disjoint_from.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_disjoint_from.md new file mode 100644 index 0000000000000..a5935725b6ae3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_disjoint_from.md @@ -0,0 +1,441 @@ +# Disjointness relation + +Two types `S` and `T` are disjoint if their intersection `S & T` is empty (equivalent to `Never`). +This means that it is known that no possible runtime object inhabits both types simultaneously. + +## Basic builtin types + +```py +from typing_extensions import Literal, LiteralString, Any +from ty_extensions import Intersection, Not, TypeOf, is_disjoint_from, static_assert + +static_assert(is_disjoint_from(bool, str)) +static_assert(not is_disjoint_from(bool, bool)) +static_assert(not is_disjoint_from(bool, int)) +static_assert(not is_disjoint_from(bool, object)) + +static_assert(not is_disjoint_from(Any, bool)) +static_assert(not is_disjoint_from(Any, Any)) +static_assert(not is_disjoint_from(Any, Not[Any])) + +static_assert(not is_disjoint_from(LiteralString, LiteralString)) +static_assert(not is_disjoint_from(str, LiteralString)) +static_assert(not is_disjoint_from(str, type)) +static_assert(not is_disjoint_from(str, type[Any])) +``` + +## Class hierarchies + +```py +from ty_extensions import is_disjoint_from, static_assert, Intersection, is_subtype_of +from typing import final + +class A: ... +class B1(A): ... +class B2(A): ... + +# B1 and B2 are subclasses of A, so they are not disjoint from A: +static_assert(not is_disjoint_from(A, B1)) +static_assert(not is_disjoint_from(A, B2)) + +# The two subclasses B1 and B2 are also not disjoint ... +static_assert(not is_disjoint_from(B1, B2)) + +# ... because they could share a common subclass ... +class C(B1, B2): ... + +# ... which lies in their intersection: +static_assert(is_subtype_of(C, Intersection[B1, B2])) + +# However, if a class is marked final, it can not be subclassed ... +@final +class FinalSubclass(A): ... + +static_assert(not is_disjoint_from(FinalSubclass, A)) + +# ... which makes it disjoint from B1, B2: +static_assert(is_disjoint_from(B1, FinalSubclass)) +static_assert(is_disjoint_from(B2, FinalSubclass)) + +# Instance types can also be disjoint if they have disjoint metaclasses. +# No possible subclass of `Meta1` and `Meta2` could exist, therefore +# no possible subclass of `UsesMeta1` and `UsesMeta2` can exist: +class Meta1(type): ... +class UsesMeta1(metaclass=Meta1): ... + +@final +class Meta2(type): ... + +class UsesMeta2(metaclass=Meta2): ... + +static_assert(is_disjoint_from(UsesMeta1, UsesMeta2)) +``` + +## Tuple types + +```py +from typing_extensions import Literal, Never +from ty_extensions import TypeOf, is_disjoint_from, static_assert + +static_assert(is_disjoint_from(tuple[()], TypeOf[object])) +static_assert(is_disjoint_from(tuple[()], TypeOf[Literal])) + +static_assert(is_disjoint_from(tuple[None], None)) +static_assert(is_disjoint_from(tuple[None], Literal[b"a"])) +static_assert(is_disjoint_from(tuple[None], Literal["a"])) +static_assert(is_disjoint_from(tuple[None], Literal[1])) +static_assert(is_disjoint_from(tuple[None], Literal[True])) + +static_assert(is_disjoint_from(tuple[Literal[1]], tuple[Literal[2]])) +static_assert(is_disjoint_from(tuple[Literal[1], Literal[2]], tuple[Literal[1]])) +static_assert(is_disjoint_from(tuple[Literal[1], Literal[2]], tuple[Literal[1], Literal[3]])) + +static_assert(not is_disjoint_from(tuple[Literal[1], Literal[2]], tuple[Literal[1], int])) +static_assert(not is_disjoint_from(tuple[Literal[1], Literal[2]], tuple[int, ...])) + +# TODO: should pass +static_assert(is_disjoint_from(tuple[int, int], tuple[None, ...])) # error: [static-assert-error] +``` + +## Unions + +```py +from typing_extensions import Literal +from ty_extensions import Intersection, is_disjoint_from, static_assert + +static_assert(is_disjoint_from(Literal[1, 2], Literal[3])) +static_assert(is_disjoint_from(Literal[1, 2], Literal[3, 4])) + +static_assert(not is_disjoint_from(Literal[1, 2], Literal[2])) +static_assert(not is_disjoint_from(Literal[1, 2], Literal[2, 3])) +``` + +## Intersections + +```py +from typing_extensions import Literal, final, Any +from ty_extensions import Intersection, is_disjoint_from, static_assert, Not + +@final +class P: ... + +@final +class Q: ... + +@final +class R: ... + +# For three pairwise disjoint classes ... +static_assert(is_disjoint_from(P, Q)) +static_assert(is_disjoint_from(P, R)) +static_assert(is_disjoint_from(Q, R)) + +# ... their intersections are also disjoint: +static_assert(is_disjoint_from(Intersection[P, Q], R)) +static_assert(is_disjoint_from(Intersection[P, R], Q)) +static_assert(is_disjoint_from(Intersection[Q, R], P)) + +# On the other hand, for non-disjoint classes ... +class X: ... +class Y: ... +class Z: ... + +static_assert(not is_disjoint_from(X, Y)) +static_assert(not is_disjoint_from(X, Z)) +static_assert(not is_disjoint_from(Y, Z)) + +# ... their intersections are also not disjoint: +static_assert(not is_disjoint_from(Intersection[X, Y], Z)) +static_assert(not is_disjoint_from(Intersection[X, Z], Y)) +static_assert(not is_disjoint_from(Intersection[Y, Z], X)) + +# If one side has a positive fully-static element and the other side has a negative of that element, they are disjoint +static_assert(is_disjoint_from(int, Not[int])) +static_assert(is_disjoint_from(Intersection[X, Y, Not[Z]], Intersection[X, Z])) +static_assert(is_disjoint_from(Intersection[X, Not[Literal[1]]], Literal[1])) + +class Parent: ... +class Child(Parent): ... + +static_assert(not is_disjoint_from(Parent, Child)) +static_assert(not is_disjoint_from(Parent, Not[Child])) +static_assert(not is_disjoint_from(Not[Parent], Not[Child])) +static_assert(is_disjoint_from(Not[Parent], Child)) +static_assert(is_disjoint_from(Intersection[X, Not[Parent]], Child)) +static_assert(is_disjoint_from(Intersection[X, Not[Parent]], Intersection[X, Child])) + +static_assert(not is_disjoint_from(Intersection[Any, X], Intersection[Any, Not[Y]])) +static_assert(not is_disjoint_from(Intersection[Any, Not[Y]], Intersection[Any, X])) + +static_assert(is_disjoint_from(Intersection[int, Any], Not[int])) +static_assert(is_disjoint_from(Not[int], Intersection[int, Any])) +``` + +## Special types + +### `Never` + +`Never` is disjoint from every type, including itself. + +```py +from typing_extensions import Never +from ty_extensions import is_disjoint_from, static_assert + +static_assert(is_disjoint_from(Never, Never)) +static_assert(is_disjoint_from(Never, None)) +static_assert(is_disjoint_from(Never, int)) +static_assert(is_disjoint_from(Never, object)) +``` + +### `None` + +```py +from typing_extensions import Literal, LiteralString +from ty_extensions import is_disjoint_from, static_assert, Intersection, Not + +static_assert(is_disjoint_from(None, Literal[True])) +static_assert(is_disjoint_from(None, Literal[1])) +static_assert(is_disjoint_from(None, Literal["test"])) +static_assert(is_disjoint_from(None, Literal[b"test"])) +static_assert(is_disjoint_from(None, LiteralString)) +static_assert(is_disjoint_from(None, int)) +static_assert(is_disjoint_from(None, type[object])) + +static_assert(not is_disjoint_from(None, None)) +static_assert(not is_disjoint_from(None, int | None)) +static_assert(not is_disjoint_from(None, object)) + +static_assert(is_disjoint_from(Intersection[int, Not[str]], None)) +static_assert(is_disjoint_from(None, Intersection[int, Not[str]])) +``` + +### Literals + +```py +from typing_extensions import Literal, LiteralString +from ty_extensions import Intersection, Not, TypeOf, is_disjoint_from, static_assert, AlwaysFalsy, AlwaysTruthy + +static_assert(is_disjoint_from(Literal[True], Literal[False])) +static_assert(is_disjoint_from(Literal[True], Literal[1])) +static_assert(is_disjoint_from(Literal[False], Literal[0])) + +static_assert(is_disjoint_from(Literal[1], Literal[2])) + +static_assert(is_disjoint_from(Literal["a"], Literal["b"])) + +static_assert(is_disjoint_from(Literal[b"a"], LiteralString)) +static_assert(is_disjoint_from(Literal[b"a"], Literal[b"b"])) +static_assert(is_disjoint_from(Literal[b"a"], Literal["a"])) + +static_assert(is_disjoint_from(type[object], TypeOf[Literal])) +static_assert(is_disjoint_from(type[str], LiteralString)) + +static_assert(not is_disjoint_from(Literal[True], Literal[True])) +static_assert(not is_disjoint_from(Literal[False], Literal[False])) +static_assert(not is_disjoint_from(Literal[True], bool)) +static_assert(not is_disjoint_from(Literal[True], int)) + +static_assert(not is_disjoint_from(Literal[1], Literal[1])) + +static_assert(not is_disjoint_from(Literal["a"], Literal["a"])) +static_assert(not is_disjoint_from(Literal["a"], LiteralString)) +static_assert(not is_disjoint_from(Literal["a"], str)) + +# TODO: No errors +# error: [static-assert-error] +static_assert(is_disjoint_from(AlwaysFalsy, Intersection[LiteralString, Not[Literal[""]]])) +# error: [static-assert-error] +static_assert(is_disjoint_from(Intersection[Not[Literal[True]], Not[Literal[False]]], bool)) +# error: [static-assert-error] +static_assert(is_disjoint_from(Intersection[AlwaysFalsy, Not[Literal[False]]], bool)) +# error: [static-assert-error] +static_assert(is_disjoint_from(Intersection[AlwaysTruthy, Not[Literal[True]]], bool)) + +# TODO: No errors +# The condition `is_disjoint(T, Not[T])` must still be satisfied after the following transformations: +# `LiteralString & AlwaysTruthy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_disjoint_from(Intersection[LiteralString, AlwaysTruthy], Not[LiteralString] | AlwaysFalsy)) +# `LiteralString & ~AlwaysFalsy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_disjoint_from(Intersection[LiteralString, Not[AlwaysFalsy]], Not[LiteralString] | AlwaysFalsy)) +``` + +### Class, module and function literals + +```toml +[environment] +python-version = "3.12" +``` + +```py +from types import ModuleType, FunctionType +from ty_extensions import TypeOf, is_disjoint_from, static_assert + +class A: ... +class B: ... + +type LiteralA = TypeOf[A] +type LiteralB = TypeOf[B] + +# Class literals for different classes are always disjoint. +# They are singleton types that only contain the class object itself. +static_assert(is_disjoint_from(LiteralA, LiteralB)) + +# The class A is a subclass of A, so A is not disjoint from type[A]: +static_assert(not is_disjoint_from(LiteralA, type[A])) + +# The class A is disjoint from type[B] because it's not a subclass of B: +static_assert(is_disjoint_from(LiteralA, type[B])) + +# However, type[A] is not disjoint from type[B], as there could be +# classes that inherit from both A and B: +static_assert(not is_disjoint_from(type[A], type[B])) + +import random +import math + +static_assert(is_disjoint_from(TypeOf[random], TypeOf[math])) +static_assert(not is_disjoint_from(TypeOf[random], ModuleType)) +static_assert(not is_disjoint_from(TypeOf[random], object)) + +def f(): ... +def g(): ... + +static_assert(is_disjoint_from(TypeOf[f], TypeOf[g])) +static_assert(not is_disjoint_from(TypeOf[f], FunctionType)) +static_assert(not is_disjoint_from(TypeOf[f], object)) +``` + +### `AlwaysTruthy` and `AlwaysFalsy` + +```py +from ty_extensions import AlwaysFalsy, AlwaysTruthy, is_disjoint_from, static_assert +from typing import Literal + +static_assert(is_disjoint_from(None, AlwaysTruthy)) +static_assert(not is_disjoint_from(None, AlwaysFalsy)) + +static_assert(is_disjoint_from(AlwaysFalsy, AlwaysTruthy)) +static_assert(not is_disjoint_from(str, AlwaysFalsy)) +static_assert(not is_disjoint_from(str, AlwaysTruthy)) + +static_assert(is_disjoint_from(Literal[1, 2], AlwaysFalsy)) +static_assert(not is_disjoint_from(Literal[0, 1], AlwaysTruthy)) +``` + +### Instance types versus `type[T]` types + +An instance type is disjoint from a `type[T]` type if the instance type is `@final` and the class of +the instance type is not a subclass of `T`'s metaclass. + +```py +from typing import final +from ty_extensions import is_disjoint_from, static_assert + +@final +class Foo: ... + +static_assert(is_disjoint_from(Foo, type[int])) +static_assert(is_disjoint_from(type[object], Foo)) +static_assert(is_disjoint_from(type[dict], Foo)) + +# Instance types can be disjoint from `type[]` types +# even if the instance type is a subtype of `type` + +@final +class Meta1(type): ... + +class UsesMeta1(metaclass=Meta1): ... + +static_assert(not is_disjoint_from(Meta1, type[UsesMeta1])) + +class Meta2(type): ... +class UsesMeta2(metaclass=Meta2): ... + +static_assert(not is_disjoint_from(Meta2, type[UsesMeta2])) +static_assert(is_disjoint_from(Meta1, type[UsesMeta2])) +``` + +### `type[T]` versus `type[S]` + +By the same token, `type[T]` is disjoint from `type[S]` if `T` is `@final`, `S` is `@final`, or the +metaclass of `T` is disjoint from the metaclass of `S`. + +```py +from typing import final +from ty_extensions import static_assert, is_disjoint_from + +@final +class Meta1(type): ... + +class Meta2(type): ... + +static_assert(is_disjoint_from(type[Meta1], type[Meta2])) + +class UsesMeta1(metaclass=Meta1): ... +class UsesMeta2(metaclass=Meta2): ... + +static_assert(is_disjoint_from(type[UsesMeta1], type[UsesMeta2])) +``` + +### `property` + +```py +from ty_extensions import is_disjoint_from, static_assert, TypeOf +from typing import final + +class C: + @property + def prop(self) -> int: + return 1 + +reveal_type(C.prop) # revealed: property + +@final +class D: + pass + +static_assert(not is_disjoint_from(int, TypeOf[C.prop])) +static_assert(not is_disjoint_from(TypeOf[C.prop], int)) +static_assert(is_disjoint_from(TypeOf[C.prop], D)) +static_assert(is_disjoint_from(D, TypeOf[C.prop])) +``` + +## Callables + +No two callable types are disjoint because there exists a non-empty callable type +`(*args: object, **kwargs: object) -> Never` that is a subtype of all fully static callable types. +As such, for any two callable types, it is possible to conceive of a runtime callable object that +would inhabit both types simultaneously. + +```py +from ty_extensions import CallableTypeOf, is_disjoint_from, static_assert +from typing_extensions import Callable, Literal, Never + +def mixed(a: int, /, b: str, *args: int, c: int = 2, **kwargs: int) -> None: ... + +static_assert(not is_disjoint_from(Callable[[], Never], CallableTypeOf[mixed])) +static_assert(not is_disjoint_from(Callable[[int, str], float], CallableTypeOf[mixed])) + +# Using gradual form +static_assert(not is_disjoint_from(Callable[..., None], Callable[[], None])) +static_assert(not is_disjoint_from(Callable[..., None], Callable[..., None])) +static_assert(not is_disjoint_from(Callable[..., None], Callable[[Literal[1]], None])) + +# Using `Never` +static_assert(not is_disjoint_from(Callable[[], Never], Callable[[], Never])) +static_assert(not is_disjoint_from(Callable[[Never], str], Callable[[Never], int])) +``` + +A callable type is disjoint from all literal types. + +```py +from ty_extensions import CallableTypeOf, is_disjoint_from, static_assert +from typing_extensions import Callable, Literal, Never + +static_assert(is_disjoint_from(Callable[[], None], Literal[""])) +static_assert(is_disjoint_from(Callable[[], None], Literal[b""])) +static_assert(is_disjoint_from(Callable[[], None], Literal[1])) +static_assert(is_disjoint_from(Callable[[], None], Literal[True])) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_equivalent_to.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_equivalent_to.md new file mode 100644 index 0000000000000..558c455c4ed62 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_equivalent_to.md @@ -0,0 +1,363 @@ +# Equivalence relation + +`is_equivalent_to` implements [the equivalence relation] for fully static types. + +Two types `A` and `B` are equivalent iff `A` is a subtype of `B` and `B` is a subtype of `A`. + +## Basic + +```py +from typing import Any +from typing_extensions import Literal +from ty_extensions import Unknown, is_equivalent_to, static_assert + +static_assert(is_equivalent_to(Literal[1, 2], Literal[1, 2])) +static_assert(is_equivalent_to(type[object], type)) + +static_assert(not is_equivalent_to(Any, Any)) +static_assert(not is_equivalent_to(Unknown, Unknown)) +static_assert(not is_equivalent_to(Any, None)) +static_assert(not is_equivalent_to(Literal[1, 2], Literal[1, 0])) +static_assert(not is_equivalent_to(Literal[1, 2], Literal[1, 2, 3])) +``` + +## Equivalence is commutative + +```py +from typing_extensions import Literal +from ty_extensions import is_equivalent_to, static_assert + +static_assert(is_equivalent_to(type, type[object])) +static_assert(not is_equivalent_to(Literal[1, 0], Literal[1, 2])) +static_assert(not is_equivalent_to(Literal[1, 2, 3], Literal[1, 2])) +``` + +## Differently ordered intersections and unions are equivalent + +```py +from ty_extensions import is_equivalent_to, static_assert, Intersection, Not + +class P: ... +class Q: ... +class R: ... +class S: ... + +static_assert(is_equivalent_to(P | Q | R, P | R | Q)) # 1 +static_assert(is_equivalent_to(P | Q | R, Q | P | R)) # 2 +static_assert(is_equivalent_to(P | Q | R, Q | R | P)) # 3 +static_assert(is_equivalent_to(P | Q | R, R | P | Q)) # 4 +static_assert(is_equivalent_to(P | Q | R, R | Q | P)) # 5 +static_assert(is_equivalent_to(P | R | Q, Q | P | R)) # 6 +static_assert(is_equivalent_to(P | R | Q, Q | R | P)) # 7 +static_assert(is_equivalent_to(P | R | Q, R | P | Q)) # 8 +static_assert(is_equivalent_to(P | R | Q, R | Q | P)) # 9 +static_assert(is_equivalent_to(Q | P | R, Q | R | P)) # 10 +static_assert(is_equivalent_to(Q | P | R, R | P | Q)) # 11 +static_assert(is_equivalent_to(Q | P | R, R | Q | P)) # 12 +static_assert(is_equivalent_to(Q | R | P, R | P | Q)) # 13 +static_assert(is_equivalent_to(Q | R | P, R | Q | P)) # 14 +static_assert(is_equivalent_to(R | P | Q, R | Q | P)) # 15 + +static_assert(is_equivalent_to(str | None, None | str)) + +static_assert(is_equivalent_to(Intersection[P, Q], Intersection[Q, P])) +static_assert(is_equivalent_to(Intersection[Q, Not[P]], Intersection[Not[P], Q])) +static_assert(is_equivalent_to(Intersection[Q, R, Not[P]], Intersection[Not[P], R, Q])) +static_assert(is_equivalent_to(Intersection[Q | R, Not[P | S]], Intersection[Not[S | P], R | Q])) +``` + +## Tuples containing equivalent but differently ordered unions/intersections are equivalent + +```py +from ty_extensions import is_equivalent_to, TypeOf, static_assert, Intersection, Not +from typing import Literal + +class P: ... +class Q: ... +class R: ... +class S: ... + +static_assert(is_equivalent_to(tuple[P | Q], tuple[Q | P])) +static_assert(is_equivalent_to(tuple[P | None], tuple[None | P])) +static_assert( + is_equivalent_to(tuple[Intersection[P, Q] | Intersection[R, Not[S]]], tuple[Intersection[Not[S], R] | Intersection[Q, P]]) +) +``` + +## Unions containing tuples containing tuples containing unions (etc.) + +```py +from ty_extensions import is_equivalent_to, static_assert, Intersection + +class P: ... +class Q: ... + +static_assert( + is_equivalent_to( + tuple[tuple[tuple[P | Q]]] | P, + tuple[tuple[tuple[Q | P]]] | P, + ) +) +static_assert( + is_equivalent_to( + tuple[tuple[tuple[tuple[tuple[Intersection[P, Q]]]]]], + tuple[tuple[tuple[tuple[tuple[Intersection[Q, P]]]]]], + ) +) +``` + +## Intersections containing tuples containing unions + +```py +from ty_extensions import is_equivalent_to, static_assert, Intersection + +class P: ... +class Q: ... +class R: ... + +static_assert(is_equivalent_to(Intersection[tuple[P | Q], R], Intersection[tuple[Q | P], R])) +``` + +## Unions containing generic instances parameterized by unions + +```toml +[environment] +python-version = "3.12" +``` + +```py +from ty_extensions import is_equivalent_to, static_assert + +class A: ... +class B: ... +class Foo[T]: ... + +static_assert(is_equivalent_to(A | Foo[A | B], Foo[B | A] | A)) +``` + +## Callable + +### Equivalent + +For an equivalence relationship, the default value does not necessarily need to be the same but if +the parameter in one of the callable has a default value then the corresponding parameter in the +other callable should also have a default value. + +```py +from ty_extensions import CallableTypeOf, is_equivalent_to, static_assert +from typing import Callable + +def f1(a: int = 1) -> None: ... +def f2(a: int = 2) -> None: ... + +static_assert(is_equivalent_to(CallableTypeOf[f1], CallableTypeOf[f2])) +static_assert(is_equivalent_to(CallableTypeOf[f1] | bool | CallableTypeOf[f2], CallableTypeOf[f2] | bool | CallableTypeOf[f1])) +``` + +The names of the positional-only, variadic and keyword-variadic parameters does not need to be the +same. + +```py +def f3(a1: int, /, *args1: int, **kwargs2: int) -> None: ... +def f4(a2: int, /, *args2: int, **kwargs1: int) -> None: ... + +static_assert(is_equivalent_to(CallableTypeOf[f3], CallableTypeOf[f4])) +static_assert(is_equivalent_to(CallableTypeOf[f3] | bool | CallableTypeOf[f4], CallableTypeOf[f4] | bool | CallableTypeOf[f3])) +``` + +Putting it all together, the following two callables are equivalent: + +```py +def f5(a1: int, /, b: float, c: bool = False, *args1: int, d: int = 1, e: str, **kwargs1: float) -> None: ... +def f6(a2: int, /, b: float, c: bool = True, *args2: int, d: int = 2, e: str, **kwargs2: float) -> None: ... + +static_assert(is_equivalent_to(CallableTypeOf[f5], CallableTypeOf[f6])) +static_assert(is_equivalent_to(CallableTypeOf[f5] | bool | CallableTypeOf[f6], CallableTypeOf[f6] | bool | CallableTypeOf[f5])) +``` + +### Not equivalent + +There are multiple cases when two callable types are not equivalent which are enumerated below. + +```py +from ty_extensions import CallableTypeOf, is_equivalent_to, static_assert +from typing import Callable +``` + +When the number of parameters is different: + +```py +def f1(a: int) -> None: ... +def f2(a: int, b: int) -> None: ... + +static_assert(not is_equivalent_to(CallableTypeOf[f1], CallableTypeOf[f2])) +``` + +When either of the callable types uses a gradual form for the parameters: + +```py +static_assert(not is_equivalent_to(Callable[..., None], Callable[[int], None])) +static_assert(not is_equivalent_to(Callable[[int], None], Callable[..., None])) +``` + +When the return types are not equivalent or absent in one or both of the callable types: + +```py +def f3(): ... +def f4() -> None: ... + +static_assert(not is_equivalent_to(Callable[[], int], Callable[[], None])) +static_assert(not is_equivalent_to(CallableTypeOf[f3], CallableTypeOf[f3])) +static_assert(not is_equivalent_to(CallableTypeOf[f3], CallableTypeOf[f4])) +static_assert(not is_equivalent_to(CallableTypeOf[f4], CallableTypeOf[f3])) +``` + +When the parameter names are different: + +```py +def f5(a: int) -> None: ... +def f6(b: int) -> None: ... + +static_assert(not is_equivalent_to(CallableTypeOf[f5], CallableTypeOf[f6])) +``` + +When only one of the callable types has parameter names: + +```py +static_assert(not is_equivalent_to(CallableTypeOf[f5], Callable[[int], None])) +``` + +When the parameter kinds are different: + +```py +def f7(a: int, /) -> None: ... +def f8(a: int) -> None: ... + +static_assert(not is_equivalent_to(CallableTypeOf[f7], CallableTypeOf[f8])) +``` + +When the annotated types of the parameters are not equivalent or absent in one or both of the +callable types: + +```py +def f9(a: int) -> None: ... +def f10(a: str) -> None: ... +def f11(a) -> None: ... + +static_assert(not is_equivalent_to(CallableTypeOf[f9], CallableTypeOf[f10])) +static_assert(not is_equivalent_to(CallableTypeOf[f10], CallableTypeOf[f11])) +static_assert(not is_equivalent_to(CallableTypeOf[f11], CallableTypeOf[f10])) +static_assert(not is_equivalent_to(CallableTypeOf[f11], CallableTypeOf[f11])) +``` + +When the default value for a parameter is present only in one of the callable type: + +```py +def f12(a: int) -> None: ... +def f13(a: int = 2) -> None: ... + +static_assert(not is_equivalent_to(CallableTypeOf[f12], CallableTypeOf[f13])) +static_assert(not is_equivalent_to(CallableTypeOf[f13], CallableTypeOf[f12])) +``` + +### Unions containing `Callable`s containing unions + +Differently ordered unions inside `Callable`s inside unions can still be equivalent: + +```py +from typing import Callable +from ty_extensions import is_equivalent_to, static_assert + +static_assert(is_equivalent_to(int | Callable[[int | str], None], Callable[[str | int], None] | int)) +``` + +### Overloads + +#### One overload + +`overloaded.pyi`: + +```pyi +from typing import overload + +class Grandparent: ... +class Parent(Grandparent): ... +class Child(Parent): ... + +@overload +def overloaded(a: Child) -> None: ... +@overload +def overloaded(a: Parent) -> None: ... +@overload +def overloaded(a: Grandparent) -> None: ... +``` + +```py +from ty_extensions import CallableTypeOf, is_equivalent_to, static_assert +from overloaded import Grandparent, Parent, Child, overloaded + +def grandparent(a: Grandparent) -> None: ... + +static_assert(is_equivalent_to(CallableTypeOf[grandparent], CallableTypeOf[overloaded])) +static_assert(is_equivalent_to(CallableTypeOf[overloaded], CallableTypeOf[grandparent])) +``` + +#### Both overloads + +`overloaded.pyi`: + +```pyi +from typing import overload + +class Grandparent: ... +class Parent(Grandparent): ... +class Child(Parent): ... + +@overload +def pg(a: Parent) -> None: ... +@overload +def pg(a: Grandparent) -> None: ... + +@overload +def cpg(a: Child) -> None: ... +@overload +def cpg(a: Parent) -> None: ... +@overload +def cpg(a: Grandparent) -> None: ... +``` + +```py +from ty_extensions import CallableTypeOf, is_equivalent_to, static_assert +from overloaded import pg, cpg + +static_assert(is_equivalent_to(CallableTypeOf[pg], CallableTypeOf[cpg])) +static_assert(is_equivalent_to(CallableTypeOf[cpg], CallableTypeOf[pg])) +``` + +## Function-literal types and bound-method types + +Function-literal types and bound-method types are always considered self-equivalent, even if they +have unannotated parameters, or parameters with not-fully-static annotations. + +```toml +[environment] +python-version = "3.12" +``` + +```py +from ty_extensions import is_equivalent_to, TypeOf, static_assert + +def f(): ... + +static_assert(is_equivalent_to(TypeOf[f], TypeOf[f])) + +class A: + def method(self) -> int: + return 42 + +static_assert(is_equivalent_to(TypeOf[A.method], TypeOf[A.method])) +type X = TypeOf[A.method] +static_assert(is_equivalent_to(X, X)) +``` + +[the equivalence relation]: https://typing.python.org/en/latest/spec/glossary.html#term-equivalent diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_fully_static.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_fully_static.md new file mode 100644 index 0000000000000..ef9f677c55eed --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_fully_static.md @@ -0,0 +1,134 @@ +# Fully-static types + +A type is fully static iff it does not contain any gradual forms. + +## Fully-static + +```py +from typing_extensions import Literal, LiteralString, Never, Callable +from ty_extensions import Intersection, Not, TypeOf, is_fully_static, static_assert + +static_assert(is_fully_static(Never)) +static_assert(is_fully_static(None)) + +static_assert(is_fully_static(Literal[1])) +static_assert(is_fully_static(Literal[True])) +static_assert(is_fully_static(Literal["abc"])) +static_assert(is_fully_static(Literal[b"abc"])) + +static_assert(is_fully_static(LiteralString)) + +static_assert(is_fully_static(str)) +static_assert(is_fully_static(object)) +static_assert(is_fully_static(type)) + +static_assert(is_fully_static(TypeOf[str])) +static_assert(is_fully_static(TypeOf[Literal])) + +static_assert(is_fully_static(str | None)) +static_assert(is_fully_static(Intersection[str, Not[LiteralString]])) + +static_assert(is_fully_static(tuple[()])) +static_assert(is_fully_static(tuple[int, object])) + +static_assert(is_fully_static(type[str])) +static_assert(is_fully_static(type[object])) +``` + +## Non-fully-static + +```py +from typing_extensions import Any, Literal, LiteralString, Callable +from ty_extensions import Intersection, Not, TypeOf, Unknown, is_fully_static, static_assert + +static_assert(not is_fully_static(Any)) +static_assert(not is_fully_static(Unknown)) + +static_assert(not is_fully_static(Any | str)) +static_assert(not is_fully_static(str | Unknown)) +static_assert(not is_fully_static(Intersection[Any, Not[LiteralString]])) + +# TODO: should pass +static_assert(not is_fully_static(tuple[Any, ...])) # error: [static-assert-error] + +static_assert(not is_fully_static(tuple[int, Any])) +static_assert(not is_fully_static(type[Any])) +``` + +## Callable + +```py +from typing_extensions import Callable, Any +from ty_extensions import Unknown, is_fully_static, static_assert + +static_assert(is_fully_static(Callable[[], int])) +static_assert(is_fully_static(Callable[[int, str], int])) + +static_assert(not is_fully_static(Callable[..., int])) +static_assert(not is_fully_static(Callable[[], Any])) +static_assert(not is_fully_static(Callable[[int, Unknown], int])) +``` + +The invalid forms of `Callable` annotation are never fully static because we represent them with the +`(...) -> Unknown` signature. + +```py +static_assert(not is_fully_static(Callable)) +# error: [invalid-type-form] +static_assert(not is_fully_static(Callable[int, int])) +``` + +Using function literals, we can check more variations of callable types as it allows us to define +parameters without annotations and no return type. + +```py +from ty_extensions import CallableTypeOf, is_fully_static, static_assert + +def f00() -> None: ... +def f01(a: int, b: str) -> None: ... +def f11(): ... +def f12(a, b): ... +def f13(a, b: int): ... +def f14(a, b: int) -> None: ... +def f15(a, b) -> None: ... + +static_assert(is_fully_static(CallableTypeOf[f00])) +static_assert(is_fully_static(CallableTypeOf[f01])) + +static_assert(not is_fully_static(CallableTypeOf[f11])) +static_assert(not is_fully_static(CallableTypeOf[f12])) +static_assert(not is_fully_static(CallableTypeOf[f13])) +static_assert(not is_fully_static(CallableTypeOf[f14])) +static_assert(not is_fully_static(CallableTypeOf[f15])) +``` + +## Overloads + +`overloaded.pyi`: + +```pyi +from typing import Any, overload + +@overload +def gradual() -> None: ... +@overload +def gradual(a: Any) -> None: ... + +@overload +def static() -> None: ... +@overload +def static(x: int) -> None: ... +@overload +def static(x: str) -> str: ... +``` + +```py +from ty_extensions import CallableTypeOf, TypeOf, is_fully_static, static_assert +from overloaded import gradual, static + +static_assert(is_fully_static(TypeOf[gradual])) +static_assert(is_fully_static(TypeOf[static])) + +static_assert(not is_fully_static(CallableTypeOf[gradual])) +static_assert(is_fully_static(CallableTypeOf[static])) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_gradual_equivalent_to.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_gradual_equivalent_to.md new file mode 100644 index 0000000000000..e3de427e4ee92 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_gradual_equivalent_to.md @@ -0,0 +1,159 @@ +# Gradual equivalence relation + +Two gradual types `A` and `B` are equivalent if all [materializations] of `A` are also +materializations of `B`, and all materializations of `B` are also materializations of `A`. + +## Basic + +```py +from typing import Any +from typing_extensions import Literal, LiteralString, Never +from ty_extensions import AlwaysFalsy, AlwaysTruthy, TypeOf, Unknown, is_gradual_equivalent_to, static_assert + +static_assert(is_gradual_equivalent_to(Any, Any)) +static_assert(is_gradual_equivalent_to(Unknown, Unknown)) +static_assert(is_gradual_equivalent_to(Any, Unknown)) + +static_assert(is_gradual_equivalent_to(Never, Never)) +static_assert(is_gradual_equivalent_to(AlwaysTruthy, AlwaysTruthy)) +static_assert(is_gradual_equivalent_to(AlwaysFalsy, AlwaysFalsy)) +static_assert(is_gradual_equivalent_to(LiteralString, LiteralString)) + +static_assert(is_gradual_equivalent_to(Literal[True], Literal[True])) +static_assert(is_gradual_equivalent_to(Literal[False], Literal[False])) +static_assert(is_gradual_equivalent_to(TypeOf[0:1:2], TypeOf[0:1:2])) + +static_assert(is_gradual_equivalent_to(TypeOf[str], TypeOf[str])) +static_assert(is_gradual_equivalent_to(type, type[object])) + +static_assert(not is_gradual_equivalent_to(type, type[Any])) +static_assert(not is_gradual_equivalent_to(type[object], type[Any])) +``` + +## Unions and intersections + +```py +from typing import Any +from ty_extensions import Intersection, Not, Unknown, is_gradual_equivalent_to, static_assert + +static_assert(is_gradual_equivalent_to(str | int, str | int)) +static_assert(is_gradual_equivalent_to(str | int | Any, str | int | Unknown)) +static_assert(is_gradual_equivalent_to(str | int, int | str)) +static_assert( + is_gradual_equivalent_to(Intersection[str, int, Not[bytes], Not[None]], Intersection[int, str, Not[None], Not[bytes]]) +) +static_assert(is_gradual_equivalent_to(Intersection[str | int, Not[type[Any]]], Intersection[int | str, Not[type[Unknown]]])) + +static_assert(not is_gradual_equivalent_to(str | int, int | str | bytes)) +static_assert(not is_gradual_equivalent_to(str | int | bytes, int | str | dict)) + +static_assert(is_gradual_equivalent_to(Unknown, Unknown | Any)) +static_assert(is_gradual_equivalent_to(Unknown, Intersection[Unknown, Any])) +``` + +## Tuples + +```py +from ty_extensions import Unknown, is_gradual_equivalent_to, static_assert +from typing import Any + +static_assert(is_gradual_equivalent_to(tuple[str, Any], tuple[str, Unknown])) + +static_assert(not is_gradual_equivalent_to(tuple[str, int], tuple[str, int, bytes])) +static_assert(not is_gradual_equivalent_to(tuple[str, int], tuple[int, str])) +``` + +## Callable + +The examples provided below are only a subset of the possible cases and only include the ones with +gradual types. The cases with fully static types and using different combinations of parameter kinds +are covered in the [equivalence tests](./is_equivalent_to.md#callable). + +```py +from ty_extensions import Unknown, CallableTypeOf, is_gradual_equivalent_to, static_assert +from typing import Any, Callable + +static_assert(is_gradual_equivalent_to(Callable[..., int], Callable[..., int])) +static_assert(is_gradual_equivalent_to(Callable[..., Any], Callable[..., Unknown])) +static_assert(is_gradual_equivalent_to(Callable[[int, Any], None], Callable[[int, Unknown], None])) + +static_assert(not is_gradual_equivalent_to(Callable[[int, Any], None], Callable[[Any, int], None])) +static_assert(not is_gradual_equivalent_to(Callable[[int, str], None], Callable[[int, str, bytes], None])) +static_assert(not is_gradual_equivalent_to(Callable[..., None], Callable[[], None])) +``` + +A function with no explicit return type should be gradual equivalent to a callable with a return +type of `Any`. + +```py +def f1(): + return + +static_assert(is_gradual_equivalent_to(CallableTypeOf[f1], Callable[[], Any])) +``` + +And, similarly for parameters with no annotations. + +```py +def f2(a, b, /) -> None: + return + +static_assert(is_gradual_equivalent_to(CallableTypeOf[f2], Callable[[Any, Any], None])) +``` + +Additionally, as per the spec, a function definition that includes both `*args` and `**kwargs` +parameter that are annotated as `Any` or kept unannotated should be gradual equivalent to a callable +with `...` as the parameter type. + +```py +def variadic_without_annotation(*args, **kwargs): + return + +def variadic_with_annotation(*args: Any, **kwargs: Any) -> Any: + return + +static_assert(is_gradual_equivalent_to(CallableTypeOf[variadic_without_annotation], Callable[..., Any])) +static_assert(is_gradual_equivalent_to(CallableTypeOf[variadic_with_annotation], Callable[..., Any])) +``` + +But, a function with either `*args` or `**kwargs` (and not both) is not gradual equivalent to a +callable with `...` as the parameter type. + +```py +def variadic_args(*args): + return + +def variadic_kwargs(**kwargs): + return + +static_assert(not is_gradual_equivalent_to(CallableTypeOf[variadic_args], Callable[..., Any])) +static_assert(not is_gradual_equivalent_to(CallableTypeOf[variadic_kwargs], Callable[..., Any])) +``` + +Parameter names, default values, and it's kind should also be considered when checking for gradual +equivalence. + +```py +def f1(a): ... +def f2(b): ... + +static_assert(not is_gradual_equivalent_to(CallableTypeOf[f1], CallableTypeOf[f2])) + +def f3(a=1): ... +def f4(a=2): ... +def f5(a): ... + +static_assert(is_gradual_equivalent_to(CallableTypeOf[f3], CallableTypeOf[f4])) +static_assert( + is_gradual_equivalent_to(CallableTypeOf[f3] | bool | CallableTypeOf[f4], CallableTypeOf[f4] | bool | CallableTypeOf[f3]) +) +static_assert(not is_gradual_equivalent_to(CallableTypeOf[f3], CallableTypeOf[f5])) + +def f6(a, /): ... + +static_assert(not is_gradual_equivalent_to(CallableTypeOf[f1], CallableTypeOf[f6])) +``` + +TODO: Overloads + +[materializations]: https://typing.python.org/en/latest/spec/glossary.html#term-materialize diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_single_valued.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_single_valued.md new file mode 100644 index 0000000000000..e947c248831f7 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_single_valued.md @@ -0,0 +1,36 @@ +## Single-valued types + +A type is single-valued iff it is not empty and all inhabitants of it compare equal. + +```py +import types +from typing_extensions import Any, Literal, LiteralString, Never, Callable +from ty_extensions import is_single_valued, static_assert, TypeOf + +static_assert(is_single_valued(None)) +static_assert(is_single_valued(Literal[True])) +static_assert(is_single_valued(Literal[1])) +static_assert(is_single_valued(Literal["abc"])) +static_assert(is_single_valued(Literal[b"abc"])) + +static_assert(is_single_valued(tuple[()])) +static_assert(is_single_valued(tuple[Literal[True], Literal[1]])) + +static_assert(not is_single_valued(str)) +static_assert(not is_single_valued(Never)) +static_assert(not is_single_valued(Any)) + +static_assert(not is_single_valued(Literal[1, 2])) + +static_assert(not is_single_valued(tuple[None, int])) + +static_assert(not is_single_valued(Callable[..., None])) +static_assert(not is_single_valued(Callable[[int, str], None])) + +class A: + def method(self): ... + +static_assert(is_single_valued(TypeOf[A().method])) +static_assert(is_single_valued(TypeOf[types.FunctionType.__get__])) +static_assert(is_single_valued(TypeOf[A.method.__get__])) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_singleton.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_singleton.md new file mode 100644 index 0000000000000..a3c41449bc76c --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_singleton.md @@ -0,0 +1,158 @@ +# Singleton types + +A type is a singleton type iff it has exactly one inhabitant. + +## Basic + +```py +from typing_extensions import Literal, Never, Callable +from ty_extensions import is_singleton, static_assert + +static_assert(is_singleton(None)) +static_assert(is_singleton(Literal[True])) +static_assert(is_singleton(Literal[False])) + +static_assert(is_singleton(type[bool])) + +static_assert(not is_singleton(Never)) +static_assert(not is_singleton(str)) + +static_assert(not is_singleton(Literal[345])) +static_assert(not is_singleton(Literal[1, 2])) + +static_assert(not is_singleton(tuple[()])) +static_assert(not is_singleton(tuple[None])) +static_assert(not is_singleton(tuple[None, Literal[True]])) + +static_assert(not is_singleton(Callable[..., None])) +static_assert(not is_singleton(Callable[[int, str], None])) +``` + +## `NoDefault` + +### 3.12 + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing_extensions import _NoDefaultType +from ty_extensions import is_singleton, static_assert + +static_assert(is_singleton(_NoDefaultType)) +``` + +### 3.13 + +```toml +[environment] +python-version = "3.13" +``` + +```py +from typing import _NoDefaultType +from ty_extensions import is_singleton, static_assert + +static_assert(is_singleton(_NoDefaultType)) +``` + +## `builtins.ellipsis`/`types.EllipsisType` + +### All Python versions + +The type of the builtin symbol `Ellipsis` is the same as the type of an ellipsis literal (`...`). +The type is not actually exposed from the standard library on Python \<3.10, but we still recognise +the type as a singleton on any Python version. + +```toml +[environment] +python-version = "3.9" +``` + +```py +from ty_extensions import is_singleton, static_assert + +static_assert(is_singleton(Ellipsis.__class__)) +static_assert(is_singleton((...).__class__)) +``` + +### Python 3.10+ + +On Python 3.10+, the standard library exposes the type of `...` as `types.EllipsisType`, and we also +recognise this as a singleton type when it is referenced directly: + +```toml +[environment] +python-version = "3.10" +``` + +```py +import types +from ty_extensions import static_assert, is_singleton + +static_assert(is_singleton(types.EllipsisType)) +``` + +## `builtins.NotImplemented` / `types.NotImplementedType` + +### All Python versions + +Just like `Ellipsis`, the type of `NotImplemented` was not exposed on Python \<3.10. However, we +still recognize the type as a singleton in all Python versions. + +```toml +[environment] +python-version = "3.9" +``` + +```py +from ty_extensions import is_singleton, static_assert + +static_assert(is_singleton(NotImplemented.__class__)) +``` + +### Python 3.10+ + +On Python 3.10+, the standard library exposes the type of `NotImplemented` as +`types.NotImplementedType`. We also recognize this as a singleton type when it is referenced +directly: + +```toml +[environment] +python-version = "3.10" +``` + +```py +import types +from ty_extensions import static_assert, is_singleton + +static_assert(is_singleton(types.NotImplementedType)) +``` + +### Callables + +We currently treat the type of `types.FunctionType.__get__` as a singleton type that has its own +dedicated variant in the `Type` enum. That variant should be understood as a singleton type, but the +similar variants `Type::BoundMethod` and `Type::MethodWrapperDunderGet` should not be; nor should +`Type::Callable` types. + +If we refactor `Type` in the future to get rid of some or all of these `Type` variants, the +assertion that the type of `types.FunctionType.__get__` is a singleton type does not necessarily +have to hold true; it's more of a unit test for our current implementation. + +```py +import types +from typing import Callable +from ty_extensions import static_assert, is_singleton, TypeOf + +class A: + def method(self): ... + +static_assert(is_singleton(TypeOf[types.FunctionType.__get__])) + +static_assert(not is_singleton(Callable[[], None])) +static_assert(not is_singleton(TypeOf[A().method])) +static_assert(not is_singleton(TypeOf[A.method.__get__])) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/is_subtype_of.md b/crates/ty_python_semantic/resources/mdtest/type_properties/is_subtype_of.md new file mode 100644 index 0000000000000..f9a97c8c51ef0 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/is_subtype_of.md @@ -0,0 +1,1462 @@ +# Subtype relation + +```toml +[environment] +python-version = "3.12" +``` + +The `is_subtype_of(S, T)` relation below checks if type `S` is a subtype of type `T`. + +A fully static type `S` is a subtype of another fully static type `T` iff the set of values +represented by `S` is a subset of the set of values represented by `T`. + +See the [typing documentation] for more information. + +## Basic builtin types + +- `bool` is a subtype of `int`. This is modeled after Python's runtime behavior, where `int` is a + supertype of `bool` (present in `bool`s bases and MRO). +- `int` is not a subtype of `float`/`complex`, although this is muddied by the + [special case for float and complex] where annotations of `float` and `complex` are interpreted + as `int | float` and `int | float | complex`, respectively. + +```py +from ty_extensions import is_subtype_of, static_assert, TypeOf + +type JustFloat = TypeOf[1.0] +type JustComplex = TypeOf[1j] + +static_assert(is_subtype_of(bool, bool)) +static_assert(is_subtype_of(bool, int)) +static_assert(is_subtype_of(bool, object)) + +static_assert(is_subtype_of(int, int)) +static_assert(is_subtype_of(int, object)) + +static_assert(is_subtype_of(object, object)) + +static_assert(not is_subtype_of(int, bool)) +static_assert(not is_subtype_of(int, str)) +static_assert(not is_subtype_of(object, int)) + +static_assert(not is_subtype_of(int, JustFloat)) +static_assert(not is_subtype_of(int, JustComplex)) + +static_assert(is_subtype_of(TypeError, Exception)) +static_assert(is_subtype_of(FloatingPointError, Exception)) +``` + +## Class hierarchies + +```py +from ty_extensions import is_subtype_of, static_assert +from typing_extensions import Never + +class A: ... +class B1(A): ... +class B2(A): ... +class C(B1, B2): ... + +static_assert(is_subtype_of(B1, A)) +static_assert(not is_subtype_of(A, B1)) + +static_assert(is_subtype_of(B2, A)) +static_assert(not is_subtype_of(A, B2)) + +static_assert(not is_subtype_of(B1, B2)) +static_assert(not is_subtype_of(B2, B1)) + +static_assert(is_subtype_of(C, B1)) +static_assert(is_subtype_of(C, B2)) +static_assert(not is_subtype_of(B1, C)) +static_assert(not is_subtype_of(B2, C)) +static_assert(is_subtype_of(C, A)) +static_assert(not is_subtype_of(A, C)) + +static_assert(is_subtype_of(Never, A)) +static_assert(is_subtype_of(Never, B1)) +static_assert(is_subtype_of(Never, B2)) +static_assert(is_subtype_of(Never, C)) + +static_assert(is_subtype_of(A, object)) +static_assert(is_subtype_of(B1, object)) +static_assert(is_subtype_of(B2, object)) +static_assert(is_subtype_of(C, object)) +``` + +## Literal types + +```py +from typing_extensions import Literal, LiteralString +from ty_extensions import is_subtype_of, static_assert, TypeOf + +type JustFloat = TypeOf[1.0] + +# Boolean literals +static_assert(is_subtype_of(Literal[True], bool)) +static_assert(is_subtype_of(Literal[True], int)) +static_assert(is_subtype_of(Literal[True], object)) + +# Integer literals +static_assert(is_subtype_of(Literal[1], int)) +static_assert(is_subtype_of(Literal[1], object)) + +static_assert(not is_subtype_of(Literal[1], bool)) + +static_assert(not is_subtype_of(Literal[1], JustFloat)) + +# String literals +static_assert(is_subtype_of(Literal["foo"], LiteralString)) +static_assert(is_subtype_of(Literal["foo"], str)) +static_assert(is_subtype_of(Literal["foo"], object)) + +static_assert(is_subtype_of(LiteralString, str)) +static_assert(is_subtype_of(LiteralString, object)) + +# Bytes literals +static_assert(is_subtype_of(Literal[b"foo"], bytes)) +static_assert(is_subtype_of(Literal[b"foo"], object)) +``` + +## Heterogeneous tuple types + +```py +from ty_extensions import is_subtype_of, static_assert + +class A1: ... +class B1(A1): ... +class A2: ... +class B2(A2): ... +class Unrelated: ... + +static_assert(is_subtype_of(B1, A1)) +static_assert(is_subtype_of(B2, A2)) + +# Zero-element tuples +static_assert(is_subtype_of(tuple[()], tuple[()])) +static_assert(not is_subtype_of(tuple[()], tuple[Unrelated])) + +# One-element tuples +static_assert(is_subtype_of(tuple[B1], tuple[A1])) +static_assert(not is_subtype_of(tuple[B1], tuple[Unrelated])) +static_assert(not is_subtype_of(tuple[B1], tuple[()])) +static_assert(not is_subtype_of(tuple[B1], tuple[A1, Unrelated])) + +# Two-element tuples +static_assert(is_subtype_of(tuple[B1, B2], tuple[A1, A2])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[Unrelated, A2])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[A1, Unrelated])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[Unrelated, Unrelated])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[()])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[A1])) +static_assert(not is_subtype_of(tuple[B1, B2], tuple[A1, A2, Unrelated])) +static_assert(is_subtype_of(tuple[int], tuple[object, ...])) +``` + +## Subtyping of heterogeneous tuple types and homogeneous tuple types + +While a homogeneous tuple type is not a subtype of any heterogeneous tuple types, a heterogeneous +tuple type can be a subtype of a homogeneous tuple type, and homogeneous tuple types can be subtypes +of `Sequence`: + +```py +from typing import Literal, Any, Sequence +from ty_extensions import static_assert, is_subtype_of, Not, AlwaysFalsy + +static_assert(is_subtype_of(tuple[Literal[1], Literal[2]], tuple[Literal[1, 2], ...])) +static_assert(is_subtype_of(tuple[Literal[1], Literal[2]], tuple[int, ...])) +static_assert(is_subtype_of(tuple[Literal[1], Literal[2]], tuple[int | str, ...])) +static_assert(is_subtype_of(tuple[Literal[1], Literal[2]], tuple[Not[AlwaysFalsy], ...])) +static_assert(is_subtype_of(tuple[Literal[1], Literal[2]], Sequence[int])) +static_assert(is_subtype_of(tuple[int, ...], Sequence[int])) + +static_assert(is_subtype_of(tuple[()], tuple[Literal[1, 2], ...])) +static_assert(is_subtype_of(tuple[()], tuple[int, ...])) +static_assert(is_subtype_of(tuple[()], tuple[int | str, ...])) +static_assert(is_subtype_of(tuple[()], tuple[Not[AlwaysFalsy], ...])) +static_assert(is_subtype_of(tuple[()], Sequence[int])) + +static_assert(not is_subtype_of(tuple[Literal[1], Literal[2]], tuple[Any, ...])) +static_assert(not is_subtype_of(tuple[int, int], tuple[str, ...])) +static_assert(not is_subtype_of(tuple[int, ...], Sequence[Any])) +static_assert(not is_subtype_of(tuple[Any, ...], Sequence[int])) +``` + +## Union types + +```py +from ty_extensions import is_subtype_of, static_assert +from typing import Literal + +class A: ... +class B1(A): ... +class B2(A): ... +class Unrelated1: ... +class Unrelated2: ... + +static_assert(is_subtype_of(B1, A)) +static_assert(is_subtype_of(B2, A)) + +# Union on the right hand side +static_assert(is_subtype_of(B1, A | Unrelated1)) +static_assert(is_subtype_of(B1, Unrelated1 | A)) + +static_assert(not is_subtype_of(B1, Unrelated1 | Unrelated2)) + +# Union on the left hand side +static_assert(is_subtype_of(B1 | B2, A)) +static_assert(is_subtype_of(B1 | B2 | A, object)) + +static_assert(not is_subtype_of(B1 | Unrelated1, A)) +static_assert(not is_subtype_of(Unrelated1 | B1, A)) + +# Union on both sides +static_assert(is_subtype_of(B1 | bool, A | int)) +static_assert(is_subtype_of(B1 | bool, int | A)) + +static_assert(not is_subtype_of(B1 | bool, Unrelated1 | int)) +static_assert(not is_subtype_of(B1 | bool, int | Unrelated1)) + +# Example: Unions of literals +static_assert(is_subtype_of(Literal[1, 2, 3], int)) +static_assert(not is_subtype_of(Literal[1, "two", 3], int)) +``` + +## Intersection types + +```py +from typing_extensions import Literal, LiteralString +from ty_extensions import Intersection, Not, is_subtype_of, static_assert + +class A: ... +class B1(A): ... +class B2(A): ... +class C(B1, B2): ... +class Unrelated: ... + +static_assert(is_subtype_of(B1, A)) +static_assert(is_subtype_of(B2, A)) +static_assert(is_subtype_of(C, A)) +static_assert(is_subtype_of(C, B1)) +static_assert(is_subtype_of(C, B2)) + +# For complements, the subtyping relation is reversed: +static_assert(is_subtype_of(Not[A], Not[B1])) +static_assert(is_subtype_of(Not[A], Not[B2])) +static_assert(is_subtype_of(Not[A], Not[C])) +static_assert(is_subtype_of(Not[B1], Not[C])) +static_assert(is_subtype_of(Not[B2], Not[C])) + +# The intersection of two types is a subtype of both: +static_assert(is_subtype_of(Intersection[B1, B2], B1)) +static_assert(is_subtype_of(Intersection[B1, B2], B2)) +# … and of their common supertype: +static_assert(is_subtype_of(Intersection[B1, B2], A)) + +# A common subtype of two types is a subtype of their intersection: +static_assert(is_subtype_of(C, Intersection[B1, B2])) +# … but not the other way around: +static_assert(not is_subtype_of(Intersection[B1, B2], C)) + +# "Removing" B1 from A leaves a subtype of A. +static_assert(is_subtype_of(Intersection[A, Not[B1]], A)) +static_assert(is_subtype_of(Intersection[A, Not[B1]], Not[B1])) + +# B1 and B2 are not disjoint, so this is not true: +static_assert(not is_subtype_of(B2, Intersection[A, Not[B1]])) +# … but for two disjoint subtypes, it is: +static_assert(is_subtype_of(Literal[2], Intersection[int, Not[Literal[1]]])) + +# A and Unrelated are not related, so this is not true: +static_assert(not is_subtype_of(Intersection[A, Not[B1]], Not[Unrelated])) +# … but for a disjoint type like `None`, it is: +static_assert(is_subtype_of(Intersection[A, Not[B1]], Not[None])) + +# Complements of types are still subtypes of `object`: +static_assert(is_subtype_of(Not[A], object)) + +# More examples: +static_assert(is_subtype_of(type[str], Not[None])) +static_assert(is_subtype_of(Not[LiteralString], object)) + +static_assert(not is_subtype_of(Intersection[int, Not[Literal[2]]], Intersection[int, Not[Literal[3]]])) +static_assert(not is_subtype_of(Not[Literal[2]], Not[Literal[3]])) +static_assert(not is_subtype_of(Not[Literal[2]], Not[int])) +static_assert(not is_subtype_of(int, Not[Literal[3]])) +static_assert(not is_subtype_of(Literal[1], Intersection[int, Not[Literal[1]]])) +``` + +## Special types + +### `Never` + +`Never` is a subtype of all types. + +```py +from typing_extensions import Literal, Never +from ty_extensions import AlwaysTruthy, AlwaysFalsy, is_subtype_of, static_assert + +static_assert(is_subtype_of(Never, Never)) +static_assert(is_subtype_of(Never, Literal[True])) +static_assert(is_subtype_of(Never, bool)) +static_assert(is_subtype_of(Never, int)) +static_assert(is_subtype_of(Never, object)) + +static_assert(is_subtype_of(Never, AlwaysTruthy)) +static_assert(is_subtype_of(Never, AlwaysFalsy)) +``` + +### `AlwaysTruthy` and `AlwaysFalsy` + +```py +from ty_extensions import AlwaysTruthy, AlwaysFalsy, Intersection, Not, is_subtype_of, static_assert +from typing_extensions import Literal, LiteralString + +static_assert(is_subtype_of(Literal[1], AlwaysTruthy)) +static_assert(is_subtype_of(Literal[0], AlwaysFalsy)) + +static_assert(is_subtype_of(AlwaysTruthy, object)) +static_assert(is_subtype_of(AlwaysFalsy, object)) + +static_assert(not is_subtype_of(Literal[1], AlwaysFalsy)) +static_assert(not is_subtype_of(Literal[0], AlwaysTruthy)) + +static_assert(not is_subtype_of(str, AlwaysTruthy)) +static_assert(not is_subtype_of(str, AlwaysFalsy)) + +# TODO: No errors +# error: [static-assert-error] +static_assert(is_subtype_of(bool, Literal[False] | AlwaysTruthy)) +# error: [static-assert-error] +static_assert(is_subtype_of(bool, Literal[True] | AlwaysFalsy)) +# error: [static-assert-error] +static_assert(is_subtype_of(LiteralString, Literal[""] | AlwaysTruthy)) +static_assert(not is_subtype_of(Literal[True] | AlwaysFalsy, Literal[False] | AlwaysTruthy)) + +# TODO: No errors +# The condition `is_subtype_of(T & U, U)` must still be satisfied after the following transformations: +# `LiteralString & AlwaysTruthy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_subtype_of(Intersection[LiteralString, Not[Literal[""]]], AlwaysTruthy)) +# error: [static-assert-error] +static_assert(is_subtype_of(Intersection[LiteralString, Not[Literal["", "a"]]], AlwaysTruthy)) +# `LiteralString & ~AlwaysFalsy` -> `LiteralString & ~Literal[""]` +# error: [static-assert-error] +static_assert(is_subtype_of(Intersection[LiteralString, Not[Literal[""]]], Not[AlwaysFalsy])) +# error: [static-assert-error] +static_assert(is_subtype_of(Intersection[LiteralString, Not[Literal["", "a"]]], Not[AlwaysFalsy])) +``` + +### Module literals + +```py +from types import ModuleType +from ty_extensions import TypeOf, is_subtype_of, static_assert +from typing_extensions import assert_type +import typing + +assert_type(typing, TypeOf[typing]) + +static_assert(is_subtype_of(TypeOf[typing], ModuleType)) +``` + +### Slice literals + +The type of a slice literal is currently inferred as a specialization of `slice`. + +```py +from ty_extensions import TypeOf, is_subtype_of, static_assert + +# slice's default specialization is slice[Any, Any, Any], which does not participate in subtyping. +static_assert(not is_subtype_of(TypeOf[1:2:3], slice)) +static_assert(is_subtype_of(TypeOf[1:2:3], slice[int])) +``` + +### Special forms + +```py +from typing import _SpecialForm, Literal +from ty_extensions import TypeOf, is_subtype_of, static_assert + +static_assert(is_subtype_of(TypeOf[Literal], _SpecialForm)) +static_assert(is_subtype_of(TypeOf[Literal], object)) + +static_assert(not is_subtype_of(_SpecialForm, TypeOf[Literal])) +``` + +## Class literal types and `type[…]` + +### Basic + +```py +from typing import _SpecialForm +from typing_extensions import Literal, assert_type +from ty_extensions import TypeOf, is_subtype_of, static_assert + +class Meta(type): ... +class HasCustomMetaclass(metaclass=Meta): ... + +type LiteralBool = TypeOf[bool] +type LiteralInt = TypeOf[int] +type LiteralStr = TypeOf[str] +type LiteralObject = TypeOf[object] + +assert_type(bool, LiteralBool) +assert_type(int, LiteralInt) +assert_type(str, LiteralStr) +assert_type(object, LiteralObject) + +# bool + +static_assert(is_subtype_of(LiteralBool, LiteralBool)) +static_assert(is_subtype_of(LiteralBool, type[bool])) +static_assert(is_subtype_of(LiteralBool, type[int])) +static_assert(is_subtype_of(LiteralBool, type[object])) +static_assert(is_subtype_of(LiteralBool, type)) +static_assert(is_subtype_of(LiteralBool, object)) + +static_assert(not is_subtype_of(LiteralBool, LiteralInt)) +static_assert(not is_subtype_of(LiteralBool, LiteralObject)) +static_assert(not is_subtype_of(LiteralBool, bool)) + +static_assert(not is_subtype_of(type, type[bool])) + +# int + +static_assert(is_subtype_of(LiteralInt, LiteralInt)) +static_assert(is_subtype_of(LiteralInt, type[int])) +static_assert(is_subtype_of(LiteralInt, type[object])) +static_assert(is_subtype_of(LiteralInt, type)) +static_assert(is_subtype_of(LiteralInt, object)) + +static_assert(not is_subtype_of(LiteralInt, LiteralObject)) +static_assert(not is_subtype_of(LiteralInt, int)) + +static_assert(not is_subtype_of(type, type[int])) + +# LiteralString + +static_assert(is_subtype_of(LiteralStr, type[str])) +static_assert(is_subtype_of(LiteralStr, type)) +static_assert(is_subtype_of(LiteralStr, type[object])) + +static_assert(not is_subtype_of(type[str], LiteralStr)) + +# custom metaclasses + +type LiteralHasCustomMetaclass = TypeOf[HasCustomMetaclass] + +static_assert(is_subtype_of(LiteralHasCustomMetaclass, Meta)) +static_assert(is_subtype_of(Meta, type[object])) +static_assert(is_subtype_of(Meta, type)) + +static_assert(not is_subtype_of(Meta, type[type])) +``` + +### Unions of class literals + +```py +from typing_extensions import assert_type +from ty_extensions import TypeOf, is_subtype_of, static_assert + +class Base: ... +class Derived(Base): ... +class Unrelated: ... + +type LiteralBase = TypeOf[Base] +type LiteralDerived = TypeOf[Derived] +type LiteralUnrelated = TypeOf[Unrelated] + +assert_type(Base, LiteralBase) +assert_type(Derived, LiteralDerived) +assert_type(Unrelated, LiteralUnrelated) + +static_assert(is_subtype_of(LiteralBase, type)) +static_assert(is_subtype_of(LiteralBase, object)) + +static_assert(is_subtype_of(LiteralBase, type[Base])) +static_assert(is_subtype_of(LiteralDerived, type[Base])) +static_assert(is_subtype_of(LiteralDerived, type[Derived])) + +static_assert(not is_subtype_of(LiteralBase, type[Derived])) +static_assert(is_subtype_of(type[Derived], type[Base])) + +static_assert(is_subtype_of(LiteralBase | LiteralUnrelated, type)) +static_assert(is_subtype_of(LiteralBase | LiteralUnrelated, object)) +``` + +## Non-fully-static types + +`Any`, `Unknown`, `Todo` and derivatives thereof do not participate in subtyping. + +```py +from ty_extensions import Unknown, is_subtype_of, static_assert, Intersection +from typing_extensions import Any + +static_assert(not is_subtype_of(Any, Any)) +static_assert(not is_subtype_of(Any, int)) +static_assert(not is_subtype_of(int, Any)) +static_assert(not is_subtype_of(Any, object)) +static_assert(not is_subtype_of(object, Any)) + +static_assert(not is_subtype_of(int, Any | int)) +static_assert(not is_subtype_of(Intersection[Any, int], int)) +static_assert(not is_subtype_of(tuple[int, int], tuple[int, Any])) + +# The same for `Unknown`: +static_assert(not is_subtype_of(Unknown, Unknown)) +static_assert(not is_subtype_of(Unknown, int)) +static_assert(not is_subtype_of(int, Unknown)) +static_assert(not is_subtype_of(Unknown, object)) +static_assert(not is_subtype_of(object, Unknown)) + +static_assert(not is_subtype_of(int, Unknown | int)) +static_assert(not is_subtype_of(Intersection[Unknown, int], int)) +static_assert(not is_subtype_of(tuple[int, int], tuple[int, Unknown])) +``` + +## Callable + +The general principle is that a callable type is a subtype of another if it's more flexible in what +it accepts and more specific in what it returns. + +References: + +- <https://typing.python.org/en/latest/spec/callables.html#assignability-rules-for-callables> +- <https://typing.python.org/en/latest/spec/callables.html#assignment> + +### Return type + +Return types are covariant. + +```py +from typing import Callable +from ty_extensions import is_subtype_of, static_assert, TypeOf + +static_assert(is_subtype_of(Callable[[], int], Callable[[], float])) +static_assert(not is_subtype_of(Callable[[], float], Callable[[], int])) +``` + +### Optional return type + +```py +from typing import Callable +from ty_extensions import is_subtype_of, static_assert, TypeOf + +flag: bool = True + +def optional_return_type() -> int | None: + if flag: + return 1 + return None + +def required_return_type() -> int: + return 1 + +static_assert(not is_subtype_of(TypeOf[optional_return_type], TypeOf[required_return_type])) +# TypeOf[some_function] is a singleton function-literal type, not a general callable type +static_assert(not is_subtype_of(TypeOf[required_return_type], TypeOf[optional_return_type])) +static_assert(is_subtype_of(TypeOf[optional_return_type], Callable[[], int | None])) +``` + +### Parameter types + +Parameter types are contravariant. + +#### Positional-only + +```py +from typing import Callable +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert, TypeOf + +def float_param(a: float, /) -> None: ... +def int_param(a: int, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[float_param], CallableTypeOf[int_param])) +static_assert(not is_subtype_of(CallableTypeOf[int_param], CallableTypeOf[float_param])) + +static_assert(is_subtype_of(TypeOf[int_param], Callable[[int], None])) +static_assert(is_subtype_of(TypeOf[float_param], Callable[[float], None])) + +static_assert(not is_subtype_of(Callable[[int], None], TypeOf[int_param])) +static_assert(not is_subtype_of(Callable[[float], None], TypeOf[float_param])) +``` + +Parameter name is not required to be the same for positional-only parameters at the same position: + +```py +def int_param_different_name(b: int, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[int_param], CallableTypeOf[int_param_different_name])) +static_assert(is_subtype_of(CallableTypeOf[int_param_different_name], CallableTypeOf[int_param])) +``` + +Multiple positional-only parameters are checked in order: + +```py +def multi_param1(a: float, b: int, c: str, /) -> None: ... +def multi_param2(b: int, c: bool, a: str, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_param1], CallableTypeOf[multi_param2])) +static_assert(not is_subtype_of(CallableTypeOf[multi_param2], CallableTypeOf[multi_param1])) + +static_assert(is_subtype_of(TypeOf[multi_param1], Callable[[float, int, str], None])) + +static_assert(not is_subtype_of(Callable[[float, int, str], None], TypeOf[multi_param1])) +``` + +#### Positional-only with default value + +If the parameter has a default value, it's treated as optional. This means that the parameter at the +corresponding position in the supertype does not need to have a default value. + +```py +from typing import Callable +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert, TypeOf + +def float_with_default(a: float = 1, /) -> None: ... +def int_with_default(a: int = 1, /) -> None: ... +def int_without_default(a: int, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[float_with_default], CallableTypeOf[int_with_default])) +static_assert(not is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[float_with_default])) + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[int_without_default])) +static_assert(not is_subtype_of(CallableTypeOf[int_without_default], CallableTypeOf[int_with_default])) + +static_assert(is_subtype_of(TypeOf[int_with_default], Callable[[int], None])) +static_assert(is_subtype_of(TypeOf[int_with_default], Callable[[], None])) +static_assert(is_subtype_of(TypeOf[float_with_default], Callable[[float], None])) + +static_assert(not is_subtype_of(Callable[[int], None], TypeOf[int_with_default])) +static_assert(not is_subtype_of(Callable[[float], None], TypeOf[float_with_default])) +``` + +As the parameter itself is optional, it can be omitted in the supertype: + +```py +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[int_without_default], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[int_with_default])) +``` + +The subtype can include any number of positional-only parameters as long as they have the default +value: + +```py +def multi_param(a: float = 1, b: int = 2, c: str = "3", /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_param], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[multi_param])) +``` + +#### Positional-only with other kinds + +If a parameter is declared as positional-only, then the corresponding parameter in the supertype +cannot be any other parameter kind. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def positional_only(a: int, /) -> None: ... +def standard(a: int) -> None: ... +def keyword_only(*, a: int) -> None: ... +def variadic(*a: int) -> None: ... +def keyword_variadic(**a: int) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[positional_only], CallableTypeOf[standard])) +static_assert(not is_subtype_of(CallableTypeOf[positional_only], CallableTypeOf[keyword_only])) +static_assert(not is_subtype_of(CallableTypeOf[positional_only], CallableTypeOf[variadic])) +static_assert(not is_subtype_of(CallableTypeOf[positional_only], CallableTypeOf[keyword_variadic])) +``` + +#### Standard + +A standard parameter is either a positional or a keyword parameter. + +Unlike positional-only parameters, standard parameters should have the same name in the subtype. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def int_param_a(a: int) -> None: ... +def int_param_b(b: int) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[int_param_a], CallableTypeOf[int_param_b])) +static_assert(not is_subtype_of(CallableTypeOf[int_param_b], CallableTypeOf[int_param_a])) +``` + +Apart from the name, it behaves the same as positional-only parameters. + +```py +def float_param(a: float) -> None: ... +def int_param(a: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[float_param], CallableTypeOf[int_param])) +static_assert(not is_subtype_of(CallableTypeOf[int_param], CallableTypeOf[float_param])) +``` + +With the same rules for default values as well. + +```py +def float_with_default(a: float = 1) -> None: ... +def int_with_default(a: int = 1) -> None: ... +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[float_with_default], CallableTypeOf[int_with_default])) +static_assert(not is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[float_with_default])) + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[int_param])) +static_assert(not is_subtype_of(CallableTypeOf[int_param], CallableTypeOf[int_with_default])) + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[int_with_default])) +``` + +Multiple standard parameters are checked in order along with their names: + +```py +def multi_param1(a: float, b: int, c: str) -> None: ... +def multi_param2(a: int, b: bool, c: str) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_param1], CallableTypeOf[multi_param2])) +static_assert(not is_subtype_of(CallableTypeOf[multi_param2], CallableTypeOf[multi_param1])) +``` + +The subtype can include as many standard parameters as long as they have the default value: + +```py +def multi_param_default(a: float = 1, b: int = 2, c: str = "s") -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_param_default], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[multi_param_default])) +``` + +#### Standard with keyword-only + +A keyword-only parameter in the supertype can be substituted with the corresponding standard +parameter in the subtype with the same name. This is because a standard parameter is more flexible +than a keyword-only parameter. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def standard_a(a: int) -> None: ... +def keyword_b(*, b: int) -> None: ... + +# The name of the parameters are different +static_assert(not is_subtype_of(CallableTypeOf[standard_a], CallableTypeOf[keyword_b])) + +def standard_float(a: float) -> None: ... +def keyword_int(*, a: int) -> None: ... + +# Here, the name of the parameters are the same +static_assert(is_subtype_of(CallableTypeOf[standard_float], CallableTypeOf[keyword_int])) + +def standard_with_default(a: int = 1) -> None: ... +def keyword_with_default(*, a: int = 1) -> None: ... +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[standard_with_default], CallableTypeOf[keyword_with_default])) +static_assert(is_subtype_of(CallableTypeOf[standard_with_default], CallableTypeOf[empty])) +``` + +The position of the keyword-only parameters does not matter: + +```py +def multi_standard(a: float, b: int, c: str) -> None: ... +def multi_keyword(*, b: bool, c: str, a: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_standard], CallableTypeOf[multi_keyword])) +``` + +#### Standard with positional-only + +A positional-only parameter in the supertype can be substituted with the corresponding standard +parameter in the subtype at the same position. This is because a standard parameter is more flexible +than a positional-only parameter. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def standard_a(a: int) -> None: ... +def positional_b(b: int, /) -> None: ... + +# The names are not important in this context +static_assert(is_subtype_of(CallableTypeOf[standard_a], CallableTypeOf[positional_b])) + +def standard_float(a: float) -> None: ... +def positional_int(a: int, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[standard_float], CallableTypeOf[positional_int])) + +def standard_with_default(a: int = 1) -> None: ... +def positional_with_default(a: int = 1, /) -> None: ... +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[standard_with_default], CallableTypeOf[positional_with_default])) +static_assert(is_subtype_of(CallableTypeOf[standard_with_default], CallableTypeOf[empty])) +``` + +The position of the positional-only parameters matter: + +```py +def multi_standard(a: float, b: int, c: str) -> None: ... +def multi_positional1(b: int, c: bool, a: str, /) -> None: ... + +# Here, the type of the parameter `a` makes the subtype relation invalid +def multi_positional2(b: int, a: float, c: str, /) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[multi_standard], CallableTypeOf[multi_positional1])) +static_assert(not is_subtype_of(CallableTypeOf[multi_standard], CallableTypeOf[multi_positional2])) +``` + +#### Standard with variadic + +A variadic or keyword-variadic parameter in the supertype cannot be substituted with a standard +parameter in the subtype. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def standard(a: int) -> None: ... +def variadic(*a: int) -> None: ... +def keyword_variadic(**a: int) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[standard], CallableTypeOf[variadic])) +static_assert(not is_subtype_of(CallableTypeOf[standard], CallableTypeOf[keyword_variadic])) +``` + +#### Variadic + +The name of the variadic parameter does not need to be the same in the subtype. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def variadic_float(*args2: float) -> None: ... +def variadic_int(*args1: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic_float], CallableTypeOf[variadic_int])) +static_assert(not is_subtype_of(CallableTypeOf[variadic_int], CallableTypeOf[variadic_float])) +``` + +The variadic parameter does not need to be present in the supertype: + +```py +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic_int], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[variadic_int])) +``` + +#### Variadic with positional-only + +If the subtype has a variadic parameter then any unmatched positional-only parameter from the +supertype should be checked against the variadic parameter. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def variadic(a: int, /, *args: float) -> None: ... + +# Here, the parameter `b` and `c` are unmatched +def positional_only(a: int, b: float, c: int, /) -> None: ... + +# Here, the parameter `b` is unmatched and there's also a variadic parameter +def positional_variadic(a: int, b: float, /, *args: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic], CallableTypeOf[positional_only])) +static_assert(is_subtype_of(CallableTypeOf[variadic], CallableTypeOf[positional_variadic])) +``` + +#### Variadic with other kinds + +Variadic parameter in a subtype can only be used to match against an unmatched positional-only +parameters from the supertype, not any other parameter kind. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def variadic(*args: int) -> None: ... + +# Both positional-only parameters are unmatched so uses the variadic parameter but the other +# parameter `c` remains and cannot be matched. +def standard(a: int, b: float, /, c: int) -> None: ... + +# Similarly, for other kinds +def keyword_only(a: int, /, *, b: int) -> None: ... +def keyword_variadic(a: int, /, **kwargs: int) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[variadic], CallableTypeOf[standard])) +static_assert(not is_subtype_of(CallableTypeOf[variadic], CallableTypeOf[keyword_only])) +static_assert(not is_subtype_of(CallableTypeOf[variadic], CallableTypeOf[keyword_variadic])) +``` + +But, there are special cases when matching against standard parameters. This is due to the fact that +a standard parameter can be passed as a positional or keyword parameter. This means that the +subtyping relation needs to consider both cases. + +```py +def variadic_keyword(*args: int, **kwargs: int) -> None: ... +def standard_int(a: int) -> None: ... +def standard_float(a: float) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic_keyword], CallableTypeOf[standard_int])) +static_assert(not is_subtype_of(CallableTypeOf[variadic_keyword], CallableTypeOf[standard_float])) +``` + +If the type of either the variadic or keyword-variadic parameter is not a supertype of the standard +parameter, then the subtyping relation is invalid. + +```py +def variadic_bool(*args: bool, **kwargs: int) -> None: ... +def keyword_variadic_bool(*args: int, **kwargs: bool) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[variadic_bool], CallableTypeOf[standard_int])) +static_assert(not is_subtype_of(CallableTypeOf[keyword_variadic_bool], CallableTypeOf[standard_int])) +``` + +The standard parameter can follow a variadic parameter in the subtype. + +```py +def standard_variadic_int(a: int, *args: int) -> None: ... +def standard_variadic_float(a: int, *args: float) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic_keyword], CallableTypeOf[standard_variadic_int])) +static_assert(not is_subtype_of(CallableTypeOf[variadic_keyword], CallableTypeOf[standard_variadic_float])) +``` + +The keyword part of the standard parameter can be matched against keyword-only parameter with the +same name if the keyword-variadic parameter is absent. + +```py +def variadic_a(*args: int, a: int) -> None: ... +def variadic_b(*args: int, b: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[variadic_a], CallableTypeOf[standard_int])) +# The parameter name is different +static_assert(not is_subtype_of(CallableTypeOf[variadic_b], CallableTypeOf[standard_int])) +``` + +#### Keyword-only + +For keyword-only parameters, the name should be the same: + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def keyword_int(*, a: int) -> None: ... +def keyword_float(*, a: float) -> None: ... +def keyword_b(*, b: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[keyword_float], CallableTypeOf[keyword_int])) +static_assert(not is_subtype_of(CallableTypeOf[keyword_int], CallableTypeOf[keyword_float])) +static_assert(not is_subtype_of(CallableTypeOf[keyword_int], CallableTypeOf[keyword_b])) +``` + +But, the order of the keyword-only parameters is not required to be the same: + +```py +def keyword_ab(*, a: float, b: float) -> None: ... +def keyword_ba(*, b: int, a: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[keyword_ab], CallableTypeOf[keyword_ba])) +static_assert(not is_subtype_of(CallableTypeOf[keyword_ba], CallableTypeOf[keyword_ab])) +``` + +#### Keyword-only with default + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def float_with_default(*, a: float = 1) -> None: ... +def int_with_default(*, a: int = 1) -> None: ... +def int_keyword(*, a: int) -> None: ... +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[float_with_default], CallableTypeOf[int_with_default])) +static_assert(not is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[float_with_default])) + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[int_keyword])) +static_assert(not is_subtype_of(CallableTypeOf[int_keyword], CallableTypeOf[int_with_default])) + +static_assert(is_subtype_of(CallableTypeOf[int_with_default], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[int_with_default])) +``` + +Keyword-only parameters with default values can be mixed with the ones without default values in any +order: + +```py +# A keyword-only parameter with a default value follows the one without a default value (it's valid) +def mixed(*, b: int = 1, a: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[mixed], CallableTypeOf[int_keyword])) +static_assert(not is_subtype_of(CallableTypeOf[int_keyword], CallableTypeOf[mixed])) +``` + +#### Keyword-only with standard + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def keywords1(*, a: int, b: int) -> None: ... +def standard(b: float, a: float) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[keywords1], CallableTypeOf[standard])) +static_assert(is_subtype_of(CallableTypeOf[standard], CallableTypeOf[keywords1])) +``` + +The subtype can include additional standard parameters as long as it has the default value: + +```py +def standard_with_default(b: float, a: float, c: float = 1) -> None: ... +def standard_without_default(b: float, a: float, c: float) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[standard_without_default], CallableTypeOf[keywords1])) +static_assert(is_subtype_of(CallableTypeOf[standard_with_default], CallableTypeOf[keywords1])) +``` + +Here, we mix keyword-only parameters with standard parameters: + +```py +def keywords2(*, a: int, c: int, b: int) -> None: ... +def mixed(b: float, a: float, *, c: float) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[keywords2], CallableTypeOf[mixed])) +static_assert(is_subtype_of(CallableTypeOf[mixed], CallableTypeOf[keywords2])) +``` + +But, we shouldn't consider any unmatched positional-only parameters: + +```py +def mixed_positional(b: float, /, a: float, *, c: float) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[mixed_positional], CallableTypeOf[keywords2])) +``` + +But, an unmatched variadic parameter is still valid: + +```py +def mixed_variadic(*args: float, a: float, b: float, c: float, **kwargs: float) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[mixed_variadic], CallableTypeOf[keywords2])) +``` + +#### Keyword-variadic + +The name of the keyword-variadic parameter does not need to be the same in the subtype. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def kwargs_float(**kwargs2: float) -> None: ... +def kwargs_int(**kwargs1: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[kwargs_float], CallableTypeOf[kwargs_int])) +static_assert(not is_subtype_of(CallableTypeOf[kwargs_int], CallableTypeOf[kwargs_float])) +``` + +A variadic parameter can be omitted in the subtype: + +```py +def empty() -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[kwargs_int], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[kwargs_int])) +``` + +#### Keyword-variadic with keyword-only + +If the subtype has a keyword-variadic parameter then any unmatched keyword-only parameter from the +supertype should be checked against the keyword-variadic parameter. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def kwargs(**kwargs: float) -> None: ... +def keyword_only(*, a: int, b: float, c: bool) -> None: ... +def keyword_variadic(*, a: int, **kwargs: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[kwargs], CallableTypeOf[keyword_only])) +static_assert(is_subtype_of(CallableTypeOf[kwargs], CallableTypeOf[keyword_variadic])) +``` + +This is valid only for keyword-only parameters, not any other parameter kind: + +```py +def mixed1(a: int, *, b: int) -> None: ... + +# Same as above but with the default value +def mixed2(a: int = 1, *, b: int) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[kwargs], CallableTypeOf[mixed1])) +static_assert(not is_subtype_of(CallableTypeOf[kwargs], CallableTypeOf[mixed2])) +``` + +#### Empty + +When the supertype has an empty list of parameters, then the subtype can have any kind of parameters +as long as they contain the default values for non-variadic parameters. + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +def empty() -> None: ... +def mixed(a: int = 1, /, b: int = 2, *args: int, c: int = 3, **kwargs: int) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[mixed], CallableTypeOf[empty])) +static_assert(not is_subtype_of(CallableTypeOf[empty], CallableTypeOf[mixed])) +``` + +#### Object + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert, TypeOf +from typing import Callable + +def f1(a: int, b: str, /, *c: float, d: int = 1, **e: float) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[f1], object)) +static_assert(not is_subtype_of(object, CallableTypeOf[f1])) + +def _( + f3: Callable[[int, str], None], +) -> None: + static_assert(is_subtype_of(TypeOf[f3], object)) + static_assert(not is_subtype_of(object, TypeOf[f3])) + +class C: + def foo(self) -> None: ... + +static_assert(is_subtype_of(TypeOf[C.foo], object)) +static_assert(not is_subtype_of(object, TypeOf[C.foo])) +``` + +### Classes with `__call__` + +```py +from typing import Callable +from ty_extensions import TypeOf, is_subtype_of, static_assert, is_assignable_to + +class A: + def __call__(self, a: int) -> int: + return a + +a = A() + +static_assert(is_subtype_of(A, Callable[[int], int])) +static_assert(not is_subtype_of(A, Callable[[], int])) +static_assert(not is_subtype_of(Callable[[int], int], A)) + +def f(fn: Callable[[int], int]) -> None: ... + +f(a) +``` + +### Class literals + +#### Classes with metaclasses + +```py +from typing import Callable, overload +from typing_extensions import Self +from ty_extensions import TypeOf, static_assert, is_subtype_of + +class MetaWithReturn(type): + def __call__(cls) -> "A": + return super().__call__() + +class A(metaclass=MetaWithReturn): ... + +static_assert(is_subtype_of(TypeOf[A], Callable[[], A])) +static_assert(not is_subtype_of(TypeOf[A], Callable[[object], A])) + +class MetaWithDifferentReturn(type): + def __call__(cls) -> int: + return super().__call__() + +class B(metaclass=MetaWithDifferentReturn): ... + +static_assert(is_subtype_of(TypeOf[B], Callable[[], int])) +static_assert(not is_subtype_of(TypeOf[B], Callable[[], B])) + +class MetaWithOverloadReturn(type): + @overload + def __call__(cls, x: int) -> int: ... + @overload + def __call__(cls) -> str: ... + def __call__(cls, x: int | None = None) -> str | int: + return super().__call__() + +class C(metaclass=MetaWithOverloadReturn): ... + +static_assert(is_subtype_of(TypeOf[C], Callable[[int], int])) +static_assert(is_subtype_of(TypeOf[C], Callable[[], str])) +``` + +#### Classes with `__new__` + +```py +from typing import Callable +from ty_extensions import TypeOf, static_assert, is_subtype_of + +class A: + def __new__(cls, a: int) -> int: + return a + +static_assert(is_subtype_of(TypeOf[A], Callable[[int], int])) +static_assert(not is_subtype_of(TypeOf[A], Callable[[], int])) + +class B: ... +class C(B): ... + +class D: + def __new__(cls) -> B: + return B() + +class E(D): + def __new__(cls) -> C: + return C() + +static_assert(is_subtype_of(TypeOf[E], Callable[[], C])) +static_assert(is_subtype_of(TypeOf[E], Callable[[], B])) +static_assert(not is_subtype_of(TypeOf[D], Callable[[], C])) +static_assert(is_subtype_of(TypeOf[D], Callable[[], B])) +``` + +#### Classes with `__call__` and `__new__` + +If `__call__` and `__new__` are both present, `__call__` takes precedence. + +```py +from typing import Callable +from ty_extensions import TypeOf, static_assert, is_subtype_of + +class MetaWithIntReturn(type): + def __call__(cls) -> int: + return super().__call__() + +class F(metaclass=MetaWithIntReturn): + def __new__(cls) -> str: + return super().__new__(cls) + +static_assert(is_subtype_of(TypeOf[F], Callable[[], int])) +static_assert(not is_subtype_of(TypeOf[F], Callable[[], str])) +``` + +### Bound methods + +```py +from typing import Callable +from ty_extensions import TypeOf, static_assert, is_subtype_of + +class A: + def f(self, a: int) -> int: + return a + + @classmethod + def g(cls, a: int) -> int: + return a + +a = A() + +static_assert(is_subtype_of(TypeOf[a.f], Callable[[int], int])) +static_assert(is_subtype_of(TypeOf[a.g], Callable[[int], int])) +static_assert(is_subtype_of(TypeOf[A.g], Callable[[int], int])) + +static_assert(not is_subtype_of(TypeOf[a.f], Callable[[float], int])) +static_assert(not is_subtype_of(TypeOf[A.g], Callable[[], int])) + +# TODO: This assertion should be true +# error: [static-assert-error] "Static assertion error: argument evaluates to `False`" +static_assert(is_subtype_of(TypeOf[A.f], Callable[[A, int], int])) +``` + +### Overloads + +#### Subtype overloaded + +For `B <: A`, if a callable `B` is overloaded with two or more signatures, it is a subtype of +callable `A` if _at least one_ of the overloaded signatures in `B` is a subtype of `A`. + +`overloaded.pyi`: + +```pyi +from typing import overload + +class A: ... +class B: ... +class C: ... + +@overload +def overloaded(x: A) -> None: ... +@overload +def overloaded(x: B) -> None: ... +``` + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert +from overloaded import A, B, C, overloaded + +def accepts_a(x: A) -> None: ... +def accepts_b(x: B) -> None: ... +def accepts_c(x: C) -> None: ... + +static_assert(is_subtype_of(CallableTypeOf[overloaded], CallableTypeOf[accepts_a])) +static_assert(is_subtype_of(CallableTypeOf[overloaded], CallableTypeOf[accepts_b])) +static_assert(not is_subtype_of(CallableTypeOf[overloaded], CallableTypeOf[accepts_c])) +``` + +#### Supertype overloaded + +For `B <: A`, if a callable `A` is overloaded with two or more signatures, callable `B` is a subtype +of `A` if `B` is a subtype of _all_ of the signatures in `A`. + +`overloaded.pyi`: + +```pyi +from typing import overload + +class Grandparent: ... +class Parent(Grandparent): ... +class Child(Parent): ... + +@overload +def overloaded(a: Child) -> None: ... +@overload +def overloaded(a: Parent) -> None: ... +@overload +def overloaded(a: Grandparent) -> None: ... +``` + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert +from overloaded import Grandparent, Parent, Child, overloaded + +# This is a subtype of only the first overload +def child(a: Child) -> None: ... + +# This is a subtype of the first and second overload +def parent(a: Parent) -> None: ... + +# This is the only function that's a subtype of all overloads +def grandparent(a: Grandparent) -> None: ... + +static_assert(not is_subtype_of(CallableTypeOf[child], CallableTypeOf[overloaded])) +static_assert(not is_subtype_of(CallableTypeOf[parent], CallableTypeOf[overloaded])) +static_assert(is_subtype_of(CallableTypeOf[grandparent], CallableTypeOf[overloaded])) +``` + +#### Both overloads + +For `B <: A`, if both `A` and `B` is a callable that's overloaded with two or more signatures, then +`B` is a subtype of `A` if for _every_ signature in `A`, there is _at least one_ signature in `B` +that is a subtype of it. + +`overloaded.pyi`: + +```pyi +from typing import overload + +class Grandparent: ... +class Parent(Grandparent): ... +class Child(Parent): ... +class Other: ... + +@overload +def pg(a: Parent) -> None: ... +@overload +def pg(a: Grandparent) -> None: ... + +@overload +def po(a: Parent) -> None: ... +@overload +def po(a: Other) -> None: ... + +@overload +def go(a: Grandparent) -> None: ... +@overload +def go(a: Other) -> None: ... + +@overload +def cpg(a: Child) -> None: ... +@overload +def cpg(a: Parent) -> None: ... +@overload +def cpg(a: Grandparent) -> None: ... + +@overload +def empty_go() -> Child: ... +@overload +def empty_go(a: Grandparent) -> None: ... +@overload +def empty_go(a: Other) -> Other: ... + +@overload +def empty_cp() -> Parent: ... +@overload +def empty_cp(a: Child) -> None: ... +@overload +def empty_cp(a: Parent) -> None: ... +``` + +```py +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert +from overloaded import pg, po, go, cpg, empty_go, empty_cp + +static_assert(is_subtype_of(CallableTypeOf[pg], CallableTypeOf[cpg])) +static_assert(is_subtype_of(CallableTypeOf[cpg], CallableTypeOf[pg])) + +static_assert(not is_subtype_of(CallableTypeOf[po], CallableTypeOf[pg])) +static_assert(not is_subtype_of(CallableTypeOf[pg], CallableTypeOf[po])) + +static_assert(is_subtype_of(CallableTypeOf[go], CallableTypeOf[pg])) +static_assert(not is_subtype_of(CallableTypeOf[pg], CallableTypeOf[go])) + +# Overload 1 in `empty_go` is a subtype of overload 1 in `empty_cp` +# Overload 2 in `empty_go` is a subtype of overload 2 in `empty_cp` +# Overload 2 in `empty_go` is a subtype of overload 3 in `empty_cp` +# +# All overloads in `empty_cp` has a subtype in `empty_go` +static_assert(is_subtype_of(CallableTypeOf[empty_go], CallableTypeOf[empty_cp])) + +static_assert(not is_subtype_of(CallableTypeOf[empty_cp], CallableTypeOf[empty_go])) +``` + +#### Order of overloads + +Order of overloads is irrelevant for subtyping. + +`overloaded.pyi`: + +```pyi +from typing import overload + +class A: ... +class B: ... + +@overload +def overload_ab(x: A) -> None: ... +@overload +def overload_ab(x: B) -> None: ... + +@overload +def overload_ba(x: B) -> None: ... +@overload +def overload_ba(x: A) -> None: ... +``` + +```py +from overloaded import overload_ab, overload_ba +from ty_extensions import CallableTypeOf, is_subtype_of, static_assert + +static_assert(is_subtype_of(CallableTypeOf[overload_ab], CallableTypeOf[overload_ba])) +static_assert(is_subtype_of(CallableTypeOf[overload_ba], CallableTypeOf[overload_ab])) +``` + +[special case for float and complex]: https://typing.python.org/en/latest/spec/special-types.html#special-cases-for-float-and-complex +[typing documentation]: https://typing.python.org/en/latest/spec/concepts.html#subtype-supertype-and-type-equivalence diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/str_repr.md b/crates/ty_python_semantic/resources/mdtest/type_properties/str_repr.md new file mode 100644 index 0000000000000..1539daabe1dc4 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/str_repr.md @@ -0,0 +1,27 @@ +# `__str__` and `__repr__` + +```py +from typing_extensions import Literal, LiteralString + +def _( + a: Literal[1], + b: Literal[True], + c: Literal[False], + d: Literal["ab'cd"], + e: LiteralString, + f: int, +): + reveal_type(str(a)) # revealed: Literal["1"] + reveal_type(str(b)) # revealed: Literal["True"] + reveal_type(str(c)) # revealed: Literal["False"] + reveal_type(str(d)) # revealed: Literal["ab'cd"] + reveal_type(str(e)) # revealed: LiteralString + reveal_type(str(f)) # revealed: str + + reveal_type(repr(a)) # revealed: Literal["1"] + reveal_type(repr(b)) # revealed: Literal["True"] + reveal_type(repr(c)) # revealed: Literal["False"] + reveal_type(repr(d)) # revealed: Literal["'ab\\'cd'"] + reveal_type(repr(e)) # revealed: LiteralString + reveal_type(repr(f)) # revealed: str +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/truthiness.md b/crates/ty_python_semantic/resources/mdtest/type_properties/truthiness.md new file mode 100644 index 0000000000000..4cb8bdbc458e6 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/truthiness.md @@ -0,0 +1,145 @@ +# Truthiness + +## Literals + +```py +from typing_extensions import Literal, LiteralString +from ty_extensions import AlwaysFalsy, AlwaysTruthy + +def _( + a: Literal[1], + b: Literal[-1], + c: Literal["foo"], + d: tuple[Literal[0]], + e: Literal[1, 2], + f: AlwaysTruthy, +): + reveal_type(bool(a)) # revealed: Literal[True] + reveal_type(bool(b)) # revealed: Literal[True] + reveal_type(bool(c)) # revealed: Literal[True] + reveal_type(bool(d)) # revealed: Literal[True] + reveal_type(bool(e)) # revealed: Literal[True] + reveal_type(bool(f)) # revealed: Literal[True] + +def _( + a: tuple[()], + b: Literal[0], + c: Literal[""], + d: Literal[b""], + e: Literal[0, 0], + f: AlwaysFalsy, +): + reveal_type(bool(a)) # revealed: Literal[False] + reveal_type(bool(b)) # revealed: Literal[False] + reveal_type(bool(c)) # revealed: Literal[False] + reveal_type(bool(d)) # revealed: Literal[False] + reveal_type(bool(e)) # revealed: Literal[False] + reveal_type(bool(f)) # revealed: Literal[False] + +def _( + a: str, + b: Literal[1, 0], + c: str | Literal[0], + d: str | Literal[1], +): + reveal_type(bool(a)) # revealed: bool + reveal_type(bool(b)) # revealed: bool + reveal_type(bool(c)) # revealed: bool + reveal_type(bool(d)) # revealed: bool +``` + +## Instances + +Checks that we don't get into a cycle if someone sets their `__bool__` method to the `bool` builtin: + +### __bool__ is bool + +```py +class BoolIsBool: + __bool__ = bool + +reveal_type(bool(BoolIsBool())) # revealed: bool +``` + +### Conditional __bool__ method + +```py +def flag() -> bool: + return True + +class Boom: + if flag(): + __bool__ = bool + else: + __bool__ = int + +reveal_type(bool(Boom())) # revealed: bool +``` + +### Possibly unbound __bool__ method + +```py +from typing import Literal + +def flag() -> bool: + return True + +class PossiblyUnboundTrue: + if flag(): + def __bool__(self) -> Literal[True]: + return True + +reveal_type(bool(PossiblyUnboundTrue())) # revealed: bool +``` + +### Special-cased classes + +Some special-cased `@final` classes are known by ty to have instances that are either always truthy +or always falsy. + +```toml +[environment] +python-version = "3.12" +``` + +```py +import types +import typing +import sys +from ty_extensions import AlwaysTruthy, static_assert, is_subtype_of +from typing_extensions import _NoDefaultType + +static_assert(is_subtype_of(sys.version_info.__class__, AlwaysTruthy)) +static_assert(is_subtype_of(types.EllipsisType, AlwaysTruthy)) +static_assert(is_subtype_of(_NoDefaultType, AlwaysTruthy)) +static_assert(is_subtype_of(slice, AlwaysTruthy)) +static_assert(is_subtype_of(types.FunctionType, AlwaysTruthy)) +static_assert(is_subtype_of(types.MethodType, AlwaysTruthy)) +static_assert(is_subtype_of(typing.TypeVar, AlwaysTruthy)) +static_assert(is_subtype_of(typing.TypeAliasType, AlwaysTruthy)) +static_assert(is_subtype_of(types.MethodWrapperType, AlwaysTruthy)) +static_assert(is_subtype_of(types.WrapperDescriptorType, AlwaysTruthy)) +``` + +### `Callable` types always have ambiguous truthiness + +```py +from typing import Callable + +def f(x: Callable, y: Callable[[int], str]): + reveal_type(bool(x)) # revealed: bool + reveal_type(bool(y)) # revealed: bool +``` + +But certain callable single-valued types are known to be always truthy: + +```py +from types import FunctionType + +class A: + def method(self): ... + +reveal_type(bool(A().method)) # revealed: Literal[True] +reveal_type(bool(f.__get__)) # revealed: Literal[True] +reveal_type(bool(FunctionType.__get__)) # revealed: Literal[True] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_properties/tuples_containing_never.md b/crates/ty_python_semantic/resources/mdtest/type_properties/tuples_containing_never.md new file mode 100644 index 0000000000000..5536b84c98d10 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_properties/tuples_containing_never.md @@ -0,0 +1,44 @@ +# Tuples containing `Never` + +A heterogeneous `tuple[…]` type that contains `Never` as a type argument simplifies to `Never`. One +way to think about this is the following: in order to construct a tuple, you need to have an object +of every element type. But since there is no object of type `Never`, you cannot construct the tuple. +Such a tuple type is therefore uninhabited and equivalent to `Never`. + +In the language of algebraic data types, a tuple type is a product type and `Never` acts like the +zero element in multiplication, similar to how a Cartesian product with the empty set is the empty +set. + +```py +from ty_extensions import static_assert, is_equivalent_to +from typing_extensions import Never, NoReturn + +static_assert(is_equivalent_to(Never, tuple[Never])) +static_assert(is_equivalent_to(Never, tuple[Never, int])) +static_assert(is_equivalent_to(Never, tuple[int, Never])) +static_assert(is_equivalent_to(Never, tuple[int, Never, str])) +static_assert(is_equivalent_to(Never, tuple[int, tuple[str, Never]])) +static_assert(is_equivalent_to(Never, tuple[tuple[str, Never], int])) + +def _(x: tuple[Never], y: tuple[int, Never], z: tuple[Never, int]): + reveal_type(x) # revealed: Never + reveal_type(y) # revealed: Never + reveal_type(z) # revealed: Never +``` + +The empty `tuple` is *not* equivalent to `Never`! + +```py +static_assert(not is_equivalent_to(Never, tuple[()])) +``` + +`NoReturn` is just a different spelling of `Never`, so the same is true for `NoReturn`: + +```py +static_assert(is_equivalent_to(NoReturn, tuple[NoReturn])) +static_assert(is_equivalent_to(NoReturn, tuple[NoReturn, int])) +static_assert(is_equivalent_to(NoReturn, tuple[int, NoReturn])) +static_assert(is_equivalent_to(NoReturn, tuple[int, NoReturn, str])) +static_assert(is_equivalent_to(NoReturn, tuple[int, tuple[str, NoReturn]])) +static_assert(is_equivalent_to(NoReturn, tuple[tuple[str, NoReturn], int])) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/type_qualifiers/classvar.md b/crates/ty_python_semantic/resources/mdtest/type_qualifiers/classvar.md new file mode 100644 index 0000000000000..fdf443db9cc04 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_qualifiers/classvar.md @@ -0,0 +1,117 @@ +# `typing.ClassVar` + +[`typing.ClassVar`] is a type qualifier that is used to indicate that a class variable may not be +written to from instances of that class. + +This test makes sure that we discover the type qualifier while inferring types from an annotation. +For more details on the semantics of pure class variables, see [this test](../attributes.md). + +## Basic + +```py +from typing import ClassVar, Annotated + +class C: + a: ClassVar[int] = 1 + b: Annotated[ClassVar[int], "the annotation for b"] = 1 + c: ClassVar[Annotated[int, "the annotation for c"]] = 1 + d: ClassVar = 1 + e: "ClassVar[int]" = 1 + +reveal_type(C.a) # revealed: int +reveal_type(C.b) # revealed: int +reveal_type(C.c) # revealed: int +# TODO: should be Unknown | Literal[1] +reveal_type(C.d) # revealed: Unknown +reveal_type(C.e) # revealed: int + +c = C() + +# error: [invalid-attribute-access] +c.a = 2 +# error: [invalid-attribute-access] +c.b = 2 +# error: [invalid-attribute-access] +c.c = 2 +# error: [invalid-attribute-access] +c.d = 2 +# error: [invalid-attribute-access] +c.e = 2 +``` + +## Conflicting type qualifiers + +We currently ignore conflicting qualifiers and simply union them, which is more conservative than +intersecting them. This means that we consider `a` to be a `ClassVar` here: + +```py +from typing import ClassVar + +def flag() -> bool: + return True + +class C: + if flag(): + a: ClassVar[int] = 1 + else: + a: str + +reveal_type(C.a) # revealed: int | str + +c = C() + +# error: [invalid-attribute-access] +c.a = 2 +``` + +and similarly here: + +```py +class Base: + a: ClassVar[int] = 1 + +class Derived(Base): + if flag(): + a: int + +reveal_type(Derived.a) # revealed: int + +d = Derived() + +# error: [invalid-attribute-access] +d.a = 2 +``` + +## Too many arguments + +```py +from typing import ClassVar + +class C: + # error: [invalid-type-form] "Type qualifier `typing.ClassVar` expects exactly one type parameter" + x: ClassVar[int, str] = 1 +``` + +## Illegal `ClassVar` in type expression + +```py +from typing import ClassVar + +class C: + # error: [invalid-type-form] "Type qualifier `typing.ClassVar` is not allowed in type expressions (only in annotation expressions)" + x: ClassVar | int + + # error: [invalid-type-form] "Type qualifier `typing.ClassVar` is not allowed in type expressions (only in annotation expressions)" + y: int | ClassVar[str] +``` + +## Used outside of a class + +```py +from typing import ClassVar + +# TODO: this should be an error +x: ClassVar[int] = 1 +``` + +[`typing.classvar`]: https://docs.python.org/3/library/typing.html#typing.ClassVar diff --git a/crates/ty_python_semantic/resources/mdtest/type_qualifiers/final.md b/crates/ty_python_semantic/resources/mdtest/type_qualifiers/final.md new file mode 100644 index 0000000000000..32e84412eb681 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/type_qualifiers/final.md @@ -0,0 +1,87 @@ +# `typing.Final` + +[`typing.Final`] is a type qualifier that is used to indicate that a symbol may not be reassigned in +any scope. Final names declared in class scopes cannot be overridden in subclasses. + +## Basic + +`mod.py`: + +```py +from typing import Final, Annotated + +FINAL_A: int = 1 +FINAL_B: Annotated[Final[int], "the annotation for FINAL_B"] = 1 +FINAL_C: Final[Annotated[int, "the annotation for FINAL_C"]] = 1 +FINAL_D: Final = 1 +FINAL_E: "Final[int]" = 1 + +reveal_type(FINAL_A) # revealed: Literal[1] +reveal_type(FINAL_B) # revealed: Literal[1] +reveal_type(FINAL_C) # revealed: Literal[1] +reveal_type(FINAL_D) # revealed: Literal[1] +reveal_type(FINAL_E) # revealed: Literal[1] + +# TODO: All of these should be errors: +FINAL_A = 2 +FINAL_B = 2 +FINAL_C = 2 +FINAL_D = 2 +FINAL_E = 2 +``` + +Public types: + +```py +from mod import FINAL_A, FINAL_B, FINAL_C, FINAL_D, FINAL_E + +# TODO: All of these should be Literal[1] +reveal_type(FINAL_A) # revealed: int +reveal_type(FINAL_B) # revealed: int +reveal_type(FINAL_C) # revealed: int +reveal_type(FINAL_D) # revealed: Unknown +reveal_type(FINAL_E) # revealed: int +``` + +## Too many arguments + +```py +from typing import Final + +class C: + # error: [invalid-type-form] "Type qualifier `typing.Final` expects exactly one type parameter" + x: Final[int, str] = 1 +``` + +## Illegal `Final` in type expression + +```py +from typing import Final + +class C: + # error: [invalid-type-form] "Type qualifier `typing.Final` is not allowed in type expressions (only in annotation expressions)" + x: Final | int + + # error: [invalid-type-form] "Type qualifier `typing.Final` is not allowed in type expressions (only in annotation expressions)" + y: int | Final[str] +``` + +## No assignment + +```py +from typing import Final + +DECLARED_THEN_BOUND: Final[int] +DECLARED_THEN_BOUND = 1 +``` + +## No assignment for bare `Final` + +```py +from typing import Final + +# TODO: This should be an error +NO_RHS: Final +``` + +[`typing.final`]: https://docs.python.org/3/library/typing.html#typing.Final diff --git a/crates/ty_python_semantic/resources/mdtest/typed_dict.md b/crates/ty_python_semantic/resources/mdtest/typed_dict.md new file mode 100644 index 0000000000000..217bfc9e4d5b3 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/typed_dict.md @@ -0,0 +1,27 @@ +# `TypedDict` + +We do not support `TypedDict`s yet. This test mainly exists to make sure that we do not emit any +errors for the definition of a `TypedDict`. + +```py +from typing_extensions import TypedDict, Required + +class Person(TypedDict): + name: str + age: int | None + +# TODO: This should not be an error: +# error: [invalid-assignment] +alice: Person = {"name": "Alice", "age": 30} + +# Alternative syntax +Message = TypedDict("Message", {"id": Required[int], "content": str}, total=False) + +msg = Message(id=1, content="Hello") + +# No errors for yet-unsupported features (`closed`): +OtherMessage = TypedDict("OtherMessage", {"id": int, "content": str}, closed=True) + +reveal_type(Person.__required_keys__) # revealed: @Todo(TypedDict) +reveal_type(Message.__required_keys__) # revealed: @Todo(TypedDict) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/unary/custom.md b/crates/ty_python_semantic/resources/mdtest/unary/custom.md new file mode 100644 index 0000000000000..1544e42890805 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/unary/custom.md @@ -0,0 +1,169 @@ +# Custom unary operations + +## Class instances + +```py +class Yes: + def __pos__(self) -> bool: + return False + + def __neg__(self) -> str: + return "negative" + + def __invert__(self) -> int: + return 17 + +class Sub(Yes): ... +class No: ... + +reveal_type(+Yes()) # revealed: bool +reveal_type(-Yes()) # revealed: str +reveal_type(~Yes()) # revealed: int + +reveal_type(+Sub()) # revealed: bool +reveal_type(-Sub()) # revealed: str +reveal_type(~Sub()) # revealed: int + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `No`" +reveal_type(+No()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `No`" +reveal_type(-No()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `No`" +reveal_type(~No()) # revealed: Unknown +``` + +## Classes + +Dunder methods defined in a class are available to instances of that class, but not to the class +itself. (For these operators to work on the class itself, they would have to be defined on the +class's type, i.e. `type`.) + +```py +class Yes: + def __pos__(self) -> bool: + return False + + def __neg__(self) -> str: + return "negative" + + def __invert__(self) -> int: + return 17 + +class Sub(Yes): ... +class No: ... + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `<class 'Yes'>`" +reveal_type(+Yes) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `<class 'Yes'>`" +reveal_type(-Yes) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `<class 'Yes'>`" +reveal_type(~Yes) # revealed: Unknown + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `<class 'Sub'>`" +reveal_type(+Sub) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `<class 'Sub'>`" +reveal_type(-Sub) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `<class 'Sub'>`" +reveal_type(~Sub) # revealed: Unknown + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `<class 'No'>`" +reveal_type(+No) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `<class 'No'>`" +reveal_type(-No) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `<class 'No'>`" +reveal_type(~No) # revealed: Unknown +``` + +## Function literals + +```py +def f(): + pass + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `def f() -> Unknown`" +reveal_type(+f) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `def f() -> Unknown`" +reveal_type(-f) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `def f() -> Unknown`" +reveal_type(~f) # revealed: Unknown +``` + +## Subclass + +```py +class Yes: + def __pos__(self) -> bool: + return False + + def __neg__(self) -> str: + return "negative" + + def __invert__(self) -> int: + return 17 + +class Sub(Yes): ... +class No: ... + +def yes() -> type[Yes]: + return Yes + +def sub() -> type[Sub]: + return Sub + +def no() -> type[No]: + return No + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `type[Yes]`" +reveal_type(+yes()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `type[Yes]`" +reveal_type(-yes()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `type[Yes]`" +reveal_type(~yes()) # revealed: Unknown + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `type[Sub]`" +reveal_type(+sub()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `type[Sub]`" +reveal_type(-sub()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `type[Sub]`" +reveal_type(~sub()) # revealed: Unknown + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `type[No]`" +reveal_type(+no()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `type[No]`" +reveal_type(-no()) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `type[No]`" +reveal_type(~no()) # revealed: Unknown +``` + +## Metaclass + +```py +class Meta(type): + def __pos__(self) -> bool: + return False + + def __neg__(self) -> str: + return "negative" + + def __invert__(self) -> int: + return 17 + +class Yes(metaclass=Meta): ... +class Sub(Yes): ... +class No: ... + +reveal_type(+Yes) # revealed: bool +reveal_type(-Yes) # revealed: str +reveal_type(~Yes) # revealed: int + +reveal_type(+Sub) # revealed: bool +reveal_type(-Sub) # revealed: str +reveal_type(~Sub) # revealed: int + +# error: [unsupported-operator] "Unary operator `+` is unsupported for type `<class 'No'>`" +reveal_type(+No) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `-` is unsupported for type `<class 'No'>`" +reveal_type(-No) # revealed: Unknown +# error: [unsupported-operator] "Unary operator `~` is unsupported for type `<class 'No'>`" +reveal_type(~No) # revealed: Unknown +``` diff --git a/crates/red_knot_python_semantic/resources/mdtest/unary/integers.md b/crates/ty_python_semantic/resources/mdtest/unary/integers.md similarity index 100% rename from crates/red_knot_python_semantic/resources/mdtest/unary/integers.md rename to crates/ty_python_semantic/resources/mdtest/unary/integers.md diff --git a/crates/ty_python_semantic/resources/mdtest/unary/invert_add_usub.md b/crates/ty_python_semantic/resources/mdtest/unary/invert_add_usub.md new file mode 100644 index 0000000000000..6b07cb1d2ee29 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/unary/invert_add_usub.md @@ -0,0 +1,33 @@ +# Invert, UAdd, USub + +## Instance + +```py +from typing import Literal + +class Number: + def __init__(self, value: int): + self.value = 1 + + def __pos__(self) -> int: + return +self.value + + def __neg__(self) -> int: + return -self.value + + def __invert__(self) -> Literal[True]: + return True + +a = Number(0) + +reveal_type(+a) # revealed: int +reveal_type(-a) # revealed: int +reveal_type(~a) # revealed: Literal[True] + +class NoDunder: ... + +b = NoDunder() ++b # error: [unsupported-operator] "Unary operator `+` is unsupported for type `NoDunder`" +-b # error: [unsupported-operator] "Unary operator `-` is unsupported for type `NoDunder`" +~b # error: [unsupported-operator] "Unary operator `~` is unsupported for type `NoDunder`" +``` diff --git a/crates/ty_python_semantic/resources/mdtest/unary/not.md b/crates/ty_python_semantic/resources/mdtest/unary/not.md new file mode 100644 index 0000000000000..e01796a9f7506 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/unary/not.md @@ -0,0 +1,217 @@ +# Unary not + +## None + +```py +reveal_type(not None) # revealed: Literal[True] +reveal_type(not not None) # revealed: Literal[False] +``` + +## Function + +```py +def f(): + return 1 + +reveal_type(not f) # revealed: Literal[False] +# TODO Unknown should not be part of the type of typing.reveal_type +# reveal_type(not reveal_type) revealed: Literal[False] +``` + +## Module + +```py +import b +import warnings + +reveal_type(not b) # revealed: Literal[False] +reveal_type(not warnings) # revealed: Literal[False] +``` + +`b.py`: + +```py +y = 1 +``` + +## Union + +```py +def _(flag: bool): + if flag: + p = 1 + q = 3.3 + r = "hello" + s = "world" + t = 0 + else: + p = "hello" + q = 4 + r = "" + s = 0 + t = "" + + reveal_type(not p) # revealed: Literal[False] + reveal_type(not q) # revealed: bool + reveal_type(not r) # revealed: bool + reveal_type(not s) # revealed: bool + reveal_type(not t) # revealed: Literal[True] +``` + +## Integer literal + +```py +reveal_type(not 1) # revealed: Literal[False] +reveal_type(not 1234567890987654321) # revealed: Literal[False] +reveal_type(not 0) # revealed: Literal[True] +reveal_type(not -1) # revealed: Literal[False] +reveal_type(not -1234567890987654321) # revealed: Literal[False] +reveal_type(not --987) # revealed: Literal[False] +``` + +## Boolean literal + +```py +w = True +reveal_type(w) # revealed: Literal[True] + +x = False +reveal_type(x) # revealed: Literal[False] + +reveal_type(not w) # revealed: Literal[False] + +reveal_type(not x) # revealed: Literal[True] +``` + +## String literal + +```py +reveal_type(not "hello") # revealed: Literal[False] +reveal_type(not "") # revealed: Literal[True] +reveal_type(not "0") # revealed: Literal[False] +reveal_type(not "hello" + "world") # revealed: Literal[False] +``` + +## Bytes literal + +```py +reveal_type(not b"hello") # revealed: Literal[False] +reveal_type(not b"") # revealed: Literal[True] +reveal_type(not b"0") # revealed: Literal[False] +reveal_type(not b"hello" + b"world") # revealed: Literal[False] +``` + +## Tuple + +```py +reveal_type(not (1,)) # revealed: Literal[False] +reveal_type(not (1, 2)) # revealed: Literal[False] +reveal_type(not (1, 2, 3)) # revealed: Literal[False] +reveal_type(not ()) # revealed: Literal[True] +reveal_type(not ("hello",)) # revealed: Literal[False] +reveal_type(not (1, "hello")) # revealed: Literal[False] +``` + +## Instance + +Not operator is inferred based on +<https://docs.python.org/3/library/stdtypes.html#truth-value-testing>. An instance is True or False +if the `__bool__` method says so. + +At runtime, the `__len__` method is a fallback for `__bool__`, but we can't make use of that. If we +have a class that defines `__len__` but not `__bool__`, it is possible that any subclass could add a +`__bool__` method that would invalidate whatever conclusion we drew from `__len__`. So instances of +classes without a `__bool__` method, with or without `__len__`, must be inferred as unknown +truthiness. + +```py +from typing import Literal + +class AlwaysTrue: + def __bool__(self) -> Literal[True]: + return True + +# revealed: Literal[False] +reveal_type(not AlwaysTrue()) + +class AlwaysFalse: + def __bool__(self) -> Literal[False]: + return False + +# revealed: Literal[True] +reveal_type(not AlwaysFalse()) + +# At runtime, no `__bool__` and no `__len__` means truthy, but we can't rely on that, because +# a subclass could add a `__bool__` method. +class NoBoolMethod: ... + +# revealed: bool +reveal_type(not NoBoolMethod()) + +# And we can't rely on `__len__` for the same reason: a subclass could add `__bool__`. +class LenZero: + def __len__(self) -> Literal[0]: + return 0 + +# revealed: bool +reveal_type(not LenZero()) + +class LenNonZero: + def __len__(self) -> Literal[1]: + return 1 + +# revealed: bool +reveal_type(not LenNonZero()) + +class WithBothLenAndBool1: + def __bool__(self) -> Literal[False]: + return False + + def __len__(self) -> Literal[2]: + return 2 + +# revealed: Literal[True] +reveal_type(not WithBothLenAndBool1()) + +class WithBothLenAndBool2: + def __bool__(self) -> Literal[True]: + return True + + def __len__(self) -> Literal[0]: + return 0 + +# revealed: Literal[False] +reveal_type(not WithBothLenAndBool2()) + +class MethodBoolInvalid: + def __bool__(self) -> int: + return 0 + +# error: [unsupported-bool-conversion] "Boolean conversion is unsupported for type `MethodBoolInvalid`" +# revealed: bool +reveal_type(not MethodBoolInvalid()) + +# Don't trust a possibly-unbound `__bool__` method: +def get_flag() -> bool: + return True + +class PossiblyUnboundBool: + if get_flag(): + def __bool__(self) -> Literal[False]: + return False + +# revealed: bool +reveal_type(not PossiblyUnboundBool()) +``` + +## Object that implements `__bool__` incorrectly + +<!-- snapshot-diagnostics --> + +```py +class NotBoolable: + __bool__: int = 3 + +# error: [unsupported-bool-conversion] +not NotBoolable() +``` diff --git a/crates/ty_python_semantic/resources/mdtest/union_types.md b/crates/ty_python_semantic/resources/mdtest/union_types.md new file mode 100644 index 0000000000000..50d20efb1248d --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/union_types.md @@ -0,0 +1,216 @@ +# Union types + +This test suite covers certain basic properties and simplification strategies for union types. + +## Basic unions + +```py +from typing import Literal + +def _(u1: int | str, u2: Literal[0] | Literal[1]) -> None: + reveal_type(u1) # revealed: int | str + reveal_type(u2) # revealed: Literal[0, 1] +``` + +## Duplicate elements are collapsed + +```py +def _(u1: int | int | str, u2: int | str | int) -> None: + reveal_type(u1) # revealed: int | str + reveal_type(u2) # revealed: int | str +``` + +## `Never` is removed + +`Never` is an empty set, a type with no inhabitants. Its presence in a union is always redundant, +and so we eagerly simplify it away. `NoReturn` is equivalent to `Never`. + +```py +from typing_extensions import Never, NoReturn + +def never(u1: int | Never, u2: int | Never | str) -> None: + reveal_type(u1) # revealed: int + reveal_type(u2) # revealed: int | str + +def noreturn(u1: int | NoReturn, u2: int | NoReturn | str) -> None: + reveal_type(u1) # revealed: int + reveal_type(u2) # revealed: int | str +``` + +## `object` subsumes everything + +Unions with `object` can be simplified to `object`: + +```py +from typing_extensions import Never, Any + +def _( + u1: int | object, + u2: object | int, + u3: Any | object, + u4: object | Any, + u5: object | Never, + u6: Never | object, + u7: int | str | object | bytes | Any, +) -> None: + reveal_type(u1) # revealed: object + reveal_type(u2) # revealed: object + reveal_type(u3) # revealed: object + reveal_type(u4) # revealed: object + reveal_type(u5) # revealed: object + reveal_type(u6) # revealed: object + reveal_type(u7) # revealed: object +``` + +## Flattening of nested unions + +```py +from typing import Literal + +def _( + u1: (int | str) | bytes, + u2: int | (str | bytes), + u3: int | (str | (bytes | bytearray)), +) -> None: + reveal_type(u1) # revealed: int | str | bytes + reveal_type(u2) # revealed: int | str | bytes + reveal_type(u3) # revealed: int | str | bytes | bytearray +``` + +## Simplification using subtyping + +The type `S | T` can be simplified to `T` if `S` is a subtype of `T`: + +```py +from typing_extensions import Literal, LiteralString + +def _( + u1: str | LiteralString, u2: LiteralString | str, u3: Literal["a"] | str | LiteralString, u4: str | bytes | LiteralString +) -> None: + reveal_type(u1) # revealed: str + reveal_type(u2) # revealed: str + reveal_type(u3) # revealed: str + reveal_type(u4) # revealed: str | bytes +``` + +## Boolean literals + +The union `Literal[True] | Literal[False]` is exactly equivalent to `bool`: + +```py +from typing import Literal + +def _( + u1: Literal[True, False], + u2: bool | Literal[True], + u3: Literal[True] | bool, + u4: Literal[True] | Literal[True, 17], + u5: Literal[True, False, True, 17], +) -> None: + reveal_type(u1) # revealed: bool + reveal_type(u2) # revealed: bool + reveal_type(u3) # revealed: bool + reveal_type(u4) # revealed: Literal[True, 17] + reveal_type(u5) # revealed: bool | Literal[17] +``` + +## Do not erase `Unknown` + +```py +from ty_extensions import Unknown + +def _(u1: Unknown | str, u2: str | Unknown) -> None: + reveal_type(u1) # revealed: Unknown | str + reveal_type(u2) # revealed: str | Unknown +``` + +## Collapse multiple `Unknown`s + +Since `Unknown` is a gradual type, it is not a subtype of anything, but multiple `Unknown`s in a +union are still redundant: + +```py +from ty_extensions import Unknown + +def _(u1: Unknown | Unknown | str, u2: Unknown | str | Unknown, u3: str | Unknown | Unknown) -> None: + reveal_type(u1) # revealed: Unknown | str + reveal_type(u2) # revealed: Unknown | str + reveal_type(u3) # revealed: str | Unknown +``` + +## Subsume multiple elements + +Simplifications still apply when `Unknown` is present. + +```py +from ty_extensions import Unknown + +def _(u1: int | Unknown | bool) -> None: + reveal_type(u1) # revealed: int | Unknown +``` + +## Union of intersections + +We can simplify unions of intersections: + +```py +from ty_extensions import Intersection, Not + +class P: ... +class Q: ... + +def _( + i1: Intersection[P, Q] | Intersection[P, Q], + i2: Intersection[P, Q] | Intersection[Q, P], +) -> None: + reveal_type(i1) # revealed: P & Q + reveal_type(i2) # revealed: P & Q +``` + +## Unions of literals with `AlwaysTruthy` and `AlwaysFalsy` + +```toml +[environment] +python-version = "3.12" +``` + +```py +from typing import Literal +from ty_extensions import AlwaysTruthy, AlwaysFalsy + +type strings = Literal["foo", ""] +type ints = Literal[0, 1] +type bytes = Literal[b"foo", b""] + +def _( + strings_or_truthy: strings | AlwaysTruthy, + truthy_or_strings: AlwaysTruthy | strings, + strings_or_falsy: strings | AlwaysFalsy, + falsy_or_strings: AlwaysFalsy | strings, + ints_or_truthy: ints | AlwaysTruthy, + truthy_or_ints: AlwaysTruthy | ints, + ints_or_falsy: ints | AlwaysFalsy, + falsy_or_ints: AlwaysFalsy | ints, + bytes_or_truthy: bytes | AlwaysTruthy, + truthy_or_bytes: AlwaysTruthy | bytes, + bytes_or_falsy: bytes | AlwaysFalsy, + falsy_or_bytes: AlwaysFalsy | bytes, +): + reveal_type(strings_or_truthy) # revealed: Literal[""] | AlwaysTruthy + reveal_type(truthy_or_strings) # revealed: AlwaysTruthy | Literal[""] + + reveal_type(strings_or_falsy) # revealed: Literal["foo"] | AlwaysFalsy + reveal_type(falsy_or_strings) # revealed: AlwaysFalsy | Literal["foo"] + + reveal_type(ints_or_truthy) # revealed: Literal[0] | AlwaysTruthy + reveal_type(truthy_or_ints) # revealed: AlwaysTruthy | Literal[0] + + reveal_type(ints_or_falsy) # revealed: Literal[1] | AlwaysFalsy + reveal_type(falsy_or_ints) # revealed: AlwaysFalsy | Literal[1] + + reveal_type(bytes_or_truthy) # revealed: Literal[b""] | AlwaysTruthy + reveal_type(truthy_or_bytes) # revealed: AlwaysTruthy | Literal[b""] + + reveal_type(bytes_or_falsy) # revealed: Literal[b"foo"] | AlwaysFalsy + reveal_type(falsy_or_bytes) # revealed: AlwaysFalsy | Literal[b"foo"] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/unpacking.md b/crates/ty_python_semantic/resources/mdtest/unpacking.md new file mode 100644 index 0000000000000..dac296b838849 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/unpacking.md @@ -0,0 +1,802 @@ +# Unpacking + +If there are not enough or too many values ​​when unpacking, an error will occur and the types of +all variables (if nested tuple unpacking fails, only the variables within the failed tuples) is +inferred to be `Unknown`. + +## Tuple + +### Simple tuple + +```py +(a, b, c) = (1, 2, 3) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +reveal_type(c) # revealed: Literal[3] +``` + +### Simple list + +```py +[a, b, c] = (1, 2, 3) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +reveal_type(c) # revealed: Literal[3] +``` + +### Simple mixed + +```py +[a, (b, c), d] = (1, (2, 3), 4) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +reveal_type(c) # revealed: Literal[3] +reveal_type(d) # revealed: Literal[4] +``` + +### Multiple assignment + +```py +a, b = c = 1, 2 +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +reveal_type(c) # revealed: tuple[Literal[1], Literal[2]] +``` + +### Nested tuple with unpacking + +```py +(a, (b, c), d) = (1, (2, 3), 4) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +reveal_type(c) # revealed: Literal[3] +reveal_type(d) # revealed: Literal[4] +``` + +### Nested tuple without unpacking + +```py +(a, b, c) = (1, (2, 3), 4) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: tuple[Literal[2], Literal[3]] +reveal_type(c) # revealed: Literal[4] +``` + +### Uneven unpacking (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 3" +(a, b, c) = (1, 2) +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +``` + +### Uneven unpacking (2) + +```py +# error: [invalid-assignment] "Too many values to unpack: Expected 2" +(a, b) = (1, 2, 3) +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Nested uneven unpacking (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +(a, (b, c), d) = (1, (2,), 3) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Literal[3] +``` + +### Nested uneven unpacking (2) + +```py +# error: [invalid-assignment] "Too many values to unpack: Expected 2" +(a, (b, c), d) = (1, (2, 3, 4), 5) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Literal[5] +``` + +### Starred expression (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 3 or more" +[a, *b, c, d] = (1, 2) +reveal_type(a) # revealed: Unknown +# TODO: Should be list[Any] once support for assigning to starred expression is added +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Unknown +``` + +### Starred expression (2) + +```py +[a, *b, c] = (1, 2) +reveal_type(a) # revealed: Literal[1] +# TODO: Should be list[Any] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: Literal[2] +``` + +### Starred expression (3) + +```py +[a, *b, c] = (1, 2, 3) +reveal_type(a) # revealed: Literal[1] +# TODO: Should be list[int] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: Literal[3] +``` + +### Starred expression (4) + +```py +[a, *b, c, d] = (1, 2, 3, 4, 5, 6) +reveal_type(a) # revealed: Literal[1] +# TODO: Should be list[int] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: Literal[5] +reveal_type(d) # revealed: Literal[6] +``` + +### Starred expression (5) + +```py +[a, b, *c] = (1, 2, 3, 4) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: Literal[2] +# TODO: Should be list[int] once support for assigning to starred expression is added +reveal_type(c) # revealed: @Todo(starred unpacking) +``` + +### Starred expression (6) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 5 or more" +(a, b, c, *d, e, f) = (1,) +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Unknown +reveal_type(e) # revealed: Unknown +reveal_type(f) # revealed: Unknown +``` + +### Non-iterable unpacking + +```py +# error: "Object of type `Literal[1]` is not iterable" +a, b = 1 +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Custom iterator unpacking + +```py +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +(a, b) = Iterable() +reveal_type(a) # revealed: int +reveal_type(b) # revealed: int +``` + +### Custom iterator unpacking nested + +```py +class Iterator: + def __next__(self) -> int: + return 42 + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +(a, (b, c), d) = (1, Iterable(), 2) +reveal_type(a) # revealed: Literal[1] +reveal_type(b) # revealed: int +reveal_type(c) # revealed: int +reveal_type(d) # revealed: Literal[2] +``` + +## String + +### Simple unpacking + +```py +a, b = "ab" +reveal_type(a) # revealed: LiteralString +reveal_type(b) # revealed: LiteralString +``` + +### Uneven unpacking (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 3" +a, b, c = "ab" +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +``` + +### Uneven unpacking (2) + +```py +# error: [invalid-assignment] "Too many values to unpack: Expected 2" +a, b = "abc" +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Starred expression (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 3 or more" +(a, *b, c, d) = "ab" +reveal_type(a) # revealed: Unknown +# TODO: Should be list[LiteralString] once support for assigning to starred expression is added +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Unknown +``` + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 3 or more" +(a, b, *c, d) = "a" +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +reveal_type(c) # revealed: Unknown +reveal_type(d) # revealed: Unknown +``` + +### Starred expression (2) + +```py +(a, *b, c) = "ab" +reveal_type(a) # revealed: LiteralString +# TODO: Should be list[Any] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: LiteralString +``` + +### Starred expression (3) + +```py +(a, *b, c) = "abc" +reveal_type(a) # revealed: LiteralString +# TODO: Should be list[LiteralString] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: LiteralString +``` + +### Starred expression (4) + +```py +(a, *b, c, d) = "abcdef" +reveal_type(a) # revealed: LiteralString +# TODO: Should be list[LiteralString] once support for assigning to starred expression is added +reveal_type(b) # revealed: @Todo(starred unpacking) +reveal_type(c) # revealed: LiteralString +reveal_type(d) # revealed: LiteralString +``` + +### Starred expression (5) + +```py +(a, b, *c) = "abcd" +reveal_type(a) # revealed: LiteralString +reveal_type(b) # revealed: LiteralString +# TODO: Should be list[int] once support for assigning to starred expression is added +reveal_type(c) # revealed: @Todo(starred unpacking) +``` + +### Unicode + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +(a, b) = "é" + +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Unicode escape (1) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +(a, b) = "\u9e6c" + +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Unicode escape (2) + +```py +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +(a, b) = "\U0010ffff" + +reveal_type(a) # revealed: Unknown +reveal_type(b) # revealed: Unknown +``` + +### Surrogates + +```py +(a, b) = "\ud800\udfff" + +reveal_type(a) # revealed: LiteralString +reveal_type(b) # revealed: LiteralString +``` + +## Union + +### Same types + +Union of two tuples of equal length and each element is of the same type. + +```py +def _(arg: tuple[int, int] | tuple[int, int]): + (a, b) = arg + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int +``` + +### Mixed types (1) + +Union of two tuples of equal length and one element differs in its type. + +```py +def _(arg: tuple[int, int] | tuple[int, str]): + a, b = arg + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int | str +``` + +### Mixed types (2) + +Union of two tuples of equal length and both the element types are different. + +```py +def _(arg: tuple[int, str] | tuple[str, int]): + a, b = arg + reveal_type(a) # revealed: int | str + reveal_type(b) # revealed: str | int +``` + +### Mixed types (3) + +Union of three tuples of equal length and various combination of element types: + +1. All same types +1. One different type +1. All different types + +```py +def _(arg: tuple[int, int, int] | tuple[int, str, bytes] | tuple[int, int, str]): + a, b, c = arg + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int | str + reveal_type(c) # revealed: int | bytes | str +``` + +### Nested + +```py +from typing import Literal + +def _(arg: tuple[int, tuple[str, bytes]] | tuple[tuple[int, bytes], Literal["ab"]]): + a, (b, c) = arg + reveal_type(a) # revealed: int | tuple[int, bytes] + reveal_type(b) # revealed: str + reveal_type(c) # revealed: bytes | LiteralString +``` + +### Starred expression + +```py +def _(arg: tuple[int, bytes, int] | tuple[int, int, str, int, bytes]): + a, *b, c = arg + reveal_type(a) # revealed: int + # TODO: Should be `list[bytes | int | str]` + reveal_type(b) # revealed: @Todo(starred unpacking) + reveal_type(c) # revealed: int | bytes +``` + +### Size mismatch (1) + +```py +def _(arg: tuple[int, bytes, int] | tuple[int, int, str, int, bytes]): + # error: [invalid-assignment] "Too many values to unpack: Expected 2" + # error: [invalid-assignment] "Too many values to unpack: Expected 2" + a, b = arg + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown +``` + +### Size mismatch (2) + +```py +def _(arg: tuple[int, bytes] | tuple[int, str]): + # error: [invalid-assignment] "Not enough values to unpack: Expected 3" + # error: [invalid-assignment] "Not enough values to unpack: Expected 3" + a, b, c = arg + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown +``` + +### Same literal types + +```py +def _(flag: bool): + if flag: + value = (1, 2) + else: + value = (3, 4) + + a, b = value + reveal_type(a) # revealed: Literal[1, 3] + reveal_type(b) # revealed: Literal[2, 4] +``` + +### Mixed literal types + +```py +def _(flag: bool): + if flag: + value = (1, 2) + else: + value = ("a", "b") + + a, b = value + reveal_type(a) # revealed: Literal[1, "a"] + reveal_type(b) # revealed: Literal[2, "b"] +``` + +### Typing literal + +```py +from typing import Literal + +def _(arg: tuple[int, int] | Literal["ab"]): + a, b = arg + reveal_type(a) # revealed: int | LiteralString + reveal_type(b) # revealed: int | LiteralString +``` + +### Custom iterator (1) + +```py +class Iterator: + def __next__(self) -> tuple[int, int] | tuple[int, str]: + return (1, 2) + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +((a, b), c) = Iterable() +reveal_type(a) # revealed: int +reveal_type(b) # revealed: int | str +reveal_type(c) # revealed: tuple[int, int] | tuple[int, str] +``` + +### Custom iterator (2) + +```py +class Iterator: + def __next__(self) -> bytes: + return b"" + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +def _(arg: tuple[int, str] | Iterable): + a, b = arg + reveal_type(a) # revealed: int | bytes + reveal_type(b) # revealed: str | bytes +``` + +## For statement + +Unpacking in a `for` statement. + +### Same types + +```py +def _(arg: tuple[tuple[int, int], tuple[int, int]]): + for a, b in arg: + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int +``` + +### Mixed types (1) + +```py +def _(arg: tuple[tuple[int, int], tuple[int, str]]): + for a, b in arg: + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int | str +``` + +### Mixed types (2) + +```py +def _(arg: tuple[tuple[int, str], tuple[str, int]]): + for a, b in arg: + reveal_type(a) # revealed: int | str + reveal_type(b) # revealed: str | int +``` + +### Mixed types (3) + +```py +def _(arg: tuple[tuple[int, int, int], tuple[int, str, bytes], tuple[int, int, str]]): + for a, b, c in arg: + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int | str + reveal_type(c) # revealed: int | bytes | str +``` + +### Same literal values + +```py +for a, b in ((1, 2), (3, 4)): + reveal_type(a) # revealed: Literal[1, 3] + reveal_type(b) # revealed: Literal[2, 4] +``` + +### Mixed literal values (1) + +```py +for a, b in ((1, 2), ("a", "b")): + reveal_type(a) # revealed: Literal[1, "a"] + reveal_type(b) # revealed: Literal[2, "b"] +``` + +### Mixed literals values (2) + +```py +# error: "Object of type `Literal[1]` is not iterable" +# error: "Object of type `Literal[2]` is not iterable" +# error: "Object of type `Literal[4]` is not iterable" +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +for a, b in (1, 2, (3, "a"), 4, (5, "b"), "c"): + reveal_type(a) # revealed: Unknown | Literal[3, 5] + reveal_type(b) # revealed: Unknown | Literal["a", "b"] +``` + +### Custom iterator (1) + +```py +class Iterator: + def __next__(self) -> tuple[int, int]: + return (1, 2) + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +for a, b in Iterable(): + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int +``` + +### Custom iterator (2) + +```py +class Iterator: + def __next__(self) -> bytes: + return b"" + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +def _(arg: tuple[tuple[int, str], Iterable]): + for a, b in arg: + reveal_type(a) # revealed: int | bytes + reveal_type(b) # revealed: str | bytes +``` + +## With statement + +Unpacking in a `with` statement. + +### Same types + +```py +class ContextManager: + def __enter__(self) -> tuple[int, int]: + return (1, 2) + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +with ContextManager() as (a, b): + reveal_type(a) # revealed: int + reveal_type(b) # revealed: int +``` + +### Mixed types + +```py +class ContextManager: + def __enter__(self) -> tuple[int, str]: + return (1, "a") + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +with ContextManager() as (a, b): + reveal_type(a) # revealed: int + reveal_type(b) # revealed: str +``` + +### Nested + +```py +class ContextManager: + def __enter__(self) -> tuple[int, tuple[str, bytes]]: + return (1, ("a", b"bytes")) + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +with ContextManager() as (a, (b, c)): + reveal_type(a) # revealed: int + reveal_type(b) # revealed: str + reveal_type(c) # revealed: bytes +``` + +### Starred expression + +```py +class ContextManager: + def __enter__(self) -> tuple[int, int, int]: + return (1, 2, 3) + + def __exit__(self, exc_type, exc_value, traceback) -> None: + pass + +with ContextManager() as (a, *b): + reveal_type(a) # revealed: int + # TODO: Should be list[int] once support for assigning to starred expression is added + reveal_type(b) # revealed: @Todo(starred unpacking) +``` + +### Unbound context manager expression + +```py +# TODO: should only be one diagnostic +# error: [unresolved-reference] "Name `nonexistant` used when not defined" +# error: [unresolved-reference] "Name `nonexistant` used when not defined" +# error: [unresolved-reference] "Name `nonexistant` used when not defined" +with nonexistant as (x, y): + reveal_type(x) # revealed: Unknown + reveal_type(y) # revealed: Unknown +``` + +### Invalid unpacking + +```py +class ContextManager: + def __enter__(self) -> tuple[int, str]: + return (1, "a") + + def __exit__(self, *args) -> None: + pass + +# error: [invalid-assignment] "Not enough values to unpack: Expected 3" +with ContextManager() as (a, b, c): + reveal_type(a) # revealed: Unknown + reveal_type(b) # revealed: Unknown + reveal_type(c) # revealed: Unknown +``` + +## Comprehension + +Unpacking in a comprehension. + +### Same types + +```py +def _(arg: tuple[tuple[int, int], tuple[int, int]]): + # revealed: tuple[int, int] + [reveal_type((a, b)) for a, b in arg] +``` + +### Mixed types (1) + +```py +def _(arg: tuple[tuple[int, int], tuple[int, str]]): + # revealed: tuple[int, int | str] + [reveal_type((a, b)) for a, b in arg] +``` + +### Mixed types (2) + +```py +def _(arg: tuple[tuple[int, str], tuple[str, int]]): + # revealed: tuple[int | str, str | int] + [reveal_type((a, b)) for a, b in arg] +``` + +### Mixed types (3) + +```py +def _(arg: tuple[tuple[int, int, int], tuple[int, str, bytes], tuple[int, int, str]]): + # revealed: tuple[int, int | str, int | bytes | str] + [reveal_type((a, b, c)) for a, b, c in arg] +``` + +### Same literal values + +```py +# revealed: tuple[Literal[1, 3], Literal[2, 4]] +[reveal_type((a, b)) for a, b in ((1, 2), (3, 4))] +``` + +### Mixed literal values (1) + +```py +# revealed: tuple[Literal[1, "a"], Literal[2, "b"]] +[reveal_type((a, b)) for a, b in ((1, 2), ("a", "b"))] +``` + +### Mixed literals values (2) + +```py +# error: "Object of type `Literal[1]` is not iterable" +# error: "Object of type `Literal[2]` is not iterable" +# error: "Object of type `Literal[4]` is not iterable" +# error: [invalid-assignment] "Not enough values to unpack: Expected 2" +# revealed: tuple[Unknown | Literal[3, 5], Unknown | Literal["a", "b"]] +[reveal_type((a, b)) for a, b in (1, 2, (3, "a"), 4, (5, "b"), "c")] +``` + +### Custom iterator (1) + +```py +class Iterator: + def __next__(self) -> tuple[int, int]: + return (1, 2) + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +# revealed: tuple[int, int] +[reveal_type((a, b)) for a, b in Iterable()] +``` + +### Custom iterator (2) + +```py +class Iterator: + def __next__(self) -> bytes: + return b"" + +class Iterable: + def __iter__(self) -> Iterator: + return Iterator() + +def _(arg: tuple[tuple[int, str], Iterable]): + # revealed: tuple[int | bytes, str | bytes] + [reveal_type((a, b)) for a, b in arg] +``` diff --git a/crates/ty_python_semantic/resources/mdtest/unreachable.md b/crates/ty_python_semantic/resources/mdtest/unreachable.md new file mode 100644 index 0000000000000..0348816b49d6f --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/unreachable.md @@ -0,0 +1,577 @@ +# Unreachable code + +This document describes our approach to handling unreachable code. There are two aspects to this. +One is to detect and mark blocks of code that are unreachable. This is useful for notifying the +user, as it can often be indicative of an error. The second aspect of this is to make sure that we +do not emit (incorrect) diagnostics in unreachable code. + +## Detecting unreachable code + +In this section, we look at various scenarios how sections of code can become unreachable. We should +eventually introduce a new diagnostic that would detect unreachable code. In an editor/LSP context, +there are ways to 'gray out' sections of code, which is helpful for blocks of code that are not +'dead' code, but inactive under certain conditions, like platform-specific code. + +### Terminal statements + +In the following examples, the `print` statements are definitely unreachable. + +```py +def f1(): + return + + # TODO: we should mark this as unreachable + print("unreachable") + +def f2(): + raise Exception() + + # TODO: we should mark this as unreachable + print("unreachable") + +def f3(): + while True: + break + + # TODO: we should mark this as unreachable + print("unreachable") + +def f4(): + for _ in range(10): + continue + + # TODO: we should mark this as unreachable + print("unreachable") +``` + +### Infinite loops + +```py +def f1(): + while True: + pass + + # TODO: we should mark this as unreachable + print("unreachable") +``` + +### Statically known branches + +In the following examples, the `print` statements are also unreachable, but it requires type +inference to determine that: + +```py +def f1(): + if 2 + 3 > 10: + # TODO: we should mark this as unreachable + print("unreachable") + +def f2(): + if True: + return + + # TODO: we should mark this as unreachable + print("unreachable") +``` + +### `Never` / `NoReturn` + +If a function is annotated with a return type of `Never` or `NoReturn`, we can consider all code +after the call to that function unreachable. + +```py +from typing_extensions import NoReturn + +def always_raises() -> NoReturn: + raise Exception() + +def f(): + always_raises() + + # TODO: we should mark this as unreachable + print("unreachable") +``` + +### Python version and platform checks + +It is common to have code that is specific to a certain Python version or platform. This case is +special because whether or not the code is reachable depends on externally configured constants. And +if we are checking for a set of parameters that makes one of these branches unreachable, that is +likely not something that the user wants to be warned about, because there are probably other sets +of parameters that make the branch reachable. + +#### `sys.version_info` branches + +Consider the following example. If we check with a Python version lower than 3.11, the import +statement is unreachable. If we check with a Python version equal to or greater than 3.11, the +import statement is definitely reachable. We should not emit any diagnostics in either case. + +##### Checking with Python version 3.10 + +```toml +[environment] +python-version = "3.10" +``` + +```py +import sys + +if sys.version_info >= (3, 11): + from typing import Self +``` + +##### Checking with Python version 3.12 + +```toml +[environment] +python-version = "3.12" +``` + +```py +import sys + +if sys.version_info >= (3, 11): + from typing import Self +``` + +#### `sys.platform` branches + +The problem is even more pronounced with `sys.platform` branches, since we don't necessarily have +the platform information available. + +##### Checking with platform `win32` + +```toml +[environment] +python-platform = "win32" +``` + +```py +import sys + +if sys.platform == "win32": + sys.getwindowsversion() +``` + +##### Checking with platform `linux` + +```toml +[environment] +python-platform = "linux" +``` + +```py +import sys + +if sys.platform == "win32": + sys.getwindowsversion() +``` + +##### Checking with platform set to `all` + +```toml +[environment] +python-platform = "all" +``` + +If `python-platform` is set to `all`, we treat the platform as unspecified. This means that we do +not infer a literal type like `Literal["win32"]` for `sys.platform`, but instead fall back to +`LiteralString` (the `typeshed` annotation for `sys.platform`). This means that we can not +statically determine the truthiness of a branch like `sys.platform == "win32"`. + +See <https://github.com/astral-sh/ruff/issues/16983#issuecomment-2777146188> for a plan on how this +could be improved. + +```py +import sys + +if sys.platform == "win32": + # TODO: we should not emit an error here + # error: [possibly-unbound-attribute] + sys.getwindowsversion() +``` + +## No (incorrect) diagnostics in unreachable code + +```toml +[environment] +python-version = "3.10" +``` + +In this section, we demonstrate that we do not emit (incorrect) diagnostics in unreachable sections +of code. + +It could be argued that no diagnostics at all should be emitted in unreachable code. The reasoning +is that any issues inside the unreachable section would not cause problems at runtime. And type +checking the unreachable code under the assumption that it *is* reachable might lead to false +positives (see the "Global constants" example below). + +On the other hand, it could be argued that code like `1 + "a"` is incorrect, no matter if it is +reachable or not. Some developers like to use things like early `return` statements while debugging, +and for this use case, it is helpful to still see some diagnostics in unreachable sections. + +We currently follow the second approach, but we do not attempt to provide the full set of +diagnostics in unreachable sections. In fact, we silence a certain category of diagnostics +(`unresolved-reference`, `unresolved-attribute`, …), in order to avoid *incorrect* diagnostics. In +the future, we may revisit this decision. + +### Use of variables in unreachable code + +We should not emit any diagnostics for uses of symbols in unreachable code: + +```py +def f(): + x = 1 + return + + print("unreachable") + + print(x) +``` + +### Use of variable in nested function + +In the example below, since we use `x` in the `inner` function, we use the "public" type of `x`, +which currently refers to the end-of-scope type of `x`. Since the end of the `outer` scope is +unreachable, we need to make sure that we do not emit an `unresolved-reference` diagnostic: + +```py +def outer(): + x = 1 + + def inner(): + reveal_type(x) # revealed: Unknown + while True: + pass +``` + +### Global constants + +```py +from typing import Literal + +FEATURE_X_ACTIVATED: Literal[False] = False + +if FEATURE_X_ACTIVATED: + def feature_x(): + print("Performing 'X'") + +def f(): + if FEATURE_X_ACTIVATED: + # Type checking this particular section as if it were reachable would + # lead to a false positive, so we should not emit diagnostics here. + + feature_x() +``` + +### Exhaustive check of syntactic constructs + +We include some more examples here to make sure that silencing of diagnostics works for +syntactically different cases. To test this, we use `ExceptionGroup`, which is only available in +Python 3.11 and later. We have set the Python version to 3.10 for this whole section, to have +`match` statements available, but not `ExceptionGroup`. + +To start, we make sure that we do not emit a diagnostic in this simple case: + +```py +import sys + +if sys.version_info >= (3, 11): + ExceptionGroup # no error here +``` + +Similarly, if we negate the logic, we also emit no error: + +```py +if sys.version_info < (3, 11): + pass +else: + ExceptionGroup # no error here +``` + +This also works for more complex `if`-`elif`-`else` chains: + +```py +if sys.version_info >= (3, 13): + ExceptionGroup # no error here +elif sys.version_info >= (3, 12): + ExceptionGroup # no error here +elif sys.version_info >= (3, 11): + ExceptionGroup # no error here +elif sys.version_info >= (3, 10): + pass +else: + pass +``` + +And for nested `if` statements: + +```py +def _(flag: bool): + if flag: + if sys.version_info >= (3, 11): + ExceptionGroup # no error here + else: + pass + + if sys.version_info < (3, 11): + pass + else: + ExceptionGroup # no error here +``` + +The same works for ternary expressions: + +```py +class ExceptionGroupPolyfill: ... + +MyExceptionGroup1 = ExceptionGroup if sys.version_info >= (3, 11) else ExceptionGroupPolyfill +MyExceptionGroup1 = ExceptionGroupPolyfill if sys.version_info < (3, 11) else ExceptionGroup +``` + +Due to short-circuiting, this also works for Boolean operators: + +```py +sys.version_info >= (3, 11) and ExceptionGroup +sys.version_info < (3, 11) or ExceptionGroup +``` + +And in `match` statements: + +```py +reveal_type(sys.version_info.minor) # revealed: Literal[10] + +match sys.version_info.minor: + case 13: + ExceptionGroup + case 12: + ExceptionGroup + case 11: + ExceptionGroup + case _: + pass +``` + +Terminal statements can also lead to unreachable code: + +```py +def f(): + if sys.version_info < (3, 11): + raise RuntimeError("this code only works for Python 3.11+") + + ExceptionGroup +``` + +Similarly, assertions with statically-known falsy conditions can lead to unreachable code: + +```py +def f(): + assert sys.version_info > (3, 11) + + ExceptionGroup +``` + +Finally, not that anyone would ever use it, but it also works for `while` loops: + +```py +while sys.version_info >= (3, 11): + ExceptionGroup +``` + +### Silencing errors for actually unknown symbols + +We currently also silence diagnostics for symbols that are not actually defined anywhere. It is +conceivable that this could be improved, but is not a priority for now. + +```py +if False: + does_not_exist + +def f(): + return + does_not_exist +``` + +### Attributes + +When attribute expressions appear in unreachable code, we should not emit `unresolved-attribute` +diagnostics: + +```py +import sys +import builtins + +if sys.version_info >= (3, 11): + builtins.ExceptionGroup +``` + +### Imports + +When import statements appear in unreachable code, we should not emit `unresolved-import` +diagnostics: + +```py +import sys + +if sys.version_info >= (3, 11): + from builtins import ExceptionGroup + + import builtins.ExceptionGroup + + # See https://docs.python.org/3/whatsnew/3.11.html#new-modules + + import tomllib + + import wsgiref.types +``` + +### Nested scopes + +When we have nested scopes inside the unreachable section, we should not emit diagnostics either: + +```py +if False: + x = 1 + + def f(): + print(x) + + class C: + def __init__(self): + print(x) +``` + +### Type annotations + +Silencing of diagnostics also works for type annotations, even if they are stringified: + +```py +import sys +import typing + +if sys.version_info >= (3, 11): + from typing import Self + + class C: + def name_expr(self) -> Self: + return self + + def name_expr_stringified(self) -> "Self": + return self + + def attribute_expr(self) -> typing.Self: + return self + + def attribute_expr_stringified(self) -> "typing.Self": + return self +``` + +### Use of unreachable symbols in type annotations, or as class bases + +We should not show any diagnostics in type annotations inside unreachable sections. + +```py +def _(): + class C: + class Inner: ... + + return + + c1: C = C() + c2: C.Inner = C.Inner() + c3: tuple[C, C] = (C(), C()) + c4: tuple[C.Inner, C.Inner] = (C.Inner(), C.Inner()) + + class Sub(C): ... +``` + +### Emit diagnostics for definitely wrong code + +Even though the expressions in the snippet below are unreachable, we still emit diagnostics for +them: + +```py +if False: + 1 + "a" # error: [unsupported-operator] + +def f(): + return + + 1 / 0 # error: [division-by-zero] +``` + +## Limitations of the current approach + +The current approach of silencing only a subset of diagnostics in unreachable code leads to some +problems, and we may want to re-evaluate this decision in the future. To illustrate, consider the +following example: + +```py +if False: + x: int = 1 +else: + x: str = "a" + +if False: + # TODO We currently emit a false positive here: + # error: [invalid-assignment] "Object of type `Literal["a"]` is not assignable to `int`" + other: int = x +else: + other: str = x +``` + +The problem here originates from the fact that the type of `x` in the `False` branch conflicts with +the visible type of `x` in the `True` branch. When we type-check the lower `False` branch, we only +see the visible definition of `x`, which has a type of `str`. + +In principle, this means that all diagnostics that depend on type information from "outside" the +unreachable section should be silenced. Similar problems to the one above can occur for other rule +types as well: + +```py +from typing import Literal + +if False: + def f(x: int): ... + def g(*, a: int, b: int): ... + + class C: + x: int = 1 + + class D: + def __call__(self): + pass + + number: Literal[1] = 1 +else: + def f(x: str): ... + def g(*, a: int): ... + + class C: + x: str = "a" + + class D: ... + number: Literal[0] = 0 + +if False: + # TODO + # error: [invalid-argument-type] + f(2) + + # TODO + # error: [unknown-argument] + g(a=2, b=3) + + # TODO + # error: [invalid-assignment] + C.x = 2 + + d: D = D() + # TODO + # error: [call-non-callable] + d() + + # TODO + # error: [division-by-zero] + 1 / number +``` diff --git a/crates/ty_python_semantic/resources/mdtest/with/async.md b/crates/ty_python_semantic/resources/mdtest/with/async.md new file mode 100644 index 0000000000000..2a98c50cb2036 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/with/async.md @@ -0,0 +1,21 @@ +# Async with statements + +## Basic `async with` statement + +The type of the target variable in a `with` statement should be the return type from the context +manager's `__aenter__` method. However, `async with` statements aren't supported yet. This test +asserts that it doesn't emit any context manager-related errors. + +```py +class Target: ... + +class Manager: + async def __aenter__(self) -> Target: + return Target() + + async def __aexit__(self, exc_type, exc_value, traceback): ... + +async def test(): + async with Manager() as f: + reveal_type(f) # revealed: @Todo(async `with` statement) +``` diff --git a/crates/ty_python_semantic/resources/mdtest/with/sync.md b/crates/ty_python_semantic/resources/mdtest/with/sync.md new file mode 100644 index 0000000000000..b180d6f55c4b9 --- /dev/null +++ b/crates/ty_python_semantic/resources/mdtest/with/sync.md @@ -0,0 +1,151 @@ +# With statements + +## Basic `with` statement + +The type of the target variable in a `with` statement is the return type from the context manager's +`__enter__` method. + +```py +class Target: ... + +class Manager: + def __enter__(self) -> Target: + return Target() + + def __exit__(self, exc_type, exc_value, traceback): ... + +with Manager() as f: + reveal_type(f) # revealed: Target +``` + +## Union context manager + +```py +def _(flag: bool): + class Manager1: + def __enter__(self) -> str: + return "foo" + + def __exit__(self, exc_type, exc_value, traceback): ... + + class Manager2: + def __enter__(self) -> int: + return 42 + + def __exit__(self, exc_type, exc_value, traceback): ... + + context_expr = Manager1() if flag else Manager2() + + with context_expr as f: + reveal_type(f) # revealed: str | int +``` + +## Context manager without an `__enter__` or `__exit__` method + +```py +class Manager: ... + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not implement `__enter__` and `__exit__`" +with Manager(): + ... +``` + +## Context manager without an `__enter__` method + +```py +class Manager: + def __exit__(self, exc_tpe, exc_value, traceback): ... + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not implement `__enter__`" +with Manager(): + ... +``` + +## Context manager without an `__exit__` method + +```py +class Manager: + def __enter__(self): ... + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not implement `__exit__`" +with Manager(): + ... +``` + +## Context manager with non-callable `__enter__` attribute + +```py +class Manager: + __enter__: int = 42 + + def __exit__(self, exc_tpe, exc_value, traceback): ... + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not correctly implement `__enter__`" +with Manager(): + ... +``` + +## Context manager with non-callable `__exit__` attribute + +```py +from typing_extensions import Self + +class Manager: + def __enter__(self) -> Self: + return self + __exit__: int = 32 + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not correctly implement `__exit__`" +with Manager(): + ... +``` + +## Context expression with possibly-unbound union variants + +```py +def _(flag: bool): + class Manager1: + def __enter__(self) -> str: + return "foo" + + def __exit__(self, exc_type, exc_value, traceback): ... + + class NotAContextManager: ... + context_expr = Manager1() if flag else NotAContextManager() + + # error: [invalid-context-manager] "Object of type `Manager1 | NotAContextManager` cannot be used with `with` because the methods `__enter__` and `__exit__` are possibly unbound" + with context_expr as f: + reveal_type(f) # revealed: str +``` + +## Context expression with "sometimes" callable `__enter__` method + +```py +def _(flag: bool): + class Manager: + if flag: + def __enter__(self) -> str: + return "abcd" + + def __exit__(self, *args): ... + + # error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because the method `__enter__` is possibly unbound" + with Manager() as f: + reveal_type(f) # revealed: str +``` + +## Invalid `__enter__` signature + +```py +class Manager: + def __enter__() -> str: + return "foo" + + def __exit__(self, exc_type, exc_value, traceback): ... + +context_expr = Manager() + +# error: [invalid-context-manager] "Object of type `Manager` cannot be used with `with` because it does not correctly implement `__enter__`" +with context_expr as f: + reveal_type(f) # revealed: str +``` diff --git a/crates/ty_python_semantic/resources/primer/bad.txt b/crates/ty_python_semantic/resources/primer/bad.txt new file mode 100644 index 0000000000000..d54f0407e8420 --- /dev/null +++ b/crates/ty_python_semantic/resources/primer/bad.txt @@ -0,0 +1,26 @@ +Tanjun # hangs +antidote # hangs / slow +artigraph # cycle panics (value_type_) +core # cycle panics (value_type_) +cpython # access to field whilst being initialized, too many cycle iterations +discord.py # some kind of hang, only when multi-threaded? +freqtrade # hangs +hydpy # too many iterations +ibis # too many iterations +jax # too many iterations +packaging # too many iterations +pandas # slow +pandas-stubs # hangs/slow, or else https://github.com/salsa-rs/salsa/issues/831 +pandera # stack overflow +pip # vendors packaging, see above +prefect # slow +pylint # cycle panics (self-recursive type alias) +pyodide # too many cycle iterations +pywin32 # bad use-def map (binding with definitely-visible unbound) +schemathesis # https://github.com/salsa-rs/salsa/issues/831 +scikit-learn # success, but mypy-primer hangs processing the output +setuptools # vendors packaging, see above +spack # success, but mypy-primer hangs processing the output +spark # too many iterations +steam.py # hangs +xarray # too many iterations diff --git a/crates/ty_python_semantic/resources/primer/good.txt b/crates/ty_python_semantic/resources/primer/good.txt new file mode 100644 index 0000000000000..abaebc99b119e --- /dev/null +++ b/crates/ty_python_semantic/resources/primer/good.txt @@ -0,0 +1,118 @@ +AutoSplit +Expression +PyGithub +PyWinCtl +SinbadCogs +aiohttp +aiohttp-devtools +aioredis +aiortc +alectryon +alerta +altair +anyio +apprise +arviz +async-utils +asynq +attrs +bandersnatch +beartype +bidict +black +bokeh +boostedblob +check-jsonschema +cki-lib +cloud-init +colour +com2ann +comtypes +cwltool +dacite +dd-trace-py +dedupe +django-stubs +downforeveryone +dragonchain +dulwich +flake8 +flake8-pyi +git-revise +graphql-core +httpx-caching +hydra-zen +ignite +imagehash +isort +itsdangerous +janus +jinja +koda-validate +kopf +kornia +manticore +materialize +meson +mitmproxy +mkdocs +mkosi +mongo-python-driver +more-itertools +mypy +mypy-protobuf +mypy_primer +nionutils +nox +openlibrary +operator +optuna +paasta +paroxython +parso +pegen +poetry +porcupine +ppb-vector +psycopg +pwndbg +pybind11 +pycryptodome +pydantic +pyinstrument +pyjwt +pylox +pyp +pyppeteer +pytest +pytest-robotframework +python-chess +python-htmlgen +python-sop +rclip +rich +rotki +schema_salad +scipy +scrapy +sockeye +speedrun.com_global_scoreboard_webapp +sphinx +starlette +static-frame +stone +strawberry +streamlit +sympy +tornado +trio +twine +typeshed-stats +urllib3 +vision +websockets +werkzeug +xarray-dataclasses +yarl +zipp +zulip diff --git a/crates/ty_python_semantic/src/ast_node_ref.rs b/crates/ty_python_semantic/src/ast_node_ref.rs new file mode 100644 index 0000000000000..7d460fed1989c --- /dev/null +++ b/crates/ty_python_semantic/src/ast_node_ref.rs @@ -0,0 +1,202 @@ +use std::hash::Hash; +use std::ops::Deref; + +use ruff_db::parsed::ParsedModule; + +/// Ref-counted owned reference to an AST node. +/// +/// The type holds an owned reference to the node's ref-counted [`ParsedModule`]. +/// Holding on to the node's [`ParsedModule`] guarantees that the reference to the +/// node must still be valid. +/// +/// Holding on to any [`AstNodeRef`] prevents the [`ParsedModule`] from being released. +/// +/// ## Equality +/// Two `AstNodeRef` are considered equal if their pointer addresses are equal. +/// +/// ## Usage in salsa tracked structs +/// It's important that [`AstNodeRef`] fields in salsa tracked structs are tracked fields +/// (attributed with `#[tracked`]). It prevents that the tracked struct gets a new ID +/// every time the AST changes, which in turn, invalidates the result of any query +/// that takes said tracked struct as a query argument or returns the tracked struct as part of its result. +/// +/// For example, marking the [`AstNodeRef`] as tracked on `Expression` +/// has the effect that salsa will consider the expression as "unchanged" for as long as it: +/// +/// * belongs to the same file +/// * belongs to the same scope +/// * has the same kind +/// * was created in the same order +/// +/// This means that changes to expressions in other scopes don't invalidate the expression's id, giving +/// us some form of scope-stable identity for expressions. Only queries accessing the node field +/// run on every AST change. All other queries only run when the expression's identity changes. +#[derive(Clone)] +pub struct AstNodeRef<T> { + /// Owned reference to the node's [`ParsedModule`]. + /// + /// The node's reference is guaranteed to remain valid as long as it's enclosing + /// [`ParsedModule`] is alive. + parsed: ParsedModule, + + /// Pointer to the referenced node. + node: std::ptr::NonNull<T>, +} + +#[expect(unsafe_code)] +impl<T> AstNodeRef<T> { + /// Creates a new `AstNodeRef` that references `node`. The `parsed` is the [`ParsedModule`] to + /// which the `AstNodeRef` belongs. + /// + /// ## Safety + /// + /// Dereferencing the `node` can result in undefined behavior if `parsed` isn't the + /// [`ParsedModule`] to which `node` belongs. It's the caller's responsibility to ensure that + /// the invariant `node belongs to parsed` is upheld. + pub(super) unsafe fn new(parsed: ParsedModule, node: &T) -> Self { + Self { + parsed, + node: std::ptr::NonNull::from(node), + } + } + + /// Returns a reference to the wrapped node. + pub const fn node(&self) -> &T { + // SAFETY: Holding on to `parsed` ensures that the AST to which `node` belongs is still + // alive and not moved. + unsafe { self.node.as_ref() } + } +} + +impl<T> Deref for AstNodeRef<T> { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.node() + } +} + +impl<T> std::fmt::Debug for AstNodeRef<T> +where + T: std::fmt::Debug, +{ + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_tuple("AstNodeRef").field(&self.node()).finish() + } +} + +impl<T> PartialEq for AstNodeRef<T> +where + T: PartialEq, +{ + fn eq(&self, other: &Self) -> bool { + if self.parsed == other.parsed { + // Comparing the pointer addresses is sufficient to determine equality + // if the parsed are the same. + self.node.eq(&other.node) + } else { + // Otherwise perform a deep comparison. + self.node().eq(other.node()) + } + } +} + +impl<T> Eq for AstNodeRef<T> where T: Eq {} + +impl<T> Hash for AstNodeRef<T> +where + T: Hash, +{ + fn hash<H: std::hash::Hasher>(&self, state: &mut H) { + self.node().hash(state); + } +} + +#[expect(unsafe_code)] +unsafe impl<T> salsa::Update for AstNodeRef<T> { + unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool { + let old_ref = unsafe { &mut (*old_pointer) }; + + if old_ref.parsed == new_value.parsed && old_ref.node.eq(&new_value.node) { + false + } else { + *old_ref = new_value; + true + } + } +} + +#[expect(unsafe_code)] +unsafe impl<T> Send for AstNodeRef<T> where T: Send {} +#[expect(unsafe_code)] +unsafe impl<T> Sync for AstNodeRef<T> where T: Sync {} + +#[cfg(test)] +mod tests { + use crate::ast_node_ref::AstNodeRef; + use ruff_db::parsed::ParsedModule; + use ruff_python_ast::PySourceType; + use ruff_python_parser::parse_unchecked_source; + + #[test] + #[expect(unsafe_code)] + fn equality() { + let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); + let parsed = ParsedModule::new(parsed_raw.clone()); + + let stmt = &parsed.syntax().body[0]; + + let node1 = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; + let node2 = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; + + assert_eq!(node1, node2); + + // Compare from different trees + let cloned = ParsedModule::new(parsed_raw); + let stmt_cloned = &cloned.syntax().body[0]; + let cloned_node = unsafe { AstNodeRef::new(cloned.clone(), stmt_cloned) }; + + assert_eq!(node1, cloned_node); + + let other_raw = parse_unchecked_source("2 + 2", PySourceType::Python); + let other = ParsedModule::new(other_raw); + + let other_stmt = &other.syntax().body[0]; + let other_node = unsafe { AstNodeRef::new(other.clone(), other_stmt) }; + + assert_ne!(node1, other_node); + } + + #[expect(unsafe_code)] + #[test] + fn inequality() { + let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); + let parsed = ParsedModule::new(parsed_raw); + + let stmt = &parsed.syntax().body[0]; + let node = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; + + let other_raw = parse_unchecked_source("2 + 2", PySourceType::Python); + let other = ParsedModule::new(other_raw); + + let other_stmt = &other.syntax().body[0]; + let other_node = unsafe { AstNodeRef::new(other.clone(), other_stmt) }; + + assert_ne!(node, other_node); + } + + #[test] + #[expect(unsafe_code)] + fn debug() { + let parsed_raw = parse_unchecked_source("1 + 2", PySourceType::Python); + let parsed = ParsedModule::new(parsed_raw); + + let stmt = &parsed.syntax().body[0]; + + let stmt_node = unsafe { AstNodeRef::new(parsed.clone(), stmt) }; + + let debug = format!("{stmt_node:?}"); + + assert_eq!(debug, format!("AstNodeRef({stmt:?})")); + } +} diff --git a/crates/ty_python_semantic/src/db.rs b/crates/ty_python_semantic/src/db.rs new file mode 100644 index 0000000000000..99e560905b6d7 --- /dev/null +++ b/crates/ty_python_semantic/src/db.rs @@ -0,0 +1,202 @@ +use crate::lint::{LintRegistry, RuleSelection}; +use ruff_db::files::File; +use ruff_db::{Db as SourceDb, Upcast}; + +/// Database giving access to semantic information about a Python program. +#[salsa::db] +pub trait Db: SourceDb + Upcast<dyn SourceDb> { + fn is_file_open(&self, file: File) -> bool; + + fn rule_selection(&self) -> &RuleSelection; + + fn lint_registry(&self) -> &LintRegistry; +} + +#[cfg(test)] +pub(crate) mod tests { + use std::sync::{Arc, Mutex}; + + use crate::program::{Program, SearchPathSettings}; + use crate::{ + ProgramSettings, PythonPlatform, PythonVersionSource, PythonVersionWithSource, + default_lint_registry, + }; + + use super::Db; + use crate::lint::{LintRegistry, RuleSelection}; + use anyhow::Context; + use ruff_db::files::{File, Files}; + use ruff_db::system::{ + DbWithTestSystem, DbWithWritableSystem as _, System, SystemPath, SystemPathBuf, TestSystem, + }; + use ruff_db::vendored::VendoredFileSystem; + use ruff_db::{Db as SourceDb, Upcast}; + use ruff_python_ast::PythonVersion; + + type Events = Arc<Mutex<Vec<salsa::Event>>>; + + #[salsa::db] + #[derive(Clone)] + pub(crate) struct TestDb { + storage: salsa::Storage<Self>, + files: Files, + system: TestSystem, + vendored: VendoredFileSystem, + events: Events, + rule_selection: Arc<RuleSelection>, + } + + impl TestDb { + pub(crate) fn new() -> Self { + let events = Events::default(); + Self { + storage: salsa::Storage::new(Some(Box::new({ + let events = events.clone(); + move |event| { + tracing::trace!("event: {event:?}"); + let mut events = events.lock().unwrap(); + events.push(event); + } + }))), + system: TestSystem::default(), + vendored: ty_vendored::file_system().clone(), + events, + files: Files::default(), + rule_selection: Arc::new(RuleSelection::from_registry(default_lint_registry())), + } + } + + /// Takes the salsa events. + pub(crate) fn take_salsa_events(&mut self) -> Vec<salsa::Event> { + let mut events = self.events.lock().unwrap(); + + std::mem::take(&mut *events) + } + + /// Clears the salsa events. + /// + /// ## Panics + /// If there are any pending salsa snapshots. + pub(crate) fn clear_salsa_events(&mut self) { + self.take_salsa_events(); + } + } + + impl DbWithTestSystem for TestDb { + fn test_system(&self) -> &TestSystem { + &self.system + } + + fn test_system_mut(&mut self) -> &mut TestSystem { + &mut self.system + } + } + + #[salsa::db] + impl SourceDb for TestDb { + fn vendored(&self) -> &VendoredFileSystem { + &self.vendored + } + + fn system(&self) -> &dyn System { + &self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> PythonVersion { + Program::get(self).python_version(self) + } + } + + impl Upcast<dyn SourceDb> for TestDb { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } + } + + #[salsa::db] + impl Db for TestDb { + fn is_file_open(&self, file: File) -> bool { + !file.path(self).is_vendored_path() + } + + fn rule_selection(&self) -> &RuleSelection { + &self.rule_selection + } + + fn lint_registry(&self) -> &LintRegistry { + default_lint_registry() + } + } + + #[salsa::db] + impl salsa::Database for TestDb {} + + pub(crate) struct TestDbBuilder<'a> { + /// Target Python version + python_version: PythonVersion, + /// Target Python platform + python_platform: PythonPlatform, + /// Path and content pairs for files that should be present + files: Vec<(&'a str, &'a str)>, + } + + impl<'a> TestDbBuilder<'a> { + pub(crate) fn new() -> Self { + Self { + python_version: PythonVersion::default(), + python_platform: PythonPlatform::default(), + files: vec![], + } + } + + pub(crate) fn with_python_version(mut self, version: PythonVersion) -> Self { + self.python_version = version; + self + } + + pub(crate) fn with_file( + mut self, + path: &'a (impl AsRef<SystemPath> + ?Sized), + content: &'a str, + ) -> Self { + self.files.push((path.as_ref().as_str(), content)); + self + } + + pub(crate) fn build(self) -> anyhow::Result<TestDb> { + let mut db = TestDb::new(); + + let src_root = SystemPathBuf::from("/src"); + db.memory_file_system().create_directory_all(&src_root)?; + + db.write_files(self.files) + .context("Failed to write test files")?; + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource { + version: self.python_version, + source: PythonVersionSource::default(), + }, + python_platform: self.python_platform, + search_paths: SearchPathSettings::new(vec![src_root]), + }, + ) + .context("Failed to configure Program settings")?; + + Ok(db) + } + } + + pub(crate) fn setup_db() -> TestDb { + TestDbBuilder::new().build().expect("valid TestDb setup") + } +} diff --git a/crates/ty_python_semantic/src/dunder_all.rs b/crates/ty_python_semantic/src/dunder_all.rs new file mode 100644 index 0000000000000..4265de2ac6d8f --- /dev/null +++ b/crates/ty_python_semantic/src/dunder_all.rs @@ -0,0 +1,465 @@ +use rustc_hash::FxHashSet; + +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_python_ast::name::Name; +use ruff_python_ast::statement_visitor::{StatementVisitor, walk_stmt}; +use ruff_python_ast::{self as ast}; + +use crate::semantic_index::ast_ids::HasScopedExpressionId; +use crate::semantic_index::symbol::ScopeId; +use crate::semantic_index::{SemanticIndex, global_scope, semantic_index}; +use crate::types::{Truthiness, Type, infer_expression_types}; +use crate::{Db, ModuleName, resolve_module}; + +#[allow(clippy::ref_option)] +fn dunder_all_names_cycle_recover( + _db: &dyn Db, + _value: &Option<FxHashSet<Name>>, + _count: u32, + _file: File, +) -> salsa::CycleRecoveryAction<Option<FxHashSet<Name>>> { + salsa::CycleRecoveryAction::Iterate +} + +fn dunder_all_names_cycle_initial(_db: &dyn Db, _file: File) -> Option<FxHashSet<Name>> { + None +} + +/// Returns a set of names in the `__all__` variable for `file`, [`None`] if it is not defined or +/// if it contains invalid elements. +#[salsa::tracked(returns(as_ref), cycle_fn=dunder_all_names_cycle_recover, cycle_initial=dunder_all_names_cycle_initial)] +pub(crate) fn dunder_all_names(db: &dyn Db, file: File) -> Option<FxHashSet<Name>> { + let _span = tracing::trace_span!("dunder_all_names", file=?file.path(db)).entered(); + + let module = parsed_module(db.upcast(), file); + let index = semantic_index(db, file); + let mut collector = DunderAllNamesCollector::new(db, file, index); + collector.visit_body(module.suite()); + collector.into_names() +} + +/// A visitor that collects the names in the `__all__` variable of a module. +struct DunderAllNamesCollector<'db> { + db: &'db dyn Db, + file: File, + + /// The scope in which the `__all__` names are being collected from. + /// + /// This is always going to be the global scope of the module. + scope: ScopeId<'db>, + + /// The semantic index for the module. + index: &'db SemanticIndex<'db>, + + /// The origin of the `__all__` variable in the current module, [`None`] if it is not defined. + origin: Option<DunderAllOrigin>, + + /// A flag indicating whether the module uses unrecognized `__all__` idioms or there are any + /// invalid elements in `__all__`. + invalid: bool, + + /// A set of names found in `__all__` for the current module. + names: FxHashSet<Name>, +} + +impl<'db> DunderAllNamesCollector<'db> { + fn new(db: &'db dyn Db, file: File, index: &'db SemanticIndex<'db>) -> Self { + Self { + db, + file, + scope: global_scope(db, file), + index, + origin: None, + invalid: false, + names: FxHashSet::default(), + } + } + + /// Updates the origin of `__all__` in the current module. + /// + /// This will clear existing names if the origin is changed to mimic the behavior of overriding + /// `__all__` in the current module. + fn update_origin(&mut self, origin: DunderAllOrigin) { + if self.origin.is_some() { + self.names.clear(); + } + self.origin = Some(origin); + } + + /// Extends the current set of names with the names from the given expression which can be + /// either a list/tuple/set of string-literal names or a module's `__all__` variable. + /// + /// Returns `true` if the expression is a valid list/tuple/set or module `__all__`, `false` otherwise. + fn extend(&mut self, expr: &ast::Expr) -> bool { + match expr { + // `__all__ += [...]` + // `__all__.extend([...])` + ast::Expr::List(ast::ExprList { elts, .. }) + | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) + | ast::Expr::Set(ast::ExprSet { elts, .. }) => self.add_names(elts), + + // `__all__ += module.__all__` + // `__all__.extend(module.__all__)` + ast::Expr::Attribute(ast::ExprAttribute { value, attr, .. }) => { + if attr != "__all__" { + return false; + } + let Type::ModuleLiteral(module_literal) = self.standalone_expression_type(value) + else { + return false; + }; + let Some(module_dunder_all_names) = module_literal + .module(self.db) + .file() + .and_then(|file| dunder_all_names(self.db, file)) + else { + // The module either does not have a `__all__` variable or it is invalid. + return false; + }; + self.names.extend(module_dunder_all_names.iter().cloned()); + true + } + + _ => false, + } + } + + /// Processes a call idiom for `__all__` and updates the set of names accordingly. + /// + /// Returns `true` if the call idiom is recognized and valid, `false` otherwise. + fn process_call_idiom( + &mut self, + function_name: &ast::Identifier, + arguments: &ast::Arguments, + ) -> bool { + if arguments.len() != 1 { + return false; + } + let Some(argument) = arguments.find_positional(0) else { + return false; + }; + match function_name.as_str() { + // `__all__.extend([...])` + // `__all__.extend(module.__all__)` + "extend" => { + if !self.extend(argument) { + return false; + } + } + + // `__all__.append(...)` + "append" => { + let Some(name) = create_name(argument) else { + return false; + }; + self.names.insert(name); + } + + // `__all__.remove(...)` + "remove" => { + let Some(name) = create_name(argument) else { + return false; + }; + self.names.remove(&name); + } + + _ => return false, + } + true + } + + /// Returns the names in `__all__` from the module imported from the given `import_from` + /// statement. + /// + /// Returns [`None`] if module resolution fails, invalid syntax, or if the module does not have + /// a `__all__` variable. + fn dunder_all_names_for_import_from( + &self, + import_from: &ast::StmtImportFrom, + ) -> Option<&'db FxHashSet<Name>> { + let module_name = + ModuleName::from_import_statement(self.db, self.file, import_from).ok()?; + let module = resolve_module(self.db, &module_name)?; + dunder_all_names(self.db, module.file()?) + } + + /// Infer the type of a standalone expression. + /// + /// # Panics + /// + /// This function panics if `expr` was not marked as a standalone expression during semantic indexing. + fn standalone_expression_type(&self, expr: &ast::Expr) -> Type<'db> { + infer_expression_types(self.db, self.index.expression(expr)) + .expression_type(expr.scoped_expression_id(self.db, self.scope)) + } + + /// Evaluate the given expression and return its truthiness. + /// + /// Returns [`None`] if the expression type doesn't implement `__bool__` correctly. + fn evaluate_test_expr(&self, expr: &ast::Expr) -> Option<Truthiness> { + self.standalone_expression_type(expr).try_bool(self.db).ok() + } + + /// Add valid names to the set. + /// + /// Returns `false` if any of the names are invalid. + fn add_names(&mut self, exprs: &[ast::Expr]) -> bool { + for expr in exprs { + let Some(name) = create_name(expr) else { + return false; + }; + self.names.insert(name); + } + true + } + + /// Consumes `self` and returns the collected set of names. + /// + /// Returns [`None`] if `__all__` is not defined in the current module or if it contains + /// invalid elements. + fn into_names(self) -> Option<FxHashSet<Name>> { + if self.origin.is_none() { + None + } else if self.invalid { + tracing::debug!("Invalid `__all__` in `{}`", self.file.path(self.db)); + None + } else { + Some(self.names) + } + } +} + +impl<'db> StatementVisitor<'db> for DunderAllNamesCollector<'db> { + fn visit_stmt(&mut self, stmt: &'db ast::Stmt) { + if self.invalid { + return; + } + + match stmt { + ast::Stmt::ImportFrom(import_from @ ast::StmtImportFrom { names, .. }) => { + for ast::Alias { name, asname, .. } in names { + // `from module import *` where `module` is a module with a top-level `__all__` + // variable that contains the "__all__" element. + if name == "*" { + // Here, we need to use the `dunder_all_names` query instead of the + // `exported_names` query because a `*`-import does not import the + // `__all__` attribute unless it is explicitly included in the `__all__` of + // the module. + let Some(all_names) = self.dunder_all_names_for_import_from(import_from) + else { + self.invalid = true; + continue; + }; + + if all_names.contains(&Name::new_static("__all__")) { + self.update_origin(DunderAllOrigin::StarImport); + self.names.extend(all_names.iter().cloned()); + } + } else { + // `from module import __all__` + // `from module import __all__ as __all__` + if name != "__all__" + || asname.as_ref().is_some_and(|asname| asname != "__all__") + { + continue; + } + + // We could do the `__all__` lookup lazily in case it's not needed. This would + // happen if a `__all__` is imported from another module but then the module + // redefines it. For example: + // + // ```python + // from module import __all__ as __all__ + // + // __all__ = ["a", "b"] + // ``` + // + // I'm avoiding this for now because it doesn't seem likely to happen in + // practice. + let Some(all_names) = self.dunder_all_names_for_import_from(import_from) + else { + self.invalid = true; + continue; + }; + + self.update_origin(DunderAllOrigin::ExternalModule); + self.names.extend(all_names.iter().cloned()); + } + } + } + + ast::Stmt::Assign(ast::StmtAssign { targets, value, .. }) => { + let [target] = targets.as_slice() else { + return; + }; + if !is_dunder_all(target) { + return; + } + match &**value { + // `__all__ = [...]` + // `__all__ = (...)` + ast::Expr::List(ast::ExprList { elts, .. }) + | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => { + self.update_origin(DunderAllOrigin::CurrentModule); + if !self.add_names(elts) { + self.invalid = true; + } + } + _ => { + self.invalid = true; + } + } + } + + ast::Stmt::AugAssign(ast::StmtAugAssign { + target, + op: ast::Operator::Add, + value, + .. + }) => { + if self.origin.is_none() { + // We can't update `__all__` if it doesn't already exist. + return; + } + if !is_dunder_all(target) { + return; + } + if !self.extend(value) { + self.invalid = true; + } + } + + ast::Stmt::AnnAssign(ast::StmtAnnAssign { + target, + value: Some(value), + .. + }) => { + if !is_dunder_all(target) { + return; + } + match &**value { + // `__all__: list[str] = [...]` + // `__all__: tuple[str, ...] = (...)` + ast::Expr::List(ast::ExprList { elts, .. }) + | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => { + self.update_origin(DunderAllOrigin::CurrentModule); + if !self.add_names(elts) { + self.invalid = true; + } + } + _ => { + self.invalid = true; + } + } + } + + ast::Stmt::Expr(ast::StmtExpr { value: expr, .. }) => { + if self.origin.is_none() { + // We can't update `__all__` if it doesn't already exist. + return; + } + let Some(ast::ExprCall { + func, arguments, .. + }) = expr.as_call_expr() + else { + return; + }; + let Some(ast::ExprAttribute { + value, + attr, + ctx: ast::ExprContext::Load, + .. + }) = func.as_attribute_expr() + else { + return; + }; + if !is_dunder_all(value) { + return; + } + if !self.process_call_idiom(attr, arguments) { + self.invalid = true; + } + } + + ast::Stmt::If(ast::StmtIf { + test, + body, + elif_else_clauses, + .. + }) => match self.evaluate_test_expr(test) { + Some(Truthiness::AlwaysTrue) => self.visit_body(body), + Some(Truthiness::AlwaysFalse) => { + for ast::ElifElseClause { test, body, .. } in elif_else_clauses { + if let Some(test) = test { + match self.evaluate_test_expr(test) { + Some(Truthiness::AlwaysTrue) => { + self.visit_body(body); + break; + } + Some(Truthiness::AlwaysFalse) => {} + Some(Truthiness::Ambiguous) | None => { + break; + } + } + } else { + self.visit_body(body); + } + } + } + Some(Truthiness::Ambiguous) | None => {} + }, + + ast::Stmt::For(..) + | ast::Stmt::While(..) + | ast::Stmt::With(..) + | ast::Stmt::Match(..) + | ast::Stmt::Try(..) => { + walk_stmt(self, stmt); + } + + ast::Stmt::FunctionDef(..) | ast::Stmt::ClassDef(..) => { + // Avoid recursing into any nested scopes as `__all__` is only valid at the module + // level. + } + + ast::Stmt::AugAssign(..) + | ast::Stmt::AnnAssign(..) + | ast::Stmt::Delete(..) + | ast::Stmt::Return(..) + | ast::Stmt::Raise(..) + | ast::Stmt::Assert(..) + | ast::Stmt::Import(..) + | ast::Stmt::Global(..) + | ast::Stmt::Nonlocal(..) + | ast::Stmt::TypeAlias(..) + | ast::Stmt::Pass(..) + | ast::Stmt::Break(..) + | ast::Stmt::Continue(..) + | ast::Stmt::IpyEscapeCommand(..) => {} + } + } +} + +#[derive(Debug, Clone)] +enum DunderAllOrigin { + /// The `__all__` variable is defined in the current module. + CurrentModule, + + /// The `__all__` variable is imported from another module. + ExternalModule, + + /// The `__all__` variable is imported from a module via a `*`-import. + StarImport, +} + +/// Checks if the given expression is a name expression for `__all__`. +fn is_dunder_all(expr: &ast::Expr) -> bool { + matches!(expr, ast::Expr::Name(ast::ExprName { id, .. }) if id == "__all__") +} + +/// Create and return a [`Name`] from the given expression, [`None`] if it is an invalid expression +/// for a `__all__` element. +fn create_name(expr: &ast::Expr) -> Option<Name> { + Some(Name::new(expr.as_string_literal_expr()?.value.to_str())) +} diff --git a/crates/ty_python_semantic/src/lib.rs b/crates/ty_python_semantic/src/lib.rs new file mode 100644 index 0000000000000..8857a48341f77 --- /dev/null +++ b/crates/ty_python_semantic/src/lib.rs @@ -0,0 +1,56 @@ +use std::hash::BuildHasherDefault; + +use rustc_hash::FxHasher; + +use crate::lint::{LintRegistry, LintRegistryBuilder}; +use crate::suppression::{INVALID_IGNORE_COMMENT, UNKNOWN_RULE, UNUSED_IGNORE_COMMENT}; +pub use db::Db; +pub use module_name::ModuleName; +pub use module_resolver::{KnownModule, Module, resolve_module, system_module_search_paths}; +pub use program::{ + Program, ProgramSettings, PythonPath, PythonVersionSource, PythonVersionWithSource, + SearchPathSettings, +}; +pub use python_platform::PythonPlatform; +pub use semantic_model::{HasType, SemanticModel}; +pub use site_packages::SysPrefixPathOrigin; + +pub mod ast_node_ref; +mod db; +mod dunder_all; +pub mod lint; +pub(crate) mod list; +mod module_name; +mod module_resolver; +mod node_key; +mod program; +mod python_platform; +pub mod semantic_index; +mod semantic_model; +pub(crate) mod site_packages; +mod suppression; +pub(crate) mod symbol; +pub mod types; +mod unpack; +mod util; + +type FxOrderSet<V> = ordermap::set::OrderSet<V, BuildHasherDefault<FxHasher>>; + +/// Returns the default registry with all known semantic lints. +pub fn default_lint_registry() -> &'static LintRegistry { + static REGISTRY: std::sync::LazyLock<LintRegistry> = std::sync::LazyLock::new(|| { + let mut registry = LintRegistryBuilder::default(); + register_lints(&mut registry); + registry.build() + }); + + ®ISTRY +} + +/// Register all known semantic lints. +pub fn register_lints(registry: &mut LintRegistryBuilder) { + types::register_lints(registry); + registry.register_lint(&UNUSED_IGNORE_COMMENT); + registry.register_lint(&UNKNOWN_RULE); + registry.register_lint(&INVALID_IGNORE_COMMENT); +} diff --git a/crates/ty_python_semantic/src/lint.rs b/crates/ty_python_semantic/src/lint.rs new file mode 100644 index 0000000000000..2acaa24b0f22b --- /dev/null +++ b/crates/ty_python_semantic/src/lint.rs @@ -0,0 +1,555 @@ +use core::fmt; +use itertools::Itertools; +use ruff_db::diagnostic::{DiagnosticId, LintName, Severity}; +use rustc_hash::FxHashMap; +use std::fmt::Formatter; +use std::hash::Hasher; +use thiserror::Error; + +#[derive(Debug, Clone)] +pub struct LintMetadata { + /// The unique identifier for the lint. + pub name: LintName, + + /// A one-sentence summary of what the lint catches. + pub summary: &'static str, + + /// An in depth explanation of the lint in markdown. Covers what the lint does, why it's bad and possible fixes. + /// + /// The documentation may require post-processing to be rendered correctly. For example, lines + /// might have leading or trailing whitespace that should be removed. + pub raw_documentation: &'static str, + + /// The default level of the lint if the user doesn't specify one. + pub default_level: Level, + + pub status: LintStatus, + + /// The source file in which the lint is declared. + pub file: &'static str, + + /// The 1-based line number in the source `file` where the lint is declared. + pub line: u32, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)] +#[cfg_attr( + feature = "serde", + derive(serde::Serialize, serde::Deserialize), + serde(rename_all = "kebab-case") +)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub enum Level { + /// # Ignore + /// + /// The lint is disabled and should not run. + Ignore, + + /// # Warn + /// + /// The lint is enabled and diagnostic should have a warning severity. + Warn, + + /// # Error + /// + /// The lint is enabled and diagnostics have an error severity. + Error, +} + +impl Level { + pub const fn is_error(self) -> bool { + matches!(self, Level::Error) + } + + pub const fn is_warn(self) -> bool { + matches!(self, Level::Warn) + } + + pub const fn is_ignore(self) -> bool { + matches!(self, Level::Ignore) + } +} + +impl fmt::Display for Level { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Level::Ignore => f.write_str("ignore"), + Level::Warn => f.write_str("warn"), + Level::Error => f.write_str("error"), + } + } +} + +impl TryFrom<Level> for Severity { + type Error = (); + + fn try_from(level: Level) -> Result<Self, ()> { + match level { + Level::Ignore => Err(()), + Level::Warn => Ok(Severity::Warning), + Level::Error => Ok(Severity::Error), + } + } +} + +impl LintMetadata { + pub fn name(&self) -> LintName { + self.name + } + + pub fn summary(&self) -> &str { + self.summary + } + + /// Returns the documentation line by line with one leading space and all trailing whitespace removed. + pub fn documentation_lines(&self) -> impl Iterator<Item = &str> { + self.raw_documentation.lines().map(|line| { + line.strip_prefix(char::is_whitespace) + .unwrap_or(line) + .trim_end() + }) + } + + /// Returns the documentation as a single string. + pub fn documentation(&self) -> String { + self.documentation_lines().join("\n") + } + + pub fn default_level(&self) -> Level { + self.default_level + } + + pub fn status(&self) -> &LintStatus { + &self.status + } + + pub fn file(&self) -> &str { + self.file + } + + pub fn line(&self) -> u32 { + self.line + } +} + +#[doc(hidden)] +pub const fn lint_metadata_defaults() -> LintMetadata { + LintMetadata { + name: LintName::of(""), + summary: "", + raw_documentation: "", + default_level: Level::Error, + status: LintStatus::preview("0.0.0"), + file: "", + line: 1, + } +} + +#[derive(Copy, Clone, Debug)] +pub enum LintStatus { + /// The lint has been added to the linter, but is not yet stable. + Preview { + /// The version in which the lint was added. + since: &'static str, + }, + + /// The lint is stable. + Stable { + /// The version in which the lint was stabilized. + since: &'static str, + }, + + /// The lint is deprecated and no longer recommended for use. + Deprecated { + /// The version in which the lint was deprecated. + since: &'static str, + + /// The reason why the lint has been deprecated. + /// + /// This should explain why the lint has been deprecated and if there's a replacement lint that users + /// can use instead. + reason: &'static str, + }, + + /// The lint has been removed and can no longer be used. + Removed { + /// The version in which the lint was removed. + since: &'static str, + + /// The reason why the lint has been removed. + reason: &'static str, + }, +} + +impl LintStatus { + pub const fn preview(since: &'static str) -> Self { + LintStatus::Preview { since } + } + + pub const fn stable(since: &'static str) -> Self { + LintStatus::Stable { since } + } + + pub const fn deprecated(since: &'static str, reason: &'static str) -> Self { + LintStatus::Deprecated { since, reason } + } + + pub const fn removed(since: &'static str, reason: &'static str) -> Self { + LintStatus::Removed { since, reason } + } + + pub const fn is_removed(&self) -> bool { + matches!(self, LintStatus::Removed { .. }) + } + + pub const fn is_deprecated(&self) -> bool { + matches!(self, LintStatus::Deprecated { .. }) + } +} + +/// Declares a lint rule with the given metadata. +/// +/// ```rust +/// use ty_python_semantic::declare_lint; +/// use ty_python_semantic::lint::{LintStatus, Level}; +/// +/// declare_lint! { +/// /// ## What it does +/// /// Checks for references to names that are not defined. +/// /// +/// /// ## Why is this bad? +/// /// Using an undefined variable will raise a `NameError` at runtime. +/// /// +/// /// ## Example +/// /// +/// /// ```python +/// /// print(x) # NameError: name 'x' is not defined +/// /// ``` +/// pub(crate) static UNRESOLVED_REFERENCE = { +/// summary: "detects references to names that are not defined", +/// status: LintStatus::preview("1.0.0"), +/// default_level: Level::Warn, +/// } +/// } +/// ``` +#[macro_export] +macro_rules! declare_lint { + ( + $(#[doc = $doc:literal])+ + $vis: vis static $name: ident = { + summary: $summary: literal, + status: $status: expr, + // Optional properties + $( $key:ident: $value:expr, )* + } + ) => { + $( #[doc = $doc] )+ + #[expect(clippy::needless_update)] + $vis static $name: $crate::lint::LintMetadata = $crate::lint::LintMetadata { + name: ruff_db::diagnostic::LintName::of(ruff_macros::kebab_case!($name)), + summary: $summary, + raw_documentation: concat!($($doc, '\n',)+), + status: $status, + file: file!(), + line: line!(), + $( $key: $value, )* + ..$crate::lint::lint_metadata_defaults() + }; + }; +} + +/// A unique identifier for a lint rule. +/// +/// Implements `PartialEq`, `Eq`, and `Hash` based on the `LintMetadata` pointer +/// for fast comparison and lookup. +#[derive(Debug, Clone, Copy)] +pub struct LintId { + definition: &'static LintMetadata, +} + +impl LintId { + pub const fn of(definition: &'static LintMetadata) -> Self { + LintId { definition } + } +} + +impl PartialEq for LintId { + fn eq(&self, other: &Self) -> bool { + std::ptr::eq(self.definition, other.definition) + } +} + +impl Eq for LintId {} + +impl std::hash::Hash for LintId { + fn hash<H: Hasher>(&self, state: &mut H) { + std::ptr::hash(self.definition, state); + } +} + +impl std::ops::Deref for LintId { + type Target = LintMetadata; + + fn deref(&self) -> &Self::Target { + self.definition + } +} + +#[derive(Default, Debug)] +pub struct LintRegistryBuilder { + /// Registered lints that haven't been removed. + lints: Vec<LintId>, + + /// Lints indexed by name, including aliases and removed rules. + by_name: FxHashMap<&'static str, LintEntry>, +} + +impl LintRegistryBuilder { + #[track_caller] + pub fn register_lint(&mut self, lint: &'static LintMetadata) { + assert_eq!( + self.by_name.insert(&*lint.name, lint.into()), + None, + "duplicate lint registration for '{name}'", + name = lint.name + ); + + if !lint.status.is_removed() { + self.lints.push(LintId::of(lint)); + } + } + + #[track_caller] + pub fn register_alias(&mut self, from: LintName, to: &'static LintMetadata) { + let target = match self.by_name.get(to.name.as_str()) { + Some(LintEntry::Lint(target) | LintEntry::Removed(target)) => target, + Some(LintEntry::Alias(target)) => { + panic!( + "lint alias {from} -> {to:?} points to another alias {target:?}", + target = target.name() + ) + } + None => panic!( + "lint alias {from} -> {to} points to non-registered lint", + to = to.name + ), + }; + + assert_eq!( + self.by_name + .insert(from.as_str(), LintEntry::Alias(*target)), + None, + "duplicate lint registration for '{from}'", + ); + } + + pub fn build(self) -> LintRegistry { + LintRegistry { + lints: self.lints, + by_name: self.by_name, + } + } +} + +#[derive(Default, Debug, Clone)] +pub struct LintRegistry { + lints: Vec<LintId>, + by_name: FxHashMap<&'static str, LintEntry>, +} + +impl LintRegistry { + /// Looks up a lint by its name. + pub fn get(&self, code: &str) -> Result<LintId, GetLintError> { + match self.by_name.get(code) { + Some(LintEntry::Lint(metadata)) => Ok(*metadata), + Some(LintEntry::Alias(lint)) => { + if lint.status.is_removed() { + Err(GetLintError::Removed(lint.name())) + } else { + Ok(*lint) + } + } + Some(LintEntry::Removed(lint)) => Err(GetLintError::Removed(lint.name())), + None => { + if let Some(without_prefix) = DiagnosticId::strip_category(code) { + if let Some(entry) = self.by_name.get(without_prefix) { + return Err(GetLintError::PrefixedWithCategory { + prefixed: code.to_string(), + suggestion: entry.id().name.to_string(), + }); + } + } + + Err(GetLintError::Unknown(code.to_string())) + } + } + } + + /// Returns all registered, non-removed lints. + pub fn lints(&self) -> &[LintId] { + &self.lints + } + + /// Returns an iterator over all known aliases and to their target lints. + /// + /// This iterator includes aliases that point to removed lints. + pub fn aliases(&self) -> impl Iterator<Item = (LintName, LintId)> + '_ { + self.by_name.iter().filter_map(|(key, value)| { + if let LintEntry::Alias(alias) = value { + Some((LintName::of(key), *alias)) + } else { + None + } + }) + } + + /// Iterates over all removed lints. + pub fn removed(&self) -> impl Iterator<Item = LintId> + '_ { + self.by_name.iter().filter_map(|(_, value)| { + if let LintEntry::Removed(metadata) = value { + Some(*metadata) + } else { + None + } + }) + } +} + +#[derive(Error, Debug, Clone, PartialEq, Eq)] +pub enum GetLintError { + /// The name maps to this removed lint. + #[error("lint `{0}` has been removed")] + Removed(LintName), + + /// No lint with the given name is known. + #[error("unknown lint `{0}`")] + Unknown(String), + + /// The name uses the full qualified diagnostic id `lint:<rule>` instead of just `rule`. + /// The String is the name without the `lint:` category prefix. + #[error("unknown lint `{prefixed}`. Did you mean `{suggestion}`?")] + PrefixedWithCategory { + prefixed: String, + suggestion: String, + }, +} + +#[derive(Debug, PartialEq, Eq, Clone, Copy)] +pub enum LintEntry { + /// An existing lint rule. Can be in preview, stable or deprecated. + Lint(LintId), + /// A lint rule that has been removed. + Removed(LintId), + Alias(LintId), +} + +impl LintEntry { + fn id(self) -> LintId { + match self { + LintEntry::Lint(id) => id, + LintEntry::Removed(id) => id, + LintEntry::Alias(id) => id, + } + } +} + +impl From<&'static LintMetadata> for LintEntry { + fn from(metadata: &'static LintMetadata) -> Self { + if metadata.status.is_removed() { + LintEntry::Removed(LintId::of(metadata)) + } else { + LintEntry::Lint(LintId::of(metadata)) + } + } +} + +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub struct RuleSelection { + /// Map with the severity for each enabled lint rule. + /// + /// If a rule isn't present in this map, then it should be considered disabled. + lints: FxHashMap<LintId, (Severity, LintSource)>, +} + +impl RuleSelection { + /// Creates a new rule selection from all known lints in the registry that are enabled + /// according to their default severity. + pub fn from_registry(registry: &LintRegistry) -> Self { + Self::from_registry_with_default(registry, None) + } + + /// Creates a new rule selection from all known lints in the registry, including lints that are default by default. + /// Lints that are disabled by default use the `default_severity`. + pub fn all(registry: &LintRegistry, default_severity: Severity) -> Self { + Self::from_registry_with_default(registry, Some(default_severity)) + } + + fn from_registry_with_default( + registry: &LintRegistry, + default_severity: Option<Severity>, + ) -> Self { + let lints = registry + .lints() + .iter() + .filter_map(|lint| { + Severity::try_from(lint.default_level()) + .ok() + .or(default_severity) + .map(|severity| (*lint, (severity, LintSource::Default))) + }) + .collect(); + + RuleSelection { lints } + } + + /// Returns an iterator over all enabled lints. + pub fn enabled(&self) -> impl Iterator<Item = LintId> + '_ { + self.lints.keys().copied() + } + + /// Returns an iterator over all enabled lints and their severity. + pub fn iter(&self) -> impl ExactSizeIterator<Item = (LintId, Severity)> + '_ { + self.lints + .iter() + .map(|(&lint, &(severity, _))| (lint, severity)) + } + + /// Returns the configured severity for the lint with the given id or `None` if the lint is disabled. + pub fn severity(&self, lint: LintId) -> Option<Severity> { + self.lints.get(&lint).map(|(severity, _)| *severity) + } + + pub fn get(&self, lint: LintId) -> Option<(Severity, LintSource)> { + self.lints.get(&lint).copied() + } + + /// Returns `true` if the `lint` is enabled. + pub fn is_enabled(&self, lint: LintId) -> bool { + self.severity(lint).is_some() + } + + /// Enables `lint` and configures with the given `severity`. + /// + /// Overrides any previous configuration for the lint. + pub fn enable(&mut self, lint: LintId, severity: Severity, source: LintSource) { + self.lints.insert(lint, (severity, source)); + } + + /// Disables `lint` if it was previously enabled. + pub fn disable(&mut self, lint: LintId) { + self.lints.remove(&lint); + } +} + +#[derive(Default, Copy, Clone, Debug, PartialEq, Eq)] +pub enum LintSource { + /// The user didn't enable the rule explicitly, instead it's enabled by default. + #[default] + Default, + + /// The rule was enabled by using a CLI argument + Cli, + + /// The rule was enabled in a configuration file. + File, +} diff --git a/crates/ty_python_semantic/src/list.rs b/crates/ty_python_semantic/src/list.rs new file mode 100644 index 0000000000000..38061787d0ba5 --- /dev/null +++ b/crates/ty_python_semantic/src/list.rs @@ -0,0 +1,745 @@ +//! Sorted, arena-allocated association lists +//! +//! An [_association list_][alist], which is a linked list of key/value pairs. We additionally +//! guarantee that the elements of an association list are sorted (by their keys), and that they do +//! not contain any entries with duplicate keys. +//! +//! Association lists have fallen out of favor in recent decades, since you often need operations +//! that are inefficient on them. In particular, looking up a random element by index is O(n), just +//! like a linked list; and looking up an element by key is also O(n), since you must do a linear +//! scan of the list to find the matching element. The typical implementation also suffers from +//! poor cache locality and high memory allocation overhead, since individual list cells are +//! typically allocated separately from the heap. We solve that last problem by storing the cells +//! of an association list in an [`IndexVec`] arena. +//! +//! We exploit structural sharing where possible, reusing cells across multiple lists when we can. +//! That said, we don't guarantee that lists are canonical — it's entirely possible for two lists +//! with identical contents to use different list cells and have different identifiers. +//! +//! Given all of this, association lists have the following benefits: +//! +//! - Lists can be represented by a single 32-bit integer (the index into the arena of the head of +//! the list). +//! - Lists can be cloned in constant time, since the underlying cells are immutable. +//! - Lists can be combined quickly (for both intersection and union), especially when you already +//! have to zip through both input lists to combine each key's values in some way. +//! +//! There is one remaining caveat: +//! +//! - You should construct lists in key order; doing this lets you insert each value in constant time. +//! Inserting entries in reverse order results in _quadratic_ overall time to construct the list. +//! +//! Lists are created using a [`ListBuilder`], and once created are accessed via a [`ListStorage`]. +//! +//! ## Tests +//! +//! This module contains quickcheck-based property tests. +//! +//! These tests are disabled by default, as they are non-deterministic and slow. You can run them +//! explicitly using: +//! +//! ```sh +//! cargo test -p ruff_index -- --ignored list::property_tests +//! ``` +//! +//! The number of tests (default: 100) can be controlled by setting the `QUICKCHECK_TESTS` +//! environment variable. For example: +//! +//! ```sh +//! QUICKCHECK_TESTS=10000 cargo test … +//! ``` +//! +//! If you want to run these tests for a longer period of time, it's advisable to run them in +//! release mode. As some tests are slower than others, it's advisable to run them in a loop until +//! they fail: +//! +//! ```sh +//! export QUICKCHECK_TESTS=100000 +//! while cargo test --release -p ruff_index -- \ +//! --ignored list::property_tests; do :; done +//! ``` +//! +//! [alist]: https://en.wikipedia.org/wiki/Association_list + +use std::cmp::Ordering; +use std::marker::PhantomData; +use std::ops::Deref; + +use ruff_index::{IndexVec, newtype_index}; + +/// A handle to an association list. Use [`ListStorage`] to access its elements, and +/// [`ListBuilder`] to construct other lists based on this one. +#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)] +pub(crate) struct List<K, V = ()> { + last: Option<ListCellId>, + _phantom: PhantomData<(K, V)>, +} + +impl<K, V> List<K, V> { + pub(crate) const fn empty() -> List<K, V> { + List::new(None) + } + + const fn new(last: Option<ListCellId>) -> List<K, V> { + List { + last, + _phantom: PhantomData, + } + } +} + +impl<K, V> Default for List<K, V> { + fn default() -> Self { + List::empty() + } +} + +#[newtype_index] +#[derive(PartialOrd, Ord)] +struct ListCellId; + +/// Stores one or more association lists. This type provides read-only access to the lists. Use a +/// [`ListBuilder`] to create lists. +#[derive(Debug, Eq, PartialEq)] +pub(crate) struct ListStorage<K, V = ()> { + cells: IndexVec<ListCellId, ListCell<K, V>>, +} + +/// Each association list is represented by a sequence of snoc cells. A snoc cell is like the more +/// familiar cons cell `(a : (b : (c : nil)))`, but in reverse `(((nil : a) : b) : c)`. +/// +/// **Terminology**: The elements of a cons cell are usually called `head` and `tail` (assuming +/// you're not in Lisp-land, where they're called `car` and `cdr`). The elements of a snoc cell +/// are usually called `rest` and `last`. +#[derive(Debug, Eq, PartialEq)] +struct ListCell<K, V> { + rest: Option<ListCellId>, + key: K, + value: V, +} + +/// Constructs one or more association lists. +#[derive(Debug, Eq, PartialEq)] +pub(crate) struct ListBuilder<K, V = ()> { + storage: ListStorage<K, V>, + + /// Scratch space that lets us implement our list operations iteratively instead of + /// recursively. + /// + /// The snoc-list representation that we use for alists is very common in functional + /// programming, and the simplest implementations of most of the operations are defined + /// recursively on that data structure. However, they are not _tail_ recursive, which means + /// that the call stack grows linearly with the size of the input, which can be a problem for + /// large lists. + /// + /// You can often rework those recursive implementations into iterative ones using an + /// _accumulator_, but that comes at the cost of reversing the list. If we didn't care about + /// ordering, that wouldn't be a problem. Since we want our lists to be sorted, we can't rely + /// on that on its own. + /// + /// The next standard trick is to use an accumulator, and use a fix-up step at the end to + /// reverse the (reversed) result in the accumulator, restoring the correct order. + /// + /// So, that's what we do! However, as one last optimization, we don't build up alist cells in + /// our accumulator, since that would add wasteful cruft to our list storage. Instead, we use a + /// normal Vec as our accumulator, holding the key/value pairs that should be stitched onto the + /// end of whatever result list we are creating. For our fix-up step, we can consume a Vec in + /// reverse order by `pop`ping the elements off one by one. + scratch: Vec<(K, V)>, +} + +impl<K, V> Default for ListBuilder<K, V> { + fn default() -> Self { + ListBuilder { + storage: ListStorage { + cells: IndexVec::default(), + }, + scratch: Vec::default(), + } + } +} + +impl<K, V> Deref for ListBuilder<K, V> { + type Target = ListStorage<K, V>; + fn deref(&self) -> &ListStorage<K, V> { + &self.storage + } +} + +impl<K, V> ListBuilder<K, V> { + /// Finalizes a `ListBuilder`. After calling this, you cannot create any new lists managed by + /// this storage. + pub(crate) fn build(mut self) -> ListStorage<K, V> { + self.storage.cells.shrink_to_fit(); + self.storage + } + + /// Adds a new cell to the list. + /// + /// Adding an element always returns a non-empty list, which means we could technically use `I` + /// as our return type, since we never return `None`. However, for consistency with our other + /// methods, we always use `Option<I>` as the return type for any method that can return a + /// list. + #[expect(clippy::unnecessary_wraps)] + fn add_cell(&mut self, rest: Option<ListCellId>, key: K, value: V) -> Option<ListCellId> { + Some(self.storage.cells.push(ListCell { rest, key, value })) + } + + /// Returns an entry pointing at where `key` would be inserted into a list. + /// + /// Note that when we add a new element to a list, we might have to clone the keys and values + /// of some existing elements. This is because list cells are immutable once created, since + /// they might be shared across multiple lists. We must therefore create new cells for every + /// element that appears after the new element. + /// + /// That means that you should construct lists in key order, since that means that there are no + /// entries to duplicate for each insertion. If you construct the list in reverse order, we + /// will have to duplicate O(n) entries for each insertion, making it _quadratic_ to construct + /// the entire list. + pub(crate) fn entry(&mut self, list: List<K, V>, key: K) -> ListEntry<K, V> + where + K: Clone + Ord, + V: Clone, + { + self.scratch.clear(); + + // Iterate through the input list, looking for the position where the key should be + // inserted. We will need to create new list cells for any elements that appear after the + // new key. Stash those away in our scratch accumulator as we step through the input. The + // result of the loop is that "rest" of the result list, which we will stitch the new key + // (and any succeeding keys) onto. + let mut curr = list.last; + while let Some(curr_id) = curr { + let cell = &self.storage.cells[curr_id]; + match key.cmp(&cell.key) { + // We found an existing entry in the input list with the desired key. + Ordering::Equal => { + return ListEntry { + builder: self, + list, + key, + rest: ListTail::Occupied(curr_id), + }; + } + // The input list does not already contain this key, and this is where we should + // add it. + Ordering::Greater => { + return ListEntry { + builder: self, + list, + key, + rest: ListTail::Vacant(curr_id), + }; + } + // If this key is in the list, it's further along. We'll need to create a new cell + // for this entry in the result list, so add its contents to the scratch + // accumulator. + Ordering::Less => { + let new_key = cell.key.clone(); + let new_value = cell.value.clone(); + self.scratch.push((new_key, new_value)); + curr = cell.rest; + } + } + } + + // We made it all the way through the list without finding the desired key, so it belongs + // at the beginning. (And we will unfortunately have to duplicate every existing cell if + // the caller proceeds with inserting the new key!) + ListEntry { + builder: self, + list, + key, + rest: ListTail::Beginning, + } + } +} + +/// A view into a list, indicating where a key would be inserted. +pub(crate) struct ListEntry<'a, K, V = ()> { + builder: &'a mut ListBuilder<K, V>, + list: List<K, V>, + key: K, + /// Points at the element that already contains `key`, if there is one, or the element + /// immediately before where it would go, if not. + rest: ListTail<ListCellId>, +} + +enum ListTail<I> { + /// The list does not already contain `key`, and it would go at the beginning of the list. + Beginning, + /// The list already contains `key` + Occupied(I), + /// The list does not already contain key, and it would go immediately after the given element + Vacant(I), +} + +impl<K, V> ListEntry<'_, K, V> +where + K: Clone, + V: Clone, +{ + fn stitch_up(self, rest: Option<ListCellId>, value: V) -> List<K, V> { + let mut last = rest; + last = self.builder.add_cell(last, self.key, value); + while let Some((key, value)) = self.builder.scratch.pop() { + last = self.builder.add_cell(last, key, value); + } + List::new(last) + } + + /// Inserts a new key/value into the list if the key is not already present. If the list + /// already contains `key`, we return the original list as-is, and do not invoke your closure. + pub(crate) fn or_insert_with<F>(self, f: F) -> List<K, V> + where + F: FnOnce() -> V, + { + let rest = match self.rest { + // If the list already contains `key`, we don't need to replace anything, and can + // return the original list unmodified. + ListTail::Occupied(_) => return self.list, + // Otherwise we have to create a new entry and stitch it onto the list. + ListTail::Beginning => None, + ListTail::Vacant(index) => Some(index), + }; + self.stitch_up(rest, f()) + } + + /// Inserts a new key and the default value into the list if the key is not already present. If + /// the list already contains `key`, we return the original list as-is. + pub(crate) fn or_insert_default(self) -> List<K, V> + where + V: Default, + { + self.or_insert_with(V::default) + } +} + +impl<K, V> ListBuilder<K, V> { + /// Returns the intersection of two lists. The result will contain an entry for any key that + /// appears in both lists. The corresponding values will be combined using the `combine` + /// function that you provide. + #[expect(clippy::needless_pass_by_value)] + pub(crate) fn intersect_with<F>( + &mut self, + a: List<K, V>, + b: List<K, V>, + mut combine: F, + ) -> List<K, V> + where + K: Clone + Ord, + V: Clone, + F: FnMut(&V, &V) -> V, + { + self.scratch.clear(); + + // Zip through the lists, building up the keys/values of the new entries into our scratch + // vector. Continue until we run out of elements in either list. (Any remaining elements in + // the other list cannot possibly be in the intersection.) + let mut a = a.last; + let mut b = b.last; + while let (Some(a_id), Some(b_id)) = (a, b) { + let a_cell = &self.storage.cells[a_id]; + let b_cell = &self.storage.cells[b_id]; + match a_cell.key.cmp(&b_cell.key) { + // Both lists contain this key; combine their values + Ordering::Equal => { + let new_key = a_cell.key.clone(); + let new_value = combine(&a_cell.value, &b_cell.value); + self.scratch.push((new_key, new_value)); + a = a_cell.rest; + b = b_cell.rest; + } + // a's key is only present in a, so it's not included in the result. + Ordering::Greater => a = a_cell.rest, + // b's key is only present in b, so it's not included in the result. + Ordering::Less => b = b_cell.rest, + } + } + + // Once the iteration loop terminates, we stitch the new entries back together into proper + // alist cells. + let mut last = None; + while let Some((key, value)) = self.scratch.pop() { + last = self.add_cell(last, key, value); + } + List::new(last) + } +} + +// ---- +// Sets + +impl<K> ListStorage<K, ()> { + /// Iterates through the elements in a set _in reverse order_. + #[expect(clippy::needless_pass_by_value)] + pub(crate) fn iter_set_reverse(&self, set: List<K, ()>) -> ListSetReverseIterator<K> { + ListSetReverseIterator { + storage: self, + curr: set.last, + } + } +} + +pub(crate) struct ListSetReverseIterator<'a, K> { + storage: &'a ListStorage<K, ()>, + curr: Option<ListCellId>, +} + +impl<'a, K> Iterator for ListSetReverseIterator<'a, K> { + type Item = &'a K; + + fn next(&mut self) -> Option<Self::Item> { + let cell = &self.storage.cells[self.curr?]; + self.curr = cell.rest; + Some(&cell.key) + } +} + +impl<K> ListBuilder<K, ()> { + /// Adds an element to a set. + pub(crate) fn insert(&mut self, set: List<K, ()>, element: K) -> List<K, ()> + where + K: Clone + Ord, + { + self.entry(set, element).or_insert_default() + } + + /// Returns the intersection of two sets. The result will contain any value that appears in + /// both sets. + pub(crate) fn intersect(&mut self, a: List<K, ()>, b: List<K, ()>) -> List<K, ()> + where + K: Clone + Ord, + { + self.intersect_with(a, b, |(), ()| ()) + } +} + +// ----- +// Tests + +#[cfg(test)] +mod tests { + use super::*; + + use std::fmt::Display; + use std::fmt::Write; + + // ---- + // Sets + + impl<K> ListStorage<K> + where + K: Display, + { + fn display_set(&self, list: List<K, ()>) -> String { + let elements: Vec<_> = self.iter_set_reverse(list).collect(); + let mut result = String::new(); + result.push('['); + for element in elements.into_iter().rev() { + if result.len() > 1 { + result.push_str(", "); + } + write!(&mut result, "{element}").unwrap(); + } + result.push(']'); + result + } + } + + #[test] + fn can_insert_into_set() { + let mut builder = ListBuilder::<u16>::default(); + + // Build up the set in order + let empty = List::empty(); + let set1 = builder.insert(empty, 1); + let set12 = builder.insert(set1, 2); + let set123 = builder.insert(set12, 3); + let set1232 = builder.insert(set123, 2); + assert_eq!(builder.display_set(empty), "[]"); + assert_eq!(builder.display_set(set1), "[1]"); + assert_eq!(builder.display_set(set12), "[1, 2]"); + assert_eq!(builder.display_set(set123), "[1, 2, 3]"); + assert_eq!(builder.display_set(set1232), "[1, 2, 3]"); + + // And in reverse order + let set3 = builder.insert(empty, 3); + let set32 = builder.insert(set3, 2); + let set321 = builder.insert(set32, 1); + let set3212 = builder.insert(set321, 2); + assert_eq!(builder.display_set(empty), "[]"); + assert_eq!(builder.display_set(set3), "[3]"); + assert_eq!(builder.display_set(set32), "[2, 3]"); + assert_eq!(builder.display_set(set321), "[1, 2, 3]"); + assert_eq!(builder.display_set(set3212), "[1, 2, 3]"); + } + + #[test] + fn can_intersect_sets() { + let mut builder = ListBuilder::<u16>::default(); + + let empty = List::empty(); + let set1 = builder.insert(empty, 1); + let set12 = builder.insert(set1, 2); + let set123 = builder.insert(set12, 3); + let set1234 = builder.insert(set123, 4); + + let set2 = builder.insert(empty, 2); + let set24 = builder.insert(set2, 4); + let set245 = builder.insert(set24, 5); + let set2457 = builder.insert(set245, 7); + + let intersection = builder.intersect(empty, empty); + assert_eq!(builder.display_set(intersection), "[]"); + let intersection = builder.intersect(empty, set1234); + assert_eq!(builder.display_set(intersection), "[]"); + let intersection = builder.intersect(empty, set2457); + assert_eq!(builder.display_set(intersection), "[]"); + let intersection = builder.intersect(set1, set1234); + assert_eq!(builder.display_set(intersection), "[1]"); + let intersection = builder.intersect(set1, set2457); + assert_eq!(builder.display_set(intersection), "[]"); + let intersection = builder.intersect(set2, set1234); + assert_eq!(builder.display_set(intersection), "[2]"); + let intersection = builder.intersect(set2, set2457); + assert_eq!(builder.display_set(intersection), "[2]"); + let intersection = builder.intersect(set1234, set2457); + assert_eq!(builder.display_set(intersection), "[2, 4]"); + } + + // ---- + // Maps + + impl<K, V> ListStorage<K, V> { + /// Iterates through the entries in a list _in reverse order by key_. + #[expect(clippy::needless_pass_by_value)] + pub(crate) fn iter_reverse(&self, list: List<K, V>) -> ListReverseIterator<'_, K, V> { + ListReverseIterator { + storage: self, + curr: list.last, + } + } + } + + pub(crate) struct ListReverseIterator<'a, K, V> { + storage: &'a ListStorage<K, V>, + curr: Option<ListCellId>, + } + + impl<'a, K, V> Iterator for ListReverseIterator<'a, K, V> { + type Item = (&'a K, &'a V); + + fn next(&mut self) -> Option<Self::Item> { + let cell = &self.storage.cells[self.curr?]; + self.curr = cell.rest; + Some((&cell.key, &cell.value)) + } + } + + impl<K, V> ListStorage<K, V> + where + K: Display, + V: Display, + { + fn display(&self, list: List<K, V>) -> String { + let entries: Vec<_> = self.iter_reverse(list).collect(); + let mut result = String::new(); + result.push('['); + for (key, value) in entries.into_iter().rev() { + if result.len() > 1 { + result.push_str(", "); + } + write!(&mut result, "{key}:{value}").unwrap(); + } + result.push(']'); + result + } + } + + #[test] + fn can_insert_into_map() { + let mut builder = ListBuilder::<u16, u16>::default(); + + // Build up the map in order + let empty = List::empty(); + let map1 = builder.entry(empty, 1).or_insert_with(|| 1); + let map12 = builder.entry(map1, 2).or_insert_with(|| 2); + let map123 = builder.entry(map12, 3).or_insert_with(|| 3); + let map1232 = builder.entry(map123, 2).or_insert_with(|| 4); + assert_eq!(builder.display(empty), "[]"); + assert_eq!(builder.display(map1), "[1:1]"); + assert_eq!(builder.display(map12), "[1:1, 2:2]"); + assert_eq!(builder.display(map123), "[1:1, 2:2, 3:3]"); + assert_eq!(builder.display(map1232), "[1:1, 2:2, 3:3]"); + + // And in reverse order + let map3 = builder.entry(empty, 3).or_insert_with(|| 3); + let map32 = builder.entry(map3, 2).or_insert_with(|| 2); + let map321 = builder.entry(map32, 1).or_insert_with(|| 1); + let map3212 = builder.entry(map321, 2).or_insert_with(|| 4); + assert_eq!(builder.display(empty), "[]"); + assert_eq!(builder.display(map3), "[3:3]"); + assert_eq!(builder.display(map32), "[2:2, 3:3]"); + assert_eq!(builder.display(map321), "[1:1, 2:2, 3:3]"); + assert_eq!(builder.display(map3212), "[1:1, 2:2, 3:3]"); + } + + #[test] + fn can_intersect_maps() { + let mut builder = ListBuilder::<u16, u16>::default(); + + let empty = List::empty(); + let map1 = builder.entry(empty, 1).or_insert_with(|| 1); + let map12 = builder.entry(map1, 2).or_insert_with(|| 2); + let map123 = builder.entry(map12, 3).or_insert_with(|| 3); + let map1234 = builder.entry(map123, 4).or_insert_with(|| 4); + + let map2 = builder.entry(empty, 2).or_insert_with(|| 20); + let map24 = builder.entry(map2, 4).or_insert_with(|| 40); + let map245 = builder.entry(map24, 5).or_insert_with(|| 50); + let map2457 = builder.entry(map245, 7).or_insert_with(|| 70); + + let intersection = builder.intersect_with(empty, empty, |a, b| a + b); + assert_eq!(builder.display(intersection), "[]"); + let intersection = builder.intersect_with(empty, map1234, |a, b| a + b); + assert_eq!(builder.display(intersection), "[]"); + let intersection = builder.intersect_with(empty, map2457, |a, b| a + b); + assert_eq!(builder.display(intersection), "[]"); + let intersection = builder.intersect_with(map1, map1234, |a, b| a + b); + assert_eq!(builder.display(intersection), "[1:2]"); + let intersection = builder.intersect_with(map1, map2457, |a, b| a + b); + assert_eq!(builder.display(intersection), "[]"); + let intersection = builder.intersect_with(map2, map1234, |a, b| a + b); + assert_eq!(builder.display(intersection), "[2:22]"); + let intersection = builder.intersect_with(map2, map2457, |a, b| a + b); + assert_eq!(builder.display(intersection), "[2:40]"); + let intersection = builder.intersect_with(map1234, map2457, |a, b| a + b); + assert_eq!(builder.display(intersection), "[2:22, 4:44]"); + } +} + +// -------------- +// Property tests + +#[cfg(test)] +mod property_tests { + use super::*; + + use std::collections::{BTreeMap, BTreeSet}; + + impl<K> ListBuilder<K> + where + K: Clone + Ord, + { + fn set_from_elements<'a>(&mut self, elements: impl IntoIterator<Item = &'a K>) -> List<K> + where + K: 'a, + { + let mut set = List::empty(); + for element in elements { + set = self.insert(set, element.clone()); + } + set + } + } + + // For most of the tests below, we use a vec as our input, instead of a HashSet or BTreeSet, + // since we want to test the behavior of adding duplicate elements to the set. + + #[quickcheck_macros::quickcheck] + #[ignore] + #[expect(clippy::needless_pass_by_value)] + fn roundtrip_set_from_vec(elements: Vec<u16>) -> bool { + let mut builder = ListBuilder::default(); + let set = builder.set_from_elements(&elements); + let expected: BTreeSet<_> = elements.iter().copied().collect(); + let actual = builder.iter_set_reverse(set).copied(); + actual.eq(expected.into_iter().rev()) + } + + #[quickcheck_macros::quickcheck] + #[ignore] + #[expect(clippy::needless_pass_by_value)] + fn roundtrip_set_intersection(a_elements: Vec<u16>, b_elements: Vec<u16>) -> bool { + let mut builder = ListBuilder::default(); + let a = builder.set_from_elements(&a_elements); + let b = builder.set_from_elements(&b_elements); + let intersection = builder.intersect(a, b); + let a_set: BTreeSet<_> = a_elements.iter().copied().collect(); + let b_set: BTreeSet<_> = b_elements.iter().copied().collect(); + let expected: Vec<_> = a_set.intersection(&b_set).copied().collect(); + let actual = builder.iter_set_reverse(intersection).copied(); + actual.eq(expected.into_iter().rev()) + } + + impl<K, V> ListBuilder<K, V> + where + K: Clone + Ord, + V: Clone + Eq, + { + fn set_from_pairs<'a, I>(&mut self, pairs: I) -> List<K, V> + where + K: 'a, + V: 'a, + I: IntoIterator<Item = &'a (K, V)>, + I::IntoIter: DoubleEndedIterator, + { + let mut list = List::empty(); + for (key, value) in pairs.into_iter().rev() { + list = self + .entry(list, key.clone()) + .or_insert_with(|| value.clone()); + } + list + } + } + + fn join<K, V>(a: &BTreeMap<K, V>, b: &BTreeMap<K, V>) -> BTreeMap<K, (Option<V>, Option<V>)> + where + K: Clone + Ord, + V: Clone + Ord, + { + let mut joined: BTreeMap<K, (Option<V>, Option<V>)> = BTreeMap::new(); + for (k, v) in a { + joined.entry(k.clone()).or_default().0 = Some(v.clone()); + } + for (k, v) in b { + joined.entry(k.clone()).or_default().1 = Some(v.clone()); + } + joined + } + + #[quickcheck_macros::quickcheck] + #[ignore] + #[expect(clippy::needless_pass_by_value)] + fn roundtrip_list_from_vec(pairs: Vec<(u16, u16)>) -> bool { + let mut builder = ListBuilder::default(); + let list = builder.set_from_pairs(&pairs); + let expected: BTreeMap<_, _> = pairs.iter().copied().collect(); + let actual = builder.iter_reverse(list).map(|(k, v)| (*k, *v)); + actual.eq(expected.into_iter().rev()) + } + + #[quickcheck_macros::quickcheck] + #[ignore] + #[expect(clippy::needless_pass_by_value)] + fn roundtrip_list_intersection( + a_elements: Vec<(u16, u16)>, + b_elements: Vec<(u16, u16)>, + ) -> bool { + let mut builder = ListBuilder::default(); + let a = builder.set_from_pairs(&a_elements); + let b = builder.set_from_pairs(&b_elements); + let intersection = builder.intersect_with(a, b, |a, b| a + b); + let a_map: BTreeMap<_, _> = a_elements.iter().copied().collect(); + let b_map: BTreeMap<_, _> = b_elements.iter().copied().collect(); + let intersection_map = join(&a_map, &b_map); + let expected: Vec<_> = intersection_map + .into_iter() + .filter_map(|(k, (v1, v2))| Some((k, v1? + v2?))) + .collect(); + let actual = builder.iter_reverse(intersection).map(|(k, v)| (*k, *v)); + actual.eq(expected.into_iter().rev()) + } +} diff --git a/crates/ty_python_semantic/src/module_name.rs b/crates/ty_python_semantic/src/module_name.rs new file mode 100644 index 0000000000000..48162fe3d934b --- /dev/null +++ b/crates/ty_python_semantic/src/module_name.rs @@ -0,0 +1,319 @@ +use std::fmt; +use std::num::NonZeroU32; +use std::ops::Deref; + +use compact_str::{CompactString, ToCompactString}; + +use ruff_db::files::File; +use ruff_python_ast as ast; +use ruff_python_stdlib::identifiers::is_identifier; + +use crate::{db::Db, module_resolver::file_to_module}; + +/// A module name, e.g. `foo.bar`. +/// +/// Always normalized to the absolute form (never a relative module name, i.e., never `.foo`). +#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)] +pub struct ModuleName(compact_str::CompactString); + +impl ModuleName { + /// Creates a new module name for `name`. Returns `Some` if `name` is a valid, absolute + /// module name and `None` otherwise. + /// + /// The module name is invalid if: + /// + /// * The name is empty + /// * The name is relative + /// * The name ends with a `.` + /// * The name contains a sequence of multiple dots + /// * A component of a name (the part between two dots) isn't a valid python identifier. + #[inline] + #[must_use] + pub fn new(name: &str) -> Option<Self> { + Self::is_valid_name(name).then(|| Self(CompactString::from(name))) + } + + /// Creates a new module name for `name` where `name` is a static string. + /// Returns `Some` if `name` is a valid, absolute module name and `None` otherwise. + /// + /// The module name is invalid if: + /// + /// * The name is empty + /// * The name is relative + /// * The name ends with a `.` + /// * The name contains a sequence of multiple dots + /// * A component of a name (the part between two dots) isn't a valid python identifier. + /// + /// ## Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert_eq!(ModuleName::new_static("foo.bar").as_deref(), Some("foo.bar")); + /// assert_eq!(ModuleName::new_static(""), None); + /// assert_eq!(ModuleName::new_static("..foo"), None); + /// assert_eq!(ModuleName::new_static(".foo"), None); + /// assert_eq!(ModuleName::new_static("foo."), None); + /// assert_eq!(ModuleName::new_static("foo..bar"), None); + /// assert_eq!(ModuleName::new_static("2000"), None); + /// ``` + #[inline] + #[must_use] + pub fn new_static(name: &'static str) -> Option<Self> { + Self::is_valid_name(name).then(|| Self(CompactString::const_new(name))) + } + + #[must_use] + fn is_valid_name(name: &str) -> bool { + !name.is_empty() && name.split('.').all(is_identifier) + } + + /// An iterator over the components of the module name: + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert_eq!(ModuleName::new_static("foo.bar.baz").unwrap().components().collect::<Vec<_>>(), vec!["foo", "bar", "baz"]); + /// ``` + #[must_use] + pub fn components(&self) -> impl DoubleEndedIterator<Item = &str> { + self.0.split('.') + } + + /// The name of this module's immediate parent, if it has a parent. + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert_eq!(ModuleName::new_static("foo.bar").unwrap().parent(), Some(ModuleName::new_static("foo").unwrap())); + /// assert_eq!(ModuleName::new_static("foo.bar.baz").unwrap().parent(), Some(ModuleName::new_static("foo.bar").unwrap())); + /// assert_eq!(ModuleName::new_static("root").unwrap().parent(), None); + /// ``` + #[must_use] + pub fn parent(&self) -> Option<ModuleName> { + let (parent, _) = self.0.rsplit_once('.')?; + Some(Self(parent.to_compact_string())) + } + + /// Returns `true` if the name starts with `other`. + /// + /// This is equivalent to checking if `self` is a sub-module of `other`. + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert!(ModuleName::new_static("foo.bar").unwrap().starts_with(&ModuleName::new_static("foo").unwrap())); + /// + /// assert!(!ModuleName::new_static("foo.bar").unwrap().starts_with(&ModuleName::new_static("bar").unwrap())); + /// assert!(!ModuleName::new_static("foo_bar").unwrap().starts_with(&ModuleName::new_static("foo").unwrap())); + /// ``` + #[must_use] + pub fn starts_with(&self, other: &ModuleName) -> bool { + let mut self_components = self.components(); + let other_components = other.components(); + + for other_component in other_components { + if self_components.next() != Some(other_component) { + return false; + } + } + + true + } + + #[must_use] + #[inline] + pub fn as_str(&self) -> &str { + &self.0 + } + + /// Construct a [`ModuleName`] from a sequence of parts. + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert_eq!(&*ModuleName::from_components(["a"]).unwrap(), "a"); + /// assert_eq!(&*ModuleName::from_components(["a", "b"]).unwrap(), "a.b"); + /// assert_eq!(&*ModuleName::from_components(["a", "b", "c"]).unwrap(), "a.b.c"); + /// + /// assert_eq!(ModuleName::from_components(["a-b"]), None); + /// assert_eq!(ModuleName::from_components(["a", "a-b"]), None); + /// assert_eq!(ModuleName::from_components(["a", "b", "a-b-c"]), None); + /// ``` + #[must_use] + pub fn from_components<'a>(components: impl IntoIterator<Item = &'a str>) -> Option<Self> { + let mut components = components.into_iter(); + let first_part = components.next()?; + if !is_identifier(first_part) { + return None; + } + let name = if let Some(second_part) = components.next() { + if !is_identifier(second_part) { + return None; + } + let mut name = format!("{first_part}.{second_part}"); + for part in components { + if !is_identifier(part) { + return None; + } + name.push('.'); + name.push_str(part); + } + CompactString::from(&name) + } else { + CompactString::from(first_part) + }; + Some(Self(name)) + } + + /// Extend `self` with the components of `other` + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// let mut module_name = ModuleName::new_static("foo").unwrap(); + /// module_name.extend(&ModuleName::new_static("bar").unwrap()); + /// assert_eq!(&module_name, "foo.bar"); + /// module_name.extend(&ModuleName::new_static("baz.eggs.ham").unwrap()); + /// assert_eq!(&module_name, "foo.bar.baz.eggs.ham"); + /// ``` + pub fn extend(&mut self, other: &ModuleName) { + self.0.push('.'); + self.0.push_str(other); + } + + /// Returns an iterator of this module name and all of its parent modules. + /// + /// # Examples + /// + /// ``` + /// use ty_python_semantic::ModuleName; + /// + /// assert_eq!( + /// ModuleName::new_static("foo.bar.baz").unwrap().ancestors().collect::<Vec<_>>(), + /// vec![ + /// ModuleName::new_static("foo.bar.baz").unwrap(), + /// ModuleName::new_static("foo.bar").unwrap(), + /// ModuleName::new_static("foo").unwrap(), + /// ], + /// ); + /// ``` + pub fn ancestors(&self) -> impl Iterator<Item = Self> { + std::iter::successors(Some(self.clone()), Self::parent) + } + + pub(crate) fn from_import_statement<'db>( + db: &'db dyn Db, + importing_file: File, + node: &'db ast::StmtImportFrom, + ) -> Result<Self, ModuleNameResolutionError> { + let ast::StmtImportFrom { + module, + level, + names: _, + range: _, + } = node; + + let module = module.as_deref(); + + if let Some(level) = NonZeroU32::new(*level) { + relative_module_name(db, importing_file, module, level) + } else { + module + .and_then(Self::new) + .ok_or(ModuleNameResolutionError::InvalidSyntax) + } + } +} + +impl Deref for ModuleName { + type Target = str; + + #[inline] + fn deref(&self) -> &Self::Target { + self.as_str() + } +} + +impl PartialEq<str> for ModuleName { + fn eq(&self, other: &str) -> bool { + self.as_str() == other + } +} + +impl PartialEq<ModuleName> for str { + fn eq(&self, other: &ModuleName) -> bool { + self == other.as_str() + } +} + +impl std::fmt::Display for ModuleName { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.0) + } +} + +/// Given a `from .foo import bar` relative import, resolve the relative module +/// we're importing `bar` from into an absolute [`ModuleName`] +/// using the name of the module we're currently analyzing. +/// +/// - `level` is the number of dots at the beginning of the relative module name: +/// - `from .foo.bar import baz` => `level == 1` +/// - `from ...foo.bar import baz` => `level == 3` +/// - `tail` is the relative module name stripped of all leading dots: +/// - `from .foo import bar` => `tail == "foo"` +/// - `from ..foo.bar import baz` => `tail == "foo.bar"` +fn relative_module_name( + db: &dyn Db, + importing_file: File, + tail: Option<&str>, + level: NonZeroU32, +) -> Result<ModuleName, ModuleNameResolutionError> { + let module = file_to_module(db, importing_file) + .ok_or(ModuleNameResolutionError::UnknownCurrentModule)?; + let mut level = level.get(); + + if module.kind().is_package() { + level = level.saturating_sub(1); + } + + let mut module_name = module + .name() + .ancestors() + .nth(level as usize) + .ok_or(ModuleNameResolutionError::TooManyDots)?; + + if let Some(tail) = tail { + let tail = ModuleName::new(tail).ok_or(ModuleNameResolutionError::InvalidSyntax)?; + module_name.extend(&tail); + } + + Ok(module_name) +} + +/// Various ways in which resolving a [`ModuleName`] +/// from an [`ast::StmtImport`] or [`ast::StmtImportFrom`] node might fail +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(crate) enum ModuleNameResolutionError { + /// The import statement has invalid syntax + InvalidSyntax, + + /// We couldn't resolve the file we're currently analyzing back to a module + /// (Only necessary for relative import statements) + UnknownCurrentModule, + + /// The relative import statement seems to take us outside of the module search path + /// (e.g. our current module is `foo.bar`, and the relative import statement in `foo.bar` + /// is `from ....baz import spam`) + TooManyDots, +} diff --git a/crates/ty_python_semantic/src/module_resolver/mod.rs b/crates/ty_python_semantic/src/module_resolver/mod.rs new file mode 100644 index 0000000000000..e0e989945be34 --- /dev/null +++ b/crates/ty_python_semantic/src/module_resolver/mod.rs @@ -0,0 +1,45 @@ +use std::iter::FusedIterator; + +pub use module::{KnownModule, Module}; +pub use resolver::resolve_module; +pub(crate) use resolver::{SearchPaths, file_to_module}; +use ruff_db::system::SystemPath; + +use crate::Db; +use crate::module_resolver::resolver::search_paths; +use resolver::SearchPathIterator; + +mod module; +mod path; +mod resolver; +mod typeshed; + +#[cfg(test)] +mod testing; + +/// Returns an iterator over all search paths pointing to a system path +pub fn system_module_search_paths(db: &dyn Db) -> SystemModuleSearchPathsIter { + SystemModuleSearchPathsIter { + inner: search_paths(db), + } +} + +pub struct SystemModuleSearchPathsIter<'db> { + inner: SearchPathIterator<'db>, +} + +impl<'db> Iterator for SystemModuleSearchPathsIter<'db> { + type Item = &'db SystemPath; + + fn next(&mut self) -> Option<Self::Item> { + loop { + let next = self.inner.next()?; + + if let Some(system_path) = next.as_system_path() { + return Some(system_path); + } + } + } +} + +impl FusedIterator for SystemModuleSearchPathsIter<'_> {} diff --git a/crates/ty_python_semantic/src/module_resolver/module.rs b/crates/ty_python_semantic/src/module_resolver/module.rs new file mode 100644 index 0000000000000..8ffd47762255e --- /dev/null +++ b/crates/ty_python_semantic/src/module_resolver/module.rs @@ -0,0 +1,240 @@ +use std::fmt::Formatter; +use std::str::FromStr; +use std::sync::Arc; + +use ruff_db::files::File; + +use super::path::SearchPath; +use crate::module_name::ModuleName; + +/// Representation of a Python module. +#[derive(Clone, PartialEq, Eq, Hash)] +pub struct Module { + inner: Arc<ModuleInner>, +} + +impl Module { + pub(crate) fn file_module( + name: ModuleName, + kind: ModuleKind, + search_path: SearchPath, + file: File, + ) -> Self { + let known = KnownModule::try_from_search_path_and_name(&search_path, &name); + + Self { + inner: Arc::new(ModuleInner::FileModule { + name, + kind, + search_path, + file, + known, + }), + } + } + + pub(crate) fn namespace_package(name: ModuleName) -> Self { + Self { + inner: Arc::new(ModuleInner::NamespacePackage { name }), + } + } + + /// The absolute name of the module (e.g. `foo.bar`) + pub fn name(&self) -> &ModuleName { + match &*self.inner { + ModuleInner::FileModule { name, .. } => name, + ModuleInner::NamespacePackage { name, .. } => name, + } + } + + /// The file to the source code that defines this module + /// + /// This is `None` for namespace packages. + pub fn file(&self) -> Option<File> { + match &*self.inner { + ModuleInner::FileModule { file, .. } => Some(*file), + ModuleInner::NamespacePackage { .. } => None, + } + } + + /// Is this a module that we special-case somehow? If so, which one? + pub fn known(&self) -> Option<KnownModule> { + match &*self.inner { + ModuleInner::FileModule { known, .. } => *known, + ModuleInner::NamespacePackage { .. } => None, + } + } + + /// Does this module represent the given known module? + pub fn is_known(&self, known_module: KnownModule) -> bool { + self.known() == Some(known_module) + } + + /// The search path from which the module was resolved. + pub(crate) fn search_path(&self) -> Option<&SearchPath> { + match &*self.inner { + ModuleInner::FileModule { search_path, .. } => Some(search_path), + ModuleInner::NamespacePackage { .. } => None, + } + } + + /// Determine whether this module is a single-file module or a package + pub fn kind(&self) -> ModuleKind { + match &*self.inner { + ModuleInner::FileModule { kind, .. } => *kind, + ModuleInner::NamespacePackage { .. } => ModuleKind::Package, + } + } +} + +impl std::fmt::Debug for Module { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("Module") + .field("name", &self.name()) + .field("kind", &self.kind()) + .field("file", &self.file()) + .field("search_path", &self.search_path()) + .field("known", &self.known()) + .finish() + } +} + +#[derive(PartialEq, Eq, Hash)] +enum ModuleInner { + /// A module that resolves to a file (`lib.py` or `package/__init__.py`) + FileModule { + name: ModuleName, + kind: ModuleKind, + search_path: SearchPath, + file: File, + known: Option<KnownModule>, + }, + + /// A namespace package. Namespace packages are special because + /// there are multiple possible paths and they have no corresponding + /// code file. + NamespacePackage { name: ModuleName }, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub enum ModuleKind { + /// A single-file module (e.g. `foo.py` or `foo.pyi`) + Module, + + /// A python package (`foo/__init__.py` or `foo/__init__.pyi`) + Package, +} + +impl ModuleKind { + pub const fn is_package(self) -> bool { + matches!(self, ModuleKind::Package) + } + pub const fn is_module(self) -> bool { + matches!(self, ModuleKind::Module) + } +} + +/// Enumeration of various core stdlib modules in which important types are located +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, strum_macros::EnumString)] +#[cfg_attr(test, derive(strum_macros::EnumIter))] +#[strum(serialize_all = "snake_case")] +pub enum KnownModule { + Builtins, + Enum, + Types, + #[strum(serialize = "_typeshed")] + Typeshed, + TypingExtensions, + Typing, + Sys, + Abc, + Dataclasses, + Collections, + Inspect, + #[strum(serialize = "_typeshed._type_checker_internals")] + TypeCheckerInternals, + TyExtensions, +} + +impl KnownModule { + pub const fn as_str(self) -> &'static str { + match self { + Self::Builtins => "builtins", + Self::Enum => "enum", + Self::Types => "types", + Self::Typing => "typing", + Self::Typeshed => "_typeshed", + Self::TypingExtensions => "typing_extensions", + Self::Sys => "sys", + Self::Abc => "abc", + Self::Dataclasses => "dataclasses", + Self::Collections => "collections", + Self::Inspect => "inspect", + Self::TypeCheckerInternals => "_typeshed._type_checker_internals", + Self::TyExtensions => "ty_extensions", + } + } + + pub fn name(self) -> ModuleName { + ModuleName::new_static(self.as_str()) + .unwrap_or_else(|| panic!("{self} should be a valid module name!")) + } + + pub(crate) fn try_from_search_path_and_name( + search_path: &SearchPath, + name: &ModuleName, + ) -> Option<Self> { + if search_path.is_standard_library() { + Self::from_str(name.as_str()).ok() + } else { + None + } + } + + pub const fn is_builtins(self) -> bool { + matches!(self, Self::Builtins) + } + + pub const fn is_typing(self) -> bool { + matches!(self, Self::Typing) + } + + pub const fn is_ty_extensions(self) -> bool { + matches!(self, Self::TyExtensions) + } + + pub const fn is_inspect(self) -> bool { + matches!(self, Self::Inspect) + } + + pub const fn is_enum(self) -> bool { + matches!(self, Self::Enum) + } +} + +impl std::fmt::Display for KnownModule { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use strum::IntoEnumIterator; + + #[test] + fn known_module_roundtrip_from_str() { + let stdlib_search_path = SearchPath::vendored_stdlib(); + + for module in KnownModule::iter() { + let module_name = module.name(); + + assert_eq!( + KnownModule::try_from_search_path_and_name(&stdlib_search_path, &module_name), + Some(module), + "The strum `EnumString` implementation appears to be incorrect for `{module_name}`" + ); + } + } +} diff --git a/crates/red_knot_python_semantic/src/module_resolver/path.rs b/crates/ty_python_semantic/src/module_resolver/path.rs similarity index 93% rename from crates/red_knot_python_semantic/src/module_resolver/path.rs rename to crates/ty_python_semantic/src/module_resolver/path.rs index 0b8a2a26d9e4e..7410e7a748bcd 100644 --- a/crates/red_knot_python_semantic/src/module_resolver/path.rs +++ b/crates/ty_python_semantic/src/module_resolver/path.rs @@ -4,12 +4,11 @@ use std::fmt; use std::sync::Arc; use camino::{Utf8Path, Utf8PathBuf}; - -use ruff_db::files::{system_path_to_file, vendored_path_to_file, File, FileError}; +use ruff_db::files::{File, FileError, system_path_to_file, vendored_path_to_file}; use ruff_db::system::{System, SystemPath, SystemPathBuf}; use ruff_db::vendored::{VendoredPath, VendoredPathBuf}; -use super::typeshed::{typeshed_versions, TypeshedVersionsParseError, TypeshedVersionsQueryResult}; +use super::typeshed::{TypeshedVersionsParseError, TypeshedVersionsQueryResult, typeshed_versions}; use crate::db::Db; use crate::module_name::ModuleName; use crate::module_resolver::resolver::ResolverContext; @@ -63,6 +62,10 @@ impl ModulePath { self.relative_path.pop() } + pub(super) fn search_path(&self) -> &SearchPath { + &self.search_path + } + #[must_use] pub(super) fn is_directory(&self, resolver: &ResolverContext) -> bool { let ModulePath { @@ -112,8 +115,9 @@ impl ModulePath { | SearchPathInner::SitePackages(search_path) | SearchPathInner::Editable(search_path) => { let absolute_path = search_path.join(relative_path); + system_path_to_file(resolver.db.upcast(), absolute_path.join("__init__.py")).is_ok() - || system_path_to_file(resolver.db.upcast(), absolute_path.join("__init__.py")) + || system_path_to_file(resolver.db.upcast(), absolute_path.join("__init__.pyi")) .is_ok() } SearchPathInner::StandardLibraryCustom(search_path) => { @@ -139,6 +143,23 @@ impl ModulePath { } } + pub(super) fn to_system_path(&self) -> Option<SystemPathBuf> { + let ModulePath { + search_path, + relative_path, + } = self; + match &*search_path.0 { + SearchPathInner::Extra(search_path) + | SearchPathInner::FirstParty(search_path) + | SearchPathInner::SitePackages(search_path) + | SearchPathInner::Editable(search_path) => Some(search_path.join(relative_path)), + SearchPathInner::StandardLibraryCustom(stdlib_root) => { + Some(stdlib_root.join(relative_path)) + } + SearchPathInner::StandardLibraryVendored(_) => None, + } + } + #[must_use] pub(super) fn to_file(&self, resolver: &ResolverContext) -> Option<File> { let db = resolver.db.upcast(); @@ -184,7 +205,18 @@ impl ModulePath { stdlib_path_to_module_name(relative_path) } else { let parent = relative_path.parent()?; - let parent_components = parent.components().map(|component| component.as_str()); + let parent_components = parent.components().enumerate().map(|(index, component)| { + let component = component.as_str(); + + // For stub packages, strip the `-stubs` suffix from the first component + // because it isn't a valid module name part AND the module name is the name without the `-stubs`. + if index == 0 { + component.strip_suffix("-stubs").unwrap_or(component) + } else { + component + } + }); + let skip_final_part = relative_path.ends_with("__init__.py") || relative_path.ends_with("__init__.pyi"); if skip_final_part { @@ -283,9 +315,9 @@ fn query_stdlib_version( let Some(module_name) = stdlib_path_to_module_name(relative_path) else { return TypeshedVersionsQueryResult::DoesNotExist; }; - let ResolverContext { db, target_version } = context; + let ResolverContext { db, python_version } = context; - typeshed_versions(*db).query_module(&module_name, *target_version) + typeshed_versions(*db).query_module(&module_name, *python_version) } /// Enumeration describing the various ways in which validation of a search path might fail. @@ -628,13 +660,26 @@ impl PartialEq<SearchPath> for VendoredPathBuf { } } +impl fmt::Display for SearchPath { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match &*self.0 { + SearchPathInner::Extra(system_path_buf) + | SearchPathInner::FirstParty(system_path_buf) + | SearchPathInner::SitePackages(system_path_buf) + | SearchPathInner::Editable(system_path_buf) + | SearchPathInner::StandardLibraryCustom(system_path_buf) => system_path_buf.fmt(f), + SearchPathInner::StandardLibraryVendored(vendored_path_buf) => vendored_path_buf.fmt(f), + } + } +} + #[cfg(test)] mod tests { use ruff_db::Db; + use ruff_python_ast::PythonVersion; use crate::db::tests::TestDb; use crate::module_resolver::testing::{FileSpec, MockedTypeshed, TestCase, TestCaseBuilder}; - use crate::python_version::PythonVersion; use super::*; @@ -658,7 +703,7 @@ mod tests { let TestCase { db, src, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(MockedTypeshed::default()) + .with_mocked_typeshed(MockedTypeshed::default()) .build(); assert_eq!( @@ -779,7 +824,7 @@ mod tests { #[should_panic(expected = "Extension must be `pyi`; got `py`")] fn stdlib_path_invalid_join_py() { let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(MockedTypeshed::default()) + .with_mocked_typeshed(MockedTypeshed::default()) .build(); SearchPath::custom_stdlib(&db, stdlib.parent().unwrap()) .unwrap() @@ -791,7 +836,7 @@ mod tests { #[should_panic(expected = "Extension must be `pyi`; got `rs`")] fn stdlib_path_invalid_join_rs() { let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(MockedTypeshed::default()) + .with_mocked_typeshed(MockedTypeshed::default()) .build(); SearchPath::custom_stdlib(&db, stdlib.parent().unwrap()) .unwrap() @@ -822,7 +867,7 @@ mod tests { #[test] fn relativize_stdlib_path_errors() { let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(MockedTypeshed::default()) + .with_mocked_typeshed(MockedTypeshed::default()) .build(); let root = SearchPath::custom_stdlib(&db, stdlib.parent().unwrap()).unwrap(); @@ -867,11 +912,11 @@ mod tests { fn typeshed_test_case( typeshed: MockedTypeshed, - target_version: PythonVersion, + python_version: PythonVersion, ) -> (TestDb, SearchPath) { let TestCase { db, stdlib, .. } = TestCaseBuilder::new() - .with_custom_typeshed(typeshed) - .with_target_version(target_version) + .with_mocked_typeshed(typeshed) + .with_python_version(python_version) .build(); let stdlib = SearchPath::custom_stdlib(&db, stdlib.parent().unwrap()).unwrap(); (db, stdlib) @@ -905,10 +950,12 @@ mod tests { assert!(asyncio_regular_package.is_regular_package(&resolver)); // Paths to directories don't resolve to VfsFiles assert_eq!(asyncio_regular_package.to_file(&resolver), None); - assert!(asyncio_regular_package - .join("__init__.pyi") - .to_file(&resolver) - .is_some()); + assert!( + asyncio_regular_package + .join("__init__.pyi") + .to_file(&resolver) + .is_some() + ); // The `asyncio` package exists on Python 3.8, but the `asyncio.tasks` submodule does not, // according to the `VERSIONS` file in our typeshed mock: @@ -1038,10 +1085,12 @@ mod tests { assert!(collections_regular_package.is_regular_package(&resolver)); // (This is still `None`, as directories don't resolve to `Vfs` files) assert_eq!(collections_regular_package.to_file(&resolver), None); - assert!(collections_regular_package - .join("__init__.pyi") - .to_file(&resolver) - .is_some()); + assert!( + collections_regular_package + .join("__init__.pyi") + .to_file(&resolver) + .is_some() + ); // ...and so should the `asyncio.tasks` submodule (though it's still not a directory): let asyncio_tasks_module = stdlib_path.join("asyncio/tasks.pyi"); diff --git a/crates/ty_python_semantic/src/module_resolver/resolver.rs b/crates/ty_python_semantic/src/module_resolver/resolver.rs new file mode 100644 index 0000000000000..49bf534e774ce --- /dev/null +++ b/crates/ty_python_semantic/src/module_resolver/resolver.rs @@ -0,0 +1,2130 @@ +use std::borrow::Cow; +use std::fmt; +use std::iter::FusedIterator; +use std::str::Split; + +use compact_str::format_compact; +use rustc_hash::{FxBuildHasher, FxHashSet}; + +use ruff_db::files::{File, FilePath, FileRootKind}; +use ruff_db::system::{DirectoryEntry, System, SystemPath, SystemPathBuf}; +use ruff_db::vendored::{VendoredFileSystem, VendoredPath}; +use ruff_python_ast::PythonVersion; + +use crate::db::Db; +use crate::module_name::ModuleName; +use crate::module_resolver::typeshed::{TypeshedVersions, vendored_typeshed_versions}; +use crate::site_packages::{PythonEnvironment, SitePackagesDiscoveryError, SysPrefixPathOrigin}; +use crate::{Program, PythonPath, SearchPathSettings}; + +use super::module::{Module, ModuleKind}; +use super::path::{ModulePath, SearchPath, SearchPathValidationError}; + +/// Resolves a module name to a module. +pub fn resolve_module(db: &dyn Db, module_name: &ModuleName) -> Option<Module> { + let interned_name = ModuleNameIngredient::new(db, module_name); + + resolve_module_query(db, interned_name) +} + +/// Salsa query that resolves an interned [`ModuleNameIngredient`] to a module. +/// +/// This query should not be called directly. Instead, use [`resolve_module`]. It only exists +/// because Salsa requires the module name to be an ingredient. +#[salsa::tracked] +pub(crate) fn resolve_module_query<'db>( + db: &'db dyn Db, + module_name: ModuleNameIngredient<'db>, +) -> Option<Module> { + let name = module_name.name(db); + let _span = tracing::trace_span!("resolve_module", %name).entered(); + + let Some(resolved) = resolve_name(db, name) else { + tracing::debug!("Module `{name}` not found in search paths"); + return None; + }; + + let module = match resolved { + ResolvedName::FileModule(module) => { + tracing::trace!( + "Resolved module `{name}` to `{path}`", + path = module.file.path(db) + ); + Module::file_module(name.clone(), module.kind, module.search_path, module.file) + } + ResolvedName::NamespacePackage => { + tracing::trace!("Module `{name}` is a namespace package"); + Module::namespace_package(name.clone()) + } + }; + + Some(module) +} + +/// Resolves the module for the given path. +/// +/// Returns `None` if the path is not a module locatable via any of the known search paths. +#[allow(unused)] +pub(crate) fn path_to_module(db: &dyn Db, path: &FilePath) -> Option<Module> { + // It's not entirely clear on first sight why this method calls `file_to_module` instead of + // it being the other way round, considering that the first thing that `file_to_module` does + // is to retrieve the file's path. + // + // The reason is that `file_to_module` is a tracked Salsa query and salsa queries require that + // all arguments are Salsa ingredients (something stored in Salsa). `Path`s aren't salsa ingredients but + // `VfsFile` is. So what we do here is to retrieve the `path`'s `VfsFile` so that we can make + // use of Salsa's caching and invalidation. + let file = path.to_file(db.upcast())?; + file_to_module(db, file) +} + +#[derive(Debug, Clone, Copy)] +enum SystemOrVendoredPathRef<'a> { + System(&'a SystemPath), + Vendored(&'a VendoredPath), +} + +impl std::fmt::Display for SystemOrVendoredPathRef<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + SystemOrVendoredPathRef::System(system) => system.fmt(f), + SystemOrVendoredPathRef::Vendored(vendored) => vendored.fmt(f), + } + } +} + +/// Resolves the module for the file with the given id. +/// +/// Returns `None` if the file is not a module locatable via any of the known search paths. +#[salsa::tracked] +pub(crate) fn file_to_module(db: &dyn Db, file: File) -> Option<Module> { + let _span = tracing::trace_span!("file_to_module", ?file).entered(); + + let path = match file.path(db.upcast()) { + FilePath::System(system) => SystemOrVendoredPathRef::System(system), + FilePath::Vendored(vendored) => SystemOrVendoredPathRef::Vendored(vendored), + FilePath::SystemVirtual(_) => return None, + }; + + let module_name = search_paths(db).find_map(|candidate| { + let relative_path = match path { + SystemOrVendoredPathRef::System(path) => candidate.relativize_system_path(path), + SystemOrVendoredPathRef::Vendored(path) => candidate.relativize_vendored_path(path), + }?; + relative_path.to_module_name() + })?; + + // Resolve the module name to see if Python would resolve the name to the same path. + // If it doesn't, then that means that multiple modules have the same name in different + // root paths, but that the module corresponding to `path` is in a lower priority search path, + // in which case we ignore it. + let module = resolve_module(db, &module_name)?; + let module_file = module.file()?; + + if file.path(db) == module_file.path(db) { + Some(module) + } else { + // This path is for a module with the same name but with a different precedence. For example: + // ``` + // src/foo.py + // src/foo/__init__.py + // ``` + // The module name of `src/foo.py` is `foo`, but the module loaded by Python is `src/foo/__init__.py`. + // That means we need to ignore `src/foo.py` even though it resolves to the same module name. + None + } +} + +pub(crate) fn search_paths(db: &dyn Db) -> SearchPathIterator { + Program::get(db).search_paths(db).iter(db) +} + +/// Searches for a `.venv` directory in `project_root` that contains a `pyvenv.cfg` file. +fn discover_venv_in(system: &dyn System, project_root: &SystemPath) -> Option<SystemPathBuf> { + let virtual_env_directory = project_root.join(".venv"); + + system + .is_file(&virtual_env_directory.join("pyvenv.cfg")) + .then_some(virtual_env_directory) +} + +#[derive(Debug, PartialEq, Eq)] +pub struct SearchPaths { + /// Search paths that have been statically determined purely from reading Ruff's configuration settings. + /// These shouldn't ever change unless the config settings themselves change. + static_paths: Vec<SearchPath>, + + /// site-packages paths are not included in the above field: + /// if there are multiple site-packages paths, editable installations can appear + /// *between* the site-packages paths on `sys.path` at runtime. + /// That means we can't know where a second or third `site-packages` path should sit + /// in terms of module-resolution priority until we've discovered the editable installs + /// for the first `site-packages` path + site_packages: Vec<SearchPath>, + + typeshed_versions: TypeshedVersions, +} + +impl SearchPaths { + /// Validate and normalize the raw settings given by the user + /// into settings we can use for module resolution + /// + /// This method also implements the typing spec's [module resolution order]. + /// + /// [module resolution order]: https://typing.python.org/en/latest/spec/distributing.html#import-resolution-ordering + pub(crate) fn from_settings( + db: &dyn Db, + settings: &SearchPathSettings, + ) -> Result<Self, SearchPathValidationError> { + fn canonicalize(path: &SystemPath, system: &dyn System) -> SystemPathBuf { + system + .canonicalize_path(path) + .unwrap_or_else(|_| path.to_path_buf()) + } + + let SearchPathSettings { + extra_paths, + src_roots, + custom_typeshed: typeshed, + python_path, + } = settings; + + let system = db.system(); + let files = db.files(); + + let mut static_paths = vec![]; + + for path in extra_paths { + let path = canonicalize(path, system); + files.try_add_root(db.upcast(), &path, FileRootKind::LibrarySearchPath); + tracing::debug!("Adding extra search-path '{path}'"); + + static_paths.push(SearchPath::extra(system, path)?); + } + + for src_root in src_roots { + tracing::debug!("Adding first-party search path '{src_root}'"); + static_paths.push(SearchPath::first_party(system, src_root.to_path_buf())?); + } + + let (typeshed_versions, stdlib_path) = if let Some(typeshed) = typeshed { + let typeshed = canonicalize(typeshed, system); + tracing::debug!("Adding custom-stdlib search path '{typeshed}'"); + + files.try_add_root(db.upcast(), &typeshed, FileRootKind::LibrarySearchPath); + + let versions_path = typeshed.join("stdlib/VERSIONS"); + + let versions_content = system.read_to_string(&versions_path).map_err(|error| { + SearchPathValidationError::FailedToReadVersionsFile { + path: versions_path, + error, + } + })?; + + let parsed: TypeshedVersions = versions_content.parse()?; + + let search_path = SearchPath::custom_stdlib(db, &typeshed)?; + + (parsed, search_path) + } else { + tracing::debug!("Using vendored stdlib"); + ( + vendored_typeshed_versions(db), + SearchPath::vendored_stdlib(), + ) + }; + + static_paths.push(stdlib_path); + + let site_packages_paths = match python_path { + PythonPath::SysPrefix(sys_prefix, origin) => { + tracing::debug!( + "Discovering site-packages paths from sys-prefix `{sys_prefix}` ({origin}')" + ); + // TODO: We may want to warn here if the venv's python version is older + // than the one resolved in the program settings because it indicates + // that the `target-version` is incorrectly configured or that the + // venv is out of date. + PythonEnvironment::new(sys_prefix, *origin, system) + .and_then(|env| env.site_packages_directories(system))? + } + + PythonPath::Resolve(target, origin) => { + tracing::debug!("Resolving {origin}: {target}"); + + let root = system + // If given a file, assume it's a Python executable, e.g., `.venv/bin/python3`, + // and search for a virtual environment in the root directory. Ideally, we'd + // invoke the target to determine `sys.prefix` here, but that's more complicated + // and may be deferred to uv. + .is_file(target) + .then(|| target.as_path()) + .take_if(|target| { + // Avoid using the target if it doesn't look like a Python executable, e.g., + // to deny cases like `.venv/bin/foo` + target + .file_name() + .is_some_and(|name| name.starts_with("python")) + }) + .and_then(SystemPath::parent) + .and_then(SystemPath::parent) + // If not a file, use the path as given and allow let `PythonEnvironment::new` + // handle the error. + .unwrap_or(target); + + PythonEnvironment::new(root, *origin, system) + .and_then(|venv| venv.site_packages_directories(system))? + } + + PythonPath::Discover(root) => { + tracing::debug!("Discovering virtual environment in `{root}`"); + let virtual_env_path = discover_venv_in(db.system(), root); + if let Some(virtual_env_path) = virtual_env_path { + tracing::debug!("Found `.venv` folder at `{}`", virtual_env_path); + + let handle_invalid_virtual_env = |error: SitePackagesDiscoveryError| { + tracing::debug!( + "Ignoring automatically detected virtual environment at `{}`: {}", + virtual_env_path, + error + ); + vec![] + }; + + match PythonEnvironment::new( + virtual_env_path.clone(), + SysPrefixPathOrigin::LocalVenv, + system, + ) { + Ok(venv) => venv + .site_packages_directories(system) + .unwrap_or_else(handle_invalid_virtual_env), + Err(error) => handle_invalid_virtual_env(error), + } + } else { + tracing::debug!("No virtual environment found"); + vec![] + } + } + + PythonPath::KnownSitePackages(paths) => paths + .iter() + .map(|path| canonicalize(path, system)) + .collect(), + }; + + let mut site_packages: Vec<_> = Vec::with_capacity(site_packages_paths.len()); + + for path in site_packages_paths { + tracing::debug!("Adding site-packages search path '{path}'"); + files.try_add_root(db.upcast(), &path, FileRootKind::LibrarySearchPath); + site_packages.push(SearchPath::site_packages(system, path)?); + } + + // TODO vendor typeshed's third-party stubs as well as the stdlib and fallback to them as a final step + + // Filter out module resolution paths that point to the same directory on disk (the same invariant maintained by [`sys.path` at runtime]). + // (Paths may, however, *overlap* -- e.g. you could have both `src/` and `src/foo` + // as module resolution paths simultaneously.) + // + // This code doesn't use an `IndexSet` because the key is the system path and not the search root. + // + // [`sys.path` at runtime]: https://docs.python.org/3/library/site.html#module-site + let mut seen_paths = FxHashSet::with_capacity_and_hasher(static_paths.len(), FxBuildHasher); + + static_paths.retain(|path| { + if let Some(path) = path.as_system_path() { + seen_paths.insert(path.to_path_buf()) + } else { + true + } + }); + + Ok(SearchPaths { + static_paths, + site_packages, + typeshed_versions, + }) + } + + pub(super) fn iter<'a>(&'a self, db: &'a dyn Db) -> SearchPathIterator<'a> { + SearchPathIterator { + db, + static_paths: self.static_paths.iter(), + dynamic_paths: None, + } + } + + pub(crate) fn custom_stdlib(&self) -> Option<&SystemPath> { + self.static_paths.iter().find_map(|search_path| { + if search_path.is_standard_library() { + search_path.as_system_path() + } else { + None + } + }) + } + + pub(super) fn typeshed_versions(&self) -> &TypeshedVersions { + &self.typeshed_versions + } +} + +/// Collect all dynamic search paths. For each `site-packages` path: +/// - Collect that `site-packages` path +/// - Collect any search paths listed in `.pth` files in that `site-packages` directory +/// due to editable installations of third-party packages. +/// +/// The editable-install search paths for the first `site-packages` directory +/// should come between the two `site-packages` directories when it comes to +/// module-resolution priority. +#[salsa::tracked(returns(deref))] +pub(crate) fn dynamic_resolution_paths(db: &dyn Db) -> Vec<SearchPath> { + tracing::debug!("Resolving dynamic module resolution paths"); + + let SearchPaths { + static_paths, + site_packages, + typeshed_versions: _, + } = Program::get(db).search_paths(db); + + let mut dynamic_paths = Vec::new(); + + if site_packages.is_empty() { + return dynamic_paths; + } + + let mut existing_paths: FxHashSet<_> = static_paths + .iter() + .filter_map(|path| path.as_system_path()) + .map(Cow::Borrowed) + .collect(); + + let files = db.files(); + let system = db.system(); + + for site_packages_search_path in site_packages { + let site_packages_dir = site_packages_search_path + .as_system_path() + .expect("Expected site package path to be a system path"); + + if !existing_paths.insert(Cow::Borrowed(site_packages_dir)) { + continue; + } + + let site_packages_root = files + .root(db.upcast(), site_packages_dir) + .expect("Site-package root to have been created"); + + // This query needs to be re-executed each time a `.pth` file + // is added, modified or removed from the `site-packages` directory. + // However, we don't use Salsa queries to read the source text of `.pth` files; + // we use the APIs on the `System` trait directly. As such, add a dependency on the + // site-package directory's revision. + site_packages_root.revision(db.upcast()); + + dynamic_paths.push(site_packages_search_path.clone()); + + // As well as modules installed directly into `site-packages`, + // the directory may also contain `.pth` files. + // Each `.pth` file in `site-packages` may contain one or more lines + // containing a (relative or absolute) path. + // Each of these paths may point to an editable install of a package, + // so should be considered an additional search path. + let pth_file_iterator = match PthFileIterator::new(db, site_packages_dir) { + Ok(iterator) => iterator, + Err(error) => { + tracing::warn!( + "Failed to search for editable installation in {site_packages_dir}: {error}" + ); + continue; + } + }; + + // The Python documentation specifies that `.pth` files in `site-packages` + // are processed in alphabetical order, so collecting and then sorting is necessary. + // https://docs.python.org/3/library/site.html#module-site + let mut all_pth_files: Vec<PthFile> = pth_file_iterator.collect(); + all_pth_files.sort_unstable_by(|a, b| a.path.cmp(&b.path)); + + let installations = all_pth_files.iter().flat_map(PthFile::items); + + for installation in installations { + let installation = system + .canonicalize_path(&installation) + .unwrap_or(installation); + + if existing_paths.insert(Cow::Owned(installation.clone())) { + match SearchPath::editable(system, installation.clone()) { + Ok(search_path) => { + tracing::debug!( + "Adding editable installation to module resolution path {path}", + path = installation + ); + dynamic_paths.push(search_path); + } + + Err(error) => { + tracing::debug!("Skipping editable installation: {error}"); + } + } + } + } + } + + dynamic_paths +} + +/// Iterate over the available module-resolution search paths, +/// following the invariants maintained by [`sys.path` at runtime]: +/// "No item is added to `sys.path` more than once." +/// Dynamic search paths (required for editable installs into `site-packages`) +/// are only calculated lazily. +/// +/// [`sys.path` at runtime]: https://docs.python.org/3/library/site.html#module-site +pub(crate) struct SearchPathIterator<'db> { + db: &'db dyn Db, + static_paths: std::slice::Iter<'db, SearchPath>, + dynamic_paths: Option<std::slice::Iter<'db, SearchPath>>, +} + +impl<'db> Iterator for SearchPathIterator<'db> { + type Item = &'db SearchPath; + + fn next(&mut self) -> Option<Self::Item> { + let SearchPathIterator { + db, + static_paths, + dynamic_paths, + } = self; + + static_paths.next().or_else(|| { + dynamic_paths + .get_or_insert_with(|| dynamic_resolution_paths(*db).iter()) + .next() + }) + } +} + +impl FusedIterator for SearchPathIterator<'_> {} + +/// Represents a single `.pth` file in a `site-packages` directory. +/// One or more lines in a `.pth` file may be a (relative or absolute) +/// path that represents an editable installation of a package. +struct PthFile<'db> { + path: SystemPathBuf, + contents: String, + site_packages: &'db SystemPath, +} + +impl<'db> PthFile<'db> { + /// Yield paths in this `.pth` file that appear to represent editable installations, + /// and should therefore be added as module-resolution search paths. + fn items(&'db self) -> impl Iterator<Item = SystemPathBuf> + 'db { + let PthFile { + path: _, + contents, + site_packages, + } = self; + + // Empty lines or lines starting with '#' are ignored by the Python interpreter. + // Lines that start with "import " or "import\t" do not represent editable installs at all; + // instead, these are lines that are executed by Python at startup. + // https://docs.python.org/3/library/site.html#module-site + contents.lines().filter_map(move |line| { + let line = line.trim_end(); + if line.is_empty() + || line.starts_with('#') + || line.starts_with("import ") + || line.starts_with("import\t") + { + return None; + } + + Some(SystemPath::absolute(line, site_packages)) + }) + } +} + +/// Iterator that yields a [`PthFile`] instance for every `.pth` file +/// found in a given `site-packages` directory. +struct PthFileIterator<'db> { + db: &'db dyn Db, + directory_iterator: Box<dyn Iterator<Item = std::io::Result<DirectoryEntry>> + 'db>, + site_packages: &'db SystemPath, +} + +impl<'db> PthFileIterator<'db> { + fn new(db: &'db dyn Db, site_packages: &'db SystemPath) -> std::io::Result<Self> { + Ok(Self { + db, + directory_iterator: db.system().read_directory(site_packages)?, + site_packages, + }) + } +} + +impl<'db> Iterator for PthFileIterator<'db> { + type Item = PthFile<'db>; + + fn next(&mut self) -> Option<Self::Item> { + let PthFileIterator { + db, + directory_iterator, + site_packages, + } = self; + + let system = db.system(); + + loop { + let entry_result = directory_iterator.next()?; + let Ok(entry) = entry_result else { + continue; + }; + let file_type = entry.file_type(); + if file_type.is_directory() { + continue; + } + let path = entry.into_path(); + if path.extension() != Some("pth") { + continue; + } + + let contents = match system.read_to_string(&path) { + Ok(contents) => contents, + Err(error) => { + tracing::warn!("Failed to read .pth file '{path}': {error}"); + continue; + } + }; + + return Some(PthFile { + path, + contents, + site_packages, + }); + } + } +} + +/// A thin wrapper around `ModuleName` to make it a Salsa ingredient. +/// +/// This is needed because Salsa requires that all query arguments are salsa ingredients. +#[salsa::interned(debug)] +struct ModuleNameIngredient<'db> { + #[returns(ref)] + pub(super) name: ModuleName, +} + +/// Given a module name and a list of search paths in which to lookup modules, +/// attempt to resolve the module name +fn resolve_name(db: &dyn Db, name: &ModuleName) -> Option<ResolvedName> { + let program = Program::get(db); + let python_version = program.python_version(db); + let resolver_state = ResolverContext::new(db, python_version); + let is_builtin_module = + ruff_python_stdlib::sys::is_builtin_module(python_version.minor, name.as_str()); + + let name = RelaxedModuleName::new(name); + let stub_name = name.to_stub_package(); + let mut is_namespace_package = false; + + for search_path in search_paths(db) { + // When a builtin module is imported, standard module resolution is bypassed: + // the module name always resolves to the stdlib module, + // even if there's a module of the same name in the first-party root + // (which would normally result in the stdlib module being overridden). + if is_builtin_module && !search_path.is_standard_library() { + continue; + } + + if !search_path.is_standard_library() { + match resolve_name_in_search_path(&resolver_state, &stub_name, search_path) { + Ok((package_kind, ResolvedName::FileModule(module))) => { + if package_kind.is_root() && module.kind.is_module() { + tracing::trace!( + "Search path '{search_path} contains a module named `{stub_name}` but a standalone module isn't a valid stub." + ); + } else { + return Some(ResolvedName::FileModule(module)); + } + } + Ok((_, ResolvedName::NamespacePackage)) => { + is_namespace_package = true; + } + Err(PackageKind::Root) => { + tracing::trace!( + "Search path '{search_path}' contains no stub package named `{stub_name}`." + ); + } + Err(PackageKind::Regular) => { + tracing::trace!( + "Stub-package in `{search_path} doesn't contain module: `{name}`" + ); + // stub exists, but the module doesn't. + // TODO: Support partial packages. + return None; + } + Err(PackageKind::Namespace) => { + tracing::trace!( + "Stub-package in `{search_path} doesn't contain module: `{name}` but it is a namespace package, keep going." + ); + // stub exists, but the module doesn't. But this is a namespace package, + // keep searching the next search path for a stub package with the same name. + continue; + } + } + } + + match resolve_name_in_search_path(&resolver_state, &name, search_path) { + Ok((_, ResolvedName::FileModule(module))) => { + return Some(ResolvedName::FileModule(module)); + } + Ok((_, ResolvedName::NamespacePackage)) => { + is_namespace_package = true; + } + Err(kind) => match kind { + PackageKind::Root => { + tracing::trace!( + "Search path '{search_path}' contains no package named `{name}`." + ); + } + PackageKind::Regular => { + // For regular packages, don't search the next search path. All files of that + // package must be in the same location + tracing::trace!("Package in `{search_path} doesn't contain module: `{name}`"); + return None; + } + PackageKind::Namespace => { + tracing::trace!( + "Package in `{search_path} doesn't contain module: `{name}` but it is a namespace package, keep going." + ); + } + }, + } + } + + if is_namespace_package { + return Some(ResolvedName::NamespacePackage); + } + + None +} + +#[derive(Debug)] +enum ResolvedName { + /// A module that resolves to a file. + FileModule(ResolvedFileModule), + + /// The module name resolved to a namespace package. + /// + /// For example, `from opentelemetry import trace, metrics` where `opentelemetry` is a namespace package (and `trace` and `metrics` are sub packages). + NamespacePackage, +} + +#[derive(Debug)] +struct ResolvedFileModule { + kind: ModuleKind, + search_path: SearchPath, + file: File, +} + +fn resolve_name_in_search_path( + context: &ResolverContext, + name: &RelaxedModuleName, + search_path: &SearchPath, +) -> Result<(PackageKind, ResolvedName), PackageKind> { + let mut components = name.components(); + let module_name = components.next_back().unwrap(); + + let resolved_package = resolve_package(search_path, components, context)?; + + let mut package_path = resolved_package.path; + + package_path.push(module_name); + + // Check for a regular package first (highest priority) + package_path.push("__init__"); + if let Some(regular_package) = resolve_file_module(&package_path, context) { + return Ok(( + resolved_package.kind, + ResolvedName::FileModule(ResolvedFileModule { + search_path: search_path.clone(), + kind: ModuleKind::Package, + file: regular_package, + }), + )); + } + + // Check for a file module next + package_path.pop(); + + if let Some(file_module) = resolve_file_module(&package_path, context) { + return Ok(( + resolved_package.kind, + ResolvedName::FileModule(ResolvedFileModule { + file: file_module, + kind: ModuleKind::Module, + search_path: search_path.clone(), + }), + )); + } + + // Last resort, check if a folder with the given name exists. + // If so, then this is a namespace package. + // We need to skip this check for typeshed because the `resolve_file_module` can also return `None` + // if the `__init__.py` exists but isn't available for the current Python version. + // Let's assume that the `xml` module is only available on Python 3.11+ and we're resolving for Python 3.10: + // * `resolve_file_module("xml/__init__.pyi")` returns `None` even though the file exists but the + // module isn't available for the current Python version. + // * The check here would now return `true` because the `xml` directory exists, resulting + // in a false positive for a namespace package. + // + // Since typeshed doesn't use any namespace packages today (May 2025), simply skip this + // check which also helps performance. If typeshed ever uses namespace packages, ensure that + // this check also takes the `VERSIONS` file into consideration. + if !search_path.is_standard_library() && package_path.is_directory(context) { + if let Some(path) = package_path.to_system_path() { + let system = context.db.system(); + if system.case_sensitivity().is_case_sensitive() + || system.path_exists_case_sensitive( + &path, + package_path.search_path().as_system_path().unwrap(), + ) + { + return Ok((resolved_package.kind, ResolvedName::NamespacePackage)); + } + } + } + + Err(resolved_package.kind) +} + +/// If `module` exists on disk with either a `.pyi` or `.py` extension, +/// return the [`File`] corresponding to that path. +/// +/// `.pyi` files take priority, as they always have priority when +/// resolving modules. +fn resolve_file_module(module: &ModulePath, resolver_state: &ResolverContext) -> Option<File> { + // Stubs have precedence over source files + let file = module + .with_pyi_extension() + .to_file(resolver_state) + .or_else(|| { + module + .with_py_extension() + .and_then(|path| path.to_file(resolver_state)) + })?; + + // For system files, test if the path has the correct casing. + // We can skip this step for vendored files or virtual files because + // those file systems are case sensitive (we wouldn't get to this point). + if let Some(path) = file.path(resolver_state.db).as_system_path() { + let system = resolver_state.db.system(); + if !system.case_sensitivity().is_case_sensitive() + && !system + .path_exists_case_sensitive(path, module.search_path().as_system_path().unwrap()) + { + return None; + } + } + + Some(file) +} + +fn resolve_package<'a, 'db, I>( + module_search_path: &SearchPath, + components: I, + resolver_state: &ResolverContext<'db>, +) -> Result<ResolvedPackage, PackageKind> +where + I: Iterator<Item = &'a str>, +{ + let mut package_path = module_search_path.to_module_path(); + + // `true` if inside a folder that is a namespace package (has no `__init__.py`). + // Namespace packages are special because they can be spread across multiple search paths. + // https://peps.python.org/pep-0420/ + let mut in_namespace_package = false; + + // `true` if resolving a sub-package. For example, `true` when resolving `bar` of `foo.bar`. + let mut in_sub_package = false; + + // For `foo.bar.baz`, test that `foo` and `baz` both contain a `__init__.py`. + for folder in components { + package_path.push(folder); + + let is_regular_package = package_path.is_regular_package(resolver_state); + + if is_regular_package { + in_namespace_package = false; + } else if package_path.is_directory(resolver_state) + // Pure modules hide namespace packages with the same name + && resolve_file_module(&package_path, resolver_state).is_none() + { + // A directory without an `__init__.py(i)` is a namespace package, continue with the next folder. + in_namespace_package = true; + } else if in_namespace_package { + // Package not found but it is part of a namespace package. + return Err(PackageKind::Namespace); + } else if in_sub_package { + // A regular sub package wasn't found. + return Err(PackageKind::Regular); + } else { + // We couldn't find `foo` for `foo.bar.baz`, search the next search path. + return Err(PackageKind::Root); + } + + in_sub_package = true; + } + + let kind = if in_namespace_package { + PackageKind::Namespace + } else if in_sub_package { + PackageKind::Regular + } else { + PackageKind::Root + }; + + Ok(ResolvedPackage { + kind, + path: package_path, + }) +} + +#[derive(Debug)] +struct ResolvedPackage { + path: ModulePath, + kind: PackageKind, +} + +#[derive(Copy, Clone, Eq, PartialEq, Debug)] +enum PackageKind { + /// A root package or module. E.g. `foo` in `foo.bar.baz` or just `foo`. + Root, + + /// A regular sub-package where the parent contains an `__init__.py`. + /// + /// For example, `bar` in `foo.bar` when the `foo` directory contains an `__init__.py`. + Regular, + + /// A sub-package in a namespace package. A namespace package is a package without an `__init__.py`. + /// + /// For example, `bar` in `foo.bar` if the `foo` directory contains no `__init__.py`. + Namespace, +} + +impl PackageKind { + pub(crate) const fn is_root(self) -> bool { + matches!(self, PackageKind::Root) + } +} + +pub(super) struct ResolverContext<'db> { + pub(super) db: &'db dyn Db, + pub(super) python_version: PythonVersion, +} + +impl<'db> ResolverContext<'db> { + pub(super) fn new(db: &'db dyn Db, python_version: PythonVersion) -> Self { + Self { db, python_version } + } + + pub(super) fn vendored(&self) -> &VendoredFileSystem { + self.db.vendored() + } +} + +/// A [`ModuleName`] but with relaxed semantics to allow `<package>-stubs.path` +#[derive(Debug)] +struct RelaxedModuleName(compact_str::CompactString); + +impl RelaxedModuleName { + fn new(name: &ModuleName) -> Self { + Self(name.as_str().into()) + } + + fn components(&self) -> Split<'_, char> { + self.0.split('.') + } + + fn to_stub_package(&self) -> Self { + if let Some((package, rest)) = self.0.split_once('.') { + Self(format_compact!("{package}-stubs.{rest}")) + } else { + Self(format_compact!("{package}-stubs", package = self.0)) + } + } +} + +impl fmt::Display for RelaxedModuleName { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.0.fmt(f) + } +} + +#[cfg(test)] +mod tests { + use ruff_db::Db; + use ruff_db::files::{File, FilePath, system_path_to_file}; + use ruff_db::system::{DbWithTestSystem as _, DbWithWritableSystem as _}; + use ruff_db::testing::{ + assert_const_function_query_was_not_run, assert_function_query_was_not_run, + }; + use ruff_python_ast::PythonVersion; + + use crate::db::tests::TestDb; + use crate::module_name::ModuleName; + use crate::module_resolver::module::ModuleKind; + use crate::module_resolver::testing::{FileSpec, MockedTypeshed, TestCase, TestCaseBuilder}; + use crate::{ProgramSettings, PythonPlatform, PythonVersionWithSource}; + + use super::*; + + #[test] + fn first_party_module() { + let TestCase { db, src, .. } = TestCaseBuilder::new() + .with_src_files(&[("foo.py", "print('Hello, world!')")]) + .build(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + + assert_eq!( + Some(&foo_module), + resolve_module(&db, &foo_module_name).as_ref() + ); + + assert_eq!("foo", foo_module.name()); + assert_eq!(&src, foo_module.search_path().unwrap()); + assert_eq!(ModuleKind::Module, foo_module.kind()); + + let expected_foo_path = src.join("foo.py"); + assert_eq!(&expected_foo_path, foo_module.file().unwrap().path(&db)); + assert_eq!( + Some(foo_module), + path_to_module(&db, &FilePath::System(expected_foo_path)) + ); + } + + #[test] + fn builtins_vendored() { + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_vendored_typeshed() + .with_src_files(&[("builtins.py", "FOOOO = 42")]) + .build(); + + let builtins_module_name = ModuleName::new_static("builtins").unwrap(); + let builtins = resolve_module(&db, &builtins_module_name).expect("builtins to resolve"); + + assert_eq!( + builtins.file().unwrap().path(&db), + &stdlib.join("builtins.pyi") + ); + } + + #[test] + fn builtins_custom() { + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: &[("builtins.pyi", "def min(a, b): ...")], + versions: "builtins: 3.8-", + }; + + const SRC: &[FileSpec] = &[("builtins.py", "FOOOO = 42")]; + + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_src_files(SRC) + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let builtins_module_name = ModuleName::new_static("builtins").unwrap(); + let builtins = resolve_module(&db, &builtins_module_name).expect("builtins to resolve"); + + assert_eq!( + builtins.file().unwrap().path(&db), + &stdlib.join("builtins.pyi") + ); + } + + #[test] + fn stdlib() { + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], + versions: "functools: 3.8-", + }; + + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let functools_module_name = ModuleName::new_static("functools").unwrap(); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + + assert_eq!( + Some(&functools_module), + resolve_module(&db, &functools_module_name).as_ref() + ); + + assert_eq!(&stdlib, functools_module.search_path().unwrap()); + assert_eq!(ModuleKind::Module, functools_module.kind()); + + let expected_functools_path = stdlib.join("functools.pyi"); + assert_eq!( + &expected_functools_path, + functools_module.file().unwrap().path(&db) + ); + + assert_eq!( + Some(functools_module), + path_to_module(&db, &FilePath::System(expected_functools_path)) + ); + } + + fn create_module_names(raw_names: &[&str]) -> Vec<ModuleName> { + raw_names + .iter() + .map(|raw| ModuleName::new(raw).unwrap()) + .collect() + } + + #[test] + fn stdlib_resolution_respects_versions_file_py38_existing_modules() { + const VERSIONS: &str = "\ + asyncio: 3.8- # 'Regular' package on py38+ + asyncio.tasks: 3.9-3.11 # Submodule on py39+ only + functools: 3.8- # Top-level single-file module + xml: 3.8-3.8 # Namespace package on py38 only + "; + + const STDLIB: &[FileSpec] = &[ + ("asyncio/__init__.pyi", ""), + ("asyncio/tasks.pyi", ""), + ("functools.pyi", ""), + ("xml/etree.pyi", ""), + ]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: STDLIB, + versions: VERSIONS, + }; + + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let existing_modules = create_module_names(&["asyncio", "functools", "xml.etree"]); + for module_name in existing_modules { + let resolved_module = resolve_module(&db, &module_name).unwrap_or_else(|| { + panic!("Expected module {module_name} to exist in the mock stdlib") + }); + let search_path = resolved_module.search_path().unwrap(); + assert_eq!( + &stdlib, search_path, + "Search path for {module_name} was unexpectedly {search_path:?}" + ); + assert!( + search_path.is_standard_library(), + "Expected a stdlib search path, but got {search_path:?}" + ); + } + } + + #[test] + fn stdlib_resolution_respects_versions_file_py38_nonexisting_modules() { + const VERSIONS: &str = "\ + asyncio: 3.8- # 'Regular' package on py38+ + asyncio.tasks: 3.9-3.11 # Submodule on py39+ only + collections: 3.9- # 'Regular' package on py39+ + importlib: 3.9- # Namespace package on py39+ + xml: 3.8-3.8 # Namespace package on 3.8 only + "; + + const STDLIB: &[FileSpec] = &[ + ("collections/__init__.pyi", ""), + ("asyncio/__init__.pyi", ""), + ("asyncio/tasks.pyi", ""), + ("importlib/abc.pyi", ""), + ("xml/etree.pyi", ""), + ]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: STDLIB, + versions: VERSIONS, + }; + + let TestCase { db, .. } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let nonexisting_modules = create_module_names(&[ + "collections", + "importlib", + "importlib.abc", + "xml", + "asyncio.tasks", + ]); + + for module_name in nonexisting_modules { + assert!( + resolve_module(&db, &module_name).is_none(), + "Unexpectedly resolved a module for {module_name}" + ); + } + } + + #[test] + fn stdlib_resolution_respects_versions_file_py39_existing_modules() { + const VERSIONS: &str = "\ + asyncio: 3.8- # 'Regular' package on py38+ + asyncio.tasks: 3.9-3.11 # Submodule on py39+ only + collections: 3.9- # 'Regular' package on py39+ + functools: 3.8- # Top-level single-file module + importlib: 3.9- # Namespace package on py39+ + "; + + const STDLIB: &[FileSpec] = &[ + ("asyncio/__init__.pyi", ""), + ("asyncio/tasks.pyi", ""), + ("collections/__init__.pyi", ""), + ("functools.pyi", ""), + ("importlib/abc.pyi", ""), + ]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: STDLIB, + versions: VERSIONS, + }; + + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY39) + .build(); + + let existing_modules = create_module_names(&[ + "asyncio", + "functools", + "importlib.abc", + "collections", + "asyncio.tasks", + ]); + + for module_name in existing_modules { + let resolved_module = resolve_module(&db, &module_name).unwrap_or_else(|| { + panic!("Expected module {module_name} to exist in the mock stdlib") + }); + let search_path = resolved_module.search_path().unwrap(); + assert_eq!( + &stdlib, search_path, + "Search path for {module_name} was unexpectedly {search_path:?}" + ); + assert!( + search_path.is_standard_library(), + "Expected a stdlib search path, but got {search_path:?}" + ); + } + } + #[test] + fn stdlib_resolution_respects_versions_file_py39_nonexisting_modules() { + const VERSIONS: &str = "\ + importlib: 3.9- # Namespace package on py39+ + xml: 3.8-3.8 # Namespace package on 3.8 only + "; + + const STDLIB: &[FileSpec] = &[("importlib/abc.pyi", ""), ("xml/etree.pyi", "")]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: STDLIB, + versions: VERSIONS, + }; + + let TestCase { db, .. } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY39) + .build(); + + let nonexisting_modules = create_module_names(&["importlib", "xml", "xml.etree"]); + for module_name in nonexisting_modules { + assert!( + resolve_module(&db, &module_name).is_none(), + "Unexpectedly resolved a module for {module_name}" + ); + } + } + + #[test] + fn first_party_precedence_over_stdlib() { + const SRC: &[FileSpec] = &[("functools.py", "def update_wrapper(): ...")]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], + versions: "functools: 3.8-", + }; + + let TestCase { db, src, .. } = TestCaseBuilder::new() + .with_src_files(SRC) + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let functools_module_name = ModuleName::new_static("functools").unwrap(); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + + assert_eq!( + Some(&functools_module), + resolve_module(&db, &functools_module_name).as_ref() + ); + assert_eq!(&src, functools_module.search_path().unwrap()); + assert_eq!(ModuleKind::Module, functools_module.kind()); + assert_eq!( + &src.join("functools.py"), + functools_module.file().unwrap().path(&db) + ); + + assert_eq!( + Some(functools_module), + path_to_module(&db, &FilePath::System(src.join("functools.py"))) + ); + } + + #[test] + fn stdlib_uses_vendored_typeshed_when_no_custom_typeshed_supplied() { + let TestCase { db, stdlib, .. } = TestCaseBuilder::new() + .with_vendored_typeshed() + .with_python_version(PythonVersion::default()) + .build(); + + let pydoc_data_topics_name = ModuleName::new_static("pydoc_data.topics").unwrap(); + let pydoc_data_topics = resolve_module(&db, &pydoc_data_topics_name).unwrap(); + + assert_eq!("pydoc_data.topics", pydoc_data_topics.name()); + assert_eq!(pydoc_data_topics.search_path().unwrap(), &stdlib); + assert_eq!( + pydoc_data_topics.file().unwrap().path(&db), + &stdlib.join("pydoc_data/topics.pyi") + ); + } + + #[test] + fn resolve_package() { + let TestCase { src, db, .. } = TestCaseBuilder::new() + .with_src_files(&[("foo/__init__.py", "print('Hello, world!'")]) + .build(); + + let foo_path = src.join("foo/__init__.py"); + let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); + + assert_eq!("foo", foo_module.name()); + assert_eq!(&src, foo_module.search_path().unwrap()); + assert_eq!(&foo_path, foo_module.file().unwrap().path(&db)); + + assert_eq!( + Some(&foo_module), + path_to_module(&db, &FilePath::System(foo_path)).as_ref() + ); + + // Resolving by directory doesn't resolve to the init file. + assert_eq!( + None, + path_to_module(&db, &FilePath::System(src.join("foo"))) + ); + } + + #[test] + fn package_priority_over_module() { + const SRC: &[FileSpec] = &[ + ("foo/__init__.py", "print('Hello, world!')"), + ("foo.py", "print('Hello, world!')"), + ]; + + let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); + + let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); + let foo_init_path = src.join("foo/__init__.py"); + + assert_eq!(&src, foo_module.search_path().unwrap()); + assert_eq!(&foo_init_path, foo_module.file().unwrap().path(&db)); + assert_eq!(ModuleKind::Package, foo_module.kind()); + + assert_eq!( + Some(foo_module), + path_to_module(&db, &FilePath::System(foo_init_path)) + ); + assert_eq!( + None, + path_to_module(&db, &FilePath::System(src.join("foo.py"))) + ); + } + + #[test] + fn typing_stub_over_module() { + const SRC: &[FileSpec] = &[("foo.py", "print('Hello, world!')"), ("foo.pyi", "x: int")]; + + let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); + + let foo = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); + let foo_stub = src.join("foo.pyi"); + + assert_eq!(&src, foo.search_path().unwrap()); + assert_eq!(&foo_stub, foo.file().unwrap().path(&db)); + + assert_eq!(Some(foo), path_to_module(&db, &FilePath::System(foo_stub))); + assert_eq!( + None, + path_to_module(&db, &FilePath::System(src.join("foo.py"))) + ); + } + + #[test] + fn sub_packages() { + const SRC: &[FileSpec] = &[ + ("foo/__init__.py", ""), + ("foo/bar/__init__.py", ""), + ("foo/bar/baz.py", "print('Hello, world!)'"), + ]; + + let TestCase { db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); + + let baz_module = + resolve_module(&db, &ModuleName::new_static("foo.bar.baz").unwrap()).unwrap(); + let baz_path = src.join("foo/bar/baz.py"); + + assert_eq!(&src, baz_module.search_path().unwrap()); + assert_eq!(&baz_path, baz_module.file().unwrap().path(&db)); + + assert_eq!( + Some(baz_module), + path_to_module(&db, &FilePath::System(baz_path)) + ); + } + + #[test] + fn module_search_path_priority() { + let TestCase { + db, + src, + site_packages, + .. + } = TestCaseBuilder::new() + .with_src_files(&[("foo.py", "")]) + .with_site_packages_files(&[("foo.py", "")]) + .build(); + + let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); + let foo_src_path = src.join("foo.py"); + + assert_eq!(&src, foo_module.search_path().unwrap()); + assert_eq!(&foo_src_path, foo_module.file().unwrap().path(&db)); + assert_eq!( + Some(foo_module), + path_to_module(&db, &FilePath::System(foo_src_path)) + ); + + assert_eq!( + None, + path_to_module(&db, &FilePath::System(site_packages.join("foo.py"))) + ); + } + + #[test] + #[cfg(target_family = "unix")] + fn symlink() -> anyhow::Result<()> { + use anyhow::Context; + + use crate::{ + PythonPlatform, PythonVersionSource, PythonVersionWithSource, program::Program, + }; + use ruff_db::system::{OsSystem, SystemPath}; + + use crate::db::tests::TestDb; + + let mut db = TestDb::new(); + + let temp_dir = tempfile::tempdir()?; + let root = temp_dir + .path() + .canonicalize() + .context("Failed to canonicalize temp dir")?; + let root = SystemPath::from_std_path(&root).unwrap(); + db.use_system(OsSystem::new(root)); + + let src = root.join("src"); + let site_packages = root.join("site-packages"); + let custom_typeshed = root.join("typeshed"); + + let foo = src.join("foo.py"); + let bar = src.join("bar.py"); + + std::fs::create_dir_all(src.as_std_path())?; + std::fs::create_dir_all(site_packages.as_std_path())?; + std::fs::create_dir_all(custom_typeshed.join("stdlib").as_std_path())?; + std::fs::File::create(custom_typeshed.join("stdlib/VERSIONS").as_std_path())?; + + std::fs::write(foo.as_std_path(), "")?; + std::os::unix::fs::symlink(foo.as_std_path(), bar.as_std_path())?; + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource { + version: PythonVersion::PY38, + source: PythonVersionSource::default(), + }, + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![src.clone()], + custom_typeshed: Some(custom_typeshed), + python_path: PythonPath::KnownSitePackages(vec![site_packages]), + }, + }, + ) + .context("Invalid program settings")?; + + let foo_module = resolve_module(&db, &ModuleName::new_static("foo").unwrap()).unwrap(); + let bar_module = resolve_module(&db, &ModuleName::new_static("bar").unwrap()).unwrap(); + + assert_ne!(foo_module, bar_module); + + assert_eq!(&src, foo_module.search_path().unwrap()); + assert_eq!(&foo, foo_module.file().unwrap().path(&db)); + + // `foo` and `bar` shouldn't resolve to the same file + + assert_eq!(&src, bar_module.search_path().unwrap()); + assert_eq!(&bar, bar_module.file().unwrap().path(&db)); + assert_eq!(&foo, foo_module.file().unwrap().path(&db)); + + assert_ne!(&foo_module, &bar_module); + + assert_eq!( + Some(foo_module), + path_to_module(&db, &FilePath::System(foo)) + ); + assert_eq!( + Some(bar_module), + path_to_module(&db, &FilePath::System(bar)) + ); + + Ok(()) + } + + #[test] + fn deleting_an_unrelated_file_doesnt_change_module_resolution() { + let TestCase { mut db, src, .. } = TestCaseBuilder::new() + .with_src_files(&[("foo.py", "x = 1"), ("bar.py", "x = 2")]) + .with_python_version(PythonVersion::PY38) + .build(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + + let bar_path = src.join("bar.py"); + let bar = system_path_to_file(&db, &bar_path).expect("bar.py to exist"); + + db.clear_salsa_events(); + + // Delete `bar.py` + db.memory_file_system().remove_file(&bar_path).unwrap(); + bar.sync(&mut db); + + // Re-query the foo module. The foo module should still be cached because `bar.py` isn't relevant + // for resolving `foo`. + + let foo_module2 = resolve_module(&db, &foo_module_name); + + assert!( + !db.take_salsa_events() + .iter() + .any(|event| { matches!(event.kind, salsa::EventKind::WillExecute { .. }) }) + ); + + assert_eq!(Some(foo_module), foo_module2); + } + + #[test] + fn adding_file_on_which_module_resolution_depends_invalidates_previously_failing_query_that_now_succeeds() + -> anyhow::Result<()> { + let TestCase { mut db, src, .. } = TestCaseBuilder::new().build(); + let foo_path = src.join("foo.py"); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + assert_eq!(resolve_module(&db, &foo_module_name), None); + + // Now write the foo file + db.write_file(&foo_path, "x = 1")?; + + let foo_file = system_path_to_file(&db, &foo_path).expect("foo.py to exist"); + + let foo_module = resolve_module(&db, &foo_module_name).expect("Foo module to resolve"); + assert_eq!(foo_file, foo_module.file().unwrap()); + + Ok(()) + } + + #[test] + fn removing_file_on_which_module_resolution_depends_invalidates_previously_successful_query_that_now_fails() + -> anyhow::Result<()> { + const SRC: &[FileSpec] = &[("foo.py", "x = 1"), ("foo/__init__.py", "x = 2")]; + + let TestCase { mut db, src, .. } = TestCaseBuilder::new().with_src_files(SRC).build(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).expect("foo module to exist"); + let foo_init_path = src.join("foo/__init__.py"); + + assert_eq!(&foo_init_path, foo_module.file().unwrap().path(&db)); + + // Delete `foo/__init__.py` and the `foo` folder. `foo` should now resolve to `foo.py` + db.memory_file_system().remove_file(&foo_init_path)?; + db.memory_file_system() + .remove_directory(foo_init_path.parent().unwrap())?; + File::sync_path(&mut db, &foo_init_path); + File::sync_path(&mut db, foo_init_path.parent().unwrap()); + + let foo_module = resolve_module(&db, &foo_module_name).expect("Foo module to resolve"); + assert_eq!(&src.join("foo.py"), foo_module.file().unwrap().path(&db)); + + Ok(()) + } + + #[test] + fn adding_file_to_search_path_with_lower_priority_does_not_invalidate_query() { + const TYPESHED: MockedTypeshed = MockedTypeshed { + versions: "functools: 3.8-", + stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], + }; + + let TestCase { + mut db, + stdlib, + site_packages, + .. + } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let functools_module_name = ModuleName::new_static("functools").unwrap(); + let stdlib_functools_path = stdlib.join("functools.pyi"); + + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + assert_eq!(functools_module.search_path().unwrap(), &stdlib); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, &stdlib_functools_path) + ); + + // Adding a file to site-packages does not invalidate the query, + // since site-packages takes lower priority in the module resolution + db.clear_salsa_events(); + let site_packages_functools_path = site_packages.join("functools.py"); + db.write_file(&site_packages_functools_path, "f: int") + .unwrap(); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + let events = db.take_salsa_events(); + assert_function_query_was_not_run( + &db, + resolve_module_query, + ModuleNameIngredient::new(&db, functools_module_name), + &events, + ); + assert_eq!(functools_module.search_path().unwrap(), &stdlib); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, &stdlib_functools_path) + ); + } + + #[test] + fn adding_file_to_search_path_with_higher_priority_invalidates_the_query() { + const TYPESHED: MockedTypeshed = MockedTypeshed { + versions: "functools: 3.8-", + stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], + }; + + let TestCase { + mut db, + stdlib, + src, + .. + } = TestCaseBuilder::new() + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let functools_module_name = ModuleName::new_static("functools").unwrap(); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + assert_eq!(functools_module.search_path().unwrap(), &stdlib); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, stdlib.join("functools.pyi")) + ); + + // Adding a first-party file invalidates the query, + // since first-party files take higher priority in module resolution: + let src_functools_path = src.join("functools.py"); + db.write_file(&src_functools_path, "FOO: int").unwrap(); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + assert_eq!(functools_module.search_path().unwrap(), &src); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, &src_functools_path) + ); + } + + #[test] + fn deleting_file_from_higher_priority_search_path_invalidates_the_query() { + const SRC: &[FileSpec] = &[("functools.py", "FOO: int")]; + + const TYPESHED: MockedTypeshed = MockedTypeshed { + versions: "functools: 3.8-", + stdlib_files: &[("functools.pyi", "def update_wrapper(): ...")], + }; + + let TestCase { + mut db, + stdlib, + src, + .. + } = TestCaseBuilder::new() + .with_src_files(SRC) + .with_mocked_typeshed(TYPESHED) + .with_python_version(PythonVersion::PY38) + .build(); + + let functools_module_name = ModuleName::new_static("functools").unwrap(); + let src_functools_path = src.join("functools.py"); + + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + assert_eq!(functools_module.search_path().unwrap(), &src); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, &src_functools_path) + ); + + // If we now delete the first-party file, + // it should resolve to the stdlib: + db.memory_file_system() + .remove_file(&src_functools_path) + .unwrap(); + File::sync_path(&mut db, &src_functools_path); + let functools_module = resolve_module(&db, &functools_module_name).unwrap(); + assert_eq!(functools_module.search_path().unwrap(), &stdlib); + assert_eq!( + Ok(functools_module.file().unwrap()), + system_path_to_file(&db, stdlib.join("functools.pyi")) + ); + } + + #[test] + fn editable_install_absolute_path() { + const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; + let x_directory = [("/x/src/foo/__init__.py", ""), ("/x/src/foo/bar.py", "")]; + + let TestCase { mut db, .. } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(x_directory).unwrap(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_bar_module_name = ModuleName::new_static("foo.bar").unwrap(); + + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + let foo_bar_module = resolve_module(&db, &foo_bar_module_name).unwrap(); + + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::system("/x/src/foo/__init__.py") + ); + assert_eq!( + foo_bar_module.file().unwrap().path(&db), + &FilePath::system("/x/src/foo/bar.py") + ); + } + + #[test] + fn editable_install_pth_file_with_whitespace() { + const SITE_PACKAGES: &[FileSpec] = &[ + ("_foo.pth", " /x/src"), + ("_bar.pth", "/y/src "), + ]; + let external_files = [("/x/src/foo.py", ""), ("/y/src/bar.py", "")]; + + let TestCase { mut db, .. } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(external_files).unwrap(); + + // Lines with leading whitespace in `.pth` files do not parse: + let foo_module_name = ModuleName::new_static("foo").unwrap(); + assert_eq!(resolve_module(&db, &foo_module_name), None); + + // Lines with trailing whitespace in `.pth` files do: + let bar_module_name = ModuleName::new_static("bar").unwrap(); + let bar_module = resolve_module(&db, &bar_module_name).unwrap(); + assert_eq!( + bar_module.file().unwrap().path(&db), + &FilePath::system("/y/src/bar.py") + ); + } + + #[test] + fn editable_install_relative_path() { + const SITE_PACKAGES: &[FileSpec] = &[ + ("_foo.pth", "../../x/../x/y/src"), + ("../x/y/src/foo.pyi", ""), + ]; + + let TestCase { db, .. } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::system("/x/y/src/foo.pyi") + ); + } + + #[test] + fn editable_install_multiple_pth_files_with_multiple_paths() { + const COMPLEX_PTH_FILE: &str = "\ +/ + +# a comment +/baz + +import not_an_editable_install; do_something_else_crazy_dynamic() + +# another comment +spam + +not_a_directory +"; + + const SITE_PACKAGES: &[FileSpec] = &[ + ("_foo.pth", "../../x/../x/y/src"), + ("_lots_of_others.pth", COMPLEX_PTH_FILE), + ("../x/y/src/foo.pyi", ""), + ("spam/spam.py", ""), + ]; + + let root_files = [("/a.py", ""), ("/baz/b.py", "")]; + + let TestCase { + mut db, + site_packages, + .. + } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(root_files).unwrap(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let a_module_name = ModuleName::new_static("a").unwrap(); + let b_module_name = ModuleName::new_static("b").unwrap(); + let spam_module_name = ModuleName::new_static("spam").unwrap(); + + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + let a_module = resolve_module(&db, &a_module_name).unwrap(); + let b_module = resolve_module(&db, &b_module_name).unwrap(); + let spam_module = resolve_module(&db, &spam_module_name).unwrap(); + + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::system("/x/y/src/foo.pyi") + ); + assert_eq!( + a_module.file().unwrap().path(&db), + &FilePath::system("/a.py") + ); + assert_eq!( + b_module.file().unwrap().path(&db), + &FilePath::system("/baz/b.py") + ); + assert_eq!( + spam_module.file().unwrap().path(&db), + &FilePath::System(site_packages.join("spam/spam.py")) + ); + } + + #[test] + fn module_resolution_paths_cached_between_different_module_resolutions() { + const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src"), ("_bar.pth", "/y/src")]; + let external_directories = [("/x/src/foo.py", ""), ("/y/src/bar.py", "")]; + + let TestCase { mut db, .. } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(external_directories).unwrap(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let bar_module_name = ModuleName::new_static("bar").unwrap(); + + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::system("/x/src/foo.py") + ); + + db.clear_salsa_events(); + let bar_module = resolve_module(&db, &bar_module_name).unwrap(); + assert_eq!( + bar_module.file().unwrap().path(&db), + &FilePath::system("/y/src/bar.py") + ); + let events = db.take_salsa_events(); + assert_const_function_query_was_not_run(&db, dynamic_resolution_paths, &events); + } + + #[test] + fn deleting_pth_file_on_which_module_resolution_depends_invalidates_cache() { + const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; + let x_directory = [("/x/src/foo.py", "")]; + + let TestCase { + mut db, + site_packages, + .. + } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(x_directory).unwrap(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::system("/x/src/foo.py") + ); + + db.memory_file_system() + .remove_file(site_packages.join("_foo.pth")) + .unwrap(); + + File::sync_path(&mut db, &site_packages.join("_foo.pth")); + + assert_eq!(resolve_module(&db, &foo_module_name), None); + } + + #[test] + fn deleting_editable_install_on_which_module_resolution_depends_invalidates_cache() { + const SITE_PACKAGES: &[FileSpec] = &[("_foo.pth", "/x/src")]; + let x_directory = [("/x/src/foo.py", "")]; + + let TestCase { mut db, .. } = TestCaseBuilder::new() + .with_site_packages_files(SITE_PACKAGES) + .build(); + + db.write_files(x_directory).unwrap(); + + let foo_module_name = ModuleName::new_static("foo").unwrap(); + let foo_module = resolve_module(&db, &foo_module_name).unwrap(); + let src_path = SystemPathBuf::from("/x/src"); + assert_eq!( + foo_module.file().unwrap().path(&db), + &FilePath::System(src_path.join("foo.py")) + ); + + db.memory_file_system() + .remove_file(src_path.join("foo.py")) + .unwrap(); + db.memory_file_system().remove_directory(&src_path).unwrap(); + File::sync_path(&mut db, &src_path.join("foo.py")); + File::sync_path(&mut db, &src_path); + assert_eq!(resolve_module(&db, &foo_module_name), None); + } + + #[test] + fn no_duplicate_search_paths_added() { + let TestCase { db, .. } = TestCaseBuilder::new() + .with_src_files(&[("foo.py", "")]) + .with_site_packages_files(&[("_foo.pth", "/src")]) + .build(); + + let search_paths: Vec<&SearchPath> = search_paths(&db).collect(); + + assert!(search_paths.contains( + &&SearchPath::first_party(db.system(), SystemPathBuf::from("/src")).unwrap() + )); + assert!( + !search_paths.contains( + &&SearchPath::editable(db.system(), SystemPathBuf::from("/src")).unwrap() + ) + ); + } + + #[test] + fn multiple_site_packages_with_editables() { + let mut db = TestDb::new(); + + let venv_site_packages = SystemPathBuf::from("/venv-site-packages"); + let site_packages_pth = venv_site_packages.join("foo.pth"); + let system_site_packages = SystemPathBuf::from("/system-site-packages"); + let editable_install_location = SystemPathBuf::from("/x/y/a.py"); + let system_site_packages_location = system_site_packages.join("a.py"); + + db.memory_file_system() + .create_directory_all("/src") + .unwrap(); + db.write_files([ + (&site_packages_pth, "/x/y"), + (&editable_install_location, ""), + (&system_site_packages_location, ""), + ]) + .unwrap(); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![SystemPathBuf::from("/src")], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![ + venv_site_packages, + system_site_packages, + ]), + }, + }, + ) + .expect("Valid program settings"); + + // The editable installs discovered from the `.pth` file in the first `site-packages` directory + // take precedence over the second `site-packages` directory... + let a_module_name = ModuleName::new_static("a").unwrap(); + let a_module = resolve_module(&db, &a_module_name).unwrap(); + assert_eq!( + a_module.file().unwrap().path(&db), + &editable_install_location + ); + + db.memory_file_system() + .remove_file(&site_packages_pth) + .unwrap(); + File::sync_path(&mut db, &site_packages_pth); + + // ...But now that the `.pth` file in the first `site-packages` directory has been deleted, + // the editable install no longer exists, so the module now resolves to the file in the + // second `site-packages` directory + let a_module = resolve_module(&db, &a_module_name).unwrap(); + assert_eq!( + a_module.file().unwrap().path(&db), + &system_site_packages_location + ); + } + + #[test] + #[cfg(unix)] + fn case_sensitive_resolution_with_symlinked_directory() -> anyhow::Result<()> { + use anyhow::Context; + use ruff_db::system::OsSystem; + + let temp_dir = tempfile::TempDir::new()?; + let root = SystemPathBuf::from_path_buf( + temp_dir + .path() + .canonicalize() + .context("Failed to canonicalized path")?, + ) + .expect("UTF8 path for temp dir"); + + let mut db = TestDb::new(); + + let src = root.join("src"); + let a_package_target = root.join("a-package"); + let a_src = src.join("a"); + + db.use_system(OsSystem::new(&root)); + + db.write_file( + a_package_target.join("__init__.py"), + "class Foo: x: int = 4", + ) + .context("Failed to write `a-package/__init__.py`")?; + + db.write_file(src.join("main.py"), "print('Hy')") + .context("Failed to write `main.py`")?; + + // The symlink triggers the slow-path in the `OsSystem`'s `exists_path_case_sensitive` + // code because canonicalizing the path for `a/__init__.py` results in `a-package/__init__.py` + std::os::unix::fs::symlink(a_package_target.as_std_path(), a_src.as_std_path()) + .context("Failed to symlink `src/a` to `a-package`")?; + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![src], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![]), + }, + }, + ) + .expect("Valid program settings"); + + // Now try to resolve the module `A` (note the capital `A` instead of `a`). + let a_module_name = ModuleName::new_static("A").unwrap(); + assert_eq!(resolve_module(&db, &a_module_name), None); + + // Now lookup the same module using the lowercase `a` and it should resolve to the file in the system site-packages + let a_module_name = ModuleName::new_static("a").unwrap(); + let a_module = resolve_module(&db, &a_module_name).expect("a.py to resolve"); + assert!( + a_module + .file() + .unwrap() + .path(&db) + .as_str() + .ends_with("src/a/__init__.py"), + ); + + Ok(()) + } + + #[test] + fn file_to_module_where_one_search_path_is_subdirectory_of_other() { + let project_directory = SystemPathBuf::from("/project"); + let site_packages = project_directory.join(".venv/lib/python3.13/site-packages"); + let installed_foo_module = site_packages.join("foo/__init__.py"); + + let mut db = TestDb::new(); + db.write_file(&installed_foo_module, "").unwrap(); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings { + extra_paths: vec![], + src_roots: vec![project_directory], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![site_packages.clone()]), + }, + }, + ) + .unwrap(); + + let foo_module_file = File::new(&db, FilePath::System(installed_foo_module)); + let module = file_to_module(&db, foo_module_file).unwrap(); + assert_eq!(module.search_path().unwrap(), &site_packages); + } +} diff --git a/crates/red_knot_python_semantic/src/module_resolver/testing.rs b/crates/ty_python_semantic/src/module_resolver/testing.rs similarity index 78% rename from crates/red_knot_python_semantic/src/module_resolver/testing.rs rename to crates/ty_python_semantic/src/module_resolver/testing.rs index 0cf486ab6adbe..5f1e9c4b6e7ef 100644 --- a/crates/red_knot_python_semantic/src/module_resolver/testing.rs +++ b/crates/ty_python_semantic/src/module_resolver/testing.rs @@ -1,10 +1,14 @@ -use ruff_db::system::{DbWithTestSystem, SystemPath, SystemPathBuf}; +use ruff_db::system::{ + DbWithTestSystem as _, DbWithWritableSystem as _, SystemPath, SystemPathBuf, +}; use ruff_db::vendored::VendoredPathBuf; +use ruff_python_ast::PythonVersion; use crate::db::tests::TestDb; use crate::program::{Program, SearchPathSettings}; -use crate::python_version::PythonVersion; -use crate::{ProgramSettings, SitePackages}; +use crate::{ + ProgramSettings, PythonPath, PythonPlatform, PythonVersionSource, PythonVersionWithSource, +}; /// A test case for the module resolver. /// @@ -18,7 +22,7 @@ pub(crate) struct TestCase<T> { // so this is a single directory instead of a `Vec` of directories, // like it is in `ruff_db::Program`. pub(crate) site_packages: SystemPathBuf, - pub(crate) target_version: PythonVersion, + pub(crate) python_version: PythonVersion, } /// A `(file_name, file_contents)` tuple @@ -67,13 +71,13 @@ pub(crate) struct UnspecifiedTypeshed; /// ```rs /// let test_case = TestCaseBuilder::new() /// .with_src_files(...) -/// .with_target_version(...) +/// .with_python_version(...) /// .build(); /// ``` /// /// For tests checking that standard-library module resolution is working /// correctly, you should usually create a [`MockedTypeshed`] instance -/// and pass it to the [`TestCaseBuilder::with_custom_typeshed`] method. +/// and pass it to the [`TestCaseBuilder::with_mocked_typeshed`] method. /// If you need to check something that involves the vendored typeshed stubs /// we include as part of the binary, you can instead use the /// [`TestCaseBuilder::with_vendored_typeshed`] method. @@ -85,13 +89,13 @@ pub(crate) struct UnspecifiedTypeshed; /// const TYPESHED = MockedTypeshed { ... }; /// /// let test_case = resolver_test_case() -/// .with_custom_typeshed(TYPESHED) -/// .with_target_version(...) +/// .with_mocked_typeshed(TYPESHED) +/// .with_python_version(...) /// .build(); /// /// let test_case2 = resolver_test_case() /// .with_vendored_typeshed() -/// .with_target_version(...) +/// .with_python_version(...) /// .build(); /// ``` /// @@ -100,7 +104,8 @@ pub(crate) struct UnspecifiedTypeshed; /// to `()`. pub(crate) struct TestCaseBuilder<T> { typeshed_option: T, - target_version: PythonVersion, + python_version: PythonVersion, + python_platform: PythonPlatform, first_party_files: Vec<FileSpec>, site_packages_files: Vec<FileSpec>, } @@ -118,9 +123,9 @@ impl<T> TestCaseBuilder<T> { self } - /// Specify the target Python version the module resolver should assume - pub(crate) fn with_target_version(mut self, target_version: PythonVersion) -> Self { - self.target_version = target_version; + /// Specify the Python version the module resolver should assume + pub(crate) fn with_python_version(mut self, python_version: PythonVersion) -> Self { + self.python_version = python_version; self } @@ -146,7 +151,8 @@ impl TestCaseBuilder<UnspecifiedTypeshed> { pub(crate) fn new() -> TestCaseBuilder<UnspecifiedTypeshed> { Self { typeshed_option: UnspecifiedTypeshed, - target_version: PythonVersion::default(), + python_version: PythonVersion::default(), + python_platform: PythonPlatform::default(), first_party_files: vec![], site_packages_files: vec![], } @@ -156,33 +162,37 @@ impl TestCaseBuilder<UnspecifiedTypeshed> { pub(crate) fn with_vendored_typeshed(self) -> TestCaseBuilder<VendoredTypeshed> { let TestCaseBuilder { typeshed_option: _, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } = self; TestCaseBuilder { typeshed_option: VendoredTypeshed, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } } /// Use a mock typeshed directory for this test case - pub(crate) fn with_custom_typeshed( + pub(crate) fn with_mocked_typeshed( self, typeshed: MockedTypeshed, ) -> TestCaseBuilder<MockedTypeshed> { let TestCaseBuilder { typeshed_option: _, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } = self; TestCaseBuilder { typeshed_option: typeshed, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } @@ -194,15 +204,15 @@ impl TestCaseBuilder<UnspecifiedTypeshed> { src, stdlib: _, site_packages, - target_version, - } = self.with_custom_typeshed(MockedTypeshed::default()).build(); + python_version, + } = self.with_mocked_typeshed(MockedTypeshed::default()).build(); TestCase { db, src, stdlib: (), site_packages, - target_version, + python_version, } } } @@ -211,7 +221,8 @@ impl TestCaseBuilder<MockedTypeshed> { pub(crate) fn build(self) -> TestCase<SystemPathBuf> { let TestCaseBuilder { typeshed_option, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } = self; @@ -225,13 +236,17 @@ impl TestCaseBuilder<MockedTypeshed> { Program::from_settings( &db, - &ProgramSettings { - target_version, + ProgramSettings { + python_version: PythonVersionWithSource { + version: python_version, + source: PythonVersionSource::default(), + }, + python_platform, search_paths: SearchPathSettings { extra_paths: vec![], - src_root: src.clone(), + src_roots: vec![src.clone()], custom_typeshed: Some(typeshed.clone()), - site_packages: SitePackages::Known(vec![site_packages.clone()]), + python_path: PythonPath::KnownSitePackages(vec![site_packages.clone()]), }, }, ) @@ -242,7 +257,7 @@ impl TestCaseBuilder<MockedTypeshed> { src, stdlib: typeshed.join("stdlib"), site_packages, - target_version, + python_version, } } @@ -268,7 +283,8 @@ impl TestCaseBuilder<VendoredTypeshed> { pub(crate) fn build(self) -> TestCase<VendoredPathBuf> { let TestCaseBuilder { typeshed_option: VendoredTypeshed, - target_version, + python_version, + python_platform, first_party_files, site_packages_files, } = self; @@ -281,11 +297,15 @@ impl TestCaseBuilder<VendoredTypeshed> { Program::from_settings( &db, - &ProgramSettings { - target_version, + ProgramSettings { + python_version: PythonVersionWithSource { + version: python_version, + source: PythonVersionSource::default(), + }, + python_platform, search_paths: SearchPathSettings { - site_packages: SitePackages::Known(vec![site_packages.clone()]), - ..SearchPathSettings::new(src.clone()) + python_path: PythonPath::KnownSitePackages(vec![site_packages.clone()]), + ..SearchPathSettings::new(vec![src.clone()]) }, }, ) @@ -296,7 +316,7 @@ impl TestCaseBuilder<VendoredTypeshed> { src, stdlib: VendoredPathBuf::from("stdlib"), site_packages, - target_version, + python_version, } } } diff --git a/crates/red_knot_python_semantic/src/module_resolver/typeshed.rs b/crates/ty_python_semantic/src/module_resolver/typeshed.rs similarity index 94% rename from crates/red_knot_python_semantic/src/module_resolver/typeshed.rs rename to crates/ty_python_semantic/src/module_resolver/typeshed.rs index 2e94c95ce32f6..b1dcff7d06ad1 100644 --- a/crates/red_knot_python_semantic/src/module_resolver/typeshed.rs +++ b/crates/ty_python_semantic/src/module_resolver/typeshed.rs @@ -4,11 +4,12 @@ use std::num::{NonZeroU16, NonZeroUsize}; use std::ops::{RangeFrom, RangeInclusive}; use std::str::FromStr; +use ruff_python_ast::PythonVersion; use rustc_hash::FxHashMap; +use crate::Program; use crate::db::Db; use crate::module_name::ModuleName; -use crate::{Program, PythonVersion}; pub(in crate::module_resolver) fn vendored_typeshed_versions(db: &dyn Db) -> TypeshedVersions { TypeshedVersions::from_str( @@ -112,10 +113,10 @@ impl TypeshedVersions { pub(in crate::module_resolver) fn query_module( &self, module: &ModuleName, - target_version: PythonVersion, + python_version: PythonVersion, ) -> TypeshedVersionsQueryResult { if let Some(range) = self.exact(module) { - if range.contains(target_version) { + if range.contains(python_version) { TypeshedVersionsQueryResult::Exists } else { TypeshedVersionsQueryResult::DoesNotExist @@ -125,7 +126,7 @@ impl TypeshedVersions { while let Some(module_to_try) = module { if let Some(range) = self.exact(&module_to_try) { return { - if range.contains(target_version) { + if range.contains(python_version) { TypeshedVersionsQueryResult::MaybeExists } else { TypeshedVersionsQueryResult::DoesNotExist @@ -236,7 +237,7 @@ impl FromStr for TypeshedVersions { return Err(TypeshedVersionsParseError { line_number: Some(line_number), reason, - }) + }); } }; } @@ -278,12 +279,12 @@ impl FromStr for PyVersionRange { let mut parts = s.split('-').map(str::trim); match (parts.next(), parts.next(), parts.next()) { (Some(lower), Some(""), None) => { - let lower = PythonVersion::from_versions_file_string(lower)?; + let lower = python_version_from_versions_file_string(lower)?; Ok(Self::AvailableFrom(lower..)) } (Some(lower), Some(upper), None) => { - let lower = PythonVersion::from_versions_file_string(lower)?; - let upper = PythonVersion::from_versions_file_string(upper)?; + let lower = python_version_from_versions_file_string(lower)?; + let upper = python_version_from_versions_file_string(upper)?; Ok(Self::AvailableWithin(lower..=upper)) } _ => Err(TypeshedVersionsParseErrorKind::UnexpectedNumberOfHyphens), @@ -302,25 +303,26 @@ impl fmt::Display for PyVersionRange { } } -impl PythonVersion { - fn from_versions_file_string(s: &str) -> Result<Self, TypeshedVersionsParseErrorKind> { - let mut parts = s.split('.').map(str::trim); - let (Some(major), Some(minor), None) = (parts.next(), parts.next(), parts.next()) else { - return Err(TypeshedVersionsParseErrorKind::UnexpectedNumberOfPeriods( - s.to_string(), - )); - }; - PythonVersion::try_from((major, minor)).map_err(|int_parse_error| { - TypeshedVersionsParseErrorKind::IntegerParsingFailure { - version: s.to_string(), - err: int_parse_error, - } - }) - } +fn python_version_from_versions_file_string( + s: &str, +) -> Result<PythonVersion, TypeshedVersionsParseErrorKind> { + let mut parts = s.split('.').map(str::trim); + let (Some(major), Some(minor), None) = (parts.next(), parts.next(), parts.next()) else { + return Err(TypeshedVersionsParseErrorKind::UnexpectedNumberOfPeriods( + s.to_string(), + )); + }; + PythonVersion::try_from((major, minor)).map_err(|int_parse_error| { + TypeshedVersionsParseErrorKind::IntegerParsingFailure { + version: s.to_string(), + err: int_parse_error, + } + }) } #[cfg(test)] mod tests { + use std::fmt::Write as _; use std::num::{IntErrorKind, NonZeroU16}; use std::path::Path; @@ -332,8 +334,7 @@ mod tests { const TYPESHED_STDLIB_DIR: &str = "stdlib"; - #[allow(unsafe_code)] - const ONE: Option<NonZeroU16> = Some(unsafe { NonZeroU16::new_unchecked(1) }); + const ONE: Option<NonZeroU16> = Some(NonZeroU16::new(1).unwrap()); impl TypeshedVersions { #[must_use] @@ -391,7 +392,7 @@ mod tests { let db = TestDb::new(); let vendored_typeshed_versions = vendored_typeshed_versions(&db); let vendored_typeshed_dir = - Path::new(env!("CARGO_MANIFEST_DIR")).join("../red_knot_vendored/vendor/typeshed"); + Path::new(env!("CARGO_MANIFEST_DIR")).join("../ty_vendored/vendor/typeshed"); let mut empty_iterator = true; @@ -459,11 +460,11 @@ foo: 3.8- # trailing comment "; let parsed_versions = TypeshedVersions::from_str(VERSIONS).unwrap(); assert_eq!(parsed_versions.len(), 3); - assert_snapshot!(parsed_versions.to_string(), @r###" + assert_snapshot!(parsed_versions.to_string(), @r" bar: 2.7-3.10 bar.baz: 3.1-3.9 foo: 3.8- - "### + " ); } @@ -570,7 +571,7 @@ foo: 3.8- # trailing comment let mut massive_versions_file = String::new(); for i in 0..too_many { - massive_versions_file.push_str(&format!("x{i}: 3.8-\n")); + let _ = writeln!(&mut massive_versions_file, "x{i}: 3.8-"); } assert_eq!( diff --git a/crates/ty_python_semantic/src/node_key.rs b/crates/ty_python_semantic/src/node_key.rs new file mode 100644 index 0000000000000..4c2ade0b7e1ef --- /dev/null +++ b/crates/ty_python_semantic/src/node_key.rs @@ -0,0 +1,21 @@ +use ruff_python_ast::AnyNodeRef; + +/// Compact key for a node for use in a hash map. +/// +/// Stores the memory address of the node, because using the range and the kind +/// of the node is not enough to uniquely identify them in ASTs resulting from +/// invalid syntax. For example, parsing the input `for` results in a `StmtFor` +/// AST node where both the `target` and the `iter` field are `ExprName` nodes +/// with the same (empty) range `3..3`. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub(super) struct NodeKey(usize); + +impl NodeKey { + pub(super) fn from_node<'a, N>(node: N) -> Self + where + N: Into<AnyNodeRef<'a>>, + { + let node = node.into(); + NodeKey(node.as_ptr().as_ptr() as usize) + } +} diff --git a/crates/ty_python_semantic/src/program.rs b/crates/ty_python_semantic/src/program.rs new file mode 100644 index 0000000000000..74e662e355f8e --- /dev/null +++ b/crates/ty_python_semantic/src/program.rs @@ -0,0 +1,208 @@ +use std::sync::Arc; + +use crate::Db; +use crate::module_resolver::SearchPaths; +use crate::python_platform::PythonPlatform; +use crate::site_packages::SysPrefixPathOrigin; + +use anyhow::Context; +use ruff_db::system::{SystemPath, SystemPathBuf}; +use ruff_python_ast::PythonVersion; +use ruff_text_size::TextRange; +use salsa::Durability; +use salsa::Setter; + +#[salsa::input(singleton)] +pub struct Program { + #[returns(ref)] + pub python_version_with_source: PythonVersionWithSource, + + #[returns(ref)] + pub python_platform: PythonPlatform, + + #[returns(ref)] + pub(crate) search_paths: SearchPaths, +} + +impl Program { + pub fn from_settings(db: &dyn Db, settings: ProgramSettings) -> anyhow::Result<Self> { + let ProgramSettings { + python_version: python_version_with_source, + python_platform, + search_paths, + } = settings; + + tracing::info!( + "Python version: Python {python_version}, platform: {python_platform}", + python_version = python_version_with_source.version + ); + + let search_paths = SearchPaths::from_settings(db, &search_paths) + .with_context(|| "Invalid search path settings")?; + + Ok( + Program::builder(python_version_with_source, python_platform, search_paths) + .durability(Durability::HIGH) + .new(db), + ) + } + + pub fn python_version(self, db: &dyn Db) -> PythonVersion { + self.python_version_with_source(db).version + } + + pub fn update_from_settings( + self, + db: &mut dyn Db, + settings: ProgramSettings, + ) -> anyhow::Result<()> { + let ProgramSettings { + python_version, + python_platform, + search_paths, + } = settings; + + if &python_platform != self.python_platform(db) { + tracing::debug!("Updating python platform: `{python_platform:?}`"); + self.set_python_platform(db).to(python_platform); + } + + if &python_version != self.python_version_with_source(db) { + tracing::debug!("Updating python version: `{python_version:?}`"); + self.set_python_version_with_source(db).to(python_version); + } + + self.update_search_paths(db, &search_paths)?; + + Ok(()) + } + + pub fn update_search_paths( + self, + db: &mut dyn Db, + search_path_settings: &SearchPathSettings, + ) -> anyhow::Result<()> { + let search_paths = SearchPaths::from_settings(db, search_path_settings)?; + + if self.search_paths(db) != &search_paths { + tracing::debug!("Update search paths"); + self.set_search_paths(db).to(search_paths); + } + + Ok(()) + } + + pub fn custom_stdlib_search_path(self, db: &dyn Db) -> Option<&SystemPath> { + self.search_paths(db).custom_stdlib() + } +} + +#[derive(Clone, Debug, Eq, PartialEq)] +pub struct ProgramSettings { + pub python_version: PythonVersionWithSource, + pub python_platform: PythonPlatform, + pub search_paths: SearchPathSettings, +} + +#[derive(Clone, Debug, Eq, PartialEq, Default)] +pub enum PythonVersionSource { + /// Value loaded from a project's configuration file. + File(Arc<SystemPathBuf>, Option<TextRange>), + + /// The value comes from a CLI argument, while it's left open if specified using a short argument, + /// long argument (`--extra-paths`) or `--config key=value`. + Cli, + + /// We fell back to a default value because the value was not specified via the CLI or a config file. + #[default] + Default, +} + +#[derive(Eq, PartialEq, Debug, Clone)] +pub struct PythonVersionWithSource { + pub version: PythonVersion, + pub source: PythonVersionSource, +} + +impl Default for PythonVersionWithSource { + fn default() -> Self { + Self { + version: PythonVersion::latest_ty(), + source: PythonVersionSource::Default, + } + } +} + +/// Configures the search paths for module resolution. +#[derive(Eq, PartialEq, Debug, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize))] +pub struct SearchPathSettings { + /// List of user-provided paths that should take first priority in the module resolution. + /// Examples in other type checkers are mypy's MYPYPATH environment variable, + /// or pyright's stubPath configuration setting. + pub extra_paths: Vec<SystemPathBuf>, + + /// The root of the project, used for finding first-party modules. + pub src_roots: Vec<SystemPathBuf>, + + /// Optional path to a "custom typeshed" directory on disk for us to use for standard-library types. + /// If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib, + /// bundled as a zip file in the binary + pub custom_typeshed: Option<SystemPathBuf>, + + /// Path to the Python installation from which ty resolves third party dependencies + /// and their type information. + pub python_path: PythonPath, +} + +impl SearchPathSettings { + pub fn new(src_roots: Vec<SystemPathBuf>) -> Self { + Self { + src_roots, + extra_paths: vec![], + custom_typeshed: None, + python_path: PythonPath::KnownSitePackages(vec![]), + } + } +} + +#[derive(Debug, Clone, Eq, PartialEq)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +pub enum PythonPath { + /// A path that represents the value of [`sys.prefix`] at runtime in Python + /// for a given Python executable. + /// + /// For the case of a virtual environment, where a + /// Python binary is at `/.venv/bin/python`, `sys.prefix` is the path to + /// the virtual environment the Python binary lies inside, i.e. `/.venv`, + /// and `site-packages` will be at `.venv/lib/python3.X/site-packages`. + /// System Python installations generally work the same way: if a system + /// Python installation lies at `/opt/homebrew/bin/python`, `sys.prefix` + /// will be `/opt/homebrew`, and `site-packages` will be at + /// `/opt/homebrew/lib/python3.X/site-packages`. + /// + /// [`sys.prefix`]: https://docs.python.org/3/library/sys.html#sys.prefix + SysPrefix(SystemPathBuf, SysPrefixPathOrigin), + + /// Resolve a path to an executable (or environment directory) into a usable environment. + Resolve(SystemPathBuf, SysPrefixPathOrigin), + + /// Tries to discover a virtual environment in the given path. + Discover(SystemPathBuf), + + /// Resolved site packages paths. + /// + /// This variant is mainly intended for testing where we want to skip resolving `site-packages` + /// because it would unnecessarily complicate the test setup. + KnownSitePackages(Vec<SystemPathBuf>), +} + +impl PythonPath { + pub fn from_virtual_env_var(path: impl Into<SystemPathBuf>) -> Self { + Self::SysPrefix(path.into(), SysPrefixPathOrigin::VirtualEnvVar) + } + + pub fn from_cli_flag(path: SystemPathBuf) -> Self { + Self::Resolve(path, SysPrefixPathOrigin::PythonCliFlag) + } +} diff --git a/crates/ty_python_semantic/src/python_platform.rs b/crates/ty_python_semantic/src/python_platform.rs new file mode 100644 index 0000000000000..587f7779737a0 --- /dev/null +++ b/crates/ty_python_semantic/src/python_platform.rs @@ -0,0 +1,129 @@ +use std::fmt::{Display, Formatter}; + +/// The target platform to assume when resolving types. +#[derive(Debug, Clone, PartialEq, Eq)] +#[cfg_attr( + feature = "serde", + derive(serde::Serialize, serde::Deserialize), + serde(rename_all = "kebab-case") +)] +pub enum PythonPlatform { + /// Do not make any assumptions about the target platform. + All, + + /// Assume a specific target platform like `linux`, `darwin` or `win32`. + /// + /// We use a string (instead of individual enum variants), as the set of possible platforms + /// may change over time. See <https://docs.python.org/3/library/sys.html#sys.platform> for + /// some known platform identifiers. + #[cfg_attr(feature = "serde", serde(untagged))] + Identifier(String), +} + +impl From<String> for PythonPlatform { + fn from(platform: String) -> Self { + match platform.as_str() { + "all" => PythonPlatform::All, + _ => PythonPlatform::Identifier(platform.to_string()), + } + } +} + +impl Display for PythonPlatform { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + PythonPlatform::All => f.write_str("all"), + PythonPlatform::Identifier(name) => f.write_str(name), + } + } +} + +impl Default for PythonPlatform { + fn default() -> Self { + if cfg!(target_os = "windows") { + PythonPlatform::Identifier("win32".to_string()) + } else if cfg!(target_os = "macos") { + PythonPlatform::Identifier("darwin".to_string()) + } else if cfg!(target_os = "android") { + PythonPlatform::Identifier("android".to_string()) + } else if cfg!(target_os = "ios") { + PythonPlatform::Identifier("ios".to_string()) + } else { + PythonPlatform::Identifier("linux".to_string()) + } + } +} + +#[cfg(feature = "schemars")] +mod schema { + use crate::PythonPlatform; + use schemars::_serde_json::Value; + use schemars::JsonSchema; + use schemars::r#gen::SchemaGenerator; + use schemars::schema::{Metadata, Schema, SchemaObject, SubschemaValidation}; + + impl JsonSchema for PythonPlatform { + fn schema_name() -> String { + "PythonPlatform".to_string() + } + + fn json_schema(_gen: &mut SchemaGenerator) -> Schema { + Schema::Object(SchemaObject { + // Hard code some well known values, but allow any other string as well. + subschemas: Some(Box::new(SubschemaValidation { + any_of: Some(vec![ + Schema::Object(SchemaObject { + instance_type: Some(schemars::schema::InstanceType::String.into()), + ..SchemaObject::default() + }), + // Promote well-known values for better auto-completion. + // Using `const` over `enumValues` as recommended [here](https://github.com/SchemaStore/schemastore/blob/master/CONTRIBUTING.md#documenting-enums). + Schema::Object(SchemaObject { + const_value: Some(Value::String("all".to_string())), + metadata: Some(Box::new(Metadata { + description: Some( + "Do not make any assumptions about the target platform." + .to_string(), + ), + ..Metadata::default() + })), + + ..SchemaObject::default() + }), + Schema::Object(SchemaObject { + const_value: Some(Value::String("darwin".to_string())), + metadata: Some(Box::new(Metadata { + description: Some("Darwin".to_string()), + ..Metadata::default() + })), + + ..SchemaObject::default() + }), + Schema::Object(SchemaObject { + const_value: Some(Value::String("linux".to_string())), + metadata: Some(Box::new(Metadata { + description: Some("Linux".to_string()), + ..Metadata::default() + })), + + ..SchemaObject::default() + }), + Schema::Object(SchemaObject { + const_value: Some(Value::String("win32".to_string())), + metadata: Some(Box::new(Metadata { + description: Some("Windows".to_string()), + ..Metadata::default() + })), + + ..SchemaObject::default() + }), + ]), + + ..SubschemaValidation::default() + })), + + ..SchemaObject::default() + }) + } + } +} diff --git a/crates/ty_python_semantic/src/semantic_index.rs b/crates/ty_python_semantic/src/semantic_index.rs new file mode 100644 index 0000000000000..7f23fab1632db --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index.rs @@ -0,0 +1,1463 @@ +use std::iter::FusedIterator; +use std::sync::Arc; + +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_index::{IndexSlice, IndexVec}; + +use ruff_python_parser::semantic_errors::SemanticSyntaxError; +use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet}; +use salsa::Update; +use salsa::plumbing::AsId; + +use crate::Db; +use crate::module_name::ModuleName; +use crate::node_key::NodeKey; +use crate::semantic_index::ast_ids::AstIds; +use crate::semantic_index::ast_ids::node_key::ExpressionNodeKey; +use crate::semantic_index::builder::SemanticIndexBuilder; +use crate::semantic_index::definition::{Definition, DefinitionNodeKey, Definitions}; +use crate::semantic_index::expression::Expression; +use crate::semantic_index::narrowing_constraints::ScopedNarrowingConstraint; +use crate::semantic_index::symbol::{ + FileScopeId, NodeWithScopeKey, NodeWithScopeRef, Scope, ScopeId, ScopeKind, ScopedSymbolId, + SymbolTable, +}; +use crate::semantic_index::use_def::{EagerSnapshotKey, ScopedEagerSnapshotId, UseDefMap}; + +pub mod ast_ids; +mod builder; +pub mod definition; +pub mod expression; +pub(crate) mod narrowing_constraints; +pub(crate) mod predicate; +mod re_exports; +pub mod symbol; +mod use_def; +mod visibility_constraints; + +pub(crate) use self::use_def::{ + BindingWithConstraints, BindingWithConstraintsIterator, DeclarationWithConstraint, + DeclarationsIterator, +}; + +type SymbolMap = hashbrown::HashMap<ScopedSymbolId, (), FxBuildHasher>; + +/// Returns the semantic index for `file`. +/// +/// Prefer using [`symbol_table`] when working with symbols from a single scope. +#[salsa::tracked(returns(ref), no_eq)] +pub(crate) fn semantic_index(db: &dyn Db, file: File) -> SemanticIndex<'_> { + let _span = tracing::trace_span!("semantic_index", ?file).entered(); + + let parsed = parsed_module(db.upcast(), file); + + SemanticIndexBuilder::new(db, file, parsed).build() +} + +/// Returns the symbol table for a specific `scope`. +/// +/// Using [`symbol_table`] over [`semantic_index`] has the advantage that +/// Salsa can avoid invalidating dependent queries if this scope's symbol table +/// is unchanged. +#[salsa::tracked(returns(deref))] +pub(crate) fn symbol_table<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> Arc<SymbolTable> { + let file = scope.file(db); + let _span = tracing::trace_span!("symbol_table", scope=?scope.as_id(), ?file).entered(); + let index = semantic_index(db, file); + + index.symbol_table(scope.file_scope_id(db)) +} + +/// Returns the set of modules that are imported anywhere in `file`. +/// +/// This set only considers `import` statements, not `from...import` statements, because: +/// +/// - In `from foo import bar`, we cannot determine whether `foo.bar` is a submodule (and is +/// therefore imported) without looking outside the content of this file. (We could turn this +/// into a _potentially_ imported modules set, but that would change how it's used in our type +/// inference logic.) +/// +/// - We cannot resolve relative imports (which aren't allowed in `import` statements) without +/// knowing the name of the current module, and whether it's a package. +#[salsa::tracked(returns(deref))] +pub(crate) fn imported_modules<'db>(db: &'db dyn Db, file: File) -> Arc<FxHashSet<ModuleName>> { + semantic_index(db, file).imported_modules.clone() +} + +/// Returns the use-def map for a specific `scope`. +/// +/// Using [`use_def_map`] over [`semantic_index`] has the advantage that +/// Salsa can avoid invalidating dependent queries if this scope's use-def map +/// is unchanged. +#[salsa::tracked(returns(deref))] +pub(crate) fn use_def_map<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> Arc<UseDefMap<'db>> { + let file = scope.file(db); + let _span = tracing::trace_span!("use_def_map", scope=?scope.as_id(), ?file).entered(); + let index = semantic_index(db, file); + + index.use_def_map(scope.file_scope_id(db)) +} + +/// Returns all attribute assignments (and their method scope IDs) for a specific class body scope. +/// Only call this when doing type inference on the same file as `class_body_scope`, otherwise it +/// introduces a direct dependency on that file's AST. +pub(crate) fn attribute_assignments<'db, 's>( + db: &'db dyn Db, + class_body_scope: ScopeId<'db>, + name: &'s str, +) -> impl Iterator<Item = (BindingWithConstraintsIterator<'db, 'db>, FileScopeId)> + use<'s, 'db> { + let file = class_body_scope.file(db); + let index = semantic_index(db, file); + let class_scope_id = class_body_scope.file_scope_id(db); + + ChildrenIter::new(index, class_scope_id).filter_map(|(child_scope_id, scope)| { + let (function_scope_id, function_scope) = + if scope.node().scope_kind() == ScopeKind::Annotation { + // This could be a generic method with a type-params scope. + // Go one level deeper to find the function scope. The first + // descendant is the (potential) function scope. + let function_scope_id = scope.descendants().start; + (function_scope_id, index.scope(function_scope_id)) + } else { + (child_scope_id, scope) + }; + + function_scope.node().as_function()?; + let attribute_table = index.instance_attribute_table(function_scope_id); + let symbol = attribute_table.symbol_id_by_name(name)?; + let use_def = &index.use_def_maps[function_scope_id]; + Some(( + use_def.instance_attribute_bindings(symbol), + function_scope_id, + )) + }) +} + +/// Returns the module global scope of `file`. +#[salsa::tracked] +pub(crate) fn global_scope(db: &dyn Db, file: File) -> ScopeId<'_> { + let _span = tracing::trace_span!("global_scope", ?file).entered(); + + FileScopeId::global().to_scope_id(db, file) +} + +pub(crate) enum EagerSnapshotResult<'map, 'db> { + FoundConstraint(ScopedNarrowingConstraint), + FoundBindings(BindingWithConstraintsIterator<'map, 'db>), + NotFound, + NoLongerInEagerContext, +} + +/// The symbol tables and use-def maps for all scopes in a file. +#[derive(Debug, Update)] +pub(crate) struct SemanticIndex<'db> { + /// List of all symbol tables in this file, indexed by scope. + symbol_tables: IndexVec<FileScopeId, Arc<SymbolTable>>, + + /// List of all instance attribute tables in this file, indexed by scope. + instance_attribute_tables: IndexVec<FileScopeId, SymbolTable>, + + /// List of all scopes in this file. + scopes: IndexVec<FileScopeId, Scope>, + + /// Map expressions to their corresponding scope. + scopes_by_expression: FxHashMap<ExpressionNodeKey, FileScopeId>, + + /// Map from a node creating a definition to its definition. + definitions_by_node: FxHashMap<DefinitionNodeKey, Definitions<'db>>, + + /// Map from a standalone expression to its [`Expression`] ingredient. + expressions_by_node: FxHashMap<ExpressionNodeKey, Expression<'db>>, + + /// Map from nodes that create a scope to the scope they create. + scopes_by_node: FxHashMap<NodeWithScopeKey, FileScopeId>, + + /// Map from the file-local [`FileScopeId`] to the salsa-ingredient [`ScopeId`]. + scope_ids_by_scope: IndexVec<FileScopeId, ScopeId<'db>>, + + /// Map from the file-local [`FileScopeId`] to the set of explicit-global symbols it contains. + globals_by_scope: FxHashMap<FileScopeId, FxHashSet<ScopedSymbolId>>, + + /// Use-def map for each scope in this file. + use_def_maps: IndexVec<FileScopeId, Arc<UseDefMap<'db>>>, + + /// Lookup table to map between node ids and ast nodes. + /// + /// Note: We should not depend on this map when analysing other files or + /// changing a file invalidates all dependents. + ast_ids: IndexVec<FileScopeId, AstIds>, + + /// The set of modules that are imported anywhere within this file. + imported_modules: Arc<FxHashSet<ModuleName>>, + + /// Flags about the global scope (code usage impacting inference) + has_future_annotations: bool, + + /// Map of all of the eager snapshots that appear in this file. + eager_snapshots: FxHashMap<EagerSnapshotKey, ScopedEagerSnapshotId>, + + /// List of all semantic syntax errors in this file. + semantic_syntax_errors: Vec<SemanticSyntaxError>, + + /// Set of all generator functions in this file. + generator_functions: FxHashSet<FileScopeId>, +} + +impl<'db> SemanticIndex<'db> { + /// Returns the symbol table for a specific scope. + /// + /// Use the Salsa cached [`symbol_table()`] query if you only need the + /// symbol table for a single scope. + #[track_caller] + pub(super) fn symbol_table(&self, scope_id: FileScopeId) -> Arc<SymbolTable> { + self.symbol_tables[scope_id].clone() + } + + pub(super) fn instance_attribute_table(&self, scope_id: FileScopeId) -> &SymbolTable { + &self.instance_attribute_tables[scope_id] + } + + /// Returns the use-def map for a specific scope. + /// + /// Use the Salsa cached [`use_def_map()`] query if you only need the + /// use-def map for a single scope. + #[track_caller] + pub(super) fn use_def_map(&self, scope_id: FileScopeId) -> Arc<UseDefMap> { + self.use_def_maps[scope_id].clone() + } + + #[track_caller] + pub(crate) fn ast_ids(&self, scope_id: FileScopeId) -> &AstIds { + &self.ast_ids[scope_id] + } + + /// Returns the ID of the `expression`'s enclosing scope. + #[track_caller] + pub(crate) fn expression_scope_id( + &self, + expression: impl Into<ExpressionNodeKey>, + ) -> FileScopeId { + self.scopes_by_expression[&expression.into()] + } + + /// Returns the [`Scope`] of the `expression`'s enclosing scope. + #[allow(unused)] + #[track_caller] + pub(crate) fn expression_scope(&self, expression: impl Into<ExpressionNodeKey>) -> &Scope { + &self.scopes[self.expression_scope_id(expression)] + } + + /// Returns the [`Scope`] with the given id. + #[track_caller] + pub(crate) fn scope(&self, id: FileScopeId) -> &Scope { + &self.scopes[id] + } + + pub(crate) fn scope_ids(&self) -> impl Iterator<Item = ScopeId> { + self.scope_ids_by_scope.iter().copied() + } + + pub(crate) fn symbol_is_global_in_scope( + &self, + symbol: ScopedSymbolId, + scope: FileScopeId, + ) -> bool { + self.globals_by_scope + .get(&scope) + .is_some_and(|globals| globals.contains(&symbol)) + } + + /// Returns the id of the parent scope. + pub(crate) fn parent_scope_id(&self, scope_id: FileScopeId) -> Option<FileScopeId> { + let scope = self.scope(scope_id); + scope.parent() + } + + /// Returns the parent scope of `scope_id`. + #[expect(unused)] + #[track_caller] + pub(crate) fn parent_scope(&self, scope_id: FileScopeId) -> Option<&Scope> { + Some(&self.scopes[self.parent_scope_id(scope_id)?]) + } + + fn is_scope_reachable(&self, db: &'db dyn Db, scope_id: FileScopeId) -> bool { + self.parent_scope_id(scope_id) + .is_none_or(|parent_scope_id| { + if !self.is_scope_reachable(db, parent_scope_id) { + return false; + } + + let parent_use_def = self.use_def_map(parent_scope_id); + let reachability = self.scope(scope_id).reachability(); + + parent_use_def.is_reachable(db, reachability) + }) + } + + /// Returns true if a given AST node is reachable from the start of the scope. For example, + /// in the following code, expression `2` is reachable, but expressions `1` and `3` are not: + /// ```py + /// def f(): + /// x = 1 + /// if False: + /// x # 1 + /// x # 2 + /// return + /// x # 3 + /// ``` + pub(crate) fn is_node_reachable( + &self, + db: &'db dyn crate::Db, + scope_id: FileScopeId, + node_key: NodeKey, + ) -> bool { + self.is_scope_reachable(db, scope_id) + && self.use_def_map(scope_id).is_node_reachable(db, node_key) + } + + /// Returns an iterator over the descendent scopes of `scope`. + #[allow(unused)] + pub(crate) fn descendent_scopes(&self, scope: FileScopeId) -> DescendantsIter { + DescendantsIter::new(self, scope) + } + + /// Returns an iterator over the direct child scopes of `scope`. + #[allow(unused)] + pub(crate) fn child_scopes(&self, scope: FileScopeId) -> ChildrenIter { + ChildrenIter::new(self, scope) + } + + /// Returns an iterator over all ancestors of `scope`, starting with `scope` itself. + pub(crate) fn ancestor_scopes(&self, scope: FileScopeId) -> AncestorsIter { + AncestorsIter::new(self, scope) + } + + /// Returns the [`definition::Definition`] salsa ingredient(s) for `definition_key`. + /// + /// There will only ever be >1 `Definition` associated with a `definition_key` + /// if the definition is created by a wildcard (`*`) import. + #[track_caller] + pub(crate) fn definitions( + &self, + definition_key: impl Into<DefinitionNodeKey>, + ) -> &Definitions<'db> { + &self.definitions_by_node[&definition_key.into()] + } + + /// Returns the [`definition::Definition`] salsa ingredient for `definition_key`. + /// + /// ## Panics + /// + /// If the number of definitions associated with the key is not exactly 1 and + /// the `debug_assertions` feature is enabled, this method will panic. + #[track_caller] + pub(crate) fn expect_single_definition( + &self, + definition_key: impl Into<DefinitionNodeKey> + std::fmt::Debug + Copy, + ) -> Definition<'db> { + let definitions = self.definitions(definition_key); + debug_assert_eq!( + definitions.len(), + 1, + "Expected exactly one definition to be associated with AST node {definition_key:?} but found {}", + definitions.len() + ); + definitions[0] + } + + /// Returns the [`Expression`] ingredient for an expression node. + /// Panics if we have no expression ingredient for that node. We can only call this method for + /// standalone-inferable expressions, which we call `add_standalone_expression` for in + /// [`SemanticIndexBuilder`]. + #[track_caller] + pub(crate) fn expression( + &self, + expression_key: impl Into<ExpressionNodeKey>, + ) -> Expression<'db> { + self.expressions_by_node[&expression_key.into()] + } + + pub(crate) fn try_expression( + &self, + expression_key: impl Into<ExpressionNodeKey>, + ) -> Option<Expression<'db>> { + self.expressions_by_node + .get(&expression_key.into()) + .copied() + } + + pub(crate) fn is_standalone_expression( + &self, + expression_key: impl Into<ExpressionNodeKey>, + ) -> bool { + self.expressions_by_node + .contains_key(&expression_key.into()) + } + + /// Returns the id of the scope that `node` creates. + /// This is different from [`definition::Definition::scope`] which + /// returns the scope in which that definition is defined in. + #[track_caller] + pub(crate) fn node_scope(&self, node: NodeWithScopeRef) -> FileScopeId { + self.scopes_by_node[&node.node_key()] + } + + /// Checks if there is an import of `__future__.annotations` in the global scope, which affects + /// the logic for type inference. + pub(super) fn has_future_annotations(&self) -> bool { + self.has_future_annotations + } + + /// Returns + /// * `NoLongerInEagerContext` if the nested scope is no longer in an eager context + /// (that is, not every scope that will be traversed is eager). + /// * an iterator of bindings for a particular nested eager scope reference if the bindings exist. + /// * a narrowing constraint if there are no bindings, but there is a narrowing constraint for an outer scope symbol. + /// * `NotFound` if the narrowing constraint / bindings do not exist in the nested eager scope. + pub(crate) fn eager_snapshot( + &self, + enclosing_scope: FileScopeId, + symbol: &str, + nested_scope: FileScopeId, + ) -> EagerSnapshotResult<'_, 'db> { + for (ancestor_scope_id, ancestor_scope) in self.ancestor_scopes(nested_scope) { + if ancestor_scope_id == enclosing_scope { + break; + } + if !ancestor_scope.is_eager() { + return EagerSnapshotResult::NoLongerInEagerContext; + } + } + let Some(symbol_id) = self.symbol_tables[enclosing_scope].symbol_id_by_name(symbol) else { + return EagerSnapshotResult::NotFound; + }; + let key = EagerSnapshotKey { + enclosing_scope, + enclosing_symbol: symbol_id, + nested_scope, + }; + let Some(id) = self.eager_snapshots.get(&key) else { + return EagerSnapshotResult::NotFound; + }; + self.use_def_maps[enclosing_scope].eager_snapshot(*id) + } + + pub(crate) fn semantic_syntax_errors(&self) -> &[SemanticSyntaxError] { + &self.semantic_syntax_errors + } +} + +pub struct AncestorsIter<'a> { + scopes: &'a IndexSlice<FileScopeId, Scope>, + next_id: Option<FileScopeId>, +} + +impl<'a> AncestorsIter<'a> { + fn new(module_symbol_table: &'a SemanticIndex, start: FileScopeId) -> Self { + Self { + scopes: &module_symbol_table.scopes, + next_id: Some(start), + } + } +} + +impl<'a> Iterator for AncestorsIter<'a> { + type Item = (FileScopeId, &'a Scope); + + fn next(&mut self) -> Option<Self::Item> { + let current_id = self.next_id?; + let current = &self.scopes[current_id]; + self.next_id = current.parent(); + + Some((current_id, current)) + } +} + +impl FusedIterator for AncestorsIter<'_> {} + +pub struct DescendantsIter<'a> { + next_id: FileScopeId, + descendants: std::slice::Iter<'a, Scope>, +} + +impl<'a> DescendantsIter<'a> { + fn new(symbol_table: &'a SemanticIndex, scope_id: FileScopeId) -> Self { + let scope = &symbol_table.scopes[scope_id]; + let scopes = &symbol_table.scopes[scope.descendants()]; + + Self { + next_id: scope_id + 1, + descendants: scopes.iter(), + } + } +} + +impl<'a> Iterator for DescendantsIter<'a> { + type Item = (FileScopeId, &'a Scope); + + fn next(&mut self) -> Option<Self::Item> { + let descendant = self.descendants.next()?; + let id = self.next_id; + self.next_id = self.next_id + 1; + + Some((id, descendant)) + } + + fn size_hint(&self) -> (usize, Option<usize>) { + self.descendants.size_hint() + } +} + +impl FusedIterator for DescendantsIter<'_> {} + +impl ExactSizeIterator for DescendantsIter<'_> {} + +pub struct ChildrenIter<'a> { + parent: FileScopeId, + descendants: DescendantsIter<'a>, +} + +impl<'a> ChildrenIter<'a> { + fn new(module_symbol_table: &'a SemanticIndex, parent: FileScopeId) -> Self { + let descendants = DescendantsIter::new(module_symbol_table, parent); + + Self { + parent, + descendants, + } + } +} + +impl<'a> Iterator for ChildrenIter<'a> { + type Item = (FileScopeId, &'a Scope); + + fn next(&mut self) -> Option<Self::Item> { + self.descendants + .find(|(_, scope)| scope.parent() == Some(self.parent)) + } +} + +impl FusedIterator for ChildrenIter<'_> {} + +#[cfg(test)] +mod tests { + use ruff_db::files::{File, system_path_to_file}; + use ruff_db::parsed::parsed_module; + use ruff_python_ast::{self as ast}; + use ruff_text_size::{Ranged, TextRange}; + + use crate::Db; + use crate::db::tests::{TestDb, TestDbBuilder}; + use crate::semantic_index::ast_ids::{HasScopedUseId, ScopedUseId}; + use crate::semantic_index::definition::{Definition, DefinitionKind}; + use crate::semantic_index::symbol::{ + FileScopeId, Scope, ScopeKind, ScopedSymbolId, SymbolTable, + }; + use crate::semantic_index::use_def::UseDefMap; + use crate::semantic_index::{global_scope, semantic_index, symbol_table, use_def_map}; + + impl UseDefMap<'_> { + fn first_public_binding(&self, symbol: ScopedSymbolId) -> Option<Definition<'_>> { + self.public_bindings(symbol) + .find_map(|constrained_binding| constrained_binding.binding) + } + + fn first_binding_at_use(&self, use_id: ScopedUseId) -> Option<Definition<'_>> { + self.bindings_at_use(use_id) + .find_map(|constrained_binding| constrained_binding.binding) + } + } + + struct TestCase { + db: TestDb, + file: File, + } + + fn test_case(content: &str) -> TestCase { + const FILENAME: &str = "test.py"; + + let db = TestDbBuilder::new() + .with_file(FILENAME, content) + .build() + .unwrap(); + + let file = system_path_to_file(&db, FILENAME).unwrap(); + + TestCase { db, file } + } + + fn names(table: &SymbolTable) -> Vec<String> { + table + .symbols() + .map(|symbol| symbol.name().to_string()) + .collect() + } + + #[test] + fn empty() { + let TestCase { db, file } = test_case(""); + let global_table = symbol_table(&db, global_scope(&db, file)); + + let global_names = names(global_table); + + assert_eq!(global_names, Vec::<&str>::new()); + } + + #[test] + fn simple() { + let TestCase { db, file } = test_case("x"); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["x"]); + } + + #[test] + fn annotation_only() { + let TestCase { db, file } = test_case("x: int"); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["int", "x"]); + // TODO record definition + } + + #[test] + fn import() { + let TestCase { db, file } = test_case("import foo"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(names(global_table), vec!["foo"]); + let foo = global_table.symbol_id_by_name("foo").unwrap(); + + let use_def = use_def_map(&db, scope); + let binding = use_def.first_public_binding(foo).unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Import(_))); + } + + #[test] + fn import_sub() { + let TestCase { db, file } = test_case("import foo.bar"); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["foo"]); + } + + #[test] + fn import_as() { + let TestCase { db, file } = test_case("import foo.bar as baz"); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["baz"]); + } + + #[test] + fn import_from() { + let TestCase { db, file } = test_case("from bar import foo"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(names(global_table), vec!["foo"]); + assert!( + global_table + .symbol_by_name("foo") + .is_some_and(|symbol| { symbol.is_bound() && !symbol.is_used() }), + "symbols that are defined get the defined flag" + ); + + let use_def = use_def_map(&db, scope); + let binding = use_def + .first_public_binding( + global_table + .symbol_id_by_name("foo") + .expect("symbol to exist"), + ) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::ImportFrom(_))); + } + + #[test] + fn assign() { + let TestCase { db, file } = test_case("x = foo"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(names(global_table), vec!["foo", "x"]); + assert!( + global_table + .symbol_by_name("foo") + .is_some_and(|symbol| { !symbol.is_bound() && symbol.is_used() }), + "a symbol used but not bound in a scope should have only the used flag" + ); + let use_def = use_def_map(&db, scope); + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name("x").expect("symbol exists")) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); + } + + #[test] + fn augmented_assignment() { + let TestCase { db, file } = test_case("x += 1"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(names(global_table), vec!["x"]); + + let use_def = use_def_map(&db, scope); + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) + .unwrap(); + + assert!(matches!( + binding.kind(&db), + DefinitionKind::AugmentedAssignment(_) + )); + } + + #[test] + fn class_scope() { + let TestCase { db, file } = test_case( + " +class C: + x = 1 +y = 2 +", + ); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["C", "y"]); + + let index = semantic_index(&db, file); + + let [(class_scope_id, class_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope") + }; + assert_eq!(class_scope.kind(), ScopeKind::Class); + assert_eq!(class_scope_id.to_scope_id(&db, file).name(&db), "C"); + + let class_table = index.symbol_table(class_scope_id); + assert_eq!(names(&class_table), vec!["x"]); + + let use_def = index.use_def_map(class_scope_id); + let binding = use_def + .first_public_binding(class_table.symbol_id_by_name("x").expect("symbol exists")) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); + } + + #[test] + fn function_scope() { + let TestCase { db, file } = test_case( + " +def func(): + x = 1 +y = 2 +", + ); + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["func", "y"]); + + let [(function_scope_id, function_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope") + }; + assert_eq!(function_scope.kind(), ScopeKind::Function); + assert_eq!(function_scope_id.to_scope_id(&db, file).name(&db), "func"); + + let function_table = index.symbol_table(function_scope_id); + assert_eq!(names(&function_table), vec!["x"]); + + let use_def = index.use_def_map(function_scope_id); + let binding = use_def + .first_public_binding( + function_table + .symbol_id_by_name("x") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Assignment(_))); + } + + #[test] + fn function_parameter_symbols() { + let TestCase { db, file } = test_case( + " +def f(a: str, /, b: str, c: int = 1, *args, d: int = 2, **kwargs): + pass +", + ); + + let index = semantic_index(&db, file); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert_eq!(names(global_table), vec!["str", "int", "f"]); + + let [(function_scope_id, _function_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("Expected a function scope") + }; + + let function_table = index.symbol_table(function_scope_id); + assert_eq!( + names(&function_table), + vec!["a", "b", "c", "d", "args", "kwargs"], + ); + + let use_def = index.use_def_map(function_scope_id); + for name in ["a", "b", "c", "d"] { + let binding = use_def + .first_public_binding( + function_table + .symbol_id_by_name(name) + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Parameter(_))); + } + let args_binding = use_def + .first_public_binding( + function_table + .symbol_id_by_name("args") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!( + args_binding.kind(&db), + DefinitionKind::VariadicPositionalParameter(_) + )); + let kwargs_binding = use_def + .first_public_binding( + function_table + .symbol_id_by_name("kwargs") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!( + kwargs_binding.kind(&db), + DefinitionKind::VariadicKeywordParameter(_) + )); + } + + #[test] + fn lambda_parameter_symbols() { + let TestCase { db, file } = test_case("lambda a, b, c=1, *args, d=2, **kwargs: None"); + + let index = semantic_index(&db, file); + let global_table = symbol_table(&db, global_scope(&db, file)); + + assert!(names(global_table).is_empty()); + + let [(lambda_scope_id, _lambda_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("Expected a lambda scope") + }; + + let lambda_table = index.symbol_table(lambda_scope_id); + assert_eq!( + names(&lambda_table), + vec!["a", "b", "c", "d", "args", "kwargs"], + ); + + let use_def = index.use_def_map(lambda_scope_id); + for name in ["a", "b", "c", "d"] { + let binding = use_def + .first_public_binding(lambda_table.symbol_id_by_name(name).expect("symbol exists")) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Parameter(_))); + } + let args_binding = use_def + .first_public_binding( + lambda_table + .symbol_id_by_name("args") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!( + args_binding.kind(&db), + DefinitionKind::VariadicPositionalParameter(_) + )); + let kwargs_binding = use_def + .first_public_binding( + lambda_table + .symbol_id_by_name("kwargs") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!( + kwargs_binding.kind(&db), + DefinitionKind::VariadicKeywordParameter(_) + )); + } + + /// Test case to validate that the comprehension scope is correctly identified and that the target + /// variable is defined only in the comprehension scope and not in the global scope. + #[test] + fn comprehension_scope() { + let TestCase { db, file } = test_case( + " +[x for x, y in iter1] +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["iter1"]); + + let [(comprehension_scope_id, comprehension_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope") + }; + + assert_eq!(comprehension_scope.kind(), ScopeKind::Comprehension); + assert_eq!( + comprehension_scope_id.to_scope_id(&db, file).name(&db), + "<listcomp>" + ); + + let comprehension_symbol_table = index.symbol_table(comprehension_scope_id); + + assert_eq!(names(&comprehension_symbol_table), vec!["x", "y"]); + + let use_def = index.use_def_map(comprehension_scope_id); + for name in ["x", "y"] { + let binding = use_def + .first_public_binding( + comprehension_symbol_table + .symbol_id_by_name(name) + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!( + binding.kind(&db), + DefinitionKind::Comprehension(_) + )); + } + } + + /// Test case to validate that the `x` variable used in the comprehension is referencing the + /// `x` variable defined by the inner generator (`for x in iter2`) and not the outer one. + #[test] + fn multiple_generators() { + let TestCase { db, file } = test_case( + " +[x for x in iter1 for x in iter2] +", + ); + + let index = semantic_index(&db, file); + let [(comprehension_scope_id, _)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope") + }; + + let use_def = index.use_def_map(comprehension_scope_id); + + let module = parsed_module(&db, file).syntax(); + let element = module.body[0] + .as_expr_stmt() + .unwrap() + .value + .as_list_comp_expr() + .unwrap() + .elt + .as_name_expr() + .unwrap(); + let element_use_id = + element.scoped_use_id(&db, comprehension_scope_id.to_scope_id(&db, file)); + + let binding = use_def.first_binding_at_use(element_use_id).unwrap(); + let DefinitionKind::Comprehension(comprehension) = binding.kind(&db) else { + panic!("expected generator definition") + }; + let target = comprehension.target(); + let name = target.as_name_expr().unwrap().id().as_str(); + + assert_eq!(name, "x"); + assert_eq!(target.range(), TextRange::new(23.into(), 24.into())); + } + + /// Test case to validate that the nested comprehension creates a new scope which is a child of + /// the outer comprehension scope and the variables are correctly defined in the respective + /// scopes. + #[test] + fn nested_generators() { + let TestCase { db, file } = test_case( + " +[{x for x in iter2} for y in iter1] +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["iter1"]); + + let [(comprehension_scope_id, comprehension_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope") + }; + + assert_eq!(comprehension_scope.kind(), ScopeKind::Comprehension); + assert_eq!( + comprehension_scope_id.to_scope_id(&db, file).name(&db), + "<listcomp>" + ); + + let comprehension_symbol_table = index.symbol_table(comprehension_scope_id); + + assert_eq!(names(&comprehension_symbol_table), vec!["y", "iter2"]); + + let [(inner_comprehension_scope_id, inner_comprehension_scope)] = index + .child_scopes(comprehension_scope_id) + .collect::<Vec<_>>()[..] + else { + panic!("expected one inner generator scope") + }; + + assert_eq!(inner_comprehension_scope.kind(), ScopeKind::Comprehension); + assert_eq!( + inner_comprehension_scope_id + .to_scope_id(&db, file) + .name(&db), + "<setcomp>" + ); + + let inner_comprehension_symbol_table = index.symbol_table(inner_comprehension_scope_id); + + assert_eq!(names(&inner_comprehension_symbol_table), vec!["x"]); + } + + #[test] + fn with_item_definition() { + let TestCase { db, file } = test_case( + " +with item1 as x, item2 as y: + pass +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["item1", "x", "item2", "y"]); + + let use_def = index.use_def_map(FileScopeId::global()); + for name in ["x", "y"] { + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) + .expect("Expected with item definition for {name}"); + assert!(matches!(binding.kind(&db), DefinitionKind::WithItem(_))); + } + } + + #[test] + fn with_item_unpacked_definition() { + let TestCase { db, file } = test_case( + " +with context() as (x, y): + pass +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["context", "x", "y"]); + + let use_def = index.use_def_map(FileScopeId::global()); + for name in ["x", "y"] { + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) + .expect("Expected with item definition for {name}"); + assert!(matches!(binding.kind(&db), DefinitionKind::WithItem(_))); + } + } + + #[test] + fn dupes() { + let TestCase { db, file } = test_case( + " +def func(): + x = 1 +def func(): + y = 2 +", + ); + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["func"]); + let [ + (func_scope1_id, func_scope_1), + (func_scope2_id, func_scope_2), + ] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected two child scopes"); + }; + + assert_eq!(func_scope_1.kind(), ScopeKind::Function); + + assert_eq!(func_scope1_id.to_scope_id(&db, file).name(&db), "func"); + assert_eq!(func_scope_2.kind(), ScopeKind::Function); + assert_eq!(func_scope2_id.to_scope_id(&db, file).name(&db), "func"); + + let func1_table = index.symbol_table(func_scope1_id); + let func2_table = index.symbol_table(func_scope2_id); + assert_eq!(names(&func1_table), vec!["x"]); + assert_eq!(names(&func2_table), vec!["y"]); + + let use_def = index.use_def_map(FileScopeId::global()); + let binding = use_def + .first_public_binding( + global_table + .symbol_id_by_name("func") + .expect("symbol exists"), + ) + .unwrap(); + assert!(matches!(binding.kind(&db), DefinitionKind::Function(_))); + } + + #[test] + fn generic_function() { + let TestCase { db, file } = test_case( + " +def func[T](): + x = 1 +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["func"]); + + let [(ann_scope_id, ann_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope"); + }; + + assert_eq!(ann_scope.kind(), ScopeKind::Annotation); + assert_eq!(ann_scope_id.to_scope_id(&db, file).name(&db), "func"); + let ann_table = index.symbol_table(ann_scope_id); + assert_eq!(names(&ann_table), vec!["T"]); + + let [(func_scope_id, func_scope)] = + index.child_scopes(ann_scope_id).collect::<Vec<_>>()[..] + else { + panic!("expected one child scope"); + }; + assert_eq!(func_scope.kind(), ScopeKind::Function); + assert_eq!(func_scope_id.to_scope_id(&db, file).name(&db), "func"); + let func_table = index.symbol_table(func_scope_id); + assert_eq!(names(&func_table), vec!["x"]); + } + + #[test] + fn generic_class() { + let TestCase { db, file } = test_case( + " +class C[T]: + x = 1 +", + ); + + let index = semantic_index(&db, file); + let global_table = index.symbol_table(FileScopeId::global()); + + assert_eq!(names(&global_table), vec!["C"]); + + let [(ann_scope_id, ann_scope)] = index + .child_scopes(FileScopeId::global()) + .collect::<Vec<_>>()[..] + else { + panic!("expected one child scope"); + }; + + assert_eq!(ann_scope.kind(), ScopeKind::Annotation); + assert_eq!(ann_scope_id.to_scope_id(&db, file).name(&db), "C"); + let ann_table = index.symbol_table(ann_scope_id); + assert_eq!(names(&ann_table), vec!["T"]); + assert!( + ann_table + .symbol_by_name("T") + .is_some_and(|s| s.is_bound() && !s.is_used()), + "type parameters are defined by the scope that introduces them" + ); + + let [(class_scope_id, class_scope)] = + index.child_scopes(ann_scope_id).collect::<Vec<_>>()[..] + else { + panic!("expected one child scope"); + }; + + assert_eq!(class_scope.kind(), ScopeKind::Class); + assert_eq!(class_scope_id.to_scope_id(&db, file).name(&db), "C"); + assert_eq!(names(&index.symbol_table(class_scope_id)), vec!["x"]); + } + + #[test] + fn reachability_trivial() { + let TestCase { db, file } = test_case("x = 1; x"); + let parsed = parsed_module(&db, file); + let scope = global_scope(&db, file); + let ast = parsed.syntax(); + let ast::Stmt::Expr(ast::StmtExpr { + value: x_use_expr, .. + }) = &ast.body[1] + else { + panic!("should be an expr") + }; + let ast::Expr::Name(x_use_expr_name) = x_use_expr.as_ref() else { + panic!("expected a Name"); + }; + let x_use_id = x_use_expr_name.scoped_use_id(&db, scope); + let use_def = use_def_map(&db, scope); + let binding = use_def.first_binding_at_use(x_use_id).unwrap(); + let DefinitionKind::Assignment(assignment) = binding.kind(&db) else { + panic!("should be an assignment definition") + }; + let ast::Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Int(num), + .. + }) = assignment.value() + else { + panic!("should be a number literal") + }; + assert_eq!(*num, 1); + } + + #[test] + fn expression_scope() { + let TestCase { db, file } = test_case("x = 1;\ndef test():\n y = 4"); + + let index = semantic_index(&db, file); + let parsed = parsed_module(&db, file); + let ast = parsed.syntax(); + + let x_stmt = ast.body[0].as_assign_stmt().unwrap(); + let x = &x_stmt.targets[0]; + + assert_eq!(index.expression_scope(x).kind(), ScopeKind::Module); + assert_eq!(index.expression_scope_id(x), FileScopeId::global()); + + let def = ast.body[1].as_function_def_stmt().unwrap(); + let y_stmt = def.body[0].as_assign_stmt().unwrap(); + let y = &y_stmt.targets[0]; + + assert_eq!(index.expression_scope(y).kind(), ScopeKind::Function); + } + + #[test] + fn scope_iterators() { + fn scope_names<'a>( + scopes: impl Iterator<Item = (FileScopeId, &'a Scope)>, + db: &'a dyn Db, + file: File, + ) -> Vec<&'a str> { + scopes + .into_iter() + .map(|(scope_id, _)| scope_id.to_scope_id(db, file).name(db)) + .collect() + } + + let TestCase { db, file } = test_case( + r" +class Test: + def foo(): + def bar(): + ... + def baz(): + pass + +def x(): + pass", + ); + + let index = semantic_index(&db, file); + + let descendants = index.descendent_scopes(FileScopeId::global()); + assert_eq!( + scope_names(descendants, &db, file), + vec!["Test", "foo", "bar", "baz", "x"] + ); + + let children = index.child_scopes(FileScopeId::global()); + assert_eq!(scope_names(children, &db, file), vec!["Test", "x"]); + + let test_class = index.child_scopes(FileScopeId::global()).next().unwrap().0; + let test_child_scopes = index.child_scopes(test_class); + assert_eq!( + scope_names(test_child_scopes, &db, file), + vec!["foo", "baz"] + ); + + let bar_scope = index + .descendent_scopes(FileScopeId::global()) + .nth(2) + .unwrap() + .0; + let ancestors = index.ancestor_scopes(bar_scope); + + assert_eq!( + scope_names(ancestors, &db, file), + vec!["bar", "foo", "Test", "<module>"] + ); + } + + #[test] + fn match_stmt() { + let TestCase { db, file } = test_case( + " +match subject: + case a: ... + case [b, c, *d]: ... + case e as f: ... + case {'x': g, **h}: ... + case Foo(i, z=j): ... + case k | l: ... + case _: ... +", + ); + + let global_scope_id = global_scope(&db, file); + let global_table = symbol_table(&db, global_scope_id); + + assert!(global_table.symbol_by_name("Foo").unwrap().is_used()); + assert_eq!( + names(global_table), + vec![ + "subject", "a", "b", "c", "d", "e", "f", "g", "h", "Foo", "i", "j", "k", "l" + ] + ); + + let use_def = use_def_map(&db, global_scope_id); + for (name, expected_index) in [ + ("a", 0), + ("b", 0), + ("c", 1), + ("d", 2), + ("e", 0), + ("f", 1), + ("g", 0), + ("h", 1), + ("i", 0), + ("j", 1), + ("k", 0), + ("l", 1), + ] { + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) + .expect("Expected with item definition for {name}"); + if let DefinitionKind::MatchPattern(pattern) = binding.kind(&db) { + assert_eq!(pattern.index(), expected_index); + } else { + panic!("Expected match pattern definition for {name}"); + } + } + } + + #[test] + fn nested_match_case() { + let TestCase { db, file } = test_case( + " +match 1: + case first: + match 2: + case second: + pass +", + ); + + let global_scope_id = global_scope(&db, file); + let global_table = symbol_table(&db, global_scope_id); + + assert_eq!(names(global_table), vec!["first", "second"]); + + let use_def = use_def_map(&db, global_scope_id); + for (name, expected_index) in [("first", 0), ("second", 0)] { + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name(name).expect("symbol exists")) + .expect("Expected with item definition for {name}"); + if let DefinitionKind::MatchPattern(pattern) = binding.kind(&db) { + assert_eq!(pattern.index(), expected_index); + } else { + panic!("Expected match pattern definition for {name}"); + } + } + } + + #[test] + fn for_loops_single_assignment() { + let TestCase { db, file } = test_case("for x in a: pass"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(&names(global_table), &["a", "x"]); + + let use_def = use_def_map(&db, scope); + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) + .unwrap(); + + assert!(matches!(binding.kind(&db), DefinitionKind::For(_))); + } + + #[test] + fn for_loops_simple_unpacking() { + let TestCase { db, file } = test_case("for (x, y) in a: pass"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(&names(global_table), &["a", "x", "y"]); + + let use_def = use_def_map(&db, scope); + let x_binding = use_def + .first_public_binding(global_table.symbol_id_by_name("x").unwrap()) + .unwrap(); + let y_binding = use_def + .first_public_binding(global_table.symbol_id_by_name("y").unwrap()) + .unwrap(); + + assert!(matches!(x_binding.kind(&db), DefinitionKind::For(_))); + assert!(matches!(y_binding.kind(&db), DefinitionKind::For(_))); + } + + #[test] + fn for_loops_complex_unpacking() { + let TestCase { db, file } = test_case("for [((a,) b), (c, d)] in e: pass"); + let scope = global_scope(&db, file); + let global_table = symbol_table(&db, scope); + + assert_eq!(&names(global_table), &["e", "a", "b", "c", "d"]); + + let use_def = use_def_map(&db, scope); + let binding = use_def + .first_public_binding(global_table.symbol_id_by_name("a").unwrap()) + .unwrap(); + + assert!(matches!(binding.kind(&db), DefinitionKind::For(_))); + } +} diff --git a/crates/red_knot_python_semantic/src/semantic_index/ast_ids.rs b/crates/ty_python_semantic/src/semantic_index/ast_ids.rs similarity index 75% rename from crates/red_knot_python_semantic/src/semantic_index/ast_ids.rs rename to crates/ty_python_semantic/src/semantic_index/ast_ids.rs index 4e620e71cd99c..0a18330569047 100644 --- a/crates/red_knot_python_semantic/src/semantic_index/ast_ids.rs +++ b/crates/ty_python_semantic/src/semantic_index/ast_ids.rs @@ -2,12 +2,12 @@ use rustc_hash::FxHashMap; use ruff_index::newtype_index; use ruff_python_ast as ast; -use ruff_python_ast::ExpressionRef; +use ruff_python_ast::ExprRef; +use crate::Db; use crate::semantic_index::ast_ids::node_key::ExpressionNodeKey; use crate::semantic_index::semantic_index; use crate::semantic_index::symbol::ScopeId; -use crate::Db; /// AST ids for a single scope. /// @@ -24,7 +24,7 @@ use crate::Db; /// /// x = foo() /// ``` -#[derive(Debug)] +#[derive(Debug, salsa::Update)] pub(crate) struct AstIds { /// Maps expressions to their expression id. expressions_map: FxHashMap<ExpressionNodeKey, ScopedExpressionId>, @@ -49,56 +49,58 @@ fn ast_ids<'db>(db: &'db dyn Db, scope: ScopeId) -> &'db AstIds { semantic_index(db, scope.file(db)).ast_ids(scope.file_scope_id(db)) } -pub trait HasScopedUseId { - /// The type of the ID uniquely identifying the use. - type Id: Copy; +/// Uniquely identifies a use of a name in a [`crate::semantic_index::symbol::FileScopeId`]. +#[newtype_index] +pub struct ScopedUseId; +pub trait HasScopedUseId { /// Returns the ID that uniquely identifies the use in `scope`. - fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id; + fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedUseId; } -/// Uniquely identifies a use of a name in a [`crate::semantic_index::symbol::FileScopeId`]. -#[newtype_index] -pub struct ScopedUseId; +impl HasScopedUseId for ast::Identifier { + fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedUseId { + let ast_ids = ast_ids(db, scope); + ast_ids.use_id(self) + } +} impl HasScopedUseId for ast::ExprName { - type Id = ScopedUseId; - - fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id { - let expression_ref = ExpressionRef::from(self); + fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedUseId { + let expression_ref = ExprRef::from(self); expression_ref.scoped_use_id(db, scope) } } -impl HasScopedUseId for ast::ExpressionRef<'_> { - type Id = ScopedUseId; - - fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id { +impl HasScopedUseId for ast::ExprRef<'_> { + fn scoped_use_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedUseId { let ast_ids = ast_ids(db, scope); ast_ids.use_id(*self) } } -pub trait HasScopedAstId { - /// The type of the ID uniquely identifying the node. - type Id: Copy; +/// Uniquely identifies an [`ast::Expr`] in a [`crate::semantic_index::symbol::FileScopeId`]. +#[newtype_index] +#[derive(salsa::Update)] +pub struct ScopedExpressionId; +pub trait HasScopedExpressionId { /// Returns the ID that uniquely identifies the node in `scope`. - fn scoped_ast_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id; + fn scoped_expression_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedExpressionId; } -/// Uniquely identifies an [`ast::Expr`] in a [`crate::semantic_index::symbol::FileScopeId`]. -#[newtype_index] -pub struct ScopedExpressionId; +impl<T: HasScopedExpressionId> HasScopedExpressionId for Box<T> { + fn scoped_expression_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedExpressionId { + self.as_ref().scoped_expression_id(db, scope) + } +} macro_rules! impl_has_scoped_expression_id { ($ty: ty) => { - impl HasScopedAstId for $ty { - type Id = ScopedExpressionId; - - fn scoped_ast_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id { - let expression_ref = ExpressionRef::from(self); - expression_ref.scoped_ast_id(db, scope) + impl HasScopedExpressionId for $ty { + fn scoped_expression_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedExpressionId { + let expression_ref = ExprRef::from(self); + expression_ref.scoped_expression_id(db, scope) } } }; @@ -138,29 +140,20 @@ impl_has_scoped_expression_id!(ast::ExprSlice); impl_has_scoped_expression_id!(ast::ExprIpyEscapeCommand); impl_has_scoped_expression_id!(ast::Expr); -impl HasScopedAstId for ast::ExpressionRef<'_> { - type Id = ScopedExpressionId; - - fn scoped_ast_id(&self, db: &dyn Db, scope: ScopeId) -> Self::Id { +impl HasScopedExpressionId for ast::ExprRef<'_> { + fn scoped_expression_id(&self, db: &dyn Db, scope: ScopeId) -> ScopedExpressionId { let ast_ids = ast_ids(db, scope); ast_ids.expression_id(*self) } } -#[derive(Debug)] +#[derive(Debug, Default)] pub(super) struct AstIdsBuilder { expressions_map: FxHashMap<ExpressionNodeKey, ScopedExpressionId>, uses_map: FxHashMap<ExpressionNodeKey, ScopedUseId>, } impl AstIdsBuilder { - pub(super) fn new() -> Self { - Self { - expressions_map: FxHashMap::default(), - uses_map: FxHashMap::default(), - } - } - /// Adds `expr` to the expression ids map and returns its id. pub(super) fn record_expression(&mut self, expr: &ast::Expr) -> ScopedExpressionId { let expression_id = self.expressions_map.len().into(); @@ -171,7 +164,7 @@ impl AstIdsBuilder { } /// Adds `expr` to the use ids map and returns its id. - pub(super) fn record_use(&mut self, expr: &ast::Expr) -> ScopedUseId { + pub(super) fn record_use(&mut self, expr: impl Into<ExpressionNodeKey>) -> ScopedUseId { let use_id = self.uses_map.len().into(); self.uses_map.insert(expr.into(), use_id); @@ -196,11 +189,11 @@ pub(crate) mod node_key { use crate::node_key::NodeKey; - #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)] + #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug, salsa::Update)] pub(crate) struct ExpressionNodeKey(NodeKey); - impl From<ast::ExpressionRef<'_>> for ExpressionNodeKey { - fn from(value: ast::ExpressionRef<'_>) -> Self { + impl From<ast::ExprRef<'_>> for ExpressionNodeKey { + fn from(value: ast::ExprRef<'_>) -> Self { Self(NodeKey::from_node(value)) } } @@ -210,4 +203,10 @@ pub(crate) mod node_key { Self(NodeKey::from_node(value)) } } + + impl From<&ast::Identifier> for ExpressionNodeKey { + fn from(value: &ast::Identifier) -> Self { + Self(NodeKey::from_node(value)) + } + } } diff --git a/crates/ty_python_semantic/src/semantic_index/builder.rs b/crates/ty_python_semantic/src/semantic_index/builder.rs new file mode 100644 index 0000000000000..a5b0819cac345 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/builder.rs @@ -0,0 +1,2701 @@ +use std::cell::{OnceCell, RefCell}; +use std::sync::Arc; + +use except_handlers::TryNodeContextStackManager; +use rustc_hash::{FxHashMap, FxHashSet}; + +use ruff_db::files::File; +use ruff_db::parsed::ParsedModule; +use ruff_db::source::{SourceText, source_text}; +use ruff_index::IndexVec; +use ruff_python_ast::name::Name; +use ruff_python_ast::visitor::{Visitor, walk_expr, walk_pattern, walk_stmt}; +use ruff_python_ast::{self as ast, PySourceType, PythonVersion}; +use ruff_python_parser::semantic_errors::{ + SemanticSyntaxChecker, SemanticSyntaxContext, SemanticSyntaxError, SemanticSyntaxErrorKind, +}; +use ruff_text_size::TextRange; + +use crate::ast_node_ref::AstNodeRef; +use crate::module_name::ModuleName; +use crate::module_resolver::resolve_module; +use crate::node_key::NodeKey; +use crate::semantic_index::SemanticIndex; +use crate::semantic_index::ast_ids::AstIdsBuilder; +use crate::semantic_index::ast_ids::node_key::ExpressionNodeKey; +use crate::semantic_index::definition::{ + AnnotatedAssignmentDefinitionKind, AnnotatedAssignmentDefinitionNodeRef, + AssignmentDefinitionKind, AssignmentDefinitionNodeRef, ComprehensionDefinitionKind, + ComprehensionDefinitionNodeRef, Definition, DefinitionCategory, DefinitionKind, + DefinitionNodeKey, DefinitionNodeRef, Definitions, ExceptHandlerDefinitionNodeRef, + ForStmtDefinitionKind, ForStmtDefinitionNodeRef, ImportDefinitionNodeRef, + ImportFromDefinitionNodeRef, MatchPatternDefinitionNodeRef, StarImportDefinitionNodeRef, + TargetKind, WithItemDefinitionKind, WithItemDefinitionNodeRef, +}; +use crate::semantic_index::expression::{Expression, ExpressionKind}; +use crate::semantic_index::predicate::{ + PatternPredicate, PatternPredicateKind, Predicate, PredicateNode, ScopedPredicateId, + StarImportPlaceholderPredicate, +}; +use crate::semantic_index::re_exports::exported_names; +use crate::semantic_index::symbol::{ + FileScopeId, NodeWithScopeKey, NodeWithScopeKind, NodeWithScopeRef, Scope, ScopeId, ScopeKind, + ScopedSymbolId, SymbolTableBuilder, +}; +use crate::semantic_index::use_def::{ + EagerSnapshotKey, FlowSnapshot, ScopedEagerSnapshotId, UseDefMapBuilder, +}; +use crate::semantic_index::visibility_constraints::{ + ScopedVisibilityConstraintId, VisibilityConstraintsBuilder, +}; +use crate::unpack::{Unpack, UnpackKind, UnpackPosition, UnpackValue}; +use crate::{Db, Program}; + +mod except_handlers; + +#[derive(Clone, Debug, Default)] +struct Loop { + /// Flow states at each `break` in the current loop. + break_states: Vec<FlowSnapshot>, +} + +impl Loop { + fn push_break(&mut self, state: FlowSnapshot) { + self.break_states.push(state); + } +} + +struct ScopeInfo { + file_scope_id: FileScopeId, + /// Current loop state; None if we are not currently visiting a loop + current_loop: Option<Loop>, +} + +pub(super) struct SemanticIndexBuilder<'db> { + // Builder state + db: &'db dyn Db, + file: File, + source_type: PySourceType, + module: &'db ParsedModule, + scope_stack: Vec<ScopeInfo>, + /// The assignments we're currently visiting, with + /// the most recent visit at the end of the Vec + current_assignments: Vec<CurrentAssignment<'db>>, + /// The match case we're currently visiting. + current_match_case: Option<CurrentMatchCase<'db>>, + /// The name of the first function parameter of the innermost function that we're currently visiting. + current_first_parameter_name: Option<&'db str>, + + /// Per-scope contexts regarding nested `try`/`except` statements + try_node_context_stack_manager: TryNodeContextStackManager, + + /// Flags about the file's global scope + has_future_annotations: bool, + + // Used for checking semantic syntax errors + python_version: PythonVersion, + source_text: OnceCell<SourceText>, + semantic_checker: SemanticSyntaxChecker, + + // Semantic Index fields + scopes: IndexVec<FileScopeId, Scope>, + scope_ids_by_scope: IndexVec<FileScopeId, ScopeId<'db>>, + symbol_tables: IndexVec<FileScopeId, SymbolTableBuilder>, + instance_attribute_tables: IndexVec<FileScopeId, SymbolTableBuilder>, + ast_ids: IndexVec<FileScopeId, AstIdsBuilder>, + use_def_maps: IndexVec<FileScopeId, UseDefMapBuilder<'db>>, + scopes_by_node: FxHashMap<NodeWithScopeKey, FileScopeId>, + scopes_by_expression: FxHashMap<ExpressionNodeKey, FileScopeId>, + globals_by_scope: FxHashMap<FileScopeId, FxHashSet<ScopedSymbolId>>, + definitions_by_node: FxHashMap<DefinitionNodeKey, Definitions<'db>>, + expressions_by_node: FxHashMap<ExpressionNodeKey, Expression<'db>>, + imported_modules: FxHashSet<ModuleName>, + /// Hashset of all [`FileScopeId`]s that correspond to [generator functions]. + /// + /// [generator functions]: https://docs.python.org/3/glossary.html#term-generator + generator_functions: FxHashSet<FileScopeId>, + eager_snapshots: FxHashMap<EagerSnapshotKey, ScopedEagerSnapshotId>, + /// Errors collected by the `semantic_checker`. + semantic_syntax_errors: RefCell<Vec<SemanticSyntaxError>>, +} + +impl<'db> SemanticIndexBuilder<'db> { + pub(super) fn new(db: &'db dyn Db, file: File, parsed: &'db ParsedModule) -> Self { + let mut builder = Self { + db, + file, + source_type: file.source_type(db.upcast()), + module: parsed, + scope_stack: Vec::new(), + current_assignments: vec![], + current_match_case: None, + current_first_parameter_name: None, + try_node_context_stack_manager: TryNodeContextStackManager::default(), + + has_future_annotations: false, + + scopes: IndexVec::new(), + symbol_tables: IndexVec::new(), + instance_attribute_tables: IndexVec::new(), + ast_ids: IndexVec::new(), + scope_ids_by_scope: IndexVec::new(), + use_def_maps: IndexVec::new(), + + scopes_by_expression: FxHashMap::default(), + scopes_by_node: FxHashMap::default(), + definitions_by_node: FxHashMap::default(), + expressions_by_node: FxHashMap::default(), + globals_by_scope: FxHashMap::default(), + + imported_modules: FxHashSet::default(), + generator_functions: FxHashSet::default(), + + eager_snapshots: FxHashMap::default(), + + python_version: Program::get(db).python_version(db), + source_text: OnceCell::new(), + semantic_checker: SemanticSyntaxChecker::default(), + semantic_syntax_errors: RefCell::default(), + }; + + builder.push_scope_with_parent( + NodeWithScopeRef::Module, + None, + ScopedVisibilityConstraintId::ALWAYS_TRUE, + ); + + builder + } + + fn current_scope_info(&self) -> &ScopeInfo { + self.scope_stack + .last() + .expect("SemanticIndexBuilder should have created a root scope") + } + + fn current_scope_info_mut(&mut self) -> &mut ScopeInfo { + self.scope_stack + .last_mut() + .expect("SemanticIndexBuilder should have created a root scope") + } + + fn current_scope(&self) -> FileScopeId { + self.current_scope_info().file_scope_id + } + + /// Returns the scope ID of the surrounding class body scope if the current scope + /// is a method inside a class body. Returns `None` otherwise, e.g. if the current + /// scope is a function body outside of a class, or if the current scope is not a + /// function body. + fn is_method_of_class(&self) -> Option<FileScopeId> { + let mut scopes_rev = self.scope_stack.iter().rev(); + let current = scopes_rev.next()?; + + if self.scopes[current.file_scope_id].kind() != ScopeKind::Function { + return None; + } + + let parent = scopes_rev.next()?; + + match self.scopes[parent.file_scope_id].kind() { + ScopeKind::Class => Some(parent.file_scope_id), + ScopeKind::Annotation => { + // If the function is generic, the parent scope is an annotation scope. + // In this case, we need to go up one level higher to find the class scope. + let grandparent = scopes_rev.next()?; + + if self.scopes[grandparent.file_scope_id].kind() == ScopeKind::Class { + Some(grandparent.file_scope_id) + } else { + None + } + } + _ => None, + } + } + + /// Push a new loop, returning the outer loop, if any. + fn push_loop(&mut self) -> Option<Loop> { + self.current_scope_info_mut() + .current_loop + .replace(Loop::default()) + } + + /// Pop a loop, replacing with the previous saved outer loop, if any. + fn pop_loop(&mut self, outer_loop: Option<Loop>) -> Loop { + std::mem::replace(&mut self.current_scope_info_mut().current_loop, outer_loop) + .expect("pop_loop() should not be called without a prior push_loop()") + } + + fn current_loop_mut(&mut self) -> Option<&mut Loop> { + self.current_scope_info_mut().current_loop.as_mut() + } + + fn push_scope(&mut self, node: NodeWithScopeRef) { + let parent = self.current_scope(); + let reachability = self.current_use_def_map().reachability; + self.push_scope_with_parent(node, Some(parent), reachability); + } + + fn push_scope_with_parent( + &mut self, + node: NodeWithScopeRef, + parent: Option<FileScopeId>, + reachability: ScopedVisibilityConstraintId, + ) { + let children_start = self.scopes.next_index() + 1; + + // SAFETY: `node` is guaranteed to be a child of `self.module` + #[expect(unsafe_code)] + let node_with_kind = unsafe { node.to_kind(self.module.clone()) }; + + let scope = Scope::new( + parent, + node_with_kind, + children_start..children_start, + reachability, + ); + let is_class_scope = scope.kind().is_class(); + self.try_node_context_stack_manager.enter_nested_scope(); + + let file_scope_id = self.scopes.push(scope); + self.symbol_tables.push(SymbolTableBuilder::default()); + self.instance_attribute_tables + .push(SymbolTableBuilder::default()); + self.use_def_maps + .push(UseDefMapBuilder::new(is_class_scope)); + let ast_id_scope = self.ast_ids.push(AstIdsBuilder::default()); + + let scope_id = ScopeId::new(self.db, self.file, file_scope_id, countme::Count::default()); + + self.scope_ids_by_scope.push(scope_id); + let previous = self.scopes_by_node.insert(node.node_key(), file_scope_id); + debug_assert_eq!(previous, None); + + debug_assert_eq!(ast_id_scope, file_scope_id); + + self.scope_stack.push(ScopeInfo { + file_scope_id, + current_loop: None, + }); + } + + fn pop_scope(&mut self) -> FileScopeId { + self.try_node_context_stack_manager.exit_scope(); + + let ScopeInfo { + file_scope_id: popped_scope_id, + .. + } = self + .scope_stack + .pop() + .expect("Root scope should be present"); + + let children_end = self.scopes.next_index(); + let popped_scope = &mut self.scopes[popped_scope_id]; + popped_scope.extend_descendants(children_end); + + if !popped_scope.is_eager() { + return popped_scope_id; + } + + // If the scope that we just popped off is an eager scope, we need to "lock" our view of + // which bindings reach each of the uses in the scope. Loop through each enclosing scope, + // looking for any that bind each symbol. + for enclosing_scope_info in self.scope_stack.iter().rev() { + let enclosing_scope_id = enclosing_scope_info.file_scope_id; + let enclosing_scope_kind = self.scopes[enclosing_scope_id].kind(); + let enclosing_symbol_table = &self.symbol_tables[enclosing_scope_id]; + + for nested_symbol in self.symbol_tables[popped_scope_id].symbols() { + // Skip this symbol if this enclosing scope doesn't contain any bindings for it. + // Note that even if this symbol is bound in the popped scope, + // it may refer to the enclosing scope bindings + // so we also need to snapshot the bindings of the enclosing scope. + + let Some(enclosing_symbol_id) = + enclosing_symbol_table.symbol_id_by_name(nested_symbol.name()) + else { + continue; + }; + let enclosing_symbol = enclosing_symbol_table.symbol(enclosing_symbol_id); + + // Snapshot the state of this symbol that are visible at this point in this + // enclosing scope. + let key = EagerSnapshotKey { + enclosing_scope: enclosing_scope_id, + enclosing_symbol: enclosing_symbol_id, + nested_scope: popped_scope_id, + }; + let eager_snapshot = self.use_def_maps[enclosing_scope_id].snapshot_eager_state( + enclosing_symbol_id, + enclosing_scope_kind, + enclosing_symbol.is_bound(), + ); + self.eager_snapshots.insert(key, eager_snapshot); + } + + // Lazy scopes are "sticky": once we see a lazy scope we stop doing lookups + // eagerly, even if we would encounter another eager enclosing scope later on. + // Also, narrowing constraints outside a lazy scope are not applicable. + // TODO: If the symbol has never been rewritten, they are applicable. + if !enclosing_scope_kind.is_eager() { + break; + } + } + + popped_scope_id + } + + fn current_symbol_table(&mut self) -> &mut SymbolTableBuilder { + let scope_id = self.current_scope(); + &mut self.symbol_tables[scope_id] + } + + fn current_attribute_table(&mut self) -> &mut SymbolTableBuilder { + let scope_id = self.current_scope(); + &mut self.instance_attribute_tables[scope_id] + } + + fn current_use_def_map_mut(&mut self) -> &mut UseDefMapBuilder<'db> { + let scope_id = self.current_scope(); + &mut self.use_def_maps[scope_id] + } + + fn current_use_def_map(&self) -> &UseDefMapBuilder<'db> { + let scope_id = self.current_scope(); + &self.use_def_maps[scope_id] + } + + fn current_visibility_constraints_mut(&mut self) -> &mut VisibilityConstraintsBuilder { + let scope_id = self.current_scope(); + &mut self.use_def_maps[scope_id].visibility_constraints + } + + fn current_ast_ids(&mut self) -> &mut AstIdsBuilder { + let scope_id = self.current_scope(); + &mut self.ast_ids[scope_id] + } + + fn flow_snapshot(&self) -> FlowSnapshot { + self.current_use_def_map().snapshot() + } + + fn flow_restore(&mut self, state: FlowSnapshot) { + self.current_use_def_map_mut().restore(state); + } + + fn flow_merge(&mut self, state: FlowSnapshot) { + self.current_use_def_map_mut().merge(state); + } + + /// Add a symbol to the symbol table and the use-def map. + /// Return the [`ScopedSymbolId`] that uniquely identifies the symbol in both. + fn add_symbol(&mut self, name: Name) -> ScopedSymbolId { + let (symbol_id, added) = self.current_symbol_table().add_symbol(name); + if added { + self.current_use_def_map_mut().add_symbol(symbol_id); + } + symbol_id + } + + fn add_attribute(&mut self, name: Name) -> ScopedSymbolId { + let (symbol_id, added) = self.current_attribute_table().add_symbol(name); + if added { + self.current_use_def_map_mut().add_attribute(symbol_id); + } + symbol_id + } + + fn mark_symbol_bound(&mut self, id: ScopedSymbolId) { + self.current_symbol_table().mark_symbol_bound(id); + } + + fn mark_symbol_declared(&mut self, id: ScopedSymbolId) { + self.current_symbol_table().mark_symbol_declared(id); + } + + fn mark_symbol_used(&mut self, id: ScopedSymbolId) { + self.current_symbol_table().mark_symbol_used(id); + } + + fn add_entry_for_definition_key(&mut self, key: DefinitionNodeKey) -> &mut Definitions<'db> { + self.definitions_by_node.entry(key).or_default() + } + + /// Add a [`Definition`] associated with the `definition_node` AST node. + /// + /// ## Panics + /// + /// This method panics if `debug_assertions` are enabled and the `definition_node` AST node + /// already has a [`Definition`] associated with it. This is an important invariant to maintain + /// for all nodes *except* [`ast::Alias`] nodes representing `*` imports. + fn add_definition( + &mut self, + symbol: ScopedSymbolId, + definition_node: impl Into<DefinitionNodeRef<'db>> + std::fmt::Debug + Copy, + ) -> Definition<'db> { + let (definition, num_definitions) = + self.push_additional_definition(symbol, definition_node); + debug_assert_eq!( + num_definitions, 1, + "Attempted to create multiple `Definition`s associated with AST node {definition_node:?}" + ); + definition + } + + /// Push a new [`Definition`] onto the list of definitions + /// associated with the `definition_node` AST node. + /// + /// Returns a 2-element tuple, where the first element is the newly created [`Definition`] + /// and the second element is the number of definitions that are now associated with + /// `definition_node`. + /// + /// This method should only be used when adding a definition associated with a `*` import. + /// All other nodes can only ever be associated with exactly 1 or 0 [`Definition`]s. + /// For any node other than an [`ast::Alias`] representing a `*` import, + /// prefer to use `self.add_definition()`, which ensures that this invariant is maintained. + fn push_additional_definition( + &mut self, + symbol: ScopedSymbolId, + definition_node: impl Into<DefinitionNodeRef<'db>>, + ) -> (Definition<'db>, usize) { + let definition_node: DefinitionNodeRef<'_> = definition_node.into(); + #[expect(unsafe_code)] + // SAFETY: `definition_node` is guaranteed to be a child of `self.module` + let kind = unsafe { definition_node.into_owned(self.module.clone()) }; + let category = kind.category(self.source_type.is_stub()); + let is_reexported = kind.is_reexported(); + + let definition = Definition::new( + self.db, + self.file, + self.current_scope(), + symbol, + kind, + is_reexported, + countme::Count::default(), + ); + + let num_definitions = { + let definitions = self.add_entry_for_definition_key(definition_node.key()); + definitions.push(definition); + definitions.len() + }; + + if category.is_binding() { + self.mark_symbol_bound(symbol); + } + if category.is_declaration() { + self.mark_symbol_declared(symbol); + } + + let use_def = self.current_use_def_map_mut(); + match category { + DefinitionCategory::DeclarationAndBinding => { + use_def.record_declaration_and_binding(symbol, definition); + } + DefinitionCategory::Declaration => use_def.record_declaration(symbol, definition), + DefinitionCategory::Binding => use_def.record_binding(symbol, definition), + } + + let mut try_node_stack_manager = std::mem::take(&mut self.try_node_context_stack_manager); + try_node_stack_manager.record_definition(self); + self.try_node_context_stack_manager = try_node_stack_manager; + + (definition, num_definitions) + } + + fn add_attribute_definition( + &mut self, + symbol: ScopedSymbolId, + definition_kind: DefinitionKind<'db>, + ) -> Definition { + let definition = Definition::new( + self.db, + self.file, + self.current_scope(), + symbol, + definition_kind, + false, + countme::Count::default(), + ); + self.current_use_def_map_mut() + .record_attribute_binding(symbol, definition); + definition + } + + fn record_expression_narrowing_constraint( + &mut self, + precide_node: &ast::Expr, + ) -> Predicate<'db> { + let predicate = self.build_predicate(precide_node); + self.record_narrowing_constraint(predicate); + predicate + } + + fn build_predicate(&mut self, predicate_node: &ast::Expr) -> Predicate<'db> { + let expression = self.add_standalone_expression(predicate_node); + Predicate { + node: PredicateNode::Expression(expression), + is_positive: true, + } + } + + /// Adds a new predicate to the list of all predicates, but does not record it. Returns the + /// predicate ID for later recording using + /// [`SemanticIndexBuilder::record_narrowing_constraint_id`]. + fn add_predicate(&mut self, predicate: Predicate<'db>) -> ScopedPredicateId { + self.current_use_def_map_mut().add_predicate(predicate) + } + + /// Negates a predicate and adds it to the list of all predicates, does not record it. + fn add_negated_predicate(&mut self, predicate: Predicate<'db>) -> ScopedPredicateId { + self.current_use_def_map_mut() + .add_predicate(predicate.negated()) + } + + /// Records a previously added narrowing constraint by adding it to all live bindings. + fn record_narrowing_constraint_id(&mut self, predicate: ScopedPredicateId) { + self.current_use_def_map_mut() + .record_narrowing_constraint(predicate); + } + + /// Adds and records a narrowing constraint, i.e. adds it to all live bindings. + fn record_narrowing_constraint(&mut self, predicate: Predicate<'db>) { + let use_def = self.current_use_def_map_mut(); + let predicate_id = use_def.add_predicate(predicate); + use_def.record_narrowing_constraint(predicate_id); + } + + /// Negates the given predicate and then adds it as a narrowing constraint to all live + /// bindings. + fn record_negated_narrowing_constraint( + &mut self, + predicate: Predicate<'db>, + ) -> ScopedPredicateId { + let id = self.add_negated_predicate(predicate); + self.record_narrowing_constraint_id(id); + id + } + + /// Records a previously added visibility constraint by applying it to all live bindings + /// and declarations. + fn record_visibility_constraint_id(&mut self, constraint: ScopedVisibilityConstraintId) { + self.current_use_def_map_mut() + .record_visibility_constraint(constraint); + } + + /// Negates the given visibility constraint and then adds it to all live bindings and declarations. + fn record_negated_visibility_constraint( + &mut self, + constraint: ScopedVisibilityConstraintId, + ) -> ScopedVisibilityConstraintId { + let id = self + .current_visibility_constraints_mut() + .add_not_constraint(constraint); + self.record_visibility_constraint_id(id); + id + } + + /// Records a visibility constraint by applying it to all live bindings and declarations. + fn record_visibility_constraint( + &mut self, + predicate: Predicate<'db>, + ) -> ScopedVisibilityConstraintId { + let predicate_id = self.current_use_def_map_mut().add_predicate(predicate); + let id = self + .current_visibility_constraints_mut() + .add_atom(predicate_id); + self.record_visibility_constraint_id(id); + id + } + + /// Records that all remaining statements in the current block are unreachable, and therefore + /// not visible. + fn mark_unreachable(&mut self) { + self.current_use_def_map_mut().mark_unreachable(); + } + + /// Records a visibility constraint that always evaluates to "ambiguous". + fn record_ambiguous_visibility(&mut self) { + self.current_use_def_map_mut() + .record_visibility_constraint(ScopedVisibilityConstraintId::AMBIGUOUS); + } + + /// Simplifies (resets) visibility constraints on all live bindings and declarations that did + /// not see any new definitions since the given snapshot. + fn simplify_visibility_constraints(&mut self, snapshot: FlowSnapshot) { + self.current_use_def_map_mut() + .simplify_visibility_constraints(snapshot); + } + + /// Record a constraint that affects the reachability of the current position in the semantic + /// index analysis. For example, if we encounter a `if test:` branch, we immediately record + /// a `test` constraint, because if `test` later (during type checking) evaluates to `False`, + /// we know that all statements that follow in this path of control flow will be unreachable. + fn record_reachability_constraint( + &mut self, + predicate: Predicate<'db>, + ) -> ScopedVisibilityConstraintId { + let predicate_id = self.add_predicate(predicate); + self.record_reachability_constraint_id(predicate_id) + } + + /// Similar to [`Self::record_reachability_constraint`], but takes a [`ScopedPredicateId`]. + fn record_reachability_constraint_id( + &mut self, + predicate_id: ScopedPredicateId, + ) -> ScopedVisibilityConstraintId { + let visibility_constraint = self + .current_visibility_constraints_mut() + .add_atom(predicate_id); + self.current_use_def_map_mut() + .record_reachability_constraint(visibility_constraint); + visibility_constraint + } + + /// Record the negation of a given reachability/visibility constraint. + fn record_negated_reachability_constraint( + &mut self, + reachability_constraint: ScopedVisibilityConstraintId, + ) { + let negated_constraint = self + .current_visibility_constraints_mut() + .add_not_constraint(reachability_constraint); + self.current_use_def_map_mut() + .record_reachability_constraint(negated_constraint); + } + + fn push_assignment(&mut self, assignment: CurrentAssignment<'db>) { + self.current_assignments.push(assignment); + } + + fn pop_assignment(&mut self) { + let popped_assignment = self.current_assignments.pop(); + debug_assert!(popped_assignment.is_some()); + } + + fn current_assignment(&self) -> Option<CurrentAssignment<'db>> { + self.current_assignments.last().copied() + } + + fn current_assignment_mut(&mut self) -> Option<&mut CurrentAssignment<'db>> { + self.current_assignments.last_mut() + } + + /// Records the fact that we saw an attribute assignment of the form + /// `object.attr: <annotation>( = …)` or `object.attr = <value>`. + fn register_attribute_assignment( + &mut self, + object: &ast::Expr, + attr: &'db ast::Identifier, + definition_kind: DefinitionKind<'db>, + ) { + if self.is_method_of_class().is_some() { + // We only care about attribute assignments to the first parameter of a method, + // i.e. typically `self` or `cls`. + let accessed_object_refers_to_first_parameter = + object.as_name_expr().map(|name| name.id.as_str()) + == self.current_first_parameter_name; + + if accessed_object_refers_to_first_parameter { + let symbol = self.add_attribute(attr.id().clone()); + self.add_attribute_definition(symbol, definition_kind); + } + } + } + + fn predicate_kind(&mut self, pattern: &ast::Pattern) -> PatternPredicateKind<'db> { + match pattern { + ast::Pattern::MatchValue(pattern) => { + let value = self.add_standalone_expression(&pattern.value); + PatternPredicateKind::Value(value) + } + ast::Pattern::MatchSingleton(singleton) => { + PatternPredicateKind::Singleton(singleton.value) + } + ast::Pattern::MatchClass(pattern) => { + let cls = self.add_standalone_expression(&pattern.cls); + PatternPredicateKind::Class(cls) + } + ast::Pattern::MatchOr(pattern) => { + let predicates = pattern + .patterns + .iter() + .map(|pattern| self.predicate_kind(pattern)) + .collect(); + PatternPredicateKind::Or(predicates) + } + _ => PatternPredicateKind::Unsupported, + } + } + + fn add_pattern_narrowing_constraint( + &mut self, + subject: Expression<'db>, + pattern: &ast::Pattern, + guard: Option<&ast::Expr>, + ) -> Predicate<'db> { + // This is called for the top-level pattern of each match arm. We need to create a + // standalone expression for each arm of a match statement, since they can introduce + // constraints on the match subject. (Or more accurately, for the match arm's pattern, + // since its the pattern that introduces any constraints, not the body.) Ideally, that + // standalone expression would wrap the match arm's pattern as a whole. But a standalone + // expression can currently only wrap an ast::Expr, which patterns are not. So, we need to + // choose an Expr that can “stand in” for the pattern, which we can wrap in a standalone + // expression. + // + // See the comment in TypeInferenceBuilder::infer_match_pattern for more details. + + let kind = self.predicate_kind(pattern); + let guard = guard.map(|guard| self.add_standalone_expression(guard)); + + let pattern_predicate = PatternPredicate::new( + self.db, + self.file, + self.current_scope(), + subject, + kind, + guard, + countme::Count::default(), + ); + let predicate = Predicate { + node: PredicateNode::Pattern(pattern_predicate), + is_positive: true, + }; + self.record_narrowing_constraint(predicate); + predicate + } + + /// Record an expression that needs to be a Salsa ingredient, because we need to infer its type + /// standalone (type narrowing tests, RHS of an assignment.) + fn add_standalone_expression(&mut self, expression_node: &ast::Expr) -> Expression<'db> { + self.add_standalone_expression_impl(expression_node, ExpressionKind::Normal, None) + } + + /// Record an expression that is immediately assigned to a target, and that needs to be a Salsa + /// ingredient, because we need to infer its type standalone (type narrowing tests, RHS of an + /// assignment.) + fn add_standalone_assigned_expression( + &mut self, + expression_node: &ast::Expr, + assigned_to: &ast::StmtAssign, + ) -> Expression<'db> { + self.add_standalone_expression_impl( + expression_node, + ExpressionKind::Normal, + Some(assigned_to), + ) + } + + /// Same as [`SemanticIndexBuilder::add_standalone_expression`], but marks the expression as a + /// *type* expression, which makes sure that it will later be inferred as such. + fn add_standalone_type_expression(&mut self, expression_node: &ast::Expr) -> Expression<'db> { + self.add_standalone_expression_impl(expression_node, ExpressionKind::TypeExpression, None) + } + + fn add_standalone_expression_impl( + &mut self, + expression_node: &ast::Expr, + expression_kind: ExpressionKind, + assigned_to: Option<&ast::StmtAssign>, + ) -> Expression<'db> { + let expression = Expression::new( + self.db, + self.file, + self.current_scope(), + #[expect(unsafe_code)] + unsafe { + AstNodeRef::new(self.module.clone(), expression_node) + }, + #[expect(unsafe_code)] + assigned_to + .map(|assigned_to| unsafe { AstNodeRef::new(self.module.clone(), assigned_to) }), + expression_kind, + countme::Count::default(), + ); + self.expressions_by_node + .insert(expression_node.into(), expression); + expression + } + + fn with_type_params( + &mut self, + with_scope: NodeWithScopeRef, + type_params: Option<&'db ast::TypeParams>, + nested: impl FnOnce(&mut Self) -> FileScopeId, + ) -> FileScopeId { + if let Some(type_params) = type_params { + self.push_scope(with_scope); + + for type_param in &type_params.type_params { + let (name, bound, default) = match type_param { + ast::TypeParam::TypeVar(ast::TypeParamTypeVar { + range: _, + name, + bound, + default, + }) => (name, bound, default), + ast::TypeParam::ParamSpec(ast::TypeParamParamSpec { + name, default, .. + }) => (name, &None, default), + ast::TypeParam::TypeVarTuple(ast::TypeParamTypeVarTuple { + name, + default, + .. + }) => (name, &None, default), + }; + let symbol = self.add_symbol(name.id.clone()); + // TODO create Definition for PEP 695 typevars + // note that the "bound" on the typevar is a totally different thing than whether + // or not a name is "bound" by a typevar declaration; the latter is always true. + self.mark_symbol_bound(symbol); + self.mark_symbol_declared(symbol); + if let Some(bounds) = bound { + self.visit_expr(bounds); + } + if let Some(default) = default { + self.visit_expr(default); + } + match type_param { + ast::TypeParam::TypeVar(node) => self.add_definition(symbol, node), + ast::TypeParam::ParamSpec(node) => self.add_definition(symbol, node), + ast::TypeParam::TypeVarTuple(node) => self.add_definition(symbol, node), + }; + } + } + + let nested_scope = nested(self); + + if type_params.is_some() { + self.pop_scope(); + } + + nested_scope + } + + /// This method does several things: + /// - It pushes a new scope onto the stack for visiting + /// a list/dict/set comprehension or generator expression + /// - Inside that scope, it visits a list of [`Comprehension`] nodes, + /// assumed to be the "generators" that compose a comprehension + /// (that is, the `for x in y` and `for y in z` parts of `x for x in y for y in z`). + /// - Inside that scope, it also calls a closure for visiting the outer `elt` + /// of a list/dict/set comprehension or generator expression + /// - It then pops the new scope off the stack + /// + /// [`Comprehension`]: ast::Comprehension + fn with_generators_scope( + &mut self, + scope: NodeWithScopeRef, + generators: &'db [ast::Comprehension], + visit_outer_elt: impl FnOnce(&mut Self), + ) { + let mut generators_iter = generators.iter(); + + let Some(generator) = generators_iter.next() else { + unreachable!("Expression must contain at least one generator"); + }; + + // The `iter` of the first generator is evaluated in the outer scope, while all subsequent + // nodes are evaluated in the inner scope. + let value = self.add_standalone_expression(&generator.iter); + self.visit_expr(&generator.iter); + self.push_scope(scope); + + self.add_unpackable_assignment( + &Unpackable::Comprehension { + node: generator, + first: true, + }, + &generator.target, + value, + ); + + for expr in &generator.ifs { + self.visit_expr(expr); + } + + for generator in generators_iter { + let value = self.add_standalone_expression(&generator.iter); + self.visit_expr(&generator.iter); + + self.add_unpackable_assignment( + &Unpackable::Comprehension { + node: generator, + first: false, + }, + &generator.target, + value, + ); + + for expr in &generator.ifs { + self.visit_expr(expr); + } + } + + visit_outer_elt(self); + self.pop_scope(); + } + + fn declare_parameters(&mut self, parameters: &'db ast::Parameters) { + for parameter in parameters.iter_non_variadic_params() { + self.declare_parameter(parameter); + } + if let Some(vararg) = parameters.vararg.as_ref() { + let symbol = self.add_symbol(vararg.name.id().clone()); + self.add_definition( + symbol, + DefinitionNodeRef::VariadicPositionalParameter(vararg), + ); + } + if let Some(kwarg) = parameters.kwarg.as_ref() { + let symbol = self.add_symbol(kwarg.name.id().clone()); + self.add_definition(symbol, DefinitionNodeRef::VariadicKeywordParameter(kwarg)); + } + } + + fn declare_parameter(&mut self, parameter: &'db ast::ParameterWithDefault) { + let symbol = self.add_symbol(parameter.name().id().clone()); + + let definition = self.add_definition(symbol, parameter); + + // Insert a mapping from the inner Parameter node to the same definition. This + // ensures that calling `HasType::inferred_type` on the inner parameter returns + // a valid type (and doesn't panic) + let existing_definition = self.definitions_by_node.insert( + (¶meter.parameter).into(), + Definitions::single(definition), + ); + debug_assert_eq!(existing_definition, None); + } + + /// Add an unpackable assignment for the given [`Unpackable`]. + /// + /// This method handles assignments that can contain unpacking like assignment statements, + /// for statements, etc. + fn add_unpackable_assignment( + &mut self, + unpackable: &Unpackable<'db>, + target: &'db ast::Expr, + value: Expression<'db>, + ) { + // We only handle assignments to names and unpackings here, other targets like + // attribute and subscript are handled separately as they don't create a new + // definition. + + let current_assignment = match target { + ast::Expr::List(_) | ast::Expr::Tuple(_) => { + if matches!(unpackable, Unpackable::Comprehension { .. }) { + debug_assert_eq!( + self.scopes[self.current_scope()].node().scope_kind(), + ScopeKind::Comprehension + ); + } + // The first iterator of the comprehension is evaluated in the outer scope, while all subsequent + // nodes are evaluated in the inner scope. + // SAFETY: The current scope is the comprehension, and the comprehension scope must have a parent scope. + let value_file_scope = + if let Unpackable::Comprehension { first: true, .. } = unpackable { + self.scope_stack + .iter() + .rev() + .nth(1) + .expect("The comprehension scope must have a parent scope") + .file_scope_id + } else { + self.current_scope() + }; + let unpack = Some(Unpack::new( + self.db, + self.file, + value_file_scope, + self.current_scope(), + // SAFETY: `target` belongs to the `self.module` tree + #[expect(unsafe_code)] + unsafe { + AstNodeRef::new(self.module.clone(), target) + }, + UnpackValue::new(unpackable.kind(), value), + countme::Count::default(), + )); + Some(unpackable.as_current_assignment(unpack)) + } + ast::Expr::Name(_) | ast::Expr::Attribute(_) => { + Some(unpackable.as_current_assignment(None)) + } + _ => None, + }; + + if let Some(current_assignment) = current_assignment { + self.push_assignment(current_assignment); + } + + self.visit_expr(target); + + if current_assignment.is_some() { + // Only need to pop in the case where we pushed something + self.pop_assignment(); + } + } + + pub(super) fn build(mut self) -> SemanticIndex<'db> { + let module = self.module; + self.visit_body(module.suite()); + + // Pop the root scope + self.pop_scope(); + assert!(self.scope_stack.is_empty()); + + assert_eq!(&self.current_assignments, &[]); + + let mut symbol_tables: IndexVec<_, _> = self + .symbol_tables + .into_iter() + .map(|builder| Arc::new(builder.finish())) + .collect(); + + let mut instance_attribute_tables: IndexVec<_, _> = self + .instance_attribute_tables + .into_iter() + .map(SymbolTableBuilder::finish) + .collect(); + + let mut use_def_maps: IndexVec<_, _> = self + .use_def_maps + .into_iter() + .map(|builder| Arc::new(builder.finish())) + .collect(); + + let mut ast_ids: IndexVec<_, _> = self + .ast_ids + .into_iter() + .map(super::ast_ids::AstIdsBuilder::finish) + .collect(); + + self.scopes.shrink_to_fit(); + symbol_tables.shrink_to_fit(); + instance_attribute_tables.shrink_to_fit(); + use_def_maps.shrink_to_fit(); + ast_ids.shrink_to_fit(); + self.scopes_by_expression.shrink_to_fit(); + self.definitions_by_node.shrink_to_fit(); + + self.scope_ids_by_scope.shrink_to_fit(); + self.scopes_by_node.shrink_to_fit(); + self.generator_functions.shrink_to_fit(); + self.eager_snapshots.shrink_to_fit(); + self.globals_by_scope.shrink_to_fit(); + + SemanticIndex { + symbol_tables, + instance_attribute_tables, + scopes: self.scopes, + definitions_by_node: self.definitions_by_node, + expressions_by_node: self.expressions_by_node, + scope_ids_by_scope: self.scope_ids_by_scope, + globals_by_scope: self.globals_by_scope, + ast_ids, + scopes_by_expression: self.scopes_by_expression, + scopes_by_node: self.scopes_by_node, + use_def_maps, + imported_modules: Arc::new(self.imported_modules), + has_future_annotations: self.has_future_annotations, + eager_snapshots: self.eager_snapshots, + semantic_syntax_errors: self.semantic_syntax_errors.into_inner(), + generator_functions: self.generator_functions, + } + } + + fn with_semantic_checker(&mut self, f: impl FnOnce(&mut SemanticSyntaxChecker, &Self)) { + let mut checker = std::mem::take(&mut self.semantic_checker); + f(&mut checker, self); + self.semantic_checker = checker; + } + + fn source_text(&self) -> &SourceText { + self.source_text + .get_or_init(|| source_text(self.db.upcast(), self.file)) + } +} + +impl<'db, 'ast> Visitor<'ast> for SemanticIndexBuilder<'db> +where + 'ast: 'db, +{ + fn visit_stmt(&mut self, stmt: &'ast ast::Stmt) { + self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context)); + + match stmt { + ast::Stmt::FunctionDef(function_def) => { + let ast::StmtFunctionDef { + decorator_list, + parameters, + type_params, + name, + returns, + body, + is_async: _, + range: _, + } = function_def; + for decorator in decorator_list { + self.visit_decorator(decorator); + } + + self.with_type_params( + NodeWithScopeRef::FunctionTypeParameters(function_def), + type_params.as_deref(), + |builder| { + builder.visit_parameters(parameters); + if let Some(returns) = returns { + builder.visit_annotation(returns); + } + + builder.push_scope(NodeWithScopeRef::Function(function_def)); + + builder.declare_parameters(parameters); + + let mut first_parameter_name = parameters + .iter_non_variadic_params() + .next() + .map(|first_param| first_param.parameter.name.id().as_str()); + std::mem::swap( + &mut builder.current_first_parameter_name, + &mut first_parameter_name, + ); + + // TODO: Fix how we determine the public types of symbols in a + // function-like scope: https://github.com/astral-sh/ruff/issues/15777 + // + // In the meantime, visit the function body, but treat the last statement + // specially if it is a return. If it is, this would cause all definitions + // in the function to be marked as non-visible with our current treatment + // of terminal statements. Since we currently model the externally visible + // definitions in a function scope as the set of bindings that are visible + // at the end of the body, we then consider this function to have no + // externally visible definitions. To get around this, we take a flow + // snapshot just before processing the return statement, and use _that_ as + // the "end-of-body" state that we resolve external references against. + if let Some((last_stmt, first_stmts)) = body.split_last() { + builder.visit_body(first_stmts); + let pre_return_state = matches!(last_stmt, ast::Stmt::Return(_)) + .then(|| builder.flow_snapshot()); + builder.visit_stmt(last_stmt); + let scope_start_visibility = + builder.current_use_def_map().scope_start_visibility; + if let Some(pre_return_state) = pre_return_state { + builder.flow_restore(pre_return_state); + builder.current_use_def_map_mut().scope_start_visibility = + scope_start_visibility; + } + } + + builder.current_first_parameter_name = first_parameter_name; + builder.pop_scope() + }, + ); + // The default value of the parameters needs to be evaluated in the + // enclosing scope. + for default in parameters + .iter_non_variadic_params() + .filter_map(|param| param.default.as_deref()) + { + self.visit_expr(default); + } + // The symbol for the function name itself has to be evaluated + // at the end to match the runtime evaluation of parameter defaults + // and return-type annotations. + let symbol = self.add_symbol(name.id.clone()); + + // Record a use of the function name in the scope that it is defined in, so that it + // can be used to find previously defined functions with the same name. This is + // used to collect all the overloaded definitions of a function. This needs to be + // done on the `Identifier` node as opposed to `ExprName` because that's what the + // AST uses. + self.mark_symbol_used(symbol); + let use_id = self.current_ast_ids().record_use(name); + self.current_use_def_map_mut() + .record_use(symbol, use_id, NodeKey::from_node(name)); + + self.add_definition(symbol, function_def); + } + ast::Stmt::ClassDef(class) => { + for decorator in &class.decorator_list { + self.visit_decorator(decorator); + } + + self.with_type_params( + NodeWithScopeRef::ClassTypeParameters(class), + class.type_params.as_deref(), + |builder| { + if let Some(arguments) = &class.arguments { + builder.visit_arguments(arguments); + } + + builder.push_scope(NodeWithScopeRef::Class(class)); + builder.visit_body(&class.body); + + builder.pop_scope() + }, + ); + + // In Python runtime semantics, a class is registered after its scope is evaluated. + let symbol = self.add_symbol(class.name.id.clone()); + self.add_definition(symbol, class); + } + ast::Stmt::TypeAlias(type_alias) => { + let symbol = self.add_symbol( + type_alias + .name + .as_name_expr() + .map(|name| name.id.clone()) + .unwrap_or("<unknown>".into()), + ); + self.add_definition(symbol, type_alias); + self.visit_expr(&type_alias.name); + + self.with_type_params( + NodeWithScopeRef::TypeAliasTypeParameters(type_alias), + type_alias.type_params.as_deref(), + |builder| { + builder.push_scope(NodeWithScopeRef::TypeAlias(type_alias)); + builder.visit_expr(&type_alias.value); + builder.pop_scope() + }, + ); + } + ast::Stmt::Import(node) => { + self.current_use_def_map_mut() + .record_node_reachability(NodeKey::from_node(node)); + + for (alias_index, alias) in node.names.iter().enumerate() { + // Mark the imported module, and all of its parents, as being imported in this + // file. + if let Some(module_name) = ModuleName::new(&alias.name) { + self.imported_modules.extend(module_name.ancestors()); + } + + let (symbol_name, is_reexported) = if let Some(asname) = &alias.asname { + (asname.id.clone(), asname.id == alias.name.id) + } else { + (Name::new(alias.name.id.split('.').next().unwrap()), false) + }; + + let symbol = self.add_symbol(symbol_name); + self.add_definition( + symbol, + ImportDefinitionNodeRef { + node, + alias_index, + is_reexported, + }, + ); + } + } + ast::Stmt::ImportFrom(node) => { + self.current_use_def_map_mut() + .record_node_reachability(NodeKey::from_node(node)); + + let mut found_star = false; + for (alias_index, alias) in node.names.iter().enumerate() { + if &alias.name == "*" { + // The following line maintains the invariant that every AST node that + // implements `Into<DefinitionNodeKey>` must have an entry in the + // `definitions_by_node` map. Maintaining this invariant ensures that + // `SemanticIndex::definitions` can always look up the definitions for a + // given AST node without panicking. + // + // The reason why maintaining this invariant requires special handling here + // is that some `Alias` nodes may be associated with 0 definitions: + // - If the import statement has invalid syntax: multiple `*` names in the `names` list + // (e.g. `from foo import *, bar, *`) + // - If the `*` import refers to a module that has 0 exported names. + // - If the module being imported from cannot be resolved. + self.add_entry_for_definition_key(alias.into()); + + if found_star { + continue; + } + + found_star = true; + + // Wildcard imports are invalid syntax everywhere except the top-level scope, + // and thus do not bind any definitions anywhere else + if !self.in_module_scope() { + continue; + } + + let Ok(module_name) = + ModuleName::from_import_statement(self.db, self.file, node) + else { + continue; + }; + + let Some(module) = resolve_module(self.db, &module_name) else { + continue; + }; + + let Some(referenced_module) = module.file() else { + continue; + }; + + // In order to understand the visibility of definitions created by a `*` import, + // we need to know the visibility of the global-scope definitions in the + // `referenced_module` the symbols imported from. Much like predicates for `if` + // statements can only have their visibility constraints resolved at type-inference + // time, the visibility of these global-scope definitions in the external module + // cannot be resolved at this point. As such, we essentially model each definition + // stemming from a `from exporter *` import as something like: + // + // ```py + // if <external_definition_is_visible>: + // from exporter import name + // ``` + // + // For more details, see the doc-comment on `StarImportPlaceholderPredicate`. + for export in exported_names(self.db, referenced_module) { + let symbol_id = self.add_symbol(export.clone()); + let node_ref = StarImportDefinitionNodeRef { node, symbol_id }; + let star_import = StarImportPlaceholderPredicate::new( + self.db, + self.file, + symbol_id, + referenced_module, + ); + + let pre_definition = + self.current_use_def_map().single_symbol_snapshot(symbol_id); + self.push_additional_definition(symbol_id, node_ref); + self.current_use_def_map_mut() + .record_and_negate_star_import_visibility_constraint( + star_import, + symbol_id, + pre_definition, + ); + } + + continue; + } + + let (symbol_name, is_reexported) = if let Some(asname) = &alias.asname { + (&asname.id, asname.id == alias.name.id) + } else { + (&alias.name.id, false) + }; + + // Look for imports `from __future__ import annotations`, ignore `as ...` + // We intentionally don't enforce the rules about location of `__future__` + // imports here, we assume the user's intent was to apply the `__future__` + // import, so we still check using it (and will also emit a diagnostic about a + // miss-placed `__future__` import.) + self.has_future_annotations |= alias.name.id == "annotations" + && node.module.as_deref() == Some("__future__"); + + let symbol = self.add_symbol(symbol_name.clone()); + + self.add_definition( + symbol, + ImportFromDefinitionNodeRef { + node, + alias_index, + is_reexported, + }, + ); + } + } + + ast::Stmt::Assert(ast::StmtAssert { + test, + msg, + range: _, + }) => { + // We model an `assert test, msg` statement here. Conceptually, we can think of + // this as being equivalent to the following: + // + // ```py + // if not test: + // msg + // <halt> + // + // <whatever code comes after> + // ``` + // + // Importantly, the `msg` expression is only evaluated if the `test` expression is + // falsy. This is why we apply the negated `test` predicate as a narrowing and + // reachability constraint on the `msg` expression. + // + // The other important part is the `<halt>`. This lets us skip the usual merging of + // flow states and simplification of visibility constraints, since there is no way + // of getting out of that `msg` branch. We simply restore to the post-test state. + + self.visit_expr(test); + let predicate = self.build_predicate(test); + + if let Some(msg) = msg { + let post_test = self.flow_snapshot(); + let negated_predicate = predicate.negated(); + self.record_narrowing_constraint(negated_predicate); + self.record_reachability_constraint(negated_predicate); + self.visit_expr(msg); + self.record_visibility_constraint(negated_predicate); + self.flow_restore(post_test); + } + + self.record_narrowing_constraint(predicate); + self.record_visibility_constraint(predicate); + self.record_reachability_constraint(predicate); + } + + ast::Stmt::Assign(node) => { + debug_assert_eq!(&self.current_assignments, &[]); + + self.visit_expr(&node.value); + let value = self.add_standalone_assigned_expression(&node.value, node); + + for target in &node.targets { + self.add_unpackable_assignment(&Unpackable::Assign(node), target, value); + } + } + ast::Stmt::AnnAssign(node) => { + debug_assert_eq!(&self.current_assignments, &[]); + self.visit_expr(&node.annotation); + if let Some(value) = &node.value { + self.visit_expr(value); + } + + // See https://docs.python.org/3/library/ast.html#ast.AnnAssign + if matches!( + *node.target, + ast::Expr::Attribute(_) | ast::Expr::Subscript(_) | ast::Expr::Name(_) + ) { + self.push_assignment(node.into()); + self.visit_expr(&node.target); + self.pop_assignment(); + } else { + self.visit_expr(&node.target); + } + } + ast::Stmt::AugAssign( + aug_assign @ ast::StmtAugAssign { + range: _, + target, + op, + value, + }, + ) => { + debug_assert_eq!(&self.current_assignments, &[]); + self.visit_expr(value); + + match &**target { + ast::Expr::Name(ast::ExprName { id, .. }) + if id == "__all__" && op.is_add() && self.in_module_scope() => + { + if let ast::Expr::Attribute(ast::ExprAttribute { value, attr, .. }) = + &**value + { + if attr == "__all__" { + self.add_standalone_expression(value); + } + } + + self.push_assignment(aug_assign.into()); + self.visit_expr(target); + self.pop_assignment(); + } + ast::Expr::Name(_) | ast::Expr::Attribute(_) | ast::Expr::Subscript(_) => { + self.push_assignment(aug_assign.into()); + self.visit_expr(target); + self.pop_assignment(); + } + _ => { + self.visit_expr(target); + } + } + } + ast::Stmt::If(node) => { + self.visit_expr(&node.test); + let mut no_branch_taken = self.flow_snapshot(); + let mut last_predicate = self.record_expression_narrowing_constraint(&node.test); + let mut reachability_constraint = + self.record_reachability_constraint(last_predicate); + self.visit_body(&node.body); + + let visibility_constraint_id = self.record_visibility_constraint(last_predicate); + let mut vis_constraints = vec![visibility_constraint_id]; + + let mut post_clauses: Vec<FlowSnapshot> = vec![]; + let elif_else_clauses = node + .elif_else_clauses + .iter() + .map(|clause| (clause.test.as_ref(), clause.body.as_slice())); + let has_else = node + .elif_else_clauses + .last() + .is_some_and(|clause| clause.test.is_none()); + let elif_else_clauses = elif_else_clauses.chain(if has_else { + // if there's an `else` clause already, we don't need to add another + None + } else { + // if there's no `else` branch, we should add a no-op `else` branch + Some((None, Default::default())) + }); + for (clause_test, clause_body) in elif_else_clauses { + // snapshot after every block except the last; the last one will just become + // the state that we merge the other snapshots into + post_clauses.push(self.flow_snapshot()); + // we can only take an elif/else branch if none of the previous ones were + // taken + self.flow_restore(no_branch_taken.clone()); + self.record_negated_narrowing_constraint(last_predicate); + self.record_negated_reachability_constraint(reachability_constraint); + + let elif_predicate = if let Some(elif_test) = clause_test { + self.visit_expr(elif_test); + // A test expression is evaluated whether the branch is taken or not + no_branch_taken = self.flow_snapshot(); + reachability_constraint = + self.record_reachability_constraint(last_predicate); + let predicate = self.record_expression_narrowing_constraint(elif_test); + Some(predicate) + } else { + None + }; + + self.visit_body(clause_body); + + for id in &vis_constraints { + self.record_negated_visibility_constraint(*id); + } + if let Some(elif_predicate) = elif_predicate { + last_predicate = elif_predicate; + let id = self.record_visibility_constraint(elif_predicate); + vis_constraints.push(id); + } + } + + for post_clause_state in post_clauses { + self.flow_merge(post_clause_state); + } + + self.simplify_visibility_constraints(no_branch_taken); + } + ast::Stmt::While(ast::StmtWhile { + test, + body, + orelse, + range: _, + }) => { + self.visit_expr(test); + + let pre_loop = self.flow_snapshot(); + let predicate = self.record_expression_narrowing_constraint(test); + self.record_reachability_constraint(predicate); + + // We need multiple copies of the visibility constraint for the while condition, + // since we need to model situations where the first evaluation of the condition + // returns True, but a later evaluation returns False. + let first_predicate_id = self.current_use_def_map_mut().add_predicate(predicate); + let later_predicate_id = self.current_use_def_map_mut().add_predicate(predicate); + let first_vis_constraint_id = self + .current_visibility_constraints_mut() + .add_atom(first_predicate_id); + let later_vis_constraint_id = self + .current_visibility_constraints_mut() + .add_atom(later_predicate_id); + + let outer_loop = self.push_loop(); + self.visit_body(body); + let this_loop = self.pop_loop(outer_loop); + + // If the body is executed, we know that we've evaluated the condition at least + // once, and that the first evaluation was True. We might not have evaluated the + // condition more than once, so we can't assume that later evaluations were True. + // So the body's full visibility constraint is `first`. + let body_vis_constraint_id = first_vis_constraint_id; + self.record_visibility_constraint_id(body_vis_constraint_id); + + // We execute the `else` once the condition evaluates to false. This could happen + // without ever executing the body, if the condition is false the first time it's + // tested. So the starting flow state of the `else` clause is the union of: + // - the pre-loop state with a visibility constraint that the first evaluation of + // the while condition was false, + // - the post-body state (which already has a visibility constraint that the + // first evaluation was true) with a visibility constraint that a _later_ + // evaluation of the while condition was false. + // To model this correctly, we need two copies of the while condition constraint, + // since the first and later evaluations might produce different results. + let post_body = self.flow_snapshot(); + self.flow_restore(pre_loop.clone()); + self.record_negated_visibility_constraint(first_vis_constraint_id); + self.flow_merge(post_body); + self.record_negated_narrowing_constraint(predicate); + self.visit_body(orelse); + self.record_negated_visibility_constraint(later_vis_constraint_id); + + // Breaking out of a while loop bypasses the `else` clause, so merge in the break + // states after visiting `else`. + for break_state in this_loop.break_states { + let snapshot = self.flow_snapshot(); + self.flow_restore(break_state); + self.record_visibility_constraint_id(body_vis_constraint_id); + self.flow_merge(snapshot); + } + + self.simplify_visibility_constraints(pre_loop); + } + ast::Stmt::With(ast::StmtWith { + items, + body, + is_async, + .. + }) => { + for item @ ast::WithItem { + range: _, + context_expr, + optional_vars, + } in items + { + self.visit_expr(context_expr); + if let Some(optional_vars) = optional_vars.as_deref() { + let context_manager = self.add_standalone_expression(context_expr); + self.add_unpackable_assignment( + &Unpackable::WithItem { + item, + is_async: *is_async, + }, + optional_vars, + context_manager, + ); + } + } + self.visit_body(body); + } + + ast::Stmt::For( + for_stmt @ ast::StmtFor { + range: _, + is_async: _, + target, + iter, + body, + orelse, + }, + ) => { + debug_assert_eq!(&self.current_assignments, &[]); + + let iter_expr = self.add_standalone_expression(iter); + self.visit_expr(iter); + + self.record_ambiguous_visibility(); + + let pre_loop = self.flow_snapshot(); + + self.add_unpackable_assignment(&Unpackable::For(for_stmt), target, iter_expr); + + let outer_loop = self.push_loop(); + self.visit_body(body); + let this_loop = self.pop_loop(outer_loop); + + // We may execute the `else` clause without ever executing the body, so merge in + // the pre-loop state before visiting `else`. + self.flow_merge(pre_loop); + self.visit_body(orelse); + + // Breaking out of a `for` loop bypasses the `else` clause, so merge in the break + // states after visiting `else`. + for break_state in this_loop.break_states { + self.flow_merge(break_state); + } + } + ast::Stmt::Match(ast::StmtMatch { + subject, + cases, + range: _, + }) => { + debug_assert_eq!(self.current_match_case, None); + + let subject_expr = self.add_standalone_expression(subject); + self.visit_expr(subject); + if cases.is_empty() { + return; + } + + let mut no_case_matched = self.flow_snapshot(); + + let has_catchall = cases + .last() + .is_some_and(|case| case.guard.is_none() && case.pattern.is_wildcard()); + + let mut post_case_snapshots = vec![]; + let mut match_predicate; + + for (i, case) in cases.iter().enumerate() { + self.current_match_case = Some(CurrentMatchCase::new(&case.pattern)); + self.visit_pattern(&case.pattern); + self.current_match_case = None; + // unlike in [Stmt::If], we don't reset [no_case_matched] + // here because the effects of visiting a pattern is binding + // symbols, and this doesn't occur unless the pattern + // actually matches + match_predicate = self.add_pattern_narrowing_constraint( + subject_expr, + &case.pattern, + case.guard.as_deref(), + ); + let vis_constraint_id = self.record_reachability_constraint(match_predicate); + + let match_success_guard_failure = case.guard.as_ref().map(|guard| { + let guard_expr = self.add_standalone_expression(guard); + self.visit_expr(guard); + let post_guard_eval = self.flow_snapshot(); + let predicate = Predicate { + node: PredicateNode::Expression(guard_expr), + is_positive: true, + }; + self.record_negated_narrowing_constraint(predicate); + let match_success_guard_failure = self.flow_snapshot(); + self.flow_restore(post_guard_eval); + self.record_narrowing_constraint(predicate); + match_success_guard_failure + }); + + self.record_visibility_constraint_id(vis_constraint_id); + + self.visit_body(&case.body); + + post_case_snapshots.push(self.flow_snapshot()); + + if i != cases.len() - 1 || !has_catchall { + // We need to restore the state after each case, but not after the last + // one. The last one will just become the state that we merge the other + // snapshots into. + self.flow_restore(no_case_matched.clone()); + self.record_negated_narrowing_constraint(match_predicate); + if let Some(match_success_guard_failure) = match_success_guard_failure { + self.flow_merge(match_success_guard_failure); + } else { + assert!(case.guard.is_none()); + } + } else { + debug_assert!(match_success_guard_failure.is_none()); + debug_assert!(case.guard.is_none()); + } + + self.record_negated_visibility_constraint(vis_constraint_id); + no_case_matched = self.flow_snapshot(); + } + + for post_clause_state in post_case_snapshots { + self.flow_merge(post_clause_state); + } + + self.simplify_visibility_constraints(no_case_matched); + } + ast::Stmt::Try(ast::StmtTry { + body, + handlers, + orelse, + finalbody, + is_star, + range: _, + }) => { + self.record_ambiguous_visibility(); + + // Save the state prior to visiting any of the `try` block. + // + // Potentially none of the `try` block could have been executed prior to executing + // the `except` block(s) and/or the `finally` block. + // We will merge this state with all of the intermediate + // states during the `try` block before visiting those suites. + let pre_try_block_state = self.flow_snapshot(); + + self.try_node_context_stack_manager.push_context(); + + // Visit the `try` block! + self.visit_body(body); + + let mut post_except_states = vec![]; + + // Take a record also of all the intermediate states we encountered + // while visiting the `try` block + let try_block_snapshots = self.try_node_context_stack_manager.pop_context(); + + if !handlers.is_empty() { + // Save the state immediately *after* visiting the `try` block + // but *before* we prepare for visiting the `except` block(s). + // + // We will revert to this state prior to visiting the `else` block, + // as there necessarily must have been 0 `except` blocks executed + // if we hit the `else` block. + let post_try_block_state = self.flow_snapshot(); + + // Prepare for visiting the `except` block(s) + self.flow_restore(pre_try_block_state); + for state in try_block_snapshots { + self.flow_merge(state); + } + + let pre_except_state = self.flow_snapshot(); + let num_handlers = handlers.len(); + + for (i, except_handler) in handlers.iter().enumerate() { + let ast::ExceptHandler::ExceptHandler(except_handler) = except_handler; + let ast::ExceptHandlerExceptHandler { + name: symbol_name, + type_: handled_exceptions, + body: handler_body, + range: _, + } = except_handler; + + if let Some(handled_exceptions) = handled_exceptions { + self.visit_expr(handled_exceptions); + } + + // If `handled_exceptions` above was `None`, it's something like `except as e:`, + // which is invalid syntax. However, it's still pretty obvious here that the user + // *wanted* `e` to be bound, so we should still create a definition here nonetheless. + if let Some(symbol_name) = symbol_name { + let symbol = self.add_symbol(symbol_name.id.clone()); + + self.add_definition( + symbol, + DefinitionNodeRef::ExceptHandler(ExceptHandlerDefinitionNodeRef { + handler: except_handler, + is_star: *is_star, + }), + ); + } + + self.visit_body(handler_body); + // Each `except` block is mutually exclusive with all other `except` blocks. + post_except_states.push(self.flow_snapshot()); + + // It's unnecessary to do the `self.flow_restore()` call for the final except handler, + // as we'll immediately call `self.flow_restore()` to a different state + // as soon as this loop over the handlers terminates. + if i < (num_handlers - 1) { + self.flow_restore(pre_except_state.clone()); + } + } + + // If we get to the `else` block, we know that 0 of the `except` blocks can have been executed, + // and the entire `try` block must have been executed: + self.flow_restore(post_try_block_state); + } + + self.visit_body(orelse); + + for post_except_state in post_except_states { + self.flow_merge(post_except_state); + } + + // TODO: there's lots of complexity here that isn't yet handled by our model. + // In order to accurately model the semantics of `finally` suites, we in fact need to visit + // the suite twice: once under the (current) assumption that either the `try + else` suite + // ran to completion or exactly one `except` branch ran to completion, and then again under + // the assumption that potentially none of the branches ran to completion and we in fact + // jumped from a `try`, `else` or `except` branch straight into the `finally` branch. + // This requires rethinking some fundamental assumptions semantic indexing makes. + // For more details, see: + // - https://astral-sh.notion.site/Exception-handler-control-flow-11348797e1ca80bb8ce1e9aedbbe439d + // - https://github.com/astral-sh/ruff/pull/13633#discussion_r1788626702 + self.visit_body(finalbody); + } + + ast::Stmt::Raise(_) | ast::Stmt::Return(_) | ast::Stmt::Continue(_) => { + walk_stmt(self, stmt); + // Everything in the current block after a terminal statement is unreachable. + self.mark_unreachable(); + } + + ast::Stmt::Break(_) => { + let snapshot = self.flow_snapshot(); + if let Some(current_loop) = self.current_loop_mut() { + current_loop.push_break(snapshot); + } + // Everything in the current block after a terminal statement is unreachable. + self.mark_unreachable(); + } + ast::Stmt::Global(ast::StmtGlobal { range: _, names }) => { + for name in names { + let symbol_id = self.add_symbol(name.id.clone()); + let symbol_table = self.current_symbol_table(); + let symbol = symbol_table.symbol(symbol_id); + if symbol.is_bound() || symbol.is_declared() || symbol.is_used() { + self.report_semantic_error(SemanticSyntaxError { + kind: SemanticSyntaxErrorKind::LoadBeforeGlobalDeclaration { + name: name.to_string(), + start: name.range.start(), + }, + range: name.range, + python_version: self.python_version, + }); + } + let scope_id = self.current_scope(); + self.globals_by_scope + .entry(scope_id) + .or_default() + .insert(symbol_id); + } + walk_stmt(self, stmt); + } + ast::Stmt::Delete(ast::StmtDelete { targets, range: _ }) => { + for target in targets { + if let ast::Expr::Name(ast::ExprName { id, .. }) = target { + let symbol_id = self.add_symbol(id.clone()); + self.current_symbol_table().mark_symbol_used(symbol_id); + } + } + walk_stmt(self, stmt); + } + ast::Stmt::Expr(ast::StmtExpr { value, range: _ }) if self.in_module_scope() => { + if let Some(expr) = dunder_all_extend_argument(value) { + self.add_standalone_expression(expr); + } + self.visit_expr(value); + } + _ => { + walk_stmt(self, stmt); + } + } + } + + fn visit_expr(&mut self, expr: &'ast ast::Expr) { + self.with_semantic_checker(|semantic, context| semantic.visit_expr(expr, context)); + + self.scopes_by_expression + .insert(expr.into(), self.current_scope()); + self.current_ast_ids().record_expression(expr); + + let node_key = NodeKey::from_node(expr); + + match expr { + ast::Expr::Name(ast::ExprName { id, ctx, .. }) => { + let (is_use, is_definition) = match (ctx, self.current_assignment()) { + (ast::ExprContext::Store, Some(CurrentAssignment::AugAssign(_))) => { + // For augmented assignment, the target expression is also used. + (true, true) + } + (ast::ExprContext::Load, _) => (true, false), + (ast::ExprContext::Store, _) => (false, true), + (ast::ExprContext::Del, _) => (false, true), + (ast::ExprContext::Invalid, _) => (false, false), + }; + let symbol = self.add_symbol(id.clone()); + + if is_use { + self.mark_symbol_used(symbol); + let use_id = self.current_ast_ids().record_use(expr); + self.current_use_def_map_mut() + .record_use(symbol, use_id, node_key); + } + + if is_definition { + match self.current_assignment() { + Some(CurrentAssignment::Assign { node, unpack }) => { + self.add_definition( + symbol, + AssignmentDefinitionNodeRef { + unpack, + value: &node.value, + target: expr, + }, + ); + } + Some(CurrentAssignment::AnnAssign(ann_assign)) => { + self.add_definition( + symbol, + AnnotatedAssignmentDefinitionNodeRef { + node: ann_assign, + annotation: &ann_assign.annotation, + value: ann_assign.value.as_deref(), + target: expr, + }, + ); + } + Some(CurrentAssignment::AugAssign(aug_assign)) => { + self.add_definition(symbol, aug_assign); + } + Some(CurrentAssignment::For { node, unpack }) => { + self.add_definition( + symbol, + ForStmtDefinitionNodeRef { + unpack, + iterable: &node.iter, + target: expr, + is_async: node.is_async, + }, + ); + } + Some(CurrentAssignment::Named(named)) => { + // TODO(dhruvmanila): If the current scope is a comprehension, then the + // named expression is implicitly nonlocal. This is yet to be + // implemented. + self.add_definition(symbol, named); + } + Some(CurrentAssignment::Comprehension { + unpack, + node, + first, + }) => { + self.add_definition( + symbol, + ComprehensionDefinitionNodeRef { + unpack, + iterable: &node.iter, + target: expr, + first, + is_async: node.is_async, + }, + ); + } + Some(CurrentAssignment::WithItem { + item, + is_async, + unpack, + }) => { + self.add_definition( + symbol, + WithItemDefinitionNodeRef { + unpack, + context_expr: &item.context_expr, + target: expr, + is_async, + }, + ); + } + None => {} + } + } + + if let Some(unpack_position) = self + .current_assignment_mut() + .and_then(CurrentAssignment::unpack_position_mut) + { + *unpack_position = UnpackPosition::Other; + } + + walk_expr(self, expr); + } + ast::Expr::Named(node) => { + // TODO walrus in comprehensions is implicitly nonlocal + self.visit_expr(&node.value); + + // See https://peps.python.org/pep-0572/#differences-between-assignment-expressions-and-assignment-statements + if node.target.is_name_expr() { + self.push_assignment(node.into()); + self.visit_expr(&node.target); + self.pop_assignment(); + } else { + self.visit_expr(&node.target); + } + } + ast::Expr::Lambda(lambda) => { + if let Some(parameters) = &lambda.parameters { + // The default value of the parameters needs to be evaluated in the + // enclosing scope. + for default in parameters + .iter_non_variadic_params() + .filter_map(|param| param.default.as_deref()) + { + self.visit_expr(default); + } + self.visit_parameters(parameters); + } + self.push_scope(NodeWithScopeRef::Lambda(lambda)); + + // Add symbols and definitions for the parameters to the lambda scope. + if let Some(parameters) = lambda.parameters.as_ref() { + self.declare_parameters(parameters); + } + + self.visit_expr(lambda.body.as_ref()); + self.pop_scope(); + } + ast::Expr::If(ast::ExprIf { + body, test, orelse, .. + }) => { + self.visit_expr(test); + let pre_if = self.flow_snapshot(); + let predicate = self.record_expression_narrowing_constraint(test); + let reachability_constraint = self.record_reachability_constraint(predicate); + self.visit_expr(body); + let visibility_constraint = self.record_visibility_constraint(predicate); + let post_body = self.flow_snapshot(); + self.flow_restore(pre_if.clone()); + + self.record_negated_narrowing_constraint(predicate); + self.record_negated_reachability_constraint(reachability_constraint); + self.visit_expr(orelse); + self.record_negated_visibility_constraint(visibility_constraint); + self.flow_merge(post_body); + self.simplify_visibility_constraints(pre_if); + } + ast::Expr::ListComp( + list_comprehension @ ast::ExprListComp { + elt, generators, .. + }, + ) => { + self.with_generators_scope( + NodeWithScopeRef::ListComprehension(list_comprehension), + generators, + |builder| builder.visit_expr(elt), + ); + } + ast::Expr::SetComp( + set_comprehension @ ast::ExprSetComp { + elt, generators, .. + }, + ) => { + self.with_generators_scope( + NodeWithScopeRef::SetComprehension(set_comprehension), + generators, + |builder| builder.visit_expr(elt), + ); + } + ast::Expr::Generator( + generator @ ast::ExprGenerator { + elt, generators, .. + }, + ) => { + self.with_generators_scope( + NodeWithScopeRef::GeneratorExpression(generator), + generators, + |builder| builder.visit_expr(elt), + ); + } + ast::Expr::DictComp( + dict_comprehension @ ast::ExprDictComp { + key, + value, + generators, + .. + }, + ) => { + self.with_generators_scope( + NodeWithScopeRef::DictComprehension(dict_comprehension), + generators, + |builder| { + builder.visit_expr(key); + builder.visit_expr(value); + }, + ); + } + ast::Expr::BoolOp(ast::ExprBoolOp { + values, + range: _, + op, + }) => { + let pre_op = self.flow_snapshot(); + + let mut snapshots = vec![]; + let mut visibility_constraints = vec![]; + + for (index, value) in values.iter().enumerate() { + self.visit_expr(value); + + for vid in &visibility_constraints { + self.record_visibility_constraint_id(*vid); + } + + // For the last value, we don't need to model control flow. There is no short-circuiting + // anymore. + if index < values.len() - 1 { + let predicate = self.build_predicate(value); + let predicate_id = match op { + ast::BoolOp::And => self.add_predicate(predicate), + ast::BoolOp::Or => self.add_negated_predicate(predicate), + }; + let visibility_constraint = self + .current_visibility_constraints_mut() + .add_atom(predicate_id); + + let after_expr = self.flow_snapshot(); + + // We first model the short-circuiting behavior. We take the short-circuit + // path here if all of the previous short-circuit paths were not taken, so + // we record all previously existing visibility constraints, and negate the + // one for the current expression. + for vid in &visibility_constraints { + self.record_visibility_constraint_id(*vid); + } + self.record_negated_visibility_constraint(visibility_constraint); + snapshots.push(self.flow_snapshot()); + + // Then we model the non-short-circuiting behavior. Here, we need to delay + // the application of the visibility constraint until after the expression + // has been evaluated, so we only push it onto the stack here. + self.flow_restore(after_expr); + self.record_narrowing_constraint_id(predicate_id); + self.record_reachability_constraint_id(predicate_id); + visibility_constraints.push(visibility_constraint); + } + } + + for snapshot in snapshots { + self.flow_merge(snapshot); + } + + self.simplify_visibility_constraints(pre_op); + } + ast::Expr::Attribute(ast::ExprAttribute { + value: object, + attr, + ctx, + range: _, + }) => { + if ctx.is_store() { + match self.current_assignment() { + Some(CurrentAssignment::Assign { node, unpack, .. }) => { + // SAFETY: `value` and `expr` belong to the `self.module` tree + #[expect(unsafe_code)] + let assignment = AssignmentDefinitionKind::new( + TargetKind::from(unpack), + unsafe { AstNodeRef::new(self.module.clone(), &node.value) }, + unsafe { AstNodeRef::new(self.module.clone(), expr) }, + ); + self.register_attribute_assignment( + object, + attr, + DefinitionKind::Assignment(assignment), + ); + } + Some(CurrentAssignment::AnnAssign(ann_assign)) => { + self.add_standalone_type_expression(&ann_assign.annotation); + // SAFETY: `annotation`, `value` and `expr` belong to the `self.module` tree + #[expect(unsafe_code)] + let assignment = AnnotatedAssignmentDefinitionKind::new( + unsafe { + AstNodeRef::new(self.module.clone(), &ann_assign.annotation) + }, + ann_assign.value.as_deref().map(|value| unsafe { + AstNodeRef::new(self.module.clone(), value) + }), + unsafe { AstNodeRef::new(self.module.clone(), expr) }, + ); + self.register_attribute_assignment( + object, + attr, + DefinitionKind::AnnotatedAssignment(assignment), + ); + } + Some(CurrentAssignment::For { node, unpack, .. }) => { + // // SAFETY: `iter` and `expr` belong to the `self.module` tree + #[expect(unsafe_code)] + let assignment = ForStmtDefinitionKind::new( + TargetKind::from(unpack), + unsafe { AstNodeRef::new(self.module.clone(), &node.iter) }, + unsafe { AstNodeRef::new(self.module.clone(), expr) }, + node.is_async, + ); + self.register_attribute_assignment( + object, + attr, + DefinitionKind::For(assignment), + ); + } + Some(CurrentAssignment::WithItem { + item, + unpack, + is_async, + .. + }) => { + // SAFETY: `context_expr` and `expr` belong to the `self.module` tree + #[expect(unsafe_code)] + let assignment = WithItemDefinitionKind::new( + TargetKind::from(unpack), + unsafe { AstNodeRef::new(self.module.clone(), &item.context_expr) }, + unsafe { AstNodeRef::new(self.module.clone(), expr) }, + is_async, + ); + self.register_attribute_assignment( + object, + attr, + DefinitionKind::WithItem(assignment), + ); + } + Some(CurrentAssignment::Comprehension { + unpack, + node, + first, + }) => { + // SAFETY: `iter` and `expr` belong to the `self.module` tree + #[expect(unsafe_code)] + let assignment = ComprehensionDefinitionKind { + target_kind: TargetKind::from(unpack), + iterable: unsafe { + AstNodeRef::new(self.module.clone(), &node.iter) + }, + target: unsafe { AstNodeRef::new(self.module.clone(), expr) }, + first, + is_async: node.is_async, + }; + // Temporarily move to the scope of the method to which the instance attribute is defined. + // SAFETY: `self.scope_stack` is not empty because the targets in comprehensions should always introduce a new scope. + let scope = self.scope_stack.pop().expect("The popped scope must be a comprehension, which must have a parent scope"); + self.register_attribute_assignment( + object, + attr, + DefinitionKind::Comprehension(assignment), + ); + self.scope_stack.push(scope); + } + Some(CurrentAssignment::AugAssign(_)) => { + // TODO: + } + Some(CurrentAssignment::Named(_)) => { + // A named expression whose target is an attribute is syntactically prohibited + } + None => {} + } + } + + // Track reachability of attribute expressions to silence `unresolved-attribute` + // diagnostics in unreachable code. + self.current_use_def_map_mut() + .record_node_reachability(node_key); + + walk_expr(self, expr); + } + ast::Expr::StringLiteral(_) => { + // Track reachability of string literals, as they could be a stringified annotation + // with child expressions whose reachability we are interested in. + self.current_use_def_map_mut() + .record_node_reachability(node_key); + + walk_expr(self, expr); + } + ast::Expr::Yield(_) | ast::Expr::YieldFrom(_) => { + let scope = self.current_scope(); + if self.scopes[scope].kind() == ScopeKind::Function { + self.generator_functions.insert(scope); + } + walk_expr(self, expr); + } + _ => { + walk_expr(self, expr); + } + } + } + + fn visit_parameters(&mut self, parameters: &'ast ast::Parameters) { + // Intentionally avoid walking default expressions, as we handle them in the enclosing + // scope. + for parameter in parameters.iter().map(ast::AnyParameterRef::as_parameter) { + self.visit_parameter(parameter); + } + } + + fn visit_pattern(&mut self, pattern: &'ast ast::Pattern) { + if let ast::Pattern::MatchStar(ast::PatternMatchStar { + name: Some(name), + range: _, + }) = pattern + { + let symbol = self.add_symbol(name.id().clone()); + let state = self.current_match_case.as_ref().unwrap(); + self.add_definition( + symbol, + MatchPatternDefinitionNodeRef { + pattern: state.pattern, + identifier: name, + index: state.index, + }, + ); + } + + walk_pattern(self, pattern); + + if let ast::Pattern::MatchAs(ast::PatternMatchAs { + name: Some(name), .. + }) + | ast::Pattern::MatchMapping(ast::PatternMatchMapping { + rest: Some(name), .. + }) = pattern + { + let symbol = self.add_symbol(name.id().clone()); + let state = self.current_match_case.as_ref().unwrap(); + self.add_definition( + symbol, + MatchPatternDefinitionNodeRef { + pattern: state.pattern, + identifier: name, + index: state.index, + }, + ); + } + + self.current_match_case.as_mut().unwrap().index += 1; + } +} + +impl SemanticSyntaxContext for SemanticIndexBuilder<'_> { + fn future_annotations_or_stub(&self) -> bool { + self.has_future_annotations + } + + fn python_version(&self) -> PythonVersion { + self.python_version + } + + fn source(&self) -> &str { + self.source_text().as_str() + } + + // We handle the one syntax error that relies on this method (`LoadBeforeGlobalDeclaration`) + // directly in `visit_stmt`, so this just returns a placeholder value. + fn global(&self, _name: &str) -> Option<TextRange> { + None + } + + fn in_async_context(&self) -> bool { + for scope_info in self.scope_stack.iter().rev() { + let scope = &self.scopes[scope_info.file_scope_id]; + match scope.kind() { + ScopeKind::Class | ScopeKind::Lambda => return false, + ScopeKind::Function => { + return scope.node().expect_function().is_async; + } + ScopeKind::Comprehension + | ScopeKind::Module + | ScopeKind::TypeAlias + | ScopeKind::Annotation => {} + } + } + false + } + + fn in_await_allowed_context(&self) -> bool { + for scope_info in self.scope_stack.iter().rev() { + let scope = &self.scopes[scope_info.file_scope_id]; + match scope.kind() { + ScopeKind::Class => return false, + ScopeKind::Function | ScopeKind::Lambda => return true, + ScopeKind::Comprehension + | ScopeKind::Module + | ScopeKind::TypeAlias + | ScopeKind::Annotation => {} + } + } + false + } + + fn in_yield_allowed_context(&self) -> bool { + for scope_info in self.scope_stack.iter().rev() { + let scope = &self.scopes[scope_info.file_scope_id]; + match scope.kind() { + ScopeKind::Class | ScopeKind::Comprehension => return false, + ScopeKind::Function | ScopeKind::Lambda => return true, + ScopeKind::Module | ScopeKind::TypeAlias | ScopeKind::Annotation => {} + } + } + false + } + + fn in_sync_comprehension(&self) -> bool { + for scope_info in self.scope_stack.iter().rev() { + let scope = &self.scopes[scope_info.file_scope_id]; + let generators = match scope.node() { + NodeWithScopeKind::ListComprehension(node) => &node.generators, + NodeWithScopeKind::SetComprehension(node) => &node.generators, + NodeWithScopeKind::DictComprehension(node) => &node.generators, + _ => continue, + }; + if generators + .iter() + .all(|comprehension| !comprehension.is_async) + { + return true; + } + } + false + } + + fn in_module_scope(&self) -> bool { + self.scope_stack.len() == 1 + } + + fn in_function_scope(&self) -> bool { + let kind = self.scopes[self.current_scope()].kind(); + matches!(kind, ScopeKind::Function | ScopeKind::Lambda) + } + + fn in_generator_scope(&self) -> bool { + matches!( + self.scopes[self.current_scope()].node(), + NodeWithScopeKind::GeneratorExpression(_) + ) + } + + fn in_notebook(&self) -> bool { + self.source_text().is_notebook() + } + + fn report_semantic_error(&self, error: SemanticSyntaxError) { + if self.db.is_file_open(self.file) { + self.semantic_syntax_errors.borrow_mut().push(error); + } + } +} + +#[derive(Copy, Clone, Debug, PartialEq)] +enum CurrentAssignment<'a> { + Assign { + node: &'a ast::StmtAssign, + unpack: Option<(UnpackPosition, Unpack<'a>)>, + }, + AnnAssign(&'a ast::StmtAnnAssign), + AugAssign(&'a ast::StmtAugAssign), + For { + node: &'a ast::StmtFor, + unpack: Option<(UnpackPosition, Unpack<'a>)>, + }, + Named(&'a ast::ExprNamed), + Comprehension { + node: &'a ast::Comprehension, + first: bool, + unpack: Option<(UnpackPosition, Unpack<'a>)>, + }, + WithItem { + item: &'a ast::WithItem, + is_async: bool, + unpack: Option<(UnpackPosition, Unpack<'a>)>, + }, +} + +impl CurrentAssignment<'_> { + fn unpack_position_mut(&mut self) -> Option<&mut UnpackPosition> { + match self { + Self::Assign { unpack, .. } + | Self::For { unpack, .. } + | Self::WithItem { unpack, .. } + | Self::Comprehension { unpack, .. } => unpack.as_mut().map(|(position, _)| position), + Self::AnnAssign(_) | Self::AugAssign(_) | Self::Named(_) => None, + } + } +} + +impl<'a> From<&'a ast::StmtAnnAssign> for CurrentAssignment<'a> { + fn from(value: &'a ast::StmtAnnAssign) -> Self { + Self::AnnAssign(value) + } +} + +impl<'a> From<&'a ast::StmtAugAssign> for CurrentAssignment<'a> { + fn from(value: &'a ast::StmtAugAssign) -> Self { + Self::AugAssign(value) + } +} + +impl<'a> From<&'a ast::ExprNamed> for CurrentAssignment<'a> { + fn from(value: &'a ast::ExprNamed) -> Self { + Self::Named(value) + } +} + +#[derive(Debug, PartialEq)] +struct CurrentMatchCase<'a> { + /// The pattern that's part of the current match case. + pattern: &'a ast::Pattern, + + /// The index of the sub-pattern that's being currently visited within the pattern. + /// + /// For example: + /// ```py + /// match subject: + /// case a as b: ... + /// case [a, b]: ... + /// case a | b: ... + /// ``` + /// + /// In all of the above cases, the index would be 0 for `a` and 1 for `b`. + index: u32, +} + +impl<'a> CurrentMatchCase<'a> { + fn new(pattern: &'a ast::Pattern) -> Self { + Self { pattern, index: 0 } + } +} + +enum Unpackable<'a> { + Assign(&'a ast::StmtAssign), + For(&'a ast::StmtFor), + WithItem { + item: &'a ast::WithItem, + is_async: bool, + }, + Comprehension { + first: bool, + node: &'a ast::Comprehension, + }, +} + +impl<'a> Unpackable<'a> { + const fn kind(&self) -> UnpackKind { + match self { + Unpackable::Assign(_) => UnpackKind::Assign, + Unpackable::For(_) | Unpackable::Comprehension { .. } => UnpackKind::Iterable, + Unpackable::WithItem { .. } => UnpackKind::ContextManager, + } + } + + fn as_current_assignment(&self, unpack: Option<Unpack<'a>>) -> CurrentAssignment<'a> { + let unpack = unpack.map(|unpack| (UnpackPosition::First, unpack)); + match self { + Unpackable::Assign(stmt) => CurrentAssignment::Assign { node: stmt, unpack }, + Unpackable::For(stmt) => CurrentAssignment::For { node: stmt, unpack }, + Unpackable::WithItem { item, is_async } => CurrentAssignment::WithItem { + item, + is_async: *is_async, + unpack, + }, + Unpackable::Comprehension { node, first } => CurrentAssignment::Comprehension { + node, + first: *first, + unpack, + }, + } + } +} + +/// Returns the single argument to `__all__.extend()`, if it is a call to `__all__.extend()` +/// where it looks like the argument might be a `submodule.__all__` expression. +/// Else, returns `None`. +fn dunder_all_extend_argument(value: &ast::Expr) -> Option<&ast::Expr> { + let ast::ExprCall { + func, + arguments: + ast::Arguments { + args, + keywords, + range: _, + }, + .. + } = value.as_call_expr()?; + + let ast::ExprAttribute { value, attr, .. } = func.as_attribute_expr()?; + + let ast::ExprName { id, .. } = value.as_name_expr()?; + + if id != "__all__" { + return None; + } + + if attr != "extend" { + return None; + } + + if !keywords.is_empty() { + return None; + } + + let [single_argument] = &**args else { + return None; + }; + + let ast::ExprAttribute { value, attr, .. } = single_argument.as_attribute_expr()?; + + (attr == "__all__").then_some(value) +} diff --git a/crates/red_knot_python_semantic/src/semantic_index/builder/except_handlers.rs b/crates/ty_python_semantic/src/semantic_index/builder/except_handlers.rs similarity index 100% rename from crates/red_knot_python_semantic/src/semantic_index/builder/except_handlers.rs rename to crates/ty_python_semantic/src/semantic_index/builder/except_handlers.rs diff --git a/crates/ty_python_semantic/src/semantic_index/definition.rs b/crates/ty_python_semantic/src/semantic_index/definition.rs new file mode 100644 index 0000000000000..c8720d7cf77d0 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/definition.rs @@ -0,0 +1,1101 @@ +use std::ops::Deref; + +use ruff_db::files::{File, FileRange}; +use ruff_db::parsed::ParsedModule; +use ruff_python_ast as ast; +use ruff_text_size::{Ranged, TextRange}; + +use crate::Db; +use crate::ast_node_ref::AstNodeRef; +use crate::node_key::NodeKey; +use crate::semantic_index::symbol::{FileScopeId, ScopeId, ScopedSymbolId}; +use crate::unpack::{Unpack, UnpackPosition}; + +/// A definition of a symbol. +/// +/// ## ID stability +/// The `Definition`'s ID is stable when the only field that change is its `kind` (AST node). +/// +/// The `Definition` changes when the `file`, `scope`, or `symbol` change. This can be +/// because a new scope gets inserted before the `Definition` or a new symbol is inserted +/// before this `Definition`. However, the ID can be considered stable and it is okay to use +/// `Definition` in cross-module` salsa queries or as a field on other salsa tracked structs. +#[salsa::tracked(debug)] +pub struct Definition<'db> { + /// The file in which the definition occurs. + pub(crate) file: File, + + /// The scope in which the definition occurs. + pub(crate) file_scope: FileScopeId, + + /// The symbol defined. + pub(crate) symbol: ScopedSymbolId, + + /// WARNING: Only access this field when doing type inference for the same + /// file as where `Definition` is defined to avoid cross-file query dependencies. + #[no_eq] + #[returns(ref)] + #[tracked] + pub(crate) kind: DefinitionKind<'db>, + + /// This is a dedicated field to avoid accessing `kind` to compute this value. + pub(crate) is_reexported: bool, + + count: countme::Count<Definition<'static>>, +} + +impl<'db> Definition<'db> { + pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { + self.file_scope(db).to_scope_id(db, self.file(db)) + } + + pub fn full_range(self, db: &'db dyn Db) -> FileRange { + FileRange::new(self.file(db), self.kind(db).full_range()) + } + + pub fn focus_range(self, db: &'db dyn Db) -> FileRange { + FileRange::new(self.file(db), self.kind(db).target_range()) + } +} + +/// One or more [`Definition`]s. +#[derive(Debug, Default, PartialEq, Eq, salsa::Update)] +pub struct Definitions<'db>(smallvec::SmallVec<[Definition<'db>; 1]>); + +impl<'db> Definitions<'db> { + pub(crate) fn single(definition: Definition<'db>) -> Self { + Self(smallvec::smallvec![definition]) + } + + pub(crate) fn push(&mut self, definition: Definition<'db>) { + self.0.push(definition); + } +} + +impl<'db> Deref for Definitions<'db> { + type Target = [Definition<'db>]; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl<'a, 'db> IntoIterator for &'a Definitions<'db> { + type Item = &'a Definition<'db>; + type IntoIter = std::slice::Iter<'a, Definition<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.0.iter() + } +} + +#[derive(Copy, Clone, Debug)] +pub(crate) enum DefinitionNodeRef<'a> { + Import(ImportDefinitionNodeRef<'a>), + ImportFrom(ImportFromDefinitionNodeRef<'a>), + ImportStar(StarImportDefinitionNodeRef<'a>), + For(ForStmtDefinitionNodeRef<'a>), + Function(&'a ast::StmtFunctionDef), + Class(&'a ast::StmtClassDef), + TypeAlias(&'a ast::StmtTypeAlias), + NamedExpression(&'a ast::ExprNamed), + Assignment(AssignmentDefinitionNodeRef<'a>), + AnnotatedAssignment(AnnotatedAssignmentDefinitionNodeRef<'a>), + AugmentedAssignment(&'a ast::StmtAugAssign), + Comprehension(ComprehensionDefinitionNodeRef<'a>), + VariadicPositionalParameter(&'a ast::Parameter), + VariadicKeywordParameter(&'a ast::Parameter), + Parameter(&'a ast::ParameterWithDefault), + WithItem(WithItemDefinitionNodeRef<'a>), + MatchPattern(MatchPatternDefinitionNodeRef<'a>), + ExceptHandler(ExceptHandlerDefinitionNodeRef<'a>), + TypeVar(&'a ast::TypeParamTypeVar), + ParamSpec(&'a ast::TypeParamParamSpec), + TypeVarTuple(&'a ast::TypeParamTypeVarTuple), +} + +impl<'a> From<&'a ast::StmtFunctionDef> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::StmtFunctionDef) -> Self { + Self::Function(node) + } +} + +impl<'a> From<&'a ast::StmtClassDef> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::StmtClassDef) -> Self { + Self::Class(node) + } +} + +impl<'a> From<&'a ast::StmtTypeAlias> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::StmtTypeAlias) -> Self { + Self::TypeAlias(node) + } +} + +impl<'a> From<&'a ast::ExprNamed> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::ExprNamed) -> Self { + Self::NamedExpression(node) + } +} + +impl<'a> From<&'a ast::StmtAugAssign> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::StmtAugAssign) -> Self { + Self::AugmentedAssignment(node) + } +} + +impl<'a> From<&'a ast::TypeParamTypeVar> for DefinitionNodeRef<'a> { + fn from(value: &'a ast::TypeParamTypeVar) -> Self { + Self::TypeVar(value) + } +} + +impl<'a> From<&'a ast::TypeParamParamSpec> for DefinitionNodeRef<'a> { + fn from(value: &'a ast::TypeParamParamSpec) -> Self { + Self::ParamSpec(value) + } +} + +impl<'a> From<&'a ast::TypeParamTypeVarTuple> for DefinitionNodeRef<'a> { + fn from(value: &'a ast::TypeParamTypeVarTuple) -> Self { + Self::TypeVarTuple(value) + } +} + +impl<'a> From<ImportDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node_ref: ImportDefinitionNodeRef<'a>) -> Self { + Self::Import(node_ref) + } +} + +impl<'a> From<ImportFromDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node_ref: ImportFromDefinitionNodeRef<'a>) -> Self { + Self::ImportFrom(node_ref) + } +} + +impl<'a> From<ForStmtDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(value: ForStmtDefinitionNodeRef<'a>) -> Self { + Self::For(value) + } +} + +impl<'a> From<AssignmentDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node_ref: AssignmentDefinitionNodeRef<'a>) -> Self { + Self::Assignment(node_ref) + } +} + +impl<'a> From<AnnotatedAssignmentDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node_ref: AnnotatedAssignmentDefinitionNodeRef<'a>) -> Self { + Self::AnnotatedAssignment(node_ref) + } +} + +impl<'a> From<WithItemDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node_ref: WithItemDefinitionNodeRef<'a>) -> Self { + Self::WithItem(node_ref) + } +} + +impl<'a> From<ComprehensionDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node: ComprehensionDefinitionNodeRef<'a>) -> Self { + Self::Comprehension(node) + } +} + +impl<'a> From<&'a ast::ParameterWithDefault> for DefinitionNodeRef<'a> { + fn from(node: &'a ast::ParameterWithDefault) -> Self { + Self::Parameter(node) + } +} + +impl<'a> From<MatchPatternDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node: MatchPatternDefinitionNodeRef<'a>) -> Self { + Self::MatchPattern(node) + } +} + +impl<'a> From<StarImportDefinitionNodeRef<'a>> for DefinitionNodeRef<'a> { + fn from(node: StarImportDefinitionNodeRef<'a>) -> Self { + Self::ImportStar(node) + } +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct ImportDefinitionNodeRef<'a> { + pub(crate) node: &'a ast::StmtImport, + pub(crate) alias_index: usize, + pub(crate) is_reexported: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct StarImportDefinitionNodeRef<'a> { + pub(crate) node: &'a ast::StmtImportFrom, + pub(crate) symbol_id: ScopedSymbolId, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct ImportFromDefinitionNodeRef<'a> { + pub(crate) node: &'a ast::StmtImportFrom, + pub(crate) alias_index: usize, + pub(crate) is_reexported: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct AssignmentDefinitionNodeRef<'a> { + pub(crate) unpack: Option<(UnpackPosition, Unpack<'a>)>, + pub(crate) value: &'a ast::Expr, + pub(crate) target: &'a ast::Expr, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct AnnotatedAssignmentDefinitionNodeRef<'a> { + pub(crate) node: &'a ast::StmtAnnAssign, + pub(crate) annotation: &'a ast::Expr, + pub(crate) value: Option<&'a ast::Expr>, + pub(crate) target: &'a ast::Expr, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct WithItemDefinitionNodeRef<'a> { + pub(crate) unpack: Option<(UnpackPosition, Unpack<'a>)>, + pub(crate) context_expr: &'a ast::Expr, + pub(crate) target: &'a ast::Expr, + pub(crate) is_async: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct ForStmtDefinitionNodeRef<'a> { + pub(crate) unpack: Option<(UnpackPosition, Unpack<'a>)>, + pub(crate) iterable: &'a ast::Expr, + pub(crate) target: &'a ast::Expr, + pub(crate) is_async: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct ExceptHandlerDefinitionNodeRef<'a> { + pub(crate) handler: &'a ast::ExceptHandlerExceptHandler, + pub(crate) is_star: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct ComprehensionDefinitionNodeRef<'a> { + pub(crate) unpack: Option<(UnpackPosition, Unpack<'a>)>, + pub(crate) iterable: &'a ast::Expr, + pub(crate) target: &'a ast::Expr, + pub(crate) first: bool, + pub(crate) is_async: bool, +} + +#[derive(Copy, Clone, Debug)] +pub(crate) struct MatchPatternDefinitionNodeRef<'a> { + /// The outermost pattern node in which the identifier being defined occurs. + pub(crate) pattern: &'a ast::Pattern, + /// The identifier being defined. + pub(crate) identifier: &'a ast::Identifier, + /// The index of the identifier in the pattern when visiting the `pattern` node in evaluation + /// order. + pub(crate) index: u32, +} + +impl<'db> DefinitionNodeRef<'db> { + #[expect(unsafe_code)] + pub(super) unsafe fn into_owned(self, parsed: ParsedModule) -> DefinitionKind<'db> { + match self { + DefinitionNodeRef::Import(ImportDefinitionNodeRef { + node, + alias_index, + is_reexported, + }) => DefinitionKind::Import(ImportDefinitionKind { + node: unsafe { AstNodeRef::new(parsed, node) }, + alias_index, + is_reexported, + }), + + DefinitionNodeRef::ImportFrom(ImportFromDefinitionNodeRef { + node, + alias_index, + is_reexported, + }) => DefinitionKind::ImportFrom(ImportFromDefinitionKind { + node: unsafe { AstNodeRef::new(parsed, node) }, + alias_index, + is_reexported, + }), + DefinitionNodeRef::ImportStar(star_import) => { + let StarImportDefinitionNodeRef { node, symbol_id } = star_import; + DefinitionKind::StarImport(StarImportDefinitionKind { + node: unsafe { AstNodeRef::new(parsed, node) }, + symbol_id, + }) + } + DefinitionNodeRef::Function(function) => { + DefinitionKind::Function(unsafe { AstNodeRef::new(parsed, function) }) + } + DefinitionNodeRef::Class(class) => { + DefinitionKind::Class(unsafe { AstNodeRef::new(parsed, class) }) + } + DefinitionNodeRef::TypeAlias(type_alias) => { + DefinitionKind::TypeAlias(unsafe { AstNodeRef::new(parsed, type_alias) }) + } + DefinitionNodeRef::NamedExpression(named) => { + DefinitionKind::NamedExpression(unsafe { AstNodeRef::new(parsed, named) }) + } + DefinitionNodeRef::Assignment(AssignmentDefinitionNodeRef { + unpack, + value, + target, + }) => DefinitionKind::Assignment(AssignmentDefinitionKind { + target_kind: TargetKind::from(unpack), + value: unsafe { AstNodeRef::new(parsed.clone(), value) }, + target: unsafe { AstNodeRef::new(parsed, target) }, + }), + DefinitionNodeRef::AnnotatedAssignment(AnnotatedAssignmentDefinitionNodeRef { + node: _, + annotation, + value, + target, + }) => DefinitionKind::AnnotatedAssignment(AnnotatedAssignmentDefinitionKind { + target: unsafe { AstNodeRef::new(parsed.clone(), target) }, + annotation: unsafe { AstNodeRef::new(parsed.clone(), annotation) }, + value: value.map(|v| unsafe { AstNodeRef::new(parsed, v) }), + }), + DefinitionNodeRef::AugmentedAssignment(augmented_assignment) => { + DefinitionKind::AugmentedAssignment(unsafe { + AstNodeRef::new(parsed, augmented_assignment) + }) + } + DefinitionNodeRef::For(ForStmtDefinitionNodeRef { + unpack, + iterable, + target, + is_async, + }) => DefinitionKind::For(ForStmtDefinitionKind { + target_kind: TargetKind::from(unpack), + iterable: unsafe { AstNodeRef::new(parsed.clone(), iterable) }, + target: unsafe { AstNodeRef::new(parsed, target) }, + is_async, + }), + DefinitionNodeRef::Comprehension(ComprehensionDefinitionNodeRef { + unpack, + iterable, + target, + first, + is_async, + }) => DefinitionKind::Comprehension(ComprehensionDefinitionKind { + target_kind: TargetKind::from(unpack), + iterable: unsafe { AstNodeRef::new(parsed.clone(), iterable) }, + target: unsafe { AstNodeRef::new(parsed, target) }, + first, + is_async, + }), + DefinitionNodeRef::VariadicPositionalParameter(parameter) => { + DefinitionKind::VariadicPositionalParameter(unsafe { + AstNodeRef::new(parsed, parameter) + }) + } + DefinitionNodeRef::VariadicKeywordParameter(parameter) => { + DefinitionKind::VariadicKeywordParameter(unsafe { + AstNodeRef::new(parsed, parameter) + }) + } + DefinitionNodeRef::Parameter(parameter) => { + DefinitionKind::Parameter(unsafe { AstNodeRef::new(parsed, parameter) }) + } + DefinitionNodeRef::WithItem(WithItemDefinitionNodeRef { + unpack, + context_expr, + target, + is_async, + }) => DefinitionKind::WithItem(WithItemDefinitionKind { + target_kind: TargetKind::from(unpack), + context_expr: unsafe { AstNodeRef::new(parsed.clone(), context_expr) }, + target: unsafe { AstNodeRef::new(parsed, target) }, + is_async, + }), + DefinitionNodeRef::MatchPattern(MatchPatternDefinitionNodeRef { + pattern, + identifier, + index, + }) => DefinitionKind::MatchPattern(MatchPatternDefinitionKind { + pattern: unsafe { AstNodeRef::new(parsed.clone(), pattern) }, + identifier: unsafe { AstNodeRef::new(parsed, identifier) }, + index, + }), + DefinitionNodeRef::ExceptHandler(ExceptHandlerDefinitionNodeRef { + handler, + is_star, + }) => DefinitionKind::ExceptHandler(ExceptHandlerDefinitionKind { + handler: unsafe { AstNodeRef::new(parsed, handler) }, + is_star, + }), + DefinitionNodeRef::TypeVar(node) => { + DefinitionKind::TypeVar(unsafe { AstNodeRef::new(parsed, node) }) + } + DefinitionNodeRef::ParamSpec(node) => { + DefinitionKind::ParamSpec(unsafe { AstNodeRef::new(parsed, node) }) + } + DefinitionNodeRef::TypeVarTuple(node) => { + DefinitionKind::TypeVarTuple(unsafe { AstNodeRef::new(parsed, node) }) + } + } + } + + pub(super) fn key(self) -> DefinitionNodeKey { + match self { + Self::Import(ImportDefinitionNodeRef { + node, + alias_index, + is_reexported: _, + }) => (&node.names[alias_index]).into(), + Self::ImportFrom(ImportFromDefinitionNodeRef { + node, + alias_index, + is_reexported: _, + }) => (&node.names[alias_index]).into(), + + // INVARIANT: for an invalid-syntax statement such as `from foo import *, bar, *`, + // we only create a `StarImportDefinitionKind` for the *first* `*` alias in the names list. + Self::ImportStar(StarImportDefinitionNodeRef { node, symbol_id: _ }) => node + .names + .iter() + .find(|alias| &alias.name == "*") + .expect( + "The `StmtImportFrom` node of a `StarImportDefinitionKind` instance \ + should always have at least one `alias` with the name `*`.", + ) + .into(), + + Self::Function(node) => node.into(), + Self::Class(node) => node.into(), + Self::TypeAlias(node) => node.into(), + Self::NamedExpression(node) => node.into(), + Self::Assignment(AssignmentDefinitionNodeRef { + value: _, + unpack: _, + target, + }) => DefinitionNodeKey(NodeKey::from_node(target)), + Self::AnnotatedAssignment(ann_assign) => ann_assign.node.into(), + Self::AugmentedAssignment(node) => node.into(), + Self::For(ForStmtDefinitionNodeRef { + target, + iterable: _, + unpack: _, + is_async: _, + }) => DefinitionNodeKey(NodeKey::from_node(target)), + Self::Comprehension(ComprehensionDefinitionNodeRef { target, .. }) => { + DefinitionNodeKey(NodeKey::from_node(target)) + } + Self::VariadicPositionalParameter(node) => node.into(), + Self::VariadicKeywordParameter(node) => node.into(), + Self::Parameter(node) => node.into(), + Self::WithItem(WithItemDefinitionNodeRef { + context_expr: _, + unpack: _, + is_async: _, + target, + }) => DefinitionNodeKey(NodeKey::from_node(target)), + Self::MatchPattern(MatchPatternDefinitionNodeRef { identifier, .. }) => { + identifier.into() + } + Self::ExceptHandler(ExceptHandlerDefinitionNodeRef { handler, .. }) => handler.into(), + Self::TypeVar(node) => node.into(), + Self::ParamSpec(node) => node.into(), + Self::TypeVarTuple(node) => node.into(), + } + } +} + +#[derive(Clone, Copy, Debug)] +pub(crate) enum DefinitionCategory { + /// A Definition which binds a value to a name (e.g. `x = 1`). + Binding, + /// A Definition which declares the upper-bound of acceptable types for this name (`x: int`). + Declaration, + /// A Definition which both declares a type and binds a value (e.g. `x: int = 1`). + DeclarationAndBinding, +} + +impl DefinitionCategory { + /// True if this definition establishes a "declared type" for the symbol. + /// + /// If so, any assignments reached by this definition are in error if they assign a value of a + /// type not assignable to the declared type. + /// + /// Annotations establish a declared type. So do function and class definitions, and imports. + pub(crate) fn is_declaration(self) -> bool { + matches!( + self, + DefinitionCategory::Declaration | DefinitionCategory::DeclarationAndBinding + ) + } + + /// True if this definition assigns a value to the symbol. + /// + /// False only for annotated assignments without a RHS. + pub(crate) fn is_binding(self) -> bool { + matches!( + self, + DefinitionCategory::Binding | DefinitionCategory::DeclarationAndBinding + ) + } +} + +/// The kind of a definition. +/// +/// ## Usage in salsa tracked structs +/// +/// [`DefinitionKind`] fields in salsa tracked structs should be tracked (attributed with `#[tracked]`) +/// because the kind is a thin wrapper around [`AstNodeRef`]. See the [`AstNodeRef`] documentation +/// for an in-depth explanation of why this is necessary. +#[derive(Clone, Debug)] +pub enum DefinitionKind<'db> { + Import(ImportDefinitionKind), + ImportFrom(ImportFromDefinitionKind), + StarImport(StarImportDefinitionKind), + Function(AstNodeRef<ast::StmtFunctionDef>), + Class(AstNodeRef<ast::StmtClassDef>), + TypeAlias(AstNodeRef<ast::StmtTypeAlias>), + NamedExpression(AstNodeRef<ast::ExprNamed>), + Assignment(AssignmentDefinitionKind<'db>), + AnnotatedAssignment(AnnotatedAssignmentDefinitionKind), + AugmentedAssignment(AstNodeRef<ast::StmtAugAssign>), + For(ForStmtDefinitionKind<'db>), + Comprehension(ComprehensionDefinitionKind<'db>), + VariadicPositionalParameter(AstNodeRef<ast::Parameter>), + VariadicKeywordParameter(AstNodeRef<ast::Parameter>), + Parameter(AstNodeRef<ast::ParameterWithDefault>), + WithItem(WithItemDefinitionKind<'db>), + MatchPattern(MatchPatternDefinitionKind), + ExceptHandler(ExceptHandlerDefinitionKind), + TypeVar(AstNodeRef<ast::TypeParamTypeVar>), + ParamSpec(AstNodeRef<ast::TypeParamParamSpec>), + TypeVarTuple(AstNodeRef<ast::TypeParamTypeVarTuple>), +} + +impl DefinitionKind<'_> { + pub(crate) fn is_reexported(&self) -> bool { + match self { + DefinitionKind::Import(import) => import.is_reexported(), + DefinitionKind::ImportFrom(import) => import.is_reexported(), + _ => true, + } + } + + pub(crate) const fn as_star_import(&self) -> Option<&StarImportDefinitionKind> { + match self { + DefinitionKind::StarImport(import) => Some(import), + _ => None, + } + } + + /// Returns the [`TextRange`] of the definition target. + /// + /// A definition target would mainly be the node representing the symbol being defined i.e., + /// [`ast::ExprName`] or [`ast::Identifier`] but could also be other nodes. + pub(crate) fn target_range(&self) -> TextRange { + match self { + DefinitionKind::Import(import) => import.alias().range(), + DefinitionKind::ImportFrom(import) => import.alias().range(), + DefinitionKind::StarImport(import) => import.alias().range(), + DefinitionKind::Function(function) => function.name.range(), + DefinitionKind::Class(class) => class.name.range(), + DefinitionKind::TypeAlias(type_alias) => type_alias.name.range(), + DefinitionKind::NamedExpression(named) => named.target.range(), + DefinitionKind::Assignment(assignment) => assignment.target.range(), + DefinitionKind::AnnotatedAssignment(assign) => assign.target.range(), + DefinitionKind::AugmentedAssignment(aug_assign) => aug_assign.target.range(), + DefinitionKind::For(for_stmt) => for_stmt.target.range(), + DefinitionKind::Comprehension(comp) => comp.target().range(), + DefinitionKind::VariadicPositionalParameter(parameter) => parameter.name.range(), + DefinitionKind::VariadicKeywordParameter(parameter) => parameter.name.range(), + DefinitionKind::Parameter(parameter) => parameter.parameter.name.range(), + DefinitionKind::WithItem(with_item) => with_item.target.range(), + DefinitionKind::MatchPattern(match_pattern) => match_pattern.identifier.range(), + DefinitionKind::ExceptHandler(handler) => handler.node().range(), + DefinitionKind::TypeVar(type_var) => type_var.name.range(), + DefinitionKind::ParamSpec(param_spec) => param_spec.name.range(), + DefinitionKind::TypeVarTuple(type_var_tuple) => type_var_tuple.name.range(), + } + } + + /// Returns the [`TextRange`] of the entire definition. + pub(crate) fn full_range(&self) -> TextRange { + match self { + DefinitionKind::Import(import) => import.alias().range(), + DefinitionKind::ImportFrom(import) => import.alias().range(), + DefinitionKind::StarImport(import) => import.import().range(), + DefinitionKind::Function(function) => function.range(), + DefinitionKind::Class(class) => class.range(), + DefinitionKind::TypeAlias(type_alias) => type_alias.range(), + DefinitionKind::NamedExpression(named) => named.range(), + DefinitionKind::Assignment(assignment) => assignment.target.range(), + DefinitionKind::AnnotatedAssignment(assign) => assign.target.range(), + DefinitionKind::AugmentedAssignment(aug_assign) => aug_assign.range(), + DefinitionKind::For(for_stmt) => for_stmt.target.range(), + DefinitionKind::Comprehension(comp) => comp.target().range(), + DefinitionKind::VariadicPositionalParameter(parameter) => parameter.range(), + DefinitionKind::VariadicKeywordParameter(parameter) => parameter.range(), + DefinitionKind::Parameter(parameter) => parameter.parameter.range(), + DefinitionKind::WithItem(with_item) => with_item.target.range(), + DefinitionKind::MatchPattern(match_pattern) => match_pattern.identifier.range(), + DefinitionKind::ExceptHandler(handler) => handler.node().range(), + DefinitionKind::TypeVar(type_var) => type_var.range(), + DefinitionKind::ParamSpec(param_spec) => param_spec.range(), + DefinitionKind::TypeVarTuple(type_var_tuple) => type_var_tuple.range(), + } + } + + pub(crate) fn category(&self, in_stub: bool) -> DefinitionCategory { + match self { + // functions, classes, and imports always bind, and we consider them declarations + DefinitionKind::Function(_) + | DefinitionKind::Class(_) + | DefinitionKind::TypeAlias(_) + | DefinitionKind::Import(_) + | DefinitionKind::ImportFrom(_) + | DefinitionKind::StarImport(_) + | DefinitionKind::TypeVar(_) + | DefinitionKind::ParamSpec(_) + | DefinitionKind::TypeVarTuple(_) => DefinitionCategory::DeclarationAndBinding, + // a parameter always binds a value, but is only a declaration if annotated + DefinitionKind::VariadicPositionalParameter(parameter) + | DefinitionKind::VariadicKeywordParameter(parameter) => { + if parameter.annotation.is_some() { + DefinitionCategory::DeclarationAndBinding + } else { + DefinitionCategory::Binding + } + } + // presence of a default is irrelevant, same logic as for a no-default parameter + DefinitionKind::Parameter(parameter_with_default) => { + if parameter_with_default.parameter.annotation.is_some() { + DefinitionCategory::DeclarationAndBinding + } else { + DefinitionCategory::Binding + } + } + // Annotated assignment is always a declaration. It is also a binding if there is a RHS + // or if we are in a stub file. Unfortunately, it is common for stubs to omit even an `...` value placeholder. + DefinitionKind::AnnotatedAssignment(ann_assign) => { + if in_stub || ann_assign.value.is_some() { + DefinitionCategory::DeclarationAndBinding + } else { + DefinitionCategory::Declaration + } + } + // all of these bind values without declaring a type + DefinitionKind::NamedExpression(_) + | DefinitionKind::Assignment(_) + | DefinitionKind::AugmentedAssignment(_) + | DefinitionKind::For(_) + | DefinitionKind::Comprehension(_) + | DefinitionKind::WithItem(_) + | DefinitionKind::MatchPattern(_) + | DefinitionKind::ExceptHandler(_) => DefinitionCategory::Binding, + } + } +} + +#[derive(Copy, Clone, Debug, PartialEq, Hash)] +pub(crate) enum TargetKind<'db> { + Sequence(UnpackPosition, Unpack<'db>), + NameOrAttribute, +} + +impl<'db> From<Option<(UnpackPosition, Unpack<'db>)>> for TargetKind<'db> { + fn from(value: Option<(UnpackPosition, Unpack<'db>)>) -> Self { + match value { + Some((unpack_position, unpack)) => TargetKind::Sequence(unpack_position, unpack), + None => TargetKind::NameOrAttribute, + } + } +} + +#[derive(Clone, Debug)] +pub struct StarImportDefinitionKind { + node: AstNodeRef<ast::StmtImportFrom>, + symbol_id: ScopedSymbolId, +} + +impl StarImportDefinitionKind { + pub(crate) fn import(&self) -> &ast::StmtImportFrom { + self.node.node() + } + + pub(crate) fn alias(&self) -> &ast::Alias { + // INVARIANT: for an invalid-syntax statement such as `from foo import *, bar, *`, + // we only create a `StarImportDefinitionKind` for the *first* `*` alias in the names list. + self.node + .node() + .names + .iter() + .find(|alias| &alias.name == "*") + .expect( + "The `StmtImportFrom` node of a `StarImportDefinitionKind` instance \ + should always have at least one `alias` with the name `*`.", + ) + } + + pub(crate) fn symbol_id(&self) -> ScopedSymbolId { + self.symbol_id + } +} + +#[derive(Clone, Debug)] +pub struct MatchPatternDefinitionKind { + pattern: AstNodeRef<ast::Pattern>, + identifier: AstNodeRef<ast::Identifier>, + index: u32, +} + +impl MatchPatternDefinitionKind { + pub(crate) fn pattern(&self) -> &ast::Pattern { + self.pattern.node() + } + + pub(crate) fn index(&self) -> u32 { + self.index + } +} + +#[derive(Clone, Debug)] +pub struct ComprehensionDefinitionKind<'db> { + pub(super) target_kind: TargetKind<'db>, + pub(super) iterable: AstNodeRef<ast::Expr>, + pub(super) target: AstNodeRef<ast::Expr>, + pub(super) first: bool, + pub(super) is_async: bool, +} + +impl<'db> ComprehensionDefinitionKind<'db> { + pub(crate) fn iterable(&self) -> &ast::Expr { + self.iterable.node() + } + + pub(crate) fn target_kind(&self) -> TargetKind<'db> { + self.target_kind + } + + pub(crate) fn target(&self) -> &ast::Expr { + self.target.node() + } + + pub(crate) fn is_first(&self) -> bool { + self.first + } + + pub(crate) fn is_async(&self) -> bool { + self.is_async + } +} + +#[derive(Clone, Debug)] +pub struct ImportDefinitionKind { + node: AstNodeRef<ast::StmtImport>, + alias_index: usize, + is_reexported: bool, +} + +impl ImportDefinitionKind { + pub(crate) fn import(&self) -> &ast::StmtImport { + self.node.node() + } + + pub(crate) fn alias(&self) -> &ast::Alias { + &self.node.node().names[self.alias_index] + } + + pub(crate) fn is_reexported(&self) -> bool { + self.is_reexported + } +} + +#[derive(Clone, Debug)] +pub struct ImportFromDefinitionKind { + node: AstNodeRef<ast::StmtImportFrom>, + alias_index: usize, + is_reexported: bool, +} + +impl ImportFromDefinitionKind { + pub(crate) fn import(&self) -> &ast::StmtImportFrom { + self.node.node() + } + + pub(crate) fn alias(&self) -> &ast::Alias { + &self.node.node().names[self.alias_index] + } + + pub(crate) fn is_reexported(&self) -> bool { + self.is_reexported + } +} + +#[derive(Clone, Debug)] +pub struct AssignmentDefinitionKind<'db> { + target_kind: TargetKind<'db>, + value: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, +} + +impl<'db> AssignmentDefinitionKind<'db> { + pub(crate) fn new( + target_kind: TargetKind<'db>, + value: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, + ) -> Self { + Self { + target_kind, + value, + target, + } + } + + pub(crate) fn target_kind(&self) -> TargetKind<'db> { + self.target_kind + } + + pub(crate) fn value(&self) -> &ast::Expr { + self.value.node() + } + + pub(crate) fn target(&self) -> &ast::Expr { + self.target.node() + } +} + +#[derive(Clone, Debug)] +pub struct AnnotatedAssignmentDefinitionKind { + annotation: AstNodeRef<ast::Expr>, + value: Option<AstNodeRef<ast::Expr>>, + target: AstNodeRef<ast::Expr>, +} + +impl AnnotatedAssignmentDefinitionKind { + pub(crate) fn new( + annotation: AstNodeRef<ast::Expr>, + value: Option<AstNodeRef<ast::Expr>>, + target: AstNodeRef<ast::Expr>, + ) -> Self { + Self { + annotation, + value, + target, + } + } + + pub(crate) fn value(&self) -> Option<&ast::Expr> { + self.value.as_deref() + } + + pub(crate) fn annotation(&self) -> &ast::Expr { + self.annotation.node() + } + + pub(crate) fn target(&self) -> &ast::Expr { + self.target.node() + } +} + +#[derive(Clone, Debug)] +pub struct WithItemDefinitionKind<'db> { + target_kind: TargetKind<'db>, + context_expr: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, + is_async: bool, +} + +impl<'db> WithItemDefinitionKind<'db> { + pub(crate) fn new( + target_kind: TargetKind<'db>, + context_expr: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, + is_async: bool, + ) -> Self { + Self { + target_kind, + context_expr, + target, + is_async, + } + } + + pub(crate) fn context_expr(&self) -> &ast::Expr { + self.context_expr.node() + } + + pub(crate) fn target_kind(&self) -> TargetKind<'db> { + self.target_kind + } + + pub(crate) fn target(&self) -> &ast::Expr { + self.target.node() + } + + pub(crate) const fn is_async(&self) -> bool { + self.is_async + } +} + +#[derive(Clone, Debug)] +pub struct ForStmtDefinitionKind<'db> { + target_kind: TargetKind<'db>, + iterable: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, + is_async: bool, +} + +impl<'db> ForStmtDefinitionKind<'db> { + pub(crate) fn new( + target_kind: TargetKind<'db>, + iterable: AstNodeRef<ast::Expr>, + target: AstNodeRef<ast::Expr>, + is_async: bool, + ) -> Self { + Self { + target_kind, + iterable, + target, + is_async, + } + } + + pub(crate) fn iterable(&self) -> &ast::Expr { + self.iterable.node() + } + + pub(crate) fn target_kind(&self) -> TargetKind<'db> { + self.target_kind + } + + pub(crate) fn target(&self) -> &ast::Expr { + self.target.node() + } + + pub(crate) const fn is_async(&self) -> bool { + self.is_async + } +} + +#[derive(Clone, Debug)] +pub struct ExceptHandlerDefinitionKind { + handler: AstNodeRef<ast::ExceptHandlerExceptHandler>, + is_star: bool, +} + +impl ExceptHandlerDefinitionKind { + pub(crate) fn node(&self) -> &ast::ExceptHandlerExceptHandler { + self.handler.node() + } + + pub(crate) fn handled_exceptions(&self) -> Option<&ast::Expr> { + self.node().type_.as_deref() + } + + pub(crate) fn is_star(&self) -> bool { + self.is_star + } +} + +#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug, salsa::Update)] +pub(crate) struct DefinitionNodeKey(NodeKey); + +impl From<&ast::Alias> for DefinitionNodeKey { + fn from(node: &ast::Alias) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::StmtFunctionDef> for DefinitionNodeKey { + fn from(node: &ast::StmtFunctionDef) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::StmtClassDef> for DefinitionNodeKey { + fn from(node: &ast::StmtClassDef) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::StmtTypeAlias> for DefinitionNodeKey { + fn from(node: &ast::StmtTypeAlias) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::ExprName> for DefinitionNodeKey { + fn from(node: &ast::ExprName) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::ExprNamed> for DefinitionNodeKey { + fn from(node: &ast::ExprNamed) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::StmtAnnAssign> for DefinitionNodeKey { + fn from(node: &ast::StmtAnnAssign) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::StmtAugAssign> for DefinitionNodeKey { + fn from(node: &ast::StmtAugAssign) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::Parameter> for DefinitionNodeKey { + fn from(node: &ast::Parameter) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<&ast::ParameterWithDefault> for DefinitionNodeKey { + fn from(node: &ast::ParameterWithDefault) -> Self { + Self(NodeKey::from_node(node)) + } +} + +impl From<ast::AnyParameterRef<'_>> for DefinitionNodeKey { + fn from(value: ast::AnyParameterRef) -> Self { + Self(match value { + ast::AnyParameterRef::Variadic(node) => NodeKey::from_node(node), + ast::AnyParameterRef::NonVariadic(node) => NodeKey::from_node(node), + }) + } +} + +impl From<&ast::Identifier> for DefinitionNodeKey { + fn from(identifier: &ast::Identifier) -> Self { + Self(NodeKey::from_node(identifier)) + } +} + +impl From<&ast::ExceptHandlerExceptHandler> for DefinitionNodeKey { + fn from(handler: &ast::ExceptHandlerExceptHandler) -> Self { + Self(NodeKey::from_node(handler)) + } +} + +impl From<&ast::TypeParamTypeVar> for DefinitionNodeKey { + fn from(value: &ast::TypeParamTypeVar) -> Self { + Self(NodeKey::from_node(value)) + } +} + +impl From<&ast::TypeParamParamSpec> for DefinitionNodeKey { + fn from(value: &ast::TypeParamParamSpec) -> Self { + Self(NodeKey::from_node(value)) + } +} + +impl From<&ast::TypeParamTypeVarTuple> for DefinitionNodeKey { + fn from(value: &ast::TypeParamTypeVarTuple) -> Self { + Self(NodeKey::from_node(value)) + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/expression.rs b/crates/ty_python_semantic/src/semantic_index/expression.rs new file mode 100644 index 0000000000000..f3afd45f497e6 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/expression.rs @@ -0,0 +1,68 @@ +use crate::ast_node_ref::AstNodeRef; +use crate::db::Db; +use crate::semantic_index::symbol::{FileScopeId, ScopeId}; +use ruff_db::files::File; +use ruff_python_ast as ast; +use salsa; + +/// Whether or not this expression should be inferred as a normal expression or +/// a type expression. For example, in `self.x: <annotation> = <value>`, the +/// `<annotation>` is inferred as a type expression, while `<value>` is inferred +/// as a normal expression. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub(crate) enum ExpressionKind { + Normal, + TypeExpression, +} + +/// An independently type-inferable expression. +/// +/// Includes constraint expressions (e.g. if tests) and the RHS of an unpacking assignment. +/// +/// ## Module-local type +/// This type should not be used as part of any cross-module API because +/// it holds a reference to the AST node. Range-offset changes +/// then propagate through all usages, and deserialization requires +/// reparsing the entire module. +/// +/// E.g. don't use this type in: +/// +/// * a return type of a cross-module query +/// * a field of a type that is a return type of a cross-module query +/// * an argument of a cross-module query +#[salsa::tracked(debug)] +pub(crate) struct Expression<'db> { + /// The file in which the expression occurs. + pub(crate) file: File, + + /// The scope in which the expression occurs. + pub(crate) file_scope: FileScopeId, + + /// The expression node. + #[no_eq] + #[tracked] + #[returns(deref)] + pub(crate) node_ref: AstNodeRef<ast::Expr>, + + /// An assignment statement, if this expression is immediately used as the rhs of that + /// assignment. + /// + /// (Note that this is the _immediately_ containing assignment — if a complex expression is + /// assigned to some target, only the outermost expression node has this set. The inner + /// expressions are used to build up the assignment result, and are not "immediately assigned" + /// to the target, and so have `None` for this field.) + #[no_eq] + #[tracked] + pub(crate) assigned_to: Option<AstNodeRef<ast::StmtAssign>>, + + /// Should this expression be inferred as a normal expression or a type expression? + pub(crate) kind: ExpressionKind, + + count: countme::Count<Expression<'static>>, +} + +impl<'db> Expression<'db> { + pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { + self.file_scope(db).to_scope_id(db, self.file(db)) + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/narrowing_constraints.rs b/crates/ty_python_semantic/src/semantic_index/narrowing_constraints.rs new file mode 100644 index 0000000000000..83bfb0d25dbf9 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/narrowing_constraints.rs @@ -0,0 +1,151 @@ +//! # Narrowing constraints +//! +//! When building a semantic index for a file, we associate each binding with a _narrowing +//! constraint_, which constrains the type of the binding's symbol. Note that a binding can be +//! associated with a different narrowing constraint at different points in a file. See the +//! [`use_def`][crate::semantic_index::use_def] module for more details. +//! +//! This module defines how narrowing constraints are stored internally. +//! +//! A _narrowing constraint_ consists of a list of _predicates_, each of which corresponds with an +//! expression in the source file (represented by a [`Predicate`]). We need to support the +//! following operations on narrowing constraints: +//! +//! - Adding a new predicate to an existing constraint +//! - Merging two constraints together, which produces the _intersection_ of their predicates +//! - Iterating through the predicates in a constraint +//! +//! In particular, note that we do not need random access to the predicates in a constraint. That +//! means that we can use a simple [_sorted association list_][crate::list] as our data structure. +//! That lets us use a single 32-bit integer to store each narrowing constraint, no matter how many +//! predicates it contains. It also makes merging two narrowing constraints fast, since alists +//! support fast intersection. +//! +//! Because we visit the contents of each scope in source-file order, and assign scoped IDs in +//! source-file order, that means that we will tend to visit narrowing constraints in order by +//! their predicate IDs. This is exactly how to get the best performance from our alist +//! implementation. +//! +//! [`Predicate`]: crate::semantic_index::predicate::Predicate + +use crate::list::{List, ListBuilder, ListSetReverseIterator, ListStorage}; +use crate::semantic_index::ast_ids::ScopedUseId; +use crate::semantic_index::predicate::ScopedPredicateId; + +/// A narrowing constraint associated with a live binding. +/// +/// A constraint is a list of [`Predicate`]s that each constrain the type of the binding's symbol. +/// +/// [`Predicate`]: crate::semantic_index::predicate::Predicate +pub(crate) type ScopedNarrowingConstraint = List<ScopedNarrowingConstraintPredicate>; + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum ConstraintKey { + NarrowingConstraint(ScopedNarrowingConstraint), + UseId(ScopedUseId), +} + +/// One of the [`Predicate`]s in a narrowing constraint, which constraints the type of the +/// binding's symbol. +/// +/// Note that those [`Predicate`]s are stored in [their own per-scope +/// arena][crate::semantic_index::predicate::Predicates], so internally we use a +/// [`ScopedPredicateId`] to refer to the underlying predicate. +/// +/// [`Predicate`]: crate::semantic_index::predicate::Predicate +#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)] +pub(crate) struct ScopedNarrowingConstraintPredicate(ScopedPredicateId); + +impl ScopedNarrowingConstraintPredicate { + /// Returns (the ID of) the `Predicate` + pub(crate) fn predicate(self) -> ScopedPredicateId { + self.0 + } +} + +impl From<ScopedPredicateId> for ScopedNarrowingConstraintPredicate { + fn from(predicate: ScopedPredicateId) -> ScopedNarrowingConstraintPredicate { + ScopedNarrowingConstraintPredicate(predicate) + } +} + +/// A collection of narrowing constraints for a given scope. +#[derive(Debug, Eq, PartialEq)] +pub(crate) struct NarrowingConstraints { + lists: ListStorage<ScopedNarrowingConstraintPredicate>, +} + +// Building constraints +// -------------------- + +/// A builder for creating narrowing constraints. +#[derive(Debug, Default, Eq, PartialEq)] +pub(crate) struct NarrowingConstraintsBuilder { + lists: ListBuilder<ScopedNarrowingConstraintPredicate>, +} + +impl NarrowingConstraintsBuilder { + pub(crate) fn build(self) -> NarrowingConstraints { + NarrowingConstraints { + lists: self.lists.build(), + } + } + + /// Adds a predicate to an existing narrowing constraint. + pub(crate) fn add_predicate_to_constraint( + &mut self, + constraint: ScopedNarrowingConstraint, + predicate: ScopedNarrowingConstraintPredicate, + ) -> ScopedNarrowingConstraint { + self.lists.insert(constraint, predicate) + } + + /// Returns the intersection of two narrowing constraints. The result contains the predicates + /// that appear in both inputs. + pub(crate) fn intersect_constraints( + &mut self, + a: ScopedNarrowingConstraint, + b: ScopedNarrowingConstraint, + ) -> ScopedNarrowingConstraint { + self.lists.intersect(a, b) + } +} + +// Iteration +// --------- + +pub(crate) type NarrowingConstraintsIterator<'a> = + std::iter::Copied<ListSetReverseIterator<'a, ScopedNarrowingConstraintPredicate>>; + +impl NarrowingConstraints { + /// Iterates over the predicates in a narrowing constraint. + pub(crate) fn iter_predicates( + &self, + set: ScopedNarrowingConstraint, + ) -> NarrowingConstraintsIterator<'_> { + self.lists.iter_set_reverse(set).copied() + } +} + +// Test support +// ------------ + +#[cfg(test)] +mod tests { + use super::*; + + impl ScopedNarrowingConstraintPredicate { + pub(crate) fn as_u32(self) -> u32 { + self.0.as_u32() + } + } + + impl NarrowingConstraintsBuilder { + pub(crate) fn iter_predicates( + &self, + set: ScopedNarrowingConstraint, + ) -> NarrowingConstraintsIterator<'_> { + self.lists.iter_set_reverse(set).copied() + } + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/predicate.rs b/crates/ty_python_semantic/src/semantic_index/predicate.rs new file mode 100644 index 0000000000000..86e3ba903a60e --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/predicate.rs @@ -0,0 +1,173 @@ +//! _Predicates_ are Python expressions whose runtime values can affect type inference. +//! +//! We currently use predicates in two places: +//! +//! - [_Narrowing constraints_][crate::semantic_index::narrowing_constraints] constrain the type of +//! a binding that is visible at a particular use. +//! - [_Visibility constraints_][crate::semantic_index::visibility_constraints] determine the +//! static visibility of a binding, and the reachability of a statement. + +use ruff_db::files::File; +use ruff_index::{IndexVec, newtype_index}; +use ruff_python_ast::Singleton; + +use crate::db::Db; +use crate::semantic_index::expression::Expression; +use crate::semantic_index::global_scope; +use crate::semantic_index::symbol::{FileScopeId, ScopeId, ScopedSymbolId}; + +// A scoped identifier for each `Predicate` in a scope. +#[newtype_index] +#[derive(Ord, PartialOrd)] +pub(crate) struct ScopedPredicateId; + +// A collection of predicates for a given scope. +pub(crate) type Predicates<'db> = IndexVec<ScopedPredicateId, Predicate<'db>>; + +#[derive(Debug, Default)] +pub(crate) struct PredicatesBuilder<'db> { + predicates: IndexVec<ScopedPredicateId, Predicate<'db>>, +} + +impl<'db> PredicatesBuilder<'db> { + /// Adds a predicate. Note that we do not deduplicate predicates. If you add a `Predicate` + /// more than once, you will get distinct `ScopedPredicateId`s for each one. (This lets you + /// model predicates that might evaluate to different values at different points of execution.) + pub(crate) fn add_predicate(&mut self, predicate: Predicate<'db>) -> ScopedPredicateId { + self.predicates.push(predicate) + } + + pub(crate) fn build(mut self) -> Predicates<'db> { + self.predicates.shrink_to_fit(); + self.predicates + } +} + +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, salsa::Update)] +pub(crate) struct Predicate<'db> { + pub(crate) node: PredicateNode<'db>, + pub(crate) is_positive: bool, +} + +impl Predicate<'_> { + pub(crate) fn negated(self) -> Self { + Self { + node: self.node, + is_positive: !self.is_positive, + } + } +} + +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, salsa::Update)] +pub(crate) enum PredicateNode<'db> { + Expression(Expression<'db>), + Pattern(PatternPredicate<'db>), + StarImportPlaceholder(StarImportPlaceholderPredicate<'db>), +} + +/// Pattern kinds for which we support type narrowing and/or static visibility analysis. +#[derive(Debug, Clone, Hash, PartialEq, salsa::Update)] +pub(crate) enum PatternPredicateKind<'db> { + Singleton(Singleton), + Value(Expression<'db>), + Or(Vec<PatternPredicateKind<'db>>), + Class(Expression<'db>), + Unsupported, +} + +#[salsa::tracked(debug)] +pub(crate) struct PatternPredicate<'db> { + pub(crate) file: File, + + pub(crate) file_scope: FileScopeId, + + pub(crate) subject: Expression<'db>, + + #[returns(ref)] + pub(crate) kind: PatternPredicateKind<'db>, + + pub(crate) guard: Option<Expression<'db>>, + + count: countme::Count<PatternPredicate<'static>>, +} + +impl<'db> PatternPredicate<'db> { + pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { + self.file_scope(db).to_scope_id(db, self.file(db)) + } +} + +/// A "placeholder predicate" that is used to model the fact that the boundness of a +/// (possible) definition or declaration caused by a `*` import cannot be fully determined +/// until type-inference time. This is essentially the same as a standard visibility constraint, +/// so we reuse the [`Predicate`] infrastructure to model it. +/// +/// To illustrate, say we have a module `exporter.py` like so: +/// +/// ```py +/// if <condition>: +/// class A: ... +/// ``` +/// +/// and we have a module `importer.py` like so: +/// +/// ```py +/// A = 1 +/// +/// from importer import * +/// ``` +/// +/// Since we cannot know whether or not <condition> is true at semantic-index time, +/// we record a definition for `A` in `b.py` as a result of the `from a import *` +/// statement, but place a predicate on it to record the fact that we don't yet +/// know whether this definition will be visible from all control-flow paths or not. +/// Essentially, we model `b.py` as something similar to this: +/// +/// ```py +/// A = 1 +/// +/// if <star_import_placeholder_predicate>: +/// from a import A +/// ``` +/// +/// At type-check time, the placeholder predicate for the `A` definition is evaluated by +/// attempting to resolve the `A` symbol in `a.py`'s global namespace: +/// - If it resolves to a definitely bound symbol, then the predicate resolves to [`Truthiness::AlwaysTrue`] +/// - If it resolves to an unbound symbol, then the predicate resolves to [`Truthiness::AlwaysFalse`] +/// - If it resolves to a possibly bound symbol, then the predicate resolves to [`Truthiness::Ambiguous`] +/// +/// [Truthiness]: [crate::types::Truthiness] +#[salsa::tracked(debug)] +pub(crate) struct StarImportPlaceholderPredicate<'db> { + pub(crate) importing_file: File, + + /// Each symbol imported by a `*` import has a separate predicate associated with it: + /// this field identifies which symbol that is. + /// + /// Note that a [`ScopedSymbolId`] is only meaningful if you also know the scope + /// it is relative to. For this specific struct, however, there's no need to store a + /// separate field to hold the ID of the scope. `StarImportPredicate`s are only created + /// for valid `*`-import definitions, and valid `*`-import definitions can only ever + /// exist in the global scope; thus, we know that the `symbol_id` here will be relative + /// to the global scope of the importing file. + pub(crate) symbol_id: ScopedSymbolId, + + pub(crate) referenced_file: File, +} + +impl<'db> StarImportPlaceholderPredicate<'db> { + pub(crate) fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { + // See doc-comment above [`StarImportPlaceholderPredicate::symbol_id`]: + // valid `*`-import definitions can only take place in the global scope. + global_scope(db, self.importing_file(db)) + } +} + +impl<'db> From<StarImportPlaceholderPredicate<'db>> for Predicate<'db> { + fn from(predicate: StarImportPlaceholderPredicate<'db>) -> Self { + Predicate { + node: PredicateNode::StarImportPlaceholder(predicate), + is_positive: true, + } + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/re_exports.rs b/crates/ty_python_semantic/src/semantic_index/re_exports.rs new file mode 100644 index 0000000000000..b8002dbf0bd2a --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/re_exports.rs @@ -0,0 +1,413 @@ +//! A visitor and query to find all global-scope symbols that are exported from a module +//! when a wildcard import is used. +//! +//! For example, if a module `foo` contains `from bar import *`, which symbols from the global +//! scope of `bar` are imported into the global namespace of `foo`? +//! +//! ## Why is this a separate query rather than a part of semantic indexing? +//! +//! This query is called by the [`super::SemanticIndexBuilder`] in order to add the correct +//! [`super::Definition`]s to the semantic index of a module `foo` if `foo` has a +//! `from bar import *` statement in its global namespace. Adding the correct `Definition`s to +//! `foo`'s [`super::SemanticIndex`] requires knowing which symbols are exported from `bar`. +//! +//! If we determined the set of exported names during semantic indexing rather than as a +//! separate query, we would need to complete semantic indexing on `bar` in order to +//! complete analysis of the global namespace of `foo`. Since semantic indexing is somewhat +//! expensive, this would be undesirable. A separate query allows us to avoid this issue. +//! +//! An additional concern is that the recursive nature of this query means that it must be able +//! to handle cycles. We do this using fixpoint iteration; adding fixpoint iteration to the +//! whole [`super::semantic_index()`] query would probably be prohibitively expensive. + +use ruff_db::{files::File, parsed::parsed_module}; +use ruff_python_ast::{ + self as ast, + name::Name, + visitor::{Visitor, walk_expr, walk_pattern, walk_stmt}, +}; +use rustc_hash::FxHashMap; + +use crate::{Db, module_name::ModuleName, resolve_module}; + +fn exports_cycle_recover( + _db: &dyn Db, + _value: &[Name], + _count: u32, + _file: File, +) -> salsa::CycleRecoveryAction<Box<[Name]>> { + salsa::CycleRecoveryAction::Iterate +} + +fn exports_cycle_initial(_db: &dyn Db, _file: File) -> Box<[Name]> { + Box::default() +} + +#[salsa::tracked(returns(deref), cycle_fn=exports_cycle_recover, cycle_initial=exports_cycle_initial)] +pub(super) fn exported_names(db: &dyn Db, file: File) -> Box<[Name]> { + let module = parsed_module(db.upcast(), file); + let mut finder = ExportFinder::new(db, file); + finder.visit_body(module.suite()); + finder.resolve_exports() +} + +struct ExportFinder<'db> { + db: &'db dyn Db, + file: File, + visiting_stub_file: bool, + exports: FxHashMap<&'db Name, PossibleExportKind>, + dunder_all: DunderAll, +} + +impl<'db> ExportFinder<'db> { + fn new(db: &'db dyn Db, file: File) -> Self { + Self { + db, + file, + visiting_stub_file: file.is_stub(db.upcast()), + exports: FxHashMap::default(), + dunder_all: DunderAll::NotPresent, + } + } + + fn possibly_add_export(&mut self, export: &'db Name, kind: PossibleExportKind) { + self.exports.insert(export, kind); + + if export == "__all__" { + self.dunder_all = DunderAll::Present; + } + } + + fn resolve_exports(self) -> Box<[Name]> { + match self.dunder_all { + DunderAll::NotPresent => self + .exports + .into_iter() + .filter_map(|(name, kind)| { + if kind == PossibleExportKind::StubImportWithoutRedundantAlias { + return None; + } + if name.starts_with('_') { + return None; + } + Some(name.clone()) + }) + .collect(), + DunderAll::Present => self.exports.into_keys().cloned().collect(), + } + } +} + +impl<'db> Visitor<'db> for ExportFinder<'db> { + fn visit_alias(&mut self, alias: &'db ast::Alias) { + let ast::Alias { + name, + asname, + range: _, + } = alias; + + let name = &name.id; + let asname = asname.as_ref().map(|asname| &asname.id); + + // If the source is a stub, names defined by imports are only exported + // if they use the explicit `foo as foo` syntax: + let kind = if self.visiting_stub_file && asname.is_none_or(|asname| asname != name) { + PossibleExportKind::StubImportWithoutRedundantAlias + } else { + PossibleExportKind::Normal + }; + + self.possibly_add_export(asname.unwrap_or(name), kind); + } + + fn visit_pattern(&mut self, pattern: &'db ast::Pattern) { + match pattern { + ast::Pattern::MatchAs(ast::PatternMatchAs { + pattern, + name, + range: _, + }) => { + if let Some(pattern) = pattern { + self.visit_pattern(pattern); + } + if let Some(name) = name { + // Wildcard patterns (`case _:`) do not bind names. + // Currently `self.possibly_add_export()` just ignores + // all names with leading underscores, but this will not always be the case + // (in the future we will want to support modules with `__all__ = ['_']`). + if name != "_" { + self.possibly_add_export(&name.id, PossibleExportKind::Normal); + } + } + } + ast::Pattern::MatchMapping(ast::PatternMatchMapping { + patterns, + rest, + keys: _, + range: _, + }) => { + for pattern in patterns { + self.visit_pattern(pattern); + } + if let Some(rest) = rest { + self.possibly_add_export(&rest.id, PossibleExportKind::Normal); + } + } + ast::Pattern::MatchStar(ast::PatternMatchStar { name, range: _ }) => { + if let Some(name) = name { + self.possibly_add_export(&name.id, PossibleExportKind::Normal); + } + } + ast::Pattern::MatchSequence(_) + | ast::Pattern::MatchOr(_) + | ast::Pattern::MatchClass(_) => { + walk_pattern(self, pattern); + } + ast::Pattern::MatchSingleton(_) | ast::Pattern::MatchValue(_) => {} + } + } + + fn visit_stmt(&mut self, stmt: &'db ast::Stmt) { + match stmt { + ast::Stmt::ClassDef(ast::StmtClassDef { + name, + decorator_list, + arguments, + type_params: _, // We don't want to visit the type params of the class + body: _, // We don't want to visit the body of the class + range: _, + }) => { + self.possibly_add_export(&name.id, PossibleExportKind::Normal); + for decorator in decorator_list { + self.visit_decorator(decorator); + } + if let Some(arguments) = arguments { + self.visit_arguments(arguments); + } + } + + ast::Stmt::FunctionDef(ast::StmtFunctionDef { + name, + decorator_list, + parameters, + returns, + type_params: _, // We don't want to visit the type params of the function + body: _, // We don't want to visit the body of the function + range: _, + is_async: _, + }) => { + self.possibly_add_export(&name.id, PossibleExportKind::Normal); + for decorator in decorator_list { + self.visit_decorator(decorator); + } + self.visit_parameters(parameters); + if let Some(returns) = returns { + self.visit_expr(returns); + } + } + + ast::Stmt::AnnAssign(ast::StmtAnnAssign { + target, + value, + annotation, + simple: _, + range: _, + }) => { + if value.is_some() || self.visiting_stub_file { + self.visit_expr(target); + } + self.visit_expr(annotation); + if let Some(value) = value { + self.visit_expr(value); + } + } + + ast::Stmt::TypeAlias(ast::StmtTypeAlias { + name, + type_params: _, + value: _, + range: _, + }) => { + self.visit_expr(name); + // Neither walrus expressions nor statements cannot appear in type aliases; + // no need to recursively visit the `value` or `type_params` + } + + ast::Stmt::ImportFrom(node) => { + let mut found_star = false; + for name in &node.names { + if &name.name.id == "*" { + if !found_star { + found_star = true; + for export in + ModuleName::from_import_statement(self.db, self.file, node) + .ok() + .and_then(|module_name| resolve_module(self.db, &module_name)) + .iter() + .flat_map(|module| { + module + .file() + .map(|file| exported_names(self.db, file)) + .unwrap_or_default() + }) + { + self.possibly_add_export(export, PossibleExportKind::Normal); + } + } + } else { + self.visit_alias(name); + } + } + } + + ast::Stmt::Import(_) + | ast::Stmt::AugAssign(_) + | ast::Stmt::While(_) + | ast::Stmt::If(_) + | ast::Stmt::With(_) + | ast::Stmt::Assert(_) + | ast::Stmt::Try(_) + | ast::Stmt::Expr(_) + | ast::Stmt::For(_) + | ast::Stmt::Assign(_) + | ast::Stmt::Match(_) => walk_stmt(self, stmt), + + ast::Stmt::Global(_) + | ast::Stmt::Raise(_) + | ast::Stmt::Return(_) + | ast::Stmt::Break(_) + | ast::Stmt::Continue(_) + | ast::Stmt::IpyEscapeCommand(_) + | ast::Stmt::Delete(_) + | ast::Stmt::Nonlocal(_) + | ast::Stmt::Pass(_) => {} + } + } + + fn visit_expr(&mut self, expr: &'db ast::Expr) { + match expr { + ast::Expr::Name(ast::ExprName { id, ctx, range: _ }) => { + if ctx.is_store() { + self.possibly_add_export(id, PossibleExportKind::Normal); + } + } + + ast::Expr::Lambda(_) + | ast::Expr::BooleanLiteral(_) + | ast::Expr::NoneLiteral(_) + | ast::Expr::NumberLiteral(_) + | ast::Expr::BytesLiteral(_) + | ast::Expr::EllipsisLiteral(_) + | ast::Expr::StringLiteral(_) => {} + + // Walrus definitions "leak" from comprehension scopes into the comprehension's + // enclosing scope; they thus need special handling + ast::Expr::SetComp(_) + | ast::Expr::ListComp(_) + | ast::Expr::Generator(_) + | ast::Expr::DictComp(_) => { + let mut walrus_finder = WalrusFinder { + export_finder: self, + }; + walk_expr(&mut walrus_finder, expr); + } + + ast::Expr::BoolOp(_) + | ast::Expr::Named(_) + | ast::Expr::BinOp(_) + | ast::Expr::UnaryOp(_) + | ast::Expr::If(_) + | ast::Expr::Attribute(_) + | ast::Expr::Subscript(_) + | ast::Expr::Starred(_) + | ast::Expr::Call(_) + | ast::Expr::Compare(_) + | ast::Expr::Yield(_) + | ast::Expr::YieldFrom(_) + | ast::Expr::FString(_) + | ast::Expr::Tuple(_) + | ast::Expr::List(_) + | ast::Expr::Slice(_) + | ast::Expr::IpyEscapeCommand(_) + | ast::Expr::Dict(_) + | ast::Expr::Set(_) + | ast::Expr::Await(_) => walk_expr(self, expr), + } + } +} + +struct WalrusFinder<'a, 'db> { + export_finder: &'a mut ExportFinder<'db>, +} + +impl<'db> Visitor<'db> for WalrusFinder<'_, 'db> { + fn visit_expr(&mut self, expr: &'db ast::Expr) { + match expr { + // It's important for us to short-circuit here for lambdas specifically, + // as walruses cannot leak out of the body of a lambda function. + ast::Expr::Lambda(_) + | ast::Expr::BooleanLiteral(_) + | ast::Expr::NoneLiteral(_) + | ast::Expr::NumberLiteral(_) + | ast::Expr::BytesLiteral(_) + | ast::Expr::EllipsisLiteral(_) + | ast::Expr::StringLiteral(_) + | ast::Expr::Name(_) => {} + + ast::Expr::Named(ast::ExprNamed { + target, + value: _, + range: _, + }) => { + if let ast::Expr::Name(ast::ExprName { + id, + ctx: ast::ExprContext::Store, + range: _, + }) = &**target + { + self.export_finder + .possibly_add_export(id, PossibleExportKind::Normal); + } + } + + // We must recurse inside nested comprehensions, + // as even a walrus inside a comprehension inside a comprehension in the global scope + // will leak out into the global scope + ast::Expr::DictComp(_) + | ast::Expr::SetComp(_) + | ast::Expr::ListComp(_) + | ast::Expr::Generator(_) + | ast::Expr::BoolOp(_) + | ast::Expr::BinOp(_) + | ast::Expr::UnaryOp(_) + | ast::Expr::If(_) + | ast::Expr::Attribute(_) + | ast::Expr::Subscript(_) + | ast::Expr::Starred(_) + | ast::Expr::Call(_) + | ast::Expr::Compare(_) + | ast::Expr::Yield(_) + | ast::Expr::YieldFrom(_) + | ast::Expr::FString(_) + | ast::Expr::Tuple(_) + | ast::Expr::List(_) + | ast::Expr::Slice(_) + | ast::Expr::IpyEscapeCommand(_) + | ast::Expr::Dict(_) + | ast::Expr::Set(_) + | ast::Expr::Await(_) => walk_expr(self, expr), + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum PossibleExportKind { + Normal, + StubImportWithoutRedundantAlias, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum DunderAll { + NotPresent, + Present, +} diff --git a/crates/ty_python_semantic/src/semantic_index/symbol.rs b/crates/ty_python_semantic/src/semantic_index/symbol.rs new file mode 100644 index 0000000000000..4d25978bed26a --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/symbol.rs @@ -0,0 +1,589 @@ +use std::hash::{Hash, Hasher}; +use std::ops::Range; + +use bitflags::bitflags; +use hashbrown::hash_map::RawEntryMut; +use ruff_db::files::File; +use ruff_db::parsed::ParsedModule; +use ruff_index::{IndexVec, newtype_index}; +use ruff_python_ast as ast; +use ruff_python_ast::name::Name; +use rustc_hash::FxHasher; + +use crate::Db; +use crate::ast_node_ref::AstNodeRef; +use crate::node_key::NodeKey; +use crate::semantic_index::visibility_constraints::ScopedVisibilityConstraintId; +use crate::semantic_index::{SemanticIndex, SymbolMap, semantic_index}; + +#[derive(Eq, PartialEq, Debug)] +pub struct Symbol { + name: Name, + flags: SymbolFlags, +} + +impl Symbol { + fn new(name: Name) -> Self { + Self { + name, + flags: SymbolFlags::empty(), + } + } + + fn insert_flags(&mut self, flags: SymbolFlags) { + self.flags.insert(flags); + } + + /// The symbol's name. + pub fn name(&self) -> &Name { + &self.name + } + + /// Is the symbol used in its containing scope? + pub fn is_used(&self) -> bool { + self.flags.contains(SymbolFlags::IS_USED) + } + + /// Is the symbol defined in its containing scope? + pub fn is_bound(&self) -> bool { + self.flags.contains(SymbolFlags::IS_BOUND) + } + + /// Is the symbol declared in its containing scope? + pub fn is_declared(&self) -> bool { + self.flags.contains(SymbolFlags::IS_DECLARED) + } +} + +bitflags! { + /// Flags that can be queried to obtain information about a symbol in a given scope. + /// + /// See the doc-comment at the top of [`super::use_def`] for explanations of what it + /// means for a symbol to be *bound* as opposed to *declared*. + #[derive(Copy, Clone, Debug, Eq, PartialEq)] + struct SymbolFlags: u8 { + const IS_USED = 1 << 0; + const IS_BOUND = 1 << 1; + const IS_DECLARED = 1 << 2; + /// TODO: This flag is not yet set by anything + const MARKED_GLOBAL = 1 << 3; + /// TODO: This flag is not yet set by anything + const MARKED_NONLOCAL = 1 << 4; + } +} + +/// ID that uniquely identifies a symbol in a file. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub struct FileSymbolId { + scope: FileScopeId, + scoped_symbol_id: ScopedSymbolId, +} + +impl FileSymbolId { + pub fn scope(self) -> FileScopeId { + self.scope + } + + pub(crate) fn scoped_symbol_id(self) -> ScopedSymbolId { + self.scoped_symbol_id + } +} + +impl From<FileSymbolId> for ScopedSymbolId { + fn from(val: FileSymbolId) -> Self { + val.scoped_symbol_id() + } +} + +/// Symbol ID that uniquely identifies a symbol inside a [`Scope`]. +#[newtype_index] +#[derive(salsa::Update)] +pub struct ScopedSymbolId; + +/// A cross-module identifier of a scope that can be used as a salsa query parameter. +#[salsa::tracked(debug)] +pub struct ScopeId<'db> { + pub file: File, + + pub file_scope_id: FileScopeId, + + count: countme::Count<ScopeId<'static>>, +} + +impl<'db> ScopeId<'db> { + pub(crate) fn is_function_like(self, db: &'db dyn Db) -> bool { + self.node(db).scope_kind().is_function_like() + } + + pub(crate) fn is_type_parameter(self, db: &'db dyn Db) -> bool { + self.node(db).scope_kind().is_type_parameter() + } + + pub(crate) fn node(self, db: &dyn Db) -> &NodeWithScopeKind { + self.scope(db).node() + } + + pub(crate) fn scope(self, db: &dyn Db) -> &Scope { + semantic_index(db, self.file(db)).scope(self.file_scope_id(db)) + } + + #[cfg(test)] + pub(crate) fn name(self, db: &'db dyn Db) -> &'db str { + match self.node(db) { + NodeWithScopeKind::Module => "<module>", + NodeWithScopeKind::Class(class) | NodeWithScopeKind::ClassTypeParameters(class) => { + class.name.as_str() + } + NodeWithScopeKind::Function(function) + | NodeWithScopeKind::FunctionTypeParameters(function) => function.name.as_str(), + NodeWithScopeKind::TypeAlias(type_alias) + | NodeWithScopeKind::TypeAliasTypeParameters(type_alias) => type_alias + .name + .as_name_expr() + .map(|name| name.id.as_str()) + .unwrap_or("<type alias>"), + NodeWithScopeKind::Lambda(_) => "<lambda>", + NodeWithScopeKind::ListComprehension(_) => "<listcomp>", + NodeWithScopeKind::SetComprehension(_) => "<setcomp>", + NodeWithScopeKind::DictComprehension(_) => "<dictcomp>", + NodeWithScopeKind::GeneratorExpression(_) => "<generator>", + } + } +} + +/// ID that uniquely identifies a scope inside of a module. +#[newtype_index] +#[derive(salsa::Update)] +pub struct FileScopeId; + +impl FileScopeId { + /// Returns the scope id of the module-global scope. + pub fn global() -> Self { + FileScopeId::from_u32(0) + } + + pub fn is_global(self) -> bool { + self == FileScopeId::global() + } + + pub fn to_scope_id(self, db: &dyn Db, file: File) -> ScopeId<'_> { + let index = semantic_index(db, file); + index.scope_ids_by_scope[self] + } + + pub(crate) fn is_generator_function(self, index: &SemanticIndex) -> bool { + index.generator_functions.contains(&self) + } +} + +#[derive(Debug, salsa::Update)] +pub struct Scope { + parent: Option<FileScopeId>, + node: NodeWithScopeKind, + descendants: Range<FileScopeId>, + reachability: ScopedVisibilityConstraintId, +} + +impl Scope { + pub(super) fn new( + parent: Option<FileScopeId>, + node: NodeWithScopeKind, + descendants: Range<FileScopeId>, + reachability: ScopedVisibilityConstraintId, + ) -> Self { + Scope { + parent, + node, + descendants, + reachability, + } + } + + pub fn parent(&self) -> Option<FileScopeId> { + self.parent + } + + pub fn node(&self) -> &NodeWithScopeKind { + &self.node + } + + pub fn kind(&self) -> ScopeKind { + self.node().scope_kind() + } + + pub fn descendants(&self) -> Range<FileScopeId> { + self.descendants.clone() + } + + pub(super) fn extend_descendants(&mut self, children_end: FileScopeId) { + self.descendants = self.descendants.start..children_end; + } + + pub(crate) fn is_eager(&self) -> bool { + self.kind().is_eager() + } + + pub(crate) fn reachability(&self) -> ScopedVisibilityConstraintId { + self.reachability + } +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum ScopeKind { + Module, + Annotation, + Class, + Function, + Lambda, + Comprehension, + TypeAlias, +} + +impl ScopeKind { + pub(crate) fn is_eager(self) -> bool { + match self { + ScopeKind::Module | ScopeKind::Class | ScopeKind::Comprehension => true, + ScopeKind::Annotation + | ScopeKind::Function + | ScopeKind::Lambda + | ScopeKind::TypeAlias => false, + } + } + + pub(crate) fn is_function_like(self) -> bool { + // Type parameter scopes behave like function scopes in terms of name resolution; CPython + // symbol table also uses the term "function-like" for these scopes. + matches!( + self, + ScopeKind::Annotation + | ScopeKind::Function + | ScopeKind::Lambda + | ScopeKind::TypeAlias + | ScopeKind::Comprehension + ) + } + + pub(crate) fn is_class(self) -> bool { + matches!(self, ScopeKind::Class) + } + + pub(crate) fn is_type_parameter(self) -> bool { + matches!(self, ScopeKind::Annotation | ScopeKind::TypeAlias) + } +} + +/// Symbol table for a specific [`Scope`]. +#[derive(Default, salsa::Update)] +pub struct SymbolTable { + /// The symbols in this scope. + symbols: IndexVec<ScopedSymbolId, Symbol>, + + /// The symbols indexed by name. + symbols_by_name: SymbolMap, +} + +impl SymbolTable { + fn shrink_to_fit(&mut self) { + self.symbols.shrink_to_fit(); + } + + pub(crate) fn symbol(&self, symbol_id: impl Into<ScopedSymbolId>) -> &Symbol { + &self.symbols[symbol_id.into()] + } + + #[expect(unused)] + pub(crate) fn symbol_ids(&self) -> impl Iterator<Item = ScopedSymbolId> { + self.symbols.indices() + } + + pub fn symbols(&self) -> impl Iterator<Item = &Symbol> { + self.symbols.iter() + } + + /// Returns the symbol named `name`. + pub(crate) fn symbol_by_name(&self, name: &str) -> Option<&Symbol> { + let id = self.symbol_id_by_name(name)?; + Some(self.symbol(id)) + } + + /// Returns the [`ScopedSymbolId`] of the symbol named `name`. + pub(crate) fn symbol_id_by_name(&self, name: &str) -> Option<ScopedSymbolId> { + let (id, ()) = self + .symbols_by_name + .raw_entry() + .from_hash(Self::hash_name(name), |id| { + self.symbol(*id).name().as_str() == name + })?; + + Some(*id) + } + + fn hash_name(name: &str) -> u64 { + let mut hasher = FxHasher::default(); + name.hash(&mut hasher); + hasher.finish() + } +} + +impl PartialEq for SymbolTable { + fn eq(&self, other: &Self) -> bool { + // We don't need to compare the symbols_by_name because the name is already captured in `Symbol`. + self.symbols == other.symbols + } +} + +impl Eq for SymbolTable {} + +impl std::fmt::Debug for SymbolTable { + /// Exclude the `symbols_by_name` field from the debug output. + /// It's very noisy and not useful for debugging. + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_tuple("SymbolTable") + .field(&self.symbols) + .finish_non_exhaustive() + } +} + +#[derive(Debug, Default)] +pub(super) struct SymbolTableBuilder { + table: SymbolTable, +} + +impl SymbolTableBuilder { + pub(super) fn add_symbol(&mut self, name: Name) -> (ScopedSymbolId, bool) { + let hash = SymbolTable::hash_name(&name); + let entry = self + .table + .symbols_by_name + .raw_entry_mut() + .from_hash(hash, |id| self.table.symbols[*id].name() == &name); + + match entry { + RawEntryMut::Occupied(entry) => (*entry.key(), false), + RawEntryMut::Vacant(entry) => { + let symbol = Symbol::new(name); + + let id = self.table.symbols.push(symbol); + entry.insert_with_hasher(hash, id, (), |id| { + SymbolTable::hash_name(self.table.symbols[*id].name().as_str()) + }); + (id, true) + } + } + } + + pub(super) fn mark_symbol_bound(&mut self, id: ScopedSymbolId) { + self.table.symbols[id].insert_flags(SymbolFlags::IS_BOUND); + } + + pub(super) fn mark_symbol_declared(&mut self, id: ScopedSymbolId) { + self.table.symbols[id].insert_flags(SymbolFlags::IS_DECLARED); + } + + pub(super) fn mark_symbol_used(&mut self, id: ScopedSymbolId) { + self.table.symbols[id].insert_flags(SymbolFlags::IS_USED); + } + + pub(super) fn symbols(&self) -> impl Iterator<Item = &Symbol> { + self.table.symbols() + } + + pub(super) fn symbol_id_by_name(&self, name: &str) -> Option<ScopedSymbolId> { + self.table.symbol_id_by_name(name) + } + + pub(super) fn symbol(&self, symbol_id: impl Into<ScopedSymbolId>) -> &Symbol { + self.table.symbol(symbol_id) + } + + pub(super) fn finish(mut self) -> SymbolTable { + self.table.shrink_to_fit(); + self.table + } +} + +/// Reference to a node that introduces a new scope. +#[derive(Copy, Clone, Debug)] +pub(crate) enum NodeWithScopeRef<'a> { + Module, + Class(&'a ast::StmtClassDef), + Function(&'a ast::StmtFunctionDef), + Lambda(&'a ast::ExprLambda), + FunctionTypeParameters(&'a ast::StmtFunctionDef), + ClassTypeParameters(&'a ast::StmtClassDef), + TypeAlias(&'a ast::StmtTypeAlias), + TypeAliasTypeParameters(&'a ast::StmtTypeAlias), + ListComprehension(&'a ast::ExprListComp), + SetComprehension(&'a ast::ExprSetComp), + DictComprehension(&'a ast::ExprDictComp), + GeneratorExpression(&'a ast::ExprGenerator), +} + +impl NodeWithScopeRef<'_> { + /// Converts the unowned reference to an owned [`NodeWithScopeKind`]. + /// + /// # Safety + /// The node wrapped by `self` must be a child of `module`. + #[expect(unsafe_code)] + pub(super) unsafe fn to_kind(self, module: ParsedModule) -> NodeWithScopeKind { + unsafe { + match self { + NodeWithScopeRef::Module => NodeWithScopeKind::Module, + NodeWithScopeRef::Class(class) => { + NodeWithScopeKind::Class(AstNodeRef::new(module, class)) + } + NodeWithScopeRef::Function(function) => { + NodeWithScopeKind::Function(AstNodeRef::new(module, function)) + } + NodeWithScopeRef::TypeAlias(type_alias) => { + NodeWithScopeKind::TypeAlias(AstNodeRef::new(module, type_alias)) + } + NodeWithScopeRef::TypeAliasTypeParameters(type_alias) => { + NodeWithScopeKind::TypeAliasTypeParameters(AstNodeRef::new(module, type_alias)) + } + NodeWithScopeRef::Lambda(lambda) => { + NodeWithScopeKind::Lambda(AstNodeRef::new(module, lambda)) + } + NodeWithScopeRef::FunctionTypeParameters(function) => { + NodeWithScopeKind::FunctionTypeParameters(AstNodeRef::new(module, function)) + } + NodeWithScopeRef::ClassTypeParameters(class) => { + NodeWithScopeKind::ClassTypeParameters(AstNodeRef::new(module, class)) + } + NodeWithScopeRef::ListComprehension(comprehension) => { + NodeWithScopeKind::ListComprehension(AstNodeRef::new(module, comprehension)) + } + NodeWithScopeRef::SetComprehension(comprehension) => { + NodeWithScopeKind::SetComprehension(AstNodeRef::new(module, comprehension)) + } + NodeWithScopeRef::DictComprehension(comprehension) => { + NodeWithScopeKind::DictComprehension(AstNodeRef::new(module, comprehension)) + } + NodeWithScopeRef::GeneratorExpression(generator) => { + NodeWithScopeKind::GeneratorExpression(AstNodeRef::new(module, generator)) + } + } + } + } + + pub(crate) fn node_key(self) -> NodeWithScopeKey { + match self { + NodeWithScopeRef::Module => NodeWithScopeKey::Module, + NodeWithScopeRef::Class(class) => NodeWithScopeKey::Class(NodeKey::from_node(class)), + NodeWithScopeRef::Function(function) => { + NodeWithScopeKey::Function(NodeKey::from_node(function)) + } + NodeWithScopeRef::Lambda(lambda) => { + NodeWithScopeKey::Lambda(NodeKey::from_node(lambda)) + } + NodeWithScopeRef::FunctionTypeParameters(function) => { + NodeWithScopeKey::FunctionTypeParameters(NodeKey::from_node(function)) + } + NodeWithScopeRef::ClassTypeParameters(class) => { + NodeWithScopeKey::ClassTypeParameters(NodeKey::from_node(class)) + } + NodeWithScopeRef::TypeAlias(type_alias) => { + NodeWithScopeKey::TypeAlias(NodeKey::from_node(type_alias)) + } + NodeWithScopeRef::TypeAliasTypeParameters(type_alias) => { + NodeWithScopeKey::TypeAliasTypeParameters(NodeKey::from_node(type_alias)) + } + NodeWithScopeRef::ListComprehension(comprehension) => { + NodeWithScopeKey::ListComprehension(NodeKey::from_node(comprehension)) + } + NodeWithScopeRef::SetComprehension(comprehension) => { + NodeWithScopeKey::SetComprehension(NodeKey::from_node(comprehension)) + } + NodeWithScopeRef::DictComprehension(comprehension) => { + NodeWithScopeKey::DictComprehension(NodeKey::from_node(comprehension)) + } + NodeWithScopeRef::GeneratorExpression(generator) => { + NodeWithScopeKey::GeneratorExpression(NodeKey::from_node(generator)) + } + } + } +} + +/// Node that introduces a new scope. +#[derive(Clone, Debug, salsa::Update)] +pub enum NodeWithScopeKind { + Module, + Class(AstNodeRef<ast::StmtClassDef>), + ClassTypeParameters(AstNodeRef<ast::StmtClassDef>), + Function(AstNodeRef<ast::StmtFunctionDef>), + FunctionTypeParameters(AstNodeRef<ast::StmtFunctionDef>), + TypeAliasTypeParameters(AstNodeRef<ast::StmtTypeAlias>), + TypeAlias(AstNodeRef<ast::StmtTypeAlias>), + Lambda(AstNodeRef<ast::ExprLambda>), + ListComprehension(AstNodeRef<ast::ExprListComp>), + SetComprehension(AstNodeRef<ast::ExprSetComp>), + DictComprehension(AstNodeRef<ast::ExprDictComp>), + GeneratorExpression(AstNodeRef<ast::ExprGenerator>), +} + +impl NodeWithScopeKind { + pub(crate) const fn scope_kind(&self) -> ScopeKind { + match self { + Self::Module => ScopeKind::Module, + Self::Class(_) => ScopeKind::Class, + Self::Function(_) => ScopeKind::Function, + Self::Lambda(_) => ScopeKind::Lambda, + Self::FunctionTypeParameters(_) + | Self::ClassTypeParameters(_) + | Self::TypeAliasTypeParameters(_) => ScopeKind::Annotation, + Self::TypeAlias(_) => ScopeKind::TypeAlias, + Self::ListComprehension(_) + | Self::SetComprehension(_) + | Self::DictComprehension(_) + | Self::GeneratorExpression(_) => ScopeKind::Comprehension, + } + } + + pub fn expect_class(&self) -> &ast::StmtClassDef { + match self { + Self::Class(class) => class.node(), + _ => panic!("expected class"), + } + } + + pub(crate) const fn as_class(&self) -> Option<&ast::StmtClassDef> { + match self { + Self::Class(class) => Some(class.node()), + _ => None, + } + } + + pub fn expect_function(&self) -> &ast::StmtFunctionDef { + self.as_function().expect("expected function") + } + + pub fn expect_type_alias(&self) -> &ast::StmtTypeAlias { + match self { + Self::TypeAlias(type_alias) => type_alias.node(), + _ => panic!("expected type alias"), + } + } + + pub const fn as_function(&self) -> Option<&ast::StmtFunctionDef> { + match self { + Self::Function(function) => Some(function.node()), + _ => None, + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub(crate) enum NodeWithScopeKey { + Module, + Class(NodeKey), + ClassTypeParameters(NodeKey), + Function(NodeKey), + FunctionTypeParameters(NodeKey), + TypeAlias(NodeKey), + TypeAliasTypeParameters(NodeKey), + Lambda(NodeKey), + ListComprehension(NodeKey), + SetComprehension(NodeKey), + DictComprehension(NodeKey), + GeneratorExpression(NodeKey), +} diff --git a/crates/ty_python_semantic/src/semantic_index/use_def.rs b/crates/ty_python_semantic/src/semantic_index/use_def.rs new file mode 100644 index 0000000000000..7605843db4e20 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/use_def.rs @@ -0,0 +1,1168 @@ +//! First, some terminology: +//! +//! * A "binding" gives a new value to a variable. This includes many different Python statements +//! (assignment statements of course, but also imports, `def` and `class` statements, `as` +//! clauses in `with` and `except` statements, match patterns, and others) and even one +//! expression kind (named expressions). It notably does not include annotated assignment +//! statements without a right-hand side value; these do not assign any new value to the +//! variable. We consider function parameters to be bindings as well, since (from the perspective +//! of the function's internal scope), a function parameter begins the scope bound to a value. +//! +//! * A "declaration" establishes an upper bound type for the values that a variable may be +//! permitted to take on. Annotated assignment statements (with or without an RHS value) are +//! declarations; annotated function parameters are also declarations. We consider `def` and +//! `class` statements to also be declarations, so as to prohibit accidentally shadowing them. +//! +//! Annotated assignments with a right-hand side, and annotated function parameters, are both +//! bindings and declarations. +//! +//! We use [`Definition`] as the universal term (and Salsa tracked struct) encompassing both +//! bindings and declarations. (This sacrifices a bit of type safety in exchange for improved +//! performance via fewer Salsa tracked structs and queries, since most declarations -- typed +//! parameters and annotated assignments with RHS -- are both bindings and declarations.) +//! +//! At any given use of a variable, we can ask about both its "declared type" and its "inferred +//! type". These may be different, but the inferred type must always be assignable to the declared +//! type; that is, the declared type is always wider, and the inferred type may be more precise. If +//! we see an invalid assignment, we emit a diagnostic and abandon our inferred type, deferring to +//! the declared type (this allows an explicit annotation to override bad inference, without a +//! cast), maintaining the invariant. +//! +//! The **inferred type** represents the most precise type we believe encompasses all possible +//! values for the variable at a given use. It is based on a union of the bindings which can reach +//! that use through some control flow path, and the narrowing constraints that control flow must +//! have passed through between the binding and the use. For example, in this code: +//! +//! ```python +//! x = 1 if flag else None +//! if x is not None: +//! use(x) +//! ``` +//! +//! For the use of `x` on the third line, the inferred type should be `Literal[1]`. This is based +//! on the binding on the first line, which assigns the type `Literal[1] | None`, and the narrowing +//! constraint on the second line, which rules out the type `None`, since control flow must pass +//! through this constraint to reach the use in question. +//! +//! The **declared type** represents the code author's declaration (usually through a type +//! annotation) that a given variable should not be assigned any type outside the declared type. In +//! our model, declared types are also control-flow-sensitive; we allow the code author to +//! explicitly redeclare the same variable with a different type. So for a given binding of a +//! variable, we will want to ask which declarations of that variable can reach that binding, in +//! order to determine whether the binding is permitted, or should be a type error. For example: +//! +//! ```python +//! from pathlib import Path +//! def f(path: str): +//! path: Path = Path(path) +//! ``` +//! +//! In this function, the initial declared type of `path` is `str`, meaning that the assignment +//! `path = Path(path)` would be a type error, since it assigns to `path` a value whose type is not +//! assignable to `str`. This is the purpose of declared types: they prevent accidental assignment +//! of the wrong type to a variable. +//! +//! But in some cases it is useful to "shadow" or "redeclare" a variable with a new type, and we +//! permit this, as long as it is done with an explicit re-annotation. So `path: Path = +//! Path(path)`, with the explicit `: Path` annotation, is permitted. +//! +//! The general rule is that whatever declaration(s) can reach a given binding determine the +//! validity of that binding. If there is a path in which the symbol is not declared, that is a +//! declaration of `Unknown`. If multiple declarations can reach a binding, we union them, but by +//! default we also issue a type error, since this implicit union of declared types may hide an +//! error. +//! +//! To support type inference, we build a map from each use of a symbol to the bindings live at +//! that use, and the type narrowing constraints that apply to each binding. +//! +//! Let's take this code sample: +//! +//! ```python +//! x = 1 +//! x = 2 +//! y = x +//! if flag: +//! x = 3 +//! else: +//! x = 4 +//! z = x +//! ``` +//! +//! In this snippet, we have four bindings of `x` (the statements assigning `1`, `2`, `3`, and `4` +//! to it), and two uses of `x` (the `y = x` and `z = x` assignments). The first binding of `x` +//! does not reach any use, because it's immediately replaced by the second binding, before any use +//! happens. (A linter could thus flag the statement `x = 1` as likely superfluous.) +//! +//! The first use of `x` has one live binding: the assignment `x = 2`. +//! +//! Things get a bit more complex when we have branches. We will definitely take either the `if` or +//! the `else` branch. Thus, the second use of `x` has two live bindings: `x = 3` and `x = 4`. The +//! `x = 2` assignment is no longer visible, because it must be replaced by either `x = 3` or `x = +//! 4`, no matter which branch was taken. We don't know which branch was taken, so we must consider +//! both bindings as live, which means eventually we would (in type inference) look at these two +//! bindings and infer a type of `Literal[3, 4]` -- the union of `Literal[3]` and `Literal[4]` -- +//! for the second use of `x`. +//! +//! So that's one question our use-def map needs to answer: given a specific use of a symbol, which +//! binding(s) can reach that use. In [`AstIds`](crate::semantic_index::ast_ids::AstIds) we number +//! all uses (that means a `Name` node with `Load` context) so we have a `ScopedUseId` to +//! efficiently represent each use. +//! +//! We also need to know, for a given definition of a symbol, what type narrowing constraints apply +//! to it. For instance, in this code sample: +//! +//! ```python +//! x = 1 if flag else None +//! if x is not None: +//! use(x) +//! ``` +//! +//! At the use of `x`, the live binding of `x` is `1 if flag else None`, which would infer as the +//! type `Literal[1] | None`. But the constraint `x is not None` dominates this use, which means we +//! can rule out the possibility that `x` is `None` here, which should give us the type +//! `Literal[1]` for this use. +//! +//! For declared types, we need to be able to answer the question "given a binding to a symbol, +//! which declarations of that symbol can reach the binding?" This allows us to emit a diagnostic +//! if the binding is attempting to bind a value of a type that is not assignable to the declared +//! type for that symbol, at that point in control flow. +//! +//! We also need to know, given a declaration of a symbol, what the inferred type of that symbol is +//! at that point. This allows us to emit a diagnostic in a case like `x = "foo"; x: int`. The +//! binding `x = "foo"` occurs before the declaration `x: int`, so according to our +//! control-flow-sensitive interpretation of declarations, the assignment is not an error. But the +//! declaration is an error, since it would violate the "inferred type must be assignable to +//! declared type" rule. +//! +//! Another case we need to handle is when a symbol is referenced from a different scope (for +//! example, an import or a nonlocal reference). We call this "public" use of a symbol. For public +//! use of a symbol, we prefer the declared type, if there are any declarations of that symbol; if +//! not, we fall back to the inferred type. So we also need to know which declarations and bindings +//! can reach the end of the scope. +//! +//! Technically, public use of a symbol could occur from any point in control flow of the scope +//! where the symbol is defined (via inline imports and import cycles, in the case of an import, or +//! via a function call partway through the local scope that ends up using a symbol from the scope +//! via a global or nonlocal reference.) But modeling this fully accurately requires whole-program +//! analysis that isn't tractable for an efficient analysis, since it means a given symbol could +//! have a different type every place it's referenced throughout the program, depending on the +//! shape of arbitrarily-sized call/import graphs. So we follow other Python type checkers in +//! making the simplifying assumption that usually the scope will finish execution before its +//! symbols are made visible to other scopes; for instance, most imports will import from a +//! complete module, not a partially-executed module. (We may want to get a little smarter than +//! this in the future for some closures, but for now this is where we start.) +//! +//! The data structure we build to answer these questions is the `UseDefMap`. It has a +//! `bindings_by_use` vector of [`SymbolBindings`] indexed by [`ScopedUseId`], a +//! `declarations_by_binding` vector of [`SymbolDeclarations`] indexed by [`ScopedDefinitionId`], a +//! `bindings_by_declaration` vector of [`SymbolBindings`] indexed by [`ScopedDefinitionId`], and +//! `public_bindings` and `public_definitions` vectors indexed by [`ScopedSymbolId`]. The values in +//! each of these vectors are (in principle) a list of live bindings at that use/definition, or at +//! the end of the scope for that symbol, with a list of the dominating constraints for each +//! binding. +//! +//! In order to avoid vectors-of-vectors-of-vectors and all the allocations that would entail, we +//! don't actually store these "list of visible definitions" as a vector of [`Definition`]. +//! Instead, [`SymbolBindings`] and [`SymbolDeclarations`] are structs which use bit-sets to track +//! definitions (and constraints, in the case of bindings) in terms of [`ScopedDefinitionId`] and +//! [`ScopedPredicateId`], which are indices into the `all_definitions` and `predicates` +//! indexvecs in the [`UseDefMap`]. +//! +//! There is another special kind of possible "definition" for a symbol: there might be a path from +//! the scope entry to a given use in which the symbol is never bound. We model this with a special +//! "unbound" definition (a `None` entry at the start of the `all_definitions` vector). If that +//! sentinel definition is present in the live bindings at a given use, it means that there is a +//! possible path through control flow in which that symbol is unbound. Similarly, if that sentinel +//! is present in the live declarations, it means that the symbol is (possibly) undeclared. +//! +//! To build a [`UseDefMap`], the [`UseDefMapBuilder`] is notified of each new use, definition, and +//! constraint as they are encountered by the +//! [`SemanticIndexBuilder`](crate::semantic_index::builder::SemanticIndexBuilder) AST visit. For +//! each symbol, the builder tracks the `SymbolState` (`SymbolBindings` and `SymbolDeclarations`) +//! for that symbol. When we hit a use or definition of a symbol, we record the necessary parts of +//! the current state for that symbol that we need for that use or definition. When we reach the +//! end of the scope, it records the state for each symbol as the public definitions of that +//! symbol. +//! +//! Let's walk through the above example. Initially we do not have any record of `x`. When we add +//! the new symbol (before we process the first binding), we create a new undefined `SymbolState` +//! which has a single live binding (the "unbound" definition) and a single live declaration (the +//! "undeclared" definition). When we see `x = 1`, we record that as the sole live binding of `x`. +//! The "unbound" binding is no longer visible. Then we see `x = 2`, and we replace `x = 1` as the +//! sole live binding of `x`. When we get to `y = x`, we record that the live bindings for that use +//! of `x` are just the `x = 2` definition. +//! +//! Then we hit the `if` branch. We visit the `test` node (`flag` in this case), since that will +//! happen regardless. Then we take a pre-branch snapshot of the current state for all symbols, +//! which we'll need later. Then we record `flag` as a possible constraint on the current binding +//! (`x = 2`), and go ahead and visit the `if` body. When we see `x = 3`, it replaces `x = 2` +//! (constrained by `flag`) as the sole live binding of `x`. At the end of the `if` body, we take +//! another snapshot of the current symbol state; we'll call this the post-if-body snapshot. +//! +//! Now we need to visit the `else` clause. The conditions when entering the `else` clause should +//! be the pre-if conditions; if we are entering the `else` clause, we know that the `if` test +//! failed and we didn't execute the `if` body. So we first reset the builder to the pre-if state, +//! using the snapshot we took previously (meaning we now have `x = 2` as the sole binding for `x` +//! again), and record a *negative* `flag` constraint for all live bindings (`x = 2`). We then +//! visit the `else` clause, where `x = 4` replaces `x = 2` as the sole live binding of `x`. +//! +//! Now we reach the end of the if/else, and want to visit the following code. The state here needs +//! to reflect that we might have gone through the `if` branch, or we might have gone through the +//! `else` branch, and we don't know which. So we need to "merge" our current builder state +//! (reflecting the end-of-else state, with `x = 4` as the only live binding) with our post-if-body +//! snapshot (which has `x = 3` as the only live binding). The result of this merge is that we now +//! have two live bindings of `x`: `x = 3` and `x = 4`. +//! +//! Another piece of information that the `UseDefMap` needs to provide are visibility constraints. +//! These are similar to the narrowing constraints, but apply to bindings and declarations within a +//! control flow path. Consider the following example: +//! ```py +//! x = 1 +//! if test: +//! x = 2 +//! y = "y" +//! ``` +//! In principle, there are two possible control flow paths here. However, if we can statically +//! infer `test` to be always truthy or always falsy (that is, `__bool__` of `test` is of type +//! `Literal[True]` or `Literal[False]`), we can rule out one of the possible paths. To support +//! this feature, we record a visibility constraint of `test` to all live bindings and declarations +//! *after* visiting the body of the `if` statement. And we record a negative visibility constraint +//! `~test` to all live bindings/declarations in the (implicit) `else` branch. For the example +//! above, we would record the following visibility constraints (adding the implicit "unbound" +//! definitions for clarity): +//! ```py +//! x = <unbound> # not live, shadowed by `x = 1` +//! y = <unbound> # visibility constraint: ~test +//! +//! x = 1 # visibility constraint: ~test +//! if test: +//! x = 2 # visibility constraint: test +//! y = "y" # visibility constraint: test +//! ``` +//! When we encounter a use of `x` after this `if` statement, we would record two live bindings: `x +//! = 1` with a constraint of `~test`, and `x = 2` with a constraint of `test`. In type inference, +//! when we iterate over all live bindings, we can evaluate these constraints to determine if a +//! particular binding is actually visible. For example, if `test` is always truthy, we only see +//! the `x = 2` binding. If `test` is always falsy, we only see the `x = 1` binding. And if the +//! `__bool__` method of `test` returns type `bool`, we can see both bindings. +//! +//! Note that we also record visibility constraints for the start of the scope. This is important +//! to determine if a symbol is definitely bound, possibly unbound, or definitely unbound. In the +//! example above, The `y = <unbound>` binding is constrained by `~test`, so `y` would only be +//! definitely-bound if `test` is always truthy. +//! +//! The [`UseDefMapBuilder`] itself just exposes methods for taking a snapshot, resetting to a +//! snapshot, and merging a snapshot into the current state. The logic using these methods lives in +//! [`SemanticIndexBuilder`](crate::semantic_index::builder::SemanticIndexBuilder), e.g. where it +//! visits a `StmtIf` node. + +use ruff_index::{IndexVec, newtype_index}; +use rustc_hash::FxHashMap; + +use self::symbol_state::{ + EagerSnapshot, LiveBindingsIterator, LiveDeclaration, LiveDeclarationsIterator, + ScopedDefinitionId, SymbolBindings, SymbolDeclarations, SymbolState, +}; +use crate::node_key::NodeKey; +use crate::semantic_index::EagerSnapshotResult; +use crate::semantic_index::ast_ids::ScopedUseId; +use crate::semantic_index::definition::Definition; +use crate::semantic_index::narrowing_constraints::{ + ConstraintKey, NarrowingConstraints, NarrowingConstraintsBuilder, NarrowingConstraintsIterator, +}; +use crate::semantic_index::predicate::{ + Predicate, Predicates, PredicatesBuilder, ScopedPredicateId, StarImportPlaceholderPredicate, +}; +use crate::semantic_index::symbol::{FileScopeId, ScopeKind, ScopedSymbolId}; +use crate::semantic_index::visibility_constraints::{ + ScopedVisibilityConstraintId, VisibilityConstraints, VisibilityConstraintsBuilder, +}; +use crate::types::{IntersectionBuilder, Truthiness, Type, infer_narrowing_constraint}; + +mod symbol_state; + +/// Applicable definitions and constraints for every use of a name. +#[derive(Debug, PartialEq, Eq, salsa::Update)] +pub(crate) struct UseDefMap<'db> { + /// Array of [`Definition`] in this scope. Only the first entry should be `None`; + /// this represents the implicit "unbound"/"undeclared" definition of every symbol. + all_definitions: IndexVec<ScopedDefinitionId, Option<Definition<'db>>>, + + /// Array of predicates in this scope. + predicates: Predicates<'db>, + + /// Array of narrowing constraints in this scope. + narrowing_constraints: NarrowingConstraints, + + /// Array of visibility constraints in this scope. + visibility_constraints: VisibilityConstraints, + + /// [`SymbolBindings`] reaching a [`ScopedUseId`]. + bindings_by_use: IndexVec<ScopedUseId, SymbolBindings>, + + /// Tracks whether or not a given AST node is reachable from the start of the scope. + node_reachability: FxHashMap<NodeKey, ScopedVisibilityConstraintId>, + + /// If the definition is a binding (only) -- `x = 1` for example -- then we need + /// [`SymbolDeclarations`] to know whether this binding is permitted by the live declarations. + /// + /// If the definition is both a declaration and a binding -- `x: int = 1` for example -- then + /// we don't actually need anything here, all we'll need to validate is that our own RHS is a + /// valid assignment to our own annotation. + declarations_by_binding: FxHashMap<Definition<'db>, SymbolDeclarations>, + + /// If the definition is a declaration (only) -- `x: int` for example -- then we need + /// [`SymbolBindings`] to know whether this declaration is consistent with the previously + /// inferred type. + /// + /// If the definition is both a declaration and a binding -- `x: int = 1` for example -- then + /// we don't actually need anything here, all we'll need to validate is that our own RHS is a + /// valid assignment to our own annotation. + bindings_by_declaration: FxHashMap<Definition<'db>, SymbolBindings>, + + /// [`SymbolState`] visible at end of scope for each symbol. + public_symbols: IndexVec<ScopedSymbolId, SymbolState>, + + /// [`SymbolState`] for each instance attribute. + instance_attributes: IndexVec<ScopedSymbolId, SymbolState>, + + /// Snapshot of bindings in this scope that can be used to resolve a reference in a nested + /// eager scope. + eager_snapshots: EagerSnapshots, + + /// Whether or not the start of the scope is visible. + /// This is used to check if the function can implicitly return `None`. + /// For example: + /// + /// ```python + /// def f(cond: bool) -> int: + /// if cond: + /// return 1 + /// ``` + /// + /// In this case, the function may implicitly return `None`. + /// + /// This is used by `UseDefMap::can_implicit_return`. + scope_start_visibility: ScopedVisibilityConstraintId, +} + +impl<'db> UseDefMap<'db> { + pub(crate) fn bindings_at_use( + &self, + use_id: ScopedUseId, + ) -> BindingWithConstraintsIterator<'_, 'db> { + self.bindings_iterator(&self.bindings_by_use[use_id]) + } + + pub(crate) fn narrowing_constraints_at_use( + &self, + constraint_key: ConstraintKey, + ) -> ConstraintsIterator<'_, 'db> { + let constraint = match constraint_key { + ConstraintKey::NarrowingConstraint(constraint) => constraint, + ConstraintKey::UseId(use_id) => { + self.bindings_by_use[use_id].unbound_narrowing_constraint() + } + }; + ConstraintsIterator { + predicates: &self.predicates, + constraint_ids: self.narrowing_constraints.iter_predicates(constraint), + } + } + + pub(super) fn is_reachable( + &self, + db: &dyn crate::Db, + reachability: ScopedVisibilityConstraintId, + ) -> bool { + !self + .visibility_constraints + .evaluate(db, &self.predicates, reachability) + .is_always_false() + } + + /// Check whether or not a given expression is reachable from the start of the scope. This + /// is a local analysis which does not capture the possibility that the entire scope might + /// be unreachable. Use [`super::SemanticIndex::is_node_reachable`] for the global + /// analysis. + #[track_caller] + pub(super) fn is_node_reachable(&self, db: &dyn crate::Db, node_key: NodeKey) -> bool { + !self + .visibility_constraints + .evaluate( + db, + &self.predicates, + *self + .node_reachability + .get(&node_key) + .expect("`is_node_reachable` should only be called on AST nodes with recorded reachability"), + ) + .is_always_false() + } + + pub(crate) fn public_bindings( + &self, + symbol: ScopedSymbolId, + ) -> BindingWithConstraintsIterator<'_, 'db> { + self.bindings_iterator(self.public_symbols[symbol].bindings()) + } + + pub(crate) fn instance_attribute_bindings( + &self, + symbol: ScopedSymbolId, + ) -> BindingWithConstraintsIterator<'_, 'db> { + self.bindings_iterator(self.instance_attributes[symbol].bindings()) + } + + pub(crate) fn eager_snapshot( + &self, + eager_bindings: ScopedEagerSnapshotId, + ) -> EagerSnapshotResult<'_, 'db> { + match self.eager_snapshots.get(eager_bindings) { + Some(EagerSnapshot::Constraint(constraint)) => { + EagerSnapshotResult::FoundConstraint(*constraint) + } + Some(EagerSnapshot::Bindings(symbol_bindings)) => { + EagerSnapshotResult::FoundBindings(self.bindings_iterator(symbol_bindings)) + } + None => EagerSnapshotResult::NotFound, + } + } + + pub(crate) fn bindings_at_declaration( + &self, + declaration: Definition<'db>, + ) -> BindingWithConstraintsIterator<'_, 'db> { + self.bindings_iterator(&self.bindings_by_declaration[&declaration]) + } + + pub(crate) fn declarations_at_binding( + &self, + binding: Definition<'db>, + ) -> DeclarationsIterator<'_, 'db> { + self.declarations_iterator(&self.declarations_by_binding[&binding]) + } + + pub(crate) fn public_declarations<'map>( + &'map self, + symbol: ScopedSymbolId, + ) -> DeclarationsIterator<'map, 'db> { + let declarations = self.public_symbols[symbol].declarations(); + self.declarations_iterator(declarations) + } + + pub(crate) fn all_public_declarations<'map>( + &'map self, + ) -> impl Iterator<Item = (ScopedSymbolId, DeclarationsIterator<'map, 'db>)> + 'map { + (0..self.public_symbols.len()) + .map(ScopedSymbolId::from_usize) + .map(|symbol_id| (symbol_id, self.public_declarations(symbol_id))) + } + + pub(crate) fn all_public_bindings<'map>( + &'map self, + ) -> impl Iterator<Item = (ScopedSymbolId, BindingWithConstraintsIterator<'map, 'db>)> + 'map + { + (0..self.public_symbols.len()) + .map(ScopedSymbolId::from_usize) + .map(|symbol_id| (symbol_id, self.public_bindings(symbol_id))) + } + + /// This function is intended to be called only once inside `TypeInferenceBuilder::infer_function_body`. + pub(crate) fn can_implicit_return(&self, db: &dyn crate::Db) -> bool { + !self + .visibility_constraints + .evaluate(db, &self.predicates, self.scope_start_visibility) + .is_always_false() + } + + pub(crate) fn is_binding_visible( + &self, + db: &dyn crate::Db, + binding: &BindingWithConstraints<'_, 'db>, + ) -> Truthiness { + self.visibility_constraints + .evaluate(db, &self.predicates, binding.visibility_constraint) + } + + fn bindings_iterator<'map>( + &'map self, + bindings: &'map SymbolBindings, + ) -> BindingWithConstraintsIterator<'map, 'db> { + BindingWithConstraintsIterator { + all_definitions: &self.all_definitions, + predicates: &self.predicates, + narrowing_constraints: &self.narrowing_constraints, + visibility_constraints: &self.visibility_constraints, + inner: bindings.iter(), + } + } + + fn declarations_iterator<'map>( + &'map self, + declarations: &'map SymbolDeclarations, + ) -> DeclarationsIterator<'map, 'db> { + DeclarationsIterator { + all_definitions: &self.all_definitions, + predicates: &self.predicates, + visibility_constraints: &self.visibility_constraints, + inner: declarations.iter(), + } + } +} + +/// Uniquely identifies a snapshot of a symbol state that can be used to resolve a reference in a +/// nested eager scope. +/// +/// An eager scope has its entire body executed immediately at the location where it is defined. +/// For any free references in the nested scope, we use the bindings that are visible at the point +/// where the nested scope is defined, instead of using the public type of the symbol. +/// +/// There is a unique ID for each distinct [`EagerSnapshotKey`] in the file. +#[newtype_index] +pub(crate) struct ScopedEagerSnapshotId; + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] +pub(crate) struct EagerSnapshotKey { + /// The enclosing scope containing the bindings + pub(crate) enclosing_scope: FileScopeId, + /// The referenced symbol (in the enclosing scope) + pub(crate) enclosing_symbol: ScopedSymbolId, + /// The nested eager scope containing the reference + pub(crate) nested_scope: FileScopeId, +} + +/// A snapshot of symbol states that can be used to resolve a reference in a nested eager scope. +type EagerSnapshots = IndexVec<ScopedEagerSnapshotId, EagerSnapshot>; + +#[derive(Debug)] +pub(crate) struct BindingWithConstraintsIterator<'map, 'db> { + all_definitions: &'map IndexVec<ScopedDefinitionId, Option<Definition<'db>>>, + pub(crate) predicates: &'map Predicates<'db>, + pub(crate) narrowing_constraints: &'map NarrowingConstraints, + pub(crate) visibility_constraints: &'map VisibilityConstraints, + inner: LiveBindingsIterator<'map>, +} + +impl<'map, 'db> Iterator for BindingWithConstraintsIterator<'map, 'db> { + type Item = BindingWithConstraints<'map, 'db>; + + fn next(&mut self) -> Option<Self::Item> { + let predicates = self.predicates; + let narrowing_constraints = self.narrowing_constraints; + + self.inner + .next() + .map(|live_binding| BindingWithConstraints { + binding: self.all_definitions[live_binding.binding], + narrowing_constraint: ConstraintsIterator { + predicates, + constraint_ids: narrowing_constraints + .iter_predicates(live_binding.narrowing_constraint), + }, + visibility_constraint: live_binding.visibility_constraint, + }) + } +} + +impl std::iter::FusedIterator for BindingWithConstraintsIterator<'_, '_> {} + +pub(crate) struct BindingWithConstraints<'map, 'db> { + pub(crate) binding: Option<Definition<'db>>, + pub(crate) narrowing_constraint: ConstraintsIterator<'map, 'db>, + pub(crate) visibility_constraint: ScopedVisibilityConstraintId, +} + +pub(crate) struct ConstraintsIterator<'map, 'db> { + predicates: &'map Predicates<'db>, + constraint_ids: NarrowingConstraintsIterator<'map>, +} + +impl<'db> Iterator for ConstraintsIterator<'_, 'db> { + type Item = Predicate<'db>; + + fn next(&mut self) -> Option<Self::Item> { + self.constraint_ids + .next() + .map(|narrowing_constraint| self.predicates[narrowing_constraint.predicate()]) + } +} + +impl std::iter::FusedIterator for ConstraintsIterator<'_, '_> {} + +impl<'db> ConstraintsIterator<'_, 'db> { + pub(crate) fn narrow( + self, + db: &'db dyn crate::Db, + base_ty: Type<'db>, + symbol: ScopedSymbolId, + ) -> Type<'db> { + let constraint_tys: Vec<_> = self + .filter_map(|constraint| infer_narrowing_constraint(db, constraint, symbol)) + .collect(); + + if constraint_tys.is_empty() { + base_ty + } else { + constraint_tys + .into_iter() + .rev() + .fold( + IntersectionBuilder::new(db).add_positive(base_ty), + IntersectionBuilder::add_positive, + ) + .build() + } + } +} + +#[derive(Clone)] +pub(crate) struct DeclarationsIterator<'map, 'db> { + all_definitions: &'map IndexVec<ScopedDefinitionId, Option<Definition<'db>>>, + pub(crate) predicates: &'map Predicates<'db>, + pub(crate) visibility_constraints: &'map VisibilityConstraints, + inner: LiveDeclarationsIterator<'map>, +} + +pub(crate) struct DeclarationWithConstraint<'db> { + pub(crate) declaration: Option<Definition<'db>>, + pub(crate) visibility_constraint: ScopedVisibilityConstraintId, +} + +impl<'db> Iterator for DeclarationsIterator<'_, 'db> { + type Item = DeclarationWithConstraint<'db>; + + fn next(&mut self) -> Option<Self::Item> { + self.inner.next().map( + |LiveDeclaration { + declaration, + visibility_constraint, + }| { + DeclarationWithConstraint { + declaration: self.all_definitions[*declaration], + visibility_constraint: *visibility_constraint, + } + }, + ) + } +} + +impl std::iter::FusedIterator for DeclarationsIterator<'_, '_> {} + +/// A snapshot of the definitions and constraints state at a particular point in control flow. +#[derive(Clone, Debug)] +pub(super) struct FlowSnapshot { + symbol_states: IndexVec<ScopedSymbolId, SymbolState>, + instance_attribute_states: IndexVec<ScopedSymbolId, SymbolState>, + scope_start_visibility: ScopedVisibilityConstraintId, + reachability: ScopedVisibilityConstraintId, +} + +#[derive(Debug)] +pub(super) struct UseDefMapBuilder<'db> { + /// Append-only array of [`Definition`]. + all_definitions: IndexVec<ScopedDefinitionId, Option<Definition<'db>>>, + + /// Builder of predicates. + pub(super) predicates: PredicatesBuilder<'db>, + + /// Builder of narrowing constraints. + pub(super) narrowing_constraints: NarrowingConstraintsBuilder, + + /// Builder of visibility constraints. + pub(super) visibility_constraints: VisibilityConstraintsBuilder, + + /// A constraint which describes the visibility of the unbound/undeclared state, i.e. + /// whether or not a use of a symbol at the current point in control flow would see + /// the fake `x = <unbound>` binding at the start of the scope. This is important for + /// cases like the following, where we need to hide the implicit unbound binding in + /// the "else" branch: + /// ```py + /// # x = <unbound> + /// + /// if True: + /// x = 1 + /// + /// use(x) # the `x = <unbound>` binding is not visible here + /// ``` + pub(super) scope_start_visibility: ScopedVisibilityConstraintId, + + /// Live bindings at each so-far-recorded use. + bindings_by_use: IndexVec<ScopedUseId, SymbolBindings>, + + /// Tracks whether or not the scope start is visible at the current point in control flow. + /// This is subtly different from `scope_start_visibility`, as we apply these constraints + /// at the beginning of a branch. Visibility constraints, on the other hand, need to be + /// applied at the end of a branch, as we apply them retroactively to all live bindings: + /// ```py + /// y = 1 + /// + /// if test: + /// # we record a reachability constraint of [test] here, + /// # so that it can affect the use of `x`: + /// + /// x # we store a reachability constraint of [test] for this use of `x` + /// + /// y = 2 + /// + /// # we record a visibility constraint of [test] here, which retroactively affects + /// # the `y = 1` and the `y = 2` binding. + /// else: + /// # we record a reachability constraint of [~test] here. + /// + /// pass + /// + /// # we record a visibility constraint of [~test] here, which retroactively affects + /// # the `y = 1` binding. + /// + /// use(y) + /// ``` + /// Depending on the value of `test`, the `y = 1`, `y = 2`, or both bindings may be visible. + /// The use of `x` is recorded with a reachability constraint of `[test]`. + pub(super) reachability: ScopedVisibilityConstraintId, + + /// Tracks whether or not a given AST node is reachable from the start of the scope. + node_reachability: FxHashMap<NodeKey, ScopedVisibilityConstraintId>, + + /// Live declarations for each so-far-recorded binding. + declarations_by_binding: FxHashMap<Definition<'db>, SymbolDeclarations>, + + /// Live bindings for each so-far-recorded declaration. + bindings_by_declaration: FxHashMap<Definition<'db>, SymbolBindings>, + + /// Currently live bindings and declarations for each symbol. + symbol_states: IndexVec<ScopedSymbolId, SymbolState>, + + /// Currently live bindings for each instance attribute. + instance_attribute_states: IndexVec<ScopedSymbolId, SymbolState>, + + /// Snapshots of symbol states in this scope that can be used to resolve a reference in a + /// nested eager scope. + eager_snapshots: EagerSnapshots, + + /// Is this a class scope? + is_class_scope: bool, +} + +impl<'db> UseDefMapBuilder<'db> { + pub(super) fn new(is_class_scope: bool) -> Self { + Self { + all_definitions: IndexVec::from_iter([None]), + predicates: PredicatesBuilder::default(), + narrowing_constraints: NarrowingConstraintsBuilder::default(), + visibility_constraints: VisibilityConstraintsBuilder::default(), + scope_start_visibility: ScopedVisibilityConstraintId::ALWAYS_TRUE, + bindings_by_use: IndexVec::new(), + reachability: ScopedVisibilityConstraintId::ALWAYS_TRUE, + node_reachability: FxHashMap::default(), + declarations_by_binding: FxHashMap::default(), + bindings_by_declaration: FxHashMap::default(), + symbol_states: IndexVec::new(), + eager_snapshots: EagerSnapshots::default(), + instance_attribute_states: IndexVec::new(), + is_class_scope, + } + } + pub(super) fn mark_unreachable(&mut self) { + self.record_visibility_constraint(ScopedVisibilityConstraintId::ALWAYS_FALSE); + self.reachability = ScopedVisibilityConstraintId::ALWAYS_FALSE; + } + + pub(super) fn add_symbol(&mut self, symbol: ScopedSymbolId) { + let new_symbol = self + .symbol_states + .push(SymbolState::undefined(self.scope_start_visibility)); + debug_assert_eq!(symbol, new_symbol); + } + + pub(super) fn add_attribute(&mut self, symbol: ScopedSymbolId) { + let new_symbol = self + .instance_attribute_states + .push(SymbolState::undefined(self.scope_start_visibility)); + debug_assert_eq!(symbol, new_symbol); + } + + pub(super) fn record_binding(&mut self, symbol: ScopedSymbolId, binding: Definition<'db>) { + let def_id = self.all_definitions.push(Some(binding)); + let symbol_state = &mut self.symbol_states[symbol]; + self.declarations_by_binding + .insert(binding, symbol_state.declarations().clone()); + symbol_state.record_binding(def_id, self.scope_start_visibility, self.is_class_scope); + } + + pub(super) fn record_attribute_binding( + &mut self, + symbol: ScopedSymbolId, + binding: Definition<'db>, + ) { + let def_id = self.all_definitions.push(Some(binding)); + let attribute_state = &mut self.instance_attribute_states[symbol]; + self.declarations_by_binding + .insert(binding, attribute_state.declarations().clone()); + attribute_state.record_binding(def_id, self.scope_start_visibility, self.is_class_scope); + } + + pub(super) fn add_predicate(&mut self, predicate: Predicate<'db>) -> ScopedPredicateId { + self.predicates.add_predicate(predicate) + } + + pub(super) fn record_narrowing_constraint(&mut self, predicate: ScopedPredicateId) { + let narrowing_constraint = predicate.into(); + for state in &mut self.symbol_states { + state + .record_narrowing_constraint(&mut self.narrowing_constraints, narrowing_constraint); + } + for state in &mut self.instance_attribute_states { + state + .record_narrowing_constraint(&mut self.narrowing_constraints, narrowing_constraint); + } + } + + pub(super) fn record_visibility_constraint( + &mut self, + constraint: ScopedVisibilityConstraintId, + ) { + for state in &mut self.symbol_states { + state.record_visibility_constraint(&mut self.visibility_constraints, constraint); + } + for state in &mut self.instance_attribute_states { + state.record_visibility_constraint(&mut self.visibility_constraints, constraint); + } + self.scope_start_visibility = self + .visibility_constraints + .add_and_constraint(self.scope_start_visibility, constraint); + } + + /// Snapshot the state of a single symbol at the current point in control flow. + /// + /// This is only used for `*`-import visibility constraints, which are handled differently + /// to most other visibility constraints. See the doc-comment for + /// [`Self::record_and_negate_star_import_visibility_constraint`] for more details. + pub(super) fn single_symbol_snapshot(&self, symbol: ScopedSymbolId) -> SymbolState { + self.symbol_states[symbol].clone() + } + + /// This method exists solely for handling `*`-import visibility constraints. + /// + /// The reason why we add visibility constraints for [`Definition`]s created by `*` imports + /// is laid out in the doc-comment for [`StarImportPlaceholderPredicate`]. But treating these + /// visibility constraints in the use-def map the same way as all other visibility constraints + /// was shown to lead to [significant regressions] for small codebases where typeshed + /// dominates. (Although `*` imports are not common generally, they are used in several + /// important places by typeshed.) + /// + /// To solve these regressions, it was observed that we could do significantly less work for + /// `*`-import definitions. We do a number of things differently here to our normal handling of + /// visibility constraints: + /// + /// - We only apply and negate the visibility constraints to a single symbol, rather than to + /// all symbols. This is possible here because, unlike most definitions, we know in advance that + /// exactly one definition occurs inside the "if-true" predicate branch, and we know exactly + /// which definition it is. + /// + /// Doing things this way is cheaper in and of itself. However, it also allows us to avoid + /// calling [`Self::simplify_visibility_constraints`] after the constraint has been applied to + /// the "if-predicate-true" branch and negated for the "if-predicate-false" branch. Simplifying + /// the visibility constraints is only important for symbols that did not have any new + /// definitions inside either the "if-predicate-true" branch or the "if-predicate-false" branch. + /// + /// - We only snapshot the state for a single symbol prior to the definition, rather than doing + /// expensive calls to [`Self::snapshot`]. Again, this is possible because we know + /// that only a single definition occurs inside the "if-predicate-true" predicate branch. + /// + /// - Normally we take care to check whether an "if-predicate-true" branch or an + /// "if-predicate-false" branch contains a terminal statement: these can affect the visibility + /// of symbols defined inside either branch. However, in the case of `*`-import definitions, + /// this is unnecessary (and therefore not done in this method), since we know that a `*`-import + /// predicate cannot create a terminal statement inside either branch. + /// + /// [significant regressions]: https://github.com/astral-sh/ruff/pull/17286#issuecomment-2786755746 + pub(super) fn record_and_negate_star_import_visibility_constraint( + &mut self, + star_import: StarImportPlaceholderPredicate<'db>, + symbol: ScopedSymbolId, + pre_definition_state: SymbolState, + ) { + let predicate_id = self.add_predicate(star_import.into()); + let visibility_id = self.visibility_constraints.add_atom(predicate_id); + let negated_visibility_id = self + .visibility_constraints + .add_not_constraint(visibility_id); + + let mut post_definition_state = + std::mem::replace(&mut self.symbol_states[symbol], pre_definition_state); + + post_definition_state + .record_visibility_constraint(&mut self.visibility_constraints, visibility_id); + + self.symbol_states[symbol] + .record_visibility_constraint(&mut self.visibility_constraints, negated_visibility_id); + + self.symbol_states[symbol].merge( + post_definition_state, + &mut self.narrowing_constraints, + &mut self.visibility_constraints, + ); + } + + /// This method resets the visibility constraints for all symbols to a previous state + /// *if* there have been no new declarations or bindings since then. Consider the + /// following example: + /// ```py + /// x = 0 + /// y = 0 + /// if test_a: + /// y = 1 + /// elif test_b: + /// y = 2 + /// elif test_c: + /// y = 3 + /// + /// # RESET + /// ``` + /// We build a complex visibility constraint for the `y = 0` binding. We build the same + /// constraint for the `x = 0` binding as well, but at the `RESET` point, we can get rid + /// of it, as the `if`-`elif`-`elif` chain doesn't include any new bindings of `x`. + pub(super) fn simplify_visibility_constraints(&mut self, snapshot: FlowSnapshot) { + debug_assert!(self.symbol_states.len() >= snapshot.symbol_states.len()); + debug_assert!( + self.instance_attribute_states.len() >= snapshot.instance_attribute_states.len() + ); + + // If there are any control flow paths that have become unreachable between `snapshot` and + // now, then it's not valid to simplify any visibility constraints to `snapshot`. + if self.scope_start_visibility != snapshot.scope_start_visibility { + return; + } + + // Note that this loop terminates when we reach a symbol not present in the snapshot. + // This means we keep visibility constraints for all new symbols, which is intended, + // since these symbols have been introduced in the corresponding branch, which might + // be subject to visibility constraints. We only simplify/reset visibility constraints + // for symbols that have the same bindings and declarations present compared to the + // snapshot. + for (current, snapshot) in self.symbol_states.iter_mut().zip(snapshot.symbol_states) { + current.simplify_visibility_constraints(snapshot); + } + for (current, snapshot) in self + .instance_attribute_states + .iter_mut() + .zip(snapshot.instance_attribute_states) + { + current.simplify_visibility_constraints(snapshot); + } + } + + pub(super) fn record_reachability_constraint( + &mut self, + constraint: ScopedVisibilityConstraintId, + ) -> ScopedVisibilityConstraintId { + self.reachability = self + .visibility_constraints + .add_and_constraint(self.reachability, constraint); + self.reachability + } + + pub(super) fn record_declaration( + &mut self, + symbol: ScopedSymbolId, + declaration: Definition<'db>, + ) { + let def_id = self.all_definitions.push(Some(declaration)); + let symbol_state = &mut self.symbol_states[symbol]; + self.bindings_by_declaration + .insert(declaration, symbol_state.bindings().clone()); + symbol_state.record_declaration(def_id); + } + + pub(super) fn record_declaration_and_binding( + &mut self, + symbol: ScopedSymbolId, + definition: Definition<'db>, + ) { + // We don't need to store anything in self.bindings_by_declaration or + // self.declarations_by_binding. + let def_id = self.all_definitions.push(Some(definition)); + let symbol_state = &mut self.symbol_states[symbol]; + symbol_state.record_declaration(def_id); + symbol_state.record_binding(def_id, self.scope_start_visibility, self.is_class_scope); + } + + pub(super) fn record_use( + &mut self, + symbol: ScopedSymbolId, + use_id: ScopedUseId, + node_key: NodeKey, + ) { + // We have a use of a symbol; clone the current bindings for that symbol, and record them + // as the live bindings for this use. + let new_use = self + .bindings_by_use + .push(self.symbol_states[symbol].bindings().clone()); + debug_assert_eq!(use_id, new_use); + + // Track reachability of all uses of symbols to silence `unresolved-reference` + // diagnostics in unreachable code. + self.record_node_reachability(node_key); + } + + pub(super) fn record_node_reachability(&mut self, node_key: NodeKey) { + self.node_reachability.insert(node_key, self.reachability); + } + + pub(super) fn snapshot_eager_state( + &mut self, + enclosing_symbol: ScopedSymbolId, + scope: ScopeKind, + is_bound: bool, + ) -> ScopedEagerSnapshotId { + // Names bound in class scopes are never visible to nested scopes, so we never need to + // save eager scope bindings in a class scope. + if scope.is_class() || !is_bound { + self.eager_snapshots.push(EagerSnapshot::Constraint( + self.symbol_states[enclosing_symbol] + .bindings() + .unbound_narrowing_constraint(), + )) + } else { + self.eager_snapshots.push(EagerSnapshot::Bindings( + self.symbol_states[enclosing_symbol].bindings().clone(), + )) + } + } + + /// Take a snapshot of the current visible-symbols state. + pub(super) fn snapshot(&self) -> FlowSnapshot { + FlowSnapshot { + symbol_states: self.symbol_states.clone(), + instance_attribute_states: self.instance_attribute_states.clone(), + scope_start_visibility: self.scope_start_visibility, + reachability: self.reachability, + } + } + + /// Restore the current builder symbols state to the given snapshot. + pub(super) fn restore(&mut self, snapshot: FlowSnapshot) { + // We never remove symbols from `symbol_states` (it's an IndexVec, and the symbol + // IDs must line up), so the current number of known symbols must always be equal to or + // greater than the number of known symbols in a previously-taken snapshot. + let num_symbols = self.symbol_states.len(); + debug_assert!(num_symbols >= snapshot.symbol_states.len()); + let num_attributes = self.instance_attribute_states.len(); + debug_assert!(num_attributes >= snapshot.instance_attribute_states.len()); + + // Restore the current visible-definitions state to the given snapshot. + self.symbol_states = snapshot.symbol_states; + self.instance_attribute_states = snapshot.instance_attribute_states; + self.scope_start_visibility = snapshot.scope_start_visibility; + self.reachability = snapshot.reachability; + + // If the snapshot we are restoring is missing some symbols we've recorded since, we need + // to fill them in so the symbol IDs continue to line up. Since they don't exist in the + // snapshot, the correct state to fill them in with is "undefined". + self.symbol_states.resize( + num_symbols, + SymbolState::undefined(self.scope_start_visibility), + ); + self.instance_attribute_states.resize( + num_attributes, + SymbolState::undefined(self.scope_start_visibility), + ); + } + + /// Merge the given snapshot into the current state, reflecting that we might have taken either + /// path to get here. The new state for each symbol should include definitions from both the + /// prior state and the snapshot. + pub(super) fn merge(&mut self, snapshot: FlowSnapshot) { + // As an optimization, if we know statically that either of the snapshots is always + // unreachable, we can leave it out of the merged result entirely. Note that we cannot + // perform any type inference at this point, so this is largely limited to unreachability + // via terminal statements. If a flow's reachability depends on an expression in the code, + // we will include the flow in the merged result; the visibility constraints of its + // bindings will include this reachability condition, so that later during type inference, + // we can determine whether any particular binding is non-visible due to unreachability. + if snapshot.scope_start_visibility == ScopedVisibilityConstraintId::ALWAYS_FALSE { + return; + } + if self.scope_start_visibility == ScopedVisibilityConstraintId::ALWAYS_FALSE { + self.restore(snapshot); + return; + } + + // We never remove symbols from `symbol_states` (it's an IndexVec, and the symbol + // IDs must line up), so the current number of known symbols must always be equal to or + // greater than the number of known symbols in a previously-taken snapshot. + debug_assert!(self.symbol_states.len() >= snapshot.symbol_states.len()); + debug_assert!( + self.instance_attribute_states.len() >= snapshot.instance_attribute_states.len() + ); + + let mut snapshot_definitions_iter = snapshot.symbol_states.into_iter(); + for current in &mut self.symbol_states { + if let Some(snapshot) = snapshot_definitions_iter.next() { + current.merge( + snapshot, + &mut self.narrowing_constraints, + &mut self.visibility_constraints, + ); + } else { + current.merge( + SymbolState::undefined(snapshot.scope_start_visibility), + &mut self.narrowing_constraints, + &mut self.visibility_constraints, + ); + // Symbol not present in snapshot, so it's unbound/undeclared from that path. + } + } + let mut snapshot_definitions_iter = snapshot.instance_attribute_states.into_iter(); + for current in &mut self.instance_attribute_states { + if let Some(snapshot) = snapshot_definitions_iter.next() { + current.merge( + snapshot, + &mut self.narrowing_constraints, + &mut self.visibility_constraints, + ); + } else { + current.merge( + SymbolState::undefined(snapshot.scope_start_visibility), + &mut self.narrowing_constraints, + &mut self.visibility_constraints, + ); + } + } + + self.scope_start_visibility = self + .visibility_constraints + .add_or_constraint(self.scope_start_visibility, snapshot.scope_start_visibility); + + self.reachability = self + .visibility_constraints + .add_or_constraint(self.reachability, snapshot.reachability); + } + + pub(super) fn finish(mut self) -> UseDefMap<'db> { + self.all_definitions.shrink_to_fit(); + self.symbol_states.shrink_to_fit(); + self.instance_attribute_states.shrink_to_fit(); + self.bindings_by_use.shrink_to_fit(); + self.node_reachability.shrink_to_fit(); + self.declarations_by_binding.shrink_to_fit(); + self.bindings_by_declaration.shrink_to_fit(); + self.eager_snapshots.shrink_to_fit(); + + UseDefMap { + all_definitions: self.all_definitions, + predicates: self.predicates.build(), + narrowing_constraints: self.narrowing_constraints.build(), + visibility_constraints: self.visibility_constraints.build(), + bindings_by_use: self.bindings_by_use, + node_reachability: self.node_reachability, + public_symbols: self.symbol_states, + instance_attributes: self.instance_attribute_states, + declarations_by_binding: self.declarations_by_binding, + bindings_by_declaration: self.bindings_by_declaration, + eager_snapshots: self.eager_snapshots, + scope_start_visibility: self.scope_start_visibility, + } + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/use_def/symbol_state.rs b/crates/ty_python_semantic/src/semantic_index/use_def/symbol_state.rs new file mode 100644 index 0000000000000..0a7df85a83f73 --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/use_def/symbol_state.rs @@ -0,0 +1,687 @@ +//! Track live bindings per symbol, applicable constraints per binding, and live declarations. +//! +//! These data structures operate entirely on scope-local newtype-indices for definitions and +//! constraints, referring to their location in the `all_definitions` and `all_constraints` +//! indexvecs in [`super::UseDefMapBuilder`]. +//! +//! We need to track arbitrary associations between bindings and constraints, not just a single set +//! of currently dominating constraints (where "dominating" means "control flow must have passed +//! through it to reach this point"), because we can have dominating constraints that apply to some +//! bindings but not others, as in this code: +//! +//! ```python +//! x = 1 if flag else None +//! if x is not None: +//! if flag2: +//! x = 2 if flag else None +//! x +//! ``` +//! +//! The `x is not None` constraint dominates the final use of `x`, but it applies only to the first +//! binding of `x`, not the second, so `None` is a possible value for `x`. +//! +//! And we can't just track, for each binding, an index into a list of dominating constraints, +//! either, because we can have bindings which are still visible, but subject to constraints that +//! are no longer dominating, as in this code: +//! +//! ```python +//! x = 0 +//! if flag1: +//! x = 1 if flag2 else None +//! assert x is not None +//! x +//! ``` +//! +//! From the point of view of the final use of `x`, the `x is not None` constraint no longer +//! dominates, but it does dominate the `x = 1 if flag2 else None` binding, so we have to keep +//! track of that. +//! +//! The data structures use `IndexVec` arenas to store all data compactly and contiguously, while +//! supporting very cheap clones. +//! +//! Tracking live declarations is simpler, since constraints are not involved, but otherwise very +//! similar to tracking live bindings. + +use itertools::{EitherOrBoth, Itertools}; +use ruff_index::newtype_index; +use smallvec::{SmallVec, smallvec}; + +use crate::semantic_index::narrowing_constraints::{ + NarrowingConstraintsBuilder, ScopedNarrowingConstraint, ScopedNarrowingConstraintPredicate, +}; +use crate::semantic_index::visibility_constraints::{ + ScopedVisibilityConstraintId, VisibilityConstraintsBuilder, +}; + +/// A newtype-index for a definition in a particular scope. +#[newtype_index] +#[derive(Ord, PartialOrd)] +pub(super) struct ScopedDefinitionId; + +impl ScopedDefinitionId { + /// A special ID that is used to describe an implicit start-of-scope state. When + /// we see that this definition is live, we know that the symbol is (possibly) + /// unbound or undeclared at a given usage site. + /// When creating a use-def-map builder, we always add an empty `None` definition + /// at index 0, so this ID is always present. + pub(super) const UNBOUND: ScopedDefinitionId = ScopedDefinitionId::from_u32(0); + + fn is_unbound(self) -> bool { + self == Self::UNBOUND + } +} + +/// Can keep inline this many live bindings or declarations per symbol at a given time; more will +/// go to heap. +const INLINE_DEFINITIONS_PER_SYMBOL: usize = 4; + +/// Live declarations for a single symbol at some point in control flow, with their +/// corresponding visibility constraints. +#[derive(Clone, Debug, Default, PartialEq, Eq, salsa::Update)] +pub(super) struct SymbolDeclarations { + /// A list of live declarations for this symbol, sorted by their `ScopedDefinitionId` + live_declarations: SmallVec<[LiveDeclaration; INLINE_DEFINITIONS_PER_SYMBOL]>, +} + +/// One of the live declarations for a single symbol at some point in control flow. +#[derive(Clone, Debug, PartialEq, Eq)] +pub(super) struct LiveDeclaration { + pub(super) declaration: ScopedDefinitionId, + pub(super) visibility_constraint: ScopedVisibilityConstraintId, +} + +pub(super) type LiveDeclarationsIterator<'a> = std::slice::Iter<'a, LiveDeclaration>; + +impl SymbolDeclarations { + fn undeclared(scope_start_visibility: ScopedVisibilityConstraintId) -> Self { + let initial_declaration = LiveDeclaration { + declaration: ScopedDefinitionId::UNBOUND, + visibility_constraint: scope_start_visibility, + }; + Self { + live_declarations: smallvec![initial_declaration], + } + } + + /// Record a newly-encountered declaration for this symbol. + fn record_declaration(&mut self, declaration: ScopedDefinitionId) { + // The new declaration replaces all previous live declaration in this path. + self.live_declarations.clear(); + self.live_declarations.push(LiveDeclaration { + declaration, + visibility_constraint: ScopedVisibilityConstraintId::ALWAYS_TRUE, + }); + } + + /// Add given visibility constraint to all live declarations. + pub(super) fn record_visibility_constraint( + &mut self, + visibility_constraints: &mut VisibilityConstraintsBuilder, + constraint: ScopedVisibilityConstraintId, + ) { + for declaration in &mut self.live_declarations { + declaration.visibility_constraint = visibility_constraints + .add_and_constraint(declaration.visibility_constraint, constraint); + } + } + + /// Return an iterator over live declarations for this symbol. + pub(super) fn iter(&self) -> LiveDeclarationsIterator<'_> { + self.live_declarations.iter() + } + + /// Iterate over the IDs of each currently live declaration for this symbol + fn iter_declarations(&self) -> impl Iterator<Item = ScopedDefinitionId> + '_ { + self.iter().map(|lb| lb.declaration) + } + + fn simplify_visibility_constraints(&mut self, other: SymbolDeclarations) { + // If the set of live declarations hasn't changed, don't simplify. + if self.live_declarations.len() != other.live_declarations.len() + || !self.iter_declarations().eq(other.iter_declarations()) + { + return; + } + + for (declaration, other_declaration) in self + .live_declarations + .iter_mut() + .zip(other.live_declarations) + { + declaration.visibility_constraint = other_declaration.visibility_constraint; + } + } + + fn merge(&mut self, b: Self, visibility_constraints: &mut VisibilityConstraintsBuilder) { + let a = std::mem::take(self); + + // Invariant: merge_join_by consumes the two iterators in sorted order, which ensures that + // the merged `live_declarations` vec remains sorted. If a definition is found in both `a` + // and `b`, we compose the constraints from the two paths in an appropriate way + // (intersection for narrowing constraints; ternary OR for visibility constraints). If a + // definition is found in only one path, it is used as-is. + let a = a.live_declarations.into_iter(); + let b = b.live_declarations.into_iter(); + for zipped in a.merge_join_by(b, |a, b| a.declaration.cmp(&b.declaration)) { + match zipped { + EitherOrBoth::Both(a, b) => { + let visibility_constraint = visibility_constraints + .add_or_constraint(a.visibility_constraint, b.visibility_constraint); + self.live_declarations.push(LiveDeclaration { + declaration: a.declaration, + visibility_constraint, + }); + } + + EitherOrBoth::Left(declaration) | EitherOrBoth::Right(declaration) => { + self.live_declarations.push(declaration); + } + } + } + } +} + +/// A snapshot of a symbol state that can be used to resolve a reference in a nested eager scope. +/// If there are bindings in a (non-class) scope , they are stored in `Bindings`. +/// Even if it's a class scope (class variables are not visible to nested scopes) or there are no +/// bindings, the current narrowing constraint is necessary for narrowing, so it's stored in +/// `Constraint`. +#[derive(Clone, Debug, PartialEq, Eq, salsa::Update)] +pub(super) enum EagerSnapshot { + Constraint(ScopedNarrowingConstraint), + Bindings(SymbolBindings), +} + +/// Live bindings for a single symbol at some point in control flow. Each live binding comes +/// with a set of narrowing constraints and a visibility constraint. +#[derive(Clone, Debug, Default, PartialEq, Eq, salsa::Update)] +pub(super) struct SymbolBindings { + /// The narrowing constraint applicable to the "unbound" binding, if we need access to it even + /// when it's not visible. This happens in class scopes, where local bindings are not visible + /// to nested scopes, but we still need to know what narrowing constraints were applied to the + /// "unbound" binding. + unbound_narrowing_constraint: Option<ScopedNarrowingConstraint>, + /// A list of live bindings for this symbol, sorted by their `ScopedDefinitionId` + live_bindings: SmallVec<[LiveBinding; INLINE_DEFINITIONS_PER_SYMBOL]>, +} + +impl SymbolBindings { + pub(super) fn unbound_narrowing_constraint(&self) -> ScopedNarrowingConstraint { + debug_assert!( + self.unbound_narrowing_constraint.is_some() + || self.live_bindings[0].binding.is_unbound() + ); + self.unbound_narrowing_constraint + .unwrap_or(self.live_bindings[0].narrowing_constraint) + } +} + +/// One of the live bindings for a single symbol at some point in control flow. +#[derive(Clone, Debug, PartialEq, Eq)] +pub(super) struct LiveBinding { + pub(super) binding: ScopedDefinitionId, + pub(super) narrowing_constraint: ScopedNarrowingConstraint, + pub(super) visibility_constraint: ScopedVisibilityConstraintId, +} + +pub(super) type LiveBindingsIterator<'a> = std::slice::Iter<'a, LiveBinding>; + +impl SymbolBindings { + fn unbound(scope_start_visibility: ScopedVisibilityConstraintId) -> Self { + let initial_binding = LiveBinding { + binding: ScopedDefinitionId::UNBOUND, + narrowing_constraint: ScopedNarrowingConstraint::empty(), + visibility_constraint: scope_start_visibility, + }; + Self { + unbound_narrowing_constraint: None, + live_bindings: smallvec![initial_binding], + } + } + + /// Record a newly-encountered binding for this symbol. + pub(super) fn record_binding( + &mut self, + binding: ScopedDefinitionId, + visibility_constraint: ScopedVisibilityConstraintId, + is_class_scope: bool, + ) { + // If we are in a class scope, and the unbound binding was previously visible, but we will + // now replace it, record the narrowing constraints on it: + if is_class_scope && self.live_bindings[0].binding.is_unbound() { + self.unbound_narrowing_constraint = Some(self.live_bindings[0].narrowing_constraint); + } + // The new binding replaces all previous live bindings in this path, and has no + // constraints. + self.live_bindings.clear(); + self.live_bindings.push(LiveBinding { + binding, + narrowing_constraint: ScopedNarrowingConstraint::empty(), + visibility_constraint, + }); + } + + /// Add given constraint to all live bindings. + pub(super) fn record_narrowing_constraint( + &mut self, + narrowing_constraints: &mut NarrowingConstraintsBuilder, + predicate: ScopedNarrowingConstraintPredicate, + ) { + for binding in &mut self.live_bindings { + binding.narrowing_constraint = narrowing_constraints + .add_predicate_to_constraint(binding.narrowing_constraint, predicate); + } + } + + /// Add given visibility constraint to all live bindings. + pub(super) fn record_visibility_constraint( + &mut self, + visibility_constraints: &mut VisibilityConstraintsBuilder, + constraint: ScopedVisibilityConstraintId, + ) { + for binding in &mut self.live_bindings { + binding.visibility_constraint = visibility_constraints + .add_and_constraint(binding.visibility_constraint, constraint); + } + } + + /// Iterate over currently live bindings for this symbol + pub(super) fn iter(&self) -> LiveBindingsIterator<'_> { + self.live_bindings.iter() + } + + /// Iterate over the IDs of each currently live binding for this symbol + fn iter_bindings(&self) -> impl Iterator<Item = ScopedDefinitionId> + '_ { + self.iter().map(|lb| lb.binding) + } + + fn simplify_visibility_constraints(&mut self, other: SymbolBindings) { + // If the set of live bindings hasn't changed, don't simplify. + if self.live_bindings.len() != other.live_bindings.len() + || !self.iter_bindings().eq(other.iter_bindings()) + { + return; + } + + for (binding, other_binding) in self.live_bindings.iter_mut().zip(other.live_bindings) { + binding.visibility_constraint = other_binding.visibility_constraint; + } + } + + fn merge( + &mut self, + b: Self, + narrowing_constraints: &mut NarrowingConstraintsBuilder, + visibility_constraints: &mut VisibilityConstraintsBuilder, + ) { + let a = std::mem::take(self); + + if let Some((a, b)) = a + .unbound_narrowing_constraint + .zip(b.unbound_narrowing_constraint) + { + self.unbound_narrowing_constraint = + Some(narrowing_constraints.intersect_constraints(a, b)); + } + + // Invariant: merge_join_by consumes the two iterators in sorted order, which ensures that + // the merged `live_bindings` vec remains sorted. If a definition is found in both `a` and + // `b`, we compose the constraints from the two paths in an appropriate way (intersection + // for narrowing constraints; ternary OR for visibility constraints). If a definition is + // found in only one path, it is used as-is. + let a = a.live_bindings.into_iter(); + let b = b.live_bindings.into_iter(); + for zipped in a.merge_join_by(b, |a, b| a.binding.cmp(&b.binding)) { + match zipped { + EitherOrBoth::Both(a, b) => { + // If the same definition is visible through both paths, any constraint + // that applies on only one path is irrelevant to the resulting type from + // unioning the two paths, so we intersect the constraints. + let narrowing_constraint = narrowing_constraints + .intersect_constraints(a.narrowing_constraint, b.narrowing_constraint); + + // For visibility constraints, we merge them using a ternary OR operation: + let visibility_constraint = visibility_constraints + .add_or_constraint(a.visibility_constraint, b.visibility_constraint); + + self.live_bindings.push(LiveBinding { + binding: a.binding, + narrowing_constraint, + visibility_constraint, + }); + } + + EitherOrBoth::Left(binding) | EitherOrBoth::Right(binding) => { + self.live_bindings.push(binding); + } + } + } + } +} + +#[derive(Clone, Debug, PartialEq, Eq)] +pub(in crate::semantic_index) struct SymbolState { + declarations: SymbolDeclarations, + bindings: SymbolBindings, +} + +impl SymbolState { + /// Return a new [`SymbolState`] representing an unbound, undeclared symbol. + pub(super) fn undefined(scope_start_visibility: ScopedVisibilityConstraintId) -> Self { + Self { + declarations: SymbolDeclarations::undeclared(scope_start_visibility), + bindings: SymbolBindings::unbound(scope_start_visibility), + } + } + + /// Record a newly-encountered binding for this symbol. + pub(super) fn record_binding( + &mut self, + binding_id: ScopedDefinitionId, + visibility_constraint: ScopedVisibilityConstraintId, + is_class_scope: bool, + ) { + debug_assert_ne!(binding_id, ScopedDefinitionId::UNBOUND); + self.bindings + .record_binding(binding_id, visibility_constraint, is_class_scope); + } + + /// Add given constraint to all live bindings. + pub(super) fn record_narrowing_constraint( + &mut self, + narrowing_constraints: &mut NarrowingConstraintsBuilder, + constraint: ScopedNarrowingConstraintPredicate, + ) { + self.bindings + .record_narrowing_constraint(narrowing_constraints, constraint); + } + + /// Add given visibility constraint to all live bindings. + pub(super) fn record_visibility_constraint( + &mut self, + visibility_constraints: &mut VisibilityConstraintsBuilder, + constraint: ScopedVisibilityConstraintId, + ) { + self.bindings + .record_visibility_constraint(visibility_constraints, constraint); + self.declarations + .record_visibility_constraint(visibility_constraints, constraint); + } + + /// Simplifies this snapshot to have the same visibility constraints as a previous point in the + /// control flow, but only if the set of live bindings or declarations for this symbol hasn't + /// changed. + pub(super) fn simplify_visibility_constraints(&mut self, snapshot_state: SymbolState) { + self.bindings + .simplify_visibility_constraints(snapshot_state.bindings); + self.declarations + .simplify_visibility_constraints(snapshot_state.declarations); + } + + /// Record a newly-encountered declaration of this symbol. + pub(super) fn record_declaration(&mut self, declaration_id: ScopedDefinitionId) { + self.declarations.record_declaration(declaration_id); + } + + /// Merge another [`SymbolState`] into this one. + pub(super) fn merge( + &mut self, + b: SymbolState, + narrowing_constraints: &mut NarrowingConstraintsBuilder, + visibility_constraints: &mut VisibilityConstraintsBuilder, + ) { + self.bindings + .merge(b.bindings, narrowing_constraints, visibility_constraints); + self.declarations + .merge(b.declarations, visibility_constraints); + } + + pub(super) fn bindings(&self) -> &SymbolBindings { + &self.bindings + } + + pub(super) fn declarations(&self) -> &SymbolDeclarations { + &self.declarations + } +} + +#[cfg(test)] +mod tests { + use super::*; + + use crate::semantic_index::predicate::ScopedPredicateId; + + #[track_caller] + fn assert_bindings( + narrowing_constraints: &NarrowingConstraintsBuilder, + symbol: &SymbolState, + expected: &[&str], + ) { + let actual = symbol + .bindings() + .iter() + .map(|live_binding| { + let def_id = live_binding.binding; + let def = if def_id == ScopedDefinitionId::UNBOUND { + "unbound".into() + } else { + def_id.as_u32().to_string() + }; + let predicates = narrowing_constraints + .iter_predicates(live_binding.narrowing_constraint) + .map(|idx| idx.as_u32().to_string()) + .collect::<Vec<_>>() + .join(", "); + format!("{def}<{predicates}>") + }) + .collect::<Vec<_>>(); + assert_eq!(actual, expected); + } + + #[track_caller] + pub(crate) fn assert_declarations(symbol: &SymbolState, expected: &[&str]) { + let actual = symbol + .declarations() + .iter() + .map( + |LiveDeclaration { + declaration, + visibility_constraint: _, + }| { + if *declaration == ScopedDefinitionId::UNBOUND { + "undeclared".into() + } else { + declaration.as_u32().to_string() + } + }, + ) + .collect::<Vec<_>>(); + assert_eq!(actual, expected); + } + + #[test] + fn unbound() { + let narrowing_constraints = NarrowingConstraintsBuilder::default(); + let sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + + assert_bindings(&narrowing_constraints, &sym, &["unbound<>"]); + } + + #[test] + fn with() { + let narrowing_constraints = NarrowingConstraintsBuilder::default(); + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_binding( + ScopedDefinitionId::from_u32(1), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + + assert_bindings(&narrowing_constraints, &sym, &["1<>"]); + } + + #[test] + fn record_constraint() { + let mut narrowing_constraints = NarrowingConstraintsBuilder::default(); + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_binding( + ScopedDefinitionId::from_u32(1), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(0).into(); + sym.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + assert_bindings(&narrowing_constraints, &sym, &["1<0>"]); + } + + #[test] + fn merge() { + let mut narrowing_constraints = NarrowingConstraintsBuilder::default(); + let mut visibility_constraints = VisibilityConstraintsBuilder::default(); + + // merging the same definition with the same constraint keeps the constraint + let mut sym1a = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym1a.record_binding( + ScopedDefinitionId::from_u32(1), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(0).into(); + sym1a.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + let mut sym1b = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym1b.record_binding( + ScopedDefinitionId::from_u32(1), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(0).into(); + sym1b.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + sym1a.merge( + sym1b, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + let mut sym1 = sym1a; + assert_bindings(&narrowing_constraints, &sym1, &["1<0>"]); + + // merging the same definition with differing constraints drops all constraints + let mut sym2a = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym2a.record_binding( + ScopedDefinitionId::from_u32(2), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(1).into(); + sym2a.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + let mut sym1b = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym1b.record_binding( + ScopedDefinitionId::from_u32(2), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(2).into(); + sym1b.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + sym2a.merge( + sym1b, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + let sym2 = sym2a; + assert_bindings(&narrowing_constraints, &sym2, &["2<>"]); + + // merging a constrained definition with unbound keeps both + let mut sym3a = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym3a.record_binding( + ScopedDefinitionId::from_u32(3), + ScopedVisibilityConstraintId::ALWAYS_TRUE, + false, + ); + let predicate = ScopedPredicateId::from_u32(3).into(); + sym3a.record_narrowing_constraint(&mut narrowing_constraints, predicate); + + let sym2b = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + + sym3a.merge( + sym2b, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + let sym3 = sym3a; + assert_bindings(&narrowing_constraints, &sym3, &["unbound<>", "3<3>"]); + + // merging different definitions keeps them each with their existing constraints + sym1.merge( + sym3, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + let sym = sym1; + assert_bindings(&narrowing_constraints, &sym, &["unbound<>", "1<0>", "3<3>"]); + } + + #[test] + fn no_declaration() { + let sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + + assert_declarations(&sym, &["undeclared"]); + } + + #[test] + fn record_declaration() { + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_declaration(ScopedDefinitionId::from_u32(1)); + + assert_declarations(&sym, &["1"]); + } + + #[test] + fn record_declaration_override() { + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_declaration(ScopedDefinitionId::from_u32(1)); + sym.record_declaration(ScopedDefinitionId::from_u32(2)); + + assert_declarations(&sym, &["2"]); + } + + #[test] + fn record_declaration_merge() { + let mut narrowing_constraints = NarrowingConstraintsBuilder::default(); + let mut visibility_constraints = VisibilityConstraintsBuilder::default(); + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_declaration(ScopedDefinitionId::from_u32(1)); + + let mut sym2 = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym2.record_declaration(ScopedDefinitionId::from_u32(2)); + + sym.merge( + sym2, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + + assert_declarations(&sym, &["1", "2"]); + } + + #[test] + fn record_declaration_merge_partial_undeclared() { + let mut narrowing_constraints = NarrowingConstraintsBuilder::default(); + let mut visibility_constraints = VisibilityConstraintsBuilder::default(); + let mut sym = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + sym.record_declaration(ScopedDefinitionId::from_u32(1)); + + let sym2 = SymbolState::undefined(ScopedVisibilityConstraintId::ALWAYS_TRUE); + + sym.merge( + sym2, + &mut narrowing_constraints, + &mut visibility_constraints, + ); + + assert_declarations(&sym, &["undeclared", "1"]); + } +} diff --git a/crates/ty_python_semantic/src/semantic_index/visibility_constraints.rs b/crates/ty_python_semantic/src/semantic_index/visibility_constraints.rs new file mode 100644 index 0000000000000..4e2e76e301fff --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_index/visibility_constraints.rs @@ -0,0 +1,691 @@ +//! # Visibility constraints +//! +//! During semantic index building, we collect visibility constraints for each binding and +//! declaration. These constraints are then used during type-checking to determine the static +//! visibility of a certain definition. This allows us to re-analyze control flow during type +//! checking, potentially "hiding" some branches that we can statically determine to never be +//! taken. Consider the following example first. We added implicit "unbound" definitions at the +//! start of the scope. Note how visibility constraints can apply to bindings outside of the +//! if-statement: +//! ```py +//! x = <unbound> # not a live binding for the use of x below, shadowed by `x = 1` +//! y = <unbound> # visibility constraint: ~test +//! +//! x = 1 # visibility constraint: ~test +//! if test: +//! x = 2 # visibility constraint: test +//! +//! y = 2 # visibility constraint: test +//! +//! use(x) +//! use(y) +//! ``` +//! The static truthiness of the `test` condition can either be always-false, ambiguous, or +//! always-true. Similarly, we have the same three options when evaluating a visibility constraint. +//! This outcome determines the visibility of a definition: always-true means that the definition +//! is definitely visible for a given use, always-false means that the definition is definitely +//! not visible, and ambiguous means that we might see this definition or not. In the latter case, +//! we need to consider both options during type inference and boundness analysis. For the example +//! above, these are the possible type inference / boundness results for the uses of `x` and `y`: +//! +//! ```text +//! | `test` truthiness | `~test` truthiness | type of `x` | boundness of `y` | +//! |-------------------|--------------------|-----------------|------------------| +//! | always false | always true | `Literal[1]` | unbound | +//! | ambiguous | ambiguous | `Literal[1, 2]` | possibly unbound | +//! | always true | always false | `Literal[2]` | bound | +//! ``` +//! +//! ### Sequential constraints (ternary AND) +//! +//! As we have seen above, visibility constraints can apply outside of a control flow element. +//! So we need to consider the possibility that multiple constraints apply to the same binding. +//! Here, we consider what happens if multiple `if`-statements lead to a sequence of constraints. +//! Consider the following example: +//! ```py +//! x = 0 +//! +//! if test1: +//! x = 1 +//! +//! if test2: +//! x = 2 +//! ``` +//! The binding `x = 2` is easy to analyze. Its visibility corresponds to the truthiness of `test2`. +//! For the `x = 1` binding, things are a bit more interesting. It is always visible if `test1` is +//! always-true *and* `test2` is always-false. It is never visible if `test1` is always-false *or* +//! `test2` is always-true. And it is ambiguous otherwise. This corresponds to a ternary *test1 AND +//! ~test2* operation in three-valued Kleene logic [Kleene]: +//! +//! ```text +//! | AND | always-false | ambiguous | always-true | +//! |--------------|--------------|--------------|--------------| +//! | always false | always-false | always-false | always-false | +//! | ambiguous | always-false | ambiguous | ambiguous | +//! | always true | always-false | ambiguous | always-true | +//! ``` +//! +//! The `x = 0` binding can be handled similarly, with the difference that both `test1` and `test2` +//! are negated: +//! ```py +//! x = 0 # ~test1 AND ~test2 +//! +//! if test1: +//! x = 1 # test1 AND ~test2 +//! +//! if test2: +//! x = 2 # test2 +//! ``` +//! +//! ### Merged constraints (ternary OR) +//! +//! Finally, we consider what happens in "parallel" control flow. Consider the following example +//! where we have omitted the test condition for the outer `if` for clarity: +//! ```py +//! x = 0 +//! +//! if <…>: +//! if test1: +//! x = 1 +//! else: +//! if test2: +//! x = 2 +//! +//! use(x) +//! ``` +//! At the usage of `x`, i.e. after control flow has been merged again, the visibility of the `x = +//! 0` binding behaves as follows: the binding is always visible if `test1` is always-false *or* +//! `test2` is always-false; and it is never visible if `test1` is always-true *and* `test2` is +//! always-true. This corresponds to a ternary *OR* operation in Kleene logic: +//! +//! ```text +//! | OR | always-false | ambiguous | always-true | +//! |--------------|--------------|--------------|--------------| +//! | always false | always-false | ambiguous | always-true | +//! | ambiguous | ambiguous | ambiguous | always-true | +//! | always true | always-true | always-true | always-true | +//! ``` +//! +//! Using this, we can annotate the visibility constraints for the example above: +//! ```py +//! x = 0 # ~test1 OR ~test2 +//! +//! if <…>: +//! if test1: +//! x = 1 # test1 +//! else: +//! if test2: +//! x = 2 # test2 +//! +//! use(x) +//! ``` +//! +//! ### Explicit ambiguity +//! +//! In some cases, we explicitly add an “ambiguous” constraint to all bindings +//! in a certain control flow path. We do this when branching on something that we can not (or +//! intentionally do not want to) analyze statically. `for` loops are one example: +//! ```py +//! x = <unbound> +//! +//! for _ in range(2): +//! x = 1 +//! ``` +//! Here, we report an ambiguous visibility constraint before branching off. If we don't do this, +//! the `x = <unbound>` binding would be considered unconditionally visible in the no-loop case. +//! And since the other branch does not have the live `x = <unbound>` binding, we would incorrectly +//! create a state where the `x = <unbound>` binding is always visible. +//! +//! +//! ### Representing formulas +//! +//! Given everything above, we can represent a visibility constraint as a _ternary formula_. This +//! is like a boolean formula (which maps several true/false variables to a single true/false +//! result), but which allows the third "ambiguous" value in addition to "true" and "false". +//! +//! [_Binary decision diagrams_][bdd] (BDDs) are a common way to represent boolean formulas when +//! doing program analysis. We extend this to a _ternary decision diagram_ (TDD) to support +//! ambiguous values. +//! +//! A TDD is a graph, and a ternary formula is represented by a node in this graph. There are three +//! possible leaf nodes representing the "true", "false", and "ambiguous" constant functions. +//! Interior nodes consist of a ternary variable to evaluate, and outgoing edges for whether the +//! variable evaluates to true, false, or ambiguous. +//! +//! Our TDDs are _reduced_ and _ordered_ (as is typical for BDDs). +//! +//! An ordered TDD means that variables appear in the same order in all paths within the graph. +//! +//! A reduced TDD means two things: First, we intern the graph nodes, so that we only keep a single +//! copy of interior nodes with the same contents. Second, we eliminate any nodes that are "noops", +//! where the "true" and "false" outgoing edges lead to the same node. (This implies that it +//! doesn't matter what value that variable has when evaluating the formula, and we can leave it +//! out of the evaluation chain completely.) +//! +//! Reduced and ordered decision diagrams are _normal forms_, which means that two equivalent +//! formulas (which have the same outputs for every combination of inputs) are represented by +//! exactly the same graph node. (Because of interning, this is not _equal_ nodes, but _identical_ +//! ones.) That means that we can compare formulas for equivalence in constant time, and in +//! particular, can check whether a visibility constraint is statically always true or false, +//! regardless of any Python program state, by seeing if the constraint's formula is the "true" or +//! "false" leaf node. +//! +//! [Kleene]: <https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics> +//! [bdd]: https://en.wikipedia.org/wiki/Binary_decision_diagram + +use std::cmp::Ordering; + +use ruff_index::{Idx, IndexVec}; +use rustc_hash::FxHashMap; + +use crate::Db; +use crate::dunder_all::dunder_all_names; +use crate::semantic_index::expression::Expression; +use crate::semantic_index::predicate::{ + PatternPredicate, PatternPredicateKind, Predicate, PredicateNode, Predicates, ScopedPredicateId, +}; +use crate::semantic_index::symbol_table; +use crate::symbol::{RequiresExplicitReExport, imported_symbol}; +use crate::types::{Truthiness, Type, infer_expression_type}; + +/// A ternary formula that defines under what conditions a binding is visible. (A ternary formula +/// is just like a boolean formula, but with `Ambiguous` as a third potential result. See the +/// module documentation for more details.) +/// +/// The primitive atoms of the formula are [`Predicate`]s, which express some property of the +/// runtime state of the code that we are analyzing. +/// +/// We assume that each atom has a stable value each time that the formula is evaluated. An atom +/// that resolves to `Ambiguous` might be true or false, and we can't tell which — but within that +/// evaluation, we assume that the atom has the _same_ unknown value each time it appears. That +/// allows us to perform simplifications like `A ∨ !A → true` and `A ∧ !A → false`. +/// +/// That means that when you are constructing a formula, you might need to create distinct atoms +/// for a particular [`Predicate`], if your formula needs to consider how a particular runtime +/// property might be different at different points in the execution of the program. +/// +/// Visibility constraints are normalized, so equivalent constraints are guaranteed to have equal +/// IDs. +#[derive(Clone, Copy, Eq, Hash, PartialEq)] +pub(crate) struct ScopedVisibilityConstraintId(u32); + +impl std::fmt::Debug for ScopedVisibilityConstraintId { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let mut f = f.debug_tuple("ScopedVisibilityConstraintId"); + match *self { + // We use format_args instead of rendering the strings directly so that we don't get + // any quotes in the output: ScopedVisibilityConstraintId(AlwaysTrue) instead of + // ScopedVisibilityConstraintId("AlwaysTrue"). + ALWAYS_TRUE => f.field(&format_args!("AlwaysTrue")), + AMBIGUOUS => f.field(&format_args!("Ambiguous")), + ALWAYS_FALSE => f.field(&format_args!("AlwaysFalse")), + _ => f.field(&self.0), + }; + f.finish() + } +} + +// Internal details: +// +// There are 3 terminals, with hard-coded constraint IDs: true, ambiguous, and false. +// +// _Atoms_ are the underlying Predicates, which are the variables that are evaluated by the +// ternary function. +// +// _Interior nodes_ provide the TDD structure for the formula. Interior nodes are stored in an +// arena Vec, with the constraint ID providing an index into the arena. + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] +struct InteriorNode { + /// A "variable" that is evaluated as part of a TDD ternary function. For visibility + /// constraints, this is a `Predicate` that represents some runtime property of the Python + /// code that we are evaluating. + atom: ScopedPredicateId, + if_true: ScopedVisibilityConstraintId, + if_ambiguous: ScopedVisibilityConstraintId, + if_false: ScopedVisibilityConstraintId, +} + +impl ScopedVisibilityConstraintId { + /// A special ID that is used for an "always true" / "always visible" constraint. + pub(crate) const ALWAYS_TRUE: ScopedVisibilityConstraintId = + ScopedVisibilityConstraintId(0xffff_ffff); + + /// A special ID that is used for an ambiguous constraint. + pub(crate) const AMBIGUOUS: ScopedVisibilityConstraintId = + ScopedVisibilityConstraintId(0xffff_fffe); + + /// A special ID that is used for an "always false" / "never visible" constraint. + pub(crate) const ALWAYS_FALSE: ScopedVisibilityConstraintId = + ScopedVisibilityConstraintId(0xffff_fffd); + + fn is_terminal(self) -> bool { + self.0 >= SMALLEST_TERMINAL.0 + } +} + +impl Idx for ScopedVisibilityConstraintId { + #[inline] + fn new(value: usize) -> Self { + assert!(value <= (SMALLEST_TERMINAL.0 as usize)); + #[expect(clippy::cast_possible_truncation)] + Self(value as u32) + } + + #[inline] + fn index(self) -> usize { + debug_assert!(!self.is_terminal()); + self.0 as usize + } +} + +// Rebind some constants locally so that we don't need as many qualifiers below. +const ALWAYS_TRUE: ScopedVisibilityConstraintId = ScopedVisibilityConstraintId::ALWAYS_TRUE; +const AMBIGUOUS: ScopedVisibilityConstraintId = ScopedVisibilityConstraintId::AMBIGUOUS; +const ALWAYS_FALSE: ScopedVisibilityConstraintId = ScopedVisibilityConstraintId::ALWAYS_FALSE; +const SMALLEST_TERMINAL: ScopedVisibilityConstraintId = ALWAYS_FALSE; + +/// A collection of visibility constraints for a given scope. +#[derive(Debug, PartialEq, Eq, salsa::Update)] +pub(crate) struct VisibilityConstraints { + interiors: IndexVec<ScopedVisibilityConstraintId, InteriorNode>, +} + +#[derive(Debug, Default, PartialEq, Eq)] +pub(crate) struct VisibilityConstraintsBuilder { + interiors: IndexVec<ScopedVisibilityConstraintId, InteriorNode>, + interior_cache: FxHashMap<InteriorNode, ScopedVisibilityConstraintId>, + not_cache: FxHashMap<ScopedVisibilityConstraintId, ScopedVisibilityConstraintId>, + and_cache: FxHashMap< + (ScopedVisibilityConstraintId, ScopedVisibilityConstraintId), + ScopedVisibilityConstraintId, + >, + or_cache: FxHashMap< + (ScopedVisibilityConstraintId, ScopedVisibilityConstraintId), + ScopedVisibilityConstraintId, + >, +} + +impl VisibilityConstraintsBuilder { + pub(crate) fn build(self) -> VisibilityConstraints { + VisibilityConstraints { + interiors: self.interiors, + } + } + + /// Returns whether `a` or `b` has a "larger" atom. TDDs are ordered such that interior nodes + /// can only have edges to "larger" nodes. Terminals are considered to have a larger atom than + /// any internal node, since they are leaf nodes. + fn cmp_atoms( + &self, + a: ScopedVisibilityConstraintId, + b: ScopedVisibilityConstraintId, + ) -> Ordering { + if a == b || (a.is_terminal() && b.is_terminal()) { + Ordering::Equal + } else if a.is_terminal() { + Ordering::Greater + } else if b.is_terminal() { + Ordering::Less + } else { + self.interiors[a].atom.cmp(&self.interiors[b].atom) + } + } + + /// Adds an interior node, ensuring that we always use the same visibility constraint ID for + /// equal nodes. + fn add_interior(&mut self, node: InteriorNode) -> ScopedVisibilityConstraintId { + // If the true and false branches lead to the same node, we can override the ambiguous + // branch to go there too. And this node is then redundant and can be reduced. + if node.if_true == node.if_false { + return node.if_true; + } + + *self + .interior_cache + .entry(node) + .or_insert_with(|| self.interiors.push(node)) + } + + /// Adds a new visibility constraint that checks a single [`Predicate`]. + /// + /// [`ScopedPredicateId`]s are the “variables” that are evaluated by a TDD. A TDD variable has + /// the same value no matter how many times it appears in the ternary formula that the TDD + /// represents. + /// + /// However, we sometimes have to model how a `Predicate` can have a different runtime + /// value at different points in the execution of the program. To handle this, you can take + /// advantage of the fact that the [`Predicates`] arena does not deduplicate `Predicate`s. + /// You can add a `Predicate` multiple times, yielding different `ScopedPredicateId`s, which + /// you can then create separate TDD atoms for. + pub(crate) fn add_atom( + &mut self, + predicate: ScopedPredicateId, + ) -> ScopedVisibilityConstraintId { + self.add_interior(InteriorNode { + atom: predicate, + if_true: ALWAYS_TRUE, + if_ambiguous: AMBIGUOUS, + if_false: ALWAYS_FALSE, + }) + } + + /// Adds a new visibility constraint that is the ternary NOT of an existing one. + pub(crate) fn add_not_constraint( + &mut self, + a: ScopedVisibilityConstraintId, + ) -> ScopedVisibilityConstraintId { + if a == ALWAYS_TRUE { + return ALWAYS_FALSE; + } else if a == AMBIGUOUS { + return AMBIGUOUS; + } else if a == ALWAYS_FALSE { + return ALWAYS_TRUE; + } + + if let Some(cached) = self.not_cache.get(&a) { + return *cached; + } + let a_node = self.interiors[a]; + let if_true = self.add_not_constraint(a_node.if_true); + let if_ambiguous = self.add_not_constraint(a_node.if_ambiguous); + let if_false = self.add_not_constraint(a_node.if_false); + let result = self.add_interior(InteriorNode { + atom: a_node.atom, + if_true, + if_ambiguous, + if_false, + }); + self.not_cache.insert(a, result); + result + } + + /// Adds a new visibility constraint that is the ternary OR of two existing ones. + pub(crate) fn add_or_constraint( + &mut self, + a: ScopedVisibilityConstraintId, + b: ScopedVisibilityConstraintId, + ) -> ScopedVisibilityConstraintId { + match (a, b) { + (ALWAYS_TRUE, _) | (_, ALWAYS_TRUE) => return ALWAYS_TRUE, + (ALWAYS_FALSE, other) | (other, ALWAYS_FALSE) => return other, + (AMBIGUOUS, AMBIGUOUS) => return AMBIGUOUS, + _ => {} + } + + // OR is commutative, which lets us halve the cache requirements + let (a, b) = if b.0 < a.0 { (b, a) } else { (a, b) }; + if let Some(cached) = self.or_cache.get(&(a, b)) { + return *cached; + } + + let (atom, if_true, if_ambiguous, if_false) = match self.cmp_atoms(a, b) { + Ordering::Equal => { + let a_node = self.interiors[a]; + let b_node = self.interiors[b]; + let if_true = self.add_or_constraint(a_node.if_true, b_node.if_true); + let if_false = self.add_or_constraint(a_node.if_false, b_node.if_false); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_or_constraint(a_node.if_ambiguous, b_node.if_ambiguous) + }; + (a_node.atom, if_true, if_ambiguous, if_false) + } + Ordering::Less => { + let a_node = self.interiors[a]; + let if_true = self.add_or_constraint(a_node.if_true, b); + let if_false = self.add_or_constraint(a_node.if_false, b); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_or_constraint(a_node.if_ambiguous, b) + }; + (a_node.atom, if_true, if_ambiguous, if_false) + } + Ordering::Greater => { + let b_node = self.interiors[b]; + let if_true = self.add_or_constraint(a, b_node.if_true); + let if_false = self.add_or_constraint(a, b_node.if_false); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_or_constraint(a, b_node.if_ambiguous) + }; + (b_node.atom, if_true, if_ambiguous, if_false) + } + }; + + let result = self.add_interior(InteriorNode { + atom, + if_true, + if_ambiguous, + if_false, + }); + self.or_cache.insert((a, b), result); + result + } + + /// Adds a new visibility constraint that is the ternary AND of two existing ones. + pub(crate) fn add_and_constraint( + &mut self, + a: ScopedVisibilityConstraintId, + b: ScopedVisibilityConstraintId, + ) -> ScopedVisibilityConstraintId { + match (a, b) { + (ALWAYS_FALSE, _) | (_, ALWAYS_FALSE) => return ALWAYS_FALSE, + (ALWAYS_TRUE, other) | (other, ALWAYS_TRUE) => return other, + (AMBIGUOUS, AMBIGUOUS) => return AMBIGUOUS, + _ => {} + } + + // AND is commutative, which lets us halve the cache requirements + let (a, b) = if b.0 < a.0 { (b, a) } else { (a, b) }; + if let Some(cached) = self.and_cache.get(&(a, b)) { + return *cached; + } + + let (atom, if_true, if_ambiguous, if_false) = match self.cmp_atoms(a, b) { + Ordering::Equal => { + let a_node = self.interiors[a]; + let b_node = self.interiors[b]; + let if_true = self.add_and_constraint(a_node.if_true, b_node.if_true); + let if_false = self.add_and_constraint(a_node.if_false, b_node.if_false); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_and_constraint(a_node.if_ambiguous, b_node.if_ambiguous) + }; + (a_node.atom, if_true, if_ambiguous, if_false) + } + Ordering::Less => { + let a_node = self.interiors[a]; + let if_true = self.add_and_constraint(a_node.if_true, b); + let if_false = self.add_and_constraint(a_node.if_false, b); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_and_constraint(a_node.if_ambiguous, b) + }; + (a_node.atom, if_true, if_ambiguous, if_false) + } + Ordering::Greater => { + let b_node = self.interiors[b]; + let if_true = self.add_and_constraint(a, b_node.if_true); + let if_false = self.add_and_constraint(a, b_node.if_false); + let if_ambiguous = if if_true == if_false { + if_true + } else { + self.add_and_constraint(a, b_node.if_ambiguous) + }; + (b_node.atom, if_true, if_ambiguous, if_false) + } + }; + + let result = self.add_interior(InteriorNode { + atom, + if_true, + if_ambiguous, + if_false, + }); + self.and_cache.insert((a, b), result); + result + } +} + +impl VisibilityConstraints { + /// Analyze the statically known visibility for a given visibility constraint. + pub(crate) fn evaluate<'db>( + &self, + db: &'db dyn Db, + predicates: &Predicates<'db>, + mut id: ScopedVisibilityConstraintId, + ) -> Truthiness { + loop { + let node = match id { + ALWAYS_TRUE => return Truthiness::AlwaysTrue, + AMBIGUOUS => return Truthiness::Ambiguous, + ALWAYS_FALSE => return Truthiness::AlwaysFalse, + _ => self.interiors[id], + }; + let predicate = &predicates[node.atom]; + match Self::analyze_single(db, predicate) { + Truthiness::AlwaysTrue => id = node.if_true, + Truthiness::Ambiguous => id = node.if_ambiguous, + Truthiness::AlwaysFalse => id = node.if_false, + } + } + } + + fn analyze_single_pattern_predicate_kind<'db>( + db: &'db dyn Db, + predicate_kind: &PatternPredicateKind<'db>, + subject: Expression<'db>, + ) -> Truthiness { + match predicate_kind { + PatternPredicateKind::Value(value) => { + let subject_ty = infer_expression_type(db, subject); + let value_ty = infer_expression_type(db, *value); + + if subject_ty.is_single_valued(db) { + Truthiness::from(subject_ty.is_equivalent_to(db, value_ty)) + } else { + Truthiness::Ambiguous + } + } + PatternPredicateKind::Singleton(singleton) => { + let subject_ty = infer_expression_type(db, subject); + + let singleton_ty = match singleton { + ruff_python_ast::Singleton::None => Type::none(db), + ruff_python_ast::Singleton::True => Type::BooleanLiteral(true), + ruff_python_ast::Singleton::False => Type::BooleanLiteral(false), + }; + + debug_assert!(singleton_ty.is_singleton(db)); + + if subject_ty.is_equivalent_to(db, singleton_ty) { + Truthiness::AlwaysTrue + } else if subject_ty.is_disjoint_from(db, singleton_ty) { + Truthiness::AlwaysFalse + } else { + Truthiness::Ambiguous + } + } + PatternPredicateKind::Or(predicates) => { + use std::ops::ControlFlow; + let (ControlFlow::Break(truthiness) | ControlFlow::Continue(truthiness)) = + predicates + .iter() + .map(|p| Self::analyze_single_pattern_predicate_kind(db, p, subject)) + // this is just a "max", but with a slight optimization: `AlwaysTrue` is the "greatest" possible element, so we short-circuit if we get there + .try_fold(Truthiness::AlwaysFalse, |acc, next| match (acc, next) { + (Truthiness::AlwaysTrue, _) | (_, Truthiness::AlwaysTrue) => { + ControlFlow::Break(Truthiness::AlwaysTrue) + } + (Truthiness::Ambiguous, _) | (_, Truthiness::Ambiguous) => { + ControlFlow::Continue(Truthiness::Ambiguous) + } + (Truthiness::AlwaysFalse, Truthiness::AlwaysFalse) => { + ControlFlow::Continue(Truthiness::AlwaysFalse) + } + }); + truthiness + } + PatternPredicateKind::Class(class_expr) => { + let subject_ty = infer_expression_type(db, subject); + let class_ty = infer_expression_type(db, *class_expr).to_instance(db); + + class_ty.map_or(Truthiness::Ambiguous, |class_ty| { + if subject_ty.is_subtype_of(db, class_ty) { + Truthiness::AlwaysTrue + } else if subject_ty.is_disjoint_from(db, class_ty) { + Truthiness::AlwaysFalse + } else { + Truthiness::Ambiguous + } + }) + } + PatternPredicateKind::Unsupported => Truthiness::Ambiguous, + } + } + + fn analyze_single_pattern_predicate(db: &dyn Db, predicate: PatternPredicate) -> Truthiness { + let truthiness = Self::analyze_single_pattern_predicate_kind( + db, + predicate.kind(db), + predicate.subject(db), + ); + + if truthiness == Truthiness::AlwaysTrue && predicate.guard(db).is_some() { + // Fall back to ambiguous, the guard might change the result. + // TODO: actually analyze guard truthiness + Truthiness::Ambiguous + } else { + truthiness + } + } + + fn analyze_single(db: &dyn Db, predicate: &Predicate) -> Truthiness { + match predicate.node { + PredicateNode::Expression(test_expr) => { + let ty = infer_expression_type(db, test_expr); + ty.bool(db).negate_if(!predicate.is_positive) + } + PredicateNode::Pattern(inner) => Self::analyze_single_pattern_predicate(db, inner), + PredicateNode::StarImportPlaceholder(star_import) => { + let symbol_table = symbol_table(db, star_import.scope(db)); + let symbol_name = symbol_table.symbol(star_import.symbol_id(db)).name(); + let referenced_file = star_import.referenced_file(db); + + let requires_explicit_reexport = match dunder_all_names(db, referenced_file) { + Some(all_names) => { + if all_names.contains(symbol_name) { + Some(RequiresExplicitReExport::No) + } else { + tracing::trace!( + "Symbol `{}` (via star import) not found in `__all__` of `{}`", + symbol_name, + referenced_file.path(db) + ); + return Truthiness::AlwaysFalse; + } + } + None => None, + }; + + match imported_symbol(db, referenced_file, symbol_name, requires_explicit_reexport) + .symbol + { + crate::symbol::Symbol::Type(_, crate::symbol::Boundness::Bound) => { + Truthiness::AlwaysTrue + } + crate::symbol::Symbol::Type(_, crate::symbol::Boundness::PossiblyUnbound) => { + Truthiness::Ambiguous + } + crate::symbol::Symbol::Unbound => Truthiness::AlwaysFalse, + } + } + } + } +} diff --git a/crates/ty_python_semantic/src/semantic_model.rs b/crates/ty_python_semantic/src/semantic_model.rs new file mode 100644 index 0000000000000..eaa9d13131fcc --- /dev/null +++ b/crates/ty_python_semantic/src/semantic_model.rs @@ -0,0 +1,241 @@ +use ruff_db::files::{File, FilePath}; +use ruff_db::source::line_index; +use ruff_python_ast as ast; +use ruff_python_ast::{Expr, ExprRef}; +use ruff_source_file::LineIndex; + +use crate::Db; +use crate::module_name::ModuleName; +use crate::module_resolver::{Module, resolve_module}; +use crate::semantic_index::ast_ids::HasScopedExpressionId; +use crate::semantic_index::semantic_index; +use crate::types::{Type, binding_type, infer_scope_types}; + +pub struct SemanticModel<'db> { + db: &'db dyn Db, + file: File, +} + +impl<'db> SemanticModel<'db> { + pub fn new(db: &'db dyn Db, file: File) -> Self { + Self { db, file } + } + + // TODO we don't actually want to expose the Db directly to lint rules, but we need to find a + // solution for exposing information from types + pub fn db(&self) -> &dyn Db { + self.db + } + + pub fn file_path(&self) -> &FilePath { + self.file.path(self.db) + } + + pub fn line_index(&self) -> LineIndex { + line_index(self.db.upcast(), self.file) + } + + pub fn resolve_module(&self, module_name: &ModuleName) -> Option<Module> { + resolve_module(self.db, module_name) + } +} + +pub trait HasType { + /// Returns the inferred type of `self`. + /// + /// ## Panics + /// May panic if `self` is from another file than `model`. + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db>; +} + +impl HasType for ast::ExprRef<'_> { + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { + let index = semantic_index(model.db, model.file); + let file_scope = index.expression_scope_id(*self); + let scope = file_scope.to_scope_id(model.db, model.file); + + let expression_id = self.scoped_expression_id(model.db, scope); + infer_scope_types(model.db, scope).expression_type(expression_id) + } +} + +macro_rules! impl_expression_has_type { + ($ty: ty) => { + impl HasType for $ty { + #[inline] + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { + let expression_ref = ExprRef::from(self); + expression_ref.inferred_type(model) + } + } + }; +} + +impl_expression_has_type!(ast::ExprBoolOp); +impl_expression_has_type!(ast::ExprNamed); +impl_expression_has_type!(ast::ExprBinOp); +impl_expression_has_type!(ast::ExprUnaryOp); +impl_expression_has_type!(ast::ExprLambda); +impl_expression_has_type!(ast::ExprIf); +impl_expression_has_type!(ast::ExprDict); +impl_expression_has_type!(ast::ExprSet); +impl_expression_has_type!(ast::ExprListComp); +impl_expression_has_type!(ast::ExprSetComp); +impl_expression_has_type!(ast::ExprDictComp); +impl_expression_has_type!(ast::ExprGenerator); +impl_expression_has_type!(ast::ExprAwait); +impl_expression_has_type!(ast::ExprYield); +impl_expression_has_type!(ast::ExprYieldFrom); +impl_expression_has_type!(ast::ExprCompare); +impl_expression_has_type!(ast::ExprCall); +impl_expression_has_type!(ast::ExprFString); +impl_expression_has_type!(ast::ExprStringLiteral); +impl_expression_has_type!(ast::ExprBytesLiteral); +impl_expression_has_type!(ast::ExprNumberLiteral); +impl_expression_has_type!(ast::ExprBooleanLiteral); +impl_expression_has_type!(ast::ExprNoneLiteral); +impl_expression_has_type!(ast::ExprEllipsisLiteral); +impl_expression_has_type!(ast::ExprAttribute); +impl_expression_has_type!(ast::ExprSubscript); +impl_expression_has_type!(ast::ExprStarred); +impl_expression_has_type!(ast::ExprName); +impl_expression_has_type!(ast::ExprList); +impl_expression_has_type!(ast::ExprTuple); +impl_expression_has_type!(ast::ExprSlice); +impl_expression_has_type!(ast::ExprIpyEscapeCommand); + +impl HasType for ast::Expr { + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { + match self { + Expr::BoolOp(inner) => inner.inferred_type(model), + Expr::Named(inner) => inner.inferred_type(model), + Expr::BinOp(inner) => inner.inferred_type(model), + Expr::UnaryOp(inner) => inner.inferred_type(model), + Expr::Lambda(inner) => inner.inferred_type(model), + Expr::If(inner) => inner.inferred_type(model), + Expr::Dict(inner) => inner.inferred_type(model), + Expr::Set(inner) => inner.inferred_type(model), + Expr::ListComp(inner) => inner.inferred_type(model), + Expr::SetComp(inner) => inner.inferred_type(model), + Expr::DictComp(inner) => inner.inferred_type(model), + Expr::Generator(inner) => inner.inferred_type(model), + Expr::Await(inner) => inner.inferred_type(model), + Expr::Yield(inner) => inner.inferred_type(model), + Expr::YieldFrom(inner) => inner.inferred_type(model), + Expr::Compare(inner) => inner.inferred_type(model), + Expr::Call(inner) => inner.inferred_type(model), + Expr::FString(inner) => inner.inferred_type(model), + Expr::StringLiteral(inner) => inner.inferred_type(model), + Expr::BytesLiteral(inner) => inner.inferred_type(model), + Expr::NumberLiteral(inner) => inner.inferred_type(model), + Expr::BooleanLiteral(inner) => inner.inferred_type(model), + Expr::NoneLiteral(inner) => inner.inferred_type(model), + Expr::EllipsisLiteral(inner) => inner.inferred_type(model), + Expr::Attribute(inner) => inner.inferred_type(model), + Expr::Subscript(inner) => inner.inferred_type(model), + Expr::Starred(inner) => inner.inferred_type(model), + Expr::Name(inner) => inner.inferred_type(model), + Expr::List(inner) => inner.inferred_type(model), + Expr::Tuple(inner) => inner.inferred_type(model), + Expr::Slice(inner) => inner.inferred_type(model), + Expr::IpyEscapeCommand(inner) => inner.inferred_type(model), + } + } +} + +macro_rules! impl_binding_has_ty { + ($ty: ty) => { + impl HasType for $ty { + #[inline] + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { + let index = semantic_index(model.db, model.file); + let binding = index.expect_single_definition(self); + binding_type(model.db, binding) + } + } + }; +} + +impl_binding_has_ty!(ast::StmtFunctionDef); +impl_binding_has_ty!(ast::StmtClassDef); +impl_binding_has_ty!(ast::Parameter); +impl_binding_has_ty!(ast::ParameterWithDefault); +impl_binding_has_ty!(ast::ExceptHandlerExceptHandler); + +impl HasType for ast::Alias { + fn inferred_type<'db>(&self, model: &SemanticModel<'db>) -> Type<'db> { + if &self.name == "*" { + return Type::Never; + } + let index = semantic_index(model.db, model.file); + binding_type(model.db, index.expect_single_definition(self)) + } +} + +#[cfg(test)] +mod tests { + use ruff_db::files::system_path_to_file; + use ruff_db::parsed::parsed_module; + + use crate::db::tests::TestDbBuilder; + use crate::{HasType, SemanticModel}; + + #[test] + fn function_type() -> anyhow::Result<()> { + let db = TestDbBuilder::new() + .with_file("/src/foo.py", "def test(): pass") + .build()?; + + let foo = system_path_to_file(&db, "/src/foo.py").unwrap(); + + let ast = parsed_module(&db, foo); + + let function = ast.suite()[0].as_function_def_stmt().unwrap(); + let model = SemanticModel::new(&db, foo); + let ty = function.inferred_type(&model); + + assert!(ty.is_function_literal()); + + Ok(()) + } + + #[test] + fn class_type() -> anyhow::Result<()> { + let db = TestDbBuilder::new() + .with_file("/src/foo.py", "class Test: pass") + .build()?; + + let foo = system_path_to_file(&db, "/src/foo.py").unwrap(); + + let ast = parsed_module(&db, foo); + + let class = ast.suite()[0].as_class_def_stmt().unwrap(); + let model = SemanticModel::new(&db, foo); + let ty = class.inferred_type(&model); + + assert!(ty.is_class_literal()); + + Ok(()) + } + + #[test] + fn alias_type() -> anyhow::Result<()> { + let db = TestDbBuilder::new() + .with_file("/src/foo.py", "class Test: pass") + .with_file("/src/bar.py", "from foo import Test") + .build()?; + + let bar = system_path_to_file(&db, "/src/bar.py").unwrap(); + + let ast = parsed_module(&db, bar); + + let import = ast.suite()[0].as_import_from_stmt().unwrap(); + let alias = &import.names[0]; + let model = SemanticModel::new(&db, bar); + let ty = alias.inferred_type(&model); + + assert!(ty.is_class_literal()); + + Ok(()) + } +} diff --git a/crates/ty_python_semantic/src/site_packages.rs b/crates/ty_python_semantic/src/site_packages.rs new file mode 100644 index 0000000000000..e893c8817e968 --- /dev/null +++ b/crates/ty_python_semantic/src/site_packages.rs @@ -0,0 +1,1360 @@ +//! Utilities for finding the `site-packages` directory, +//! into which third-party packages are installed. +//! +//! The routines exposed by this module have different behaviour depending +//! on the platform of the *host machine*, which may be +//! different from the *target platform for type checking*. (A user +//! might be running ty on a Windows machine, but might +//! reasonably ask us to type-check code assuming that the code runs +//! on Linux.) + +use std::fmt; +use std::fmt::Display; +use std::io; +use std::num::NonZeroUsize; +use std::ops::Deref; + +use ruff_db::system::{System, SystemPath, SystemPathBuf}; +use ruff_python_ast::PythonVersion; + +type SitePackagesDiscoveryResult<T> = Result<T, SitePackagesDiscoveryError>; + +#[derive(Debug)] +pub(crate) enum PythonEnvironment { + Virtual(VirtualEnvironment), + System(SystemEnvironment), +} + +impl PythonEnvironment { + pub(crate) fn new( + path: impl AsRef<SystemPath>, + origin: SysPrefixPathOrigin, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Self> { + let path = SysPrefixPath::new(path, origin, system)?; + + // Attempt to inspect as a virtual environment first + // TODO(zanieb): Consider avoiding the clone here by checking for `pyvenv.cfg` ahead-of-time + match VirtualEnvironment::new(path.clone(), origin, system) { + Ok(venv) => Ok(Self::Virtual(venv)), + // If there's not a `pyvenv.cfg` marker, attempt to inspect as a system environment + // + Err(SitePackagesDiscoveryError::NoPyvenvCfgFile(_, _)) + if !origin.must_be_virtual_env() => + { + Ok(Self::System(SystemEnvironment::new(path))) + } + Err(err) => Err(err), + } + } + + /// Returns the `site-packages` directories for this Python environment. + /// + /// See the documentation for [`site_packages_directory_from_sys_prefix`] for more details. + pub(crate) fn site_packages_directories( + &self, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Vec<SystemPathBuf>> { + match self { + Self::Virtual(env) => env.site_packages_directories(system), + Self::System(env) => env.site_packages_directories(system), + } + } +} + +/// The Python runtime that produced the venv. +/// +/// We only need to distinguish cases that change the on-disk layout. +/// Everything else can be treated like CPython. +#[derive(Debug, Copy, Clone, Eq, PartialEq)] +pub(crate) enum PythonImplementation { + CPython, + PyPy, + GraalPy, + /// Fallback when the value is missing or unrecognised. + /// We treat it like CPython but keep the information for diagnostics. + Unknown, +} + +impl PythonImplementation { + /// Return the relative path from `sys.prefix` to the `site-packages` directory + /// if this is a known implementation. Return `None` if this is an unknown implementation. + fn relative_site_packages_path(self, version: Option<PythonVersion>) -> Option<String> { + match self { + Self::CPython | Self::GraalPy => { + version.map(|version| format!("lib/python{version}/site-packages")) + } + Self::PyPy => version.map(|version| format!("lib/pypy{version}/site-packages")), + Self::Unknown => None, + } + } +} + +/// Abstraction for a Python virtual environment. +/// +/// Most of this information is derived from the virtual environment's `pyvenv.cfg` file. +/// The format of this file is not defined anywhere, and exactly which keys are present +/// depends on the tool that was used to create the virtual environment. +#[derive(Debug)] +pub(crate) struct VirtualEnvironment { + root_path: SysPrefixPath, + base_executable_home_path: PythonHomePath, + include_system_site_packages: bool, + + /// The version of the Python executable that was used to create this virtual environment. + /// + /// The Python version is encoded under different keys and in different formats + /// by different virtual-environment creation tools, + /// and the key is never read by the standard-library `site.py` module, + /// so it's possible that we might not be able to find this information + /// in an acceptable format under any of the keys we expect. + /// This field will be `None` if so. + version: Option<PythonVersion>, + implementation: PythonImplementation, +} + +impl VirtualEnvironment { + pub(crate) fn new( + path: SysPrefixPath, + origin: SysPrefixPathOrigin, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Self> { + fn pyvenv_cfg_line_number(index: usize) -> NonZeroUsize { + index.checked_add(1).and_then(NonZeroUsize::new).unwrap() + } + + let pyvenv_cfg_path = path.join("pyvenv.cfg"); + tracing::debug!("Attempting to parse virtual environment metadata at '{pyvenv_cfg_path}'"); + + let pyvenv_cfg = system + .read_to_string(&pyvenv_cfg_path) + .map_err(|io_err| SitePackagesDiscoveryError::NoPyvenvCfgFile(origin, io_err))?; + + let mut include_system_site_packages = false; + let mut base_executable_home_path = None; + let mut version_info_string = None; + let mut implementation = PythonImplementation::Unknown; + + // A `pyvenv.cfg` file *looks* like a `.ini` file, but actually isn't valid `.ini` syntax! + // The Python standard-library's `site` module parses these files by splitting each line on + // '=' characters, so that's what we should do as well. + // + // See also: https://snarky.ca/how-virtual-environments-work/ + for (index, line) in pyvenv_cfg.lines().enumerate() { + if let Some((key, value)) = line.split_once('=') { + let key = key.trim(); + if key.is_empty() { + return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + pyvenv_cfg_path, + PyvenvCfgParseErrorKind::MalformedKeyValuePair { + line_number: pyvenv_cfg_line_number(index), + }, + )); + } + + let value = value.trim(); + if value.is_empty() { + return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + pyvenv_cfg_path, + PyvenvCfgParseErrorKind::MalformedKeyValuePair { + line_number: pyvenv_cfg_line_number(index), + }, + )); + } + + match key { + "include-system-site-packages" => { + include_system_site_packages = value.eq_ignore_ascii_case("true"); + } + "home" => base_executable_home_path = Some(value), + // `virtualenv` and `uv` call this key `version_info`, + // but the stdlib venv module calls it `version` + "version" | "version_info" => version_info_string = Some(value), + "implementation" => { + implementation = match value.to_ascii_lowercase().as_str() { + "cpython" => PythonImplementation::CPython, + "graalvm" => PythonImplementation::GraalPy, + "pypy" => PythonImplementation::PyPy, + _ => PythonImplementation::Unknown, + }; + } + _ => continue, + } + } + } + + // The `home` key is read by the standard library's `site.py` module, + // so if it's missing from the `pyvenv.cfg` file + // (or the provided value is invalid), + // it's reasonable to consider the virtual environment irredeemably broken. + let Some(base_executable_home_path) = base_executable_home_path else { + return Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + pyvenv_cfg_path, + PyvenvCfgParseErrorKind::NoHomeKey, + )); + }; + let base_executable_home_path = PythonHomePath::new(base_executable_home_path, system) + .map_err(|io_err| { + SitePackagesDiscoveryError::PyvenvCfgParseError( + pyvenv_cfg_path, + PyvenvCfgParseErrorKind::InvalidHomeValue(io_err), + ) + })?; + + // but the `version`/`version_info` key is not read by the standard library, + // and is provided under different keys depending on which virtual-environment creation tool + // created the `pyvenv.cfg` file. Lenient parsing is appropriate here: + // the file isn't really *invalid* if it doesn't have this key, + // or if the value doesn't parse according to our expectations. + let version = version_info_string.and_then(|version_string| { + let mut version_info_parts = version_string.split('.'); + let (major, minor) = (version_info_parts.next()?, version_info_parts.next()?); + PythonVersion::try_from((major, minor)).ok() + }); + + let metadata = Self { + root_path: path, + base_executable_home_path, + include_system_site_packages, + version, + implementation, + }; + + tracing::trace!("Resolved metadata for virtual environment: {metadata:?}"); + Ok(metadata) + } + + /// Return a list of `site-packages` directories that are available from this virtual environment + /// + /// See the documentation for [`site_packages_directory_from_sys_prefix`] for more details. + pub(crate) fn site_packages_directories( + &self, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Vec<SystemPathBuf>> { + let VirtualEnvironment { + root_path, + base_executable_home_path, + include_system_site_packages, + implementation, + version, + } = self; + + let mut site_packages_directories = vec![site_packages_directory_from_sys_prefix( + root_path, + *version, + *implementation, + system, + )?]; + + if *include_system_site_packages { + let system_sys_prefix = + SysPrefixPath::from_executable_home_path(base_executable_home_path); + + // If we fail to resolve the `sys.prefix` path from the base executable home path, + // or if we fail to resolve the `site-packages` from the `sys.prefix` path, + // we should probably print a warning but *not* abort type checking + if let Some(sys_prefix_path) = system_sys_prefix { + match site_packages_directory_from_sys_prefix( + &sys_prefix_path, + *version, + *implementation, + system, + ) { + Ok(site_packages_directory) => { + site_packages_directories.push(site_packages_directory); + } + Err(error) => tracing::warn!( + "{error}. System site-packages will not be used for module resolution." + ), + } + } else { + tracing::warn!( + "Failed to resolve `sys.prefix` of the system Python installation \ +from the `home` value in the `pyvenv.cfg` file at `{}`. \ +System site-packages will not be used for module resolution.", + root_path.join("pyvenv.cfg") + ); + } + } + + tracing::debug!( + "Resolved site-packages directories for this virtual environment are: {site_packages_directories:?}" + ); + Ok(site_packages_directories) + } +} + +/// A Python environment that is _not_ a virtual environment. +/// +/// This environment may or may not be one that is managed by the operating system itself, e.g., +/// this captures both Homebrew-installed Python versions and the bundled macOS Python installation. +#[derive(Debug)] +pub(crate) struct SystemEnvironment { + root_path: SysPrefixPath, +} + +impl SystemEnvironment { + /// Create a new system environment from the given path. + /// + /// At this time, there is no eager validation and this is infallible. Instead, validation + /// will occur in [`site_packages_directory_from_sys_prefix`] — which will fail if there is not + /// a Python environment at the given path. + pub(crate) fn new(path: SysPrefixPath) -> Self { + Self { root_path: path } + } + + /// Return a list of `site-packages` directories that are available from this environment. + /// + /// See the documentation for [`site_packages_directory_from_sys_prefix`] for more details. + pub(crate) fn site_packages_directories( + &self, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Vec<SystemPathBuf>> { + let SystemEnvironment { root_path } = self; + + let site_packages_directories = vec![site_packages_directory_from_sys_prefix( + root_path, + None, + PythonImplementation::Unknown, + system, + )?]; + + tracing::debug!( + "Resolved site-packages directories for this environment are: {site_packages_directories:?}" + ); + Ok(site_packages_directories) + } +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum SitePackagesDiscoveryError { + #[error("Invalid {1}: `{0}` could not be canonicalized")] + EnvDirCanonicalizationError(SystemPathBuf, SysPrefixPathOrigin, #[source] io::Error), + #[error("Invalid {1}: `{0}` does not point to a directory on disk")] + EnvDirNotDirectory(SystemPathBuf, SysPrefixPathOrigin), + #[error("{0} points to a broken venv with no pyvenv.cfg file")] + NoPyvenvCfgFile(SysPrefixPathOrigin, #[source] io::Error), + #[error("Failed to parse the pyvenv.cfg file at {0} because {1}")] + PyvenvCfgParseError(SystemPathBuf, PyvenvCfgParseErrorKind), + #[error( + "Failed to search the `lib` directory of the Python installation at {1} for `site-packages`" + )] + CouldNotReadLibDirectory(#[source] io::Error, SysPrefixPath), + #[error("Could not find the `site-packages` directory for the Python installation at {0}")] + NoSitePackagesDirFound(SysPrefixPath), +} + +/// The various ways in which parsing a `pyvenv.cfg` file could fail +#[derive(Debug)] +pub(crate) enum PyvenvCfgParseErrorKind { + MalformedKeyValuePair { line_number: NonZeroUsize }, + NoHomeKey, + InvalidHomeValue(io::Error), +} + +impl fmt::Display for PyvenvCfgParseErrorKind { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Self::MalformedKeyValuePair { line_number } => write!( + f, + "line {line_number} has a malformed `<key> = <value>` pair" + ), + Self::NoHomeKey => f.write_str("the file does not have a `home` key"), + Self::InvalidHomeValue(io_err) => { + write!( + f, + "the following error was encountered \ +when trying to resolve the `home` value to a directory on disk: {io_err}" + ) + } + } + } +} + +/// Attempt to retrieve the `site-packages` directory +/// associated with a given Python installation. +/// +/// The location of the `site-packages` directory can vary according to the +/// Python version that this installation represents. The Python version may +/// or may not be known at this point, which is why the `python_version` +/// parameter is an `Option`. +fn site_packages_directory_from_sys_prefix( + sys_prefix_path: &SysPrefixPath, + python_version: Option<PythonVersion>, + implementation: PythonImplementation, + system: &dyn System, +) -> SitePackagesDiscoveryResult<SystemPathBuf> { + tracing::debug!("Searching for site-packages directory in {sys_prefix_path}"); + + if cfg!(target_os = "windows") { + let site_packages = sys_prefix_path.join(r"Lib\site-packages"); + return system + .is_directory(&site_packages) + .then_some(site_packages) + .ok_or(SitePackagesDiscoveryError::NoSitePackagesDirFound( + sys_prefix_path.to_owned(), + )); + } + + // In the Python standard library's `site.py` module (used for finding `site-packages` + // at runtime), we can find this in [the non-Windows branch]: + // + // ```py + // libdirs = [sys.platlibdir] + // if sys.platlibdir != "lib": + // libdirs.append("lib") + // ``` + // + // Pyright therefore searches for both a `lib/python3.X/site-packages` directory + // and a `lib64/python3.X/site-packages` directory on non-MacOS Unix systems, + // since `sys.platlibdir` can sometimes be equal to `"lib64"`. + // + // However, we only care about the `site-packages` directory insofar as it allows + // us to discover Python source code that can be used for inferring type + // information regarding third-party dependencies. That means that we don't need + // to care about any possible `lib64/site-packages` directories, since + // [the `sys`-module documentation] states that `sys.platlibdir` is *only* ever + // used for C extensions, never for pure-Python modules. + // + // [the non-Windows branch]: https://github.com/python/cpython/blob/a8be8fc6c4682089be45a87bd5ee1f686040116c/Lib/site.py#L401-L410 + // [the `sys`-module documentation]: https://docs.python.org/3/library/sys.html#sys.platlibdir + + // If we were able to figure out what Python version this installation is, + // we should be able to avoid iterating through all items in the `lib/` directory: + if let Some(expected_relative_path) = implementation.relative_site_packages_path(python_version) + { + let expected_absolute_path = sys_prefix_path.join(expected_relative_path); + if system.is_directory(&expected_absolute_path) { + return Ok(expected_absolute_path); + } + + // CPython free-threaded (3.13+) variant: pythonXYt + if matches!(implementation, PythonImplementation::CPython) + && python_version.is_some_and(PythonVersion::free_threaded_build_available) + { + let alternative_path = sys_prefix_path.join(format!( + "lib/python{}t/site-packages", + python_version.unwrap() + )); + if system.is_directory(&alternative_path) { + return Ok(alternative_path); + } + } + } + + // Either we couldn't figure out the version before calling this function + // (e.g., from a `pyvenv.cfg` file if this was a venv), + // or we couldn't find a `site-packages` folder at the expected location given + // the parsed version + // + // Note: the `python3.x` part of the `site-packages` path can't be computed from + // the `--python-version` the user has passed, as they might be running Python 3.12 locally + // even if they've requested that we type check their code "as if" they're running 3.8. + for entry_result in system + .read_directory(&sys_prefix_path.join("lib")) + .map_err(|io_err| { + SitePackagesDiscoveryError::CouldNotReadLibDirectory(io_err, sys_prefix_path.to_owned()) + })? + { + let Ok(entry) = entry_result else { + continue; + }; + + if !entry.file_type().is_directory() { + continue; + } + + let mut path = entry.into_path(); + + let name = path + .file_name() + .expect("File name to be non-null because path is guaranteed to be a child of `lib`"); + + if !(name.starts_with("python3.") || name.starts_with("pypy3.")) { + continue; + } + + path.push("site-packages"); + if system.is_directory(&path) { + return Ok(path); + } + } + Err(SitePackagesDiscoveryError::NoSitePackagesDirFound( + sys_prefix_path.to_owned(), + )) +} + +/// A path that represents the value of [`sys.prefix`] at runtime in Python +/// for a given Python executable. +/// +/// For the case of a virtual environment, where a +/// Python binary is at `/.venv/bin/python`, `sys.prefix` is the path to +/// the virtual environment the Python binary lies inside, i.e. `/.venv`, +/// and `site-packages` will be at `.venv/lib/python3.X/site-packages`. +/// System Python installations generally work the same way: if a system +/// Python installation lies at `/opt/homebrew/bin/python`, `sys.prefix` +/// will be `/opt/homebrew`, and `site-packages` will be at +/// `/opt/homebrew/lib/python3.X/site-packages`. +/// +/// [`sys.prefix`]: https://docs.python.org/3/library/sys.html#sys.prefix +#[derive(Debug, PartialEq, Eq, Clone)] +pub(crate) struct SysPrefixPath { + inner: SystemPathBuf, + origin: SysPrefixPathOrigin, +} + +impl SysPrefixPath { + fn new( + unvalidated_path: impl AsRef<SystemPath>, + origin: SysPrefixPathOrigin, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Self> { + Self::new_impl(unvalidated_path.as_ref(), origin, system) + } + + fn new_impl( + unvalidated_path: &SystemPath, + origin: SysPrefixPathOrigin, + system: &dyn System, + ) -> SitePackagesDiscoveryResult<Self> { + // It's important to resolve symlinks here rather than simply making the path absolute, + // since system Python installations often only put symlinks in the "expected" + // locations for `home` and `site-packages` + let canonicalized = system + .canonicalize_path(unvalidated_path) + .map_err(|io_err| { + SitePackagesDiscoveryError::EnvDirCanonicalizationError( + unvalidated_path.to_path_buf(), + origin, + io_err, + ) + })?; + system + .is_directory(&canonicalized) + .then_some(Self { + inner: canonicalized, + origin, + }) + .ok_or_else(|| { + SitePackagesDiscoveryError::EnvDirNotDirectory( + unvalidated_path.to_path_buf(), + origin, + ) + }) + } + + fn from_executable_home_path(path: &PythonHomePath) -> Option<Self> { + // No need to check whether `path.parent()` is a directory: + // the parent of a canonicalised path that is known to exist + // is guaranteed to be a directory. + if cfg!(target_os = "windows") { + Some(Self { + inner: path.to_path_buf(), + origin: SysPrefixPathOrigin::Derived, + }) + } else { + path.parent().map(|path| Self { + inner: path.to_path_buf(), + origin: SysPrefixPathOrigin::Derived, + }) + } + } +} + +impl Deref for SysPrefixPath { + type Target = SystemPath; + + fn deref(&self) -> &Self::Target { + &self.inner + } +} + +impl fmt::Display for SysPrefixPath { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "`sys.prefix` path `{}`", self.inner) + } +} + +#[derive(Debug, PartialEq, Eq, Copy, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] +pub enum SysPrefixPathOrigin { + PythonCliFlag, + VirtualEnvVar, + Derived, + LocalVenv, +} + +impl SysPrefixPathOrigin { + /// Whether the given `sys.prefix` path must be a virtual environment (rather than a system + /// Python environment). + pub(crate) fn must_be_virtual_env(self) -> bool { + match self { + Self::LocalVenv | Self::VirtualEnvVar => true, + Self::PythonCliFlag | Self::Derived => false, + } + } +} + +impl Display for SysPrefixPathOrigin { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::PythonCliFlag => f.write_str("`--python` argument"), + Self::VirtualEnvVar => f.write_str("`VIRTUAL_ENV` environment variable"), + Self::Derived => f.write_str("derived `sys.prefix` path"), + Self::LocalVenv => f.write_str("local virtual environment"), + } + } +} + +/// The value given by the `home` key in `pyvenv.cfg` files. +/// +/// This is equivalent to `{sys_prefix_path}/bin`, and points +/// to a directory in which a Python executable can be found. +/// Confusingly, it is *not* the same as the [`PYTHONHOME`] +/// environment variable that Python provides! However, it's +/// consistent among all mainstream creators of Python virtual +/// environments (the stdlib Python `venv` module, the third-party +/// `virtualenv` library, and `uv`), was specified by +/// [the original PEP adding the `venv` module], +/// and it's one of the few fields that's read by the Python +/// standard library's `site.py` module. +/// +/// Although it doesn't appear to be specified anywhere, +/// all existing virtual environment tools always use an absolute path +/// for the `home` value, and the Python standard library also assumes +/// that the `home` value will be an absolute path. +/// +/// Other values, such as the path to the Python executable or the +/// base-executable `sys.prefix` value, are either only provided in +/// `pyvenv.cfg` files by some virtual-environment creators, +/// or are included under different keys depending on which +/// virtual-environment creation tool you've used. +/// +/// [`PYTHONHOME`]: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONHOME +/// [the original PEP adding the `venv` module]: https://peps.python.org/pep-0405/ +#[derive(Debug, PartialEq, Eq)] +struct PythonHomePath(SystemPathBuf); + +impl PythonHomePath { + fn new(path: impl AsRef<SystemPath>, system: &dyn System) -> io::Result<Self> { + let path = path.as_ref(); + // It's important to resolve symlinks here rather than simply making the path absolute, + // since system Python installations often only put symlinks in the "expected" + // locations for `home` and `site-packages` + let canonicalized = system.canonicalize_path(path)?; + system + .is_directory(&canonicalized) + .then_some(Self(canonicalized)) + .ok_or_else(|| io::Error::other("not a directory")) + } +} + +impl Deref for PythonHomePath { + type Target = SystemPath; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl fmt::Display for PythonHomePath { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "`home` location `{}`", self.0) + } +} + +impl PartialEq<SystemPath> for PythonHomePath { + fn eq(&self, other: &SystemPath) -> bool { + &*self.0 == other + } +} + +impl PartialEq<SystemPathBuf> for PythonHomePath { + fn eq(&self, other: &SystemPathBuf) -> bool { + self == &**other + } +} + +#[cfg(test)] +mod tests { + use ruff_db::system::TestSystem; + + use super::*; + + impl PythonEnvironment { + fn expect_venv(self) -> VirtualEnvironment { + match self { + Self::Virtual(venv) => venv, + Self::System(_) => panic!("Expected a virtual environment"), + } + } + } + + struct VirtualEnvironmentTestCase { + system_site_packages: bool, + pyvenv_cfg_version_field: Option<&'static str>, + command_field: Option<&'static str>, + implementation_field: Option<&'static str>, + } + + struct PythonEnvironmentTestCase { + system: TestSystem, + minor_version: u8, + free_threaded: bool, + origin: SysPrefixPathOrigin, + virtual_env: Option<VirtualEnvironmentTestCase>, + } + + impl PythonEnvironmentTestCase { + /// Builds a mock environment, and returns the path to the environment root. + fn build(&self) -> SystemPathBuf { + let PythonEnvironmentTestCase { + system, + minor_version, + free_threaded, + origin: _, + virtual_env, + } = self; + let memory_fs = system.memory_file_system(); + let unix_site_packages = if *free_threaded { + format!("lib/python3.{minor_version}t/site-packages") + } else { + format!("lib/python3.{minor_version}/site-packages") + }; + + let system_install_sys_prefix = + SystemPathBuf::from(&*format!("/Python3.{minor_version}")); + let (system_home_path, system_exe_path, system_site_packages_path) = + if cfg!(target_os = "windows") { + let system_home_path = system_install_sys_prefix.clone(); + let system_exe_path = system_home_path.join("python.exe"); + let system_site_packages_path = + system_install_sys_prefix.join(r"Lib\site-packages"); + (system_home_path, system_exe_path, system_site_packages_path) + } else { + let system_home_path = system_install_sys_prefix.join("bin"); + let system_exe_path = system_home_path.join("python"); + let system_site_packages_path = + system_install_sys_prefix.join(&unix_site_packages); + (system_home_path, system_exe_path, system_site_packages_path) + }; + memory_fs.write_file_all(system_exe_path, "").unwrap(); + memory_fs + .create_directory_all(&system_site_packages_path) + .unwrap(); + + let Some(VirtualEnvironmentTestCase { + pyvenv_cfg_version_field, + system_site_packages, + command_field, + implementation_field, + }) = virtual_env + else { + return system_install_sys_prefix; + }; + + let venv_sys_prefix = SystemPathBuf::from("/.venv"); + let (venv_exe, site_packages_path) = if cfg!(target_os = "windows") { + ( + venv_sys_prefix.join(r"Scripts\python.exe"), + venv_sys_prefix.join(r"Lib\site-packages"), + ) + } else { + ( + venv_sys_prefix.join("bin/python"), + venv_sys_prefix.join(&unix_site_packages), + ) + }; + memory_fs.write_file_all(&venv_exe, "").unwrap(); + memory_fs.create_directory_all(&site_packages_path).unwrap(); + + let pyvenv_cfg_path = venv_sys_prefix.join("pyvenv.cfg"); + let mut pyvenv_cfg_contents = format!("home = {system_home_path}\n"); + if let Some(version_field) = pyvenv_cfg_version_field { + pyvenv_cfg_contents.push_str(version_field); + pyvenv_cfg_contents.push('\n'); + } + if let Some(command_field) = command_field { + pyvenv_cfg_contents.push_str(command_field); + pyvenv_cfg_contents.push('\n'); + } + if let Some(implementation_field) = implementation_field { + pyvenv_cfg_contents.push_str(implementation_field); + pyvenv_cfg_contents.push('\n'); + } + // Deliberately using weird casing here to test that our pyvenv.cfg parsing is case-insensitive: + if *system_site_packages { + pyvenv_cfg_contents.push_str("include-system-site-packages = TRuE\n"); + } + memory_fs + .write_file_all(pyvenv_cfg_path, &pyvenv_cfg_contents) + .unwrap(); + + venv_sys_prefix + } + + #[track_caller] + fn err(self) -> SitePackagesDiscoveryError { + PythonEnvironment::new(self.build(), self.origin, &self.system) + .expect_err("Expected environment construction to fail") + } + + #[track_caller] + fn run(self) -> PythonEnvironment { + let env_path = self.build(); + let env = PythonEnvironment::new(env_path.clone(), self.origin, &self.system) + .expect("Expected environment construction to succeed"); + + let expect_virtual_env = self.virtual_env.is_some(); + match &env { + PythonEnvironment::Virtual(venv) if expect_virtual_env => { + self.assert_virtual_environment(venv, &env_path); + } + PythonEnvironment::Virtual(venv) => { + panic!( + "Expected a system environment, but got a virtual environment: {venv:?}" + ); + } + PythonEnvironment::System(env) if !expect_virtual_env => { + self.assert_system_environment(env, &env_path); + } + PythonEnvironment::System(env) => { + panic!("Expected a virtual environment, but got a system environment: {env:?}"); + } + } + env + } + + fn assert_virtual_environment( + &self, + venv: &VirtualEnvironment, + expected_env_path: &SystemPathBuf, + ) { + let self_venv = self.virtual_env.as_ref().expect( + "`assert_virtual_environment` should only be used when `virtual_env` is populated", + ); + + assert_eq!( + venv.root_path, + SysPrefixPath { + inner: self.system.canonicalize_path(expected_env_path).unwrap(), + origin: self.origin, + } + ); + assert_eq!( + venv.include_system_site_packages, + self_venv.system_site_packages + ); + + if self_venv.pyvenv_cfg_version_field.is_some() { + assert_eq!( + venv.version, + Some(PythonVersion { + major: 3, + minor: self.minor_version + }) + ); + } else { + assert_eq!(venv.version, None); + } + + let expected_home = if cfg!(target_os = "windows") { + SystemPathBuf::from(&*format!(r"\Python3.{}", self.minor_version)) + } else { + SystemPathBuf::from(&*format!("/Python3.{}/bin", self.minor_version)) + }; + assert_eq!(venv.base_executable_home_path, expected_home); + + let site_packages_directories = venv.site_packages_directories(&self.system).unwrap(); + let expected_venv_site_packages = if cfg!(target_os = "windows") { + SystemPathBuf::from(r"\.venv\Lib\site-packages") + } else if self.free_threaded { + SystemPathBuf::from(&*format!( + "/.venv/lib/python3.{}t/site-packages", + self.minor_version + )) + } else { + SystemPathBuf::from(&*format!( + "/.venv/lib/python3.{}/site-packages", + self.minor_version + )) + }; + + let expected_system_site_packages = if cfg!(target_os = "windows") { + SystemPathBuf::from(&*format!( + r"\Python3.{}\Lib\site-packages", + self.minor_version + )) + } else if self.free_threaded { + SystemPathBuf::from(&*format!( + "/Python3.{minor_version}/lib/python3.{minor_version}t/site-packages", + minor_version = self.minor_version + )) + } else { + SystemPathBuf::from(&*format!( + "/Python3.{minor_version}/lib/python3.{minor_version}/site-packages", + minor_version = self.minor_version + )) + }; + + if self_venv.system_site_packages { + assert_eq!( + &site_packages_directories, + &[expected_venv_site_packages, expected_system_site_packages] + ); + } else { + assert_eq!(&site_packages_directories, &[expected_venv_site_packages]); + } + } + + fn assert_system_environment( + &self, + env: &SystemEnvironment, + expected_env_path: &SystemPathBuf, + ) { + assert!( + self.virtual_env.is_none(), + "`assert_system_environment` should only be used when `virtual_env` is not populated" + ); + + assert_eq!( + env.root_path, + SysPrefixPath { + inner: self.system.canonicalize_path(expected_env_path).unwrap(), + origin: self.origin, + } + ); + + let site_packages_directories = env.site_packages_directories(&self.system).unwrap(); + + let expected_site_packages = if cfg!(target_os = "windows") { + SystemPathBuf::from(&*format!( + r"\Python3.{}\Lib\site-packages", + self.minor_version + )) + } else if self.free_threaded { + SystemPathBuf::from(&*format!( + "/Python3.{minor_version}/lib/python3.{minor_version}t/site-packages", + minor_version = self.minor_version + )) + } else { + SystemPathBuf::from(&*format!( + "/Python3.{minor_version}/lib/python3.{minor_version}/site-packages", + minor_version = self.minor_version + )) + }; + + assert_eq!(&site_packages_directories, &[expected_site_packages]); + } + } + + #[test] + fn can_find_site_packages_directory_no_virtual_env() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 12, + free_threaded: false, + origin: SysPrefixPathOrigin::PythonCliFlag, + virtual_env: None, + }; + test.run(); + } + + #[test] + fn can_find_site_packages_directory_no_virtual_env_freethreaded() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::PythonCliFlag, + virtual_env: None, + }; + test.run(); + } + + #[test] + fn cannot_find_site_packages_directory_no_virtual_env_at_origin_virtual_env_var() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: false, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: None, + }; + let err = test.err(); + assert!( + matches!(err, SitePackagesDiscoveryError::NoPyvenvCfgFile(..)), + "Got {err:?}", + ); + } + + #[test] + fn cannot_find_site_packages_directory_no_virtual_env_at_origin_local_venv() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: false, + origin: SysPrefixPathOrigin::LocalVenv, + virtual_env: None, + }; + let err = test.err(); + assert!( + matches!(err, SitePackagesDiscoveryError::NoPyvenvCfgFile(..)), + "Got {err:?}", + ); + } + + #[test] + fn can_find_site_packages_directory_no_version_field_in_pyvenv_cfg() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 12, + free_threaded: false, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: false, + pyvenv_cfg_version_field: None, + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn can_find_site_packages_directory_venv_style_version_field_in_pyvenv_cfg() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 12, + free_threaded: false, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: false, + pyvenv_cfg_version_field: Some("version = 3.12"), + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn can_find_site_packages_directory_uv_style_version_field_in_pyvenv_cfg() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 12, + free_threaded: false, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: false, + pyvenv_cfg_version_field: Some("version_info = 3.12"), + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn can_find_site_packages_directory_virtualenv_style_version_field_in_pyvenv_cfg() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 12, + free_threaded: false, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: false, + pyvenv_cfg_version_field: Some("version_info = 3.12.0rc2"), + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn can_find_site_packages_directory_freethreaded_build() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: false, + pyvenv_cfg_version_field: Some("version_info = 3.13"), + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn finds_system_site_packages() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: Some("version_info = 3.13"), + command_field: None, + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn detects_pypy_implementation() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: None, + command_field: None, + implementation_field: Some("implementation = PyPy"), + }), + }; + let venv = test.run().expect_venv(); + assert_eq!(venv.implementation, PythonImplementation::PyPy); + } + + #[test] + fn detects_cpython_implementation() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: None, + command_field: None, + implementation_field: Some("implementation = CPython"), + }), + }; + let venv = test.run().expect_venv(); + assert_eq!(venv.implementation, PythonImplementation::CPython); + } + + #[test] + fn detects_graalpy_implementation() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: None, + command_field: None, + implementation_field: Some("implementation = GraalVM"), + }), + }; + let venv = test.run().expect_venv(); + assert_eq!(venv.implementation, PythonImplementation::GraalPy); + } + + #[test] + fn detects_unknown_implementation() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: None, + command_field: None, + implementation_field: None, + }), + }; + let venv = test.run().expect_venv(); + assert_eq!(venv.implementation, PythonImplementation::Unknown); + } + + #[test] + fn reject_env_that_does_not_exist() { + let system = TestSystem::default(); + assert!(matches!( + PythonEnvironment::new("/env", SysPrefixPathOrigin::PythonCliFlag, &system), + Err(SitePackagesDiscoveryError::EnvDirCanonicalizationError(..)) + )); + } + + #[test] + fn reject_env_that_is_not_a_directory() { + let system = TestSystem::default(); + system + .memory_file_system() + .write_file_all("/env", "") + .unwrap(); + assert!(matches!( + PythonEnvironment::new("/env", SysPrefixPathOrigin::PythonCliFlag, &system), + Err(SitePackagesDiscoveryError::EnvDirNotDirectory(..)) + )); + } + + #[test] + fn cannot_read_lib_directory() { + let system = TestSystem::default(); + system + .memory_file_system() + .create_directory_all("/env") + .unwrap(); + // Environment creation succeeds, but site-packages retrieval fails reading the `lib` + // directory + let env = + PythonEnvironment::new("/env", SysPrefixPathOrigin::PythonCliFlag, &system).unwrap(); + let site_packages = env.site_packages_directories(&system); + if cfg!(unix) { + assert!( + matches!( + site_packages, + Err(SitePackagesDiscoveryError::CouldNotReadLibDirectory(..)), + ), + "Got {site_packages:?}", + ); + } else { + // On Windows, we look for `Lib/site-packages` directly instead of listing the entries + // of `lib/...` — so we don't see the intermediate failure + assert!( + matches!( + site_packages, + Err(SitePackagesDiscoveryError::NoSitePackagesDirFound(..)), + ), + "Got {site_packages:?}", + ); + } + } + + #[test] + fn cannot_find_site_packages_directory() { + let system = TestSystem::default(); + if cfg!(unix) { + system + .memory_file_system() + .create_directory_all("/env/lib") + .unwrap(); + } else { + system + .memory_file_system() + .create_directory_all("/env/Lib") + .unwrap(); + } + // Environment creation succeeds, but site-packages retrieval fails + let env = + PythonEnvironment::new("/env", SysPrefixPathOrigin::PythonCliFlag, &system).unwrap(); + let site_packages = env.site_packages_directories(&system); + assert!( + matches!( + site_packages, + Err(SitePackagesDiscoveryError::NoSitePackagesDirFound(..)), + ), + "Got {site_packages:?}", + ); + } + + /// See <https://github.com/astral-sh/ty/issues/430> + #[test] + fn parsing_pyvenv_cfg_with_equals_in_value() { + let test = PythonEnvironmentTestCase { + system: TestSystem::default(), + minor_version: 13, + free_threaded: true, + origin: SysPrefixPathOrigin::VirtualEnvVar, + virtual_env: Some(VirtualEnvironmentTestCase { + system_site_packages: true, + pyvenv_cfg_version_field: Some("version_info = 3.13"), + command_field: Some( + r#"command = /.pyenv/versions/3.13.3/bin/python3.13 -m venv --without-pip --prompt="python-default/3.13.3" /somewhere-else/python/virtualenvs/python-default/3.13.3"#, + ), + implementation_field: None, + }), + }; + test.run(); + } + + #[test] + fn parsing_pyvenv_cfg_with_key_but_no_value_fails() { + let system = TestSystem::default(); + let memory_fs = system.memory_file_system(); + let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); + memory_fs + .write_file_all(&pyvenv_cfg_path, "home =") + .unwrap(); + let venv_result = + PythonEnvironment::new("/.venv", SysPrefixPathOrigin::VirtualEnvVar, &system); + assert!(matches!( + venv_result, + Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + path, + PyvenvCfgParseErrorKind::MalformedKeyValuePair { line_number } + )) + if path == pyvenv_cfg_path && Some(line_number) == NonZeroUsize::new(1) + )); + } + + #[test] + fn parsing_pyvenv_cfg_with_value_but_no_key_fails() { + let system = TestSystem::default(); + let memory_fs = system.memory_file_system(); + let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); + memory_fs + .write_file_all(&pyvenv_cfg_path, "= whatever") + .unwrap(); + let venv_result = + PythonEnvironment::new("/.venv", SysPrefixPathOrigin::VirtualEnvVar, &system); + assert!(matches!( + venv_result, + Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + path, + PyvenvCfgParseErrorKind::MalformedKeyValuePair { line_number } + )) + if path == pyvenv_cfg_path && Some(line_number) == NonZeroUsize::new(1) + )); + } + + #[test] + fn parsing_pyvenv_cfg_with_no_home_key_fails() { + let system = TestSystem::default(); + let memory_fs = system.memory_file_system(); + let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); + memory_fs.write_file_all(&pyvenv_cfg_path, "").unwrap(); + let venv_result = + PythonEnvironment::new("/.venv", SysPrefixPathOrigin::VirtualEnvVar, &system); + assert!(matches!( + venv_result, + Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + path, + PyvenvCfgParseErrorKind::NoHomeKey + )) + if path == pyvenv_cfg_path + )); + } + + #[test] + fn parsing_pyvenv_cfg_with_invalid_home_key_fails() { + let system = TestSystem::default(); + let memory_fs = system.memory_file_system(); + let pyvenv_cfg_path = SystemPathBuf::from("/.venv/pyvenv.cfg"); + memory_fs + .write_file_all(&pyvenv_cfg_path, "home = foo") + .unwrap(); + let venv_result = + PythonEnvironment::new("/.venv", SysPrefixPathOrigin::VirtualEnvVar, &system); + assert!(matches!( + venv_result, + Err(SitePackagesDiscoveryError::PyvenvCfgParseError( + path, + PyvenvCfgParseErrorKind::InvalidHomeValue(_) + )) + if path == pyvenv_cfg_path + )); + } +} diff --git a/crates/ty_python_semantic/src/suppression.rs b/crates/ty_python_semantic/src/suppression.rs new file mode 100644 index 0000000000000..51efb2c72d131 --- /dev/null +++ b/crates/ty_python_semantic/src/suppression.rs @@ -0,0 +1,1182 @@ +use crate::lint::{GetLintError, Level, LintMetadata, LintRegistry, LintStatus}; +use crate::types::TypeCheckDiagnostics; +use crate::{Db, declare_lint, lint::LintId}; +use ruff_db::diagnostic::{Annotation, Diagnostic, DiagnosticId, Span}; +use ruff_db::{files::File, parsed::parsed_module, source::source_text}; +use ruff_python_parser::TokenKind; +use ruff_python_trivia::Cursor; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use smallvec::{SmallVec, smallvec}; +use std::error::Error; +use std::fmt; +use std::fmt::Formatter; +use thiserror::Error; + +declare_lint! { + /// ## What it does + /// Checks for `type: ignore` or `ty: ignore` directives that are no longer applicable. + /// + /// ## Why is this bad? + /// A `type: ignore` directive that no longer matches any diagnostic violations is likely + /// included by mistake, and should be removed to avoid confusion. + /// + /// ## Examples + /// ```py + /// a = 20 / 2 # ty: ignore[division-by-zero] + /// ``` + /// + /// Use instead: + /// + /// ```py + /// a = 20 / 2 + /// ``` + pub(crate) static UNUSED_IGNORE_COMMENT = { + summary: "detects unused `type: ignore` comments", + status: LintStatus::preview("1.0.0"), + default_level: Level::Ignore, + } +} + +declare_lint! { + /// ## What it does + /// Checks for `ty: ignore[code]` where `code` isn't a known lint rule. + /// + /// ## Why is this bad? + /// A `ty: ignore[code]` directive with a `code` that doesn't match + /// any known rule will not suppress any type errors, and is probably a mistake. + /// + /// ## Examples + /// ```py + /// a = 20 / 0 # ty: ignore[division-by-zer] + /// ``` + /// + /// Use instead: + /// + /// ```py + /// a = 20 / 0 # ty: ignore[division-by-zero] + /// ``` + pub(crate) static UNKNOWN_RULE = { + summary: "detects `ty: ignore` comments that reference unknown rules", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks for `type: ignore` and `ty: ignore` comments that are syntactically incorrect. + /// + /// ## Why is this bad? + /// A syntactically incorrect ignore comment is probably a mistake and is useless. + /// + /// ## Examples + /// ```py + /// a = 20 / 0 # type: ignoree + /// ``` + /// + /// Use instead: + /// + /// ```py + /// a = 20 / 0 # type: ignore + /// ``` + pub(crate) static INVALID_IGNORE_COMMENT = { + summary: "detects ignore comments that use invalid syntax", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +#[salsa::tracked(returns(ref))] +pub(crate) fn suppressions(db: &dyn Db, file: File) -> Suppressions { + let parsed = parsed_module(db.upcast(), file); + let source = source_text(db.upcast(), file); + + let mut builder = SuppressionsBuilder::new(&source, db.lint_registry()); + let mut line_start = TextSize::default(); + + for token in parsed.tokens() { + if !token.kind().is_trivia() { + builder.set_seen_non_trivia_token(); + } + + match token.kind() { + TokenKind::Comment => { + let parser = SuppressionParser::new(&source, token.range()); + + for comment in parser { + match comment { + Ok(comment) => { + builder.add_comment(&comment, TextRange::new(line_start, token.end())); + } + Err(error) => match error.kind { + ParseErrorKind::NotASuppression + | ParseErrorKind::CommentWithoutHash => { + // Skip non suppression comments and comments that miss a hash (shouldn't ever happen) + } + ParseErrorKind::NoWhitespaceAfterIgnore(kind) + | ParseErrorKind::CodesMissingComma(kind) + | ParseErrorKind::InvalidCode(kind) + | ParseErrorKind::CodesMissingClosingBracket(kind) => { + builder.add_invalid_comment(kind, error); + } + }, + } + } + } + TokenKind::Newline | TokenKind::NonLogicalNewline => { + line_start = token.end(); + } + _ => {} + } + } + + builder.finish() +} + +pub(crate) fn check_suppressions(db: &dyn Db, file: File, diagnostics: &mut TypeCheckDiagnostics) { + let mut context = CheckSuppressionsContext::new(db, file, diagnostics); + + check_unknown_rule(&mut context); + check_invalid_suppression(&mut context); + check_unused_suppressions(&mut context); +} + +/// Checks for `ty: ignore` comments that reference unknown rules. +fn check_unknown_rule(context: &mut CheckSuppressionsContext) { + if context.is_lint_disabled(&UNKNOWN_RULE) { + return; + } + + for unknown in &context.suppressions.unknown { + match &unknown.reason { + GetLintError::Removed(removed) => { + context.report_lint( + &UNKNOWN_RULE, + unknown.range, + format_args!("Removed rule `{removed}`"), + ); + } + GetLintError::Unknown(rule) => { + context.report_lint( + &UNKNOWN_RULE, + unknown.range, + format_args!("Unknown rule `{rule}`"), + ); + } + + GetLintError::PrefixedWithCategory { + prefixed, + suggestion, + } => { + context.report_lint( + &UNKNOWN_RULE, + unknown.range, + format_args!("Unknown rule `{prefixed}`. Did you mean `{suggestion}`?"), + ); + } + } + } +} + +fn check_invalid_suppression(context: &mut CheckSuppressionsContext) { + if context.is_lint_disabled(&INVALID_IGNORE_COMMENT) { + return; + } + + for invalid in &context.suppressions.invalid { + context.report_lint( + &INVALID_IGNORE_COMMENT, + invalid.error.range, + format_args!( + "Invalid `{kind}` comment: {reason}", + kind = invalid.kind, + reason = &invalid.error + ), + ); + } +} + +/// Checks for unused suppression comments in `file` and +/// adds diagnostic for each of them to `diagnostics`. +/// +/// Does nothing if the [`UNUSED_IGNORE_COMMENT`] rule is disabled. +fn check_unused_suppressions(context: &mut CheckSuppressionsContext) { + if context.is_lint_disabled(&UNUSED_IGNORE_COMMENT) { + return; + } + + let all = context.suppressions; + let mut unused = Vec::with_capacity( + all.file + .len() + .saturating_add(all.line.len()) + .saturating_sub(context.diagnostics.used_len()), + ); + + // Collect all suppressions that are unused after type-checking. + for suppression in all { + if context.diagnostics.is_used(suppression.id()) { + continue; + } + + // `unused-ignore-comment` diagnostics can only be suppressed by specifying a + // code. This is necessary because every `type: ignore` would implicitly also + // suppress its own unused-ignore-comment diagnostic. + if let Some(unused_suppression) = all + .lint_suppressions(suppression.range, LintId::of(&UNUSED_IGNORE_COMMENT)) + .find(|unused_ignore_suppression| unused_ignore_suppression.target.is_lint()) + { + // A `unused-ignore-comment` suppression can't ignore itself. + // It can only ignore other suppressions. + if unused_suppression.id() != suppression.id() { + context.diagnostics.mark_used(unused_suppression.id()); + continue; + } + } + + unused.push(suppression); + } + + for suppression in unused { + // This looks silly but it's necessary to check again if a `unused-ignore-comment` is indeed unused + // in case the "unused" directive comes after it: + // ```py + // a = 10 / 2 # ty: ignore[unused-ignore-comment, division-by-zero] + // ``` + if context.diagnostics.is_used(suppression.id()) { + continue; + } + + match suppression.target { + SuppressionTarget::All => context.report_unchecked( + &UNUSED_IGNORE_COMMENT, + suppression.range, + format_args!("Unused blanket `{}` directive", suppression.kind), + ), + SuppressionTarget::Lint(lint) => context.report_unchecked( + &UNUSED_IGNORE_COMMENT, + suppression.range, + format_args!( + "Unused `{kind}` directive: '{code}'", + kind = suppression.kind, + code = lint.name() + ), + ), + SuppressionTarget::Empty => context.report_unchecked( + &UNUSED_IGNORE_COMMENT, + suppression.range, + format_args!("Unused `{kind}` without a code", kind = suppression.kind), + ), + } + } +} + +struct CheckSuppressionsContext<'a> { + db: &'a dyn Db, + file: File, + suppressions: &'a Suppressions, + diagnostics: &'a mut TypeCheckDiagnostics, +} + +impl<'a> CheckSuppressionsContext<'a> { + fn new(db: &'a dyn Db, file: File, diagnostics: &'a mut TypeCheckDiagnostics) -> Self { + let suppressions = suppressions(db, file); + Self { + db, + file, + suppressions, + diagnostics, + } + } + + fn is_lint_disabled(&self, lint: &'static LintMetadata) -> bool { + !self.db.rule_selection().is_enabled(LintId::of(lint)) + } + + fn report_lint( + &mut self, + lint: &'static LintMetadata, + range: TextRange, + message: fmt::Arguments, + ) { + if let Some(suppression) = self.suppressions.find_suppression(range, LintId::of(lint)) { + self.diagnostics.mark_used(suppression.id()); + return; + } + + self.report_unchecked(lint, range, message); + } + + /// Reports a diagnostic without checking if the lint at the given range is suppressed or marking + /// the suppression as used. + fn report_unchecked( + &mut self, + lint: &'static LintMetadata, + range: TextRange, + message: fmt::Arguments, + ) { + let Some(severity) = self.db.rule_selection().severity(LintId::of(lint)) else { + return; + }; + + let id = DiagnosticId::Lint(lint.name()); + let mut diag = Diagnostic::new(id, severity, ""); + let span = Span::from(self.file).with_range(range); + diag.annotate(Annotation::primary(span).message(message)); + self.diagnostics.push(diag); + } +} + +/// The suppressions of a single file. +#[derive(Debug, Eq, PartialEq)] +pub(crate) struct Suppressions { + /// Suppressions that apply to the entire file. + /// + /// The suppressions are sorted by [`Suppression::comment_range`] and the [`Suppression::suppressed_range`] + /// spans the entire file. + /// + /// For now, this is limited to `type: ignore` comments. + file: SmallVec<[Suppression; 1]>, + + /// Suppressions that apply to a specific line (or lines). + /// + /// Comments with multiple codes create multiple [`Suppression`]s that all share the same [`Suppression::comment_range`]. + /// + /// The suppressions are sorted by [`Suppression::range`] (which implies [`Suppression::comment_range`]). + line: Vec<Suppression>, + + /// Suppressions with lint codes that are unknown. + unknown: Vec<UnknownSuppression>, + + /// Suppressions that are syntactically invalid. + invalid: Vec<InvalidSuppression>, +} + +impl Suppressions { + pub(crate) fn find_suppression(&self, range: TextRange, id: LintId) -> Option<&Suppression> { + self.lint_suppressions(range, id).next() + } + + /// Returns all suppressions for the given lint + fn lint_suppressions( + &self, + range: TextRange, + id: LintId, + ) -> impl Iterator<Item = &Suppression> + '_ { + self.file + .iter() + .chain(self.line_suppressions(range)) + .filter(move |suppression| suppression.matches(id)) + } + + /// Returns the line-level suppressions that apply for `range`. + /// + /// A suppression applies for the given range if it contains the range's + /// start or end offset. This means the suppression is on the same line + /// as the diagnostic's start or end. + fn line_suppressions(&self, range: TextRange) -> impl Iterator<Item = &Suppression> + '_ { + // First find the index of the suppression comment that ends right before the range + // starts. This allows us to skip suppressions that are not relevant for the range. + let end_offset = self + .line + .binary_search_by_key(&range.start(), |suppression| { + suppression.suppressed_range.end() + }) + .unwrap_or_else(|index| index); + + // From here, search the remaining suppression comments for one that + // contains the range's start or end offset. Stop the search + // as soon as the suppression's range and the range no longer overlap. + self.line[end_offset..] + .iter() + // Stop searching if the suppression starts after the range we're looking for. + .take_while(move |suppression| range.end() >= suppression.suppressed_range.start()) + .filter(move |suppression| { + // Don't use intersect to avoid that suppressions on inner-expression + // ignore errors for outer expressions + suppression.suppressed_range.contains(range.start()) + || suppression.suppressed_range.contains(range.end()) + }) + } + + fn iter(&self) -> SuppressionsIter { + self.file.iter().chain(&self.line) + } +} + +pub(crate) type SuppressionsIter<'a> = + std::iter::Chain<std::slice::Iter<'a, Suppression>, std::slice::Iter<'a, Suppression>>; + +impl<'a> IntoIterator for &'a Suppressions { + type Item = &'a Suppression; + type IntoIter = SuppressionsIter<'a>; + + fn into_iter(self) -> Self::IntoIter { + self.iter() + } +} + +/// A `type: ignore` or `ty: ignore` suppression. +/// +/// Suppression comments that suppress multiple codes +/// create multiple suppressions: one for every code. +/// They all share the same `comment_range`. +#[derive(Clone, Debug, Eq, PartialEq)] +pub(crate) struct Suppression { + target: SuppressionTarget, + kind: SuppressionKind, + + /// The range of this specific suppression. + /// This is the same as `comment_range` except for suppression comments that suppress multiple + /// codes. For those, the range is limited to the specific code. + range: TextRange, + + /// The range of the suppression comment. + comment_range: TextRange, + + /// The range for which this suppression applies. + /// Most of the time, this is the range of the comment's line. + /// However, there are few cases where the range gets expanded to + /// cover multiple lines: + /// * multiline strings: `expr + """multiline\nstring""" # type: ignore` + /// * line continuations: `expr \ + "test" # type: ignore` + suppressed_range: TextRange, +} + +impl Suppression { + fn matches(&self, tested_id: LintId) -> bool { + match self.target { + SuppressionTarget::All => true, + SuppressionTarget::Lint(suppressed_id) => tested_id == suppressed_id, + SuppressionTarget::Empty => false, + } + } + + pub(crate) fn id(&self) -> FileSuppressionId { + FileSuppressionId(self.range) + } +} + +/// Unique ID for a suppression in a file. +/// +/// ## Implementation +/// The wrapped `TextRange` is the suppression's range. +/// This is unique enough because it is its exact +/// location in the source. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)] +pub(crate) struct FileSuppressionId(TextRange); + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +enum SuppressionTarget { + /// Suppress all lints + All, + + /// Suppress the lint with the given id + Lint(LintId), + + /// Suppresses no lint, e.g. `ty: ignore[]` + Empty, +} + +impl SuppressionTarget { + const fn is_lint(self) -> bool { + matches!(self, SuppressionTarget::Lint(_)) + } +} + +struct SuppressionsBuilder<'a> { + lint_registry: &'a LintRegistry, + source: &'a str, + + /// `type: ignore` comments at the top of the file before any non-trivia code apply to the entire file. + /// This boolean tracks if there has been any non trivia token. + seen_non_trivia_token: bool, + + line: Vec<Suppression>, + file: SmallVec<[Suppression; 1]>, + unknown: Vec<UnknownSuppression>, + invalid: Vec<InvalidSuppression>, +} + +impl<'a> SuppressionsBuilder<'a> { + fn new(source: &'a str, lint_registry: &'a LintRegistry) -> Self { + Self { + source, + lint_registry, + seen_non_trivia_token: false, + line: Vec::new(), + file: SmallVec::new(), + unknown: Vec::new(), + invalid: Vec::new(), + } + } + + fn set_seen_non_trivia_token(&mut self) { + self.seen_non_trivia_token = true; + } + + fn finish(mut self) -> Suppressions { + self.line.shrink_to_fit(); + self.file.shrink_to_fit(); + self.unknown.shrink_to_fit(); + self.invalid.shrink_to_fit(); + + Suppressions { + file: self.file, + line: self.line, + unknown: self.unknown, + invalid: self.invalid, + } + } + + fn add_comment(&mut self, comment: &SuppressionComment, line_range: TextRange) { + // `type: ignore` comments at the start of the file apply to the entire range. + // > A # type: ignore comment on a line by itself at the top of a file, before any docstrings, + // > imports, or other executable code, silences all errors in the file. + // > Blank lines and other comments, such as shebang lines and coding cookies, + // > may precede the # type: ignore comment. + // > https://typing.python.org/en/latest/spec/directives.html#type-ignore-comments + let is_file_suppression = comment.kind.is_type_ignore() && !self.seen_non_trivia_token; + + let suppressed_range = if is_file_suppression { + TextRange::new(0.into(), self.source.text_len()) + } else { + line_range + }; + + let mut push_type_ignore_suppression = |suppression: Suppression| { + if is_file_suppression { + self.file.push(suppression); + } else { + self.line.push(suppression); + } + }; + + match comment.codes.as_deref() { + // `type: ignore` + None => { + push_type_ignore_suppression(Suppression { + target: SuppressionTarget::All, + kind: comment.kind, + comment_range: comment.range, + range: comment.range, + suppressed_range, + }); + } + + // `type: ignore[..]` + // The suppression applies to all lints if it is a `type: ignore` + // comment. `type: ignore` apply to all lints for better mypy compatibility. + Some(_) if comment.kind.is_type_ignore() => { + push_type_ignore_suppression(Suppression { + target: SuppressionTarget::All, + kind: comment.kind, + comment_range: comment.range, + range: comment.range, + suppressed_range, + }); + } + + // `ty: ignore[]` + Some([]) => { + self.line.push(Suppression { + target: SuppressionTarget::Empty, + kind: comment.kind, + range: comment.range, + comment_range: comment.range, + suppressed_range, + }); + } + + // `ty: ignore[a, b]` + Some(codes) => { + for code_range in codes { + let code = &self.source[*code_range]; + let range = if codes.len() == 1 { + comment.range + } else { + *code_range + }; + + match self.lint_registry.get(code) { + Ok(lint) => { + self.line.push(Suppression { + target: SuppressionTarget::Lint(lint), + kind: comment.kind, + range, + comment_range: comment.range, + suppressed_range, + }); + } + Err(error) => self.unknown.push(UnknownSuppression { + range, + comment_range: comment.range, + reason: error, + }), + } + } + } + } + } + + fn add_invalid_comment(&mut self, kind: SuppressionKind, error: ParseError) { + self.invalid.push(InvalidSuppression { kind, error }); + } +} + +/// Suppression for an unknown lint rule. +#[derive(Debug, PartialEq, Eq)] +struct UnknownSuppression { + /// The range of the code. + range: TextRange, + + /// The range of the suppression comment + comment_range: TextRange, + + reason: GetLintError, +} + +#[derive(Debug, PartialEq, Eq)] +struct InvalidSuppression { + kind: SuppressionKind, + error: ParseError, +} + +struct SuppressionParser<'src> { + cursor: Cursor<'src>, + range: TextRange, +} + +impl<'src> SuppressionParser<'src> { + fn new(source: &'src str, range: TextRange) -> Self { + let cursor = Cursor::new(&source[range]); + + Self { cursor, range } + } + + fn parse_comment(&mut self) -> Result<SuppressionComment, ParseError> { + let comment_start = self.offset(); + self.cursor.start_token(); + + if !self.cursor.eat_char('#') { + return self.syntax_error(ParseErrorKind::CommentWithoutHash); + } + + self.eat_whitespace(); + + // type: ignore[code] + // ^^^^^^^^^^^^ + let Some(kind) = self.eat_kind() else { + return Err(ParseError::new( + ParseErrorKind::NotASuppression, + TextRange::new(comment_start, self.offset()), + )); + }; + + let has_trailing_whitespace = self.eat_whitespace(); + + // type: ignore[code1, code2] + // ^^^^^^ + let codes = self.eat_codes(kind)?; + + if self.cursor.is_eof() || codes.is_some() || has_trailing_whitespace { + // Consume the comment until its end or until the next "sub-comment" starts. + self.cursor.eat_while(|c| c != '#'); + Ok(SuppressionComment { + kind, + codes, + range: TextRange::at(comment_start, self.cursor.token_len()), + }) + } else { + self.syntax_error(ParseErrorKind::NoWhitespaceAfterIgnore(kind)) + } + } + + fn eat_kind(&mut self) -> Option<SuppressionKind> { + let kind = if self.cursor.as_str().starts_with("type") { + SuppressionKind::TypeIgnore + } else if self.cursor.as_str().starts_with("ty") { + SuppressionKind::Ty + } else { + return None; + }; + + self.cursor.skip_bytes(kind.len_utf8()); + + self.eat_whitespace(); + + if !self.cursor.eat_char(':') { + return None; + } + + self.eat_whitespace(); + + if !self.cursor.as_str().starts_with("ignore") { + return None; + } + + self.cursor.skip_bytes("ignore".len()); + + Some(kind) + } + + fn eat_codes( + &mut self, + kind: SuppressionKind, + ) -> Result<Option<SmallVec<[TextRange; 2]>>, ParseError> { + if !self.cursor.eat_char('[') { + return Ok(None); + } + + let mut codes: SmallVec<[TextRange; 2]> = smallvec![]; + + loop { + if self.cursor.is_eof() { + return self.syntax_error(ParseErrorKind::CodesMissingClosingBracket(kind)); + } + + self.eat_whitespace(); + + // `ty: ignore[]` or `ty: ignore[a,]` + if self.cursor.eat_char(']') { + break Ok(Some(codes)); + } + + let code_start = self.offset(); + if !self.eat_word() { + return self.syntax_error(ParseErrorKind::InvalidCode(kind)); + } + + codes.push(TextRange::new(code_start, self.offset())); + + self.eat_whitespace(); + + if !self.cursor.eat_char(',') { + self.eat_whitespace(); + + if self.cursor.eat_char(']') { + break Ok(Some(codes)); + } + // `ty: ignore[a b] + return self.syntax_error(ParseErrorKind::CodesMissingComma(kind)); + } + } + } + + fn eat_whitespace(&mut self) -> bool { + if self.cursor.eat_if(char::is_whitespace) { + self.cursor.eat_while(char::is_whitespace); + true + } else { + false + } + } + + fn eat_word(&mut self) -> bool { + if self.cursor.eat_if(char::is_alphabetic) { + // Allow `:` for better error recovery when someone uses `lint:code` instead of just `code`. + self.cursor + .eat_while(|c| c.is_alphanumeric() || matches!(c, '_' | '-' | ':')); + true + } else { + false + } + } + + fn syntax_error<T>(&self, kind: ParseErrorKind) -> Result<T, ParseError> { + let len = if self.cursor.is_eof() { + TextSize::default() + } else { + self.cursor.first().text_len() + }; + + Err(ParseError::new(kind, TextRange::at(self.offset(), len))) + } + + fn offset(&self) -> TextSize { + self.range.start() + self.range.len() - self.cursor.text_len() + } +} + +impl Iterator for SuppressionParser<'_> { + type Item = Result<SuppressionComment, ParseError>; + + fn next(&mut self) -> Option<Self::Item> { + if self.cursor.is_eof() { + return None; + } + + match self.parse_comment() { + Ok(result) => Some(Ok(result)), + Err(error) => { + self.cursor.eat_while(|c| c != '#'); + Some(Err(error)) + } + } + } +} + +/// A single parsed suppression comment. +#[derive(Clone, Debug, Eq, PartialEq)] +struct SuppressionComment { + /// The range of the suppression comment. + /// + /// This can be a sub-range of the comment token if the comment token contains multiple `#` tokens: + /// ```py + /// # fmt: off # type: ignore + /// ^^^^^^^^^^^^^^ + /// ``` + range: TextRange, + + kind: SuppressionKind, + + /// The ranges of the codes in the optional `[...]`. + /// `None` for comments that don't specify any code. + /// + /// ```py + /// # type: ignore[unresolved-reference, invalid-exception-caught] + /// ^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^ + /// ``` + codes: Option<SmallVec<[TextRange; 2]>>, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +enum SuppressionKind { + TypeIgnore, + Ty, +} + +impl SuppressionKind { + const fn is_type_ignore(self) -> bool { + matches!(self, SuppressionKind::TypeIgnore) + } + + fn len_utf8(self) -> usize { + match self { + SuppressionKind::TypeIgnore => "type".len(), + SuppressionKind::Ty => "ty".len(), + } + } +} + +impl fmt::Display for SuppressionKind { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self { + SuppressionKind::TypeIgnore => f.write_str("type: ignore"), + SuppressionKind::Ty => f.write_str("ty: ignore"), + } + } +} + +#[derive(Debug, Eq, PartialEq, Clone)] +struct ParseError { + kind: ParseErrorKind, + + /// The position/range at which the parse error occurred. + range: TextRange, +} + +impl ParseError { + fn new(kind: ParseErrorKind, range: TextRange) -> Self { + Self { kind, range } + } +} + +impl fmt::Display for ParseError { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + self.kind.fmt(f) + } +} + +impl Error for ParseError {} + +#[derive(Debug, Eq, PartialEq, Clone, Error)] +enum ParseErrorKind { + /// The comment isn't a suppression comment. + #[error("not a suppression comment")] + NotASuppression, + + #[error("the comment doesn't start with a `#`")] + CommentWithoutHash, + + /// A valid suppression `type: ignore` but it misses a whitespaces after the `ignore` keyword. + /// + /// ```py + /// type: ignoree + /// ``` + #[error("no whitespace after `ignore`")] + NoWhitespaceAfterIgnore(SuppressionKind), + + /// Missing comma between two codes + #[error("expected a comma separating the rule codes")] + CodesMissingComma(SuppressionKind), + + /// `ty: ignore[*.*]` + #[error("expected a alphanumeric character or `-` or `_` as code")] + InvalidCode(SuppressionKind), + + /// `ty: ignore[a, b` + #[error("expected a closing bracket")] + CodesMissingClosingBracket(SuppressionKind), +} + +#[cfg(test)] +mod tests { + use crate::suppression::{SuppressionComment, SuppressionParser}; + use insta::assert_debug_snapshot; + use ruff_text_size::{TextLen, TextRange}; + use std::fmt; + use std::fmt::Formatter; + + #[test] + fn type_ignore_no_codes() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore", + kind: TypeIgnore, + codes: [], + }, + ] + "## + ); + } + + #[test] + fn type_ignore_explanation() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore I tried but couldn't figure out the proper type", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore I tried but couldn't figure out the proper type", + kind: TypeIgnore, + codes: [], + }, + ] + "## + ); + } + + #[test] + fn fmt_comment_before_type_ignore() { + assert_debug_snapshot!( + SuppressionComments::new( + "# fmt: off # type: ignore", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore", + kind: TypeIgnore, + codes: [], + }, + ] + "## + ); + } + + #[test] + fn type_ignore_before_fmt_off() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore # fmt: off", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore ", + kind: TypeIgnore, + codes: [], + }, + ] + "## + ); + } + + #[test] + fn multiple_type_ignore_comments() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore[a] # type: ignore[b]", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore[a] ", + kind: TypeIgnore, + codes: [ + "a", + ], + }, + SuppressionComment { + text: "# type: ignore[b]", + kind: TypeIgnore, + codes: [ + "b", + ], + }, + ] + "## + ); + } + + #[test] + fn invalid_type_ignore_valid_type_ignore() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore[a # type: ignore[b]", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore[b]", + kind: TypeIgnore, + codes: [ + "b", + ], + }, + ] + "## + ); + } + + #[test] + fn valid_type_ignore_invalid_type_ignore() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore[a] # type: ignoreeee", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore[a] ", + kind: TypeIgnore, + codes: [ + "a", + ], + }, + ] + "## + ); + } + + #[test] + fn type_ignore_multiple_codes() { + assert_debug_snapshot!( + SuppressionComments::new( + "# type: ignore[invalid-exception-raised, invalid-exception-caught]", + ), + @r##" + [ + SuppressionComment { + text: "# type: ignore[invalid-exception-raised, invalid-exception-caught]", + kind: TypeIgnore, + codes: [ + "invalid-exception-raised", + "invalid-exception-caught", + ], + }, + ] + "## + ); + } + + #[test] + fn type_ignore_single_code() { + assert_debug_snapshot!( + SuppressionComments::new("# type: ignore[invalid-exception-raised]",), + @r##" + [ + SuppressionComment { + text: "# type: ignore[invalid-exception-raised]", + kind: TypeIgnore, + codes: [ + "invalid-exception-raised", + ], + }, + ] + "## + ); + } + + struct SuppressionComments<'a> { + source: &'a str, + } + + impl<'a> SuppressionComments<'a> { + fn new(source: &'a str) -> Self { + Self { source } + } + } + + impl fmt::Debug for SuppressionComments<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let mut list = f.debug_list(); + + for comment in SuppressionParser::new( + self.source, + TextRange::new(0.into(), self.source.text_len()), + ) + .flatten() + { + list.entry(&comment.debug(self.source)); + } + + list.finish() + } + } + + impl SuppressionComment { + fn debug<'a>(&'a self, source: &'a str) -> DebugSuppressionComment<'a> { + DebugSuppressionComment { + source, + comment: self, + } + } + } + + struct DebugSuppressionComment<'a> { + source: &'a str, + comment: &'a SuppressionComment, + } + + impl fmt::Debug for DebugSuppressionComment<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + struct DebugCodes<'a> { + source: &'a str, + codes: &'a [TextRange], + } + + impl fmt::Debug for DebugCodes<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let mut f = f.debug_list(); + + for code in self.codes { + f.entry(&&self.source[*code]); + } + + f.finish() + } + } + + f.debug_struct("SuppressionComment") + .field("text", &&self.source[self.comment.range]) + .field("kind", &self.comment.kind) + .field( + "codes", + &DebugCodes { + source: self.source, + codes: self.comment.codes.as_deref().unwrap_or_default(), + }, + ) + .finish() + } + } +} diff --git a/crates/ty_python_semantic/src/symbol.rs b/crates/ty_python_semantic/src/symbol.rs new file mode 100644 index 0000000000000..8e20a08954fe9 --- /dev/null +++ b/crates/ty_python_semantic/src/symbol.rs @@ -0,0 +1,1232 @@ +use ruff_db::files::File; + +use crate::dunder_all::dunder_all_names; +use crate::module_resolver::file_to_module; +use crate::semantic_index::definition::Definition; +use crate::semantic_index::symbol::{ScopeId, ScopedSymbolId}; +use crate::semantic_index::{ + BindingWithConstraints, BindingWithConstraintsIterator, DeclarationsIterator, symbol_table, +}; +use crate::semantic_index::{DeclarationWithConstraint, global_scope, use_def_map}; +use crate::types::{ + KnownClass, Truthiness, Type, TypeAndQualifiers, TypeQualifiers, UnionBuilder, UnionType, + binding_type, declaration_type, todo_type, +}; +use crate::{Db, KnownModule, Program, resolve_module}; + +pub(crate) use implicit_globals::{ + module_type_implicit_global_declaration, module_type_implicit_global_symbol, +}; + +#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)] +pub(crate) enum Boundness { + Bound, + PossiblyUnbound, +} + +impl Boundness { + pub(crate) const fn max(self, other: Self) -> Self { + match (self, other) { + (Boundness::Bound, _) | (_, Boundness::Bound) => Boundness::Bound, + (Boundness::PossiblyUnbound, Boundness::PossiblyUnbound) => Boundness::PossiblyUnbound, + } + } +} + +/// The result of a symbol lookup, which can either be a (possibly unbound) type +/// or a completely unbound symbol. +/// +/// Consider this example: +/// ```py +/// bound = 1 +/// +/// if flag: +/// possibly_unbound = 2 +/// ``` +/// +/// If we look up symbols in this scope, we would get the following results: +/// ```rs +/// bound: Symbol::Type(Type::IntLiteral(1), Boundness::Bound), +/// possibly_unbound: Symbol::Type(Type::IntLiteral(2), Boundness::PossiblyUnbound), +/// non_existent: Symbol::Unbound, +/// ``` +#[derive(Debug, Clone, PartialEq, Eq, salsa::Update)] +pub(crate) enum Symbol<'db> { + Type(Type<'db>, Boundness), + Unbound, +} + +impl<'db> Symbol<'db> { + /// Constructor that creates a `Symbol` with boundness [`Boundness::Bound`]. + pub(crate) fn bound(ty: impl Into<Type<'db>>) -> Self { + Symbol::Type(ty.into(), Boundness::Bound) + } + + pub(crate) fn possibly_unbound(ty: impl Into<Type<'db>>) -> Self { + Symbol::Type(ty.into(), Boundness::PossiblyUnbound) + } + + /// Constructor that creates a [`Symbol`] with a [`crate::types::TodoType`] type + /// and boundness [`Boundness::Bound`]. + #[allow(unused_variables)] // Only unused in release builds + pub(crate) fn todo(message: &'static str) -> Self { + Symbol::Type(todo_type!(message), Boundness::Bound) + } + + pub(crate) fn is_unbound(&self) -> bool { + matches!(self, Symbol::Unbound) + } + + /// Returns the type of the symbol, ignoring possible unboundness. + /// + /// If the symbol is *definitely* unbound, this function will return `None`. Otherwise, + /// if there is at least one control-flow path where the symbol is bound, return the type. + pub(crate) fn ignore_possibly_unbound(&self) -> Option<Type<'db>> { + match self { + Symbol::Type(ty, _) => Some(*ty), + Symbol::Unbound => None, + } + } + + #[cfg(test)] + #[track_caller] + pub(crate) fn expect_type(self) -> Type<'db> { + self.ignore_possibly_unbound() + .expect("Expected a (possibly unbound) type, not an unbound symbol") + } + + #[must_use] + pub(crate) fn map_type(self, f: impl FnOnce(Type<'db>) -> Type<'db>) -> Symbol<'db> { + match self { + Symbol::Type(ty, boundness) => Symbol::Type(f(ty), boundness), + Symbol::Unbound => Symbol::Unbound, + } + } + + #[must_use] + pub(crate) fn with_qualifiers(self, qualifiers: TypeQualifiers) -> SymbolAndQualifiers<'db> { + SymbolAndQualifiers { + symbol: self, + qualifiers, + } + } + + /// Try to call `__get__(None, owner)` on the type of this symbol (not on the meta type). + /// If it succeeds, return the `__get__` return type. Otherwise, returns the original symbol. + /// This is used to resolve (potential) descriptor attributes. + pub(crate) fn try_call_dunder_get(self, db: &'db dyn Db, owner: Type<'db>) -> Symbol<'db> { + match self { + Symbol::Type(Type::Union(union), boundness) => union.map_with_boundness(db, |elem| { + Symbol::Type(*elem, boundness).try_call_dunder_get(db, owner) + }), + + Symbol::Type(Type::Intersection(intersection), boundness) => intersection + .map_with_boundness(db, |elem| { + Symbol::Type(*elem, boundness).try_call_dunder_get(db, owner) + }), + + Symbol::Type(self_ty, boundness) => { + if let Some((dunder_get_return_ty, _)) = + self_ty.try_call_dunder_get(db, Type::none(db), owner) + { + Symbol::Type(dunder_get_return_ty, boundness) + } else { + self + } + } + + Symbol::Unbound => Symbol::Unbound, + } + } +} + +impl<'db> From<LookupResult<'db>> for SymbolAndQualifiers<'db> { + fn from(value: LookupResult<'db>) -> Self { + match value { + Ok(type_and_qualifiers) => { + Symbol::Type(type_and_qualifiers.inner_type(), Boundness::Bound) + .with_qualifiers(type_and_qualifiers.qualifiers()) + } + Err(LookupError::Unbound(qualifiers)) => Symbol::Unbound.with_qualifiers(qualifiers), + Err(LookupError::PossiblyUnbound(type_and_qualifiers)) => { + Symbol::Type(type_and_qualifiers.inner_type(), Boundness::PossiblyUnbound) + .with_qualifiers(type_and_qualifiers.qualifiers()) + } + } + } +} + +/// Possible ways in which a symbol lookup can (possibly or definitely) fail. +#[derive(Copy, Clone, PartialEq, Eq, Debug)] +pub(crate) enum LookupError<'db> { + Unbound(TypeQualifiers), + PossiblyUnbound(TypeAndQualifiers<'db>), +} + +impl<'db> LookupError<'db> { + /// Fallback (wholly or partially) to `fallback` to create a new [`LookupResult`]. + pub(crate) fn or_fall_back_to( + self, + db: &'db dyn Db, + fallback: SymbolAndQualifiers<'db>, + ) -> LookupResult<'db> { + let fallback = fallback.into_lookup_result(); + match (&self, &fallback) { + (LookupError::Unbound(_), _) => fallback, + (LookupError::PossiblyUnbound { .. }, Err(LookupError::Unbound(_))) => Err(self), + (LookupError::PossiblyUnbound(ty), Ok(ty2)) => Ok(TypeAndQualifiers::new( + UnionType::from_elements(db, [ty.inner_type(), ty2.inner_type()]), + ty.qualifiers().union(ty2.qualifiers()), + )), + (LookupError::PossiblyUnbound(ty), Err(LookupError::PossiblyUnbound(ty2))) => { + Err(LookupError::PossiblyUnbound(TypeAndQualifiers::new( + UnionType::from_elements(db, [ty.inner_type(), ty2.inner_type()]), + ty.qualifiers().union(ty2.qualifiers()), + ))) + } + } + } +} + +/// A [`Result`] type in which the `Ok` variant represents a definitely bound symbol +/// and the `Err` variant represents a symbol that is either definitely or possibly unbound. +/// +/// Note that this type is exactly isomorphic to [`Symbol`]. +/// In the future, we could possibly consider removing `Symbol` and using this type everywhere instead. +pub(crate) type LookupResult<'db> = Result<TypeAndQualifiers<'db>, LookupError<'db>>; + +/// Infer the public type of a symbol (its type as seen from outside its scope) in the given +/// `scope`. +pub(crate) fn symbol<'db>( + db: &'db dyn Db, + scope: ScopeId<'db>, + name: &str, +) -> SymbolAndQualifiers<'db> { + symbol_impl(db, scope, name, RequiresExplicitReExport::No) +} + +/// Infer the public type of a class symbol (its type as seen from outside its scope) in the given +/// `scope`. +pub(crate) fn class_symbol<'db>( + db: &'db dyn Db, + scope: ScopeId<'db>, + name: &str, +) -> SymbolAndQualifiers<'db> { + symbol_table(db, scope) + .symbol_id_by_name(name) + .map(|symbol| { + let symbol_and_quals = symbol_by_id(db, scope, symbol, RequiresExplicitReExport::No); + + if symbol_and_quals.is_class_var() { + // For declared class vars we do not need to check if they have bindings, + // we just trust the declaration. + return symbol_and_quals; + } + + if let SymbolAndQualifiers { + symbol: Symbol::Type(ty, _), + qualifiers, + } = symbol_and_quals + { + // Otherwise, we need to check if the symbol has bindings + let use_def = use_def_map(db, scope); + let bindings = use_def.public_bindings(symbol); + let inferred = + symbol_from_bindings_impl(db, bindings, RequiresExplicitReExport::No); + + // TODO: we should not need to calculate inferred type second time. This is a temporary + // solution until the notion of Boundness and Declaredness is split. See #16036, #16264 + match inferred { + Symbol::Unbound => Symbol::Unbound.with_qualifiers(qualifiers), + Symbol::Type(_, boundness) => { + Symbol::Type(ty, boundness).with_qualifiers(qualifiers) + } + } + } else { + Symbol::Unbound.into() + } + }) + .unwrap_or_default() +} + +/// Infers the public type of an explicit module-global symbol as seen from within the same file. +/// +/// Note that all global scopes also include various "implicit globals" such as `__name__`, +/// `__doc__` and `__file__`. This function **does not** consider those symbols; it will return +/// `Symbol::Unbound` for them. Use the (currently test-only) `global_symbol` query to also include +/// those additional symbols. +/// +/// Use [`imported_symbol`] to perform the lookup as seen from outside the file (e.g. via imports). +pub(crate) fn explicit_global_symbol<'db>( + db: &'db dyn Db, + file: File, + name: &str, +) -> SymbolAndQualifiers<'db> { + symbol_impl( + db, + global_scope(db, file), + name, + RequiresExplicitReExport::No, + ) +} + +/// Infers the public type of an explicit module-global symbol as seen from within the same file. +/// +/// Unlike [`explicit_global_symbol`], this function also considers various "implicit globals" +/// such as `__name__`, `__doc__` and `__file__`. These are looked up as attributes on `types.ModuleType` +/// rather than being looked up as symbols explicitly defined/declared in the global scope. +/// +/// Use [`imported_symbol`] to perform the lookup as seen from outside the file (e.g. via imports). +pub(crate) fn global_symbol<'db>( + db: &'db dyn Db, + file: File, + name: &str, +) -> SymbolAndQualifiers<'db> { + explicit_global_symbol(db, file, name) + .or_fall_back_to(db, || module_type_implicit_global_symbol(db, name)) +} + +/// Infers the public type of an imported symbol. +/// +/// If `requires_explicit_reexport` is [`None`], it will be inferred from the file's source type. +/// For stub files, explicit re-export will be required, while for non-stub files, it will not. +pub(crate) fn imported_symbol<'db>( + db: &'db dyn Db, + file: File, + name: &str, + requires_explicit_reexport: Option<RequiresExplicitReExport>, +) -> SymbolAndQualifiers<'db> { + let requires_explicit_reexport = requires_explicit_reexport.unwrap_or_else(|| { + if file.is_stub(db.upcast()) { + RequiresExplicitReExport::Yes + } else { + RequiresExplicitReExport::No + } + }); + + // If it's not found in the global scope, check if it's present as an instance on + // `types.ModuleType` or `builtins.object`. + // + // We do a more limited version of this in `module_type_implicit_global_symbol`, + // but there are two crucial differences here: + // - If a member is looked up as an attribute, `__init__` is also available on the module, but + // it isn't available as a global from inside the module + // - If a member is looked up as an attribute, members on `builtins.object` are also available + // (because `types.ModuleType` inherits from `object`); these attributes are also not + // available as globals from inside the module. + // + // The same way as in `module_type_implicit_global_symbol`, however, we need to be careful to + // ignore `__getattr__`. Typeshed has a fake `__getattr__` on `types.ModuleType` to help out with + // dynamic imports; we shouldn't use it for `ModuleLiteral` types where we know exactly which + // module we're dealing with. + symbol_impl(db, global_scope(db, file), name, requires_explicit_reexport).or_fall_back_to( + db, + || { + if name == "__getattr__" { + Symbol::Unbound.into() + } else if name == "__builtins__" { + Symbol::bound(Type::any()).into() + } else { + KnownClass::ModuleType.to_instance(db).member(db, name) + } + }, + ) +} + +/// Lookup the type of `symbol` in the builtins namespace. +/// +/// Returns `Symbol::Unbound` if the `builtins` module isn't available for some reason. +/// +/// Note that this function is only intended for use in the context of the builtins *namespace* +/// and should not be used when a symbol is being explicitly imported from the `builtins` module +/// (e.g. `from builtins import int`). +pub(crate) fn builtins_symbol<'db>(db: &'db dyn Db, symbol: &str) -> SymbolAndQualifiers<'db> { + resolve_module(db, &KnownModule::Builtins.name()) + .and_then(|module| { + let file = module.file()?; + Some( + symbol_impl( + db, + global_scope(db, file), + symbol, + RequiresExplicitReExport::Yes, + ) + .or_fall_back_to(db, || { + // We're looking up in the builtins namespace and not the module, so we should + // do the normal lookup in `types.ModuleType` and not the special one as in + // `imported_symbol`. + module_type_implicit_global_symbol(db, symbol) + }), + ) + }) + .unwrap_or_default() +} + +/// Lookup the type of `symbol` in a given known module. +/// +/// Returns `Symbol::Unbound` if the given known module cannot be resolved for some reason. +pub(crate) fn known_module_symbol<'db>( + db: &'db dyn Db, + known_module: KnownModule, + symbol: &str, +) -> SymbolAndQualifiers<'db> { + resolve_module(db, &known_module.name()) + .and_then(|module| { + let file = module.file()?; + Some(imported_symbol(db, file, symbol, None)) + }) + .unwrap_or_default() +} + +/// Lookup the type of `symbol` in the `typing` module namespace. +/// +/// Returns `Symbol::Unbound` if the `typing` module isn't available for some reason. +#[inline] +#[cfg(test)] +pub(crate) fn typing_symbol<'db>(db: &'db dyn Db, symbol: &str) -> SymbolAndQualifiers<'db> { + known_module_symbol(db, KnownModule::Typing, symbol) +} + +/// Lookup the type of `symbol` in the `typing_extensions` module namespace. +/// +/// Returns `Symbol::Unbound` if the `typing_extensions` module isn't available for some reason. +#[inline] +pub(crate) fn typing_extensions_symbol<'db>( + db: &'db dyn Db, + symbol: &str, +) -> SymbolAndQualifiers<'db> { + known_module_symbol(db, KnownModule::TypingExtensions, symbol) +} + +/// Get the `builtins` module scope. +/// +/// Can return `None` if a custom typeshed is used that is missing `builtins.pyi`. +pub(crate) fn builtins_module_scope(db: &dyn Db) -> Option<ScopeId<'_>> { + core_module_scope(db, KnownModule::Builtins) +} + +/// Get the scope of a core stdlib module. +/// +/// Can return `None` if a custom typeshed is used that is missing the core module in question. +fn core_module_scope(db: &dyn Db, core_module: KnownModule) -> Option<ScopeId<'_>> { + let module = resolve_module(db, &core_module.name())?; + Some(global_scope(db, module.file()?)) +} + +/// Infer the combined type from an iterator of bindings, and return it +/// together with boundness information in a [`Symbol`]. +/// +/// The type will be a union if there are multiple bindings with different types. +pub(super) fn symbol_from_bindings<'db>( + db: &'db dyn Db, + bindings_with_constraints: BindingWithConstraintsIterator<'_, 'db>, +) -> Symbol<'db> { + symbol_from_bindings_impl(db, bindings_with_constraints, RequiresExplicitReExport::No) +} + +/// Build a declared type from a [`DeclarationsIterator`]. +/// +/// If there is only one declaration, or all declarations declare the same type, returns +/// `Ok(..)`. If there are conflicting declarations, returns an `Err(..)` variant with +/// a union of the declared types as well as a list of all conflicting types. +/// +/// This function also returns declaredness information (see [`Symbol`]) and a set of +/// [`TypeQualifiers`] that have been specified on the declaration(s). +pub(crate) fn symbol_from_declarations<'db>( + db: &'db dyn Db, + declarations: DeclarationsIterator<'_, 'db>, +) -> SymbolFromDeclarationsResult<'db> { + symbol_from_declarations_impl(db, declarations, RequiresExplicitReExport::No) +} + +/// The result of looking up a declared type from declarations; see [`symbol_from_declarations`]. +pub(crate) type SymbolFromDeclarationsResult<'db> = + Result<SymbolAndQualifiers<'db>, (TypeAndQualifiers<'db>, Box<[Type<'db>]>)>; + +/// A type with declaredness information, and a set of type qualifiers. +/// +/// This is used to represent the result of looking up the declared type. Consider this +/// example: +/// ```py +/// class C: +/// if flag: +/// variable: ClassVar[int] +/// ``` +/// If we look up the declared type of `variable` in the scope of class `C`, we will get +/// the type `int`, a "declaredness" of [`Boundness::PossiblyUnbound`], and the information +/// that this comes with a [`CLASS_VAR`] type qualifier. +/// +/// [`CLASS_VAR`]: crate::types::TypeQualifiers::CLASS_VAR +#[derive(Debug, Clone, PartialEq, Eq, salsa::Update)] +pub(crate) struct SymbolAndQualifiers<'db> { + pub(crate) symbol: Symbol<'db>, + pub(crate) qualifiers: TypeQualifiers, +} + +impl Default for SymbolAndQualifiers<'_> { + fn default() -> Self { + SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers: TypeQualifiers::empty(), + } + } +} + +impl<'db> SymbolAndQualifiers<'db> { + /// Constructor that creates a [`SymbolAndQualifiers`] instance with a [`TodoType`] type + /// and no qualifiers. + /// + /// [`TodoType`]: crate::types::TodoType + pub(crate) fn todo(message: &'static str) -> Self { + Self { + symbol: Symbol::todo(message), + qualifiers: TypeQualifiers::empty(), + } + } + + /// Returns `true` if the symbol has a `ClassVar` type qualifier. + pub(crate) fn is_class_var(&self) -> bool { + self.qualifiers.contains(TypeQualifiers::CLASS_VAR) + } + + #[must_use] + pub(crate) fn map_type( + self, + f: impl FnOnce(Type<'db>) -> Type<'db>, + ) -> SymbolAndQualifiers<'db> { + SymbolAndQualifiers { + symbol: self.symbol.map_type(f), + qualifiers: self.qualifiers, + } + } + + /// Transform symbol and qualifiers into a [`LookupResult`], + /// a [`Result`] type in which the `Ok` variant represents a definitely bound symbol + /// and the `Err` variant represents a symbol that is either definitely or possibly unbound. + pub(crate) fn into_lookup_result(self) -> LookupResult<'db> { + match self { + SymbolAndQualifiers { + symbol: Symbol::Type(ty, Boundness::Bound), + qualifiers, + } => Ok(TypeAndQualifiers::new(ty, qualifiers)), + SymbolAndQualifiers { + symbol: Symbol::Type(ty, Boundness::PossiblyUnbound), + qualifiers, + } => Err(LookupError::PossiblyUnbound(TypeAndQualifiers::new( + ty, qualifiers, + ))), + SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers, + } => Err(LookupError::Unbound(qualifiers)), + } + } + + /// Safely unwrap the symbol and the qualifiers into a [`TypeQualifiers`]. + /// + /// If the symbol is definitely unbound or possibly unbound, it will be transformed into a + /// [`LookupError`] and `diagnostic_fn` will be applied to the error value before returning + /// the result of `diagnostic_fn` (which will be a [`TypeQualifiers`]). This allows the caller + /// to ensure that a diagnostic is emitted if the symbol is possibly or definitely unbound. + pub(crate) fn unwrap_with_diagnostic( + self, + diagnostic_fn: impl FnOnce(LookupError<'db>) -> TypeAndQualifiers<'db>, + ) -> TypeAndQualifiers<'db> { + self.into_lookup_result().unwrap_or_else(diagnostic_fn) + } + + /// Fallback (partially or fully) to another symbol if `self` is partially or fully unbound. + /// + /// 1. If `self` is definitely bound, return `self` without evaluating `fallback_fn()`. + /// 2. Else, evaluate `fallback_fn()`: + /// 1. If `self` is definitely unbound, return the result of `fallback_fn()`. + /// 2. Else, if `fallback` is definitely unbound, return `self`. + /// 3. Else, if `self` is possibly unbound and `fallback` is definitely bound, + /// return `Symbol(<union of self-type and fallback-type>, Boundness::Bound)` + /// 4. Else, if `self` is possibly unbound and `fallback` is possibly unbound, + /// return `Symbol(<union of self-type and fallback-type>, Boundness::PossiblyUnbound)` + #[must_use] + pub(crate) fn or_fall_back_to( + self, + db: &'db dyn Db, + fallback_fn: impl FnOnce() -> SymbolAndQualifiers<'db>, + ) -> Self { + self.into_lookup_result() + .or_else(|lookup_error| lookup_error.or_fall_back_to(db, fallback_fn())) + .into() + } +} + +impl<'db> From<Symbol<'db>> for SymbolAndQualifiers<'db> { + fn from(symbol: Symbol<'db>) -> Self { + symbol.with_qualifiers(TypeQualifiers::empty()) + } +} + +fn symbol_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &SymbolAndQualifiers<'db>, + _count: u32, + _scope: ScopeId<'db>, + _symbol_id: ScopedSymbolId, + _requires_explicit_reexport: RequiresExplicitReExport, +) -> salsa::CycleRecoveryAction<SymbolAndQualifiers<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn symbol_cycle_initial<'db>( + _db: &'db dyn Db, + _scope: ScopeId<'db>, + _symbol_id: ScopedSymbolId, + _requires_explicit_reexport: RequiresExplicitReExport, +) -> SymbolAndQualifiers<'db> { + Symbol::bound(Type::Never).into() +} + +#[salsa::tracked(cycle_fn=symbol_cycle_recover, cycle_initial=symbol_cycle_initial)] +fn symbol_by_id<'db>( + db: &'db dyn Db, + scope: ScopeId<'db>, + symbol_id: ScopedSymbolId, + requires_explicit_reexport: RequiresExplicitReExport, +) -> SymbolAndQualifiers<'db> { + let use_def = use_def_map(db, scope); + + // If the symbol is declared, the public type is based on declarations; otherwise, it's based + // on inference from bindings. + + let declarations = use_def.public_declarations(symbol_id); + let declared = symbol_from_declarations_impl(db, declarations, requires_explicit_reexport); + + match declared { + // Symbol is declared, trust the declared type + Ok( + symbol_and_quals @ SymbolAndQualifiers { + symbol: Symbol::Type(_, Boundness::Bound), + qualifiers: _, + }, + ) => symbol_and_quals, + // Symbol is possibly declared + Ok(SymbolAndQualifiers { + symbol: Symbol::Type(declared_ty, Boundness::PossiblyUnbound), + qualifiers, + }) => { + let bindings = use_def.public_bindings(symbol_id); + let inferred = symbol_from_bindings_impl(db, bindings, requires_explicit_reexport); + + let symbol = match inferred { + // Symbol is possibly undeclared and definitely unbound + Symbol::Unbound => { + // TODO: We probably don't want to report `Bound` here. This requires a bit of + // design work though as we might want a different behavior for stubs and for + // normal modules. + Symbol::Type(declared_ty, Boundness::Bound) + } + // Symbol is possibly undeclared and (possibly) bound + Symbol::Type(inferred_ty, boundness) => Symbol::Type( + UnionType::from_elements(db, [inferred_ty, declared_ty]), + boundness, + ), + }; + + SymbolAndQualifiers { symbol, qualifiers } + } + // Symbol is undeclared, return the union of `Unknown` with the inferred type + Ok(SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers: _, + }) => { + let bindings = use_def.public_bindings(symbol_id); + let inferred = symbol_from_bindings_impl(db, bindings, requires_explicit_reexport); + + // `__slots__` is a symbol with special behavior in Python's runtime. It can be + // modified externally, but those changes do not take effect. We therefore issue + // a diagnostic if we see it being modified externally. In type inference, we + // can assign a "narrow" type to it even if it is not *declared*. This means, we + // do not have to call [`widen_type_for_undeclared_public_symbol`]. + // + // `TYPE_CHECKING` is a special variable that should only be assigned `False` + // at runtime, but is always considered `True` in type checking. + // See mdtest/known_constants.md#user-defined-type_checking for details. + let is_considered_non_modifiable = matches!( + symbol_table(db, scope).symbol(symbol_id).name().as_str(), + "__slots__" | "TYPE_CHECKING" + ); + + if scope.file(db).is_stub(db.upcast()) { + // We generally trust module-level undeclared symbols in stubs and do not union + // with `Unknown`. If we don't do this, simple aliases like `IOError = OSError` in + // stubs would result in `IOError` being a union of `OSError` and `Unknown`, which + // leads to all sorts of downstream problems. Similarly, type variables are often + // defined as `_T = TypeVar("_T")`, without being declared. + + inferred.into() + } else { + widen_type_for_undeclared_public_symbol(db, inferred, is_considered_non_modifiable) + .into() + } + } + // Symbol has conflicting declared types + Err((declared, _)) => { + // Intentionally ignore conflicting declared types; that's not our problem, + // it's the problem of the module we are importing from. + Symbol::bound(declared.inner_type()).with_qualifiers(declared.qualifiers()) + } + } + + // TODO (ticket: https://github.com/astral-sh/ruff/issues/14297) Our handling of boundness + // currently only depends on bindings, and ignores declarations. This is inconsistent, since + // we only look at bindings if the symbol may be undeclared. Consider the following example: + // ```py + // x: int + // + // if flag: + // y: int + // else + // y = 3 + // ``` + // If we import from this module, we will currently report `x` as a definitely-bound symbol + // (even though it has no bindings at all!) but report `y` as possibly-unbound (even though + // every path has either a binding or a declaration for it.) +} + +/// Implementation of [`symbol`]. +fn symbol_impl<'db>( + db: &'db dyn Db, + scope: ScopeId<'db>, + name: &str, + requires_explicit_reexport: RequiresExplicitReExport, +) -> SymbolAndQualifiers<'db> { + let _span = tracing::trace_span!("symbol", ?name).entered(); + + if name == "platform" + && file_to_module(db, scope.file(db)) + .is_some_and(|module| module.is_known(KnownModule::Sys)) + { + match Program::get(db).python_platform(db) { + crate::PythonPlatform::Identifier(platform) => { + return Symbol::bound(Type::string_literal(db, platform.as_str())).into(); + } + crate::PythonPlatform::All => { + // Fall through to the looked up type + } + } + } + + symbol_table(db, scope) + .symbol_id_by_name(name) + .map(|symbol| symbol_by_id(db, scope, symbol, requires_explicit_reexport)) + .unwrap_or_default() +} + +/// Implementation of [`symbol_from_bindings`]. +/// +/// ## Implementation Note +/// This function gets called cross-module. It, therefore, shouldn't +/// access any AST nodes from the file containing the declarations. +fn symbol_from_bindings_impl<'db>( + db: &'db dyn Db, + bindings_with_constraints: BindingWithConstraintsIterator<'_, 'db>, + requires_explicit_reexport: RequiresExplicitReExport, +) -> Symbol<'db> { + let predicates = bindings_with_constraints.predicates; + let visibility_constraints = bindings_with_constraints.visibility_constraints; + let mut bindings_with_constraints = bindings_with_constraints.peekable(); + + let is_non_exported = |binding: Definition<'db>| { + requires_explicit_reexport.is_yes() && !is_reexported(db, binding) + }; + + let unbound_visibility_constraint = match bindings_with_constraints.peek() { + Some(BindingWithConstraints { + binding, + visibility_constraint, + narrowing_constraint: _, + }) if binding.is_none_or(is_non_exported) => Some(*visibility_constraint), + _ => None, + }; + + // Evaluate this lazily because we don't always need it (for example, if there are no visible + // bindings at all, we don't need it), and it can cause us to evaluate visibility constraint + // expressions, which is extra work and can lead to cycles. + let unbound_visibility = || { + unbound_visibility_constraint + .map(|visibility_constraint| { + visibility_constraints.evaluate(db, predicates, visibility_constraint) + }) + .unwrap_or(Truthiness::AlwaysFalse) + }; + + let mut types = bindings_with_constraints.filter_map( + |BindingWithConstraints { + binding, + narrowing_constraint, + visibility_constraint, + }| { + let binding = binding?; + + if is_non_exported(binding) { + return None; + } + + let static_visibility = + visibility_constraints.evaluate(db, predicates, visibility_constraint); + + if static_visibility.is_always_false() { + // We found a binding that we have statically determined to not be visible from + // the use of the symbol that we are investigating. There are three interesting + // cases to consider: + // + // ```py + // def f1(): + // if False: + // x = 1 + // use(x) + // + // def f2(): + // y = 1 + // return + // use(y) + // + // def f3(flag: bool): + // z = 1 + // if flag: + // z = 2 + // return + // use(z) + // ``` + // + // In the first case, there is a single binding for `x`, and due to the statically + // known `False` condition, it is not visible at the use of `x`. However, we *can* + // see/reach the start of the scope from `use(x)`. This means that `x` is unbound + // and we should return `None`. + // + // In the second case, `y` is also not visible at the use of `y`, but here, we can + // not see/reach the start of the scope. There is only one path of control flow, + // and it passes through that binding of `y` (which we can not see). This implies + // that we are in an unreachable section of code. We return `Never` in order to + // silence the `unresolve-reference` diagnostic that would otherwise be emitted at + // the use of `y`. + // + // In the third case, we have two bindings for `z`. The first one is visible, so we + // consider the case that we now encounter the second binding `z = 2`, which is not + // visible due to the early return. We *also* can not see the start of the scope + // from `use(z)` because both paths of control flow pass through a binding of `z`. + // The `z = 1` binding is visible, and so we are *not* in an unreachable section of + // code. However, it is still okay to return `Never` in this case, because we will + // union the types of all bindings, and `Never` will be eliminated automatically. + + if unbound_visibility().is_always_false() { + // The scope-start is not visible + return Some(Type::Never); + } + return None; + } + + let binding_ty = binding_type(db, binding); + Some(narrowing_constraint.narrow(db, binding_ty, binding.symbol(db))) + }, + ); + + if let Some(first) = types.next() { + let boundness = match unbound_visibility() { + Truthiness::AlwaysTrue => { + unreachable!( + "If we have at least one binding, the scope-start should not be definitely visible" + ) + } + Truthiness::AlwaysFalse => Boundness::Bound, + Truthiness::Ambiguous => Boundness::PossiblyUnbound, + }; + + if let Some(second) = types.next() { + Symbol::Type( + UnionType::from_elements(db, [first, second].into_iter().chain(types)), + boundness, + ) + } else { + Symbol::Type(first, boundness) + } + } else { + Symbol::Unbound + } +} + +/// Implementation of [`symbol_from_declarations`]. +/// +/// ## Implementation Note +/// This function gets called cross-module. It, therefore, shouldn't +/// access any AST nodes from the file containing the declarations. +fn symbol_from_declarations_impl<'db>( + db: &'db dyn Db, + declarations: DeclarationsIterator<'_, 'db>, + requires_explicit_reexport: RequiresExplicitReExport, +) -> SymbolFromDeclarationsResult<'db> { + let predicates = declarations.predicates; + let visibility_constraints = declarations.visibility_constraints; + let mut declarations = declarations.peekable(); + + let is_non_exported = |declaration: Definition<'db>| { + requires_explicit_reexport.is_yes() && !is_reexported(db, declaration) + }; + + let undeclared_visibility = match declarations.peek() { + Some(DeclarationWithConstraint { + declaration, + visibility_constraint, + }) if declaration.is_none_or(is_non_exported) => { + visibility_constraints.evaluate(db, predicates, *visibility_constraint) + } + _ => Truthiness::AlwaysFalse, + }; + + let mut types = declarations.filter_map( + |DeclarationWithConstraint { + declaration, + visibility_constraint, + }| { + let declaration = declaration?; + + if is_non_exported(declaration) { + return None; + } + + let static_visibility = + visibility_constraints.evaluate(db, predicates, visibility_constraint); + + if static_visibility.is_always_false() { + None + } else { + Some(declaration_type(db, declaration)) + } + }, + ); + + if let Some(first) = types.next() { + let mut conflicting: Vec<Type<'db>> = vec![]; + let declared = if let Some(second) = types.next() { + let ty_first = first.inner_type(); + let mut qualifiers = first.qualifiers(); + + let mut builder = UnionBuilder::new(db).add(ty_first); + for other in std::iter::once(second).chain(types) { + let other_ty = other.inner_type(); + if !ty_first.is_equivalent_to(db, other_ty) { + conflicting.push(other_ty); + } + builder = builder.add(other_ty); + qualifiers = qualifiers.union(other.qualifiers()); + } + TypeAndQualifiers::new(builder.build(), qualifiers) + } else { + first + }; + if conflicting.is_empty() { + let boundness = match undeclared_visibility { + Truthiness::AlwaysTrue => { + unreachable!( + "If we have at least one declaration, the scope-start should not be definitely visible" + ) + } + Truthiness::AlwaysFalse => Boundness::Bound, + Truthiness::Ambiguous => Boundness::PossiblyUnbound, + }; + + Ok(Symbol::Type(declared.inner_type(), boundness) + .with_qualifiers(declared.qualifiers())) + } else { + Err(( + declared, + std::iter::once(first.inner_type()) + .chain(conflicting) + .collect(), + )) + } + } else { + Ok(Symbol::Unbound.into()) + } +} + +// Returns `true` if the `definition` is re-exported. +// +// This will first check if the definition is using the "redundant alias" pattern like `import foo +// as foo` or `from foo import bar as bar`. If it's not, it will check whether the symbol is being +// exported via `__all__`. +fn is_reexported(db: &dyn Db, definition: Definition<'_>) -> bool { + // This information is computed by the semantic index builder. + if definition.is_reexported(db) { + return true; + } + // At this point, the definition should either be an `import` or `from ... import` statement. + // This is because the default value of `is_reexported` is `true` for any other kind of + // definition. + let Some(all_names) = dunder_all_names(db, definition.file(db)) else { + return false; + }; + let table = symbol_table(db, definition.scope(db)); + let symbol_name = table.symbol(definition.symbol(db)).name(); + all_names.contains(symbol_name) +} + +mod implicit_globals { + use ruff_python_ast as ast; + + use crate::db::Db; + use crate::semantic_index::{self, symbol_table, use_def_map}; + use crate::symbol::SymbolAndQualifiers; + use crate::types::{KnownClass, Type}; + + use super::{Symbol, SymbolFromDeclarationsResult, symbol_from_declarations}; + + pub(crate) fn module_type_implicit_global_declaration<'db>( + db: &'db dyn Db, + name: &str, + ) -> SymbolFromDeclarationsResult<'db> { + if !module_type_symbols(db) + .iter() + .any(|module_type_member| &**module_type_member == name) + { + return Ok(Symbol::Unbound.into()); + } + let Type::ClassLiteral(module_type_class) = KnownClass::ModuleType.to_class_literal(db) + else { + return Ok(Symbol::Unbound.into()); + }; + let module_type_scope = module_type_class.body_scope(db); + let symbol_table = symbol_table(db, module_type_scope); + let Some(symbol_id) = symbol_table.symbol_id_by_name(name) else { + return Ok(Symbol::Unbound.into()); + }; + symbol_from_declarations( + db, + use_def_map(db, module_type_scope).public_declarations(symbol_id), + ) + } + + /// Looks up the type of an "implicit global symbol". Returns [`Symbol::Unbound`] if + /// `name` is not present as an implicit symbol in module-global namespaces. + /// + /// Implicit global symbols are symbols such as `__doc__`, `__name__`, and `__file__` + /// that are implicitly defined in every module's global scope. Because their type is + /// always the same, we simply look these up as instance attributes on `types.ModuleType`. + /// + /// Note that this function should only be used as a fallback if a symbol is being looked + /// up in the global scope **from within the same file**. If the symbol is being looked up + /// from outside the file (e.g. via imports), use [`super::imported_symbol`] (or fallback logic + /// like the logic used in that function) instead. The reason is that this function returns + /// [`Symbol::Unbound`] for `__init__` and `__dict__` (which cannot be found in globals if + /// the lookup is being done from the same file) -- but these symbols *are* available in the + /// global scope if they're being imported **from a different file**. + pub(crate) fn module_type_implicit_global_symbol<'db>( + db: &'db dyn Db, + name: &str, + ) -> SymbolAndQualifiers<'db> { + // We special-case `__file__` here because we know that for an internal implicit global + // lookup in a Python module, it is always a string, even though typeshed says `str | + // None`. + if name == "__file__" { + Symbol::bound(KnownClass::Str.to_instance(db)).into() + } else if name == "__builtins__" { + Symbol::bound(Type::any()).into() + } + // In general we wouldn't check to see whether a symbol exists on a class before doing the + // `.member()` call on the instance type -- we'd just do the `.member`() call on the instance + // type, since it has the same end result. The reason to only call `.member()` on `ModuleType` + // when absolutely necessary is that this function is used in a very hot path (name resolution + // in `infer.rs`). We use less idiomatic (and much more verbose) code here as a micro-optimisation. + else if module_type_symbols(db) + .iter() + .any(|module_type_member| &**module_type_member == name) + { + KnownClass::ModuleType.to_instance(db).member(db, name) + } else { + Symbol::Unbound.into() + } + } + + /// An internal micro-optimisation for `module_type_implicit_global_symbol`. + /// + /// This function returns a list of the symbols that typeshed declares in the + /// body scope of the stub for the class `types.ModuleType`. + /// + /// The returned list excludes the attributes `__dict__` and `__init__`. These are very + /// special members that can be accessed as attributes on the module when imported, + /// but cannot be accessed as globals *inside* the module. + /// + /// The list also excludes `__getattr__`. `__getattr__` is even more special: it doesn't + /// exist at runtime, but typeshed includes it to reduce false positives associated with + /// functions that dynamically import modules and return `Instance(types.ModuleType)`. + /// We should ignore it for any known module-literal type. + /// + /// Conceptually this function could be a `Set` rather than a list, + /// but the number of symbols declared in this scope is likely to be very small, + /// so the cost of hashing the names is likely to be more expensive than it's worth. + #[salsa::tracked(returns(deref))] + fn module_type_symbols<'db>(db: &'db dyn Db) -> smallvec::SmallVec<[ast::name::Name; 8]> { + let Some(module_type) = KnownClass::ModuleType + .to_class_literal(db) + .into_class_literal() + else { + // The most likely way we get here is if a user specified a `--custom-typeshed-dir` + // without a `types.pyi` stub in the `stdlib/` directory + return smallvec::SmallVec::default(); + }; + + let module_type_scope = module_type.body_scope(db); + let module_type_symbol_table = symbol_table(db, module_type_scope); + + module_type_symbol_table + .symbols() + .filter(|symbol| symbol.is_declared()) + .map(semantic_index::symbol::Symbol::name) + .filter(|symbol_name| { + !matches!(&***symbol_name, "__dict__" | "__getattr__" | "__init__") + }) + .cloned() + .collect() + } + + #[cfg(test)] + mod tests { + use super::*; + use crate::db::tests::setup_db; + + #[test] + fn module_type_symbols_includes_declared_types_but_not_referenced_types() { + let db = setup_db(); + let symbol_names = module_type_symbols(&db); + + let dunder_name_symbol_name = ast::name::Name::new_static("__name__"); + assert!(symbol_names.contains(&dunder_name_symbol_name)); + + let property_symbol_name = ast::name::Name::new_static("property"); + assert!(!symbol_names.contains(&property_symbol_name)); + } + } +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] +pub(crate) enum RequiresExplicitReExport { + Yes, + No, +} + +impl RequiresExplicitReExport { + const fn is_yes(self) -> bool { + matches!(self, RequiresExplicitReExport::Yes) + } +} + +/// Computes a possibly-widened type `Unknown | T_inferred` from the inferred type `T_inferred` +/// of a symbol, unless the type is a known-instance type (e.g. `typing.Any`) or the symbol is +/// considered non-modifiable (e.g. when the symbol is `@Final`). We need this for public uses +/// of symbols that have no declared type. +fn widen_type_for_undeclared_public_symbol<'db>( + db: &'db dyn Db, + inferred: Symbol<'db>, + is_considered_non_modifiable: bool, +) -> Symbol<'db> { + // We special-case known-instance types here since symbols like `typing.Any` are typically + // not declared in the stubs (e.g. `Any = object()`), but we still want to treat them as + // such. + let is_known_instance = inferred + .ignore_possibly_unbound() + .is_some_and(|ty| matches!(ty, Type::KnownInstance(_))); + + if is_considered_non_modifiable || is_known_instance { + inferred + } else { + inferred.map_type(|ty| UnionType::from_elements(db, [Type::unknown(), ty])) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::db::tests::setup_db; + + #[test] + fn test_symbol_or_fall_back_to() { + use Boundness::{Bound, PossiblyUnbound}; + + let db = setup_db(); + let ty1 = Type::IntLiteral(1); + let ty2 = Type::IntLiteral(2); + + let unbound = || Symbol::Unbound.with_qualifiers(TypeQualifiers::empty()); + + let possibly_unbound_ty1 = + || Symbol::Type(ty1, PossiblyUnbound).with_qualifiers(TypeQualifiers::empty()); + let possibly_unbound_ty2 = + || Symbol::Type(ty2, PossiblyUnbound).with_qualifiers(TypeQualifiers::empty()); + + let bound_ty1 = || Symbol::Type(ty1, Bound).with_qualifiers(TypeQualifiers::empty()); + let bound_ty2 = || Symbol::Type(ty2, Bound).with_qualifiers(TypeQualifiers::empty()); + + // Start from an unbound symbol + assert_eq!(unbound().or_fall_back_to(&db, unbound), unbound()); + assert_eq!( + unbound().or_fall_back_to(&db, possibly_unbound_ty1), + possibly_unbound_ty1() + ); + assert_eq!(unbound().or_fall_back_to(&db, bound_ty1), bound_ty1()); + + // Start from a possibly unbound symbol + assert_eq!( + possibly_unbound_ty1().or_fall_back_to(&db, unbound), + possibly_unbound_ty1() + ); + assert_eq!( + possibly_unbound_ty1().or_fall_back_to(&db, possibly_unbound_ty2), + Symbol::Type(UnionType::from_elements(&db, [ty1, ty2]), PossiblyUnbound).into() + ); + assert_eq!( + possibly_unbound_ty1().or_fall_back_to(&db, bound_ty2), + Symbol::Type(UnionType::from_elements(&db, [ty1, ty2]), Bound).into() + ); + + // Start from a definitely bound symbol + assert_eq!(bound_ty1().or_fall_back_to(&db, unbound), bound_ty1()); + assert_eq!( + bound_ty1().or_fall_back_to(&db, possibly_unbound_ty2), + bound_ty1() + ); + assert_eq!(bound_ty1().or_fall_back_to(&db, bound_ty2), bound_ty1()); + } + + #[track_caller] + fn assert_bound_string_symbol<'db>(db: &'db dyn Db, symbol: Symbol<'db>) { + assert!(matches!( + symbol, + Symbol::Type(Type::NominalInstance(_), Boundness::Bound) + )); + assert_eq!(symbol.expect_type(), KnownClass::Str.to_instance(db)); + } + + #[test] + fn implicit_builtin_globals() { + let db = setup_db(); + assert_bound_string_symbol(&db, builtins_symbol(&db, "__name__").symbol); + } + + #[test] + fn implicit_typing_globals() { + let db = setup_db(); + assert_bound_string_symbol(&db, typing_symbol(&db, "__name__").symbol); + } + + #[test] + fn implicit_typing_extensions_globals() { + let db = setup_db(); + assert_bound_string_symbol(&db, typing_extensions_symbol(&db, "__name__").symbol); + } + + #[test] + fn implicit_sys_globals() { + let db = setup_db(); + assert_bound_string_symbol( + &db, + known_module_symbol(&db, KnownModule::Sys, "__name__").symbol, + ); + } +} diff --git a/crates/ty_python_semantic/src/types.rs b/crates/ty_python_semantic/src/types.rs new file mode 100644 index 0000000000000..6c9123acaeb3f --- /dev/null +++ b/crates/ty_python_semantic/src/types.rs @@ -0,0 +1,9229 @@ +use infer::nearest_enclosing_class; +use itertools::Either; + +use std::slice::Iter; +use std::str::FromStr; + +use bitflags::bitflags; +use call::{CallDunderError, CallError, CallErrorKind}; +use context::InferContext; +use diagnostic::{ + CALL_POSSIBLY_UNBOUND_METHOD, INVALID_CONTEXT_MANAGER, INVALID_SUPER_ARGUMENT, NOT_ITERABLE, + UNAVAILABLE_IMPLICIT_SUPER_ARGUMENTS, +}; +use ruff_db::diagnostic::{ + Annotation, Severity, Span, SubDiagnostic, create_semantic_syntax_diagnostic, +}; +use ruff_db::files::{File, FileRange}; +use ruff_python_ast::name::Name; +use ruff_python_ast::{self as ast, AnyNodeRef}; +use ruff_text_size::{Ranged, TextRange}; +use type_ordering::union_or_intersection_elements_ordering; + +pub(crate) use self::builder::{IntersectionBuilder, UnionBuilder}; +pub use self::diagnostic::TypeCheckDiagnostics; +pub(crate) use self::diagnostic::register_lints; +pub(crate) use self::display::TypeArrayDisplay; +pub(crate) use self::infer::{ + infer_deferred_types, infer_definition_types, infer_expression_type, infer_expression_types, + infer_scope_types, +}; +pub(crate) use self::narrow::ClassInfoConstraintFunction; +pub(crate) use self::signatures::{CallableSignature, Signature, Signatures}; +pub(crate) use self::subclass_of::{SubclassOfInner, SubclassOfType}; +use crate::module_name::ModuleName; +use crate::module_resolver::{KnownModule, file_to_module, resolve_module}; +use crate::semantic_index::ast_ids::{HasScopedExpressionId, HasScopedUseId}; +use crate::semantic_index::definition::Definition; +use crate::semantic_index::symbol::ScopeId; +use crate::semantic_index::{imported_modules, semantic_index}; +use crate::suppression::check_suppressions; +use crate::symbol::{ + Boundness, Symbol, SymbolAndQualifiers, imported_symbol, symbol_from_bindings, +}; +use crate::types::call::{Bindings, CallArgumentTypes, CallableBinding}; +pub(crate) use crate::types::class_base::ClassBase; +use crate::types::context::{LintDiagnosticGuard, LintDiagnosticGuardBuilder}; +use crate::types::diagnostic::{INVALID_TYPE_FORM, UNSUPPORTED_BOOL_CONVERSION}; +use crate::types::generics::{GenericContext, PartialSpecialization, Specialization}; +use crate::types::infer::infer_unpack_types; +use crate::types::mro::{Mro, MroError, MroIterator}; +pub(crate) use crate::types::narrow::infer_narrowing_constraint; +use crate::types::signatures::{Parameter, ParameterForm, Parameters}; +use crate::{Db, FxOrderSet, Module, Program}; +pub(crate) use class::{ClassLiteral, ClassType, GenericAlias, KnownClass}; +use instance::Protocol; +pub(crate) use instance::{NominalInstanceType, ProtocolInstanceType}; +pub(crate) use known_instance::KnownInstanceType; + +mod builder; +mod call; +mod class; +mod class_base; +mod context; +mod diagnostic; +mod display; +mod generics; +mod infer; +mod instance; +mod known_instance; +mod mro; +mod narrow; +mod protocol_class; +mod signatures; +mod slots; +mod string_annotation; +mod subclass_of; +mod type_ordering; +mod unpacker; + +mod definition; +#[cfg(test)] +mod property_tests; + +#[salsa::tracked(returns(ref))] +pub fn check_types(db: &dyn Db, file: File) -> TypeCheckDiagnostics { + let _span = tracing::trace_span!("check_types", ?file).entered(); + + tracing::debug!("Checking file '{path}'", path = file.path(db)); + + let index = semantic_index(db, file); + let mut diagnostics = TypeCheckDiagnostics::default(); + + for scope_id in index.scope_ids() { + let result = infer_scope_types(db, scope_id); + diagnostics.extend(result.diagnostics()); + } + + diagnostics.extend_diagnostics( + index + .semantic_syntax_errors() + .iter() + .map(|error| create_semantic_syntax_diagnostic(file, error)), + ); + + check_suppressions(db, file, &mut diagnostics); + + diagnostics +} + +/// Infer the type of a binding. +pub(crate) fn binding_type<'db>(db: &'db dyn Db, definition: Definition<'db>) -> Type<'db> { + let inference = infer_definition_types(db, definition); + inference.binding_type(definition) +} + +/// Infer the type of a declaration. +pub(crate) fn declaration_type<'db>( + db: &'db dyn Db, + definition: Definition<'db>, +) -> TypeAndQualifiers<'db> { + let inference = infer_definition_types(db, definition); + inference.declaration_type(definition) +} + +/// Infer the type of a (possibly deferred) sub-expression of a [`Definition`]. +/// +/// Supports expressions that are evaluated within a type-params sub-scope. +/// +/// ## Panics +/// If the given expression is not a sub-expression of the given [`Definition`]. +fn definition_expression_type<'db>( + db: &'db dyn Db, + definition: Definition<'db>, + expression: &ast::Expr, +) -> Type<'db> { + let file = definition.file(db); + let index = semantic_index(db, file); + let file_scope = index.expression_scope_id(expression); + let scope = file_scope.to_scope_id(db, file); + let expr_id = expression.scoped_expression_id(db, scope); + if scope == definition.scope(db) { + // expression is in the definition scope + let inference = infer_definition_types(db, definition); + if let Some(ty) = inference.try_expression_type(expr_id) { + ty + } else { + infer_deferred_types(db, definition).expression_type(expr_id) + } + } else { + // expression is in a type-params sub-scope + infer_scope_types(db, scope).expression_type(expr_id) + } +} + +/// The descriptor protocol distinguishes two kinds of descriptors. Non-data descriptors +/// define a `__get__` method, while data descriptors additionally define a `__set__` +/// method or a `__delete__` method. This enum is used to categorize attributes into two +/// groups: (1) data descriptors and (2) normal attributes or non-data descriptors. +#[derive(Clone, Debug, Copy, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) enum AttributeKind { + DataDescriptor, + NormalOrNonDataDescriptor, +} + +impl AttributeKind { + const fn is_data(self) -> bool { + matches!(self, Self::DataDescriptor) + } +} + +/// This enum is used to control the behavior of the descriptor protocol implementation. +/// When invoked on a class object, the fallback type (a class attribute) can shadow a +/// non-data descriptor of the meta-type (the class's metaclass). However, this is not +/// true for instances. When invoked on an instance, the fallback type (an attribute on +/// the instance) can not completely shadow a non-data descriptor of the meta-type (the +/// class), because we do not currently attempt to statically infer if an instance +/// attribute is definitely defined (i.e. to check whether a particular method has been +/// called). +#[derive(Clone, Debug, Copy, PartialEq)] +enum InstanceFallbackShadowsNonDataDescriptor { + Yes, + No, +} + +bitflags! { + #[derive(Clone, Debug, Copy, PartialEq, Eq, Hash)] + pub(crate) struct MemberLookupPolicy: u8 { + /// Dunder methods are looked up on the meta-type of a type without potentially falling + /// back on attributes on the type itself. For example, when implicitly invoked on an + /// instance, dunder methods are not looked up as instance attributes. And when invoked + /// on a class, dunder methods are only looked up on the metaclass, not the class itself. + /// + /// All other attributes use the `WithInstanceFallback` policy. + /// + /// If this flag is set - look up the attribute on the meta-type only. + const NO_INSTANCE_FALLBACK = 1 << 0; + + /// When looking up an attribute on a class, we sometimes need to avoid + /// looking up attributes defined on the `object` class. Usually because + /// typeshed doesn't properly encode runtime behavior (e.g. see how `__new__` & `__init__` + /// are handled during class creation). + /// + /// If this flag is set - exclude attributes defined on `object` when looking up attributes. + const MRO_NO_OBJECT_FALLBACK = 1 << 1; + + /// When looking up an attribute on a class, we sometimes need to avoid + /// looking up attributes defined on `type` if this is the metaclass of the class. + /// + /// This is similar to no object fallback above + const META_CLASS_NO_TYPE_FALLBACK = 1 << 2; + } +} + +impl MemberLookupPolicy { + /// Only look up the attribute on the meta-type. + /// + /// If false - Look up the attribute on the meta-type, but fall back to attributes on the instance + /// if the meta-type attribute is not found or if the meta-type attribute is not a data + /// descriptor. + pub(crate) const fn no_instance_fallback(self) -> bool { + self.contains(Self::NO_INSTANCE_FALLBACK) + } + + /// Exclude attributes defined on `object` when looking up attributes. + pub(crate) const fn mro_no_object_fallback(self) -> bool { + self.contains(Self::MRO_NO_OBJECT_FALLBACK) + } + + /// Exclude attributes defined on `type` when looking up meta-class-attributes. + pub(crate) const fn meta_class_no_type_fallback(self) -> bool { + self.contains(Self::META_CLASS_NO_TYPE_FALLBACK) + } +} + +impl Default for MemberLookupPolicy { + fn default() -> Self { + Self::empty() + } +} + +fn member_lookup_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &SymbolAndQualifiers<'db>, + _count: u32, + _self: Type<'db>, + _name: Name, + _policy: MemberLookupPolicy, +) -> salsa::CycleRecoveryAction<SymbolAndQualifiers<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn member_lookup_cycle_initial<'db>( + _db: &'db dyn Db, + _self: Type<'db>, + _name: Name, + _policy: MemberLookupPolicy, +) -> SymbolAndQualifiers<'db> { + Symbol::bound(Type::Never).into() +} + +/// Meta data for `Type::Todo`, which represents a known limitation in ty. +#[cfg(debug_assertions)] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] +pub struct TodoType(pub &'static str); + +#[cfg(debug_assertions)] +impl std::fmt::Display for TodoType { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "({msg})", msg = self.0) + } +} + +#[cfg(not(debug_assertions))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] +pub struct TodoType; + +#[cfg(not(debug_assertions))] +impl std::fmt::Display for TodoType { + fn fmt(&self, _: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + Ok(()) + } +} + +/// Create a `Type::Todo` variant to represent a known limitation in the type system. +/// +/// It can be created by specifying a custom message: `todo_type!("PEP 604 not supported")`. +#[cfg(debug_assertions)] +macro_rules! todo_type { + ($message:literal) => {{ + const _: () = { + let s = $message; + + if !s.is_ascii() { + panic!("todo_type! message must be ASCII"); + } + + let bytes = s.as_bytes(); + let mut i = 0; + while i < bytes.len() { + // Check each byte for '(' or ')' + let ch = bytes[i]; + + assert!( + !40u8.eq_ignore_ascii_case(&ch) && !41u8.eq_ignore_ascii_case(&ch), + "todo_type! message must not contain parentheses", + ); + i += 1; + } + }; + $crate::types::Type::Dynamic($crate::types::DynamicType::Todo($crate::types::TodoType( + $message, + ))) + }}; + ($message:ident) => { + $crate::types::Type::Dynamic($crate::types::DynamicType::Todo($crate::types::TodoType( + $message, + ))) + }; +} + +#[cfg(not(debug_assertions))] +macro_rules! todo_type { + () => { + $crate::types::Type::Dynamic($crate::types::DynamicType::Todo(crate::types::TodoType)) + }; + ($message:literal) => { + $crate::types::Type::Dynamic($crate::types::DynamicType::Todo(crate::types::TodoType)) + }; + ($message:ident) => { + $crate::types::Type::Dynamic($crate::types::DynamicType::Todo(crate::types::TodoType)) + }; +} + +pub use crate::types::definition::TypeDefinition; +pub(crate) use todo_type; + +/// Represents an instance of `builtins.property`. +/// +/// # Ordering +/// Ordering is based on the property instance's salsa-assigned id and not on its values. +/// The id may change between runs, or when the property instance was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct PropertyInstanceType<'db> { + getter: Option<Type<'db>>, + setter: Option<Type<'db>>, +} + +impl<'db> PropertyInstanceType<'db> { + fn apply_type_mapping<'a>(self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + let getter = self + .getter(db) + .map(|ty| ty.apply_type_mapping(db, type_mapping)); + let setter = self + .setter(db) + .map(|ty| ty.apply_type_mapping(db, type_mapping)); + Self::new(db, getter, setter) + } + + fn normalized(self, db: &'db dyn Db) -> Self { + Self::new( + db, + self.getter(db).map(|ty| ty.normalized(db)), + self.setter(db).map(|ty| ty.normalized(db)), + ) + } + + fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + if let Some(ty) = self.getter(db) { + ty.find_legacy_typevars(db, typevars); + } + if let Some(ty) = self.setter(db) { + ty.find_legacy_typevars(db, typevars); + } + } +} + +bitflags! { + /// Used for the return type of `dataclass(…)` calls. Keeps track of the arguments + /// that were passed in. For the precise meaning of the fields, see [1]. + /// + /// [1]: https://docs.python.org/3/library/dataclasses.html + #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] + pub struct DataclassParams: u16 { + const INIT = 0b0000_0000_0001; + const REPR = 0b0000_0000_0010; + const EQ = 0b0000_0000_0100; + const ORDER = 0b0000_0000_1000; + const UNSAFE_HASH = 0b0000_0001_0000; + const FROZEN = 0b0000_0010_0000; + const MATCH_ARGS = 0b0000_0100_0000; + const KW_ONLY = 0b0000_1000_0000; + const SLOTS = 0b0001_0000_0000; + const WEAKREF_SLOT = 0b0010_0000_0000; + } +} + +impl Default for DataclassParams { + fn default() -> Self { + Self::INIT | Self::REPR | Self::EQ | Self::MATCH_ARGS + } +} + +impl From<DataclassTransformerParams> for DataclassParams { + fn from(params: DataclassTransformerParams) -> Self { + let mut result = Self::default(); + + result.set( + Self::EQ, + params.contains(DataclassTransformerParams::EQ_DEFAULT), + ); + result.set( + Self::ORDER, + params.contains(DataclassTransformerParams::ORDER_DEFAULT), + ); + result.set( + Self::KW_ONLY, + params.contains(DataclassTransformerParams::KW_ONLY_DEFAULT), + ); + result.set( + Self::FROZEN, + params.contains(DataclassTransformerParams::FROZEN_DEFAULT), + ); + + result + } +} + +bitflags! { + /// Used for the return type of `dataclass_transform(…)` calls. Keeps track of the + /// arguments that were passed in. For the precise meaning of the fields, see [1]. + /// + /// [1]: https://docs.python.org/3/library/typing.html#typing.dataclass_transform + #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, salsa::Update)] + pub struct DataclassTransformerParams: u8 { + const EQ_DEFAULT = 0b0000_0001; + const ORDER_DEFAULT = 0b0000_0010; + const KW_ONLY_DEFAULT = 0b0000_0100; + const FROZEN_DEFAULT = 0b0000_1000; + } +} + +impl Default for DataclassTransformerParams { + fn default() -> Self { + Self::EQ_DEFAULT + } +} + +/// Representation of a type: a set of possible values at runtime. +/// +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub enum Type<'db> { + /// The dynamic type: a statically unknown set of values + Dynamic(DynamicType), + /// The empty set of values + Never, + /// A specific function object + FunctionLiteral(FunctionType<'db>), + /// Represents a callable `instance.method` where `instance` is an instance of a class + /// and `method` is a method (of that class). + /// + /// See [`BoundMethodType`] for more information. + /// + /// TODO: consider replacing this with `Callable & Instance(MethodType)`? + /// I.e. if we have a method `def f(self, x: int) -> str`, and see it being called as + /// `instance.f`, we could partially apply (and check) the `instance` argument against + /// the `self` parameter, and return a `MethodType & Callable[[int], str]`. + /// One drawback would be that we could not show the bound instance when that type is displayed. + BoundMethod(BoundMethodType<'db>), + /// Represents a specific instance of `types.MethodWrapperType`. + /// + /// TODO: consider replacing this with `Callable & types.MethodWrapperType` type? + /// Requires `Callable` to be able to represent overloads, e.g. `types.FunctionType.__get__` has + /// this behaviour when a method is accessed on a class vs an instance: + /// + /// ```txt + /// * (None, type) -> Literal[function_on_which_it_was_called] + /// * (object, type | None) -> BoundMethod[instance, function_on_which_it_was_called] + /// ``` + MethodWrapper(MethodWrapperKind<'db>), + /// Represents a specific instance of `types.WrapperDescriptorType`. + /// + /// TODO: Similar to above, this could eventually be replaced by a generic `Callable` + /// type. We currently add this as a separate variant because `FunctionType.__get__` + /// is an overloaded method and we do not support `@overload` yet. + WrapperDescriptor(WrapperDescriptorKind), + /// A special callable that is returned by a `dataclass(…)` call. It is usually + /// used as a decorator. Note that this is only used as a return type for actual + /// `dataclass` calls, not for the argumentless `@dataclass` decorator. + DataclassDecorator(DataclassParams), + /// A special callable that is returned by a `dataclass_transform(…)` call. + DataclassTransformer(DataclassTransformerParams), + /// The type of an arbitrary callable object with a certain specified signature. + Callable(CallableType<'db>), + /// A specific module object + ModuleLiteral(ModuleLiteralType<'db>), + /// A specific class object + ClassLiteral(ClassLiteral<'db>), + /// A specialization of a generic class + GenericAlias(GenericAlias<'db>), + /// The set of all class objects that are subclasses of the given class (C), spelled `type[C]`. + SubclassOf(SubclassOfType<'db>), + /// The set of Python objects with the given class in their __class__'s method resolution order. + /// Construct this variant using the `Type::instance` constructor function. + NominalInstance(NominalInstanceType<'db>), + /// The set of Python objects that conform to the interface described by a given protocol. + /// Construct this variant using the `Type::instance` constructor function. + ProtocolInstance(ProtocolInstanceType<'db>), + /// A single Python object that requires special treatment in the type system + KnownInstance(KnownInstanceType<'db>), + /// An instance of `builtins.property` + PropertyInstance(PropertyInstanceType<'db>), + /// The set of objects in any of the types in the union + Union(UnionType<'db>), + /// The set of objects in all of the types in the intersection + Intersection(IntersectionType<'db>), + /// Represents objects whose `__bool__` method is deterministic: + /// - `AlwaysTruthy`: `__bool__` always returns `True` + /// - `AlwaysFalsy`: `__bool__` always returns `False` + AlwaysTruthy, + AlwaysFalsy, + /// An integer literal + IntLiteral(i64), + /// A boolean literal, either `True` or `False`. + BooleanLiteral(bool), + /// A string literal whose value is known + StringLiteral(StringLiteralType<'db>), + /// A string known to originate only from literal values, but whose value is not known (unlike + /// `StringLiteral` above). + LiteralString, + /// A bytes literal + BytesLiteral(BytesLiteralType<'db>), + /// A heterogeneous tuple type, with elements of the given types in source order. + // TODO: Support variable length homogeneous tuple type like `tuple[int, ...]`. + Tuple(TupleType<'db>), + /// An instance of a typevar in a generic class or function. When the generic class or function + /// is specialized, we will replace this typevar with its specialization. + TypeVar(TypeVarInstance<'db>), + // A bound super object like `super()` or `super(A, A())` + // This type doesn't handle an unbound super object like `super(A)`; for that we just use + // a `Type::NominalInstance` of `builtins.super`. + BoundSuper(BoundSuperType<'db>), + // TODO protocols, overloads, generics +} + +#[salsa::tracked] +impl<'db> Type<'db> { + pub const fn any() -> Self { + Self::Dynamic(DynamicType::Any) + } + + pub const fn unknown() -> Self { + Self::Dynamic(DynamicType::Unknown) + } + + pub fn object(db: &'db dyn Db) -> Self { + KnownClass::Object.to_instance(db) + } + + pub const fn is_unknown(&self) -> bool { + matches!(self, Type::Dynamic(DynamicType::Unknown)) + } + + pub const fn is_never(&self) -> bool { + matches!(self, Type::Never) + } + + /// Returns `true` if `self` is [`Type::Callable`]. + pub const fn is_callable_type(&self) -> bool { + matches!(self, Type::Callable(..)) + } + + fn is_none(&self, db: &'db dyn Db) -> bool { + self.into_nominal_instance() + .is_some_and(|instance| instance.class.is_known(db, KnownClass::NoneType)) + } + + fn is_bool(&self, db: &'db dyn Db) -> bool { + self.into_nominal_instance() + .is_some_and(|instance| instance.class.is_known(db, KnownClass::Bool)) + } + + pub fn is_notimplemented(&self, db: &'db dyn Db) -> bool { + self.into_nominal_instance() + .is_some_and(|instance| instance.class.is_known(db, KnownClass::NotImplementedType)) + } + + pub fn is_object(&self, db: &'db dyn Db) -> bool { + self.into_nominal_instance() + .is_some_and(|instance| instance.class.is_object(db)) + } + + pub const fn is_todo(&self) -> bool { + matches!(self, Type::Dynamic(DynamicType::Todo(_))) + } + + /// Replace references to the class `class` with a self-reference marker. This is currently + /// used for recursive protocols, but could probably be extended to self-referential type- + /// aliases and similar. + #[must_use] + pub fn replace_self_reference(&self, db: &'db dyn Db, class: ClassLiteral<'db>) -> Type<'db> { + match self { + Self::ProtocolInstance(protocol) => { + Self::ProtocolInstance(protocol.replace_self_reference(db, class)) + } + + Self::Union(union) => UnionType::from_elements( + db, + union + .elements(db) + .iter() + .map(|ty| ty.replace_self_reference(db, class)), + ), + + Self::Intersection(intersection) => IntersectionBuilder::new(db) + .positive_elements( + intersection + .positive(db) + .iter() + .map(|ty| ty.replace_self_reference(db, class)), + ) + .negative_elements( + intersection + .negative(db) + .iter() + .map(|ty| ty.replace_self_reference(db, class)), + ) + .build(), + + Self::Tuple(tuple) => TupleType::from_elements( + db, + tuple + .elements(db) + .iter() + .map(|ty| ty.replace_self_reference(db, class)), + ), + + Self::Callable(callable) => Self::Callable(callable.replace_self_reference(db, class)), + + Self::GenericAlias(_) | Self::TypeVar(_) => { + // TODO: replace self-references in generic aliases and typevars + *self + } + + Self::Dynamic(_) + | Self::AlwaysFalsy + | Self::AlwaysTruthy + | Self::Never + | Self::BooleanLiteral(_) + | Self::BytesLiteral(_) + | Self::StringLiteral(_) + | Self::IntLiteral(_) + | Self::LiteralString + | Self::FunctionLiteral(_) + | Self::ModuleLiteral(_) + | Self::ClassLiteral(_) + | Self::NominalInstance(_) + | Self::KnownInstance(_) + | Self::PropertyInstance(_) + | Self::BoundMethod(_) + | Self::WrapperDescriptor(_) + | Self::MethodWrapper(_) + | Self::DataclassDecorator(_) + | Self::DataclassTransformer(_) + | Self::SubclassOf(_) + | Self::BoundSuper(_) => *self, + } + } + + /// Return `true` if `self`, or any of the types contained in `self`, match the closure passed in. + pub fn any_over_type(self, db: &'db dyn Db, type_fn: &dyn Fn(Type<'db>) -> bool) -> bool { + if type_fn(self) { + return true; + } + + match self { + Self::AlwaysFalsy + | Self::AlwaysTruthy + | Self::Never + | Self::BooleanLiteral(_) + | Self::BytesLiteral(_) + | Self::ModuleLiteral(_) + | Self::FunctionLiteral(_) + | Self::ClassLiteral(_) + | Self::KnownInstance(_) + | Self::StringLiteral(_) + | Self::IntLiteral(_) + | Self::LiteralString + | Self::Dynamic(_) + | Self::BoundMethod(_) + | Self::WrapperDescriptor(_) + | Self::MethodWrapper(_) + | Self::DataclassDecorator(_) + | Self::DataclassTransformer(_) => false, + + Self::GenericAlias(generic) => generic + .specialization(db) + .types(db) + .iter() + .copied() + .any(|ty| ty.any_over_type(db, type_fn)), + + Self::Callable(callable) => { + let signatures = callable.signatures(db); + signatures.iter().any(|signature| { + signature.parameters().iter().any(|param| { + param + .annotated_type() + .is_some_and(|ty| ty.any_over_type(db, type_fn)) + }) || signature + .return_ty + .is_some_and(|ty| ty.any_over_type(db, type_fn)) + }) + } + + Self::SubclassOf(subclass_of) => { + Type::from(subclass_of.subclass_of()).any_over_type(db, type_fn) + } + + Self::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => false, + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.any_over_type(db, type_fn) + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .any(|constraint| constraint.any_over_type(db, type_fn)), + }, + + Self::BoundSuper(bound_super) => { + Type::from(bound_super.pivot_class(db)).any_over_type(db, type_fn) + || Type::from(bound_super.owner(db)).any_over_type(db, type_fn) + } + + Self::Tuple(tuple) => tuple + .elements(db) + .iter() + .any(|ty| ty.any_over_type(db, type_fn)), + + Self::Union(union) => union + .elements(db) + .iter() + .any(|ty| ty.any_over_type(db, type_fn)), + + Self::Intersection(intersection) => { + intersection + .positive(db) + .iter() + .any(|ty| ty.any_over_type(db, type_fn)) + || intersection + .negative(db) + .iter() + .any(|ty| ty.any_over_type(db, type_fn)) + } + + Self::ProtocolInstance(protocol) => protocol.any_over_type(db, type_fn), + + Self::PropertyInstance(property) => { + property + .getter(db) + .is_some_and(|ty| ty.any_over_type(db, type_fn)) + || property + .setter(db) + .is_some_and(|ty| ty.any_over_type(db, type_fn)) + } + + Self::NominalInstance(instance) => match instance.class { + ClassType::NonGeneric(_) => false, + ClassType::Generic(generic) => generic + .specialization(db) + .types(db) + .iter() + .any(|ty| ty.any_over_type(db, type_fn)), + }, + } + } + + pub const fn into_class_literal(self) -> Option<ClassLiteral<'db>> { + match self { + Type::ClassLiteral(class_type) => Some(class_type), + _ => None, + } + } + + #[track_caller] + pub fn expect_class_literal(self) -> ClassLiteral<'db> { + self.into_class_literal() + .expect("Expected a Type::ClassLiteral variant") + } + + pub const fn is_subclass_of(&self) -> bool { + matches!(self, Type::SubclassOf(..)) + } + + pub const fn is_class_literal(&self) -> bool { + matches!(self, Type::ClassLiteral(..)) + } + + /// Turn a class literal (`Type::ClassLiteral` or `Type::GenericAlias`) into a `ClassType`. + /// Since a `ClassType` must be specialized, apply the default specialization to any + /// unspecialized generic class literal. + pub fn to_class_type(self, db: &'db dyn Db) -> Option<ClassType<'db>> { + match self { + Type::ClassLiteral(class_literal) => Some(class_literal.default_specialization(db)), + Type::GenericAlias(alias) => Some(ClassType::Generic(alias)), + _ => None, + } + } + + #[track_caller] + pub fn expect_class_type(self, db: &'db dyn Db) -> ClassType<'db> { + self.to_class_type(db) + .expect("Expected a Type::GenericAlias or Type::ClassLiteral variant") + } + + pub fn is_class_type(&self, db: &'db dyn Db) -> bool { + match self { + Type::ClassLiteral(class) if class.generic_context(db).is_none() => true, + Type::GenericAlias(_) => true, + _ => false, + } + } + + pub const fn is_property_instance(&self) -> bool { + matches!(self, Type::PropertyInstance(..)) + } + + pub fn module_literal(db: &'db dyn Db, importing_file: File, submodule: Module) -> Self { + Self::ModuleLiteral(ModuleLiteralType::new(db, importing_file, submodule)) + } + + pub const fn into_module_literal(self) -> Option<ModuleLiteralType<'db>> { + match self { + Type::ModuleLiteral(module) => Some(module), + _ => None, + } + } + + #[track_caller] + pub fn expect_module_literal(self) -> ModuleLiteralType<'db> { + self.into_module_literal() + .expect("Expected a Type::ModuleLiteral variant") + } + + pub const fn into_union(self) -> Option<UnionType<'db>> { + match self { + Type::Union(union_type) => Some(union_type), + _ => None, + } + } + + #[track_caller] + pub fn expect_union(self) -> UnionType<'db> { + self.into_union().expect("Expected a Type::Union variant") + } + + pub const fn is_union(&self) -> bool { + matches!(self, Type::Union(..)) + } + + pub const fn into_intersection(self) -> Option<IntersectionType<'db>> { + match self { + Type::Intersection(intersection_type) => Some(intersection_type), + _ => None, + } + } + + #[track_caller] + pub fn expect_intersection(self) -> IntersectionType<'db> { + self.into_intersection() + .expect("Expected a Type::Intersection variant") + } + + pub const fn into_function_literal(self) -> Option<FunctionType<'db>> { + match self { + Type::FunctionLiteral(function_type) => Some(function_type), + _ => None, + } + } + + #[track_caller] + pub fn expect_function_literal(self) -> FunctionType<'db> { + self.into_function_literal() + .expect("Expected a Type::FunctionLiteral variant") + } + + pub const fn is_function_literal(&self) -> bool { + matches!(self, Type::FunctionLiteral(..)) + } + + pub const fn is_bound_method(&self) -> bool { + matches!(self, Type::BoundMethod(..)) + } + + pub fn is_union_of_single_valued(&self, db: &'db dyn Db) -> bool { + self.into_union().is_some_and(|union| { + union + .elements(db) + .iter() + .all(|ty| ty.is_single_valued(db) || ty.is_bool(db) || ty.is_literal_string()) + }) || self.is_bool(db) + || self.is_literal_string() + } + + pub const fn into_int_literal(self) -> Option<i64> { + match self { + Type::IntLiteral(value) => Some(value), + _ => None, + } + } + + pub fn into_string_literal(self) -> Option<StringLiteralType<'db>> { + match self { + Type::StringLiteral(string_literal) => Some(string_literal), + _ => None, + } + } + + pub fn is_string_literal(&self) -> bool { + matches!(self, Type::StringLiteral(..)) + } + + #[track_caller] + pub fn expect_int_literal(self) -> i64 { + self.into_int_literal() + .expect("Expected a Type::IntLiteral variant") + } + + pub const fn into_known_instance(self) -> Option<KnownInstanceType<'db>> { + match self { + Type::KnownInstance(known_instance) => Some(known_instance), + _ => None, + } + } + + #[track_caller] + pub fn expect_known_instance(self) -> KnownInstanceType<'db> { + self.into_known_instance() + .expect("Expected a Type::KnownInstance variant") + } + + pub const fn into_tuple(self) -> Option<TupleType<'db>> { + match self { + Type::Tuple(tuple_type) => Some(tuple_type), + _ => None, + } + } + + pub const fn is_boolean_literal(&self) -> bool { + matches!(self, Type::BooleanLiteral(..)) + } + + pub const fn is_literal_string(&self) -> bool { + matches!(self, Type::LiteralString) + } + + pub fn string_literal(db: &'db dyn Db, string: &str) -> Self { + Self::StringLiteral(StringLiteralType::new(db, string)) + } + + pub fn bytes_literal(db: &'db dyn Db, bytes: &[u8]) -> Self { + Self::BytesLiteral(BytesLiteralType::new(db, bytes)) + } + + #[must_use] + pub fn negate(&self, db: &'db dyn Db) -> Type<'db> { + IntersectionBuilder::new(db).add_negative(*self).build() + } + + #[must_use] + pub fn negate_if(&self, db: &'db dyn Db, yes: bool) -> Type<'db> { + if yes { self.negate(db) } else { *self } + } + + /// Returns the fallback instance type that a literal is an instance of, or `None` if the type + /// is not a literal. + pub fn literal_fallback_instance(self, db: &'db dyn Db) -> Option<Type<'db>> { + // There are other literal types that could conceivable be included here: class literals + // falling back to `type[X]`, for instance. For now, there is not much rigorous thought put + // into what's included vs not; this is just an empirical choice that makes our ecosystem + // report look better until we have proper bidirectional type inference. + match self { + Type::StringLiteral(_) | Type::LiteralString => Some(KnownClass::Str.to_instance(db)), + Type::BooleanLiteral(_) => Some(KnownClass::Bool.to_instance(db)), + Type::IntLiteral(_) => Some(KnownClass::Int.to_instance(db)), + Type::BytesLiteral(_) => Some(KnownClass::Bytes.to_instance(db)), + Type::ModuleLiteral(_) => Some(KnownClass::ModuleType.to_instance(db)), + _ => None, + } + } + + /// Return a "normalized" version of `self` that ensures that equivalent types have the same Salsa ID. + /// + /// A normalized type: + /// - Has all unions and intersections sorted according to a canonical order, + /// no matter how "deeply" a union/intersection may be nested. + /// - Strips the names of positional-only parameters and variadic parameters from `Callable` types, + /// as these are irrelevant to whether a callable type `X` is equivalent to a callable type `Y`. + /// - Strips the types of default values from parameters in `Callable` types: only whether a parameter + /// *has* or *does not have* a default value is relevant to whether two `Callable` types are equivalent. + /// - Converts class-based protocols into synthesized protocols + #[must_use] + pub fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Type::Union(union) => Type::Union(union.normalized(db)), + Type::Intersection(intersection) => Type::Intersection(intersection.normalized(db)), + Type::Tuple(tuple) => Type::Tuple(tuple.normalized(db)), + Type::Callable(callable) => Type::Callable(callable.normalized(db)), + Type::ProtocolInstance(protocol) => protocol.normalized(db), + Type::NominalInstance(instance) => Type::NominalInstance(instance.normalized(db)), + Type::Dynamic(dynamic) => Type::Dynamic(dynamic.normalized()), + Type::FunctionLiteral(function) => Type::FunctionLiteral(function.normalized(db)), + Type::PropertyInstance(property) => Type::PropertyInstance(property.normalized(db)), + Type::MethodWrapper(method_kind) => Type::MethodWrapper(method_kind.normalized(db)), + Type::BoundMethod(method) => Type::BoundMethod(method.normalized(db)), + Type::BoundSuper(bound_super) => Type::BoundSuper(bound_super.normalized(db)), + Type::GenericAlias(generic) => Type::GenericAlias(generic.normalized(db)), + Type::SubclassOf(subclass_of) => Type::SubclassOf(subclass_of.normalized(db)), + Type::KnownInstance(known_instance) => { + Type::KnownInstance(known_instance.normalized(db)) + } + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + Type::TypeVar(TypeVarInstance::new( + db, + typevar.name(db).clone(), + typevar.definition(db), + Some(TypeVarBoundOrConstraints::UpperBound(bound.normalized(db))), + typevar.variance(db), + typevar.default_ty(db), + typevar.kind(db), + )) + } + Some(TypeVarBoundOrConstraints::Constraints(union)) => { + Type::TypeVar(TypeVarInstance::new( + db, + typevar.name(db).clone(), + typevar.definition(db), + Some(TypeVarBoundOrConstraints::Constraints(union.normalized(db))), + typevar.variance(db), + typevar.default_ty(db), + typevar.kind(db), + )) + } + None => self, + }, + Type::LiteralString + | Type::AlwaysFalsy + | Type::AlwaysTruthy + | Type::BooleanLiteral(_) + | Type::BytesLiteral(_) + | Type::StringLiteral(_) + | Type::Never + | Type::WrapperDescriptor(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::ClassLiteral(_) + | Type::IntLiteral(_) => self, + } + } + + /// Return true if this type is a [subtype of] type `target`. + /// + /// This method returns `false` if either `self` or `other` is not fully static. + /// + /// [subtype of]: https://typing.python.org/en/latest/spec/concepts.html#subtype-supertype-and-type-equivalence + pub(crate) fn is_subtype_of(self, db: &'db dyn Db, target: Type<'db>) -> bool { + // Two equivalent types are always subtypes of each other. + // + // "Equivalent to" here means that the two types are both fully static + // and describe exactly the same set of possible runtime objects. + // For example, `int` is a subtype of `int` because `int` and `int` are equivalent to each other. + // Equally, `type[object]` is a subtype of `type`, + // because the former type expresses "all subclasses of `object`" + // while the latter expresses "all instances of `type`", + // and these are exactly the same set of objects at runtime. + if self.is_equivalent_to(db, target) { + return true; + } + + // Non-fully-static types do not participate in subtyping. + // + // Type `A` can only be a subtype of type `B` if the set of possible runtime objects + // that `A` represents is a subset of the set of possible runtime objects that `B` represents. + // But the set of objects described by a non-fully-static type is (either partially or wholly) unknown, + // so the question is simply unanswerable for non-fully-static types. + if !self.is_fully_static(db) || !target.is_fully_static(db) { + return false; + } + + match (self, target) { + // We should have handled these immediately above. + (Type::Dynamic(_), _) | (_, Type::Dynamic(_)) => { + unreachable!("Non-fully-static types do not participate in subtyping!") + } + + // `Never` is the bottom type, the empty set. + // It is a subtype of all other fully static types. + // No other fully static type is a subtype of `Never`. + (Type::Never, _) => true, + (_, Type::Never) => false, + + // Everything is a subtype of `object`. + (_, Type::NominalInstance(instance)) if instance.class.is_object(db) => true, + + // In general, a TypeVar `T` is not a subtype of a type `S` unless one of the two conditions is satisfied: + // 1. `T` is a bound TypeVar and `T`'s upper bound is a subtype of `S`. + // TypeVars without an explicit upper bound are treated as having an implicit upper bound of `object`. + // 2. `T` is a constrained TypeVar and all of `T`'s constraints are subtypes of `S`. + // + // However, there is one exception to this general rule: for any given typevar `T`, + // `T` will always be a subtype of any union containing `T`. + // A similar rule applies in reverse to intersection types. + (Type::TypeVar(_), Type::Union(union)) if union.elements(db).contains(&self) => true, + (Type::Intersection(intersection), Type::TypeVar(_)) + if intersection.positive(db).contains(&target) => + { + true + } + (Type::Intersection(intersection), Type::TypeVar(_)) + if intersection.negative(db).contains(&target) => + { + false + } + + // A fully static typevar is a subtype of its upper bound, and to something similar to + // the union of its constraints. An unbound, unconstrained, fully static typevar has an + // implicit upper bound of `object` (which is handled above). + (Type::TypeVar(typevar), _) if typevar.bound_or_constraints(db).is_some() => { + match typevar.bound_or_constraints(db) { + None => unreachable!(), + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.is_subtype_of(db, target) + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_subtype_of(db, target)), + } + } + + // If the typevar is constrained, there must be multiple constraints, and the typevar + // might be specialized to any one of them. However, the constraints do not have to be + // disjoint, which means an lhs type might be a subtype of all of the constraints. + (_, Type::TypeVar(typevar)) + if typevar.constraints(db).is_some_and(|constraints| { + constraints + .iter() + .all(|constraint| self.is_subtype_of(db, *constraint)) + }) => + { + true + } + + (Type::Union(union), _) => union + .elements(db) + .iter() + .all(|&elem_ty| elem_ty.is_subtype_of(db, target)), + + (_, Type::Union(union)) => union + .elements(db) + .iter() + .any(|&elem_ty| self.is_subtype_of(db, elem_ty)), + + // If both sides are intersections we need to handle the right side first + // (A & B & C) is a subtype of (A & B) because the left is a subtype of both A and B, + // but none of A, B, or C is a subtype of (A & B). + (_, Type::Intersection(intersection)) => { + intersection + .positive(db) + .iter() + .all(|&pos_ty| self.is_subtype_of(db, pos_ty)) + && intersection + .negative(db) + .iter() + .all(|&neg_ty| self.is_disjoint_from(db, neg_ty)) + } + + (Type::Intersection(intersection), _) => intersection + .positive(db) + .iter() + .any(|&elem_ty| elem_ty.is_subtype_of(db, target)), + + // Other than the special cases checked above, no other types are a subtype of a + // typevar, since there's no guarantee what type the typevar will be specialized to. + // (If the typevar is bounded, it might be specialized to a smaller type than the + // bound. This is true even if the bound is a final class, since the typevar can still + // be specialized to `Never`.) + (_, Type::TypeVar(_)) => false, + + // Note that the definition of `Type::AlwaysFalsy` depends on the return value of `__bool__`. + // If `__bool__` always returns True or False, it can be treated as a subtype of `AlwaysTruthy` or `AlwaysFalsy`, respectively. + (left, Type::AlwaysFalsy) => left.bool(db).is_always_false(), + (left, Type::AlwaysTruthy) => left.bool(db).is_always_true(), + // Currently, the only supertype of `AlwaysFalsy` and `AlwaysTruthy` is the universal set (object instance). + (Type::AlwaysFalsy | Type::AlwaysTruthy, _) => { + target.is_equivalent_to(db, Type::object(db)) + } + + // These clauses handle type variants that include function literals. A function + // literal is the subtype of itself, and not of any other function literal. However, + // our representation of a function literal includes any specialization that should be + // applied to the signature. Different specializations of the same function literal are + // only subtypes of each other if they result in the same signature. + (Type::FunctionLiteral(self_function), Type::FunctionLiteral(target_function)) => { + self_function.is_subtype_of(db, target_function) + } + (Type::BoundMethod(self_method), Type::BoundMethod(target_method)) => { + self_method.is_subtype_of(db, target_method) + } + (Type::MethodWrapper(self_method), Type::MethodWrapper(target_method)) => { + self_method.is_subtype_of(db, target_method) + } + + // No literal type is a subtype of any other literal type, unless they are the same + // type (which is handled above). This case is not necessary from a correctness + // perspective (the fallback cases below will handle it correctly), but it is important + // for performance of simplifying large unions of literal types. + ( + Type::StringLiteral(_) + | Type::IntLiteral(_) + | Type::BytesLiteral(_) + | Type::ClassLiteral(_) + | Type::FunctionLiteral(_) + | Type::ModuleLiteral(_), + Type::StringLiteral(_) + | Type::IntLiteral(_) + | Type::BytesLiteral(_) + | Type::ClassLiteral(_) + | Type::FunctionLiteral(_) + | Type::ModuleLiteral(_), + ) => false, + + // All `StringLiteral` types are a subtype of `LiteralString`. + (Type::StringLiteral(_), Type::LiteralString) => true, + + // Except for the special `LiteralString` case above, + // most `Literal` types delegate to their instance fallbacks + // unless `self` is exactly equivalent to `target` (handled above) + ( + Type::StringLiteral(_) + | Type::LiteralString + | Type::BooleanLiteral(_) + | Type::IntLiteral(_) + | Type::BytesLiteral(_) + | Type::ModuleLiteral(_), + _, + ) => (self.literal_fallback_instance(db)) + .is_some_and(|instance| instance.is_subtype_of(db, target)), + + (Type::FunctionLiteral(self_function_literal), Type::Callable(_)) => { + self_function_literal + .into_callable_type(db) + .is_subtype_of(db, target) + } + + (Type::BoundMethod(self_bound_method), Type::Callable(_)) => self_bound_method + .into_callable_type(db) + .is_subtype_of(db, target), + + // A `FunctionLiteral` type is a single-valued type like the other literals handled above, + // so it also, for now, just delegates to its instance fallback. + (Type::FunctionLiteral(_), _) => KnownClass::FunctionType + .to_instance(db) + .is_subtype_of(db, target), + + // The same reasoning applies for these special callable types: + (Type::BoundMethod(_), _) => KnownClass::MethodType + .to_instance(db) + .is_subtype_of(db, target), + (Type::MethodWrapper(_), _) => KnownClass::WrapperDescriptorType + .to_instance(db) + .is_subtype_of(db, target), + (Type::WrapperDescriptor(_), _) => KnownClass::WrapperDescriptorType + .to_instance(db) + .is_subtype_of(db, target), + + (Type::Callable(self_callable), Type::Callable(other_callable)) => { + self_callable.is_subtype_of(db, other_callable) + } + + (Type::DataclassDecorator(_) | Type::DataclassTransformer(_), _) => { + // TODO: Implement subtyping using an equivalent `Callable` type. + false + } + + (Type::NominalInstance(_) | Type::ProtocolInstance(_), Type::Callable(_)) => { + let call_symbol = self.member(db, "__call__").symbol; + match call_symbol { + Symbol::Type(Type::BoundMethod(call_function), _) => call_function + .into_callable_type(db) + .is_subtype_of(db, target), + _ => false, + } + } + (Type::ProtocolInstance(left), Type::ProtocolInstance(right)) => { + left.is_subtype_of(db, right) + } + // A protocol instance can never be a subtype of a nominal type, with the *sole* exception of `object`. + (Type::ProtocolInstance(_), _) => false, + (_, Type::ProtocolInstance(protocol)) => self.satisfies_protocol(db, protocol), + + (Type::Callable(_), _) => { + // TODO: Implement subtyping between callable types and other types like + // function literals, bound methods, class literals, `type[]`, etc.) + false + } + + // A fully static heterogeneous tuple type `A` is a subtype of a fully static heterogeneous tuple type `B` + // iff the two tuple types have the same number of elements and each element-type in `A` is a subtype + // of the element-type at the same index in `B`. (Now say that 5 times fast.) + // + // For example: `tuple[bool, bool]` is a subtype of `tuple[int, int]`, + // but `tuple[bool, bool, bool]` is not a subtype of `tuple[int, int]` + (Type::Tuple(self_tuple), Type::Tuple(target_tuple)) => { + let self_elements = self_tuple.elements(db); + let target_elements = target_tuple.elements(db); + self_elements.len() == target_elements.len() + && self_elements.iter().zip(target_elements).all( + |(self_element, target_element)| { + self_element.is_subtype_of(db, *target_element) + }, + ) + } + + // `tuple[A, B, C]` is a subtype of `tuple[A | B | C, ...]` + (Type::Tuple(tuple), _) => tuple.homogeneous_supertype(db).is_subtype_of(db, target), + + (Type::BoundSuper(_), Type::BoundSuper(_)) => self.is_equivalent_to(db, target), + (Type::BoundSuper(_), _) => KnownClass::Super.to_instance(db).is_subtype_of(db, target), + + // `Literal[<class 'C'>]` is a subtype of `type[B]` if `C` is a subclass of `B`, + // since `type[B]` describes all possible runtime subclasses of the class object `B`. + (Type::ClassLiteral(class), Type::SubclassOf(target_subclass_ty)) => target_subclass_ty + .subclass_of() + .into_class() + .is_some_and(|target_class| class.is_subclass_of(db, None, target_class)), + (Type::GenericAlias(alias), Type::SubclassOf(target_subclass_ty)) => target_subclass_ty + .subclass_of() + .into_class() + .is_some_and(|target_class| { + ClassType::from(alias).is_subclass_of(db, target_class) + }), + + // This branch asks: given two types `type[T]` and `type[S]`, is `type[T]` a subtype of `type[S]`? + (Type::SubclassOf(self_subclass_ty), Type::SubclassOf(target_subclass_ty)) => { + self_subclass_ty.is_subtype_of(db, target_subclass_ty) + } + + (Type::ClassLiteral(class_literal), Type::Callable(_)) => { + if let Some(callable) = class_literal.into_callable(db) { + return callable.is_subtype_of(db, target); + } + false + } + + // `Literal[str]` is a subtype of `type` because the `str` class object is an instance of its metaclass `type`. + // `Literal[abc.ABC]` is a subtype of `abc.ABCMeta` because the `abc.ABC` class object + // is an instance of its metaclass `abc.ABCMeta`. + (Type::ClassLiteral(class), _) => { + class.metaclass_instance_type(db).is_subtype_of(db, target) + } + (Type::GenericAlias(alias), _) => ClassType::from(alias) + .metaclass_instance_type(db) + .is_subtype_of(db, target), + + // `type[str]` (== `SubclassOf("str")` in ty) describes all possible runtime subclasses + // of the class object `str`. It is a subtype of `type` (== `Instance("type")`) because `str` + // is an instance of `type`, and so all possible subclasses of `str` will also be instances of `type`. + // + // Similarly `type[enum.Enum]` is a subtype of `enum.EnumMeta` because `enum.Enum` + // is an instance of `enum.EnumMeta`. `type[Any]` and `type[Unknown]` do not participate in subtyping, + // however, as they are not fully static types. + (Type::SubclassOf(subclass_of_ty), _) => subclass_of_ty + .subclass_of() + .into_class() + .map(|class| class.metaclass_instance_type(db)) + .is_some_and(|metaclass_instance_type| { + metaclass_instance_type.is_subtype_of(db, target) + }), + + // For example: `Type::KnownInstance(KnownInstanceType::Type)` is a subtype of `Type::NominalInstance(_SpecialForm)`, + // because `Type::KnownInstance(KnownInstanceType::Type)` is a set with exactly one runtime value in it + // (the symbol `typing.Type`), and that symbol is known to be an instance of `typing._SpecialForm` at runtime. + (Type::KnownInstance(left), right) => { + left.instance_fallback(db).is_subtype_of(db, right) + } + + // `bool` is a subtype of `int`, because `bool` subclasses `int`, + // which means that all instances of `bool` are also instances of `int` + (Type::NominalInstance(self_instance), Type::NominalInstance(target_instance)) => { + self_instance.is_subtype_of(db, target_instance) + } + + (Type::PropertyInstance(_), _) => KnownClass::Property + .to_instance(db) + .is_subtype_of(db, target), + (_, Type::PropertyInstance(_)) => { + self.is_subtype_of(db, KnownClass::Property.to_instance(db)) + } + + // Other than the special cases enumerated above, `Instance` types and typevars are + // never subtypes of any other variants + (Type::NominalInstance(_) | Type::TypeVar(_), _) => false, + } + } + + /// Return true if this type is [assignable to] type `target`. + /// + /// [assignable to]: https://typing.python.org/en/latest/spec/concepts.html#the-assignable-to-or-consistent-subtyping-relation + pub(crate) fn is_assignable_to(self, db: &'db dyn Db, target: Type<'db>) -> bool { + if self.is_gradual_equivalent_to(db, target) { + return true; + } + + match (self, target) { + // Never can be assigned to any type. + (Type::Never, _) => true, + + // The dynamic type is assignable-to and assignable-from any type. + (Type::Dynamic(_), _) => true, + (_, Type::Dynamic(_)) => true, + + // All types are assignable to `object`. + // TODO this special case might be removable once the below cases are comprehensive + (_, Type::NominalInstance(instance)) if instance.class.is_object(db) => true, + + // In general, a TypeVar `T` is not assignable to a type `S` unless one of the two conditions is satisfied: + // 1. `T` is a bound TypeVar and `T`'s upper bound is assignable to `S`. + // TypeVars without an explicit upper bound are treated as having an implicit upper bound of `object`. + // 2. `T` is a constrained TypeVar and all of `T`'s constraints are assignable to `S`. + // + // However, there is one exception to this general rule: for any given typevar `T`, + // `T` will always be assignable to any union containing `T`. + // A similar rule applies in reverse to intersection types. + (Type::TypeVar(_), Type::Union(union)) if union.elements(db).contains(&self) => true, + (Type::Intersection(intersection), Type::TypeVar(_)) + if intersection.positive(db).contains(&target) => + { + true + } + (Type::Intersection(intersection), Type::TypeVar(_)) + if intersection.negative(db).contains(&target) => + { + false + } + + // A typevar is assignable to its upper bound, and to something similar to the union of + // its constraints. An unbound, unconstrained typevar has an implicit upper bound of + // `object` (which is handled above). + (Type::TypeVar(typevar), _) if typevar.bound_or_constraints(db).is_some() => { + match typevar.bound_or_constraints(db) { + None => unreachable!(), + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.is_assignable_to(db, target) + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_assignable_to(db, target)), + } + } + + // If the typevar is constrained, there must be multiple constraints, and the typevar + // might be specialized to any one of them. However, the constraints do not have to be + // disjoint, which means an lhs type might be assignable to all of the constraints. + (_, Type::TypeVar(typevar)) + if typevar.constraints(db).is_some_and(|constraints| { + constraints + .iter() + .all(|constraint| self.is_assignable_to(db, *constraint)) + }) => + { + true + } + + // A union is assignable to a type T iff every element of the union is assignable to T. + (Type::Union(union), ty) => union + .elements(db) + .iter() + .all(|&elem_ty| elem_ty.is_assignable_to(db, ty)), + + // A type T is assignable to a union iff T is assignable to any element of the union. + (ty, Type::Union(union)) => union + .elements(db) + .iter() + .any(|&elem_ty| ty.is_assignable_to(db, elem_ty)), + + // If both sides are intersections we need to handle the right side first + // (A & B & C) is assignable to (A & B) because the left is assignable to both A and B, + // but none of A, B, or C is assignable to (A & B). + // + // A type S is assignable to an intersection type T if + // S is assignable to all positive elements of T (e.g. `str & int` is assignable to `str & Any`), and + // S is disjoint from all negative elements of T (e.g. `int` is not assignable to Intersection[int, Not[Literal[1]]]). + (ty, Type::Intersection(intersection)) => { + intersection + .positive(db) + .iter() + .all(|&elem_ty| ty.is_assignable_to(db, elem_ty)) + && intersection + .negative(db) + .iter() + .all(|&neg_ty| ty.is_disjoint_from(db, neg_ty)) + } + + // An intersection type S is assignable to a type T if + // Any element of S is assignable to T (e.g. `A & B` is assignable to `A`) + // Negative elements do not have an effect on assignability - if S is assignable to T then S & ~P is also assignable to T. + (Type::Intersection(intersection), ty) => intersection + .positive(db) + .iter() + .any(|&elem_ty| elem_ty.is_assignable_to(db, ty)), + + // Other than the special cases checked above, no other types are assignable to a + // typevar, since there's no guarantee what type the typevar will be specialized to. + // (If the typevar is bounded, it might be specialized to a smaller type than the + // bound. This is true even if the bound is a final class, since the typevar can still + // be specialized to `Never`.) + (_, Type::TypeVar(_)) => false, + + // A tuple type S is assignable to a tuple type T if their lengths are the same, and + // each element of S is assignable to the corresponding element of T. + (Type::Tuple(self_tuple), Type::Tuple(target_tuple)) => { + let self_elements = self_tuple.elements(db); + let target_elements = target_tuple.elements(db); + self_elements.len() == target_elements.len() + && self_elements.iter().zip(target_elements).all( + |(self_element, target_element)| { + self_element.is_assignable_to(db, *target_element) + }, + ) + } + + // This special case is required because the left-hand side tuple might be a + // gradual type, so we can not rely on subtyping. This allows us to assign e.g. + // `tuple[Any, int]` to `tuple`. + // + // `tuple[A, B, C]` is assignable to `tuple[A | B | C, ...]` + (Type::Tuple(tuple), _) + if tuple.homogeneous_supertype(db).is_assignable_to(db, target) => + { + true + } + + // These clauses handle type variants that include function literals. A function + // literal is assignable to itself, and not to any other function literal. However, our + // representation of a function literal includes any specialization that should be + // applied to the signature. Different specializations of the same function literal are + // only assignable to each other if they result in the same signature. + (Type::FunctionLiteral(self_function), Type::FunctionLiteral(target_function)) => { + self_function.is_assignable_to(db, target_function) + } + (Type::BoundMethod(self_method), Type::BoundMethod(target_method)) => { + self_method.is_assignable_to(db, target_method) + } + (Type::MethodWrapper(self_method), Type::MethodWrapper(target_method)) => { + self_method.is_assignable_to(db, target_method) + } + + // `type[Any]` is assignable to any `type[...]` type, because `type[Any]` can + // materialize to any `type[...]` type. + (Type::SubclassOf(subclass_of_ty), Type::SubclassOf(_)) + if subclass_of_ty.is_dynamic() => + { + true + } + + (Type::ClassLiteral(class), Type::SubclassOf(_)) + if class + .iter_mro(db, None) + .any(class_base::ClassBase::is_dynamic) => + { + true + } + + // Every `type[...]` is assignable to `type` + (Type::SubclassOf(_), _) + if KnownClass::Type + .to_instance(db) + .is_assignable_to(db, target) => + { + true + } + + // All `type[...]` types are assignable to `type[Any]`, because `type[Any]` can + // materialize to any `type[...]` type. + // + // Every class literal type is also assignable to `type[Any]`, because the class + // literal type for a class `C` is a subtype of `type[C]`, and `type[C]` is assignable + // to `type[Any]`. + ( + Type::ClassLiteral(_) | Type::GenericAlias(_) | Type::SubclassOf(_), + Type::SubclassOf(target_subclass_of), + ) if target_subclass_of.is_dynamic() => true, + + // `type[Any]` is assignable to any type that `type[object]` is assignable to, because + // `type[Any]` can materialize to `type[object]`. + // + // `type[Any]` is also assignable to any subtype of `type[object]`, because all + // subtypes of `type[object]` are `type[...]` types (or `Never`), and `type[Any]` can + // materialize to any `type[...]` type (or to `type[Never]`, which is equivalent to + // `Never`.) + (Type::SubclassOf(subclass_of_ty), Type::NominalInstance(_)) + if subclass_of_ty.is_dynamic() + && (KnownClass::Type + .to_instance(db) + .is_assignable_to(db, target) + || target.is_subtype_of(db, KnownClass::Type.to_instance(db))) => + { + true + } + + // Any type that is assignable to `type[object]` is also assignable to `type[Any]`, + // because `type[Any]` can materialize to `type[object]`. + (Type::NominalInstance(_), Type::SubclassOf(subclass_of_ty)) + if subclass_of_ty.is_dynamic() + && self.is_assignable_to(db, KnownClass::Type.to_instance(db)) => + { + true + } + + (Type::NominalInstance(self_instance), Type::NominalInstance(target_instance)) => { + self_instance.is_assignable_to(db, target_instance) + } + + (Type::Callable(self_callable), Type::Callable(target_callable)) => { + self_callable.is_assignable_to(db, target_callable) + } + + (Type::NominalInstance(instance), Type::Callable(_)) + if instance.class.is_subclass_of_any_or_unknown(db) => + { + true + } + + (Type::NominalInstance(_) | Type::ProtocolInstance(_), Type::Callable(_)) => { + let call_symbol = self.member(db, "__call__").symbol; + match call_symbol { + Symbol::Type(Type::BoundMethod(call_function), _) => call_function + .into_callable_type(db) + .is_assignable_to(db, target), + _ => false, + } + } + + (Type::ClassLiteral(class_literal), Type::Callable(_)) => { + if let Some(callable) = class_literal.into_callable(db) { + return callable.is_assignable_to(db, target); + } + false + } + + (Type::FunctionLiteral(self_function_literal), Type::Callable(_)) => { + self_function_literal + .into_callable_type(db) + .is_assignable_to(db, target) + } + + (Type::BoundMethod(self_bound_method), Type::Callable(_)) => self_bound_method + .into_callable_type(db) + .is_assignable_to(db, target), + + (Type::ProtocolInstance(left), Type::ProtocolInstance(right)) => { + left.is_assignable_to(db, right) + } + // Other than the dynamic types such as `Any`/`Unknown`/`Todo` handled above, + // a protocol instance can never be assignable to a nominal type, + // with the *sole* exception of `object`. + (Type::ProtocolInstance(_), _) => false, + (_, Type::ProtocolInstance(protocol)) => self.satisfies_protocol(db, protocol), + + // TODO other types containing gradual forms + _ => self.is_subtype_of(db, target), + } + } + + /// Return true if this type is [equivalent to] type `other`. + /// + /// This method returns `false` if either `self` or `other` is not fully static. + /// + /// [equivalent to]: https://typing.python.org/en/latest/spec/glossary.html#term-equivalent + pub(crate) fn is_equivalent_to(self, db: &'db dyn Db, other: Type<'db>) -> bool { + // TODO equivalent but not identical types: TypedDicts, Protocols, type aliases, etc. + + match (self, other) { + (Type::Union(left), Type::Union(right)) => left.is_equivalent_to(db, right), + (Type::Intersection(left), Type::Intersection(right)) => { + left.is_equivalent_to(db, right) + } + (Type::Tuple(left), Type::Tuple(right)) => left.is_equivalent_to(db, right), + (Type::FunctionLiteral(self_function), Type::FunctionLiteral(target_function)) => { + self_function.is_equivalent_to(db, target_function) + } + (Type::BoundMethod(self_method), Type::BoundMethod(target_method)) => { + self_method.is_equivalent_to(db, target_method) + } + (Type::MethodWrapper(self_method), Type::MethodWrapper(target_method)) => { + self_method.is_equivalent_to(db, target_method) + } + (Type::Callable(left), Type::Callable(right)) => left.is_equivalent_to(db, right), + (Type::NominalInstance(left), Type::NominalInstance(right)) => { + left.is_equivalent_to(db, right) + } + (Type::ProtocolInstance(left), Type::ProtocolInstance(right)) => { + left.is_equivalent_to(db, right) + } + (Type::ProtocolInstance(protocol), nominal @ Type::NominalInstance(n)) + | (nominal @ Type::NominalInstance(n), Type::ProtocolInstance(protocol)) => { + n.class.is_object(db) && protocol.normalized(db) == nominal + } + _ => self == other && self.is_fully_static(db) && other.is_fully_static(db), + } + } + + /// Returns true if this type and `other` are gradual equivalent. + /// + /// > Two gradual types `A` and `B` are equivalent + /// > (that is, the same gradual type, not merely consistent with one another) + /// > if and only if all materializations of `A` are also materializations of `B`, + /// > and all materializations of `B` are also materializations of `A`. + /// > + /// > — [Summary of type relations] + /// + /// This powers the `assert_type()` directive. + /// + /// [Summary of type relations]: https://typing.python.org/en/latest/spec/concepts.html#summary-of-type-relations + pub(crate) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Type<'db>) -> bool { + if self == other { + return true; + } + + match (self, other) { + (Type::Dynamic(_), Type::Dynamic(_)) => true, + + (Type::SubclassOf(first), Type::SubclassOf(second)) => { + match (first.subclass_of(), second.subclass_of()) { + (first, second) if first == second => true, + (SubclassOfInner::Dynamic(_), SubclassOfInner::Dynamic(_)) => true, + _ => false, + } + } + + (Type::NominalInstance(first), Type::NominalInstance(second)) => { + first.is_gradual_equivalent_to(db, second) + } + + (Type::Tuple(first), Type::Tuple(second)) => first.is_gradual_equivalent_to(db, second), + + (Type::Union(first), Type::Union(second)) => first.is_gradual_equivalent_to(db, second), + + (Type::Intersection(first), Type::Intersection(second)) => { + first.is_gradual_equivalent_to(db, second) + } + + (Type::FunctionLiteral(self_function), Type::FunctionLiteral(target_function)) => { + self_function.is_gradual_equivalent_to(db, target_function) + } + (Type::BoundMethod(self_method), Type::BoundMethod(target_method)) => { + self_method.is_gradual_equivalent_to(db, target_method) + } + (Type::MethodWrapper(self_method), Type::MethodWrapper(target_method)) => { + self_method.is_gradual_equivalent_to(db, target_method) + } + (Type::Callable(first), Type::Callable(second)) => { + first.is_gradual_equivalent_to(db, second) + } + + (Type::ProtocolInstance(first), Type::ProtocolInstance(second)) => { + first.is_gradual_equivalent_to(db, second) + } + (Type::ProtocolInstance(protocol), nominal @ Type::NominalInstance(n)) + | (nominal @ Type::NominalInstance(n), Type::ProtocolInstance(protocol)) => { + n.class.is_object(db) && protocol.normalized(db) == nominal + } + _ => false, + } + } + + /// Return true if this type and `other` have no common elements. + /// + /// Note: This function aims to have no false positives, but might return + /// wrong `false` answers in some cases. + pub(crate) fn is_disjoint_from(self, db: &'db dyn Db, other: Type<'db>) -> bool { + match (self, other) { + (Type::Never, _) | (_, Type::Never) => true, + + (Type::Dynamic(_), _) | (_, Type::Dynamic(_)) => false, + + // A typevar is never disjoint from itself, since all occurrences of the typevar must + // be specialized to the same type. (This is an important difference between typevars + // and `Any`!) Different typevars might be disjoint, depending on their bounds and + // constraints, which are handled below. + (Type::TypeVar(self_typevar), Type::TypeVar(other_typevar)) + if self_typevar == other_typevar => + { + false + } + + (tvar @ Type::TypeVar(_), Type::Intersection(intersection)) + | (Type::Intersection(intersection), tvar @ Type::TypeVar(_)) + if intersection.negative(db).contains(&tvar) => + { + true + } + + // An unbounded typevar is never disjoint from any other type, since it might be + // specialized to any type. A bounded typevar is not disjoint from its bound, and is + // only disjoint from other types if its bound is. A constrained typevar is disjoint + // from a type if all of its constraints are. + (Type::TypeVar(typevar), other) | (other, Type::TypeVar(typevar)) => { + match typevar.bound_or_constraints(db) { + None => false, + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.is_disjoint_from(db, other) + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_disjoint_from(db, other)), + } + } + + (Type::Union(union), other) | (other, Type::Union(union)) => union + .elements(db) + .iter() + .all(|e| e.is_disjoint_from(db, other)), + + // If we have two intersections, we test the positive elements of each one against the other intersection + // Negative elements need a positive element on the other side in order to be disjoint. + // This is similar to what would happen if we tried to build a new intersection that combines the two + (Type::Intersection(self_intersection), Type::Intersection(other_intersection)) => { + self_intersection + .positive(db) + .iter() + .any(|p| p.is_disjoint_from(db, other)) + || other_intersection + .positive(db) + .iter() + .any(|p: &Type<'_>| p.is_disjoint_from(db, self)) + } + + (Type::Intersection(intersection), other) + | (other, Type::Intersection(intersection)) => { + intersection + .positive(db) + .iter() + .any(|p| p.is_disjoint_from(db, other)) + // A & B & Not[C] is disjoint from C + || intersection + .negative(db) + .iter() + .any(|&neg_ty| other.is_subtype_of(db, neg_ty)) + } + + // any single-valued type is disjoint from another single-valued type + // iff the two types are nonequal + ( + left @ (Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::ModuleLiteral(..) + | Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::KnownInstance(..)), + right @ (Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::ModuleLiteral(..) + | Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::KnownInstance(..)), + ) => left != right, + + // One tuple type can be a subtype of another tuple type, + // but we know for sure that any given tuple type is disjoint from all single-valued types + ( + Type::Tuple(..), + Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::ModuleLiteral(..) + | Type::BooleanLiteral(..) + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::DataclassDecorator(..) + | Type::DataclassTransformer(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::LiteralString, + ) + | ( + Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::ModuleLiteral(..) + | Type::BooleanLiteral(..) + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::DataclassDecorator(..) + | Type::DataclassTransformer(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::LiteralString, + Type::Tuple(..), + ) => true, + + (Type::SubclassOf(subclass_of_ty), Type::ClassLiteral(class_b)) + | (Type::ClassLiteral(class_b), Type::SubclassOf(subclass_of_ty)) => { + match subclass_of_ty.subclass_of() { + SubclassOfInner::Dynamic(_) => false, + SubclassOfInner::Class(class_a) => !class_b.is_subclass_of(db, None, class_a), + } + } + + (Type::SubclassOf(subclass_of_ty), Type::GenericAlias(alias_b)) + | (Type::GenericAlias(alias_b), Type::SubclassOf(subclass_of_ty)) => { + match subclass_of_ty.subclass_of() { + SubclassOfInner::Dynamic(_) => false, + SubclassOfInner::Class(class_a) => { + !ClassType::from(alias_b).is_subclass_of(db, class_a) + } + } + } + + ( + Type::SubclassOf(_), + Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::LiteralString + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::ModuleLiteral(..), + ) + | ( + Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::LiteralString + | Type::BytesLiteral(..) + | Type::FunctionLiteral(..) + | Type::BoundMethod(..) + | Type::MethodWrapper(..) + | Type::WrapperDescriptor(..) + | Type::ModuleLiteral(..), + Type::SubclassOf(_), + ) => true, + + (Type::AlwaysTruthy, ty) | (ty, Type::AlwaysTruthy) => { + // `Truthiness::Ambiguous` may include `AlwaysTrue` as a subset, so it's not guaranteed to be disjoint. + // Thus, they are only disjoint if `ty.bool() == AlwaysFalse`. + ty.bool(db).is_always_false() + } + (Type::AlwaysFalsy, ty) | (ty, Type::AlwaysFalsy) => { + // Similarly, they are only disjoint if `ty.bool() == AlwaysTrue`. + ty.bool(db).is_always_true() + } + + (Type::ProtocolInstance(left), Type::ProtocolInstance(right)) => { + left.is_disjoint_from(db, right) + } + + // TODO: we could also consider `protocol` to be disjoint from `nominal` if `nominal` + // has the right member but the type of its member is disjoint from the type of the + // member on `protocol`. + (Type::ProtocolInstance(protocol), nominal @ Type::NominalInstance(n)) + | (nominal @ Type::NominalInstance(n), Type::ProtocolInstance(protocol)) => { + n.class.is_final(db) && !nominal.satisfies_protocol(db, protocol) + } + + ( + ty @ (Type::LiteralString + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::BooleanLiteral(..) + | Type::ClassLiteral(..) + | Type::FunctionLiteral(..) + | Type::ModuleLiteral(..) + | Type::GenericAlias(..) + | Type::IntLiteral(..)), + Type::ProtocolInstance(protocol), + ) + | ( + Type::ProtocolInstance(protocol), + ty @ (Type::LiteralString + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::BooleanLiteral(..) + | Type::ClassLiteral(..) + | Type::FunctionLiteral(..) + | Type::ModuleLiteral(..) + | Type::GenericAlias(..) + | Type::IntLiteral(..)), + ) => !ty.satisfies_protocol(db, protocol), + + (Type::ProtocolInstance(protocol), Type::KnownInstance(known_instance)) + | (Type::KnownInstance(known_instance), Type::ProtocolInstance(protocol)) => { + !known_instance + .instance_fallback(db) + .satisfies_protocol(db, protocol) + } + + (Type::Callable(_), Type::ProtocolInstance(_)) + | (Type::ProtocolInstance(_), Type::Callable(_)) => { + // TODO disjointness between `Callable` and `ProtocolInstance` + false + } + + (Type::Tuple(..), Type::ProtocolInstance(..)) + | (Type::ProtocolInstance(..), Type::Tuple(..)) => { + // Currently we do not make any general assumptions about the disjointness of a `Tuple` type + // and a `ProtocolInstance` type because a `Tuple` type can be an instance of a tuple + // subclass. + // + // TODO when we capture the types of the protocol members, we can improve on this. + false + } + + // for `type[Any]`/`type[Unknown]`/`type[Todo]`, we know the type cannot be any larger than `type`, + // so although the type is dynamic we can still determine disjointedness in some situations + (Type::SubclassOf(subclass_of_ty), other) + | (other, Type::SubclassOf(subclass_of_ty)) => match subclass_of_ty.subclass_of() { + SubclassOfInner::Dynamic(_) => { + KnownClass::Type.to_instance(db).is_disjoint_from(db, other) + } + SubclassOfInner::Class(class) => class + .metaclass_instance_type(db) + .is_disjoint_from(db, other), + }, + + (Type::KnownInstance(known_instance), Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::KnownInstance(known_instance)) => { + !known_instance.is_instance_of(db, instance.class) + } + + (known_instance_ty @ Type::KnownInstance(_), Type::Tuple(tuple)) + | (Type::Tuple(tuple), known_instance_ty @ Type::KnownInstance(_)) => { + known_instance_ty.is_disjoint_from(db, tuple.homogeneous_supertype(db)) + } + + (Type::BooleanLiteral(..), Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::BooleanLiteral(..)) => { + // A `Type::BooleanLiteral()` must be an instance of exactly `bool` + // (it cannot be an instance of a `bool` subclass) + !KnownClass::Bool.is_subclass_of(db, instance.class) + } + + (Type::BooleanLiteral(..), _) | (_, Type::BooleanLiteral(..)) => true, + + (Type::IntLiteral(..), Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::IntLiteral(..)) => { + // A `Type::IntLiteral()` must be an instance of exactly `int` + // (it cannot be an instance of an `int` subclass) + !KnownClass::Int.is_subclass_of(db, instance.class) + } + + (Type::IntLiteral(..), _) | (_, Type::IntLiteral(..)) => true, + + (Type::StringLiteral(..), Type::LiteralString) + | (Type::LiteralString, Type::StringLiteral(..)) => false, + + (Type::StringLiteral(..) | Type::LiteralString, Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::StringLiteral(..) | Type::LiteralString) => { + // A `Type::StringLiteral()` or a `Type::LiteralString` must be an instance of exactly `str` + // (it cannot be an instance of a `str` subclass) + !KnownClass::Str.is_subclass_of(db, instance.class) + } + + (Type::LiteralString, Type::LiteralString) => false, + (Type::LiteralString, _) | (_, Type::LiteralString) => true, + + (Type::BytesLiteral(..), Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::BytesLiteral(..)) => { + // A `Type::BytesLiteral()` must be an instance of exactly `bytes` + // (it cannot be an instance of a `bytes` subclass) + !KnownClass::Bytes.is_subclass_of(db, instance.class) + } + + // A class-literal type `X` is always disjoint from an instance type `Y`, + // unless the type expressing "all instances of `Z`" is a subtype of of `Y`, + // where `Z` is `X`'s metaclass. + (Type::ClassLiteral(class), instance @ Type::NominalInstance(_)) + | (instance @ Type::NominalInstance(_), Type::ClassLiteral(class)) => !class + .metaclass_instance_type(db) + .is_subtype_of(db, instance), + (Type::GenericAlias(alias), instance @ Type::NominalInstance(_)) + | (instance @ Type::NominalInstance(_), Type::GenericAlias(alias)) => { + !ClassType::from(alias) + .metaclass_instance_type(db) + .is_subtype_of(db, instance) + } + + (Type::FunctionLiteral(..), Type::NominalInstance(instance)) + | (Type::NominalInstance(instance), Type::FunctionLiteral(..)) => { + // A `Type::FunctionLiteral()` must be an instance of exactly `types.FunctionType` + // (it cannot be an instance of a `types.FunctionType` subclass) + !KnownClass::FunctionType.is_subclass_of(db, instance.class) + } + + (Type::BoundMethod(_), other) | (other, Type::BoundMethod(_)) => KnownClass::MethodType + .to_instance(db) + .is_disjoint_from(db, other), + + (Type::MethodWrapper(_), other) | (other, Type::MethodWrapper(_)) => { + KnownClass::MethodWrapperType + .to_instance(db) + .is_disjoint_from(db, other) + } + + (Type::WrapperDescriptor(_), other) | (other, Type::WrapperDescriptor(_)) => { + KnownClass::WrapperDescriptorType + .to_instance(db) + .is_disjoint_from(db, other) + } + + (Type::Callable(_) | Type::FunctionLiteral(_), Type::Callable(_)) + | (Type::Callable(_), Type::FunctionLiteral(_)) => { + // No two callable types are ever disjoint because + // `(*args: object, **kwargs: object) -> Never` is a subtype of all fully static + // callable types. + false + } + + (Type::Callable(_), Type::StringLiteral(_) | Type::BytesLiteral(_)) + | (Type::StringLiteral(_) | Type::BytesLiteral(_), Type::Callable(_)) => { + // A callable type is disjoint from other literal types. For example, + // `Type::StringLiteral` must be an instance of exactly `str`, not a subclass + // of `str`, and `str` is not callable. The same applies to other literal types. + true + } + + ( + Type::Callable(_) | Type::DataclassDecorator(_) | Type::DataclassTransformer(_), + _, + ) + | ( + _, + Type::Callable(_) | Type::DataclassDecorator(_) | Type::DataclassTransformer(_), + ) => { + // TODO: Implement disjointness for general callable type with other types + false + } + + (Type::ModuleLiteral(..), other @ Type::NominalInstance(..)) + | (other @ Type::NominalInstance(..), Type::ModuleLiteral(..)) => { + // Modules *can* actually be instances of `ModuleType` subclasses + other.is_disjoint_from(db, KnownClass::ModuleType.to_instance(db)) + } + + (Type::NominalInstance(left), Type::NominalInstance(right)) => { + left.is_disjoint_from(db, right) + } + + (Type::Tuple(tuple), Type::Tuple(other_tuple)) => { + let self_elements = tuple.elements(db); + let other_elements = other_tuple.elements(db); + self_elements.len() != other_elements.len() + || self_elements + .iter() + .zip(other_elements) + .any(|(e1, e2)| e1.is_disjoint_from(db, *e2)) + } + + (Type::Tuple(tuple), instance @ Type::NominalInstance(_)) + | (instance @ Type::NominalInstance(_), Type::Tuple(tuple)) => { + instance.is_disjoint_from(db, tuple.homogeneous_supertype(db)) + } + + (Type::PropertyInstance(_), other) | (other, Type::PropertyInstance(_)) => { + KnownClass::Property + .to_instance(db) + .is_disjoint_from(db, other) + } + + (Type::BoundSuper(_), Type::BoundSuper(_)) => !self.is_equivalent_to(db, other), + (Type::BoundSuper(_), other) | (other, Type::BoundSuper(_)) => KnownClass::Super + .to_instance(db) + .is_disjoint_from(db, other), + } + } + + /// Returns true if the type does not contain any gradual forms (as a sub-part). + pub(crate) fn is_fully_static(&self, db: &'db dyn Db) -> bool { + match self { + Type::Dynamic(_) => false, + Type::Never + | Type::FunctionLiteral(..) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(..) + | Type::IntLiteral(_) + | Type::BooleanLiteral(_) + | Type::StringLiteral(_) + | Type::LiteralString + | Type::BytesLiteral(_) + | Type::KnownInstance(_) + | Type::AlwaysFalsy + | Type::AlwaysTruthy + | Type::PropertyInstance(_) => true, + + Type::ProtocolInstance(protocol) => protocol.is_fully_static(db), + + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => true, + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => bound.is_fully_static(db), + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_fully_static(db)), + }, + + Type::SubclassOf(subclass_of_ty) => subclass_of_ty.is_fully_static(), + Type::BoundSuper(bound_super) => { + !matches!(bound_super.pivot_class(db), ClassBase::Dynamic(_)) + && !matches!(bound_super.owner(db), SuperOwnerKind::Dynamic(_)) + } + Type::ClassLiteral(_) | Type::GenericAlias(_) | Type::NominalInstance(_) => { + // TODO: Ideally, we would iterate over the MRO of the class, check if all + // bases are fully static, and only return `true` if that is the case. + // + // This does not work yet, because we currently infer `Unknown` for some + // generic base classes that we don't understand yet. For example, `str` + // is defined as `class str(Sequence[str])` in typeshed and we currently + // compute its MRO as `(str, Unknown, object)`. This would make us think + // that `str` is a gradual type, which causes all sorts of downstream + // issues because it does not participate in equivalence/subtyping etc. + // + // Another problem is that we run into problems if we eagerly query the + // MRO of class literals here. I have not fully investigated this, but + // iterating over the MRO alone, without even acting on it, causes us to + // infer `Unknown` for many classes. + + true + } + Type::Union(union) => union.is_fully_static(db), + Type::Intersection(intersection) => intersection.is_fully_static(db), + // TODO: Once we support them, make sure that we return `false` for other types + // containing gradual forms such as `tuple[Any, ...]`. + // Conversely, make sure to return `true` for homogeneous tuples such as + // `tuple[int, ...]`, once we add support for them. + Type::Tuple(tuple) => tuple + .elements(db) + .iter() + .all(|elem| elem.is_fully_static(db)), + Type::Callable(callable) => callable.is_fully_static(db), + } + } + + /// Return true if there is just a single inhabitant for this type. + /// + /// Note: This function aims to have no false positives, but might return `false` + /// for more complicated types that are actually singletons. + pub(crate) fn is_singleton(self, db: &'db dyn Db) -> bool { + match self { + Type::Dynamic(_) + | Type::Never + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::LiteralString => { + // Note: The literal types included in this pattern are not true singletons. + // There can be multiple Python objects (at different memory locations) that + // are both of type Literal[345], for example. + false + } + + Type::ProtocolInstance(..) => { + // It *might* be possible to have a singleton protocol-instance type...? + // + // E.g.: + // + // ```py + // from typing import Protocol, Callable + // + // class WeirdAndWacky(Protocol): + // @property + // def __class__(self) -> Callable[[], None]: ... + // ``` + // + // `WeirdAndWacky` only has a single possible inhabitant: `None`! + // It is thus a singleton type. + // However, going out of our way to recognise it as such is probably not worth it. + // Such cases should anyway be exceedingly rare and/or contrived. + false + } + + // An unbounded, unconstrained typevar is not a singleton, because it can be + // specialized to a non-singleton type. A bounded typevar is not a singleton, even if + // the bound is a final singleton class, since it can still be specialized to `Never`. + // A constrained typevar is a singleton if all of its constraints are singletons. (Note + // that you cannot specialize a constrained typevar to a subtype of a constraint.) + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => false, + Some(TypeVarBoundOrConstraints::UpperBound(_)) => false, + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_singleton(db)), + }, + + // We eagerly transform `SubclassOf` to `ClassLiteral` for final types, so `SubclassOf` is never a singleton. + Type::SubclassOf(..) => false, + Type::BoundSuper(..) => false, + Type::BooleanLiteral(_) + | Type::FunctionLiteral(..) + | Type::WrapperDescriptor(..) + | Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::ModuleLiteral(..) => true, + Type::KnownInstance(known_instance) => { + // Nearly all `KnownInstance` types are singletons, but if a symbol could validly + // originate from either `typing` or `typing_extensions` then this is not guaranteed. + // E.g. `typing.Protocol` is equivalent to `typing_extensions.Protocol`, so both are treated + // as inhabiting the type `KnownInstanceType::Protocol` in our model, but they are actually + // distinct symbols at different memory addresses at runtime. + !(known_instance.check_module(KnownModule::Typing) + && known_instance.check_module(KnownModule::TypingExtensions)) + } + Type::Callable(_) => { + // A callable type is never a singleton because for any given signature, + // there could be any number of distinct objects that are all callable with that + // signature. + false + } + Type::BoundMethod(..) => { + // `BoundMethod` types are single-valued types, but not singleton types: + // ```pycon + // >>> class Foo: + // ... def bar(self): pass + // >>> f = Foo() + // >>> f.bar is f.bar + // False + // ``` + false + } + Type::MethodWrapper(_) => { + // Just a special case of `BoundMethod` really + // (this variant represents `f.__get__`, where `f` is any function) + false + } + Type::DataclassDecorator(_) | Type::DataclassTransformer(_) => false, + Type::NominalInstance(instance) => instance.is_singleton(db), + Type::PropertyInstance(_) => false, + Type::Tuple(..) => { + // The empty tuple is a singleton on CPython and PyPy, but not on other Python + // implementations such as GraalPy. Its *use* as a singleton is discouraged and + // should not be relied on for type narrowing, so we do not treat it as one. + // See: + // https://docs.python.org/3/reference/expressions.html#parenthesized-forms + false + } + Type::Union(..) => { + // A single-element union, where the sole element was a singleton, would itself + // be a singleton type. However, unions with length < 2 should never appear in + // our model due to [`UnionBuilder::build`]. + false + } + Type::Intersection(..) => { + // Here, we assume that all intersection types that are singletons would have + // been reduced to a different form via [`IntersectionBuilder::build`] by now. + // For example: + // + // bool & ~Literal[False] = Literal[True] + // None & (None | int) = None | None & int = None + // + false + } + Type::AlwaysTruthy | Type::AlwaysFalsy => false, + } + } + + /// Return true if this type is non-empty and all inhabitants of this type compare equal. + pub(crate) fn is_single_valued(self, db: &'db dyn Db) -> bool { + match self { + Type::FunctionLiteral(..) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::ModuleLiteral(..) + | Type::ClassLiteral(..) + | Type::GenericAlias(..) + | Type::IntLiteral(..) + | Type::BooleanLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::KnownInstance(..) => true, + + Type::ProtocolInstance(..) => { + // See comment in the `Type::ProtocolInstance` branch for `Type::is_singleton`. + false + } + + // An unbounded, unconstrained typevar is not single-valued, because it can be + // specialized to a multiple-valued type. A bounded typevar is not single-valued, even + // if the bound is a final single-valued class, since it can still be specialized to + // `Never`. A constrained typevar is single-valued if all of its constraints are + // single-valued. (Note that you cannot specialize a constrained typevar to a subtype + // of a constraint.) + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => false, + Some(TypeVarBoundOrConstraints::UpperBound(_)) => false, + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .elements(db) + .iter() + .all(|constraint| constraint.is_single_valued(db)), + }, + + Type::SubclassOf(..) => { + // TODO: Same comment as above for `is_singleton` + false + } + + Type::Tuple(tuple) => tuple + .elements(db) + .iter() + .all(|elem| elem.is_single_valued(db)), + + Type::NominalInstance(instance) => instance.is_single_valued(db), + + Type::BoundSuper(_) => { + // At runtime two super instances never compare equal, even if their arguments are identical. + false + } + + Type::Dynamic(_) + | Type::Never + | Type::Union(..) + | Type::Intersection(..) + | Type::LiteralString + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::Callable(_) + | Type::PropertyInstance(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) => false, + } + } + + /// This function is roughly equivalent to `find_name_in_mro` as defined in the [descriptor guide] or + /// [`_PyType_Lookup`] in CPython's `Objects/typeobject.c`. It should typically be called through + /// [Type::class_member], unless it is known that `self` is a class-like type. This function returns + /// `None` if called on an instance-like type. + /// + /// [descriptor guide]: https://docs.python.org/3/howto/descriptor.html#invocation-from-an-instance + /// [`_PyType_Lookup`]: https://github.com/python/cpython/blob/e285232c76606e3be7bf216efb1be1e742423e4b/Objects/typeobject.c#L5223 + fn find_name_in_mro(&self, db: &'db dyn Db, name: &str) -> Option<SymbolAndQualifiers<'db>> { + self.find_name_in_mro_with_policy(db, name, MemberLookupPolicy::default()) + } + + fn find_name_in_mro_with_policy( + &self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + ) -> Option<SymbolAndQualifiers<'db>> { + match self { + Type::Union(union) => Some(union.map_with_boundness_and_qualifiers(db, |elem| { + elem.find_name_in_mro_with_policy(db, name, policy) + // If some elements are classes, and some are not, we simply fall back to `Unbound` for the non-class + // elements instead of short-circuiting the whole result to `None`. We would need a more detailed + // return type otherwise, and since `find_name_in_mro` is usually called via `class_member`, this is + // not a problem. + .unwrap_or_default() + })), + Type::Intersection(inter) => { + Some(inter.map_with_boundness_and_qualifiers(db, |elem| { + elem.find_name_in_mro_with_policy(db, name, policy) + // Fall back to Unbound, similar to the union case (see above). + .unwrap_or_default() + })) + } + + Type::Dynamic(_) | Type::Never => Some(Symbol::bound(self).into()), + + Type::ClassLiteral(class) => { + match (class.known(db), name) { + (Some(KnownClass::FunctionType), "__get__") => Some( + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::FunctionTypeDunderGet, + )) + .into(), + ), + (Some(KnownClass::FunctionType), "__set__" | "__delete__") => { + // Hard code this knowledge, as we look up `__set__` and `__delete__` on `FunctionType` often. + Some(Symbol::Unbound.into()) + } + (Some(KnownClass::Property), "__get__") => Some( + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::PropertyDunderGet, + )) + .into(), + ), + (Some(KnownClass::Property), "__set__") => Some( + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::PropertyDunderSet, + )) + .into(), + ), + + _ => Some(class.class_member(db, name, policy)), + } + } + + Type::GenericAlias(alias) => { + Some(ClassType::from(*alias).class_member(db, name, policy)) + } + + Type::SubclassOf(subclass_of_ty) => { + subclass_of_ty.find_name_in_mro_with_policy(db, name, policy) + } + + // Note: `super(pivot, owner).__class__` is `builtins.super`, not the owner's class. + // `BoundSuper` should look up the name in the MRO of `builtins.super`. + Type::BoundSuper(_) => KnownClass::Super + .to_class_literal(db) + .find_name_in_mro_with_policy(db, name, policy), + + // We eagerly normalize type[object], i.e. Type::SubclassOf(object) to `type`, + // i.e. Type::NominalInstance(type). So looking up a name in the MRO of + // `Type::NominalInstance(type)` is equivalent to looking up the name in the + // MRO of the class `object`. + Type::NominalInstance(instance) if instance.class.is_known(db, KnownClass::Type) => { + KnownClass::Object + .to_class_literal(db) + .find_name_in_mro_with_policy(db, name, policy) + } + + Type::FunctionLiteral(_) + | Type::Callable(_) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::KnownInstance(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::IntLiteral(_) + | Type::BooleanLiteral(_) + | Type::StringLiteral(_) + | Type::LiteralString + | Type::BytesLiteral(_) + | Type::Tuple(_) + | Type::TypeVar(_) + | Type::NominalInstance(_) + | Type::ProtocolInstance(_) + | Type::PropertyInstance(_) => None, + } + } + + /// Look up an attribute in the MRO of the meta-type of `self`. This returns class-level attributes + /// when called on an instance-like type, and metaclass attributes when called on a class-like type. + /// + /// Basically corresponds to `self.to_meta_type().find_name_in_mro(name)`, except for the handling + /// of union and intersection types. + fn class_member(self, db: &'db dyn Db, name: Name) -> SymbolAndQualifiers<'db> { + self.class_member_with_policy(db, name, MemberLookupPolicy::default()) + } + + #[salsa::tracked] + fn class_member_with_policy( + self, + db: &'db dyn Db, + name: Name, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + tracing::trace!("class_member: {}.{}", self.display(db), name); + match self { + Type::Union(union) => union.map_with_boundness_and_qualifiers(db, |elem| { + elem.class_member_with_policy(db, name.clone(), policy) + }), + Type::Intersection(inter) => inter.map_with_boundness_and_qualifiers(db, |elem| { + elem.class_member_with_policy(db, name.clone(), policy) + }), + _ => self + .to_meta_type(db) + .find_name_in_mro_with_policy(db, name.as_str(), policy) + .expect( + "`Type::find_name_in_mro()` should return `Some()` when called on a meta-type", + ), + } + } + + /// This function roughly corresponds to looking up an attribute in the `__dict__` of an object. + /// For instance-like types, this goes through the classes MRO and discovers attribute assignments + /// in methods, as well as class-body declarations that we consider to be evidence for the presence + /// of an instance attribute. + /// + /// For example, an instance of the following class has instance members `a` and `b`, but `c` is + /// just a class attribute that would not be discovered by this method: + /// ```py + /// class C: + /// a: int + /// + /// c = 1 + /// + /// def __init__(self): + /// self.b: str = "a" + /// ``` + fn instance_member(&self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + match self { + Type::Union(union) => { + union.map_with_boundness_and_qualifiers(db, |elem| elem.instance_member(db, name)) + } + + Type::Intersection(intersection) => intersection + .map_with_boundness_and_qualifiers(db, |elem| elem.instance_member(db, name)), + + Type::Dynamic(_) | Type::Never => Symbol::bound(self).into(), + + Type::NominalInstance(instance) => instance.class.instance_member(db, name), + + Type::ProtocolInstance(protocol) => protocol.instance_member(db, name), + + Type::FunctionLiteral(_) => KnownClass::FunctionType + .to_instance(db) + .instance_member(db, name), + + Type::BoundMethod(_) => KnownClass::MethodType + .to_instance(db) + .instance_member(db, name), + Type::MethodWrapper(_) => KnownClass::MethodWrapperType + .to_instance(db) + .instance_member(db, name), + Type::WrapperDescriptor(_) => KnownClass::WrapperDescriptorType + .to_instance(db) + .instance_member(db, name), + Type::DataclassDecorator(_) => KnownClass::FunctionType + .to_instance(db) + .instance_member(db, name), + Type::Callable(_) | Type::DataclassTransformer(_) => { + KnownClass::Object.to_instance(db).instance_member(db, name) + } + + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => KnownClass::Object.to_instance(db).instance_member(db, name), + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.instance_member(db, name) + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => constraints + .map_with_boundness_and_qualifiers(db, |constraint| { + constraint.instance_member(db, name) + }), + }, + + Type::IntLiteral(_) => KnownClass::Int.to_instance(db).instance_member(db, name), + Type::BooleanLiteral(_) => KnownClass::Bool.to_instance(db).instance_member(db, name), + Type::StringLiteral(_) | Type::LiteralString => { + KnownClass::Str.to_instance(db).instance_member(db, name) + } + Type::BytesLiteral(_) => KnownClass::Bytes.to_instance(db).instance_member(db, name), + Type::Tuple(tuple) => tuple.homogeneous_supertype(db).instance_member(db, name), + + Type::AlwaysTruthy | Type::AlwaysFalsy => Type::object(db).instance_member(db, name), + Type::ModuleLiteral(_) => KnownClass::ModuleType + .to_instance(db) + .instance_member(db, name), + + Type::KnownInstance(_) => Symbol::Unbound.into(), + + Type::PropertyInstance(_) => KnownClass::Property + .to_instance(db) + .instance_member(db, name), + + // Note: `super(pivot, owner).__dict__` refers to the `__dict__` of the `builtins.super` instance, + // not that of the owner. + // This means we should only look up instance members defined on the `builtins.super()` instance itself. + // If you want to look up a member in the MRO of the `super`'s owner, + // refer to [`Type::member`] instead. + Type::BoundSuper(_) => KnownClass::Super.to_instance(db).instance_member(db, name), + + // TODO: we currently don't model the fact that class literals and subclass-of types have + // a `__dict__` that is filled with class level attributes. Modeling this is currently not + // required, as `instance_member` is only called for instance-like types through `member`, + // but we might want to add this in the future. + Type::ClassLiteral(_) | Type::GenericAlias(_) | Type::SubclassOf(_) => { + Symbol::Unbound.into() + } + } + } + + /// Access an attribute of this type without invoking the descriptor protocol. This + /// method corresponds to `inspect.getattr_static(<object of type 'self'>, name)`. + /// + /// See also: [`Type::member`] + fn static_member(&self, db: &'db dyn Db, name: &str) -> Symbol<'db> { + if let Type::ModuleLiteral(module) = self { + module.static_member(db, name) + } else if let symbol @ Symbol::Type(_, _) = self.class_member(db, name.into()).symbol { + symbol + } else if let Some(symbol @ Symbol::Type(_, _)) = + self.find_name_in_mro(db, name).map(|inner| inner.symbol) + { + symbol + } else { + self.instance_member(db, name).symbol + } + } + + /// Look up `__get__` on the meta-type of self, and call it with the arguments `self`, `instance`, + /// and `owner`. `__get__` is different than other dunder methods in that it is not looked up using + /// the descriptor protocol itself. + /// + /// In addition to the return type of `__get__`, this method also returns the *kind* of attribute + /// that `self` represents: (1) a data descriptor or (2) a non-data descriptor / normal attribute. + /// + /// If `__get__` is not defined on the meta-type, this method returns `None`. + #[salsa::tracked] + pub(crate) fn try_call_dunder_get( + self, + db: &'db dyn Db, + instance: Type<'db>, + owner: Type<'db>, + ) -> Option<(Type<'db>, AttributeKind)> { + tracing::trace!( + "try_call_dunder_get: {}, {}, {}", + self.display(db), + instance.display(db), + owner.display(db) + ); + let descr_get = self.class_member(db, "__get__".into()).symbol; + + if let Symbol::Type(descr_get, descr_get_boundness) = descr_get { + let return_ty = descr_get + .try_call(db, &CallArgumentTypes::positional([self, instance, owner])) + .map(|bindings| { + if descr_get_boundness == Boundness::Bound { + bindings.return_type(db) + } else { + UnionType::from_elements(db, [bindings.return_type(db), self]) + } + }) + .ok()?; + + let descriptor_kind = if self.class_member(db, "__set__".into()).symbol.is_unbound() + && self + .class_member(db, "__delete__".into()) + .symbol + .is_unbound() + { + AttributeKind::NormalOrNonDataDescriptor + } else { + AttributeKind::DataDescriptor + }; + + Some((return_ty, descriptor_kind)) + } else { + None + } + } + + /// Look up `__get__` on the meta-type of `attribute`, and call it with `attribute`, `instance`, + /// and `owner` as arguments. This method exists as a separate step as we need to handle unions + /// and intersections explicitly. + fn try_call_dunder_get_on_attribute( + db: &'db dyn Db, + attribute: SymbolAndQualifiers<'db>, + instance: Type<'db>, + owner: Type<'db>, + ) -> (SymbolAndQualifiers<'db>, AttributeKind) { + match attribute { + // This branch is not strictly needed, but it short-circuits the lookup of various dunder + // methods and calls that would otherwise be made. + // + // Note that attribute accesses on dynamic types always succeed. For this reason, they also + // have `__get__`, `__set__`, and `__delete__` methods and are therefore considered to be + // data descriptors. + // + // The same is true for `Never`. + SymbolAndQualifiers { + symbol: Symbol::Type(Type::Dynamic(_) | Type::Never, _), + qualifiers: _, + } => (attribute, AttributeKind::DataDescriptor), + + SymbolAndQualifiers { + symbol: Symbol::Type(Type::Union(union), boundness), + qualifiers, + } => ( + union + .map_with_boundness(db, |elem| { + Symbol::Type( + elem.try_call_dunder_get(db, instance, owner) + .map_or(*elem, |(ty, _)| ty), + boundness, + ) + }) + .with_qualifiers(qualifiers), + // TODO: avoid the duplication here: + if union.elements(db).iter().all(|elem| { + elem.try_call_dunder_get(db, instance, owner) + .is_some_and(|(_, kind)| kind.is_data()) + }) { + AttributeKind::DataDescriptor + } else { + AttributeKind::NormalOrNonDataDescriptor + }, + ), + + SymbolAndQualifiers { + symbol: Symbol::Type(Type::Intersection(intersection), boundness), + qualifiers, + } => ( + intersection + .map_with_boundness(db, |elem| { + Symbol::Type( + elem.try_call_dunder_get(db, instance, owner) + .map_or(*elem, |(ty, _)| ty), + boundness, + ) + }) + .with_qualifiers(qualifiers), + // TODO: Discover data descriptors in intersections. + AttributeKind::NormalOrNonDataDescriptor, + ), + + SymbolAndQualifiers { + symbol: Symbol::Type(attribute_ty, boundness), + qualifiers: _, + } => { + if let Some((return_ty, attribute_kind)) = + attribute_ty.try_call_dunder_get(db, instance, owner) + { + (Symbol::Type(return_ty, boundness).into(), attribute_kind) + } else { + (attribute, AttributeKind::NormalOrNonDataDescriptor) + } + } + + _ => (attribute, AttributeKind::NormalOrNonDataDescriptor), + } + } + + /// Implementation of the descriptor protocol. + /// + /// This method roughly performs the following steps: + /// + /// - Look up the attribute `name` on the meta-type of `self`. Call the result `meta_attr`. + /// - Call `__get__` on the meta-type of `meta_attr`, if it exists. If the call succeeds, + /// replace `meta_attr` with the result of the call. Also check if `meta_attr` is a *data* + /// descriptor by testing if `__set__` or `__delete__` exist. + /// - If `meta_attr` is a data descriptor, return it. + /// - Otherwise, if `fallback` is bound, return `fallback`. + /// - Otherwise, return `meta_attr`. + /// + /// In addition to that, we also handle various cases of possibly-unbound symbols and fall + /// back to lower-precedence stages of the descriptor protocol by building union types. + fn invoke_descriptor_protocol( + self, + db: &'db dyn Db, + name: &str, + fallback: SymbolAndQualifiers<'db>, + policy: InstanceFallbackShadowsNonDataDescriptor, + member_policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + let ( + SymbolAndQualifiers { + symbol: meta_attr, + qualifiers: meta_attr_qualifiers, + }, + meta_attr_kind, + ) = Self::try_call_dunder_get_on_attribute( + db, + self.class_member_with_policy(db, name.into(), member_policy), + self, + self.to_meta_type(db), + ); + + let SymbolAndQualifiers { + symbol: fallback, + qualifiers: fallback_qualifiers, + } = fallback; + + match (meta_attr, meta_attr_kind, fallback) { + // The fallback type is unbound, so we can just return `meta_attr` unconditionally, + // no matter if it's data descriptor, a non-data descriptor, or a normal attribute. + (meta_attr @ Symbol::Type(_, _), _, Symbol::Unbound) => { + meta_attr.with_qualifiers(meta_attr_qualifiers) + } + + // `meta_attr` is the return type of a data descriptor and definitely bound, so we + // return it. + (meta_attr @ Symbol::Type(_, Boundness::Bound), AttributeKind::DataDescriptor, _) => { + meta_attr.with_qualifiers(meta_attr_qualifiers) + } + + // `meta_attr` is the return type of a data descriptor, but the attribute on the + // meta-type is possibly-unbound. This means that we "fall through" to the next + // stage of the descriptor protocol and union with the fallback type. + ( + Symbol::Type(meta_attr_ty, Boundness::PossiblyUnbound), + AttributeKind::DataDescriptor, + Symbol::Type(fallback_ty, fallback_boundness), + ) => Symbol::Type( + UnionType::from_elements(db, [meta_attr_ty, fallback_ty]), + fallback_boundness, + ) + .with_qualifiers(meta_attr_qualifiers.union(fallback_qualifiers)), + + // `meta_attr` is *not* a data descriptor. This means that the `fallback` type has + // now the highest priority. However, we only return the pure `fallback` type if the + // policy allows it. When invoked on class objects, the policy is set to `Yes`, which + // means that class-level attributes (the fallback) can shadow non-data descriptors + // on metaclasses. However, for instances, the policy is set to `No`, because we do + // allow instance-level attributes to shadow class-level non-data descriptors. This + // would require us to statically infer if an instance attribute is always set, which + // is something we currently don't attempt to do. + ( + Symbol::Type(_, _), + AttributeKind::NormalOrNonDataDescriptor, + fallback @ Symbol::Type(_, Boundness::Bound), + ) if policy == InstanceFallbackShadowsNonDataDescriptor::Yes => { + fallback.with_qualifiers(fallback_qualifiers) + } + + // `meta_attr` is *not* a data descriptor. The `fallback` symbol is either possibly + // unbound or the policy argument is `No`. In both cases, the `fallback` type does + // not completely shadow the non-data descriptor, so we build a union of the two. + ( + Symbol::Type(meta_attr_ty, meta_attr_boundness), + AttributeKind::NormalOrNonDataDescriptor, + Symbol::Type(fallback_ty, fallback_boundness), + ) => Symbol::Type( + UnionType::from_elements(db, [meta_attr_ty, fallback_ty]), + meta_attr_boundness.max(fallback_boundness), + ) + .with_qualifiers(meta_attr_qualifiers.union(fallback_qualifiers)), + + // If the attribute is not found on the meta-type, we simply return the fallback. + (Symbol::Unbound, _, fallback) => fallback.with_qualifiers(fallback_qualifiers), + } + } + + /// Access an attribute of this type, potentially invoking the descriptor protocol. + /// Corresponds to `getattr(<object of type 'self'>, name)`. + /// + /// See also: [`Type::static_member`] + /// + /// TODO: We should return a `Result` here to handle errors that can appear during attribute + /// lookup, like a failed `__get__` call on a descriptor. + #[must_use] + pub(crate) fn member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + self.member_lookup_with_policy(db, name.into(), MemberLookupPolicy::default()) + } + + /// Similar to [`Type::member`], but allows the caller to specify what policy should be used + /// when looking up attributes. See [`MemberLookupPolicy`] for more information. + #[salsa::tracked(cycle_fn=member_lookup_cycle_recover, cycle_initial=member_lookup_cycle_initial)] + fn member_lookup_with_policy( + self, + db: &'db dyn Db, + name: Name, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + tracing::trace!("member_lookup_with_policy: {}.{}", self.display(db), name); + if name == "__class__" { + return Symbol::bound(self.to_meta_type(db)).into(); + } + + let name_str = name.as_str(); + + match self { + Type::Union(union) => union + .map_with_boundness(db, |elem| { + elem.member_lookup_with_policy(db, name_str.into(), policy) + .symbol + }) + .into(), + + Type::Intersection(intersection) => intersection + .map_with_boundness(db, |elem| { + elem.member_lookup_with_policy(db, name_str.into(), policy) + .symbol + }) + .into(), + + Type::Dynamic(..) | Type::Never => Symbol::bound(self).into(), + + Type::FunctionLiteral(function) if name == "__get__" => Symbol::bound( + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet(function)), + ) + .into(), + Type::FunctionLiteral(function) if name == "__call__" => Symbol::bound( + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderCall(function)), + ) + .into(), + Type::PropertyInstance(property) if name == "__get__" => Symbol::bound( + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet(property)), + ) + .into(), + Type::PropertyInstance(property) if name == "__set__" => Symbol::bound( + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet(property)), + ) + .into(), + Type::StringLiteral(literal) if name == "startswith" => Symbol::bound( + Type::MethodWrapper(MethodWrapperKind::StrStartswith(literal)), + ) + .into(), + + Type::ClassLiteral(class) + if name == "__get__" && class.is_known(db, KnownClass::FunctionType) => + { + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::FunctionTypeDunderGet, + )) + .into() + } + Type::ClassLiteral(class) + if name == "__get__" && class.is_known(db, KnownClass::Property) => + { + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::PropertyDunderGet, + )) + .into() + } + Type::ClassLiteral(class) + if name == "__set__" && class.is_known(db, KnownClass::Property) => + { + Symbol::bound(Type::WrapperDescriptor( + WrapperDescriptorKind::PropertyDunderSet, + )) + .into() + } + Type::BoundMethod(bound_method) => match name_str { + "__self__" => Symbol::bound(bound_method.self_instance(db)).into(), + "__func__" => { + Symbol::bound(Type::FunctionLiteral(bound_method.function(db))).into() + } + _ => { + KnownClass::MethodType + .to_instance(db) + .member_lookup_with_policy(db, name.clone(), policy) + .or_fall_back_to(db, || { + // If an attribute is not available on the bound method object, + // it will be looked up on the underlying function object: + Type::FunctionLiteral(bound_method.function(db)) + .member_lookup_with_policy(db, name, policy) + }) + } + }, + Type::MethodWrapper(_) => KnownClass::MethodWrapperType + .to_instance(db) + .member_lookup_with_policy(db, name, policy), + Type::WrapperDescriptor(_) => KnownClass::WrapperDescriptorType + .to_instance(db) + .member_lookup_with_policy(db, name, policy), + Type::DataclassDecorator(_) => KnownClass::FunctionType + .to_instance(db) + .member_lookup_with_policy(db, name, policy), + + Type::Callable(_) | Type::DataclassTransformer(_) if name_str == "__call__" => { + Symbol::bound(self).into() + } + Type::Callable(_) | Type::DataclassTransformer(_) => KnownClass::Object + .to_instance(db) + .member_lookup_with_policy(db, name, policy), + + Type::NominalInstance(instance) + if matches!(name.as_str(), "major" | "minor") + && instance.class.is_known(db, KnownClass::VersionInfo) => + { + let python_version = Program::get(db).python_version(db); + let segment = if name == "major" { + python_version.major + } else { + python_version.minor + }; + Symbol::bound(Type::IntLiteral(segment.into())).into() + } + + Type::PropertyInstance(property) if name == "fget" => { + Symbol::bound(property.getter(db).unwrap_or(Type::none(db))).into() + } + Type::PropertyInstance(property) if name == "fset" => { + Symbol::bound(property.setter(db).unwrap_or(Type::none(db))).into() + } + + Type::IntLiteral(_) if matches!(name_str, "real" | "numerator") => { + Symbol::bound(self).into() + } + + Type::BooleanLiteral(bool_value) if matches!(name_str, "real" | "numerator") => { + Symbol::bound(Type::IntLiteral(i64::from(bool_value))).into() + } + + Type::ModuleLiteral(module) => module.static_member(db, name_str).into(), + + Type::AlwaysFalsy | Type::AlwaysTruthy => { + self.class_member_with_policy(db, name, policy) + } + + _ if policy.no_instance_fallback() => self.invoke_descriptor_protocol( + db, + name_str, + Symbol::Unbound.into(), + InstanceFallbackShadowsNonDataDescriptor::No, + policy, + ), + + Type::NominalInstance(..) + | Type::ProtocolInstance(..) + | Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::LiteralString + | Type::Tuple(..) + | Type::TypeVar(..) + | Type::KnownInstance(..) + | Type::PropertyInstance(..) + | Type::FunctionLiteral(..) => { + let fallback = self.instance_member(db, name_str); + + let result = self.invoke_descriptor_protocol( + db, + name_str, + fallback, + InstanceFallbackShadowsNonDataDescriptor::No, + policy, + ); + + let custom_getattr_result = || { + // Typeshed has a fake `__getattr__` on `types.ModuleType` to help out with + // dynamic imports. We explicitly hide it here to prevent arbitrary attributes + // from being available on modules. Same for `types.GenericAlias` - its + // `__getattr__` method will delegate to `__origin__` to allow looking up + // attributes on the original type. But in typeshed its return type is `Any`. + // It will need a special handling, so it remember the origin type to properly + // resolve the attribute. + if matches!( + self.into_nominal_instance() + .and_then(|instance| instance.class.known(db)), + Some(KnownClass::ModuleType | KnownClass::GenericAlias) + ) { + return Symbol::Unbound.into(); + } + + self.try_call_dunder( + db, + "__getattr__", + CallArgumentTypes::positional([Type::StringLiteral( + StringLiteralType::new(db, Box::from(name.as_str())), + )]), + ) + .map(|outcome| Symbol::bound(outcome.return_type(db))) + // TODO: Handle call errors here. + .unwrap_or(Symbol::Unbound) + .into() + }; + + match result { + member @ SymbolAndQualifiers { + symbol: Symbol::Type(_, Boundness::Bound), + qualifiers: _, + } => member, + member @ SymbolAndQualifiers { + symbol: Symbol::Type(_, Boundness::PossiblyUnbound), + qualifiers: _, + } => member.or_fall_back_to(db, custom_getattr_result), + SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers: _, + } => custom_getattr_result(), + } + } + + Type::ClassLiteral(..) | Type::GenericAlias(..) | Type::SubclassOf(..) => { + let class_attr_plain = self.find_name_in_mro_with_policy(db, name_str,policy).expect( + "Calling `find_name_in_mro` on class literals and subclass-of types should always return `Some`", + ); + + if name == "__mro__" { + return class_attr_plain; + } + + if self.is_subtype_of(db, KnownClass::Enum.to_subclass_of(db)) { + return SymbolAndQualifiers::todo("Attribute access on enum classes"); + } + + let class_attr_fallback = Self::try_call_dunder_get_on_attribute( + db, + class_attr_plain, + Type::none(db), + self, + ) + .0; + + self.invoke_descriptor_protocol( + db, + name_str, + class_attr_fallback, + InstanceFallbackShadowsNonDataDescriptor::Yes, + policy, + ) + } + + // Unlike other objects, `super` has a unique member lookup behavior. + // It's simpler than other objects: + // + // 1. Search for the attribute in the MRO, starting just after the pivot class. + // 2. If the attribute is a descriptor, invoke its `__get__` method. + Type::BoundSuper(bound_super) => { + let owner_attr = bound_super.find_name_in_mro_after_pivot(db, name_str, policy); + + bound_super + .try_call_dunder_get_on_attribute(db, owner_attr.clone()) + .unwrap_or(owner_attr) + } + } + } + + /// Resolves the boolean value of the type and falls back to [`Truthiness::Ambiguous`] if the type doesn't implement `__bool__` correctly. + /// + /// This method should only be used outside type checking or when evaluating if a type + /// is truthy or falsy in a context where Python doesn't make an implicit `bool` call. + /// Use [`try_bool`](Self::try_bool) for type checking or implicit `bool` calls. + pub(crate) fn bool(&self, db: &'db dyn Db) -> Truthiness { + self.try_bool_impl(db, true) + .unwrap_or_else(|err| err.fallback_truthiness()) + } + + /// Resolves the boolean value of a type. + /// + /// This is used to determine the value that would be returned + /// when `bool(x)` is called on an object `x`. + /// + /// Returns an error if the type doesn't implement `__bool__` correctly. + pub(crate) fn try_bool(&self, db: &'db dyn Db) -> Result<Truthiness, BoolError<'db>> { + self.try_bool_impl(db, false) + } + + /// Resolves the boolean value of a type. + /// + /// Setting `allow_short_circuit` to `true` allows the implementation to + /// early return if the bool value of any union variant is `Truthiness::Ambiguous`. + /// Early returning shows a 1-2% perf improvement on our benchmarks because + /// `bool` (which doesn't care about errors) is used heavily when evaluating statically known branches. + /// + /// An alternative to this flag is to implement a trait similar to Rust's `Try` trait. + /// The advantage of that is that it would allow collecting the errors as well. However, + /// it is significantly more complex and duplicating the logic into `bool` without the error + /// handling didn't show any significant performance difference to when using the `allow_short_circuit` flag. + #[inline] + fn try_bool_impl( + &self, + db: &'db dyn Db, + allow_short_circuit: bool, + ) -> Result<Truthiness, BoolError<'db>> { + let type_to_truthiness = |ty| { + if let Type::BooleanLiteral(bool_val) = ty { + Truthiness::from(bool_val) + } else { + Truthiness::Ambiguous + } + }; + + let try_dunder_bool = || { + // We only check the `__bool__` method for truth testing, even though at + // runtime there is a fallback to `__len__`, since `__bool__` takes precedence + // and a subclass could add a `__bool__` method. + + match self.try_call_dunder(db, "__bool__", CallArgumentTypes::none()) { + Ok(outcome) => { + let return_type = outcome.return_type(db); + if !return_type.is_assignable_to(db, KnownClass::Bool.to_instance(db)) { + // The type has a `__bool__` method, but it doesn't return a + // boolean. + return Err(BoolError::IncorrectReturnType { + return_type, + not_boolable_type: *self, + }); + } + Ok(type_to_truthiness(return_type)) + } + + Err(CallDunderError::PossiblyUnbound(outcome)) => { + let return_type = outcome.return_type(db); + if !return_type.is_assignable_to(db, KnownClass::Bool.to_instance(db)) { + // The type has a `__bool__` method, but it doesn't return a + // boolean. + return Err(BoolError::IncorrectReturnType { + return_type: outcome.return_type(db), + not_boolable_type: *self, + }); + } + + // Don't trust possibly unbound `__bool__` method. + Ok(Truthiness::Ambiguous) + } + + Err(CallDunderError::MethodNotAvailable) => Ok(Truthiness::Ambiguous), + Err(CallDunderError::CallError(CallErrorKind::BindingError, bindings)) => { + Err(BoolError::IncorrectArguments { + truthiness: type_to_truthiness(bindings.return_type(db)), + not_boolable_type: *self, + }) + } + Err(CallDunderError::CallError(CallErrorKind::NotCallable, _)) => { + Err(BoolError::NotCallable { + not_boolable_type: *self, + }) + } + Err(CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, _)) => { + Err(BoolError::Other { + not_boolable_type: *self, + }) + } + } + }; + + let try_union = |union: UnionType<'db>| { + let mut truthiness = None; + let mut all_not_callable = true; + let mut has_errors = false; + + for element in union.elements(db) { + let element_truthiness = match element.try_bool_impl(db, allow_short_circuit) { + Ok(truthiness) => truthiness, + Err(err) => { + has_errors = true; + all_not_callable &= matches!(err, BoolError::NotCallable { .. }); + err.fallback_truthiness() + } + }; + + truthiness.get_or_insert(element_truthiness); + + if Some(element_truthiness) != truthiness { + truthiness = Some(Truthiness::Ambiguous); + + if allow_short_circuit { + return Ok(Truthiness::Ambiguous); + } + } + } + + if has_errors { + if all_not_callable { + return Err(BoolError::NotCallable { + not_boolable_type: *self, + }); + } + return Err(BoolError::Union { + union, + truthiness: truthiness.unwrap_or(Truthiness::Ambiguous), + }); + } + Ok(truthiness.unwrap_or(Truthiness::Ambiguous)) + }; + + let truthiness = match self { + Type::Dynamic(_) | Type::Never | Type::Callable(_) | Type::LiteralString => { + Truthiness::Ambiguous + } + + Type::FunctionLiteral(_) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::AlwaysTruthy => Truthiness::AlwaysTrue, + + Type::AlwaysFalsy => Truthiness::AlwaysFalse, + + Type::ClassLiteral(class) => class + .metaclass_instance_type(db) + .try_bool_impl(db, allow_short_circuit)?, + Type::GenericAlias(alias) => ClassType::from(*alias) + .metaclass_instance_type(db) + .try_bool_impl(db, allow_short_circuit)?, + + Type::SubclassOf(subclass_of_ty) => match subclass_of_ty.subclass_of() { + SubclassOfInner::Dynamic(_) => Truthiness::Ambiguous, + SubclassOfInner::Class(class) => { + Type::from(class).try_bool_impl(db, allow_short_circuit)? + } + }, + + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => Truthiness::Ambiguous, + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + bound.try_bool_impl(db, allow_short_circuit)? + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => { + try_union(constraints)? + } + }, + + Type::NominalInstance(instance) => match instance.class.known(db) { + Some(known_class) => known_class.bool(), + None => try_dunder_bool()?, + }, + + Type::ProtocolInstance(_) => try_dunder_bool()?, + + Type::KnownInstance(known_instance) => known_instance.bool(), + + Type::PropertyInstance(_) => Truthiness::AlwaysTrue, + + Type::Union(union) => try_union(*union)?, + + Type::Intersection(_) => { + // TODO + Truthiness::Ambiguous + } + + Type::IntLiteral(num) => Truthiness::from(*num != 0), + Type::BooleanLiteral(bool) => Truthiness::from(*bool), + Type::StringLiteral(str) => Truthiness::from(!str.value(db).is_empty()), + Type::BytesLiteral(bytes) => Truthiness::from(!bytes.value(db).is_empty()), + Type::Tuple(items) => Truthiness::from(!items.elements(db).is_empty()), + Type::BoundSuper(_) => Truthiness::AlwaysTrue, + }; + + Ok(truthiness) + } + + /// Return the type of `len()` on a type if it is known more precisely than `int`, + /// or `None` otherwise. + /// + /// In the second case, the return type of `len()` in `typeshed` (`int`) + /// is used as a fallback. + fn len(&self, db: &'db dyn Db) -> Option<Type<'db>> { + fn non_negative_int_literal<'db>(db: &'db dyn Db, ty: Type<'db>) -> Option<Type<'db>> { + match ty { + // TODO: Emit diagnostic for non-integers and negative integers + Type::IntLiteral(value) => (value >= 0).then_some(ty), + Type::BooleanLiteral(value) => Some(Type::IntLiteral(value.into())), + Type::Union(union) => { + let mut builder = UnionBuilder::new(db); + for element in union.elements(db) { + builder = builder.add(non_negative_int_literal(db, *element)?); + } + Some(builder.build()) + } + _ => None, + } + } + + let usize_len = match self { + Type::BytesLiteral(bytes) => Some(bytes.python_len(db)), + Type::StringLiteral(string) => Some(string.python_len(db)), + Type::Tuple(tuple) => Some(tuple.len(db)), + _ => None, + }; + + if let Some(usize_len) = usize_len { + return usize_len.try_into().ok().map(Type::IntLiteral); + } + + let return_ty = match self.try_call_dunder(db, "__len__", CallArgumentTypes::none()) { + Ok(bindings) => bindings.return_type(db), + Err(CallDunderError::PossiblyUnbound(bindings)) => bindings.return_type(db), + + // TODO: emit a diagnostic + Err(CallDunderError::MethodNotAvailable) => return None, + Err(CallDunderError::CallError(_, bindings)) => bindings.return_type(db), + }; + + non_negative_int_literal(db, return_ty) + } + + /// Returns the call signatures of a type. + /// + /// Note that all types have a valid [`Signatures`], even if the type is not callable. + /// Moreover, "callable" can be subtle for a union type, since some union elements might be + /// callable and some not. A union is callable if every element type is callable — and even + /// then, the elements might be inconsistent, such that there's no argument list that's valid + /// for all elements. It's usually best to only worry about "callability" relative to a + /// particular argument list, via [`try_call`][Self::try_call] and + /// [`CallErrorKind::NotCallable`]. + fn signatures(self, db: &'db dyn Db) -> Signatures<'db> { + match self { + Type::Callable(callable) => Signatures::single(match callable.signatures(db) { + [signature] => CallableSignature::single(self, signature.clone()), + signatures => CallableSignature::from_overloads(self, signatures.iter().cloned()), + }), + + Type::BoundMethod(bound_method) => { + let signature = bound_method.function(db).signature(db); + Signatures::single( + CallableSignature::from_overloads(self, signature.overloads.iter().cloned()) + .with_bound_type(bound_method.self_instance(db)), + ) + } + + Type::MethodWrapper( + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::PropertyDunderGet(_), + ) => { + // Here, we dynamically model the overloaded function signature of `types.FunctionType.__get__`. + // This is required because we need to return more precise types than what the signature in + // typeshed provides: + // + // ```py + // class FunctionType: + // # ... + // @overload + // def __get__(self, instance: None, owner: type, /) -> FunctionType: ... + // @overload + // def __get__(self, instance: object, owner: type | None = None, /) -> MethodType: ... + // ``` + // + // For `builtins.property.__get__`, we use the same signature. The return types are not + // specified yet, they will be dynamically added in `Bindings::evaluate_known_cases`. + + let not_none = Type::none(db).negate(db); + let signature = CallableSignature::from_overloads( + self, + [ + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(Type::none(db)), + Parameter::positional_only(Some(Name::new_static("owner"))) + .with_annotated_type(KnownClass::Type.to_instance(db)), + ]), + None, + ), + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(not_none), + Parameter::positional_only(Some(Name::new_static("owner"))) + .with_annotated_type(UnionType::from_elements( + db, + [KnownClass::Type.to_instance(db), Type::none(db)], + )) + .with_default_type(Type::none(db)), + ]), + None, + ), + ], + ); + Signatures::single(signature) + } + + Type::WrapperDescriptor( + kind @ (WrapperDescriptorKind::FunctionTypeDunderGet + | WrapperDescriptorKind::PropertyDunderGet), + ) => { + // Here, we also model `types.FunctionType.__get__` (or builtins.property.__get__), + // but now we consider a call to this as a function, i.e. we also expect the `self` + // argument to be passed in. + + // TODO: Consider merging this signature with the one in the previous match clause, + // since the previous one is just this signature with the `self` parameters + // removed. + let not_none = Type::none(db).negate(db); + let descriptor = match kind { + WrapperDescriptorKind::FunctionTypeDunderGet => { + KnownClass::FunctionType.to_instance(db) + } + WrapperDescriptorKind::PropertyDunderGet => { + KnownClass::Property.to_instance(db) + } + WrapperDescriptorKind::PropertyDunderSet => { + unreachable!("Not part of outer match pattern") + } + }; + let signature = CallableSignature::from_overloads( + self, + [ + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("self"))) + .with_annotated_type(descriptor), + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(Type::none(db)), + Parameter::positional_only(Some(Name::new_static("owner"))) + .with_annotated_type(KnownClass::Type.to_instance(db)), + ]), + None, + ), + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("self"))) + .with_annotated_type(descriptor), + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(not_none), + Parameter::positional_only(Some(Name::new_static("owner"))) + .with_annotated_type(UnionType::from_elements( + db, + [KnownClass::Type.to_instance(db), Type::none(db)], + )) + .with_default_type(Type::none(db)), + ]), + None, + ), + ], + ); + Signatures::single(signature) + } + + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet(_)) => { + Signatures::single(CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(Type::object(db)), + Parameter::positional_only(Some(Name::new_static("value"))) + .with_annotated_type(Type::object(db)), + ]), + None, + ), + )) + } + Type::WrapperDescriptor(WrapperDescriptorKind::PropertyDunderSet) => { + Signatures::single(CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("self"))) + .with_annotated_type(KnownClass::Property.to_instance(db)), + Parameter::positional_only(Some(Name::new_static("instance"))) + .with_annotated_type(Type::object(db)), + Parameter::positional_only(Some(Name::new_static("value"))) + .with_annotated_type(Type::object(db)), + ]), + None, + ), + )) + } + + Type::MethodWrapper(MethodWrapperKind::StrStartswith(_)) => { + Signatures::single(CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("prefix"))) + .with_annotated_type(UnionType::from_elements( + db, + [ + KnownClass::Str.to_instance(db), + KnownClass::Tuple.to_specialized_instance( + db, + [KnownClass::Str.to_instance(db)], + ), + ], + )), + Parameter::positional_only(Some(Name::new_static("start"))) + .with_annotated_type(UnionType::from_elements( + db, + [KnownClass::SupportsIndex.to_instance(db), Type::none(db)], + )) + .with_default_type(Type::none(db)), + Parameter::positional_only(Some(Name::new_static("end"))) + .with_annotated_type(UnionType::from_elements( + db, + [KnownClass::SupportsIndex.to_instance(db), Type::none(db)], + )) + .with_default_type(Type::none(db)), + ]), + Some(KnownClass::Bool.to_instance(db)), + ), + )) + } + + // TODO: We should probably also check the original return type of the function + // that was decorated with `@dataclass_transform`, to see if it is consistent with + // with what we configure here. + Type::DataclassTransformer(_) => Signatures::single(CallableSignature::single( + self, + Signature::new( + Parameters::new([Parameter::positional_only(Some(Name::new_static("func"))) + .with_annotated_type(Type::object(db))]), + None, + ), + )), + + Type::FunctionLiteral(function_type) => match function_type.known(db) { + Some( + KnownFunction::IsEquivalentTo + | KnownFunction::IsSubtypeOf + | KnownFunction::IsAssignableTo + | KnownFunction::IsDisjointFrom + | KnownFunction::IsGradualEquivalentTo, + ) => { + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("a"))) + .type_form() + .with_annotated_type(Type::any()), + Parameter::positional_only(Some(Name::new_static("b"))) + .type_form() + .with_annotated_type(Type::any()), + ]), + Some(KnownClass::Bool.to_instance(db)), + ), + ); + Signatures::single(signature) + } + + Some( + KnownFunction::IsFullyStatic + | KnownFunction::IsSingleton + | KnownFunction::IsSingleValued, + ) => { + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([Parameter::positional_only(Some(Name::new_static( + "a", + ))) + .type_form() + .with_annotated_type(Type::any())]), + Some(KnownClass::Bool.to_instance(db)), + ), + ); + Signatures::single(signature) + } + + Some(KnownFunction::AssertType) => { + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("value"))) + .with_annotated_type(Type::any()), + Parameter::positional_only(Some(Name::new_static("type"))) + .type_form() + .with_annotated_type(Type::any()), + ]), + Some(Type::none(db)), + ), + ); + Signatures::single(signature) + } + + Some(KnownFunction::AssertNever) => { + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([Parameter::positional_only(Some(Name::new_static( + "arg", + ))) + // We need to set the type to `Any` here (instead of `Never`), + // in order for every `assert_never` call to pass the argument + // check. If we set it to `Never`, we'll get invalid-argument-type + // errors instead of `type-assertion-failure` errors. + .with_annotated_type(Type::any())]), + Some(Type::none(db)), + ), + ); + Signatures::single(signature) + } + + Some(KnownFunction::Cast) => { + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_or_keyword(Name::new_static("typ")) + .type_form() + .with_annotated_type(Type::any()), + Parameter::positional_or_keyword(Name::new_static("val")) + .with_annotated_type(Type::any()), + ]), + Some(Type::any()), + ), + ); + Signatures::single(signature) + } + + Some(KnownFunction::Dataclass) => { + let signature = CallableSignature::from_overloads( + self, + [ + // def dataclass(cls: None, /) -> Callable[[type[_T]], type[_T]]: ... + Signature::new( + Parameters::new([Parameter::positional_only(Some( + Name::new_static("cls"), + )) + .with_annotated_type(Type::none(db))]), + None, + ), + // def dataclass(cls: type[_T], /) -> type[_T]: ... + Signature::new( + Parameters::new([Parameter::positional_only(Some( + Name::new_static("cls"), + )) + .with_annotated_type(KnownClass::Type.to_instance(db))]), + None, + ), + // TODO: make this overload Python-version-dependent + + // def dataclass( + // *, + // init: bool = True, + // repr: bool = True, + // eq: bool = True, + // order: bool = False, + // unsafe_hash: bool = False, + // frozen: bool = False, + // match_args: bool = True, + // kw_only: bool = False, + // slots: bool = False, + // weakref_slot: bool = False, + // ) -> Callable[[type[_T]], type[_T]]: ... + Signature::new( + Parameters::new([ + Parameter::keyword_only(Name::new_static("init")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(true)), + Parameter::keyword_only(Name::new_static("repr")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(true)), + Parameter::keyword_only(Name::new_static("eq")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(true)), + Parameter::keyword_only(Name::new_static("order")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("unsafe_hash")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("frozen")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("match_args")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(true)), + Parameter::keyword_only(Name::new_static("kw_only")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("slots")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("weakref_slot")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + ]), + None, + ), + ], + ); + + Signatures::single(signature) + } + + _ => Signatures::single(function_type.signature(db).overloads.clone()), + }, + + Type::ClassLiteral(class) => match class.known(db) { + // TODO: Ideally we'd use `try_call_constructor` for all constructor calls. + // Currently we don't for a few special known types, either because their + // constructors are defined with overloads, or because we want to special case + // their return type beyond what typeshed provides (though this support could + // likely be moved into the `try_call_constructor` path). Once we support + // overloads, re-evaluate the need for these arms. + Some(KnownClass::Bool) => { + // ```py + // class bool(int): + // def __new__(cls, o: object = ..., /) -> Self: ... + // ``` + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([Parameter::positional_only(Some(Name::new_static( + "o", + ))) + .with_annotated_type(Type::any()) + .with_default_type(Type::BooleanLiteral(false))]), + Some(KnownClass::Bool.to_instance(db)), + ), + ); + Signatures::single(signature) + } + + Some(KnownClass::Str) => { + // ```py + // class str(Sequence[str]): + // @overload + // def __new__(cls, object: object = ...) -> Self: ... + // @overload + // def __new__(cls, object: ReadableBuffer, encoding: str = ..., errors: str = ...) -> Self: ... + // ``` + let signature = CallableSignature::from_overloads( + self, + [ + Signature::new( + Parameters::new([Parameter::positional_or_keyword( + Name::new_static("object"), + ) + .with_annotated_type(Type::object(db)) + .with_default_type(Type::string_literal(db, ""))]), + Some(KnownClass::Str.to_instance(db)), + ), + Signature::new( + Parameters::new([ + Parameter::positional_or_keyword(Name::new_static("object")) + // TODO: Should be `ReadableBuffer` instead of this union type: + .with_annotated_type(UnionType::from_elements( + db, + [ + KnownClass::Bytes.to_instance(db), + KnownClass::Bytearray.to_instance(db), + ], + )) + .with_default_type(Type::bytes_literal(db, b"")), + Parameter::positional_or_keyword(Name::new_static("encoding")) + .with_annotated_type(KnownClass::Str.to_instance(db)) + .with_default_type(Type::string_literal(db, "utf-8")), + Parameter::positional_or_keyword(Name::new_static("errors")) + .with_annotated_type(KnownClass::Str.to_instance(db)) + .with_default_type(Type::string_literal(db, "strict")), + ]), + Some(KnownClass::Str.to_instance(db)), + ), + ], + ); + Signatures::single(signature) + } + + Some(KnownClass::Type) => { + let str_instance = KnownClass::Str.to_instance(db); + let type_instance = KnownClass::Type.to_instance(db); + + // ```py + // class type: + // @overload + // def __init__(self, o: object, /) -> None: ... + // @overload + // def __init__(self, name: str, bases: tuple[type, ...], dict: dict[str, Any], /, **kwds: Any) -> None: ... + // ``` + let signature = CallableSignature::from_overloads( + self, + [ + Signature::new( + Parameters::new([Parameter::positional_only(Some( + Name::new_static("o"), + )) + .with_annotated_type(Type::any())]), + Some(type_instance), + ), + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("name"))) + .with_annotated_type(str_instance), + Parameter::positional_only(Some(Name::new_static("bases"))) + .with_annotated_type( + KnownClass::Tuple + .to_specialized_instance(db, [type_instance]), + ), + Parameter::positional_only(Some(Name::new_static("dict"))) + .with_annotated_type( + KnownClass::Dict.to_specialized_instance( + db, + [str_instance, Type::any()], + ), + ), + ]), + Some(type_instance), + ), + ], + ); + Signatures::single(signature) + } + Some(KnownClass::NamedTuple) => { + Signatures::single(CallableSignature::todo("functional `NamedTuple` syntax")) + } + Some(KnownClass::Object) => { + // ```py + // class object: + // def __init__(self) -> None: ... + // def __new__(cls) -> Self: ... + // ``` + let signature = CallableSignature::from_overloads( + self, + [Signature::new( + Parameters::empty(), + Some(KnownClass::Object.to_instance(db)), + )], + ); + Signatures::single(signature) + } + Some(KnownClass::Enum) => { + Signatures::single(CallableSignature::todo("functional `Enum` syntax")) + } + + Some(KnownClass::Super) => { + // ```py + // class super: + // @overload + // def __init__(self, t: Any, obj: Any, /) -> None: ... + // @overload + // def __init__(self, t: Any, /) -> None: ... + // @overload + // def __init__(self) -> None: ... + // ``` + let signature = CallableSignature::from_overloads( + self, + [ + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("t"))) + .with_annotated_type(Type::any()), + Parameter::positional_only(Some(Name::new_static("obj"))) + .with_annotated_type(Type::any()), + ]), + Some(KnownClass::Super.to_instance(db)), + ), + Signature::new( + Parameters::new([Parameter::positional_only(Some( + Name::new_static("t"), + )) + .with_annotated_type(Type::any())]), + Some(KnownClass::Super.to_instance(db)), + ), + Signature::new( + Parameters::empty(), + Some(KnownClass::Super.to_instance(db)), + ), + ], + ); + Signatures::single(signature) + } + + Some(KnownClass::TypeVar) => { + // ```py + // class TypeVar: + // def __new__( + // cls, + // name: str, + // *constraints: Any, + // bound: Any | None = None, + // contravariant: bool = False, + // covariant: bool = False, + // infer_variance: bool = False, + // default: Any = ..., + // ) -> Self: ... + // ``` + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_or_keyword(Name::new_static("name")) + .with_annotated_type(Type::LiteralString), + Parameter::variadic(Name::new_static("constraints")) + .type_form() + .with_annotated_type(Type::any()), + Parameter::keyword_only(Name::new_static("bound")) + .type_form() + .with_annotated_type(UnionType::from_elements( + db, + [Type::any(), Type::none(db)], + )) + .with_default_type(Type::none(db)), + Parameter::keyword_only(Name::new_static("default")) + .type_form() + .with_annotated_type(Type::any()) + .with_default_type(KnownClass::NoneType.to_instance(db)), + Parameter::keyword_only(Name::new_static("contravariant")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("covariant")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + Parameter::keyword_only(Name::new_static("infer_variance")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(false)), + ]), + Some(KnownClass::TypeVar.to_instance(db)), + ), + ); + Signatures::single(signature) + } + + Some(KnownClass::TypeAliasType) => { + // ```py + // def __new__( + // cls, + // name: str, + // value: Any, + // *, + // type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = () + // ) -> Self: ... + // ``` + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_or_keyword(Name::new_static("name")) + .with_annotated_type(KnownClass::Str.to_instance(db)), + Parameter::positional_or_keyword(Name::new_static("value")) + .with_annotated_type(Type::any()) + .type_form(), + Parameter::keyword_only(Name::new_static("type_params")) + .with_annotated_type(KnownClass::Tuple.to_specialized_instance( + db, + [UnionType::from_elements( + db, + [ + KnownClass::TypeVar.to_instance(db), + KnownClass::ParamSpec.to_instance(db), + KnownClass::TypeVarTuple.to_instance(db), + ], + )], + )) + .with_default_type(TupleType::empty(db)), + ]), + None, + ), + ); + Signatures::single(signature) + } + + Some(KnownClass::Property) => { + let getter_signature = Signature::new( + Parameters::new([ + Parameter::positional_only(None).with_annotated_type(Type::any()) + ]), + Some(Type::any()), + ); + let setter_signature = Signature::new( + Parameters::new([ + Parameter::positional_only(None).with_annotated_type(Type::any()), + Parameter::positional_only(None).with_annotated_type(Type::any()), + ]), + Some(Type::none(db)), + ); + let deleter_signature = Signature::new( + Parameters::new([ + Parameter::positional_only(None).with_annotated_type(Type::any()) + ]), + Some(Type::any()), + ); + + let signature = CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_or_keyword(Name::new_static("fget")) + .with_annotated_type(UnionType::from_elements( + db, + [ + Type::Callable(CallableType::single( + db, + getter_signature, + )), + Type::none(db), + ], + )) + .with_default_type(Type::none(db)), + Parameter::positional_or_keyword(Name::new_static("fset")) + .with_annotated_type(UnionType::from_elements( + db, + [ + Type::Callable(CallableType::single( + db, + setter_signature, + )), + Type::none(db), + ], + )) + .with_default_type(Type::none(db)), + Parameter::positional_or_keyword(Name::new_static("fdel")) + .with_annotated_type(UnionType::from_elements( + db, + [ + Type::Callable(CallableType::single( + db, + deleter_signature, + )), + Type::none(db), + ], + )) + .with_default_type(Type::none(db)), + Parameter::positional_or_keyword(Name::new_static("doc")) + .with_annotated_type(UnionType::from_elements( + db, + [KnownClass::Str.to_instance(db), Type::none(db)], + )) + .with_default_type(Type::none(db)), + ]), + None, + ), + ); + Signatures::single(signature) + } + + // Most class literal constructor calls are handled by `try_call_constructor` and + // not via getting the signature here. This signature can still be used in some + // cases (e.g. evaluating callable subtyping). TODO improve this definition + // (intersection of `__new__` and `__init__` signatures? and respect metaclass + // `__call__`). + _ => { + let signature = CallableSignature::single( + self, + Signature::new_generic( + class.generic_context(db), + Parameters::gradual_form(), + self.to_instance(db), + ), + ); + Signatures::single(signature) + } + }, + + Type::KnownInstance(KnownInstanceType::TypedDict) => { + Signatures::single(CallableSignature::single( + self, + Signature::new( + Parameters::new([ + Parameter::positional_only(Some(Name::new_static("typename"))) + .with_annotated_type(KnownClass::Str.to_instance(db)), + Parameter::positional_only(Some(Name::new_static("fields"))) + .with_annotated_type(KnownClass::Dict.to_instance(db)) + .with_default_type(Type::any()), + Parameter::keyword_only(Name::new_static("total")) + .with_annotated_type(KnownClass::Bool.to_instance(db)) + .with_default_type(Type::BooleanLiteral(true)), + // Future compatibility, in case new keyword arguments will be added: + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(Type::any()), + ]), + None, + ), + )) + } + + Type::GenericAlias(_) => { + // TODO annotated return type on `__new__` or metaclass `__call__` + // TODO check call vs signatures of `__new__` and/or `__init__` + let signature = CallableSignature::single( + self, + Signature::new(Parameters::gradual_form(), self.to_instance(db)), + ); + Signatures::single(signature) + } + + Type::SubclassOf(subclass_of_type) => match subclass_of_type.subclass_of() { + SubclassOfInner::Dynamic(dynamic_type) => { + Type::Dynamic(dynamic_type).signatures(db) + } + // Most type[] constructor calls are handled by `try_call_constructor` and not via + // getting the signature here. This signature can still be used in some cases (e.g. + // evaluating callable subtyping). TODO improve this definition (intersection of + // `__new__` and `__init__` signatures? and respect metaclass `__call__`). + SubclassOfInner::Class(class) => Type::from(class).signatures(db), + }, + + Type::NominalInstance(_) | Type::ProtocolInstance(_) => { + // Note that for objects that have a (possibly not callable!) `__call__` attribute, + // we will get the signature of the `__call__` attribute, but will pass in the type + // of the original object as the "callable type". That ensures that we get errors + // like "`X` is not callable" instead of "`<type of illegal '__call__'>` is not + // callable". + match self + .member_lookup_with_policy( + db, + Name::new_static("__call__"), + MemberLookupPolicy::NO_INSTANCE_FALLBACK, + ) + .symbol + { + Symbol::Type(dunder_callable, boundness) => { + let mut signatures = dunder_callable.signatures(db).clone(); + signatures.replace_callable_type(dunder_callable, self); + if boundness == Boundness::PossiblyUnbound { + signatures.set_dunder_call_is_possibly_unbound(); + } + signatures + } + Symbol::Unbound => Signatures::not_callable(self), + } + } + + // Dynamic types are callable, and the return type is the same dynamic type. Similarly, + // `Never` is always callable and returns `Never`. + Type::Dynamic(_) | Type::Never => Signatures::single(CallableSignature::dynamic(self)), + + // Note that this correctly returns `None` if none of the union elements are callable. + Type::Union(union) => Signatures::from_union( + self, + union + .elements(db) + .iter() + .map(|element| element.signatures(db)), + ), + + Type::Intersection(_) => { + Signatures::single(CallableSignature::todo("Type::Intersection.call()")) + } + + // TODO: these are actually callable + Type::MethodWrapper(_) | Type::DataclassDecorator(_) => Signatures::not_callable(self), + + // TODO: some `KnownInstance`s are callable (e.g. TypedDicts) + Type::KnownInstance(_) => Signatures::not_callable(self), + + Type::PropertyInstance(_) + | Type::AlwaysFalsy + | Type::AlwaysTruthy + | Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::BytesLiteral(_) + | Type::BooleanLiteral(_) + | Type::LiteralString + | Type::Tuple(_) + | Type::BoundSuper(_) + | Type::TypeVar(_) + | Type::ModuleLiteral(_) => Signatures::not_callable(self), + } + } + + /// Calls `self`. Returns a [`CallError`] if `self` is (always or possibly) not callable, or if + /// the arguments are not compatible with the formal parameters. + /// + /// You get back a [`Bindings`] for both successful and unsuccessful calls. + /// It contains information about which formal parameters each argument was matched to, + /// and about any errors matching arguments and parameters. + fn try_call( + self, + db: &'db dyn Db, + argument_types: &CallArgumentTypes<'_, 'db>, + ) -> Result<Bindings<'db>, CallError<'db>> { + let signatures = self.signatures(db); + Bindings::match_parameters(signatures, argument_types).check_types(db, argument_types) + } + + /// Look up a dunder method on the meta-type of `self` and call it. + /// + /// Returns an `Err` if the dunder method can't be called, + /// or the given arguments are not valid. + fn try_call_dunder( + self, + db: &'db dyn Db, + name: &str, + mut argument_types: CallArgumentTypes<'_, 'db>, + ) -> Result<Bindings<'db>, CallDunderError<'db>> { + self.try_call_dunder_with_policy( + db, + name, + &mut argument_types, + MemberLookupPolicy::NO_INSTANCE_FALLBACK, + ) + } + + /// Same as `try_call_dunder`, but allows specifying a policy for the member lookup. In + /// particular, this allows to specify `MemberLookupPolicy::MRO_NO_OBJECT_FALLBACK` to avoid + /// looking up dunder methods on `object`, which is needed for functions like `__init__`, + /// `__new__`, or `__setattr__`. + fn try_call_dunder_with_policy( + self, + db: &'db dyn Db, + name: &str, + argument_types: &mut CallArgumentTypes<'_, 'db>, + policy: MemberLookupPolicy, + ) -> Result<Bindings<'db>, CallDunderError<'db>> { + match self + .member_lookup_with_policy(db, name.into(), policy) + .symbol + { + Symbol::Type(dunder_callable, boundness) => { + let signatures = dunder_callable.signatures(db); + let bindings = Bindings::match_parameters(signatures, argument_types) + .check_types(db, argument_types)?; + if boundness == Boundness::PossiblyUnbound { + return Err(CallDunderError::PossiblyUnbound(Box::new(bindings))); + } + Ok(bindings) + } + Symbol::Unbound => Err(CallDunderError::MethodNotAvailable), + } + } + + /// Returns the element type when iterating over `self`. + /// + /// This method should only be used outside of type checking because it omits any errors. + /// For type checking, use [`try_iterate`](Self::try_iterate) instead. + fn iterate(self, db: &'db dyn Db) -> Type<'db> { + self.try_iterate(db) + .unwrap_or_else(|err| err.fallback_element_type(db)) + } + + /// Given the type of an object that is iterated over in some way, + /// return the type of objects that are yielded by that iteration. + /// + /// E.g., for the following loop, given the type of `x`, infer the type of `y`: + /// ```python + /// for y in x: + /// pass + /// ``` + fn try_iterate(self, db: &'db dyn Db) -> Result<Type<'db>, IterationError<'db>> { + if let Type::Tuple(tuple_type) = self { + return Ok(UnionType::from_elements(db, tuple_type.elements(db))); + } + + if let Type::GenericAlias(alias) = self { + if alias.origin(db).is_known(db, KnownClass::Tuple) { + return Ok(todo_type!("*tuple[] annotations")); + } + } + + let try_call_dunder_getitem = || { + self.try_call_dunder( + db, + "__getitem__", + CallArgumentTypes::positional([KnownClass::Int.to_instance(db)]), + ) + .map(|dunder_getitem_outcome| dunder_getitem_outcome.return_type(db)) + }; + + let try_call_dunder_next_on_iterator = |iterator: Type<'db>| { + iterator + .try_call_dunder(db, "__next__", CallArgumentTypes::none()) + .map(|dunder_next_outcome| dunder_next_outcome.return_type(db)) + }; + + let dunder_iter_result = self + .try_call_dunder(db, "__iter__", CallArgumentTypes::none()) + .map(|dunder_iter_outcome| dunder_iter_outcome.return_type(db)); + + match dunder_iter_result { + Ok(iterator) => { + // `__iter__` is definitely bound and calling it succeeds. + // See what calling `__next__` on the object returned by `__iter__` gives us... + try_call_dunder_next_on_iterator(iterator).map_err(|dunder_next_error| { + IterationError::IterReturnsInvalidIterator { + iterator, + dunder_next_error, + } + }) + } + + // `__iter__` is possibly unbound... + Err(CallDunderError::PossiblyUnbound(dunder_iter_outcome)) => { + let iterator = dunder_iter_outcome.return_type(db); + + match try_call_dunder_next_on_iterator(iterator) { + Ok(dunder_next_return) => { + try_call_dunder_getitem() + .map(|dunder_getitem_return_type| { + // If `__iter__` is possibly unbound, + // but it returns an object that has a bound and valid `__next__` method, + // *and* the object has a bound and valid `__getitem__` method, + // we infer a union of the type returned by the `__next__` method + // and the type returned by the `__getitem__` method. + // + // No diagnostic is emitted; iteration will always succeed! + UnionType::from_elements( + db, + [dunder_next_return, dunder_getitem_return_type], + ) + }) + .map_err(|dunder_getitem_error| { + IterationError::PossiblyUnboundIterAndGetitemError { + dunder_next_return, + dunder_getitem_error, + } + }) + } + + Err(dunder_next_error) => Err(IterationError::IterReturnsInvalidIterator { + iterator, + dunder_next_error, + }), + } + } + + // `__iter__` is definitely bound but it can't be called with the expected arguments + Err(CallDunderError::CallError(kind, bindings)) => { + Err(IterationError::IterCallError(kind, bindings)) + } + + // There's no `__iter__` method. Try `__getitem__` instead... + Err(CallDunderError::MethodNotAvailable) => { + try_call_dunder_getitem().map_err(|dunder_getitem_error| { + IterationError::UnboundIterAndGetitemError { + dunder_getitem_error, + } + }) + } + } + } + + /// Returns the type bound from a context manager with type `self`. + /// + /// This method should only be used outside of type checking because it omits any errors. + /// For type checking, use [`try_enter`](Self::try_enter) instead. + fn enter(self, db: &'db dyn Db) -> Type<'db> { + self.try_enter(db) + .unwrap_or_else(|err| err.fallback_enter_type(db)) + } + + /// Given the type of an object that is used as a context manager (i.e. in a `with` statement), + /// return the return type of its `__enter__` method, which is bound to any potential targets. + /// + /// E.g., for the following `with` statement, given the type of `x`, infer the type of `y`: + /// ```python + /// with x as y: + /// pass + /// ``` + fn try_enter(self, db: &'db dyn Db) -> Result<Type<'db>, ContextManagerError<'db>> { + let enter = self.try_call_dunder(db, "__enter__", CallArgumentTypes::none()); + let exit = self.try_call_dunder( + db, + "__exit__", + CallArgumentTypes::positional([Type::none(db), Type::none(db), Type::none(db)]), + ); + + // TODO: Make use of Protocols when we support it (the manager be assignable to `contextlib.AbstractContextManager`). + match (enter, exit) { + (Ok(enter), Ok(_)) => Ok(enter.return_type(db)), + (Ok(enter), Err(exit_error)) => Err(ContextManagerError::Exit { + enter_return_type: enter.return_type(db), + exit_error, + }), + // TODO: Use the `exit_ty` to determine if any raised exception is suppressed. + (Err(enter_error), Ok(_)) => Err(ContextManagerError::Enter(enter_error)), + (Err(enter_error), Err(exit_error)) => Err(ContextManagerError::EnterAndExit { + enter_error, + exit_error, + }), + } + } + + /// Given a class literal or non-dynamic SubclassOf type, try calling it (creating an instance) + /// and return the resulting instance type. + /// + /// Models `type.__call__` behavior. + /// TODO: model metaclass `__call__`. + /// + /// E.g., for the following code, infer the type of `Foo()`: + /// ```python + /// class Foo: + /// pass + /// + /// Foo() + /// ``` + fn try_call_constructor( + self, + db: &'db dyn Db, + argument_types: CallArgumentTypes<'_, 'db>, + ) -> Result<Type<'db>, ConstructorCallError<'db>> { + debug_assert!(matches!( + self, + Type::ClassLiteral(_) | Type::GenericAlias(_) | Type::SubclassOf(_) + )); + + // If we are trying to construct a non-specialized generic class, we should use the + // constructor parameters to try to infer the class specialization. To do this, we need to + // tweak our member lookup logic a bit. Normally, when looking up a class or instance + // member, we first apply the class's default specialization, and apply that specialization + // to the type of the member. To infer a specialization from the argument types, we need to + // have the class's typevars still in the method signature when we attempt to call it. To + // do this, we instead use the _identity_ specialization, which maps each of the class's + // generic typevars to itself. + let (generic_origin, generic_context, self_type) = match self { + Type::ClassLiteral(class) => match class.generic_context(db) { + Some(generic_context) => { + let specialization = generic_context.identity_specialization(db); + ( + Some(class), + Some(generic_context), + Type::GenericAlias(GenericAlias::new(db, class, specialization)), + ) + } + _ => (None, None, self), + }, + _ => (None, None, self), + }; + + // As of now we do not model custom `__call__` on meta-classes, so the code below + // only deals with interplay between `__new__` and `__init__` methods. + // The logic is roughly as follows: + // 1. If `__new__` is defined anywhere in the MRO (except for `object`, since it is always + // present), we call it and analyze outcome. We then analyze `__init__` call, but only + // if it is defined somewhere except object. This is because `object.__init__` + // allows arbitrary arguments if and only if `__new__` is defined, but typeshed + // defines `__init__` for `object` with no arguments. + // 2. If `__new__` is not found, we call `__init__`. Here, we allow it to fallback all + // the way to `object` (single `self` argument call). This time it is correct to + // fallback to `object.__init__`, since it will indeed check that no arguments are + // passed. + // + // Note that we currently ignore `__new__` return type, since we do not yet support `Self` + // and most builtin classes use it as return type annotation. We always return the instance + // type. + + // Lookup `__new__` method in the MRO up to, but not including, `object`. Also, we must + // avoid `__new__` on `type` since per descriptor protocol, if `__new__` is not defined on + // a class, metaclass attribute would take precedence. But by avoiding `__new__` on + // `object` we would inadvertently unhide `__new__` on `type`, which is not what we want. + // An alternative might be to not skip `object.__new__` but instead mark it such that it's + // easy to check if that's the one we found? + // Note that `__new__` is a static method, so we must inject the `cls` argument. + let new_method = self_type.find_name_in_mro_with_policy( + db, + "__new__", + MemberLookupPolicy::MRO_NO_OBJECT_FALLBACK + | MemberLookupPolicy::META_CLASS_NO_TYPE_FALLBACK, + ); + let new_call_outcome = new_method.and_then(|new_method| { + match new_method.symbol.try_call_dunder_get(db, self_type) { + Symbol::Type(new_method, boundness) => { + let result = + new_method.try_call(db, argument_types.with_self(Some(self_type)).as_ref()); + if boundness == Boundness::PossiblyUnbound { + Some(Err(DunderNewCallError::PossiblyUnbound(result.err()))) + } else { + Some(result.map_err(DunderNewCallError::CallError)) + } + } + Symbol::Unbound => None, + } + }); + + // Construct an instance type that we can use to look up the `__init__` instance method. + // This performs the same logic as `Type::to_instance`, except for generic class literals. + // TODO: we should use the actual return type of `__new__` to determine the instance type + let init_ty = self_type + .to_instance(db) + .expect("type should be convertible to instance type"); + + let init_call_outcome = if new_call_outcome.is_none() + || !init_ty + .member_lookup_with_policy( + db, + "__init__".into(), + MemberLookupPolicy::NO_INSTANCE_FALLBACK + | MemberLookupPolicy::MRO_NO_OBJECT_FALLBACK, + ) + .symbol + .is_unbound() + { + Some(init_ty.try_call_dunder(db, "__init__", argument_types)) + } else { + None + }; + + // Note that we use `self` here, not `self_type`, so that if constructor argument inference + // fails, we fail back to the default specialization. + let instance_ty = self + .to_instance(db) + .expect("type should be convertible to instance type"); + + match (generic_origin, new_call_outcome, init_call_outcome) { + // All calls are successful or not called at all + ( + Some(generic_origin), + new_call_outcome @ (None | Some(Ok(_))), + init_call_outcome @ (None | Some(Ok(_))), + ) => { + fn combine_specializations<'db>( + db: &'db dyn Db, + s1: Option<Specialization<'db>>, + s2: Option<Specialization<'db>>, + ) -> Option<Specialization<'db>> { + match (s1, s2) { + (None, None) => None, + (Some(s), None) | (None, Some(s)) => Some(s), + (Some(s1), Some(s2)) => Some(s1.combine(db, s2)), + } + } + + let new_specialization = new_call_outcome + .and_then(Result::ok) + .as_ref() + .and_then(Bindings::single_element) + .into_iter() + .flat_map(CallableBinding::matching_overloads) + .next() + .and_then(|(_, binding)| binding.inherited_specialization()) + .filter(|specialization| { + Some(specialization.generic_context(db)) == generic_context + }); + let init_specialization = init_call_outcome + .and_then(Result::ok) + .as_ref() + .and_then(Bindings::single_element) + .into_iter() + .flat_map(CallableBinding::matching_overloads) + .next() + .and_then(|(_, binding)| binding.inherited_specialization()) + .filter(|specialization| { + Some(specialization.generic_context(db)) == generic_context + }); + let specialization = + combine_specializations(db, new_specialization, init_specialization); + let specialized = specialization + .map(|specialization| { + Type::instance( + db, + ClassType::Generic(GenericAlias::new( + db, + generic_origin, + specialization, + )), + ) + }) + .unwrap_or(instance_ty); + Ok(specialized) + } + + (None, None | Some(Ok(_)), None | Some(Ok(_))) => Ok(instance_ty), + + (_, None | Some(Ok(_)), Some(Err(error))) => { + // no custom `__new__` or it was called and succeeded, but `__init__` failed. + Err(ConstructorCallError::Init(instance_ty, error)) + } + (_, Some(Err(error)), None | Some(Ok(_))) => { + // custom `__new__` was called and failed, but init is ok + Err(ConstructorCallError::New(instance_ty, error)) + } + (_, Some(Err(new_error)), Some(Err(init_error))) => { + // custom `__new__` was called and failed, and `__init__` is also not ok + Err(ConstructorCallError::NewAndInit( + instance_ty, + new_error, + init_error, + )) + } + } + } + + #[must_use] + pub fn to_instance(&self, db: &'db dyn Db) -> Option<Type<'db>> { + match self { + Type::Dynamic(_) | Type::Never => Some(*self), + Type::ClassLiteral(class) => Some(Type::instance(db, class.default_specialization(db))), + Type::GenericAlias(alias) => Some(Type::instance(db, ClassType::from(*alias))), + Type::SubclassOf(subclass_of_ty) => Some(subclass_of_ty.to_instance(db)), + Type::Union(union) => { + let mut builder = UnionBuilder::new(db); + for element in union.elements(db) { + builder = builder.add(element.to_instance(db)?); + } + Some(builder.build()) + } + // If there is no bound or constraints on a typevar `T`, `T: object` implicitly, which + // has no instance type. Otherwise, synthesize a typevar with bound or constraints + // mapped through `to_instance`. + Type::TypeVar(typevar) => { + let bound_or_constraints = match typevar.bound_or_constraints(db)? { + TypeVarBoundOrConstraints::UpperBound(upper_bound) => { + TypeVarBoundOrConstraints::UpperBound(upper_bound.to_instance(db)?) + } + TypeVarBoundOrConstraints::Constraints(constraints) => { + let mut builder = UnionBuilder::new(db); + for constraint in constraints.elements(db) { + builder = builder.add(constraint.to_instance(db)?); + } + TypeVarBoundOrConstraints::Constraints(builder.build().into_union()?) + } + }; + Some(Type::TypeVar(TypeVarInstance::new( + db, + Name::new(format!("{}'instance", typevar.name(db))), + None, + Some(bound_or_constraints), + typevar.variance(db), + None, + typevar.kind(db), + ))) + } + Type::Intersection(_) => Some(todo_type!("Type::Intersection.to_instance")), + Type::BooleanLiteral(_) + | Type::BytesLiteral(_) + | Type::FunctionLiteral(_) + | Type::Callable(..) + | Type::MethodWrapper(_) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::NominalInstance(_) + | Type::ProtocolInstance(_) + | Type::KnownInstance(_) + | Type::PropertyInstance(_) + | Type::ModuleLiteral(_) + | Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::Tuple(_) + | Type::LiteralString + | Type::BoundSuper(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy => None, + } + } + + /// If we see a value of this type used as a type expression, what type does it name? + /// + /// For example, the builtin `int` as a value expression is of type + /// `Type::ClassLiteral(builtins.int)`, that is, it is the `int` class itself. As a type + /// expression, it names the type `Type::NominalInstance(builtins.int)`, that is, all objects whose + /// `__class__` is `int`. + pub fn in_type_expression( + &self, + db: &'db dyn Db, + scope_id: ScopeId<'db>, + ) -> Result<Type<'db>, InvalidTypeExpressionError<'db>> { + match self { + // Special cases for `float` and `complex` + // https://typing.python.org/en/latest/spec/special-types.html#special-cases-for-float-and-complex + Type::ClassLiteral(class) => { + let ty = match class.known(db) { + Some(KnownClass::Any) => Type::any(), + Some(KnownClass::Complex) => UnionType::from_elements( + db, + [ + KnownClass::Int.to_instance(db), + KnownClass::Float.to_instance(db), + KnownClass::Complex.to_instance(db), + ], + ), + Some(KnownClass::Float) => UnionType::from_elements( + db, + [ + KnownClass::Int.to_instance(db), + KnownClass::Float.to_instance(db), + ], + ), + _ => Type::instance(db, class.default_specialization(db)), + }; + Ok(ty) + } + Type::GenericAlias(alias) => Ok(Type::instance(db, ClassType::from(*alias))), + + Type::SubclassOf(_) + | Type::BooleanLiteral(_) + | Type::BytesLiteral(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::IntLiteral(_) + | Type::LiteralString + | Type::ModuleLiteral(_) + | Type::StringLiteral(_) + | Type::Tuple(_) + | Type::TypeVar(_) + | Type::Callable(_) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::Never + | Type::FunctionLiteral(_) + | Type::BoundSuper(_) + | Type::ProtocolInstance(_) + | Type::PropertyInstance(_) => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![InvalidTypeExpression::InvalidType( + *self, scope_id + )], + fallback_type: Type::unknown(), + }), + + Type::KnownInstance(known_instance) => match known_instance { + KnownInstanceType::TypeAliasType(alias) => Ok(alias.value_type(db)), + KnownInstanceType::Never | KnownInstanceType::NoReturn => Ok(Type::Never), + KnownInstanceType::LiteralString => Ok(Type::LiteralString), + KnownInstanceType::Unknown => Ok(Type::unknown()), + KnownInstanceType::AlwaysTruthy => Ok(Type::AlwaysTruthy), + KnownInstanceType::AlwaysFalsy => Ok(Type::AlwaysFalsy), + + // We treat `typing.Type` exactly the same as `builtins.type`: + KnownInstanceType::Type => Ok(KnownClass::Type.to_instance(db)), + KnownInstanceType::Tuple => Ok(KnownClass::Tuple.to_instance(db)), + + // Legacy `typing` aliases + KnownInstanceType::List => Ok(KnownClass::List.to_instance(db)), + KnownInstanceType::Dict => Ok(KnownClass::Dict.to_instance(db)), + KnownInstanceType::Set => Ok(KnownClass::Set.to_instance(db)), + KnownInstanceType::FrozenSet => Ok(KnownClass::FrozenSet.to_instance(db)), + KnownInstanceType::ChainMap => Ok(KnownClass::ChainMap.to_instance(db)), + KnownInstanceType::Counter => Ok(KnownClass::Counter.to_instance(db)), + KnownInstanceType::DefaultDict => Ok(KnownClass::DefaultDict.to_instance(db)), + KnownInstanceType::Deque => Ok(KnownClass::Deque.to_instance(db)), + KnownInstanceType::OrderedDict => Ok(KnownClass::OrderedDict.to_instance(db)), + + KnownInstanceType::TypeVar(typevar) => Ok(Type::TypeVar(*typevar)), + + // TODO: Use an opt-in rule for a bare `Callable` + KnownInstanceType::Callable => Ok(Type::Callable(CallableType::unknown(db))), + + KnownInstanceType::TypingSelf => { + let index = semantic_index(db, scope_id.file(db)); + let Some(class) = nearest_enclosing_class(db, index, scope_id) else { + return Err(InvalidTypeExpressionError { + fallback_type: Type::unknown(), + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::InvalidType(*self, scope_id) + ], + }); + }; + let instance = Type::ClassLiteral(class) + .to_instance(db) + .expect("enclosing_class_symbol must return type that can be instantiated"); + Ok(Type::TypeVar(TypeVarInstance::new( + db, + ast::name::Name::new("Self"), + Some(class.definition(db)), + Some(TypeVarBoundOrConstraints::UpperBound(instance)), + TypeVarVariance::Invariant, + None, + TypeVarKind::Legacy, + ))) + } + KnownInstanceType::TypeAlias => Ok(todo_type!("Support for `typing.TypeAlias`")), + KnownInstanceType::TypedDict => Ok(todo_type!("Support for `typing.TypedDict`")), + + KnownInstanceType::Protocol(_) => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![InvalidTypeExpression::Protocol], + fallback_type: Type::unknown(), + }), + KnownInstanceType::Generic(_) => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![InvalidTypeExpression::Generic], + fallback_type: Type::unknown(), + }), + + KnownInstanceType::Literal + | KnownInstanceType::Union + | KnownInstanceType::Intersection => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::RequiresArguments(*self) + ], + fallback_type: Type::unknown(), + }), + + KnownInstanceType::Optional + | KnownInstanceType::Not + | KnownInstanceType::TypeOf + | KnownInstanceType::TypeIs + | KnownInstanceType::TypeGuard + | KnownInstanceType::Unpack + | KnownInstanceType::CallableTypeOf => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::RequiresOneArgument(*self) + ], + fallback_type: Type::unknown(), + }), + + KnownInstanceType::Annotated | KnownInstanceType::Concatenate => { + Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::RequiresTwoArguments(*self) + ], + fallback_type: Type::unknown(), + }) + } + + KnownInstanceType::ClassVar | KnownInstanceType::Final => { + Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::TypeQualifier(*known_instance) + ], + fallback_type: Type::unknown(), + }) + } + + KnownInstanceType::ReadOnly + | KnownInstanceType::NotRequired + | KnownInstanceType::Required => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![ + InvalidTypeExpression::TypeQualifierRequiresOneArgument(*known_instance) + ], + fallback_type: Type::unknown(), + }), + }, + + Type::Union(union) => { + let mut builder = UnionBuilder::new(db); + let mut invalid_expressions = smallvec::SmallVec::default(); + for element in union.elements(db) { + match element.in_type_expression(db, scope_id) { + Ok(type_expr) => builder = builder.add(type_expr), + Err(InvalidTypeExpressionError { + fallback_type, + invalid_expressions: new_invalid_expressions, + }) => { + invalid_expressions.extend(new_invalid_expressions); + builder = builder.add(fallback_type); + } + } + } + if invalid_expressions.is_empty() { + Ok(builder.build()) + } else { + Err(InvalidTypeExpressionError { + fallback_type: builder.build(), + invalid_expressions, + }) + } + } + + Type::Dynamic(_) => Ok(*self), + + Type::NominalInstance(instance) => match instance.class.known(db) { + Some(KnownClass::TypeVar) => Ok(todo_type!( + "Support for `typing.TypeVar` instances in type expressions" + )), + Some( + KnownClass::ParamSpec | KnownClass::ParamSpecArgs | KnownClass::ParamSpecKwargs, + ) => Ok(todo_type!("Support for `typing.ParamSpec`")), + Some(KnownClass::TypeVarTuple) => Ok(todo_type!( + "Support for `typing.TypeVarTuple` instances in type expressions" + )), + Some(KnownClass::NewType) => Ok(todo_type!( + "Support for `typing.NewType` instances in type expressions" + )), + Some(KnownClass::GenericAlias) => Ok(todo_type!( + "Support for `typing.GenericAlias` instances in type expressions" + )), + Some(KnownClass::UnionType) => Ok(todo_type!( + "Support for `types.UnionType` instances in type expressions" + )), + _ => Err(InvalidTypeExpressionError { + invalid_expressions: smallvec::smallvec![InvalidTypeExpression::InvalidType( + *self, scope_id + )], + fallback_type: Type::unknown(), + }), + }, + + Type::Intersection(_) => Ok(todo_type!("Type::Intersection.in_type_expression")), + } + } + + /// The type `NoneType` / `None` + pub fn none(db: &'db dyn Db) -> Type<'db> { + KnownClass::NoneType.to_instance(db) + } + + /// Return the type of `tuple(sys.version_info)`. + /// + /// This is not exactly the type that `sys.version_info` has at runtime, + /// but it's a useful fallback for us in order to infer `Literal` types from `sys.version_info` comparisons. + fn version_info_tuple(db: &'db dyn Db) -> Self { + let python_version = Program::get(db).python_version(db); + let int_instance_ty = KnownClass::Int.to_instance(db); + + // TODO: just grab this type from typeshed (it's a `sys._ReleaseLevel` type alias there) + let release_level_ty = { + let elements: Box<[Type<'db>]> = ["alpha", "beta", "candidate", "final"] + .iter() + .map(|level| Type::string_literal(db, level)) + .collect(); + + // For most unions, it's better to go via `UnionType::from_elements` or use `UnionBuilder`; + // those techniques ensure that union elements are deduplicated and unions are eagerly simplified + // into other types where necessary. Here, however, we know that there are no duplicates + // in this union, so it's probably more efficient to use `UnionType::new()` directly. + Type::Union(UnionType::new(db, elements)) + }; + + TupleType::from_elements( + db, + [ + Type::IntLiteral(python_version.major.into()), + Type::IntLiteral(python_version.minor.into()), + int_instance_ty, + release_level_ty, + int_instance_ty, + ], + ) + } + + /// Given a type that is assumed to represent an instance of a class, + /// return a type that represents that class itself. + #[must_use] + pub fn to_meta_type(&self, db: &'db dyn Db) -> Type<'db> { + match self { + Type::Never => Type::Never, + Type::NominalInstance(instance) => instance.to_meta_type(db), + Type::KnownInstance(known_instance) => known_instance.to_meta_type(db), + Type::PropertyInstance(_) => KnownClass::Property.to_class_literal(db), + Type::Union(union) => union.map(db, |ty| ty.to_meta_type(db)), + Type::BooleanLiteral(_) => KnownClass::Bool.to_class_literal(db), + Type::BytesLiteral(_) => KnownClass::Bytes.to_class_literal(db), + Type::IntLiteral(_) => KnownClass::Int.to_class_literal(db), + Type::FunctionLiteral(_) => KnownClass::FunctionType.to_class_literal(db), + Type::BoundMethod(_) => KnownClass::MethodType.to_class_literal(db), + Type::MethodWrapper(_) => KnownClass::MethodWrapperType.to_class_literal(db), + Type::WrapperDescriptor(_) => KnownClass::WrapperDescriptorType.to_class_literal(db), + Type::DataclassDecorator(_) => KnownClass::FunctionType.to_class_literal(db), + Type::Callable(_) | Type::DataclassTransformer(_) => KnownClass::Type.to_instance(db), + Type::ModuleLiteral(_) => KnownClass::ModuleType.to_class_literal(db), + Type::Tuple(_) => KnownClass::Tuple.to_class_literal(db), + + Type::TypeVar(typevar) => match typevar.bound_or_constraints(db) { + None => KnownClass::Object.to_class_literal(db), + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => bound.to_meta_type(db), + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => { + // TODO: If we add a proper `OneOf` connector, we should use that here instead + // of union. (Using a union here doesn't break anything, but it is imprecise.) + constraints.map(db, |constraint| constraint.to_meta_type(db)) + } + }, + + Type::ClassLiteral(class) => class.metaclass(db), + Type::GenericAlias(alias) => ClassType::from(*alias).metaclass(db), + Type::SubclassOf(subclass_of_ty) => match subclass_of_ty.subclass_of() { + SubclassOfInner::Dynamic(_) => *self, + SubclassOfInner::Class(class) => SubclassOfType::from( + db, + SubclassOfInner::try_from_type(db, class.metaclass(db)) + .unwrap_or(SubclassOfInner::unknown()), + ), + }, + + Type::StringLiteral(_) | Type::LiteralString => KnownClass::Str.to_class_literal(db), + Type::Dynamic(dynamic) => SubclassOfType::from(db, SubclassOfInner::Dynamic(*dynamic)), + // TODO intersections + Type::Intersection(_) => SubclassOfType::from( + db, + SubclassOfInner::try_from_type(db, todo_type!("Intersection meta-type")) + .expect("Type::Todo should be a valid `SubclassOfInner`"), + ), + Type::AlwaysTruthy | Type::AlwaysFalsy => KnownClass::Type.to_instance(db), + Type::BoundSuper(_) => KnownClass::Super.to_class_literal(db), + Type::ProtocolInstance(protocol) => protocol.to_meta_type(db), + } + } + + #[must_use] + pub fn apply_optional_specialization( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + ) -> Type<'db> { + if let Some(specialization) = specialization { + self.apply_specialization(db, specialization) + } else { + self + } + } + + /// Applies a specialization to this type, replacing any typevars with the types that they are + /// specialized to. + /// + /// Note that this does not specialize generic classes, functions, or type aliases! That is a + /// different operation that is performed explicitly (via a subscript operation), or implicitly + /// via a call to the generic object. + #[salsa::tracked] + pub fn apply_specialization( + self, + db: &'db dyn Db, + specialization: Specialization<'db>, + ) -> Type<'db> { + self.apply_type_mapping(db, &TypeMapping::Specialization(specialization)) + } + + fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Type<'db> { + match self { + Type::TypeVar(typevar) => match type_mapping { + TypeMapping::Specialization(specialization) => { + specialization.get(db, typevar).unwrap_or(self) + } + TypeMapping::PartialSpecialization(partial) => { + partial.get(db, typevar).unwrap_or(self) + } + TypeMapping::PromoteLiterals => self, + } + + Type::FunctionLiteral(function) => { + Type::FunctionLiteral(function.with_type_mapping(db, type_mapping)) + } + + Type::BoundMethod(method) => Type::BoundMethod(BoundMethodType::new( + db, + method.function(db).with_type_mapping(db, type_mapping), + method.self_instance(db).apply_type_mapping(db, type_mapping), + )), + + Type::NominalInstance(instance) => Type::NominalInstance( + instance.apply_type_mapping(db, type_mapping), + ), + + Type::ProtocolInstance(instance) => { + Type::ProtocolInstance(instance.apply_type_mapping(db, type_mapping)) + } + + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet(function)) => { + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet( + function.with_type_mapping(db, type_mapping), + )) + } + + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderCall(function)) => { + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderCall( + function.with_type_mapping(db, type_mapping), + )) + } + + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet(property)) => { + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet( + property.apply_type_mapping(db, type_mapping), + )) + } + + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet(property)) => { + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet( + property.apply_type_mapping(db, type_mapping), + )) + } + + Type::Callable(callable) => { + Type::Callable(callable.apply_type_mapping(db, type_mapping)) + } + + Type::GenericAlias(generic) => { + Type::GenericAlias(generic.apply_type_mapping(db, type_mapping)) + } + + Type::SubclassOf(subclass_of) => Type::SubclassOf( + subclass_of.apply_type_mapping(db, type_mapping), + ), + + Type::PropertyInstance(property) => { + Type::PropertyInstance(property.apply_type_mapping(db, type_mapping)) + } + + Type::Union(union) => union.map(db, |element| { + element.apply_type_mapping(db, type_mapping) + }), + Type::Intersection(intersection) => { + let mut builder = IntersectionBuilder::new(db); + for positive in intersection.positive(db) { + builder = + builder.add_positive(positive.apply_type_mapping(db, type_mapping)); + } + for negative in intersection.negative(db) { + builder = + builder.add_negative(negative.apply_type_mapping(db, type_mapping)); + } + builder.build() + } + Type::Tuple(tuple) => TupleType::from_elements( + db, + tuple + .iter(db) + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + ), + + Type::ModuleLiteral(_) + | Type::IntLiteral(_) + | Type::BooleanLiteral(_) + | Type::LiteralString + | Type::StringLiteral(_) + | Type::BytesLiteral(_) => match type_mapping { + TypeMapping::Specialization(_) | + TypeMapping::PartialSpecialization(_) => self, + TypeMapping::PromoteLiterals => self.literal_fallback_instance(db) + .expect("literal type should have fallback instance type"), + } + + Type::Dynamic(_) + | Type::Never + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(MethodWrapperKind::StrStartswith(_)) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + // A non-generic class never needs to be specialized. A generic class is specialized + // explicitly (via a subscript expression) or implicitly (via a call), and not because + // some other generic context's specialization is applied to it. + | Type::ClassLiteral(_) + | Type::BoundSuper(_) + | Type::KnownInstance(_) => self, + } + } + + /// Locates any legacy `TypeVar`s in this type, and adds them to a set. This is used to build + /// up a generic context from any legacy `TypeVar`s that appear in a function parameter list or + /// `Generic` specialization. + pub(crate) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + match self { + Type::TypeVar(typevar) => { + if typevar.is_legacy(db) { + typevars.insert(typevar); + } + } + + Type::FunctionLiteral(function) => function.find_legacy_typevars(db, typevars), + + Type::BoundMethod(method) => { + method.self_instance(db).find_legacy_typevars(db, typevars); + method.function(db).find_legacy_typevars(db, typevars); + } + + Type::MethodWrapper( + MethodWrapperKind::FunctionTypeDunderGet(function) + | MethodWrapperKind::FunctionTypeDunderCall(function), + ) => { + function.find_legacy_typevars(db, typevars); + } + + Type::MethodWrapper( + MethodWrapperKind::PropertyDunderGet(property) + | MethodWrapperKind::PropertyDunderSet(property), + ) => { + property.find_legacy_typevars(db, typevars); + } + + Type::Callable(callable) => { + callable.find_legacy_typevars(db, typevars); + } + + Type::PropertyInstance(property) => { + property.find_legacy_typevars(db, typevars); + } + + Type::Union(union) => { + for element in union.iter(db) { + element.find_legacy_typevars(db, typevars); + } + } + Type::Intersection(intersection) => { + for positive in intersection.positive(db) { + positive.find_legacy_typevars(db, typevars); + } + for negative in intersection.negative(db) { + negative.find_legacy_typevars(db, typevars); + } + } + Type::Tuple(tuple) => { + for element in tuple.iter(db) { + element.find_legacy_typevars(db, typevars); + } + } + + Type::GenericAlias(alias) => { + alias.find_legacy_typevars(db, typevars); + } + + Type::NominalInstance(instance) => { + instance.find_legacy_typevars(db, typevars); + } + + Type::ProtocolInstance(instance) => { + instance.find_legacy_typevars(db, typevars); + } + + Type::SubclassOf(subclass_of) => { + subclass_of.find_legacy_typevars(db, typevars); + } + + Type::Dynamic(_) + | Type::Never + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(MethodWrapperKind::StrStartswith(_)) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::ClassLiteral(_) + | Type::IntLiteral(_) + | Type::BooleanLiteral(_) + | Type::LiteralString + | Type::StringLiteral(_) + | Type::BytesLiteral(_) + | Type::BoundSuper(_) + | Type::KnownInstance(_) => {} + } + } + + /// Return the string representation of this type when converted to string as it would be + /// provided by the `__str__` method. + /// + /// When not available, this should fall back to the value of `[Type::repr]`. + /// Note: this method is used in the builtins `format`, `print`, `str.format` and `f-strings`. + #[must_use] + pub fn str(&self, db: &'db dyn Db) -> Type<'db> { + match self { + Type::IntLiteral(_) | Type::BooleanLiteral(_) => self.repr(db), + Type::StringLiteral(_) | Type::LiteralString => *self, + Type::KnownInstance(known_instance) => Type::StringLiteral(StringLiteralType::new( + db, + known_instance.repr(db).to_string().into_boxed_str(), + )), + // TODO: handle more complex types + _ => KnownClass::Str.to_instance(db), + } + } + + /// Return the string representation of this type as it would be provided by the `__repr__` + /// method at runtime. + #[must_use] + pub fn repr(&self, db: &'db dyn Db) -> Type<'db> { + match self { + Type::IntLiteral(number) => Type::string_literal(db, &number.to_string()), + Type::BooleanLiteral(true) => Type::string_literal(db, "True"), + Type::BooleanLiteral(false) => Type::string_literal(db, "False"), + Type::StringLiteral(literal) => { + Type::string_literal(db, &format!("'{}'", literal.value(db).escape_default())) + } + Type::LiteralString => Type::LiteralString, + Type::KnownInstance(known_instance) => Type::StringLiteral(StringLiteralType::new( + db, + known_instance.repr(db).to_string().into_boxed_str(), + )), + // TODO: handle more complex types + _ => KnownClass::Str.to_instance(db), + } + } + + /// Returns where this type is defined. + /// + /// It's the foundation for the editor's "Go to type definition" feature + /// where the user clicks on a value and it takes them to where the value's type is defined. + /// + /// This method returns `None` for unions and intersections because how these + /// should be handled, especially when some variants don't have definitions, is + /// specific to the call site. + pub fn definition(&self, db: &'db dyn Db) -> Option<TypeDefinition<'db>> { + match self { + Self::BoundMethod(method) => { + Some(TypeDefinition::Function(method.function(db).definition(db))) + } + Self::FunctionLiteral(function) => { + Some(TypeDefinition::Function(function.definition(db))) + } + Self::ModuleLiteral(module) => Some(TypeDefinition::Module(module.module(db))), + Self::ClassLiteral(class_literal) => { + Some(TypeDefinition::Class(class_literal.definition(db))) + } + Self::GenericAlias(alias) => Some(TypeDefinition::Class(alias.definition(db))), + Self::NominalInstance(instance) => { + Some(TypeDefinition::Class(instance.class.definition(db))) + } + Self::KnownInstance(instance) => match instance { + KnownInstanceType::TypeVar(var) => { + Some(TypeDefinition::TypeVar(var.definition(db)?)) + } + KnownInstanceType::TypeAliasType(type_alias) => { + type_alias.definition(db).map(TypeDefinition::TypeAlias) + } + _ => None, + }, + + Self::SubclassOf(subclass_of_type) => match subclass_of_type.subclass_of() { + SubclassOfInner::Class(class) => Some(TypeDefinition::Class(class.definition(db))), + SubclassOfInner::Dynamic(_) => None, + }, + + Self::StringLiteral(_) + | Self::BooleanLiteral(_) + | Self::LiteralString + | Self::IntLiteral(_) + | Self::BytesLiteral(_) + | Self::MethodWrapper(_) + | Self::WrapperDescriptor(_) + | Self::DataclassDecorator(_) + | Self::DataclassTransformer(_) + | Self::PropertyInstance(_) + | Self::BoundSuper(_) + | Self::Tuple(_) => self.to_meta_type(db).definition(db), + + Self::TypeVar(var) => Some(TypeDefinition::TypeVar(var.definition(db)?)), + + Self::ProtocolInstance(protocol) => match protocol.inner { + Protocol::FromClass(class) => Some(TypeDefinition::Class(class.definition(db))), + Protocol::Synthesized(_) => None, + }, + + Self::Union(_) | Self::Intersection(_) => None, + + // These types have no definition + Self::Dynamic(_) + | Self::Never + | Self::Callable(_) + | Self::AlwaysTruthy + | Self::AlwaysFalsy => None, + } + } + + /// Returns a tuple of two spans. The first is + /// the span for the identifier of the function + /// definition for `self`. The second is + /// the span for the parameter in the function + /// definition for `self`. + /// + /// If there are no meaningful spans, then this + /// returns `None`. For example, when this type + /// isn't callable. + /// + /// When `parameter_index` is `None`, then the + /// second span returned covers the entire parameter + /// list. + /// + /// # Performance + /// + /// Note that this may introduce cross-module + /// dependencies. This can have an impact on + /// the effectiveness of incremental caching + /// and should therefore be used judiciously. + /// + /// An example of a good use case is to improve + /// a diagnostic. + fn parameter_span( + &self, + db: &'db dyn Db, + parameter_index: Option<usize>, + ) -> Option<(Span, Span)> { + match *self { + Type::FunctionLiteral(function) => function.parameter_span(db, parameter_index), + Type::BoundMethod(bound_method) => bound_method + .function(db) + .parameter_span(db, parameter_index), + _ => None, + } + } + + /// Returns a collection of useful spans for a + /// function signature. These are useful for + /// creating annotations on diagnostics. + /// + /// If there are no meaningful spans, then this + /// returns `None`. For example, when this type + /// isn't callable. + /// + /// # Performance + /// + /// Note that this may introduce cross-module + /// dependencies. This can have an impact on + /// the effectiveness of incremental caching + /// and should therefore be used judiciously. + /// + /// An example of a good use case is to improve + /// a diagnostic. + fn function_spans(&self, db: &'db dyn Db) -> Option<FunctionSpans> { + match *self { + Type::FunctionLiteral(function) => function.spans(db), + Type::BoundMethod(bound_method) => bound_method.function(db).spans(db), + _ => None, + } + } +} + +impl<'db> From<&Type<'db>> for Type<'db> { + fn from(value: &Type<'db>) -> Self { + *value + } +} + +/// A mapping that can be applied to a type, producing another type. This is applied inductively to +/// the components of complex types. +/// +/// This is represented as an enum (with some variants using `Cow`), and not an `FnMut` trait, +/// since we sometimes have to apply type mappings lazily (e.g., to the signature of a function +/// literal). +#[derive(Clone, Debug, Eq, Hash, PartialEq)] +pub enum TypeMapping<'a, 'db> { + /// Applies a specialization to the type + Specialization(Specialization<'db>), + /// Applies a partial specialization to the type + PartialSpecialization(PartialSpecialization<'a, 'db>), + /// Promotes any literal types to their corresponding instance types (e.g. `Literal["string"]` + /// to `str`) + PromoteLiterals, +} + +impl<'db> TypeMapping<'_, 'db> { + fn to_owned(&self) -> TypeMapping<'db, 'db> { + match self { + TypeMapping::Specialization(specialization) => { + TypeMapping::Specialization(*specialization) + } + TypeMapping::PartialSpecialization(partial) => { + TypeMapping::PartialSpecialization(partial.to_owned()) + } + TypeMapping::PromoteLiterals => TypeMapping::PromoteLiterals, + } + } + + fn normalized(&self, db: &'db dyn Db) -> Self { + match self { + TypeMapping::Specialization(specialization) => { + TypeMapping::Specialization(specialization.normalized(db)) + } + TypeMapping::PartialSpecialization(partial) => { + TypeMapping::PartialSpecialization(partial.normalized(db)) + } + TypeMapping::PromoteLiterals => TypeMapping::PromoteLiterals, + } + } +} + +#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)] +pub enum DynamicType { + // An explicitly annotated `typing.Any` + Any, + // An unannotated value, or a dynamic type resulting from an error + Unknown, + /// Temporary type for symbols that can't be inferred yet because of missing implementations. + /// + /// This variant should eventually be removed once ty is spec-compliant. + /// + /// General rule: `Todo` should only propagate when the presence of the input `Todo` caused the + /// output to be unknown. An output should only be `Todo` if fixing all `Todo` inputs to be not + /// `Todo` would change the output type. + /// + /// This variant should be created with the `todo_type!` macro. + Todo(TodoType), + /// A special Todo-variant for PEP-695 `ParamSpec` types. A temporary variant to detect and special- + /// case the handling of these types in `Callable` annotations. + TodoPEP695ParamSpec, +} + +impl DynamicType { + #[expect(clippy::unused_self)] + fn normalized(self) -> Self { + Self::Any + } +} + +impl std::fmt::Display for DynamicType { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + DynamicType::Any => f.write_str("Any"), + DynamicType::Unknown => f.write_str("Unknown"), + // `DynamicType::Todo`'s display should be explicit that is not a valid display of + // any other type + DynamicType::Todo(todo) => write!(f, "@Todo{todo}"), + DynamicType::TodoPEP695ParamSpec => { + if cfg!(debug_assertions) { + f.write_str("@Todo(ParamSpec)") + } else { + f.write_str("@Todo") + } + } + } + } +} + +bitflags! { + /// Type qualifiers that appear in an annotation expression. + #[derive(Copy, Clone, Debug, Eq, PartialEq, Default, salsa::Update, Hash)] + pub(crate) struct TypeQualifiers: u8 { + /// `typing.ClassVar` + const CLASS_VAR = 1 << 0; + /// `typing.Final` + const FINAL = 1 << 1; + } +} + +/// When inferring the type of an annotation expression, we can also encounter type qualifiers +/// such as `ClassVar` or `Final`. These do not affect the inferred type itself, but rather +/// control how a particular symbol can be accessed or modified. This struct holds a type and +/// a set of type qualifiers. +/// +/// Example: `Annotated[ClassVar[tuple[int]], "metadata"]` would have type `tuple[int]` and the +/// qualifier `ClassVar`. +#[derive(Clone, Debug, Copy, Eq, PartialEq, salsa::Update)] +pub(crate) struct TypeAndQualifiers<'db> { + inner: Type<'db>, + qualifiers: TypeQualifiers, +} + +impl<'db> TypeAndQualifiers<'db> { + pub(crate) fn new(inner: Type<'db>, qualifiers: TypeQualifiers) -> Self { + Self { inner, qualifiers } + } + + /// Constructor that creates a [`TypeAndQualifiers`] instance with type `Unknown` and no qualifiers. + pub(crate) fn unknown() -> Self { + Self { + inner: Type::unknown(), + qualifiers: TypeQualifiers::empty(), + } + } + + /// Forget about type qualifiers and only return the inner type. + pub(crate) fn inner_type(&self) -> Type<'db> { + self.inner + } + + /// Insert/add an additional type qualifier. + pub(crate) fn add_qualifier(&mut self, qualifier: TypeQualifiers) { + self.qualifiers |= qualifier; + } + + /// Return the set of type qualifiers. + pub(crate) fn qualifiers(&self) -> TypeQualifiers { + self.qualifiers + } +} + +impl<'db> From<Type<'db>> for TypeAndQualifiers<'db> { + fn from(inner: Type<'db>) -> Self { + Self { + inner, + qualifiers: TypeQualifiers::empty(), + } + } +} + +/// Error struct providing information on type(s) that were deemed to be invalid +/// in a type expression context, and the type we should therefore fallback to +/// for the problematic type expression. +#[derive(Debug, PartialEq, Eq)] +pub struct InvalidTypeExpressionError<'db> { + fallback_type: Type<'db>, + invalid_expressions: smallvec::SmallVec<[InvalidTypeExpression<'db>; 1]>, +} + +impl<'db> InvalidTypeExpressionError<'db> { + fn into_fallback_type( + self, + context: &InferContext, + node: &ast::Expr, + is_reachable: bool, + ) -> Type<'db> { + let InvalidTypeExpressionError { + fallback_type, + invalid_expressions, + } = self; + if is_reachable { + for error in invalid_expressions { + let Some(builder) = context.report_lint(&INVALID_TYPE_FORM, node) else { + continue; + }; + let diagnostic = builder.into_diagnostic(error.reason(context.db())); + error.add_subdiagnostics(context.db(), diagnostic); + } + } + fallback_type + } +} + +/// Enumeration of various types that are invalid in type-expression contexts +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +enum InvalidTypeExpression<'db> { + /// Some types always require exactly one argument when used in a type expression + RequiresOneArgument(Type<'db>), + /// Some types always require at least one argument when used in a type expression + RequiresArguments(Type<'db>), + /// Some types always require at least two arguments when used in a type expression + RequiresTwoArguments(Type<'db>), + /// The `Protocol` class is invalid in type expressions + Protocol, + /// Same for `Generic` + Generic, + /// Type qualifiers are always invalid in *type expressions*, + /// but these ones are okay with 0 arguments in *annotation expressions* + TypeQualifier(KnownInstanceType<'db>), + /// Type qualifiers that are invalid in type expressions, + /// and which would require exactly one argument even if they appeared in an annotation expression + TypeQualifierRequiresOneArgument(KnownInstanceType<'db>), + /// Some types are always invalid in type expressions + InvalidType(Type<'db>, ScopeId<'db>), +} + +impl<'db> InvalidTypeExpression<'db> { + const fn reason(self, db: &'db dyn Db) -> impl std::fmt::Display + 'db { + struct Display<'db> { + error: InvalidTypeExpression<'db>, + db: &'db dyn Db, + } + + impl std::fmt::Display for Display<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self.error { + InvalidTypeExpression::RequiresOneArgument(ty) => write!( + f, + "`{ty}` requires exactly one argument when used in a type expression", + ty = ty.display(self.db) + ), + InvalidTypeExpression::RequiresArguments(ty) => write!( + f, + "`{ty}` requires at least one argument when used in a type expression", + ty = ty.display(self.db) + ), + InvalidTypeExpression::RequiresTwoArguments(ty) => write!( + f, + "`{ty}` requires at least two arguments when used in a type expression", + ty = ty.display(self.db) + ), + InvalidTypeExpression::Protocol => { + f.write_str("`typing.Protocol` is not allowed in type expressions") + } + InvalidTypeExpression::Generic => { + f.write_str("`typing.Generic` is not allowed in type expressions") + } + InvalidTypeExpression::TypeQualifier(qualifier) => write!( + f, + "Type qualifier `{q}` is not allowed in type expressions (only in annotation expressions)", + q = qualifier.repr(self.db) + ), + InvalidTypeExpression::TypeQualifierRequiresOneArgument(qualifier) => write!( + f, + "Type qualifier `{q}` is not allowed in type expressions (only in annotation expressions, and only with exactly one argument)", + q = qualifier.repr(self.db) + ), + InvalidTypeExpression::InvalidType(ty, _) => write!( + f, + "Variable of type `{ty}` is not allowed in a type expression", + ty = ty.display(self.db) + ), + } + } + } + + Display { error: self, db } + } + + fn add_subdiagnostics(self, db: &'db dyn Db, mut diagnostic: LintDiagnosticGuard) { + let InvalidTypeExpression::InvalidType(ty, scope) = self else { + return; + }; + let Type::ModuleLiteral(module_type) = ty else { + return; + }; + let module = module_type.module(db); + let Some(module_name_final_part) = module.name().components().next_back() else { + return; + }; + let Some(module_member_with_same_name) = ty + .member(db, module_name_final_part) + .symbol + .ignore_possibly_unbound() + else { + return; + }; + if module_member_with_same_name + .in_type_expression(db, scope) + .is_err() + { + return; + } + + // TODO: showing a diff (and even having an autofix) would be even better + diagnostic.info(format_args!( + "Did you mean to use the module's member \ + `{module_name_final_part}.{module_name_final_part}` instead?" + )); + } +} + +/// Whether this typecar was created via the legacy `TypeVar` constructor, or using PEP 695 syntax. +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] +pub enum TypeVarKind { + Legacy, + Pep695, +} + +/// Data regarding a single type variable. +/// +/// This is referenced by `KnownInstanceType::TypeVar` (to represent the singleton type of the +/// runtime `typing.TypeVar` object itself), and by `Type::TypeVar` to represent the type that this +/// typevar represents as an annotation: that is, an unknown set of objects, constrained by the +/// upper-bound/constraints on this type var, defaulting to the default type of this type var when +/// not otherwise bound to a type. +/// +/// # Ordering +/// Ordering is based on the type var instance's salsa-assigned id and not on its values. +/// The id may change between runs, or when the type var instance was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct TypeVarInstance<'db> { + /// The name of this TypeVar (e.g. `T`) + #[returns(ref)] + name: ast::name::Name, + + /// The type var's definition (None if synthesized) + pub definition: Option<Definition<'db>>, + + /// The upper bound or constraint on the type of this TypeVar + bound_or_constraints: Option<TypeVarBoundOrConstraints<'db>>, + + /// The variance of the TypeVar + variance: TypeVarVariance, + + /// The default type for this TypeVar + default_ty: Option<Type<'db>>, + + pub kind: TypeVarKind, +} + +impl<'db> TypeVarInstance<'db> { + pub(crate) fn is_legacy(self, db: &'db dyn Db) -> bool { + matches!(self.kind(db), TypeVarKind::Legacy) + } + + pub(crate) fn upper_bound(self, db: &'db dyn Db) -> Option<Type<'db>> { + if let Some(TypeVarBoundOrConstraints::UpperBound(ty)) = self.bound_or_constraints(db) { + Some(ty) + } else { + None + } + } + + pub(crate) fn constraints(self, db: &'db dyn Db) -> Option<&'db [Type<'db>]> { + if let Some(TypeVarBoundOrConstraints::Constraints(tuple)) = self.bound_or_constraints(db) { + Some(tuple.elements(db)) + } else { + None + } + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + Self::new( + db, + self.name(db), + self.definition(db), + self.bound_or_constraints(db).map(|b| b.normalized(db)), + self.variance(db), + self.default_ty(db).map(|d| d.normalized(db)), + self.kind(db), + ) + } +} + +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, salsa::Update)] +pub enum TypeVarVariance { + Invariant, + Covariant, + Contravariant, + Bivariant, +} + +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, salsa::Update)] +pub enum TypeVarBoundOrConstraints<'db> { + UpperBound(Type<'db>), + Constraints(UnionType<'db>), +} + +impl<'db> TypeVarBoundOrConstraints<'db> { + fn normalized(self, db: &'db dyn Db) -> Self { + match self { + TypeVarBoundOrConstraints::UpperBound(bound) => { + TypeVarBoundOrConstraints::UpperBound(bound.normalized(db)) + } + TypeVarBoundOrConstraints::Constraints(constraints) => { + TypeVarBoundOrConstraints::Constraints(constraints.normalized(db)) + } + } + } +} + +/// Error returned if a type is not (or may not be) a context manager. +#[derive(Debug)] +enum ContextManagerError<'db> { + Enter(CallDunderError<'db>), + Exit { + enter_return_type: Type<'db>, + exit_error: CallDunderError<'db>, + }, + EnterAndExit { + enter_error: CallDunderError<'db>, + exit_error: CallDunderError<'db>, + }, +} + +impl<'db> ContextManagerError<'db> { + fn fallback_enter_type(&self, db: &'db dyn Db) -> Type<'db> { + self.enter_type(db).unwrap_or(Type::unknown()) + } + + /// Returns the `__enter__` return type if it is known, + /// or `None` if the type never has a callable `__enter__` attribute + fn enter_type(&self, db: &'db dyn Db) -> Option<Type<'db>> { + match self { + Self::Exit { + enter_return_type, + exit_error: _, + } => Some(*enter_return_type), + Self::Enter(enter_error) + | Self::EnterAndExit { + enter_error, + exit_error: _, + } => match enter_error { + CallDunderError::PossiblyUnbound(call_outcome) => { + Some(call_outcome.return_type(db)) + } + CallDunderError::CallError(CallErrorKind::NotCallable, _) => None, + CallDunderError::CallError(_, bindings) => Some(bindings.return_type(db)), + CallDunderError::MethodNotAvailable => None, + }, + } + } + + fn report_diagnostic( + &self, + context: &InferContext<'db>, + context_expression_type: Type<'db>, + context_expression_node: ast::AnyNodeRef, + ) { + let Some(builder) = context.report_lint(&INVALID_CONTEXT_MANAGER, context_expression_node) + else { + return; + }; + + let format_call_dunder_error = |call_dunder_error: &CallDunderError<'db>, name: &str| { + match call_dunder_error { + CallDunderError::MethodNotAvailable => format!("it does not implement `{name}`"), + CallDunderError::PossiblyUnbound(_) => { + format!("the method `{name}` is possibly unbound") + } + // TODO: Use more specific error messages for the different error cases. + // E.g. hint toward the union variant that doesn't correctly implement enter, + // distinguish between a not callable `__enter__` attribute and a wrong signature. + CallDunderError::CallError(_, _) => { + format!("it does not correctly implement `{name}`") + } + } + }; + + let format_call_dunder_errors = |error_a: &CallDunderError<'db>, + name_a: &str, + error_b: &CallDunderError<'db>, + name_b: &str| { + match (error_a, error_b) { + (CallDunderError::PossiblyUnbound(_), CallDunderError::PossiblyUnbound(_)) => { + format!("the methods `{name_a}` and `{name_b}` are possibly unbound") + } + (CallDunderError::MethodNotAvailable, CallDunderError::MethodNotAvailable) => { + format!("it does not implement `{name_a}` and `{name_b}`") + } + (CallDunderError::CallError(_, _), CallDunderError::CallError(_, _)) => { + format!("it does not correctly implement `{name_a}` or `{name_b}`") + } + (_, _) => format!( + "{format_a}, and {format_b}", + format_a = format_call_dunder_error(error_a, name_a), + format_b = format_call_dunder_error(error_b, name_b) + ), + } + }; + + let db = context.db(); + + let formatted_errors = match self { + Self::Exit { + enter_return_type: _, + exit_error, + } => format_call_dunder_error(exit_error, "__exit__"), + Self::Enter(enter_error) => format_call_dunder_error(enter_error, "__enter__"), + Self::EnterAndExit { + enter_error, + exit_error, + } => format_call_dunder_errors(enter_error, "__enter__", exit_error, "__exit__"), + }; + + builder.into_diagnostic( + format_args!( + "Object of type `{context_expression}` cannot be used with `with` because {formatted_errors}", + context_expression = context_expression_type.display(db) + ), + ); + } +} + +/// Error returned if a type is not (or may not be) iterable. +#[derive(Debug)] +enum IterationError<'db> { + /// The object being iterated over has a bound `__iter__` method, + /// but calling it with the expected arguments results in an error. + IterCallError(CallErrorKind, Box<Bindings<'db>>), + + /// The object being iterated over has a bound `__iter__` method that can be called + /// with the expected types, but it returns an object that is not a valid iterator. + IterReturnsInvalidIterator { + /// The type of the object returned by the `__iter__` method. + iterator: Type<'db>, + /// The error we encountered when we tried to call `__next__` on the type + /// returned by `__iter__` + dunder_next_error: CallDunderError<'db>, + }, + + /// The object being iterated over has a bound `__iter__` method that returns a + /// valid iterator. However, the `__iter__` method is possibly unbound, and there + /// either isn't a `__getitem__` method to fall back to, or calling the `__getitem__` + /// method returns some kind of error. + PossiblyUnboundIterAndGetitemError { + /// The type of the object returned by the `__next__` method on the iterator. + /// (The iterator being the type returned by the `__iter__` method on the iterable.) + dunder_next_return: Type<'db>, + /// The error we encountered when we tried to call `__getitem__` on the iterable. + dunder_getitem_error: CallDunderError<'db>, + }, + + /// The object being iterated over doesn't have an `__iter__` method. + /// It also either doesn't have a `__getitem__` method to fall back to, + /// or calling the `__getitem__` method returns some kind of error. + UnboundIterAndGetitemError { + dunder_getitem_error: CallDunderError<'db>, + }, +} + +impl<'db> IterationError<'db> { + fn fallback_element_type(&self, db: &'db dyn Db) -> Type<'db> { + self.element_type(db).unwrap_or(Type::unknown()) + } + + /// Returns the element type if it is known, or `None` if the type is never iterable. + fn element_type(&self, db: &'db dyn Db) -> Option<Type<'db>> { + match self { + Self::IterReturnsInvalidIterator { + dunder_next_error, .. + } => dunder_next_error.return_type(db), + + Self::IterCallError(_, dunder_iter_bindings) => dunder_iter_bindings + .return_type(db) + .try_call_dunder(db, "__next__", CallArgumentTypes::none()) + .map(|dunder_next_outcome| Some(dunder_next_outcome.return_type(db))) + .unwrap_or_else(|dunder_next_call_error| dunder_next_call_error.return_type(db)), + + Self::PossiblyUnboundIterAndGetitemError { + dunder_next_return, + dunder_getitem_error, + } => match dunder_getitem_error { + CallDunderError::MethodNotAvailable => Some(*dunder_next_return), + CallDunderError::PossiblyUnbound(dunder_getitem_outcome) => { + Some(UnionType::from_elements( + db, + [*dunder_next_return, dunder_getitem_outcome.return_type(db)], + )) + } + CallDunderError::CallError(CallErrorKind::NotCallable, _) => { + Some(*dunder_next_return) + } + CallDunderError::CallError(_, dunder_getitem_bindings) => { + let dunder_getitem_return = dunder_getitem_bindings.return_type(db); + let elements = [*dunder_next_return, dunder_getitem_return]; + Some(UnionType::from_elements(db, elements)) + } + }, + + Self::UnboundIterAndGetitemError { + dunder_getitem_error, + } => dunder_getitem_error.return_type(db), + } + } + + /// Reports the diagnostic for this error. + fn report_diagnostic( + &self, + context: &InferContext<'db>, + iterable_type: Type<'db>, + iterable_node: ast::AnyNodeRef, + ) { + /// A little helper type for emitting a diagnostic + /// based on the variant of iteration error. + struct Reporter<'a> { + db: &'a dyn Db, + builder: LintDiagnosticGuardBuilder<'a, 'a>, + iterable_type: Type<'a>, + } + + impl<'a> Reporter<'a> { + /// Emit a diagnostic that is certain that `iterable_type` is not iterable. + /// + /// `because` should explain why `iterable_type` is not iterable. + #[expect(clippy::wrong_self_convention)] + fn is_not(self, because: impl std::fmt::Display) -> LintDiagnosticGuard<'a, 'a> { + let mut diag = self.builder.into_diagnostic(format_args!( + "Object of type `{iterable_type}` is not iterable", + iterable_type = self.iterable_type.display(self.db), + )); + diag.info(because); + diag + } + + /// Emit a diagnostic that is uncertain that `iterable_type` is not iterable. + /// + /// `because` should explain why `iterable_type` is likely not iterable. + fn may_not(self, because: impl std::fmt::Display) -> LintDiagnosticGuard<'a, 'a> { + let mut diag = self.builder.into_diagnostic(format_args!( + "Object of type `{iterable_type}` may not be iterable", + iterable_type = self.iterable_type.display(self.db), + )); + diag.info(because); + diag + } + } + + let Some(builder) = context.report_lint(&NOT_ITERABLE, iterable_node) else { + return; + }; + let db = context.db(); + let reporter = Reporter { + db, + builder, + iterable_type, + }; + + // TODO: for all of these error variants, the "explanation" for the diagnostic + // (everything after the "because") should really be presented as a "help:", "note", + // or similar, rather than as part of the same sentence as the error message. + match self { + Self::IterCallError(CallErrorKind::NotCallable, bindings) => { + reporter.is_not(format_args!( + "Its `__iter__` attribute has type `{dunder_iter_type}`, which is not callable", + dunder_iter_type = bindings.callable_type().display(db), + )); + } + Self::IterCallError(CallErrorKind::PossiblyNotCallable, bindings) + if bindings.is_single() => + { + reporter.may_not(format_args!( + "Its `__iter__` attribute (with type `{dunder_iter_type}`) \ + may not be callable", + dunder_iter_type = bindings.callable_type().display(db), + )); + } + Self::IterCallError(CallErrorKind::PossiblyNotCallable, bindings) => { + reporter.may_not(format_args!( + "Its `__iter__` attribute (with type `{dunder_iter_type}`) \ + may not be callable", + dunder_iter_type = bindings.callable_type().display(db), + )); + } + Self::IterCallError(CallErrorKind::BindingError, bindings) if bindings.is_single() => { + reporter + .is_not("Its `__iter__` method has an invalid signature") + .info("Expected signature `def __iter__(self): ...`"); + } + Self::IterCallError(CallErrorKind::BindingError, bindings) => { + let mut diag = + reporter.may_not("Its `__iter__` method may have an invalid signature"); + diag.info(format_args!( + "Type of `__iter__` is `{dunder_iter_type}`", + dunder_iter_type = bindings.callable_type().display(db), + )); + diag.info("Expected signature for `__iter__` is `def __iter__(self): ...`"); + } + + Self::IterReturnsInvalidIterator { + iterator, + dunder_next_error, + } => match dunder_next_error { + CallDunderError::MethodNotAvailable => { + reporter.is_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which has no `__next__` method", + iterator_type = iterator.display(db), + )); + } + CallDunderError::PossiblyUnbound(_) => { + reporter.may_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which may not have a `__next__` method", + iterator_type = iterator.display(db), + )); + } + CallDunderError::CallError(CallErrorKind::NotCallable, _) => { + reporter.is_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which has a `__next__` attribute that is not callable", + iterator_type = iterator.display(db), + )); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, _) => { + reporter.may_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which has a `__next__` attribute that may not be callable", + iterator_type = iterator.display(db), + )); + } + CallDunderError::CallError(CallErrorKind::BindingError, bindings) + if bindings.is_single() => + { + reporter + .is_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which has an invalid `__next__` method", + iterator_type = iterator.display(db), + )) + .info("Expected signature for `__next__` is `def __next__(self): ...`"); + } + CallDunderError::CallError(CallErrorKind::BindingError, _) => { + reporter + .may_not(format_args!( + "Its `__iter__` method returns an object of type `{iterator_type}`, \ + which may have an invalid `__next__` method", + iterator_type = iterator.display(db), + )) + .info("Expected signature for `__next__` is `def __next__(self): ...`)"); + } + }, + + Self::PossiblyUnboundIterAndGetitemError { + dunder_getitem_error, + .. + } => match dunder_getitem_error { + CallDunderError::MethodNotAvailable => { + reporter.may_not( + "It may not have an `__iter__` method \ + and it doesn't have a `__getitem__` method", + ); + } + CallDunderError::PossiblyUnbound(_) => { + reporter + .may_not("It may not have an `__iter__` method or a `__getitem__` method"); + } + CallDunderError::CallError(CallErrorKind::NotCallable, bindings) => { + reporter.may_not(format_args!( + "It may not have an `__iter__` method \ + and its `__getitem__` attribute has type `{dunder_getitem_type}`, \ + which is not callable", + dunder_getitem_type = bindings.callable_type().display(db), + )); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, bindings) + if bindings.is_single() => + { + reporter.may_not( + "It may not have an `__iter__` method \ + and its `__getitem__` attribute may not be callable", + ); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, bindings) => { + reporter.may_not(format_args!( + "It may not have an `__iter__` method \ + and its `__getitem__` attribute (with type `{dunder_getitem_type}`) \ + may not be callable", + dunder_getitem_type = bindings.callable_type().display(db), + )); + } + CallDunderError::CallError(CallErrorKind::BindingError, bindings) + if bindings.is_single() => + { + reporter + .may_not( + "It may not have an `__iter__` method \ + and its `__getitem__` method has an incorrect signature \ + for the old-style iteration protocol", + ) + .info( + "`__getitem__` must be at least as permissive as \ + `def __getitem__(self, key: int): ...` \ + to satisfy the old-style iteration protocol", + ); + } + CallDunderError::CallError(CallErrorKind::BindingError, bindings) => { + reporter + .may_not(format_args!( + "It may not have an `__iter__` method \ + and its `__getitem__` method (with type `{dunder_getitem_type}`) \ + may have an incorrect signature for the old-style iteration protocol", + dunder_getitem_type = bindings.callable_type().display(db), + )) + .info( + "`__getitem__` must be at least as permissive as \ + `def __getitem__(self, key: int): ...` \ + to satisfy the old-style iteration protocol", + ); + } + }, + + Self::UnboundIterAndGetitemError { + dunder_getitem_error, + } => match dunder_getitem_error { + CallDunderError::MethodNotAvailable => { + reporter + .is_not("It doesn't have an `__iter__` method or a `__getitem__` method"); + } + CallDunderError::PossiblyUnbound(_) => { + reporter.is_not( + "It has no `__iter__` method and it may not have a `__getitem__` method", + ); + } + CallDunderError::CallError(CallErrorKind::NotCallable, bindings) => { + reporter.is_not(format_args!( + "It has no `__iter__` method and \ + its `__getitem__` attribute has type `{dunder_getitem_type}`, \ + which is not callable", + dunder_getitem_type = bindings.callable_type().display(db), + )); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, bindings) + if bindings.is_single() => + { + reporter.may_not( + "It has no `__iter__` method and its `__getitem__` attribute \ + may not be callable", + ); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, bindings) => { + reporter.may_not( + "It has no `__iter__` method and its `__getitem__` attribute is invalid", + ).info(format_args!( + "`__getitem__` has type `{dunder_getitem_type}`, which is not callable", + dunder_getitem_type = bindings.callable_type().display(db), + )); + } + CallDunderError::CallError(CallErrorKind::BindingError, bindings) + if bindings.is_single() => + { + reporter + .is_not( + "It has no `__iter__` method and \ + its `__getitem__` method has an incorrect signature \ + for the old-style iteration protocol", + ) + .info( + "`__getitem__` must be at least as permissive as \ + `def __getitem__(self, key: int): ...` \ + to satisfy the old-style iteration protocol", + ); + } + CallDunderError::CallError(CallErrorKind::BindingError, bindings) => { + reporter + .may_not(format_args!( + "It has no `__iter__` method and \ + its `__getitem__` method (with type `{dunder_getitem_type}`) \ + may have an incorrect signature for the old-style iteration protocol", + dunder_getitem_type = bindings.callable_type().display(db), + )) + .info( + "`__getitem__` must be at least as permissive as \ + `def __getitem__(self, key: int): ...` \ + to satisfy the old-style iteration protocol", + ); + } + }, + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(super) enum BoolError<'db> { + /// The type has a `__bool__` attribute but it can't be called. + NotCallable { not_boolable_type: Type<'db> }, + + /// The type has a callable `__bool__` attribute, but it isn't callable + /// with the given arguments. + IncorrectArguments { + not_boolable_type: Type<'db>, + truthiness: Truthiness, + }, + + /// The type has a `__bool__` method, is callable with the given arguments, + /// but the return type isn't assignable to `bool`. + IncorrectReturnType { + not_boolable_type: Type<'db>, + return_type: Type<'db>, + }, + + /// A union type doesn't implement `__bool__` correctly. + Union { + union: UnionType<'db>, + truthiness: Truthiness, + }, + + /// Any other reason why the type can't be converted to a bool. + /// E.g. because calling `__bool__` returns in a union type and not all variants support `__bool__` or + /// because `__bool__` points to a type that has a possibly unbound `__call__` method. + Other { not_boolable_type: Type<'db> }, +} + +impl<'db> BoolError<'db> { + pub(super) fn fallback_truthiness(&self) -> Truthiness { + match self { + BoolError::NotCallable { .. } + | BoolError::IncorrectReturnType { .. } + | BoolError::Other { .. } => Truthiness::Ambiguous, + BoolError::IncorrectArguments { truthiness, .. } + | BoolError::Union { truthiness, .. } => *truthiness, + } + } + + fn not_boolable_type(&self) -> Type<'db> { + match self { + BoolError::NotCallable { + not_boolable_type, .. + } + | BoolError::IncorrectArguments { + not_boolable_type, .. + } + | BoolError::Other { not_boolable_type } + | BoolError::IncorrectReturnType { + not_boolable_type, .. + } => *not_boolable_type, + BoolError::Union { union, .. } => Type::Union(*union), + } + } + + pub(super) fn report_diagnostic(&self, context: &InferContext, condition: impl Ranged) { + self.report_diagnostic_impl(context, condition.range()); + } + + fn report_diagnostic_impl(&self, context: &InferContext, condition: TextRange) { + let Some(builder) = context.report_lint(&UNSUPPORTED_BOOL_CONVERSION, condition) else { + return; + }; + match self { + Self::IncorrectArguments { + not_boolable_type, .. + } => { + let mut diag = builder.into_diagnostic(format_args!( + "Boolean conversion is unsupported for type `{}`", + not_boolable_type.display(context.db()) + )); + let mut sub = SubDiagnostic::new( + Severity::Info, + "`__bool__` methods must only have a `self` parameter", + ); + if let Some((func_span, parameter_span)) = not_boolable_type + .member(context.db(), "__bool__") + .into_lookup_result() + .ok() + .and_then(|quals| quals.inner_type().parameter_span(context.db(), None)) + { + sub.annotate( + Annotation::primary(parameter_span).message("Incorrect parameters"), + ); + sub.annotate(Annotation::secondary(func_span).message("Method defined here")); + } + diag.sub(sub); + } + Self::IncorrectReturnType { + not_boolable_type, + return_type, + } => { + let mut diag = builder.into_diagnostic(format_args!( + "Boolean conversion is unsupported for type `{not_boolable}`", + not_boolable = not_boolable_type.display(context.db()), + )); + let mut sub = SubDiagnostic::new( + Severity::Info, + format_args!( + "`{return_type}` is not assignable to `bool`", + return_type = return_type.display(context.db()), + ), + ); + if let Some((func_span, return_type_span)) = not_boolable_type + .member(context.db(), "__bool__") + .into_lookup_result() + .ok() + .and_then(|quals| quals.inner_type().function_spans(context.db())) + .and_then(|spans| Some((spans.name, spans.return_type?))) + { + sub.annotate( + Annotation::primary(return_type_span).message("Incorrect return type"), + ); + sub.annotate(Annotation::secondary(func_span).message("Method defined here")); + } + diag.sub(sub); + } + Self::NotCallable { not_boolable_type } => { + let mut diag = builder.into_diagnostic(format_args!( + "Boolean conversion is unsupported for type `{}`", + not_boolable_type.display(context.db()) + )); + let sub = SubDiagnostic::new( + Severity::Info, + format_args!( + "`__bool__` on `{}` must be callable", + not_boolable_type.display(context.db()) + ), + ); + // TODO: It would be nice to create an annotation here for + // where `__bool__` is defined. At time of writing, I couldn't + // figure out a straight-forward way of doing this. ---AG + diag.sub(sub); + } + Self::Union { union, .. } => { + let first_error = union + .elements(context.db()) + .iter() + .find_map(|element| element.try_bool(context.db()).err()) + .unwrap(); + + builder.into_diagnostic(format_args!( + "Boolean conversion is unsupported for union `{}` \ + because `{}` doesn't implement `__bool__` correctly", + Type::Union(*union).display(context.db()), + first_error.not_boolable_type().display(context.db()), + )); + } + + Self::Other { not_boolable_type } => { + builder.into_diagnostic(format_args!( + "Boolean conversion is unsupported for type `{}`; \ + it incorrectly implements `__bool__`", + not_boolable_type.display(context.db()) + )); + } + } + } +} + +/// Represents possibly failure modes of implicit `__new__` calls. +#[derive(Debug)] +enum DunderNewCallError<'db> { + /// The call to `__new__` failed. + CallError(CallError<'db>), + /// The `__new__` method could be unbound. If the call to the + /// method has also failed, this variant also includes the + /// corresponding `CallError`. + PossiblyUnbound(Option<CallError<'db>>), +} + +/// Error returned if a class instantiation call failed +#[derive(Debug)] +enum ConstructorCallError<'db> { + Init(Type<'db>, CallDunderError<'db>), + New(Type<'db>, DunderNewCallError<'db>), + NewAndInit(Type<'db>, DunderNewCallError<'db>, CallDunderError<'db>), +} + +impl<'db> ConstructorCallError<'db> { + fn return_type(&self) -> Type<'db> { + match self { + Self::Init(ty, _) => *ty, + Self::New(ty, _) => *ty, + Self::NewAndInit(ty, _, _) => *ty, + } + } + + fn report_diagnostic( + &self, + context: &InferContext<'db>, + context_expression_type: Type<'db>, + context_expression_node: ast::AnyNodeRef, + ) { + let report_init_error = |call_dunder_error: &CallDunderError<'db>| match call_dunder_error { + CallDunderError::MethodNotAvailable => { + if let Some(builder) = + context.report_lint(&CALL_POSSIBLY_UNBOUND_METHOD, context_expression_node) + { + // If we are using vendored typeshed, it should be impossible to have missing + // or unbound `__init__` method on a class, as all classes have `object` in MRO. + // Thus the following may only trigger if a custom typeshed is used. + builder.into_diagnostic(format_args!( + "`__init__` method is missing on type `{}`. \ + Make sure your `object` in typeshed has its definition.", + context_expression_type.display(context.db()), + )); + } + } + CallDunderError::PossiblyUnbound(bindings) => { + if let Some(builder) = + context.report_lint(&CALL_POSSIBLY_UNBOUND_METHOD, context_expression_node) + { + builder.into_diagnostic(format_args!( + "Method `__init__` on type `{}` is possibly unbound.", + context_expression_type.display(context.db()), + )); + } + + bindings.report_diagnostics(context, context_expression_node); + } + CallDunderError::CallError(_, bindings) => { + bindings.report_diagnostics(context, context_expression_node); + } + }; + + let report_new_error = |error: &DunderNewCallError<'db>| match error { + DunderNewCallError::PossiblyUnbound(call_error) => { + if let Some(builder) = + context.report_lint(&CALL_POSSIBLY_UNBOUND_METHOD, context_expression_node) + { + builder.into_diagnostic(format_args!( + "Method `__new__` on type `{}` is possibly unbound.", + context_expression_type.display(context.db()), + )); + } + + if let Some(CallError(_kind, bindings)) = call_error { + bindings.report_diagnostics(context, context_expression_node); + } + } + DunderNewCallError::CallError(CallError(_kind, bindings)) => { + bindings.report_diagnostics(context, context_expression_node); + } + }; + + match self { + Self::Init(_, init_call_dunder_error) => { + report_init_error(init_call_dunder_error); + } + Self::New(_, new_call_error) => { + report_new_error(new_call_error); + } + Self::NewAndInit(_, new_call_error, init_call_dunder_error) => { + report_new_error(new_call_error); + report_init_error(init_call_dunder_error); + } + } + } +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub enum Truthiness { + /// For an object `x`, `bool(x)` will always return `True` + AlwaysTrue, + /// For an object `x`, `bool(x)` will always return `False` + AlwaysFalse, + /// For an object `x`, `bool(x)` could return either `True` or `False` + Ambiguous, +} + +impl Truthiness { + pub(crate) const fn is_ambiguous(self) -> bool { + matches!(self, Truthiness::Ambiguous) + } + + pub(crate) const fn is_always_false(self) -> bool { + matches!(self, Truthiness::AlwaysFalse) + } + + pub(crate) const fn is_always_true(self) -> bool { + matches!(self, Truthiness::AlwaysTrue) + } + + pub(crate) const fn negate(self) -> Self { + match self { + Self::AlwaysTrue => Self::AlwaysFalse, + Self::AlwaysFalse => Self::AlwaysTrue, + Self::Ambiguous => Self::Ambiguous, + } + } + + pub(crate) const fn negate_if(self, condition: bool) -> Self { + if condition { self.negate() } else { self } + } + + pub(crate) fn and(self, other: Self) -> Self { + match (self, other) { + (Truthiness::AlwaysTrue, Truthiness::AlwaysTrue) => Truthiness::AlwaysTrue, + (Truthiness::AlwaysFalse, _) | (_, Truthiness::AlwaysFalse) => Truthiness::AlwaysFalse, + _ => Truthiness::Ambiguous, + } + } + + fn into_type(self, db: &dyn Db) -> Type { + match self { + Self::AlwaysTrue => Type::BooleanLiteral(true), + Self::AlwaysFalse => Type::BooleanLiteral(false), + Self::Ambiguous => KnownClass::Bool.to_instance(db), + } + } +} + +impl From<bool> for Truthiness { + fn from(value: bool) -> Self { + if value { + Truthiness::AlwaysTrue + } else { + Truthiness::AlwaysFalse + } + } +} + +bitflags! { + #[derive(Copy, Clone, Debug, Eq, PartialEq, Default, Hash)] + pub struct FunctionDecorators: u8 { + /// `@classmethod` + const CLASSMETHOD = 1 << 0; + /// `@typing.no_type_check` + const NO_TYPE_CHECK = 1 << 1; + /// `@typing.overload` + const OVERLOAD = 1 << 2; + /// `@abc.abstractmethod` + const ABSTRACT_METHOD = 1 << 3; + /// `@typing.final` + const FINAL = 1 << 4; + /// `@typing.override` + const OVERRIDE = 1 << 6; + } +} + +/// A function signature, which optionally includes an implementation signature if the function is +/// overloaded. +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) struct FunctionSignature<'db> { + pub(crate) overloads: CallableSignature<'db>, + pub(crate) implementation: Option<Signature<'db>>, +} + +impl<'db> FunctionSignature<'db> { + /// Returns the "bottom" signature (subtype of all fully-static signatures.) + pub(crate) fn bottom(db: &'db dyn Db) -> Self { + FunctionSignature { + overloads: CallableSignature::single(Type::any(), Signature::bottom(db)), + implementation: None, + } + } +} + +/// An overloaded function. +/// +/// This is created by the [`to_overloaded`] method on [`FunctionType`]. +/// +/// [`to_overloaded`]: FunctionType::to_overloaded +#[derive(Debug, PartialEq, Eq, salsa::Update)] +struct OverloadedFunction<'db> { + /// The overloads of this function. + overloads: Vec<FunctionType<'db>>, + /// The implementation of this overloaded function, if any. + implementation: Option<FunctionType<'db>>, +} + +impl<'db> OverloadedFunction<'db> { + /// Returns an iterator over all overloads and the implementation, in that order. + fn all(&self) -> impl Iterator<Item = FunctionType<'db>> + '_ { + self.overloads.iter().copied().chain(self.implementation) + } +} + +/// # Ordering +/// Ordering is based on the function type's salsa-assigned id and not on its values. +/// The id may change between runs, or when the function type was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct FunctionType<'db> { + /// Name of the function at definition. + #[returns(ref)] + pub name: ast::name::Name, + + /// Is this a function that we special-case somehow? If so, which one? + known: Option<KnownFunction>, + + /// The scope that's created by the function, in which the function body is evaluated. + body_scope: ScopeId<'db>, + + /// A set of special decorators that were applied to this function + decorators: FunctionDecorators, + + /// The arguments to `dataclass_transformer`, if this function was annotated + /// with `@dataclass_transformer(...)`. + dataclass_transformer_params: Option<DataclassTransformerParams>, + + /// The inherited generic context, if this function is a class method being used to infer the + /// specialization of its generic class. If the method is itself generic, this is in addition + /// to its own generic context. + inherited_generic_context: Option<GenericContext<'db>>, + + /// Type mappings that should be applied to the function's parameter and return types. + type_mappings: Box<[TypeMapping<'db, 'db>]>, +} + +#[salsa::tracked] +impl<'db> FunctionType<'db> { + /// Returns the [`File`] in which this function is defined. + pub(crate) fn file(self, db: &'db dyn Db) -> File { + // NOTE: Do not use `self.definition(db).file(db)` here, as that could create a + // cross-module dependency on the full AST. + self.body_scope(db).file(db) + } + + pub(crate) fn has_known_decorator(self, db: &dyn Db, decorator: FunctionDecorators) -> bool { + self.decorators(db).contains(decorator) + } + + /// Convert the `FunctionType` into a [`Type::Callable`]. + pub(crate) fn into_callable_type(self, db: &'db dyn Db) -> Type<'db> { + Type::Callable(CallableType::from_overloads( + db, + self.signature(db).overloads.iter().cloned(), + )) + } + + /// Convert the `FunctionType` into a [`Type::BoundMethod`]. + pub(crate) fn into_bound_method_type( + self, + db: &'db dyn Db, + self_instance: Type<'db>, + ) -> Type<'db> { + Type::BoundMethod(BoundMethodType::new(db, self, self_instance)) + } + + /// Returns the AST node for this function. + pub(crate) fn node(self, db: &'db dyn Db, file: File) -> &'db ast::StmtFunctionDef { + debug_assert_eq!( + file, + self.file(db), + "FunctionType::node() must be called with the same file as the one where \ + the function is defined." + ); + + self.body_scope(db).node(db).expect_function() + } + + /// Returns the [`FileRange`] of the function's name. + pub fn focus_range(self, db: &dyn Db) -> FileRange { + FileRange::new( + self.file(db), + self.body_scope(db).node(db).expect_function().name.range, + ) + } + + pub fn full_range(self, db: &dyn Db) -> FileRange { + FileRange::new( + self.file(db), + self.body_scope(db).node(db).expect_function().range, + ) + } + + /// Returns the [`Definition`] of this function. + /// + /// ## Warning + /// + /// This uses the semantic index to find the definition of the function. This means that if the + /// calling query is not in the same file as this function is defined in, then this will create + /// a cross-module dependency directly on the full AST which will lead to cache + /// over-invalidation. + pub(crate) fn definition(self, db: &'db dyn Db) -> Definition<'db> { + let body_scope = self.body_scope(db); + let index = semantic_index(db, body_scope.file(db)); + index.expect_single_definition(body_scope.node(db).expect_function()) + } + + /// Typed externally-visible signature for this function. + /// + /// This is the signature as seen by external callers, possibly modified by decorators and/or + /// overloaded. + /// + /// ## Why is this a salsa query? + /// + /// This is a salsa query to short-circuit the invalidation + /// when the function's AST node changes. + /// + /// Were this not a salsa query, then the calling query + /// would depend on the function's AST and rerun for every change in that file. + #[salsa::tracked(returns(ref), cycle_fn=signature_cycle_recover, cycle_initial=signature_cycle_initial)] + pub(crate) fn signature(self, db: &'db dyn Db) -> FunctionSignature<'db> { + let inherited_generic_context = self.inherited_generic_context(db); + let type_mappings = self.type_mappings(db); + if let Some(overloaded) = self.to_overloaded(db) { + FunctionSignature { + overloads: CallableSignature::from_overloads( + Type::FunctionLiteral(self), + overloaded.overloads.iter().copied().map(|overload| { + type_mappings.iter().fold( + overload.internal_signature(db, inherited_generic_context), + |ty, mapping| ty.apply_type_mapping(db, mapping), + ) + }), + ), + implementation: overloaded.implementation.map(|implementation| { + type_mappings.iter().fold( + implementation.internal_signature(db, inherited_generic_context), + |ty, mapping| ty.apply_type_mapping(db, mapping), + ) + }), + } + } else { + FunctionSignature { + overloads: CallableSignature::single( + Type::FunctionLiteral(self), + type_mappings.iter().fold( + self.internal_signature(db, inherited_generic_context), + |ty, mapping| ty.apply_type_mapping(db, mapping), + ), + ), + implementation: None, + } + } + } + + /// Typed internally-visible signature for this function. + /// + /// This represents the annotations on the function itself, unmodified by decorators and + /// overloads. + /// + /// These are the parameter and return types that should be used for type checking the body of + /// the function. + /// + /// Don't call this when checking any other file; only when type-checking the function body + /// scope. + fn internal_signature( + self, + db: &'db dyn Db, + inherited_generic_context: Option<GenericContext<'db>>, + ) -> Signature<'db> { + let scope = self.body_scope(db); + let function_stmt_node = scope.node(db).expect_function(); + let definition = self.definition(db); + let generic_context = function_stmt_node.type_params.as_ref().map(|type_params| { + let index = semantic_index(db, scope.file(db)); + GenericContext::from_type_params(db, index, type_params) + }); + Signature::from_function( + db, + generic_context, + inherited_generic_context, + definition, + function_stmt_node, + ) + } + + pub(crate) fn is_known(self, db: &'db dyn Db, known_function: KnownFunction) -> bool { + self.known(db) == Some(known_function) + } + + fn with_dataclass_transformer_params( + self, + db: &'db dyn Db, + params: DataclassTransformerParams, + ) -> Self { + Self::new( + db, + self.name(db).clone(), + self.known(db), + self.body_scope(db), + self.decorators(db), + Some(params), + self.inherited_generic_context(db), + self.type_mappings(db), + ) + } + + fn with_inherited_generic_context( + self, + db: &'db dyn Db, + inherited_generic_context: GenericContext<'db>, + ) -> Self { + // A function cannot inherit more than one generic context from its containing class. + debug_assert!(self.inherited_generic_context(db).is_none()); + Self::new( + db, + self.name(db).clone(), + self.known(db), + self.body_scope(db), + self.decorators(db), + self.dataclass_transformer_params(db), + Some(inherited_generic_context), + self.type_mappings(db), + ) + } + + fn with_type_mapping<'a>(self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + let type_mappings: Box<[_]> = self + .type_mappings(db) + .iter() + .cloned() + .chain(std::iter::once(type_mapping.to_owned())) + .collect(); + Self::new( + db, + self.name(db).clone(), + self.known(db), + self.body_scope(db), + self.decorators(db), + self.dataclass_transformer_params(db), + self.inherited_generic_context(db), + type_mappings, + ) + } + + fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + let signatures = self.signature(db); + for signature in &signatures.overloads { + signature.find_legacy_typevars(db, typevars); + } + } + + /// Returns `self` as [`OverloadedFunction`] if it is overloaded, [`None`] otherwise. + /// + /// ## Note + /// + /// The way this method works only allows us to "see" the overloads that are defined before + /// this function definition. This is because the semantic model records a use for each + /// function on the name node which is used to get the previous function definition with the + /// same name. This means that [`OverloadedFunction`] would only include the functions that + /// comes before this function definition. Consider the following example: + /// + /// ```py + /// from typing import overload + /// + /// @overload + /// def foo() -> None: ... + /// @overload + /// def foo(x: int) -> int: ... + /// def foo(x: int | None) -> int | None: + /// return x + /// ``` + /// + /// Here, when the `to_overloaded` method is invoked on the + /// 1. first `foo` definition, it would only contain a single overload which is itself and no + /// implementation + /// 2. second `foo` definition, it would contain both overloads and still no implementation + /// 3. third `foo` definition, it would contain both overloads and the implementation which is + /// itself + #[salsa::tracked(returns(as_ref))] + fn to_overloaded(self, db: &'db dyn Db) -> Option<OverloadedFunction<'db>> { + let mut current = self; + let mut overloads = vec![]; + + loop { + // The semantic model records a use for each function on the name node. This is used + // here to get the previous function definition with the same name. + let scope = current.definition(db).scope(db); + let use_def = semantic_index(db, scope.file(db)).use_def_map(scope.file_scope_id(db)); + let use_id = current + .body_scope(db) + .node(db) + .expect_function() + .name + .scoped_use_id(db, scope); + + let Symbol::Type(Type::FunctionLiteral(previous), Boundness::Bound) = + symbol_from_bindings(db, use_def.bindings_at_use(use_id)) + else { + break; + }; + + if previous.has_known_decorator(db, FunctionDecorators::OVERLOAD) { + overloads.push(previous); + } else { + break; + } + + current = previous; + } + + // Overloads are inserted in reverse order, from bottom to top. + overloads.reverse(); + + let implementation = if self.has_known_decorator(db, FunctionDecorators::OVERLOAD) { + overloads.push(self); + None + } else { + Some(self) + }; + + if overloads.is_empty() { + None + } else { + Some(OverloadedFunction { + overloads, + implementation, + }) + } + } + + fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + // A function literal is the subtype of itself, and not of any other function literal. + // However, our representation of a function literal includes any specialization that + // should be applied to the signature. Different specializations of the same function + // literal are only subtypes of each other if they result in subtype signatures. + self.normalized(db) == other.normalized(db) + || (self.body_scope(db) == other.body_scope(db) + && self + .into_callable_type(db) + .is_subtype_of(db, other.into_callable_type(db))) + } + + fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + // A function literal is assignable to itself, and not to any other function literal. + // However, our representation of a function literal includes any specialization that + // should be applied to the signature. Different specializations of the same function + // literal are only assignable to each other if they result in assignable signatures. + self.body_scope(db) == other.body_scope(db) + && self + .into_callable_type(db) + .is_assignable_to(db, other.into_callable_type(db)) + } + + fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.normalized(db) == other.normalized(db) + || (self.body_scope(db) == other.body_scope(db) + && self + .into_callable_type(db) + .is_equivalent_to(db, other.into_callable_type(db))) + } + + fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.body_scope(db) == other.body_scope(db) + && self + .into_callable_type(db) + .is_gradual_equivalent_to(db, other.into_callable_type(db)) + } + + fn normalized(self, db: &'db dyn Db) -> Self { + let context = self + .inherited_generic_context(db) + .map(|ctx| ctx.normalized(db)); + + let mappings: Box<_> = self + .type_mappings(db) + .iter() + .map(|mapping| mapping.normalized(db)) + .collect(); + + Self::new( + db, + self.name(db), + self.known(db), + self.body_scope(db), + self.decorators(db), + self.dataclass_transformer_params(db), + context, + mappings, + ) + } + + /// Returns a tuple of two spans. The first is + /// the span for the identifier of the function + /// definition for `self`. The second is + /// the span for the parameter in the function + /// definition for `self`. + /// + /// If there are no meaningful spans, then this + /// returns `None`. For example, when this type + /// isn't callable. + /// + /// When `parameter_index` is `None`, then the + /// second span returned covers the entire parameter + /// list. + /// + /// # Performance + /// + /// Note that this may introduce cross-module + /// dependencies. This can have an impact on + /// the effectiveness of incremental caching + /// and should therefore be used judiciously. + /// + /// An example of a good use case is to improve + /// a diagnostic. + fn parameter_span( + self, + db: &'db dyn Db, + parameter_index: Option<usize>, + ) -> Option<(Span, Span)> { + let function_scope = self.body_scope(db); + let span = Span::from(function_scope.file(db)); + let node = function_scope.node(db); + let func_def = node.as_function()?; + let range = parameter_index + .and_then(|parameter_index| { + func_def + .parameters + .iter() + .nth(parameter_index) + .map(|param| param.range()) + }) + .unwrap_or(func_def.parameters.range); + let name_span = span.clone().with_range(func_def.name.range); + let parameter_span = span.with_range(range); + Some((name_span, parameter_span)) + } + + /// Returns a collection of useful spans for a + /// function signature. These are useful for + /// creating annotations on diagnostics. + /// + /// # Performance + /// + /// Note that this may introduce cross-module + /// dependencies. This can have an impact on + /// the effectiveness of incremental caching + /// and should therefore be used judiciously. + /// + /// An example of a good use case is to improve + /// a diagnostic. + fn spans(self, db: &'db dyn Db) -> Option<FunctionSpans> { + let function_scope = self.body_scope(db); + let span = Span::from(function_scope.file(db)); + let node = function_scope.node(db); + let func_def = node.as_function()?; + let return_type_range = func_def.returns.as_ref().map(|returns| returns.range()); + let mut signature = func_def.name.range.cover(func_def.parameters.range); + if let Some(return_type_range) = return_type_range { + signature = signature.cover(return_type_range); + } + Some(FunctionSpans { + signature: span.clone().with_range(signature), + name: span.clone().with_range(func_def.name.range), + parameters: span.clone().with_range(func_def.parameters.range), + return_type: return_type_range.map(|range| span.clone().with_range(range)), + }) + } +} + +/// A collection of useful spans for annotating functions. +/// +/// This can be retrieved via `FunctionType::spans` or +/// `Type::function_spans`. +struct FunctionSpans { + /// The span of the entire function "signature." This includes + /// the name, parameter list and return type (if present). + signature: Span, + /// The span of the function name. i.e., `foo` in `def foo(): ...`. + name: Span, + /// The span of the parameter list, including the opening and + /// closing parentheses. + #[expect(dead_code)] + parameters: Span, + /// The span of the annotated return type, if present. + return_type: Option<Span>, +} + +fn signature_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &FunctionSignature<'db>, + _count: u32, + _function: FunctionType<'db>, +) -> salsa::CycleRecoveryAction<FunctionSignature<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn signature_cycle_initial<'db>( + db: &'db dyn Db, + _function: FunctionType<'db>, +) -> FunctionSignature<'db> { + FunctionSignature::bottom(db) +} + +/// Non-exhaustive enumeration of known functions (e.g. `builtins.reveal_type`, ...) that might +/// have special behavior. +#[derive( + Debug, Copy, Clone, PartialEq, Eq, Hash, strum_macros::EnumString, strum_macros::IntoStaticStr, +)] +#[strum(serialize_all = "snake_case")] +#[cfg_attr(test, derive(strum_macros::EnumIter))] +pub enum KnownFunction { + /// `builtins.isinstance` + #[strum(serialize = "isinstance")] + IsInstance, + /// `builtins.issubclass` + #[strum(serialize = "issubclass")] + IsSubclass, + /// `builtins.hasattr` + #[strum(serialize = "hasattr")] + HasAttr, + /// `builtins.reveal_type`, `typing.reveal_type` or `typing_extensions.reveal_type` + RevealType, + /// `builtins.len` + Len, + /// `builtins.repr` + Repr, + /// `typing(_extensions).final` + Final, + + /// [`typing(_extensions).no_type_check`](https://typing.python.org/en/latest/spec/directives.html#no-type-check) + NoTypeCheck, + + /// `typing(_extensions).assert_type` + AssertType, + /// `typing(_extensions).assert_never` + AssertNever, + /// `typing(_extensions).cast` + Cast, + /// `typing(_extensions).overload` + Overload, + /// `typing(_extensions).override` + Override, + /// `typing(_extensions).is_protocol` + IsProtocol, + /// `typing(_extensions).get_protocol_members` + GetProtocolMembers, + /// `typing(_extensions).runtime_checkable` + RuntimeCheckable, + /// `typing(_extensions).dataclass_transform` + DataclassTransform, + + /// `abc.abstractmethod` + #[strum(serialize = "abstractmethod")] + AbstractMethod, + + /// `dataclasses.dataclass` + Dataclass, + + /// `inspect.getattr_static` + GetattrStatic, + + /// `ty_extensions.static_assert` + StaticAssert, + /// `ty_extensions.is_equivalent_to` + IsEquivalentTo, + /// `ty_extensions.is_subtype_of` + IsSubtypeOf, + /// `ty_extensions.is_assignable_to` + IsAssignableTo, + /// `ty_extensions.is_disjoint_from` + IsDisjointFrom, + /// `ty_extensions.is_gradual_equivalent_to` + IsGradualEquivalentTo, + /// `ty_extensions.is_fully_static` + IsFullyStatic, + /// `ty_extensions.is_singleton` + IsSingleton, + /// `ty_extensions.is_single_valued` + IsSingleValued, + /// `ty_extensions.generic_context` + GenericContext, + /// `ty_extensions.dunder_all_names` + DunderAllNames, +} + +impl KnownFunction { + pub fn into_classinfo_constraint_function(self) -> Option<ClassInfoConstraintFunction> { + match self { + Self::IsInstance => Some(ClassInfoConstraintFunction::IsInstance), + Self::IsSubclass => Some(ClassInfoConstraintFunction::IsSubclass), + _ => None, + } + } + + fn try_from_definition_and_name<'db>( + db: &'db dyn Db, + definition: Definition<'db>, + name: &str, + ) -> Option<Self> { + let candidate = Self::from_str(name).ok()?; + candidate + .check_module(file_to_module(db, definition.file(db))?.known()?) + .then_some(candidate) + } + + /// Return `true` if `self` is defined in `module` at runtime. + const fn check_module(self, module: KnownModule) -> bool { + match self { + Self::IsInstance | Self::IsSubclass | Self::HasAttr | Self::Len | Self::Repr => { + module.is_builtins() + } + Self::AssertType + | Self::AssertNever + | Self::Cast + | Self::Overload + | Self::Override + | Self::RevealType + | Self::Final + | Self::IsProtocol + | Self::GetProtocolMembers + | Self::RuntimeCheckable + | Self::DataclassTransform + | Self::NoTypeCheck => { + matches!(module, KnownModule::Typing | KnownModule::TypingExtensions) + } + Self::AbstractMethod => { + matches!(module, KnownModule::Abc) + } + Self::Dataclass => { + matches!(module, KnownModule::Dataclasses) + } + Self::GetattrStatic => module.is_inspect(), + Self::IsAssignableTo + | Self::IsDisjointFrom + | Self::IsEquivalentTo + | Self::IsGradualEquivalentTo + | Self::IsFullyStatic + | Self::IsSingleValued + | Self::IsSingleton + | Self::IsSubtypeOf + | Self::GenericContext + | Self::DunderAllNames + | Self::StaticAssert => module.is_ty_extensions(), + } + } +} + +/// This type represents bound method objects that are created when a method is accessed +/// on an instance of a class. For example, the expression `Path("a.txt").touch` creates +/// a bound method object that represents the `Path.touch` method which is bound to the +/// instance `Path("a.txt")`. +/// +/// # Ordering +/// Ordering is based on the bounded method's salsa-assigned id and not on its values. +/// The id may change between runs, or when the bounded method was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct BoundMethodType<'db> { + /// The function that is being bound. Corresponds to the `__func__` attribute on a + /// bound method object + pub(crate) function: FunctionType<'db>, + /// The instance on which this method has been called. Corresponds to the `__self__` + /// attribute on a bound method object + self_instance: Type<'db>, +} + +impl<'db> BoundMethodType<'db> { + pub(crate) fn into_callable_type(self, db: &'db dyn Db) -> Type<'db> { + Type::Callable(CallableType::from_overloads( + db, + self.function(db) + .signature(db) + .overloads + .iter() + .map(signatures::Signature::bind_self), + )) + } + + fn normalized(self, db: &'db dyn Db) -> Self { + Self::new( + db, + self.function(db).normalized(db), + self.self_instance(db).normalized(db), + ) + } + + fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + // A bound method is a typically a subtype of itself. However, we must explicitly verify + // the subtyping of the underlying function signatures (since they might be specialized + // differently), and of the bound self parameter (taking care that parameters, including a + // bound self parameter, are contravariant.) + self.function(db).is_subtype_of(db, other.function(db)) + && other + .self_instance(db) + .is_subtype_of(db, self.self_instance(db)) + } + + fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + // A bound method is a typically assignable to itself. However, we must explicitly verify + // the assignability of the underlying function signatures (since they might be specialized + // differently), and of the bound self parameter (taking care that parameters, including a + // bound self parameter, are contravariant.) + self.function(db).is_assignable_to(db, other.function(db)) + && other + .self_instance(db) + .is_assignable_to(db, self.self_instance(db)) + } + + fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.function(db).is_equivalent_to(db, other.function(db)) + && other + .self_instance(db) + .is_equivalent_to(db, self.self_instance(db)) + } + + fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.function(db) + .is_gradual_equivalent_to(db, other.function(db)) + && other + .self_instance(db) + .is_gradual_equivalent_to(db, self.self_instance(db)) + } +} + +/// This type represents the set of all callable objects with a certain, possibly overloaded, +/// signature. +/// +/// It can be written in type expressions using `typing.Callable`. `lambda` expressions are +/// inferred directly as `CallableType`s; all function-literal types are subtypes of a +/// `CallableType`. +/// +/// # Ordering +/// Ordering is based on the callable type's salsa-assigned id and not on its values. +/// The id may change between runs, or when the callable type was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct CallableType<'db> { + #[returns(deref)] + signatures: Box<[Signature<'db>]>, +} + +impl<'db> CallableType<'db> { + /// Create a non-overloaded callable type with a single signature. + pub(crate) fn single(db: &'db dyn Db, signature: Signature<'db>) -> Self { + CallableType::new(db, vec![signature].into_boxed_slice()) + } + + /// Create an overloaded callable type with multiple signatures. + /// + /// # Panics + /// + /// Panics if `overloads` is empty. + pub(crate) fn from_overloads<I>(db: &'db dyn Db, overloads: I) -> Self + where + I: IntoIterator<Item = Signature<'db>>, + { + let overloads = overloads.into_iter().collect::<Vec<_>>().into_boxed_slice(); + assert!( + !overloads.is_empty(), + "CallableType must have at least one signature" + ); + CallableType::new(db, overloads) + } + + /// Create a callable type which accepts any parameters and returns an `Unknown` type. + pub(crate) fn unknown(db: &'db dyn Db) -> Self { + CallableType::single( + db, + Signature::new(Parameters::unknown(), Some(Type::unknown())), + ) + } + + /// Create a callable type which represents a fully-static "bottom" callable. + /// + /// Specifically, this represents a callable type with a single signature: + /// `(*args: object, **kwargs: object) -> Never`. + #[cfg(test)] + pub(crate) fn bottom(db: &'db dyn Db) -> Type<'db> { + Type::Callable(CallableType::single(db, Signature::bottom(db))) + } + + /// Return a "normalized" version of this `Callable` type. + /// + /// See [`Type::normalized`] for more details. + fn normalized(self, db: &'db dyn Db) -> Self { + CallableType::from_overloads( + db, + self.signatures(db) + .iter() + .map(|signature| signature.normalized(db)), + ) + } + + fn apply_type_mapping<'a>(self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + CallableType::from_overloads( + db, + self.signatures(db) + .iter() + .map(|signature| signature.apply_type_mapping(db, type_mapping)), + ) + } + + fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + for signature in self.signatures(db) { + signature.find_legacy_typevars(db, typevars); + } + } + + /// Check whether this callable type is fully static. + /// + /// See [`Type::is_fully_static`] for more details. + fn is_fully_static(self, db: &'db dyn Db) -> bool { + self.signatures(db) + .iter() + .all(|signature| signature.is_fully_static(db)) + } + + /// Check whether this callable type is a subtype of another callable type. + /// + /// See [`Type::is_subtype_of`] for more details. + fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + self.is_assignable_to_impl(db, other, &|self_signature, other_signature| { + self_signature.is_subtype_of(db, other_signature) + }) + } + + /// Check whether this callable type is assignable to another callable type. + /// + /// See [`Type::is_assignable_to`] for more details. + fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + self.is_assignable_to_impl(db, other, &|self_signature, other_signature| { + self_signature.is_assignable_to(db, other_signature) + }) + } + + /// Implementation for the various relation checks between two, possible overloaded, callable + /// types. + /// + /// The `check_signature` closure is used to check the relation between two [`Signature`]s. + fn is_assignable_to_impl<F>(self, db: &'db dyn Db, other: Self, check_signature: &F) -> bool + where + F: Fn(&Signature<'db>, &Signature<'db>) -> bool, + { + match (self.signatures(db), other.signatures(db)) { + ([self_signature], [other_signature]) => { + // Base case: both callable types contain a single signature. + check_signature(self_signature, other_signature) + } + + // `self` is possibly overloaded while `other` is definitely not overloaded. + (self_signatures, [other_signature]) => { + let other_callable = CallableType::single(db, other_signature.clone()); + self_signatures + .iter() + .map(|self_signature| CallableType::single(db, self_signature.clone())) + .any(|self_callable| { + self_callable.is_assignable_to_impl(db, other_callable, check_signature) + }) + } + + // `self` is definitely not overloaded while `other` is possibly overloaded. + ([self_signature], other_signatures) => { + let self_callable = CallableType::single(db, self_signature.clone()); + other_signatures + .iter() + .map(|other_signature| CallableType::single(db, other_signature.clone())) + .all(|other_callable| { + self_callable.is_assignable_to_impl(db, other_callable, check_signature) + }) + } + + // `self` is definitely overloaded while `other` is possibly overloaded. + (_, other_signatures) => other_signatures + .iter() + .map(|other_signature| CallableType::single(db, other_signature.clone())) + .all(|other_callable| { + self.is_assignable_to_impl(db, other_callable, check_signature) + }), + } + } + + /// Check whether this callable type is equivalent to another callable type. + /// + /// See [`Type::is_equivalent_to`] for more details. + fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + match (self.signatures(db), other.signatures(db)) { + ([self_signature], [other_signature]) => { + // Common case: both callable types contain a single signature, use the custom + // equivalence check instead of delegating it to the subtype check. + self_signature.is_equivalent_to(db, other_signature) + } + (self_signatures, other_signatures) => { + if !self_signatures + .iter() + .chain(other_signatures.iter()) + .all(|signature| signature.is_fully_static(db)) + { + return false; + } + if self == other { + return true; + } + self.is_subtype_of(db, other) && other.is_subtype_of(db, self) + } + } + } + + /// Check whether this callable type is gradual equivalent to another callable type. + /// + /// See [`Type::is_gradual_equivalent_to`] for more details. + fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + match (self.signatures(db), other.signatures(db)) { + ([self_signature], [other_signature]) => { + self_signature.is_gradual_equivalent_to(db, other_signature) + } + _ => { + // TODO: overloads + false + } + } + } + + /// See [`Type::replace_self_reference`]. + fn replace_self_reference(self, db: &'db dyn Db, class: ClassLiteral<'db>) -> Self { + CallableType::from_overloads( + db, + self.signatures(db) + .iter() + .cloned() + .map(|signature| signature.replace_self_reference(db, class)), + ) + } +} + +/// Represents a specific instance of `types.MethodWrapperType` +#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, salsa::Update)] +pub enum MethodWrapperKind<'db> { + /// Method wrapper for `some_function.__get__` + FunctionTypeDunderGet(FunctionType<'db>), + /// Method wrapper for `some_function.__call__` + FunctionTypeDunderCall(FunctionType<'db>), + /// Method wrapper for `some_property.__get__` + PropertyDunderGet(PropertyInstanceType<'db>), + /// Method wrapper for `some_property.__set__` + PropertyDunderSet(PropertyInstanceType<'db>), + /// Method wrapper for `str.startswith`. + /// We treat this method specially because we want to be able to infer precise Boolean + /// literal return types if the instance and the prefix are both string literals, and + /// this allows us to understand statically known branches for common tests such as + /// `if sys.platform.startswith("freebsd")`. + StrStartswith(StringLiteralType<'db>), +} + +impl<'db> MethodWrapperKind<'db> { + fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + match (self, other) { + ( + MethodWrapperKind::FunctionTypeDunderGet(self_function), + MethodWrapperKind::FunctionTypeDunderGet(other_function), + ) => self_function.is_subtype_of(db, other_function), + + ( + MethodWrapperKind::FunctionTypeDunderCall(self_function), + MethodWrapperKind::FunctionTypeDunderCall(other_function), + ) => self_function.is_subtype_of(db, other_function), + + (MethodWrapperKind::PropertyDunderGet(_), MethodWrapperKind::PropertyDunderGet(_)) + | (MethodWrapperKind::PropertyDunderSet(_), MethodWrapperKind::PropertyDunderSet(_)) + | (MethodWrapperKind::StrStartswith(_), MethodWrapperKind::StrStartswith(_)) => { + self == other + } + + ( + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + ) => false, + } + } + + fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + match (self, other) { + ( + MethodWrapperKind::FunctionTypeDunderGet(self_function), + MethodWrapperKind::FunctionTypeDunderGet(other_function), + ) => self_function.is_assignable_to(db, other_function), + + ( + MethodWrapperKind::FunctionTypeDunderCall(self_function), + MethodWrapperKind::FunctionTypeDunderCall(other_function), + ) => self_function.is_assignable_to(db, other_function), + + (MethodWrapperKind::PropertyDunderGet(_), MethodWrapperKind::PropertyDunderGet(_)) + | (MethodWrapperKind::PropertyDunderSet(_), MethodWrapperKind::PropertyDunderSet(_)) + | (MethodWrapperKind::StrStartswith(_), MethodWrapperKind::StrStartswith(_)) => { + self == other + } + + ( + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + ) => false, + } + } + + fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + match (self, other) { + ( + MethodWrapperKind::FunctionTypeDunderGet(self_function), + MethodWrapperKind::FunctionTypeDunderGet(other_function), + ) => self_function.is_equivalent_to(db, other_function), + + ( + MethodWrapperKind::FunctionTypeDunderCall(self_function), + MethodWrapperKind::FunctionTypeDunderCall(other_function), + ) => self_function.is_equivalent_to(db, other_function), + + (MethodWrapperKind::PropertyDunderGet(_), MethodWrapperKind::PropertyDunderGet(_)) + | (MethodWrapperKind::PropertyDunderSet(_), MethodWrapperKind::PropertyDunderSet(_)) + | (MethodWrapperKind::StrStartswith(_), MethodWrapperKind::StrStartswith(_)) => { + self == other + } + + ( + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + ) => false, + } + } + + fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + match (self, other) { + ( + MethodWrapperKind::FunctionTypeDunderGet(self_function), + MethodWrapperKind::FunctionTypeDunderGet(other_function), + ) => self_function.is_gradual_equivalent_to(db, other_function), + + ( + MethodWrapperKind::FunctionTypeDunderCall(self_function), + MethodWrapperKind::FunctionTypeDunderCall(other_function), + ) => self_function.is_gradual_equivalent_to(db, other_function), + + (MethodWrapperKind::PropertyDunderGet(_), MethodWrapperKind::PropertyDunderGet(_)) + | (MethodWrapperKind::PropertyDunderSet(_), MethodWrapperKind::PropertyDunderSet(_)) + | (MethodWrapperKind::StrStartswith(_), MethodWrapperKind::StrStartswith(_)) => { + self == other + } + + ( + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + MethodWrapperKind::FunctionTypeDunderGet(_) + | MethodWrapperKind::FunctionTypeDunderCall(_) + | MethodWrapperKind::PropertyDunderGet(_) + | MethodWrapperKind::PropertyDunderSet(_) + | MethodWrapperKind::StrStartswith(_), + ) => false, + } + } + + fn normalized(self, db: &'db dyn Db) -> Self { + match self { + MethodWrapperKind::FunctionTypeDunderGet(function) => { + MethodWrapperKind::FunctionTypeDunderGet(function.normalized(db)) + } + MethodWrapperKind::FunctionTypeDunderCall(function) => { + MethodWrapperKind::FunctionTypeDunderCall(function.normalized(db)) + } + MethodWrapperKind::PropertyDunderGet(property) => { + MethodWrapperKind::PropertyDunderGet(property.normalized(db)) + } + MethodWrapperKind::PropertyDunderSet(property) => { + MethodWrapperKind::PropertyDunderSet(property.normalized(db)) + } + MethodWrapperKind::StrStartswith(_) => self, + } + } +} + +/// Represents a specific instance of `types.WrapperDescriptorType` +#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, salsa::Update)] +pub enum WrapperDescriptorKind { + /// `FunctionType.__get__` + FunctionTypeDunderGet, + /// `property.__get__` + PropertyDunderGet, + /// `property.__set__` + PropertyDunderSet, +} + +/// # Ordering +/// Ordering is based on the module literal's salsa-assigned id and not on its values. +/// The id may change between runs, or when the module literal was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct ModuleLiteralType<'db> { + /// The file in which this module was imported. + /// + /// We need this in order to know which submodules should be attached to it as attributes + /// (because the submodules were also imported in this file). + pub importing_file: File, + + /// The imported module. + pub module: Module, +} + +impl<'db> ModuleLiteralType<'db> { + fn static_member(self, db: &'db dyn Db, name: &str) -> Symbol<'db> { + // `__dict__` is a very special member that is never overridden by module globals; + // we should always look it up directly as an attribute on `types.ModuleType`, + // never in the global scope of the module. + if name == "__dict__" { + return KnownClass::ModuleType + .to_instance(db) + .member(db, "__dict__") + .symbol; + } + + // If the file that originally imported the module has also imported a submodule + // named `name`, then the result is (usually) that submodule, even if the module + // also defines a (non-module) symbol with that name. + // + // Note that technically, either the submodule or the non-module symbol could take + // priority, depending on the ordering of when the submodule is loaded relative to + // the parent module's `__init__.py` file being evaluated. That said, we have + // chosen to always have the submodule take priority. (This matches pyright's + // current behavior, but is the opposite of mypy's current behavior.) + if let Some(submodule_name) = ModuleName::new(name) { + let importing_file = self.importing_file(db); + let imported_submodules = imported_modules(db, importing_file); + let mut full_submodule_name = self.module(db).name().clone(); + full_submodule_name.extend(&submodule_name); + if imported_submodules.contains(&full_submodule_name) { + if let Some(submodule) = resolve_module(db, &full_submodule_name) { + return Symbol::bound(Type::module_literal(db, importing_file, submodule)); + } + } + } + + self.module(db) + .file() + .map(|file| imported_symbol(db, file, name, None)) + .unwrap_or_default() + .symbol + } +} + +/// # Ordering +/// Ordering is based on the type alias's salsa-assigned id and not on its values. +/// The id may change between runs, or when the alias was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct PEP695TypeAliasType<'db> { + #[returns(ref)] + pub name: ast::name::Name, + + rhs_scope: ScopeId<'db>, +} + +#[salsa::tracked] +impl<'db> PEP695TypeAliasType<'db> { + pub(crate) fn definition(self, db: &'db dyn Db) -> Definition<'db> { + let scope = self.rhs_scope(db); + let type_alias_stmt_node = scope.node(db).expect_type_alias(); + + semantic_index(db, scope.file(db)).expect_single_definition(type_alias_stmt_node) + } + + #[salsa::tracked] + pub(crate) fn value_type(self, db: &'db dyn Db) -> Type<'db> { + let scope = self.rhs_scope(db); + let type_alias_stmt_node = scope.node(db).expect_type_alias(); + let definition = self.definition(db); + definition_expression_type(db, definition, &type_alias_stmt_node.value) + } + + fn normalized(self, _db: &'db dyn Db) -> Self { + self + } +} + +/// # Ordering +/// Ordering is based on the type alias's salsa-assigned id and not on its values. +/// The id may change between runs, or when the alias was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct BareTypeAliasType<'db> { + #[returns(ref)] + pub name: ast::name::Name, + pub definition: Option<Definition<'db>>, + pub value: Type<'db>, +} + +impl<'db> BareTypeAliasType<'db> { + fn normalized(self, db: &'db dyn Db) -> Self { + Self::new( + db, + self.name(db), + self.definition(db), + self.value(db).normalized(db), + ) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, salsa::Update)] +pub enum TypeAliasType<'db> { + PEP695(PEP695TypeAliasType<'db>), + Bare(BareTypeAliasType<'db>), +} + +impl<'db> TypeAliasType<'db> { + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + TypeAliasType::PEP695(type_alias) => TypeAliasType::PEP695(type_alias.normalized(db)), + TypeAliasType::Bare(type_alias) => TypeAliasType::Bare(type_alias.normalized(db)), + } + } + + pub(crate) fn name(self, db: &'db dyn Db) -> &'db str { + match self { + TypeAliasType::PEP695(type_alias) => type_alias.name(db), + TypeAliasType::Bare(type_alias) => type_alias.name(db), + } + } + + pub(crate) fn definition(self, db: &'db dyn Db) -> Option<Definition<'db>> { + match self { + TypeAliasType::PEP695(type_alias) => Some(type_alias.definition(db)), + TypeAliasType::Bare(type_alias) => type_alias.definition(db), + } + } + + pub(crate) fn value_type(self, db: &'db dyn Db) -> Type<'db> { + match self { + TypeAliasType::PEP695(type_alias) => type_alias.value_type(db), + TypeAliasType::Bare(type_alias) => type_alias.value(db), + } + } +} + +/// Either the explicit `metaclass=` keyword of the class, or the inferred metaclass of one of its base classes. +#[derive(Debug, Clone, PartialEq, Eq, salsa::Update)] +pub(super) struct MetaclassCandidate<'db> { + metaclass: ClassType<'db>, + explicit_metaclass_of: ClassLiteral<'db>, +} + +#[salsa::interned(debug)] +pub struct UnionType<'db> { + /// The union type includes values in any of these types. + #[returns(deref)] + pub elements: Box<[Type<'db>]>, +} + +impl<'db> UnionType<'db> { + /// Create a union from a list of elements + /// (which may be eagerly simplified into a different variant of [`Type`] altogether). + pub fn from_elements<I, T>(db: &'db dyn Db, elements: I) -> Type<'db> + where + I: IntoIterator<Item = T>, + T: Into<Type<'db>>, + { + elements + .into_iter() + .fold(UnionBuilder::new(db), |builder, element| { + builder.add(element.into()) + }) + .build() + } + + /// Apply a transformation function to all elements of the union, + /// and create a new union from the resulting set of types. + pub fn map( + &self, + db: &'db dyn Db, + transform_fn: impl FnMut(&Type<'db>) -> Type<'db>, + ) -> Type<'db> { + Self::from_elements(db, self.elements(db).iter().map(transform_fn)) + } + + pub(crate) fn filter( + self, + db: &'db dyn Db, + filter_fn: impl FnMut(&&Type<'db>) -> bool, + ) -> Type<'db> { + Self::from_elements(db, self.elements(db).iter().filter(filter_fn)) + } + + pub fn iter(&self, db: &'db dyn Db) -> Iter<Type<'db>> { + self.elements(db).iter() + } + + pub(crate) fn map_with_boundness( + self, + db: &'db dyn Db, + mut transform_fn: impl FnMut(&Type<'db>) -> Symbol<'db>, + ) -> Symbol<'db> { + let mut builder = UnionBuilder::new(db); + + let mut all_unbound = true; + let mut possibly_unbound = false; + for ty in self.elements(db) { + let ty_member = transform_fn(ty); + match ty_member { + Symbol::Unbound => { + possibly_unbound = true; + } + Symbol::Type(ty_member, member_boundness) => { + if member_boundness == Boundness::PossiblyUnbound { + possibly_unbound = true; + } + + all_unbound = false; + builder = builder.add(ty_member); + } + } + } + + if all_unbound { + Symbol::Unbound + } else { + Symbol::Type( + builder.build(), + if possibly_unbound { + Boundness::PossiblyUnbound + } else { + Boundness::Bound + }, + ) + } + } + + pub(crate) fn map_with_boundness_and_qualifiers( + self, + db: &'db dyn Db, + mut transform_fn: impl FnMut(&Type<'db>) -> SymbolAndQualifiers<'db>, + ) -> SymbolAndQualifiers<'db> { + let mut builder = UnionBuilder::new(db); + let mut qualifiers = TypeQualifiers::empty(); + + let mut all_unbound = true; + let mut possibly_unbound = false; + for ty in self.elements(db) { + let SymbolAndQualifiers { + symbol: ty_member, + qualifiers: new_qualifiers, + } = transform_fn(ty); + qualifiers |= new_qualifiers; + match ty_member { + Symbol::Unbound => { + possibly_unbound = true; + } + Symbol::Type(ty_member, member_boundness) => { + if member_boundness == Boundness::PossiblyUnbound { + possibly_unbound = true; + } + + all_unbound = false; + builder = builder.add(ty_member); + } + } + } + SymbolAndQualifiers { + symbol: if all_unbound { + Symbol::Unbound + } else { + Symbol::Type( + builder.build(), + if possibly_unbound { + Boundness::PossiblyUnbound + } else { + Boundness::Bound + }, + ) + }, + qualifiers, + } + } + + pub(crate) fn is_fully_static(self, db: &'db dyn Db) -> bool { + self.elements(db).iter().all(|ty| ty.is_fully_static(db)) + } + + /// Create a new union type with the elements normalized. + /// + /// See [`Type::normalized`] for more details. + #[must_use] + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + let mut new_elements: Vec<Type<'db>> = self + .elements(db) + .iter() + .map(|element| element.normalized(db)) + .collect(); + new_elements.sort_unstable_by(|l, r| union_or_intersection_elements_ordering(db, l, r)); + UnionType::new(db, new_elements.into_boxed_slice()) + } + + /// Return `true` if `self` represents the exact same set of possible runtime objects as `other` + pub(crate) fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + /// Inlined version of [`UnionType::is_fully_static`] to avoid having to lookup + /// `self.elements` multiple times in the Salsa db in this single method. + #[inline] + fn all_fully_static(db: &dyn Db, elements: &[Type]) -> bool { + elements.iter().all(|ty| ty.is_fully_static(db)) + } + + let self_elements = self.elements(db); + let other_elements = other.elements(db); + + if self_elements.len() != other_elements.len() { + return false; + } + + if !all_fully_static(db, self_elements) { + return false; + } + + if !all_fully_static(db, other_elements) { + return false; + } + + if self == other { + return true; + } + + let sorted_self = self.normalized(db); + + if sorted_self == other { + return true; + } + + sorted_self == other.normalized(db) + } + + /// Return `true` if `self` has exactly the same set of possible static materializations as `other` + /// (if `self` represents the same set of possible sets of possible runtime objects as `other`) + pub(crate) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + if self == other { + return true; + } + + // TODO: `T | Unknown` should be gradually equivalent to `T | Unknown | Any`, + // since they have exactly the same set of possible static materializations + // (they represent the same set of possible sets of possible runtime objects) + if self.elements(db).len() != other.elements(db).len() { + return false; + } + + let sorted_self = self.normalized(db); + + if sorted_self == other { + return true; + } + + let sorted_other = other.normalized(db); + + if sorted_self == sorted_other { + return true; + } + + sorted_self + .elements(db) + .iter() + .zip(sorted_other.elements(db)) + .all(|(self_ty, other_ty)| self_ty.is_gradual_equivalent_to(db, *other_ty)) + } +} + +#[salsa::interned(debug)] +pub struct IntersectionType<'db> { + /// The intersection type includes only values in all of these types. + #[returns(ref)] + positive: FxOrderSet<Type<'db>>, + + /// The intersection type does not include any value in any of these types. + /// + /// Negation types aren't expressible in annotations, and are most likely to arise from type + /// narrowing along with intersections (e.g. `if not isinstance(...)`), so we represent them + /// directly in intersections rather than as a separate type. + #[returns(ref)] + negative: FxOrderSet<Type<'db>>, +} + +impl<'db> IntersectionType<'db> { + /// Return a new `IntersectionType` instance with the positive and negative types sorted + /// according to a canonical ordering, and other normalizations applied to each element as applicable. + /// + /// See [`Type::normalized`] for more details. + #[must_use] + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + fn normalized_set<'db>( + db: &'db dyn Db, + elements: &FxOrderSet<Type<'db>>, + ) -> FxOrderSet<Type<'db>> { + let mut elements: FxOrderSet<Type<'db>> = + elements.iter().map(|ty| ty.normalized(db)).collect(); + + elements.sort_unstable_by(|l, r| union_or_intersection_elements_ordering(db, l, r)); + elements + } + + IntersectionType::new( + db, + normalized_set(db, self.positive(db)), + normalized_set(db, self.negative(db)), + ) + } + + pub(crate) fn is_fully_static(self, db: &'db dyn Db) -> bool { + self.positive(db).iter().all(|ty| ty.is_fully_static(db)) + && self.negative(db).iter().all(|ty| ty.is_fully_static(db)) + } + + /// Return `true` if `self` represents exactly the same set of possible runtime objects as `other` + pub(crate) fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + /// Inlined version of [`IntersectionType::is_fully_static`] to avoid having to lookup + /// `positive` and `negative` multiple times in the Salsa db in this single method. + #[inline] + fn all_fully_static(db: &dyn Db, elements: &FxOrderSet<Type>) -> bool { + elements.iter().all(|ty| ty.is_fully_static(db)) + } + + let self_positive = self.positive(db); + + if !all_fully_static(db, self_positive) { + return false; + } + + let other_positive = other.positive(db); + + if self_positive.len() != other_positive.len() { + return false; + } + + if !all_fully_static(db, other_positive) { + return false; + } + + let self_negative = self.negative(db); + + if !all_fully_static(db, self_negative) { + return false; + } + + let other_negative = other.negative(db); + + if self_negative.len() != other_negative.len() { + return false; + } + + if !all_fully_static(db, other_negative) { + return false; + } + + if self == other { + return true; + } + + let sorted_self = self.normalized(db); + + if sorted_self == other { + return true; + } + + sorted_self == other.normalized(db) + } + + /// Return `true` if `self` has exactly the same set of possible static materializations as `other` + /// (if `self` represents the same set of possible sets of possible runtime objects as `other`) + pub(crate) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + if self == other { + return true; + } + + if self.positive(db).len() != other.positive(db).len() + || self.negative(db).len() != other.negative(db).len() + { + return false; + } + + let sorted_self = self.normalized(db); + + if sorted_self == other { + return true; + } + + let sorted_other = other.normalized(db); + + if sorted_self == sorted_other { + return true; + } + + sorted_self + .positive(db) + .iter() + .zip(sorted_other.positive(db)) + .all(|(self_ty, other_ty)| self_ty.is_gradual_equivalent_to(db, *other_ty)) + && sorted_self + .negative(db) + .iter() + .zip(sorted_other.negative(db)) + .all(|(self_ty, other_ty)| self_ty.is_gradual_equivalent_to(db, *other_ty)) + } + + pub(crate) fn map_with_boundness( + self, + db: &'db dyn Db, + mut transform_fn: impl FnMut(&Type<'db>) -> Symbol<'db>, + ) -> Symbol<'db> { + if !self.negative(db).is_empty() { + return Symbol::todo("map_with_boundness: intersections with negative contributions"); + } + + let mut builder = IntersectionBuilder::new(db); + + let mut all_unbound = true; + let mut any_definitely_bound = false; + for ty in self.positive(db) { + let ty_member = transform_fn(ty); + match ty_member { + Symbol::Unbound => {} + Symbol::Type(ty_member, member_boundness) => { + all_unbound = false; + if member_boundness == Boundness::Bound { + any_definitely_bound = true; + } + + builder = builder.add_positive(ty_member); + } + } + } + + if all_unbound { + Symbol::Unbound + } else { + Symbol::Type( + builder.build(), + if any_definitely_bound { + Boundness::Bound + } else { + Boundness::PossiblyUnbound + }, + ) + } + } + + pub(crate) fn map_with_boundness_and_qualifiers( + self, + db: &'db dyn Db, + mut transform_fn: impl FnMut(&Type<'db>) -> SymbolAndQualifiers<'db>, + ) -> SymbolAndQualifiers<'db> { + if !self.negative(db).is_empty() { + return Symbol::todo("map_with_boundness: intersections with negative contributions") + .into(); + } + + let mut builder = IntersectionBuilder::new(db); + let mut qualifiers = TypeQualifiers::empty(); + + let mut any_unbound = false; + let mut any_possibly_unbound = false; + for ty in self.positive(db) { + let SymbolAndQualifiers { + symbol: member, + qualifiers: new_qualifiers, + } = transform_fn(ty); + qualifiers |= new_qualifiers; + match member { + Symbol::Unbound => { + any_unbound = true; + } + Symbol::Type(ty_member, member_boundness) => { + if member_boundness == Boundness::PossiblyUnbound { + any_possibly_unbound = true; + } + + builder = builder.add_positive(ty_member); + } + } + } + + SymbolAndQualifiers { + symbol: if any_unbound { + Symbol::Unbound + } else { + Symbol::Type( + builder.build(), + if any_possibly_unbound { + Boundness::PossiblyUnbound + } else { + Boundness::Bound + }, + ) + }, + qualifiers, + } + } + + pub fn iter_positive(&self, db: &'db dyn Db) -> impl Iterator<Item = Type<'db>> { + self.positive(db).iter().copied() + } + + pub fn has_one_element(&self, db: &'db dyn Db) -> bool { + (self.positive(db).len() + self.negative(db).len()) == 1 + } +} + +/// # Ordering +/// Ordering is based on the string literal's salsa-assigned id and not on its value. +/// The id may change between runs, or when the string literal was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct StringLiteralType<'db> { + #[returns(deref)] + value: Box<str>, +} + +impl<'db> StringLiteralType<'db> { + /// The length of the string, as would be returned by Python's `len()`. + pub(crate) fn python_len(self, db: &'db dyn Db) -> usize { + self.value(db).chars().count() + } + + /// Return an iterator over each character in the string literal. + /// as would be returned by Python's `iter()`. + pub(crate) fn iter_each_char(self, db: &'db dyn Db) -> impl Iterator<Item = Self> { + self.value(db) + .chars() + .map(|c| StringLiteralType::new(db, c.to_string().as_str())) + } +} + +/// # Ordering +/// Ordering is based on the byte literal's salsa-assigned id and not on its value. +/// The id may change between runs, or when the byte literal was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct BytesLiteralType<'db> { + #[returns(deref)] + value: Box<[u8]>, +} + +impl<'db> BytesLiteralType<'db> { + pub(crate) fn python_len(self, db: &'db dyn Db) -> usize { + self.value(db).len() + } +} + +/// # Ordering +/// Ordering is based on the tuple's salsa-assigned id and not on its elements. +/// The id may change between runs, or when the tuple was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct TupleType<'db> { + #[returns(deref)] + elements: Box<[Type<'db>]>, +} + +impl<'db> TupleType<'db> { + fn homogeneous_supertype(self, db: &'db dyn Db) -> Type<'db> { + KnownClass::Tuple + .to_specialized_instance(db, [UnionType::from_elements(db, self.elements(db))]) + } + + pub(crate) fn empty(db: &'db dyn Db) -> Type<'db> { + Type::Tuple(TupleType::new(db, Box::<[Type<'db>]>::from([]))) + } + + pub(crate) fn from_elements<T: Into<Type<'db>>>( + db: &'db dyn Db, + types: impl IntoIterator<Item = T>, + ) -> Type<'db> { + let mut elements = vec![]; + + for ty in types { + let ty = ty.into(); + if ty.is_never() { + return Type::Never; + } + elements.push(ty); + } + + Type::Tuple(Self::new(db, elements.into_boxed_slice())) + } + + /// Return a normalized version of `self`. + /// + /// See [`Type::normalized`] for more details. + #[must_use] + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + let elements: Box<[Type<'db>]> = self + .elements(db) + .iter() + .map(|ty| ty.normalized(db)) + .collect(); + TupleType::new(db, elements) + } + + pub(crate) fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + let self_elements = self.elements(db); + let other_elements = other.elements(db); + self_elements.len() == other_elements.len() + && self_elements + .iter() + .zip(other_elements) + .all(|(self_ty, other_ty)| self_ty.is_equivalent_to(db, *other_ty)) + } + + pub(crate) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + let self_elements = self.elements(db); + let other_elements = other.elements(db); + self_elements.len() == other_elements.len() + && self_elements + .iter() + .zip(other_elements) + .all(|(self_ty, other_ty)| self_ty.is_gradual_equivalent_to(db, *other_ty)) + } + + pub fn get(&self, db: &'db dyn Db, index: usize) -> Option<Type<'db>> { + self.elements(db).get(index).copied() + } + + pub fn len(&self, db: &'db dyn Db) -> usize { + self.elements(db).len() + } + + pub fn iter(&self, db: &'db dyn Db) -> impl Iterator<Item = Type<'db>> + 'db + '_ { + self.elements(db).iter().copied() + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) enum BoundSuperError<'db> { + InvalidPivotClassType { + pivot_class: Type<'db>, + }, + FailingConditionCheck { + pivot_class: Type<'db>, + owner: Type<'db>, + }, + UnavailableImplicitArguments, +} + +impl BoundSuperError<'_> { + pub(super) fn report_diagnostic(&self, context: &InferContext, node: AnyNodeRef) { + match self { + BoundSuperError::InvalidPivotClassType { pivot_class } => { + if let Some(builder) = context.report_lint(&INVALID_SUPER_ARGUMENT, node) { + builder.into_diagnostic(format_args!( + "`{pivot_class}` is not a valid class", + pivot_class = pivot_class.display(context.db()), + )); + } + } + BoundSuperError::FailingConditionCheck { pivot_class, owner } => { + if let Some(builder) = context.report_lint(&INVALID_SUPER_ARGUMENT, node) { + builder.into_diagnostic(format_args!( + "`{owner}` is not an instance or subclass of \ + `{pivot_class}` in `super({pivot_class}, {owner})` call", + pivot_class = pivot_class.display(context.db()), + owner = owner.display(context.db()), + )); + } + } + BoundSuperError::UnavailableImplicitArguments => { + if let Some(builder) = + context.report_lint(&UNAVAILABLE_IMPLICIT_SUPER_ARGUMENTS, node) + { + builder.into_diagnostic(format_args!( + "Cannot determine implicit arguments for 'super()' in this context", + )); + } + } + } + } +} + +#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] +pub enum SuperOwnerKind<'db> { + Dynamic(DynamicType), + Class(ClassType<'db>), + Instance(NominalInstanceType<'db>), +} + +impl<'db> SuperOwnerKind<'db> { + fn normalized(self, db: &'db dyn Db) -> Self { + match self { + SuperOwnerKind::Dynamic(dynamic) => SuperOwnerKind::Dynamic(dynamic.normalized()), + SuperOwnerKind::Class(class) => SuperOwnerKind::Class(class.normalized(db)), + SuperOwnerKind::Instance(instance) => SuperOwnerKind::Instance(instance.normalized(db)), + } + } + + fn iter_mro(self, db: &'db dyn Db) -> impl Iterator<Item = ClassBase<'db>> { + match self { + SuperOwnerKind::Dynamic(dynamic) => { + Either::Left(ClassBase::Dynamic(dynamic).mro(db, None)) + } + SuperOwnerKind::Class(class) => Either::Right(class.iter_mro(db)), + SuperOwnerKind::Instance(instance) => Either::Right(instance.class.iter_mro(db)), + } + } + + fn into_type(self) -> Type<'db> { + match self { + SuperOwnerKind::Dynamic(dynamic) => Type::Dynamic(dynamic), + SuperOwnerKind::Class(class) => class.into(), + SuperOwnerKind::Instance(instance) => instance.into(), + } + } + + fn into_class(self) -> Option<ClassType<'db>> { + match self { + SuperOwnerKind::Dynamic(_) => None, + SuperOwnerKind::Class(class) => Some(class), + SuperOwnerKind::Instance(instance) => Some(instance.class), + } + } + + fn try_from_type(db: &'db dyn Db, ty: Type<'db>) -> Option<Self> { + match ty { + Type::Dynamic(dynamic) => Some(SuperOwnerKind::Dynamic(dynamic)), + Type::ClassLiteral(class_literal) => Some(SuperOwnerKind::Class( + class_literal.apply_optional_specialization(db, None), + )), + Type::NominalInstance(instance) => Some(SuperOwnerKind::Instance(instance)), + Type::BooleanLiteral(_) => { + SuperOwnerKind::try_from_type(db, KnownClass::Bool.to_instance(db)) + } + Type::IntLiteral(_) => { + SuperOwnerKind::try_from_type(db, KnownClass::Int.to_instance(db)) + } + Type::StringLiteral(_) => { + SuperOwnerKind::try_from_type(db, KnownClass::Str.to_instance(db)) + } + Type::LiteralString => { + SuperOwnerKind::try_from_type(db, KnownClass::Str.to_instance(db)) + } + Type::BytesLiteral(_) => { + SuperOwnerKind::try_from_type(db, KnownClass::Bytes.to_instance(db)) + } + Type::KnownInstance(known_instance) => { + SuperOwnerKind::try_from_type(db, known_instance.instance_fallback(db)) + } + _ => None, + } + } +} + +impl<'db> From<SuperOwnerKind<'db>> for Type<'db> { + fn from(owner: SuperOwnerKind<'db>) -> Self { + match owner { + SuperOwnerKind::Dynamic(dynamic) => Type::Dynamic(dynamic), + SuperOwnerKind::Class(class) => class.into(), + SuperOwnerKind::Instance(instance) => instance.into(), + } + } +} + +/// Represent a bound super object like `super(PivotClass, owner)` +#[salsa::interned(debug)] +pub struct BoundSuperType<'db> { + pub pivot_class: ClassBase<'db>, + #[return_ref] + pub owner: SuperOwnerKind<'db>, +} + +impl<'db> BoundSuperType<'db> { + /// Attempts to build a `Type::BoundSuper` based on the given `pivot_class` and `owner`. + /// + /// This mimics the behavior of Python's built-in `super(pivot, owner)` at runtime. + /// - `super(pivot, owner_class)` is valid only if `issubclass(owner_class, pivot)` + /// - `super(pivot, owner_instance)` is valid only if `isinstance(owner_instance, pivot)` + /// + /// However, the checking is skipped when any of the arguments is a dynamic type. + fn build( + db: &'db dyn Db, + pivot_class_type: Type<'db>, + owner_type: Type<'db>, + ) -> Result<Type<'db>, BoundSuperError<'db>> { + if let Type::Union(union) = owner_type { + return Ok(UnionType::from_elements( + db, + union + .elements(db) + .iter() + .map(|ty| BoundSuperType::build(db, pivot_class_type, *ty)) + .collect::<Result<Vec<_>, _>>()?, + )); + } + + let pivot_class = ClassBase::try_from_type(db, pivot_class_type).ok_or({ + BoundSuperError::InvalidPivotClassType { + pivot_class: pivot_class_type, + } + })?; + + let owner = SuperOwnerKind::try_from_type(db, owner_type) + .and_then(|owner| { + let Some(pivot_class) = pivot_class.into_class() else { + return Some(owner); + }; + let Some(owner_class) = owner.into_class() else { + return Some(owner); + }; + if owner_class.is_subclass_of(db, pivot_class) { + Some(owner) + } else { + None + } + }) + .ok_or(BoundSuperError::FailingConditionCheck { + pivot_class: pivot_class_type, + owner: owner_type, + })?; + + Ok(Type::BoundSuper(BoundSuperType::new( + db, + pivot_class, + owner, + ))) + } + + /// Skips elements in the MRO up to and including the pivot class. + /// + /// If the pivot class is a dynamic type, its MRO can't be determined, + /// so we fall back to using the MRO of `DynamicType::Unknown`. + fn skip_until_after_pivot( + self, + db: &'db dyn Db, + mro_iter: impl Iterator<Item = ClassBase<'db>>, + ) -> impl Iterator<Item = ClassBase<'db>> { + let Some(pivot_class) = self.pivot_class(db).into_class() else { + return Either::Left(ClassBase::Dynamic(DynamicType::Unknown).mro(db, None)); + }; + + let mut pivot_found = false; + + Either::Right(mro_iter.skip_while(move |superclass| { + if pivot_found { + false + } else if Some(pivot_class) == superclass.into_class() { + pivot_found = true; + true + } else { + true + } + })) + } + + /// Tries to call `__get__` on the attribute. + /// The arguments passed to `__get__` depend on whether the owner is an instance or a class. + /// See the `CPython` implementation for reference: + /// <https://github.com/python/cpython/blob/3b3720f1a26ab34377542b48eb6a6565f78ff892/Objects/typeobject.c#L11690-L11693> + fn try_call_dunder_get_on_attribute( + self, + db: &'db dyn Db, + attribute: SymbolAndQualifiers<'db>, + ) -> Option<SymbolAndQualifiers<'db>> { + let owner = self.owner(db); + + match owner { + // If the owner is a dynamic type, we can't tell whether it's a class or an instance. + // Also, invoking a descriptor on a dynamic attribute is meaningless, so we don't handle this. + SuperOwnerKind::Dynamic(_) => None, + SuperOwnerKind::Class(_) => Some( + Type::try_call_dunder_get_on_attribute( + db, + attribute, + Type::none(db), + owner.into_type(), + ) + .0, + ), + SuperOwnerKind::Instance(_) => Some( + Type::try_call_dunder_get_on_attribute( + db, + attribute, + owner.into_type(), + owner.into_type().to_meta_type(db), + ) + .0, + ), + } + } + + /// Similar to `Type::find_name_in_mro_with_policy`, but performs lookup starting *after* the + /// pivot class in the MRO, based on the `owner` type instead of the `super` type. + fn find_name_in_mro_after_pivot( + self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + let owner = self.owner(db); + let class = match owner { + SuperOwnerKind::Dynamic(_) => { + return owner + .into_type() + .find_name_in_mro_with_policy(db, name, policy) + .expect("Calling `find_name_in_mro` on dynamic type should return `Some`"); + } + SuperOwnerKind::Class(class) => class, + SuperOwnerKind::Instance(instance) => instance.class, + }; + + let (class_literal, _) = class.class_literal(db); + // TODO properly support super() with generic types + // * requires a fix for https://github.com/astral-sh/ruff/issues/17432 + // * also requires understanding how we should handle cases like this: + // ```python + // b_int: B[int] + // b_unknown: B + // + // super(B, b_int) + // super(B[int], b_unknown) + // ``` + match class_literal.generic_context(db) { + Some(_) => Symbol::bound(todo_type!("super in generic class")).into(), + None => class_literal.class_member_from_mro( + db, + name, + policy, + self.skip_until_after_pivot(db, owner.iter_mro(db)), + ), + } + } + + fn normalized(self, db: &'db dyn Db) -> Self { + Self::new( + db, + self.pivot_class(db).normalized(db), + self.owner(db).normalized(db), + ) + } +} + +// Make sure that the `Type` enum does not grow unexpectedly. +#[cfg(not(debug_assertions))] +#[cfg(target_pointer_width = "64")] +static_assertions::assert_eq_size!(Type, [u8; 16]); + +#[cfg(test)] +pub(crate) mod tests { + use super::*; + use crate::db::tests::{TestDbBuilder, setup_db}; + use crate::symbol::{ + global_symbol, known_module_symbol, typing_extensions_symbol, typing_symbol, + }; + use ruff_db::files::system_path_to_file; + use ruff_db::parsed::parsed_module; + use ruff_db::system::DbWithWritableSystem as _; + use ruff_db::testing::assert_function_query_was_not_run; + use ruff_python_ast::PythonVersion; + use strum::IntoEnumIterator; + use test_case::test_case; + + /// Explicitly test for Python version <3.13 and >=3.13, to ensure that + /// the fallback to `typing_extensions` is working correctly. + /// See [`KnownClass::canonical_module`] for more information. + #[test_case(PythonVersion::PY312)] + #[test_case(PythonVersion::PY313)] + fn no_default_type_is_singleton(python_version: PythonVersion) { + let db = TestDbBuilder::new() + .with_python_version(python_version) + .build() + .unwrap(); + + let no_default = KnownClass::NoDefaultType.to_instance(&db); + + assert!(no_default.is_singleton(&db)); + } + + #[test] + fn typing_vs_typeshed_no_default() { + let db = TestDbBuilder::new() + .with_python_version(PythonVersion::PY313) + .build() + .unwrap(); + + let typing_no_default = typing_symbol(&db, "NoDefault").symbol.expect_type(); + let typing_extensions_no_default = typing_extensions_symbol(&db, "NoDefault") + .symbol + .expect_type(); + + assert_eq!(typing_no_default.display(&db).to_string(), "NoDefault"); + assert_eq!( + typing_extensions_no_default.display(&db).to_string(), + "NoDefault" + ); + } + + /// Inferring the result of a call-expression shouldn't need to re-run after + /// a trivial change to the function's file (e.g. by adding a docstring to the function). + #[test] + fn call_type_doesnt_rerun_when_only_callee_changed() -> anyhow::Result<()> { + let mut db = setup_db(); + + db.write_dedented( + "src/foo.py", + r#" + def foo() -> int: + return 5 + "#, + )?; + db.write_dedented( + "src/bar.py", + r#" + from foo import foo + + a = foo() + "#, + )?; + + let bar = system_path_to_file(&db, "src/bar.py")?; + let a = global_symbol(&db, bar, "a").symbol; + + assert_eq!( + a.expect_type(), + UnionType::from_elements(&db, [Type::unknown(), KnownClass::Int.to_instance(&db)]) + ); + + // Add a docstring to foo to trigger a re-run. + // The bar-call site of foo should not be re-run because of that + db.write_dedented( + "src/foo.py", + r#" + def foo() -> int: + "Computes a value" + return 5 + "#, + )?; + db.clear_salsa_events(); + + let a = global_symbol(&db, bar, "a").symbol; + + assert_eq!( + a.expect_type(), + UnionType::from_elements(&db, [Type::unknown(), KnownClass::Int.to_instance(&db)]) + ); + let events = db.take_salsa_events(); + + let call = &*parsed_module(&db, bar).syntax().body[1] + .as_assign_stmt() + .unwrap() + .value; + let foo_call = semantic_index(&db, bar).expression(call); + + assert_function_query_was_not_run(&db, infer_expression_types, foo_call, &events); + + Ok(()) + } + + /// All other tests also make sure that `Type::Todo` works as expected. This particular + /// test makes sure that we handle `Todo` types correctly, even if they originate from + /// different sources. + #[test] + fn todo_types() { + let db = setup_db(); + + let todo1 = todo_type!("1"); + let todo2 = todo_type!("2"); + + let int = KnownClass::Int.to_instance(&db); + + assert!(int.is_assignable_to(&db, todo1)); + + assert!(todo1.is_assignable_to(&db, int)); + + // We lose information when combining several `Todo` types. This is an + // acknowledged limitation of the current implementation. We can not + // easily store the meta information of several `Todo`s in a single + // variant, as `TodoType` needs to implement `Copy`, meaning it can't + // contain `Vec`/`Box`/etc., and can't be boxed itself. + // + // Lifting this restriction would require us to intern `TodoType` in + // salsa, but that would mean we would have to pass in `db` everywhere. + + // A union of several `Todo` types collapses to a single `Todo` type: + assert!(UnionType::from_elements(&db, vec![todo1, todo2]).is_todo()); + + // And similar for intersection types: + assert!( + IntersectionBuilder::new(&db) + .add_positive(todo1) + .add_positive(todo2) + .build() + .is_todo() + ); + assert!( + IntersectionBuilder::new(&db) + .add_positive(todo1) + .add_negative(todo2) + .build() + .is_todo() + ); + } + + #[test] + fn known_function_roundtrip_from_str() { + let db = setup_db(); + + for function in KnownFunction::iter() { + let function_name: &'static str = function.into(); + + let module = match function { + KnownFunction::Len + | KnownFunction::Repr + | KnownFunction::IsInstance + | KnownFunction::HasAttr + | KnownFunction::IsSubclass => KnownModule::Builtins, + + KnownFunction::AbstractMethod => KnownModule::Abc, + + KnownFunction::Dataclass => KnownModule::Dataclasses, + + KnownFunction::GetattrStatic => KnownModule::Inspect, + + KnownFunction::Cast + | KnownFunction::Final + | KnownFunction::Overload + | KnownFunction::Override + | KnownFunction::RevealType + | KnownFunction::AssertType + | KnownFunction::AssertNever + | KnownFunction::IsProtocol + | KnownFunction::GetProtocolMembers + | KnownFunction::RuntimeCheckable + | KnownFunction::DataclassTransform + | KnownFunction::NoTypeCheck => KnownModule::TypingExtensions, + + KnownFunction::IsSingleton + | KnownFunction::IsSubtypeOf + | KnownFunction::GenericContext + | KnownFunction::DunderAllNames + | KnownFunction::StaticAssert + | KnownFunction::IsFullyStatic + | KnownFunction::IsDisjointFrom + | KnownFunction::IsSingleValued + | KnownFunction::IsAssignableTo + | KnownFunction::IsEquivalentTo + | KnownFunction::IsGradualEquivalentTo => KnownModule::TyExtensions, + }; + + let function_definition = known_module_symbol(&db, module, function_name) + .symbol + .expect_type() + .expect_function_literal() + .definition(&db); + + assert_eq!( + KnownFunction::try_from_definition_and_name( + &db, + function_definition, + function_name + ), + Some(function), + "The strum `EnumString` implementation appears to be incorrect for `{function_name}`" + ); + } + } +} diff --git a/crates/ty_python_semantic/src/types/builder.rs b/crates/ty_python_semantic/src/types/builder.rs new file mode 100644 index 0000000000000..5b55088a8b336 --- /dev/null +++ b/crates/ty_python_semantic/src/types/builder.rs @@ -0,0 +1,1006 @@ +//! Smart builders for union and intersection types. +//! +//! Invariants we maintain here: +//! * No single-element union types (should just be the contained type instead.) +//! * No single-positive-element intersection types. Single-negative-element are OK, we don't +//! have a standalone negation type so there's no other representation for this. +//! * The same type should never appear more than once in a union or intersection. (This should +//! be expanded to cover subtyping -- see below -- but for now we only implement it for type +//! identity.) +//! * Disjunctive normal form (DNF): the tree of unions and intersections can never be deeper +//! than a union-of-intersections. Unions cannot contain other unions (the inner union just +//! flattens into the outer one), intersections cannot contain other intersections (also +//! flattens), and intersections cannot contain unions (the intersection distributes over the +//! union, inverting it into a union-of-intersections). +//! * No type in a union can be a subtype of any other type in the union (just eliminate the +//! subtype from the union). +//! * No type in an intersection can be a supertype of any other type in the intersection (just +//! eliminate the supertype from the intersection). +//! * An intersection containing two non-overlapping types simplifies to [`Type::Never`]. +//! +//! The implication of these invariants is that a [`UnionBuilder`] does not necessarily build a +//! [`Type::Union`]. For example, if only one type is added to the [`UnionBuilder`], `build()` will +//! just return that type directly. The same is true for [`IntersectionBuilder`]; for example, if a +//! union type is added to the intersection, it will distribute and [`IntersectionBuilder::build`] +//! may end up returning a [`Type::Union`] of intersections. +//! +//! ## Performance +//! +//! In practice, there are two kinds of unions found in the wild: relatively-small unions made up +//! of normal user types (classes, etc), and large unions made up of literals, which can occur via +//! large enums (not yet implemented) or from string/integer/bytes literals, which can grow due to +//! literal arithmetic or operations on literal strings/bytes. For normal unions, it's most +//! efficient to just store the member types in a vector, and do O(n^2) `is_subtype_of` checks to +//! maintain the union in simplified form. But literal unions can grow to a size where this becomes +//! a performance problem. For this reason, we group literal types in `UnionBuilder`. Since every +//! different string literal type shares exactly the same possible super-types, and none of them +//! are subtypes of each other (unless exactly the same literal type), we can avoid many +//! unnecessary `is_subtype_of` checks. + +use crate::types::{ + BytesLiteralType, IntersectionType, KnownClass, StringLiteralType, Type, + TypeVarBoundOrConstraints, UnionType, +}; +use crate::{Db, FxOrderSet}; +use smallvec::SmallVec; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum LiteralKind { + Int, + String, + Bytes, +} + +impl<'db> Type<'db> { + /// Return `true` if this type can be a supertype of some literals of `kind` and not others. + fn splits_literals(self, db: &'db dyn Db, kind: LiteralKind) -> bool { + match (self, kind) { + (Type::AlwaysFalsy | Type::AlwaysTruthy, _) => true, + (Type::StringLiteral(_), LiteralKind::String) => true, + (Type::BytesLiteral(_), LiteralKind::Bytes) => true, + (Type::IntLiteral(_), LiteralKind::Int) => true, + (Type::Intersection(intersection), _) => { + intersection + .positive(db) + .iter() + .any(|ty| ty.splits_literals(db, kind)) + || intersection + .negative(db) + .iter() + .any(|ty| ty.splits_literals(db, kind)) + } + (Type::Union(union), _) => union + .elements(db) + .iter() + .any(|ty| ty.splits_literals(db, kind)), + _ => false, + } + } +} + +enum UnionElement<'db> { + IntLiterals(FxOrderSet<i64>), + StringLiterals(FxOrderSet<StringLiteralType<'db>>), + BytesLiterals(FxOrderSet<BytesLiteralType<'db>>), + Type(Type<'db>), +} + +impl<'db> UnionElement<'db> { + /// Try reducing this `UnionElement` given the presence in the same union of `other_type`. + /// + /// If this `UnionElement` is a group of literals, filter the literals present if needed and + /// return `ReduceResult::KeepIf` with a boolean value indicating whether the remaining group + /// of literals should be kept in the union + /// + /// If this `UnionElement` is some other type, return `ReduceResult::Type` so `UnionBuilder` + /// can perform more complex checks on it. + fn try_reduce(&mut self, db: &'db dyn Db, other_type: Type<'db>) -> ReduceResult<'db> { + match self { + UnionElement::IntLiterals(literals) => { + if other_type.splits_literals(db, LiteralKind::Int) { + let mut collapse = false; + let negated = other_type.negate(db); + literals.retain(|literal| { + let ty = Type::IntLiteral(*literal); + if negated.is_subtype_of(db, ty) { + collapse = true; + } + !ty.is_subtype_of(db, other_type) + }); + if collapse { + ReduceResult::CollapseToObject + } else { + ReduceResult::KeepIf(!literals.is_empty()) + } + } else { + ReduceResult::KeepIf( + !Type::IntLiteral(literals[0]).is_subtype_of(db, other_type), + ) + } + } + UnionElement::StringLiterals(literals) => { + if other_type.splits_literals(db, LiteralKind::String) { + let mut collapse = false; + let negated = other_type.negate(db); + literals.retain(|literal| { + let ty = Type::StringLiteral(*literal); + if negated.is_subtype_of(db, ty) { + collapse = true; + } + !ty.is_subtype_of(db, other_type) + }); + if collapse { + ReduceResult::CollapseToObject + } else { + ReduceResult::KeepIf(!literals.is_empty()) + } + } else { + ReduceResult::KeepIf( + !Type::StringLiteral(literals[0]).is_subtype_of(db, other_type), + ) + } + } + UnionElement::BytesLiterals(literals) => { + if other_type.splits_literals(db, LiteralKind::Bytes) { + let mut collapse = false; + let negated = other_type.negate(db); + literals.retain(|literal| { + let ty = Type::BytesLiteral(*literal); + if negated.is_subtype_of(db, ty) { + collapse = true; + } + !ty.is_subtype_of(db, other_type) + }); + if collapse { + ReduceResult::CollapseToObject + } else { + ReduceResult::KeepIf(!literals.is_empty()) + } + } else { + ReduceResult::KeepIf( + !Type::BytesLiteral(literals[0]).is_subtype_of(db, other_type), + ) + } + } + UnionElement::Type(existing) => ReduceResult::Type(*existing), + } + } +} + +enum ReduceResult<'db> { + /// Reduction of this `UnionElement` is complete; keep it in the union if the nested + /// boolean is true, eliminate it from the union if false. + KeepIf(bool), + /// Collapse this entire union to `object`. + CollapseToObject, + /// The given `Type` can stand-in for the entire `UnionElement` for further union + /// simplification checks. + Type(Type<'db>), +} + +// TODO increase this once we extend `UnionElement` throughout all union/intersection +// representations, so that we can make large unions of literals fast in all operations. +const MAX_UNION_LITERALS: usize = 200; + +pub(crate) struct UnionBuilder<'db> { + elements: Vec<UnionElement<'db>>, + db: &'db dyn Db, +} + +impl<'db> UnionBuilder<'db> { + pub(crate) fn new(db: &'db dyn Db) -> Self { + Self { + db, + elements: vec![], + } + } + + pub(crate) fn is_empty(&self) -> bool { + self.elements.is_empty() + } + + /// Collapse the union to a single type: `object`. + fn collapse_to_object(&mut self) { + self.elements.clear(); + self.elements + .push(UnionElement::Type(Type::object(self.db))); + } + + /// Adds a type to this union. + pub(crate) fn add(mut self, ty: Type<'db>) -> Self { + self.add_in_place(ty); + self + } + + /// Adds a type to this union. + pub(crate) fn add_in_place(&mut self, ty: Type<'db>) { + match ty { + Type::Union(union) => { + let new_elements = union.elements(self.db); + self.elements.reserve(new_elements.len()); + for element in new_elements { + self.add_in_place(*element); + } + } + // Adding `Never` to a union is a no-op. + Type::Never => {} + // If adding a string literal, look for an existing `UnionElement::StringLiterals` to + // add it to, or an existing element that is a super-type of string literals, which + // means we shouldn't add it. Otherwise, add a new `UnionElement::StringLiterals` + // containing it. + Type::StringLiteral(literal) => { + let mut found = false; + let ty_negated = ty.negate(self.db); + for element in &mut self.elements { + match element { + UnionElement::StringLiterals(literals) => { + if literals.len() >= MAX_UNION_LITERALS { + let replace_with = KnownClass::Str.to_instance(self.db); + self.add_in_place(replace_with); + return; + } + literals.insert(literal); + found = true; + break; + } + UnionElement::Type(existing) => { + if ty.is_subtype_of(self.db, *existing) { + return; + } + if ty_negated.is_subtype_of(self.db, *existing) { + // The type that includes both this new element, and its negation + // (or a supertype of its negation), must be simply `object`. + self.collapse_to_object(); + return; + } + } + _ => {} + } + } + if !found { + self.elements + .push(UnionElement::StringLiterals(FxOrderSet::from_iter([ + literal, + ]))); + } + } + // Same for bytes literals as for string literals, above. + Type::BytesLiteral(literal) => { + let mut found = false; + let ty_negated = ty.negate(self.db); + for element in &mut self.elements { + match element { + UnionElement::BytesLiterals(literals) => { + if literals.len() >= MAX_UNION_LITERALS { + let replace_with = KnownClass::Bytes.to_instance(self.db); + self.add_in_place(replace_with); + return; + } + literals.insert(literal); + found = true; + break; + } + UnionElement::Type(existing) => { + if ty.is_subtype_of(self.db, *existing) { + return; + } + if ty_negated.is_subtype_of(self.db, *existing) { + // The type that includes both this new element, and its negation + // (or a supertype of its negation), must be simply `object`. + self.collapse_to_object(); + return; + } + } + _ => {} + } + } + if !found { + self.elements + .push(UnionElement::BytesLiterals(FxOrderSet::from_iter([ + literal, + ]))); + } + } + // And same for int literals as well. + Type::IntLiteral(literal) => { + let mut found = false; + let ty_negated = ty.negate(self.db); + for element in &mut self.elements { + match element { + UnionElement::IntLiterals(literals) => { + if literals.len() >= MAX_UNION_LITERALS { + let replace_with = KnownClass::Int.to_instance(self.db); + self.add_in_place(replace_with); + return; + } + literals.insert(literal); + found = true; + break; + } + UnionElement::Type(existing) => { + if ty.is_subtype_of(self.db, *existing) { + return; + } + if ty_negated.is_subtype_of(self.db, *existing) { + // The type that includes both this new element, and its negation + // (or a supertype of its negation), must be simply `object`. + self.collapse_to_object(); + return; + } + } + _ => {} + } + } + if !found { + self.elements + .push(UnionElement::IntLiterals(FxOrderSet::from_iter([literal]))); + } + } + // Adding `object` to a union results in `object`. + ty if ty.is_object(self.db) => { + self.collapse_to_object(); + } + _ => { + let bool_pair = if let Type::BooleanLiteral(b) = ty { + Some(Type::BooleanLiteral(!b)) + } else { + None + }; + + let mut to_add = ty; + let mut to_remove = SmallVec::<[usize; 2]>::new(); + let ty_negated = ty.negate(self.db); + + for (index, element) in self.elements.iter_mut().enumerate() { + let element_type = match element.try_reduce(self.db, ty) { + ReduceResult::KeepIf(keep) => { + if !keep { + to_remove.push(index); + } + continue; + } + ReduceResult::Type(ty) => ty, + ReduceResult::CollapseToObject => { + self.collapse_to_object(); + return; + } + }; + if Some(element_type) == bool_pair { + to_add = KnownClass::Bool.to_instance(self.db); + to_remove.push(index); + // The type we are adding is a BooleanLiteral, which doesn't have any + // subtypes. And we just found that the union already contained our + // mirror-image BooleanLiteral, so it can't also contain bool or any + // supertype of bool. Therefore, we are done. + break; + } + + if ty.is_gradual_equivalent_to(self.db, element_type) + || ty.is_subtype_of(self.db, element_type) + || element_type.is_object(self.db) + { + return; + } else if element_type.is_subtype_of(self.db, ty) { + to_remove.push(index); + } else if ty_negated.is_subtype_of(self.db, element_type) { + // We add `ty` to the union. We just checked that `~ty` is a subtype of an + // existing `element`. This also means that `~ty | ty` is a subtype of + // `element | ty`, because both elements in the first union are subtypes of + // the corresponding elements in the second union. But `~ty | ty` is just + // `object`. Since `object` is a subtype of `element | ty`, we can only + // conclude that `element | ty` must be `object` (object has no other + // supertypes). This means we can simplify the whole union to just + // `object`, since all other potential elements would also be subtypes of + // `object`. + self.collapse_to_object(); + return; + } + } + if let Some((&first, rest)) = to_remove.split_first() { + self.elements[first] = UnionElement::Type(to_add); + // We iterate in descending order to keep remaining indices valid after `swap_remove`. + for &index in rest.iter().rev() { + self.elements.swap_remove(index); + } + } else { + self.elements.push(UnionElement::Type(to_add)); + } + } + } + } + + pub(crate) fn build(self) -> Type<'db> { + let mut types = vec![]; + for element in self.elements { + match element { + UnionElement::IntLiterals(literals) => { + types.extend(literals.into_iter().map(Type::IntLiteral)); + } + UnionElement::StringLiterals(literals) => { + types.extend(literals.into_iter().map(Type::StringLiteral)); + } + UnionElement::BytesLiterals(literals) => { + types.extend(literals.into_iter().map(Type::BytesLiteral)); + } + UnionElement::Type(ty) => types.push(ty), + } + } + match types.len() { + 0 => Type::Never, + 1 => types[0], + _ => Type::Union(UnionType::new(self.db, types.into_boxed_slice())), + } + } +} + +#[derive(Clone)] +pub(crate) struct IntersectionBuilder<'db> { + // Really this builds a union-of-intersections, because we always keep our set-theoretic types + // in disjunctive normal form (DNF), a union of intersections. In the simplest case there's + // just a single intersection in this vector, and we are building a single intersection type, + // but if a union is added to the intersection, we'll distribute ourselves over that union and + // create a union of intersections. + intersections: Vec<InnerIntersectionBuilder<'db>>, + db: &'db dyn Db, +} + +impl<'db> IntersectionBuilder<'db> { + pub(crate) fn new(db: &'db dyn Db) -> Self { + Self { + db, + intersections: vec![InnerIntersectionBuilder::default()], + } + } + + fn empty(db: &'db dyn Db) -> Self { + Self { + db, + intersections: vec![], + } + } + + pub(crate) fn add_positive(mut self, ty: Type<'db>) -> Self { + if let Type::Union(union) = ty { + // Distribute ourself over this union: for each union element, clone ourself and + // intersect with that union element, then create a new union-of-intersections with all + // of those sub-intersections in it. E.g. if `self` is a simple intersection `T1 & T2` + // and we add `T3 | T4` to the intersection, we don't get `T1 & T2 & (T3 | T4)` (that's + // not in DNF), we distribute the union and get `(T1 & T3) | (T2 & T3) | (T1 & T4) | + // (T2 & T4)`. If `self` is already a union-of-intersections `(T1 & T2) | (T3 & T4)` + // and we add `T5 | T6` to it, that flattens all the way out to `(T1 & T2 & T5) | (T1 & + // T2 & T6) | (T3 & T4 & T5) ...` -- you get the idea. + union + .elements(self.db) + .iter() + .map(|elem| self.clone().add_positive(*elem)) + .fold(IntersectionBuilder::empty(self.db), |mut builder, sub| { + builder.intersections.extend(sub.intersections); + builder + }) + } else { + // If we are already a union-of-intersections, distribute the new intersected element + // across all of those intersections. + for inner in &mut self.intersections { + inner.add_positive(self.db, ty); + } + self + } + } + + pub(crate) fn add_negative(mut self, ty: Type<'db>) -> Self { + // See comments above in `add_positive`; this is just the negated version. + if let Type::Union(union) = ty { + for elem in union.elements(self.db) { + self = self.add_negative(*elem); + } + self + } else if let Type::Intersection(intersection) = ty { + // (A | B) & ~(C & ~D) + // -> (A | B) & (~C | D) + // -> ((A | B) & ~C) | ((A | B) & D) + // i.e. if we have an intersection of positive constraints C + // and negative constraints D, then our new intersection + // is (existing & ~C) | (existing & D) + + let positive_side = intersection + .positive(self.db) + .iter() + // we negate all the positive constraints while distributing + .map(|elem| self.clone().add_negative(*elem)); + + let negative_side = intersection + .negative(self.db) + .iter() + // all negative constraints end up becoming positive constraints + .map(|elem| self.clone().add_positive(*elem)); + + positive_side.chain(negative_side).fold( + IntersectionBuilder::empty(self.db), + |mut builder, sub| { + builder.intersections.extend(sub.intersections); + builder + }, + ) + } else { + for inner in &mut self.intersections { + inner.add_negative(self.db, ty); + } + self + } + } + + pub(crate) fn positive_elements<I, T>(mut self, elements: I) -> Self + where + I: IntoIterator<Item = T>, + T: Into<Type<'db>>, + { + for element in elements { + self = self.add_positive(element.into()); + } + self + } + + pub(crate) fn negative_elements<I, T>(mut self, elements: I) -> Self + where + I: IntoIterator<Item = T>, + T: Into<Type<'db>>, + { + for element in elements { + self = self.add_negative(element.into()); + } + self + } + + pub(crate) fn build(mut self) -> Type<'db> { + // Avoid allocating the UnionBuilder unnecessarily if we have just one intersection: + if self.intersections.len() == 1 { + self.intersections.pop().unwrap().build(self.db) + } else { + UnionType::from_elements( + self.db, + self.intersections + .into_iter() + .map(|inner| inner.build(self.db)), + ) + } + } +} + +#[derive(Debug, Clone, Default)] +struct InnerIntersectionBuilder<'db> { + positive: FxOrderSet<Type<'db>>, + negative: FxOrderSet<Type<'db>>, +} + +impl<'db> InnerIntersectionBuilder<'db> { + /// Adds a positive type to this intersection. + fn add_positive(&mut self, db: &'db dyn Db, mut new_positive: Type<'db>) { + match new_positive { + // `LiteralString & AlwaysTruthy` -> `LiteralString & ~Literal[""]` + Type::AlwaysTruthy if self.positive.contains(&Type::LiteralString) => { + self.add_negative(db, Type::string_literal(db, "")); + } + // `LiteralString & AlwaysFalsy` -> `Literal[""]` + Type::AlwaysFalsy if self.positive.swap_remove(&Type::LiteralString) => { + self.add_positive(db, Type::string_literal(db, "")); + } + // `AlwaysTruthy & LiteralString` -> `LiteralString & ~Literal[""]` + Type::LiteralString if self.positive.swap_remove(&Type::AlwaysTruthy) => { + self.add_positive(db, Type::LiteralString); + self.add_negative(db, Type::string_literal(db, "")); + } + // `AlwaysFalsy & LiteralString` -> `Literal[""]` + Type::LiteralString if self.positive.swap_remove(&Type::AlwaysFalsy) => { + self.add_positive(db, Type::string_literal(db, "")); + } + // `LiteralString & ~AlwaysTruthy` -> `LiteralString & AlwaysFalsy` -> `Literal[""]` + Type::LiteralString if self.negative.swap_remove(&Type::AlwaysTruthy) => { + self.add_positive(db, Type::string_literal(db, "")); + } + // `LiteralString & ~AlwaysFalsy` -> `LiteralString & ~Literal[""]` + Type::LiteralString if self.negative.swap_remove(&Type::AlwaysFalsy) => { + self.add_positive(db, Type::LiteralString); + self.add_negative(db, Type::string_literal(db, "")); + } + // `(A & B & ~C) & (D & E & ~F)` -> `A & B & D & E & ~C & ~F` + Type::Intersection(other) => { + for pos in other.positive(db) { + self.add_positive(db, *pos); + } + for neg in other.negative(db) { + self.add_negative(db, *neg); + } + } + _ => { + let known_instance = new_positive + .into_nominal_instance() + .and_then(|instance| instance.class.known(db)); + + if known_instance == Some(KnownClass::Object) { + // `object & T` -> `T`; it is always redundant to add `object` to an intersection + return; + } + + let addition_is_bool_instance = known_instance == Some(KnownClass::Bool); + + for (index, existing_positive) in self.positive.iter().enumerate() { + match existing_positive { + // `AlwaysTruthy & bool` -> `Literal[True]` + Type::AlwaysTruthy if addition_is_bool_instance => { + new_positive = Type::BooleanLiteral(true); + } + // `AlwaysFalsy & bool` -> `Literal[False]` + Type::AlwaysFalsy if addition_is_bool_instance => { + new_positive = Type::BooleanLiteral(false); + } + Type::NominalInstance(instance) + if instance.class.is_known(db, KnownClass::Bool) => + { + match new_positive { + // `bool & AlwaysTruthy` -> `Literal[True]` + Type::AlwaysTruthy => { + new_positive = Type::BooleanLiteral(true); + } + // `bool & AlwaysFalsy` -> `Literal[False]` + Type::AlwaysFalsy => { + new_positive = Type::BooleanLiteral(false); + } + _ => continue, + } + } + _ => continue, + } + self.positive.swap_remove_index(index); + break; + } + + if addition_is_bool_instance { + for (index, existing_negative) in self.negative.iter().enumerate() { + match existing_negative { + // `bool & ~Literal[False]` -> `Literal[True]` + // `bool & ~Literal[True]` -> `Literal[False]` + Type::BooleanLiteral(bool_value) => { + new_positive = Type::BooleanLiteral(!bool_value); + } + // `bool & ~AlwaysTruthy` -> `Literal[False]` + Type::AlwaysTruthy => { + new_positive = Type::BooleanLiteral(false); + } + // `bool & ~AlwaysFalsy` -> `Literal[True]` + Type::AlwaysFalsy => { + new_positive = Type::BooleanLiteral(true); + } + _ => continue, + } + self.negative.swap_remove_index(index); + break; + } + } + + let mut to_remove = SmallVec::<[usize; 1]>::new(); + for (index, existing_positive) in self.positive.iter().enumerate() { + // S & T = S if S <: T + if existing_positive.is_subtype_of(db, new_positive) + || existing_positive.is_gradual_equivalent_to(db, new_positive) + { + return; + } + // same rule, reverse order + if new_positive.is_subtype_of(db, *existing_positive) { + to_remove.push(index); + } + // A & B = Never if A and B are disjoint + if new_positive.is_disjoint_from(db, *existing_positive) { + *self = Self::default(); + self.positive.insert(Type::Never); + return; + } + } + for index in to_remove.into_iter().rev() { + self.positive.swap_remove_index(index); + } + + let mut to_remove = SmallVec::<[usize; 1]>::new(); + for (index, existing_negative) in self.negative.iter().enumerate() { + // S & ~T = Never if S <: T + if new_positive.is_subtype_of(db, *existing_negative) { + *self = Self::default(); + self.positive.insert(Type::Never); + return; + } + // A & ~B = A if A and B are disjoint + if existing_negative.is_disjoint_from(db, new_positive) { + to_remove.push(index); + } + } + for index in to_remove.into_iter().rev() { + self.negative.swap_remove_index(index); + } + + self.positive.insert(new_positive); + } + } + } + + /// Adds a negative type to this intersection. + fn add_negative(&mut self, db: &'db dyn Db, new_negative: Type<'db>) { + let contains_bool = || { + self.positive + .iter() + .filter_map(|ty| ty.into_nominal_instance()) + .filter_map(|instance| instance.class.known(db)) + .any(KnownClass::is_bool) + }; + + match new_negative { + Type::Intersection(inter) => { + for pos in inter.positive(db) { + self.add_negative(db, *pos); + } + for neg in inter.negative(db) { + self.add_positive(db, *neg); + } + } + Type::Never => { + // Adding ~Never to an intersection is a no-op. + } + Type::NominalInstance(instance) if instance.class.is_object(db) => { + // Adding ~object to an intersection results in Never. + *self = Self::default(); + self.positive.insert(Type::Never); + } + ty @ Type::Dynamic(_) => { + // Adding any of these types to the negative side of an intersection + // is equivalent to adding it to the positive side. We do this to + // simplify the representation. + self.add_positive(db, ty); + } + // `bool & ~AlwaysTruthy` -> `bool & Literal[False]` + // `bool & ~Literal[True]` -> `bool & Literal[False]` + Type::AlwaysTruthy | Type::BooleanLiteral(true) if contains_bool() => { + self.add_positive(db, Type::BooleanLiteral(false)); + } + // `LiteralString & ~AlwaysTruthy` -> `LiteralString & Literal[""]` + Type::AlwaysTruthy if self.positive.contains(&Type::LiteralString) => { + self.add_positive(db, Type::string_literal(db, "")); + } + // `bool & ~AlwaysFalsy` -> `bool & Literal[True]` + // `bool & ~Literal[False]` -> `bool & Literal[True]` + Type::AlwaysFalsy | Type::BooleanLiteral(false) if contains_bool() => { + self.add_positive(db, Type::BooleanLiteral(true)); + } + // `LiteralString & ~AlwaysFalsy` -> `LiteralString & ~Literal[""]` + Type::AlwaysFalsy if self.positive.contains(&Type::LiteralString) => { + self.add_negative(db, Type::string_literal(db, "")); + } + _ => { + let mut to_remove = SmallVec::<[usize; 1]>::new(); + for (index, existing_negative) in self.negative.iter().enumerate() { + // ~S & ~T = ~T if S <: T + if existing_negative.is_subtype_of(db, new_negative) + || existing_negative.is_gradual_equivalent_to(db, new_negative) + { + to_remove.push(index); + } + // same rule, reverse order + if new_negative.is_subtype_of(db, *existing_negative) { + return; + } + } + for index in to_remove.into_iter().rev() { + self.negative.swap_remove_index(index); + } + + for existing_positive in &self.positive { + // S & ~T = Never if S <: T + if existing_positive.is_subtype_of(db, new_negative) { + *self = Self::default(); + self.positive.insert(Type::Never); + return; + } + // A & ~B = A if A and B are disjoint + if existing_positive.is_disjoint_from(db, new_negative) { + return; + } + } + + self.negative.insert(new_negative); + } + } + } + + /// Tries to simplify any constrained typevars in the intersection: + /// + /// - If the intersection contains a positive entry for exactly one of the constraints, we can + /// remove the typevar (effectively replacing it with that one positive constraint). + /// + /// - If the intersection contains negative entries for all but one of the constraints, we can + /// remove the negative constraints and replace the typevar with the remaining positive + /// constraint. + /// + /// - If the intersection contains negative entries for all of the constraints, the overall + /// intersection is `Never`. + fn simplify_constrained_typevars(&mut self, db: &'db dyn Db) { + let mut to_add = SmallVec::<[Type<'db>; 1]>::new(); + let mut positive_to_remove = SmallVec::<[usize; 1]>::new(); + + for (typevar_index, ty) in self.positive.iter().enumerate() { + let Type::TypeVar(typevar) = ty else { + continue; + }; + let Some(TypeVarBoundOrConstraints::Constraints(constraints)) = + typevar.bound_or_constraints(db) + else { + continue; + }; + + // Determine which constraints appear as positive entries in the intersection. Note + // that we shouldn't have duplicate entries in the positive or negative lists, so we + // don't need to worry about finding any particular constraint more than once. + let constraints = constraints.elements(db); + let mut positive_constraint_count = 0; + for positive in &self.positive { + // This linear search should be fine as long as we don't encounter typevars with + // thousands of constraints. + positive_constraint_count += constraints + .iter() + .filter(|c| c.is_subtype_of(db, *positive)) + .count(); + } + + // If precisely one constraint appears as a positive element, we can replace the + // typevar with that positive constraint. + if positive_constraint_count == 1 { + positive_to_remove.push(typevar_index); + continue; + } + + // Determine which constraints appear as negative entries in the intersection. + let mut to_remove = Vec::with_capacity(constraints.len()); + let mut remaining_constraints: Vec<_> = constraints.iter().copied().map(Some).collect(); + for (negative_index, negative) in self.negative.iter().enumerate() { + // This linear search should be fine as long as we don't encounter typevars with + // thousands of constraints. + let matching_constraints = constraints + .iter() + .enumerate() + .filter(|(_, c)| c.is_subtype_of(db, *negative)); + for (constraint_index, _) in matching_constraints { + to_remove.push(negative_index); + remaining_constraints[constraint_index] = None; + } + } + + let mut iter = remaining_constraints.into_iter().flatten(); + let Some(remaining_constraint) = iter.next() else { + // All of the typevar constraints have been removed, so the entire intersection is + // `Never`. + *self = Self::default(); + self.positive.insert(Type::Never); + return; + }; + + let more_than_one_remaining_constraint = iter.next().is_some(); + if more_than_one_remaining_constraint { + // This typevar cannot be simplified. + continue; + } + + // Only one typevar constraint remains. Remove all of the negative constraints, and + // replace the typevar itself with the remaining positive constraint. + to_add.push(remaining_constraint); + positive_to_remove.push(typevar_index); + } + + // We don't need to sort the positive list, since we only append to it in increasing order. + for index in positive_to_remove.into_iter().rev() { + self.positive.swap_remove_index(index); + } + + for remaining_constraint in to_add { + self.add_positive(db, remaining_constraint); + } + } + + fn build(mut self, db: &'db dyn Db) -> Type<'db> { + self.simplify_constrained_typevars(db); + match (self.positive.len(), self.negative.len()) { + (0, 0) => Type::object(db), + (1, 0) => self.positive[0], + _ => { + self.positive.shrink_to_fit(); + self.negative.shrink_to_fit(); + Type::Intersection(IntersectionType::new(db, self.positive, self.negative)) + } + } + } +} + +#[cfg(test)] +mod tests { + use super::{IntersectionBuilder, Type, UnionBuilder, UnionType}; + + use crate::db::tests::setup_db; + use crate::types::{KnownClass, Truthiness}; + + use test_case::test_case; + + #[test] + fn build_union_no_elements() { + let db = setup_db(); + + let empty_union = UnionBuilder::new(&db).build(); + assert_eq!(empty_union, Type::Never); + } + + #[test] + fn build_union_single_element() { + let db = setup_db(); + + let t0 = Type::IntLiteral(0); + let union = UnionType::from_elements(&db, [t0]); + assert_eq!(union, t0); + } + + #[test] + fn build_union_two_elements() { + let db = setup_db(); + + let t0 = Type::IntLiteral(0); + let t1 = Type::IntLiteral(1); + let union = UnionType::from_elements(&db, [t0, t1]).expect_union(); + + assert_eq!(union.elements(&db), &[t0, t1]); + } + + #[test] + fn build_intersection_empty_intersection_equals_object() { + let db = setup_db(); + + let intersection = IntersectionBuilder::new(&db).build(); + assert_eq!(intersection, Type::object(&db)); + } + + #[test_case(Type::BooleanLiteral(true))] + #[test_case(Type::BooleanLiteral(false))] + #[test_case(Type::AlwaysTruthy)] + #[test_case(Type::AlwaysFalsy)] + fn build_intersection_simplify_split_bool(t_splitter: Type) { + let db = setup_db(); + let bool_value = t_splitter.bool(&db) == Truthiness::AlwaysTrue; + + // We add t_object in various orders (in first or second position) in + // the tests below to ensure that the boolean simplification eliminates + // everything from the intersection, not just `bool`. + let t_object = Type::object(&db); + let t_bool = KnownClass::Bool.to_instance(&db); + + let ty = IntersectionBuilder::new(&db) + .add_positive(t_object) + .add_positive(t_bool) + .add_negative(t_splitter) + .build(); + assert_eq!(ty, Type::BooleanLiteral(!bool_value)); + + let ty = IntersectionBuilder::new(&db) + .add_positive(t_bool) + .add_positive(t_object) + .add_negative(t_splitter) + .build(); + assert_eq!(ty, Type::BooleanLiteral(!bool_value)); + + let ty = IntersectionBuilder::new(&db) + .add_positive(t_object) + .add_negative(t_splitter) + .add_positive(t_bool) + .build(); + assert_eq!(ty, Type::BooleanLiteral(!bool_value)); + + let ty = IntersectionBuilder::new(&db) + .add_negative(t_splitter) + .add_positive(t_object) + .add_positive(t_bool) + .build(); + assert_eq!(ty, Type::BooleanLiteral(!bool_value)); + } +} diff --git a/crates/ty_python_semantic/src/types/call.rs b/crates/ty_python_semantic/src/types/call.rs new file mode 100644 index 0000000000000..27c10e5432a0d --- /dev/null +++ b/crates/ty_python_semantic/src/types/call.rs @@ -0,0 +1,69 @@ +use super::context::InferContext; +use super::{CallableSignature, Signature, Signatures, Type}; +use crate::Db; + +mod arguments; +mod bind; +pub(super) use arguments::{Argument, CallArgumentTypes, CallArguments}; +pub(super) use bind::{Bindings, CallableBinding}; + +/// Wraps a [`Bindings`] for an unsuccessful call with information about why the call was +/// unsuccessful. +/// +/// The bindings are boxed so that we do not pass around large `Err` variants on the stack. +#[derive(Debug)] +pub(crate) struct CallError<'db>(pub(crate) CallErrorKind, pub(crate) Box<Bindings<'db>>); + +/// The reason why calling a type failed. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum CallErrorKind { + /// The type is not callable. For a union type, _none_ of the union elements are callable. + NotCallable, + + /// The type is not callable with the given arguments. + /// + /// `BindingError` takes precedence over `PossiblyNotCallable`: for a union type, there might + /// be some union elements that are not callable at all, but the call arguments are not + /// compatible with at least one of the callable elements. + BindingError, + + /// Not all of the elements of a union type are callable, but the call arguments are compatible + /// with all of the callable elements. + PossiblyNotCallable, +} + +#[derive(Debug)] +pub(super) enum CallDunderError<'db> { + /// The dunder attribute exists but it can't be called with the given arguments. + /// + /// This includes non-callable dunder attributes that are possibly unbound. + CallError(CallErrorKind, Box<Bindings<'db>>), + + /// The type has the specified dunder method and it is callable + /// with the specified arguments without any binding errors + /// but it is possibly unbound. + PossiblyUnbound(Box<Bindings<'db>>), + + /// The dunder method with the specified name is missing. + MethodNotAvailable, +} + +impl<'db> CallDunderError<'db> { + pub(super) fn return_type(&self, db: &'db dyn Db) -> Option<Type<'db>> { + match self { + Self::MethodNotAvailable | Self::CallError(CallErrorKind::NotCallable, _) => None, + Self::CallError(_, bindings) => Some(bindings.return_type(db)), + Self::PossiblyUnbound(bindings) => Some(bindings.return_type(db)), + } + } + + pub(super) fn fallback_return_type(&self, db: &'db dyn Db) -> Type<'db> { + self.return_type(db).unwrap_or(Type::unknown()) + } +} + +impl<'db> From<CallError<'db>> for CallDunderError<'db> { + fn from(CallError(kind, bindings): CallError<'db>) -> Self { + Self::CallError(kind, bindings) + } +} diff --git a/crates/ty_python_semantic/src/types/call/arguments.rs b/crates/ty_python_semantic/src/types/call/arguments.rs new file mode 100644 index 0000000000000..392c4ee514268 --- /dev/null +++ b/crates/ty_python_semantic/src/types/call/arguments.rs @@ -0,0 +1,124 @@ +use std::borrow::Cow; +use std::ops::{Deref, DerefMut}; + +use super::Type; + +/// Arguments for a single call, in source order. +#[derive(Clone, Debug, Default)] +pub(crate) struct CallArguments<'a>(Vec<Argument<'a>>); + +impl<'a> CallArguments<'a> { + /// Prepend an optional extra synthetic argument (for a `self` or `cls` parameter) to the front + /// of this argument list. (If `bound_self` is none, we return the argument list + /// unmodified.) + pub(crate) fn with_self(&self, bound_self: Option<Type<'_>>) -> Cow<Self> { + if bound_self.is_some() { + let arguments = std::iter::once(Argument::Synthetic) + .chain(self.0.iter().copied()) + .collect(); + Cow::Owned(CallArguments(arguments)) + } else { + Cow::Borrowed(self) + } + } + + pub(crate) fn len(&self) -> usize { + self.0.len() + } + + pub(crate) fn iter(&self) -> impl Iterator<Item = Argument<'a>> + '_ { + self.0.iter().copied() + } +} + +impl<'a> FromIterator<Argument<'a>> for CallArguments<'a> { + fn from_iter<T: IntoIterator<Item = Argument<'a>>>(iter: T) -> Self { + Self(iter.into_iter().collect()) + } +} + +#[derive(Clone, Copy, Debug)] +pub(crate) enum Argument<'a> { + /// The synthetic `self` or `cls` argument, which doesn't appear explicitly at the call site. + Synthetic, + /// A positional argument. + Positional, + /// A starred positional argument (e.g. `*args`). + Variadic, + /// A keyword argument (e.g. `a=1`). + Keyword(&'a str), + /// The double-starred keywords argument (e.g. `**kwargs`). + Keywords, +} + +/// Arguments for a single call, in source order, along with inferred types for each argument. +#[derive(Clone, Debug, Default)] +pub(crate) struct CallArgumentTypes<'a, 'db> { + arguments: CallArguments<'a>, + types: Vec<Type<'db>>, +} + +impl<'a, 'db> CallArgumentTypes<'a, 'db> { + /// Create a [`CallArgumentTypes`] with no arguments. + pub(crate) fn none() -> Self { + Self::default() + } + + /// Create a [`CallArgumentTypes`] from an iterator over non-variadic positional argument + /// types. + pub(crate) fn positional(positional_tys: impl IntoIterator<Item = Type<'db>>) -> Self { + let types: Vec<_> = positional_tys.into_iter().collect(); + let arguments = CallArguments(vec![Argument::Positional; types.len()]); + Self { arguments, types } + } + + /// Create a new [`CallArgumentTypes`] to store the inferred types of the arguments in a + /// [`CallArguments`]. Uses the provided callback to infer each argument type. + pub(crate) fn new<F>(arguments: CallArguments<'a>, mut f: F) -> Self + where + F: FnMut(usize, Argument<'a>) -> Type<'db>, + { + let types = arguments + .iter() + .enumerate() + .map(|(idx, argument)| f(idx, argument)) + .collect(); + Self { arguments, types } + } + + /// Prepend an optional extra synthetic argument (for a `self` or `cls` parameter) to the front + /// of this argument list. (If `bound_self` is none, we return the argument list + /// unmodified.) + pub(crate) fn with_self(&self, bound_self: Option<Type<'db>>) -> Cow<Self> { + if let Some(bound_self) = bound_self { + let arguments = CallArguments( + std::iter::once(Argument::Synthetic) + .chain(self.arguments.0.iter().copied()) + .collect(), + ); + let types = std::iter::once(bound_self) + .chain(self.types.iter().copied()) + .collect(); + Cow::Owned(CallArgumentTypes { arguments, types }) + } else { + Cow::Borrowed(self) + } + } + + pub(crate) fn iter(&self) -> impl Iterator<Item = (Argument<'a>, Type<'db>)> + '_ { + self.arguments.iter().zip(self.types.iter().copied()) + } +} + +impl<'a> Deref for CallArgumentTypes<'a, '_> { + type Target = CallArguments<'a>; + fn deref(&self) -> &CallArguments<'a> { + &self.arguments + } +} + +impl<'a> DerefMut for CallArgumentTypes<'a, '_> { + fn deref_mut(&mut self) -> &mut CallArguments<'a> { + &mut self.arguments + } +} diff --git a/crates/ty_python_semantic/src/types/call/bind.rs b/crates/ty_python_semantic/src/types/call/bind.rs new file mode 100644 index 0000000000000..a94022f9c31b9 --- /dev/null +++ b/crates/ty_python_semantic/src/types/call/bind.rs @@ -0,0 +1,1912 @@ +//! When analyzing a call site, we create _bindings_, which match and type-check the actual +//! arguments against the parameters of the callable. Like with +//! [signatures][crate::types::signatures], we have to handle the fact that the callable might be a +//! union of types, each of which might contain multiple overloads. + +use smallvec::SmallVec; + +use super::{ + Argument, CallArgumentTypes, CallArguments, CallError, CallErrorKind, CallableSignature, + InferContext, Signature, Signatures, Type, +}; +use crate::db::Db; +use crate::dunder_all::dunder_all_names; +use crate::symbol::{Boundness, Symbol}; +use crate::types::diagnostic::{ + CALL_NON_CALLABLE, CONFLICTING_ARGUMENT_FORMS, INVALID_ARGUMENT_TYPE, MISSING_ARGUMENT, + NO_MATCHING_OVERLOAD, PARAMETER_ALREADY_ASSIGNED, TOO_MANY_POSITIONAL_ARGUMENTS, + UNKNOWN_ARGUMENT, +}; +use crate::types::generics::{Specialization, SpecializationBuilder, SpecializationError}; +use crate::types::signatures::{Parameter, ParameterForm}; +use crate::types::{ + BoundMethodType, DataclassParams, DataclassTransformerParams, FunctionDecorators, FunctionType, + KnownClass, KnownFunction, KnownInstanceType, MethodWrapperKind, PropertyInstanceType, + TupleType, TypeMapping, UnionType, WrapperDescriptorKind, todo_type, +}; +use ruff_db::diagnostic::{Annotation, Diagnostic, Severity, SubDiagnostic}; +use ruff_python_ast as ast; + +/// Binding information for a possible union of callables. At a call site, the arguments must be +/// compatible with _all_ of the types in the union for the call to be valid. +/// +/// It's guaranteed that the wrapped bindings have no errors. +#[derive(Debug)] +pub(crate) struct Bindings<'db> { + signatures: Signatures<'db>, + /// By using `SmallVec`, we avoid an extra heap allocation for the common case of a non-union + /// type. + elements: SmallVec<[CallableBinding<'db>; 1]>, + + /// Whether each argument will be used as a value and/or a type form in this call. + pub(crate) argument_forms: Box<[Option<ParameterForm>]>, + + conflicting_forms: Box<[bool]>, +} + +impl<'db> Bindings<'db> { + /// Match the arguments of a call site against the parameters of a collection of possibly + /// unioned, possibly overloaded signatures. + /// + /// The returned bindings tell you which parameter (in each signature) each argument was + /// matched against. You can then perform type inference on each argument with extra context + /// about the expected parameter types. (You do this by creating a [`CallArgumentTypes`] object + /// from the `arguments` that you match against.) + /// + /// Once you have argument types available, you can call [`check_types`][Self::check_types] to + /// verify that each argument type is assignable to the corresponding parameter type. + pub(crate) fn match_parameters( + signatures: Signatures<'db>, + arguments: &CallArguments<'_>, + ) -> Self { + let mut argument_forms = vec![None; arguments.len()]; + let mut conflicting_forms = vec![false; arguments.len()]; + let elements: SmallVec<[CallableBinding<'db>; 1]> = signatures + .iter() + .map(|signature| { + CallableBinding::match_parameters( + signature, + arguments, + &mut argument_forms, + &mut conflicting_forms, + ) + }) + .collect(); + + Bindings { + signatures, + elements, + argument_forms: argument_forms.into(), + conflicting_forms: conflicting_forms.into(), + } + } + + /// Verify that the type of each argument is assignable to type of the parameter that it was + /// matched to. + /// + /// You must provide an `argument_types` that was created from the same `arguments` that you + /// provided to [`match_parameters`][Self::match_parameters]. + /// + /// We update the bindings to include the return type of the call, the bound types for all + /// parameters, and any errors resulting from binding the call, all for each union element and + /// overload (if any). + pub(crate) fn check_types( + mut self, + db: &'db dyn Db, + argument_types: &CallArgumentTypes<'_, 'db>, + ) -> Result<Self, CallError<'db>> { + for (signature, element) in self.signatures.iter().zip(&mut self.elements) { + element.check_types(db, signature, argument_types); + } + + self.evaluate_known_cases(db); + + // In order of precedence: + // + // - If every union element is Ok, then the union is too. + // - If any element has a BindingError, the union has a BindingError. + // - If every element is NotCallable, then the union is also NotCallable. + // - Otherwise, the elements are some mixture of Ok, NotCallable, and PossiblyNotCallable. + // The union as a whole is PossiblyNotCallable. + // + // For example, the union type `Callable[[int], int] | None` may not be callable at all, + // because the `None` element in this union has no `__call__` method. + // + // On the other hand, the union type `Callable[[int], int] | Callable[[str], str]` is + // always *callable*, but it would produce a `BindingError` if an inhabitant of this type + // was called with a single `int` argument passed in. That's because the second element in + // the union doesn't accept an `int` when it's called: it only accepts a `str`. + let mut all_ok = true; + let mut any_binding_error = false; + let mut all_not_callable = true; + if self.conflicting_forms.contains(&true) { + all_ok = false; + any_binding_error = true; + all_not_callable = false; + } + for binding in &self.elements { + let result = binding.as_result(); + all_ok &= result.is_ok(); + any_binding_error |= matches!(result, Err(CallErrorKind::BindingError)); + all_not_callable &= matches!(result, Err(CallErrorKind::NotCallable)); + } + + if all_ok { + Ok(self) + } else if any_binding_error { + Err(CallError(CallErrorKind::BindingError, Box::new(self))) + } else if all_not_callable { + Err(CallError(CallErrorKind::NotCallable, Box::new(self))) + } else { + Err(CallError( + CallErrorKind::PossiblyNotCallable, + Box::new(self), + )) + } + } + + pub(crate) fn is_single(&self) -> bool { + self.elements.len() == 1 + } + + pub(crate) fn single_element(&self) -> Option<&CallableBinding<'db>> { + match self.elements.as_slice() { + [element] => Some(element), + _ => None, + } + } + + pub(crate) fn callable_type(&self) -> Type<'db> { + self.signatures.callable_type + } + + /// Returns the return type of the call. For successful calls, this is the actual return type. + /// For calls with binding errors, this is a type that best approximates the return type. For + /// types that are not callable, returns `Type::Unknown`. + pub(crate) fn return_type(&self, db: &'db dyn Db) -> Type<'db> { + if let [binding] = self.elements.as_slice() { + return binding.return_type(); + } + UnionType::from_elements(db, self.into_iter().map(CallableBinding::return_type)) + } + + /// Report diagnostics for all of the errors that occurred when trying to match actual + /// arguments to formal parameters. If the callable is a union, or has multiple overloads, we + /// report a single diagnostic if we couldn't match any union element or overload. + /// TODO: Update this to add subdiagnostics about how we failed to match each union element and + /// overload. + pub(crate) fn report_diagnostics(&self, context: &InferContext<'db>, node: ast::AnyNodeRef) { + // If all union elements are not callable, report that the union as a whole is not + // callable. + if self.into_iter().all(|b| !b.is_callable()) { + if let Some(builder) = context.report_lint(&CALL_NON_CALLABLE, node) { + builder.into_diagnostic(format_args!( + "Object of type `{}` is not callable", + self.callable_type().display(context.db()) + )); + } + return; + } + + for (index, conflicting_form) in self.conflicting_forms.iter().enumerate() { + if *conflicting_form { + let node = BindingError::get_node(node, Some(index)); + if let Some(builder) = context.report_lint(&CONFLICTING_ARGUMENT_FORMS, node) { + builder.into_diagnostic( + "Argument is used as both a value and a type form in call", + ); + } + } + } + + // If this is not a union, then report a diagnostic for any + // errors as normal. + if let Some(binding) = self.single_element() { + binding.report_diagnostics(context, node, None); + return; + } + + for binding in self { + let union_diag = UnionDiagnostic { + callable_type: self.callable_type(), + binding, + }; + binding.report_diagnostics(context, node, Some(&union_diag)); + } + } + + /// Evaluates the return type of certain known callables, where we have special-case logic to + /// determine the return type in a way that isn't directly expressible in the type system. + fn evaluate_known_cases(&mut self, db: &'db dyn Db) { + let to_bool = |ty: &Option<Type<'_>>, default: bool| -> bool { + if let Some(Type::BooleanLiteral(value)) = ty { + *value + } else { + // TODO: emit a diagnostic if we receive `bool` + default + } + }; + + // Each special case listed here should have a corresponding clause in `Type::signatures`. + for (binding, callable_signature) in self.elements.iter_mut().zip(self.signatures.iter()) { + let binding_type = binding.callable_type; + for (overload_index, overload) in binding.matching_overloads_mut() { + match binding_type { + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet(function)) => { + if function.has_known_decorator(db, FunctionDecorators::CLASSMETHOD) { + match overload.parameter_types() { + [_, Some(owner)] => { + overload.set_return_type(Type::BoundMethod( + BoundMethodType::new(db, function, *owner), + )); + } + [Some(instance), None] => { + overload.set_return_type(Type::BoundMethod( + BoundMethodType::new( + db, + function, + instance.to_meta_type(db), + ), + )); + } + _ => {} + } + } else if let [Some(first), _] = overload.parameter_types() { + if first.is_none(db) { + overload.set_return_type(Type::FunctionLiteral(function)); + } else { + overload.set_return_type(Type::BoundMethod(BoundMethodType::new( + db, function, *first, + ))); + } + } + } + + Type::WrapperDescriptor(WrapperDescriptorKind::FunctionTypeDunderGet) => { + if let [Some(function_ty @ Type::FunctionLiteral(function)), ..] = + overload.parameter_types() + { + if function.has_known_decorator(db, FunctionDecorators::CLASSMETHOD) { + match overload.parameter_types() { + [_, _, Some(owner)] => { + overload.set_return_type(Type::BoundMethod( + BoundMethodType::new(db, *function, *owner), + )); + } + + [_, Some(instance), None] => { + overload.set_return_type(Type::BoundMethod( + BoundMethodType::new( + db, + *function, + instance.to_meta_type(db), + ), + )); + } + + _ => {} + } + } else { + match overload.parameter_types() { + [_, Some(instance), _] if instance.is_none(db) => { + overload.set_return_type(*function_ty); + } + [_, Some(instance), _] => { + overload.set_return_type(Type::BoundMethod( + BoundMethodType::new(db, *function, *instance), + )); + } + + _ => {} + } + } + } + } + + Type::WrapperDescriptor(WrapperDescriptorKind::PropertyDunderGet) => { + match overload.parameter_types() { + [ + Some(property @ Type::PropertyInstance(_)), + Some(instance), + .., + ] if instance.is_none(db) => { + overload.set_return_type(*property); + } + [ + Some(Type::PropertyInstance(property)), + Some(Type::KnownInstance(KnownInstanceType::TypeAliasType( + type_alias, + ))), + .., + ] if property.getter(db).is_some_and(|getter| { + getter + .into_function_literal() + .is_some_and(|f| f.name(db) == "__name__") + }) => + { + overload + .set_return_type(Type::string_literal(db, type_alias.name(db))); + } + [ + Some(Type::PropertyInstance(property)), + Some(Type::KnownInstance(KnownInstanceType::TypeVar(typevar))), + .., + ] => { + match property + .getter(db) + .and_then(Type::into_function_literal) + .map(|f| f.name(db).as_str()) + { + Some("__name__") => { + overload.set_return_type(Type::string_literal( + db, + typevar.name(db), + )); + } + Some("__bound__") => { + overload.set_return_type( + typevar + .upper_bound(db) + .unwrap_or_else(|| Type::none(db)), + ); + } + Some("__constraints__") => { + overload.set_return_type(TupleType::from_elements( + db, + typevar.constraints(db).into_iter().flatten(), + )); + } + Some("__default__") => { + overload.set_return_type( + typevar.default_ty(db).unwrap_or_else(|| { + KnownClass::NoDefaultType.to_instance(db) + }), + ); + } + _ => {} + } + } + [Some(Type::PropertyInstance(property)), Some(instance), ..] => { + if let Some(getter) = property.getter(db) { + if let Ok(return_ty) = getter + .try_call(db, &CallArgumentTypes::positional([*instance])) + .map(|binding| binding.return_type(db)) + { + overload.set_return_type(return_ty); + } else { + overload.errors.push(BindingError::InternalCallError( + "calling the getter failed", + )); + overload.set_return_type(Type::unknown()); + } + } else { + overload.errors.push(BindingError::InternalCallError( + "property has no getter", + )); + overload.set_return_type(Type::Never); + } + } + _ => {} + } + } + + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet(property)) => { + match overload.parameter_types() { + [Some(instance), ..] if instance.is_none(db) => { + overload.set_return_type(Type::PropertyInstance(property)); + } + [Some(instance), ..] => { + if let Some(getter) = property.getter(db) { + if let Ok(return_ty) = getter + .try_call(db, &CallArgumentTypes::positional([*instance])) + .map(|binding| binding.return_type(db)) + { + overload.set_return_type(return_ty); + } else { + overload.errors.push(BindingError::InternalCallError( + "calling the getter failed", + )); + overload.set_return_type(Type::unknown()); + } + } else { + overload.set_return_type(Type::Never); + overload.errors.push(BindingError::InternalCallError( + "property has no getter", + )); + } + } + _ => {} + } + } + + Type::WrapperDescriptor(WrapperDescriptorKind::PropertyDunderSet) => { + if let [ + Some(Type::PropertyInstance(property)), + Some(instance), + Some(value), + .., + ] = overload.parameter_types() + { + if let Some(setter) = property.setter(db) { + if let Err(_call_error) = setter.try_call( + db, + &CallArgumentTypes::positional([*instance, *value]), + ) { + overload.errors.push(BindingError::InternalCallError( + "calling the setter failed", + )); + } + } else { + overload.errors.push(BindingError::InternalCallError( + "property has no setter", + )); + } + } + } + + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet(property)) => { + if let [Some(instance), Some(value), ..] = overload.parameter_types() { + if let Some(setter) = property.setter(db) { + if let Err(_call_error) = setter.try_call( + db, + &CallArgumentTypes::positional([*instance, *value]), + ) { + overload.errors.push(BindingError::InternalCallError( + "calling the setter failed", + )); + } + } else { + overload.errors.push(BindingError::InternalCallError( + "property has no setter", + )); + } + } + } + + Type::MethodWrapper(MethodWrapperKind::StrStartswith(literal)) => { + if let [Some(Type::StringLiteral(prefix)), None, None] = + overload.parameter_types() + { + overload.set_return_type(Type::BooleanLiteral( + literal.value(db).starts_with(prefix.value(db)), + )); + } + } + + Type::DataclassTransformer(params) => { + if let [Some(Type::FunctionLiteral(function))] = overload.parameter_types() + { + overload.set_return_type(Type::FunctionLiteral( + function.with_dataclass_transformer_params(db, params), + )); + } + } + + Type::BoundMethod(bound_method) + if bound_method.self_instance(db).is_property_instance() => + { + match bound_method.function(db).name(db).as_str() { + "setter" => { + if let [Some(_), Some(setter)] = overload.parameter_types() { + let mut ty_property = bound_method.self_instance(db); + if let Type::PropertyInstance(property) = ty_property { + ty_property = + Type::PropertyInstance(PropertyInstanceType::new( + db, + property.getter(db), + Some(*setter), + )); + } + overload.set_return_type(ty_property); + } + } + "getter" => { + if let [Some(_), Some(getter)] = overload.parameter_types() { + let mut ty_property = bound_method.self_instance(db); + if let Type::PropertyInstance(property) = ty_property { + ty_property = + Type::PropertyInstance(PropertyInstanceType::new( + db, + Some(*getter), + property.setter(db), + )); + } + overload.set_return_type(ty_property); + } + } + "deleter" => { + // TODO: we do not store deleters yet + let ty_property = bound_method.self_instance(db); + overload.set_return_type(ty_property); + } + _ => { + // Fall back to typeshed stubs for all other methods + } + } + } + + Type::FunctionLiteral(function_type) => match function_type.known(db) { + Some(KnownFunction::IsEquivalentTo) => { + if let [Some(ty_a), Some(ty_b)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty_a.is_equivalent_to(db, *ty_b), + )); + } + } + + Some(KnownFunction::IsSubtypeOf) => { + if let [Some(ty_a), Some(ty_b)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty_a.is_subtype_of(db, *ty_b), + )); + } + } + + Some(KnownFunction::IsAssignableTo) => { + if let [Some(ty_a), Some(ty_b)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty_a.is_assignable_to(db, *ty_b), + )); + } + } + + Some(KnownFunction::IsDisjointFrom) => { + if let [Some(ty_a), Some(ty_b)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty_a.is_disjoint_from(db, *ty_b), + )); + } + } + + Some(KnownFunction::IsGradualEquivalentTo) => { + if let [Some(ty_a), Some(ty_b)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty_a.is_gradual_equivalent_to(db, *ty_b), + )); + } + } + + Some(KnownFunction::IsFullyStatic) => { + if let [Some(ty)] = overload.parameter_types() { + overload + .set_return_type(Type::BooleanLiteral(ty.is_fully_static(db))); + } + } + + Some(KnownFunction::IsSingleton) => { + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral(ty.is_singleton(db))); + } + } + + Some(KnownFunction::IsSingleValued) => { + if let [Some(ty)] = overload.parameter_types() { + overload + .set_return_type(Type::BooleanLiteral(ty.is_single_valued(db))); + } + } + + Some(KnownFunction::GenericContext) => { + if let [Some(ty)] = overload.parameter_types() { + // TODO: Handle generic functions, and unions/intersections of + // generic types + overload.set_return_type(match ty { + Type::ClassLiteral(class) => match class.generic_context(db) { + Some(generic_context) => TupleType::from_elements( + db, + generic_context + .variables(db) + .iter() + .map(|typevar| Type::TypeVar(*typevar)), + ), + None => Type::none(db), + }, + + _ => Type::none(db), + }); + } + } + + Some(KnownFunction::DunderAllNames) => { + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(match ty { + Type::ModuleLiteral(module_literal) => { + let all_names = module_literal + .module(db) + .file() + .map(|file| dunder_all_names(db, file)) + .unwrap_or_default(); + match all_names { + Some(names) => { + let mut names = names.iter().collect::<Vec<_>>(); + names.sort(); + TupleType::from_elements( + db, + names.iter().map(|name| { + Type::string_literal(db, name.as_str()) + }), + ) + } + None => Type::none(db), + } + } + _ => Type::none(db), + }); + } + } + + Some(KnownFunction::Len) => { + if let [Some(first_arg)] = overload.parameter_types() { + if let Some(len_ty) = first_arg.len(db) { + overload.set_return_type(len_ty); + } + } + } + + Some(KnownFunction::Repr) => { + if let [Some(first_arg)] = overload.parameter_types() { + overload.set_return_type(first_arg.repr(db)); + } + } + + Some(KnownFunction::Cast) => { + if let [Some(casted_ty), Some(_)] = overload.parameter_types() { + overload.set_return_type(*casted_ty); + } + } + + Some(KnownFunction::IsProtocol) => { + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(Type::BooleanLiteral( + ty.into_class_literal() + .is_some_and(|class| class.is_protocol(db)), + )); + } + } + + Some(KnownFunction::GetProtocolMembers) => { + if let [Some(Type::ClassLiteral(class))] = overload.parameter_types() { + if let Some(protocol_class) = class.into_protocol_class(db) { + // TODO: actually a frozenset at runtime (requires support for legacy generic classes) + overload.set_return_type(Type::Tuple(TupleType::new( + db, + protocol_class + .interface(db) + .members(db) + .map(|member| Type::string_literal(db, member.name())) + .collect::<Box<[Type<'db>]>>(), + ))); + } + } + } + + Some(KnownFunction::Overload) => { + // TODO: This can be removed once we understand legacy generics because the + // typeshed definition for `typing.overload` is an identity function. + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(*ty); + } + } + + Some(KnownFunction::Override) => { + // TODO: This can be removed once we understand legacy generics because the + // typeshed definition for `typing.overload` is an identity function. + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(*ty); + } + } + + Some(KnownFunction::AbstractMethod) => { + // TODO: This can be removed once we understand legacy generics because the + // typeshed definition for `abc.abstractmethod` is an identity function. + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(*ty); + } + } + + Some(KnownFunction::Final) => { + // TODO: This can be removed once we understand legacy generics because the + // typeshed definition for `abc.abstractmethod` is an identity function. + if let [Some(ty)] = overload.parameter_types() { + overload.set_return_type(*ty); + } + } + + Some(KnownFunction::GetattrStatic) => { + let [Some(instance_ty), Some(attr_name), default] = + overload.parameter_types() + else { + continue; + }; + + let Some(attr_name) = attr_name.into_string_literal() else { + continue; + }; + + let default = if let Some(default) = default { + *default + } else { + Type::Never + }; + + let union_with_default = + |ty| UnionType::from_elements(db, [ty, default]); + + // TODO: we could emit a diagnostic here (if default is not set) + overload.set_return_type( + match instance_ty.static_member(db, attr_name.value(db)) { + Symbol::Type(ty, Boundness::Bound) => { + if instance_ty.is_fully_static(db) { + ty + } else { + // Here, we attempt to model the fact that an attribute lookup on + // a non-fully static type could fail. This is an approximation, + // as there are gradual types like `tuple[Any]`, on which a lookup + // of (e.g. of the `index` method) would always succeed. + + union_with_default(ty) + } + } + Symbol::Type(ty, Boundness::PossiblyUnbound) => { + union_with_default(ty) + } + Symbol::Unbound => default, + }, + ); + } + + Some(KnownFunction::Dataclass) => { + if let [ + init, + repr, + eq, + order, + unsafe_hash, + frozen, + match_args, + kw_only, + slots, + weakref_slot, + ] = overload.parameter_types() + { + let mut params = DataclassParams::empty(); + + if to_bool(init, true) { + params |= DataclassParams::INIT; + } + if to_bool(repr, true) { + params |= DataclassParams::REPR; + } + if to_bool(eq, true) { + params |= DataclassParams::EQ; + } + if to_bool(order, false) { + params |= DataclassParams::ORDER; + } + if to_bool(unsafe_hash, false) { + params |= DataclassParams::UNSAFE_HASH; + } + if to_bool(frozen, false) { + params |= DataclassParams::FROZEN; + } + if to_bool(match_args, true) { + params |= DataclassParams::MATCH_ARGS; + } + if to_bool(kw_only, false) { + params |= DataclassParams::KW_ONLY; + } + if to_bool(slots, false) { + params |= DataclassParams::SLOTS; + } + if to_bool(weakref_slot, false) { + params |= DataclassParams::WEAKREF_SLOT; + } + + overload.set_return_type(Type::DataclassDecorator(params)); + } + } + + Some(KnownFunction::DataclassTransform) => { + if let [ + eq_default, + order_default, + kw_only_default, + frozen_default, + _field_specifiers, + _kwargs, + ] = overload.parameter_types() + { + let mut params = DataclassTransformerParams::empty(); + + if to_bool(eq_default, true) { + params |= DataclassTransformerParams::EQ_DEFAULT; + } + if to_bool(order_default, false) { + params |= DataclassTransformerParams::ORDER_DEFAULT; + } + if to_bool(kw_only_default, false) { + params |= DataclassTransformerParams::KW_ONLY_DEFAULT; + } + if to_bool(frozen_default, false) { + params |= DataclassTransformerParams::FROZEN_DEFAULT; + } + + overload.set_return_type(Type::DataclassTransformer(params)); + } + } + + _ => { + let mut handle_dataclass_transformer_params = + |function_type: &FunctionType| { + if let Some(params) = + function_type.dataclass_transformer_params(db) + { + // This is a call to a custom function that was decorated with `@dataclass_transformer`. + // If this function was called with a keyword argument like `order=False`, we extract + // the argument type and overwrite the corresponding flag in `dataclass_params` after + // constructing them from the `dataclass_transformer`-parameter defaults. + + let mut dataclass_params = DataclassParams::from(params); + + if let Some(Some(Type::BooleanLiteral(order))) = + callable_signature.iter().nth(overload_index).and_then( + |signature| { + let (idx, _) = signature + .parameters() + .keyword_by_name("order")?; + overload.parameter_types().get(idx) + }, + ) + { + dataclass_params.set(DataclassParams::ORDER, *order); + } + + overload.set_return_type(Type::DataclassDecorator( + dataclass_params, + )); + } + }; + + // Ideally, either the implementation, or exactly one of the overloads + // of the function can have the dataclass_transform decorator applied. + // However, we do not yet enforce this, and in the case of multiple + // applications of the decorator, we will only consider the last one + // for the return value, since the prior ones will be over-written. + if let Some(overloaded) = function_type.to_overloaded(db) { + overloaded + .overloads + .iter() + .for_each(&mut handle_dataclass_transformer_params); + } + + handle_dataclass_transformer_params(&function_type); + } + }, + + Type::ClassLiteral(class) => match class.known(db) { + Some(KnownClass::Bool) => match overload.parameter_types() { + [Some(arg)] => overload.set_return_type(arg.bool(db).into_type(db)), + [None] => overload.set_return_type(Type::BooleanLiteral(false)), + _ => {} + }, + + Some(KnownClass::Str) if overload_index == 0 => { + match overload.parameter_types() { + [Some(arg)] => overload.set_return_type(arg.str(db)), + [None] => overload.set_return_type(Type::string_literal(db, "")), + _ => {} + } + } + + Some(KnownClass::Type) if overload_index == 0 => { + if let [Some(arg)] = overload.parameter_types() { + overload.set_return_type(arg.to_meta_type(db)); + } + } + + Some(KnownClass::Property) => { + if let [getter, setter, ..] = overload.parameter_types() { + overload.set_return_type(Type::PropertyInstance( + PropertyInstanceType::new(db, *getter, *setter), + )); + } + } + + _ => {} + }, + + Type::KnownInstance(KnownInstanceType::TypedDict) => { + overload.set_return_type(todo_type!("TypedDict")); + } + + // Not a special case + _ => {} + } + } + } + } +} + +impl<'a, 'db> IntoIterator for &'a Bindings<'db> { + type Item = &'a CallableBinding<'db>; + type IntoIter = std::slice::Iter<'a, CallableBinding<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.elements.iter() + } +} + +impl<'a, 'db> IntoIterator for &'a mut Bindings<'db> { + type Item = &'a mut CallableBinding<'db>; + type IntoIter = std::slice::IterMut<'a, CallableBinding<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.elements.iter_mut() + } +} + +/// Binding information for a single callable. If the callable is overloaded, there is a separate +/// [`Binding`] for each overload. +/// +/// For a successful binding, each argument is mapped to one of the callable's formal parameters. +/// If the callable has multiple overloads, the first one that matches is used as the overall +/// binding match. +/// +/// TODO: Implement the call site evaluation algorithm in the [proposed updated typing +/// spec][overloads], which is much more subtle than “first match wins”. +/// +/// If the arguments cannot be matched to formal parameters, we store information about the +/// specific errors that occurred when trying to match them up. If the callable has multiple +/// overloads, we store this error information for each overload. +/// +/// [overloads]: https://github.com/python/typing/pull/1839 +#[derive(Debug)] +pub(crate) struct CallableBinding<'db> { + pub(crate) callable_type: Type<'db>, + pub(crate) signature_type: Type<'db>, + pub(crate) dunder_call_is_possibly_unbound: bool, + + /// The bindings of each overload of this callable. Will be empty if the type is not callable. + /// + /// By using `SmallVec`, we avoid an extra heap allocation for the common case of a + /// non-overloaded callable. + overloads: SmallVec<[Binding<'db>; 1]>, +} + +impl<'db> CallableBinding<'db> { + fn match_parameters( + signature: &CallableSignature<'db>, + arguments: &CallArguments<'_>, + argument_forms: &mut [Option<ParameterForm>], + conflicting_forms: &mut [bool], + ) -> Self { + // If this callable is a bound method, prepend the self instance onto the arguments list + // before checking. + let arguments = arguments.with_self(signature.bound_type); + + // TODO: This checks every overload. In the proposed more detailed call checking spec [1], + // arguments are checked for arity first, and are only checked for type assignability against + // the matching overloads. Make sure to implement that as part of separating call binding into + // two phases. + // + // [1] https://typing.python.org/en/latest/spec/overload.html#overload-call-evaluation + let overloads = signature + .into_iter() + .map(|signature| { + Binding::match_parameters( + signature, + arguments.as_ref(), + argument_forms, + conflicting_forms, + ) + }) + .collect(); + + CallableBinding { + callable_type: signature.callable_type, + signature_type: signature.signature_type, + dunder_call_is_possibly_unbound: signature.dunder_call_is_possibly_unbound, + overloads, + } + } + + fn check_types( + &mut self, + db: &'db dyn Db, + signature: &CallableSignature<'db>, + argument_types: &CallArgumentTypes<'_, 'db>, + ) { + // If this callable is a bound method, prepend the self instance onto the arguments list + // before checking. + let argument_types = argument_types.with_self(signature.bound_type); + for (signature, overload) in signature.iter().zip(&mut self.overloads) { + overload.check_types(db, signature, argument_types.as_ref()); + } + } + + fn as_result(&self) -> Result<(), CallErrorKind> { + if !self.is_callable() { + return Err(CallErrorKind::NotCallable); + } + + if self.has_binding_errors() { + return Err(CallErrorKind::BindingError); + } + + if self.dunder_call_is_possibly_unbound { + return Err(CallErrorKind::PossiblyNotCallable); + } + + Ok(()) + } + + fn is_callable(&self) -> bool { + !self.overloads.is_empty() + } + + /// Returns whether there were any errors binding this call site. If the callable has multiple + /// overloads, they must _all_ have errors. + pub(crate) fn has_binding_errors(&self) -> bool { + self.matching_overloads().next().is_none() + } + + /// Returns an iterator over all the overloads that matched for this call binding. + pub(crate) fn matching_overloads(&self) -> impl Iterator<Item = (usize, &Binding<'db>)> { + self.overloads + .iter() + .enumerate() + .filter(|(_, overload)| overload.as_result().is_ok()) + } + + /// Returns an iterator over all the mutable overloads that matched for this call binding. + pub(crate) fn matching_overloads_mut( + &mut self, + ) -> impl Iterator<Item = (usize, &mut Binding<'db>)> { + self.overloads + .iter_mut() + .enumerate() + .filter(|(_, overload)| overload.as_result().is_ok()) + } + + /// Returns the return type of this call. For a valid call, this is the return type of the + /// first overload that the arguments matched against. For an invalid call to a non-overloaded + /// function, this is the return type of the function. For an invalid call to an overloaded + /// function, we return `Type::unknown`, since we cannot make any useful conclusions about + /// which overload was intended to be called. + pub(crate) fn return_type(&self) -> Type<'db> { + // TODO: Implement the overload call evaluation algorithm as mentioned in the spec [1] to + // get the matching overload and use that to get the return type. + // + // [1]: https://typing.python.org/en/latest/spec/overload.html#overload-call-evaluation + if let Some((_, first_overload)) = self.matching_overloads().next() { + return first_overload.return_type(); + } + if let [overload] = self.overloads.as_slice() { + return overload.return_type(); + } + Type::unknown() + } + + fn report_diagnostics( + &self, + context: &InferContext<'db>, + node: ast::AnyNodeRef, + union_diag: Option<&UnionDiagnostic<'_, '_>>, + ) { + if !self.is_callable() { + if let Some(builder) = context.report_lint(&CALL_NON_CALLABLE, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Object of type `{}` is not callable", + self.callable_type.display(context.db()), + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + return; + } + + if self.dunder_call_is_possibly_unbound { + if let Some(builder) = context.report_lint(&CALL_NON_CALLABLE, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Object of type `{}` is not callable (possibly unbound `__call__` method)", + self.callable_type.display(context.db()), + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + return; + } + + match self.overloads.as_slice() { + [] => {} + [overload] => { + let callable_description = + CallableDescription::new(context.db(), self.signature_type); + overload.report_diagnostics( + context, + node, + self.signature_type, + callable_description.as_ref(), + union_diag, + ); + } + _overloads => { + // When the number of unmatched overloads exceeds this number, we stop + // printing them to avoid excessive output. + // + // An example of a routine with many many overloads: + // https://github.com/henribru/google-api-python-client-stubs/blob/master/googleapiclient-stubs/discovery.pyi + const MAXIMUM_OVERLOADS: usize = 50; + + let Some(builder) = context.report_lint(&NO_MATCHING_OVERLOAD, node) else { + return; + }; + let callable_description = + CallableDescription::new(context.db(), self.callable_type); + let mut diag = builder.into_diagnostic(format_args!( + "No overload{} matches arguments", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" of {kind} `{name}`") + } else { + String::new() + } + )); + // TODO: This should probably be adapted to handle more + // types of callables[1]. At present, it just handles + // standard function and method calls. + // + // [1]: https://github.com/astral-sh/ty/issues/274#issuecomment-2881856028 + let function_type_and_kind = match self.signature_type { + Type::FunctionLiteral(function) => Some(("function", function)), + Type::BoundMethod(bound_method) => { + Some(("bound method", bound_method.function(context.db()))) + } + _ => None, + }; + if let Some((kind, function)) = function_type_and_kind { + if let Some(overloaded_function) = function.to_overloaded(context.db()) { + if let Some(spans) = overloaded_function + .overloads + .first() + .and_then(|overload| overload.spans(context.db())) + { + let mut sub = + SubDiagnostic::new(Severity::Info, "First overload defined here"); + sub.annotate(Annotation::primary(spans.signature)); + diag.sub(sub); + } + + diag.info(format_args!( + "Possible overloads for {kind} `{}`:", + function.name(context.db()) + )); + + let overloads = &function.signature(context.db()).overloads.overloads; + for overload in overloads.iter().take(MAXIMUM_OVERLOADS) { + diag.info(format_args!(" {}", overload.display(context.db()))); + } + if overloads.len() > MAXIMUM_OVERLOADS { + diag.info(format_args!( + "... omitted {remaining} overloads", + remaining = overloads.len() - MAXIMUM_OVERLOADS + )); + } + + if let Some(spans) = overloaded_function + .implementation + .and_then(|function| function.spans(context.db())) + { + let mut sub = SubDiagnostic::new( + Severity::Info, + "Overload implementation defined here", + ); + sub.annotate(Annotation::primary(spans.signature)); + diag.sub(sub); + } + } + } + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + } +} + +/// Binding information for one of the overloads of a callable. +#[derive(Debug)] +pub(crate) struct Binding<'db> { + /// Return type of the call. + return_ty: Type<'db>, + + /// The specialization that was inferred from the argument types, if the callable is generic. + specialization: Option<Specialization<'db>>, + + /// The specialization that was inferred for a class method's containing generic class, if it + /// is being used to infer a specialization for the class. + inherited_specialization: Option<Specialization<'db>>, + + /// The formal parameter that each argument is matched with, in argument source order, or + /// `None` if the argument was not matched to any parameter. + argument_parameters: Box<[Option<usize>]>, + + /// Bound types for parameters, in parameter source order, or `None` if no argument was matched + /// to that parameter. + parameter_tys: Box<[Option<Type<'db>>]>, + + /// Call binding errors, if any. + errors: Vec<BindingError<'db>>, +} + +impl<'db> Binding<'db> { + fn match_parameters( + signature: &Signature<'db>, + arguments: &CallArguments<'_>, + argument_forms: &mut [Option<ParameterForm>], + conflicting_forms: &mut [bool], + ) -> Self { + let parameters = signature.parameters(); + // The parameter that each argument is matched with. + let mut argument_parameters = vec![None; arguments.len()]; + // Whether each parameter has been matched with an argument. + let mut parameter_matched = vec![false; parameters.len()]; + let mut errors = vec![]; + let mut next_positional = 0; + let mut first_excess_positional = None; + let mut num_synthetic_args = 0; + let get_argument_index = |argument_index: usize, num_synthetic_args: usize| { + if argument_index >= num_synthetic_args { + // Adjust the argument index to skip synthetic args, which don't appear at the call + // site and thus won't be in the Call node arguments list. + Some(argument_index - num_synthetic_args) + } else { + // we are erroring on a synthetic argument, we'll just emit the diagnostic on the + // entire Call node, since there's no argument node for this argument at the call site + None + } + }; + for (argument_index, argument) in arguments.iter().enumerate() { + let (index, parameter, positional) = match argument { + Argument::Positional | Argument::Synthetic => { + if matches!(argument, Argument::Synthetic) { + num_synthetic_args += 1; + } + let Some((index, parameter)) = parameters + .get_positional(next_positional) + .map(|param| (next_positional, param)) + .or_else(|| parameters.variadic()) + else { + first_excess_positional.get_or_insert(argument_index); + next_positional += 1; + continue; + }; + next_positional += 1; + (index, parameter, !parameter.is_variadic()) + } + Argument::Keyword(name) => { + let Some((index, parameter)) = parameters + .keyword_by_name(name) + .or_else(|| parameters.keyword_variadic()) + else { + errors.push(BindingError::UnknownArgument { + argument_name: ast::name::Name::new(name), + argument_index: get_argument_index(argument_index, num_synthetic_args), + }); + continue; + }; + (index, parameter, false) + } + + Argument::Variadic | Argument::Keywords => { + // TODO + continue; + } + }; + if !matches!(argument, Argument::Synthetic) { + if let Some(existing) = + argument_forms[argument_index - num_synthetic_args].replace(parameter.form) + { + if existing != parameter.form { + conflicting_forms[argument_index - num_synthetic_args] = true; + } + } + } + if parameter_matched[index] { + if !parameter.is_variadic() && !parameter.is_keyword_variadic() { + errors.push(BindingError::ParameterAlreadyAssigned { + argument_index: get_argument_index(argument_index, num_synthetic_args), + parameter: ParameterContext::new(parameter, index, positional), + }); + } + } + argument_parameters[argument_index] = Some(index); + parameter_matched[index] = true; + } + if let Some(first_excess_argument_index) = first_excess_positional { + errors.push(BindingError::TooManyPositionalArguments { + first_excess_argument_index: get_argument_index( + first_excess_argument_index, + num_synthetic_args, + ), + expected_positional_count: parameters.positional().count(), + provided_positional_count: next_positional, + }); + } + let mut missing = vec![]; + for (index, matched) in parameter_matched.iter().copied().enumerate() { + if !matched { + let param = ¶meters[index]; + if param.is_variadic() + || param.is_keyword_variadic() + || param.default_type().is_some() + { + // variadic/keywords and defaulted arguments are not required + continue; + } + missing.push(ParameterContext::new(param, index, false)); + } + } + + if !missing.is_empty() { + errors.push(BindingError::MissingArguments { + parameters: ParameterContexts(missing), + }); + } + + Self { + return_ty: signature.return_ty.unwrap_or(Type::unknown()), + specialization: None, + inherited_specialization: None, + argument_parameters: argument_parameters.into_boxed_slice(), + parameter_tys: vec![None; parameters.len()].into_boxed_slice(), + errors, + } + } + + fn check_types( + &mut self, + db: &'db dyn Db, + signature: &Signature<'db>, + argument_types: &CallArgumentTypes<'_, 'db>, + ) { + let mut num_synthetic_args = 0; + let get_argument_index = |argument_index: usize, num_synthetic_args: usize| { + if argument_index >= num_synthetic_args { + // Adjust the argument index to skip synthetic args, which don't appear at the call + // site and thus won't be in the Call node arguments list. + Some(argument_index - num_synthetic_args) + } else { + // we are erroring on a synthetic argument, we'll just emit the diagnostic on the + // entire Call node, since there's no argument node for this argument at the call site + None + } + }; + + // If this overload is generic, first see if we can infer a specialization of the function + // from the arguments that were passed in. + let parameters = signature.parameters(); + if signature.generic_context.is_some() || signature.inherited_generic_context.is_some() { + let mut builder = SpecializationBuilder::new(db); + for (argument_index, (argument, argument_type)) in argument_types.iter().enumerate() { + if matches!(argument, Argument::Synthetic) { + num_synthetic_args += 1; + } + let Some(parameter_index) = self.argument_parameters[argument_index] else { + // There was an error with argument when matching parameters, so don't bother + // type-checking it. + continue; + }; + let parameter = ¶meters[parameter_index]; + let Some(expected_type) = parameter.annotated_type() else { + continue; + }; + if let Err(error) = builder.infer(expected_type, argument_type) { + self.errors.push(BindingError::SpecializationError { + error, + argument_index: get_argument_index(argument_index, num_synthetic_args), + }); + } + } + self.specialization = signature.generic_context.map(|gc| builder.build(gc)); + self.inherited_specialization = signature.inherited_generic_context.map(|gc| { + // The inherited generic context is used when inferring the specialization of a + // generic class from a constructor call. In this case (only), we promote any + // typevars that are inferred as a literal to the corresponding instance type. + builder + .build(gc) + .apply_type_mapping(db, &TypeMapping::PromoteLiterals) + }); + } + + num_synthetic_args = 0; + for (argument_index, (argument, mut argument_type)) in argument_types.iter().enumerate() { + if matches!(argument, Argument::Synthetic) { + num_synthetic_args += 1; + } + let Some(parameter_index) = self.argument_parameters[argument_index] else { + // There was an error with argument when matching parameters, so don't bother + // type-checking it. + continue; + }; + let parameter = ¶meters[parameter_index]; + if let Some(mut expected_ty) = parameter.annotated_type() { + if let Some(specialization) = self.specialization { + argument_type = argument_type.apply_specialization(db, specialization); + expected_ty = expected_ty.apply_specialization(db, specialization); + } + if let Some(inherited_specialization) = self.inherited_specialization { + argument_type = + argument_type.apply_specialization(db, inherited_specialization); + expected_ty = expected_ty.apply_specialization(db, inherited_specialization); + } + if !argument_type.is_assignable_to(db, expected_ty) { + let positional = matches!(argument, Argument::Positional | Argument::Synthetic) + && !parameter.is_variadic(); + self.errors.push(BindingError::InvalidArgumentType { + parameter: ParameterContext::new(parameter, parameter_index, positional), + argument_index: get_argument_index(argument_index, num_synthetic_args), + expected_ty, + provided_ty: argument_type, + }); + } + } + // We still update the actual type of the parameter in this binding to match the + // argument, even if the argument type is not assignable to the expected parameter + // type. + if let Some(existing) = self.parameter_tys[parameter_index].replace(argument_type) { + // We already verified in `match_parameters` that we only match multiple arguments + // with variadic parameters. + let union = UnionType::from_elements(db, [existing, argument_type]); + self.parameter_tys[parameter_index] = Some(union); + } + } + + if let Some(specialization) = self.specialization { + self.return_ty = self.return_ty.apply_specialization(db, specialization); + } + if let Some(inherited_specialization) = self.inherited_specialization { + self.return_ty = self + .return_ty + .apply_specialization(db, inherited_specialization); + } + } + + pub(crate) fn set_return_type(&mut self, return_ty: Type<'db>) { + self.return_ty = return_ty; + } + + pub(crate) fn return_type(&self) -> Type<'db> { + self.return_ty + } + + pub(crate) fn inherited_specialization(&self) -> Option<Specialization<'db>> { + self.inherited_specialization + } + + /// Returns the bound types for each parameter, in parameter source order, or `None` if no + /// argument was matched to that parameter. + pub(crate) fn parameter_types(&self) -> &[Option<Type<'db>>] { + &self.parameter_tys + } + + pub(crate) fn arguments_for_parameter<'a>( + &'a self, + argument_types: &'a CallArgumentTypes<'a, 'db>, + parameter_index: usize, + ) -> impl Iterator<Item = (Argument<'a>, Type<'db>)> + 'a { + argument_types + .iter() + .zip(&self.argument_parameters) + .filter(move |(_, argument_parameter)| { + argument_parameter.is_some_and(|ap| ap == parameter_index) + }) + .map(|(arg_and_type, _)| arg_and_type) + } + + fn report_diagnostics( + &self, + context: &InferContext<'db>, + node: ast::AnyNodeRef, + callable_ty: Type<'db>, + callable_description: Option<&CallableDescription>, + union_diag: Option<&UnionDiagnostic<'_, '_>>, + ) { + for error in &self.errors { + error.report_diagnostic(context, node, callable_ty, callable_description, union_diag); + } + } + + fn as_result(&self) -> Result<(), CallErrorKind> { + if !self.errors.is_empty() { + return Err(CallErrorKind::BindingError); + } + Ok(()) + } +} + +/// Describes a callable for the purposes of diagnostics. +#[derive(Debug)] +pub(crate) struct CallableDescription<'a> { + name: &'a str, + kind: &'a str, +} + +impl<'db> CallableDescription<'db> { + fn new(db: &'db dyn Db, callable_type: Type<'db>) -> Option<CallableDescription<'db>> { + match callable_type { + Type::FunctionLiteral(function) => Some(CallableDescription { + kind: "function", + name: function.name(db), + }), + Type::ClassLiteral(class_type) => Some(CallableDescription { + kind: "class", + name: class_type.name(db), + }), + Type::BoundMethod(bound_method) => Some(CallableDescription { + kind: "bound method", + name: bound_method.function(db).name(db), + }), + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet(function)) => { + Some(CallableDescription { + kind: "method wrapper `__get__` of function", + name: function.name(db), + }) + } + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet(_)) => { + Some(CallableDescription { + kind: "method wrapper", + name: "`__get__` of property", + }) + } + Type::WrapperDescriptor(kind) => Some(CallableDescription { + kind: "wrapper descriptor", + name: match kind { + WrapperDescriptorKind::FunctionTypeDunderGet => "FunctionType.__get__", + WrapperDescriptorKind::PropertyDunderGet => "property.__get__", + WrapperDescriptorKind::PropertyDunderSet => "property.__set__", + }, + }), + _ => None, + } + } +} + +/// Information needed to emit a diagnostic regarding a parameter. +#[derive(Clone, Debug, PartialEq, Eq)] +pub(crate) struct ParameterContext { + name: Option<ast::name::Name>, + index: usize, + + /// Was the argument for this parameter passed positionally, and matched to a non-variadic + /// positional parameter? (If so, we will provide the index in the diagnostic, not just the + /// name.) + positional: bool, +} + +impl ParameterContext { + fn new(parameter: &Parameter, index: usize, positional: bool) -> Self { + Self { + name: parameter.display_name(), + index, + positional, + } + } +} + +impl std::fmt::Display for ParameterContext { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + if let Some(name) = &self.name { + if self.positional { + write!(f, "{} (`{name}`)", self.index + 1) + } else { + write!(f, "`{name}`") + } + } else { + write!(f, "{}", self.index + 1) + } + } +} + +#[derive(Clone, Debug, PartialEq, Eq)] +pub(crate) struct ParameterContexts(Vec<ParameterContext>); + +impl std::fmt::Display for ParameterContexts { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let mut iter = self.0.iter(); + if let Some(first) = iter.next() { + write!(f, "{first}")?; + for param in iter { + f.write_str(", ")?; + write!(f, "{param}")?; + } + } + Ok(()) + } +} + +#[derive(Clone, Debug, PartialEq, Eq)] +pub(crate) enum BindingError<'db> { + /// The type of an argument is not assignable to the annotated type of its corresponding + /// parameter. + InvalidArgumentType { + parameter: ParameterContext, + argument_index: Option<usize>, + expected_ty: Type<'db>, + provided_ty: Type<'db>, + }, + /// One or more required parameters (that is, with no default) is not supplied by any argument. + MissingArguments { parameters: ParameterContexts }, + /// A call argument can't be matched to any parameter. + UnknownArgument { + argument_name: ast::name::Name, + argument_index: Option<usize>, + }, + /// More positional arguments are provided in the call than can be handled by the signature. + TooManyPositionalArguments { + first_excess_argument_index: Option<usize>, + expected_positional_count: usize, + provided_positional_count: usize, + }, + /// Multiple arguments were provided for a single parameter. + ParameterAlreadyAssigned { + argument_index: Option<usize>, + parameter: ParameterContext, + }, + /// An inferred specialization was invalid. + SpecializationError { + error: SpecializationError<'db>, + argument_index: Option<usize>, + }, + /// The call itself might be well constructed, but an error occurred while evaluating the call. + /// We use this variant to report errors in `property.__get__` and `property.__set__`, which + /// can occur when the call to the underlying getter/setter fails. + InternalCallError(&'static str), +} + +impl<'db> BindingError<'db> { + fn report_diagnostic( + &self, + context: &InferContext<'db>, + node: ast::AnyNodeRef, + callable_ty: Type<'db>, + callable_description: Option<&CallableDescription>, + union_diag: Option<&UnionDiagnostic<'_, '_>>, + ) { + match self { + Self::InvalidArgumentType { + parameter, + argument_index, + expected_ty, + provided_ty, + } => { + let range = Self::get_node(node, *argument_index); + let Some(builder) = context.report_lint(&INVALID_ARGUMENT_TYPE, range) else { + return; + }; + + let provided_ty_display = provided_ty.display(context.db()); + let expected_ty_display = expected_ty.display(context.db()); + + let mut diag = builder.into_diagnostic(format_args!( + "Argument{} is incorrect", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" to {kind} `{name}`") + } else { + String::new() + } + )); + diag.set_primary_message(format_args!( + "Expected `{expected_ty_display}`, found `{provided_ty_display}`" + )); + if let Some((name_span, parameter_span)) = + callable_ty.parameter_span(context.db(), Some(parameter.index)) + { + let mut sub = SubDiagnostic::new(Severity::Info, "Function defined here"); + sub.annotate(Annotation::primary(name_span)); + sub.annotate( + Annotation::secondary(parameter_span).message("Parameter declared here"), + ); + diag.sub(sub); + } + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + + Self::TooManyPositionalArguments { + first_excess_argument_index, + expected_positional_count, + provided_positional_count, + } => { + let node = Self::get_node(node, *first_excess_argument_index); + if let Some(builder) = context.report_lint(&TOO_MANY_POSITIONAL_ARGUMENTS, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Too many positional arguments{}: expected \ + {expected_positional_count}, got {provided_positional_count}", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" to {kind} `{name}`") + } else { + String::new() + } + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + + Self::MissingArguments { parameters } => { + if let Some(builder) = context.report_lint(&MISSING_ARGUMENT, node) { + let s = if parameters.0.len() == 1 { "" } else { "s" }; + let mut diag = builder.into_diagnostic(format_args!( + "No argument{s} provided for required parameter{s} {parameters}{}", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" of {kind} `{name}`") + } else { + String::new() + } + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + + Self::UnknownArgument { + argument_name, + argument_index, + } => { + let node = Self::get_node(node, *argument_index); + if let Some(builder) = context.report_lint(&UNKNOWN_ARGUMENT, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Argument `{argument_name}` does not match any known parameter{}", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" of {kind} `{name}`") + } else { + String::new() + } + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + + Self::ParameterAlreadyAssigned { + argument_index, + parameter, + } => { + let node = Self::get_node(node, *argument_index); + if let Some(builder) = context.report_lint(&PARAMETER_ALREADY_ASSIGNED, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Multiple values provided for parameter {parameter}{}", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" of {kind} `{name}`") + } else { + String::new() + } + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + + Self::SpecializationError { + error, + argument_index, + } => { + let range = Self::get_node(node, *argument_index); + let Some(builder) = context.report_lint(&INVALID_ARGUMENT_TYPE, range) else { + return; + }; + + let typevar = error.typevar(); + let argument_type = error.argument_type(); + let argument_ty_display = argument_type.display(context.db()); + + let mut diag = builder.into_diagnostic(format_args!( + "Argument{} is incorrect", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" to {kind} `{name}`") + } else { + String::new() + } + )); + diag.set_primary_message(format_args!( + "Argument type `{argument_ty_display}` does not satisfy {} of type variable `{}`", + match error { + SpecializationError::MismatchedBound {..} => "upper bound", + SpecializationError::MismatchedConstraint {..} => "constraints", + }, + typevar.name(context.db()), + )); + + if let Some(typevar_definition) = typevar.definition(context.db()) { + let typevar_range = typevar_definition.full_range(context.db()); + let mut sub = SubDiagnostic::new(Severity::Info, "Type variable defined here"); + sub.annotate(Annotation::primary(typevar_range.into())); + diag.sub(sub); + } + + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + + Self::InternalCallError(reason) => { + let node = Self::get_node(node, None); + if let Some(builder) = context.report_lint(&CALL_NON_CALLABLE, node) { + let mut diag = builder.into_diagnostic(format_args!( + "Call{} failed: {reason}", + if let Some(CallableDescription { kind, name }) = callable_description { + format!(" of {kind} `{name}`") + } else { + String::new() + } + )); + if let Some(union_diag) = union_diag { + union_diag.add_union_context(context.db(), &mut diag); + } + } + } + } + } + + fn get_node(node: ast::AnyNodeRef, argument_index: Option<usize>) -> ast::AnyNodeRef { + // If we have a Call node and an argument index, report the diagnostic on the correct + // argument node; otherwise, report it on the entire provided node. + match (node, argument_index) { + (ast::AnyNodeRef::ExprCall(call_node), Some(argument_index)) => { + match call_node + .arguments + .arguments_source_order() + .nth(argument_index) + .expect("argument index should not be out of range") + { + ast::ArgOrKeyword::Arg(expr) => expr.into(), + ast::ArgOrKeyword::Keyword(keyword) => keyword.into(), + } + } + _ => node, + } + } +} + +/// Contains additional context for union specific diagnostics. +/// +/// This is used when a function call is inconsistent with one or more variants +/// of a union. This can be used to attach sub-diagnostics that clarify that +/// the error is part of a union. +struct UnionDiagnostic<'b, 'db> { + /// The type of the union. + callable_type: Type<'db>, + /// The specific binding that failed. + binding: &'b CallableBinding<'db>, +} + +impl UnionDiagnostic<'_, '_> { + /// Adds context about any relevant union function types to the given + /// diagnostic. + fn add_union_context(&self, db: &'_ dyn Db, diag: &mut Diagnostic) { + let sub = SubDiagnostic::new( + Severity::Info, + format_args!( + "Union variant `{callable_ty}` is incompatible with this call site", + callable_ty = self.binding.callable_type.display(db), + ), + ); + diag.sub(sub); + + let sub = SubDiagnostic::new( + Severity::Info, + format_args!( + "Attempted to call union type `{}`", + self.callable_type.display(db) + ), + ); + diag.sub(sub); + } +} diff --git a/crates/ty_python_semantic/src/types/class.rs b/crates/ty_python_semantic/src/types/class.rs new file mode 100644 index 0000000000000..4278fe0defc9a --- /dev/null +++ b/crates/ty_python_semantic/src/types/class.rs @@ -0,0 +1,2961 @@ +use std::hash::BuildHasherDefault; +use std::sync::{LazyLock, Mutex}; + +use super::{ + IntersectionBuilder, KnownFunction, MemberLookupPolicy, Mro, MroError, MroIterator, + SubclassOfType, Truthiness, Type, TypeQualifiers, class_base::ClassBase, infer_expression_type, + infer_unpack_types, +}; +use crate::semantic_index::DeclarationWithConstraint; +use crate::semantic_index::definition::Definition; +use crate::types::generics::{GenericContext, Specialization}; +use crate::types::signatures::{Parameter, Parameters}; +use crate::types::{ + CallableType, DataclassParams, DataclassTransformerParams, KnownInstanceType, Signature, + TypeMapping, TypeVarInstance, +}; +use crate::{ + Db, FxOrderSet, KnownModule, Program, + module_resolver::file_to_module, + semantic_index::{ + ast_ids::HasScopedExpressionId, + attribute_assignments, + definition::{DefinitionKind, TargetKind}, + semantic_index, + symbol::ScopeId, + symbol_table, use_def_map, + }, + symbol::{ + Boundness, LookupError, LookupResult, Symbol, SymbolAndQualifiers, class_symbol, + known_module_symbol, symbol_from_bindings, symbol_from_declarations, + }, + types::{ + CallArgumentTypes, CallError, CallErrorKind, DynamicType, MetaclassCandidate, TupleType, + UnionBuilder, UnionType, definition_expression_type, + }, +}; +use indexmap::IndexSet; +use itertools::Itertools as _; +use ruff_db::diagnostic::Span; +use ruff_db::files::File; +use ruff_python_ast::name::Name; +use ruff_python_ast::{self as ast, PythonVersion}; +use ruff_text_size::{Ranged, TextRange}; +use rustc_hash::{FxHashSet, FxHasher}; + +type FxOrderMap<K, V> = ordermap::map::OrderMap<K, V, BuildHasherDefault<FxHasher>>; + +fn explicit_bases_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &[Type<'db>], + _count: u32, + _self: ClassLiteral<'db>, +) -> salsa::CycleRecoveryAction<Box<[Type<'db>]>> { + salsa::CycleRecoveryAction::Iterate +} + +fn explicit_bases_cycle_initial<'db>( + _db: &'db dyn Db, + _self: ClassLiteral<'db>, +) -> Box<[Type<'db>]> { + Box::default() +} + +#[expect(clippy::ref_option, clippy::trivially_copy_pass_by_ref)] +fn inheritance_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Option<InheritanceCycle>, + _count: u32, + _self: ClassLiteral<'db>, +) -> salsa::CycleRecoveryAction<Option<InheritanceCycle>> { + salsa::CycleRecoveryAction::Iterate +} + +fn inheritance_cycle_initial<'db>( + _db: &'db dyn Db, + _self: ClassLiteral<'db>, +) -> Option<InheritanceCycle> { + None +} + +fn try_mro_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Result<Mro<'db>, MroError<'db>>, + _count: u32, + _self: ClassLiteral<'db>, + _specialization: Option<Specialization<'db>>, +) -> salsa::CycleRecoveryAction<Result<Mro<'db>, MroError<'db>>> { + salsa::CycleRecoveryAction::Iterate +} + +fn try_mro_cycle_initial<'db>( + db: &'db dyn Db, + self_: ClassLiteral<'db>, + specialization: Option<Specialization<'db>>, +) -> Result<Mro<'db>, MroError<'db>> { + Err(MroError::cycle( + db, + self_.apply_optional_specialization(db, specialization), + )) +} + +fn try_metaclass_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Result<(Type<'db>, Option<DataclassTransformerParams>), MetaclassError<'db>>, + _count: u32, + _self: ClassLiteral<'db>, +) -> salsa::CycleRecoveryAction< + Result<(Type<'db>, Option<DataclassTransformerParams>), MetaclassError<'db>>, +> { + salsa::CycleRecoveryAction::Iterate +} + +#[allow(clippy::unnecessary_wraps)] +fn try_metaclass_cycle_initial<'db>( + _db: &'db dyn Db, + _self_: ClassLiteral<'db>, +) -> Result<(Type<'db>, Option<DataclassTransformerParams>), MetaclassError<'db>> { + Err(MetaclassError { + kind: MetaclassErrorKind::Cycle, + }) +} + +/// A category of classes with code generation capabilities (with synthesized methods). +#[derive(Clone, Copy, Debug, PartialEq)] +enum CodeGeneratorKind { + /// Classes decorated with `@dataclass` or similar dataclass-like decorators + DataclassLike, + /// Classes inheriting from `typing.NamedTuple` + NamedTuple, +} + +impl CodeGeneratorKind { + fn from_class(db: &dyn Db, class: ClassLiteral<'_>) -> Option<Self> { + if CodeGeneratorKind::DataclassLike.matches(db, class) { + Some(CodeGeneratorKind::DataclassLike) + } else if CodeGeneratorKind::NamedTuple.matches(db, class) { + Some(CodeGeneratorKind::NamedTuple) + } else { + None + } + } + + fn matches<'db>(self, db: &'db dyn Db, class: ClassLiteral<'db>) -> bool { + match self { + Self::DataclassLike => { + class.dataclass_params(db).is_some() + || class + .try_metaclass(db) + .is_ok_and(|(_, transformer_params)| transformer_params.is_some()) + } + Self::NamedTuple => class.explicit_bases(db).iter().any(|base| { + base.into_class_literal() + .is_some_and(|c| c.is_known(db, KnownClass::NamedTuple)) + }), + } + } +} + +/// A specialization of a generic class with a particular assignment of types to typevars. +/// +/// # Ordering +/// Ordering is based on the generic aliases's salsa-assigned id and not on its values. +/// The id may change between runs, or when the alias was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct GenericAlias<'db> { + pub(crate) origin: ClassLiteral<'db>, + pub(crate) specialization: Specialization<'db>, +} + +impl<'db> GenericAlias<'db> { + pub(super) fn normalized(self, db: &'db dyn Db) -> Self { + Self::new(db, self.origin(db), self.specialization(db).normalized(db)) + } + + pub(crate) fn definition(self, db: &'db dyn Db) -> Definition<'db> { + self.origin(db).definition(db) + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + Self::new( + db, + self.origin(db), + self.specialization(db).apply_type_mapping(db, type_mapping), + ) + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + self.specialization(db).find_legacy_typevars(db, typevars); + } +} + +impl<'db> From<GenericAlias<'db>> for Type<'db> { + fn from(alias: GenericAlias<'db>) -> Type<'db> { + Type::GenericAlias(alias) + } +} + +/// Represents a class type, which might be a non-generic class, or a specialization of a generic +/// class. +#[derive( + Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, salsa::Supertype, salsa::Update, +)] +pub enum ClassType<'db> { + NonGeneric(ClassLiteral<'db>), + Generic(GenericAlias<'db>), +} + +#[salsa::tracked] +impl<'db> ClassType<'db> { + pub(super) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Self::NonGeneric(_) => self, + Self::Generic(generic) => Self::Generic(generic.normalized(db)), + } + } + + /// Returns the class literal and specialization for this class. For a non-generic class, this + /// is the class itself. For a generic alias, this is the alias's origin. + pub(crate) fn class_literal( + self, + db: &'db dyn Db, + ) -> (ClassLiteral<'db>, Option<Specialization<'db>>) { + match self { + Self::NonGeneric(non_generic) => (non_generic, None), + Self::Generic(generic) => (generic.origin(db), Some(generic.specialization(db))), + } + } + + /// Returns the class literal and specialization for this class, with an additional + /// specialization applied if the class is generic. + pub(crate) fn class_literal_specialized( + self, + db: &'db dyn Db, + additional_specialization: Option<Specialization<'db>>, + ) -> (ClassLiteral<'db>, Option<Specialization<'db>>) { + match self { + Self::NonGeneric(non_generic) => (non_generic, None), + Self::Generic(generic) => ( + generic.origin(db), + Some( + generic + .specialization(db) + .apply_optional_specialization(db, additional_specialization), + ), + ), + } + } + + pub(crate) fn name(self, db: &'db dyn Db) -> &'db ast::name::Name { + let (class_literal, _) = self.class_literal(db); + class_literal.name(db) + } + + pub(crate) fn known(self, db: &'db dyn Db) -> Option<KnownClass> { + let (class_literal, _) = self.class_literal(db); + class_literal.known(db) + } + + pub(crate) fn definition(self, db: &'db dyn Db) -> Definition<'db> { + let (class_literal, _) = self.class_literal(db); + class_literal.definition(db) + } + + /// Return `true` if this class represents `known_class` + pub(crate) fn is_known(self, db: &'db dyn Db, known_class: KnownClass) -> bool { + self.known(db) == Some(known_class) + } + + /// Return `true` if this class represents the builtin class `object` + pub(crate) fn is_object(self, db: &'db dyn Db) -> bool { + self.is_known(db, KnownClass::Object) + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + match self { + Self::NonGeneric(_) => self, + Self::Generic(generic) => Self::Generic(generic.apply_type_mapping(db, type_mapping)), + } + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + match self { + Self::NonGeneric(_) => {} + Self::Generic(generic) => generic.find_legacy_typevars(db, typevars), + } + } + + /// Iterate over the [method resolution order] ("MRO") of the class. + /// + /// If the MRO could not be accurately resolved, this method falls back to iterating + /// over an MRO that has the class directly inheriting from `Unknown`. Use + /// [`ClassLiteral::try_mro`] if you need to distinguish between the success and failure + /// cases rather than simply iterating over the inferred resolution order for the class. + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + pub(super) fn iter_mro(self, db: &'db dyn Db) -> MroIterator<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal.iter_mro(db, specialization) + } + + /// Iterate over the method resolution order ("MRO") of the class, optionally applying an + /// additional specialization to it if the class is generic. + pub(super) fn iter_mro_specialized( + self, + db: &'db dyn Db, + additional_specialization: Option<Specialization<'db>>, + ) -> MroIterator<'db> { + let (class_literal, specialization) = + self.class_literal_specialized(db, additional_specialization); + class_literal.iter_mro(db, specialization) + } + + /// Is this class final? + pub(super) fn is_final(self, db: &'db dyn Db) -> bool { + let (class_literal, _) = self.class_literal(db); + class_literal.is_final(db) + } + + /// Is this class a subclass of `Any` or `Unknown`? + pub(crate) fn is_subclass_of_any_or_unknown(self, db: &'db dyn Db) -> bool { + self.iter_mro(db).any(|base| { + matches!( + base, + ClassBase::Dynamic(DynamicType::Any | DynamicType::Unknown) + ) + }) + } + + /// Return `true` if `other` is present in this class's MRO. + pub(super) fn is_subclass_of(self, db: &'db dyn Db, other: ClassType<'db>) -> bool { + self.iter_mro(db).any(|base| { + match base { + // `is_subclass_of` is checking the subtype relation, in which gradual types do not + // participate. + ClassBase::Dynamic(_) => false, + + // Protocol and Generic are not represented by a ClassType. + ClassBase::Protocol(_) | ClassBase::Generic(_) => false, + + ClassBase::Class(base) => match (base, other) { + (ClassType::NonGeneric(base), ClassType::NonGeneric(other)) => base == other, + (ClassType::Generic(base), ClassType::Generic(other)) => { + base.origin(db) == other.origin(db) + && base + .specialization(db) + .is_subtype_of(db, other.specialization(db)) + } + (ClassType::Generic(_), ClassType::NonGeneric(_)) + | (ClassType::NonGeneric(_), ClassType::Generic(_)) => false, + }, + } + }) + } + + pub(super) fn is_equivalent_to(self, db: &'db dyn Db, other: ClassType<'db>) -> bool { + match (self, other) { + (ClassType::NonGeneric(this), ClassType::NonGeneric(other)) => this == other, + (ClassType::NonGeneric(_), _) | (_, ClassType::NonGeneric(_)) => false, + + (ClassType::Generic(this), ClassType::Generic(other)) => { + this.origin(db) == other.origin(db) + && this + .specialization(db) + .is_equivalent_to(db, other.specialization(db)) + } + } + } + + pub(super) fn is_assignable_to(self, db: &'db dyn Db, other: ClassType<'db>) -> bool { + self.iter_mro(db).any(|base| { + match base { + ClassBase::Dynamic(DynamicType::Any | DynamicType::Unknown) => !other.is_final(db), + ClassBase::Dynamic(_) => false, + + // Protocol and Generic are not represented by a ClassType. + ClassBase::Protocol(_) | ClassBase::Generic(_) => false, + + ClassBase::Class(base) => match (base, other) { + (ClassType::NonGeneric(base), ClassType::NonGeneric(other)) => base == other, + (ClassType::Generic(base), ClassType::Generic(other)) => { + base.origin(db) == other.origin(db) + && base + .specialization(db) + .is_assignable_to(db, other.specialization(db)) + } + (ClassType::Generic(_), ClassType::NonGeneric(_)) + | (ClassType::NonGeneric(_), ClassType::Generic(_)) => false, + }, + } + }) + } + + pub(super) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: ClassType<'db>) -> bool { + match (self, other) { + (ClassType::NonGeneric(this), ClassType::NonGeneric(other)) => this == other, + (ClassType::NonGeneric(_), _) | (_, ClassType::NonGeneric(_)) => false, + + (ClassType::Generic(this), ClassType::Generic(other)) => { + this.origin(db) == other.origin(db) + && this + .specialization(db) + .is_gradual_equivalent_to(db, other.specialization(db)) + } + } + } + + /// Return the metaclass of this class, or `type[Unknown]` if the metaclass cannot be inferred. + pub(super) fn metaclass(self, db: &'db dyn Db) -> Type<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal + .metaclass(db) + .apply_optional_specialization(db, specialization) + } + + /// Return a type representing "the set of all instances of the metaclass of this class". + pub(super) fn metaclass_instance_type(self, db: &'db dyn Db) -> Type<'db> { + self + .metaclass(db) + .to_instance(db) + .expect("`Type::to_instance()` should always return `Some()` when called on the type of a metaclass") + } + + /// Returns the class member of this class named `name`. + /// + /// The member resolves to a member on the class itself or any of its proper superclasses. + /// + /// TODO: Should this be made private...? + pub(super) fn class_member( + self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal.class_member_inner(db, specialization, name, policy) + } + + /// Returns the inferred type of the class member named `name`. Only bound members + /// or those marked as ClassVars are considered. + /// + /// Returns [`Symbol::Unbound`] if `name` cannot be found in this class's scope + /// directly. Use [`ClassType::class_member`] if you require a method that will + /// traverse through the MRO until it finds the member. + pub(super) fn own_class_member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal + .own_class_member(db, specialization, name) + .map_type(|ty| ty.apply_optional_specialization(db, specialization)) + } + + /// Returns the `name` attribute of an instance of this class. + /// + /// The attribute could be defined in the class body, but it could also be an implicitly + /// defined attribute that is only present in a method (typically `__init__`). + /// + /// The attribute might also be defined in a superclass of this class. + pub(super) fn instance_member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal + .instance_member(db, specialization, name) + .map_type(|ty| ty.apply_optional_specialization(db, specialization)) + } + + /// A helper function for `instance_member` that looks up the `name` attribute only on + /// this class, not on its superclasses. + fn own_instance_member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + let (class_literal, specialization) = self.class_literal(db); + class_literal + .own_instance_member(db, name) + .map_type(|ty| ty.apply_optional_specialization(db, specialization)) + } +} + +impl<'db> From<GenericAlias<'db>> for ClassType<'db> { + fn from(generic: GenericAlias<'db>) -> ClassType<'db> { + ClassType::Generic(generic) + } +} + +impl<'db> From<ClassType<'db>> for Type<'db> { + fn from(class: ClassType<'db>) -> Type<'db> { + match class { + ClassType::NonGeneric(non_generic) => non_generic.into(), + ClassType::Generic(generic) => generic.into(), + } + } +} + +/// Representation of a class definition statement in the AST: either a non-generic class, or a +/// generic class that has not been specialized. +/// +/// This does not in itself represent a type, but can be transformed into a [`ClassType`] that +/// does. (For generic classes, this requires specializing its generic context.) +/// +/// # Ordering +/// Ordering is based on the class's id assigned by salsa and not on the class literal's values. +/// The id may change between runs, or when the class literal was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct ClassLiteral<'db> { + /// Name of the class at definition + #[returns(ref)] + pub(crate) name: ast::name::Name, + + pub(crate) body_scope: ScopeId<'db>, + + pub(crate) known: Option<KnownClass>, + + pub(crate) dataclass_params: Option<DataclassParams>, + pub(crate) dataclass_transformer_params: Option<DataclassTransformerParams>, +} + +#[expect(clippy::trivially_copy_pass_by_ref, clippy::ref_option)] +fn pep695_generic_context_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Option<GenericContext<'db>>, + _count: u32, + _self: ClassLiteral<'db>, +) -> salsa::CycleRecoveryAction<Option<GenericContext<'db>>> { + salsa::CycleRecoveryAction::Iterate +} + +fn pep695_generic_context_cycle_initial<'db>( + _db: &'db dyn Db, + _self: ClassLiteral<'db>, +) -> Option<GenericContext<'db>> { + None +} + +#[salsa::tracked] +impl<'db> ClassLiteral<'db> { + /// Return `true` if this class represents `known_class` + pub(crate) fn is_known(self, db: &'db dyn Db, known_class: KnownClass) -> bool { + self.known(db) == Some(known_class) + } + + pub(crate) fn generic_context(self, db: &'db dyn Db) -> Option<GenericContext<'db>> { + // Several typeshed definitions examine `sys.version_info`. To break cycles, we hard-code + // the knowledge that this class is not generic. + if self.is_known(db, KnownClass::VersionInfo) { + return None; + } + + // We've already verified that the class literal does not contain both a PEP-695 generic + // scope and a `typing.Generic` base class. + // + // Note that if a class has an explicit legacy generic context (by inheriting from + // `typing.Generic`), and also an implicit one (by inheriting from other generic classes, + // specialized by typevars), the explicit one takes precedence. + self.pep695_generic_context(db) + .or_else(|| self.legacy_generic_context(db)) + .or_else(|| self.inherited_legacy_generic_context(db)) + } + + #[salsa::tracked(cycle_fn=pep695_generic_context_cycle_recover, cycle_initial=pep695_generic_context_cycle_initial)] + pub(crate) fn pep695_generic_context(self, db: &'db dyn Db) -> Option<GenericContext<'db>> { + let scope = self.body_scope(db); + let class_def_node = scope.node(db).expect_class(); + class_def_node.type_params.as_ref().map(|type_params| { + let index = semantic_index(db, scope.file(db)); + GenericContext::from_type_params(db, index, type_params) + }) + } + + pub(crate) fn legacy_generic_context(self, db: &'db dyn Db) -> Option<GenericContext<'db>> { + self.explicit_bases(db).iter().find_map(|base| match base { + Type::KnownInstance( + KnownInstanceType::Generic(generic_context) + | KnownInstanceType::Protocol(generic_context), + ) => *generic_context, + _ => None, + }) + } + + pub(crate) fn inherited_legacy_generic_context( + self, + db: &'db dyn Db, + ) -> Option<GenericContext<'db>> { + GenericContext::from_base_classes( + db, + self.explicit_bases(db) + .iter() + .copied() + .filter(|ty| matches!(ty, Type::GenericAlias(_))), + ) + } + + /// Return `true` if this class represents the builtin class `object` + pub(crate) fn is_object(self, db: &'db dyn Db) -> bool { + self.is_known(db, KnownClass::Object) + } + + fn file(self, db: &dyn Db) -> File { + self.body_scope(db).file(db) + } + + /// Return the original [`ast::StmtClassDef`] node associated with this class + /// + /// ## Note + /// Only call this function from queries in the same file or your + /// query depends on the AST of another file (bad!). + fn node(self, db: &'db dyn Db) -> &'db ast::StmtClassDef { + self.body_scope(db).node(db).expect_class() + } + + pub(crate) fn definition(self, db: &'db dyn Db) -> Definition<'db> { + let body_scope = self.body_scope(db); + let index = semantic_index(db, body_scope.file(db)); + index.expect_single_definition(body_scope.node(db).expect_class()) + } + + pub(crate) fn apply_optional_specialization( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + ) -> ClassType<'db> { + match (self.generic_context(db), specialization) { + (None, _) => ClassType::NonGeneric(self), + (Some(generic_context), None) => { + let specialization = generic_context.default_specialization(db); + ClassType::Generic(GenericAlias::new(db, self, specialization)) + } + (Some(_), Some(specialization)) => { + ClassType::Generic(GenericAlias::new(db, self, specialization)) + } + } + } + + /// Returns the default specialization of this class. For non-generic classes, the class is + /// returned unchanged. For a non-specialized generic class, we return a generic alias that + /// applies the default specialization to the class's typevars. + pub(crate) fn default_specialization(self, db: &'db dyn Db) -> ClassType<'db> { + match self.generic_context(db) { + None => ClassType::NonGeneric(self), + Some(generic_context) => { + let specialization = generic_context.default_specialization(db); + ClassType::Generic(GenericAlias::new(db, self, specialization)) + } + } + } + + /// Returns a specialization of this class with a `@Todo`-type + pub(crate) fn todo_specialization(self, db: &'db dyn Db, todo: &'static str) -> ClassType<'db> { + match self.generic_context(db) { + None => ClassType::NonGeneric(self), + Some(generic_context) => { + let specialization = generic_context.todo_specialization(db, todo); + ClassType::Generic(GenericAlias::new(db, self, specialization)) + } + } + } + + /// Returns the unknown specialization of this class. For non-generic classes, the class is + /// returned unchanged. For a non-specialized generic class, we return a generic alias that + /// maps each of the class's typevars to `Unknown`. + pub(crate) fn unknown_specialization(self, db: &'db dyn Db) -> ClassType<'db> { + match self.generic_context(db) { + None => ClassType::NonGeneric(self), + Some(generic_context) => { + let specialization = generic_context.unknown_specialization(db); + ClassType::Generic(GenericAlias::new(db, self, specialization)) + } + } + } + + /// Return an iterator over the inferred types of this class's *explicit* bases. + /// + /// Note that any class (except for `object`) that has no explicit + /// bases will implicitly inherit from `object` at runtime. Nonetheless, + /// this method does *not* include `object` in the bases it iterates over. + /// + /// ## Why is this a salsa query? + /// + /// This is a salsa query to short-circuit the invalidation + /// when the class's AST node changes. + /// + /// Were this not a salsa query, then the calling query + /// would depend on the class's AST and rerun for every change in that file. + #[salsa::tracked(returns(deref), cycle_fn=explicit_bases_cycle_recover, cycle_initial=explicit_bases_cycle_initial)] + pub(super) fn explicit_bases(self, db: &'db dyn Db) -> Box<[Type<'db>]> { + tracing::trace!("ClassLiteral::explicit_bases_query: {}", self.name(db)); + + let class_stmt = self.node(db); + let class_definition = + semantic_index(db, self.file(db)).expect_single_definition(class_stmt); + + class_stmt + .bases() + .iter() + .map(|base_node| definition_expression_type(db, class_definition, base_node)) + .collect() + } + + /// Iterate over this class's explicit bases, filtering out any bases that are not class + /// objects, and applying default specialization to any unspecialized generic class literals. + fn fully_static_explicit_bases(self, db: &'db dyn Db) -> impl Iterator<Item = ClassType<'db>> { + self.explicit_bases(db) + .iter() + .copied() + .filter_map(|ty| ty.to_class_type(db)) + } + + /// Determine if this class is a protocol. + /// + /// This method relies on the accuracy of the [`KnownClass::is_protocol`] method, + /// which hardcodes knowledge about certain special-cased classes. See the docs on + /// that method for why we do this rather than relying on generalised logic for all + /// classes, including the special-cased ones that are included in the [`KnownClass`] + /// enum. + pub(super) fn is_protocol(self, db: &'db dyn Db) -> bool { + self.known(db) + .map(KnownClass::is_protocol) + .unwrap_or_else(|| { + // Iterate through the last three bases of the class + // searching for `Protocol` or `Protocol[]` in the bases list. + // + // If `Protocol` is present in the bases list of a valid protocol class, it must either: + // + // - be the last base + // - OR be the last-but-one base (with the final base being `Generic[]` or `object`) + // - OR be the last-but-two base (with the penultimate base being `Generic[]` + // and the final base being `object`) + self.explicit_bases(db) + .iter() + .rev() + .take(3) + .any(|base| matches!(base, Type::KnownInstance(KnownInstanceType::Protocol(_)))) + }) + } + + /// Determine if this is an abstract class. + pub(super) fn is_abstract(self, db: &'db dyn Db) -> bool { + self.metaclass(db) + .into_class_literal() + .is_some_and(|metaclass| metaclass.is_known(db, KnownClass::ABCMeta)) + } + + /// Return the types of the decorators on this class + #[salsa::tracked(returns(deref))] + fn decorators(self, db: &'db dyn Db) -> Box<[Type<'db>]> { + tracing::trace!("ClassLiteral::decorators: {}", self.name(db)); + + let class_stmt = self.node(db); + if class_stmt.decorator_list.is_empty() { + return Box::new([]); + } + + let class_definition = + semantic_index(db, self.file(db)).expect_single_definition(class_stmt); + + class_stmt + .decorator_list + .iter() + .map(|decorator_node| { + definition_expression_type(db, class_definition, &decorator_node.expression) + }) + .collect() + } + + pub(super) fn known_function_decorators( + self, + db: &'db dyn Db, + ) -> impl Iterator<Item = KnownFunction> + 'db { + self.decorators(db) + .iter() + .filter_map(|deco| deco.into_function_literal()) + .filter_map(|decorator| decorator.known(db)) + } + + /// Is this class final? + pub(super) fn is_final(self, db: &'db dyn Db) -> bool { + self.known_function_decorators(db) + .contains(&KnownFunction::Final) + } + + /// Attempt to resolve the [method resolution order] ("MRO") for this class. + /// If the MRO is unresolvable, return an error indicating why the class's MRO + /// cannot be accurately determined. The error returned contains a fallback MRO + /// that will be used instead for the purposes of type inference. + /// + /// The MRO is the tuple of classes that can be retrieved as the `__mro__` + /// attribute on a class at runtime. + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + #[salsa::tracked(returns(as_ref), cycle_fn=try_mro_cycle_recover, cycle_initial=try_mro_cycle_initial)] + pub(super) fn try_mro( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + ) -> Result<Mro<'db>, MroError<'db>> { + tracing::trace!("ClassLiteral::try_mro: {}", self.name(db)); + Mro::of_class(db, self, specialization) + } + + /// Iterate over the [method resolution order] ("MRO") of the class. + /// + /// If the MRO could not be accurately resolved, this method falls back to iterating + /// over an MRO that has the class directly inheriting from `Unknown`. Use + /// [`ClassLiteral::try_mro`] if you need to distinguish between the success and failure + /// cases rather than simply iterating over the inferred resolution order for the class. + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + pub(super) fn iter_mro( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + ) -> MroIterator<'db> { + MroIterator::new(db, self, specialization) + } + + /// Return `true` if `other` is present in this class's MRO. + pub(super) fn is_subclass_of( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + other: ClassType<'db>, + ) -> bool { + // `is_subclass_of` is checking the subtype relation, in which gradual types do not + // participate, so we should not return `True` if we find `Any/Unknown` in the MRO. + self.iter_mro(db, specialization) + .contains(&ClassBase::Class(other)) + } + + /// Return the explicit `metaclass` of this class, if one is defined. + /// + /// ## Note + /// Only call this function from queries in the same file or your + /// query depends on the AST of another file (bad!). + fn explicit_metaclass(self, db: &'db dyn Db) -> Option<Type<'db>> { + let class_stmt = self.node(db); + let metaclass_node = &class_stmt + .arguments + .as_ref()? + .find_keyword("metaclass")? + .value; + + let class_definition = self.definition(db); + + Some(definition_expression_type( + db, + class_definition, + metaclass_node, + )) + } + + /// Return the metaclass of this class, or `type[Unknown]` if the metaclass cannot be inferred. + pub(super) fn metaclass(self, db: &'db dyn Db) -> Type<'db> { + self.try_metaclass(db) + .map(|(ty, _)| ty) + .unwrap_or_else(|_| SubclassOfType::subclass_of_unknown()) + } + + /// Return a type representing "the set of all instances of the metaclass of this class". + pub(super) fn metaclass_instance_type(self, db: &'db dyn Db) -> Type<'db> { + self + .metaclass(db) + .to_instance(db) + .expect("`Type::to_instance()` should always return `Some()` when called on the type of a metaclass") + } + + /// Return the metaclass of this class, or an error if the metaclass cannot be inferred. + #[salsa::tracked( + cycle_fn=try_metaclass_cycle_recover, + cycle_initial=try_metaclass_cycle_initial, + )] + pub(super) fn try_metaclass( + self, + db: &'db dyn Db, + ) -> Result<(Type<'db>, Option<DataclassTransformerParams>), MetaclassError<'db>> { + tracing::trace!("ClassLiteral::try_metaclass: {}", self.name(db)); + + // Identify the class's own metaclass (or take the first base class's metaclass). + let mut base_classes = self.fully_static_explicit_bases(db).peekable(); + + if base_classes.peek().is_some() && self.inheritance_cycle(db).is_some() { + // We emit diagnostics for cyclic class definitions elsewhere. + // Avoid attempting to infer the metaclass if the class is cyclically defined. + return Ok((SubclassOfType::subclass_of_unknown(), None)); + } + + if self.try_mro(db, None).is_err_and(MroError::is_cycle) { + return Ok((SubclassOfType::subclass_of_unknown(), None)); + } + + let explicit_metaclass = self.explicit_metaclass(db); + let (metaclass, class_metaclass_was_from) = if let Some(metaclass) = explicit_metaclass { + (metaclass, self) + } else if let Some(base_class) = base_classes.next() { + let (base_class_literal, _) = base_class.class_literal(db); + (base_class.metaclass(db), base_class_literal) + } else { + (KnownClass::Type.to_class_literal(db), self) + }; + + let mut candidate = if let Some(metaclass_ty) = metaclass.to_class_type(db) { + MetaclassCandidate { + metaclass: metaclass_ty, + explicit_metaclass_of: class_metaclass_was_from, + } + } else { + let name = Type::string_literal(db, self.name(db)); + let bases = TupleType::from_elements(db, self.explicit_bases(db)); + let namespace = KnownClass::Dict + .to_specialized_instance(db, [KnownClass::Str.to_instance(db), Type::any()]); + + // TODO: Other keyword arguments? + let arguments = CallArgumentTypes::positional([name, bases, namespace]); + + let return_ty_result = match metaclass.try_call(db, &arguments) { + Ok(bindings) => Ok(bindings.return_type(db)), + + Err(CallError(CallErrorKind::NotCallable, bindings)) => Err(MetaclassError { + kind: MetaclassErrorKind::NotCallable(bindings.callable_type()), + }), + + // TODO we should also check for binding errors that would indicate the metaclass + // does not accept the right arguments + Err(CallError(CallErrorKind::BindingError, bindings)) => { + Ok(bindings.return_type(db)) + } + + Err(CallError(CallErrorKind::PossiblyNotCallable, _)) => Err(MetaclassError { + kind: MetaclassErrorKind::PartlyNotCallable(metaclass), + }), + }; + + return return_ty_result.map(|ty| (ty.to_meta_type(db), None)); + }; + + // Reconcile all base classes' metaclasses with the candidate metaclass. + // + // See: + // - https://docs.python.org/3/reference/datamodel.html#determining-the-appropriate-metaclass + // - https://github.com/python/cpython/blob/83ba8c2bba834c0b92de669cac16fcda17485e0e/Objects/typeobject.c#L3629-L3663 + for base_class in base_classes { + let metaclass = base_class.metaclass(db); + let Some(metaclass) = metaclass.to_class_type(db) else { + continue; + }; + if metaclass.is_subclass_of(db, candidate.metaclass) { + let (base_class_literal, _) = base_class.class_literal(db); + candidate = MetaclassCandidate { + metaclass, + explicit_metaclass_of: base_class_literal, + }; + continue; + } + if candidate.metaclass.is_subclass_of(db, metaclass) { + continue; + } + let (base_class_literal, _) = base_class.class_literal(db); + return Err(MetaclassError { + kind: MetaclassErrorKind::Conflict { + candidate1: candidate, + candidate2: MetaclassCandidate { + metaclass, + explicit_metaclass_of: base_class_literal, + }, + candidate1_is_base_class: explicit_metaclass.is_none(), + }, + }); + } + + let (metaclass_literal, _) = candidate.metaclass.class_literal(db); + Ok(( + candidate.metaclass.into(), + metaclass_literal.dataclass_transformer_params(db), + )) + } + + pub(super) fn into_callable(self, db: &'db dyn Db) -> Option<Type<'db>> { + let self_ty = Type::from(self); + let metaclass_call_function_symbol = self_ty + .member_lookup_with_policy( + db, + "__call__".into(), + MemberLookupPolicy::NO_INSTANCE_FALLBACK + | MemberLookupPolicy::META_CLASS_NO_TYPE_FALLBACK, + ) + .symbol; + + if let Symbol::Type(Type::BoundMethod(metaclass_call_function), _) = + metaclass_call_function_symbol + { + // TODO: this intentionally diverges from step 1 in + // https://typing.python.org/en/latest/spec/constructors.html#converting-a-constructor-to-callable + // by always respecting the signature of the metaclass `__call__`, rather than + // using a heuristic which makes unwarranted assumptions to sometimes ignore it. + return Some(metaclass_call_function.into_callable_type(db)); + } + + let dunder_new_method = self_ty + .find_name_in_mro(db, "__new__") + .expect("find_name_in_mro always succeeds for class literals") + .symbol + .try_call_dunder_get(db, self_ty); + + if let Symbol::Type(Type::FunctionLiteral(dunder_new_method), _) = dunder_new_method { + return Some(dunder_new_method.into_bound_method_type(db, self.into())); + } + // TODO handle `__init__` also + None + } + + /// Returns the class member of this class named `name`. + /// + /// The member resolves to a member on the class itself or any of its proper superclasses. + /// + /// TODO: Should this be made private...? + pub(super) fn class_member( + self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + self.class_member_inner(db, None, name, policy) + } + + fn class_member_inner( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + name: &str, + policy: MemberLookupPolicy, + ) -> SymbolAndQualifiers<'db> { + if name == "__mro__" { + let tuple_elements = self.iter_mro(db, specialization).map(Type::from); + return Symbol::bound(TupleType::from_elements(db, tuple_elements)).into(); + } + + self.class_member_from_mro(db, name, policy, self.iter_mro(db, specialization)) + } + + pub(super) fn class_member_from_mro( + self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + mro_iter: impl Iterator<Item = ClassBase<'db>>, + ) -> SymbolAndQualifiers<'db> { + // If we encounter a dynamic type in this class's MRO, we'll save that dynamic type + // in this variable. After we've traversed the MRO, we'll either: + // (1) Use that dynamic type as the type for this attribute, + // if no other classes in the MRO define the attribute; or, + // (2) Intersect that dynamic type with the type of the attribute + // from the non-dynamic members of the class's MRO. + let mut dynamic_type_to_intersect_with: Option<Type<'db>> = None; + + let mut lookup_result: LookupResult<'db> = + Err(LookupError::Unbound(TypeQualifiers::empty())); + + for superclass in mro_iter { + match superclass { + ClassBase::Generic(_) | ClassBase::Protocol(_) => { + // Skip over these very special class bases that aren't really classes. + } + ClassBase::Dynamic(_) => { + // Note: calling `Type::from(superclass).member()` would be incorrect here. + // What we'd really want is a `Type::Any.own_class_member()` method, + // but adding such a method wouldn't make much sense -- it would always return `Any`! + dynamic_type_to_intersect_with.get_or_insert(Type::from(superclass)); + } + ClassBase::Class(class) => { + if class.is_known(db, KnownClass::Object) + // Only exclude `object` members if this is not an `object` class itself + && (policy.mro_no_object_fallback() && !self.is_known(db, KnownClass::Object)) + { + continue; + } + + if class.is_known(db, KnownClass::Type) && policy.meta_class_no_type_fallback() + { + continue; + } + + lookup_result = lookup_result.or_else(|lookup_error| { + lookup_error.or_fall_back_to(db, class.own_class_member(db, name)) + }); + } + } + if lookup_result.is_ok() { + break; + } + } + + match ( + SymbolAndQualifiers::from(lookup_result), + dynamic_type_to_intersect_with, + ) { + (symbol_and_qualifiers, None) => symbol_and_qualifiers, + + ( + SymbolAndQualifiers { + symbol: Symbol::Type(ty, _), + qualifiers, + }, + Some(dynamic_type), + ) => Symbol::bound( + IntersectionBuilder::new(db) + .add_positive(ty) + .add_positive(dynamic_type) + .build(), + ) + .with_qualifiers(qualifiers), + + ( + SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers, + }, + Some(dynamic_type), + ) => Symbol::bound(dynamic_type).with_qualifiers(qualifiers), + } + } + + /// Returns the inferred type of the class member named `name`. Only bound members + /// or those marked as ClassVars are considered. + /// + /// Returns [`Symbol::Unbound`] if `name` cannot be found in this class's scope + /// directly. Use [`ClassLiteral::class_member`] if you require a method that will + /// traverse through the MRO until it finds the member. + pub(super) fn own_class_member( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + name: &str, + ) -> SymbolAndQualifiers<'db> { + if name == "__dataclass_fields__" && self.dataclass_params(db).is_some() { + // Make this class look like a subclass of the `DataClassInstance` protocol + return Symbol::bound(KnownClass::Dict.to_specialized_instance( + db, + [ + KnownClass::Str.to_instance(db), + KnownClass::Field.to_specialized_instance(db, [Type::any()]), + ], + )) + .with_qualifiers(TypeQualifiers::CLASS_VAR); + } + + let body_scope = self.body_scope(db); + let symbol = class_symbol(db, body_scope, name).map_type(|ty| { + // The `__new__` and `__init__` members of a non-specialized generic class are handled + // specially: they inherit the generic context of their class. That lets us treat them + // as generic functions when constructing the class, and infer the specialization of + // the class from the arguments that are passed in. + // + // We might decide to handle other class methods the same way, having them inherit the + // class's generic context, and performing type inference on calls to them to determine + // the specialization of the class. If we do that, we would update this to also apply + // to any method with a `@classmethod` decorator. (`__init__` would remain a special + // case, since it's an _instance_ method where we don't yet know the generic class's + // specialization.) + match (self.generic_context(db), ty, specialization, name) { + ( + Some(generic_context), + Type::FunctionLiteral(function), + Some(_), + "__new__" | "__init__", + ) => Type::FunctionLiteral( + function.with_inherited_generic_context(db, generic_context), + ), + _ => ty, + } + }); + + if symbol.symbol.is_unbound() { + if let Some(synthesized_member) = self.own_synthesized_member(db, specialization, name) + { + return Symbol::bound(synthesized_member).into(); + } + } + + symbol + } + + /// Returns the type of a synthesized dataclass member like `__init__` or `__lt__`, or + /// a synthesized `__new__` method for a `NamedTuple`. + fn own_synthesized_member( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + name: &str, + ) -> Option<Type<'db>> { + let dataclass_params = self.dataclass_params(db); + let has_dataclass_param = + |param| dataclass_params.is_some_and(|params| params.contains(param)); + + let field_policy = CodeGeneratorKind::from_class(db, self)?; + + let signature_from_fields = |mut parameters: Vec<_>| { + for (name, (mut attr_ty, mut default_ty)) in + self.fields(db, specialization, field_policy) + { + // The descriptor handling below is guarded by this fully-static check, because dynamic + // types like `Any` are valid (data) descriptors: since they have all possible attributes, + // they also have a (callable) `__set__` method. The problem is that we can't determine + // the type of the value parameter this way. Instead, we want to use the dynamic type + // itself in this case, so we skip the special descriptor handling. + if attr_ty.is_fully_static(db) { + let dunder_set = attr_ty.class_member(db, "__set__".into()); + if let Some(dunder_set) = dunder_set.symbol.ignore_possibly_unbound() { + // This type of this attribute is a data descriptor. Instead of overwriting the + // descriptor attribute, data-classes will (implicitly) call the `__set__` method + // of the descriptor. This means that the synthesized `__init__` parameter for + // this attribute is determined by possible `value` parameter types with which + // the `__set__` method can be called. We build a union of all possible options + // to account for possible overloads. + let mut value_types = UnionBuilder::new(db); + for signature in &dunder_set.signatures(db) { + for overload in signature { + if let Some(value_param) = overload.parameters().get_positional(2) { + value_types = value_types.add( + value_param.annotated_type().unwrap_or_else(Type::unknown), + ); + } else if overload.parameters().is_gradual() { + value_types = value_types.add(Type::unknown()); + } + } + } + attr_ty = value_types.build(); + + // The default value of the attribute is *not* determined by the right hand side + // of the class-body assignment. Instead, the runtime invokes `__get__` on the + // descriptor, as if it had been called on the class itself, i.e. it passes `None` + // for the `instance` argument. + + if let Some(ref mut default_ty) = default_ty { + *default_ty = default_ty + .try_call_dunder_get(db, Type::none(db), Type::ClassLiteral(self)) + .map(|(return_ty, _)| return_ty) + .unwrap_or_else(Type::unknown); + } + } + } + + let mut parameter = + Parameter::positional_or_keyword(name).with_annotated_type(attr_ty); + + if let Some(default_ty) = default_ty { + parameter = parameter.with_default_type(default_ty); + } + + parameters.push(parameter); + } + + let signature = Signature::new(Parameters::new(parameters), Some(Type::none(db))); + Some(Type::Callable(CallableType::single(db, signature))) + }; + + match (field_policy, name) { + (CodeGeneratorKind::DataclassLike, "__init__") => { + let has_synthesized_dunder_init = has_dataclass_param(DataclassParams::INIT) + || self + .try_metaclass(db) + .is_ok_and(|(_, transformer_params)| transformer_params.is_some()); + + if !has_synthesized_dunder_init { + return None; + } + + signature_from_fields(vec![]) + } + (CodeGeneratorKind::NamedTuple, "__new__") => { + let cls_parameter = Parameter::positional_or_keyword(Name::new_static("cls")) + .with_annotated_type(KnownClass::Type.to_instance(db)); + signature_from_fields(vec![cls_parameter]) + } + (CodeGeneratorKind::DataclassLike, "__lt__" | "__le__" | "__gt__" | "__ge__") => { + if !has_dataclass_param(DataclassParams::ORDER) { + return None; + } + + let signature = Signature::new( + Parameters::new([Parameter::positional_or_keyword(Name::new_static("other")) + // TODO: could be `Self`. + .with_annotated_type(Type::instance( + db, + self.apply_optional_specialization(db, specialization), + ))]), + Some(KnownClass::Bool.to_instance(db)), + ); + + Some(Type::Callable(CallableType::single(db, signature))) + } + (CodeGeneratorKind::NamedTuple, name) if name != "__init__" => { + KnownClass::NamedTupleFallback + .to_class_literal(db) + .into_class_literal()? + .own_class_member(db, None, name) + .symbol + .ignore_possibly_unbound() + } + _ => None, + } + } + + /// Returns a list of all annotated attributes defined in this class, or any of its superclasses. + /// + /// See [`ClassLiteral::own_fields`] for more details. + fn fields( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + field_policy: CodeGeneratorKind, + ) -> FxOrderMap<Name, (Type<'db>, Option<Type<'db>>)> { + if field_policy == CodeGeneratorKind::NamedTuple { + // NamedTuples do not allow multiple inheritance, so it is sufficient to enumerate the + // fields of this class only. + return self.own_fields(db); + } + + let matching_classes_in_mro: Vec<_> = self + .iter_mro(db, specialization) + .filter_map(|superclass| { + if let Some(class) = superclass.into_class() { + let class_literal = class.class_literal(db).0; + if field_policy.matches(db, class_literal) { + Some(class_literal) + } else { + None + } + } else { + None + } + }) + // We need to collect into a `Vec` here because we iterate the MRO in reverse order + .collect(); + + matching_classes_in_mro + .into_iter() + .rev() + .flat_map(|class| class.own_fields(db)) + // We collect into a FxOrderMap here to deduplicate attributes + .collect() + } + + /// Returns a list of all annotated attributes defined in the body of this class. This is similar + /// to the `__annotations__` attribute at runtime, but also contains default values. + /// + /// For a class body like + /// ```py + /// @dataclass + /// class C: + /// x: int + /// y: str = "a" + /// ``` + /// we return a map `{"x": (int, None), "y": (str, Some(Literal["a"]))}`. + fn own_fields(self, db: &'db dyn Db) -> FxOrderMap<Name, (Type<'db>, Option<Type<'db>>)> { + let mut attributes = FxOrderMap::default(); + + let class_body_scope = self.body_scope(db); + let table = symbol_table(db, class_body_scope); + + let use_def = use_def_map(db, class_body_scope); + for (symbol_id, declarations) in use_def.all_public_declarations() { + // Here, we exclude all declarations that are not annotated assignments. We need this because + // things like function definitions and nested classes would otherwise be considered dataclass + // fields. The check is too broad in the sense that it also excludes (weird) constructs where + // a symbol would have multiple declarations, one of which is an annotated assignment. If we + // want to improve this, we could instead pass a definition-kind filter to the use-def map + // query, or to the `symbol_from_declarations` call below. Doing so would potentially require + // us to generate a union of `__init__` methods. + if !declarations + .clone() + .all(|DeclarationWithConstraint { declaration, .. }| { + declaration.is_some_and(|declaration| { + matches!( + declaration.kind(db), + DefinitionKind::AnnotatedAssignment(..) + ) + }) + }) + { + continue; + } + + let symbol = table.symbol(symbol_id); + + if let Ok(attr) = symbol_from_declarations(db, declarations) { + if attr.is_class_var() { + continue; + } + + if let Some(attr_ty) = attr.symbol.ignore_possibly_unbound() { + let bindings = use_def.public_bindings(symbol_id); + let default_ty = symbol_from_bindings(db, bindings).ignore_possibly_unbound(); + + attributes.insert(symbol.name().clone(), (attr_ty, default_ty)); + } + } + } + + attributes + } + + /// Returns the `name` attribute of an instance of this class. + /// + /// The attribute could be defined in the class body, but it could also be an implicitly + /// defined attribute that is only present in a method (typically `__init__`). + /// + /// The attribute might also be defined in a superclass of this class. + pub(super) fn instance_member( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + name: &str, + ) -> SymbolAndQualifiers<'db> { + let mut union = UnionBuilder::new(db); + let mut union_qualifiers = TypeQualifiers::empty(); + + for superclass in self.iter_mro(db, specialization) { + match superclass { + ClassBase::Generic(_) | ClassBase::Protocol(_) => { + // Skip over these very special class bases that aren't really classes. + } + ClassBase::Dynamic(_) => { + return SymbolAndQualifiers::todo( + "instance attribute on class with dynamic base", + ); + } + ClassBase::Class(class) => { + if let member @ SymbolAndQualifiers { + symbol: Symbol::Type(ty, boundness), + qualifiers, + } = class.own_instance_member(db, name) + { + // TODO: We could raise a diagnostic here if there are conflicting type qualifiers + union_qualifiers |= qualifiers; + + if boundness == Boundness::Bound { + if union.is_empty() { + // Short-circuit, no need to allocate inside the union builder + return member; + } + + return Symbol::bound(union.add(ty).build()) + .with_qualifiers(union_qualifiers); + } + + // If we see a possibly-unbound symbol, we need to keep looking + // higher up in the MRO. + union = union.add(ty); + } + } + } + } + + if union.is_empty() { + Symbol::Unbound.with_qualifiers(TypeQualifiers::empty()) + } else { + // If we have reached this point, we know that we have only seen possibly-unbound symbols. + // This means that the final result is still possibly-unbound. + + Symbol::Type(union.build(), Boundness::PossiblyUnbound) + .with_qualifiers(union_qualifiers) + } + } + + /// Tries to find declarations/bindings of an instance attribute named `name` that are only + /// "implicitly" defined in a method of the class that corresponds to `class_body_scope`. + fn implicit_instance_attribute( + db: &'db dyn Db, + class_body_scope: ScopeId<'db>, + name: &str, + ) -> Symbol<'db> { + // If we do not see any declarations of an attribute, neither in the class body nor in + // any method, we build a union of `Unknown` with the inferred types of all bindings of + // that attribute. We include `Unknown` in that union to account for the fact that the + // attribute might be externally modified. + let mut union_of_inferred_types = UnionBuilder::new(db).add(Type::unknown()); + + let mut is_attribute_bound = Truthiness::AlwaysFalse; + + let file = class_body_scope.file(db); + let index = semantic_index(db, file); + let class_map = use_def_map(db, class_body_scope); + let class_table = symbol_table(db, class_body_scope); + + for (attribute_assignments, method_scope_id) in + attribute_assignments(db, class_body_scope, name) + { + let method_scope = method_scope_id.to_scope_id(db, file); + let method_map = use_def_map(db, method_scope); + + // The attribute assignment inherits the visibility of the method which contains it + let is_method_visible = if let Some(method_def) = method_scope.node(db).as_function() { + let method = index.expect_single_definition(method_def); + let method_symbol = class_table.symbol_id_by_name(&method_def.name).unwrap(); + class_map + .public_bindings(method_symbol) + .find_map(|bind| { + (bind.binding == Some(method)) + .then(|| class_map.is_binding_visible(db, &bind)) + }) + .unwrap_or(Truthiness::AlwaysFalse) + } else { + Truthiness::AlwaysFalse + }; + if is_method_visible.is_always_false() { + continue; + } + + let mut attribute_assignments = attribute_assignments.peekable(); + let unbound_visibility = attribute_assignments + .peek() + .map(|attribute_assignment| { + if attribute_assignment.binding.is_none() { + method_map.is_binding_visible(db, attribute_assignment) + } else { + Truthiness::AlwaysFalse + } + }) + .unwrap_or(Truthiness::AlwaysFalse); + + for attribute_assignment in attribute_assignments { + let Some(binding) = attribute_assignment.binding else { + continue; + }; + match method_map + .is_binding_visible(db, &attribute_assignment) + .and(is_method_visible) + { + Truthiness::AlwaysTrue => { + is_attribute_bound = Truthiness::AlwaysTrue; + } + Truthiness::Ambiguous => { + if is_attribute_bound.is_always_false() { + is_attribute_bound = Truthiness::Ambiguous; + } + } + Truthiness::AlwaysFalse => { + continue; + } + } + + // There is at least one attribute assignment that may be visible, + // so if `unbound_visibility` is always false then this attribute is considered bound. + // TODO: this is incomplete logic since the attributes bound after termination are considered visible. + if unbound_visibility + .negate() + .and(is_method_visible) + .is_always_true() + { + is_attribute_bound = Truthiness::AlwaysTrue; + } + + match binding.kind(db) { + DefinitionKind::AnnotatedAssignment(ann_assign) => { + // We found an annotated assignment of one of the following forms (using 'self' in these + // examples, but we support arbitrary names for the first parameters of methods): + // + // self.name: <annotation> + // self.name: <annotation> = … + + let annotation_ty = + infer_expression_type(db, index.expression(ann_assign.annotation())); + + // TODO: check if there are conflicting declarations + match is_attribute_bound { + Truthiness::AlwaysTrue => { + return Symbol::bound(annotation_ty); + } + Truthiness::Ambiguous => { + return Symbol::possibly_unbound(annotation_ty); + } + Truthiness::AlwaysFalse => unreachable!( + "If the attribute assignments are all invisible, inference of their types should be skipped" + ), + } + } + DefinitionKind::Assignment(assign) => { + match assign.target_kind() { + TargetKind::Sequence(_, unpack) => { + // We found an unpacking assignment like: + // + // .., self.name, .. = <value> + // (.., self.name, ..) = <value> + // [.., self.name, ..] = <value> + + let unpacked = infer_unpack_types(db, unpack); + let target_ast_id = + assign.target().scoped_expression_id(db, method_scope); + let inferred_ty = unpacked.expression_type(target_ast_id); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + TargetKind::NameOrAttribute => { + // We found an un-annotated attribute assignment of the form: + // + // self.name = <value> + + let inferred_ty = + infer_expression_type(db, index.expression(assign.value())); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + } + } + DefinitionKind::For(for_stmt) => { + match for_stmt.target_kind() { + TargetKind::Sequence(_, unpack) => { + // We found an unpacking assignment like: + // + // for .., self.name, .. in <iterable>: + + let unpacked = infer_unpack_types(db, unpack); + let target_ast_id = + for_stmt.target().scoped_expression_id(db, method_scope); + let inferred_ty = unpacked.expression_type(target_ast_id); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + TargetKind::NameOrAttribute => { + // We found an attribute assignment like: + // + // for self.name in <iterable>: + + let iterable_ty = infer_expression_type( + db, + index.expression(for_stmt.iterable()), + ); + // TODO: Potential diagnostics resulting from the iterable are currently not reported. + let inferred_ty = iterable_ty.iterate(db); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + } + } + DefinitionKind::WithItem(with_item) => { + match with_item.target_kind() { + TargetKind::Sequence(_, unpack) => { + // We found an unpacking assignment like: + // + // with <context_manager> as .., self.name, ..: + + let unpacked = infer_unpack_types(db, unpack); + let target_ast_id = + with_item.target().scoped_expression_id(db, method_scope); + let inferred_ty = unpacked.expression_type(target_ast_id); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + TargetKind::NameOrAttribute => { + // We found an attribute assignment like: + // + // with <context_manager> as self.name: + + let context_ty = infer_expression_type( + db, + index.expression(with_item.context_expr()), + ); + let inferred_ty = context_ty.enter(db); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + } + } + DefinitionKind::Comprehension(comprehension) => { + match comprehension.target_kind() { + TargetKind::Sequence(_, unpack) => { + // We found an unpacking assignment like: + // + // [... for .., self.name, .. in <iterable>] + + let unpacked = infer_unpack_types(db, unpack); + let target_ast_id = comprehension + .target() + .scoped_expression_id(db, unpack.target_scope(db)); + let inferred_ty = unpacked.expression_type(target_ast_id); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + TargetKind::NameOrAttribute => { + // We found an attribute assignment like: + // + // [... for self.name in <iterable>] + + let iterable_ty = infer_expression_type( + db, + index.expression(comprehension.iterable()), + ); + // TODO: Potential diagnostics resulting from the iterable are currently not reported. + let inferred_ty = iterable_ty.iterate(db); + + union_of_inferred_types = union_of_inferred_types.add(inferred_ty); + } + } + } + DefinitionKind::AugmentedAssignment(_) => { + // TODO: + } + DefinitionKind::NamedExpression(_) => { + // A named expression whose target is an attribute is syntactically prohibited + } + _ => {} + } + } + } + + match is_attribute_bound { + Truthiness::AlwaysTrue => Symbol::bound(union_of_inferred_types.build()), + Truthiness::Ambiguous => Symbol::possibly_unbound(union_of_inferred_types.build()), + Truthiness::AlwaysFalse => Symbol::Unbound, + } + } + + /// A helper function for `instance_member` that looks up the `name` attribute only on + /// this class, not on its superclasses. + fn own_instance_member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + // TODO: There are many things that are not yet implemented here: + // - `typing.Final` + // - Proper diagnostics + + let body_scope = self.body_scope(db); + let table = symbol_table(db, body_scope); + + if let Some(symbol_id) = table.symbol_id_by_name(name) { + let use_def = use_def_map(db, body_scope); + + let declarations = use_def.public_declarations(symbol_id); + let declared_and_qualifiers = symbol_from_declarations(db, declarations); + match declared_and_qualifiers { + Ok(SymbolAndQualifiers { + symbol: mut declared @ Symbol::Type(declared_ty, declaredness), + qualifiers, + }) => { + // For the purpose of finding instance attributes, ignore `ClassVar` + // declarations: + if qualifiers.contains(TypeQualifiers::CLASS_VAR) { + declared = Symbol::Unbound; + } + + // The attribute is declared in the class body. + + let bindings = use_def.public_bindings(symbol_id); + let inferred = symbol_from_bindings(db, bindings); + let has_binding = !inferred.is_unbound(); + + if has_binding { + // The attribute is declared and bound in the class body. + + if let Some(implicit_ty) = + Self::implicit_instance_attribute(db, body_scope, name) + .ignore_possibly_unbound() + { + if declaredness == Boundness::Bound { + // If a symbol is definitely declared, and we see + // attribute assignments in methods of the class, + // we trust the declared type. + declared.with_qualifiers(qualifiers) + } else { + Symbol::Type( + UnionType::from_elements(db, [declared_ty, implicit_ty]), + declaredness, + ) + .with_qualifiers(qualifiers) + } + } else { + // The symbol is declared and bound in the class body, + // but we did not find any attribute assignments in + // methods of the class. This means that the attribute + // has a class-level default value, but it would not be + // found in a `__dict__` lookup. + + Symbol::Unbound.into() + } + } else { + // The attribute is declared but not bound in the class body. + // We take this as a sign that this is intended to be a pure + // instance attribute, and we trust the declared type, unless + // it is possibly-undeclared. In the latter case, we also + // union with the inferred type from attribute assignments. + + if declaredness == Boundness::Bound { + declared.with_qualifiers(qualifiers) + } else { + if let Some(implicit_ty) = + Self::implicit_instance_attribute(db, body_scope, name) + .ignore_possibly_unbound() + { + Symbol::Type( + UnionType::from_elements(db, [declared_ty, implicit_ty]), + declaredness, + ) + .with_qualifiers(qualifiers) + } else { + declared.with_qualifiers(qualifiers) + } + } + } + } + + Ok(SymbolAndQualifiers { + symbol: Symbol::Unbound, + qualifiers: _, + }) => { + // The attribute is not *declared* in the class body. It could still be declared/bound + // in a method. + + Self::implicit_instance_attribute(db, body_scope, name).into() + } + Err((declared, _conflicting_declarations)) => { + // There are conflicting declarations for this attribute in the class body. + Symbol::bound(declared.inner_type()).with_qualifiers(declared.qualifiers()) + } + } + } else { + // This attribute is neither declared nor bound in the class body. + // It could still be implicitly defined in a method. + + Self::implicit_instance_attribute(db, body_scope, name).into() + } + } + + /// Return this class' involvement in an inheritance cycle, if any. + /// + /// A class definition like this will fail at runtime, + /// but we must be resilient to it or we could panic. + #[salsa::tracked(cycle_fn=inheritance_cycle_recover, cycle_initial=inheritance_cycle_initial)] + pub(super) fn inheritance_cycle(self, db: &'db dyn Db) -> Option<InheritanceCycle> { + /// Return `true` if the class is cyclically defined. + /// + /// Also, populates `visited_classes` with all base classes of `self`. + fn is_cyclically_defined_recursive<'db>( + db: &'db dyn Db, + class: ClassLiteral<'db>, + classes_on_stack: &mut IndexSet<ClassLiteral<'db>>, + visited_classes: &mut IndexSet<ClassLiteral<'db>>, + ) -> bool { + let mut result = false; + for explicit_base in class.explicit_bases(db) { + let explicit_base_class_literal = match explicit_base { + Type::ClassLiteral(class_literal) => *class_literal, + Type::GenericAlias(generic_alias) => generic_alias.origin(db), + _ => continue, + }; + if !classes_on_stack.insert(explicit_base_class_literal) { + return true; + } + + if visited_classes.insert(explicit_base_class_literal) { + // If we find a cycle, keep searching to check if we can reach the starting class. + result |= is_cyclically_defined_recursive( + db, + explicit_base_class_literal, + classes_on_stack, + visited_classes, + ); + } + classes_on_stack.pop(); + } + result + } + + tracing::trace!("Class::inheritance_cycle: {}", self.name(db)); + + let visited_classes = &mut IndexSet::new(); + if !is_cyclically_defined_recursive(db, self, &mut IndexSet::new(), visited_classes) { + None + } else if visited_classes.contains(&self) { + Some(InheritanceCycle::Participant) + } else { + Some(InheritanceCycle::Inherited) + } + } + + /// Returns a [`Span`] with the range of the class's header. + /// + /// See [`Self::header_range`] for more details. + pub(super) fn header_span(self, db: &'db dyn Db) -> Span { + Span::from(self.file(db)).with_range(self.header_range(db)) + } + + /// Returns the range of the class's "header": the class name + /// and any arguments passed to the `class` statement. E.g. + /// + /// ```ignore + /// class Foo(Bar, metaclass=Baz): ... + /// ^^^^^^^^^^^^^^^^^^^^^^^ + /// ``` + pub(super) fn header_range(self, db: &'db dyn Db) -> TextRange { + let class_scope = self.body_scope(db); + let class_node = class_scope.node(db).expect_class(); + let class_name = &class_node.name; + TextRange::new( + class_name.start(), + class_node + .arguments + .as_deref() + .map(Ranged::end) + .unwrap_or_else(|| class_name.end()), + ) + } +} + +impl<'db> From<ClassLiteral<'db>> for Type<'db> { + fn from(class: ClassLiteral<'db>) -> Type<'db> { + Type::ClassLiteral(class) + } +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] +pub(super) enum InheritanceCycle { + /// The class is cyclically defined and is a participant in the cycle. + /// i.e., it inherits either directly or indirectly from itself. + Participant, + /// The class inherits from a class that is a `Participant` in an inheritance cycle, + /// but is not itself a participant. + Inherited, +} + +impl InheritanceCycle { + pub(super) const fn is_participant(self) -> bool { + matches!(self, InheritanceCycle::Participant) + } +} + +/// Non-exhaustive enumeration of known classes (e.g. `builtins.int`, `typing.Any`, ...) to allow +/// for easier syntax when interacting with very common classes. +/// +/// Feel free to expand this enum if you ever find yourself using the same class in multiple +/// places. +/// Note: good candidates are any classes in `[crate::module_resolver::module::KnownModule]` +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +#[cfg_attr(test, derive(strum_macros::EnumIter))] +pub enum KnownClass { + // To figure out where an stdlib symbol is defined, you can go into `crates/ty_vendored` + // and grep for the symbol name in any `.pyi` file. + + // Builtins + Bool, + Object, + Bytes, + Bytearray, + Type, + Int, + Float, + Complex, + Str, + List, + Tuple, + Set, + FrozenSet, + Dict, + Slice, + Property, + BaseException, + Exception, + BaseExceptionGroup, + ExceptionGroup, + Classmethod, + Super, + // enum + Enum, + // abc + ABCMeta, + // Types + GenericAlias, + ModuleType, + FunctionType, + MethodType, + MethodWrapperType, + WrapperDescriptorType, + UnionType, + GeneratorType, + AsyncGeneratorType, + // Typeshed + NoneType, // Part of `types` for Python >= 3.10 + // Typing + Any, + StdlibAlias, + SpecialForm, + TypeVar, + ParamSpec, + ParamSpecArgs, + ParamSpecKwargs, + TypeVarTuple, + TypeAliasType, + NoDefaultType, + NamedTuple, + NewType, + SupportsIndex, + // Collections + ChainMap, + Counter, + DefaultDict, + Deque, + OrderedDict, + // sys + VersionInfo, + // Exposed as `types.EllipsisType` on Python >=3.10; + // backported as `builtins.ellipsis` by typeshed on Python <=3.9 + EllipsisType, + NotImplementedType, + // dataclasses + Field, + // _typeshed._type_checker_internals + NamedTupleFallback, +} + +impl<'db> KnownClass { + pub(crate) const fn is_bool(self) -> bool { + matches!(self, Self::Bool) + } + + pub(crate) const fn is_special_form(self) -> bool { + matches!(self, Self::SpecialForm) + } + + /// Determine whether instances of this class are always truthy, always falsy, + /// or have an ambiguous truthiness. + pub(crate) const fn bool(self) -> Truthiness { + match self { + // N.B. It's only generally safe to infer `Truthiness::AlwaysTrue` for a `KnownClass` + // variant if the class's `__bool__` method always returns the same thing *and* the + // class is `@final`. + // + // E.g. `ModuleType.__bool__` always returns `True`, but `ModuleType` is not `@final`. + // Equally, `range` is `@final`, but its `__bool__` method can return `False`. + Self::EllipsisType + | Self::NoDefaultType + | Self::MethodType + | Self::Slice + | Self::FunctionType + | Self::VersionInfo + | Self::TypeAliasType + | Self::TypeVar + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::TypeVarTuple + | Self::Super + | Self::WrapperDescriptorType + | Self::UnionType + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::MethodWrapperType => Truthiness::AlwaysTrue, + + Self::NoneType => Truthiness::AlwaysFalse, + + Self::Any + | Self::BaseException + | Self::Exception + | Self::ExceptionGroup + | Self::Object + | Self::OrderedDict + | Self::BaseExceptionGroup + | Self::Bool + | Self::Str + | Self::List + | Self::GenericAlias + | Self::NewType + | Self::StdlibAlias + | Self::SupportsIndex + | Self::Set + | Self::Tuple + | Self::Int + | Self::Type + | Self::Bytes + | Self::Bytearray + | Self::FrozenSet + | Self::Property + | Self::SpecialForm + | Self::Dict + | Self::ModuleType + | Self::ChainMap + | Self::Complex + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::Float + | Self::Enum + | Self::ABCMeta + // Empty tuples are AlwaysFalse; non-empty tuples are AlwaysTrue + | Self::NamedTuple + // Evaluating `NotImplementedType` in a boolean context was deprecated in Python 3.9 + // and raises a `TypeError` in Python >=3.14 + // (see https://docs.python.org/3/library/constants.html#NotImplemented) + | Self::NotImplementedType + | Self::Classmethod + | Self::Field + | Self::NamedTupleFallback => Truthiness::Ambiguous, + } + } + + /// Return `true` if this class is a protocol class. + /// + /// In an ideal world, perhaps we wouldn't hardcode this knowledge here; + /// instead, we'd just look at the bases for these classes, as we do for + /// all other classes. However, the special casing here helps us out in + /// two important ways: + /// + /// 1. It helps us avoid Salsa cycles when creating types such as "instance of `str`" + /// and "instance of `sys._version_info`". These types are constructed very early + /// on, but it causes problems if we attempt to infer the types of their bases + /// too soon. + /// 2. It's probably more performant. + const fn is_protocol(self) -> bool { + match self { + Self::SupportsIndex => true, + + Self::Any + | Self::Bool + | Self::Object + | Self::Bytes + | Self::Bytearray + | Self::Tuple + | Self::Int + | Self::Float + | Self::Complex + | Self::FrozenSet + | Self::Str + | Self::Set + | Self::Dict + | Self::List + | Self::Type + | Self::Slice + | Self::Property + | Self::BaseException + | Self::BaseExceptionGroup + | Self::Exception + | Self::ExceptionGroup + | Self::Classmethod + | Self::GenericAlias + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::ModuleType + | Self::FunctionType + | Self::MethodType + | Self::MethodWrapperType + | Self::WrapperDescriptorType + | Self::NoneType + | Self::SpecialForm + | Self::TypeVar + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::TypeVarTuple + | Self::TypeAliasType + | Self::NoDefaultType + | Self::NamedTuple + | Self::NewType + | Self::ChainMap + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::OrderedDict + | Self::Enum + | Self::ABCMeta + | Self::Super + | Self::StdlibAlias + | Self::VersionInfo + | Self::EllipsisType + | Self::NotImplementedType + | Self::UnionType + | Self::Field + | Self::NamedTupleFallback => false, + } + } + + pub(crate) fn name(self, db: &'db dyn Db) -> &'static str { + match self { + Self::Any => "Any", + Self::Bool => "bool", + Self::Object => "object", + Self::Bytes => "bytes", + Self::Bytearray => "bytearray", + Self::Tuple => "tuple", + Self::Int => "int", + Self::Float => "float", + Self::Complex => "complex", + Self::FrozenSet => "frozenset", + Self::Str => "str", + Self::Set => "set", + Self::Dict => "dict", + Self::List => "list", + Self::Type => "type", + Self::Slice => "slice", + Self::Property => "property", + Self::BaseException => "BaseException", + Self::BaseExceptionGroup => "BaseExceptionGroup", + Self::Exception => "Exception", + Self::ExceptionGroup => "ExceptionGroup", + Self::Classmethod => "classmethod", + Self::GenericAlias => "GenericAlias", + Self::ModuleType => "ModuleType", + Self::FunctionType => "FunctionType", + Self::MethodType => "MethodType", + Self::UnionType => "UnionType", + Self::MethodWrapperType => "MethodWrapperType", + Self::WrapperDescriptorType => "WrapperDescriptorType", + Self::GeneratorType => "GeneratorType", + Self::AsyncGeneratorType => "AsyncGeneratorType", + Self::NamedTuple => "NamedTuple", + Self::NoneType => "NoneType", + Self::SpecialForm => "_SpecialForm", + Self::TypeVar => "TypeVar", + Self::ParamSpec => "ParamSpec", + Self::ParamSpecArgs => "ParamSpecArgs", + Self::ParamSpecKwargs => "ParamSpecKwargs", + Self::TypeVarTuple => "TypeVarTuple", + Self::TypeAliasType => "TypeAliasType", + Self::NoDefaultType => "_NoDefaultType", + Self::NewType => "NewType", + Self::SupportsIndex => "SupportsIndex", + Self::ChainMap => "ChainMap", + Self::Counter => "Counter", + Self::DefaultDict => "defaultdict", + Self::Deque => "deque", + Self::OrderedDict => "OrderedDict", + Self::Enum => "Enum", + Self::ABCMeta => "ABCMeta", + Self::Super => "super", + // For example, `typing.List` is defined as `List = _Alias()` in typeshed + Self::StdlibAlias => "_Alias", + // This is the name the type of `sys.version_info` has in typeshed, + // which is different to what `type(sys.version_info).__name__` is at runtime. + // (At runtime, `type(sys.version_info).__name__ == "version_info"`, + // which is impossible to replicate in the stubs since the sole instance of the class + // also has that name in the `sys` module.) + Self::VersionInfo => "_version_info", + Self::EllipsisType => { + // Exposed as `types.EllipsisType` on Python >=3.10; + // backported as `builtins.ellipsis` by typeshed on Python <=3.9 + if Program::get(db).python_version(db) >= PythonVersion::PY310 { + "EllipsisType" + } else { + "ellipsis" + } + } + Self::NotImplementedType => "_NotImplementedType", + Self::Field => "Field", + Self::NamedTupleFallback => "NamedTupleFallback", + } + } + + pub(super) fn display(self, db: &'db dyn Db) -> impl std::fmt::Display + 'db { + struct KnownClassDisplay<'db> { + db: &'db dyn Db, + class: KnownClass, + } + + impl std::fmt::Display for KnownClassDisplay<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let KnownClassDisplay { + class: known_class, + db, + } = *self; + write!( + f, + "{module}.{class}", + module = known_class.canonical_module(db), + class = known_class.name(db) + ) + } + } + + KnownClassDisplay { db, class: self } + } + + /// Lookup a [`KnownClass`] in typeshed and return a [`Type`] + /// representing all possible instances of the class. + /// + /// If the class cannot be found in typeshed, a debug-level log message will be emitted stating this. + pub(crate) fn to_instance(self, db: &'db dyn Db) -> Type<'db> { + self.to_class_literal(db) + .to_class_type(db) + .map(|class| Type::instance(db, class)) + .unwrap_or_else(Type::unknown) + } + + /// Lookup a [`KnownClass`] in typeshed and return a [`Type`] + /// representing all possible instances of the generic class with a specialization. + /// + /// If the class cannot be found in typeshed, or if you provide a specialization with the wrong + /// number of types, a debug-level log message will be emitted stating this. + pub(crate) fn to_specialized_instance( + self, + db: &'db dyn Db, + specialization: impl IntoIterator<Item = Type<'db>>, + ) -> Type<'db> { + let Type::ClassLiteral(class_literal) = self.to_class_literal(db) else { + return Type::unknown(); + }; + let Some(generic_context) = class_literal.generic_context(db) else { + return Type::unknown(); + }; + + let types = specialization.into_iter().collect::<Box<[_]>>(); + if types.len() != generic_context.len(db) { + // a cache of the `KnownClass`es that we have already seen mismatched-arity + // specializations for (and therefore that we've already logged a warning for) + static MESSAGES: LazyLock<Mutex<FxHashSet<KnownClass>>> = LazyLock::new(Mutex::default); + if MESSAGES.lock().unwrap().insert(self) { + tracing::info!( + "Wrong number of types when specializing {}. \ + Falling back to `Unknown` for the symbol instead.", + self.display(db) + ); + } + return Type::unknown(); + } + + let specialization = generic_context.specialize(db, types); + Type::instance( + db, + ClassType::Generic(GenericAlias::new(db, class_literal, specialization)), + ) + } + + /// Attempt to lookup a [`KnownClass`] in typeshed and return a [`Type`] representing that class-literal. + /// + /// Return an error if the symbol cannot be found in the expected typeshed module, + /// or if the symbol is not a class definition, or if the symbol is possibly unbound. + pub(crate) fn try_to_class_literal( + self, + db: &'db dyn Db, + ) -> Result<ClassLiteral<'db>, KnownClassLookupError<'db>> { + let symbol = known_module_symbol(db, self.canonical_module(db), self.name(db)).symbol; + match symbol { + Symbol::Type(Type::ClassLiteral(class_literal), Boundness::Bound) => Ok(class_literal), + Symbol::Type(Type::ClassLiteral(class_literal), Boundness::PossiblyUnbound) => { + Err(KnownClassLookupError::ClassPossiblyUnbound { class_literal }) + } + Symbol::Type(found_type, _) => { + Err(KnownClassLookupError::SymbolNotAClass { found_type }) + } + Symbol::Unbound => Err(KnownClassLookupError::ClassNotFound), + } + } + + /// Lookup a [`KnownClass`] in typeshed and return a [`Type`] representing that class-literal. + /// + /// If the class cannot be found in typeshed, a debug-level log message will be emitted stating this. + pub(crate) fn to_class_literal(self, db: &'db dyn Db) -> Type<'db> { + // a cache of the `KnownClass`es that we have already failed to lookup in typeshed + // (and therefore that we've already logged a warning for) + static MESSAGES: LazyLock<Mutex<FxHashSet<KnownClass>>> = LazyLock::new(Mutex::default); + + self.try_to_class_literal(db) + .map(Type::ClassLiteral) + .unwrap_or_else(|lookup_error| { + if MESSAGES.lock().unwrap().insert(self) { + if matches!( + lookup_error, + KnownClassLookupError::ClassPossiblyUnbound { .. } + ) { + tracing::info!("{}", lookup_error.display(db, self)); + } else { + tracing::info!( + "{}. Falling back to `Unknown` for the symbol instead.", + lookup_error.display(db, self) + ); + } + } + + match lookup_error { + KnownClassLookupError::ClassPossiblyUnbound { class_literal, .. } => { + class_literal.into() + } + KnownClassLookupError::ClassNotFound { .. } + | KnownClassLookupError::SymbolNotAClass { .. } => Type::unknown(), + } + }) + } + + /// Lookup a [`KnownClass`] in typeshed and return a [`Type`] + /// representing that class and all possible subclasses of the class. + /// + /// If the class cannot be found in typeshed, a debug-level log message will be emitted stating this. + pub(crate) fn to_subclass_of(self, db: &'db dyn Db) -> Type<'db> { + self.to_class_literal(db) + .to_class_type(db) + .map(|class| SubclassOfType::from(db, class)) + .unwrap_or_else(SubclassOfType::subclass_of_unknown) + } + + /// Return `true` if this symbol can be resolved to a class definition `class` in typeshed, + /// *and* `class` is a subclass of `other`. + pub(super) fn is_subclass_of(self, db: &'db dyn Db, other: ClassType<'db>) -> bool { + self.try_to_class_literal(db) + .is_ok_and(|class| class.is_subclass_of(db, None, other)) + } + + /// Return the module in which we should look up the definition for this class + fn canonical_module(self, db: &'db dyn Db) -> KnownModule { + match self { + Self::Bool + | Self::Object + | Self::Bytes + | Self::Bytearray + | Self::Type + | Self::Int + | Self::Float + | Self::Complex + | Self::Str + | Self::List + | Self::Tuple + | Self::Set + | Self::FrozenSet + | Self::Dict + | Self::BaseException + | Self::BaseExceptionGroup + | Self::Exception + | Self::ExceptionGroup + | Self::Classmethod + | Self::Slice + | Self::Super + | Self::Property => KnownModule::Builtins, + Self::VersionInfo => KnownModule::Sys, + Self::ABCMeta => KnownModule::Abc, + Self::Enum => KnownModule::Enum, + Self::GenericAlias + | Self::ModuleType + | Self::FunctionType + | Self::MethodType + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::MethodWrapperType + | Self::UnionType + | Self::WrapperDescriptorType => KnownModule::Types, + Self::NoneType => KnownModule::Typeshed, + Self::Any + | Self::SpecialForm + | Self::TypeVar + | Self::NamedTuple + | Self::StdlibAlias + | Self::SupportsIndex => KnownModule::Typing, + Self::TypeAliasType + | Self::TypeVarTuple + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::NewType => KnownModule::TypingExtensions, + Self::NoDefaultType => { + let python_version = Program::get(db).python_version(db); + + // typing_extensions has a 3.13+ re-export for the `typing.NoDefault` + // singleton, but not for `typing._NoDefaultType`. So we need to switch + // to `typing._NoDefaultType` for newer versions: + if python_version >= PythonVersion::PY313 { + KnownModule::Typing + } else { + KnownModule::TypingExtensions + } + } + Self::EllipsisType => { + // Exposed as `types.EllipsisType` on Python >=3.10; + // backported as `builtins.ellipsis` by typeshed on Python <=3.9 + if Program::get(db).python_version(db) >= PythonVersion::PY310 { + KnownModule::Types + } else { + KnownModule::Builtins + } + } + Self::NotImplementedType => KnownModule::Builtins, + Self::ChainMap + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::OrderedDict => KnownModule::Collections, + Self::Field => KnownModule::Dataclasses, + Self::NamedTupleFallback => KnownModule::TypeCheckerInternals, + } + } + + /// Return true if all instances of this `KnownClass` compare equal. + pub(super) const fn is_single_valued(self) -> bool { + match self { + Self::NoneType + | Self::NoDefaultType + | Self::VersionInfo + | Self::EllipsisType + | Self::TypeAliasType + | Self::UnionType + | Self::NotImplementedType => true, + + Self::Any + | Self::Bool + | Self::Object + | Self::Bytes + | Self::Bytearray + | Self::Type + | Self::Int + | Self::Float + | Self::Complex + | Self::Str + | Self::List + | Self::Tuple + | Self::Set + | Self::FrozenSet + | Self::Dict + | Self::Slice + | Self::Property + | Self::BaseException + | Self::BaseExceptionGroup + | Self::Exception + | Self::ExceptionGroup + | Self::Classmethod + | Self::GenericAlias + | Self::ModuleType + | Self::FunctionType + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::MethodType + | Self::MethodWrapperType + | Self::WrapperDescriptorType + | Self::SpecialForm + | Self::ChainMap + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::OrderedDict + | Self::SupportsIndex + | Self::StdlibAlias + | Self::TypeVar + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::TypeVarTuple + | Self::Enum + | Self::ABCMeta + | Self::Super + | Self::NamedTuple + | Self::NewType + | Self::Field + | Self::NamedTupleFallback => false, + } + } + + /// Is this class a singleton class? + /// + /// A singleton class is a class where it is known that only one instance can ever exist at runtime. + pub(super) const fn is_singleton(self) -> bool { + match self { + Self::NoneType + | Self::EllipsisType + | Self::NoDefaultType + | Self::VersionInfo + | Self::TypeAliasType + | Self::NotImplementedType => true, + + Self::Any + | Self::Bool + | Self::Object + | Self::Bytes + | Self::Bytearray + | Self::Tuple + | Self::Int + | Self::Float + | Self::Complex + | Self::Str + | Self::Set + | Self::FrozenSet + | Self::Dict + | Self::List + | Self::Type + | Self::Slice + | Self::Property + | Self::GenericAlias + | Self::ModuleType + | Self::FunctionType + | Self::MethodType + | Self::MethodWrapperType + | Self::WrapperDescriptorType + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::SpecialForm + | Self::ChainMap + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::OrderedDict + | Self::StdlibAlias + | Self::SupportsIndex + | Self::BaseException + | Self::BaseExceptionGroup + | Self::Exception + | Self::ExceptionGroup + | Self::Classmethod + | Self::TypeVar + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::TypeVarTuple + | Self::Enum + | Self::ABCMeta + | Self::Super + | Self::UnionType + | Self::NamedTuple + | Self::NewType + | Self::Field + | Self::NamedTupleFallback => false, + } + } + + pub(super) fn try_from_file_and_name( + db: &dyn Db, + file: File, + class_name: &str, + ) -> Option<Self> { + // We assert that this match is exhaustive over the right-hand side in the unit test + // `known_class_roundtrip_from_str()` + let candidate = match class_name { + "Any" => Self::Any, + "bool" => Self::Bool, + "object" => Self::Object, + "bytes" => Self::Bytes, + "bytearray" => Self::Bytearray, + "tuple" => Self::Tuple, + "type" => Self::Type, + "int" => Self::Int, + "float" => Self::Float, + "complex" => Self::Complex, + "str" => Self::Str, + "set" => Self::Set, + "frozenset" => Self::FrozenSet, + "dict" => Self::Dict, + "list" => Self::List, + "slice" => Self::Slice, + "property" => Self::Property, + "BaseException" => Self::BaseException, + "BaseExceptionGroup" => Self::BaseExceptionGroup, + "Exception" => Self::Exception, + "ExceptionGroup" => Self::ExceptionGroup, + "classmethod" => Self::Classmethod, + "GenericAlias" => Self::GenericAlias, + "NoneType" => Self::NoneType, + "ModuleType" => Self::ModuleType, + "GeneratorType" => Self::GeneratorType, + "AsyncGeneratorType" => Self::AsyncGeneratorType, + "FunctionType" => Self::FunctionType, + "MethodType" => Self::MethodType, + "UnionType" => Self::UnionType, + "MethodWrapperType" => Self::MethodWrapperType, + "WrapperDescriptorType" => Self::WrapperDescriptorType, + "NamedTuple" => Self::NamedTuple, + "NewType" => Self::NewType, + "TypeAliasType" => Self::TypeAliasType, + "TypeVar" => Self::TypeVar, + "ParamSpec" => Self::ParamSpec, + "ParamSpecArgs" => Self::ParamSpecArgs, + "ParamSpecKwargs" => Self::ParamSpecKwargs, + "TypeVarTuple" => Self::TypeVarTuple, + "ChainMap" => Self::ChainMap, + "Counter" => Self::Counter, + "defaultdict" => Self::DefaultDict, + "deque" => Self::Deque, + "OrderedDict" => Self::OrderedDict, + "_Alias" => Self::StdlibAlias, + "_SpecialForm" => Self::SpecialForm, + "_NoDefaultType" => Self::NoDefaultType, + "SupportsIndex" => Self::SupportsIndex, + "Enum" => Self::Enum, + "ABCMeta" => Self::ABCMeta, + "super" => Self::Super, + "_version_info" => Self::VersionInfo, + "ellipsis" if Program::get(db).python_version(db) <= PythonVersion::PY39 => { + Self::EllipsisType + } + "EllipsisType" if Program::get(db).python_version(db) >= PythonVersion::PY310 => { + Self::EllipsisType + } + "_NotImplementedType" => Self::NotImplementedType, + "Field" => Self::Field, + "NamedTupleFallback" => Self::NamedTupleFallback, + _ => return None, + }; + + candidate + .check_module(db, file_to_module(db, file)?.known()?) + .then_some(candidate) + } + + /// Return `true` if the module of `self` matches `module` + fn check_module(self, db: &'db dyn Db, module: KnownModule) -> bool { + match self { + Self::Any + | Self::Bool + | Self::Object + | Self::Bytes + | Self::Bytearray + | Self::Type + | Self::Int + | Self::Float + | Self::Complex + | Self::Str + | Self::List + | Self::Tuple + | Self::Set + | Self::FrozenSet + | Self::Dict + | Self::Slice + | Self::Property + | Self::GenericAlias + | Self::ChainMap + | Self::Counter + | Self::DefaultDict + | Self::Deque + | Self::OrderedDict + | Self::StdlibAlias // no equivalent class exists in typing_extensions, nor ever will + | Self::ModuleType + | Self::VersionInfo + | Self::BaseException + | Self::Exception + | Self::ExceptionGroup + | Self::EllipsisType + | Self::BaseExceptionGroup + | Self::Classmethod + | Self::FunctionType + | Self::MethodType + | Self::MethodWrapperType + | Self::Enum + | Self::ABCMeta + | Self::Super + | Self::NotImplementedType + | Self::UnionType + | Self::GeneratorType + | Self::AsyncGeneratorType + | Self::WrapperDescriptorType + | Self::Field + | Self::NamedTupleFallback => module == self.canonical_module(db), + Self::NoneType => matches!(module, KnownModule::Typeshed | KnownModule::Types), + Self::SpecialForm + | Self::TypeVar + | Self::TypeAliasType + | Self::NoDefaultType + | Self::SupportsIndex + | Self::ParamSpec + | Self::ParamSpecArgs + | Self::ParamSpecKwargs + | Self::TypeVarTuple + | Self::NamedTuple + | Self::NewType => matches!(module, KnownModule::Typing | KnownModule::TypingExtensions), + } + } +} + +/// Enumeration of ways in which looking up a [`KnownClass`] in typeshed could fail. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum KnownClassLookupError<'db> { + /// There is no symbol by that name in the expected typeshed module. + ClassNotFound, + /// There is a symbol by that name in the expected typeshed module, + /// but it's not a class. + SymbolNotAClass { found_type: Type<'db> }, + /// There is a symbol by that name in the expected typeshed module, + /// and it's a class definition, but it's possibly unbound. + ClassPossiblyUnbound { class_literal: ClassLiteral<'db> }, +} + +impl<'db> KnownClassLookupError<'db> { + fn display(&self, db: &'db dyn Db, class: KnownClass) -> impl std::fmt::Display + 'db { + struct ErrorDisplay<'db> { + db: &'db dyn Db, + class: KnownClass, + error: KnownClassLookupError<'db>, + } + + impl std::fmt::Display for ErrorDisplay<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let ErrorDisplay { db, class, error } = *self; + + let class = class.display(db); + let python_version = Program::get(db).python_version(db); + + match error { + KnownClassLookupError::ClassNotFound => write!( + f, + "Could not find class `{class}` in typeshed on Python {python_version}", + ), + KnownClassLookupError::SymbolNotAClass { found_type } => write!( + f, + "Error looking up `{class}` in typeshed: expected to find a class definition \ + on Python {python_version}, but found a symbol of type `{found_type}` instead", + found_type = found_type.display(db), + ), + KnownClassLookupError::ClassPossiblyUnbound { .. } => write!( + f, + "Error looking up `{class}` in typeshed on Python {python_version}: \ + expected to find a fully bound symbol, but found one that is possibly unbound", + ), + } + } + } + + ErrorDisplay { + db, + class, + error: *self, + } + } +} + +pub(crate) struct SliceLiteral { + pub(crate) start: Option<i32>, + pub(crate) stop: Option<i32>, + pub(crate) step: Option<i32>, +} + +impl<'db> Type<'db> { + /// If this type represents a valid slice literal, returns a [`SliceLiteral`] describing it. + /// Otherwise returns `None`. + /// + /// The type must be a specialization of the `slice` builtin type, where the specialized + /// typevars are statically known integers or `None`. + pub(crate) fn slice_literal(self, db: &'db dyn Db) -> Option<SliceLiteral> { + let ClassType::Generic(alias) = self.into_nominal_instance()?.class else { + return None; + }; + if !alias.origin(db).is_known(db, KnownClass::Slice) { + return None; + } + let [start, stop, step] = alias.specialization(db).types(db) else { + return None; + }; + + let to_u32 = |ty: &Type<'db>| match ty { + Type::IntLiteral(n) => i32::try_from(*n).map(Some).ok(), + Type::BooleanLiteral(b) => Some(Some(i32::from(*b))), + Type::NominalInstance(instance) + if instance.class.is_known(db, KnownClass::NoneType) => + { + Some(None) + } + _ => None, + }; + Some(SliceLiteral { + start: to_u32(start)?, + stop: to_u32(stop)?, + step: to_u32(step)?, + }) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, salsa::Update)] +pub(super) struct MetaclassError<'db> { + kind: MetaclassErrorKind<'db>, +} + +impl<'db> MetaclassError<'db> { + /// Return an [`MetaclassErrorKind`] variant describing why we could not resolve the metaclass for this class. + pub(super) fn reason(&self) -> &MetaclassErrorKind<'db> { + &self.kind + } +} + +#[derive(Debug, Clone, PartialEq, Eq, salsa::Update)] +pub(super) enum MetaclassErrorKind<'db> { + /// The class has incompatible metaclasses in its inheritance hierarchy. + /// + /// The metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all + /// its bases. + Conflict { + /// `candidate1` will either be the explicit `metaclass=` keyword in the class definition, + /// or the inferred metaclass of a base class + candidate1: MetaclassCandidate<'db>, + + /// `candidate2` will always be the inferred metaclass of a base class + candidate2: MetaclassCandidate<'db>, + + /// Flag to indicate whether `candidate1` is the explicit `metaclass=` keyword or the + /// inferred metaclass of a base class. This helps us give better error messages in diagnostics. + candidate1_is_base_class: bool, + }, + /// The metaclass is not callable + NotCallable(Type<'db>), + /// The metaclass is of a union type whose some members are not callable + PartlyNotCallable(Type<'db>), + /// A cycle was encountered attempting to determine the metaclass + Cycle, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::db::tests::setup_db; + use crate::module_resolver::resolve_module; + use crate::{PythonVersionSource, PythonVersionWithSource}; + use salsa::Setter; + use strum::IntoEnumIterator; + + #[test] + fn known_class_roundtrip_from_str() { + let db = setup_db(); + for class in KnownClass::iter() { + let class_name = class.name(&db); + let class_module = resolve_module(&db, &class.canonical_module(&db).name()).unwrap(); + + assert_eq!( + KnownClass::try_from_file_and_name(&db, class_module.file().unwrap(), class_name), + Some(class), + "`KnownClass::candidate_from_str` appears to be missing a case for `{class_name}`" + ); + } + } + + #[test] + fn known_class_doesnt_fallback_to_unknown_unexpectedly_on_latest_version() { + let mut db = setup_db(); + + Program::get(&db) + .set_python_version_with_source(&mut db) + .to(PythonVersionWithSource { + version: PythonVersion::latest_ty(), + source: PythonVersionSource::default(), + }); + + for class in KnownClass::iter() { + assert_ne!( + class.to_instance(&db), + Type::unknown(), + "Unexpectedly fell back to `Unknown` for `{class:?}`" + ); + } + } + + #[test] + fn known_class_doesnt_fallback_to_unknown_unexpectedly_on_low_python_version() { + let mut db = setup_db(); + + for class in KnownClass::iter() { + let version_added = match class { + KnownClass::UnionType => PythonVersion::PY310, + KnownClass::BaseExceptionGroup | KnownClass::ExceptionGroup => PythonVersion::PY311, + KnownClass::GenericAlias => PythonVersion::PY39, + _ => PythonVersion::PY37, + }; + + Program::get(&db) + .set_python_version_with_source(&mut db) + .to(PythonVersionWithSource { + version: version_added, + source: PythonVersionSource::default(), + }); + + assert_ne!( + class.to_instance(&db), + Type::unknown(), + "Unexpectedly fell back to `Unknown` for `{class:?}` on Python {version_added}" + ); + } + } +} diff --git a/crates/ty_python_semantic/src/types/class_base.rs b/crates/ty_python_semantic/src/types/class_base.rs new file mode 100644 index 0000000000000..9ff7fcad6003c --- /dev/null +++ b/crates/ty_python_semantic/src/types/class_base.rs @@ -0,0 +1,397 @@ +use crate::Db; +use crate::types::generics::{GenericContext, Specialization}; +use crate::types::{ + ClassType, DynamicType, KnownClass, KnownInstanceType, MroError, MroIterator, Type, + TypeMapping, todo_type, +}; + +/// Enumeration of the possible kinds of types we allow in class bases. +/// +/// This is much more limited than the [`Type`] enum: all types that would be invalid to have as a +/// class base are transformed into [`ClassBase::unknown()`] +/// +/// Note that a non-specialized generic class _cannot_ be a class base. When we see a +/// non-specialized generic class in any type expression (including the list of base classes), we +/// automatically construct the default specialization for that class. +#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, salsa::Update)] +pub enum ClassBase<'db> { + Dynamic(DynamicType), + Class(ClassType<'db>), + /// Although `Protocol` is not a class in typeshed's stubs, it is at runtime, + /// and can appear in the MRO of a class. + Protocol(Option<GenericContext<'db>>), + /// Bare `Generic` cannot be subclassed directly in user code, + /// but nonetheless appears in the MRO of classes that inherit from `Generic[T]`, + /// `Protocol[T]`, or bare `Protocol`. + Generic(Option<GenericContext<'db>>), +} + +impl<'db> ClassBase<'db> { + pub(crate) const fn unknown() -> Self { + Self::Dynamic(DynamicType::Unknown) + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Self::Dynamic(dynamic) => Self::Dynamic(dynamic.normalized()), + Self::Class(class) => Self::Class(class.normalized(db)), + Self::Protocol(generic_context) => { + Self::Protocol(generic_context.map(|context| context.normalized(db))) + } + Self::Generic(generic_context) => { + Self::Generic(generic_context.map(|context| context.normalized(db))) + } + } + } + + pub(crate) fn display(self, db: &'db dyn Db) -> impl std::fmt::Display + 'db { + struct Display<'db> { + base: ClassBase<'db>, + db: &'db dyn Db, + } + + impl std::fmt::Display for Display<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self.base { + ClassBase::Dynamic(dynamic) => dynamic.fmt(f), + ClassBase::Class(class @ ClassType::NonGeneric(_)) => { + write!(f, "<class '{}'>", class.name(self.db)) + } + ClassBase::Class(ClassType::Generic(alias)) => { + write!(f, "<class '{}'>", alias.display(self.db)) + } + ClassBase::Protocol(generic_context) => { + f.write_str("typing.Protocol")?; + if let Some(generic_context) = generic_context { + generic_context.display(self.db).fmt(f)?; + } + Ok(()) + } + ClassBase::Generic(generic_context) => { + f.write_str("typing.Generic")?; + if let Some(generic_context) = generic_context { + generic_context.display(self.db).fmt(f)?; + } + Ok(()) + } + } + } + } + + Display { base: self, db } + } + + pub(crate) fn name(self, db: &'db dyn Db) -> &'db str { + match self { + ClassBase::Class(class) => class.name(db), + ClassBase::Dynamic(DynamicType::Any) => "Any", + ClassBase::Dynamic(DynamicType::Unknown) => "Unknown", + ClassBase::Dynamic(DynamicType::Todo(_) | DynamicType::TodoPEP695ParamSpec) => "@Todo", + ClassBase::Protocol(_) => "Protocol", + ClassBase::Generic(_) => "Generic", + } + } + + /// Return a `ClassBase` representing the class `builtins.object` + pub(super) fn object(db: &'db dyn Db) -> Self { + KnownClass::Object + .to_class_literal(db) + .to_class_type(db) + .map_or(Self::unknown(), Self::Class) + } + + /// Attempt to resolve `ty` into a `ClassBase`. + /// + /// Return `None` if `ty` is not an acceptable type for a class base. + pub(super) fn try_from_type(db: &'db dyn Db, ty: Type<'db>) -> Option<Self> { + match ty { + Type::Dynamic(dynamic) => Some(Self::Dynamic(dynamic)), + Type::ClassLiteral(literal) => { + if literal.is_known(db, KnownClass::Any) { + Some(Self::Dynamic(DynamicType::Any)) + } else if literal.is_known(db, KnownClass::NamedTuple) { + Self::try_from_type(db, KnownClass::Tuple.to_class_literal(db)) + } else { + Some(Self::Class(literal.default_specialization(db))) + } + } + Type::GenericAlias(generic) => Some(Self::Class(ClassType::Generic(generic))), + Type::NominalInstance(instance) + if instance.class.is_known(db, KnownClass::GenericAlias) => + { + Self::try_from_type(db, todo_type!("GenericAlias instance")) + } + Type::SubclassOf(subclass_of) => subclass_of + .subclass_of() + .into_dynamic() + .map(ClassBase::Dynamic), + Type::Intersection(inter) => { + let valid_element = inter + .positive(db) + .iter() + .find_map(|elem| ClassBase::try_from_type(db, *elem))?; + + if ty.is_disjoint_from(db, KnownClass::Type.to_instance(db)) { + None + } else { + Some(valid_element) + } + } + Type::Union(union) => { + // We do not support full unions of MROs (yet). Until we do, + // support the cases where one of the types in the union is + // a dynamic type such as `Any` or `Unknown`, and all other + // types *would be* valid class bases. In this case, we can + // "fold" the other potential bases into the dynamic type, + // and return `Any`/`Unknown` as the class base to prevent + // invalid-base diagnostics and further downstream errors. + let Some(Type::Dynamic(dynamic)) = union + .elements(db) + .iter() + .find(|elem| matches!(elem, Type::Dynamic(_))) + else { + return None; + }; + + if union + .elements(db) + .iter() + .all(|elem| ClassBase::try_from_type(db, *elem).is_some()) + { + Some(ClassBase::Dynamic(*dynamic)) + } else { + None + } + } + Type::NominalInstance(_) => None, // TODO -- handle `__mro_entries__`? + + // This likely means that we're in unreachable code, + // in which case we want to treat `Never` in a forgiving way and silence diagnostics + Type::Never => Some(ClassBase::unknown()), + + Type::PropertyInstance(_) + | Type::BooleanLiteral(_) + | Type::FunctionLiteral(_) + | Type::Callable(..) + | Type::BoundMethod(_) + | Type::MethodWrapper(_) + | Type::WrapperDescriptor(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::BytesLiteral(_) + | Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::LiteralString + | Type::Tuple(_) + | Type::ModuleLiteral(_) + | Type::TypeVar(_) + | Type::BoundSuper(_) + | Type::ProtocolInstance(_) + | Type::AlwaysFalsy + | Type::AlwaysTruthy => None, + Type::KnownInstance(known_instance) => match known_instance { + KnownInstanceType::TypeVar(_) + | KnownInstanceType::TypeAliasType(_) + | KnownInstanceType::Annotated + | KnownInstanceType::Literal + | KnownInstanceType::LiteralString + | KnownInstanceType::Union + | KnownInstanceType::NoReturn + | KnownInstanceType::Never + | KnownInstanceType::Final + | KnownInstanceType::NotRequired + | KnownInstanceType::TypeGuard + | KnownInstanceType::TypeIs + | KnownInstanceType::TypingSelf + | KnownInstanceType::Unpack + | KnownInstanceType::ClassVar + | KnownInstanceType::Concatenate + | KnownInstanceType::Required + | KnownInstanceType::TypeAlias + | KnownInstanceType::ReadOnly + | KnownInstanceType::Optional + | KnownInstanceType::Not + | KnownInstanceType::Intersection + | KnownInstanceType::TypeOf + | KnownInstanceType::CallableTypeOf + | KnownInstanceType::AlwaysTruthy + | KnownInstanceType::AlwaysFalsy => None, + KnownInstanceType::Unknown => Some(Self::unknown()), + // TODO: Classes inheriting from `typing.Type` et al. also have `Generic` in their MRO + KnownInstanceType::Dict => { + Self::try_from_type(db, KnownClass::Dict.to_class_literal(db)) + } + KnownInstanceType::List => { + Self::try_from_type(db, KnownClass::List.to_class_literal(db)) + } + KnownInstanceType::Type => { + Self::try_from_type(db, KnownClass::Type.to_class_literal(db)) + } + KnownInstanceType::Tuple => { + Self::try_from_type(db, KnownClass::Tuple.to_class_literal(db)) + } + KnownInstanceType::Set => { + Self::try_from_type(db, KnownClass::Set.to_class_literal(db)) + } + KnownInstanceType::FrozenSet => { + Self::try_from_type(db, KnownClass::FrozenSet.to_class_literal(db)) + } + KnownInstanceType::ChainMap => { + Self::try_from_type(db, KnownClass::ChainMap.to_class_literal(db)) + } + KnownInstanceType::Counter => { + Self::try_from_type(db, KnownClass::Counter.to_class_literal(db)) + } + KnownInstanceType::DefaultDict => { + Self::try_from_type(db, KnownClass::DefaultDict.to_class_literal(db)) + } + KnownInstanceType::Deque => { + Self::try_from_type(db, KnownClass::Deque.to_class_literal(db)) + } + KnownInstanceType::OrderedDict => { + Self::try_from_type(db, KnownClass::OrderedDict.to_class_literal(db)) + } + KnownInstanceType::TypedDict => Self::try_from_type(db, todo_type!("TypedDict")), + KnownInstanceType::Callable => { + Self::try_from_type(db, todo_type!("Support for Callable as a base class")) + } + KnownInstanceType::Protocol(generic_context) => { + Some(ClassBase::Protocol(generic_context)) + } + KnownInstanceType::Generic(generic_context) => { + Some(ClassBase::Generic(generic_context)) + } + }, + } + } + + pub(super) fn into_class(self) -> Option<ClassType<'db>> { + match self { + Self::Class(class) => Some(class), + Self::Dynamic(_) | Self::Generic(_) | Self::Protocol(_) => None, + } + } + + fn apply_type_mapping<'a>(self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + match self { + Self::Class(class) => Self::Class(class.apply_type_mapping(db, type_mapping)), + Self::Dynamic(_) | Self::Generic(_) | Self::Protocol(_) => self, + } + } + + pub(crate) fn apply_optional_specialization( + self, + db: &'db dyn Db, + specialization: Option<Specialization<'db>>, + ) -> Self { + if let Some(specialization) = specialization { + self.apply_type_mapping(db, &TypeMapping::Specialization(specialization)) + } else { + self + } + } + + pub(super) fn has_cyclic_mro(self, db: &'db dyn Db) -> bool { + match self { + ClassBase::Class(class) => { + let (class_literal, specialization) = class.class_literal(db); + class_literal + .try_mro(db, specialization) + .is_err_and(MroError::is_cycle) + } + ClassBase::Dynamic(_) | ClassBase::Generic(_) | ClassBase::Protocol(_) => false, + } + } + + /// Iterate over the MRO of this base + pub(super) fn mro( + self, + db: &'db dyn Db, + additional_specialization: Option<Specialization<'db>>, + ) -> impl Iterator<Item = ClassBase<'db>> { + match self { + ClassBase::Protocol(context) => { + ClassBaseMroIterator::length_3(db, self, ClassBase::Generic(context)) + } + ClassBase::Dynamic(_) | ClassBase::Generic(_) => { + ClassBaseMroIterator::length_2(db, self) + } + ClassBase::Class(class) => { + ClassBaseMroIterator::from_class(db, class, additional_specialization) + } + } + } + + pub(crate) const fn is_dynamic(self) -> bool { + matches!(self, Self::Dynamic(_)) + } +} + +impl<'db> From<ClassType<'db>> for ClassBase<'db> { + fn from(value: ClassType<'db>) -> Self { + ClassBase::Class(value) + } +} + +impl<'db> From<ClassBase<'db>> for Type<'db> { + fn from(value: ClassBase<'db>) -> Self { + match value { + ClassBase::Dynamic(dynamic) => Type::Dynamic(dynamic), + ClassBase::Class(class) => class.into(), + ClassBase::Protocol(generic_context) => { + Type::KnownInstance(KnownInstanceType::Protocol(generic_context)) + } + ClassBase::Generic(generic_context) => { + Type::KnownInstance(KnownInstanceType::Generic(generic_context)) + } + } + } +} + +impl<'db> From<&ClassBase<'db>> for Type<'db> { + fn from(value: &ClassBase<'db>) -> Self { + Self::from(*value) + } +} + +/// An iterator over the MRO of a class base. +enum ClassBaseMroIterator<'db> { + Length2(core::array::IntoIter<ClassBase<'db>, 2>), + Length3(core::array::IntoIter<ClassBase<'db>, 3>), + FromClass(MroIterator<'db>), +} + +impl<'db> ClassBaseMroIterator<'db> { + /// Iterate over an MRO of length 2 that consists of `first_element` and then `object`. + fn length_2(db: &'db dyn Db, first_element: ClassBase<'db>) -> Self { + ClassBaseMroIterator::Length2([first_element, ClassBase::object(db)].into_iter()) + } + + /// Iterate over an MRO of length 3 that consists of `first_element`, then `second_element`, then `object`. + fn length_3(db: &'db dyn Db, element_1: ClassBase<'db>, element_2: ClassBase<'db>) -> Self { + ClassBaseMroIterator::Length3([element_1, element_2, ClassBase::object(db)].into_iter()) + } + + /// Iterate over the MRO of an arbitrary class. The MRO may be of any length. + fn from_class( + db: &'db dyn Db, + class: ClassType<'db>, + additional_specialization: Option<Specialization<'db>>, + ) -> Self { + ClassBaseMroIterator::FromClass(class.iter_mro_specialized(db, additional_specialization)) + } +} + +impl<'db> Iterator for ClassBaseMroIterator<'db> { + type Item = ClassBase<'db>; + + fn next(&mut self) -> Option<Self::Item> { + match self { + Self::Length2(iter) => iter.next(), + Self::Length3(iter) => iter.next(), + Self::FromClass(iter) => iter.next(), + } + } +} + +impl std::iter::FusedIterator for ClassBaseMroIterator<'_> {} diff --git a/crates/ty_python_semantic/src/types/context.rs b/crates/ty_python_semantic/src/types/context.rs new file mode 100644 index 0000000000000..d8004122cc7a1 --- /dev/null +++ b/crates/ty_python_semantic/src/types/context.rs @@ -0,0 +1,586 @@ +use std::fmt; + +use drop_bomb::DebugDropBomb; +use ruff_db::diagnostic::{DiagnosticTag, SubDiagnostic}; +use ruff_db::{ + diagnostic::{Annotation, Diagnostic, DiagnosticId, IntoDiagnosticMessage, Severity, Span}, + files::File, +}; +use ruff_text_size::{Ranged, TextRange}; + +use super::{Type, TypeCheckDiagnostics, binding_type}; + +use crate::lint::LintSource; +use crate::semantic_index::symbol::ScopeId; +use crate::{ + Db, + lint::{LintId, LintMetadata}, + suppression::suppressions, +}; +use crate::{semantic_index::semantic_index, types::FunctionDecorators}; + +/// Context for inferring the types of a single file. +/// +/// One context exists for at least for every inferred region but it's +/// possible that inferring a sub-region, like an unpack assignment, creates +/// a sub-context. +/// +/// Tracks the reported diagnostics of the inferred region. +/// +/// ## Consuming +/// It's important that the context is explicitly consumed before dropping by calling +/// [`InferContext::finish`] and the returned diagnostics must be stored +/// on the current [`TypeInference`](super::infer::TypeInference) result. +pub(crate) struct InferContext<'db> { + db: &'db dyn Db, + scope: ScopeId<'db>, + file: File, + diagnostics: std::cell::RefCell<TypeCheckDiagnostics>, + no_type_check: InNoTypeCheck, + bomb: DebugDropBomb, +} + +impl<'db> InferContext<'db> { + pub(crate) fn new(db: &'db dyn Db, scope: ScopeId<'db>) -> Self { + Self { + db, + scope, + file: scope.file(db), + diagnostics: std::cell::RefCell::new(TypeCheckDiagnostics::default()), + no_type_check: InNoTypeCheck::default(), + bomb: DebugDropBomb::new( + "`InferContext` needs to be explicitly consumed by calling `::finish` to prevent accidental loss of diagnostics.", + ), + } + } + + /// The file for which the types are inferred. + pub(crate) fn file(&self) -> File { + self.file + } + + /// Create a span with the range of the given expression + /// in the file being currently type checked. + /// + /// If you're creating a diagnostic with snippets in files + /// other than this one, you should create the span directly + /// and not use this convenience API. + pub(crate) fn span<T: Ranged>(&self, ranged: T) -> Span { + Span::from(self.file()).with_range(ranged.range()) + } + + /// Create a secondary annotation attached to the range of the given value in + /// the file currently being type checked. + /// + /// The annotation returned has no message attached to it. + pub(crate) fn secondary<T: Ranged>(&self, ranged: T) -> Annotation { + Annotation::secondary(self.span(ranged)) + } + + pub(crate) fn db(&self) -> &'db dyn Db { + self.db + } + + pub(crate) fn extend(&mut self, other: &TypeCheckDiagnostics) { + self.diagnostics.get_mut().extend(other); + } + + /// Optionally return a builder for a lint diagnostic guard. + /// + /// If the current context believes a diagnostic should be reported for + /// the given lint, then a builder is returned that enables building a + /// lint diagnostic guard. The guard can then be used, via its `DerefMut` + /// implementation, to directly mutate a `Diagnostic`. + /// + /// The severity of the diagnostic returned is automatically determined + /// by the given lint and configuration. The message given to + /// `LintDiagnosticGuardBuilder::to_diagnostic` is used to construct the + /// initial diagnostic and should be considered the "top-level message" of + /// the diagnostic. (i.e., If nothing else about the diagnostic is seen, + /// aside from its identifier, the message is probably the thing you'd pick + /// to show.) + /// + /// The diagnostic constructed also includes a primary annotation with a + /// `Span` derived from the range given attached to the `File` in this + /// typing context. (That means the range given _must_ be valid for the + /// `File` currently being type checked.) This primary annotation does + /// not have a message attached to it, but callers can attach one via + /// `LintDiagnosticGuard::set_primary_message`. + /// + /// After using the builder to make a guard, once the guard is dropped, the + /// diagnostic is added to the context, unless there is something in the + /// diagnostic that excludes it. (Currently, no such conditions exist.) + /// + /// If callers need to create a non-lint diagnostic, you'll want to use the + /// lower level `InferContext::report_diagnostic` routine. + pub(super) fn report_lint<'ctx, T: Ranged>( + &'ctx self, + lint: &'static LintMetadata, + ranged: T, + ) -> Option<LintDiagnosticGuardBuilder<'ctx, 'db>> { + LintDiagnosticGuardBuilder::new(self, lint, ranged.range()) + } + + /// Optionally return a builder for a diagnostic guard. + /// + /// This only returns a builder if the current context allows a diagnostic + /// with the given information to be added. In general, the requirements + /// here are quite a bit less than for `InferContext::report_lint`, since + /// this routine doesn't take rule selection into account (among other + /// things). + /// + /// After using the builder to make a guard, once the guard is dropped, the + /// diagnostic is added to the context, unless there is something in the + /// diagnostic that excludes it. (Currently, no such conditions exist.) + /// + /// Callers should generally prefer adding a lint diagnostic via + /// `InferContext::report_lint` whenever possible. + pub(super) fn report_diagnostic<'ctx>( + &'ctx self, + id: DiagnosticId, + severity: Severity, + ) -> Option<DiagnosticGuardBuilder<'ctx, 'db>> { + DiagnosticGuardBuilder::new(self, id, severity) + } + + pub(super) fn set_in_no_type_check(&mut self, no_type_check: InNoTypeCheck) { + self.no_type_check = no_type_check; + } + + fn is_in_no_type_check(&self) -> bool { + match self.no_type_check { + InNoTypeCheck::Possibly => { + // Accessing the semantic index here is fine because + // the index belongs to the same file as for which we emit the diagnostic. + let index = semantic_index(self.db, self.file); + + let scope_id = self.scope.file_scope_id(self.db); + + // Inspect all ancestor function scopes by walking bottom up and infer the function's type. + let mut function_scope_tys = index + .ancestor_scopes(scope_id) + .filter_map(|(_, scope)| scope.node().as_function()) + .map(|node| binding_type(self.db, index.expect_single_definition(node))) + .filter_map(Type::into_function_literal); + + // Iterate over all functions and test if any is decorated with `@no_type_check`. + function_scope_tys.any(|function_ty| { + function_ty.has_known_decorator(self.db, FunctionDecorators::NO_TYPE_CHECK) + }) + } + InNoTypeCheck::Yes => true, + } + } + + /// Are we currently inferring types in a stub file? + pub(crate) fn in_stub(&self) -> bool { + self.file.is_stub(self.db().upcast()) + } + + #[must_use] + pub(crate) fn finish(mut self) -> TypeCheckDiagnostics { + self.bomb.defuse(); + let mut diagnostics = self.diagnostics.into_inner(); + diagnostics.shrink_to_fit(); + diagnostics + } +} + +impl fmt::Debug for InferContext<'_> { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + f.debug_struct("TyContext") + .field("file", &self.file) + .field("diagnostics", &self.diagnostics) + .field("defused", &self.bomb) + .finish() + } +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq, Default)] +pub(crate) enum InNoTypeCheck { + /// The inference might be in a `no_type_check` block but only if any + /// ancestor function is decorated with `@no_type_check`. + #[default] + Possibly, + + /// The inference is known to be in an `@no_type_check` decorated function. + Yes, +} + +/// An abstraction for mutating a diagnostic through the lense of a lint. +/// +/// Callers can build this guard by starting with `InferContext::report_lint`. +/// +/// There are two primary functions of this guard, which mutably derefs to +/// a `Diagnostic`: +/// +/// * On `Drop`, the underlying diagnostic is added to the typing context. +/// * Some convenience methods for mutating the underlying `Diagnostic` +/// in lint context. For example, `LintDiagnosticGuard::set_primary_message` +/// will attach a message to the primary span on the diagnostic. +pub(super) struct LintDiagnosticGuard<'db, 'ctx> { + /// The typing context. + ctx: &'ctx InferContext<'db>, + /// The diagnostic that we want to report. + /// + /// This is always `Some` until the `Drop` impl. + diag: Option<Diagnostic>, + + source: LintSource, +} + +impl LintDiagnosticGuard<'_, '_> { + /// Set the message on the primary annotation for this diagnostic. + /// + /// If a message already exists on the primary annotation, then this + /// overwrites the existing message. + /// + /// This message is associated with the primary annotation created + /// for every `Diagnostic` that uses the `LintDiagnosticGuard` API. + /// Specifically, the annotation is derived from the `TextRange` given to + /// the `InferContext::report_lint` API. + /// + /// Callers can add additional primary or secondary annotations via the + /// `DerefMut` trait implementation to a `Diagnostic`. + pub(super) fn set_primary_message(&mut self, message: impl IntoDiagnosticMessage) { + // N.B. It is normally bad juju to define `self` methods + // on types that implement `Deref`. Instead, it's idiomatic + // to do `fn foo(this: &mut LintDiagnosticGuard)`, which in + // turn forces callers to use + // `LintDiagnosticGuard(&mut guard, message)`. But this is + // supremely annoying for what is expected to be a common + // case. + // + // Moreover, most of the downside that comes from these sorts + // of methods is a semver hazard. Because the deref target type + // could also define a method by the same name, and that leads + // to confusion. But we own all the code involved here and + // there is no semver boundary. So... ¯\_(ツ)_/¯ ---AG + + // OK because we know the diagnostic was constructed with a single + // primary annotation that will always come before any other annotation + // in the diagnostic. (This relies on the `Diagnostic` API not exposing + // any methods for removing annotations or re-ordering them, which is + // true as of 2025-04-11.) + let ann = self.primary_annotation_mut().unwrap(); + ann.set_message(message); + } + + /// Adds a tag on the primary annotation for this diagnostic. + /// + /// This tag is associated with the primary annotation created + /// for every `Diagnostic` that uses the `LintDiagnosticGuard` API. + /// Specifically, the annotation is derived from the `TextRange` given to + /// the `InferContext::report_lint` API. + /// + /// Callers can add additional primary or secondary annotations via the + /// `DerefMut` trait implementation to a `Diagnostic`. + #[expect(dead_code)] + pub(super) fn add_primary_tag(&mut self, tag: DiagnosticTag) { + let ann = self.primary_annotation_mut().unwrap(); + ann.push_tag(tag); + } +} + +impl std::ops::Deref for LintDiagnosticGuard<'_, '_> { + type Target = Diagnostic; + + fn deref(&self) -> &Diagnostic { + // OK because `self.diag` is only `None` within `Drop`. + self.diag.as_ref().unwrap() + } +} + +/// Return a mutable borrow of the diagnostic in this guard. +/// +/// Callers may mutate the diagnostic to add new sub-diagnostics +/// or annotations. +/// +/// The diagnostic is added to the typing context, if appropriate, +/// when this guard is dropped. +impl std::ops::DerefMut for LintDiagnosticGuard<'_, '_> { + fn deref_mut(&mut self) -> &mut Diagnostic { + // OK because `self.diag` is only `None` within `Drop`. + self.diag.as_mut().unwrap() + } +} + +/// Finishes use of this guard. +/// +/// This will add the lint as a diagnostic to the typing context if +/// appropriate. The diagnostic may be skipped, for example, if there is a +/// relevant suppression. +impl Drop for LintDiagnosticGuard<'_, '_> { + fn drop(&mut self) { + // OK because the only way `self.diag` is `None` + // is via this impl, which can only run at most + // once. + let mut diag = self.diag.take().unwrap(); + + diag.sub(SubDiagnostic::new( + Severity::Info, + match self.source { + LintSource::Default => format!("rule `{}` is enabled by default", diag.id()), + LintSource::Cli => format!("rule `{}` was selected on the command line", diag.id()), + LintSource::File => { + format!( + "rule `{}` was selected in the configuration file", + diag.id() + ) + } + }, + )); + + self.ctx.diagnostics.borrow_mut().push(diag); + } +} + +/// A builder for constructing a lint diagnostic guard. +/// +/// This type exists to separate the phases of "check if a diagnostic should +/// be reported" and "build the actual diagnostic." It's why, for example, +/// `InferContext::report_lint` only requires a `LintMetadata` (and a range), +/// but this builder further requires a message before one can mutate the +/// diagnostic. This is because the `LintMetadata` can be used to derive +/// the diagnostic ID and its severity (based on configuration). Combined +/// with a message you get the minimum amount of data required to build a +/// `Diagnostic`. +/// +/// Additionally, the range is used to construct a primary annotation (without +/// a message) using the file current being type checked. The range given to +/// `InferContext::report_lint` must be from the file currently being type +/// checked. +/// +/// If callers need to report a diagnostic with an identifier type other +/// than `DiagnosticId::Lint`, then they should use the more general +/// `InferContext::report_diagnostic` API. But note that this API will not take +/// rule selection or suppressions into account. +/// +/// # When is the diagnostic added? +/// +/// When a builder is not returned by `InferContext::report_lint`, then +/// it is known that the diagnostic should not be reported. This can happen +/// when the diagnostic is disabled or suppressed (among other reasons). +pub(super) struct LintDiagnosticGuardBuilder<'db, 'ctx> { + ctx: &'ctx InferContext<'db>, + id: DiagnosticId, + severity: Severity, + source: LintSource, + primary_span: Span, +} + +impl<'db, 'ctx> LintDiagnosticGuardBuilder<'db, 'ctx> { + fn new( + ctx: &'ctx InferContext<'db>, + lint: &'static LintMetadata, + range: TextRange, + ) -> Option<LintDiagnosticGuardBuilder<'db, 'ctx>> { + // The comment below was copied from the original + // implementation of diagnostic reporting. The code + // has been refactored, but this still kind of looked + // relevant, so I've preserved the note. ---AG + // + // TODO: Don't emit the diagnostic if: + // * The enclosing node contains any syntax errors + // * The rule is disabled for this file. We probably want to introduce a new query that + // returns a rule selector for a given file that respects the package's settings, + // any global pragma comments in the file, and any per-file-ignores. + + if !ctx.db.is_file_open(ctx.file) { + return None; + } + let lint_id = LintId::of(lint); + // Skip over diagnostics if the rule + // is disabled. + let (severity, source) = ctx.db.rule_selection().get(lint_id)?; + // If we're not in type checking mode, + // we can bail now. + if ctx.is_in_no_type_check() { + return None; + } + let id = DiagnosticId::Lint(lint.name()); + + let suppressions = suppressions(ctx.db(), ctx.file()); + if let Some(suppression) = suppressions.find_suppression(range, lint_id) { + ctx.diagnostics.borrow_mut().mark_used(suppression.id()); + return None; + } + + let primary_span = Span::from(ctx.file()).with_range(range); + Some(LintDiagnosticGuardBuilder { + ctx, + id, + severity, + source, + primary_span, + }) + } + + /// Create a new lint diagnostic guard. + /// + /// This initializes a new diagnostic using the given message along with + /// the ID and severity derived from the `LintMetadata` used to create + /// this builder. The diagnostic also includes a primary annotation + /// without a message. To add a message to this primary annotation, use + /// `LintDiagnosticGuard::set_primary_message`. + /// + /// The diagnostic can be further mutated on the guard via its `DerefMut` + /// impl to `Diagnostic`. + pub(super) fn into_diagnostic( + self, + message: impl std::fmt::Display, + ) -> LintDiagnosticGuard<'db, 'ctx> { + let mut diag = Diagnostic::new(self.id, self.severity, message); + // This is why `LintDiagnosticGuard::set_primary_message` exists. + // We add the primary annotation here (because it's required), but + // the optional message can be added later. We could accept it here + // in this `build` method, but we already accept the main diagnostic + // message. So the messages are likely to be quite confusable. + diag.annotate(Annotation::primary(self.primary_span.clone())); + LintDiagnosticGuard { + ctx: self.ctx, + source: self.source, + diag: Some(diag), + } + } +} + +/// An abstraction for mutating a diagnostic. +/// +/// Callers can build this guard by starting with +/// `InferContext::report_diagnostic`. +/// +/// Callers likely should use `LintDiagnosticGuard` via +/// `InferContext::report_lint` instead. This guard is only intended for use +/// with non-lint diagnostics. It is fundamentally lower level and easier to +/// get things wrong by using it. +/// +/// Unlike `LintDiagnosticGuard`, this API does not guarantee that the +/// constructed `Diagnostic` not only has a primary annotation, but its +/// associated file is equivalent to the file being type checked. As a result, +/// if either is violated, then the `Drop` impl on `DiagnosticGuard` will +/// panic. +pub(super) struct DiagnosticGuard<'db, 'ctx> { + ctx: &'ctx InferContext<'db>, + /// The diagnostic that we want to report. + /// + /// This is always `Some` until the `Drop` impl. + diag: Option<Diagnostic>, +} + +impl std::ops::Deref for DiagnosticGuard<'_, '_> { + type Target = Diagnostic; + + fn deref(&self) -> &Diagnostic { + // OK because `self.diag` is only `None` within `Drop`. + self.diag.as_ref().unwrap() + } +} + +/// Return a mutable borrow of the diagnostic in this guard. +/// +/// Callers may mutate the diagnostic to add new sub-diagnostics +/// or annotations. +/// +/// The diagnostic is added to the typing context, if appropriate, +/// when this guard is dropped. +impl std::ops::DerefMut for DiagnosticGuard<'_, '_> { + fn deref_mut(&mut self) -> &mut Diagnostic { + // OK because `self.diag` is only `None` within `Drop`. + self.diag.as_mut().unwrap() + } +} + +/// Finishes use of this guard. +/// +/// This will add the diagnostic to the typing context if appropriate. +/// +/// # Panics +/// +/// This panics when the underlying diagnostic lacks a primary +/// annotation, or if it has one and its file doesn't match the file +/// being type checked. +impl Drop for DiagnosticGuard<'_, '_> { + fn drop(&mut self) { + if std::thread::panicking() { + // Don't submit diagnostics when panicking because they might be incomplete. + return; + } + + // OK because the only way `self.diag` is `None` + // is via this impl, which can only run at most + // once. + let diag = self.diag.take().unwrap(); + + if std::thread::panicking() { + // Don't submit diagnostics when panicking because they might be incomplete. + return; + } + + let Some(ann) = diag.primary_annotation() else { + panic!( + "All diagnostics reported by `InferContext` must have a \ + primary annotation, but diagnostic {id} does not", + id = diag.id(), + ); + }; + + let expected_file = self.ctx.file(); + let got_file = ann.get_span().expect_ty_file(); + assert_eq!( + expected_file, + got_file, + "All diagnostics reported by `InferContext` must have a \ + primary annotation whose file matches the file of the \ + current typing context, but diagnostic {id} has file \ + {got_file:?} and we expected {expected_file:?}", + id = diag.id(), + ); + self.ctx.diagnostics.borrow_mut().push(diag); + } +} + +/// A builder for constructing a diagnostic guard. +/// +/// This type exists to separate the phases of "check if a diagnostic should +/// be reported" and "build the actual diagnostic." It's why, for example, +/// `InferContext::report_diagnostic` only requires an ID and a severity, but +/// this builder further requires a message (with those three things being the +/// minimal amount of information with which to construct a diagnostic) before +/// one can mutate the diagnostic. +pub(super) struct DiagnosticGuardBuilder<'db, 'ctx> { + ctx: &'ctx InferContext<'db>, + id: DiagnosticId, + severity: Severity, +} + +impl<'db, 'ctx> DiagnosticGuardBuilder<'db, 'ctx> { + fn new( + ctx: &'ctx InferContext<'db>, + id: DiagnosticId, + severity: Severity, + ) -> Option<DiagnosticGuardBuilder<'db, 'ctx>> { + if !ctx.db.is_file_open(ctx.file) { + return None; + } + Some(DiagnosticGuardBuilder { ctx, id, severity }) + } + + /// Create a new guard. + /// + /// This initializes a new diagnostic using the given message along with + /// the ID and severity used to create this builder. + /// + /// The diagnostic can be further mutated on the guard via its `DerefMut` + /// impl to `Diagnostic`. + pub(super) fn into_diagnostic( + self, + message: impl std::fmt::Display, + ) -> DiagnosticGuard<'db, 'ctx> { + let diag = Some(Diagnostic::new(self.id, self.severity, message)); + DiagnosticGuard { + ctx: self.ctx, + diag, + } + } +} diff --git a/crates/ty_python_semantic/src/types/definition.rs b/crates/ty_python_semantic/src/types/definition.rs new file mode 100644 index 0000000000000..466673b09f3ea --- /dev/null +++ b/crates/ty_python_semantic/src/types/definition.rs @@ -0,0 +1,40 @@ +use crate::semantic_index::definition::Definition; +use crate::{Db, Module}; +use ruff_db::files::FileRange; +use ruff_db::source::source_text; +use ruff_text_size::{TextLen, TextRange}; + +#[derive(Debug, PartialEq, Eq, Hash)] +pub enum TypeDefinition<'db> { + Module(Module), + Class(Definition<'db>), + Function(Definition<'db>), + TypeVar(Definition<'db>), + TypeAlias(Definition<'db>), +} + +impl TypeDefinition<'_> { + pub fn focus_range(&self, db: &dyn Db) -> Option<FileRange> { + match self { + Self::Module(_) => None, + Self::Class(definition) + | Self::Function(definition) + | Self::TypeVar(definition) + | Self::TypeAlias(definition) => Some(definition.focus_range(db)), + } + } + + pub fn full_range(&self, db: &dyn Db) -> Option<FileRange> { + match self { + Self::Module(module) => { + let file = module.file()?; + let source = source_text(db.upcast(), file); + Some(FileRange::new(file, TextRange::up_to(source.text_len()))) + } + Self::Class(definition) + | Self::Function(definition) + | Self::TypeVar(definition) + | Self::TypeAlias(definition) => Some(definition.full_range(db)), + } + } +} diff --git a/crates/ty_python_semantic/src/types/diagnostic.rs b/crates/ty_python_semantic/src/types/diagnostic.rs new file mode 100644 index 0000000000000..af7c67894758d --- /dev/null +++ b/crates/ty_python_semantic/src/types/diagnostic.rs @@ -0,0 +1,2151 @@ +use super::call::CallErrorKind; +use super::context::InferContext; +use super::mro::DuplicateBaseError; +use super::{CallArgumentTypes, CallDunderError, ClassBase, ClassLiteral, KnownClass}; +use crate::db::Db; +use crate::lint::{Level, LintRegistryBuilder, LintStatus}; +use crate::suppression::FileSuppressionId; +use crate::types::LintDiagnosticGuard; +use crate::types::string_annotation::{ + BYTE_STRING_TYPE_ANNOTATION, ESCAPE_CHARACTER_IN_FORWARD_ANNOTATION, FSTRING_TYPE_ANNOTATION, + IMPLICIT_CONCATENATED_STRING_TYPE_ANNOTATION, INVALID_SYNTAX_IN_FORWARD_ANNOTATION, + RAW_STRING_TYPE_ANNOTATION, +}; +use crate::types::{KnownFunction, KnownInstanceType, Type, protocol_class::ProtocolClassLiteral}; +use crate::{Program, PythonVersionWithSource, declare_lint}; +use ruff_db::diagnostic::{Annotation, Diagnostic, Severity, Span, SubDiagnostic}; +use ruff_db::files::system_path_to_file; +use ruff_python_ast::{self as ast, AnyNodeRef}; +use ruff_python_stdlib::builtins::version_builtin_was_added; +use ruff_text_size::{Ranged, TextRange}; +use rustc_hash::FxHashSet; +use std::fmt::Formatter; + +/// Registers all known type check lints. +pub(crate) fn register_lints(registry: &mut LintRegistryBuilder) { + registry.register_lint(&CALL_NON_CALLABLE); + registry.register_lint(&CALL_POSSIBLY_UNBOUND_METHOD); + registry.register_lint(&CONFLICTING_ARGUMENT_FORMS); + registry.register_lint(&CONFLICTING_DECLARATIONS); + registry.register_lint(&CONFLICTING_METACLASS); + registry.register_lint(&CYCLIC_CLASS_DEFINITION); + registry.register_lint(&DIVISION_BY_ZERO); + registry.register_lint(&DUPLICATE_BASE); + registry.register_lint(&INCOMPATIBLE_SLOTS); + registry.register_lint(&INCONSISTENT_MRO); + registry.register_lint(&INDEX_OUT_OF_BOUNDS); + registry.register_lint(&INVALID_ARGUMENT_TYPE); + registry.register_lint(&INVALID_RETURN_TYPE); + registry.register_lint(&INVALID_ASSIGNMENT); + registry.register_lint(&INVALID_BASE); + registry.register_lint(&INVALID_CONTEXT_MANAGER); + registry.register_lint(&INVALID_DECLARATION); + registry.register_lint(&INVALID_EXCEPTION_CAUGHT); + registry.register_lint(&INVALID_GENERIC_CLASS); + registry.register_lint(&INVALID_LEGACY_TYPE_VARIABLE); + registry.register_lint(&INVALID_TYPE_ALIAS_TYPE); + registry.register_lint(&INVALID_METACLASS); + registry.register_lint(&INVALID_OVERLOAD); + registry.register_lint(&INVALID_PARAMETER_DEFAULT); + registry.register_lint(&INVALID_PROTOCOL); + registry.register_lint(&INVALID_RAISE); + registry.register_lint(&INVALID_SUPER_ARGUMENT); + registry.register_lint(&INVALID_TYPE_CHECKING_CONSTANT); + registry.register_lint(&INVALID_TYPE_FORM); + registry.register_lint(&INVALID_TYPE_VARIABLE_CONSTRAINTS); + registry.register_lint(&MISSING_ARGUMENT); + registry.register_lint(&NO_MATCHING_OVERLOAD); + registry.register_lint(&NON_SUBSCRIPTABLE); + registry.register_lint(&NOT_ITERABLE); + registry.register_lint(&UNSUPPORTED_BOOL_CONVERSION); + registry.register_lint(&PARAMETER_ALREADY_ASSIGNED); + registry.register_lint(&POSSIBLY_UNBOUND_ATTRIBUTE); + registry.register_lint(&POSSIBLY_UNBOUND_IMPORT); + registry.register_lint(&POSSIBLY_UNRESOLVED_REFERENCE); + registry.register_lint(&SUBCLASS_OF_FINAL_CLASS); + registry.register_lint(&TYPE_ASSERTION_FAILURE); + registry.register_lint(&TOO_MANY_POSITIONAL_ARGUMENTS); + registry.register_lint(&UNAVAILABLE_IMPLICIT_SUPER_ARGUMENTS); + registry.register_lint(&UNDEFINED_REVEAL); + registry.register_lint(&UNKNOWN_ARGUMENT); + registry.register_lint(&UNRESOLVED_ATTRIBUTE); + registry.register_lint(&UNRESOLVED_IMPORT); + registry.register_lint(&UNRESOLVED_REFERENCE); + registry.register_lint(&UNSUPPORTED_BASE); + registry.register_lint(&UNSUPPORTED_OPERATOR); + registry.register_lint(&ZERO_STEPSIZE_IN_SLICE); + registry.register_lint(&STATIC_ASSERT_ERROR); + registry.register_lint(&INVALID_ATTRIBUTE_ACCESS); + registry.register_lint(&REDUNDANT_CAST); + + // String annotations + registry.register_lint(&BYTE_STRING_TYPE_ANNOTATION); + registry.register_lint(&ESCAPE_CHARACTER_IN_FORWARD_ANNOTATION); + registry.register_lint(&FSTRING_TYPE_ANNOTATION); + registry.register_lint(&IMPLICIT_CONCATENATED_STRING_TYPE_ANNOTATION); + registry.register_lint(&INVALID_SYNTAX_IN_FORWARD_ANNOTATION); + registry.register_lint(&RAW_STRING_TYPE_ANNOTATION); +} + +declare_lint! { + /// ## What it does + /// Checks for calls to non-callable objects. + /// + /// ## Why is this bad? + /// Calling a non-callable object will raise a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// 4() # TypeError: 'int' object is not callable + /// ``` + pub(crate) static CALL_NON_CALLABLE = { + summary: "detects calls to non-callable objects", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for calls to possibly unbound methods. + /// + /// ## Why is this bad? + /// Calling an unbound method will raise an `AttributeError` at runtime. + pub(crate) static CALL_POSSIBLY_UNBOUND_METHOD = { + summary: "detects calls to possibly unbound methods", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks whether an argument is used as both a value and a type form in a call. + /// + /// ## Why is this bad? + /// Such calls have confusing semantics and often indicate a logic error. + /// + /// ## Examples + /// ```python + /// from typing import reveal_type + /// from ty_extensions import is_fully_static + /// + /// if flag: + /// f = repr # Expects a value + /// else: + /// f = is_fully_static # Expects a type form + /// + /// f(int) # error + /// ``` + pub(crate) static CONFLICTING_ARGUMENT_FORMS = { + summary: "detects when an argument is used as both a value and a type form in a call", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks whether a variable has been declared as two conflicting types. + /// + /// ## Why is this bad + /// A variable with two conflicting declarations likely indicates a mistake. + /// Moreover, it could lead to incorrect or ill-defined type inference for + /// other code that relies on these variables. + /// + /// ## Examples + /// ```python + /// if b: + /// a: int + /// else: + /// a: str + /// + /// a = 1 + /// ``` + pub(crate) static CONFLICTING_DECLARATIONS = { + summary: "detects conflicting declarations", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for class definitions where the metaclass of the class + /// being created would not be a subclass of the metaclasses of + /// all the class's bases. + /// + /// ## Why is it bad? + /// Such a class definition raises a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// class M1(type): ... + /// class M2(type): ... + /// class A(metaclass=M1): ... + /// class B(metaclass=M2): ... + /// + /// # TypeError: metaclass conflict + /// class C(A, B): ... + /// ``` + pub(crate) static CONFLICTING_METACLASS = { + summary: "detects conflicting metaclasses", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for class definitions in stub files that inherit + /// (directly or indirectly) from themselves. + /// + /// ## Why is it bad? + /// Although forward references are natively supported in stub files, + /// inheritance cycles are still disallowed, as it is impossible to + /// resolve a consistent [method resolution order] for a class that + /// inherits from itself. + /// + /// ## Examples + /// ```python + /// # foo.pyi + /// class A(B): ... + /// class B(A): ... + /// ``` + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + pub(crate) static CYCLIC_CLASS_DEFINITION = { + summary: "detects cyclic class definitions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// It detects division by zero. + /// + /// ## Why is this bad? + /// Dividing by zero raises a `ZeroDivisionError` at runtime. + /// + /// ## Examples + /// ```python + /// 5 / 0 + /// ``` + pub(crate) static DIVISION_BY_ZERO = { + summary: "detects division by zero", + status: LintStatus::preview("1.0.0"), + default_level: Level::Ignore, + } +} + +declare_lint! { + /// ## What it does + /// Checks for class definitions with duplicate bases. + /// + /// ## Why is this bad? + /// Class definitions with duplicate bases raise `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// class A: ... + /// + /// # TypeError: duplicate base class + /// class B(A, A): ... + /// ``` + pub(crate) static DUPLICATE_BASE = { + summary: "detects class definitions with duplicate bases", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for classes whose bases define incompatible `__slots__`. + /// + /// ## Why is this bad? + /// Inheriting from bases with incompatible `__slots__`s + /// will lead to a `TypeError` at runtime. + /// + /// Classes with no or empty `__slots__` are always compatible: + /// + /// ```python + /// class A: ... + /// class B: + /// __slots__ = () + /// class C: + /// __slots__ = ("a", "b") + /// + /// # fine + /// class D(A, B, C): ... + /// ``` + /// + /// Multiple inheritance from more than one different class + /// defining non-empty `__slots__` is not allowed: + /// + /// ```python + /// class A: + /// __slots__ = ("a", "b") + /// + /// class B: + /// __slots__ = ("a", "b") # Even if the values are the same + /// + /// # TypeError: multiple bases have instance lay-out conflict + /// class C(A, B): ... + /// ``` + /// + /// ## Known problems + /// Dynamic (not tuple or string literal) `__slots__` are not checked. + /// Additionally, classes inheriting from built-in classes with implicit layouts + /// like `str` or `int` are also not checked. + /// + /// ```pycon + /// >>> hasattr(int, "__slots__") + /// False + /// >>> hasattr(str, "__slots__") + /// False + /// >>> class A(int, str): ... + /// Traceback (most recent call last): + /// File "<python-input-0>", line 1, in <module> + /// class A(int, str): ... + /// TypeError: multiple bases have instance lay-out conflict + /// ``` + pub(crate) static INCOMPATIBLE_SLOTS = { + summary: "detects class definitions whose MRO has conflicting `__slots__`", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for invalidly defined protocol classes. + /// + /// ## Why is this bad? + /// An invalidly defined protocol class may lead to the type checker inferring + /// unexpected things. It may also lead to `TypeError`s at runtime. + /// + /// ## Examples + /// A `Protocol` class cannot inherit from a non-`Protocol` class; + /// this raises a `TypeError` at runtime: + /// + /// ```pycon + /// >>> from typing import Protocol + /// >>> class Foo(int, Protocol): ... + /// ... + /// Traceback (most recent call last): + /// File "<python-input-1>", line 1, in <module> + /// class Foo(int, Protocol): ... + /// TypeError: Protocols can only inherit from other protocols, got <class 'int'> + /// ``` + pub(crate) static INVALID_PROTOCOL = { + summary: "detects invalid protocol class definitions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for classes with an inconsistent [method resolution order] (MRO). + /// + /// ## Why is this bad? + /// Classes with an inconsistent MRO will raise a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// class A: ... + /// class B(A): ... + /// + /// # TypeError: Cannot create a consistent method resolution order + /// class C(A, B): ... + /// ``` + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + pub(crate) static INCONSISTENT_MRO = { + summary: "detects class definitions with an inconsistent MRO", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for attempts to use an out of bounds index to get an item from + /// a container. + /// + /// ## Why is this bad? + /// Using an out of bounds index will raise an `IndexError` at runtime. + /// + /// ## Examples + /// ```python + /// t = (0, 1, 2) + /// t[3] # IndexError: tuple index out of range + /// ``` + pub(crate) static INDEX_OUT_OF_BOUNDS = { + summary: "detects index out of bounds errors", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Detects call arguments whose type is not assignable to the corresponding typed parameter. + /// + /// ## Why is this bad? + /// Passing an argument of a type the function (or callable object) does not accept violates + /// the expectations of the function author and may cause unexpected runtime errors within the + /// body of the function. + /// + /// ## Examples + /// ```python + /// def func(x: int): ... + /// func("foo") # error: [invalid-argument-type] + /// ``` + pub(crate) static INVALID_ARGUMENT_TYPE = { + summary: "detects call arguments whose type is not assignable to the corresponding typed parameter", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Detects returned values that can't be assigned to the function's annotated return type. + /// + /// ## Why is this bad? + /// Returning an object of a type incompatible with the annotated return type may cause confusion to the user calling the function. + /// + /// ## Examples + /// ```python + /// def func() -> int: + /// return "a" # error: [invalid-return-type] + /// ``` + pub(crate) static INVALID_RETURN_TYPE = { + summary: "detects returned values that can't be assigned to the function's annotated return type", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for assignments where the type of the value + /// is not [assignable to] the type of the assignee. + /// + /// ## Why is this bad? + /// Such assignments break the rules of the type system and + /// weaken a type checker's ability to accurately reason about your code. + /// + /// ## Examples + /// ```python + /// a: int = '' + /// ``` + /// + /// [assignable to]: https://typing.python.org/en/latest/spec/glossary.html#term-assignable + pub(crate) static INVALID_ASSIGNMENT = { + summary: "detects invalid assignments", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for class definitions that have bases which are not instances of `type`. + /// + /// ## Why is this bad? + /// Class definitions with bases like this will lead to `TypeError` being raised at runtime. + /// + /// ## Examples + /// ```python + /// class A(42): ... # error: [invalid-base] + /// ``` + pub(crate) static INVALID_BASE = { + summary: "detects class bases that will cause the class definition to raise an exception at runtime", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for class definitions that have bases which are unsupported by ty. + /// + /// ## Why is this bad? + /// If a class has a base that is an instance of a complex type such as a union type, + /// ty will not be able to resolve the [method resolution order] (MRO) for the class. + /// This will lead to an inferior understanding of your codebase and unpredictable + /// type-checking behavior. + /// + /// ## Examples + /// ```python + /// import datetime + /// + /// class A: ... + /// class B: ... + /// + /// if datetime.date.today().weekday() != 6: + /// C = A + /// else: + /// C = B + /// + /// class D(C): ... # error: [unsupported-base] + /// ``` + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + pub(crate) static UNSUPPORTED_BASE = { + summary: "detects class bases that are unsupported as ty could not feasibly calculate the class's MRO", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks for expressions used in `with` statements + /// that do not implement the context manager protocol. + /// + /// ## Why is this bad? + /// Such a statement will raise `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// # TypeError: 'int' object does not support the context manager protocol + /// with 1: + /// print(2) + /// ``` + pub(crate) static INVALID_CONTEXT_MANAGER = { + summary: "detects expressions used in with statements that don't implement the context manager protocol", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for declarations where the inferred type of an existing symbol + /// is not [assignable to] its post-hoc declared type. + /// + /// ## Why is this bad? + /// Such declarations break the rules of the type system and + /// weaken a type checker's ability to accurately reason about your code. + /// + /// ## Examples + /// ```python + /// a = 1 + /// a: str + /// ``` + /// + /// [assignable to]: https://typing.python.org/en/latest/spec/glossary.html#term-assignable + pub(crate) static INVALID_DECLARATION = { + summary: "detects invalid declarations", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for exception handlers that catch non-exception classes. + /// + /// ## Why is this bad? + /// Catching classes that do not inherit from `BaseException` will raise a TypeError at runtime. + /// + /// ## Example + /// ```python + /// try: + /// 1 / 0 + /// except 1: + /// ... + /// ``` + /// + /// Use instead: + /// ```python + /// try: + /// 1 / 0 + /// except ZeroDivisionError: + /// ... + /// ``` + /// + /// ## References + /// - [Python documentation: except clause](https://docs.python.org/3/reference/compound_stmts.html#except-clause) + /// - [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions) + /// + /// ## Ruff rule + /// This rule corresponds to Ruff's [`except-with-non-exception-classes` (`B030`)](https://docs.astral.sh/ruff/rules/except-with-non-exception-classes) + pub(crate) static INVALID_EXCEPTION_CAUGHT = { + summary: "detects exception handlers that catch classes that do not inherit from `BaseException`", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for the creation of invalid generic classes + /// + /// ## Why is this bad? + /// There are several requirements that you must follow when defining a generic class. + /// + /// ## Examples + /// ```python + /// from typing import Generic, TypeVar + /// + /// T = TypeVar("T") # okay + /// + /// # error: class uses both PEP-695 syntax and legacy syntax + /// class C[U](Generic[T]): ... + /// ``` + /// + /// ## References + /// - [Typing spec: Generics](https://typing.python.org/en/latest/spec/generics.html#introduction) + pub(crate) static INVALID_GENERIC_CLASS = { + summary: "detects invalid generic classes", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for the creation of invalid legacy `TypeVar`s + /// + /// ## Why is this bad? + /// There are several requirements that you must follow when creating a legacy `TypeVar`. + /// + /// ## Examples + /// ```python + /// from typing import TypeVar + /// + /// T = TypeVar("T") # okay + /// Q = TypeVar("S") # error: TypeVar name must match the variable it's assigned to + /// T = TypeVar("T") # error: TypeVars should not be redefined + /// + /// # error: TypeVar must be immediately assigned to a variable + /// def f(t: TypeVar("U")): ... + /// ``` + /// + /// ## References + /// - [Typing spec: Generics](https://typing.python.org/en/latest/spec/generics.html#introduction) + pub(crate) static INVALID_LEGACY_TYPE_VARIABLE = { + summary: "detects invalid legacy type variables", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for the creation of invalid `TypeAliasType`s + /// + /// ## Why is this bad? + /// There are several requirements that you must follow when creating a `TypeAliasType`. + /// + /// ## Examples + /// ```python + /// from typing import TypeAliasType + /// + /// IntOrStr = TypeAliasType("IntOrStr", int | str) # okay + /// NewAlias = TypeAliasType(get_name(), int) # error: TypeAliasType name must be a string literal + /// ``` + pub(crate) static INVALID_TYPE_ALIAS_TYPE = { + summary: "detects invalid TypeAliasType definitions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for arguments to `metaclass=` that are invalid. + /// + /// ## Why is this bad? + /// Python allows arbitrary expressions to be used as the argument to `metaclass=`. + /// These expressions, however, need to be callable and accept the same arguments + /// as `type.__new__`. + /// + /// ## Example + /// + /// ```python + /// def f(): ... + /// + /// # TypeError: f() takes 0 positional arguments but 3 were given + /// class B(metaclass=f): ... + /// ``` + /// + /// ## References + /// - [Python documentation: Metaclasses](https://docs.python.org/3/reference/datamodel.html#metaclasses) + pub(crate) static INVALID_METACLASS = { + summary: "detects invalid `metaclass=` arguments", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for various invalid `@overload` usages. + /// + /// ## Why is this bad? + /// The `@overload` decorator is used to define functions and methods that accepts different + /// combinations of arguments and return different types based on the arguments passed. This is + /// mainly beneficial for type checkers. But, if the `@overload` usage is invalid, the type + /// checker may not be able to provide correct type information. + /// + /// ## Example + /// + /// Defining only one overload: + /// + /// ```py + /// from typing import overload + /// + /// @overload + /// def foo(x: int) -> int: ... + /// def foo(x: int | None) -> int | None: + /// return x + /// ``` + /// + /// Or, not providing an implementation for the overloaded definition: + /// + /// ```py + /// from typing import overload + /// + /// @overload + /// def foo() -> None: ... + /// @overload + /// def foo(x: int) -> int: ... + /// ``` + /// + /// ## References + /// - [Python documentation: `@overload`](https://docs.python.org/3/library/typing.html#typing.overload) + pub(crate) static INVALID_OVERLOAD = { + summary: "detects invalid `@overload` usages", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for default values that can't be + /// assigned to the parameter's annotated type. + /// + /// ## Why is this bad? + /// This breaks the rules of the type system and + /// weakens a type checker's ability to accurately reason about your code. + /// + /// ## Examples + /// ```python + /// def f(a: int = ''): ... + /// ``` + pub(crate) static INVALID_PARAMETER_DEFAULT = { + summary: "detects default values that can't be assigned to the parameter's annotated type", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// Checks for `raise` statements that raise non-exceptions or use invalid + /// causes for their raised exceptions. + /// + /// ## Why is this bad? + /// Only subclasses or instances of `BaseException` can be raised. + /// For an exception's cause, the same rules apply, except that `None` is also + /// permitted. Violating these rules results in a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// def f(): + /// try: + /// something() + /// except NameError: + /// raise "oops!" from f + /// + /// def g(): + /// raise NotImplemented from 42 + /// ``` + /// + /// Use instead: + /// ```python + /// def f(): + /// try: + /// something() + /// except NameError as e: + /// raise RuntimeError("oops!") from e + /// + /// def g(): + /// raise NotImplementedError from None + /// ``` + /// + /// ## References + /// - [Python documentation: The `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#raise) + /// - [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions) + pub(crate) static INVALID_RAISE = { + summary: "detects `raise` statements that raise invalid exceptions or use invalid causes", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Detects `super()` calls where: + /// - the first argument is not a valid class literal, or + /// - the second argument is not an instance or subclass of the first argument. + /// + /// ## Why is this bad? + /// `super(type, obj)` expects: + /// - the first argument to be a class, + /// - and the second argument to satisfy one of the following: + /// - `isinstance(obj, type)` is `True` + /// - `issubclass(obj, type)` is `True` + /// + /// Violating this relationship will raise a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// class A: + /// ... + /// class B(A): + /// ... + /// + /// super(A, B()) # it's okay! `A` satisfies `isinstance(B(), A)` + /// + /// super(A(), B()) # error: `A()` is not a class + /// + /// super(B, A()) # error: `A()` does not satisfy `isinstance(A(), B)` + /// super(B, A) # error: `A` does not satisfy `issubclass(A, B)` + /// ``` + /// + /// ## References + /// - [Python documentation: super()](https://docs.python.org/3/library/functions.html#super) + pub(crate) static INVALID_SUPER_ARGUMENT = { + summary: "detects invalid arguments for `super()`", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for a value other than `False` assigned to the `TYPE_CHECKING` variable, or an + /// annotation not assignable from `bool`. + /// + /// ## Why is this bad? + /// The name `TYPE_CHECKING` is reserved for a flag that can be used to provide conditional + /// code seen only by the type checker, and not at runtime. Normally this flag is imported from + /// `typing` or `typing_extensions`, but it can also be defined locally. If defined locally, it + /// must be assigned the value `False` at runtime; the type checker will consider its value to + /// be `True`. If annotated, it must be annotated as a type that can accept `bool` values. + /// + /// ## Examples + /// ```python + /// TYPE_CHECKING: str + /// TYPE_CHECKING = '' + /// ``` + pub(crate) static INVALID_TYPE_CHECKING_CONSTANT = { + summary: "detects invalid `TYPE_CHECKING` constant assignments", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for expressions that are used as [type expressions] + /// but cannot validly be interpreted as such. + /// + /// ## Why is this bad? + /// Such expressions cannot be understood by ty. + /// In some cases, they might raise errors at runtime. + /// + /// ## Examples + /// ```python + /// from typing import Annotated + /// + /// a: type[1] # `1` is not a type + /// b: Annotated[int] # `Annotated` expects at least two arguments + /// ``` + /// [type expressions]: https://typing.python.org/en/latest/spec/annotations.html#type-and-annotation-expressions + pub(crate) static INVALID_TYPE_FORM = { + summary: "detects invalid type forms", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for constrained [type variables] with only one constraint. + /// + /// ## Why is this bad? + /// A constrained type variable must have at least two constraints. + /// + /// ## Examples + /// ```python + /// from typing import TypeVar + /// + /// T = TypeVar('T', str) # invalid constrained TypeVar + /// ``` + /// + /// Use instead: + /// ```python + /// T = TypeVar('T', str, int) # valid constrained TypeVar + /// # or + /// T = TypeVar('T', bound=str) # valid bound TypeVar + /// ``` + /// + /// [type variables]: https://docs.python.org/3/library/typing.html#typing.TypeVar + pub(crate) static INVALID_TYPE_VARIABLE_CONSTRAINTS = { + summary: "detects invalid type variable constraints", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for missing required arguments in a call. + /// + /// ## Why is this bad? + /// Failing to provide a required argument will raise a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// def func(x: int): ... + /// func() # TypeError: func() missing 1 required positional argument: 'x' + /// ``` + pub(crate) static MISSING_ARGUMENT = { + summary: "detects missing required arguments in a call", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for calls to an overloaded function that do not match any of the overloads. + /// + /// ## Why is this bad? + /// Failing to provide the correct arguments to one of the overloads will raise a `TypeError` + /// at runtime. + /// + /// ## Examples + /// ```python + /// @overload + /// def func(x: int): ... + /// @overload + /// def func(x: bool): ... + /// func("string") # error: [no-matching-overload] + /// ``` + pub(crate) static NO_MATCHING_OVERLOAD = { + summary: "detects calls that do not match any overload", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for subscripting objects that do not support subscripting. + /// + /// ## Why is this bad? + /// Subscripting an object that does not support it will raise a `TypeError` at runtime. + /// + /// ## Examples + /// ```python + /// 4[1] # TypeError: 'int' object is not subscriptable + /// ``` + pub(crate) static NON_SUBSCRIPTABLE = { + summary: "detects subscripting objects that do not support subscripting", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for objects that are not iterable but are used in a context that requires them to be. + /// + /// ## Why is this bad? + /// Iterating over an object that is not iterable will raise a `TypeError` at runtime. + /// + /// ## Examples + /// + /// ```python + /// for i in 34: # TypeError: 'int' object is not iterable + /// pass + /// ``` + pub(crate) static NOT_ITERABLE = { + summary: "detects iteration over an object that is not iterable", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for bool conversions where the object doesn't correctly implement `__bool__`. + /// + /// ## Why is this bad? + /// If an exception is raised when you attempt to evaluate the truthiness of an object, + /// using the object in a boolean context will fail at runtime. + /// + /// ## Examples + /// + /// ```python + /// class NotBoolable: + /// __bool__ = None + /// + /// b1 = NotBoolable() + /// b2 = NotBoolable() + /// + /// if b1: # exception raised here + /// pass + /// + /// b1 and b2 # exception raised here + /// not b1 # exception raised here + /// b1 < b2 < b1 # exception raised here + /// ``` + pub(crate) static UNSUPPORTED_BOOL_CONVERSION = { + summary: "detects boolean conversion where the object incorrectly implements `__bool__`", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for calls which provide more than one argument for a single parameter. + /// + /// ## Why is this bad? + /// Providing multiple values for a single parameter will raise a `TypeError` at runtime. + /// + /// ## Examples + /// + /// ```python + /// def f(x: int) -> int: ... + /// + /// f(1, x=2) # Error raised here + /// ``` + pub(crate) static PARAMETER_ALREADY_ASSIGNED = { + summary: "detects multiple arguments for the same parameter", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for possibly unbound attributes. + /// + /// ## Why is this bad? + /// Attempting to access an unbound attribute will raise an `AttributeError` at runtime. + /// + /// ## Examples + /// ```python + /// class A: + /// if b: + /// c = 0 + /// + /// A.c # AttributeError: type object 'A' has no attribute 'c' + /// ``` + pub(crate) static POSSIBLY_UNBOUND_ATTRIBUTE = { + summary: "detects references to possibly unbound attributes", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks for imports of symbols that may be unbound. + /// + /// ## Why is this bad? + /// Importing an unbound module or name will raise a `ModuleNotFoundError` + /// or `ImportError` at runtime. + /// + /// ## Examples + /// ```python + /// # module.py + /// import datetime + /// + /// if datetime.date.today().weekday() != 6: + /// a = 1 + /// + /// # main.py + /// from module import a # ImportError: cannot import name 'a' from 'module' + /// ``` + pub(crate) static POSSIBLY_UNBOUND_IMPORT = { + summary: "detects possibly unbound imports", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks for references to names that are possibly not defined. + /// + /// ## Why is this bad? + /// Using an undefined variable will raise a `NameError` at runtime. + /// + /// ## Example + /// + /// ```python + /// for i in range(0): + /// x = i + /// + /// print(x) # NameError: name 'x' is not defined + /// ``` + pub(crate) static POSSIBLY_UNRESOLVED_REFERENCE = { + summary: "detects references to possibly undefined names", + status: LintStatus::preview("1.0.0"), + default_level: Level::Ignore, + } +} + +declare_lint! { + /// ## What it does + /// Checks for classes that subclass final classes. + /// + /// ## Why is this bad? + /// Decorating a class with `@final` declares to the type checker that it should not be subclassed. + /// + /// ## Example + /// + /// ```python + /// from typing import final + /// + /// @final + /// class A: ... + /// class B(A): ... # Error raised here + /// ``` + pub(crate) static SUBCLASS_OF_FINAL_CLASS = { + summary: "detects subclasses of final classes", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for `assert_type()` and `assert_never()` calls where the actual type + /// is not the same as the asserted type. + /// + /// ## Why is this bad? + /// `assert_type()` allows confirming the inferred type of a certain value. + /// + /// ## Example + /// + /// ```python + /// def _(x: int): + /// assert_type(x, int) # fine + /// assert_type(x, str) # error: Actual type does not match asserted type + /// ``` + pub(crate) static TYPE_ASSERTION_FAILURE = { + summary: "detects failed type assertions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for calls that pass more positional arguments than the callable can accept. + /// + /// ## Why is this bad? + /// Passing too many positional arguments will raise `TypeError` at runtime. + /// + /// ## Example + /// + /// ```python + /// def f(): ... + /// + /// f("foo") # Error raised here + /// ``` + pub(crate) static TOO_MANY_POSITIONAL_ARGUMENTS = { + summary: "detects calls passing too many positional arguments", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Detects invalid `super()` calls where implicit arguments like the enclosing class or first method argument are unavailable. + /// + /// ## Why is this bad? + /// When `super()` is used without arguments, Python tries to find two things: + /// the nearest enclosing class and the first argument of the immediately enclosing function (typically self or cls). + /// If either of these is missing, the call will fail at runtime with a `RuntimeError`. + /// + /// ## Examples + /// ```python + /// super() # error: no enclosing class or function found + /// + /// def func(): + /// super() # error: no enclosing class or first argument exists + /// + /// class A: + /// f = super() # error: no enclosing function to provide the first argument + /// + /// def method(self): + /// def nested(): + /// super() # error: first argument does not exist in this nested function + /// + /// lambda: super() # error: first argument does not exist in this lambda + /// + /// (super() for _ in range(10)) # error: argument is not available in generator expression + /// + /// super() # okay! both enclosing class and first argument are available + /// ``` + /// + /// ## References + /// - [Python documentation: super()](https://docs.python.org/3/library/functions.html#super) + pub(crate) static UNAVAILABLE_IMPLICIT_SUPER_ARGUMENTS = { + summary: "detects invalid `super()` calls where implicit arguments are unavailable.", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for calls to `reveal_type` without importing it. + /// + /// ## Why is this bad? + /// Using `reveal_type` without importing it will raise a `NameError` at runtime. + /// + /// ## Examples + /// ```python + /// reveal_type(1) # NameError: name 'reveal_type' is not defined + /// ``` + pub(crate) static UNDEFINED_REVEAL = { + summary: "detects usages of `reveal_type` without importing it", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +declare_lint! { + /// ## What it does + /// Checks for keyword arguments in calls that don't match any parameter of the callable. + /// + /// ## Why is this bad? + /// Providing an unknown keyword argument will raise `TypeError` at runtime. + /// + /// ## Example + /// + /// ```python + /// def f(x: int) -> int: ... + /// + /// f(x=1, y=2) # Error raised here + /// ``` + pub(crate) static UNKNOWN_ARGUMENT = { + summary: "detects unknown keyword arguments in calls", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for unresolved attributes. + /// + /// ## Why is this bad? + /// Accessing an unbound attribute will raise an `AttributeError` at runtime. + /// An unresolved attribute is not guaranteed to exist from the type alone, + /// so this could also indicate that the object is not of the type that the user expects. + /// + /// ## Examples + /// ```python + /// class A: ... + /// + /// A().foo # AttributeError: 'A' object has no attribute 'foo' + /// ``` + pub(crate) static UNRESOLVED_ATTRIBUTE = { + summary: "detects references to unresolved attributes", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for import statements for which the module cannot be resolved. + /// + /// ## Why is this bad? + /// Importing a module that cannot be resolved will raise a `ModuleNotFoundError` + /// at runtime. + /// + /// ## Examples + /// ```python + /// import foo # ModuleNotFoundError: No module named 'foo' + /// ``` + pub(crate) static UNRESOLVED_IMPORT = { + summary: "detects unresolved imports", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for references to names that are not defined. + /// + /// ## Why is this bad? + /// Using an undefined variable will raise a `NameError` at runtime. + /// + /// ## Example + /// + /// ```python + /// print(x) # NameError: name 'x' is not defined + /// ``` + pub(crate) static UNRESOLVED_REFERENCE = { + summary: "detects references to names that are not defined", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for binary expressions, comparisons, and unary expressions where + /// the operands don't support the operator. + /// + /// ## Why is this bad? + /// Attempting to use an unsupported operator will raise a `TypeError` at + /// runtime. + /// + /// ## Examples + /// ```python + /// class A: ... + /// + /// A() + A() # TypeError: unsupported operand type(s) for +: 'A' and 'A' + /// ``` + pub(crate) static UNSUPPORTED_OPERATOR = { + summary: "detects binary, unary, or comparison expressions where the operands don't support the operator", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for step size 0 in slices. + /// + /// ## Why is this bad? + /// A slice with a step size of zero will raise a `ValueError` at runtime. + /// + /// ## Examples + /// ```python + /// l = list(range(10)) + /// l[1:10:0] # ValueError: slice step cannot be zero + /// ``` + pub(crate) static ZERO_STEPSIZE_IN_SLICE = { + summary: "detects a slice step size of zero", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Makes sure that the argument of `static_assert` is statically known to be true. + /// + /// ## Why is this bad? + /// A `static_assert` call represents an explicit request from the user + /// for the type checker to emit an error if the argument cannot be verified + /// to evaluate to `True` in a boolean context. + /// + /// ## Examples + /// ```python + /// from ty_extensions import static_assert + /// + /// static_assert(1 + 1 == 3) # error: evaluates to `False` + /// + /// static_assert(int(2.0 * 3.0) == 6) # error: does not have a statically known truthiness + /// ``` + pub(crate) static STATIC_ASSERT_ERROR = { + summary: "Failed static assertion", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for assignments to class variables from instances + /// and assignments to instance variables from its class. + /// + /// ## Why is this bad? + /// Incorrect assignments break the rules of the type system and + /// weaken a type checker's ability to accurately reason about your code. + /// + /// ## Examples + /// ```python + /// class C: + /// class_var: ClassVar[int] = 1 + /// instance_var: int + /// + /// C.class_var = 3 # okay + /// C().class_var = 3 # error: Cannot assign to class variable + /// + /// C().instance_var = 3 # okay + /// C.instance_var = 3 # error: Cannot assign to instance variable + /// ``` + pub(crate) static INVALID_ATTRIBUTE_ACCESS = { + summary: "Invalid attribute access", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Detects redundant `cast` calls where the value already has the target type. + /// + /// ## Why is this bad? + /// These casts have no effect and can be removed. + /// + /// ## Example + /// ```python + /// def f() -> int: + /// return 10 + /// + /// cast(int, f()) # Redundant + /// ``` + pub(crate) static REDUNDANT_CAST = { + summary: "detects redundant `cast` calls", + status: LintStatus::preview("1.0.0"), + default_level: Level::Warn, + } +} + +/// A collection of type check diagnostics. +#[derive(Default, Eq, PartialEq)] +pub struct TypeCheckDiagnostics { + diagnostics: Vec<Diagnostic>, + used_suppressions: FxHashSet<FileSuppressionId>, +} + +impl TypeCheckDiagnostics { + pub(crate) fn push(&mut self, diagnostic: Diagnostic) { + self.diagnostics.push(diagnostic); + } + + pub(super) fn extend(&mut self, other: &TypeCheckDiagnostics) { + self.diagnostics.extend_from_slice(&other.diagnostics); + self.used_suppressions.extend(&other.used_suppressions); + } + + pub(super) fn extend_diagnostics(&mut self, diagnostics: impl IntoIterator<Item = Diagnostic>) { + self.diagnostics.extend(diagnostics); + } + + pub(crate) fn mark_used(&mut self, suppression_id: FileSuppressionId) { + self.used_suppressions.insert(suppression_id); + } + + pub(crate) fn is_used(&self, suppression_id: FileSuppressionId) -> bool { + self.used_suppressions.contains(&suppression_id) + } + + pub(crate) fn used_len(&self) -> usize { + self.used_suppressions.len() + } + + pub(crate) fn shrink_to_fit(&mut self) { + self.used_suppressions.shrink_to_fit(); + self.diagnostics.shrink_to_fit(); + } + + pub fn iter(&self) -> std::slice::Iter<'_, Diagnostic> { + self.diagnostics.iter() + } +} + +impl std::fmt::Debug for TypeCheckDiagnostics { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.diagnostics.fmt(f) + } +} + +impl IntoIterator for TypeCheckDiagnostics { + type Item = Diagnostic; + type IntoIter = std::vec::IntoIter<Diagnostic>; + + fn into_iter(self) -> Self::IntoIter { + self.diagnostics.into_iter() + } +} + +impl<'a> IntoIterator for &'a TypeCheckDiagnostics { + type Item = &'a Diagnostic; + type IntoIter = std::slice::Iter<'a, Diagnostic>; + + fn into_iter(self) -> Self::IntoIter { + self.diagnostics.iter() + } +} + +/// Emit a diagnostic declaring that an index is out of bounds for a tuple. +pub(super) fn report_index_out_of_bounds( + context: &InferContext, + kind: &'static str, + node: AnyNodeRef, + tuple_ty: Type, + length: usize, + index: i64, +) { + let Some(builder) = context.report_lint(&INDEX_OUT_OF_BOUNDS, node) else { + return; + }; + builder.into_diagnostic(format_args!( + "Index {index} is out of bounds for {kind} `{}` with length {length}", + tuple_ty.display(context.db()) + )); +} + +/// Emit a diagnostic declaring that a type does not support subscripting. +pub(super) fn report_non_subscriptable( + context: &InferContext, + node: AnyNodeRef, + non_subscriptable_ty: Type, + method: &str, +) { + let Some(builder) = context.report_lint(&NON_SUBSCRIPTABLE, node) else { + return; + }; + builder.into_diagnostic(format_args!( + "Cannot subscript object of type `{}` with no `{method}` method", + non_subscriptable_ty.display(context.db()) + )); +} + +pub(super) fn report_slice_step_size_zero(context: &InferContext, node: AnyNodeRef) { + let Some(builder) = context.report_lint(&ZERO_STEPSIZE_IN_SLICE, node) else { + return; + }; + builder.into_diagnostic("Slice step size can not be zero"); +} + +fn report_invalid_assignment_with_message( + context: &InferContext, + node: AnyNodeRef, + target_ty: Type, + message: std::fmt::Arguments, +) { + let Some(builder) = context.report_lint(&INVALID_ASSIGNMENT, node) else { + return; + }; + match target_ty { + Type::ClassLiteral(class) => { + let mut diag = builder.into_diagnostic(format_args!( + "Implicit shadowing of class `{}`", + class.name(context.db()), + )); + diag.info("Annotate to make it explicit if this is intentional"); + } + Type::FunctionLiteral(function) => { + let mut diag = builder.into_diagnostic(format_args!( + "Implicit shadowing of function `{}`", + function.name(context.db()), + )); + diag.info("Annotate to make it explicit if this is intentional"); + } + _ => { + builder.into_diagnostic(message); + } + } +} + +pub(super) fn report_invalid_assignment( + context: &InferContext, + node: AnyNodeRef, + target_ty: Type, + source_ty: Type, +) { + report_invalid_assignment_with_message( + context, + node, + target_ty, + format_args!( + "Object of type `{}` is not assignable to `{}`", + source_ty.display(context.db()), + target_ty.display(context.db()), + ), + ); +} + +pub(super) fn report_invalid_attribute_assignment( + context: &InferContext, + node: AnyNodeRef, + target_ty: Type, + source_ty: Type, + attribute_name: &'_ str, +) { + report_invalid_assignment_with_message( + context, + node, + target_ty, + format_args!( + "Object of type `{}` is not assignable to attribute `{attribute_name}` of type `{}`", + source_ty.display(context.db()), + target_ty.display(context.db()), + ), + ); +} + +pub(super) fn report_invalid_return_type( + context: &InferContext, + object_range: impl Ranged, + return_type_range: impl Ranged, + expected_ty: Type, + actual_ty: Type, +) { + let Some(builder) = context.report_lint(&INVALID_RETURN_TYPE, object_range) else { + return; + }; + + let return_type_span = context.span(return_type_range); + + let mut diag = builder.into_diagnostic("Return type does not match returned value"); + diag.set_primary_message(format_args!( + "expected `{expected_ty}`, found `{actual_ty}`", + expected_ty = expected_ty.display(context.db()), + actual_ty = actual_ty.display(context.db()), + )); + diag.annotate( + Annotation::secondary(return_type_span).message(format_args!( + "Expected `{expected_ty}` because of return type", + expected_ty = expected_ty.display(context.db()), + )), + ); +} + +pub(super) fn report_invalid_generator_function_return_type( + context: &InferContext, + return_type_range: TextRange, + inferred_return: KnownClass, + expected_ty: Type, +) { + let Some(builder) = context.report_lint(&INVALID_RETURN_TYPE, return_type_range) else { + return; + }; + + let mut diag = builder.into_diagnostic("Return type does not match returned value"); + let inferred_ty = inferred_return.display(context.db()); + diag.set_primary_message(format_args!( + "expected `{expected_ty}`, found `{inferred_ty}`", + expected_ty = expected_ty.display(context.db()), + )); + + let (description, link) = if inferred_return == KnownClass::AsyncGeneratorType { + ( + "an async generator function", + "https://docs.python.org/3/glossary.html#term-asynchronous-generator", + ) + } else { + ( + "a generator function", + "https://docs.python.org/3/glossary.html#term-generator", + ) + }; + + diag.info(format_args!( + "Function is inferred as returning `{inferred_ty}` because it is {description}" + )); + diag.info(format_args!("See {link} for more details")); +} + +pub(super) fn report_implicit_return_type( + context: &InferContext, + range: impl Ranged, + expected_ty: Type, + has_empty_body: bool, + enclosing_class_of_method: Option<ClassLiteral>, +) { + let Some(builder) = context.report_lint(&INVALID_RETURN_TYPE, range) else { + return; + }; + let db = context.db(); + let mut diagnostic = builder.into_diagnostic(format_args!( + "Function can implicitly return `None`, which is not assignable to return type `{}`", + expected_ty.display(db) + )); + if !has_empty_body { + return; + } + let Some(class) = enclosing_class_of_method else { + return; + }; + if class + .iter_mro(db, None) + .any(|base| matches!(base, ClassBase::Protocol(_))) + { + diagnostic.info( + "Only functions in stub files, methods on protocol classes, \ + or methods with `@abstractmethod` are permitted to have empty bodies", + ); + diagnostic.info(format_args!( + "Class `{}` has `typing.Protocol` in its MRO, but it is not a protocol class", + class.name(db) + )); + + let mut sub_diagnostic = SubDiagnostic::new( + Severity::Info, + "Only classes that directly inherit from `typing.Protocol` \ + or `typing_extensions.Protocol` are considered protocol classes", + ); + sub_diagnostic.annotate( + Annotation::primary(class.header_span(db)).message(format_args!( + "`Protocol` not present in `{class}`'s immediate bases", + class = class.name(db) + )), + ); + diagnostic.sub(sub_diagnostic); + + diagnostic.info("See https://typing.python.org/en/latest/spec/protocol.html#"); + } +} + +pub(super) fn report_invalid_type_checking_constant(context: &InferContext, node: AnyNodeRef) { + let Some(builder) = context.report_lint(&INVALID_TYPE_CHECKING_CONSTANT, node) else { + return; + }; + builder.into_diagnostic( + "The name TYPE_CHECKING is reserved for use as a flag; only False can be assigned to it", + ); +} + +pub(super) fn report_possibly_unresolved_reference( + context: &InferContext, + expr_name_node: &ast::ExprName, +) { + let Some(builder) = context.report_lint(&POSSIBLY_UNRESOLVED_REFERENCE, expr_name_node) else { + return; + }; + + let ast::ExprName { id, .. } = expr_name_node; + builder.into_diagnostic(format_args!("Name `{id}` used when possibly not defined")); +} + +pub(super) fn report_possibly_unbound_attribute( + context: &InferContext, + target: &ast::ExprAttribute, + attribute: &str, + object_ty: Type, +) { + let Some(builder) = context.report_lint(&POSSIBLY_UNBOUND_ATTRIBUTE, target) else { + return; + }; + builder.into_diagnostic(format_args!( + "Attribute `{attribute}` on type `{}` is possibly unbound", + object_ty.display(context.db()), + )); +} + +pub(super) fn add_inferred_python_version_hint(db: &dyn Db, mut diagnostic: LintDiagnosticGuard) { + let program = Program::get(db); + let PythonVersionWithSource { version, source } = program.python_version_with_source(db); + + match source { + crate::PythonVersionSource::Cli => { + diagnostic.info(format_args!( + "Python {version} was assumed when resolving types because it was specified on the command line", + )); + } + crate::PythonVersionSource::File(path, range) => { + if let Ok(file) = system_path_to_file(db.upcast(), &**path) { + let mut sub_diagnostic = SubDiagnostic::new( + Severity::Info, + format_args!("Python {version} was assumed when resolving types"), + ); + sub_diagnostic.annotate( + Annotation::primary(Span::from(file).with_optional_range(*range)).message( + format_args!("Python {version} assumed due to this configuration setting"), + ), + ); + diagnostic.sub(sub_diagnostic); + } else { + diagnostic.info(format_args!( + "Python {version} was assumed when resolving types because of your configuration file(s)", + )); + } + } + crate::PythonVersionSource::Default => { + diagnostic.info(format_args!( + "Python {version} was assumed when resolving types \ + because it is the newest Python version supported by ty, \ + and neither a command-line argument nor a configuration setting was provided", + )); + } + } +} + +pub(super) fn report_unresolved_reference(context: &InferContext, expr_name_node: &ast::ExprName) { + let Some(builder) = context.report_lint(&UNRESOLVED_REFERENCE, expr_name_node) else { + return; + }; + + let ast::ExprName { id, .. } = expr_name_node; + let mut diagnostic = builder.into_diagnostic(format_args!("Name `{id}` used when not defined")); + if let Some(version_added_to_builtins) = version_builtin_was_added(id) { + diagnostic.info(format_args!( + "`{id}` was added as a builtin in Python 3.{version_added_to_builtins}" + )); + add_inferred_python_version_hint(context.db(), diagnostic); + } +} + +pub(super) fn report_invalid_exception_caught(context: &InferContext, node: &ast::Expr, ty: Type) { + let Some(builder) = context.report_lint(&INVALID_EXCEPTION_CAUGHT, node) else { + return; + }; + builder.into_diagnostic(format_args!( + "Cannot catch object of type `{}` in an exception handler \ + (must be a `BaseException` subclass or a tuple of `BaseException` subclasses)", + ty.display(context.db()) + )); +} + +pub(crate) fn report_invalid_exception_raised(context: &InferContext, node: &ast::Expr, ty: Type) { + let Some(builder) = context.report_lint(&INVALID_RAISE, node) else { + return; + }; + builder.into_diagnostic(format_args!( + "Cannot raise object of type `{}` (must be a `BaseException` subclass or instance)", + ty.display(context.db()) + )); +} + +pub(crate) fn report_invalid_exception_cause(context: &InferContext, node: &ast::Expr, ty: Type) { + let Some(builder) = context.report_lint(&INVALID_RAISE, node) else { + return; + }; + builder.into_diagnostic(format_args!( + "Cannot use object of type `{}` as exception cause \ + (must be a `BaseException` subclass or instance or `None`)", + ty.display(context.db()) + )); +} + +pub(crate) fn report_base_with_incompatible_slots(context: &InferContext, node: &ast::Expr) { + let Some(builder) = context.report_lint(&INCOMPATIBLE_SLOTS, node) else { + return; + }; + builder.into_diagnostic("Class base has incompatible `__slots__`"); +} + +pub(crate) fn report_invalid_arguments_to_annotated( + db: &dyn Db, + context: &InferContext, + subscript: &ast::ExprSubscript, +) { + let Some(builder) = context.report_lint(&INVALID_TYPE_FORM, subscript) else { + return; + }; + builder.into_diagnostic(format_args!( + "Special form `{}` expected at least 2 arguments \ + (one type and at least one metadata element)", + KnownInstanceType::Annotated.repr(db) + )); +} + +pub(crate) fn report_bad_argument_to_get_protocol_members( + context: &InferContext, + call: &ast::ExprCall, + class: ClassLiteral, +) { + let Some(builder) = context.report_lint(&INVALID_ARGUMENT_TYPE, call) else { + return; + }; + let db = context.db(); + let mut diagnostic = builder.into_diagnostic("Invalid argument to `get_protocol_members`"); + diagnostic.set_primary_message("This call will raise `TypeError` at runtime"); + diagnostic.info("Only protocol classes can be passed to `get_protocol_members`"); + + let mut class_def_diagnostic = SubDiagnostic::new( + Severity::Info, + format_args!( + "`{}` is declared here, but it is not a protocol class:", + class.name(db) + ), + ); + class_def_diagnostic.annotate(Annotation::primary(class.header_span(db))); + diagnostic.sub(class_def_diagnostic); + + diagnostic.info( + "A class is only a protocol class if it directly inherits \ + from `typing.Protocol` or `typing_extensions.Protocol`", + ); + // TODO the typing spec isn't really designed as user-facing documentation, + // but there isn't really any user-facing documentation that covers this specific issue well + // (it's not described well in the CPython docs; and PEP-544 is a snapshot of a decision taken + // years ago rather than up-to-date documentation). We should either write our own docs + // describing this well or contribute to type-checker-agnostic docs somewhere and link to those. + diagnostic.info("See https://typing.python.org/en/latest/spec/protocol.html#"); +} + +pub(crate) fn report_invalid_arguments_to_callable( + db: &dyn Db, + context: &InferContext, + subscript: &ast::ExprSubscript, +) { + let Some(builder) = context.report_lint(&INVALID_TYPE_FORM, subscript) else { + return; + }; + builder.into_diagnostic(format_args!( + "Special form `{}` expected exactly two arguments (parameter types and return type)", + KnownInstanceType::Callable.repr(db) + )); +} + +pub(crate) fn add_type_expression_reference_link(mut diag: LintDiagnosticGuard) { + diag.info("See the following page for a reference on valid type expressions:"); + diag.info( + "https://typing.python.org/en/latest/spec/annotations.html#type-and-annotation-expressions", + ); +} + +pub(crate) fn report_runtime_check_against_non_runtime_checkable_protocol( + context: &InferContext, + call: &ast::ExprCall, + protocol: ProtocolClassLiteral, + function: KnownFunction, +) { + let Some(builder) = context.report_lint(&INVALID_ARGUMENT_TYPE, call) else { + return; + }; + let db = context.db(); + let class_name = protocol.name(db); + let function_name: &'static str = function.into(); + let mut diagnostic = builder.into_diagnostic(format_args!( + "Class `{class_name}` cannot be used as the second argument to `{function_name}`", + )); + diagnostic.set_primary_message("This call will raise `TypeError` at runtime"); + + let mut class_def_diagnostic = SubDiagnostic::new( + Severity::Info, + format_args!( + "`{class_name}` is declared as a protocol class, \ + but it is not declared as runtime-checkable" + ), + ); + class_def_diagnostic.annotate( + Annotation::primary(protocol.header_span(db)) + .message(format_args!("`{class_name}` declared here")), + ); + diagnostic.sub(class_def_diagnostic); + + diagnostic.info(format_args!( + "A protocol class can only be used in `{function_name}` checks if it is decorated \ + with `@typing.runtime_checkable` or `@typing_extensions.runtime_checkable`" + )); + diagnostic.info("See https://docs.python.org/3/library/typing.html#typing.runtime_checkable"); +} + +pub(crate) fn report_attempted_protocol_instantiation( + context: &InferContext, + call: &ast::ExprCall, + protocol: ProtocolClassLiteral, +) { + let Some(builder) = context.report_lint(&CALL_NON_CALLABLE, call) else { + return; + }; + let db = context.db(); + let class_name = protocol.name(db); + let mut diagnostic = + builder.into_diagnostic(format_args!("Cannot instantiate class `{class_name}`",)); + diagnostic.set_primary_message("This call will raise `TypeError` at runtime"); + + let mut class_def_diagnostic = SubDiagnostic::new( + Severity::Info, + format_args!("Protocol classes cannot be instantiated"), + ); + class_def_diagnostic.annotate( + Annotation::primary(protocol.header_span(db)) + .message(format_args!("`{class_name}` declared as a protocol here")), + ); + diagnostic.sub(class_def_diagnostic); +} + +pub(crate) fn report_duplicate_bases( + context: &InferContext, + class: ClassLiteral, + duplicate_base_error: &DuplicateBaseError, + bases_list: &[ast::Expr], +) { + let db = context.db(); + + let Some(builder) = context.report_lint(&DUPLICATE_BASE, class.header_range(db)) else { + return; + }; + + let DuplicateBaseError { + duplicate_base, + first_index, + later_indices, + } = duplicate_base_error; + + let duplicate_name = duplicate_base.name(db); + + let mut diagnostic = + builder.into_diagnostic(format_args!("Duplicate base class `{duplicate_name}`",)); + + let mut sub_diagnostic = SubDiagnostic::new( + Severity::Info, + format_args!( + "The definition of class `{}` will raise `TypeError` at runtime", + class.name(db) + ), + ); + sub_diagnostic.annotate( + Annotation::secondary(context.span(&bases_list[*first_index])).message(format_args!( + "Class `{duplicate_name}` first included in bases list here" + )), + ); + for index in later_indices { + sub_diagnostic.annotate( + Annotation::primary(context.span(&bases_list[*index])) + .message(format_args!("Class `{duplicate_name}` later repeated here")), + ); + } + + diagnostic.sub(sub_diagnostic); +} + +pub(crate) fn report_invalid_or_unsupported_base( + context: &InferContext, + base_node: &ast::Expr, + base_type: Type, + class: ClassLiteral, +) { + let db = context.db(); + let instance_of_type = KnownClass::Type.to_instance(db); + + if base_type.is_assignable_to(db, instance_of_type) { + report_unsupported_base(context, base_node, base_type, class); + return; + } + + let tuple_of_types = KnownClass::Tuple.to_specialized_instance(db, [instance_of_type]); + + let explain_mro_entries = |diagnostic: &mut LintDiagnosticGuard| { + diagnostic.info( + "An instance type is only a valid class base \ + if it has a valid `__mro_entries__` method", + ); + }; + + match base_type.try_call_dunder( + db, + "__mro_entries__", + CallArgumentTypes::positional([tuple_of_types]), + ) { + Ok(ret) => { + if ret.return_type(db).is_assignable_to(db, tuple_of_types) { + report_unsupported_base(context, base_node, base_type, class); + } else { + let Some(mut diagnostic) = + report_invalid_base(context, base_node, base_type, class) + else { + return; + }; + explain_mro_entries(&mut diagnostic); + diagnostic.info(format_args!( + "Type `{}` has an `__mro_entries__` method, but it does not return a tuple of types", + base_type.display(db) + )); + } + } + Err(mro_entries_call_error) => { + let Some(mut diagnostic) = report_invalid_base(context, base_node, base_type, class) + else { + return; + }; + + match mro_entries_call_error { + CallDunderError::MethodNotAvailable => {} + CallDunderError::PossiblyUnbound(_) => { + explain_mro_entries(&mut diagnostic); + diagnostic.info(format_args!( + "Type `{}` has an `__mro_entries__` attribute, but it is possibly unbound", + base_type.display(db) + )); + } + CallDunderError::CallError(CallErrorKind::NotCallable, _) => { + explain_mro_entries(&mut diagnostic); + diagnostic.info(format_args!( + "Type `{}` has an `__mro_entries__` attribute, but it is not callable", + base_type.display(db) + )); + } + CallDunderError::CallError(CallErrorKind::BindingError, _) => { + explain_mro_entries(&mut diagnostic); + diagnostic.info(format_args!( + "Type `{}` has an `__mro_entries__` method, \ + but it cannot be called with the expected arguments", + base_type.display(db) + )); + diagnostic.info( + "Expected a signature at least as permissive as \ + `def __mro_entries__(self, bases: tuple[type, ...], /) -> tuple[type, ...]`" + ); + } + CallDunderError::CallError(CallErrorKind::PossiblyNotCallable, _) => { + explain_mro_entries(&mut diagnostic); + diagnostic.info(format_args!( + "Type `{}` has an `__mro_entries__` method, \ + but it may not be callable", + base_type.display(db) + )); + } + } + } + } +} + +fn report_unsupported_base( + context: &InferContext, + base_node: &ast::Expr, + base_type: Type, + class: ClassLiteral, +) { + let Some(builder) = context.report_lint(&UNSUPPORTED_BASE, base_node) else { + return; + }; + let mut diagnostic = builder.into_diagnostic(format_args!( + "Unsupported class base with type `{}`", + base_type.display(context.db()) + )); + diagnostic.info(format_args!( + "ty cannot resolve a consistent MRO for class `{}` due to this base", + class.name(context.db()) + )); + diagnostic.info("Only class objects or `Any` are supported as class bases"); +} + +fn report_invalid_base<'ctx, 'db>( + context: &'ctx InferContext<'db>, + base_node: &ast::Expr, + base_type: Type<'db>, + class: ClassLiteral<'db>, +) -> Option<LintDiagnosticGuard<'ctx, 'db>> { + let builder = context.report_lint(&INVALID_BASE, base_node)?; + let mut diagnostic = builder.into_diagnostic(format_args!( + "Invalid class base with type `{}`", + base_type.display(context.db()) + )); + diagnostic.info(format_args!( + "Definition of class `{}` will raise `TypeError` at runtime", + class.name(context.db()) + )); + Some(diagnostic) +} diff --git a/crates/ty_python_semantic/src/types/display.rs b/crates/ty_python_semantic/src/types/display.rs new file mode 100644 index 0000000000000..d0f3e9a61efa0 --- /dev/null +++ b/crates/ty_python_semantic/src/types/display.rs @@ -0,0 +1,945 @@ +//! Display implementations for types. + +use std::fmt::{self, Display, Formatter, Write}; + +use ruff_db::display::FormatterJoinExtension; +use ruff_python_ast::str::{Quote, TripleQuotes}; +use ruff_python_literal::escape::AsciiEscape; + +use crate::types::class::{ClassLiteral, ClassType, GenericAlias}; +use crate::types::generics::{GenericContext, Specialization}; +use crate::types::signatures::{Parameter, Parameters, Signature}; +use crate::types::{ + CallableType, IntersectionType, KnownClass, MethodWrapperKind, Protocol, StringLiteralType, + SubclassOfInner, Type, TypeVarBoundOrConstraints, TypeVarInstance, UnionType, + WrapperDescriptorKind, +}; +use crate::{Db, FxOrderSet}; + +impl<'db> Type<'db> { + pub fn display(&self, db: &'db dyn Db) -> DisplayType { + DisplayType { ty: self, db } + } + fn representation(self, db: &'db dyn Db) -> DisplayRepresentation<'db> { + DisplayRepresentation { db, ty: self } + } +} + +#[derive(Copy, Clone)] +pub struct DisplayType<'db> { + ty: &'db Type<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let representation = self.ty.representation(self.db); + match self.ty { + Type::ClassLiteral(literal) if literal.is_known(self.db, KnownClass::Any) => { + write!(f, "typing.Any") + } + Type::IntLiteral(_) + | Type::BooleanLiteral(_) + | Type::StringLiteral(_) + | Type::BytesLiteral(_) => { + write!(f, "Literal[{representation}]") + } + _ => representation.fmt(f), + } + } +} + +impl fmt::Debug for DisplayType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + Display::fmt(self, f) + } +} + +/// Writes the string representation of a type, which is the value displayed either as +/// `Literal[<repr>]` or `Literal[<repr1>, <repr2>]` for literal types or as `<repr>` for +/// non literals +struct DisplayRepresentation<'db> { + ty: Type<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayRepresentation<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self.ty { + Type::Dynamic(dynamic) => dynamic.fmt(f), + Type::Never => f.write_str("Never"), + Type::NominalInstance(instance) => { + match (instance.class, instance.class.known(self.db)) { + (_, Some(KnownClass::NoneType)) => f.write_str("None"), + (_, Some(KnownClass::NoDefaultType)) => f.write_str("NoDefault"), + (ClassType::NonGeneric(class), _) => f.write_str(class.name(self.db)), + (ClassType::Generic(alias), _) => alias.display(self.db).fmt(f), + } + } + Type::ProtocolInstance(protocol) => match protocol.inner { + Protocol::FromClass(ClassType::NonGeneric(class)) => { + f.write_str(class.name(self.db)) + } + Protocol::FromClass(ClassType::Generic(alias)) => alias.display(self.db).fmt(f), + Protocol::Synthesized(synthetic) => { + f.write_str("<Protocol with members ")?; + let interface = synthetic.interface(); + let member_list = interface.members(self.db); + let num_members = member_list.len(); + for (i, member) in member_list.enumerate() { + let is_last = i == num_members - 1; + write!(f, "'{}'", member.name())?; + if !is_last { + f.write_str(", ")?; + } + } + f.write_char('>') + } + }, + Type::PropertyInstance(_) => f.write_str("property"), + Type::ModuleLiteral(module) => { + write!(f, "<module '{}'>", module.module(self.db).name()) + } + Type::ClassLiteral(class) => { + write!(f, "<class '{}'>", class.name(self.db)) + } + Type::GenericAlias(generic) => write!(f, "<class '{}'>", generic.display(self.db)), + Type::SubclassOf(subclass_of_ty) => match subclass_of_ty.subclass_of() { + // Only show the bare class name here; ClassBase::display would render this as + // type[<class 'Foo'>] instead of type[Foo]. + SubclassOfInner::Class(class) => write!(f, "type[{}]", class.name(self.db)), + SubclassOfInner::Dynamic(dynamic) => write!(f, "type[{dynamic}]"), + }, + Type::KnownInstance(known_instance) => known_instance.repr(self.db).fmt(f), + Type::FunctionLiteral(function) => { + let signature = function.signature(self.db); + + // TODO: when generic function types are supported, we should add + // the generic type parameters to the signature, i.e. + // show `def foo[T](x: T) -> T`. + + match signature.overloads.as_slice() { + [signature] => { + write!( + f, + // "def {name}{specialization}{signature}", + "def {name}{signature}", + name = function.name(self.db), + signature = signature.display(self.db) + ) + } + signatures => { + // TODO: How to display overloads? + f.write_str("Overload[")?; + let mut join = f.join(", "); + for signature in signatures { + join.entry(&signature.display(self.db)); + } + f.write_str("]") + } + } + } + Type::Callable(callable) => callable.display(self.db).fmt(f), + Type::BoundMethod(bound_method) => { + let function = bound_method.function(self.db); + + // TODO: use the specialization from the method. Similar to the comment above + // about the function specialization, + + match function.signature(self.db).overloads.as_slice() { + [signature] => { + write!( + f, + "bound method {instance}.{method}{signature}", + method = function.name(self.db), + instance = bound_method.self_instance(self.db).display(self.db), + signature = signature.bind_self().display(self.db) + ) + } + signatures => { + // TODO: How to display overloads? + f.write_str("Overload[")?; + let mut join = f.join(", "); + for signature in signatures { + join.entry(&signature.bind_self().display(self.db)); + } + f.write_str("]") + } + } + } + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderGet(function)) => { + write!( + f, + "<method-wrapper `__get__` of `{function}`>", + function = function.name(self.db), + ) + } + Type::MethodWrapper(MethodWrapperKind::FunctionTypeDunderCall(function)) => { + write!( + f, + "<method-wrapper `__call__` of `{function}`>", + function = function.name(self.db), + ) + } + Type::MethodWrapper(MethodWrapperKind::PropertyDunderGet(_)) => { + write!(f, "<method-wrapper `__get__` of `property` object>",) + } + Type::MethodWrapper(MethodWrapperKind::PropertyDunderSet(_)) => { + write!(f, "<method-wrapper `__set__` of `property` object>",) + } + Type::MethodWrapper(MethodWrapperKind::StrStartswith(_)) => { + write!(f, "<method-wrapper `startswith` of `str` object>",) + } + Type::WrapperDescriptor(kind) => { + let (method, object) = match kind { + WrapperDescriptorKind::FunctionTypeDunderGet => ("__get__", "function"), + WrapperDescriptorKind::PropertyDunderGet => ("__get__", "property"), + WrapperDescriptorKind::PropertyDunderSet => ("__set__", "property"), + }; + write!(f, "<wrapper-descriptor `{method}` of `{object}` objects>") + } + Type::DataclassDecorator(_) => { + f.write_str("<decorator produced by dataclass-like function>") + } + Type::DataclassTransformer(_) => { + f.write_str("<decorator produced by typing.dataclass_transform>") + } + Type::Union(union) => union.display(self.db).fmt(f), + Type::Intersection(intersection) => intersection.display(self.db).fmt(f), + Type::IntLiteral(n) => n.fmt(f), + Type::BooleanLiteral(boolean) => f.write_str(if boolean { "True" } else { "False" }), + Type::StringLiteral(string) => string.display(self.db).fmt(f), + Type::LiteralString => f.write_str("LiteralString"), + Type::BytesLiteral(bytes) => { + let escape = AsciiEscape::with_preferred_quote(bytes.value(self.db), Quote::Double); + + escape.bytes_repr(TripleQuotes::No).write(f) + } + Type::Tuple(tuple) => { + f.write_str("tuple[")?; + let elements = tuple.elements(self.db); + if elements.is_empty() { + f.write_str("()")?; + } else { + elements.display(self.db).fmt(f)?; + } + f.write_str("]") + } + Type::TypeVar(typevar) => f.write_str(typevar.name(self.db)), + Type::AlwaysTruthy => f.write_str("AlwaysTruthy"), + Type::AlwaysFalsy => f.write_str("AlwaysFalsy"), + Type::BoundSuper(bound_super) => { + write!( + f, + "<super: {pivot}, {owner}>", + pivot = Type::from(bound_super.pivot_class(self.db)).display(self.db), + owner = bound_super.owner(self.db).into_type().display(self.db) + ) + } + } + } +} + +impl<'db> GenericAlias<'db> { + pub(crate) fn display(&'db self, db: &'db dyn Db) -> DisplayGenericAlias<'db> { + DisplayGenericAlias { + origin: self.origin(db), + specialization: self.specialization(db), + db, + } + } +} + +pub(crate) struct DisplayGenericAlias<'db> { + origin: ClassLiteral<'db>, + specialization: Specialization<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayGenericAlias<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + write!( + f, + "{origin}{specialization}", + origin = self.origin.name(self.db), + specialization = self.specialization.display_short( + self.db, + TupleSpecialization::from_class(self.db, self.origin) + ), + ) + } +} + +impl<'db> GenericContext<'db> { + pub fn display(&'db self, db: &'db dyn Db) -> DisplayGenericContext<'db> { + DisplayGenericContext { + typevars: self.variables(db), + db, + } + } +} + +pub struct DisplayGenericContext<'db> { + typevars: &'db FxOrderSet<TypeVarInstance<'db>>, + db: &'db dyn Db, +} + +impl Display for DisplayGenericContext<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + f.write_char('[')?; + for (idx, var) in self.typevars.iter().enumerate() { + if idx > 0 { + f.write_str(", ")?; + } + f.write_str(var.name(self.db))?; + match var.bound_or_constraints(self.db) { + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + write!(f, ": {}", bound.display(self.db))?; + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => { + f.write_str(": (")?; + for (idx, constraint) in constraints.iter(self.db).enumerate() { + if idx > 0 { + f.write_str(", ")?; + } + constraint.display(self.db).fmt(f)?; + } + f.write_char(')')?; + } + None => {} + } + if let Some(default_type) = var.default_ty(self.db) { + write!(f, " = {}", default_type.display(self.db))?; + } + } + f.write_char(']') + } +} + +impl<'db> Specialization<'db> { + /// Renders the specialization in full, e.g. `{T = int, U = str}`. + pub fn display( + &'db self, + db: &'db dyn Db, + tuple_specialization: TupleSpecialization, + ) -> DisplaySpecialization<'db> { + DisplaySpecialization { + typevars: self.generic_context(db).variables(db), + types: self.types(db), + db, + full: true, + tuple_specialization, + } + } + + /// Renders the specialization as it would appear in a subscript expression, e.g. `[int, str]`. + pub fn display_short( + &'db self, + db: &'db dyn Db, + tuple_specialization: TupleSpecialization, + ) -> DisplaySpecialization<'db> { + DisplaySpecialization { + typevars: self.generic_context(db).variables(db), + types: self.types(db), + db, + full: false, + tuple_specialization, + } + } +} + +pub struct DisplaySpecialization<'db> { + typevars: &'db FxOrderSet<TypeVarInstance<'db>>, + types: &'db [Type<'db>], + db: &'db dyn Db, + full: bool, + tuple_specialization: TupleSpecialization, +} + +impl Display for DisplaySpecialization<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + if self.full { + f.write_char('{')?; + for (idx, (var, ty)) in self.typevars.iter().zip(self.types).enumerate() { + if idx > 0 { + f.write_str(", ")?; + } + write!(f, "{} = {}", var.name(self.db), ty.display(self.db))?; + } + f.write_char('}') + } else { + f.write_char('[')?; + for (idx, (_, ty)) in self.typevars.iter().zip(self.types).enumerate() { + if idx > 0 { + f.write_str(", ")?; + } + ty.display(self.db).fmt(f)?; + } + if self.tuple_specialization.is_yes() { + f.write_str(", ...")?; + } + f.write_char(']') + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum TupleSpecialization { + Yes, + No, +} + +impl TupleSpecialization { + const fn is_yes(self) -> bool { + matches!(self, Self::Yes) + } + + fn from_class(db: &dyn Db, class: ClassLiteral) -> Self { + if class.is_known(db, KnownClass::Tuple) { + Self::Yes + } else { + Self::No + } + } +} + +impl<'db> CallableType<'db> { + pub(crate) fn display(&'db self, db: &'db dyn Db) -> DisplayCallableType<'db> { + DisplayCallableType { + signatures: self.signatures(db), + db, + } + } +} + +pub(crate) struct DisplayCallableType<'db> { + signatures: &'db [Signature<'db>], + db: &'db dyn Db, +} + +impl Display for DisplayCallableType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + match self.signatures { + [signature] => signature.display(self.db).fmt(f), + signatures => { + // TODO: How to display overloads? + f.write_str("Overload[")?; + let mut join = f.join(", "); + for signature in signatures { + join.entry(&signature.display(self.db)); + } + join.finish()?; + f.write_char(']') + } + } + } +} + +impl<'db> Signature<'db> { + pub(crate) fn display(&'db self, db: &'db dyn Db) -> DisplaySignature<'db> { + DisplaySignature { + parameters: self.parameters(), + return_ty: self.return_ty, + db, + } + } +} + +pub(crate) struct DisplaySignature<'db> { + parameters: &'db Parameters<'db>, + return_ty: Option<Type<'db>>, + db: &'db dyn Db, +} + +impl Display for DisplaySignature<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + f.write_char('(')?; + + if self.parameters.is_gradual() { + // We represent gradual form as `...` in the signature, internally the parameters still + // contain `(*args, **kwargs)` parameters. + f.write_str("...")?; + } else { + let mut star_added = false; + let mut needs_slash = false; + let mut join = f.join(", "); + + for parameter in self.parameters.as_slice() { + if !star_added && parameter.is_keyword_only() { + join.entry(&'*'); + star_added = true; + } + if parameter.is_positional_only() { + needs_slash = true; + } else if needs_slash { + join.entry(&'/'); + needs_slash = false; + } + join.entry(¶meter.display(self.db)); + } + if needs_slash { + join.entry(&'/'); + } + join.finish()?; + } + + write!( + f, + ") -> {}", + self.return_ty.unwrap_or(Type::unknown()).display(self.db) + ) + } +} + +impl<'db> Parameter<'db> { + fn display(&'db self, db: &'db dyn Db) -> DisplayParameter<'db> { + DisplayParameter { param: self, db } + } +} + +struct DisplayParameter<'db> { + param: &'db Parameter<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayParameter<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + if let Some(name) = self.param.display_name() { + f.write_str(&name)?; + if let Some(annotated_type) = self.param.annotated_type() { + write!(f, ": {}", annotated_type.display(self.db))?; + } + // Default value can only be specified if `name` is given. + if let Some(default_ty) = self.param.default_type() { + if self.param.annotated_type().is_some() { + write!(f, " = {}", default_ty.display(self.db))?; + } else { + write!(f, "={}", default_ty.display(self.db))?; + } + } + } else if let Some(ty) = self.param.annotated_type() { + // This case is specifically for the `Callable` signature where name and default value + // cannot be provided. + ty.display(self.db).fmt(f)?; + } + Ok(()) + } +} + +impl<'db> UnionType<'db> { + fn display(&'db self, db: &'db dyn Db) -> DisplayUnionType<'db> { + DisplayUnionType { db, ty: self } + } +} + +struct DisplayUnionType<'db> { + ty: &'db UnionType<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayUnionType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + fn is_condensable(ty: Type<'_>) -> bool { + matches!( + ty, + Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::BytesLiteral(_) + | Type::BooleanLiteral(_) + ) + } + + let elements = self.ty.elements(self.db); + + let condensed_types = elements + .iter() + .copied() + .filter(|element| is_condensable(*element)) + .collect::<Vec<_>>(); + + let mut join = f.join(" | "); + + let mut condensed_types = Some(condensed_types); + for element in elements { + if is_condensable(*element) { + if let Some(condensed_types) = condensed_types.take() { + join.entry(&DisplayLiteralGroup { + literals: condensed_types, + db: self.db, + }); + } + } else { + join.entry(&DisplayMaybeParenthesizedType { + ty: *element, + db: self.db, + }); + } + } + + join.finish()?; + + Ok(()) + } +} + +impl fmt::Debug for DisplayUnionType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + Display::fmt(self, f) + } +} + +struct DisplayLiteralGroup<'db> { + literals: Vec<Type<'db>>, + db: &'db dyn Db, +} + +impl Display for DisplayLiteralGroup<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + f.write_str("Literal[")?; + f.join(", ") + .entries(self.literals.iter().map(|ty| ty.representation(self.db))) + .finish()?; + f.write_str("]") + } +} + +impl<'db> IntersectionType<'db> { + fn display(&'db self, db: &'db dyn Db) -> DisplayIntersectionType<'db> { + DisplayIntersectionType { db, ty: self } + } +} + +struct DisplayIntersectionType<'db> { + ty: &'db IntersectionType<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayIntersectionType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let tys = self + .ty + .positive(self.db) + .iter() + .map(|&ty| DisplayMaybeNegatedType { + ty, + db: self.db, + negated: false, + }) + .chain( + self.ty + .negative(self.db) + .iter() + .map(|&ty| DisplayMaybeNegatedType { + ty, + db: self.db, + negated: true, + }), + ); + f.join(" & ").entries(tys).finish() + } +} + +impl fmt::Debug for DisplayIntersectionType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + Display::fmt(self, f) + } +} + +struct DisplayMaybeNegatedType<'db> { + ty: Type<'db>, + db: &'db dyn Db, + negated: bool, +} + +impl Display for DisplayMaybeNegatedType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + if self.negated { + f.write_str("~")?; + } + DisplayMaybeParenthesizedType { + ty: self.ty, + db: self.db, + } + .fmt(f) + } +} + +struct DisplayMaybeParenthesizedType<'db> { + ty: Type<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayMaybeParenthesizedType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let write_parentheses = |f: &mut Formatter<'_>| write!(f, "({})", self.ty.display(self.db)); + match self.ty { + Type::Callable(_) + | Type::MethodWrapper(_) + | Type::FunctionLiteral(_) + | Type::BoundMethod(_) + | Type::Union(_) => write_parentheses(f), + Type::Intersection(intersection) if !intersection.has_one_element(self.db) => { + write_parentheses(f) + } + _ => self.ty.display(self.db).fmt(f), + } + } +} + +pub(crate) trait TypeArrayDisplay<'db> { + fn display(&self, db: &'db dyn Db) -> DisplayTypeArray; +} + +impl<'db> TypeArrayDisplay<'db> for Box<[Type<'db>]> { + fn display(&self, db: &'db dyn Db) -> DisplayTypeArray { + DisplayTypeArray { types: self, db } + } +} + +impl<'db> TypeArrayDisplay<'db> for Vec<Type<'db>> { + fn display(&self, db: &'db dyn Db) -> DisplayTypeArray { + DisplayTypeArray { types: self, db } + } +} + +impl<'db> TypeArrayDisplay<'db> for [Type<'db>] { + fn display(&self, db: &'db dyn Db) -> DisplayTypeArray { + DisplayTypeArray { types: self, db } + } +} + +pub(crate) struct DisplayTypeArray<'b, 'db> { + types: &'b [Type<'db>], + db: &'db dyn Db, +} + +impl Display for DisplayTypeArray<'_, '_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + f.join(", ") + .entries(self.types.iter().map(|ty| ty.display(self.db))) + .finish() + } +} + +impl<'db> StringLiteralType<'db> { + fn display(&'db self, db: &'db dyn Db) -> DisplayStringLiteralType<'db> { + DisplayStringLiteralType { db, ty: self } + } +} + +struct DisplayStringLiteralType<'db> { + ty: &'db StringLiteralType<'db>, + db: &'db dyn Db, +} + +impl Display for DisplayStringLiteralType<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let value = self.ty.value(self.db); + f.write_char('"')?; + for ch in value.chars() { + match ch { + // `escape_debug` will escape even single quotes, which is not necessary for our + // use case as we are already using double quotes to wrap the string. + '\'' => f.write_char('\''), + _ => ch.escape_debug().fmt(f), + }?; + } + f.write_char('"') + } +} + +#[cfg(test)] +mod tests { + use ruff_python_ast::name::Name; + + use crate::Db; + use crate::db::tests::setup_db; + use crate::symbol::typing_extensions_symbol; + use crate::types::{KnownClass, Parameter, Parameters, Signature, StringLiteralType, Type}; + + #[test] + fn string_literal_display() { + let db = setup_db(); + + assert_eq!( + Type::StringLiteral(StringLiteralType::new(&db, r"\n")) + .display(&db) + .to_string(), + r#"Literal["\\n"]"# + ); + assert_eq!( + Type::StringLiteral(StringLiteralType::new(&db, "'")) + .display(&db) + .to_string(), + r#"Literal["'"]"# + ); + assert_eq!( + Type::StringLiteral(StringLiteralType::new(&db, r#"""#)) + .display(&db) + .to_string(), + r#"Literal["\""]"# + ); + } + + #[test] + fn synthesized_protocol_display() { + let db = setup_db(); + + // Call `.normalized()` to turn the class-based protocol into a nameless synthesized one. + let supports_index_synthesized = KnownClass::SupportsIndex.to_instance(&db).normalized(&db); + assert_eq!( + supports_index_synthesized.display(&db).to_string(), + "<Protocol with members '__index__'>" + ); + + let iterator_synthesized = typing_extensions_symbol(&db, "Iterator") + .symbol + .ignore_possibly_unbound() + .unwrap() + .to_instance(&db) + .unwrap() + .normalized(&db); // Call `.normalized()` to turn the class-based protocol into a nameless synthesized one. + + assert_eq!( + iterator_synthesized.display(&db).to_string(), + "<Protocol with members '__iter__', '__next__'>" + ); + } + + fn display_signature<'db>( + db: &dyn Db, + parameters: impl IntoIterator<Item = Parameter<'db>>, + return_ty: Option<Type<'db>>, + ) -> String { + Signature::new(Parameters::new(parameters), return_ty) + .display(db) + .to_string() + } + + #[test] + fn signature_display() { + let db = setup_db(); + + // Empty parameters with no return type. + assert_eq!(display_signature(&db, [], None), "() -> Unknown"); + + // Empty parameters with a return type. + assert_eq!( + display_signature(&db, [], Some(Type::none(&db))), + "() -> None" + ); + + // Single parameter type (no name) with a return type. + assert_eq!( + display_signature( + &db, + [Parameter::positional_only(None).with_annotated_type(Type::none(&db))], + Some(Type::none(&db)) + ), + "(None, /) -> None" + ); + + // Two parameters where one has annotation and the other doesn't. + assert_eq!( + display_signature( + &db, + [ + Parameter::positional_or_keyword(Name::new_static("x")) + .with_default_type(KnownClass::Int.to_instance(&db)), + Parameter::positional_or_keyword(Name::new_static("y")) + .with_annotated_type(KnownClass::Str.to_instance(&db)) + .with_default_type(KnownClass::Str.to_instance(&db)), + ], + Some(Type::none(&db)) + ), + "(x=int, y: str = str) -> None" + ); + + // All positional only parameters. + assert_eq!( + display_signature( + &db, + [ + Parameter::positional_only(Some(Name::new_static("x"))), + Parameter::positional_only(Some(Name::new_static("y"))), + ], + Some(Type::none(&db)) + ), + "(x, y, /) -> None" + ); + + // Positional-only parameters mixed with non-positional-only parameters. + assert_eq!( + display_signature( + &db, + [ + Parameter::positional_only(Some(Name::new_static("x"))), + Parameter::positional_or_keyword(Name::new_static("y")), + ], + Some(Type::none(&db)) + ), + "(x, /, y) -> None" + ); + + // All keyword-only parameters. + assert_eq!( + display_signature( + &db, + [ + Parameter::keyword_only(Name::new_static("x")), + Parameter::keyword_only(Name::new_static("y")), + ], + Some(Type::none(&db)) + ), + "(*, x, y) -> None" + ); + + // Keyword-only parameters mixed with non-keyword-only parameters. + assert_eq!( + display_signature( + &db, + [ + Parameter::positional_or_keyword(Name::new_static("x")), + Parameter::keyword_only(Name::new_static("y")), + ], + Some(Type::none(&db)) + ), + "(x, *, y) -> None" + ); + + // A mix of all parameter kinds. + assert_eq!( + display_signature( + &db, + [ + Parameter::positional_only(Some(Name::new_static("a"))), + Parameter::positional_only(Some(Name::new_static("b"))) + .with_annotated_type(KnownClass::Int.to_instance(&db)), + Parameter::positional_only(Some(Name::new_static("c"))) + .with_default_type(Type::IntLiteral(1)), + Parameter::positional_only(Some(Name::new_static("d"))) + .with_annotated_type(KnownClass::Int.to_instance(&db)) + .with_default_type(Type::IntLiteral(2)), + Parameter::positional_or_keyword(Name::new_static("e")) + .with_default_type(Type::IntLiteral(3)), + Parameter::positional_or_keyword(Name::new_static("f")) + .with_annotated_type(KnownClass::Int.to_instance(&db)) + .with_default_type(Type::IntLiteral(4)), + Parameter::variadic(Name::new_static("args")) + .with_annotated_type(Type::object(&db)), + Parameter::keyword_only(Name::new_static("g")) + .with_default_type(Type::IntLiteral(5)), + Parameter::keyword_only(Name::new_static("h")) + .with_annotated_type(KnownClass::Int.to_instance(&db)) + .with_default_type(Type::IntLiteral(6)), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(KnownClass::Str.to_instance(&db)), + ], + Some(KnownClass::Bytes.to_instance(&db)) + ), + "(a, b: int, c=Literal[1], d: int = Literal[2], \ + /, e=Literal[3], f: int = Literal[4], *args: object, \ + *, g=Literal[5], h: int = Literal[6], **kwargs: str) -> bytes" + ); + } +} diff --git a/crates/ty_python_semantic/src/types/generics.rs b/crates/ty_python_semantic/src/types/generics.rs new file mode 100644 index 0000000000000..c3d5a61fb7a0f --- /dev/null +++ b/crates/ty_python_semantic/src/types/generics.rs @@ -0,0 +1,796 @@ +use std::borrow::Cow; + +use ruff_python_ast as ast; +use rustc_hash::FxHashMap; + +use crate::semantic_index::SemanticIndex; +use crate::types::class::ClassType; +use crate::types::class_base::ClassBase; +use crate::types::instance::{NominalInstanceType, Protocol, ProtocolInstanceType}; +use crate::types::signatures::{Parameter, Parameters, Signature}; +use crate::types::{ + KnownInstanceType, Type, TypeMapping, TypeVarBoundOrConstraints, TypeVarInstance, + TypeVarVariance, UnionType, declaration_type, todo_type, +}; +use crate::{Db, FxOrderSet}; + +/// A list of formal type variables for a generic function, class, or type alias. +/// +/// TODO: Handle nested generic contexts better, with actual parent links to the lexically +/// containing context. +/// +/// # Ordering +/// Ordering is based on the context's salsa-assigned id and not on its values. +/// The id may change between runs, or when the context was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub struct GenericContext<'db> { + #[returns(ref)] + pub(crate) variables: FxOrderSet<TypeVarInstance<'db>>, + pub(crate) origin: GenericContextOrigin, +} + +impl<'db> GenericContext<'db> { + /// Creates a generic context from a list of PEP-695 type parameters. + pub(crate) fn from_type_params( + db: &'db dyn Db, + index: &'db SemanticIndex<'db>, + type_params_node: &ast::TypeParams, + ) -> Self { + let variables: FxOrderSet<_> = type_params_node + .iter() + .filter_map(|type_param| Self::variable_from_type_param(db, index, type_param)) + .collect(); + Self::new(db, variables, GenericContextOrigin::TypeParameterList) + } + + fn variable_from_type_param( + db: &'db dyn Db, + index: &'db SemanticIndex<'db>, + type_param_node: &ast::TypeParam, + ) -> Option<TypeVarInstance<'db>> { + match type_param_node { + ast::TypeParam::TypeVar(node) => { + let definition = index.expect_single_definition(node); + let Type::KnownInstance(KnownInstanceType::TypeVar(typevar)) = + declaration_type(db, definition).inner_type() + else { + return None; + }; + Some(typevar) + } + // TODO: Support these! + ast::TypeParam::ParamSpec(_) => None, + ast::TypeParam::TypeVarTuple(_) => None, + } + } + + /// Creates a generic context from the legacy `TypeVar`s that appear in a function parameter + /// list. + pub(crate) fn from_function_params( + db: &'db dyn Db, + parameters: &Parameters<'db>, + return_type: Option<Type<'db>>, + ) -> Option<Self> { + let mut variables = FxOrderSet::default(); + for param in parameters { + if let Some(ty) = param.annotated_type() { + ty.find_legacy_typevars(db, &mut variables); + } + if let Some(ty) = param.default_type() { + ty.find_legacy_typevars(db, &mut variables); + } + } + if let Some(ty) = return_type { + ty.find_legacy_typevars(db, &mut variables); + } + if variables.is_empty() { + return None; + } + Some(Self::new( + db, + variables, + GenericContextOrigin::LegacyGenericFunction, + )) + } + + /// Creates a generic context from the legacy `TypeVar`s that appear in class's base class + /// list. + pub(crate) fn from_base_classes( + db: &'db dyn Db, + bases: impl Iterator<Item = Type<'db>>, + ) -> Option<Self> { + let mut variables = FxOrderSet::default(); + for base in bases { + base.find_legacy_typevars(db, &mut variables); + } + if variables.is_empty() { + return None; + } + Some(Self::new(db, variables, GenericContextOrigin::Inherited)) + } + + pub(crate) fn len(self, db: &'db dyn Db) -> usize { + self.variables(db).len() + } + + pub(crate) fn signature(self, db: &'db dyn Db) -> Signature<'db> { + let parameters = Parameters::new( + self.variables(db) + .iter() + .map(|typevar| Self::parameter_from_typevar(db, *typevar)), + ); + Signature::new(parameters, None) + } + + fn parameter_from_typevar(db: &'db dyn Db, typevar: TypeVarInstance<'db>) -> Parameter<'db> { + let mut parameter = Parameter::positional_only(Some(typevar.name(db).clone())); + match typevar.bound_or_constraints(db) { + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + // TODO: This should be a type form. + parameter = parameter.with_annotated_type(bound); + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => { + // TODO: This should be a new type variant where only these exact types are + // assignable, and not subclasses of them, nor a union of them. + parameter = parameter + .with_annotated_type(UnionType::from_elements(db, constraints.iter(db))); + } + None => {} + } + if let Some(default_ty) = typevar.default_ty(db) { + parameter = parameter.with_default_type(default_ty); + } + parameter + } + + pub(crate) fn default_specialization(self, db: &'db dyn Db) -> Specialization<'db> { + self.specialize_partial(db, &vec![None; self.variables(db).len()]) + } + + #[allow(unused_variables)] // Only unused in release builds + pub(crate) fn todo_specialization( + self, + db: &'db dyn Db, + todo: &'static str, + ) -> Specialization<'db> { + let types = self + .variables(db) + .iter() + .map(|typevar| typevar.default_ty(db).unwrap_or(todo_type!(todo))) + .collect(); + self.specialize(db, types) + } + + pub(crate) fn identity_specialization(self, db: &'db dyn Db) -> Specialization<'db> { + let types = self + .variables(db) + .iter() + .map(|typevar| Type::TypeVar(*typevar)) + .collect(); + self.specialize(db, types) + } + + pub(crate) fn unknown_specialization(self, db: &'db dyn Db) -> Specialization<'db> { + let types = vec![Type::unknown(); self.variables(db).len()]; + self.specialize(db, types.into()) + } + + pub(crate) fn is_subset_of(self, db: &'db dyn Db, other: GenericContext<'db>) -> bool { + self.variables(db).is_subset(other.variables(db)) + } + + /// Creates a specialization of this generic context. Panics if the length of `types` does not + /// match the number of typevars in the generic context. You must provide a specific type for + /// each typevar; no defaults are used. (Use [`specialize_partial`](Self::specialize_partial) + /// if you might not have types for every typevar.) + pub(crate) fn specialize( + self, + db: &'db dyn Db, + types: Box<[Type<'db>]>, + ) -> Specialization<'db> { + assert!(self.variables(db).len() == types.len()); + Specialization::new(db, self, types) + } + + /// Creates a specialization of this generic context. Panics if the length of `types` does not + /// match the number of typevars in the generic context. If any provided type is `None`, we + /// will use the corresponding typevar's default type. + pub(crate) fn specialize_partial( + self, + db: &'db dyn Db, + types: &[Option<Type<'db>>], + ) -> Specialization<'db> { + let variables = self.variables(db); + assert!(variables.len() == types.len()); + + // Typevars can have other typevars as their default values, e.g. + // + // ```py + // class C[T, U = T]: ... + // ``` + // + // If there is a mapping for `T`, we want to map `U` to that type, not to `T`. To handle + // this, we repeatedly apply the specialization to itself, until we reach a fixed point. + let mut expanded = vec![Type::unknown(); types.len()]; + for (idx, (ty, typevar)) in types.iter().zip(variables).enumerate() { + if let Some(ty) = ty { + expanded[idx] = *ty; + continue; + } + + let Some(default) = typevar.default_ty(db) else { + continue; + }; + + // Typevars are only allowed to refer to _earlier_ typevars in their defaults. (This is + // statically enforced for PEP-695 contexts, and is explicitly called out as a + // requirement for legacy contexts.) + let partial = PartialSpecialization { + generic_context: self, + types: Cow::Borrowed(&expanded[0..idx]), + }; + let default = + default.apply_type_mapping(db, &TypeMapping::PartialSpecialization(partial)); + expanded[idx] = default; + } + + Specialization::new(db, self, expanded.into_boxed_slice()) + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + let variables: FxOrderSet<_> = self + .variables(db) + .iter() + .map(|ty| ty.normalized(db)) + .collect(); + Self::new(db, variables, self.origin(db)) + } +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)] +pub enum GenericContextOrigin { + LegacyBase(LegacyGenericBase), + Inherited, + LegacyGenericFunction, + TypeParameterList, +} + +impl GenericContextOrigin { + pub(crate) const fn as_str(self) -> &'static str { + match self { + Self::LegacyBase(base) => base.as_str(), + Self::Inherited => "inherited", + Self::LegacyGenericFunction => "legacy generic function", + Self::TypeParameterList => "type parameter list", + } + } +} + +impl std::fmt::Display for GenericContextOrigin { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)] +pub enum LegacyGenericBase { + Generic, + Protocol, +} + +impl LegacyGenericBase { + pub(crate) const fn as_str(self) -> &'static str { + match self { + Self::Generic => "`typing.Generic`", + Self::Protocol => "subscripted `typing.Protocol`", + } + } +} + +impl std::fmt::Display for LegacyGenericBase { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } +} + +impl From<LegacyGenericBase> for GenericContextOrigin { + fn from(base: LegacyGenericBase) -> Self { + Self::LegacyBase(base) + } +} + +/// An assignment of a specific type to each type variable in a generic scope. +/// +/// TODO: Handle nested specializations better, with actual parent links to the specialization of +/// the lexically containing context. +#[salsa::interned(debug)] +pub struct Specialization<'db> { + pub(crate) generic_context: GenericContext<'db>, + #[returns(deref)] + pub(crate) types: Box<[Type<'db>]>, +} + +impl<'db> Specialization<'db> { + /// Returns the type that a typevar is mapped to, or None if the typevar isn't part of this + /// mapping. + pub(crate) fn get(self, db: &'db dyn Db, typevar: TypeVarInstance<'db>) -> Option<Type<'db>> { + let index = self + .generic_context(db) + .variables(db) + .get_index_of(&typevar)?; + self.types(db).get(index).copied() + } + + /// Applies a specialization to this specialization. This is used, for instance, when a generic + /// class inherits from a generic alias: + /// + /// ```py + /// class A[T]: ... + /// class B[U](A[U]): ... + /// ``` + /// + /// `B` is a generic class, whose MRO includes the generic alias `A[U]`, which specializes `A` + /// with the specialization `{T: U}`. If `B` is specialized to `B[int]`, with specialization + /// `{U: int}`, we can apply the second specialization to the first, resulting in `T: int`. + /// That lets us produce the generic alias `A[int]`, which is the corresponding entry in the + /// MRO of `B[int]`. + pub(crate) fn apply_specialization(self, db: &'db dyn Db, other: Specialization<'db>) -> Self { + self.apply_type_mapping(db, &TypeMapping::Specialization(other)) + } + + pub(crate) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + let types: Box<[_]> = self + .types(db) + .iter() + .map(|ty| ty.apply_type_mapping(db, type_mapping)) + .collect(); + Specialization::new(db, self.generic_context(db), types) + } + + /// Applies an optional specialization to this specialization. + pub(crate) fn apply_optional_specialization( + self, + db: &'db dyn Db, + other: Option<Specialization<'db>>, + ) -> Self { + if let Some(other) = other { + self.apply_specialization(db, other) + } else { + self + } + } + + /// Combines two specializations of the same generic context. If either specialization maps a + /// typevar to `Type::Unknown`, the other specialization's mapping is used. If both map the + /// typevar to a known type, those types are unioned together. + /// + /// Panics if the two specializations are not for the same generic context. + pub(crate) fn combine(self, db: &'db dyn Db, other: Self) -> Self { + let generic_context = self.generic_context(db); + assert!(other.generic_context(db) == generic_context); + // TODO special-casing Unknown to mean "no mapping" is not right here, and can give + // confusing/wrong results in cases where there was a mapping found for a typevar, and it + // was of type Unknown. We should probably add a bitset or similar to Specialization that + // explicitly tells us which typevars are mapped. + let types: Box<[_]> = self + .types(db) + .iter() + .zip(other.types(db)) + .map(|(self_type, other_type)| match (self_type, other_type) { + (unknown, known) | (known, unknown) if unknown.is_unknown() => *known, + _ => UnionType::from_elements(db, [self_type, other_type]), + }) + .collect(); + Specialization::new(db, self.generic_context(db), types) + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + let types: Box<[_]> = self.types(db).iter().map(|ty| ty.normalized(db)).collect(); + Self::new(db, self.generic_context(db), types) + } + + pub(crate) fn is_subtype_of(self, db: &'db dyn Db, other: Specialization<'db>) -> bool { + let generic_context = self.generic_context(db); + if generic_context != other.generic_context(db) { + return false; + } + + for ((typevar, self_type), other_type) in (generic_context.variables(db).into_iter()) + .zip(self.types(db)) + .zip(other.types(db)) + { + if matches!(self_type, Type::Dynamic(_)) || matches!(other_type, Type::Dynamic(_)) { + return false; + } + + // Subtyping of each type in the specialization depends on the variance of the + // corresponding typevar: + // - covariant: verify that self_type <: other_type + // - contravariant: verify that other_type <: self_type + // - invariant: verify that self_type == other_type + // - bivariant: skip, can't make subtyping false + let compatible = match typevar.variance(db) { + TypeVarVariance::Invariant => self_type.is_equivalent_to(db, *other_type), + TypeVarVariance::Covariant => self_type.is_subtype_of(db, *other_type), + TypeVarVariance::Contravariant => other_type.is_subtype_of(db, *self_type), + TypeVarVariance::Bivariant => true, + }; + if !compatible { + return false; + } + } + + true + } + + pub(crate) fn is_equivalent_to(self, db: &'db dyn Db, other: Specialization<'db>) -> bool { + let generic_context = self.generic_context(db); + if generic_context != other.generic_context(db) { + return false; + } + + for ((typevar, self_type), other_type) in (generic_context.variables(db).into_iter()) + .zip(self.types(db)) + .zip(other.types(db)) + { + if matches!(self_type, Type::Dynamic(_)) || matches!(other_type, Type::Dynamic(_)) { + return false; + } + + // Equivalence of each type in the specialization depends on the variance of the + // corresponding typevar: + // - covariant: verify that self_type == other_type + // - contravariant: verify that other_type == self_type + // - invariant: verify that self_type == other_type + // - bivariant: skip, can't make equivalence false + let compatible = match typevar.variance(db) { + TypeVarVariance::Invariant + | TypeVarVariance::Covariant + | TypeVarVariance::Contravariant => self_type.is_equivalent_to(db, *other_type), + TypeVarVariance::Bivariant => true, + }; + if !compatible { + return false; + } + } + + true + } + + pub(crate) fn is_assignable_to(self, db: &'db dyn Db, other: Specialization<'db>) -> bool { + let generic_context = self.generic_context(db); + if generic_context != other.generic_context(db) { + return false; + } + + for ((typevar, self_type), other_type) in (generic_context.variables(db).into_iter()) + .zip(self.types(db)) + .zip(other.types(db)) + { + if matches!(self_type, Type::Dynamic(_)) || matches!(other_type, Type::Dynamic(_)) { + continue; + } + + // Assignability of each type in the specialization depends on the variance of the + // corresponding typevar: + // - covariant: verify that self_type <: other_type + // - contravariant: verify that other_type <: self_type + // - invariant: verify that self_type <: other_type AND other_type <: self_type + // - bivariant: skip, can't make assignability false + let compatible = match typevar.variance(db) { + TypeVarVariance::Invariant => { + self_type.is_assignable_to(db, *other_type) + && other_type.is_assignable_to(db, *self_type) + } + TypeVarVariance::Covariant => self_type.is_assignable_to(db, *other_type), + TypeVarVariance::Contravariant => other_type.is_assignable_to(db, *self_type), + TypeVarVariance::Bivariant => true, + }; + if !compatible { + return false; + } + } + + true + } + + pub(crate) fn is_gradual_equivalent_to( + self, + db: &'db dyn Db, + other: Specialization<'db>, + ) -> bool { + let generic_context = self.generic_context(db); + if generic_context != other.generic_context(db) { + return false; + } + + for ((typevar, self_type), other_type) in (generic_context.variables(db).into_iter()) + .zip(self.types(db)) + .zip(other.types(db)) + { + // Equivalence of each type in the specialization depends on the variance of the + // corresponding typevar: + // - covariant: verify that self_type == other_type + // - contravariant: verify that other_type == self_type + // - invariant: verify that self_type == other_type + // - bivariant: skip, can't make equivalence false + let compatible = match typevar.variance(db) { + TypeVarVariance::Invariant + | TypeVarVariance::Covariant + | TypeVarVariance::Contravariant => { + self_type.is_gradual_equivalent_to(db, *other_type) + } + TypeVarVariance::Bivariant => true, + }; + if !compatible { + return false; + } + } + + true + } + + pub(crate) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + for ty in self.types(db) { + ty.find_legacy_typevars(db, typevars); + } + } +} + +/// A mapping between type variables and types. +/// +/// You will usually use [`Specialization`] instead of this type. This type is used when we need to +/// substitute types for type variables before we have fully constructed a [`Specialization`]. +#[derive(Clone, Debug, Eq, Hash, PartialEq)] +pub struct PartialSpecialization<'a, 'db> { + generic_context: GenericContext<'db>, + types: Cow<'a, [Type<'db>]>, +} + +impl<'db> PartialSpecialization<'_, 'db> { + /// Returns the type that a typevar is mapped to, or None if the typevar isn't part of this + /// mapping. + pub(crate) fn get(&self, db: &'db dyn Db, typevar: TypeVarInstance<'db>) -> Option<Type<'db>> { + let index = self.generic_context.variables(db).get_index_of(&typevar)?; + self.types.get(index).copied() + } + + pub(crate) fn to_owned(&self) -> PartialSpecialization<'db, 'db> { + PartialSpecialization { + generic_context: self.generic_context, + types: Cow::from(self.types.clone().into_owned()), + } + } + + pub(crate) fn normalized(&self, db: &'db dyn Db) -> PartialSpecialization<'db, 'db> { + let generic_context = self.generic_context.normalized(db); + let types: Cow<_> = self.types.iter().map(|ty| ty.normalized(db)).collect(); + + PartialSpecialization { + generic_context, + types, + } + } +} + +/// Performs type inference between parameter annotations and argument types, producing a +/// specialization of a generic function. +pub(crate) struct SpecializationBuilder<'db> { + db: &'db dyn Db, + types: FxHashMap<TypeVarInstance<'db>, Type<'db>>, +} + +impl<'db> SpecializationBuilder<'db> { + pub(crate) fn new(db: &'db dyn Db) -> Self { + Self { + db, + types: FxHashMap::default(), + } + } + + pub(crate) fn build(&mut self, generic_context: GenericContext<'db>) -> Specialization<'db> { + let types: Box<[_]> = generic_context + .variables(self.db) + .iter() + .map(|variable| { + self.types + .get(variable) + .copied() + .unwrap_or(variable.default_ty(self.db).unwrap_or(Type::unknown())) + }) + .collect(); + Specialization::new(self.db, generic_context, types) + } + + fn add_type_mapping(&mut self, typevar: TypeVarInstance<'db>, ty: Type<'db>) { + self.types + .entry(typevar) + .and_modify(|existing| { + *existing = UnionType::from_elements(self.db, [*existing, ty]); + }) + .or_insert(ty); + } + + pub(crate) fn infer( + &mut self, + formal: Type<'db>, + actual: Type<'db>, + ) -> Result<(), SpecializationError<'db>> { + // If the actual type is a subtype of the formal type, then return without adding any new + // type mappings. (Note that if the formal type contains any typevars, this check will + // fail, since no non-typevar types are assignable to a typevar. Also note that we are + // checking _subtyping_, not _assignability_, so that we do specialize typevars to dynamic + // argument types; and we have a special case for `Never`, which is a subtype of all types, + // but which we also do want as a specialization candidate.) + // + // In particular, this handles a case like + // + // ```py + // def f[T](t: T | None): ... + // + // f(None) + // ``` + // + // without specializing `T` to `None`. + if !matches!(formal, Type::ProtocolInstance(_)) + && !actual.is_never() + && actual.is_subtype_of(self.db, formal) + { + return Ok(()); + } + + match (formal, actual) { + (Type::TypeVar(typevar), ty) | (ty, Type::TypeVar(typevar)) => { + match typevar.bound_or_constraints(self.db) { + Some(TypeVarBoundOrConstraints::UpperBound(bound)) => { + if !ty.is_assignable_to(self.db, bound) { + return Err(SpecializationError::MismatchedBound { + typevar, + argument: ty, + }); + } + self.add_type_mapping(typevar, ty); + } + Some(TypeVarBoundOrConstraints::Constraints(constraints)) => { + for constraint in constraints.iter(self.db) { + if ty.is_assignable_to(self.db, *constraint) { + self.add_type_mapping(typevar, *constraint); + return Ok(()); + } + } + return Err(SpecializationError::MismatchedConstraint { + typevar, + argument: ty, + }); + } + _ => { + self.add_type_mapping(typevar, ty); + } + } + } + + (Type::Tuple(formal_tuple), Type::Tuple(actual_tuple)) => { + let formal_elements = formal_tuple.elements(self.db); + let actual_elements = actual_tuple.elements(self.db); + if formal_elements.len() == actual_elements.len() { + for (formal_element, actual_element) in + formal_elements.iter().zip(actual_elements) + { + self.infer(*formal_element, *actual_element)?; + } + } + } + + ( + Type::NominalInstance(NominalInstanceType { + class: ClassType::Generic(formal_alias), + .. + }) + // TODO: This will only handle classes that explicit implement a generic protocol + // by listing it as a base class. To handle classes that implicitly implement a + // generic protocol, we will need to check the types of the protocol members to be + // able to infer the specialization of the protocol that the class implements. + | Type::ProtocolInstance(ProtocolInstanceType { + inner: Protocol::FromClass(ClassType::Generic(formal_alias)), + .. + }), + Type::NominalInstance(NominalInstanceType { + class: actual_class, + .. + }), + ) => { + let formal_origin = formal_alias.origin(self.db); + for base in actual_class.iter_mro(self.db) { + let ClassBase::Class(ClassType::Generic(base_alias)) = base else { + continue; + }; + if formal_origin != base_alias.origin(self.db) { + continue; + } + let formal_specialization = formal_alias.specialization(self.db).types(self.db); + let base_specialization = base_alias.specialization(self.db).types(self.db); + for (formal_ty, base_ty) in + formal_specialization.iter().zip(base_specialization) + { + self.infer(*formal_ty, *base_ty)?; + } + return Ok(()); + } + } + + (Type::Union(formal), _) => { + // TODO: We haven't implemented a full unification solver yet. If typevars appear + // in multiple union elements, we ideally want to express that _only one_ of them + // needs to match, and that we should infer the smallest type mapping that allows + // that. + // + // For now, we punt on handling multiple typevar elements. Instead, if _precisely + // one_ union element _is_ a typevar (not _contains_ a typevar), then we go ahead + // and add a mapping between that typevar and the actual type. (Note that we've + // already handled above the case where the actual is assignable to a _non-typevar_ + // union element.) + let mut typevars = formal.iter(self.db).filter_map(|ty| match ty { + Type::TypeVar(typevar) => Some(*typevar), + _ => None, + }); + let typevar = typevars.next(); + let additional_typevars = typevars.next(); + if let (Some(typevar), None) = (typevar, additional_typevars) { + self.add_type_mapping(typevar, actual); + } + } + + (Type::Intersection(formal), _) => { + // The actual type must be assignable to every (positive) element of the + // formal intersection, so we must infer type mappings for each of them. (The + // actual type must also be disjoint from every negative element of the + // intersection, but that doesn't help us infer any type mappings.) + for positive in formal.iter_positive(self.db) { + self.infer(positive, actual)?; + } + } + + // TODO: Add more forms that we can structurally induct into: type[C], callables + _ => {} + } + + Ok(()) + } +} + +#[derive(Clone, Debug, Eq, PartialEq)] +pub(crate) enum SpecializationError<'db> { + MismatchedBound { + typevar: TypeVarInstance<'db>, + argument: Type<'db>, + }, + MismatchedConstraint { + typevar: TypeVarInstance<'db>, + argument: Type<'db>, + }, +} + +impl<'db> SpecializationError<'db> { + pub(crate) fn typevar(&self) -> TypeVarInstance<'db> { + match self { + Self::MismatchedBound { typevar, .. } => *typevar, + Self::MismatchedConstraint { typevar, .. } => *typevar, + } + } + + pub(crate) fn argument_type(&self) -> Type<'db> { + match self { + Self::MismatchedBound { argument, .. } => *argument, + Self::MismatchedConstraint { argument, .. } => *argument, + } + } +} diff --git a/crates/ty_python_semantic/src/types/infer.rs b/crates/ty_python_semantic/src/types/infer.rs new file mode 100644 index 0000000000000..46c383eaa76bf --- /dev/null +++ b/crates/ty_python_semantic/src/types/infer.rs @@ -0,0 +1,9711 @@ +//! We have Salsa queries for inferring types at three different granularities: scope-level, +//! definition-level, and expression-level. +//! +//! Scope-level inference is for when we are actually checking a file, and need to check types for +//! everything in that file's scopes, or give a linter access to types of arbitrary expressions +//! (via the [`HasType`](crate::semantic_model::HasType) trait). +//! +//! Definition-level inference allows us to look up the types of symbols in other scopes (e.g. for +//! imports) with the minimum inference necessary, so that if we're looking up one symbol from a +//! very large module, we can avoid a bunch of unnecessary work. Definition-level inference also +//! allows us to handle import cycles without getting into a cycle of scope-level inference +//! queries. +//! +//! The expression-level inference query is needed in only a few cases. Since some assignments can +//! have multiple targets (via `x = y = z` or unpacking `(x, y) = z`, they can be associated with +//! multiple definitions (one per assigned symbol). In order to avoid inferring the type of the +//! right-hand side once per definition, we infer it as a standalone query, so its result will be +//! cached by Salsa. We also need the expression-level query for inferring types in type guard +//! expressions (e.g. the test clause of an `if` statement.) +//! +//! Inferring types at any of the three region granularities returns a [`TypeInference`], which +//! holds types for every [`Definition`] and expression within the inferred region. +//! +//! Some type expressions can require deferred evaluation. This includes all type expressions in +//! stub files, or annotation expressions in modules with `from __future__ import annotations`, or +//! stringified annotations. We have a fourth Salsa query for inferring the deferred types +//! associated with a particular definition. Scope-level inference infers deferred types for all +//! definitions once the rest of the types in the scope have been inferred. +//! +//! Many of our type inference Salsa queries implement cycle recovery via fixed-point iteration. In +//! general, they initiate fixed-point iteration by returning a `TypeInference` that returns +//! `Type::Never` for all expressions, bindings, and declarations, and then they continue iterating +//! the query cycle until a fixed-point is reached. Salsa has a built-in fixed limit on the number +//! of iterations, so if we fail to converge, Salsa will eventually panic. (This should of course +//! be considered a bug.) +use itertools::{Either, Itertools}; +use ruff_db::diagnostic::{Annotation, DiagnosticId, Severity}; +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_python_ast::visitor::{Visitor, walk_expr}; +use ruff_python_ast::{self as ast, AnyNodeRef, ExprContext, PythonVersion}; +use ruff_text_size::{Ranged, TextRange}; +use rustc_hash::{FxHashMap, FxHashSet}; +use salsa; +use salsa::plumbing::AsId; + +use crate::module_name::{ModuleName, ModuleNameResolutionError}; +use crate::module_resolver::resolve_module; +use crate::node_key::NodeKey; +use crate::semantic_index::ast_ids::{HasScopedExpressionId, HasScopedUseId, ScopedExpressionId}; +use crate::semantic_index::definition::{ + AnnotatedAssignmentDefinitionKind, AssignmentDefinitionKind, ComprehensionDefinitionKind, + Definition, DefinitionKind, DefinitionNodeKey, ExceptHandlerDefinitionKind, + ForStmtDefinitionKind, TargetKind, WithItemDefinitionKind, +}; +use crate::semantic_index::expression::{Expression, ExpressionKind}; +use crate::semantic_index::narrowing_constraints::ConstraintKey; +use crate::semantic_index::symbol::{ + FileScopeId, NodeWithScopeKind, NodeWithScopeRef, ScopeId, ScopeKind, ScopedSymbolId, +}; +use crate::semantic_index::{EagerSnapshotResult, SemanticIndex, semantic_index}; +use crate::symbol::{ + Boundness, LookupError, builtins_module_scope, builtins_symbol, explicit_global_symbol, + global_symbol, module_type_implicit_global_declaration, module_type_implicit_global_symbol, + symbol, symbol_from_bindings, symbol_from_declarations, typing_extensions_symbol, +}; +use crate::types::call::{Argument, Bindings, CallArgumentTypes, CallArguments, CallError}; +use crate::types::class::{MetaclassErrorKind, SliceLiteral}; +use crate::types::diagnostic::{ + self, CALL_NON_CALLABLE, CALL_POSSIBLY_UNBOUND_METHOD, CONFLICTING_DECLARATIONS, + CONFLICTING_METACLASS, CYCLIC_CLASS_DEFINITION, DIVISION_BY_ZERO, INCONSISTENT_MRO, + INVALID_ARGUMENT_TYPE, INVALID_ASSIGNMENT, INVALID_ATTRIBUTE_ACCESS, INVALID_BASE, + INVALID_DECLARATION, INVALID_GENERIC_CLASS, INVALID_LEGACY_TYPE_VARIABLE, + INVALID_PARAMETER_DEFAULT, INVALID_TYPE_ALIAS_TYPE, INVALID_TYPE_FORM, + INVALID_TYPE_VARIABLE_CONSTRAINTS, POSSIBLY_UNBOUND_IMPORT, TypeCheckDiagnostics, + UNDEFINED_REVEAL, UNRESOLVED_ATTRIBUTE, UNRESOLVED_IMPORT, UNSUPPORTED_OPERATOR, + report_implicit_return_type, report_invalid_arguments_to_annotated, + report_invalid_arguments_to_callable, report_invalid_assignment, + report_invalid_attribute_assignment, report_invalid_generator_function_return_type, + report_invalid_return_type, report_possibly_unbound_attribute, +}; +use crate::types::generics::GenericContext; +use crate::types::mro::MroErrorKind; +use crate::types::unpacker::{UnpackResult, Unpacker}; +use crate::types::{ + BareTypeAliasType, CallDunderError, CallableSignature, CallableType, ClassLiteral, ClassType, + DataclassParams, DynamicType, FunctionDecorators, FunctionType, GenericAlias, + IntersectionBuilder, IntersectionType, KnownClass, KnownFunction, KnownInstanceType, + MemberLookupPolicy, MetaclassCandidate, PEP695TypeAliasType, Parameter, ParameterForm, + Parameters, Signature, Signatures, StringLiteralType, SubclassOfType, Symbol, + SymbolAndQualifiers, Truthiness, TupleType, Type, TypeAliasType, TypeAndQualifiers, + TypeArrayDisplay, TypeQualifiers, TypeVarBoundOrConstraints, TypeVarInstance, TypeVarKind, + TypeVarVariance, UnionBuilder, UnionType, binding_type, todo_type, +}; +use crate::unpack::{Unpack, UnpackPosition}; +use crate::util::subscript::{PyIndex, PySlice}; +use crate::{Db, FxOrderSet, Program}; + +use super::context::{InNoTypeCheck, InferContext}; +use super::diagnostic::{ + INVALID_METACLASS, INVALID_OVERLOAD, INVALID_PROTOCOL, REDUNDANT_CAST, STATIC_ASSERT_ERROR, + SUBCLASS_OF_FINAL_CLASS, TYPE_ASSERTION_FAILURE, report_attempted_protocol_instantiation, + report_bad_argument_to_get_protocol_members, report_duplicate_bases, + report_index_out_of_bounds, report_invalid_exception_caught, report_invalid_exception_cause, + report_invalid_exception_raised, report_invalid_or_unsupported_base, + report_invalid_type_checking_constant, report_non_subscriptable, + report_possibly_unresolved_reference, + report_runtime_check_against_non_runtime_checkable_protocol, report_slice_step_size_zero, + report_unresolved_reference, +}; +use super::generics::{GenericContextOrigin, LegacyGenericBase}; +use super::slots::check_class_slots; +use super::string_annotation::{ + BYTE_STRING_TYPE_ANNOTATION, FSTRING_TYPE_ANNOTATION, parse_string_annotation, +}; +use super::subclass_of::SubclassOfInner; +use super::{BoundSuperError, BoundSuperType, ClassBase}; + +/// Infer all types for a [`ScopeId`], including all definitions and expressions in that scope. +/// Use when checking a scope, or needing to provide a type for an arbitrary expression in the +/// scope. +#[salsa::tracked(returns(ref), cycle_fn=scope_cycle_recover, cycle_initial=scope_cycle_initial)] +pub(crate) fn infer_scope_types<'db>(db: &'db dyn Db, scope: ScopeId<'db>) -> TypeInference<'db> { + let file = scope.file(db); + let _span = tracing::trace_span!("infer_scope_types", scope=?scope.as_id(), ?file).entered(); + + // Using the index here is fine because the code below depends on the AST anyway. + // The isolation of the query is by the return inferred types. + let index = semantic_index(db, file); + + TypeInferenceBuilder::new(db, InferenceRegion::Scope(scope), index).finish() +} + +fn scope_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &TypeInference<'db>, + _count: u32, + _scope: ScopeId<'db>, +) -> salsa::CycleRecoveryAction<TypeInference<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn scope_cycle_initial<'db>(_db: &'db dyn Db, scope: ScopeId<'db>) -> TypeInference<'db> { + TypeInference::cycle_fallback(scope, Type::Never) +} + +/// Infer all types for a [`Definition`] (including sub-expressions). +/// Use when resolving a symbol name use or public type of a symbol. +#[salsa::tracked(returns(ref), cycle_fn=definition_cycle_recover, cycle_initial=definition_cycle_initial)] +pub(crate) fn infer_definition_types<'db>( + db: &'db dyn Db, + definition: Definition<'db>, +) -> TypeInference<'db> { + let file = definition.file(db); + let _span = tracing::trace_span!( + "infer_definition_types", + range = ?definition.kind(db).target_range(), + ?file + ) + .entered(); + + let index = semantic_index(db, file); + + TypeInferenceBuilder::new(db, InferenceRegion::Definition(definition), index).finish() +} + +fn definition_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &TypeInference<'db>, + _count: u32, + _definition: Definition<'db>, +) -> salsa::CycleRecoveryAction<TypeInference<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn definition_cycle_initial<'db>( + db: &'db dyn Db, + definition: Definition<'db>, +) -> TypeInference<'db> { + TypeInference::cycle_fallback(definition.scope(db), Type::Never) +} + +/// Infer types for all deferred type expressions in a [`Definition`]. +/// +/// Deferred expressions are type expressions (annotations, base classes, aliases...) in a stub +/// file, or in a file with `from __future__ import annotations`, or stringified annotations. +#[salsa::tracked(returns(ref), cycle_fn=deferred_cycle_recover, cycle_initial=deferred_cycle_initial)] +pub(crate) fn infer_deferred_types<'db>( + db: &'db dyn Db, + definition: Definition<'db>, +) -> TypeInference<'db> { + let file = definition.file(db); + let _span = tracing::trace_span!( + "infer_deferred_types", + definition = ?definition.as_id(), + range = ?definition.kind(db).target_range(), + ?file + ) + .entered(); + + let index = semantic_index(db, file); + + TypeInferenceBuilder::new(db, InferenceRegion::Deferred(definition), index).finish() +} + +fn deferred_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &TypeInference<'db>, + _count: u32, + _definition: Definition<'db>, +) -> salsa::CycleRecoveryAction<TypeInference<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn deferred_cycle_initial<'db>(db: &'db dyn Db, definition: Definition<'db>) -> TypeInference<'db> { + TypeInference::cycle_fallback(definition.scope(db), Type::Never) +} + +/// Infer all types for an [`Expression`] (including sub-expressions). +/// Use rarely; only for cases where we'd otherwise risk double-inferring an expression: RHS of an +/// assignment, which might be unpacking/multi-target and thus part of multiple definitions, or a +/// type narrowing guard expression (e.g. if statement test node). +#[salsa::tracked(returns(ref), cycle_fn=expression_cycle_recover, cycle_initial=expression_cycle_initial)] +pub(crate) fn infer_expression_types<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> TypeInference<'db> { + let file = expression.file(db); + let _span = tracing::trace_span!( + "infer_expression_types", + expression = ?expression.as_id(), + range = ?expression.node_ref(db).range(), + ?file + ) + .entered(); + + let index = semantic_index(db, file); + + TypeInferenceBuilder::new(db, InferenceRegion::Expression(expression), index).finish() +} + +fn expression_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &TypeInference<'db>, + _count: u32, + _expression: Expression<'db>, +) -> salsa::CycleRecoveryAction<TypeInference<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn expression_cycle_initial<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> TypeInference<'db> { + TypeInference::cycle_fallback(expression.scope(db), Type::Never) +} + +/// Infers the type of an `expression` that is guaranteed to be in the same file as the calling query. +/// +/// This is a small helper around [`infer_expression_types()`] to reduce the boilerplate. +/// Use [`infer_expression_type()`] if it isn't guaranteed that `expression` is in the same file to +/// avoid cross-file query dependencies. +pub(super) fn infer_same_file_expression_type<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> Type<'db> { + let inference = infer_expression_types(db, expression); + let scope = expression.scope(db); + inference.expression_type(expression.node_ref(db).scoped_expression_id(db, scope)) +} + +/// Infers the type of an expression where the expression might come from another file. +/// +/// Use this over [`infer_expression_types`] if the expression might come from another file than the +/// enclosing query to avoid cross-file query dependencies. +/// +/// Use [`infer_same_file_expression_type`] if it is guaranteed that `expression` is in the same +/// to avoid unnecessary salsa ingredients. This is normally the case inside the `TypeInferenceBuilder`. +#[salsa::tracked(cycle_fn=single_expression_cycle_recover, cycle_initial=single_expression_cycle_initial)] +pub(crate) fn infer_expression_type<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> Type<'db> { + // It's okay to call the "same file" version here because we're inside a salsa query. + infer_same_file_expression_type(db, expression) +} + +fn single_expression_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Type<'db>, + _count: u32, + _expression: Expression<'db>, +) -> salsa::CycleRecoveryAction<Type<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn single_expression_cycle_initial<'db>( + _db: &'db dyn Db, + _expression: Expression<'db>, +) -> Type<'db> { + Type::Never +} + +/// Infer the types for an [`Unpack`] operation. +/// +/// This infers the expression type and performs structural match against the target expression +/// involved in an unpacking operation. It returns a result-like object that can be used to get the +/// type of the variables involved in this unpacking along with any violations that are detected +/// during this unpacking. +#[salsa::tracked(returns(ref), cycle_fn=unpack_cycle_recover, cycle_initial=unpack_cycle_initial)] +pub(super) fn infer_unpack_types<'db>(db: &'db dyn Db, unpack: Unpack<'db>) -> UnpackResult<'db> { + let file = unpack.file(db); + let _span = + tracing::trace_span!("infer_unpack_types", range=?unpack.range(db), ?file).entered(); + + let mut unpacker = Unpacker::new(db, unpack.target_scope(db), unpack.value_scope(db)); + unpacker.unpack(unpack.target(db), unpack.value(db)); + unpacker.finish() +} + +fn unpack_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &UnpackResult<'db>, + _count: u32, + _unpack: Unpack<'db>, +) -> salsa::CycleRecoveryAction<UnpackResult<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn unpack_cycle_initial<'db>(_db: &'db dyn Db, _unpack: Unpack<'db>) -> UnpackResult<'db> { + UnpackResult::cycle_fallback(Type::Never) +} + +/// Returns the type of the nearest enclosing class for the given scope. +/// +/// This function walks up the ancestor scopes starting from the given scope, +/// and finds the closest class definition. This is different to the behaviour of +/// [`TypeInferenceBuilder::class_context_of_current_method`], which will only return +/// `Some(class)` if either the immediate parent scope is a class OR the immediate parent +/// scope is a type-parameters scope and the grandparent scope is a class. +/// +/// Returns `None` if no enclosing class is found. +pub(crate) fn nearest_enclosing_class<'db>( + db: &'db dyn Db, + semantic: &SemanticIndex<'db>, + scope: ScopeId, +) -> Option<ClassLiteral<'db>> { + semantic + .ancestor_scopes(scope.file_scope_id(db)) + .find_map(|(_, ancestor_scope)| { + let class = ancestor_scope.node().as_class()?; + let definition = semantic.expect_single_definition(class); + infer_definition_types(db, definition) + .declaration_type(definition) + .inner_type() + .into_class_literal() + }) +} + +/// A region within which we can infer types. +#[derive(Copy, Clone, Debug)] +pub(crate) enum InferenceRegion<'db> { + /// infer types for a standalone [`Expression`] + Expression(Expression<'db>), + /// infer types for a [`Definition`] + Definition(Definition<'db>), + /// infer deferred types for a [`Definition`] + Deferred(Definition<'db>), + /// infer types for an entire [`ScopeId`] + Scope(ScopeId<'db>), +} + +impl<'db> InferenceRegion<'db> { + fn scope(self, db: &'db dyn Db) -> ScopeId<'db> { + match self { + InferenceRegion::Expression(expression) => expression.scope(db), + InferenceRegion::Definition(definition) | InferenceRegion::Deferred(definition) => { + definition.scope(db) + } + InferenceRegion::Scope(scope) => scope, + } + } +} + +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +struct TypeAndRange<'db> { + ty: Type<'db>, + range: TextRange, +} + +/// The inferred types for a single region. +#[derive(Debug, Eq, PartialEq, salsa::Update)] +pub(crate) struct TypeInference<'db> { + /// The types of every expression in this region. + expressions: FxHashMap<ScopedExpressionId, Type<'db>>, + + /// The types of every binding in this region. + bindings: FxHashMap<Definition<'db>, Type<'db>>, + + /// The types and type qualifiers of every declaration in this region. + declarations: FxHashMap<Definition<'db>, TypeAndQualifiers<'db>>, + + /// The definitions that are deferred. + deferred: FxHashSet<Definition<'db>>, + + /// The diagnostics for this region. + diagnostics: TypeCheckDiagnostics, + + /// The scope this region is part of. + scope: ScopeId<'db>, + + /// The fallback type for missing expressions/bindings/declarations. + /// + /// This is used only when constructing a cycle-recovery `TypeInference`. + cycle_fallback_type: Option<Type<'db>>, +} + +impl<'db> TypeInference<'db> { + pub(crate) fn empty(scope: ScopeId<'db>) -> Self { + Self { + expressions: FxHashMap::default(), + bindings: FxHashMap::default(), + declarations: FxHashMap::default(), + deferred: FxHashSet::default(), + diagnostics: TypeCheckDiagnostics::default(), + scope, + cycle_fallback_type: None, + } + } + + fn cycle_fallback(scope: ScopeId<'db>, cycle_fallback_type: Type<'db>) -> Self { + Self { + expressions: FxHashMap::default(), + bindings: FxHashMap::default(), + declarations: FxHashMap::default(), + deferred: FxHashSet::default(), + diagnostics: TypeCheckDiagnostics::default(), + scope, + cycle_fallback_type: Some(cycle_fallback_type), + } + } + + #[track_caller] + pub(crate) fn expression_type(&self, expression: ScopedExpressionId) -> Type<'db> { + self.try_expression_type(expression).expect( + "expression should belong to this TypeInference region and \ + TypeInferenceBuilder should have inferred a type for it", + ) + } + + pub(crate) fn try_expression_type(&self, expression: ScopedExpressionId) -> Option<Type<'db>> { + self.expressions + .get(&expression) + .copied() + .or(self.cycle_fallback_type) + } + + #[track_caller] + pub(crate) fn binding_type(&self, definition: Definition<'db>) -> Type<'db> { + self.bindings + .get(&definition) + .copied() + .or(self.cycle_fallback_type) + .expect( + "definition should belong to this TypeInference region and \ + TypeInferenceBuilder should have inferred a type for it", + ) + } + + #[track_caller] + pub(crate) fn declaration_type(&self, definition: Definition<'db>) -> TypeAndQualifiers<'db> { + self.declarations + .get(&definition) + .copied() + .or(self.cycle_fallback_type.map(Into::into)) + .expect( + "definition should belong to this TypeInference region and \ + TypeInferenceBuilder should have inferred a type for it", + ) + } + + pub(crate) fn diagnostics(&self) -> &TypeCheckDiagnostics { + &self.diagnostics + } + + fn shrink_to_fit(&mut self) { + self.expressions.shrink_to_fit(); + self.bindings.shrink_to_fit(); + self.declarations.shrink_to_fit(); + self.diagnostics.shrink_to_fit(); + self.deferred.shrink_to_fit(); + } +} + +/// Whether the intersection type is on the left or right side of the comparison. +#[derive(Debug, Clone, Copy)] +enum IntersectionOn { + Left, + Right, +} + +/// A helper to track if we already know that declared and inferred types are the same. +#[derive(Debug, Clone, PartialEq, Eq)] +enum DeclaredAndInferredType<'db> { + /// We know that both the declared and inferred types are the same. + AreTheSame(Type<'db>), + /// Declared and inferred types might be different, we need to check assignability. + MightBeDifferent { + declared_ty: TypeAndQualifiers<'db>, + inferred_ty: Type<'db>, + }, +} + +/// Builder to infer all types in a region. +/// +/// A builder is used by creating it with [`new()`](TypeInferenceBuilder::new), and then calling +/// [`finish()`](TypeInferenceBuilder::finish) on it, which returns the resulting +/// [`TypeInference`]. +/// +/// There are a few different kinds of methods in the type inference builder, and the naming +/// distinctions are a bit subtle. +/// +/// The `finish` method calls [`infer_region`](TypeInferenceBuilder::infer_region), which delegates +/// to one of [`infer_region_scope`](TypeInferenceBuilder::infer_region_scope), +/// [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition), or +/// [`infer_region_expression`](TypeInferenceBuilder::infer_region_expression), depending which +/// kind of [`InferenceRegion`] we are inferring types for. +/// +/// Scope inference starts with the scope body, walking all statements and expressions and +/// recording the types of each expression in the [`TypeInference`] result. Most of the methods +/// here (with names like `infer_*_statement` or `infer_*_expression` or some other node kind) take +/// a single AST node and are called as part of this AST visit. +/// +/// When the visit encounters a node which creates a [`Definition`], we look up the definition in +/// the semantic index and call the [`infer_definition_types()`] query on it, which creates another +/// [`TypeInferenceBuilder`] just for that definition, and we merge the returned [`TypeInference`] +/// into the one we are currently building for the entire scope. Using the query in this way +/// ensures that if we first infer types for some scattered definitions in a scope, and later for +/// the entire scope, we don't re-infer any types, we reuse the cached inference for those +/// definitions and their sub-expressions. +/// +/// Functions with a name like `infer_*_definition` take both a node and a [`Definition`], and are +/// called by [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition). +/// +/// So for example we have both +/// [`infer_function_definition_statement`](TypeInferenceBuilder::infer_function_definition_statement), +/// which takes just the function AST node, and +/// [`infer_function_definition`](TypeInferenceBuilder::infer_function_definition), which takes +/// both the node and the [`Definition`] id. The former is called as part of walking the AST, and +/// it just looks up the [`Definition`] for that function in the semantic index and calls +/// [`infer_definition_types()`] on it, which will create a new [`TypeInferenceBuilder`] with +/// [`InferenceRegion::Definition`], and in that builder +/// [`infer_region_definition`](TypeInferenceBuilder::infer_region_definition) will call +/// [`infer_function_definition`](TypeInferenceBuilder::infer_function_definition) to actually +/// infer a type for the definition. +/// +/// Similarly, when we encounter a standalone-inferable expression (right-hand side of an +/// assignment, type narrowing guard), we use the [`infer_expression_types()`] query to ensure we +/// don't infer its types more than once. +pub(super) struct TypeInferenceBuilder<'db> { + context: InferContext<'db>, + index: &'db SemanticIndex<'db>, + region: InferenceRegion<'db>, + + /// The type inference results + types: TypeInference<'db>, + + /// The returned types and their corresponding ranges of the region, if it is a function body. + return_types_and_ranges: Vec<TypeAndRange<'db>>, + + /// A set of functions that have been defined **and** called in this region. + /// + /// This is a set because the same function could be called multiple times in the same region. + /// This is mainly used in [`check_overloaded_functions`] to check an overloaded function that + /// is shadowed by a function with the same name in this scope but has been called before. For + /// example: + /// + /// ```py + /// from typing import overload + /// + /// @overload + /// def foo() -> None: ... + /// @overload + /// def foo(x: int) -> int: ... + /// def foo(x: int | None) -> int | None: return x + /// + /// foo() # An overloaded function that was defined in this scope have been called + /// + /// def foo(x: int) -> int: + /// return x + /// ``` + /// + /// [`check_overloaded_functions`]: TypeInferenceBuilder::check_overloaded_functions + called_functions: FxHashSet<FunctionType<'db>>, + + /// The deferred state of inferring types of certain expressions within the region. + /// + /// This is different from [`InferenceRegion::Deferred`] which works on the entire definition + /// while this is relevant for specific expressions within the region itself and is updated + /// during the inference process. + /// + /// For example, when inferring the types of an annotated assignment, the type of an annotation + /// expression could be deferred if the file has `from __future__ import annotations` import or + /// is a stub file but we're still in a non-deferred region. + deferred_state: DeferredExpressionState, +} + +impl<'db> TypeInferenceBuilder<'db> { + /// How big a string do we build before bailing? + /// + /// This is a fairly arbitrary number. It should be *far* more than enough + /// for most use cases, but we can reevaluate it later if useful. + const MAX_STRING_LITERAL_SIZE: usize = 4096; + + /// Creates a new builder for inferring types in a region. + pub(super) fn new( + db: &'db dyn Db, + region: InferenceRegion<'db>, + index: &'db SemanticIndex<'db>, + ) -> Self { + let scope = region.scope(db); + + Self { + context: InferContext::new(db, scope), + index, + region, + return_types_and_ranges: vec![], + called_functions: FxHashSet::default(), + deferred_state: DeferredExpressionState::None, + types: TypeInference::empty(scope), + } + } + + fn extend(&mut self, inference: &TypeInference<'db>) { + debug_assert_eq!(self.types.scope, inference.scope); + + self.types.bindings.extend(inference.bindings.iter()); + self.types + .declarations + .extend(inference.declarations.iter()); + self.types.expressions.extend(inference.expressions.iter()); + self.types.deferred.extend(inference.deferred.iter()); + self.context.extend(inference.diagnostics()); + } + + fn file(&self) -> File { + self.context.file() + } + + fn db(&self) -> &'db dyn Db { + self.context.db() + } + + fn scope(&self) -> ScopeId<'db> { + self.types.scope + } + + /// Are we currently inferring types in file with deferred types? + /// This is true for stub files and files with `__future__.annotations` + fn defer_annotations(&self) -> bool { + self.index.has_future_annotations() || self.in_stub() + } + + /// Are we currently inferring deferred types? + fn is_deferred(&self) -> bool { + matches!(self.region, InferenceRegion::Deferred(_)) || self.deferred_state.is_deferred() + } + + /// Return the node key of the given AST node, or the key of the outermost enclosing string + /// literal, if the node originates from inside a stringified annotation. + fn enclosing_node_key(&self, node: AnyNodeRef<'_>) -> NodeKey { + match self.deferred_state { + DeferredExpressionState::InStringAnnotation(enclosing_node_key) => enclosing_node_key, + _ => NodeKey::from_node(node), + } + } + + /// Check if a given AST node is reachable. + /// + /// Note that this only works if reachability is explicitly tracked for this specific + /// type of node (see `node_reachability` in the use-def map). + fn is_reachable<'a, N>(&self, node: N) -> bool + where + N: Into<AnyNodeRef<'a>>, + { + let file_scope_id = self.scope().file_scope_id(self.db()); + self.index.is_node_reachable( + self.db(), + file_scope_id, + self.enclosing_node_key(node.into()), + ) + } + + fn in_stub(&self) -> bool { + self.context.in_stub() + } + + /// Get the already-inferred type of an expression node. + /// + /// ## Panics + /// If the expression is not within this region, or if no type has yet been inferred for + /// this node. + #[track_caller] + fn expression_type(&self, expr: &ast::Expr) -> Type<'db> { + self.types + .expression_type(expr.scoped_expression_id(self.db(), self.scope())) + } + + /// Get the type of an expression from any scope in the same file. + /// + /// If the expression is in the current scope, and we are inferring the entire scope, just look + /// up the expression in our own results, otherwise call [`infer_scope_types()`] for the scope + /// of the expression. + /// + /// ## Panics + /// + /// If the expression is in the current scope but we haven't yet inferred a type for it. + /// + /// Can cause query cycles if the expression is from a different scope and type inference is + /// already in progress for that scope (further up the stack). + fn file_expression_type(&self, expression: &ast::Expr) -> Type<'db> { + let file_scope = self.index.expression_scope_id(expression); + let expr_scope = file_scope.to_scope_id(self.db(), self.file()); + let expr_id = expression.scoped_expression_id(self.db(), expr_scope); + match self.region { + InferenceRegion::Scope(scope) if scope == expr_scope => { + self.expression_type(expression) + } + _ => infer_scope_types(self.db(), expr_scope).expression_type(expr_id), + } + } + + /// Infers types in the given [`InferenceRegion`]. + fn infer_region(&mut self) { + match self.region { + InferenceRegion::Scope(scope) => self.infer_region_scope(scope), + InferenceRegion::Definition(definition) => self.infer_region_definition(definition), + InferenceRegion::Deferred(definition) => self.infer_region_deferred(definition), + InferenceRegion::Expression(expression) => self.infer_region_expression(expression), + } + } + + fn infer_region_scope(&mut self, scope: ScopeId<'db>) { + let node = scope.node(self.db()); + match node { + NodeWithScopeKind::Module => { + let parsed = parsed_module(self.db().upcast(), self.file()); + self.infer_module(parsed.syntax()); + } + NodeWithScopeKind::Function(function) => self.infer_function_body(function.node()), + NodeWithScopeKind::Lambda(lambda) => self.infer_lambda_body(lambda.node()), + NodeWithScopeKind::Class(class) => self.infer_class_body(class.node()), + NodeWithScopeKind::ClassTypeParameters(class) => { + self.infer_class_type_params(class.node()); + } + NodeWithScopeKind::FunctionTypeParameters(function) => { + self.infer_function_type_params(function.node()); + } + NodeWithScopeKind::TypeAliasTypeParameters(type_alias) => { + self.infer_type_alias_type_params(type_alias.node()); + } + NodeWithScopeKind::TypeAlias(type_alias) => { + self.infer_type_alias(type_alias.node()); + } + NodeWithScopeKind::ListComprehension(comprehension) => { + self.infer_list_comprehension_expression_scope(comprehension.node()); + } + NodeWithScopeKind::SetComprehension(comprehension) => { + self.infer_set_comprehension_expression_scope(comprehension.node()); + } + NodeWithScopeKind::DictComprehension(comprehension) => { + self.infer_dict_comprehension_expression_scope(comprehension.node()); + } + NodeWithScopeKind::GeneratorExpression(generator) => { + self.infer_generator_expression_scope(generator.node()); + } + } + + // Infer the deferred types for the definitions here to consider the end-of-scope + // semantics. + for definition in std::mem::take(&mut self.types.deferred) { + self.extend(infer_deferred_types(self.db(), definition)); + } + assert!( + self.types.deferred.is_empty(), + "Inferring deferred types should not add more deferred definitions" + ); + + // TODO: Only call this function when diagnostics are enabled. + self.check_class_definitions(); + self.check_overloaded_functions(node); + } + + /// Iterate over all class definitions to check that the definition will not cause an exception + /// to be raised at runtime. This needs to be done after most other types in the scope have been + /// inferred, due to the fact that base classes can be deferred. If it looks like a class + /// definition is invalid in some way, issue a diagnostic. + /// + /// Among the things we check for in this method are whether Python will be able to determine a + /// consistent "[method resolution order]" and [metaclass] for each class. + /// + /// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order + /// [metaclass]: https://docs.python.org/3/reference/datamodel.html#metaclasses + fn check_class_definitions(&mut self) { + let class_definitions = self + .types + .declarations + .iter() + .filter_map(|(definition, ty)| { + // Filter out class literals that result from imports + if let DefinitionKind::Class(class) = definition.kind(self.db()) { + ty.inner_type() + .into_class_literal() + .map(|class_literal| (class_literal, class.node())) + } else { + None + } + }); + + // Iterate through all class definitions in this scope. + for (class, class_node) in class_definitions { + // (1) Check that the class does not have a cyclic definition + if let Some(inheritance_cycle) = class.inheritance_cycle(self.db()) { + if inheritance_cycle.is_participant() { + if let Some(builder) = self + .context + .report_lint(&CYCLIC_CLASS_DEFINITION, class_node) + { + builder.into_diagnostic(format_args!( + "Cyclic definition of `{}` (class cannot inherit from itself)", + class.name(self.db()) + )); + } + } + // If a class is cyclically defined, that's a sufficient error to report; the + // following checks (which are all inheritance-based) aren't even relevant. + continue; + } + + let is_protocol = class.is_protocol(self.db()); + + // (2) Iterate through the class's explicit bases to check for various possible errors: + // - Check for inheritance from plain `Generic`, + // - Check for inheritance from a `@final` classes + // - If the class is a protocol class: check for inheritance from a non-protocol class + for (i, base_class) in class.explicit_bases(self.db()).iter().enumerate() { + let base_class = match base_class { + Type::KnownInstance(KnownInstanceType::Generic(None)) => { + if let Some(builder) = self + .context + .report_lint(&INVALID_BASE, &class_node.bases()[i]) + { + // Unsubscripted `Generic` can appear in the MRO of many classes, + // but it is never valid as an explicit base class in user code. + builder.into_diagnostic("Cannot inherit from plain `Generic`"); + } + continue; + } + Type::ClassLiteral(class) => class, + // dynamic/unknown bases are never `@final` + _ => continue, + }; + + if is_protocol + && !(base_class.is_protocol(self.db()) + || base_class.is_known(self.db(), KnownClass::Object)) + { + if let Some(builder) = self + .context + .report_lint(&INVALID_PROTOCOL, &class_node.bases()[i]) + { + builder.into_diagnostic(format_args!( + "Protocol class `{}` cannot inherit from non-protocol class `{}`", + class.name(self.db()), + base_class.name(self.db()), + )); + } + } + + if base_class.is_final(self.db()) { + if let Some(builder) = self + .context + .report_lint(&SUBCLASS_OF_FINAL_CLASS, &class_node.bases()[i]) + { + builder.into_diagnostic(format_args!( + "Class `{}` cannot inherit from final class `{}`", + class.name(self.db()), + base_class.name(self.db()), + )); + } + } + } + + // (3) Check that the class's MRO is resolvable + match class.try_mro(self.db(), None) { + Err(mro_error) => match mro_error.reason() { + MroErrorKind::DuplicateBases(duplicates) => { + let base_nodes = class_node.bases(); + for duplicate in duplicates { + report_duplicate_bases(&self.context, class, duplicate, base_nodes); + } + } + MroErrorKind::InvalidBases(bases) => { + let base_nodes = class_node.bases(); + for (index, base_ty) in bases { + report_invalid_or_unsupported_base( + &self.context, + &base_nodes[*index], + *base_ty, + class, + ); + } + } + MroErrorKind::UnresolvableMro { bases_list } => { + if let Some(builder) = + self.context.report_lint(&INCONSISTENT_MRO, class_node) + { + builder.into_diagnostic(format_args!( + "Cannot create a consistent method resolution order (MRO) \ + for class `{}` with bases list `[{}]`", + class.name(self.db()), + bases_list + .iter() + .map(|base| base.display(self.db())) + .join(", ") + )); + } + } + MroErrorKind::InheritanceCycle => { + if let Some(builder) = self + .context + .report_lint(&CYCLIC_CLASS_DEFINITION, class_node) + { + builder.into_diagnostic(format_args!( + "Cyclic definition of `{}` (class cannot inherit from itself)", + class.name(self.db()) + )); + } + } + }, + Ok(_) => check_class_slots(&self.context, class, class_node), + } + + // (4) Check that the class's metaclass can be determined without error. + if let Err(metaclass_error) = class.try_metaclass(self.db()) { + match metaclass_error.reason() { + MetaclassErrorKind::Cycle => { + if let Some(builder) = self + .context + .report_lint(&CYCLIC_CLASS_DEFINITION, class_node) + { + builder.into_diagnostic(format_args!( + "Cyclic definition of `{}`", + class.name(self.db()) + )); + } + } + MetaclassErrorKind::NotCallable(ty) => { + if let Some(builder) = + self.context.report_lint(&INVALID_METACLASS, class_node) + { + builder.into_diagnostic(format_args!( + "Metaclass type `{}` is not callable", + ty.display(self.db()) + )); + } + } + MetaclassErrorKind::PartlyNotCallable(ty) => { + if let Some(builder) = + self.context.report_lint(&INVALID_METACLASS, class_node) + { + builder.into_diagnostic(format_args!( + "Metaclass type `{}` is partly not callable", + ty.display(self.db()) + )); + } + } + MetaclassErrorKind::Conflict { + candidate1: + MetaclassCandidate { + metaclass: metaclass1, + explicit_metaclass_of: class1, + }, + candidate2: + MetaclassCandidate { + metaclass: metaclass2, + explicit_metaclass_of: class2, + }, + candidate1_is_base_class, + } => { + if let Some(builder) = + self.context.report_lint(&CONFLICTING_METACLASS, class_node) + { + if *candidate1_is_base_class { + builder.into_diagnostic(format_args!( + "The metaclass of a derived class (`{class}`) \ + must be a subclass of the metaclasses of all its bases, \ + but `{metaclass1}` (metaclass of base class `{base1}`) \ + and `{metaclass2}` (metaclass of base class `{base2}`) \ + have no subclass relationship", + class = class.name(self.db()), + metaclass1 = metaclass1.name(self.db()), + base1 = class1.name(self.db()), + metaclass2 = metaclass2.name(self.db()), + base2 = class2.name(self.db()), + )); + } else { + builder.into_diagnostic(format_args!( + "The metaclass of a derived class (`{class}`) \ + must be a subclass of the metaclasses of all its bases, \ + but `{metaclass_of_class}` (metaclass of `{class}`) \ + and `{metaclass_of_base}` (metaclass of base class `{base}`) \ + have no subclass relationship", + class = class.name(self.db()), + metaclass_of_class = metaclass1.name(self.db()), + metaclass_of_base = metaclass2.name(self.db()), + base = class2.name(self.db()), + )); + } + } + } + } + } + + // (5) Check that a generic class does not have invalid or conflicting generic + // contexts. + if class.pep695_generic_context(self.db()).is_some() { + if let Some(legacy_context) = class.legacy_generic_context(self.db()) { + if let Some(builder) = + self.context.report_lint(&INVALID_GENERIC_CLASS, class_node) + { + builder.into_diagnostic(format_args!( + "Cannot both inherit from {} and use PEP 695 type variables", + legacy_context.origin(self.db()) + )); + } + } + } + + if let (Some(legacy), Some(inherited)) = ( + class.legacy_generic_context(self.db()), + class.inherited_legacy_generic_context(self.db()), + ) { + if !inherited.is_subset_of(self.db(), legacy) { + if let Some(builder) = + self.context.report_lint(&INVALID_GENERIC_CLASS, class_node) + { + builder.into_diagnostic( + "`Generic` base class must include all type \ + variables used in other base classes", + ); + } + } + } + } + } + + /// Check the overloaded functions in this scope. + /// + /// This only checks the overloaded functions that are: + /// 1. Visible publicly at the end of this scope + /// 2. Or, defined and called in this scope + /// + /// For (1), this has the consequence of not checking an overloaded function that is being + /// shadowed by another function with the same name in this scope. + fn check_overloaded_functions(&mut self, scope: &NodeWithScopeKind) { + // Collect all the unique overloaded function symbols in this scope. This requires a set + // because an overloaded function uses the same symbol for each of the overloads and the + // implementation. + let overloaded_function_symbols: FxHashSet<_> = self + .types + .declarations + .iter() + .filter_map(|(definition, ty)| { + // Filter out function literals that result from anything other than a function + // definition e.g., imports which would create a cross-module AST dependency. + if !matches!(definition.kind(self.db()), DefinitionKind::Function(_)) { + return None; + } + let function = ty.inner_type().into_function_literal()?; + if function.has_known_decorator(self.db(), FunctionDecorators::OVERLOAD) { + Some(definition.symbol(self.db())) + } else { + None + } + }) + .collect(); + + let use_def = self + .index + .use_def_map(self.scope().file_scope_id(self.db())); + + let mut public_functions = FxHashSet::default(); + + for symbol in overloaded_function_symbols { + if let Symbol::Type(Type::FunctionLiteral(function), Boundness::Bound) = + symbol_from_bindings(self.db(), use_def.public_bindings(symbol)) + { + if function.file(self.db()) != self.file() { + // If the function is not in this file, we don't need to check it. + // https://github.com/astral-sh/ruff/pull/17609#issuecomment-2839445740 + continue; + } + + // Extend the functions that we need to check with the publicly visible overloaded + // function. This is always going to be either the implementation or the last + // overload if the implementation doesn't exists. + public_functions.insert(function); + } + } + + for function in self.called_functions.union(&public_functions) { + let Some(overloaded) = function.to_overloaded(self.db()) else { + continue; + }; + + // Check that the overloaded function has at least two overloads + if let [single_overload] = overloaded.overloads.as_slice() { + let function_node = function.node(self.db(), self.file()); + if let Some(builder) = self + .context + .report_lint(&INVALID_OVERLOAD, &function_node.name) + { + let mut diagnostic = builder.into_diagnostic(format_args!( + "Overloaded function `{}` requires at least two overloads", + &function_node.name + )); + diagnostic.annotate( + self.context + .secondary(single_overload.focus_range(self.db())) + .message(format_args!("Only one overload defined here")), + ); + } + } + + // Check that the overloaded function has an implementation. Overload definitions + // within stub files, protocols, and on abstract methods within abstract base classes + // are exempt from this check. + if overloaded.implementation.is_none() && !self.in_stub() { + let mut implementation_required = true; + + if let NodeWithScopeKind::Class(class_node_ref) = scope { + let class = binding_type( + self.db(), + self.index.expect_single_definition(class_node_ref.node()), + ) + .expect_class_literal(); + + if class.is_protocol(self.db()) + || (class.is_abstract(self.db()) + && overloaded.overloads.iter().all(|overload| { + overload.has_known_decorator( + self.db(), + FunctionDecorators::ABSTRACT_METHOD, + ) + })) + { + implementation_required = false; + } + } + + if implementation_required { + let function_node = function.node(self.db(), self.file()); + if let Some(builder) = self + .context + .report_lint(&INVALID_OVERLOAD, &function_node.name) + { + builder.into_diagnostic(format_args!( + "Overloaded non-stub function `{}` must have an implementation", + &function_node.name + )); + } + } + } + + // TODO: Add `@staticmethod` + for (decorator, name) in [(FunctionDecorators::CLASSMETHOD, "classmethod")] { + let mut decorator_present = false; + let mut decorator_missing = vec![]; + + for function in overloaded.all() { + if function.has_known_decorator(self.db(), decorator) { + decorator_present = true; + } else { + decorator_missing.push(function); + } + } + + if !decorator_present { + // Both overloads and implementation does not have the decorator + continue; + } + if decorator_missing.is_empty() { + // All overloads and implementation have the decorator + continue; + } + + let function_node = function.node(self.db(), self.file()); + if let Some(builder) = self + .context + .report_lint(&INVALID_OVERLOAD, &function_node.name) + { + let mut diagnostic = builder.into_diagnostic(format_args!( + "Overloaded function `{}` does not use the `@{name}` decorator \ + consistently", + &function_node.name + )); + for function in decorator_missing { + diagnostic.annotate( + self.context + .secondary(function.focus_range(self.db())) + .message(format_args!("Missing here")), + ); + } + } + } + + for (decorator, name) in [ + (FunctionDecorators::FINAL, "final"), + (FunctionDecorators::OVERRIDE, "override"), + ] { + if let Some(implementation) = overloaded.implementation.as_ref() { + for overload in &overloaded.overloads { + if !overload.has_known_decorator(self.db(), decorator) { + continue; + } + let function_node = function.node(self.db(), self.file()); + let Some(builder) = self + .context + .report_lint(&INVALID_OVERLOAD, &function_node.name) + else { + continue; + }; + let mut diagnostic = builder.into_diagnostic(format_args!( + "`@{name}` decorator should be applied only to the \ + overload implementation" + )); + diagnostic.annotate( + self.context + .secondary(implementation.focus_range(self.db())) + .message(format_args!("Implementation defined here")), + ); + } + } else { + let mut overloads = overloaded.overloads.iter(); + let Some(first_overload) = overloads.next() else { + continue; + }; + for overload in overloads { + if !overload.has_known_decorator(self.db(), decorator) { + continue; + } + let function_node = function.node(self.db(), self.file()); + let Some(builder) = self + .context + .report_lint(&INVALID_OVERLOAD, &function_node.name) + else { + continue; + }; + let mut diagnostic = builder.into_diagnostic(format_args!( + "`@{name}` decorator should be applied only to the \ + first overload" + )); + diagnostic.annotate( + self.context + .secondary(first_overload.focus_range(self.db())) + .message(format_args!("First overload defined here")), + ); + } + } + } + } + } + + fn infer_region_definition(&mut self, definition: Definition<'db>) { + match definition.kind(self.db()) { + DefinitionKind::Function(function) => { + self.infer_function_definition(function.node(), definition); + } + DefinitionKind::Class(class) => self.infer_class_definition(class.node(), definition), + DefinitionKind::TypeAlias(type_alias) => { + self.infer_type_alias_definition(type_alias.node(), definition); + } + DefinitionKind::Import(import) => { + self.infer_import_definition(import.import(), import.alias(), definition); + } + DefinitionKind::ImportFrom(import_from) => { + self.infer_import_from_definition( + import_from.import(), + import_from.alias(), + definition, + ); + } + DefinitionKind::StarImport(import) => { + self.infer_import_from_definition(import.import(), import.alias(), definition); + } + DefinitionKind::Assignment(assignment) => { + self.infer_assignment_definition(assignment, definition); + } + DefinitionKind::AnnotatedAssignment(annotated_assignment) => { + self.infer_annotated_assignment_definition(annotated_assignment, definition); + } + DefinitionKind::AugmentedAssignment(augmented_assignment) => { + self.infer_augment_assignment_definition(augmented_assignment.node(), definition); + } + DefinitionKind::For(for_statement_definition) => { + self.infer_for_statement_definition(for_statement_definition, definition); + } + DefinitionKind::NamedExpression(named_expression) => { + self.infer_named_expression_definition(named_expression.node(), definition); + } + DefinitionKind::Comprehension(comprehension) => { + self.infer_comprehension_definition(comprehension, definition); + } + DefinitionKind::VariadicPositionalParameter(parameter) => { + self.infer_variadic_positional_parameter_definition(parameter, definition); + } + DefinitionKind::VariadicKeywordParameter(parameter) => { + self.infer_variadic_keyword_parameter_definition(parameter, definition); + } + DefinitionKind::Parameter(parameter_with_default) => { + self.infer_parameter_definition(parameter_with_default, definition); + } + DefinitionKind::WithItem(with_item_definition) => { + self.infer_with_item_definition(with_item_definition, definition); + } + DefinitionKind::MatchPattern(match_pattern) => { + self.infer_match_pattern_definition( + match_pattern.pattern(), + match_pattern.index(), + definition, + ); + } + DefinitionKind::ExceptHandler(except_handler_definition) => { + self.infer_except_handler_definition(except_handler_definition, definition); + } + DefinitionKind::TypeVar(node) => { + self.infer_typevar_definition(node, definition); + } + DefinitionKind::ParamSpec(node) => { + self.infer_paramspec_definition(node, definition); + } + DefinitionKind::TypeVarTuple(node) => { + self.infer_typevartuple_definition(node, definition); + } + } + } + + fn infer_region_deferred(&mut self, definition: Definition<'db>) { + // N.B. We don't defer the types for an annotated assignment here because it is done in + // the same definition query. It utilizes the deferred expression state instead. + // + // This is because for partially stringified annotations like `a: tuple[int, "ForwardRef"]`, + // we need to defer the types of non-stringified expressions like `tuple` and `int` in the + // definition query while the stringified expression `"ForwardRef"` would need to deferred + // to use end-of-scope semantics. This would require custom and possibly a complex + // implementation to allow this "split" to happen. + + match definition.kind(self.db()) { + DefinitionKind::Function(function) => self.infer_function_deferred(function.node()), + DefinitionKind::Class(class) => self.infer_class_deferred(class.node()), + _ => {} + } + } + + fn infer_region_expression(&mut self, expression: Expression<'db>) { + match expression.kind(self.db()) { + ExpressionKind::Normal => { + self.infer_expression_impl(expression.node_ref(self.db())); + } + ExpressionKind::TypeExpression => { + self.infer_type_expression(expression.node_ref(self.db())); + } + } + } + + /// Raise a diagnostic if the given type cannot be divided by zero. + /// + /// Expects the resolved type of the left side of the binary expression. + fn check_division_by_zero( + &mut self, + node: AnyNodeRef<'_>, + op: ast::Operator, + left: Type<'db>, + ) -> bool { + match left { + Type::BooleanLiteral(_) | Type::IntLiteral(_) => {} + Type::NominalInstance(instance) + if matches!( + instance.class.known(self.db()), + Some(KnownClass::Float | KnownClass::Int | KnownClass::Bool) + ) => {} + _ => return false, + } + + let (op, by_zero) = match op { + ast::Operator::Div => ("divide", "by zero"), + ast::Operator::FloorDiv => ("floor divide", "by zero"), + ast::Operator::Mod => ("reduce", "modulo zero"), + _ => return false, + }; + + if let Some(builder) = self.context.report_lint(&DIVISION_BY_ZERO, node) { + builder.into_diagnostic(format_args!( + "Cannot {op} object of type `{}` {by_zero}", + left.display(self.db()) + )); + } + + true + } + + fn add_binding(&mut self, node: AnyNodeRef, binding: Definition<'db>, ty: Type<'db>) { + debug_assert!( + binding + .kind(self.db()) + .category(self.context.in_stub()) + .is_binding() + ); + + let file_scope_id = binding.file_scope(self.db()); + let symbol_table = self.index.symbol_table(file_scope_id); + let use_def = self.index.use_def_map(file_scope_id); + let mut bound_ty = ty; + let symbol_id = binding.symbol(self.db()); + + let global_use_def_map = self.index.use_def_map(FileScopeId::global()); + let symbol_name = symbol_table.symbol(symbol_id).name(); + let skip_non_global_scopes = self.skip_non_global_scopes(file_scope_id, symbol_id); + let declarations = if skip_non_global_scopes { + match self + .index + .symbol_table(FileScopeId::global()) + .symbol_id_by_name(symbol_name) + { + Some(id) => global_use_def_map.public_declarations(id), + // This case is a syntax error (load before global declaration) but ignore that here + None => use_def.declarations_at_binding(binding), + } + } else { + use_def.declarations_at_binding(binding) + }; + + let declared_ty = symbol_from_declarations(self.db(), declarations) + .and_then(|symbol| { + let symbol = if matches!(symbol.symbol, Symbol::Type(_, Boundness::Bound)) { + symbol + } else if skip_non_global_scopes + || self.scope().file_scope_id(self.db()).is_global() + { + let module_type_declarations = + module_type_implicit_global_declaration(self.db(), symbol_name)?; + symbol.or_fall_back_to(self.db(), || module_type_declarations) + } else { + symbol + }; + Ok(symbol) + }) + .map(|SymbolAndQualifiers { symbol, .. }| { + symbol.ignore_possibly_unbound().unwrap_or(Type::unknown()) + }) + .unwrap_or_else(|(ty, conflicting)| { + // TODO point out the conflicting declarations in the diagnostic? + let symbol_table = self.index.symbol_table(binding.file_scope(self.db())); + let symbol_name = symbol_table.symbol(binding.symbol(self.db())).name(); + if let Some(builder) = self.context.report_lint(&CONFLICTING_DECLARATIONS, node) { + builder.into_diagnostic(format_args!( + "Conflicting declared types for `{symbol_name}`: {}", + conflicting.display(self.db()) + )); + } + ty.inner_type() + }); + if !bound_ty.is_assignable_to(self.db(), declared_ty) { + report_invalid_assignment(&self.context, node, declared_ty, bound_ty); + // allow declarations to override inference in case of invalid assignment + bound_ty = declared_ty; + } + + self.types.bindings.insert(binding, bound_ty); + } + + /// Returns `true` if `symbol_id` should be looked up in the global scope, skipping intervening + /// local scopes. + fn skip_non_global_scopes( + &self, + file_scope_id: FileScopeId, + symbol_id: ScopedSymbolId, + ) -> bool { + !file_scope_id.is_global() + && self + .index + .symbol_is_global_in_scope(symbol_id, file_scope_id) + } + + fn add_declaration( + &mut self, + node: AnyNodeRef, + declaration: Definition<'db>, + ty: TypeAndQualifiers<'db>, + ) { + debug_assert!( + declaration + .kind(self.db()) + .category(self.context.in_stub()) + .is_declaration() + ); + let use_def = self.index.use_def_map(declaration.file_scope(self.db())); + let prior_bindings = use_def.bindings_at_declaration(declaration); + // unbound_ty is Never because for this check we don't care about unbound + let inferred_ty = symbol_from_bindings(self.db(), prior_bindings) + .with_qualifiers(TypeQualifiers::empty()) + .or_fall_back_to(self.db(), || { + // Fallback to bindings declared on `types.ModuleType` if it's a global symbol + let scope = self.scope().file_scope_id(self.db()); + if scope.is_global() { + module_type_implicit_global_symbol( + self.db(), + self.index + .symbol_table(scope) + .symbol(declaration.symbol(self.db())) + .name(), + ) + } else { + Symbol::Unbound.into() + } + }) + .symbol + .ignore_possibly_unbound() + .unwrap_or(Type::Never); + let ty = if inferred_ty.is_assignable_to(self.db(), ty.inner_type()) { + ty + } else { + if let Some(builder) = self.context.report_lint(&INVALID_DECLARATION, node) { + builder.into_diagnostic(format_args!( + "Cannot declare type `{}` for inferred type `{}`", + ty.inner_type().display(self.db()), + inferred_ty.display(self.db()) + )); + } + TypeAndQualifiers::unknown() + }; + self.types.declarations.insert(declaration, ty); + } + + fn add_declaration_with_binding( + &mut self, + node: AnyNodeRef, + definition: Definition<'db>, + declared_and_inferred_ty: &DeclaredAndInferredType<'db>, + ) { + debug_assert!( + definition + .kind(self.db()) + .category(self.context.in_stub()) + .is_binding() + ); + debug_assert!( + definition + .kind(self.db()) + .category(self.context.in_stub()) + .is_declaration() + ); + + let (declared_ty, inferred_ty) = match *declared_and_inferred_ty { + DeclaredAndInferredType::AreTheSame(ty) => (ty.into(), ty), + DeclaredAndInferredType::MightBeDifferent { + declared_ty, + inferred_ty, + } => { + let file_scope_id = self.scope().file_scope_id(self.db()); + if file_scope_id.is_global() { + let symbol_table = self.index.symbol_table(file_scope_id); + let symbol_name = symbol_table.symbol(definition.symbol(self.db())).name(); + if let Some(module_type_implicit_declaration) = + module_type_implicit_global_declaration(self.db(), symbol_name) + .ok() + .and_then(|sym| sym.symbol.ignore_possibly_unbound()) + { + let declared_type = declared_ty.inner_type(); + if !declared_type + .is_assignable_to(self.db(), module_type_implicit_declaration) + { + if let Some(builder) = + self.context.report_lint(&INVALID_DECLARATION, node) + { + let mut diagnostic = builder.into_diagnostic(format_args!( + "Cannot shadow implicit global attribute `{symbol_name}` with declaration of type `{}`", + declared_type.display(self.db()) + )); + diagnostic.info(format_args!("The global symbol `{}` must always have a type assignable to `{}`", + symbol_name, + module_type_implicit_declaration.display(self.db()) + )); + } + } + } + } + if inferred_ty.is_assignable_to(self.db(), declared_ty.inner_type()) { + (declared_ty, inferred_ty) + } else { + report_invalid_assignment( + &self.context, + node, + declared_ty.inner_type(), + inferred_ty, + ); + // if the assignment is invalid, fall back to assuming the annotation is correct + (declared_ty, declared_ty.inner_type()) + } + } + }; + self.types.declarations.insert(definition, declared_ty); + self.types.bindings.insert(definition, inferred_ty); + } + + fn add_unknown_declaration_with_binding( + &mut self, + node: AnyNodeRef, + definition: Definition<'db>, + ) { + self.add_declaration_with_binding( + node, + definition, + &DeclaredAndInferredType::AreTheSame(Type::unknown()), + ); + } + + fn record_return_type(&mut self, ty: Type<'db>, range: TextRange) { + self.return_types_and_ranges + .push(TypeAndRange { ty, range }); + } + + fn infer_module(&mut self, module: &ast::ModModule) { + self.infer_body(&module.body); + } + + fn infer_class_type_params(&mut self, class: &ast::StmtClassDef) { + let type_params = class + .type_params + .as_deref() + .expect("class type params scope without type params"); + + self.infer_type_parameters(type_params); + + if let Some(arguments) = class.arguments.as_deref() { + let call_arguments = Self::parse_arguments(arguments); + let argument_forms = vec![Some(ParameterForm::Value); call_arguments.len()]; + self.infer_argument_types(arguments, call_arguments, &argument_forms); + } + } + + fn infer_class_body(&mut self, class: &ast::StmtClassDef) { + self.infer_body(&class.body); + } + + fn infer_function_type_params(&mut self, function: &ast::StmtFunctionDef) { + let type_params = function + .type_params + .as_deref() + .expect("function type params scope without type params"); + + self.infer_optional_annotation_expression( + function.returns.as_deref(), + DeferredExpressionState::None, + ); + self.infer_type_parameters(type_params); + self.infer_parameters(&function.parameters); + } + + fn infer_type_alias_type_params(&mut self, type_alias: &ast::StmtTypeAlias) { + let type_params = type_alias + .type_params + .as_ref() + .expect("type alias type params scope without type params"); + + self.infer_type_parameters(type_params); + } + + fn infer_type_alias(&mut self, type_alias: &ast::StmtTypeAlias) { + self.infer_annotation_expression(&type_alias.value, DeferredExpressionState::Deferred); + } + + /// If the current scope is a method inside an enclosing class, + /// return `Some(class)` where `class` represents the enclosing class. + /// + /// If the current scope is not a method inside an enclosing class, + /// return `None`. + /// + /// Note that this method will only return `Some` if the immediate parent scope + /// is a class scope OR the immediate parent scope is an annotation scope + /// and the grandparent scope is a class scope. This means it has different + /// behaviour to the [`nearest_enclosing_class`] function. + fn class_context_of_current_method(&self) -> Option<ClassLiteral<'db>> { + let current_scope_id = self.scope().file_scope_id(self.db()); + let current_scope = self.index.scope(current_scope_id); + let parent_scope_id = current_scope.parent()?; + let parent_scope = self.index.scope(parent_scope_id); + + let class_scope = match parent_scope.kind() { + ScopeKind::Class => parent_scope, + ScopeKind::Annotation => { + let class_scope_id = parent_scope.parent()?; + let potentially_class_scope = self.index.scope(class_scope_id); + + match potentially_class_scope.kind() { + ScopeKind::Class => potentially_class_scope, + _ => return None, + } + } + _ => return None, + }; + + let class_stmt = class_scope.node().as_class()?; + let class_definition = self.index.expect_single_definition(class_stmt); + binding_type(self.db(), class_definition).into_class_literal() + } + + /// Returns `true` if the current scope is the function body scope of a function overload (that + /// is, the stub declaration decorated with `@overload`, not the implementation), or an + /// abstract method (decorated with `@abstractmethod`.) + fn in_function_overload_or_abstractmethod(&self) -> bool { + let current_scope_id = self.scope().file_scope_id(self.db()); + let current_scope = self.index.scope(current_scope_id); + + let function_scope = match current_scope.kind() { + ScopeKind::Function => current_scope, + _ => return false, + }; + + let NodeWithScopeKind::Function(node_ref) = function_scope.node() else { + return false; + }; + + node_ref.decorator_list.iter().any(|decorator| { + let decorator_type = self.file_expression_type(&decorator.expression); + + match decorator_type { + Type::FunctionLiteral(function) => matches!( + function.known(self.db()), + Some(KnownFunction::Overload | KnownFunction::AbstractMethod) + ), + _ => false, + } + }) + } + + fn infer_function_body(&mut self, function: &ast::StmtFunctionDef) { + // Parameters are odd: they are Definitions in the function body scope, but have no + // constituent nodes that are part of the function body. In order to get diagnostics + // merged/emitted for them, we need to explicitly infer their definitions here. + for parameter in &function.parameters { + self.infer_definition(parameter); + } + self.infer_body(&function.body); + + if let Some(returns) = function.returns.as_deref() { + fn is_stub_suite(suite: &[ast::Stmt]) -> bool { + match suite { + [ + ast::Stmt::Expr(ast::StmtExpr { value: first, .. }), + ast::Stmt::Expr(ast::StmtExpr { value: second, .. }), + .., + ] => first.is_string_literal_expr() && second.is_ellipsis_literal_expr(), + [ + ast::Stmt::Expr(ast::StmtExpr { value, .. }), + ast::Stmt::Pass(_), + .., + ] => value.is_string_literal_expr(), + [ast::Stmt::Expr(ast::StmtExpr { value, .. }), ..] => { + value.is_ellipsis_literal_expr() || value.is_string_literal_expr() + } + [ast::Stmt::Pass(_)] => true, + _ => false, + } + } + + let has_empty_body = + self.return_types_and_ranges.is_empty() && is_stub_suite(&function.body); + + let mut enclosing_class_context = None; + + if has_empty_body { + if self.in_stub() { + return; + } + if self.in_function_overload_or_abstractmethod() { + return; + } + if let Some(class) = self.class_context_of_current_method() { + enclosing_class_context = Some(class); + if class.is_protocol(self.db()) { + return; + } + } + } + + let declared_ty = self.file_expression_type(returns); + + let scope_id = self.index.node_scope(NodeWithScopeRef::Function(function)); + if scope_id.is_generator_function(self.index) { + // TODO: `AsyncGeneratorType` and `GeneratorType` are both generic classes. + // + // If type arguments are supplied to `(Async)Iterable`, `(Async)Iterator`, + // `(Async)Generator` or `(Async)GeneratorType` in the return annotation, + // we should iterate over the `yield` expressions and `return` statements in the function + // to check that they are consistent with the type arguments provided. + let inferred_return = if function.is_async { + KnownClass::AsyncGeneratorType + } else { + KnownClass::GeneratorType + }; + + if !inferred_return + .to_instance(self.db()) + .is_assignable_to(self.db(), declared_ty) + { + report_invalid_generator_function_return_type( + &self.context, + returns.range(), + inferred_return, + declared_ty, + ); + } + return; + } + + for invalid in self + .return_types_and_ranges + .iter() + .copied() + .filter_map(|ty_range| match ty_range.ty { + // We skip `is_assignable_to` checks for `NotImplemented`, + // so we remove it beforehand. + Type::Union(union) => Some(TypeAndRange { + ty: union.filter(self.db(), |ty| !ty.is_notimplemented(self.db())), + range: ty_range.range, + }), + ty if ty.is_notimplemented(self.db()) => None, + _ => Some(ty_range), + }) + .filter(|ty_range| !ty_range.ty.is_assignable_to(self.db(), declared_ty)) + { + report_invalid_return_type( + &self.context, + invalid.range, + returns.range(), + declared_ty, + invalid.ty, + ); + } + let use_def = self.index.use_def_map(scope_id); + if use_def.can_implicit_return(self.db()) + && !Type::none(self.db()).is_assignable_to(self.db(), declared_ty) + { + report_implicit_return_type( + &self.context, + returns.range(), + declared_ty, + has_empty_body, + enclosing_class_context, + ); + } + } + } + + fn infer_body(&mut self, suite: &[ast::Stmt]) { + for statement in suite { + self.infer_statement(statement); + } + } + + fn infer_statement(&mut self, statement: &ast::Stmt) { + match statement { + ast::Stmt::FunctionDef(function) => self.infer_function_definition_statement(function), + ast::Stmt::ClassDef(class) => self.infer_class_definition_statement(class), + ast::Stmt::Expr(ast::StmtExpr { range: _, value }) => { + self.infer_expression(value); + } + ast::Stmt::If(if_statement) => self.infer_if_statement(if_statement), + ast::Stmt::Try(try_statement) => self.infer_try_statement(try_statement), + ast::Stmt::With(with_statement) => self.infer_with_statement(with_statement), + ast::Stmt::Match(match_statement) => self.infer_match_statement(match_statement), + ast::Stmt::Assign(assign) => self.infer_assignment_statement(assign), + ast::Stmt::AnnAssign(assign) => self.infer_annotated_assignment_statement(assign), + ast::Stmt::AugAssign(aug_assign) => { + self.infer_augmented_assignment_statement(aug_assign); + } + ast::Stmt::TypeAlias(type_statement) => self.infer_type_alias_statement(type_statement), + ast::Stmt::For(for_statement) => self.infer_for_statement(for_statement), + ast::Stmt::While(while_statement) => self.infer_while_statement(while_statement), + ast::Stmt::Import(import) => self.infer_import_statement(import), + ast::Stmt::ImportFrom(import) => self.infer_import_from_statement(import), + ast::Stmt::Assert(assert_statement) => self.infer_assert_statement(assert_statement), + ast::Stmt::Raise(raise) => self.infer_raise_statement(raise), + ast::Stmt::Return(ret) => self.infer_return_statement(ret), + ast::Stmt::Delete(delete) => self.infer_delete_statement(delete), + ast::Stmt::Break(_) + | ast::Stmt::Continue(_) + | ast::Stmt::Pass(_) + | ast::Stmt::IpyEscapeCommand(_) + | ast::Stmt::Global(_) + | ast::Stmt::Nonlocal(_) => { + // No-op + } + } + } + + fn infer_definition(&mut self, node: impl Into<DefinitionNodeKey> + std::fmt::Debug + Copy) { + let definition = self.index.expect_single_definition(node); + let result = infer_definition_types(self.db(), definition); + self.extend(result); + } + + fn infer_function_definition_statement(&mut self, function: &ast::StmtFunctionDef) { + self.infer_definition(function); + } + + fn infer_function_definition( + &mut self, + function: &ast::StmtFunctionDef, + definition: Definition<'db>, + ) { + let ast::StmtFunctionDef { + range: _, + is_async: _, + name, + type_params, + parameters, + returns, + body: _, + decorator_list, + } = function; + + let mut decorator_types_and_nodes = Vec::with_capacity(decorator_list.len()); + let mut function_decorators = FunctionDecorators::empty(); + let mut dataclass_transformer_params = None; + + for decorator in decorator_list { + let decorator_ty = self.infer_decorator(decorator); + + match decorator_ty { + Type::FunctionLiteral(function) => { + match function.known(self.db()) { + Some(KnownFunction::NoTypeCheck) => { + // If the function is decorated with the `no_type_check` decorator, + // we need to suppress any errors that come after the decorators. + self.context.set_in_no_type_check(InNoTypeCheck::Yes); + function_decorators |= FunctionDecorators::NO_TYPE_CHECK; + continue; + } + Some(KnownFunction::Overload) => { + function_decorators |= FunctionDecorators::OVERLOAD; + continue; + } + Some(KnownFunction::AbstractMethod) => { + function_decorators |= FunctionDecorators::ABSTRACT_METHOD; + continue; + } + Some(KnownFunction::Final) => { + function_decorators |= FunctionDecorators::FINAL; + continue; + } + Some(KnownFunction::Override) => { + function_decorators |= FunctionDecorators::OVERRIDE; + continue; + } + _ => {} + } + } + Type::ClassLiteral(class) => { + if class.is_known(self.db(), KnownClass::Classmethod) { + function_decorators |= FunctionDecorators::CLASSMETHOD; + continue; + } + } + Type::DataclassTransformer(params) => { + dataclass_transformer_params = Some(params); + } + _ => {} + } + + decorator_types_and_nodes.push((decorator_ty, decorator)); + } + + for default in parameters + .iter_non_variadic_params() + .filter_map(|param| param.default.as_deref()) + { + self.infer_expression(default); + } + + // If there are type params, parameters and returns are evaluated in that scope, that is, in + // `infer_function_type_params`, rather than here. + if type_params.is_none() { + if self.defer_annotations() { + self.types.deferred.insert(definition); + } else { + self.infer_optional_annotation_expression( + returns.as_deref(), + DeferredExpressionState::None, + ); + self.infer_parameters(parameters); + } + } + + let function_kind = + KnownFunction::try_from_definition_and_name(self.db(), definition, name); + + let body_scope = self + .index + .node_scope(NodeWithScopeRef::Function(function)) + .to_scope_id(self.db(), self.file()); + + let inherited_generic_context = None; + let type_mappings = Box::from([]); + + let mut inferred_ty = Type::FunctionLiteral(FunctionType::new( + self.db(), + &name.id, + function_kind, + body_scope, + function_decorators, + dataclass_transformer_params, + inherited_generic_context, + type_mappings, + )); + + for (decorator_ty, decorator_node) in decorator_types_and_nodes.iter().rev() { + inferred_ty = match decorator_ty + .try_call(self.db(), &CallArgumentTypes::positional([inferred_ty])) + .map(|bindings| bindings.return_type(self.db())) + { + Ok(return_ty) => return_ty, + Err(CallError(_, bindings)) => { + bindings.report_diagnostics(&self.context, (*decorator_node).into()); + bindings.return_type(self.db()) + } + }; + } + + self.add_declaration_with_binding( + function.into(), + definition, + &DeclaredAndInferredType::AreTheSame(inferred_ty), + ); + } + + fn infer_parameters(&mut self, parameters: &ast::Parameters) { + let ast::Parameters { + range: _, + posonlyargs: _, + args: _, + vararg, + kwonlyargs: _, + kwarg, + } = parameters; + + for param_with_default in parameters.iter_non_variadic_params() { + self.infer_parameter_with_default(param_with_default); + } + if let Some(vararg) = vararg { + self.infer_parameter(vararg); + } + if let Some(kwarg) = kwarg { + self.infer_parameter(kwarg); + } + } + + fn infer_parameter_with_default(&mut self, parameter_with_default: &ast::ParameterWithDefault) { + let ast::ParameterWithDefault { + range: _, + parameter, + default: _, + } = parameter_with_default; + + self.infer_optional_annotation_expression( + parameter.annotation.as_deref(), + DeferredExpressionState::None, + ); + } + + fn infer_parameter(&mut self, parameter: &ast::Parameter) { + let ast::Parameter { + range: _, + name: _, + annotation, + } = parameter; + + self.infer_optional_annotation_expression( + annotation.as_deref(), + DeferredExpressionState::None, + ); + } + + /// Set initial declared type (if annotated) and inferred type for a function-parameter symbol, + /// in the function body scope. + /// + /// The declared type is the annotated type, if any, or `Unknown`. + /// + /// The inferred type is the annotated type, unioned with the type of the default value, if + /// any. If both types are fully static, this union is a no-op (it should simplify to just the + /// annotated type.) But in a case like `f(x=None)` with no annotated type, we want to infer + /// the type `Unknown | None` for `x`, not just `Unknown`, so that we can error on usage of `x` + /// that would not be valid for `None`. + /// + /// If the default-value type is not assignable to the declared (annotated) type, we ignore the + /// default-value type and just infer the annotated type; this is the same way we handle + /// assignments, and allows an explicit annotation to override a bad inference. + /// + /// Parameter definitions are odd in that they define a symbol in the function-body scope, so + /// the Definition belongs to the function body scope, but the expressions (annotation and + /// default value) both belong to outer scopes. (The default value always belongs to the outer + /// scope in which the function is defined, the annotation belongs either to the outer scope, + /// or maybe to an intervening type-params scope, if it's a generic function.) So we don't use + /// `self.infer_expression` or store any expression types here, we just use `expression_ty` to + /// get the types of the expressions from their respective scopes. + /// + /// It is safe (non-cycle-causing) to use `expression_ty` here, because an outer scope can't + /// depend on a definition from an inner scope, so we shouldn't be in-process of inferring the + /// outer scope here. + fn infer_parameter_definition( + &mut self, + parameter_with_default: &ast::ParameterWithDefault, + definition: Definition<'db>, + ) { + let ast::ParameterWithDefault { + parameter, + default, + range: _, + } = parameter_with_default; + let default_ty = default + .as_ref() + .map(|default| self.file_expression_type(default)); + if let Some(annotation) = parameter.annotation.as_ref() { + let declared_ty = self.file_expression_type(annotation); + let declared_and_inferred_ty = if let Some(default_ty) = default_ty { + if default_ty.is_assignable_to(self.db(), declared_ty) { + DeclaredAndInferredType::MightBeDifferent { + declared_ty: declared_ty.into(), + inferred_ty: UnionType::from_elements(self.db(), [declared_ty, default_ty]), + } + } else if (self.in_stub() + || self.in_function_overload_or_abstractmethod() + || self + .class_context_of_current_method() + .is_some_and(|class| class.is_protocol(self.db()))) + && default + .as_ref() + .is_some_and(|d| d.is_ellipsis_literal_expr()) + { + DeclaredAndInferredType::AreTheSame(declared_ty) + } else { + if let Some(builder) = self + .context + .report_lint(&INVALID_PARAMETER_DEFAULT, parameter_with_default) + { + builder.into_diagnostic(format_args!( + "Default value of type `{}` is not assignable \ + to annotated parameter type `{}`", + default_ty.display(self.db()), + declared_ty.display(self.db()) + )); + } + DeclaredAndInferredType::AreTheSame(declared_ty) + } + } else { + DeclaredAndInferredType::AreTheSame(declared_ty) + }; + self.add_declaration_with_binding( + parameter.into(), + definition, + &declared_and_inferred_ty, + ); + } else { + let ty = if let Some(default_ty) = default_ty { + UnionType::from_elements(self.db(), [Type::unknown(), default_ty]) + } else { + Type::unknown() + }; + self.add_binding(parameter.into(), definition, ty); + } + } + + /// Set initial declared/inferred types for a `*args` variadic positional parameter. + /// + /// The annotated type is implicitly wrapped in a homogeneous tuple. + /// + /// See [`infer_parameter_definition`] doc comment for some relevant observations about scopes. + /// + /// [`infer_parameter_definition`]: Self::infer_parameter_definition + fn infer_variadic_positional_parameter_definition( + &mut self, + parameter: &ast::Parameter, + definition: Definition<'db>, + ) { + if let Some(annotation) = parameter.annotation() { + let ty = if annotation.is_starred_expr() { + todo_type!("PEP 646") + } else { + let annotated_type = self.file_expression_type(annotation); + KnownClass::Tuple.to_specialized_instance(self.db(), [annotated_type]) + }; + + self.add_declaration_with_binding( + parameter.into(), + definition, + &DeclaredAndInferredType::AreTheSame(ty), + ); + } else { + self.add_binding( + parameter.into(), + definition, + KnownClass::Tuple.to_specialized_instance(self.db(), [Type::unknown()]), + ); + } + } + + /// Set initial declared/inferred types for a `*args` variadic positional parameter. + /// + /// The annotated type is implicitly wrapped in a string-keyed dictionary. + /// + /// See [`infer_parameter_definition`] doc comment for some relevant observations about scopes. + /// + /// [`infer_parameter_definition`]: Self::infer_parameter_definition + fn infer_variadic_keyword_parameter_definition( + &mut self, + parameter: &ast::Parameter, + definition: Definition<'db>, + ) { + if let Some(annotation) = parameter.annotation() { + let annotated_ty = self.file_expression_type(annotation); + let ty = KnownClass::Dict.to_specialized_instance( + self.db(), + [KnownClass::Str.to_instance(self.db()), annotated_ty], + ); + self.add_declaration_with_binding( + parameter.into(), + definition, + &DeclaredAndInferredType::AreTheSame(ty), + ); + } else { + self.add_binding( + parameter.into(), + definition, + KnownClass::Dict.to_specialized_instance( + self.db(), + [KnownClass::Str.to_instance(self.db()), Type::unknown()], + ), + ); + } + } + + fn infer_class_definition_statement(&mut self, class: &ast::StmtClassDef) { + self.infer_definition(class); + } + + fn infer_class_definition( + &mut self, + class_node: &ast::StmtClassDef, + definition: Definition<'db>, + ) { + let ast::StmtClassDef { + range: _, + name, + type_params, + decorator_list, + arguments: _, + body: _, + } = class_node; + + let mut dataclass_params = None; + let mut dataclass_transformer_params = None; + for decorator in decorator_list { + let decorator_ty = self.infer_decorator(decorator); + if decorator_ty + .into_function_literal() + .is_some_and(|function| function.is_known(self.db(), KnownFunction::Dataclass)) + { + dataclass_params = Some(DataclassParams::default()); + continue; + } + + if let Type::DataclassDecorator(params) = decorator_ty { + dataclass_params = Some(params); + continue; + } + + if let Type::FunctionLiteral(f) = decorator_ty { + // We do not yet detect or flag `@dataclass_transform` applied to more than one + // overload, or an overload and the implementation both. Nevertheless, this is not + // allowed. We do not try to treat the offenders intelligently -- just use the + // params of the last seen usage of `@dataclass_transform` + if let Some(overloaded) = f.to_overloaded(self.db()) { + overloaded.overloads.iter().for_each(|overload| { + if let Some(params) = overload.dataclass_transformer_params(self.db()) { + dataclass_params = Some(params.into()); + } + }); + } + if let Some(params) = f.dataclass_transformer_params(self.db()) { + dataclass_params = Some(params.into()); + continue; + } + } + + if let Type::DataclassTransformer(params) = decorator_ty { + dataclass_transformer_params = Some(params); + continue; + } + } + + let body_scope = self + .index + .node_scope(NodeWithScopeRef::Class(class_node)) + .to_scope_id(self.db(), self.file()); + + let maybe_known_class = KnownClass::try_from_file_and_name(self.db(), self.file(), name); + + let class_ty = Type::from(ClassLiteral::new( + self.db(), + name.id.clone(), + body_scope, + maybe_known_class, + dataclass_params, + dataclass_transformer_params, + )); + + self.add_declaration_with_binding( + class_node.into(), + definition, + &DeclaredAndInferredType::AreTheSame(class_ty), + ); + + // if there are type parameters, then the keywords and bases are within that scope + // and we don't need to run inference here + if type_params.is_none() { + for keyword in class_node.keywords() { + self.infer_expression(&keyword.value); + } + + // Inference of bases deferred in stubs + // TODO: Only defer the references that are actually string literals, instead of + // deferring the entire class definition if a string literal occurs anywhere in the + // base class list. + if self.in_stub() || class_node.bases().iter().any(contains_string_literal) { + self.types.deferred.insert(definition); + } else { + for base in class_node.bases() { + self.infer_expression(base); + } + } + } + } + + fn infer_function_deferred(&mut self, function: &ast::StmtFunctionDef) { + self.infer_optional_annotation_expression( + function.returns.as_deref(), + DeferredExpressionState::Deferred, + ); + self.infer_parameters(function.parameters.as_ref()); + } + + fn infer_class_deferred(&mut self, class: &ast::StmtClassDef) { + for base in class.bases() { + self.infer_expression(base); + } + } + + fn infer_type_alias_definition( + &mut self, + type_alias: &ast::StmtTypeAlias, + definition: Definition<'db>, + ) { + self.infer_expression(&type_alias.name); + + let rhs_scope = self + .index + .node_scope(NodeWithScopeRef::TypeAlias(type_alias)) + .to_scope_id(self.db(), self.file()); + + let type_alias_ty = Type::KnownInstance(KnownInstanceType::TypeAliasType( + TypeAliasType::PEP695(PEP695TypeAliasType::new( + self.db(), + &type_alias.name.as_name_expr().unwrap().id, + rhs_scope, + )), + )); + + self.add_declaration_with_binding( + type_alias.into(), + definition, + &DeclaredAndInferredType::AreTheSame(type_alias_ty), + ); + } + + fn infer_if_statement(&mut self, if_statement: &ast::StmtIf) { + let ast::StmtIf { + range: _, + test, + body, + elif_else_clauses, + } = if_statement; + + let test_ty = self.infer_standalone_expression(test); + + if let Err(err) = test_ty.try_bool(self.db()) { + err.report_diagnostic(&self.context, &**test); + } + + self.infer_body(body); + + for clause in elif_else_clauses { + let ast::ElifElseClause { + range: _, + test, + body, + } = clause; + + if let Some(test) = &test { + let test_ty = self.infer_standalone_expression(test); + + if let Err(err) = test_ty.try_bool(self.db()) { + err.report_diagnostic(&self.context, test); + } + } + + self.infer_body(body); + } + } + + fn infer_try_statement(&mut self, try_statement: &ast::StmtTry) { + let ast::StmtTry { + range: _, + body, + handlers, + orelse, + finalbody, + is_star: _, + } = try_statement; + + self.infer_body(body); + + for handler in handlers { + let ast::ExceptHandler::ExceptHandler(handler) = handler; + let ast::ExceptHandlerExceptHandler { + type_: handled_exceptions, + name: symbol_name, + body, + range: _, + } = handler; + + // If `symbol_name` is `Some()` and `handled_exceptions` is `None`, + // it's invalid syntax (something like `except as e:`). + // However, it's obvious that the user *wanted* `e` to be bound here, + // so we'll have created a definition in the semantic-index stage anyway. + if symbol_name.is_some() { + self.infer_definition(handler); + } else { + self.infer_exception(handled_exceptions.as_deref(), try_statement.is_star); + } + + self.infer_body(body); + } + + self.infer_body(orelse); + self.infer_body(finalbody); + } + + fn infer_with_statement(&mut self, with_statement: &ast::StmtWith) { + let ast::StmtWith { + range: _, + is_async, + items, + body, + } = with_statement; + for item in items { + let target = item.optional_vars.as_deref(); + if let Some(target) = target { + self.infer_target(target, &item.context_expr, |builder, context_expr| { + // TODO: `infer_with_statement_definition` reports a diagnostic if `ctx_manager_ty` isn't a context manager + // but only if the target is a name. We should report a diagnostic here if the target isn't a name: + // `with not_context_manager as a.x: ... + builder + .infer_standalone_expression(context_expr) + .enter(builder.db()) + }); + } else { + // Call into the context expression inference to validate that it evaluates + // to a valid context manager. + let context_expression_ty = self.infer_expression(&item.context_expr); + self.infer_context_expression(&item.context_expr, context_expression_ty, *is_async); + self.infer_optional_expression(target); + } + } + + self.infer_body(body); + } + + fn infer_with_item_definition( + &mut self, + with_item: &WithItemDefinitionKind<'db>, + definition: Definition<'db>, + ) { + let context_expr = with_item.context_expr(); + let target = with_item.target(); + + let context_expr_ty = self.infer_standalone_expression(context_expr); + + let target_ty = if with_item.is_async() { + todo_type!("async `with` statement") + } else { + match with_item.target_kind() { + TargetKind::Sequence(unpack_position, unpack) => { + let unpacked = infer_unpack_types(self.db(), unpack); + let target_ast_id = target.scoped_expression_id(self.db(), self.scope()); + if unpack_position == UnpackPosition::First { + self.context.extend(unpacked.diagnostics()); + } + unpacked.expression_type(target_ast_id) + } + TargetKind::NameOrAttribute => self.infer_context_expression( + context_expr, + context_expr_ty, + with_item.is_async(), + ), + } + }; + + self.store_expression_type(target, target_ty); + self.add_binding(target.into(), definition, target_ty); + } + + /// Infers the type of a context expression (`with expr`) and returns the target's type + /// + /// Returns [`Type::unknown`] if the context expression doesn't implement the context manager protocol. + /// + /// ## Terminology + /// See [PEP343](https://peps.python.org/pep-0343/#standard-terminology). + fn infer_context_expression( + &mut self, + context_expression: &ast::Expr, + context_expression_type: Type<'db>, + is_async: bool, + ) -> Type<'db> { + // TODO: Handle async with statements (they use `aenter` and `aexit`) + if is_async { + return todo_type!("async `with` statement"); + } + + context_expression_type + .try_enter(self.db()) + .unwrap_or_else(|err| { + err.report_diagnostic( + &self.context, + context_expression_type, + context_expression.into(), + ); + err.fallback_enter_type(self.db()) + }) + } + + fn infer_exception(&mut self, node: Option<&ast::Expr>, is_star: bool) -> Type<'db> { + fn extract_tuple_specialization<'db>(db: &'db dyn Db, ty: Type<'db>) -> Option<Type<'db>> { + let class = ty.into_nominal_instance()?.class; + if !class.is_known(db, KnownClass::Tuple) { + return None; + } + let ClassType::Generic(class) = class else { + return None; + }; + let specialization = class.specialization(db).types(db)[0]; + let specialization_instance = specialization.to_instance(db)?; + + specialization_instance + .is_assignable_to(db, KnownClass::BaseException.to_instance(db)) + .then_some(specialization_instance) + } + + // If there is no handled exception, it's invalid syntax; + // a diagnostic will have already been emitted + let node_ty = node.map_or(Type::unknown(), |ty| self.infer_expression(ty)); + let type_base_exception = KnownClass::BaseException.to_subclass_of(self.db()); + + // If it's an `except*` handler, this won't actually be the type of the bound symbol; + // it will actually be the type of the generic parameters to `BaseExceptionGroup` or `ExceptionGroup`. + let symbol_ty = if let Type::Tuple(tuple) = node_ty { + let mut builder = UnionBuilder::new(self.db()); + for element in tuple.elements(self.db()).iter().copied() { + builder = builder.add( + if element.is_assignable_to(self.db(), type_base_exception) { + element.to_instance(self.db()).expect( + "`Type::to_instance()` should always return `Some()` \ + if called on a type assignable to `type[BaseException]`", + ) + } else { + if let Some(node) = node { + report_invalid_exception_caught(&self.context, node, element); + } + Type::unknown() + }, + ); + } + builder.build() + } else if node_ty.is_assignable_to(self.db(), type_base_exception) { + node_ty.to_instance(self.db()).expect( + "`Type::to_instance()` should always return `Some()` \ + if called on a type assignable to `type[BaseException]`", + ) + } else if node_ty.is_assignable_to( + self.db(), + KnownClass::Tuple.to_specialized_instance(self.db(), [type_base_exception]), + ) { + extract_tuple_specialization(self.db(), node_ty) + .unwrap_or_else(|| KnownClass::BaseException.to_instance(self.db())) + } else if node_ty.is_assignable_to( + self.db(), + UnionType::from_elements( + self.db(), + [ + type_base_exception, + KnownClass::Tuple.to_specialized_instance(self.db(), [type_base_exception]), + ], + ), + ) { + KnownClass::BaseException.to_instance(self.db()) + } else { + if let Some(node) = node { + report_invalid_exception_caught(&self.context, node, node_ty); + } + Type::unknown() + }; + + if is_star { + let class = if symbol_ty + .is_subtype_of(self.db(), KnownClass::Exception.to_instance(self.db())) + { + KnownClass::ExceptionGroup + } else { + KnownClass::BaseExceptionGroup + }; + class.to_specialized_instance(self.db(), [symbol_ty]) + } else { + symbol_ty + } + } + + fn infer_except_handler_definition( + &mut self, + except_handler_definition: &ExceptHandlerDefinitionKind, + definition: Definition<'db>, + ) { + let symbol_ty = self.infer_exception( + except_handler_definition.handled_exceptions(), + except_handler_definition.is_star(), + ); + + self.add_binding( + except_handler_definition.node().into(), + definition, + symbol_ty, + ); + } + + fn infer_typevar_definition( + &mut self, + node: &ast::TypeParamTypeVar, + definition: Definition<'db>, + ) { + let ast::TypeParamTypeVar { + range: _, + name, + bound, + default, + } = node; + let bound_or_constraint = match bound.as_deref() { + Some(expr @ ast::Expr::Tuple(ast::ExprTuple { elts, .. })) => { + if elts.len() < 2 { + if let Some(builder) = self + .context + .report_lint(&INVALID_TYPE_VARIABLE_CONSTRAINTS, expr) + { + builder.into_diagnostic("TypeVar must have at least two constrained types"); + } + self.infer_expression(expr); + None + } else { + // We don't use UnionType::from_elements or UnionBuilder here, because we don't + // want to simplify the list of constraints like we do with the elements of an + // actual union type. + // TODO: Consider using a new `OneOfType` connective here instead, since that + // more accurately represents the actual semantics of typevar constraints. + let elements = UnionType::new( + self.db(), + elts.iter() + .map(|expr| self.infer_type_expression(expr)) + .collect::<Box<[_]>>(), + ); + let constraints = TypeVarBoundOrConstraints::Constraints(elements); + // But when we construct an actual union type for the constraint expression as + // a whole, we do use UnionType::from_elements to maintain the invariant that + // all union types are simplified. + self.store_expression_type( + expr, + UnionType::from_elements(self.db(), elements.elements(self.db())), + ); + Some(constraints) + } + } + Some(expr) => Some(TypeVarBoundOrConstraints::UpperBound( + self.infer_type_expression(expr), + )), + None => None, + }; + let default_ty = self.infer_optional_type_expression(default.as_deref()); + let ty = Type::KnownInstance(KnownInstanceType::TypeVar(TypeVarInstance::new( + self.db(), + name.id.clone(), + Some(definition), + bound_or_constraint, + TypeVarVariance::Invariant, // TODO: infer this + default_ty, + TypeVarKind::Pep695, + ))); + self.add_declaration_with_binding( + node.into(), + definition, + &DeclaredAndInferredType::AreTheSame(ty), + ); + } + + fn infer_paramspec_definition( + &mut self, + node: &ast::TypeParamParamSpec, + definition: Definition<'db>, + ) { + let ast::TypeParamParamSpec { + range: _, + name: _, + default, + } = node; + self.infer_optional_expression(default.as_deref()); + let pep_695_todo = Type::Dynamic(DynamicType::TodoPEP695ParamSpec); + self.add_declaration_with_binding( + node.into(), + definition, + &DeclaredAndInferredType::AreTheSame(pep_695_todo), + ); + } + + fn infer_typevartuple_definition( + &mut self, + node: &ast::TypeParamTypeVarTuple, + definition: Definition<'db>, + ) { + let ast::TypeParamTypeVarTuple { + range: _, + name: _, + default, + } = node; + self.infer_optional_expression(default.as_deref()); + let pep_695_todo = todo_type!("PEP-695 TypeVarTuple definition types"); + self.add_declaration_with_binding( + node.into(), + definition, + &DeclaredAndInferredType::AreTheSame(pep_695_todo), + ); + } + + fn infer_match_statement(&mut self, match_statement: &ast::StmtMatch) { + let ast::StmtMatch { + range: _, + subject, + cases, + } = match_statement; + + self.infer_standalone_expression(subject); + + for case in cases { + let ast::MatchCase { + range: _, + body, + pattern, + guard, + } = case; + self.infer_match_pattern(pattern); + + if let Some(guard) = guard.as_deref() { + let guard_ty = self.infer_standalone_expression(guard); + + if let Err(err) = guard_ty.try_bool(self.db()) { + err.report_diagnostic(&self.context, guard); + } + } + + self.infer_body(body); + } + } + + fn infer_match_pattern_definition( + &mut self, + pattern: &ast::Pattern, + _index: u32, + definition: Definition<'db>, + ) { + // TODO(dhruvmanila): The correct way to infer types here is to perform structural matching + // against the subject expression type (which we can query via `infer_expression_types`) + // and extract the type at the `index` position if the pattern matches. This will be + // similar to the logic in `self.infer_assignment_definition`. + self.add_binding( + pattern.into(), + definition, + todo_type!("`match` pattern definition types"), + ); + } + + fn infer_match_pattern(&mut self, pattern: &ast::Pattern) { + // We need to create a standalone expression for each arm of a match statement, since they + // can introduce constraints on the match subject. (Or more accurately, for the match arm's + // pattern, since its the pattern that introduces any constraints, not the body.) Ideally, + // that standalone expression would wrap the match arm's pattern as a whole. But a + // standalone expression can currently only wrap an ast::Expr, which patterns are not. So, + // we need to choose an Expr that can “stand in” for the pattern, which we can wrap in a + // standalone expression. + // + // That said, when inferring the type of a standalone expression, we don't have access to + // its parent or sibling nodes. That means, for instance, that in a class pattern, where + // we are currently using the class name as the standalone expression, we do not have + // access to the class pattern's arguments in the standalone expression inference scope. + // At the moment, we aren't trying to do anything with those arguments when creating a + // narrowing constraint for the pattern. But in the future, if we do, we will have to + // either wrap those arguments in their own standalone expressions, or update Expression to + // be able to wrap other AST node types besides just ast::Expr. + // + // This function is only called for the top-level pattern of a match arm, and is + // responsible for inferring the standalone expression for each supported pattern type. It + // then hands off to `infer_nested_match_pattern` for any subexpressions and subpatterns, + // where we do NOT have any additional standalone expressions to infer through. + // + // TODO(dhruvmanila): Add a Salsa query for inferring pattern types and matching against + // the subject expression: https://github.com/astral-sh/ruff/pull/13147#discussion_r1739424510 + match pattern { + ast::Pattern::MatchValue(match_value) => { + self.infer_standalone_expression(&match_value.value); + } + ast::Pattern::MatchClass(match_class) => { + let ast::PatternMatchClass { + range: _, + cls, + arguments, + } = match_class; + for pattern in &arguments.patterns { + self.infer_nested_match_pattern(pattern); + } + for keyword in &arguments.keywords { + self.infer_nested_match_pattern(&keyword.pattern); + } + self.infer_standalone_expression(cls); + } + ast::Pattern::MatchOr(match_or) => { + for pattern in &match_or.patterns { + self.infer_match_pattern(pattern); + } + } + _ => { + self.infer_nested_match_pattern(pattern); + } + } + } + + fn infer_nested_match_pattern(&mut self, pattern: &ast::Pattern) { + match pattern { + ast::Pattern::MatchValue(match_value) => { + self.infer_expression(&match_value.value); + } + ast::Pattern::MatchSequence(match_sequence) => { + for pattern in &match_sequence.patterns { + self.infer_nested_match_pattern(pattern); + } + } + ast::Pattern::MatchMapping(match_mapping) => { + let ast::PatternMatchMapping { + range: _, + keys, + patterns, + rest: _, + } = match_mapping; + for key in keys { + self.infer_expression(key); + } + for pattern in patterns { + self.infer_nested_match_pattern(pattern); + } + } + ast::Pattern::MatchClass(match_class) => { + let ast::PatternMatchClass { + range: _, + cls, + arguments, + } = match_class; + for pattern in &arguments.patterns { + self.infer_nested_match_pattern(pattern); + } + for keyword in &arguments.keywords { + self.infer_nested_match_pattern(&keyword.pattern); + } + self.infer_expression(cls); + } + ast::Pattern::MatchAs(match_as) => { + if let Some(pattern) = &match_as.pattern { + self.infer_nested_match_pattern(pattern); + } + } + ast::Pattern::MatchOr(match_or) => { + for pattern in &match_or.patterns { + self.infer_nested_match_pattern(pattern); + } + } + ast::Pattern::MatchStar(_) | ast::Pattern::MatchSingleton(_) => {} + } + } + + fn infer_assignment_statement(&mut self, assignment: &ast::StmtAssign) { + let ast::StmtAssign { + range: _, + targets, + value, + } = assignment; + + for target in targets { + self.infer_target(target, value, |builder, value_expr| { + builder.infer_standalone_expression(value_expr) + }); + } + } + + /// Infer the (definition) types involved in a `target` expression. + /// + /// This is used for assignment statements, for statements, etc. with a single or multiple + /// targets (unpacking). If `target` is an attribute expression, we check that the assignment + /// is valid. For 'target's that are definitions, this check happens elsewhere. + /// + /// The `infer_value_expr` function is used to infer the type of the `value` expression which + /// are not `Name` expressions. The returned type is the one that is eventually assigned to the + /// `target`. + fn infer_target<F>(&mut self, target: &ast::Expr, value: &ast::Expr, infer_value_expr: F) + where + F: Fn(&mut TypeInferenceBuilder<'db>, &ast::Expr) -> Type<'db>, + { + let assigned_ty = match target { + ast::Expr::Name(_) => None, + _ => Some(infer_value_expr(self, value)), + }; + self.infer_target_impl(target, assigned_ty); + } + + /// Make sure that the attribute assignment `obj.attribute = value` is valid. + /// + /// `target` is the node for the left-hand side, `object_ty` is the type of `obj`, `attribute` is + /// the name of the attribute being assigned, and `value_ty` is the type of the right-hand side of + /// the assignment. If the assignment is invalid, emit diagnostics. + fn validate_attribute_assignment( + &mut self, + target: &ast::ExprAttribute, + object_ty: Type<'db>, + attribute: &str, + value_ty: Type<'db>, + emit_diagnostics: bool, + ) -> bool { + let db = self.db(); + + let ensure_assignable_to = |attr_ty| -> bool { + let assignable = value_ty.is_assignable_to(db, attr_ty); + if !assignable && emit_diagnostics { + report_invalid_attribute_assignment( + &self.context, + target.into(), + attr_ty, + value_ty, + attribute, + ); + } + assignable + }; + + match object_ty { + Type::Union(union) => { + if union.elements(self.db()).iter().all(|elem| { + self.validate_attribute_assignment(target, *elem, attribute, value_ty, false) + }) { + true + } else { + // TODO: This is not a very helpful error message, as it does not include the underlying reason + // why the assignment is invalid. This would be a good use case for sub-diagnostics. + if emit_diagnostics { + if let Some(builder) = self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + builder.into_diagnostic(format_args!( + "Object of type `{}` is not assignable \ + to attribute `{attribute}` on type `{}`", + value_ty.display(self.db()), + object_ty.display(self.db()), + )); + } + } + + false + } + } + + Type::Intersection(intersection) => { + // TODO: Handle negative intersection elements + if intersection.positive(db).iter().any(|elem| { + self.validate_attribute_assignment(target, *elem, attribute, value_ty, false) + }) { + true + } else { + if emit_diagnostics { + if let Some(builder) = self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + // TODO: same here, see above + builder.into_diagnostic(format_args!( + "Object of type `{}` is not assignable \ + to attribute `{attribute}` on type `{}`", + value_ty.display(self.db()), + object_ty.display(self.db()), + )); + } + } + false + } + } + + // Super instances do not allow attribute assignment + Type::NominalInstance(instance) if instance.class.is_known(db, KnownClass::Super) => { + if emit_diagnostics { + if let Some(builder) = self.context.report_lint(&INVALID_ASSIGNMENT, target) { + builder.into_diagnostic(format_args!( + "Cannot assign to attribute `{attribute}` on type `{}`", + object_ty.display(self.db()), + )); + } + } + false + } + Type::BoundSuper(_) => { + if emit_diagnostics { + if let Some(builder) = self.context.report_lint(&INVALID_ASSIGNMENT, target) { + builder.into_diagnostic(format_args!( + "Cannot assign to attribute `{attribute}` on type `{}`", + object_ty.display(self.db()), + )); + } + } + false + } + + Type::Dynamic(..) | Type::Never => true, + + Type::NominalInstance(..) + | Type::ProtocolInstance(_) + | Type::BooleanLiteral(..) + | Type::IntLiteral(..) + | Type::StringLiteral(..) + | Type::BytesLiteral(..) + | Type::LiteralString + | Type::Tuple(..) + | Type::KnownInstance(..) + | Type::PropertyInstance(..) + | Type::FunctionLiteral(..) + | Type::Callable(..) + | Type::BoundMethod(_) + | Type::MethodWrapper(_) + | Type::WrapperDescriptor(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::TypeVar(..) + | Type::AlwaysTruthy + | Type::AlwaysFalsy => { + let is_read_only = || { + let dataclass_params = match object_ty { + Type::NominalInstance(instance) => match instance.class { + ClassType::NonGeneric(cls) => cls.dataclass_params(self.db()), + ClassType::Generic(cls) => { + cls.origin(self.db()).dataclass_params(self.db()) + } + }, + _ => None, + }; + + dataclass_params.is_some_and(|params| params.contains(DataclassParams::FROZEN)) + }; + + match object_ty.class_member(db, attribute.into()) { + meta_attr @ SymbolAndQualifiers { .. } if meta_attr.is_class_var() => { + if emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&INVALID_ATTRIBUTE_ACCESS, target) + { + builder.into_diagnostic(format_args!( + "Cannot assign to ClassVar `{attribute}` \ + from an instance of type `{ty}`", + ty = object_ty.display(self.db()), + )); + } + } + false + } + SymbolAndQualifiers { + symbol: Symbol::Type(meta_attr_ty, meta_attr_boundness), + qualifiers: _, + } => { + if is_read_only() { + if emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + builder.into_diagnostic(format_args!( + "Property `{attribute}` defined in `{ty}` is read-only", + ty = object_ty.display(self.db()), + )); + } + } + false + } else { + let assignable_to_meta_attr = if let Symbol::Type(meta_dunder_set, _) = + meta_attr_ty.class_member(db, "__set__".into()).symbol + { + let successful_call = meta_dunder_set + .try_call( + db, + &CallArgumentTypes::positional([ + meta_attr_ty, + object_ty, + value_ty, + ]), + ) + .is_ok(); + + if !successful_call && emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + // TODO: Here, it would be nice to emit an additional diagnostic that explains why the call failed + builder.into_diagnostic(format_args!( + "Invalid assignment to data descriptor attribute \ + `{attribute}` on type `{}` with custom `__set__` method", + object_ty.display(db) + )); + } + } + + successful_call + } else { + ensure_assignable_to(meta_attr_ty) + }; + + let assignable_to_instance_attribute = + if meta_attr_boundness == Boundness::PossiblyUnbound { + let (assignable, boundness) = if let Symbol::Type( + instance_attr_ty, + instance_attr_boundness, + ) = + object_ty.instance_member(db, attribute).symbol + { + ( + ensure_assignable_to(instance_attr_ty), + instance_attr_boundness, + ) + } else { + (true, Boundness::PossiblyUnbound) + }; + + if boundness == Boundness::PossiblyUnbound { + report_possibly_unbound_attribute( + &self.context, + target, + attribute, + object_ty, + ); + } + + assignable + } else { + true + }; + + assignable_to_meta_attr && assignable_to_instance_attribute + } + } + + SymbolAndQualifiers { + symbol: Symbol::Unbound, + .. + } => { + if let Symbol::Type(instance_attr_ty, instance_attr_boundness) = + object_ty.instance_member(db, attribute).symbol + { + if instance_attr_boundness == Boundness::PossiblyUnbound { + report_possibly_unbound_attribute( + &self.context, + target, + attribute, + object_ty, + ); + } + + if is_read_only() { + if emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + builder.into_diagnostic(format_args!( + "Property `{attribute}` defined in `{ty}` is read-only", + ty = object_ty.display(self.db()), + )); + } + } + false + } else { + ensure_assignable_to(instance_attr_ty) + } + } else { + let result = object_ty.try_call_dunder_with_policy( + db, + "__setattr__", + &mut CallArgumentTypes::positional([ + Type::StringLiteral(StringLiteralType::new( + db, + Box::from(attribute), + )), + value_ty, + ]), + MemberLookupPolicy::NO_INSTANCE_FALLBACK + | MemberLookupPolicy::MRO_NO_OBJECT_FALLBACK, + ); + + match result { + Ok(_) | Err(CallDunderError::PossiblyUnbound(_)) => true, + Err(CallDunderError::CallError(..)) => { + if emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&UNRESOLVED_ATTRIBUTE, target) + { + builder.into_diagnostic(format_args!( + "Can not assign object of `{}` to attribute \ + `{attribute}` on type `{}` with \ + custom `__setattr__` method.", + value_ty.display(db), + object_ty.display(db) + )); + } + } + false + } + Err(CallDunderError::MethodNotAvailable) => { + if emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&UNRESOLVED_ATTRIBUTE, target) + { + builder.into_diagnostic(format_args!( + "Unresolved attribute `{}` on type `{}`.", + attribute, + object_ty.display(db) + )); + } + } + + false + } + } + } + } + } + } + + Type::ClassLiteral(..) | Type::GenericAlias(..) | Type::SubclassOf(..) => { + match object_ty.class_member(db, attribute.into()) { + SymbolAndQualifiers { + symbol: Symbol::Type(meta_attr_ty, meta_attr_boundness), + qualifiers: _, + } => { + let assignable_to_meta_attr = if let Symbol::Type(meta_dunder_set, _) = + meta_attr_ty.class_member(db, "__set__".into()).symbol + { + let successful_call = meta_dunder_set + .try_call( + db, + &CallArgumentTypes::positional([ + meta_attr_ty, + object_ty, + value_ty, + ]), + ) + .is_ok(); + + if !successful_call && emit_diagnostics { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + // TODO: Here, it would be nice to emit an additional diagnostic that explains why the call failed + builder.into_diagnostic(format_args!( + "Invalid assignment to data descriptor attribute \ + `{attribute}` on type `{}` with custom `__set__` method", + object_ty.display(db) + )); + } + } + + successful_call + } else { + ensure_assignable_to(meta_attr_ty) + }; + + let assignable_to_class_attr = if meta_attr_boundness + == Boundness::PossiblyUnbound + { + let (assignable, boundness) = if let Symbol::Type( + class_attr_ty, + class_attr_boundness, + ) = object_ty + .find_name_in_mro(db, attribute) + .expect("called on Type::ClassLiteral or Type::SubclassOf") + .symbol + { + (ensure_assignable_to(class_attr_ty), class_attr_boundness) + } else { + (true, Boundness::PossiblyUnbound) + }; + + if boundness == Boundness::PossiblyUnbound { + report_possibly_unbound_attribute( + &self.context, + target, + attribute, + object_ty, + ); + } + + assignable + } else { + true + }; + + assignable_to_meta_attr && assignable_to_class_attr + } + SymbolAndQualifiers { + symbol: Symbol::Unbound, + .. + } => { + if let Symbol::Type(class_attr_ty, class_attr_boundness) = object_ty + .find_name_in_mro(db, attribute) + .expect("called on Type::ClassLiteral or Type::SubclassOf") + .symbol + { + if class_attr_boundness == Boundness::PossiblyUnbound { + report_possibly_unbound_attribute( + &self.context, + target, + attribute, + object_ty, + ); + } + + ensure_assignable_to(class_attr_ty) + } else { + let attribute_is_bound_on_instance = + object_ty.to_instance(self.db()).is_some_and(|instance| { + !instance + .instance_member(self.db(), attribute) + .symbol + .is_unbound() + }); + + // Attribute is declared or bound on instance. Forbid access from the class object + if emit_diagnostics { + if attribute_is_bound_on_instance { + if let Some(builder) = + self.context.report_lint(&INVALID_ATTRIBUTE_ACCESS, target) + { + builder.into_diagnostic(format_args!( + "Cannot assign to instance attribute \ + `{attribute}` from the class object `{ty}`", + ty = object_ty.display(self.db()), + )); + } + } else { + if let Some(builder) = + self.context.report_lint(&UNRESOLVED_ATTRIBUTE, target) + { + builder.into_diagnostic(format_args!( + "Unresolved attribute `{}` on type `{}`.", + attribute, + object_ty.display(db) + )); + } + } + } + + false + } + } + } + } + + Type::ModuleLiteral(module) => { + if let Symbol::Type(attr_ty, _) = module.static_member(db, attribute) { + let assignable = value_ty.is_assignable_to(db, attr_ty); + if !assignable { + report_invalid_attribute_assignment( + &self.context, + target.into(), + attr_ty, + value_ty, + attribute, + ); + } + + false + } else { + if let Some(builder) = self.context.report_lint(&UNRESOLVED_ATTRIBUTE, target) { + builder.into_diagnostic(format_args!( + "Unresolved attribute `{}` on type `{}`.", + attribute, + object_ty.display(db) + )); + } + + false + } + } + } + } + + fn infer_target_impl(&mut self, target: &ast::Expr, assigned_ty: Option<Type<'db>>) { + match target { + ast::Expr::Name(name) => self.infer_definition(name), + ast::Expr::List(ast::ExprList { elts, .. }) + | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => { + let mut assigned_tys = match assigned_ty { + Some(Type::Tuple(tuple)) => { + Either::Left(tuple.elements(self.db()).iter().copied()) + } + Some(_) | None => Either::Right(std::iter::empty()), + }; + + for element in elts { + self.infer_target_impl(element, assigned_tys.next()); + } + } + ast::Expr::Attribute( + attr_expr @ ast::ExprAttribute { + value: object, + ctx: ExprContext::Store, + attr, + .. + }, + ) => { + self.store_expression_type(target, assigned_ty.unwrap_or(Type::unknown())); + + let object_ty = self.infer_expression(object); + + if let Some(assigned_ty) = assigned_ty { + self.validate_attribute_assignment( + attr_expr, + object_ty, + attr.id(), + assigned_ty, + true, + ); + } + } + _ => { + // TODO: Remove this once we handle all possible assignment targets. + self.infer_expression(target); + } + } + } + + fn infer_assignment_definition( + &mut self, + assignment: &AssignmentDefinitionKind<'db>, + definition: Definition<'db>, + ) { + let value = assignment.value(); + let target = assignment.target(); + + let value_ty = self.infer_standalone_expression(value); + + let mut target_ty = match assignment.target_kind() { + TargetKind::Sequence(unpack_position, unpack) => { + let unpacked = infer_unpack_types(self.db(), unpack); + // Only copy the diagnostics if this is the first assignment to avoid duplicating the + // unpack assignments. + if unpack_position == UnpackPosition::First { + self.context.extend(unpacked.diagnostics()); + } + + let target_ast_id = target.scoped_expression_id(self.db(), self.scope()); + unpacked.expression_type(target_ast_id) + } + TargetKind::NameOrAttribute => { + // `TYPE_CHECKING` is a special variable that should only be assigned `False` + // at runtime, but is always considered `True` in type checking. + // See mdtest/known_constants.md#user-defined-type_checking for details. + if target.as_name_expr().map(|name| name.id.as_str()) == Some("TYPE_CHECKING") { + if !matches!( + value.as_boolean_literal_expr(), + Some(ast::ExprBooleanLiteral { value: false, .. }) + ) { + report_invalid_type_checking_constant(&self.context, target.into()); + } + Type::BooleanLiteral(true) + } else if self.in_stub() && value.is_ellipsis_literal_expr() { + Type::unknown() + } else { + value_ty + } + } + }; + + if let Some(known_instance) = target.as_name_expr().and_then(|name| { + KnownInstanceType::try_from_file_and_name(self.db(), self.file(), &name.id) + }) { + target_ty = Type::KnownInstance(known_instance); + } + + self.store_expression_type(target, target_ty); + self.add_binding(target.into(), definition, target_ty); + } + + fn infer_annotated_assignment_statement(&mut self, assignment: &ast::StmtAnnAssign) { + // assignments to non-Names are not Definitions + if matches!(*assignment.target, ast::Expr::Name(_)) { + self.infer_definition(assignment); + } else { + let ast::StmtAnnAssign { + range: _, + annotation, + value, + target, + simple: _, + } = assignment; + let annotated = + self.infer_annotation_expression(annotation, DeferredExpressionState::None); + self.infer_optional_expression(value.as_deref()); + + // If we have an annotated assignment like `self.attr: int = 1`, we still need to + // do type inference on the `self.attr` target to get types for all sub-expressions. + self.infer_expression(target); + + // But here we explicitly overwrite the type for the overall `self.attr` node with + // the annotated type. We do no use `store_expression_type` here, because it checks + // that no type has been stored for the expression before. + let expr_id = target.scoped_expression_id(self.db(), self.scope()); + self.types + .expressions + .insert(expr_id, annotated.inner_type()); + } + } + + /// Infer the types in an annotated assignment definition. + fn infer_annotated_assignment_definition( + &mut self, + assignment: &'db AnnotatedAssignmentDefinitionKind, + definition: Definition<'db>, + ) { + let annotation = assignment.annotation(); + let target = assignment.target(); + let value = assignment.value(); + + let mut declared_ty = self.infer_annotation_expression( + annotation, + DeferredExpressionState::from(self.defer_annotations()), + ); + + if target + .as_name_expr() + .is_some_and(|name| &name.id == "TYPE_CHECKING") + { + if !KnownClass::Bool + .to_instance(self.db()) + .is_assignable_to(self.db(), declared_ty.inner_type()) + { + // annotation not assignable from `bool` is an error + report_invalid_type_checking_constant(&self.context, target.into()); + } else if self.in_stub() + && value + .as_ref() + .is_none_or(|value| value.is_ellipsis_literal_expr()) + { + // stub file assigning nothing or `...` is fine + } else if !matches!( + value + .as_ref() + .and_then(|value| value.as_boolean_literal_expr()), + Some(ast::ExprBooleanLiteral { value: false, .. }) + ) { + // otherwise, assigning something other than `False` is an error + report_invalid_type_checking_constant(&self.context, target.into()); + } + declared_ty.inner = Type::BooleanLiteral(true); + } + + // Handle various singletons. + if let Type::NominalInstance(instance) = declared_ty.inner_type() { + if instance.class.is_known(self.db(), KnownClass::SpecialForm) { + if let Some(name_expr) = target.as_name_expr() { + if let Some(known_instance) = KnownInstanceType::try_from_file_and_name( + self.db(), + self.file(), + &name_expr.id, + ) { + declared_ty.inner = Type::KnownInstance(known_instance); + } + } + } + } + + // Annotated assignments to non-names are not definitions, so we can only be here + // if the target is a name. In this case, we can simply store types in `target` + // below, instead of calling `infer_expression` (which would return `Never`). + debug_assert!(target.is_name_expr()); + + if let Some(value) = value { + let inferred_ty = self.infer_expression(value); + let inferred_ty = if target + .as_name_expr() + .is_some_and(|name| &name.id == "TYPE_CHECKING") + { + Type::BooleanLiteral(true) + } else if self.in_stub() && value.is_ellipsis_literal_expr() { + declared_ty.inner_type() + } else { + inferred_ty + }; + self.add_declaration_with_binding( + target.into(), + definition, + &DeclaredAndInferredType::MightBeDifferent { + declared_ty, + inferred_ty, + }, + ); + + self.store_expression_type(target, inferred_ty); + } else { + if self.in_stub() { + self.add_declaration_with_binding( + target.into(), + definition, + &DeclaredAndInferredType::AreTheSame(declared_ty.inner_type()), + ); + } else { + self.add_declaration(target.into(), definition, declared_ty); + } + + self.store_expression_type(target, declared_ty.inner_type()); + } + } + + fn infer_augmented_assignment_statement(&mut self, assignment: &ast::StmtAugAssign) { + if assignment.target.is_name_expr() { + self.infer_definition(assignment); + } else { + // TODO currently we don't consider assignments to non-Names to be Definitions + self.infer_augment_assignment(assignment); + } + } + + fn infer_augmented_op( + &mut self, + assignment: &ast::StmtAugAssign, + target_type: Type<'db>, + value_type: Type<'db>, + ) -> Type<'db> { + // If the target defines, e.g., `__iadd__`, infer the augmented assignment as a call to that + // dunder. + let op = assignment.op; + let db = self.db(); + + let report_unsupported_augmented_op = |ctx: &mut InferContext| { + let Some(builder) = ctx.report_lint(&UNSUPPORTED_OPERATOR, assignment) else { + return; + }; + builder.into_diagnostic(format_args!( + "Operator `{op}=` is unsupported between objects of type `{}` and `{}`", + target_type.display(db), + value_type.display(db) + )); + }; + + // Fall back to non-augmented binary operator inference. + let mut binary_return_ty = || { + self.infer_binary_expression_type(assignment.into(), false, target_type, value_type, op) + .unwrap_or_else(|| { + report_unsupported_augmented_op(&mut self.context); + Type::unknown() + }) + }; + + match target_type { + Type::Union(union) => union.map(db, |&elem_type| { + self.infer_augmented_op(assignment, elem_type, value_type) + }), + _ => { + let call = target_type.try_call_dunder( + db, + op.in_place_dunder(), + CallArgumentTypes::positional([value_type]), + ); + + match call { + Ok(outcome) => outcome.return_type(db), + Err(CallDunderError::MethodNotAvailable) => binary_return_ty(), + Err(CallDunderError::PossiblyUnbound(outcome)) => { + UnionType::from_elements(db, [outcome.return_type(db), binary_return_ty()]) + } + Err(CallDunderError::CallError(_, bindings)) => { + report_unsupported_augmented_op(&mut self.context); + bindings.return_type(db) + } + } + } + } + } + + fn infer_augment_assignment_definition( + &mut self, + assignment: &ast::StmtAugAssign, + definition: Definition<'db>, + ) { + let target_ty = self.infer_augment_assignment(assignment); + self.add_binding(assignment.into(), definition, target_ty); + } + + fn infer_augment_assignment(&mut self, assignment: &ast::StmtAugAssign) -> Type<'db> { + let ast::StmtAugAssign { + range: _, + target, + op: _, + value, + } = assignment; + + // Resolve the target type, assuming a load context. + let target_type = match &**target { + ast::Expr::Name(name) => { + let previous_value = self.infer_name_load(name); + self.store_expression_type(target, previous_value); + previous_value + } + ast::Expr::Attribute(attr) => { + let previous_value = self.infer_attribute_load(attr); + self.store_expression_type(target, previous_value); + previous_value + } + _ => self.infer_expression(target), + }; + let value_type = self.infer_expression(value); + + self.infer_augmented_op(assignment, target_type, value_type) + } + + fn infer_type_alias_statement(&mut self, node: &ast::StmtTypeAlias) { + self.infer_definition(node); + } + + fn infer_for_statement(&mut self, for_statement: &ast::StmtFor) { + let ast::StmtFor { + range: _, + target, + iter, + body, + orelse, + is_async: _, + } = for_statement; + + self.infer_target(target, iter, |builder, iter_expr| { + // TODO: `infer_for_statement_definition` reports a diagnostic if `iter_ty` isn't iterable + // but only if the target is a name. We should report a diagnostic here if the target isn't a name: + // `for a.x in not_iterable: ... + builder + .infer_standalone_expression(iter_expr) + .iterate(builder.db()) + }); + + self.infer_body(body); + self.infer_body(orelse); + } + + fn infer_for_statement_definition( + &mut self, + for_stmt: &ForStmtDefinitionKind<'db>, + definition: Definition<'db>, + ) { + let iterable = for_stmt.iterable(); + let target = for_stmt.target(); + + let iterable_type = self.infer_standalone_expression(iterable); + + let loop_var_value_type = if for_stmt.is_async() { + todo_type!("async iterables/iterators") + } else { + match for_stmt.target_kind() { + TargetKind::Sequence(unpack_position, unpack) => { + let unpacked = infer_unpack_types(self.db(), unpack); + if unpack_position == UnpackPosition::First { + self.context.extend(unpacked.diagnostics()); + } + let target_ast_id = target.scoped_expression_id(self.db(), self.scope()); + unpacked.expression_type(target_ast_id) + } + TargetKind::NameOrAttribute => { + iterable_type.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, iterable_type, iterable.into()); + err.fallback_element_type(self.db()) + }) + } + } + }; + + self.store_expression_type(target, loop_var_value_type); + self.add_binding(target.into(), definition, loop_var_value_type); + } + + fn infer_while_statement(&mut self, while_statement: &ast::StmtWhile) { + let ast::StmtWhile { + range: _, + test, + body, + orelse, + } = while_statement; + + let test_ty = self.infer_standalone_expression(test); + + if let Err(err) = test_ty.try_bool(self.db()) { + err.report_diagnostic(&self.context, &**test); + } + + self.infer_body(body); + self.infer_body(orelse); + } + + fn infer_import_statement(&mut self, import: &ast::StmtImport) { + let ast::StmtImport { range: _, names } = import; + + for alias in names { + self.infer_definition(alias); + } + } + + fn report_unresolved_import( + &self, + import_node: AnyNodeRef<'_>, + range: TextRange, + level: u32, + module: Option<&str>, + ) { + let is_import_reachable = self.is_reachable(import_node); + + if !is_import_reachable { + return; + } + + let Some(builder) = self.context.report_lint(&UNRESOLVED_IMPORT, range) else { + return; + }; + let mut diagnostic = builder.into_diagnostic(format_args!( + "Cannot resolve imported module `{}{}`", + ".".repeat(level as usize), + module.unwrap_or_default() + )); + if level == 0 { + diagnostic.info( + "make sure your Python environment is properly configured: https://github.com/astral-sh/ty/blob/main/docs/README.md#python-environment" + ); + } + } + + fn infer_import_definition( + &mut self, + node: &ast::StmtImport, + alias: &'db ast::Alias, + definition: Definition<'db>, + ) { + let ast::Alias { + range: _, + name, + asname, + } = alias; + + // The name of the module being imported + let Some(full_module_name) = ModuleName::new(name) else { + tracing::debug!("Failed to resolve import due to invalid syntax"); + self.add_unknown_declaration_with_binding(alias.into(), definition); + return; + }; + + // Resolve the module being imported. + let Some(full_module_ty) = self.module_type_from_name(&full_module_name) else { + self.report_unresolved_import(node.into(), alias.range(), 0, Some(name)); + self.add_unknown_declaration_with_binding(alias.into(), definition); + return; + }; + + let binding_ty = if asname.is_some() { + // If we are renaming the imported module via an `as` clause, then we bind the resolved + // module's type to that name, even if that module is nested. + full_module_ty + } else if full_module_name.contains('.') { + // If there's no `as` clause and the imported module is nested, we're not going to bind + // the resolved module itself into the current scope; we're going to bind the top-most + // parent package of that module. + let topmost_parent_name = + ModuleName::new(full_module_name.components().next().unwrap()).unwrap(); + let Some(topmost_parent_ty) = self.module_type_from_name(&topmost_parent_name) else { + self.add_unknown_declaration_with_binding(alias.into(), definition); + return; + }; + topmost_parent_ty + } else { + // If there's no `as` clause and the imported module isn't nested, then the imported + // module _is_ what we bind into the current scope. + full_module_ty + }; + + self.add_declaration_with_binding( + alias.into(), + definition, + &DeclaredAndInferredType::AreTheSame(binding_ty), + ); + } + + fn infer_import_from_statement(&mut self, import: &ast::StmtImportFrom) { + let ast::StmtImportFrom { + range: _, + module: _, + names, + level: _, + } = import; + + self.check_import_from_module_is_resolvable(import); + + for alias in names { + for definition in self.index.definitions(alias) { + self.extend(infer_definition_types(self.db(), *definition)); + } + } + } + + fn infer_assert_statement(&mut self, assert: &ast::StmtAssert) { + let ast::StmtAssert { + range: _, + test, + msg, + } = assert; + + let test_ty = self.infer_standalone_expression(test); + + if let Err(err) = test_ty.try_bool(self.db()) { + err.report_diagnostic(&self.context, &**test); + } + + self.infer_optional_expression(msg.as_deref()); + } + + fn infer_raise_statement(&mut self, raise: &ast::StmtRaise) { + let ast::StmtRaise { + range: _, + exc, + cause, + } = raise; + + let base_exception_type = KnownClass::BaseException.to_subclass_of(self.db()); + let base_exception_instance = KnownClass::BaseException.to_instance(self.db()); + + let can_be_raised = + UnionType::from_elements(self.db(), [base_exception_type, base_exception_instance]); + let can_be_exception_cause = + UnionType::from_elements(self.db(), [can_be_raised, Type::none(self.db())]); + + if let Some(raised) = exc { + let raised_type = self.infer_expression(raised); + + if !raised_type.is_assignable_to(self.db(), can_be_raised) { + report_invalid_exception_raised(&self.context, raised, raised_type); + } + } + + if let Some(cause) = cause { + let cause_type = self.infer_expression(cause); + + if !cause_type.is_assignable_to(self.db(), can_be_exception_cause) { + report_invalid_exception_cause(&self.context, cause, cause_type); + } + } + } + + /// Resolve the [`ModuleName`], and the type of the module, being referred to by an + /// [`ast::StmtImportFrom`] node. Emit a diagnostic if the module cannot be resolved. + fn check_import_from_module_is_resolvable(&mut self, import_from: &ast::StmtImportFrom) { + let ast::StmtImportFrom { module, level, .. } = import_from; + + // For diagnostics, we want to highlight the unresolvable + // module and not the entire `from ... import ...` statement. + let module_ref = module + .as_ref() + .map(AnyNodeRef::from) + .unwrap_or_else(|| AnyNodeRef::from(import_from)); + let module = module.as_deref(); + + tracing::trace!( + "Resolving import statement from module `{}` into file `{}`", + format_import_from_module(*level, module), + self.file().path(self.db()), + ); + let module_name = ModuleName::from_import_statement(self.db(), self.file(), import_from); + + let module_name = match module_name { + Ok(module_name) => module_name, + Err(ModuleNameResolutionError::InvalidSyntax) => { + tracing::debug!("Failed to resolve import due to invalid syntax"); + // Invalid syntax diagnostics are emitted elsewhere. + return; + } + Err(ModuleNameResolutionError::TooManyDots) => { + tracing::debug!( + "Relative module resolution `{}` failed: too many leading dots", + format_import_from_module(*level, module), + ); + self.report_unresolved_import( + import_from.into(), + module_ref.range(), + *level, + module, + ); + return; + } + Err(ModuleNameResolutionError::UnknownCurrentModule) => { + tracing::debug!( + "Relative module resolution `{}` failed; could not resolve file `{}` to a module", + format_import_from_module(*level, module), + self.file().path(self.db()) + ); + self.report_unresolved_import( + import_from.into(), + module_ref.range(), + *level, + module, + ); + return; + } + }; + + if resolve_module(self.db(), &module_name).is_none() { + self.report_unresolved_import(import_from.into(), module_ref.range(), *level, module); + } + } + + fn infer_import_from_definition( + &mut self, + import_from: &'db ast::StmtImportFrom, + alias: &ast::Alias, + definition: Definition<'db>, + ) { + let Ok(module_name) = + ModuleName::from_import_statement(self.db(), self.file(), import_from) + else { + self.add_unknown_declaration_with_binding(alias.into(), definition); + return; + }; + + let Some(module_ty) = self.module_type_from_name(&module_name) else { + self.add_unknown_declaration_with_binding(alias.into(), definition); + return; + }; + + // The indirection of having `star_import_info` as a separate variable + // is required in order to make the borrow checker happy. + let star_import_info = definition + .kind(self.db()) + .as_star_import() + .map(|star_import| { + let symbol_table = self + .index + .symbol_table(self.scope().file_scope_id(self.db())); + (star_import, symbol_table) + }); + + let name = if let Some((star_import, symbol_table)) = star_import_info.as_ref() { + symbol_table.symbol(star_import.symbol_id()).name() + } else { + &alias.name.id + }; + + // Avoid looking up attributes on a module if a module imports from itself + // (e.g. `from parent import submodule` inside the `parent` module). + let import_is_self_referential = module_ty + .into_module_literal() + .is_some_and(|module| Some(self.file()) == module.module(self.db()).file()); + + // First try loading the requested attribute from the module. + if !import_is_self_referential { + if let Symbol::Type(ty, boundness) = module_ty.member(self.db(), name).symbol { + if &alias.name != "*" && boundness == Boundness::PossiblyUnbound { + // TODO: Consider loading _both_ the attribute and any submodule and unioning them + // together if the attribute exists but is possibly-unbound. + if let Some(builder) = self + .context + .report_lint(&POSSIBLY_UNBOUND_IMPORT, AnyNodeRef::Alias(alias)) + { + builder.into_diagnostic(format_args!( + "Member `{name}` of module `{module_name}` is possibly unbound", + )); + } + } + self.add_declaration_with_binding( + alias.into(), + definition, + &DeclaredAndInferredType::AreTheSame(ty), + ); + return; + } + } + + // If the module doesn't bind the symbol, check if it's a submodule. This won't get + // handled by the `Type::member` call because it relies on the semantic index's + // `imported_modules` set. The semantic index does not include information about + // `from...import` statements because there are two things it cannot determine while only + // inspecting the content of the current file: + // + // - whether the imported symbol is an attribute or submodule + // - whether the containing file is in a module or a package (needed to correctly resolve + // relative imports) + // + // The first would be solvable by making it a _potentially_ imported modules set. The + // second is not. + // + // Regardless, for now, we sidestep all of that by repeating the submodule-or-attribute + // check here when inferring types for a `from...import` statement. + if let Some(submodule_name) = ModuleName::new(name) { + let mut full_submodule_name = module_name.clone(); + full_submodule_name.extend(&submodule_name); + if let Some(submodule_ty) = self.module_type_from_name(&full_submodule_name) { + self.add_declaration_with_binding( + alias.into(), + definition, + &DeclaredAndInferredType::AreTheSame(submodule_ty), + ); + return; + } + } + + if &alias.name != "*" { + let is_import_reachable = self.is_reachable(import_from); + + if is_import_reachable { + if let Some(builder) = self + .context + .report_lint(&UNRESOLVED_IMPORT, AnyNodeRef::Alias(alias)) + { + builder.into_diagnostic(format_args!( + "Module `{module_name}` has no member `{name}`" + )); + } + } + } + + self.add_unknown_declaration_with_binding(alias.into(), definition); + } + + fn infer_return_statement(&mut self, ret: &ast::StmtReturn) { + if let Some(ty) = self.infer_optional_expression(ret.value.as_deref()) { + let range = ret + .value + .as_ref() + .map_or(ret.range(), |value| value.range()); + self.record_return_type(ty, range); + } else { + self.record_return_type(Type::none(self.db()), ret.range()); + } + } + + fn infer_delete_statement(&mut self, delete: &ast::StmtDelete) { + let ast::StmtDelete { range: _, targets } = delete; + for target in targets { + self.infer_expression(target); + } + } + + fn module_type_from_name(&self, module_name: &ModuleName) -> Option<Type<'db>> { + resolve_module(self.db(), module_name) + .map(|module| Type::module_literal(self.db(), self.file(), module)) + } + + fn infer_decorator(&mut self, decorator: &ast::Decorator) -> Type<'db> { + let ast::Decorator { + range: _, + expression, + } = decorator; + + self.infer_expression(expression) + } + + fn parse_arguments(arguments: &ast::Arguments) -> CallArguments<'_> { + arguments + .arguments_source_order() + .map(|arg_or_keyword| { + match arg_or_keyword { + ast::ArgOrKeyword::Arg(arg) => match arg { + ast::Expr::Starred(ast::ExprStarred { .. }) => Argument::Variadic, + // TODO diagnostic if after a keyword argument + _ => Argument::Positional, + }, + ast::ArgOrKeyword::Keyword(ast::Keyword { arg, .. }) => { + if let Some(arg) = arg { + Argument::Keyword(&arg.id) + } else { + // TODO diagnostic if not last + Argument::Keywords + } + } + } + }) + .collect() + } + + fn infer_argument_types<'a>( + &mut self, + ast_arguments: &ast::Arguments, + arguments: CallArguments<'a>, + argument_forms: &[Option<ParameterForm>], + ) -> CallArgumentTypes<'a, 'db> { + let mut ast_arguments = ast_arguments.arguments_source_order(); + CallArgumentTypes::new(arguments, |index, _| { + let arg_or_keyword = ast_arguments + .next() + .expect("argument lists should have consistent lengths"); + match arg_or_keyword { + ast::ArgOrKeyword::Arg(arg) => match arg { + ast::Expr::Starred(ast::ExprStarred { value, .. }) => { + let ty = self.infer_argument_type(value, argument_forms[index]); + self.store_expression_type(arg, ty); + ty + } + _ => self.infer_argument_type(arg, argument_forms[index]), + }, + ast::ArgOrKeyword::Keyword(ast::Keyword { value, .. }) => { + self.infer_argument_type(value, argument_forms[index]) + } + } + }) + } + + fn infer_argument_type( + &mut self, + ast_argument: &ast::Expr, + form: Option<ParameterForm>, + ) -> Type<'db> { + match form { + None | Some(ParameterForm::Value) => self.infer_expression(ast_argument), + Some(ParameterForm::Type) => self.infer_type_expression(ast_argument), + } + } + + fn infer_optional_expression(&mut self, expression: Option<&ast::Expr>) -> Option<Type<'db>> { + expression.map(|expr| self.infer_expression(expr)) + } + + #[track_caller] + fn infer_expression(&mut self, expression: &ast::Expr) -> Type<'db> { + debug_assert_eq!( + self.index.try_expression(expression), + None, + "Calling `self.infer_expression` on a standalone-expression is not allowed because it can lead to double-inference. Use `self.infer_standalone_expression` instead." + ); + + self.infer_expression_impl(expression) + } + + fn infer_standalone_expression(&mut self, expression: &ast::Expr) -> Type<'db> { + let standalone_expression = self.index.expression(expression); + let types = infer_expression_types(self.db(), standalone_expression); + self.extend(types); + + // Instead of calling `self.expression_type(expr)` after extending here, we get + // the result from `types` directly because we might be in cycle recovery where + // `types.cycle_fallback_type` is `Some(fallback_ty)`, which we can retrieve by + // using `expression_type` on `types`: + types.expression_type(expression.scoped_expression_id(self.db(), self.scope())) + } + + fn infer_expression_impl(&mut self, expression: &ast::Expr) -> Type<'db> { + let ty = match expression { + ast::Expr::NoneLiteral(ast::ExprNoneLiteral { range: _ }) => Type::none(self.db()), + ast::Expr::NumberLiteral(literal) => self.infer_number_literal_expression(literal), + ast::Expr::BooleanLiteral(literal) => self.infer_boolean_literal_expression(literal), + ast::Expr::StringLiteral(literal) => self.infer_string_literal_expression(literal), + ast::Expr::BytesLiteral(bytes_literal) => { + self.infer_bytes_literal_expression(bytes_literal) + } + ast::Expr::FString(fstring) => self.infer_fstring_expression(fstring), + ast::Expr::EllipsisLiteral(literal) => self.infer_ellipsis_literal_expression(literal), + ast::Expr::Tuple(tuple) => self.infer_tuple_expression(tuple), + ast::Expr::List(list) => self.infer_list_expression(list), + ast::Expr::Set(set) => self.infer_set_expression(set), + ast::Expr::Dict(dict) => self.infer_dict_expression(dict), + ast::Expr::Generator(generator) => self.infer_generator_expression(generator), + ast::Expr::ListComp(listcomp) => self.infer_list_comprehension_expression(listcomp), + ast::Expr::DictComp(dictcomp) => self.infer_dict_comprehension_expression(dictcomp), + ast::Expr::SetComp(setcomp) => self.infer_set_comprehension_expression(setcomp), + ast::Expr::Name(name) => self.infer_name_expression(name), + ast::Expr::Attribute(attribute) => self.infer_attribute_expression(attribute), + ast::Expr::UnaryOp(unary_op) => self.infer_unary_expression(unary_op), + ast::Expr::BinOp(binary) => self.infer_binary_expression(binary), + ast::Expr::BoolOp(bool_op) => self.infer_boolean_expression(bool_op), + ast::Expr::Compare(compare) => self.infer_compare_expression(compare), + ast::Expr::Subscript(subscript) => self.infer_subscript_expression(subscript), + ast::Expr::Slice(slice) => self.infer_slice_expression(slice), + ast::Expr::Named(named) => self.infer_named_expression(named), + ast::Expr::If(if_expression) => self.infer_if_expression(if_expression), + ast::Expr::Lambda(lambda_expression) => self.infer_lambda_expression(lambda_expression), + ast::Expr::Call(call_expression) => { + self.infer_call_expression(expression, call_expression) + } + ast::Expr::Starred(starred) => self.infer_starred_expression(starred), + ast::Expr::Yield(yield_expression) => self.infer_yield_expression(yield_expression), + ast::Expr::YieldFrom(yield_from) => self.infer_yield_from_expression(yield_from), + ast::Expr::Await(await_expression) => self.infer_await_expression(await_expression), + ast::Expr::IpyEscapeCommand(_) => { + todo_type!("Ipy escape command support") + } + }; + + self.store_expression_type(expression, ty); + + ty + } + + fn store_expression_type(&mut self, expression: &impl HasScopedExpressionId, ty: Type<'db>) { + if self.deferred_state.in_string_annotation() { + // Avoid storing the type of expressions that are part of a string annotation because + // the expression ids don't exists in the semantic index. Instead, we'll store the type + // on the string expression itself that represents the annotation. + return; + } + let expr_id = expression.scoped_expression_id(self.db(), self.scope()); + let previous = self.types.expressions.insert(expr_id, ty); + assert_eq!(previous, None); + } + + fn infer_number_literal_expression(&mut self, literal: &ast::ExprNumberLiteral) -> Type<'db> { + let ast::ExprNumberLiteral { range: _, value } = literal; + let db = self.db(); + + match value { + ast::Number::Int(n) => n + .as_i64() + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(db)), + ast::Number::Float(_) => KnownClass::Float.to_instance(db), + ast::Number::Complex { .. } => KnownClass::Complex.to_instance(db), + } + } + + #[expect(clippy::unused_self)] + fn infer_boolean_literal_expression(&mut self, literal: &ast::ExprBooleanLiteral) -> Type<'db> { + let ast::ExprBooleanLiteral { range: _, value } = literal; + + Type::BooleanLiteral(*value) + } + + fn infer_string_literal_expression(&mut self, literal: &ast::ExprStringLiteral) -> Type<'db> { + if literal.value.len() <= Self::MAX_STRING_LITERAL_SIZE { + Type::string_literal(self.db(), literal.value.to_str()) + } else { + Type::LiteralString + } + } + + fn infer_bytes_literal_expression(&mut self, literal: &ast::ExprBytesLiteral) -> Type<'db> { + // TODO: ignoring r/R prefixes for now, should normalize bytes values + let bytes: Vec<u8> = literal.value.bytes().collect(); + Type::bytes_literal(self.db(), &bytes) + } + + fn infer_fstring_expression(&mut self, fstring: &ast::ExprFString) -> Type<'db> { + let ast::ExprFString { range: _, value } = fstring; + + let mut collector = StringPartsCollector::new(); + for part in value { + // Make sure we iter through every parts to infer all sub-expressions. The `collector` + // struct ensures we don't allocate unnecessary strings. + match part { + ast::FStringPart::Literal(literal) => { + collector.push_str(&literal.value); + } + ast::FStringPart::FString(fstring) => { + for element in &fstring.elements { + match element { + ast::FStringElement::Expression(expression) => { + let ast::FStringExpressionElement { + range: _, + expression, + debug_text: _, + conversion, + format_spec, + } = expression; + let ty = self.infer_expression(expression); + + if let Some(format_spec) = format_spec { + for element in format_spec.elements.expressions() { + self.infer_expression(&element.expression); + } + } + + // TODO: handle format specifiers by calling a method + // (`Type::format`?) that handles the `__format__` method. + // Conversion flags should be handled before calling `__format__`. + // https://docs.python.org/3/library/string.html#format-string-syntax + if !conversion.is_none() || format_spec.is_some() { + collector.add_expression(); + } else { + if let Type::StringLiteral(literal) = ty.str(self.db()) { + collector.push_str(literal.value(self.db())); + } else { + collector.add_expression(); + } + } + } + ast::FStringElement::Literal(literal) => { + collector.push_str(&literal.value); + } + } + } + } + } + } + collector.string_type(self.db()) + } + + fn infer_ellipsis_literal_expression( + &mut self, + _literal: &ast::ExprEllipsisLiteral, + ) -> Type<'db> { + KnownClass::EllipsisType.to_instance(self.db()) + } + + fn infer_tuple_expression(&mut self, tuple: &ast::ExprTuple) -> Type<'db> { + let ast::ExprTuple { + range: _, + elts, + ctx: _, + parenthesized: _, + } = tuple; + + // Collecting all elements is necessary to infer all sub-expressions even if some + // element types are `Never` (which leads `from_elements` to return early without + // consuming the whole iterator). + let element_types: Vec<_> = elts.iter().map(|elt| self.infer_expression(elt)).collect(); + + TupleType::from_elements(self.db(), element_types) + } + + fn infer_list_expression(&mut self, list: &ast::ExprList) -> Type<'db> { + let ast::ExprList { + range: _, + elts, + ctx: _, + } = list; + + for elt in elts { + self.infer_expression(elt); + } + + // TODO generic + KnownClass::List.to_instance(self.db()) + } + + fn infer_set_expression(&mut self, set: &ast::ExprSet) -> Type<'db> { + let ast::ExprSet { range: _, elts } = set; + + for elt in elts { + self.infer_expression(elt); + } + + // TODO generic + KnownClass::Set.to_instance(self.db()) + } + + fn infer_dict_expression(&mut self, dict: &ast::ExprDict) -> Type<'db> { + let ast::ExprDict { range: _, items } = dict; + + for item in items { + self.infer_optional_expression(item.key.as_ref()); + self.infer_expression(&item.value); + } + + // TODO generic + KnownClass::Dict.to_instance(self.db()) + } + + /// Infer the type of the `iter` expression of the first comprehension. + fn infer_first_comprehension_iter(&mut self, comprehensions: &[ast::Comprehension]) { + let mut comprehensions_iter = comprehensions.iter(); + let Some(first_comprehension) = comprehensions_iter.next() else { + unreachable!("Comprehension must contain at least one generator"); + }; + self.infer_standalone_expression(&first_comprehension.iter); + } + + fn infer_generator_expression(&mut self, generator: &ast::ExprGenerator) -> Type<'db> { + let ast::ExprGenerator { + range: _, + elt: _, + generators, + parenthesized: _, + } = generator; + + self.infer_first_comprehension_iter(generators); + + todo_type!("generator type") + } + + fn infer_list_comprehension_expression(&mut self, listcomp: &ast::ExprListComp) -> Type<'db> { + let ast::ExprListComp { + range: _, + elt: _, + generators, + } = listcomp; + + self.infer_first_comprehension_iter(generators); + + todo_type!("list comprehension type") + } + + fn infer_dict_comprehension_expression(&mut self, dictcomp: &ast::ExprDictComp) -> Type<'db> { + let ast::ExprDictComp { + range: _, + key: _, + value: _, + generators, + } = dictcomp; + + self.infer_first_comprehension_iter(generators); + + todo_type!("dict comprehension type") + } + + fn infer_set_comprehension_expression(&mut self, setcomp: &ast::ExprSetComp) -> Type<'db> { + let ast::ExprSetComp { + range: _, + elt: _, + generators, + } = setcomp; + + self.infer_first_comprehension_iter(generators); + + todo_type!("set comprehension type") + } + + fn infer_generator_expression_scope(&mut self, generator: &ast::ExprGenerator) { + let ast::ExprGenerator { + range: _, + elt, + generators, + parenthesized: _, + } = generator; + + self.infer_expression(elt); + self.infer_comprehensions(generators); + } + + fn infer_list_comprehension_expression_scope(&mut self, listcomp: &ast::ExprListComp) { + let ast::ExprListComp { + range: _, + elt, + generators, + } = listcomp; + + self.infer_expression(elt); + self.infer_comprehensions(generators); + } + + fn infer_dict_comprehension_expression_scope(&mut self, dictcomp: &ast::ExprDictComp) { + let ast::ExprDictComp { + range: _, + key, + value, + generators, + } = dictcomp; + + self.infer_expression(key); + self.infer_expression(value); + self.infer_comprehensions(generators); + } + + fn infer_set_comprehension_expression_scope(&mut self, setcomp: &ast::ExprSetComp) { + let ast::ExprSetComp { + range: _, + elt, + generators, + } = setcomp; + + self.infer_expression(elt); + self.infer_comprehensions(generators); + } + + fn infer_comprehensions(&mut self, comprehensions: &[ast::Comprehension]) { + let mut comprehensions_iter = comprehensions.iter(); + let Some(first_comprehension) = comprehensions_iter.next() else { + unreachable!("Comprehension must contain at least one generator"); + }; + self.infer_comprehension(first_comprehension, true); + for comprehension in comprehensions_iter { + self.infer_comprehension(comprehension, false); + } + } + + fn infer_comprehension(&mut self, comprehension: &ast::Comprehension, is_first: bool) { + let ast::Comprehension { + range: _, + target, + iter, + ifs, + is_async: _, + } = comprehension; + + self.infer_target(target, iter, |builder, iter_expr| { + // TODO: `infer_comprehension_definition` reports a diagnostic if `iter_ty` isn't iterable + // but only if the target is a name. We should report a diagnostic here if the target isn't a name: + // `[... for a.x in not_iterable] + if is_first { + infer_same_file_expression_type(builder.db(), builder.index.expression(iter_expr)) + } else { + builder.infer_standalone_expression(iter_expr) + } + .iterate(builder.db()) + }); + for expr in ifs { + self.infer_expression(expr); + } + } + + fn infer_comprehension_definition( + &mut self, + comprehension: &ComprehensionDefinitionKind<'db>, + definition: Definition<'db>, + ) { + let iterable = comprehension.iterable(); + let target = comprehension.target(); + + let expression = self.index.expression(iterable); + let result = infer_expression_types(self.db(), expression); + + // Two things are different if it's the first comprehension: + // (1) We must lookup the `ScopedExpressionId` of the iterable expression in the outer scope, + // because that's the scope we visit it in in the semantic index builder + // (2) We must *not* call `self.extend()` on the result of the type inference, + // because `ScopedExpressionId`s are only meaningful within their own scope, so + // we'd add types for random wrong expressions in the current scope + let iterable_type = if comprehension.is_first() { + let lookup_scope = self + .index + .parent_scope_id(self.scope().file_scope_id(self.db())) + .expect("A comprehension should never be the top-level scope") + .to_scope_id(self.db(), self.file()); + result.expression_type(iterable.scoped_expression_id(self.db(), lookup_scope)) + } else { + self.extend(result); + result.expression_type(iterable.scoped_expression_id(self.db(), self.scope())) + }; + + let target_type = if comprehension.is_async() { + // TODO: async iterables/iterators! -- Alex + todo_type!("async iterables/iterators") + } else { + match comprehension.target_kind() { + TargetKind::Sequence(unpack_position, unpack) => { + let unpacked = infer_unpack_types(self.db(), unpack); + if unpack_position == UnpackPosition::First { + self.context.extend(unpacked.diagnostics()); + } + let target_ast_id = target.scoped_expression_id(self.db(), self.scope()); + unpacked.expression_type(target_ast_id) + } + TargetKind::NameOrAttribute => { + iterable_type.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, iterable_type, iterable.into()); + err.fallback_element_type(self.db()) + }) + } + } + }; + + self.types.expressions.insert( + target.scoped_expression_id(self.db(), self.scope()), + target_type, + ); + self.add_binding(target.into(), definition, target_type); + } + + fn infer_named_expression(&mut self, named: &ast::ExprNamed) -> Type<'db> { + // See https://peps.python.org/pep-0572/#differences-between-assignment-expressions-and-assignment-statements + if named.target.is_name_expr() { + let definition = self.index.expect_single_definition(named); + let result = infer_definition_types(self.db(), definition); + self.extend(result); + result.binding_type(definition) + } else { + // For syntactically invalid targets, we still need to run type inference: + self.infer_expression(&named.target); + self.infer_expression(&named.value); + Type::unknown() + } + } + + fn infer_named_expression_definition( + &mut self, + named: &ast::ExprNamed, + definition: Definition<'db>, + ) -> Type<'db> { + let ast::ExprNamed { + range: _, + target, + value, + } = named; + + let value_ty = self.infer_expression(value); + self.infer_expression(target); + + self.add_binding(named.into(), definition, value_ty); + + value_ty + } + + fn infer_if_expression(&mut self, if_expression: &ast::ExprIf) -> Type<'db> { + let ast::ExprIf { + range: _, + test, + body, + orelse, + } = if_expression; + + let test_ty = self.infer_standalone_expression(test); + let body_ty = self.infer_expression(body); + let orelse_ty = self.infer_expression(orelse); + + match test_ty.try_bool(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, &**test); + err.fallback_truthiness() + }) { + Truthiness::AlwaysTrue => body_ty, + Truthiness::AlwaysFalse => orelse_ty, + Truthiness::Ambiguous => UnionType::from_elements(self.db(), [body_ty, orelse_ty]), + } + } + + fn infer_lambda_body(&mut self, lambda_expression: &ast::ExprLambda) { + self.infer_expression(&lambda_expression.body); + } + + fn infer_lambda_expression(&mut self, lambda_expression: &ast::ExprLambda) -> Type<'db> { + let ast::ExprLambda { + range: _, + parameters, + body: _, + } = lambda_expression; + + let parameters = if let Some(parameters) = parameters { + let positional_only = parameters + .posonlyargs + .iter() + .map(|param| { + let mut parameter = Parameter::positional_only(Some(param.name().id.clone())); + if let Some(default) = param.default() { + parameter = parameter.with_default_type(self.infer_expression(default)); + } + parameter + }) + .collect::<Vec<_>>(); + let positional_or_keyword = parameters + .args + .iter() + .map(|param| { + let mut parameter = Parameter::positional_or_keyword(param.name().id.clone()); + if let Some(default) = param.default() { + parameter = parameter.with_default_type(self.infer_expression(default)); + } + parameter + }) + .collect::<Vec<_>>(); + let variadic = parameters + .vararg + .as_ref() + .map(|param| Parameter::variadic(param.name().id.clone())); + let keyword_only = parameters + .kwonlyargs + .iter() + .map(|param| { + let mut parameter = Parameter::keyword_only(param.name().id.clone()); + if let Some(default) = param.default() { + parameter = parameter.with_default_type(self.infer_expression(default)); + } + parameter + }) + .collect::<Vec<_>>(); + let keyword_variadic = parameters + .kwarg + .as_ref() + .map(|param| Parameter::keyword_variadic(param.name().id.clone())); + + Parameters::new( + positional_only + .into_iter() + .chain(positional_or_keyword) + .chain(variadic) + .chain(keyword_only) + .chain(keyword_variadic), + ) + } else { + Parameters::empty() + }; + + // TODO: Useful inference of a lambda's return type will require a different approach, + // which does the inference of the body expression based on arguments at each call site, + // rather than eagerly computing a return type without knowing the argument types. + Type::Callable(CallableType::single( + self.db(), + Signature::new(parameters, Some(Type::unknown())), + )) + } + + /// Returns the type of the first parameter if the given scope is function-like (i.e. function or lambda). + /// Returns `None` if the scope is not function-like, or has no parameters. + fn first_param_type_in_scope(&self, scope: ScopeId) -> Option<Type<'db>> { + let first_param = match scope.node(self.db()) { + NodeWithScopeKind::Function(f) => f.parameters.iter().next(), + NodeWithScopeKind::Lambda(l) => l.parameters.as_ref()?.iter().next(), + _ => None, + }?; + + let definition = self.index.expect_single_definition(first_param); + + Some(infer_definition_types(self.db(), definition).binding_type(definition)) + } + + fn infer_call_expression( + &mut self, + call_expression_node: &ast::Expr, + call_expression: &ast::ExprCall, + ) -> Type<'db> { + let ast::ExprCall { + range: _, + func, + arguments, + } = call_expression; + + // We don't call `Type::try_call`, because we want to perform type inference on the + // arguments after matching them to parameters, but before checking that the argument types + // are assignable to any parameter annotations. + let call_arguments = Self::parse_arguments(arguments); + let callable_type = self.infer_expression(func); + + if let Type::FunctionLiteral(function) = callable_type { + // Make sure that the `function.definition` is only called when the function is defined + // in the same file as the one we're currently inferring the types for. This is because + // the `definition` method accesses the semantic index, which could create a + // cross-module AST dependency. + if function.file(self.db()) == self.file() + && function.definition(self.db()).scope(self.db()) == self.scope() + { + self.called_functions.insert(function); + } + } + + let class = match callable_type { + Type::ClassLiteral(class) => Some(ClassType::NonGeneric(class)), + Type::GenericAlias(generic) => Some(ClassType::Generic(generic)), + Type::SubclassOf(subclass) => subclass.subclass_of().into_class(), + _ => None, + }; + + if let Some(class) = class { + // It might look odd here that we emit an error for class-literals and generic aliases but not + // `type[]` types. But it's deliberate! The typing spec explicitly mandates that `type[]` types + // can be called even though class-literals cannot. This is because even though a protocol class + // `SomeProtocol` is always an abstract class, `type[SomeProtocol]` can be a concrete subclass of + // that protocol -- and indeed, according to the spec, type checkers must disallow abstract + // subclasses of the protocol to be passed to parameters that accept `type[SomeProtocol]`. + // <https://typing.python.org/en/latest/spec/protocol.html#type-and-class-objects-vs-protocols>. + if !callable_type.is_subclass_of() { + if let Some(protocol) = class + .class_literal(self.db()) + .0 + .into_protocol_class(self.db()) + { + report_attempted_protocol_instantiation( + &self.context, + call_expression, + protocol, + ); + } + } + + // For class literals we model the entire class instantiation logic, so it is handled + // in a separate function. For some known classes we have manual signatures defined and use + // the `try_call` path below. + // TODO: it should be possible to move these special cases into the `try_call_constructor` + // path instead, or even remove some entirely once we support overloads fully. + if !matches!( + class.known(self.db()), + Some( + KnownClass::Bool + | KnownClass::Str + | KnownClass::Type + | KnownClass::Object + | KnownClass::Property + | KnownClass::Super + | KnownClass::TypeVar + | KnownClass::NamedTuple + | KnownClass::TypeAliasType + ) + ) + // temporary special-casing for all subclasses of `enum.Enum` + // until we support the functional syntax for creating enum classes + && KnownClass::Enum + .to_class_literal(self.db()) + .to_class_type(self.db()) + .is_none_or(|enum_class| !class.is_subclass_of(self.db(), enum_class)) + { + let argument_forms = vec![Some(ParameterForm::Value); call_arguments.len()]; + let call_argument_types = + self.infer_argument_types(arguments, call_arguments, &argument_forms); + + return callable_type + .try_call_constructor(self.db(), call_argument_types) + .unwrap_or_else(|err| { + err.report_diagnostic(&self.context, callable_type, call_expression.into()); + err.return_type() + }); + } + } + + let signatures = callable_type.signatures(self.db()); + let bindings = Bindings::match_parameters(signatures, &call_arguments); + let call_argument_types = + self.infer_argument_types(arguments, call_arguments, &bindings.argument_forms); + + match bindings.check_types(self.db(), &call_argument_types) { + Ok(mut bindings) => { + for binding in &mut bindings { + let binding_type = binding.callable_type; + for (_, overload) in binding.matching_overloads_mut() { + match binding_type { + Type::FunctionLiteral(function_literal) => { + let Some(known_function) = function_literal.known(self.db()) else { + continue; + }; + + match known_function { + KnownFunction::RevealType => { + if let [Some(revealed_type)] = overload.parameter_types() { + if let Some(builder) = self.context.report_diagnostic( + DiagnosticId::RevealedType, + Severity::Info, + ) { + let mut diag = + builder.into_diagnostic("Revealed type"); + let span = self + .context + .span(&call_expression.arguments.args[0]); + diag.annotate(Annotation::primary(span).message( + format_args!( + "`{}`", + revealed_type.display(self.db()) + ), + )); + } + } + } + KnownFunction::AssertType => { + if let [Some(actual_ty), Some(asserted_ty)] = + overload.parameter_types() + { + if !actual_ty + .is_gradual_equivalent_to(self.db(), *asserted_ty) + { + if let Some(builder) = self.context.report_lint( + &TYPE_ASSERTION_FAILURE, + call_expression, + ) { + let mut diagnostic = + builder.into_diagnostic(format_args!( + "Argument does not have asserted type `{}`", + asserted_ty.display(self.db()), + )); + diagnostic.annotate( + Annotation::secondary(self.context.span( + &call_expression.arguments.args[0], + )) + .message(format_args!( + "Inferred type of argument is `{}`", + actual_ty.display(self.db()), + )), + ); + diagnostic.info( + format_args!( + "`{asserted_type}` and `{inferred_type}` are not equivalent types", + asserted_type = asserted_ty.display(self.db()), + inferred_type = actual_ty.display(self.db()), + ) + ); + } + } + } + } + KnownFunction::AssertNever => { + if let [Some(actual_ty)] = overload.parameter_types() { + if !actual_ty.is_equivalent_to(self.db(), Type::Never) { + if let Some(builder) = self.context.report_lint( + &TYPE_ASSERTION_FAILURE, + call_expression, + ) { + let mut diagnostic = builder.into_diagnostic( + "Argument does not have asserted type `Never`", + ); + diagnostic.annotate( + Annotation::secondary(self.context.span( + &call_expression.arguments.args[0], + )) + .message(format_args!( + "Inferred type of argument is `{}`", + actual_ty.display(self.db()) + )), + ); + diagnostic.info( + format_args!( + "`Never` and `{inferred_type}` are not equivalent types", + inferred_type = actual_ty.display(self.db()), + ) + ); + } + } + } + } + KnownFunction::StaticAssert => { + if let [Some(parameter_ty), message] = + overload.parameter_types() + { + let truthiness = match parameter_ty.try_bool(self.db()) + { + Ok(truthiness) => truthiness, + Err(err) => { + let condition = arguments + .find_argument("condition", 0) + .map(|argument| { + match argument { + ruff_python_ast::ArgOrKeyword::Arg( + expr, + ) => ast::AnyNodeRef::from(expr), + ruff_python_ast::ArgOrKeyword::Keyword( + keyword, + ) => ast::AnyNodeRef::from(keyword), + } + }) + .unwrap_or(ast::AnyNodeRef::from( + call_expression, + )); + + err.report_diagnostic(&self.context, condition); + + continue; + } + }; + + if let Some(builder) = self + .context + .report_lint(&STATIC_ASSERT_ERROR, call_expression) + { + if !truthiness.is_always_true() { + if let Some(message) = message + .and_then(Type::into_string_literal) + .map(|s| s.value(self.db())) + { + builder.into_diagnostic(format_args!( + "Static assertion error: {message}" + )); + } else if *parameter_ty + == Type::BooleanLiteral(false) + { + builder.into_diagnostic( + "Static assertion error: \ + argument evaluates to `False`", + ); + } else if truthiness.is_always_false() { + builder.into_diagnostic(format_args!( + "Static assertion error: \ + argument of type `{parameter_ty}` \ + is statically known to be falsy", + parameter_ty = + parameter_ty.display(self.db()) + )); + } else { + builder.into_diagnostic(format_args!( + "Static assertion error: \ + argument of type `{parameter_ty}` \ + has an ambiguous static truthiness", + parameter_ty = + parameter_ty.display(self.db()) + )); + } + } + } + } + } + KnownFunction::Cast => { + if let [Some(casted_type), Some(source_type)] = + overload.parameter_types() + { + let db = self.db(); + let contains_unknown_or_todo = |ty| matches!(ty, Type::Dynamic(dynamic) if dynamic != DynamicType::Any); + if source_type.is_equivalent_to(db, *casted_type) + || (source_type.normalized(db) + == casted_type.normalized(db) + && !casted_type.any_over_type(db, &|ty| { + contains_unknown_or_todo(ty) + }) + && !source_type.any_over_type(db, &|ty| { + contains_unknown_or_todo(ty) + })) + { + if let Some(builder) = self + .context + .report_lint(&REDUNDANT_CAST, call_expression) + { + builder.into_diagnostic(format_args!( + "Value is already of type `{}`", + casted_type.display(db), + )); + } + } + } + } + KnownFunction::GetProtocolMembers => { + if let [Some(Type::ClassLiteral(class))] = + overload.parameter_types() + { + if !class.is_protocol(self.db()) { + report_bad_argument_to_get_protocol_members( + &self.context, + call_expression, + *class, + ); + } + } + } + KnownFunction::IsInstance | KnownFunction::IsSubclass => { + if let [_, Some(Type::ClassLiteral(class))] = + overload.parameter_types() + { + if let Some(protocol_class) = + class.into_protocol_class(self.db()) + { + if !protocol_class.is_runtime_checkable(self.db()) { + report_runtime_check_against_non_runtime_checkable_protocol( + &self.context, + call_expression, + protocol_class, + known_function + ); + } + } + } + } + _ => {} + } + } + + Type::ClassLiteral(class) => { + let Some(known_class) = class.known(self.db()) else { + continue; + }; + + match known_class { + KnownClass::Super => { + // Handle the case where `super()` is called with no arguments. + // In this case, we need to infer the two arguments: + // 1. The nearest enclosing class + // 2. The first parameter of the current function (typically `self` or `cls`) + match overload.parameter_types() { + [] => { + let scope = self.scope(); + + let Some(enclosing_class) = nearest_enclosing_class( + self.db(), + self.index, + scope, + ) else { + overload.set_return_type(Type::unknown()); + BoundSuperError::UnavailableImplicitArguments + .report_diagnostic( + &self.context, + call_expression.into(), + ); + continue; + }; + + let Some(first_param) = + self.first_param_type_in_scope(scope) + else { + overload.set_return_type(Type::unknown()); + BoundSuperError::UnavailableImplicitArguments + .report_diagnostic( + &self.context, + call_expression.into(), + ); + continue; + }; + + let bound_super = BoundSuperType::build( + self.db(), + Type::ClassLiteral(enclosing_class), + first_param, + ) + .unwrap_or_else(|err| { + err.report_diagnostic( + &self.context, + call_expression.into(), + ); + Type::unknown() + }); + + overload.set_return_type(bound_super); + } + [Some(pivot_class_type), Some(owner_type)] => { + let bound_super = BoundSuperType::build( + self.db(), + *pivot_class_type, + *owner_type, + ) + .unwrap_or_else(|err| { + err.report_diagnostic( + &self.context, + call_expression.into(), + ); + Type::unknown() + }); + + overload.set_return_type(bound_super); + } + _ => (), + } + } + + KnownClass::TypeVar => { + let assigned_to = (self.index) + .try_expression(call_expression_node) + .and_then(|expr| expr.assigned_to(self.db())); + + let Some(target) = + assigned_to.as_ref().and_then(|assigned_to| { + match assigned_to.node().targets.as_slice() { + [ast::Expr::Name(target)] => Some(target), + _ => None, + } + }) + else { + if let Some(builder) = self.context.report_lint( + &INVALID_LEGACY_TYPE_VARIABLE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "A legacy `typing.TypeVar` must be immediately assigned to a variable", + )); + } + continue; + }; + + let [ + Some(name_param), + constraints, + bound, + default, + contravariant, + covariant, + _infer_variance, + ] = overload.parameter_types() + else { + continue; + }; + + let covariant = match covariant { + Some(ty) => ty.bool(self.db()), + None => Truthiness::AlwaysFalse, + }; + + let contravariant = match contravariant { + Some(ty) => ty.bool(self.db()), + None => Truthiness::AlwaysFalse, + }; + + let variance = match (contravariant, covariant) { + (Truthiness::Ambiguous, _) => { + if let Some(builder) = self.context.report_lint( + &INVALID_LEGACY_TYPE_VARIABLE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "The `contravariant` parameter of \ + a legacy `typing.TypeVar` cannot have \ + an ambiguous value", + )); + } + continue; + } + (_, Truthiness::Ambiguous) => { + if let Some(builder) = self.context.report_lint( + &INVALID_LEGACY_TYPE_VARIABLE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "The `covariant` parameter of \ + a legacy `typing.TypeVar` cannot have \ + an ambiguous value", + )); + } + continue; + } + (Truthiness::AlwaysTrue, Truthiness::AlwaysTrue) => { + if let Some(builder) = self.context.report_lint( + &INVALID_LEGACY_TYPE_VARIABLE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "A legacy `typing.TypeVar` cannot be \ + both covariant and contravariant", + )); + } + continue; + } + (Truthiness::AlwaysTrue, Truthiness::AlwaysFalse) => { + TypeVarVariance::Contravariant + } + (Truthiness::AlwaysFalse, Truthiness::AlwaysTrue) => { + TypeVarVariance::Covariant + } + (Truthiness::AlwaysFalse, Truthiness::AlwaysFalse) => { + TypeVarVariance::Invariant + } + }; + + let name_param = name_param + .into_string_literal() + .map(|name| name.value(self.db())); + if name_param + .is_none_or(|name_param| name_param != target.id) + { + if let Some(builder) = self.context.report_lint( + &INVALID_LEGACY_TYPE_VARIABLE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "The name of a legacy `typing.TypeVar`{} must match \ + the name of the variable it is assigned to (`{}`)", + if let Some(name_param) = name_param { + format!(" (`{name_param}`)") + } else { + String::new() + }, + target.id, + )); + } + continue; + } + + let bound_or_constraint = match (bound, constraints) { + (Some(bound), None) => { + Some(TypeVarBoundOrConstraints::UpperBound(*bound)) + } + + (None, Some(_constraints)) => { + // We don't use UnionType::from_elements or UnionBuilder here, + // because we don't want to simplify the list of constraints like + // we do with the elements of an actual union type. + // TODO: Consider using a new `OneOfType` connective here instead, + // since that more accurately represents the actual semantics of + // typevar constraints. + let elements = UnionType::new( + self.db(), + overload + .arguments_for_parameter( + &call_argument_types, + 1, + ) + .map(|(_, ty)| ty) + .collect::<Box<_>>(), + ); + Some(TypeVarBoundOrConstraints::Constraints( + elements, + )) + } + + // TODO: Emit a diagnostic that TypeVar cannot be both bounded and + // constrained + (Some(_), Some(_)) => continue, + + (None, None) => None, + }; + + let containing_assignment = + self.index.expect_single_definition(target); + overload.set_return_type(Type::KnownInstance( + KnownInstanceType::TypeVar(TypeVarInstance::new( + self.db(), + target.id.clone(), + Some(containing_assignment), + bound_or_constraint, + variance, + *default, + TypeVarKind::Legacy, + )), + )); + } + + KnownClass::TypeAliasType => { + let assigned_to = (self.index) + .try_expression(call_expression_node) + .and_then(|expr| expr.assigned_to(self.db())); + + let containing_assignment = + assigned_to.as_ref().and_then(|assigned_to| { + match assigned_to.node().targets.as_slice() { + [ast::Expr::Name(target)] => Some( + self.index.expect_single_definition(target), + ), + _ => None, + } + }); + + let [Some(name), Some(value), ..] = + overload.parameter_types() + else { + continue; + }; + + if let Some(name) = name.into_string_literal() { + overload.set_return_type(Type::KnownInstance( + KnownInstanceType::TypeAliasType( + TypeAliasType::Bare(BareTypeAliasType::new( + self.db(), + ast::name::Name::new(name.value(self.db())), + containing_assignment, + value, + )), + ), + )); + } else { + if let Some(builder) = self.context.report_lint( + &INVALID_TYPE_ALIAS_TYPE, + call_expression, + ) { + builder.into_diagnostic(format_args!( + "The name of a `typing.TypeAlias` must be a string literal", + )); + } + } + } + + _ => (), + } + } + _ => (), + } + } + } + bindings.return_type(self.db()) + } + + Err(CallError(_, bindings)) => { + bindings.report_diagnostics(&self.context, call_expression.into()); + bindings.return_type(self.db()) + } + } + } + + fn infer_starred_expression(&mut self, starred: &ast::ExprStarred) -> Type<'db> { + let ast::ExprStarred { + range: _, + value, + ctx: _, + } = starred; + + let iterable_type = self.infer_expression(value); + iterable_type.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, iterable_type, value.as_ref().into()); + err.fallback_element_type(self.db()) + }); + + // TODO + todo_type!("starred expression") + } + + fn infer_yield_expression(&mut self, yield_expression: &ast::ExprYield) -> Type<'db> { + let ast::ExprYield { range: _, value } = yield_expression; + self.infer_optional_expression(value.as_deref()); + todo_type!("yield expressions") + } + + fn infer_yield_from_expression(&mut self, yield_from: &ast::ExprYieldFrom) -> Type<'db> { + let ast::ExprYieldFrom { range: _, value } = yield_from; + + let iterable_type = self.infer_expression(value); + iterable_type.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, iterable_type, value.as_ref().into()); + err.fallback_element_type(self.db()) + }); + + // TODO get type from `ReturnType` of generator + todo_type!("Generic `typing.Generator` type") + } + + fn infer_await_expression(&mut self, await_expression: &ast::ExprAwait) -> Type<'db> { + let ast::ExprAwait { range: _, value } = await_expression; + self.infer_expression(value); + todo_type!("generic `typing.Awaitable` type") + } + + /// Infer the type of a [`ast::ExprName`] expression, assuming a load context. + fn infer_name_load(&mut self, name_node: &ast::ExprName) -> Type<'db> { + let ast::ExprName { + range: _, + id: symbol_name, + ctx: _, + } = name_node; + + let db = self.db(); + let scope = self.scope(); + let file_scope_id = scope.file_scope_id(db); + let symbol_table = self.index.symbol_table(file_scope_id); + let use_def = self.index.use_def_map(file_scope_id); + + let mut constraint_keys = vec![]; + // Perform narrowing with applicable constraints between the current scope and the enclosing scope. + let narrow_with_applicable_constraints = |mut ty, constraint_keys: &[_]| { + for (enclosing_scope_file_id, constraint_key) in constraint_keys { + let use_def = self.index.use_def_map(*enclosing_scope_file_id); + let constraints = use_def.narrowing_constraints_at_use(*constraint_key); + let symbol_table = self.index.symbol_table(*enclosing_scope_file_id); + let symbol = symbol_table.symbol_id_by_name(symbol_name).unwrap(); + + ty = constraints.narrow(db, ty, symbol); + } + ty + }; + + // If we're inferring types of deferred expressions, always treat them as public symbols + let (local_scope_symbol, use_id) = if self.is_deferred() { + let symbol = if let Some(symbol_id) = symbol_table.symbol_id_by_name(symbol_name) { + symbol_from_bindings(db, use_def.public_bindings(symbol_id)) + } else { + assert!( + self.deferred_state.in_string_annotation(), + "Expected the symbol table to create a symbol for every Name node" + ); + Symbol::Unbound + }; + (symbol, None) + } else { + let use_id = name_node.scoped_use_id(db, scope); + let symbol = symbol_from_bindings(db, use_def.bindings_at_use(use_id)); + (symbol, Some(use_id)) + }; + + let symbol = SymbolAndQualifiers::from(local_scope_symbol).or_fall_back_to(db, || { + let has_bindings_in_this_scope = match symbol_table.symbol_by_name(symbol_name) { + Some(symbol) => symbol.is_bound(), + None => { + assert!( + self.deferred_state.in_string_annotation(), + "Expected the symbol table to create a symbol for every Name node" + ); + false + } + }; + + let current_file = self.file(); + + let skip_non_global_scopes = symbol_table + .symbol_id_by_name(symbol_name) + .is_some_and(|symbol_id| self.skip_non_global_scopes(file_scope_id, symbol_id)); + + if skip_non_global_scopes { + return global_symbol(self.db(), self.file(), symbol_name); + } + + // If it's a function-like scope and there is one or more binding in this scope (but + // none of those bindings are visible from where we are in the control flow), we cannot + // fallback to any bindings in enclosing scopes. As such, we can immediately short-circuit + // here and return `Symbol::Unbound`. + // + // This is because Python is very strict in its categorisation of whether a variable is + // a local variable or not in function-like scopes. If a variable has any bindings in a + // function-like scope, it is considered a local variable; it never references another + // scope. (At runtime, it would use the `LOAD_FAST` opcode.) + if has_bindings_in_this_scope && scope.is_function_like(db) { + return Symbol::Unbound.into(); + } + + if let Some(use_id) = use_id { + constraint_keys.push((file_scope_id, ConstraintKey::UseId(use_id))); + } + + // Walk up parent scopes looking for a possible enclosing scope that may have a + // definition of this name visible to us (would be `LOAD_DEREF` at runtime.) + // Note that we skip the scope containing the use that we are resolving, since we + // already looked for the symbol there up above. + for (enclosing_scope_file_id, _) in self.index.ancestor_scopes(file_scope_id).skip(1) { + // Class scopes are not visible to nested scopes, and we need to handle global + // scope differently (because an unbound name there falls back to builtins), so + // check only function-like scopes. + // There is one exception to this rule: type parameter scopes can see + // names defined in an immediately-enclosing class scope. + let enclosing_scope_id = enclosing_scope_file_id.to_scope_id(db, current_file); + + let is_immediately_enclosing_scope = scope.is_type_parameter(db) + && scope + .scope(db) + .parent() + .is_some_and(|parent| parent == enclosing_scope_file_id); + + // If the reference is in a nested eager scope, we need to look for the symbol at + // the point where the previous enclosing scope was defined, instead of at the end + // of the scope. (Note that the semantic index builder takes care of only + // registering eager bindings for nested scopes that are actually eager, and for + // enclosing scopes that actually contain bindings that we should use when + // resolving the reference.) + if !self.is_deferred() { + match self.index.eager_snapshot( + enclosing_scope_file_id, + symbol_name, + file_scope_id, + ) { + EagerSnapshotResult::FoundConstraint(constraint) => { + constraint_keys.push(( + enclosing_scope_file_id, + ConstraintKey::NarrowingConstraint(constraint), + )); + } + EagerSnapshotResult::FoundBindings(bindings) => { + if !enclosing_scope_id.is_function_like(db) + && !is_immediately_enclosing_scope + { + continue; + } + return symbol_from_bindings(db, bindings) + .map_type(|ty| { + narrow_with_applicable_constraints(ty, &constraint_keys) + }) + .into(); + } + // There are no visible bindings / constraint here. + // Don't fall back to non-eager symbol resolution. + EagerSnapshotResult::NotFound => { + continue; + } + EagerSnapshotResult::NoLongerInEagerContext => {} + } + } + + if !enclosing_scope_id.is_function_like(db) && !is_immediately_enclosing_scope { + continue; + } + + let enclosing_symbol_table = self.index.symbol_table(enclosing_scope_file_id); + let Some(enclosing_symbol) = enclosing_symbol_table.symbol_by_name(symbol_name) + else { + continue; + }; + if enclosing_symbol.is_bound() { + // We can return early here, because the nearest function-like scope that + // defines a name must be the only source for the nonlocal reference (at + // runtime, it is the scope that creates the cell for our closure.) If the name + // isn't bound in that scope, we should get an unbound name, not continue + // falling back to other scopes / globals / builtins. + return symbol(db, enclosing_scope_id, symbol_name) + .map_type(|ty| narrow_with_applicable_constraints(ty, &constraint_keys)); + } + } + + SymbolAndQualifiers::from(Symbol::Unbound) + // No nonlocal binding? Check the module's explicit globals. + // Avoid infinite recursion if `self.scope` already is the module's global scope. + .or_fall_back_to(db, || { + if file_scope_id.is_global() { + return Symbol::Unbound.into(); + } + + if !self.is_deferred() { + match self.index.eager_snapshot( + FileScopeId::global(), + symbol_name, + file_scope_id, + ) { + EagerSnapshotResult::FoundConstraint(constraint) => { + constraint_keys.push(( + FileScopeId::global(), + ConstraintKey::NarrowingConstraint(constraint), + )); + } + EagerSnapshotResult::FoundBindings(bindings) => { + return symbol_from_bindings(db, bindings) + .map_type(|ty| { + narrow_with_applicable_constraints(ty, &constraint_keys) + }) + .into(); + } + // There are no visible bindings / constraint here. + EagerSnapshotResult::NotFound => { + return Symbol::Unbound.into(); + } + EagerSnapshotResult::NoLongerInEagerContext => {} + } + } + + explicit_global_symbol(db, self.file(), symbol_name) + .map_type(|ty| narrow_with_applicable_constraints(ty, &constraint_keys)) + }) + // Not found in the module's explicitly declared global symbols? + // Check the "implicit globals" such as `__doc__`, `__file__`, `__name__`, etc. + // These are looked up as attributes on `types.ModuleType`. + .or_fall_back_to(db, || { + module_type_implicit_global_symbol(db, symbol_name) + .map_type(|ty| narrow_with_applicable_constraints(ty, &constraint_keys)) + }) + // Not found in globals? Fallback to builtins + // (without infinite recursion if we're already in builtins.) + .or_fall_back_to(db, || { + if Some(self.scope()) == builtins_module_scope(db) { + Symbol::Unbound.into() + } else { + builtins_symbol(db, symbol_name) + } + }) + // Still not found? It might be `reveal_type`... + .or_fall_back_to(db, || { + if symbol_name == "reveal_type" { + if let Some(builder) = + self.context.report_lint(&UNDEFINED_REVEAL, name_node) + { + let mut diag = + builder.into_diagnostic("`reveal_type` used without importing it"); + diag.info( + "This is allowed for debugging convenience but will fail at runtime" + ); + } + typing_extensions_symbol(db, symbol_name) + } else { + Symbol::Unbound.into() + } + }) + }); + + symbol + .unwrap_with_diagnostic(|lookup_error| match lookup_error { + LookupError::Unbound(qualifiers) => { + if self.is_reachable(name_node) { + report_unresolved_reference(&self.context, name_node); + } + TypeAndQualifiers::new(Type::unknown(), qualifiers) + } + LookupError::PossiblyUnbound(type_when_bound) => { + if self.is_reachable(name_node) { + report_possibly_unresolved_reference(&self.context, name_node); + } + type_when_bound + } + }) + .inner_type() + } + + fn infer_name_expression(&mut self, name: &ast::ExprName) -> Type<'db> { + match name.ctx { + ExprContext::Load => self.infer_name_load(name), + ExprContext::Store | ExprContext::Del => Type::Never, + ExprContext::Invalid => Type::unknown(), + } + } + + /// Infer the type of a [`ast::ExprAttribute`] expression, assuming a load context. + fn infer_attribute_load(&mut self, attribute: &ast::ExprAttribute) -> Type<'db> { + let ast::ExprAttribute { + value, + attr, + range: _, + ctx: _, + } = attribute; + + let value_type = if self.index.is_standalone_expression(&**value) { + self.infer_standalone_expression(value) + } else { + self.infer_expression(value) + }; + + let db = self.db(); + + value_type + .member(db, &attr.id) + .unwrap_with_diagnostic(|lookup_error| match lookup_error { + LookupError::Unbound(_) => { + let report_unresolved_attribute = self.is_reachable(attribute); + + if report_unresolved_attribute { + let bound_on_instance = match value_type { + Type::ClassLiteral(class) => { + !class.instance_member(db, None, attr).symbol.is_unbound() + } + Type::SubclassOf(subclass_of @ SubclassOfType { .. }) => { + match subclass_of.subclass_of() { + SubclassOfInner::Class(class) => { + !class.instance_member(db, attr).symbol.is_unbound() + } + SubclassOfInner::Dynamic(_) => unreachable!( + "Attribute lookup on a dynamic `SubclassOf` type should always return a bound symbol" + ), + } + } + _ => false, + }; + + if let Some(builder) = self + .context + .report_lint(&UNRESOLVED_ATTRIBUTE, attribute) + { + if bound_on_instance { + builder.into_diagnostic( + format_args!( + "Attribute `{}` can only be accessed on instances, \ + not on the class object `{}` itself.", + attr.id, + value_type.display(db) + ), + ); + } else { + builder.into_diagnostic( + format_args!( + "Type `{}` has no attribute `{}`", + value_type.display(db), + attr.id + ), + ); + } + } + } + + Type::unknown().into() + } + LookupError::PossiblyUnbound(type_when_bound) => { + report_possibly_unbound_attribute( + &self.context, + attribute, + &attr.id, + value_type, + ); + + type_when_bound + } + }).inner_type() + } + + fn infer_attribute_expression(&mut self, attribute: &ast::ExprAttribute) -> Type<'db> { + let ast::ExprAttribute { + value, + attr: _, + range: _, + ctx, + } = attribute; + + match ctx { + ExprContext::Load => self.infer_attribute_load(attribute), + ExprContext::Store | ExprContext::Del => { + self.infer_expression(value); + Type::Never + } + ExprContext::Invalid => { + self.infer_expression(value); + Type::unknown() + } + } + } + + fn infer_unary_expression(&mut self, unary: &ast::ExprUnaryOp) -> Type<'db> { + let ast::ExprUnaryOp { + range: _, + op, + operand, + } = unary; + + let operand_type = self.infer_expression(operand); + + match (op, operand_type) { + (_, Type::Dynamic(_)) => operand_type, + (_, Type::Never) => Type::Never, + + (ast::UnaryOp::UAdd, Type::IntLiteral(value)) => Type::IntLiteral(value), + (ast::UnaryOp::USub, Type::IntLiteral(value)) => Type::IntLiteral(-value), + (ast::UnaryOp::Invert, Type::IntLiteral(value)) => Type::IntLiteral(!value), + + (ast::UnaryOp::UAdd, Type::BooleanLiteral(bool)) => Type::IntLiteral(i64::from(bool)), + (ast::UnaryOp::USub, Type::BooleanLiteral(bool)) => Type::IntLiteral(-i64::from(bool)), + (ast::UnaryOp::Invert, Type::BooleanLiteral(bool)) => { + Type::IntLiteral(!i64::from(bool)) + } + + (ast::UnaryOp::Not, ty) => ty + .try_bool(self.db()) + .unwrap_or_else(|err| { + err.report_diagnostic(&self.context, unary); + err.fallback_truthiness() + }) + .negate() + .into_type(self.db()), + ( + op @ (ast::UnaryOp::UAdd | ast::UnaryOp::USub | ast::UnaryOp::Invert), + Type::FunctionLiteral(_) + | Type::Callable(..) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::BoundMethod(_) + | Type::ModuleLiteral(_) + | Type::ClassLiteral(_) + | Type::GenericAlias(_) + | Type::SubclassOf(_) + | Type::NominalInstance(_) + | Type::ProtocolInstance(_) + | Type::KnownInstance(_) + | Type::PropertyInstance(_) + | Type::Union(_) + | Type::Intersection(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::StringLiteral(_) + | Type::LiteralString + | Type::BytesLiteral(_) + | Type::Tuple(_) + | Type::BoundSuper(_) + | Type::TypeVar(_), + ) => { + let unary_dunder_method = match op { + ast::UnaryOp::Invert => "__invert__", + ast::UnaryOp::UAdd => "__pos__", + ast::UnaryOp::USub => "__neg__", + ast::UnaryOp::Not => { + unreachable!("Not operator is handled in its own case"); + } + }; + + match operand_type.try_call_dunder( + self.db(), + unary_dunder_method, + CallArgumentTypes::none(), + ) { + Ok(outcome) => outcome.return_type(self.db()), + Err(e) => { + if let Some(builder) = + self.context.report_lint(&UNSUPPORTED_OPERATOR, unary) + { + builder.into_diagnostic(format_args!( + "Unary operator `{op}` is unsupported for type `{}`", + operand_type.display(self.db()), + )); + } + e.fallback_return_type(self.db()) + } + } + } + } + } + + fn infer_binary_expression(&mut self, binary: &ast::ExprBinOp) -> Type<'db> { + let ast::ExprBinOp { + left, + op, + right, + range: _, + } = binary; + + let left_ty = self.infer_expression(left); + let right_ty = self.infer_expression(right); + + self.infer_binary_expression_type(binary.into(), false, left_ty, right_ty, *op) + .unwrap_or_else(|| { + let db = self.db(); + + if let Some(builder) = self.context.report_lint(&UNSUPPORTED_OPERATOR, binary) { + let mut diag = builder.into_diagnostic(format_args!( + "Operator `{op}` is unsupported between objects of type `{}` and `{}`", + left_ty.display(db), + right_ty.display(db) + )); + + if op == &ast::Operator::BitOr + && (left_ty.is_subtype_of(db, KnownClass::Type.to_instance(db)) + || right_ty.is_subtype_of(db, KnownClass::Type.to_instance(db))) + && Program::get(db).python_version(db) < PythonVersion::PY310 + { + diag.info( + "Note that `X | Y` PEP 604 union syntax is only available in Python 3.10 and later", + ); + diagnostic::add_inferred_python_version_hint(db, diag); + } + } + Type::unknown() + }) + } + + fn infer_binary_expression_type( + &mut self, + node: AnyNodeRef<'_>, + mut emitted_division_by_zero_diagnostic: bool, + left_ty: Type<'db>, + right_ty: Type<'db>, + op: ast::Operator, + ) -> Option<Type<'db>> { + // Check for division by zero; this doesn't change the inferred type for the expression, but + // may emit a diagnostic + if !emitted_division_by_zero_diagnostic + && matches!( + (op, right_ty), + ( + ast::Operator::Div | ast::Operator::FloorDiv | ast::Operator::Mod, + Type::IntLiteral(0) | Type::BooleanLiteral(false) + ) + ) + { + emitted_division_by_zero_diagnostic = self.check_division_by_zero(node, op, left_ty); + } + + match (left_ty, right_ty, op) { + (Type::Union(lhs_union), rhs, _) => { + let mut union = UnionBuilder::new(self.db()); + for lhs in lhs_union.elements(self.db()) { + let result = self.infer_binary_expression_type( + node, + emitted_division_by_zero_diagnostic, + *lhs, + rhs, + op, + )?; + union = union.add(result); + } + Some(union.build()) + } + (lhs, Type::Union(rhs_union), _) => { + let mut union = UnionBuilder::new(self.db()); + for rhs in rhs_union.elements(self.db()) { + let result = self.infer_binary_expression_type( + node, + emitted_division_by_zero_diagnostic, + lhs, + *rhs, + op, + )?; + union = union.add(result); + } + Some(union.build()) + } + + // Non-todo Anys take precedence over Todos (as if we fix this `Todo` in the future, + // the result would then become Any or Unknown, respectively). + (any @ Type::Dynamic(DynamicType::Any), _, _) + | (_, any @ Type::Dynamic(DynamicType::Any), _) => Some(any), + (unknown @ Type::Dynamic(DynamicType::Unknown), _, _) + | (_, unknown @ Type::Dynamic(DynamicType::Unknown), _) => Some(unknown), + ( + todo @ Type::Dynamic(DynamicType::Todo(_) | DynamicType::TodoPEP695ParamSpec), + _, + _, + ) + | ( + _, + todo @ Type::Dynamic(DynamicType::Todo(_) | DynamicType::TodoPEP695ParamSpec), + _, + ) => Some(todo), + (Type::Never, _, _) | (_, Type::Never, _) => Some(Type::Never), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Add) => Some( + n.checked_add(m) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())), + ), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Sub) => Some( + n.checked_sub(m) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())), + ), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Mult) => Some( + n.checked_mul(m) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())), + ), + + (Type::IntLiteral(_), Type::IntLiteral(_), ast::Operator::Div) => { + Some(KnownClass::Float.to_instance(self.db())) + } + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::FloorDiv) => Some( + n.checked_div(m) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())), + ), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Mod) => Some( + n.checked_rem(m) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())), + ), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::Pow) => Some({ + if m < 0 { + KnownClass::Float.to_instance(self.db()) + } else { + u32::try_from(m) + .ok() + .and_then(|m| n.checked_pow(m)) + .map(Type::IntLiteral) + .unwrap_or_else(|| KnownClass::Int.to_instance(self.db())) + } + }), + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::BitOr) => { + Some(Type::IntLiteral(n | m)) + } + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::BitAnd) => { + Some(Type::IntLiteral(n & m)) + } + + (Type::IntLiteral(n), Type::IntLiteral(m), ast::Operator::BitXor) => { + Some(Type::IntLiteral(n ^ m)) + } + + (Type::BytesLiteral(lhs), Type::BytesLiteral(rhs), ast::Operator::Add) => { + let bytes = [lhs.value(self.db()), rhs.value(self.db())].concat(); + Some(Type::bytes_literal(self.db(), &bytes)) + } + + (Type::StringLiteral(lhs), Type::StringLiteral(rhs), ast::Operator::Add) => { + let lhs_value = lhs.value(self.db()).to_string(); + let rhs_value = rhs.value(self.db()); + let ty = if lhs_value.len() + rhs_value.len() <= Self::MAX_STRING_LITERAL_SIZE { + Type::string_literal(self.db(), &(lhs_value + rhs_value)) + } else { + Type::LiteralString + }; + Some(ty) + } + + ( + Type::StringLiteral(_) | Type::LiteralString, + Type::StringLiteral(_) | Type::LiteralString, + ast::Operator::Add, + ) => Some(Type::LiteralString), + + (Type::StringLiteral(s), Type::IntLiteral(n), ast::Operator::Mult) + | (Type::IntLiteral(n), Type::StringLiteral(s), ast::Operator::Mult) => { + let ty = if n < 1 { + Type::string_literal(self.db(), "") + } else if let Ok(n) = usize::try_from(n) { + if n.checked_mul(s.value(self.db()).len()) + .is_some_and(|new_length| new_length <= Self::MAX_STRING_LITERAL_SIZE) + { + let new_literal = s.value(self.db()).repeat(n); + Type::string_literal(self.db(), &new_literal) + } else { + Type::LiteralString + } + } else { + Type::LiteralString + }; + Some(ty) + } + + (Type::LiteralString, Type::IntLiteral(n), ast::Operator::Mult) + | (Type::IntLiteral(n), Type::LiteralString, ast::Operator::Mult) => { + let ty = if n < 1 { + Type::string_literal(self.db(), "") + } else { + Type::LiteralString + }; + Some(ty) + } + + (Type::BooleanLiteral(b1), Type::BooleanLiteral(b2), ast::Operator::BitOr) => { + Some(Type::BooleanLiteral(b1 | b2)) + } + + (Type::BooleanLiteral(b1), Type::BooleanLiteral(b2), ast::Operator::BitAnd) => { + Some(Type::BooleanLiteral(b1 & b2)) + } + + (Type::BooleanLiteral(b1), Type::BooleanLiteral(b2), ast::Operator::BitXor) => { + Some(Type::BooleanLiteral(b1 ^ b2)) + } + + (Type::BooleanLiteral(bool_value), right, op) => self.infer_binary_expression_type( + node, + emitted_division_by_zero_diagnostic, + Type::IntLiteral(i64::from(bool_value)), + right, + op, + ), + (left, Type::BooleanLiteral(bool_value), op) => self.infer_binary_expression_type( + node, + emitted_division_by_zero_diagnostic, + left, + Type::IntLiteral(i64::from(bool_value)), + op, + ), + + (Type::Tuple(lhs), Type::Tuple(rhs), ast::Operator::Add) => { + // Note: this only works on heterogeneous tuples. + let lhs_elements = lhs.elements(self.db()); + let rhs_elements = rhs.elements(self.db()); + + Some(TupleType::from_elements( + self.db(), + lhs_elements + .iter() + .copied() + .chain(rhs_elements.iter().copied()), + )) + } + + // We've handled all of the special cases that we support for literals, so we need to + // fall back on looking for dunder methods on one of the operand types. + ( + Type::FunctionLiteral(_) + | Type::Callable(..) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::ClassLiteral(_) + | Type::GenericAlias(_) + | Type::SubclassOf(_) + | Type::NominalInstance(_) + | Type::ProtocolInstance(_) + | Type::KnownInstance(_) + | Type::PropertyInstance(_) + | Type::Intersection(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::LiteralString + | Type::BytesLiteral(_) + | Type::Tuple(_) + | Type::BoundSuper(_) + | Type::TypeVar(_), + Type::FunctionLiteral(_) + | Type::Callable(..) + | Type::BoundMethod(_) + | Type::WrapperDescriptor(_) + | Type::MethodWrapper(_) + | Type::DataclassDecorator(_) + | Type::DataclassTransformer(_) + | Type::ModuleLiteral(_) + | Type::ClassLiteral(_) + | Type::GenericAlias(_) + | Type::SubclassOf(_) + | Type::NominalInstance(_) + | Type::ProtocolInstance(_) + | Type::KnownInstance(_) + | Type::PropertyInstance(_) + | Type::Intersection(_) + | Type::AlwaysTruthy + | Type::AlwaysFalsy + | Type::IntLiteral(_) + | Type::StringLiteral(_) + | Type::LiteralString + | Type::BytesLiteral(_) + | Type::Tuple(_) + | Type::BoundSuper(_) + | Type::TypeVar(_), + op, + ) => { + // We either want to call lhs.__op__ or rhs.__rop__. The full decision tree from + // the Python spec [1] is: + // + // - If rhs is a (proper) subclass of lhs, and it provides a different + // implementation of __rop__, use that. + // - Otherwise, if lhs implements __op__, use that. + // - Otherwise, if lhs and rhs are different types, and rhs implements __rop__, + // use that. + // + // [1] https://docs.python.org/3/reference/datamodel.html#object.__radd__ + + // Technically we don't have to check left_ty != right_ty here, since if the types + // are the same, they will trivially have the same implementation of the reflected + // dunder, and so we'll fail the inner check. But the type equality check will be + // faster for the common case, and allow us to skip the (two) class member lookups. + let left_class = left_ty.to_meta_type(self.db()); + let right_class = right_ty.to_meta_type(self.db()); + if left_ty != right_ty && right_ty.is_subtype_of(self.db(), left_ty) { + let reflected_dunder = op.reflected_dunder(); + let rhs_reflected = right_class.member(self.db(), reflected_dunder).symbol; + // TODO: if `rhs_reflected` is possibly unbound, we should union the two possible + // Bindings together + if !rhs_reflected.is_unbound() + && rhs_reflected != left_class.member(self.db(), reflected_dunder).symbol + { + return right_ty + .try_call_dunder( + self.db(), + reflected_dunder, + CallArgumentTypes::positional([left_ty]), + ) + .map(|outcome| outcome.return_type(self.db())) + .or_else(|_| { + left_ty + .try_call_dunder( + self.db(), + op.dunder(), + CallArgumentTypes::positional([right_ty]), + ) + .map(|outcome| outcome.return_type(self.db())) + }) + .ok(); + } + } + + let call_on_left_instance = left_ty + .try_call_dunder( + self.db(), + op.dunder(), + CallArgumentTypes::positional([right_ty]), + ) + .map(|outcome| outcome.return_type(self.db())) + .ok(); + + call_on_left_instance.or_else(|| { + if left_ty == right_ty { + None + } else { + right_ty + .try_call_dunder( + self.db(), + op.reflected_dunder(), + CallArgumentTypes::positional([left_ty]), + ) + .map(|outcome| outcome.return_type(self.db())) + .ok() + } + }) + } + } + } + + fn infer_boolean_expression(&mut self, bool_op: &ast::ExprBoolOp) -> Type<'db> { + let ast::ExprBoolOp { + range: _, + op, + values, + } = bool_op; + self.infer_chained_boolean_types( + *op, + values.iter().enumerate(), + |builder, (index, value)| { + let ty = if index == values.len() - 1 { + builder.infer_expression(value) + } else { + builder.infer_standalone_expression(value) + }; + + (ty, value.range()) + }, + ) + } + + /// Computes the output of a chain of (one) boolean operation, consuming as input an iterator + /// of operations and calling the `infer_ty` for each to infer their types. + /// The iterator is consumed even if the boolean evaluation can be short-circuited, + /// in order to ensure the invariant that all expressions are evaluated when inferring types. + fn infer_chained_boolean_types<Iterator, Item, F>( + &mut self, + op: ast::BoolOp, + operations: Iterator, + infer_ty: F, + ) -> Type<'db> + where + Iterator: IntoIterator<Item = Item>, + F: Fn(&mut Self, Item) -> (Type<'db>, TextRange), + { + let mut done = false; + let db = self.db(); + + let elements = operations + .into_iter() + .with_position() + .map(|(position, item)| { + let (ty, range) = infer_ty(self, item); + + let is_last = matches!( + position, + itertools::Position::Last | itertools::Position::Only + ); + + if is_last { + if done { Type::Never } else { ty } + } else { + let truthiness = ty.try_bool(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, range); + err.fallback_truthiness() + }); + + if done { + return Type::Never; + } + + match (truthiness, op) { + (Truthiness::AlwaysTrue, ast::BoolOp::And) => Type::Never, + (Truthiness::AlwaysFalse, ast::BoolOp::Or) => Type::Never, + + (Truthiness::AlwaysFalse, ast::BoolOp::And) + | (Truthiness::AlwaysTrue, ast::BoolOp::Or) => { + done = true; + ty + } + + (Truthiness::Ambiguous, _) => IntersectionBuilder::new(db) + .add_positive(ty) + .add_negative(match op { + ast::BoolOp::And => Type::AlwaysTruthy, + ast::BoolOp::Or => Type::AlwaysFalsy, + }) + .build(), + } + } + }); + + UnionType::from_elements(db, elements) + } + + fn infer_compare_expression(&mut self, compare: &ast::ExprCompare) -> Type<'db> { + let ast::ExprCompare { + range: _, + left, + ops, + comparators, + } = compare; + + self.infer_expression(left); + + // https://docs.python.org/3/reference/expressions.html#comparisons + // > Formally, if `a, b, c, …, y, z` are expressions and `op1, op2, …, opN` are comparison + // > operators, then `a op1 b op2 c ... y opN z` is equivalent to `a op1 b and b op2 c and + // ... > y opN z`, except that each expression is evaluated at most once. + // + // As some operators (==, !=, <, <=, >, >=) *can* return an arbitrary type, the logic below + // is shared with the one in `infer_binary_type_comparison`. + self.infer_chained_boolean_types( + ast::BoolOp::And, + std::iter::once(&**left) + .chain(comparators) + .tuple_windows::<(_, _)>() + .zip(ops), + |builder, ((left, right), op)| { + let left_ty = builder.expression_type(left); + let right_ty = builder.infer_expression(right); + + let range = TextRange::new(left.start(), right.end()); + + let ty = builder + .infer_binary_type_comparison(left_ty, *op, right_ty, range) + .unwrap_or_else(|error| { + if let Some(diagnostic_builder) = + builder.context.report_lint(&UNSUPPORTED_OPERATOR, range) + { + // Handle unsupported operators (diagnostic, `bool`/`Unknown` outcome) + diagnostic_builder.into_diagnostic(format_args!( + "Operator `{}` is not supported for types `{}` and `{}`{}", + error.op, + error.left_ty.display(builder.db()), + error.right_ty.display(builder.db()), + if (left_ty, right_ty) == (error.left_ty, error.right_ty) { + String::new() + } else { + format!( + ", in comparing `{}` with `{}`", + left_ty.display(builder.db()), + right_ty.display(builder.db()) + ) + } + )); + } + + match op { + // `in, not in, is, is not` always return bool instances + ast::CmpOp::In + | ast::CmpOp::NotIn + | ast::CmpOp::Is + | ast::CmpOp::IsNot => KnownClass::Bool.to_instance(builder.db()), + // Other operators can return arbitrary types + _ => Type::unknown(), + } + }); + + (ty, range) + }, + ) + } + + fn infer_binary_intersection_type_comparison( + &mut self, + intersection: IntersectionType<'db>, + op: ast::CmpOp, + other: Type<'db>, + intersection_on: IntersectionOn, + range: TextRange, + ) -> Result<Type<'db>, CompareUnsupportedError<'db>> { + // If a comparison yields a definitive true/false answer on a (positive) part + // of an intersection type, it will also yield a definitive answer on the full + // intersection type, which is even more specific. + for pos in intersection.positive(self.db()) { + let result = match intersection_on { + IntersectionOn::Left => { + self.infer_binary_type_comparison(*pos, op, other, range)? + } + IntersectionOn::Right => { + self.infer_binary_type_comparison(other, op, *pos, range)? + } + }; + if let Type::BooleanLiteral(b) = result { + return Ok(Type::BooleanLiteral(b)); + } + } + + // For negative contributions to the intersection type, there are only a few + // special cases that allow us to narrow down the result type of the comparison. + for neg in intersection.negative(self.db()) { + let result = match intersection_on { + IntersectionOn::Left => self + .infer_binary_type_comparison(*neg, op, other, range) + .ok(), + IntersectionOn::Right => self + .infer_binary_type_comparison(other, op, *neg, range) + .ok(), + }; + + match (op, result) { + (ast::CmpOp::Is, Some(Type::BooleanLiteral(true))) => { + return Ok(Type::BooleanLiteral(false)); + } + (ast::CmpOp::IsNot, Some(Type::BooleanLiteral(false))) => { + return Ok(Type::BooleanLiteral(true)); + } + _ => {} + } + } + + // If none of the simplifications above apply, we still need to return *some* + // result type for the comparison 'T_inter `op` T_other' (or reversed), where + // + // T_inter = P1 & P2 & ... & Pn & ~N1 & ~N2 & ... & ~Nm + // + // is the intersection type. If f(T) is the function that computes the result + // type of a `op`-comparison with `T_other`, we are interested in f(T_inter). + // Since we can't compute it exactly, we return the following approximation: + // + // f(T_inter) = f(P1) & f(P2) & ... & f(Pn) + // + // The reason for this is the following: In general, for any function 'f', the + // set f(A) & f(B) is *larger than or equal to* the set f(A & B). This means + // that we will return a type that is possibly wider than it could be, but + // never wrong. + // + // However, we do have to leave out the negative contributions. If we were to + // add a contribution like ~f(N1), we would potentially infer result types + // that are too narrow. + // + // As an example for this, consider the intersection type `int & ~Literal[1]`. + // If 'f' would be the `==`-comparison with 2, we obviously can't tell if that + // answer would be true or false, so we need to return `bool`. And indeed, we + // we have (glossing over notational details): + // + // f(int & ~1) + // = f({..., -1, 0, 2, 3, ...}) + // = {..., False, False, True, False, ...} + // = bool + // + // On the other hand, if we were to compute + // + // f(int) & ~f(1) + // = bool & ~False + // = True + // + // we would get a result type `Literal[True]` which is too narrow. + // + let mut builder = IntersectionBuilder::new(self.db()); + + builder = builder.add_positive(KnownClass::Bool.to_instance(self.db())); + + for pos in intersection.positive(self.db()) { + let result = match intersection_on { + IntersectionOn::Left => { + self.infer_binary_type_comparison(*pos, op, other, range)? + } + IntersectionOn::Right => { + self.infer_binary_type_comparison(other, op, *pos, range)? + } + }; + builder = builder.add_positive(result); + } + + Ok(builder.build()) + } + + /// Infers the type of a binary comparison (e.g. 'left == right'). See + /// `infer_compare_expression` for the higher level logic dealing with multi-comparison + /// expressions. + /// + /// If the operation is not supported, return None (we need upstream context to emit a + /// diagnostic). + fn infer_binary_type_comparison( + &mut self, + left: Type<'db>, + op: ast::CmpOp, + right: Type<'db>, + range: TextRange, + ) -> Result<Type<'db>, CompareUnsupportedError<'db>> { + // Note: identity (is, is not) for equal builtin types is unreliable and not part of the + // language spec. + // - `[ast::CompOp::Is]`: return `false` if unequal, `bool` if equal + // - `[ast::CompOp::IsNot]`: return `true` if unequal, `bool` if equal + match (left, right) { + (Type::Union(union), other) => { + let mut builder = UnionBuilder::new(self.db()); + for element in union.elements(self.db()) { + builder = + builder.add(self.infer_binary_type_comparison(*element, op, other, range)?); + } + Ok(builder.build()) + } + (other, Type::Union(union)) => { + let mut builder = UnionBuilder::new(self.db()); + for element in union.elements(self.db()) { + builder = + builder.add(self.infer_binary_type_comparison(other, op, *element, range)?); + } + Ok(builder.build()) + } + + (Type::Intersection(intersection), right) => self + .infer_binary_intersection_type_comparison( + intersection, + op, + right, + IntersectionOn::Left, + range, + ), + (left, Type::Intersection(intersection)) => self + .infer_binary_intersection_type_comparison( + intersection, + op, + left, + IntersectionOn::Right, + range, + ), + + (Type::IntLiteral(n), Type::IntLiteral(m)) => match op { + ast::CmpOp::Eq => Ok(Type::BooleanLiteral(n == m)), + ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(n != m)), + ast::CmpOp::Lt => Ok(Type::BooleanLiteral(n < m)), + ast::CmpOp::LtE => Ok(Type::BooleanLiteral(n <= m)), + ast::CmpOp::Gt => Ok(Type::BooleanLiteral(n > m)), + ast::CmpOp::GtE => Ok(Type::BooleanLiteral(n >= m)), + // We cannot say that two equal int Literals will return True from an `is` or `is not` comparison. + // Even if they are the same value, they may not be the same object. + ast::CmpOp::Is => { + if n == m { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(false)) + } + } + ast::CmpOp::IsNot => { + if n == m { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(true)) + } + } + // Undefined for (int, int) + ast::CmpOp::In | ast::CmpOp::NotIn => Err(CompareUnsupportedError { + op, + left_ty: left, + right_ty: right, + }), + }, + (Type::IntLiteral(_), Type::NominalInstance(_)) => self.infer_binary_type_comparison( + KnownClass::Int.to_instance(self.db()), + op, + right, + range, + ), + (Type::NominalInstance(_), Type::IntLiteral(_)) => self.infer_binary_type_comparison( + left, + op, + KnownClass::Int.to_instance(self.db()), + range, + ), + + // Booleans are coded as integers (False = 0, True = 1) + (Type::IntLiteral(n), Type::BooleanLiteral(b)) => self.infer_binary_type_comparison( + Type::IntLiteral(n), + op, + Type::IntLiteral(i64::from(b)), + range, + ), + (Type::BooleanLiteral(b), Type::IntLiteral(m)) => self.infer_binary_type_comparison( + Type::IntLiteral(i64::from(b)), + op, + Type::IntLiteral(m), + range, + ), + (Type::BooleanLiteral(a), Type::BooleanLiteral(b)) => self + .infer_binary_type_comparison( + Type::IntLiteral(i64::from(a)), + op, + Type::IntLiteral(i64::from(b)), + range, + ), + + (Type::StringLiteral(salsa_s1), Type::StringLiteral(salsa_s2)) => { + let s1 = salsa_s1.value(self.db()); + let s2 = salsa_s2.value(self.db()); + match op { + ast::CmpOp::Eq => Ok(Type::BooleanLiteral(s1 == s2)), + ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(s1 != s2)), + ast::CmpOp::Lt => Ok(Type::BooleanLiteral(s1 < s2)), + ast::CmpOp::LtE => Ok(Type::BooleanLiteral(s1 <= s2)), + ast::CmpOp::Gt => Ok(Type::BooleanLiteral(s1 > s2)), + ast::CmpOp::GtE => Ok(Type::BooleanLiteral(s1 >= s2)), + ast::CmpOp::In => Ok(Type::BooleanLiteral(s2.contains(s1))), + ast::CmpOp::NotIn => Ok(Type::BooleanLiteral(!s2.contains(s1))), + ast::CmpOp::Is => { + if s1 == s2 { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(false)) + } + } + ast::CmpOp::IsNot => { + if s1 == s2 { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(true)) + } + } + } + } + (Type::StringLiteral(_), _) => self.infer_binary_type_comparison( + KnownClass::Str.to_instance(self.db()), + op, + right, + range, + ), + (_, Type::StringLiteral(_)) => self.infer_binary_type_comparison( + left, + op, + KnownClass::Str.to_instance(self.db()), + range, + ), + + (Type::LiteralString, _) => self.infer_binary_type_comparison( + KnownClass::Str.to_instance(self.db()), + op, + right, + range, + ), + (_, Type::LiteralString) => self.infer_binary_type_comparison( + left, + op, + KnownClass::Str.to_instance(self.db()), + range, + ), + + (Type::BytesLiteral(salsa_b1), Type::BytesLiteral(salsa_b2)) => { + let b1 = salsa_b1.value(self.db()); + let b2 = salsa_b2.value(self.db()); + match op { + ast::CmpOp::Eq => Ok(Type::BooleanLiteral(b1 == b2)), + ast::CmpOp::NotEq => Ok(Type::BooleanLiteral(b1 != b2)), + ast::CmpOp::Lt => Ok(Type::BooleanLiteral(b1 < b2)), + ast::CmpOp::LtE => Ok(Type::BooleanLiteral(b1 <= b2)), + ast::CmpOp::Gt => Ok(Type::BooleanLiteral(b1 > b2)), + ast::CmpOp::GtE => Ok(Type::BooleanLiteral(b1 >= b2)), + ast::CmpOp::In => { + Ok(Type::BooleanLiteral(memchr::memmem::find(b2, b1).is_some())) + } + ast::CmpOp::NotIn => { + Ok(Type::BooleanLiteral(memchr::memmem::find(b2, b1).is_none())) + } + ast::CmpOp::Is => { + if b1 == b2 { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(false)) + } + } + ast::CmpOp::IsNot => { + if b1 == b2 { + Ok(KnownClass::Bool.to_instance(self.db())) + } else { + Ok(Type::BooleanLiteral(true)) + } + } + } + } + (Type::BytesLiteral(_), _) => self.infer_binary_type_comparison( + KnownClass::Bytes.to_instance(self.db()), + op, + right, + range, + ), + (_, Type::BytesLiteral(_)) => self.infer_binary_type_comparison( + left, + op, + KnownClass::Bytes.to_instance(self.db()), + range, + ), + (Type::Tuple(_), Type::NominalInstance(instance)) + if instance.class.is_known(self.db(), KnownClass::VersionInfo) => + { + self.infer_binary_type_comparison( + left, + op, + Type::version_info_tuple(self.db()), + range, + ) + } + (Type::NominalInstance(instance), Type::Tuple(_)) + if instance.class.is_known(self.db(), KnownClass::VersionInfo) => + { + self.infer_binary_type_comparison( + Type::version_info_tuple(self.db()), + op, + right, + range, + ) + } + (Type::Tuple(lhs), Type::Tuple(rhs)) => { + // Note: This only works on heterogeneous tuple types. + let lhs_elements = lhs.elements(self.db()); + let rhs_elements = rhs.elements(self.db()); + + let mut tuple_rich_comparison = + |op| self.infer_tuple_rich_comparison(lhs_elements, op, rhs_elements, range); + + match op { + ast::CmpOp::Eq => tuple_rich_comparison(RichCompareOperator::Eq), + ast::CmpOp::NotEq => tuple_rich_comparison(RichCompareOperator::Ne), + ast::CmpOp::Lt => tuple_rich_comparison(RichCompareOperator::Lt), + ast::CmpOp::LtE => tuple_rich_comparison(RichCompareOperator::Le), + ast::CmpOp::Gt => tuple_rich_comparison(RichCompareOperator::Gt), + ast::CmpOp::GtE => tuple_rich_comparison(RichCompareOperator::Ge), + ast::CmpOp::In | ast::CmpOp::NotIn => { + let mut eq_count = 0usize; + let mut not_eq_count = 0usize; + + for ty in rhs_elements { + let eq_result = self.infer_binary_type_comparison( + Type::Tuple(lhs), + ast::CmpOp::Eq, + *ty, + range, + ).expect("infer_binary_type_comparison should never return None for `CmpOp::Eq`"); + + match eq_result { + todo @ Type::Dynamic(DynamicType::Todo(_)) => return Ok(todo), + // It's okay to ignore errors here because Python doesn't call `__bool__` + // for different union variants. Instead, this is just for us to + // evaluate a possibly truthy value to `false` or `true`. + ty => match ty.bool(self.db()) { + Truthiness::AlwaysTrue => eq_count += 1, + Truthiness::AlwaysFalse => not_eq_count += 1, + Truthiness::Ambiguous => (), + }, + } + } + + if eq_count >= 1 { + Ok(Type::BooleanLiteral(op.is_in())) + } else if not_eq_count == rhs_elements.len() { + Ok(Type::BooleanLiteral(op.is_not_in())) + } else { + Ok(KnownClass::Bool.to_instance(self.db())) + } + } + ast::CmpOp::Is | ast::CmpOp::IsNot => { + // - `[ast::CmpOp::Is]`: returns `false` if the elements are definitely unequal, otherwise `bool` + // - `[ast::CmpOp::IsNot]`: returns `true` if the elements are definitely unequal, otherwise `bool` + let eq_result = tuple_rich_comparison(RichCompareOperator::Eq).expect( + "infer_binary_type_comparison should never return None for `CmpOp::Eq`", + ); + + Ok(match eq_result { + todo @ Type::Dynamic(DynamicType::Todo(_)) => todo, + // It's okay to ignore errors here because Python doesn't call `__bool__` + // for `is` and `is not` comparisons. This is an implementation detail + // for how we determine the truthiness of a type. + ty => match ty.bool(self.db()) { + Truthiness::AlwaysFalse => Type::BooleanLiteral(op.is_is_not()), + _ => KnownClass::Bool.to_instance(self.db()), + }, + }) + } + } + } + + // Lookup the rich comparison `__dunder__` methods + _ => { + let rich_comparison = |op| self.infer_rich_comparison(left, right, op); + let membership_test_comparison = |op, range: TextRange| { + self.infer_membership_test_comparison(left, right, op, range) + }; + match op { + ast::CmpOp::Eq => rich_comparison(RichCompareOperator::Eq), + ast::CmpOp::NotEq => rich_comparison(RichCompareOperator::Ne), + ast::CmpOp::Lt => rich_comparison(RichCompareOperator::Lt), + ast::CmpOp::LtE => rich_comparison(RichCompareOperator::Le), + ast::CmpOp::Gt => rich_comparison(RichCompareOperator::Gt), + ast::CmpOp::GtE => rich_comparison(RichCompareOperator::Ge), + ast::CmpOp::In => { + membership_test_comparison(MembershipTestCompareOperator::In, range) + } + ast::CmpOp::NotIn => { + membership_test_comparison(MembershipTestCompareOperator::NotIn, range) + } + ast::CmpOp::Is => { + if left.is_disjoint_from(self.db(), right) { + Ok(Type::BooleanLiteral(false)) + } else if left.is_singleton(self.db()) + && left.is_equivalent_to(self.db(), right) + { + Ok(Type::BooleanLiteral(true)) + } else { + Ok(KnownClass::Bool.to_instance(self.db())) + } + } + ast::CmpOp::IsNot => { + if left.is_disjoint_from(self.db(), right) { + Ok(Type::BooleanLiteral(true)) + } else if left.is_singleton(self.db()) + && left.is_equivalent_to(self.db(), right) + { + Ok(Type::BooleanLiteral(false)) + } else { + Ok(KnownClass::Bool.to_instance(self.db())) + } + } + } + } + } + } + + /// Rich comparison in Python are the operators `==`, `!=`, `<`, `<=`, `>`, and `>=`. Their + /// behaviour can be edited for classes by implementing corresponding dunder methods. + /// This function performs rich comparison between two types and returns the resulting type. + /// see `<https://docs.python.org/3/reference/datamodel.html#object.__lt__>` + fn infer_rich_comparison( + &self, + left: Type<'db>, + right: Type<'db>, + op: RichCompareOperator, + ) -> Result<Type<'db>, CompareUnsupportedError<'db>> { + let db = self.db(); + // The following resource has details about the rich comparison algorithm: + // https://snarky.ca/unravelling-rich-comparison-operators/ + let call_dunder = |op: RichCompareOperator, left: Type<'db>, right: Type<'db>| { + left.try_call_dunder(db, op.dunder(), CallArgumentTypes::positional([right])) + .map(|outcome| outcome.return_type(db)) + .ok() + }; + + // The reflected dunder has priority if the right-hand side is a strict subclass of the left-hand side. + if left != right && right.is_subtype_of(db, left) { + call_dunder(op.reflect(), right, left).or_else(|| call_dunder(op, left, right)) + } else { + call_dunder(op, left, right).or_else(|| call_dunder(op.reflect(), right, left)) + } + .or_else(|| { + // When no appropriate method returns any value other than NotImplemented, + // the `==` and `!=` operators will fall back to `is` and `is not`, respectively. + // refer to `<https://docs.python.org/3/reference/datamodel.html#object.__eq__>` + if matches!(op, RichCompareOperator::Eq | RichCompareOperator::Ne) { + Some(KnownClass::Bool.to_instance(db)) + } else { + None + } + }) + .ok_or_else(|| CompareUnsupportedError { + op: op.into(), + left_ty: left, + right_ty: right, + }) + } + + /// Performs a membership test (`in` and `not in`) between two instances and returns the resulting type, or `None` if the test is unsupported. + /// The behavior can be customized in Python by implementing `__contains__`, `__iter__`, or `__getitem__` methods. + /// See `<https://docs.python.org/3/reference/datamodel.html#object.__contains__>` + /// and `<https://docs.python.org/3/reference/expressions.html#membership-test-details>` + fn infer_membership_test_comparison( + &self, + left: Type<'db>, + right: Type<'db>, + op: MembershipTestCompareOperator, + range: TextRange, + ) -> Result<Type<'db>, CompareUnsupportedError<'db>> { + let db = self.db(); + + let contains_dunder = right.class_member(db, "__contains__".into()).symbol; + let compare_result_opt = match contains_dunder { + Symbol::Type(contains_dunder, Boundness::Bound) => { + // If `__contains__` is available, it is used directly for the membership test. + contains_dunder + .try_call(db, &CallArgumentTypes::positional([right, left])) + .map(|bindings| bindings.return_type(db)) + .ok() + } + _ => { + // iteration-based membership test + right + .try_iterate(db) + .map(|_| KnownClass::Bool.to_instance(db)) + .ok() + } + }; + + compare_result_opt + .map(|ty| { + if matches!(ty, Type::Dynamic(DynamicType::Todo(_))) { + return ty; + } + + let truthiness = ty.try_bool(db).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, range); + err.fallback_truthiness() + }); + + match op { + MembershipTestCompareOperator::In => truthiness.into_type(db), + MembershipTestCompareOperator::NotIn => truthiness.negate().into_type(db), + } + }) + .ok_or_else(|| CompareUnsupportedError { + op: op.into(), + left_ty: left, + right_ty: right, + }) + } + + /// Simulates rich comparison between tuples and returns the inferred result. + /// This performs a lexicographic comparison, returning a union of all possible return types that could result from the comparison. + /// + /// basically it's based on cpython's `tuple_richcompare` + /// see `<https://github.com/python/cpython/blob/9d6366b60d01305fc5e45100e0cd13e358aa397d/Objects/tupleobject.c#L637>` + fn infer_tuple_rich_comparison( + &mut self, + left: &[Type<'db>], + op: RichCompareOperator, + right: &[Type<'db>], + range: TextRange, + ) -> Result<Type<'db>, CompareUnsupportedError<'db>> { + let left_iter = left.iter().copied(); + let right_iter = right.iter().copied(); + + let mut builder = UnionBuilder::new(self.db()); + + for (l_ty, r_ty) in left_iter.zip(right_iter) { + let pairwise_eq_result = self + .infer_binary_type_comparison(l_ty, ast::CmpOp::Eq, r_ty, range) + .expect("infer_binary_type_comparison should never return None for `CmpOp::Eq`"); + + match pairwise_eq_result + .try_bool(self.db()) + .unwrap_or_else(|err| { + // TODO: We should, whenever possible, pass the range of the left and right elements + // instead of the range of the whole tuple. + err.report_diagnostic(&self.context, range); + err.fallback_truthiness() + }) { + // - AlwaysTrue : Continue to the next pair for lexicographic comparison + Truthiness::AlwaysTrue => continue, + // - AlwaysFalse: + // Lexicographic comparisons will always terminate with this pair. + // Complete the comparison and return the result. + // - Ambiguous: + // Lexicographic comparisons might continue to the next pair (if eq_result is true), + // or terminate here (if eq_result is false). + // To account for cases where the comparison terminates here, add the pairwise comparison result to the union builder. + eq_truthiness @ (Truthiness::AlwaysFalse | Truthiness::Ambiguous) => { + let pairwise_compare_result = match op { + RichCompareOperator::Lt + | RichCompareOperator::Le + | RichCompareOperator::Gt + | RichCompareOperator::Ge => { + self.infer_binary_type_comparison(l_ty, op.into(), r_ty, range)? + } + // For `==` and `!=`, we already figure out the result from `pairwise_eq_result` + // NOTE: The CPython implementation does not account for non-boolean return types + // or cases where `!=` is not the negation of `==`, we also do not consider these cases. + RichCompareOperator::Eq => Type::BooleanLiteral(false), + RichCompareOperator::Ne => Type::BooleanLiteral(true), + }; + + builder = builder.add(pairwise_compare_result); + + if eq_truthiness.is_ambiguous() { + continue; + } + + return Ok(builder.build()); + } + } + } + + // if no more items to compare, we just compare sizes + let (left_len, right_len) = (left.len(), right.len()); + + builder = builder.add(Type::BooleanLiteral(match op { + RichCompareOperator::Eq => left_len == right_len, + RichCompareOperator::Ne => left_len != right_len, + RichCompareOperator::Lt => left_len < right_len, + RichCompareOperator::Le => left_len <= right_len, + RichCompareOperator::Gt => left_len > right_len, + RichCompareOperator::Ge => left_len >= right_len, + })); + + Ok(builder.build()) + } + + fn infer_subscript_expression(&mut self, subscript: &ast::ExprSubscript) -> Type<'db> { + let ast::ExprSubscript { + range: _, + value, + slice, + ctx: _, + } = subscript; + + // HACK ALERT: If we are subscripting a generic class, short-circuit the rest of the + // subscript inference logic and treat this as an explicit specialization. + // TODO: Move this logic into a custom callable, and update `find_name_in_mro` to return + // this callable as the `__class_getitem__` method on `type`. That probably requires + // updating all of the subscript logic below to use custom callables for all of the _other_ + // special cases, too. + let value_ty = self.infer_expression(value); + if let Type::ClassLiteral(class) = value_ty { + if class.is_known(self.db(), KnownClass::Tuple) { + self.infer_expression(slice); + // TODO heterogeneous and homogeneous tuples in value expressions + return Type::from( + class.todo_specialization(self.db(), "Generic tuple specializations"), + ); + } + if let Some(generic_context) = class.generic_context(self.db()) { + return self.infer_explicit_class_specialization( + subscript, + value_ty, + class, + generic_context, + ); + } + } + + let slice_ty = self.infer_expression(slice); + self.infer_subscript_expression_types(value, value_ty, slice_ty) + } + + fn infer_explicit_class_specialization( + &mut self, + subscript: &ast::ExprSubscript, + value_ty: Type<'db>, + generic_class: ClassLiteral<'db>, + generic_context: GenericContext<'db>, + ) -> Type<'db> { + let slice_node = subscript.slice.as_ref(); + let call_argument_types = match slice_node { + ast::Expr::Tuple(tuple) => { + let arguments = CallArgumentTypes::positional( + tuple.elts.iter().map(|elt| self.infer_type_expression(elt)), + ); + self.store_expression_type( + slice_node, + TupleType::from_elements(self.db(), arguments.iter().map(|(_, ty)| ty)), + ); + arguments + } + _ => CallArgumentTypes::positional([self.infer_type_expression(slice_node)]), + }; + let signatures = Signatures::single(CallableSignature::single( + value_ty, + generic_context.signature(self.db()), + )); + let bindings = match Bindings::match_parameters(signatures, &call_argument_types) + .check_types(self.db(), &call_argument_types) + { + Ok(bindings) => bindings, + Err(CallError(_, bindings)) => { + bindings.report_diagnostics(&self.context, subscript.into()); + return Type::unknown(); + } + }; + let callable = bindings + .into_iter() + .next() + .expect("valid bindings should have one callable"); + let (_, overload) = callable + .matching_overloads() + .next() + .expect("valid bindings should have matching overload"); + let specialization = + generic_context.specialize_partial(self.db(), overload.parameter_types()); + Type::from(GenericAlias::new(self.db(), generic_class, specialization)) + } + + fn infer_subscript_expression_types( + &mut self, + value_node: &ast::Expr, + value_ty: Type<'db>, + slice_ty: Type<'db>, + ) -> Type<'db> { + match (value_ty, slice_ty, slice_ty.slice_literal(self.db())) { + (Type::NominalInstance(instance), _, _) + if instance.class.is_known(self.db(), KnownClass::VersionInfo) => + { + self.infer_subscript_expression_types( + value_node, + Type::version_info_tuple(self.db()), + slice_ty, + ) + } + + // Ex) Given `("a", "b", "c", "d")[1]`, return `"b"` + (Type::Tuple(tuple_ty), Type::IntLiteral(int), _) if i32::try_from(int).is_ok() => { + let elements = tuple_ty.elements(self.db()); + elements + .iter() + .py_index(i32::try_from(int).expect("checked in branch arm")) + .copied() + .unwrap_or_else(|_| { + report_index_out_of_bounds( + &self.context, + "tuple", + value_node.into(), + value_ty, + elements.len(), + int, + ); + Type::unknown() + }) + } + // Ex) Given `("a", 1, Null)[0:2]`, return `("a", 1)` + (Type::Tuple(tuple_ty), _, Some(SliceLiteral { start, stop, step })) => { + let elements = tuple_ty.elements(self.db()); + + if let Ok(new_elements) = elements.py_slice(start, stop, step) { + TupleType::from_elements(self.db(), new_elements) + } else { + report_slice_step_size_zero(&self.context, value_node.into()); + Type::unknown() + } + } + // Ex) Given `"value"[1]`, return `"a"` + (Type::StringLiteral(literal_ty), Type::IntLiteral(int), _) + if i32::try_from(int).is_ok() => + { + let literal_value = literal_ty.value(self.db()); + literal_value + .chars() + .py_index(i32::try_from(int).expect("checked in branch arm")) + .map(|ch| Type::string_literal(self.db(), &ch.to_string())) + .unwrap_or_else(|_| { + report_index_out_of_bounds( + &self.context, + "string", + value_node.into(), + value_ty, + literal_value.chars().count(), + int, + ); + Type::unknown() + }) + } + // Ex) Given `"value"[1:3]`, return `"al"` + (Type::StringLiteral(literal_ty), _, Some(SliceLiteral { start, stop, step })) => { + let literal_value = literal_ty.value(self.db()); + + let chars: Vec<_> = literal_value.chars().collect(); + + if let Ok(new_chars) = chars.py_slice(start, stop, step) { + let literal: String = new_chars.collect(); + Type::string_literal(self.db(), &literal) + } else { + report_slice_step_size_zero(&self.context, value_node.into()); + Type::unknown() + } + } + // Ex) Given `b"value"[1]`, return `97` (i.e., `ord(b"a")`) + (Type::BytesLiteral(literal_ty), Type::IntLiteral(int), _) + if i32::try_from(int).is_ok() => + { + let literal_value = literal_ty.value(self.db()); + literal_value + .iter() + .py_index(i32::try_from(int).expect("checked in branch arm")) + .map(|byte| Type::IntLiteral((*byte).into())) + .unwrap_or_else(|_| { + report_index_out_of_bounds( + &self.context, + "bytes literal", + value_node.into(), + value_ty, + literal_value.len(), + int, + ); + Type::unknown() + }) + } + // Ex) Given `b"value"[1:3]`, return `b"al"` + (Type::BytesLiteral(literal_ty), _, Some(SliceLiteral { start, stop, step })) => { + let literal_value = literal_ty.value(self.db()); + + if let Ok(new_bytes) = literal_value.py_slice(start, stop, step) { + let new_bytes: Vec<u8> = new_bytes.copied().collect(); + Type::bytes_literal(self.db(), &new_bytes) + } else { + report_slice_step_size_zero(&self.context, value_node.into()); + Type::unknown() + } + } + // Ex) Given `"value"[True]`, return `"a"` + ( + Type::Tuple(_) | Type::StringLiteral(_) | Type::BytesLiteral(_), + Type::BooleanLiteral(bool), + _, + ) => self.infer_subscript_expression_types( + value_node, + value_ty, + Type::IntLiteral(i64::from(bool)), + ), + (Type::KnownInstance(KnownInstanceType::Protocol(None)), Type::Tuple(typevars), _) => { + self.legacy_generic_class_context( + value_node, + typevars.elements(self.db()), + LegacyGenericBase::Protocol, + ) + .map(|context| Type::KnownInstance(KnownInstanceType::Protocol(Some(context)))) + .unwrap_or_else(Type::unknown) + } + (Type::KnownInstance(KnownInstanceType::Protocol(None)), typevar, _) => self + .legacy_generic_class_context( + value_node, + std::slice::from_ref(&typevar), + LegacyGenericBase::Protocol, + ) + .map(|context| Type::KnownInstance(KnownInstanceType::Protocol(Some(context)))) + .unwrap_or_else(Type::unknown), + (Type::KnownInstance(KnownInstanceType::Protocol(Some(_))), _, _) => { + // TODO: emit a diagnostic + todo_type!("doubly-specialized typing.Protocol") + } + (Type::KnownInstance(KnownInstanceType::Generic(None)), Type::Tuple(typevars), _) => { + self.legacy_generic_class_context( + value_node, + typevars.elements(self.db()), + LegacyGenericBase::Generic, + ) + .map(|context| Type::KnownInstance(KnownInstanceType::Generic(Some(context)))) + .unwrap_or_else(Type::unknown) + } + (Type::KnownInstance(KnownInstanceType::Generic(None)), typevar, _) => self + .legacy_generic_class_context( + value_node, + std::slice::from_ref(&typevar), + LegacyGenericBase::Generic, + ) + .map(|context| Type::KnownInstance(KnownInstanceType::Generic(Some(context)))) + .unwrap_or_else(Type::unknown), + (Type::KnownInstance(KnownInstanceType::Generic(Some(_))), _, _) => { + // TODO: emit a diagnostic + todo_type!("doubly-specialized typing.Generic") + } + (Type::KnownInstance(known_instance), _, _) + if known_instance.class().is_special_form() => + { + todo_type!("Inference of subscript on special form") + } + (value_ty, slice_ty, _) => { + // If the class defines `__getitem__`, return its return type. + // + // See: https://docs.python.org/3/reference/datamodel.html#class-getitem-versus-getitem + match value_ty.try_call_dunder( + self.db(), + "__getitem__", + CallArgumentTypes::positional([slice_ty]), + ) { + Ok(outcome) => return outcome.return_type(self.db()), + Err(err @ CallDunderError::PossiblyUnbound { .. }) => { + if let Some(builder) = self + .context + .report_lint(&CALL_POSSIBLY_UNBOUND_METHOD, value_node) + { + builder.into_diagnostic(format_args!( + "Method `__getitem__` of type `{}` is possibly unbound", + value_ty.display(self.db()), + )); + } + + return err.fallback_return_type(self.db()); + } + Err(CallDunderError::CallError(_, bindings)) => { + if let Some(builder) = + self.context.report_lint(&CALL_NON_CALLABLE, value_node) + { + builder.into_diagnostic(format_args!( + "Method `__getitem__` of type `{}` \ + is not callable on object of type `{}`", + bindings.callable_type().display(self.db()), + value_ty.display(self.db()), + )); + } + + return bindings.return_type(self.db()); + } + Err(CallDunderError::MethodNotAvailable) => { + // try `__class_getitem__` + } + } + + // Otherwise, if the value is itself a class and defines `__class_getitem__`, + // return its return type. + // + // TODO: lots of classes are only subscriptable at runtime on Python 3.9+, + // *but* we should also allow them to be subscripted in stubs + // (and in annotations if `from __future__ import annotations` is enabled), + // even if the target version is Python 3.8 or lower, + // despite the fact that there will be no corresponding `__class_getitem__` + // method in these `sys.version_info` branches. + if value_ty.is_subtype_of(self.db(), KnownClass::Type.to_instance(self.db())) { + let dunder_class_getitem_method = + value_ty.member(self.db(), "__class_getitem__").symbol; + + match dunder_class_getitem_method { + Symbol::Unbound => {} + Symbol::Type(ty, boundness) => { + if boundness == Boundness::PossiblyUnbound { + if let Some(builder) = self + .context + .report_lint(&CALL_POSSIBLY_UNBOUND_METHOD, value_node) + { + builder.into_diagnostic(format_args!( + "Method `__class_getitem__` of type `{}` \ + is possibly unbound", + value_ty.display(self.db()), + )); + } + } + + match ty.try_call( + self.db(), + &CallArgumentTypes::positional([value_ty, slice_ty]), + ) { + Ok(bindings) => return bindings.return_type(self.db()), + Err(CallError(_, bindings)) => { + if let Some(builder) = + self.context.report_lint(&CALL_NON_CALLABLE, value_node) + { + builder.into_diagnostic(format_args!( + "Method `__class_getitem__` of type `{}` \ + is not callable on object of type `{}`", + bindings.callable_type().display(self.db()), + value_ty.display(self.db()), + )); + } + return bindings.return_type(self.db()); + } + } + } + } + + if let Type::ClassLiteral(class) = value_ty { + if class.is_known(self.db(), KnownClass::Type) { + return KnownClass::GenericAlias.to_instance(self.db()); + } + + if class.generic_context(self.db()).is_some() { + // TODO: specialize the generic class using these explicit type + // variable assignments. This branch is only encountered when an + // explicit class specialization appears inside of some other subscript + // expression, e.g. `tuple[list[int], ...]`. We have already inferred + // the type of the outer subscript slice as a value expression, which + // means we can't re-infer the inner specialization here as a type + // expression. + return value_ty; + } + } + + // TODO: properly handle old-style generics; get rid of this temporary hack + if !value_ty.into_class_literal().is_some_and(|class| { + class + .iter_mro(self.db(), None) + .any(|base| matches!(base, ClassBase::Generic(_))) + }) { + report_non_subscriptable( + &self.context, + value_node.into(), + value_ty, + "__class_getitem__", + ); + } + } else { + report_non_subscriptable( + &self.context, + value_node.into(), + value_ty, + "__getitem__", + ); + } + + match value_ty { + Type::ClassLiteral(_) => { + // TODO: proper support for generic classes + // For now, just infer `Sequence`, if we see something like `Sequence[str]`. This allows us + // to look up attributes on generic base classes, even if we don't understand generics yet. + // Note that this isn't handled by the clause up above for generic classes + // that use legacy type variables and an explicit `Generic` base class. + // Once we handle legacy typevars, this special case will be removed in + // favor of the specialization logic above. + value_ty + } + _ => Type::unknown(), + } + } + } + } + + fn legacy_generic_class_context( + &mut self, + value_node: &ast::Expr, + typevars: &[Type<'db>], + origin: LegacyGenericBase, + ) -> Option<GenericContext<'db>> { + let typevars: Option<FxOrderSet<_>> = typevars + .iter() + .map(|typevar| match typevar { + Type::KnownInstance(KnownInstanceType::TypeVar(typevar)) => Some(*typevar), + _ => { + if let Some(builder) = + self.context.report_lint(&INVALID_ARGUMENT_TYPE, value_node) + { + builder.into_diagnostic(format_args!( + "`{}` is not a valid argument to {origin}", + typevar.display(self.db()), + )); + } + None + } + }) + .collect(); + typevars.map(|typevars| { + GenericContext::new(self.db(), typevars, GenericContextOrigin::from(origin)) + }) + } + + fn infer_slice_expression(&mut self, slice: &ast::ExprSlice) -> Type<'db> { + enum SliceArg<'db> { + Arg(Type<'db>), + Unsupported, + } + + let ast::ExprSlice { + range: _, + lower, + upper, + step, + } = slice; + + let ty_lower = self.infer_optional_expression(lower.as_deref()); + let ty_upper = self.infer_optional_expression(upper.as_deref()); + let ty_step = self.infer_optional_expression(step.as_deref()); + + let type_to_slice_argument = |ty: Option<Type<'db>>| match ty { + Some(ty @ (Type::IntLiteral(_) | Type::BooleanLiteral(_))) => SliceArg::Arg(ty), + Some(ty @ Type::NominalInstance(instance)) + if instance.class.is_known(self.db(), KnownClass::NoneType) => + { + SliceArg::Arg(ty) + } + None => SliceArg::Arg(Type::none(self.db())), + _ => SliceArg::Unsupported, + }; + + match ( + type_to_slice_argument(ty_lower), + type_to_slice_argument(ty_upper), + type_to_slice_argument(ty_step), + ) { + (SliceArg::Arg(lower), SliceArg::Arg(upper), SliceArg::Arg(step)) => { + KnownClass::Slice.to_specialized_instance(self.db(), [lower, upper, step]) + } + _ => KnownClass::Slice.to_instance(self.db()), + } + } + + fn infer_type_parameters(&mut self, type_parameters: &ast::TypeParams) { + let ast::TypeParams { + range: _, + type_params, + } = type_parameters; + for type_param in type_params { + match type_param { + ast::TypeParam::TypeVar(node) => self.infer_definition(node), + ast::TypeParam::ParamSpec(node) => self.infer_definition(node), + ast::TypeParam::TypeVarTuple(node) => self.infer_definition(node), + } + } + } + + pub(super) fn finish(mut self) -> TypeInference<'db> { + self.infer_region(); + self.types.diagnostics = self.context.finish(); + self.types.shrink_to_fit(); + self.types + } +} + +/// Annotation expressions. +impl<'db> TypeInferenceBuilder<'db> { + /// Infer the type of an annotation expression with the given [`DeferredExpressionState`]. + fn infer_annotation_expression( + &mut self, + annotation: &ast::Expr, + deferred_state: DeferredExpressionState, + ) -> TypeAndQualifiers<'db> { + let previous_deferred_state = std::mem::replace(&mut self.deferred_state, deferred_state); + let annotation_ty = self.infer_annotation_expression_impl(annotation); + self.deferred_state = previous_deferred_state; + annotation_ty + } + + /// Similar to [`infer_annotation_expression`], but accepts an optional annotation expression + /// and returns [`None`] if the annotation is [`None`]. + /// + /// [`infer_annotation_expression`]: TypeInferenceBuilder::infer_annotation_expression + fn infer_optional_annotation_expression( + &mut self, + annotation: Option<&ast::Expr>, + deferred_state: DeferredExpressionState, + ) -> Option<TypeAndQualifiers<'db>> { + annotation.map(|expr| self.infer_annotation_expression(expr, deferred_state)) + } + + /// Implementation of [`infer_annotation_expression`]. + /// + /// [`infer_annotation_expression`]: TypeInferenceBuilder::infer_annotation_expression + fn infer_annotation_expression_impl( + &mut self, + annotation: &ast::Expr, + ) -> TypeAndQualifiers<'db> { + // https://typing.python.org/en/latest/spec/annotations.html#grammar-token-expression-grammar-annotation_expression + let annotation_ty = match annotation { + // String annotations: https://typing.python.org/en/latest/spec/annotations.html#string-annotations + ast::Expr::StringLiteral(string) => self.infer_string_annotation_expression(string), + + // Annotation expressions also get special handling for `*args` and `**kwargs`. + ast::Expr::Starred(starred) => self.infer_starred_expression(starred).into(), + + ast::Expr::BytesLiteral(bytes) => { + if let Some(builder) = self + .context + .report_lint(&BYTE_STRING_TYPE_ANNOTATION, bytes) + { + builder.into_diagnostic("Type expressions cannot use bytes literal"); + } + TypeAndQualifiers::unknown() + } + + ast::Expr::FString(fstring) => { + if let Some(builder) = self.context.report_lint(&FSTRING_TYPE_ANNOTATION, fstring) { + builder.into_diagnostic("Type expressions cannot use f-strings"); + } + self.infer_fstring_expression(fstring); + TypeAndQualifiers::unknown() + } + + ast::Expr::Name(name) => match name.ctx { + ast::ExprContext::Load => { + let name_expr_ty = self.infer_name_expression(name); + match name_expr_ty { + Type::KnownInstance(KnownInstanceType::ClassVar) => { + TypeAndQualifiers::new(Type::unknown(), TypeQualifiers::CLASS_VAR) + } + Type::KnownInstance(KnownInstanceType::Final) => { + TypeAndQualifiers::new(Type::unknown(), TypeQualifiers::FINAL) + } + _ => name_expr_ty + .in_type_expression(self.db(), self.scope()) + .unwrap_or_else(|error| { + error.into_fallback_type( + &self.context, + annotation, + self.is_reachable(annotation), + ) + }) + .into(), + } + } + ast::ExprContext::Invalid => TypeAndQualifiers::unknown(), + ast::ExprContext::Store | ast::ExprContext::Del => { + todo_type!("Name expression annotation in Store/Del context").into() + } + }, + + ast::Expr::Subscript(subscript @ ast::ExprSubscript { value, slice, .. }) => { + let value_ty = self.infer_expression(value); + + let slice = &**slice; + + match value_ty { + Type::KnownInstance(KnownInstanceType::Annotated) => { + // This branch is similar to the corresponding branch in `infer_parameterized_known_instance_type_expression`, but + // `Annotated[…]` can appear both in annotation expressions and in type expressions, and needs to be handled slightly + // differently in each case (calling either `infer_type_expression_*` or `infer_annotation_expression_*`). + if let ast::Expr::Tuple(ast::ExprTuple { + elts: arguments, .. + }) = slice + { + if arguments.len() < 2 { + report_invalid_arguments_to_annotated( + self.db(), + &self.context, + subscript, + ); + } + + if let [inner_annotation, metadata @ ..] = &arguments[..] { + for element in metadata { + self.infer_expression(element); + } + + let inner_annotation_ty = + self.infer_annotation_expression_impl(inner_annotation); + + self.store_expression_type(slice, inner_annotation_ty.inner_type()); + inner_annotation_ty + } else { + self.infer_type_expression(slice); + TypeAndQualifiers::unknown() + } + } else { + report_invalid_arguments_to_annotated( + self.db(), + &self.context, + subscript, + ); + self.infer_annotation_expression_impl(slice) + } + } + Type::KnownInstance( + known_instance @ (KnownInstanceType::ClassVar | KnownInstanceType::Final), + ) => match slice { + ast::Expr::Tuple(..) => { + if let Some(builder) = + self.context.report_lint(&INVALID_TYPE_FORM, subscript) + { + builder.into_diagnostic(format_args!( + "Type qualifier `{type_qualifier}` \ + expects exactly one type parameter", + type_qualifier = known_instance.repr(self.db()), + )); + } + Type::unknown().into() + } + _ => { + let mut type_and_qualifiers = + self.infer_annotation_expression_impl(slice); + match known_instance { + KnownInstanceType::ClassVar => { + type_and_qualifiers.add_qualifier(TypeQualifiers::CLASS_VAR); + } + KnownInstanceType::Final => { + type_and_qualifiers.add_qualifier(TypeQualifiers::FINAL); + } + _ => unreachable!(), + } + type_and_qualifiers + } + }, + _ => self + .infer_subscript_type_expression_no_store(subscript, slice, value_ty) + .into(), + } + } + + // All other annotation expressions are (possibly) valid type expressions, so handle + // them there instead. + type_expr => self.infer_type_expression_no_store(type_expr).into(), + }; + + self.store_expression_type(annotation, annotation_ty.inner_type()); + + annotation_ty + } + + /// Infer the type of a string annotation expression. + fn infer_string_annotation_expression( + &mut self, + string: &ast::ExprStringLiteral, + ) -> TypeAndQualifiers<'db> { + match parse_string_annotation(&self.context, string) { + Some(parsed) => { + // String annotations are always evaluated in the deferred context. + self.infer_annotation_expression( + parsed.expr(), + DeferredExpressionState::InStringAnnotation( + self.enclosing_node_key(string.into()), + ), + ) + } + None => TypeAndQualifiers::unknown(), + } + } +} + +/// Type expressions +impl<'db> TypeInferenceBuilder<'db> { + /// Infer the type of a type expression. + fn infer_type_expression(&mut self, expression: &ast::Expr) -> Type<'db> { + let ty = self.infer_type_expression_no_store(expression); + self.store_expression_type(expression, ty); + ty + } + + /// Similar to [`infer_type_expression`], but accepts an optional type expression and returns + /// [`None`] if the expression is [`None`]. + /// + /// [`infer_type_expression`]: TypeInferenceBuilder::infer_type_expression + fn infer_optional_type_expression( + &mut self, + expression: Option<&ast::Expr>, + ) -> Option<Type<'db>> { + expression.map(|expr| self.infer_type_expression(expr)) + } + + /// Similar to [`infer_type_expression`], but accepts a [`DeferredExpressionState`]. + /// + /// [`infer_type_expression`]: TypeInferenceBuilder::infer_type_expression + fn infer_type_expression_with_state( + &mut self, + expression: &ast::Expr, + deferred_state: DeferredExpressionState, + ) -> Type<'db> { + let previous_deferred_state = std::mem::replace(&mut self.deferred_state, deferred_state); + let annotation_ty = self.infer_type_expression(expression); + self.deferred_state = previous_deferred_state; + annotation_ty + } + + fn report_invalid_type_expression( + &mut self, + expression: &ast::Expr, + message: std::fmt::Arguments, + ) -> Type<'db> { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, expression) { + let diag = builder.into_diagnostic(message); + diagnostic::add_type_expression_reference_link(diag); + } + Type::unknown() + } + + /// Infer the type of a type expression without storing the result. + fn infer_type_expression_no_store(&mut self, expression: &ast::Expr) -> Type<'db> { + // https://typing.python.org/en/latest/spec/annotations.html#grammar-token-expression-grammar-type_expression + match expression { + ast::Expr::Name(name) => match name.ctx { + ast::ExprContext::Load => self + .infer_name_expression(name) + .in_type_expression(self.db(), self.scope()) + .unwrap_or_else(|error| { + error.into_fallback_type( + &self.context, + expression, + self.is_reachable(expression), + ) + }), + ast::ExprContext::Invalid => Type::unknown(), + ast::ExprContext::Store | ast::ExprContext::Del => { + todo_type!("Name expression annotation in Store/Del context") + } + }, + + ast::Expr::Attribute(attribute_expression) => match attribute_expression.ctx { + ast::ExprContext::Load => self + .infer_attribute_expression(attribute_expression) + .in_type_expression(self.db(), self.scope()) + .unwrap_or_else(|error| { + error.into_fallback_type( + &self.context, + expression, + self.is_reachable(expression), + ) + }), + ast::ExprContext::Invalid => Type::unknown(), + ast::ExprContext::Store | ast::ExprContext::Del => { + todo_type!("Attribute expression annotation in Store/Del context") + } + }, + + ast::Expr::NoneLiteral(_literal) => Type::none(self.db()), + + // https://typing.python.org/en/latest/spec/annotations.html#string-annotations + ast::Expr::StringLiteral(string) => self.infer_string_type_expression(string), + + ast::Expr::Subscript(subscript) => { + let ast::ExprSubscript { + value, + slice, + ctx: _, + range: _, + } = subscript; + + let value_ty = self.infer_expression(value); + + self.infer_subscript_type_expression_no_store(subscript, slice, value_ty) + } + + ast::Expr::BinOp(binary) => { + match binary.op { + // PEP-604 unions are okay, e.g., `int | str` + ast::Operator::BitOr => { + let left_ty = self.infer_type_expression(&binary.left); + let right_ty = self.infer_type_expression(&binary.right); + UnionType::from_elements(self.db(), [left_ty, right_ty]) + } + // anything else is an invalid annotation: + _ => { + self.infer_binary_expression(binary); + Type::unknown() + } + } + } + + // Avoid inferring the types of invalid type expressions that have been parsed from a + // string annotation, as they are not present in the semantic index. + _ if self.deferred_state.in_string_annotation() => Type::unknown(), + + // ===================================================================================== + // Forms which are invalid in the context of annotation expressions: we infer their + // nested expressions as normal expressions, but the type of the top-level expression is + // always `Type::unknown` in these cases. + // ===================================================================================== + + // TODO: add a subdiagnostic linking to type-expression grammar + // and stating that it is only valid in `typing.Literal[]` or `typing.Annotated[]` + ast::Expr::BytesLiteral(_) => self.report_invalid_type_expression( + expression, + format_args!("Bytes literals are not allowed in this context in a type expression"), + ), + + // TODO: add a subdiagnostic linking to type-expression grammar + // and stating that it is only valid in `typing.Literal[]` or `typing.Annotated[]` + ast::Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Int(_), + .. + }) => self.report_invalid_type_expression( + expression, + format_args!("Int literals are not allowed in this context in a type expression"), + ), + + ast::Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Float(_), + .. + }) => self.report_invalid_type_expression( + expression, + format_args!("Float literals are not allowed in type expressions"), + ), + + ast::Expr::NumberLiteral(ast::ExprNumberLiteral { + value: ast::Number::Complex { .. }, + .. + }) => self.report_invalid_type_expression( + expression, + format_args!("Complex literals are not allowed in type expressions"), + ), + + // TODO: add a subdiagnostic linking to type-expression grammar + // and stating that it is only valid in `typing.Literal[]` or `typing.Annotated[]` + ast::Expr::BooleanLiteral(_) => self.report_invalid_type_expression( + expression, + format_args!( + "Boolean literals are not allowed in this context in a type expression" + ), + ), + + // TODO: add a subdiagnostic linking to type-expression grammar + // and stating that it is only valid as first argument to `typing.Callable[]` + ast::Expr::List(list) => { + self.infer_list_expression(list); + self.report_invalid_type_expression( + expression, + format_args!( + "List literals are not allowed in this context in a type expression" + ), + ) + } + + ast::Expr::BoolOp(bool_op) => { + self.infer_boolean_expression(bool_op); + self.report_invalid_type_expression( + expression, + format_args!("Boolean operations are not allowed in type expressions"), + ) + } + + ast::Expr::Named(named) => { + self.infer_named_expression(named); + self.report_invalid_type_expression( + expression, + format_args!("Named expressions are not allowed in type expressions"), + ) + } + + ast::Expr::UnaryOp(unary) => { + self.infer_unary_expression(unary); + self.report_invalid_type_expression( + expression, + format_args!("Unary operations are not allowed in type expressions"), + ) + } + + ast::Expr::Lambda(lambda_expression) => { + self.infer_lambda_expression(lambda_expression); + self.report_invalid_type_expression( + expression, + format_args!("`lambda` expressions are not allowed in type expressions"), + ) + } + + ast::Expr::If(if_expression) => { + self.infer_if_expression(if_expression); + self.report_invalid_type_expression( + expression, + format_args!("`if` expressions are not allowed in type expressions"), + ) + } + + ast::Expr::Dict(dict) => { + self.infer_dict_expression(dict); + self.report_invalid_type_expression( + expression, + format_args!("Dict literals are not allowed in type expressions"), + ) + } + + ast::Expr::Set(set) => { + self.infer_set_expression(set); + self.report_invalid_type_expression( + expression, + format_args!("Set literals are not allowed in type expressions"), + ) + } + + ast::Expr::DictComp(dictcomp) => { + self.infer_dict_comprehension_expression(dictcomp); + self.report_invalid_type_expression( + expression, + format_args!("Dict comprehensions are not allowed in type expressions"), + ) + } + + ast::Expr::ListComp(listcomp) => { + self.infer_list_comprehension_expression(listcomp); + self.report_invalid_type_expression( + expression, + format_args!("List comprehensions are not allowed in type expressions"), + ) + } + + ast::Expr::SetComp(setcomp) => { + self.infer_set_comprehension_expression(setcomp); + self.report_invalid_type_expression( + expression, + format_args!("Set comprehensions are not allowed in type expressions"), + ) + } + + ast::Expr::Generator(generator) => { + self.infer_generator_expression(generator); + self.report_invalid_type_expression( + expression, + format_args!("Generator expressions are not allowed in type expressions"), + ) + } + + ast::Expr::Await(await_expression) => { + self.infer_await_expression(await_expression); + self.report_invalid_type_expression( + expression, + format_args!("`await` expressions are not allowed in type expressions"), + ) + } + + ast::Expr::Yield(yield_expression) => { + self.infer_yield_expression(yield_expression); + self.report_invalid_type_expression( + expression, + format_args!("`yield` expressions are not allowed in type expressions"), + ) + } + + ast::Expr::YieldFrom(yield_from) => { + self.infer_yield_from_expression(yield_from); + self.report_invalid_type_expression( + expression, + format_args!("`yield from` expressions are not allowed in type expressions"), + ) + } + + ast::Expr::Compare(compare) => { + self.infer_compare_expression(compare); + self.report_invalid_type_expression( + expression, + format_args!("Comparison expressions are not allowed in type expressions"), + ) + } + + ast::Expr::Call(call_expr) => { + self.infer_call_expression(expression, call_expr); + self.report_invalid_type_expression( + expression, + format_args!("Function calls are not allowed in type expressions"), + ) + } + + ast::Expr::FString(fstring) => { + self.infer_fstring_expression(fstring); + self.report_invalid_type_expression( + expression, + format_args!("F-strings are not allowed in type expressions"), + ) + } + + ast::Expr::Slice(slice) => { + self.infer_slice_expression(slice); + self.report_invalid_type_expression( + expression, + format_args!("Slices are not allowed in type expressions"), + ) + } + + // ================================================================================= + // Branches where we probably should emit diagnostics in some context, but don't yet + // ================================================================================= + ast::Expr::IpyEscapeCommand(_) => todo!("Implement Ipy escape command support"), + + ast::Expr::EllipsisLiteral(_) => { + todo_type!("ellipsis literal in type expression") + } + + ast::Expr::Tuple(tuple) => { + self.infer_tuple_expression(tuple); + Type::unknown() + } + + ast::Expr::Starred(starred) => { + self.infer_starred_expression(starred); + todo_type!("PEP 646") + } + } + } + + fn infer_subscript_type_expression_no_store( + &mut self, + subscript: &ast::ExprSubscript, + slice: &ast::Expr, + value_ty: Type<'db>, + ) -> Type<'db> { + match value_ty { + Type::ClassLiteral(class_literal) => match class_literal.known(self.db()) { + Some(KnownClass::Tuple) => self.infer_tuple_type_expression(slice), + Some(KnownClass::Type) => self.infer_subclass_of_type_expression(slice), + _ => self.infer_subscript_type_expression(subscript, value_ty), + }, + _ => self.infer_subscript_type_expression(subscript, value_ty), + } + } + + /// Infer the type of a string type expression. + fn infer_string_type_expression(&mut self, string: &ast::ExprStringLiteral) -> Type<'db> { + match parse_string_annotation(&self.context, string) { + Some(parsed) => { + // String annotations are always evaluated in the deferred context. + self.infer_type_expression_with_state( + parsed.expr(), + DeferredExpressionState::InStringAnnotation( + self.enclosing_node_key(string.into()), + ), + ) + } + None => Type::unknown(), + } + } + + /// Given the slice of a `tuple[]` annotation, return the type that the annotation represents + fn infer_tuple_type_expression(&mut self, tuple_slice: &ast::Expr) -> Type<'db> { + /// In most cases, if a subelement of the tuple is inferred as `Todo`, + /// we should only infer `Todo` for that specific subelement. + /// Certain specific AST nodes can however change the meaning of the entire tuple, + /// however: for example, `tuple[int, ...]` or `tuple[int, *tuple[str, ...]]` are a + /// homogeneous tuple and a partly homogeneous tuple (respectively) due to the `...` + /// and the starred expression (respectively), Neither is supported by us right now, + /// so we should infer `Todo` for the *entire* tuple if we encounter one of those elements. + fn element_could_alter_type_of_whole_tuple( + element: &ast::Expr, + element_ty: Type, + builder: &mut TypeInferenceBuilder, + ) -> bool { + if !element_ty.is_todo() { + return false; + } + + match element { + ast::Expr::Starred(_) => true, + ast::Expr::Subscript(ast::ExprSubscript { value, .. }) => { + let value_ty = if builder.deferred_state.in_string_annotation() { + // Using `.expression_type` does not work in string annotations, because + // we do not store types for sub-expressions. Re-infer the type here. + builder.infer_expression(value) + } else { + builder.expression_type(value) + }; + + value_ty == Type::KnownInstance(KnownInstanceType::Unpack) + } + _ => false, + } + } + + // TODO: PEP 646 + match tuple_slice { + ast::Expr::Tuple(elements) => { + if let [element, ellipsis @ ast::Expr::EllipsisLiteral(_)] = &*elements.elts { + self.infer_expression(ellipsis); + let result = KnownClass::Tuple + .to_specialized_instance(self.db(), [self.infer_type_expression(element)]); + self.store_expression_type(tuple_slice, result); + return result; + } + + let mut element_types = Vec::with_capacity(elements.len()); + + // Whether to infer `Todo` for the whole tuple + // (see docstring for `element_could_alter_type_of_whole_tuple`) + let mut return_todo = false; + + for element in elements { + let element_ty = self.infer_type_expression(element); + return_todo |= + element_could_alter_type_of_whole_tuple(element, element_ty, self); + element_types.push(element_ty); + } + + let ty = if return_todo { + todo_type!("PEP 646") + } else { + TupleType::from_elements(self.db(), element_types) + }; + + // Here, we store the type for the inner `int, str` tuple-expression, + // while the type for the outer `tuple[int, str]` slice-expression is + // stored in the surrounding `infer_type_expression` call: + self.store_expression_type(tuple_slice, ty); + + ty + } + single_element => { + let single_element_ty = self.infer_type_expression(single_element); + if element_could_alter_type_of_whole_tuple(single_element, single_element_ty, self) + { + todo_type!("PEP 646") + } else { + TupleType::from_elements(self.db(), std::iter::once(single_element_ty)) + } + } + } + } + + /// Given the slice of a `type[]` annotation, return the type that the annotation represents + fn infer_subclass_of_type_expression(&mut self, slice: &ast::Expr) -> Type<'db> { + match slice { + ast::Expr::Name(_) | ast::Expr::Attribute(_) => { + let name_ty = self.infer_expression(slice); + match name_ty { + Type::ClassLiteral(class_literal) => { + if class_literal.is_known(self.db(), KnownClass::Any) { + SubclassOfType::subclass_of_any() + } else { + SubclassOfType::from( + self.db(), + class_literal.default_specialization(self.db()), + ) + } + } + Type::KnownInstance(KnownInstanceType::Unknown) => { + SubclassOfType::subclass_of_unknown() + } + _ => todo_type!("unsupported type[X] special form"), + } + } + ast::Expr::BinOp(binary) if binary.op == ast::Operator::BitOr => { + let union_ty = UnionType::from_elements( + self.db(), + [ + self.infer_subclass_of_type_expression(&binary.left), + self.infer_subclass_of_type_expression(&binary.right), + ], + ); + self.store_expression_type(slice, union_ty); + + union_ty + } + ast::Expr::Tuple(_) => { + self.infer_type_expression(slice); + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, slice) { + builder.into_diagnostic("type[...] must have exactly one type argument"); + } + Type::unknown() + } + ast::Expr::Subscript(ast::ExprSubscript { + value, + slice: parameters, + .. + }) => { + let parameters_ty = match self.infer_expression(value) { + Type::KnownInstance(KnownInstanceType::Union) => match &**parameters { + ast::Expr::Tuple(tuple) => { + let ty = UnionType::from_elements( + self.db(), + tuple + .iter() + .map(|element| self.infer_subclass_of_type_expression(element)), + ); + self.store_expression_type(parameters, ty); + ty + } + _ => self.infer_subclass_of_type_expression(parameters), + }, + _ => { + self.infer_type_expression(parameters); + todo_type!("unsupported nested subscript in type[X]") + } + }; + self.store_expression_type(slice, parameters_ty); + parameters_ty + } + // TODO: subscripts, etc. + _ => { + self.infer_type_expression(slice); + todo_type!("unsupported type[X] special form") + } + } + } + + fn infer_subscript_type_expression( + &mut self, + subscript: &ast::ExprSubscript, + value_ty: Type<'db>, + ) -> Type<'db> { + let ast::ExprSubscript { + range: _, + value: _, + slice, + ctx: _, + } = subscript; + + match value_ty { + Type::ClassLiteral(literal) if literal.is_known(self.db(), KnownClass::Any) => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic("Type `typing.Any` expected no type parameter"); + } + Type::unknown() + } + Type::KnownInstance(known_instance) => { + self.infer_parameterized_known_instance_type_expression(subscript, known_instance) + } + Type::Dynamic(DynamicType::Todo(_)) => { + self.infer_type_expression(slice); + value_ty + } + Type::ClassLiteral(class) => { + match class.generic_context(self.db()) { + Some(generic_context) => { + let specialized_class = self.infer_explicit_class_specialization( + subscript, + value_ty, + class, + generic_context, + ); + specialized_class + .in_type_expression(self.db(), self.scope()) + .unwrap_or(Type::unknown()) + } + None => { + // TODO: Once we know that e.g. `list` is generic, emit a diagnostic if you try to + // specialize a non-generic class. + self.infer_type_expression(slice); + todo_type!("specialized non-generic class") + } + } + } + _ => { + // TODO: Emit a diagnostic once we've implemented all valid subscript type + // expressions. + self.infer_type_expression(slice); + todo_type!("unknown type subscript") + } + } + } + + fn infer_parameterized_known_instance_type_expression( + &mut self, + subscript: &ast::ExprSubscript, + known_instance: KnownInstanceType, + ) -> Type<'db> { + let db = self.db(); + let arguments_slice = &*subscript.slice; + match known_instance { + KnownInstanceType::Annotated => { + let ast::Expr::Tuple(ast::ExprTuple { + elts: arguments, .. + }) = arguments_slice + else { + report_invalid_arguments_to_annotated(self.db(), &self.context, subscript); + + // `Annotated[]` with less than two arguments is an error at runtime. + // However, we still treat `Annotated[T]` as `T` here for the purpose of + // giving better diagnostics later on. + // Pyright also does this. Mypy doesn't; it falls back to `Any` instead. + return self.infer_type_expression(arguments_slice); + }; + + if arguments.len() < 2 { + report_invalid_arguments_to_annotated(self.db(), &self.context, subscript); + } + + let [type_expr, metadata @ ..] = &arguments[..] else { + self.infer_type_expression(arguments_slice); + return Type::unknown(); + }; + + for element in metadata { + self.infer_expression(element); + } + + let ty = self.infer_type_expression(type_expr); + self.store_expression_type(arguments_slice, ty); + ty + } + KnownInstanceType::Literal => { + match self.infer_literal_parameter_type(arguments_slice) { + Ok(ty) => ty, + Err(nodes) => { + for node in nodes { + if let Some(builder) = + self.context.report_lint(&INVALID_TYPE_FORM, node) + { + builder.into_diagnostic( + "Type arguments for `Literal` must be `None`, \ + a literal value (int, bool, str, or bytes), or an enum value", + ); + } + } + Type::unknown() + } + } + } + KnownInstanceType::Optional => { + let param_type = self.infer_type_expression(arguments_slice); + UnionType::from_elements(db, [param_type, Type::none(db)]) + } + KnownInstanceType::Union => match arguments_slice { + ast::Expr::Tuple(t) => { + let union_ty = UnionType::from_elements( + db, + t.iter().map(|elt| self.infer_type_expression(elt)), + ); + self.store_expression_type(arguments_slice, union_ty); + union_ty + } + _ => self.infer_type_expression(arguments_slice), + }, + KnownInstanceType::TypeVar(_) => { + self.infer_type_expression(arguments_slice); + todo_type!("TypeVar annotations") + } + KnownInstanceType::TypeAliasType(_) => { + self.infer_type_expression(arguments_slice); + todo_type!("Generic PEP-695 type alias") + } + KnownInstanceType::Callable => { + let mut arguments = match arguments_slice { + ast::Expr::Tuple(tuple) => Either::Left(tuple.iter()), + _ => { + self.infer_callable_parameter_types(arguments_slice); + Either::Right(std::iter::empty::<&ast::Expr>()) + } + }; + + let first_argument = arguments.next(); + + let parameters = + first_argument.and_then(|arg| self.infer_callable_parameter_types(arg)); + + let return_type = arguments.next().map(|arg| self.infer_type_expression(arg)); + + let correct_argument_number = if let Some(third_argument) = arguments.next() { + self.infer_type_expression(third_argument); + for argument in arguments { + self.infer_type_expression(argument); + } + false + } else { + return_type.is_some() + }; + + if !correct_argument_number { + report_invalid_arguments_to_callable(self.db(), &self.context, subscript); + } + + let callable_type = if let (Some(parameters), Some(return_type), true) = + (parameters, return_type, correct_argument_number) + { + CallableType::single(db, Signature::new(parameters, Some(return_type))) + } else { + CallableType::unknown(db) + }; + + let callable_type = Type::Callable(callable_type); + + // `Signature` / `Parameters` are not a `Type` variant, so we're storing + // the outer callable type on these expressions instead. + self.store_expression_type(arguments_slice, callable_type); + if let Some(first_argument) = first_argument { + self.store_expression_type(first_argument, callable_type); + } + + callable_type + } + + // Type API special forms + KnownInstanceType::Not => match arguments_slice { + ast::Expr::Tuple(_) => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "Special form `{}` expected exactly one type parameter", + known_instance.repr(self.db()) + )); + } + Type::unknown() + } + _ => { + let argument_type = self.infer_type_expression(arguments_slice); + argument_type.negate(db) + } + }, + KnownInstanceType::Intersection => { + let elements = match arguments_slice { + ast::Expr::Tuple(tuple) => Either::Left(tuple.iter()), + element => Either::Right(std::iter::once(element)), + }; + + elements + .fold(IntersectionBuilder::new(db), |builder, element| { + builder.add_positive(self.infer_type_expression(element)) + }) + .build() + } + KnownInstanceType::TypeOf => match arguments_slice { + ast::Expr::Tuple(_) => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "Special form `{}` expected exactly one type parameter", + known_instance.repr(self.db()) + )); + } + Type::unknown() + } + _ => { + // NB: This calls `infer_expression` instead of `infer_type_expression`. + + self.infer_expression(arguments_slice) + } + }, + KnownInstanceType::CallableTypeOf => match arguments_slice { + ast::Expr::Tuple(_) => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "Special form `{}` expected exactly one type parameter", + known_instance.repr(self.db()) + )); + } + Type::unknown() + } + _ => { + let argument_type = self.infer_expression(arguments_slice); + let signatures = argument_type.signatures(db); + + // SAFETY: This is enforced by the constructor methods on `Signatures` even in + // the case of a non-callable union. + let callable_signature = signatures + .iter() + .next() + .expect("`Signatures` should have at least one `CallableSignature`"); + + let mut signature_iter = callable_signature.iter().map(|signature| { + if argument_type.is_bound_method() { + signature.bind_self() + } else { + signature.clone() + } + }); + + let Some(signature) = signature_iter.next() else { + if let Some(builder) = self + .context + .report_lint(&INVALID_TYPE_FORM, arguments_slice) + { + builder.into_diagnostic(format_args!( + "Expected the first argument to `{}` \ + to be a callable object, \ + but got an object of type `{}`", + known_instance.repr(self.db()), + argument_type.display(db) + )); + } + return Type::unknown(); + }; + + Type::Callable(CallableType::from_overloads( + db, + std::iter::once(signature).chain(signature_iter), + )) + } + }, + + // TODO: Generics + KnownInstanceType::ChainMap => { + self.infer_type_expression(arguments_slice); + KnownClass::ChainMap.to_instance(db) + } + KnownInstanceType::OrderedDict => { + self.infer_type_expression(arguments_slice); + KnownClass::OrderedDict.to_instance(db) + } + KnownInstanceType::Dict => { + self.infer_type_expression(arguments_slice); + KnownClass::Dict.to_instance(db) + } + KnownInstanceType::List => { + self.infer_type_expression(arguments_slice); + KnownClass::List.to_instance(db) + } + KnownInstanceType::DefaultDict => { + self.infer_type_expression(arguments_slice); + KnownClass::DefaultDict.to_instance(db) + } + KnownInstanceType::Counter => { + self.infer_type_expression(arguments_slice); + KnownClass::Counter.to_instance(db) + } + KnownInstanceType::Set => { + self.infer_type_expression(arguments_slice); + KnownClass::Set.to_instance(db) + } + KnownInstanceType::FrozenSet => { + self.infer_type_expression(arguments_slice); + KnownClass::FrozenSet.to_instance(db) + } + KnownInstanceType::Deque => { + self.infer_type_expression(arguments_slice); + KnownClass::Deque.to_instance(db) + } + + KnownInstanceType::ReadOnly => { + self.infer_type_expression(arguments_slice); + todo_type!("`ReadOnly[]` type qualifier") + } + KnownInstanceType::NotRequired => { + self.infer_type_expression(arguments_slice); + todo_type!("`NotRequired[]` type qualifier") + } + KnownInstanceType::ClassVar | KnownInstanceType::Final => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + let diag = builder.into_diagnostic(format_args!( + "Type qualifier `{}` is not allowed in type expressions \ + (only in annotation expressions)", + known_instance.repr(self.db()) + )); + diagnostic::add_type_expression_reference_link(diag); + } + self.infer_type_expression(arguments_slice) + } + KnownInstanceType::Required => { + self.infer_type_expression(arguments_slice); + todo_type!("`Required[]` type qualifier") + } + KnownInstanceType::TypeIs => { + self.infer_type_expression(arguments_slice); + todo_type!("`TypeIs[]` special form") + } + KnownInstanceType::TypeGuard => { + self.infer_type_expression(arguments_slice); + todo_type!("`TypeGuard[]` special form") + } + KnownInstanceType::Concatenate => { + self.infer_type_expression(arguments_slice); + todo_type!("`Concatenate[]` special form") + } + KnownInstanceType::Unpack => { + self.infer_type_expression(arguments_slice); + todo_type!("`Unpack[]` special form") + } + KnownInstanceType::Protocol(_) => { + self.infer_type_expression(arguments_slice); + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "`typing.Protocol` is not allowed in type expressions", + )); + } + Type::unknown() + } + KnownInstanceType::Generic(_) => { + self.infer_type_expression(arguments_slice); + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "`typing.Generic` is not allowed in type expressions", + )); + } + Type::unknown() + } + KnownInstanceType::NoReturn + | KnownInstanceType::Never + | KnownInstanceType::AlwaysTruthy + | KnownInstanceType::AlwaysFalsy => { + self.infer_type_expression(arguments_slice); + + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "Type `{}` expected no type parameter", + known_instance.repr(self.db()) + )); + } + Type::unknown() + } + KnownInstanceType::TypingSelf + | KnownInstanceType::TypeAlias + | KnownInstanceType::TypedDict + | KnownInstanceType::Unknown => { + self.infer_type_expression(arguments_slice); + + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + builder.into_diagnostic(format_args!( + "Special form `{}` expected no type parameter", + known_instance.repr(self.db()) + )); + } + Type::unknown() + } + KnownInstanceType::LiteralString => { + self.infer_type_expression(arguments_slice); + + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, subscript) { + let mut diag = builder.into_diagnostic(format_args!( + "Type `{}` expected no type parameter", + known_instance.repr(self.db()) + )); + diag.info("Did you mean to use `Literal[...]` instead?"); + } + Type::unknown() + } + KnownInstanceType::Type => self.infer_subclass_of_type_expression(arguments_slice), + KnownInstanceType::Tuple => self.infer_tuple_type_expression(arguments_slice), + } + } + + fn infer_literal_parameter_type<'ast>( + &mut self, + parameters: &'ast ast::Expr, + ) -> Result<Type<'db>, Vec<&'ast ast::Expr>> { + Ok(match parameters { + // TODO handle type aliases + ast::Expr::Subscript(ast::ExprSubscript { value, slice, .. }) => { + let value_ty = self.infer_expression(value); + if matches!(value_ty, Type::KnownInstance(KnownInstanceType::Literal)) { + let ty = self.infer_literal_parameter_type(slice)?; + + // This branch deals with annotations such as `Literal[Literal[1]]`. + // Here, we store the type for the inner `Literal[1]` expression: + self.store_expression_type(parameters, ty); + ty + } else { + self.store_expression_type(parameters, Type::unknown()); + + return Err(vec![parameters]); + } + } + ast::Expr::Tuple(tuple) if !tuple.parenthesized => { + let mut errors = vec![]; + let mut builder = UnionBuilder::new(self.db()); + for elt in tuple { + match self.infer_literal_parameter_type(elt) { + Ok(ty) => { + builder = builder.add(ty); + } + Err(nodes) => { + errors.extend(nodes); + } + } + } + if errors.is_empty() { + let union_type = builder.build(); + + // This branch deals with annotations such as `Literal[1, 2]`. Here, we + // store the type for the inner `1, 2` tuple-expression: + self.store_expression_type(parameters, union_type); + + union_type + } else { + self.store_expression_type(parameters, Type::unknown()); + + return Err(errors); + } + } + + literal @ (ast::Expr::StringLiteral(_) + | ast::Expr::BytesLiteral(_) + | ast::Expr::BooleanLiteral(_) + | ast::Expr::NoneLiteral(_)) => self.infer_expression(literal), + literal @ ast::Expr::NumberLiteral(number) if number.value.is_int() => { + self.infer_expression(literal) + } + // For enum values + ast::Expr::Attribute(ast::ExprAttribute { value, attr, .. }) => { + let value_ty = self.infer_expression(value); + // TODO: Check that value type is enum otherwise return None + value_ty + .member(self.db(), &attr.id) + .symbol + .ignore_possibly_unbound() + .unwrap_or(Type::unknown()) + } + // for negative and positive numbers + ast::Expr::UnaryOp(u) + if matches!(u.op, ast::UnaryOp::USub | ast::UnaryOp::UAdd) + && u.operand.is_number_literal_expr() => + { + self.infer_unary_expression(u) + } + _ => { + self.infer_expression(parameters); + return Err(vec![parameters]); + } + }) + } + + /// Infer the first argument to a `typing.Callable` type expression and returns the + /// corresponding [`Parameters`]. + /// + /// It returns `None` if the argument is invalid i.e., not a list of types, parameter + /// specification, `typing.Concatenate`, or `...`. + fn infer_callable_parameter_types( + &mut self, + parameters: &ast::Expr, + ) -> Option<Parameters<'db>> { + Some(match parameters { + ast::Expr::EllipsisLiteral(ast::ExprEllipsisLiteral { .. }) => { + Parameters::gradual_form() + } + ast::Expr::List(ast::ExprList { elts: params, .. }) => { + let mut parameter_types = Vec::with_capacity(params.len()); + + // Whether to infer `Todo` for the parameters + let mut return_todo = false; + + for param in params { + let param_type = self.infer_type_expression(param); + // This is similar to what we currently do for inferring tuple type expression. + // We currently infer `Todo` for the parameters to avoid invalid diagnostics + // when trying to check for assignability or any other relation. For example, + // `*tuple[int, str]`, `Unpack[]`, etc. are not yet supported. + return_todo |= param_type.is_todo() + && matches!(param, ast::Expr::Starred(_) | ast::Expr::Subscript(_)); + parameter_types.push(param_type); + } + + if return_todo { + // TODO: `Unpack` + Parameters::todo() + } else { + Parameters::new(parameter_types.iter().map(|param_type| { + Parameter::positional_only(None).with_annotated_type(*param_type) + })) + } + } + ast::Expr::Subscript(_) => { + // TODO: Support `Concatenate[...]` + Parameters::todo() + } + ast::Expr::Name(name) if name.is_invalid() => { + // This is a special case to avoid raising the error suggesting what the first + // argument should be. This only happens when there's already a syntax error like + // `Callable[]`. + return None; + } + ast::Expr::Name(name) + if self.infer_name_load(name) + == Type::Dynamic(DynamicType::TodoPEP695ParamSpec) => + { + return Some(Parameters::todo()); + } + _ => { + if let Some(builder) = self.context.report_lint(&INVALID_TYPE_FORM, parameters) { + let diag = builder.into_diagnostic(format_args!( + "The first argument to `Callable` \ + must be either a list of types, \ + ParamSpec, Concatenate, or `...`", + )); + diagnostic::add_type_expression_reference_link(diag); + } + return None; + } + }) + } +} + +/// The deferred state of a specific expression in an inference region. +#[derive(Default, Debug, Clone, Copy)] +enum DeferredExpressionState { + /// The expression is not deferred. + #[default] + None, + + /// The expression is deferred. + /// + /// In the following example, + /// ```py + /// from __future__ import annotation + /// + /// a: tuple[int, "ForwardRef"] = ... + /// ``` + /// + /// The expression `tuple` and `int` are deferred but `ForwardRef` (after parsing) is both + /// deferred and in a string annotation context. + Deferred, + + /// The expression is in a string annotation context. + /// + /// This is required to differentiate between a deferred annotation and a string annotation. + /// The former can occur when there's a `from __future__ import annotations` statement or we're + /// in a stub file. + /// + /// In the following example, + /// ```py + /// a: "List[int]" = ... + /// b: tuple[int, "ForwardRef"] = ... + /// ``` + /// + /// The annotation of `a` is completely inside a string while for `b`, it's only partially + /// stringified. + /// + /// This variant wraps a [`NodeKey`] that allows us to retrieve the original + /// [`ast::ExprStringLiteral`] node which created the string annotation. + InStringAnnotation(NodeKey), +} + +impl DeferredExpressionState { + const fn is_deferred(self) -> bool { + matches!( + self, + DeferredExpressionState::Deferred | DeferredExpressionState::InStringAnnotation(_) + ) + } + + const fn in_string_annotation(self) -> bool { + matches!(self, DeferredExpressionState::InStringAnnotation(_)) + } +} + +impl From<bool> for DeferredExpressionState { + fn from(value: bool) -> Self { + if value { + DeferredExpressionState::Deferred + } else { + DeferredExpressionState::None + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum RichCompareOperator { + Eq, + Ne, + Gt, + Ge, + Lt, + Le, +} + +impl From<RichCompareOperator> for ast::CmpOp { + fn from(value: RichCompareOperator) -> Self { + match value { + RichCompareOperator::Eq => ast::CmpOp::Eq, + RichCompareOperator::Ne => ast::CmpOp::NotEq, + RichCompareOperator::Lt => ast::CmpOp::Lt, + RichCompareOperator::Le => ast::CmpOp::LtE, + RichCompareOperator::Gt => ast::CmpOp::Gt, + RichCompareOperator::Ge => ast::CmpOp::GtE, + } + } +} + +impl RichCompareOperator { + #[must_use] + const fn dunder(self) -> &'static str { + match self { + RichCompareOperator::Eq => "__eq__", + RichCompareOperator::Ne => "__ne__", + RichCompareOperator::Lt => "__lt__", + RichCompareOperator::Le => "__le__", + RichCompareOperator::Gt => "__gt__", + RichCompareOperator::Ge => "__ge__", + } + } + + #[must_use] + const fn reflect(self) -> Self { + match self { + RichCompareOperator::Eq => RichCompareOperator::Eq, + RichCompareOperator::Ne => RichCompareOperator::Ne, + RichCompareOperator::Lt => RichCompareOperator::Gt, + RichCompareOperator::Le => RichCompareOperator::Ge, + RichCompareOperator::Gt => RichCompareOperator::Lt, + RichCompareOperator::Ge => RichCompareOperator::Le, + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum MembershipTestCompareOperator { + In, + NotIn, +} + +impl From<MembershipTestCompareOperator> for ast::CmpOp { + fn from(value: MembershipTestCompareOperator) -> Self { + match value { + MembershipTestCompareOperator::In => ast::CmpOp::In, + MembershipTestCompareOperator::NotIn => ast::CmpOp::NotIn, + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +struct CompareUnsupportedError<'db> { + op: ast::CmpOp, + left_ty: Type<'db>, + right_ty: Type<'db>, +} + +fn format_import_from_module(level: u32, module: Option<&str>) -> String { + format!( + "{}{}", + ".".repeat(level as usize), + module.unwrap_or_default() + ) +} + +/// Struct collecting string parts when inferring a formatted string. Infers a string literal if the +/// concatenated string is small enough, otherwise infers a literal string. +/// +/// If the formatted string contains an expression (with a representation unknown at compile time), +/// infers an instance of `builtins.str`. +#[derive(Debug)] +struct StringPartsCollector { + concatenated: Option<String>, + expression: bool, +} + +impl StringPartsCollector { + fn new() -> Self { + Self { + concatenated: Some(String::new()), + expression: false, + } + } + + fn push_str(&mut self, literal: &str) { + if let Some(mut concatenated) = self.concatenated.take() { + if concatenated.len().saturating_add(literal.len()) + <= TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + { + concatenated.push_str(literal); + self.concatenated = Some(concatenated); + } else { + self.concatenated = None; + } + } + } + + fn add_expression(&mut self) { + self.concatenated = None; + self.expression = true; + } + + fn string_type(self, db: &dyn Db) -> Type { + if self.expression { + KnownClass::Str.to_instance(db) + } else if let Some(concatenated) = self.concatenated { + Type::string_literal(db, &concatenated) + } else { + Type::LiteralString + } + } +} + +fn contains_string_literal(expr: &ast::Expr) -> bool { + struct ContainsStringLiteral(bool); + + impl<'a> Visitor<'a> for ContainsStringLiteral { + fn visit_expr(&mut self, expr: &'a ast::Expr) { + self.0 |= matches!(expr, ast::Expr::StringLiteral(_)); + walk_expr(self, expr); + } + } + + let mut visitor = ContainsStringLiteral(false); + visitor.visit_expr(expr); + visitor.0 +} + +#[cfg(test)] +mod tests { + use crate::db::tests::{TestDb, setup_db}; + use crate::semantic_index::definition::Definition; + use crate::semantic_index::symbol::FileScopeId; + use crate::semantic_index::{global_scope, semantic_index, symbol_table, use_def_map}; + use crate::symbol::global_symbol; + use crate::types::check_types; + use ruff_db::diagnostic::Diagnostic; + use ruff_db::files::{File, system_path_to_file}; + use ruff_db::system::DbWithWritableSystem as _; + use ruff_db::testing::{assert_function_query_was_not_run, assert_function_query_was_run}; + + use super::*; + + #[track_caller] + fn get_symbol<'db>( + db: &'db TestDb, + file_name: &str, + scopes: &[&str], + symbol_name: &str, + ) -> Symbol<'db> { + let file = system_path_to_file(db, file_name).expect("file to exist"); + let index = semantic_index(db, file); + let mut file_scope_id = FileScopeId::global(); + let mut scope = file_scope_id.to_scope_id(db, file); + for expected_scope_name in scopes { + file_scope_id = index + .child_scopes(file_scope_id) + .next() + .unwrap_or_else(|| panic!("scope of {expected_scope_name}")) + .0; + scope = file_scope_id.to_scope_id(db, file); + assert_eq!(scope.name(db), *expected_scope_name); + } + + symbol(db, scope, symbol_name).symbol + } + + #[track_caller] + fn assert_diagnostic_messages(diagnostics: &TypeCheckDiagnostics, expected: &[&str]) { + let messages: Vec<&str> = diagnostics + .iter() + .map(Diagnostic::primary_message) + .collect(); + assert_eq!(&messages, expected); + } + + #[track_caller] + fn assert_file_diagnostics(db: &TestDb, filename: &str, expected: &[&str]) { + let file = system_path_to_file(db, filename).unwrap(); + let diagnostics = check_types(db, file); + + assert_diagnostic_messages(diagnostics, expected); + } + + #[test] + fn not_literal_string() -> anyhow::Result<()> { + let mut db = setup_db(); + let content = format!( + r#" + from typing_extensions import Literal, assert_type + + assert_type(not "{y}", bool) + assert_type(not 10*"{y}", bool) + assert_type(not "{y}"*10, bool) + assert_type(not 0*"{y}", Literal[True]) + assert_type(not (-100)*"{y}", Literal[True]) + "#, + y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), + ); + db.write_dedented("src/a.py", &content)?; + + assert_file_diagnostics(&db, "src/a.py", &[]); + + Ok(()) + } + + #[test] + fn multiplied_string() -> anyhow::Result<()> { + let mut db = setup_db(); + let content = format!( + r#" + from typing_extensions import Literal, LiteralString, assert_type + + assert_type(2 * "hello", Literal["hellohello"]) + assert_type("goodbye" * 3, Literal["goodbyegoodbyegoodbye"]) + assert_type("a" * {y}, Literal["{a_repeated}"]) + assert_type({z} * "b", LiteralString) + assert_type(0 * "hello", Literal[""]) + assert_type(-3 * "hello", Literal[""]) + "#, + y = TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE, + z = TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1, + a_repeated = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE), + ); + db.write_dedented("src/a.py", &content)?; + + assert_file_diagnostics(&db, "src/a.py", &[]); + + Ok(()) + } + + #[test] + fn multiplied_literal_string() -> anyhow::Result<()> { + let mut db = setup_db(); + let content = format!( + r#" + from typing_extensions import Literal, LiteralString, assert_type + + assert_type("{y}", LiteralString) + assert_type(10*"{y}", LiteralString) + assert_type("{y}"*10, LiteralString) + assert_type(0*"{y}", Literal[""]) + assert_type((-100)*"{y}", Literal[""]) + "#, + y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), + ); + db.write_dedented("src/a.py", &content)?; + + assert_file_diagnostics(&db, "src/a.py", &[]); + + Ok(()) + } + + #[test] + fn truncated_string_literals_become_literal_string() -> anyhow::Result<()> { + let mut db = setup_db(); + let content = format!( + r#" + from typing_extensions import LiteralString, assert_type + + assert_type("{y}", LiteralString) + assert_type("a" + "{z}", LiteralString) + "#, + y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), + z = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE), + ); + db.write_dedented("src/a.py", &content)?; + + assert_file_diagnostics(&db, "src/a.py", &[]); + + Ok(()) + } + + #[test] + fn adding_string_literals_and_literal_string() -> anyhow::Result<()> { + let mut db = setup_db(); + let content = format!( + r#" + from typing_extensions import LiteralString, assert_type + + assert_type("{y}", LiteralString) + assert_type("{y}" + "a", LiteralString) + assert_type("a" + "{y}", LiteralString) + assert_type("{y}" + "{y}", LiteralString) + "#, + y = "a".repeat(TypeInferenceBuilder::MAX_STRING_LITERAL_SIZE + 1), + ); + db.write_dedented("src/a.py", &content)?; + + assert_file_diagnostics(&db, "src/a.py", &[]); + + Ok(()) + } + + #[test] + fn pep695_type_params() { + let mut db = setup_db(); + + db.write_dedented( + "src/a.py", + " + def f[T, U: A, V: (A, B), W = A, X: A = A1, Y: (int,)](): + pass + + class A: ... + class B: ... + class A1(A): ... + ", + ) + .unwrap(); + + let check_typevar = |var: &'static str, + upper_bound: Option<&'static str>, + constraints: Option<&[&'static str]>, + default: Option<&'static str>| { + let var_ty = get_symbol(&db, "src/a.py", &["f"], var).expect_type(); + assert_eq!(var_ty.display(&db).to_string(), "typing.TypeVar"); + + let expected_name_ty = format!(r#"Literal["{var}"]"#); + let name_ty = var_ty.member(&db, "__name__").symbol.expect_type(); + assert_eq!(name_ty.display(&db).to_string(), expected_name_ty); + + let KnownInstanceType::TypeVar(typevar) = var_ty.expect_known_instance() else { + panic!("expected TypeVar"); + }; + + assert_eq!( + typevar + .upper_bound(&db) + .map(|ty| ty.display(&db).to_string()), + upper_bound.map(std::borrow::ToOwned::to_owned) + ); + assert_eq!( + typevar.constraints(&db).map(|tys| tys + .iter() + .map(|ty| ty.display(&db).to_string()) + .collect::<Vec<_>>()), + constraints.map(|strings| strings + .iter() + .map(std::string::ToString::to_string) + .collect::<Vec<_>>()) + ); + assert_eq!( + typevar + .default_ty(&db) + .map(|ty| ty.display(&db).to_string()), + default.map(std::borrow::ToOwned::to_owned) + ); + }; + + check_typevar("T", None, None, None); + check_typevar("U", Some("A"), None, None); + check_typevar("V", None, Some(&["A", "B"]), None); + check_typevar("W", None, None, Some("A")); + check_typevar("X", Some("A"), None, Some("A1")); + + // a typevar with less than two constraints is treated as unconstrained + check_typevar("Y", None, None, None); + } + + /// Test that a symbol known to be unbound in a scope does not still trigger cycle-causing + /// visibility-constraint checks in that scope. + #[test] + fn unbound_symbol_no_visibility_constraint_check() { + let mut db = setup_db(); + + // If the bug we are testing for is not fixed, what happens is that when inferring the + // `flag: bool = True` definitions, we look up `bool` as a deferred name (thus from end of + // scope), and because of the early return its "unbound" binding has a visibility + // constraint of `~flag`, which we evaluate, meaning we have to evaluate the definition of + // `flag` -- and we are in a cycle. With the fix, we short-circuit evaluating visibility + // constraints on "unbound" if a symbol is otherwise not bound. + db.write_dedented( + "src/a.py", + " + from __future__ import annotations + + def f(): + flag: bool = True + if flag: + return True + ", + ) + .unwrap(); + + db.clear_salsa_events(); + assert_file_diagnostics(&db, "src/a.py", &[]); + let events = db.take_salsa_events(); + let cycles = salsa::attach(&db, || { + events + .iter() + .filter_map(|event| { + if let salsa::EventKind::WillIterateCycle { database_key, .. } = event.kind { + Some(format!("{database_key:?}")) + } else { + None + } + }) + .collect::<Vec<_>>() + }); + let expected: Vec<String> = vec![]; + assert_eq!(cycles, expected); + } + + // Incremental inference tests + #[track_caller] + fn first_public_binding<'db>(db: &'db TestDb, file: File, name: &str) -> Definition<'db> { + let scope = global_scope(db, file); + use_def_map(db, scope) + .public_bindings(symbol_table(db, scope).symbol_id_by_name(name).unwrap()) + .find_map(|b| b.binding) + .expect("no binding found") + } + + #[test] + fn dependency_public_symbol_type_change() -> anyhow::Result<()> { + let mut db = setup_db(); + + db.write_files([ + ("/src/a.py", "from foo import x"), + ("/src/foo.py", "x: int = 10\ndef foo(): ..."), + ])?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + let x_ty = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty.display(&db).to_string(), "int"); + + // Change `x` to a different value + db.write_file("/src/foo.py", "x: bool = True\ndef foo(): ...")?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + + let x_ty_2 = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty_2.display(&db).to_string(), "bool"); + + Ok(()) + } + + #[test] + fn dependency_internal_symbol_change() -> anyhow::Result<()> { + let mut db = setup_db(); + + db.write_files([ + ("/src/a.py", "from foo import x"), + ("/src/foo.py", "x: int = 10\ndef foo(): y = 1"), + ])?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + let x_ty = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty.display(&db).to_string(), "int"); + + db.write_file("/src/foo.py", "x: int = 10\ndef foo(): pass")?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + + db.clear_salsa_events(); + + let x_ty_2 = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty_2.display(&db).to_string(), "int"); + + let events = db.take_salsa_events(); + + assert_function_query_was_not_run( + &db, + infer_definition_types, + first_public_binding(&db, a, "x"), + &events, + ); + + Ok(()) + } + + #[test] + fn dependency_unrelated_symbol() -> anyhow::Result<()> { + let mut db = setup_db(); + + db.write_files([ + ("/src/a.py", "from foo import x"), + ("/src/foo.py", "x: int = 10\ny: bool = True"), + ])?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + let x_ty = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty.display(&db).to_string(), "int"); + + db.write_file("/src/foo.py", "x: int = 10\ny: bool = False")?; + + let a = system_path_to_file(&db, "/src/a.py").unwrap(); + + db.clear_salsa_events(); + + let x_ty_2 = global_symbol(&db, a, "x").symbol.expect_type(); + + assert_eq!(x_ty_2.display(&db).to_string(), "int"); + + let events = db.take_salsa_events(); + + assert_function_query_was_not_run( + &db, + infer_definition_types, + first_public_binding(&db, a, "x"), + &events, + ); + Ok(()) + } + + #[test] + fn dependency_implicit_instance_attribute() -> anyhow::Result<()> { + fn x_rhs_expression(db: &TestDb) -> Expression<'_> { + let file_main = system_path_to_file(db, "/src/main.py").unwrap(); + let ast = parsed_module(db, file_main); + // Get the second statement in `main.py` (x = …) and extract the expression + // node on the right-hand side: + let x_rhs_node = &ast.syntax().body[1].as_assign_stmt().unwrap().value; + + let index = semantic_index(db, file_main); + index.expression(x_rhs_node.as_ref()) + } + + let mut db = setup_db(); + + db.write_dedented( + "/src/mod.py", + r#" + class C: + def f(self): + self.attr: int | None = None + "#, + )?; + db.write_dedented( + "/src/main.py", + r#" + from mod import C + x = C().attr + "#, + )?; + + let file_main = system_path_to_file(&db, "/src/main.py").unwrap(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | int | None"); + + // Change the type of `attr` to `str | None`; this should trigger the type of `x` to be re-inferred + db.write_dedented( + "/src/mod.py", + r#" + class C: + def f(self): + self.attr: str | None = None + "#, + )?; + + let events = { + db.clear_salsa_events(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | str | None"); + db.take_salsa_events() + }; + assert_function_query_was_run(&db, infer_expression_types, x_rhs_expression(&db), &events); + + // Add a comment; this should not trigger the type of `x` to be re-inferred + db.write_dedented( + "/src/mod.py", + r#" + class C: + def f(self): + # a comment! + self.attr: str | None = None + "#, + )?; + + let events = { + db.clear_salsa_events(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | str | None"); + db.take_salsa_events() + }; + + assert_function_query_was_not_run( + &db, + infer_expression_types, + x_rhs_expression(&db), + &events, + ); + + Ok(()) + } + + /// This test verifies that changing a class's declaration in a non-meaningful way (e.g. by adding a comment) + /// doesn't trigger type inference for expressions that depend on the class's members. + #[test] + fn dependency_own_instance_member() -> anyhow::Result<()> { + fn x_rhs_expression(db: &TestDb) -> Expression<'_> { + let file_main = system_path_to_file(db, "/src/main.py").unwrap(); + let ast = parsed_module(db, file_main); + // Get the second statement in `main.py` (x = …) and extract the expression + // node on the right-hand side: + let x_rhs_node = &ast.syntax().body[1].as_assign_stmt().unwrap().value; + + let index = semantic_index(db, file_main); + index.expression(x_rhs_node.as_ref()) + } + + let mut db = setup_db(); + + db.write_dedented( + "/src/mod.py", + r#" + class C: + if random.choice([True, False]): + attr: int = 42 + else: + attr: None = None + "#, + )?; + db.write_dedented( + "/src/main.py", + r#" + from mod import C + x = C().attr + "#, + )?; + + let file_main = system_path_to_file(&db, "/src/main.py").unwrap(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | int | None"); + + // Change the type of `attr` to `str | None`; this should trigger the type of `x` to be re-inferred + db.write_dedented( + "/src/mod.py", + r#" + class C: + if random.choice([True, False]): + attr: str = "42" + else: + attr: None = None + "#, + )?; + + let events = { + db.clear_salsa_events(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | str | None"); + db.take_salsa_events() + }; + assert_function_query_was_run(&db, infer_expression_types, x_rhs_expression(&db), &events); + + // Add a comment; this should not trigger the type of `x` to be re-inferred + db.write_dedented( + "/src/mod.py", + r#" + class C: + # comment + if random.choice([True, False]): + attr: str = "42" + else: + attr: None = None + "#, + )?; + + let events = { + db.clear_salsa_events(); + let attr_ty = global_symbol(&db, file_main, "x").symbol.expect_type(); + assert_eq!(attr_ty.display(&db).to_string(), "Unknown | str | None"); + db.take_salsa_events() + }; + + assert_function_query_was_not_run( + &db, + infer_expression_types, + x_rhs_expression(&db), + &events, + ); + + Ok(()) + } +} diff --git a/crates/ty_python_semantic/src/types/instance.rs b/crates/ty_python_semantic/src/types/instance.rs new file mode 100644 index 0000000000000..e63a420cd1c3d --- /dev/null +++ b/crates/ty_python_semantic/src/types/instance.rs @@ -0,0 +1,407 @@ +//! Instance types: both nominal and structural. + +use std::marker::PhantomData; + +use super::protocol_class::ProtocolInterface; +use super::{ClassType, KnownClass, SubclassOfType, Type}; +use crate::symbol::{Symbol, SymbolAndQualifiers}; +use crate::types::{ClassLiteral, TypeMapping, TypeVarInstance}; +use crate::{Db, FxOrderSet}; + +pub(super) use synthesized_protocol::SynthesizedProtocolType; + +impl<'db> Type<'db> { + pub(crate) fn instance(db: &'db dyn Db, class: ClassType<'db>) -> Self { + if class.class_literal(db).0.is_protocol(db) { + Self::ProtocolInstance(ProtocolInstanceType::from_class(class)) + } else { + Self::NominalInstance(NominalInstanceType::from_class(class)) + } + } + + pub(crate) const fn into_nominal_instance(self) -> Option<NominalInstanceType<'db>> { + match self { + Type::NominalInstance(instance_type) => Some(instance_type), + _ => None, + } + } + + pub(super) fn synthesized_protocol<'a, M>(db: &'db dyn Db, members: M) -> Self + where + M: IntoIterator<Item = (&'a str, Type<'db>)>, + { + Self::ProtocolInstance(ProtocolInstanceType::synthesized( + SynthesizedProtocolType::new(db, ProtocolInterface::with_members(db, members)), + )) + } + + /// Return `true` if `self` conforms to the interface described by `protocol`. + /// + /// TODO: we may need to split this into two methods in the future, once we start + /// differentiating between fully-static and non-fully-static protocols. + pub(super) fn satisfies_protocol( + self, + db: &'db dyn Db, + protocol: ProtocolInstanceType<'db>, + ) -> bool { + // TODO: this should consider the types of the protocol members + // as well as whether each member *exists* on `self`. + protocol + .inner + .interface(db) + .members(db) + .all(|member| !self.member(db, member.name()).symbol.is_unbound()) + } +} + +/// A type representing the set of runtime objects which are instances of a certain nominal class. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, salsa::Update)] +pub struct NominalInstanceType<'db> { + pub(super) class: ClassType<'db>, + + // Keep this field private, so that the only way of constructing `NominalInstanceType` instances + // is through the `Type::instance` constructor function. + _phantom: PhantomData<()>, +} + +impl<'db> NominalInstanceType<'db> { + // Keep this method private, so that the only way of constructing `NominalInstanceType` + // instances is through the `Type::instance` constructor function. + fn from_class(class: ClassType<'db>) -> Self { + Self { + class, + _phantom: PhantomData, + } + } + + pub(super) fn normalized(self, db: &'db dyn Db) -> Self { + Self::from_class(self.class.normalized(db)) + } + + pub(super) fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + // N.B. The subclass relation is fully static + self.class.is_subclass_of(db, other.class) + } + + pub(super) fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.class.is_equivalent_to(db, other.class) + } + + pub(super) fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + self.class.is_assignable_to(db, other.class) + } + + pub(super) fn is_disjoint_from(self, db: &'db dyn Db, other: Self) -> bool { + if self.class.is_final(db) && !self.class.is_subclass_of(db, other.class) { + return true; + } + + if other.class.is_final(db) && !other.class.is_subclass_of(db, self.class) { + return true; + } + + // Check to see whether the metaclasses of `self` and `other` are disjoint. + // Avoid this check if the metaclass of either `self` or `other` is `type`, + // however, since we end up with infinite recursion in that case due to the fact + // that `type` is its own metaclass (and we know that `type` cannot be disjoint + // from any metaclass, anyway). + let type_type = KnownClass::Type.to_instance(db); + let self_metaclass = self.class.metaclass_instance_type(db); + if self_metaclass == type_type { + return false; + } + let other_metaclass = other.class.metaclass_instance_type(db); + if other_metaclass == type_type { + return false; + } + self_metaclass.is_disjoint_from(db, other_metaclass) + } + + pub(super) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.class.is_gradual_equivalent_to(db, other.class) + } + + pub(super) fn is_singleton(self, db: &'db dyn Db) -> bool { + self.class.known(db).is_some_and(KnownClass::is_singleton) + } + + pub(super) fn is_single_valued(self, db: &'db dyn Db) -> bool { + self.class + .known(db) + .is_some_and(KnownClass::is_single_valued) + } + + pub(super) fn to_meta_type(self, db: &'db dyn Db) -> Type<'db> { + SubclassOfType::from(db, self.class) + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + Self::from_class(self.class.apply_type_mapping(db, type_mapping)) + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + self.class.find_legacy_typevars(db, typevars); + } +} + +impl<'db> From<NominalInstanceType<'db>> for Type<'db> { + fn from(value: NominalInstanceType<'db>) -> Self { + Self::NominalInstance(value) + } +} + +/// A `ProtocolInstanceType` represents the set of all possible runtime objects +/// that conform to the interface described by a certain protocol. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, salsa::Update, PartialOrd, Ord)] +pub struct ProtocolInstanceType<'db> { + pub(super) inner: Protocol<'db>, + + // Keep the inner field here private, + // so that the only way of constructing `ProtocolInstanceType` instances + // is through the `Type::instance` constructor function. + _phantom: PhantomData<()>, +} + +impl<'db> ProtocolInstanceType<'db> { + // Keep this method private, so that the only way of constructing `ProtocolInstanceType` + // instances is through the `Type::instance` constructor function. + fn from_class(class: ClassType<'db>) -> Self { + Self { + inner: Protocol::FromClass(class), + _phantom: PhantomData, + } + } + + // Keep this method private, so that the only way of constructing `ProtocolInstanceType` + // instances is through the `Type::instance` constructor function. + fn synthesized(synthesized: SynthesizedProtocolType<'db>) -> Self { + Self { + inner: Protocol::Synthesized(synthesized), + _phantom: PhantomData, + } + } + + /// Return the meta-type of this protocol-instance type. + pub(super) fn to_meta_type(self, db: &'db dyn Db) -> Type<'db> { + match self.inner { + Protocol::FromClass(class) => SubclassOfType::from(db, class), + + // TODO: we can and should do better here. + // + // This is supported by mypy, and should be supported by us as well. + // We'll need to come up with a better solution for the meta-type of + // synthesized protocols to solve this: + // + // ```py + // from typing import Callable + // + // def foo(x: Callable[[], int]) -> None: + // reveal_type(type(x)) # mypy: "type[def (builtins.int) -> builtins.str]" + // reveal_type(type(x).__call__) # mypy: "def (*args: Any, **kwds: Any) -> Any" + // ``` + Protocol::Synthesized(_) => KnownClass::Type.to_instance(db), + } + } + + /// Return a "normalized" version of this `Protocol` type. + /// + /// See [`Type::normalized`] for more details. + pub(super) fn normalized(self, db: &'db dyn Db) -> Type<'db> { + let object = KnownClass::Object.to_instance(db); + if object.satisfies_protocol(db, self) { + return object; + } + match self.inner { + Protocol::FromClass(_) => Type::ProtocolInstance(Self::synthesized( + SynthesizedProtocolType::new(db, self.inner.interface(db)), + )), + Protocol::Synthesized(_) => Type::ProtocolInstance(self), + } + } + + /// Replace references to `class` with a self-reference marker + pub(super) fn replace_self_reference(self, db: &'db dyn Db, class: ClassLiteral<'db>) -> Self { + match self.inner { + Protocol::FromClass(class_type) if class_type.class_literal(db).0 == class => { + ProtocolInstanceType::synthesized(SynthesizedProtocolType::new( + db, + ProtocolInterface::SelfReference, + )) + } + _ => self, + } + } + + /// Return `true` if the types of any of the members match the closure passed in. + pub(super) fn any_over_type( + self, + db: &'db dyn Db, + type_fn: &dyn Fn(Type<'db>) -> bool, + ) -> bool { + self.inner.interface(db).any_over_type(db, type_fn) + } + + /// Return `true` if this protocol type is fully static. + pub(super) fn is_fully_static(self, db: &'db dyn Db) -> bool { + self.inner.interface(db).is_fully_static(db) + } + + /// Return `true` if this protocol type is a subtype of the protocol `other`. + pub(super) fn is_subtype_of(self, db: &'db dyn Db, other: Self) -> bool { + self.is_fully_static(db) && other.is_fully_static(db) && self.is_assignable_to(db, other) + } + + /// Return `true` if this protocol type is assignable to the protocol `other`. + /// + /// TODO: consider the types of the members as well as their existence + pub(super) fn is_assignable_to(self, db: &'db dyn Db, other: Self) -> bool { + other + .inner + .interface(db) + .is_sub_interface_of(db, self.inner.interface(db)) + } + + /// Return `true` if this protocol type is equivalent to the protocol `other`. + /// + /// TODO: consider the types of the members as well as their existence + pub(super) fn is_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.is_fully_static(db) + && other.is_fully_static(db) + && self.normalized(db) == other.normalized(db) + } + + /// Return `true` if this protocol type is gradually equivalent to the protocol `other`. + /// + /// TODO: consider the types of the members as well as their existence + pub(super) fn is_gradual_equivalent_to(self, db: &'db dyn Db, other: Self) -> bool { + self.normalized(db) == other.normalized(db) + } + + /// Return `true` if this protocol type is disjoint from the protocol `other`. + /// + /// TODO: a protocol `X` is disjoint from a protocol `Y` if `X` and `Y` + /// have a member with the same name but disjoint types + #[expect(clippy::unused_self)] + pub(super) fn is_disjoint_from(self, _db: &'db dyn Db, _other: Self) -> bool { + false + } + + pub(crate) fn instance_member(self, db: &'db dyn Db, name: &str) -> SymbolAndQualifiers<'db> { + match self.inner { + Protocol::FromClass(class) => class.instance_member(db, name), + Protocol::Synthesized(synthesized) => synthesized + .interface() + .member_by_name(db, name) + .map(|member| SymbolAndQualifiers { + symbol: Symbol::bound(member.ty()), + qualifiers: member.qualifiers(), + }) + .unwrap_or_else(|| KnownClass::Object.to_instance(db).instance_member(db, name)), + } + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + match self.inner { + Protocol::FromClass(class) => { + Self::from_class(class.apply_type_mapping(db, type_mapping)) + } + Protocol::Synthesized(synthesized) => { + Self::synthesized(synthesized.apply_type_mapping(db, type_mapping)) + } + } + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + match self.inner { + Protocol::FromClass(class) => { + class.find_legacy_typevars(db, typevars); + } + Protocol::Synthesized(synthesized) => { + synthesized.find_legacy_typevars(db, typevars); + } + } + } +} + +/// An enumeration of the two kinds of protocol types: those that originate from a class +/// definition in source code, and those that are synthesized from a set of members. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, salsa::Update, PartialOrd, Ord)] +pub(super) enum Protocol<'db> { + FromClass(ClassType<'db>), + Synthesized(SynthesizedProtocolType<'db>), +} + +impl<'db> Protocol<'db> { + /// Return the members of this protocol type + fn interface(self, db: &'db dyn Db) -> ProtocolInterface<'db> { + match self { + Self::FromClass(class) => class + .class_literal(db) + .0 + .into_protocol_class(db) + .expect("Protocol class literal should be a protocol class") + .interface(db), + Self::Synthesized(synthesized) => synthesized.interface(), + } + } +} + +mod synthesized_protocol { + use crate::types::protocol_class::ProtocolInterface; + use crate::types::{TypeMapping, TypeVarInstance}; + use crate::{Db, FxOrderSet}; + + /// A "synthesized" protocol type that is dissociated from a class definition in source code. + /// + /// Two synthesized protocol types with the same members will share the same Salsa ID, + /// making them easy to compare for equivalence. A synthesized protocol type is therefore + /// returned by [`super::ProtocolInstanceType::normalized`] so that two protocols with the same members + /// will be understood as equivalent even in the context of differently ordered unions or intersections. + /// + /// The constructor method of this type maintains the invariant that a synthesized protocol type + /// is always constructed from a *normalized* protocol interface. + #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, salsa::Update, PartialOrd, Ord)] + pub(in crate::types) struct SynthesizedProtocolType<'db>(ProtocolInterface<'db>); + + impl<'db> SynthesizedProtocolType<'db> { + pub(super) fn new(db: &'db dyn Db, interface: ProtocolInterface<'db>) -> Self { + Self(interface.normalized(db)) + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + Self(self.0.specialized_and_normalized(db, type_mapping)) + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + self.0.find_legacy_typevars(db, typevars); + } + + pub(in crate::types) fn interface(self) -> ProtocolInterface<'db> { + self.0 + } + } +} diff --git a/crates/ty_python_semantic/src/types/known_instance.rs b/crates/ty_python_semantic/src/types/known_instance.rs new file mode 100644 index 0000000000000..a310a9894187f --- /dev/null +++ b/crates/ty_python_semantic/src/types/known_instance.rs @@ -0,0 +1,452 @@ +//! The `KnownInstance` type. +//! +//! Despite its name, this is quite a different type from [`super::NominalInstanceType`]. +//! For the vast majority of instance-types in Python, we cannot say how many possible +//! inhabitants there are or could be of that type at runtime. Each variant of the +//! [`KnownInstanceType`] enum, however, represents a specific runtime symbol +//! that requires heavy special-casing in the type system. Thus any one `KnownInstance` +//! variant can only be inhabited by one or two specific objects at runtime with +//! locations that are known in advance. + +use std::fmt::Display; + +use super::generics::GenericContext; +use super::{ClassType, Truthiness, Type, TypeAliasType, TypeVarInstance, class::KnownClass}; +use crate::db::Db; +use crate::module_resolver::{KnownModule, file_to_module}; +use ruff_db::files::File; + +/// Enumeration of specific runtime symbols that are special enough +/// that they can each be considered to inhabit a unique type. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, salsa::Update)] +pub enum KnownInstanceType<'db> { + /// The symbol `typing.Annotated` (which can also be found as `typing_extensions.Annotated`) + Annotated, + /// The symbol `typing.Literal` (which can also be found as `typing_extensions.Literal`) + Literal, + /// The symbol `typing.LiteralString` (which can also be found as `typing_extensions.LiteralString`) + LiteralString, + /// The symbol `typing.Optional` (which can also be found as `typing_extensions.Optional`) + Optional, + /// The symbol `typing.Union` (which can also be found as `typing_extensions.Union`) + Union, + /// The symbol `typing.NoReturn` (which can also be found as `typing_extensions.NoReturn`) + NoReturn, + /// The symbol `typing.Never` available since 3.11 (which can also be found as `typing_extensions.Never`) + Never, + /// The symbol `typing.Tuple` (which can also be found as `typing_extensions.Tuple`) + Tuple, + /// The symbol `typing.List` (which can also be found as `typing_extensions.List`) + List, + /// The symbol `typing.Dict` (which can also be found as `typing_extensions.Dict`) + Dict, + /// The symbol `typing.Set` (which can also be found as `typing_extensions.Set`) + Set, + /// The symbol `typing.FrozenSet` (which can also be found as `typing_extensions.FrozenSet`) + FrozenSet, + /// The symbol `typing.ChainMap` (which can also be found as `typing_extensions.ChainMap`) + ChainMap, + /// The symbol `typing.Counter` (which can also be found as `typing_extensions.Counter`) + Counter, + /// The symbol `typing.DefaultDict` (which can also be found as `typing_extensions.DefaultDict`) + DefaultDict, + /// The symbol `typing.Deque` (which can also be found as `typing_extensions.Deque`) + Deque, + /// The symbol `typing.OrderedDict` (which can also be found as `typing_extensions.OrderedDict`) + OrderedDict, + /// The symbol `typing.Protocol` (which can also be found as `typing_extensions.Protocol`) + Protocol(Option<GenericContext<'db>>), + /// The symbol `typing.Generic` (which can also be found as `typing_extensions.Generic`) + Generic(Option<GenericContext<'db>>), + /// The symbol `typing.Type` (which can also be found as `typing_extensions.Type`) + Type, + /// A single instance of `typing.TypeVar` + TypeVar(TypeVarInstance<'db>), + /// A single instance of `typing.TypeAliasType` (PEP 695 type alias) + TypeAliasType(TypeAliasType<'db>), + /// The symbol `ty_extensions.Unknown` + Unknown, + /// The symbol `ty_extensions.AlwaysTruthy` + AlwaysTruthy, + /// The symbol `ty_extensions.AlwaysFalsy` + AlwaysFalsy, + /// The symbol `ty_extensions.Not` + Not, + /// The symbol `ty_extensions.Intersection` + Intersection, + /// The symbol `ty_extensions.TypeOf` + TypeOf, + /// The symbol `ty_extensions.CallableTypeOf` + CallableTypeOf, + /// The symbol `typing.Callable` + /// (which can also be found as `typing_extensions.Callable` or as `collections.abc.Callable`) + Callable, + /// The symbol `typing.Self` (which can also be found as `typing_extensions.Self`) + TypingSelf, + + // Various special forms, special aliases and type qualifiers that we don't yet understand + // (all currently inferred as TODO in most contexts): + Final, + ClassVar, + Concatenate, + Unpack, + Required, + NotRequired, + TypeAlias, + TypeGuard, + TypedDict, + TypeIs, + ReadOnly, + // TODO: fill this enum out with more special forms, etc. +} + +impl<'db> KnownInstanceType<'db> { + /// Evaluate the known instance in boolean context + pub(crate) const fn bool(self) -> Truthiness { + match self { + Self::Annotated + | Self::Literal + | Self::LiteralString + | Self::Optional + // This is a legacy `TypeVar` _outside_ of any generic class or function, so it's + // AlwaysTrue. The truthiness of a typevar inside of a generic class or function + // depends on its bounds and constraints; but that's represented by `Type::TypeVar` and + // handled in elsewhere. + | Self::TypeVar(_) + | Self::Union + | Self::NoReturn + | Self::Never + | Self::Tuple + | Self::Type + | Self::TypingSelf + | Self::Final + | Self::ClassVar + | Self::Callable + | Self::Concatenate + | Self::Unpack + | Self::Required + | Self::NotRequired + | Self::TypeAlias + | Self::TypeGuard + | Self::TypedDict + | Self::TypeIs + | Self::List + | Self::Dict + | Self::DefaultDict + | Self::Set + | Self::FrozenSet + | Self::Counter + | Self::Deque + | Self::ChainMap + | Self::OrderedDict + | Self::Protocol(_) + | Self::Generic(_) + | Self::ReadOnly + | Self::TypeAliasType(_) + | Self::Unknown + | Self::AlwaysTruthy + | Self::AlwaysFalsy + | Self::Not + | Self::Intersection + | Self::TypeOf + | Self::CallableTypeOf => Truthiness::AlwaysTrue, + } + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Self::Annotated + | Self::Literal + | Self::LiteralString + | Self::Optional + | Self::Union + | Self::NoReturn + | Self::Never + | Self::Tuple + | Self::Type + | Self::TypingSelf + | Self::Final + | Self::ClassVar + | Self::Callable + | Self::Concatenate + | Self::Unpack + | Self::Required + | Self::NotRequired + | Self::TypeAlias + | Self::TypeGuard + | Self::TypedDict + | Self::TypeIs + | Self::List + | Self::Dict + | Self::DefaultDict + | Self::Set + | Self::FrozenSet + | Self::Counter + | Self::Deque + | Self::ChainMap + | Self::OrderedDict + | Self::ReadOnly + | Self::Unknown + | Self::AlwaysTruthy + | Self::AlwaysFalsy + | Self::Not + | Self::Intersection + | Self::TypeOf + | Self::CallableTypeOf => self, + Self::TypeVar(tvar) => Self::TypeVar(tvar.normalized(db)), + Self::Protocol(ctx) => Self::Protocol(ctx.map(|ctx| ctx.normalized(db))), + Self::Generic(ctx) => Self::Generic(ctx.map(|ctx| ctx.normalized(db))), + Self::TypeAliasType(alias) => Self::TypeAliasType(alias.normalized(db)), + } + } + + /// Return the repr of the symbol at runtime + pub(crate) fn repr(self, db: &'db dyn Db) -> impl Display + 'db { + KnownInstanceRepr { + known_instance: self, + db, + } + } + + /// Return the [`KnownClass`] which this symbol is an instance of + pub(crate) const fn class(self) -> KnownClass { + match self { + Self::Annotated => KnownClass::SpecialForm, + Self::Literal => KnownClass::SpecialForm, + Self::LiteralString => KnownClass::SpecialForm, + Self::Optional => KnownClass::SpecialForm, + Self::Union => KnownClass::SpecialForm, + Self::NoReturn => KnownClass::SpecialForm, + Self::Never => KnownClass::SpecialForm, + Self::Tuple => KnownClass::SpecialForm, + Self::Type => KnownClass::SpecialForm, + Self::TypingSelf => KnownClass::SpecialForm, + Self::Final => KnownClass::SpecialForm, + Self::ClassVar => KnownClass::SpecialForm, + Self::Callable => KnownClass::SpecialForm, + Self::Concatenate => KnownClass::SpecialForm, + Self::Unpack => KnownClass::SpecialForm, + Self::Required => KnownClass::SpecialForm, + Self::NotRequired => KnownClass::SpecialForm, + Self::TypeAlias => KnownClass::SpecialForm, + Self::TypeGuard => KnownClass::SpecialForm, + Self::TypedDict => KnownClass::SpecialForm, + Self::TypeIs => KnownClass::SpecialForm, + Self::ReadOnly => KnownClass::SpecialForm, + Self::List => KnownClass::StdlibAlias, + Self::Dict => KnownClass::StdlibAlias, + Self::DefaultDict => KnownClass::StdlibAlias, + Self::Set => KnownClass::StdlibAlias, + Self::FrozenSet => KnownClass::StdlibAlias, + Self::Counter => KnownClass::StdlibAlias, + Self::Deque => KnownClass::StdlibAlias, + Self::ChainMap => KnownClass::StdlibAlias, + Self::OrderedDict => KnownClass::StdlibAlias, + Self::Protocol(_) => KnownClass::SpecialForm, // actually `_ProtocolMeta` at runtime but this is what typeshed says + Self::Generic(_) => KnownClass::SpecialForm, // actually `type` at runtime but this is what typeshed says + Self::TypeVar(_) => KnownClass::TypeVar, + Self::TypeAliasType(_) => KnownClass::TypeAliasType, + Self::TypeOf => KnownClass::SpecialForm, + Self::Not => KnownClass::SpecialForm, + Self::Intersection => KnownClass::SpecialForm, + Self::CallableTypeOf => KnownClass::SpecialForm, + Self::Unknown => KnownClass::Object, + Self::AlwaysTruthy => KnownClass::Object, + Self::AlwaysFalsy => KnownClass::Object, + } + } + + /// Return the instance type which this type is a subtype of. + /// + /// For example, the symbol `typing.Literal` is an instance of `typing._SpecialForm`, + /// so `KnownInstanceType::Literal.instance_fallback(db)` + /// returns `Type::NominalInstance(NominalInstanceType { class: <typing._SpecialForm> })`. + pub(super) fn instance_fallback(self, db: &dyn Db) -> Type { + self.class().to_instance(db) + } + + /// Return `true` if this symbol is an instance of `class`. + pub(super) fn is_instance_of(self, db: &'db dyn Db, class: ClassType<'db>) -> bool { + self.class().is_subclass_of(db, class) + } + + pub(super) fn try_from_file_and_name( + db: &'db dyn Db, + file: File, + symbol_name: &str, + ) -> Option<Self> { + let candidate = match symbol_name { + "ClassVar" => Self::ClassVar, + "Deque" => Self::Deque, + "List" => Self::List, + "Dict" => Self::Dict, + "DefaultDict" => Self::DefaultDict, + "Set" => Self::Set, + "FrozenSet" => Self::FrozenSet, + "Counter" => Self::Counter, + "ChainMap" => Self::ChainMap, + "OrderedDict" => Self::OrderedDict, + "Generic" => Self::Generic(None), + "Protocol" => Self::Protocol(None), + "Optional" => Self::Optional, + "Union" => Self::Union, + "NoReturn" => Self::NoReturn, + "Tuple" => Self::Tuple, + "Type" => Self::Type, + "Callable" => Self::Callable, + "Annotated" => Self::Annotated, + "Literal" => Self::Literal, + "Never" => Self::Never, + "Self" => Self::TypingSelf, + "Final" => Self::Final, + "Unpack" => Self::Unpack, + "Required" => Self::Required, + "TypeAlias" => Self::TypeAlias, + "TypeGuard" => Self::TypeGuard, + "TypedDict" => Self::TypedDict, + "TypeIs" => Self::TypeIs, + "ReadOnly" => Self::ReadOnly, + "Concatenate" => Self::Concatenate, + "NotRequired" => Self::NotRequired, + "LiteralString" => Self::LiteralString, + "Unknown" => Self::Unknown, + "AlwaysTruthy" => Self::AlwaysTruthy, + "AlwaysFalsy" => Self::AlwaysFalsy, + "Not" => Self::Not, + "Intersection" => Self::Intersection, + "TypeOf" => Self::TypeOf, + "CallableTypeOf" => Self::CallableTypeOf, + _ => return None, + }; + + candidate + .check_module(file_to_module(db, file)?.known()?) + .then_some(candidate) + } + + /// Return `true` if `module` is a module from which this `KnownInstance` variant can validly originate. + /// + /// Most variants can only exist in one module, which is the same as `self.class().canonical_module()`. + /// Some variants could validly be defined in either `typing` or `typing_extensions`, however. + pub(super) fn check_module(self, module: KnownModule) -> bool { + match self { + Self::ClassVar + | Self::Deque + | Self::List + | Self::Dict + | Self::DefaultDict + | Self::Set + | Self::FrozenSet + | Self::Counter + | Self::ChainMap + | Self::OrderedDict + | Self::Optional + | Self::Union + | Self::NoReturn + | Self::Tuple + | Self::Type + | Self::Generic(_) + | Self::Callable => module.is_typing(), + Self::Annotated + | Self::Protocol(_) + | Self::Literal + | Self::LiteralString + | Self::Never + | Self::TypingSelf + | Self::Final + | Self::Concatenate + | Self::Unpack + | Self::Required + | Self::NotRequired + | Self::TypeAlias + | Self::TypeGuard + | Self::TypedDict + | Self::TypeIs + | Self::ReadOnly + | Self::TypeAliasType(_) + | Self::TypeVar(_) => { + matches!(module, KnownModule::Typing | KnownModule::TypingExtensions) + } + Self::Unknown + | Self::AlwaysTruthy + | Self::AlwaysFalsy + | Self::Not + | Self::Intersection + | Self::TypeOf + | Self::CallableTypeOf => module.is_ty_extensions(), + } + } + + pub(super) fn to_meta_type(self, db: &'db dyn Db) -> Type<'db> { + self.class().to_class_literal(db) + } +} + +struct KnownInstanceRepr<'db> { + known_instance: KnownInstanceType<'db>, + db: &'db dyn Db, +} + +impl Display for KnownInstanceRepr<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self.known_instance { + KnownInstanceType::Annotated => f.write_str("typing.Annotated"), + KnownInstanceType::Literal => f.write_str("typing.Literal"), + KnownInstanceType::LiteralString => f.write_str("typing.LiteralString"), + KnownInstanceType::Optional => f.write_str("typing.Optional"), + KnownInstanceType::Union => f.write_str("typing.Union"), + KnownInstanceType::NoReturn => f.write_str("typing.NoReturn"), + KnownInstanceType::Never => f.write_str("typing.Never"), + KnownInstanceType::Tuple => f.write_str("typing.Tuple"), + KnownInstanceType::Type => f.write_str("typing.Type"), + KnownInstanceType::TypingSelf => f.write_str("typing.Self"), + KnownInstanceType::Final => f.write_str("typing.Final"), + KnownInstanceType::ClassVar => f.write_str("typing.ClassVar"), + KnownInstanceType::Callable => f.write_str("typing.Callable"), + KnownInstanceType::Concatenate => f.write_str("typing.Concatenate"), + KnownInstanceType::Unpack => f.write_str("typing.Unpack"), + KnownInstanceType::Required => f.write_str("typing.Required"), + KnownInstanceType::NotRequired => f.write_str("typing.NotRequired"), + KnownInstanceType::TypeAlias => f.write_str("typing.TypeAlias"), + KnownInstanceType::TypeGuard => f.write_str("typing.TypeGuard"), + KnownInstanceType::TypedDict => f.write_str("typing.TypedDict"), + KnownInstanceType::TypeIs => f.write_str("typing.TypeIs"), + KnownInstanceType::List => f.write_str("typing.List"), + KnownInstanceType::Dict => f.write_str("typing.Dict"), + KnownInstanceType::DefaultDict => f.write_str("typing.DefaultDict"), + KnownInstanceType::Set => f.write_str("typing.Set"), + KnownInstanceType::FrozenSet => f.write_str("typing.FrozenSet"), + KnownInstanceType::Counter => f.write_str("typing.Counter"), + KnownInstanceType::Deque => f.write_str("typing.Deque"), + KnownInstanceType::ChainMap => f.write_str("typing.ChainMap"), + KnownInstanceType::OrderedDict => f.write_str("typing.OrderedDict"), + KnownInstanceType::Protocol(generic_context) => { + f.write_str("typing.Protocol")?; + if let Some(generic_context) = generic_context { + generic_context.display(self.db).fmt(f)?; + } + Ok(()) + } + KnownInstanceType::Generic(generic_context) => { + f.write_str("typing.Generic")?; + if let Some(generic_context) = generic_context { + generic_context.display(self.db).fmt(f)?; + } + Ok(()) + } + KnownInstanceType::ReadOnly => f.write_str("typing.ReadOnly"), + // This is a legacy `TypeVar` _outside_ of any generic class or function, so we render + // it as an instance of `typing.TypeVar`. Inside of a generic class or function, we'll + // have a `Type::TypeVar(_)`, which is rendered as the typevar's name. + KnownInstanceType::TypeVar(_) => f.write_str("typing.TypeVar"), + KnownInstanceType::TypeAliasType(_) => f.write_str("typing.TypeAliasType"), + KnownInstanceType::Unknown => f.write_str("ty_extensions.Unknown"), + KnownInstanceType::AlwaysTruthy => f.write_str("ty_extensions.AlwaysTruthy"), + KnownInstanceType::AlwaysFalsy => f.write_str("ty_extensions.AlwaysFalsy"), + KnownInstanceType::Not => f.write_str("ty_extensions.Not"), + KnownInstanceType::Intersection => f.write_str("ty_extensions.Intersection"), + KnownInstanceType::TypeOf => f.write_str("ty_extensions.TypeOf"), + KnownInstanceType::CallableTypeOf => f.write_str("ty_extensions.CallableTypeOf"), + } + } +} diff --git a/crates/ty_python_semantic/src/types/mro.rs b/crates/ty_python_semantic/src/types/mro.rs new file mode 100644 index 0000000000000..151fbf69665b1 --- /dev/null +++ b/crates/ty_python_semantic/src/types/mro.rs @@ -0,0 +1,444 @@ +use std::collections::VecDeque; +use std::ops::Deref; + +use indexmap::IndexMap; +use rustc_hash::FxBuildHasher; + +use crate::Db; +use crate::types::class_base::ClassBase; +use crate::types::generics::Specialization; +use crate::types::{ClassLiteral, ClassType, Type}; + +/// The inferred method resolution order of a given class. +/// +/// An MRO cannot contain non-specialized generic classes. (This is why [`ClassBase`] contains a +/// [`ClassType`], not a [`ClassLiteral`].) Any generic classes in a base class list are always +/// specialized — either because the class is explicitly specialized if there is a subscript +/// expression, or because we create the default specialization if there isn't. +/// +/// The MRO of a non-specialized generic class can contain generic classes that are specialized +/// with a typevar from the inheriting class. When the inheriting class is specialized, the MRO of +/// the resulting generic alias will substitute those type variables accordingly. For instance, in +/// the following example, the MRO of `D[int]` includes `C[int]`, and the MRO of `D[U]` includes +/// `C[U]` (which is a generic alias, not a non-specialized generic class): +/// +/// ```py +/// class C[T]: ... +/// class D[U](C[U]): ... +/// ``` +/// +/// See [`ClassType::iter_mro`] for more details. +#[derive(PartialEq, Eq, Clone, Debug, salsa::Update)] +pub(super) struct Mro<'db>(Box<[ClassBase<'db>]>); + +impl<'db> Mro<'db> { + /// Attempt to resolve the MRO of a given class. Because we derive the MRO from the list of + /// base classes in the class definition, this operation is performed on a [class + /// literal][ClassLiteral], not a [class type][ClassType]. (You can _also_ get the MRO of a + /// class type, but this is done by first getting the MRO of the underlying class literal, and + /// specializing each base class as needed if the class type is a generic alias.) + /// + /// In the event that a possible list of bases would (or could) lead to a `TypeError` being + /// raised at runtime due to an unresolvable MRO, we infer the MRO of the class as being `[<the + /// class in question>, Unknown, object]`. This seems most likely to reduce the possibility of + /// cascading errors elsewhere. (For a generic class, the first entry in this fallback MRO uses + /// the default specialization of the class's type variables.) + /// + /// (We emit a diagnostic warning about the runtime `TypeError` in + /// [`super::infer::TypeInferenceBuilder::infer_region_scope`].) + pub(super) fn of_class( + db: &'db dyn Db, + class: ClassLiteral<'db>, + specialization: Option<Specialization<'db>>, + ) -> Result<Self, MroError<'db>> { + Self::of_class_impl(db, class, specialization).map_err(|err| { + err.into_mro_error(db, class.apply_optional_specialization(db, specialization)) + }) + } + + pub(super) fn from_error(db: &'db dyn Db, class: ClassType<'db>) -> Self { + Self::from([ + ClassBase::Class(class), + ClassBase::unknown(), + ClassBase::object(db), + ]) + } + + fn of_class_impl( + db: &'db dyn Db, + class: ClassLiteral<'db>, + specialization: Option<Specialization<'db>>, + ) -> Result<Self, MroErrorKind<'db>> { + let class_type = class.apply_optional_specialization(db, specialization); + + match class.explicit_bases(db) { + // `builtins.object` is the special case: + // the only class in Python that has an MRO with length <2 + [] if class.is_object(db) => Ok(Self::from([ + // object is not generic, so the default specialization should be a no-op + ClassBase::Class(class_type), + ])), + + // All other classes in Python have an MRO with length >=2. + // Even if a class has no explicit base classes, + // it will implicitly inherit from `object` at runtime; + // `object` will appear in the class's `__bases__` list and `__mro__`: + // + // ```pycon + // >>> class Foo: ... + // ... + // >>> Foo.__bases__ + // (<class 'object'>,) + // >>> Foo.__mro__ + // (<class '__main__.Foo'>, <class 'object'>) + // ``` + [] => Ok(Self::from([ + ClassBase::Class(class_type), + ClassBase::object(db), + ])), + + // Fast path for a class that has only a single explicit base. + // + // This *could* theoretically be handled by the final branch below, + // but it's a common case (i.e., worth optimizing for), + // and the `c3_merge` function requires lots of allocations. + [single_base] => ClassBase::try_from_type(db, *single_base).map_or_else( + || Err(MroErrorKind::InvalidBases(Box::from([(0, *single_base)]))), + |single_base| { + if single_base.has_cyclic_mro(db) { + Err(MroErrorKind::InheritanceCycle) + } else { + Ok(std::iter::once(ClassBase::Class( + class.apply_optional_specialization(db, specialization), + )) + .chain(single_base.mro(db, specialization)) + .collect()) + } + }, + ), + + // The class has multiple explicit bases. + // + // We'll fallback to a full implementation of the C3-merge algorithm to determine + // what MRO Python will give this class at runtime + // (if an MRO is indeed resolvable at all!) + multiple_bases => { + let mut valid_bases = vec![]; + let mut invalid_bases = vec![]; + + for (i, base) in multiple_bases.iter().enumerate() { + match ClassBase::try_from_type(db, *base) { + Some(valid_base) => valid_bases.push(valid_base), + None => invalid_bases.push((i, *base)), + } + } + + if !invalid_bases.is_empty() { + return Err(MroErrorKind::InvalidBases(invalid_bases.into_boxed_slice())); + } + + let mut seqs = vec![VecDeque::from([ClassBase::Class(class_type)])]; + for base in &valid_bases { + if base.has_cyclic_mro(db) { + return Err(MroErrorKind::InheritanceCycle); + } + seqs.push(base.mro(db, specialization).collect()); + } + seqs.push( + valid_bases + .iter() + .map(|base| base.apply_optional_specialization(db, specialization)) + .collect(), + ); + + if let Some(mro) = c3_merge(seqs) { + return Ok(mro); + } + + let mut duplicate_dynamic_bases = false; + + let duplicate_bases: Vec<DuplicateBaseError<'db>> = { + let mut base_to_indices: IndexMap<ClassBase<'db>, Vec<usize>, FxBuildHasher> = + IndexMap::default(); + + for (index, base) in valid_bases.iter().enumerate() { + base_to_indices.entry(*base).or_default().push(index); + } + + let mut errors = vec![]; + + for (base, indices) in base_to_indices { + let Some((first_index, later_indices)) = indices.split_first() else { + continue; + }; + if later_indices.is_empty() { + continue; + } + match base { + ClassBase::Class(_) + | ClassBase::Generic(_) + | ClassBase::Protocol(_) => { + errors.push(DuplicateBaseError { + duplicate_base: base, + first_index: *first_index, + later_indices: later_indices.iter().copied().collect(), + }); + } + ClassBase::Dynamic(_) => duplicate_dynamic_bases = true, + } + } + + errors + }; + + if duplicate_bases.is_empty() { + if duplicate_dynamic_bases { + Ok(Mro::from_error( + db, + class.apply_optional_specialization(db, specialization), + )) + } else { + Err(MroErrorKind::UnresolvableMro { + bases_list: valid_bases.into_boxed_slice(), + }) + } + } else { + Err(MroErrorKind::DuplicateBases( + duplicate_bases.into_boxed_slice(), + )) + } + } + } + } +} + +impl<'db, const N: usize> From<[ClassBase<'db>; N]> for Mro<'db> { + fn from(value: [ClassBase<'db>; N]) -> Self { + Self(Box::from(value)) + } +} + +impl<'db> From<Vec<ClassBase<'db>>> for Mro<'db> { + fn from(value: Vec<ClassBase<'db>>) -> Self { + Self(value.into_boxed_slice()) + } +} + +impl<'db> Deref for Mro<'db> { + type Target = [ClassBase<'db>]; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl<'db> FromIterator<ClassBase<'db>> for Mro<'db> { + fn from_iter<T: IntoIterator<Item = ClassBase<'db>>>(iter: T) -> Self { + Self(iter.into_iter().collect()) + } +} + +/// Iterator that yields elements of a class's MRO. +/// +/// We avoid materialising the *full* MRO unless it is actually necessary: +/// - Materialising the full MRO is expensive +/// - We need to do it for every class in the code that we're checking, as we need to make sure +/// that there are no class definitions in the code we're checking that would cause an +/// exception to be raised at runtime. But the same does *not* necessarily apply for every class +/// in third-party and stdlib dependencies: we never emit diagnostics about non-first-party code. +/// - However, we *do* need to resolve attribute accesses on classes/instances from +/// third-party and stdlib dependencies. That requires iterating over the MRO of third-party/stdlib +/// classes, but not necessarily the *whole* MRO: often just the first element is enough. +/// Luckily we know that for any class `X`, the first element of `X`'s MRO will always be `X` itself. +/// We can therefore avoid resolving the full MRO for many third-party/stdlib classes while still +/// being faithful to the runtime semantics. +/// +/// Even for first-party code, where we will have to resolve the MRO for every class we encounter, +/// loading the cached MRO comes with a certain amount of overhead, so it's best to avoid calling the +/// Salsa-tracked [`ClassLiteral::try_mro`] method unless it's absolutely necessary. +pub(super) struct MroIterator<'db> { + db: &'db dyn Db, + + /// The class whose MRO we're iterating over + class: ClassLiteral<'db>, + + /// The specialization to apply to each MRO element, if any + specialization: Option<Specialization<'db>>, + + /// Whether or not we've already yielded the first element of the MRO + first_element_yielded: bool, + + /// Iterator over all elements of the MRO except the first. + /// + /// The full MRO is expensive to materialize, so this field is `None` + /// unless we actually *need* to iterate past the first element of the MRO, + /// at which point it is lazily materialized. + subsequent_elements: Option<std::slice::Iter<'db, ClassBase<'db>>>, +} + +impl<'db> MroIterator<'db> { + pub(super) fn new( + db: &'db dyn Db, + class: ClassLiteral<'db>, + specialization: Option<Specialization<'db>>, + ) -> Self { + Self { + db, + class, + specialization, + first_element_yielded: false, + subsequent_elements: None, + } + } + + /// Materialize the full MRO of the class. + /// Return an iterator over that MRO which skips the first element of the MRO. + fn full_mro_except_first_element(&mut self) -> impl Iterator<Item = ClassBase<'db>> + '_ { + self.subsequent_elements + .get_or_insert_with(|| { + let mut full_mro_iter = match self.class.try_mro(self.db, self.specialization) { + Ok(mro) => mro.iter(), + Err(error) => error.fallback_mro().iter(), + }; + full_mro_iter.next(); + full_mro_iter + }) + .copied() + } +} + +impl<'db> Iterator for MroIterator<'db> { + type Item = ClassBase<'db>; + + fn next(&mut self) -> Option<Self::Item> { + if !self.first_element_yielded { + self.first_element_yielded = true; + return Some(ClassBase::Class( + self.class + .apply_optional_specialization(self.db, self.specialization), + )); + } + self.full_mro_except_first_element().next() + } +} + +impl std::iter::FusedIterator for MroIterator<'_> {} + +#[derive(Debug, PartialEq, Eq, salsa::Update)] +pub(super) struct MroError<'db> { + kind: MroErrorKind<'db>, + fallback_mro: Mro<'db>, +} + +impl<'db> MroError<'db> { + /// Construct an MRO error of kind `InheritanceCycle`. + pub(super) fn cycle(db: &'db dyn Db, class: ClassType<'db>) -> Self { + MroErrorKind::InheritanceCycle.into_mro_error(db, class) + } + + pub(super) fn is_cycle(&self) -> bool { + matches!(self.kind, MroErrorKind::InheritanceCycle) + } + + /// Return an [`MroErrorKind`] variant describing why we could not resolve the MRO for this class. + pub(super) fn reason(&self) -> &MroErrorKind<'db> { + &self.kind + } + + /// Return the fallback MRO we should infer for this class during type inference + /// (since accurate resolution of its "true" MRO was impossible) + pub(super) fn fallback_mro(&self) -> &Mro<'db> { + &self.fallback_mro + } +} + +/// Possible ways in which attempting to resolve the MRO of a class might fail. +#[derive(Debug, PartialEq, Eq, salsa::Update)] +pub(super) enum MroErrorKind<'db> { + /// The class inherits from one or more invalid bases. + /// + /// To avoid excessive complexity in our implementation, + /// we only permit classes to inherit from class-literal types, + /// `Todo`, `Unknown` or `Any`. Anything else results in us + /// emitting a diagnostic. + /// + /// This variant records the indices and types of class bases + /// that we deem to be invalid. The indices are the indices of nodes + /// in the bases list of the class's [`StmtClassDef`](ruff_python_ast::StmtClassDef) node. + /// Each index is the index of a node representing an invalid base. + InvalidBases(Box<[(usize, Type<'db>)]>), + + /// The class has one or more duplicate bases. + /// See [`DuplicateBaseError`] for more details. + DuplicateBases(Box<[DuplicateBaseError<'db>]>), + + /// A cycle was encountered resolving the class' bases. + InheritanceCycle, + + /// The MRO is otherwise unresolvable through the C3-merge algorithm. + /// + /// See [`c3_merge`] for more details. + UnresolvableMro { bases_list: Box<[ClassBase<'db>]> }, +} + +impl<'db> MroErrorKind<'db> { + pub(super) fn into_mro_error(self, db: &'db dyn Db, class: ClassType<'db>) -> MroError<'db> { + MroError { + kind: self, + fallback_mro: Mro::from_error(db, class), + } + } +} + +/// Error recording the fact that a class definition was found to have duplicate bases. +#[derive(Debug, PartialEq, Eq, salsa::Update)] +pub(super) struct DuplicateBaseError<'db> { + /// The base that is duplicated in the class's bases list. + pub(super) duplicate_base: ClassBase<'db>, + /// The index of the first occurrence of the base in the class's bases list. + pub(super) first_index: usize, + /// The indices of the base's later occurrences in the class's bases list. + pub(super) later_indices: Box<[usize]>, +} + +/// Implementation of the [C3-merge algorithm] for calculating a Python class's +/// [method resolution order]. +/// +/// [C3-merge algorithm]: https://docs.python.org/3/howto/mro.html#python-2-3-mro +/// [method resolution order]: https://docs.python.org/3/glossary.html#term-method-resolution-order +fn c3_merge(mut sequences: Vec<VecDeque<ClassBase>>) -> Option<Mro> { + // Most MROs aren't that long... + let mut mro = Vec::with_capacity(8); + + loop { + sequences.retain(|sequence| !sequence.is_empty()); + + if sequences.is_empty() { + return Some(Mro::from(mro)); + } + + // If the candidate exists "deeper down" in the inheritance hierarchy, + // we should refrain from adding it to the MRO for now. Add the first candidate + // for which this does not hold true. If this holds true for all candidates, + // return `None`; it will be impossible to find a consistent MRO for the class + // with the given bases. + let mro_entry = sequences.iter().find_map(|outer_sequence| { + let candidate = outer_sequence[0]; + + let not_head = sequences + .iter() + .all(|sequence| sequence.iter().skip(1).all(|base| base != &candidate)); + + not_head.then_some(candidate) + })?; + + mro.push(mro_entry); + + // Make sure we don't try to add the candidate to the MRO twice: + for sequence in &mut sequences { + if sequence[0] == mro_entry { + sequence.pop_front(); + } + } + } +} diff --git a/crates/ty_python_semantic/src/types/narrow.rs b/crates/ty_python_semantic/src/types/narrow.rs new file mode 100644 index 0000000000000..303885c32049a --- /dev/null +++ b/crates/ty_python_semantic/src/types/narrow.rs @@ -0,0 +1,876 @@ +use crate::Db; +use crate::semantic_index::ast_ids::HasScopedExpressionId; +use crate::semantic_index::expression::Expression; +use crate::semantic_index::predicate::{ + PatternPredicate, PatternPredicateKind, Predicate, PredicateNode, +}; +use crate::semantic_index::symbol::{ScopeId, ScopedSymbolId, SymbolTable}; +use crate::semantic_index::symbol_table; +use crate::types::infer::infer_same_file_expression_type; +use crate::types::{ + IntersectionBuilder, KnownClass, SubclassOfType, Truthiness, Type, UnionBuilder, + infer_expression_types, +}; + +use ruff_python_stdlib::identifiers::is_identifier; + +use itertools::Itertools; +use ruff_python_ast as ast; +use ruff_python_ast::{BoolOp, ExprBoolOp}; +use rustc_hash::FxHashMap; +use std::collections::hash_map::Entry; + +use super::{KnownFunction, UnionType}; + +/// Return the type constraint that `test` (if true) would place on `symbol`, if any. +/// +/// For example, if we have this code: +/// +/// ```python +/// y = 1 if flag else None +/// x = 1 if flag else None +/// if x is not None: +/// ... +/// ``` +/// +/// The `test` expression `x is not None` places the constraint "not None" on the definition of +/// `x`, so in that case we'd return `Some(Type::Intersection(negative=[Type::None]))`. +/// +/// But if we called this with the same `test` expression, but the `symbol` of `y`, no +/// constraint is applied to that symbol, so we'd just return `None`. +pub(crate) fn infer_narrowing_constraint<'db>( + db: &'db dyn Db, + predicate: Predicate<'db>, + symbol: ScopedSymbolId, +) -> Option<Type<'db>> { + let constraints = match predicate.node { + PredicateNode::Expression(expression) => { + if predicate.is_positive { + all_narrowing_constraints_for_expression(db, expression) + } else { + all_negative_narrowing_constraints_for_expression(db, expression) + } + } + PredicateNode::Pattern(pattern) => { + if predicate.is_positive { + all_narrowing_constraints_for_pattern(db, pattern) + } else { + all_negative_narrowing_constraints_for_pattern(db, pattern) + } + } + PredicateNode::StarImportPlaceholder(_) => return None, + }; + if let Some(constraints) = constraints { + constraints.get(&symbol).copied() + } else { + None + } +} + +#[salsa::tracked(returns(as_ref))] +fn all_narrowing_constraints_for_pattern<'db>( + db: &'db dyn Db, + pattern: PatternPredicate<'db>, +) -> Option<NarrowingConstraints<'db>> { + NarrowingConstraintsBuilder::new(db, PredicateNode::Pattern(pattern), true).finish() +} + +#[salsa::tracked( + returns(as_ref), + cycle_fn=constraints_for_expression_cycle_recover, + cycle_initial=constraints_for_expression_cycle_initial, +)] +fn all_narrowing_constraints_for_expression<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> Option<NarrowingConstraints<'db>> { + NarrowingConstraintsBuilder::new(db, PredicateNode::Expression(expression), true).finish() +} + +#[salsa::tracked( + returns(as_ref), + cycle_fn=negative_constraints_for_expression_cycle_recover, + cycle_initial=negative_constraints_for_expression_cycle_initial, +)] +fn all_negative_narrowing_constraints_for_expression<'db>( + db: &'db dyn Db, + expression: Expression<'db>, +) -> Option<NarrowingConstraints<'db>> { + NarrowingConstraintsBuilder::new(db, PredicateNode::Expression(expression), false).finish() +} + +#[salsa::tracked(returns(as_ref))] +fn all_negative_narrowing_constraints_for_pattern<'db>( + db: &'db dyn Db, + pattern: PatternPredicate<'db>, +) -> Option<NarrowingConstraints<'db>> { + NarrowingConstraintsBuilder::new(db, PredicateNode::Pattern(pattern), false).finish() +} + +#[expect(clippy::ref_option)] +fn constraints_for_expression_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Option<NarrowingConstraints<'db>>, + _count: u32, + _expression: Expression<'db>, +) -> salsa::CycleRecoveryAction<Option<NarrowingConstraints<'db>>> { + salsa::CycleRecoveryAction::Iterate +} + +fn constraints_for_expression_cycle_initial<'db>( + _db: &'db dyn Db, + _expression: Expression<'db>, +) -> Option<NarrowingConstraints<'db>> { + None +} + +#[expect(clippy::ref_option)] +fn negative_constraints_for_expression_cycle_recover<'db>( + _db: &'db dyn Db, + _value: &Option<NarrowingConstraints<'db>>, + _count: u32, + _expression: Expression<'db>, +) -> salsa::CycleRecoveryAction<Option<NarrowingConstraints<'db>>> { + salsa::CycleRecoveryAction::Iterate +} + +fn negative_constraints_for_expression_cycle_initial<'db>( + _db: &'db dyn Db, + _expression: Expression<'db>, +) -> Option<NarrowingConstraints<'db>> { + None +} + +/// Functions that can be used to narrow the type of a first argument using a "classinfo" second argument. +/// +/// A "classinfo" argument is either a class or a tuple of classes, or a tuple of tuples of classes +/// (etc. for arbitrary levels of recursion) +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum ClassInfoConstraintFunction { + /// `builtins.isinstance` + IsInstance, + /// `builtins.issubclass` + IsSubclass, +} + +impl ClassInfoConstraintFunction { + /// Generate a constraint from the type of a `classinfo` argument to `isinstance` or `issubclass`. + /// + /// The `classinfo` argument can be a class literal, a tuple of (tuples of) class literals. PEP 604 + /// union types are not yet supported. Returns `None` if the `classinfo` argument has a wrong type. + fn generate_constraint<'db>(self, db: &'db dyn Db, classinfo: Type<'db>) -> Option<Type<'db>> { + let constraint_fn = |class| match self { + ClassInfoConstraintFunction::IsInstance => Type::instance(db, class), + ClassInfoConstraintFunction::IsSubclass => SubclassOfType::from(db, class), + }; + + match classinfo { + Type::Tuple(tuple) => { + let mut builder = UnionBuilder::new(db); + for element in tuple.elements(db) { + builder = builder.add(self.generate_constraint(db, *element)?); + } + Some(builder.build()) + } + Type::ClassLiteral(class_literal) => { + // At runtime (on Python 3.11+), this will return `True` for classes that actually + // do inherit `typing.Any` and `False` otherwise. We could accurately model that? + if class_literal.is_known(db, KnownClass::Any) { + None + } else { + Some(constraint_fn(class_literal.default_specialization(db))) + } + } + Type::SubclassOf(subclass_of_ty) => { + subclass_of_ty.subclass_of().into_class().map(constraint_fn) + } + _ => None, + } + } +} + +type NarrowingConstraints<'db> = FxHashMap<ScopedSymbolId, Type<'db>>; + +fn merge_constraints_and<'db>( + into: &mut NarrowingConstraints<'db>, + from: NarrowingConstraints<'db>, + db: &'db dyn Db, +) { + for (key, value) in from { + match into.entry(key) { + Entry::Occupied(mut entry) => { + *entry.get_mut() = IntersectionBuilder::new(db) + .add_positive(*entry.get()) + .add_positive(value) + .build(); + } + Entry::Vacant(entry) => { + entry.insert(value); + } + } + } +} + +fn merge_constraints_or<'db>( + into: &mut NarrowingConstraints<'db>, + from: &NarrowingConstraints<'db>, + db: &'db dyn Db, +) { + for (key, value) in from { + match into.entry(*key) { + Entry::Occupied(mut entry) => { + *entry.get_mut() = UnionBuilder::new(db).add(*entry.get()).add(*value).build(); + } + Entry::Vacant(entry) => { + entry.insert(Type::object(db)); + } + } + } + for (key, value) in into.iter_mut() { + if !from.contains_key(key) { + *value = Type::object(db); + } + } +} + +fn negate_if<'db>(constraints: &mut NarrowingConstraints<'db>, db: &'db dyn Db, yes: bool) { + for (_symbol, ty) in constraints.iter_mut() { + *ty = ty.negate_if(db, yes); + } +} + +fn expr_name(expr: &ast::Expr) -> Option<&ast::name::Name> { + match expr { + ast::Expr::Named(ast::ExprNamed { target, .. }) => match target.as_ref() { + ast::Expr::Name(ast::ExprName { id, .. }) => Some(id), + _ => None, + }, + ast::Expr::Name(ast::ExprName { id, .. }) => Some(id), + _ => None, + } +} + +struct NarrowingConstraintsBuilder<'db> { + db: &'db dyn Db, + predicate: PredicateNode<'db>, + is_positive: bool, +} + +impl<'db> NarrowingConstraintsBuilder<'db> { + fn new(db: &'db dyn Db, predicate: PredicateNode<'db>, is_positive: bool) -> Self { + Self { + db, + predicate, + is_positive, + } + } + + fn finish(mut self) -> Option<NarrowingConstraints<'db>> { + let constraints: Option<NarrowingConstraints<'db>> = match self.predicate { + PredicateNode::Expression(expression) => { + self.evaluate_expression_predicate(expression, self.is_positive) + } + PredicateNode::Pattern(pattern) => { + self.evaluate_pattern_predicate(pattern, self.is_positive) + } + PredicateNode::StarImportPlaceholder(_) => return None, + }; + if let Some(mut constraints) = constraints { + constraints.shrink_to_fit(); + Some(constraints) + } else { + None + } + } + + fn evaluate_expression_predicate( + &mut self, + expression: Expression<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + let expression_node = expression.node_ref(self.db); + self.evaluate_expression_node_predicate(expression_node, expression, is_positive) + } + + fn evaluate_expression_node_predicate( + &mut self, + expression_node: &ruff_python_ast::Expr, + expression: Expression<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + match expression_node { + ast::Expr::Name(name) => Some(self.evaluate_expr_name(name, is_positive)), + ast::Expr::Compare(expr_compare) => { + self.evaluate_expr_compare(expr_compare, expression, is_positive) + } + ast::Expr::Call(expr_call) => { + self.evaluate_expr_call(expr_call, expression, is_positive) + } + ast::Expr::UnaryOp(unary_op) if unary_op.op == ast::UnaryOp::Not => { + self.evaluate_expression_node_predicate(&unary_op.operand, expression, !is_positive) + } + ast::Expr::BoolOp(bool_op) => self.evaluate_bool_op(bool_op, expression, is_positive), + ast::Expr::Named(expr_named) => self.evaluate_expr_named(expr_named, is_positive), + _ => None, + } + } + + fn evaluate_pattern_predicate_kind( + &mut self, + pattern_predicate_kind: &PatternPredicateKind<'db>, + subject: Expression<'db>, + ) -> Option<NarrowingConstraints<'db>> { + match pattern_predicate_kind { + PatternPredicateKind::Singleton(singleton) => { + self.evaluate_match_pattern_singleton(subject, *singleton) + } + PatternPredicateKind::Class(cls) => self.evaluate_match_pattern_class(subject, *cls), + PatternPredicateKind::Value(expr) => self.evaluate_match_pattern_value(subject, *expr), + PatternPredicateKind::Or(predicates) => { + self.evaluate_match_pattern_or(subject, predicates) + } + PatternPredicateKind::Unsupported => None, + } + } + + fn evaluate_pattern_predicate( + &mut self, + pattern: PatternPredicate<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + let subject = pattern.subject(self.db); + self.evaluate_pattern_predicate_kind(pattern.kind(self.db), subject) + .map(|mut constraints| { + negate_if(&mut constraints, self.db, !is_positive); + constraints + }) + } + + fn symbols(&self) -> &'db SymbolTable { + symbol_table(self.db, self.scope()) + } + + fn scope(&self) -> ScopeId<'db> { + match self.predicate { + PredicateNode::Expression(expression) => expression.scope(self.db), + PredicateNode::Pattern(pattern) => pattern.scope(self.db), + PredicateNode::StarImportPlaceholder(definition) => definition.scope(self.db), + } + } + + #[track_caller] + fn expect_expr_name_symbol(&self, symbol: &str) -> ScopedSymbolId { + self.symbols() + .symbol_id_by_name(symbol) + .expect("We should always have a symbol for every `Name` node") + } + + fn evaluate_expr_name( + &mut self, + expr_name: &ast::ExprName, + is_positive: bool, + ) -> NarrowingConstraints<'db> { + let ast::ExprName { id, .. } = expr_name; + + let symbol = self.expect_expr_name_symbol(id); + + let ty = if is_positive { + Type::AlwaysFalsy.negate(self.db) + } else { + Type::AlwaysTruthy.negate(self.db) + }; + + NarrowingConstraints::from_iter([(symbol, ty)]) + } + + fn evaluate_expr_named( + &mut self, + expr_named: &ast::ExprNamed, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + if let ast::Expr::Name(expr_name) = expr_named.target.as_ref() { + Some(self.evaluate_expr_name(expr_name, is_positive)) + } else { + None + } + } + + fn evaluate_expr_eq(&mut self, lhs_ty: Type<'db>, rhs_ty: Type<'db>) -> Option<Type<'db>> { + // We can only narrow on equality checks against single-valued types. + if rhs_ty.is_single_valued(self.db) || rhs_ty.is_union_of_single_valued(self.db) { + // The fully-general (and more efficient) approach here would be to introduce a + // `NeverEqualTo` type that can wrap a single-valued type, and then simply return + // `~NeverEqualTo(rhs_ty)` here and let union/intersection builder sort it out. This is + // how we handle `AlwaysTruthy` and `AlwaysFalsy`. But this means we have to deal with + // this type everywhere, and possibly have it show up unsimplified in some cases, and + // so we instead prefer to just do the simplification here. (Another hybrid option that + // would be similar to this, but more efficient, would be to allow narrowing to return + // something that is not a type, and handle this not-a-type in `symbol_from_bindings`, + // instead of intersecting with a type.) + + // Return `true` if it is possible for any two inhabitants of the given types to + // compare equal to each other; otherwise return `false`. + fn could_compare_equal<'db>( + db: &'db dyn Db, + left_ty: Type<'db>, + right_ty: Type<'db>, + ) -> bool { + if !left_ty.is_disjoint_from(db, right_ty) { + // If types overlap, they have inhabitants in common; it's definitely possible + // for an object to compare equal to itself. + return true; + } + match (left_ty, right_ty) { + // In order to be sure a union type cannot compare equal to another type, it + // must be true that no element of the union can compare equal to that type. + (Type::Union(union), _) => union + .elements(db) + .iter() + .any(|ty| could_compare_equal(db, *ty, right_ty)), + (_, Type::Union(union)) => union + .elements(db) + .iter() + .any(|ty| could_compare_equal(db, left_ty, *ty)), + // Boolean literals and int literals are disjoint, and single valued, and yet + // `True == 1` and `False == 0`. + (Type::BooleanLiteral(b), Type::IntLiteral(i)) + | (Type::IntLiteral(i), Type::BooleanLiteral(b)) => i64::from(b) == i, + // Other than the above cases, two single-valued disjoint types cannot compare + // equal. + _ => !(left_ty.is_single_valued(db) && right_ty.is_single_valued(db)), + } + } + + // Return `true` if `lhs_ty` consists only of `LiteralString` and types that cannot + // compare equal to `rhs_ty`. + fn can_narrow_to_rhs<'db>( + db: &'db dyn Db, + lhs_ty: Type<'db>, + rhs_ty: Type<'db>, + ) -> bool { + match lhs_ty { + Type::Union(union) => union + .elements(db) + .iter() + .all(|ty| can_narrow_to_rhs(db, *ty, rhs_ty)), + // Either `rhs_ty` is a string literal, in which case we can narrow to it (no + // other string literal could compare equal to it), or it is not a string + // literal, in which case (given that it is single-valued), LiteralString + // cannot compare equal to it. + Type::LiteralString => true, + _ => !could_compare_equal(db, lhs_ty, rhs_ty), + } + } + + // Filter `ty` to just the types that cannot be equal to `rhs_ty`. + fn filter_to_cannot_be_equal<'db>( + db: &'db dyn Db, + ty: Type<'db>, + rhs_ty: Type<'db>, + ) -> Type<'db> { + match ty { + Type::Union(union) => { + union.map(db, |ty| filter_to_cannot_be_equal(db, *ty, rhs_ty)) + } + // Treat `bool` as `Literal[True, False]`. + Type::NominalInstance(instance) + if instance.class.is_known(db, KnownClass::Bool) => + { + UnionType::from_elements( + db, + [Type::BooleanLiteral(true), Type::BooleanLiteral(false)] + .into_iter() + .map(|ty| filter_to_cannot_be_equal(db, ty, rhs_ty)), + ) + } + _ => { + if ty.is_single_valued(db) && !could_compare_equal(db, ty, rhs_ty) { + ty + } else { + Type::Never + } + } + } + } + Some(if can_narrow_to_rhs(self.db, lhs_ty, rhs_ty) { + rhs_ty + } else { + filter_to_cannot_be_equal(self.db, lhs_ty, rhs_ty).negate(self.db) + }) + } else { + None + } + } + + fn evaluate_expr_ne(&mut self, lhs_ty: Type<'db>, rhs_ty: Type<'db>) -> Option<Type<'db>> { + match (lhs_ty, rhs_ty) { + (Type::NominalInstance(instance), Type::IntLiteral(i)) + if instance.class.is_known(self.db, KnownClass::Bool) => + { + if i == 0 { + Some(Type::BooleanLiteral(false).negate(self.db)) + } else if i == 1 { + Some(Type::BooleanLiteral(true).negate(self.db)) + } else { + None + } + } + (_, Type::BooleanLiteral(b)) => Some( + UnionType::from_elements(self.db, [rhs_ty, Type::IntLiteral(i64::from(b))]) + .negate(self.db), + ), + _ if rhs_ty.is_single_valued(self.db) => Some(rhs_ty.negate(self.db)), + _ => None, + } + } + + fn evaluate_expr_in(&mut self, lhs_ty: Type<'db>, rhs_ty: Type<'db>) -> Option<Type<'db>> { + if lhs_ty.is_single_valued(self.db) || lhs_ty.is_union_of_single_valued(self.db) { + match rhs_ty { + Type::Tuple(rhs_tuple) => Some(UnionType::from_elements( + self.db, + rhs_tuple.elements(self.db), + )), + + Type::StringLiteral(string_literal) => Some(UnionType::from_elements( + self.db, + string_literal + .iter_each_char(self.db) + .map(Type::StringLiteral), + )), + + _ => None, + } + } else { + None + } + } + + fn evaluate_expr_compare_op( + &mut self, + lhs_ty: Type<'db>, + rhs_ty: Type<'db>, + op: ast::CmpOp, + ) -> Option<Type<'db>> { + match op { + ast::CmpOp::IsNot => { + if rhs_ty.is_singleton(self.db) { + let ty = IntersectionBuilder::new(self.db) + .add_negative(rhs_ty) + .build(); + Some(ty) + } else { + // Non-singletons cannot be safely narrowed using `is not` + None + } + } + ast::CmpOp::Is => Some(rhs_ty), + ast::CmpOp::Eq => self.evaluate_expr_eq(lhs_ty, rhs_ty), + ast::CmpOp::NotEq => self.evaluate_expr_ne(lhs_ty, rhs_ty), + ast::CmpOp::In => self.evaluate_expr_in(lhs_ty, rhs_ty), + ast::CmpOp::NotIn => self + .evaluate_expr_in(lhs_ty, rhs_ty) + .map(|ty| ty.negate(self.db)), + _ => None, + } + } + + fn evaluate_expr_compare( + &mut self, + expr_compare: &ast::ExprCompare, + expression: Expression<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + fn is_narrowing_target_candidate(expr: &ast::Expr) -> bool { + matches!( + expr, + ast::Expr::Name(_) | ast::Expr::Call(_) | ast::Expr::Named(_) + ) + } + + let ast::ExprCompare { + range: _, + left, + ops, + comparators, + } = expr_compare; + + // Performance optimization: early return if there are no potential narrowing targets. + if !is_narrowing_target_candidate(left) + && comparators + .iter() + .all(|c| !is_narrowing_target_candidate(c)) + { + return None; + } + + if !is_positive && comparators.len() > 1 { + // We can't negate a constraint made by a multi-comparator expression, since we can't + // know which comparison part is the one being negated. + // For example, the negation of `x is 1 is y is 2`, would be `(x is not 1) or (y is not 1) or (y is not 2)` + // and that requires cross-symbol constraints, which we don't support yet. + return None; + } + let scope = self.scope(); + let inference = infer_expression_types(self.db, expression); + + let comparator_tuples = std::iter::once(&**left) + .chain(comparators) + .tuple_windows::<(&ruff_python_ast::Expr, &ruff_python_ast::Expr)>(); + let mut constraints = NarrowingConstraints::default(); + + let mut last_rhs_ty: Option<Type> = None; + + for (op, (left, right)) in std::iter::zip(&**ops, comparator_tuples) { + let lhs_ty = last_rhs_ty.unwrap_or_else(|| { + inference.expression_type(left.scoped_expression_id(self.db, scope)) + }); + let rhs_ty = inference.expression_type(right.scoped_expression_id(self.db, scope)); + last_rhs_ty = Some(rhs_ty); + + match left { + ast::Expr::Name(_) | ast::Expr::Named(_) => { + if let Some(id) = expr_name(left) { + let symbol = self.expect_expr_name_symbol(id); + let op = if is_positive { *op } else { op.negate() }; + + if let Some(ty) = self.evaluate_expr_compare_op(lhs_ty, rhs_ty, op) { + constraints.insert(symbol, ty); + } + } + } + ast::Expr::Call(ast::ExprCall { + range: _, + func: callable, + arguments: + ast::Arguments { + args, + keywords, + range: _, + }, + }) if keywords.is_empty() => { + let rhs_class = match rhs_ty { + Type::ClassLiteral(class) => class, + Type::GenericAlias(alias) => alias.origin(self.db), + _ => { + continue; + } + }; + + let id = match &**args { + [first] => match expr_name(first) { + Some(id) => id, + None => continue, + }, + _ => continue, + }; + + let is_valid_constraint = if is_positive { + op == &ast::CmpOp::Is + } else { + op == &ast::CmpOp::IsNot + }; + + if !is_valid_constraint { + continue; + } + + let callable_type = + inference.expression_type(callable.scoped_expression_id(self.db, scope)); + + if callable_type + .into_class_literal() + .is_some_and(|c| c.is_known(self.db, KnownClass::Type)) + { + let symbol = self.expect_expr_name_symbol(id); + constraints.insert( + symbol, + Type::instance(self.db, rhs_class.unknown_specialization(self.db)), + ); + } + } + _ => {} + } + } + Some(constraints) + } + + fn evaluate_expr_call( + &mut self, + expr_call: &ast::ExprCall, + expression: Expression<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + let scope = self.scope(); + let inference = infer_expression_types(self.db, expression); + + let callable_ty = + inference.expression_type(expr_call.func.scoped_expression_id(self.db, scope)); + + // TODO: add support for PEP 604 union types on the right hand side of `isinstance` + // and `issubclass`, for example `isinstance(x, str | (int | float))`. + match callable_ty { + Type::FunctionLiteral(function_type) if expr_call.arguments.keywords.is_empty() => { + let [first_arg, second_arg] = &*expr_call.arguments.args else { + return None; + }; + let first_arg = expr_name(first_arg)?; + let function = function_type.known(self.db)?; + let symbol = self.expect_expr_name_symbol(first_arg); + + if function == KnownFunction::HasAttr { + let attr = inference + .expression_type(second_arg.scoped_expression_id(self.db, scope)) + .into_string_literal()? + .value(self.db); + + if !is_identifier(attr) { + return None; + } + + let constraint = Type::synthesized_protocol( + self.db, + [(attr, KnownClass::Object.to_instance(self.db))], + ); + + return Some(NarrowingConstraints::from_iter([( + symbol, + constraint.negate_if(self.db, !is_positive), + )])); + } + + let function = function.into_classinfo_constraint_function()?; + + let class_info_ty = + inference.expression_type(second_arg.scoped_expression_id(self.db, scope)); + + function + .generate_constraint(self.db, class_info_ty) + .map(|constraint| { + NarrowingConstraints::from_iter([( + symbol, + constraint.negate_if(self.db, !is_positive), + )]) + }) + } + // for the expression `bool(E)`, we further narrow the type based on `E` + Type::ClassLiteral(class_type) + if expr_call.arguments.args.len() == 1 + && expr_call.arguments.keywords.is_empty() + && class_type.is_known(self.db, KnownClass::Bool) => + { + self.evaluate_expression_node_predicate( + &expr_call.arguments.args[0], + expression, + is_positive, + ) + } + _ => None, + } + } + + fn evaluate_match_pattern_singleton( + &mut self, + subject: Expression<'db>, + singleton: ast::Singleton, + ) -> Option<NarrowingConstraints<'db>> { + let symbol = self.expect_expr_name_symbol(&subject.node_ref(self.db).as_name_expr()?.id); + + let ty = match singleton { + ast::Singleton::None => Type::none(self.db), + ast::Singleton::True => Type::BooleanLiteral(true), + ast::Singleton::False => Type::BooleanLiteral(false), + }; + Some(NarrowingConstraints::from_iter([(symbol, ty)])) + } + + fn evaluate_match_pattern_class( + &mut self, + subject: Expression<'db>, + cls: Expression<'db>, + ) -> Option<NarrowingConstraints<'db>> { + let symbol = self.expect_expr_name_symbol(&subject.node_ref(self.db).as_name_expr()?.id); + let ty = infer_same_file_expression_type(self.db, cls).to_instance(self.db)?; + + Some(NarrowingConstraints::from_iter([(symbol, ty)])) + } + + fn evaluate_match_pattern_value( + &mut self, + subject: Expression<'db>, + value: Expression<'db>, + ) -> Option<NarrowingConstraints<'db>> { + let symbol = self.expect_expr_name_symbol(&subject.node_ref(self.db).as_name_expr()?.id); + let ty = infer_same_file_expression_type(self.db, value); + Some(NarrowingConstraints::from_iter([(symbol, ty)])) + } + + fn evaluate_match_pattern_or( + &mut self, + subject: Expression<'db>, + predicates: &Vec<PatternPredicateKind<'db>>, + ) -> Option<NarrowingConstraints<'db>> { + let db = self.db; + + predicates + .iter() + .filter_map(|predicate| self.evaluate_pattern_predicate_kind(predicate, subject)) + .reduce(|mut constraints, constraints_| { + merge_constraints_or(&mut constraints, &constraints_, db); + constraints + }) + } + + fn evaluate_bool_op( + &mut self, + expr_bool_op: &ExprBoolOp, + expression: Expression<'db>, + is_positive: bool, + ) -> Option<NarrowingConstraints<'db>> { + let inference = infer_expression_types(self.db, expression); + let scope = self.scope(); + let mut sub_constraints = expr_bool_op + .values + .iter() + // filter our arms with statically known truthiness + .filter(|expr| { + inference + .expression_type(expr.scoped_expression_id(self.db, scope)) + .bool(self.db) + != match expr_bool_op.op { + BoolOp::And => Truthiness::AlwaysTrue, + BoolOp::Or => Truthiness::AlwaysFalse, + } + }) + .map(|sub_expr| { + self.evaluate_expression_node_predicate(sub_expr, expression, is_positive) + }) + .collect::<Vec<_>>(); + match (expr_bool_op.op, is_positive) { + (BoolOp::And, true) | (BoolOp::Or, false) => { + let mut aggregation: Option<NarrowingConstraints> = None; + for sub_constraint in sub_constraints.into_iter().flatten() { + if let Some(ref mut some_aggregation) = aggregation { + merge_constraints_and(some_aggregation, sub_constraint, self.db); + } else { + aggregation = Some(sub_constraint); + } + } + aggregation + } + (BoolOp::Or, true) | (BoolOp::And, false) => { + let (first, rest) = sub_constraints.split_first_mut()?; + if let Some(first) = first { + for rest_constraint in rest { + if let Some(rest_constraint) = rest_constraint { + merge_constraints_or(first, rest_constraint, self.db); + } else { + return None; + } + } + } + first.clone() + } + } + } +} diff --git a/crates/ty_python_semantic/src/types/property_tests.rs b/crates/ty_python_semantic/src/types/property_tests.rs new file mode 100644 index 0000000000000..e0bca1c509f82 --- /dev/null +++ b/crates/ty_python_semantic/src/types/property_tests.rs @@ -0,0 +1,306 @@ +//! This module contains quickcheck-based property tests for `Type`s. +//! +//! These tests are disabled by default, as they are non-deterministic and slow. You can +//! run them explicitly using: +//! +//! ```sh +//! cargo test -p ty_python_semantic -- --ignored types::property_tests::stable +//! ``` +//! +//! The number of tests (default: 100) can be controlled by setting the `QUICKCHECK_TESTS` +//! environment variable. For example: +//! +//! ```sh +//! QUICKCHECK_TESTS=10000 cargo test … +//! ``` +//! +//! If you want to run these tests for a longer period of time, it's advisable to run them +//! in release mode. As some tests are slower than others, it's advisable to run them in a +//! loop until they fail: +//! +//! ```sh +//! export QUICKCHECK_TESTS=100000 +//! while cargo test --release -p ty_python_semantic -- \ +//! --ignored types::property_tests::stable; do :; done +//! ``` +mod setup; +mod type_generation; + +use type_generation::{intersection, union}; + +/// A macro to define a property test for types. +/// +/// The `$test_name` identifier specifies the name of the test function. The `$db` identifier +/// is used to refer to the salsa database in the property to be tested. The actual property is +/// specified using the syntax: +/// +/// forall types t1, t2, ..., tn . <property>` +/// +/// where `t1`, `t2`, ..., `tn` are identifiers that represent arbitrary types, and `<property>` +/// is an expression using these identifiers. +/// +macro_rules! type_property_test { + ($test_name:ident, $db:ident, forall types $($types:ident),+ . $property:expr) => { + #[quickcheck_macros::quickcheck] + #[ignore] + fn $test_name($($types: crate::types::property_tests::type_generation::Ty),+) -> bool { + let $db = &crate::types::property_tests::setup::get_cached_db(); + $(let $types = $types.into_type($db);)+ + + $property + } + }; + // A property test with a logical implication. + ($name:ident, $db:ident, forall types $($types:ident),+ . $premise:expr => $conclusion:expr) => { + type_property_test!($name, $db, forall types $($types),+ . !($premise) || ($conclusion)); + }; +} + +mod stable { + use super::union; + use crate::types::{CallableType, Type}; + + // Reflexivity: `T` is equivalent to itself. + type_property_test!( + equivalent_to_is_reflexive, db, + forall types t. t.is_fully_static(db) => t.is_equivalent_to(db, t) + ); + + // Symmetry: If `S` is equivalent to `T`, then `T` must be equivalent to `S`. + // Note that this (trivially) holds true for gradual types as well. + type_property_test!( + equivalent_to_is_symmetric, db, + forall types s, t. s.is_equivalent_to(db, t) => t.is_equivalent_to(db, s) + ); + + // Transitivity: If `S` is equivalent to `T` and `T` is equivalent to `U`, then `S` must be equivalent to `U`. + type_property_test!( + equivalent_to_is_transitive, db, + forall types s, t, u. s.is_equivalent_to(db, t) && t.is_equivalent_to(db, u) => s.is_equivalent_to(db, u) + ); + + // Symmetry: If `S` is gradual equivalent to `T`, `T` is gradual equivalent to `S`. + type_property_test!( + gradual_equivalent_to_is_symmetric, db, + forall types s, t. s.is_gradual_equivalent_to(db, t) => t.is_gradual_equivalent_to(db, s) + ); + + // A fully static type `T` is a subtype of itself. + type_property_test!( + subtype_of_is_reflexive, db, + forall types t. t.is_fully_static(db) => t.is_subtype_of(db, t) + ); + + // `S <: T` and `T <: U` implies that `S <: U`. + type_property_test!( + subtype_of_is_transitive, db, + forall types s, t, u. s.is_subtype_of(db, t) && t.is_subtype_of(db, u) => s.is_subtype_of(db, u) + ); + + // `S <: T` and `T <: S` implies that `S` is equivalent to `T`. + type_property_test!( + subtype_of_is_antisymmetric, db, + forall types s, t. s.is_subtype_of(db, t) && t.is_subtype_of(db, s) => s.is_equivalent_to(db, t) + ); + + // `T` is not disjoint from itself, unless `T` is `Never`. + type_property_test!( + disjoint_from_is_irreflexive, db, + forall types t. t.is_disjoint_from(db, t) => t.is_never() + ); + + // `S` is disjoint from `T` implies that `T` is disjoint from `S`. + type_property_test!( + disjoint_from_is_symmetric, db, + forall types s, t. s.is_disjoint_from(db, t) == t.is_disjoint_from(db, s) + ); + + // `S <: T` implies that `S` is not disjoint from `T`, unless `S` is `Never`. + type_property_test!( + subtype_of_implies_not_disjoint_from, db, + forall types s, t. s.is_subtype_of(db, t) => !s.is_disjoint_from(db, t) || s.is_never() + ); + + // `S <: T` implies that `S` can be assigned to `T`. + type_property_test!( + subtype_of_implies_assignable_to, db, + forall types s, t. s.is_subtype_of(db, t) => s.is_assignable_to(db, t) + ); + + // If `T` is a singleton, it is also single-valued. + type_property_test!( + singleton_implies_single_valued, db, + forall types t. t.is_singleton(db) => t.is_single_valued(db) + ); + + // If `T` contains a gradual form, it should not participate in equivalence + type_property_test!( + non_fully_static_types_do_not_participate_in_equivalence, db, + forall types s, t. !s.is_fully_static(db) => !s.is_equivalent_to(db, t) && !t.is_equivalent_to(db, s) + ); + + // If `T` contains a gradual form, it should not participate in subtyping + type_property_test!( + non_fully_static_types_do_not_participate_in_subtyping, db, + forall types s, t. !s.is_fully_static(db) => !s.is_subtype_of(db, t) && !t.is_subtype_of(db, s) + ); + + // All types should be assignable to `object` + type_property_test!( + all_types_assignable_to_object, db, + forall types t. t.is_assignable_to(db, Type::object(db)) + ); + + // And for fully static types, they should also be subtypes of `object` + type_property_test!( + all_fully_static_types_subtype_of_object, db, + forall types t. t.is_fully_static(db) => t.is_subtype_of(db, Type::object(db)) + ); + + // Never should be assignable to every type + type_property_test!( + never_assignable_to_every_type, db, + forall types t. Type::Never.is_assignable_to(db, t) + ); + + // And it should be a subtype of all fully static types + type_property_test!( + never_subtype_of_every_fully_static_type, db, + forall types t. t.is_fully_static(db) => Type::Never.is_subtype_of(db, t) + ); + + // Similar to `Never`, a fully-static "bottom" callable type should be a subtype of all + // fully-static callable types + type_property_test!( + bottom_callable_is_subtype_of_all_fully_static_callable, db, + forall types t. t.is_callable_type() && t.is_fully_static(db) + => CallableType::bottom(db).is_subtype_of(db, t) + ); + + // For any two fully static types, each type in the pair must be a subtype of their union. + type_property_test!( + all_fully_static_type_pairs_are_subtype_of_their_union, db, + forall types s, t. + s.is_fully_static(db) && t.is_fully_static(db) + => s.is_subtype_of(db, union(db, [s, t])) && t.is_subtype_of(db, union(db, [s, t])) + ); + + // A fully static type does not have any materializations. + // Thus, two equivalent (fully static) types are also gradual equivalent. + type_property_test!( + two_equivalent_types_are_also_gradual_equivalent, db, + forall types s, t. s.is_equivalent_to(db, t) => s.is_gradual_equivalent_to(db, t) + ); + + // Two gradual equivalent fully static types are also equivalent. + type_property_test!( + two_gradual_equivalent_fully_static_types_are_also_equivalent, db, + forall types s, t. + s.is_fully_static(db) && s.is_gradual_equivalent_to(db, t) => s.is_equivalent_to(db, t) + ); + + // `T` can be assigned to itself. + type_property_test!( + assignable_to_is_reflexive, db, + forall types t. t.is_assignable_to(db, t) + ); + + // For *any* pair of types, whether fully static or not, + // each of the pair should be assignable to the union of the two. + type_property_test!( + all_type_pairs_are_assignable_to_their_union, db, + forall types s, t. s.is_assignable_to(db, union(db, [s, t])) && t.is_assignable_to(db, union(db, [s, t])) + ); +} + +/// This module contains property tests that currently lead to many false positives. +/// +/// The reason for this is our insufficient understanding of equivalence of types. For +/// example, we currently consider `int | str` and `str | int` to be different types. +/// Similar issues exist for intersection types. Once this is resolved, we can move these +/// tests to the `stable` section. In the meantime, it can still be useful to run these +/// tests (using [`types::property_tests::flaky`]), to see if there are any new obvious bugs. +mod flaky { + use itertools::Itertools; + + use super::{intersection, union}; + + // Negating `T` twice is equivalent to `T`. + type_property_test!( + double_negation_is_identity, db, + forall types t. t.negate(db).negate(db).is_equivalent_to(db, t) + ); + + // ~T should be disjoint from T + type_property_test!( + negation_is_disjoint, db, + forall types t. t.is_fully_static(db) => t.negate(db).is_disjoint_from(db, t) + ); + + // For two fully static types, their intersection must be a subtype of each type in the pair. + type_property_test!( + all_fully_static_type_pairs_are_supertypes_of_their_intersection, db, + forall types s, t. + s.is_fully_static(db) && t.is_fully_static(db) + => intersection(db, [s, t]).is_subtype_of(db, s) && intersection(db, [s, t]).is_subtype_of(db, t) + ); + + // And for non-fully-static types, the intersection of a pair of types + // should be assignable to both types of the pair. + // Currently fails due to https://github.com/astral-sh/ruff/issues/14899 + type_property_test!( + all_type_pairs_can_be_assigned_from_their_intersection, db, + forall types s, t. intersection(db, [s, t]).is_assignable_to(db, s) && intersection(db, [s, t]).is_assignable_to(db, t) + ); + + // Equal element sets of intersections implies equivalence + // flaky at least in part because of https://github.com/astral-sh/ruff/issues/15513 + type_property_test!( + intersection_equivalence_not_order_dependent, db, + forall types s, t, u. + s.is_fully_static(db) && t.is_fully_static(db) && u.is_fully_static(db) + => [s, t, u] + .into_iter() + .permutations(3) + .map(|trio_of_types| intersection(db, trio_of_types)) + .permutations(2) + .all(|vec_of_intersections| vec_of_intersections[0].is_equivalent_to(db, vec_of_intersections[1])) + ); + + // Equal element sets of unions implies equivalence + // flaky at least in part because of https://github.com/astral-sh/ruff/issues/15513 + type_property_test!( + union_equivalence_not_order_dependent, db, + forall types s, t, u. + s.is_fully_static(db) && t.is_fully_static(db) && u.is_fully_static(db) + => [s, t, u] + .into_iter() + .permutations(3) + .map(|trio_of_types| union(db, trio_of_types)) + .permutations(2) + .all(|vec_of_unions| vec_of_unions[0].is_equivalent_to(db, vec_of_unions[1])) + ); + + // `S | T` is always a supertype of `S`. + // Thus, `S` is never disjoint from `S | T`. + type_property_test!( + constituent_members_of_union_is_not_disjoint_from_that_union, db, + forall types s, t. + !s.is_disjoint_from(db, union(db, [s, t])) && !t.is_disjoint_from(db, union(db, [s, t])) + ); + + // If `S <: T`, then `~T <: ~S`. + // + // DO NOT STABILISE this test until the mdtests here pass: + // https://github.com/astral-sh/ruff/blob/2711e08eb8eb38d1ce323aae0517fede371cba15/crates/ty_python_semantic/resources/mdtest/type_properties/is_subtype_of.md?plain=1#L276-L315 + // + // This test has flakes relating to those subtyping and simplification tests + // (see https://github.com/astral-sh/ruff/issues/16913), but it is hard to + // reliably trigger the flakes when running this test manually as the flakes + // occur very rarely (even running the test with several million seeds does + // not always reliably reproduce the flake). + type_property_test!( + negation_reverses_subtype_order, db, + forall types s, t. s.is_subtype_of(db, t) => t.negate(db).is_subtype_of(db, s.negate(db)) + ); +} diff --git a/crates/ty_python_semantic/src/types/property_tests/setup.rs b/crates/ty_python_semantic/src/types/property_tests/setup.rs new file mode 100644 index 0000000000000..b436c4d9e92fc --- /dev/null +++ b/crates/ty_python_semantic/src/types/property_tests/setup.rs @@ -0,0 +1,9 @@ +use crate::db::tests::{TestDb, setup_db}; +use std::sync::{Arc, Mutex, OnceLock}; + +static CACHED_DB: OnceLock<Arc<Mutex<TestDb>>> = OnceLock::new(); + +pub(crate) fn get_cached_db() -> TestDb { + let db = CACHED_DB.get_or_init(|| Arc::new(Mutex::new(setup_db()))); + db.lock().unwrap().clone() +} diff --git a/crates/ty_python_semantic/src/types/property_tests/type_generation.rs b/crates/ty_python_semantic/src/types/property_tests/type_generation.rs new file mode 100644 index 0000000000000..362d603e6b85d --- /dev/null +++ b/crates/ty_python_semantic/src/types/property_tests/type_generation.rs @@ -0,0 +1,467 @@ +use crate::db::tests::TestDb; +use crate::symbol::{builtins_symbol, known_module_symbol}; +use crate::types::{ + BoundMethodType, CallableType, IntersectionBuilder, KnownClass, KnownInstanceType, Parameter, + Parameters, Signature, SubclassOfType, TupleType, Type, UnionType, +}; +use crate::{Db, KnownModule}; +use hashbrown::HashSet; +use quickcheck::{Arbitrary, Gen}; +use ruff_python_ast::name::Name; + +/// A test representation of a type that can be transformed unambiguously into a real Type, +/// given a db. +/// +/// TODO: We should add some variants that exercise generic classes and specializations thereof. +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum Ty { + Never, + Unknown, + None, + Any, + IntLiteral(i64), + BooleanLiteral(bool), + StringLiteral(&'static str), + LiteralString, + BytesLiteral(&'static str), + // BuiltinInstance("str") corresponds to an instance of the builtin `str` class + BuiltinInstance(&'static str), + /// Members of the `abc` stdlib module + AbcInstance(&'static str), + AbcClassLiteral(&'static str), + TypingLiteral, + // BuiltinClassLiteral("str") corresponds to the builtin `str` class object itself + BuiltinClassLiteral(&'static str), + KnownClassInstance(KnownClass), + Union(Vec<Ty>), + Intersection { + pos: Vec<Ty>, + neg: Vec<Ty>, + }, + Tuple(Vec<Ty>), + SubclassOfAny, + SubclassOfBuiltinClass(&'static str), + SubclassOfAbcClass(&'static str), + AlwaysTruthy, + AlwaysFalsy, + BuiltinsFunction(&'static str), + BuiltinsBoundMethod { + class: &'static str, + method: &'static str, + }, + Callable { + params: CallableParams, + returns: Option<Box<Ty>>, + }, +} + +#[derive(Debug, Clone, PartialEq)] +pub(crate) enum CallableParams { + GradualForm, + List(Vec<Param>), +} + +impl CallableParams { + pub(crate) fn into_parameters(self, db: &TestDb) -> Parameters<'_> { + match self { + CallableParams::GradualForm => Parameters::gradual_form(), + CallableParams::List(params) => Parameters::new(params.into_iter().map(|param| { + let mut parameter = match param.kind { + ParamKind::PositionalOnly => Parameter::positional_only(param.name), + ParamKind::PositionalOrKeyword => { + Parameter::positional_or_keyword(param.name.unwrap()) + } + ParamKind::Variadic => Parameter::variadic(param.name.unwrap()), + ParamKind::KeywordOnly => Parameter::keyword_only(param.name.unwrap()), + ParamKind::KeywordVariadic => Parameter::keyword_variadic(param.name.unwrap()), + }; + if let Some(annotated_ty) = param.annotated_ty { + parameter = parameter.with_annotated_type(annotated_ty.into_type(db)); + } + if let Some(default_ty) = param.default_ty { + parameter = parameter.with_default_type(default_ty.into_type(db)); + } + parameter + })), + } + } +} + +#[derive(Debug, Clone, PartialEq)] +pub(crate) struct Param { + kind: ParamKind, + name: Option<Name>, + annotated_ty: Option<Ty>, + default_ty: Option<Ty>, +} + +#[derive(Debug, Clone, Copy, PartialEq)] +enum ParamKind { + PositionalOnly, + PositionalOrKeyword, + Variadic, + KeywordOnly, + KeywordVariadic, +} + +#[salsa::tracked] +fn create_bound_method<'db>( + db: &'db dyn Db, + function: Type<'db>, + builtins_class: Type<'db>, +) -> Type<'db> { + Type::BoundMethod(BoundMethodType::new( + db, + function.expect_function_literal(), + builtins_class.to_instance(db).unwrap(), + )) +} + +impl Ty { + pub(crate) fn into_type(self, db: &TestDb) -> Type<'_> { + match self { + Ty::Never => Type::Never, + Ty::Unknown => Type::unknown(), + Ty::None => Type::none(db), + Ty::Any => Type::any(), + Ty::IntLiteral(n) => Type::IntLiteral(n), + Ty::StringLiteral(s) => Type::string_literal(db, s), + Ty::BooleanLiteral(b) => Type::BooleanLiteral(b), + Ty::LiteralString => Type::LiteralString, + Ty::BytesLiteral(s) => Type::bytes_literal(db, s.as_bytes()), + Ty::BuiltinInstance(s) => builtins_symbol(db, s) + .symbol + .expect_type() + .to_instance(db) + .unwrap(), + Ty::AbcInstance(s) => known_module_symbol(db, KnownModule::Abc, s) + .symbol + .expect_type() + .to_instance(db) + .unwrap(), + Ty::AbcClassLiteral(s) => known_module_symbol(db, KnownModule::Abc, s) + .symbol + .expect_type(), + Ty::TypingLiteral => Type::KnownInstance(KnownInstanceType::Literal), + Ty::BuiltinClassLiteral(s) => builtins_symbol(db, s).symbol.expect_type(), + Ty::KnownClassInstance(known_class) => known_class.to_instance(db), + Ty::Union(tys) => { + UnionType::from_elements(db, tys.into_iter().map(|ty| ty.into_type(db))) + } + Ty::Intersection { pos, neg } => { + let mut builder = IntersectionBuilder::new(db); + for p in pos { + builder = builder.add_positive(p.into_type(db)); + } + for n in neg { + builder = builder.add_negative(n.into_type(db)); + } + builder.build() + } + Ty::Tuple(tys) => { + let elements = tys.into_iter().map(|ty| ty.into_type(db)); + TupleType::from_elements(db, elements) + } + Ty::SubclassOfAny => SubclassOfType::subclass_of_any(), + Ty::SubclassOfBuiltinClass(s) => SubclassOfType::from( + db, + builtins_symbol(db, s) + .symbol + .expect_type() + .expect_class_literal() + .default_specialization(db), + ), + Ty::SubclassOfAbcClass(s) => SubclassOfType::from( + db, + known_module_symbol(db, KnownModule::Abc, s) + .symbol + .expect_type() + .expect_class_literal() + .default_specialization(db), + ), + Ty::AlwaysTruthy => Type::AlwaysTruthy, + Ty::AlwaysFalsy => Type::AlwaysFalsy, + Ty::BuiltinsFunction(name) => builtins_symbol(db, name).symbol.expect_type(), + Ty::BuiltinsBoundMethod { class, method } => { + let builtins_class = builtins_symbol(db, class).symbol.expect_type(); + let function = builtins_class.member(db, method).symbol.expect_type(); + + create_bound_method(db, function, builtins_class) + } + Ty::Callable { params, returns } => Type::Callable(CallableType::single( + db, + Signature::new( + params.into_parameters(db), + returns.map(|ty| ty.into_type(db)), + ), + )), + } + } +} + +fn arbitrary_core_type(g: &mut Gen) -> Ty { + // We could select a random integer here, but this would make it much less + // likely to explore interesting edge cases: + let int_lit = Ty::IntLiteral(*g.choose(&[-2, -1, 0, 1, 2]).unwrap()); + let bool_lit = Ty::BooleanLiteral(bool::arbitrary(g)); + g.choose(&[ + Ty::Never, + Ty::Unknown, + Ty::None, + Ty::Any, + int_lit, + bool_lit, + Ty::StringLiteral(""), + Ty::StringLiteral("a"), + Ty::LiteralString, + Ty::BytesLiteral(""), + Ty::BytesLiteral("\x00"), + Ty::KnownClassInstance(KnownClass::Object), + Ty::KnownClassInstance(KnownClass::Str), + Ty::KnownClassInstance(KnownClass::Int), + Ty::KnownClassInstance(KnownClass::Bool), + Ty::KnownClassInstance(KnownClass::FunctionType), + Ty::KnownClassInstance(KnownClass::SpecialForm), + Ty::KnownClassInstance(KnownClass::TypeVar), + Ty::KnownClassInstance(KnownClass::TypeAliasType), + Ty::KnownClassInstance(KnownClass::NoDefaultType), + Ty::TypingLiteral, + Ty::BuiltinClassLiteral("str"), + Ty::BuiltinClassLiteral("int"), + Ty::BuiltinClassLiteral("bool"), + Ty::BuiltinClassLiteral("object"), + Ty::BuiltinInstance("type"), + Ty::AbcInstance("ABC"), + Ty::AbcInstance("ABCMeta"), + Ty::SubclassOfAny, + Ty::SubclassOfBuiltinClass("object"), + Ty::SubclassOfBuiltinClass("str"), + Ty::SubclassOfBuiltinClass("type"), + Ty::AbcClassLiteral("ABC"), + Ty::AbcClassLiteral("ABCMeta"), + Ty::SubclassOfAbcClass("ABC"), + Ty::SubclassOfAbcClass("ABCMeta"), + Ty::AlwaysTruthy, + Ty::AlwaysFalsy, + Ty::BuiltinsFunction("chr"), + Ty::BuiltinsFunction("ascii"), + Ty::BuiltinsBoundMethod { + class: "str", + method: "isascii", + }, + Ty::BuiltinsBoundMethod { + class: "int", + method: "bit_length", + }, + ]) + .unwrap() + .clone() +} + +/// Constructs an arbitrary type. +/// +/// The `size` parameter controls the depth of the type tree. For example, +/// a simple type like `int` has a size of 0, `Union[int, str]` has a size +/// of 1, `tuple[int, Union[str, bytes]]` has a size of 2, etc. +fn arbitrary_type(g: &mut Gen, size: u32) -> Ty { + if size == 0 { + arbitrary_core_type(g) + } else { + match u32::arbitrary(g) % 5 { + 0 => arbitrary_core_type(g), + 1 => Ty::Union( + (0..*g.choose(&[2, 3]).unwrap()) + .map(|_| arbitrary_type(g, size - 1)) + .collect(), + ), + 2 => Ty::Tuple( + (0..*g.choose(&[0, 1, 2]).unwrap()) + .map(|_| arbitrary_type(g, size - 1)) + .collect(), + ), + 3 => Ty::Intersection { + pos: (0..*g.choose(&[0, 1, 2]).unwrap()) + .map(|_| arbitrary_type(g, size - 1)) + .collect(), + neg: (0..*g.choose(&[0, 1, 2]).unwrap()) + .map(|_| arbitrary_type(g, size - 1)) + .collect(), + }, + 4 => Ty::Callable { + params: match u32::arbitrary(g) % 2 { + 0 => CallableParams::GradualForm, + 1 => CallableParams::List(arbitrary_parameter_list(g, size)), + _ => unreachable!(), + }, + returns: arbitrary_optional_type(g, size - 1).map(Box::new), + }, + _ => unreachable!(), + } + } +} + +fn arbitrary_parameter_list(g: &mut Gen, size: u32) -> Vec<Param> { + let mut params: Vec<Param> = vec![]; + let mut used_names = HashSet::new(); + + // First, choose the number of parameters to generate. + for _ in 0..*g.choose(&[0, 1, 2, 3, 4, 5]).unwrap() { + // Next, choose the kind of parameters that can be generated based on the last parameter. + let next_kind = match params.last().map(|p| p.kind) { + None | Some(ParamKind::PositionalOnly) => *g + .choose(&[ + ParamKind::PositionalOnly, + ParamKind::PositionalOrKeyword, + ParamKind::Variadic, + ParamKind::KeywordOnly, + ParamKind::KeywordVariadic, + ]) + .unwrap(), + Some(ParamKind::PositionalOrKeyword) => *g + .choose(&[ + ParamKind::PositionalOrKeyword, + ParamKind::Variadic, + ParamKind::KeywordOnly, + ParamKind::KeywordVariadic, + ]) + .unwrap(), + Some(ParamKind::Variadic | ParamKind::KeywordOnly) => *g + .choose(&[ParamKind::KeywordOnly, ParamKind::KeywordVariadic]) + .unwrap(), + Some(ParamKind::KeywordVariadic) => { + // There can't be any other parameter kind after a keyword variadic parameter. + break; + } + }; + + let name = loop { + let name = if matches!(next_kind, ParamKind::PositionalOnly) { + arbitrary_optional_name(g) + } else { + Some(arbitrary_name(g)) + }; + if let Some(name) = name { + if used_names.insert(name.clone()) { + break Some(name); + } + } else { + break None; + } + }; + + params.push(Param { + kind: next_kind, + name, + annotated_ty: arbitrary_optional_type(g, size), + default_ty: if matches!(next_kind, ParamKind::Variadic | ParamKind::KeywordVariadic) { + None + } else { + arbitrary_optional_type(g, size) + }, + }); + } + + params +} + +fn arbitrary_optional_type(g: &mut Gen, size: u32) -> Option<Ty> { + match u32::arbitrary(g) % 2 { + 0 => None, + 1 => Some(arbitrary_type(g, size)), + _ => unreachable!(), + } +} + +fn arbitrary_name(g: &mut Gen) -> Name { + Name::new(format!("n{}", u32::arbitrary(g) % 10)) +} + +fn arbitrary_optional_name(g: &mut Gen) -> Option<Name> { + match u32::arbitrary(g) % 2 { + 0 => None, + 1 => Some(arbitrary_name(g)), + _ => unreachable!(), + } +} + +impl Arbitrary for Ty { + fn arbitrary(g: &mut Gen) -> Ty { + const MAX_SIZE: u32 = 2; + arbitrary_type(g, MAX_SIZE) + } + + fn shrink(&self) -> Box<dyn Iterator<Item = Self>> { + match self.clone() { + Ty::Union(types) => Box::new(types.shrink().filter_map(|elts| match elts.len() { + 0 => None, + 1 => Some(elts.into_iter().next().unwrap()), + _ => Some(Ty::Union(elts)), + })), + Ty::Tuple(types) => Box::new(types.shrink().filter_map(|elts| match elts.len() { + 0 => None, + 1 => Some(elts.into_iter().next().unwrap()), + _ => Some(Ty::Tuple(elts)), + })), + Ty::Intersection { pos, neg } => { + // Shrinking on intersections is not exhaustive! + // + // We try to shrink the positive side or the negative side, + // but we aren't shrinking both at the same time. + // + // This should remove positive or negative constraints but + // won't shrink (A & B & ~C & ~D) to (A & ~C) in one shrink + // iteration. + // + // Instead, it hopes that (A & B & ~C) or (A & ~C & ~D) fails + // so that shrinking can happen there. + let pos_orig = pos.clone(); + let neg_orig = neg.clone(); + Box::new( + // we shrink negative constraints first, as + // intersections with only negative constraints are + // more confusing + neg.shrink() + .map(move |shrunk_neg| Ty::Intersection { + pos: pos_orig.clone(), + neg: shrunk_neg, + }) + .chain(pos.shrink().map(move |shrunk_pos| Ty::Intersection { + pos: shrunk_pos, + neg: neg_orig.clone(), + })) + .filter_map(|ty| { + if let Ty::Intersection { pos, neg } = &ty { + match (pos.len(), neg.len()) { + // an empty intersection does not mean + // anything + (0, 0) => None, + // a single positive element should be + // unwrapped + (1, 0) => Some(pos[0].clone()), + _ => Some(ty), + } + } else { + unreachable!() + } + }), + ) + } + _ => Box::new(std::iter::empty()), + } + } +} + +pub(crate) fn intersection<'db>( + db: &'db TestDb, + tys: impl IntoIterator<Item = Type<'db>>, +) -> Type<'db> { + let mut builder = IntersectionBuilder::new(db); + for ty in tys { + builder = builder.add_positive(ty); + } + builder.build() +} + +pub(crate) fn union<'db>(db: &'db TestDb, tys: impl IntoIterator<Item = Type<'db>>) -> Type<'db> { + UnionType::from_elements(db, tys) +} diff --git a/crates/ty_python_semantic/src/types/protocol_class.rs b/crates/ty_python_semantic/src/types/protocol_class.rs new file mode 100644 index 0000000000000..005ea95765a20 --- /dev/null +++ b/crates/ty_python_semantic/src/types/protocol_class.rs @@ -0,0 +1,386 @@ +use std::{collections::BTreeMap, ops::Deref}; + +use itertools::{Either, Itertools}; + +use ruff_python_ast::name::Name; + +use crate::{ + semantic_index::{symbol_table, use_def_map}, + symbol::{symbol_from_bindings, symbol_from_declarations}, + types::{ + ClassBase, ClassLiteral, KnownFunction, Type, TypeMapping, TypeQualifiers, TypeVarInstance, + }, + {Db, FxOrderSet}, +}; + +impl<'db> ClassLiteral<'db> { + /// Returns `Some` if this is a protocol class, `None` otherwise. + pub(super) fn into_protocol_class(self, db: &'db dyn Db) -> Option<ProtocolClassLiteral<'db>> { + self.is_protocol(db).then_some(ProtocolClassLiteral(self)) + } +} + +/// Representation of a single `Protocol` class definition. +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub(super) struct ProtocolClassLiteral<'db>(ClassLiteral<'db>); + +impl<'db> ProtocolClassLiteral<'db> { + /// Returns the protocol members of this class. + /// + /// A protocol's members define the interface declared by the protocol. + /// They therefore determine how the protocol should behave with regards to + /// assignability and subtyping. + /// + /// The list of members consists of all bindings and declarations that take place + /// in the protocol's class body, except for a list of excluded attributes which should + /// not be taken into account. (This list includes `__init__` and `__new__`, which can + /// legally be defined on protocol classes but do not constitute protocol members.) + /// + /// It is illegal for a protocol class to have any instance attributes that are not declared + /// in the protocol's class body. If any are assigned to, they are not taken into account in + /// the protocol's list of members. + pub(super) fn interface(self, db: &'db dyn Db) -> ProtocolInterface<'db> { + let _span = tracing::trace_span!("protocol_members", "class='{}'", self.name(db)).entered(); + cached_protocol_interface(db, *self) + } + + pub(super) fn is_runtime_checkable(self, db: &'db dyn Db) -> bool { + self.known_function_decorators(db) + .contains(&KnownFunction::RuntimeCheckable) + } +} + +impl<'db> Deref for ProtocolClassLiteral<'db> { + type Target = ClassLiteral<'db>; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +/// # Ordering +/// Ordering is based on the protocol interface member's salsa-assigned id and not on its members. +/// The id may change between runs, or when the protocol instance members was garbage collected and recreated. +#[salsa::interned(debug)] +#[derive(PartialOrd, Ord)] +pub(super) struct ProtocolInterfaceMembers<'db> { + #[returns(ref)] + inner: BTreeMap<Name, ProtocolMemberData<'db>>, +} + +/// The interface of a protocol: the members of that protocol, and the types of those members. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, salsa::Update, PartialOrd, Ord)] +pub(super) enum ProtocolInterface<'db> { + Members(ProtocolInterfaceMembers<'db>), + SelfReference, +} + +impl<'db> ProtocolInterface<'db> { + pub(super) fn with_members<'a, M>(db: &'db dyn Db, members: M) -> Self + where + M: IntoIterator<Item = (&'a str, Type<'db>)>, + { + let members: BTreeMap<_, _> = members + .into_iter() + .map(|(name, ty)| { + ( + Name::new(name), + ProtocolMemberData { + ty: ty.normalized(db), + qualifiers: TypeQualifiers::default(), + }, + ) + }) + .collect(); + Self::Members(ProtocolInterfaceMembers::new(db, members)) + } + + fn empty(db: &'db dyn Db) -> Self { + Self::Members(ProtocolInterfaceMembers::new(db, BTreeMap::default())) + } + + pub(super) fn members<'a>( + self, + db: &'db dyn Db, + ) -> impl ExactSizeIterator<Item = ProtocolMember<'a, 'db>> + where + 'db: 'a, + { + match self { + Self::Members(members) => { + Either::Left(members.inner(db).iter().map(|(name, data)| ProtocolMember { + name, + ty: data.ty, + qualifiers: data.qualifiers, + })) + } + Self::SelfReference => Either::Right(std::iter::empty()), + } + } + + pub(super) fn member_by_name<'a>( + self, + db: &'db dyn Db, + name: &'a str, + ) -> Option<ProtocolMember<'a, 'db>> { + match self { + Self::Members(members) => members.inner(db).get(name).map(|data| ProtocolMember { + name, + ty: data.ty, + qualifiers: data.qualifiers, + }), + Self::SelfReference => None, + } + } + + /// Return `true` if all members of this protocol are fully static. + pub(super) fn is_fully_static(self, db: &'db dyn Db) -> bool { + self.members(db).all(|member| member.ty.is_fully_static(db)) + } + + /// Return `true` if if all members on `self` are also members of `other`. + /// + /// TODO: this method should consider the types of the members as well as their names. + pub(super) fn is_sub_interface_of(self, db: &'db dyn Db, other: Self) -> bool { + match (self, other) { + (Self::Members(self_members), Self::Members(other_members)) => self_members + .inner(db) + .keys() + .all(|member_name| other_members.inner(db).contains_key(member_name)), + _ => { + unreachable!("Enclosing protocols should never be a self-reference marker") + } + } + } + + /// Return `true` if the types of any of the members match the closure passed in. + pub(super) fn any_over_type( + self, + db: &'db dyn Db, + type_fn: &dyn Fn(Type<'db>) -> bool, + ) -> bool { + self.members(db) + .any(|member| member.ty.any_over_type(db, type_fn)) + } + + pub(super) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Self::Members(members) => Self::Members(ProtocolInterfaceMembers::new( + db, + members + .inner(db) + .iter() + .map(|(name, data)| (name.clone(), data.normalized(db))) + .collect::<BTreeMap<_, _>>(), + )), + Self::SelfReference => Self::SelfReference, + } + } + + pub(super) fn specialized_and_normalized<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + match self { + Self::Members(members) => Self::Members(ProtocolInterfaceMembers::new( + db, + members + .inner(db) + .iter() + .map(|(name, data)| { + ( + name.clone(), + data.apply_type_mapping(db, type_mapping).normalized(db), + ) + }) + .collect::<BTreeMap<_, _>>(), + )), + Self::SelfReference => Self::SelfReference, + } + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + match self { + Self::Members(members) => { + for data in members.inner(db).values() { + data.find_legacy_typevars(db, typevars); + } + } + Self::SelfReference => {} + } + } +} + +#[derive(Debug, PartialEq, Eq, Clone, Hash, salsa::Update)] +pub(super) struct ProtocolMemberData<'db> { + ty: Type<'db>, + qualifiers: TypeQualifiers, +} + +impl<'db> ProtocolMemberData<'db> { + fn normalized(&self, db: &'db dyn Db) -> Self { + Self { + ty: self.ty.normalized(db), + qualifiers: self.qualifiers, + } + } + + fn apply_type_mapping<'a>(&self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + Self { + ty: self.ty.apply_type_mapping(db, type_mapping), + qualifiers: self.qualifiers, + } + } + + fn find_legacy_typevars( + &self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + self.ty.find_legacy_typevars(db, typevars); + } +} + +/// A single member of a protocol interface. +#[derive(Debug, PartialEq, Eq)] +pub(super) struct ProtocolMember<'a, 'db> { + name: &'a str, + ty: Type<'db>, + qualifiers: TypeQualifiers, +} + +impl<'a, 'db> ProtocolMember<'a, 'db> { + pub(super) fn name(&self) -> &'a str { + self.name + } + + pub(super) fn ty(&self) -> Type<'db> { + self.ty + } + + pub(super) fn qualifiers(&self) -> TypeQualifiers { + self.qualifiers + } +} + +/// Returns `true` if a declaration or binding to a given name in a protocol class body +/// should be excluded from the list of protocol members of that class. +/// +/// The list of excluded members is subject to change between Python versions, +/// especially for dunders, but it probably doesn't matter *too* much if this +/// list goes out of date. It's up to date as of Python commit 87b1ea016b1454b1e83b9113fa9435849b7743aa +/// (<https://github.com/python/cpython/blob/87b1ea016b1454b1e83b9113fa9435849b7743aa/Lib/typing.py#L1776-L1791>) +fn excluded_from_proto_members(member: &str) -> bool { + matches!( + member, + "_is_protocol" + | "__non_callable_proto_members__" + | "__static_attributes__" + | "__orig_class__" + | "__match_args__" + | "__weakref__" + | "__doc__" + | "__parameters__" + | "__module__" + | "_MutableMapping__marker" + | "__slots__" + | "__dict__" + | "__new__" + | "__protocol_attrs__" + | "__init__" + | "__class_getitem__" + | "__firstlineno__" + | "__abstractmethods__" + | "__orig_bases__" + | "_is_runtime_protocol" + | "__subclasshook__" + | "__type_params__" + | "__annotations__" + | "__annotate__" + | "__annotate_func__" + | "__annotations_cache__" + ) +} + +/// Inner Salsa query for [`ProtocolClassLiteral::interface`]. +#[salsa::tracked(cycle_fn=proto_interface_cycle_recover, cycle_initial=proto_interface_cycle_initial)] +fn cached_protocol_interface<'db>( + db: &'db dyn Db, + class: ClassLiteral<'db>, +) -> ProtocolInterface<'db> { + let mut members = BTreeMap::default(); + + for parent_protocol in class + .iter_mro(db, None) + .filter_map(ClassBase::into_class) + .filter_map(|class| class.class_literal(db).0.into_protocol_class(db)) + { + let parent_scope = parent_protocol.body_scope(db); + let use_def_map = use_def_map(db, parent_scope); + let symbol_table = symbol_table(db, parent_scope); + + members.extend( + use_def_map + .all_public_declarations() + .flat_map(|(symbol_id, declarations)| { + symbol_from_declarations(db, declarations).map(|symbol| (symbol_id, symbol)) + }) + .filter_map(|(symbol_id, symbol)| { + symbol + .symbol + .ignore_possibly_unbound() + .map(|ty| (symbol_id, ty, symbol.qualifiers)) + }) + // Bindings in the class body that are not declared in the class body + // are not valid protocol members, and we plan to emit diagnostics for them + // elsewhere. Invalid or not, however, it's important that we still consider + // them to be protocol members. The implementation of `issubclass()` and + // `isinstance()` for runtime-checkable protocols considers them to be protocol + // members at runtime, and it's important that we accurately understand + // type narrowing that uses `isinstance()` or `issubclass()` with + // runtime-checkable protocols. + .chain( + use_def_map + .all_public_bindings() + .filter_map(|(symbol_id, bindings)| { + symbol_from_bindings(db, bindings) + .ignore_possibly_unbound() + .map(|ty| (symbol_id, ty, TypeQualifiers::default())) + }), + ) + .map(|(symbol_id, member, qualifiers)| { + (symbol_table.symbol(symbol_id).name(), member, qualifiers) + }) + .filter(|(name, _, _)| !excluded_from_proto_members(name)) + .map(|(name, ty, qualifiers)| { + let ty = ty.replace_self_reference(db, class); + let member = ProtocolMemberData { ty, qualifiers }; + (name.clone(), member) + }), + ); + } + + ProtocolInterface::Members(ProtocolInterfaceMembers::new(db, members)) +} + +#[allow(clippy::trivially_copy_pass_by_ref)] +fn proto_interface_cycle_recover<'db>( + _db: &dyn Db, + _value: &ProtocolInterface<'db>, + _count: u32, + _class: ClassLiteral<'db>, +) -> salsa::CycleRecoveryAction<ProtocolInterface<'db>> { + salsa::CycleRecoveryAction::Iterate +} + +fn proto_interface_cycle_initial<'db>( + db: &'db dyn Db, + _class: ClassLiteral<'db>, +) -> ProtocolInterface<'db> { + ProtocolInterface::empty(db) +} diff --git a/crates/ty_python_semantic/src/types/signatures.rs b/crates/ty_python_semantic/src/types/signatures.rs new file mode 100644 index 0000000000000..2b68e7c731987 --- /dev/null +++ b/crates/ty_python_semantic/src/types/signatures.rs @@ -0,0 +1,1758 @@ +//! _Signatures_ describe the expected parameters and return type of a function or other callable. +//! Overloads and unions add complexity to this simple description. +//! +//! In a call expression, the type of the callable might be a union of several types. The call must +//! be compatible with _all_ of these types, since at runtime the callable might be an instance of +//! any of them. +//! +//! Each of the atomic types in the union must be callable. Each callable might be _overloaded_, +//! containing multiple _overload signatures_, each of which describes a different combination of +//! argument types and return types. For each callable type in the union, the call expression's +//! arguments must match _at least one_ overload. + +use std::{collections::HashMap, slice::Iter}; + +use itertools::EitherOrBoth; +use smallvec::{SmallVec, smallvec}; + +use super::{DynamicType, Type, definition_expression_type}; +use crate::semantic_index::definition::Definition; +use crate::types::generics::GenericContext; +use crate::types::{ClassLiteral, TypeMapping, TypeVarInstance, todo_type}; +use crate::{Db, FxOrderSet}; +use ruff_python_ast::{self as ast, name::Name}; + +/// The signature of a possible union of callables. +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) struct Signatures<'db> { + /// The type that is (hopefully) callable. + pub(crate) callable_type: Type<'db>, + /// The type we'll use for error messages referring to details of the called signature. For calls to functions this + /// will be the same as `callable_type`; for other callable instances it may be a `__call__` method. + pub(crate) signature_type: Type<'db>, + /// By using `SmallVec`, we avoid an extra heap allocation for the common case of a non-union + /// type. + elements: SmallVec<[CallableSignature<'db>; 1]>, +} + +impl<'db> Signatures<'db> { + pub(crate) fn not_callable(signature_type: Type<'db>) -> Self { + Self { + callable_type: signature_type, + signature_type, + elements: smallvec![CallableSignature::not_callable(signature_type)], + } + } + + pub(crate) fn single(signature: CallableSignature<'db>) -> Self { + Self { + callable_type: signature.callable_type, + signature_type: signature.signature_type, + elements: smallvec![signature], + } + } + + /// Creates a new `Signatures` from an iterator of [`Signature`]s. Panics if the iterator is + /// empty. + pub(crate) fn from_union<I>(signature_type: Type<'db>, elements: I) -> Self + where + I: IntoIterator<Item = Signatures<'db>>, + { + let elements: SmallVec<_> = elements + .into_iter() + .flat_map(|s| s.elements.into_iter()) + .collect(); + assert!(!elements.is_empty()); + Self { + callable_type: signature_type, + signature_type, + elements, + } + } + + pub(crate) fn iter(&self) -> std::slice::Iter<'_, CallableSignature<'db>> { + self.elements.iter() + } + + pub(crate) fn replace_callable_type(&mut self, before: Type<'db>, after: Type<'db>) { + if self.callable_type == before { + self.callable_type = after; + } + for signature in &mut self.elements { + signature.replace_callable_type(before, after); + } + } + + pub(crate) fn set_dunder_call_is_possibly_unbound(&mut self) { + for signature in &mut self.elements { + signature.dunder_call_is_possibly_unbound = true; + } + } +} + +impl<'a, 'db> IntoIterator for &'a Signatures<'db> { + type Item = &'a CallableSignature<'db>; + type IntoIter = std::slice::Iter<'a, CallableSignature<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.iter() + } +} + +/// The signature of a single callable. If the callable is overloaded, there is a separate +/// [`Signature`] for each overload. +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) struct CallableSignature<'db> { + /// The type that is (hopefully) callable. + pub(crate) callable_type: Type<'db>, + + /// The type we'll use for error messages referring to details of the called signature. For + /// calls to functions this will be the same as `callable_type`; for other callable instances + /// it may be a `__call__` method. + pub(crate) signature_type: Type<'db>, + + /// If this is a callable object (i.e. called via a `__call__` method), the boundness of + /// that call method. + pub(crate) dunder_call_is_possibly_unbound: bool, + + /// The type of the bound `self` or `cls` parameter if this signature is for a bound method. + pub(crate) bound_type: Option<Type<'db>>, + + /// The signatures of each overload of this callable. Will be empty if the type is not + /// callable. + /// + /// By using `SmallVec`, we avoid an extra heap allocation for the common case of a + /// non-overloaded callable. + pub(crate) overloads: SmallVec<[Signature<'db>; 1]>, +} + +impl<'db> CallableSignature<'db> { + pub(crate) fn not_callable(signature_type: Type<'db>) -> Self { + Self { + callable_type: signature_type, + signature_type, + dunder_call_is_possibly_unbound: false, + bound_type: None, + overloads: smallvec![], + } + } + + pub(crate) fn single(signature_type: Type<'db>, signature: Signature<'db>) -> Self { + Self { + callable_type: signature_type, + signature_type, + dunder_call_is_possibly_unbound: false, + bound_type: None, + overloads: smallvec![signature], + } + } + + /// Creates a new `CallableSignature` from an iterator of [`Signature`]s. Returns a + /// non-callable signature if the iterator is empty. + pub(crate) fn from_overloads<I>(signature_type: Type<'db>, overloads: I) -> Self + where + I: IntoIterator<Item = Signature<'db>>, + { + Self { + callable_type: signature_type, + signature_type, + dunder_call_is_possibly_unbound: false, + bound_type: None, + overloads: overloads.into_iter().collect(), + } + } + + /// Return a signature for a dynamic callable + pub(crate) fn dynamic(signature_type: Type<'db>) -> Self { + let signature = Signature { + generic_context: None, + inherited_generic_context: None, + parameters: Parameters::gradual_form(), + return_ty: Some(signature_type), + }; + Self::single(signature_type, signature) + } + + /// Return a todo signature: (*args: Todo, **kwargs: Todo) -> Todo + #[allow(unused_variables)] // 'reason' only unused in debug builds + pub(crate) fn todo(reason: &'static str) -> Self { + let signature_type = todo_type!(reason); + let signature = Signature { + generic_context: None, + inherited_generic_context: None, + parameters: Parameters::todo(), + return_ty: Some(signature_type), + }; + Self::single(signature_type, signature) + } + + pub(crate) fn with_bound_type(mut self, bound_type: Type<'db>) -> Self { + self.bound_type = Some(bound_type); + self + } + + pub(crate) fn iter(&self) -> std::slice::Iter<'_, Signature<'db>> { + self.overloads.iter() + } + + pub(crate) fn as_slice(&self) -> &[Signature<'db>] { + self.overloads.as_slice() + } + + fn replace_callable_type(&mut self, before: Type<'db>, after: Type<'db>) { + if self.callable_type == before { + self.callable_type = after; + } + } +} + +impl<'a, 'db> IntoIterator for &'a CallableSignature<'db> { + type Item = &'a Signature<'db>; + type IntoIter = std::slice::Iter<'a, Signature<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.iter() + } +} + +/// The signature of one of the overloads of a callable. +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub struct Signature<'db> { + /// The generic context for this overload, if it is generic. + pub(crate) generic_context: Option<GenericContext<'db>>, + + /// The inherited generic context, if this function is a class method being used to infer the + /// specialization of its generic class. If the method is itself generic, this is in addition + /// to its own generic context. + pub(crate) inherited_generic_context: Option<GenericContext<'db>>, + + /// Parameters, in source order. + /// + /// The ordering of parameters in a valid signature must be: first positional-only parameters, + /// then positional-or-keyword, then optionally the variadic parameter, then keyword-only + /// parameters, and last, optionally the variadic keywords parameter. Parameters with defaults + /// must come after parameters without defaults. + /// + /// We may get invalid signatures, though, and need to handle them without panicking. + parameters: Parameters<'db>, + + /// Annotated return type, if any. + pub(crate) return_ty: Option<Type<'db>>, +} + +impl<'db> Signature<'db> { + pub(crate) fn new(parameters: Parameters<'db>, return_ty: Option<Type<'db>>) -> Self { + Self { + generic_context: None, + inherited_generic_context: None, + parameters, + return_ty, + } + } + + pub(crate) fn new_generic( + generic_context: Option<GenericContext<'db>>, + parameters: Parameters<'db>, + return_ty: Option<Type<'db>>, + ) -> Self { + Self { + generic_context, + inherited_generic_context: None, + parameters, + return_ty, + } + } + + /// Return a typed signature from a function definition. + pub(super) fn from_function( + db: &'db dyn Db, + generic_context: Option<GenericContext<'db>>, + inherited_generic_context: Option<GenericContext<'db>>, + definition: Definition<'db>, + function_node: &ast::StmtFunctionDef, + ) -> Self { + let parameters = + Parameters::from_parameters(db, definition, function_node.parameters.as_ref()); + let return_ty = function_node.returns.as_ref().map(|returns| { + if function_node.is_async { + todo_type!("generic types.CoroutineType") + } else { + definition_expression_type(db, definition, returns.as_ref()) + } + }); + let legacy_generic_context = + GenericContext::from_function_params(db, ¶meters, return_ty); + + if generic_context.is_some() && legacy_generic_context.is_some() { + // TODO: Raise a diagnostic! + } + + Self { + generic_context: generic_context.or(legacy_generic_context), + inherited_generic_context, + parameters, + return_ty, + } + } + + /// Return the "bottom" signature, subtype of all other fully-static signatures. + pub(crate) fn bottom(db: &'db dyn Db) -> Self { + Self::new(Parameters::object(db), Some(Type::Never)) + } + + pub(crate) fn normalized(&self, db: &'db dyn Db) -> Self { + Self { + generic_context: self.generic_context.map(|ctx| ctx.normalized(db)), + inherited_generic_context: self.inherited_generic_context.map(|ctx| ctx.normalized(db)), + parameters: self + .parameters + .iter() + .map(|param| param.normalized(db)) + .collect(), + return_ty: self.return_ty.map(|return_ty| return_ty.normalized(db)), + } + } + + pub(crate) fn apply_type_mapping<'a>( + &self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + Self { + generic_context: self.generic_context, + inherited_generic_context: self.inherited_generic_context, + parameters: self.parameters.apply_type_mapping(db, type_mapping), + return_ty: self + .return_ty + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + } + } + + pub(crate) fn find_legacy_typevars( + &self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + for param in &self.parameters { + if let Some(ty) = param.annotated_type() { + ty.find_legacy_typevars(db, typevars); + } + if let Some(ty) = param.default_type() { + ty.find_legacy_typevars(db, typevars); + } + } + if let Some(ty) = self.return_ty { + ty.find_legacy_typevars(db, typevars); + } + } + + /// Return the parameters in this signature. + pub(crate) fn parameters(&self) -> &Parameters<'db> { + &self.parameters + } + + pub(crate) fn bind_self(&self) -> Self { + Self { + generic_context: self.generic_context, + inherited_generic_context: self.inherited_generic_context, + parameters: Parameters::new(self.parameters().iter().skip(1).cloned()), + return_ty: self.return_ty, + } + } + + /// Returns `true` if this is a fully static signature. + /// + /// A signature is fully static if all of its parameters and return type are fully static and + /// if it does not use gradual form (`...`) for its parameters. + pub(crate) fn is_fully_static(&self, db: &'db dyn Db) -> bool { + if self.parameters.is_gradual() { + return false; + } + + if self.parameters.iter().any(|parameter| { + parameter + .annotated_type() + .is_none_or(|annotated_type| !annotated_type.is_fully_static(db)) + }) { + return false; + } + + self.return_ty + .is_some_and(|return_type| return_type.is_fully_static(db)) + } + + /// Return `true` if `self` has exactly the same set of possible static materializations as + /// `other` (if `self` represents the same set of possible sets of possible runtime objects as + /// `other`). + pub(crate) fn is_gradual_equivalent_to(&self, db: &'db dyn Db, other: &Signature<'db>) -> bool { + self.is_equivalent_to_impl(other, |self_type, other_type| { + self_type + .unwrap_or(Type::unknown()) + .is_gradual_equivalent_to(db, other_type.unwrap_or(Type::unknown())) + }) + } + + /// Return `true` if `self` represents the exact same set of possible runtime objects as `other`. + pub(crate) fn is_equivalent_to(&self, db: &'db dyn Db, other: &Signature<'db>) -> bool { + self.is_equivalent_to_impl(other, |self_type, other_type| { + match (self_type, other_type) { + (Some(self_type), Some(other_type)) => self_type.is_equivalent_to(db, other_type), + // We need the catch-all case here because it's not guaranteed that this is a fully + // static type. + _ => false, + } + }) + } + + /// Implementation for the [`is_equivalent_to`] and [`is_gradual_equivalent_to`] for signature. + /// + /// [`is_equivalent_to`]: Self::is_equivalent_to + /// [`is_gradual_equivalent_to`]: Self::is_gradual_equivalent_to + fn is_equivalent_to_impl<F>(&self, other: &Signature<'db>, check_types: F) -> bool + where + F: Fn(Option<Type<'db>>, Option<Type<'db>>) -> bool, + { + // N.B. We don't need to explicitly check for the use of gradual form (`...`) in the + // parameters because it is internally represented by adding `*Any` and `**Any` to the + // parameter list. + + if self.parameters.len() != other.parameters.len() { + return false; + } + + if !check_types(self.return_ty, other.return_ty) { + return false; + } + + for (self_parameter, other_parameter) in self.parameters.iter().zip(&other.parameters) { + match (self_parameter.kind(), other_parameter.kind()) { + ( + ParameterKind::PositionalOnly { + default_type: self_default, + .. + }, + ParameterKind::PositionalOnly { + default_type: other_default, + .. + }, + ) if self_default.is_some() == other_default.is_some() => {} + + ( + ParameterKind::PositionalOrKeyword { + name: self_name, + default_type: self_default, + }, + ParameterKind::PositionalOrKeyword { + name: other_name, + default_type: other_default, + }, + ) if self_default.is_some() == other_default.is_some() + && self_name == other_name => {} + + (ParameterKind::Variadic { .. }, ParameterKind::Variadic { .. }) => {} + + ( + ParameterKind::KeywordOnly { + name: self_name, + default_type: self_default, + }, + ParameterKind::KeywordOnly { + name: other_name, + default_type: other_default, + }, + ) if self_default.is_some() == other_default.is_some() + && self_name == other_name => {} + + (ParameterKind::KeywordVariadic { .. }, ParameterKind::KeywordVariadic { .. }) => {} + + _ => return false, + } + + if !check_types( + self_parameter.annotated_type(), + other_parameter.annotated_type(), + ) { + return false; + } + } + + true + } + + /// Return `true` if a callable with signature `self` is assignable to a callable with + /// signature `other`. + pub(crate) fn is_assignable_to(&self, db: &'db dyn Db, other: &Signature<'db>) -> bool { + self.is_assignable_to_impl(other, |type1, type2| { + // In the context of a callable type, the `None` variant represents an `Unknown` type. + type1 + .unwrap_or(Type::unknown()) + .is_assignable_to(db, type2.unwrap_or(Type::unknown())) + }) + } + + /// Return `true` if a callable with signature `self` is a subtype of a callable with signature + /// `other`. + /// + /// # Panics + /// + /// Panics if `self` or `other` is not a fully static signature. + pub(crate) fn is_subtype_of(&self, db: &'db dyn Db, other: &Signature<'db>) -> bool { + self.is_assignable_to_impl(other, |type1, type2| { + // SAFETY: Subtype relation is only checked for fully static types. + type1.unwrap().is_subtype_of(db, type2.unwrap()) + }) + } + + /// Implementation for the [`is_assignable_to`] and [`is_subtype_of`] for signature. + /// + /// [`is_assignable_to`]: Self::is_assignable_to + /// [`is_subtype_of`]: Self::is_subtype_of + fn is_assignable_to_impl<F>(&self, other: &Signature<'db>, check_types: F) -> bool + where + F: Fn(Option<Type<'db>>, Option<Type<'db>>) -> bool, + { + /// A helper struct to zip two slices of parameters together that provides control over the + /// two iterators individually. It also keeps track of the current parameter in each + /// iterator. + struct ParametersZip<'a, 'db> { + current_self: Option<&'a Parameter<'db>>, + current_other: Option<&'a Parameter<'db>>, + iter_self: Iter<'a, Parameter<'db>>, + iter_other: Iter<'a, Parameter<'db>>, + } + + impl<'a, 'db> ParametersZip<'a, 'db> { + /// Move to the next parameter in both the `self` and `other` parameter iterators, + /// [`None`] if both iterators are exhausted. + fn next(&mut self) -> Option<EitherOrBoth<&'a Parameter<'db>, &'a Parameter<'db>>> { + match (self.next_self(), self.next_other()) { + (Some(self_param), Some(other_param)) => { + Some(EitherOrBoth::Both(self_param, other_param)) + } + (Some(self_param), None) => Some(EitherOrBoth::Left(self_param)), + (None, Some(other_param)) => Some(EitherOrBoth::Right(other_param)), + (None, None) => None, + } + } + + /// Move to the next parameter in the `self` parameter iterator, [`None`] if the + /// iterator is exhausted. + fn next_self(&mut self) -> Option<&'a Parameter<'db>> { + self.current_self = self.iter_self.next(); + self.current_self + } + + /// Move to the next parameter in the `other` parameter iterator, [`None`] if the + /// iterator is exhausted. + fn next_other(&mut self) -> Option<&'a Parameter<'db>> { + self.current_other = self.iter_other.next(); + self.current_other + } + + /// Peek at the next parameter in the `other` parameter iterator without consuming it. + fn peek_other(&mut self) -> Option<&'a Parameter<'db>> { + self.iter_other.clone().next() + } + + /// Consumes the `ParametersZip` and returns a two-element tuple containing the + /// remaining parameters in the `self` and `other` iterators respectively. + /// + /// The returned iterators starts with the current parameter, if any, followed by the + /// remaining parameters in the respective iterators. + fn into_remaining( + self, + ) -> ( + impl Iterator<Item = &'a Parameter<'db>>, + impl Iterator<Item = &'a Parameter<'db>>, + ) { + ( + self.current_self.into_iter().chain(self.iter_self), + self.current_other.into_iter().chain(self.iter_other), + ) + } + } + + // Return types are covariant. + if !check_types(self.return_ty, other.return_ty) { + return false; + } + + if self.parameters.is_gradual() || other.parameters.is_gradual() { + // If either of the parameter lists contains a gradual form (`...`), then it is + // assignable / subtype to and from any other callable type. + return true; + } + + let mut parameters = ParametersZip { + current_self: None, + current_other: None, + iter_self: self.parameters.iter(), + iter_other: other.parameters.iter(), + }; + + // Collect all the standard parameters that have only been matched against a variadic + // parameter which means that the keyword variant is still unmatched. + let mut other_keywords = Vec::new(); + + loop { + let Some(next_parameter) = parameters.next() else { + // All parameters have been checked or both the parameter lists were empty. In + // either case, `self` is a subtype of `other`. + return true; + }; + + match next_parameter { + EitherOrBoth::Left(self_parameter) => match self_parameter.kind() { + ParameterKind::KeywordOnly { .. } | ParameterKind::KeywordVariadic { .. } + if !other_keywords.is_empty() => + { + // If there are any unmatched keyword parameters in `other`, they need to + // be checked against the keyword-only / keyword-variadic parameters that + // will be done after this loop. + break; + } + ParameterKind::PositionalOnly { default_type, .. } + | ParameterKind::PositionalOrKeyword { default_type, .. } + | ParameterKind::KeywordOnly { default_type, .. } => { + // For `self <: other` to be valid, if there are no more parameters in + // `other`, then the non-variadic parameters in `self` must have a default + // value. + if default_type.is_none() { + return false; + } + } + ParameterKind::Variadic { .. } | ParameterKind::KeywordVariadic { .. } => { + // Variadic parameters don't have any restrictions in this context, so + // we'll just continue to the next parameter set. + } + }, + + EitherOrBoth::Right(_) => { + // If there are more parameters in `other` than in `self`, then `self` is not a + // subtype of `other`. + return false; + } + + EitherOrBoth::Both(self_parameter, other_parameter) => { + match (self_parameter.kind(), other_parameter.kind()) { + ( + ParameterKind::PositionalOnly { + default_type: self_default, + .. + } + | ParameterKind::PositionalOrKeyword { + default_type: self_default, + .. + }, + ParameterKind::PositionalOnly { + default_type: other_default, + .. + }, + ) => { + if self_default.is_none() && other_default.is_some() { + return false; + } + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + } + + ( + ParameterKind::PositionalOrKeyword { + name: self_name, + default_type: self_default, + }, + ParameterKind::PositionalOrKeyword { + name: other_name, + default_type: other_default, + }, + ) => { + if self_name != other_name { + return false; + } + // The following checks are the same as positional-only parameters. + if self_default.is_none() && other_default.is_some() { + return false; + } + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + } + + ( + ParameterKind::Variadic { .. }, + ParameterKind::PositionalOnly { .. } + | ParameterKind::PositionalOrKeyword { .. }, + ) => { + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + + if matches!( + other_parameter.kind(), + ParameterKind::PositionalOrKeyword { .. } + ) { + other_keywords.push(other_parameter); + } + + // We've reached a variadic parameter in `self` which means there can + // be no more positional parameters after this in a valid AST. But, the + // current parameter in `other` is a positional-only which means there + // can be more positional parameters after this which could be either + // more positional-only parameters, standard parameters or a variadic + // parameter. + // + // So, any remaining positional parameters in `other` would need to be + // checked against the variadic parameter in `self`. This loop does + // that by only moving the `other` iterator forward. + loop { + let Some(other_parameter) = parameters.peek_other() else { + break; + }; + match other_parameter.kind() { + ParameterKind::PositionalOrKeyword { .. } => { + other_keywords.push(other_parameter); + } + ParameterKind::PositionalOnly { .. } + | ParameterKind::Variadic { .. } => {} + _ => { + // Any other parameter kind cannot be checked against a + // variadic parameter and is deferred to the next iteration. + break; + } + } + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + parameters.next_other(); + } + } + + (ParameterKind::Variadic { .. }, ParameterKind::Variadic { .. }) => { + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + } + + ( + _, + ParameterKind::KeywordOnly { .. } + | ParameterKind::KeywordVariadic { .. }, + ) => { + // Keyword parameters are not considered in this loop as the order of + // parameters is not important for them and so they are checked by + // doing name-based lookups. + break; + } + + _ => return false, + } + } + } + } + + // At this point, the remaining parameters in `other` are keyword-only or keyword variadic. + // But, `self` could contain any unmatched positional parameters. + let (self_parameters, other_parameters) = parameters.into_remaining(); + + // Collect all the keyword-only parameters and the unmatched standard parameters. + let mut self_keywords = HashMap::new(); + + // Type of the variadic keyword parameter in `self`. + // + // This is a nested option where the outer option represents the presence of a keyword + // variadic parameter in `self` and the inner option represents the annotated type of the + // keyword variadic parameter. + let mut self_keyword_variadic: Option<Option<Type<'db>>> = None; + + for self_parameter in self_parameters { + match self_parameter.kind() { + ParameterKind::KeywordOnly { name, .. } + | ParameterKind::PositionalOrKeyword { name, .. } => { + self_keywords.insert(name.clone(), self_parameter); + } + ParameterKind::KeywordVariadic { .. } => { + self_keyword_variadic = Some(self_parameter.annotated_type()); + } + ParameterKind::PositionalOnly { .. } => { + // These are the unmatched positional-only parameters in `self` from the + // previous loop. They cannot be matched against any parameter in `other` which + // only contains keyword-only and keyword-variadic parameters so the subtype + // relation is invalid. + return false; + } + ParameterKind::Variadic { .. } => {} + } + } + + for other_parameter in other_keywords.into_iter().chain(other_parameters) { + match other_parameter.kind() { + ParameterKind::KeywordOnly { + name: other_name, + default_type: other_default, + } + | ParameterKind::PositionalOrKeyword { + name: other_name, + default_type: other_default, + } => { + if let Some(self_parameter) = self_keywords.remove(other_name) { + match self_parameter.kind() { + ParameterKind::PositionalOrKeyword { + default_type: self_default, + .. + } + | ParameterKind::KeywordOnly { + default_type: self_default, + .. + } => { + if self_default.is_none() && other_default.is_some() { + return false; + } + if !check_types( + other_parameter.annotated_type(), + self_parameter.annotated_type(), + ) { + return false; + } + } + _ => unreachable!( + "`self_keywords` should only contain keyword-only or standard parameters" + ), + } + } else if let Some(self_keyword_variadic_type) = self_keyword_variadic { + if !check_types( + other_parameter.annotated_type(), + self_keyword_variadic_type, + ) { + return false; + } + } else { + return false; + } + } + ParameterKind::KeywordVariadic { .. } => { + let Some(self_keyword_variadic_type) = self_keyword_variadic else { + // For a `self <: other` relationship, if `other` has a keyword variadic + // parameter, `self` must also have a keyword variadic parameter. + return false; + }; + if !check_types(other_parameter.annotated_type(), self_keyword_variadic_type) { + return false; + } + } + _ => { + // This can only occur in case of a syntax error. + return false; + } + } + } + + // If there are still unmatched keyword parameters from `self`, then they should be + // optional otherwise the subtype relation is invalid. + for (_, self_parameter) in self_keywords { + if self_parameter.default_type().is_none() { + return false; + } + } + + true + } + + /// See [`Type::replace_self_reference`]. + pub(crate) fn replace_self_reference( + mut self, + db: &'db dyn Db, + class: ClassLiteral<'db>, + ) -> Self { + // TODO: also replace self references in generic context + + self.parameters = self + .parameters + .iter() + .cloned() + .map(|param| param.replace_self_reference(db, class)) + .collect(); + + if let Some(ty) = self.return_ty.as_mut() { + *ty = ty.replace_self_reference(db, class); + } + + self + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) struct Parameters<'db> { + // TODO: use SmallVec here once invariance bug is fixed + value: Vec<Parameter<'db>>, + + /// Whether this parameter list represents a gradual form using `...` as the only parameter. + /// + /// If this is `true`, the `value` will still contain the variadic and keyword-variadic + /// parameters. This flag is used to distinguish between an explicit `...` in the callable type + /// as in `Callable[..., int]` and the variadic arguments in `lambda` expression as in + /// `lambda *args, **kwargs: None`. + /// + /// The display implementation utilizes this flag to use `...` instead of displaying the + /// individual variadic and keyword-variadic parameters. + /// + /// Note: This flag is also used to indicate invalid forms of `Callable` annotations. + is_gradual: bool, +} + +impl<'db> Parameters<'db> { + pub(crate) fn new(parameters: impl IntoIterator<Item = Parameter<'db>>) -> Self { + Self { + value: parameters.into_iter().collect(), + is_gradual: false, + } + } + + /// Create an empty parameter list. + pub(crate) fn empty() -> Self { + Self { + value: Vec::new(), + is_gradual: false, + } + } + + pub(crate) fn as_slice(&self) -> &[Parameter<'db>] { + self.value.as_slice() + } + + pub(crate) const fn is_gradual(&self) -> bool { + self.is_gradual + } + + /// Return todo parameters: (*args: Todo, **kwargs: Todo) + pub(crate) fn todo() -> Self { + Self { + value: vec![ + Parameter::variadic(Name::new_static("args")) + .with_annotated_type(todo_type!("todo signature *args")), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(todo_type!("todo signature **kwargs")), + ], + is_gradual: true, + } + } + + /// Return parameters that represents a gradual form using `...` as the only parameter. + /// + /// Internally, this is represented as `(*Any, **Any)` that accepts parameters of type [`Any`]. + /// + /// [`Any`]: crate::types::DynamicType::Any + pub(crate) fn gradual_form() -> Self { + Self { + value: vec![ + Parameter::variadic(Name::new_static("args")) + .with_annotated_type(Type::Dynamic(DynamicType::Any)), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(Type::Dynamic(DynamicType::Any)), + ], + is_gradual: true, + } + } + + /// Return parameters that represents an unknown list of parameters. + /// + /// Internally, this is represented as `(*Unknown, **Unknown)` that accepts parameters of type + /// [`Unknown`]. + /// + /// [`Unknown`]: crate::types::DynamicType::Unknown + pub(crate) fn unknown() -> Self { + Self { + value: vec![ + Parameter::variadic(Name::new_static("args")) + .with_annotated_type(Type::Dynamic(DynamicType::Unknown)), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(Type::Dynamic(DynamicType::Unknown)), + ], + is_gradual: true, + } + } + + /// Return parameters that represents `(*args: object, **kwargs: object)`. + pub(crate) fn object(db: &'db dyn Db) -> Self { + Self { + value: vec![ + Parameter::variadic(Name::new_static("args")).with_annotated_type(Type::object(db)), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(Type::object(db)), + ], + is_gradual: false, + } + } + + fn from_parameters( + db: &'db dyn Db, + definition: Definition<'db>, + parameters: &ast::Parameters, + ) -> Self { + let ast::Parameters { + posonlyargs, + args, + vararg, + kwonlyargs, + kwarg, + range: _, + } = parameters; + let default_type = |param: &ast::ParameterWithDefault| { + param + .default() + .map(|default| definition_expression_type(db, definition, default)) + }; + let positional_only = posonlyargs.iter().map(|arg| { + Parameter::from_node_and_kind( + db, + definition, + &arg.parameter, + ParameterKind::PositionalOnly { + name: Some(arg.parameter.name.id.clone()), + default_type: default_type(arg), + }, + ) + }); + let positional_or_keyword = args.iter().map(|arg| { + Parameter::from_node_and_kind( + db, + definition, + &arg.parameter, + ParameterKind::PositionalOrKeyword { + name: arg.parameter.name.id.clone(), + default_type: default_type(arg), + }, + ) + }); + let variadic = vararg.as_ref().map(|arg| { + Parameter::from_node_and_kind( + db, + definition, + arg, + ParameterKind::Variadic { + name: arg.name.id.clone(), + }, + ) + }); + let keyword_only = kwonlyargs.iter().map(|arg| { + Parameter::from_node_and_kind( + db, + definition, + &arg.parameter, + ParameterKind::KeywordOnly { + name: arg.parameter.name.id.clone(), + default_type: default_type(arg), + }, + ) + }); + let keywords = kwarg.as_ref().map(|arg| { + Parameter::from_node_and_kind( + db, + definition, + arg, + ParameterKind::KeywordVariadic { + name: arg.name.id.clone(), + }, + ) + }); + Self::new( + positional_only + .chain(positional_or_keyword) + .chain(variadic) + .chain(keyword_only) + .chain(keywords), + ) + } + + fn apply_type_mapping<'a>(&self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + Self { + value: self + .value + .iter() + .map(|param| param.apply_type_mapping(db, type_mapping)) + .collect(), + is_gradual: self.is_gradual, + } + } + + pub(crate) fn len(&self) -> usize { + self.value.len() + } + + pub(crate) fn iter(&self) -> std::slice::Iter<Parameter<'db>> { + self.value.iter() + } + + /// Iterate initial positional parameters, not including variadic parameter, if any. + /// + /// For a valid signature, this will be all positional parameters. In an invalid signature, + /// there could be non-initial positional parameters; effectively, we just won't consider those + /// to be positional, which is fine. + pub(crate) fn positional(&self) -> impl Iterator<Item = &Parameter<'db>> { + self.iter().take_while(|param| param.is_positional()) + } + + /// Return parameter at given index, or `None` if index is out-of-range. + pub(crate) fn get(&self, index: usize) -> Option<&Parameter<'db>> { + self.value.get(index) + } + + /// Return positional parameter at given index, or `None` if `index` is out of range. + /// + /// Does not return variadic parameter. + pub(crate) fn get_positional(&self, index: usize) -> Option<&Parameter<'db>> { + self.get(index) + .and_then(|parameter| parameter.is_positional().then_some(parameter)) + } + + /// Return the variadic parameter (`*args`), if any, and its index, or `None`. + pub(crate) fn variadic(&self) -> Option<(usize, &Parameter<'db>)> { + self.iter() + .enumerate() + .find(|(_, parameter)| parameter.is_variadic()) + } + + /// Return parameter (with index) for given name, or `None` if no such parameter. + /// + /// Does not return keywords (`**kwargs`) parameter. + /// + /// In an invalid signature, there could be multiple parameters with the same name; we will + /// just return the first that matches. + pub(crate) fn keyword_by_name(&self, name: &str) -> Option<(usize, &Parameter<'db>)> { + self.iter() + .enumerate() + .find(|(_, parameter)| parameter.callable_by_name(name)) + } + + /// Return the keywords parameter (`**kwargs`), if any, and its index, or `None`. + pub(crate) fn keyword_variadic(&self) -> Option<(usize, &Parameter<'db>)> { + self.iter() + .enumerate() + .rfind(|(_, parameter)| parameter.is_keyword_variadic()) + } +} + +impl<'db, 'a> IntoIterator for &'a Parameters<'db> { + type Item = &'a Parameter<'db>; + type IntoIter = std::slice::Iter<'a, Parameter<'db>>; + + fn into_iter(self) -> Self::IntoIter { + self.value.iter() + } +} + +impl<'db> FromIterator<Parameter<'db>> for Parameters<'db> { + fn from_iter<T: IntoIterator<Item = Parameter<'db>>>(iter: T) -> Self { + Self::new(iter) + } +} + +impl<'db> std::ops::Index<usize> for Parameters<'db> { + type Output = Parameter<'db>; + + fn index(&self, index: usize) -> &Self::Output { + &self.value[index] + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) struct Parameter<'db> { + /// Annotated type of the parameter. + annotated_type: Option<Type<'db>>, + + kind: ParameterKind<'db>, + pub(crate) form: ParameterForm, +} + +impl<'db> Parameter<'db> { + pub(crate) fn positional_only(name: Option<Name>) -> Self { + Self { + annotated_type: None, + kind: ParameterKind::PositionalOnly { + name, + default_type: None, + }, + form: ParameterForm::Value, + } + } + + pub(crate) fn positional_or_keyword(name: Name) -> Self { + Self { + annotated_type: None, + kind: ParameterKind::PositionalOrKeyword { + name, + default_type: None, + }, + form: ParameterForm::Value, + } + } + + pub(crate) fn variadic(name: Name) -> Self { + Self { + annotated_type: None, + kind: ParameterKind::Variadic { name }, + form: ParameterForm::Value, + } + } + + pub(crate) fn keyword_only(name: Name) -> Self { + Self { + annotated_type: None, + kind: ParameterKind::KeywordOnly { + name, + default_type: None, + }, + form: ParameterForm::Value, + } + } + + pub(crate) fn keyword_variadic(name: Name) -> Self { + Self { + annotated_type: None, + kind: ParameterKind::KeywordVariadic { name }, + form: ParameterForm::Value, + } + } + + pub(crate) fn with_annotated_type(mut self, annotated_type: Type<'db>) -> Self { + self.annotated_type = Some(annotated_type); + self + } + + pub(crate) fn with_default_type(mut self, default: Type<'db>) -> Self { + match &mut self.kind { + ParameterKind::PositionalOnly { default_type, .. } + | ParameterKind::PositionalOrKeyword { default_type, .. } + | ParameterKind::KeywordOnly { default_type, .. } => *default_type = Some(default), + ParameterKind::Variadic { .. } | ParameterKind::KeywordVariadic { .. } => { + panic!("cannot set default value for variadic parameter") + } + } + self + } + + pub(crate) fn type_form(mut self) -> Self { + self.form = ParameterForm::Type; + self + } + + fn apply_type_mapping<'a>(&self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + Self { + annotated_type: self + .annotated_type + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + kind: self.kind.apply_type_mapping(db, type_mapping), + form: self.form, + } + } + + /// Strip information from the parameter so that two equivalent parameters compare equal. + /// Normalize nested unions and intersections in the annotated type, if any. + /// + /// See [`Type::normalized`] for more details. + pub(crate) fn normalized(&self, db: &'db dyn Db) -> Self { + let Parameter { + annotated_type, + kind, + form, + } = self; + + // Ensure unions and intersections are ordered in the annotated type (if there is one) + let annotated_type = annotated_type.map(|ty| ty.normalized(db)); + + // Ensure that parameter names are stripped from positional-only, variadic and keyword-variadic parameters. + // Ensure that we only record whether a parameter *has* a default + // (strip the precise *type* of the default from the parameter, replacing it with `Never`). + let kind = match kind { + ParameterKind::PositionalOnly { + name: _, + default_type, + } => ParameterKind::PositionalOnly { + name: None, + default_type: default_type.map(|_| Type::Never), + }, + ParameterKind::PositionalOrKeyword { name, default_type } => { + ParameterKind::PositionalOrKeyword { + name: name.clone(), + default_type: default_type.map(|_| Type::Never), + } + } + ParameterKind::KeywordOnly { name, default_type } => ParameterKind::KeywordOnly { + name: name.clone(), + default_type: default_type.map(|_| Type::Never), + }, + ParameterKind::Variadic { name: _ } => ParameterKind::Variadic { + name: Name::new_static("args"), + }, + ParameterKind::KeywordVariadic { name: _ } => ParameterKind::KeywordVariadic { + name: Name::new_static("kwargs"), + }, + }; + + Self { + annotated_type, + kind, + form: *form, + } + } + + fn from_node_and_kind( + db: &'db dyn Db, + definition: Definition<'db>, + parameter: &ast::Parameter, + kind: ParameterKind<'db>, + ) -> Self { + Self { + annotated_type: parameter + .annotation() + .map(|annotation| definition_expression_type(db, definition, annotation)), + kind, + form: ParameterForm::Value, + } + } + + /// Returns `true` if this is a keyword-only parameter. + pub(crate) fn is_keyword_only(&self) -> bool { + matches!(self.kind, ParameterKind::KeywordOnly { .. }) + } + + /// Returns `true` if this is a positional-only parameter. + pub(crate) fn is_positional_only(&self) -> bool { + matches!(self.kind, ParameterKind::PositionalOnly { .. }) + } + + /// Returns `true` if this is a variadic parameter. + pub(crate) fn is_variadic(&self) -> bool { + matches!(self.kind, ParameterKind::Variadic { .. }) + } + + /// Returns `true` if this is a keyword-variadic parameter. + pub(crate) fn is_keyword_variadic(&self) -> bool { + matches!(self.kind, ParameterKind::KeywordVariadic { .. }) + } + + /// Returns `true` if this is either a positional-only or standard (positional or keyword) + /// parameter. + pub(crate) fn is_positional(&self) -> bool { + matches!( + self.kind, + ParameterKind::PositionalOnly { .. } | ParameterKind::PositionalOrKeyword { .. } + ) + } + + pub(crate) fn callable_by_name(&self, name: &str) -> bool { + match &self.kind { + ParameterKind::PositionalOrKeyword { + name: param_name, .. + } + | ParameterKind::KeywordOnly { + name: param_name, .. + } => param_name == name, + _ => false, + } + } + + /// Annotated type of the parameter, if annotated. + pub(crate) fn annotated_type(&self) -> Option<Type<'db>> { + self.annotated_type + } + + /// Kind of the parameter. + pub(crate) fn kind(&self) -> &ParameterKind<'db> { + &self.kind + } + + /// Name of the parameter (if it has one). + pub(crate) fn name(&self) -> Option<&ast::name::Name> { + match &self.kind { + ParameterKind::PositionalOnly { name, .. } => name.as_ref(), + ParameterKind::PositionalOrKeyword { name, .. } => Some(name), + ParameterKind::Variadic { name } => Some(name), + ParameterKind::KeywordOnly { name, .. } => Some(name), + ParameterKind::KeywordVariadic { name } => Some(name), + } + } + + /// Display name of the parameter, if it has one. + pub(crate) fn display_name(&self) -> Option<ast::name::Name> { + self.name().map(|name| match self.kind { + ParameterKind::Variadic { .. } => ast::name::Name::new(format!("*{name}")), + ParameterKind::KeywordVariadic { .. } => ast::name::Name::new(format!("**{name}")), + _ => name.clone(), + }) + } + + /// Default-value type of the parameter, if any. + pub(crate) fn default_type(&self) -> Option<Type<'db>> { + match self.kind { + ParameterKind::PositionalOnly { default_type, .. } + | ParameterKind::PositionalOrKeyword { default_type, .. } + | ParameterKind::KeywordOnly { default_type, .. } => default_type, + ParameterKind::Variadic { .. } | ParameterKind::KeywordVariadic { .. } => None, + } + } + + /// See [`Type::replace_self_reference`]. + fn replace_self_reference(mut self, db: &'db (dyn Db), class: ClassLiteral<'db>) -> Self { + if let Some(ty) = self.annotated_type.as_mut() { + *ty = ty.replace_self_reference(db, class); + } + self + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) enum ParameterKind<'db> { + /// Positional-only parameter, e.g. `def f(x, /): ...` + PositionalOnly { + /// Parameter name. + /// + /// It is possible for signatures to be defined in ways that leave positional-only parameters + /// nameless (e.g. via `Callable` annotations). + name: Option<Name>, + default_type: Option<Type<'db>>, + }, + + /// Positional-or-keyword parameter, e.g. `def f(x): ...` + PositionalOrKeyword { + /// Parameter name. + name: Name, + default_type: Option<Type<'db>>, + }, + + /// Variadic parameter, e.g. `def f(*args): ...` + Variadic { + /// Parameter name. + name: Name, + }, + + /// Keyword-only parameter, e.g. `def f(*, x): ...` + KeywordOnly { + /// Parameter name. + name: Name, + default_type: Option<Type<'db>>, + }, + + /// Variadic keywords parameter, e.g. `def f(**kwargs): ...` + KeywordVariadic { + /// Parameter name. + name: Name, + }, +} + +impl<'db> ParameterKind<'db> { + fn apply_type_mapping<'a>(&self, db: &'db dyn Db, type_mapping: &TypeMapping<'a, 'db>) -> Self { + match self { + Self::PositionalOnly { default_type, name } => Self::PositionalOnly { + default_type: default_type + .as_ref() + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + name: name.clone(), + }, + Self::PositionalOrKeyword { default_type, name } => Self::PositionalOrKeyword { + default_type: default_type + .as_ref() + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + name: name.clone(), + }, + Self::KeywordOnly { default_type, name } => Self::KeywordOnly { + default_type: default_type + .as_ref() + .map(|ty| ty.apply_type_mapping(db, type_mapping)), + name: name.clone(), + }, + Self::Variadic { .. } | Self::KeywordVariadic { .. } => self.clone(), + } + } +} + +/// Whether a parameter is used as a value or a type form. +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] +pub(crate) enum ParameterForm { + Value, + Type, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::db::tests::{TestDb, setup_db}; + use crate::symbol::global_symbol; + use crate::types::{FunctionSignature, FunctionType, KnownClass}; + use ruff_db::system::DbWithWritableSystem as _; + + #[track_caller] + fn get_function_f<'db>(db: &'db TestDb, file: &'static str) -> FunctionType<'db> { + let module = ruff_db::files::system_path_to_file(db, file).unwrap(); + global_symbol(db, module, "f") + .symbol + .expect_type() + .expect_function_literal() + } + + #[track_caller] + fn assert_params<'db>(signature: &Signature<'db>, expected: &[Parameter<'db>]) { + assert_eq!(signature.parameters.value.as_slice(), expected); + } + + #[test] + fn empty() { + let mut db = setup_db(); + db.write_dedented("/src/a.py", "def f(): ...").unwrap(); + let func = get_function_f(&db, "/src/a.py"); + + let sig = func.internal_signature(&db, None); + + assert!(sig.return_ty.is_none()); + assert_params(&sig, &[]); + } + + #[test] + #[allow(clippy::many_single_char_names)] + fn full() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.py", + " + from typing import Literal + + def f(a, b: int, c = 1, d: int = 2, /, + e = 3, f: Literal[4] = 4, *args: object, + g = 5, h: Literal[6] = 6, **kwargs: str) -> bytes: ... + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.py"); + + let sig = func.internal_signature(&db, None); + + assert_eq!(sig.return_ty.unwrap().display(&db).to_string(), "bytes"); + assert_params( + &sig, + &[ + Parameter::positional_only(Some(Name::new_static("a"))), + Parameter::positional_only(Some(Name::new_static("b"))) + .with_annotated_type(KnownClass::Int.to_instance(&db)), + Parameter::positional_only(Some(Name::new_static("c"))) + .with_default_type(Type::IntLiteral(1)), + Parameter::positional_only(Some(Name::new_static("d"))) + .with_annotated_type(KnownClass::Int.to_instance(&db)) + .with_default_type(Type::IntLiteral(2)), + Parameter::positional_or_keyword(Name::new_static("e")) + .with_default_type(Type::IntLiteral(3)), + Parameter::positional_or_keyword(Name::new_static("f")) + .with_annotated_type(Type::IntLiteral(4)) + .with_default_type(Type::IntLiteral(4)), + Parameter::variadic(Name::new_static("args")) + .with_annotated_type(Type::object(&db)), + Parameter::keyword_only(Name::new_static("g")) + .with_default_type(Type::IntLiteral(5)), + Parameter::keyword_only(Name::new_static("h")) + .with_annotated_type(Type::IntLiteral(6)) + .with_default_type(Type::IntLiteral(6)), + Parameter::keyword_variadic(Name::new_static("kwargs")) + .with_annotated_type(KnownClass::Str.to_instance(&db)), + ], + ); + } + + #[test] + fn not_deferred() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.py", + " + class A: ... + class B: ... + + alias = A + + def f(a: alias): ... + + alias = B + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.py"); + + let sig = func.internal_signature(&db, None); + + let [ + Parameter { + annotated_type, + kind: ParameterKind::PositionalOrKeyword { name, .. }, + .. + }, + ] = &sig.parameters.value[..] + else { + panic!("expected one positional-or-keyword parameter"); + }; + assert_eq!(name, "a"); + // Parameter resolution not deferred; we should see A not B + assert_eq!(annotated_type.unwrap().display(&db).to_string(), "A"); + } + + #[test] + fn deferred_in_stub() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.pyi", + " + class A: ... + class B: ... + + alias = A + + def f(a: alias): ... + + alias = B + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.pyi"); + + let sig = func.internal_signature(&db, None); + + let [ + Parameter { + annotated_type, + kind: ParameterKind::PositionalOrKeyword { name, .. }, + .. + }, + ] = &sig.parameters.value[..] + else { + panic!("expected one positional-or-keyword parameter"); + }; + assert_eq!(name, "a"); + // Parameter resolution deferred; we should see B + assert_eq!(annotated_type.unwrap().display(&db).to_string(), "B"); + } + + #[test] + fn generic_not_deferred() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.py", + " + class A: ... + class B: ... + + alias = A + + def f[T](a: alias, b: T) -> T: ... + + alias = B + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.py"); + + let sig = func.internal_signature(&db, None); + + let [ + Parameter { + annotated_type: a_annotated_ty, + kind: ParameterKind::PositionalOrKeyword { name: a_name, .. }, + .. + }, + Parameter { + annotated_type: b_annotated_ty, + kind: ParameterKind::PositionalOrKeyword { name: b_name, .. }, + .. + }, + ] = &sig.parameters.value[..] + else { + panic!("expected two positional-or-keyword parameters"); + }; + assert_eq!(a_name, "a"); + assert_eq!(b_name, "b"); + // TODO resolution should not be deferred; we should see A not B + assert_eq!( + a_annotated_ty.unwrap().display(&db).to_string(), + "Unknown | B" + ); + assert_eq!(b_annotated_ty.unwrap().display(&db).to_string(), "T"); + } + + #[test] + fn generic_deferred_in_stub() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.pyi", + " + class A: ... + class B: ... + + alias = A + + def f[T](a: alias, b: T) -> T: ... + + alias = B + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.pyi"); + + let sig = func.internal_signature(&db, None); + + let [ + Parameter { + annotated_type: a_annotated_ty, + kind: ParameterKind::PositionalOrKeyword { name: a_name, .. }, + .. + }, + Parameter { + annotated_type: b_annotated_ty, + kind: ParameterKind::PositionalOrKeyword { name: b_name, .. }, + .. + }, + ] = &sig.parameters.value[..] + else { + panic!("expected two positional-or-keyword parameters"); + }; + assert_eq!(a_name, "a"); + assert_eq!(b_name, "b"); + // Parameter resolution deferred; we should see B + assert_eq!(a_annotated_ty.unwrap().display(&db).to_string(), "B"); + assert_eq!(b_annotated_ty.unwrap().display(&db).to_string(), "T"); + } + + #[test] + fn external_signature_no_decorator() { + let mut db = setup_db(); + db.write_dedented( + "/src/a.py", + " + def f(a: int) -> int: ... + ", + ) + .unwrap(); + let func = get_function_f(&db, "/src/a.py"); + + let expected_sig = func.internal_signature(&db, None); + + // With no decorators, internal and external signature are the same + assert_eq!( + func.signature(&db), + &FunctionSignature { + overloads: CallableSignature::single(Type::FunctionLiteral(func), expected_sig), + implementation: None + }, + ); + } +} diff --git a/crates/ty_python_semantic/src/types/slots.rs b/crates/ty_python_semantic/src/types/slots.rs new file mode 100644 index 0000000000000..760185db98a08 --- /dev/null +++ b/crates/ty_python_semantic/src/types/slots.rs @@ -0,0 +1,109 @@ +use ruff_python_ast as ast; + +use crate::db::Db; +use crate::symbol::{Boundness, Symbol}; +use crate::types::class_base::ClassBase; +use crate::types::diagnostic::report_base_with_incompatible_slots; +use crate::types::{ClassLiteral, Type}; + +use super::InferContext; + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +enum SlotsKind { + /// `__slots__` is not found in the class. + NotSpecified, + /// `__slots__` is defined but empty: `__slots__ = ()`. + Empty, + /// `__slots__` is defined and is not empty: `__slots__ = ("a", "b")`. + NotEmpty, + /// `__slots__` is defined but its value is dynamic: + /// * `__slots__ = tuple(a for a in b)` + /// * `__slots__ = ["a", "b"]` + Dynamic, +} + +impl SlotsKind { + fn from(db: &dyn Db, base: ClassLiteral) -> Self { + let Symbol::Type(slots_ty, bound) = base.own_class_member(db, None, "__slots__").symbol + else { + return Self::NotSpecified; + }; + + if matches!(bound, Boundness::PossiblyUnbound) { + return Self::Dynamic; + } + + match slots_ty { + // __slots__ = ("a", "b") + Type::Tuple(tuple) => { + if tuple.elements(db).is_empty() { + Self::Empty + } else { + Self::NotEmpty + } + } + + // __slots__ = "abc" # Same as `("abc",)` + Type::StringLiteral(_) => Self::NotEmpty, + + _ => Self::Dynamic, + } + } +} + +pub(super) fn check_class_slots( + context: &InferContext, + class: ClassLiteral, + node: &ast::StmtClassDef, +) { + let db = context.db(); + + let mut first_with_solid_base = None; + let mut common_solid_base = None; + let mut found_second = false; + + for (index, base) in class.explicit_bases(db).iter().enumerate() { + let Type::ClassLiteral(base) = base else { + continue; + }; + + let solid_base = base.iter_mro(db, None).find_map(|current| { + let ClassBase::Class(current) = current else { + return None; + }; + + let (class_literal, _) = current.class_literal(db); + match SlotsKind::from(db, class_literal) { + SlotsKind::NotEmpty => Some(current), + SlotsKind::NotSpecified | SlotsKind::Empty => None, + SlotsKind::Dynamic => None, + } + }); + + if solid_base.is_none() { + continue; + } + + let base_node = &node.bases()[index]; + + if first_with_solid_base.is_none() { + first_with_solid_base = Some(index); + common_solid_base = solid_base; + continue; + } + + if solid_base == common_solid_base { + continue; + } + + found_second = true; + report_base_with_incompatible_slots(context, base_node); + } + + if found_second { + if let Some(index) = first_with_solid_base { + let base_node = &node.bases()[index]; + report_base_with_incompatible_slots(context, base_node); + } + } +} diff --git a/crates/ty_python_semantic/src/types/string_annotation.rs b/crates/ty_python_semantic/src/types/string_annotation.rs new file mode 100644 index 0000000000000..ae811bbbb1712 --- /dev/null +++ b/crates/ty_python_semantic/src/types/string_annotation.rs @@ -0,0 +1,180 @@ +use ruff_db::source::source_text; +use ruff_python_ast::{self as ast, ModExpression}; +use ruff_python_parser::Parsed; +use ruff_text_size::Ranged; + +use crate::declare_lint; +use crate::lint::{Level, LintStatus}; + +use super::context::InferContext; + +declare_lint! { + /// ## What it does + /// Checks for f-strings in type annotation positions. + /// + /// ## Why is this bad? + /// Static analysis tools like ty can't analyse type annotations that use f-string notation. + /// + /// ## Examples + /// ```python + /// def test(): -> f"int": + /// ... + /// ``` + /// + /// Use instead: + /// ```python + /// def test(): -> "int": + /// ... + /// ``` + pub(crate) static FSTRING_TYPE_ANNOTATION = { + summary: "detects F-strings in type annotation positions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for byte-strings in type annotation positions. + /// + /// ## Why is this bad? + /// Static analysis tools like ty can't analyse type annotations that use byte-string notation. + /// + /// ## Examples + /// ```python + /// def test(): -> b"int": + /// ... + /// ``` + /// + /// Use instead: + /// ```python + /// def test(): -> "int": + /// ... + /// ``` + pub(crate) static BYTE_STRING_TYPE_ANNOTATION = { + summary: "detects byte strings in type annotation positions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for raw-strings in type annotation positions. + /// + /// ## Why is this bad? + /// Static analysis tools like ty can't analyse type annotations that use raw-string notation. + /// + /// ## Examples + /// ```python + /// def test(): -> r"int": + /// ... + /// ``` + /// + /// Use instead: + /// ```python + /// def test(): -> "int": + /// ... + /// ``` + pub(crate) static RAW_STRING_TYPE_ANNOTATION = { + summary: "detects raw strings in type annotation positions", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// ## What it does + /// Checks for implicit concatenated strings in type annotation positions. + /// + /// ## Why is this bad? + /// Static analysis tools like ty can't analyse type annotations that use implicit concatenated strings. + /// + /// ## Examples + /// ```python + /// def test(): -> "Literal[" "5" "]": + /// ... + /// ``` + /// + /// Use instead: + /// ```python + /// def test(): -> "Literal[5]": + /// ... + /// ``` + pub(crate) static IMPLICIT_CONCATENATED_STRING_TYPE_ANNOTATION = { + summary: "detects implicit concatenated strings in type annotations", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// TODO #14889 + pub(crate) static INVALID_SYNTAX_IN_FORWARD_ANNOTATION = { + summary: "detects invalid syntax in forward annotations", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +declare_lint! { + /// TODO #14889 + pub(crate) static ESCAPE_CHARACTER_IN_FORWARD_ANNOTATION = { + summary: "detects forward type annotations with escape characters", + status: LintStatus::preview("1.0.0"), + default_level: Level::Error, + } +} + +/// Parses the given expression as a string annotation. +pub(crate) fn parse_string_annotation( + context: &InferContext, + string_expr: &ast::ExprStringLiteral, +) -> Option<Parsed<ModExpression>> { + let file = context.file(); + let db = context.db(); + + let _span = tracing::trace_span!("parse_string_annotation", string=?string_expr.range(), ?file) + .entered(); + + let source = source_text(db.upcast(), file); + + if let Some(string_literal) = string_expr.as_single_part_string() { + let prefix = string_literal.flags.prefix(); + if prefix.is_raw() { + if let Some(builder) = context.report_lint(&RAW_STRING_TYPE_ANNOTATION, string_literal) + { + builder.into_diagnostic("Type expressions cannot use raw string literal"); + } + // Compare the raw contents (without quotes) of the expression with the parsed contents + // contained in the string literal. + } else if &source[string_literal.content_range()] == string_literal.as_str() { + match ruff_python_parser::parse_string_annotation(source.as_str(), string_literal) { + Ok(parsed) => return Some(parsed), + Err(parse_error) => { + if let Some(builder) = + context.report_lint(&INVALID_SYNTAX_IN_FORWARD_ANNOTATION, string_literal) + { + builder.into_diagnostic(format_args!( + "Syntax error in forward annotation: {}", + parse_error.error + )); + } + } + } + } else if let Some(builder) = + context.report_lint(&ESCAPE_CHARACTER_IN_FORWARD_ANNOTATION, string_expr) + { + // The raw contents of the string doesn't match the parsed content. This could be the + // case for annotations that contain escape sequences. + builder.into_diagnostic("Type expressions cannot contain escape characters"); + } + } else if let Some(builder) = + context.report_lint(&IMPLICIT_CONCATENATED_STRING_TYPE_ANNOTATION, string_expr) + { + // String is implicitly concatenated. + builder.into_diagnostic("Type expressions cannot span multiple string literals"); + } + + None +} diff --git a/crates/ty_python_semantic/src/types/subclass_of.rs b/crates/ty_python_semantic/src/types/subclass_of.rs new file mode 100644 index 0000000000000..b177ea92f6270 --- /dev/null +++ b/crates/ty_python_semantic/src/types/subclass_of.rs @@ -0,0 +1,216 @@ +use crate::symbol::SymbolAndQualifiers; +use crate::types::{ + ClassType, DynamicType, KnownClass, MemberLookupPolicy, Type, TypeMapping, TypeVarInstance, +}; +use crate::{Db, FxOrderSet}; + +/// A type that represents `type[C]`, i.e. the class object `C` and class objects that are subclasses of `C`. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, salsa::Update)] +pub struct SubclassOfType<'db> { + // Keep this field private, so that the only way of constructing the struct is through the `from` method. + subclass_of: SubclassOfInner<'db>, +} + +impl<'db> SubclassOfType<'db> { + /// Construct a new [`Type`] instance representing a given class object (or a given dynamic type) + /// and all possible subclasses of that class object/dynamic type. + /// + /// This method does not always return a [`Type::SubclassOf`] variant. + /// If the class object is known to be a final class, + /// this method will return a [`Type::ClassLiteral`] variant; this is a more precise type. + /// If the class object is `builtins.object`, `Type::NominalInstance(<builtins.type>)` + /// will be returned; this is no more precise, but it is exactly equivalent to `type[object]`. + /// + /// The eager normalization here means that we do not need to worry elsewhere about distinguishing + /// between `@final` classes and other classes when dealing with [`Type::SubclassOf`] variants. + pub(crate) fn from(db: &'db dyn Db, subclass_of: impl Into<SubclassOfInner<'db>>) -> Type<'db> { + let subclass_of = subclass_of.into(); + match subclass_of { + SubclassOfInner::Dynamic(_) => Type::SubclassOf(Self { subclass_of }), + SubclassOfInner::Class(class) => { + if class.is_final(db) { + Type::from(class) + } else if class.is_object(db) { + KnownClass::Type.to_instance(db) + } else { + Type::SubclassOf(Self { subclass_of }) + } + } + } + } + + /// Return a [`Type`] instance representing the type `type[Unknown]`. + pub(crate) const fn subclass_of_unknown() -> Type<'db> { + Type::SubclassOf(SubclassOfType { + subclass_of: SubclassOfInner::unknown(), + }) + } + + /// Return a [`Type`] instance representing the type `type[Any]`. + pub(crate) const fn subclass_of_any() -> Type<'db> { + Type::SubclassOf(SubclassOfType { + subclass_of: SubclassOfInner::Dynamic(DynamicType::Any), + }) + } + + /// Return the inner [`SubclassOfInner`] value wrapped by this `SubclassOfType`. + pub(crate) const fn subclass_of(self) -> SubclassOfInner<'db> { + self.subclass_of + } + + pub(crate) const fn is_dynamic(self) -> bool { + // Unpack `self` so that we're forced to update this method if any more fields are added in the future. + let Self { subclass_of } = self; + subclass_of.is_dynamic() + } + + pub(crate) const fn is_fully_static(self) -> bool { + !self.is_dynamic() + } + + pub(super) fn apply_type_mapping<'a>( + self, + db: &'db dyn Db, + type_mapping: &TypeMapping<'a, 'db>, + ) -> Self { + match self.subclass_of { + SubclassOfInner::Class(class) => Self { + subclass_of: SubclassOfInner::Class(class.apply_type_mapping(db, type_mapping)), + }, + SubclassOfInner::Dynamic(_) => self, + } + } + + pub(super) fn find_legacy_typevars( + self, + db: &'db dyn Db, + typevars: &mut FxOrderSet<TypeVarInstance<'db>>, + ) { + match self.subclass_of { + SubclassOfInner::Class(class) => { + class.find_legacy_typevars(db, typevars); + } + SubclassOfInner::Dynamic(_) => {} + } + } + + pub(crate) fn find_name_in_mro_with_policy( + self, + db: &'db dyn Db, + name: &str, + policy: MemberLookupPolicy, + ) -> Option<SymbolAndQualifiers<'db>> { + Type::from(self.subclass_of).find_name_in_mro_with_policy(db, name, policy) + } + + /// Return `true` if `self` is a subtype of `other`. + /// + /// This can only return `true` if `self.subclass_of` is a [`SubclassOfInner::Class`] variant; + /// only fully static types participate in subtyping. + pub(crate) fn is_subtype_of(self, db: &'db dyn Db, other: SubclassOfType<'db>) -> bool { + match (self.subclass_of, other.subclass_of) { + // Non-fully-static types do not participate in subtyping + (SubclassOfInner::Dynamic(_), _) | (_, SubclassOfInner::Dynamic(_)) => false, + + // For example, `type[bool]` describes all possible runtime subclasses of the class `bool`, + // and `type[int]` describes all possible runtime subclasses of the class `int`. + // The first set is a subset of the second set, because `bool` is itself a subclass of `int`. + (SubclassOfInner::Class(self_class), SubclassOfInner::Class(other_class)) => { + // N.B. The subclass relation is fully static + self_class.is_subclass_of(db, other_class) + } + } + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + Self { + subclass_of: self.subclass_of.normalized(db), + } + } + + pub(crate) fn to_instance(self, db: &'db dyn Db) -> Type<'db> { + match self.subclass_of { + SubclassOfInner::Class(class) => Type::instance(db, class), + SubclassOfInner::Dynamic(dynamic_type) => Type::Dynamic(dynamic_type), + } + } +} + +/// An enumeration of the different kinds of `type[]` types that a [`SubclassOfType`] can represent: +/// +/// 1. A "subclass of a class": `type[C]` for any class object `C` +/// 2. A "subclass of a dynamic type": `type[Any]`, `type[Unknown]` and `type[@Todo]` +/// +/// In the long term, we may want to implement <https://github.com/astral-sh/ruff/issues/15381>. +/// Doing this would allow us to get rid of this enum, +/// since `type[Any]` would be represented as `type & Any` +/// rather than using the [`Type::SubclassOf`] variant at all; +/// [`SubclassOfType`] would then be a simple wrapper around [`ClassType`]. +/// +/// Note that this enum is similar to the [`super::ClassBase`] enum, +/// but does not include the `ClassBase::Protocol` and `ClassBase::Generic` variants +/// (`type[Protocol]` and `type[Generic]` are not valid types). +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, salsa::Update)] +pub(crate) enum SubclassOfInner<'db> { + Class(ClassType<'db>), + Dynamic(DynamicType), +} + +impl<'db> SubclassOfInner<'db> { + pub(crate) const fn unknown() -> Self { + Self::Dynamic(DynamicType::Unknown) + } + + pub(crate) const fn is_dynamic(self) -> bool { + matches!(self, Self::Dynamic(_)) + } + + pub(crate) const fn into_class(self) -> Option<ClassType<'db>> { + match self { + Self::Class(class) => Some(class), + Self::Dynamic(_) => None, + } + } + + pub(crate) const fn into_dynamic(self) -> Option<DynamicType> { + match self { + Self::Class(_) => None, + Self::Dynamic(dynamic) => Some(dynamic), + } + } + + pub(crate) fn normalized(self, db: &'db dyn Db) -> Self { + match self { + Self::Class(class) => Self::Class(class.normalized(db)), + Self::Dynamic(dynamic) => Self::Dynamic(dynamic.normalized()), + } + } + + pub(crate) fn try_from_type(db: &'db dyn Db, ty: Type<'db>) -> Option<Self> { + match ty { + Type::Dynamic(dynamic) => Some(Self::Dynamic(dynamic)), + Type::ClassLiteral(literal) => Some(if literal.is_known(db, KnownClass::Any) { + Self::Dynamic(DynamicType::Any) + } else { + Self::Class(literal.default_specialization(db)) + }), + Type::GenericAlias(generic) => Some(Self::Class(ClassType::Generic(generic))), + _ => None, + } + } +} + +impl<'db> From<ClassType<'db>> for SubclassOfInner<'db> { + fn from(value: ClassType<'db>) -> Self { + SubclassOfInner::Class(value) + } +} + +impl<'db> From<SubclassOfInner<'db>> for Type<'db> { + fn from(value: SubclassOfInner<'db>) -> Self { + match value { + SubclassOfInner::Dynamic(dynamic) => Type::Dynamic(dynamic), + SubclassOfInner::Class(class) => class.into(), + } + } +} diff --git a/crates/ty_python_semantic/src/types/type_ordering.rs b/crates/ty_python_semantic/src/types/type_ordering.rs new file mode 100644 index 0000000000000..465fc389005b5 --- /dev/null +++ b/crates/ty_python_semantic/src/types/type_ordering.rs @@ -0,0 +1,388 @@ +use std::cmp::Ordering; + +use crate::db::Db; + +use super::{ + DynamicType, KnownInstanceType, SuperOwnerKind, TodoType, Type, class_base::ClassBase, + subclass_of::SubclassOfInner, +}; + +/// Return an [`Ordering`] that describes the canonical order in which two types should appear +/// in an [`crate::types::IntersectionType`] or a [`crate::types::UnionType`] in order for them +/// to be compared for equivalence. +/// +/// Two intersections are compared lexicographically. Element types in the intersection must +/// already be sorted. Two unions are never compared in this function because DNF does not permit +/// nested unions. +/// +/// ## Why not just implement [`Ord`] on [`Type`]? +/// +/// It would be fairly easy to slap `#[derive(PartialOrd, Ord)]` on [`Type`], and the ordering we +/// create here is not user-facing. However, it doesn't really "make sense" for `Type` to implement +/// [`Ord`] in terms of the semantics. There are many different ways in which you could plausibly +/// sort a list of types; this is only one (somewhat arbitrary, at times) possible ordering. +pub(super) fn union_or_intersection_elements_ordering<'db>( + db: &'db dyn Db, + left: &Type<'db>, + right: &Type<'db>, +) -> Ordering { + debug_assert_eq!( + *left, + left.normalized(db), + "`left` must be normalized before a meaningful ordering can be established" + ); + debug_assert_eq!( + *right, + right.normalized(db), + "`right` must be normalized before a meaningful ordering can be established" + ); + + if left == right { + return Ordering::Equal; + } + + match (left, right) { + (Type::Never, _) => Ordering::Less, + (_, Type::Never) => Ordering::Greater, + + (Type::LiteralString, _) => Ordering::Less, + (_, Type::LiteralString) => Ordering::Greater, + + (Type::BooleanLiteral(left), Type::BooleanLiteral(right)) => left.cmp(right), + (Type::BooleanLiteral(_), _) => Ordering::Less, + (_, Type::BooleanLiteral(_)) => Ordering::Greater, + + (Type::IntLiteral(left), Type::IntLiteral(right)) => left.cmp(right), + (Type::IntLiteral(_), _) => Ordering::Less, + (_, Type::IntLiteral(_)) => Ordering::Greater, + + (Type::StringLiteral(left), Type::StringLiteral(right)) => left.cmp(right), + (Type::StringLiteral(_), _) => Ordering::Less, + (_, Type::StringLiteral(_)) => Ordering::Greater, + + (Type::BytesLiteral(left), Type::BytesLiteral(right)) => left.cmp(right), + (Type::BytesLiteral(_), _) => Ordering::Less, + (_, Type::BytesLiteral(_)) => Ordering::Greater, + + (Type::FunctionLiteral(left), Type::FunctionLiteral(right)) => left.cmp(right), + (Type::FunctionLiteral(_), _) => Ordering::Less, + (_, Type::FunctionLiteral(_)) => Ordering::Greater, + + (Type::BoundMethod(left), Type::BoundMethod(right)) => left.cmp(right), + (Type::BoundMethod(_), _) => Ordering::Less, + (_, Type::BoundMethod(_)) => Ordering::Greater, + + (Type::MethodWrapper(left), Type::MethodWrapper(right)) => left.cmp(right), + (Type::MethodWrapper(_), _) => Ordering::Less, + (_, Type::MethodWrapper(_)) => Ordering::Greater, + + (Type::WrapperDescriptor(left), Type::WrapperDescriptor(right)) => left.cmp(right), + (Type::WrapperDescriptor(_), _) => Ordering::Less, + (_, Type::WrapperDescriptor(_)) => Ordering::Greater, + + (Type::DataclassDecorator(left), Type::DataclassDecorator(right)) => { + left.bits().cmp(&right.bits()) + } + (Type::DataclassDecorator(_), _) => Ordering::Less, + (_, Type::DataclassDecorator(_)) => Ordering::Greater, + + (Type::DataclassTransformer(left), Type::DataclassTransformer(right)) => { + left.bits().cmp(&right.bits()) + } + (Type::DataclassTransformer(_), _) => Ordering::Less, + (_, Type::DataclassTransformer(_)) => Ordering::Greater, + + (Type::Callable(left), Type::Callable(right)) => left.cmp(right), + (Type::Callable(_), _) => Ordering::Less, + (_, Type::Callable(_)) => Ordering::Greater, + + (Type::Tuple(left), Type::Tuple(right)) => left.cmp(right), + (Type::Tuple(_), _) => Ordering::Less, + (_, Type::Tuple(_)) => Ordering::Greater, + + (Type::ModuleLiteral(left), Type::ModuleLiteral(right)) => left.cmp(right), + (Type::ModuleLiteral(_), _) => Ordering::Less, + (_, Type::ModuleLiteral(_)) => Ordering::Greater, + + (Type::ClassLiteral(left), Type::ClassLiteral(right)) => left.cmp(right), + (Type::ClassLiteral(_), _) => Ordering::Less, + (_, Type::ClassLiteral(_)) => Ordering::Greater, + + (Type::GenericAlias(left), Type::GenericAlias(right)) => left.cmp(right), + (Type::GenericAlias(_), _) => Ordering::Less, + (_, Type::GenericAlias(_)) => Ordering::Greater, + + (Type::SubclassOf(left), Type::SubclassOf(right)) => { + match (left.subclass_of(), right.subclass_of()) { + (SubclassOfInner::Class(left), SubclassOfInner::Class(right)) => left.cmp(&right), + (SubclassOfInner::Class(_), _) => Ordering::Less, + (_, SubclassOfInner::Class(_)) => Ordering::Greater, + (SubclassOfInner::Dynamic(left), SubclassOfInner::Dynamic(right)) => { + dynamic_elements_ordering(left, right) + } + } + } + + (Type::SubclassOf(_), _) => Ordering::Less, + (_, Type::SubclassOf(_)) => Ordering::Greater, + + (Type::NominalInstance(left), Type::NominalInstance(right)) => left.class.cmp(&right.class), + (Type::NominalInstance(_), _) => Ordering::Less, + (_, Type::NominalInstance(_)) => Ordering::Greater, + + (Type::ProtocolInstance(left_proto), Type::ProtocolInstance(right_proto)) => { + left_proto.cmp(right_proto) + } + (Type::ProtocolInstance(_), _) => Ordering::Less, + (_, Type::ProtocolInstance(_)) => Ordering::Greater, + + (Type::TypeVar(left), Type::TypeVar(right)) => left.cmp(right), + (Type::TypeVar(_), _) => Ordering::Less, + (_, Type::TypeVar(_)) => Ordering::Greater, + + (Type::AlwaysTruthy, _) => Ordering::Less, + (_, Type::AlwaysTruthy) => Ordering::Greater, + + (Type::AlwaysFalsy, _) => Ordering::Less, + (_, Type::AlwaysFalsy) => Ordering::Greater, + + (Type::BoundSuper(left), Type::BoundSuper(right)) => { + (match (left.pivot_class(db), right.pivot_class(db)) { + (ClassBase::Class(left), ClassBase::Class(right)) => left.cmp(&right), + (ClassBase::Class(_), _) => Ordering::Less, + (_, ClassBase::Class(_)) => Ordering::Greater, + + (ClassBase::Protocol(left), ClassBase::Protocol(right)) => left.cmp(&right), + (ClassBase::Protocol(_), _) => Ordering::Less, + (_, ClassBase::Protocol(_)) => Ordering::Greater, + + (ClassBase::Generic(left), ClassBase::Generic(right)) => left.cmp(&right), + (ClassBase::Generic(_), _) => Ordering::Less, + (_, ClassBase::Generic(_)) => Ordering::Greater, + + (ClassBase::Dynamic(left), ClassBase::Dynamic(right)) => { + dynamic_elements_ordering(left, right) + } + }) + .then_with(|| match (left.owner(db), right.owner(db)) { + (SuperOwnerKind::Class(left), SuperOwnerKind::Class(right)) => left.cmp(&right), + (SuperOwnerKind::Class(_), _) => Ordering::Less, + (_, SuperOwnerKind::Class(_)) => Ordering::Greater, + (SuperOwnerKind::Instance(left), SuperOwnerKind::Instance(right)) => { + left.class.cmp(&right.class) + } + (SuperOwnerKind::Instance(_), _) => Ordering::Less, + (_, SuperOwnerKind::Instance(_)) => Ordering::Greater, + (SuperOwnerKind::Dynamic(left), SuperOwnerKind::Dynamic(right)) => { + dynamic_elements_ordering(left, right) + } + }) + } + (Type::BoundSuper(_), _) => Ordering::Less, + (_, Type::BoundSuper(_)) => Ordering::Greater, + + (Type::KnownInstance(left_instance), Type::KnownInstance(right_instance)) => { + match (left_instance, right_instance) { + (KnownInstanceType::Tuple, _) => Ordering::Less, + (_, KnownInstanceType::Tuple) => Ordering::Greater, + + (KnownInstanceType::AlwaysFalsy, _) => Ordering::Less, + (_, KnownInstanceType::AlwaysFalsy) => Ordering::Greater, + + (KnownInstanceType::AlwaysTruthy, _) => Ordering::Less, + (_, KnownInstanceType::AlwaysTruthy) => Ordering::Greater, + + (KnownInstanceType::Annotated, _) => Ordering::Less, + (_, KnownInstanceType::Annotated) => Ordering::Greater, + + (KnownInstanceType::Callable, _) => Ordering::Less, + (_, KnownInstanceType::Callable) => Ordering::Greater, + + (KnownInstanceType::ChainMap, _) => Ordering::Less, + (_, KnownInstanceType::ChainMap) => Ordering::Greater, + + (KnownInstanceType::ClassVar, _) => Ordering::Less, + (_, KnownInstanceType::ClassVar) => Ordering::Greater, + + (KnownInstanceType::Concatenate, _) => Ordering::Less, + (_, KnownInstanceType::Concatenate) => Ordering::Greater, + + (KnownInstanceType::Counter, _) => Ordering::Less, + (_, KnownInstanceType::Counter) => Ordering::Greater, + + (KnownInstanceType::DefaultDict, _) => Ordering::Less, + (_, KnownInstanceType::DefaultDict) => Ordering::Greater, + + (KnownInstanceType::Deque, _) => Ordering::Less, + (_, KnownInstanceType::Deque) => Ordering::Greater, + + (KnownInstanceType::Dict, _) => Ordering::Less, + (_, KnownInstanceType::Dict) => Ordering::Greater, + + (KnownInstanceType::Final, _) => Ordering::Less, + (_, KnownInstanceType::Final) => Ordering::Greater, + + (KnownInstanceType::FrozenSet, _) => Ordering::Less, + (_, KnownInstanceType::FrozenSet) => Ordering::Greater, + + (KnownInstanceType::TypeGuard, _) => Ordering::Less, + (_, KnownInstanceType::TypeGuard) => Ordering::Greater, + + (KnownInstanceType::TypedDict, _) => Ordering::Less, + (_, KnownInstanceType::TypedDict) => Ordering::Greater, + + (KnownInstanceType::List, _) => Ordering::Less, + (_, KnownInstanceType::List) => Ordering::Greater, + + (KnownInstanceType::Literal, _) => Ordering::Less, + (_, KnownInstanceType::Literal) => Ordering::Greater, + + (KnownInstanceType::LiteralString, _) => Ordering::Less, + (_, KnownInstanceType::LiteralString) => Ordering::Greater, + + (KnownInstanceType::Optional, _) => Ordering::Less, + (_, KnownInstanceType::Optional) => Ordering::Greater, + + (KnownInstanceType::OrderedDict, _) => Ordering::Less, + (_, KnownInstanceType::OrderedDict) => Ordering::Greater, + + (KnownInstanceType::Generic(left), KnownInstanceType::Generic(right)) => { + left.cmp(right) + } + (KnownInstanceType::Generic(_), _) => Ordering::Less, + (_, KnownInstanceType::Generic(_)) => Ordering::Greater, + + (KnownInstanceType::Protocol(left), KnownInstanceType::Protocol(right)) => { + left.cmp(right) + } + (KnownInstanceType::Protocol(_), _) => Ordering::Less, + (_, KnownInstanceType::Protocol(_)) => Ordering::Greater, + + (KnownInstanceType::NoReturn, _) => Ordering::Less, + (_, KnownInstanceType::NoReturn) => Ordering::Greater, + + (KnownInstanceType::Never, _) => Ordering::Less, + (_, KnownInstanceType::Never) => Ordering::Greater, + + (KnownInstanceType::Set, _) => Ordering::Less, + (_, KnownInstanceType::Set) => Ordering::Greater, + + (KnownInstanceType::Type, _) => Ordering::Less, + (_, KnownInstanceType::Type) => Ordering::Greater, + + (KnownInstanceType::TypeAlias, _) => Ordering::Less, + (_, KnownInstanceType::TypeAlias) => Ordering::Greater, + + (KnownInstanceType::Unknown, _) => Ordering::Less, + (_, KnownInstanceType::Unknown) => Ordering::Greater, + + (KnownInstanceType::Not, _) => Ordering::Less, + (_, KnownInstanceType::Not) => Ordering::Greater, + + (KnownInstanceType::Intersection, _) => Ordering::Less, + (_, KnownInstanceType::Intersection) => Ordering::Greater, + + (KnownInstanceType::TypeOf, _) => Ordering::Less, + (_, KnownInstanceType::TypeOf) => Ordering::Greater, + + (KnownInstanceType::CallableTypeOf, _) => Ordering::Less, + (_, KnownInstanceType::CallableTypeOf) => Ordering::Greater, + + (KnownInstanceType::Unpack, _) => Ordering::Less, + (_, KnownInstanceType::Unpack) => Ordering::Greater, + + (KnownInstanceType::TypingSelf, _) => Ordering::Less, + (_, KnownInstanceType::TypingSelf) => Ordering::Greater, + + (KnownInstanceType::Required, _) => Ordering::Less, + (_, KnownInstanceType::Required) => Ordering::Greater, + + (KnownInstanceType::NotRequired, _) => Ordering::Less, + (_, KnownInstanceType::NotRequired) => Ordering::Greater, + + (KnownInstanceType::TypeIs, _) => Ordering::Less, + (_, KnownInstanceType::TypeIs) => Ordering::Greater, + + (KnownInstanceType::ReadOnly, _) => Ordering::Less, + (_, KnownInstanceType::ReadOnly) => Ordering::Greater, + + (KnownInstanceType::Union, _) => Ordering::Less, + (_, KnownInstanceType::Union) => Ordering::Greater, + + ( + KnownInstanceType::TypeAliasType(left), + KnownInstanceType::TypeAliasType(right), + ) => left.cmp(right), + (KnownInstanceType::TypeAliasType(_), _) => Ordering::Less, + (_, KnownInstanceType::TypeAliasType(_)) => Ordering::Greater, + + (KnownInstanceType::TypeVar(left), KnownInstanceType::TypeVar(right)) => { + left.cmp(right) + } + } + } + + (Type::KnownInstance(_), _) => Ordering::Less, + (_, Type::KnownInstance(_)) => Ordering::Greater, + + (Type::PropertyInstance(left), Type::PropertyInstance(right)) => left.cmp(right), + (Type::PropertyInstance(_), _) => Ordering::Less, + (_, Type::PropertyInstance(_)) => Ordering::Greater, + + (Type::Dynamic(left), Type::Dynamic(right)) => dynamic_elements_ordering(*left, *right), + (Type::Dynamic(_), _) => Ordering::Less, + (_, Type::Dynamic(_)) => Ordering::Greater, + + (Type::Union(_), _) | (_, Type::Union(_)) => { + unreachable!("our type representation does not permit nested unions"); + } + + (Type::Intersection(left), Type::Intersection(right)) => { + // Lexicographically compare the elements of the two unequal intersections. + let left_positive = left.positive(db); + let right_positive = right.positive(db); + if left_positive.len() != right_positive.len() { + return left_positive.len().cmp(&right_positive.len()); + } + let left_negative = left.negative(db); + let right_negative = right.negative(db); + if left_negative.len() != right_negative.len() { + return left_negative.len().cmp(&right_negative.len()); + } + for (left, right) in left_positive.iter().zip(right_positive) { + let ordering = union_or_intersection_elements_ordering(db, left, right); + if ordering != Ordering::Equal { + return ordering; + } + } + for (left, right) in left_negative.iter().zip(right_negative) { + let ordering = union_or_intersection_elements_ordering(db, left, right); + if ordering != Ordering::Equal { + return ordering; + } + } + + unreachable!("Two equal, normalized intersections should share the same Salsa ID") + } + } +} + +/// Determine a canonical order for two instances of [`DynamicType`]. +fn dynamic_elements_ordering(left: DynamicType, right: DynamicType) -> Ordering { + match (left, right) { + (DynamicType::Any, _) => Ordering::Less, + (_, DynamicType::Any) => Ordering::Greater, + + (DynamicType::Unknown, _) => Ordering::Less, + (_, DynamicType::Unknown) => Ordering::Greater, + + #[cfg(debug_assertions)] + (DynamicType::Todo(TodoType(left)), DynamicType::Todo(TodoType(right))) => left.cmp(right), + + #[cfg(not(debug_assertions))] + (DynamicType::Todo(TodoType), DynamicType::Todo(TodoType)) => Ordering::Equal, + + (DynamicType::TodoPEP695ParamSpec, _) => Ordering::Less, + (_, DynamicType::TodoPEP695ParamSpec) => Ordering::Greater, + } +} diff --git a/crates/ty_python_semantic/src/types/unpacker.rs b/crates/ty_python_semantic/src/types/unpacker.rs new file mode 100644 index 0000000000000..cdde1a2e34e9f --- /dev/null +++ b/crates/ty_python_semantic/src/types/unpacker.rs @@ -0,0 +1,341 @@ +use std::borrow::Cow; +use std::cmp::Ordering; + +use rustc_hash::FxHashMap; + +use ruff_python_ast::{self as ast, AnyNodeRef}; + +use crate::Db; +use crate::semantic_index::ast_ids::{HasScopedExpressionId, ScopedExpressionId}; +use crate::semantic_index::symbol::ScopeId; +use crate::types::{Type, TypeCheckDiagnostics, infer_expression_types, todo_type}; +use crate::unpack::{UnpackKind, UnpackValue}; + +use super::context::InferContext; +use super::diagnostic::INVALID_ASSIGNMENT; +use super::{TupleType, UnionType}; + +/// Unpacks the value expression type to their respective targets. +pub(crate) struct Unpacker<'db> { + context: InferContext<'db>, + target_scope: ScopeId<'db>, + value_scope: ScopeId<'db>, + targets: FxHashMap<ScopedExpressionId, Type<'db>>, +} + +impl<'db> Unpacker<'db> { + pub(crate) fn new( + db: &'db dyn Db, + target_scope: ScopeId<'db>, + value_scope: ScopeId<'db>, + ) -> Self { + Self { + context: InferContext::new(db, target_scope), + targets: FxHashMap::default(), + target_scope, + value_scope, + } + } + + fn db(&self) -> &'db dyn Db { + self.context.db() + } + + /// Unpack the value to the target expression. + pub(crate) fn unpack(&mut self, target: &ast::Expr, value: UnpackValue<'db>) { + debug_assert!( + matches!(target, ast::Expr::List(_) | ast::Expr::Tuple(_)), + "Unpacking target must be a list or tuple expression" + ); + + let value_type = infer_expression_types(self.db(), value.expression()) + .expression_type(value.scoped_expression_id(self.db(), self.value_scope)); + + let value_type = match value.kind() { + UnpackKind::Assign => { + if self.context.in_stub() + && value + .expression() + .node_ref(self.db()) + .is_ellipsis_literal_expr() + { + Type::unknown() + } else { + value_type + } + } + UnpackKind::Iterable => value_type.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, value_type, value.as_any_node_ref(self.db())); + err.fallback_element_type(self.db()) + }), + UnpackKind::ContextManager => value_type.try_enter(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, value_type, value.as_any_node_ref(self.db())); + err.fallback_enter_type(self.db()) + }), + }; + + self.unpack_inner(target, value.as_any_node_ref(self.db()), value_type); + } + + fn unpack_inner( + &mut self, + target: &ast::Expr, + value_expr: AnyNodeRef<'db>, + value_ty: Type<'db>, + ) { + match target { + ast::Expr::Name(_) | ast::Expr::Attribute(_) => { + self.targets.insert( + target.scoped_expression_id(self.db(), self.target_scope), + value_ty, + ); + } + ast::Expr::Starred(ast::ExprStarred { value, .. }) => { + self.unpack_inner(value, value_expr, value_ty); + } + ast::Expr::List(ast::ExprList { elts, .. }) + | ast::Expr::Tuple(ast::ExprTuple { elts, .. }) => { + // Initialize the vector of target types, one for each target. + // + // This is mainly useful for the union type where the target type at index `n` is + // going to be a union of types from every union type element at index `n`. + // + // For example, if the type is `tuple[int, int] | tuple[int, str]` and the target + // has two elements `(a, b)`, then + // * The type of `a` will be a union of `int` and `int` which are at index 0 in the + // first and second tuple respectively which resolves to an `int`. + // * Similarly, the type of `b` will be a union of `int` and `str` which are at + // index 1 in the first and second tuple respectively which will be `int | str`. + let mut target_types = vec![vec![]; elts.len()]; + + let unpack_types = match value_ty { + Type::Union(union_ty) => union_ty.elements(self.db()), + _ => std::slice::from_ref(&value_ty), + }; + + for ty in unpack_types.iter().copied() { + // Deconstruct certain types to delegate the inference back to the tuple type + // for correct handling of starred expressions. + let ty = match ty { + Type::StringLiteral(string_literal_ty) => { + // We could go further and deconstruct to an array of `StringLiteral` + // with each individual character, instead of just an array of + // `LiteralString`, but there would be a cost and it's not clear that + // it's worth it. + TupleType::from_elements( + self.db(), + std::iter::repeat_n( + Type::LiteralString, + string_literal_ty.python_len(self.db()), + ), + ) + } + _ => ty, + }; + + if let Some(tuple_ty) = ty.into_tuple() { + let tuple_ty_elements = + self.tuple_ty_elements(target, elts, tuple_ty, value_expr); + + let length_mismatch = + match elts.len().cmp(&tuple_ty_elements.len()) { + Ordering::Less => { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + let mut diag = + builder.into_diagnostic("Too many values to unpack"); + diag.set_primary_message(format_args!( + "Expected {}", + elts.len(), + )); + diag.annotate(self.context.secondary(value_expr).message( + format_args!("Got {}", tuple_ty_elements.len()), + )); + } + true + } + Ordering::Greater => { + if let Some(builder) = + self.context.report_lint(&INVALID_ASSIGNMENT, target) + { + let mut diag = + builder.into_diagnostic("Not enough values to unpack"); + diag.set_primary_message(format_args!( + "Expected {}", + elts.len(), + )); + diag.annotate(self.context.secondary(value_expr).message( + format_args!("Got {}", tuple_ty_elements.len()), + )); + } + true + } + Ordering::Equal => false, + }; + + for (index, ty) in tuple_ty_elements.iter().enumerate() { + if let Some(element_types) = target_types.get_mut(index) { + if length_mismatch { + element_types.push(Type::unknown()); + } else { + element_types.push(*ty); + } + } + } + } else { + let ty = if ty.is_literal_string() { + Type::LiteralString + } else { + ty.try_iterate(self.db()).unwrap_or_else(|err| { + err.report_diagnostic(&self.context, ty, value_expr); + err.fallback_element_type(self.db()) + }) + }; + for target_type in &mut target_types { + target_type.push(ty); + } + } + } + + for (index, element) in elts.iter().enumerate() { + // SAFETY: `target_types` is initialized with the same length as `elts`. + let element_ty = match target_types[index].as_slice() { + [] => Type::unknown(), + types => UnionType::from_elements(self.db(), types), + }; + self.unpack_inner(element, value_expr, element_ty); + } + } + _ => {} + } + } + + /// Returns the [`Type`] elements inside the given [`TupleType`] taking into account that there + /// can be a starred expression in the `elements`. + /// + /// `value_expr` is an AST reference to the value being unpacked. It is + /// only used for diagnostics. + fn tuple_ty_elements( + &self, + expr: &ast::Expr, + targets: &[ast::Expr], + tuple_ty: TupleType<'db>, + value_expr: AnyNodeRef<'_>, + ) -> Cow<'_, [Type<'db>]> { + // If there is a starred expression, it will consume all of the types at that location. + let Some(starred_index) = targets.iter().position(ast::Expr::is_starred_expr) else { + // Otherwise, the types will be unpacked 1-1 to the targets. + return Cow::Borrowed(tuple_ty.elements(self.db())); + }; + + if tuple_ty.len(self.db()) >= targets.len() - 1 { + // This branch is only taken when there are enough elements in the tuple type to + // combine for the starred expression. So, the arithmetic and indexing operations are + // safe to perform. + let mut element_types = Vec::with_capacity(targets.len()); + + // Insert all the elements before the starred expression. + element_types.extend_from_slice( + // SAFETY: Safe because of the length check above. + &tuple_ty.elements(self.db())[..starred_index], + ); + + // The number of target expressions that are remaining after the starred expression. + // For example, in `(a, *b, c, d) = ...`, the index of starred element `b` is 1 and the + // remaining elements after that are 2. + let remaining = targets.len() - (starred_index + 1); + + // This index represents the position of the last element that belongs to the starred + // expression, in an exclusive manner. For example, in `(a, *b, c) = (1, 2, 3, 4)`, the + // starred expression `b` will consume the elements `Literal[2]` and `Literal[3]` and + // the index value would be 3. + let starred_end_index = tuple_ty.len(self.db()) - remaining; + + // SAFETY: Safe because of the length check above. + let _starred_element_types = + &tuple_ty.elements(self.db())[starred_index..starred_end_index]; + // TODO: Combine the types into a list type. If the + // starred_element_types is empty, then it should be `List[Any]`. + // combine_types(starred_element_types); + element_types.push(todo_type!("starred unpacking")); + + // Insert the types remaining that aren't consumed by the starred expression. + element_types.extend_from_slice( + // SAFETY: Safe because of the length check above. + &tuple_ty.elements(self.db())[starred_end_index..], + ); + + Cow::Owned(element_types) + } else { + if let Some(builder) = self.context.report_lint(&INVALID_ASSIGNMENT, expr) { + let mut diag = builder.into_diagnostic("Not enough values to unpack"); + diag.set_primary_message(format_args!("Expected {} or more", targets.len() - 1)); + diag.annotate( + self.context + .secondary(value_expr) + .message(format_args!("Got {}", tuple_ty.len(self.db()))), + ); + } + + Cow::Owned(vec![Type::unknown(); targets.len()]) + } + } + + pub(crate) fn finish(mut self) -> UnpackResult<'db> { + self.targets.shrink_to_fit(); + UnpackResult { + diagnostics: self.context.finish(), + targets: self.targets, + cycle_fallback_type: None, + } + } +} + +#[derive(Debug, Default, PartialEq, Eq, salsa::Update)] +pub(crate) struct UnpackResult<'db> { + targets: FxHashMap<ScopedExpressionId, Type<'db>>, + diagnostics: TypeCheckDiagnostics, + + /// The fallback type for missing expressions. + /// + /// This is used only when constructing a cycle-recovery `UnpackResult`. + cycle_fallback_type: Option<Type<'db>>, +} + +impl<'db> UnpackResult<'db> { + /// Returns the inferred type for a given sub-expression of the left-hand side target + /// of an unpacking assignment. + /// + /// # Panics + /// + /// May panic if a scoped expression ID is passed in that does not correspond to a sub- + /// expression of the target. + #[track_caller] + pub(crate) fn expression_type(&self, expr_id: ScopedExpressionId) -> Type<'db> { + self.try_expression_type(expr_id).expect( + "expression should belong to this `UnpackResult` and \ + `Unpacker` should have inferred a type for it", + ) + } + + pub(crate) fn try_expression_type(&self, expr_id: ScopedExpressionId) -> Option<Type<'db>> { + self.targets + .get(&expr_id) + .copied() + .or(self.cycle_fallback_type) + } + + /// Returns the diagnostics in this unpacking assignment. + pub(crate) fn diagnostics(&self) -> &TypeCheckDiagnostics { + &self.diagnostics + } + + pub(crate) fn cycle_fallback(cycle_fallback_type: Type<'db>) -> Self { + Self { + targets: FxHashMap::default(), + diagnostics: TypeCheckDiagnostics::default(), + cycle_fallback_type: Some(cycle_fallback_type), + } + } +} diff --git a/crates/ty_python_semantic/src/unpack.rs b/crates/ty_python_semantic/src/unpack.rs new file mode 100644 index 0000000000000..338c9a945a3c1 --- /dev/null +++ b/crates/ty_python_semantic/src/unpack.rs @@ -0,0 +1,130 @@ +use ruff_db::files::File; +use ruff_python_ast::{self as ast, AnyNodeRef}; +use ruff_text_size::{Ranged, TextRange}; + +use crate::Db; +use crate::ast_node_ref::AstNodeRef; +use crate::semantic_index::ast_ids::{HasScopedExpressionId, ScopedExpressionId}; +use crate::semantic_index::expression::Expression; +use crate::semantic_index::symbol::{FileScopeId, ScopeId}; + +/// This ingredient represents a single unpacking. +/// +/// This is required to make use of salsa to cache the complete unpacking of multiple variables +/// involved. It allows us to: +/// 1. Avoid doing structural match multiple times for each definition +/// 2. Avoid highlighting the same error multiple times +/// +/// ## Module-local type +/// This type should not be used as part of any cross-module API because +/// it holds a reference to the AST node. Range-offset changes +/// then propagate through all usages, and deserialization requires +/// reparsing the entire module. +/// +/// E.g. don't use this type in: +/// +/// * a return type of a cross-module query +/// * a field of a type that is a return type of a cross-module query +/// * an argument of a cross-module query +#[salsa::tracked(debug)] +pub(crate) struct Unpack<'db> { + pub(crate) file: File, + + pub(crate) value_file_scope: FileScopeId, + + pub(crate) target_file_scope: FileScopeId, + + /// The target expression that is being unpacked. For example, in `(a, b) = (1, 2)`, the target + /// expression is `(a, b)`. + #[no_eq] + #[returns(deref)] + #[tracked] + pub(crate) target: AstNodeRef<ast::Expr>, + + /// The ingredient representing the value expression of the unpacking. For example, in + /// `(a, b) = (1, 2)`, the value expression is `(1, 2)`. + pub(crate) value: UnpackValue<'db>, + + count: countme::Count<Unpack<'static>>, +} + +impl<'db> Unpack<'db> { + /// Returns the scope in which the unpack value expression belongs. + /// + /// The scope in which the target and value expression belongs to are usually the same + /// except in generator expressions and comprehensions (list/dict/set), where the value + /// expression of the first generator is evaluated in the outer scope, while the ones in the subsequent + /// generators are evaluated in the comprehension scope. + pub(crate) fn value_scope(self, db: &'db dyn Db) -> ScopeId<'db> { + self.value_file_scope(db).to_scope_id(db, self.file(db)) + } + + /// Returns the scope where the unpack target expression belongs to. + pub(crate) fn target_scope(self, db: &'db dyn Db) -> ScopeId<'db> { + self.target_file_scope(db).to_scope_id(db, self.file(db)) + } + + /// Returns the range of the unpack target expression. + pub(crate) fn range(self, db: &'db dyn Db) -> TextRange { + self.target(db).range() + } +} + +/// The expression that is being unpacked. +#[derive(Clone, Copy, Debug, Hash, salsa::Update)] +pub(crate) struct UnpackValue<'db> { + /// The kind of unpack expression + kind: UnpackKind, + /// The expression we are unpacking + expression: Expression<'db>, +} + +impl<'db> UnpackValue<'db> { + pub(crate) fn new(kind: UnpackKind, expression: Expression<'db>) -> Self { + Self { kind, expression } + } + + /// Returns the underlying [`Expression`] that is being unpacked. + pub(crate) const fn expression(self) -> Expression<'db> { + self.expression + } + + /// Returns the [`ScopedExpressionId`] of the underlying expression. + pub(crate) fn scoped_expression_id( + self, + db: &'db dyn Db, + scope: ScopeId<'db>, + ) -> ScopedExpressionId { + self.expression() + .node_ref(db) + .scoped_expression_id(db, scope) + } + + /// Returns the expression as an [`AnyNodeRef`]. + pub(crate) fn as_any_node_ref(self, db: &'db dyn Db) -> AnyNodeRef<'db> { + self.expression().node_ref(db).into() + } + + pub(crate) const fn kind(self) -> UnpackKind { + self.kind + } +} + +#[derive(Clone, Copy, Debug, Hash, salsa::Update)] +pub(crate) enum UnpackKind { + /// An iterable expression like the one in a `for` loop or a comprehension. + Iterable, + /// An context manager expression like the one in a `with` statement. + ContextManager, + /// An expression that is being assigned to a target. + Assign, +} + +/// The position of the target element in an unpacking. +#[derive(Clone, Copy, Debug, Hash, PartialEq, salsa::Update)] +pub(crate) enum UnpackPosition { + /// The target element is in the first position of the unpacking. + First, + /// The target element is in the position other than the first position of the unpacking. + Other, +} diff --git a/crates/red_knot_python_semantic/src/util/mod.rs b/crates/ty_python_semantic/src/util/mod.rs similarity index 100% rename from crates/red_knot_python_semantic/src/util/mod.rs rename to crates/ty_python_semantic/src/util/mod.rs diff --git a/crates/ty_python_semantic/src/util/subscript.rs b/crates/ty_python_semantic/src/util/subscript.rs new file mode 100644 index 0000000000000..bf0cdaec84c9b --- /dev/null +++ b/crates/ty_python_semantic/src/util/subscript.rs @@ -0,0 +1,502 @@ +//! This module provides utility functions for indexing (`PyIndex`) and slicing +//! operations (`PySlice`) on iterators, following the semantics of equivalent +//! operations in Python. + +use itertools::Either; + +#[derive(Debug, Clone, Copy, PartialEq)] +pub(crate) struct OutOfBoundsError; + +pub(crate) trait PyIndex { + type Item; + + fn py_index(&mut self, index: i32) -> Result<Self::Item, OutOfBoundsError>; +} + +fn from_nonnegative_i32(index: i32) -> usize { + static_assertions::const_assert!(usize::BITS >= 32); + debug_assert!(index >= 0); + + usize::try_from(index) + .expect("Should only ever pass a positive integer to `from_nonnegative_i32`") +} + +fn from_negative_i32(index: i32) -> usize { + static_assertions::const_assert!(usize::BITS >= 32); + + index.checked_neg().map(from_nonnegative_i32).unwrap_or({ + // 'checked_neg' only fails for i32::MIN. We can not + // represent -i32::MIN as a i32, but we can represent + // it as a usize, since usize is at least 32 bits. + from_nonnegative_i32(i32::MAX) + 1 + }) +} + +#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)] +enum Position { + BeforeStart, + AtIndex(usize), + AfterEnd, +} + +enum Nth { + FromStart(usize), + FromEnd(usize), +} + +impl Nth { + fn from_index(index: i32) -> Self { + if index >= 0 { + Nth::FromStart(from_nonnegative_i32(index)) + } else { + Nth::FromEnd(from_negative_i32(index) - 1) + } + } + + fn to_position(&self, len: usize) -> Position { + debug_assert!(len > 0); + + match self { + Nth::FromStart(nth) => { + if *nth < len { + Position::AtIndex(*nth) + } else { + Position::AfterEnd + } + } + Nth::FromEnd(nth_rev) => { + if *nth_rev < len { + Position::AtIndex(len - 1 - *nth_rev) + } else { + Position::BeforeStart + } + } + } + } +} + +impl<I, T> PyIndex for T +where + T: DoubleEndedIterator<Item = I>, +{ + type Item = I; + + fn py_index(&mut self, index: i32) -> Result<I, OutOfBoundsError> { + match Nth::from_index(index) { + Nth::FromStart(nth) => self.nth(nth).ok_or(OutOfBoundsError), + Nth::FromEnd(nth_rev) => self.nth_back(nth_rev).ok_or(OutOfBoundsError), + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq)] +pub(crate) struct StepSizeZeroError; + +pub(crate) trait PySlice { + type Item; + + fn py_slice( + &self, + start: Option<i32>, + stop: Option<i32>, + step: Option<i32>, + ) -> Result< + Either<impl Iterator<Item = &Self::Item>, impl Iterator<Item = &Self::Item>>, + StepSizeZeroError, + >; +} + +impl<T> PySlice for [T] { + type Item = T; + + fn py_slice( + &self, + start: Option<i32>, + stop: Option<i32>, + step_int: Option<i32>, + ) -> Result< + Either<impl Iterator<Item = &Self::Item>, impl Iterator<Item = &Self::Item>>, + StepSizeZeroError, + > { + let step_int = step_int.unwrap_or(1); + if step_int == 0 { + return Err(StepSizeZeroError); + } + + let len = self.len(); + if len == 0 { + // The iterator needs to have the same type as the step>0 case below, + // so we need to use `.skip(0)`. + #[expect(clippy::iter_skip_zero)] + return Ok(Either::Left(self.iter().skip(0).take(0).step_by(1))); + } + + let to_position = |index| Nth::from_index(index).to_position(len); + + if step_int.is_positive() { + let step = from_nonnegative_i32(step_int); + + let start = start.map(to_position).unwrap_or(Position::BeforeStart); + let stop = stop.map(to_position).unwrap_or(Position::AfterEnd); + + let (skip, take, step) = if start < stop { + let skip = match start { + Position::BeforeStart => 0, + Position::AtIndex(start_index) => start_index, + Position::AfterEnd => len, + }; + + let take = match stop { + Position::BeforeStart => 0, + Position::AtIndex(stop_index) => stop_index - skip, + Position::AfterEnd => len - skip, + }; + + (skip, take, step) + } else { + (0, 0, step) + }; + + Ok(Either::Left( + self.iter().skip(skip).take(take).step_by(step), + )) + } else { + let step = from_negative_i32(step_int); + + let start = start.map(to_position).unwrap_or(Position::AfterEnd); + let stop = stop.map(to_position).unwrap_or(Position::BeforeStart); + + let (skip, take, step) = if start <= stop { + (0, 0, step) + } else { + let skip = match start { + Position::BeforeStart => len, + Position::AtIndex(start_index) => len - 1 - start_index, + Position::AfterEnd => 0, + }; + + let take = match stop { + Position::BeforeStart => len - skip, + Position::AtIndex(stop_index) => (len - 1) - skip - stop_index, + Position::AfterEnd => 0, + }; + + (skip, take, step) + }; + + Ok(Either::Right( + self.iter().rev().skip(skip).take(take).step_by(step), + )) + } + } +} + +#[cfg(test)] +#[expect(clippy::redundant_clone)] +mod tests { + use crate::util::subscript::{OutOfBoundsError, StepSizeZeroError}; + + use super::{PyIndex, PySlice}; + use itertools::assert_equal; + + #[test] + fn py_index_empty() { + let iter = std::iter::empty::<char>(); + + assert_eq!(iter.clone().py_index(0), Err(OutOfBoundsError)); + assert_eq!(iter.clone().py_index(1), Err(OutOfBoundsError)); + assert_eq!(iter.clone().py_index(-1), Err(OutOfBoundsError)); + assert_eq!(iter.clone().py_index(i32::MIN), Err(OutOfBoundsError)); + assert_eq!(iter.clone().py_index(i32::MAX), Err(OutOfBoundsError)); + } + + #[test] + fn py_index_single_element() { + let iter = ['a'].into_iter(); + + assert_eq!(iter.clone().py_index(0), Ok('a')); + assert_eq!(iter.clone().py_index(1), Err(OutOfBoundsError)); + assert_eq!(iter.clone().py_index(-1), Ok('a')); + assert_eq!(iter.clone().py_index(-2), Err(OutOfBoundsError)); + } + + #[test] + fn py_index_more_elements() { + let iter = ['a', 'b', 'c', 'd', 'e'].into_iter(); + + assert_eq!(iter.clone().py_index(0), Ok('a')); + assert_eq!(iter.clone().py_index(1), Ok('b')); + assert_eq!(iter.clone().py_index(4), Ok('e')); + assert_eq!(iter.clone().py_index(5), Err(OutOfBoundsError)); + + assert_eq!(iter.clone().py_index(-1), Ok('e')); + assert_eq!(iter.clone().py_index(-2), Ok('d')); + assert_eq!(iter.clone().py_index(-5), Ok('a')); + assert_eq!(iter.clone().py_index(-6), Err(OutOfBoundsError)); + } + + #[test] + fn py_index_uses_full_index_range() { + let iter = 0..=u32::MAX; + + // u32::MAX - |i32::MIN| + 1 = 2^32 - 1 - 2^31 + 1 = 2^31 + assert_eq!(iter.clone().py_index(i32::MIN), Ok(2u32.pow(31))); + assert_eq!(iter.clone().py_index(-2), Ok(u32::MAX - 2 + 1)); + assert_eq!(iter.clone().py_index(-1), Ok(u32::MAX - 1 + 1)); + + assert_eq!(iter.clone().py_index(0), Ok(0)); + assert_eq!(iter.clone().py_index(1), Ok(1)); + assert_eq!(iter.clone().py_index(i32::MAX), Ok(i32::MAX as u32)); + } + + #[track_caller] + fn assert_eq_slice<const N: usize, const M: usize>( + input: &[char; N], + start: Option<i32>, + stop: Option<i32>, + step: Option<i32>, + expected: &[char; M], + ) { + assert_equal(input.py_slice(start, stop, step).unwrap(), expected.iter()); + } + + #[test] + fn py_slice_empty_input() { + let input = []; + + assert_eq_slice(&input, None, None, None, &[]); + assert_eq_slice(&input, Some(0), None, None, &[]); + assert_eq_slice(&input, None, Some(0), None, &[]); + assert_eq_slice(&input, Some(0), Some(0), None, &[]); + assert_eq_slice(&input, Some(-5), Some(-5), None, &[]); + assert_eq_slice(&input, None, None, Some(-1), &[]); + assert_eq_slice(&input, None, None, Some(2), &[]); + } + + #[test] + fn py_slice_single_element_input() { + let input = ['a']; + + assert_eq_slice(&input, None, None, None, &['a']); + + assert_eq_slice(&input, Some(0), None, None, &['a']); + assert_eq_slice(&input, None, Some(0), None, &[]); + assert_eq_slice(&input, Some(0), Some(0), None, &[]); + assert_eq_slice(&input, Some(0), Some(1), None, &['a']); + assert_eq_slice(&input, Some(0), Some(2), None, &['a']); + + assert_eq_slice(&input, Some(-1), None, None, &['a']); + assert_eq_slice(&input, Some(-1), Some(-1), None, &[]); + assert_eq_slice(&input, Some(-1), Some(0), None, &[]); + assert_eq_slice(&input, Some(-1), Some(1), None, &['a']); + assert_eq_slice(&input, Some(-1), Some(2), None, &['a']); + assert_eq_slice(&input, None, Some(-1), None, &[]); + + assert_eq_slice(&input, Some(-2), None, None, &['a']); + assert_eq_slice(&input, Some(-2), Some(-1), None, &[]); + assert_eq_slice(&input, Some(-2), Some(0), None, &[]); + assert_eq_slice(&input, Some(-2), Some(1), None, &['a']); + assert_eq_slice(&input, Some(-2), Some(2), None, &['a']); + } + + #[test] + fn py_slice_nonnegative_indices() { + let input = ['a', 'b', 'c', 'd', 'e']; + + assert_eq_slice(&input, None, Some(0), None, &[]); + assert_eq_slice(&input, None, Some(1), None, &['a']); + assert_eq_slice(&input, None, Some(4), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, None, Some(5), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, None, Some(6), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, None, None, None, &['a', 'b', 'c', 'd', 'e']); + + assert_eq_slice(&input, Some(0), Some(0), None, &[]); + assert_eq_slice(&input, Some(0), Some(1), None, &['a']); + assert_eq_slice(&input, Some(0), Some(4), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(0), Some(5), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(0), Some(6), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(0), None, None, &['a', 'b', 'c', 'd', 'e']); + + assert_eq_slice(&input, Some(1), Some(0), None, &[]); + assert_eq_slice(&input, Some(1), Some(1), None, &[]); + assert_eq_slice(&input, Some(1), Some(2), None, &['b']); + assert_eq_slice(&input, Some(1), Some(4), None, &['b', 'c', 'd']); + assert_eq_slice(&input, Some(1), Some(5), None, &['b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(1), Some(6), None, &['b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(1), None, None, &['b', 'c', 'd', 'e']); + + assert_eq_slice(&input, Some(4), Some(0), None, &[]); + assert_eq_slice(&input, Some(4), Some(4), None, &[]); + assert_eq_slice(&input, Some(4), Some(5), None, &['e']); + assert_eq_slice(&input, Some(4), Some(6), None, &['e']); + assert_eq_slice(&input, Some(4), None, None, &['e']); + + assert_eq_slice(&input, Some(5), Some(0), None, &[]); + assert_eq_slice(&input, Some(5), Some(5), None, &[]); + assert_eq_slice(&input, Some(5), Some(6), None, &[]); + assert_eq_slice(&input, Some(5), None, None, &[]); + + assert_eq_slice(&input, Some(6), Some(0), None, &[]); + assert_eq_slice(&input, Some(6), Some(6), None, &[]); + assert_eq_slice(&input, Some(6), None, None, &[]); + } + + #[test] + fn py_slice_negatice_indices() { + let input = ['a', 'b', 'c', 'd', 'e']; + + assert_eq_slice(&input, Some(-6), None, None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-6), Some(-1), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(-6), Some(-4), None, &['a']); + assert_eq_slice(&input, Some(-6), Some(-5), None, &[]); + assert_eq_slice(&input, Some(-6), Some(-6), None, &[]); + assert_eq_slice(&input, Some(-6), Some(-10), None, &[]); + + assert_eq_slice(&input, Some(-5), None, None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-5), Some(-1), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(-5), Some(-4), None, &['a']); + assert_eq_slice(&input, Some(-5), Some(-5), None, &[]); + assert_eq_slice(&input, Some(-5), Some(-6), None, &[]); + assert_eq_slice(&input, Some(-5), Some(-10), None, &[]); + + assert_eq_slice(&input, Some(-4), None, None, &['b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-4), Some(-1), None, &['b', 'c', 'd']); + assert_eq_slice(&input, Some(-4), Some(-3), None, &['b']); + assert_eq_slice(&input, Some(-4), Some(-4), None, &[]); + assert_eq_slice(&input, Some(-4), Some(-10), None, &[]); + + assert_eq_slice(&input, Some(-1), None, None, &['e']); + assert_eq_slice(&input, Some(-1), Some(-1), None, &[]); + assert_eq_slice(&input, Some(-1), Some(-10), None, &[]); + + assert_eq_slice(&input, None, Some(-1), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, None, Some(-4), None, &['a']); + assert_eq_slice(&input, None, Some(-5), None, &[]); + assert_eq_slice(&input, None, Some(-6), None, &[]); + } + + #[test] + fn py_slice_mixed_positive_negative_indices() { + let input = ['a', 'b', 'c', 'd', 'e']; + + assert_eq_slice(&input, Some(0), Some(-1), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(1), Some(-1), None, &['b', 'c', 'd']); + assert_eq_slice(&input, Some(3), Some(-1), None, &['d']); + assert_eq_slice(&input, Some(4), Some(-1), None, &[]); + assert_eq_slice(&input, Some(5), Some(-1), None, &[]); + + assert_eq_slice(&input, Some(0), Some(-4), None, &['a']); + assert_eq_slice(&input, Some(1), Some(-4), None, &[]); + assert_eq_slice(&input, Some(3), Some(-4), None, &[]); + + assert_eq_slice(&input, Some(0), Some(-5), None, &[]); + assert_eq_slice(&input, Some(1), Some(-5), None, &[]); + assert_eq_slice(&input, Some(3), Some(-5), None, &[]); + + assert_eq_slice(&input, Some(0), Some(-6), None, &[]); + assert_eq_slice(&input, Some(1), Some(-6), None, &[]); + + assert_eq_slice(&input, Some(-6), Some(6), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-6), Some(5), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-6), Some(4), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(-6), Some(1), None, &['a']); + assert_eq_slice(&input, Some(-6), Some(0), None, &[]); + + assert_eq_slice(&input, Some(-5), Some(6), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-5), Some(5), None, &['a', 'b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-5), Some(4), None, &['a', 'b', 'c', 'd']); + assert_eq_slice(&input, Some(-5), Some(1), None, &['a']); + assert_eq_slice(&input, Some(-5), Some(0), None, &[]); + + assert_eq_slice(&input, Some(-4), Some(6), None, &['b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-4), Some(5), None, &['b', 'c', 'd', 'e']); + assert_eq_slice(&input, Some(-4), Some(4), None, &['b', 'c', 'd']); + assert_eq_slice(&input, Some(-4), Some(2), None, &['b']); + assert_eq_slice(&input, Some(-4), Some(1), None, &[]); + assert_eq_slice(&input, Some(-4), Some(0), None, &[]); + + assert_eq_slice(&input, Some(-1), Some(6), None, &['e']); + assert_eq_slice(&input, Some(-1), Some(5), None, &['e']); + assert_eq_slice(&input, Some(-1), Some(4), None, &[]); + assert_eq_slice(&input, Some(-1), Some(1), None, &[]); + } + + #[test] + fn py_slice_step_forward() { + // indices: 0 1 2 3 4 5 6 + let input = ['a', 'b', 'c', 'd', 'e', 'f', 'g']; + + // Step size zero is invalid: + assert!(matches!( + input.py_slice(None, None, Some(0)), + Err(StepSizeZeroError) + )); + assert!(matches!( + input.py_slice(Some(0), Some(5), Some(0)), + Err(StepSizeZeroError) + )); + assert!(matches!( + input.py_slice(Some(0), Some(0), Some(0)), + Err(StepSizeZeroError) + )); + + assert_eq_slice(&input, Some(0), Some(8), Some(2), &['a', 'c', 'e', 'g']); + assert_eq_slice(&input, Some(0), Some(7), Some(2), &['a', 'c', 'e', 'g']); + assert_eq_slice(&input, Some(0), Some(6), Some(2), &['a', 'c', 'e']); + assert_eq_slice(&input, Some(0), Some(5), Some(2), &['a', 'c', 'e']); + assert_eq_slice(&input, Some(0), Some(4), Some(2), &['a', 'c']); + assert_eq_slice(&input, Some(0), Some(3), Some(2), &['a', 'c']); + assert_eq_slice(&input, Some(0), Some(2), Some(2), &['a']); + assert_eq_slice(&input, Some(0), Some(1), Some(2), &['a']); + assert_eq_slice(&input, Some(0), Some(0), Some(2), &[]); + assert_eq_slice(&input, Some(1), Some(5), Some(2), &['b', 'd']); + + assert_eq_slice(&input, Some(0), Some(7), Some(3), &['a', 'd', 'g']); + assert_eq_slice(&input, Some(0), Some(6), Some(3), &['a', 'd']); + + assert_eq_slice(&input, Some(0), None, Some(10), &['a']); + } + + #[test] + fn py_slice_step_backward() { + // indices: 0 1 2 3 4 5 6 + let input = ['a', 'b', 'c', 'd', 'e', 'f', 'g']; + + assert_eq_slice(&input, Some(7), Some(0), Some(-2), &['g', 'e', 'c']); + assert_eq_slice(&input, Some(6), Some(0), Some(-2), &['g', 'e', 'c']); + assert_eq_slice(&input, Some(5), Some(0), Some(-2), &['f', 'd', 'b']); + assert_eq_slice(&input, Some(4), Some(0), Some(-2), &['e', 'c']); + assert_eq_slice(&input, Some(3), Some(0), Some(-2), &['d', 'b']); + assert_eq_slice(&input, Some(2), Some(0), Some(-2), &['c']); + assert_eq_slice(&input, Some(1), Some(0), Some(-2), &['b']); + assert_eq_slice(&input, Some(0), Some(0), Some(-2), &[]); + + assert_eq_slice(&input, Some(7), None, Some(-2), &['g', 'e', 'c', 'a']); + assert_eq_slice(&input, None, None, Some(-2), &['g', 'e', 'c', 'a']); + assert_eq_slice(&input, None, Some(0), Some(-2), &['g', 'e', 'c']); + + assert_eq_slice(&input, Some(5), Some(1), Some(-2), &['f', 'd']); + assert_eq_slice(&input, Some(5), Some(2), Some(-2), &['f', 'd']); + assert_eq_slice(&input, Some(5), Some(3), Some(-2), &['f']); + assert_eq_slice(&input, Some(5), Some(4), Some(-2), &['f']); + assert_eq_slice(&input, Some(5), Some(5), Some(-2), &[]); + + assert_eq_slice(&input, Some(6), None, Some(-3), &['g', 'd', 'a']); + assert_eq_slice(&input, Some(6), Some(0), Some(-3), &['g', 'd']); + + assert_eq_slice(&input, Some(7), None, Some(-10), &['g']); + + assert_eq_slice(&input, Some(-6), Some(-9), Some(-1), &['b', 'a']); + assert_eq_slice(&input, Some(-6), Some(-8), Some(-1), &['b', 'a']); + assert_eq_slice(&input, Some(-6), Some(-7), Some(-1), &['b']); + assert_eq_slice(&input, Some(-6), Some(-6), Some(-1), &[]); + + assert_eq_slice(&input, Some(-7), Some(-9), Some(-1), &['a']); + + assert_eq_slice(&input, Some(-8), Some(-9), Some(-1), &[]); + assert_eq_slice(&input, Some(-9), Some(-9), Some(-1), &[]); + + assert_eq_slice(&input, Some(-6), Some(-2), Some(-1), &[]); + assert_eq_slice(&input, Some(-9), Some(-6), Some(-1), &[]); + } +} diff --git a/crates/ty_python_semantic/tests/mdtest.rs b/crates/ty_python_semantic/tests/mdtest.rs new file mode 100644 index 0000000000000..12ce72ca1f376 --- /dev/null +++ b/crates/ty_python_semantic/tests/mdtest.rs @@ -0,0 +1,68 @@ +use camino::Utf8Path; +use dir_test::{Fixture, dir_test}; +use ty_test::OutputFormat; + +/// See `crates/ty_test/README.md` for documentation on these tests. +#[dir_test( + dir: "$CARGO_MANIFEST_DIR/resources/mdtest", + glob: "**/*.md" +)] +#[expect(clippy::needless_pass_by_value)] +fn mdtest(fixture: Fixture<&str>) { + let absolute_fixture_path = Utf8Path::new(fixture.path()); + let crate_dir = Utf8Path::new(env!("CARGO_MANIFEST_DIR")); + let snapshot_path = crate_dir.join("resources").join("mdtest").join("snapshots"); + let workspace_root = crate_dir.ancestors().nth(2).unwrap(); + + let relative_fixture_path = absolute_fixture_path.strip_prefix(workspace_root).unwrap(); + let short_title = absolute_fixture_path.file_name().unwrap(); + + let test_name = test_name("mdtest", absolute_fixture_path); + + let output_format = if std::env::var("MDTEST_GITHUB_ANNOTATIONS_FORMAT").is_ok() { + OutputFormat::GitHub + } else { + OutputFormat::Cli + }; + + ty_test::run( + absolute_fixture_path, + relative_fixture_path, + &snapshot_path, + short_title, + &test_name, + output_format, + ); +} + +/// Constructs the test name used for individual markdown files +/// +/// This code is copied from <https://github.com/fe-lang/dir-test/blob/1c0f41c480a3490bc2653a043ff6e3f8085a1f47/macros/src/lib.rs#L104-L138> +/// and should be updated if they diverge +fn test_name(test_func_name: &str, fixture_path: &Utf8Path) -> String { + assert!(fixture_path.is_file()); + + let dir_path = format!("{}/resources/mdtest", std::env!("CARGO_MANIFEST_DIR")); + let rel_path = fixture_path.strip_prefix(dir_path).unwrap(); + assert!(rel_path.is_relative()); + + let mut test_name = test_func_name.to_owned(); + test_name.push_str("__"); + + for component in rel_path.parent().unwrap().components() { + let component = component + .as_str() + .replace(|c: char| c.is_ascii_punctuation(), "_"); + test_name.push_str(&component); + test_name.push('_'); + } + + test_name.push_str( + &rel_path + .file_stem() + .unwrap() + .replace(|c: char| c.is_ascii_punctuation(), "_"), + ); + + test_name +} diff --git a/crates/ty_server/Cargo.toml b/crates/ty_server/Cargo.toml new file mode 100644 index 0000000000000..0bae064fda374 --- /dev/null +++ b/crates/ty_server/Cargo.toml @@ -0,0 +1,41 @@ +[package] +name = "ty_server" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } + +[dependencies] +ruff_db = { workspace = true, features = ["os"] } +ruff_notebook = { workspace = true } +ruff_source_file = { workspace = true } +ruff_text_size = { workspace = true } + +ty_ide = { workspace = true } +ty_project = { workspace = true } +ty_python_semantic = { workspace = true } + +anyhow = { workspace = true } +crossbeam = { workspace = true } +jod-thread = { workspace = true } +lsp-server = { workspace = true } +lsp-types = { workspace = true } +rustc-hash = { workspace = true } +serde = { workspace = true } +serde_json = { workspace = true } +shellexpand = { workspace = true } +tracing = { workspace = true } +tracing-subscriber = { workspace = true } + +[dev-dependencies] + +[target.'cfg(target_vendor = "apple")'.dependencies] +libc = { workspace = true } + +[lints] +workspace = true diff --git a/crates/ty_server/src/document.rs b/crates/ty_server/src/document.rs new file mode 100644 index 0000000000000..dade6a7fd1867 --- /dev/null +++ b/crates/ty_server/src/document.rs @@ -0,0 +1,92 @@ +//! Types and utilities for working with text, modifying source files, and `ty <-> LSP` type conversion. + +mod location; +mod notebook; +mod range; +mod text_document; + +pub(crate) use location::ToLink; +use lsp_types::{PositionEncodingKind, Url}; +pub use notebook::NotebookDocument; +pub(crate) use range::{FileRangeExt, PositionExt, RangeExt, TextSizeExt, ToRangeExt}; +pub(crate) use text_document::DocumentVersion; +pub use text_document::TextDocument; + +/// A convenient enumeration for supported text encodings. Can be converted to [`lsp_types::PositionEncodingKind`]. +// Please maintain the order from least to greatest priority for the derived `Ord` impl. +#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)] +pub enum PositionEncoding { + /// UTF 16 is the encoding supported by all LSP clients. + #[default] + UTF16, + + /// Second choice because UTF32 uses a fixed 4 byte encoding for each character (makes conversion relatively easy) + UTF32, + + /// ty's preferred encoding + UTF8, +} + +impl From<PositionEncoding> for ruff_source_file::PositionEncoding { + fn from(value: PositionEncoding) -> Self { + match value { + PositionEncoding::UTF8 => Self::Utf8, + PositionEncoding::UTF16 => Self::Utf16, + PositionEncoding::UTF32 => Self::Utf32, + } + } +} + +/// A unique document ID, derived from a URL passed as part of an LSP request. +/// This document ID can point to either be a standalone Python file, a full notebook, or a cell within a notebook. +#[derive(Clone, Debug)] +pub enum DocumentKey { + Notebook(Url), + NotebookCell(Url), + Text(Url), +} + +impl DocumentKey { + /// Returns the URL associated with the key. + pub(crate) fn url(&self) -> &Url { + match self { + DocumentKey::NotebookCell(url) + | DocumentKey::Notebook(url) + | DocumentKey::Text(url) => url, + } + } +} + +impl std::fmt::Display for DocumentKey { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::NotebookCell(url) | Self::Notebook(url) | Self::Text(url) => url.fmt(f), + } + } +} + +impl From<PositionEncoding> for PositionEncodingKind { + fn from(value: PositionEncoding) -> Self { + match value { + PositionEncoding::UTF8 => PositionEncodingKind::UTF8, + PositionEncoding::UTF16 => PositionEncodingKind::UTF16, + PositionEncoding::UTF32 => PositionEncodingKind::UTF32, + } + } +} + +impl TryFrom<&PositionEncodingKind> for PositionEncoding { + type Error = (); + + fn try_from(value: &PositionEncodingKind) -> Result<Self, Self::Error> { + Ok(if value == &PositionEncodingKind::UTF8 { + PositionEncoding::UTF8 + } else if value == &PositionEncodingKind::UTF16 { + PositionEncoding::UTF16 + } else if value == &PositionEncodingKind::UTF32 { + PositionEncoding::UTF32 + } else { + return Err(()); + }) + } +} diff --git a/crates/ty_server/src/document/location.rs b/crates/ty_server/src/document/location.rs new file mode 100644 index 0000000000000..50b8f91aee202 --- /dev/null +++ b/crates/ty_server/src/document/location.rs @@ -0,0 +1,54 @@ +use crate::PositionEncoding; +use crate::document::{FileRangeExt, ToRangeExt}; +use crate::system::file_to_url; +use lsp_types::Location; +use ruff_db::files::FileRange; +use ruff_db::source::{line_index, source_text}; +use ruff_text_size::Ranged; +use ty_ide::{Db, NavigationTarget}; + +pub(crate) trait ToLink { + fn to_location(&self, db: &dyn ty_ide::Db, encoding: PositionEncoding) -> Option<Location>; + + fn to_link( + &self, + db: &dyn ty_ide::Db, + src: Option<FileRange>, + encoding: PositionEncoding, + ) -> Option<lsp_types::LocationLink>; +} + +impl ToLink for NavigationTarget { + fn to_location(&self, db: &dyn Db, encoding: PositionEncoding) -> Option<Location> { + FileRange::new(self.file(), self.focus_range()).to_location(db.upcast(), encoding) + } + + fn to_link( + &self, + db: &dyn Db, + src: Option<FileRange>, + encoding: PositionEncoding, + ) -> Option<lsp_types::LocationLink> { + let file = self.file(); + let uri = file_to_url(db.upcast(), file)?; + let source = source_text(db.upcast(), file); + let index = line_index(db.upcast(), file); + + let target_range = self.full_range().to_lsp_range(&source, &index, encoding); + let selection_range = self.focus_range().to_lsp_range(&source, &index, encoding); + + let src = src.map(|src| { + let source = source_text(db.upcast(), src.file()); + let index = line_index(db.upcast(), src.file()); + + src.range().to_lsp_range(&source, &index, encoding) + }); + + Some(lsp_types::LocationLink { + target_uri: uri, + target_range, + target_selection_range: selection_range, + origin_selection_range: src, + }) + } +} diff --git a/crates/ty_server/src/document/notebook.rs b/crates/ty_server/src/document/notebook.rs new file mode 100644 index 0000000000000..e25d031bdac48 --- /dev/null +++ b/crates/ty_server/src/document/notebook.rs @@ -0,0 +1,356 @@ +use anyhow::Ok; +use lsp_types::NotebookCellKind; +use ruff_notebook::CellMetadata; +use rustc_hash::{FxBuildHasher, FxHashMap}; + +use crate::{PositionEncoding, TextDocument}; + +use super::DocumentVersion; + +pub(super) type CellId = usize; + +/// The state of a notebook document in the server. Contains an array of cells whose +/// contents are internally represented by [`TextDocument`]s. +#[derive(Clone, Debug)] +pub struct NotebookDocument { + cells: Vec<NotebookCell>, + metadata: ruff_notebook::RawNotebookMetadata, + version: DocumentVersion, + // Used to quickly find the index of a cell for a given URL. + cell_index: FxHashMap<lsp_types::Url, CellId>, +} + +/// A single cell within a notebook, which has text contents represented as a `TextDocument`. +#[derive(Clone, Debug)] +struct NotebookCell { + url: lsp_types::Url, + kind: NotebookCellKind, + document: TextDocument, +} + +impl NotebookDocument { + pub fn new( + version: DocumentVersion, + cells: Vec<lsp_types::NotebookCell>, + metadata: serde_json::Map<String, serde_json::Value>, + cell_documents: Vec<lsp_types::TextDocumentItem>, + ) -> crate::Result<Self> { + let mut cell_contents: FxHashMap<_, _> = cell_documents + .into_iter() + .map(|document| (document.uri, document.text)) + .collect(); + + let cells: Vec<_> = cells + .into_iter() + .map(|cell| { + let contents = cell_contents.remove(&cell.document).unwrap_or_default(); + NotebookCell::new(cell, contents, version) + }) + .collect(); + + Ok(Self { + version, + cell_index: Self::make_cell_index(cells.as_slice()), + metadata: serde_json::from_value(serde_json::Value::Object(metadata))?, + cells, + }) + } + + /// Generates a pseudo-representation of a notebook that lacks per-cell metadata and contextual information + /// but should still work with Ruff's linter. + pub fn make_ruff_notebook(&self) -> ruff_notebook::Notebook { + let cells = self + .cells + .iter() + .map(|cell| match cell.kind { + NotebookCellKind::Code => ruff_notebook::Cell::Code(ruff_notebook::CodeCell { + execution_count: None, + id: None, + metadata: CellMetadata::default(), + outputs: vec![], + source: ruff_notebook::SourceValue::String( + cell.document.contents().to_string(), + ), + }), + NotebookCellKind::Markup => { + ruff_notebook::Cell::Markdown(ruff_notebook::MarkdownCell { + attachments: None, + id: None, + metadata: CellMetadata::default(), + source: ruff_notebook::SourceValue::String( + cell.document.contents().to_string(), + ), + }) + } + }) + .collect(); + let raw_notebook = ruff_notebook::RawNotebook { + cells, + metadata: self.metadata.clone(), + nbformat: 4, + nbformat_minor: 5, + }; + + ruff_notebook::Notebook::from_raw_notebook(raw_notebook, false) + .unwrap_or_else(|err| panic!("Server notebook document could not be converted to ty's notebook document format: {err}")) + } + + pub(crate) fn update( + &mut self, + cells: Option<lsp_types::NotebookDocumentCellChange>, + metadata_change: Option<serde_json::Map<String, serde_json::Value>>, + version: DocumentVersion, + encoding: PositionEncoding, + ) -> crate::Result<()> { + self.version = version; + + if let Some(lsp_types::NotebookDocumentCellChange { + structure, + data, + text_content, + }) = cells + { + // The structural changes should be done first, as they may affect the cell index. + if let Some(structure) = structure { + let start = structure.array.start as usize; + let delete = structure.array.delete_count as usize; + + // This is required because of the way the `NotebookCell` is modelled. We include + // the `TextDocument` within the `NotebookCell` so when it's deleted, the + // corresponding `TextDocument` is removed as well. But, when cells are + // re-ordered, the change request doesn't provide the actual contents of the cell. + // Instead, it only provides that (a) these cell URIs were removed, and (b) these + // cell URIs were added. + // https://github.com/astral-sh/ruff/issues/12573 + let mut deleted_cells = FxHashMap::default(); + + // First, delete the cells and remove them from the index. + if delete > 0 { + for cell in self.cells.drain(start..start + delete) { + self.cell_index.remove(&cell.url); + deleted_cells.insert(cell.url, cell.document); + } + } + + // Second, insert the new cells with the available information. This array does not + // provide the actual contents of the cells, so we'll initialize them with empty + // contents. + for cell in structure.array.cells.into_iter().flatten().rev() { + let (content, version) = + if let Some(text_document) = deleted_cells.remove(&cell.document) { + let version = text_document.version(); + (text_document.into_contents(), version) + } else { + (String::new(), 0) + }; + self.cells + .insert(start, NotebookCell::new(cell, content, version)); + } + + // Third, register the new cells in the index and update existing ones that came + // after the insertion. + for (index, cell) in self.cells.iter().enumerate().skip(start) { + self.cell_index.insert(cell.url.clone(), index); + } + + // Finally, update the text document that represents the cell with the actual + // contents. This should be done at the end so that both the `cells` and + // `cell_index` are updated before we start applying the changes to the cells. + if let Some(did_open) = structure.did_open { + for cell_text_document in did_open { + if let Some(cell) = self.cell_by_uri_mut(&cell_text_document.uri) { + cell.document = TextDocument::new( + cell_text_document.text, + cell_text_document.version, + ); + } + } + } + } + + if let Some(cell_data) = data { + for cell in cell_data { + if let Some(existing_cell) = self.cell_by_uri_mut(&cell.document) { + existing_cell.kind = cell.kind; + } + } + } + + if let Some(content_changes) = text_content { + for content_change in content_changes { + if let Some(cell) = self.cell_by_uri_mut(&content_change.document.uri) { + cell.document + .apply_changes(content_change.changes, version, encoding); + } + } + } + } + + if let Some(metadata_change) = metadata_change { + self.metadata = serde_json::from_value(serde_json::Value::Object(metadata_change))?; + } + + Ok(()) + } + + /// Get the current version of the notebook document. + pub(crate) fn version(&self) -> DocumentVersion { + self.version + } + + /// Get the URI for a cell by its index within the cell array. + #[expect(dead_code)] + pub(crate) fn cell_uri_by_index(&self, index: CellId) -> Option<&lsp_types::Url> { + self.cells.get(index).map(|cell| &cell.url) + } + + /// Get the text document representing the contents of a cell by the cell URI. + pub(crate) fn cell_document_by_uri(&self, uri: &lsp_types::Url) -> Option<&TextDocument> { + self.cells + .get(*self.cell_index.get(uri)?) + .map(|cell| &cell.document) + } + + /// Returns a list of cell URIs in the order they appear in the array. + pub(crate) fn urls(&self) -> impl Iterator<Item = &lsp_types::Url> { + self.cells.iter().map(|cell| &cell.url) + } + + fn cell_by_uri_mut(&mut self, uri: &lsp_types::Url) -> Option<&mut NotebookCell> { + self.cells.get_mut(*self.cell_index.get(uri)?) + } + + fn make_cell_index(cells: &[NotebookCell]) -> FxHashMap<lsp_types::Url, CellId> { + let mut index = FxHashMap::with_capacity_and_hasher(cells.len(), FxBuildHasher); + for (i, cell) in cells.iter().enumerate() { + index.insert(cell.url.clone(), i); + } + index + } +} + +impl NotebookCell { + pub(crate) fn new( + cell: lsp_types::NotebookCell, + contents: String, + version: DocumentVersion, + ) -> Self { + Self { + url: cell.document, + kind: cell.kind, + document: TextDocument::new(contents, version), + } + } +} + +#[cfg(test)] +mod tests { + use super::NotebookDocument; + + enum TestCellContent { + #[expect(dead_code)] + Markup(String), + Code(String), + } + + fn create_test_url(index: usize) -> lsp_types::Url { + lsp_types::Url::parse(&format!("cell:/test.ipynb#{index}")).unwrap() + } + + fn create_test_notebook(test_cells: Vec<TestCellContent>) -> NotebookDocument { + let mut cells = Vec::with_capacity(test_cells.len()); + let mut cell_documents = Vec::with_capacity(test_cells.len()); + + for (index, test_cell) in test_cells.into_iter().enumerate() { + let url = create_test_url(index); + match test_cell { + TestCellContent::Markup(content) => { + cells.push(lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Markup, + document: url.clone(), + metadata: None, + execution_summary: None, + }); + cell_documents.push(lsp_types::TextDocumentItem { + uri: url, + language_id: "markdown".to_owned(), + version: 0, + text: content, + }); + } + TestCellContent::Code(content) => { + cells.push(lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: url.clone(), + metadata: None, + execution_summary: None, + }); + cell_documents.push(lsp_types::TextDocumentItem { + uri: url, + language_id: "python".to_owned(), + version: 0, + text: content, + }); + } + } + } + + NotebookDocument::new(0, cells, serde_json::Map::default(), cell_documents).unwrap() + } + + /// This test case checks that for a notebook with three code cells, when the client sends a + /// change request to swap the first two cells, the notebook document is updated correctly. + /// + /// The swap operation as a change request is represented as deleting the first two cells and + /// adding them back in the reverse order. + #[test] + fn swap_cells() { + let mut notebook = create_test_notebook(vec![ + TestCellContent::Code("cell = 0".to_owned()), + TestCellContent::Code("cell = 1".to_owned()), + TestCellContent::Code("cell = 2".to_owned()), + ]); + + notebook + .update( + Some(lsp_types::NotebookDocumentCellChange { + structure: Some(lsp_types::NotebookDocumentCellChangeStructure { + array: lsp_types::NotebookCellArrayChange { + start: 0, + delete_count: 2, + cells: Some(vec![ + lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: create_test_url(1), + metadata: None, + execution_summary: None, + }, + lsp_types::NotebookCell { + kind: lsp_types::NotebookCellKind::Code, + document: create_test_url(0), + metadata: None, + execution_summary: None, + }, + ]), + }, + did_open: None, + did_close: None, + }), + data: None, + text_content: None, + }), + None, + 1, + crate::PositionEncoding::default(), + ) + .unwrap(); + + assert_eq!( + notebook.make_ruff_notebook().source_code(), + "cell = 1 +cell = 0 +cell = 2 +" + ); + } +} diff --git a/crates/ty_server/src/document/range.rs b/crates/ty_server/src/document/range.rs new file mode 100644 index 0000000000000..c399a181b6046 --- /dev/null +++ b/crates/ty_server/src/document/range.rs @@ -0,0 +1,172 @@ +use super::PositionEncoding; +use super::notebook; +use crate::system::file_to_url; + +use lsp_types as types; +use lsp_types::Location; + +use ruff_db::files::FileRange; +use ruff_db::source::{line_index, source_text}; +use ruff_notebook::NotebookIndex; +use ruff_source_file::LineIndex; +use ruff_source_file::{OneIndexed, SourceLocation}; +use ruff_text_size::{Ranged, TextRange, TextSize}; +use ty_python_semantic::Db; + +#[expect(dead_code)] +pub(crate) struct NotebookRange { + pub(crate) cell: notebook::CellId, + pub(crate) range: types::Range, +} + +pub(crate) trait RangeExt { + fn to_text_range(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) + -> TextRange; +} + +pub(crate) trait PositionExt { + fn to_text_size(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) -> TextSize; +} + +pub(crate) trait TextSizeExt { + fn to_position( + self, + text: &str, + index: &LineIndex, + encoding: PositionEncoding, + ) -> types::Position + where + Self: Sized; +} + +impl TextSizeExt for TextSize { + fn to_position( + self, + text: &str, + index: &LineIndex, + encoding: PositionEncoding, + ) -> types::Position { + let source_location = index.source_location(self, text, encoding.into()); + source_location_to_position(&source_location) + } +} + +pub(crate) trait ToRangeExt { + fn to_lsp_range( + &self, + text: &str, + index: &LineIndex, + encoding: PositionEncoding, + ) -> types::Range; + + #[expect(dead_code)] + fn to_notebook_range( + &self, + text: &str, + source_index: &LineIndex, + notebook_index: &NotebookIndex, + encoding: PositionEncoding, + ) -> NotebookRange; +} + +fn u32_index_to_usize(index: u32) -> usize { + usize::try_from(index).expect("u32 fits in usize") +} + +impl PositionExt for lsp_types::Position { + fn to_text_size(&self, text: &str, index: &LineIndex, encoding: PositionEncoding) -> TextSize { + index.offset( + SourceLocation { + line: OneIndexed::from_zero_indexed(u32_index_to_usize(self.line)), + character_offset: OneIndexed::from_zero_indexed(u32_index_to_usize(self.character)), + }, + text, + encoding.into(), + ) + } +} + +impl RangeExt for lsp_types::Range { + fn to_text_range( + &self, + text: &str, + index: &LineIndex, + encoding: PositionEncoding, + ) -> TextRange { + TextRange::new( + self.start.to_text_size(text, index, encoding), + self.end.to_text_size(text, index, encoding), + ) + } +} + +impl ToRangeExt for TextRange { + fn to_lsp_range( + &self, + text: &str, + index: &LineIndex, + encoding: PositionEncoding, + ) -> types::Range { + types::Range { + start: self.start().to_position(text, index, encoding), + end: self.end().to_position(text, index, encoding), + } + } + + fn to_notebook_range( + &self, + text: &str, + source_index: &LineIndex, + notebook_index: &NotebookIndex, + encoding: PositionEncoding, + ) -> NotebookRange { + let start = source_index.source_location(self.start(), text, encoding.into()); + let mut end = source_index.source_location(self.end(), text, encoding.into()); + let starting_cell = notebook_index.cell(start.line); + + // weird edge case here - if the end of the range is where the newline after the cell got added (making it 'out of bounds') + // we need to move it one character back (which should place it at the end of the last line). + // we test this by checking if the ending offset is in a different (or nonexistent) cell compared to the cell of the starting offset. + if notebook_index.cell(end.line) != starting_cell { + end.line = end.line.saturating_sub(1); + let offset = self.end().checked_sub(1.into()).unwrap_or_default(); + end.character_offset = source_index + .source_location(offset, text, encoding.into()) + .character_offset; + } + + let start = source_location_to_position(¬ebook_index.translate_source_location(&start)); + let end = source_location_to_position(¬ebook_index.translate_source_location(&end)); + + NotebookRange { + cell: starting_cell + .map(OneIndexed::to_zero_indexed) + .unwrap_or_default(), + range: types::Range { start, end }, + } + } +} + +fn source_location_to_position(location: &SourceLocation) -> types::Position { + types::Position { + line: u32::try_from(location.line.to_zero_indexed()).expect("line usize fits in u32"), + character: u32::try_from(location.character_offset.to_zero_indexed()) + .expect("character usize fits in u32"), + } +} + +pub(crate) trait FileRangeExt { + fn to_location(&self, db: &dyn Db, encoding: PositionEncoding) -> Option<Location>; +} + +impl FileRangeExt for FileRange { + fn to_location(&self, db: &dyn Db, encoding: PositionEncoding) -> Option<Location> { + let file = self.file(); + let uri = file_to_url(db, file)?; + let source = source_text(db.upcast(), file); + let line_index = line_index(db.upcast(), file); + + let range = self.range().to_lsp_range(&source, &line_index, encoding); + Some(Location { uri, range }) + } +} diff --git a/crates/ty_server/src/document/text_document.rs b/crates/ty_server/src/document/text_document.rs new file mode 100644 index 0000000000000..e5d00ff0cf176 --- /dev/null +++ b/crates/ty_server/src/document/text_document.rs @@ -0,0 +1,224 @@ +use lsp_types::TextDocumentContentChangeEvent; +use ruff_source_file::LineIndex; + +use crate::PositionEncoding; + +use super::RangeExt; + +pub(crate) type DocumentVersion = i32; + +/// The state of an individual document in the server. Stays up-to-date +/// with changes made by the user, including unsaved changes. +#[derive(Debug, Clone)] +pub struct TextDocument { + /// The string contents of the document. + contents: String, + /// A computed line index for the document. This should always reflect + /// the current version of `contents`. Using a function like [`Self::modify`] + /// will re-calculate the line index automatically when the `contents` value is updated. + index: LineIndex, + /// The latest version of the document, set by the LSP client. The server will panic in + /// debug mode if we attempt to update the document with an 'older' version. + version: DocumentVersion, + /// The language ID of the document as provided by the client. + language_id: Option<LanguageId>, +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub enum LanguageId { + Python, + Other, +} + +impl From<&str> for LanguageId { + fn from(language_id: &str) -> Self { + match language_id { + "python" => Self::Python, + _ => Self::Other, + } + } +} + +impl TextDocument { + pub fn new(contents: String, version: DocumentVersion) -> Self { + let index = LineIndex::from_source_text(&contents); + Self { + contents, + index, + version, + language_id: None, + } + } + + #[must_use] + pub fn with_language_id(mut self, language_id: &str) -> Self { + self.language_id = Some(LanguageId::from(language_id)); + self + } + + pub fn into_contents(self) -> String { + self.contents + } + + pub fn contents(&self) -> &str { + &self.contents + } + + pub fn index(&self) -> &LineIndex { + &self.index + } + + pub fn version(&self) -> DocumentVersion { + self.version + } + + pub fn language_id(&self) -> Option<LanguageId> { + self.language_id + } + + pub fn apply_changes( + &mut self, + changes: Vec<lsp_types::TextDocumentContentChangeEvent>, + new_version: DocumentVersion, + encoding: PositionEncoding, + ) { + if let [ + lsp_types::TextDocumentContentChangeEvent { + range: None, text, .. + }, + ] = changes.as_slice() + { + tracing::debug!("Fast path - replacing entire document"); + self.modify(|contents, version| { + contents.clone_from(text); + *version = new_version; + }); + return; + } + + let mut new_contents = self.contents().to_string(); + let mut active_index = self.index().clone(); + + for TextDocumentContentChangeEvent { + range, + text: change, + .. + } in changes + { + if let Some(range) = range { + let range = range.to_text_range(&new_contents, &active_index, encoding); + + new_contents.replace_range( + usize::from(range.start())..usize::from(range.end()), + &change, + ); + } else { + new_contents = change; + } + + active_index = LineIndex::from_source_text(&new_contents); + } + + self.modify_with_manual_index(|contents, version, index| { + *index = active_index; + *contents = new_contents; + *version = new_version; + }); + } + + pub fn update_version(&mut self, new_version: DocumentVersion) { + self.modify_with_manual_index(|_, version, _| { + *version = new_version; + }); + } + + // A private function for modifying the document's internal state + fn modify(&mut self, func: impl FnOnce(&mut String, &mut DocumentVersion)) { + self.modify_with_manual_index(|c, v, i| { + func(c, v); + *i = LineIndex::from_source_text(c); + }); + } + + // A private function for overriding how we update the line index by default. + fn modify_with_manual_index( + &mut self, + func: impl FnOnce(&mut String, &mut DocumentVersion, &mut LineIndex), + ) { + let old_version = self.version; + func(&mut self.contents, &mut self.version, &mut self.index); + debug_assert!(self.version >= old_version); + } +} + +#[cfg(test)] +mod tests { + use crate::{PositionEncoding, TextDocument}; + use lsp_types::{Position, TextDocumentContentChangeEvent}; + + #[test] + fn redo_edit() { + let mut document = TextDocument::new( + r#"""" +测试comment +一些测试内容 +""" +import click + + +@click.group() +def interface(): + pas +"# + .to_string(), + 0, + ); + + // Add an `s`, remove it again (back to the original code), and then re-add the `s` + document.apply_changes( + vec![ + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 7), + )), + range_length: Some(0), + text: "s".to_string(), + }, + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 8), + )), + range_length: Some(1), + text: String::new(), + }, + TextDocumentContentChangeEvent { + range: Some(lsp_types::Range::new( + Position::new(9, 7), + Position::new(9, 7), + )), + range_length: Some(0), + text: "s".to_string(), + }, + ], + 1, + PositionEncoding::UTF16, + ); + + assert_eq!( + &document.contents, + r#"""" +测试comment +一些测试内容 +""" +import click + + +@click.group() +def interface(): + pass +"# + ); + } +} diff --git a/crates/ty_server/src/lib.rs b/crates/ty_server/src/lib.rs new file mode 100644 index 0000000000000..efc27184c7219 --- /dev/null +++ b/crates/ty_server/src/lib.rs @@ -0,0 +1,40 @@ +use crate::server::Server; +use anyhow::Context; +pub use document::{DocumentKey, NotebookDocument, PositionEncoding, TextDocument}; +pub use session::{ClientSettings, DocumentQuery, DocumentSnapshot, Session}; +use std::num::NonZeroUsize; + +#[macro_use] +mod message; + +mod document; +mod logging; +mod server; +mod session; +mod system; + +pub(crate) const SERVER_NAME: &str = "ty"; +pub(crate) const DIAGNOSTIC_NAME: &str = "ty"; + +/// A common result type used in most cases where a +/// result type is needed. +pub(crate) type Result<T> = anyhow::Result<T>; + +pub(crate) fn version() -> &'static str { + env!("CARGO_PKG_VERSION") +} + +pub fn run_server() -> anyhow::Result<()> { + let four = NonZeroUsize::new(4).unwrap(); + + // by default, we set the number of worker threads to `num_cpus`, with a maximum of 4. + let worker_threads = std::thread::available_parallelism() + .unwrap_or(four) + .min(four); + + Server::new(worker_threads) + .context("Failed to start server")? + .run()?; + + Ok(()) +} diff --git a/crates/ty_server/src/logging.rs b/crates/ty_server/src/logging.rs new file mode 100644 index 0000000000000..3726ba25d1d31 --- /dev/null +++ b/crates/ty_server/src/logging.rs @@ -0,0 +1,114 @@ +//! The logging system for `ty server`. +//! +//! Log messages are controlled by the `logLevel` setting which defaults to `"info"`. Log messages +//! are written to `stderr` by default, which should appear in the logs for most LSP clients. A +//! `logFile` path can also be specified in the settings, and output will be directed there +//! instead. +use core::str; +use serde::Deserialize; +use std::{path::PathBuf, str::FromStr, sync::Arc}; +use tracing::level_filters::LevelFilter; +use tracing_subscriber::{ + Layer, + fmt::{time::Uptime, writer::BoxMakeWriter}, + layer::SubscriberExt, +}; + +pub(crate) fn init_logging(log_level: LogLevel, log_file: Option<&std::path::Path>) { + let log_file = log_file + .map(|path| { + // this expands `logFile` so that tildes and environment variables + // are replaced with their values, if possible. + if let Some(expanded) = shellexpand::full(&path.to_string_lossy()) + .ok() + .and_then(|path| PathBuf::from_str(&path).ok()) + { + expanded + } else { + path.to_path_buf() + } + }) + .and_then(|path| { + std::fs::OpenOptions::new() + .create(true) + .append(true) + .open(&path) + .map_err(|err| { + #[expect(clippy::print_stderr)] + { + eprintln!( + "Failed to open file at {} for logging: {err}", + path.display() + ); + } + }) + .ok() + }); + + let logger = match log_file { + Some(file) => BoxMakeWriter::new(Arc::new(file)), + None => BoxMakeWriter::new(std::io::stderr), + }; + let subscriber = tracing_subscriber::Registry::default().with( + tracing_subscriber::fmt::layer() + .with_timer(Uptime::default()) + .with_thread_names(true) + .with_ansi(false) + .with_writer(logger) + .with_filter(LogLevelFilter { filter: log_level }), + ); + + tracing::subscriber::set_global_default(subscriber) + .expect("should be able to set global default subscriber"); +} + +/// The log level for the server as provided by the client during initialization. +/// +/// The default log level is `info`. +#[derive(Clone, Copy, Debug, Deserialize, Default, PartialEq, Eq, PartialOrd, Ord)] +#[serde(rename_all = "lowercase")] +pub(crate) enum LogLevel { + Error, + Warn, + #[default] + Info, + Debug, + Trace, +} + +impl LogLevel { + fn trace_level(self) -> tracing::Level { + match self { + Self::Error => tracing::Level::ERROR, + Self::Warn => tracing::Level::WARN, + Self::Info => tracing::Level::INFO, + Self::Debug => tracing::Level::DEBUG, + Self::Trace => tracing::Level::TRACE, + } + } +} + +/// Filters out traces which have a log level lower than the `logLevel` set by the client. +struct LogLevelFilter { + filter: LogLevel, +} + +impl<S> tracing_subscriber::layer::Filter<S> for LogLevelFilter { + fn enabled( + &self, + meta: &tracing::Metadata<'_>, + _: &tracing_subscriber::layer::Context<'_, S>, + ) -> bool { + let filter = if meta.target().starts_with("ty") { + self.filter.trace_level() + } else { + tracing::Level::WARN + }; + + meta.level() <= &filter + } + + fn max_level_hint(&self) -> Option<tracing::level_filters::LevelFilter> { + Some(LevelFilter::from_level(self.filter.trace_level())) + } +} diff --git a/crates/ty_server/src/message.rs b/crates/ty_server/src/message.rs new file mode 100644 index 0000000000000..8b21fcf52a58a --- /dev/null +++ b/crates/ty_server/src/message.rs @@ -0,0 +1,54 @@ +use anyhow::Context; +use lsp_types::notification::Notification; +use std::sync::OnceLock; + +use crate::server::ClientSender; + +static MESSENGER: OnceLock<ClientSender> = OnceLock::new(); + +pub(crate) fn init_messenger(client_sender: ClientSender) { + MESSENGER + .set(client_sender) + .expect("messenger should only be initialized once"); +} + +pub(crate) fn show_message(message: String, message_type: lsp_types::MessageType) { + try_show_message(message, message_type).unwrap(); +} + +pub(super) fn try_show_message( + message: String, + message_type: lsp_types::MessageType, +) -> crate::Result<()> { + MESSENGER + .get() + .ok_or_else(|| anyhow::anyhow!("messenger not initialized"))? + .send(lsp_server::Message::Notification( + lsp_server::Notification { + method: lsp_types::notification::ShowMessage::METHOD.into(), + params: serde_json::to_value(lsp_types::ShowMessageParams { + typ: message_type, + message, + })?, + }, + )) + .context("Failed to send message")?; + + Ok(()) +} + +/// Sends an error to the client with a formatted message. The error is sent in a +/// `window/showMessage` notification. +macro_rules! show_err_msg { + ($msg:expr$(, $($arg:tt)*)?) => { + crate::message::show_message(::core::format_args!($msg$(, $($arg)*)?).to_string(), lsp_types::MessageType::ERROR) + }; +} + +/// Sends a request to display a warning to the client with a formatted message. The warning is +/// sent in a `window/showMessage` notification. +macro_rules! show_warn_msg { + ($msg:expr$(, $($arg:tt)*)?) => { + crate::message::show_message(::core::format_args!($msg$(, $($arg)*)?).to_string(), lsp_types::MessageType::WARNING) + }; +} diff --git a/crates/ty_server/src/server.rs b/crates/ty_server/src/server.rs new file mode 100644 index 0000000000000..36694eb2dafb1 --- /dev/null +++ b/crates/ty_server/src/server.rs @@ -0,0 +1,321 @@ +//! Scheduling, I/O, and API endpoints. + +use std::num::NonZeroUsize; +// The new PanicInfoHook name requires MSRV >= 1.82 +#[expect(deprecated)] +use std::panic::PanicInfo; + +use lsp_server::Message; +use lsp_types::{ + ClientCapabilities, DiagnosticOptions, DiagnosticServerCapabilities, + DidChangeWatchedFilesRegistrationOptions, FileSystemWatcher, HoverProviderCapability, + InlayHintOptions, InlayHintServerCapabilities, MessageType, ServerCapabilities, + TextDocumentSyncCapability, TextDocumentSyncKind, TextDocumentSyncOptions, + TypeDefinitionProviderCapability, Url, +}; + +use self::connection::{Connection, ConnectionInitializer}; +use self::schedule::event_loop_thread; +use crate::PositionEncoding; +use crate::session::{AllSettings, ClientSettings, Experimental, Session}; + +mod api; +mod client; +mod connection; +mod schedule; + +use crate::message::try_show_message; +use crate::server::schedule::Task; +pub(crate) use connection::ClientSender; + +pub(crate) type Result<T> = std::result::Result<T, api::Error>; + +pub(crate) struct Server { + connection: Connection, + client_capabilities: ClientCapabilities, + worker_threads: NonZeroUsize, + session: Session, +} + +impl Server { + pub(crate) fn new(worker_threads: NonZeroUsize) -> crate::Result<Self> { + let connection = ConnectionInitializer::stdio(); + + let (id, init_params) = connection.initialize_start()?; + + let AllSettings { + global_settings, + mut workspace_settings, + } = AllSettings::from_value( + init_params + .initialization_options + .unwrap_or_else(|| serde_json::Value::Object(serde_json::Map::default())), + ); + + let client_capabilities = init_params.capabilities; + let position_encoding = Self::find_best_position_encoding(&client_capabilities); + let server_capabilities = + Self::server_capabilities(position_encoding, global_settings.experimental.as_ref()); + + let connection = connection.initialize_finish( + id, + &server_capabilities, + crate::SERVER_NAME, + crate::version(), + )?; + + crate::message::init_messenger(connection.make_sender()); + crate::logging::init_logging( + global_settings.tracing.log_level.unwrap_or_default(), + global_settings.tracing.log_file.as_deref(), + ); + + let mut workspace_for_url = |url: Url| { + let Some(workspace_settings) = workspace_settings.as_mut() else { + return (url, ClientSettings::default()); + }; + let settings = workspace_settings.remove(&url).unwrap_or_else(|| { + tracing::warn!("No workspace settings found for {}", url); + ClientSettings::default() + }); + (url, settings) + }; + + let workspaces = init_params + .workspace_folders + .filter(|folders| !folders.is_empty()) + .map(|folders| folders.into_iter().map(|folder| { + workspace_for_url(folder.uri) + }).collect()) + .or_else(|| { + tracing::warn!("No workspace(s) were provided during initialization. Using the current working directory as a default workspace..."); + let uri = Url::from_file_path(std::env::current_dir().ok()?).ok()?; + Some(vec![workspace_for_url(uri)]) + }) + .ok_or_else(|| { + anyhow::anyhow!("Failed to get the current working directory while creating a default workspace.") + })?; + + let workspaces = if workspaces.len() > 1 { + let first_workspace = workspaces.into_iter().next().unwrap(); + tracing::warn!( + "Multiple workspaces are not yet supported, using the first workspace: {}", + &first_workspace.0 + ); + show_warn_msg!( + "Multiple workspaces are not yet supported, using the first workspace: {}", + &first_workspace.0 + ); + vec![first_workspace] + } else { + workspaces + }; + + Ok(Self { + connection, + worker_threads, + session: Session::new( + &client_capabilities, + position_encoding, + global_settings, + &workspaces, + )?, + client_capabilities, + }) + } + + pub(crate) fn run(self) -> crate::Result<()> { + // The new PanicInfoHook name requires MSRV >= 1.82 + #[expect(deprecated)] + type PanicHook = Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send>; + struct RestorePanicHook { + hook: Option<PanicHook>, + } + + impl Drop for RestorePanicHook { + fn drop(&mut self) { + if let Some(hook) = self.hook.take() { + std::panic::set_hook(hook); + } + } + } + + // unregister any previously registered panic hook + // The hook will be restored when this function exits. + let _ = RestorePanicHook { + hook: Some(std::panic::take_hook()), + }; + + // When we panic, try to notify the client. + std::panic::set_hook(Box::new(move |panic_info| { + use std::io::Write; + + let backtrace = std::backtrace::Backtrace::force_capture(); + tracing::error!("{panic_info}\n{backtrace}"); + + // we also need to print to stderr directly for when using `$logTrace` because + // the message won't be sent to the client. + // But don't use `eprintln` because `eprintln` itself may panic if the pipe is broken. + let mut stderr = std::io::stderr().lock(); + writeln!(stderr, "{panic_info}\n{backtrace}").ok(); + + try_show_message( + "The ty language server exited with a panic. See the logs for more details." + .to_string(), + MessageType::ERROR, + ) + .ok(); + })); + + event_loop_thread(move || { + Self::event_loop( + &self.connection, + &self.client_capabilities, + self.session, + self.worker_threads, + )?; + self.connection.close()?; + Ok(()) + })? + .join() + } + + fn event_loop( + connection: &Connection, + client_capabilities: &ClientCapabilities, + mut session: Session, + worker_threads: NonZeroUsize, + ) -> crate::Result<()> { + let mut scheduler = + schedule::Scheduler::new(&mut session, worker_threads, connection.make_sender()); + + let fs_watcher = client_capabilities + .workspace + .as_ref() + .and_then(|workspace| workspace.did_change_watched_files?.dynamic_registration) + .unwrap_or_default(); + + if fs_watcher { + let registration = lsp_types::Registration { + id: "workspace/didChangeWatchedFiles".to_owned(), + method: "workspace/didChangeWatchedFiles".to_owned(), + register_options: Some( + serde_json::to_value(DidChangeWatchedFilesRegistrationOptions { + watchers: vec![ + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String("**/ty.toml".into()), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String( + "**/.gitignore".into(), + ), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String("**/.ignore".into()), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String( + "**/pyproject.toml".into(), + ), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String("**/*.py".into()), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String("**/*.pyi".into()), + kind: None, + }, + FileSystemWatcher { + glob_pattern: lsp_types::GlobPattern::String("**/*.ipynb".into()), + kind: None, + }, + ], + }) + .unwrap(), + ), + }; + let response_handler = |()| { + tracing::info!("File watcher successfully registered"); + Task::nothing() + }; + + if let Err(err) = scheduler.request::<lsp_types::request::RegisterCapability>( + lsp_types::RegistrationParams { + registrations: vec![registration], + }, + response_handler, + ) { + tracing::error!( + "An error occurred when trying to register the configuration file watcher: {err}" + ); + } + } else { + tracing::warn!("The client does not support file system watching."); + } + + for msg in connection.incoming() { + if connection.handle_shutdown(&msg)? { + break; + } + let task = match msg { + Message::Request(req) => api::request(req), + Message::Notification(notification) => api::notification(notification), + Message::Response(response) => scheduler.response(response), + }; + scheduler.dispatch(task); + } + + Ok(()) + } + + fn find_best_position_encoding(client_capabilities: &ClientCapabilities) -> PositionEncoding { + client_capabilities + .general + .as_ref() + .and_then(|general_capabilities| general_capabilities.position_encodings.as_ref()) + .and_then(|encodings| { + encodings + .iter() + .filter_map(|encoding| PositionEncoding::try_from(encoding).ok()) + .max() // this selects the highest priority position encoding + }) + .unwrap_or_default() + } + + fn server_capabilities( + position_encoding: PositionEncoding, + experimental: Option<&Experimental>, + ) -> ServerCapabilities { + ServerCapabilities { + position_encoding: Some(position_encoding.into()), + diagnostic_provider: Some(DiagnosticServerCapabilities::Options(DiagnosticOptions { + identifier: Some(crate::DIAGNOSTIC_NAME.into()), + inter_file_dependencies: true, + ..Default::default() + })), + text_document_sync: Some(TextDocumentSyncCapability::Options( + TextDocumentSyncOptions { + open_close: Some(true), + change: Some(TextDocumentSyncKind::INCREMENTAL), + ..Default::default() + }, + )), + type_definition_provider: Some(TypeDefinitionProviderCapability::Simple(true)), + hover_provider: Some(HoverProviderCapability::Simple(true)), + inlay_hint_provider: Some(lsp_types::OneOf::Right( + InlayHintServerCapabilities::Options(InlayHintOptions::default()), + )), + completion_provider: experimental + .is_some_and(Experimental::is_completions_enabled) + .then_some(lsp_types::CompletionOptions { + ..Default::default() + }), + ..Default::default() + } + } +} diff --git a/crates/ty_server/src/server/api.rs b/crates/ty_server/src/server/api.rs new file mode 100644 index 0000000000000..a9dd9da1d0272 --- /dev/null +++ b/crates/ty_server/src/server/api.rs @@ -0,0 +1,295 @@ +use crate::server::schedule::Task; +use crate::session::Session; +use crate::system::{AnySystemPath, url_to_any_system_path}; +use anyhow::anyhow; +use lsp_server as server; +use lsp_types::notification::Notification; + +mod diagnostics; +mod notifications; +mod requests; +mod traits; + +use notifications as notification; +use requests as request; + +use self::traits::{NotificationHandler, RequestHandler}; + +use super::{Result, client::Responder, schedule::BackgroundSchedule}; + +pub(super) fn request<'a>(req: server::Request) -> Task<'a> { + let id = req.id.clone(); + + match req.method.as_str() { + request::DocumentDiagnosticRequestHandler::METHOD => background_request_task::< + request::DocumentDiagnosticRequestHandler, + >( + req, BackgroundSchedule::Worker + ), + request::GotoTypeDefinitionRequestHandler::METHOD => background_request_task::< + request::GotoTypeDefinitionRequestHandler, + >( + req, BackgroundSchedule::Worker + ), + request::HoverRequestHandler::METHOD => { + background_request_task::<request::HoverRequestHandler>(req, BackgroundSchedule::Worker) + } + request::InlayHintRequestHandler::METHOD => background_request_task::< + request::InlayHintRequestHandler, + >(req, BackgroundSchedule::Worker), + request::CompletionRequestHandler::METHOD => background_request_task::< + request::CompletionRequestHandler, + >( + req, BackgroundSchedule::LatencySensitive + ), + + method => { + tracing::warn!("Received request {method} which does not have a handler"); + let result: Result<()> = Err(Error::new( + anyhow!("Unknown request"), + server::ErrorCode::MethodNotFound, + )); + return Task::immediate(id, result); + } + } + .unwrap_or_else(|err| { + tracing::error!("Encountered error when routing request with ID {id}: {err}"); + show_err_msg!( + "ty failed to handle a request from the editor. Check the logs for more details." + ); + let result: Result<()> = Err(err); + Task::immediate(id, result) + }) +} + +pub(super) fn notification<'a>(notif: server::Notification) -> Task<'a> { + match notif.method.as_str() { + notification::DidCloseTextDocumentHandler::METHOD => { + local_notification_task::<notification::DidCloseTextDocumentHandler>(notif) + } + notification::DidOpenTextDocumentHandler::METHOD => { + local_notification_task::<notification::DidOpenTextDocumentHandler>(notif) + } + notification::DidChangeTextDocumentHandler::METHOD => { + local_notification_task::<notification::DidChangeTextDocumentHandler>(notif) + } + notification::DidOpenNotebookHandler::METHOD => { + local_notification_task::<notification::DidOpenNotebookHandler>(notif) + } + notification::DidCloseNotebookHandler::METHOD => { + local_notification_task::<notification::DidCloseNotebookHandler>(notif) + } + notification::DidChangeWatchedFiles::METHOD => { + local_notification_task::<notification::DidChangeWatchedFiles>(notif) + } + lsp_types::notification::SetTrace::METHOD => { + tracing::trace!("Ignoring `setTrace` notification"); + return Task::nothing(); + } + + method => { + tracing::warn!("Received notification {method} which does not have a handler."); + return Task::nothing(); + } + } + .unwrap_or_else(|err| { + tracing::error!("Encountered error when routing notification: {err}"); + show_err_msg!( + "ty failed to handle a notification from the editor. Check the logs for more details." + ); + Task::nothing() + }) +} + +fn _local_request_task<'a, R: traits::SyncRequestHandler>( + req: server::Request, +) -> super::Result<Task<'a>> { + let (id, params) = cast_request::<R>(req)?; + Ok(Task::local(|session, notifier, requester, responder| { + let _span = tracing::trace_span!("request", %id, method = R::METHOD).entered(); + let result = R::run(session, notifier, requester, params); + respond::<R>(id, result, &responder); + })) +} + +// TODO(micha): Calls to `db` could panic if the db gets mutated while this task is running. +// We should either wrap `R::run_with_snapshot` with a salsa catch cancellation handler or +// use `SemanticModel` instead of passing `db` which uses a Result for all it's methods +// that propagate cancellations. +fn background_request_task<'a, R: traits::BackgroundDocumentRequestHandler>( + req: server::Request, + schedule: BackgroundSchedule, +) -> super::Result<Task<'a>> { + let (id, params) = cast_request::<R>(req)?; + Ok(Task::background(schedule, move |session: &Session| { + let url = R::document_url(¶ms).into_owned(); + + let Ok(path) = url_to_any_system_path(&url) else { + tracing::warn!("Ignoring request for invalid `{url}`"); + return Box::new(|_, _| {}); + }; + let db = match &path { + AnySystemPath::System(path) => match session.project_db_for_path(path.as_std_path()) { + Some(db) => db.clone(), + None => session.default_project_db().clone(), + }, + AnySystemPath::SystemVirtual(_) => session.default_project_db().clone(), + }; + + let Some(snapshot) = session.take_snapshot(url) else { + tracing::warn!("Ignoring request because snapshot for path `{path:?}` doesn't exist."); + return Box::new(|_, _| {}); + }; + + Box::new(move |notifier, responder| { + let _span = tracing::trace_span!("request", %id, method = R::METHOD).entered(); + let result = R::run_with_snapshot(&db, snapshot, notifier, params); + respond::<R>(id, result, &responder); + }) + })) +} + +fn local_notification_task<'a, N: traits::SyncNotificationHandler>( + notif: server::Notification, +) -> super::Result<Task<'a>> { + let (id, params) = cast_notification::<N>(notif)?; + Ok(Task::local(move |session, notifier, requester, _| { + let _span = tracing::trace_span!("notification", method = N::METHOD).entered(); + if let Err(err) = N::run(session, notifier, requester, params) { + tracing::error!("An error occurred while running {id}: {err}"); + show_err_msg!("ty encountered a problem. Check the logs for more details."); + } + })) +} + +#[expect(dead_code)] +fn background_notification_thread<'a, N: traits::BackgroundDocumentNotificationHandler>( + req: server::Notification, + schedule: BackgroundSchedule, +) -> super::Result<Task<'a>> { + let (id, params) = cast_notification::<N>(req)?; + Ok(Task::background(schedule, move |session: &Session| { + let url = N::document_url(¶ms); + let Some(snapshot) = session.take_snapshot((*url).clone()) else { + tracing::debug!( + "Ignoring notification because snapshot for url `{url}` doesn't exist." + ); + return Box::new(|_, _| {}); + }; + Box::new(move |notifier, _| { + let _span = tracing::trace_span!("notification", method = N::METHOD).entered(); + if let Err(err) = N::run_with_snapshot(snapshot, notifier, params) { + tracing::error!("An error occurred while running {id}: {err}"); + show_err_msg!("ty encountered a problem. Check the logs for more details."); + } + }) + })) +} + +/// Tries to cast a serialized request from the server into +/// a parameter type for a specific request handler. +/// It is *highly* recommended to not override this function in your +/// implementation. +fn cast_request<Req>( + request: server::Request, +) -> super::Result<( + server::RequestId, + <<Req as RequestHandler>::RequestType as lsp_types::request::Request>::Params, +)> +where + Req: traits::RequestHandler, +{ + request + .extract(Req::METHOD) + .map_err(|err| match err { + json_err @ server::ExtractError::JsonError { .. } => { + anyhow::anyhow!("JSON parsing failure:\n{json_err}") + } + server::ExtractError::MethodMismatch(_) => { + unreachable!("A method mismatch should not be possible here unless you've used a different handler (`Req`) \ + than the one whose method name was matched against earlier.") + } + }) + .with_failure_code(server::ErrorCode::InternalError) +} + +/// Sends back a response to the server using a [`Responder`]. +fn respond<Req>( + id: server::RequestId, + result: crate::server::Result< + <<Req as traits::RequestHandler>::RequestType as lsp_types::request::Request>::Result, + >, + responder: &Responder, +) where + Req: traits::RequestHandler, +{ + if let Err(err) = &result { + tracing::error!("An error occurred with request ID {id}: {err}"); + show_err_msg!("ty encountered a problem. Check the logs for more details."); + } + if let Err(err) = responder.respond(id, result) { + tracing::error!("Failed to send response: {err}"); + } +} + +/// Tries to cast a serialized request from the server into +/// a parameter type for a specific request handler. +fn cast_notification<N>( + notification: server::Notification, +) -> super::Result< + ( + &'static str, + <<N as traits::NotificationHandler>::NotificationType as lsp_types::notification::Notification>::Params, +)> where N: traits::NotificationHandler{ + Ok(( + N::METHOD, + notification + .extract(N::METHOD) + .map_err(|err| match err { + json_err @ server::ExtractError::JsonError { .. } => { + anyhow::anyhow!("JSON parsing failure:\n{json_err}") + } + server::ExtractError::MethodMismatch(_) => { + unreachable!("A method mismatch should not be possible here unless you've used a different handler (`N`) \ + than the one whose method name was matched against earlier.") + } + }) + .with_failure_code(server::ErrorCode::InternalError)?, + )) +} + +pub(crate) struct Error { + pub(crate) code: server::ErrorCode, + pub(crate) error: anyhow::Error, +} + +/// A trait to convert result types into the server result type, [`super::Result`]. +trait LSPResult<T> { + fn with_failure_code(self, code: server::ErrorCode) -> super::Result<T>; +} + +impl<T, E: Into<anyhow::Error>> LSPResult<T> for core::result::Result<T, E> { + fn with_failure_code(self, code: server::ErrorCode) -> super::Result<T> { + self.map_err(|err| Error::new(err.into(), code)) + } +} + +impl Error { + pub(crate) fn new(err: anyhow::Error, code: server::ErrorCode) -> Self { + Self { code, error: err } + } +} + +// Right now, we treat the error code as invisible data that won't +// be printed. +impl std::fmt::Debug for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.error.fmt(f) + } +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.error.fmt(f) + } +} diff --git a/crates/red_knot_server/src/server/api/diagnostics.rs b/crates/ty_server/src/server/api/diagnostics.rs similarity index 84% rename from crates/red_knot_server/src/server/api/diagnostics.rs rename to crates/ty_server/src/server/api/diagnostics.rs index 0a209252a888c..c1b3449acc8c9 100644 --- a/crates/red_knot_server/src/server/api/diagnostics.rs +++ b/crates/ty_server/src/server/api/diagnostics.rs @@ -1,8 +1,8 @@ use lsp_server::ErrorCode; -use lsp_types::{notification::PublishDiagnostics, PublishDiagnosticsParams, Url}; +use lsp_types::{PublishDiagnosticsParams, Url, notification::PublishDiagnostics}; -use crate::server::client::Notifier; use crate::server::Result; +use crate::server::client::Notifier; use super::LSPResult; diff --git a/crates/red_knot_server/src/server/api/notifications.rs b/crates/ty_server/src/server/api/notifications.rs similarity index 80% rename from crates/red_knot_server/src/server/api/notifications.rs rename to crates/ty_server/src/server/api/notifications.rs index 33429547d4da6..5e4f54eb942d0 100644 --- a/crates/red_knot_server/src/server/api/notifications.rs +++ b/crates/ty_server/src/server/api/notifications.rs @@ -1,13 +1,13 @@ mod did_change; +mod did_change_watched_files; mod did_close; mod did_close_notebook; mod did_open; mod did_open_notebook; -mod set_trace; pub(super) use did_change::DidChangeTextDocumentHandler; +pub(super) use did_change_watched_files::DidChangeWatchedFiles; pub(super) use did_close::DidCloseTextDocumentHandler; pub(super) use did_close_notebook::DidCloseNotebookHandler; pub(super) use did_open::DidOpenTextDocumentHandler; pub(super) use did_open_notebook::DidOpenNotebookHandler; -pub(super) use set_trace::SetTraceHandler; diff --git a/crates/red_knot_server/src/server/api/notifications/did_change.rs b/crates/ty_server/src/server/api/notifications/did_change.rs similarity index 82% rename from crates/red_knot_server/src/server/api/notifications/did_change.rs rename to crates/ty_server/src/server/api/notifications/did_change.rs index 79cd7b3092cd0..c066725c9d7e1 100644 --- a/crates/red_knot_server/src/server/api/notifications/did_change.rs +++ b/crates/ty_server/src/server/api/notifications/did_change.rs @@ -1,15 +1,15 @@ use lsp_server::ErrorCode; -use lsp_types::notification::DidChangeTextDocument; use lsp_types::DidChangeTextDocumentParams; +use lsp_types::notification::DidChangeTextDocument; -use red_knot_workspace::watch::ChangeEvent; +use ty_project::watch::ChangeEvent; -use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; +use crate::system::{AnySystemPath, url_to_any_system_path}; pub(crate) struct DidChangeTextDocumentHandler; @@ -36,19 +36,19 @@ impl SyncNotificationHandler for DidChangeTextDocumentHandler { match path { AnySystemPath::System(path) => { - let db = match session.workspace_db_for_path_mut(path.as_std_path()) { + let db = match session.project_db_for_path_mut(path.as_std_path()) { Some(db) => db, - None => session.default_workspace_db_mut(), + None => session.default_project_db_mut(), }; db.apply_changes(vec![ChangeEvent::file_content_changed(path)], None); } AnySystemPath::SystemVirtual(virtual_path) => { - let db = session.default_workspace_db_mut(); + let db = session.default_project_db_mut(); db.apply_changes(vec![ChangeEvent::ChangedVirtual(virtual_path)], None); } } - // TODO(dhruvmanila): Publish diagnostics if the client doesnt support pull diagnostics + // TODO(dhruvmanila): Publish diagnostics if the client doesn't support pull diagnostics Ok(()) } diff --git a/crates/ty_server/src/server/api/notifications/did_change_watched_files.rs b/crates/ty_server/src/server/api/notifications/did_change_watched_files.rs new file mode 100644 index 0000000000000..d380b5c06a065 --- /dev/null +++ b/crates/ty_server/src/server/api/notifications/did_change_watched_files.rs @@ -0,0 +1,111 @@ +use crate::server::Result; +use crate::server::api::LSPResult; +use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; +use crate::server::client::{Notifier, Requester}; +use crate::server::schedule::Task; +use crate::session::Session; +use crate::system::{AnySystemPath, url_to_any_system_path}; +use lsp_types as types; +use lsp_types::{FileChangeType, notification as notif}; +use rustc_hash::FxHashMap; +use ty_project::Db; +use ty_project::watch::{ChangeEvent, ChangedKind, CreatedKind, DeletedKind}; + +pub(crate) struct DidChangeWatchedFiles; + +impl NotificationHandler for DidChangeWatchedFiles { + type NotificationType = notif::DidChangeWatchedFiles; +} + +impl SyncNotificationHandler for DidChangeWatchedFiles { + fn run( + session: &mut Session, + _notifier: Notifier, + requester: &mut Requester, + params: types::DidChangeWatchedFilesParams, + ) -> Result<()> { + let mut events_by_db: FxHashMap<_, Vec<ChangeEvent>> = FxHashMap::default(); + + for change in params.changes { + let path = match url_to_any_system_path(&change.uri) { + Ok(path) => path, + Err(err) => { + tracing::warn!( + "Failed to convert URI '{}` to system path: {err:?}", + change.uri + ); + continue; + } + }; + + let system_path = match path { + AnySystemPath::System(system) => system, + AnySystemPath::SystemVirtual(path) => { + tracing::debug!("Ignoring virtual path from change event: `{path}`"); + continue; + } + }; + + let Some(db) = session.project_db_for_path(system_path.as_std_path()) else { + tracing::trace!( + "Ignoring change event for `{system_path}` because it's not in any workspace" + ); + continue; + }; + + let change_event = match change.typ { + FileChangeType::CREATED => ChangeEvent::Created { + path: system_path, + kind: CreatedKind::Any, + }, + FileChangeType::CHANGED => ChangeEvent::Changed { + path: system_path, + kind: ChangedKind::Any, + }, + FileChangeType::DELETED => ChangeEvent::Deleted { + path: system_path, + kind: DeletedKind::Any, + }, + _ => { + tracing::debug!( + "Ignoring unsupported change event type: `{:?}` for {system_path}", + change.typ + ); + continue; + } + }; + + events_by_db + .entry(db.project().root(db).to_path_buf()) + .or_default() + .push(change_event); + } + + if events_by_db.is_empty() { + return Ok(()); + } + + for (root, changes) in events_by_db { + tracing::debug!("Applying changes to `{root}`"); + let db = session.project_db_for_path_mut(&*root).unwrap(); + + db.apply_changes(changes, None); + } + + let client_capabilities = session.client_capabilities(); + + if client_capabilities.diagnostics_refresh { + requester + .request::<types::request::WorkspaceDiagnosticRefresh>((), |()| Task::nothing()) + .with_failure_code(lsp_server::ErrorCode::InternalError)?; + } + + if client_capabilities.inlay_refresh { + requester + .request::<types::request::InlayHintRefreshRequest>((), |()| Task::nothing()) + .with_failure_code(lsp_server::ErrorCode::InternalError)?; + } + + Ok(()) + } +} diff --git a/crates/red_knot_server/src/server/api/notifications/did_close.rs b/crates/ty_server/src/server/api/notifications/did_close.rs similarity index 89% rename from crates/red_knot_server/src/server/api/notifications/did_close.rs rename to crates/ty_server/src/server/api/notifications/did_close.rs index 87afef9747b73..0daaa645a28ce 100644 --- a/crates/red_knot_server/src/server/api/notifications/did_close.rs +++ b/crates/ty_server/src/server/api/notifications/did_close.rs @@ -1,15 +1,15 @@ use lsp_server::ErrorCode; -use lsp_types::notification::DidCloseTextDocument; use lsp_types::DidCloseTextDocumentParams; -use red_knot_workspace::watch::ChangeEvent; +use lsp_types::notification::DidCloseTextDocument; +use ty_project::watch::ChangeEvent; +use crate::server::Result; +use crate::server::api::LSPResult; use crate::server::api::diagnostics::clear_diagnostics; use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; -use crate::server::api::LSPResult; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; +use crate::system::{AnySystemPath, url_to_any_system_path}; pub(crate) struct DidCloseTextDocumentHandler; @@ -34,7 +34,7 @@ impl SyncNotificationHandler for DidCloseTextDocumentHandler { .with_failure_code(ErrorCode::InternalError)?; if let AnySystemPath::SystemVirtual(virtual_path) = path { - let db = session.default_workspace_db_mut(); + let db = session.default_project_db_mut(); db.apply_changes(vec![ChangeEvent::DeletedVirtual(virtual_path)], None); } diff --git a/crates/red_knot_server/src/server/api/notifications/did_close_notebook.rs b/crates/ty_server/src/server/api/notifications/did_close_notebook.rs similarity index 88% rename from crates/red_knot_server/src/server/api/notifications/did_close_notebook.rs rename to crates/ty_server/src/server/api/notifications/did_close_notebook.rs index 3d96f83eef1b0..07f0c31b488e9 100644 --- a/crates/red_knot_server/src/server/api/notifications/did_close_notebook.rs +++ b/crates/ty_server/src/server/api/notifications/did_close_notebook.rs @@ -1,14 +1,14 @@ -use lsp_types::notification::DidCloseNotebookDocument; use lsp_types::DidCloseNotebookDocumentParams; +use lsp_types::notification::DidCloseNotebookDocument; -use red_knot_workspace::watch::ChangeEvent; +use ty_project::watch::ChangeEvent; -use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; +use crate::system::{AnySystemPath, url_to_any_system_path}; pub(crate) struct DidCloseNotebookHandler; @@ -33,7 +33,7 @@ impl SyncNotificationHandler for DidCloseNotebookHandler { .with_failure_code(lsp_server::ErrorCode::InternalError)?; if let AnySystemPath::SystemVirtual(virtual_path) = path { - let db = session.default_workspace_db_mut(); + let db = session.default_project_db_mut(); db.apply_changes(vec![ChangeEvent::DeletedVirtual(virtual_path)], None); } diff --git a/crates/ty_server/src/server/api/notifications/did_open.rs b/crates/ty_server/src/server/api/notifications/did_open.rs new file mode 100644 index 0000000000000..1b49222be8c9a --- /dev/null +++ b/crates/ty_server/src/server/api/notifications/did_open.rs @@ -0,0 +1,60 @@ +use lsp_types::notification::DidOpenTextDocument; +use lsp_types::{DidOpenTextDocumentParams, TextDocumentItem}; + +use ruff_db::Db; +use ty_project::watch::ChangeEvent; + +use crate::TextDocument; +use crate::server::Result; +use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; +use crate::server::client::{Notifier, Requester}; +use crate::session::Session; +use crate::system::{AnySystemPath, url_to_any_system_path}; + +pub(crate) struct DidOpenTextDocumentHandler; + +impl NotificationHandler for DidOpenTextDocumentHandler { + type NotificationType = DidOpenTextDocument; +} + +impl SyncNotificationHandler for DidOpenTextDocumentHandler { + fn run( + session: &mut Session, + _notifier: Notifier, + _requester: &mut Requester, + DidOpenTextDocumentParams { + text_document: + TextDocumentItem { + uri, + text, + version, + language_id, + }, + }: DidOpenTextDocumentParams, + ) -> Result<()> { + let Ok(path) = url_to_any_system_path(&uri) else { + return Ok(()); + }; + + let document = TextDocument::new(text, version).with_language_id(&language_id); + session.open_text_document(uri, document); + + match path { + AnySystemPath::System(path) => { + let db = match session.project_db_for_path_mut(path.as_std_path()) { + Some(db) => db, + None => session.default_project_db_mut(), + }; + db.apply_changes(vec![ChangeEvent::Opened(path)], None); + } + AnySystemPath::SystemVirtual(virtual_path) => { + let db = session.default_project_db_mut(); + db.files().virtual_file(db, &virtual_path); + } + } + + // TODO(dhruvmanila): Publish diagnostics if the client doesn't support pull diagnostics + + Ok(()) + } +} diff --git a/crates/red_knot_server/src/server/api/notifications/did_open_notebook.rs b/crates/ty_server/src/server/api/notifications/did_open_notebook.rs similarity index 83% rename from crates/red_knot_server/src/server/api/notifications/did_open_notebook.rs rename to crates/ty_server/src/server/api/notifications/did_open_notebook.rs index edbff7e022b4d..d2ee3e9558036 100644 --- a/crates/red_knot_server/src/server/api/notifications/did_open_notebook.rs +++ b/crates/ty_server/src/server/api/notifications/did_open_notebook.rs @@ -1,17 +1,17 @@ use lsp_server::ErrorCode; -use lsp_types::notification::DidOpenNotebookDocument; use lsp_types::DidOpenNotebookDocumentParams; +use lsp_types::notification::DidOpenNotebookDocument; -use red_knot_workspace::watch::ChangeEvent; use ruff_db::Db; +use ty_project::watch::ChangeEvent; -use crate::edit::NotebookDocument; -use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; +use crate::document::NotebookDocument; +use crate::server::Result; use crate::server::api::LSPResult; +use crate::server::api::traits::{NotificationHandler, SyncNotificationHandler}; use crate::server::client::{Notifier, Requester}; -use crate::server::Result; use crate::session::Session; -use crate::system::{url_to_any_system_path, AnySystemPath}; +use crate::system::{AnySystemPath, url_to_any_system_path}; pub(crate) struct DidOpenNotebookHandler; @@ -41,14 +41,14 @@ impl SyncNotificationHandler for DidOpenNotebookHandler { match path { AnySystemPath::System(path) => { - let db = match session.workspace_db_for_path_mut(path.as_std_path()) { + let db = match session.project_db_for_path_mut(path.as_std_path()) { Some(db) => db, - None => session.default_workspace_db_mut(), + None => session.default_project_db_mut(), }; db.apply_changes(vec![ChangeEvent::Opened(path)], None); } AnySystemPath::SystemVirtual(virtual_path) => { - let db = session.default_workspace_db_mut(); + let db = session.default_project_db_mut(); db.files().virtual_file(db, &virtual_path); } } diff --git a/crates/ty_server/src/server/api/requests.rs b/crates/ty_server/src/server/api/requests.rs new file mode 100644 index 0000000000000..bfdec09623f7f --- /dev/null +++ b/crates/ty_server/src/server/api/requests.rs @@ -0,0 +1,11 @@ +mod completion; +mod diagnostic; +mod goto_type_definition; +mod hover; +mod inlay_hints; + +pub(super) use completion::CompletionRequestHandler; +pub(super) use diagnostic::DocumentDiagnosticRequestHandler; +pub(super) use goto_type_definition::GotoTypeDefinitionRequestHandler; +pub(super) use hover::HoverRequestHandler; +pub(super) use inlay_hints::InlayHintRequestHandler; diff --git a/crates/ty_server/src/server/api/requests/completion.rs b/crates/ty_server/src/server/api/requests/completion.rs new file mode 100644 index 0000000000000..e0089a43a1bd7 --- /dev/null +++ b/crates/ty_server/src/server/api/requests/completion.rs @@ -0,0 +1,58 @@ +use std::borrow::Cow; + +use lsp_types::request::Completion; +use lsp_types::{CompletionItem, CompletionParams, CompletionResponse, Url}; +use ruff_db::source::{line_index, source_text}; +use ty_ide::completion; +use ty_project::ProjectDatabase; + +use crate::DocumentSnapshot; +use crate::document::PositionExt; +use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; +use crate::server::client::Notifier; + +pub(crate) struct CompletionRequestHandler; + +impl RequestHandler for CompletionRequestHandler { + type RequestType = Completion; +} + +impl BackgroundDocumentRequestHandler for CompletionRequestHandler { + fn document_url(params: &CompletionParams) -> Cow<Url> { + Cow::Borrowed(¶ms.text_document_position.text_document.uri) + } + + fn run_with_snapshot( + db: &ProjectDatabase, + snapshot: DocumentSnapshot, + _notifier: Notifier, + params: CompletionParams, + ) -> crate::server::Result<Option<CompletionResponse>> { + let Some(file) = snapshot.file(db) else { + tracing::debug!("Failed to resolve file for {:?}", params); + return Ok(None); + }; + + let source = source_text(db, file); + let line_index = line_index(db, file); + let offset = params.text_document_position.position.to_text_size( + &source, + &line_index, + snapshot.encoding(), + ); + let completions = completion(db, file, offset); + if completions.is_empty() { + return Ok(None); + } + + let items: Vec<CompletionItem> = completions + .into_iter() + .map(|comp| CompletionItem { + label: comp.label, + ..Default::default() + }) + .collect(); + let response = CompletionResponse::Array(items); + Ok(Some(response)) + } +} diff --git a/crates/ty_server/src/server/api/requests/diagnostic.rs b/crates/ty_server/src/server/api/requests/diagnostic.rs new file mode 100644 index 0000000000000..1824bc8693738 --- /dev/null +++ b/crates/ty_server/src/server/api/requests/diagnostic.rs @@ -0,0 +1,191 @@ +use std::borrow::Cow; + +use lsp_types::request::DocumentDiagnosticRequest; +use lsp_types::{ + Diagnostic, DiagnosticSeverity, DiagnosticTag, DocumentDiagnosticParams, + DocumentDiagnosticReport, DocumentDiagnosticReportResult, FullDocumentDiagnosticReport, + NumberOrString, Range, RelatedFullDocumentDiagnosticReport, +}; + +use crate::PositionEncoding; +use crate::document::{FileRangeExt, ToRangeExt}; +use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; +use crate::server::{Result, client::Notifier}; +use crate::session::DocumentSnapshot; +use ruff_db::diagnostic::{Annotation, Severity, SubDiagnostic}; +use ruff_db::files::FileRange; +use ruff_db::source::{line_index, source_text}; +use ty_project::{Db, ProjectDatabase}; + +pub(crate) struct DocumentDiagnosticRequestHandler; + +impl RequestHandler for DocumentDiagnosticRequestHandler { + type RequestType = DocumentDiagnosticRequest; +} + +impl BackgroundDocumentRequestHandler for DocumentDiagnosticRequestHandler { + fn document_url(params: &DocumentDiagnosticParams) -> Cow<lsp_types::Url> { + Cow::Borrowed(¶ms.text_document.uri) + } + + fn run_with_snapshot( + db: &ProjectDatabase, + snapshot: DocumentSnapshot, + _notifier: Notifier, + _params: DocumentDiagnosticParams, + ) -> Result<DocumentDiagnosticReportResult> { + let diagnostics = compute_diagnostics(&snapshot, db); + + Ok(DocumentDiagnosticReportResult::Report( + DocumentDiagnosticReport::Full(RelatedFullDocumentDiagnosticReport { + related_documents: None, + full_document_diagnostic_report: FullDocumentDiagnosticReport { + result_id: None, + items: diagnostics, + }, + }), + )) + } +} + +fn compute_diagnostics(snapshot: &DocumentSnapshot, db: &ProjectDatabase) -> Vec<Diagnostic> { + let Some(file) = snapshot.file(db) else { + tracing::info!( + "No file found for snapshot for `{}`", + snapshot.query().file_url() + ); + return vec![]; + }; + + let diagnostics = match db.check_file(file) { + Ok(diagnostics) => diagnostics, + Err(cancelled) => { + tracing::info!("Diagnostics computation {cancelled}"); + return vec![]; + } + }; + + diagnostics + .as_slice() + .iter() + .map(|message| to_lsp_diagnostic(db, message, snapshot.encoding())) + .collect() +} + +fn to_lsp_diagnostic( + db: &dyn Db, + diagnostic: &ruff_db::diagnostic::Diagnostic, + encoding: crate::PositionEncoding, +) -> Diagnostic { + let range = if let Some(span) = diagnostic.primary_span() { + let file = span.expect_ty_file(); + let index = line_index(db.upcast(), file); + let source = source_text(db.upcast(), file); + + span.range() + .map(|range| range.to_lsp_range(&source, &index, encoding)) + .unwrap_or_default() + } else { + Range::default() + }; + + let severity = match diagnostic.severity() { + Severity::Info => DiagnosticSeverity::INFORMATION, + Severity::Warning => DiagnosticSeverity::WARNING, + Severity::Error | Severity::Fatal => DiagnosticSeverity::ERROR, + }; + + let tags = diagnostic + .primary_tags() + .map(|tags| { + tags.iter() + .map(|tag| match tag { + ruff_db::diagnostic::DiagnosticTag::Unnecessary => DiagnosticTag::UNNECESSARY, + ruff_db::diagnostic::DiagnosticTag::Deprecated => DiagnosticTag::DEPRECATED, + }) + .collect::<Vec<DiagnosticTag>>() + }) + .filter(|mapped_tags| !mapped_tags.is_empty()); + + let code_description = diagnostic + .id() + .is_lint() + .then(|| { + Some(lsp_types::CodeDescription { + href: lsp_types::Url::parse(&format!("https://ty.dev/rules#{}", diagnostic.id())) + .ok()?, + }) + }) + .flatten(); + + let mut related_information = Vec::new(); + + related_information.extend( + diagnostic + .secondary_annotations() + .filter_map(|annotation| annotation_to_related_information(db, annotation, encoding)), + ); + + for sub_diagnostic in diagnostic.sub_diagnostics() { + related_information.extend(sub_diagnostic_to_related_information( + db, + sub_diagnostic, + encoding, + )); + + related_information.extend( + sub_diagnostic + .annotations() + .iter() + .filter_map(|annotation| { + annotation_to_related_information(db, annotation, encoding) + }), + ); + } + + Diagnostic { + range, + severity: Some(severity), + tags, + code: Some(NumberOrString::String(diagnostic.id().to_string())), + code_description, + source: Some("ty".into()), + message: diagnostic.concise_message().to_string(), + related_information: Some(related_information), + data: None, + } +} + +fn annotation_to_related_information( + db: &dyn Db, + annotation: &Annotation, + encoding: PositionEncoding, +) -> Option<lsp_types::DiagnosticRelatedInformation> { + let span = annotation.get_span(); + + let annotation_message = annotation.get_message()?; + let range = FileRange::try_from(span).ok()?; + let location = range.to_location(db.upcast(), encoding)?; + + Some(lsp_types::DiagnosticRelatedInformation { + location, + message: annotation_message.to_string(), + }) +} + +fn sub_diagnostic_to_related_information( + db: &dyn Db, + diagnostic: &SubDiagnostic, + encoding: PositionEncoding, +) -> Option<lsp_types::DiagnosticRelatedInformation> { + let primary_annotation = diagnostic.primary_annotation()?; + + let span = primary_annotation.get_span(); + let range = FileRange::try_from(span).ok()?; + let location = range.to_location(db.upcast(), encoding)?; + + Some(lsp_types::DiagnosticRelatedInformation { + location, + message: diagnostic.concise_message().to_string(), + }) +} diff --git a/crates/ty_server/src/server/api/requests/goto_type_definition.rs b/crates/ty_server/src/server/api/requests/goto_type_definition.rs new file mode 100644 index 0000000000000..8e7824769151b --- /dev/null +++ b/crates/ty_server/src/server/api/requests/goto_type_definition.rs @@ -0,0 +1,68 @@ +use std::borrow::Cow; + +use lsp_types::request::{GotoTypeDefinition, GotoTypeDefinitionParams}; +use lsp_types::{GotoDefinitionResponse, Url}; +use ruff_db::source::{line_index, source_text}; +use ty_ide::goto_type_definition; +use ty_project::ProjectDatabase; + +use crate::DocumentSnapshot; +use crate::document::{PositionExt, ToLink}; +use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; +use crate::server::client::Notifier; + +pub(crate) struct GotoTypeDefinitionRequestHandler; + +impl RequestHandler for GotoTypeDefinitionRequestHandler { + type RequestType = GotoTypeDefinition; +} + +impl BackgroundDocumentRequestHandler for GotoTypeDefinitionRequestHandler { + fn document_url(params: &GotoTypeDefinitionParams) -> Cow<Url> { + Cow::Borrowed(¶ms.text_document_position_params.text_document.uri) + } + + fn run_with_snapshot( + db: &ProjectDatabase, + snapshot: DocumentSnapshot, + _notifier: Notifier, + params: GotoTypeDefinitionParams, + ) -> crate::server::Result<Option<GotoDefinitionResponse>> { + let Some(file) = snapshot.file(db) else { + tracing::debug!("Failed to resolve file for {:?}", params); + return Ok(None); + }; + + let source = source_text(db, file); + let line_index = line_index(db, file); + let offset = params.text_document_position_params.position.to_text_size( + &source, + &line_index, + snapshot.encoding(), + ); + + let Some(ranged) = goto_type_definition(db, file, offset) else { + return Ok(None); + }; + + if snapshot + .resolved_client_capabilities() + .type_definition_link_support + { + let src = Some(ranged.range); + let links: Vec<_> = ranged + .into_iter() + .filter_map(|target| target.to_link(db, src, snapshot.encoding())) + .collect(); + + Ok(Some(GotoDefinitionResponse::Link(links))) + } else { + let locations: Vec<_> = ranged + .into_iter() + .filter_map(|target| target.to_location(db, snapshot.encoding())) + .collect(); + + Ok(Some(GotoDefinitionResponse::Array(locations))) + } + } +} diff --git a/crates/ty_server/src/server/api/requests/hover.rs b/crates/ty_server/src/server/api/requests/hover.rs new file mode 100644 index 0000000000000..8b58059d1af24 --- /dev/null +++ b/crates/ty_server/src/server/api/requests/hover.rs @@ -0,0 +1,71 @@ +use std::borrow::Cow; + +use crate::DocumentSnapshot; +use crate::document::{PositionExt, ToRangeExt}; +use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; +use crate::server::client::Notifier; +use lsp_types::request::HoverRequest; +use lsp_types::{HoverContents, HoverParams, MarkupContent, Url}; +use ruff_db::source::{line_index, source_text}; +use ruff_text_size::Ranged; +use ty_ide::{MarkupKind, hover}; +use ty_project::ProjectDatabase; + +pub(crate) struct HoverRequestHandler; + +impl RequestHandler for HoverRequestHandler { + type RequestType = HoverRequest; +} + +impl BackgroundDocumentRequestHandler for HoverRequestHandler { + fn document_url(params: &HoverParams) -> Cow<Url> { + Cow::Borrowed(¶ms.text_document_position_params.text_document.uri) + } + + fn run_with_snapshot( + db: &ProjectDatabase, + snapshot: DocumentSnapshot, + _notifier: Notifier, + params: HoverParams, + ) -> crate::server::Result<Option<lsp_types::Hover>> { + let Some(file) = snapshot.file(db) else { + tracing::debug!("Failed to resolve file for {:?}", params); + return Ok(None); + }; + + let source = source_text(db, file); + let line_index = line_index(db, file); + let offset = params.text_document_position_params.position.to_text_size( + &source, + &line_index, + snapshot.encoding(), + ); + + let Some(range_info) = hover(db, file, offset) else { + return Ok(None); + }; + + let (markup_kind, lsp_markup_kind) = if snapshot + .resolved_client_capabilities() + .hover_prefer_markdown + { + (MarkupKind::Markdown, lsp_types::MarkupKind::Markdown) + } else { + (MarkupKind::PlainText, lsp_types::MarkupKind::PlainText) + }; + + let contents = range_info.display(db, markup_kind).to_string(); + + Ok(Some(lsp_types::Hover { + contents: HoverContents::Markup(MarkupContent { + kind: lsp_markup_kind, + value: contents, + }), + range: Some(range_info.file_range().range().to_lsp_range( + &source, + &line_index, + snapshot.encoding(), + )), + })) + } +} diff --git a/crates/ty_server/src/server/api/requests/inlay_hints.rs b/crates/ty_server/src/server/api/requests/inlay_hints.rs new file mode 100644 index 0000000000000..2e7c3c6bd0429 --- /dev/null +++ b/crates/ty_server/src/server/api/requests/inlay_hints.rs @@ -0,0 +1,62 @@ +use std::borrow::Cow; + +use crate::DocumentSnapshot; +use crate::document::{RangeExt, TextSizeExt}; +use crate::server::api::traits::{BackgroundDocumentRequestHandler, RequestHandler}; +use crate::server::client::Notifier; +use lsp_types::request::InlayHintRequest; +use lsp_types::{InlayHintParams, Url}; +use ruff_db::source::{line_index, source_text}; +use ty_ide::inlay_hints; +use ty_project::ProjectDatabase; + +pub(crate) struct InlayHintRequestHandler; + +impl RequestHandler for InlayHintRequestHandler { + type RequestType = InlayHintRequest; +} + +impl BackgroundDocumentRequestHandler for InlayHintRequestHandler { + fn document_url(params: &InlayHintParams) -> Cow<Url> { + Cow::Borrowed(¶ms.text_document.uri) + } + + fn run_with_snapshot( + db: &ProjectDatabase, + snapshot: DocumentSnapshot, + _notifier: Notifier, + params: InlayHintParams, + ) -> crate::server::Result<Option<Vec<lsp_types::InlayHint>>> { + let Some(file) = snapshot.file(db) else { + tracing::debug!("Failed to resolve file for {:?}", params); + return Ok(None); + }; + + let index = line_index(db, file); + let source = source_text(db, file); + + let range = params + .range + .to_text_range(&source, &index, snapshot.encoding()); + + let inlay_hints = inlay_hints(db, file, range); + + let inlay_hints = inlay_hints + .into_iter() + .map(|hint| lsp_types::InlayHint { + position: hint + .position + .to_position(&source, &index, snapshot.encoding()), + label: lsp_types::InlayHintLabel::String(hint.display(db).to_string()), + kind: Some(lsp_types::InlayHintKind::TYPE), + tooltip: None, + padding_left: None, + padding_right: None, + data: None, + text_edits: None, + }) + .collect(); + + Ok(Some(inlay_hints)) + } +} diff --git a/crates/red_knot_server/src/server/api/traits.rs b/crates/ty_server/src/server/api/traits.rs similarity index 95% rename from crates/red_knot_server/src/server/api/traits.rs rename to crates/ty_server/src/server/api/traits.rs index 03006d0abba14..7301259c10d04 100644 --- a/crates/red_knot_server/src/server/api/traits.rs +++ b/crates/ty_server/src/server/api/traits.rs @@ -1,11 +1,11 @@ -//! A stateful LSP implementation that calls into the Ruff API. +//! A stateful LSP implementation that calls into the ty API. use crate::server::client::{Notifier, Requester}; use crate::session::{DocumentSnapshot, Session}; use lsp_types::notification::Notification as LSPNotification; use lsp_types::request::Request; -use red_knot_workspace::db::RootDatabase; +use ty_project::ProjectDatabase; /// A supertrait for any server request handler. pub(super) trait RequestHandler { @@ -17,6 +17,7 @@ pub(super) trait RequestHandler { /// This will block the main message receiver loop, meaning that no /// incoming requests or notifications will be handled while `run` is /// executing. Try to avoid doing any I/O or long-running computations. +#[expect(dead_code)] pub(super) trait SyncRequestHandler: RequestHandler { fn run( session: &mut Session, @@ -33,8 +34,8 @@ pub(super) trait BackgroundDocumentRequestHandler: RequestHandler { ) -> std::borrow::Cow<lsp_types::Url>; fn run_with_snapshot( + db: &ProjectDatabase, snapshot: DocumentSnapshot, - db: RootDatabase, notifier: Notifier, params: <<Self as RequestHandler>::RequestType as Request>::Params, ) -> super::Result<<<Self as RequestHandler>::RequestType as Request>::Result>; diff --git a/crates/red_knot_server/src/server/client.rs b/crates/ty_server/src/server/client.rs similarity index 97% rename from crates/red_knot_server/src/server/client.rs rename to crates/ty_server/src/server/client.rs index bd12f86d78e5c..e136bc98d44b8 100644 --- a/crates/red_knot_server/src/server/client.rs +++ b/crates/ty_server/src/server/client.rs @@ -4,7 +4,7 @@ use lsp_server::{Notification, RequestId}; use rustc_hash::FxHashMap; use serde_json::Value; -use super::{schedule::Task, ClientSender}; +use super::{ClientSender, schedule::Task}; type ResponseBuilder<'s> = Box<dyn FnOnce(lsp_server::Response) -> Task<'s>>; @@ -26,7 +26,7 @@ pub(crate) struct Requester<'s> { response_handlers: FxHashMap<lsp_server::RequestId, ResponseBuilder<'s>>, } -impl<'s> Client<'s> { +impl Client<'_> { pub(super) fn new(sender: ClientSender) -> Self { Self { notifier: Notifier(sender.clone()), @@ -48,7 +48,7 @@ impl<'s> Client<'s> { } } -#[allow(dead_code)] // we'll need to use `Notifier` in the future +#[expect(dead_code)] // we'll need to use `Notifier` in the future impl Notifier { pub(crate) fn notify<N>(&self, params: N::Params) -> crate::Result<()> where diff --git a/crates/ty_server/src/server/connection.rs b/crates/ty_server/src/server/connection.rs new file mode 100644 index 0000000000000..029a34c931f59 --- /dev/null +++ b/crates/ty_server/src/server/connection.rs @@ -0,0 +1,167 @@ +use lsp_server as lsp; +use lsp_types::{notification::Notification, request::Request}; +use std::sync::{Arc, Weak}; + +type ConnectionSender = crossbeam::channel::Sender<lsp::Message>; +type ConnectionReceiver = crossbeam::channel::Receiver<lsp::Message>; + +/// A builder for `Connection` that handles LSP initialization. +pub(crate) struct ConnectionInitializer { + connection: lsp::Connection, + threads: lsp::IoThreads, +} + +/// Handles inbound and outbound messages with the client. +pub(crate) struct Connection { + sender: Arc<ConnectionSender>, + receiver: ConnectionReceiver, + threads: lsp::IoThreads, +} + +impl ConnectionInitializer { + /// Create a new LSP server connection over stdin/stdout. + pub(super) fn stdio() -> Self { + let (connection, threads) = lsp::Connection::stdio(); + Self { + connection, + threads, + } + } + + /// Starts the initialization process with the client by listening for an initialization request. + /// Returns a request ID that should be passed into `initialize_finish` later, + /// along with the initialization parameters that were provided. + pub(super) fn initialize_start( + &self, + ) -> crate::Result<(lsp::RequestId, lsp_types::InitializeParams)> { + let (id, params) = self.connection.initialize_start()?; + Ok((id, serde_json::from_value(params)?)) + } + + /// Finishes the initialization process with the client, + /// returning an initialized `Connection`. + pub(super) fn initialize_finish( + self, + id: lsp::RequestId, + server_capabilities: &lsp_types::ServerCapabilities, + name: &str, + version: &str, + ) -> crate::Result<Connection> { + self.connection.initialize_finish( + id, + serde_json::json!({ + "capabilities": server_capabilities, + "serverInfo": { + "name": name, + "version": version + } + }), + )?; + let Self { + connection: lsp::Connection { sender, receiver }, + threads, + } = self; + Ok(Connection { + sender: Arc::new(sender), + receiver, + threads, + }) + } +} + +impl Connection { + /// Make a new `ClientSender` for sending messages to the client. + pub(super) fn make_sender(&self) -> ClientSender { + ClientSender { + weak_sender: Arc::downgrade(&self.sender), + } + } + + /// An iterator over incoming messages from the client. + pub(super) fn incoming(&self) -> crossbeam::channel::Iter<lsp::Message> { + self.receiver.iter() + } + + /// Check and respond to any incoming shutdown requests; returns`true` if the server should be shutdown. + pub(super) fn handle_shutdown(&self, message: &lsp::Message) -> crate::Result<bool> { + match message { + lsp::Message::Request(lsp::Request { id, method, .. }) + if method == lsp_types::request::Shutdown::METHOD => + { + self.sender + .send(lsp::Response::new_ok(id.clone(), ()).into())?; + tracing::info!("Shutdown request received. Waiting for an exit notification..."); + + loop { + match &self + .receiver + .recv_timeout(std::time::Duration::from_secs(30))? + { + lsp::Message::Notification(lsp::Notification { method, .. }) + if method == lsp_types::notification::Exit::METHOD => + { + tracing::info!("Exit notification received. Server shutting down..."); + return Ok(true); + } + lsp::Message::Request(lsp::Request { id, method, .. }) => { + tracing::warn!( + "Server received unexpected request {method} ({id}) while waiting for exit notification", + ); + self.sender.send(lsp::Message::Response(lsp::Response::new_err( + id.clone(), + lsp::ErrorCode::InvalidRequest as i32, + "Server received unexpected request while waiting for exit notification".to_string(), + )))?; + } + message => { + tracing::warn!( + "Server received unexpected message while waiting for exit notification: {message:?}" + ); + } + } + } + } + lsp::Message::Notification(lsp::Notification { method, .. }) + if method == lsp_types::notification::Exit::METHOD => + { + anyhow::bail!( + "Server received an exit notification before a shutdown request was sent. Exiting..." + ); + } + _ => Ok(false), + } + } + + /// Join the I/O threads that underpin this connection. + /// This is guaranteed to be nearly immediate since + /// we close the only active channels to these threads prior + /// to joining them. + pub(super) fn close(self) -> crate::Result<()> { + std::mem::drop( + Arc::into_inner(self.sender) + .expect("the client sender shouldn't have more than one strong reference"), + ); + std::mem::drop(self.receiver); + self.threads.join()?; + Ok(()) + } +} + +/// A weak reference to an underlying sender channel, used for communication with the client. +/// If the `Connection` that created this `ClientSender` is dropped, any `send` calls will throw +/// an error. +#[derive(Clone, Debug)] +pub(crate) struct ClientSender { + weak_sender: Weak<ConnectionSender>, +} + +// note: additional wrapper functions for senders may be implemented as needed. +impl ClientSender { + pub(crate) fn send(&self, msg: lsp::Message) -> crate::Result<()> { + let Some(sender) = self.weak_sender.upgrade() else { + anyhow::bail!("The connection with the client has been closed"); + }; + + Ok(sender.send(msg)?) + } +} diff --git a/crates/red_knot_server/src/server/schedule.rs b/crates/ty_server/src/server/schedule.rs similarity index 97% rename from crates/red_knot_server/src/server/schedule.rs rename to crates/ty_server/src/server/schedule.rs index f03570686aa4a..21c7168318975 100644 --- a/crates/red_knot_server/src/server/schedule.rs +++ b/crates/ty_server/src/server/schedule.rs @@ -12,7 +12,7 @@ use self::{ thread::ThreadPriority, }; -use super::{client::Client, ClientSender}; +use super::{ClientSender, client::Client}; /// The event loop thread is actually a secondary thread that we spawn from the /// _actual_ main thread. This secondary thread has a larger stack size @@ -23,7 +23,7 @@ pub(crate) fn event_loop_thread( ) -> crate::Result<thread::JoinHandle<crate::Result<()>>> { // Override OS defaults to avoid stack overflows on platforms with low stack size defaults. const MAIN_THREAD_STACK_SIZE: usize = 2 * 1024 * 1024; - const MAIN_THREAD_NAME: &str = "ruff:main"; + const MAIN_THREAD_NAME: &str = "ty:main"; Ok( thread::Builder::new(thread::ThreadPriority::LatencySensitive) .name(MAIN_THREAD_NAME.into()) diff --git a/crates/red_knot_server/src/server/schedule/task.rs b/crates/ty_server/src/server/schedule/task.rs similarity index 94% rename from crates/red_knot_server/src/server/schedule/task.rs rename to crates/ty_server/src/server/schedule/task.rs index fdba5e3991d9a..d269c1edb5a3b 100644 --- a/crates/red_knot_server/src/server/schedule/task.rs +++ b/crates/ty_server/src/server/schedule/task.rs @@ -17,11 +17,13 @@ type BackgroundFnBuilder<'s> = Box<dyn FnOnce(&Session) -> BackgroundFn + 's>; pub(in crate::server) enum BackgroundSchedule { /// The task should be run on the background thread designated /// for formatting actions. This is a high priority thread. + #[expect(dead_code)] Fmt, /// The task should be run on the general high-priority background - /// thread. + /// thread. Reserved for actions caused by the user typing (e.g.syntax highlighting). LatencySensitive, /// The task should be run on a regular-priority background thread. + /// The default for any request that isn't in the critical path of the user typing. #[default] Worker, } diff --git a/crates/red_knot_server/src/server/schedule/thread.rs b/crates/ty_server/src/server/schedule/thread.rs similarity index 100% rename from crates/red_knot_server/src/server/schedule/thread.rs rename to crates/ty_server/src/server/schedule/thread.rs diff --git a/crates/red_knot_server/src/server/schedule/thread/pool.rs b/crates/ty_server/src/server/schedule/thread/pool.rs similarity index 98% rename from crates/red_knot_server/src/server/schedule/thread/pool.rs rename to crates/ty_server/src/server/schedule/thread/pool.rs index ea654a11d2af4..391676ad5becf 100644 --- a/crates/red_knot_server/src/server/schedule/thread/pool.rs +++ b/crates/ty_server/src/server/schedule/thread/pool.rs @@ -16,8 +16,8 @@ use std::{ num::NonZeroUsize, sync::{ - atomic::{AtomicUsize, Ordering}, Arc, + atomic::{AtomicUsize, Ordering}, }, }; @@ -59,7 +59,7 @@ impl Pool { for i in 0..threads { let handle = Builder::new(INITIAL_PRIORITY) .stack_size(STACK_SIZE) - .name(format!("ruff:worker:{i}")) + .name(format!("ty:worker:{i}")) .spawn({ let extant_tasks = Arc::clone(&extant_tasks); let job_receiver: Receiver<Job> = job_receiver.clone(); @@ -106,7 +106,7 @@ impl Pool { self.job_sender.send(job).unwrap(); } - #[allow(dead_code)] + #[expect(dead_code)] pub(super) fn len(&self) -> usize { self.extant_tasks.load(Ordering::SeqCst) } diff --git a/crates/red_knot_server/src/server/schedule/thread/priority.rs b/crates/ty_server/src/server/schedule/thread/priority.rs similarity index 98% rename from crates/red_knot_server/src/server/schedule/thread/priority.rs rename to crates/ty_server/src/server/schedule/thread/priority.rs index e6a555242fcb7..65b6e3d984908 100644 --- a/crates/red_knot_server/src/server/schedule/thread/priority.rs +++ b/crates/ty_server/src/server/schedule/thread/priority.rs @@ -183,14 +183,14 @@ mod imp { QoSClass::Background => libc::qos_class_t::QOS_CLASS_BACKGROUND, }; - #[allow(unsafe_code)] + #[expect(unsafe_code)] let code = unsafe { libc::pthread_set_qos_class_self_np(c, 0) }; if code == 0 { return; } - #[allow(unsafe_code)] + #[expect(unsafe_code)] let errno = unsafe { *libc::__error() }; match errno { @@ -223,10 +223,10 @@ mod imp { } pub(super) fn get_current_thread_qos_class() -> Option<QoSClass> { - #[allow(unsafe_code)] + #[expect(unsafe_code)] let current_thread = unsafe { libc::pthread_self() }; let mut qos_class_raw = libc::qos_class_t::QOS_CLASS_UNSPECIFIED; - #[allow(unsafe_code)] + #[expect(unsafe_code)] let code = unsafe { libc::pthread_get_qos_class_np(current_thread, &mut qos_class_raw, std::ptr::null_mut()) }; @@ -241,7 +241,7 @@ mod imp { // ones which we cannot handle anyway // // 0: https://github.com/apple-oss-distributions/libpthread/blob/67e155c94093be9a204b69637d198eceff2c7c46/src/qos.c#L171-L177 - #[allow(unsafe_code)] + #[expect(unsafe_code)] let errno = unsafe { *libc::__error() }; unreachable!("`pthread_get_qos_class_np` failed unexpectedly (os error {errno})"); } diff --git a/crates/red_knot_server/src/session.rs b/crates/ty_server/src/session.rs similarity index 78% rename from crates/red_knot_server/src/session.rs rename to crates/ty_server/src/session.rs index de01e227d1de4..5d1cce4bd3f3e 100644 --- a/crates/red_knot_server/src/session.rs +++ b/crates/ty_server/src/session.rs @@ -8,27 +8,27 @@ use std::sync::Arc; use anyhow::anyhow; use lsp_types::{ClientCapabilities, TextDocumentContentChangeEvent, Url}; -use red_knot_workspace::db::RootDatabase; -use red_knot_workspace::workspace::WorkspaceMetadata; -use ruff_db::files::{system_path_to_file, File}; -use ruff_db::system::SystemPath; use ruff_db::Db; +use ruff_db::files::{File, system_path_to_file}; +use ruff_db::system::SystemPath; +use ty_project::{ProjectDatabase, ProjectMetadata}; -use crate::edit::{DocumentKey, DocumentVersion, NotebookDocument}; -use crate::system::{url_to_any_system_path, AnySystemPath, LSPSystem}; +use crate::document::{DocumentKey, DocumentVersion, NotebookDocument}; +use crate::system::{AnySystemPath, LSPSystem, url_to_any_system_path}; use crate::{PositionEncoding, TextDocument}; pub(crate) use self::capabilities::ResolvedClientCapabilities; pub use self::index::DocumentQuery; pub(crate) use self::settings::AllSettings; pub use self::settings::ClientSettings; +pub(crate) use self::settings::Experimental; mod capabilities; pub(crate) mod index; mod settings; // TODO(dhruvmanila): In general, the server shouldn't use any salsa queries directly and instead -// should use methods on `RootDatabase`. +// should use methods on `ProjectDatabase`. /// The global state for the LSP pub struct Session { @@ -41,8 +41,9 @@ pub struct Session { /// [`index_mut`]: Session::index_mut index: Option<Arc<index::Index>>, - /// Maps workspace root paths to their respective databases. - workspaces: BTreeMap<PathBuf, RootDatabase>, + /// Maps workspace folders to their respective project databases. + projects_by_workspace_folder: BTreeMap<PathBuf, ProjectDatabase>, + /// The global position encoding, negotiated during LSP initialization. position_encoding: PositionEncoding, /// Tracks what LSP features the client supports and doesn't support. @@ -68,14 +69,16 @@ impl Session { let system = LSPSystem::new(index.clone()); // TODO(dhruvmanila): Get the values from the client settings - let metadata = WorkspaceMetadata::from_path(system_path, &system, None)?; + let mut metadata = ProjectMetadata::discover(system_path, &system)?; + metadata.apply_configuration_files(&system)?; + // TODO(micha): Handle the case where the program settings are incorrect more gracefully. - workspaces.insert(path, RootDatabase::new(metadata, system)?); + workspaces.insert(path, ProjectDatabase::new(metadata, system)?); } Ok(Self { position_encoding, - workspaces, + projects_by_workspace_folder: workspaces, index: Some(index), resolved_client_capabilities: Arc::new(ResolvedClientCapabilities::new( client_capabilities, @@ -87,38 +90,41 @@ impl Session { // and `default_workspace_db_mut` but the borrow checker doesn't allow that. // https://github.com/astral-sh/ruff/pull/13041#discussion_r1726725437 - /// Returns a reference to the workspace [`RootDatabase`] corresponding to the given path, if + /// Returns a reference to the project's [`ProjectDatabase`] corresponding to the given path, if /// any. - pub(crate) fn workspace_db_for_path(&self, path: impl AsRef<Path>) -> Option<&RootDatabase> { - self.workspaces + pub(crate) fn project_db_for_path(&self, path: impl AsRef<Path>) -> Option<&ProjectDatabase> { + self.projects_by_workspace_folder .range(..=path.as_ref().to_path_buf()) .next_back() .map(|(_, db)| db) } - /// Returns a mutable reference to the workspace [`RootDatabase`] corresponding to the given + /// Returns a mutable reference to the project [`ProjectDatabase`] corresponding to the given /// path, if any. - pub(crate) fn workspace_db_for_path_mut( + pub(crate) fn project_db_for_path_mut( &mut self, path: impl AsRef<Path>, - ) -> Option<&mut RootDatabase> { - self.workspaces + ) -> Option<&mut ProjectDatabase> { + self.projects_by_workspace_folder .range_mut(..=path.as_ref().to_path_buf()) .next_back() .map(|(_, db)| db) } - /// Returns a reference to the default workspace [`RootDatabase`]. The default workspace is the - /// minimum root path in the workspace map. - pub(crate) fn default_workspace_db(&self) -> &RootDatabase { - // SAFETY: Currently, red knot only support a single workspace. - self.workspaces.values().next().unwrap() + /// Returns a reference to the default project [`ProjectDatabase`]. The default project is the + /// minimum root path in the project map. + pub(crate) fn default_project_db(&self) -> &ProjectDatabase { + // SAFETY: Currently, ty only support a single project. + self.projects_by_workspace_folder.values().next().unwrap() } - /// Returns a mutable reference to the default workspace [`RootDatabase`]. - pub(crate) fn default_workspace_db_mut(&mut self) -> &mut RootDatabase { - // SAFETY: Currently, red knot only support a single workspace. - self.workspaces.values_mut().next().unwrap() + /// Returns a mutable reference to the default project [`ProjectDatabase`]. + pub(crate) fn default_project_db_mut(&mut self) -> &mut ProjectDatabase { + // SAFETY: Currently, ty only support a single project. + self.projects_by_workspace_folder + .values_mut() + .next() + .unwrap() } pub fn key_from_url(&self, url: Url) -> DocumentKey { @@ -187,7 +193,7 @@ impl Session { fn index_mut(&mut self) -> MutIndexGuard { let index = self.index.take().unwrap(); - for db in self.workspaces.values_mut() { + for db in self.projects_by_workspace_folder.values_mut() { // Remove the `index` from each database. This drops the count of `Arc<Index>` down to 1 db.system_mut() .as_any_mut() @@ -204,6 +210,10 @@ impl Session { index, } } + + pub(crate) fn client_capabilities(&self) -> &ResolvedClientCapabilities { + &self.resolved_client_capabilities + } } /// A guard that holds the only reference to the index and allows modifying it. @@ -232,7 +242,7 @@ impl Drop for MutIndexGuard<'_> { fn drop(&mut self) { if let Some(index) = self.index.take() { let index = Arc::new(index); - for db in self.session.workspaces.values_mut() { + for db in self.session.projects_by_workspace_folder.values_mut() { db.system_mut() .as_any_mut() .downcast_mut::<LSPSystem>() @@ -267,7 +277,7 @@ impl DocumentSnapshot { self.position_encoding } - pub(crate) fn file(&self, db: &RootDatabase) -> Option<File> { + pub(crate) fn file(&self, db: &dyn Db) -> Option<File> { match url_to_any_system_path(self.document_ref.file_url()).ok()? { AnySystemPath::System(path) => system_path_to_file(db, path).ok(), AnySystemPath::SystemVirtual(virtual_path) => db diff --git a/crates/ty_server/src/session/capabilities.rs b/crates/ty_server/src/session/capabilities.rs new file mode 100644 index 0000000000000..adfe6cb077af1 --- /dev/null +++ b/crates/ty_server/src/session/capabilities.rs @@ -0,0 +1,95 @@ +use lsp_types::{ClientCapabilities, MarkupKind}; + +#[derive(Debug, Clone, PartialEq, Eq, Default)] +#[expect(clippy::struct_excessive_bools)] +pub(crate) struct ResolvedClientCapabilities { + pub(crate) code_action_deferred_edit_resolution: bool, + pub(crate) apply_edit: bool, + pub(crate) document_changes: bool, + pub(crate) diagnostics_refresh: bool, + pub(crate) inlay_refresh: bool, + pub(crate) pull_diagnostics: bool, + /// Whether `textDocument.typeDefinition.linkSupport` is `true` + pub(crate) type_definition_link_support: bool, + + /// `true`, if the first markup kind in `textDocument.hover.contentFormat` is `Markdown` + pub(crate) hover_prefer_markdown: bool, +} + +impl ResolvedClientCapabilities { + pub(super) fn new(client_capabilities: &ClientCapabilities) -> Self { + let code_action_settings = client_capabilities + .text_document + .as_ref() + .and_then(|doc_settings| doc_settings.code_action.as_ref()); + let code_action_data_support = code_action_settings + .and_then(|code_action_settings| code_action_settings.data_support) + .unwrap_or_default(); + let code_action_edit_resolution = code_action_settings + .and_then(|code_action_settings| code_action_settings.resolve_support.as_ref()) + .is_some_and(|resolve_support| resolve_support.properties.contains(&"edit".into())); + + let apply_edit = client_capabilities + .workspace + .as_ref() + .and_then(|workspace| workspace.apply_edit) + .unwrap_or_default(); + + let document_changes = client_capabilities + .workspace + .as_ref() + .and_then(|workspace| workspace.workspace_edit.as_ref()?.document_changes) + .unwrap_or_default(); + + let declaration_link_support = client_capabilities + .text_document + .as_ref() + .and_then(|document| document.type_definition?.link_support) + .unwrap_or_default(); + + let diagnostics_refresh = client_capabilities + .workspace + .as_ref() + .and_then(|workspace| workspace.diagnostics.as_ref()?.refresh_support) + .unwrap_or_default(); + + let inlay_refresh = client_capabilities + .workspace + .as_ref() + .and_then(|workspace| workspace.inlay_hint.as_ref()?.refresh_support) + .unwrap_or_default(); + + let pull_diagnostics = client_capabilities + .text_document + .as_ref() + .and_then(|text_document| text_document.diagnostic.as_ref()) + .is_some(); + + let hover_prefer_markdown = client_capabilities + .text_document + .as_ref() + .and_then(|text_document| { + Some( + text_document + .hover + .as_ref()? + .content_format + .as_ref()? + .contains(&MarkupKind::Markdown), + ) + }) + .unwrap_or_default(); + + Self { + code_action_deferred_edit_resolution: code_action_data_support + && code_action_edit_resolution, + apply_edit, + document_changes, + diagnostics_refresh, + inlay_refresh, + pull_diagnostics, + type_definition_link_support: declaration_link_support, + hover_prefer_markdown, + } + } +} diff --git a/crates/red_knot_server/src/session/index.rs b/crates/ty_server/src/session/index.rs similarity index 88% rename from crates/red_knot_server/src/session/index.rs rename to crates/ty_server/src/session/index.rs index 62f00e1de7ba7..bcd2c60ab85fa 100644 --- a/crates/red_knot_server/src/session/index.rs +++ b/crates/ty_server/src/session/index.rs @@ -1,13 +1,12 @@ -use std::borrow::Cow; -use std::path::{Path, PathBuf}; +use std::path::Path; use std::sync::Arc; use lsp_types::Url; use rustc_hash::FxHashMap; use crate::{ - edit::{DocumentKey, DocumentVersion, NotebookDocument}, PositionEncoding, TextDocument, + document::{DocumentKey, DocumentVersion, NotebookDocument}, }; use super::ClientSettings; @@ -22,6 +21,7 @@ pub(crate) struct Index { notebook_cells: FxHashMap<Url, Url>, /// Global settings provided by the client. + #[expect(dead_code)] global_settings: ClientSettings, } @@ -34,12 +34,14 @@ impl Index { } } + #[expect(dead_code)] pub(super) fn text_document_urls(&self) -> impl Iterator<Item = &Url> + '_ { self.documents .iter() .filter_map(|(url, doc)| doc.as_text().and(Some(url))) } + #[expect(dead_code)] pub(super) fn notebook_document_urls(&self) -> impl Iterator<Item = &Url> + '_ { self.documents .iter() @@ -74,7 +76,7 @@ impl Index { DocumentKey::NotebookCell(url) } else if Path::new(url.path()) .extension() - .map_or(false, |ext| ext.eq_ignore_ascii_case("ipynb")) + .is_some_and(|ext| ext.eq_ignore_ascii_case("ipynb")) { DocumentKey::Notebook(url) } else { @@ -82,6 +84,7 @@ impl Index { } } + #[expect(dead_code)] pub(super) fn update_notebook_document( &mut self, key: &DocumentKey, @@ -116,10 +119,6 @@ impl Index { Ok(()) } - pub(super) fn num_documents(&self) -> usize { - self.documents.len() - } - pub(crate) fn make_document_ref(&self, key: DocumentKey) -> Option<DocumentQuery> { let url = self.url_for_key(&key)?.clone(); let controller = self.documents.get(&url)?; @@ -231,7 +230,6 @@ impl DocumentController { } } - #[allow(dead_code)] pub(crate) fn as_text(&self) -> Option<&TextDocument> { match self { Self::Text(document) => Some(document), @@ -267,6 +265,7 @@ pub enum DocumentQuery { impl DocumentQuery { /// Retrieve the original key that describes this document query. + #[expect(dead_code)] pub(crate) fn make_key(&self) -> DocumentKey { match self { Self::Text { file_url, .. } => DocumentKey::Text(file_url.clone()), @@ -286,14 +285,6 @@ impl DocumentQuery { } } - /// Get the source type of the document associated with this query. - pub(crate) fn source_type(&self) -> ruff_python_ast::PySourceType { - match self { - Self::Text { .. } => ruff_python_ast::PySourceType::from(self.virtual_file_path()), - Self::Notebook { .. } => ruff_python_ast::PySourceType::Ipynb, - } - } - /// Get the version of document selected by this query. pub(crate) fn version(&self) -> DocumentVersion { match self { @@ -309,27 +300,9 @@ impl DocumentQuery { } } - /// Get the path for the document selected by this query. - /// - /// Returns `None` if this is an unsaved (untitled) document. - /// - /// The path isn't guaranteed to point to a real path on the filesystem. This is the case - /// for unsaved (untitled) documents. - pub(crate) fn file_path(&self) -> Option<PathBuf> { - self.file_url().to_file_path().ok() - } - - /// Get the path for the document selected by this query, ignoring whether the file exists on disk. - /// - /// Returns the URL's path if this is an unsaved (untitled) document. - pub(crate) fn virtual_file_path(&self) -> Cow<Path> { - self.file_path() - .map(Cow::Owned) - .unwrap_or_else(|| Cow::Borrowed(Path::new(self.file_url().path()))) - } - /// Attempt to access the single inner text document selected by the query. /// If this query is selecting an entire notebook document, this will return `None`. + #[expect(dead_code)] pub(crate) fn as_single_document(&self) -> Option<&TextDocument> { match self { Self::Text { document, .. } => Some(document), diff --git a/crates/ty_server/src/session/settings.rs b/crates/ty_server/src/session/settings.rs new file mode 100644 index 0000000000000..64f6fe04a900f --- /dev/null +++ b/crates/ty_server/src/session/settings.rs @@ -0,0 +1,135 @@ +use std::path::PathBuf; + +use lsp_types::Url; +use rustc_hash::FxHashMap; +use serde::Deserialize; + +/// Maps a workspace URI to its associated client settings. Used during server initialization. +pub(crate) type WorkspaceSettingsMap = FxHashMap<Url, ClientSettings>; + +#[derive(Debug, Deserialize, Default)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(rename_all = "camelCase")] +struct Completions { + enable: Option<bool>, +} + +#[derive(Debug, Deserialize, Default)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(rename_all = "camelCase")] +pub(crate) struct Experimental { + completions: Option<Completions>, +} + +impl Experimental { + /// Returns `true` if completions are enabled in the settings. + pub(crate) fn is_completions_enabled(&self) -> bool { + self.completions + .as_ref() + .is_some_and(|completions| completions.enable.unwrap_or_default()) + } +} + +/// This is a direct representation of the settings schema sent by the client. +#[derive(Debug, Deserialize, Default)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(rename_all = "camelCase")] +pub struct ClientSettings { + pub(crate) experimental: Option<Experimental>, + // These settings are only needed for tracing, and are only read from the global configuration. + // These will not be in the resolved settings. + #[serde(flatten)] + pub(crate) tracing: TracingSettings, +} + +/// Settings needed to initialize tracing. These will only be +/// read from the global configuration. +#[derive(Debug, Deserialize, Default)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(rename_all = "camelCase")] +pub(crate) struct TracingSettings { + pub(crate) log_level: Option<crate::logging::LogLevel>, + /// Path to the log file - tildes and environment variables are supported. + pub(crate) log_file: Option<PathBuf>, +} + +/// This is a direct representation of the workspace settings schema, +/// which inherits the schema of [`ClientSettings`] and adds extra fields +/// to describe the workspace it applies to. +#[derive(Debug, Deserialize)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(rename_all = "camelCase")] +struct WorkspaceSettings { + #[serde(flatten)] + settings: ClientSettings, + workspace: Url, +} + +/// This is the exact schema for initialization options sent in by the client +/// during initialization. +#[derive(Debug, Deserialize)] +#[cfg_attr(test, derive(PartialEq, Eq))] +#[serde(untagged)] +enum InitializationOptions { + #[serde(rename_all = "camelCase")] + HasWorkspaces { + global_settings: ClientSettings, + #[serde(rename = "settings")] + workspace_settings: Vec<WorkspaceSettings>, + }, + GlobalOnly { + #[serde(default)] + settings: ClientSettings, + }, +} + +/// Built from the initialization options provided by the client. +#[derive(Debug)] +pub(crate) struct AllSettings { + pub(crate) global_settings: ClientSettings, + /// If this is `None`, the client only passed in global settings. + pub(crate) workspace_settings: Option<WorkspaceSettingsMap>, +} + +impl AllSettings { + /// Initializes the controller from the serialized initialization options. + /// This fails if `options` are not valid initialization options. + pub(crate) fn from_value(options: serde_json::Value) -> Self { + Self::from_init_options( + serde_json::from_value(options) + .map_err(|err| { + tracing::error!("Failed to deserialize initialization options: {err}. Falling back to default client settings..."); + show_err_msg!("ty received invalid client settings - falling back to default client settings."); + }) + .unwrap_or_default(), + ) + } + + fn from_init_options(options: InitializationOptions) -> Self { + let (global_settings, workspace_settings) = match options { + InitializationOptions::GlobalOnly { settings } => (settings, None), + InitializationOptions::HasWorkspaces { + global_settings, + workspace_settings, + } => (global_settings, Some(workspace_settings)), + }; + + Self { + global_settings, + workspace_settings: workspace_settings.map(|workspace_settings| { + workspace_settings + .into_iter() + .map(|settings| (settings.workspace, settings.settings)) + .collect() + }), + } + } +} + +impl Default for InitializationOptions { + fn default() -> Self { + Self::GlobalOnly { + settings: ClientSettings::default(), + } + } +} diff --git a/crates/red_knot_server/src/system.rs b/crates/ty_server/src/system.rs similarity index 84% rename from crates/red_knot_server/src/system.rs rename to crates/ty_server/src/system.rs index 4d8c18785bf4e..58e9425ce384c 100644 --- a/crates/red_knot_server/src/system.rs +++ b/crates/ty_server/src/system.rs @@ -3,17 +3,18 @@ use std::fmt::Display; use std::sync::Arc; use lsp_types::Url; - use ruff_db::file_revision::FileRevision; +use ruff_db::files::{File, FilePath}; use ruff_db::system::walk_directory::WalkDirectoryBuilder; use ruff_db::system::{ - DirectoryEntry, FileType, Metadata, OsSystem, Result, System, SystemPath, SystemPathBuf, - SystemVirtualPath, SystemVirtualPathBuf, + CaseSensitivity, DirectoryEntry, FileType, GlobError, Metadata, OsSystem, PatternError, Result, + System, SystemPath, SystemPathBuf, SystemVirtualPath, SystemVirtualPathBuf, }; use ruff_notebook::{Notebook, NotebookError}; +use ty_python_semantic::Db; -use crate::session::index::Index; use crate::DocumentQuery; +use crate::session::index::Index; /// Converts the given [`Url`] to an [`AnySystemPath`]. /// @@ -35,6 +36,16 @@ pub(crate) fn url_to_any_system_path(url: &Url) -> std::result::Result<AnySystem } } +pub(crate) fn file_to_url(db: &dyn Db, file: File) -> Option<Url> { + match file.path(db) { + FilePath::System(system) => Url::from_file_path(system.as_std_path()).ok(), + FilePath::SystemVirtual(path) => Url::parse(path.as_str()).ok(), + // TODO: Not yet supported, consider an approach similar to Sorbet's custom paths + // https://sorbet.org/docs/sorbet-uris + FilePath::Vendored(_) => None, + } +} + /// Represents either a [`SystemPath`] or a [`SystemVirtualPath`]. #[derive(Debug)] pub(crate) enum AnySystemPath { @@ -136,6 +147,10 @@ impl System for LSPSystem { self.os_system.canonicalize_path(path) } + fn path_exists_case_sensitive(&self, path: &SystemPath, prefix: &SystemPath) -> bool { + self.os_system.path_exists_case_sensitive(path, prefix) + } + fn read_to_string(&self, path: &SystemPath) -> Result<String> { let document = self.system_path_to_document_ref(path)?; @@ -187,6 +202,10 @@ impl System for LSPSystem { self.os_system.current_directory() } + fn user_config_directory(&self) -> Option<SystemPathBuf> { + self.os_system.user_config_directory() + } + fn read_directory<'a>( &'a self, path: &SystemPath, @@ -198,6 +217,16 @@ impl System for LSPSystem { self.os_system.walk_directory(path) } + fn glob( + &self, + pattern: &str, + ) -> std::result::Result< + Box<dyn Iterator<Item = std::result::Result<SystemPathBuf, GlobError>> + '_>, + PatternError, + > { + self.os_system.glob(pattern) + } + fn as_any(&self) -> &dyn Any { self } @@ -205,6 +234,10 @@ impl System for LSPSystem { fn as_any_mut(&mut self) -> &mut dyn Any { self } + + fn case_sensitivity(&self) -> CaseSensitivity { + self.os_system.case_sensitivity() + } } fn not_a_text_document(path: impl Display) -> std::io::Error { @@ -225,6 +258,6 @@ fn virtual_path_not_found(path: impl Display) -> std::io::Error { fn document_revision(document: &DocumentQuery) -> FileRevision { // The file revision is just an opaque number which doesn't have any significant meaning other // than that the file has changed if the revisions are different. - #[allow(clippy::cast_sign_loss)] + #[expect(clippy::cast_sign_loss)] FileRevision::new(document.version() as u128) } diff --git a/crates/ty_test/Cargo.toml b/crates/ty_test/Cargo.toml new file mode 100644 index 0000000000000..c80bf76011e9d --- /dev/null +++ b/crates/ty_test/Cargo.toml @@ -0,0 +1,41 @@ +[package] +name = "ty_test" +version = "0.0.0" +publish = false +edition.workspace = true +rust-version.workspace = true +homepage.workspace = true +documentation.workspace = true +repository.workspace = true +authors.workspace = true +license.workspace = true + +[dependencies] +ruff_db = { workspace = true, features = ["os", "testing"] } +ruff_index = { workspace = true } +ruff_notebook = { workspace = true } +ruff_python_trivia = { workspace = true } +ruff_source_file = { workspace = true } +ruff_text_size = { workspace = true } +ruff_python_ast = { workspace = true } +ty_python_semantic = { workspace = true, features = ["serde"] } +ty_vendored = { workspace = true } + +anyhow = { workspace = true } +camino = { workspace = true } +colored = { workspace = true } +insta = { workspace = true, features = ["filters"] } +memchr = { workspace = true } +regex = { workspace = true } +rustc-hash = { workspace = true } +rustc-stable-hash = { workspace = true } +salsa = { workspace = true } +smallvec = { workspace = true } +serde = { workspace = true } +tempfile = { workspace = true } +toml = { workspace = true } +tracing = { workspace = true } +thiserror = { workspace = true } + +[lints] +workspace = true diff --git a/crates/ty_test/README.md b/crates/ty_test/README.md new file mode 100644 index 0000000000000..e16b56ec49016 --- /dev/null +++ b/crates/ty_test/README.md @@ -0,0 +1,536 @@ +# Writing type-checking / type-inference tests + +Any Markdown file can be a test suite. + +In order for it to be run as one, `ty_test::run` must be called with its path; see +`crates/ty_python_semantic/tests/mdtest.rs` for an example that treats all Markdown files +under a certain directory as test suites. + +A Markdown test suite can contain any number of tests. A test consists of one or more embedded +"files", each defined by a triple-backticks fenced code block. The code block must have a tag string +specifying its language. We currently support `py` (Python files) and `pyi` (type stub files), as +well as [typeshed `VERSIONS`] files and `toml` for configuration. + +The simplest possible test suite consists of just a single test, with a single embedded file: + +````markdown +```py +reveal_type(1) # revealed: Literal[1] +``` +```` + +When running this test, the mdtest framework will write a file with these contents to the default +file path (`/src/mdtest_snippet.py`) in its in-memory file system, run a type check on that file, +and then match the resulting diagnostics with the assertions in the test. Assertions are in the form +of Python comments. If all diagnostics and all assertions are matched, the test passes; otherwise, +it fails. + +<!--- +(If you are reading this document in raw Markdown source rather than rendered Markdown, note that +the quadruple-backtick-fenced "markdown" language code block above is NOT itself part of the mdtest +syntax, it's just how this README embeds an example mdtest Markdown document.) +---> + +See actual example mdtest suites in +[`crates/ty_python_semantic/resources/mdtest`](https://github.com/astral-sh/ruff/tree/main/crates/ty_python_semantic/resources/mdtest). + +> [!NOTE] +> If you use `dir-test`, `rstest` or similar to generate a separate test for all Markdown files in a certain directory, +> as with the example in `crates/ty_python_semantic/tests/mdtest.rs`, +> you will likely want to also make sure that the crate the tests are in is rebuilt every time a +> Markdown file is added or removed from the directory. See +> [`crates/ty_python_semantic/build.rs`](https://github.com/astral-sh/ruff/tree/main/crates/ty_python_semantic/build.rs) +> for an example of how to do this. +> +> This is because these macros generate their tests at build time rather than at runtime. +> Without the `build.rs` file to force a rebuild when a Markdown file is added or removed, +> a new Markdown test suite might not be run unless some other change in the crate caused a rebuild +> following the addition of the new test file. + +## Assertions + +Two kinds of assertions are supported: `# revealed:` (shown above) and `# error:`. + +### Assertion kinds + +#### revealed + +A `# revealed:` assertion should always be paired with a call to the `reveal_type` utility, which +reveals (via a diagnostic) the inferred type of its argument (which can be any expression). The text +after `# revealed:` must match exactly with the displayed form of the revealed type of that +expression. + +The `reveal_type` function can be imported from the `typing` standard library module (or, for older +Python versions, from the `typing_extensions` pseudo-standard-library module[^extensions]): + +```py +from typing import reveal_type + +reveal_type("foo") # revealed: Literal["foo"] +``` + +For convenience, type checkers also pretend that `reveal_type` is a built-in, so that this import is +not required. Using `reveal_type` without importing it issues a diagnostic warning that it was used +without importing it, in addition to the diagnostic revealing the type of the expression. + +The `# revealed:` assertion must always match a revealed-type diagnostic, and will also match the +undefined-reveal diagnostic, if present, so it's safe to use `reveal_type` in tests either with or +without importing it. (Style preference is to not import it in tests, unless specifically testing +something about the behavior of importing it.) + +#### error + +A comment beginning with `# error:` is an assertion that a type checker diagnostic will be emitted, +with text span starting on that line. The matching can be narrowed in three ways: + +- `# error: [invalid-assignment]` requires that the matched diagnostic have the rule code + `invalid-assignment`. (The square brackets are required.) +- `# error: "Some text"` requires that the diagnostic's full message contain the text `Some text`. + (The double quotes are required in the assertion comment; they are not part of the matched text.) +- `# error: 8 [rule-code]` or `# error: 8 "Some text"` additionally requires that the matched + diagnostic's text span begins on column 8 (one-indexed) of this line. + +Assertions must contain either a rule code or a contains-text, or both, and may optionally also +include a column number. They must come in order: first column, if present; then rule code, if +present; then contains-text, if present. For example, an assertion using all three would look like +`# error: 8 [invalid-assignment] "Some text"`. + +Error assertions in tests intended to test type checker semantics should primarily use rule-code +assertions, with occasional contains-text assertions where needed to disambiguate or validate some +details of the diagnostic message. + +### Assertion locations + +An assertion comment may be a line-trailing comment, in which case it applies to the line it is on: + +```py +x: str = 1 # error: [invalid-assignment] +``` + +Or it may be a comment on its own line, in which case it applies to the next line that does not +contain an assertion comment: + +```py +# error: [invalid-assignment] +x: str = 1 +``` + +Multiple assertions applying to the same line may be stacked: + +```py +# error: [invalid-assignment] +# revealed: Literal[1] +x: str = reveal_type(1) +``` + +Intervening empty lines or non-assertion comments are not allowed; an assertion stack must be one +assertion per line, immediately following each other, with the line immediately following the last +assertion as the line of source code on which the matched diagnostics are emitted. + +## Literate style + +If multiple code blocks (without an explicit path, see below) are present in a single test, they will +be merged into a single file in the order they appear in the Markdown file. This allows for tests that +interleave code and explanations: + +````markdown +# My literate test + +This first snippet here: + +```py +from typing import Literal + +def f(x: Literal[1]): + pass +``` + +will be merged with this second snippet here, i.e. `f` is defined here: + +```py +f(2) # error: [invalid-argument-type] +``` +```` + +## Diagnostic Snapshotting + +In addition to inline assertions, one can also snapshot the full diagnostic +output of a test. This is done by adding a `<!-- snapshot-diagnostics -->` directive +in the corresponding section. For example: + +````markdown +## Unresolvable module import + +<!-- snapshot-diagnostics --> + +```py +import zqzqzqzqzqzqzq # error: [unresolved-import] "Cannot resolve import `zqzqzqzqzqzqzq`" +``` +```` + +The `snapshot-diagnostics` directive must appear before anything else in +the section. + +This will use `insta` to manage an external file snapshot of all diagnostic +output generated. + +Inline assertions, as described above, may be used in conjunction with diagnostic +snapshotting. + +At present, there is no way to do inline snapshotting or to request more granular +snapshotting of specific diagnostics. + +## Multi-file tests + +Some tests require multiple files, with imports from one file into another. For this purpose, +tests can specify explicit file paths in a separate line before the code block (`b.py` below): + +````markdown +```py +from b import C +reveal_type(C) # revealed: Literal[C] +``` + +`b.py`: + +```py +class C: pass +``` +```` + +Relative file names are always relative to the "workspace root", which is also an import root (that +is, the equivalent of a runtime entry on `sys.path`). + +The default workspace root is `/src/`. Currently it is not possible to customize this in a test, but +this is a feature we will want to add in the future. + +So the above test creates two files, `/src/mdtest_snippet.py` and `/src/b.py`, and sets the workspace +root to `/src/`, allowing imports from `b.py` using the module name `b`. + +## Multi-test suites + +A single test suite (Markdown file) can contain multiple tests, by demarcating them using Markdown +header lines: + +````markdown +# Same-file invalid assignment + +```py +x: int = "foo" # error: [invalid-assignment] +``` + +# Cross-file invalid assignment + +```py +from b import y +x: int = y # error: [invalid-assignment] +``` + +`b.py`: + +```py +y = "foo" +``` +```` + +This test suite contains two tests, one named "Same-file invalid assignment" and the other named +"Cross-file invalid assignment". The first test involves only a single embedded file, and the second +test involves two embedded files. + +The tests are run independently, in independent in-memory file systems and with new ty +[Salsa](https://github.com/salsa-rs/salsa) databases. This means that each is a from-scratch run of +the type checker, with no data persisting from any previous test. + +It is possible to filter to individual tests within a single markdown file using the +`MDTEST_TEST_FILTER` environment variable. This variable will match any tests which contain the +value as a case-sensitive substring in its name. An example test name is +`unpacking.md - Unpacking - Tuple - Multiple assignment`, which contains the name of the markdown +file and its parent headers joined together with hyphens. + +## Structured test suites + +Markdown headers can also be used to group related tests within a suite: + +````markdown +# Literals + +## Numbers + +### Integer + +```py +reveal_type(1) # revealed: Literal[1] +``` + +### Float + +```py +reveal_type(1.0) # revealed: float +``` + +## Strings + +```py +reveal_type("foo") # revealed: Literal["foo"] +``` +```` + +This test suite contains three tests, named "Literals - Numbers - Integer", "Literals - Numbers - +Float", and "Literals - Strings". + +A header-demarcated section must either be a test or a grouping header; it cannot be both. That is, +a header section can either contain embedded files (making it a test), or it can contain more +deeply-nested headers (headers with more `#`), but it cannot contain both. + +## Configuration + +The test framework supports a TOML-based configuration format, which is a subset of the full ty +configuration format. This configuration can be specified in fenced code blocks with `toml` as the +language tag: + +````markdown +```toml +[environment] +python-version = "3.10" +``` +```` + +This configuration will apply to all tests in the same section, and all nested sections within that +section. Nested sections can override configurations from their parent sections. + +See [`MarkdownTestConfig`](https://github.com/astral-sh/ruff/blob/main/crates/ty_test/src/config.rs) for the full list of supported configuration options. + +### Specifying a custom typeshed + +Some tests will need to override the default typeshed with custom files. The `[environment]` +configuration option `typeshed` can be used to do this: + +````markdown +```toml +[environment] +typeshed = "/typeshed" +``` +```` + +For more details, take a look at the [custom-typeshed Markdown test]. + +### Mocking a Python environment + +Mdtest supports mocking a Python environment for a specific test at an arbitrary location, again +using the `[environment]` configuration option: + +````markdown +```toml +[environment] +python = ".venv" +``` +```` + +Mdtest also makes it easy to write Python packages to the mock environment's `site-packages` +directory using the `<path-to-site-packages>` magic path segment. This would otherwise be hard, due +to the fact that the `site-packages` subdirectory in an environment is located at a different +relative path depending on the platform. In the following test, mdtest will write the Python file to +`.venv/Lib/site-packages/foo.py` in its in-memory filesystem used for the test if the test is being +executed on Windows, and `.venv/lib/python3.13/site-packages/foo.py` otherwise: + +````markdown +```toml +[environment] +python = ".venv" +python-version = "3.13" +``` + +`.venv/<path-to-site-packages>/foo.py`: + +```py +X = 1 +``` +```` + +## Documentation of tests + +Arbitrary Markdown syntax (including of course normal prose paragraphs) is permitted (and ignored by +the test framework) between fenced code blocks. This permits natural documentation of +why a test exists, and what it intends to assert: + +````markdown +Assigning a string to a variable annotated as `int` is not permitted: + +```py +x: int = "foo" # error: [invalid-assignment] +``` +```` + +## Running the tests + +All Markdown-based tests are executed in a normal `cargo test` / `cargo run nextest` run. If you want to run the Markdown tests +*only*, you can filter the tests using `mdtest__`: + +```bash +cargo test -p ty_python_semantic -- mdtest__ +``` + +Alternatively, you can use the `mdtest.py` runner which has a watch mode that will re-run corresponding tests when Markdown files change, and recompile automatically when Rust code changes: + +```bash +uv run crates/ty_python_semantic/mdtest.py +``` + +## Planned features + +There are some designed features that we intend for the test framework to have, but have not yet +implemented: + +### Multi-line diagnostic assertions + +We may want to be able to assert that a diagnostic spans multiple lines, and to assert the columns it +begins and/or ends on. The planned syntax for this will use `<<<` and `>>>` to mark the start and end lines for +an assertion: + +```py +(3 # error: 2 [unsupported-operands] <<< + + + "foo") # error: 6 >>> +``` + +The column assertion `6` on the ending line should be optional. + +In cases of overlapping such assertions, resolve ambiguity using more angle brackets: `<<<<` begins +an assertion ended by `>>>>`, etc. + +### Configuring search paths and kinds + +The ty TOML configuration format hasn't been finalized, and we may want to implement +support in the test framework for configuring search paths before it is designed. If so, we can +define some configuration options for now under the `[tests]` namespace. In the future, perhaps +some of these can be replaced by real ty configuration options; some or all may also be +kept long-term as test-specific options. + +Some configuration options we will want to provide: + +- We should be able to configure the default workspace root to something other than `/src/` using a + `workspace-root` configuration option. + +- We should be able to add a third-party root using the `third-party-root` configuration option. + +- We may want to add additional configuration options for setting additional search path kinds. + +Paths for `workspace-root` and `third-party-root` must be absolute. + +Relative embedded-file paths are relative to the workspace root, even if it is explicitly set to a +non-default value using the `workspace-root` config. + +### I/O errors + +We could use an `error=` configuration option in the tag string to make an embedded file cause an +I/O error on read. + +### Asserting on full diagnostic output + +> [!NOTE] +> At present, one can opt into diagnostic snapshotting that is managed via external files. See +> the section above for more details. The feature outlined below, *inline* diagnostic snapshotting, +> is still desirable. + +The inline comment diagnostic assertions are useful for making quick, readable assertions about +diagnostics in a particular location. But sometimes we will want to assert on the full diagnostic +output of checking an embedded Python file. Or sometimes (see “incremental tests” below) we will +want to assert on diagnostics in a file, without impacting the contents of that file by changing a +comment in it. In these cases, a Python code block in a test could be followed by a fenced code +block with language `output`; this would contain the full diagnostic output for the preceding test +file: + +````markdown +# full output + +```py +x = 1 +reveal_type(x) +``` + +This is just an example, not a proposal that ty would ever actually output diagnostics in +precisely this format: + +```output +mdtest_snippet.py, line 1, col 1: revealed type is 'Literal[1]' +``` +```` + +We will want to build tooling to automatically capture and update these “full diagnostic output” +blocks, when tests are run in an update-output mode (probably specified by an environment variable.) + +By default, an `output` block will specify diagnostic output for the file +`<workspace-root>/mdtest_snippet.py`. An `output` block can be prefixed by a +<code>`<path>`:</code> label as usual, to explicitly specify the Python file for which it asserts +diagnostic output. + +It is an error for an `output` block to exist, if there is no `py` or `python` block in the same +test for the same file path. + +### Incremental tests + +Some tests should validate incremental checking, by initially creating some files, checking them, +and then modifying/adding/deleting files and checking again. + +We should add the capability to create an incremental test by using the `stage=` option on some +fenced code blocks in the test: + +````markdown +# Incremental + +## modify a file + +Initial file contents: + +```py +from b import x +reveal_type(x) +``` + +`b.py`: + +```py +x = 1 +``` + +Initial expected output for the unnamed file: + +```output +/src/mdtest_snippet.py, line 1, col 1: revealed type is 'Literal[1]' +``` + +Now in our first incremental stage, modify the contents of `b.py`: + +`b.py`: + +```py stage=1 +# b.py +x = 2 +``` + +And this is our updated expected output for the unnamed file at stage 1: + +```output stage=1 +/src/mdtest_snippet.py, line 1, col 1: revealed type is 'Literal[2]' +``` + +(One reason to use full-diagnostic-output blocks in this test is that updating inline-comment +diagnostic assertions for `mdtest_snippet.py` would require specifying new contents for +`mdtest_snippet.py` in stage 1, which we don't want to do in this test.) +```` + +It will be possible to provide any number of stages in an incremental test. If a stage re-specifies +a filename that was specified in a previous stage (or the initial stage), that file is modified. A +new filename appearing for the first time in a new stage will create a new file. To delete a +previously created file, specify that file with the tag `delete` in its tag string (in this case, it +is an error to provide non-empty contents). Any previously-created files that are not re-specified +in a later stage continue to exist with their previously-specified contents, and are not "touched". + +All stages should be run in order, incrementally, and then the final state should also be re-checked +cold, to validate equivalence of cold and incremental check results. + +[^extensions]: `typing-extensions` is a third-party module, but typeshed, and thus type checkers + also, treat it as part of the standard library. + +[custom-typeshed markdown test]: ../ty_python_semantic/resources/mdtest/mdtest_custom_typeshed.md +[typeshed `versions`]: https://github.com/python/typeshed/blob/c546278aae47de0b2b664973da4edb613400f6ce/stdlib/VERSIONS#L1-L18%3E diff --git a/crates/ty_test/src/assertion.rs b/crates/ty_test/src/assertion.rs new file mode 100644 index 0000000000000..2e9bfd338ceb0 --- /dev/null +++ b/crates/ty_test/src/assertion.rs @@ -0,0 +1,822 @@ +//! Parse type and type-error assertions in Python comment form. +//! +//! Parses comments of the form `# revealed: SomeType` and `# error: 8 [rule-code] "message text"`. +//! In the latter case, the `8` is a column number, and `"message text"` asserts that the full +//! diagnostic message contains the text `"message text"`; all three are optional (`# error:` will +//! match any error.) +//! +//! Assertion comments may be placed at end-of-line: +//! +//! ```py +//! x: int = "foo" # error: [invalid-assignment] +//! ``` +//! +//! Or as a full-line comment on the preceding line: +//! +//! ```py +//! # error: [invalid-assignment] +//! x: int = "foo" +//! ``` +//! +//! Multiple assertion comments may apply to the same line; in this case all (or all but the last) +//! must be full-line comments: +//! +//! ```py +//! # error: [unbound-name] +//! reveal_type(x) # revealed: Unbound +//! ``` +//! +//! or +//! +//! ```py +//! # error: [unbound-name] +//! # revealed: Unbound +//! reveal_type(x) +//! ``` + +use crate::db::Db; +use ruff_db::files::File; +use ruff_db::parsed::parsed_module; +use ruff_db::source::{SourceText, line_index, source_text}; +use ruff_python_trivia::{CommentRanges, Cursor}; +use ruff_source_file::{LineIndex, OneIndexed}; +use ruff_text_size::{Ranged, TextLen, TextRange, TextSize}; +use smallvec::SmallVec; +use std::ops::Deref; +use std::str::FromStr; + +/// Diagnostic assertion comments in a single embedded file. +#[derive(Debug)] +pub(crate) struct InlineFileAssertions { + comment_ranges: CommentRanges, + source: SourceText, + lines: LineIndex, +} + +impl InlineFileAssertions { + pub(crate) fn from_file(db: &Db, file: File) -> Self { + let source = source_text(db, file); + let lines = line_index(db, file); + let parsed = parsed_module(db, file); + let comment_ranges = CommentRanges::from(parsed.tokens()); + Self { + comment_ranges, + source, + lines, + } + } + + fn line_number(&self, range: &impl Ranged) -> OneIndexed { + self.lines.line_index(range.start()) + } + + fn is_own_line_comment(&self, ranged_assertion: &AssertionWithRange) -> bool { + CommentRanges::is_own_line(ranged_assertion.start(), self.source.as_str()) + } +} + +impl<'a> IntoIterator for &'a InlineFileAssertions { + type Item = LineAssertions<'a>; + type IntoIter = LineAssertionsIterator<'a>; + + fn into_iter(self) -> Self::IntoIter { + Self::IntoIter { + file_assertions: self, + inner: AssertionWithRangeIterator { + file_assertions: self, + inner: self.comment_ranges.into_iter(), + } + .peekable(), + } + } +} + +/// An [`UnparsedAssertion`] with the [`TextRange`] of its original inline comment. +#[derive(Debug)] +struct AssertionWithRange<'a>(UnparsedAssertion<'a>, TextRange); + +impl<'a> Deref for AssertionWithRange<'a> { + type Target = UnparsedAssertion<'a>; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl Ranged for AssertionWithRange<'_> { + fn range(&self) -> TextRange { + self.1 + } +} + +impl<'a> From<AssertionWithRange<'a>> for UnparsedAssertion<'a> { + fn from(value: AssertionWithRange<'a>) -> Self { + value.0 + } +} + +/// Iterator that yields all assertions within a single embedded Python file. +#[derive(Debug)] +struct AssertionWithRangeIterator<'a> { + file_assertions: &'a InlineFileAssertions, + inner: std::iter::Copied<std::slice::Iter<'a, TextRange>>, +} + +impl<'a> Iterator for AssertionWithRangeIterator<'a> { + type Item = AssertionWithRange<'a>; + + fn next(&mut self) -> Option<Self::Item> { + loop { + let inner_next = self.inner.next()?; + let comment = &self.file_assertions.source[inner_next]; + if let Some(assertion) = UnparsedAssertion::from_comment(comment) { + return Some(AssertionWithRange(assertion, inner_next)); + } + } + } +} + +impl std::iter::FusedIterator for AssertionWithRangeIterator<'_> {} + +/// A vector of [`UnparsedAssertion`]s belonging to a single line. +/// +/// Most lines will have zero or one assertion, so we use a [`SmallVec`] optimized for a single +/// element to avoid most heap vector allocations. +type AssertionVec<'a> = SmallVec<[UnparsedAssertion<'a>; 1]>; + +#[derive(Debug)] +pub(crate) struct LineAssertionsIterator<'a> { + file_assertions: &'a InlineFileAssertions, + inner: std::iter::Peekable<AssertionWithRangeIterator<'a>>, +} + +impl<'a> Iterator for LineAssertionsIterator<'a> { + type Item = LineAssertions<'a>; + + fn next(&mut self) -> Option<Self::Item> { + let file = self.file_assertions; + let ranged_assertion = self.inner.next()?; + let mut collector = AssertionVec::new(); + let mut line_number = file.line_number(&ranged_assertion); + // Collect all own-line comments on consecutive lines; these all apply to the same line of + // code. For example: + // + // ```py + // # error: [unbound-name] + // # revealed: Unbound + // reveal_type(x) + // ``` + // + if file.is_own_line_comment(&ranged_assertion) { + collector.push(ranged_assertion.into()); + let mut only_own_line = true; + while let Some(ranged_assertion) = self.inner.peek() { + let next_line_number = line_number.saturating_add(1); + if file.line_number(ranged_assertion) == next_line_number { + if !file.is_own_line_comment(ranged_assertion) { + only_own_line = false; + } + line_number = next_line_number; + collector.push(self.inner.next().unwrap().into()); + // If we see an end-of-line comment, it has to be the end of the stack, + // otherwise we'd botch this case, attributing all three errors to the `bar` + // line: + // + // ```py + // # error: + // foo # error: + // bar # error: + // ``` + // + if !only_own_line { + break; + } + } else { + break; + } + } + if only_own_line { + // The collected comments apply to the _next_ line in the code. + line_number = line_number.saturating_add(1); + } + } else { + // We have a line-trailing comment; it applies to its own line, and is not grouped. + collector.push(ranged_assertion.into()); + } + Some(LineAssertions { + line_number, + assertions: collector, + }) + } +} + +impl std::iter::FusedIterator for LineAssertionsIterator<'_> {} + +/// One or more assertions referring to the same line of code. +#[derive(Debug)] +pub(crate) struct LineAssertions<'a> { + /// The line these assertions refer to. + /// + /// Not necessarily the same line the assertion comment is located on; for an own-line comment, + /// it's the next non-assertion line. + pub(crate) line_number: OneIndexed, + + /// The assertions referring to this line. + pub(crate) assertions: AssertionVec<'a>, +} + +impl<'a> Deref for LineAssertions<'a> { + type Target = [UnparsedAssertion<'a>]; + + fn deref(&self) -> &Self::Target { + &self.assertions + } +} + +/// A single diagnostic assertion comment. +/// +/// This type represents an *attempted* assertion, but not necessarily a *valid* assertion. +/// Parsing is done lazily in `matcher.rs`; this allows us to emit nicer error messages +/// in the event of an invalid assertion +#[derive(Debug)] +pub(crate) enum UnparsedAssertion<'a> { + /// A `# revealed:` assertion. + Revealed(&'a str), + + /// An `# error:` assertion. + Error(&'a str), +} + +impl<'a> UnparsedAssertion<'a> { + /// Returns `Some(_)` if the comment starts with `# error:` or `# revealed:`, + /// indicating that it is an assertion comment. + fn from_comment(comment: &'a str) -> Option<Self> { + let comment = comment.trim().strip_prefix('#')?.trim(); + let (keyword, body) = comment.split_once(':')?; + let keyword = keyword.trim(); + let body = body.trim(); + + match keyword { + "revealed" => Some(Self::Revealed(body)), + "error" => Some(Self::Error(body)), + _ => None, + } + } + + /// Parse the attempted assertion into a [`ParsedAssertion`] structured representation. + pub(crate) fn parse(&self) -> Result<ParsedAssertion<'a>, PragmaParseError<'a>> { + match self { + Self::Revealed(revealed) => { + if revealed.is_empty() { + Err(PragmaParseError::EmptyRevealTypeAssertion) + } else { + Ok(ParsedAssertion::Revealed(revealed)) + } + } + Self::Error(error) => ErrorAssertion::from_str(error) + .map(ParsedAssertion::Error) + .map_err(PragmaParseError::ErrorAssertionParseError), + } + } +} + +impl std::fmt::Display for UnparsedAssertion<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Revealed(expected_type) => write!(f, "revealed: {expected_type}"), + Self::Error(assertion) => write!(f, "error: {assertion}"), + } + } +} + +/// An assertion comment that has been parsed and validated for correctness. +#[derive(Debug)] +pub(crate) enum ParsedAssertion<'a> { + /// A `# revealed:` assertion. + Revealed(&'a str), + + /// An `# error:` assertion. + Error(ErrorAssertion<'a>), +} + +impl std::fmt::Display for ParsedAssertion<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Revealed(expected_type) => write!(f, "revealed: {expected_type}"), + Self::Error(assertion) => assertion.fmt(f), + } + } +} + +/// A parsed and validated `# error:` assertion comment. +#[derive(Debug)] +pub(crate) struct ErrorAssertion<'a> { + /// The diagnostic rule code we expect. + pub(crate) rule: Option<&'a str>, + + /// The column we expect the diagnostic range to start at. + pub(crate) column: Option<OneIndexed>, + + /// A string we expect to be contained in the diagnostic message. + pub(crate) message_contains: Option<&'a str>, +} + +impl<'a> ErrorAssertion<'a> { + fn from_str(source: &'a str) -> Result<Self, ErrorAssertionParseError<'a>> { + ErrorAssertionParser::new(source).parse() + } +} + +impl std::fmt::Display for ErrorAssertion<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("error:")?; + if let Some(column) = self.column { + write!(f, " {column}")?; + } + if let Some(rule) = self.rule { + write!(f, " [{rule}]")?; + } + if let Some(message) = self.message_contains { + write!(f, r#" "{message}""#)?; + } + Ok(()) + } +} + +/// A parser to convert a string into a [`ErrorAssertion`]. +#[derive(Debug, Clone)] +struct ErrorAssertionParser<'a> { + cursor: Cursor<'a>, + + /// string slice representing all characters *after* the `# error:` prefix. + comment_source: &'a str, +} + +impl<'a> ErrorAssertionParser<'a> { + fn new(comment: &'a str) -> Self { + Self { + cursor: Cursor::new(comment), + comment_source: comment, + } + } + + /// Retrieves the current offset of the cursor within the source code. + fn offset(&self) -> TextSize { + self.comment_source.text_len() - self.cursor.text_len() + } + + /// Consume characters in the assertion comment until we find a non-whitespace character + fn skip_whitespace(&mut self) { + self.cursor.eat_while(char::is_whitespace); + } + + /// Attempt to parse the assertion comment into a [`ErrorAssertion`]. + fn parse(mut self) -> Result<ErrorAssertion<'a>, ErrorAssertionParseError<'a>> { + let mut column = None; + let mut rule = None; + + self.skip_whitespace(); + + while let Some(character) = self.cursor.bump() { + match character { + // column number + '0'..='9' => { + if column.is_some() { + return Err(ErrorAssertionParseError::MultipleColumnNumbers); + } + if rule.is_some() { + return Err(ErrorAssertionParseError::ColumnNumberAfterRuleCode); + } + let offset = self.offset() - TextSize::new(1); + self.cursor.eat_while(|c| !c.is_whitespace()); + let column_str = &self.comment_source[TextRange::new(offset, self.offset())]; + column = OneIndexed::from_str(column_str) + .map(Some) + .map_err(|e| ErrorAssertionParseError::BadColumnNumber(column_str, e))?; + } + + // rule code + '[' => { + if rule.is_some() { + return Err(ErrorAssertionParseError::MultipleRuleCodes); + } + let offset = self.offset(); + self.cursor.eat_while(|c| c != ']'); + if self.cursor.is_eof() { + return Err(ErrorAssertionParseError::UnclosedRuleCode); + } + rule = Some(self.comment_source[TextRange::new(offset, self.offset())].trim()); + self.cursor.bump(); + } + + // message text + '"' => { + let comment_source = self.comment_source.trim(); + return if comment_source.ends_with('"') { + let rest = + &comment_source[self.offset().to_usize()..comment_source.len() - 1]; + Ok(ErrorAssertion { + rule, + column, + message_contains: Some(rest), + }) + } else { + Err(ErrorAssertionParseError::UnclosedMessage) + }; + } + + // Some other assumptions we make don't hold true if we hit this branch: + '\n' | '\r' => { + unreachable!("Assertion comments should never contain newlines") + } + + // something else (bad!)... + unexpected => { + return Err(ErrorAssertionParseError::UnexpectedCharacter { + character: unexpected, + offset: self.offset().to_usize(), + }); + } + } + + self.skip_whitespace(); + } + + if rule.is_some() { + Ok(ErrorAssertion { + rule, + column, + message_contains: None, + }) + } else { + Err(ErrorAssertionParseError::NoRuleOrMessage) + } + } +} + +/// Enumeration of ways in which parsing an assertion comment can fail. +/// +/// The assertion comment could be either a "revealed" assertion or an "error" assertion. +#[derive(Debug, thiserror::Error)] +pub(crate) enum PragmaParseError<'a> { + #[error("Must specify which type should be revealed")] + EmptyRevealTypeAssertion, + #[error("{0}")] + ErrorAssertionParseError(ErrorAssertionParseError<'a>), +} + +/// Enumeration of ways in which parsing an *error* assertion comment can fail. +#[derive(Debug, thiserror::Error)] +pub(crate) enum ErrorAssertionParseError<'a> { + #[error("no rule or message text")] + NoRuleOrMessage, + #[error("bad column number `{0}`")] + BadColumnNumber(&'a str, #[source] std::num::ParseIntError), + #[error("column number must precede the rule code")] + ColumnNumberAfterRuleCode, + #[error("multiple column numbers in one assertion")] + MultipleColumnNumbers, + #[error("expected ']' to close rule code")] + UnclosedRuleCode, + #[error("cannot use multiple rule codes in one assertion")] + MultipleRuleCodes, + #[error("expected '\"' to be the final character in an assertion with an error message")] + UnclosedMessage, + #[error( + "unexpected character `{character}` at offset {offset} (relative to the `:` in the assertion comment)" + )] + UnexpectedCharacter { character: char, offset: usize }, +} + +#[cfg(test)] +mod tests { + use super::*; + use ruff_db::files::system_path_to_file; + use ruff_db::system::DbWithWritableSystem as _; + use ruff_python_trivia::textwrap::dedent; + use ruff_source_file::OneIndexed; + use ty_python_semantic::{ + Program, ProgramSettings, PythonPlatform, PythonVersionWithSource, SearchPathSettings, + }; + + fn get_assertions(source: &str) -> InlineFileAssertions { + let mut db = Db::setup(); + + let settings = ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings::new(Vec::new()), + }; + match Program::try_get(&db) { + Some(program) => program.update_from_settings(&mut db, settings), + None => Program::from_settings(&db, settings).map(|_| ()), + } + .expect("Failed to update Program settings in TestDb"); + + db.write_file("/src/test.py", source).unwrap(); + let file = system_path_to_file(&db, "/src/test.py").unwrap(); + InlineFileAssertions::from_file(&db, file) + } + + fn as_vec(assertions: &InlineFileAssertions) -> Vec<LineAssertions> { + assertions.into_iter().collect() + } + + #[test] + fn ty_display() { + let assertions = get_assertions(&dedent( + " + reveal_type(1) # revealed: Literal[1] + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), "revealed: Literal[1]"); + } + + #[test] + fn error() { + let assertions = get_assertions(&dedent( + " + x # error: + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), "error: "); + } + + #[test] + fn prior_line() { + let assertions = get_assertions(&dedent( + " + # revealed: Literal[1] + reveal_type(1) + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), "revealed: Literal[1]"); + } + + #[test] + fn stacked_prior_line() { + let assertions = get_assertions(&dedent( + " + # revealed: Unbound + # error: [unbound-name] + reveal_type(x) + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(3)); + + let [assert1, assert2] = &line.assertions[..] else { + panic!("expected two assertions"); + }; + + assert_eq!(format!("{assert1}"), "revealed: Unbound"); + assert_eq!(format!("{assert2}"), "error: [unbound-name]"); + } + + #[test] + fn stacked_mixed() { + let assertions = get_assertions(&dedent( + " + # revealed: Unbound + reveal_type(x) # error: [unbound-name] + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); + + let [assert1, assert2] = &line.assertions[..] else { + panic!("expected two assertions"); + }; + + assert_eq!(format!("{assert1}"), "revealed: Unbound"); + assert_eq!(format!("{assert2}"), "error: [unbound-name]"); + } + + #[test] + fn multiple_lines() { + let assertions = get_assertions(&dedent( + r#" + # error: [invalid-assignment] + x: int = "foo" + y # error: [unbound-name] + "#, + )); + + let [line1, line2] = &as_vec(&assertions)[..] else { + panic!("expected two lines"); + }; + + assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(2)); + assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(3)); + + let [UnparsedAssertion::Error(error1)] = &line1.assertions[..] else { + panic!("expected one error assertion"); + }; + + let error1 = ErrorAssertion::from_str(error1).unwrap(); + + assert_eq!(error1.rule, Some("invalid-assignment")); + + let [UnparsedAssertion::Error(error2)] = &line2.assertions[..] else { + panic!("expected one error assertion"); + }; + + let error2 = ErrorAssertion::from_str(error2).unwrap(); + + assert_eq!(error2.rule, Some("unbound-name")); + } + + #[test] + fn multiple_lines_mixed_stack() { + let assertions = get_assertions(&dedent( + r#" + # error: [invalid-assignment] + x: int = reveal_type("foo") # revealed: str + y # error: [unbound-name] + "#, + )); + + let [line1, line2] = &as_vec(&assertions)[..] else { + panic!("expected two lines"); + }; + + assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(2)); + assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(3)); + + let [ + UnparsedAssertion::Error(error1), + UnparsedAssertion::Revealed(expected_ty), + ] = &line1.assertions[..] + else { + panic!("expected one error assertion and one Revealed assertion"); + }; + + let error1 = ErrorAssertion::from_str(error1).unwrap(); + + assert_eq!(error1.rule, Some("invalid-assignment")); + assert_eq!(expected_ty.trim(), "str"); + + let [UnparsedAssertion::Error(error2)] = &line2.assertions[..] else { + panic!("expected one error assertion"); + }; + + let error2 = ErrorAssertion::from_str(error2).unwrap(); + + assert_eq!(error2.rule, Some("unbound-name")); + } + + #[test] + fn error_with_rule() { + let assertions = get_assertions(&dedent( + " + x # error: [unbound-name] + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), "error: [unbound-name]"); + } + + #[test] + fn error_with_rule_and_column() { + let assertions = get_assertions(&dedent( + " + x # error: 1 [unbound-name] + ", + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(1)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), "error: 1 [unbound-name]"); + } + + #[test] + fn error_with_rule_and_message() { + let assertions = get_assertions(&dedent( + r#" + # error: [unbound-name] "`x` is unbound" + x + "#, + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!( + format!("{assert}"), + r#"error: [unbound-name] "`x` is unbound""# + ); + } + + #[test] + fn error_with_message_and_column() { + let assertions = get_assertions(&dedent( + r#" + # error: 1 "`x` is unbound" + x + "#, + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!(format!("{assert}"), r#"error: 1 "`x` is unbound""#); + } + + #[test] + fn error_with_rule_and_message_and_column() { + let assertions = get_assertions(&dedent( + r#" + # error: 1 [unbound-name] "`x` is unbound" + x + "#, + )); + + let [line] = &as_vec(&assertions)[..] else { + panic!("expected one line"); + }; + + assert_eq!(line.line_number, OneIndexed::from_zero_indexed(2)); + + let [assert] = &line.assertions[..] else { + panic!("expected one assertion"); + }; + + assert_eq!( + format!("{assert}"), + r#"error: 1 [unbound-name] "`x` is unbound""# + ); + } +} diff --git a/crates/ty_test/src/config.rs b/crates/ty_test/src/config.rs new file mode 100644 index 0000000000000..316a3e502692e --- /dev/null +++ b/crates/ty_test/src/config.rs @@ -0,0 +1,118 @@ +//! TOML-deserializable ty configuration, similar to `ty.toml`, to be able to +//! control some configuration options from Markdown files. For now, this supports the +//! following limited structure: +//! +//! ```toml +//! log = true # or log = "ty=WARN" +//! [environment] +//! python-version = "3.10" +//! ``` + +use anyhow::Context; +use ruff_db::system::{SystemPath, SystemPathBuf}; +use ruff_python_ast::PythonVersion; +use serde::{Deserialize, Serialize}; +use ty_python_semantic::PythonPlatform; + +#[derive(Deserialize, Debug, Default, Clone)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +pub(crate) struct MarkdownTestConfig { + pub(crate) environment: Option<Environment>, + + pub(crate) log: Option<Log>, + + /// The [`ruff_db::system::System`] to use for tests. + /// + /// Defaults to the case-sensitive [`ruff_db::system::InMemorySystem`]. + pub(crate) system: Option<SystemKind>, +} + +impl MarkdownTestConfig { + pub(crate) fn from_str(s: &str) -> anyhow::Result<Self> { + toml::from_str(s).context("Error while parsing Markdown TOML config") + } + + pub(crate) fn python_version(&self) -> Option<PythonVersion> { + self.environment.as_ref()?.python_version + } + + pub(crate) fn python_platform(&self) -> Option<PythonPlatform> { + self.environment.as_ref()?.python_platform.clone() + } + + pub(crate) fn typeshed(&self) -> Option<&SystemPath> { + self.environment.as_ref()?.typeshed.as_deref() + } + + pub(crate) fn extra_paths(&self) -> Option<&[SystemPathBuf]> { + self.environment.as_ref()?.extra_paths.as_deref() + } + + pub(crate) fn python(&self) -> Option<&SystemPath> { + self.environment.as_ref()?.python.as_deref() + } +} + +#[derive(Deserialize, Debug, Default, Clone)] +#[serde(rename_all = "kebab-case", deny_unknown_fields)] +pub(crate) struct Environment { + /// Target Python version to assume when resolving types. + /// + /// The Python version affects allowed syntax, type definitions of the standard library, and + /// type definitions of first- and third-party modules that are conditional on the Python version. + /// + /// By default, the Python version is inferred as the lower bound of the project's + /// `requires-python` field from the `pyproject.toml`, if available. Otherwise, the latest + /// stable version supported by ty is used, which is currently 3.13. + /// + /// ty will not infer the Python version from the Python environment at this time. + pub(crate) python_version: Option<PythonVersion>, + + /// Target platform to assume when resolving types. + pub(crate) python_platform: Option<PythonPlatform>, + + /// Path to a custom typeshed directory. + pub(crate) typeshed: Option<SystemPathBuf>, + + /// Additional search paths to consider when resolving modules. + pub(crate) extra_paths: Option<Vec<SystemPathBuf>>, + + /// Path to the Python environment. + /// + /// ty uses the Python environment to resolve type information and third-party dependencies. + /// + /// If a path to a Python interpreter is provided, e.g., `.venv/bin/python3`, ty will attempt to + /// find an environment two directories up from the interpreter's path, e.g., `.venv`. At this + /// time, ty does not invoke the interpreter to determine the location of the environment. This + /// means that ty will not resolve dynamic executables such as a shim. + /// + /// ty will search in the resolved environment's `site-packages` directories for type + /// information and third-party imports. + #[serde(skip_serializing_if = "Option::is_none")] + pub python: Option<SystemPathBuf>, +} + +#[derive(Deserialize, Debug, Clone)] +#[serde(untagged)] +pub(crate) enum Log { + /// Enable logging with tracing when `true`. + Bool(bool), + /// Enable logging and only show filters that match the given [env-filter](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) + Filter(String), +} + +/// The system to use for tests. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize, Serialize, Default)] +#[serde(rename_all = "kebab-case")] +pub(crate) enum SystemKind { + /// Use an in-memory system with a case sensitive file system.. + /// + /// This is recommended for all tests because it's fast. + #[default] + InMemory, + + /// Use the os system. + /// + /// This system should only be used when testing system or OS specific behavior. + Os, +} diff --git a/crates/ty_test/src/db.rs b/crates/ty_test/src/db.rs new file mode 100644 index 0000000000000..348d61aa04717 --- /dev/null +++ b/crates/ty_test/src/db.rs @@ -0,0 +1,284 @@ +use camino::{Utf8Component, Utf8PathBuf}; +use ruff_db::diagnostic::Severity; +use ruff_db::files::{File, Files}; +use ruff_db::system::{ + CaseSensitivity, DbWithWritableSystem, InMemorySystem, OsSystem, System, SystemPath, + SystemPathBuf, WritableSystem, +}; +use ruff_db::vendored::VendoredFileSystem; +use ruff_db::{Db as SourceDb, Upcast}; +use ruff_notebook::{Notebook, NotebookError}; +use std::borrow::Cow; +use std::sync::Arc; +use tempfile::TempDir; +use ty_python_semantic::lint::{LintRegistry, RuleSelection}; +use ty_python_semantic::{Db as SemanticDb, Program, default_lint_registry}; + +#[salsa::db] +#[derive(Clone)] +pub(crate) struct Db { + storage: salsa::Storage<Self>, + files: Files, + system: MdtestSystem, + vendored: VendoredFileSystem, + rule_selection: Arc<RuleSelection>, +} + +impl Db { + pub(crate) fn setup() -> Self { + let rule_selection = RuleSelection::all(default_lint_registry(), Severity::Info); + + Self { + system: MdtestSystem::in_memory(), + storage: salsa::Storage::new(Some(Box::new({ + move |event| { + tracing::trace!("event: {:?}", event); + } + }))), + vendored: ty_vendored::file_system().clone(), + files: Files::default(), + rule_selection: Arc::new(rule_selection), + } + } + + pub(crate) fn use_os_system_with_temp_dir(&mut self, cwd: SystemPathBuf, temp_dir: TempDir) { + self.system.with_os(cwd, temp_dir); + Files::sync_all(self); + } + + pub(crate) fn use_in_memory_system(&mut self) { + self.system.with_in_memory(); + Files::sync_all(self); + } + + pub(crate) fn create_directory_all(&self, path: &SystemPath) -> ruff_db::system::Result<()> { + self.system.create_directory_all(path) + } +} + +#[salsa::db] +impl SourceDb for Db { + fn vendored(&self) -> &VendoredFileSystem { + &self.vendored + } + + fn system(&self) -> &dyn System { + &self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> ruff_python_ast::PythonVersion { + Program::get(self).python_version(self) + } +} + +impl Upcast<dyn SourceDb> for Db { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } +} + +#[salsa::db] +impl SemanticDb for Db { + fn is_file_open(&self, file: File) -> bool { + !file.path(self).is_vendored_path() + } + + fn rule_selection(&self) -> &RuleSelection { + &self.rule_selection + } + + fn lint_registry(&self) -> &LintRegistry { + default_lint_registry() + } +} + +#[salsa::db] +impl salsa::Database for Db {} + +impl DbWithWritableSystem for Db { + type System = MdtestSystem; + fn writable_system(&self) -> &Self::System { + &self.system + } +} + +#[derive(Debug, Clone)] +pub(crate) struct MdtestSystem(Arc<MdtestSystemInner>); + +#[derive(Debug)] +enum MdtestSystemInner { + InMemory(InMemorySystem), + Os { + os_system: OsSystem, + _temp_dir: TempDir, + }, +} + +impl MdtestSystem { + fn in_memory() -> Self { + Self(Arc::new(MdtestSystemInner::InMemory( + InMemorySystem::default(), + ))) + } + + fn as_system(&self) -> &dyn WritableSystem { + match &*self.0 { + MdtestSystemInner::InMemory(system) => system, + MdtestSystemInner::Os { os_system, .. } => os_system, + } + } + + fn with_os(&mut self, cwd: SystemPathBuf, temp_dir: TempDir) { + self.0 = Arc::new(MdtestSystemInner::Os { + os_system: OsSystem::new(cwd), + _temp_dir: temp_dir, + }); + } + + fn with_in_memory(&mut self) { + if let MdtestSystemInner::InMemory(in_memory) = &*self.0 { + in_memory.fs().remove_all(); + } else { + self.0 = Arc::new(MdtestSystemInner::InMemory(InMemorySystem::default())); + } + } + + fn normalize_path<'a>(&self, path: &'a SystemPath) -> Cow<'a, SystemPath> { + match &*self.0 { + MdtestSystemInner::InMemory(_) => Cow::Borrowed(path), + MdtestSystemInner::Os { os_system, .. } => { + // Make all paths relative to the current directory + // to avoid writing or reading from outside the temp directory. + let without_root: Utf8PathBuf = path + .components() + .skip_while(|component| { + matches!( + component, + Utf8Component::RootDir | Utf8Component::Prefix(..) + ) + }) + .collect(); + Cow::Owned(os_system.current_directory().join(&without_root)) + } + } + } +} + +impl System for MdtestSystem { + fn path_metadata( + &self, + path: &SystemPath, + ) -> ruff_db::system::Result<ruff_db::system::Metadata> { + self.as_system().path_metadata(&self.normalize_path(path)) + } + + fn canonicalize_path(&self, path: &SystemPath) -> ruff_db::system::Result<SystemPathBuf> { + let canonicalized = self + .as_system() + .canonicalize_path(&self.normalize_path(path))?; + + if let MdtestSystemInner::Os { os_system, .. } = &*self.0 { + // Make the path relative to the current directory + Ok(canonicalized + .strip_prefix(os_system.current_directory()) + .unwrap() + .to_owned()) + } else { + Ok(canonicalized) + } + } + + fn read_to_string(&self, path: &SystemPath) -> ruff_db::system::Result<String> { + self.as_system().read_to_string(&self.normalize_path(path)) + } + + fn read_to_notebook(&self, path: &SystemPath) -> Result<Notebook, NotebookError> { + self.as_system() + .read_to_notebook(&self.normalize_path(path)) + } + + fn read_virtual_path_to_string( + &self, + path: &ruff_db::system::SystemVirtualPath, + ) -> ruff_db::system::Result<String> { + self.as_system().read_virtual_path_to_string(path) + } + + fn read_virtual_path_to_notebook( + &self, + path: &ruff_db::system::SystemVirtualPath, + ) -> Result<Notebook, NotebookError> { + self.as_system().read_virtual_path_to_notebook(path) + } + + fn path_exists_case_sensitive(&self, path: &SystemPath, prefix: &SystemPath) -> bool { + self.as_system() + .path_exists_case_sensitive(&self.normalize_path(path), &self.normalize_path(prefix)) + } + + fn case_sensitivity(&self) -> CaseSensitivity { + self.as_system().case_sensitivity() + } + + fn current_directory(&self) -> &SystemPath { + self.as_system().current_directory() + } + + fn user_config_directory(&self) -> Option<SystemPathBuf> { + self.as_system().user_config_directory() + } + + fn read_directory<'a>( + &'a self, + path: &SystemPath, + ) -> ruff_db::system::Result< + Box<dyn Iterator<Item = ruff_db::system::Result<ruff_db::system::DirectoryEntry>> + 'a>, + > { + self.as_system().read_directory(&self.normalize_path(path)) + } + + fn walk_directory( + &self, + path: &SystemPath, + ) -> ruff_db::system::walk_directory::WalkDirectoryBuilder { + self.as_system().walk_directory(&self.normalize_path(path)) + } + + fn glob( + &self, + pattern: &str, + ) -> Result< + Box<dyn Iterator<Item = Result<SystemPathBuf, ruff_db::system::GlobError>> + '_>, + ruff_db::system::PatternError, + > { + self.as_system() + .glob(self.normalize_path(SystemPath::new(pattern)).as_str()) + } + + fn as_any(&self) -> &dyn std::any::Any { + self + } + + fn as_any_mut(&mut self) -> &mut dyn std::any::Any { + self + } +} + +impl WritableSystem for MdtestSystem { + fn write_file(&self, path: &SystemPath, content: &str) -> ruff_db::system::Result<()> { + self.as_system() + .write_file(&self.normalize_path(path), content) + } + + fn create_directory_all(&self, path: &SystemPath) -> ruff_db::system::Result<()> { + self.as_system() + .create_directory_all(&self.normalize_path(path)) + } +} diff --git a/crates/ty_test/src/diagnostic.rs b/crates/ty_test/src/diagnostic.rs new file mode 100644 index 0000000000000..f869f999ab0cb --- /dev/null +++ b/crates/ty_test/src/diagnostic.rs @@ -0,0 +1,190 @@ +//! Sort and group diagnostics by line number, so they can be correlated with assertions. +//! +//! We don't assume that we will get the diagnostics in source order. + +use ruff_db::diagnostic::Diagnostic; +use ruff_source_file::{LineIndex, OneIndexed}; +use std::ops::{Deref, Range}; + +/// All diagnostics for one embedded Python file, sorted and grouped by start line number. +/// +/// The diagnostics are kept in a flat vector, sorted by line number. A separate vector of +/// [`LineDiagnosticRange`] has one entry for each contiguous slice of the diagnostics vector +/// containing diagnostics which all start on the same line. +#[derive(Debug)] +pub(crate) struct SortedDiagnostics<'a> { + diagnostics: Vec<&'a Diagnostic>, + line_ranges: Vec<LineDiagnosticRange>, +} + +impl<'a> SortedDiagnostics<'a> { + pub(crate) fn new( + diagnostics: impl IntoIterator<Item = &'a Diagnostic>, + line_index: &LineIndex, + ) -> Self { + let mut diagnostics: Vec<_> = diagnostics + .into_iter() + .map(|diagnostic| DiagnosticWithLine { + line_number: diagnostic + .primary_span() + .and_then(|span| span.range()) + .map_or(OneIndexed::from_zero_indexed(0), |range| { + line_index.line_index(range.start()) + }), + diagnostic, + }) + .collect(); + diagnostics.sort_unstable_by_key(|diagnostic_with_line| diagnostic_with_line.line_number); + + let mut diags = Self { + diagnostics: Vec::with_capacity(diagnostics.len()), + line_ranges: vec![], + }; + + let mut current_line_number = None; + let mut start = 0; + for DiagnosticWithLine { + line_number, + diagnostic, + } in diagnostics + { + match current_line_number { + None => { + current_line_number = Some(line_number); + } + Some(current) => { + if line_number != current { + let end = diags.diagnostics.len(); + diags.line_ranges.push(LineDiagnosticRange { + line_number: current, + diagnostic_index_range: start..end, + }); + start = end; + current_line_number = Some(line_number); + } + } + } + diags.diagnostics.push(diagnostic); + } + if let Some(line_number) = current_line_number { + diags.line_ranges.push(LineDiagnosticRange { + line_number, + diagnostic_index_range: start..diags.diagnostics.len(), + }); + } + + diags + } + + pub(crate) fn iter_lines(&self) -> LineDiagnosticsIterator<'_> { + LineDiagnosticsIterator { + diagnostics: self.diagnostics.as_slice(), + inner: self.line_ranges.iter(), + } + } +} + +/// Range delineating diagnostics in [`SortedDiagnostics`] that begin on a single line. +#[derive(Debug)] +struct LineDiagnosticRange { + line_number: OneIndexed, + diagnostic_index_range: Range<usize>, +} + +/// Iterator to group sorted diagnostics by line. +pub(crate) struct LineDiagnosticsIterator<'a> { + diagnostics: &'a [&'a Diagnostic], + inner: std::slice::Iter<'a, LineDiagnosticRange>, +} + +impl<'a> Iterator for LineDiagnosticsIterator<'a> { + type Item = LineDiagnostics<'a>; + + fn next(&mut self) -> Option<Self::Item> { + let LineDiagnosticRange { + line_number, + diagnostic_index_range, + } = self.inner.next()?; + Some(LineDiagnostics { + line_number: *line_number, + diagnostics: &self.diagnostics[diagnostic_index_range.clone()], + }) + } +} + +impl std::iter::FusedIterator for LineDiagnosticsIterator<'_> {} + +/// All diagnostics that start on a single line of source code in one embedded Python file. +#[derive(Debug)] +pub(crate) struct LineDiagnostics<'a> { + /// Line number on which these diagnostics start. + pub(crate) line_number: OneIndexed, + + /// Diagnostics starting on this line. + pub(crate) diagnostics: &'a [&'a Diagnostic], +} + +impl<'a> Deref for LineDiagnostics<'a> { + type Target = [&'a Diagnostic]; + + fn deref(&self) -> &Self::Target { + self.diagnostics + } +} + +#[derive(Debug)] +struct DiagnosticWithLine<'a> { + line_number: OneIndexed, + diagnostic: &'a Diagnostic, +} + +#[cfg(test)] +mod tests { + use crate::db::Db; + use ruff_db::diagnostic::{Annotation, Diagnostic, DiagnosticId, LintName, Severity, Span}; + use ruff_db::files::system_path_to_file; + use ruff_db::source::line_index; + use ruff_db::system::DbWithWritableSystem as _; + use ruff_source_file::OneIndexed; + use ruff_text_size::{TextRange, TextSize}; + + #[test] + fn sort_and_group() { + let mut db = Db::setup(); + db.write_file("/src/test.py", "one\ntwo\n").unwrap(); + let file = system_path_to_file(&db, "/src/test.py").unwrap(); + let lines = line_index(&db, file); + + let ranges = [ + TextRange::new(TextSize::new(0), TextSize::new(1)), + TextRange::new(TextSize::new(5), TextSize::new(10)), + TextRange::new(TextSize::new(1), TextSize::new(7)), + ]; + + let diagnostics: Vec<_> = ranges + .into_iter() + .map(|range| { + let mut diag = Diagnostic::new( + DiagnosticId::Lint(LintName::of("dummy")), + Severity::Error, + "dummy", + ); + let span = Span::from(file).with_range(range); + diag.annotate(Annotation::primary(span)); + diag + }) + .collect(); + + let sorted = super::SortedDiagnostics::new(diagnostics.iter(), &lines); + let grouped = sorted.iter_lines().collect::<Vec<_>>(); + + let [line1, line2] = &grouped[..] else { + panic!("expected two lines"); + }; + + assert_eq!(line1.line_number, OneIndexed::from_zero_indexed(0)); + assert_eq!(line1.diagnostics.len(), 2); + assert_eq!(line2.line_number, OneIndexed::from_zero_indexed(1)); + assert_eq!(line2.diagnostics.len(), 1); + } +} diff --git a/crates/ty_test/src/lib.rs b/crates/ty_test/src/lib.rs new file mode 100644 index 0000000000000..8375bf2046151 --- /dev/null +++ b/crates/ty_test/src/lib.rs @@ -0,0 +1,467 @@ +use crate::config::Log; +use crate::parser::{BacktickOffsets, EmbeddedFileSourceMap}; +use camino::Utf8Path; +use colored::Colorize; +use config::SystemKind; +use parser as test_parser; +use ruff_db::Upcast; +use ruff_db::diagnostic::{ + Diagnostic, DisplayDiagnosticConfig, create_parse_diagnostic, + create_unsupported_syntax_diagnostic, +}; +use ruff_db::files::{File, system_path_to_file}; +use ruff_db::panic::catch_unwind; +use ruff_db::parsed::parsed_module; +use ruff_db::system::{DbWithWritableSystem as _, SystemPath, SystemPathBuf}; +use ruff_db::testing::{setup_logging, setup_logging_with_filter}; +use ruff_source_file::{LineIndex, OneIndexed}; +use std::backtrace::BacktraceStatus; +use std::fmt::Write; +use ty_python_semantic::types::check_types; +use ty_python_semantic::{ + Program, ProgramSettings, PythonPath, PythonPlatform, PythonVersionSource, + PythonVersionWithSource, SearchPathSettings, SysPrefixPathOrigin, +}; + +mod assertion; +mod config; +mod db; +mod diagnostic; +mod matcher; +mod parser; + +const MDTEST_TEST_FILTER: &str = "MDTEST_TEST_FILTER"; + +/// Run `path` as a markdown test suite with given `title`. +/// +/// Panic on test failure, and print failure details. +#[expect(clippy::print_stdout)] +pub fn run( + absolute_fixture_path: &Utf8Path, + relative_fixture_path: &Utf8Path, + snapshot_path: &Utf8Path, + short_title: &str, + test_name: &str, + output_format: OutputFormat, +) { + let source = std::fs::read_to_string(absolute_fixture_path).unwrap(); + let suite = match test_parser::parse(short_title, &source) { + Ok(suite) => suite, + Err(err) => { + panic!("Error parsing `{absolute_fixture_path}`: {err:?}") + } + }; + + let mut db = db::Db::setup(); + + let filter = std::env::var(MDTEST_TEST_FILTER).ok(); + let mut any_failures = false; + for test in suite.tests() { + if filter + .as_ref() + .is_some_and(|f| !test.uncontracted_name().contains(f)) + { + continue; + } + + let _tracing = test.configuration().log.as_ref().and_then(|log| match log { + Log::Bool(enabled) => enabled.then(setup_logging), + Log::Filter(filter) => setup_logging_with_filter(filter), + }); + + if let Err(failures) = run_test(&mut db, relative_fixture_path, snapshot_path, &test) { + any_failures = true; + + if output_format.is_cli() { + println!("\n{}\n", test.name().bold().underline()); + } + + let md_index = LineIndex::from_source_text(&source); + + for test_failures in failures { + let source_map = + EmbeddedFileSourceMap::new(&md_index, test_failures.backtick_offsets); + + for (relative_line_number, failures) in test_failures.by_line.iter() { + let absolute_line_number = + source_map.to_absolute_line_number(relative_line_number); + + for failure in failures { + match output_format { + OutputFormat::Cli => { + let line_info = + format!("{relative_fixture_path}:{absolute_line_number}") + .cyan(); + println!(" {line_info} {failure}"); + } + OutputFormat::GitHub => println!( + "::error file={absolute_fixture_path},line={absolute_line_number}::{failure}" + ), + } + } + } + } + + let escaped_test_name = test.name().replace('\'', "\\'"); + + if output_format.is_cli() { + println!( + "\nTo rerun this specific test, set the environment variable: {MDTEST_TEST_FILTER}='{escaped_test_name}'", + ); + println!( + "{MDTEST_TEST_FILTER}='{escaped_test_name}' cargo test -p ty_python_semantic --test mdtest -- {test_name}", + ); + } + } + } + + println!("\n{}\n", "-".repeat(50)); + + assert!(!any_failures, "Some tests failed."); +} + +/// Defines the format in which mdtest should print an error to the terminal +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum OutputFormat { + /// The format `cargo test` should use by default. + Cli, + /// A format that will provide annotations from GitHub Actions + /// if mdtest fails on a PR. + /// See <https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-error-message> + GitHub, +} + +impl OutputFormat { + const fn is_cli(self) -> bool { + matches!(self, OutputFormat::Cli) + } +} + +fn run_test( + db: &mut db::Db, + relative_fixture_path: &Utf8Path, + snapshot_path: &Utf8Path, + test: &parser::MarkdownTest, +) -> Result<(), Failures> { + // Initialize the system and remove all files and directories to reset the system to a clean state. + match test.configuration().system.unwrap_or_default() { + SystemKind::InMemory => { + db.use_in_memory_system(); + } + SystemKind::Os => { + let dir = tempfile::TempDir::new().expect("Creating a temporary directory to succeed"); + let root_path = dir + .path() + .canonicalize() + .expect("Canonicalizing to succeed"); + let root_path = SystemPathBuf::from_path_buf(root_path) + .expect("Temp directory to be a valid UTF8 path") + .simplified() + .to_path_buf(); + + db.use_os_system_with_temp_dir(root_path, dir); + } + } + + let project_root = SystemPathBuf::from("/src"); + db.create_directory_all(&project_root) + .expect("Creating the project root to succeed"); + + let src_path = project_root.clone(); + let custom_typeshed_path = test.configuration().typeshed(); + let python_path = test.configuration().python(); + let python_version = test.configuration().python_version().unwrap_or_default(); + + let mut typeshed_files = vec![]; + let mut has_custom_versions_file = false; + + let test_files: Vec<_> = test + .files() + .filter_map(|embedded| { + if embedded.lang == "ignore" { + return None; + } + + assert!( + matches!(embedded.lang, "py" | "pyi" | "python" | "text" | "cfg"), + "Supported file types are: py (or python), pyi, text, cfg and ignore" + ); + + let mut full_path = embedded.full_path(&project_root); + + if let Some(typeshed_path) = custom_typeshed_path { + if let Ok(relative_path) = full_path.strip_prefix(typeshed_path.join("stdlib")) { + if relative_path.as_str() == "VERSIONS" { + has_custom_versions_file = true; + } else if relative_path.extension().is_some_and(|ext| ext == "pyi") { + typeshed_files.push(relative_path.to_path_buf()); + } + } + } else if let Some(python_path) = python_path { + if let Ok(relative_path) = full_path.strip_prefix(python_path) { + // Construct the path to the site-packages directory + if relative_path.as_str() != "pyvenv.cfg" { + let mut new_path = SystemPathBuf::new(); + for component in full_path.components() { + let component = component.as_str(); + if component == "<path-to-site-packages>" { + if cfg!(target_os = "windows") { + new_path.push("Lib"); + new_path.push("site-packages"); + } else { + new_path.push("lib"); + new_path.push(format!("python{python_version}")); + new_path.push("site-packages"); + } + } else { + new_path.push(component); + } + } + full_path = new_path; + } + } + } + + db.write_file(&full_path, &embedded.code).unwrap(); + + if !(full_path.starts_with(&src_path) && matches!(embedded.lang, "py" | "pyi")) { + // These files need to be written to the file system (above), but we don't run any checks on them. + return None; + } + + let file = system_path_to_file(db, full_path).unwrap(); + + Some(TestFile { + file, + backtick_offsets: embedded.backtick_offsets.clone(), + }) + }) + .collect(); + + // Create a custom typeshed `VERSIONS` file if none was provided. + if let Some(typeshed_path) = custom_typeshed_path { + if !has_custom_versions_file { + let versions_file = typeshed_path.join("stdlib/VERSIONS"); + let contents = typeshed_files + .iter() + .fold(String::new(), |mut content, path| { + // This is intentionally kept simple: + let module_name = path + .as_str() + .trim_end_matches(".pyi") + .trim_end_matches("/__init__") + .replace('/', "."); + let _ = writeln!(content, "{module_name}: 3.8-"); + content + }); + db.write_file(&versions_file, contents).unwrap(); + } + } + + let configuration = test.configuration(); + + let settings = ProgramSettings { + python_version: PythonVersionWithSource { + version: python_version, + source: PythonVersionSource::Cli, + }, + python_platform: configuration + .python_platform() + .unwrap_or(PythonPlatform::Identifier("linux".to_string())), + search_paths: SearchPathSettings { + src_roots: vec![src_path], + extra_paths: configuration.extra_paths().unwrap_or_default().to_vec(), + custom_typeshed: custom_typeshed_path.map(SystemPath::to_path_buf), + python_path: configuration + .python() + .map(|sys_prefix| { + PythonPath::SysPrefix( + sys_prefix.to_path_buf(), + SysPrefixPathOrigin::PythonCliFlag, + ) + }) + .unwrap_or(PythonPath::KnownSitePackages(vec![])), + }, + }; + + match Program::try_get(db) { + Some(program) => program.update_from_settings(db, settings), + None => Program::from_settings(db, settings).map(|_| ()), + } + .expect("Failed to update Program settings in TestDb"); + + // When snapshot testing is enabled, this is populated with + // all diagnostics. Otherwise it remains empty. + let mut snapshot_diagnostics = vec![]; + + let failures: Failures = test_files + .into_iter() + .filter_map(|test_file| { + let parsed = parsed_module(db, test_file.file); + + let mut diagnostics: Vec<Diagnostic> = parsed + .errors() + .iter() + .map(|error| create_parse_diagnostic(test_file.file, error)) + .collect(); + + diagnostics.extend( + parsed + .unsupported_syntax_errors() + .iter() + .map(|error| create_unsupported_syntax_diagnostic(test_file.file, error)), + ); + + let type_diagnostics = match catch_unwind(|| check_types(db, test_file.file)) { + Ok(type_diagnostics) => type_diagnostics, + Err(info) => { + let mut by_line = matcher::FailuresByLine::default(); + let mut messages = vec![]; + match info.location { + Some(location) => messages.push(format!("panicked at {location}")), + None => messages.push("panicked at unknown location".to_string()), + } + match info.payload.as_str() { + Some(message) => messages.push(message.to_string()), + // Mimic the default panic hook's rendering of the panic payload if it's + // not a string. + None => messages.push("Box<dyn Any>".to_string()), + } + if let Some(backtrace) = info.backtrace { + match backtrace.status() { + BacktraceStatus::Disabled => { + let msg = "run with `RUST_BACKTRACE=1` environment variable to display a backtrace"; + messages.push(msg.to_string()); + } + BacktraceStatus::Captured => { + messages.extend(backtrace.to_string().split('\n').map(String::from)); + } + _ => {} + } + } + + if let Some(backtrace) = info.salsa_backtrace { + salsa::attach(db, || { + messages.extend(format!("{backtrace:#}").split('\n').map(String::from)); + }); + } + + by_line.push(OneIndexed::from_zero_indexed(0), messages); + return Some(FileFailures { + backtick_offsets: test_file.backtick_offsets, + by_line, + }); + } + }; + diagnostics.extend(type_diagnostics.into_iter().cloned()); + diagnostics.sort_by(|left, right|left.rendering_sort_key(db).cmp(&right.rendering_sort_key(db))); + + let failure = match matcher::match_file(db, test_file.file, &diagnostics) { + Ok(()) => None, + Err(line_failures) => Some(FileFailures { + backtick_offsets: test_file.backtick_offsets, + by_line: line_failures, + }), + }; + if test.should_snapshot_diagnostics() { + snapshot_diagnostics.extend(diagnostics); + } + failure + }) + .collect(); + + if snapshot_diagnostics.is_empty() && test.should_snapshot_diagnostics() { + panic!( + "Test `{}` requested snapshotting diagnostics but it didn't produce any.", + test.name() + ); + } else if !snapshot_diagnostics.is_empty() { + let snapshot = + create_diagnostic_snapshot(db, relative_fixture_path, test, snapshot_diagnostics); + let name = test.name().replace(' ', "_").replace(':', "__"); + insta::with_settings!( + { + snapshot_path => snapshot_path, + input_file => name.clone(), + filters => vec![(r"\\", "/")], + prepend_module_to_snapshot => false, + }, + { insta::assert_snapshot!(name, snapshot) } + ); + } + + if failures.is_empty() { + Ok(()) + } else { + Err(failures) + } +} + +type Failures = Vec<FileFailures>; + +/// The failures for a single file in a test by line number. +struct FileFailures { + /// Positional information about the code block(s) to reconstruct absolute line numbers. + backtick_offsets: Vec<BacktickOffsets>, + + /// The failures by lines in the file. + by_line: matcher::FailuresByLine, +} + +/// File in a test. +struct TestFile { + file: File, + + /// Positional information about the code block(s) to reconstruct absolute line numbers. + backtick_offsets: Vec<BacktickOffsets>, +} + +fn create_diagnostic_snapshot( + db: &mut db::Db, + relative_fixture_path: &Utf8Path, + test: &parser::MarkdownTest, + diagnostics: impl IntoIterator<Item = Diagnostic>, +) -> String { + let display_config = DisplayDiagnosticConfig::default().color(false); + + let mut snapshot = String::new(); + writeln!(snapshot).unwrap(); + writeln!(snapshot, "---").unwrap(); + writeln!(snapshot, "mdtest name: {}", test.uncontracted_name()).unwrap(); + writeln!(snapshot, "mdtest path: {relative_fixture_path}").unwrap(); + writeln!(snapshot, "---").unwrap(); + writeln!(snapshot).unwrap(); + + writeln!(snapshot, "# Python source files").unwrap(); + writeln!(snapshot).unwrap(); + for file in test.files() { + writeln!(snapshot, "## {}", file.relative_path()).unwrap(); + writeln!(snapshot).unwrap(); + // Note that we don't use ```py here because the line numbering + // we add makes it invalid Python. This sacrifices syntax + // highlighting when you look at the snapshot on GitHub, + // but the line numbers are extremely useful for analyzing + // snapshots. So we keep them. + writeln!(snapshot, "```").unwrap(); + + let line_number_width = file.code.lines().count().to_string().len(); + for (i, line) in file.code.lines().enumerate() { + let line_number = i + 1; + writeln!(snapshot, "{line_number:>line_number_width$} | {line}").unwrap(); + } + writeln!(snapshot, "```").unwrap(); + writeln!(snapshot).unwrap(); + } + + writeln!(snapshot, "# Diagnostics").unwrap(); + writeln!(snapshot).unwrap(); + for (i, diag) in diagnostics.into_iter().enumerate() { + if i > 0 { + writeln!(snapshot).unwrap(); + } + writeln!(snapshot, "```").unwrap(); + write!(snapshot, "{}", diag.display(&db.upcast(), &display_config)).unwrap(); + writeln!(snapshot, "```").unwrap(); + } + snapshot +} diff --git a/crates/ty_test/src/matcher.rs b/crates/ty_test/src/matcher.rs new file mode 100644 index 0000000000000..ff90010f78635 --- /dev/null +++ b/crates/ty_test/src/matcher.rs @@ -0,0 +1,1319 @@ +//! Match [`Diagnostic`]s against assertions and produce test failure +//! messages for any mismatches. +use crate::assertion::{InlineFileAssertions, ParsedAssertion, UnparsedAssertion}; +use crate::db::Db; +use crate::diagnostic::SortedDiagnostics; +use colored::Colorize; +use ruff_db::diagnostic::{Diagnostic, DiagnosticId}; +use ruff_db::files::File; +use ruff_db::source::{SourceText, line_index, source_text}; +use ruff_source_file::{LineIndex, OneIndexed}; +use std::cmp::Ordering; +use std::ops::Range; + +#[derive(Debug, Default)] +pub(super) struct FailuresByLine { + failures: Vec<String>, + lines: Vec<LineFailures>, +} + +impl FailuresByLine { + pub(super) fn iter(&self) -> impl Iterator<Item = (OneIndexed, &[String])> { + self.lines.iter().map(|line_failures| { + ( + line_failures.line_number, + &self.failures[line_failures.range.clone()], + ) + }) + } + + pub(super) fn push(&mut self, line_number: OneIndexed, messages: Vec<String>) { + let start = self.failures.len(); + self.failures.extend(messages); + self.lines.push(LineFailures { + line_number, + range: start..self.failures.len(), + }); + } + + fn is_empty(&self) -> bool { + self.lines.is_empty() + } +} + +#[derive(Debug)] +struct LineFailures { + line_number: OneIndexed, + range: Range<usize>, +} + +pub(super) fn match_file( + db: &Db, + file: File, + diagnostics: &[Diagnostic], +) -> Result<(), FailuresByLine> { + // Parse assertions from comments in the file, and get diagnostics from the file; both + // ordered by line number. + let assertions = InlineFileAssertions::from_file(db, file); + let diagnostics = SortedDiagnostics::new(diagnostics, &line_index(db, file)); + + // Get iterators over assertions and diagnostics grouped by line, in ascending line order. + let mut line_assertions = assertions.into_iter(); + let mut line_diagnostics = diagnostics.iter_lines(); + + let mut current_assertions = line_assertions.next(); + let mut current_diagnostics = line_diagnostics.next(); + + let matcher = Matcher::from_file(db, file); + let mut failures = FailuresByLine::default(); + + loop { + match (¤t_assertions, ¤t_diagnostics) { + (Some(assertions), Some(diagnostics)) => { + match assertions.line_number.cmp(&diagnostics.line_number) { + Ordering::Equal => { + // We have assertions and diagnostics on the same line; check for + // matches and error on any that don't match, then advance both + // iterators. + matcher + .match_line(diagnostics, assertions) + .unwrap_or_else(|messages| { + failures.push(assertions.line_number, messages); + }); + current_assertions = line_assertions.next(); + current_diagnostics = line_diagnostics.next(); + } + Ordering::Less => { + // We have assertions on an earlier line than diagnostics; report these + // assertions as all unmatched, and advance the assertions iterator. + failures.push(assertions.line_number, unmatched(assertions)); + current_assertions = line_assertions.next(); + } + Ordering::Greater => { + // We have diagnostics on an earlier line than assertions; report these + // diagnostics as all unmatched, and advance the diagnostics iterator. + failures.push(diagnostics.line_number, unmatched(diagnostics)); + current_diagnostics = line_diagnostics.next(); + } + } + } + (Some(assertions), None) => { + // We've exhausted diagnostics but still have assertions; report these assertions + // as unmatched and advance the assertions iterator. + failures.push(assertions.line_number, unmatched(assertions)); + current_assertions = line_assertions.next(); + } + (None, Some(diagnostics)) => { + // We've exhausted assertions but still have diagnostics; report these + // diagnostics as unmatched and advance the diagnostics iterator. + failures.push(diagnostics.line_number, unmatched(diagnostics)); + current_diagnostics = line_diagnostics.next(); + } + // When we've exhausted both diagnostics and assertions, break. + (None, None) => break, + } + } + + if failures.is_empty() { + Ok(()) + } else { + Err(failures) + } +} + +trait Unmatched { + fn unmatched(&self) -> String; +} + +fn unmatched<'a, T: Unmatched + 'a>(unmatched: &'a [T]) -> Vec<String> { + unmatched.iter().map(Unmatched::unmatched).collect() +} + +trait UnmatchedWithColumn { + fn unmatched_with_column(&self, column: OneIndexed) -> String; +} + +// This is necessary since we only parse assertions lazily, +// and sometimes we know before parsing any assertions that an assertion will be unmatched, +// e.g. if we've exhausted all diagnostics but there are still assertions left. +// +// TODO: the lazy parsing means that we sometimes won't report malformed assertions as +// being invalid if we detect that they'll be unmatched before parsing them. +// That's perhaps not the best user experience. +impl Unmatched for UnparsedAssertion<'_> { + fn unmatched(&self) -> String { + format!("{} {self}", "unmatched assertion:".red()) + } +} + +impl Unmatched for ParsedAssertion<'_> { + fn unmatched(&self) -> String { + format!("{} {self}", "unmatched assertion:".red()) + } +} + +fn maybe_add_undefined_reveal_clarification( + diagnostic: &Diagnostic, + original: std::fmt::Arguments, +) -> String { + if diagnostic.id().is_lint_named("undefined-reveal") { + format!( + "{} add a `# revealed` assertion on this line (original diagnostic: {original})", + "used built-in `reveal_type`:".yellow() + ) + } else { + format!("{} {original}", "unexpected error:".red()) + } +} + +impl Unmatched for &Diagnostic { + fn unmatched(&self) -> String { + maybe_add_undefined_reveal_clarification( + self, + format_args!( + r#"[{id}] "{message}""#, + id = self.id(), + message = self.concise_message() + ), + ) + } +} + +impl UnmatchedWithColumn for &Diagnostic { + fn unmatched_with_column(&self, column: OneIndexed) -> String { + maybe_add_undefined_reveal_clarification( + self, + format_args!( + r#"{column} [{id}] "{message}""#, + id = self.id(), + message = self.concise_message() + ), + ) + } +} + +/// Discard `@Todo`-type metadata from expected types, which is not available +/// when running in release mode. +#[cfg(not(debug_assertions))] +fn discard_todo_metadata(ty: &str) -> std::borrow::Cow<'_, str> { + static TODO_METADATA_REGEX: std::sync::LazyLock<regex::Regex> = + std::sync::LazyLock::new(|| regex::Regex::new(r"@Todo\([^)]*\)").unwrap()); + + TODO_METADATA_REGEX.replace_all(ty, "@Todo") +} + +struct Matcher { + line_index: LineIndex, + source: SourceText, +} + +impl Matcher { + fn from_file(db: &Db, file: File) -> Self { + Self { + line_index: line_index(db, file), + source: source_text(db, file), + } + } + + /// Check a slice of [`Diagnostic`]s against a slice of + /// [`UnparsedAssertion`]s. + /// + /// Return vector of [`Unmatched`] for any unmatched diagnostics or + /// assertions. + fn match_line<'a, 'b>( + &self, + diagnostics: &'a [&'a Diagnostic], + assertions: &'a [UnparsedAssertion<'b>], + ) -> Result<(), Vec<String>> + where + 'b: 'a, + { + let mut failures = vec![]; + let mut unmatched = diagnostics.to_vec(); + for assertion in assertions { + match assertion.parse() { + Ok(assertion) => { + if !self.matches(&assertion, &mut unmatched) { + failures.push(assertion.unmatched()); + } + } + Err(error) => { + failures.push(format!("{} {}", "invalid assertion:".red(), error)); + } + } + } + for diagnostic in unmatched { + failures.push(diagnostic.unmatched_with_column(self.column(diagnostic))); + } + if failures.is_empty() { + Ok(()) + } else { + Err(failures) + } + } + + fn column(&self, diagnostic: &Diagnostic) -> OneIndexed { + diagnostic + .primary_span() + .and_then(|span| span.range()) + .map(|range| { + self.line_index + .line_column(range.start(), &self.source) + .column + }) + .unwrap_or(OneIndexed::from_zero_indexed(0)) + } + + /// Check if `assertion` matches any [`Diagnostic`]s in `unmatched`. + /// + /// If so, return `true` and remove the matched diagnostics from `unmatched`. Otherwise, return + /// `false`. + /// + /// An `Error` assertion can only match one diagnostic; even if it could match more than one, + /// we short-circuit after the first match. + /// + /// A `Revealed` assertion must match a revealed-type diagnostic, and may also match an + /// undefined-reveal diagnostic, if present. + fn matches(&self, assertion: &ParsedAssertion, unmatched: &mut Vec<&Diagnostic>) -> bool { + match assertion { + ParsedAssertion::Error(error) => { + let position = unmatched.iter().position(|diagnostic| { + let lint_name_matches = !error.rule.is_some_and(|rule| { + !(diagnostic.id().is_lint_named(rule) || diagnostic.id().as_str() == rule) + }); + let column_matches = error + .column + .is_none_or(|col| col == self.column(diagnostic)); + let message_matches = error.message_contains.is_none_or(|needle| { + diagnostic.concise_message().to_string().contains(needle) + }); + lint_name_matches && column_matches && message_matches + }); + if let Some(position) = position { + unmatched.swap_remove(position); + true + } else { + false + } + } + ParsedAssertion::Revealed(expected_type) => { + #[cfg(not(debug_assertions))] + let expected_type = discard_todo_metadata(&expected_type); + + let mut matched_revealed_type = None; + let mut matched_undefined_reveal = None; + let expected_reveal_type_message = format!("`{expected_type}`"); + for (index, diagnostic) in unmatched.iter().enumerate() { + if matched_revealed_type.is_none() + && diagnostic.id() == DiagnosticId::RevealedType + && diagnostic + .primary_annotation() + .and_then(|a| a.get_message()) + .unwrap_or_default() + == expected_reveal_type_message + { + matched_revealed_type = Some(index); + } else if matched_undefined_reveal.is_none() + && diagnostic.id().is_lint_named("undefined-reveal") + { + matched_undefined_reveal = Some(index); + } + if matched_revealed_type.is_some() && matched_undefined_reveal.is_some() { + break; + } + } + let mut idx = 0; + unmatched.retain(|_| { + let retain = + Some(idx) != matched_revealed_type && Some(idx) != matched_undefined_reveal; + idx += 1; + retain + }); + matched_revealed_type.is_some() + } + } + } +} + +#[cfg(test)] +mod tests { + use super::FailuresByLine; + use ruff_db::diagnostic::{Annotation, Diagnostic, DiagnosticId, Severity, Span}; + use ruff_db::files::{File, system_path_to_file}; + use ruff_db::system::DbWithWritableSystem as _; + use ruff_python_trivia::textwrap::dedent; + use ruff_source_file::OneIndexed; + use ruff_text_size::TextRange; + use ty_python_semantic::{ + Program, ProgramSettings, PythonPlatform, PythonVersionWithSource, SearchPathSettings, + }; + + struct ExpectedDiagnostic { + id: DiagnosticId, + message: &'static str, + range: TextRange, + } + + impl ExpectedDiagnostic { + fn new(id: DiagnosticId, message: &'static str, offset: usize) -> Self { + let offset: u32 = offset.try_into().unwrap(); + Self { + id, + message, + range: TextRange::new(offset.into(), (offset + 1).into()), + } + } + + fn into_diagnostic(self, file: File) -> Diagnostic { + let mut diag = if self.id == DiagnosticId::RevealedType { + Diagnostic::new(self.id, Severity::Error, "Revealed type") + } else { + Diagnostic::new(self.id, Severity::Error, "") + }; + let span = Span::from(file).with_range(self.range); + diag.annotate(Annotation::primary(span).message(self.message)); + diag + } + } + + fn get_result( + source: &str, + expected_diagnostics: Vec<ExpectedDiagnostic>, + ) -> Result<(), FailuresByLine> { + colored::control::set_override(false); + + let mut db = crate::db::Db::setup(); + + let settings = ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings::new(Vec::new()), + }; + match Program::try_get(&db) { + Some(program) => program.update_from_settings(&mut db, settings), + None => Program::from_settings(&db, settings).map(|_| ()), + } + .expect("Failed to update Program settings in TestDb"); + + db.write_file("/src/test.py", source).unwrap(); + let file = system_path_to_file(&db, "/src/test.py").unwrap(); + + let diagnostics: Vec<Diagnostic> = expected_diagnostics + .into_iter() + .map(|diagnostic| diagnostic.into_diagnostic(file)) + .collect(); + super::match_file(&db, file, &diagnostics) + } + + fn assert_fail(result: Result<(), FailuresByLine>, messages: &[(usize, &[&str])]) { + let Err(failures) = result else { + panic!("expected a failure"); + }; + + let expected: Vec<(OneIndexed, Vec<String>)> = messages + .iter() + .map(|(idx, msgs)| { + ( + OneIndexed::from_zero_indexed(*idx), + msgs.iter().map(ToString::to_string).collect(), + ) + }) + .collect(); + let failures: Vec<(OneIndexed, Vec<String>)> = failures + .iter() + .map(|(idx, msgs)| (idx, msgs.to_vec())) + .collect(); + + assert_eq!(failures, expected); + } + + fn assert_ok(result: &Result<(), FailuresByLine>) { + assert!(result.is_ok(), "{result:?}"); + } + + #[test] + fn revealed_match() { + let result = get_result( + "x # revealed: Foo", + vec![ExpectedDiagnostic::new( + DiagnosticId::RevealedType, + "`Foo`", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn revealed_wrong_rule() { + let result = get_result( + "x # revealed: Foo", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("not-revealed-type"), + "`Foo`", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: revealed: Foo", + r#"unexpected error: 1 [not-revealed-type] "`Foo`""#, + ], + )], + ); + } + + #[test] + fn revealed_wrong_message() { + let result = get_result( + "x # revealed: Foo", + vec![ExpectedDiagnostic::new( + DiagnosticId::RevealedType, + "Something else", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: revealed: Foo", + r#"unexpected error: 1 [revealed-type] "Revealed type: Something else""#, + ], + )], + ); + } + + #[test] + fn revealed_unmatched() { + let result = get_result("x # revealed: Foo", vec![]); + + assert_fail(result, &[(0, &["unmatched assertion: revealed: Foo"])]); + } + + #[test] + fn revealed_match_with_undefined() { + let result = get_result( + "x # revealed: Foo", + vec![ + ExpectedDiagnostic::new(DiagnosticId::RevealedType, "`Foo`", 0), + ExpectedDiagnostic::new( + DiagnosticId::lint("undefined-reveal"), + "Doesn't matter", + 0, + ), + ], + ); + + assert_ok(&result); + } + + #[test] + fn revealed_match_with_only_undefined() { + let result = get_result( + "x # revealed: Foo", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("undefined-reveal"), + "Doesn't matter", + 0, + )], + ); + + assert_fail(result, &[(0, &["unmatched assertion: revealed: Foo"])]); + } + + #[test] + fn revealed_mismatch_with_undefined() { + let result = get_result( + "x # revealed: Foo", + vec![ + ExpectedDiagnostic::new(DiagnosticId::RevealedType, "`Bar`", 0), + ExpectedDiagnostic::new( + DiagnosticId::lint("undefined-reveal"), + "Doesn't matter", + 0, + ), + ], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: revealed: Foo", + r#"unexpected error: 1 [revealed-type] "Revealed type: `Bar`""#, + ], + )], + ); + } + + #[test] + fn undefined_reveal_type_unmatched() { + let result = get_result( + "reveal_type(1)", + vec![ + ExpectedDiagnostic::new( + DiagnosticId::lint("undefined-reveal"), + "undefined reveal message", + 0, + ), + ExpectedDiagnostic::new(DiagnosticId::RevealedType, "`Literal[1]`", 12), + ], + ); + + assert_fail( + result, + &[( + 0, + &[ + "used built-in `reveal_type`: add a `# revealed` assertion on this line (\ + original diagnostic: [undefined-reveal] \"undefined reveal message\")", + r#"unexpected error: [revealed-type] "Revealed type: `Literal[1]`""#, + ], + )], + ); + } + + #[test] + fn undefined_reveal_type_mismatched() { + let result = get_result( + "reveal_type(1) # error: [something-else]", + vec![ + ExpectedDiagnostic::new( + DiagnosticId::lint("undefined-reveal"), + "undefined reveal message", + 0, + ), + ExpectedDiagnostic::new(DiagnosticId::RevealedType, "`Literal[1]`", 12), + ], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: error: [something-else]", + "used built-in `reveal_type`: add a `# revealed` assertion on this line (\ + original diagnostic: 1 [undefined-reveal] \"undefined reveal message\")", + r#"unexpected error: 13 [revealed-type] "Revealed type: `Literal[1]`""#, + ], + )], + ); + } + + #[test] + fn error_unmatched() { + let result = get_result("x # error: [rule]", vec![]); + + assert_fail(result, &[(0, &["unmatched assertion: error: [rule]"])]); + } + + #[test] + fn error_match_rule() { + let result = get_result( + "x # error: [some-rule]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Any message", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_rule_no_whitespace() { + let result = get_result( + "x #error:[some-rule]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Any message", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_rule_lots_of_whitespace() { + let result = get_result( + "x # error : [ some-rule ]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Any message", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_wrong_rule() { + let result = get_result( + "x # error: [some-rule]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("anything"), + "Any message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: error: [some-rule]", + r#"unexpected error: 1 [anything] "Any message""#, + ], + )], + ); + } + + #[test] + fn error_match_message() { + let result = get_result( + r#"x # error: "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("anything"), + "message contains this", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_wrong_message() { + let result = get_result( + r#"x # error: "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("anything"), + "Any message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + r#"unmatched assertion: error: "contains this""#, + r#"unexpected error: 1 [anything] "Any message""#, + ], + )], + ); + } + + #[test] + fn error_match_column_and_rule() { + let result = get_result( + "x # error: 1 [some-rule]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Any message", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_column_and_rule_and_message() { + let result = get_result( + r#"x # error: 5 [some-rule] "Some message""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Some message", + 4, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_wrong_column() { + let result = get_result( + "x # error: 2 [rule]", + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("rule"), + "Any message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "unmatched assertion: error: 2 [rule]", + r#"unexpected error: 1 [rule] "Any message""#, + ], + )], + ); + } + + #[test] + fn error_match_column_and_message() { + let result = get_result( + r#"x # error: 1 "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("anything"), + "message contains this", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_rule_and_message() { + let result = get_result( + r#"x # error: [a-rule] "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("a-rule"), + "message contains this", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_all() { + let result = get_result( + r#"x # error: 1 [a-rule] "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("a-rule"), + "message contains this", + 0, + )], + ); + + assert_ok(&result); + } + + #[test] + fn error_match_all_wrong_column() { + let result = get_result( + r#"x # error: 2 [some-rule] "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "message contains this", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + r#"unmatched assertion: error: 2 [some-rule] "contains this""#, + r#"unexpected error: 1 [some-rule] "message contains this""#, + ], + )], + ); + } + + #[test] + fn error_match_all_wrong_rule() { + let result = get_result( + r#"x # error: 1 [some-rule] "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("other-rule"), + "message contains this", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + r#"unmatched assertion: error: 1 [some-rule] "contains this""#, + r#"unexpected error: 1 [other-rule] "message contains this""#, + ], + )], + ); + } + + #[test] + fn error_match_all_wrong_message() { + let result = get_result( + r#"x # error: 1 [some-rule] "contains this""#, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "Any message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + r#"unmatched assertion: error: 1 [some-rule] "contains this""#, + r#"unexpected error: 1 [some-rule] "Any message""#, + ], + )], + ); + } + + #[test] + fn interspersed_matches_and_mismatches() { + let source = dedent( + r#" + 1 # error: [line-one] + 2 + 3 # error: [line-three] + 4 # error: [line-four] + 5 + 6: # error: [line-six] + "#, + ); + let two = source.find('2').unwrap(); + let three = source.find('3').unwrap(); + let five = source.find('5').unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("line-two"), "msg", two), + ExpectedDiagnostic::new(DiagnosticId::lint("line-three"), "msg", three), + ExpectedDiagnostic::new(DiagnosticId::lint("line-five"), "msg", five), + ], + ); + + assert_fail( + result, + &[ + (1, &["unmatched assertion: error: [line-one]"]), + (2, &[r#"unexpected error: [line-two] "msg""#]), + (4, &["unmatched assertion: error: [line-four]"]), + (5, &[r#"unexpected error: [line-five] "msg""#]), + (6, &["unmatched assertion: error: [line-six]"]), + ], + ); + } + + #[test] + fn more_diagnostics_than_assertions() { + let source = dedent( + r#" + 1 # error: [line-one] + 2 + "#, + ); + let one = source.find('1').unwrap(); + let two = source.find('2').unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("line-one"), "msg", one), + ExpectedDiagnostic::new(DiagnosticId::lint("line-two"), "msg", two), + ], + ); + + assert_fail(result, &[(2, &[r#"unexpected error: [line-two] "msg""#])]); + } + + #[test] + fn multiple_assertions_and_diagnostics_same_line() { + let source = dedent( + " + # error: [one-rule] + # error: [other-rule] + x + ", + ); + let x = source.find('x').unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("one-rule"), "msg", x), + ExpectedDiagnostic::new(DiagnosticId::lint("other-rule"), "msg", x), + ], + ); + + assert_ok(&result); + } + + #[test] + fn multiple_assertions_and_diagnostics_same_line_all_same() { + let source = dedent( + " + # error: [one-rule] + # error: [one-rule] + x + ", + ); + let x = source.find('x').unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("one-rule"), "msg", x), + ExpectedDiagnostic::new(DiagnosticId::lint("one-rule"), "msg", x), + ], + ); + + assert_ok(&result); + } + + #[test] + fn multiple_assertions_and_diagnostics_same_line_mismatch() { + let source = dedent( + " + # error: [one-rule] + # error: [other-rule] + x + ", + ); + let x = source.find('x').unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("one-rule"), "msg", x), + ExpectedDiagnostic::new(DiagnosticId::lint("other-rule"), "msg", x), + ExpectedDiagnostic::new(DiagnosticId::lint("third-rule"), "msg", x), + ], + ); + + assert_fail( + result, + &[(3, &[r#"unexpected error: 1 [third-rule] "msg""#])], + ); + } + + #[test] + fn parenthesized_expression() { + let source = dedent( + " + a = b + ( + error: [undefined-reveal] + reveal_type(5) # revealed: Literal[5] + ) + ", + ); + let reveal = source.find("reveal_type").unwrap(); + let result = get_result( + &source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("undefined-reveal"), "msg", reveal), + ExpectedDiagnostic::new(DiagnosticId::RevealedType, "`Literal[5]`", reveal), + ], + ); + + assert_ok(&result); + } + + #[test] + fn bare_error_assertion_not_allowed() { + let source = "x # error:"; + let x = source.find('x').unwrap(); + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + x, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: no rule or message text", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn bare_reveal_assertion_not_allowed() { + let source = "x # revealed: "; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: Must specify which type should be revealed", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn column_only_error_assertion_not_allowed() { + let source = "x # error: 1"; + let x = source.find('x').unwrap(); + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + x, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: no rule or message text", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn unclosed_rule_not_allowed() { + let source = r#"x # error: 42 [some-rule "Some message""#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: expected ']' to close rule code", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn bad_column_number_not_allowed() { + let source = r#"x # error: 3.14 [some-rule] "Some message""#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: bad column number `3.14`", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn multiple_column_numbers_not_allowed() { + let source = r#"x # error: 3 14 [some-rule] "Some message""#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: multiple column numbers in one assertion", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn multiple_column_numbers_not_allowed_even_if_interspersed() { + let source = r#"x # error: 3 [some-rule] 14 "Some message""#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: multiple column numbers in one assertion", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn two_rule_codes_not_allowed() { + let source = r#"x # error: [rule1] [rule2] "Some message""#; + let result = get_result( + source, + vec![ + ExpectedDiagnostic::new(DiagnosticId::lint("rule1"), "Some message", 0), + ExpectedDiagnostic::new(DiagnosticId::lint("rule2"), "Some message", 0), + ], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: cannot use multiple rule codes in one assertion", + r#"unexpected error: 1 [rule1] "Some message""#, + r#"unexpected error: 1 [rule2] "Some message""#, + ], + )], + ); + } + + #[test] + fn column_number_not_allowed_after_rule_code() { + let source = r#"x # error: [rule1] 4 "Some message""#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("rule1"), + "Some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: column number must precede the rule code", + r#"unexpected error: 1 [rule1] "Some message""#, + ], + )], + ); + } + + #[test] + fn column_number_not_allowed_after_message() { + let source = r#"x # error: "Some message" 0"#; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("rule1"), + "Some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: expected '\"' to be the final character in an assertion with an error message", + r#"unexpected error: 1 [rule1] "Some message""#, + ], + )], + ); + } + + #[test] + fn unclosed_message_not_allowed() { + let source = "x # error: \"Some message"; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: expected '\"' to be the final character in an assertion with an error message", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } + + #[test] + fn unclosed_message_not_allowed_even_after_rule_code() { + let source = "x # error: [some-rule] \"Some message"; + let result = get_result( + source, + vec![ExpectedDiagnostic::new( + DiagnosticId::lint("some-rule"), + "some message", + 0, + )], + ); + + assert_fail( + result, + &[( + 0, + &[ + "invalid assertion: expected '\"' to be the final character in an assertion with an error message", + r#"unexpected error: 1 [some-rule] "some message""#, + ], + )], + ); + } +} diff --git a/crates/ty_test/src/parser.rs b/crates/ty_test/src/parser.rs new file mode 100644 index 0000000000000..805ce0d409ac6 --- /dev/null +++ b/crates/ty_test/src/parser.rs @@ -0,0 +1,1938 @@ +use std::{ + borrow::Cow, + collections::hash_map::Entry, + fmt::{Formatter, LowerHex, Write}, + hash::Hash, +}; + +use anyhow::bail; +use ruff_db::system::{SystemPath, SystemPathBuf}; +use rustc_hash::FxHashMap; + +use ruff_index::{IndexVec, newtype_index}; +use ruff_python_ast::PySourceType; +use ruff_python_trivia::Cursor; +use ruff_source_file::{LineIndex, LineRanges, OneIndexed}; +use ruff_text_size::{TextLen, TextRange, TextSize}; +use rustc_stable_hash::{FromStableHash, SipHasher128Hash, StableSipHasher128}; + +use crate::config::MarkdownTestConfig; + +/// Parse the Markdown `source` as a test suite with given `title`. +pub(crate) fn parse<'s>(title: &'s str, source: &'s str) -> anyhow::Result<MarkdownTestSuite<'s>> { + let parser = Parser::new(title, source); + parser.parse() +} + +/// A parsed markdown file containing tests. +/// +/// Borrows from the source string and filepath it was created from. +#[derive(Debug)] +pub(crate) struct MarkdownTestSuite<'s> { + /// Header sections. + sections: IndexVec<SectionId, Section<'s>>, + + /// Test files embedded within the Markdown file. + files: IndexVec<EmbeddedFileId, EmbeddedFile<'s>>, +} + +impl<'s> MarkdownTestSuite<'s> { + pub(crate) fn tests(&self) -> MarkdownTestIterator<'_, 's> { + MarkdownTestIterator { + suite: self, + current_file_index: 0, + } + } +} + +struct Hash128([u64; 2]); + +impl FromStableHash for Hash128 { + type Hash = SipHasher128Hash; + + fn from(SipHasher128Hash(hash): SipHasher128Hash) -> Hash128 { + Hash128(hash) + } +} + +impl LowerHex for Hash128 { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + let Self(hash) = self; + + // Only write the first half for concision + write!(f, "{:x}", hash[0]) + } +} + +/// A single test inside a [`MarkdownTestSuite`]. +/// +/// A test is a single header section (or the implicit root section, if there are no Markdown +/// headers in the file), containing one or more embedded Python files as fenced code blocks, and +/// containing no nested header subsections. +#[derive(Debug)] +pub(crate) struct MarkdownTest<'m, 's> { + suite: &'m MarkdownTestSuite<'s>, + section: &'m Section<'s>, + files: &'m [EmbeddedFile<'s>], +} + +impl<'m, 's> MarkdownTest<'m, 's> { + const MAX_TITLE_LENGTH: usize = 20; + const ELLIPSIS: char = '\u{2026}'; + + fn contracted_title(title: &str) -> String { + if title.len() <= Self::MAX_TITLE_LENGTH { + return (*title).to_string(); + } + + format!( + "{}{}", + title + .chars() + .take(Self::MAX_TITLE_LENGTH) + .collect::<String>(), + Self::ELLIPSIS + ) + } + + fn joined_name(&self, contracted: bool) -> String { + let mut name_fragments = vec![]; + let mut parent_id = self.section.parent_id; + + while let Some(next_id) = parent_id { + let parent = &self.suite.sections[next_id]; + name_fragments.insert(0, parent.title); + parent_id = parent.parent_id; + } + + name_fragments.push(self.section.title); + + let full_name = name_fragments.join(" - "); + + if !contracted { + return full_name; + } + + let mut contracted_name = name_fragments + .iter() + .map(|fragment| Self::contracted_title(fragment)) + .collect::<Vec<_>>() + .join(" - "); + + let mut hasher = StableSipHasher128::new(); + full_name.hash(&mut hasher); + let _ = write!(contracted_name, " ({:x})", hasher.finish::<Hash128>()); + + contracted_name + } + + pub(crate) fn uncontracted_name(&self) -> String { + self.joined_name(false) + } + + pub(crate) fn name(&self) -> String { + self.joined_name(true) + } + + pub(crate) fn files(&self) -> impl Iterator<Item = &'m EmbeddedFile<'s>> { + self.files.iter() + } + + pub(crate) fn configuration(&self) -> &MarkdownTestConfig { + &self.section.config + } + + pub(super) fn should_snapshot_diagnostics(&self) -> bool { + self.section.snapshot_diagnostics + } +} + +/// Iterator yielding all [`MarkdownTest`]s in a [`MarkdownTestSuite`]. +#[derive(Debug)] +pub(crate) struct MarkdownTestIterator<'m, 's> { + suite: &'m MarkdownTestSuite<'s>, + current_file_index: usize, +} + +impl<'m, 's> Iterator for MarkdownTestIterator<'m, 's> { + type Item = MarkdownTest<'m, 's>; + + fn next(&mut self) -> Option<Self::Item> { + let mut current_file_index = self.current_file_index; + let mut file = self.suite.files.get(current_file_index.into()); + let section_id = file?.section; + while file.is_some_and(|file| file.section == section_id) { + current_file_index += 1; + file = self.suite.files.get(current_file_index.into()); + } + let files = &self.suite.files[EmbeddedFileId::from_usize(self.current_file_index) + ..EmbeddedFileId::from_usize(current_file_index)]; + self.current_file_index = current_file_index; + Some(MarkdownTest { + suite: self.suite, + section: &self.suite.sections[section_id], + files, + }) + } +} + +#[newtype_index] +struct SectionId; + +/// A single header section of a [`MarkdownTestSuite`], or the implicit root "section". +/// +/// A header section is the part of a Markdown file beginning with a `#`-prefixed header line, and +/// extending until the next header line at the same or higher outline level (that is, with the +/// same number or fewer `#` characters). +/// +/// A header section may either contain one or more embedded Python files (making it a +/// [`MarkdownTest`]), or it may contain nested sections (headers with more `#` characters), but +/// not both. +#[derive(Debug)] +struct Section<'s> { + title: &'s str, + level: u8, + parent_id: Option<SectionId>, + config: MarkdownTestConfig, + snapshot_diagnostics: bool, +} + +#[newtype_index] +struct EmbeddedFileId; + +/// Holds information about the start and the end of a code block in a Markdown file. +/// +/// The start is the offset of the first triple-backtick in the code block, and the end is the +/// offset of the (start of the) closing triple-backtick. +#[derive(Debug, Clone)] +pub(crate) struct BacktickOffsets(TextSize, TextSize); + +/// Holds information about the position and length of all code blocks that are part of +/// a single embedded file in a Markdown file. This is used to reconstruct absolute line +/// numbers (in the Markdown file) from relative line numbers (in the embedded file). +/// +/// If we have a Markdown section with multiple code blocks like this: +/// +/// 01 # Test +/// 02 +/// 03 Part 1: +/// 04 +/// 05 ```py +/// 06 a = 1 # Relative line number: 1 +/// 07 b = 2 # Relative line number: 2 +/// 08 ``` +/// 09 +/// 10 Part 2: +/// 11 +/// 12 ```py +/// 13 c = 3 # Relative line number: 3 +/// 14 ``` +/// +/// We want to reconstruct the absolute line number (left) from relative +/// line numbers. The information we have is the start line and the line +/// count of each code block: +/// +/// - Block 1: (start = 5, count = 2) +/// - Block 2: (start = 12, count = 1) +/// +/// For example, if we see a relative line number of 3, we see that it is +/// larger than the line count of the first block, so we subtract the line +/// count of the first block, and then add the new relative line number (1) +/// to the absolute start line of the second block (12), resulting in an +/// absolute line number of 13. +pub(crate) struct EmbeddedFileSourceMap { + start_line_and_line_count: Vec<(usize, usize)>, +} + +impl EmbeddedFileSourceMap { + pub(crate) fn new( + md_index: &LineIndex, + dimensions: impl IntoIterator<Item = BacktickOffsets>, + ) -> EmbeddedFileSourceMap { + EmbeddedFileSourceMap { + start_line_and_line_count: dimensions + .into_iter() + .map(|d| { + let start_line = md_index.line_index(d.0).get(); + let end_line = md_index.line_index(d.1).get(); + let code_line_count = (end_line - start_line) - 1; + (start_line, code_line_count) + }) + .collect(), + } + } + + pub(crate) fn to_absolute_line_number(&self, relative_line_number: OneIndexed) -> OneIndexed { + let mut absolute_line_number = 0; + let mut relative_line_number = relative_line_number.get(); + + for (start_line, line_count) in &self.start_line_and_line_count { + if relative_line_number > *line_count { + relative_line_number -= *line_count; + } else { + absolute_line_number = start_line + relative_line_number; + break; + } + } + + OneIndexed::new(absolute_line_number).expect("Relative line number out of bounds") + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub(crate) enum EmbeddedFilePath<'s> { + Autogenerated(PySourceType), + Explicit(&'s str), +} + +impl EmbeddedFilePath<'_> { + pub(crate) fn as_str(&self) -> &str { + match self { + EmbeddedFilePath::Autogenerated(PySourceType::Python) => "mdtest_snippet.py", + EmbeddedFilePath::Autogenerated(PySourceType::Stub) => "mdtest_snippet.pyi", + EmbeddedFilePath::Autogenerated(PySourceType::Ipynb) => "mdtest_snippet.ipynb", + EmbeddedFilePath::Explicit(path) => path, + } + } + + fn is_explicit(&self) -> bool { + matches!(self, EmbeddedFilePath::Explicit(_)) + } + + fn is_allowed_explicit_path(path: &str) -> bool { + [PySourceType::Python, PySourceType::Stub] + .iter() + .all(|source_type| path != EmbeddedFilePath::Autogenerated(*source_type).as_str()) + } +} + +/// A single file embedded in a [`Section`] as a fenced code block. +/// +/// Currently must be a Python file (`py` language), a type stub (`pyi`) or a [typeshed `VERSIONS`] +/// file. +/// +/// TOML configuration blocks are also supported, but are not stored as `EmbeddedFile`s. In the +/// future we plan to support `pth` files as well. +/// +/// A Python embedded file makes its containing [`Section`] into a [`MarkdownTest`], and will be +/// type-checked and searched for inline-comment assertions to match against the diagnostics from +/// type checking. +/// +/// [typeshed `VERSIONS`]: https://github.com/python/typeshed/blob/c546278aae47de0b2b664973da4edb613400f6ce/stdlib/VERSIONS#L1-L18 +#[derive(Debug)] +pub(crate) struct EmbeddedFile<'s> { + section: SectionId, + path: EmbeddedFilePath<'s>, + pub(crate) lang: &'s str, + pub(crate) code: Cow<'s, str>, + pub(crate) backtick_offsets: Vec<BacktickOffsets>, +} + +impl EmbeddedFile<'_> { + fn append_code(&mut self, backtick_offsets: BacktickOffsets, new_code: &str) { + // Treat empty code blocks as non-existent, instead of creating + // an additional empty line: + if new_code.is_empty() { + return; + } + + self.backtick_offsets.push(backtick_offsets); + + let existing_code = self.code.to_mut(); + existing_code.push('\n'); + existing_code.push_str(new_code); + } + + pub(crate) fn relative_path(&self) -> &str { + self.path.as_str() + } + + /// Returns the full path using unix file-path convention. + pub(crate) fn full_path(&self, project_root: &SystemPath) -> SystemPathBuf { + // Don't use `SystemPath::absolute` here because it's platform dependent + // and we want to use unix file-path convention. + let relative_path = self.relative_path(); + if relative_path.starts_with('/') { + SystemPathBuf::from(relative_path) + } else { + project_root.join(relative_path) + } + } +} + +#[derive(Debug)] +struct SectionStack(Vec<SectionId>); + +impl SectionStack { + fn new(root_section_id: SectionId) -> Self { + Self(vec![root_section_id]) + } + + fn push(&mut self, section_id: SectionId) { + self.0.push(section_id); + } + + fn pop(&mut self) -> Option<SectionId> { + let popped = self.0.pop(); + debug_assert_ne!(popped, None, "Should never pop the implicit root section"); + debug_assert!( + !self.0.is_empty(), + "Should never pop the implicit root section" + ); + popped + } + + fn top(&mut self) -> SectionId { + *self + .0 + .last() + .expect("Should never pop the implicit root section") + } +} + +/// Parse the source of a Markdown file into a [`MarkdownTestSuite`]. +#[derive(Debug)] +struct Parser<'s> { + /// [`Section`]s of the final [`MarkdownTestSuite`]. + sections: IndexVec<SectionId, Section<'s>>, + + /// [`EmbeddedFile`]s of the final [`MarkdownTestSuite`]. + files: IndexVec<EmbeddedFileId, EmbeddedFile<'s>>, + + /// The unparsed remainder of the Markdown source. + cursor: Cursor<'s>, + + // Number of consecutive empty lines. + preceding_blank_lines: usize, + + // Explicitly specified path for the upcoming code block. + explicit_path: Option<&'s str>, + + source: &'s str, + source_len: TextSize, + + /// Stack of ancestor sections. + stack: SectionStack, + + /// Names of embedded files in current active section. + current_section_files: FxHashMap<EmbeddedFilePath<'s>, EmbeddedFileId>, + + /// Whether or not the current section has a config block. + current_section_has_config: bool, +} + +impl<'s> Parser<'s> { + fn new(title: &'s str, source: &'s str) -> Self { + let mut sections = IndexVec::default(); + let root_section_id = sections.push(Section { + title, + level: 0, + parent_id: None, + config: MarkdownTestConfig::default(), + snapshot_diagnostics: false, + }); + Self { + sections, + source, + files: IndexVec::default(), + cursor: Cursor::new(source), + preceding_blank_lines: 0, + explicit_path: None, + source_len: source.text_len(), + stack: SectionStack::new(root_section_id), + current_section_files: FxHashMap::default(), + current_section_has_config: false, + } + } + + fn parse(mut self) -> anyhow::Result<MarkdownTestSuite<'s>> { + self.parse_impl()?; + Ok(self.finish()) + } + + fn finish(mut self) -> MarkdownTestSuite<'s> { + self.sections.shrink_to_fit(); + self.files.shrink_to_fit(); + + MarkdownTestSuite { + sections: self.sections, + files: self.files, + } + } + + fn skip_whitespace(&mut self) { + self.cursor.eat_while(|c| c.is_whitespace() && c != '\n'); + } + + fn skip_to_beginning_of_next_line(&mut self) -> bool { + if let Some(position) = memchr::memchr(b'\n', self.cursor.as_bytes()) { + self.cursor.skip_bytes(position + 1); + true + } else { + false + } + } + + fn consume_until(&mut self, mut end_predicate: impl FnMut(char) -> bool) -> Option<&'s str> { + let start = self.offset().to_usize(); + + while !self.cursor.is_eof() { + if end_predicate(self.cursor.first()) { + return Some(&self.source[start..self.offset().to_usize()]); + } + self.cursor.bump(); + } + + None + } + + fn parse_impl(&mut self) -> anyhow::Result<()> { + const SECTION_CONFIG_SNAPSHOT: &str = "snapshot-diagnostics"; + const HTML_COMMENT_ALLOWLIST: &[&str] = &["blacken-docs:on", "blacken-docs:off"]; + const CODE_BLOCK_END: &[u8] = b"```"; + const HTML_COMMENT_END: &[u8] = b"-->"; + + while let Some(first) = self.cursor.bump() { + match first { + '<' if self.cursor.eat_char3('!', '-', '-') => { + if let Some(position) = + memchr::memmem::find(self.cursor.as_bytes(), HTML_COMMENT_END) + { + let html_comment = self.cursor.as_str()[..position].trim(); + if html_comment == SECTION_CONFIG_SNAPSHOT { + self.process_snapshot_diagnostics()?; + } else if !HTML_COMMENT_ALLOWLIST.contains(&html_comment) { + bail!( + "Unknown HTML comment `{}` -- possibly a `snapshot-diagnostics` typo? \ + (Add to `HTML_COMMENT_ALLOWLIST` if this is a false positive)", + html_comment + ); + } + self.cursor.skip_bytes(position + HTML_COMMENT_END.len()); + } else { + bail!("Unterminated HTML comment."); + } + } + + '#' => { + self.explicit_path = None; + self.preceding_blank_lines = 0; + + // Determine header level (number of '#' characters) + let mut header_level = 1; + while self.cursor.eat_char('#') { + header_level += 1; + } + + // Parse header title + if let Some(title) = self.consume_until(|c| c == '\n') { + let title = title.trim(); + + if !title.is_empty() { + self.process_header(header_level, title)?; + } + } + } + '`' => { + if self.cursor.eat_char2('`', '`') { + // We saw the triple-backtick beginning of a code block. + + let backtick_offset_start = self.offset() - "```".text_len(); + + if self.preceding_blank_lines < 1 && self.explicit_path.is_none() { + bail!( + "Code blocks must start on a new line and be preceded by at least one blank line." + ); + } + + self.skip_whitespace(); + + // Parse the code block language specifier + let lang = self + .consume_until(|c| matches!(c, ' ' | '\n')) + .unwrap_or_default(); + + self.skip_whitespace(); + + if !self.cursor.eat_char('\n') { + bail!( + "Trailing code-block metadata is not supported. Only the code block language can be specified." + ); + } + + if let Some(position) = + memchr::memmem::find(self.cursor.as_bytes(), CODE_BLOCK_END) + { + let mut code = &self.cursor.as_str()[..position]; + self.cursor.skip_bytes(position + CODE_BLOCK_END.len()); + + if code.ends_with('\n') { + code = &code[..code.len() - '\n'.len_utf8()]; + } + + let backtick_offset_end = self.offset() - "```".text_len(); + + self.process_code_block( + lang, + code, + BacktickOffsets(backtick_offset_start, backtick_offset_end), + )?; + } else { + let code_block_start = self.cursor.token_len(); + let line = self.source.count_lines(TextRange::up_to(code_block_start)); + bail!("Unterminated code block at line {line}."); + } + + self.explicit_path = None; + } else if self.preceding_blank_lines > 0 { + // This could be a line that specifies an explicit path for a Markdown code block (`module.py`:) + self.explicit_path = None; + + if let Some(path) = self.consume_until(|c| matches!(c, '`' | '\n')) { + if self.cursor.eat_char('`') { + self.skip_whitespace(); + if self.cursor.eat_char(':') { + self.explicit_path = Some(path); + } + } + } + } + + self.preceding_blank_lines = 0; + } + '\n' => { + self.preceding_blank_lines += 1; + continue; + } + c => { + self.preceding_blank_lines = 0; + self.explicit_path = None; + + if c.is_whitespace() { + self.skip_whitespace(); + if self.cursor.eat_char('`') + && self.cursor.eat_char('`') + && self.cursor.eat_char('`') + { + bail!("Indented code blocks are not supported."); + } + } + } + } + + if !self.skip_to_beginning_of_next_line() { + break; + } + } + + Ok(()) + } + + fn process_header(&mut self, header_level: usize, title: &'s str) -> anyhow::Result<()> { + self.pop_sections_to_level(header_level); + + let parent = self.stack.top(); + + let section = Section { + title, + level: header_level.try_into()?, + parent_id: Some(parent), + config: self.sections[parent].config.clone(), + snapshot_diagnostics: self.sections[parent].snapshot_diagnostics, + }; + + if !self.current_section_files.is_empty() { + bail!( + "Header '{}' not valid inside a test case; parent '{}' has code files.", + section.title, + self.sections[parent].title, + ); + } + + let section_id = self.sections.push(section); + self.stack.push(section_id); + + self.current_section_files.clear(); + self.current_section_has_config = false; + + Ok(()) + } + + fn process_code_block( + &mut self, + lang: &'s str, + code: &'s str, + backtick_offsets: BacktickOffsets, + ) -> anyhow::Result<()> { + // We never pop the implicit root section. + let section = self.stack.top(); + let test_name = self.sections[section].title; + + if lang == "toml" { + return self.process_config_block(code); + } + + if lang == "ignore" { + return Ok(()); + } + + if let Some(explicit_path) = self.explicit_path { + let expected_extension = if lang == "python" { "py" } else { lang }; + + if !expected_extension.is_empty() + && lang != "text" + && !SystemPath::new(explicit_path) + .extension() + .is_none_or(|extension| extension.eq_ignore_ascii_case(expected_extension)) + { + let backtick_start = self.line_index(backtick_offsets.0); + bail!( + "File extension of test file path `{explicit_path}` in test `{test_name}` does not match language specified `{lang}` of code block at line `{backtick_start}`" + ); + } + } + + let path = match self.explicit_path { + Some(path) => { + if !EmbeddedFilePath::is_allowed_explicit_path(path) { + bail!( + "The file name `{path}` in test `{test_name}` must not be used explicitly.", + ); + } + + EmbeddedFilePath::Explicit(path) + } + None => match lang { + "py" | "python" => EmbeddedFilePath::Autogenerated(PySourceType::Python), + "pyi" => EmbeddedFilePath::Autogenerated(PySourceType::Stub), + "" => { + bail!( + "Cannot auto-generate file name for code block with empty language specifier in test `{test_name}`" + ); + } + _ => { + bail!( + "Cannot auto-generate file name for code block with language `{}` in test `{test_name}`", + lang + ); + } + }, + }; + + let has_merged_snippets = self.current_section_has_merged_snippets(); + let has_explicit_file_paths = self.current_section_has_explicit_file_paths(); + + match self.current_section_files.entry(path.clone()) { + Entry::Vacant(entry) => { + if has_merged_snippets { + bail!( + "Merged snippets in test `{test_name}` are not allowed in the presence of other files." + ); + } + + let index = self.files.push(EmbeddedFile { + path: path.clone(), + section, + lang, + code: Cow::Borrowed(code), + backtick_offsets: vec![backtick_offsets], + }); + entry.insert(index); + } + Entry::Occupied(entry) => { + if path.is_explicit() { + bail!( + "Test `{test_name}` has duplicate files named `{}`.", + path.as_str(), + ); + } + + if has_explicit_file_paths { + bail!( + "Merged snippets in test `{test_name}` are not allowed in the presence of other files." + ); + } + + let index = *entry.get(); + self.files[index].append_code(backtick_offsets, code); + } + } + + Ok(()) + } + + fn current_section_has_explicit_file_paths(&self) -> bool { + self.current_section_files + .iter() + .any(|(path, _)| path.is_explicit()) + } + + fn current_section_has_merged_snippets(&self) -> bool { + self.current_section_files + .values() + .any(|id| self.files[*id].backtick_offsets.len() > 1) + } + + fn process_config_block(&mut self, code: &str) -> anyhow::Result<()> { + if self.current_section_has_config { + bail!("Multiple TOML configuration blocks in the same section are not allowed."); + } + + let current_section = &mut self.sections[self.stack.top()]; + current_section.config = MarkdownTestConfig::from_str(code)?; + + self.current_section_has_config = true; + + Ok(()) + } + + fn process_snapshot_diagnostics(&mut self) -> anyhow::Result<()> { + if self.current_section_has_config { + bail!( + "Section config to enable snapshotting diagnostics must come before \ + everything else (including TOML configuration blocks).", + ); + } + if !self.current_section_files.is_empty() { + bail!( + "Section config to enable snapshotting diagnostics must come before \ + everything else (including embedded files).", + ); + } + + let current_section = &mut self.sections[self.stack.top()]; + if current_section.snapshot_diagnostics { + bail!( + "Section config to enable snapshotting diagnostics should appear \ + at most once.", + ); + } + current_section.snapshot_diagnostics = true; + + Ok(()) + } + + fn pop_sections_to_level(&mut self, level: usize) { + while level <= self.sections[self.stack.top()].level.into() { + self.stack.pop(); + // We would have errored before pushing a child section if there were files, so we know + // no parent section can have files. + self.current_section_files.clear(); + } + } + + /// Retrieves the current offset of the cursor within the source code. + fn offset(&self) -> TextSize { + self.source_len - self.cursor.text_len() + } + + fn line_index(&self, char_index: TextSize) -> u32 { + self.source.count_lines(TextRange::up_to(char_index)) + } +} + +#[cfg(test)] +mod tests { + use ruff_python_ast::PySourceType; + use ruff_python_trivia::textwrap::dedent; + + use insta::assert_snapshot; + + use crate::parser::EmbeddedFilePath; + + #[test] + fn empty() { + let mf = super::parse("file.md", "").unwrap(); + + assert!(mf.tests().next().is_none()); + } + + #[test] + fn single_file_test() { + let source = dedent( + " + ```py + x = 1 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + + assert_snapshot!(test.name(), @"file.md (a8decfe8bd23e259)"); + + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn no_new_line_at_eof() { + let source = dedent( + " + ```py + x = 1 + ```", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + + assert_snapshot!(test.name(), @"file.md (a8decfe8bd23e259)"); + + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn multiple_tests() { + let source = dedent( + " + # One + + ```py + x = 1 + ``` + + # Two + + ```py + y = 2 + ``` + + # Three + + `mod_a.pyi`: + + ```pyi + a: int + ``` + + `mod_b.pyi`: + + ```pyi + b: str + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test1, test2, test3] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected three tests"); + }; + + assert_snapshot!(test1.name(), @"file.md - One (9f620a533a21278)"); + assert_snapshot!(test2.name(), @"file.md - Two (1b4d4ef5a2cebbdc)"); + assert_snapshot!(test3.name(), @"file.md - Three (26479e23633dda57)"); + + let [file] = test1.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "x = 1"); + + let [file] = test2.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "y = 2"); + + let [file_1, file_2] = test3.files().collect::<Vec<_>>()[..] else { + panic!("expected two files"); + }; + + assert_eq!(file_1.relative_path(), "mod_a.pyi"); + assert_eq!(file_1.lang, "pyi"); + assert_eq!(file_1.code, "a: int"); + + assert_eq!(file_2.relative_path(), "mod_b.pyi"); + assert_eq!(file_2.lang, "pyi"); + assert_eq!(file_2.code, "b: str"); + } + + #[test] + fn multiple_file_tests() { + let source = dedent( + " + # One + + `main.py`: + + ```py + from foo import y + ``` + + `foo.py`: + + ```py + y = 2 + ``` + + # Two + + ```py + y = 2 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test1, test2] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected two tests"); + }; + + assert_snapshot!(test1.name(), @"file.md - One (9f620a533a21278)"); + assert_snapshot!(test2.name(), @"file.md - Two (1b4d4ef5a2cebbdc)"); + + let [main, foo] = test1.files().collect::<Vec<_>>()[..] else { + panic!("expected two files"); + }; + + assert_eq!(main.relative_path(), "main.py"); + assert_eq!(main.lang, "py"); + assert_eq!(main.code, "from foo import y"); + + assert_eq!(foo.relative_path(), "foo.py"); + assert_eq!(foo.lang, "py"); + assert_eq!(foo.code, "y = 2"); + + let [file] = test2.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "y = 2"); + } + + #[test] + fn merged_snippets() { + let source = dedent( + " + # One + + This is the first part of the embedded file: + + ```py + x = 1 + ``` + + And this is the second part: + + ```py + y = 2 + ``` + + And this is the third part: + + ```py + z = 3 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "x = 1\ny = 2\nz = 3"); + } + + #[test] + fn no_merged_snippets_for_explicit_paths() { + let source = dedent( + " + # One + + `foo.py`: + + ```py + x = 1 + ``` + + `foo.py`: + + ```py + y = 2 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Test `One` has duplicate files named `foo.py`." + ); + } + + #[test] + fn disallow_merged_snippets_in_presence_of_explicit_paths() { + for source in [ + // Merged snippets first + " + # One + + ```py + x = 1 + ``` + + ```py + y = 2 + ``` + + `foo.py`: + + ```py + print('hello') + ``` + ", + // Explicit path first + " + # One + + `foo.py`: + + ```py + print('hello') + ``` + + ```py + x = 1 + ``` + + ```py + y = 2 + ``` + ", + ] { + let err = super::parse("file.md", &dedent(source)).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Merged snippets in test `One` are not allowed in the presence of other files." + ); + } + } + + #[test] + fn disallow_pyi_snippets_in_presence_of_merged_py_snippets() { + let source = dedent( + " + # One + + ```py + x = 1 + ``` + + ```py + y = 2 + ``` + + ```pyi + x: int + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Merged snippets in test `One` are not allowed in the presence of other files." + ); + } + + #[test] + fn custom_file_path() { + let source = dedent( + " + `foo.py`: + + ```py + x = 1 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "foo.py"); + assert_eq!(file.lang, "py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn multi_line_file() { + let source = dedent( + " + ```py + x = 1 + y = 2 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.code, "x = 1\ny = 2"); + } + + #[test] + fn empty_file() { + let source = dedent( + " + ```py + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.code, ""); + } + + #[test] + fn no_lang() { + let source = dedent( + " + # No language specifier + + ``` + x = 10 + ``` + ", + ); + + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Cannot auto-generate file name for code block with empty language specifier in test `No language specifier`" + ); + } + + #[test] + fn cannot_generate_name_for_lang() { + let source = dedent( + " + # JSON test? + + ```json + {} + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Cannot auto-generate file name for code block with language `json` in test `JSON test?`" + ); + } + + #[test] + fn mismatching_lang() { + let source = dedent( + " + # Accidental stub + + `a.py`: + + ```pyi + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "File extension of test file path `a.py` in test `Accidental stub` does not match language specified `pyi` of code block at line `5`" + ); + } + + #[test] + fn files_with_no_extension_can_have_any_lang() { + let source = dedent( + " + `lorem`: + + ```foo + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "lorem"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn files_with_lang_text_can_have_any_paths() { + let source = dedent( + " + `lorem.yaml`: + + ```text + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "lorem.yaml"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn unterminated_code_block_1() { + let source = dedent( + " + ``` + x = 1 + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!(err.to_string(), "Unterminated code block at line 2."); + } + + #[test] + fn unterminated_code_block_2() { + let source = dedent( + " + ## A well-fenced block + + ```py + y = 2 + ``` + + ## A not-so-well-fenced block + + ```py + x = 1 + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!(err.to_string(), "Unterminated code block at line 10."); + } + + #[test] + fn header_start_at_beginning_of_line() { + let source = dedent( + " + # A test + + # not a header + + ```py + x = 1 + ``` + ", + ); + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + + assert_snapshot!(test.name(), @"file.md - A test (1b4e27e6123dc8e7)"); + } + + #[test] + fn code_blocks_must_not_be_indented() { + let source = dedent( + " + # A test? + + ```py + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!(err.to_string(), "Indented code blocks are not supported."); + } + + #[test] + fn no_header_inside_test() { + let source = dedent( + " + # One + + ```py + x = 1 + ``` + + ## Two + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Header 'Two' not valid inside a test case; parent 'One' has code files." + ); + } + + #[test] + fn line_break_in_header_1() { + let source = dedent( + " + # + Foo + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(test.section.title, "file.md"); + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn line_break_in_header_2() { + let source = dedent( + " + # Foo + + ## + Lorem + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(test.section.title, "Foo"); + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn no_duplicate_name_files_in_test() { + let source = dedent( + " + `foo.py`: + + ```py + x = 1 + ``` + + `foo.py`: + + ```py + y = 2 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Test `file.md` has duplicate files named `foo.py`." + ); + } + + #[test] + fn no_usage_of_autogenerated_name() { + let source = dedent( + " + # Name clash + + `mdtest_snippet.py`: + + ```py + x = 1 + ``` + + ```py + y = 2 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "The file name `mdtest_snippet.py` in test `Name clash` must not be used explicitly." + ); + } + + #[test] + fn separate_path() { + let source = dedent( + " + `foo.py`: + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "foo.py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn separate_path_whitespace_1() { + let source = dedent( + " + `foo.py` : + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "foo.py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn separate_path_whitespace_2() { + let source = dedent( + " + `foo.py`: + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "foo.py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn path_with_space() { + let source = dedent( + " + `foo bar.py`: + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!(file.relative_path(), "foo bar.py"); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn path_with_line_break() { + let source = dedent( + " + `foo + .py`: + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn path_with_backtick() { + let source = dedent( + " + `foo`bar.py`: + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn path_colon_on_next_line() { + let source = dedent( + " + `foo.py` + : + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn random_trailing_backtick_quoted() { + let source = dedent( + " + A long sentence that forces a line break + `int`: + + ```py + x = 1 + ``` + ", + ); + + let mf = super::parse("file.md", &source).unwrap(); + + let [test] = &mf.tests().collect::<Vec<_>>()[..] else { + panic!("expected one test"); + }; + let [file] = test.files().collect::<Vec<_>>()[..] else { + panic!("expected one file"); + }; + + assert_eq!( + file.path, + EmbeddedFilePath::Autogenerated(PySourceType::Python) + ); + assert_eq!(file.code, "x = 1"); + } + + #[test] + fn no_newline_between_prose_and_code() { + // Regression test for https://github.com/astral-sh/ruff/issues/15923 + let source = dedent( + " + Some code: + No newline between prose and code: + ```py + # A syntax error: + § + ``` + ", + ); + + super::parse("file.md", &source).expect_err( + "Code blocks must start on a new line and be preceded by at least one blank line.", + ); + } + + #[test] + fn config_no_longer_allowed() { + let source = dedent( + " + ```py foo=bar + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Trailing code-block metadata is not supported. Only the code block language can be specified." + ); + } + + #[test] + fn duplicate_section_directive_not_allowed() { + let source = dedent( + " + # Some header + + <!-- snapshot-diagnostics --> + <!-- snapshot-diagnostics --> + + ```py + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Section config to enable snapshotting diagnostics should appear at most once.", + ); + } + + #[test] + fn snapshot_diagnostic_directive_detection_ignores_whitespace() { + // A bit weird, but the fact that the parser rejects this indicates that + // we have correctly recognised both of these HTML comments as a directive to have + // snapshotting enabled for the file, which is what we want (even though they both + // contain different amounts of whitespace to the "standard" snapshot directive). + let source = dedent( + " + # Some header + + <!-- snapshot-diagnostics --> + <!--snapshot-diagnostics--> + + ```py + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Section config to enable snapshotting diagnostics should appear at most once.", + ); + } + + #[test] + fn section_directive_must_appear_before_config() { + let source = dedent( + " + # Some header + + ```toml + [environment] + typeshed = \"/typeshed\" + ``` + + <!-- snapshot-diagnostics --> + + ```py + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Section config to enable snapshotting diagnostics must \ + come before everything else \ + (including TOML configuration blocks).", + ); + } + + #[test] + fn section_directive_must_appear_before_embedded_files() { + let source = dedent( + " + # Some header + + ```py + x = 1 + ``` + + <!-- snapshot-diagnostics --> + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Section config to enable snapshotting diagnostics must \ + come before everything else \ + (including embedded files).", + ); + } + + #[test] + fn obvious_typos_in_directives_are_detected() { + let source = dedent( + " + # Some header + <!-- snpshotttt-digggggnosstic --> + ```py + x = 1 + ``` + ", + ); + let err = super::parse("file.md", &source).expect_err("Should fail to parse"); + assert_eq!( + err.to_string(), + "Unknown HTML comment `snpshotttt-digggggnosstic` -- possibly a `snapshot-diagnostics` typo? \ + (Add to `HTML_COMMENT_ALLOWLIST` if this is a false positive)", + ); + } + + #[test] + fn allowlisted_html_comments_are_permitted() { + let source = dedent( + " + # Some header + <!-- blacken-docs:off --> + + ```py + x = 1 + ``` + + <!-- blacken-docs:on --> + ", + ); + let parse_result = super::parse("file.md", &source); + assert!(parse_result.is_ok(), "{parse_result:?}"); + } +} diff --git a/crates/ty_vendored/.gitignore b/crates/ty_vendored/.gitignore new file mode 100644 index 0000000000000..fcf1008688c1a --- /dev/null +++ b/crates/ty_vendored/.gitignore @@ -0,0 +1,4 @@ +# Do not ignore any of the vendored files. If this pattern is not present, +# we will gitignore the `venv/` stubs in typeshed, as there is a general +# rule to ignore `venv/` directories in the root `.gitignore`. +!/vendor/typeshed/**/* diff --git a/crates/ty_vendored/Cargo.toml b/crates/ty_vendored/Cargo.toml new file mode 100644 index 0000000000000..bd8f8e175bfd7 --- /dev/null +++ b/crates/ty_vendored/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "ty_vendored" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } + +[dependencies] +ruff_db = { workspace = true } +zip = { workspace = true } + +[build-dependencies] +path-slash = { workspace = true } +walkdir = { workspace = true } +zip = { workspace = true, features = ["zstd", "deflate"] } + +[dev-dependencies] +walkdir = { workspace = true } + +[features] +zstd = ["zip/zstd"] +deflate = ["zip/deflate"] + +[lints] +workspace = true + diff --git a/crates/ty_vendored/README.md b/crates/ty_vendored/README.md new file mode 100644 index 0000000000000..40ab2fc04f18f --- /dev/null +++ b/crates/ty_vendored/README.md @@ -0,0 +1,5 @@ +# Vendored types for the stdlib + +This crate vendors [typeshed](https://github.com/python/typeshed)'s stubs for the standard library. The vendored stubs can be found in `crates/ty_vendored/vendor/typeshed`. The file `crates/ty_vendored/vendor/typeshed/source_commit.txt` tells you the typeshed commit that our vendored stdlib stubs currently correspond to. + +The typeshed stubs are updated every two weeks via an automated PR using the `sync_typeshed.yaml` workflow in the `.github/workflows` directory. This workflow can also be triggered at any time via [workflow dispatch](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow#running-a-workflow). diff --git a/crates/ty_vendored/build.rs b/crates/ty_vendored/build.rs new file mode 100644 index 0000000000000..5c65c09848517 --- /dev/null +++ b/crates/ty_vendored/build.rs @@ -0,0 +1,103 @@ +//! Build script to package our vendored typeshed files +//! into a zip archive that can be included in the Ruff binary. +//! +//! This script should be automatically run at build time +//! whenever the script itself changes, or whenever any files +//! in `crates/ty_vendored/vendor/typeshed` change. + +use std::fs::File; +use std::io::Write; +use std::path::Path; + +use path_slash::PathExt; +use zip::CompressionMethod; +use zip::result::ZipResult; +use zip::write::{FileOptions, ZipWriter}; + +const TYPESHED_SOURCE_DIR: &str = "vendor/typeshed"; +const TY_EXTENSIONS_STUBS: &str = "ty_extensions/ty_extensions.pyi"; +const TYPESHED_ZIP_LOCATION: &str = "/zipped_typeshed.zip"; + +/// Recursively zip the contents of the entire typeshed directory and patch typeshed +/// on the fly to include the `ty_extensions` module. +/// +/// This routine is adapted from a recipe at +/// <https://github.com/zip-rs/zip-old/blob/5d0f198124946b7be4e5969719a7f29f363118cd/examples/write_dir.rs> +fn write_zipped_typeshed_to(writer: File) -> ZipResult<File> { + let mut zip = ZipWriter::new(writer); + + // Use deflated compression for WASM builds because compiling `zstd-sys` requires clang + // [source](https://github.com/gyscos/zstd-rs/wiki/Compile-for-WASM) which complicates the build + // by a lot. Deflated compression is slower but it shouldn't matter much for the WASM use case + // (WASM itself is already slower than a native build for a specific platform). + // We can't use `#[cfg(...)]` here because the target-arch in a build script is the + // architecture of the system running the build script and not the architecture of the build-target. + // That's why we use the `TARGET` environment variable here. + let method = if cfg!(feature = "zstd") { + CompressionMethod::Zstd + } else if cfg!(feature = "deflate") { + CompressionMethod::Deflated + } else { + CompressionMethod::Stored + }; + + let options = FileOptions::default() + .compression_method(method) + .unix_permissions(0o644); + + for entry in walkdir::WalkDir::new(TYPESHED_SOURCE_DIR) { + let dir_entry = entry.unwrap(); + let absolute_path = dir_entry.path(); + let normalized_relative_path = absolute_path + .strip_prefix(Path::new(TYPESHED_SOURCE_DIR)) + .unwrap() + .to_slash() + .expect("Unexpected non-utf8 typeshed path!"); + + // Write file or directory explicitly + // Some unzip tools unzip files with directory paths correctly, some do not! + if absolute_path.is_file() { + println!("adding file {absolute_path:?} as {normalized_relative_path:?} ..."); + zip.start_file(&*normalized_relative_path, options)?; + let mut f = File::open(absolute_path)?; + std::io::copy(&mut f, &mut zip).unwrap(); + + // Patch the VERSIONS file to make `ty_extensions` available + if normalized_relative_path == "stdlib/VERSIONS" { + writeln!(&mut zip, "ty_extensions: 3.0-")?; + } + } else if !normalized_relative_path.is_empty() { + // Only if not root! Avoids path spec / warning + // and mapname conversion failed error on unzip + println!("adding dir {absolute_path:?} as {normalized_relative_path:?} ..."); + zip.add_directory(normalized_relative_path, options)?; + } + } + + // Patch typeshed and add the stubs for the `ty_extensions` module + println!("adding file {TY_EXTENSIONS_STUBS} as stdlib/ty_extensions.pyi ..."); + zip.start_file("stdlib/ty_extensions.pyi", options)?; + let mut f = File::open(TY_EXTENSIONS_STUBS)?; + std::io::copy(&mut f, &mut zip).unwrap(); + + zip.finish() +} + +fn main() { + assert!( + Path::new(TYPESHED_SOURCE_DIR).is_dir(), + "Where is typeshed?" + ); + let out_dir = std::env::var("OUT_DIR").unwrap(); + + // N.B. Deliberately using `format!()` instead of `Path::join()` here, + // so that we use `/` as a path separator on all platforms. + // That enables us to load the typeshed zip at compile time in `module.rs` + // (otherwise we'd have to dynamically determine the exact path to the typeshed zip + // based on the default path separator for the specific platform we're on, + // which can't be done at compile time.) + let zipped_typeshed_location = format!("{out_dir}{TYPESHED_ZIP_LOCATION}"); + + let zipped_typeshed_file = File::create(zipped_typeshed_location).unwrap(); + write_zipped_typeshed_to(zipped_typeshed_file).unwrap(); +} diff --git a/crates/red_knot_vendored/src/lib.rs b/crates/ty_vendored/src/lib.rs similarity index 100% rename from crates/red_knot_vendored/src/lib.rs rename to crates/ty_vendored/src/lib.rs diff --git a/crates/ty_vendored/ty_extensions/README.md b/crates/ty_vendored/ty_extensions/README.md new file mode 100644 index 0000000000000..594f6c98faea0 --- /dev/null +++ b/crates/ty_vendored/ty_extensions/README.md @@ -0,0 +1,2 @@ +The `build.rs` copies the `ty_extensions.pyi` file in this directory into +the `vendor/typeshed/stdlib` directory. diff --git a/crates/ty_vendored/ty_extensions/ty_extensions.pyi b/crates/ty_vendored/ty_extensions/ty_extensions.pyi new file mode 100644 index 0000000000000..0ed447e11237b --- /dev/null +++ b/crates/ty_vendored/ty_extensions/ty_extensions.pyi @@ -0,0 +1,36 @@ +from typing import Any, LiteralString, _SpecialForm + +# Special operations +def static_assert(condition: object, msg: LiteralString | None = None) -> None: ... + +# Types +Unknown = object() +AlwaysTruthy = object() +AlwaysFalsy = object() + +# Special forms +Not: _SpecialForm +Intersection: _SpecialForm +TypeOf: _SpecialForm +CallableTypeOf: _SpecialForm + +# Predicates on types +# +# Ideally, these would be annotated using `TypeForm`, but that has not been +# standardized yet (https://peps.python.org/pep-0747). +def is_equivalent_to(type_a: Any, type_b: Any) -> bool: ... +def is_subtype_of(type_derived: Any, type_base: Any) -> bool: ... +def is_assignable_to(type_target: Any, type_source: Any) -> bool: ... +def is_disjoint_from(type_a: Any, type_b: Any) -> bool: ... +def is_gradual_equivalent_to(type_a: Any, type_b: Any) -> bool: ... +def is_fully_static(type: Any) -> bool: ... +def is_singleton(type: Any) -> bool: ... +def is_single_valued(type: Any) -> bool: ... + +# Returns the generic context of a type as a tuple of typevars, or `None` if the +# type is not generic. +def generic_context(type: Any) -> Any: ... + +# Returns the `__all__` names of a module as a tuple of sorted strings, or `None` if +# either the module does not have `__all__` or it has invalid elements. +def dunder_all_names(module: Any) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/LICENSE b/crates/ty_vendored/vendor/typeshed/LICENSE similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/LICENSE rename to crates/ty_vendored/vendor/typeshed/LICENSE diff --git a/crates/ty_vendored/vendor/typeshed/README.md b/crates/ty_vendored/vendor/typeshed/README.md new file mode 100644 index 0000000000000..ee09529b967ac --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/README.md @@ -0,0 +1,124 @@ +# typeshed + +[![Tests](https://github.com/python/typeshed/actions/workflows/tests.yml/badge.svg)](https://github.com/python/typeshed/actions/workflows/tests.yml) +[![Chat at https://gitter.im/python/typing](https://badges.gitter.im/python/typing.svg)](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Pull Requests Welcome](https://img.shields.io/badge/pull%20requests-welcome-brightgreen.svg)](https://github.com/python/typeshed/blob/main/CONTRIBUTING.md) + +## About + +Typeshed contains external type annotations for the Python standard library +and Python builtins, as well as third party packages as contributed by +people external to those projects. + +This data can e.g. be used for static analysis, type checking, type inference, +and autocompletion. + +For information on how to use typeshed, read below. Information for +contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md). **Please read +it before submitting pull requests; do not report issues with annotations to +the project the stubs are for, but instead report them here to typeshed.** + +Further documentation on stub files, typeshed, and Python's typing system in +general, can also be found at https://typing.readthedocs.io/en/latest/. + +Typeshed supports Python versions 3.9 to 3.14. + +## Using + +If you're just using a type checker ([mypy](https://github.com/python/mypy/), +[pyright](https://github.com/microsoft/pyright), +[pytype](https://github.com/google/pytype/), PyCharm, ...), as opposed to +developing it, you don't need to interact with the typeshed repo at +all: a copy of standard library part of typeshed is bundled with type checkers. +And type stubs for third party packages and modules you are using can +be installed from PyPI. For example, if you are using `html5lib` and `requests`, +you can install the type stubs using + +```bash +$ pip install types-html5lib types-requests +``` + +These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/) +and are automatically released (up to once a day) by +[typeshed internal machinery](https://github.com/typeshed-internal/stub_uploader). + +Type checkers should be able to use these stub packages when installed. For more +details, see the documentation for your type checker. + +### Package versioning for third-party stubs + +Version numbers of third-party stub packages consist of at least four parts. +All parts of the stub version, except for the last part, correspond to the +version of the runtime package being stubbed. For example, if the `types-foo` +package has version `1.2.0.20240309`, this guarantees that the `types-foo` package +contains stubs targeted against `foo==1.2.*` and tested against the latest +version of `foo` matching that specifier. In this example, the final element +of the version number (20240309) indicates that the stub package was pushed on +March 9, 2024. + +At typeshed, we try to keep breaking changes to a minimum. However, due to the +nature of stubs, any version bump can introduce changes that might make your +code fail to type check. + +There are several strategies available for specifying the version of a stubs +package you're using, each with its own tradeoffs: + +1. Use the same bounds that you use for the package being stubbed. For example, + if you use `requests>=2.30.0,<2.32`, you can use + `types-requests>=2.30.0,<2.32`. This ensures that the stubs are compatible + with the package you are using, but it carries a small risk of breaking + type checking due to changes in the stubs. + + Another risk of this strategy is that stubs often lag behind + the package being stubbed. You might want to force the package being stubbed + to a certain minimum version because it fixes a critical bug, but if + correspondingly updated stubs have not been released, your type + checking results may not be fully accurate. +2. Pin the stubs to a known good version and update the pin from time to time + (either manually, or using a tool such as dependabot or renovate). + + For example, if you use `types-requests==2.31.0.1`, you can have confidence + that upgrading dependencies will not break type checking. However, you will + miss out on improvements in the stubs that could potentially improve type + checking until you update the pin. This strategy also has the risk that the + stubs you are using might become incompatible with the package being stubbed. +3. Don't pin the stubs. This is the option that demands the least work from + you when it comes to updating version pins, and has the advantage that you + will automatically benefit from improved stubs whenever a new version of the + stubs package is released. However, it carries the risk that the stubs + become incompatible with the package being stubbed. + + For example, if a new major version of the package is released, there's a + chance the stubs might be updated to reflect the new version of the runtime + package before you update the package being stubbed. + +You can also switch between the different strategies as needed. For example, +you could default to strategy (1), but fall back to strategy (2) when +a problem arises that can't easily be fixed. + +### The `_typeshed` package + +typeshed includes a package `_typeshed` as part of the standard library. +This package and its submodules contain utility types, but are not +available at runtime. For more information about how to use this package, +[see the `stdlib/_typeshed` directory](https://github.com/python/typeshed/tree/main/stdlib/_typeshed). + +## Discussion + +If you've run into behavior in the type checker that suggests the type +stubs for a given library are incorrect or incomplete, +we want to hear from you! + +Our main forum for discussion is the project's [GitHub issue +tracker](https://github.com/python/typeshed/issues). This is the right +place to start a discussion of any of the above or most any other +topic concerning the project. + +If you have general questions about typing with Python, or you need +a review of your type annotations or stubs outside of typeshed, head over to +[our discussion forum](https://github.com/python/typing/discussions). +For less formal discussion, try the typing chat room on +[gitter.im](https://gitter.im/python/typing). Some typeshed maintainers +are almost always present; feel free to find us there and we're happy +to chat. Substantive technical discussion will be directed to the +issue tracker. diff --git a/crates/ty_vendored/vendor/typeshed/source_commit.txt b/crates/ty_vendored/vendor/typeshed/source_commit.txt new file mode 100644 index 0000000000000..fdd24bb31d910 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/source_commit.txt @@ -0,0 +1 @@ +1063db7c15135c172f1f6a81d3aff6d1cb00a980 diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS b/crates/ty_vendored/vendor/typeshed/stdlib/VERSIONS similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS rename to crates/ty_vendored/vendor/typeshed/stdlib/VERSIONS index ed23ee6ddcea5..1ecd8af645595 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS +++ b/crates/ty_vendored/vendor/typeshed/stdlib/VERSIONS @@ -22,17 +22,24 @@ __main__: 3.0- _ast: 3.0- _asyncio: 3.0- _bisect: 3.0- +_blake2: 3.6- _bootlocale: 3.4-3.9 +_bz2: 3.3- _codecs: 3.0- _collections_abc: 3.3- _compat_pickle: 3.1- -_compression: 3.5- +_compression: 3.5-3.13 +_contextvars: 3.7- _csv: 3.0- _ctypes: 3.0- _curses: 3.0- +_curses_panel: 3.0- +_dbm: 3.0- _decimal: 3.3- -_dummy_thread: 3.0-3.8 -_dummy_threading: 3.0-3.8 +_frozen_importlib: 3.0- +_frozen_importlib_external: 3.5- +_gdbm: 3.0- +_hashlib: 3.0- _heapq: 3.0- _imp: 3.0- _interpchannels: 3.13- @@ -42,19 +49,24 @@ _io: 3.0- _json: 3.0- _locale: 3.0- _lsprof: 3.0- +_lzma: 3.3- _markupbase: 3.0- _msi: 3.0-3.12 +_multibytecodec: 3.0- _operator: 3.4- _osx_support: 3.0- +_pickle: 3.0- _posixsubprocess: 3.2- _py_abc: 3.7- _pydecimal: 3.5- +_queue: 3.7- _random: 3.0- _sitebuiltins: 3.4- _socket: 3.0- # present in 3.0 at runtime, but not in typeshed _sqlite3: 3.0- _ssl: 3.0- _stat: 3.4- +_struct: 3.0- _thread: 3.0- _threading_local: 3.0- _tkinter: 3.0- @@ -66,6 +78,7 @@ _weakrefset: 3.0- _winapi: 3.3- abc: 3.0- aifc: 3.0-3.12 +annotationlib: 3.14- antigravity: 3.0- argparse: 3.0- array: 3.0- @@ -74,6 +87,7 @@ asynchat: 3.0-3.11 asyncio: 3.4- asyncio.exceptions: 3.8- asyncio.format_helpers: 3.7- +asyncio.graph: 3.14- asyncio.mixins: 3.10- asyncio.runners: 3.7- asyncio.staggered: 3.8- @@ -105,7 +119,9 @@ collections: 3.0- collections.abc: 3.3- colorsys: 3.0- compileall: 3.0- +compression: 3.14- concurrent: 3.2- +concurrent.futures.interpreter: 3.14- configparser: 3.0- contextlib: 3.0- contextvars: 3.7- @@ -126,9 +142,13 @@ distutils: 3.0-3.11 distutils.command.bdist_msi: 3.0-3.10 distutils.command.bdist_wininst: 3.0-3.9 doctest: 3.0- -dummy_threading: 3.0-3.8 email: 3.0- encodings: 3.0- +encodings.cp1125: 3.4- +encodings.cp273: 3.4- +encodings.cp858: 3.2- +encodings.koi8_t: 3.5- +encodings.kz1048: 3.5- ensurepip: 3.0- enum: 3.4- errno: 3.0- @@ -160,6 +180,8 @@ imghdr: 3.0-3.12 imp: 3.0-3.11 importlib: 3.0- importlib._abc: 3.10- +importlib._bootstrap: 3.0- +importlib._bootstrap_external: 3.5- importlib.metadata: 3.8- importlib.metadata._meta: 3.10- importlib.metadata.diagnose: 3.13- @@ -208,6 +230,7 @@ os: 3.0- ossaudiodev: 3.0-3.12 parser: 3.0-3.9 pathlib: 3.4- +pathlib.types: 3.14- pdb: 3.0- pickle: 3.0- pickletools: 3.0- @@ -260,6 +283,7 @@ ssl: 3.0- stat: 3.0- statistics: 3.4- string: 3.0- +string.templatelib: 3.14- stringprep: 3.0- struct: 3.0- subprocess: 3.0- diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/__future__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/__future__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/__future__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/__future__.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/__main__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/__main__.pyi new file mode 100644 index 0000000000000..5b0f74feb261b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/__main__.pyi @@ -0,0 +1 @@ +def __getattr__(name: str): ... # incomplete module diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ast.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_ast.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_ast.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_ast.pyi index 8dc1bcbea32c5..00c6b357f7d80 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ast.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_ast.pyi @@ -111,13 +111,20 @@ from ast import ( from typing import Literal if sys.version_info >= (3, 12): - from ast import ParamSpec as ParamSpec, TypeVar as TypeVar, TypeVarTuple as TypeVarTuple, type_param as type_param + from ast import ( + ParamSpec as ParamSpec, + TypeAlias as TypeAlias, + TypeVar as TypeVar, + TypeVarTuple as TypeVarTuple, + type_param as type_param, + ) if sys.version_info >= (3, 11): from ast import TryStar as TryStar if sys.version_info >= (3, 10): from ast import ( + Match as Match, MatchAs as MatchAs, MatchClass as MatchClass, MatchMapping as MatchMapping, @@ -130,17 +137,6 @@ if sys.version_info >= (3, 10): pattern as pattern, ) -if sys.version_info < (3, 9): - from ast import ( - AugLoad as AugLoad, - AugStore as AugStore, - ExtSlice as ExtSlice, - Index as Index, - Param as Param, - Suite as Suite, - slice as slice, - ) - PyCF_ALLOW_TOP_LEVEL_AWAIT: Literal[8192] PyCF_ONLY_AST: Literal[1024] PyCF_TYPE_COMMENTS: Literal[4096] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_asyncio.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_asyncio.pyi similarity index 79% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_asyncio.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_asyncio.pyi index 18920cd8a8a48..be486fddb12da 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_asyncio.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_asyncio.pyi @@ -1,19 +1,16 @@ import sys from asyncio.events import AbstractEventLoop -from collections.abc import Awaitable, Callable, Coroutine, Generator, Iterable +from collections.abc import Awaitable, Callable, Coroutine, Generator from contextvars import Context -from types import FrameType +from types import FrameType, GenericAlias from typing import Any, Literal, TextIO, TypeVar from typing_extensions import Self, TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - _T = TypeVar("_T") _T_co = TypeVar("_T_co", covariant=True) _TaskYieldType: TypeAlias = Future[object] | None -class Future(Awaitable[_T], Iterable[_T]): +class Future(Awaitable[_T]): _state: str @property def _exception(self) -> BaseException | None: ... @@ -29,11 +26,7 @@ class Future(Awaitable[_T], Iterable[_T]): @property def _callbacks(self) -> list[tuple[Callable[[Self], Any], Context]]: ... def add_done_callback(self, fn: Callable[[Self], object], /, *, context: Context | None = None) -> None: ... - if sys.version_info >= (3, 9): - def cancel(self, msg: Any | None = None) -> bool: ... - else: - def cancel(self) -> bool: ... - + def cancel(self, msg: Any | None = None) -> bool: ... def cancelled(self) -> bool: ... def done(self) -> bool: ... def result(self) -> _T: ... @@ -45,15 +38,12 @@ class Future(Awaitable[_T], Iterable[_T]): def __await__(self) -> Generator[Any, None, _T]: ... @property def _loop(self) -> AbstractEventLoop: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... if sys.version_info >= (3, 12): _TaskCompatibleCoro: TypeAlias = Coroutine[Any, Any, _T_co] -elif sys.version_info >= (3, 9): - _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Coroutine[Any, Any, _T_co] else: - _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Awaitable[_T_co] + _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Coroutine[Any, Any, _T_co] # mypy and pyright complain that a subclass of an invariant class shouldn't be covariant. # While this is true in general, here it's sort-of okay to have a covariant subclass, @@ -65,7 +55,7 @@ class Task(Future[_T_co]): # type: ignore[type-var] # pyright: ignore[reportIn self, coro: _TaskCompatibleCoro[_T_co], *, - loop: AbstractEventLoop = ..., + loop: AbstractEventLoop | None = None, name: str | None = ..., context: Context | None = None, eager_start: bool = False, @@ -75,13 +65,13 @@ class Task(Future[_T_co]): # type: ignore[type-var] # pyright: ignore[reportIn self, coro: _TaskCompatibleCoro[_T_co], *, - loop: AbstractEventLoop = ..., + loop: AbstractEventLoop | None = None, name: str | None = ..., context: Context | None = None, ) -> None: ... else: def __init__( - self, coro: _TaskCompatibleCoro[_T_co], *, loop: AbstractEventLoop = ..., name: str | None = ... + self, coro: _TaskCompatibleCoro[_T_co], *, loop: AbstractEventLoop | None = None, name: str | None = ... ) -> None: ... if sys.version_info >= (3, 12): @@ -99,13 +89,8 @@ class Task(Future[_T_co]): # type: ignore[type-var] # pyright: ignore[reportIn if sys.version_info >= (3, 11): def cancelling(self) -> int: ... def uncancel(self) -> int: ... - if sys.version_info < (3, 9): - @classmethod - def current_task(cls, loop: AbstractEventLoop | None = None) -> Task[Any] | None: ... - @classmethod - def all_tasks(cls, loop: AbstractEventLoop | None = None) -> set[Task[Any]]: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... def get_event_loop() -> AbstractEventLoop: ... def get_running_loop() -> AbstractEventLoop: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_bisect.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_bisect.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_bisect.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_bisect.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_blake2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_blake2.pyi new file mode 100644 index 0000000000000..d578df55c2faa --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_blake2.pyi @@ -0,0 +1,76 @@ +from _typeshed import ReadableBuffer +from typing import ClassVar, final +from typing_extensions import Self + +BLAKE2B_MAX_DIGEST_SIZE: int = 64 +BLAKE2B_MAX_KEY_SIZE: int = 64 +BLAKE2B_PERSON_SIZE: int = 16 +BLAKE2B_SALT_SIZE: int = 16 +BLAKE2S_MAX_DIGEST_SIZE: int = 32 +BLAKE2S_MAX_KEY_SIZE: int = 32 +BLAKE2S_PERSON_SIZE: int = 8 +BLAKE2S_SALT_SIZE: int = 8 + +@final +class blake2b: + MAX_DIGEST_SIZE: ClassVar[int] = 64 + MAX_KEY_SIZE: ClassVar[int] = 64 + PERSON_SIZE: ClassVar[int] = 16 + SALT_SIZE: ClassVar[int] = 16 + block_size: int + digest_size: int + name: str + def __new__( + cls, + data: ReadableBuffer = b"", + /, + *, + digest_size: int = 64, + key: ReadableBuffer = b"", + salt: ReadableBuffer = b"", + person: ReadableBuffer = b"", + fanout: int = 1, + depth: int = 1, + leaf_size: int = 0, + node_offset: int = 0, + node_depth: int = 0, + inner_size: int = 0, + last_node: bool = False, + usedforsecurity: bool = True, + ) -> Self: ... + def copy(self) -> Self: ... + def digest(self) -> bytes: ... + def hexdigest(self) -> str: ... + def update(self, data: ReadableBuffer, /) -> None: ... + +@final +class blake2s: + MAX_DIGEST_SIZE: ClassVar[int] = 32 + MAX_KEY_SIZE: ClassVar[int] = 32 + PERSON_SIZE: ClassVar[int] = 8 + SALT_SIZE: ClassVar[int] = 8 + block_size: int + digest_size: int + name: str + def __new__( + cls, + data: ReadableBuffer = b"", + /, + *, + digest_size: int = 32, + key: ReadableBuffer = b"", + salt: ReadableBuffer = b"", + person: ReadableBuffer = b"", + fanout: int = 1, + depth: int = 1, + leaf_size: int = 0, + node_offset: int = 0, + node_depth: int = 0, + inner_size: int = 0, + last_node: bool = False, + usedforsecurity: bool = True, + ) -> Self: ... + def copy(self) -> Self: ... + def digest(self) -> bytes: ... + def hexdigest(self) -> str: ... + def update(self, data: ReadableBuffer, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_bootlocale.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_bootlocale.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_bootlocale.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_bootlocale.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_bz2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_bz2.pyi new file mode 100644 index 0000000000000..fdad932ca22e6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_bz2.pyi @@ -0,0 +1,24 @@ +import sys +from _typeshed import ReadableBuffer +from typing import final +from typing_extensions import Self + +@final +class BZ2Compressor: + if sys.version_info >= (3, 12): + def __new__(cls, compresslevel: int = 9, /) -> Self: ... + else: + def __init__(self, compresslevel: int = 9, /) -> None: ... + + def compress(self, data: ReadableBuffer, /) -> bytes: ... + def flush(self) -> bytes: ... + +@final +class BZ2Decompressor: + def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes: ... + @property + def eof(self) -> bool: ... + @property + def needs_input(self) -> bool: ... + @property + def unused_data(self) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_codecs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_codecs.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_codecs.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_codecs.pyi index ecf874d33ddd2..89f97edb9ba81 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_codecs.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_codecs.pyi @@ -2,10 +2,13 @@ import codecs import sys from _typeshed import ReadableBuffer from collections.abc import Callable -from typing import Literal, overload +from typing import Literal, final, overload, type_check_only from typing_extensions import TypeAlias # This type is not exposed; it is defined in unicodeobject.c +# At runtime it calls itself builtins.EncodingMap +@final +@type_check_only class _EncodingMap: def size(self) -> int: ... @@ -78,26 +81,12 @@ def escape_decode(data: str | ReadableBuffer, errors: str | None = None, /) -> t def escape_encode(data: bytes, errors: str | None = None, /) -> tuple[bytes, int]: ... def latin_1_decode(data: ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... def latin_1_encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... - -if sys.version_info >= (3, 9): - def raw_unicode_escape_decode( - data: str | ReadableBuffer, errors: str | None = None, final: bool = True, / - ) -> tuple[str, int]: ... - -else: - def raw_unicode_escape_decode(data: str | ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... - +def raw_unicode_escape_decode( + data: str | ReadableBuffer, errors: str | None = None, final: bool = True, / +) -> tuple[str, int]: ... def raw_unicode_escape_encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... def readbuffer_encode(data: str | ReadableBuffer, errors: str | None = None, /) -> tuple[bytes, int]: ... - -if sys.version_info >= (3, 9): - def unicode_escape_decode( - data: str | ReadableBuffer, errors: str | None = None, final: bool = True, / - ) -> tuple[str, int]: ... - -else: - def unicode_escape_decode(data: str | ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... - +def unicode_escape_decode(data: str | ReadableBuffer, errors: str | None = None, final: bool = True, /) -> tuple[str, int]: ... def unicode_escape_encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... def utf_16_be_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... def utf_16_be_encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_collections_abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_collections_abc.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_collections_abc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_collections_abc.pyi index 8b1ac9c7eb8bb..b099bdd98f3c4 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_collections_abc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_collections_abc.pyi @@ -1,13 +1,14 @@ import sys from abc import abstractmethod from types import MappingProxyType -from typing import ( # noqa: Y022,Y038 +from typing import ( # noqa: Y022,Y038,UP035 AbstractSet as Set, AsyncGenerator as AsyncGenerator, AsyncIterable as AsyncIterable, AsyncIterator as AsyncIterator, Awaitable as Awaitable, Callable as Callable, + ClassVar, Collection as Collection, Container as Container, Coroutine as Coroutine, @@ -60,7 +61,7 @@ __all__ = [ "MutableSequence", ] if sys.version_info < (3, 14): - from typing import ByteString as ByteString # noqa: Y057 + from typing import ByteString as ByteString # noqa: Y057,UP035 __all__ += ["ByteString"] @@ -73,6 +74,8 @@ _VT_co = TypeVar("_VT_co", covariant=True) # Value type covariant containers. @final class dict_keys(KeysView[_KT_co], Generic[_KT_co, _VT_co]): # undocumented def __eq__(self, value: object, /) -> bool: ... + def __reversed__(self) -> Iterator[_KT_co]: ... + __hash__: ClassVar[None] # type: ignore[assignment] if sys.version_info >= (3, 13): def isdisjoint(self, other: Iterable[_KT_co], /) -> bool: ... if sys.version_info >= (3, 10): @@ -81,6 +84,7 @@ class dict_keys(KeysView[_KT_co], Generic[_KT_co, _VT_co]): # undocumented @final class dict_values(ValuesView[_VT_co], Generic[_KT_co, _VT_co]): # undocumented + def __reversed__(self) -> Iterator[_VT_co]: ... if sys.version_info >= (3, 10): @property def mapping(self) -> MappingProxyType[_KT_co, _VT_co]: ... @@ -88,6 +92,8 @@ class dict_values(ValuesView[_VT_co], Generic[_KT_co, _VT_co]): # undocumented @final class dict_items(ItemsView[_KT_co, _VT_co]): # undocumented def __eq__(self, value: object, /) -> bool: ... + def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... + __hash__: ClassVar[None] # type: ignore[assignment] if sys.version_info >= (3, 13): def isdisjoint(self, other: Iterable[tuple[_KT_co, _VT_co]], /) -> bool: ... if sys.version_info >= (3, 10): diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_compat_pickle.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_compat_pickle.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_compat_pickle.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_compat_pickle.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_compression.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_compression.pyi new file mode 100644 index 0000000000000..80d38b4db824b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_compression.pyi @@ -0,0 +1,27 @@ +# _compression is replaced by compression._common._streams on Python 3.14+ (PEP-784) + +from _typeshed import Incomplete, WriteableBuffer +from collections.abc import Callable +from io import DEFAULT_BUFFER_SIZE, BufferedIOBase, RawIOBase +from typing import Any, Protocol + +BUFFER_SIZE = DEFAULT_BUFFER_SIZE + +class _Reader(Protocol): + def read(self, n: int, /) -> bytes: ... + def seekable(self) -> bool: ... + def seek(self, n: int, /) -> Any: ... + +class BaseStream(BufferedIOBase): ... + +class DecompressReader(RawIOBase): + def __init__( + self, + fp: _Reader, + decomp_factory: Callable[..., Incomplete], + trailing_error: type[Exception] | tuple[type[Exception], ...] = (), + **decomp_args: Any, # These are passed to decomp_factory. + ) -> None: ... + def readinto(self, b: WriteableBuffer) -> int: ... + def read(self, size: int = -1) -> bytes: ... + def seek(self, offset: int, whence: int = 0) -> int: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_contextvars.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_contextvars.pyi new file mode 100644 index 0000000000000..e2e2e4df9d086 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_contextvars.pyi @@ -0,0 +1,64 @@ +import sys +from collections.abc import Callable, Iterator, Mapping +from types import GenericAlias, TracebackType +from typing import Any, ClassVar, Generic, TypeVar, final, overload +from typing_extensions import ParamSpec, Self + +_T = TypeVar("_T") +_D = TypeVar("_D") +_P = ParamSpec("_P") + +@final +class ContextVar(Generic[_T]): + @overload + def __new__(cls, name: str) -> Self: ... + @overload + def __new__(cls, name: str, *, default: _T) -> Self: ... + def __hash__(self) -> int: ... + @property + def name(self) -> str: ... + @overload + def get(self) -> _T: ... + @overload + def get(self, default: _T, /) -> _T: ... + @overload + def get(self, default: _D, /) -> _D | _T: ... + def set(self, value: _T, /) -> Token[_T]: ... + def reset(self, token: Token[_T], /) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +@final +class Token(Generic[_T]): + @property + def var(self) -> ContextVar[_T]: ... + @property + def old_value(self) -> Any: ... # returns either _T or MISSING, but that's hard to express + MISSING: ClassVar[object] + __hash__: ClassVar[None] # type: ignore[assignment] + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + if sys.version_info >= (3, 14): + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + +def copy_context() -> Context: ... + +# It doesn't make sense to make this generic, because for most Contexts each ContextVar will have +# a different value. +@final +class Context(Mapping[ContextVar[Any], Any]): + def __init__(self) -> None: ... + @overload + def get(self, key: ContextVar[_T], default: None = None, /) -> _T | None: ... + @overload + def get(self, key: ContextVar[_T], default: _T, /) -> _T: ... + @overload + def get(self, key: ContextVar[_T], default: _D, /) -> _T | _D: ... + def run(self, callable: Callable[_P, _T], *args: _P.args, **kwargs: _P.kwargs) -> _T: ... + def copy(self) -> Context: ... + __hash__: ClassVar[None] # type: ignore[assignment] + def __getitem__(self, key: ContextVar[_T], /) -> _T: ... + def __iter__(self) -> Iterator[ContextVar[Any]]: ... + def __len__(self) -> int: ... + def __eq__(self, value: object, /) -> bool: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_csv.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_csv.pyi new file mode 100644 index 0000000000000..ecea4878907c4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_csv.pyi @@ -0,0 +1,133 @@ +import csv +import sys +from _typeshed import SupportsWrite +from collections.abc import Iterable +from typing import Any, Final, Literal, type_check_only +from typing_extensions import Self, TypeAlias + +__version__: Final[str] + +QUOTE_ALL: Final = 1 +QUOTE_MINIMAL: Final = 0 +QUOTE_NONE: Final = 3 +QUOTE_NONNUMERIC: Final = 2 +if sys.version_info >= (3, 12): + QUOTE_STRINGS: Final = 4 + QUOTE_NOTNULL: Final = 5 + +if sys.version_info >= (3, 12): + _QuotingType: TypeAlias = Literal[0, 1, 2, 3, 4, 5] +else: + _QuotingType: TypeAlias = Literal[0, 1, 2, 3] + +class Error(Exception): ... + +_DialectLike: TypeAlias = str | Dialect | csv.Dialect | type[Dialect | csv.Dialect] + +class Dialect: + delimiter: str + quotechar: str | None + escapechar: str | None + doublequote: bool + skipinitialspace: bool + lineterminator: str + quoting: _QuotingType + strict: bool + def __new__( + cls, + dialect: _DialectLike | None = ..., + delimiter: str = ",", + doublequote: bool = True, + escapechar: str | None = None, + lineterminator: str = "\r\n", + quotechar: str | None = '"', + quoting: _QuotingType = 0, + skipinitialspace: bool = False, + strict: bool = False, + ) -> Self: ... + +if sys.version_info >= (3, 10): + # This class calls itself _csv.reader. + class Reader: + @property + def dialect(self) -> Dialect: ... + line_num: int + def __iter__(self) -> Self: ... + def __next__(self) -> list[str]: ... + + # This class calls itself _csv.writer. + class Writer: + @property + def dialect(self) -> Dialect: ... + if sys.version_info >= (3, 13): + def writerow(self, row: Iterable[Any], /) -> Any: ... + def writerows(self, rows: Iterable[Iterable[Any]], /) -> None: ... + else: + def writerow(self, row: Iterable[Any]) -> Any: ... + def writerows(self, rows: Iterable[Iterable[Any]]) -> None: ... + + # For the return types below. + # These aliases can be removed when typeshed drops support for 3.9. + _reader = Reader + _writer = Writer +else: + # This class is not exposed. It calls itself _csv.reader. + @type_check_only + class _reader: + @property + def dialect(self) -> Dialect: ... + line_num: int + def __iter__(self) -> Self: ... + def __next__(self) -> list[str]: ... + + # This class is not exposed. It calls itself _csv.writer. + @type_check_only + class _writer: + @property + def dialect(self) -> Dialect: ... + def writerow(self, row: Iterable[Any]) -> Any: ... + def writerows(self, rows: Iterable[Iterable[Any]]) -> None: ... + +def writer( + csvfile: SupportsWrite[str], + dialect: _DialectLike = "excel", + *, + delimiter: str = ",", + quotechar: str | None = '"', + escapechar: str | None = None, + doublequote: bool = True, + skipinitialspace: bool = False, + lineterminator: str = "\r\n", + quoting: _QuotingType = 0, + strict: bool = False, +) -> _writer: ... +def reader( + csvfile: Iterable[str], + dialect: _DialectLike = "excel", + *, + delimiter: str = ",", + quotechar: str | None = '"', + escapechar: str | None = None, + doublequote: bool = True, + skipinitialspace: bool = False, + lineterminator: str = "\r\n", + quoting: _QuotingType = 0, + strict: bool = False, +) -> _reader: ... +def register_dialect( + name: str, + dialect: type[Dialect | csv.Dialect] = ..., + *, + delimiter: str = ",", + quotechar: str | None = '"', + escapechar: str | None = None, + doublequote: bool = True, + skipinitialspace: bool = False, + lineterminator: str = "\r\n", + quoting: _QuotingType = 0, + strict: bool = False, +) -> None: ... +def unregister_dialect(name: str) -> None: ... +def get_dialect(name: str) -> Dialect: ... +def list_dialects() -> list[str]: ... +def field_size_limit(new_limit: int = ...) -> int: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_ctypes.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_ctypes.pyi new file mode 100644 index 0000000000000..944685646c36d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_ctypes.pyi @@ -0,0 +1,336 @@ +import _typeshed +import sys +from _typeshed import ReadableBuffer, StrOrBytesPath, WriteableBuffer +from abc import abstractmethod +from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence +from ctypes import CDLL, ArgumentError as ArgumentError, c_void_p +from types import GenericAlias +from typing import Any, ClassVar, Generic, TypeVar, final, overload, type_check_only +from typing_extensions import Self, TypeAlias + +_T = TypeVar("_T") +_CT = TypeVar("_CT", bound=_CData) + +FUNCFLAG_CDECL: int +FUNCFLAG_PYTHONAPI: int +FUNCFLAG_USE_ERRNO: int +FUNCFLAG_USE_LASTERROR: int +RTLD_GLOBAL: int +RTLD_LOCAL: int + +if sys.version_info >= (3, 11): + CTYPES_MAX_ARGCOUNT: int + +if sys.version_info >= (3, 12): + SIZEOF_TIME_T: int + +if sys.platform == "win32": + # Description, Source, HelpFile, HelpContext, scode + _COMError_Details: TypeAlias = tuple[str | None, str | None, str | None, int | None, int | None] + + class COMError(Exception): + hresult: int + text: str | None + details: _COMError_Details + + def __init__(self, hresult: int, text: str | None, details: _COMError_Details) -> None: ... + + def CopyComPointer(src: _PointerLike, dst: _PointerLike | _CArgObject) -> int: ... + + FUNCFLAG_HRESULT: int + FUNCFLAG_STDCALL: int + + def FormatError(code: int = ...) -> str: ... + def get_last_error() -> int: ... + def set_last_error(value: int) -> int: ... + def LoadLibrary(name: str, load_flags: int = 0, /) -> int: ... + def FreeLibrary(handle: int, /) -> None: ... + +else: + def dlclose(handle: int, /) -> None: ... + # The default for flag is RTLD_GLOBAL|RTLD_LOCAL, which is platform dependent. + def dlopen(name: StrOrBytesPath, flag: int = ..., /) -> int: ... + def dlsym(handle: int, name: str, /) -> int: ... + +if sys.version_info >= (3, 13): + # This class is not exposed. It calls itself _ctypes.CType_Type. + @type_check_only + class _CType_Type(type): + # By default mypy complains about the following two methods, because strictly speaking cls + # might not be a Type[_CT]. However this doesn't happen because this is only a + # metaclass for subclasses of _CData. + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + + _CTypeBaseType = _CType_Type + +else: + _CTypeBaseType = type + +# This class is not exposed. +@type_check_only +class _CData: + _b_base_: int + _b_needsfree_: bool + _objects: Mapping[Any, int] | None + def __buffer__(self, flags: int, /) -> memoryview: ... + def __ctypes_from_outparam__(self, /) -> Self: ... + +# this is a union of all the subclasses of _CData, which is useful because of +# the methods that are present on each of those subclasses which are not present +# on _CData itself. +_CDataType: TypeAlias = _SimpleCData[Any] | _Pointer[Any] | CFuncPtr | Union | Structure | Array[Any] + +# This class is not exposed. It calls itself _ctypes.PyCSimpleType. +@type_check_only +class _PyCSimpleType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(self: type[_CT], value: int, /) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(self: type[_CT], value: int, /) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class _SimpleCData(_CData, Generic[_T], metaclass=_PyCSimpleType): + value: _T + # The TypeVar can be unsolved here, + # but we can't use overloads without creating many, many mypy false-positive errors + def __init__(self, value: _T = ...) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] + def __ctypes_from_outparam__(self, /) -> _T: ... # type: ignore[override] + +class _CanCastTo(_CData): ... +class _PointerLike(_CanCastTo): ... + +# This type is not exposed. It calls itself _ctypes.PyCPointerType. +@type_check_only +class _PyCPointerType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + def set_type(self, type: Any, /) -> None: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class _Pointer(_PointerLike, _CData, Generic[_CT], metaclass=_PyCPointerType): + _type_: type[_CT] + contents: _CT + @overload + def __init__(self) -> None: ... + @overload + def __init__(self, arg: _CT) -> None: ... + @overload + def __getitem__(self, key: int, /) -> Any: ... + @overload + def __getitem__(self, key: slice, /) -> list[Any]: ... + def __setitem__(self, key: int, value: Any, /) -> None: ... + +if sys.version_info < (3, 14): + @overload + def POINTER(type: None, /) -> type[c_void_p]: ... + @overload + def POINTER(type: type[_CT], /) -> type[_Pointer[_CT]]: ... + def pointer(obj: _CT, /) -> _Pointer[_CT]: ... + +# This class is not exposed. It calls itself _ctypes.CArgObject. +@final +@type_check_only +class _CArgObject: ... + +if sys.version_info >= (3, 14): + def byref(obj: _CData | _CDataType, offset: int = 0, /) -> _CArgObject: ... + +else: + def byref(obj: _CData | _CDataType, offset: int = 0) -> _CArgObject: ... + +_ECT: TypeAlias = Callable[[_CData | _CDataType | None, CFuncPtr, tuple[_CData | _CDataType, ...]], _CDataType] +_PF: TypeAlias = tuple[int] | tuple[int, str | None] | tuple[int, str | None, Any] + +# This class is not exposed. It calls itself _ctypes.PyCFuncPtrType. +@type_check_only +class _PyCFuncPtrType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class CFuncPtr(_PointerLike, _CData, metaclass=_PyCFuncPtrType): + restype: type[_CDataType] | Callable[[int], Any] | None + argtypes: Sequence[type[_CDataType]] + errcheck: _ECT + # Abstract attribute that must be defined on subclasses + _flags_: ClassVar[int] + @overload + def __new__(cls) -> Self: ... + @overload + def __new__(cls, address: int, /) -> Self: ... + @overload + def __new__(cls, callable: Callable[..., Any], /) -> Self: ... + @overload + def __new__(cls, func_spec: tuple[str | int, CDLL], paramflags: tuple[_PF, ...] | None = ..., /) -> Self: ... + if sys.platform == "win32": + @overload + def __new__( + cls, vtbl_index: int, name: str, paramflags: tuple[_PF, ...] | None = ..., iid: _CData | _CDataType | None = ..., / + ) -> Self: ... + + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + +_GetT = TypeVar("_GetT") +_SetT = TypeVar("_SetT") + +# This class is not exposed. It calls itself _ctypes.CField. +@final +@type_check_only +class _CField(Generic[_CT, _GetT, _SetT]): + offset: int + size: int + if sys.version_info >= (3, 10): + @overload + def __get__(self, instance: None, owner: type[Any] | None = None, /) -> Self: ... + @overload + def __get__(self, instance: Any, owner: type[Any] | None = None, /) -> _GetT: ... + else: + @overload + def __get__(self, instance: None, owner: type[Any] | None, /) -> Self: ... + @overload + def __get__(self, instance: Any, owner: type[Any] | None, /) -> _GetT: ... + + def __set__(self, instance: Any, value: _SetT, /) -> None: ... + +# This class is not exposed. It calls itself _ctypes.UnionType. +@type_check_only +class _UnionType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + # At runtime, various attributes are created on a Union subclass based + # on its _fields_. This method doesn't exist, but represents those + # dynamically created attributes. + def __getattr__(self, name: str) -> _CField[Any, Any, Any]: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class Union(_CData, metaclass=_UnionType): + _fields_: ClassVar[Sequence[tuple[str, type[_CDataType]] | tuple[str, type[_CDataType], int]]] + _pack_: ClassVar[int] + _anonymous_: ClassVar[Sequence[str]] + if sys.version_info >= (3, 13): + _align_: ClassVar[int] + + def __init__(self, *args: Any, **kw: Any) -> None: ... + def __getattr__(self, name: str) -> Any: ... + def __setattr__(self, name: str, value: Any) -> None: ... + +# This class is not exposed. It calls itself _ctypes.PyCStructType. +@type_check_only +class _PyCStructType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + # At runtime, various attributes are created on a Structure subclass based + # on its _fields_. This method doesn't exist, but represents those + # dynamically created attributes. + def __getattr__(self, name: str) -> _CField[Any, Any, Any]: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class Structure(_CData, metaclass=_PyCStructType): + _fields_: ClassVar[Sequence[tuple[str, type[_CDataType]] | tuple[str, type[_CDataType], int]]] + _pack_: ClassVar[int] + _anonymous_: ClassVar[Sequence[str]] + if sys.version_info >= (3, 13): + _align_: ClassVar[int] + + def __init__(self, *args: Any, **kw: Any) -> None: ... + def __getattr__(self, name: str) -> Any: ... + def __setattr__(self, name: str, value: Any) -> None: ... + +# This class is not exposed. It calls itself _ctypes.PyCArrayType. +@type_check_only +class _PyCArrayType(_CTypeBaseType): + def from_address(self: type[_typeshed.Self], value: int, /) -> _typeshed.Self: ... + def from_buffer(self: type[_typeshed.Self], obj: WriteableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_buffer_copy(self: type[_typeshed.Self], buffer: ReadableBuffer, offset: int = 0, /) -> _typeshed.Self: ... + def from_param(self: type[_typeshed.Self], value: Any, /) -> _typeshed.Self | _CArgObject: ... + def in_dll(self: type[_typeshed.Self], dll: CDLL, name: str, /) -> _typeshed.Self: ... + if sys.version_info < (3, 13): + # Inherited from CType_Type starting on 3.13 + def __mul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __rmul__(cls: type[_CT], other: int) -> type[Array[_CT]]: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + +class Array(_CData, Generic[_CT], metaclass=_PyCArrayType): + @property + @abstractmethod + def _length_(self) -> int: ... + @_length_.setter + def _length_(self, value: int) -> None: ... + @property + @abstractmethod + def _type_(self) -> type[_CT]: ... + @_type_.setter + def _type_(self, value: type[_CT]) -> None: ... + # Note: only available if _CT == c_char + @property + def raw(self) -> bytes: ... + @raw.setter + def raw(self, value: ReadableBuffer) -> None: ... + value: Any # Note: bytes if _CT == c_char, str if _CT == c_wchar, unavailable otherwise + # TODO: These methods cannot be annotated correctly at the moment. + # All of these "Any"s stand for the array's element type, but it's not possible to use _CT + # here, because of a special feature of ctypes. + # By default, when accessing an element of an Array[_CT], the returned object has type _CT. + # However, when _CT is a "simple type" like c_int, ctypes automatically "unboxes" the object + # and converts it to the corresponding Python primitive. For example, when accessing an element + # of an Array[c_int], a Python int object is returned, not a c_int. + # This behavior does *not* apply to subclasses of "simple types". + # If MyInt is a subclass of c_int, then accessing an element of an Array[MyInt] returns + # a MyInt, not an int. + # This special behavior is not easy to model in a stub, so for now all places where + # the array element type would belong are annotated with Any instead. + def __init__(self, *args: Any) -> None: ... + @overload + def __getitem__(self, key: int, /) -> Any: ... + @overload + def __getitem__(self, key: slice, /) -> list[Any]: ... + @overload + def __setitem__(self, key: int, value: Any, /) -> None: ... + @overload + def __setitem__(self, key: slice, value: Iterable[Any], /) -> None: ... + def __iter__(self) -> Iterator[Any]: ... + # Can't inherit from Sized because the metaclass conflict between + # Sized and _CData prevents using _CDataMeta. + def __len__(self) -> int: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +def addressof(obj: _CData | _CDataType, /) -> int: ... +def alignment(obj_or_type: _CData | _CDataType | type[_CData | _CDataType], /) -> int: ... +def get_errno() -> int: ... +def resize(obj: _CData | _CDataType, size: int, /) -> None: ... +def set_errno(value: int, /) -> int: ... +def sizeof(obj_or_type: _CData | _CDataType | type[_CData | _CDataType], /) -> int: ... +def PyObj_FromPtr(address: int, /) -> Any: ... +def Py_DECREF(o: _T, /) -> _T: ... +def Py_INCREF(o: _T, /) -> _T: ... +def buffer_info(o: _CData | _CDataType | type[_CData | _CDataType], /) -> tuple[str, int, tuple[int, ...]]: ... +def call_cdeclfunction(address: int, arguments: tuple[Any, ...], /) -> Any: ... +def call_function(address: int, arguments: tuple[Any, ...], /) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_curses.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_curses.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_curses.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_curses.pyi index 80075d77e8e6b..d7820c72c090d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_curses.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_curses.pyi @@ -1,6 +1,7 @@ import sys -from _typeshed import ReadOnlyBuffer, SupportsRead -from typing import IO, Any, NamedTuple, final, overload +from _typeshed import ReadOnlyBuffer, SupportsRead, SupportsWrite +from curses import _ncurses_version +from typing import Any, final, overload from typing_extensions import TypeAlias # NOTE: This module is ordinarily only available on Unix, but the windows-curses @@ -94,13 +95,14 @@ BUTTON4_DOUBLE_CLICKED: int BUTTON4_PRESSED: int BUTTON4_RELEASED: int BUTTON4_TRIPLE_CLICKED: int -# Darwin ncurses doesn't provide BUTTON5_* constants -if sys.version_info >= (3, 10) and sys.platform != "darwin": - BUTTON5_PRESSED: int - BUTTON5_RELEASED: int - BUTTON5_CLICKED: int - BUTTON5_DOUBLE_CLICKED: int - BUTTON5_TRIPLE_CLICKED: int +# Darwin ncurses doesn't provide BUTTON5_* constants prior to 3.12.10 and 3.13.3 +if sys.version_info >= (3, 10): + if sys.version_info >= (3, 12) or sys.platform != "darwin": + BUTTON5_PRESSED: int + BUTTON5_RELEASED: int + BUTTON5_CLICKED: int + BUTTON5_DOUBLE_CLICKED: int + BUTTON5_TRIPLE_CLICKED: int BUTTON_ALT: int BUTTON_CTRL: int BUTTON_SHIFT: int @@ -291,11 +293,8 @@ def erasechar() -> bytes: ... def filter() -> None: ... def flash() -> None: ... def flushinp() -> None: ... - -if sys.version_info >= (3, 9): - def get_escdelay() -> int: ... - def get_tabsize() -> int: ... - +def get_escdelay() -> int: ... +def get_tabsize() -> int: ... def getmouse() -> tuple[int, int, int, int, int]: ... def getsyx() -> tuple[int, int]: ... def getwin(file: SupportsRead[bytes], /) -> window: ... @@ -340,11 +339,8 @@ def resetty() -> None: ... def resize_term(nlines: int, ncols: int, /) -> None: ... def resizeterm(nlines: int, ncols: int, /) -> None: ... def savetty() -> None: ... - -if sys.version_info >= (3, 9): - def set_escdelay(ms: int, /) -> None: ... - def set_tabsize(size: int, /) -> None: ... - +def set_escdelay(ms: int, /) -> None: ... +def set_tabsize(size: int, /) -> None: ... def setsyx(y: int, x: int, /) -> None: ... def setupterm(term: str | None = None, fd: int = -1) -> None: ... def start_color() -> None: ... @@ -516,7 +512,7 @@ class window: # undocumented def overwrite( self, destwin: window, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int ) -> None: ... - def putwin(self, file: IO[Any], /) -> None: ... + def putwin(self, file: SupportsWrite[bytes], /) -> None: ... def redrawln(self, beg: int, num: int, /) -> None: ... def redrawwin(self) -> None: ... @overload @@ -549,9 +545,4 @@ class window: # undocumented @overload def vline(self, y: int, x: int, ch: _ChType, n: int) -> None: ... -class _ncurses_version(NamedTuple): - major: int - minor: int - patch: int - ncurses_version: _ncurses_version diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_curses_panel.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_curses_panel.pyi new file mode 100644 index 0000000000000..ddec22236b963 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_curses_panel.pyi @@ -0,0 +1,27 @@ +from _curses import window +from typing import final + +__version__: str +version: str + +class error(Exception): ... + +@final +class panel: + def above(self) -> panel: ... + def below(self) -> panel: ... + def bottom(self) -> None: ... + def hidden(self) -> bool: ... + def hide(self) -> None: ... + def move(self, y: int, x: int, /) -> None: ... + def replace(self, win: window, /) -> None: ... + def set_userptr(self, obj: object, /) -> None: ... + def show(self) -> None: ... + def top(self) -> None: ... + def userptr(self) -> object: ... + def window(self) -> window: ... + +def bottom_panel() -> panel: ... +def new_panel(win: window, /) -> panel: ... +def top_panel() -> panel: ... +def update_panels() -> panel: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_dbm.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_dbm.pyi new file mode 100644 index 0000000000000..7e53cca3c704f --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_dbm.pyi @@ -0,0 +1,44 @@ +import sys +from _typeshed import ReadOnlyBuffer, StrOrBytesPath +from types import TracebackType +from typing import TypeVar, final, overload, type_check_only +from typing_extensions import Self, TypeAlias + +if sys.platform != "win32": + _T = TypeVar("_T") + _KeyType: TypeAlias = str | ReadOnlyBuffer + _ValueType: TypeAlias = str | ReadOnlyBuffer + + class error(OSError): ... + library: str + + # Actual typename dbm, not exposed by the implementation + @final + @type_check_only + class _dbm: + def close(self) -> None: ... + if sys.version_info >= (3, 13): + def clear(self) -> None: ... + + def __getitem__(self, item: _KeyType) -> bytes: ... + def __setitem__(self, key: _KeyType, value: _ValueType) -> None: ... + def __delitem__(self, key: _KeyType) -> None: ... + def __len__(self) -> int: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + @overload + def get(self, k: _KeyType, /) -> bytes | None: ... + @overload + def get(self, k: _KeyType, default: _T, /) -> bytes | _T: ... + def keys(self) -> list[bytes]: ... + def setdefault(self, k: _KeyType, default: _ValueType = ..., /) -> bytes: ... + # This isn't true, but the class can't be instantiated. See #13024 + __new__: None # type: ignore[assignment] + __init__: None # type: ignore[assignment] + + if sys.version_info >= (3, 11): + def open(filename: StrOrBytesPath, flags: str = "r", mode: int = 0o666, /) -> _dbm: ... + else: + def open(filename: str, flags: str = "r", mode: int = 0o666, /) -> _dbm: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_decimal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_decimal.pyi similarity index 75% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_decimal.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_decimal.pyi index 9fcc08dbb95d0..fd0e6e6ac0914 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_decimal.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_decimal.pyi @@ -17,37 +17,32 @@ from decimal import ( Rounded as Rounded, Subnormal as Subnormal, Underflow as Underflow, + _ContextManager, ) -from types import TracebackType from typing import Final from typing_extensions import TypeAlias _TrapType: TypeAlias = type[DecimalException] -class _ContextManager: - new_context: Context - saved_context: Context - def __init__(self, new_context: Context) -> None: ... - def __enter__(self) -> Context: ... - def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... - __version__: Final[str] __libmpdec_version__: Final[str] -ROUND_DOWN: Final[str] -ROUND_HALF_UP: Final[str] -ROUND_HALF_EVEN: Final[str] -ROUND_CEILING: Final[str] -ROUND_FLOOR: Final[str] -ROUND_UP: Final[str] -ROUND_HALF_DOWN: Final[str] -ROUND_05UP: Final[str] +ROUND_DOWN: Final = "ROUND_DOWN" +ROUND_HALF_UP: Final = "ROUND_HALF_UP" +ROUND_HALF_EVEN: Final = "ROUND_HALF_EVEN" +ROUND_CEILING: Final = "ROUND_CEILING" +ROUND_FLOOR: Final = "ROUND_FLOOR" +ROUND_UP: Final = "ROUND_UP" +ROUND_HALF_DOWN: Final = "ROUND_HALF_DOWN" +ROUND_05UP: Final = "ROUND_05UP" HAVE_CONTEXTVAR: Final[bool] HAVE_THREADS: Final[bool] MAX_EMAX: Final[int] MAX_PREC: Final[int] MIN_EMIN: Final[int] MIN_ETINY: Final[int] +if sys.version_info >= (3, 14): + IEEE_CONTEXT_MAX_BITS: Final[int] def setcontext(context: Context, /) -> None: ... def getcontext() -> Context: ... @@ -69,6 +64,9 @@ if sys.version_info >= (3, 11): else: def localcontext(ctx: Context | None = None) -> _ContextManager: ... +if sys.version_info >= (3, 14): + def IEEEContext(bits: int, /) -> Context: ... + DefaultContext: Context BasicContext: Context ExtendedContext: Context diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib.pyi new file mode 100644 index 0000000000000..3dbc8c6b52f0d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib.pyi @@ -0,0 +1,113 @@ +import importlib.abc +import importlib.machinery +import sys +import types +from _typeshed.importlib import LoaderProtocol +from collections.abc import Mapping, Sequence +from types import ModuleType +from typing import Any, ClassVar + +# Signature of `builtins.__import__` should be kept identical to `importlib.__import__` +def __import__( + name: str, + globals: Mapping[str, object] | None = None, + locals: Mapping[str, object] | None = None, + fromlist: Sequence[str] = (), + level: int = 0, +) -> ModuleType: ... +def spec_from_loader( + name: str, loader: LoaderProtocol | None, *, origin: str | None = None, is_package: bool | None = None +) -> importlib.machinery.ModuleSpec | None: ... +def module_from_spec(spec: importlib.machinery.ModuleSpec) -> types.ModuleType: ... +def _init_module_attrs( + spec: importlib.machinery.ModuleSpec, module: types.ModuleType, *, override: bool = False +) -> types.ModuleType: ... + +class ModuleSpec: + def __init__( + self, + name: str, + loader: importlib.abc.Loader | None, + *, + origin: str | None = None, + loader_state: Any = None, + is_package: bool | None = None, + ) -> None: ... + name: str + loader: importlib.abc.Loader | None + origin: str | None + submodule_search_locations: list[str] | None + loader_state: Any + cached: str | None + @property + def parent(self) -> str | None: ... + has_location: bool + def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] + +class BuiltinImporter(importlib.abc.MetaPathFinder, importlib.abc.InspectLoader): + # MetaPathFinder + if sys.version_info < (3, 12): + @classmethod + def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... + + @classmethod + def find_spec( + cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None + ) -> ModuleSpec | None: ... + # InspectLoader + @classmethod + def is_package(cls, fullname: str) -> bool: ... + @classmethod + def load_module(cls, fullname: str) -> types.ModuleType: ... + @classmethod + def get_code(cls, fullname: str) -> None: ... + @classmethod + def get_source(cls, fullname: str) -> None: ... + # Loader + if sys.version_info < (3, 12): + @staticmethod + def module_repr(module: types.ModuleType) -> str: ... + if sys.version_info >= (3, 10): + @staticmethod + def create_module(spec: ModuleSpec) -> types.ModuleType | None: ... + @staticmethod + def exec_module(module: types.ModuleType) -> None: ... + else: + @classmethod + def create_module(cls, spec: ModuleSpec) -> types.ModuleType | None: ... + @classmethod + def exec_module(cls, module: types.ModuleType) -> None: ... + +class FrozenImporter(importlib.abc.MetaPathFinder, importlib.abc.InspectLoader): + # MetaPathFinder + if sys.version_info < (3, 12): + @classmethod + def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... + + @classmethod + def find_spec( + cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None + ) -> ModuleSpec | None: ... + # InspectLoader + @classmethod + def is_package(cls, fullname: str) -> bool: ... + @classmethod + def load_module(cls, fullname: str) -> types.ModuleType: ... + @classmethod + def get_code(cls, fullname: str) -> None: ... + @classmethod + def get_source(cls, fullname: str) -> None: ... + # Loader + if sys.version_info < (3, 12): + @staticmethod + def module_repr(m: types.ModuleType) -> str: ... + if sys.version_info >= (3, 10): + @staticmethod + def create_module(spec: ModuleSpec) -> types.ModuleType | None: ... + else: + @classmethod + def create_module(cls, spec: ModuleSpec) -> types.ModuleType | None: ... + + @staticmethod + def exec_module(module: types.ModuleType) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib_external.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib_external.pyi new file mode 100644 index 0000000000000..edad50a8d8583 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib_external.pyi @@ -0,0 +1,188 @@ +import _ast +import _io +import importlib.abc +import importlib.machinery +import sys +import types +from _typeshed import ReadableBuffer, StrOrBytesPath, StrPath +from _typeshed.importlib import LoaderProtocol +from collections.abc import Callable, Iterable, Iterator, Mapping, MutableSequence, Sequence +from importlib.machinery import ModuleSpec +from importlib.metadata import DistributionFinder, PathDistribution +from typing import Any, Literal +from typing_extensions import Self, deprecated + +if sys.version_info >= (3, 10): + import importlib.readers + +if sys.platform == "win32": + path_separators: Literal["\\/"] + path_sep: Literal["\\"] + path_sep_tuple: tuple[Literal["\\"], Literal["/"]] +else: + path_separators: Literal["/"] + path_sep: Literal["/"] + path_sep_tuple: tuple[Literal["/"]] + +MAGIC_NUMBER: bytes + +def cache_from_source(path: StrPath, debug_override: bool | None = None, *, optimization: Any | None = None) -> str: ... +def source_from_cache(path: StrPath) -> str: ... +def decode_source(source_bytes: ReadableBuffer) -> str: ... +def spec_from_file_location( + name: str, + location: StrOrBytesPath | None = None, + *, + loader: LoaderProtocol | None = None, + submodule_search_locations: list[str] | None = ..., +) -> importlib.machinery.ModuleSpec | None: ... +@deprecated( + "Deprecated as of Python 3.6: Use site configuration instead. " + "Future versions of Python may not enable this finder by default." +) +class WindowsRegistryFinder(importlib.abc.MetaPathFinder): + if sys.version_info < (3, 12): + @classmethod + def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... + + @classmethod + def find_spec( + cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None + ) -> ModuleSpec | None: ... + +class PathFinder(importlib.abc.MetaPathFinder): + if sys.version_info >= (3, 10): + @staticmethod + def invalidate_caches() -> None: ... + else: + @classmethod + def invalidate_caches(cls) -> None: ... + if sys.version_info >= (3, 10): + @staticmethod + def find_distributions(context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... + else: + @classmethod + def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... + + @classmethod + def find_spec( + cls, fullname: str, path: Sequence[str] | None = None, target: types.ModuleType | None = None + ) -> ModuleSpec | None: ... + if sys.version_info < (3, 12): + @classmethod + def find_module(cls, fullname: str, path: Sequence[str] | None = None) -> importlib.abc.Loader | None: ... + +SOURCE_SUFFIXES: list[str] +DEBUG_BYTECODE_SUFFIXES: list[str] +OPTIMIZED_BYTECODE_SUFFIXES: list[str] +BYTECODE_SUFFIXES: list[str] +EXTENSION_SUFFIXES: list[str] + +class FileFinder(importlib.abc.PathEntryFinder): + path: str + def __init__(self, path: str, *loader_details: tuple[type[importlib.abc.Loader], list[str]]) -> None: ... + @classmethod + def path_hook( + cls, *loader_details: tuple[type[importlib.abc.Loader], list[str]] + ) -> Callable[[str], importlib.abc.PathEntryFinder]: ... + +class _LoaderBasics: + def is_package(self, fullname: str) -> bool: ... + def create_module(self, spec: ModuleSpec) -> types.ModuleType | None: ... + def exec_module(self, module: types.ModuleType) -> None: ... + def load_module(self, fullname: str) -> types.ModuleType: ... + +class SourceLoader(_LoaderBasics): + def path_mtime(self, path: str) -> float: ... + def set_data(self, path: str, data: bytes) -> None: ... + def get_source(self, fullname: str) -> str | None: ... + def path_stats(self, path: str) -> Mapping[str, Any]: ... + def source_to_code( + self, data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, path: ReadableBuffer | StrPath + ) -> types.CodeType: ... + def get_code(self, fullname: str) -> types.CodeType | None: ... + +class FileLoader: + name: str + path: str + def __init__(self, fullname: str, path: str) -> None: ... + def get_data(self, path: str) -> bytes: ... + def get_filename(self, name: str | None = None) -> str: ... + def load_module(self, name: str | None = None) -> types.ModuleType: ... + if sys.version_info >= (3, 10): + def get_resource_reader(self, name: str | None = None) -> importlib.readers.FileReader: ... + else: + def get_resource_reader(self, name: str | None = None) -> Self | None: ... + def open_resource(self, resource: str) -> _io.FileIO: ... + def resource_path(self, resource: str) -> str: ... + def is_resource(self, name: str) -> bool: ... + def contents(self) -> Iterator[str]: ... + +class SourceFileLoader(importlib.abc.FileLoader, FileLoader, importlib.abc.SourceLoader, SourceLoader): # type: ignore[misc] # incompatible method arguments in base classes + def set_data(self, path: str, data: ReadableBuffer, *, _mode: int = 0o666) -> None: ... + def path_stats(self, path: str) -> Mapping[str, Any]: ... + def source_to_code( # type: ignore[override] # incompatible with InspectLoader.source_to_code + self, + data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, + path: ReadableBuffer | StrPath, + *, + _optimize: int = -1, + ) -> types.CodeType: ... + +class SourcelessFileLoader(importlib.abc.FileLoader, FileLoader, _LoaderBasics): + def get_code(self, fullname: str) -> types.CodeType | None: ... + def get_source(self, fullname: str) -> None: ... + +class ExtensionFileLoader(FileLoader, _LoaderBasics, importlib.abc.ExecutionLoader): + def __init__(self, name: str, path: str) -> None: ... + def get_filename(self, name: str | None = None) -> str: ... + def get_source(self, fullname: str) -> None: ... + def create_module(self, spec: ModuleSpec) -> types.ModuleType: ... + def exec_module(self, module: types.ModuleType) -> None: ... + def get_code(self, fullname: str) -> None: ... + def __eq__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + +if sys.version_info >= (3, 11): + class NamespaceLoader(importlib.abc.InspectLoader): + def __init__( + self, name: str, path: MutableSequence[str], path_finder: Callable[[str, tuple[str, ...]], ModuleSpec] + ) -> None: ... + def is_package(self, fullname: str) -> Literal[True]: ... + def get_source(self, fullname: str) -> Literal[""]: ... + def get_code(self, fullname: str) -> types.CodeType: ... + def create_module(self, spec: ModuleSpec) -> None: ... + def exec_module(self, module: types.ModuleType) -> None: ... + @deprecated("load_module() is deprecated; use exec_module() instead") + def load_module(self, fullname: str) -> types.ModuleType: ... + def get_resource_reader(self, module: types.ModuleType) -> importlib.readers.NamespaceReader: ... + if sys.version_info < (3, 12): + @staticmethod + @deprecated("module_repr() is deprecated, and has been removed in Python 3.12") + def module_repr(module: types.ModuleType) -> str: ... + + _NamespaceLoader = NamespaceLoader +else: + class _NamespaceLoader: + def __init__( + self, name: str, path: MutableSequence[str], path_finder: Callable[[str, tuple[str, ...]], ModuleSpec] + ) -> None: ... + def is_package(self, fullname: str) -> Literal[True]: ... + def get_source(self, fullname: str) -> Literal[""]: ... + def get_code(self, fullname: str) -> types.CodeType: ... + def create_module(self, spec: ModuleSpec) -> None: ... + def exec_module(self, module: types.ModuleType) -> None: ... + @deprecated("load_module() is deprecated; use exec_module() instead") + def load_module(self, fullname: str) -> types.ModuleType: ... + if sys.version_info >= (3, 10): + @staticmethod + @deprecated("module_repr() is deprecated, and has been removed in Python 3.12") + def module_repr(module: types.ModuleType) -> str: ... + def get_resource_reader(self, module: types.ModuleType) -> importlib.readers.NamespaceReader: ... + else: + @classmethod + @deprecated("module_repr() is deprecated, and has been removed in Python 3.12") + def module_repr(cls, module: types.ModuleType) -> str: ... + +if sys.version_info >= (3, 13): + class AppleFrameworkLoader(ExtensionFileLoader, importlib.abc.ExecutionLoader): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/gnu.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_gdbm.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/gnu.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_gdbm.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_hashlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_hashlib.pyi new file mode 100644 index 0000000000000..746b1657e2dbf --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_hashlib.pyi @@ -0,0 +1,82 @@ +import sys +from _typeshed import ReadableBuffer +from collections.abc import Callable +from types import ModuleType +from typing import AnyStr, Protocol, final, overload, type_check_only +from typing_extensions import Self, TypeAlias + +_DigestMod: TypeAlias = str | Callable[[], _HashObject] | ModuleType | None + +openssl_md_meth_names: frozenset[str] + +@type_check_only +class _HashObject(Protocol): + @property + def digest_size(self) -> int: ... + @property + def block_size(self) -> int: ... + @property + def name(self) -> str: ... + def copy(self) -> Self: ... + def digest(self) -> bytes: ... + def hexdigest(self) -> str: ... + def update(self, obj: ReadableBuffer, /) -> None: ... + +class HASH: + @property + def digest_size(self) -> int: ... + @property + def block_size(self) -> int: ... + @property + def name(self) -> str: ... + def copy(self) -> Self: ... + def digest(self) -> bytes: ... + def hexdigest(self) -> str: ... + def update(self, obj: ReadableBuffer, /) -> None: ... + +if sys.version_info >= (3, 10): + class UnsupportedDigestmodError(ValueError): ... + +class HASHXOF(HASH): + def digest(self, length: int) -> bytes: ... # type: ignore[override] + def hexdigest(self, length: int) -> str: ... # type: ignore[override] + +@final +class HMAC: + @property + def digest_size(self) -> int: ... + @property + def block_size(self) -> int: ... + @property + def name(self) -> str: ... + def copy(self) -> Self: ... + def digest(self) -> bytes: ... + def hexdigest(self) -> str: ... + def update(self, msg: ReadableBuffer) -> None: ... + +@overload +def compare_digest(a: ReadableBuffer, b: ReadableBuffer, /) -> bool: ... +@overload +def compare_digest(a: AnyStr, b: AnyStr, /) -> bool: ... +def get_fips_mode() -> int: ... +def hmac_new(key: bytes | bytearray, msg: ReadableBuffer = b"", digestmod: _DigestMod = None) -> HMAC: ... +def new(name: str, string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_md5(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha1(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha224(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha256(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha384(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha512(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha3_224(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha3_256(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha3_384(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_sha3_512(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASH: ... +def openssl_shake_128(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASHXOF: ... +def openssl_shake_256(string: ReadableBuffer = b"", *, usedforsecurity: bool = True) -> HASHXOF: ... +def hmac_digest(key: bytes | bytearray, msg: ReadableBuffer, digest: str) -> bytes: ... +def pbkdf2_hmac( + hash_name: str, password: ReadableBuffer, salt: ReadableBuffer, iterations: int, dklen: int | None = None +) -> bytes: ... +def scrypt( + password: ReadableBuffer, *, salt: ReadableBuffer, n: int, r: int, p: int, maxmem: int = 0, dklen: int = 64 +) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_heapq.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_heapq.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_heapq.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_heapq.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_imp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_imp.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_imp.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_imp.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpchannels.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_interpchannels.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_interpchannels.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_interpchannels.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_interpqueues.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_interpqueues.pyi new file mode 100644 index 0000000000000..c9323b106f3dc --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_interpqueues.pyi @@ -0,0 +1,19 @@ +from typing import Any, Literal, SupportsIndex +from typing_extensions import TypeAlias + +_UnboundOp: TypeAlias = Literal[1, 2, 3] + +class QueueError(RuntimeError): ... +class QueueNotFoundError(QueueError): ... + +def bind(qid: SupportsIndex) -> None: ... +def create(maxsize: SupportsIndex, fmt: SupportsIndex, unboundop: _UnboundOp) -> int: ... +def destroy(qid: SupportsIndex) -> None: ... +def get(qid: SupportsIndex) -> tuple[Any, int, _UnboundOp | None]: ... +def get_count(qid: SupportsIndex) -> int: ... +def get_maxsize(qid: SupportsIndex) -> int: ... +def get_queue_defaults(qid: SupportsIndex) -> tuple[int, _UnboundOp]: ... +def is_full(qid: SupportsIndex) -> bool: ... +def list_all() -> list[tuple[int, int, _UnboundOp]]: ... +def put(qid: SupportsIndex, obj: Any, fmt: SupportsIndex, unboundop: _UnboundOp) -> None: ... +def release(qid: SupportsIndex) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpreters.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_interpreters.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_interpreters.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_interpreters.pyi index 75f661a7e8e18..caa1115e9d3d6 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_interpreters.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_interpreters.pyi @@ -7,7 +7,7 @@ _Configs: TypeAlias = Literal["default", "isolated", "legacy", "empty", ""] class InterpreterError(Exception): ... class InterpreterNotFoundError(InterpreterError): ... -class NotShareableError(Exception): ... +class NotShareableError(ValueError): ... class CrossInterpreterBufferView: def __buffer__(self, flags: int, /) -> memoryview: ... @@ -21,7 +21,9 @@ def get_main() -> tuple[int, int]: ... def is_running(id: SupportsIndex, *, restrict: bool = False) -> bool: ... def get_config(id: SupportsIndex, *, restrict: bool = False) -> types.SimpleNamespace: ... def whence(id: SupportsIndex) -> int: ... -def exec(id: SupportsIndex, code: str, shared: bool | None = None, *, restrict: bool = False) -> None: ... +def exec( + id: SupportsIndex, code: str | types.CodeType | Callable[[], object], shared: bool | None = None, *, restrict: bool = False +) -> None | types.SimpleNamespace: ... def call( id: SupportsIndex, callable: Callable[..., object], diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_io.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_io.pyi new file mode 100644 index 0000000000000..c77d75287c25a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_io.pyi @@ -0,0 +1,242 @@ +import builtins +import codecs +import sys +from _typeshed import FileDescriptorOrPath, MaybeNone, ReadableBuffer, WriteableBuffer +from collections.abc import Callable, Iterable, Iterator +from io import BufferedIOBase, RawIOBase, TextIOBase, UnsupportedOperation as UnsupportedOperation +from os import _Opener +from types import TracebackType +from typing import IO, Any, BinaryIO, Final, Generic, Literal, Protocol, TextIO, TypeVar, overload, type_check_only +from typing_extensions import Self + +_T = TypeVar("_T") + +DEFAULT_BUFFER_SIZE: Final = 8192 + +open = builtins.open + +def open_code(path: str) -> IO[bytes]: ... + +BlockingIOError = builtins.BlockingIOError + +class _IOBase: + def __iter__(self) -> Iterator[bytes]: ... + def __next__(self) -> bytes: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + def close(self) -> None: ... + def fileno(self) -> int: ... + def flush(self) -> None: ... + def isatty(self) -> bool: ... + def readable(self) -> bool: ... + read: Callable[..., Any] + def readlines(self, hint: int = -1, /) -> list[bytes]: ... + def seek(self, offset: int, whence: int = 0, /) -> int: ... + def seekable(self) -> bool: ... + def tell(self) -> int: ... + def truncate(self, size: int | None = None, /) -> int: ... + def writable(self) -> bool: ... + write: Callable[..., Any] + def writelines(self, lines: Iterable[ReadableBuffer], /) -> None: ... + def readline(self, size: int | None = -1, /) -> bytes: ... + def __del__(self) -> None: ... + @property + def closed(self) -> bool: ... + def _checkClosed(self) -> None: ... # undocumented + +class _RawIOBase(_IOBase): + def readall(self) -> bytes: ... + # The following methods can return None if the file is in non-blocking mode + # and no data is available. + def readinto(self, buffer: WriteableBuffer, /) -> int | MaybeNone: ... + def write(self, b: ReadableBuffer, /) -> int | MaybeNone: ... + def read(self, size: int = -1, /) -> bytes | MaybeNone: ... + +class _BufferedIOBase(_IOBase): + def detach(self) -> RawIOBase: ... + def readinto(self, buffer: WriteableBuffer, /) -> int: ... + def write(self, buffer: ReadableBuffer, /) -> int: ... + def readinto1(self, buffer: WriteableBuffer, /) -> int: ... + def read(self, size: int | None = -1, /) -> bytes: ... + def read1(self, size: int = -1, /) -> bytes: ... + +class FileIO(RawIOBase, _RawIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of writelines in the base classes + mode: str + # The type of "name" equals the argument passed in to the constructor, + # but that can make FileIO incompatible with other I/O types that assume + # "name" is a str. In the future, making FileIO generic might help. + name: Any + def __init__( + self, file: FileDescriptorOrPath, mode: str = "r", closefd: bool = True, opener: _Opener | None = None + ) -> None: ... + @property + def closefd(self) -> bool: ... + def seek(self, pos: int, whence: int = 0, /) -> int: ... + def read(self, size: int | None = -1, /) -> bytes | MaybeNone: ... + +class BytesIO(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of methods in the base classes + def __init__(self, initial_bytes: ReadableBuffer = b"") -> None: ... + # BytesIO does not contain a "name" field. This workaround is necessary + # to allow BytesIO sub-classes to add this field, as it is defined + # as a read-only property on IO[]. + name: Any + def getvalue(self) -> bytes: ... + def getbuffer(self) -> memoryview: ... + def read1(self, size: int | None = -1, /) -> bytes: ... + def readlines(self, size: int | None = None, /) -> list[bytes]: ... + def seek(self, pos: int, whence: int = 0, /) -> int: ... + +class _BufferedReaderStream(Protocol): + def read(self, n: int = ..., /) -> bytes: ... + # Optional: def readall(self) -> bytes: ... + def readinto(self, b: memoryview, /) -> int | None: ... + def seek(self, pos: int, whence: int, /) -> int: ... + def tell(self) -> int: ... + def truncate(self, size: int, /) -> int: ... + def flush(self) -> object: ... + def close(self) -> object: ... + @property + def closed(self) -> bool: ... + def readable(self) -> bool: ... + def seekable(self) -> bool: ... + + # The following methods just pass through to the underlying stream. Since + # not all streams support them, they are marked as optional here, and will + # raise an AttributeError if called on a stream that does not support them. + + # @property + # def name(self) -> Any: ... # Type is inconsistent between the various I/O types. + # @property + # def mode(self) -> str: ... + # def fileno(self) -> int: ... + # def isatty(self) -> bool: ... + +_BufferedReaderStreamT = TypeVar("_BufferedReaderStreamT", bound=_BufferedReaderStream, default=_BufferedReaderStream) + +class BufferedReader(BufferedIOBase, _BufferedIOBase, BinaryIO, Generic[_BufferedReaderStreamT]): # type: ignore[misc] # incompatible definitions of methods in the base classes + raw: _BufferedReaderStreamT + def __init__(self, raw: _BufferedReaderStreamT, buffer_size: int = 8192) -> None: ... + def peek(self, size: int = 0, /) -> bytes: ... + def seek(self, target: int, whence: int = 0, /) -> int: ... + def truncate(self, pos: int | None = None, /) -> int: ... + +class BufferedWriter(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of writelines in the base classes + raw: RawIOBase + def __init__(self, raw: RawIOBase, buffer_size: int = 8192) -> None: ... + def write(self, buffer: ReadableBuffer, /) -> int: ... + def seek(self, target: int, whence: int = 0, /) -> int: ... + def truncate(self, pos: int | None = None, /) -> int: ... + +class BufferedRandom(BufferedIOBase, _BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible definitions of methods in the base classes + mode: str + name: Any + raw: RawIOBase + def __init__(self, raw: RawIOBase, buffer_size: int = 8192) -> None: ... + def seek(self, target: int, whence: int = 0, /) -> int: ... # stubtest needs this + def peek(self, size: int = 0, /) -> bytes: ... + def truncate(self, pos: int | None = None, /) -> int: ... + +class BufferedRWPair(BufferedIOBase, _BufferedIOBase, Generic[_BufferedReaderStreamT]): + def __init__(self, reader: _BufferedReaderStreamT, writer: RawIOBase, buffer_size: int = 8192, /) -> None: ... + def peek(self, size: int = 0, /) -> bytes: ... + +class _TextIOBase(_IOBase): + encoding: str + errors: str | None + newlines: str | tuple[str, ...] | None + def __iter__(self) -> Iterator[str]: ... # type: ignore[override] + def __next__(self) -> str: ... # type: ignore[override] + def detach(self) -> BinaryIO: ... + def write(self, s: str, /) -> int: ... + def writelines(self, lines: Iterable[str], /) -> None: ... # type: ignore[override] + def readline(self, size: int = -1, /) -> str: ... # type: ignore[override] + def readlines(self, hint: int = -1, /) -> list[str]: ... # type: ignore[override] + def read(self, size: int | None = -1, /) -> str: ... + +@type_check_only +class _WrappedBuffer(Protocol): + # "name" is wrapped by TextIOWrapper. Its type is inconsistent between + # the various I/O types. + @property + def name(self) -> Any: ... + @property + def closed(self) -> bool: ... + def read(self, size: int = ..., /) -> ReadableBuffer: ... + # Optional: def read1(self, size: int, /) -> ReadableBuffer: ... + def write(self, b: bytes, /) -> object: ... + def flush(self) -> object: ... + def close(self) -> object: ... + def seekable(self) -> bool: ... + def readable(self) -> bool: ... + def writable(self) -> bool: ... + def truncate(self, size: int, /) -> int: ... + def fileno(self) -> int: ... + def isatty(self) -> bool: ... + # Optional: Only needs to be present if seekable() returns True. + # def seek(self, offset: Literal[0], whence: Literal[2]) -> int: ... + # def tell(self) -> int: ... + +_BufferT_co = TypeVar("_BufferT_co", bound=_WrappedBuffer, default=_WrappedBuffer, covariant=True) + +class TextIOWrapper(TextIOBase, _TextIOBase, TextIO, Generic[_BufferT_co]): # type: ignore[misc] # incompatible definitions of write in the base classes + def __init__( + self, + buffer: _BufferT_co, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + line_buffering: bool = False, + write_through: bool = False, + ) -> None: ... + # Equals the "buffer" argument passed in to the constructor. + @property + def buffer(self) -> _BufferT_co: ... # type: ignore[override] + @property + def line_buffering(self) -> bool: ... + @property + def write_through(self) -> bool: ... + def reconfigure( + self, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + line_buffering: bool | None = None, + write_through: bool | None = None, + ) -> None: ... + def readline(self, size: int = -1, /) -> str: ... # type: ignore[override] + # Equals the "buffer" argument passed in to the constructor. + def detach(self) -> _BufferT_co: ... # type: ignore[override] + # TextIOWrapper's version of seek only supports a limited subset of + # operations. + def seek(self, cookie: int, whence: int = 0, /) -> int: ... + def truncate(self, pos: int | None = None, /) -> int: ... + +class StringIO(TextIOBase, _TextIOBase, TextIO): # type: ignore[misc] # incompatible definitions of write in the base classes + def __init__(self, initial_value: str | None = "", newline: str | None = "\n") -> None: ... + # StringIO does not contain a "name" field. This workaround is necessary + # to allow StringIO sub-classes to add this field, as it is defined + # as a read-only property on IO[]. + name: Any + def getvalue(self) -> str: ... + @property + def line_buffering(self) -> bool: ... + def seek(self, pos: int, whence: int = 0, /) -> int: ... + def truncate(self, pos: int | None = None, /) -> int: ... + +class IncrementalNewlineDecoder: + def __init__(self, decoder: codecs.IncrementalDecoder | None, translate: bool, errors: str = "strict") -> None: ... + def decode(self, input: ReadableBuffer | str, final: bool = False) -> str: ... + @property + def newlines(self) -> str | tuple[str, ...] | None: ... + def getstate(self) -> tuple[bytes, int]: ... + def reset(self) -> None: ... + def setstate(self, state: tuple[bytes, int], /) -> None: ... + +if sys.version_info >= (3, 10): + @overload + def text_encoding(encoding: None, stacklevel: int = 2, /) -> Literal["locale", "utf-8"]: ... + @overload + def text_encoding(encoding: _T, stacklevel: int = 2, /) -> _T: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_json.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_json.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_json.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_json.pyi index 069fb6eac4bf5..5296b8e62a028 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_json.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_json.pyi @@ -1,5 +1,6 @@ from collections.abc import Callable from typing import Any, final +from typing_extensions import Self @final class make_encoder: @@ -19,8 +20,8 @@ class make_encoder: def encoder(self) -> Callable[[str], str]: ... @property def item_separator(self) -> str: ... - def __init__( - self, + def __new__( + cls, markers: dict[int, Any] | None, default: Callable[[Any], Any], encoder: Callable[[str], str], @@ -30,7 +31,7 @@ class make_encoder: sort_keys: bool, skipkeys: bool, allow_nan: bool, - ) -> None: ... + ) -> Self: ... def __call__(self, obj: object, _current_indent_level: int) -> Any: ... @final @@ -42,8 +43,9 @@ class make_scanner: parse_float: Any strict: bool # TODO: 'context' needs the attrs above (ducktype), but not __call__. - def __init__(self, context: make_scanner) -> None: ... + def __new__(cls, context: make_scanner) -> Self: ... def __call__(self, string: str, index: int) -> tuple[Any, int]: ... +def encode_basestring(s: str, /) -> str: ... def encode_basestring_ascii(s: str, /) -> str: ... def scanstring(string: str, end: int, strict: bool = ...) -> tuple[str, int]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_locale.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_locale.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_locale.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_locale.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_lsprof.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_lsprof.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_lsprof.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_lsprof.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_lzma.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_lzma.pyi new file mode 100644 index 0000000000000..1a27c7428e8ec --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_lzma.pyi @@ -0,0 +1,71 @@ +import sys +from _typeshed import ReadableBuffer +from collections.abc import Mapping, Sequence +from typing import Any, Final, final +from typing_extensions import Self, TypeAlias + +_FilterChain: TypeAlias = Sequence[Mapping[str, Any]] + +FORMAT_AUTO: Final = 0 +FORMAT_XZ: Final = 1 +FORMAT_ALONE: Final = 2 +FORMAT_RAW: Final = 3 +CHECK_NONE: Final = 0 +CHECK_CRC32: Final = 1 +CHECK_CRC64: Final = 4 +CHECK_SHA256: Final = 10 +CHECK_ID_MAX: Final = 15 +CHECK_UNKNOWN: Final = 16 +FILTER_LZMA1: int # v big number +FILTER_LZMA2: Final = 33 +FILTER_DELTA: Final = 3 +FILTER_X86: Final = 4 +FILTER_IA64: Final = 6 +FILTER_ARM: Final = 7 +FILTER_ARMTHUMB: Final = 8 +FILTER_SPARC: Final = 9 +FILTER_POWERPC: Final = 5 +MF_HC3: Final = 3 +MF_HC4: Final = 4 +MF_BT2: Final = 18 +MF_BT3: Final = 19 +MF_BT4: Final = 20 +MODE_FAST: Final = 1 +MODE_NORMAL: Final = 2 +PRESET_DEFAULT: Final = 6 +PRESET_EXTREME: int # v big number + +@final +class LZMADecompressor: + if sys.version_info >= (3, 12): + def __new__(cls, format: int | None = ..., memlimit: int | None = ..., filters: _FilterChain | None = ...) -> Self: ... + else: + def __init__(self, format: int | None = ..., memlimit: int | None = ..., filters: _FilterChain | None = ...) -> None: ... + + def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes: ... + @property + def check(self) -> int: ... + @property + def eof(self) -> bool: ... + @property + def unused_data(self) -> bytes: ... + @property + def needs_input(self) -> bool: ... + +@final +class LZMACompressor: + if sys.version_info >= (3, 12): + def __new__( + cls, format: int | None = ..., check: int = ..., preset: int | None = ..., filters: _FilterChain | None = ... + ) -> Self: ... + else: + def __init__( + self, format: int | None = ..., check: int = ..., preset: int | None = ..., filters: _FilterChain | None = ... + ) -> None: ... + + def compress(self, data: ReadableBuffer, /) -> bytes: ... + def flush(self) -> bytes: ... + +class LZMAError(Exception): ... + +def is_check_supported(check_id: int, /) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_markupbase.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_markupbase.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_markupbase.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_markupbase.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_msi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_msi.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_msi.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_msi.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_multibytecodec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_multibytecodec.pyi new file mode 100644 index 0000000000000..7e408f2aa30e1 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_multibytecodec.pyi @@ -0,0 +1,44 @@ +from _typeshed import ReadableBuffer +from codecs import _ReadableStream, _WritableStream +from collections.abc import Iterable +from typing import final, type_check_only + +# This class is not exposed. It calls itself _multibytecodec.MultibyteCodec. +@final +@type_check_only +class _MultibyteCodec: + def decode(self, input: ReadableBuffer, errors: str | None = None) -> str: ... + def encode(self, input: str, errors: str | None = None) -> bytes: ... + +class MultibyteIncrementalDecoder: + errors: str + def __init__(self, errors: str = "strict") -> None: ... + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + def getstate(self) -> tuple[bytes, int]: ... + def reset(self) -> None: ... + def setstate(self, state: tuple[bytes, int], /) -> None: ... + +class MultibyteIncrementalEncoder: + errors: str + def __init__(self, errors: str = "strict") -> None: ... + def encode(self, input: str, final: bool = False) -> bytes: ... + def getstate(self) -> int: ... + def reset(self) -> None: ... + def setstate(self, state: int, /) -> None: ... + +class MultibyteStreamReader: + errors: str + stream: _ReadableStream + def __init__(self, stream: _ReadableStream, errors: str = "strict") -> None: ... + def read(self, sizeobj: int | None = None, /) -> str: ... + def readline(self, sizeobj: int | None = None, /) -> str: ... + def readlines(self, sizehintobj: int | None = None, /) -> list[str]: ... + def reset(self) -> None: ... + +class MultibyteStreamWriter: + errors: str + stream: _WritableStream + def __init__(self, stream: _WritableStream, errors: str = "strict") -> None: ... + def reset(self) -> None: ... + def write(self, strobj: str, /) -> None: ... + def writelines(self, lines: Iterable[str], /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_operator.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_operator.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_operator.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_operator.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_osx_support.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_osx_support.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_osx_support.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_osx_support.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_pickle.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_pickle.pyi new file mode 100644 index 0000000000000..8e8afb600efac --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_pickle.pyi @@ -0,0 +1,104 @@ +from _typeshed import ReadableBuffer, SupportsWrite +from collections.abc import Callable, Iterable, Iterator, Mapping +from pickle import PickleBuffer as PickleBuffer +from typing import Any, Protocol, type_check_only +from typing_extensions import TypeAlias + +class _ReadableFileobj(Protocol): + def read(self, n: int, /) -> bytes: ... + def readline(self) -> bytes: ... + +_BufferCallback: TypeAlias = Callable[[PickleBuffer], Any] | None + +_ReducedType: TypeAlias = ( + str + | tuple[Callable[..., Any], tuple[Any, ...]] + | tuple[Callable[..., Any], tuple[Any, ...], Any] + | tuple[Callable[..., Any], tuple[Any, ...], Any, Iterator[Any] | None] + | tuple[Callable[..., Any], tuple[Any, ...], Any, Iterator[Any] | None, Iterator[Any] | None] +) + +def dump( + obj: Any, + file: SupportsWrite[bytes], + protocol: int | None = None, + *, + fix_imports: bool = True, + buffer_callback: _BufferCallback = None, +) -> None: ... +def dumps( + obj: Any, protocol: int | None = None, *, fix_imports: bool = True, buffer_callback: _BufferCallback = None +) -> bytes: ... +def load( + file: _ReadableFileobj, + *, + fix_imports: bool = True, + encoding: str = "ASCII", + errors: str = "strict", + buffers: Iterable[Any] | None = (), +) -> Any: ... +def loads( + data: ReadableBuffer, + /, + *, + fix_imports: bool = True, + encoding: str = "ASCII", + errors: str = "strict", + buffers: Iterable[Any] | None = (), +) -> Any: ... + +class PickleError(Exception): ... +class PicklingError(PickleError): ... +class UnpicklingError(PickleError): ... + +@type_check_only +class PicklerMemoProxy: + def clear(self, /) -> None: ... + def copy(self, /) -> dict[int, tuple[int, Any]]: ... + +class Pickler: + fast: bool + dispatch_table: Mapping[type, Callable[[Any], _ReducedType]] + reducer_override: Callable[[Any], Any] + bin: bool # undocumented + def __init__( + self, + file: SupportsWrite[bytes], + protocol: int | None = None, + fix_imports: bool = True, + buffer_callback: _BufferCallback = None, + ) -> None: ... + @property + def memo(self) -> PicklerMemoProxy: ... + @memo.setter + def memo(self, value: PicklerMemoProxy | dict[int, tuple[int, Any]]) -> None: ... + def dump(self, obj: Any, /) -> None: ... + def clear_memo(self) -> None: ... + + # this method has no default implementation for Python < 3.13 + def persistent_id(self, obj: Any, /) -> Any: ... + +@type_check_only +class UnpicklerMemoProxy: + def clear(self, /) -> None: ... + def copy(self, /) -> dict[int, tuple[int, Any]]: ... + +class Unpickler: + def __init__( + self, + file: _ReadableFileobj, + *, + fix_imports: bool = True, + encoding: str = "ASCII", + errors: str = "strict", + buffers: Iterable[Any] | None = (), + ) -> None: ... + @property + def memo(self) -> UnpicklerMemoProxy: ... + @memo.setter + def memo(self, value: UnpicklerMemoProxy | dict[int, tuple[int, Any]]) -> None: ... + def load(self) -> Any: ... + def find_class(self, module_name: str, global_name: str, /) -> Any: ... + + # this method has no default implementation for Python < 3.13 + def persistent_load(self, pid: Any, /) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi index 3df56d9a3d03a..df05dcd80be80 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_posixsubprocess.pyi @@ -4,7 +4,6 @@ from collections.abc import Callable, Sequence from typing import SupportsIndex if sys.platform != "win32": - def cloexec_pipe() -> tuple[int, int]: ... def fork_exec( args: Sequence[StrOrBytesPath] | None, executable_list: Sequence[bytes], diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_py_abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_py_abc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_py_abc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_py_abc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_pydecimal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_pydecimal.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_pydecimal.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_pydecimal.pyi index faff626ac0bae..a6723f749da6d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_pydecimal.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_pydecimal.pyi @@ -1,5 +1,6 @@ # This is a slight lie, the implementations aren't exactly identical # However, in all likelihood, the differences are inconsequential +import sys from _decimal import * __all__ = [ @@ -41,3 +42,6 @@ __all__ = [ "HAVE_THREADS", "HAVE_CONTEXTVAR", ] + +if sys.version_info >= (3, 14): + __all__ += ["IEEEContext", "IEEE_CONTEXT_MAX_BITS"] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_queue.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_queue.pyi new file mode 100644 index 0000000000000..f98397b132aba --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_queue.pyi @@ -0,0 +1,16 @@ +from types import GenericAlias +from typing import Any, Generic, TypeVar + +_T = TypeVar("_T") + +class Empty(Exception): ... + +class SimpleQueue(Generic[_T]): + def __init__(self) -> None: ... + def empty(self) -> bool: ... + def get(self, block: bool = True, timeout: float | None = None) -> _T: ... + def get_nowait(self) -> _T: ... + def put(self, item: _T, block: bool = True, timeout: float | None = None) -> None: ... + def put_nowait(self, item: _T) -> None: ... + def qsize(self) -> int: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_random.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_random.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_random.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_random.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi new file mode 100644 index 0000000000000..eb6c811294216 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_sitebuiltins.pyi @@ -0,0 +1,17 @@ +import sys +from collections.abc import Iterable +from typing import ClassVar, Literal, NoReturn + +class Quitter: + name: str + eof: str + def __init__(self, name: str, eof: str) -> None: ... + def __call__(self, code: sys._ExitCode = None) -> NoReturn: ... + +class _Printer: + MAXLINES: ClassVar[Literal[23]] + def __init__(self, name: str, data: str, files: Iterable[str] = (), dirs: Iterable[str] = ()) -> None: ... + def __call__(self) -> None: ... + +class _Helper: + def __call__(self, request: object = ...) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_socket.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_socket.pyi similarity index 80% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_socket.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_socket.pyi index 7e4cf4e0364a2..06a8a2ba5fa06 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_socket.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_socket.pyi @@ -3,7 +3,7 @@ from _typeshed import ReadableBuffer, WriteableBuffer from collections.abc import Iterable from socket import error as error, gaierror as gaierror, herror as herror, timeout as timeout from typing import Any, SupportsIndex, overload -from typing_extensions import TypeAlias +from typing_extensions import CapsuleType, TypeAlias _CMSG: TypeAlias = tuple[int, int, bytes] _CMSGArg: TypeAlias = tuple[int, int, ReadableBuffer] @@ -72,13 +72,16 @@ SO_SNDBUF: int SO_SNDLOWAT: int SO_SNDTIMEO: int SO_TYPE: int -SO_USELOOPBACK: int +if sys.platform != "linux": + SO_USELOOPBACK: int if sys.platform == "win32": SO_EXCLUSIVEADDRUSE: int if sys.platform != "win32": SO_REUSEPORT: int + if sys.platform != "darwin" or sys.version_info >= (3, 13): + SO_BINDTODEVICE: int + if sys.platform != "win32" and sys.platform != "darwin": - SO_BINDTODEVICE: int SO_DOMAIN: int SO_MARK: int SO_PASSCRED: int @@ -87,7 +90,10 @@ if sys.platform != "win32" and sys.platform != "darwin": SO_PEERSEC: int SO_PRIORITY: int SO_PROTOCOL: int +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": SO_SETFIB: int +if sys.platform == "linux" and sys.version_info >= (3, 13): + SO_BINDTOIFINDEX: int SOMAXCONN: int @@ -99,27 +105,32 @@ MSG_TRUNC: int MSG_WAITALL: int if sys.platform != "win32": MSG_DONTWAIT: int - MSG_EOF: int MSG_EOR: int MSG_NOSIGNAL: int # Sometimes this exists on darwin, sometimes not if sys.platform != "darwin": - MSG_BCAST: int MSG_ERRQUEUE: int +if sys.platform == "win32": + MSG_BCAST: int MSG_MCAST: int if sys.platform != "win32" and sys.platform != "darwin": - MSG_BTAG: int MSG_CMSG_CLOEXEC: int MSG_CONFIRM: int - MSG_ETAG: int MSG_FASTOPEN: int MSG_MORE: int +if sys.platform != "win32" and sys.platform != "linux": + MSG_EOF: int +if sys.platform != "win32" and sys.platform != "linux" and sys.platform != "darwin": MSG_NOTIFICATION: int + MSG_BTAG: int # Not FreeBSD either + MSG_ETAG: int # Not FreeBSD either SOL_IP: int SOL_SOCKET: int SOL_TCP: int SOL_UDP: int if sys.platform != "win32" and sys.platform != "darwin": + # Defined in socket.h for Linux, but these aren't always present for + # some reason. SOL_ATALK: int SOL_AX25: int SOL_HCI: int @@ -128,10 +139,11 @@ if sys.platform != "win32" and sys.platform != "darwin": SOL_ROSE: int if sys.platform != "win32": - SCM_CREDS: int SCM_RIGHTS: int if sys.platform != "win32" and sys.platform != "darwin": SCM_CREDENTIALS: int +if sys.platform != "win32" and sys.platform != "linux": + SCM_CREDS: int IPPROTO_ICMP: int IPPROTO_IP: int @@ -143,21 +155,22 @@ IPPROTO_DSTOPTS: int IPPROTO_EGP: int IPPROTO_ESP: int IPPROTO_FRAGMENT: int -IPPROTO_GGP: int IPPROTO_HOPOPTS: int IPPROTO_ICMPV6: int IPPROTO_IDP: int IPPROTO_IGMP: int -IPPROTO_IPV4: int IPPROTO_IPV6: int -IPPROTO_MAX: int -IPPROTO_ND: int IPPROTO_NONE: int IPPROTO_PIM: int IPPROTO_PUP: int IPPROTO_ROUTING: int IPPROTO_SCTP: int -if sys.platform != "darwin": +if sys.platform != "linux": + IPPROTO_GGP: int + IPPROTO_IPV4: int + IPPROTO_MAX: int + IPPROTO_ND: int +if sys.platform == "win32": IPPROTO_CBT: int IPPROTO_ICLFXBM: int IPPROTO_IGP: int @@ -166,19 +179,20 @@ if sys.platform != "darwin": IPPROTO_RDP: int IPPROTO_ST: int if sys.platform != "win32": - IPPROTO_EON: int IPPROTO_GRE: int - IPPROTO_HELLO: int - IPPROTO_IPCOMP: int IPPROTO_IPIP: int IPPROTO_RSVP: int IPPROTO_TP: int +if sys.platform != "win32" and sys.platform != "linux": + IPPROTO_EON: int + IPPROTO_HELLO: int + IPPROTO_IPCOMP: int IPPROTO_XTP: int -if sys.platform != "win32" and sys.platform != "darwin": - IPPROTO_BIP: int - IPPROTO_MOBILE: int - IPPROTO_VRRP: int -if sys.version_info >= (3, 9) and sys.platform == "linux": +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": + IPPROTO_BIP: int # Not FreeBSD either + IPPROTO_MOBILE: int # Not FreeBSD either + IPPROTO_VRRP: int # Not FreeBSD either +if sys.platform == "linux": # Availability: Linux >= 2.6.20, FreeBSD >= 10.1 IPPROTO_UDPLITE: int if sys.version_info >= (3, 10) and sys.platform == "linux": @@ -202,11 +216,10 @@ IP_MULTICAST_IF: int IP_MULTICAST_LOOP: int IP_MULTICAST_TTL: int IP_OPTIONS: int -IP_RECVDSTADDR: int +if sys.platform != "linux": + IP_RECVDSTADDR: int if sys.version_info >= (3, 10): IP_RECVTOS: int -elif sys.platform != "win32" and sys.platform != "darwin": - IP_RECVTOS: int IP_TOS: int IP_TTL: int if sys.platform != "win32": @@ -216,8 +229,31 @@ if sys.platform != "win32": IP_RECVOPTS: int IP_RECVRETOPTS: int IP_RETOPTS: int +if sys.version_info >= (3, 14): + IP_RECVTTL: int + + if sys.platform == "win32" or sys.platform == "linux": + IPV6_RECVERR: int + IP_RECVERR: int + SO_ORIGINAL_DST: int + + if sys.platform == "win32": + SOL_RFCOMM: int + SO_BTH_ENCRYPT: int + SO_BTH_MTU: int + SO_BTH_MTU_MAX: int + SO_BTH_MTU_MIN: int + TCP_QUICKACK: int + + if sys.platform == "linux": + CAN_RAW_ERR_FILTER: int + IP_FREEBIND: int + IP_RECVORIGDSTADDR: int + VMADDR_CID_LOCAL: int + if sys.platform != "win32" and sys.platform != "darwin": IP_TRANSPARENT: int +if sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 11): IP_BIND_ADDRESS_NO_PORT: int if sys.version_info >= (3, 12): IP_ADD_SOURCE_MEMBERSHIP: int @@ -236,26 +272,26 @@ IPV6_RECVTCLASS: int IPV6_TCLASS: int IPV6_UNICAST_HOPS: int IPV6_V6ONLY: int -if sys.version_info >= (3, 9) or sys.platform != "darwin": - IPV6_DONTFRAG: int - IPV6_HOPLIMIT: int - IPV6_HOPOPTS: int - IPV6_PKTINFO: int - IPV6_RECVRTHDR: int - IPV6_RTHDR: int +IPV6_DONTFRAG: int +IPV6_HOPLIMIT: int +IPV6_HOPOPTS: int +IPV6_PKTINFO: int +IPV6_RECVRTHDR: int +IPV6_RTHDR: int if sys.platform != "win32": IPV6_RTHDR_TYPE_0: int - if sys.version_info >= (3, 9) or sys.platform != "darwin": - IPV6_DSTOPTS: int - IPV6_NEXTHOP: int - IPV6_PATHMTU: int - IPV6_RECVDSTOPTS: int - IPV6_RECVHOPLIMIT: int - IPV6_RECVHOPOPTS: int - IPV6_RECVPATHMTU: int - IPV6_RECVPKTINFO: int - IPV6_RTHDRDSTOPTS: int - IPV6_USE_MIN_MTU: int + IPV6_DSTOPTS: int + IPV6_NEXTHOP: int + IPV6_PATHMTU: int + IPV6_RECVDSTOPTS: int + IPV6_RECVHOPLIMIT: int + IPV6_RECVHOPOPTS: int + IPV6_RECVPATHMTU: int + IPV6_RECVPKTINFO: int + IPV6_RTHDRDSTOPTS: int + +if sys.platform != "win32" and sys.platform != "linux": + IPV6_USE_MIN_MTU: int EAI_AGAIN: int EAI_BADFLAGS: int @@ -268,11 +304,12 @@ EAI_SERVICE: int EAI_SOCKTYPE: int if sys.platform != "win32": EAI_ADDRFAMILY: int + EAI_OVERFLOW: int + EAI_SYSTEM: int +if sys.platform != "win32" and sys.platform != "linux": EAI_BADHINTS: int EAI_MAX: int - EAI_OVERFLOW: int EAI_PROTOCOL: int - EAI_SYSTEM: int AI_ADDRCONFIG: int AI_ALL: int @@ -281,7 +318,7 @@ AI_NUMERICHOST: int AI_NUMERICSERV: int AI_PASSIVE: int AI_V4MAPPED: int -if sys.platform != "win32": +if sys.platform != "win32" and sys.platform != "linux": AI_DEFAULT: int AI_MASK: int AI_V4MAPPED_CFG: int @@ -293,6 +330,8 @@ NI_NAMEREQD: int NI_NOFQDN: int NI_NUMERICHOST: int NI_NUMERICSERV: int +if sys.platform == "linux" and sys.version_info >= (3, 13): + NI_IDN: int TCP_FASTOPEN: int TCP_KEEPCNT: int @@ -318,6 +357,27 @@ if sys.platform != "win32" and sys.platform != "darwin": TCP_SYNCNT: int TCP_USER_TIMEOUT: int TCP_WINDOW_CLAMP: int +if sys.platform == "linux" and sys.version_info >= (3, 12): + TCP_CC_INFO: int + TCP_FASTOPEN_CONNECT: int + TCP_FASTOPEN_KEY: int + TCP_FASTOPEN_NO_COOKIE: int + TCP_INQ: int + TCP_MD5SIG: int + TCP_MD5SIG_EXT: int + TCP_QUEUE_SEQ: int + TCP_REPAIR: int + TCP_REPAIR_OPTIONS: int + TCP_REPAIR_QUEUE: int + TCP_REPAIR_WINDOW: int + TCP_SAVED_SYN: int + TCP_SAVE_SYN: int + TCP_THIN_DUPACK: int + TCP_THIN_LINEAR_TIMEOUTS: int + TCP_TIMESTAMP: int + TCP_TX_DELAY: int + TCP_ULP: int + TCP_ZEROCOPY_RECEIVE: int # -------------------- # Specifically documented constants @@ -334,12 +394,13 @@ if sys.platform == "linux": CAN_ERR_FLAG: int CAN_ERR_MASK: int CAN_RAW: int - CAN_RAW_ERR_FILTER: int CAN_RAW_FILTER: int CAN_RAW_LOOPBACK: int CAN_RAW_RECV_OWN_MSGS: int CAN_RTR_FLAG: int CAN_SFF_MASK: int + if sys.version_info < (3, 11): + CAN_RAW_ERR_FILTER: int if sys.platform == "linux": # Availability: Linux >= 2.6.25 @@ -372,16 +433,10 @@ if sys.platform == "linux": if sys.platform == "linux": # Availability: Linux >= 3.6 CAN_RAW_FD_FRAMES: int - -if sys.platform == "linux" and sys.version_info >= (3, 9): # Availability: Linux >= 4.1 CAN_RAW_JOIN_FILTERS: int - -if sys.platform == "linux": # Availability: Linux >= 2.6.25 CAN_ISOTP: int - -if sys.platform == "linux" and sys.version_info >= (3, 9): # Availability: Linux >= 5.4 CAN_J1939: int @@ -437,12 +492,13 @@ if sys.platform == "linux": AF_RDS: int PF_RDS: int SOL_RDS: int + # These are present in include/linux/rds.h but don't always show up + # here. RDS_CANCEL_SENT_TO: int RDS_CMSG_RDMA_ARGS: int RDS_CMSG_RDMA_DEST: int RDS_CMSG_RDMA_MAP: int RDS_CMSG_RDMA_STATUS: int - RDS_CMSG_RDMA_UPDATE: int RDS_CONG_MONITOR: int RDS_FREE_MR: int RDS_GET_MR: int @@ -456,6 +512,10 @@ if sys.platform == "linux": RDS_RDMA_USE_ONCE: int RDS_RECVERR: int + # This is supported by CPython but doesn't seem to be a real thing. + # The closest existing constant in rds.h is RDS_CMSG_CONG_UPDATE + # RDS_CMSG_RDMA_UPDATE: int + if sys.platform == "win32": SIO_RCVALL: int SIO_KEEPALIVE_VALS: int @@ -519,19 +579,18 @@ if sys.platform == "linux": SO_VM_SOCKETS_BUFFER_MIN_SIZE: int VM_SOCKETS_INVALID_VERSION: int # undocumented -if sys.platform != "win32" or sys.version_info >= (3, 9): - # Documented as only available on BSD, macOS, but empirically sometimes - # available on Windows +# Documented as only available on BSD, macOS, but empirically sometimes +# available on Windows +if sys.platform != "linux": AF_LINK: int has_ipv6: bool -if sys.platform != "darwin": - if sys.platform != "win32" or sys.version_info >= (3, 9): - BDADDR_ANY: str - BDADDR_LOCAL: str +if sys.platform != "darwin" and sys.platform != "linux": + BDADDR_ANY: str + BDADDR_LOCAL: str -if sys.platform != "win32" and sys.platform != "darwin": +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": HCI_FILTER: int # not in NetBSD or DragonFlyBSD HCI_TIME_STAMP: int # not in FreeBSD, NetBSD, or DragonFlyBSD HCI_DATA_DIR: int # not in FreeBSD, NetBSD, or DragonFlyBSD @@ -580,40 +639,39 @@ if sys.version_info >= (3, 12): if sys.platform == "linux": # Netlink is defined by Linux AF_NETLINK: int - NETLINK_ARPD: int NETLINK_CRYPTO: int NETLINK_DNRTMSG: int NETLINK_FIREWALL: int NETLINK_IP6_FW: int NETLINK_NFLOG: int - NETLINK_ROUTE6: int NETLINK_ROUTE: int - NETLINK_SKIP: int - NETLINK_TAPBASE: int - NETLINK_TCPDIAG: int NETLINK_USERSOCK: int - NETLINK_W1: int NETLINK_XFRM: int + # Technically still supported by CPython + # NETLINK_ARPD: int # linux 2.0 to 2.6.12 (EOL August 2005) + # NETLINK_ROUTE6: int # linux 2.2 to 2.6.12 (EOL August 2005) + # NETLINK_SKIP: int # linux 2.0 to 2.6.12 (EOL August 2005) + # NETLINK_TAPBASE: int # linux 2.2 to 2.6.12 (EOL August 2005) + # NETLINK_TCPDIAG: int # linux 2.6.0 to 2.6.13 (EOL December 2005) + # NETLINK_W1: int # linux 2.6.13 to 2.6.17 (EOL October 2006) if sys.platform == "darwin": PF_SYSTEM: int SYSPROTO_CONTROL: int -if sys.platform != "darwin": - if sys.version_info >= (3, 9) or sys.platform != "win32": - AF_BLUETOOTH: int +if sys.platform != "darwin" and sys.platform != "linux": + AF_BLUETOOTH: int -if sys.platform != "win32" and sys.platform != "darwin": +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": # Linux and some BSD support is explicit in the docs # Windows and macOS do not support in practice BTPROTO_HCI: int BTPROTO_L2CAP: int BTPROTO_SCO: int # not in FreeBSD -if sys.platform != "darwin": - if sys.version_info >= (3, 9) or sys.platform != "win32": - BTPROTO_RFCOMM: int +if sys.platform != "darwin" and sys.platform != "linux": + BTPROTO_RFCOMM: int -if sys.version_info >= (3, 9) and sys.platform == "linux": +if sys.platform == "linux": UDPLITE_RECV_CSCOV: int UDPLITE_SEND_CSCOV: int @@ -636,13 +694,14 @@ AF_SNA: int if sys.platform != "win32": AF_ROUTE: int + +if sys.platform == "darwin": AF_SYSTEM: int if sys.platform != "darwin": AF_IRDA: int if sys.platform != "win32" and sys.platform != "darwin": - AF_AAL5: int AF_ASH: int AF_ATMPVC: int AF_ATMSVC: int @@ -661,10 +720,12 @@ if sys.platform != "win32" and sys.platform != "darwin": # Miscellaneous undocumented -if sys.platform != "win32": +if sys.platform != "win32" and sys.platform != "linux": LOCAL_PEERCRED: int if sys.platform != "win32" and sys.platform != "darwin": + # Defined in linux socket.h, but this isn't always present for + # some reason. IPX_TYPE: int # ===== Classes ===== @@ -760,12 +821,12 @@ def getaddrinfo( type: int = ..., proto: int = ..., flags: int = ..., -) -> list[tuple[int, int, int, str, tuple[str, int] | tuple[str, int, int, int]]]: ... +) -> list[tuple[int, int, int, str, tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]]]: ... def gethostbyname(hostname: str, /) -> str: ... def gethostbyname_ex(hostname: str, /) -> tuple[str, list[str], list[str]]: ... def gethostname() -> str: ... def gethostbyaddr(ip_address: str, /) -> tuple[str, list[str], list[str]]: ... -def getnameinfo(sockaddr: tuple[str, int] | tuple[str, int, int, int], flags: int, /) -> tuple[str, str]: ... +def getnameinfo(sockaddr: tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes], flags: int, /) -> tuple[str, str]: ... def getprotobyname(protocolname: str, /) -> int: ... def getservbyname(servicename: str, protocolname: str = ..., /) -> int: ... def getservbyport(port: int, protocolname: str = ..., /) -> str: ... @@ -790,6 +851,11 @@ if sys.platform != "win32": def if_nameindex() -> list[tuple[int, str]]: ... def if_nametoindex(oname: str, /) -> int: ... -def if_indextoname(index: int, /) -> str: ... -CAPI: object +if sys.version_info >= (3, 14): + def if_indextoname(if_index: int, /) -> str: ... + +else: + def if_indextoname(index: int, /) -> str: ... + +CAPI: CapsuleType diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_sqlite3.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_sqlite3.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_sqlite3.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_sqlite3.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ssl.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_ssl.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_ssl.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_ssl.pyi index 3e88874143df0..7ab880e4def74 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_ssl.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_ssl.pyi @@ -12,7 +12,7 @@ from ssl import ( SSLWantWriteError as SSLWantWriteError, SSLZeroReturnError as SSLZeroReturnError, ) -from typing import Any, Literal, TypedDict, final, overload +from typing import Any, ClassVar, Literal, TypedDict, final, overload from typing_extensions import NotRequired, Self, TypeAlias _PasswordType: TypeAlias = Callable[[], str | bytes | bytearray] | str | bytes | bytearray @@ -105,7 +105,7 @@ class _SSLContext: if sys.version_info >= (3, 13): def set_psk_client_callback(self, callback: Callable[[str | None], tuple[str | None, bytes]] | None) -> None: ... def set_psk_server_callback( - self, callback: Callable[[str | None], tuple[str | None, bytes]] | None, identity_hint: str | None = None + self, callback: Callable[[str | None], bytes] | None, identity_hint: str | None = None ) -> None: ... @final @@ -119,6 +119,7 @@ class MemoryBIO: @final class SSLSession: + __hash__: ClassVar[None] # type: ignore[assignment] @property def has_ticket(self) -> bool: ... @property @@ -239,9 +240,7 @@ OP_SINGLE_ECDH_USE: int OP_NO_COMPRESSION: int OP_ENABLE_MIDDLEBOX_COMPAT: int OP_NO_RENEGOTIATION: int -if sys.version_info >= (3, 11): - OP_IGNORE_UNEXPECTED_EOF: int -elif sys.version_info >= (3, 8) and sys.platform == "linux": +if sys.version_info >= (3, 11) or sys.platform == "linux": OP_IGNORE_UNEXPECTED_EOF: int if sys.version_info >= (3, 12): OP_LEGACY_SERVER_CONNECT: int @@ -284,6 +283,8 @@ HAS_TLSv1: bool HAS_TLSv1_1: bool HAS_TLSv1_2: bool HAS_TLSv1_3: bool +if sys.version_info >= (3, 14): + HAS_PHA: bool # version info OPENSSL_VERSION_NUMBER: int diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_stat.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_stat.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_stat.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_stat.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_struct.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_struct.pyi new file mode 100644 index 0000000000000..662170e869f31 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_struct.pyi @@ -0,0 +1,22 @@ +from _typeshed import ReadableBuffer, WriteableBuffer +from collections.abc import Iterator +from typing import Any + +def pack(fmt: str | bytes, /, *v: Any) -> bytes: ... +def pack_into(fmt: str | bytes, buffer: WriteableBuffer, offset: int, /, *v: Any) -> None: ... +def unpack(format: str | bytes, buffer: ReadableBuffer, /) -> tuple[Any, ...]: ... +def unpack_from(format: str | bytes, /, buffer: ReadableBuffer, offset: int = 0) -> tuple[Any, ...]: ... +def iter_unpack(format: str | bytes, buffer: ReadableBuffer, /) -> Iterator[tuple[Any, ...]]: ... +def calcsize(format: str | bytes, /) -> int: ... + +class Struct: + @property + def format(self) -> str: ... + @property + def size(self) -> int: ... + def __init__(self, format: str | bytes) -> None: ... + def pack(self, *v: Any) -> bytes: ... + def pack_into(self, buffer: WriteableBuffer, offset: int, *v: Any) -> None: ... + def unpack(self, buffer: ReadableBuffer, /) -> tuple[Any, ...]: ... + def unpack_from(self, buffer: ReadableBuffer, offset: int = 0) -> tuple[Any, ...]: ... + def iter_unpack(self, buffer: ReadableBuffer, /) -> Iterator[tuple[Any, ...]]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_thread.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_thread.pyi new file mode 100644 index 0000000000000..378ac24237572 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_thread.pyi @@ -0,0 +1,111 @@ +import signal +import sys +from _typeshed import structseq +from collections.abc import Callable +from threading import Thread +from types import TracebackType +from typing import Any, Final, NoReturn, final, overload +from typing_extensions import TypeVarTuple, Unpack + +_Ts = TypeVarTuple("_Ts") + +error = RuntimeError + +def _count() -> int: ... +@final +class RLock: + def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release(self) -> None: ... + __enter__ = acquire + def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... + +if sys.version_info >= (3, 13): + @final + class _ThreadHandle: + ident: int + + def join(self, timeout: float | None = None, /) -> None: ... + def is_done(self) -> bool: ... + def _set_done(self) -> None: ... + + def start_joinable_thread( + function: Callable[[], object], handle: _ThreadHandle | None = None, daemon: bool = True + ) -> _ThreadHandle: ... + @final + class lock: + def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release(self) -> None: ... + def locked(self) -> bool: ... + def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release_lock(self) -> None: ... + def locked_lock(self) -> bool: ... + def __enter__(self) -> bool: ... + def __exit__( + self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + + LockType = lock +else: + @final + class LockType: + def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release(self) -> None: ... + def locked(self) -> bool: ... + def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release_lock(self) -> None: ... + def locked_lock(self) -> bool: ... + def __enter__(self) -> bool: ... + def __exit__( + self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + +@overload +def start_new_thread(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ... +@overload +def start_new_thread(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ... + +# Obsolete synonym for start_new_thread() +@overload +def start_new(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ... +@overload +def start_new(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ... + +if sys.version_info >= (3, 10): + def interrupt_main(signum: signal.Signals = ..., /) -> None: ... + +else: + def interrupt_main() -> None: ... + +def exit() -> NoReturn: ... +def exit_thread() -> NoReturn: ... # Obsolete synonym for exit() +def allocate_lock() -> LockType: ... +def allocate() -> LockType: ... # Obsolete synonym for allocate_lock() +def get_ident() -> int: ... +def stack_size(size: int = 0, /) -> int: ... + +TIMEOUT_MAX: float + +def get_native_id() -> int: ... # only available on some platforms +@final +class _ExceptHookArgs(structseq[Any], tuple[type[BaseException], BaseException | None, TracebackType | None, Thread | None]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("exc_type", "exc_value", "exc_traceback", "thread") + + @property + def exc_type(self) -> type[BaseException]: ... + @property + def exc_value(self) -> BaseException | None: ... + @property + def exc_traceback(self) -> TracebackType | None: ... + @property + def thread(self) -> Thread | None: ... + +_excepthook: Callable[[_ExceptHookArgs], Any] + +if sys.version_info >= (3, 12): + def daemon_threads_allowed() -> bool: ... + +class _local: + def __getattribute__(self, name: str, /) -> Any: ... + def __setattr__(self, name: str, value: Any, /) -> None: ... + def __delattr__(self, name: str, /) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_threading_local.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_threading_local.pyi new file mode 100644 index 0000000000000..07a825f0d8168 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_threading_local.pyi @@ -0,0 +1,22 @@ +from threading import RLock +from typing import Any +from typing_extensions import Self, TypeAlias +from weakref import ReferenceType + +__all__ = ["local"] +_LocalDict: TypeAlias = dict[Any, Any] + +class _localimpl: + key: str + dicts: dict[int, tuple[ReferenceType[Any], _LocalDict]] + # Keep localargs in sync with the *args, **kwargs annotation on local.__new__ + localargs: tuple[list[Any], dict[str, Any]] + locallock: RLock + def get_dict(self) -> _LocalDict: ... + def create_dict(self) -> _LocalDict: ... + +class local: + def __new__(cls, /, *args: Any, **kw: Any) -> Self: ... + def __getattribute__(self, name: str) -> Any: ... + def __setattr__(self, name: str, value: Any) -> None: ... + def __delattr__(self, name: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_tkinter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_tkinter.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_tkinter.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_tkinter.pyi index 63b1e7ca7cb46..4206a2114f954 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_tkinter.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_tkinter.pyi @@ -113,16 +113,31 @@ TK_VERSION: Final[str] class TkttType: def deletetimerhandler(self): ... -def create( - screenName: str | None = None, - baseName: str = "", - className: str = "Tk", - interactive: bool = False, - wantobjects: bool = False, - wantTk: bool = True, - sync: bool = False, - use: str | None = None, - /, -): ... +if sys.version_info >= (3, 13): + def create( + screenName: str | None = None, + baseName: str = "", + className: str = "Tk", + interactive: bool = False, + wantobjects: int = 0, + wantTk: bool = True, + sync: bool = False, + use: str | None = None, + /, + ): ... + +else: + def create( + screenName: str | None = None, + baseName: str = "", + className: str = "Tk", + interactive: bool = False, + wantobjects: bool = False, + wantTk: bool = True, + sync: bool = False, + use: str | None = None, + /, + ): ... + def getbusywaitinterval(): ... def setbusywaitinterval(new_val, /): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi similarity index 85% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi index b1aeb710233e1..e9720f46692ce 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_tracemalloc.pyi @@ -1,4 +1,3 @@ -import sys from collections.abc import Sequence from tracemalloc import _FrameTuple, _TraceTuple @@ -9,9 +8,6 @@ def get_traceback_limit() -> int: ... def get_traced_memory() -> tuple[int, int]: ... def get_tracemalloc_memory() -> int: ... def is_tracing() -> bool: ... - -if sys.version_info >= (3, 9): - def reset_peak() -> None: ... - +def reset_peak() -> None: ... def start(nframe: int = 1, /) -> None: ... def stop() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/README.md b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/README.md similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/README.md rename to crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/README.md diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi new file mode 100644 index 0000000000000..c37d55a7d9ec3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi @@ -0,0 +1,380 @@ +# Utility types for typeshed +# +# See the README.md file in this directory for more information. + +import sys +from collections.abc import Awaitable, Callable, Iterable, Sequence, Set as AbstractSet, Sized +from dataclasses import Field +from os import PathLike +from types import FrameType, TracebackType +from typing import ( + Any, + AnyStr, + ClassVar, + Final, + Generic, + Literal, + Protocol, + SupportsFloat, + SupportsIndex, + SupportsInt, + TypeVar, + final, + overload, +) +from typing_extensions import Buffer, LiteralString, Self as _Self, TypeAlias + +_KT = TypeVar("_KT") +_KT_co = TypeVar("_KT_co", covariant=True) +_KT_contra = TypeVar("_KT_contra", contravariant=True) +_VT = TypeVar("_VT") +_VT_co = TypeVar("_VT_co", covariant=True) +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) +_T_contra = TypeVar("_T_contra", contravariant=True) + +# Alternative to `typing_extensions.Self`, exclusively for use with `__new__` +# in metaclasses: +# def __new__(cls: type[Self], ...) -> Self: ... +# In other cases, use `typing_extensions.Self`. +Self = TypeVar("Self") # noqa: Y001 + +# covariant version of typing.AnyStr, useful for protocols +AnyStr_co = TypeVar("AnyStr_co", str, bytes, covariant=True) # noqa: Y001 + +# For partially known annotations. Usually, fields where type annotations +# haven't been added are left unannotated, but in some situations this +# isn't possible or a type is already partially known. In cases like these, +# use Incomplete instead of Any as a marker. For example, use +# "Incomplete | None" instead of "Any | None". +Incomplete: TypeAlias = Any # stable + +# To describe a function parameter that is unused and will work with anything. +Unused: TypeAlias = object # stable + +# Marker for return types that include None, but where forcing the user to +# check for None can be detrimental. Sometimes called "the Any trick". See +# CONTRIBUTING.md for more information. +MaybeNone: TypeAlias = Any # stable + +# Used to mark arguments that default to a sentinel value. This prevents +# stubtest from complaining about the default value not matching. +# +# def foo(x: int | None = sentinel) -> None: ... +# +# In cases where the sentinel object is exported and can be used by user code, +# a construct like this is better: +# +# _SentinelType = NewType("_SentinelType", object) +# sentinel: _SentinelType +# def foo(x: int | None | _SentinelType = ...) -> None: ... +sentinel: Any + +# stable +class IdentityFunction(Protocol): + def __call__(self, x: _T, /) -> _T: ... + +# stable +class SupportsNext(Protocol[_T_co]): + def __next__(self) -> _T_co: ... + +# stable +class SupportsAnext(Protocol[_T_co]): + def __anext__(self) -> Awaitable[_T_co]: ... + +# Comparison protocols + +class SupportsDunderLT(Protocol[_T_contra]): + def __lt__(self, other: _T_contra, /) -> bool: ... + +class SupportsDunderGT(Protocol[_T_contra]): + def __gt__(self, other: _T_contra, /) -> bool: ... + +class SupportsDunderLE(Protocol[_T_contra]): + def __le__(self, other: _T_contra, /) -> bool: ... + +class SupportsDunderGE(Protocol[_T_contra]): + def __ge__(self, other: _T_contra, /) -> bool: ... + +class SupportsAllComparisons( + SupportsDunderLT[Any], SupportsDunderGT[Any], SupportsDunderLE[Any], SupportsDunderGE[Any], Protocol +): ... + +SupportsRichComparison: TypeAlias = SupportsDunderLT[Any] | SupportsDunderGT[Any] +SupportsRichComparisonT = TypeVar("SupportsRichComparisonT", bound=SupportsRichComparison) # noqa: Y001 + +# Dunder protocols + +class SupportsAdd(Protocol[_T_contra, _T_co]): + def __add__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsRAdd(Protocol[_T_contra, _T_co]): + def __radd__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsSub(Protocol[_T_contra, _T_co]): + def __sub__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsRSub(Protocol[_T_contra, _T_co]): + def __rsub__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsMul(Protocol[_T_contra, _T_co]): + def __mul__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsRMul(Protocol[_T_contra, _T_co]): + def __rmul__(self, x: _T_contra, /) -> _T_co: ... + +class SupportsDivMod(Protocol[_T_contra, _T_co]): + def __divmod__(self, other: _T_contra, /) -> _T_co: ... + +class SupportsRDivMod(Protocol[_T_contra, _T_co]): + def __rdivmod__(self, other: _T_contra, /) -> _T_co: ... + +# This protocol is generic over the iterator type, while Iterable is +# generic over the type that is iterated over. +class SupportsIter(Protocol[_T_co]): + def __iter__(self) -> _T_co: ... + +# This protocol is generic over the iterator type, while AsyncIterable is +# generic over the type that is iterated over. +class SupportsAiter(Protocol[_T_co]): + def __aiter__(self) -> _T_co: ... + +class SupportsLenAndGetItem(Protocol[_T_co]): + def __len__(self) -> int: ... + def __getitem__(self, k: int, /) -> _T_co: ... + +class SupportsTrunc(Protocol): + def __trunc__(self) -> int: ... + +# Mapping-like protocols + +# stable +class SupportsItems(Protocol[_KT_co, _VT_co]): + def items(self) -> AbstractSet[tuple[_KT_co, _VT_co]]: ... + +# stable +class SupportsKeysAndGetItem(Protocol[_KT, _VT_co]): + def keys(self) -> Iterable[_KT]: ... + def __getitem__(self, key: _KT, /) -> _VT_co: ... + +# stable +class SupportsGetItem(Protocol[_KT_contra, _VT_co]): + def __getitem__(self, key: _KT_contra, /) -> _VT_co: ... + +# stable +class SupportsContainsAndGetItem(Protocol[_KT_contra, _VT_co]): + def __contains__(self, x: Any, /) -> bool: ... + def __getitem__(self, key: _KT_contra, /) -> _VT_co: ... + +# stable +class SupportsItemAccess(Protocol[_KT_contra, _VT]): + def __contains__(self, x: Any, /) -> bool: ... + def __getitem__(self, key: _KT_contra, /) -> _VT: ... + def __setitem__(self, key: _KT_contra, value: _VT, /) -> None: ... + def __delitem__(self, key: _KT_contra, /) -> None: ... + +StrPath: TypeAlias = str | PathLike[str] # stable +BytesPath: TypeAlias = bytes | PathLike[bytes] # stable +GenericPath: TypeAlias = AnyStr | PathLike[AnyStr] +StrOrBytesPath: TypeAlias = str | bytes | PathLike[str] | PathLike[bytes] # stable + +OpenTextModeUpdating: TypeAlias = Literal[ + "r+", + "+r", + "rt+", + "r+t", + "+rt", + "tr+", + "t+r", + "+tr", + "w+", + "+w", + "wt+", + "w+t", + "+wt", + "tw+", + "t+w", + "+tw", + "a+", + "+a", + "at+", + "a+t", + "+at", + "ta+", + "t+a", + "+ta", + "x+", + "+x", + "xt+", + "x+t", + "+xt", + "tx+", + "t+x", + "+tx", +] +OpenTextModeWriting: TypeAlias = Literal["w", "wt", "tw", "a", "at", "ta", "x", "xt", "tx"] +OpenTextModeReading: TypeAlias = Literal["r", "rt", "tr", "U", "rU", "Ur", "rtU", "rUt", "Urt", "trU", "tUr", "Utr"] +OpenTextMode: TypeAlias = OpenTextModeUpdating | OpenTextModeWriting | OpenTextModeReading +OpenBinaryModeUpdating: TypeAlias = Literal[ + "rb+", + "r+b", + "+rb", + "br+", + "b+r", + "+br", + "wb+", + "w+b", + "+wb", + "bw+", + "b+w", + "+bw", + "ab+", + "a+b", + "+ab", + "ba+", + "b+a", + "+ba", + "xb+", + "x+b", + "+xb", + "bx+", + "b+x", + "+bx", +] +OpenBinaryModeWriting: TypeAlias = Literal["wb", "bw", "ab", "ba", "xb", "bx"] +OpenBinaryModeReading: TypeAlias = Literal["rb", "br", "rbU", "rUb", "Urb", "brU", "bUr", "Ubr"] +OpenBinaryMode: TypeAlias = OpenBinaryModeUpdating | OpenBinaryModeReading | OpenBinaryModeWriting + +# stable +class HasFileno(Protocol): + def fileno(self) -> int: ... + +FileDescriptor: TypeAlias = int # stable +FileDescriptorLike: TypeAlias = int | HasFileno # stable +FileDescriptorOrPath: TypeAlias = int | StrOrBytesPath + +# stable +class SupportsRead(Protocol[_T_co]): + def read(self, length: int = ..., /) -> _T_co: ... + +# stable +class SupportsReadline(Protocol[_T_co]): + def readline(self, length: int = ..., /) -> _T_co: ... + +# stable +class SupportsNoArgReadline(Protocol[_T_co]): + def readline(self) -> _T_co: ... + +# stable +class SupportsWrite(Protocol[_T_contra]): + def write(self, s: _T_contra, /) -> object: ... + +# stable +class SupportsFlush(Protocol): + def flush(self) -> object: ... + +# Unfortunately PEP 688 does not allow us to distinguish read-only +# from writable buffers. We use these aliases for readability for now. +# Perhaps a future extension of the buffer protocol will allow us to +# distinguish these cases in the type system. +ReadOnlyBuffer: TypeAlias = Buffer # stable +# Anything that implements the read-write buffer interface. +WriteableBuffer: TypeAlias = Buffer +# Same as WriteableBuffer, but also includes read-only buffer types (like bytes). +ReadableBuffer: TypeAlias = Buffer # stable + +class SliceableBuffer(Buffer, Protocol): + def __getitem__(self, slice: slice, /) -> Sequence[int]: ... + +class IndexableBuffer(Buffer, Protocol): + def __getitem__(self, i: int, /) -> int: ... + +class SupportsGetItemBuffer(SliceableBuffer, IndexableBuffer, Protocol): + def __contains__(self, x: Any, /) -> bool: ... + @overload + def __getitem__(self, slice: slice, /) -> Sequence[int]: ... + @overload + def __getitem__(self, i: int, /) -> int: ... + +class SizedBuffer(Sized, Buffer, Protocol): ... + +# for compatibility with third-party stubs that may use this +_BufferWithLen: TypeAlias = SizedBuffer # not stable # noqa: Y047 + +ExcInfo: TypeAlias = tuple[type[BaseException], BaseException, TracebackType] +OptExcInfo: TypeAlias = ExcInfo | tuple[None, None, None] + +# stable +if sys.version_info >= (3, 10): + from types import NoneType as NoneType +else: + # Used by type checkers for checks involving None (does not exist at runtime) + @final + class NoneType: + def __bool__(self) -> Literal[False]: ... + +# This is an internal CPython type that is like, but subtly different from, a NamedTuple +# Subclasses of this type are found in multiple modules. +# In typeshed, `structseq` is only ever used as a mixin in combination with a fixed-length `Tuple` +# See discussion at #6546 & #6560 +# `structseq` classes are unsubclassable, so are all decorated with `@final`. +class structseq(Generic[_T_co]): + n_fields: Final[int] + n_unnamed_fields: Final[int] + n_sequence_fields: Final[int] + # The first parameter will generally only take an iterable of a specific length. + # E.g. `os.uname_result` takes any iterable of length exactly 5. + # + # The second parameter will accept a dict of any kind without raising an exception, + # but only has any meaning if you supply it a dict where the keys are strings. + # https://github.com/python/typeshed/pull/6560#discussion_r767149830 + def __new__(cls, sequence: Iterable[_T_co], dict: dict[str, Any] = ...) -> _Self: ... + if sys.version_info >= (3, 13): + def __replace__(self, **kwargs: Any) -> _Self: ... + +# Superset of typing.AnyStr that also includes LiteralString +AnyOrLiteralStr = TypeVar("AnyOrLiteralStr", str, bytes, LiteralString) # noqa: Y001 + +# Represents when str or LiteralStr is acceptable. Useful for string processing +# APIs where literalness of return value depends on literalness of inputs +StrOrLiteralStr = TypeVar("StrOrLiteralStr", LiteralString, str) # noqa: Y001 + +# Objects suitable to be passed to sys.setprofile, threading.setprofile, and similar +ProfileFunction: TypeAlias = Callable[[FrameType, str, Any], object] + +# Objects suitable to be passed to sys.settrace, threading.settrace, and similar +TraceFunction: TypeAlias = Callable[[FrameType, str, Any], TraceFunction | None] + +# experimental +# Might not work as expected for pyright, see +# https://github.com/python/typeshed/pull/9362 +# https://github.com/microsoft/pyright/issues/4339 +class DataclassInstance(Protocol): + __dataclass_fields__: ClassVar[dict[str, Field[Any]]] + +# Anything that can be passed to the int/float constructors +if sys.version_info >= (3, 14): + ConvertibleToInt: TypeAlias = str | ReadableBuffer | SupportsInt | SupportsIndex +else: + ConvertibleToInt: TypeAlias = str | ReadableBuffer | SupportsInt | SupportsIndex | SupportsTrunc +ConvertibleToFloat: TypeAlias = str | ReadableBuffer | SupportsFloat | SupportsIndex + +# A few classes updated from Foo(str, Enum) to Foo(StrEnum). This is a convenience so these +# can be accurate on all python versions without getting too wordy +if sys.version_info >= (3, 11): + from enum import StrEnum as StrEnum +else: + from enum import Enum + + class StrEnum(str, Enum): ... + +# Objects that appear in annotations or in type expressions. +# Similar to PEP 747's TypeForm but a little broader. +AnnotationForm: TypeAlias = Any + +if sys.version_info >= (3, 14): + from annotationlib import Format + + # These return annotations, which can be arbitrary objects + AnnotateFunc: TypeAlias = Callable[[Format], dict[str, AnnotationForm]] + EvaluateFunc: TypeAlias = Callable[[Format], AnnotationForm] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/_type_checker_internals.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/_type_checker_internals.pyi new file mode 100644 index 0000000000000..feb22aae00732 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/_type_checker_internals.pyi @@ -0,0 +1,89 @@ +# Internals used by some type checkers. +# +# Don't use this module directly. It is only for type checkers to use. + +import sys +import typing_extensions +from _collections_abc import dict_items, dict_keys, dict_values +from abc import ABCMeta +from collections.abc import Awaitable, Generator, Iterable, Mapping +from typing import Any, ClassVar, Generic, TypeVar, overload +from typing_extensions import Never + +_T = TypeVar("_T") + +# Used for an undocumented mypy feature. Does not exist at runtime. +promote = object() + +# Fallback type providing methods and attributes that appear on all `TypedDict` types. +# N.B. Keep this mostly in sync with typing_extensions._TypedDict/mypy_extensions._TypedDict +class TypedDictFallback(Mapping[str, object], metaclass=ABCMeta): + __total__: ClassVar[bool] + __required_keys__: ClassVar[frozenset[str]] + __optional_keys__: ClassVar[frozenset[str]] + # __orig_bases__ sometimes exists on <3.12, but not consistently, + # so we only add it to the stub on 3.12+ + if sys.version_info >= (3, 12): + __orig_bases__: ClassVar[tuple[Any, ...]] + if sys.version_info >= (3, 13): + __readonly_keys__: ClassVar[frozenset[str]] + __mutable_keys__: ClassVar[frozenset[str]] + + def copy(self) -> typing_extensions.Self: ... + # Using Never so that only calls using mypy plugin hook that specialize the signature + # can go through. + def setdefault(self, k: Never, default: object) -> object: ... + # Mypy plugin hook for 'pop' expects that 'default' has a type variable type. + def pop(self, k: Never, default: _T = ...) -> object: ... # pyright: ignore[reportInvalidTypeVarUse] + def update(self, m: typing_extensions.Self, /) -> None: ... + def __delitem__(self, k: Never) -> None: ... + def items(self) -> dict_items[str, object]: ... + def keys(self) -> dict_keys[str, object]: ... + def values(self) -> dict_values[str, object]: ... + @overload + def __or__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... + @overload + def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... + @overload + def __ror__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... + @overload + def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... + # supposedly incompatible definitions of __or__ and __ior__ + def __ior__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... # type: ignore[misc] + +# Fallback type providing methods and attributes that appear on all `NamedTuple` types. +class NamedTupleFallback(tuple[Any, ...]): + _field_defaults: ClassVar[dict[str, Any]] + _fields: ClassVar[tuple[str, ...]] + # __orig_bases__ sometimes exists on <3.12, but not consistently + # So we only add it to the stub on 3.12+. + if sys.version_info >= (3, 12): + __orig_bases__: ClassVar[tuple[Any, ...]] + + @overload + def __init__(self, typename: str, fields: Iterable[tuple[str, Any]], /) -> None: ... + @overload + @typing_extensions.deprecated( + "Creating a typing.NamedTuple using keyword arguments is deprecated and support will be removed in Python 3.15" + ) + def __init__(self, typename: str, fields: None = None, /, **kwargs: Any) -> None: ... + @classmethod + def _make(cls, iterable: Iterable[Any]) -> typing_extensions.Self: ... + def _asdict(self) -> dict[str, Any]: ... + def _replace(self, **kwargs: Any) -> typing_extensions.Self: ... + if sys.version_info >= (3, 13): + def __replace__(self, **kwargs: Any) -> typing_extensions.Self: ... + +# Non-default variations to accommodate couroutines, and `AwaitableGenerator` having a 4th type parameter. +_S = TypeVar("_S") +_YieldT_co = TypeVar("_YieldT_co", covariant=True) +_SendT_nd_contra = TypeVar("_SendT_nd_contra", contravariant=True) +_ReturnT_nd_co = TypeVar("_ReturnT_nd_co", covariant=True) + +# The parameters correspond to Generator, but the 4th is the original type. +class AwaitableGenerator( + Awaitable[_ReturnT_nd_co], + Generator[_YieldT_co, _SendT_nd_contra, _ReturnT_nd_co], + Generic[_YieldT_co, _SendT_nd_contra, _ReturnT_nd_co, _S], + metaclass=ABCMeta, +): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/dbapi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/dbapi.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/dbapi.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/dbapi.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/importlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/importlib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/importlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/importlib.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/wsgi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/wsgi.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/wsgi.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/wsgi.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/xml.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/xml.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_typeshed/xml.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/xml.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_warnings.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_warnings.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_warnings.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_warnings.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_weakref.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_weakref.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_weakref.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_weakref.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_weakrefset.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_weakrefset.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_weakrefset.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_weakrefset.pyi index 2a4e682f64ed7..dad1ed7a4fb5c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/_weakrefset.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/_weakrefset.pyi @@ -1,11 +1,8 @@ -import sys from collections.abc import Iterable, Iterator, MutableSet -from typing import Any, TypeVar, overload +from types import GenericAlias +from typing import Any, ClassVar, TypeVar, overload from typing_extensions import Self -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = ["WeakSet"] _S = TypeVar("_S") @@ -21,6 +18,7 @@ class WeakSet(MutableSet[_T]): def copy(self) -> Self: ... def remove(self, item: _T) -> None: ... def update(self, other: Iterable[_T]) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __contains__(self, item: object) -> bool: ... def __len__(self) -> int: ... def __iter__(self) -> Iterator[_T]: ... @@ -47,5 +45,4 @@ class WeakSet(MutableSet[_T]): def union(self, other: Iterable[_S]) -> WeakSet[_S | _T]: ... def __or__(self, other: Iterable[_S]) -> WeakSet[_S | _T]: ... def isdisjoint(self, other: Iterable[_T]) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/_winapi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/_winapi.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/_winapi.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/_winapi.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/abc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/abc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/abc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/aifc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/aifc.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/aifc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/aifc.pyi index 05bf53986b290..bfe12c6af2b0b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/aifc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/aifc.pyi @@ -1,12 +1,8 @@ -import sys from types import TracebackType from typing import IO, Any, Literal, NamedTuple, overload from typing_extensions import Self, TypeAlias -if sys.version_info >= (3, 9): - __all__ = ["Error", "open"] -else: - __all__ = ["Error", "open", "openfp"] +__all__ = ["Error", "open"] class Error(Exception): ... @@ -81,11 +77,3 @@ def open(f: _File, mode: Literal["r", "rb"]) -> Aifc_read: ... def open(f: _File, mode: Literal["w", "wb"]) -> Aifc_write: ... @overload def open(f: _File, mode: str | None = None) -> Any: ... - -if sys.version_info < (3, 9): - @overload - def openfp(f: _File, mode: Literal["r", "rb"]) -> Aifc_read: ... - @overload - def openfp(f: _File, mode: Literal["w", "wb"]) -> Aifc_write: ... - @overload - def openfp(f: _File, mode: str | None = None) -> Any: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/annotationlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/annotationlib.pyi new file mode 100644 index 0000000000000..7590c632d7856 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/annotationlib.pyi @@ -0,0 +1,132 @@ +import sys +from typing import Literal + +if sys.version_info >= (3, 14): + import enum + import types + from _typeshed import AnnotateFunc, AnnotationForm, EvaluateFunc, SupportsItems + from collections.abc import Mapping + from typing import Any, ParamSpec, TypeVar, TypeVarTuple, final, overload + from warnings import deprecated + + __all__ = [ + "Format", + "ForwardRef", + "call_annotate_function", + "call_evaluate_function", + "get_annotate_from_class_namespace", + "get_annotations", + "annotations_to_string", + "type_repr", + ] + + class Format(enum.IntEnum): + VALUE = 1 + VALUE_WITH_FAKE_GLOBALS = 2 + FORWARDREF = 3 + STRING = 4 + + @final + class ForwardRef: + __forward_is_argument__: bool + __forward_is_class__: bool + __forward_module__: str | None + def __init__( + self, arg: str, *, module: str | None = None, owner: object = None, is_argument: bool = True, is_class: bool = False + ) -> None: ... + @overload + def evaluate( + self, + *, + globals: dict[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] | None = None, + owner: object = None, + format: Literal[Format.STRING], + ) -> str: ... + @overload + def evaluate( + self, + *, + globals: dict[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] | None = None, + owner: object = None, + format: Literal[Format.FORWARDREF], + ) -> AnnotationForm | ForwardRef: ... + @overload + def evaluate( + self, + *, + globals: dict[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] | None = None, + owner: object = None, + format: Format = Format.VALUE, # noqa: Y011 + ) -> AnnotationForm: ... + @deprecated("Use ForwardRef.evaluate() or typing.evaluate_forward_ref() instead.") + def _evaluate( + self, + globalns: dict[str, Any] | None, + localns: Mapping[str, Any] | None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = ..., + *, + recursive_guard: frozenset[str], + ) -> AnnotationForm: ... + @property + def __forward_arg__(self) -> str: ... + @property + def __forward_code__(self) -> types.CodeType: ... + def __eq__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + def __or__(self, other: Any) -> types.UnionType: ... + def __ror__(self, other: Any) -> types.UnionType: ... + + @overload + def call_evaluate_function(evaluate: EvaluateFunc, format: Literal[Format.STRING], *, owner: object = None) -> str: ... + @overload + def call_evaluate_function( + evaluate: EvaluateFunc, format: Literal[Format.FORWARDREF], *, owner: object = None + ) -> AnnotationForm | ForwardRef: ... + @overload + def call_evaluate_function(evaluate: EvaluateFunc, format: Format, *, owner: object = None) -> AnnotationForm: ... + @overload + def call_annotate_function( + annotate: AnnotateFunc, format: Literal[Format.STRING], *, owner: object = None + ) -> dict[str, str]: ... + @overload + def call_annotate_function( + annotate: AnnotateFunc, format: Literal[Format.FORWARDREF], *, owner: object = None + ) -> dict[str, AnnotationForm | ForwardRef]: ... + @overload + def call_annotate_function(annotate: AnnotateFunc, format: Format, *, owner: object = None) -> dict[str, AnnotationForm]: ... + def get_annotate_from_class_namespace(obj: Mapping[str, object]) -> AnnotateFunc | None: ... + @overload + def get_annotations( + obj: Any, # any object with __annotations__ or __annotate__ + *, + globals: dict[str, object] | None = None, + locals: Mapping[str, object] | None = None, + eval_str: bool = False, + format: Literal[Format.STRING], + ) -> dict[str, str]: ... + @overload + def get_annotations( + obj: Any, + *, + globals: dict[str, object] | None = None, + locals: Mapping[str, object] | None = None, + eval_str: bool = False, + format: Literal[Format.FORWARDREF], + ) -> dict[str, AnnotationForm | ForwardRef]: ... + @overload + def get_annotations( + obj: Any, + *, + globals: dict[str, object] | None = None, + locals: Mapping[str, object] | None = None, + eval_str: bool = False, + format: Format = Format.VALUE, # noqa: Y011 + ) -> dict[str, AnnotationForm]: ... + def type_repr(value: object) -> str: ... + def annotations_to_string(annotations: SupportsItems[str, object]) -> dict[str, str]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/antigravity.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/antigravity.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/antigravity.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/antigravity.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/argparse.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/argparse.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/argparse.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/argparse.pyi index 2526322ac8f6d..95ad6c7da8ebf 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/argparse.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/argparse.pyi @@ -1,8 +1,8 @@ import sys -from _typeshed import sentinel +from _typeshed import SupportsWrite, sentinel from collections.abc import Callable, Generator, Iterable, Sequence from re import Pattern -from typing import IO, Any, Final, Generic, NewType, NoReturn, Protocol, TypeVar, overload +from typing import IO, Any, ClassVar, Final, Generic, NoReturn, Protocol, TypeVar, overload from typing_extensions import Self, TypeAlias, deprecated __all__ = [ @@ -17,6 +17,7 @@ __all__ = [ "MetavarTypeHelpFormatter", "Namespace", "Action", + "BooleanOptionalAction", "ONE_OR_MORE", "OPTIONAL", "PARSER", @@ -25,33 +26,19 @@ __all__ = [ "ZERO_OR_MORE", ] -if sys.version_info >= (3, 9): - __all__ += ["BooleanOptionalAction"] - _T = TypeVar("_T") _ActionT = TypeVar("_ActionT", bound=Action) _ArgumentParserT = TypeVar("_ArgumentParserT", bound=ArgumentParser) _N = TypeVar("_N") _ActionType: TypeAlias = Callable[[str], Any] | FileType | str -# more precisely, Literal["store", "store_const", "store_true", -# "store_false", "append", "append_const", "count", "help", "version", -# "extend"], but using this would make it hard to annotate callers -# that don't use a literal argument -_ActionStr: TypeAlias = str -# more precisely, Literal["?", "*", "+", "...", "A...", -# "==SUPPRESS=="], but using this would make it hard to annotate -# callers that don't use a literal argument -_NArgsStr: TypeAlias = str ONE_OR_MORE: Final = "+" OPTIONAL: Final = "?" PARSER: Final = "A..." REMAINDER: Final = "..." -_SUPPRESS_T = NewType("_SUPPRESS_T", str) -SUPPRESS: _SUPPRESS_T | str # not using Literal because argparse sometimes compares SUPPRESS with is -# the | str is there so that foo = argparse.SUPPRESS; foo = "test" checks out in mypy +SUPPRESS: Final = "==SUPPRESS==" ZERO_OR_MORE: Final = "*" -_UNRECOGNIZED_ARGS_ATTR: Final[str] # undocumented +_UNRECOGNIZED_ARGS_ATTR: Final = "_unrecognized_args" # undocumented class ArgumentError(Exception): argument_name: str | None @@ -86,8 +73,13 @@ class _ActionsContainer: def add_argument( self, *name_or_flags: str, - action: _ActionStr | type[Action] = ..., - nargs: int | _NArgsStr | _SUPPRESS_T | None = None, + # str covers predefined actions ("store_true", "count", etc.) + # and user registered actions via the `register` method. + action: str | type[Action] = ..., + # more precisely, Literal["?", "*", "+", "...", "A...", "==SUPPRESS=="], + # but using this would make it hard to annotate callers that don't use a + # literal argument and for subclasses to override this method. + nargs: int | str | None = None, const: Any = ..., default: Any = ..., type: _ActionType = ..., @@ -131,6 +123,11 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): fromfile_prefix_chars: str | None add_help: bool allow_abbrev: bool + exit_on_error: bool + + if sys.version_info >= (3, 14): + suggest_on_error: bool + color: bool # undocumented _positionals: _ArgumentGroup @@ -138,7 +135,7 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): _subparsers: _ArgumentGroup | None # Note: the constructor arguments are also used in _SubParsersAction.add_parser. - if sys.version_info >= (3, 9): + if sys.version_info >= (3, 14): def __init__( self, prog: str | None = None, @@ -154,6 +151,9 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): add_help: bool = True, allow_abbrev: bool = True, exit_on_error: bool = True, + *, + suggest_on_error: bool = False, + color: bool = False, ) -> None: ... else: def __init__( @@ -170,6 +170,7 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): conflict_handler: str = "error", add_help: bool = True, allow_abbrev: bool = True, + exit_on_error: bool = True, ) -> None: ... @overload @@ -182,33 +183,33 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): def add_subparsers( self: _ArgumentParserT, *, - title: str = ..., - description: str | None = ..., - prog: str = ..., + title: str = "subcommands", + description: str | None = None, + prog: str | None = None, action: type[Action] = ..., option_string: str = ..., - dest: str | None = ..., - required: bool = ..., - help: str | None = ..., - metavar: str | None = ..., + dest: str | None = None, + required: bool = False, + help: str | None = None, + metavar: str | None = None, ) -> _SubParsersAction[_ArgumentParserT]: ... @overload def add_subparsers( self, *, - title: str = ..., - description: str | None = ..., - prog: str = ..., + title: str = "subcommands", + description: str | None = None, + prog: str | None = None, parser_class: type[_ArgumentParserT], action: type[Action] = ..., option_string: str = ..., - dest: str | None = ..., - required: bool = ..., - help: str | None = ..., - metavar: str | None = ..., + dest: str | None = None, + required: bool = False, + help: str | None = None, + metavar: str | None = None, ) -> _SubParsersAction[_ArgumentParserT]: ... - def print_usage(self, file: IO[str] | None = None) -> None: ... - def print_help(self, file: IO[str] | None = None) -> None: ... + def print_usage(self, file: SupportsWrite[str] | None = None) -> None: ... + def print_help(self, file: SupportsWrite[str] | None = None) -> None: ... def format_usage(self) -> str: ... def format_help(self) -> str: ... @overload @@ -237,7 +238,13 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): # undocumented def _get_optional_actions(self) -> list[Action]: ... def _get_positional_actions(self) -> list[Action]: ... - def _parse_known_args(self, arg_strings: list[str], namespace: Namespace) -> tuple[Namespace, list[str]]: ... + if sys.version_info >= (3, 12): + def _parse_known_args( + self, arg_strings: list[str], namespace: Namespace, intermixed: bool + ) -> tuple[Namespace, list[str]]: ... + else: + def _parse_known_args(self, arg_strings: list[str], namespace: Namespace) -> tuple[Namespace, list[str]]: ... + def _read_args_from_files(self, arg_strings: list[str]) -> list[str]: ... def _match_argument(self, action: Action, arg_strings_pattern: str) -> int: ... def _match_arguments_partial(self, actions: Sequence[Action], arg_strings_pattern: str) -> list[int]: ... @@ -248,7 +255,7 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): def _get_value(self, action: Action, arg_string: str) -> Any: ... def _check_value(self, action: Action, value: Any) -> None: ... def _get_formatter(self) -> HelpFormatter: ... - def _print_message(self, message: str, file: IO[str] | None = None) -> None: ... + def _print_message(self, message: str, file: SupportsWrite[str] | None = None) -> None: ... class HelpFormatter: # undocumented @@ -272,7 +279,21 @@ class HelpFormatter: def __init__(self, formatter: HelpFormatter, parent: Self | None, heading: str | None = None) -> None: ... def format_help(self) -> str: ... - def __init__(self, prog: str, indent_increment: int = 2, max_help_position: int = 24, width: int | None = None) -> None: ... + if sys.version_info >= (3, 14): + def __init__( + self, + prog: str, + indent_increment: int = 2, + max_help_position: int = 24, + width: int | None = None, + prefix_chars: str = "-", + color: bool = False, + ) -> None: ... + else: + def __init__( + self, prog: str, indent_increment: int = 2, max_help_position: int = 24, width: int | None = None + ) -> None: ... + def _indent(self) -> None: ... def _dedent(self) -> None: ... def _add_item(self, func: Callable[..., str], args: Iterable[Any]) -> None: ... @@ -352,8 +373,7 @@ class Action(_AttributeHolder): def __call__( self, parser: ArgumentParser, namespace: Namespace, values: str | Sequence[Any] | None, option_string: str | None = None ) -> None: ... - if sys.version_info >= (3, 9): - def format_usage(self) -> str: ... + def format_usage(self) -> str: ... if sys.version_info >= (3, 12): class BooleanOptionalAction(Action): @@ -418,7 +438,7 @@ if sys.version_info >= (3, 12): metavar: str | tuple[str, ...] | None = sentinel, ) -> None: ... -elif sys.version_info >= (3, 9): +else: class BooleanOptionalAction(Action): @overload def __init__( @@ -450,15 +470,32 @@ class Namespace(_AttributeHolder): def __setattr__(self, name: str, value: Any, /) -> None: ... def __contains__(self, key: str) -> bool: ... def __eq__(self, other: object) -> bool: ... - -class FileType: - # undocumented - _mode: str - _bufsize: int - _encoding: str | None - _errors: str | None - def __init__(self, mode: str = "r", bufsize: int = -1, encoding: str | None = None, errors: str | None = None) -> None: ... - def __call__(self, string: str) -> IO[Any]: ... + __hash__: ClassVar[None] # type: ignore[assignment] + +if sys.version_info >= (3, 14): + @deprecated("Deprecated in Python 3.14; Simply open files after parsing arguments") + class FileType: + # undocumented + _mode: str + _bufsize: int + _encoding: str | None + _errors: str | None + def __init__( + self, mode: str = "r", bufsize: int = -1, encoding: str | None = None, errors: str | None = None + ) -> None: ... + def __call__(self, string: str) -> IO[Any]: ... + +else: + class FileType: + # undocumented + _mode: str + _bufsize: int + _encoding: str | None + _errors: str | None + def __init__( + self, mode: str = "r", bufsize: int = -1, encoding: str | None = None, errors: str | None = None + ) -> None: ... + def __call__(self, string: str) -> IO[Any]: ... # undocumented class _ArgumentGroup(_ActionsContainer): @@ -688,7 +725,7 @@ class _SubParsersAction(Action, Generic[_ArgumentParserT]): # Note: `add_parser` accepts all kwargs of `ArgumentParser.__init__`. It also # accepts its own `help` and `aliases` kwargs. - if sys.version_info >= (3, 13): + if sys.version_info >= (3, 14): def add_parser( self, name: str, @@ -710,13 +747,16 @@ class _SubParsersAction(Action, Generic[_ArgumentParserT]): add_help: bool = ..., allow_abbrev: bool = ..., exit_on_error: bool = ..., + suggest_on_error: bool = False, + color: bool = False, **kwargs: Any, # Accepting any additional kwargs for custom parser classes ) -> _ArgumentParserT: ... - elif sys.version_info >= (3, 9): + elif sys.version_info >= (3, 13): def add_parser( self, name: str, *, + deprecated: bool = False, help: str | None = ..., aliases: Sequence[str] = ..., # Kwargs from ArgumentParser constructor @@ -755,6 +795,7 @@ class _SubParsersAction(Action, Generic[_ArgumentParserT]): conflict_handler: str = ..., add_help: bool = ..., allow_abbrev: bool = ..., + exit_on_error: bool = ..., **kwargs: Any, # Accepting any additional kwargs for custom parser classes ) -> _ArgumentParserT: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/array.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/array.pyi new file mode 100644 index 0000000000000..bd96c9bc2d317 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/array.pyi @@ -0,0 +1,88 @@ +import sys +from _typeshed import ReadableBuffer, SupportsRead, SupportsWrite +from collections.abc import Iterable, MutableSequence +from types import GenericAlias +from typing import Any, ClassVar, Literal, SupportsIndex, TypeVar, overload +from typing_extensions import Self, TypeAlias + +_IntTypeCode: TypeAlias = Literal["b", "B", "h", "H", "i", "I", "l", "L", "q", "Q"] +_FloatTypeCode: TypeAlias = Literal["f", "d"] +_UnicodeTypeCode: TypeAlias = Literal["u"] +_TypeCode: TypeAlias = _IntTypeCode | _FloatTypeCode | _UnicodeTypeCode + +_T = TypeVar("_T", int, float, str) + +typecodes: str + +class array(MutableSequence[_T]): + @property + def typecode(self) -> _TypeCode: ... + @property + def itemsize(self) -> int: ... + @overload + def __new__( + cls: type[array[int]], typecode: _IntTypeCode, initializer: bytes | bytearray | Iterable[int] = ..., / + ) -> array[int]: ... + @overload + def __new__( + cls: type[array[float]], typecode: _FloatTypeCode, initializer: bytes | bytearray | Iterable[float] = ..., / + ) -> array[float]: ... + @overload + def __new__( + cls: type[array[str]], typecode: _UnicodeTypeCode, initializer: bytes | bytearray | Iterable[str] = ..., / + ) -> array[str]: ... + @overload + def __new__(cls, typecode: str, initializer: Iterable[_T], /) -> Self: ... + @overload + def __new__(cls, typecode: str, initializer: bytes | bytearray = ..., /) -> Self: ... + def append(self, v: _T, /) -> None: ... + def buffer_info(self) -> tuple[int, int]: ... + def byteswap(self) -> None: ... + def count(self, v: _T, /) -> int: ... + def extend(self, bb: Iterable[_T], /) -> None: ... + def frombytes(self, buffer: ReadableBuffer, /) -> None: ... + def fromfile(self, f: SupportsRead[bytes], n: int, /) -> None: ... + def fromlist(self, list: list[_T], /) -> None: ... + def fromunicode(self, ustr: str, /) -> None: ... + if sys.version_info >= (3, 10): + def index(self, v: _T, start: int = 0, stop: int = sys.maxsize, /) -> int: ... + else: + def index(self, v: _T, /) -> int: ... # type: ignore[override] + + def insert(self, i: int, v: _T, /) -> None: ... + def pop(self, i: int = -1, /) -> _T: ... + def remove(self, v: _T, /) -> None: ... + def tobytes(self) -> bytes: ... + def tofile(self, f: SupportsWrite[bytes], /) -> None: ... + def tolist(self) -> list[_T]: ... + def tounicode(self) -> str: ... + + __hash__: ClassVar[None] # type: ignore[assignment] + def __len__(self) -> int: ... + @overload + def __getitem__(self, key: SupportsIndex, /) -> _T: ... + @overload + def __getitem__(self, key: slice, /) -> array[_T]: ... + @overload # type: ignore[override] + def __setitem__(self, key: SupportsIndex, value: _T, /) -> None: ... + @overload + def __setitem__(self, key: slice, value: array[_T], /) -> None: ... + def __delitem__(self, key: SupportsIndex | slice, /) -> None: ... + def __add__(self, value: array[_T], /) -> array[_T]: ... + def __eq__(self, value: object, /) -> bool: ... + def __ge__(self, value: array[_T], /) -> bool: ... + def __gt__(self, value: array[_T], /) -> bool: ... + def __iadd__(self, value: array[_T], /) -> Self: ... # type: ignore[override] + def __imul__(self, value: int, /) -> Self: ... + def __le__(self, value: array[_T], /) -> bool: ... + def __lt__(self, value: array[_T], /) -> bool: ... + def __mul__(self, value: int, /) -> array[_T]: ... + def __rmul__(self, value: int, /) -> array[_T]: ... + def __copy__(self) -> array[_T]: ... + def __deepcopy__(self, unused: Any, /) -> array[_T]: ... + def __buffer__(self, flags: int, /) -> memoryview: ... + def __release_buffer__(self, buffer: memoryview, /) -> None: ... + if sys.version_info >= (3, 12): + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +ArrayType = array diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ast.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ast.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ast.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ast.pyi index 3a43d62a3a607..f26ec4d1a08be 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ast.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ast.pyi @@ -1,3 +1,4 @@ +import builtins import os import sys import typing_extensions @@ -7,19 +8,13 @@ from _ast import ( PyCF_TYPE_COMMENTS as PyCF_TYPE_COMMENTS, ) from _typeshed import ReadableBuffer, Unused -from collections.abc import Iterator +from collections.abc import Iterable, Iterator, Sequence from typing import Any, ClassVar, Generic, Literal, TypedDict, TypeVar as _TypeVar, overload from typing_extensions import Self, Unpack, deprecated if sys.version_info >= (3, 13): from _ast import PyCF_OPTIMIZED_AST as PyCF_OPTIMIZED_AST -# Alias used for fields that must always be valid identifiers -# A string `x` counts as a valid identifier if both the following are True -# (1) `x.isidentifier()` evaluates to `True` -# (2) `keyword.iskeyword(x)` evaluates to `False` -_Identifier: typing_extensions.TypeAlias = str - # Used for node end positions in constructor keyword arguments _EndPositionT = typing_extensions.TypeVar("_EndPositionT", int, int | None, default=int | None) @@ -111,7 +106,7 @@ class FunctionDef(stmt): __match_args__ = ("name", "args", "body", "decorator_list", "returns", "type_comment", "type_params") elif sys.version_info >= (3, 10): __match_args__ = ("name", "args", "body", "decorator_list", "returns", "type_comment") - name: _Identifier + name: str args: arguments body: list[stmt] decorator_list: list[expr] @@ -122,7 +117,7 @@ class FunctionDef(stmt): if sys.version_info >= (3, 13): def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt] = ..., decorator_list: list[expr] = ..., @@ -135,7 +130,7 @@ class FunctionDef(stmt): @overload def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -147,7 +142,7 @@ class FunctionDef(stmt): @overload def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -160,7 +155,7 @@ class FunctionDef(stmt): else: def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -173,13 +168,14 @@ class FunctionDef(stmt): def __replace__( self, *, - name: _Identifier = ..., + name: str = ..., args: arguments = ..., body: list[stmt] = ..., decorator_list: list[expr] = ..., returns: expr | None = ..., type_comment: str | None = ..., type_params: list[type_param] = ..., + **kwargs: Unpack[_Attributes], ) -> Self: ... class AsyncFunctionDef(stmt): @@ -187,7 +183,7 @@ class AsyncFunctionDef(stmt): __match_args__ = ("name", "args", "body", "decorator_list", "returns", "type_comment", "type_params") elif sys.version_info >= (3, 10): __match_args__ = ("name", "args", "body", "decorator_list", "returns", "type_comment") - name: _Identifier + name: str args: arguments body: list[stmt] decorator_list: list[expr] @@ -198,7 +194,7 @@ class AsyncFunctionDef(stmt): if sys.version_info >= (3, 13): def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt] = ..., decorator_list: list[expr] = ..., @@ -211,7 +207,7 @@ class AsyncFunctionDef(stmt): @overload def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -223,7 +219,7 @@ class AsyncFunctionDef(stmt): @overload def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -236,7 +232,7 @@ class AsyncFunctionDef(stmt): else: def __init__( self, - name: _Identifier, + name: str, args: arguments, body: list[stmt], decorator_list: list[expr], @@ -249,13 +245,14 @@ class AsyncFunctionDef(stmt): def __replace__( self, *, - name: _Identifier = ..., + name: str = ..., args: arguments = ..., - body: list[stmt], - decorator_list: list[expr], - returns: expr | None, - type_comment: str | None, - type_params: list[type_param], + body: list[stmt] = ..., + decorator_list: list[expr] = ..., + returns: expr | None = ..., + type_comment: str | None = ..., + type_params: list[type_param] = ..., + **kwargs: Unpack[_Attributes], ) -> Self: ... class ClassDef(stmt): @@ -263,7 +260,7 @@ class ClassDef(stmt): __match_args__ = ("name", "bases", "keywords", "body", "decorator_list", "type_params") elif sys.version_info >= (3, 10): __match_args__ = ("name", "bases", "keywords", "body", "decorator_list") - name: _Identifier + name: str bases: list[expr] keywords: list[keyword] body: list[stmt] @@ -273,7 +270,7 @@ class ClassDef(stmt): if sys.version_info >= (3, 13): def __init__( self, - name: _Identifier, + name: str, bases: list[expr] = ..., keywords: list[keyword] = ..., body: list[stmt] = ..., @@ -284,7 +281,7 @@ class ClassDef(stmt): elif sys.version_info >= (3, 12): def __init__( self, - name: _Identifier, + name: str, bases: list[expr], keywords: list[keyword], body: list[stmt], @@ -295,7 +292,7 @@ class ClassDef(stmt): else: def __init__( self, - name: _Identifier, + name: str, bases: list[expr], keywords: list[keyword], body: list[stmt], @@ -307,12 +304,12 @@ class ClassDef(stmt): def __replace__( self, *, - name: _Identifier, - bases: list[expr], - keywords: list[keyword], - body: list[stmt], - decorator_list: list[expr], - type_params: list[type_param], + name: str = ..., + bases: list[expr] = ..., + keywords: list[keyword] = ..., + body: list[stmt] = ..., + decorator_list: list[expr] = ..., + type_params: list[type_param] = ..., **kwargs: Unpack[_Attributes], ) -> Self: ... @@ -383,7 +380,7 @@ if sys.version_info >= (3, 12): ) -> None: ... if sys.version_info >= (3, 14): - def __replace__( + def __replace__( # type: ignore[override] self, *, name: Name = ..., @@ -546,7 +543,9 @@ class While(stmt): def __init__(self, test: expr, body: list[stmt], orelse: list[stmt], **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, test: expr, body: list[stmt], orelse: list[stmt], **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__( + self, *, test: expr = ..., body: list[stmt] = ..., orelse: list[stmt] = ..., **kwargs: Unpack[_Attributes] + ) -> Self: ... class If(stmt): if sys.version_info >= (3, 10): @@ -731,7 +730,7 @@ class Assert(stmt): def __init__(self, test: expr, msg: expr | None = None, **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, test: expr, msg: expr | None, **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, test: expr = ..., msg: expr | None = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class Import(stmt): if sys.version_info >= (3, 10): @@ -774,26 +773,26 @@ class ImportFrom(stmt): class Global(stmt): if sys.version_info >= (3, 10): __match_args__ = ("names",) - names: list[_Identifier] + names: list[str] if sys.version_info >= (3, 13): - def __init__(self, names: list[_Identifier] = ..., **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, names: list[str] = ..., **kwargs: Unpack[_Attributes]) -> None: ... else: - def __init__(self, names: list[_Identifier], **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, names: list[str], **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, names: list[_Identifier], **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, names: list[str] = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class Nonlocal(stmt): if sys.version_info >= (3, 10): __match_args__ = ("names",) - names: list[_Identifier] + names: list[str] if sys.version_info >= (3, 13): - def __init__(self, names: list[_Identifier] = ..., **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, names: list[str] = ..., **kwargs: Unpack[_Attributes]) -> None: ... else: - def __init__(self, names: list[_Identifier], **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, names: list[str], **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, names: list[_Identifier] = ..., **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, names: list[str] = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class Expr(stmt): if sys.version_info >= (3, 10): @@ -1065,6 +1064,37 @@ class JoinedStr(expr): if sys.version_info >= (3, 14): def __replace__(self, *, values: list[expr] = ..., **kwargs: Unpack[_Attributes]) -> Self: ... +if sys.version_info >= (3, 14): + class TemplateStr(expr): + __match_args__ = ("values",) + values: list[expr] + def __init__(self, values: list[expr] = ..., **kwargs: Unpack[_Attributes]) -> None: ... + def __replace__(self, *, values: list[expr] = ..., **kwargs: Unpack[_Attributes]) -> Self: ... + + class Interpolation(expr): + __match_args__ = ("value", "str", "conversion", "format_spec") + value: expr + str: builtins.str + conversion: int + format_spec: builtins.str | None = None + def __init__( + self, + value: expr = ..., + str: builtins.str = ..., + conversion: int = ..., + format_spec: builtins.str | None = ..., + **kwargs: Unpack[_Attributes], + ) -> None: ... + def __replace__( + self, + *, + value: expr = ..., + str: builtins.str = ..., + conversion: int = ..., + format_spec: builtins.str | None = ..., + **kwargs: Unpack[_Attributes], + ) -> Self: ... + class Constant(expr): if sys.version_info >= (3, 10): __match_args__ = ("value", "kind") @@ -1084,13 +1114,13 @@ class Attribute(expr): if sys.version_info >= (3, 10): __match_args__ = ("value", "attr", "ctx") value: expr - attr: _Identifier + attr: str ctx: expr_context # Not present in Python < 3.13 if not passed to `__init__` - def __init__(self, value: expr, attr: _Identifier, ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, value: expr, attr: str, ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, *, value: expr = ..., attr: _Identifier = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes] + self, *, value: expr = ..., attr: str = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes] ) -> Self: ... class Subscript(expr): @@ -1119,12 +1149,12 @@ class Starred(expr): class Name(expr): if sys.version_info >= (3, 10): __match_args__ = ("id", "ctx") - id: _Identifier + id: str ctx: expr_context # Not present in Python < 3.13 if not passed to `__init__` - def __init__(self, id: _Identifier, ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, id: str, ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, id: _Identifier = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, id: str = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class List(expr): if sys.version_info >= (3, 10): @@ -1144,8 +1174,7 @@ class Tuple(expr): __match_args__ = ("elts", "ctx") elts: list[expr] ctx: expr_context # Not present in Python < 3.13 if not passed to `__init__` - if sys.version_info >= (3, 9): - dims: list[expr] + dims: list[expr] if sys.version_info >= (3, 13): def __init__(self, elts: list[expr] = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> None: ... else: @@ -1154,16 +1183,11 @@ class Tuple(expr): if sys.version_info >= (3, 14): def __replace__(self, *, elts: list[expr] = ..., ctx: expr_context = ..., **kwargs: Unpack[_Attributes]) -> Self: ... -class slice(AST): ... # deprecated and moved to ast.py for >= (3, 9) - -if sys.version_info >= (3, 9): - _Slice: typing_extensions.TypeAlias = expr - _SliceAttributes: typing_extensions.TypeAlias = _Attributes -else: - # alias for use with variables named slice - _Slice: typing_extensions.TypeAlias = slice +@deprecated("Deprecated since Python 3.9.") +class slice(AST): ... - class _SliceAttributes(TypedDict): ... +_Slice: typing_extensions.TypeAlias = expr +_SliceAttributes: typing_extensions.TypeAlias = _Attributes class Slice(_Slice): if sys.version_info >= (3, 10): @@ -1185,22 +1209,27 @@ class Slice(_Slice): **kwargs: Unpack[_SliceAttributes], ) -> Self: ... -class ExtSlice(slice): # deprecated and moved to ast.py if sys.version_info >= (3, 9) - dims: list[slice] - def __init__(self, dims: list[slice], **kwargs: Unpack[_SliceAttributes]) -> None: ... +@deprecated("Deprecated since Python 3.9. Use ast.Tuple instead.") +class ExtSlice(slice): + def __new__(cls, dims: Iterable[slice] = (), **kwargs: Unpack[_SliceAttributes]) -> Tuple: ... # type: ignore[misc] -class Index(slice): # deprecated and moved to ast.py if sys.version_info >= (3, 9) - value: expr - def __init__(self, value: expr, **kwargs: Unpack[_SliceAttributes]) -> None: ... +@deprecated("Deprecated since Python 3.9. Use the index value directly instead.") +class Index(slice): + def __new__(cls, value: expr, **kwargs: Unpack[_SliceAttributes]) -> expr: ... # type: ignore[misc] class expr_context(AST): ... -class AugLoad(expr_context): ... # deprecated and moved to ast.py if sys.version_info >= (3, 9) -class AugStore(expr_context): ... # deprecated and moved to ast.py if sys.version_info >= (3, 9) -class Param(expr_context): ... # deprecated and moved to ast.py if sys.version_info >= (3, 9) -class Suite(mod): # deprecated and moved to ast.py if sys.version_info >= (3, 9) - body: list[stmt] - def __init__(self, body: list[stmt]) -> None: ... +@deprecated("Deprecated since Python 3.9. Unused in Python 3.") +class AugLoad(expr_context): ... + +@deprecated("Deprecated since Python 3.9. Unused in Python 3.") +class AugStore(expr_context): ... + +@deprecated("Deprecated since Python 3.9. Unused in Python 3.") +class Param(expr_context): ... + +@deprecated("Deprecated since Python 3.9. Unused in Python 3.") +class Suite(mod): ... class Load(expr_context): ... class Store(expr_context): ... @@ -1273,30 +1302,23 @@ class ExceptHandler(excepthandler): if sys.version_info >= (3, 10): __match_args__ = ("type", "name", "body") type: expr | None - name: _Identifier | None + name: str | None body: list[stmt] if sys.version_info >= (3, 13): def __init__( - self, type: expr | None = None, name: _Identifier | None = None, body: list[stmt] = ..., **kwargs: Unpack[_Attributes] + self, type: expr | None = None, name: str | None = None, body: list[stmt] = ..., **kwargs: Unpack[_Attributes] ) -> None: ... else: @overload - def __init__( - self, type: expr | None, name: _Identifier | None, body: list[stmt], **kwargs: Unpack[_Attributes] - ) -> None: ... + def __init__(self, type: expr | None, name: str | None, body: list[stmt], **kwargs: Unpack[_Attributes]) -> None: ... @overload def __init__( - self, type: expr | None = None, name: _Identifier | None = None, *, body: list[stmt], **kwargs: Unpack[_Attributes] + self, type: expr | None = None, name: str | None = None, *, body: list[stmt], **kwargs: Unpack[_Attributes] ) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, - *, - type: expr | None = ..., - name: _Identifier | None = ..., - body: list[stmt] = ..., - **kwargs: Unpack[_Attributes], + self, *, type: expr | None = ..., name: str | None = ..., body: list[stmt] = ..., **kwargs: Unpack[_Attributes] ) -> Self: ... class arguments(AST): @@ -1377,21 +1399,16 @@ class arg(AST): end_col_offset: int | None if sys.version_info >= (3, 10): __match_args__ = ("arg", "annotation", "type_comment") - arg: _Identifier + arg: str annotation: expr | None type_comment: str | None def __init__( - self, arg: _Identifier, annotation: expr | None = None, type_comment: str | None = None, **kwargs: Unpack[_Attributes] + self, arg: str, annotation: expr | None = None, type_comment: str | None = None, **kwargs: Unpack[_Attributes] ) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, - *, - arg: _Identifier = ..., - annotation: expr | None = ..., - type_comment: str | None = ..., - **kwargs: Unpack[_Attributes], + self, *, arg: str = ..., annotation: expr | None = ..., type_comment: str | None = ..., **kwargs: Unpack[_Attributes] ) -> Self: ... class keyword(AST): @@ -1401,15 +1418,15 @@ class keyword(AST): end_col_offset: int | None if sys.version_info >= (3, 10): __match_args__ = ("arg", "value") - arg: _Identifier | None + arg: str | None value: expr @overload - def __init__(self, arg: _Identifier | None, value: expr, **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, arg: str | None, value: expr, **kwargs: Unpack[_Attributes]) -> None: ... @overload - def __init__(self, arg: _Identifier | None = None, *, value: expr, **kwargs: Unpack[_Attributes]) -> None: ... + def __init__(self, arg: str | None = None, *, value: expr, **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, arg: _Identifier | None = ..., value: expr = ..., **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, arg: str | None = ..., value: expr = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class alias(AST): lineno: int @@ -1419,11 +1436,11 @@ class alias(AST): if sys.version_info >= (3, 10): __match_args__ = ("name", "asname") name: str - asname: _Identifier | None - def __init__(self, name: str, asname: _Identifier | None = None, **kwargs: Unpack[_Attributes]) -> None: ... + asname: str | None + def __init__(self, name: str, asname: str | None = None, **kwargs: Unpack[_Attributes]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, name: str = ..., asname: _Identifier | None = ..., **kwargs: Unpack[_Attributes]) -> Self: ... + def __replace__(self, *, name: str = ..., asname: str | None = ..., **kwargs: Unpack[_Attributes]) -> Self: ... class withitem(AST): if sys.version_info >= (3, 10): @@ -1498,22 +1515,18 @@ if sys.version_info >= (3, 10): __match_args__ = ("keys", "patterns", "rest") keys: list[expr] patterns: list[pattern] - rest: _Identifier | None + rest: str | None if sys.version_info >= (3, 13): def __init__( self, keys: list[expr] = ..., patterns: list[pattern] = ..., - rest: _Identifier | None = None, + rest: str | None = None, **kwargs: Unpack[_Attributes[int]], ) -> None: ... else: def __init__( - self, - keys: list[expr], - patterns: list[pattern], - rest: _Identifier | None = None, - **kwargs: Unpack[_Attributes[int]], + self, keys: list[expr], patterns: list[pattern], rest: str | None = None, **kwargs: Unpack[_Attributes[int]] ) -> None: ... if sys.version_info >= (3, 14): @@ -1522,7 +1535,7 @@ if sys.version_info >= (3, 10): *, keys: list[expr] = ..., patterns: list[pattern] = ..., - rest: _Identifier | None = ..., + rest: str | None = ..., **kwargs: Unpack[_Attributes[int]], ) -> Self: ... @@ -1530,14 +1543,14 @@ if sys.version_info >= (3, 10): __match_args__ = ("cls", "patterns", "kwd_attrs", "kwd_patterns") cls: expr patterns: list[pattern] - kwd_attrs: list[_Identifier] + kwd_attrs: list[str] kwd_patterns: list[pattern] if sys.version_info >= (3, 13): def __init__( self, cls: expr, patterns: list[pattern] = ..., - kwd_attrs: list[_Identifier] = ..., + kwd_attrs: list[str] = ..., kwd_patterns: list[pattern] = ..., **kwargs: Unpack[_Attributes[int]], ) -> None: ... @@ -1546,7 +1559,7 @@ if sys.version_info >= (3, 10): self, cls: expr, patterns: list[pattern], - kwd_attrs: list[_Identifier], + kwd_attrs: list[str], kwd_patterns: list[pattern], **kwargs: Unpack[_Attributes[int]], ) -> None: ... @@ -1557,30 +1570,30 @@ if sys.version_info >= (3, 10): *, cls: expr = ..., patterns: list[pattern] = ..., - kwd_attrs: list[_Identifier] = ..., + kwd_attrs: list[str] = ..., kwd_patterns: list[pattern] = ..., **kwargs: Unpack[_Attributes[int]], ) -> Self: ... class MatchStar(pattern): __match_args__ = ("name",) - name: _Identifier | None - def __init__(self, name: _Identifier | None, **kwargs: Unpack[_Attributes[int]]) -> None: ... + name: str | None + def __init__(self, name: str | None, **kwargs: Unpack[_Attributes[int]]) -> None: ... if sys.version_info >= (3, 14): - def __replace__(self, *, name: _Identifier | None = ..., **kwargs: Unpack[_Attributes[int]]) -> Self: ... + def __replace__(self, *, name: str | None = ..., **kwargs: Unpack[_Attributes[int]]) -> Self: ... class MatchAs(pattern): __match_args__ = ("pattern", "name") pattern: _Pattern | None - name: _Identifier | None + name: str | None def __init__( - self, pattern: _Pattern | None = None, name: _Identifier | None = None, **kwargs: Unpack[_Attributes[int]] + self, pattern: _Pattern | None = None, name: str | None = None, **kwargs: Unpack[_Attributes[int]] ) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, *, pattern: _Pattern | None = ..., name: _Identifier | None = ..., **kwargs: Unpack[_Attributes[int]] + self, *, pattern: _Pattern | None = ..., name: str | None = ..., **kwargs: Unpack[_Attributes[int]] ) -> Self: ... class MatchOr(pattern): @@ -1622,25 +1635,21 @@ if sys.version_info >= (3, 12): __match_args__ = ("name", "bound", "default_value") else: __match_args__ = ("name", "bound") - name: _Identifier + name: str bound: expr | None if sys.version_info >= (3, 13): default_value: expr | None def __init__( - self, - name: _Identifier, - bound: expr | None = None, - default_value: expr | None = None, - **kwargs: Unpack[_Attributes[int]], + self, name: str, bound: expr | None = None, default_value: expr | None = None, **kwargs: Unpack[_Attributes[int]] ) -> None: ... else: - def __init__(self, name: _Identifier, bound: expr | None = None, **kwargs: Unpack[_Attributes[int]]) -> None: ... + def __init__(self, name: str, bound: expr | None = None, **kwargs: Unpack[_Attributes[int]]) -> None: ... if sys.version_info >= (3, 14): def __replace__( self, *, - name: _Identifier = ..., + name: str = ..., bound: expr | None = ..., default_value: expr | None = ..., **kwargs: Unpack[_Attributes[int]], @@ -1651,18 +1660,16 @@ if sys.version_info >= (3, 12): __match_args__ = ("name", "default_value") else: __match_args__ = ("name",) - name: _Identifier + name: str if sys.version_info >= (3, 13): default_value: expr | None - def __init__( - self, name: _Identifier, default_value: expr | None = None, **kwargs: Unpack[_Attributes[int]] - ) -> None: ... + def __init__(self, name: str, default_value: expr | None = None, **kwargs: Unpack[_Attributes[int]]) -> None: ... else: - def __init__(self, name: _Identifier, **kwargs: Unpack[_Attributes[int]]) -> None: ... + def __init__(self, name: str, **kwargs: Unpack[_Attributes[int]]) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, *, name: _Identifier = ..., default_value: expr | None = ..., **kwargs: Unpack[_Attributes[int]] + self, *, name: str = ..., default_value: expr | None = ..., **kwargs: Unpack[_Attributes[int]] ) -> Self: ... class TypeVarTuple(type_param): @@ -1670,23 +1677,20 @@ if sys.version_info >= (3, 12): __match_args__ = ("name", "default_value") else: __match_args__ = ("name",) - name: _Identifier + name: str if sys.version_info >= (3, 13): default_value: expr | None - def __init__( - self, name: _Identifier, default_value: expr | None = None, **kwargs: Unpack[_Attributes[int]] - ) -> None: ... + def __init__(self, name: str, default_value: expr | None = None, **kwargs: Unpack[_Attributes[int]]) -> None: ... else: - def __init__(self, name: _Identifier, **kwargs: Unpack[_Attributes[int]]) -> None: ... + def __init__(self, name: str, **kwargs: Unpack[_Attributes[int]]) -> None: ... if sys.version_info >= (3, 14): def __replace__( - self, *, name: _Identifier = ..., default_value: expr | None = ..., **kwargs: Unpack[_Attributes[int]] + self, *, name: str = ..., default_value: expr | None = ..., **kwargs: Unpack[_Attributes[int]] ) -> Self: ... class _ABC(type): - if sys.version_info >= (3, 9): - def __init__(cls, *args: Unused) -> None: ... + def __init__(cls, *args: Unused) -> None: ... if sys.version_info < (3, 14): @deprecated("Replaced by ast.Constant; removed in Python 3.14") @@ -1877,14 +1881,11 @@ if sys.version_info >= (3, 13): show_empty: bool = False, ) -> str: ... -elif sys.version_info >= (3, 9): +else: def dump( node: AST, annotate_fields: bool = True, include_attributes: bool = False, *, indent: int | str | None = None ) -> str: ... -else: - def dump(node: AST, annotate_fields: bool = True, include_attributes: bool = False) -> str: ... - def copy_location(new_node: _T, old_node: AST) -> _T: ... def fix_missing_locations(node: _T) -> _T: ... def increment_lineno(node: _T, n: int = 1) -> _T: ... @@ -1898,8 +1899,12 @@ if sys.version_info >= (3, 14): def compare(left: AST, right: AST, /, *, compare_attributes: bool = False) -> bool: ... class NodeVisitor: + # All visit methods below can be overwritten by subclasses and return an + # arbitrary value, which is passed to the caller. def visit(self, node: AST) -> Any: ... def generic_visit(self, node: AST) -> Any: ... + # The following visit methods are not defined on NodeVisitor, but can + # be implemented by subclasses and are called during a visit if defined. def visit_Module(self, node: Module) -> Any: ... def visit_Interactive(self, node: Interactive) -> Any: ... def visit_Expression(self, node: Expression) -> Any: ... @@ -2023,11 +2028,18 @@ class NodeVisitor: def visit_AugLoad(self, node: AugLoad) -> Any: ... def visit_AugStore(self, node: AugStore) -> Any: ... def visit_Param(self, node: Param) -> Any: ... - def visit_Num(self, node: Num) -> Any: ... - def visit_Str(self, node: Str) -> Any: ... - def visit_Bytes(self, node: Bytes) -> Any: ... - def visit_NameConstant(self, node: NameConstant) -> Any: ... - def visit_Ellipsis(self, node: Ellipsis) -> Any: ... + + if sys.version_info < (3, 14): + @deprecated("Replaced by visit_Constant; removed in Python 3.14") + def visit_Num(self, node: Num) -> Any: ... # type: ignore[deprecated] + @deprecated("Replaced by visit_Constant; removed in Python 3.14") + def visit_Str(self, node: Str) -> Any: ... # type: ignore[deprecated] + @deprecated("Replaced by visit_Constant; removed in Python 3.14") + def visit_Bytes(self, node: Bytes) -> Any: ... # type: ignore[deprecated] + @deprecated("Replaced by visit_Constant; removed in Python 3.14") + def visit_NameConstant(self, node: NameConstant) -> Any: ... # type: ignore[deprecated] + @deprecated("Replaced by visit_Constant; removed in Python 3.14") + def visit_Ellipsis(self, node: Ellipsis) -> Any: ... # type: ignore[deprecated] class NodeTransformer(NodeVisitor): def generic_visit(self, node: AST) -> AST: ... @@ -2035,8 +2047,10 @@ class NodeTransformer(NodeVisitor): # The usual return type is AST | None, but Iterable[AST] # is also allowed in some cases -- this needs to be mapped. -if sys.version_info >= (3, 9): - def unparse(ast_obj: AST) -> str: ... +def unparse(ast_obj: AST) -> str: ... -if sys.version_info >= (3, 9): +if sys.version_info >= (3, 14): + def main(args: Sequence[str] | None = None) -> None: ... + +else: def main() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asynchat.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asynchat.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asynchat.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asynchat.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi new file mode 100644 index 0000000000000..f9118608060e5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/__init__.pyi @@ -0,0 +1,1008 @@ +# ruff: noqa: PLR5501 # This condition is so big, it's clearer to keep to platform condition in two blocks +# Can't NOQA on a specific line: https://github.com/plinss/flake8-noqa/issues/22 +import sys +from collections.abc import Awaitable, Coroutine, Generator +from typing import Any, TypeVar +from typing_extensions import TypeAlias + +# As at runtime, this depends on all submodules defining __all__ accurately. +from .base_events import * +from .coroutines import * +from .events import * +from .exceptions import * +from .futures import * +from .locks import * +from .protocols import * +from .queues import * +from .runners import * +from .streams import * +from .subprocess import * +from .tasks import * +from .threads import * +from .transports import * + +if sys.version_info >= (3, 14): + from .graph import * + +if sys.version_info >= (3, 11): + from .taskgroups import * + from .timeouts import * + +if sys.platform == "win32": + from .windows_events import * +else: + from .unix_events import * + +if sys.platform == "win32": + if sys.version_info >= (3, 14): + + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "future_discard_from_awaited_by", # from futures + "future_add_to_awaited_by", # from futures + "capture_call_graph", # from graph + "format_call_graph", # from graph + "print_call_graph", # from graph + "FrameCallGraphEntry", # from graph + "FutureCallGraph", # from graph + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "QueueShutDown", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from windows_events + "ProactorEventLoop", # from windows_events + "IocpProactor", # from windows_events + "DefaultEventLoopPolicy", # from windows_events + "WindowsSelectorEventLoopPolicy", # from windows_events + "WindowsProactorEventLoopPolicy", # from windows_events + "EventLoop", # from windows_events + ) + elif sys.version_info >= (3, 13): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "QueueShutDown", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from windows_events + "ProactorEventLoop", # from windows_events + "IocpProactor", # from windows_events + "DefaultEventLoopPolicy", # from windows_events + "WindowsSelectorEventLoopPolicy", # from windows_events + "WindowsProactorEventLoopPolicy", # from windows_events + "EventLoop", # from windows_events + ) + elif sys.version_info >= (3, 12): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from windows_events + "ProactorEventLoop", # from windows_events + "IocpProactor", # from windows_events + "DefaultEventLoopPolicy", # from windows_events + "WindowsSelectorEventLoopPolicy", # from windows_events + "WindowsProactorEventLoopPolicy", # from windows_events + ) + elif sys.version_info >= (3, 11): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from windows_events + "ProactorEventLoop", # from windows_events + "IocpProactor", # from windows_events + "DefaultEventLoopPolicy", # from windows_events + "WindowsSelectorEventLoopPolicy", # from windows_events + "WindowsProactorEventLoopPolicy", # from windows_events + ) + else: + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "coroutine", # from coroutines + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "to_thread", # from threads + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from windows_events + "ProactorEventLoop", # from windows_events + "IocpProactor", # from windows_events + "DefaultEventLoopPolicy", # from windows_events + "WindowsSelectorEventLoopPolicy", # from windows_events + "WindowsProactorEventLoopPolicy", # from windows_events + ) +else: + if sys.version_info >= (3, 14): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "future_discard_from_awaited_by", # from futures + "future_add_to_awaited_by", # from futures + "capture_call_graph", # from graph + "format_call_graph", # from graph + "print_call_graph", # from graph + "FrameCallGraphEntry", # from graph + "FutureCallGraph", # from graph + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "QueueShutDown", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "open_unix_connection", # from streams + "start_unix_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from unix_events + "DefaultEventLoopPolicy", # from unix_events + "EventLoop", # from unix_events + ) + elif sys.version_info >= (3, 13): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "QueueShutDown", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "open_unix_connection", # from streams + "start_unix_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from unix_events + "AbstractChildWatcher", # from unix_events + "SafeChildWatcher", # from unix_events + "FastChildWatcher", # from unix_events + "PidfdChildWatcher", # from unix_events + "MultiLoopChildWatcher", # from unix_events + "ThreadedChildWatcher", # from unix_events + "DefaultEventLoopPolicy", # from unix_events + "EventLoop", # from unix_events + ) + elif sys.version_info >= (3, 12): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "open_unix_connection", # from streams + "start_unix_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "create_eager_task_factory", # from tasks + "eager_task_factory", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "TaskGroup", # from taskgroups + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from unix_events + "AbstractChildWatcher", # from unix_events + "SafeChildWatcher", # from unix_events + "FastChildWatcher", # from unix_events + "PidfdChildWatcher", # from unix_events + "MultiLoopChildWatcher", # from unix_events + "ThreadedChildWatcher", # from unix_events + "DefaultEventLoopPolicy", # from unix_events + ) + elif sys.version_info >= (3, 11): + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "BrokenBarrierError", # from exceptions + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "Barrier", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "Runner", # from runners + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "open_unix_connection", # from streams + "start_unix_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "to_thread", # from threads + "Timeout", # from timeouts + "timeout", # from timeouts + "timeout_at", # from timeouts + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from unix_events + "AbstractChildWatcher", # from unix_events + "SafeChildWatcher", # from unix_events + "FastChildWatcher", # from unix_events + "PidfdChildWatcher", # from unix_events + "MultiLoopChildWatcher", # from unix_events + "ThreadedChildWatcher", # from unix_events + "DefaultEventLoopPolicy", # from unix_events + ) + else: + __all__ = ( + "BaseEventLoop", # from base_events + "Server", # from base_events + "coroutine", # from coroutines + "iscoroutinefunction", # from coroutines + "iscoroutine", # from coroutines + "AbstractEventLoopPolicy", # from events + "AbstractEventLoop", # from events + "AbstractServer", # from events + "Handle", # from events + "TimerHandle", # from events + "get_event_loop_policy", # from events + "set_event_loop_policy", # from events + "get_event_loop", # from events + "set_event_loop", # from events + "new_event_loop", # from events + "get_child_watcher", # from events + "set_child_watcher", # from events + "_set_running_loop", # from events + "get_running_loop", # from events + "_get_running_loop", # from events + "CancelledError", # from exceptions + "InvalidStateError", # from exceptions + "TimeoutError", # from exceptions + "IncompleteReadError", # from exceptions + "LimitOverrunError", # from exceptions + "SendfileNotAvailableError", # from exceptions + "Future", # from futures + "wrap_future", # from futures + "isfuture", # from futures + "Lock", # from locks + "Event", # from locks + "Condition", # from locks + "Semaphore", # from locks + "BoundedSemaphore", # from locks + "BaseProtocol", # from protocols + "Protocol", # from protocols + "DatagramProtocol", # from protocols + "SubprocessProtocol", # from protocols + "BufferedProtocol", # from protocols + "run", # from runners + "Queue", # from queues + "PriorityQueue", # from queues + "LifoQueue", # from queues + "QueueFull", # from queues + "QueueEmpty", # from queues + "StreamReader", # from streams + "StreamWriter", # from streams + "StreamReaderProtocol", # from streams + "open_connection", # from streams + "start_server", # from streams + "open_unix_connection", # from streams + "start_unix_server", # from streams + "create_subprocess_exec", # from subprocess + "create_subprocess_shell", # from subprocess + "Task", # from tasks + "create_task", # from tasks + "FIRST_COMPLETED", # from tasks + "FIRST_EXCEPTION", # from tasks + "ALL_COMPLETED", # from tasks + "wait", # from tasks + "wait_for", # from tasks + "as_completed", # from tasks + "sleep", # from tasks + "gather", # from tasks + "shield", # from tasks + "ensure_future", # from tasks + "run_coroutine_threadsafe", # from tasks + "current_task", # from tasks + "all_tasks", # from tasks + "_register_task", # from tasks + "_unregister_task", # from tasks + "_enter_task", # from tasks + "_leave_task", # from tasks + "to_thread", # from threads + "BaseTransport", # from transports + "ReadTransport", # from transports + "WriteTransport", # from transports + "Transport", # from transports + "DatagramTransport", # from transports + "SubprocessTransport", # from transports + "SelectorEventLoop", # from unix_events + "AbstractChildWatcher", # from unix_events + "SafeChildWatcher", # from unix_events + "FastChildWatcher", # from unix_events + "PidfdChildWatcher", # from unix_events + "MultiLoopChildWatcher", # from unix_events + "ThreadedChildWatcher", # from unix_events + "DefaultEventLoopPolicy", # from unix_events + ) + +_T_co = TypeVar("_T_co", covariant=True) + +# Aliases imported by multiple submodules in typeshed +if sys.version_info >= (3, 12): + _AwaitableLike: TypeAlias = Awaitable[_T_co] # noqa: Y047 + _CoroutineLike: TypeAlias = Coroutine[Any, Any, _T_co] # noqa: Y047 +else: + _AwaitableLike: TypeAlias = Generator[Any, None, _T_co] | Awaitable[_T_co] + _CoroutineLike: TypeAlias = Generator[Any, None, _T_co] | Coroutine[Any, Any, _T_co] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi index cba2c77995284..cad7dde40b011 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_events.pyi @@ -8,15 +8,14 @@ from asyncio.protocols import BaseProtocol from asyncio.tasks import Task from asyncio.transports import BaseTransport, DatagramTransport, ReadTransport, SubprocessTransport, Transport, WriteTransport from collections.abc import Callable, Iterable, Sequence +from concurrent.futures import Executor, ThreadPoolExecutor from contextvars import Context from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket from typing import IO, Any, Literal, TypeVar, overload from typing_extensions import TypeAlias, TypeVarTuple, Unpack -if sys.version_info >= (3, 9): - __all__ = ("BaseEventLoop", "Server") -else: - __all__ = ("BaseEventLoop",) +# Keep asyncio.__all__ updated with any changes to __all__ here +__all__ = ("BaseEventLoop", "Server") _T = TypeVar("_T") _Ts = TypeVarTuple("_Ts") @@ -95,8 +94,8 @@ class BaseEventLoop(AbstractEventLoop): def call_soon_threadsafe( self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None ) -> Handle: ... - def run_in_executor(self, executor: Any, func: Callable[[Unpack[_Ts]], _T], *args: Unpack[_Ts]) -> Future[_T]: ... - def set_default_executor(self, executor: Any) -> None: ... + def run_in_executor(self, executor: Executor | None, func: Callable[[Unpack[_Ts]], _T], *args: Unpack[_Ts]) -> Future[_T]: ... + def set_default_executor(self, executor: ThreadPoolExecutor) -> None: ... # type: ignore[override] # Network I/O methods returning Futures. async def getaddrinfo( self, @@ -452,6 +451,7 @@ class BaseEventLoop(AbstractEventLoop): bufsize: Literal[0] = 0, encoding: None = None, errors: None = None, + text: Literal[False] | None = None, **kwargs: Any, ) -> tuple[SubprocessTransport, _ProtocolT]: ... def add_reader(self, fd: FileDescriptorLike, callback: Callable[[Unpack[_Ts]], Any], *args: Unpack[_Ts]) -> None: ... @@ -482,7 +482,7 @@ class BaseEventLoop(AbstractEventLoop): def set_debug(self, enabled: bool) -> None: ... if sys.version_info >= (3, 12): async def shutdown_default_executor(self, timeout: float | None = None) -> None: ... - elif sys.version_info >= (3, 9): + else: async def shutdown_default_executor(self) -> None: ... def __del__(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_futures.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_futures.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_futures.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_futures.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_subprocess.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_subprocess.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_subprocess.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_subprocess.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_tasks.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_tasks.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/base_tasks.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/base_tasks.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/constants.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/constants.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/constants.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/constants.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi index bc797de7fd518..8ef30b3d31980 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/coroutines.pyi @@ -3,6 +3,7 @@ from collections.abc import Awaitable, Callable, Coroutine from typing import Any, TypeVar, overload from typing_extensions import ParamSpec, TypeGuard, TypeIs +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 11): __all__ = ("iscoroutinefunction", "iscoroutine") else: diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/events.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/events.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/events.pyi index ead64070671fc..af43d2f5937dc 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/events.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/events.pyi @@ -9,6 +9,7 @@ from _asyncio import ( from _typeshed import FileDescriptorLike, ReadableBuffer, StrPath, Unused, WriteableBuffer from abc import ABCMeta, abstractmethod from collections.abc import Callable, Sequence +from concurrent.futures import Executor from contextvars import Context from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket from typing import IO, Any, Literal, Protocol, TypeVar, overload @@ -20,8 +21,11 @@ from .futures import Future from .protocols import BaseProtocol from .tasks import Task from .transports import BaseTransport, DatagramTransport, ReadTransport, SubprocessTransport, Transport, WriteTransport -from .unix_events import AbstractChildWatcher +if sys.version_info < (3, 14): + from .unix_events import AbstractChildWatcher + +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 14): __all__ = ( "AbstractEventLoopPolicy", @@ -136,27 +140,19 @@ class AbstractEventLoop: @abstractmethod async def shutdown_asyncgens(self) -> None: ... # Methods scheduling callbacks. All these return Handles. - if sys.version_info >= (3, 9): # "context" added in 3.9.10/3.10.2 - @abstractmethod - def call_soon( - self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None - ) -> Handle: ... - @abstractmethod - def call_later( - self, delay: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None - ) -> TimerHandle: ... - @abstractmethod - def call_at( - self, when: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None - ) -> TimerHandle: ... - else: - @abstractmethod - def call_soon(self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> Handle: ... - @abstractmethod - def call_later(self, delay: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> TimerHandle: ... - @abstractmethod - def call_at(self, when: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> TimerHandle: ... - + # "context" added in 3.9.10/3.10.2 for call_* + @abstractmethod + def call_soon( + self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None + ) -> Handle: ... + @abstractmethod + def call_later( + self, delay: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None + ) -> TimerHandle: ... + @abstractmethod + def call_at( + self, when: float, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None + ) -> TimerHandle: ... @abstractmethod def time(self) -> float: ... # Future methods @@ -177,19 +173,15 @@ class AbstractEventLoop: @abstractmethod def get_task_factory(self) -> _TaskFactory | None: ... # Methods for interacting with threads - if sys.version_info >= (3, 9): # "context" added in 3.9.10/3.10.2 - @abstractmethod - def call_soon_threadsafe( - self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None - ) -> Handle: ... - else: - @abstractmethod - def call_soon_threadsafe(self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> Handle: ... - + # "context" added in 3.9.10/3.10.2 + @abstractmethod + def call_soon_threadsafe( + self, callback: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts], context: Context | None = None + ) -> Handle: ... @abstractmethod - def run_in_executor(self, executor: Any, func: Callable[[Unpack[_Ts]], _T], *args: Unpack[_Ts]) -> Future[_T]: ... + def run_in_executor(self, executor: Executor | None, func: Callable[[Unpack[_Ts]], _T], *args: Unpack[_Ts]) -> Future[_T]: ... @abstractmethod - def set_default_executor(self, executor: Any) -> None: ... + def set_default_executor(self, executor: Executor) -> None: ... # Network I/O methods returning Futures. @abstractmethod async def getaddrinfo( @@ -605,9 +597,8 @@ class AbstractEventLoop: def get_debug(self) -> bool: ... @abstractmethod def set_debug(self, enabled: bool) -> None: ... - if sys.version_info >= (3, 9): - @abstractmethod - async def shutdown_default_executor(self) -> None: ... + @abstractmethod + async def shutdown_default_executor(self) -> None: ... class AbstractEventLoopPolicy: @abstractmethod diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi index 0746394d582fa..759838f45de47 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/exceptions.pyi @@ -1,5 +1,6 @@ import sys +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 11): __all__ = ( "BrokenBarrierError", diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/format_helpers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/format_helpers.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/format_helpers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/format_helpers.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi new file mode 100644 index 0000000000000..a63de66f02e67 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/futures.pyi @@ -0,0 +1,25 @@ +import sys +from _asyncio import Future as Future +from concurrent.futures._base import Future as _ConcurrentFuture +from typing import Any, TypeVar +from typing_extensions import TypeIs + +from .events import AbstractEventLoop + +# Keep asyncio.__all__ updated with any changes to __all__ here +if sys.version_info >= (3, 14): + __all__ = ("Future", "wrap_future", "isfuture", "future_discard_from_awaited_by", "future_add_to_awaited_by") +else: + __all__ = ("Future", "wrap_future", "isfuture") + +_T = TypeVar("_T") + +# asyncio defines 'isfuture()' in base_futures.py and re-imports it in futures.py +# but it leads to circular import error in pytype tool. +# That's why the import order is reversed. +def isfuture(obj: object) -> TypeIs[Future[Any]]: ... +def wrap_future(future: _ConcurrentFuture[_T] | Future[_T], *, loop: AbstractEventLoop | None = None) -> Future[_T]: ... + +if sys.version_info >= (3, 14): + def future_discard_from_awaited_by(future: Future[Any], waiter: Future[Any], /) -> None: ... + def future_add_to_awaited_by(future: Future[Any], waiter: Future[Any], /) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/graph.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/graph.pyi new file mode 100644 index 0000000000000..cb2cf01749955 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/graph.pyi @@ -0,0 +1,26 @@ +from _typeshed import SupportsWrite +from asyncio import Future +from dataclasses import dataclass +from types import FrameType +from typing import Any, overload + +__all__ = ("capture_call_graph", "format_call_graph", "print_call_graph", "FrameCallGraphEntry", "FutureCallGraph") + +@dataclass(frozen=True) +class FrameCallGraphEntry: + frame: FrameType + +@dataclass(frozen=True) +class FutureCallGraph: + future: Future[Any] + call_stack: tuple[FrameCallGraphEntry, ...] + awaited_by: tuple[FutureCallGraph, ...] + +@overload +def capture_call_graph(future: None = None, /, *, depth: int = 1, limit: int | None = None) -> FutureCallGraph | None: ... +@overload +def capture_call_graph(future: Future[Any], /, *, depth: int = 1, limit: int | None = None) -> FutureCallGraph | None: ... +def format_call_graph(future: Future[Any] | None = None, /, *, depth: int = 1, limit: int | None = None) -> str: ... +def print_call_graph( + future: Future[Any] | None = None, /, *, file: SupportsWrite[str] | None = None, depth: int = 1, limit: int | None = None +) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi new file mode 100644 index 0000000000000..17390b0c5a0ee --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/locks.pyi @@ -0,0 +1,104 @@ +import enum +import sys +from _typeshed import Unused +from collections import deque +from collections.abc import Callable +from types import TracebackType +from typing import Any, Literal, TypeVar +from typing_extensions import Self + +from .events import AbstractEventLoop +from .futures import Future + +if sys.version_info >= (3, 10): + from .mixins import _LoopBoundMixin +else: + _LoopBoundMixin = object + +# Keep asyncio.__all__ updated with any changes to __all__ here +if sys.version_info >= (3, 11): + __all__ = ("Lock", "Event", "Condition", "Semaphore", "BoundedSemaphore", "Barrier") +else: + __all__ = ("Lock", "Event", "Condition", "Semaphore", "BoundedSemaphore") + +_T = TypeVar("_T") + +class _ContextManagerMixin: + async def __aenter__(self) -> None: ... + async def __aexit__( + self, exc_type: type[BaseException] | None, exc: BaseException | None, tb: TracebackType | None + ) -> None: ... + +class Lock(_ContextManagerMixin, _LoopBoundMixin): + _waiters: deque[Future[Any]] | None + if sys.version_info >= (3, 10): + def __init__(self) -> None: ... + else: + def __init__(self, *, loop: AbstractEventLoop | None = None) -> None: ... + + def locked(self) -> bool: ... + async def acquire(self) -> Literal[True]: ... + def release(self) -> None: ... + +class Event(_LoopBoundMixin): + _waiters: deque[Future[Any]] + if sys.version_info >= (3, 10): + def __init__(self) -> None: ... + else: + def __init__(self, *, loop: AbstractEventLoop | None = None) -> None: ... + + def is_set(self) -> bool: ... + def set(self) -> None: ... + def clear(self) -> None: ... + async def wait(self) -> Literal[True]: ... + +class Condition(_ContextManagerMixin, _LoopBoundMixin): + _waiters: deque[Future[Any]] + if sys.version_info >= (3, 10): + def __init__(self, lock: Lock | None = None) -> None: ... + else: + def __init__(self, lock: Lock | None = None, *, loop: AbstractEventLoop | None = None) -> None: ... + + def locked(self) -> bool: ... + async def acquire(self) -> Literal[True]: ... + def release(self) -> None: ... + async def wait(self) -> Literal[True]: ... + async def wait_for(self, predicate: Callable[[], _T]) -> _T: ... + def notify(self, n: int = 1) -> None: ... + def notify_all(self) -> None: ... + +class Semaphore(_ContextManagerMixin, _LoopBoundMixin): + _value: int + _waiters: deque[Future[Any]] | None + if sys.version_info >= (3, 10): + def __init__(self, value: int = 1) -> None: ... + else: + def __init__(self, value: int = 1, *, loop: AbstractEventLoop | None = None) -> None: ... + + def locked(self) -> bool: ... + async def acquire(self) -> Literal[True]: ... + def release(self) -> None: ... + def _wake_up_next(self) -> None: ... + +class BoundedSemaphore(Semaphore): ... + +if sys.version_info >= (3, 11): + class _BarrierState(enum.Enum): # undocumented + FILLING = "filling" + DRAINING = "draining" + RESETTING = "resetting" + BROKEN = "broken" + + class Barrier(_LoopBoundMixin): + def __init__(self, parties: int) -> None: ... + async def __aenter__(self) -> Self: ... + async def __aexit__(self, *args: Unused) -> None: ... + async def wait(self) -> int: ... + async def abort(self) -> None: ... + async def reset(self) -> None: ... + @property + def parties(self) -> int: ... + @property + def n_waiting(self) -> int: ... + @property + def broken(self) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/log.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/log.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/log.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/log.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/mixins.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/mixins.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/mixins.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/mixins.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi index 957fdd6ce2559..909d671df289d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/proactor_events.pyi @@ -62,3 +62,4 @@ class _ProactorSocketTransport(_ProactorReadPipeTransport, _ProactorBaseWritePip class BaseProactorEventLoop(base_events.BaseEventLoop): def __init__(self, proactor: Any) -> None: ... + async def sock_recv(self, sock: socket, n: int) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi index 5173b74ed5a03..5425336c49a82 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/protocols.pyi @@ -2,6 +2,7 @@ from _typeshed import ReadableBuffer from asyncio import transports from typing import Any +# Keep asyncio.__all__ updated with any changes to __all__ here __all__ = ("BaseProtocol", "Protocol", "DatagramProtocol", "SubprocessProtocol", "BufferedProtocol") class BaseProtocol: diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi new file mode 100644 index 0000000000000..63cd98f53da3f --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/queues.pyi @@ -0,0 +1,54 @@ +import sys +from asyncio.events import AbstractEventLoop +from types import GenericAlias +from typing import Any, Generic, TypeVar + +if sys.version_info >= (3, 10): + from .mixins import _LoopBoundMixin +else: + _LoopBoundMixin = object + +class QueueEmpty(Exception): ... +class QueueFull(Exception): ... + +# Keep asyncio.__all__ updated with any changes to __all__ here +if sys.version_info >= (3, 13): + __all__ = ("Queue", "PriorityQueue", "LifoQueue", "QueueFull", "QueueEmpty", "QueueShutDown") + +else: + __all__ = ("Queue", "PriorityQueue", "LifoQueue", "QueueFull", "QueueEmpty") + +_T = TypeVar("_T") + +if sys.version_info >= (3, 13): + class QueueShutDown(Exception): ... + +# If Generic[_T] is last and _LoopBoundMixin is object, pyright is unhappy. +# We can remove the noqa pragma when dropping 3.9 support. +class Queue(Generic[_T], _LoopBoundMixin): # noqa: Y059 + if sys.version_info >= (3, 10): + def __init__(self, maxsize: int = 0) -> None: ... + else: + def __init__(self, maxsize: int = 0, *, loop: AbstractEventLoop | None = None) -> None: ... + + def _init(self, maxsize: int) -> None: ... + def _get(self) -> _T: ... + def _put(self, item: _T) -> None: ... + def _format(self) -> str: ... + def qsize(self) -> int: ... + @property + def maxsize(self) -> int: ... + def empty(self) -> bool: ... + def full(self) -> bool: ... + async def put(self, item: _T) -> None: ... + def put_nowait(self, item: _T) -> None: ... + async def get(self) -> _T: ... + def get_nowait(self) -> _T: ... + async def join(self) -> None: ... + def task_done(self) -> None: ... + def __class_getitem__(cls, type: Any, /) -> GenericAlias: ... + if sys.version_info >= (3, 13): + def shutdown(self, immediate: bool = False) -> None: ... + +class PriorityQueue(Queue[_T]): ... +class LifoQueue(Queue[_T]): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi index 37a85b709cdc4..caf5e4996cf4b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/runners.pyi @@ -7,6 +7,7 @@ from typing_extensions import Self from .events import AbstractEventLoop +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 11): __all__ = ("Runner", "run") else: diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi new file mode 100644 index 0000000000000..18c5df033e2f6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/selector_events.pyi @@ -0,0 +1,10 @@ +import selectors +from socket import socket + +from . import base_events + +__all__ = ("BaseSelectorEventLoop",) + +class BaseSelectorEventLoop(base_events.BaseEventLoop): + def __init__(self, selector: selectors.BaseSelector | None = None) -> None: ... + async def sock_recv(self, sock: socket, n: int) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi index ded1933dd6597..ab102f124c2e8 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/sslproto.pyi @@ -76,7 +76,7 @@ class _SSLProtocolTransport(transports._FlowControlMixin, transports.Transport): def get_extra_info(self, name: str, default: Any | None = None) -> dict[str, Any]: ... @property def _protocol_paused(self) -> bool: ... - def write(self, data: bytes | bytearray | memoryview) -> None: ... + def write(self, data: bytes | bytearray | memoryview[Any]) -> None: ... # any memoryview format or shape def can_write_eof(self) -> Literal[False]: ... if sys.version_info >= (3, 11): def get_write_buffer_limits(self) -> tuple[int, int]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/staggered.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/staggered.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/staggered.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/staggered.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi index 0be5249e2169f..43df5ae2d0c81 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/streams.pyi @@ -1,7 +1,7 @@ import ssl import sys from _typeshed import ReadableBuffer, StrPath -from collections.abc import AsyncIterator, Awaitable, Callable, Iterable, Sequence, Sized +from collections.abc import Awaitable, Callable, Iterable, Sequence, Sized from types import ModuleType from typing import Any, Protocol, SupportsIndex from typing_extensions import Self, TypeAlias @@ -9,6 +9,7 @@ from typing_extensions import Self, TypeAlias from . import events, protocols, transports from .base_events import Server +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.platform == "win32": __all__ = ("StreamReader", "StreamWriter", "StreamReaderProtocol", "open_connection", "start_server") else: @@ -137,7 +138,7 @@ class StreamWriter: elif sys.version_info >= (3, 11): def __del__(self) -> None: ... -class StreamReader(AsyncIterator[bytes]): +class StreamReader: def __init__(self, limit: int = 65536, loop: events.AbstractEventLoop | None = None) -> None: ... def exception(self) -> Exception: ... def set_exception(self, exc: Exception) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi new file mode 100644 index 0000000000000..50d75391f36d6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/subprocess.pyi @@ -0,0 +1,230 @@ +import subprocess +import sys +from _typeshed import StrOrBytesPath +from asyncio import events, protocols, streams, transports +from collections.abc import Callable, Collection +from typing import IO, Any, Literal + +# Keep asyncio.__all__ updated with any changes to __all__ here +__all__ = ("create_subprocess_exec", "create_subprocess_shell") + +PIPE: int +STDOUT: int +DEVNULL: int + +class SubprocessStreamProtocol(streams.FlowControlMixin, protocols.SubprocessProtocol): + stdin: streams.StreamWriter | None + stdout: streams.StreamReader | None + stderr: streams.StreamReader | None + def __init__(self, limit: int, loop: events.AbstractEventLoop) -> None: ... + def pipe_data_received(self, fd: int, data: bytes | str) -> None: ... + +class Process: + stdin: streams.StreamWriter | None + stdout: streams.StreamReader | None + stderr: streams.StreamReader | None + pid: int + def __init__( + self, transport: transports.BaseTransport, protocol: protocols.BaseProtocol, loop: events.AbstractEventLoop + ) -> None: ... + @property + def returncode(self) -> int | None: ... + async def wait(self) -> int: ... + def send_signal(self, signal: int) -> None: ... + def terminate(self) -> None: ... + def kill(self) -> None: ... + async def communicate(self, input: bytes | bytearray | memoryview | None = None) -> tuple[bytes, bytes]: ... + +if sys.version_info >= (3, 11): + async def create_subprocess_shell( + cmd: str | bytes, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + limit: int = 65536, + *, + # These parameters are forced to these values by BaseEventLoop.subprocess_shell + universal_newlines: Literal[False] = False, + shell: Literal[True] = True, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + process_group: int | None = None, + pipesize: int = -1, + ) -> Process: ... + async def create_subprocess_exec( + program: StrOrBytesPath, + *args: StrOrBytesPath, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + limit: int = 65536, + # These parameters are forced to these values by BaseEventLoop.subprocess_exec + universal_newlines: Literal[False] = False, + shell: Literal[False] = False, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + process_group: int | None = None, + pipesize: int = -1, + ) -> Process: ... + +elif sys.version_info >= (3, 10): + async def create_subprocess_shell( + cmd: str | bytes, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + limit: int = 65536, + *, + # These parameters are forced to these values by BaseEventLoop.subprocess_shell + universal_newlines: Literal[False] = False, + shell: Literal[True] = True, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + pipesize: int = -1, + ) -> Process: ... + async def create_subprocess_exec( + program: StrOrBytesPath, + *args: StrOrBytesPath, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + limit: int = 65536, + # These parameters are forced to these values by BaseEventLoop.subprocess_exec + universal_newlines: Literal[False] = False, + shell: Literal[False] = False, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + pipesize: int = -1, + ) -> Process: ... + +else: # >= 3.9 + async def create_subprocess_shell( + cmd: str | bytes, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + loop: events.AbstractEventLoop | None = None, + limit: int = 65536, + *, + # These parameters are forced to these values by BaseEventLoop.subprocess_shell + universal_newlines: Literal[False] = False, + shell: Literal[True] = True, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + ) -> Process: ... + async def create_subprocess_exec( + program: StrOrBytesPath, + *args: StrOrBytesPath, + stdin: int | IO[Any] | None = None, + stdout: int | IO[Any] | None = None, + stderr: int | IO[Any] | None = None, + loop: events.AbstractEventLoop | None = None, + limit: int = 65536, + # These parameters are forced to these values by BaseEventLoop.subprocess_exec + universal_newlines: Literal[False] = False, + shell: Literal[False] = False, + bufsize: Literal[0] = 0, + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + # These parameters are taken by subprocess.Popen, which this ultimately delegates to + executable: StrOrBytesPath | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + cwd: StrOrBytesPath | None = None, + env: subprocess._ENV | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + group: None | str | int = None, + extra_groups: None | Collection[str | int] = None, + user: None | str | int = None, + umask: int = -1, + ) -> Process: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi index aec3f1127f159..30b7c9129f6f9 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/taskgroups.pyi @@ -8,6 +8,7 @@ from . import _CoroutineLike from .events import AbstractEventLoop from .tasks import Task +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 12): __all__ = ("TaskGroup",) else: diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi index 47d1bb13e4a3a..e42151213e69c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/tasks.pyi @@ -7,7 +7,7 @@ from _asyncio import ( _register_task as _register_task, _unregister_task as _unregister_task, ) -from collections.abc import Awaitable, Coroutine, Generator, Iterable, Iterator +from collections.abc import AsyncIterator, Awaitable, Coroutine, Generator, Iterable, Iterator from typing import Any, Literal, Protocol, TypeVar, overload from typing_extensions import TypeAlias @@ -18,6 +18,7 @@ from .futures import Future if sys.version_info >= (3, 11): from contextvars import Context +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.version_info >= (3, 12): __all__ = ( "Task", @@ -78,13 +79,19 @@ if sys.version_info >= (3, 12): _FutureLike: TypeAlias = Future[_T] | Awaitable[_T] else: _FutureLike: TypeAlias = Future[_T] | Generator[Any, None, _T] | Awaitable[_T] + _TaskYieldType: TypeAlias = Future[object] | None FIRST_COMPLETED = concurrent.futures.FIRST_COMPLETED FIRST_EXCEPTION = concurrent.futures.FIRST_EXCEPTION ALL_COMPLETED = concurrent.futures.ALL_COMPLETED -if sys.version_info >= (3, 10): +if sys.version_info >= (3, 13): + class _SyncAndAsyncIterator(Iterator[_T_co], AsyncIterator[_T_co], Protocol[_T_co]): ... + + def as_completed(fs: Iterable[_FutureLike[_T]], *, timeout: float | None = None) -> _SyncAndAsyncIterator[Future[_T]]: ... + +elif sys.version_info >= (3, 10): def as_completed(fs: Iterable[_FutureLike[_T]], *, timeout: float | None = None) -> Iterator[Future[_T]]: ... else: @@ -341,7 +348,8 @@ else: *coros_or_futures: _FutureLike[_T], loop: AbstractEventLoop | None = None, return_exceptions: bool ) -> Future[list[_T | BaseException]]: ... -def run_coroutine_threadsafe(coro: _FutureLike[_T], loop: AbstractEventLoop) -> concurrent.futures.Future[_T]: ... +# unlike some asyncio apis, This does strict runtime checking of actually being a coroutine, not of any future-like. +def run_coroutine_threadsafe(coro: Coroutine[Any, Any, _T], loop: AbstractEventLoop) -> concurrent.futures.Future[_T]: ... if sys.version_info >= (3, 10): def shield(arg: _FutureLike[_T]) -> Future[_T]: ... @@ -399,10 +407,8 @@ else: if sys.version_info >= (3, 12): _TaskCompatibleCoro: TypeAlias = Coroutine[Any, Any, _T_co] -elif sys.version_info >= (3, 9): - _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Coroutine[Any, Any, _T_co] else: - _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Awaitable[_T_co] + _TaskCompatibleCoro: TypeAlias = Generator[_TaskYieldType, None, _T_co] | Coroutine[Any, Any, _T_co] def all_tasks(loop: AbstractEventLoop | None = None) -> set[Task[Any]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi similarity index 80% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi index 799efd25fea4d..00aae2ea814cb 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/threads.pyi @@ -2,6 +2,7 @@ from collections.abc import Callable from typing import TypeVar from typing_extensions import ParamSpec +# Keep asyncio.__all__ updated with any changes to __all__ here __all__ = ("to_thread",) _P = ParamSpec("_P") _R = TypeVar("_R") diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi index 2f0e40e256801..668cccbfe8b18 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/timeouts.pyi @@ -2,6 +2,7 @@ from types import TracebackType from typing import final from typing_extensions import Self +# Keep asyncio.__all__ updated with any changes to __all__ here __all__ = ("Timeout", "timeout", "timeout_at") @final diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi similarity index 85% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi index 531f776724384..bce54897f18f6 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/transports.pyi @@ -4,6 +4,7 @@ from collections.abc import Iterable, Mapping from socket import _Address from typing import Any +# Keep asyncio.__all__ updated with any changes to __all__ here __all__ = ("BaseTransport", "ReadTransport", "WriteTransport", "Transport", "DatagramTransport", "SubprocessTransport") class BaseTransport: @@ -23,8 +24,10 @@ class WriteTransport(BaseTransport): def set_write_buffer_limits(self, high: int | None = None, low: int | None = None) -> None: ... def get_write_buffer_size(self) -> int: ... def get_write_buffer_limits(self) -> tuple[int, int]: ... - def write(self, data: bytes | bytearray | memoryview) -> None: ... - def writelines(self, list_of_data: Iterable[bytes | bytearray | memoryview]) -> None: ... + def write(self, data: bytes | bytearray | memoryview[Any]) -> None: ... # any memoryview format or shape + def writelines( + self, list_of_data: Iterable[bytes | bytearray | memoryview[Any]] + ) -> None: ... # any memoryview format or shape def write_eof(self) -> None: ... def can_write_eof(self) -> bool: ... def abort(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/trsock.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/trsock.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/trsock.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/trsock.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi index fb21c5b5fa05f..79f99fbe37f02 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/unix_events.pyi @@ -13,10 +13,12 @@ from .selector_events import BaseSelectorEventLoop _Ts = TypeVarTuple("_Ts") +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.platform != "win32": if sys.version_info >= (3, 14): __all__ = ("SelectorEventLoop", "DefaultEventLoopPolicy", "EventLoop") elif sys.version_info >= (3, 13): + # Adds EventLoop __all__ = ( "SelectorEventLoop", "AbstractChildWatcher", @@ -28,23 +30,14 @@ if sys.platform != "win32": "DefaultEventLoopPolicy", "EventLoop", ) - elif sys.version_info >= (3, 9): - __all__ = ( - "SelectorEventLoop", - "AbstractChildWatcher", - "SafeChildWatcher", - "FastChildWatcher", - "PidfdChildWatcher", - "MultiLoopChildWatcher", - "ThreadedChildWatcher", - "DefaultEventLoopPolicy", - ) else: + # adds PidfdChildWatcher __all__ = ( "SelectorEventLoop", "AbstractChildWatcher", "SafeChildWatcher", "FastChildWatcher", + "PidfdChildWatcher", "MultiLoopChildWatcher", "ThreadedChildWatcher", "DefaultEventLoopPolicy", @@ -236,16 +229,15 @@ if sys.platform != "win32": def remove_child_handler(self, pid: int) -> bool: ... def attach_loop(self, loop: AbstractEventLoop | None) -> None: ... - if sys.version_info >= (3, 9): - class PidfdChildWatcher(AbstractChildWatcher): - def __enter__(self) -> Self: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None - ) -> None: ... - def is_active(self) -> bool: ... - def close(self) -> None: ... - def attach_loop(self, loop: AbstractEventLoop | None) -> None: ... - def add_child_handler( - self, pid: int, callback: Callable[[int, int, Unpack[_Ts]], object], *args: Unpack[_Ts] - ) -> None: ... - def remove_child_handler(self, pid: int) -> bool: ... + class PidfdChildWatcher(AbstractChildWatcher): + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None + ) -> None: ... + def is_active(self) -> bool: ... + def close(self) -> None: ... + def attach_loop(self, loop: AbstractEventLoop | None) -> None: ... + def add_child_handler( + self, pid: int, callback: Callable[[int, int, Unpack[_Ts]], object], *args: Unpack[_Ts] + ) -> None: ... + def remove_child_handler(self, pid: int) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi index e5205ba4dcb07..2ffc2eccb228a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/windows_events.pyi @@ -6,6 +6,7 @@ from typing import IO, Any, ClassVar, Final, NoReturn from . import events, futures, proactor_events, selector_events, streams, windows_utils +# Keep asyncio.__all__ updated with any changes to __all__ here if sys.platform == "win32": if sys.version_info >= (3, 13): # 3.13 added `EventLoop`. diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/windows_utils.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncio/windows_utils.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncio/windows_utils.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncio/windows_utils.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/asyncore.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/asyncore.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/asyncore.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/asyncore.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/atexit.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/atexit.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/atexit.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/atexit.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/audioop.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/audioop.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/audioop.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/audioop.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/base64.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/base64.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/base64.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/base64.pyi index 8be4cfe69de00..279d74a94ebe2 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/base64.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/base64.pyi @@ -56,10 +56,6 @@ def encode(input: IO[bytes], output: IO[bytes]) -> None: ... def encodebytes(s: ReadableBuffer) -> bytes: ... def decodebytes(s: ReadableBuffer) -> bytes: ... -if sys.version_info < (3, 9): - def encodestring(s: ReadableBuffer) -> bytes: ... - def decodestring(s: ReadableBuffer) -> bytes: ... - if sys.version_info >= (3, 13): def z85encode(s: ReadableBuffer) -> bytes: ... def z85decode(s: str | ReadableBuffer) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/bdb.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/bdb.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/bdb.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/bdb.pyi index 75bfa91cc3798..b73f894093ce5 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/bdb.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/bdb.pyi @@ -1,14 +1,16 @@ import sys from _typeshed import ExcInfo, TraceFunction, Unused -from collections.abc import Callable, Iterable, Mapping +from collections.abc import Callable, Iterable, Iterator, Mapping +from contextlib import contextmanager from types import CodeType, FrameType, TracebackType -from typing import IO, Any, Final, SupportsInt, TypeVar -from typing_extensions import ParamSpec +from typing import IO, Any, Final, Literal, SupportsInt, TypeVar +from typing_extensions import ParamSpec, TypeAlias __all__ = ["BdbQuit", "Bdb", "Breakpoint"] _T = TypeVar("_T") _P = ParamSpec("_P") +_Backend: TypeAlias = Literal["settrace", "monitoring"] # A union of code-object flags at runtime. # The exact values of code-object flags are implementation details, @@ -27,9 +29,18 @@ class Bdb: stopframe: FrameType | None returnframe: FrameType | None stoplineno: int - def __init__(self, skip: Iterable[str] | None = None) -> None: ... + if sys.version_info >= (3, 14): + backend: _Backend + def __init__(self, skip: Iterable[str] | None = None, backend: _Backend = "settrace") -> None: ... + else: + def __init__(self, skip: Iterable[str] | None = None) -> None: ... + def canonic(self, filename: str) -> str: ... def reset(self) -> None: ... + if sys.version_info >= (3, 12): + @contextmanager + def set_enterframe(self, frame: FrameType) -> Iterator[None]: ... + def trace_dispatch(self, frame: FrameType, event: str, arg: Any) -> TraceFunction: ... def dispatch_line(self, frame: FrameType) -> TraceFunction: ... def dispatch_call(self, frame: FrameType, arg: None) -> TraceFunction: ... @@ -73,13 +84,18 @@ class Bdb: def get_file_breaks(self, filename: str) -> list[Breakpoint]: ... def get_all_breaks(self) -> list[Breakpoint]: ... def get_stack(self, f: FrameType | None, t: TracebackType | None) -> tuple[list[tuple[FrameType, int]], int]: ... - def format_stack_entry(self, frame_lineno: int, lprefix: str = ": ") -> str: ... + def format_stack_entry(self, frame_lineno: tuple[FrameType, int], lprefix: str = ": ") -> str: ... def run( self, cmd: str | CodeType, globals: dict[str, Any] | None = None, locals: Mapping[str, Any] | None = None ) -> None: ... def runeval(self, expr: str, globals: dict[str, Any] | None = None, locals: Mapping[str, Any] | None = None) -> None: ... def runctx(self, cmd: str | CodeType, globals: dict[str, Any] | None, locals: Mapping[str, Any] | None) -> None: ... def runcall(self, func: Callable[_P, _T], /, *args: _P.args, **kwds: _P.kwargs) -> _T | None: ... + if sys.version_info >= (3, 14): + def start_trace(self) -> None: ... + def stop_trace(self) -> None: ... + def disable_current_event(self) -> None: ... + def restart_events(self) -> None: ... class Breakpoint: next: int diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/binascii.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/binascii.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/binascii.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/binascii.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/binhex.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/binhex.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/binhex.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/binhex.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/bisect.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/bisect.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/bisect.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/bisect.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/builtins.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/builtins.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/builtins.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/builtins.pyi index 63c53a5f6201d..ad6994cf605b3 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/builtins.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/builtins.pyi @@ -1,10 +1,11 @@ -# ruff: noqa: PYI036 # This is the module declaring BaseException import _ast +import _sitebuiltins import _typeshed import sys import types from _collections_abc import dict_items, dict_keys, dict_values from _typeshed import ( + AnnotationForm, AnyStr_co, ConvertibleToFloat, ConvertibleToInt, @@ -32,11 +33,11 @@ from _typeshed import ( ) from collections.abc import Awaitable, Callable, Iterable, Iterator, MutableSet, Reversible, Set as AbstractSet, Sized from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper -from types import CellType, CodeType, TracebackType +from types import CellType, CodeType, GenericAlias, TracebackType # mypy crashes if any of {ByteString, Sequence, MutableSequence, Mapping, MutableMapping} # are imported from collections.abc in builtins.pyi -from typing import ( # noqa: Y022 +from typing import ( # noqa: Y022,UP035 IO, Any, BinaryIO, @@ -45,7 +46,6 @@ from typing import ( # noqa: Y022 Mapping, MutableMapping, MutableSequence, - NoReturn, Protocol, Sequence, SupportsAbs, @@ -73,8 +73,8 @@ from typing_extensions import ( # noqa: Y023 deprecated, ) -if sys.version_info >= (3, 9): - from types import GenericAlias +if sys.version_info >= (3, 14): + from _typeshed import AnnotateFunc _T = TypeVar("_T") _I = TypeVar("_I", default=int) @@ -89,12 +89,20 @@ _T2 = TypeVar("_T2") _T3 = TypeVar("_T3") _T4 = TypeVar("_T4") _T5 = TypeVar("_T5") -_SupportsNextT = TypeVar("_SupportsNextT", bound=SupportsNext[Any], covariant=True) -_SupportsAnextT = TypeVar("_SupportsAnextT", bound=SupportsAnext[Any], covariant=True) +_SupportsNextT_co = TypeVar("_SupportsNextT_co", bound=SupportsNext[Any], covariant=True) +_SupportsAnextT_co = TypeVar("_SupportsAnextT_co", bound=SupportsAnext[Any], covariant=True) _AwaitableT = TypeVar("_AwaitableT", bound=Awaitable[Any]) _AwaitableT_co = TypeVar("_AwaitableT_co", bound=Awaitable[Any], covariant=True) _P = ParamSpec("_P") +# Type variables for slice +_StartT_co = TypeVar("_StartT_co", covariant=True, default=Any) # slice -> slice[Any, Any, Any] +_StopT_co = TypeVar("_StopT_co", covariant=True, default=_StartT_co) # slice[A] -> slice[A, A, A] +# NOTE: step could differ from start and stop, (e.g. datetime/timedelta)l +# the default (start|stop) is chosen to cater to the most common case of int/index slices. +# FIXME: https://github.com/python/typing/issues/213 (replace step=start|stop with step=start&stop) +_StepT_co = TypeVar("_StepT_co", covariant=True, default=_StartT_co | _StopT_co) # slice[A,B] -> slice[A, B, A|B] + class object: __doc__: str | None __dict__: dict[str, Any] @@ -103,7 +111,7 @@ class object: @property def __class__(self) -> type[Self]: ... @__class__.setter - def __class__(self, type: type[object], /) -> None: ... + def __class__(self, type: type[Self], /) -> None: ... def __init__(self) -> None: ... def __new__(cls) -> Self: ... # N.B. `object.__setattr__` and `object.__delattr__` are heavily special-cased by type checkers. @@ -211,6 +219,9 @@ class type: def __ror__(self, value: Any, /) -> types.UnionType: ... if sys.version_info >= (3, 12): __type_params__: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] + __annotations__: dict[str, AnnotationForm] + if sys.version_info >= (3, 14): + __annotate__: AnnotateFunc | None class super: @overload @@ -370,10 +381,8 @@ class float: def __rpow__(self, value: float, mod: None = None, /) -> Any: ... def __getnewargs__(self) -> tuple[float]: ... def __trunc__(self) -> int: ... - if sys.version_info >= (3, 9): - def __ceil__(self) -> int: ... - def __floor__(self) -> int: ... - + def __ceil__(self) -> int: ... + def __floor__(self) -> int: ... @overload def __round__(self, ndigits: None = None, /) -> int: ... @overload @@ -512,16 +521,15 @@ class str(Sequence[str]): ) -> LiteralString: ... @overload def replace(self, old: str, new: str, count: SupportsIndex = -1, /) -> str: ... # type: ignore[misc] - if sys.version_info >= (3, 9): - @overload - def removeprefix(self: LiteralString, prefix: LiteralString, /) -> LiteralString: ... - @overload - def removeprefix(self, prefix: str, /) -> str: ... # type: ignore[misc] - @overload - def removesuffix(self: LiteralString, suffix: LiteralString, /) -> LiteralString: ... - @overload - def removesuffix(self, suffix: str, /) -> str: ... # type: ignore[misc] + @overload + def removeprefix(self: LiteralString, prefix: LiteralString, /) -> LiteralString: ... + @overload + def removeprefix(self, prefix: str, /) -> str: ... # type: ignore[misc] + @overload + def removesuffix(self: LiteralString, suffix: LiteralString, /) -> LiteralString: ... + @overload + def removesuffix(self, suffix: str, /) -> str: ... # type: ignore[misc] def rfind(self, sub: str, start: SupportsIndex | None = ..., end: SupportsIndex | None = ..., /) -> int: ... def rindex(self, sub: str, start: SupportsIndex | None = ..., end: SupportsIndex | None = ..., /) -> int: ... @overload @@ -659,10 +667,8 @@ class bytes(Sequence[int]): def lstrip(self, bytes: ReadableBuffer | None = None, /) -> bytes: ... def partition(self, sep: ReadableBuffer, /) -> tuple[bytes, bytes, bytes]: ... def replace(self, old: ReadableBuffer, new: ReadableBuffer, count: SupportsIndex = -1, /) -> bytes: ... - if sys.version_info >= (3, 9): - def removeprefix(self, prefix: ReadableBuffer, /) -> bytes: ... - def removesuffix(self, suffix: ReadableBuffer, /) -> bytes: ... - + def removeprefix(self, prefix: ReadableBuffer, /) -> bytes: ... + def removesuffix(self, suffix: ReadableBuffer, /) -> bytes: ... def rfind( self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = ..., end: SupportsIndex | None = ..., / ) -> int: ... @@ -764,10 +770,8 @@ class bytearray(MutableSequence[int]): def partition(self, sep: ReadableBuffer, /) -> tuple[bytearray, bytearray, bytearray]: ... def pop(self, index: int = -1, /) -> int: ... def remove(self, value: int, /) -> None: ... - if sys.version_info >= (3, 9): - def removeprefix(self, prefix: ReadableBuffer, /) -> bytearray: ... - def removesuffix(self, suffix: ReadableBuffer, /) -> bytearray: ... - + def removeprefix(self, prefix: ReadableBuffer, /) -> bytearray: ... + def removesuffix(self, suffix: ReadableBuffer, /) -> bytearray: ... def replace(self, old: ReadableBuffer, new: ReadableBuffer, count: SupportsIndex = -1, /) -> bytearray: ... def rfind( self, sub: ReadableBuffer | SupportsIndex, start: SupportsIndex | None = ..., end: SupportsIndex | None = ..., / @@ -834,7 +838,7 @@ _IntegerFormats: TypeAlias = Literal[ ] @final -class memoryview(Generic[_I]): +class memoryview(Sequence[_I]): @property def format(self) -> str: ... @property @@ -862,7 +866,11 @@ class memoryview(Generic[_I]): def __new__(cls, obj: ReadableBuffer) -> Self: ... def __enter__(self) -> Self: ... def __exit__( - self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None, / + self, + exc_type: type[BaseException] | None, # noqa: PYI036 # This is the module declaring BaseException + exc_val: BaseException | None, + exc_tb: TracebackType | None, + /, ) -> None: ... @overload def cast(self, format: Literal["c", "@c"], shape: list[int] | tuple[int, ...] = ...) -> memoryview[bytes]: ... @@ -884,7 +892,7 @@ class memoryview(Generic[_I]): @overload def __setitem__(self, key: slice, value: ReadableBuffer, /) -> None: ... @overload - def __setitem__(self, key: SupportsIndex | tuple[SupportsIndex, ...], value: SupportsIndex, /) -> None: ... + def __setitem__(self, key: SupportsIndex | tuple[SupportsIndex, ...], value: _I, /) -> None: ... if sys.version_info >= (3, 10): def tobytes(self, order: Literal["C", "F", "A"] | None = "C") -> bytes: ... else: @@ -897,6 +905,11 @@ class memoryview(Generic[_I]): def __buffer__(self, flags: int, /) -> memoryview: ... def __release_buffer__(self, buffer: memoryview, /) -> None: ... + # These are inherited from the Sequence ABC, but don't actually exist on memoryview. + # See https://github.com/python/cpython/issues/125420 + index: ClassVar[None] # type: ignore[assignment] + count: ClassVar[None] # type: ignore[assignment] + @final class bool(int): def __new__(cls, o: object = ..., /) -> Self: ... @@ -931,19 +944,43 @@ class bool(int): def __invert__(self) -> int: ... @final -class slice: +class slice(Generic[_StartT_co, _StopT_co, _StepT_co]): @property - def start(self) -> Any: ... + def start(self) -> _StartT_co: ... @property - def step(self) -> Any: ... + def step(self) -> _StepT_co: ... @property - def stop(self) -> Any: ... + def stop(self) -> _StopT_co: ... + # Note: __new__ overloads map `None` to `Any`, since users expect slice(x, None) + # to be compatible with slice(None, x). + # generic slice -------------------------------------------------------------------- + @overload + def __new__(cls, start: None, stop: None = None, step: None = None, /) -> slice[Any, Any, Any]: ... + # unary overloads ------------------------------------------------------------------ + @overload + def __new__(cls, stop: _T2, /) -> slice[Any, _T2, Any]: ... + # binary overloads ----------------------------------------------------------------- + @overload + def __new__(cls, start: _T1, stop: None, step: None = None, /) -> slice[_T1, Any, Any]: ... + @overload + def __new__(cls, start: None, stop: _T2, step: None = None, /) -> slice[Any, _T2, Any]: ... @overload - def __new__(cls, stop: Any, /) -> Self: ... + def __new__(cls, start: _T1, stop: _T2, step: None = None, /) -> slice[_T1, _T2, Any]: ... + # ternary overloads ---------------------------------------------------------------- @overload - def __new__(cls, start: Any, stop: Any, step: Any = ..., /) -> Self: ... + def __new__(cls, start: None, stop: None, step: _T3, /) -> slice[Any, Any, _T3]: ... + @overload + def __new__(cls, start: _T1, stop: None, step: _T3, /) -> slice[_T1, Any, _T3]: ... + @overload + def __new__(cls, start: None, stop: _T2, step: _T3, /) -> slice[Any, _T2, _T3]: ... + @overload + def __new__(cls, start: _T1, stop: _T2, step: _T3, /) -> slice[_T1, _T2, _T3]: ... def __eq__(self, value: object, /) -> bool: ... - __hash__: ClassVar[None] # type: ignore[assignment] + if sys.version_info >= (3, 12): + def __hash__(self) -> int: ... + else: + __hash__: ClassVar[None] # type: ignore[assignment] + def indices(self, len: SupportsIndex, /) -> tuple[int, int, int]: ... class tuple(Sequence[_T_co]): @@ -969,12 +1006,12 @@ class tuple(Sequence[_T_co]): def __rmul__(self, value: SupportsIndex, /) -> tuple[_T_co, ...]: ... def count(self, value: Any, /) -> int: ... def index(self, value: Any, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... # Doesn't exist at runtime, but deleting this breaks mypy and pyright. See: # https://github.com/python/typeshed/issues/7580 # https://github.com/python/mypy/issues/8240 +# Obsolete, use types.FunctionType instead. @final @type_check_only class function: @@ -988,7 +1025,9 @@ class function: def __globals__(self) -> dict[str, Any]: ... __name__: str __qualname__: str - __annotations__: dict[str, Any] + __annotations__: dict[str, AnnotationForm] + if sys.version_info >= (3, 14): + __annotate__: AnnotateFunc | None __kwdefaults__: dict[str, Any] if sys.version_info >= (3, 10): @property @@ -1052,8 +1091,7 @@ class list(MutableSequence[_T]): def __lt__(self, value: list[_T], /) -> bool: ... def __le__(self, value: list[_T], /) -> bool: ... def __eq__(self, value: object, /) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class dict(MutableMapping[_KT, _VT]): # __init__ should be kept roughly in line with `collections.UserDict.__init__`, which has similar semantics @@ -1103,7 +1141,7 @@ class dict(MutableMapping[_KT, _VT]): def fromkeys(cls, iterable: Iterable[_T], value: _S, /) -> dict[_T, _S]: ... # Positional-only in dict, but not in MutableMapping @overload # type: ignore[override] - def get(self, key: _KT, /) -> _VT | None: ... + def get(self, key: _KT, default: None = None, /) -> _VT | None: ... @overload def get(self, key: _KT, default: _VT, /) -> _VT: ... @overload @@ -1122,21 +1160,20 @@ class dict(MutableMapping[_KT, _VT]): def __eq__(self, value: object, /) -> bool: ... def __reversed__(self) -> Iterator[_KT]: ... __hash__: ClassVar[None] # type: ignore[assignment] - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... - @overload - def __or__(self, value: dict[_KT, _VT], /) -> dict[_KT, _VT]: ... - @overload - def __or__(self, value: dict[_T1, _T2], /) -> dict[_KT | _T1, _VT | _T2]: ... - @overload - def __ror__(self, value: dict[_KT, _VT], /) -> dict[_KT, _VT]: ... - @overload - def __ror__(self, value: dict[_T1, _T2], /) -> dict[_KT | _T1, _VT | _T2]: ... - # dict.__ior__ should be kept roughly in line with MutableMapping.update() - @overload # type: ignore[misc] - def __ior__(self, value: SupportsKeysAndGetItem[_KT, _VT], /) -> Self: ... - @overload - def __ior__(self, value: Iterable[tuple[_KT, _VT]], /) -> Self: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + @overload + def __or__(self, value: dict[_KT, _VT], /) -> dict[_KT, _VT]: ... + @overload + def __or__(self, value: dict[_T1, _T2], /) -> dict[_KT | _T1, _VT | _T2]: ... + @overload + def __ror__(self, value: dict[_KT, _VT], /) -> dict[_KT, _VT]: ... + @overload + def __ror__(self, value: dict[_T1, _T2], /) -> dict[_KT | _T1, _VT | _T2]: ... + # dict.__ior__ should be kept roughly in line with MutableMapping.update() + @overload # type: ignore[misc] + def __ior__(self, value: SupportsKeysAndGetItem[_KT, _VT], /) -> Self: ... + @overload + def __ior__(self, value: Iterable[tuple[_KT, _VT]], /) -> Self: ... class set(MutableSet[_T]): @overload @@ -1175,8 +1212,7 @@ class set(MutableSet[_T]): def __gt__(self, value: AbstractSet[object], /) -> bool: ... def __eq__(self, value: object, /) -> bool: ... __hash__: ClassVar[None] # type: ignore[assignment] - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class frozenset(AbstractSet[_T_co]): @overload @@ -1204,15 +1240,13 @@ class frozenset(AbstractSet[_T_co]): def __gt__(self, value: AbstractSet[object], /) -> bool: ... def __eq__(self, value: object, /) -> bool: ... def __hash__(self) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... -class enumerate(Iterator[tuple[int, _T]]): +class enumerate(Generic[_T]): def __new__(cls, iterable: Iterable[_T], start: int = 0) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> tuple[int, _T]: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... @final class range(Sequence[int]): @@ -1257,15 +1291,16 @@ class property: def getter(self, fget: Callable[[Any], Any], /) -> property: ... def setter(self, fset: Callable[[Any, Any], None], /) -> property: ... def deleter(self, fdel: Callable[[Any], None], /) -> property: ... + @overload + def __get__(self, instance: None, owner: type, /) -> Self: ... + @overload def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... def __set__(self, instance: Any, value: Any, /) -> None: ... def __delete__(self, instance: Any, /) -> None: ... @final class _NotImplementedType(Any): - # A little weird, but typing the __call__ as NotImplemented makes the error message - # for NotImplemented() much better - __call__: NotImplemented # type: ignore[valid-type] # pyright: ignore[reportInvalidTypeForm] + __call__: None NotImplemented: _NotImplementedType @@ -1276,7 +1311,7 @@ def ascii(obj: object, /) -> str: ... def bin(number: int | SupportsIndex, /) -> str: ... def breakpoint(*args: Any, **kws: Any) -> None: ... def callable(obj: object, /) -> TypeIs[Callable[..., object]]: ... -def chr(i: int, /) -> str: ... +def chr(i: int | SupportsIndex, /) -> str: ... # We define this here instead of using os.PathLike to avoid import cycle issues. # See https://github.com/python/typeshed/pull/991#issuecomment-288160993 @@ -1284,7 +1319,7 @@ class _PathLike(Protocol[AnyStr_co]): def __fspath__(self) -> AnyStr_co: ... if sys.version_info >= (3, 10): - def aiter(async_iterable: SupportsAiter[_SupportsAnextT], /) -> _SupportsAnextT: ... + def aiter(async_iterable: SupportsAiter[_SupportsAnextT_co], /) -> _SupportsAnextT_co: ... class _SupportsSynchronousAnext(Protocol[_AwaitableT_co]): def __anext__(self) -> _AwaitableT_co: ... @@ -1343,8 +1378,10 @@ def compile( *, _feature_version: int = -1, ) -> Any: ... -def copyright() -> None: ... -def credits() -> None: ... + +copyright: _sitebuiltins._Printer +credits: _sitebuiltins._Printer + def delattr(obj: object, name: str, /) -> None: ... def dir(o: object = ..., /) -> list[str]: ... @overload @@ -1399,9 +1436,9 @@ else: /, ) -> None: ... -def exit(code: sys._ExitCode = None) -> NoReturn: ... +exit: _sitebuiltins.Quitter -class filter(Iterator[_T]): +class filter(Generic[_T]): @overload def __new__(cls, function: None, iterable: Iterable[_T | None], /) -> Self: ... @overload @@ -1433,7 +1470,9 @@ def getattr(o: object, name: str, default: _T, /) -> Any | _T: ... def globals() -> dict[str, Any]: ... def hasattr(obj: object, name: str, /) -> bool: ... def hash(obj: object, /) -> int: ... -def help(request: object = ...) -> None: ... + +help: _sitebuiltins._Helper + def hex(number: int | SupportsIndex, /) -> str: ... def id(obj: object, /) -> int: ... def input(prompt: object = "", /) -> str: ... @@ -1442,7 +1481,7 @@ class _GetItemIterable(Protocol[_T_co]): def __getitem__(self, i: int, /) -> _T_co: ... @overload -def iter(object: SupportsIter[_SupportsNextT], /) -> _SupportsNextT: ... +def iter(object: SupportsIter[_SupportsNextT_co], /) -> _SupportsNextT_co: ... @overload def iter(object: _GetItemIterable[_T], /) -> Iterator[_T]: ... @overload @@ -1459,52 +1498,114 @@ else: def isinstance(obj: object, class_or_tuple: _ClassInfo, /) -> bool: ... def issubclass(cls: type, class_or_tuple: _ClassInfo, /) -> bool: ... def len(obj: Sized, /) -> int: ... -def license() -> None: ... + +license: _sitebuiltins._Printer + def locals() -> dict[str, Any]: ... -class map(Iterator[_S]): - @overload - def __new__(cls, func: Callable[[_T1], _S], iter1: Iterable[_T1], /) -> Self: ... - @overload - def __new__(cls, func: Callable[[_T1, _T2], _S], iter1: Iterable[_T1], iter2: Iterable[_T2], /) -> Self: ... - @overload - def __new__( - cls, func: Callable[[_T1, _T2, _T3], _S], iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], / - ) -> Self: ... - @overload - def __new__( - cls, - func: Callable[[_T1, _T2, _T3, _T4], _S], - iter1: Iterable[_T1], - iter2: Iterable[_T2], - iter3: Iterable[_T3], - iter4: Iterable[_T4], - /, - ) -> Self: ... - @overload - def __new__( - cls, - func: Callable[[_T1, _T2, _T3, _T4, _T5], _S], - iter1: Iterable[_T1], - iter2: Iterable[_T2], - iter3: Iterable[_T3], - iter4: Iterable[_T4], - iter5: Iterable[_T5], - /, - ) -> Self: ... - @overload - def __new__( - cls, - func: Callable[..., _S], - iter1: Iterable[Any], - iter2: Iterable[Any], - iter3: Iterable[Any], - iter4: Iterable[Any], - iter5: Iterable[Any], - iter6: Iterable[Any], - /, - *iterables: Iterable[Any], - ) -> Self: ... +class map(Generic[_S]): + # 3.14 adds `strict` argument. + if sys.version_info >= (3, 14): + @overload + def __new__(cls, func: Callable[[_T1], _S], iterable: Iterable[_T1], /, *, strict: bool = False) -> Self: ... + @overload + def __new__( + cls, func: Callable[[_T1, _T2], _S], iterable: Iterable[_T1], iter2: Iterable[_T2], /, *, strict: bool = False + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[[_T1, _T2, _T3], _S], + iterable: Iterable[_T1], + iter2: Iterable[_T2], + iter3: Iterable[_T3], + /, + *, + strict: bool = False, + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[[_T1, _T2, _T3, _T4], _S], + iterable: Iterable[_T1], + iter2: Iterable[_T2], + iter3: Iterable[_T3], + iter4: Iterable[_T4], + /, + *, + strict: bool = False, + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[[_T1, _T2, _T3, _T4, _T5], _S], + iterable: Iterable[_T1], + iter2: Iterable[_T2], + iter3: Iterable[_T3], + iter4: Iterable[_T4], + iter5: Iterable[_T5], + /, + *, + strict: bool = False, + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[..., _S], + iterable: Iterable[Any], + iter2: Iterable[Any], + iter3: Iterable[Any], + iter4: Iterable[Any], + iter5: Iterable[Any], + iter6: Iterable[Any], + /, + *iterables: Iterable[Any], + strict: bool = False, + ) -> Self: ... + else: + @overload + def __new__(cls, func: Callable[[_T1], _S], iterable: Iterable[_T1], /) -> Self: ... + @overload + def __new__(cls, func: Callable[[_T1, _T2], _S], iterable: Iterable[_T1], iter2: Iterable[_T2], /) -> Self: ... + @overload + def __new__( + cls, func: Callable[[_T1, _T2, _T3], _S], iterable: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], / + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[[_T1, _T2, _T3, _T4], _S], + iterable: Iterable[_T1], + iter2: Iterable[_T2], + iter3: Iterable[_T3], + iter4: Iterable[_T4], + /, + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[[_T1, _T2, _T3, _T4, _T5], _S], + iterable: Iterable[_T1], + iter2: Iterable[_T2], + iter3: Iterable[_T3], + iter4: Iterable[_T4], + iter5: Iterable[_T5], + /, + ) -> Self: ... + @overload + def __new__( + cls, + func: Callable[..., _S], + iterable: Iterable[Any], + iter2: Iterable[Any], + iter3: Iterable[Any], + iter4: Iterable[Any], + iter5: Iterable[Any], + iter6: Iterable[Any], + /, + *iterables: Iterable[Any], + ) -> Self: ... + def __iter__(self) -> Self: ... def __next__(self) -> _S: ... @@ -1647,17 +1748,17 @@ def print( *values: object, sep: str | None = " ", end: str | None = "\n", file: _SupportsWriteAndFlush[str] | None = None, flush: bool ) -> None: ... -_E = TypeVar("_E", contravariant=True) -_M = TypeVar("_M", contravariant=True) +_E_contra = TypeVar("_E_contra", contravariant=True) +_M_contra = TypeVar("_M_contra", contravariant=True) -class _SupportsPow2(Protocol[_E, _T_co]): - def __pow__(self, other: _E, /) -> _T_co: ... +class _SupportsPow2(Protocol[_E_contra, _T_co]): + def __pow__(self, other: _E_contra, /) -> _T_co: ... -class _SupportsPow3NoneOnly(Protocol[_E, _T_co]): - def __pow__(self, other: _E, modulo: None = None, /) -> _T_co: ... +class _SupportsPow3NoneOnly(Protocol[_E_contra, _T_co]): + def __pow__(self, other: _E_contra, modulo: None = None, /) -> _T_co: ... -class _SupportsPow3(Protocol[_E, _M, _T_co]): - def __pow__(self, other: _E, modulo: _M, /) -> _T_co: ... +class _SupportsPow3(Protocol[_E_contra, _M_contra, _T_co]): + def __pow__(self, other: _E_contra, modulo: _M_contra, /) -> _T_co: ... _SupportsSomeKindOfPow = ( # noqa: Y026 # TODO: Use TypeAlias once mypy bugs are fixed _SupportsPow2[Any, Any] | _SupportsPow3NoneOnly[Any, Any] | _SupportsPow3[Any, Any, Any] @@ -1693,18 +1794,19 @@ def pow(base: float, exp: complex | _SupportsSomeKindOfPow, mod: None = None) -> @overload def pow(base: complex, exp: complex | _SupportsSomeKindOfPow, mod: None = None) -> complex: ... @overload -def pow(base: _SupportsPow2[_E, _T_co], exp: _E, mod: None = None) -> _T_co: ... # type: ignore[overload-overlap] +def pow(base: _SupportsPow2[_E_contra, _T_co], exp: _E_contra, mod: None = None) -> _T_co: ... # type: ignore[overload-overlap] @overload -def pow(base: _SupportsPow3NoneOnly[_E, _T_co], exp: _E, mod: None = None) -> _T_co: ... # type: ignore[overload-overlap] +def pow(base: _SupportsPow3NoneOnly[_E_contra, _T_co], exp: _E_contra, mod: None = None) -> _T_co: ... # type: ignore[overload-overlap] @overload -def pow(base: _SupportsPow3[_E, _M, _T_co], exp: _E, mod: _M) -> _T_co: ... +def pow(base: _SupportsPow3[_E_contra, _M_contra, _T_co], exp: _E_contra, mod: _M_contra) -> _T_co: ... @overload def pow(base: _SupportsSomeKindOfPow, exp: float, mod: None = None) -> Any: ... @overload def pow(base: _SupportsSomeKindOfPow, exp: complex, mod: None = None) -> complex: ... -def quit(code: sys._ExitCode = None) -> NoReturn: ... -class reversed(Iterator[_T]): +quit: _sitebuiltins.Quitter + +class reversed(Generic[_T]): @overload def __new__(cls, sequence: Reversible[_T], /) -> Iterator[_T]: ... # type: ignore[misc] @overload @@ -1765,7 +1867,7 @@ def vars(object: type, /) -> types.MappingProxyType[str, Any]: ... @overload def vars(object: Any = ..., /) -> dict[str, Any]: ... -class zip(Iterator[_T_co]): +class zip(Generic[_T_co]): if sys.version_info >= (3, 10): @overload def __new__(cls, *, strict: bool = ...) -> zip[Any]: ... @@ -1895,8 +1997,8 @@ class StopIteration(Exception): value: Any class OSError(Exception): - errno: int - strerror: str + errno: int | None + strerror: str | None # filename, filename2 are actually str | bytes | None filename: Any filename2: Any @@ -1938,20 +2040,37 @@ class NameError(Exception): class ReferenceError(Exception): ... class RuntimeError(Exception): ... - -class StopAsyncIteration(Exception): - value: Any +class StopAsyncIteration(Exception): ... class SyntaxError(Exception): msg: str + filename: str | None lineno: int | None offset: int | None text: str | None - filename: str | None + # Errors are displayed differently if this attribute exists on the exception. + # The value is always None. + print_file_and_line: None if sys.version_info >= (3, 10): end_lineno: int | None end_offset: int | None + @overload + def __init__(self) -> None: ... + @overload + def __init__(self, msg: object, /) -> None: ... + # Second argument is the tuple (filename, lineno, offset, text) + @overload + def __init__(self, msg: str, info: tuple[str | None, int | None, int | None, str | None], /) -> None: ... + if sys.version_info >= (3, 10): + # end_lineno and end_offset must both be provided if one is. + @overload + def __init__( + self, msg: str, info: tuple[str | None, int | None, int | None, str | None, int | None, int | None], / + ) -> None: ... + # If you provide more than two arguments, it still creates the SyntaxError, but + # the arguments from the info tuple are not parsed. This form is omitted. + class SystemError(Exception): ... class TypeError(Exception): ... class ValueError(Exception): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/bz2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/bz2.pyi new file mode 100644 index 0000000000000..0f9d00fbc633e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/bz2.pyi @@ -0,0 +1,116 @@ +import sys +from _bz2 import BZ2Compressor as BZ2Compressor, BZ2Decompressor as BZ2Decompressor +from _typeshed import ReadableBuffer, StrOrBytesPath, WriteableBuffer +from collections.abc import Iterable +from typing import IO, Literal, Protocol, SupportsIndex, TextIO, overload +from typing_extensions import Self, TypeAlias + +if sys.version_info >= (3, 14): + from compression._common._streams import BaseStream, _Reader +else: + from _compression import BaseStream, _Reader + +__all__ = ["BZ2File", "BZ2Compressor", "BZ2Decompressor", "open", "compress", "decompress"] + +# The following attributes and methods are optional: +# def fileno(self) -> int: ... +# def close(self) -> object: ... +class _ReadableFileobj(_Reader, Protocol): ... + +class _WritableFileobj(Protocol): + def write(self, b: bytes, /) -> object: ... + # The following attributes and methods are optional: + # def fileno(self) -> int: ... + # def close(self) -> object: ... + +def compress(data: ReadableBuffer, compresslevel: int = 9) -> bytes: ... +def decompress(data: ReadableBuffer) -> bytes: ... + +_ReadBinaryMode: TypeAlias = Literal["", "r", "rb"] +_WriteBinaryMode: TypeAlias = Literal["w", "wb", "x", "xb", "a", "ab"] +_ReadTextMode: TypeAlias = Literal["rt"] +_WriteTextMode: TypeAlias = Literal["wt", "xt", "at"] + +@overload +def open( + filename: _ReadableFileobj, + mode: _ReadBinaryMode = "rb", + compresslevel: int = 9, + encoding: None = None, + errors: None = None, + newline: None = None, +) -> BZ2File: ... +@overload +def open( + filename: _ReadableFileobj, + mode: _ReadTextMode, + compresslevel: int = 9, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> TextIO: ... +@overload +def open( + filename: _WritableFileobj, + mode: _WriteBinaryMode, + compresslevel: int = 9, + encoding: None = None, + errors: None = None, + newline: None = None, +) -> BZ2File: ... +@overload +def open( + filename: _WritableFileobj, + mode: _WriteTextMode, + compresslevel: int = 9, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> TextIO: ... +@overload +def open( + filename: StrOrBytesPath, + mode: _ReadBinaryMode | _WriteBinaryMode = "rb", + compresslevel: int = 9, + encoding: None = None, + errors: None = None, + newline: None = None, +) -> BZ2File: ... +@overload +def open( + filename: StrOrBytesPath, + mode: _ReadTextMode | _WriteTextMode, + compresslevel: int = 9, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> TextIO: ... +@overload +def open( + filename: StrOrBytesPath | _ReadableFileobj | _WritableFileobj, + mode: str, + compresslevel: int = 9, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> BZ2File | TextIO: ... + +class BZ2File(BaseStream, IO[bytes]): + def __enter__(self) -> Self: ... + @overload + def __init__(self, filename: _WritableFileobj, mode: _WriteBinaryMode, *, compresslevel: int = 9) -> None: ... + @overload + def __init__(self, filename: _ReadableFileobj, mode: _ReadBinaryMode = "r", *, compresslevel: int = 9) -> None: ... + @overload + def __init__( + self, filename: StrOrBytesPath, mode: _ReadBinaryMode | _WriteBinaryMode = "r", *, compresslevel: int = 9 + ) -> None: ... + def read(self, size: int | None = -1) -> bytes: ... + def read1(self, size: int = -1) -> bytes: ... + def readline(self, size: SupportsIndex = -1) -> bytes: ... # type: ignore[override] + def readinto(self, b: WriteableBuffer) -> int: ... + def readlines(self, size: SupportsIndex = -1) -> list[bytes]: ... + def peek(self, n: int = 0) -> bytes: ... + def seek(self, offset: int, whence: int = 0) -> int: ... + def write(self, data: ReadableBuffer) -> int: ... + def writelines(self, seq: Iterable[ReadableBuffer]) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/cProfile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/cProfile.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/cProfile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/cProfile.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/calendar.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/calendar.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/calendar.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/calendar.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/cgi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/cgi.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/cgi.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/cgi.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/cgitb.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/cgitb.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/cgitb.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/cgitb.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/chunk.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/chunk.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/chunk.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/chunk.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/cmath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/cmath.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/cmath.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/cmath.pyi index fab9d10230f84..a08addcf54389 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/cmath.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/cmath.pyi @@ -1,13 +1,13 @@ -from typing import SupportsComplex, SupportsFloat, SupportsIndex +from typing import Final, SupportsComplex, SupportsFloat, SupportsIndex from typing_extensions import TypeAlias -e: float -pi: float -inf: float -infj: complex -nan: float -nanj: complex -tau: float +e: Final[float] +pi: Final[float] +inf: Final[float] +infj: Final[complex] +nan: Final[float] +nanj: Final[complex] +tau: Final[float] _C: TypeAlias = SupportsFloat | SupportsComplex | SupportsIndex | complex diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/cmd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/cmd.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/cmd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/cmd.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/code.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/code.pyi new file mode 100644 index 0000000000000..0b13c8a5016d4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/code.pyi @@ -0,0 +1,54 @@ +import sys +from codeop import CommandCompiler, compile_command as compile_command +from collections.abc import Callable +from types import CodeType +from typing import Any + +__all__ = ["InteractiveInterpreter", "InteractiveConsole", "interact", "compile_command"] + +class InteractiveInterpreter: + locals: dict[str, Any] # undocumented + compile: CommandCompiler # undocumented + def __init__(self, locals: dict[str, Any] | None = None) -> None: ... + def runsource(self, source: str, filename: str = "<input>", symbol: str = "single") -> bool: ... + def runcode(self, code: CodeType) -> None: ... + if sys.version_info >= (3, 13): + def showsyntaxerror(self, filename: str | None = None, *, source: str = "") -> None: ... + else: + def showsyntaxerror(self, filename: str | None = None) -> None: ... + + def showtraceback(self) -> None: ... + def write(self, data: str) -> None: ... + +class InteractiveConsole(InteractiveInterpreter): + buffer: list[str] # undocumented + filename: str # undocumented + if sys.version_info >= (3, 13): + def __init__( + self, locals: dict[str, Any] | None = None, filename: str = "<console>", *, local_exit: bool = False + ) -> None: ... + def push(self, line: str, filename: str | None = None) -> bool: ... + else: + def __init__(self, locals: dict[str, Any] | None = None, filename: str = "<console>") -> None: ... + def push(self, line: str) -> bool: ... + + def interact(self, banner: str | None = None, exitmsg: str | None = None) -> None: ... + def resetbuffer(self) -> None: ... + def raw_input(self, prompt: str = "") -> str: ... + +if sys.version_info >= (3, 13): + def interact( + banner: str | None = None, + readfunc: Callable[[str], str] | None = None, + local: dict[str, Any] | None = None, + exitmsg: str | None = None, + local_exit: bool = False, + ) -> None: ... + +else: + def interact( + banner: str | None = None, + readfunc: Callable[[str], str] | None = None, + local: dict[str, Any] | None = None, + exitmsg: str | None = None, + ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/codecs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/codecs.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/codecs.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/codecs.pyi index a41df9752d335..579d09c66a1bc 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/codecs.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/codecs.pyi @@ -3,8 +3,8 @@ from _codecs import * from _typeshed import ReadableBuffer from abc import abstractmethod from collections.abc import Callable, Generator, Iterable -from typing import Any, BinaryIO, Final, Literal, Protocol, TextIO -from typing_extensions import Self +from typing import Any, BinaryIO, ClassVar, Final, Literal, Protocol, TextIO, overload +from typing_extensions import Self, TypeAlias __all__ = [ "register", @@ -58,6 +58,21 @@ BOM32_LE: Final = b"\xff\xfe" BOM64_BE: Final = b"\x00\x00\xfe\xff" BOM64_LE: Final = b"\xff\xfe\x00\x00" +_BufferedEncoding: TypeAlias = Literal[ + "idna", + "raw-unicode-escape", + "unicode-escape", + "utf-16", + "utf-16-be", + "utf-16-le", + "utf-32", + "utf-32-be", + "utf-32-le", + "utf-7", + "utf-8", + "utf-8-sig", +] + class _WritableStream(Protocol): def write(self, data: bytes, /) -> object: ... def seek(self, offset: int, whence: int, /) -> object: ... @@ -94,6 +109,9 @@ class _IncrementalEncoder(Protocol): class _IncrementalDecoder(Protocol): def __call__(self, errors: str = ...) -> IncrementalDecoder: ... +class _BufferedIncrementalDecoder(Protocol): + def __call__(self, errors: str = ...) -> BufferedIncrementalDecoder: ... + class CodecInfo(tuple[_Encoder, _Decoder, _StreamReader, _StreamWriter]): _is_text_encoding: bool @property @@ -125,6 +143,9 @@ class CodecInfo(tuple[_Encoder, _Decoder, _StreamReader, _StreamWriter]): def getencoder(encoding: str) -> _Encoder: ... def getdecoder(encoding: str) -> _Decoder: ... def getincrementalencoder(encoding: str) -> _IncrementalEncoder: ... +@overload +def getincrementaldecoder(encoding: _BufferedEncoding) -> _BufferedIncrementalDecoder: ... +@overload def getincrementaldecoder(encoding: str) -> _IncrementalDecoder: ... def getreader(encoding: str) -> _StreamReader: ... def getwriter(encoding: str) -> _StreamWriter: ... @@ -202,6 +223,7 @@ class StreamWriter(Codec): def write(self, object: str) -> None: ... def writelines(self, list: Iterable[str]) -> None: ... def reset(self) -> None: ... + def seek(self, offset: int, whence: int = 0) -> None: ... def __enter__(self) -> Self: ... def __exit__(self, type: type[BaseException] | None, value: BaseException | None, tb: types.TracebackType | None) -> None: ... def __getattr__(self, name: str, getattr: Callable[[Any, str], Any] = ...) -> Any: ... @@ -209,11 +231,14 @@ class StreamWriter(Codec): class StreamReader(Codec): stream: _ReadableStream errors: str + # This is set to str, but some subclasses set to bytes instead. + charbuffertype: ClassVar[type] = ... def __init__(self, stream: _ReadableStream, errors: str = "strict") -> None: ... def read(self, size: int = -1, chars: int = -1, firstline: bool = False) -> str: ... def readline(self, size: int | None = None, keepends: bool = True) -> str: ... def readlines(self, sizehint: int | None = None, keepends: bool = True) -> list[str]: ... def reset(self) -> None: ... + def seek(self, offset: int, whence: int = 0) -> None: ... def __enter__(self) -> Self: ... def __exit__(self, type: type[BaseException] | None, value: BaseException | None, tb: types.TracebackType | None) -> None: ... def __iter__(self) -> Self: ... @@ -250,6 +275,8 @@ class StreamReaderWriter(TextIO): def writable(self) -> bool: ... class StreamRecoder(BinaryIO): + data_encoding: str + file_encoding: str def __init__( self, stream: _Stream, diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/codeop.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/codeop.pyi new file mode 100644 index 0000000000000..8e311343eb89d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/codeop.pyi @@ -0,0 +1,21 @@ +import sys +from types import CodeType + +__all__ = ["compile_command", "Compile", "CommandCompiler"] + +if sys.version_info >= (3, 14): + def compile_command(source: str, filename: str = "<input>", symbol: str = "single", flags: int = 0) -> CodeType | None: ... + +else: + def compile_command(source: str, filename: str = "<input>", symbol: str = "single") -> CodeType | None: ... + +class Compile: + flags: int + if sys.version_info >= (3, 13): + def __call__(self, source: str, filename: str, symbol: str, flags: int = 0) -> CodeType: ... + else: + def __call__(self, source: str, filename: str, symbol: str) -> CodeType: ... + +class CommandCompiler: + compiler: Compile + def __call__(self, source: str, filename: str = "<input>", symbol: str = "single") -> CodeType | None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/collections/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/collections/__init__.pyi new file mode 100644 index 0000000000000..b9e4f84ec0b63 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/collections/__init__.pyi @@ -0,0 +1,495 @@ +import sys +from _collections_abc import dict_items, dict_keys, dict_values +from _typeshed import SupportsItems, SupportsKeysAndGetItem, SupportsRichComparison, SupportsRichComparisonT +from types import GenericAlias +from typing import Any, ClassVar, Generic, NoReturn, SupportsIndex, TypeVar, final, overload +from typing_extensions import Self + +if sys.version_info >= (3, 10): + from collections.abc import ( + Callable, + ItemsView, + Iterable, + Iterator, + KeysView, + Mapping, + MutableMapping, + MutableSequence, + Sequence, + ValuesView, + ) +else: + from _collections_abc import * + +__all__ = ["ChainMap", "Counter", "OrderedDict", "UserDict", "UserList", "UserString", "defaultdict", "deque", "namedtuple"] + +_S = TypeVar("_S") +_T = TypeVar("_T") +_T1 = TypeVar("_T1") +_T2 = TypeVar("_T2") +_KT = TypeVar("_KT") +_VT = TypeVar("_VT") +_KT_co = TypeVar("_KT_co", covariant=True) +_VT_co = TypeVar("_VT_co", covariant=True) + +# namedtuple is special-cased in the type checker; the initializer is ignored. +def namedtuple( + typename: str, + field_names: str | Iterable[str], + *, + rename: bool = False, + module: str | None = None, + defaults: Iterable[Any] | None = None, +) -> type[tuple[Any, ...]]: ... + +class UserDict(MutableMapping[_KT, _VT]): + data: dict[_KT, _VT] + # __init__ should be kept roughly in line with `dict.__init__`, which has the same semantics + @overload + def __init__(self, dict: None = None, /) -> None: ... + @overload + def __init__( + self: UserDict[str, _VT], dict: None = None, /, **kwargs: _VT # pyright: ignore[reportInvalidTypeVarUse] #11780 + ) -> None: ... + @overload + def __init__(self, dict: SupportsKeysAndGetItem[_KT, _VT], /) -> None: ... + @overload + def __init__( + self: UserDict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + dict: SupportsKeysAndGetItem[str, _VT], + /, + **kwargs: _VT, + ) -> None: ... + @overload + def __init__(self, iterable: Iterable[tuple[_KT, _VT]], /) -> None: ... + @overload + def __init__( + self: UserDict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + iterable: Iterable[tuple[str, _VT]], + /, + **kwargs: _VT, + ) -> None: ... + @overload + def __init__(self: UserDict[str, str], iterable: Iterable[list[str]], /) -> None: ... + @overload + def __init__(self: UserDict[bytes, bytes], iterable: Iterable[list[bytes]], /) -> None: ... + def __len__(self) -> int: ... + def __getitem__(self, key: _KT) -> _VT: ... + def __setitem__(self, key: _KT, item: _VT) -> None: ... + def __delitem__(self, key: _KT) -> None: ... + def __iter__(self) -> Iterator[_KT]: ... + def __contains__(self, key: object) -> bool: ... + def copy(self) -> Self: ... + def __copy__(self) -> Self: ... + + # `UserDict.fromkeys` has the same semantics as `dict.fromkeys`, so should be kept in line with `dict.fromkeys`. + # TODO: Much like `dict.fromkeys`, the true signature of `UserDict.fromkeys` is inexpressible in the current type system. + # See #3800 & https://github.com/python/typing/issues/548#issuecomment-683336963. + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T], value: None = None) -> UserDict[_T, Any | None]: ... + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T], value: _S) -> UserDict[_T, _S]: ... + @overload + def __or__(self, other: UserDict[_KT, _VT] | dict[_KT, _VT]) -> Self: ... + @overload + def __or__(self, other: UserDict[_T1, _T2] | dict[_T1, _T2]) -> UserDict[_KT | _T1, _VT | _T2]: ... + @overload + def __ror__(self, other: UserDict[_KT, _VT] | dict[_KT, _VT]) -> Self: ... + @overload + def __ror__(self, other: UserDict[_T1, _T2] | dict[_T1, _T2]) -> UserDict[_KT | _T1, _VT | _T2]: ... + # UserDict.__ior__ should be kept roughly in line with MutableMapping.update() + @overload # type: ignore[misc] + def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... + @overload + def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... + if sys.version_info >= (3, 12): + @overload + def get(self, key: _KT, default: None = None) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _T) -> _VT | _T: ... + +class UserList(MutableSequence[_T]): + data: list[_T] + @overload + def __init__(self, initlist: None = None) -> None: ... + @overload + def __init__(self, initlist: Iterable[_T]) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] + def __lt__(self, other: list[_T] | UserList[_T]) -> bool: ... + def __le__(self, other: list[_T] | UserList[_T]) -> bool: ... + def __gt__(self, other: list[_T] | UserList[_T]) -> bool: ... + def __ge__(self, other: list[_T] | UserList[_T]) -> bool: ... + def __eq__(self, other: object) -> bool: ... + def __contains__(self, item: object) -> bool: ... + def __len__(self) -> int: ... + @overload + def __getitem__(self, i: SupportsIndex) -> _T: ... + @overload + def __getitem__(self, i: slice) -> Self: ... + @overload + def __setitem__(self, i: SupportsIndex, item: _T) -> None: ... + @overload + def __setitem__(self, i: slice, item: Iterable[_T]) -> None: ... + def __delitem__(self, i: SupportsIndex | slice) -> None: ... + def __add__(self, other: Iterable[_T]) -> Self: ... + def __radd__(self, other: Iterable[_T]) -> Self: ... + def __iadd__(self, other: Iterable[_T]) -> Self: ... + def __mul__(self, n: int) -> Self: ... + def __rmul__(self, n: int) -> Self: ... + def __imul__(self, n: int) -> Self: ... + def append(self, item: _T) -> None: ... + def insert(self, i: int, item: _T) -> None: ... + def pop(self, i: int = -1) -> _T: ... + def remove(self, item: _T) -> None: ... + def copy(self) -> Self: ... + def __copy__(self) -> Self: ... + def count(self, item: _T) -> int: ... + # The runtime signature is "item, *args", and the arguments are then passed + # to `list.index`. In order to give more precise types, we pretend that the + # `item` argument is positional-only. + def index(self, item: _T, start: SupportsIndex = 0, stop: SupportsIndex = sys.maxsize, /) -> int: ... + # All arguments are passed to `list.sort` at runtime, so the signature should be kept in line with `list.sort`. + @overload + def sort(self: UserList[SupportsRichComparisonT], *, key: None = None, reverse: bool = False) -> None: ... + @overload + def sort(self, *, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None: ... + def extend(self, other: Iterable[_T]) -> None: ... + +class UserString(Sequence[UserString]): + data: str + def __init__(self, seq: object) -> None: ... + def __int__(self) -> int: ... + def __float__(self) -> float: ... + def __complex__(self) -> complex: ... + def __getnewargs__(self) -> tuple[str]: ... + def __lt__(self, string: str | UserString) -> bool: ... + def __le__(self, string: str | UserString) -> bool: ... + def __gt__(self, string: str | UserString) -> bool: ... + def __ge__(self, string: str | UserString) -> bool: ... + def __eq__(self, string: object) -> bool: ... + def __hash__(self) -> int: ... + def __contains__(self, char: object) -> bool: ... + def __len__(self) -> int: ... + def __getitem__(self, index: SupportsIndex | slice) -> Self: ... + def __iter__(self) -> Iterator[Self]: ... + def __reversed__(self) -> Iterator[Self]: ... + def __add__(self, other: object) -> Self: ... + def __radd__(self, other: object) -> Self: ... + def __mul__(self, n: int) -> Self: ... + def __rmul__(self, n: int) -> Self: ... + def __mod__(self, args: Any) -> Self: ... + def __rmod__(self, template: object) -> Self: ... + def capitalize(self) -> Self: ... + def casefold(self) -> Self: ... + def center(self, width: int, *args: Any) -> Self: ... + def count(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... + def encode(self: UserString, encoding: str | None = "utf-8", errors: str | None = "strict") -> bytes: ... + def endswith(self, suffix: str | tuple[str, ...], start: int | None = 0, end: int | None = sys.maxsize) -> bool: ... + def expandtabs(self, tabsize: int = 8) -> Self: ... + def find(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... + def format(self, *args: Any, **kwds: Any) -> str: ... + def format_map(self, mapping: Mapping[str, Any]) -> str: ... + def index(self, sub: str, start: int = 0, end: int = sys.maxsize) -> int: ... + def isalpha(self) -> bool: ... + def isalnum(self) -> bool: ... + def isdecimal(self) -> bool: ... + def isdigit(self) -> bool: ... + def isidentifier(self) -> bool: ... + def islower(self) -> bool: ... + def isnumeric(self) -> bool: ... + def isprintable(self) -> bool: ... + def isspace(self) -> bool: ... + def istitle(self) -> bool: ... + def isupper(self) -> bool: ... + def isascii(self) -> bool: ... + def join(self, seq: Iterable[str]) -> str: ... + def ljust(self, width: int, *args: Any) -> Self: ... + def lower(self) -> Self: ... + def lstrip(self, chars: str | None = None) -> Self: ... + maketrans = str.maketrans + def partition(self, sep: str) -> tuple[str, str, str]: ... + def removeprefix(self, prefix: str | UserString, /) -> Self: ... + def removesuffix(self, suffix: str | UserString, /) -> Self: ... + def replace(self, old: str | UserString, new: str | UserString, maxsplit: int = -1) -> Self: ... + def rfind(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... + def rindex(self, sub: str | UserString, start: int = 0, end: int = sys.maxsize) -> int: ... + def rjust(self, width: int, *args: Any) -> Self: ... + def rpartition(self, sep: str) -> tuple[str, str, str]: ... + def rstrip(self, chars: str | None = None) -> Self: ... + def split(self, sep: str | None = None, maxsplit: int = -1) -> list[str]: ... + def rsplit(self, sep: str | None = None, maxsplit: int = -1) -> list[str]: ... + def splitlines(self, keepends: bool = False) -> list[str]: ... + def startswith(self, prefix: str | tuple[str, ...], start: int | None = 0, end: int | None = sys.maxsize) -> bool: ... + def strip(self, chars: str | None = None) -> Self: ... + def swapcase(self) -> Self: ... + def title(self) -> Self: ... + def translate(self, *args: Any) -> Self: ... + def upper(self) -> Self: ... + def zfill(self, width: int) -> Self: ... + +class deque(MutableSequence[_T]): + @property + def maxlen(self) -> int | None: ... + @overload + def __init__(self, *, maxlen: int | None = None) -> None: ... + @overload + def __init__(self, iterable: Iterable[_T], maxlen: int | None = None) -> None: ... + def append(self, x: _T, /) -> None: ... + def appendleft(self, x: _T, /) -> None: ... + def copy(self) -> Self: ... + def count(self, x: _T, /) -> int: ... + def extend(self, iterable: Iterable[_T], /) -> None: ... + def extendleft(self, iterable: Iterable[_T], /) -> None: ... + def insert(self, i: int, x: _T, /) -> None: ... + def index(self, x: _T, start: int = 0, stop: int = ..., /) -> int: ... + def pop(self) -> _T: ... # type: ignore[override] + def popleft(self) -> _T: ... + def remove(self, value: _T, /) -> None: ... + def rotate(self, n: int = 1, /) -> None: ... + def __copy__(self) -> Self: ... + def __len__(self) -> int: ... + __hash__: ClassVar[None] # type: ignore[assignment] + # These methods of deque don't take slices, unlike MutableSequence, hence the type: ignores + def __getitem__(self, key: SupportsIndex, /) -> _T: ... # type: ignore[override] + def __setitem__(self, key: SupportsIndex, value: _T, /) -> None: ... # type: ignore[override] + def __delitem__(self, key: SupportsIndex, /) -> None: ... # type: ignore[override] + def __contains__(self, key: object, /) -> bool: ... + def __reduce__(self) -> tuple[type[Self], tuple[()], None, Iterator[_T]]: ... + def __iadd__(self, value: Iterable[_T], /) -> Self: ... + def __add__(self, value: Self, /) -> Self: ... + def __mul__(self, value: int, /) -> Self: ... + def __imul__(self, value: int, /) -> Self: ... + def __lt__(self, value: deque[_T], /) -> bool: ... + def __le__(self, value: deque[_T], /) -> bool: ... + def __gt__(self, value: deque[_T], /) -> bool: ... + def __ge__(self, value: deque[_T], /) -> bool: ... + def __eq__(self, value: object, /) -> bool: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +class Counter(dict[_T, int], Generic[_T]): + @overload + def __init__(self, iterable: None = None, /) -> None: ... + @overload + def __init__(self: Counter[str], iterable: None = None, /, **kwargs: int) -> None: ... + @overload + def __init__(self, mapping: SupportsKeysAndGetItem[_T, int], /) -> None: ... + @overload + def __init__(self, iterable: Iterable[_T], /) -> None: ... + def copy(self) -> Self: ... + def elements(self) -> Iterator[_T]: ... + def most_common(self, n: int | None = None) -> list[tuple[_T, int]]: ... + @classmethod + def fromkeys(cls, iterable: Any, v: int | None = None) -> NoReturn: ... # type: ignore[override] + @overload + def subtract(self, iterable: None = None, /) -> None: ... + @overload + def subtract(self, mapping: Mapping[_T, int], /) -> None: ... + @overload + def subtract(self, iterable: Iterable[_T], /) -> None: ... + # Unlike dict.update(), use Mapping instead of SupportsKeysAndGetItem for the first overload + # (source code does an `isinstance(other, Mapping)` check) + # + # The second overload is also deliberately different to dict.update() + # (if it were `Iterable[_T] | Iterable[tuple[_T, int]]`, + # the tuples would be added as keys, breaking type safety) + @overload # type: ignore[override] + def update(self, m: Mapping[_T, int], /, **kwargs: int) -> None: ... + @overload + def update(self, iterable: Iterable[_T], /, **kwargs: int) -> None: ... + @overload + def update(self, iterable: None = None, /, **kwargs: int) -> None: ... + def __missing__(self, key: _T) -> int: ... + def __delitem__(self, elem: object) -> None: ... + if sys.version_info >= (3, 10): + def __eq__(self, other: object) -> bool: ... + def __ne__(self, other: object) -> bool: ... + + def __add__(self, other: Counter[_S]) -> Counter[_T | _S]: ... + def __sub__(self, other: Counter[_T]) -> Counter[_T]: ... + def __and__(self, other: Counter[_T]) -> Counter[_T]: ... + def __or__(self, other: Counter[_S]) -> Counter[_T | _S]: ... # type: ignore[override] + def __pos__(self) -> Counter[_T]: ... + def __neg__(self) -> Counter[_T]: ... + # several type: ignores because __iadd__ is supposedly incompatible with __add__, etc. + def __iadd__(self, other: SupportsItems[_T, int]) -> Self: ... # type: ignore[misc] + def __isub__(self, other: SupportsItems[_T, int]) -> Self: ... + def __iand__(self, other: SupportsItems[_T, int]) -> Self: ... + def __ior__(self, other: SupportsItems[_T, int]) -> Self: ... # type: ignore[override,misc] + if sys.version_info >= (3, 10): + def total(self) -> int: ... + def __le__(self, other: Counter[Any]) -> bool: ... + def __lt__(self, other: Counter[Any]) -> bool: ... + def __ge__(self, other: Counter[Any]) -> bool: ... + def __gt__(self, other: Counter[Any]) -> bool: ... + +# The pure-Python implementations of the "views" classes +# These are exposed at runtime in `collections/__init__.py` +class _OrderedDictKeysView(KeysView[_KT_co]): + def __reversed__(self) -> Iterator[_KT_co]: ... + +class _OrderedDictItemsView(ItemsView[_KT_co, _VT_co]): + def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... + +class _OrderedDictValuesView(ValuesView[_VT_co]): + def __reversed__(self) -> Iterator[_VT_co]: ... + +# The C implementations of the "views" classes +# (At runtime, these are called `odict_keys`, `odict_items` and `odict_values`, +# but they are not exposed anywhere) +# pyright doesn't have a specific error code for subclassing error! +@final +class _odict_keys(dict_keys[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __reversed__(self) -> Iterator[_KT_co]: ... + +@final +class _odict_items(dict_items[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... + +@final +class _odict_values(dict_values[_KT_co, _VT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __reversed__(self) -> Iterator[_VT_co]: ... + +class OrderedDict(dict[_KT, _VT]): + def popitem(self, last: bool = True) -> tuple[_KT, _VT]: ... + def move_to_end(self, key: _KT, last: bool = True) -> None: ... + def copy(self) -> Self: ... + def __reversed__(self) -> Iterator[_KT]: ... + def keys(self) -> _odict_keys[_KT, _VT]: ... + def items(self) -> _odict_items[_KT, _VT]: ... + def values(self) -> _odict_values[_KT, _VT]: ... + # The signature of OrderedDict.fromkeys should be kept in line with `dict.fromkeys`, modulo positional-only differences. + # Like dict.fromkeys, its true signature is not expressible in the current type system. + # See #3800 & https://github.com/python/typing/issues/548#issuecomment-683336963. + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T], value: None = None) -> OrderedDict[_T, Any | None]: ... + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T], value: _S) -> OrderedDict[_T, _S]: ... + # Keep OrderedDict.setdefault in line with MutableMapping.setdefault, modulo positional-only differences. + @overload + def setdefault(self: OrderedDict[_KT, _T | None], key: _KT, default: None = None) -> _T | None: ... + @overload + def setdefault(self, key: _KT, default: _VT) -> _VT: ... + # Same as dict.pop, but accepts keyword arguments + @overload + def pop(self, key: _KT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T) -> _VT | _T: ... + def __eq__(self, value: object, /) -> bool: ... + @overload + def __or__(self, value: dict[_KT, _VT], /) -> Self: ... + @overload + def __or__(self, value: dict[_T1, _T2], /) -> OrderedDict[_KT | _T1, _VT | _T2]: ... + @overload + def __ror__(self, value: dict[_KT, _VT], /) -> Self: ... + @overload + def __ror__(self, value: dict[_T1, _T2], /) -> OrderedDict[_KT | _T1, _VT | _T2]: ... # type: ignore[misc] + +class defaultdict(dict[_KT, _VT]): + default_factory: Callable[[], _VT] | None + @overload + def __init__(self) -> None: ... + @overload + def __init__(self: defaultdict[str, _VT], **kwargs: _VT) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] #11780 + @overload + def __init__(self, default_factory: Callable[[], _VT] | None, /) -> None: ... + @overload + def __init__( + self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + default_factory: Callable[[], _VT] | None, + /, + **kwargs: _VT, + ) -> None: ... + @overload + def __init__(self, default_factory: Callable[[], _VT] | None, map: SupportsKeysAndGetItem[_KT, _VT], /) -> None: ... + @overload + def __init__( + self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + default_factory: Callable[[], _VT] | None, + map: SupportsKeysAndGetItem[str, _VT], + /, + **kwargs: _VT, + ) -> None: ... + @overload + def __init__(self, default_factory: Callable[[], _VT] | None, iterable: Iterable[tuple[_KT, _VT]], /) -> None: ... + @overload + def __init__( + self: defaultdict[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + default_factory: Callable[[], _VT] | None, + iterable: Iterable[tuple[str, _VT]], + /, + **kwargs: _VT, + ) -> None: ... + def __missing__(self, key: _KT, /) -> _VT: ... + def __copy__(self) -> Self: ... + def copy(self) -> Self: ... + @overload + def __or__(self, value: dict[_KT, _VT], /) -> Self: ... + @overload + def __or__(self, value: dict[_T1, _T2], /) -> defaultdict[_KT | _T1, _VT | _T2]: ... + @overload + def __ror__(self, value: dict[_KT, _VT], /) -> Self: ... + @overload + def __ror__(self, value: dict[_T1, _T2], /) -> defaultdict[_KT | _T1, _VT | _T2]: ... # type: ignore[misc] + +class ChainMap(MutableMapping[_KT, _VT]): + maps: list[MutableMapping[_KT, _VT]] + def __init__(self, *maps: MutableMapping[_KT, _VT]) -> None: ... + def new_child(self, m: MutableMapping[_KT, _VT] | None = None) -> Self: ... + @property + def parents(self) -> Self: ... + def __setitem__(self, key: _KT, value: _VT) -> None: ... + def __delitem__(self, key: _KT) -> None: ... + def __getitem__(self, key: _KT) -> _VT: ... + def __iter__(self) -> Iterator[_KT]: ... + def __len__(self) -> int: ... + def __contains__(self, key: object) -> bool: ... + @overload + def get(self, key: _KT, default: None = None) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _T) -> _VT | _T: ... + def __missing__(self, key: _KT) -> _VT: ... # undocumented + def __bool__(self) -> bool: ... + # Keep ChainMap.setdefault in line with MutableMapping.setdefault, modulo positional-only differences. + @overload + def setdefault(self: ChainMap[_KT, _T | None], key: _KT, default: None = None) -> _T | None: ... + @overload + def setdefault(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T) -> _VT | _T: ... + def copy(self) -> Self: ... + __copy__ = copy + # All arguments to `fromkeys` are passed to `dict.fromkeys` at runtime, + # so the signature should be kept in line with `dict.fromkeys`. + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T]) -> ChainMap[_T, Any | None]: ... + @classmethod + @overload + # Special-case None: the user probably wants to add non-None values later. + def fromkeys(cls, iterable: Iterable[_T], value: None, /) -> ChainMap[_T, Any | None]: ... + @classmethod + @overload + def fromkeys(cls, iterable: Iterable[_T], value: _S, /) -> ChainMap[_T, _S]: ... + @overload + def __or__(self, other: Mapping[_KT, _VT]) -> Self: ... + @overload + def __or__(self, other: Mapping[_T1, _T2]) -> ChainMap[_KT | _T1, _VT | _T2]: ... + @overload + def __ror__(self, other: Mapping[_KT, _VT]) -> Self: ... + @overload + def __ror__(self, other: Mapping[_T1, _T2]) -> ChainMap[_KT | _T1, _VT | _T2]: ... + # ChainMap.__ior__ should be kept roughly in line with MutableMapping.update() + @overload # type: ignore[misc] + def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... + @overload + def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/collections/abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/collections/abc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/collections/abc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/collections/abc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/colorsys.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/colorsys.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/colorsys.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/colorsys.pyi index 443ee828ebfe7..7842f80284ef4 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/colorsys.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/colorsys.pyi @@ -7,7 +7,7 @@ def hls_to_rgb(h: float, l: float, s: float) -> tuple[float, float, float]: ... def rgb_to_hsv(r: float, g: float, b: float) -> tuple[float, float, float]: ... def hsv_to_rgb(h: float, s: float, v: float) -> tuple[float, float, float]: ... -# TODO undocumented +# TODO: undocumented ONE_SIXTH: float ONE_THIRD: float TWO_THIRD: float diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/compileall.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compileall.pyi similarity index 76% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/compileall.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/compileall.pyi index 9fb3608f2979b..a599b1b235402 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/compileall.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compileall.pyi @@ -25,7 +25,7 @@ if sys.version_info >= (3, 10): prependdir: StrPath | None = None, limit_sl_dest: StrPath | None = None, hardlink_dupes: bool = False, - ) -> int: ... + ) -> bool: ... def compile_file( fullname: StrPath, ddir: StrPath | None = None, @@ -40,9 +40,9 @@ if sys.version_info >= (3, 10): prependdir: StrPath | None = None, limit_sl_dest: StrPath | None = None, hardlink_dupes: bool = False, - ) -> int: ... + ) -> bool: ... -elif sys.version_info >= (3, 9): +else: def compile_dir( dir: StrPath, maxlevels: int | None = None, @@ -59,7 +59,7 @@ elif sys.version_info >= (3, 9): prependdir: StrPath | None = None, limit_sl_dest: StrPath | None = None, hardlink_dupes: bool = False, - ) -> int: ... + ) -> bool: ... def compile_file( fullname: StrPath, ddir: StrPath | None = None, @@ -74,31 +74,7 @@ elif sys.version_info >= (3, 9): prependdir: StrPath | None = None, limit_sl_dest: StrPath | None = None, hardlink_dupes: bool = False, - ) -> int: ... - -else: - def compile_dir( - dir: StrPath, - maxlevels: int = 10, - ddir: StrPath | None = None, - force: bool = False, - rx: _SupportsSearch | None = None, - quiet: int = 0, - legacy: bool = False, - optimize: int = -1, - workers: int = 1, - invalidation_mode: PycInvalidationMode | None = None, - ) -> int: ... - def compile_file( - fullname: StrPath, - ddir: StrPath | None = None, - force: bool = False, - rx: _SupportsSearch | None = None, - quiet: int = 0, - legacy: bool = False, - optimize: int = -1, - invalidation_mode: PycInvalidationMode | None = None, - ) -> int: ... + ) -> bool: ... def compile_path( skip_curdir: bool = ..., @@ -108,4 +84,4 @@ def compile_path( legacy: bool = False, optimize: int = -1, invalidation_mode: PycInvalidationMode | None = None, -) -> int: ... +) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/compression/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/_common/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/compression/_common/__init__.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/compression/_common/_streams.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/_common/_streams.pyi new file mode 100644 index 0000000000000..6303a9b1d460c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compression/_common/_streams.pyi @@ -0,0 +1,25 @@ +from _typeshed import Incomplete, WriteableBuffer +from collections.abc import Callable +from io import DEFAULT_BUFFER_SIZE, BufferedIOBase, RawIOBase +from typing import Any, Protocol + +BUFFER_SIZE = DEFAULT_BUFFER_SIZE + +class _Reader(Protocol): + def read(self, n: int, /) -> bytes: ... + def seekable(self) -> bool: ... + def seek(self, n: int, /) -> Any: ... + +class BaseStream(BufferedIOBase): ... + +class DecompressReader(RawIOBase): + def __init__( + self, + fp: _Reader, + decomp_factory: Callable[..., Incomplete], # Consider backporting changes to _compression + trailing_error: type[Exception] | tuple[type[Exception], ...] = (), + **decomp_args: Any, # These are passed to decomp_factory. + ) -> None: ... + def readinto(self, b: WriteableBuffer) -> int: ... + def read(self, size: int = -1) -> bytes: ... + def seek(self, offset: int, whence: int = 0) -> int: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/compression/bz2/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/bz2/__init__.pyi new file mode 100644 index 0000000000000..9ddc39f27c286 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compression/bz2/__init__.pyi @@ -0,0 +1 @@ +from bz2 import * diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/compression/gzip/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/gzip/__init__.pyi new file mode 100644 index 0000000000000..9422a735c590e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compression/gzip/__init__.pyi @@ -0,0 +1 @@ +from gzip import * diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/compression/lzma/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/lzma/__init__.pyi new file mode 100644 index 0000000000000..936c3813db4f1 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compression/lzma/__init__.pyi @@ -0,0 +1 @@ +from lzma import * diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/compression/zlib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/compression/zlib/__init__.pyi new file mode 100644 index 0000000000000..78d176c03ee83 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/compression/zlib/__init__.pyi @@ -0,0 +1 @@ +from zlib import * diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/concurrent/__init__.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi new file mode 100644 index 0000000000000..dd1f6da80c4d6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/__init__.pyi @@ -0,0 +1,71 @@ +import sys + +from ._base import ( + ALL_COMPLETED as ALL_COMPLETED, + FIRST_COMPLETED as FIRST_COMPLETED, + FIRST_EXCEPTION as FIRST_EXCEPTION, + BrokenExecutor as BrokenExecutor, + CancelledError as CancelledError, + Executor as Executor, + Future as Future, + InvalidStateError as InvalidStateError, + TimeoutError as TimeoutError, + as_completed as as_completed, + wait as wait, +) +from .process import ProcessPoolExecutor as ProcessPoolExecutor +from .thread import ThreadPoolExecutor as ThreadPoolExecutor + +if sys.version_info >= (3, 14): + from .interpreter import InterpreterPoolExecutor as InterpreterPoolExecutor + + __all__ = ( + "FIRST_COMPLETED", + "FIRST_EXCEPTION", + "ALL_COMPLETED", + "CancelledError", + "TimeoutError", + "InvalidStateError", + "BrokenExecutor", + "Future", + "Executor", + "wait", + "as_completed", + "ProcessPoolExecutor", + "ThreadPoolExecutor", + "InterpreterPoolExecutor", + ) + +elif sys.version_info >= (3, 13): + __all__ = ( + "FIRST_COMPLETED", + "FIRST_EXCEPTION", + "ALL_COMPLETED", + "CancelledError", + "TimeoutError", + "InvalidStateError", + "BrokenExecutor", + "Future", + "Executor", + "wait", + "as_completed", + "ProcessPoolExecutor", + "ThreadPoolExecutor", + ) +else: + __all__ = ( + "FIRST_COMPLETED", + "FIRST_EXCEPTION", + "ALL_COMPLETED", + "CancelledError", + "TimeoutError", + "BrokenExecutor", + "Future", + "Executor", + "wait", + "as_completed", + "ProcessPoolExecutor", + "ThreadPoolExecutor", + ) + +def __dir__() -> tuple[str, ...]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi new file mode 100644 index 0000000000000..fbf07a3fc78f9 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/_base.pyi @@ -0,0 +1,119 @@ +import sys +import threading +from _typeshed import Unused +from collections.abc import Callable, Iterable, Iterator +from logging import Logger +from types import GenericAlias, TracebackType +from typing import Any, Final, Generic, NamedTuple, Protocol, TypeVar +from typing_extensions import ParamSpec, Self + +FIRST_COMPLETED: Final = "FIRST_COMPLETED" +FIRST_EXCEPTION: Final = "FIRST_EXCEPTION" +ALL_COMPLETED: Final = "ALL_COMPLETED" +PENDING: Final = "PENDING" +RUNNING: Final = "RUNNING" +CANCELLED: Final = "CANCELLED" +CANCELLED_AND_NOTIFIED: Final = "CANCELLED_AND_NOTIFIED" +FINISHED: Final = "FINISHED" +_FUTURE_STATES: list[str] +_STATE_TO_DESCRIPTION_MAP: dict[str, str] +LOGGER: Logger + +class Error(Exception): ... +class CancelledError(Error): ... + +if sys.version_info >= (3, 11): + from builtins import TimeoutError as TimeoutError +else: + class TimeoutError(Error): ... + +class InvalidStateError(Error): ... +class BrokenExecutor(RuntimeError): ... + +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) +_P = ParamSpec("_P") + +class Future(Generic[_T]): + _condition: threading.Condition + _state: str + _result: _T | None + _exception: BaseException | None + _waiters: list[_Waiter] + def cancel(self) -> bool: ... + def cancelled(self) -> bool: ... + def running(self) -> bool: ... + def done(self) -> bool: ... + def add_done_callback(self, fn: Callable[[Future[_T]], object]) -> None: ... + def result(self, timeout: float | None = None) -> _T: ... + def set_running_or_notify_cancel(self) -> bool: ... + def set_result(self, result: _T) -> None: ... + def exception(self, timeout: float | None = None) -> BaseException | None: ... + def set_exception(self, exception: BaseException | None) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +class Executor: + def submit(self, fn: Callable[_P, _T], /, *args: _P.args, **kwargs: _P.kwargs) -> Future[_T]: ... + if sys.version_info >= (3, 14): + def map( + self, + fn: Callable[..., _T], + *iterables: Iterable[Any], + timeout: float | None = None, + chunksize: int = 1, + buffersize: int | None = None, + ) -> Iterator[_T]: ... + else: + def map( + self, fn: Callable[..., _T], *iterables: Iterable[Any], timeout: float | None = None, chunksize: int = 1 + ) -> Iterator[_T]: ... + + def shutdown(self, wait: bool = True, *, cancel_futures: bool = False) -> None: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> bool | None: ... + +class _AsCompletedFuture(Protocol[_T_co]): + # as_completed only mutates non-generic aspects of passed Futures and does not do any nominal + # checks. Therefore, we can use a Protocol here to allow as_completed to act covariantly. + # See the tests for concurrent.futures + _condition: threading.Condition + _state: str + _waiters: list[_Waiter] + # Not used by as_completed, but needed to propagate the generic type + def result(self, timeout: float | None = None) -> _T_co: ... + +def as_completed(fs: Iterable[_AsCompletedFuture[_T]], timeout: float | None = None) -> Iterator[Future[_T]]: ... + +class DoneAndNotDoneFutures(NamedTuple, Generic[_T]): + done: set[Future[_T]] + not_done: set[Future[_T]] + +def wait( + fs: Iterable[Future[_T]], timeout: float | None = None, return_when: str = "ALL_COMPLETED" +) -> DoneAndNotDoneFutures[_T]: ... + +class _Waiter: + event: threading.Event + finished_futures: list[Future[Any]] + def add_result(self, future: Future[Any]) -> None: ... + def add_exception(self, future: Future[Any]) -> None: ... + def add_cancelled(self, future: Future[Any]) -> None: ... + +class _AsCompletedWaiter(_Waiter): + lock: threading.Lock + +class _FirstCompletedWaiter(_Waiter): ... + +class _AllCompletedWaiter(_Waiter): + num_pending_calls: int + stop_on_exception: bool + lock: threading.Lock + def __init__(self, num_pending_calls: int, stop_on_exception: bool) -> None: ... + +class _AcquireFutures: + futures: Iterable[Future[Any]] + def __init__(self, futures: Iterable[Future[Any]]) -> None: ... + def __enter__(self) -> None: ... + def __exit__(self, *args: Unused) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/interpreter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/interpreter.pyi new file mode 100644 index 0000000000000..c1a29e6b05521 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/interpreter.pyi @@ -0,0 +1,102 @@ +import sys +from collections.abc import Callable, Mapping +from concurrent.futures import ThreadPoolExecutor +from typing import Final, Literal, Protocol, overload, type_check_only +from typing_extensions import ParamSpec, Self, TypeAlias, TypeVar, TypeVarTuple, Unpack + +_Task: TypeAlias = tuple[bytes, Literal["function", "script"]] + +@type_check_only +class _TaskFunc(Protocol): + @overload + def __call__(self, fn: Callable[_P, _R], *args: _P.args, **kwargs: _P.kwargs) -> tuple[bytes, Literal["function"]]: ... + @overload + def __call__(self, fn: str) -> tuple[bytes, Literal["script"]]: ... + +_Ts = TypeVarTuple("_Ts") +_P = ParamSpec("_P") +_R = TypeVar("_R") + +# A `type.simplenamespace` with `__name__` attribute. +@type_check_only +class _HasName(Protocol): + __name__: str + +# `_interpreters.exec` technically gives us a simple namespace. +@type_check_only +class _ExcInfo(Protocol): + formatted: str + msg: str + type: _HasName + +if sys.version_info >= (3, 14): + from concurrent.futures.thread import BrokenThreadPool, WorkerContext as ThreadWorkerContext + + from _interpreters import InterpreterError + + class ExecutionFailed(InterpreterError): + def __init__(self, excinfo: _ExcInfo) -> None: ... # type: ignore[override] + + UNBOUND: Final = 2 + + class WorkerContext(ThreadWorkerContext): + # Parent class doesn't have `shared` argument, + @overload # type: ignore[override] + @classmethod + def prepare( + cls, initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]], shared: Mapping[str, object] + ) -> tuple[Callable[[], Self], _TaskFunc]: ... + @overload # type: ignore[override] + @classmethod + def prepare( + cls, initializer: Callable[[], object], initargs: tuple[()], shared: Mapping[str, object] + ) -> tuple[Callable[[], Self], _TaskFunc]: ... + def __init__( + self, initdata: tuple[bytes, Literal["function", "script"]], shared: Mapping[str, object] | None = None + ) -> None: ... # type: ignore[override] + def __del__(self) -> None: ... + def run(self, task: _Task) -> None: ... # type: ignore[override] + + class BrokenInterpreterPool(BrokenThreadPool): ... + + class InterpreterPoolExecutor(ThreadPoolExecutor): + BROKEN: type[BrokenInterpreterPool] + + @overload # type: ignore[override] + @classmethod + def prepare_context( + cls, initializer: Callable[[], object], initargs: tuple[()], shared: Mapping[str, object] + ) -> tuple[Callable[[], WorkerContext], _TaskFunc]: ... + @overload # type: ignore[override] + @classmethod + def prepare_context( + cls, initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]], shared: Mapping[str, object] + ) -> tuple[Callable[[], WorkerContext], _TaskFunc]: ... + @overload + def __init__( + self, + max_workers: int | None = None, + thread_name_prefix: str = "", + initializer: Callable[[], object] | None = None, + initargs: tuple[()] = (), + shared: Mapping[str, object] | None = None, + ) -> None: ... + @overload + def __init__( + self, + max_workers: int | None = None, + thread_name_prefix: str = "", + *, + initializer: Callable[[Unpack[_Ts]], object], + initargs: tuple[Unpack[_Ts]], + shared: Mapping[str, object] | None = None, + ) -> None: ... + @overload + def __init__( + self, + max_workers: int | None, + thread_name_prefix: str, + initializer: Callable[[Unpack[_Ts]], object], + initargs: tuple[Unpack[_Ts]], + shared: Mapping[str, object] | None = None, + ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi index a1de3d679b236..607990100369e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/process.pyi @@ -72,21 +72,27 @@ class _CallItem: class _SafeQueue(Queue[Future[Any]]): pending_work_items: dict[int, _WorkItem[Any]] - shutdown_lock: Lock + if sys.version_info < (3, 12): + shutdown_lock: Lock thread_wakeup: _ThreadWakeup - if sys.version_info >= (3, 9): + if sys.version_info >= (3, 12): def __init__( self, max_size: int | None = 0, *, ctx: BaseContext, pending_work_items: dict[int, _WorkItem[Any]], - shutdown_lock: Lock, thread_wakeup: _ThreadWakeup, ) -> None: ... else: def __init__( - self, max_size: int | None = 0, *, ctx: BaseContext, pending_work_items: dict[int, _WorkItem[Any]] + self, + max_size: int | None = 0, + *, + ctx: BaseContext, + pending_work_items: dict[int, _WorkItem[Any]], + shutdown_lock: Lock, + thread_wakeup: _ThreadWakeup, ) -> None: ... def _on_queue_feeder_error(self, e: Exception, obj: _CallItem) -> None: ... @@ -125,27 +131,26 @@ else: initargs: tuple[Unpack[_Ts]], ) -> None: ... -if sys.version_info >= (3, 9): - class _ExecutorManagerThread(Thread): - thread_wakeup: _ThreadWakeup - shutdown_lock: Lock - executor_reference: ref[Any] - processes: MutableMapping[int, Process] - call_queue: Queue[_CallItem] - result_queue: SimpleQueue[_ResultItem] - work_ids_queue: Queue[int] - pending_work_items: dict[int, _WorkItem[Any]] - def __init__(self, executor: ProcessPoolExecutor) -> None: ... - def run(self) -> None: ... - def add_call_item_to_queue(self) -> None: ... - def wait_result_broken_or_wakeup(self) -> tuple[Any, bool, str]: ... - def process_result_item(self, result_item: int | _ResultItem) -> None: ... - def is_shutting_down(self) -> bool: ... - def terminate_broken(self, cause: str) -> None: ... - def flag_executor_shutting_down(self) -> None: ... - def shutdown_workers(self) -> None: ... - def join_executor_internals(self) -> None: ... - def get_n_children_alive(self) -> int: ... +class _ExecutorManagerThread(Thread): + thread_wakeup: _ThreadWakeup + shutdown_lock: Lock + executor_reference: ref[Any] + processes: MutableMapping[int, Process] + call_queue: Queue[_CallItem] + result_queue: SimpleQueue[_ResultItem] + work_ids_queue: Queue[int] + pending_work_items: dict[int, _WorkItem[Any]] + def __init__(self, executor: ProcessPoolExecutor) -> None: ... + def run(self) -> None: ... + def add_call_item_to_queue(self) -> None: ... + def wait_result_broken_or_wakeup(self) -> tuple[Any, bool, str]: ... + def process_result_item(self, result_item: int | _ResultItem) -> None: ... + def is_shutting_down(self) -> bool: ... + def terminate_broken(self, cause: str) -> None: ... + def flag_executor_shutting_down(self) -> None: ... + def shutdown_workers(self) -> None: ... + def join_executor_internals(self) -> None: ... + def get_n_children_alive(self) -> int: ... _system_limits_checked: bool _system_limited: bool | None @@ -228,7 +233,10 @@ class ProcessPoolExecutor(Executor): initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]], ) -> None: ... - if sys.version_info >= (3, 9): - def _start_executor_manager_thread(self) -> None: ... + def _start_executor_manager_thread(self) -> None: ... def _adjust_process_count(self) -> None: ... + + if sys.version_info >= (3, 14): + def kill_workers(self) -> None: ... + def terminate_workers(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi new file mode 100644 index 0000000000000..22df0dca5a3fd --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/concurrent/futures/thread.pyi @@ -0,0 +1,136 @@ +import queue +import sys +from collections.abc import Callable, Iterable, Mapping, Set as AbstractSet +from threading import Lock, Semaphore, Thread +from types import GenericAlias +from typing import Any, Generic, Protocol, TypeVar, overload, type_check_only +from typing_extensions import Self, TypeAlias, TypeVarTuple, Unpack +from weakref import ref + +from ._base import BrokenExecutor, Executor, Future + +_Ts = TypeVarTuple("_Ts") + +_threads_queues: Mapping[Any, Any] +_shutdown: bool +_global_shutdown_lock: Lock + +def _python_exit() -> None: ... + +_S = TypeVar("_S") + +_Task: TypeAlias = tuple[Callable[..., Any], tuple[Any, ...], dict[str, Any]] + +_C = TypeVar("_C", bound=Callable[..., object]) +_KT = TypeVar("_KT", bound=str) +_VT = TypeVar("_VT") + +@type_check_only +class _ResolveTaskFunc(Protocol): + def __call__( + self, func: _C, args: tuple[Unpack[_Ts]], kwargs: dict[_KT, _VT] + ) -> tuple[_C, tuple[Unpack[_Ts]], dict[_KT, _VT]]: ... + +if sys.version_info >= (3, 14): + class WorkerContext: + @overload + @classmethod + def prepare( + cls, initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]] + ) -> tuple[Callable[[], Self], _ResolveTaskFunc]: ... + @overload + @classmethod + def prepare( + cls, initializer: Callable[[], object], initargs: tuple[()] + ) -> tuple[Callable[[], Self], _ResolveTaskFunc]: ... + @overload + def __init__(self, initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]]) -> None: ... + @overload + def __init__(self, initializer: Callable[[], object], initargs: tuple[()]) -> None: ... + def initialize(self) -> None: ... + def finalize(self) -> None: ... + def run(self, task: _Task) -> None: ... + +if sys.version_info >= (3, 14): + class _WorkItem(Generic[_S]): + future: Future[Any] + task: _Task + def __init__(self, future: Future[Any], task: _Task) -> None: ... + def run(self, ctx: WorkerContext) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + + def _worker(executor_reference: ref[Any], ctx: WorkerContext, work_queue: queue.SimpleQueue[Any]) -> None: ... + +else: + class _WorkItem(Generic[_S]): + future: Future[_S] + fn: Callable[..., _S] + args: Iterable[Any] + kwargs: Mapping[str, Any] + def __init__(self, future: Future[_S], fn: Callable[..., _S], args: Iterable[Any], kwargs: Mapping[str, Any]) -> None: ... + def run(self) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + + def _worker( + executor_reference: ref[Any], + work_queue: queue.SimpleQueue[Any], + initializer: Callable[[Unpack[_Ts]], object], + initargs: tuple[Unpack[_Ts]], + ) -> None: ... + +class BrokenThreadPool(BrokenExecutor): ... + +class ThreadPoolExecutor(Executor): + if sys.version_info >= (3, 14): + BROKEN: type[BrokenThreadPool] + + _max_workers: int + _idle_semaphore: Semaphore + _threads: AbstractSet[Thread] + _broken: bool + _shutdown: bool + _shutdown_lock: Lock + _thread_name_prefix: str | None + _initializer: Callable[..., None] | None + _initargs: tuple[Any, ...] + _work_queue: queue.SimpleQueue[_WorkItem[Any]] + + if sys.version_info >= (3, 14): + @overload + @classmethod + def prepare_context( + cls, initializer: Callable[[], object], initargs: tuple[()] + ) -> tuple[Callable[[], Self], _ResolveTaskFunc]: ... + @overload + @classmethod + def prepare_context( + cls, initializer: Callable[[Unpack[_Ts]], object], initargs: tuple[Unpack[_Ts]] + ) -> tuple[Callable[[], Self], _ResolveTaskFunc]: ... + + @overload + def __init__( + self, + max_workers: int | None = None, + thread_name_prefix: str = "", + initializer: Callable[[], object] | None = None, + initargs: tuple[()] = (), + ) -> None: ... + @overload + def __init__( + self, + max_workers: int | None = None, + thread_name_prefix: str = "", + *, + initializer: Callable[[Unpack[_Ts]], object], + initargs: tuple[Unpack[_Ts]], + ) -> None: ... + @overload + def __init__( + self, + max_workers: int | None, + thread_name_prefix: str, + initializer: Callable[[Unpack[_Ts]], object], + initargs: tuple[Unpack[_Ts]], + ) -> None: ... + def _adjust_thread_count(self) -> None: ... + def _initializer_failed(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/configparser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/configparser.pyi new file mode 100644 index 0000000000000..15c564c025897 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/configparser.pyi @@ -0,0 +1,464 @@ +import sys +from _typeshed import MaybeNone, StrOrBytesPath, SupportsWrite +from collections.abc import Callable, ItemsView, Iterable, Iterator, Mapping, MutableMapping, Sequence +from re import Pattern +from typing import Any, ClassVar, Final, Literal, TypeVar, overload +from typing_extensions import TypeAlias + +if sys.version_info >= (3, 14): + __all__ = ( + "NoSectionError", + "DuplicateOptionError", + "DuplicateSectionError", + "NoOptionError", + "InterpolationError", + "InterpolationDepthError", + "InterpolationMissingOptionError", + "InterpolationSyntaxError", + "ParsingError", + "MissingSectionHeaderError", + "MultilineContinuationError", + "UnnamedSectionDisabledError", + "InvalidWriteError", + "ConfigParser", + "RawConfigParser", + "Interpolation", + "BasicInterpolation", + "ExtendedInterpolation", + "SectionProxy", + "ConverterMapping", + "DEFAULTSECT", + "MAX_INTERPOLATION_DEPTH", + "UNNAMED_SECTION", + ) +elif sys.version_info >= (3, 13): + __all__ = ( + "NoSectionError", + "DuplicateOptionError", + "DuplicateSectionError", + "NoOptionError", + "InterpolationError", + "InterpolationDepthError", + "InterpolationMissingOptionError", + "InterpolationSyntaxError", + "ParsingError", + "MissingSectionHeaderError", + "ConfigParser", + "RawConfigParser", + "Interpolation", + "BasicInterpolation", + "ExtendedInterpolation", + "SectionProxy", + "ConverterMapping", + "DEFAULTSECT", + "MAX_INTERPOLATION_DEPTH", + "UNNAMED_SECTION", + "MultilineContinuationError", + ) +elif sys.version_info >= (3, 12): + __all__ = ( + "NoSectionError", + "DuplicateOptionError", + "DuplicateSectionError", + "NoOptionError", + "InterpolationError", + "InterpolationDepthError", + "InterpolationMissingOptionError", + "InterpolationSyntaxError", + "ParsingError", + "MissingSectionHeaderError", + "ConfigParser", + "RawConfigParser", + "Interpolation", + "BasicInterpolation", + "ExtendedInterpolation", + "LegacyInterpolation", + "SectionProxy", + "ConverterMapping", + "DEFAULTSECT", + "MAX_INTERPOLATION_DEPTH", + ) +else: + __all__ = [ + "NoSectionError", + "DuplicateOptionError", + "DuplicateSectionError", + "NoOptionError", + "InterpolationError", + "InterpolationDepthError", + "InterpolationMissingOptionError", + "InterpolationSyntaxError", + "ParsingError", + "MissingSectionHeaderError", + "ConfigParser", + "SafeConfigParser", + "RawConfigParser", + "Interpolation", + "BasicInterpolation", + "ExtendedInterpolation", + "LegacyInterpolation", + "SectionProxy", + "ConverterMapping", + "DEFAULTSECT", + "MAX_INTERPOLATION_DEPTH", + ] + +if sys.version_info >= (3, 13): + class _UNNAMED_SECTION: ... + UNNAMED_SECTION: _UNNAMED_SECTION + + _SectionName: TypeAlias = str | _UNNAMED_SECTION + # A list of sections can only include an unnamed section if the parser was initialized with + # allow_unnamed_section=True. Any prevents users from having to use explicit + # type checks if allow_unnamed_section is False (the default). + _SectionNameList: TypeAlias = list[Any] +else: + _SectionName: TypeAlias = str + _SectionNameList: TypeAlias = list[str] + +_Section: TypeAlias = Mapping[str, str] +_Parser: TypeAlias = MutableMapping[str, _Section] +_ConverterCallback: TypeAlias = Callable[[str], Any] +_ConvertersMap: TypeAlias = dict[str, _ConverterCallback] +_T = TypeVar("_T") + +DEFAULTSECT: Final = "DEFAULT" +MAX_INTERPOLATION_DEPTH: Final = 10 + +class Interpolation: + def before_get(self, parser: _Parser, section: _SectionName, option: str, value: str, defaults: _Section) -> str: ... + def before_set(self, parser: _Parser, section: _SectionName, option: str, value: str) -> str: ... + def before_read(self, parser: _Parser, section: _SectionName, option: str, value: str) -> str: ... + def before_write(self, parser: _Parser, section: _SectionName, option: str, value: str) -> str: ... + +class BasicInterpolation(Interpolation): ... +class ExtendedInterpolation(Interpolation): ... + +if sys.version_info < (3, 13): + class LegacyInterpolation(Interpolation): + def before_get(self, parser: _Parser, section: _SectionName, option: str, value: str, vars: _Section) -> str: ... + +class RawConfigParser(_Parser): + _SECT_TMPL: ClassVar[str] # undocumented + _OPT_TMPL: ClassVar[str] # undocumented + _OPT_NV_TMPL: ClassVar[str] # undocumented + + SECTCRE: Pattern[str] + OPTCRE: ClassVar[Pattern[str]] + OPTCRE_NV: ClassVar[Pattern[str]] # undocumented + NONSPACECRE: ClassVar[Pattern[str]] # undocumented + + BOOLEAN_STATES: ClassVar[Mapping[str, bool]] # undocumented + default_section: str + if sys.version_info >= (3, 13): + @overload + def __init__( + self, + defaults: Mapping[str, str | None] | None = None, + dict_type: type[Mapping[str, str]] = ..., + *, + allow_no_value: Literal[True], + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + allow_unnamed_section: bool = False, + ) -> None: ... + @overload + def __init__( + self, + defaults: Mapping[str, str | None] | None, + dict_type: type[Mapping[str, str]], + allow_no_value: Literal[True], + *, + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + allow_unnamed_section: bool = False, + ) -> None: ... + @overload + def __init__( + self, + defaults: _Section | None = None, + dict_type: type[Mapping[str, str]] = ..., + allow_no_value: bool = False, + *, + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + allow_unnamed_section: bool = False, + ) -> None: ... + else: + @overload + def __init__( + self, + defaults: Mapping[str, str | None] | None = None, + dict_type: type[Mapping[str, str]] = ..., + *, + allow_no_value: Literal[True], + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + ) -> None: ... + @overload + def __init__( + self, + defaults: Mapping[str, str | None] | None, + dict_type: type[Mapping[str, str]], + allow_no_value: Literal[True], + *, + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + ) -> None: ... + @overload + def __init__( + self, + defaults: _Section | None = None, + dict_type: type[Mapping[str, str]] = ..., + allow_no_value: bool = False, + *, + delimiters: Sequence[str] = ("=", ":"), + comment_prefixes: Sequence[str] = ("#", ";"), + inline_comment_prefixes: Sequence[str] | None = None, + strict: bool = True, + empty_lines_in_values: bool = True, + default_section: str = "DEFAULT", + interpolation: Interpolation | None = ..., + converters: _ConvertersMap = ..., + ) -> None: ... + + def __len__(self) -> int: ... + def __getitem__(self, key: str) -> SectionProxy: ... + def __setitem__(self, key: str, value: _Section) -> None: ... + def __delitem__(self, key: str) -> None: ... + def __iter__(self) -> Iterator[str]: ... + def __contains__(self, key: object) -> bool: ... + def defaults(self) -> _Section: ... + def sections(self) -> _SectionNameList: ... + def add_section(self, section: _SectionName) -> None: ... + def has_section(self, section: _SectionName) -> bool: ... + def options(self, section: _SectionName) -> list[str]: ... + def has_option(self, section: _SectionName, option: str) -> bool: ... + def read(self, filenames: StrOrBytesPath | Iterable[StrOrBytesPath], encoding: str | None = None) -> list[str]: ... + def read_file(self, f: Iterable[str], source: str | None = None) -> None: ... + def read_string(self, string: str, source: str = "<string>") -> None: ... + def read_dict(self, dictionary: Mapping[str, Mapping[str, Any]], source: str = "<dict>") -> None: ... + if sys.version_info < (3, 12): + def readfp(self, fp: Iterable[str], filename: str | None = None) -> None: ... + # These get* methods are partially applied (with the same names) in + # SectionProxy; the stubs should be kept updated together + @overload + def getint(self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None) -> int: ... + @overload + def getint( + self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... + ) -> int | _T: ... + @overload + def getfloat(self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None) -> float: ... + @overload + def getfloat( + self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... + ) -> float | _T: ... + @overload + def getboolean(self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None) -> bool: ... + @overload + def getboolean( + self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T = ... + ) -> bool | _T: ... + def _get_conv( + self, + section: _SectionName, + option: str, + conv: Callable[[str], _T], + *, + raw: bool = False, + vars: _Section | None = None, + fallback: _T = ..., + ) -> _T: ... + # This is incompatible with MutableMapping so we ignore the type + @overload # type: ignore[override] + def get(self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None) -> str | MaybeNone: ... + @overload + def get( + self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T + ) -> str | _T | MaybeNone: ... + @overload + def items(self, *, raw: bool = False, vars: _Section | None = None) -> ItemsView[str, SectionProxy]: ... + @overload + def items(self, section: _SectionName, raw: bool = False, vars: _Section | None = None) -> list[tuple[str, str]]: ... + def set(self, section: _SectionName, option: str, value: str | None = None) -> None: ... + def write(self, fp: SupportsWrite[str], space_around_delimiters: bool = True) -> None: ... + def remove_option(self, section: _SectionName, option: str) -> bool: ... + def remove_section(self, section: _SectionName) -> bool: ... + def optionxform(self, optionstr: str) -> str: ... + @property + def converters(self) -> ConverterMapping: ... + +class ConfigParser(RawConfigParser): + # This is incompatible with MutableMapping so we ignore the type + @overload # type: ignore[override] + def get(self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None) -> str: ... + @overload + def get( + self, section: _SectionName, option: str, *, raw: bool = False, vars: _Section | None = None, fallback: _T + ) -> str | _T: ... + +if sys.version_info < (3, 12): + class SafeConfigParser(ConfigParser): ... # deprecated alias + +class SectionProxy(MutableMapping[str, str]): + def __init__(self, parser: RawConfigParser, name: str) -> None: ... + def __getitem__(self, key: str) -> str: ... + def __setitem__(self, key: str, value: str) -> None: ... + def __delitem__(self, key: str) -> None: ... + def __contains__(self, key: object) -> bool: ... + def __len__(self) -> int: ... + def __iter__(self) -> Iterator[str]: ... + @property + def parser(self) -> RawConfigParser: ... + @property + def name(self) -> str: ... + # This is incompatible with MutableMapping so we ignore the type + @overload # type: ignore[override] + def get( + self, + option: str, + fallback: None = None, + *, + raw: bool = False, + vars: _Section | None = None, + _impl: Any | None = None, + **kwargs: Any, # passed to the underlying parser's get() method + ) -> str | None: ... + @overload + def get( + self, + option: str, + fallback: _T, + *, + raw: bool = False, + vars: _Section | None = None, + _impl: Any | None = None, + **kwargs: Any, # passed to the underlying parser's get() method + ) -> str | _T: ... + # These are partially-applied version of the methods with the same names in + # RawConfigParser; the stubs should be kept updated together + @overload + def getint(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> int | None: ... + @overload + def getint(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> int | _T: ... + @overload + def getfloat(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> float | None: ... + @overload + def getfloat(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> float | _T: ... + @overload + def getboolean(self, option: str, *, raw: bool = ..., vars: _Section | None = ...) -> bool | None: ... + @overload + def getboolean(self, option: str, fallback: _T = ..., *, raw: bool = ..., vars: _Section | None = ...) -> bool | _T: ... + # SectionProxy can have arbitrary attributes when custom converters are used + def __getattr__(self, key: str) -> Callable[..., Any]: ... + +class ConverterMapping(MutableMapping[str, _ConverterCallback | None]): + GETTERCRE: ClassVar[Pattern[Any]] + def __init__(self, parser: RawConfigParser) -> None: ... + def __getitem__(self, key: str) -> _ConverterCallback: ... + def __setitem__(self, key: str, value: _ConverterCallback | None) -> None: ... + def __delitem__(self, key: str) -> None: ... + def __iter__(self) -> Iterator[str]: ... + def __len__(self) -> int: ... + +class Error(Exception): + message: str + def __init__(self, msg: str = "") -> None: ... + +class NoSectionError(Error): + section: _SectionName + def __init__(self, section: _SectionName) -> None: ... + +class DuplicateSectionError(Error): + section: _SectionName + source: str | None + lineno: int | None + def __init__(self, section: _SectionName, source: str | None = None, lineno: int | None = None) -> None: ... + +class DuplicateOptionError(Error): + section: _SectionName + option: str + source: str | None + lineno: int | None + def __init__(self, section: _SectionName, option: str, source: str | None = None, lineno: int | None = None) -> None: ... + +class NoOptionError(Error): + section: _SectionName + option: str + def __init__(self, option: str, section: _SectionName) -> None: ... + +class InterpolationError(Error): + section: _SectionName + option: str + def __init__(self, option: str, section: _SectionName, msg: str) -> None: ... + +class InterpolationDepthError(InterpolationError): + def __init__(self, option: str, section: _SectionName, rawval: object) -> None: ... + +class InterpolationMissingOptionError(InterpolationError): + reference: str + def __init__(self, option: str, section: _SectionName, rawval: object, reference: str) -> None: ... + +class InterpolationSyntaxError(InterpolationError): ... + +class ParsingError(Error): + source: str + errors: list[tuple[int, str]] + if sys.version_info >= (3, 13): + def __init__(self, source: str, *args: object) -> None: ... + def combine(self, others: Iterable[ParsingError]) -> ParsingError: ... + elif sys.version_info >= (3, 12): + def __init__(self, source: str) -> None: ... + else: + def __init__(self, source: str | None = None, filename: str | None = None) -> None: ... + + def append(self, lineno: int, line: str) -> None: ... + +class MissingSectionHeaderError(ParsingError): + lineno: int + line: str + def __init__(self, filename: str, lineno: int, line: str) -> None: ... + +if sys.version_info >= (3, 13): + class MultilineContinuationError(ParsingError): + lineno: int + line: str + def __init__(self, filename: str, lineno: int, line: str) -> None: ... + +if sys.version_info >= (3, 14): + class UnnamedSectionDisabledError(Error): + msg: Final = "Support for UNNAMED_SECTION is disabled." + def __init__(self) -> None: ... + + class InvalidWriteError(Error): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/contextlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/contextlib.pyi similarity index 78% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/contextlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/contextlib.pyi index fb34251693ad0..4663b448c79c8 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/contextlib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/contextlib.pyi @@ -1,7 +1,7 @@ import abc import sys from _typeshed import FileDescriptorOrPath, Unused -from abc import abstractmethod +from abc import ABC, abstractmethod from collections.abc import AsyncGenerator, AsyncIterator, Awaitable, Callable, Generator, Iterator from types import TracebackType from typing import IO, Any, Generic, Protocol, TypeVar, overload, runtime_checkable @@ -33,21 +33,31 @@ _T_co = TypeVar("_T_co", covariant=True) _T_io = TypeVar("_T_io", bound=IO[str] | None) _ExitT_co = TypeVar("_ExitT_co", covariant=True, bound=bool | None, default=bool | None) _F = TypeVar("_F", bound=Callable[..., Any]) +_G_co = TypeVar("_G_co", bound=Generator[Any, Any, Any] | AsyncGenerator[Any, Any], covariant=True) _P = ParamSpec("_P") +_SendT_contra = TypeVar("_SendT_contra", contravariant=True, default=None) +_ReturnT_co = TypeVar("_ReturnT_co", covariant=True, default=None) + _ExitFunc: TypeAlias = Callable[[type[BaseException] | None, BaseException | None, TracebackType | None], bool | None] _CM_EF = TypeVar("_CM_EF", bound=AbstractContextManager[Any, Any] | _ExitFunc) +# mypy and pyright object to this being both ABC and Protocol. +# At runtime it inherits from ABC and is not a Protocol, but it is on the +# allowlist for use as a Protocol. @runtime_checkable -class AbstractContextManager(Protocol[_T_co, _ExitT_co]): +class AbstractContextManager(ABC, Protocol[_T_co, _ExitT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] def __enter__(self) -> _T_co: ... @abstractmethod def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, / ) -> _ExitT_co: ... +# mypy and pyright object to this being both ABC and Protocol. +# At runtime it inherits from ABC and is not a Protocol, but it is on the +# allowlist for use as a Protocol. @runtime_checkable -class AbstractAsyncContextManager(Protocol[_T_co, _ExitT_co]): +class AbstractAsyncContextManager(ABC, Protocol[_T_co, _ExitT_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] async def __aenter__(self) -> _T_co: ... @abstractmethod async def __aexit__( @@ -58,22 +68,22 @@ class ContextDecorator: def _recreate_cm(self) -> Self: ... def __call__(self, func: _F) -> _F: ... -class _GeneratorContextManager(AbstractContextManager[_T_co, bool | None], ContextDecorator): - # __init__ and all instance attributes are actually inherited from _GeneratorContextManagerBase - # _GeneratorContextManagerBase is more trouble than it's worth to include in the stub; see #6676 - def __init__(self, func: Callable[..., Iterator[_T_co]], args: tuple[Any, ...], kwds: dict[str, Any]) -> None: ... - gen: Generator[_T_co, Any, Any] - func: Callable[..., Generator[_T_co, Any, Any]] +class _GeneratorContextManagerBase(Generic[_G_co]): + # Ideally this would use ParamSpec, but that requires (*args, **kwargs), which this isn't. see #6676 + def __init__(self, func: Callable[..., _G_co], args: tuple[Any, ...], kwds: dict[str, Any]) -> None: ... + gen: _G_co + func: Callable[..., _G_co] args: tuple[Any, ...] kwds: dict[str, Any] - if sys.version_info >= (3, 9): - def __exit__( - self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> bool | None: ... - else: - def __exit__( - self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None - ) -> bool | None: ... + +class _GeneratorContextManager( + _GeneratorContextManagerBase[Generator[_T_co, _SendT_contra, _ReturnT_co]], + AbstractContextManager[_T_co, bool | None], + ContextDecorator, +): + def __exit__( + self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> bool | None: ... def contextmanager(func: Callable[_P, Iterator[_T_co]]) -> Callable[_P, _GeneratorContextManager[_T_co]]: ... @@ -84,25 +94,19 @@ if sys.version_info >= (3, 10): def _recreate_cm(self) -> Self: ... def __call__(self, func: _AF) -> _AF: ... - class _AsyncGeneratorContextManager(AbstractAsyncContextManager[_T_co, bool | None], AsyncContextDecorator): - # __init__ and these attributes are actually defined in the base class _GeneratorContextManagerBase, - # which is more trouble than it's worth to include in the stub (see #6676) - def __init__(self, func: Callable[..., AsyncIterator[_T_co]], args: tuple[Any, ...], kwds: dict[str, Any]) -> None: ... - gen: AsyncGenerator[_T_co, Any] - func: Callable[..., AsyncGenerator[_T_co, Any]] - args: tuple[Any, ...] - kwds: dict[str, Any] + class _AsyncGeneratorContextManager( + _GeneratorContextManagerBase[AsyncGenerator[_T_co, _SendT_contra]], + AbstractAsyncContextManager[_T_co, bool | None], + AsyncContextDecorator, + ): async def __aexit__( self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None ) -> bool | None: ... else: - class _AsyncGeneratorContextManager(AbstractAsyncContextManager[_T_co, bool | None]): - def __init__(self, func: Callable[..., AsyncIterator[_T_co]], args: tuple[Any, ...], kwds: dict[str, Any]) -> None: ... - gen: AsyncGenerator[_T_co, Any] - func: Callable[..., AsyncGenerator[_T_co, Any]] - args: tuple[Any, ...] - kwds: dict[str, Any] + class _AsyncGeneratorContextManager( + _GeneratorContextManagerBase[AsyncGenerator[_T_co, _SendT_contra]], AbstractAsyncContextManager[_T_co, bool | None] + ): async def __aexit__( self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None ) -> bool | None: ... @@ -175,7 +179,7 @@ class AsyncExitStack(_BaseExitStack[_ExitT_co], metaclass=abc.ABCMeta): async def __aenter__(self) -> Self: ... async def __aexit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, / - ) -> bool: ... + ) -> _ExitT_co: ... if sys.version_info >= (3, 10): class nullcontext(AbstractContextManager[_T, None], AbstractAsyncContextManager[_T, None]): diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/contextvars.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/contextvars.pyi new file mode 100644 index 0000000000000..22dc33006e9d4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/contextvars.pyi @@ -0,0 +1,3 @@ +from _contextvars import Context as Context, ContextVar as ContextVar, Token as Token, copy_context as copy_context + +__all__ = ("Context", "ContextVar", "Token", "copy_context") diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/copy.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/copy.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/copy.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/copy.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/copyreg.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/copyreg.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/copyreg.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/copyreg.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/crypt.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/crypt.pyi new file mode 100644 index 0000000000000..bd22b5f8daba2 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/crypt.pyi @@ -0,0 +1,20 @@ +import sys +from typing import Final, NamedTuple, type_check_only + +if sys.platform != "win32": + @type_check_only + class _MethodBase(NamedTuple): + name: str + ident: str | None + salt_chars: int + total_size: int + + class _Method(_MethodBase): ... + METHOD_CRYPT: Final[_Method] + METHOD_MD5: Final[_Method] + METHOD_SHA256: Final[_Method] + METHOD_SHA512: Final[_Method] + METHOD_BLOWFISH: Final[_Method] + methods: list[_Method] + def mksalt(method: _Method | None = None, *, rounds: int | None = None) -> str: ... + def crypt(word: str, salt: str | _Method | None = None) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/csv.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/csv.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/csv.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/csv.pyi index a1656f217ec63..2c8e7109cdfc3 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/csv.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/csv.pyi @@ -4,13 +4,10 @@ from _csv import ( QUOTE_MINIMAL as QUOTE_MINIMAL, QUOTE_NONE as QUOTE_NONE, QUOTE_NONNUMERIC as QUOTE_NONNUMERIC, - Dialect as _Dialect, Error as Error, __version__ as __version__, _DialectLike, _QuotingType, - _reader, - _writer, field_size_limit as field_size_limit, get_dialect as get_dialect, list_dialects as list_dialects, @@ -22,15 +19,17 @@ from _csv import ( if sys.version_info >= (3, 12): from _csv import QUOTE_NOTNULL as QUOTE_NOTNULL, QUOTE_STRINGS as QUOTE_STRINGS +if sys.version_info >= (3, 10): + from _csv import Reader, Writer +else: + from _csv import _reader as Reader, _writer as Writer from _typeshed import SupportsWrite -from collections.abc import Collection, Iterable, Iterator, Mapping, Sequence +from collections.abc import Collection, Iterable, Mapping, Sequence +from types import GenericAlias from typing import Any, Generic, Literal, TypeVar, overload from typing_extensions import Self -if sys.version_info >= (3, 12): - from types import GenericAlias - __all__ = [ "QUOTE_MINIMAL", "QUOTE_ALL", @@ -59,18 +58,26 @@ if sys.version_info < (3, 13): _T = TypeVar("_T") -class Dialect(_Dialect): +class Dialect: + delimiter: str + quotechar: str | None + escapechar: str | None + doublequote: bool + skipinitialspace: bool + lineterminator: str + quoting: _QuotingType + strict: bool def __init__(self) -> None: ... class excel(Dialect): ... class excel_tab(excel): ... class unix_dialect(Dialect): ... -class DictReader(Iterator[dict[_T | Any, str | Any]], Generic[_T]): +class DictReader(Generic[_T]): fieldnames: Sequence[_T] | None restkey: _T | None restval: str | Any | None - reader: _reader + reader: Reader dialect: _DialectLike line_num: int @overload @@ -118,7 +125,7 @@ class DictWriter(Generic[_T]): fieldnames: Collection[_T] restval: Any | None extrasaction: Literal["raise", "ignore"] - writer: _writer + writer: Writer def __init__( self, f: SupportsWrite[str], diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi new file mode 100644 index 0000000000000..68b75b86def15 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/__init__.pyi @@ -0,0 +1,317 @@ +import sys +from _ctypes import ( + RTLD_GLOBAL as RTLD_GLOBAL, + RTLD_LOCAL as RTLD_LOCAL, + Array as Array, + CFuncPtr as _CFuncPtr, + Structure as Structure, + Union as Union, + _CanCastTo as _CanCastTo, + _CArgObject as _CArgObject, + _CData as _CData, + _CDataType as _CDataType, + _CField as _CField, + _Pointer as _Pointer, + _PointerLike as _PointerLike, + _SimpleCData as _SimpleCData, + addressof as addressof, + alignment as alignment, + byref as byref, + get_errno as get_errno, + resize as resize, + set_errno as set_errno, + sizeof as sizeof, +) +from _typeshed import StrPath +from ctypes._endian import BigEndianStructure as BigEndianStructure, LittleEndianStructure as LittleEndianStructure +from types import GenericAlias +from typing import Any, ClassVar, Generic, Literal, TypeVar, overload, type_check_only +from typing_extensions import Self, TypeAlias, deprecated + +if sys.platform == "win32": + from _ctypes import FormatError as FormatError, get_last_error as get_last_error, set_last_error as set_last_error + +if sys.version_info >= (3, 11): + from ctypes._endian import BigEndianUnion as BigEndianUnion, LittleEndianUnion as LittleEndianUnion + +_CT = TypeVar("_CT", bound=_CData) +_T = TypeVar("_T", default=Any) +_DLLT = TypeVar("_DLLT", bound=CDLL) + +if sys.version_info >= (3, 14): + @overload + @deprecated("ctypes.POINTER with string") + def POINTER(cls: str) -> type[Any]: ... + @overload + def POINTER(cls: None) -> type[c_void_p]: ... + @overload + def POINTER(cls: type[_CT]) -> type[_Pointer[_CT]]: ... + def pointer(obj: _CT) -> _Pointer[_CT]: ... + +else: + from _ctypes import POINTER as POINTER, pointer as pointer + +DEFAULT_MODE: int + +class ArgumentError(Exception): ... + +# defined within CDLL.__init__ +# Runtime name is ctypes.CDLL.__init__.<locals>._FuncPtr +@type_check_only +class _CDLLFuncPointer(_CFuncPtr): + _flags_: ClassVar[int] + _restype_: ClassVar[type[_CDataType]] + +# Not a real class; _CDLLFuncPointer with a __name__ set on it. +@type_check_only +class _NamedFuncPointer(_CDLLFuncPointer): + __name__: str + +if sys.version_info >= (3, 12): + _NameTypes: TypeAlias = StrPath | None +else: + _NameTypes: TypeAlias = str | None + +class CDLL: + _func_flags_: ClassVar[int] + _func_restype_: ClassVar[type[_CDataType]] + _name: str + _handle: int + _FuncPtr: type[_CDLLFuncPointer] + def __init__( + self, + name: _NameTypes, + mode: int = ..., + handle: int | None = None, + use_errno: bool = False, + use_last_error: bool = False, + winmode: int | None = None, + ) -> None: ... + def __getattr__(self, name: str) -> _NamedFuncPointer: ... + def __getitem__(self, name_or_ordinal: str) -> _NamedFuncPointer: ... + +if sys.platform == "win32": + class OleDLL(CDLL): ... + class WinDLL(CDLL): ... + +class PyDLL(CDLL): ... + +class LibraryLoader(Generic[_DLLT]): + def __init__(self, dlltype: type[_DLLT]) -> None: ... + def __getattr__(self, name: str) -> _DLLT: ... + def __getitem__(self, name: str) -> _DLLT: ... + def LoadLibrary(self, name: str) -> _DLLT: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +cdll: LibraryLoader[CDLL] +if sys.platform == "win32": + windll: LibraryLoader[WinDLL] + oledll: LibraryLoader[OleDLL] +pydll: LibraryLoader[PyDLL] +pythonapi: PyDLL + +# Class definition within CFUNCTYPE / WINFUNCTYPE / PYFUNCTYPE +# Names at runtime are +# ctypes.CFUNCTYPE.<locals>.CFunctionType +# ctypes.WINFUNCTYPE.<locals>.WinFunctionType +# ctypes.PYFUNCTYPE.<locals>.CFunctionType +@type_check_only +class _CFunctionType(_CFuncPtr): + _argtypes_: ClassVar[list[type[_CData | _CDataType]]] + _restype_: ClassVar[type[_CData | _CDataType] | None] + _flags_: ClassVar[int] + +# Alias for either function pointer type +_FuncPointer: TypeAlias = _CDLLFuncPointer | _CFunctionType # noqa: Y047 # not used here + +def CFUNCTYPE( + restype: type[_CData | _CDataType] | None, + *argtypes: type[_CData | _CDataType], + use_errno: bool = False, + use_last_error: bool = False, +) -> type[_CFunctionType]: ... + +if sys.platform == "win32": + def WINFUNCTYPE( + restype: type[_CData | _CDataType] | None, + *argtypes: type[_CData | _CDataType], + use_errno: bool = False, + use_last_error: bool = False, + ) -> type[_CFunctionType]: ... + +def PYFUNCTYPE(restype: type[_CData | _CDataType] | None, *argtypes: type[_CData | _CDataType]) -> type[_CFunctionType]: ... + +# Any type that can be implicitly converted to c_void_p when passed as a C function argument. +# (bytes is not included here, see below.) +_CVoidPLike: TypeAlias = _PointerLike | Array[Any] | _CArgObject | int +# Same as above, but including types known to be read-only (i. e. bytes). +# This distinction is not strictly necessary (ctypes doesn't differentiate between const +# and non-const pointers), but it catches errors like memmove(b'foo', buf, 4) +# when memmove(buf, b'foo', 4) was intended. +_CVoidConstPLike: TypeAlias = _CVoidPLike | bytes + +_CastT = TypeVar("_CastT", bound=_CanCastTo) + +def cast(obj: _CData | _CDataType | _CArgObject | int, typ: type[_CastT]) -> _CastT: ... +def create_string_buffer(init: int | bytes, size: int | None = None) -> Array[c_char]: ... + +c_buffer = create_string_buffer + +def create_unicode_buffer(init: int | str, size: int | None = None) -> Array[c_wchar]: ... +@deprecated("Deprecated in Python 3.13; removal scheduled for Python 3.15") +def SetPointerType(pointer: type[_Pointer[Any]], cls: Any) -> None: ... +def ARRAY(typ: _CT, len: int) -> Array[_CT]: ... # Soft Deprecated, no plans to remove + +if sys.platform == "win32": + def DllCanUnloadNow() -> int: ... + def DllGetClassObject(rclsid: Any, riid: Any, ppv: Any) -> int: ... # TODO: not documented + + # Actually just an instance of _NamedFuncPointer (aka _CDLLFuncPointer), + # but we want to set a more specific __call__ + @type_check_only + class _GetLastErrorFunctionType(_NamedFuncPointer): + def __call__(self) -> int: ... + + GetLastError: _GetLastErrorFunctionType + +# Actually just an instance of _CFunctionType, but we want to set a more +# specific __call__. +@type_check_only +class _MemmoveFunctionType(_CFunctionType): + def __call__(self, dst: _CVoidPLike, src: _CVoidConstPLike, count: int) -> int: ... + +memmove: _MemmoveFunctionType + +# Actually just an instance of _CFunctionType, but we want to set a more +# specific __call__. +@type_check_only +class _MemsetFunctionType(_CFunctionType): + def __call__(self, dst: _CVoidPLike, c: int, count: int) -> int: ... + +memset: _MemsetFunctionType + +def string_at(ptr: _CVoidConstPLike, size: int = -1) -> bytes: ... + +if sys.platform == "win32": + def WinError(code: int | None = None, descr: str | None = None) -> OSError: ... + +def wstring_at(ptr: _CVoidConstPLike, size: int = -1) -> str: ... + +class py_object(_CanCastTo, _SimpleCData[_T]): + _type_: ClassVar[Literal["O"]] + +class c_bool(_SimpleCData[bool]): + _type_: ClassVar[Literal["?"]] + def __init__(self, value: bool = ...) -> None: ... + +class c_byte(_SimpleCData[int]): + _type_: ClassVar[Literal["b"]] + +class c_ubyte(_SimpleCData[int]): + _type_: ClassVar[Literal["B"]] + +class c_short(_SimpleCData[int]): + _type_: ClassVar[Literal["h"]] + +class c_ushort(_SimpleCData[int]): + _type_: ClassVar[Literal["H"]] + +class c_long(_SimpleCData[int]): + _type_: ClassVar[Literal["l"]] + +class c_ulong(_SimpleCData[int]): + _type_: ClassVar[Literal["L"]] + +class c_int(_SimpleCData[int]): # can be an alias for c_long + _type_: ClassVar[Literal["i", "l"]] + +class c_uint(_SimpleCData[int]): # can be an alias for c_ulong + _type_: ClassVar[Literal["I", "L"]] + +class c_longlong(_SimpleCData[int]): # can be an alias for c_long + _type_: ClassVar[Literal["q", "l"]] + +class c_ulonglong(_SimpleCData[int]): # can be an alias for c_ulong + _type_: ClassVar[Literal["Q", "L"]] + +c_int8 = c_byte +c_uint8 = c_ubyte + +class c_int16(_SimpleCData[int]): # can be an alias for c_short or c_int + _type_: ClassVar[Literal["h", "i"]] + +class c_uint16(_SimpleCData[int]): # can be an alias for c_ushort or c_uint + _type_: ClassVar[Literal["H", "I"]] + +class c_int32(_SimpleCData[int]): # can be an alias for c_int or c_long + _type_: ClassVar[Literal["i", "l"]] + +class c_uint32(_SimpleCData[int]): # can be an alias for c_uint or c_ulong + _type_: ClassVar[Literal["I", "L"]] + +class c_int64(_SimpleCData[int]): # can be an alias for c_long or c_longlong + _type_: ClassVar[Literal["l", "q"]] + +class c_uint64(_SimpleCData[int]): # can be an alias for c_ulong or c_ulonglong + _type_: ClassVar[Literal["L", "Q"]] + +class c_ssize_t(_SimpleCData[int]): # alias for c_int, c_long, or c_longlong + _type_: ClassVar[Literal["i", "l", "q"]] + +class c_size_t(_SimpleCData[int]): # alias for c_uint, c_ulong, or c_ulonglong + _type_: ClassVar[Literal["I", "L", "Q"]] + +class c_float(_SimpleCData[float]): + _type_: ClassVar[Literal["f"]] + +class c_double(_SimpleCData[float]): + _type_: ClassVar[Literal["d"]] + +class c_longdouble(_SimpleCData[float]): # can be an alias for c_double + _type_: ClassVar[Literal["d", "g"]] + +if sys.version_info >= (3, 14): + class c_float_complex(_SimpleCData[complex]): + _type_: ClassVar[Literal["E"]] + + class c_double_complex(_SimpleCData[complex]): + _type_: ClassVar[Literal["C"]] + + class c_longdouble_complex(_SimpleCData[complex]): + _type_: ClassVar[Literal["F"]] + +class c_char(_SimpleCData[bytes]): + _type_: ClassVar[Literal["c"]] + def __init__(self, value: int | bytes | bytearray = ...) -> None: ... + +class c_char_p(_PointerLike, _SimpleCData[bytes | None]): + _type_: ClassVar[Literal["z"]] + def __init__(self, value: int | bytes | None = ...) -> None: ... + @classmethod + def from_param(cls, value: Any, /) -> Self | _CArgObject: ... + +class c_void_p(_PointerLike, _SimpleCData[int | None]): + _type_: ClassVar[Literal["P"]] + @classmethod + def from_param(cls, value: Any, /) -> Self | _CArgObject: ... + +c_voidp = c_void_p # backwards compatibility (to a bug) + +class c_wchar(_SimpleCData[str]): + _type_: ClassVar[Literal["u"]] + +class c_wchar_p(_PointerLike, _SimpleCData[str | None]): + _type_: ClassVar[Literal["Z"]] + def __init__(self, value: int | str | None = ...) -> None: ... + @classmethod + def from_param(cls, value: Any, /) -> Self | _CArgObject: ... + +if sys.platform == "win32": + class HRESULT(_SimpleCData[int]): # TODO: undocumented + _type_: ClassVar[Literal["l"]] + +if sys.version_info >= (3, 12): + # At runtime, this is an alias for either c_int32 or c_int64, + # which are themselves an alias for one of c_int, c_long, or c_longlong + # This covers all our bases. + c_time_t: type[c_int32 | c_int64 | c_int | c_long | c_longlong] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/_endian.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/_endian.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/_endian.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ctypes/_endian.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/__init__.pyi new file mode 100644 index 0000000000000..bda5b5a7f4cc3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/__init__.pyi @@ -0,0 +1 @@ +__version__: str diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dyld.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dyld.pyi new file mode 100644 index 0000000000000..c7e94daa21497 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dyld.pyi @@ -0,0 +1,8 @@ +from collections.abc import Mapping +from ctypes.macholib.dylib import dylib_info as dylib_info +from ctypes.macholib.framework import framework_info as framework_info + +__all__ = ["dyld_find", "framework_find", "framework_info", "dylib_info"] + +def dyld_find(name: str, executable_path: str | None = None, env: Mapping[str, str] | None = None) -> str: ... +def framework_find(fn: str, executable_path: str | None = None, env: Mapping[str, str] | None = None) -> str: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dylib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dylib.pyi new file mode 100644 index 0000000000000..95945edfd155c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/dylib.pyi @@ -0,0 +1,14 @@ +from typing import TypedDict, type_check_only + +__all__ = ["dylib_info"] + +# Actual result is produced by re.match.groupdict() +@type_check_only +class _DylibInfo(TypedDict): + location: str + name: str + shortname: str + version: str | None + suffix: str | None + +def dylib_info(filename: str) -> _DylibInfo | None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/framework.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/framework.pyi new file mode 100644 index 0000000000000..e92bf3700e840 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/macholib/framework.pyi @@ -0,0 +1,14 @@ +from typing import TypedDict, type_check_only + +__all__ = ["framework_info"] + +# Actual result is produced by re.match.groupdict() +@type_check_only +class _FrameworkInfo(TypedDict): + location: str + name: str + shortname: str + version: str | None + suffix: str | None + +def framework_info(filename: str) -> _FrameworkInfo | None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/util.pyi new file mode 100644 index 0000000000000..316f7a2b3e2f5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/util.pyi @@ -0,0 +1,8 @@ +import sys + +def find_library(name: str) -> str | None: ... + +if sys.platform == "win32": + def find_msvcrt() -> str | None: ... + +def test() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi index 8847860f2002b..63f117787aa0b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ctypes/wintypes.pyi @@ -1,10 +1,10 @@ +import sys +from _ctypes import _CArgObject, _CField from ctypes import ( Array, Structure, - _CField, _Pointer, _SimpleCData, - c_byte, c_char, c_char_p, c_double, @@ -21,10 +21,18 @@ from ctypes import ( c_wchar, c_wchar_p, ) -from typing import TypeVar -from typing_extensions import TypeAlias +from typing import Any, TypeVar +from typing_extensions import Self, TypeAlias + +if sys.version_info >= (3, 12): + from ctypes import c_ubyte + + BYTE = c_ubyte +else: + from ctypes import c_byte + + BYTE = c_byte -BYTE = c_byte WORD = c_ushort DWORD = c_ulong CHAR = c_char @@ -241,10 +249,16 @@ LPBYTE = PBYTE PBOOLEAN = PBYTE # LP_c_char -class PCHAR(_Pointer[CHAR]): ... +class PCHAR(_Pointer[CHAR]): + # this is inherited from ctypes.c_char_p, kind of. + @classmethod + def from_param(cls, value: Any, /) -> Self | _CArgObject: ... # LP_c_wchar -class PWCHAR(_Pointer[WCHAR]): ... +class PWCHAR(_Pointer[WCHAR]): + # inherited from ctypes.c_wchar_p, kind of + @classmethod + def from_param(cls, value: Any, /) -> Self | _CArgObject: ... # LP_c_void_p class PHANDLE(_Pointer[HANDLE]): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/curses/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/curses/__init__.pyi new file mode 100644 index 0000000000000..5c157fd7c2f61 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/curses/__init__.pyi @@ -0,0 +1,40 @@ +import sys +from _curses import * +from _curses import window as window +from _typeshed import structseq +from collections.abc import Callable +from typing import Final, TypeVar, final, type_check_only +from typing_extensions import Concatenate, ParamSpec + +# NOTE: The _curses module is ordinarily only available on Unix, but the +# windows-curses package makes it available on Windows as well with the same +# contents. + +_T = TypeVar("_T") +_P = ParamSpec("_P") + +# available after calling `curses.initscr()` +LINES: int +COLS: int + +# available after calling `curses.start_color()` +COLORS: int +COLOR_PAIRS: int + +def wrapper(func: Callable[Concatenate[window, _P], _T], /, *arg: _P.args, **kwds: _P.kwargs) -> _T: ... + +# At runtime this class is unexposed and calls itself curses.ncurses_version. +# That name would conflict with the actual curses.ncurses_version, which is +# an instance of this class. +@final +@type_check_only +class _ncurses_version(structseq[int], tuple[int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("major", "minor", "patch") + + @property + def major(self) -> int: ... + @property + def minor(self) -> int: ... + @property + def patch(self) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/ascii.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/curses/ascii.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/curses/ascii.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/curses/ascii.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/has_key.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/curses/has_key.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/curses/has_key.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/curses/has_key.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/curses/panel.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/curses/panel.pyi new file mode 100644 index 0000000000000..861559d38bc5a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/curses/panel.pyi @@ -0,0 +1 @@ +from _curses_panel import * diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/curses/textpad.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/curses/textpad.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/curses/textpad.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/curses/textpad.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/dataclasses.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dataclasses.pyi new file mode 100644 index 0000000000000..bba76c1af1b4b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/dataclasses.pyi @@ -0,0 +1,412 @@ +import enum +import sys +import types +from _typeshed import DataclassInstance +from builtins import type as Type # alias to avoid name clashes with fields named "type" +from collections.abc import Callable, Iterable, Mapping +from types import GenericAlias +from typing import Any, Generic, Literal, Protocol, TypeVar, overload, type_check_only +from typing_extensions import Never, TypeIs + +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) + +__all__ = [ + "dataclass", + "field", + "Field", + "FrozenInstanceError", + "InitVar", + "MISSING", + "fields", + "asdict", + "astuple", + "make_dataclass", + "replace", + "is_dataclass", +] + +if sys.version_info >= (3, 10): + __all__ += ["KW_ONLY"] + +_DataclassT = TypeVar("_DataclassT", bound=DataclassInstance) + +@type_check_only +class _DataclassFactory(Protocol): + def __call__( + self, + cls: type[_T], + /, + *, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + weakref_slot: bool = False, + ) -> type[_T]: ... + +# define _MISSING_TYPE as an enum within the type stubs, +# even though that is not really its type at runtime +# this allows us to use Literal[_MISSING_TYPE.MISSING] +# for background, see: +# https://github.com/python/typeshed/pull/5900#issuecomment-895513797 +class _MISSING_TYPE(enum.Enum): + MISSING = enum.auto() + +MISSING = _MISSING_TYPE.MISSING + +if sys.version_info >= (3, 10): + class KW_ONLY: ... + +@overload +def asdict(obj: DataclassInstance) -> dict[str, Any]: ... +@overload +def asdict(obj: DataclassInstance, *, dict_factory: Callable[[list[tuple[str, Any]]], _T]) -> _T: ... +@overload +def astuple(obj: DataclassInstance) -> tuple[Any, ...]: ... +@overload +def astuple(obj: DataclassInstance, *, tuple_factory: Callable[[list[Any]], _T]) -> _T: ... +@overload +def dataclass(cls: None, /) -> Callable[[type[_T]], type[_T]]: ... +@overload +def dataclass(cls: type[_T], /) -> type[_T]: ... + +if sys.version_info >= (3, 11): + @overload + def dataclass( + *, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + weakref_slot: bool = False, + ) -> Callable[[type[_T]], type[_T]]: ... + +elif sys.version_info >= (3, 10): + @overload + def dataclass( + *, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + ) -> Callable[[type[_T]], type[_T]]: ... + +else: + @overload + def dataclass( + *, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + ) -> Callable[[type[_T]], type[_T]]: ... + +# See https://github.com/python/mypy/issues/10750 +class _DefaultFactory(Protocol[_T_co]): + def __call__(self) -> _T_co: ... + +class Field(Generic[_T]): + name: str + type: Type[_T] | str | Any + default: _T | Literal[_MISSING_TYPE.MISSING] + default_factory: _DefaultFactory[_T] | Literal[_MISSING_TYPE.MISSING] + repr: bool + hash: bool | None + init: bool + compare: bool + metadata: types.MappingProxyType[Any, Any] + + if sys.version_info >= (3, 14): + doc: str | None + + if sys.version_info >= (3, 10): + kw_only: bool | Literal[_MISSING_TYPE.MISSING] + + if sys.version_info >= (3, 14): + def __init__( + self, + default: _T, + default_factory: Callable[[], _T], + init: bool, + repr: bool, + hash: bool | None, + compare: bool, + metadata: Mapping[Any, Any], + kw_only: bool, + doc: str | None, + ) -> None: ... + elif sys.version_info >= (3, 10): + def __init__( + self, + default: _T, + default_factory: Callable[[], _T], + init: bool, + repr: bool, + hash: bool | None, + compare: bool, + metadata: Mapping[Any, Any], + kw_only: bool, + ) -> None: ... + else: + def __init__( + self, + default: _T, + default_factory: Callable[[], _T], + init: bool, + repr: bool, + hash: bool | None, + compare: bool, + metadata: Mapping[Any, Any], + ) -> None: ... + + def __set_name__(self, owner: Type[Any], name: str) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +# NOTE: Actual return type is 'Field[_T]', but we want to help type checkers +# to understand the magic that happens at runtime. +if sys.version_info >= (3, 14): + @overload # `default` and `default_factory` are optional and mutually exclusive. + def field( + *, + default: _T, + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + doc: str | None = None, + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Callable[[], _T], + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + doc: str | None = None, + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + doc: str | None = None, + ) -> Any: ... + +elif sys.version_info >= (3, 10): + @overload # `default` and `default_factory` are optional and mutually exclusive. + def field( + *, + default: _T, + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Callable[[], _T], + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + kw_only: bool | Literal[_MISSING_TYPE.MISSING] = ..., + ) -> Any: ... + +else: + @overload # `default` and `default_factory` are optional and mutually exclusive. + def field( + *, + default: _T, + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Callable[[], _T], + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + ) -> _T: ... + @overload + def field( + *, + default: Literal[_MISSING_TYPE.MISSING] = ..., + default_factory: Literal[_MISSING_TYPE.MISSING] = ..., + init: bool = True, + repr: bool = True, + hash: bool | None = None, + compare: bool = True, + metadata: Mapping[Any, Any] | None = None, + ) -> Any: ... + +def fields(class_or_instance: DataclassInstance | type[DataclassInstance]) -> tuple[Field[Any], ...]: ... + +# HACK: `obj: Never` typing matches if object argument is using `Any` type. +@overload +def is_dataclass(obj: Never) -> TypeIs[DataclassInstance | type[DataclassInstance]]: ... # type: ignore[narrowed-type-not-subtype] # pyright: ignore[reportGeneralTypeIssues] +@overload +def is_dataclass(obj: type) -> TypeIs[type[DataclassInstance]]: ... +@overload +def is_dataclass(obj: object) -> TypeIs[DataclassInstance | type[DataclassInstance]]: ... + +class FrozenInstanceError(AttributeError): ... + +class InitVar(Generic[_T], metaclass=type): + type: Type[_T] + def __init__(self, type: Type[_T]) -> None: ... + @overload + def __class_getitem__(cls, type: Type[_T]) -> InitVar[_T]: ... # pyright: ignore[reportInvalidTypeForm] + @overload + def __class_getitem__(cls, type: Any) -> InitVar[Any]: ... # pyright: ignore[reportInvalidTypeForm] + +if sys.version_info >= (3, 14): + def make_dataclass( + cls_name: str, + fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], + *, + bases: tuple[type, ...] = (), + namespace: dict[str, Any] | None = None, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + weakref_slot: bool = False, + module: str | None = None, + decorator: _DataclassFactory = ..., + ) -> type: ... + +elif sys.version_info >= (3, 12): + def make_dataclass( + cls_name: str, + fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], + *, + bases: tuple[type, ...] = (), + namespace: dict[str, Any] | None = None, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + weakref_slot: bool = False, + module: str | None = None, + ) -> type: ... + +elif sys.version_info >= (3, 11): + def make_dataclass( + cls_name: str, + fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], + *, + bases: tuple[type, ...] = (), + namespace: dict[str, Any] | None = None, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + weakref_slot: bool = False, + ) -> type: ... + +elif sys.version_info >= (3, 10): + def make_dataclass( + cls_name: str, + fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], + *, + bases: tuple[type, ...] = (), + namespace: dict[str, Any] | None = None, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + match_args: bool = True, + kw_only: bool = False, + slots: bool = False, + ) -> type: ... + +else: + def make_dataclass( + cls_name: str, + fields: Iterable[str | tuple[str, Any] | tuple[str, Any, Any]], + *, + bases: tuple[type, ...] = (), + namespace: dict[str, Any] | None = None, + init: bool = True, + repr: bool = True, + eq: bool = True, + order: bool = False, + unsafe_hash: bool = False, + frozen: bool = False, + ) -> type: ... + +def replace(obj: _DataclassT, /, **changes: Any) -> _DataclassT: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/datetime.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/datetime.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/datetime.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/datetime.pyi index e8a4efdc61f3a..37d6a06dfff95 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/datetime.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/datetime.pyi @@ -1,12 +1,12 @@ import sys from abc import abstractmethod from time import struct_time -from typing import ClassVar, Final, NamedTuple, NoReturn, SupportsIndex, final, overload -from typing_extensions import Self, TypeAlias, deprecated +from typing import ClassVar, Final, NoReturn, SupportsIndex, final, overload, type_check_only +from typing_extensions import CapsuleType, Self, TypeAlias, deprecated if sys.version_info >= (3, 11): __all__ = ("date", "datetime", "time", "timedelta", "timezone", "tzinfo", "MINYEAR", "MAXYEAR", "UTC") -elif sys.version_info >= (3, 9): +else: __all__ = ("date", "datetime", "time", "timedelta", "timezone", "tzinfo", "MINYEAR", "MAXYEAR") MINYEAR: Final = 1 @@ -29,7 +29,7 @@ class timezone(tzinfo): utc: ClassVar[timezone] min: ClassVar[timezone] max: ClassVar[timezone] - def __init__(self, offset: timedelta, name: str = ...) -> None: ... + def __new__(cls, offset: timedelta, name: str = ...) -> Self: ... def tzname(self, dt: datetime | None, /) -> str: ... def utcoffset(self, dt: datetime | None, /) -> timedelta: ... def dst(self, dt: datetime | None, /) -> None: ... @@ -39,11 +39,17 @@ class timezone(tzinfo): if sys.version_info >= (3, 11): UTC: timezone -if sys.version_info >= (3, 9): - class _IsoCalendarDate(NamedTuple): - year: int - week: int - weekday: int +# This class calls itself datetime.IsoCalendarDate. It's neither +# NamedTuple nor structseq. +@final +@type_check_only +class _IsoCalendarDate(tuple[int, int, int]): + @property + def year(self) -> int: ... + @property + def week(self) -> int: ... + @property + def weekday(self) -> int: ... class date: min: ClassVar[date] @@ -67,6 +73,11 @@ class date: @property def day(self) -> int: ... def ctime(self) -> str: ... + + if sys.version_info >= (3, 14): + @classmethod + def strptime(cls, date_string: str, format: str, /) -> Self: ... + # On <3.12, the name of the parameter in the pure-Python implementation # didn't match the name in the C implementation, # meaning it is only *safe* to pass it as a keyword argument on 3.12+ @@ -99,10 +110,7 @@ class date: def __hash__(self) -> int: ... def weekday(self) -> int: ... def isoweekday(self) -> int: ... - if sys.version_info >= (3, 9): - def isocalendar(self) -> _IsoCalendarDate: ... - else: - def isocalendar(self) -> tuple[int, int, int]: ... + def isocalendar(self) -> _IsoCalendarDate: ... class time: min: ClassVar[time] @@ -139,6 +147,11 @@ class time: def isoformat(self, timespec: str = ...) -> str: ... @classmethod def fromisoformat(cls, time_string: str, /) -> Self: ... + + if sys.version_info >= (3, 14): + @classmethod + def strptime(cls, date_string: str, format: str, /) -> Self: ... + # On <3.12, the name of the parameter in the pure-Python implementation # didn't match the name in the C implementation, # meaning it is only *safe* to pass it as a keyword argument on 3.12+ @@ -325,3 +338,5 @@ class datetime(date): def __sub__(self, value: Self, /) -> timedelta: ... @overload def __sub__(self, value: timedelta, /) -> Self: ... + +datetime_CAPI: CapsuleType diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi new file mode 100644 index 0000000000000..7f344060f9ab5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/__init__.pyi @@ -0,0 +1,104 @@ +import sys +from _typeshed import StrOrBytesPath +from collections.abc import Iterator, MutableMapping +from types import TracebackType +from typing import Literal, type_check_only +from typing_extensions import Self, TypeAlias + +__all__ = ["open", "whichdb", "error"] + +_KeyType: TypeAlias = str | bytes +_ValueType: TypeAlias = str | bytes | bytearray +_TFlags: TypeAlias = Literal[ + "r", + "w", + "c", + "n", + "rf", + "wf", + "cf", + "nf", + "rs", + "ws", + "cs", + "ns", + "ru", + "wu", + "cu", + "nu", + "rfs", + "wfs", + "cfs", + "nfs", + "rfu", + "wfu", + "cfu", + "nfu", + "rsf", + "wsf", + "csf", + "nsf", + "rsu", + "wsu", + "csu", + "nsu", + "ruf", + "wuf", + "cuf", + "nuf", + "rus", + "wus", + "cus", + "nus", + "rfsu", + "wfsu", + "cfsu", + "nfsu", + "rfus", + "wfus", + "cfus", + "nfus", + "rsfu", + "wsfu", + "csfu", + "nsfu", + "rsuf", + "wsuf", + "csuf", + "nsuf", + "rufs", + "wufs", + "cufs", + "nufs", + "rusf", + "wusf", + "cusf", + "nusf", +] + +class _Database(MutableMapping[_KeyType, bytes]): + def close(self) -> None: ... + def __getitem__(self, key: _KeyType) -> bytes: ... + def __setitem__(self, key: _KeyType, value: _ValueType) -> None: ... + def __delitem__(self, key: _KeyType) -> None: ... + def __iter__(self) -> Iterator[bytes]: ... + def __len__(self) -> int: ... + def __del__(self) -> None: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + +# This class is not exposed. It calls itself dbm.error. +@type_check_only +class _error(Exception): ... + +error: tuple[type[_error], type[OSError]] + +if sys.version_info >= (3, 11): + def whichdb(filename: StrOrBytesPath) -> str | None: ... + def open(file: StrOrBytesPath, flag: _TFlags = "r", mode: int = 0o666) -> _Database: ... + +else: + def whichdb(filename: str) -> str | None: ... + def open(file: str, flag: _TFlags = "r", mode: int = 0o666) -> _Database: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/dumb.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/dumb.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/dumb.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/dbm/dumb.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/dbm/gnu.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/gnu.pyi new file mode 100644 index 0000000000000..2dac3d12b0ca4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/gnu.pyi @@ -0,0 +1 @@ +from _gdbm import * diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi new file mode 100644 index 0000000000000..66c943ab640be --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/ndbm.pyi @@ -0,0 +1 @@ +from _dbm import * diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/sqlite3.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dbm/sqlite3.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/dbm/sqlite3.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/dbm/sqlite3.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/decimal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/decimal.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/decimal.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/decimal.pyi index 3da75ec192ac0..b85c000800920 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/decimal.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/decimal.pyi @@ -1,4 +1,5 @@ import numbers +import sys from _decimal import ( HAVE_CONTEXTVAR as HAVE_CONTEXTVAR, HAVE_THREADS as HAVE_THREADS, @@ -24,9 +25,13 @@ from _decimal import ( setcontext as setcontext, ) from collections.abc import Container, Sequence -from typing import Any, ClassVar, Literal, NamedTuple, overload +from types import TracebackType +from typing import Any, ClassVar, Literal, NamedTuple, final, overload, type_check_only from typing_extensions import Self, TypeAlias +if sys.version_info >= (3, 14): + from _decimal import IEEE_CONTEXT_MAX_BITS as IEEE_CONTEXT_MAX_BITS, IEEEContext as IEEEContext + _Decimal: TypeAlias = Decimal | int _DecimalNew: TypeAlias = Decimal | float | str | tuple[int, Sequence[int], int] _ComparableNum: TypeAlias = Decimal | float | numbers.Rational @@ -35,6 +40,14 @@ _TrapType: TypeAlias = type[DecimalException] # At runtime, these classes are implemented in C as part of "_decimal". # However, they consider themselves to live in "decimal", so we'll put them here. +# This type isn't exposed at runtime. It calls itself decimal.ContextManager +@final +@type_check_only +class _ContextManager: + def __init__(self, new_context: Context) -> None: ... + def __enter__(self) -> Context: ... + def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... + class DecimalTuple(NamedTuple): sign: int digits: tuple[int, ...] @@ -56,7 +69,11 @@ class Underflow(Inexact, Rounded, Subnormal): ... class FloatOperation(DecimalException, TypeError): ... class Decimal: - def __new__(cls, value: _DecimalNew = ..., context: Context | None = ...) -> Self: ... + def __new__(cls, value: _DecimalNew = "0", context: Context | None = None) -> Self: ... + if sys.version_info >= (3, 14): + @classmethod + def from_number(cls, number: Decimal | float, /) -> Self: ... + @classmethod def from_float(cls, f: float, /) -> Self: ... def __bool__(self) -> bool: ... @@ -154,12 +171,12 @@ class Decimal: def __reduce__(self) -> tuple[type[Self], tuple[str]]: ... def __copy__(self) -> Self: ... def __deepcopy__(self, memo: Any, /) -> Self: ... - def __format__(self, specifier: str, context: Context | None = ..., /) -> str: ... + def __format__(self, specifier: str, context: Context | None = None, /) -> str: ... class Context: # TODO: Context doesn't allow you to delete *any* attributes from instances of the class at runtime, # even settable attributes like `prec` and `rounding`, - # but that's inexpressable in the stub. + # but that's inexpressible in the stub. # Type checkers either ignore it or misinterpret it # if you add a `def __delattr__(self, name: str, /) -> NoReturn` method to the stub prec: int @@ -172,15 +189,14 @@ class Context: flags: dict[_TrapType, bool] def __init__( self, - prec: int | None = ..., - rounding: str | None = ..., - Emin: int | None = ..., - Emax: int | None = ..., - capitals: int | None = ..., - clamp: int | None = ..., - flags: None | dict[_TrapType, bool] | Container[_TrapType] = ..., - traps: None | dict[_TrapType, bool] | Container[_TrapType] = ..., - _ignored_flags: list[_TrapType] | None = ..., + prec: int | None = None, + rounding: str | None = None, + Emin: int | None = None, + Emax: int | None = None, + capitals: int | None = None, + clamp: int | None = None, + flags: dict[_TrapType, bool] | Container[_TrapType] | None = None, + traps: dict[_TrapType, bool] | Container[_TrapType] | None = None, ) -> None: ... def __reduce__(self) -> tuple[type[Self], tuple[Any, ...]]: ... def clear_flags(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/difflib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/difflib.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/difflib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/difflib.pyi index 50154d785c2f5..18583a3acfe9d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/difflib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/difflib.pyi @@ -1,10 +1,7 @@ -import sys from collections.abc import Callable, Iterable, Iterator, Sequence +from types import GenericAlias from typing import Any, AnyStr, Generic, Literal, NamedTuple, TypeVar, overload -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "get_close_matches", "ndiff", @@ -43,19 +40,14 @@ class SequenceMatcher(Generic[_T]): def set_seqs(self, a: Sequence[_T], b: Sequence[_T]) -> None: ... def set_seq1(self, a: Sequence[_T]) -> None: ... def set_seq2(self, b: Sequence[_T]) -> None: ... - if sys.version_info >= (3, 9): - def find_longest_match(self, alo: int = 0, ahi: int | None = None, blo: int = 0, bhi: int | None = None) -> Match: ... - else: - def find_longest_match(self, alo: int, ahi: int, blo: int, bhi: int) -> Match: ... - + def find_longest_match(self, alo: int = 0, ahi: int | None = None, blo: int = 0, bhi: int | None = None) -> Match: ... def get_matching_blocks(self) -> list[Match]: ... def get_opcodes(self) -> list[tuple[Literal["replace", "delete", "insert", "equal"], int, int, int, int]]: ... def get_grouped_opcodes(self, n: int = 3) -> Iterable[list[tuple[str, int, int, int, int]]]: ... def ratio(self) -> float: ... def quick_ratio(self) -> float: ... def real_quick_ratio(self) -> float: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... @overload def get_close_matches(word: AnyStr, possibilities: Iterable[AnyStr], n: int = 3, cutoff: float = 0.6) -> list[AnyStr]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/dis.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/dis.pyi similarity index 77% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/dis.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/dis.pyi index cb69eac89c920..86b6d01e3120d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/dis.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/dis.pyi @@ -106,11 +106,40 @@ class Instruction(_Instruction): def jump_target(self) -> int: ... @property def is_jump_target(self) -> bool: ... + if sys.version_info >= (3, 14): + @staticmethod + def make( + opname: str, + arg: int | None, + argval: Any, + argrepr: str, + offset: int, + start_offset: int, + starts_line: bool, + line_number: int | None, + label: int | None = None, + positions: Positions | None = None, + cache_info: list[tuple[str, int, Any]] | None = None, + ) -> Instruction: ... class Bytecode: codeobj: types.CodeType first_line: int - if sys.version_info >= (3, 13): + if sys.version_info >= (3, 14): + show_positions: bool + # 3.14 added `show_positions` + def __init__( + self, + x: _HaveCodeType | str, + *, + first_line: int | None = None, + current_offset: int | None = None, + show_caches: bool = False, + adaptive: bool = False, + show_offsets: bool = False, + show_positions: bool = False, + ) -> None: ... + elif sys.version_info >= (3, 13): show_offsets: bool # 3.13 added `show_offsets` def __init__( @@ -156,7 +185,39 @@ def findlinestarts(code: _HaveCodeType) -> Iterator[tuple[int, int]]: ... def pretty_flags(flags: int) -> str: ... def code_info(x: _HaveCodeType | str) -> str: ... -if sys.version_info >= (3, 13): +if sys.version_info >= (3, 14): + # 3.14 added `show_positions` + def dis( + x: _HaveCodeType | str | bytes | bytearray | None = None, + *, + file: IO[str] | None = None, + depth: int | None = None, + show_caches: bool = False, + adaptive: bool = False, + show_offsets: bool = False, + show_positions: bool = False, + ) -> None: ... + def disassemble( + co: _HaveCodeType, + lasti: int = -1, + *, + file: IO[str] | None = None, + show_caches: bool = False, + adaptive: bool = False, + show_offsets: bool = False, + show_positions: bool = False, + ) -> None: ... + def distb( + tb: types.TracebackType | None = None, + *, + file: IO[str] | None = None, + show_caches: bool = False, + adaptive: bool = False, + show_offsets: bool = False, + show_positions: bool = False, + ) -> None: ... + +elif sys.version_info >= (3, 13): # 3.13 added `show_offsets` def dis( x: _HaveCodeType | str | bytes | bytearray | None = None, @@ -184,10 +245,6 @@ if sys.version_info >= (3, 13): adaptive: bool = False, show_offsets: bool = False, ) -> None: ... - # 3.13 made `show_cache` `None` by default - def get_instructions( - x: _HaveCodeType, *, first_line: int | None = None, show_caches: bool | None = None, adaptive: bool = False - ) -> Iterator[Instruction]: ... elif sys.version_info >= (3, 11): # 3.11 added `show_caches` and `adaptive` @@ -205,9 +262,6 @@ elif sys.version_info >= (3, 11): def distb( tb: types.TracebackType | None = None, *, file: IO[str] | None = None, show_caches: bool = False, adaptive: bool = False ) -> None: ... - def get_instructions( - x: _HaveCodeType, *, first_line: int | None = None, show_caches: bool = False, adaptive: bool = False - ) -> Iterator[Instruction]: ... else: def dis( @@ -215,6 +269,19 @@ else: ) -> None: ... def disassemble(co: _HaveCodeType, lasti: int = -1, *, file: IO[str] | None = None) -> None: ... def distb(tb: types.TracebackType | None = None, *, file: IO[str] | None = None) -> None: ... + +if sys.version_info >= (3, 13): + # 3.13 made `show_cache` `None` by default + def get_instructions( + x: _HaveCodeType, *, first_line: int | None = None, show_caches: bool | None = None, adaptive: bool = False + ) -> Iterator[Instruction]: ... + +elif sys.version_info >= (3, 11): + def get_instructions( + x: _HaveCodeType, *, first_line: int | None = None, show_caches: bool = False, adaptive: bool = False + ) -> Iterator[Instruction]: ... + +else: def get_instructions(x: _HaveCodeType, *, first_line: int | None = None) -> Iterator[Instruction]: ... def show_code(co: _HaveCodeType, *, file: IO[str] | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/__init__.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/_msvccompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/_msvccompiler.pyi new file mode 100644 index 0000000000000..bba9373b72dbc --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/_msvccompiler.pyi @@ -0,0 +1,13 @@ +from _typeshed import Incomplete +from distutils.ccompiler import CCompiler +from typing import ClassVar, Final + +PLAT_SPEC_TO_RUNTIME: Final[dict[str, str]] +PLAT_TO_VCVARS: Final[dict[str, str]] + +class MSVCCompiler(CCompiler): + compiler_type: ClassVar[str] + executables: ClassVar[dict[Incomplete, Incomplete]] + res_extension: ClassVar[str] + initialized: bool + def initialize(self, plat_name: str | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/archive_util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/archive_util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/archive_util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/archive_util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/bcppcompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/bcppcompiler.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/bcppcompiler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/bcppcompiler.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi index e0f33f430e5a0..5bff209807eef 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/ccompiler.pyi @@ -1,5 +1,5 @@ from _typeshed import BytesPath, StrPath, Unused -from collections.abc import Callable, Iterable +from collections.abc import Callable, Iterable, Sequence from distutils.file_util import _BytesPathT, _StrPathT from typing import Literal, overload from typing_extensions import TypeAlias, TypeVarTuple, Unpack @@ -63,7 +63,7 @@ class CCompiler: def set_executables(self, **args: str) -> None: ... def compile( self, - sources: list[str], + sources: Sequence[StrPath], output_dir: str | None = None, macros: list[_Macro] | None = None, include_dirs: list[str] | None = None, @@ -165,7 +165,7 @@ class CCompiler: def execute( self, func: Callable[[Unpack[_Ts]], Unused], args: tuple[Unpack[_Ts]], msg: str | None = None, level: int = 1 ) -> None: ... - def spawn(self, cmd: list[str]) -> None: ... + def spawn(self, cmd: Iterable[str]) -> None: ... def mkpath(self, name: str, mode: int = 0o777) -> None: ... @overload def move_file(self, src: StrPath, dst: _StrPathT) -> _StrPathT | str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi similarity index 99% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi index dcb423a49b090..a4e77ddf13882 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/cmd.pyi @@ -30,7 +30,7 @@ _CommandT = TypeVar("_CommandT", bound=Command) _Ts = TypeVarTuple("_Ts") class Command: - dry_run: Literal[0, 1] # Exposed from __getattr_. Same as Distribution.dry_run + dry_run: bool | Literal[0, 1] # Exposed from __getattr_. Same as Distribution.dry_run distribution: Distribution # Any to work around variance issues sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi similarity index 75% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi index 43d77087f7d8a..6f996207077e0 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist.pyi @@ -1,6 +1,6 @@ -from _typeshed import Unused +from _typeshed import Incomplete, Unused from collections.abc import Callable -from typing import Any, ClassVar +from typing import ClassVar from ..cmd import Command @@ -15,13 +15,13 @@ class bdist(Command): default_format: ClassVar[dict[str, str]] format_commands: ClassVar[list[str]] format_command: ClassVar[dict[str, tuple[str, str]]] - bdist_base: Any - plat_name: Any - formats: Any - dist_dir: Any + bdist_base: Incomplete + plat_name: Incomplete + formats: Incomplete + dist_dir: Incomplete skip_build: int - group: Any - owner: Any + group: Incomplete + owner: Incomplete def initialize_options(self) -> None: ... def finalize_options(self) -> None: ... def run(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi new file mode 100644 index 0000000000000..297a0c39ed430 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_dumb.pyi @@ -0,0 +1,22 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class bdist_dumb(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + default_format: ClassVar[dict[str, str]] + bdist_dir: Incomplete + plat_name: Incomplete + format: Incomplete + keep_temp: int + dist_dir: Incomplete + skip_build: Incomplete + relative: int + owner: Incomplete + group: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi new file mode 100644 index 0000000000000..d677f81d14251 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_msi.pyi @@ -0,0 +1,45 @@ +import sys +from _typeshed import Incomplete +from typing import ClassVar, Literal + +from ..cmd import Command + +if sys.platform == "win32": + from msilib import Control, Dialog + + class PyDialog(Dialog): + def __init__(self, *args, **kw) -> None: ... + def title(self, title) -> None: ... + def back(self, title, next, name: str = "Back", active: bool | Literal[0, 1] = 1) -> Control: ... + def cancel(self, title, next, name: str = "Cancel", active: bool | Literal[0, 1] = 1) -> Control: ... + def next(self, title, next, name: str = "Next", active: bool | Literal[0, 1] = 1) -> Control: ... + def xbutton(self, name, title, next, xpos) -> Control: ... + + class bdist_msi(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + all_versions: Incomplete + other_version: str + def __init__(self, *args, **kw) -> None: ... + bdist_dir: Incomplete + plat_name: Incomplete + keep_temp: int + no_target_compile: int + no_target_optimize: int + target_version: Incomplete + dist_dir: Incomplete + skip_build: Incomplete + install_script: Incomplete + pre_install_script: Incomplete + versions: Incomplete + def initialize_options(self) -> None: ... + install_script_key: Incomplete + def finalize_options(self) -> None: ... + db: Incomplete + def run(self) -> None: ... + def add_files(self) -> None: ... + def add_find_python(self) -> None: ... + def add_scripts(self) -> None: ... + def add_ui(self) -> None: ... + def get_installer_filename(self, fullname): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc_data/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_packager.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc_data/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_packager.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi new file mode 100644 index 0000000000000..83b4161094c51 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_rpm.pyi @@ -0,0 +1,53 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class bdist_rpm(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + negative_opt: ClassVar[dict[str, str]] + bdist_base: Incomplete + rpm_base: Incomplete + dist_dir: Incomplete + python: Incomplete + fix_python: Incomplete + spec_only: Incomplete + binary_only: Incomplete + source_only: Incomplete + use_bzip2: Incomplete + distribution_name: Incomplete + group: Incomplete + release: Incomplete + serial: Incomplete + vendor: Incomplete + packager: Incomplete + doc_files: Incomplete + changelog: Incomplete + icon: Incomplete + prep_script: Incomplete + build_script: Incomplete + install_script: Incomplete + clean_script: Incomplete + verify_script: Incomplete + pre_install: Incomplete + post_install: Incomplete + pre_uninstall: Incomplete + post_uninstall: Incomplete + prep: Incomplete + provides: Incomplete + requires: Incomplete + conflicts: Incomplete + build_requires: Incomplete + obsoletes: Incomplete + keep_temp: int + use_rpm_opt_flags: int + rpm3_mode: int + no_autoreq: int + force_arch: Incomplete + quiet: int + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def finalize_package_data(self) -> None: ... + def run(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_wininst.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_wininst.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/bdist_wininst.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/bdist_wininst.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi new file mode 100644 index 0000000000000..3ec0c9614d62a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build.pyi @@ -0,0 +1,34 @@ +from _typeshed import Incomplete, Unused +from collections.abc import Callable +from typing import Any, ClassVar + +from ..cmd import Command + +def show_compilers() -> None: ... + +class build(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] + build_base: str + build_purelib: Incomplete + build_platlib: Incomplete + build_lib: Incomplete + build_temp: Incomplete + build_scripts: Incomplete + compiler: Incomplete + plat_name: Incomplete + debug: Incomplete + force: int + executable: Incomplete + parallel: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def has_pure_modules(self): ... + def has_c_libraries(self): ... + def has_ext_modules(self): ... + def has_scripts(self): ... + # Any to work around variance issues + sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi new file mode 100644 index 0000000000000..69cfbe7120d8e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_clib.pyi @@ -0,0 +1,29 @@ +from _typeshed import Incomplete, Unused +from collections.abc import Callable +from typing import ClassVar + +from ..cmd import Command + +def show_compilers() -> None: ... + +class build_clib(Command): + description: str + user_options: ClassVar[list[tuple[str, str, str]]] + boolean_options: ClassVar[list[str]] + help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] + build_clib: Incomplete + build_temp: Incomplete + libraries: Incomplete + include_dirs: Incomplete + define: Incomplete + undef: Incomplete + debug: Incomplete + force: int + compiler: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def check_library_list(self, libraries) -> None: ... + def get_library_names(self): ... + def get_source_files(self): ... + def build_libraries(self, libraries) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi new file mode 100644 index 0000000000000..c5a9b5d508f0d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_ext.pyi @@ -0,0 +1,52 @@ +from _typeshed import Incomplete, Unused +from collections.abc import Callable +from typing import ClassVar + +from ..cmd import Command + +extension_name_re: Incomplete + +def show_compilers() -> None: ... + +class build_ext(Command): + description: str + sep_by: Incomplete + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + help_options: ClassVar[list[tuple[str, str | None, str, Callable[[], Unused]]]] + extensions: Incomplete + build_lib: Incomplete + plat_name: Incomplete + build_temp: Incomplete + inplace: int + package: Incomplete + include_dirs: Incomplete + define: Incomplete + undef: Incomplete + libraries: Incomplete + library_dirs: Incomplete + rpath: Incomplete + link_objects: Incomplete + debug: Incomplete + force: Incomplete + compiler: Incomplete + swig: Incomplete + swig_cpp: Incomplete + swig_opts: Incomplete + user: Incomplete + parallel: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def check_extensions_list(self, extensions) -> None: ... + def get_source_files(self): ... + def get_outputs(self): ... + def build_extensions(self) -> None: ... + def build_extension(self, ext) -> None: ... + def swig_sources(self, sources, extension): ... + def find_swig(self): ... + def get_ext_fullpath(self, ext_name: str) -> str: ... + def get_ext_fullname(self, ext_name: str) -> str: ... + def get_ext_filename(self, ext_name: str) -> str: ... + def get_export_symbols(self, ext): ... + def get_libraries(self, ext): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi similarity index 79% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi index 90f06751416a6..23ed230bb2d8c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_py.pyi @@ -1,4 +1,5 @@ -from typing import Any, ClassVar, Literal +from _typeshed import Incomplete +from typing import ClassVar, Literal from ..cmd import Command from ..util import Mixin2to3 as Mixin2to3 @@ -8,17 +9,17 @@ class build_py(Command): user_options: ClassVar[list[tuple[str, str | None, str]]] boolean_options: ClassVar[list[str]] negative_opt: ClassVar[dict[str, str]] - build_lib: Any - py_modules: Any - package: Any - package_data: Any - package_dir: Any + build_lib: Incomplete + py_modules: Incomplete + package: Incomplete + package_data: Incomplete + package_dir: Incomplete compile: int optimize: int - force: Any + force: Incomplete def initialize_options(self) -> None: ... - packages: Any - data_files: Any + packages: Incomplete + data_files: Incomplete def finalize_options(self) -> None: ... def run(self) -> None: ... def get_data_files(self): ... @@ -32,13 +33,13 @@ class build_py(Command): def find_all_modules(self): ... def get_source_files(self): ... def get_module_outfile(self, build_dir, package, module): ... - def get_outputs(self, include_bytecode: bool | Literal[0, 1] = 1): ... + def get_outputs(self, include_bytecode: bool | Literal[0, 1] = 1) -> list[str]: ... def build_module(self, module, module_file, package): ... def build_modules(self) -> None: ... def build_packages(self) -> None: ... def byte_compile(self, files) -> None: ... class build_py_2to3(build_py, Mixin2to3): - updated_files: Any + updated_files: Incomplete def run(self) -> None: ... def build_module(self, module, module_file, package): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi new file mode 100644 index 0000000000000..8372919bbd530 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/build_scripts.pyi @@ -0,0 +1,25 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command +from ..util import Mixin2to3 as Mixin2to3 + +first_line_re: Incomplete + +class build_scripts(Command): + description: str + user_options: ClassVar[list[tuple[str, str, str]]] + boolean_options: ClassVar[list[str]] + build_dir: Incomplete + scripts: Incomplete + force: Incomplete + executable: Incomplete + outfiles: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def get_source_files(self): ... + def run(self) -> None: ... + def copy_scripts(self): ... + +class build_scripts_2to3(build_scripts, Mixin2to3): + def copy_scripts(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi index e69627d20c7a0..2c807fd2c4396 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/check.pyi @@ -1,3 +1,4 @@ +from _typeshed import Incomplete from typing import Any, ClassVar, Final, Literal from typing_extensions import TypeAlias @@ -9,13 +10,13 @@ _Reporter: TypeAlias = Any # really docutils.utils.Reporter # Depends on a third-party stub. Since distutils is deprecated anyway, # it's easier to just suppress the "any subclassing" error. class SilentReporter(_Reporter): - messages: Any + messages: Incomplete def __init__( self, source, report_level, halt_level, - stream: Any | None = ..., + stream: Incomplete | None = ..., debug: bool | Literal[0, 1] = 0, encoding: str = ..., error_handler: str = ..., diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi new file mode 100644 index 0000000000000..0f3768d6dcf4d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/clean.pyi @@ -0,0 +1,18 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class clean(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + build_base: Incomplete + build_lib: Incomplete + build_temp: Incomplete + build_scripts: Incomplete + bdist_base: Incomplete + all: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi new file mode 100644 index 0000000000000..562ff3a5271f8 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/config.pyi @@ -0,0 +1,84 @@ +from _typeshed import Incomplete, StrOrBytesPath +from collections.abc import Sequence +from re import Pattern +from typing import ClassVar, Final, Literal + +from ..ccompiler import CCompiler +from ..cmd import Command + +LANG_EXT: Final[dict[str, str]] + +class config(Command): + description: str + # Tuple is full name, short name, description + user_options: ClassVar[list[tuple[str, str | None, str]]] + compiler: str | CCompiler + cc: str | None + include_dirs: Sequence[str] | None + libraries: Sequence[str] | None + library_dirs: Sequence[str] | None + noisy: int + dump_source: int + temp_files: Sequence[str] + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def try_cpp( + self, + body: str | None = None, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + lang: str = "c", + ) -> bool: ... + def search_cpp( + self, + pattern: Pattern[str] | str, + body: str | None = None, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + lang: str = "c", + ) -> bool: ... + def try_compile( + self, body: str, headers: Sequence[str] | None = None, include_dirs: Sequence[str] | None = None, lang: str = "c" + ) -> bool: ... + def try_link( + self, + body: str, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + libraries: Sequence[str] | None = None, + library_dirs: Sequence[str] | None = None, + lang: str = "c", + ) -> bool: ... + def try_run( + self, + body: str, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + libraries: Sequence[str] | None = None, + library_dirs: Sequence[str] | None = None, + lang: str = "c", + ) -> bool: ... + def check_func( + self, + func: str, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + libraries: Sequence[str] | None = None, + library_dirs: Sequence[str] | None = None, + decl: bool | Literal[0, 1] = 0, + call: bool | Literal[0, 1] = 0, + ) -> bool: ... + def check_lib( + self, + library: str, + library_dirs: Sequence[str] | None = None, + headers: Sequence[str] | None = None, + include_dirs: Sequence[str] | None = None, + other_libraries: list[str] = [], + ) -> bool: ... + def check_header( + self, header: str, include_dirs: Sequence[str] | None = None, library_dirs: Sequence[str] | None = None, lang: str = "c" + ) -> bool: ... + +def dump_file(filename: StrOrBytesPath, head: Incomplete | None = None) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi new file mode 100644 index 0000000000000..1714e01a2c284 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install.pyi @@ -0,0 +1,71 @@ +import sys +from _typeshed import Incomplete +from collections.abc import Callable +from typing import Any, ClassVar, Final, Literal + +from ..cmd import Command + +HAS_USER_SITE: Final[bool] + +SCHEME_KEYS: Final[tuple[Literal["purelib"], Literal["platlib"], Literal["headers"], Literal["scripts"], Literal["data"]]] +INSTALL_SCHEMES: Final[dict[str, dict[str, str]]] + +if sys.version_info < (3, 10): + WINDOWS_SCHEME: Final[dict[str, str]] + +class install(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + negative_opt: ClassVar[dict[str, str]] + prefix: str | None + exec_prefix: Incomplete + home: str | None + user: bool + install_base: Incomplete + install_platbase: Incomplete + root: str | None + install_purelib: Incomplete + install_platlib: Incomplete + install_headers: Incomplete + install_lib: str | None + install_scripts: Incomplete + install_data: Incomplete + install_userbase: Incomplete + install_usersite: Incomplete + compile: Incomplete + optimize: Incomplete + extra_path: Incomplete + install_path_file: int + force: int + skip_build: int + warn_dir: int + build_base: Incomplete + build_lib: Incomplete + record: Incomplete + def initialize_options(self) -> None: ... + config_vars: Incomplete + install_libbase: Incomplete + def finalize_options(self) -> None: ... + def dump_dirs(self, msg) -> None: ... + def finalize_unix(self) -> None: ... + def finalize_other(self) -> None: ... + def select_scheme(self, name) -> None: ... + def expand_basedirs(self) -> None: ... + def expand_dirs(self) -> None: ... + def convert_paths(self, *names) -> None: ... + path_file: Incomplete + extra_dirs: Incomplete + def handle_extra_path(self) -> None: ... + def change_roots(self, *names) -> None: ... + def create_home_path(self) -> None: ... + def run(self) -> None: ... + def create_path_file(self) -> None: ... + def get_outputs(self): ... + def get_inputs(self): ... + def has_lib(self): ... + def has_headers(self): ... + def has_scripts(self): ... + def has_data(self): ... + # Any to work around variance issues + sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi new file mode 100644 index 0000000000000..609de62b04b52 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_data.pyi @@ -0,0 +1,20 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class install_data(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + install_dir: Incomplete + outfiles: Incomplete + root: Incomplete + force: int + data_files: Incomplete + warn_dir: int + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def get_inputs(self): ... + def get_outputs(self): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi new file mode 100644 index 0000000000000..75bb906ce5824 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_egg_info.pyi @@ -0,0 +1,19 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class install_egg_info(Command): + description: ClassVar[str] + user_options: ClassVar[list[tuple[str, str, str]]] + install_dir: Incomplete + def initialize_options(self) -> None: ... + target: Incomplete + outputs: Incomplete + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def get_outputs(self) -> list[str]: ... + +def safe_name(name): ... +def safe_version(version): ... +def to_filename(name): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi similarity index 76% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi index 7854d2393a987..3caad8a07dca4 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_headers.pyi @@ -1,4 +1,5 @@ -from typing import Any, ClassVar +from _typeshed import Incomplete +from typing import ClassVar from ..cmd import Command @@ -6,9 +7,9 @@ class install_headers(Command): description: str user_options: ClassVar[list[tuple[str, str, str]]] boolean_options: ClassVar[list[str]] - install_dir: Any + install_dir: Incomplete force: int - outfiles: Any + outfiles: Incomplete def initialize_options(self) -> None: ... def finalize_options(self) -> None: ... def run(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi new file mode 100644 index 0000000000000..a537e254904aa --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_lib.pyi @@ -0,0 +1,26 @@ +from _typeshed import Incomplete +from typing import ClassVar, Final + +from ..cmd import Command + +PYTHON_SOURCE_EXTENSION: Final = ".py" + +class install_lib(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + negative_opt: ClassVar[dict[str, str]] + install_dir: Incomplete + build_dir: Incomplete + force: int + compile: Incomplete + optimize: Incomplete + skip_build: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def build(self) -> None: ... + def install(self): ... + def byte_compile(self, files) -> None: ... + def get_outputs(self): ... + def get_inputs(self): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi new file mode 100644 index 0000000000000..658594f32e43c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/install_scripts.pyi @@ -0,0 +1,19 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..cmd import Command + +class install_scripts(Command): + description: str + user_options: ClassVar[list[tuple[str, str | None, str]]] + boolean_options: ClassVar[list[str]] + install_dir: Incomplete + force: int + build_dir: Incomplete + skip_build: Incomplete + def initialize_options(self) -> None: ... + def finalize_options(self) -> None: ... + outfiles: Incomplete + def run(self) -> None: ... + def get_inputs(self): ... + def get_outputs(self): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi index a5e251d2d01e8..cf98e178a9ba1 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/register.pyi @@ -1,3 +1,4 @@ +from _typeshed import Incomplete from collections.abc import Callable from typing import Any, ClassVar @@ -17,4 +18,4 @@ class register(PyPIRCCommand): def verify_metadata(self) -> None: ... def send_metadata(self) -> None: ... def build_post_data(self, action): ... - def post_to_server(self, data, auth: Any | None = None): ... + def post_to_server(self, data, auth: Incomplete | None = None): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi index 5b7fe24195519..48a140714dda7 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/sdist.pyi @@ -1,4 +1,4 @@ -from _typeshed import Unused +from _typeshed import Incomplete, Unused from collections.abc import Callable from typing import Any, ClassVar @@ -16,22 +16,22 @@ class sdist(Command): # Any to work around variance issues sub_commands: ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] READMES: ClassVar[tuple[str, ...]] - template: Any - manifest: Any + template: Incomplete + manifest: Incomplete use_defaults: int prune: int manifest_only: int force_manifest: int - formats: Any + formats: Incomplete keep_temp: int - dist_dir: Any - archive_files: Any + dist_dir: Incomplete + archive_files: Incomplete metadata_check: int - owner: Any - group: Any + owner: Incomplete + group: Incomplete def initialize_options(self) -> None: ... def finalize_options(self) -> None: ... - filelist: Any + filelist: Incomplete def run(self) -> None: ... def check_metadata(self) -> None: ... def get_file_list(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi new file mode 100644 index 0000000000000..afcfbaf48677e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/command/upload.pyi @@ -0,0 +1,18 @@ +from _typeshed import Incomplete +from typing import ClassVar + +from ..config import PyPIRCCommand + +class upload(PyPIRCCommand): + description: ClassVar[str] + username: str + password: str + show_response: int + sign: bool + identity: Incomplete + def initialize_options(self) -> None: ... + repository: Incomplete + realm: Incomplete + def finalize_options(self) -> None: ... + def run(self) -> None: ... + def upload_file(self, command: str, pyversion: str, filename: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/config.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/config.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/config.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/config.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/core.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/core.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/core.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/core.pyi index a4d21f8ddd7b8..174f249913514 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/core.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/core.pyi @@ -1,4 +1,4 @@ -from _typeshed import StrOrBytesPath +from _typeshed import Incomplete, StrOrBytesPath from collections.abc import Mapping from distutils.cmd import Command as Command from distutils.dist import Distribution as Distribution @@ -32,7 +32,7 @@ def setup( distclass: type[Distribution] = ..., script_name: str = ..., script_args: list[str] = ..., - options: Mapping[str, Any] = ..., + options: Mapping[str, Incomplete] = ..., license: str = ..., keywords: list[str] | str = ..., platforms: list[str] | str = ..., @@ -43,7 +43,7 @@ def setup( provides: list[str] = ..., requires: list[str] = ..., command_packages: list[str] = ..., - command_options: Mapping[str, Mapping[str, tuple[Any, Any]]] = ..., + command_options: Mapping[str, Mapping[str, tuple[Incomplete, Incomplete]]] = ..., package_data: Mapping[str, list[str]] = ..., include_package_data: bool | Literal[0, 1] = ..., libraries: list[str] = ..., @@ -52,6 +52,7 @@ def setup( include_dirs: list[str] = ..., password: str = ..., fullname: str = ..., + # Custom Distributions could accept more params **attrs: Any, ) -> Distribution: ... def run_setup(script_name: str, script_args: list[str] | None = None, stop_after: str = "run") -> Distribution: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/cygwinccompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/cygwinccompiler.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/cygwinccompiler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/cygwinccompiler.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/debug.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/debug.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/debug.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/debug.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dep_util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/dep_util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dep_util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/dep_util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dir_util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/dir_util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dir_util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/dir_util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dist.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/dist.pyi similarity index 99% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dist.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/dist.pyi index 75fc7dbb388d6..09f2b456d2635 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/dist.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/dist.pyi @@ -88,9 +88,9 @@ class Distribution: display_options: ClassVar[_OptionsList] display_option_names: ClassVar[list[str]] negative_opt: ClassVar[dict[str, str]] - verbose: Literal[0, 1] - dry_run: Literal[0, 1] - help: Literal[0, 1] + verbose: bool | Literal[0, 1] + dry_run: bool | Literal[0, 1] + help: bool | Literal[0, 1] command_packages: list[str] | None script_name: str | None script_args: list[str] | None diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/errors.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/errors.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/errors.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/errors.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/extension.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/extension.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/extension.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/extension.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi new file mode 100644 index 0000000000000..f3fa2a1255a6d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/fancy_getopt.pyi @@ -0,0 +1,44 @@ +from collections.abc import Iterable, Mapping +from getopt import _SliceableT, _StrSequenceT_co +from re import Pattern +from typing import Any, Final, overload +from typing_extensions import TypeAlias + +_Option: TypeAlias = tuple[str, str | None, str] + +longopt_pat: Final = r"[a-zA-Z](?:[a-zA-Z0-9-]*)" +longopt_re: Final[Pattern[str]] +neg_alias_re: Final[Pattern[str]] +longopt_xlate: Final[dict[int, int]] + +class FancyGetopt: + def __init__(self, option_table: list[_Option] | None = None) -> None: ... + # TODO: kinda wrong, `getopt(object=object())` is invalid + @overload + def getopt( + self, args: _SliceableT[_StrSequenceT_co] | None = None, object: None = None + ) -> tuple[_StrSequenceT_co, OptionDummy]: ... + @overload + def getopt( + self, args: _SliceableT[_StrSequenceT_co] | None, object: Any + ) -> _StrSequenceT_co: ... # object is an arbitrary non-slotted object + def get_option_order(self) -> list[tuple[str, str]]: ... + def generate_help(self, header: str | None = None) -> list[str]: ... + +# Same note as FancyGetopt.getopt +@overload +def fancy_getopt( + options: list[_Option], negative_opt: Mapping[_Option, _Option], object: None, args: _SliceableT[_StrSequenceT_co] | None +) -> tuple[_StrSequenceT_co, OptionDummy]: ... +@overload +def fancy_getopt( + options: list[_Option], negative_opt: Mapping[_Option, _Option], object: Any, args: _SliceableT[_StrSequenceT_co] | None +) -> _StrSequenceT_co: ... + +WS_TRANS: Final[dict[int, str]] + +def wrap_text(text: str, width: int) -> list[str]: ... +def translate_longopt(opt: str) -> str: ... + +class OptionDummy: + def __init__(self, options: Iterable[str] = []) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/file_util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/file_util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/file_util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/file_util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/filelist.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/filelist.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/filelist.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/filelist.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/log.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/log.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/log.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/log.pyi index 0ea135c283718..7246dd6be0cdf 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/log.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/log.pyi @@ -8,6 +8,7 @@ FATAL: Final = 5 class Log: def __init__(self, threshold: int = 3) -> None: ... + # Arbitrary msg args' type depends on the format method def log(self, level: int, msg: str, *args: Any) -> None: ... def debug(self, msg: str, *args: Any) -> None: ... def info(self, msg: str, *args: Any) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/msvccompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/msvccompiler.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/msvccompiler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/msvccompiler.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi new file mode 100644 index 0000000000000..ae07a49504fe1 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/spawn.pyi @@ -0,0 +1,10 @@ +from collections.abc import Iterable +from typing import Literal + +def spawn( + cmd: Iterable[str], + search_path: bool | Literal[0, 1] = 1, + verbose: bool | Literal[0, 1] = 0, + dry_run: bool | Literal[0, 1] = 0, +) -> None: ... +def find_executable(executable: str, path: str | None = None) -> str | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/sysconfig.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/sysconfig.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/sysconfig.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/sysconfig.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/text_file.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/text_file.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/text_file.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/text_file.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/unixccompiler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/unixccompiler.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/unixccompiler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/unixccompiler.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/version.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/distutils/version.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/distutils/version.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/distutils/version.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/doctest.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/doctest.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/doctest.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/doctest.pyi index 4380083027a6b..562b5a5bdac9e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/doctest.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/doctest.pyi @@ -3,7 +3,7 @@ import types import unittest from _typeshed import ExcInfo from collections.abc import Callable -from typing import Any, ClassVar, NamedTuple +from typing import Any, NamedTuple, type_check_only from typing_extensions import Self, TypeAlias __all__ = [ @@ -42,17 +42,15 @@ __all__ = [ "debug", ] -# MyPy errors on conditionals within named tuples. - if sys.version_info >= (3, 13): - class TestResults(NamedTuple): - def __new__(cls, failed: int, attempted: int, *, skipped: int = 0) -> Self: ... # type: ignore[misc] - skipped: int + @type_check_only + class _TestResultsBase(NamedTuple): failed: int attempted: int - _fields: ClassVar = ("failed", "attempted") # type: ignore[misc] - __match_args__ = ("failed", "attempted") # type: ignore[misc] - __doc__: None # type: ignore[misc] + + class TestResults(_TestResultsBase): + def __new__(cls, failed: int, attempted: int, *, skipped: int = 0) -> Self: ... + skipped: int else: class TestResults(NamedTuple): diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/__init__.pyi new file mode 100644 index 0000000000000..53f8c350b01e3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/__init__.pyi @@ -0,0 +1,60 @@ +from collections.abc import Callable +from email._policybase import _MessageT +from email.message import Message +from email.policy import Policy +from typing import IO, overload +from typing_extensions import TypeAlias + +# At runtime, listing submodules in __all__ without them being imported is +# valid, and causes them to be included in a star import. See #6523 + +__all__ = [ # noqa: F822 # Undefined names in __all__ + "base64mime", # pyright: ignore[reportUnsupportedDunderAll] + "charset", # pyright: ignore[reportUnsupportedDunderAll] + "encoders", # pyright: ignore[reportUnsupportedDunderAll] + "errors", # pyright: ignore[reportUnsupportedDunderAll] + "feedparser", # pyright: ignore[reportUnsupportedDunderAll] + "generator", # pyright: ignore[reportUnsupportedDunderAll] + "header", # pyright: ignore[reportUnsupportedDunderAll] + "iterators", # pyright: ignore[reportUnsupportedDunderAll] + "message", # pyright: ignore[reportUnsupportedDunderAll] + "message_from_file", + "message_from_binary_file", + "message_from_string", + "message_from_bytes", + "mime", # pyright: ignore[reportUnsupportedDunderAll] + "parser", # pyright: ignore[reportUnsupportedDunderAll] + "quoprimime", # pyright: ignore[reportUnsupportedDunderAll] + "utils", # pyright: ignore[reportUnsupportedDunderAll] +] + +# Definitions imported by multiple submodules in typeshed +_ParamType: TypeAlias = str | tuple[str | None, str | None, str] # noqa: Y047 +_ParamsType: TypeAlias = str | None | tuple[str, str | None, str] # noqa: Y047 + +@overload +def message_from_string(s: str) -> Message: ... +@overload +def message_from_string(s: str, _class: Callable[[], _MessageT]) -> _MessageT: ... +@overload +def message_from_string(s: str, _class: Callable[[], _MessageT] = ..., *, policy: Policy[_MessageT]) -> _MessageT: ... +@overload +def message_from_bytes(s: bytes | bytearray) -> Message: ... +@overload +def message_from_bytes(s: bytes | bytearray, _class: Callable[[], _MessageT]) -> _MessageT: ... +@overload +def message_from_bytes( + s: bytes | bytearray, _class: Callable[[], _MessageT] = ..., *, policy: Policy[_MessageT] +) -> _MessageT: ... +@overload +def message_from_file(fp: IO[str]) -> Message: ... +@overload +def message_from_file(fp: IO[str], _class: Callable[[], _MessageT]) -> _MessageT: ... +@overload +def message_from_file(fp: IO[str], _class: Callable[[], _MessageT] = ..., *, policy: Policy[_MessageT]) -> _MessageT: ... +@overload +def message_from_binary_file(fp: IO[bytes]) -> Message: ... +@overload +def message_from_binary_file(fp: IO[bytes], _class: Callable[[], _MessageT]) -> _MessageT: ... +@overload +def message_from_binary_file(fp: IO[bytes], _class: Callable[[], _MessageT] = ..., *, policy: Policy[_MessageT]) -> _MessageT: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi index ff405a8b61d22..a8abfead92172 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/_header_value_parser.pyi @@ -1,3 +1,4 @@ +import sys from collections.abc import Iterable, Iterator from email.errors import HeaderParseError, MessageDefect from email.policy import Policy @@ -16,11 +17,15 @@ TOKEN_ENDS: Final[set[str]] ASPECIALS: Final[set[str]] ATTRIBUTE_ENDS: Final[set[str]] EXTENDED_ATTRIBUTE_ENDS: Final[set[str]] -# Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 +# Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 NLSET: Final[set[str]] -# Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 +# Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 SPECIALSNL: Final[set[str]] +if sys.version_info >= (3, 10): + # Added in Python 3.10.17, 3.11.12, 3.12.9, 3.13.2 (may still be backported to 3.9) + def make_quoted_pairs(value: Any) -> str: ... + def quote_string(value: Any) -> str: ... rfc2047_matcher: Pattern[str] @@ -345,7 +350,7 @@ ListSeparator: Final[ValueTerminal] RouteComponentMarker: Final[ValueTerminal] def get_fws(value: str) -> tuple[WhiteSpaceTerminal, str]: ... -def get_encoded_word(value: str) -> tuple[EncodedWord, str]: ... +def get_encoded_word(value: str, terminal_type: str = "vtext") -> tuple[EncodedWord, str]: ... def get_unstructured(value: str) -> UnstructuredTokenList: ... def get_qp_ctext(value: str) -> tuple[WhiteSpaceTerminal, str]: ... def get_qcontent(value: str) -> tuple[ValueTerminal, str]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/_policybase.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/_policybase.pyi new file mode 100644 index 0000000000000..0fb890d424b10 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/_policybase.pyi @@ -0,0 +1,80 @@ +from abc import ABCMeta, abstractmethod +from email.errors import MessageDefect +from email.header import Header +from email.message import Message +from typing import Any, Generic, Protocol, TypeVar, type_check_only +from typing_extensions import Self + +__all__ = ["Policy", "Compat32", "compat32"] + +_MessageT = TypeVar("_MessageT", bound=Message[Any, Any], default=Message[str, str]) +_MessageT_co = TypeVar("_MessageT_co", covariant=True, bound=Message[Any, Any], default=Message[str, str]) + +@type_check_only +class _MessageFactory(Protocol[_MessageT]): + def __call__(self, policy: Policy[_MessageT]) -> _MessageT: ... + +# Policy below is the only known direct subclass of _PolicyBase. We therefore +# assume that the __init__ arguments and attributes of _PolicyBase are +# the same as those of Policy. +class _PolicyBase(Generic[_MessageT_co]): + max_line_length: int | None + linesep: str + cte_type: str + raise_on_defect: bool + mangle_from_: bool + message_factory: _MessageFactory[_MessageT_co] | None + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool + + def __init__( + self, + *, + max_line_length: int | None = 78, + linesep: str = "\n", + cte_type: str = "8bit", + raise_on_defect: bool = False, + mangle_from_: bool = ..., # default depends on sub-class + message_factory: _MessageFactory[_MessageT_co] | None = None, + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool = True, + ) -> None: ... + def clone( + self, + *, + max_line_length: int | None = ..., + linesep: str = ..., + cte_type: str = ..., + raise_on_defect: bool = ..., + mangle_from_: bool = ..., + message_factory: _MessageFactory[_MessageT_co] | None = ..., + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool = ..., + ) -> Self: ... + def __add__(self, other: Policy) -> Self: ... + +class Policy(_PolicyBase[_MessageT_co], metaclass=ABCMeta): + # Every Message object has a `defects` attribute, so the following + # methods will work for any Message object. + def handle_defect(self, obj: Message[Any, Any], defect: MessageDefect) -> None: ... + def register_defect(self, obj: Message[Any, Any], defect: MessageDefect) -> None: ... + def header_max_count(self, name: str) -> int | None: ... + @abstractmethod + def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... + @abstractmethod + def header_store_parse(self, name: str, value: str) -> tuple[str, str]: ... + @abstractmethod + def header_fetch_parse(self, name: str, value: str) -> str: ... + @abstractmethod + def fold(self, name: str, value: str) -> str: ... + @abstractmethod + def fold_binary(self, name: str, value: str) -> bytes: ... + +class Compat32(Policy[_MessageT_co]): + def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... + def header_store_parse(self, name: str, value: str) -> tuple[str, str]: ... + def header_fetch_parse(self, name: str, value: str) -> str | Header: ... # type: ignore[override] + def fold(self, name: str, value: str) -> str: ... + def fold_binary(self, name: str, value: str) -> bytes: ... + +compat32: Compat32[Message[str, str]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/base64mime.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/base64mime.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/base64mime.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/base64mime.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/charset.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/charset.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/charset.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/charset.pyi index 2939192c95264..683daa468cf3b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/charset.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/charset.pyi @@ -1,6 +1,6 @@ from collections.abc import Callable, Iterator from email.message import Message -from typing import Final, overload +from typing import ClassVar, Final, overload __all__ = ["Charset", "add_alias", "add_charset", "add_codec"] @@ -24,6 +24,7 @@ class Charset: def body_encode(self, string: None) -> None: ... @overload def body_encode(self, string: str | bytes) -> str: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __eq__(self, other: object) -> bool: ... def __ne__(self, value: object, /) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/contentmanager.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/contentmanager.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/contentmanager.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/contentmanager.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/encoders.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/encoders.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/encoders.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/encoders.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/errors.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/errors.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/errors.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/errors.pyi index f105576c5ee49..b501a58665560 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/errors.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/errors.pyi @@ -7,7 +7,7 @@ class BoundaryError(MessageParseError): ... class MultipartConversionError(MessageError, TypeError): ... class CharsetError(MessageError): ... -# Added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 +# Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 class HeaderWriteError(MessageError): ... class MessageDefect(ValueError): diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/feedparser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/feedparser.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/feedparser.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/feedparser.pyi index 8c268ca1ae18c..d9279e9cd996d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/feedparser.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/feedparser.pyi @@ -1,12 +1,11 @@ from collections.abc import Callable +from email._policybase import _MessageT from email.message import Message from email.policy import Policy -from typing import Generic, TypeVar, overload +from typing import Generic, overload __all__ = ["FeedParser", "BytesFeedParser"] -_MessageT = TypeVar("_MessageT", bound=Message, default=Message) - class FeedParser(Generic[_MessageT]): @overload def __init__(self: FeedParser[Message], _factory: None = None, *, policy: Policy[Message] = ...) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/generator.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/generator.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/generator.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/generator.pyi index dfa0604a20a98..d30e686299fab 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/generator.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/generator.pyi @@ -7,7 +7,7 @@ from typing_extensions import Self __all__ = ["Generator", "DecodedGenerator", "BytesGenerator"] # By default, generators do not have a message policy. -_MessageT = TypeVar("_MessageT", bound=Message, default=Any) +_MessageT = TypeVar("_MessageT", bound=Message[Any, Any], default=Any) class Generator(Generic[_MessageT]): maxheaderlen: int | None diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/header.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/header.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/header.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/header.pyi index 212132c6be18f..a26bbb516e096 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/header.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/header.pyi @@ -1,6 +1,6 @@ from collections.abc import Iterable from email.charset import Charset -from typing import Any +from typing import Any, ClassVar __all__ = ["Header", "decode_header", "make_header"] @@ -16,6 +16,7 @@ class Header: ) -> None: ... def append(self, s: bytes | bytearray | str, charset: Charset | str | None = None, errors: str = "strict") -> None: ... def encode(self, splitchars: str = ";, \t", maxlinelen: int | None = None, linesep: str = "\n") -> str: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __eq__(self, other: object) -> bool: ... def __ne__(self, value: object, /) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi index 2ffdca9b2f229..dc641c8c952b3 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/headerregistry.pyi @@ -167,6 +167,7 @@ class Address: def __init__( self, display_name: str = "", username: str | None = "", domain: str | None = "", addr_spec: str | None = None ) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __eq__(self, other: object) -> bool: ... class Group: @@ -175,4 +176,5 @@ class Group: @property def addresses(self) -> tuple[Address, ...]: ... def __init__(self, display_name: str | None = None, addresses: Iterable[Address] | None = None) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __eq__(self, other: object) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/iterators.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/iterators.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/iterators.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/iterators.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/message.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/message.pyi new file mode 100644 index 0000000000000..e4d14992168a1 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/message.pyi @@ -0,0 +1,172 @@ +from _typeshed import MaybeNone +from collections.abc import Generator, Iterator, Sequence +from email import _ParamsType, _ParamType +from email.charset import Charset +from email.contentmanager import ContentManager +from email.errors import MessageDefect +from email.policy import Policy +from typing import Any, Generic, Literal, Protocol, TypeVar, overload +from typing_extensions import Self, TypeAlias + +__all__ = ["Message", "EmailMessage"] + +_T = TypeVar("_T") +# Type returned by Policy.header_fetch_parse, often str or Header. +_HeaderT_co = TypeVar("_HeaderT_co", covariant=True, default=str) +_HeaderParamT_contra = TypeVar("_HeaderParamT_contra", contravariant=True, default=str) +# Represents headers constructed by HeaderRegistry. Those are sub-classes +# of BaseHeader and another header type. +_HeaderRegistryT_co = TypeVar("_HeaderRegistryT_co", covariant=True, default=Any) +_HeaderRegistryParamT_contra = TypeVar("_HeaderRegistryParamT_contra", contravariant=True, default=Any) + +_PayloadType: TypeAlias = Message | str +_EncodedPayloadType: TypeAlias = Message | bytes +_MultipartPayloadType: TypeAlias = list[_PayloadType] +_CharsetType: TypeAlias = Charset | str | None + +class _SupportsEncodeToPayload(Protocol): + def encode(self, encoding: str, /) -> _PayloadType | _MultipartPayloadType | _SupportsDecodeToPayload: ... + +class _SupportsDecodeToPayload(Protocol): + def decode(self, encoding: str, errors: str, /) -> _PayloadType | _MultipartPayloadType: ... + +class Message(Generic[_HeaderT_co, _HeaderParamT_contra]): + # The policy attributes and arguments in this class and its subclasses + # would ideally use Policy[Self], but this is not possible. + policy: Policy[Any] # undocumented + preamble: str | None + epilogue: str | None + defects: list[MessageDefect] + def __init__(self, policy: Policy[Any] = ...) -> None: ... + def is_multipart(self) -> bool: ... + def set_unixfrom(self, unixfrom: str) -> None: ... + def get_unixfrom(self) -> str | None: ... + def attach(self, payload: _PayloadType) -> None: ... + # `i: int` without a multipart payload results in an error + # `| MaybeNone` acts like `| Any`: can be None for cleared or unset payload, but annoying to check + @overload # multipart + def get_payload(self, i: int, decode: Literal[True]) -> None: ... + @overload # multipart + def get_payload(self, i: int, decode: Literal[False] = False) -> _PayloadType | MaybeNone: ... + @overload # either + def get_payload(self, i: None = None, decode: Literal[False] = False) -> _PayloadType | _MultipartPayloadType | MaybeNone: ... + @overload # not multipart + def get_payload(self, i: None = None, *, decode: Literal[True]) -> _EncodedPayloadType | MaybeNone: ... + @overload # not multipart, IDEM but w/o kwarg + def get_payload(self, i: None, decode: Literal[True]) -> _EncodedPayloadType | MaybeNone: ... + # If `charset=None` and payload supports both `encode` AND `decode`, + # then an invalid payload could be passed, but this is unlikely + # Not[_SupportsEncodeToPayload] + @overload + def set_payload( + self, payload: _SupportsDecodeToPayload | _PayloadType | _MultipartPayloadType, charset: None = None + ) -> None: ... + @overload + def set_payload( + self, + payload: _SupportsEncodeToPayload | _SupportsDecodeToPayload | _PayloadType | _MultipartPayloadType, + charset: Charset | str, + ) -> None: ... + def set_charset(self, charset: _CharsetType) -> None: ... + def get_charset(self) -> _CharsetType: ... + def __len__(self) -> int: ... + def __contains__(self, name: str) -> bool: ... + def __iter__(self) -> Iterator[str]: ... + # Same as `get` with `failobj=None`, but with the expectation that it won't return None in most scenarios + # This is important for protocols using __getitem__, like SupportsKeysAndGetItem + # Morally, the return type should be `AnyOf[_HeaderType, None]`, + # so using "the Any trick" instead. + def __getitem__(self, name: str) -> _HeaderT_co | MaybeNone: ... + def __setitem__(self, name: str, val: _HeaderParamT_contra) -> None: ... + def __delitem__(self, name: str) -> None: ... + def keys(self) -> list[str]: ... + def values(self) -> list[_HeaderT_co]: ... + def items(self) -> list[tuple[str, _HeaderT_co]]: ... + @overload + def get(self, name: str, failobj: None = None) -> _HeaderT_co | None: ... + @overload + def get(self, name: str, failobj: _T) -> _HeaderT_co | _T: ... + @overload + def get_all(self, name: str, failobj: None = None) -> list[_HeaderT_co] | None: ... + @overload + def get_all(self, name: str, failobj: _T) -> list[_HeaderT_co] | _T: ... + def add_header(self, _name: str, _value: str, **_params: _ParamsType) -> None: ... + def replace_header(self, _name: str, _value: _HeaderParamT_contra) -> None: ... + def get_content_type(self) -> str: ... + def get_content_maintype(self) -> str: ... + def get_content_subtype(self) -> str: ... + def get_default_type(self) -> str: ... + def set_default_type(self, ctype: str) -> None: ... + @overload + def get_params( + self, failobj: None = None, header: str = "content-type", unquote: bool = True + ) -> list[tuple[str, str]] | None: ... + @overload + def get_params(self, failobj: _T, header: str = "content-type", unquote: bool = True) -> list[tuple[str, str]] | _T: ... + @overload + def get_param( + self, param: str, failobj: None = None, header: str = "content-type", unquote: bool = True + ) -> _ParamType | None: ... + @overload + def get_param(self, param: str, failobj: _T, header: str = "content-type", unquote: bool = True) -> _ParamType | _T: ... + def del_param(self, param: str, header: str = "content-type", requote: bool = True) -> None: ... + def set_type(self, type: str, header: str = "Content-Type", requote: bool = True) -> None: ... + @overload + def get_filename(self, failobj: None = None) -> str | None: ... + @overload + def get_filename(self, failobj: _T) -> str | _T: ... + @overload + def get_boundary(self, failobj: None = None) -> str | None: ... + @overload + def get_boundary(self, failobj: _T) -> str | _T: ... + def set_boundary(self, boundary: str) -> None: ... + @overload + def get_content_charset(self) -> str | None: ... + @overload + def get_content_charset(self, failobj: _T) -> str | _T: ... + @overload + def get_charsets(self, failobj: None = None) -> list[str | None]: ... + @overload + def get_charsets(self, failobj: _T) -> list[str | _T]: ... + def walk(self) -> Generator[Self, None, None]: ... + def get_content_disposition(self) -> str | None: ... + def as_string(self, unixfrom: bool = False, maxheaderlen: int = 0, policy: Policy[Any] | None = None) -> str: ... + def as_bytes(self, unixfrom: bool = False, policy: Policy[Any] | None = None) -> bytes: ... + def __bytes__(self) -> bytes: ... + def set_param( + self, + param: str, + value: str, + header: str = "Content-Type", + requote: bool = True, + charset: str | None = None, + language: str = "", + replace: bool = False, + ) -> None: ... + # The following two methods are undocumented, but a source code comment states that they are public API + def set_raw(self, name: str, value: _HeaderParamT_contra) -> None: ... + def raw_items(self) -> Iterator[tuple[str, _HeaderT_co]]: ... + +class MIMEPart(Message[_HeaderRegistryT_co, _HeaderRegistryParamT_contra]): + def __init__(self, policy: Policy[Any] | None = None) -> None: ... + def get_body(self, preferencelist: Sequence[str] = ("related", "html", "plain")) -> MIMEPart[_HeaderRegistryT_co] | None: ... + def attach(self, payload: Self) -> None: ... # type: ignore[override] + # The attachments are created via type(self) in the attach method. It's theoretically + # possible to sneak other attachment types into a MIMEPart instance, but could cause + # cause unforseen consequences. + def iter_attachments(self) -> Iterator[Self]: ... + def iter_parts(self) -> Iterator[MIMEPart[_HeaderRegistryT_co]]: ... + def get_content(self, *args: Any, content_manager: ContentManager | None = None, **kw: Any) -> Any: ... + def set_content(self, *args: Any, content_manager: ContentManager | None = None, **kw: Any) -> None: ... + def make_related(self, boundary: str | None = None) -> None: ... + def make_alternative(self, boundary: str | None = None) -> None: ... + def make_mixed(self, boundary: str | None = None) -> None: ... + def add_related(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... + def add_alternative(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... + def add_attachment(self, *args: Any, content_manager: ContentManager | None = ..., **kw: Any) -> None: ... + def clear(self) -> None: ... + def clear_content(self) -> None: ... + def as_string(self, unixfrom: bool = False, maxheaderlen: int | None = None, policy: Policy[Any] | None = None) -> str: ... + def is_attachment(self) -> bool: ... + +class EmailMessage(MIMEPart): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/application.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/application.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/application.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/application.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/audio.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/audio.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/audio.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/audio.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/base.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/base.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/base.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/base.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/image.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/image.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/image.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/image.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/message.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/message.pyi new file mode 100644 index 0000000000000..a1e370e2eab51 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/message.pyi @@ -0,0 +1,8 @@ +from email._policybase import _MessageT +from email.mime.nonmultipart import MIMENonMultipart +from email.policy import Policy + +__all__ = ["MIMEMessage"] + +class MIMEMessage(MIMENonMultipart): + def __init__(self, _msg: _MessageT, _subtype: str = "rfc822", *, policy: Policy[_MessageT] | None = None) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi new file mode 100644 index 0000000000000..fb9599edbcb8f --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/multipart.pyi @@ -0,0 +1,18 @@ +from collections.abc import Sequence +from email import _ParamsType +from email._policybase import _MessageT +from email.mime.base import MIMEBase +from email.policy import Policy + +__all__ = ["MIMEMultipart"] + +class MIMEMultipart(MIMEBase): + def __init__( + self, + _subtype: str = "mixed", + boundary: str | None = None, + _subparts: Sequence[_MessageT] | None = None, + *, + policy: Policy[_MessageT] | None = None, + **_params: _ParamsType, + ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/nonmultipart.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/nonmultipart.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/nonmultipart.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/nonmultipart.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/text.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/text.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/text.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/mime/text.pyi index 74d5ef4c5caea..edfa67a092427 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/mime/text.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/mime/text.pyi @@ -1,5 +1,5 @@ +from email._policybase import Policy from email.mime.nonmultipart import MIMENonMultipart -from email.policy import Policy __all__ = ["MIMEText"] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/parser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/parser.pyi new file mode 100644 index 0000000000000..a4924a6cbd88f --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/parser.pyi @@ -0,0 +1,39 @@ +from _typeshed import SupportsRead +from collections.abc import Callable +from email._policybase import _MessageT +from email.feedparser import BytesFeedParser as BytesFeedParser, FeedParser as FeedParser +from email.message import Message +from email.policy import Policy +from io import _WrappedBuffer +from typing import Generic, overload + +__all__ = ["Parser", "HeaderParser", "BytesParser", "BytesHeaderParser", "FeedParser", "BytesFeedParser"] + +class Parser(Generic[_MessageT]): + @overload + def __init__(self: Parser[Message[str, str]], _class: None = None) -> None: ... + @overload + def __init__(self, _class: None = None, *, policy: Policy[_MessageT]) -> None: ... + @overload + def __init__(self, _class: Callable[[], _MessageT] | None, *, policy: Policy[_MessageT] = ...) -> None: ... + def parse(self, fp: SupportsRead[str], headersonly: bool = False) -> _MessageT: ... + def parsestr(self, text: str, headersonly: bool = False) -> _MessageT: ... + +class HeaderParser(Parser[_MessageT]): + def parse(self, fp: SupportsRead[str], headersonly: bool = True) -> _MessageT: ... + def parsestr(self, text: str, headersonly: bool = True) -> _MessageT: ... + +class BytesParser(Generic[_MessageT]): + parser: Parser[_MessageT] + @overload + def __init__(self: BytesParser[Message[str, str]], _class: None = None) -> None: ... + @overload + def __init__(self, _class: None = None, *, policy: Policy[_MessageT]) -> None: ... + @overload + def __init__(self, _class: Callable[[], _MessageT], *, policy: Policy[_MessageT] = ...) -> None: ... + def parse(self, fp: _WrappedBuffer, headersonly: bool = False) -> _MessageT: ... + def parsebytes(self, text: bytes | bytearray, headersonly: bool = False) -> _MessageT: ... + +class BytesHeaderParser(BytesParser[_MessageT]): + def parse(self, fp: _WrappedBuffer, headersonly: bool = True) -> _MessageT: ... + def parsebytes(self, text: bytes | bytearray, headersonly: bool = True) -> _MessageT: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/email/policy.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/policy.pyi new file mode 100644 index 0000000000000..35c999919eede --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/policy.pyi @@ -0,0 +1,75 @@ +from collections.abc import Callable +from email._policybase import Compat32 as Compat32, Policy as Policy, _MessageFactory, _MessageT, compat32 as compat32 +from email.contentmanager import ContentManager +from email.message import EmailMessage +from typing import Any, overload +from typing_extensions import Self + +__all__ = ["Compat32", "compat32", "Policy", "EmailPolicy", "default", "strict", "SMTP", "HTTP"] + +class EmailPolicy(Policy[_MessageT]): + utf8: bool + refold_source: str + header_factory: Callable[[str, Any], Any] + content_manager: ContentManager + @overload + def __init__( + self: EmailPolicy[EmailMessage], + *, + max_line_length: int | None = ..., + linesep: str = ..., + cte_type: str = ..., + raise_on_defect: bool = ..., + mangle_from_: bool = ..., + message_factory: None = None, + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool = ..., + utf8: bool = ..., + refold_source: str = ..., + header_factory: Callable[[str, str], str] = ..., + content_manager: ContentManager = ..., + ) -> None: ... + @overload + def __init__( + self, + *, + max_line_length: int | None = ..., + linesep: str = ..., + cte_type: str = ..., + raise_on_defect: bool = ..., + mangle_from_: bool = ..., + message_factory: _MessageFactory[_MessageT] | None = ..., + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool = ..., + utf8: bool = ..., + refold_source: str = ..., + header_factory: Callable[[str, str], str] = ..., + content_manager: ContentManager = ..., + ) -> None: ... + def header_source_parse(self, sourcelines: list[str]) -> tuple[str, str]: ... + def header_store_parse(self, name: str, value: Any) -> tuple[str, Any]: ... + def header_fetch_parse(self, name: str, value: str) -> Any: ... + def fold(self, name: str, value: str) -> Any: ... + def fold_binary(self, name: str, value: str) -> bytes: ... + def clone( + self, + *, + max_line_length: int | None = ..., + linesep: str = ..., + cte_type: str = ..., + raise_on_defect: bool = ..., + mangle_from_: bool = ..., + message_factory: _MessageFactory[_MessageT] | None = ..., + # Added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 + verify_generated_headers: bool = ..., + utf8: bool = ..., + refold_source: str = ..., + header_factory: Callable[[str, str], str] = ..., + content_manager: ContentManager = ..., + ) -> Self: ... + +default: EmailPolicy[EmailMessage] +SMTP: EmailPolicy[EmailMessage] +SMTPUTF8: EmailPolicy[EmailMessage] +HTTP: EmailPolicy[EmailMessage] +strict: EmailPolicy[EmailMessage] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/quoprimime.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/quoprimime.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/quoprimime.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/quoprimime.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/utils.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/email/utils.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/email/utils.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/email/utils.pyi index dc3eecb5ef7fb..efc32a7abce29 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/email/utils.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/email/utils.pyi @@ -30,11 +30,11 @@ _PDTZ: TypeAlias = tuple[int, int, int, int, int, int, int, int, int, int | None def quote(str: str) -> str: ... def unquote(str: str) -> str: ... -# `strict` parameter added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 +# `strict` parameter added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 def parseaddr(addr: str | list[str], *, strict: bool = True) -> tuple[str, str]: ... def formataddr(pair: tuple[str | None, str], charset: str | Charset = "utf-8") -> str: ... -# `strict` parameter added in Python 3.8.20, 3.9.20, 3.10.15, 3.11.10, 3.12.5 +# `strict` parameter added in Python 3.9.20, 3.10.15, 3.11.10, 3.12.5 def getaddresses(fieldvalues: Iterable[str], *, strict: bool = True) -> list[tuple[str, str]]: ... @overload def parsedate(data: None) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi new file mode 100644 index 0000000000000..12ec6792d49b5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/__init__.pyi @@ -0,0 +1,9 @@ +from codecs import CodecInfo + +class CodecRegistryError(LookupError, SystemError): ... + +def normalize_encoding(encoding: str | bytes) -> str: ... +def search_function(encoding: str) -> CodecInfo | None: ... + +# Needed for submodules +def __getattr__(name: str): ... # incomplete module diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/aliases.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/aliases.pyi new file mode 100644 index 0000000000000..079af85d51ee4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/aliases.pyi @@ -0,0 +1 @@ +aliases: dict[str, str] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ascii.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ascii.pyi new file mode 100644 index 0000000000000..a85585af32ed9 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ascii.pyi @@ -0,0 +1,30 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + # At runtime, this is codecs.ascii_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + # At runtime, this is codecs.ascii_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +# Note: encode being a decode function and decode being an encode function is accurate to runtime. +class StreamConverter(StreamWriter, StreamReader): # type: ignore[misc] # incompatible methods in base classes + # At runtime, this is codecs.ascii_decode + @staticmethod + def encode(data: ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... # type: ignore[override] + # At runtime, this is codecs.ascii_encode + @staticmethod + def decode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... # type: ignore[override] + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/base64_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/base64_codec.pyi new file mode 100644 index 0000000000000..0c4f1cb1fe599 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/base64_codec.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def base64_encode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... +def base64_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5hkscs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5hkscs.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/big5hkscs.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/bz2_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/bz2_codec.pyi new file mode 100644 index 0000000000000..468346a93da98 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/bz2_codec.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def bz2_encode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... +def bz2_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/charmap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/charmap.pyi new file mode 100644 index 0000000000000..a971a15860b52 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/charmap.pyi @@ -0,0 +1,33 @@ +import codecs +from _codecs import _CharMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + # At runtime, this is codecs.charmap_encode + @staticmethod + def encode(str: str, errors: str | None = None, mapping: _CharMap | None = None, /) -> tuple[bytes, int]: ... + # At runtime, this is codecs.charmap_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, mapping: _CharMap | None = None, /) -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + mapping: _CharMap | None + def __init__(self, errors: str = "strict", mapping: _CharMap | None = None) -> None: ... + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + mapping: _CharMap | None + def __init__(self, errors: str = "strict", mapping: _CharMap | None = None) -> None: ... + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): + mapping: _CharMap | None + def __init__(self, stream: codecs._WritableStream, errors: str = "strict", mapping: _CharMap | None = None) -> None: ... + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class StreamReader(Codec, codecs.StreamReader): + mapping: _CharMap | None + def __init__(self, stream: codecs._ReadableStream, errors: str = "strict", mapping: _CharMap | None = None) -> None: ... + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... # type: ignore[override] + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp037.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp037.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp037.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1006.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1006.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1006.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1026.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1026.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1026.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1125.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1125.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1125.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1140.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1140.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1140.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1250.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1250.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1250.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1251.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1251.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1251.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1252.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1252.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1252.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1253.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1253.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1253.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1254.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1254.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1254.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1255.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1255.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1255.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1256.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1256.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1256.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1257.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1257.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1257.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1258.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1258.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp1258.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp273.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp273.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp273.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp424.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp424.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp424.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp437.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp437.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp437.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp500.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp500.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp500.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp720.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp720.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp720.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp737.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp737.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp737.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp775.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp775.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp775.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp850.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp850.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp850.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp852.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp852.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp852.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp855.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp855.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp855.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp856.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp856.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp856.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp857.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp857.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp857.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp858.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp858.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp858.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp860.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp860.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp860.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp861.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp861.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp861.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp862.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp862.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp862.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp863.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp863.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp863.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp864.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp864.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp864.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp865.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp865.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp865.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp866.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp866.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp866.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp869.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp869.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp869.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp874.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp874.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp874.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp875.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp875.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp875.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp932.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp932.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp932.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp949.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp949.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp949.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp950.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp950.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/cp950.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jis_2004.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jis_2004.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jis_2004.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jisx0213.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jisx0213.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jisx0213.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jp.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_jp.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_kr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_kr.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/euc_kr.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb18030.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb18030.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb18030.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb2312.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb2312.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gb2312.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gbk.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gbk.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/gbk.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hex_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hex_codec.pyi new file mode 100644 index 0000000000000..3fd4fe38898a8 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hex_codec.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def hex_encode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... +def hex_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hp_roman8.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hp_roman8.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hp_roman8.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hz.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hz.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/hz.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/idna.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/idna.pyi new file mode 100644 index 0000000000000..3e2c8baf1cb28 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/idna.pyi @@ -0,0 +1,26 @@ +import codecs +import re +from _typeshed import ReadableBuffer + +dots: re.Pattern[str] +ace_prefix: bytes +sace_prefix: str + +def nameprep(label: str) -> str: ... +def ToASCII(label: str) -> bytes: ... +def ToUnicode(label: bytes | str) -> str: ... + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: ReadableBuffer | str, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.BufferedIncrementalEncoder): + def _buffer_encode(self, input: str, errors: str, final: bool) -> tuple[bytes, int]: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + def _buffer_decode(self, input: ReadableBuffer | str, errors: str, final: bool) -> tuple[str, int]: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_1.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_1.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_1.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2004.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2004.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_2004.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_3.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_3.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_3.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_ext.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_ext.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_jp_ext.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_kr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_kr.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso2022_kr.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_1.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_1.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_1.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_10.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_10.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_10.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_11.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_11.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_11.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_13.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_13.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_13.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_14.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_14.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_14.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_15.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_15.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_15.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_16.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_16.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_16.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_2.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_2.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_3.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_3.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_3.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_4.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_4.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_4.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_5.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_5.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_5.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_6.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_6.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_6.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_7.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_7.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_7.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_8.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_8.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_8.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_9.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_9.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/iso8859_9.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/johab.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/johab.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/johab.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_r.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_r.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_r.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_t.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_t.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_t.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_u.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_u.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/koi8_u.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/kz1048.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/kz1048.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/kz1048.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/latin_1.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/latin_1.pyi new file mode 100644 index 0000000000000..3b06773eac03c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/latin_1.pyi @@ -0,0 +1,30 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + # At runtime, this is codecs.latin_1_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + # At runtime, this is codecs.latin_1_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +# Note: encode being a decode function and decode being an encode function is accurate to runtime. +class StreamConverter(StreamWriter, StreamReader): # type: ignore[misc] # incompatible methods in base classes + # At runtime, this is codecs.latin_1_decode + @staticmethod + def encode(data: ReadableBuffer, errors: str | None = None, /) -> tuple[str, int]: ... # type: ignore[override] + # At runtime, this is codecs.latin_1_encode + @staticmethod + def decode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... # type: ignore[override] + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_arabic.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_arabic.pyi new file mode 100644 index 0000000000000..42781b4892984 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_arabic.pyi @@ -0,0 +1,21 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_map: dict[int, int | None] +decoding_table: str +encoding_map: dict[int, int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_croatian.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_croatian.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_croatian.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_cyrillic.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_cyrillic.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_cyrillic.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_farsi.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_farsi.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_farsi.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_greek.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_greek.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_greek.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_iceland.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_iceland.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_iceland.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_latin2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_latin2.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_latin2.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_roman.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_roman.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_roman.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_romanian.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_romanian.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_romanian.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_turkish.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_turkish.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mac_turkish.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mbcs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mbcs.pyi new file mode 100644 index 0000000000000..2c2917d63f6db --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/mbcs.pyi @@ -0,0 +1,28 @@ +import codecs +import sys +from _typeshed import ReadableBuffer + +if sys.platform == "win32": + encode = codecs.mbcs_encode + + def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + + class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + + class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.mbcs_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + + class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.mbcs_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + + class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.mbcs_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + + def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/oem.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/oem.pyi new file mode 100644 index 0000000000000..376c12c445f42 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/oem.pyi @@ -0,0 +1,28 @@ +import codecs +import sys +from _typeshed import ReadableBuffer + +if sys.platform == "win32": + encode = codecs.oem_encode + + def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + + class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + + class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.oem_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + + class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.oem_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + + class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.oem_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + + def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/palmos.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/palmos.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/palmos.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ptcp154.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ptcp154.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/ptcp154.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/punycode.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/punycode.pyi new file mode 100644 index 0000000000000..eb99e667b4167 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/punycode.pyi @@ -0,0 +1,33 @@ +import codecs +from typing import Literal + +def segregate(str: str) -> tuple[bytes, list[int]]: ... +def selective_len(str: str, max: int) -> int: ... +def selective_find(str: str, char: str, index: int, pos: int) -> tuple[int, int]: ... +def insertion_unsort(str: str, extended: list[int]) -> list[int]: ... +def T(j: int, bias: int) -> int: ... + +digits: Literal[b"abcdefghijklmnopqrstuvwxyz0123456789"] + +def generate_generalized_integer(N: int, bias: int) -> bytes: ... +def adapt(delta: int, first: bool, numchars: int) -> int: ... +def generate_integers(baselen: int, deltas: list[int]) -> bytes: ... +def punycode_encode(text: str) -> bytes: ... +def decode_generalized_number(extended: bytes, extpos: int, bias: int, errors: str) -> tuple[int, int | None]: ... +def insertion_sort(base: str, extended: bytes, errors: str) -> str: ... +def punycode_decode(text: memoryview | bytes | bytearray | str, errors: str) -> str: ... + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: memoryview | bytes | bytearray | str, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: memoryview | bytes | bytearray | str, final: bool = False) -> str: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/quopri_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/quopri_codec.pyi new file mode 100644 index 0000000000000..e9deadd8d463c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/quopri_codec.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def quopri_encode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... +def quopri_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/raw_unicode_escape.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/raw_unicode_escape.pyi new file mode 100644 index 0000000000000..2887739468f24 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/raw_unicode_escape.pyi @@ -0,0 +1,23 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + # At runtime, this is codecs.raw_unicode_escape_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + # At runtime, this is codecs.raw_unicode_escape_decode + @staticmethod + def decode(data: str | ReadableBuffer, errors: str | None = None, final: bool = True, /) -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + def _buffer_decode(self, input: str | ReadableBuffer, errors: str | None, final: bool) -> tuple[str, int]: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... + +class StreamReader(Codec, codecs.StreamReader): + def decode(self, input: str | ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... # type: ignore[override] + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/rot_13.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/rot_13.pyi new file mode 100644 index 0000000000000..8d71bc9575949 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/rot_13.pyi @@ -0,0 +1,23 @@ +import codecs +from _typeshed import SupportsRead, SupportsWrite + +# This codec is string to string. + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[str, int]: ... # type: ignore[override] + def decode(self, input: str, errors: str = "strict") -> tuple[str, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> str: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: str, final: bool = False) -> str: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +rot13_map: dict[int, int] + +def rot13(infile: SupportsRead[str], outfile: SupportsWrite[str]) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis_2004.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis_2004.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jis_2004.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jisx0213.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jisx0213.pyi new file mode 100644 index 0000000000000..d613026a5a862 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/shift_jisx0213.pyi @@ -0,0 +1,23 @@ +import _multibytecodec as mbc +import codecs +from typing import ClassVar + +codec: mbc._MultibyteCodec + +class Codec(codecs.Codec): + encode = codec.encode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + decode = codec.decode # type: ignore[assignment] # pyright: ignore[reportAssignmentType] + +class IncrementalEncoder(mbc.MultibyteIncrementalEncoder, codecs.IncrementalEncoder): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class IncrementalDecoder(mbc.MultibyteIncrementalDecoder, codecs.IncrementalDecoder): + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamReader(Codec, mbc.MultibyteStreamReader, codecs.StreamReader): # type: ignore[misc] + codec: ClassVar[mbc._MultibyteCodec] = ... + +class StreamWriter(Codec, mbc.MultibyteStreamWriter, codecs.StreamWriter): + codec: ClassVar[mbc._MultibyteCodec] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/tis_620.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/tis_620.pyi new file mode 100644 index 0000000000000..f62195662ce96 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/tis_620.pyi @@ -0,0 +1,21 @@ +import codecs +from _codecs import _EncodingMap +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: bytes, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... + +decoding_table: str +encoding_table: _EncodingMap diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/undefined.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/undefined.pyi new file mode 100644 index 0000000000000..4775dac752f28 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/undefined.pyi @@ -0,0 +1,20 @@ +import codecs +from _typeshed import ReadableBuffer + +# These return types are just to match the base types. In reality, these always +# raise an error. + +class Codec(codecs.Codec): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> str: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... +class StreamReader(Codec, codecs.StreamReader): ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/unicode_escape.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/unicode_escape.pyi new file mode 100644 index 0000000000000..ceaa39a3859ae --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/unicode_escape.pyi @@ -0,0 +1,23 @@ +import codecs +from _typeshed import ReadableBuffer + +class Codec(codecs.Codec): + # At runtime, this is codecs.unicode_escape_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + # At runtime, this is codecs.unicode_escape_decode + @staticmethod + def decode(data: str | ReadableBuffer, errors: str | None = None, final: bool = True, /) -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + def _buffer_decode(self, input: str | ReadableBuffer, errors: str | None, final: bool) -> tuple[str, int]: ... + +class StreamWriter(Codec, codecs.StreamWriter): ... + +class StreamReader(Codec, codecs.StreamReader): + def decode(self, input: str | ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... # type: ignore[override] + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16.pyi new file mode 100644 index 0000000000000..3b712cde420ae --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16.pyi @@ -0,0 +1,20 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_16_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + def _buffer_decode(self, input: ReadableBuffer, errors: str, final: bool) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_be.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_be.pyi new file mode 100644 index 0000000000000..cc7d1534fc69b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_be.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_16_be_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_16_be_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_16_be_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_16_be_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_le.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_le.pyi new file mode 100644 index 0000000000000..ba103eb088e3c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_16_le.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_16_le_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_16_le_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_16_le_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_16_le_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32.pyi new file mode 100644 index 0000000000000..c925be712c728 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32.pyi @@ -0,0 +1,20 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_32_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + def _buffer_decode(self, input: ReadableBuffer, errors: str, final: bool) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + def encode(self, input: str, errors: str = "strict") -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_be.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_be.pyi new file mode 100644 index 0000000000000..9d28f5199c501 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_be.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_32_be_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_32_be_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_32_be_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_32_be_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_le.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_le.pyi new file mode 100644 index 0000000000000..5be14a91a3e6c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_32_le.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_32_le_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_32_le_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_32_le_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_32_le_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_7.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_7.pyi new file mode 100644 index 0000000000000..dc1162f34c287 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_7.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer + +encode = codecs.utf_7_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: str, final: bool = False) -> bytes: ... + +class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_7_decode + @staticmethod + def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_7_encode + @staticmethod + def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... + +class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_7_decode + @staticmethod + def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi similarity index 82% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi index bb745399eb8cb..918712d804730 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_8.pyi @@ -1,21 +1,26 @@ import codecs from _typeshed import ReadableBuffer +encode = codecs.utf_8_encode + +def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... + class IncrementalEncoder(codecs.IncrementalEncoder): def encode(self, input: str, final: bool = False) -> bytes: ... class IncrementalDecoder(codecs.BufferedIncrementalDecoder): + # At runtime, this is codecs.utf_8_decode @staticmethod def _buffer_decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... class StreamWriter(codecs.StreamWriter): + # At runtime, this is codecs.utf_8_encode @staticmethod def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... class StreamReader(codecs.StreamReader): + # At runtime, this is codecs.utf_8_decode @staticmethod def decode(data: ReadableBuffer, errors: str | None = None, final: bool = False, /) -> tuple[str, int]: ... def getregentry() -> codecs.CodecInfo: ... -def encode(str: str, errors: str | None = None, /) -> tuple[bytes, int]: ... -def decode(input: ReadableBuffer, errors: str | None = "strict") -> tuple[str, int]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/utf_8_sig.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_8_sig.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/encodings/utf_8_sig.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/encodings/utf_8_sig.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/uu_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/uu_codec.pyi new file mode 100644 index 0000000000000..e32ba8ac0a1a7 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/uu_codec.pyi @@ -0,0 +1,28 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def uu_encode( + input: ReadableBuffer, errors: str = "strict", filename: str = "<data>", mode: int = 0o666 +) -> tuple[bytes, int]: ... +def uu_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/encodings/zlib_codec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/zlib_codec.pyi new file mode 100644 index 0000000000000..0f13d0e810e91 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/encodings/zlib_codec.pyi @@ -0,0 +1,26 @@ +import codecs +from _typeshed import ReadableBuffer +from typing import ClassVar + +# This codec is bytes to bytes. + +def zlib_encode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... +def zlib_decode(input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... + +class Codec(codecs.Codec): + def encode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + def decode(self, input: ReadableBuffer, errors: str = "strict") -> tuple[bytes, int]: ... # type: ignore[override] + +class IncrementalEncoder(codecs.IncrementalEncoder): + def encode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input: ReadableBuffer, final: bool = False) -> bytes: ... # type: ignore[override] + +class StreamWriter(Codec, codecs.StreamWriter): + charbuffertype: ClassVar[type] = ... + +class StreamReader(Codec, codecs.StreamReader): + charbuffertype: ClassVar[type] = ... + +def getregentry() -> codecs.CodecInfo: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ensurepip/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ensurepip/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ensurepip/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ensurepip/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/enum.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/enum.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/enum.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/enum.pyi index 3b6c325522d7b..26f1988671132 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/enum.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/enum.pyi @@ -64,7 +64,11 @@ if sys.version_info >= (3, 11): def __init__(self, value: _EnumMemberT) -> None: ... class _EnumDict(dict[str, Any]): - def __init__(self) -> None: ... + if sys.version_info >= (3, 13): + def __init__(self, cls_name: str | None = None) -> None: ... + else: + def __init__(self) -> None: ... + def __setitem__(self, key: str, value: Any) -> None: ... if sys.version_info >= (3, 11): # See comment above `typing.MutableMapping.update` @@ -96,20 +100,13 @@ class EnumMeta(type): _simple: bool = False, **kwds: Any, ) -> _typeshed.Self: ... - elif sys.version_info >= (3, 9): + else: def __new__( metacls: type[_typeshed.Self], cls: str, bases: tuple[type, ...], classdict: _EnumDict, **kwds: Any ) -> _typeshed.Self: ... - else: - def __new__(metacls: type[_typeshed.Self], cls: str, bases: tuple[type, ...], classdict: _EnumDict) -> _typeshed.Self: ... - - if sys.version_info >= (3, 9): - @classmethod - def __prepare__(metacls, cls: str, bases: tuple[type, ...], **kwds: Any) -> _EnumDict: ... # type: ignore[override] - else: - @classmethod - def __prepare__(metacls, cls: str, bases: tuple[type, ...]) -> _EnumDict: ... # type: ignore[override] + @classmethod + def __prepare__(metacls, cls: str, bases: tuple[type, ...], **kwds: Any) -> _EnumDict: ... # type: ignore[override] def __iter__(self: type[_EnumMemberT]) -> Iterator[_EnumMemberT]: ... def __reversed__(self: type[_EnumMemberT]) -> Iterator[_EnumMemberT]: ... if sys.version_info >= (3, 12): @@ -302,6 +299,7 @@ if sys.version_info >= (3, 11): def __or__(self, other: int) -> Self: ... def __and__(self, other: int) -> Self: ... def __xor__(self, other: int) -> Self: ... + def __invert__(self) -> Self: ... __ror__ = __or__ __rand__ = __and__ __rxor__ = __xor__ @@ -312,6 +310,7 @@ else: def __or__(self, other: int) -> Self: ... def __and__(self, other: int) -> Self: ... def __xor__(self, other: int) -> Self: ... + def __invert__(self) -> Self: ... __ror__ = __or__ __rand__ = __and__ __rxor__ = __xor__ diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/errno.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/errno.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/errno.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/errno.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/faulthandler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/faulthandler.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/faulthandler.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/faulthandler.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/fcntl.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/fcntl.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/fcntl.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/fcntl.pyi index 376611f166b85..2fe64eb532013 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/fcntl.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/fcntl.pyi @@ -26,8 +26,7 @@ if sys.platform != "win32": if sys.platform == "darwin": F_FULLFSYNC: int F_NOCACHE: int - if sys.version_info >= (3, 9): - F_GETPATH: int + F_GETPATH: int if sys.platform == "linux": F_SETLKW64: int F_SETSIG: int @@ -43,10 +42,9 @@ if sys.platform != "win32": F_SEAL_SEAL: int F_SEAL_SHRINK: int F_SEAL_WRITE: int - if sys.version_info >= (3, 9): - F_OFD_GETLK: Final[int] - F_OFD_SETLK: Final[int] - F_OFD_SETLKW: Final[int] + F_OFD_GETLK: Final[int] + F_OFD_SETLK: Final[int] + F_OFD_SETLKW: Final[int] if sys.version_info >= (3, 10): F_GETPIPE_SZ: int @@ -70,8 +68,10 @@ if sys.platform != "win32": LOCK_RW: int LOCK_WRITE: int - # These are highly problematic, they might be present or not, depends on the specific OS. if sys.platform == "linux": + # Constants for the POSIX STREAMS interface. Present in glibc until 2.29 (released February 2019). + # Never implemented on BSD, and considered "obsolescent" starting in POSIX 2008. + # Probably still used on Solaris. I_ATMARK: int I_CANPUT: int I_CKBAND: int diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/filecmp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/filecmp.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/filecmp.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/filecmp.pyi index cb7b945960773..a2a2b235fdadc 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/filecmp.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/filecmp.pyi @@ -1,11 +1,9 @@ import sys from _typeshed import GenericPath, StrOrBytesPath from collections.abc import Callable, Iterable, Sequence +from types import GenericAlias from typing import Any, AnyStr, Final, Generic, Literal -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = ["clear_cache", "cmp", "dircmp", "cmpfiles", "DEFAULT_IGNORES"] DEFAULT_IGNORES: list[str] @@ -62,7 +60,6 @@ class dircmp(Generic[AnyStr]): def phase3(self) -> None: ... def phase4(self) -> None: ... def phase4_closure(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... def clear_cache() -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/fileinput.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/fileinput.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/fileinput.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/fileinput.pyi index 1e6aa78e26077..948b39ea1e1ca 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/fileinput.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/fileinput.pyi @@ -1,13 +1,10 @@ import sys from _typeshed import AnyStr_co, StrOrBytesPath -from collections.abc import Callable, Iterable, Iterator -from types import TracebackType -from typing import IO, Any, AnyStr, Literal, Protocol, overload +from collections.abc import Callable, Iterable +from types import GenericAlias, TracebackType +from typing import IO, Any, AnyStr, Generic, Literal, Protocol, overload from typing_extensions import Self, TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "input", "close", @@ -107,7 +104,7 @@ def fileno() -> int: ... def isfirstline() -> bool: ... def isstdin() -> bool: ... -class FileInput(Iterator[AnyStr]): +class FileInput(Generic[AnyStr]): if sys.version_info >= (3, 10): # encoding and errors are added @overload @@ -199,8 +196,7 @@ class FileInput(Iterator[AnyStr]): def fileno(self) -> int: ... def isfirstline(self) -> bool: ... def isstdin(self) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... if sys.version_info >= (3, 10): def hook_compressed( diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/fnmatch.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/fnmatch.pyi new file mode 100644 index 0000000000000..345c4576497de --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/fnmatch.pyi @@ -0,0 +1,15 @@ +import sys +from collections.abc import Iterable +from typing import AnyStr + +__all__ = ["filter", "fnmatch", "fnmatchcase", "translate"] +if sys.version_info >= (3, 14): + __all__ += ["filterfalse"] + +def fnmatch(name: AnyStr, pat: AnyStr) -> bool: ... +def fnmatchcase(name: AnyStr, pat: AnyStr) -> bool: ... +def filter(names: Iterable[AnyStr], pat: AnyStr) -> list[AnyStr]: ... +def translate(pat: str) -> str: ... + +if sys.version_info >= (3, 14): + def filterfalse(names: Iterable[AnyStr], pat: AnyStr) -> list[AnyStr]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/formatter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/formatter.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/formatter.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/formatter.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/fractions.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/fractions.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/fractions.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/fractions.pyi index 086aff50344c7..4d5c2160e60a1 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/fractions.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/fractions.pyi @@ -1,30 +1,27 @@ import sys from collections.abc import Callable from decimal import Decimal -from numbers import Integral, Rational, Real -from typing import Any, Literal, SupportsIndex, overload +from numbers import Rational, Real +from typing import Any, Literal, Protocol, SupportsIndex, overload from typing_extensions import Self, TypeAlias _ComparableNum: TypeAlias = int | float | Decimal | Real -if sys.version_info >= (3, 9): - __all__ = ["Fraction"] -else: - __all__ = ["Fraction", "gcd"] - @overload - def gcd(a: int, b: int) -> int: ... - @overload - def gcd(a: Integral, b: int) -> Integral: ... - @overload - def gcd(a: int, b: Integral) -> Integral: ... - @overload - def gcd(a: Integral, b: Integral) -> Integral: ... +__all__ = ["Fraction"] + +class _ConvertibleToIntegerRatio(Protocol): + def as_integer_ratio(self) -> tuple[int | Rational, int | Rational]: ... class Fraction(Rational): @overload def __new__(cls, numerator: int | Rational = 0, denominator: int | Rational | None = None) -> Self: ... @overload - def __new__(cls, value: float | Decimal | str, /) -> Self: ... + def __new__(cls, numerator: float | Decimal | str) -> Self: ... + + if sys.version_info >= (3, 14): + @overload + def __new__(cls, numerator: _ConvertibleToIntegerRatio) -> Self: ... + @classmethod def from_float(cls, f: float) -> Self: ... @classmethod @@ -130,7 +127,7 @@ class Fraction(Rational): def __round__(self, ndigits: None = None) -> int: ... @overload def __round__(self, ndigits: int) -> Fraction: ... - def __hash__(self) -> int: ... + def __hash__(self) -> int: ... # type: ignore[override] def __eq__(a, b: object) -> bool: ... def __lt__(a, b: _ComparableNum) -> bool: ... def __gt__(a, b: _ComparableNum) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ftplib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ftplib.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ftplib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ftplib.pyi index 3693d7c52a26c..44bc2165fe0e3 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ftplib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ftplib.pyi @@ -41,29 +41,17 @@ class FTP: self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None ) -> None: ... source_address: tuple[str, int] | None - if sys.version_info >= (3, 9): - def __init__( - self, - host: str = "", - user: str = "", - passwd: str = "", - acct: str = "", - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - *, - encoding: str = "utf-8", - ) -> None: ... - else: - def __init__( - self, - host: str = "", - user: str = "", - passwd: str = "", - acct: str = "", - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - ) -> None: ... - + def __init__( + self, + host: str = "", + user: str = "", + passwd: str = "", + acct: str = "", + timeout: float | None = ..., + source_address: tuple[str, int] | None = None, + *, + encoding: str = "utf-8", + ) -> None: ... def connect( self, host: str = "", port: int = 0, timeout: float = -999, source_address: tuple[str, int] | None = None ) -> str: ... @@ -131,7 +119,7 @@ class FTP_TLS(FTP): source_address: tuple[str, int] | None = None, encoding: str = "utf-8", ) -> None: ... - elif sys.version_info >= (3, 9): + else: def __init__( self, host: str = "", @@ -146,19 +134,6 @@ class FTP_TLS(FTP): *, encoding: str = "utf-8", ) -> None: ... - else: - def __init__( - self, - host: str = "", - user: str = "", - passwd: str = "", - acct: str = "", - keyfile: str | None = None, - certfile: str | None = None, - context: SSLContext | None = None, - timeout: float | None = ..., - source_address: tuple[str, int] | None = None, - ) -> None: ... ssl_version: int keyfile: str | None certfile: str | None diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/functools.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/functools.pyi new file mode 100644 index 0000000000000..e31399fb87054 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/functools.pyi @@ -0,0 +1,247 @@ +import sys +import types +from _typeshed import SupportsAllComparisons, SupportsItems +from collections.abc import Callable, Hashable, Iterable, Sized +from types import GenericAlias +from typing import Any, Final, Generic, Literal, NamedTuple, TypedDict, TypeVar, final, overload +from typing_extensions import ParamSpec, Self, TypeAlias + +__all__ = [ + "update_wrapper", + "wraps", + "WRAPPER_ASSIGNMENTS", + "WRAPPER_UPDATES", + "total_ordering", + "cmp_to_key", + "lru_cache", + "reduce", + "partial", + "partialmethod", + "singledispatch", + "cached_property", + "singledispatchmethod", + "cache", +] + +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) +_S = TypeVar("_S") +_PWrapped = ParamSpec("_PWrapped") +_RWrapped = TypeVar("_RWrapped") +_PWrapper = ParamSpec("_PWrapper") +_RWrapper = TypeVar("_RWrapper") + +if sys.version_info >= (3, 14): + @overload + def reduce(function: Callable[[_T, _S], _T], iterable: Iterable[_S], /, initial: _T) -> _T: ... + +else: + @overload + def reduce(function: Callable[[_T, _S], _T], iterable: Iterable[_S], initial: _T, /) -> _T: ... + +@overload +def reduce(function: Callable[[_T, _T], _T], iterable: Iterable[_T], /) -> _T: ... + +class _CacheInfo(NamedTuple): + hits: int + misses: int + maxsize: int | None + currsize: int + +class _CacheParameters(TypedDict): + maxsize: int + typed: bool + +@final +class _lru_cache_wrapper(Generic[_T]): + __wrapped__: Callable[..., _T] + def __call__(self, *args: Hashable, **kwargs: Hashable) -> _T: ... + def cache_info(self) -> _CacheInfo: ... + def cache_clear(self) -> None: ... + def cache_parameters(self) -> _CacheParameters: ... + def __copy__(self) -> _lru_cache_wrapper[_T]: ... + def __deepcopy__(self, memo: Any, /) -> _lru_cache_wrapper[_T]: ... + +@overload +def lru_cache(maxsize: int | None = 128, typed: bool = False) -> Callable[[Callable[..., _T]], _lru_cache_wrapper[_T]]: ... +@overload +def lru_cache(maxsize: Callable[..., _T], typed: bool = False) -> _lru_cache_wrapper[_T]: ... + +if sys.version_info >= (3, 14): + WRAPPER_ASSIGNMENTS: Final[ + tuple[ + Literal["__module__"], + Literal["__name__"], + Literal["__qualname__"], + Literal["__doc__"], + Literal["__annotate__"], + Literal["__type_params__"], + ] + ] +elif sys.version_info >= (3, 12): + WRAPPER_ASSIGNMENTS: Final[ + tuple[ + Literal["__module__"], + Literal["__name__"], + Literal["__qualname__"], + Literal["__doc__"], + Literal["__annotations__"], + Literal["__type_params__"], + ] + ] +else: + WRAPPER_ASSIGNMENTS: Final[ + tuple[Literal["__module__"], Literal["__name__"], Literal["__qualname__"], Literal["__doc__"], Literal["__annotations__"]] + ] + +WRAPPER_UPDATES: tuple[Literal["__dict__"]] + +class _Wrapped(Generic[_PWrapped, _RWrapped, _PWrapper, _RWrapper]): + __wrapped__: Callable[_PWrapped, _RWrapped] + def __call__(self, *args: _PWrapper.args, **kwargs: _PWrapper.kwargs) -> _RWrapper: ... + # as with ``Callable``, we'll assume that these attributes exist + __name__: str + __qualname__: str + +class _Wrapper(Generic[_PWrapped, _RWrapped]): + def __call__(self, f: Callable[_PWrapper, _RWrapper]) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... + +if sys.version_info >= (3, 14): + def update_wrapper( + wrapper: Callable[_PWrapper, _RWrapper], + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotate__", "__type_params__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... + def wraps( + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotate__", "__type_params__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapper[_PWrapped, _RWrapped]: ... + +elif sys.version_info >= (3, 12): + def update_wrapper( + wrapper: Callable[_PWrapper, _RWrapper], + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__", "__type_params__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... + def wraps( + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__", "__type_params__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapper[_PWrapped, _RWrapped]: ... + +else: + def update_wrapper( + wrapper: Callable[_PWrapper, _RWrapper], + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapped[_PWrapped, _RWrapped, _PWrapper, _RWrapper]: ... + def wraps( + wrapped: Callable[_PWrapped, _RWrapped], + assigned: Iterable[str] = ("__module__", "__name__", "__qualname__", "__doc__", "__annotations__"), + updated: Iterable[str] = ("__dict__",), + ) -> _Wrapper[_PWrapped, _RWrapped]: ... + +def total_ordering(cls: type[_T]) -> type[_T]: ... +def cmp_to_key(mycmp: Callable[[_T, _T], int]) -> Callable[[_T], SupportsAllComparisons]: ... + +class partial(Generic[_T]): + @property + def func(self) -> Callable[..., _T]: ... + @property + def args(self) -> tuple[Any, ...]: ... + @property + def keywords(self) -> dict[str, Any]: ... + def __new__(cls, func: Callable[..., _T], /, *args: Any, **kwargs: Any) -> Self: ... + def __call__(self, /, *args: Any, **kwargs: Any) -> _T: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +# With protocols, this could change into a generic protocol that defines __get__ and returns _T +_Descriptor: TypeAlias = Any + +class partialmethod(Generic[_T]): + func: Callable[..., _T] | _Descriptor + args: tuple[Any, ...] + keywords: dict[str, Any] + @overload + def __init__(self, func: Callable[..., _T], /, *args: Any, **keywords: Any) -> None: ... + @overload + def __init__(self, func: _Descriptor, /, *args: Any, **keywords: Any) -> None: ... + def __get__(self, obj: Any, cls: type[Any] | None = None) -> Callable[..., _T]: ... + @property + def __isabstractmethod__(self) -> bool: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +if sys.version_info >= (3, 11): + _RegType: TypeAlias = type[Any] | types.UnionType +else: + _RegType: TypeAlias = type[Any] + +class _SingleDispatchCallable(Generic[_T]): + registry: types.MappingProxyType[Any, Callable[..., _T]] + def dispatch(self, cls: Any) -> Callable[..., _T]: ... + # @fun.register(complex) + # def _(arg, verbose=False): ... + @overload + def register(self, cls: _RegType, func: None = None) -> Callable[[Callable[..., _T]], Callable[..., _T]]: ... + # @fun.register + # def _(arg: int, verbose=False): + @overload + def register(self, cls: Callable[..., _T], func: None = None) -> Callable[..., _T]: ... + # fun.register(int, lambda x: x) + @overload + def register(self, cls: _RegType, func: Callable[..., _T]) -> Callable[..., _T]: ... + def _clear_cache(self) -> None: ... + def __call__(self, /, *args: Any, **kwargs: Any) -> _T: ... + +def singledispatch(func: Callable[..., _T]) -> _SingleDispatchCallable[_T]: ... + +class singledispatchmethod(Generic[_T]): + dispatcher: _SingleDispatchCallable[_T] + func: Callable[..., _T] + def __init__(self, func: Callable[..., _T]) -> None: ... + @property + def __isabstractmethod__(self) -> bool: ... + @overload + def register(self, cls: _RegType, method: None = None) -> Callable[[Callable[..., _T]], Callable[..., _T]]: ... + @overload + def register(self, cls: Callable[..., _T], method: None = None) -> Callable[..., _T]: ... + @overload + def register(self, cls: _RegType, method: Callable[..., _T]) -> Callable[..., _T]: ... + def __get__(self, obj: _S, cls: type[_S] | None = None) -> Callable[..., _T]: ... + +class cached_property(Generic[_T_co]): + func: Callable[[Any], _T_co] + attrname: str | None + def __init__(self, func: Callable[[Any], _T_co]) -> None: ... + @overload + def __get__(self, instance: None, owner: type[Any] | None = None) -> Self: ... + @overload + def __get__(self, instance: object, owner: type[Any] | None = None) -> _T_co: ... + def __set_name__(self, owner: type[Any], name: str) -> None: ... + # __set__ is not defined at runtime, but @cached_property is designed to be settable + def __set__(self, instance: object, value: _T_co) -> None: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +def cache(user_function: Callable[..., _T], /) -> _lru_cache_wrapper[_T]: ... +def _make_key( + args: tuple[Hashable, ...], + kwds: SupportsItems[Any, Any], + typed: bool, + kwd_mark: tuple[object, ...] = ..., + fasttypes: set[type] = ..., + tuple: type = ..., + type: Any = ..., + len: Callable[[Sized], int] = ..., +) -> Hashable: ... + +if sys.version_info >= (3, 14): + @final + class _PlaceholderType: ... + + Placeholder: Final[_PlaceholderType] + + __all__ += ["Placeholder"] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/gc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/gc.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/gc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/gc.pyi index 9d34e0d6213a3..06fb6b47c2d1d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/gc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/gc.pyi @@ -1,4 +1,3 @@ -import sys from collections.abc import Callable from typing import Any, Final, Literal from typing_extensions import TypeAlias @@ -28,10 +27,7 @@ def get_referrers(*objs: Any) -> list[Any]: ... def get_stats() -> list[dict[str, Any]]: ... def get_threshold() -> tuple[int, int, int]: ... def is_tracked(obj: Any, /) -> bool: ... - -if sys.version_info >= (3, 9): - def is_finalized(obj: Any, /) -> bool: ... - +def is_finalized(obj: Any, /) -> bool: ... def isenabled() -> bool: ... def set_debug(flags: int, /) -> None: ... def set_threshold(threshold0: int, threshold1: int = ..., threshold2: int = ..., /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/genericpath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/genericpath.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/genericpath.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/genericpath.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/getopt.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/getopt.pyi new file mode 100644 index 0000000000000..c15db8122cfcf --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/getopt.pyi @@ -0,0 +1,27 @@ +from collections.abc import Iterable, Sequence +from typing import Protocol, TypeVar, overload, type_check_only + +_StrSequenceT_co = TypeVar("_StrSequenceT_co", covariant=True, bound=Sequence[str]) + +@type_check_only +class _SliceableT(Protocol[_StrSequenceT_co]): + @overload + def __getitem__(self, key: int, /) -> str: ... + @overload + def __getitem__(self, key: slice, /) -> _StrSequenceT_co: ... + +__all__ = ["GetoptError", "error", "getopt", "gnu_getopt"] + +def getopt( + args: _SliceableT[_StrSequenceT_co], shortopts: str, longopts: Iterable[str] | str = [] +) -> tuple[list[tuple[str, str]], _StrSequenceT_co]: ... +def gnu_getopt( + args: Sequence[str], shortopts: str, longopts: Iterable[str] | str = [] +) -> tuple[list[tuple[str, str]], list[str]]: ... + +class GetoptError(Exception): + msg: str + opt: str + def __init__(self, msg: str, opt: str = "") -> None: ... + +error = GetoptError diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/getpass.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/getpass.pyi new file mode 100644 index 0000000000000..bb3013dfbf393 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/getpass.pyi @@ -0,0 +1,14 @@ +import sys +from typing import TextIO + +__all__ = ["getpass", "getuser", "GetPassWarning"] + +if sys.version_info >= (3, 14): + def getpass(prompt: str = "Password: ", stream: TextIO | None = None, *, echo_char: str | None = None) -> str: ... + +else: + def getpass(prompt: str = "Password: ", stream: TextIO | None = None) -> str: ... + +def getuser() -> str: ... + +class GetPassWarning(UserWarning): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/gettext.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/gettext.pyi similarity index 99% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/gettext.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/gettext.pyi index 4c17c0dc5de42..d8fd92a00e132 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/gettext.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/gettext.pyi @@ -167,3 +167,5 @@ if sys.version_info < (3, 11): def bind_textdomain_codeset(domain: str, codeset: str | None = None) -> str: ... Catalog = translation + +def c2py(plural: str) -> Callable[[int], int]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/glob.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/glob.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/glob.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/glob.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/graphlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/graphlib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/graphlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/graphlib.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/grp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/grp.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/grp.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/grp.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/gzip.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/gzip.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/gzip.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/gzip.pyi index 9b32008dcbf65..883456b1ddc3d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/gzip.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/gzip.pyi @@ -1,11 +1,15 @@ -import _compression import sys import zlib from _typeshed import ReadableBuffer, SizedBuffer, StrOrBytesPath -from io import FileIO -from typing import Final, Literal, Protocol, TextIO, overload +from io import FileIO, TextIOWrapper +from typing import Final, Literal, Protocol, overload from typing_extensions import TypeAlias +if sys.version_info >= (3, 14): + from compression._common._streams import BaseStream, DecompressReader +else: + from _compression import BaseStream, DecompressReader + __all__ = ["BadGzipFile", "GzipFile", "open", "compress", "decompress"] _ReadBinaryMode: TypeAlias = Literal["r", "rb"] @@ -57,13 +61,13 @@ def open( ) -> GzipFile: ... @overload def open( - filename: StrOrBytesPath, + filename: StrOrBytesPath | _ReadableFileobj | _WritableFileobj, mode: _OpenTextMode, compresslevel: int = 9, encoding: str | None = None, errors: str | None = None, newline: str | None = None, -) -> TextIO: ... +) -> TextIOWrapper: ... @overload def open( filename: StrOrBytesPath | _ReadableFileobj | _WritableFileobj, @@ -72,7 +76,7 @@ def open( encoding: str | None = None, errors: str | None = None, newline: str | None = None, -) -> GzipFile | TextIO: ... +) -> GzipFile | TextIOWrapper: ... class _PaddedFile: file: _ReadableFileobj @@ -84,7 +88,7 @@ class _PaddedFile: class BadGzipFile(OSError): ... -class GzipFile(_compression.BaseStream): +class GzipFile(BaseStream): myfileobj: FileIO | None mode: object name: str @@ -153,7 +157,7 @@ class GzipFile(_compression.BaseStream): def seek(self, offset: int, whence: int = 0) -> int: ... def readline(self, size: int | None = -1) -> bytes: ... -class _GzipReader(_compression.DecompressReader): +class _GzipReader(DecompressReader): def __init__(self, fp: _ReadableFileobj) -> None: ... def compress(data: SizedBuffer, compresslevel: int = 9, *, mtime: float | None = None) -> bytes: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/hashlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/hashlib.pyi new file mode 100644 index 0000000000000..b32c0e9925740 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/hashlib.pyi @@ -0,0 +1,87 @@ +import sys +from _blake2 import blake2b as blake2b, blake2s as blake2s +from _hashlib import ( + HASH, + _HashObject, + openssl_md5 as md5, + openssl_sha1 as sha1, + openssl_sha3_224 as sha3_224, + openssl_sha3_256 as sha3_256, + openssl_sha3_384 as sha3_384, + openssl_sha3_512 as sha3_512, + openssl_sha224 as sha224, + openssl_sha256 as sha256, + openssl_sha384 as sha384, + openssl_sha512 as sha512, + openssl_shake_128 as shake_128, + openssl_shake_256 as shake_256, + pbkdf2_hmac as pbkdf2_hmac, + scrypt as scrypt, +) +from _typeshed import ReadableBuffer +from collections.abc import Callable, Set as AbstractSet +from typing import Protocol + +if sys.version_info >= (3, 11): + __all__ = ( + "md5", + "sha1", + "sha224", + "sha256", + "sha384", + "sha512", + "blake2b", + "blake2s", + "sha3_224", + "sha3_256", + "sha3_384", + "sha3_512", + "shake_128", + "shake_256", + "new", + "algorithms_guaranteed", + "algorithms_available", + "pbkdf2_hmac", + "file_digest", + ) +else: + __all__ = ( + "md5", + "sha1", + "sha224", + "sha256", + "sha384", + "sha512", + "blake2b", + "blake2s", + "sha3_224", + "sha3_256", + "sha3_384", + "sha3_512", + "shake_128", + "shake_256", + "new", + "algorithms_guaranteed", + "algorithms_available", + "pbkdf2_hmac", + ) + +def new(name: str, data: ReadableBuffer = b"", *, usedforsecurity: bool = ...) -> HASH: ... + +algorithms_guaranteed: AbstractSet[str] +algorithms_available: AbstractSet[str] + +if sys.version_info >= (3, 11): + class _BytesIOLike(Protocol): + def getbuffer(self) -> ReadableBuffer: ... + + class _FileDigestFileObj(Protocol): + def readinto(self, buf: bytearray, /) -> int: ... + def readable(self) -> bool: ... + + def file_digest( + fileobj: _BytesIOLike | _FileDigestFileObj, digest: str | Callable[[], _HashObject], /, *, _bufsize: int = 262144 + ) -> HASH: ... + +# Legacy typing-only alias +_Hash = HASH diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/heapq.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/heapq.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/heapq.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/heapq.pyi index 7a3aa8b442a51..220c41f303fba 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/heapq.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/heapq.pyi @@ -1,6 +1,6 @@ from _heapq import * from _typeshed import SupportsRichComparison -from collections.abc import Callable, Iterable +from collections.abc import Callable, Generator, Iterable from typing import Any, Final, TypeVar __all__ = ["heappush", "heappop", "heapify", "heapreplace", "merge", "nlargest", "nsmallest", "heappushpop"] @@ -11,7 +11,7 @@ __about__: Final[str] def merge( *iterables: Iterable[_S], key: Callable[[_S], SupportsRichComparison] | None = None, reverse: bool = False -) -> Iterable[_S]: ... +) -> Generator[_S]: ... def nlargest(n: int, iterable: Iterable[_S], key: Callable[[_S], SupportsRichComparison] | None = None) -> list[_S]: ... def nsmallest(n: int, iterable: Iterable[_S], key: Callable[[_S], SupportsRichComparison] | None = None) -> list[_S]: ... def _heapify_max(heap: list[Any], /) -> None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/hmac.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/hmac.pyi similarity index 77% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/hmac.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/hmac.pyi index eccfbdc235f4a..300ed9eb26d85 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/hmac.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/hmac.pyi @@ -1,11 +1,11 @@ +from _hashlib import _HashObject, compare_digest as compare_digest from _typeshed import ReadableBuffer, SizedBuffer from collections.abc import Callable -from hashlib import _Hash as _HashlibHash from types import ModuleType -from typing import AnyStr, overload +from typing import overload from typing_extensions import TypeAlias -_DigestMod: TypeAlias = str | Callable[[], _HashlibHash] | ModuleType +_DigestMod: TypeAlias = str | Callable[[], _HashObject] | ModuleType trans_5C: bytes trans_36: bytes @@ -30,8 +30,4 @@ class HMAC: def hexdigest(self) -> str: ... def copy(self) -> HMAC: ... -@overload -def compare_digest(a: ReadableBuffer, b: ReadableBuffer, /) -> bool: ... -@overload -def compare_digest(a: AnyStr, b: AnyStr, /) -> bool: ... def digest(key: SizedBuffer, msg: ReadableBuffer, digest: _DigestMod) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/html/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/html/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/html/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/html/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/html/entities.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/html/entities.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/html/entities.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/html/entities.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/html/parser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/html/parser.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/html/parser.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/html/parser.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/http/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/http/__init__.pyi new file mode 100644 index 0000000000000..f60c3909736d3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/http/__init__.pyi @@ -0,0 +1,118 @@ +import sys +from enum import IntEnum + +if sys.version_info >= (3, 11): + from enum import StrEnum + +if sys.version_info >= (3, 11): + __all__ = ["HTTPStatus", "HTTPMethod"] +else: + __all__ = ["HTTPStatus"] + +class HTTPStatus(IntEnum): + @property + def phrase(self) -> str: ... + @property + def description(self) -> str: ... + + # Keep these synced with the global constants in http/client.pyi. + CONTINUE = 100 + SWITCHING_PROTOCOLS = 101 + PROCESSING = 102 + EARLY_HINTS = 103 + + OK = 200 + CREATED = 201 + ACCEPTED = 202 + NON_AUTHORITATIVE_INFORMATION = 203 + NO_CONTENT = 204 + RESET_CONTENT = 205 + PARTIAL_CONTENT = 206 + MULTI_STATUS = 207 + ALREADY_REPORTED = 208 + IM_USED = 226 + + MULTIPLE_CHOICES = 300 + MOVED_PERMANENTLY = 301 + FOUND = 302 + SEE_OTHER = 303 + NOT_MODIFIED = 304 + USE_PROXY = 305 + TEMPORARY_REDIRECT = 307 + PERMANENT_REDIRECT = 308 + + BAD_REQUEST = 400 + UNAUTHORIZED = 401 + PAYMENT_REQUIRED = 402 + FORBIDDEN = 403 + NOT_FOUND = 404 + METHOD_NOT_ALLOWED = 405 + NOT_ACCEPTABLE = 406 + PROXY_AUTHENTICATION_REQUIRED = 407 + REQUEST_TIMEOUT = 408 + CONFLICT = 409 + GONE = 410 + LENGTH_REQUIRED = 411 + PRECONDITION_FAILED = 412 + if sys.version_info >= (3, 13): + CONTENT_TOO_LARGE = 413 + REQUEST_ENTITY_TOO_LARGE = 413 + if sys.version_info >= (3, 13): + URI_TOO_LONG = 414 + REQUEST_URI_TOO_LONG = 414 + UNSUPPORTED_MEDIA_TYPE = 415 + if sys.version_info >= (3, 13): + RANGE_NOT_SATISFIABLE = 416 + REQUESTED_RANGE_NOT_SATISFIABLE = 416 + EXPECTATION_FAILED = 417 + IM_A_TEAPOT = 418 + MISDIRECTED_REQUEST = 421 + if sys.version_info >= (3, 13): + UNPROCESSABLE_CONTENT = 422 + UNPROCESSABLE_ENTITY = 422 + LOCKED = 423 + FAILED_DEPENDENCY = 424 + TOO_EARLY = 425 + UPGRADE_REQUIRED = 426 + PRECONDITION_REQUIRED = 428 + TOO_MANY_REQUESTS = 429 + REQUEST_HEADER_FIELDS_TOO_LARGE = 431 + UNAVAILABLE_FOR_LEGAL_REASONS = 451 + + INTERNAL_SERVER_ERROR = 500 + NOT_IMPLEMENTED = 501 + BAD_GATEWAY = 502 + SERVICE_UNAVAILABLE = 503 + GATEWAY_TIMEOUT = 504 + HTTP_VERSION_NOT_SUPPORTED = 505 + VARIANT_ALSO_NEGOTIATES = 506 + INSUFFICIENT_STORAGE = 507 + LOOP_DETECTED = 508 + NOT_EXTENDED = 510 + NETWORK_AUTHENTICATION_REQUIRED = 511 + + if sys.version_info >= (3, 12): + @property + def is_informational(self) -> bool: ... + @property + def is_success(self) -> bool: ... + @property + def is_redirection(self) -> bool: ... + @property + def is_client_error(self) -> bool: ... + @property + def is_server_error(self) -> bool: ... + +if sys.version_info >= (3, 11): + class HTTPMethod(StrEnum): + @property + def description(self) -> str: ... + CONNECT = "CONNECT" + DELETE = "DELETE" + GET = "GET" + HEAD = "HEAD" + OPTIONS = "OPTIONS" + PATCH = "PATCH" + POST = "POST" + PUT = "PUT" + TRACE = "TRACE" diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/http/client.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/http/client.pyi new file mode 100644 index 0000000000000..5c35dff28d43a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/http/client.pyi @@ -0,0 +1,265 @@ +import email.message +import io +import ssl +import sys +import types +from _typeshed import MaybeNone, ReadableBuffer, SupportsRead, SupportsReadline, WriteableBuffer +from collections.abc import Callable, Iterable, Iterator, Mapping +from email._policybase import _MessageT +from socket import socket +from typing import BinaryIO, Literal, TypeVar, overload +from typing_extensions import Self, TypeAlias + +__all__ = [ + "HTTPResponse", + "HTTPConnection", + "HTTPException", + "NotConnected", + "UnknownProtocol", + "UnknownTransferEncoding", + "UnimplementedFileMode", + "IncompleteRead", + "InvalidURL", + "ImproperConnectionState", + "CannotSendRequest", + "CannotSendHeader", + "ResponseNotReady", + "BadStatusLine", + "LineTooLong", + "RemoteDisconnected", + "error", + "responses", + "HTTPSConnection", +] + +_DataType: TypeAlias = SupportsRead[bytes] | Iterable[ReadableBuffer] | ReadableBuffer +_T = TypeVar("_T") +_HeaderValue: TypeAlias = ReadableBuffer | str | int + +HTTP_PORT: int +HTTPS_PORT: int + +# Keep these global constants in sync with http.HTTPStatus (http/__init__.pyi). +# They are present for backward compatibility reasons. +CONTINUE: Literal[100] +SWITCHING_PROTOCOLS: Literal[101] +PROCESSING: Literal[102] +EARLY_HINTS: Literal[103] + +OK: Literal[200] +CREATED: Literal[201] +ACCEPTED: Literal[202] +NON_AUTHORITATIVE_INFORMATION: Literal[203] +NO_CONTENT: Literal[204] +RESET_CONTENT: Literal[205] +PARTIAL_CONTENT: Literal[206] +MULTI_STATUS: Literal[207] +ALREADY_REPORTED: Literal[208] +IM_USED: Literal[226] + +MULTIPLE_CHOICES: Literal[300] +MOVED_PERMANENTLY: Literal[301] +FOUND: Literal[302] +SEE_OTHER: Literal[303] +NOT_MODIFIED: Literal[304] +USE_PROXY: Literal[305] +TEMPORARY_REDIRECT: Literal[307] +PERMANENT_REDIRECT: Literal[308] + +BAD_REQUEST: Literal[400] +UNAUTHORIZED: Literal[401] +PAYMENT_REQUIRED: Literal[402] +FORBIDDEN: Literal[403] +NOT_FOUND: Literal[404] +METHOD_NOT_ALLOWED: Literal[405] +NOT_ACCEPTABLE: Literal[406] +PROXY_AUTHENTICATION_REQUIRED: Literal[407] +REQUEST_TIMEOUT: Literal[408] +CONFLICT: Literal[409] +GONE: Literal[410] +LENGTH_REQUIRED: Literal[411] +PRECONDITION_FAILED: Literal[412] +if sys.version_info >= (3, 13): + CONTENT_TOO_LARGE: Literal[413] +REQUEST_ENTITY_TOO_LARGE: Literal[413] +if sys.version_info >= (3, 13): + URI_TOO_LONG: Literal[414] +REQUEST_URI_TOO_LONG: Literal[414] +UNSUPPORTED_MEDIA_TYPE: Literal[415] +if sys.version_info >= (3, 13): + RANGE_NOT_SATISFIABLE: Literal[416] +REQUESTED_RANGE_NOT_SATISFIABLE: Literal[416] +EXPECTATION_FAILED: Literal[417] +IM_A_TEAPOT: Literal[418] +MISDIRECTED_REQUEST: Literal[421] +if sys.version_info >= (3, 13): + UNPROCESSABLE_CONTENT: Literal[422] +UNPROCESSABLE_ENTITY: Literal[422] +LOCKED: Literal[423] +FAILED_DEPENDENCY: Literal[424] +TOO_EARLY: Literal[425] +UPGRADE_REQUIRED: Literal[426] +PRECONDITION_REQUIRED: Literal[428] +TOO_MANY_REQUESTS: Literal[429] +REQUEST_HEADER_FIELDS_TOO_LARGE: Literal[431] +UNAVAILABLE_FOR_LEGAL_REASONS: Literal[451] + +INTERNAL_SERVER_ERROR: Literal[500] +NOT_IMPLEMENTED: Literal[501] +BAD_GATEWAY: Literal[502] +SERVICE_UNAVAILABLE: Literal[503] +GATEWAY_TIMEOUT: Literal[504] +HTTP_VERSION_NOT_SUPPORTED: Literal[505] +VARIANT_ALSO_NEGOTIATES: Literal[506] +INSUFFICIENT_STORAGE: Literal[507] +LOOP_DETECTED: Literal[508] +NOT_EXTENDED: Literal[510] +NETWORK_AUTHENTICATION_REQUIRED: Literal[511] + +responses: dict[int, str] + +class HTTPMessage(email.message.Message[str, str]): + def getallmatchingheaders(self, name: str) -> list[str]: ... # undocumented + +@overload +def parse_headers(fp: SupportsReadline[bytes], _class: Callable[[], _MessageT]) -> _MessageT: ... +@overload +def parse_headers(fp: SupportsReadline[bytes]) -> HTTPMessage: ... + +class HTTPResponse(io.BufferedIOBase, BinaryIO): # type: ignore[misc] # incompatible method definitions in the base classes + msg: HTTPMessage + headers: HTTPMessage + version: int + debuglevel: int + fp: io.BufferedReader + closed: bool + status: int + reason: str + chunked: bool + chunk_left: int | None + length: int | None + will_close: bool + # url is set on instances of the class in urllib.request.AbstractHTTPHandler.do_open + # to match urllib.response.addinfourl's interface. + # It's not set in HTTPResponse.__init__ or any other method on the class + url: str + def __init__(self, sock: socket, debuglevel: int = 0, method: str | None = None, url: str | None = None) -> None: ... + def peek(self, n: int = -1) -> bytes: ... + def read(self, amt: int | None = None) -> bytes: ... + def read1(self, n: int = -1) -> bytes: ... + def readinto(self, b: WriteableBuffer) -> int: ... + def readline(self, limit: int = -1) -> bytes: ... # type: ignore[override] + @overload + def getheader(self, name: str) -> str | None: ... + @overload + def getheader(self, name: str, default: _T) -> str | _T: ... + def getheaders(self) -> list[tuple[str, str]]: ... + def isclosed(self) -> bool: ... + def __iter__(self) -> Iterator[bytes]: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None + ) -> None: ... + def info(self) -> email.message.Message: ... + def geturl(self) -> str: ... + def getcode(self) -> int: ... + def begin(self) -> None: ... + +class HTTPConnection: + auto_open: int # undocumented + debuglevel: int + default_port: int # undocumented + response_class: type[HTTPResponse] # undocumented + timeout: float | None + host: str + port: int + sock: socket | MaybeNone # can be `None` if `.connect()` was not called + def __init__( + self, + host: str, + port: int | None = None, + timeout: float | None = ..., + source_address: tuple[str, int] | None = None, + blocksize: int = 8192, + ) -> None: ... + def request( + self, + method: str, + url: str, + body: _DataType | str | None = None, + headers: Mapping[str, _HeaderValue] = {}, + *, + encode_chunked: bool = False, + ) -> None: ... + def getresponse(self) -> HTTPResponse: ... + def set_debuglevel(self, level: int) -> None: ... + if sys.version_info >= (3, 12): + def get_proxy_response_headers(self) -> HTTPMessage | None: ... + + def set_tunnel(self, host: str, port: int | None = None, headers: Mapping[str, str] | None = None) -> None: ... + def connect(self) -> None: ... + def close(self) -> None: ... + def putrequest(self, method: str, url: str, skip_host: bool = False, skip_accept_encoding: bool = False) -> None: ... + def putheader(self, header: str | bytes, *values: _HeaderValue) -> None: ... + def endheaders(self, message_body: _DataType | None = None, *, encode_chunked: bool = False) -> None: ... + def send(self, data: _DataType | str) -> None: ... + +class HTTPSConnection(HTTPConnection): + # Can be `None` if `.connect()` was not called: + sock: ssl.SSLSocket | MaybeNone + if sys.version_info >= (3, 12): + def __init__( + self, + host: str, + port: int | None = None, + *, + timeout: float | None = ..., + source_address: tuple[str, int] | None = None, + context: ssl.SSLContext | None = None, + blocksize: int = 8192, + ) -> None: ... + else: + def __init__( + self, + host: str, + port: int | None = None, + key_file: str | None = None, + cert_file: str | None = None, + timeout: float | None = ..., + source_address: tuple[str, int] | None = None, + *, + context: ssl.SSLContext | None = None, + check_hostname: bool | None = None, + blocksize: int = 8192, + ) -> None: ... + +class HTTPException(Exception): ... + +error = HTTPException + +class NotConnected(HTTPException): ... +class InvalidURL(HTTPException): ... + +class UnknownProtocol(HTTPException): + def __init__(self, version: str) -> None: ... + +class UnknownTransferEncoding(HTTPException): ... +class UnimplementedFileMode(HTTPException): ... + +class IncompleteRead(HTTPException): + def __init__(self, partial: bytes, expected: int | None = None) -> None: ... + partial: bytes + expected: int | None + +class ImproperConnectionState(HTTPException): ... +class CannotSendRequest(ImproperConnectionState): ... +class CannotSendHeader(ImproperConnectionState): ... +class ResponseNotReady(ImproperConnectionState): ... + +class BadStatusLine(HTTPException): + def __init__(self, line: str) -> None: ... + +class LineTooLong(HTTPException): + def __init__(self, line_type: str) -> None: ... + +class RemoteDisconnected(ConnectionResetError, BadStatusLine): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi index 56097f163afd3..31e1d3fc83785 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/http/cookiejar.pyi @@ -1,6 +1,6 @@ import sys from _typeshed import StrPath -from collections.abc import Iterable, Iterator, Sequence +from collections.abc import Iterator, Sequence from http.client import HTTPResponse from re import Pattern from typing import ClassVar, TypeVar, overload @@ -21,7 +21,7 @@ _T = TypeVar("_T") class LoadError(OSError): ... -class CookieJar(Iterable[Cookie]): +class CookieJar: non_word_re: ClassVar[Pattern[str]] # undocumented quote_re: ClassVar[Pattern[str]] # undocumented strict_domain_re: ClassVar[Pattern[str]] # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookies.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/http/cookies.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookies.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/http/cookies.pyi index c4af5256b5d8b..4df12e3125d4b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/http/cookies.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/http/cookies.pyi @@ -1,11 +1,8 @@ -import sys from collections.abc import Iterable, Mapping +from types import GenericAlias from typing import Any, Generic, TypeVar, overload from typing_extensions import TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = ["CookieError", "BaseCookie", "SimpleCookie"] _DataType: TypeAlias = str | Mapping[str, str | Morsel[Any]] @@ -44,8 +41,7 @@ class Morsel(dict[str, Any], Generic[_T]): def OutputString(self, attrs: list[str] | None = None) -> str: ... def __eq__(self, morsel: object) -> bool: ... def __setitem__(self, K: str, V: Any) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class BaseCookie(dict[str, Morsel[_T]], Generic[_T]): def __init__(self, input: _DataType | None = None) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/http/server.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/http/server.pyi new file mode 100644 index 0000000000000..429bb65bb0efc --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/http/server.pyi @@ -0,0 +1,130 @@ +import _socket +import email.message +import io +import socketserver +import sys +from _ssl import _PasswordType +from _typeshed import ReadableBuffer, StrOrBytesPath, StrPath, SupportsRead, SupportsWrite +from collections.abc import Callable, Iterable, Mapping, Sequence +from ssl import Purpose, SSLContext +from typing import Any, AnyStr, BinaryIO, ClassVar, Protocol, type_check_only +from typing_extensions import Self, deprecated + +if sys.version_info >= (3, 14): + __all__ = [ + "HTTPServer", + "ThreadingHTTPServer", + "HTTPSServer", + "ThreadingHTTPSServer", + "BaseHTTPRequestHandler", + "SimpleHTTPRequestHandler", + "CGIHTTPRequestHandler", + ] +else: + __all__ = ["HTTPServer", "ThreadingHTTPServer", "BaseHTTPRequestHandler", "SimpleHTTPRequestHandler", "CGIHTTPRequestHandler"] + +class HTTPServer(socketserver.TCPServer): + server_name: str + server_port: int + +class ThreadingHTTPServer(socketserver.ThreadingMixIn, HTTPServer): ... + +if sys.version_info >= (3, 14): + @type_check_only + class _SSLModule(Protocol): + @staticmethod + def create_default_context( + purpose: Purpose = ..., + *, + cafile: StrOrBytesPath | None = None, + capath: StrOrBytesPath | None = None, + cadata: str | ReadableBuffer | None = None, + ) -> SSLContext: ... + + class HTTPSServer(HTTPServer): + ssl: _SSLModule + certfile: StrOrBytesPath + keyfile: StrOrBytesPath | None + password: _PasswordType | None + alpn_protocols: Iterable[str] + def __init__( + self, + server_address: socketserver._AfInetAddress, + RequestHandlerClass: Callable[[Any, _socket._RetAddress, Self], socketserver.BaseRequestHandler], + bind_and_activate: bool = True, + *, + certfile: StrOrBytesPath, + keyfile: StrOrBytesPath | None = None, + password: _PasswordType | None = None, + alpn_protocols: Iterable[str] | None = None, + ) -> None: ... + def server_activate(self) -> None: ... + + class ThreadingHTTPSServer(socketserver.ThreadingMixIn, HTTPSServer): ... + +class BaseHTTPRequestHandler(socketserver.StreamRequestHandler): + client_address: tuple[str, int] + close_connection: bool + requestline: str + command: str + path: str + request_version: str + headers: email.message.Message + server_version: str + sys_version: str + error_message_format: str + error_content_type: str + protocol_version: str + MessageClass: type + responses: Mapping[int, tuple[str, str]] + default_request_version: str # undocumented + weekdayname: ClassVar[Sequence[str]] # undocumented + monthname: ClassVar[Sequence[str | None]] # undocumented + def handle_one_request(self) -> None: ... + def handle_expect_100(self) -> bool: ... + def send_error(self, code: int, message: str | None = None, explain: str | None = None) -> None: ... + def send_response(self, code: int, message: str | None = None) -> None: ... + def send_header(self, keyword: str, value: str) -> None: ... + def send_response_only(self, code: int, message: str | None = None) -> None: ... + def end_headers(self) -> None: ... + def flush_headers(self) -> None: ... + def log_request(self, code: int | str = "-", size: int | str = "-") -> None: ... + def log_error(self, format: str, *args: Any) -> None: ... + def log_message(self, format: str, *args: Any) -> None: ... + def version_string(self) -> str: ... + def date_time_string(self, timestamp: float | None = None) -> str: ... + def log_date_time_string(self) -> str: ... + def address_string(self) -> str: ... + def parse_request(self) -> bool: ... # undocumented + +class SimpleHTTPRequestHandler(BaseHTTPRequestHandler): + extensions_map: dict[str, str] + if sys.version_info >= (3, 12): + index_pages: ClassVar[tuple[str, ...]] + directory: str + def __init__( + self, + request: socketserver._RequestType, + client_address: _socket._RetAddress, + server: socketserver.BaseServer, + *, + directory: StrPath | None = None, + ) -> None: ... + def do_GET(self) -> None: ... + def do_HEAD(self) -> None: ... + def send_head(self) -> io.BytesIO | BinaryIO | None: ... # undocumented + def list_directory(self, path: StrPath) -> io.BytesIO | None: ... # undocumented + def translate_path(self, path: str) -> str: ... # undocumented + def copyfile(self, source: SupportsRead[AnyStr], outputfile: SupportsWrite[AnyStr]) -> None: ... # undocumented + def guess_type(self, path: StrPath) -> str: ... # undocumented + +def executable(path: StrPath) -> bool: ... # undocumented +@deprecated("Deprecated in Python 3.13; removal scheduled for Python 3.15") +class CGIHTTPRequestHandler(SimpleHTTPRequestHandler): + cgi_directories: list[str] + have_fork: bool # undocumented + def do_POST(self) -> None: ... + def is_cgi(self) -> bool: ... # undocumented + def is_executable(self, path: StrPath) -> bool: ... # undocumented + def is_python(self, path: StrPath) -> bool: ... # undocumented + def run_cgi(self) -> None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/imaplib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/imaplib.pyi similarity index 78% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/imaplib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/imaplib.pyi index 6a4d8b2e720a0..536985a592b7f 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/imaplib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/imaplib.pyi @@ -1,16 +1,16 @@ import subprocess import sys import time -from _typeshed import ReadableBuffer, SizedBuffer +from _typeshed import ReadableBuffer, SizedBuffer, Unused from builtins import list as _list # conflicts with a method named "list" -from collections.abc import Callable +from collections.abc import Callable, Generator from datetime import datetime from re import Pattern from socket import socket as _socket from ssl import SSLContext, SSLSocket from types import TracebackType from typing import IO, Any, Literal, SupportsAbs, SupportsInt -from typing_extensions import Self, TypeAlias +from typing_extensions import Self, TypeAlias, deprecated __all__ = ["IMAP4", "IMAP4_stream", "Internaldate2tuple", "Int2AP", "ParseFlags", "Time2Internaldate", "IMAP4_SSL"] @@ -40,18 +40,19 @@ class IMAP4: welcome: bytes capabilities: tuple[str, ...] PROTOCOL_VERSION: str - if sys.version_info >= (3, 9): - def __init__(self, host: str = "", port: int = 143, timeout: float | None = None) -> None: ... - def open(self, host: str = "", port: int = 143, timeout: float | None = None) -> None: ... + def __init__(self, host: str = "", port: int = 143, timeout: float | None = None) -> None: ... + def open(self, host: str = "", port: int = 143, timeout: float | None = None) -> None: ... + if sys.version_info >= (3, 14): + @property + @deprecated("IMAP4.file is unsupported, can cause errors, and may be removed.") + def file(self) -> IO[str] | IO[bytes]: ... else: - def __init__(self, host: str = "", port: int = 143) -> None: ... - def open(self, host: str = "", port: int = 143) -> None: ... + file: IO[str] | IO[bytes] def __getattr__(self, attr: str) -> Any: ... host: str port: int sock: _socket - file: IO[str] | IO[bytes] def read(self, size: int) -> bytes: ... def readline(self) -> bytes: ... def send(self, data: ReadableBuffer) -> None: ... @@ -77,6 +78,9 @@ class IMAP4: def getannotation(self, mailbox: str, entry: str, attribute: str) -> _CommandResults: ... def getquota(self, root: str) -> _CommandResults: ... def getquotaroot(self, mailbox: str) -> _CommandResults: ... + if sys.version_info >= (3, 14): + def idle(self, duration: float | None = None) -> Idler: ... + def list(self, directory: str = '""', pattern: str = "*") -> tuple[str, _AnyResponseData]: ... def login(self, user: str, password: str) -> tuple[Literal["OK"], _list[bytes]]: ... def login_cram_md5(self, user: str, password: str) -> _CommandResults: ... @@ -101,12 +105,19 @@ class IMAP4: def thread(self, threading_algorithm: str, charset: str, *search_criteria: str) -> _CommandResults: ... def uid(self, command: str, *args: str) -> _CommandResults: ... def unsubscribe(self, mailbox: str) -> _CommandResults: ... - if sys.version_info >= (3, 9): - def unselect(self) -> _CommandResults: ... - + def unselect(self) -> _CommandResults: ... def xatom(self, name: str, *args: str) -> _CommandResults: ... def print_log(self) -> None: ... +if sys.version_info >= (3, 14): + class Idler: + def __init__(self, imap: IMAP4, duration: float | None = None) -> None: ... + def __enter__(self) -> Self: ... + def __exit__(self, exc_type: object, exc_val: Unused, exc_tb: Unused) -> Literal[False]: ... + def __iter__(self) -> Self: ... + def __next__(self) -> tuple[str, float | None]: ... + def burst(self, interval: float = 0.1) -> Generator[tuple[str, float | None]]: ... + class IMAP4_SSL(IMAP4): if sys.version_info < (3, 12): keyfile: str @@ -115,16 +126,6 @@ class IMAP4_SSL(IMAP4): def __init__( self, host: str = "", port: int = 993, *, ssl_context: SSLContext | None = None, timeout: float | None = None ) -> None: ... - elif sys.version_info >= (3, 9): - def __init__( - self, - host: str = "", - port: int = 993, - keyfile: str | None = None, - certfile: str | None = None, - ssl_context: SSLContext | None = None, - timeout: float | None = None, - ) -> None: ... else: def __init__( self, @@ -133,27 +134,32 @@ class IMAP4_SSL(IMAP4): keyfile: str | None = None, certfile: str | None = None, ssl_context: SSLContext | None = None, + timeout: float | None = None, ) -> None: ... sslobj: SSLSocket - file: IO[Any] - if sys.version_info >= (3, 9): - def open(self, host: str = "", port: int | None = 993, timeout: float | None = None) -> None: ... + if sys.version_info >= (3, 14): + @property + @deprecated("IMAP4_SSL.file is unsupported, can cause errors, and may be removed.") + def file(self) -> IO[Any]: ... else: - def open(self, host: str = "", port: int | None = 993) -> None: ... + file: IO[Any] + def open(self, host: str = "", port: int | None = 993, timeout: float | None = None) -> None: ... def ssl(self) -> SSLSocket: ... class IMAP4_stream(IMAP4): command: str def __init__(self, command: str) -> None: ... - file: IO[Any] + if sys.version_info >= (3, 14): + @property + @deprecated("IMAP4_stream.file is unsupported, can cause errors, and may be removed.") + def file(self) -> IO[Any]: ... + else: + file: IO[Any] process: subprocess.Popen[bytes] writefile: IO[Any] readfile: IO[Any] - if sys.version_info >= (3, 9): - def open(self, host: str | None = None, port: int | None = None, timeout: float | None = None) -> None: ... - else: - def open(self, host: str | None = None, port: int | None = None) -> None: ... + def open(self, host: str | None = None, port: int | None = None, timeout: float | None = None) -> None: ... class _Authenticator: mech: Callable[[bytes], bytes | bytearray | memoryview | str | None] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/imghdr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/imghdr.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/imghdr.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/imghdr.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/imp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/imp.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/imp.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/imp.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi new file mode 100644 index 0000000000000..cab81512e92f2 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/__init__.pyi @@ -0,0 +1,15 @@ +import sys +from importlib._bootstrap import __import__ as __import__ +from importlib.abc import Loader +from types import ModuleType + +__all__ = ["__import__", "import_module", "invalidate_caches", "reload"] + +# `importlib.import_module` return type should be kept the same as `builtins.__import__` +def import_module(name: str, package: str | None = None) -> ModuleType: ... + +if sys.version_info < (3, 12): + def find_loader(name: str, path: str | None = None) -> Loader | None: ... + +def invalidate_caches() -> None: ... +def reload(module: ModuleType) -> ModuleType: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/_abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_abc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/_abc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/_abc.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap.pyi new file mode 100644 index 0000000000000..02427ff420620 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap.pyi @@ -0,0 +1,2 @@ +from _frozen_importlib import * +from _frozen_importlib import __import__ as __import__, _init_module_attrs as _init_module_attrs diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap_external.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap_external.pyi new file mode 100644 index 0000000000000..6210ce7083afa --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/_bootstrap_external.pyi @@ -0,0 +1,2 @@ +from _frozen_importlib_external import * +from _frozen_importlib_external import _NamespaceLoader as _NamespaceLoader diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/abc.pyi new file mode 100644 index 0000000000000..3016a3a43b36a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/abc.pyi @@ -0,0 +1,175 @@ +import _ast +import sys +import types +from _typeshed import ReadableBuffer, StrPath +from abc import ABCMeta, abstractmethod +from collections.abc import Iterator, Mapping, Sequence +from importlib import _bootstrap_external +from importlib.machinery import ModuleSpec +from io import BufferedReader +from typing import IO, Any, Literal, Protocol, overload, runtime_checkable +from typing_extensions import deprecated + +if sys.version_info >= (3, 11): + __all__ = [ + "Loader", + "MetaPathFinder", + "PathEntryFinder", + "ResourceLoader", + "InspectLoader", + "ExecutionLoader", + "FileLoader", + "SourceLoader", + ] + + if sys.version_info < (3, 12): + __all__ += ["Finder", "ResourceReader", "Traversable", "TraversableResources"] + +if sys.version_info >= (3, 10): + from importlib._abc import Loader as Loader +else: + class Loader(metaclass=ABCMeta): + def load_module(self, fullname: str) -> types.ModuleType: ... + def module_repr(self, module: types.ModuleType) -> str: ... + def create_module(self, spec: ModuleSpec) -> types.ModuleType | None: ... + # Not defined on the actual class for backwards-compatibility reasons, + # but expected in new code. + def exec_module(self, module: types.ModuleType) -> None: ... + +if sys.version_info < (3, 12): + class Finder(metaclass=ABCMeta): ... + +@deprecated("Deprecated as of Python 3.7: Use importlib.resources.abc.TraversableResources instead.") +class ResourceLoader(Loader): + @abstractmethod + def get_data(self, path: str) -> bytes: ... + +class InspectLoader(Loader): + def is_package(self, fullname: str) -> bool: ... + def get_code(self, fullname: str) -> types.CodeType | None: ... + @abstractmethod + def get_source(self, fullname: str) -> str | None: ... + def exec_module(self, module: types.ModuleType) -> None: ... + @staticmethod + def source_to_code( + data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, path: ReadableBuffer | StrPath = "<string>" + ) -> types.CodeType: ... + +class ExecutionLoader(InspectLoader): + @abstractmethod + def get_filename(self, fullname: str) -> str: ... + +class SourceLoader(_bootstrap_external.SourceLoader, ResourceLoader, ExecutionLoader, metaclass=ABCMeta): # type: ignore[misc] # incompatible definitions of source_to_code in the base classes + @deprecated("Deprecated as of Python 3.3: Use importlib.resources.abc.SourceLoader.path_stats instead.") + def path_mtime(self, path: str) -> float: ... + def set_data(self, path: str, data: bytes) -> None: ... + def get_source(self, fullname: str) -> str | None: ... + def path_stats(self, path: str) -> Mapping[str, Any]: ... + +# The base classes differ starting in 3.10: +if sys.version_info >= (3, 10): + # Please keep in sync with _typeshed.importlib.MetaPathFinderProtocol + class MetaPathFinder(metaclass=ABCMeta): + if sys.version_info < (3, 12): + def find_module(self, fullname: str, path: Sequence[str] | None) -> Loader | None: ... + + def invalidate_caches(self) -> None: ... + # Not defined on the actual class, but expected to exist. + def find_spec( + self, fullname: str, path: Sequence[str] | None, target: types.ModuleType | None = ..., / + ) -> ModuleSpec | None: ... + + class PathEntryFinder(metaclass=ABCMeta): + if sys.version_info < (3, 12): + def find_module(self, fullname: str) -> Loader | None: ... + def find_loader(self, fullname: str) -> tuple[Loader | None, Sequence[str]]: ... + + def invalidate_caches(self) -> None: ... + # Not defined on the actual class, but expected to exist. + def find_spec(self, fullname: str, target: types.ModuleType | None = ...) -> ModuleSpec | None: ... + +else: + # Please keep in sync with _typeshed.importlib.MetaPathFinderProtocol + class MetaPathFinder(Finder): + def find_module(self, fullname: str, path: Sequence[str] | None) -> Loader | None: ... + def invalidate_caches(self) -> None: ... + # Not defined on the actual class, but expected to exist. + def find_spec( + self, fullname: str, path: Sequence[str] | None, target: types.ModuleType | None = ..., / + ) -> ModuleSpec | None: ... + + class PathEntryFinder(Finder): + def find_module(self, fullname: str) -> Loader | None: ... + def find_loader(self, fullname: str) -> tuple[Loader | None, Sequence[str]]: ... + def invalidate_caches(self) -> None: ... + # Not defined on the actual class, but expected to exist. + def find_spec(self, fullname: str, target: types.ModuleType | None = ...) -> ModuleSpec | None: ... + +class FileLoader(_bootstrap_external.FileLoader, ResourceLoader, ExecutionLoader, metaclass=ABCMeta): + name: str + path: str + def __init__(self, fullname: str, path: str) -> None: ... + def get_data(self, path: str) -> bytes: ... + def get_filename(self, name: str | None = None) -> str: ... + def load_module(self, name: str | None = None) -> types.ModuleType: ... + +class ResourceReader(metaclass=ABCMeta): + @abstractmethod + def open_resource(self, resource: str) -> IO[bytes]: ... + @abstractmethod + def resource_path(self, resource: str) -> str: ... + if sys.version_info >= (3, 10): + @abstractmethod + def is_resource(self, path: str) -> bool: ... + else: + @abstractmethod + def is_resource(self, name: str) -> bool: ... + + @abstractmethod + def contents(self) -> Iterator[str]: ... + +@runtime_checkable +class Traversable(Protocol): + @abstractmethod + def is_dir(self) -> bool: ... + @abstractmethod + def is_file(self) -> bool: ... + @abstractmethod + def iterdir(self) -> Iterator[Traversable]: ... + if sys.version_info >= (3, 11): + @abstractmethod + def joinpath(self, *descendants: str) -> Traversable: ... + else: + @abstractmethod + def joinpath(self, child: str, /) -> Traversable: ... + + # The documentation and runtime protocol allows *args, **kwargs arguments, + # but this would mean that all implementers would have to support them, + # which is not the case. + @overload + @abstractmethod + def open(self, mode: Literal["r"] = "r", *, encoding: str | None = None, errors: str | None = None) -> IO[str]: ... + @overload + @abstractmethod + def open(self, mode: Literal["rb"]) -> IO[bytes]: ... + @property + @abstractmethod + def name(self) -> str: ... + if sys.version_info >= (3, 10): + def __truediv__(self, child: str, /) -> Traversable: ... + else: + @abstractmethod + def __truediv__(self, child: str, /) -> Traversable: ... + + @abstractmethod + def read_bytes(self) -> bytes: ... + @abstractmethod + def read_text(self, encoding: str | None = None) -> str: ... + +class TraversableResources(ResourceReader): + @abstractmethod + def files(self) -> Traversable: ... + def open_resource(self, resource: str) -> BufferedReader: ... + def resource_path(self, resource: Any) -> str: ... + def is_resource(self, path: str) -> bool: ... + def contents(self) -> Iterator[str]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi new file mode 100644 index 0000000000000..bb1a6f93d0e09 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/machinery.pyi @@ -0,0 +1,20 @@ +import sys +from importlib._bootstrap import BuiltinImporter as BuiltinImporter, FrozenImporter as FrozenImporter, ModuleSpec as ModuleSpec +from importlib._bootstrap_external import ( + BYTECODE_SUFFIXES as BYTECODE_SUFFIXES, + DEBUG_BYTECODE_SUFFIXES as DEBUG_BYTECODE_SUFFIXES, + EXTENSION_SUFFIXES as EXTENSION_SUFFIXES, + OPTIMIZED_BYTECODE_SUFFIXES as OPTIMIZED_BYTECODE_SUFFIXES, + SOURCE_SUFFIXES as SOURCE_SUFFIXES, + ExtensionFileLoader as ExtensionFileLoader, + FileFinder as FileFinder, + PathFinder as PathFinder, + SourceFileLoader as SourceFileLoader, + SourcelessFileLoader as SourcelessFileLoader, + WindowsRegistryFinder as WindowsRegistryFinder, +) + +if sys.version_info >= (3, 11): + from importlib._bootstrap_external import NamespaceLoader as NamespaceLoader + +def all_suffixes() -> list[str]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi new file mode 100644 index 0000000000000..15d8b50b09d21 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/__init__.pyi @@ -0,0 +1,290 @@ +import abc +import pathlib +import sys +import types +from _collections_abc import dict_keys, dict_values +from _typeshed import StrPath +from collections.abc import Iterable, Iterator, Mapping +from email.message import Message +from importlib.abc import MetaPathFinder +from os import PathLike +from pathlib import Path +from re import Pattern +from typing import Any, ClassVar, Generic, NamedTuple, TypeVar, overload +from typing_extensions import Self, TypeAlias + +_T = TypeVar("_T") +_KT = TypeVar("_KT") +_VT = TypeVar("_VT") + +__all__ = [ + "Distribution", + "DistributionFinder", + "PackageNotFoundError", + "distribution", + "distributions", + "entry_points", + "files", + "metadata", + "requires", + "version", +] + +if sys.version_info >= (3, 10): + __all__ += ["PackageMetadata", "packages_distributions"] + +if sys.version_info >= (3, 10): + from importlib.metadata._meta import PackageMetadata as PackageMetadata, SimplePath + def packages_distributions() -> Mapping[str, list[str]]: ... + + _SimplePath: TypeAlias = SimplePath + +else: + _SimplePath: TypeAlias = Path + +class PackageNotFoundError(ModuleNotFoundError): + @property + def name(self) -> str: ... # type: ignore[override] + +if sys.version_info >= (3, 13): + _EntryPointBase = object +elif sys.version_info >= (3, 11): + class DeprecatedTuple: + def __getitem__(self, item: int) -> str: ... + + _EntryPointBase = DeprecatedTuple +else: + class _EntryPointBase(NamedTuple): + name: str + value: str + group: str + +class EntryPoint(_EntryPointBase): + pattern: ClassVar[Pattern[str]] + if sys.version_info >= (3, 11): + name: str + value: str + group: str + + def __init__(self, name: str, value: str, group: str) -> None: ... + + def load(self) -> Any: ... # Callable[[], Any] or an importable module + @property + def extras(self) -> list[str]: ... + @property + def module(self) -> str: ... + @property + def attr(self) -> str: ... + if sys.version_info >= (3, 10): + dist: ClassVar[Distribution | None] + def matches( + self, + *, + name: str = ..., + value: str = ..., + group: str = ..., + module: str = ..., + attr: str = ..., + extras: list[str] = ..., + ) -> bool: ... # undocumented + + def __hash__(self) -> int: ... + def __eq__(self, other: object) -> bool: ... + if sys.version_info >= (3, 11): + def __lt__(self, other: object) -> bool: ... + if sys.version_info < (3, 12): + def __iter__(self) -> Iterator[Any]: ... # result of iter((str, Self)), really + +if sys.version_info >= (3, 12): + class EntryPoints(tuple[EntryPoint, ...]): + def __getitem__(self, name: str) -> EntryPoint: ... # type: ignore[override] + def select( + self, + *, + name: str = ..., + value: str = ..., + group: str = ..., + module: str = ..., + attr: str = ..., + extras: list[str] = ..., + ) -> EntryPoints: ... + @property + def names(self) -> set[str]: ... + @property + def groups(self) -> set[str]: ... + +elif sys.version_info >= (3, 10): + class DeprecatedList(list[_T]): ... + + class EntryPoints(DeprecatedList[EntryPoint]): # use as list is deprecated since 3.10 + # int argument is deprecated since 3.10 + def __getitem__(self, name: int | str) -> EntryPoint: ... # type: ignore[override] + def select( + self, + *, + name: str = ..., + value: str = ..., + group: str = ..., + module: str = ..., + attr: str = ..., + extras: list[str] = ..., + ) -> EntryPoints: ... + @property + def names(self) -> set[str]: ... + @property + def groups(self) -> set[str]: ... + +if sys.version_info >= (3, 10) and sys.version_info < (3, 12): + class Deprecated(Generic[_KT, _VT]): + def __getitem__(self, name: _KT) -> _VT: ... + @overload + def get(self, name: _KT, default: None = None) -> _VT | None: ... + @overload + def get(self, name: _KT, default: _T) -> _VT | _T: ... + def __iter__(self) -> Iterator[_KT]: ... + def __contains__(self, *args: object) -> bool: ... + def keys(self) -> dict_keys[_KT, _VT]: ... + def values(self) -> dict_values[_KT, _VT]: ... + + class SelectableGroups(Deprecated[str, EntryPoints], dict[str, EntryPoints]): # use as dict is deprecated since 3.10 + @classmethod + def load(cls, eps: Iterable[EntryPoint]) -> Self: ... + @property + def groups(self) -> set[str]: ... + @property + def names(self) -> set[str]: ... + @overload + def select(self) -> Self: ... + @overload + def select( + self, + *, + name: str = ..., + value: str = ..., + group: str = ..., + module: str = ..., + attr: str = ..., + extras: list[str] = ..., + ) -> EntryPoints: ... + +class PackagePath(pathlib.PurePosixPath): + def read_text(self, encoding: str = "utf-8") -> str: ... + def read_binary(self) -> bytes: ... + def locate(self) -> PathLike[str]: ... + # The following attributes are not defined on PackagePath, but are dynamically added by Distribution.files: + hash: FileHash | None + size: int | None + dist: Distribution + +class FileHash: + mode: str + value: str + def __init__(self, spec: str) -> None: ... + +if sys.version_info >= (3, 12): + class DeprecatedNonAbstract: ... + _distribution_parent = DeprecatedNonAbstract +else: + _distribution_parent = object + +class Distribution(_distribution_parent): + @abc.abstractmethod + def read_text(self, filename: str) -> str | None: ... + @abc.abstractmethod + def locate_file(self, path: StrPath) -> _SimplePath: ... + @classmethod + def from_name(cls, name: str) -> Distribution: ... + @overload + @classmethod + def discover(cls, *, context: DistributionFinder.Context) -> Iterable[Distribution]: ... + @overload + @classmethod + def discover( + cls, *, context: None = None, name: str | None = ..., path: list[str] = ..., **kwargs: Any + ) -> Iterable[Distribution]: ... + @staticmethod + def at(path: StrPath) -> PathDistribution: ... + + if sys.version_info >= (3, 10): + @property + def metadata(self) -> PackageMetadata: ... + @property + def entry_points(self) -> EntryPoints: ... + else: + @property + def metadata(self) -> Message: ... + @property + def entry_points(self) -> list[EntryPoint]: ... + + @property + def version(self) -> str: ... + @property + def files(self) -> list[PackagePath] | None: ... + @property + def requires(self) -> list[str] | None: ... + if sys.version_info >= (3, 10): + @property + def name(self) -> str: ... + if sys.version_info >= (3, 13): + @property + def origin(self) -> types.SimpleNamespace: ... + +class DistributionFinder(MetaPathFinder): + class Context: + name: str | None + def __init__(self, *, name: str | None = ..., path: list[str] = ..., **kwargs: Any) -> None: ... + @property + def path(self) -> list[str]: ... + + @abc.abstractmethod + def find_distributions(self, context: DistributionFinder.Context = ...) -> Iterable[Distribution]: ... + +class MetadataPathFinder(DistributionFinder): + @classmethod + def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ... + if sys.version_info >= (3, 11): + @classmethod + def invalidate_caches(cls) -> None: ... + elif sys.version_info >= (3, 10): + # Yes, this is an instance method that has a parameter named "cls" + def invalidate_caches(cls) -> None: ... + +class PathDistribution(Distribution): + _path: _SimplePath + def __init__(self, path: _SimplePath) -> None: ... + def read_text(self, filename: StrPath) -> str | None: ... + def locate_file(self, path: StrPath) -> _SimplePath: ... + +def distribution(distribution_name: str) -> Distribution: ... +@overload +def distributions(*, context: DistributionFinder.Context) -> Iterable[Distribution]: ... +@overload +def distributions( + *, context: None = None, name: str | None = ..., path: list[str] = ..., **kwargs: Any +) -> Iterable[Distribution]: ... + +if sys.version_info >= (3, 10): + def metadata(distribution_name: str) -> PackageMetadata: ... + +else: + def metadata(distribution_name: str) -> Message: ... + +if sys.version_info >= (3, 12): + def entry_points( + *, name: str = ..., value: str = ..., group: str = ..., module: str = ..., attr: str = ..., extras: list[str] = ... + ) -> EntryPoints: ... + +elif sys.version_info >= (3, 10): + @overload + def entry_points() -> SelectableGroups: ... + @overload + def entry_points( + *, name: str = ..., value: str = ..., group: str = ..., module: str = ..., attr: str = ..., extras: list[str] = ... + ) -> EntryPoints: ... + +else: + def entry_points() -> dict[str, list[EntryPoint]]: ... + +def version(distribution_name: str) -> str: ... +def files(distribution_name: str) -> list[PackagePath] | None: ... +def requires(distribution_name: str) -> list[str] | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/_meta.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/_meta.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/_meta.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/_meta.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/diagnose.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/diagnose.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/metadata/diagnose.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/metadata/diagnose.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/readers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/readers.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/readers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/readers.pyi index 41d7af966d58c..4a6c73921535a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/readers.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/readers.pyi @@ -5,16 +5,20 @@ import pathlib import sys import zipfile -from _typeshed import Incomplete, StrPath +from _typeshed import StrPath from collections.abc import Iterable, Iterator from io import BufferedReader from typing import Literal, NoReturn, TypeVar from typing_extensions import Never +if sys.version_info >= (3, 10): + from importlib._bootstrap_external import FileLoader + from zipimport import zipimporter + if sys.version_info >= (3, 11): - import importlib.resources.abc as abc + from importlib.resources import abc else: - import importlib.abc as abc + from importlib import abc if sys.version_info >= (3, 10): if sys.version_info >= (3, 11): @@ -27,14 +31,14 @@ if sys.version_info >= (3, 10): class FileReader(abc.TraversableResources): path: pathlib.Path - def __init__(self, loader) -> None: ... + def __init__(self, loader: FileLoader) -> None: ... def resource_path(self, resource: StrPath) -> str: ... def files(self) -> pathlib.Path: ... class ZipReader(abc.TraversableResources): prefix: str - archive: Incomplete - def __init__(self, loader, module: str) -> None: ... + archive: str + def __init__(self, loader: zipimporter, module: str) -> None: ... def open_resource(self, resource: str) -> BufferedReader: ... def is_resource(self, path: StrPath) -> bool: ... def files(self) -> zipfile.Path: ... @@ -63,6 +67,6 @@ if sys.version_info >= (3, 10): class NamespaceReader(abc.TraversableResources): path: MultiplexedPath - def __init__(self, namespace_path) -> None: ... + def __init__(self, namespace_path: Iterable[str]) -> None: ... def resource_path(self, resource: str) -> str: ... def files(self) -> MultiplexedPath: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi new file mode 100644 index 0000000000000..2cf6366b6cb3b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/__init__.pyi @@ -0,0 +1,76 @@ +import os +import sys +from collections.abc import Iterator +from contextlib import AbstractContextManager +from importlib.abc import Traversable +from pathlib import Path +from types import ModuleType +from typing import Any, BinaryIO, Literal, TextIO +from typing_extensions import TypeAlias + +if sys.version_info >= (3, 11): + from importlib.resources._common import Package as Package +else: + Package: TypeAlias = str | ModuleType + +__all__ = [ + "Package", + "as_file", + "contents", + "files", + "is_resource", + "open_binary", + "open_text", + "path", + "read_binary", + "read_text", +] + +if sys.version_info >= (3, 10): + __all__ += ["ResourceReader"] + +if sys.version_info < (3, 13): + __all__ += ["Resource"] + +if sys.version_info < (3, 11): + Resource: TypeAlias = str | os.PathLike[Any] +elif sys.version_info < (3, 13): + Resource: TypeAlias = str + +if sys.version_info >= (3, 12): + from importlib.resources._common import Anchor as Anchor + + __all__ += ["Anchor"] + +if sys.version_info >= (3, 13): + from importlib.resources._functional import ( + contents as contents, + is_resource as is_resource, + open_binary as open_binary, + open_text as open_text, + path as path, + read_binary as read_binary, + read_text as read_text, + ) + +else: + def open_binary(package: Package, resource: Resource) -> BinaryIO: ... + def open_text(package: Package, resource: Resource, encoding: str = "utf-8", errors: str = "strict") -> TextIO: ... + def read_binary(package: Package, resource: Resource) -> bytes: ... + def read_text(package: Package, resource: Resource, encoding: str = "utf-8", errors: str = "strict") -> str: ... + def path(package: Package, resource: Resource) -> AbstractContextManager[Path, Literal[False]]: ... + def is_resource(package: Package, name: str) -> bool: ... + def contents(package: Package) -> Iterator[str]: ... + +if sys.version_info >= (3, 11): + from importlib.resources._common import as_file as as_file +else: + def as_file(path: Traversable) -> AbstractContextManager[Path, Literal[False]]: ... + +if sys.version_info >= (3, 11): + from importlib.resources._common import files as files +else: + def files(package: Package) -> Traversable: ... + +if sys.version_info >= (3, 10): + from importlib.abc import ResourceReader as ResourceReader diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi index f04f70f25e230..d6a9436544dce 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_common.pyi @@ -7,7 +7,7 @@ if sys.version_info >= (3, 11): from contextlib import AbstractContextManager from importlib.abc import ResourceReader, Traversable from pathlib import Path - from typing import overload + from typing import Literal, overload from typing_extensions import TypeAlias, deprecated Package: TypeAlias = str | types.ModuleType @@ -16,7 +16,7 @@ if sys.version_info >= (3, 11): Anchor: TypeAlias = Package def package_to_anchor( - func: Callable[[Anchor | None], Traversable] + func: Callable[[Anchor | None], Traversable], ) -> Callable[[Anchor | None, Anchor | None], Traversable]: ... @overload def files(anchor: Anchor | None = None) -> Traversable: ... @@ -39,4 +39,4 @@ if sys.version_info >= (3, 11): def get_package(package: Package) -> types.ModuleType: ... def from_package(package: types.ModuleType) -> Traversable: ... - def as_file(path: Traversable) -> AbstractContextManager[Path]: ... + def as_file(path: Traversable) -> AbstractContextManager[Path, Literal[False]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi index 97e46bdf0a536..50f3405f9a00b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/_functional.pyi @@ -8,7 +8,7 @@ if sys.version_info >= (3, 13): from importlib.resources._common import Anchor from io import TextIOWrapper from pathlib import Path - from typing import BinaryIO, overload + from typing import BinaryIO, Literal, overload from typing_extensions import Unpack def open_binary(anchor: Anchor, *path_names: StrPath) -> BinaryIO: ... @@ -25,6 +25,6 @@ if sys.version_info >= (3, 13): ) -> str: ... @overload def read_text(anchor: Anchor, *path_names: StrPath, encoding: str | None, errors: str | None = "strict") -> str: ... - def path(anchor: Anchor, *path_names: StrPath) -> AbstractContextManager[Path]: ... + def path(anchor: Anchor, *path_names: StrPath) -> AbstractContextManager[Path, Literal[False]]: ... def is_resource(anchor: Anchor, *path_names: StrPath) -> bool: ... def contents(anchor: Anchor, *path_names: StrPath) -> Iterator[str]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi new file mode 100644 index 0000000000000..ad80605f7c71d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/abc.pyi @@ -0,0 +1,14 @@ +import sys + +if sys.version_info >= (3, 11): + # These are all actually defined in this file on 3.11+, + # and re-exported from importlib.abc, + # but it's much less code duplication for typeshed if we pretend that they're still defined + # in importlib.abc on 3.11+, and re-exported from this file + from importlib.abc import ( + ResourceReader as ResourceReader, + Traversable as Traversable, + TraversableResources as TraversableResources, + ) + + __all__ = ["ResourceReader", "Traversable", "TraversableResources"] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/readers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/readers.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/readers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/readers.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/simple.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/simple.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/resources/simple.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/resources/simple.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/simple.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/simple.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/importlib/simple.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/importlib/simple.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/importlib/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/util.pyi new file mode 100644 index 0000000000000..cc1c98ae4d0e4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/importlib/util.pyi @@ -0,0 +1,33 @@ +import importlib.abc +import importlib.machinery +import sys +import types +from _typeshed import ReadableBuffer +from collections.abc import Callable +from importlib._bootstrap import module_from_spec as module_from_spec, spec_from_loader as spec_from_loader +from importlib._bootstrap_external import ( + MAGIC_NUMBER as MAGIC_NUMBER, + cache_from_source as cache_from_source, + decode_source as decode_source, + source_from_cache as source_from_cache, + spec_from_file_location as spec_from_file_location, +) +from typing_extensions import ParamSpec + +_P = ParamSpec("_P") + +if sys.version_info < (3, 12): + def module_for_loader(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... + def set_loader(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... + def set_package(fxn: Callable[_P, types.ModuleType]) -> Callable[_P, types.ModuleType]: ... + +def resolve_name(name: str, package: str | None) -> str: ... +def find_spec(name: str, package: str | None = None) -> importlib.machinery.ModuleSpec | None: ... + +class LazyLoader(importlib.abc.Loader): + def __init__(self, loader: importlib.abc.Loader) -> None: ... + @classmethod + def factory(cls, loader: importlib.abc.Loader) -> Callable[..., LazyLoader]: ... + def exec_module(self, module: types.ModuleType) -> None: ... + +def source_hash(source_bytes: ReadableBuffer) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/inspect.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/inspect.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/inspect.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/inspect.pyi index 1eb9fc502e125..e19c2a634aa09 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/inspect.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/inspect.pyi @@ -2,7 +2,7 @@ import dis import enum import sys import types -from _typeshed import StrPath +from _typeshed import AnnotationForm, StrPath from collections import OrderedDict from collections.abc import AsyncGenerator, Awaitable, Callable, Coroutine, Generator, Mapping, Sequence, Set as AbstractSet from types import ( @@ -28,6 +28,9 @@ from types import ( from typing import Any, ClassVar, Final, Literal, NamedTuple, Protocol, TypeVar, overload from typing_extensions import ParamSpec, Self, TypeAlias, TypeGuard, TypeIs +if sys.version_info >= (3, 14): + from annotationlib import Format + if sys.version_info >= (3, 11): __all__ = [ "ArgInfo", @@ -139,12 +142,14 @@ if sys.version_info >= (3, 11): "getasyncgenstate", "BufferFlags", ] + if sys.version_info >= (3, 14): + __all__ += ["CO_HAS_DOCSTRING", "CO_METHOD", "ispackage"] _P = ParamSpec("_P") _T = TypeVar("_T") _F = TypeVar("_F", bound=Callable[..., Any]) -_T_cont = TypeVar("_T_cont", contravariant=True) -_V_cont = TypeVar("_V_cont", contravariant=True) +_T_contra = TypeVar("_T_contra", contravariant=True) +_V_contra = TypeVar("_V_contra", contravariant=True) # # Types and members @@ -172,6 +177,9 @@ CO_COROUTINE: Final = 128 CO_ITERABLE_COROUTINE: Final = 256 CO_ASYNC_GENERATOR: Final = 512 TPFLAGS_IS_ABSTRACT: Final = 1048576 +if sys.version_info >= (3, 14): + CO_HAS_DOCSTRING: Final = 67108864 + CO_METHOD: Final = 134217728 modulesbyfile: dict[str, Any] @@ -199,6 +207,11 @@ def getmodulename(path: StrPath) -> str | None: ... def ismodule(object: object) -> TypeIs[ModuleType]: ... def isclass(object: object) -> TypeIs[type[Any]]: ... def ismethod(object: object) -> TypeIs[MethodType]: ... + +if sys.version_info >= (3, 14): + # Not TypeIs because it does not return True for all modules + def ispackage(object: object) -> TypeGuard[ModuleType]: ... + def isfunction(object: object) -> TypeIs[FunctionType]: ... if sys.version_info >= (3, 12): @@ -228,11 +241,11 @@ def isasyncgenfunction(obj: Callable[_P, Any]) -> TypeGuard[Callable[_P, AsyncGe @overload def isasyncgenfunction(obj: object) -> TypeGuard[Callable[..., AsyncGeneratorType[Any, Any]]]: ... -class _SupportsSet(Protocol[_T_cont, _V_cont]): - def __set__(self, instance: _T_cont, value: _V_cont, /) -> None: ... +class _SupportsSet(Protocol[_T_contra, _V_contra]): + def __set__(self, instance: _T_contra, value: _V_contra, /) -> None: ... -class _SupportsDelete(Protocol[_T_cont]): - def __delete__(self, instance: _T_cont, /) -> None: ... +class _SupportsDelete(Protocol[_T_contra]): + def __delete__(self, instance: _T_contra, /) -> None: ... def isasyncgen(object: object) -> TypeIs[AsyncGeneratorType[Any, Any]]: ... def istraceback(object: object) -> TypeIs[TracebackType]: ... @@ -294,7 +307,18 @@ _IntrospectableCallable: TypeAlias = Callable[..., Any] # # Introspecting callables with the Signature object # -if sys.version_info >= (3, 10): +if sys.version_info >= (3, 14): + def signature( + obj: _IntrospectableCallable, + *, + follow_wrapped: bool = True, + globals: Mapping[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + eval_str: bool = False, + annotation_format: Format = Format.VALUE, # noqa: Y011 + ) -> Signature: ... + +elif sys.version_info >= (3, 10): def signature( obj: _IntrospectableCallable, *, @@ -323,7 +347,19 @@ class Signature: def bind_partial(self, *args: Any, **kwargs: Any) -> BoundArguments: ... def replace(self, *, parameters: Sequence[Parameter] | type[_void] | None = ..., return_annotation: Any = ...) -> Self: ... __replace__ = replace - if sys.version_info >= (3, 10): + if sys.version_info >= (3, 14): + @classmethod + def from_callable( + cls, + obj: _IntrospectableCallable, + *, + follow_wrapped: bool = True, + globals: Mapping[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + eval_str: bool = False, + annotation_format: Format = Format.VALUE, # noqa: Y011 + ) -> Self: ... + elif sys.version_info >= (3, 10): @classmethod def from_callable( cls, @@ -337,20 +373,24 @@ class Signature: else: @classmethod def from_callable(cls, obj: _IntrospectableCallable, *, follow_wrapped: bool = True) -> Self: ... - if sys.version_info >= (3, 13): + if sys.version_info >= (3, 14): + def format(self, *, max_width: int | None = None, quote_annotation_strings: bool = True) -> str: ... + elif sys.version_info >= (3, 13): def format(self, *, max_width: int | None = None) -> str: ... def __eq__(self, other: object) -> bool: ... def __hash__(self) -> int: ... -if sys.version_info >= (3, 10): +if sys.version_info >= (3, 14): + from annotationlib import get_annotations as get_annotations +elif sys.version_info >= (3, 10): def get_annotations( - obj: Callable[..., object] | type[Any] | ModuleType, + obj: Callable[..., object] | type[object] | ModuleType, # any callable, class, or module *, - globals: Mapping[str, Any] | None = None, - locals: Mapping[str, Any] | None = None, + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key eval_str: bool = False, - ) -> dict[str, Any]: ... + ) -> dict[str, AnnotationForm]: ... # values are type expressions # The name is the same as the enum's name in CPython class _ParameterKind(enum.IntEnum): @@ -370,7 +410,7 @@ if sys.version_info >= (3, 12): AGEN_CLOSED: Final = "AGEN_CLOSED" def getasyncgenstate( - agen: AsyncGenerator[Any, Any] + agen: AsyncGenerator[Any, Any], ) -> Literal["AGEN_CREATED", "AGEN_RUNNING", "AGEN_SUSPENDED", "AGEN_CLOSED"]: ... def getasyncgenlocals(agen: AsyncGeneratorType[Any, Any]) -> dict[str, Any]: ... @@ -416,16 +456,16 @@ class BoundArguments: def __init__(self, signature: Signature, arguments: OrderedDict[str, Any]) -> None: ... def apply_defaults(self) -> None: ... def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] # # Classes and functions # -# TODO: The actual return type should be list[_ClassTreeItem] but mypy doesn't -# seem to be supporting this at the moment: -# _ClassTreeItem = list[_ClassTreeItem] | Tuple[type, Tuple[type, ...]] -def getclasstree(classes: list[type], unique: bool = False) -> list[Any]: ... -def walktree(classes: list[type], children: Mapping[type[Any], list[type]], parent: type[Any] | None) -> list[Any]: ... +_ClassTreeItem: TypeAlias = list[tuple[type, ...]] | list[_ClassTreeItem] + +def getclasstree(classes: list[type], unique: bool = False) -> _ClassTreeItem: ... +def walktree(classes: list[type], children: Mapping[type[Any], list[type]], parent: type[Any] | None) -> _ClassTreeItem: ... class Arguments(NamedTuple): args: list[str] @@ -461,7 +501,13 @@ class ArgInfo(NamedTuple): locals: dict[str, Any] def getargvalues(frame: FrameType) -> ArgInfo: ... -def formatannotation(annotation: object, base_module: str | None = None) -> str: ... + +if sys.version_info >= (3, 14): + def formatannotation(annotation: object, base_module: str | None = None, *, quote_annotation_strings: bool = True) -> str: ... + +else: + def formatannotation(annotation: object, base_module: str | None = None) -> str: ... + def formatannotationrelativeto(object: object) -> Callable[[object], str]: ... if sys.version_info < (3, 11): @@ -590,7 +636,7 @@ GEN_SUSPENDED: Final = "GEN_SUSPENDED" GEN_CLOSED: Final = "GEN_CLOSED" def getgeneratorstate( - generator: Generator[Any, Any, Any] + generator: Generator[Any, Any, Any], ) -> Literal["GEN_CREATED", "GEN_RUNNING", "GEN_SUSPENDED", "GEN_CLOSED"]: ... CORO_CREATED: Final = "CORO_CREATED" @@ -599,7 +645,7 @@ CORO_SUSPENDED: Final = "CORO_SUSPENDED" CORO_CLOSED: Final = "CORO_CLOSED" def getcoroutinestate( - coroutine: Coroutine[Any, Any, Any] + coroutine: Coroutine[Any, Any, Any], ) -> Literal["CORO_CREATED", "CORO_RUNNING", "CORO_SUSPENDED", "CORO_CLOSED"]: ... def getgeneratorlocals(generator: Generator[Any, Any, Any]) -> dict[str, Any]: ... def getcoroutinelocals(coroutine: Coroutine[Any, Any, Any]) -> dict[str, Any]: ... @@ -616,8 +662,7 @@ class Attribute(NamedTuple): def classify_class_attrs(cls: type) -> list[Attribute]: ... -if sys.version_info >= (3, 9): - class ClassFoundException(Exception): ... +class ClassFoundException(Exception): ... if sys.version_info >= (3, 12): class BufferFlags(enum.IntFlag): diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/io.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/io.pyi similarity index 77% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/io.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/io.pyi index 5c26cb245a2f1..1313df183d36d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/io.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/io.pyi @@ -20,7 +20,7 @@ from _io import ( open as open, open_code as open_code, ) -from typing import Final +from typing import Final, Protocol, TypeVar __all__ = [ "BlockingIOError", @@ -44,11 +44,17 @@ __all__ = [ "SEEK_END", ] +if sys.version_info >= (3, 14): + __all__ += ["Reader", "Writer"] + if sys.version_info >= (3, 11): from _io import text_encoding as text_encoding __all__ += ["DEFAULT_BUFFER_SIZE", "IncrementalNewlineDecoder", "text_encoding"] +_T_co = TypeVar("_T_co", covariant=True) +_T_contra = TypeVar("_T_contra", contravariant=True) + SEEK_SET: Final = 0 SEEK_CUR: Final = 1 SEEK_END: Final = 2 @@ -58,3 +64,10 @@ class IOBase(_IOBase, metaclass=abc.ABCMeta): ... class RawIOBase(_RawIOBase, IOBase): ... class BufferedIOBase(_BufferedIOBase, IOBase): ... class TextIOBase(_TextIOBase, IOBase): ... + +if sys.version_info >= (3, 14): + class Reader(Protocol[_T_co]): + def read(self, size: int = ..., /) -> _T_co: ... + + class Writer(Protocol[_T_contra]): + def write(self, data: _T_contra, /) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ipaddress.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ipaddress.pyi similarity index 79% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ipaddress.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ipaddress.pyi index fa2faf8e6c13c..9df6bab7c167b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ipaddress.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ipaddress.pyi @@ -18,7 +18,7 @@ def ip_network( address: _RawIPAddress | _RawNetworkPart | tuple[_RawIPAddress] | tuple[_RawIPAddress, int], strict: bool = True ) -> IPv4Network | IPv6Network: ... def ip_interface( - address: _RawIPAddress | _RawNetworkPart | tuple[_RawIPAddress] | tuple[_RawIPAddress, int] + address: _RawIPAddress | _RawNetworkPart | tuple[_RawIPAddress] | tuple[_RawIPAddress, int], ) -> IPv4Interface | IPv6Interface: ... class _IPAddressBase: @@ -28,18 +28,16 @@ class _IPAddressBase: def exploded(self) -> str: ... @property def reverse_pointer(self) -> str: ... - @property - def version(self) -> int: ... + if sys.version_info < (3, 14): + @property + def version(self) -> int: ... class _BaseAddress(_IPAddressBase): - def __init__(self, address: object) -> None: ... def __add__(self, other: int) -> Self: ... def __hash__(self) -> int: ... def __int__(self) -> int: ... def __sub__(self, other: int) -> Self: ... - if sys.version_info >= (3, 9): - def __format__(self, fmt: str) -> str: ... - + def __format__(self, fmt: str) -> str: ... def __eq__(self, other: object) -> bool: ... def __lt__(self, other: Self) -> bool: ... if sys.version_info >= (3, 11): @@ -51,29 +49,9 @@ class _BaseAddress(_IPAddressBase): def __gt__(self, other: Self, NotImplemented: Any = ...) -> bool: ... def __le__(self, other: Self, NotImplemented: Any = ...) -> bool: ... - @property - def is_global(self) -> bool: ... - @property - def is_link_local(self) -> bool: ... - @property - def is_loopback(self) -> bool: ... - @property - def is_multicast(self) -> bool: ... - @property - def is_private(self) -> bool: ... - @property - def is_reserved(self) -> bool: ... - @property - def is_unspecified(self) -> bool: ... - @property - def max_prefixlen(self) -> int: ... - @property - def packed(self) -> bytes: ... - class _BaseNetwork(_IPAddressBase, Generic[_A]): network_address: _A netmask: _A - def __init__(self, address: object, strict: bool = ...) -> None: ... def __contains__(self, other: Any) -> bool: ... def __getitem__(self, n: int) -> _A: ... def __iter__(self) -> Iterator[_A]: ... @@ -109,8 +87,6 @@ class _BaseNetwork(_IPAddressBase, Generic[_A]): @property def is_unspecified(self) -> bool: ... @property - def max_prefixlen(self) -> int: ... - @property def num_addresses(self) -> int: ... def overlaps(self, other: _BaseNetwork[IPv4Address] | _BaseNetwork[IPv6Address]) -> bool: ... @property @@ -128,43 +104,85 @@ class _BaseNetwork(_IPAddressBase, Generic[_A]): @property def hostmask(self) -> _A: ... -class _BaseInterface(_BaseAddress, Generic[_A, _N]): - hostmask: _A - netmask: _A - network: _N +class _BaseV4: + if sys.version_info >= (3, 14): + version: Final = 4 + max_prefixlen: Final = 32 + else: + @property + def version(self) -> Literal[4]: ... + @property + def max_prefixlen(self) -> Literal[32]: ... + +class IPv4Address(_BaseV4, _BaseAddress): + def __init__(self, address: object) -> None: ... @property - def ip(self) -> _A: ... + def is_global(self) -> bool: ... @property - def with_hostmask(self) -> str: ... + def is_link_local(self) -> bool: ... @property - def with_netmask(self) -> str: ... + def is_loopback(self) -> bool: ... @property - def with_prefixlen(self) -> str: ... - -class _BaseV4: + def is_multicast(self) -> bool: ... @property - def version(self) -> Literal[4]: ... + def is_private(self) -> bool: ... @property - def max_prefixlen(self) -> Literal[32]: ... - -class IPv4Address(_BaseV4, _BaseAddress): + def is_reserved(self) -> bool: ... + @property + def is_unspecified(self) -> bool: ... + @property + def packed(self) -> bytes: ... if sys.version_info >= (3, 13): @property def ipv6_mapped(self) -> IPv6Address: ... -class IPv4Network(_BaseV4, _BaseNetwork[IPv4Address]): ... +class IPv4Network(_BaseV4, _BaseNetwork[IPv4Address]): + def __init__(self, address: object, strict: bool = ...) -> None: ... -class IPv4Interface(IPv4Address, _BaseInterface[IPv4Address, IPv4Network]): +class IPv4Interface(IPv4Address): + netmask: IPv4Address + network: IPv4Network def __eq__(self, other: object) -> bool: ... def __hash__(self) -> int: ... - -class _BaseV6: @property - def version(self) -> Literal[6]: ... + def hostmask(self) -> IPv4Address: ... @property - def max_prefixlen(self) -> Literal[128]: ... + def ip(self) -> IPv4Address: ... + @property + def with_hostmask(self) -> str: ... + @property + def with_netmask(self) -> str: ... + @property + def with_prefixlen(self) -> str: ... + +class _BaseV6: + if sys.version_info >= (3, 14): + version: Final = 6 + max_prefixlen: Final = 128 + else: + @property + def version(self) -> Literal[6]: ... + @property + def max_prefixlen(self) -> Literal[128]: ... class IPv6Address(_BaseV6, _BaseAddress): + def __init__(self, address: object) -> None: ... + @property + def is_global(self) -> bool: ... + @property + def is_link_local(self) -> bool: ... + @property + def is_loopback(self) -> bool: ... + @property + def is_multicast(self) -> bool: ... + @property + def is_private(self) -> bool: ... + @property + def is_reserved(self) -> bool: ... + @property + def is_unspecified(self) -> bool: ... + @property + def packed(self) -> bytes: ... @property def ipv4_mapped(self) -> IPv4Address | None: ... @property @@ -173,20 +191,31 @@ class IPv6Address(_BaseV6, _BaseAddress): def sixtofour(self) -> IPv4Address | None: ... @property def teredo(self) -> tuple[IPv4Address, IPv4Address] | None: ... - if sys.version_info >= (3, 9): - @property - def scope_id(self) -> str | None: ... - + @property + def scope_id(self) -> str | None: ... def __hash__(self) -> int: ... def __eq__(self, other: object) -> bool: ... class IPv6Network(_BaseV6, _BaseNetwork[IPv6Address]): + def __init__(self, address: object, strict: bool = ...) -> None: ... @property def is_site_local(self) -> bool: ... -class IPv6Interface(IPv6Address, _BaseInterface[IPv6Address, IPv6Network]): +class IPv6Interface(IPv6Address): + netmask: IPv6Address + network: IPv6Network def __eq__(self, other: object) -> bool: ... def __hash__(self) -> int: ... + @property + def hostmask(self) -> IPv6Address: ... + @property + def ip(self) -> IPv6Address: ... + @property + def with_hostmask(self) -> str: ... + @property + def with_netmask(self) -> str: ... + @property + def with_prefixlen(self) -> str: ... def v4_int_to_packed(address: int) -> bytes: ... def v6_int_to_packed(address: int) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/itertools.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/itertools.pyi similarity index 82% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/itertools.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/itertools.pyi index 1635b6a0a0729..d0085dd7224dc 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/itertools.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/itertools.pyi @@ -1,11 +1,10 @@ import sys +from _typeshed import MaybeNone from collections.abc import Callable, Iterable, Iterator +from types import GenericAlias from typing import Any, Generic, Literal, SupportsComplex, SupportsFloat, SupportsIndex, SupportsInt, TypeVar, overload from typing_extensions import Self, TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - _T = TypeVar("_T") _S = TypeVar("_S") _N = TypeVar("_N", int, float, SupportsFloat, SupportsInt, SupportsIndex, SupportsComplex) @@ -28,7 +27,7 @@ _Predicate: TypeAlias = Callable[[_T], object] # Technically count can take anything that implements a number protocol and has an add method # but we can't enforce the add method -class count(Iterator[_N]): +class count(Generic[_N]): @overload def __new__(cls) -> count[int]: ... @overload @@ -38,54 +37,53 @@ class count(Iterator[_N]): def __next__(self) -> _N: ... def __iter__(self) -> Self: ... -class cycle(Iterator[_T]): - def __init__(self, iterable: Iterable[_T], /) -> None: ... +class cycle(Generic[_T]): + def __new__(cls, iterable: Iterable[_T], /) -> Self: ... def __next__(self) -> _T: ... def __iter__(self) -> Self: ... -class repeat(Iterator[_T]): +class repeat(Generic[_T]): @overload - def __init__(self, object: _T) -> None: ... + def __new__(cls, object: _T) -> Self: ... @overload - def __init__(self, object: _T, times: int) -> None: ... + def __new__(cls, object: _T, times: int) -> Self: ... def __next__(self) -> _T: ... def __iter__(self) -> Self: ... def __length_hint__(self) -> int: ... -class accumulate(Iterator[_T]): +class accumulate(Generic[_T]): @overload - def __init__(self, iterable: Iterable[_T], func: None = None, *, initial: _T | None = ...) -> None: ... + def __new__(cls, iterable: Iterable[_T], func: None = None, *, initial: _T | None = ...) -> Self: ... @overload - def __init__(self, iterable: Iterable[_S], func: Callable[[_T, _S], _T], *, initial: _T | None = ...) -> None: ... + def __new__(cls, iterable: Iterable[_S], func: Callable[[_T, _S], _T], *, initial: _T | None = ...) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... -class chain(Iterator[_T]): - def __init__(self, *iterables: Iterable[_T]) -> None: ... +class chain(Generic[_T]): + def __new__(cls, *iterables: Iterable[_T]) -> Self: ... def __next__(self) -> _T: ... def __iter__(self) -> Self: ... @classmethod # We use type[Any] and not type[_S] to not lose the type inference from __iterable def from_iterable(cls: type[Any], iterable: Iterable[Iterable[_S]], /) -> chain[_S]: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... -class compress(Iterator[_T]): - def __init__(self, data: Iterable[_T], selectors: Iterable[Any]) -> None: ... +class compress(Generic[_T]): + def __new__(cls, data: Iterable[_T], selectors: Iterable[Any]) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... -class dropwhile(Iterator[_T]): - def __init__(self, predicate: _Predicate[_T], iterable: Iterable[_T], /) -> None: ... +class dropwhile(Generic[_T]): + def __new__(cls, predicate: _Predicate[_T], iterable: Iterable[_T], /) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... -class filterfalse(Iterator[_T]): - def __init__(self, predicate: _Predicate[_T] | None, iterable: Iterable[_T], /) -> None: ... +class filterfalse(Generic[_T]): + def __new__(cls, function: _Predicate[_T] | None, iterable: Iterable[_T], /) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... -class groupby(Iterator[tuple[_T_co, Iterator[_S_co]]], Generic[_T_co, _S_co]): +class groupby(Generic[_T_co, _S_co]): @overload def __new__(cls, iterable: Iterable[_T1], key: None = None) -> groupby[_T1, _T1]: ... @overload @@ -93,27 +91,27 @@ class groupby(Iterator[tuple[_T_co, Iterator[_S_co]]], Generic[_T_co, _S_co]): def __iter__(self) -> Self: ... def __next__(self) -> tuple[_T_co, Iterator[_S_co]]: ... -class islice(Iterator[_T]): +class islice(Generic[_T]): @overload - def __init__(self, iterable: Iterable[_T], stop: int | None, /) -> None: ... + def __new__(cls, iterable: Iterable[_T], stop: int | None, /) -> Self: ... @overload - def __init__(self, iterable: Iterable[_T], start: int | None, stop: int | None, step: int | None = ..., /) -> None: ... + def __new__(cls, iterable: Iterable[_T], start: int | None, stop: int | None, step: int | None = ..., /) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... -class starmap(Iterator[_T_co]): +class starmap(Generic[_T_co]): def __new__(cls, function: Callable[..., _T], iterable: Iterable[Iterable[Any]], /) -> starmap[_T]: ... def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... -class takewhile(Iterator[_T]): - def __init__(self, predicate: _Predicate[_T], iterable: Iterable[_T], /) -> None: ... +class takewhile(Generic[_T]): + def __new__(cls, predicate: _Predicate[_T], iterable: Iterable[_T], /) -> Self: ... def __iter__(self) -> Self: ... def __next__(self) -> _T: ... def tee(iterable: Iterable[_T], n: int = 2, /) -> tuple[Iterator[_T], ...]: ... -class zip_longest(Iterator[_T_co]): +class zip_longest(Generic[_T_co]): # one iterable (fillvalue doesn't matter) @overload def __new__(cls, iter1: Iterable[_T1], /, *, fillvalue: object = ...) -> zip_longest[tuple[_T1]]: ... @@ -122,7 +120,7 @@ class zip_longest(Iterator[_T_co]): # In the overloads without fillvalue, all of the tuple members could theoretically be None, # but we return Any instead to avoid false positives for code where we know one of the iterables # is longer. - def __new__(cls, iter1: Iterable[_T1], iter2: Iterable[_T2], /) -> zip_longest[tuple[_T1 | Any, _T2 | Any]]: ... + def __new__(cls, iter1: Iterable[_T1], iter2: Iterable[_T2], /) -> zip_longest[tuple[_T1 | MaybeNone, _T2 | MaybeNone]]: ... @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], /, *, fillvalue: _T @@ -131,7 +129,7 @@ class zip_longest(Iterator[_T_co]): @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], / - ) -> zip_longest[tuple[_T1 | Any, _T2 | Any, _T3 | Any]]: ... + ) -> zip_longest[tuple[_T1 | MaybeNone, _T2 | MaybeNone, _T3 | MaybeNone]]: ... @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], /, *, fillvalue: _T @@ -140,7 +138,7 @@ class zip_longest(Iterator[_T_co]): @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], iter4: Iterable[_T4], / - ) -> zip_longest[tuple[_T1 | Any, _T2 | Any, _T3 | Any, _T4 | Any]]: ... + ) -> zip_longest[tuple[_T1 | MaybeNone, _T2 | MaybeNone, _T3 | MaybeNone, _T4 | MaybeNone]]: ... @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], iter4: Iterable[_T4], /, *, fillvalue: _T @@ -149,7 +147,7 @@ class zip_longest(Iterator[_T_co]): @overload def __new__( cls, iter1: Iterable[_T1], iter2: Iterable[_T2], iter3: Iterable[_T3], iter4: Iterable[_T4], iter5: Iterable[_T5], / - ) -> zip_longest[tuple[_T1 | Any, _T2 | Any, _T3 | Any, _T4 | Any, _T5 | Any]]: ... + ) -> zip_longest[tuple[_T1 | MaybeNone, _T2 | MaybeNone, _T3 | MaybeNone, _T4 | MaybeNone, _T5 | MaybeNone]]: ... @overload def __new__( cls, @@ -174,7 +172,7 @@ class zip_longest(Iterator[_T_co]): iter6: Iterable[_T], /, *iterables: Iterable[_T], - ) -> zip_longest[tuple[_T | Any, ...]]: ... + ) -> zip_longest[tuple[_T | MaybeNone, ...]]: ... @overload def __new__( cls, @@ -191,7 +189,7 @@ class zip_longest(Iterator[_T_co]): def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... -class product(Iterator[_T_co]): +class product(Generic[_T_co]): @overload def __new__(cls, iter1: Iterable[_T1], /) -> product[tuple[_T1]]: ... @overload @@ -276,7 +274,7 @@ class product(Iterator[_T_co]): def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... -class permutations(Iterator[_T_co]): +class permutations(Generic[_T_co]): @overload def __new__(cls, iterable: Iterable[_T], r: Literal[2]) -> permutations[tuple[_T, _T]]: ... @overload @@ -290,7 +288,7 @@ class permutations(Iterator[_T_co]): def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... -class combinations(Iterator[_T_co]): +class combinations(Generic[_T_co]): @overload def __new__(cls, iterable: Iterable[_T], r: Literal[2]) -> combinations[tuple[_T, _T]]: ... @overload @@ -304,7 +302,7 @@ class combinations(Iterator[_T_co]): def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... -class combinations_with_replacement(Iterator[_T_co]): +class combinations_with_replacement(Generic[_T_co]): @overload def __new__(cls, iterable: Iterable[_T], r: Literal[2]) -> combinations_with_replacement[tuple[_T, _T]]: ... @overload @@ -319,13 +317,13 @@ class combinations_with_replacement(Iterator[_T_co]): def __next__(self) -> _T_co: ... if sys.version_info >= (3, 10): - class pairwise(Iterator[_T_co]): + class pairwise(Generic[_T_co]): def __new__(cls, iterable: Iterable[_T], /) -> pairwise[tuple[_T, _T]]: ... def __iter__(self) -> Self: ... def __next__(self) -> _T_co: ... if sys.version_info >= (3, 12): - class batched(Iterator[tuple[_T_co, ...]], Generic[_T_co]): + class batched(Generic[_T_co]): if sys.version_info >= (3, 13): def __new__(cls, iterable: Iterable[_T_co], n: int, *, strict: bool = False) -> Self: ... else: diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/json/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/json/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/json/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/json/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/json/decoder.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/json/decoder.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/json/decoder.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/json/decoder.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/json/encoder.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/json/encoder.pyi similarity index 82% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/json/encoder.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/json/encoder.pyi index aa4a3bdf61d4f..83b78666d4a70 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/json/encoder.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/json/encoder.pyi @@ -2,11 +2,11 @@ from collections.abc import Callable, Iterator from re import Pattern from typing import Any, Final -ESCAPE: Final[Pattern[str]] -ESCAPE_ASCII: Final[Pattern[str]] -HAS_UTF8: Final[Pattern[bytes]] -ESCAPE_DCT: Final[dict[str, str]] -INFINITY: Final[float] +ESCAPE: Final[Pattern[str]] # undocumented +ESCAPE_ASCII: Final[Pattern[str]] # undocumented +HAS_UTF8: Final[Pattern[bytes]] # undocumented +ESCAPE_DCT: Final[dict[str, str]] # undocumented +INFINITY: Final[float] # undocumented def py_encode_basestring(s: str) -> str: ... # undocumented def py_encode_basestring_ascii(s: str) -> str: ... # undocumented diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/json/scanner.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/json/scanner.pyi new file mode 100644 index 0000000000000..68b42e92d295e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/json/scanner.pyi @@ -0,0 +1,7 @@ +from _json import make_scanner as make_scanner +from re import Pattern +from typing import Final + +__all__ = ["make_scanner"] + +NUMBER_RE: Final[Pattern[str]] # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/json/tool.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/json/tool.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/json/tool.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/json/tool.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/keyword.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/keyword.pyi new file mode 100644 index 0000000000000..6b8bdad6beb6a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/keyword.pyi @@ -0,0 +1,16 @@ +from collections.abc import Sequence +from typing import Final + +__all__ = ["iskeyword", "issoftkeyword", "kwlist", "softkwlist"] + +def iskeyword(s: str, /) -> bool: ... + +# a list at runtime, but you're not meant to mutate it; +# type it as a sequence +kwlist: Final[Sequence[str]] + +def issoftkeyword(s: str, /) -> bool: ... + +# a list at runtime, but you're not meant to mutate it; +# type it as a sequence +softkwlist: Final[Sequence[str]] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/btm_matcher.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/btm_matcher.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/btm_matcher.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/btm_matcher.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixer_base.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixer_base.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixer_base.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixer_base.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_apply.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_apply.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_apply.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_apply.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_asserts.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_asserts.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_asserts.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_asserts.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_basestring.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_basestring.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_basestring.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_basestring.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_buffer.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_buffer.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_buffer.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_buffer.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_dict.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_dict.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_dict.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_dict.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_except.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_except.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_except.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_except.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exec.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exec.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exec.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exec.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_execfile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_execfile.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_execfile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_execfile.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exitfunc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exitfunc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exitfunc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_exitfunc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_filter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_filter.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_filter.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_filter.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_funcattrs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_funcattrs.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_funcattrs.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_funcattrs.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_future.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_future.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_future.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_future.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_getcwdu.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_getcwdu.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_getcwdu.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_getcwdu.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_has_key.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_has_key.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_has_key.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_has_key.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_idioms.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_idioms.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_idioms.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_idioms.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_import.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_import.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_import.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_import.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports2.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports2.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_imports2.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_input.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_input.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_input.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_input.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_intern.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_intern.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_intern.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_intern.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_isinstance.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_isinstance.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_isinstance.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_isinstance.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools_imports.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools_imports.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools_imports.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_itertools_imports.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_long.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_long.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_long.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_long.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_map.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_map.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_map.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_map.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_metaclass.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_metaclass.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_metaclass.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_metaclass.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_methodattrs.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_methodattrs.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_methodattrs.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_methodattrs.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ne.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ne.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ne.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ne.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_next.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_next.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_next.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_next.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_nonzero.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_nonzero.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_nonzero.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_nonzero.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_numliterals.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_numliterals.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_numliterals.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_numliterals.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_operator.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_operator.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_operator.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_operator.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_paren.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_paren.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_paren.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_paren.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_print.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_print.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_print.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_print.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raise.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raise.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raise.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raise.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raw_input.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raw_input.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raw_input.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_raw_input.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reduce.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reduce.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reduce.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reduce.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reload.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reload.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reload.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_reload.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_renames.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_renames.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_renames.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_renames.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_repr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_repr.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_repr.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_repr.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_set_literal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_set_literal.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_set_literal.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_set_literal.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_standarderror.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_standarderror.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_standarderror.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_standarderror.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_sys_exc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_sys_exc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_sys_exc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_sys_exc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_throw.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_throw.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_throw.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_throw.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_tuple_params.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_tuple_params.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_tuple_params.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_tuple_params.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_types.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_types.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_types.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_types.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_unicode.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_unicode.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_unicode.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_unicode.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_urllib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_urllib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_urllib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_urllib.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ws_comma.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ws_comma.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ws_comma.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_ws_comma.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xrange.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xrange.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xrange.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xrange.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xreadlines.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xreadlines.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xreadlines.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_xreadlines.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_zip.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_zip.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_zip.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/fixes/fix_zip.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/main.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/main.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/main.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/main.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/driver.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/driver.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/driver.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/driver.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/grammar.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/grammar.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/grammar.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/grammar.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/literals.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/literals.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/literals.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/literals.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/parse.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/parse.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/parse.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/parse.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi index 6d9f776c61aec..5776d100d1da0 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/pgen.pyi @@ -1,6 +1,6 @@ from _typeshed import Incomplete, StrPath from collections.abc import Iterable, Iterator -from typing import IO, NoReturn, overload +from typing import IO, ClassVar, NoReturn, overload from . import grammar from .tokenize import _TokenInfo @@ -46,5 +46,6 @@ class DFAState: def addarc(self, next: DFAState, label: str) -> None: ... def unifystate(self, old: DFAState, new: DFAState) -> None: ... def __eq__(self, other: DFAState) -> bool: ... # type: ignore[override] + __hash__: ClassVar[None] # type: ignore[assignment] def generate_grammar(filename: StrPath = "Grammar.txt") -> PgenGrammar: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/token.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/token.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/token.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/token.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/tokenize.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/tokenize.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/tokenize.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pgen2/tokenize.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pygram.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pygram.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pygram.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pygram.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi index 138333bd58af1..51bdbc75e1421 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/pytree.pyi @@ -1,7 +1,7 @@ from _typeshed import Incomplete, SupportsGetItem, SupportsLenAndGetItem, Unused from abc import abstractmethod from collections.abc import Iterable, Iterator, MutableSequence -from typing import Final +from typing import ClassVar, Final from typing_extensions import Self, TypeAlias from .fixer_base import BaseFix @@ -24,6 +24,7 @@ class Base: was_changed: bool was_checked: bool def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] @abstractmethod def _eq(self, other: Base) -> bool: ... @abstractmethod diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/refactor.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/refactor.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/lib2to3/refactor.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/lib2to3/refactor.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/linecache.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/linecache.pyi similarity index 82% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/linecache.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/linecache.pyi index 2e050e13b621b..5379a21e7d123 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/linecache.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/linecache.pyi @@ -1,12 +1,8 @@ -import sys from collections.abc import Callable from typing import Any from typing_extensions import TypeAlias -if sys.version_info >= (3, 9): - __all__ = ["getline", "clearcache", "checkcache", "lazycache"] -else: - __all__ = ["getline", "clearcache", "checkcache"] +__all__ = ["getline", "clearcache", "checkcache", "lazycache"] _ModuleGlobals: TypeAlias = dict[str, Any] _ModuleMetadata: TypeAlias = tuple[int, float | None, list[str], str] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/locale.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/locale.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/locale.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/locale.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/logging/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/logging/__init__.pyi new file mode 100644 index 0000000000000..e555f74a81af7 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/logging/__init__.pyi @@ -0,0 +1,657 @@ +import sys +import threading +from _typeshed import StrPath, SupportsWrite +from collections.abc import Callable, Iterable, Mapping, MutableMapping, Sequence +from io import TextIOWrapper +from re import Pattern +from string import Template +from time import struct_time +from types import FrameType, GenericAlias, TracebackType +from typing import Any, ClassVar, Final, Generic, Literal, Protocol, TextIO, TypeVar, overload +from typing_extensions import Self, TypeAlias, deprecated + +__all__ = [ + "BASIC_FORMAT", + "BufferingFormatter", + "CRITICAL", + "DEBUG", + "ERROR", + "FATAL", + "FileHandler", + "Filter", + "Formatter", + "Handler", + "INFO", + "LogRecord", + "Logger", + "LoggerAdapter", + "NOTSET", + "NullHandler", + "StreamHandler", + "WARN", + "WARNING", + "addLevelName", + "basicConfig", + "captureWarnings", + "critical", + "debug", + "disable", + "error", + "exception", + "fatal", + "getLevelName", + "getLogger", + "getLoggerClass", + "info", + "log", + "makeLogRecord", + "setLoggerClass", + "shutdown", + "warning", + "getLogRecordFactory", + "setLogRecordFactory", + "lastResort", + "raiseExceptions", + "warn", +] + +if sys.version_info >= (3, 11): + __all__ += ["getLevelNamesMapping"] +if sys.version_info >= (3, 12): + __all__ += ["getHandlerByName", "getHandlerNames"] + +_SysExcInfoType: TypeAlias = tuple[type[BaseException], BaseException, TracebackType | None] | tuple[None, None, None] +_ExcInfoType: TypeAlias = None | bool | _SysExcInfoType | BaseException +_ArgsType: TypeAlias = tuple[object, ...] | Mapping[str, object] +_Level: TypeAlias = int | str +_FormatStyle: TypeAlias = Literal["%", "{", "$"] + +if sys.version_info >= (3, 12): + class _SupportsFilter(Protocol): + def filter(self, record: LogRecord, /) -> bool | LogRecord: ... + + _FilterType: TypeAlias = Filter | Callable[[LogRecord], bool | LogRecord] | _SupportsFilter +else: + class _SupportsFilter(Protocol): + def filter(self, record: LogRecord, /) -> bool: ... + + _FilterType: TypeAlias = Filter | Callable[[LogRecord], bool] | _SupportsFilter + +raiseExceptions: bool +logThreads: bool +logMultiprocessing: bool +logProcesses: bool +_srcfile: str | None + +def currentframe() -> FrameType: ... + +_levelToName: dict[int, str] +_nameToLevel: dict[str, int] + +class Filterer: + filters: list[_FilterType] + def addFilter(self, filter: _FilterType) -> None: ... + def removeFilter(self, filter: _FilterType) -> None: ... + if sys.version_info >= (3, 12): + def filter(self, record: LogRecord) -> bool | LogRecord: ... + else: + def filter(self, record: LogRecord) -> bool: ... + +class Manager: # undocumented + root: RootLogger + disable: int + emittedNoHandlerWarning: bool + loggerDict: dict[str, Logger | PlaceHolder] + loggerClass: type[Logger] | None + logRecordFactory: Callable[..., LogRecord] | None + def __init__(self, rootnode: RootLogger) -> None: ... + def getLogger(self, name: str) -> Logger: ... + def setLoggerClass(self, klass: type[Logger]) -> None: ... + def setLogRecordFactory(self, factory: Callable[..., LogRecord]) -> None: ... + +class Logger(Filterer): + name: str # undocumented + level: int # undocumented + parent: Logger | None # undocumented + propagate: bool + handlers: list[Handler] # undocumented + disabled: bool # undocumented + root: ClassVar[RootLogger] # undocumented + manager: Manager # undocumented + def __init__(self, name: str, level: _Level = 0) -> None: ... + def setLevel(self, level: _Level) -> None: ... + def isEnabledFor(self, level: int) -> bool: ... + def getEffectiveLevel(self) -> int: ... + def getChild(self, suffix: str) -> Self: ... # see python/typing#980 + if sys.version_info >= (3, 12): + def getChildren(self) -> set[Logger]: ... + + def debug( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def info( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def warning( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + @deprecated("Deprecated; use warning() instead.") + def warn( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def error( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def exception( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = True, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def critical( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def log( + self, + level: int, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + ) -> None: ... + def _log( + self, + level: int, + msg: object, + args: _ArgsType, + exc_info: _ExcInfoType | None = None, + extra: Mapping[str, object] | None = None, + stack_info: bool = False, + stacklevel: int = 1, + ) -> None: ... # undocumented + fatal = critical + def addHandler(self, hdlr: Handler) -> None: ... + def removeHandler(self, hdlr: Handler) -> None: ... + def findCaller(self, stack_info: bool = False, stacklevel: int = 1) -> tuple[str, int, str, str | None]: ... + def handle(self, record: LogRecord) -> None: ... + def makeRecord( + self, + name: str, + level: int, + fn: str, + lno: int, + msg: object, + args: _ArgsType, + exc_info: _SysExcInfoType | None, + func: str | None = None, + extra: Mapping[str, object] | None = None, + sinfo: str | None = None, + ) -> LogRecord: ... + def hasHandlers(self) -> bool: ... + def callHandlers(self, record: LogRecord) -> None: ... # undocumented + +CRITICAL: Final = 50 +FATAL: Final = CRITICAL +ERROR: Final = 40 +WARNING: Final = 30 +WARN: Final = WARNING +INFO: Final = 20 +DEBUG: Final = 10 +NOTSET: Final = 0 + +class Handler(Filterer): + level: int # undocumented + formatter: Formatter | None # undocumented + lock: threading.Lock | None # undocumented + name: str | None # undocumented + def __init__(self, level: _Level = 0) -> None: ... + def get_name(self) -> str: ... # undocumented + def set_name(self, name: str) -> None: ... # undocumented + def createLock(self) -> None: ... + def acquire(self) -> None: ... + def release(self) -> None: ... + def setLevel(self, level: _Level) -> None: ... + def setFormatter(self, fmt: Formatter | None) -> None: ... + def flush(self) -> None: ... + def close(self) -> None: ... + def handle(self, record: LogRecord) -> bool: ... + def handleError(self, record: LogRecord) -> None: ... + def format(self, record: LogRecord) -> str: ... + def emit(self, record: LogRecord) -> None: ... + +if sys.version_info >= (3, 12): + def getHandlerByName(name: str) -> Handler | None: ... + def getHandlerNames() -> frozenset[str]: ... + +class Formatter: + converter: Callable[[float | None], struct_time] + _fmt: str | None # undocumented + datefmt: str | None # undocumented + _style: PercentStyle # undocumented + default_time_format: str + default_msec_format: str | None + + if sys.version_info >= (3, 10): + def __init__( + self, + fmt: str | None = None, + datefmt: str | None = None, + style: _FormatStyle = "%", + validate: bool = True, + *, + defaults: Mapping[str, Any] | None = None, + ) -> None: ... + else: + def __init__( + self, fmt: str | None = None, datefmt: str | None = None, style: _FormatStyle = "%", validate: bool = True + ) -> None: ... + + def format(self, record: LogRecord) -> str: ... + def formatTime(self, record: LogRecord, datefmt: str | None = None) -> str: ... + def formatException(self, ei: _SysExcInfoType) -> str: ... + def formatMessage(self, record: LogRecord) -> str: ... # undocumented + def formatStack(self, stack_info: str) -> str: ... + def usesTime(self) -> bool: ... # undocumented + +class BufferingFormatter: + linefmt: Formatter + def __init__(self, linefmt: Formatter | None = None) -> None: ... + def formatHeader(self, records: Sequence[LogRecord]) -> str: ... + def formatFooter(self, records: Sequence[LogRecord]) -> str: ... + def format(self, records: Sequence[LogRecord]) -> str: ... + +class Filter: + name: str # undocumented + nlen: int # undocumented + def __init__(self, name: str = "") -> None: ... + if sys.version_info >= (3, 12): + def filter(self, record: LogRecord) -> bool | LogRecord: ... + else: + def filter(self, record: LogRecord) -> bool: ... + +class LogRecord: + # args can be set to None by logging.handlers.QueueHandler + # (see https://bugs.python.org/issue44473) + args: _ArgsType | None + asctime: str + created: float + exc_info: _SysExcInfoType | None + exc_text: str | None + filename: str + funcName: str + levelname: str + levelno: int + lineno: int + module: str + msecs: float + # Only created when logging.Formatter.format is called. See #6132. + message: str + msg: str | Any # The runtime accepts any object, but will be a str in 99% of cases + name: str + pathname: str + process: int | None + processName: str | None + relativeCreated: float + stack_info: str | None + thread: int | None + threadName: str | None + if sys.version_info >= (3, 12): + taskName: str | None + + def __init__( + self, + name: str, + level: int, + pathname: str, + lineno: int, + msg: object, + args: _ArgsType | None, + exc_info: _SysExcInfoType | None, + func: str | None = None, + sinfo: str | None = None, + ) -> None: ... + def getMessage(self) -> str: ... + # Allows setting contextual information on LogRecord objects as per the docs, see #7833 + def __setattr__(self, name: str, value: Any, /) -> None: ... + +_L = TypeVar("_L", bound=Logger | LoggerAdapter[Any]) + +class LoggerAdapter(Generic[_L]): + logger: _L + manager: Manager # undocumented + + if sys.version_info >= (3, 13): + def __init__(self, logger: _L, extra: Mapping[str, object] | None = None, merge_extra: bool = False) -> None: ... + elif sys.version_info >= (3, 10): + def __init__(self, logger: _L, extra: Mapping[str, object] | None = None) -> None: ... + else: + def __init__(self, logger: _L, extra: Mapping[str, object]) -> None: ... + + if sys.version_info >= (3, 10): + extra: Mapping[str, object] | None + else: + extra: Mapping[str, object] + + def process(self, msg: Any, kwargs: MutableMapping[str, Any]) -> tuple[Any, MutableMapping[str, Any]]: ... + def debug( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def info( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def warning( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + @deprecated("Deprecated; use warning() instead.") + def warn( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def error( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def exception( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = True, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def critical( + self, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def log( + self, + level: int, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, + **kwargs: object, + ) -> None: ... + def isEnabledFor(self, level: int) -> bool: ... + def getEffectiveLevel(self) -> int: ... + def setLevel(self, level: _Level) -> None: ... + def hasHandlers(self) -> bool: ... + if sys.version_info >= (3, 11): + def _log( + self, + level: int, + msg: object, + args: _ArgsType, + *, + exc_info: _ExcInfoType | None = None, + extra: Mapping[str, object] | None = None, + stack_info: bool = False, + ) -> None: ... # undocumented + else: + def _log( + self, + level: int, + msg: object, + args: _ArgsType, + exc_info: _ExcInfoType | None = None, + extra: Mapping[str, object] | None = None, + stack_info: bool = False, + ) -> None: ... # undocumented + + @property + def name(self) -> str: ... # undocumented + if sys.version_info >= (3, 11): + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +def getLogger(name: str | None = None) -> Logger: ... +def getLoggerClass() -> type[Logger]: ... +def getLogRecordFactory() -> Callable[..., LogRecord]: ... +def debug( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def info( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def warning( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +@deprecated("Deprecated; use warning() instead.") +def warn( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def error( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def critical( + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def exception( + msg: object, + *args: object, + exc_info: _ExcInfoType = True, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... +def log( + level: int, + msg: object, + *args: object, + exc_info: _ExcInfoType = None, + stack_info: bool = False, + stacklevel: int = 1, + extra: Mapping[str, object] | None = None, +) -> None: ... + +fatal = critical + +def disable(level: int = 50) -> None: ... +def addLevelName(level: int, levelName: str) -> None: ... +@overload +def getLevelName(level: int) -> str: ... +@overload +@deprecated("The str -> int case is considered a mistake.") +def getLevelName(level: str) -> Any: ... + +if sys.version_info >= (3, 11): + def getLevelNamesMapping() -> dict[str, int]: ... + +def makeLogRecord(dict: Mapping[str, object]) -> LogRecord: ... +def basicConfig( + *, + filename: StrPath | None = ..., + filemode: str = ..., + format: str = ..., + datefmt: str | None = ..., + style: _FormatStyle = ..., + level: _Level | None = ..., + stream: SupportsWrite[str] | None = ..., + handlers: Iterable[Handler] | None = ..., + force: bool | None = ..., + encoding: str | None = ..., + errors: str | None = ..., +) -> None: ... +def shutdown(handlerList: Sequence[Any] = ...) -> None: ... # handlerList is undocumented +def setLoggerClass(klass: type[Logger]) -> None: ... +def captureWarnings(capture: bool) -> None: ... +def setLogRecordFactory(factory: Callable[..., LogRecord]) -> None: ... + +lastResort: Handler | None + +_StreamT = TypeVar("_StreamT", bound=SupportsWrite[str]) + +class StreamHandler(Handler, Generic[_StreamT]): + stream: _StreamT # undocumented + terminator: str + @overload + def __init__(self: StreamHandler[TextIO], stream: None = None) -> None: ... + @overload + def __init__(self: StreamHandler[_StreamT], stream: _StreamT) -> None: ... # pyright: ignore[reportInvalidTypeVarUse] #11780 + def setStream(self, stream: _StreamT) -> _StreamT | None: ... + if sys.version_info >= (3, 11): + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +class FileHandler(StreamHandler[TextIOWrapper]): + baseFilename: str # undocumented + mode: str # undocumented + encoding: str | None # undocumented + delay: bool # undocumented + errors: str | None # undocumented + def __init__( + self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None + ) -> None: ... + def _open(self) -> TextIOWrapper: ... # undocumented + +class NullHandler(Handler): ... + +class PlaceHolder: # undocumented + loggerMap: dict[Logger, None] + def __init__(self, alogger: Logger) -> None: ... + def append(self, alogger: Logger) -> None: ... + +# Below aren't in module docs but still visible + +class RootLogger(Logger): + def __init__(self, level: int) -> None: ... + +root: RootLogger + +class PercentStyle: # undocumented + default_format: str + asctime_format: str + asctime_search: str + validation_pattern: Pattern[str] + _fmt: str + if sys.version_info >= (3, 10): + def __init__(self, fmt: str, *, defaults: Mapping[str, Any] | None = None) -> None: ... + else: + def __init__(self, fmt: str) -> None: ... + + def usesTime(self) -> bool: ... + def validate(self) -> None: ... + def format(self, record: Any) -> str: ... + +class StrFormatStyle(PercentStyle): # undocumented + fmt_spec: Pattern[str] + field_spec: Pattern[str] + +class StringTemplateStyle(PercentStyle): # undocumented + _tpl: Template + +_STYLES: Final[dict[str, tuple[PercentStyle, str]]] + +BASIC_FORMAT: Final[str] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/logging/config.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/logging/config.pyi new file mode 100644 index 0000000000000..000ba1ebb06e0 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/logging/config.pyi @@ -0,0 +1,139 @@ +import sys +from _typeshed import StrOrBytesPath +from collections.abc import Callable, Hashable, Iterable, Mapping, Sequence +from configparser import RawConfigParser +from re import Pattern +from threading import Thread +from typing import IO, Any, Final, Literal, SupportsIndex, TypedDict, overload, type_check_only +from typing_extensions import Required, TypeAlias + +from . import Filter, Filterer, Formatter, Handler, Logger, _FilterType, _FormatStyle, _Level + +DEFAULT_LOGGING_CONFIG_PORT: int +RESET_ERROR: Final[int] # undocumented +IDENTIFIER: Final[Pattern[str]] # undocumented + +if sys.version_info >= (3, 11): + @type_check_only + class _RootLoggerConfiguration(TypedDict, total=False): + level: _Level + filters: Sequence[str | _FilterType] + handlers: Sequence[str] + +else: + @type_check_only + class _RootLoggerConfiguration(TypedDict, total=False): + level: _Level + filters: Sequence[str] + handlers: Sequence[str] + +@type_check_only +class _LoggerConfiguration(_RootLoggerConfiguration, TypedDict, total=False): + propagate: bool + +_FormatterConfigurationTypedDict = TypedDict( + "_FormatterConfigurationTypedDict", {"class": str, "format": str, "datefmt": str, "style": _FormatStyle}, total=False +) + +@type_check_only +class _FilterConfigurationTypedDict(TypedDict): + name: str + +# Formatter and filter configs can specify custom factories via the special `()` key. +# If that is the case, the dictionary can contain any additional keys +# https://docs.python.org/3/library/logging.config.html#user-defined-objects +_FormatterConfiguration: TypeAlias = _FormatterConfigurationTypedDict | dict[str, Any] +_FilterConfiguration: TypeAlias = _FilterConfigurationTypedDict | dict[str, Any] +# Handler config can have additional keys even when not providing a custom factory so we just use `dict`. +_HandlerConfiguration: TypeAlias = dict[str, Any] + +@type_check_only +class _DictConfigArgs(TypedDict, total=False): + version: Required[Literal[1]] + formatters: dict[str, _FormatterConfiguration] + filters: dict[str, _FilterConfiguration] + handlers: dict[str, _HandlerConfiguration] + loggers: dict[str, _LoggerConfiguration] + root: _RootLoggerConfiguration + incremental: bool + disable_existing_loggers: bool + +# Accept dict[str, Any] to avoid false positives if called with a dict +# type, since dict types are not compatible with TypedDicts. +# +# Also accept a TypedDict type, to allow callers to use TypedDict +# types, and for somewhat stricter type checking of dict literals. +def dictConfig(config: _DictConfigArgs | dict[str, Any]) -> None: ... + +if sys.version_info >= (3, 10): + def fileConfig( + fname: StrOrBytesPath | IO[str] | RawConfigParser, + defaults: Mapping[str, str] | None = None, + disable_existing_loggers: bool = True, + encoding: str | None = None, + ) -> None: ... + +else: + def fileConfig( + fname: StrOrBytesPath | IO[str] | RawConfigParser, + defaults: Mapping[str, str] | None = None, + disable_existing_loggers: bool = True, + ) -> None: ... + +def valid_ident(s: str) -> Literal[True]: ... # undocumented +def listen(port: int = 9030, verify: Callable[[bytes], bytes | None] | None = None) -> Thread: ... +def stopListening() -> None: ... + +class ConvertingMixin: # undocumented + def convert_with_key(self, key: Any, value: Any, replace: bool = True) -> Any: ... + def convert(self, value: Any) -> Any: ... + +class ConvertingDict(dict[Hashable, Any], ConvertingMixin): # undocumented + def __getitem__(self, key: Hashable) -> Any: ... + def get(self, key: Hashable, default: Any = None) -> Any: ... + def pop(self, key: Hashable, default: Any = None) -> Any: ... + +class ConvertingList(list[Any], ConvertingMixin): # undocumented + @overload + def __getitem__(self, key: SupportsIndex) -> Any: ... + @overload + def __getitem__(self, key: slice) -> Any: ... + def pop(self, idx: SupportsIndex = -1) -> Any: ... + +class ConvertingTuple(tuple[Any, ...], ConvertingMixin): # undocumented + @overload + def __getitem__(self, key: SupportsIndex) -> Any: ... + @overload + def __getitem__(self, key: slice) -> Any: ... + +class BaseConfigurator: # undocumented + CONVERT_PATTERN: Pattern[str] + WORD_PATTERN: Pattern[str] + DOT_PATTERN: Pattern[str] + INDEX_PATTERN: Pattern[str] + DIGIT_PATTERN: Pattern[str] + value_converters: dict[str, str] + importer: Callable[..., Any] + + def __init__(self, config: _DictConfigArgs | dict[str, Any]) -> None: ... + def resolve(self, s: str) -> Any: ... + def ext_convert(self, value: str) -> Any: ... + def cfg_convert(self, value: str) -> Any: ... + def convert(self, value: Any) -> Any: ... + def configure_custom(self, config: dict[str, Any]) -> Any: ... + def as_tuple(self, value: list[Any] | tuple[Any, ...]) -> tuple[Any, ...]: ... + +class DictConfigurator(BaseConfigurator): + def configure(self) -> None: ... # undocumented + def configure_formatter(self, config: _FormatterConfiguration) -> Formatter | Any: ... # undocumented + def configure_filter(self, config: _FilterConfiguration) -> Filter | Any: ... # undocumented + def add_filters(self, filterer: Filterer, filters: Iterable[_FilterType]) -> None: ... # undocumented + def configure_handler(self, config: _HandlerConfiguration) -> Handler | Any: ... # undocumented + def add_handlers(self, logger: Logger, handlers: Iterable[str]) -> None: ... # undocumented + def common_logger_config( + self, logger: Logger, config: _LoggerConfiguration, incremental: bool = False + ) -> None: ... # undocumented + def configure_logger(self, name: str, config: _LoggerConfiguration, incremental: bool = False) -> None: ... # undocumented + def configure_root(self, config: _LoggerConfiguration, incremental: bool = False) -> None: ... # undocumented + +dictConfigClass = DictConfigurator diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/handlers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/logging/handlers.pyi similarity index 75% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/logging/handlers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/logging/handlers.pyi index 91f9fe57e46f3..9636b81dc4f3c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/logging/handlers.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/logging/handlers.pyi @@ -8,7 +8,9 @@ from logging import FileHandler, Handler, LogRecord from re import Pattern from socket import SocketKind, socket from threading import Thread +from types import TracebackType from typing import Any, ClassVar, Final, Protocol, TypeVar +from typing_extensions import Self _T = TypeVar("_T") @@ -22,54 +24,34 @@ SYSLOG_TCP_PORT: Final[int] class WatchedFileHandler(FileHandler): dev: int # undocumented ino: int # undocumented - if sys.version_info >= (3, 9): - def __init__( - self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None - ) -> None: ... - else: - def __init__(self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False) -> None: ... - + def __init__( + self, filename: StrPath, mode: str = "a", encoding: str | None = None, delay: bool = False, errors: str | None = None + ) -> None: ... def _statstream(self) -> None: ... # undocumented def reopenIfNeeded(self) -> None: ... class BaseRotatingHandler(FileHandler): namer: Callable[[str], str] | None rotator: Callable[[str, str], None] | None - if sys.version_info >= (3, 9): - def __init__( - self, filename: StrPath, mode: str, encoding: str | None = None, delay: bool = False, errors: str | None = None - ) -> None: ... - else: - def __init__(self, filename: StrPath, mode: str, encoding: str | None = None, delay: bool = False) -> None: ... - + def __init__( + self, filename: StrPath, mode: str, encoding: str | None = None, delay: bool = False, errors: str | None = None + ) -> None: ... def rotation_filename(self, default_name: str) -> str: ... def rotate(self, source: str, dest: str) -> None: ... class RotatingFileHandler(BaseRotatingHandler): maxBytes: int # undocumented backupCount: int # undocumented - if sys.version_info >= (3, 9): - def __init__( - self, - filename: StrPath, - mode: str = "a", - maxBytes: int = 0, - backupCount: int = 0, - encoding: str | None = None, - delay: bool = False, - errors: str | None = None, - ) -> None: ... - else: - def __init__( - self, - filename: StrPath, - mode: str = "a", - maxBytes: int = 0, - backupCount: int = 0, - encoding: str | None = None, - delay: bool = False, - ) -> None: ... - + def __init__( + self, + filename: StrPath, + mode: str = "a", + maxBytes: int = 0, + backupCount: int = 0, + encoding: str | None = None, + delay: bool = False, + errors: str | None = None, + ) -> None: ... def doRollover(self) -> None: ... def shouldRollover(self, record: LogRecord) -> int: ... # undocumented @@ -83,32 +65,18 @@ class TimedRotatingFileHandler(BaseRotatingHandler): dayOfWeek: int # undocumented rolloverAt: int # undocumented extMatch: Pattern[str] # undocumented - if sys.version_info >= (3, 9): - def __init__( - self, - filename: StrPath, - when: str = "h", - interval: int = 1, - backupCount: int = 0, - encoding: str | None = None, - delay: bool = False, - utc: bool = False, - atTime: datetime.time | None = None, - errors: str | None = None, - ) -> None: ... - else: - def __init__( - self, - filename: StrPath, - when: str = "h", - interval: int = 1, - backupCount: int = 0, - encoding: str | None = None, - delay: bool = False, - utc: bool = False, - atTime: datetime.time | None = None, - ) -> None: ... - + def __init__( + self, + filename: StrPath, + when: str = "h", + interval: int = 1, + backupCount: int = 0, + encoding: str | None = None, + delay: bool = False, + utc: bool = False, + atTime: datetime.time | None = None, + errors: str | None = None, + ) -> None: ... def doRollover(self) -> None: ... def shouldRollover(self, record: LogRecord) -> int: ... # undocumented def computeRollover(self, currentTime: int) -> int: ... # undocumented @@ -155,13 +123,10 @@ class SysLogHandler(Handler): LOG_CRON: int LOG_AUTHPRIV: int LOG_FTP: int - - if sys.version_info >= (3, 9): - LOG_NTP: int - LOG_SECURITY: int - LOG_CONSOLE: int - LOG_SOLCRON: int - + LOG_NTP: int + LOG_SECURITY: int + LOG_CONSOLE: int + LOG_SOLCRON: int LOG_LOCAL0: int LOG_LOCAL1: int LOG_LOCAL2: int @@ -179,9 +144,19 @@ class SysLogHandler(Handler): priority_names: ClassVar[dict[str, int]] # undocumented facility_names: ClassVar[dict[str, int]] # undocumented priority_map: ClassVar[dict[str, str]] # undocumented - def __init__( - self, address: tuple[str, int] | str = ("localhost", 514), facility: str | int = 1, socktype: SocketKind | None = None - ) -> None: ... + if sys.version_info >= (3, 14): + timeout: float | None + def __init__( + self, + address: tuple[str, int] | str = ("localhost", 514), + facility: str | int = 1, + socktype: SocketKind | None = None, + timeout: float | None = None, + ) -> None: ... + else: + def __init__( + self, address: tuple[str, int] | str = ("localhost", 514), facility: str | int = 1, socktype: SocketKind | None = None + ) -> None: ... if sys.version_info >= (3, 11): def createSocket(self) -> None: ... @@ -191,7 +166,7 @@ class SysLogHandler(Handler): class NTEventLogHandler(Handler): def __init__(self, appname: str, dllname: str | None = None, logtype: str = "Application") -> None: ... def getEventCategory(self, record: LogRecord) -> int: ... - # TODO correct return value? + # TODO: correct return value? def getEventType(self, record: LogRecord) -> int: ... def getMessageID(self, record: LogRecord) -> int: ... @@ -248,8 +223,7 @@ class HTTPHandler(Handler): context: ssl.SSLContext | None = None, ) -> None: ... def mapLogRecord(self, record: LogRecord) -> dict[str, Any]: ... - if sys.version_info >= (3, 9): - def getConnection(self, host: str, secure: bool) -> http.client.HTTPConnection: ... # undocumented + def getConnection(self, host: str, secure: bool) -> http.client.HTTPConnection: ... # undocumented class _QueueLike(Protocol[_T]): def get(self) -> _T: ... @@ -260,6 +234,8 @@ class QueueHandler(Handler): def __init__(self, queue: _QueueLike[Any]) -> None: ... def prepare(self, record: LogRecord) -> Any: ... def enqueue(self, record: LogRecord) -> None: ... + if sys.version_info >= (3, 12): + listener: QueueListener | None class QueueListener: handlers: tuple[Handler, ...] # undocumented @@ -273,3 +249,9 @@ class QueueListener: def stop(self) -> None: ... def enqueue_sentinel(self) -> None: ... def handle(self, record: LogRecord) -> None: ... + + if sys.version_info >= (3, 14): + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None + ) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/lzma.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/lzma.pyi new file mode 100644 index 0000000000000..b066d222466ba --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/lzma.pyi @@ -0,0 +1,179 @@ +import sys +from _lzma import ( + CHECK_CRC32 as CHECK_CRC32, + CHECK_CRC64 as CHECK_CRC64, + CHECK_ID_MAX as CHECK_ID_MAX, + CHECK_NONE as CHECK_NONE, + CHECK_SHA256 as CHECK_SHA256, + CHECK_UNKNOWN as CHECK_UNKNOWN, + FILTER_ARM as FILTER_ARM, + FILTER_ARMTHUMB as FILTER_ARMTHUMB, + FILTER_DELTA as FILTER_DELTA, + FILTER_IA64 as FILTER_IA64, + FILTER_LZMA1 as FILTER_LZMA1, + FILTER_LZMA2 as FILTER_LZMA2, + FILTER_POWERPC as FILTER_POWERPC, + FILTER_SPARC as FILTER_SPARC, + FILTER_X86 as FILTER_X86, + FORMAT_ALONE as FORMAT_ALONE, + FORMAT_AUTO as FORMAT_AUTO, + FORMAT_RAW as FORMAT_RAW, + FORMAT_XZ as FORMAT_XZ, + MF_BT2 as MF_BT2, + MF_BT3 as MF_BT3, + MF_BT4 as MF_BT4, + MF_HC3 as MF_HC3, + MF_HC4 as MF_HC4, + MODE_FAST as MODE_FAST, + MODE_NORMAL as MODE_NORMAL, + PRESET_DEFAULT as PRESET_DEFAULT, + PRESET_EXTREME as PRESET_EXTREME, + LZMACompressor as LZMACompressor, + LZMADecompressor as LZMADecompressor, + LZMAError as LZMAError, + _FilterChain, + is_check_supported as is_check_supported, +) +from _typeshed import ReadableBuffer, StrOrBytesPath +from typing import IO, Literal, TextIO, overload +from typing_extensions import Self, TypeAlias + +if sys.version_info >= (3, 14): + from compression._common._streams import BaseStream +else: + from _compression import BaseStream + +__all__ = [ + "CHECK_NONE", + "CHECK_CRC32", + "CHECK_CRC64", + "CHECK_SHA256", + "CHECK_ID_MAX", + "CHECK_UNKNOWN", + "FILTER_LZMA1", + "FILTER_LZMA2", + "FILTER_DELTA", + "FILTER_X86", + "FILTER_IA64", + "FILTER_ARM", + "FILTER_ARMTHUMB", + "FILTER_POWERPC", + "FILTER_SPARC", + "FORMAT_AUTO", + "FORMAT_XZ", + "FORMAT_ALONE", + "FORMAT_RAW", + "MF_HC3", + "MF_HC4", + "MF_BT2", + "MF_BT3", + "MF_BT4", + "MODE_FAST", + "MODE_NORMAL", + "PRESET_DEFAULT", + "PRESET_EXTREME", + "LZMACompressor", + "LZMADecompressor", + "LZMAFile", + "LZMAError", + "open", + "compress", + "decompress", + "is_check_supported", +] + +_OpenBinaryWritingMode: TypeAlias = Literal["w", "wb", "x", "xb", "a", "ab"] +_OpenTextWritingMode: TypeAlias = Literal["wt", "xt", "at"] + +_PathOrFile: TypeAlias = StrOrBytesPath | IO[bytes] + +class LZMAFile(BaseStream, IO[bytes]): # type: ignore[misc] # incompatible definitions of writelines in the base classes + def __init__( + self, + filename: _PathOrFile | None = None, + mode: str = "r", + *, + format: int | None = None, + check: int = -1, + preset: int | None = None, + filters: _FilterChain | None = None, + ) -> None: ... + def __enter__(self) -> Self: ... + def peek(self, size: int = -1) -> bytes: ... + def read(self, size: int | None = -1) -> bytes: ... + def read1(self, size: int = -1) -> bytes: ... + def readline(self, size: int | None = -1) -> bytes: ... + def write(self, data: ReadableBuffer) -> int: ... + def seek(self, offset: int, whence: int = 0) -> int: ... + +@overload +def open( + filename: _PathOrFile, + mode: Literal["r", "rb"] = "rb", + *, + format: int | None = None, + check: Literal[-1] = -1, + preset: None = None, + filters: _FilterChain | None = None, + encoding: None = None, + errors: None = None, + newline: None = None, +) -> LZMAFile: ... +@overload +def open( + filename: _PathOrFile, + mode: _OpenBinaryWritingMode, + *, + format: int | None = None, + check: int = -1, + preset: int | None = None, + filters: _FilterChain | None = None, + encoding: None = None, + errors: None = None, + newline: None = None, +) -> LZMAFile: ... +@overload +def open( + filename: StrOrBytesPath, + mode: Literal["rt"], + *, + format: int | None = None, + check: Literal[-1] = -1, + preset: None = None, + filters: _FilterChain | None = None, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> TextIO: ... +@overload +def open( + filename: StrOrBytesPath, + mode: _OpenTextWritingMode, + *, + format: int | None = None, + check: int = -1, + preset: int | None = None, + filters: _FilterChain | None = None, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> TextIO: ... +@overload +def open( + filename: _PathOrFile, + mode: str, + *, + format: int | None = None, + check: int = -1, + preset: int | None = None, + filters: _FilterChain | None = None, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, +) -> LZMAFile | TextIO: ... +def compress( + data: ReadableBuffer, format: int = 1, check: int = -1, preset: int | None = None, filters: _FilterChain | None = None +) -> bytes: ... +def decompress( + data: ReadableBuffer, format: int = 0, memlimit: int | None = None, filters: _FilterChain | None = None +) -> bytes: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/mailbox.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/mailbox.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/mailbox.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/mailbox.pyi index a98a00a42853e..ff605c0661fb1 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/mailbox.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/mailbox.pyi @@ -4,13 +4,11 @@ import sys from _typeshed import StrPath, SupportsNoArgReadline, SupportsRead from abc import ABCMeta, abstractmethod from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence -from types import TracebackType +from email._policybase import _MessageT +from types import GenericAlias, TracebackType from typing import IO, Any, AnyStr, Generic, Literal, Protocol, TypeVar, overload from typing_extensions import Self, TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "Mailbox", "Maildir", @@ -32,7 +30,6 @@ __all__ = [ ] _T = TypeVar("_T") -_MessageT = TypeVar("_MessageT", bound=Message) class _SupportsReadAndReadline(SupportsRead[bytes], SupportsNoArgReadline[bytes], Protocol): ... @@ -101,8 +98,7 @@ class Mailbox(Generic[_MessageT]): def unlock(self) -> None: ... @abstractmethod def close(self) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class Maildir(Mailbox[MaildirMessage]): colon: str @@ -251,8 +247,7 @@ class _ProxyFile(Generic[AnyStr]): def flush(self) -> None: ... @property def closed(self) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class _PartialFile(_ProxyFile[AnyStr]): def __init__(self, f: IO[AnyStr], start: int | None = None, stop: int | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/mailcap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/mailcap.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/mailcap.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/mailcap.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/marshal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/marshal.pyi similarity index 78% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/marshal.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/marshal.pyi index 6ab202637ddaa..46c421e4ce307 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/marshal.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/marshal.pyi @@ -2,10 +2,10 @@ import builtins import sys import types from _typeshed import ReadableBuffer, SupportsRead, SupportsWrite -from typing import Any +from typing import Any, Final from typing_extensions import TypeAlias -version: int +version: Final[int] _Marshallable: TypeAlias = ( # handled in w_object() in marshal.c @@ -28,14 +28,22 @@ _Marshallable: TypeAlias = ( | ReadableBuffer ) -if sys.version_info >= (3, 13): +if sys.version_info >= (3, 14): + def dump(value: _Marshallable, file: SupportsWrite[bytes], version: int = 5, /, *, allow_code: bool = True) -> None: ... + def dumps(value: _Marshallable, version: int = 5, /, *, allow_code: bool = True) -> bytes: ... + +elif sys.version_info >= (3, 13): def dump(value: _Marshallable, file: SupportsWrite[bytes], version: int = 4, /, *, allow_code: bool = True) -> None: ... - def load(file: SupportsRead[bytes], /, *, allow_code: bool = True) -> Any: ... def dumps(value: _Marshallable, version: int = 4, /, *, allow_code: bool = True) -> bytes: ... - def loads(bytes: ReadableBuffer, /, *, allow_code: bool = True) -> Any: ... else: def dump(value: _Marshallable, file: SupportsWrite[bytes], version: int = 4, /) -> None: ... - def load(file: SupportsRead[bytes], /) -> Any: ... def dumps(value: _Marshallable, version: int = 4, /) -> bytes: ... + +if sys.version_info >= (3, 13): + def load(file: SupportsRead[bytes], /, *, allow_code: bool = True) -> Any: ... + def loads(bytes: ReadableBuffer, /, *, allow_code: bool = True) -> Any: ... + +else: + def load(file: SupportsRead[bytes], /) -> Any: ... def loads(bytes: ReadableBuffer, /) -> Any: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/math.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/math.pyi new file mode 100644 index 0000000000000..9e77f0cd7e068 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/math.pyi @@ -0,0 +1,137 @@ +import sys +from _typeshed import SupportsMul, SupportsRMul +from collections.abc import Iterable +from typing import Any, Final, Literal, Protocol, SupportsFloat, SupportsIndex, TypeVar, overload +from typing_extensions import TypeAlias + +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) + +_SupportsFloatOrIndex: TypeAlias = SupportsFloat | SupportsIndex + +e: Final[float] +pi: Final[float] +inf: Final[float] +nan: Final[float] +tau: Final[float] + +def acos(x: _SupportsFloatOrIndex, /) -> float: ... +def acosh(x: _SupportsFloatOrIndex, /) -> float: ... +def asin(x: _SupportsFloatOrIndex, /) -> float: ... +def asinh(x: _SupportsFloatOrIndex, /) -> float: ... +def atan(x: _SupportsFloatOrIndex, /) -> float: ... +def atan2(y: _SupportsFloatOrIndex, x: _SupportsFloatOrIndex, /) -> float: ... +def atanh(x: _SupportsFloatOrIndex, /) -> float: ... + +if sys.version_info >= (3, 11): + def cbrt(x: _SupportsFloatOrIndex, /) -> float: ... + +class _SupportsCeil(Protocol[_T_co]): + def __ceil__(self) -> _T_co: ... + +@overload +def ceil(x: _SupportsCeil[_T], /) -> _T: ... +@overload +def ceil(x: _SupportsFloatOrIndex, /) -> int: ... +def comb(n: SupportsIndex, k: SupportsIndex, /) -> int: ... +def copysign(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... +def cos(x: _SupportsFloatOrIndex, /) -> float: ... +def cosh(x: _SupportsFloatOrIndex, /) -> float: ... +def degrees(x: _SupportsFloatOrIndex, /) -> float: ... +def dist(p: Iterable[_SupportsFloatOrIndex], q: Iterable[_SupportsFloatOrIndex], /) -> float: ... +def erf(x: _SupportsFloatOrIndex, /) -> float: ... +def erfc(x: _SupportsFloatOrIndex, /) -> float: ... +def exp(x: _SupportsFloatOrIndex, /) -> float: ... + +if sys.version_info >= (3, 11): + def exp2(x: _SupportsFloatOrIndex, /) -> float: ... + +def expm1(x: _SupportsFloatOrIndex, /) -> float: ... +def fabs(x: _SupportsFloatOrIndex, /) -> float: ... +def factorial(x: SupportsIndex, /) -> int: ... + +class _SupportsFloor(Protocol[_T_co]): + def __floor__(self) -> _T_co: ... + +@overload +def floor(x: _SupportsFloor[_T], /) -> _T: ... +@overload +def floor(x: _SupportsFloatOrIndex, /) -> int: ... +def fmod(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... +def frexp(x: _SupportsFloatOrIndex, /) -> tuple[float, int]: ... +def fsum(seq: Iterable[_SupportsFloatOrIndex], /) -> float: ... +def gamma(x: _SupportsFloatOrIndex, /) -> float: ... +def gcd(*integers: SupportsIndex) -> int: ... +def hypot(*coordinates: _SupportsFloatOrIndex) -> float: ... +def isclose( + a: _SupportsFloatOrIndex, + b: _SupportsFloatOrIndex, + *, + rel_tol: _SupportsFloatOrIndex = 1e-09, + abs_tol: _SupportsFloatOrIndex = 0.0, +) -> bool: ... +def isinf(x: _SupportsFloatOrIndex, /) -> bool: ... +def isfinite(x: _SupportsFloatOrIndex, /) -> bool: ... +def isnan(x: _SupportsFloatOrIndex, /) -> bool: ... +def isqrt(n: SupportsIndex, /) -> int: ... +def lcm(*integers: SupportsIndex) -> int: ... +def ldexp(x: _SupportsFloatOrIndex, i: int, /) -> float: ... +def lgamma(x: _SupportsFloatOrIndex, /) -> float: ... +def log(x: _SupportsFloatOrIndex, base: _SupportsFloatOrIndex = ...) -> float: ... +def log10(x: _SupportsFloatOrIndex, /) -> float: ... +def log1p(x: _SupportsFloatOrIndex, /) -> float: ... +def log2(x: _SupportsFloatOrIndex, /) -> float: ... +def modf(x: _SupportsFloatOrIndex, /) -> tuple[float, float]: ... + +if sys.version_info >= (3, 12): + def nextafter(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /, *, steps: SupportsIndex | None = None) -> float: ... + +else: + def nextafter(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... + +def perm(n: SupportsIndex, k: SupportsIndex | None = None, /) -> int: ... +def pow(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... + +_PositiveInteger: TypeAlias = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25] +_NegativeInteger: TypeAlias = Literal[-1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -11, -12, -13, -14, -15, -16, -17, -18, -19, -20] +_LiteralInteger = _PositiveInteger | _NegativeInteger | Literal[0] # noqa: Y026 # TODO: Use TypeAlias once mypy bugs are fixed + +_MultiplicableT1 = TypeVar("_MultiplicableT1", bound=SupportsMul[Any, Any]) +_MultiplicableT2 = TypeVar("_MultiplicableT2", bound=SupportsMul[Any, Any]) + +class _SupportsProdWithNoDefaultGiven(SupportsMul[Any, Any], SupportsRMul[int, Any], Protocol): ... + +_SupportsProdNoDefaultT = TypeVar("_SupportsProdNoDefaultT", bound=_SupportsProdWithNoDefaultGiven) + +# This stub is based on the type stub for `builtins.sum`. +# Like `builtins.sum`, it cannot be precisely represented in a type stub +# without introducing many false positives. +# For more details on its limitations and false positives, see #13572. +# Instead, just like `builtins.sum`, we explicitly handle several useful cases. +@overload +def prod(iterable: Iterable[bool | _LiteralInteger], /, *, start: int = 1) -> int: ... # type: ignore[overload-overlap] +@overload +def prod(iterable: Iterable[_SupportsProdNoDefaultT], /) -> _SupportsProdNoDefaultT | Literal[1]: ... +@overload +def prod(iterable: Iterable[_MultiplicableT1], /, *, start: _MultiplicableT2) -> _MultiplicableT1 | _MultiplicableT2: ... +def radians(x: _SupportsFloatOrIndex, /) -> float: ... +def remainder(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, /) -> float: ... +def sin(x: _SupportsFloatOrIndex, /) -> float: ... +def sinh(x: _SupportsFloatOrIndex, /) -> float: ... + +if sys.version_info >= (3, 12): + def sumprod(p: Iterable[float], q: Iterable[float], /) -> float: ... + +def sqrt(x: _SupportsFloatOrIndex, /) -> float: ... +def tan(x: _SupportsFloatOrIndex, /) -> float: ... +def tanh(x: _SupportsFloatOrIndex, /) -> float: ... + +# Is different from `_typeshed.SupportsTrunc`, which is not generic +class _SupportsTrunc(Protocol[_T_co]): + def __trunc__(self) -> _T_co: ... + +def trunc(x: _SupportsTrunc[_T], /) -> _T: ... +def ulp(x: _SupportsFloatOrIndex, /) -> float: ... + +if sys.version_info >= (3, 13): + def fma(x: _SupportsFloatOrIndex, y: _SupportsFloatOrIndex, z: _SupportsFloatOrIndex, /) -> float: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/mimetypes.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/mimetypes.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/mimetypes.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/mimetypes.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/mmap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/mmap.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/mmap.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/mmap.pyi index 5be7f7b76ba1c..c9b8358cde6cb 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/mmap.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/mmap.pyi @@ -34,9 +34,22 @@ class mmap: if sys.platform == "win32": def __init__(self, fileno: int, length: int, tagname: str | None = ..., access: int = ..., offset: int = ...) -> None: ... else: - def __init__( - self, fileno: int, length: int, flags: int = ..., prot: int = ..., access: int = ..., offset: int = ... - ) -> None: ... + if sys.version_info >= (3, 13): + def __new__( + cls, + fileno: int, + length: int, + flags: int = ..., + prot: int = ..., + access: int = ..., + offset: int = ..., + *, + trackfd: bool = True, + ) -> Self: ... + else: + def __new__( + cls, fileno: int, length: int, flags: int = ..., prot: int = ..., access: int = ..., offset: int = ... + ) -> Self: ... def close(self) -> None: ... def flush(self, offset: int = ..., size: int = ...) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/modulefinder.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/modulefinder.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/modulefinder.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/modulefinder.pyi index 2cf948ba898a8..6db665a18e691 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/modulefinder.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/modulefinder.pyi @@ -64,3 +64,5 @@ class ModuleFinder: def any_missing(self) -> list[str]: ... # undocumented def any_missing_maybe(self) -> tuple[list[str], list[str]]: ... # undocumented def replace_paths_in_code(self, co: CodeType) -> CodeType: ... # undocumented + +def test() -> ModuleFinder | None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/msilib/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/msilib/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/schema.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/msilib/schema.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/schema.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/msilib/schema.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/sequence.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/msilib/sequence.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/sequence.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/msilib/sequence.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/text.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/msilib/text.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/msilib/text.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/msilib/text.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/msvcrt.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/msvcrt.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/msvcrt.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/msvcrt.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi index 9998239d3119d..cd4fa102c0f3e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/connection.pyi @@ -12,10 +12,10 @@ __all__ = ["Client", "Listener", "Pipe", "wait"] _Address: TypeAlias = str | tuple[str, int] # Defaulting to Any to avoid forcing generics on a lot of pre-existing code -_SendT = TypeVar("_SendT", contravariant=True, default=Any) -_RecvT = TypeVar("_RecvT", covariant=True, default=Any) +_SendT_contra = TypeVar("_SendT_contra", contravariant=True, default=Any) +_RecvT_co = TypeVar("_RecvT_co", covariant=True, default=Any) -class _ConnectionBase(Generic[_SendT, _RecvT]): +class _ConnectionBase(Generic[_SendT_contra, _RecvT_co]): def __init__(self, handle: SupportsIndex, readable: bool = True, writable: bool = True) -> None: ... @property def closed(self) -> bool: ... # undocumented @@ -26,10 +26,10 @@ class _ConnectionBase(Generic[_SendT, _RecvT]): def fileno(self) -> int: ... def close(self) -> None: ... def send_bytes(self, buf: ReadableBuffer, offset: int = 0, size: int | None = None) -> None: ... - def send(self, obj: _SendT) -> None: ... + def send(self, obj: _SendT_contra) -> None: ... def recv_bytes(self, maxlength: int | None = None) -> bytes: ... def recv_bytes_into(self, buf: Any, offset: int = 0) -> int: ... - def recv(self) -> _RecvT: ... + def recv(self) -> _RecvT_co: ... def poll(self, timeout: float | None = 0.0) -> bool: ... def __enter__(self) -> Self: ... def __exit__( @@ -37,10 +37,10 @@ class _ConnectionBase(Generic[_SendT, _RecvT]): ) -> None: ... def __del__(self) -> None: ... -class Connection(_ConnectionBase[_SendT, _RecvT]): ... +class Connection(_ConnectionBase[_SendT_contra, _RecvT_co]): ... if sys.platform == "win32": - class PipeConnection(_ConnectionBase[_SendT, _RecvT]): ... + class PipeConnection(_ConnectionBase[_SendT_contra, _RecvT_co]): ... class Listener: def __init__( @@ -66,8 +66,8 @@ else: def answer_challenge(connection: Connection[Any, Any], authkey: bytes) -> None: ... def wait( - object_list: Iterable[Connection[_SendT, _RecvT] | socket.socket | int], timeout: float | None = None -) -> list[Connection[_SendT, _RecvT] | socket.socket | int]: ... + object_list: Iterable[Connection[_SendT_contra, _RecvT_co] | socket.socket | int], timeout: float | None = None +) -> list[Connection[_SendT_contra, _RecvT_co] | socket.socket | int]: ... def Client(address: _Address, family: str | None = None, authkey: bytes | None = None) -> Connection[Any, Any]: ... # N.B. Keep this in sync with multiprocessing.context.BaseContext.Pipe. diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi similarity index 99% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi index 9900f009a398c..03d1d2e5c2203 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/context.pyi @@ -1,7 +1,8 @@ import ctypes import sys +from _ctypes import _CData from collections.abc import Callable, Iterable, Sequence -from ctypes import _CData, _SimpleCData, c_char +from ctypes import _SimpleCData, c_char from logging import Logger, _Level as _LoggingLevel from multiprocessing import popen_fork, popen_forkserver, popen_spawn_posix, popen_spawn_win32, queues, synchronize from multiprocessing.managers import SyncManager diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/connection.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/connection.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/connection.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/dummy/connection.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/forkserver.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/forkserver.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/forkserver.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/forkserver.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/heap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/heap.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/heap.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/heap.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi new file mode 100644 index 0000000000000..50e4f1c1fe662 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/managers.pyi @@ -0,0 +1,288 @@ +import queue +import sys +import threading +from _typeshed import SupportsKeysAndGetItem, SupportsRichComparison, SupportsRichComparisonT +from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping, MutableSequence, Sequence +from types import GenericAlias, TracebackType +from typing import Any, AnyStr, ClassVar, Generic, SupportsIndex, TypeVar, overload +from typing_extensions import Self, TypeAlias + +from . import pool +from .connection import Connection, _Address +from .context import BaseContext +from .shared_memory import _SLT, ShareableList as _ShareableList, SharedMemory as _SharedMemory +from .util import Finalize as _Finalize + +__all__ = ["BaseManager", "SyncManager", "BaseProxy", "Token", "SharedMemoryManager"] + +_T = TypeVar("_T") +_KT = TypeVar("_KT") +_VT = TypeVar("_VT") + +class Namespace: + def __init__(self, **kwds: Any) -> None: ... + def __getattr__(self, name: str, /) -> Any: ... + def __setattr__(self, name: str, value: Any, /) -> None: ... + +_Namespace: TypeAlias = Namespace + +class Token: + typeid: str | bytes | None + address: _Address | None + id: str | bytes | int | None + def __init__(self, typeid: bytes | str | None, address: _Address | None, id: str | bytes | int | None) -> None: ... + def __getstate__(self) -> tuple[str | bytes | None, tuple[str | bytes, int], str | bytes | int | None]: ... + def __setstate__(self, state: tuple[str | bytes | None, tuple[str | bytes, int], str | bytes | int | None]) -> None: ... + +class BaseProxy: + _address_to_local: dict[_Address, Any] + _mutex: Any + def __init__( + self, + token: Any, + serializer: str, + manager: Any = None, + authkey: AnyStr | None = None, + exposed: Any = None, + incref: bool = True, + manager_owned: bool = False, + ) -> None: ... + def __deepcopy__(self, memo: Any | None) -> Any: ... + def _callmethod(self, methodname: str, args: tuple[Any, ...] = (), kwds: dict[Any, Any] = {}) -> None: ... + def _getvalue(self) -> Any: ... + def __reduce__(self) -> tuple[Any, tuple[Any, Any, str, dict[Any, Any]]]: ... + +class ValueProxy(BaseProxy, Generic[_T]): + def get(self) -> _T: ... + def set(self, value: _T) -> None: ... + value: _T + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +if sys.version_info >= (3, 13): + class _BaseDictProxy(BaseProxy, MutableMapping[_KT, _VT]): + __builtins__: ClassVar[dict[str, Any]] + def __len__(self) -> int: ... + def __getitem__(self, key: _KT, /) -> _VT: ... + def __setitem__(self, key: _KT, value: _VT, /) -> None: ... + def __delitem__(self, key: _KT, /) -> None: ... + def __iter__(self) -> Iterator[_KT]: ... + def copy(self) -> dict[_KT, _VT]: ... + @overload # type: ignore[override] + def get(self, key: _KT, /) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _VT, /) -> _VT: ... + @overload + def get(self, key: _KT, default: _T, /) -> _VT | _T: ... + @overload + def pop(self, key: _KT, /) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT, /) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T, /) -> _VT | _T: ... + def keys(self) -> list[_KT]: ... # type: ignore[override] + def items(self) -> list[tuple[_KT, _VT]]: ... # type: ignore[override] + def values(self) -> list[_VT]: ... # type: ignore[override] + + class DictProxy(_BaseDictProxy[_KT, _VT]): + def __class_getitem__(cls, args: Any, /) -> GenericAlias: ... + +else: + class DictProxy(BaseProxy, MutableMapping[_KT, _VT]): + __builtins__: ClassVar[dict[str, Any]] + def __len__(self) -> int: ... + def __getitem__(self, key: _KT, /) -> _VT: ... + def __setitem__(self, key: _KT, value: _VT, /) -> None: ... + def __delitem__(self, key: _KT, /) -> None: ... + def __iter__(self) -> Iterator[_KT]: ... + def copy(self) -> dict[_KT, _VT]: ... + @overload # type: ignore[override] + def get(self, key: _KT, /) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _VT, /) -> _VT: ... + @overload + def get(self, key: _KT, default: _T, /) -> _VT | _T: ... + @overload + def pop(self, key: _KT, /) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT, /) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T, /) -> _VT | _T: ... + def keys(self) -> list[_KT]: ... # type: ignore[override] + def items(self) -> list[tuple[_KT, _VT]]: ... # type: ignore[override] + def values(self) -> list[_VT]: ... # type: ignore[override] + +class BaseListProxy(BaseProxy, MutableSequence[_T]): + __builtins__: ClassVar[dict[str, Any]] + def __len__(self) -> int: ... + def __add__(self, x: list[_T], /) -> list[_T]: ... + def __delitem__(self, i: SupportsIndex | slice, /) -> None: ... + @overload + def __getitem__(self, i: SupportsIndex, /) -> _T: ... + @overload + def __getitem__(self, s: slice, /) -> list[_T]: ... + @overload + def __setitem__(self, i: SupportsIndex, o: _T, /) -> None: ... + @overload + def __setitem__(self, s: slice, o: Iterable[_T], /) -> None: ... + def __mul__(self, n: SupportsIndex, /) -> list[_T]: ... + def __rmul__(self, n: SupportsIndex, /) -> list[_T]: ... + def __imul__(self, value: SupportsIndex, /) -> Self: ... + def __reversed__(self) -> Iterator[_T]: ... + def append(self, object: _T, /) -> None: ... + def extend(self, iterable: Iterable[_T], /) -> None: ... + def pop(self, index: SupportsIndex = ..., /) -> _T: ... + def index(self, value: _T, start: SupportsIndex = ..., stop: SupportsIndex = ..., /) -> int: ... + def count(self, value: _T, /) -> int: ... + def insert(self, index: SupportsIndex, object: _T, /) -> None: ... + def remove(self, value: _T, /) -> None: ... + # Use BaseListProxy[SupportsRichComparisonT] for the first overload rather than [SupportsRichComparison] + # to work around invariance + @overload + def sort(self: BaseListProxy[SupportsRichComparisonT], *, key: None = None, reverse: bool = ...) -> None: ... + @overload + def sort(self, *, key: Callable[[_T], SupportsRichComparison], reverse: bool = ...) -> None: ... + +class ListProxy(BaseListProxy[_T]): + def __iadd__(self, value: Iterable[_T], /) -> Self: ... # type: ignore[override] + def __imul__(self, value: SupportsIndex, /) -> Self: ... # type: ignore[override] + if sys.version_info >= (3, 13): + def __class_getitem__(cls, args: Any, /) -> Any: ... + +# Send is (kind, result) +# Receive is (id, methodname, args, kwds) +_ServerConnection: TypeAlias = Connection[tuple[str, Any], tuple[str, str, Iterable[Any], Mapping[str, Any]]] + +# Returned by BaseManager.get_server() +class Server: + address: _Address | None + id_to_obj: dict[str, tuple[Any, set[str], dict[str, str]]] + fallback_mapping: dict[str, Callable[[_ServerConnection, str, Any], Any]] + public: list[str] + # Registry values are (callable, exposed, method_to_typeid, proxytype) + def __init__( + self, + registry: dict[str, tuple[Callable[..., Any], Iterable[str], dict[str, str], Any]], + address: _Address | None, + authkey: bytes, + serializer: str, + ) -> None: ... + def serve_forever(self) -> None: ... + def accepter(self) -> None: ... + if sys.version_info >= (3, 10): + def handle_request(self, conn: _ServerConnection) -> None: ... + else: + def handle_request(self, c: _ServerConnection) -> None: ... + + def serve_client(self, conn: _ServerConnection) -> None: ... + def fallback_getvalue(self, conn: _ServerConnection, ident: str, obj: _T) -> _T: ... + def fallback_str(self, conn: _ServerConnection, ident: str, obj: Any) -> str: ... + def fallback_repr(self, conn: _ServerConnection, ident: str, obj: Any) -> str: ... + def dummy(self, c: _ServerConnection) -> None: ... + def debug_info(self, c: _ServerConnection) -> str: ... + def number_of_objects(self, c: _ServerConnection) -> int: ... + def shutdown(self, c: _ServerConnection) -> None: ... + def create(self, c: _ServerConnection, typeid: str, /, *args: Any, **kwds: Any) -> tuple[str, tuple[str, ...]]: ... + def get_methods(self, c: _ServerConnection, token: Token) -> set[str]: ... + def accept_connection(self, c: _ServerConnection, name: str) -> None: ... + def incref(self, c: _ServerConnection, ident: str) -> None: ... + def decref(self, c: _ServerConnection, ident: str) -> None: ... + +class BaseManager: + if sys.version_info >= (3, 11): + def __init__( + self, + address: _Address | None = None, + authkey: bytes | None = None, + serializer: str = "pickle", + ctx: BaseContext | None = None, + *, + shutdown_timeout: float = 1.0, + ) -> None: ... + else: + def __init__( + self, + address: _Address | None = None, + authkey: bytes | None = None, + serializer: str = "pickle", + ctx: BaseContext | None = None, + ) -> None: ... + + def get_server(self) -> Server: ... + def connect(self) -> None: ... + def start(self, initializer: Callable[..., object] | None = None, initargs: Iterable[Any] = ()) -> None: ... + shutdown: _Finalize # only available after start() was called + def join(self, timeout: float | None = None) -> None: ... # undocumented + @property + def address(self) -> _Address | None: ... + @classmethod + def register( + cls, + typeid: str, + callable: Callable[..., object] | None = None, + proxytype: Any = None, + exposed: Sequence[str] | None = None, + method_to_typeid: Mapping[str, str] | None = None, + create_method: bool = True, + ) -> None: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + +class SyncManager(BaseManager): + def Barrier( + self, parties: int, action: Callable[[], None] | None = None, timeout: float | None = None + ) -> threading.Barrier: ... + def BoundedSemaphore(self, value: int = 1) -> threading.BoundedSemaphore: ... + def Condition(self, lock: threading.Lock | threading._RLock | None = None) -> threading.Condition: ... + def Event(self) -> threading.Event: ... + def Lock(self) -> threading.Lock: ... + def Namespace(self) -> _Namespace: ... + def Pool( + self, + processes: int | None = None, + initializer: Callable[..., object] | None = None, + initargs: Iterable[Any] = (), + maxtasksperchild: int | None = None, + context: Any | None = None, + ) -> pool.Pool: ... + def Queue(self, maxsize: int = ...) -> queue.Queue[Any]: ... + def JoinableQueue(self, maxsize: int = ...) -> queue.Queue[Any]: ... + def RLock(self) -> threading.RLock: ... + def Semaphore(self, value: int = 1) -> threading.Semaphore: ... + def Array(self, typecode: Any, sequence: Sequence[_T]) -> Sequence[_T]: ... + def Value(self, typecode: Any, value: _T) -> ValueProxy[_T]: ... + # Overloads are copied from builtins.dict.__init__ + @overload + def dict(self) -> DictProxy[Any, Any]: ... + @overload + def dict(self, **kwargs: _VT) -> DictProxy[str, _VT]: ... + @overload + def dict(self, map: SupportsKeysAndGetItem[_KT, _VT], /) -> DictProxy[_KT, _VT]: ... + @overload + def dict(self, map: SupportsKeysAndGetItem[str, _VT], /, **kwargs: _VT) -> DictProxy[str, _VT]: ... + @overload + def dict(self, iterable: Iterable[tuple[_KT, _VT]], /) -> DictProxy[_KT, _VT]: ... + @overload + def dict(self, iterable: Iterable[tuple[str, _VT]], /, **kwargs: _VT) -> DictProxy[str, _VT]: ... + @overload + def dict(self, iterable: Iterable[list[str]], /) -> DictProxy[str, str]: ... + @overload + def dict(self, iterable: Iterable[list[bytes]], /) -> DictProxy[bytes, bytes]: ... + @overload + def list(self, sequence: Sequence[_T], /) -> ListProxy[_T]: ... + @overload + def list(self) -> ListProxy[Any]: ... + +class RemoteError(Exception): ... + +class SharedMemoryServer(Server): + def track_segment(self, c: _ServerConnection, segment_name: str) -> None: ... + def release_segment(self, c: _ServerConnection, segment_name: str) -> None: ... + def list_segments(self, c: _ServerConnection) -> list[str]: ... + +class SharedMemoryManager(BaseManager): + def get_server(self) -> SharedMemoryServer: ... + def SharedMemory(self, size: int) -> _SharedMemory: ... + def ShareableList(self, sequence: Iterable[_SLT] | None) -> _ShareableList[_SLT]: ... + def __del__(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi index 950ed1d8c56b6..b79f9e77359ae 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/pool.pyi @@ -1,12 +1,9 @@ -import sys -from collections.abc import Callable, Iterable, Iterator, Mapping -from types import TracebackType +from collections.abc import Callable, Iterable, Mapping +from multiprocessing.context import DefaultContext, Process +from types import GenericAlias, TracebackType from typing import Any, Final, Generic, TypeVar from typing_extensions import Self -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = ["Pool", "ThreadPool"] _S = TypeVar("_S") @@ -20,8 +17,7 @@ class ApplyResult(Generic[_T]): def wait(self, timeout: float | None = None) -> None: ... def ready(self) -> bool: ... def successful(self) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... # alias created during issue #17805 AsyncResult = ApplyResult @@ -36,7 +32,7 @@ class MapResult(ApplyResult[list[_T]]): error_callback: Callable[[BaseException], object] | None, ) -> None: ... -class IMapIterator(Iterator[_T]): +class IMapIterator(Generic[_T]): def __init__(self, pool: Pool) -> None: ... def __iter__(self) -> Self: ... def next(self, timeout: float | None = None) -> _T: ... @@ -53,6 +49,8 @@ class Pool: maxtasksperchild: int | None = None, context: Any | None = None, ) -> None: ... + @staticmethod + def Process(ctx: DefaultContext, *args: Any, **kwds: Any) -> Process: ... def apply(self, func: Callable[..., _T], args: Iterable[Any] = (), kwds: Mapping[str, Any] = {}) -> _T: ... def apply_async( self, diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_fork.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_fork.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_fork.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_fork.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_forkserver.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_forkserver.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_forkserver.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_forkserver.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_posix.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_posix.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_posix.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_posix.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_win32.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_win32.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_win32.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/popen_spawn_win32.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/process.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/process.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/process.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/process.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi new file mode 100644 index 0000000000000..a6b00d744c421 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/queues.pyi @@ -0,0 +1,36 @@ +import sys +from types import GenericAlias +from typing import Any, Generic, TypeVar + +__all__ = ["Queue", "SimpleQueue", "JoinableQueue"] + +_T = TypeVar("_T") + +class Queue(Generic[_T]): + # FIXME: `ctx` is a circular dependency and it's not actually optional. + # It's marked as such to be able to use the generic Queue in __init__.pyi. + def __init__(self, maxsize: int = 0, *, ctx: Any = ...) -> None: ... + def put(self, obj: _T, block: bool = True, timeout: float | None = None) -> None: ... + def get(self, block: bool = True, timeout: float | None = None) -> _T: ... + def qsize(self) -> int: ... + def empty(self) -> bool: ... + def full(self) -> bool: ... + def get_nowait(self) -> _T: ... + def put_nowait(self, obj: _T) -> None: ... + def close(self) -> None: ... + def join_thread(self) -> None: ... + def cancel_join_thread(self) -> None: ... + if sys.version_info >= (3, 12): + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +class JoinableQueue(Queue[_T]): + def task_done(self) -> None: ... + def join(self) -> None: ... + +class SimpleQueue(Generic[_T]): + def __init__(self, *, ctx: Any = ...) -> None: ... + def close(self) -> None: ... + def empty(self) -> bool: ... + def get(self) -> _T: ... + def put(self, obj: _T) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi index 473e90936d71a..942e92ce530ec 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/reduction.pyi @@ -1,12 +1,12 @@ import pickle import sys +from _pickle import _ReducedType from _typeshed import HasFileno, SupportsWrite, Unused from abc import ABCMeta from builtins import type as Type # alias to avoid name clash from collections.abc import Callable from copyreg import _DispatchTableType from multiprocessing import connection -from pickle import _ReducedType from socket import socket from typing import Any, Final diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/resource_sharer.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/resource_sharer.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/resource_sharer.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/resource_sharer.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi index 61da7fdf1cebe..cb2f27a628614 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/resource_tracker.pyi @@ -1,3 +1,4 @@ +import sys from _typeshed import FileDescriptorOrPath from collections.abc import Sized @@ -8,6 +9,8 @@ class ResourceTracker: def ensure_running(self) -> None: ... def register(self, name: Sized, rtype: str) -> None: ... def unregister(self, name: Sized, rtype: str) -> None: ... + if sys.version_info >= (3, 12): + def __del__(self) -> None: ... _resource_tracker: ResourceTracker ensure_running = _resource_tracker.ensure_running diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi index b63cedf858676..1a12812c27e4d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/shared_memory.pyi @@ -1,11 +1,9 @@ import sys from collections.abc import Iterable +from types import GenericAlias from typing import Any, Generic, TypeVar, overload from typing_extensions import Self -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = ["SharedMemory", "ShareableList"] _SLT = TypeVar("_SLT", int, float, bool, str, bytes, None) @@ -40,5 +38,4 @@ class ShareableList(Generic[_SLT]): def format(self) -> str: ... def count(self, value: _SLT) -> int: ... def index(self, value: _SLT) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi index 2b0498abc2c61..5283445d8545b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/sharedctypes.pyi @@ -1,6 +1,7 @@ import ctypes +from _ctypes import _CData from collections.abc import Callable, Iterable, Sequence -from ctypes import _CData, _SimpleCData, c_char +from ctypes import _SimpleCData, c_char from multiprocessing.context import BaseContext from multiprocessing.synchronize import _LockLike from types import TracebackType diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi new file mode 100644 index 0000000000000..4a97532228974 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/spawn.pyi @@ -0,0 +1,32 @@ +from collections.abc import Mapping, Sequence +from types import ModuleType +from typing import Any, Final + +__all__ = [ + "_main", + "freeze_support", + "set_executable", + "get_executable", + "get_preparation_data", + "get_command_line", + "import_main_path", +] + +WINEXE: Final[bool] +WINSERVICE: Final[bool] + +def set_executable(exe: str) -> None: ... +def get_executable() -> str: ... +def is_forking(argv: Sequence[str]) -> bool: ... +def freeze_support() -> None: ... +def get_command_line(**kwds: Any) -> list[str]: ... +def spawn_main(pipe_handle: int, parent_pid: int | None = None, tracker_fd: int | None = None) -> None: ... + +# undocumented +def _main(fd: int, parent_sentinel: int) -> int: ... +def get_preparation_data(name: str) -> dict[str, Any]: ... + +old_main_modules: list[ModuleType] + +def prepare(data: Mapping[str, Any]) -> None: ... +def import_main_path(main_path: str) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi new file mode 100644 index 0000000000000..a0d97baa0633b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/synchronize.pyi @@ -0,0 +1,60 @@ +import threading +from collections.abc import Callable +from multiprocessing.context import BaseContext +from types import TracebackType +from typing_extensions import TypeAlias + +__all__ = ["Lock", "RLock", "Semaphore", "BoundedSemaphore", "Condition", "Event"] + +_LockLike: TypeAlias = Lock | RLock + +class Barrier(threading.Barrier): + def __init__( + self, parties: int, action: Callable[[], object] | None = None, timeout: float | None = None, *, ctx: BaseContext + ) -> None: ... + +class Condition: + def __init__(self, lock: _LockLike | None = None, *, ctx: BaseContext) -> None: ... + def notify(self, n: int = 1) -> None: ... + def notify_all(self) -> None: ... + def wait(self, timeout: float | None = None) -> bool: ... + def wait_for(self, predicate: Callable[[], bool], timeout: float | None = None) -> bool: ... + def __enter__(self) -> bool: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None, / + ) -> None: ... + # These methods are copied from the lock passed to the constructor, or an + # instance of ctx.RLock() if lock was None. + def acquire(self, block: bool = True, timeout: float | None = None) -> bool: ... + def release(self) -> None: ... + +class Event: + def __init__(self, *, ctx: BaseContext) -> None: ... + def is_set(self) -> bool: ... + def set(self) -> None: ... + def clear(self) -> None: ... + def wait(self, timeout: float | None = None) -> bool: ... + +# Not part of public API +class SemLock: + def __init__(self, kind: int, value: int, maxvalue: int, *, ctx: BaseContext | None) -> None: ... + def __enter__(self) -> bool: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None, / + ) -> None: ... + # These methods are copied from the wrapped _multiprocessing.SemLock object + def acquire(self, block: bool = True, timeout: float | None = None) -> bool: ... + def release(self) -> None: ... + +class Lock(SemLock): + def __init__(self, *, ctx: BaseContext) -> None: ... + +class RLock(SemLock): + def __init__(self, *, ctx: BaseContext) -> None: ... + +class Semaphore(SemLock): + def __init__(self, value: int = 1, *, ctx: BaseContext) -> None: ... + def get_value(self) -> int: ... + +class BoundedSemaphore(Semaphore): + def __init__(self, value: int = 1, *, ctx: BaseContext) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/multiprocessing/util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/multiprocessing/util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/netrc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/netrc.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/netrc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/netrc.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/nis.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/nis.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/nis.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/nis.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/nntplib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/nntplib.pyi similarity index 95% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/nntplib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/nntplib.pyi index 85dfbff1cb50e..1fb1e79f69a1f 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/nntplib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/nntplib.pyi @@ -1,7 +1,6 @@ import datetime import socket import ssl -import sys from _typeshed import Unused from builtins import list as _list # conflicts with a method named "list" from collections.abc import Iterable @@ -98,10 +97,6 @@ class NNTP: def over( self, message_spec: None | str | _list[Any] | tuple[Any, ...], *, file: _File = None ) -> tuple[str, _list[tuple[int, dict[str, str]]]]: ... - if sys.version_info < (3, 9): - def xgtitle(self, group: str, *, file: _File = None) -> tuple[str, _list[tuple[str, str]]]: ... - def xpath(self, id: Any) -> tuple[str, str]: ... - def date(self) -> tuple[str, datetime.datetime]: ... def post(self, data: bytes | Iterable[bytes]) -> str: ... def ihave(self, message_id: Any, data: bytes | Iterable[bytes]) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/nt.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/nt.pyi similarity index 96% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/nt.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/nt.pyi index e1d57d09a9bd5..3ed8f8af379b8 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/nt.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/nt.pyi @@ -89,14 +89,14 @@ if sys.platform == "win32": umask as umask, uname_result as uname_result, unlink as unlink, + unsetenv as unsetenv, urandom as urandom, utime as utime, waitpid as waitpid, + waitstatus_to_exitcode as waitstatus_to_exitcode, write as write, ) - if sys.version_info >= (3, 9): - from os import unsetenv as unsetenv, waitstatus_to_exitcode as waitstatus_to_exitcode if sys.version_info >= (3, 11): from os import EX_OK as EX_OK if sys.version_info >= (3, 12): diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ntpath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ntpath.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ntpath.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ntpath.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/nturl2path.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/nturl2path.pyi new file mode 100644 index 0000000000000..c38a359469d2d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/nturl2path.pyi @@ -0,0 +1,12 @@ +import sys +from typing_extensions import deprecated + +if sys.version_info >= (3, 14): + @deprecated("nturl2path module was deprecated since Python 3.14") + def url2pathname(url: str) -> str: ... + @deprecated("nturl2path module was deprecated since Python 3.14") + def pathname2url(p: str) -> str: ... + +else: + def url2pathname(url: str) -> str: ... + def pathname2url(p: str) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/numbers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/numbers.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/numbers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/numbers.pyi index e129de2cdc67a..f2bca4e58bc58 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/numbers.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/numbers.pyi @@ -9,7 +9,7 @@ from _typeshed import Incomplete from abc import ABCMeta, abstractmethod -from typing import Literal, Protocol, overload +from typing import ClassVar, Literal, Protocol, overload __all__ = ["Number", "Complex", "Real", "Rational", "Integral"] @@ -102,6 +102,7 @@ class Complex(Number, _ComplexLike): def conjugate(self) -> _ComplexLike: ... @abstractmethod def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] # See comment at the top of the file # for why some of these return types are purposefully vague diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/opcode.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/opcode.pyi new file mode 100644 index 0000000000000..a5a3a79c323b0 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/opcode.pyi @@ -0,0 +1,47 @@ +import sys +from typing import Literal + +__all__ = [ + "cmp_op", + "hasconst", + "hasname", + "hasjrel", + "hasjabs", + "haslocal", + "hascompare", + "hasfree", + "opname", + "opmap", + "HAVE_ARGUMENT", + "EXTENDED_ARG", + "stack_effect", +] +if sys.version_info >= (3, 12): + __all__ += ["hasarg", "hasexc"] +else: + __all__ += ["hasnargs"] +if sys.version_info >= (3, 13): + __all__ += ["hasjump"] + +cmp_op: tuple[Literal["<"], Literal["<="], Literal["=="], Literal["!="], Literal[">"], Literal[">="]] +hasconst: list[int] +hasname: list[int] +hasjrel: list[int] +hasjabs: list[int] +haslocal: list[int] +hascompare: list[int] +hasfree: list[int] +if sys.version_info >= (3, 12): + hasarg: list[int] + hasexc: list[int] +else: + hasnargs: list[int] +if sys.version_info >= (3, 13): + hasjump: list[int] +opname: list[str] + +opmap: dict[str, int] +HAVE_ARGUMENT: int +EXTENDED_ARG: int + +def stack_effect(opcode: int, oparg: int | None = None, /, *, jump: bool | None = None) -> int: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/operator.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/operator.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/operator.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/operator.pyi index b73e037f3ed9b..bc2b5e0266171 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/operator.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/operator.pyi @@ -54,7 +54,7 @@ from _operator import ( ) from _typeshed import SupportsGetItem from typing import Any, Generic, TypeVar, final, overload -from typing_extensions import TypeVarTuple, Unpack +from typing_extensions import Self, TypeVarTuple, Unpack _T = TypeVar("_T") _T_co = TypeVar("_T_co", covariant=True) @@ -211,5 +211,5 @@ class itemgetter(Generic[_T_co]): @final class methodcaller: - def __init__(self, name: str, /, *args: Any, **kwargs: Any) -> None: ... + def __new__(cls, name: str, /, *args: Any, **kwargs: Any) -> Self: ... def __call__(self, obj: Any) -> Any: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/optparse.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/optparse.pyi new file mode 100644 index 0000000000000..8b7fcd82e5a55 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/optparse.pyi @@ -0,0 +1,309 @@ +import builtins +from _typeshed import MaybeNone, SupportsWrite +from abc import abstractmethod +from collections.abc import Callable, Iterable, Mapping, Sequence +from typing import Any, ClassVar, Final, Literal, NoReturn, overload +from typing_extensions import Self + +__all__ = [ + "Option", + "make_option", + "SUPPRESS_HELP", + "SUPPRESS_USAGE", + "Values", + "OptionContainer", + "OptionGroup", + "OptionParser", + "HelpFormatter", + "IndentedHelpFormatter", + "TitledHelpFormatter", + "OptParseError", + "OptionError", + "OptionConflictError", + "OptionValueError", + "BadOptionError", + "check_choice", +] +# pytype is not happy with `NO_DEFAULT: Final = ("NO", "DEFAULT")` +NO_DEFAULT: Final[tuple[Literal["NO"], Literal["DEFAULT"]]] +SUPPRESS_HELP: Final = "SUPPRESSHELP" +SUPPRESS_USAGE: Final = "SUPPRESSUSAGE" + +# Can return complex, float, or int depending on the option's type +def check_builtin(option: Option, opt: str, value: str) -> complex: ... +def check_choice(option: Option, opt: str, value: str) -> str: ... + +class OptParseError(Exception): + msg: str + def __init__(self, msg: str) -> None: ... + +class BadOptionError(OptParseError): + opt_str: str + def __init__(self, opt_str: str) -> None: ... + +class AmbiguousOptionError(BadOptionError): + possibilities: Iterable[str] + def __init__(self, opt_str: str, possibilities: Sequence[str]) -> None: ... + +class OptionError(OptParseError): + option_id: str + def __init__(self, msg: str, option: Option) -> None: ... + +class OptionConflictError(OptionError): ... +class OptionValueError(OptParseError): ... + +class HelpFormatter: + NO_DEFAULT_VALUE: str + _long_opt_fmt: str + _short_opt_fmt: str + current_indent: int + default_tag: str + help_position: int + help_width: int | MaybeNone # initialized as None and computed later as int when storing option strings + indent_increment: int + level: int + max_help_position: int + option_strings: dict[Option, str] + parser: OptionParser + short_first: bool | Literal[0, 1] + width: int + def __init__( + self, indent_increment: int, max_help_position: int, width: int | None, short_first: bool | Literal[0, 1] + ) -> None: ... + def dedent(self) -> None: ... + def expand_default(self, option: Option) -> str: ... + def format_description(self, description: str | None) -> str: ... + def format_epilog(self, epilog: str | None) -> str: ... + @abstractmethod + def format_heading(self, heading: str) -> str: ... + def format_option(self, option: Option) -> str: ... + def format_option_strings(self, option: Option) -> str: ... + @abstractmethod + def format_usage(self, usage: str) -> str: ... + def indent(self) -> None: ... + def set_long_opt_delimiter(self, delim: str) -> None: ... + def set_parser(self, parser: OptionParser) -> None: ... + def set_short_opt_delimiter(self, delim: str) -> None: ... + def store_option_strings(self, parser: OptionParser) -> None: ... + +class IndentedHelpFormatter(HelpFormatter): + def __init__( + self, + indent_increment: int = 2, + max_help_position: int = 24, + width: int | None = None, + short_first: bool | Literal[0, 1] = 1, + ) -> None: ... + def format_heading(self, heading: str) -> str: ... + def format_usage(self, usage: str) -> str: ... + +class TitledHelpFormatter(HelpFormatter): + def __init__( + self, + indent_increment: int = 0, + max_help_position: int = 24, + width: int | None = None, + short_first: bool | Literal[0, 1] = 0, + ) -> None: ... + def format_heading(self, heading: str) -> str: ... + def format_usage(self, usage: str) -> str: ... + +class Option: + ACTIONS: tuple[str, ...] + ALWAYS_TYPED_ACTIONS: tuple[str, ...] + ATTRS: list[str] + CHECK_METHODS: list[Callable[[Self], object]] | None + CONST_ACTIONS: tuple[str, ...] + STORE_ACTIONS: tuple[str, ...] + TYPED_ACTIONS: tuple[str, ...] + TYPES: tuple[str, ...] + TYPE_CHECKER: dict[str, Callable[[Option, str, str], object]] + _long_opts: list[str] + _short_opts: list[str] + action: str + type: str | None + dest: str | None + default: Any # default can be "any" type + nargs: int + const: Any | None # const can be "any" type + choices: list[str] | tuple[str, ...] | None + # Callback args and kwargs cannot be expressed in Python's type system. + # Revisit if ParamSpec is ever changed to work with packed args/kwargs. + callback: Callable[..., object] | None + callback_args: tuple[Any, ...] | None + callback_kwargs: dict[str, Any] | None + help: str | None + metavar: str | None + def __init__( + self, + *opts: str | None, + # The following keywords are handled by the _set_attrs method. All default to + # `None` except for `default`, which defaults to `NO_DEFAULT`. + action: str | None = None, + type: str | builtins.type | None = None, + dest: str | None = None, + default: Any = ..., # = NO_DEFAULT + nargs: int | None = None, + const: Any | None = None, + choices: list[str] | tuple[str, ...] | None = None, + callback: Callable[..., object] | None = None, + callback_args: tuple[Any, ...] | None = None, + callback_kwargs: dict[str, Any] | None = None, + help: str | None = None, + metavar: str | None = None, + ) -> None: ... + def _check_action(self) -> None: ... + def _check_callback(self) -> None: ... + def _check_choice(self) -> None: ... + def _check_const(self) -> None: ... + def _check_dest(self) -> None: ... + def _check_nargs(self) -> None: ... + def _check_opt_strings(self, opts: Iterable[str | None]) -> list[str]: ... + def _check_type(self) -> None: ... + def _set_attrs(self, attrs: dict[str, Any]) -> None: ... # accepted attrs depend on the ATTRS attribute + def _set_opt_strings(self, opts: Iterable[str]) -> None: ... + def check_value(self, opt: str, value: str) -> Any: ... # return type cannot be known statically + def convert_value(self, opt: str, value: str | tuple[str, ...] | None) -> Any: ... # return type cannot be known statically + def get_opt_string(self) -> str: ... + def process(self, opt: str, value: str | tuple[str, ...] | None, values: Values, parser: OptionParser) -> int: ... + # value of take_action can be "any" type + def take_action(self, action: str, dest: str, opt: str, value: Any, values: Values, parser: OptionParser) -> int: ... + def takes_value(self) -> bool: ... + +make_option = Option + +class OptionContainer: + _long_opt: dict[str, Option] + _short_opt: dict[str, Option] + conflict_handler: str + defaults: dict[str, Any] # default values can be "any" type + description: str | None + option_class: type[Option] + def __init__( + self, option_class: type[Option], conflict_handler: Literal["error", "resolve"], description: str | None + ) -> None: ... + def _check_conflict(self, option: Option) -> None: ... + def _create_option_mappings(self) -> None: ... + def _share_option_mappings(self, parser: OptionParser) -> None: ... + @overload + def add_option(self, opt: Option, /) -> Option: ... + @overload + def add_option( + self, + opt_str: str, + /, + *opts: str | None, + action: str | None = None, + type: str | builtins.type | None = None, + dest: str | None = None, + default: Any = ..., # = NO_DEFAULT + nargs: int | None = None, + const: Any | None = None, + choices: list[str] | tuple[str, ...] | None = None, + callback: Callable[..., object] | None = None, + callback_args: tuple[Any, ...] | None = None, + callback_kwargs: dict[str, Any] | None = None, + help: str | None = None, + metavar: str | None = None, + **kwargs, # Allow arbitrary keyword arguments for user defined option_class + ) -> Option: ... + def add_options(self, option_list: Iterable[Option]) -> None: ... + def destroy(self) -> None: ... + def format_option_help(self, formatter: HelpFormatter) -> str: ... + def format_description(self, formatter: HelpFormatter) -> str: ... + def format_help(self, formatter: HelpFormatter) -> str: ... + def get_description(self) -> str | None: ... + def get_option(self, opt_str: str) -> Option | None: ... + def has_option(self, opt_str: str) -> bool: ... + def remove_option(self, opt_str: str) -> None: ... + def set_conflict_handler(self, handler: Literal["error", "resolve"]) -> None: ... + def set_description(self, description: str | None) -> None: ... + +class OptionGroup(OptionContainer): + option_list: list[Option] + parser: OptionParser + title: str + def __init__(self, parser: OptionParser, title: str, description: str | None = None) -> None: ... + def _create_option_list(self) -> None: ... + def set_title(self, title: str) -> None: ... + +class Values: + def __init__(self, defaults: Mapping[str, object] | None = None) -> None: ... + def _update(self, dict: Mapping[str, object], mode: Literal["careful", "loose"]) -> None: ... + def _update_careful(self, dict: Mapping[str, object]) -> None: ... + def _update_loose(self, dict: Mapping[str, object]) -> None: ... + def ensure_value(self, attr: str, value: object) -> Any: ... # return type cannot be known statically + def read_file(self, filename: str, mode: Literal["careful", "loose"] = "careful") -> None: ... + def read_module(self, modname: str, mode: Literal["careful", "loose"] = "careful") -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] + # __getattr__ doesn't exist, but anything passed as a default to __init__ + # is set on the instance. + def __getattr__(self, name: str) -> Any: ... + # TODO: mypy infers -> object for __getattr__ if __setattr__ has `value: object` + def __setattr__(self, name: str, value: Any, /) -> None: ... + def __eq__(self, other: object) -> bool: ... + +class OptionParser(OptionContainer): + allow_interspersed_args: bool + epilog: str | None + formatter: HelpFormatter + largs: list[str] | None + option_groups: list[OptionGroup] + option_list: list[Option] + process_default_values: bool + prog: str | None + rargs: list[str] | None + standard_option_list: list[Option] + usage: str | None + values: Values | None + version: str + def __init__( + self, + usage: str | None = None, + option_list: Iterable[Option] | None = None, + option_class: type[Option] = ..., + version: str | None = None, + conflict_handler: str = "error", + description: str | None = None, + formatter: HelpFormatter | None = None, + add_help_option: bool = True, + prog: str | None = None, + epilog: str | None = None, + ) -> None: ... + def _add_help_option(self) -> None: ... + def _add_version_option(self) -> None: ... + def _create_option_list(self) -> None: ... + def _get_all_options(self) -> list[Option]: ... + def _get_args(self, args: list[str] | None) -> list[str]: ... + def _init_parsing_state(self) -> None: ... + def _match_long_opt(self, opt: str) -> str: ... + def _populate_option_list(self, option_list: Iterable[Option] | None, add_help: bool = True) -> None: ... + def _process_args(self, largs: list[str], rargs: list[str], values: Values) -> None: ... + def _process_long_opt(self, rargs: list[str], values: Values) -> None: ... + def _process_short_opts(self, rargs: list[str], values: Values) -> None: ... + @overload + def add_option_group(self, opt_group: OptionGroup, /) -> OptionGroup: ... + @overload + def add_option_group(self, title: str, /, description: str | None = None) -> OptionGroup: ... + def check_values(self, values: Values, args: list[str]) -> tuple[Values, list[str]]: ... + def disable_interspersed_args(self) -> None: ... + def enable_interspersed_args(self) -> None: ... + def error(self, msg: str) -> NoReturn: ... + def exit(self, status: int = 0, msg: str | None = None) -> NoReturn: ... + def expand_prog_name(self, s: str) -> str: ... + def format_epilog(self, formatter: HelpFormatter) -> str: ... + def format_help(self, formatter: HelpFormatter | None = None) -> str: ... + def format_option_help(self, formatter: HelpFormatter | None = None) -> str: ... + def get_default_values(self) -> Values: ... + def get_option_group(self, opt_str: str) -> OptionGroup | None: ... + def get_prog_name(self) -> str: ... + def get_usage(self) -> str: ... + def get_version(self) -> str: ... + def parse_args(self, args: list[str] | None = None, values: Values | None = None) -> tuple[Values, list[str]]: ... + def print_usage(self, file: SupportsWrite[str] | None = None) -> None: ... + def print_help(self, file: SupportsWrite[str] | None = None) -> None: ... + def print_version(self, file: SupportsWrite[str] | None = None) -> None: ... + def set_default(self, dest: str, value: Any) -> None: ... # default value can be "any" type + def set_defaults(self, **kwargs: Any) -> None: ... # default values can be "any" type + def set_process_default_values(self, process: bool) -> None: ... + def set_usage(self, usage: str | None) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/os/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/os/__init__.pyi new file mode 100644 index 0000000000000..5286c76d1b066 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/os/__init__.pyi @@ -0,0 +1,1664 @@ +import sys +from _typeshed import ( + AnyStr_co, + BytesPath, + FileDescriptor, + FileDescriptorLike, + FileDescriptorOrPath, + GenericPath, + OpenBinaryMode, + OpenBinaryModeReading, + OpenBinaryModeUpdating, + OpenBinaryModeWriting, + OpenTextMode, + ReadableBuffer, + StrOrBytesPath, + StrPath, + SupportsLenAndGetItem, + Unused, + WriteableBuffer, + structseq, +) +from abc import ABC, abstractmethod +from builtins import OSError +from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping, Sequence +from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper +from subprocess import Popen +from types import GenericAlias, TracebackType +from typing import ( + IO, + Any, + AnyStr, + BinaryIO, + Final, + Generic, + Literal, + NoReturn, + Protocol, + TypeVar, + final, + overload, + runtime_checkable, +) +from typing_extensions import Self, TypeAlias, Unpack, deprecated + +from . import path as _path + +__all__ = [ + "F_OK", + "O_APPEND", + "O_CREAT", + "O_EXCL", + "O_RDONLY", + "O_RDWR", + "O_TRUNC", + "O_WRONLY", + "P_NOWAIT", + "P_NOWAITO", + "P_WAIT", + "R_OK", + "SEEK_CUR", + "SEEK_END", + "SEEK_SET", + "TMP_MAX", + "W_OK", + "X_OK", + "DirEntry", + "_exit", + "abort", + "access", + "altsep", + "chdir", + "chmod", + "close", + "closerange", + "cpu_count", + "curdir", + "defpath", + "device_encoding", + "devnull", + "dup", + "dup2", + "environ", + "error", + "execl", + "execle", + "execlp", + "execlpe", + "execv", + "execve", + "execvp", + "execvpe", + "extsep", + "fdopen", + "fsdecode", + "fsencode", + "fspath", + "fstat", + "fsync", + "ftruncate", + "get_exec_path", + "get_inheritable", + "get_terminal_size", + "getcwd", + "getcwdb", + "getenv", + "getlogin", + "getpid", + "getppid", + "isatty", + "kill", + "linesep", + "link", + "listdir", + "lseek", + "lstat", + "makedirs", + "mkdir", + "name", + "open", + "pardir", + "path", + "pathsep", + "pipe", + "popen", + "putenv", + "read", + "readlink", + "remove", + "removedirs", + "rename", + "renames", + "replace", + "rmdir", + "scandir", + "sep", + "set_inheritable", + "spawnl", + "spawnle", + "spawnv", + "spawnve", + "stat", + "stat_result", + "statvfs_result", + "strerror", + "supports_bytes_environ", + "symlink", + "system", + "terminal_size", + "times", + "times_result", + "truncate", + "umask", + "uname_result", + "unlink", + "unsetenv", + "urandom", + "utime", + "waitpid", + "waitstatus_to_exitcode", + "walk", + "write", +] +if sys.version_info >= (3, 14): + __all__ += ["readinto"] +if sys.platform == "darwin" and sys.version_info >= (3, 12): + __all__ += ["PRIO_DARWIN_BG", "PRIO_DARWIN_NONUI", "PRIO_DARWIN_PROCESS", "PRIO_DARWIN_THREAD"] +if sys.platform == "darwin" and sys.version_info >= (3, 10): + __all__ += ["O_EVTONLY", "O_NOFOLLOW_ANY", "O_SYMLINK"] +if sys.platform == "linux": + __all__ += [ + "GRND_NONBLOCK", + "GRND_RANDOM", + "MFD_ALLOW_SEALING", + "MFD_CLOEXEC", + "MFD_HUGETLB", + "MFD_HUGE_16GB", + "MFD_HUGE_16MB", + "MFD_HUGE_1GB", + "MFD_HUGE_1MB", + "MFD_HUGE_256MB", + "MFD_HUGE_2GB", + "MFD_HUGE_2MB", + "MFD_HUGE_32MB", + "MFD_HUGE_512KB", + "MFD_HUGE_512MB", + "MFD_HUGE_64KB", + "MFD_HUGE_8MB", + "MFD_HUGE_MASK", + "MFD_HUGE_SHIFT", + "O_DIRECT", + "O_LARGEFILE", + "O_NOATIME", + "O_PATH", + "O_RSYNC", + "O_TMPFILE", + "P_PIDFD", + "RTLD_DEEPBIND", + "SCHED_BATCH", + "SCHED_IDLE", + "SCHED_RESET_ON_FORK", + "XATTR_CREATE", + "XATTR_REPLACE", + "XATTR_SIZE_MAX", + "copy_file_range", + "getrandom", + "getxattr", + "listxattr", + "memfd_create", + "pidfd_open", + "removexattr", + "setxattr", + ] +if sys.platform == "linux" and sys.version_info >= (3, 14): + __all__ += ["SCHED_DEADLINE", "SCHED_NORMAL"] +if sys.platform == "linux" and sys.version_info >= (3, 13): + __all__ += [ + "POSIX_SPAWN_CLOSEFROM", + "TFD_CLOEXEC", + "TFD_NONBLOCK", + "TFD_TIMER_ABSTIME", + "TFD_TIMER_CANCEL_ON_SET", + "timerfd_create", + "timerfd_gettime", + "timerfd_gettime_ns", + "timerfd_settime", + "timerfd_settime_ns", + ] +if sys.platform == "linux" and sys.version_info >= (3, 12): + __all__ += [ + "CLONE_FILES", + "CLONE_FS", + "CLONE_NEWCGROUP", + "CLONE_NEWIPC", + "CLONE_NEWNET", + "CLONE_NEWNS", + "CLONE_NEWPID", + "CLONE_NEWTIME", + "CLONE_NEWUSER", + "CLONE_NEWUTS", + "CLONE_SIGHAND", + "CLONE_SYSVSEM", + "CLONE_THREAD", + "CLONE_VM", + "setns", + "unshare", + "PIDFD_NONBLOCK", + ] +if sys.platform == "linux" and sys.version_info >= (3, 10): + __all__ += [ + "EFD_CLOEXEC", + "EFD_NONBLOCK", + "EFD_SEMAPHORE", + "RWF_APPEND", + "SPLICE_F_MORE", + "SPLICE_F_MOVE", + "SPLICE_F_NONBLOCK", + "eventfd", + "eventfd_read", + "eventfd_write", + "splice", + ] +if sys.platform == "win32": + __all__ += [ + "O_BINARY", + "O_NOINHERIT", + "O_RANDOM", + "O_SEQUENTIAL", + "O_SHORT_LIVED", + "O_TEMPORARY", + "O_TEXT", + "P_DETACH", + "P_OVERLAY", + "get_handle_inheritable", + "set_handle_inheritable", + "startfile", + ] +if sys.platform == "win32" and sys.version_info >= (3, 12): + __all__ += ["listdrives", "listmounts", "listvolumes"] +if sys.platform != "win32": + __all__ += [ + "CLD_CONTINUED", + "CLD_DUMPED", + "CLD_EXITED", + "CLD_KILLED", + "CLD_STOPPED", + "CLD_TRAPPED", + "EX_CANTCREAT", + "EX_CONFIG", + "EX_DATAERR", + "EX_IOERR", + "EX_NOHOST", + "EX_NOINPUT", + "EX_NOPERM", + "EX_NOUSER", + "EX_OSERR", + "EX_OSFILE", + "EX_PROTOCOL", + "EX_SOFTWARE", + "EX_TEMPFAIL", + "EX_UNAVAILABLE", + "EX_USAGE", + "F_LOCK", + "F_TEST", + "F_TLOCK", + "F_ULOCK", + "NGROUPS_MAX", + "O_ACCMODE", + "O_ASYNC", + "O_CLOEXEC", + "O_DIRECTORY", + "O_DSYNC", + "O_NDELAY", + "O_NOCTTY", + "O_NOFOLLOW", + "O_NONBLOCK", + "O_SYNC", + "POSIX_SPAWN_CLOSE", + "POSIX_SPAWN_DUP2", + "POSIX_SPAWN_OPEN", + "PRIO_PGRP", + "PRIO_PROCESS", + "PRIO_USER", + "P_ALL", + "P_PGID", + "P_PID", + "RTLD_GLOBAL", + "RTLD_LAZY", + "RTLD_LOCAL", + "RTLD_NODELETE", + "RTLD_NOLOAD", + "RTLD_NOW", + "SCHED_FIFO", + "SCHED_OTHER", + "SCHED_RR", + "SEEK_DATA", + "SEEK_HOLE", + "ST_NOSUID", + "ST_RDONLY", + "WCONTINUED", + "WCOREDUMP", + "WEXITED", + "WEXITSTATUS", + "WIFCONTINUED", + "WIFEXITED", + "WIFSIGNALED", + "WIFSTOPPED", + "WNOHANG", + "WNOWAIT", + "WSTOPPED", + "WSTOPSIG", + "WTERMSIG", + "WUNTRACED", + "chown", + "chroot", + "confstr", + "confstr_names", + "ctermid", + "environb", + "fchdir", + "fchown", + "fork", + "forkpty", + "fpathconf", + "fstatvfs", + "fwalk", + "getegid", + "getenvb", + "geteuid", + "getgid", + "getgrouplist", + "getgroups", + "getloadavg", + "getpgid", + "getpgrp", + "getpriority", + "getsid", + "getuid", + "initgroups", + "killpg", + "lchown", + "lockf", + "major", + "makedev", + "minor", + "mkfifo", + "mknod", + "nice", + "openpty", + "pathconf", + "pathconf_names", + "posix_spawn", + "posix_spawnp", + "pread", + "preadv", + "pwrite", + "pwritev", + "readv", + "register_at_fork", + "sched_get_priority_max", + "sched_get_priority_min", + "sched_yield", + "sendfile", + "setegid", + "seteuid", + "setgid", + "setgroups", + "setpgid", + "setpgrp", + "setpriority", + "setregid", + "setreuid", + "setsid", + "setuid", + "spawnlp", + "spawnlpe", + "spawnvp", + "spawnvpe", + "statvfs", + "sync", + "sysconf", + "sysconf_names", + "tcgetpgrp", + "tcsetpgrp", + "ttyname", + "uname", + "wait", + "wait3", + "wait4", + "writev", + ] +if sys.platform != "win32" and sys.version_info >= (3, 13): + __all__ += ["grantpt", "posix_openpt", "ptsname", "unlockpt"] +if sys.platform != "win32" and sys.version_info >= (3, 11): + __all__ += ["login_tty"] +if sys.platform != "win32" and sys.version_info >= (3, 10): + __all__ += ["O_FSYNC"] +if sys.platform != "darwin" and sys.platform != "win32": + __all__ += [ + "POSIX_FADV_DONTNEED", + "POSIX_FADV_NOREUSE", + "POSIX_FADV_NORMAL", + "POSIX_FADV_RANDOM", + "POSIX_FADV_SEQUENTIAL", + "POSIX_FADV_WILLNEED", + "RWF_DSYNC", + "RWF_HIPRI", + "RWF_NOWAIT", + "RWF_SYNC", + "ST_APPEND", + "ST_MANDLOCK", + "ST_NOATIME", + "ST_NODEV", + "ST_NODIRATIME", + "ST_NOEXEC", + "ST_RELATIME", + "ST_SYNCHRONOUS", + "ST_WRITE", + "fdatasync", + "getresgid", + "getresuid", + "pipe2", + "posix_fadvise", + "posix_fallocate", + "sched_getaffinity", + "sched_getparam", + "sched_getscheduler", + "sched_param", + "sched_rr_get_interval", + "sched_setaffinity", + "sched_setparam", + "sched_setscheduler", + "setresgid", + "setresuid", + ] +if sys.platform != "linux" and sys.platform != "win32": + __all__ += ["O_EXLOCK", "O_SHLOCK", "chflags", "lchflags"] +if sys.platform != "linux" and sys.platform != "win32" and sys.version_info >= (3, 13): + __all__ += ["O_EXEC", "O_SEARCH"] +if sys.platform != "darwin" or sys.version_info >= (3, 13): + if sys.platform != "win32": + __all__ += ["waitid", "waitid_result"] +if sys.platform != "win32" or sys.version_info >= (3, 13): + __all__ += ["fchmod"] + if sys.platform != "linux": + __all__ += ["lchmod"] +if sys.platform != "win32" or sys.version_info >= (3, 12): + __all__ += ["get_blocking", "set_blocking"] +if sys.platform != "win32" or sys.version_info >= (3, 11): + __all__ += ["EX_OK"] + +# This unnecessary alias is to work around various errors +path = _path + +_T = TypeVar("_T") +_T1 = TypeVar("_T1") +_T2 = TypeVar("_T2") + +# ----- os variables ----- + +error = OSError + +supports_bytes_environ: bool + +supports_dir_fd: set[Callable[..., Any]] +supports_fd: set[Callable[..., Any]] +supports_effective_ids: set[Callable[..., Any]] +supports_follow_symlinks: set[Callable[..., Any]] + +if sys.platform != "win32": + # Unix only + PRIO_PROCESS: int + PRIO_PGRP: int + PRIO_USER: int + + F_LOCK: int + F_TLOCK: int + F_ULOCK: int + F_TEST: int + + if sys.platform != "darwin": + POSIX_FADV_NORMAL: int + POSIX_FADV_SEQUENTIAL: int + POSIX_FADV_RANDOM: int + POSIX_FADV_NOREUSE: int + POSIX_FADV_WILLNEED: int + POSIX_FADV_DONTNEED: int + + if sys.platform != "linux" and sys.platform != "darwin": + # In the os-module docs, these are marked as being available + # on "Unix, not Emscripten, not WASI." + # However, in the source code, a comment indicates they're "FreeBSD constants". + # sys.platform could have one of many values on a FreeBSD Python build, + # so the sys-module docs recommend doing `if sys.platform.startswith('freebsd')` + # to detect FreeBSD builds. Unfortunately that would be too dynamic + # for type checkers, however. + SF_NODISKIO: int + SF_MNOWAIT: int + SF_SYNC: int + + if sys.version_info >= (3, 11): + SF_NOCACHE: int + + if sys.platform == "linux": + XATTR_SIZE_MAX: int + XATTR_CREATE: int + XATTR_REPLACE: int + + P_PID: int + P_PGID: int + P_ALL: int + + if sys.platform == "linux": + P_PIDFD: int + + WEXITED: int + WSTOPPED: int + WNOWAIT: int + + CLD_EXITED: int + CLD_DUMPED: int + CLD_TRAPPED: int + CLD_CONTINUED: int + CLD_KILLED: int + CLD_STOPPED: int + + SCHED_OTHER: int + SCHED_FIFO: int + SCHED_RR: int + if sys.platform != "darwin" and sys.platform != "linux": + SCHED_SPORADIC: int + +if sys.platform == "linux": + SCHED_BATCH: int + SCHED_IDLE: int + SCHED_RESET_ON_FORK: int + +if sys.version_info >= (3, 14) and sys.platform == "linux": + SCHED_DEADLINE: int + SCHED_NORMAL: int + +if sys.platform != "win32": + RTLD_LAZY: int + RTLD_NOW: int + RTLD_GLOBAL: int + RTLD_LOCAL: int + RTLD_NODELETE: int + RTLD_NOLOAD: int + +if sys.platform == "linux": + RTLD_DEEPBIND: int + GRND_NONBLOCK: int + GRND_RANDOM: int + +if sys.platform == "darwin" and sys.version_info >= (3, 12): + PRIO_DARWIN_BG: int + PRIO_DARWIN_NONUI: int + PRIO_DARWIN_PROCESS: int + PRIO_DARWIN_THREAD: int + +SEEK_SET: int +SEEK_CUR: int +SEEK_END: int +if sys.platform != "win32": + SEEK_DATA: int + SEEK_HOLE: int + +O_RDONLY: int +O_WRONLY: int +O_RDWR: int +O_APPEND: int +O_CREAT: int +O_EXCL: int +O_TRUNC: int +if sys.platform == "win32": + O_BINARY: int + O_NOINHERIT: int + O_SHORT_LIVED: int + O_TEMPORARY: int + O_RANDOM: int + O_SEQUENTIAL: int + O_TEXT: int + +if sys.platform != "win32": + O_DSYNC: int + O_SYNC: int + O_NDELAY: int + O_NONBLOCK: int + O_NOCTTY: int + O_CLOEXEC: int + O_ASYNC: int # Gnu extension if in C library + O_DIRECTORY: int # Gnu extension if in C library + O_NOFOLLOW: int # Gnu extension if in C library + O_ACCMODE: int # TODO: when does this exist? + +if sys.platform == "linux": + O_RSYNC: int + O_DIRECT: int # Gnu extension if in C library + O_NOATIME: int # Gnu extension if in C library + O_PATH: int # Gnu extension if in C library + O_TMPFILE: int # Gnu extension if in C library + O_LARGEFILE: int # Gnu extension if in C library + +if sys.platform != "linux" and sys.platform != "win32": + O_SHLOCK: int + O_EXLOCK: int + +if sys.platform == "darwin" and sys.version_info >= (3, 10): + O_EVTONLY: int + O_NOFOLLOW_ANY: int + O_SYMLINK: int + +if sys.platform != "win32" and sys.version_info >= (3, 10): + O_FSYNC: int + +if sys.platform != "linux" and sys.platform != "win32" and sys.version_info >= (3, 13): + O_EXEC: int + O_SEARCH: int + +if sys.platform != "win32" and sys.platform != "darwin": + # posix, but apparently missing on macos + ST_APPEND: int + ST_MANDLOCK: int + ST_NOATIME: int + ST_NODEV: int + ST_NODIRATIME: int + ST_NOEXEC: int + ST_RELATIME: int + ST_SYNCHRONOUS: int + ST_WRITE: int + +if sys.platform != "win32": + NGROUPS_MAX: int + ST_NOSUID: int + ST_RDONLY: int + +curdir: str +pardir: str +sep: str +if sys.platform == "win32": + altsep: str +else: + altsep: str | None +extsep: str +pathsep: str +defpath: str +linesep: str +devnull: str +name: str + +F_OK: int +R_OK: int +W_OK: int +X_OK: int + +_EnvironCodeFunc: TypeAlias = Callable[[AnyStr], AnyStr] + +class _Environ(MutableMapping[AnyStr, AnyStr], Generic[AnyStr]): + encodekey: _EnvironCodeFunc[AnyStr] + decodekey: _EnvironCodeFunc[AnyStr] + encodevalue: _EnvironCodeFunc[AnyStr] + decodevalue: _EnvironCodeFunc[AnyStr] + def __init__( + self, + data: MutableMapping[AnyStr, AnyStr], + encodekey: _EnvironCodeFunc[AnyStr], + decodekey: _EnvironCodeFunc[AnyStr], + encodevalue: _EnvironCodeFunc[AnyStr], + decodevalue: _EnvironCodeFunc[AnyStr], + ) -> None: ... + def setdefault(self, key: AnyStr, value: AnyStr) -> AnyStr: ... + def copy(self) -> dict[AnyStr, AnyStr]: ... + def __delitem__(self, key: AnyStr) -> None: ... + def __getitem__(self, key: AnyStr) -> AnyStr: ... + def __setitem__(self, key: AnyStr, value: AnyStr) -> None: ... + def __iter__(self) -> Iterator[AnyStr]: ... + def __len__(self) -> int: ... + def __or__(self, other: Mapping[_T1, _T2]) -> dict[AnyStr | _T1, AnyStr | _T2]: ... + def __ror__(self, other: Mapping[_T1, _T2]) -> dict[AnyStr | _T1, AnyStr | _T2]: ... + # We use @overload instead of a Union for reasons similar to those given for + # overloading MutableMapping.update in stdlib/typing.pyi + # The type: ignore is needed due to incompatible __or__/__ior__ signatures + @overload # type: ignore[misc] + def __ior__(self, other: Mapping[AnyStr, AnyStr]) -> Self: ... + @overload + def __ior__(self, other: Iterable[tuple[AnyStr, AnyStr]]) -> Self: ... + +environ: _Environ[str] +if sys.platform != "win32": + environb: _Environ[bytes] + +if sys.version_info >= (3, 11) or sys.platform != "win32": + EX_OK: int + +if sys.platform != "win32": + confstr_names: dict[str, int] + pathconf_names: dict[str, int] + sysconf_names: dict[str, int] + + EX_USAGE: int + EX_DATAERR: int + EX_NOINPUT: int + EX_NOUSER: int + EX_NOHOST: int + EX_UNAVAILABLE: int + EX_SOFTWARE: int + EX_OSERR: int + EX_OSFILE: int + EX_CANTCREAT: int + EX_IOERR: int + EX_TEMPFAIL: int + EX_PROTOCOL: int + EX_NOPERM: int + EX_CONFIG: int + +# Exists on some Unix platforms, e.g. Solaris. +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": + EX_NOTFOUND: int + +P_NOWAIT: int +P_NOWAITO: int +P_WAIT: int +if sys.platform == "win32": + P_DETACH: int + P_OVERLAY: int + +# wait()/waitpid() options +if sys.platform != "win32": + WNOHANG: int # Unix only + WCONTINUED: int # some Unix systems + WUNTRACED: int # Unix only + +TMP_MAX: int # Undocumented, but used by tempfile + +# ----- os classes (structures) ----- +@final +class stat_result(structseq[float], tuple[int, int, int, int, int, int, int, float, float, float]): + # The constructor of this class takes an iterable of variable length (though it must be at least 10). + # + # However, this class behaves like a tuple of 10 elements, + # no matter how long the iterable supplied to the constructor is. + # https://github.com/python/typeshed/pull/6560#discussion_r767162532 + # + # The 10 elements always present are st_mode, st_ino, st_dev, st_nlink, + # st_uid, st_gid, st_size, st_atime, st_mtime, st_ctime. + # + # More items may be added at the end by some implementations. + if sys.version_info >= (3, 10): + __match_args__: Final = ("st_mode", "st_ino", "st_dev", "st_nlink", "st_uid", "st_gid", "st_size") + + @property + def st_mode(self) -> int: ... # protection bits, + @property + def st_ino(self) -> int: ... # inode number, + @property + def st_dev(self) -> int: ... # device, + @property + def st_nlink(self) -> int: ... # number of hard links, + @property + def st_uid(self) -> int: ... # user id of owner, + @property + def st_gid(self) -> int: ... # group id of owner, + @property + def st_size(self) -> int: ... # size of file, in bytes, + @property + def st_atime(self) -> float: ... # time of most recent access, + @property + def st_mtime(self) -> float: ... # time of most recent content modification, + # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows) + if sys.version_info >= (3, 12) and sys.platform == "win32": + @property + @deprecated( + """\ +Use st_birthtime instead to retrieve the file creation time. \ +In the future, this property will contain the last metadata change time.""" + ) + def st_ctime(self) -> float: ... + else: + @property + def st_ctime(self) -> float: ... + + @property + def st_atime_ns(self) -> int: ... # time of most recent access, in nanoseconds + @property + def st_mtime_ns(self) -> int: ... # time of most recent content modification in nanoseconds + # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows) in nanoseconds + @property + def st_ctime_ns(self) -> int: ... + if sys.platform == "win32": + @property + def st_file_attributes(self) -> int: ... + @property + def st_reparse_tag(self) -> int: ... + if sys.version_info >= (3, 12): + @property + def st_birthtime(self) -> float: ... # time of file creation in seconds + @property + def st_birthtime_ns(self) -> int: ... # time of file creation in nanoseconds + else: + @property + def st_blocks(self) -> int: ... # number of blocks allocated for file + @property + def st_blksize(self) -> int: ... # filesystem blocksize + @property + def st_rdev(self) -> int: ... # type of device if an inode device + if sys.platform != "linux": + # These properties are available on MacOS, but not Ubuntu. + # On other Unix systems (such as FreeBSD), the following attributes may be + # available (but may be only filled out if root tries to use them): + @property + def st_gen(self) -> int: ... # file generation number + @property + def st_birthtime(self) -> float: ... # time of file creation in seconds + if sys.platform == "darwin": + @property + def st_flags(self) -> int: ... # user defined flags for file + # Attributes documented as sometimes appearing, but deliberately omitted from the stub: `st_creator`, `st_rsize`, `st_type`. + # See https://github.com/python/typeshed/pull/6560#issuecomment-991253327 + +# mypy and pyright object to this being both ABC and Protocol. +# At runtime it inherits from ABC and is not a Protocol, but it will be +# on the allowlist for use as a Protocol starting in 3.14. +@runtime_checkable +class PathLike(ABC, Protocol[AnyStr_co]): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + @abstractmethod + def __fspath__(self) -> AnyStr_co: ... + +@overload +def listdir(path: StrPath | None = None) -> list[str]: ... +@overload +def listdir(path: BytesPath) -> list[bytes]: ... +@overload +def listdir(path: int) -> list[str]: ... +@final +class DirEntry(Generic[AnyStr]): + # This is what the scandir iterator yields + # The constructor is hidden + + @property + def name(self) -> AnyStr: ... + @property + def path(self) -> AnyStr: ... + def inode(self) -> int: ... + def is_dir(self, *, follow_symlinks: bool = True) -> bool: ... + def is_file(self, *, follow_symlinks: bool = True) -> bool: ... + def is_symlink(self) -> bool: ... + def stat(self, *, follow_symlinks: bool = True) -> stat_result: ... + def __fspath__(self) -> AnyStr: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + if sys.version_info >= (3, 12): + def is_junction(self) -> bool: ... + +@final +class statvfs_result(structseq[int], tuple[int, int, int, int, int, int, int, int, int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ( + "f_bsize", + "f_frsize", + "f_blocks", + "f_bfree", + "f_bavail", + "f_files", + "f_ffree", + "f_favail", + "f_flag", + "f_namemax", + ) + + @property + def f_bsize(self) -> int: ... + @property + def f_frsize(self) -> int: ... + @property + def f_blocks(self) -> int: ... + @property + def f_bfree(self) -> int: ... + @property + def f_bavail(self) -> int: ... + @property + def f_files(self) -> int: ... + @property + def f_ffree(self) -> int: ... + @property + def f_favail(self) -> int: ... + @property + def f_flag(self) -> int: ... + @property + def f_namemax(self) -> int: ... + @property + def f_fsid(self) -> int: ... + +# ----- os function stubs ----- +def fsencode(filename: StrOrBytesPath) -> bytes: ... +def fsdecode(filename: StrOrBytesPath) -> str: ... +@overload +def fspath(path: str) -> str: ... +@overload +def fspath(path: bytes) -> bytes: ... +@overload +def fspath(path: PathLike[AnyStr]) -> AnyStr: ... +def get_exec_path(env: Mapping[str, str] | None = None) -> list[str]: ... +def getlogin() -> str: ... +def getpid() -> int: ... +def getppid() -> int: ... +def strerror(code: int, /) -> str: ... +def umask(mask: int, /) -> int: ... +@final +class uname_result(structseq[str], tuple[str, str, str, str, str]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("sysname", "nodename", "release", "version", "machine") + + @property + def sysname(self) -> str: ... + @property + def nodename(self) -> str: ... + @property + def release(self) -> str: ... + @property + def version(self) -> str: ... + @property + def machine(self) -> str: ... + +if sys.platform != "win32": + def ctermid() -> str: ... + def getegid() -> int: ... + def geteuid() -> int: ... + def getgid() -> int: ... + def getgrouplist(user: str, group: int, /) -> list[int]: ... + def getgroups() -> list[int]: ... # Unix only, behaves differently on Mac + def initgroups(username: str, gid: int, /) -> None: ... + def getpgid(pid: int) -> int: ... + def getpgrp() -> int: ... + def getpriority(which: int, who: int) -> int: ... + def setpriority(which: int, who: int, priority: int) -> None: ... + if sys.platform != "darwin": + def getresuid() -> tuple[int, int, int]: ... + def getresgid() -> tuple[int, int, int]: ... + + def getuid() -> int: ... + def setegid(egid: int, /) -> None: ... + def seteuid(euid: int, /) -> None: ... + def setgid(gid: int, /) -> None: ... + def setgroups(groups: Sequence[int], /) -> None: ... + def setpgrp() -> None: ... + def setpgid(pid: int, pgrp: int, /) -> None: ... + def setregid(rgid: int, egid: int, /) -> None: ... + if sys.platform != "darwin": + def setresgid(rgid: int, egid: int, sgid: int, /) -> None: ... + def setresuid(ruid: int, euid: int, suid: int, /) -> None: ... + + def setreuid(ruid: int, euid: int, /) -> None: ... + def getsid(pid: int, /) -> int: ... + def setsid() -> None: ... + def setuid(uid: int, /) -> None: ... + def uname() -> uname_result: ... + +@overload +def getenv(key: str) -> str | None: ... +@overload +def getenv(key: str, default: _T) -> str | _T: ... + +if sys.platform != "win32": + @overload + def getenvb(key: bytes) -> bytes | None: ... + @overload + def getenvb(key: bytes, default: _T) -> bytes | _T: ... + def putenv(name: StrOrBytesPath, value: StrOrBytesPath, /) -> None: ... + def unsetenv(name: StrOrBytesPath, /) -> None: ... + +else: + def putenv(name: str, value: str, /) -> None: ... + def unsetenv(name: str, /) -> None: ... + +_Opener: TypeAlias = Callable[[str, int], int] + +@overload +def fdopen( + fd: int, + mode: OpenTextMode = "r", + buffering: int = -1, + encoding: str | None = None, + errors: str | None = ..., + newline: str | None = ..., + closefd: bool = ..., + opener: _Opener | None = ..., +) -> TextIOWrapper: ... +@overload +def fdopen( + fd: int, + mode: OpenBinaryMode, + buffering: Literal[0], + encoding: None = None, + errors: None = None, + newline: None = None, + closefd: bool = ..., + opener: _Opener | None = ..., +) -> FileIO: ... +@overload +def fdopen( + fd: int, + mode: OpenBinaryModeUpdating, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + closefd: bool = ..., + opener: _Opener | None = ..., +) -> BufferedRandom: ... +@overload +def fdopen( + fd: int, + mode: OpenBinaryModeWriting, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + closefd: bool = ..., + opener: _Opener | None = ..., +) -> BufferedWriter: ... +@overload +def fdopen( + fd: int, + mode: OpenBinaryModeReading, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + closefd: bool = ..., + opener: _Opener | None = ..., +) -> BufferedReader: ... +@overload +def fdopen( + fd: int, + mode: OpenBinaryMode, + buffering: int = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + closefd: bool = ..., + opener: _Opener | None = ..., +) -> BinaryIO: ... +@overload +def fdopen( + fd: int, + mode: str, + buffering: int = -1, + encoding: str | None = None, + errors: str | None = ..., + newline: str | None = ..., + closefd: bool = ..., + opener: _Opener | None = ..., +) -> IO[Any]: ... +def close(fd: int) -> None: ... +def closerange(fd_low: int, fd_high: int, /) -> None: ... +def device_encoding(fd: int) -> str | None: ... +def dup(fd: int, /) -> int: ... +def dup2(fd: int, fd2: int, inheritable: bool = True) -> int: ... +def fstat(fd: int) -> stat_result: ... +def ftruncate(fd: int, length: int, /) -> None: ... +def fsync(fd: FileDescriptorLike) -> None: ... +def isatty(fd: int, /) -> bool: ... + +if sys.platform != "win32" and sys.version_info >= (3, 11): + def login_tty(fd: int, /) -> None: ... + +if sys.version_info >= (3, 11): + def lseek(fd: int, position: int, whence: int, /) -> int: ... + +else: + def lseek(fd: int, position: int, how: int, /) -> int: ... + +def open(path: StrOrBytesPath, flags: int, mode: int = 0o777, *, dir_fd: int | None = None) -> int: ... +def pipe() -> tuple[int, int]: ... +def read(fd: int, length: int, /) -> bytes: ... + +if sys.version_info >= (3, 12) or sys.platform != "win32": + def get_blocking(fd: int, /) -> bool: ... + def set_blocking(fd: int, blocking: bool, /) -> None: ... + +if sys.platform != "win32": + def fchown(fd: int, uid: int, gid: int) -> None: ... + def fpathconf(fd: int, name: str | int, /) -> int: ... + def fstatvfs(fd: int, /) -> statvfs_result: ... + def lockf(fd: int, command: int, length: int, /) -> None: ... + def openpty() -> tuple[int, int]: ... # some flavors of Unix + if sys.platform != "darwin": + def fdatasync(fd: FileDescriptorLike) -> None: ... + def pipe2(flags: int, /) -> tuple[int, int]: ... # some flavors of Unix + def posix_fallocate(fd: int, offset: int, length: int, /) -> None: ... + def posix_fadvise(fd: int, offset: int, length: int, advice: int, /) -> None: ... + + def pread(fd: int, length: int, offset: int, /) -> bytes: ... + def pwrite(fd: int, buffer: ReadableBuffer, offset: int, /) -> int: ... + # In CI, stubtest sometimes reports that these are available on MacOS, sometimes not + def preadv(fd: int, buffers: SupportsLenAndGetItem[WriteableBuffer], offset: int, flags: int = 0, /) -> int: ... + def pwritev(fd: int, buffers: SupportsLenAndGetItem[ReadableBuffer], offset: int, flags: int = 0, /) -> int: ... + if sys.platform != "darwin": + if sys.version_info >= (3, 10): + RWF_APPEND: int # docs say available on 3.7+, stubtest says otherwise + RWF_DSYNC: int + RWF_SYNC: int + RWF_HIPRI: int + RWF_NOWAIT: int + + if sys.platform == "linux": + def sendfile(out_fd: FileDescriptor, in_fd: FileDescriptor, offset: int | None, count: int) -> int: ... + else: + def sendfile( + out_fd: FileDescriptor, + in_fd: FileDescriptor, + offset: int, + count: int, + headers: Sequence[ReadableBuffer] = ..., + trailers: Sequence[ReadableBuffer] = ..., + flags: int = 0, + ) -> int: ... # FreeBSD and Mac OS X only + + def readv(fd: int, buffers: SupportsLenAndGetItem[WriteableBuffer], /) -> int: ... + def writev(fd: int, buffers: SupportsLenAndGetItem[ReadableBuffer], /) -> int: ... + +if sys.version_info >= (3, 14): + def readinto(fd: int, buffer: ReadableBuffer, /) -> int: ... + +@final +class terminal_size(structseq[int], tuple[int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("columns", "lines") + + @property + def columns(self) -> int: ... + @property + def lines(self) -> int: ... + +def get_terminal_size(fd: int = ..., /) -> terminal_size: ... +def get_inheritable(fd: int, /) -> bool: ... +def set_inheritable(fd: int, inheritable: bool, /) -> None: ... + +if sys.platform == "win32": + def get_handle_inheritable(handle: int, /) -> bool: ... + def set_handle_inheritable(handle: int, inheritable: bool, /) -> None: ... + +if sys.platform != "win32": + # Unix only + def tcgetpgrp(fd: int, /) -> int: ... + def tcsetpgrp(fd: int, pgid: int, /) -> None: ... + def ttyname(fd: int, /) -> str: ... + +def write(fd: int, data: ReadableBuffer, /) -> int: ... +def access( + path: FileDescriptorOrPath, mode: int, *, dir_fd: int | None = None, effective_ids: bool = False, follow_symlinks: bool = True +) -> bool: ... +def chdir(path: FileDescriptorOrPath) -> None: ... + +if sys.platform != "win32": + def fchdir(fd: FileDescriptorLike) -> None: ... + +def getcwd() -> str: ... +def getcwdb() -> bytes: ... +def chmod(path: FileDescriptorOrPath, mode: int, *, dir_fd: int | None = None, follow_symlinks: bool = ...) -> None: ... + +if sys.platform != "win32" and sys.platform != "linux": + def chflags(path: StrOrBytesPath, flags: int, follow_symlinks: bool = True) -> None: ... # some flavors of Unix + def lchflags(path: StrOrBytesPath, flags: int) -> None: ... + +if sys.platform != "win32": + def chroot(path: StrOrBytesPath) -> None: ... + def chown( + path: FileDescriptorOrPath, uid: int, gid: int, *, dir_fd: int | None = None, follow_symlinks: bool = True + ) -> None: ... + def lchown(path: StrOrBytesPath, uid: int, gid: int) -> None: ... + +def link( + src: StrOrBytesPath, + dst: StrOrBytesPath, + *, + src_dir_fd: int | None = None, + dst_dir_fd: int | None = None, + follow_symlinks: bool = True, +) -> None: ... +def lstat(path: StrOrBytesPath, *, dir_fd: int | None = None) -> stat_result: ... +def mkdir(path: StrOrBytesPath, mode: int = 0o777, *, dir_fd: int | None = None) -> None: ... + +if sys.platform != "win32": + def mkfifo(path: StrOrBytesPath, mode: int = 0o666, *, dir_fd: int | None = None) -> None: ... # Unix only + +def makedirs(name: StrOrBytesPath, mode: int = 0o777, exist_ok: bool = False) -> None: ... + +if sys.platform != "win32": + def mknod(path: StrOrBytesPath, mode: int = 0o600, device: int = 0, *, dir_fd: int | None = None) -> None: ... + def major(device: int, /) -> int: ... + def minor(device: int, /) -> int: ... + def makedev(major: int, minor: int, /) -> int: ... + def pathconf(path: FileDescriptorOrPath, name: str | int) -> int: ... # Unix only + +def readlink(path: GenericPath[AnyStr], *, dir_fd: int | None = None) -> AnyStr: ... +def remove(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... +def removedirs(name: StrOrBytesPath) -> None: ... +def rename(src: StrOrBytesPath, dst: StrOrBytesPath, *, src_dir_fd: int | None = None, dst_dir_fd: int | None = None) -> None: ... +def renames(old: StrOrBytesPath, new: StrOrBytesPath) -> None: ... +def replace( + src: StrOrBytesPath, dst: StrOrBytesPath, *, src_dir_fd: int | None = None, dst_dir_fd: int | None = None +) -> None: ... +def rmdir(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... +@final +class _ScandirIterator(Generic[AnyStr]): + def __del__(self) -> None: ... + def __iter__(self) -> Self: ... + def __next__(self) -> DirEntry[AnyStr]: ... + def __enter__(self) -> Self: ... + def __exit__(self, *args: Unused) -> None: ... + def close(self) -> None: ... + +@overload +def scandir(path: None = None) -> _ScandirIterator[str]: ... +@overload +def scandir(path: int) -> _ScandirIterator[str]: ... +@overload +def scandir(path: GenericPath[AnyStr]) -> _ScandirIterator[AnyStr]: ... +def stat(path: FileDescriptorOrPath, *, dir_fd: int | None = None, follow_symlinks: bool = True) -> stat_result: ... + +if sys.platform != "win32": + def statvfs(path: FileDescriptorOrPath) -> statvfs_result: ... # Unix only + +def symlink( + src: StrOrBytesPath, dst: StrOrBytesPath, target_is_directory: bool = False, *, dir_fd: int | None = None +) -> None: ... + +if sys.platform != "win32": + def sync() -> None: ... # Unix only + +def truncate(path: FileDescriptorOrPath, length: int) -> None: ... # Unix only up to version 3.4 +def unlink(path: StrOrBytesPath, *, dir_fd: int | None = None) -> None: ... +def utime( + path: FileDescriptorOrPath, + times: tuple[int, int] | tuple[float, float] | None = None, + *, + ns: tuple[int, int] = ..., + dir_fd: int | None = None, + follow_symlinks: bool = True, +) -> None: ... + +_OnError: TypeAlias = Callable[[OSError], object] + +def walk( + top: GenericPath[AnyStr], topdown: bool = True, onerror: _OnError | None = None, followlinks: bool = False +) -> Iterator[tuple[AnyStr, list[AnyStr], list[AnyStr]]]: ... + +if sys.platform != "win32": + @overload + def fwalk( + top: StrPath = ".", + topdown: bool = True, + onerror: _OnError | None = None, + *, + follow_symlinks: bool = False, + dir_fd: int | None = None, + ) -> Iterator[tuple[str, list[str], list[str], int]]: ... + @overload + def fwalk( + top: BytesPath, + topdown: bool = True, + onerror: _OnError | None = None, + *, + follow_symlinks: bool = False, + dir_fd: int | None = None, + ) -> Iterator[tuple[bytes, list[bytes], list[bytes], int]]: ... + if sys.platform == "linux": + def getxattr(path: FileDescriptorOrPath, attribute: StrOrBytesPath, *, follow_symlinks: bool = True) -> bytes: ... + def listxattr(path: FileDescriptorOrPath | None = None, *, follow_symlinks: bool = True) -> list[str]: ... + def removexattr(path: FileDescriptorOrPath, attribute: StrOrBytesPath, *, follow_symlinks: bool = True) -> None: ... + def setxattr( + path: FileDescriptorOrPath, + attribute: StrOrBytesPath, + value: ReadableBuffer, + flags: int = 0, + *, + follow_symlinks: bool = True, + ) -> None: ... + +def abort() -> NoReturn: ... + +# These are defined as execl(file, *args) but the first *arg is mandatory. +def execl(file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]]]]) -> NoReturn: ... +def execlp(file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]]]]) -> NoReturn: ... + +# These are: execle(file, *args, env) but env is pulled from the last element of the args. +def execle( + file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]], _ExecEnv]] +) -> NoReturn: ... +def execlpe( + file: StrOrBytesPath, *args: Unpack[tuple[StrOrBytesPath, Unpack[tuple[StrOrBytesPath, ...]], _ExecEnv]] +) -> NoReturn: ... + +# The docs say `args: tuple or list of strings` +# The implementation enforces tuple or list so we can't use Sequence. +# Not separating out PathLike[str] and PathLike[bytes] here because it doesn't make much difference +# in practice, and doing so would explode the number of combinations in this already long union. +# All these combinations are necessary due to list being invariant. +_ExecVArgs: TypeAlias = ( + tuple[StrOrBytesPath, ...] + | list[bytes] + | list[str] + | list[PathLike[Any]] + | list[bytes | str] + | list[bytes | PathLike[Any]] + | list[str | PathLike[Any]] + | list[bytes | str | PathLike[Any]] +) +# Depending on the OS, the keys and values are passed either to +# PyUnicode_FSDecoder (which accepts str | ReadableBuffer) or to +# PyUnicode_FSConverter (which accepts StrOrBytesPath). For simplicity, +# we limit to str | bytes. +_ExecEnv: TypeAlias = Mapping[bytes, bytes | str] | Mapping[str, bytes | str] + +def execv(path: StrOrBytesPath, argv: _ExecVArgs, /) -> NoReturn: ... +def execve(path: FileDescriptorOrPath, argv: _ExecVArgs, env: _ExecEnv) -> NoReturn: ... +def execvp(file: StrOrBytesPath, args: _ExecVArgs) -> NoReturn: ... +def execvpe(file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> NoReturn: ... +def _exit(status: int) -> NoReturn: ... +def kill(pid: int, signal: int, /) -> None: ... + +if sys.platform != "win32": + # Unix only + def fork() -> int: ... + def forkpty() -> tuple[int, int]: ... # some flavors of Unix + def killpg(pgid: int, signal: int, /) -> None: ... + def nice(increment: int, /) -> int: ... + if sys.platform != "darwin" and sys.platform != "linux": + def plock(op: int, /) -> None: ... + +class _wrap_close: + def __init__(self, stream: TextIOWrapper, proc: Popen[str]) -> None: ... + def close(self) -> int | None: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + def __iter__(self) -> Iterator[str]: ... + # Methods below here don't exist directly on the _wrap_close object, but + # are copied from the wrapped TextIOWrapper object via __getattr__. + # The full set of TextIOWrapper methods are technically available this way, + # but undocumented. Only a subset are currently included here. + def read(self, size: int | None = -1, /) -> str: ... + def readable(self) -> bool: ... + def readline(self, size: int = -1, /) -> str: ... + def readlines(self, hint: int = -1, /) -> list[str]: ... + def writable(self) -> bool: ... + def write(self, s: str, /) -> int: ... + def writelines(self, lines: Iterable[str], /) -> None: ... + +def popen(cmd: str, mode: str = "r", buffering: int = -1) -> _wrap_close: ... +def spawnl(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: StrOrBytesPath) -> int: ... +def spawnle(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: Any) -> int: ... # Imprecise sig + +if sys.platform != "win32": + def spawnv(mode: int, file: StrOrBytesPath, args: _ExecVArgs) -> int: ... + def spawnve(mode: int, file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> int: ... + +else: + def spawnv(mode: int, path: StrOrBytesPath, argv: _ExecVArgs, /) -> int: ... + def spawnve(mode: int, path: StrOrBytesPath, argv: _ExecVArgs, env: _ExecEnv, /) -> int: ... + +def system(command: StrOrBytesPath) -> int: ... +@final +class times_result(structseq[float], tuple[float, float, float, float, float]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("user", "system", "children_user", "children_system", "elapsed") + + @property + def user(self) -> float: ... + @property + def system(self) -> float: ... + @property + def children_user(self) -> float: ... + @property + def children_system(self) -> float: ... + @property + def elapsed(self) -> float: ... + +def times() -> times_result: ... +def waitpid(pid: int, options: int, /) -> tuple[int, int]: ... + +if sys.platform == "win32": + if sys.version_info >= (3, 10): + def startfile( + filepath: StrOrBytesPath, + operation: str = ..., + arguments: str = "", + cwd: StrOrBytesPath | None = None, + show_cmd: int = 1, + ) -> None: ... + else: + def startfile(filepath: StrOrBytesPath, operation: str = ...) -> None: ... + +else: + def spawnlp(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: StrOrBytesPath) -> int: ... + def spawnlpe(mode: int, file: StrOrBytesPath, arg0: StrOrBytesPath, *args: Any) -> int: ... # Imprecise signature + def spawnvp(mode: int, file: StrOrBytesPath, args: _ExecVArgs) -> int: ... + def spawnvpe(mode: int, file: StrOrBytesPath, args: _ExecVArgs, env: _ExecEnv) -> int: ... + def wait() -> tuple[int, int]: ... # Unix only + # Added to MacOS in 3.13 + if sys.platform != "darwin" or sys.version_info >= (3, 13): + @final + class waitid_result(structseq[int], tuple[int, int, int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("si_pid", "si_uid", "si_signo", "si_status", "si_code") + + @property + def si_pid(self) -> int: ... + @property + def si_uid(self) -> int: ... + @property + def si_signo(self) -> int: ... + @property + def si_status(self) -> int: ... + @property + def si_code(self) -> int: ... + + def waitid(idtype: int, ident: int, options: int, /) -> waitid_result | None: ... + + from resource import struct_rusage + + def wait3(options: int) -> tuple[int, int, struct_rusage]: ... + def wait4(pid: int, options: int) -> tuple[int, int, struct_rusage]: ... + def WCOREDUMP(status: int, /) -> bool: ... + def WIFCONTINUED(status: int) -> bool: ... + def WIFSTOPPED(status: int) -> bool: ... + def WIFSIGNALED(status: int) -> bool: ... + def WIFEXITED(status: int) -> bool: ... + def WEXITSTATUS(status: int) -> int: ... + def WSTOPSIG(status: int) -> int: ... + def WTERMSIG(status: int) -> int: ... + def posix_spawn( + path: StrOrBytesPath, + argv: _ExecVArgs, + env: _ExecEnv, + /, + *, + file_actions: Sequence[tuple[Any, ...]] | None = ..., + setpgroup: int | None = ..., + resetids: bool = ..., + setsid: bool = ..., + setsigmask: Iterable[int] = ..., + setsigdef: Iterable[int] = ..., + scheduler: tuple[Any, sched_param] | None = ..., + ) -> int: ... + def posix_spawnp( + path: StrOrBytesPath, + argv: _ExecVArgs, + env: _ExecEnv, + /, + *, + file_actions: Sequence[tuple[Any, ...]] | None = ..., + setpgroup: int | None = ..., + resetids: bool = ..., + setsid: bool = ..., + setsigmask: Iterable[int] = ..., + setsigdef: Iterable[int] = ..., + scheduler: tuple[Any, sched_param] | None = ..., + ) -> int: ... + POSIX_SPAWN_OPEN: int + POSIX_SPAWN_CLOSE: int + POSIX_SPAWN_DUP2: int + +if sys.platform != "win32": + @final + class sched_param(structseq[int], tuple[int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("sched_priority",) + + def __new__(cls, sched_priority: int) -> Self: ... + @property + def sched_priority(self) -> int: ... + + def sched_get_priority_min(policy: int) -> int: ... # some flavors of Unix + def sched_get_priority_max(policy: int) -> int: ... # some flavors of Unix + def sched_yield() -> None: ... # some flavors of Unix + if sys.platform != "darwin": + def sched_setscheduler(pid: int, policy: int, param: sched_param, /) -> None: ... # some flavors of Unix + def sched_getscheduler(pid: int, /) -> int: ... # some flavors of Unix + def sched_rr_get_interval(pid: int, /) -> float: ... # some flavors of Unix + def sched_setparam(pid: int, param: sched_param, /) -> None: ... # some flavors of Unix + def sched_getparam(pid: int, /) -> sched_param: ... # some flavors of Unix + def sched_setaffinity(pid: int, mask: Iterable[int], /) -> None: ... # some flavors of Unix + def sched_getaffinity(pid: int, /) -> set[int]: ... # some flavors of Unix + +def cpu_count() -> int | None: ... + +if sys.version_info >= (3, 13): + # Documented to return `int | None`, but falls back to `len(sched_getaffinity(0))` when + # available. See https://github.com/python/cpython/blob/417c130/Lib/os.py#L1175-L1186. + if sys.platform != "win32" and sys.platform != "darwin": + def process_cpu_count() -> int: ... + else: + def process_cpu_count() -> int | None: ... + +if sys.platform != "win32": + # Unix only + def confstr(name: str | int, /) -> str | None: ... + def getloadavg() -> tuple[float, float, float]: ... + def sysconf(name: str | int, /) -> int: ... + +if sys.platform == "linux": + def getrandom(size: int, flags: int = 0) -> bytes: ... + +def urandom(size: int, /) -> bytes: ... + +if sys.platform != "win32": + def register_at_fork( + *, + before: Callable[..., Any] | None = ..., + after_in_parent: Callable[..., Any] | None = ..., + after_in_child: Callable[..., Any] | None = ..., + ) -> None: ... + +if sys.platform == "win32": + class _AddedDllDirectory: + path: str | None + def __init__(self, path: str | None, cookie: _T, remove_dll_directory: Callable[[_T], object]) -> None: ... + def close(self) -> None: ... + def __enter__(self) -> Self: ... + def __exit__(self, *args: Unused) -> None: ... + + def add_dll_directory(path: str) -> _AddedDllDirectory: ... + +if sys.platform == "linux": + MFD_CLOEXEC: int + MFD_ALLOW_SEALING: int + MFD_HUGETLB: int + MFD_HUGE_SHIFT: int + MFD_HUGE_MASK: int + MFD_HUGE_64KB: int + MFD_HUGE_512KB: int + MFD_HUGE_1MB: int + MFD_HUGE_2MB: int + MFD_HUGE_8MB: int + MFD_HUGE_16MB: int + MFD_HUGE_32MB: int + MFD_HUGE_256MB: int + MFD_HUGE_512MB: int + MFD_HUGE_1GB: int + MFD_HUGE_2GB: int + MFD_HUGE_16GB: int + def memfd_create(name: str, flags: int = ...) -> int: ... + def copy_file_range(src: int, dst: int, count: int, offset_src: int | None = ..., offset_dst: int | None = ...) -> int: ... + +def waitstatus_to_exitcode(status: int) -> int: ... + +if sys.platform == "linux": + def pidfd_open(pid: int, flags: int = ...) -> int: ... + +if sys.version_info >= (3, 12) and sys.platform == "linux": + PIDFD_NONBLOCK: Final = 2048 + +if sys.version_info >= (3, 12) and sys.platform == "win32": + def listdrives() -> list[str]: ... + def listmounts(volume: str) -> list[str]: ... + def listvolumes() -> list[str]: ... + +if sys.version_info >= (3, 10) and sys.platform == "linux": + EFD_CLOEXEC: int + EFD_NONBLOCK: int + EFD_SEMAPHORE: int + SPLICE_F_MORE: int + SPLICE_F_MOVE: int + SPLICE_F_NONBLOCK: int + def eventfd(initval: int, flags: int = 524288) -> FileDescriptor: ... + def eventfd_read(fd: FileDescriptor) -> int: ... + def eventfd_write(fd: FileDescriptor, value: int) -> None: ... + def splice( + src: FileDescriptor, + dst: FileDescriptor, + count: int, + offset_src: int | None = ..., + offset_dst: int | None = ..., + flags: int = 0, + ) -> int: ... + +if sys.version_info >= (3, 12) and sys.platform == "linux": + CLONE_FILES: int + CLONE_FS: int + CLONE_NEWCGROUP: int # Linux 4.6+ + CLONE_NEWIPC: int # Linux 2.6.19+ + CLONE_NEWNET: int # Linux 2.6.24+ + CLONE_NEWNS: int + CLONE_NEWPID: int # Linux 3.8+ + CLONE_NEWTIME: int # Linux 5.6+ + CLONE_NEWUSER: int # Linux 3.8+ + CLONE_NEWUTS: int # Linux 2.6.19+ + CLONE_SIGHAND: int + CLONE_SYSVSEM: int # Linux 2.6.26+ + CLONE_THREAD: int + CLONE_VM: int + def unshare(flags: int) -> None: ... + def setns(fd: FileDescriptorLike, nstype: int = 0) -> None: ... + +if sys.version_info >= (3, 13) and sys.platform != "win32": + def posix_openpt(oflag: int, /) -> int: ... + def grantpt(fd: FileDescriptorLike, /) -> None: ... + def unlockpt(fd: FileDescriptorLike, /) -> None: ... + def ptsname(fd: FileDescriptorLike, /) -> str: ... + +if sys.version_info >= (3, 13) and sys.platform == "linux": + TFD_TIMER_ABSTIME: Final = 1 + TFD_TIMER_CANCEL_ON_SET: Final = 2 + TFD_NONBLOCK: Final[int] + TFD_CLOEXEC: Final[int] + POSIX_SPAWN_CLOSEFROM: Final[int] + + def timerfd_create(clockid: int, /, *, flags: int = 0) -> int: ... + def timerfd_settime( + fd: FileDescriptor, /, *, flags: int = 0, initial: float = 0.0, interval: float = 0.0 + ) -> tuple[float, float]: ... + def timerfd_settime_ns(fd: FileDescriptor, /, *, flags: int = 0, initial: int = 0, interval: int = 0) -> tuple[int, int]: ... + def timerfd_gettime(fd: FileDescriptor, /) -> tuple[float, float]: ... + def timerfd_gettime_ns(fd: FileDescriptor, /) -> tuple[int, int]: ... + +if sys.version_info >= (3, 13) or sys.platform != "win32": + # Added to Windows in 3.13. + def fchmod(fd: int, mode: int) -> None: ... + +if sys.platform != "linux": + if sys.version_info >= (3, 13) or sys.platform != "win32": + # Added to Windows in 3.13. + def lchmod(path: StrOrBytesPath, mode: int) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/os/path.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/os/path.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/os/path.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/os/path.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ossaudiodev.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ossaudiodev.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ossaudiodev.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ossaudiodev.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/parser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/parser.pyi new file mode 100644 index 0000000000000..26140c76248ae --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/parser.pyi @@ -0,0 +1,25 @@ +from _typeshed import StrOrBytesPath +from collections.abc import Sequence +from types import CodeType +from typing import Any, ClassVar, final + +def expr(source: str) -> STType: ... +def suite(source: str) -> STType: ... +def sequence2st(sequence: Sequence[Any]) -> STType: ... +def tuple2st(sequence: Sequence[Any]) -> STType: ... +def st2list(st: STType, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ... +def st2tuple(st: STType, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ... +def compilest(st: STType, filename: StrOrBytesPath = ...) -> CodeType: ... +def isexpr(st: STType) -> bool: ... +def issuite(st: STType) -> bool: ... + +class ParserError(Exception): ... + +@final +class STType: + __hash__: ClassVar[None] # type: ignore[assignment] + def compile(self, filename: StrOrBytesPath = ...) -> CodeType: ... + def isexpr(self) -> bool: ... + def issuite(self) -> bool: ... + def tolist(self, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ... + def totuple(self, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/__init__.pyi new file mode 100644 index 0000000000000..b84fc69313a15 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/__init__.pyi @@ -0,0 +1,307 @@ +import sys +import types +from _typeshed import ( + OpenBinaryMode, + OpenBinaryModeReading, + OpenBinaryModeUpdating, + OpenBinaryModeWriting, + OpenTextMode, + ReadableBuffer, + StrOrBytesPath, + StrPath, + Unused, +) +from collections.abc import Callable, Generator, Iterator, Sequence +from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper +from os import PathLike, stat_result +from types import GenericAlias, TracebackType +from typing import IO, Any, BinaryIO, ClassVar, Literal, TypeVar, overload +from typing_extensions import Never, Self, deprecated + +_PathT = TypeVar("_PathT", bound=PurePath) + +__all__ = ["PurePath", "PurePosixPath", "PureWindowsPath", "Path", "PosixPath", "WindowsPath"] + +if sys.version_info >= (3, 14): + from pathlib.types import PathInfo + +if sys.version_info >= (3, 13): + __all__ += ["UnsupportedOperation"] + +class PurePath(PathLike[str]): + if sys.version_info >= (3, 13): + parser: ClassVar[types.ModuleType] + def full_match(self, pattern: StrPath, *, case_sensitive: bool | None = None) -> bool: ... + + @property + def parts(self) -> tuple[str, ...]: ... + @property + def drive(self) -> str: ... + @property + def root(self) -> str: ... + @property + def anchor(self) -> str: ... + @property + def name(self) -> str: ... + @property + def suffix(self) -> str: ... + @property + def suffixes(self) -> list[str]: ... + @property + def stem(self) -> str: ... + if sys.version_info >= (3, 12): + def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... + def __init__(self, *args: StrPath) -> None: ... # pyright: ignore[reportInconsistentConstructor] + else: + def __new__(cls, *args: StrPath) -> Self: ... + + def __hash__(self) -> int: ... + def __fspath__(self) -> str: ... + def __lt__(self, other: PurePath) -> bool: ... + def __le__(self, other: PurePath) -> bool: ... + def __gt__(self, other: PurePath) -> bool: ... + def __ge__(self, other: PurePath) -> bool: ... + def __truediv__(self, key: StrPath) -> Self: ... + def __rtruediv__(self, key: StrPath) -> Self: ... + def __bytes__(self) -> bytes: ... + def as_posix(self) -> str: ... + def as_uri(self) -> str: ... + def is_absolute(self) -> bool: ... + def is_reserved(self) -> bool: ... + if sys.version_info >= (3, 14): + def is_relative_to(self, other: StrPath) -> bool: ... + elif sys.version_info >= (3, 12): + def is_relative_to(self, other: StrPath, /, *_deprecated: StrPath) -> bool: ... + else: + def is_relative_to(self, *other: StrPath) -> bool: ... + + if sys.version_info >= (3, 12): + def match(self, path_pattern: str, *, case_sensitive: bool | None = None) -> bool: ... + else: + def match(self, path_pattern: str) -> bool: ... + + if sys.version_info >= (3, 14): + def relative_to(self, other: StrPath, *, walk_up: bool = False) -> Self: ... + elif sys.version_info >= (3, 12): + def relative_to(self, other: StrPath, /, *_deprecated: StrPath, walk_up: bool = False) -> Self: ... + else: + def relative_to(self, *other: StrPath) -> Self: ... + + def with_name(self, name: str) -> Self: ... + def with_stem(self, stem: str) -> Self: ... + def with_suffix(self, suffix: str) -> Self: ... + def joinpath(self, *other: StrPath) -> Self: ... + @property + def parents(self) -> Sequence[Self]: ... + @property + def parent(self) -> Self: ... + if sys.version_info < (3, 11): + def __class_getitem__(cls, type: Any) -> GenericAlias: ... + + if sys.version_info >= (3, 12): + def with_segments(self, *args: StrPath) -> Self: ... + +class PurePosixPath(PurePath): ... +class PureWindowsPath(PurePath): ... + +class Path(PurePath): + if sys.version_info >= (3, 12): + def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... # pyright: ignore[reportInconsistentConstructor] + else: + def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ... + + @classmethod + def cwd(cls) -> Self: ... + if sys.version_info >= (3, 10): + def stat(self, *, follow_symlinks: bool = True) -> stat_result: ... + def chmod(self, mode: int, *, follow_symlinks: bool = True) -> None: ... + else: + def stat(self) -> stat_result: ... + def chmod(self, mode: int) -> None: ... + + if sys.version_info >= (3, 13): + @classmethod + def from_uri(cls, uri: str) -> Self: ... + def is_dir(self, *, follow_symlinks: bool = True) -> bool: ... + def is_file(self, *, follow_symlinks: bool = True) -> bool: ... + def read_text(self, encoding: str | None = None, errors: str | None = None, newline: str | None = None) -> str: ... + else: + def __enter__(self) -> Self: ... + def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... + def is_dir(self) -> bool: ... + def is_file(self) -> bool: ... + def read_text(self, encoding: str | None = None, errors: str | None = None) -> str: ... + + if sys.version_info >= (3, 13): + def glob(self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = False) -> Iterator[Self]: ... + def rglob( + self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = False + ) -> Iterator[Self]: ... + elif sys.version_info >= (3, 12): + def glob(self, pattern: str, *, case_sensitive: bool | None = None) -> Generator[Self, None, None]: ... + def rglob(self, pattern: str, *, case_sensitive: bool | None = None) -> Generator[Self, None, None]: ... + else: + def glob(self, pattern: str) -> Generator[Self, None, None]: ... + def rglob(self, pattern: str) -> Generator[Self, None, None]: ... + + if sys.version_info >= (3, 12): + def exists(self, *, follow_symlinks: bool = True) -> bool: ... + else: + def exists(self) -> bool: ... + + def is_symlink(self) -> bool: ... + def is_socket(self) -> bool: ... + def is_fifo(self) -> bool: ... + def is_block_device(self) -> bool: ... + def is_char_device(self) -> bool: ... + if sys.version_info >= (3, 12): + def is_junction(self) -> bool: ... + + def iterdir(self) -> Generator[Self, None, None]: ... + def lchmod(self, mode: int) -> None: ... + def lstat(self) -> stat_result: ... + def mkdir(self, mode: int = 0o777, parents: bool = False, exist_ok: bool = False) -> None: ... + + if sys.version_info >= (3, 14): + + @property + def info(self) -> PathInfo: ... + @overload + def move_into(self, target_dir: _PathT) -> _PathT: ... # type: ignore[overload-overlap] + @overload + def move_into(self, target_dir: StrPath) -> Self: ... # type: ignore[overload-overlap] + @overload + def move(self, target: _PathT) -> _PathT: ... # type: ignore[overload-overlap] + @overload + def move(self, target: StrPath) -> Self: ... # type: ignore[overload-overlap] + @overload + def copy_into(self, target_dir: _PathT, *, follow_symlinks: bool = True, preserve_metadata: bool = False) -> _PathT: ... # type: ignore[overload-overlap] + @overload + def copy_into(self, target_dir: StrPath, *, follow_symlinks: bool = True, preserve_metadata: bool = False) -> Self: ... # type: ignore[overload-overlap] + @overload + def copy(self, target: _PathT, *, follow_symlinks: bool = True, preserve_metadata: bool = False) -> _PathT: ... # type: ignore[overload-overlap] + @overload + def copy(self, target: StrPath, *, follow_symlinks: bool = True, preserve_metadata: bool = False) -> Self: ... # type: ignore[overload-overlap] + + # Adapted from builtins.open + # Text mode: always returns a TextIOWrapper + # The Traversable .open in stdlib/importlib/abc.pyi should be kept in sync with this. + @overload + def open( + self, + mode: OpenTextMode = "r", + buffering: int = -1, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> TextIOWrapper: ... + # Unbuffered binary mode: returns a FileIO + @overload + def open( + self, mode: OpenBinaryMode, buffering: Literal[0], encoding: None = None, errors: None = None, newline: None = None + ) -> FileIO: ... + # Buffering is on: return BufferedRandom, BufferedReader, or BufferedWriter + @overload + def open( + self, + mode: OpenBinaryModeUpdating, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + ) -> BufferedRandom: ... + @overload + def open( + self, + mode: OpenBinaryModeWriting, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + ) -> BufferedWriter: ... + @overload + def open( + self, + mode: OpenBinaryModeReading, + buffering: Literal[-1, 1] = -1, + encoding: None = None, + errors: None = None, + newline: None = None, + ) -> BufferedReader: ... + # Buffering cannot be determined: fall back to BinaryIO + @overload + def open( + self, mode: OpenBinaryMode, buffering: int = -1, encoding: None = None, errors: None = None, newline: None = None + ) -> BinaryIO: ... + # Fallback if mode is not specified + @overload + def open( + self, mode: str, buffering: int = -1, encoding: str | None = None, errors: str | None = None, newline: str | None = None + ) -> IO[Any]: ... + + # These methods do "exist" on Windows on <3.13, but they always raise NotImplementedError. + if sys.platform == "win32": + if sys.version_info < (3, 13): + def owner(self: Never) -> str: ... # type: ignore[misc] + def group(self: Never) -> str: ... # type: ignore[misc] + else: + if sys.version_info >= (3, 13): + def owner(self, *, follow_symlinks: bool = True) -> str: ... + def group(self, *, follow_symlinks: bool = True) -> str: ... + else: + def owner(self) -> str: ... + def group(self) -> str: ... + + # This method does "exist" on Windows on <3.12, but always raises NotImplementedError + # On py312+, it works properly on Windows, as with all other platforms + if sys.platform == "win32" and sys.version_info < (3, 12): + def is_mount(self: Never) -> bool: ... # type: ignore[misc] + else: + def is_mount(self) -> bool: ... + + def readlink(self) -> Self: ... + + if sys.version_info >= (3, 10): + def rename(self, target: StrPath) -> Self: ... + def replace(self, target: StrPath) -> Self: ... + else: + def rename(self, target: str | PurePath) -> Self: ... + def replace(self, target: str | PurePath) -> Self: ... + + def resolve(self, strict: bool = False) -> Self: ... + def rmdir(self) -> None: ... + def symlink_to(self, target: StrOrBytesPath, target_is_directory: bool = False) -> None: ... + if sys.version_info >= (3, 10): + def hardlink_to(self, target: StrOrBytesPath) -> None: ... + + def touch(self, mode: int = 0o666, exist_ok: bool = True) -> None: ... + def unlink(self, missing_ok: bool = False) -> None: ... + @classmethod + def home(cls) -> Self: ... + def absolute(self) -> Self: ... + def expanduser(self) -> Self: ... + def read_bytes(self) -> bytes: ... + def samefile(self, other_path: StrPath) -> bool: ... + def write_bytes(self, data: ReadableBuffer) -> int: ... + if sys.version_info >= (3, 10): + def write_text( + self, data: str, encoding: str | None = None, errors: str | None = None, newline: str | None = None + ) -> int: ... + else: + def write_text(self, data: str, encoding: str | None = None, errors: str | None = None) -> int: ... + if sys.version_info < (3, 12): + if sys.version_info >= (3, 10): + @deprecated("Deprecated as of Python 3.10 and removed in Python 3.12. Use hardlink_to() instead.") + def link_to(self, target: StrOrBytesPath) -> None: ... + else: + def link_to(self, target: StrOrBytesPath) -> None: ... + if sys.version_info >= (3, 12): + def walk( + self, top_down: bool = ..., on_error: Callable[[OSError], object] | None = ..., follow_symlinks: bool = ... + ) -> Iterator[tuple[Self, list[str], list[str]]]: ... + +class PosixPath(Path, PurePosixPath): ... +class WindowsPath(Path, PureWindowsPath): ... + +if sys.version_info >= (3, 13): + class UnsupportedOperation(NotImplementedError): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/types.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/types.pyi new file mode 100644 index 0000000000000..9f9a650846deb --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pathlib/types.pyi @@ -0,0 +1,8 @@ +from typing import Protocol, runtime_checkable + +@runtime_checkable +class PathInfo(Protocol): + def exists(self, *, follow_symlinks: bool = True) -> bool: ... + def is_dir(self, *, follow_symlinks: bool = True) -> bool: ... + def is_file(self, *, follow_symlinks: bool = True) -> bool: ... + def is_symlink(self) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pdb.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pdb.pyi similarity index 76% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pdb.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pdb.pyi index 61e8b7176e849..ad69fcab16de0 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pdb.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pdb.pyi @@ -1,17 +1,21 @@ import signal import sys -from bdb import Bdb +from bdb import Bdb, _Backend from cmd import Cmd from collections.abc import Callable, Iterable, Mapping, Sequence from inspect import _SourceObjectType +from linecache import _ModuleGlobals from types import CodeType, FrameType, TracebackType -from typing import IO, Any, ClassVar, Final, TypeVar -from typing_extensions import ParamSpec, Self +from typing import IO, Any, ClassVar, Final, Literal, TypeVar +from typing_extensions import ParamSpec, Self, TypeAlias __all__ = ["run", "pm", "Pdb", "runeval", "runctx", "runcall", "set_trace", "post_mortem", "help"] +if sys.version_info >= (3, 14): + __all__ += ["set_default_backend", "get_default_backend"] _T = TypeVar("_T") _P = ParamSpec("_P") +_Mode: TypeAlias = Literal["inline", "cli"] line_prefix: str # undocumented @@ -21,7 +25,16 @@ def run(statement: str, globals: dict[str, Any] | None = None, locals: Mapping[s def runeval(expression: str, globals: dict[str, Any] | None = None, locals: Mapping[str, Any] | None = None) -> Any: ... def runctx(statement: str, globals: dict[str, Any], locals: Mapping[str, Any]) -> None: ... def runcall(func: Callable[_P, _T], *args: _P.args, **kwds: _P.kwargs) -> _T | None: ... -def set_trace(*, header: str | None = None) -> None: ... + +if sys.version_info >= (3, 14): + def set_default_backend(backend: _Backend) -> None: ... + def get_default_backend() -> _Backend: ... + def set_trace(*, header: str | None = None, commands: Iterable[str] | None = None) -> None: ... + async def set_trace_async(*, header: str | None = None, commands: Iterable[str] | None = None) -> None: ... + +else: + def set_trace(*, header: str | None = None) -> None: ... + def post_mortem(t: TracebackType | None = None) -> None: ... def pm() -> None: ... @@ -47,15 +60,35 @@ class Pdb(Bdb, Cmd): curindex: int curframe: FrameType | None curframe_locals: Mapping[str, Any] - def __init__( - self, - completekey: str = "tab", - stdin: IO[str] | None = None, - stdout: IO[str] | None = None, - skip: Iterable[str] | None = None, - nosigint: bool = False, - readrc: bool = True, - ) -> None: ... + if sys.version_info >= (3, 14): + mode: _Mode | None + colorize: bool + def __init__( + self, + completekey: str = "tab", + stdin: IO[str] | None = None, + stdout: IO[str] | None = None, + skip: Iterable[str] | None = None, + nosigint: bool = False, + readrc: bool = True, + mode: _Mode | None = None, + backend: _Backend | None = None, + colorize: bool = False, + ) -> None: ... + else: + def __init__( + self, + completekey: str = "tab", + stdin: IO[str] | None = None, + stdout: IO[str] | None = None, + skip: Iterable[str] | None = None, + nosigint: bool = False, + readrc: bool = True, + ) -> None: ... + if sys.version_info >= (3, 14): + def set_trace(self, frame: FrameType | None = None, *, commands: Iterable[str] | None = None) -> None: ... + async def set_trace_async(self, frame: FrameType | None = None, *, commands: Iterable[str] | None = None) -> None: ... + def forget(self) -> None: ... def setup(self, f: FrameType | None, tb: TracebackType | None) -> None: ... if sys.version_info < (3, 11): @@ -75,14 +108,25 @@ class Pdb(Bdb, Cmd): def handle_command_def(self, line: str) -> bool: ... def defaultFile(self) -> str: ... def lineinfo(self, identifier: str) -> tuple[None, None, None] | tuple[str, str, int]: ... - def checkline(self, filename: str, lineno: int) -> int: ... + if sys.version_info >= (3, 14): + def checkline(self, filename: str, lineno: int, module_globals: _ModuleGlobals | None = None) -> int: ... + else: + def checkline(self, filename: str, lineno: int) -> int: ... + def _getval(self, arg: str) -> object: ... - def print_stack_trace(self) -> None: ... + if sys.version_info >= (3, 14): + def print_stack_trace(self, count: int | None = None) -> None: ... + else: + def print_stack_trace(self) -> None: ... + def print_stack_entry(self, frame_lineno: tuple[FrameType, int], prompt_prefix: str = "\n-> ") -> None: ... def lookupmodule(self, filename: str) -> str | None: ... if sys.version_info < (3, 11): def _runscript(self, filename: str) -> None: ... + if sys.version_info >= (3, 14): + def complete_multiline_names(self, text: str, line: str, begidx: int, endidx: int) -> list[str]: ... + if sys.version_info >= (3, 13): def completedefault(self, text: str, line: str, begidx: int, endidx: int) -> list[str]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pickle.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pickle.pyi new file mode 100644 index 0000000000000..2d80d61645e0e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pickle.pyi @@ -0,0 +1,233 @@ +from _pickle import ( + PickleError as PickleError, + Pickler as Pickler, + PicklingError as PicklingError, + Unpickler as Unpickler, + UnpicklingError as UnpicklingError, + _BufferCallback, + _ReadableFileobj, + _ReducedType, + dump as dump, + dumps as dumps, + load as load, + loads as loads, +) +from _typeshed import ReadableBuffer, SupportsWrite +from collections.abc import Callable, Iterable, Mapping +from typing import Any, ClassVar, SupportsBytes, SupportsIndex, final +from typing_extensions import Self + +__all__ = [ + "PickleBuffer", + "PickleError", + "PicklingError", + "UnpicklingError", + "Pickler", + "Unpickler", + "dump", + "dumps", + "load", + "loads", + "ADDITEMS", + "APPEND", + "APPENDS", + "BINBYTES", + "BINBYTES8", + "BINFLOAT", + "BINGET", + "BININT", + "BININT1", + "BININT2", + "BINPERSID", + "BINPUT", + "BINSTRING", + "BINUNICODE", + "BINUNICODE8", + "BUILD", + "BYTEARRAY8", + "DEFAULT_PROTOCOL", + "DICT", + "DUP", + "EMPTY_DICT", + "EMPTY_LIST", + "EMPTY_SET", + "EMPTY_TUPLE", + "EXT1", + "EXT2", + "EXT4", + "FALSE", + "FLOAT", + "FRAME", + "FROZENSET", + "GET", + "GLOBAL", + "HIGHEST_PROTOCOL", + "INST", + "INT", + "LIST", + "LONG", + "LONG1", + "LONG4", + "LONG_BINGET", + "LONG_BINPUT", + "MARK", + "MEMOIZE", + "NEWFALSE", + "NEWOBJ", + "NEWOBJ_EX", + "NEWTRUE", + "NEXT_BUFFER", + "NONE", + "OBJ", + "PERSID", + "POP", + "POP_MARK", + "PROTO", + "PUT", + "READONLY_BUFFER", + "REDUCE", + "SETITEM", + "SETITEMS", + "SHORT_BINBYTES", + "SHORT_BINSTRING", + "SHORT_BINUNICODE", + "STACK_GLOBAL", + "STOP", + "STRING", + "TRUE", + "TUPLE", + "TUPLE1", + "TUPLE2", + "TUPLE3", + "UNICODE", +] + +HIGHEST_PROTOCOL: int +DEFAULT_PROTOCOL: int + +bytes_types: tuple[type[Any], ...] # undocumented + +@final +class PickleBuffer: + def __new__(cls, buffer: ReadableBuffer) -> Self: ... + def raw(self) -> memoryview: ... + def release(self) -> None: ... + def __buffer__(self, flags: int, /) -> memoryview: ... + def __release_buffer__(self, buffer: memoryview, /) -> None: ... + +MARK: bytes +STOP: bytes +POP: bytes +POP_MARK: bytes +DUP: bytes +FLOAT: bytes +INT: bytes +BININT: bytes +BININT1: bytes +LONG: bytes +BININT2: bytes +NONE: bytes +PERSID: bytes +BINPERSID: bytes +REDUCE: bytes +STRING: bytes +BINSTRING: bytes +SHORT_BINSTRING: bytes +UNICODE: bytes +BINUNICODE: bytes +APPEND: bytes +BUILD: bytes +GLOBAL: bytes +DICT: bytes +EMPTY_DICT: bytes +APPENDS: bytes +GET: bytes +BINGET: bytes +INST: bytes +LONG_BINGET: bytes +LIST: bytes +EMPTY_LIST: bytes +OBJ: bytes +PUT: bytes +BINPUT: bytes +LONG_BINPUT: bytes +SETITEM: bytes +TUPLE: bytes +EMPTY_TUPLE: bytes +SETITEMS: bytes +BINFLOAT: bytes + +TRUE: bytes +FALSE: bytes + +# protocol 2 +PROTO: bytes +NEWOBJ: bytes +EXT1: bytes +EXT2: bytes +EXT4: bytes +TUPLE1: bytes +TUPLE2: bytes +TUPLE3: bytes +NEWTRUE: bytes +NEWFALSE: bytes +LONG1: bytes +LONG4: bytes + +# protocol 3 +BINBYTES: bytes +SHORT_BINBYTES: bytes + +# protocol 4 +SHORT_BINUNICODE: bytes +BINUNICODE8: bytes +BINBYTES8: bytes +EMPTY_SET: bytes +ADDITEMS: bytes +FROZENSET: bytes +NEWOBJ_EX: bytes +STACK_GLOBAL: bytes +MEMOIZE: bytes +FRAME: bytes + +# protocol 5 +BYTEARRAY8: bytes +NEXT_BUFFER: bytes +READONLY_BUFFER: bytes + +def encode_long(x: int) -> bytes: ... # undocumented +def decode_long(data: Iterable[SupportsIndex] | SupportsBytes | ReadableBuffer) -> int: ... # undocumented + +# undocumented pure-Python implementations +class _Pickler: + fast: bool + dispatch_table: Mapping[type, Callable[[Any], _ReducedType]] + bin: bool # undocumented + dispatch: ClassVar[dict[type, Callable[[Unpickler, Any], None]]] # undocumented, _Pickler only + reducer_override: Callable[[Any], Any] + def __init__( + self, + file: SupportsWrite[bytes], + protocol: int | None = None, + *, + fix_imports: bool = True, + buffer_callback: _BufferCallback = None, + ) -> None: ... + def dump(self, obj: Any) -> None: ... + def clear_memo(self) -> None: ... + def persistent_id(self, obj: Any) -> Any: ... + +class _Unpickler: + dispatch: ClassVar[dict[int, Callable[[Unpickler], None]]] # undocumented, _Unpickler only + def __init__( + self, + file: _ReadableFileobj, + *, + fix_imports: bool = True, + encoding: str = "ASCII", + errors: str = "strict", + buffers: Iterable[Any] | None = None, + ) -> None: ... + def load(self) -> Any: ... + def find_class(self, module: str, name: str) -> Any: ... + def persistent_load(self, pid: Any) -> Any: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pickletools.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pickletools.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pickletools.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pickletools.pyi index 542172814926c..cdade08d39a87 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pickletools.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pickletools.pyi @@ -1,3 +1,4 @@ +import sys from collections.abc import Callable, Iterator, MutableMapping from typing import IO, Any from typing_extensions import TypeAlias @@ -40,7 +41,13 @@ def read_uint8(f: IO[bytes]) -> int: ... uint8: ArgumentDescriptor -def read_stringnl(f: IO[bytes], decode: bool = True, stripquotes: bool = True) -> bytes | str: ... +if sys.version_info >= (3, 12): + def read_stringnl( + f: IO[bytes], decode: bool = True, stripquotes: bool = True, *, encoding: str = "latin-1" + ) -> bytes | str: ... + +else: + def read_stringnl(f: IO[bytes], decode: bool = True, stripquotes: bool = True) -> bytes | str: ... stringnl: ArgumentDescriptor diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pipes.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pipes.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pipes.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pipes.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pkgutil.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pkgutil.pyi new file mode 100644 index 0000000000000..e764d08e79f80 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pkgutil.pyi @@ -0,0 +1,53 @@ +import sys +from _typeshed import StrOrBytesPath, SupportsRead +from _typeshed.importlib import LoaderProtocol, MetaPathFinderProtocol, PathEntryFinderProtocol +from collections.abc import Callable, Iterable, Iterator +from typing import IO, Any, NamedTuple, TypeVar +from typing_extensions import deprecated + +__all__ = [ + "get_importer", + "iter_importers", + "walk_packages", + "iter_modules", + "get_data", + "read_code", + "extend_path", + "ModuleInfo", +] +if sys.version_info < (3, 14): + __all__ += ["get_loader", "find_loader"] +if sys.version_info < (3, 12): + __all__ += ["ImpImporter", "ImpLoader"] + +_PathT = TypeVar("_PathT", bound=Iterable[str]) + +class ModuleInfo(NamedTuple): + module_finder: MetaPathFinderProtocol | PathEntryFinderProtocol + name: str + ispkg: bool + +def extend_path(path: _PathT, name: str) -> _PathT: ... + +if sys.version_info < (3, 12): + class ImpImporter: + def __init__(self, path: StrOrBytesPath | None = None) -> None: ... + + class ImpLoader: + def __init__(self, fullname: str, file: IO[str], filename: StrOrBytesPath, etc: tuple[str, str, int]) -> None: ... + +if sys.version_info < (3, 14): + @deprecated("Use importlib.util.find_spec() instead. Will be removed in Python 3.14.") + def find_loader(fullname: str) -> LoaderProtocol | None: ... + @deprecated("Use importlib.util.find_spec() instead. Will be removed in Python 3.14.") + def get_loader(module_or_name: str) -> LoaderProtocol | None: ... + +def get_importer(path_item: StrOrBytesPath) -> PathEntryFinderProtocol | None: ... +def iter_importers(fullname: str = "") -> Iterator[MetaPathFinderProtocol | PathEntryFinderProtocol]: ... +def iter_modules(path: Iterable[StrOrBytesPath] | None = None, prefix: str = "") -> Iterator[ModuleInfo]: ... +def read_code(stream: SupportsRead[bytes]) -> Any: ... # undocumented +def walk_packages( + path: Iterable[StrOrBytesPath] | None = None, prefix: str = "", onerror: Callable[[str], object] | None = None +) -> Iterator[ModuleInfo]: ... +def get_data(package: str, resource: str) -> bytes | None: ... +def resolve_name(name: str) -> Any: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/platform.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/platform.pyi new file mode 100644 index 0000000000000..fbc73c6c91775 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/platform.pyi @@ -0,0 +1,87 @@ +import sys +from typing import NamedTuple, type_check_only +from typing_extensions import Self + +def libc_ver(executable: str | None = None, lib: str = "", version: str = "", chunksize: int = 16384) -> tuple[str, str]: ... +def win32_ver(release: str = "", version: str = "", csd: str = "", ptype: str = "") -> tuple[str, str, str, str]: ... +def win32_edition() -> str: ... +def win32_is_iot() -> bool: ... +def mac_ver( + release: str = "", versioninfo: tuple[str, str, str] = ("", "", ""), machine: str = "" +) -> tuple[str, tuple[str, str, str], str]: ... +def java_ver( + release: str = "", vendor: str = "", vminfo: tuple[str, str, str] = ("", "", ""), osinfo: tuple[str, str, str] = ("", "", "") +) -> tuple[str, str, tuple[str, str, str], tuple[str, str, str]]: ... +def system_alias(system: str, release: str, version: str) -> tuple[str, str, str]: ... +def architecture(executable: str = sys.executable, bits: str = "", linkage: str = "") -> tuple[str, str]: ... + +# This class is not exposed. It calls itself platform.uname_result_base. +# At runtime it only has 5 fields. +@type_check_only +class _uname_result_base(NamedTuple): + system: str + node: str + release: str + version: str + machine: str + # This base class doesn't have this field at runtime, but claiming it + # does is the least bad way to handle the situation. Nobody really + # sees this class anyway. See #13068 + processor: str + +# uname_result emulates a 6-field named tuple, but the processor field +# is lazily evaluated rather than being passed in to the constructor. +class uname_result(_uname_result_base): + if sys.version_info >= (3, 10): + __match_args__ = ("system", "node", "release", "version", "machine") # pyright: ignore[reportAssignmentType] + + def __new__(_cls, system: str, node: str, release: str, version: str, machine: str) -> Self: ... + @property + def processor(self) -> str: ... + +def uname() -> uname_result: ... +def system() -> str: ... +def node() -> str: ... +def release() -> str: ... +def version() -> str: ... +def machine() -> str: ... +def processor() -> str: ... +def python_implementation() -> str: ... +def python_version() -> str: ... +def python_version_tuple() -> tuple[str, str, str]: ... +def python_branch() -> str: ... +def python_revision() -> str: ... +def python_build() -> tuple[str, str]: ... +def python_compiler() -> str: ... +def platform(aliased: bool = ..., terse: bool = ...) -> str: ... + +if sys.version_info >= (3, 10): + def freedesktop_os_release() -> dict[str, str]: ... + +if sys.version_info >= (3, 13): + class AndroidVer(NamedTuple): + release: str + api_level: int + manufacturer: str + model: str + device: str + is_emulator: bool + + class IOSVersionInfo(NamedTuple): + system: str + release: str + model: str + is_simulator: bool + + def android_ver( + release: str = "", + api_level: int = 0, + manufacturer: str = "", + model: str = "", + device: str = "", + is_emulator: bool = False, + ) -> AndroidVer: ... + def ios_ver(system: str = "", release: str = "", model: str = "", is_simulator: bool = False) -> IOSVersionInfo: ... + +if sys.version_info >= (3, 14): + def invalidate_caches() -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/plistlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/plistlib.pyi new file mode 100644 index 0000000000000..8b39b4217eae6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/plistlib.pyi @@ -0,0 +1,84 @@ +import sys +from _typeshed import ReadableBuffer +from collections.abc import Mapping, MutableMapping +from datetime import datetime +from enum import Enum +from typing import IO, Any +from typing_extensions import Self + +__all__ = ["InvalidFileException", "FMT_XML", "FMT_BINARY", "load", "dump", "loads", "dumps", "UID"] + +class PlistFormat(Enum): + FMT_XML = 1 + FMT_BINARY = 2 + +FMT_XML = PlistFormat.FMT_XML +FMT_BINARY = PlistFormat.FMT_BINARY +if sys.version_info >= (3, 13): + def load( + fp: IO[bytes], + *, + fmt: PlistFormat | None = None, + dict_type: type[MutableMapping[str, Any]] = ..., + aware_datetime: bool = False, + ) -> Any: ... + def loads( + value: ReadableBuffer | str, + *, + fmt: PlistFormat | None = None, + dict_type: type[MutableMapping[str, Any]] = ..., + aware_datetime: bool = False, + ) -> Any: ... + +else: + def load(fp: IO[bytes], *, fmt: PlistFormat | None = None, dict_type: type[MutableMapping[str, Any]] = ...) -> Any: ... + def loads( + value: ReadableBuffer, *, fmt: PlistFormat | None = None, dict_type: type[MutableMapping[str, Any]] = ... + ) -> Any: ... + +if sys.version_info >= (3, 13): + def dump( + value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, + fp: IO[bytes], + *, + fmt: PlistFormat = ..., + sort_keys: bool = True, + skipkeys: bool = False, + aware_datetime: bool = False, + ) -> None: ... + def dumps( + value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, + *, + fmt: PlistFormat = ..., + skipkeys: bool = False, + sort_keys: bool = True, + aware_datetime: bool = False, + ) -> bytes: ... + +else: + def dump( + value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, + fp: IO[bytes], + *, + fmt: PlistFormat = ..., + sort_keys: bool = True, + skipkeys: bool = False, + ) -> None: ... + def dumps( + value: Mapping[str, Any] | list[Any] | tuple[Any, ...] | str | bool | float | bytes | bytearray | datetime, + *, + fmt: PlistFormat = ..., + skipkeys: bool = False, + sort_keys: bool = True, + ) -> bytes: ... + +class UID: + data: int + def __init__(self, data: int) -> None: ... + def __index__(self) -> int: ... + def __reduce__(self) -> tuple[type[Self], tuple[int]]: ... + def __hash__(self) -> int: ... + def __eq__(self, other: object) -> bool: ... + +class InvalidFileException(ValueError): + def __init__(self, message: str = "Invalid file") -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/poplib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/poplib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/poplib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/poplib.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/posix.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/posix.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/posix.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/posix.pyi index 1a4f22af82cf4..6d0d76ab82176 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/posix.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/posix.pyi @@ -6,6 +6,8 @@ if sys.platform != "win32": CLD_CONTINUED as CLD_CONTINUED, CLD_DUMPED as CLD_DUMPED, CLD_EXITED as CLD_EXITED, + CLD_KILLED as CLD_KILLED, + CLD_STOPPED as CLD_STOPPED, CLD_TRAPPED as CLD_TRAPPED, EX_CANTCREAT as EX_CANTCREAT, EX_CONFIG as EX_CONFIG, @@ -29,22 +31,20 @@ if sys.platform != "win32": F_TLOCK as F_TLOCK, F_ULOCK as F_ULOCK, NGROUPS_MAX as NGROUPS_MAX, + O_ACCMODE as O_ACCMODE, O_APPEND as O_APPEND, O_ASYNC as O_ASYNC, + O_CLOEXEC as O_CLOEXEC, O_CREAT as O_CREAT, - O_DIRECT as O_DIRECT, O_DIRECTORY as O_DIRECTORY, O_DSYNC as O_DSYNC, O_EXCL as O_EXCL, - O_LARGEFILE as O_LARGEFILE, O_NDELAY as O_NDELAY, - O_NOATIME as O_NOATIME, O_NOCTTY as O_NOCTTY, O_NOFOLLOW as O_NOFOLLOW, O_NONBLOCK as O_NONBLOCK, O_RDONLY as O_RDONLY, O_RDWR as O_RDWR, - O_RSYNC as O_RSYNC, O_SYNC as O_SYNC, O_TRUNC as O_TRUNC, O_WRONLY as O_WRONLY, @@ -64,13 +64,9 @@ if sys.platform != "win32": RTLD_NODELETE as RTLD_NODELETE, RTLD_NOLOAD as RTLD_NOLOAD, RTLD_NOW as RTLD_NOW, - SCHED_BATCH as SCHED_BATCH, SCHED_FIFO as SCHED_FIFO, - SCHED_IDLE as SCHED_IDLE, SCHED_OTHER as SCHED_OTHER, - SCHED_RESET_ON_FORK as SCHED_RESET_ON_FORK, SCHED_RR as SCHED_RR, - SCHED_SPORADIC as SCHED_SPORADIC, SEEK_DATA as SEEK_DATA, SEEK_HOLE as SEEK_HOLE, ST_NOSUID as ST_NOSUID, @@ -226,12 +222,13 @@ if sys.platform != "win32": wait3 as wait3, wait4 as wait4, waitpid as waitpid, + waitstatus_to_exitcode as waitstatus_to_exitcode, write as write, writev as writev, ) - if sys.version_info >= (3, 9): - from os import CLD_KILLED as CLD_KILLED, CLD_STOPPED as CLD_STOPPED, waitstatus_to_exitcode as waitstatus_to_exitcode + if sys.version_info >= (3, 10): + from os import O_FSYNC as O_FSYNC if sys.version_info >= (3, 11): from os import login_tty as login_tty @@ -253,11 +250,20 @@ if sys.platform != "win32": timerfd_settime_ns as timerfd_settime_ns, ) + if sys.version_info >= (3, 14): + from os import readinto as readinto + + if sys.version_info >= (3, 14) and sys.platform == "linux": + from os import SCHED_DEADLINE as SCHED_DEADLINE, SCHED_NORMAL as SCHED_NORMAL + if sys.platform != "linux": - from os import chflags as chflags, lchflags as lchflags, lchmod as lchmod + from os import O_EXLOCK as O_EXLOCK, O_SHLOCK as O_SHLOCK, chflags as chflags, lchflags as lchflags, lchmod as lchmod if sys.platform != "linux" and sys.platform != "darwin": - from os import EX_NOTFOUND as EX_NOTFOUND + from os import EX_NOTFOUND as EX_NOTFOUND, SCHED_SPORADIC as SCHED_SPORADIC + + if sys.platform != "linux" and sys.version_info >= (3, 13): + from os import O_EXEC as O_EXEC, O_SEARCH as O_SEARCH if sys.platform != "darwin": from os import ( @@ -271,6 +277,15 @@ if sys.platform != "win32": RWF_HIPRI as RWF_HIPRI, RWF_NOWAIT as RWF_NOWAIT, RWF_SYNC as RWF_SYNC, + ST_APPEND as ST_APPEND, + ST_MANDLOCK as ST_MANDLOCK, + ST_NOATIME as ST_NOATIME, + ST_NODEV as ST_NODEV, + ST_NODIRATIME as ST_NODIRATIME, + ST_NOEXEC as ST_NOEXEC, + ST_RELATIME as ST_RELATIME, + ST_SYNCHRONOUS as ST_SYNCHRONOUS, + ST_WRITE as ST_WRITE, fdatasync as fdatasync, getresgid as getresgid, getresuid as getresuid, @@ -315,7 +330,17 @@ if sys.platform != "win32": MFD_HUGE_MASK as MFD_HUGE_MASK, MFD_HUGE_SHIFT as MFD_HUGE_SHIFT, MFD_HUGETLB as MFD_HUGETLB, + O_DIRECT as O_DIRECT, + O_LARGEFILE as O_LARGEFILE, + O_NOATIME as O_NOATIME, + O_PATH as O_PATH, + O_RSYNC as O_RSYNC, + O_TMPFILE as O_TMPFILE, + P_PIDFD as P_PIDFD, RTLD_DEEPBIND as RTLD_DEEPBIND, + SCHED_BATCH as SCHED_BATCH, + SCHED_IDLE as SCHED_IDLE, + SCHED_RESET_ON_FORK as SCHED_RESET_ON_FORK, XATTR_CREATE as XATTR_CREATE, XATTR_REPLACE as XATTR_REPLACE, XATTR_SIZE_MAX as XATTR_SIZE_MAX, @@ -324,13 +349,11 @@ if sys.platform != "win32": getxattr as getxattr, listxattr as listxattr, memfd_create as memfd_create, + pidfd_open as pidfd_open, removexattr as removexattr, setxattr as setxattr, ) - if sys.version_info >= (3, 9): - from os import P_PIDFD as P_PIDFD, pidfd_open as pidfd_open - if sys.version_info >= (3, 10): from os import ( EFD_CLOEXEC as EFD_CLOEXEC, @@ -361,6 +384,7 @@ if sys.platform != "win32": CLONE_SYSVSEM as CLONE_SYSVSEM, CLONE_THREAD as CLONE_THREAD, CLONE_VM as CLONE_VM, + PIDFD_NONBLOCK as PIDFD_NONBLOCK, setns as setns, unshare as unshare, ) @@ -373,6 +397,8 @@ if sys.platform != "win32": PRIO_DARWIN_PROCESS as PRIO_DARWIN_PROCESS, PRIO_DARWIN_THREAD as PRIO_DARWIN_THREAD, ) + if sys.platform == "darwin" and sys.version_info >= (3, 10): + from os import O_EVTONLY as O_EVTONLY, O_NOFOLLOW_ANY as O_NOFOLLOW_ANY, O_SYMLINK as O_SYMLINK # Not same as os.environ or os.environb # Because of this variable, we can't do "from posix import *" in os/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/posixpath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/posixpath.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/posixpath.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/posixpath.pyi index 31406f8df9501..3313667f1781b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/posixpath.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/posixpath.pyi @@ -77,7 +77,11 @@ pathsep: LiteralString defpath: LiteralString devnull: LiteralString -def abspath(path: PathLike[AnyStr] | AnyStr) -> AnyStr: ... +# Overloads are necessary to work around python/mypy#17952 & python/mypy#11880 +@overload +def abspath(path: PathLike[AnyStr]) -> AnyStr: ... +@overload +def abspath(path: AnyStr) -> AnyStr: ... @overload def basename(p: PathLike[AnyStr]) -> AnyStr: ... @overload @@ -86,8 +90,14 @@ def basename(p: AnyOrLiteralStr) -> AnyOrLiteralStr: ... def dirname(p: PathLike[AnyStr]) -> AnyStr: ... @overload def dirname(p: AnyOrLiteralStr) -> AnyOrLiteralStr: ... -def expanduser(path: PathLike[AnyStr] | AnyStr) -> AnyStr: ... -def expandvars(path: PathLike[AnyStr] | AnyStr) -> AnyStr: ... +@overload +def expanduser(path: PathLike[AnyStr]) -> AnyStr: ... +@overload +def expanduser(path: AnyStr) -> AnyStr: ... +@overload +def expandvars(path: PathLike[AnyStr]) -> AnyStr: ... +@overload +def expandvars(path: AnyStr) -> AnyStr: ... @overload def normcase(s: PathLike[AnyStr]) -> AnyStr: ... @overload diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pprint.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pprint.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pprint.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pprint.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/profile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/profile.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/profile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/profile.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pstats.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pstats.pyi new file mode 100644 index 0000000000000..c4dee1f6b8f69 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pstats.pyi @@ -0,0 +1,91 @@ +import sys +from _typeshed import StrOrBytesPath +from collections.abc import Iterable +from cProfile import Profile as _cProfile +from dataclasses import dataclass +from profile import Profile +from typing import IO, Any, Literal, overload +from typing_extensions import Self, TypeAlias + +if sys.version_info >= (3, 11): + from enum import StrEnum +else: + from enum import Enum + +__all__ = ["Stats", "SortKey", "FunctionProfile", "StatsProfile"] + +_Selector: TypeAlias = str | float | int + +if sys.version_info >= (3, 11): + class SortKey(StrEnum): + CALLS = "calls" + CUMULATIVE = "cumulative" + FILENAME = "filename" + LINE = "line" + NAME = "name" + NFL = "nfl" + PCALLS = "pcalls" + STDNAME = "stdname" + TIME = "time" + +else: + class SortKey(str, Enum): + CALLS = "calls" + CUMULATIVE = "cumulative" + FILENAME = "filename" + LINE = "line" + NAME = "name" + NFL = "nfl" + PCALLS = "pcalls" + STDNAME = "stdname" + TIME = "time" + +@dataclass(unsafe_hash=True) +class FunctionProfile: + ncalls: str + tottime: float + percall_tottime: float + cumtime: float + percall_cumtime: float + file_name: str + line_number: int + +@dataclass(unsafe_hash=True) +class StatsProfile: + total_tt: float + func_profiles: dict[str, FunctionProfile] + +_SortArgDict: TypeAlias = dict[str, tuple[tuple[tuple[int, int], ...], str]] + +class Stats: + sort_arg_dict_default: _SortArgDict + def __init__( + self, + arg: None | str | Profile | _cProfile = ..., + /, + *args: None | str | Profile | _cProfile | Self, + stream: IO[Any] | None = None, + ) -> None: ... + def init(self, arg: None | str | Profile | _cProfile) -> None: ... + def load_stats(self, arg: None | str | Profile | _cProfile) -> None: ... + def get_top_level_stats(self) -> None: ... + def add(self, *arg_list: None | str | Profile | _cProfile | Self) -> Self: ... + def dump_stats(self, filename: StrOrBytesPath) -> None: ... + def get_sort_arg_defs(self) -> _SortArgDict: ... + @overload + def sort_stats(self, field: Literal[-1, 0, 1, 2]) -> Self: ... + @overload + def sort_stats(self, *field: str) -> Self: ... + def reverse_order(self) -> Self: ... + def strip_dirs(self) -> Self: ... + def calc_callees(self) -> None: ... + def eval_print_amount(self, sel: _Selector, list: list[str], msg: str) -> tuple[list[str], str]: ... + def get_stats_profile(self) -> StatsProfile: ... + def get_print_list(self, sel_list: Iterable[_Selector]) -> tuple[int, list[str]]: ... + def print_stats(self, *amount: _Selector) -> Self: ... + def print_callees(self, *amount: _Selector) -> Self: ... + def print_callers(self, *amount: _Selector) -> Self: ... + def print_call_heading(self, name_size: int, column_title: str) -> None: ... + def print_call_line(self, name_size: int, source: str, call_dict: dict[str, Any], arrow: str = "->") -> None: ... + def print_title(self) -> None: ... + def print_line(self, func: str) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pty.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pty.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pty.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pty.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pwd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pwd.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pwd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pwd.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/py_compile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/py_compile.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/py_compile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/py_compile.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pyclbr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pyclbr.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pyclbr.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pyclbr.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pydoc.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pydoc.pyi index 144f782acad57..f14b9d1bb6998 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pydoc.pyi @@ -6,7 +6,7 @@ from collections.abc import Callable, Container, Mapping, MutableMapping from reprlib import Repr from types import MethodType, ModuleType, TracebackType from typing import IO, Any, AnyStr, Final, NoReturn, Protocol, TypeVar -from typing_extensions import TypeGuard +from typing_extensions import TypeGuard, deprecated __all__ = ["help"] @@ -31,7 +31,14 @@ def stripid(text: str) -> str: ... def allmethods(cl: type) -> MutableMapping[str, MethodType]: ... def visiblename(name: str, all: Container[str] | None = None, obj: object = None) -> bool: ... def classify_class_attrs(object: object) -> list[tuple[str, str, type, str]]: ... -def ispackage(path: str) -> bool: ... + +if sys.version_info >= (3, 13): + @deprecated("Deprecated in Python 3.13.") + def ispackage(path: str) -> bool: ... + +else: + def ispackage(path: str) -> bool: ... + def source_synopsis(file: IO[AnyStr]) -> AnyStr | None: ... def synopsis(filename: str, cache: MutableMapping[str, tuple[int, str]] = {}) -> str | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pydoc_data/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pydoc_data/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc_data/topics.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pydoc_data/topics.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pydoc_data/topics.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pydoc_data/topics.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi new file mode 100644 index 0000000000000..21e676052098d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/__init__.pyi @@ -0,0 +1,82 @@ +from _typeshed import ReadableBuffer, SupportsRead +from collections.abc import Callable +from pyexpat import errors as errors, model as model +from typing import Any, Final, final +from typing_extensions import CapsuleType, TypeAlias +from xml.parsers.expat import ExpatError as ExpatError + +EXPAT_VERSION: Final[str] # undocumented +version_info: tuple[int, int, int] # undocumented +native_encoding: str # undocumented +features: list[tuple[str, int]] # undocumented + +error = ExpatError +XML_PARAM_ENTITY_PARSING_NEVER: Final = 0 +XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE: Final = 1 +XML_PARAM_ENTITY_PARSING_ALWAYS: Final = 2 + +_Model: TypeAlias = tuple[int, int, str | None, tuple[Any, ...]] + +@final +class XMLParserType: + def Parse(self, data: str | ReadableBuffer, isfinal: bool = False, /) -> int: ... + def ParseFile(self, file: SupportsRead[bytes], /) -> int: ... + def SetBase(self, base: str, /) -> None: ... + def GetBase(self) -> str | None: ... + def GetInputContext(self) -> bytes | None: ... + def ExternalEntityParserCreate(self, context: str | None, encoding: str = ..., /) -> XMLParserType: ... + def SetParamEntityParsing(self, flag: int, /) -> int: ... + def UseForeignDTD(self, flag: bool = True, /) -> None: ... + def GetReparseDeferralEnabled(self) -> bool: ... + def SetReparseDeferralEnabled(self, enabled: bool, /) -> None: ... + @property + def intern(self) -> dict[str, str]: ... + buffer_size: int + buffer_text: bool + buffer_used: int + namespace_prefixes: bool # undocumented + ordered_attributes: bool + specified_attributes: bool + ErrorByteIndex: int + ErrorCode: int + ErrorColumnNumber: int + ErrorLineNumber: int + CurrentByteIndex: int + CurrentColumnNumber: int + CurrentLineNumber: int + XmlDeclHandler: Callable[[str, str | None, int], Any] | None + StartDoctypeDeclHandler: Callable[[str, str | None, str | None, bool], Any] | None + EndDoctypeDeclHandler: Callable[[], Any] | None + ElementDeclHandler: Callable[[str, _Model], Any] | None + AttlistDeclHandler: Callable[[str, str, str, str | None, bool], Any] | None + StartElementHandler: ( + Callable[[str, dict[str, str]], Any] + | Callable[[str, list[str]], Any] + | Callable[[str, dict[str, str], list[str]], Any] + | None + ) + EndElementHandler: Callable[[str], Any] | None + ProcessingInstructionHandler: Callable[[str, str], Any] | None + CharacterDataHandler: Callable[[str], Any] | None + UnparsedEntityDeclHandler: Callable[[str, str | None, str, str | None, str], Any] | None + EntityDeclHandler: Callable[[str, bool, str | None, str | None, str, str | None, str | None], Any] | None + NotationDeclHandler: Callable[[str, str | None, str, str | None], Any] | None + StartNamespaceDeclHandler: Callable[[str, str], Any] | None + EndNamespaceDeclHandler: Callable[[str], Any] | None + CommentHandler: Callable[[str], Any] | None + StartCdataSectionHandler: Callable[[], Any] | None + EndCdataSectionHandler: Callable[[], Any] | None + DefaultHandler: Callable[[str], Any] | None + DefaultHandlerExpand: Callable[[str], Any] | None + NotStandaloneHandler: Callable[[], int] | None + ExternalEntityRefHandler: Callable[[str, str | None, str | None, str | None], int] | None + SkippedEntityHandler: Callable[[str, bool], Any] | None + +def ErrorString(code: int, /) -> str: ... + +# intern is undocumented +def ParserCreate( + encoding: str | None = None, namespace_separator: str | None = None, intern: dict[str, Any] | None = None +) -> XMLParserType: ... + +expat_CAPI: CapsuleType diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/errors.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/errors.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/errors.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/errors.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/model.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/model.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/pyexpat/model.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/pyexpat/model.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/queue.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/queue.pyi new file mode 100644 index 0000000000000..f5d9179e079d4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/queue.pyi @@ -0,0 +1,54 @@ +import sys +from _queue import Empty as Empty, SimpleQueue as SimpleQueue +from threading import Condition, Lock +from types import GenericAlias +from typing import Any, Generic, TypeVar + +__all__ = ["Empty", "Full", "Queue", "PriorityQueue", "LifoQueue", "SimpleQueue"] +if sys.version_info >= (3, 13): + __all__ += ["ShutDown"] + +_T = TypeVar("_T") + +class Full(Exception): ... + +if sys.version_info >= (3, 13): + class ShutDown(Exception): ... + +class Queue(Generic[_T]): + maxsize: int + + mutex: Lock # undocumented + not_empty: Condition # undocumented + not_full: Condition # undocumented + all_tasks_done: Condition # undocumented + unfinished_tasks: int # undocumented + if sys.version_info >= (3, 13): + is_shutdown: bool # undocumented + # Despite the fact that `queue` has `deque` type, + # we treat it as `Any` to allow different implementations in subtypes. + queue: Any # undocumented + def __init__(self, maxsize: int = 0) -> None: ... + def _init(self, maxsize: int) -> None: ... + def empty(self) -> bool: ... + def full(self) -> bool: ... + def get(self, block: bool = True, timeout: float | None = None) -> _T: ... + def get_nowait(self) -> _T: ... + if sys.version_info >= (3, 13): + def shutdown(self, immediate: bool = False) -> None: ... + + def _get(self) -> _T: ... + def put(self, item: _T, block: bool = True, timeout: float | None = None) -> None: ... + def put_nowait(self, item: _T) -> None: ... + def _put(self, item: _T) -> None: ... + def join(self) -> None: ... + def qsize(self) -> int: ... + def _qsize(self) -> int: ... + def task_done(self) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +class PriorityQueue(Queue[_T]): + queue: list[_T] + +class LifoQueue(Queue[_T]): + queue: list[_T] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/quopri.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/quopri.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/quopri.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/quopri.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/random.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/random.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/random.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/random.pyi index e7320369c3778..83e37113a941b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/random.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/random.pyi @@ -30,10 +30,9 @@ __all__ = [ "getrandbits", "choices", "SystemRandom", + "randbytes", ] -if sys.version_info >= (3, 9): - __all__ += ["randbytes"] if sys.version_info >= (3, 12): __all__ += ["binomialvariate"] @@ -41,25 +40,16 @@ _T = TypeVar("_T") class Random(_random.Random): VERSION: ClassVar[int] - if sys.version_info >= (3, 9): - def __init__(self, x: int | float | str | bytes | bytearray | None = None) -> None: ... # noqa: Y041 - else: - def __init__(self, x: Any = None) -> None: ... + def __init__(self, x: int | float | str | bytes | bytearray | None = None) -> None: ... # noqa: Y041 # Using other `seed` types is deprecated since 3.9 and removed in 3.11 # Ignore Y041, since random.seed doesn't treat int like a float subtype. Having an explicit # int better documents conventional usage of random.seed. - if sys.version_info >= (3, 9): - def seed(self, a: int | float | str | bytes | bytearray | None = None, version: int = 2) -> None: ... # type: ignore[override] # noqa: Y041 - else: - def seed(self, a: Any = None, version: int = 2) -> None: ... - + def seed(self, a: int | float | str | bytes | bytearray | None = None, version: int = 2) -> None: ... # type: ignore[override] # noqa: Y041 def getstate(self) -> tuple[Any, ...]: ... def setstate(self, state: tuple[Any, ...]) -> None: ... def randrange(self, start: int, stop: int | None = None, step: int = 1) -> int: ... def randint(self, a: int, b: int) -> int: ... - if sys.version_info >= (3, 9): - def randbytes(self, n: int) -> bytes: ... - + def randbytes(self, n: int) -> bytes: ... def choice(self, seq: SupportsLenAndGetItem[_T]) -> _T: ... def choices( self, @@ -75,12 +65,10 @@ class Random(_random.Random): def shuffle(self, x: MutableSequence[Any], random: Callable[[], float] | None = None) -> None: ... if sys.version_info >= (3, 11): def sample(self, population: Sequence[_T], k: int, *, counts: Iterable[int] | None = None) -> list[_T]: ... - elif sys.version_info >= (3, 9): + else: def sample( self, population: Sequence[_T] | AbstractSet[_T], k: int, *, counts: Iterable[int] | None = None ) -> list[_T]: ... - else: - def sample(self, population: Sequence[_T] | AbstractSet[_T], k: int) -> list[_T]: ... def uniform(self, a: float, b: float) -> float: ... def triangular(self, low: float = 0.0, high: float = 1.0, mode: float | None = None) -> float: ... @@ -137,5 +125,4 @@ weibullvariate = _inst.weibullvariate getstate = _inst.getstate setstate = _inst.setstate getrandbits = _inst.getrandbits -if sys.version_info >= (3, 9): - randbytes = _inst.randbytes +randbytes = _inst.randbytes diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/re.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/re.pyi similarity index 87% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/re.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/re.pyi index ac297b7d45677..f25a0a376704b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/re.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/re.pyi @@ -2,14 +2,12 @@ import enum import sre_compile import sre_constants import sys -from _typeshed import ReadableBuffer +from _typeshed import MaybeNone, ReadableBuffer from collections.abc import Callable, Iterator, Mapping -from typing import Any, AnyStr, Generic, Literal, TypeVar, final, overload +from types import GenericAlias +from typing import Any, AnyStr, Final, Generic, Literal, TypeVar, final, overload from typing_extensions import TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "match", "fullmatch", @@ -90,19 +88,19 @@ class Match(Generic[AnyStr]): @overload def group(self, group: Literal[0] = 0, /) -> AnyStr: ... @overload - def group(self, group: str | int, /) -> AnyStr | Any: ... + def group(self, group: str | int, /) -> AnyStr | MaybeNone: ... @overload - def group(self, group1: str | int, group2: str | int, /, *groups: str | int) -> tuple[AnyStr | Any, ...]: ... + def group(self, group1: str | int, group2: str | int, /, *groups: str | int) -> tuple[AnyStr | MaybeNone, ...]: ... # Each item of groups()'s return tuple is either "AnyStr" or # "AnyStr | None", depending on the pattern. @overload - def groups(self) -> tuple[AnyStr | Any, ...]: ... + def groups(self) -> tuple[AnyStr | MaybeNone, ...]: ... @overload def groups(self, default: _T) -> tuple[AnyStr | _T, ...]: ... # Each value in groupdict()'s return dict is either "AnyStr" or # "AnyStr | None", depending on the pattern. @overload - def groupdict(self) -> dict[str, AnyStr | Any]: ... + def groupdict(self) -> dict[str, AnyStr | MaybeNone]: ... @overload def groupdict(self, default: _T) -> dict[str, AnyStr | _T]: ... def start(self, group: int | str = 0, /) -> int: ... @@ -114,11 +112,10 @@ class Match(Generic[AnyStr]): @overload def __getitem__(self, key: Literal[0], /) -> AnyStr: ... @overload - def __getitem__(self, key: int | str, /) -> AnyStr | Any: ... + def __getitem__(self, key: int | str, /) -> AnyStr | MaybeNone: ... def __copy__(self) -> Match[AnyStr]: ... def __deepcopy__(self, memo: Any, /) -> Match[AnyStr]: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... @final class Pattern(Generic[AnyStr]): @@ -151,11 +148,11 @@ class Pattern(Generic[AnyStr]): @overload def fullmatch(self, string: AnyStr, pos: int = 0, endpos: int = sys.maxsize) -> Match[AnyStr] | None: ... @overload - def split(self: Pattern[str], string: str, maxsplit: int = 0) -> list[str | Any]: ... + def split(self: Pattern[str], string: str, maxsplit: int = 0) -> list[str | MaybeNone]: ... @overload - def split(self: Pattern[bytes], string: ReadableBuffer, maxsplit: int = 0) -> list[bytes | Any]: ... + def split(self: Pattern[bytes], string: ReadableBuffer, maxsplit: int = 0) -> list[bytes | MaybeNone]: ... @overload - def split(self, string: AnyStr, maxsplit: int = 0) -> list[AnyStr | Any]: ... + def split(self, string: AnyStr, maxsplit: int = 0) -> list[AnyStr | MaybeNone]: ... # return type depends on the number of groups in the pattern @overload def findall(self: Pattern[str], string: str, pos: int = 0, endpos: int = sys.maxsize) -> list[Any]: ... @@ -197,8 +194,7 @@ class Pattern(Generic[AnyStr]): def __deepcopy__(self, memo: Any, /) -> Pattern[AnyStr]: ... def __eq__(self, value: object, /) -> bool: ... def __hash__(self) -> int: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... # ----- re variables and constants ----- @@ -224,25 +220,27 @@ class RegexFlag(enum.IntFlag): if sys.version_info >= (3, 11): NOFLAG = 0 -A = RegexFlag.A -ASCII = RegexFlag.ASCII -DEBUG = RegexFlag.DEBUG -I = RegexFlag.I -IGNORECASE = RegexFlag.IGNORECASE -L = RegexFlag.L -LOCALE = RegexFlag.LOCALE -M = RegexFlag.M -MULTILINE = RegexFlag.MULTILINE -S = RegexFlag.S -DOTALL = RegexFlag.DOTALL -X = RegexFlag.X -VERBOSE = RegexFlag.VERBOSE -U = RegexFlag.U -UNICODE = RegexFlag.UNICODE +A: Final = RegexFlag.A +ASCII: Final = RegexFlag.ASCII +DEBUG: Final = RegexFlag.DEBUG +I: Final = RegexFlag.I +IGNORECASE: Final = RegexFlag.IGNORECASE +L: Final = RegexFlag.L +LOCALE: Final = RegexFlag.LOCALE +M: Final = RegexFlag.M +MULTILINE: Final = RegexFlag.MULTILINE +S: Final = RegexFlag.S +DOTALL: Final = RegexFlag.DOTALL +X: Final = RegexFlag.X +VERBOSE: Final = RegexFlag.VERBOSE +U: Final = RegexFlag.U +UNICODE: Final = RegexFlag.UNICODE if sys.version_info < (3, 13): - T = RegexFlag.T - TEMPLATE = RegexFlag.TEMPLATE + T: Final = RegexFlag.T + TEMPLATE: Final = RegexFlag.TEMPLATE if sys.version_info >= (3, 11): + # pytype chokes on `NOFLAG: Final = RegexFlag.NOFLAG` with `LiteralValueError` + # mypy chokes on `NOFLAG: Final[Literal[RegexFlag.NOFLAG]]` with `Literal[...] is invalid` NOFLAG = RegexFlag.NOFLAG _FlagsType: TypeAlias = int | RegexFlag @@ -270,11 +268,11 @@ def fullmatch(pattern: str | Pattern[str], string: str, flags: _FlagsType = 0) - @overload def fullmatch(pattern: bytes | Pattern[bytes], string: ReadableBuffer, flags: _FlagsType = 0) -> Match[bytes] | None: ... @overload -def split(pattern: str | Pattern[str], string: str, maxsplit: int = 0, flags: _FlagsType = 0) -> list[str | Any]: ... +def split(pattern: str | Pattern[str], string: str, maxsplit: int = 0, flags: _FlagsType = 0) -> list[str | MaybeNone]: ... @overload def split( pattern: bytes | Pattern[bytes], string: ReadableBuffer, maxsplit: int = 0, flags: _FlagsType = 0 -) -> list[bytes | Any]: ... +) -> list[bytes | MaybeNone]: ... @overload def findall(pattern: str | Pattern[str], string: str, flags: _FlagsType = 0) -> list[Any]: ... @overload diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/readline.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/readline.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/readline.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/readline.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/reprlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/reprlib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/reprlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/reprlib.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/resource.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/resource.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/resource.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/resource.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/rlcompleter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/rlcompleter.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/rlcompleter.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/rlcompleter.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/runpy.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/runpy.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/runpy.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/runpy.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sched.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sched.pyi similarity index 85% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sched.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sched.pyi index 75dd63d0414af..52f87ab68ff54 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/sched.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sched.pyi @@ -1,6 +1,6 @@ import sys from collections.abc import Callable -from typing import Any, NamedTuple +from typing import Any, ClassVar, NamedTuple, type_check_only from typing_extensions import TypeAlias __all__ = ["scheduler"] @@ -17,13 +17,17 @@ if sys.version_info >= (3, 10): kwargs: dict[str, Any] else: - class Event(NamedTuple): + @type_check_only + class _EventBase(NamedTuple): time: float priority: Any action: _ActionCallback argument: tuple[Any, ...] kwargs: dict[str, Any] + class Event(_EventBase): + __hash__: ClassVar[None] # type: ignore[assignment] + class scheduler: timefunc: Callable[[], float] delayfunc: Callable[[float], object] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/secrets.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/secrets.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/secrets.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/secrets.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/select.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/select.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/select.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/select.pyi index 6d4c8d8f4c157..42941b9e41fab 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/select.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/select.pyi @@ -2,7 +2,7 @@ import sys from _typeshed import FileDescriptorLike from collections.abc import Iterable from types import TracebackType -from typing import Any, final +from typing import Any, ClassVar, final from typing_extensions import Self if sys.platform != "win32": @@ -10,7 +10,8 @@ if sys.platform != "win32": POLLERR: int POLLHUP: int POLLIN: int - POLLMSG: int + if sys.platform == "linux": + POLLMSG: int POLLNVAL: int POLLOUT: int POLLPRI: int @@ -21,11 +22,14 @@ if sys.platform != "win32": POLLWRBAND: int POLLWRNORM: int -class poll: - def register(self, fd: FileDescriptorLike, eventmask: int = ...) -> None: ... - def modify(self, fd: FileDescriptorLike, eventmask: int) -> None: ... - def unregister(self, fd: FileDescriptorLike) -> None: ... - def poll(self, timeout: float | None = ...) -> list[tuple[int, int]]: ... + # This is actually a function that returns an instance of a class. + # The class is not accessible directly, and also calls itself select.poll. + class poll: + # default value is select.POLLIN | select.POLLPRI | select.POLLOUT + def register(self, fd: FileDescriptorLike, eventmask: int = 7, /) -> None: ... + def modify(self, fd: FileDescriptorLike, eventmask: int, /) -> None: ... + def unregister(self, fd: FileDescriptorLike, /) -> None: ... + def poll(self, timeout: float | None = None, /) -> list[tuple[int, int]]: ... def select( rlist: Iterable[Any], wlist: Iterable[Any], xlist: Iterable[Any], timeout: float | None = None, / @@ -52,6 +56,7 @@ if sys.platform != "linux" and sys.platform != "win32": data: Any = ..., udata: Any = ..., ) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] # BSD only @final @@ -77,7 +82,8 @@ if sys.platform != "linux" and sys.platform != "win32": KQ_EV_ONESHOT: int KQ_EV_SYSFLAGS: int KQ_FILTER_AIO: int - KQ_FILTER_NETDEV: int + if sys.platform != "darwin": + KQ_FILTER_NETDEV: int KQ_FILTER_PROC: int KQ_FILTER_READ: int KQ_FILTER_SIGNAL: int diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/selectors.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/selectors.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/selectors.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/selectors.pyi index a857d0e242ab5..0ba843a403d8a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/selectors.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/selectors.pyi @@ -50,10 +50,12 @@ if sys.platform == "linux": class EpollSelector(_PollLikeSelector): def fileno(self) -> int: ... -class DevpollSelector(_PollLikeSelector): - def fileno(self) -> int: ... +if sys.platform != "linux" and sys.platform != "darwin" and sys.platform != "win32": + # Solaris only + class DevpollSelector(_PollLikeSelector): + def fileno(self) -> int: ... -if sys.platform != "win32": +if sys.platform != "win32" and sys.platform != "linux": class KqueueSelector(_BaseSelectorImpl): def fileno(self) -> int: ... def select(self, timeout: float | None = None) -> list[tuple[SelectorKey, _EventMask]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/shelve.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/shelve.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/shelve.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/shelve.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/shlex.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/shlex.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/shlex.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/shlex.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/shutil.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/shutil.pyi similarity index 85% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/shutil.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/shutil.pyi index dcff18d110bd8..ea2c29d4625f0 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/shutil.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/shutil.pyi @@ -1,9 +1,9 @@ import os import sys -from _typeshed import BytesPath, ExcInfo, FileDescriptorOrPath, StrOrBytesPath, StrPath, SupportsRead, SupportsWrite +from _typeshed import BytesPath, ExcInfo, FileDescriptorOrPath, MaybeNone, StrOrBytesPath, StrPath, SupportsRead, SupportsWrite from collections.abc import Callable, Iterable, Sequence from tarfile import _TarfileFilter -from typing import Any, AnyStr, NamedTuple, Protocol, TypeVar, overload +from typing import Any, AnyStr, NamedTuple, NoReturn, Protocol, TypeVar, overload from typing_extensions import TypeAlias, deprecated __all__ = [ @@ -37,9 +37,7 @@ __all__ = [ _StrOrBytesPathT = TypeVar("_StrOrBytesPathT", bound=StrOrBytesPath) _StrPathT = TypeVar("_StrPathT", bound=StrPath) -# Return value of some functions that may either return a path-like object that was passed in or -# a string -_PathReturn: TypeAlias = Any +_BytesPathT = TypeVar("_BytesPathT", bound=BytesPath) class Error(OSError): ... class SameFileError(Error): ... @@ -53,23 +51,23 @@ def copyfile(src: StrOrBytesPath, dst: _StrOrBytesPathT, *, follow_symlinks: boo def copymode(src: StrOrBytesPath, dst: StrOrBytesPath, *, follow_symlinks: bool = True) -> None: ... def copystat(src: StrOrBytesPath, dst: StrOrBytesPath, *, follow_symlinks: bool = True) -> None: ... @overload -def copy(src: StrPath, dst: StrPath, *, follow_symlinks: bool = True) -> _PathReturn: ... +def copy(src: StrPath, dst: _StrPathT, *, follow_symlinks: bool = True) -> _StrPathT | str: ... @overload -def copy(src: BytesPath, dst: BytesPath, *, follow_symlinks: bool = True) -> _PathReturn: ... +def copy(src: BytesPath, dst: _BytesPathT, *, follow_symlinks: bool = True) -> _BytesPathT | bytes: ... @overload -def copy2(src: StrPath, dst: StrPath, *, follow_symlinks: bool = True) -> _PathReturn: ... +def copy2(src: StrPath, dst: _StrPathT, *, follow_symlinks: bool = True) -> _StrPathT | str: ... @overload -def copy2(src: BytesPath, dst: BytesPath, *, follow_symlinks: bool = True) -> _PathReturn: ... +def copy2(src: BytesPath, dst: _BytesPathT, *, follow_symlinks: bool = True) -> _BytesPathT | bytes: ... def ignore_patterns(*patterns: StrPath) -> Callable[[Any, list[str]], set[str]]: ... def copytree( src: StrPath, - dst: StrPath, + dst: _StrPathT, symlinks: bool = False, ignore: None | Callable[[str, list[str]], Iterable[str]] | Callable[[StrPath, list[str]], Iterable[str]] = None, copy_function: Callable[[str, str], object] = ..., ignore_dangling_symlinks: bool = False, dirs_exist_ok: bool = False, -) -> _PathReturn: ... +) -> _StrPathT: ... _OnErrorCallback: TypeAlias = Callable[[Callable[..., Any], str, ExcInfo], object] _OnExcCallback: TypeAlias = Callable[[Callable[..., Any], str, BaseException], object] @@ -83,7 +81,7 @@ class _RmtreeType(Protocol): self, path: StrOrBytesPath, ignore_errors: bool, - onerror: _OnErrorCallback, + onerror: _OnErrorCallback | None, *, onexc: None = None, dir_fd: int | None = None, @@ -95,7 +93,7 @@ class _RmtreeType(Protocol): path: StrOrBytesPath, ignore_errors: bool = False, *, - onerror: _OnErrorCallback, + onerror: _OnErrorCallback | None, onexc: None = None, dir_fd: int | None = None, ) -> None: ... @@ -130,12 +128,7 @@ _CopyFn: TypeAlias = Callable[[str, str], object] | Callable[[StrPath, StrPath], # N.B. shutil.move appears to take bytes arguments, however, # this does not work when dst is (or is within) an existing directory. # (#6832) -if sys.version_info >= (3, 9): - def move(src: StrPath, dst: StrPath, copy_function: _CopyFn = ...) -> _PathReturn: ... - -else: - # See https://bugs.python.org/issue32689 - def move(src: str, dst: StrPath, copy_function: _CopyFn = ...) -> _PathReturn: ... +def move(src: StrPath, dst: _StrPathT, copy_function: _CopyFn = ...) -> _StrPathT | str | MaybeNone: ... class _ntuple_diskusage(NamedTuple): total: int @@ -185,8 +178,13 @@ else: @overload def chown(path: FileDescriptorOrPath, user: str | int, group: str | int) -> None: ... +if sys.platform == "win32" and sys.version_info < (3, 12): + @overload + @deprecated("On Windows before Python 3.12, using a PathLike as `cmd` would always fail or return `None`.") + def which(cmd: os.PathLike[str], mode: int = 1, path: StrPath | None = None) -> NoReturn: ... + @overload -def which(cmd: _StrPathT, mode: int = 1, path: StrPath | None = None) -> str | _StrPathT | None: ... +def which(cmd: StrPath, mode: int = 1, path: StrPath | None = None) -> str | None: ... @overload def which(cmd: bytes, mode: int = 1, path: StrPath | None = None) -> bytes | None: ... def make_archive( diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/signal.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/signal.pyi new file mode 100644 index 0000000000000..d50565d1c8ac3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/signal.pyi @@ -0,0 +1,187 @@ +import sys +from _typeshed import structseq +from collections.abc import Callable, Iterable +from enum import IntEnum +from types import FrameType +from typing import Any, Final, Literal, final +from typing_extensions import Never, TypeAlias + +NSIG: int + +class Signals(IntEnum): + SIGABRT = 6 + SIGFPE = 8 + SIGILL = 4 + SIGINT = 2 + SIGSEGV = 11 + SIGTERM = 15 + + if sys.platform == "win32": + SIGBREAK = 21 + CTRL_C_EVENT = 0 + CTRL_BREAK_EVENT = 1 + else: + SIGALRM = 14 + SIGBUS = 7 + SIGCHLD = 17 + SIGCONT = 18 + SIGHUP = 1 + SIGIO = 29 + SIGIOT = 6 + SIGKILL = 9 + SIGPIPE = 13 + SIGPROF = 27 + SIGQUIT = 3 + SIGSTOP = 19 + SIGSYS = 31 + SIGTRAP = 5 + SIGTSTP = 20 + SIGTTIN = 21 + SIGTTOU = 22 + SIGURG = 23 + SIGUSR1 = 10 + SIGUSR2 = 12 + SIGVTALRM = 26 + SIGWINCH = 28 + SIGXCPU = 24 + SIGXFSZ = 25 + if sys.platform != "linux": + SIGEMT = 7 + SIGINFO = 29 + if sys.platform != "darwin": + SIGCLD = 17 + SIGPOLL = 29 + SIGPWR = 30 + SIGRTMAX = 64 + SIGRTMIN = 34 + if sys.version_info >= (3, 11): + SIGSTKFLT = 16 + +class Handlers(IntEnum): + SIG_DFL = 0 + SIG_IGN = 1 + +SIG_DFL: Literal[Handlers.SIG_DFL] +SIG_IGN: Literal[Handlers.SIG_IGN] + +_SIGNUM: TypeAlias = int | Signals +_HANDLER: TypeAlias = Callable[[int, FrameType | None], Any] | int | Handlers | None + +def default_int_handler(signalnum: int, frame: FrameType | None, /) -> Never: ... + +if sys.version_info >= (3, 10): # arguments changed in 3.10.2 + def getsignal(signalnum: _SIGNUM) -> _HANDLER: ... + def signal(signalnum: _SIGNUM, handler: _HANDLER) -> _HANDLER: ... + +else: + def getsignal(signalnum: _SIGNUM, /) -> _HANDLER: ... + def signal(signalnum: _SIGNUM, handler: _HANDLER, /) -> _HANDLER: ... + +SIGABRT: Literal[Signals.SIGABRT] +SIGFPE: Literal[Signals.SIGFPE] +SIGILL: Literal[Signals.SIGILL] +SIGINT: Literal[Signals.SIGINT] +SIGSEGV: Literal[Signals.SIGSEGV] +SIGTERM: Literal[Signals.SIGTERM] + +if sys.platform == "win32": + SIGBREAK: Literal[Signals.SIGBREAK] + CTRL_C_EVENT: Literal[Signals.CTRL_C_EVENT] + CTRL_BREAK_EVENT: Literal[Signals.CTRL_BREAK_EVENT] +else: + if sys.platform != "linux": + SIGINFO: Literal[Signals.SIGINFO] + SIGEMT: Literal[Signals.SIGEMT] + SIGALRM: Literal[Signals.SIGALRM] + SIGBUS: Literal[Signals.SIGBUS] + SIGCHLD: Literal[Signals.SIGCHLD] + SIGCONT: Literal[Signals.SIGCONT] + SIGHUP: Literal[Signals.SIGHUP] + SIGIO: Literal[Signals.SIGIO] + SIGIOT: Literal[Signals.SIGABRT] # alias + SIGKILL: Literal[Signals.SIGKILL] + SIGPIPE: Literal[Signals.SIGPIPE] + SIGPROF: Literal[Signals.SIGPROF] + SIGQUIT: Literal[Signals.SIGQUIT] + SIGSTOP: Literal[Signals.SIGSTOP] + SIGSYS: Literal[Signals.SIGSYS] + SIGTRAP: Literal[Signals.SIGTRAP] + SIGTSTP: Literal[Signals.SIGTSTP] + SIGTTIN: Literal[Signals.SIGTTIN] + SIGTTOU: Literal[Signals.SIGTTOU] + SIGURG: Literal[Signals.SIGURG] + SIGUSR1: Literal[Signals.SIGUSR1] + SIGUSR2: Literal[Signals.SIGUSR2] + SIGVTALRM: Literal[Signals.SIGVTALRM] + SIGWINCH: Literal[Signals.SIGWINCH] + SIGXCPU: Literal[Signals.SIGXCPU] + SIGXFSZ: Literal[Signals.SIGXFSZ] + + class ItimerError(OSError): ... + ITIMER_PROF: int + ITIMER_REAL: int + ITIMER_VIRTUAL: int + + class Sigmasks(IntEnum): + SIG_BLOCK = 0 + SIG_UNBLOCK = 1 + SIG_SETMASK = 2 + + SIG_BLOCK: Literal[Sigmasks.SIG_BLOCK] + SIG_UNBLOCK: Literal[Sigmasks.SIG_UNBLOCK] + SIG_SETMASK: Literal[Sigmasks.SIG_SETMASK] + def alarm(seconds: int, /) -> int: ... + def getitimer(which: int, /) -> tuple[float, float]: ... + def pause() -> None: ... + def pthread_kill(thread_id: int, signalnum: int, /) -> None: ... + if sys.version_info >= (3, 10): # arguments changed in 3.10.2 + def pthread_sigmask(how: int, mask: Iterable[int]) -> set[_SIGNUM]: ... + else: + def pthread_sigmask(how: int, mask: Iterable[int], /) -> set[_SIGNUM]: ... + + def setitimer(which: int, seconds: float, interval: float = 0.0, /) -> tuple[float, float]: ... + def siginterrupt(signalnum: int, flag: bool, /) -> None: ... + def sigpending() -> Any: ... + if sys.version_info >= (3, 10): # argument changed in 3.10.2 + def sigwait(sigset: Iterable[int]) -> _SIGNUM: ... + else: + def sigwait(sigset: Iterable[int], /) -> _SIGNUM: ... + if sys.platform != "darwin": + SIGCLD: Literal[Signals.SIGCHLD] # alias + SIGPOLL: Literal[Signals.SIGIO] # alias + SIGPWR: Literal[Signals.SIGPWR] + SIGRTMAX: Literal[Signals.SIGRTMAX] + SIGRTMIN: Literal[Signals.SIGRTMIN] + if sys.version_info >= (3, 11): + SIGSTKFLT: Literal[Signals.SIGSTKFLT] + + @final + class struct_siginfo(structseq[int], tuple[int, int, int, int, int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("si_signo", "si_code", "si_errno", "si_pid", "si_uid", "si_status", "si_band") + + @property + def si_signo(self) -> int: ... + @property + def si_code(self) -> int: ... + @property + def si_errno(self) -> int: ... + @property + def si_pid(self) -> int: ... + @property + def si_uid(self) -> int: ... + @property + def si_status(self) -> int: ... + @property + def si_band(self) -> int: ... + + def sigtimedwait(sigset: Iterable[int], timeout: float, /) -> struct_siginfo | None: ... + def sigwaitinfo(sigset: Iterable[int], /) -> struct_siginfo: ... + +def strsignal(signalnum: _SIGNUM, /) -> str | None: ... +def valid_signals() -> set[Signals]: ... +def raise_signal(signalnum: _SIGNUM, /) -> None: ... +def set_wakeup_fd(fd: int, /, *, warn_on_full_buffer: bool = ...) -> int: ... + +if sys.platform == "linux": + def pidfd_send_signal(pidfd: int, sig: int, siginfo: None = None, flags: int = ..., /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/site.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/site.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/site.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/site.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/smtpd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/smtpd.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/smtpd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/smtpd.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/smtplib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/smtplib.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/smtplib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/smtplib.pyi index a762427bcab33..609b3e6426c4e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/smtplib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/smtplib.pyi @@ -185,20 +185,11 @@ class SMTP_SSL(SMTP): LMTP_PORT: int class LMTP(SMTP): - if sys.version_info >= (3, 9): - def __init__( - self, - host: str = "", - port: int = 2003, - local_hostname: str | None = None, - source_address: _SourceAddress | None = None, - timeout: float = ..., - ) -> None: ... - else: - def __init__( - self, - host: str = "", - port: int = 2003, - local_hostname: str | None = None, - source_address: _SourceAddress | None = None, - ) -> None: ... + def __init__( + self, + host: str = "", + port: int = 2003, + local_hostname: str | None = None, + source_address: _SourceAddress | None = None, + timeout: float = ..., + ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sndhdr.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sndhdr.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sndhdr.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sndhdr.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/socket.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/socket.pyi new file mode 100644 index 0000000000000..1ee006235ee6c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/socket.pyi @@ -0,0 +1,1429 @@ +# Ideally, we'd just do "from _socket import *". Unfortunately, socket +# overrides some definitions from _socket incompatibly. mypy incorrectly +# prefers the definitions from _socket over those defined here. +import _socket +import sys +from _socket import ( + CAPI as CAPI, + EAI_AGAIN as EAI_AGAIN, + EAI_BADFLAGS as EAI_BADFLAGS, + EAI_FAIL as EAI_FAIL, + EAI_FAMILY as EAI_FAMILY, + EAI_MEMORY as EAI_MEMORY, + EAI_NODATA as EAI_NODATA, + EAI_NONAME as EAI_NONAME, + EAI_SERVICE as EAI_SERVICE, + EAI_SOCKTYPE as EAI_SOCKTYPE, + INADDR_ALLHOSTS_GROUP as INADDR_ALLHOSTS_GROUP, + INADDR_ANY as INADDR_ANY, + INADDR_BROADCAST as INADDR_BROADCAST, + INADDR_LOOPBACK as INADDR_LOOPBACK, + INADDR_MAX_LOCAL_GROUP as INADDR_MAX_LOCAL_GROUP, + INADDR_NONE as INADDR_NONE, + INADDR_UNSPEC_GROUP as INADDR_UNSPEC_GROUP, + IP_ADD_MEMBERSHIP as IP_ADD_MEMBERSHIP, + IP_DROP_MEMBERSHIP as IP_DROP_MEMBERSHIP, + IP_HDRINCL as IP_HDRINCL, + IP_MULTICAST_IF as IP_MULTICAST_IF, + IP_MULTICAST_LOOP as IP_MULTICAST_LOOP, + IP_MULTICAST_TTL as IP_MULTICAST_TTL, + IP_OPTIONS as IP_OPTIONS, + IP_TOS as IP_TOS, + IP_TTL as IP_TTL, + IPPORT_RESERVED as IPPORT_RESERVED, + IPPORT_USERRESERVED as IPPORT_USERRESERVED, + IPPROTO_AH as IPPROTO_AH, + IPPROTO_DSTOPTS as IPPROTO_DSTOPTS, + IPPROTO_EGP as IPPROTO_EGP, + IPPROTO_ESP as IPPROTO_ESP, + IPPROTO_FRAGMENT as IPPROTO_FRAGMENT, + IPPROTO_HOPOPTS as IPPROTO_HOPOPTS, + IPPROTO_ICMP as IPPROTO_ICMP, + IPPROTO_ICMPV6 as IPPROTO_ICMPV6, + IPPROTO_IDP as IPPROTO_IDP, + IPPROTO_IGMP as IPPROTO_IGMP, + IPPROTO_IP as IPPROTO_IP, + IPPROTO_IPV6 as IPPROTO_IPV6, + IPPROTO_NONE as IPPROTO_NONE, + IPPROTO_PIM as IPPROTO_PIM, + IPPROTO_PUP as IPPROTO_PUP, + IPPROTO_RAW as IPPROTO_RAW, + IPPROTO_ROUTING as IPPROTO_ROUTING, + IPPROTO_SCTP as IPPROTO_SCTP, + IPPROTO_TCP as IPPROTO_TCP, + IPPROTO_UDP as IPPROTO_UDP, + IPV6_CHECKSUM as IPV6_CHECKSUM, + IPV6_DONTFRAG as IPV6_DONTFRAG, + IPV6_HOPLIMIT as IPV6_HOPLIMIT, + IPV6_HOPOPTS as IPV6_HOPOPTS, + IPV6_JOIN_GROUP as IPV6_JOIN_GROUP, + IPV6_LEAVE_GROUP as IPV6_LEAVE_GROUP, + IPV6_MULTICAST_HOPS as IPV6_MULTICAST_HOPS, + IPV6_MULTICAST_IF as IPV6_MULTICAST_IF, + IPV6_MULTICAST_LOOP as IPV6_MULTICAST_LOOP, + IPV6_PKTINFO as IPV6_PKTINFO, + IPV6_RECVRTHDR as IPV6_RECVRTHDR, + IPV6_RECVTCLASS as IPV6_RECVTCLASS, + IPV6_RTHDR as IPV6_RTHDR, + IPV6_TCLASS as IPV6_TCLASS, + IPV6_UNICAST_HOPS as IPV6_UNICAST_HOPS, + IPV6_V6ONLY as IPV6_V6ONLY, + NI_DGRAM as NI_DGRAM, + NI_MAXHOST as NI_MAXHOST, + NI_MAXSERV as NI_MAXSERV, + NI_NAMEREQD as NI_NAMEREQD, + NI_NOFQDN as NI_NOFQDN, + NI_NUMERICHOST as NI_NUMERICHOST, + NI_NUMERICSERV as NI_NUMERICSERV, + SHUT_RD as SHUT_RD, + SHUT_RDWR as SHUT_RDWR, + SHUT_WR as SHUT_WR, + SO_ACCEPTCONN as SO_ACCEPTCONN, + SO_BROADCAST as SO_BROADCAST, + SO_DEBUG as SO_DEBUG, + SO_DONTROUTE as SO_DONTROUTE, + SO_ERROR as SO_ERROR, + SO_KEEPALIVE as SO_KEEPALIVE, + SO_LINGER as SO_LINGER, + SO_OOBINLINE as SO_OOBINLINE, + SO_RCVBUF as SO_RCVBUF, + SO_RCVLOWAT as SO_RCVLOWAT, + SO_RCVTIMEO as SO_RCVTIMEO, + SO_REUSEADDR as SO_REUSEADDR, + SO_SNDBUF as SO_SNDBUF, + SO_SNDLOWAT as SO_SNDLOWAT, + SO_SNDTIMEO as SO_SNDTIMEO, + SO_TYPE as SO_TYPE, + SOL_IP as SOL_IP, + SOL_SOCKET as SOL_SOCKET, + SOL_TCP as SOL_TCP, + SOL_UDP as SOL_UDP, + SOMAXCONN as SOMAXCONN, + TCP_FASTOPEN as TCP_FASTOPEN, + TCP_KEEPCNT as TCP_KEEPCNT, + TCP_KEEPINTVL as TCP_KEEPINTVL, + TCP_MAXSEG as TCP_MAXSEG, + TCP_NODELAY as TCP_NODELAY, + SocketType as SocketType, + _Address as _Address, + _RetAddress as _RetAddress, + close as close, + dup as dup, + getdefaulttimeout as getdefaulttimeout, + gethostbyaddr as gethostbyaddr, + gethostbyname as gethostbyname, + gethostbyname_ex as gethostbyname_ex, + gethostname as gethostname, + getnameinfo as getnameinfo, + getprotobyname as getprotobyname, + getservbyname as getservbyname, + getservbyport as getservbyport, + has_ipv6 as has_ipv6, + htonl as htonl, + htons as htons, + if_indextoname as if_indextoname, + if_nameindex as if_nameindex, + if_nametoindex as if_nametoindex, + inet_aton as inet_aton, + inet_ntoa as inet_ntoa, + inet_ntop as inet_ntop, + inet_pton as inet_pton, + ntohl as ntohl, + ntohs as ntohs, + setdefaulttimeout as setdefaulttimeout, +) +from _typeshed import ReadableBuffer, Unused, WriteableBuffer +from collections.abc import Iterable +from enum import IntEnum, IntFlag +from io import BufferedReader, BufferedRWPair, BufferedWriter, IOBase, RawIOBase, TextIOWrapper +from typing import Any, Literal, Protocol, SupportsIndex, overload +from typing_extensions import Self + +__all__ = [ + "fromfd", + "getfqdn", + "create_connection", + "create_server", + "has_dualstack_ipv6", + "AddressFamily", + "SocketKind", + "AF_APPLETALK", + "AF_DECnet", + "AF_INET", + "AF_INET6", + "AF_IPX", + "AF_SNA", + "AF_UNSPEC", + "AI_ADDRCONFIG", + "AI_ALL", + "AI_CANONNAME", + "AI_NUMERICHOST", + "AI_NUMERICSERV", + "AI_PASSIVE", + "AI_V4MAPPED", + "CAPI", + "EAI_AGAIN", + "EAI_BADFLAGS", + "EAI_FAIL", + "EAI_FAMILY", + "EAI_MEMORY", + "EAI_NODATA", + "EAI_NONAME", + "EAI_SERVICE", + "EAI_SOCKTYPE", + "INADDR_ALLHOSTS_GROUP", + "INADDR_ANY", + "INADDR_BROADCAST", + "INADDR_LOOPBACK", + "INADDR_MAX_LOCAL_GROUP", + "INADDR_NONE", + "INADDR_UNSPEC_GROUP", + "IPPORT_RESERVED", + "IPPORT_USERRESERVED", + "IPPROTO_AH", + "IPPROTO_DSTOPTS", + "IPPROTO_EGP", + "IPPROTO_ESP", + "IPPROTO_FRAGMENT", + "IPPROTO_HOPOPTS", + "IPPROTO_ICMP", + "IPPROTO_ICMPV6", + "IPPROTO_IDP", + "IPPROTO_IGMP", + "IPPROTO_IP", + "IPPROTO_IPV6", + "IPPROTO_NONE", + "IPPROTO_PIM", + "IPPROTO_PUP", + "IPPROTO_RAW", + "IPPROTO_ROUTING", + "IPPROTO_SCTP", + "IPPROTO_TCP", + "IPPROTO_UDP", + "IPV6_CHECKSUM", + "IPV6_DONTFRAG", + "IPV6_HOPLIMIT", + "IPV6_HOPOPTS", + "IPV6_JOIN_GROUP", + "IPV6_LEAVE_GROUP", + "IPV6_MULTICAST_HOPS", + "IPV6_MULTICAST_IF", + "IPV6_MULTICAST_LOOP", + "IPV6_PKTINFO", + "IPV6_RECVRTHDR", + "IPV6_RECVTCLASS", + "IPV6_RTHDR", + "IPV6_TCLASS", + "IPV6_UNICAST_HOPS", + "IPV6_V6ONLY", + "IP_ADD_MEMBERSHIP", + "IP_DROP_MEMBERSHIP", + "IP_HDRINCL", + "IP_MULTICAST_IF", + "IP_MULTICAST_LOOP", + "IP_MULTICAST_TTL", + "IP_OPTIONS", + "IP_TOS", + "IP_TTL", + "MSG_CTRUNC", + "MSG_DONTROUTE", + "MSG_OOB", + "MSG_PEEK", + "MSG_TRUNC", + "MSG_WAITALL", + "NI_DGRAM", + "NI_MAXHOST", + "NI_MAXSERV", + "NI_NAMEREQD", + "NI_NOFQDN", + "NI_NUMERICHOST", + "NI_NUMERICSERV", + "SHUT_RD", + "SHUT_RDWR", + "SHUT_WR", + "SOCK_DGRAM", + "SOCK_RAW", + "SOCK_RDM", + "SOCK_SEQPACKET", + "SOCK_STREAM", + "SOL_IP", + "SOL_SOCKET", + "SOL_TCP", + "SOL_UDP", + "SOMAXCONN", + "SO_ACCEPTCONN", + "SO_BROADCAST", + "SO_DEBUG", + "SO_DONTROUTE", + "SO_ERROR", + "SO_KEEPALIVE", + "SO_LINGER", + "SO_OOBINLINE", + "SO_RCVBUF", + "SO_RCVLOWAT", + "SO_RCVTIMEO", + "SO_REUSEADDR", + "SO_SNDBUF", + "SO_SNDLOWAT", + "SO_SNDTIMEO", + "SO_TYPE", + "SocketType", + "TCP_FASTOPEN", + "TCP_KEEPCNT", + "TCP_KEEPINTVL", + "TCP_MAXSEG", + "TCP_NODELAY", + "close", + "dup", + "error", + "gaierror", + "getaddrinfo", + "getdefaulttimeout", + "gethostbyaddr", + "gethostbyname", + "gethostbyname_ex", + "gethostname", + "getnameinfo", + "getprotobyname", + "getservbyname", + "getservbyport", + "has_ipv6", + "herror", + "htonl", + "htons", + "if_indextoname", + "if_nameindex", + "if_nametoindex", + "inet_aton", + "inet_ntoa", + "inet_ntop", + "inet_pton", + "ntohl", + "ntohs", + "setdefaulttimeout", + "socket", + "socketpair", + "timeout", +] + +if sys.platform == "win32": + from _socket import ( + IPPROTO_CBT as IPPROTO_CBT, + IPPROTO_ICLFXBM as IPPROTO_ICLFXBM, + IPPROTO_IGP as IPPROTO_IGP, + IPPROTO_L2TP as IPPROTO_L2TP, + IPPROTO_PGM as IPPROTO_PGM, + IPPROTO_RDP as IPPROTO_RDP, + IPPROTO_ST as IPPROTO_ST, + RCVALL_MAX as RCVALL_MAX, + RCVALL_OFF as RCVALL_OFF, + RCVALL_ON as RCVALL_ON, + RCVALL_SOCKETLEVELONLY as RCVALL_SOCKETLEVELONLY, + SIO_KEEPALIVE_VALS as SIO_KEEPALIVE_VALS, + SIO_LOOPBACK_FAST_PATH as SIO_LOOPBACK_FAST_PATH, + SIO_RCVALL as SIO_RCVALL, + SO_EXCLUSIVEADDRUSE as SO_EXCLUSIVEADDRUSE, + ) + + __all__ += [ + "IPPROTO_CBT", + "IPPROTO_ICLFXBM", + "IPPROTO_IGP", + "IPPROTO_L2TP", + "IPPROTO_PGM", + "IPPROTO_RDP", + "IPPROTO_ST", + "RCVALL_MAX", + "RCVALL_OFF", + "RCVALL_ON", + "RCVALL_SOCKETLEVELONLY", + "SIO_KEEPALIVE_VALS", + "SIO_LOOPBACK_FAST_PATH", + "SIO_RCVALL", + "SO_EXCLUSIVEADDRUSE", + "fromshare", + "errorTab", + "MSG_BCAST", + "MSG_MCAST", + ] + +if sys.platform == "darwin": + from _socket import PF_SYSTEM as PF_SYSTEM, SYSPROTO_CONTROL as SYSPROTO_CONTROL + + __all__ += ["PF_SYSTEM", "SYSPROTO_CONTROL", "AF_SYSTEM"] + +if sys.platform != "darwin": + from _socket import TCP_KEEPIDLE as TCP_KEEPIDLE + + __all__ += ["TCP_KEEPIDLE", "AF_IRDA", "MSG_ERRQUEUE"] + +if sys.version_info >= (3, 10): + from _socket import IP_RECVTOS as IP_RECVTOS + + __all__ += ["IP_RECVTOS"] + +if sys.platform != "win32" and sys.platform != "darwin": + from _socket import ( + IP_TRANSPARENT as IP_TRANSPARENT, + IPX_TYPE as IPX_TYPE, + SCM_CREDENTIALS as SCM_CREDENTIALS, + SO_DOMAIN as SO_DOMAIN, + SO_MARK as SO_MARK, + SO_PASSCRED as SO_PASSCRED, + SO_PASSSEC as SO_PASSSEC, + SO_PEERCRED as SO_PEERCRED, + SO_PEERSEC as SO_PEERSEC, + SO_PRIORITY as SO_PRIORITY, + SO_PROTOCOL as SO_PROTOCOL, + SOL_ATALK as SOL_ATALK, + SOL_AX25 as SOL_AX25, + SOL_HCI as SOL_HCI, + SOL_IPX as SOL_IPX, + SOL_NETROM as SOL_NETROM, + SOL_ROSE as SOL_ROSE, + TCP_CONGESTION as TCP_CONGESTION, + TCP_CORK as TCP_CORK, + TCP_DEFER_ACCEPT as TCP_DEFER_ACCEPT, + TCP_INFO as TCP_INFO, + TCP_LINGER2 as TCP_LINGER2, + TCP_QUICKACK as TCP_QUICKACK, + TCP_SYNCNT as TCP_SYNCNT, + TCP_USER_TIMEOUT as TCP_USER_TIMEOUT, + TCP_WINDOW_CLAMP as TCP_WINDOW_CLAMP, + ) + + __all__ += [ + "IP_TRANSPARENT", + "SCM_CREDENTIALS", + "SO_DOMAIN", + "SO_MARK", + "SO_PASSCRED", + "SO_PASSSEC", + "SO_PEERCRED", + "SO_PEERSEC", + "SO_PRIORITY", + "SO_PROTOCOL", + "TCP_CONGESTION", + "TCP_CORK", + "TCP_DEFER_ACCEPT", + "TCP_INFO", + "TCP_LINGER2", + "TCP_QUICKACK", + "TCP_SYNCNT", + "TCP_USER_TIMEOUT", + "TCP_WINDOW_CLAMP", + "AF_ASH", + "AF_ATMPVC", + "AF_ATMSVC", + "AF_AX25", + "AF_BRIDGE", + "AF_ECONET", + "AF_KEY", + "AF_LLC", + "AF_NETBEUI", + "AF_NETROM", + "AF_PPPOX", + "AF_ROSE", + "AF_SECURITY", + "AF_WANPIPE", + "AF_X25", + "MSG_CMSG_CLOEXEC", + "MSG_CONFIRM", + "MSG_FASTOPEN", + "MSG_MORE", + ] + +if sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 11): + from _socket import IP_BIND_ADDRESS_NO_PORT as IP_BIND_ADDRESS_NO_PORT + + __all__ += ["IP_BIND_ADDRESS_NO_PORT"] + +if sys.platform != "win32": + from _socket import ( + CMSG_LEN as CMSG_LEN, + CMSG_SPACE as CMSG_SPACE, + EAI_ADDRFAMILY as EAI_ADDRFAMILY, + EAI_OVERFLOW as EAI_OVERFLOW, + EAI_SYSTEM as EAI_SYSTEM, + IP_DEFAULT_MULTICAST_LOOP as IP_DEFAULT_MULTICAST_LOOP, + IP_DEFAULT_MULTICAST_TTL as IP_DEFAULT_MULTICAST_TTL, + IP_MAX_MEMBERSHIPS as IP_MAX_MEMBERSHIPS, + IP_RECVOPTS as IP_RECVOPTS, + IP_RECVRETOPTS as IP_RECVRETOPTS, + IP_RETOPTS as IP_RETOPTS, + IPPROTO_GRE as IPPROTO_GRE, + IPPROTO_IPIP as IPPROTO_IPIP, + IPPROTO_RSVP as IPPROTO_RSVP, + IPPROTO_TP as IPPROTO_TP, + IPV6_RTHDR_TYPE_0 as IPV6_RTHDR_TYPE_0, + SCM_RIGHTS as SCM_RIGHTS, + SO_REUSEPORT as SO_REUSEPORT, + TCP_NOTSENT_LOWAT as TCP_NOTSENT_LOWAT, + sethostname as sethostname, + ) + + __all__ += [ + "CMSG_LEN", + "CMSG_SPACE", + "EAI_ADDRFAMILY", + "EAI_OVERFLOW", + "EAI_SYSTEM", + "IP_DEFAULT_MULTICAST_LOOP", + "IP_DEFAULT_MULTICAST_TTL", + "IP_MAX_MEMBERSHIPS", + "IP_RECVOPTS", + "IP_RECVRETOPTS", + "IP_RETOPTS", + "IPPROTO_GRE", + "IPPROTO_IPIP", + "IPPROTO_RSVP", + "IPPROTO_TP", + "IPV6_RTHDR_TYPE_0", + "SCM_RIGHTS", + "SO_REUSEPORT", + "TCP_NOTSENT_LOWAT", + "sethostname", + "AF_ROUTE", + "AF_UNIX", + "MSG_DONTWAIT", + "MSG_EOR", + "MSG_NOSIGNAL", + ] + + from _socket import ( + IPV6_DSTOPTS as IPV6_DSTOPTS, + IPV6_NEXTHOP as IPV6_NEXTHOP, + IPV6_PATHMTU as IPV6_PATHMTU, + IPV6_RECVDSTOPTS as IPV6_RECVDSTOPTS, + IPV6_RECVHOPLIMIT as IPV6_RECVHOPLIMIT, + IPV6_RECVHOPOPTS as IPV6_RECVHOPOPTS, + IPV6_RECVPATHMTU as IPV6_RECVPATHMTU, + IPV6_RECVPKTINFO as IPV6_RECVPKTINFO, + IPV6_RTHDRDSTOPTS as IPV6_RTHDRDSTOPTS, + ) + + __all__ += [ + "IPV6_DSTOPTS", + "IPV6_NEXTHOP", + "IPV6_PATHMTU", + "IPV6_RECVDSTOPTS", + "IPV6_RECVHOPLIMIT", + "IPV6_RECVHOPOPTS", + "IPV6_RECVPATHMTU", + "IPV6_RECVPKTINFO", + "IPV6_RTHDRDSTOPTS", + ] + + if sys.platform != "darwin" or sys.version_info >= (3, 13): + from _socket import SO_BINDTODEVICE as SO_BINDTODEVICE + + __all__ += ["SO_BINDTODEVICE"] + +if sys.platform != "darwin" and sys.platform != "linux": + from _socket import BDADDR_ANY as BDADDR_ANY, BDADDR_LOCAL as BDADDR_LOCAL, BTPROTO_RFCOMM as BTPROTO_RFCOMM + + __all__ += ["BDADDR_ANY", "BDADDR_LOCAL", "BTPROTO_RFCOMM"] + +if sys.platform == "darwin" and sys.version_info >= (3, 10): + from _socket import TCP_KEEPALIVE as TCP_KEEPALIVE + + __all__ += ["TCP_KEEPALIVE"] + +if sys.platform == "darwin" and sys.version_info >= (3, 11): + from _socket import TCP_CONNECTION_INFO as TCP_CONNECTION_INFO + + __all__ += ["TCP_CONNECTION_INFO"] + +if sys.platform == "linux": + from _socket import ( + ALG_OP_DECRYPT as ALG_OP_DECRYPT, + ALG_OP_ENCRYPT as ALG_OP_ENCRYPT, + ALG_OP_SIGN as ALG_OP_SIGN, + ALG_OP_VERIFY as ALG_OP_VERIFY, + ALG_SET_AEAD_ASSOCLEN as ALG_SET_AEAD_ASSOCLEN, + ALG_SET_AEAD_AUTHSIZE as ALG_SET_AEAD_AUTHSIZE, + ALG_SET_IV as ALG_SET_IV, + ALG_SET_KEY as ALG_SET_KEY, + ALG_SET_OP as ALG_SET_OP, + ALG_SET_PUBKEY as ALG_SET_PUBKEY, + CAN_BCM as CAN_BCM, + CAN_BCM_CAN_FD_FRAME as CAN_BCM_CAN_FD_FRAME, + CAN_BCM_RX_ANNOUNCE_RESUME as CAN_BCM_RX_ANNOUNCE_RESUME, + CAN_BCM_RX_CHANGED as CAN_BCM_RX_CHANGED, + CAN_BCM_RX_CHECK_DLC as CAN_BCM_RX_CHECK_DLC, + CAN_BCM_RX_DELETE as CAN_BCM_RX_DELETE, + CAN_BCM_RX_FILTER_ID as CAN_BCM_RX_FILTER_ID, + CAN_BCM_RX_NO_AUTOTIMER as CAN_BCM_RX_NO_AUTOTIMER, + CAN_BCM_RX_READ as CAN_BCM_RX_READ, + CAN_BCM_RX_RTR_FRAME as CAN_BCM_RX_RTR_FRAME, + CAN_BCM_RX_SETUP as CAN_BCM_RX_SETUP, + CAN_BCM_RX_STATUS as CAN_BCM_RX_STATUS, + CAN_BCM_RX_TIMEOUT as CAN_BCM_RX_TIMEOUT, + CAN_BCM_SETTIMER as CAN_BCM_SETTIMER, + CAN_BCM_STARTTIMER as CAN_BCM_STARTTIMER, + CAN_BCM_TX_ANNOUNCE as CAN_BCM_TX_ANNOUNCE, + CAN_BCM_TX_COUNTEVT as CAN_BCM_TX_COUNTEVT, + CAN_BCM_TX_CP_CAN_ID as CAN_BCM_TX_CP_CAN_ID, + CAN_BCM_TX_DELETE as CAN_BCM_TX_DELETE, + CAN_BCM_TX_EXPIRED as CAN_BCM_TX_EXPIRED, + CAN_BCM_TX_READ as CAN_BCM_TX_READ, + CAN_BCM_TX_RESET_MULTI_IDX as CAN_BCM_TX_RESET_MULTI_IDX, + CAN_BCM_TX_SEND as CAN_BCM_TX_SEND, + CAN_BCM_TX_SETUP as CAN_BCM_TX_SETUP, + CAN_BCM_TX_STATUS as CAN_BCM_TX_STATUS, + CAN_EFF_FLAG as CAN_EFF_FLAG, + CAN_EFF_MASK as CAN_EFF_MASK, + CAN_ERR_FLAG as CAN_ERR_FLAG, + CAN_ERR_MASK as CAN_ERR_MASK, + CAN_ISOTP as CAN_ISOTP, + CAN_RAW as CAN_RAW, + CAN_RAW_FD_FRAMES as CAN_RAW_FD_FRAMES, + CAN_RAW_FILTER as CAN_RAW_FILTER, + CAN_RAW_LOOPBACK as CAN_RAW_LOOPBACK, + CAN_RAW_RECV_OWN_MSGS as CAN_RAW_RECV_OWN_MSGS, + CAN_RTR_FLAG as CAN_RTR_FLAG, + CAN_SFF_MASK as CAN_SFF_MASK, + IOCTL_VM_SOCKETS_GET_LOCAL_CID as IOCTL_VM_SOCKETS_GET_LOCAL_CID, + NETLINK_CRYPTO as NETLINK_CRYPTO, + NETLINK_DNRTMSG as NETLINK_DNRTMSG, + NETLINK_FIREWALL as NETLINK_FIREWALL, + NETLINK_IP6_FW as NETLINK_IP6_FW, + NETLINK_NFLOG as NETLINK_NFLOG, + NETLINK_ROUTE as NETLINK_ROUTE, + NETLINK_USERSOCK as NETLINK_USERSOCK, + NETLINK_XFRM as NETLINK_XFRM, + PACKET_BROADCAST as PACKET_BROADCAST, + PACKET_FASTROUTE as PACKET_FASTROUTE, + PACKET_HOST as PACKET_HOST, + PACKET_LOOPBACK as PACKET_LOOPBACK, + PACKET_MULTICAST as PACKET_MULTICAST, + PACKET_OTHERHOST as PACKET_OTHERHOST, + PACKET_OUTGOING as PACKET_OUTGOING, + PF_CAN as PF_CAN, + PF_PACKET as PF_PACKET, + PF_RDS as PF_RDS, + RDS_CANCEL_SENT_TO as RDS_CANCEL_SENT_TO, + RDS_CMSG_RDMA_ARGS as RDS_CMSG_RDMA_ARGS, + RDS_CMSG_RDMA_DEST as RDS_CMSG_RDMA_DEST, + RDS_CMSG_RDMA_MAP as RDS_CMSG_RDMA_MAP, + RDS_CMSG_RDMA_STATUS as RDS_CMSG_RDMA_STATUS, + RDS_CONG_MONITOR as RDS_CONG_MONITOR, + RDS_FREE_MR as RDS_FREE_MR, + RDS_GET_MR as RDS_GET_MR, + RDS_GET_MR_FOR_DEST as RDS_GET_MR_FOR_DEST, + RDS_RDMA_DONTWAIT as RDS_RDMA_DONTWAIT, + RDS_RDMA_FENCE as RDS_RDMA_FENCE, + RDS_RDMA_INVALIDATE as RDS_RDMA_INVALIDATE, + RDS_RDMA_NOTIFY_ME as RDS_RDMA_NOTIFY_ME, + RDS_RDMA_READWRITE as RDS_RDMA_READWRITE, + RDS_RDMA_SILENT as RDS_RDMA_SILENT, + RDS_RDMA_USE_ONCE as RDS_RDMA_USE_ONCE, + RDS_RECVERR as RDS_RECVERR, + SO_VM_SOCKETS_BUFFER_MAX_SIZE as SO_VM_SOCKETS_BUFFER_MAX_SIZE, + SO_VM_SOCKETS_BUFFER_MIN_SIZE as SO_VM_SOCKETS_BUFFER_MIN_SIZE, + SO_VM_SOCKETS_BUFFER_SIZE as SO_VM_SOCKETS_BUFFER_SIZE, + SOL_ALG as SOL_ALG, + SOL_CAN_BASE as SOL_CAN_BASE, + SOL_CAN_RAW as SOL_CAN_RAW, + SOL_RDS as SOL_RDS, + SOL_TIPC as SOL_TIPC, + TIPC_ADDR_ID as TIPC_ADDR_ID, + TIPC_ADDR_NAME as TIPC_ADDR_NAME, + TIPC_ADDR_NAMESEQ as TIPC_ADDR_NAMESEQ, + TIPC_CFG_SRV as TIPC_CFG_SRV, + TIPC_CLUSTER_SCOPE as TIPC_CLUSTER_SCOPE, + TIPC_CONN_TIMEOUT as TIPC_CONN_TIMEOUT, + TIPC_CRITICAL_IMPORTANCE as TIPC_CRITICAL_IMPORTANCE, + TIPC_DEST_DROPPABLE as TIPC_DEST_DROPPABLE, + TIPC_HIGH_IMPORTANCE as TIPC_HIGH_IMPORTANCE, + TIPC_IMPORTANCE as TIPC_IMPORTANCE, + TIPC_LOW_IMPORTANCE as TIPC_LOW_IMPORTANCE, + TIPC_MEDIUM_IMPORTANCE as TIPC_MEDIUM_IMPORTANCE, + TIPC_NODE_SCOPE as TIPC_NODE_SCOPE, + TIPC_PUBLISHED as TIPC_PUBLISHED, + TIPC_SRC_DROPPABLE as TIPC_SRC_DROPPABLE, + TIPC_SUB_CANCEL as TIPC_SUB_CANCEL, + TIPC_SUB_PORTS as TIPC_SUB_PORTS, + TIPC_SUB_SERVICE as TIPC_SUB_SERVICE, + TIPC_SUBSCR_TIMEOUT as TIPC_SUBSCR_TIMEOUT, + TIPC_TOP_SRV as TIPC_TOP_SRV, + TIPC_WAIT_FOREVER as TIPC_WAIT_FOREVER, + TIPC_WITHDRAWN as TIPC_WITHDRAWN, + TIPC_ZONE_SCOPE as TIPC_ZONE_SCOPE, + VM_SOCKETS_INVALID_VERSION as VM_SOCKETS_INVALID_VERSION, + VMADDR_CID_ANY as VMADDR_CID_ANY, + VMADDR_CID_HOST as VMADDR_CID_HOST, + VMADDR_PORT_ANY as VMADDR_PORT_ANY, + ) + + __all__ += [ + "ALG_OP_DECRYPT", + "ALG_OP_ENCRYPT", + "ALG_OP_SIGN", + "ALG_OP_VERIFY", + "ALG_SET_AEAD_ASSOCLEN", + "ALG_SET_AEAD_AUTHSIZE", + "ALG_SET_IV", + "ALG_SET_KEY", + "ALG_SET_OP", + "ALG_SET_PUBKEY", + "CAN_BCM", + "CAN_BCM_CAN_FD_FRAME", + "CAN_BCM_RX_ANNOUNCE_RESUME", + "CAN_BCM_RX_CHANGED", + "CAN_BCM_RX_CHECK_DLC", + "CAN_BCM_RX_DELETE", + "CAN_BCM_RX_FILTER_ID", + "CAN_BCM_RX_NO_AUTOTIMER", + "CAN_BCM_RX_READ", + "CAN_BCM_RX_RTR_FRAME", + "CAN_BCM_RX_SETUP", + "CAN_BCM_RX_STATUS", + "CAN_BCM_RX_TIMEOUT", + "CAN_BCM_SETTIMER", + "CAN_BCM_STARTTIMER", + "CAN_BCM_TX_ANNOUNCE", + "CAN_BCM_TX_COUNTEVT", + "CAN_BCM_TX_CP_CAN_ID", + "CAN_BCM_TX_DELETE", + "CAN_BCM_TX_EXPIRED", + "CAN_BCM_TX_READ", + "CAN_BCM_TX_RESET_MULTI_IDX", + "CAN_BCM_TX_SEND", + "CAN_BCM_TX_SETUP", + "CAN_BCM_TX_STATUS", + "CAN_EFF_FLAG", + "CAN_EFF_MASK", + "CAN_ERR_FLAG", + "CAN_ERR_MASK", + "CAN_ISOTP", + "CAN_RAW", + "CAN_RAW_FD_FRAMES", + "CAN_RAW_FILTER", + "CAN_RAW_LOOPBACK", + "CAN_RAW_RECV_OWN_MSGS", + "CAN_RTR_FLAG", + "CAN_SFF_MASK", + "IOCTL_VM_SOCKETS_GET_LOCAL_CID", + "NETLINK_CRYPTO", + "NETLINK_DNRTMSG", + "NETLINK_FIREWALL", + "NETLINK_IP6_FW", + "NETLINK_NFLOG", + "NETLINK_ROUTE", + "NETLINK_USERSOCK", + "NETLINK_XFRM", + "PACKET_BROADCAST", + "PACKET_FASTROUTE", + "PACKET_HOST", + "PACKET_LOOPBACK", + "PACKET_MULTICAST", + "PACKET_OTHERHOST", + "PACKET_OUTGOING", + "PF_CAN", + "PF_PACKET", + "PF_RDS", + "SO_VM_SOCKETS_BUFFER_MAX_SIZE", + "SO_VM_SOCKETS_BUFFER_MIN_SIZE", + "SO_VM_SOCKETS_BUFFER_SIZE", + "SOL_ALG", + "SOL_CAN_BASE", + "SOL_CAN_RAW", + "SOL_RDS", + "SOL_TIPC", + "TIPC_ADDR_ID", + "TIPC_ADDR_NAME", + "TIPC_ADDR_NAMESEQ", + "TIPC_CFG_SRV", + "TIPC_CLUSTER_SCOPE", + "TIPC_CONN_TIMEOUT", + "TIPC_CRITICAL_IMPORTANCE", + "TIPC_DEST_DROPPABLE", + "TIPC_HIGH_IMPORTANCE", + "TIPC_IMPORTANCE", + "TIPC_LOW_IMPORTANCE", + "TIPC_MEDIUM_IMPORTANCE", + "TIPC_NODE_SCOPE", + "TIPC_PUBLISHED", + "TIPC_SRC_DROPPABLE", + "TIPC_SUB_CANCEL", + "TIPC_SUB_PORTS", + "TIPC_SUB_SERVICE", + "TIPC_SUBSCR_TIMEOUT", + "TIPC_TOP_SRV", + "TIPC_WAIT_FOREVER", + "TIPC_WITHDRAWN", + "TIPC_ZONE_SCOPE", + "VM_SOCKETS_INVALID_VERSION", + "VMADDR_CID_ANY", + "VMADDR_CID_HOST", + "VMADDR_PORT_ANY", + "AF_CAN", + "AF_PACKET", + "AF_RDS", + "AF_TIPC", + "AF_ALG", + "AF_NETLINK", + "AF_VSOCK", + "AF_QIPCRTR", + "SOCK_CLOEXEC", + "SOCK_NONBLOCK", + ] + + if sys.version_info < (3, 11): + from _socket import CAN_RAW_ERR_FILTER as CAN_RAW_ERR_FILTER + + __all__ += ["CAN_RAW_ERR_FILTER"] + +if sys.platform == "linux": + from _socket import ( + CAN_J1939 as CAN_J1939, + CAN_RAW_JOIN_FILTERS as CAN_RAW_JOIN_FILTERS, + IPPROTO_UDPLITE as IPPROTO_UDPLITE, + J1939_EE_INFO_NONE as J1939_EE_INFO_NONE, + J1939_EE_INFO_TX_ABORT as J1939_EE_INFO_TX_ABORT, + J1939_FILTER_MAX as J1939_FILTER_MAX, + J1939_IDLE_ADDR as J1939_IDLE_ADDR, + J1939_MAX_UNICAST_ADDR as J1939_MAX_UNICAST_ADDR, + J1939_NLA_BYTES_ACKED as J1939_NLA_BYTES_ACKED, + J1939_NLA_PAD as J1939_NLA_PAD, + J1939_NO_ADDR as J1939_NO_ADDR, + J1939_NO_NAME as J1939_NO_NAME, + J1939_NO_PGN as J1939_NO_PGN, + J1939_PGN_ADDRESS_CLAIMED as J1939_PGN_ADDRESS_CLAIMED, + J1939_PGN_ADDRESS_COMMANDED as J1939_PGN_ADDRESS_COMMANDED, + J1939_PGN_MAX as J1939_PGN_MAX, + J1939_PGN_PDU1_MAX as J1939_PGN_PDU1_MAX, + J1939_PGN_REQUEST as J1939_PGN_REQUEST, + SCM_J1939_DEST_ADDR as SCM_J1939_DEST_ADDR, + SCM_J1939_DEST_NAME as SCM_J1939_DEST_NAME, + SCM_J1939_ERRQUEUE as SCM_J1939_ERRQUEUE, + SCM_J1939_PRIO as SCM_J1939_PRIO, + SO_J1939_ERRQUEUE as SO_J1939_ERRQUEUE, + SO_J1939_FILTER as SO_J1939_FILTER, + SO_J1939_PROMISC as SO_J1939_PROMISC, + SO_J1939_SEND_PRIO as SO_J1939_SEND_PRIO, + UDPLITE_RECV_CSCOV as UDPLITE_RECV_CSCOV, + UDPLITE_SEND_CSCOV as UDPLITE_SEND_CSCOV, + ) + + __all__ += [ + "CAN_J1939", + "CAN_RAW_JOIN_FILTERS", + "IPPROTO_UDPLITE", + "J1939_EE_INFO_NONE", + "J1939_EE_INFO_TX_ABORT", + "J1939_FILTER_MAX", + "J1939_IDLE_ADDR", + "J1939_MAX_UNICAST_ADDR", + "J1939_NLA_BYTES_ACKED", + "J1939_NLA_PAD", + "J1939_NO_ADDR", + "J1939_NO_NAME", + "J1939_NO_PGN", + "J1939_PGN_ADDRESS_CLAIMED", + "J1939_PGN_ADDRESS_COMMANDED", + "J1939_PGN_MAX", + "J1939_PGN_PDU1_MAX", + "J1939_PGN_REQUEST", + "SCM_J1939_DEST_ADDR", + "SCM_J1939_DEST_NAME", + "SCM_J1939_ERRQUEUE", + "SCM_J1939_PRIO", + "SO_J1939_ERRQUEUE", + "SO_J1939_FILTER", + "SO_J1939_PROMISC", + "SO_J1939_SEND_PRIO", + "UDPLITE_RECV_CSCOV", + "UDPLITE_SEND_CSCOV", + ] +if sys.platform == "linux" and sys.version_info >= (3, 10): + from _socket import IPPROTO_MPTCP as IPPROTO_MPTCP + + __all__ += ["IPPROTO_MPTCP"] +if sys.platform == "linux" and sys.version_info >= (3, 11): + from _socket import SO_INCOMING_CPU as SO_INCOMING_CPU + + __all__ += ["SO_INCOMING_CPU"] +if sys.platform == "linux" and sys.version_info >= (3, 12): + from _socket import ( + TCP_CC_INFO as TCP_CC_INFO, + TCP_FASTOPEN_CONNECT as TCP_FASTOPEN_CONNECT, + TCP_FASTOPEN_KEY as TCP_FASTOPEN_KEY, + TCP_FASTOPEN_NO_COOKIE as TCP_FASTOPEN_NO_COOKIE, + TCP_INQ as TCP_INQ, + TCP_MD5SIG as TCP_MD5SIG, + TCP_MD5SIG_EXT as TCP_MD5SIG_EXT, + TCP_QUEUE_SEQ as TCP_QUEUE_SEQ, + TCP_REPAIR as TCP_REPAIR, + TCP_REPAIR_OPTIONS as TCP_REPAIR_OPTIONS, + TCP_REPAIR_QUEUE as TCP_REPAIR_QUEUE, + TCP_REPAIR_WINDOW as TCP_REPAIR_WINDOW, + TCP_SAVE_SYN as TCP_SAVE_SYN, + TCP_SAVED_SYN as TCP_SAVED_SYN, + TCP_THIN_DUPACK as TCP_THIN_DUPACK, + TCP_THIN_LINEAR_TIMEOUTS as TCP_THIN_LINEAR_TIMEOUTS, + TCP_TIMESTAMP as TCP_TIMESTAMP, + TCP_TX_DELAY as TCP_TX_DELAY, + TCP_ULP as TCP_ULP, + TCP_ZEROCOPY_RECEIVE as TCP_ZEROCOPY_RECEIVE, + ) + + __all__ += [ + "TCP_CC_INFO", + "TCP_FASTOPEN_CONNECT", + "TCP_FASTOPEN_KEY", + "TCP_FASTOPEN_NO_COOKIE", + "TCP_INQ", + "TCP_MD5SIG", + "TCP_MD5SIG_EXT", + "TCP_QUEUE_SEQ", + "TCP_REPAIR", + "TCP_REPAIR_OPTIONS", + "TCP_REPAIR_QUEUE", + "TCP_REPAIR_WINDOW", + "TCP_SAVED_SYN", + "TCP_SAVE_SYN", + "TCP_THIN_DUPACK", + "TCP_THIN_LINEAR_TIMEOUTS", + "TCP_TIMESTAMP", + "TCP_TX_DELAY", + "TCP_ULP", + "TCP_ZEROCOPY_RECEIVE", + ] + +if sys.platform == "linux" and sys.version_info >= (3, 13): + from _socket import NI_IDN as NI_IDN, SO_BINDTOIFINDEX as SO_BINDTOIFINDEX + + __all__ += ["NI_IDN", "SO_BINDTOIFINDEX"] + +if sys.version_info >= (3, 12): + from _socket import ( + IP_ADD_SOURCE_MEMBERSHIP as IP_ADD_SOURCE_MEMBERSHIP, + IP_BLOCK_SOURCE as IP_BLOCK_SOURCE, + IP_DROP_SOURCE_MEMBERSHIP as IP_DROP_SOURCE_MEMBERSHIP, + IP_PKTINFO as IP_PKTINFO, + IP_UNBLOCK_SOURCE as IP_UNBLOCK_SOURCE, + ) + + __all__ += ["IP_ADD_SOURCE_MEMBERSHIP", "IP_BLOCK_SOURCE", "IP_DROP_SOURCE_MEMBERSHIP", "IP_PKTINFO", "IP_UNBLOCK_SOURCE"] + + if sys.platform == "win32": + from _socket import ( + HV_GUID_BROADCAST as HV_GUID_BROADCAST, + HV_GUID_CHILDREN as HV_GUID_CHILDREN, + HV_GUID_LOOPBACK as HV_GUID_LOOPBACK, + HV_GUID_PARENT as HV_GUID_PARENT, + HV_GUID_WILDCARD as HV_GUID_WILDCARD, + HV_GUID_ZERO as HV_GUID_ZERO, + HV_PROTOCOL_RAW as HV_PROTOCOL_RAW, + HVSOCKET_ADDRESS_FLAG_PASSTHRU as HVSOCKET_ADDRESS_FLAG_PASSTHRU, + HVSOCKET_CONNECT_TIMEOUT as HVSOCKET_CONNECT_TIMEOUT, + HVSOCKET_CONNECT_TIMEOUT_MAX as HVSOCKET_CONNECT_TIMEOUT_MAX, + HVSOCKET_CONNECTED_SUSPEND as HVSOCKET_CONNECTED_SUSPEND, + ) + + __all__ += [ + "HV_GUID_BROADCAST", + "HV_GUID_CHILDREN", + "HV_GUID_LOOPBACK", + "HV_GUID_PARENT", + "HV_GUID_WILDCARD", + "HV_GUID_ZERO", + "HV_PROTOCOL_RAW", + "HVSOCKET_ADDRESS_FLAG_PASSTHRU", + "HVSOCKET_CONNECT_TIMEOUT", + "HVSOCKET_CONNECT_TIMEOUT_MAX", + "HVSOCKET_CONNECTED_SUSPEND", + ] + else: + from _socket import ( + ETHERTYPE_ARP as ETHERTYPE_ARP, + ETHERTYPE_IP as ETHERTYPE_IP, + ETHERTYPE_IPV6 as ETHERTYPE_IPV6, + ETHERTYPE_VLAN as ETHERTYPE_VLAN, + ) + + __all__ += ["ETHERTYPE_ARP", "ETHERTYPE_IP", "ETHERTYPE_IPV6", "ETHERTYPE_VLAN"] + + if sys.platform == "linux": + from _socket import ETH_P_ALL as ETH_P_ALL + + __all__ += ["ETH_P_ALL"] + + if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin": + # FreeBSD >= 14.0 + from _socket import PF_DIVERT as PF_DIVERT + + __all__ += ["PF_DIVERT", "AF_DIVERT"] + +if sys.platform != "win32": + __all__ += ["send_fds", "recv_fds"] + +if sys.platform != "linux": + __all__ += ["AF_LINK"] +if sys.platform != "darwin" and sys.platform != "linux": + __all__ += ["AF_BLUETOOTH"] + +if sys.platform == "win32" and sys.version_info >= (3, 12): + __all__ += ["AF_HYPERV"] + +if sys.platform != "win32" and sys.platform != "linux": + from _socket import ( + EAI_BADHINTS as EAI_BADHINTS, + EAI_MAX as EAI_MAX, + EAI_PROTOCOL as EAI_PROTOCOL, + IPPROTO_EON as IPPROTO_EON, + IPPROTO_HELLO as IPPROTO_HELLO, + IPPROTO_IPCOMP as IPPROTO_IPCOMP, + IPPROTO_XTP as IPPROTO_XTP, + IPV6_USE_MIN_MTU as IPV6_USE_MIN_MTU, + LOCAL_PEERCRED as LOCAL_PEERCRED, + SCM_CREDS as SCM_CREDS, + ) + + __all__ += [ + "EAI_BADHINTS", + "EAI_MAX", + "EAI_PROTOCOL", + "IPPROTO_EON", + "IPPROTO_HELLO", + "IPPROTO_IPCOMP", + "IPPROTO_XTP", + "IPV6_USE_MIN_MTU", + "LOCAL_PEERCRED", + "SCM_CREDS", + "AI_DEFAULT", + "AI_MASK", + "AI_V4MAPPED_CFG", + "MSG_EOF", + ] + +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": + from _socket import ( + IPPROTO_BIP as IPPROTO_BIP, + IPPROTO_MOBILE as IPPROTO_MOBILE, + IPPROTO_VRRP as IPPROTO_VRRP, + MSG_BTAG as MSG_BTAG, + MSG_ETAG as MSG_ETAG, + SO_SETFIB as SO_SETFIB, + ) + + __all__ += ["SO_SETFIB", "MSG_BTAG", "MSG_ETAG", "IPPROTO_BIP", "IPPROTO_MOBILE", "IPPROTO_VRRP", "MSG_NOTIFICATION"] + +if sys.platform != "linux": + from _socket import ( + IP_RECVDSTADDR as IP_RECVDSTADDR, + IPPROTO_GGP as IPPROTO_GGP, + IPPROTO_IPV4 as IPPROTO_IPV4, + IPPROTO_MAX as IPPROTO_MAX, + IPPROTO_ND as IPPROTO_ND, + SO_USELOOPBACK as SO_USELOOPBACK, + ) + + __all__ += ["IPPROTO_GGP", "IPPROTO_IPV4", "IPPROTO_MAX", "IPPROTO_ND", "IP_RECVDSTADDR", "SO_USELOOPBACK"] + +if sys.version_info >= (3, 14): + from _socket import IP_RECVTTL as IP_RECVTTL + + __all__ += ["IP_RECVTTL"] + + if sys.platform == "win32" or sys.platform == "linux": + from _socket import IP_RECVERR as IP_RECVERR, IPV6_RECVERR as IPV6_RECVERR, SO_ORIGINAL_DST as SO_ORIGINAL_DST + + __all__ += ["IP_RECVERR", "IPV6_RECVERR", "SO_ORIGINAL_DST"] + + if sys.platform == "win32": + from _socket import ( + SO_BTH_ENCRYPT as SO_BTH_ENCRYPT, + SO_BTH_MTU as SO_BTH_MTU, + SO_BTH_MTU_MAX as SO_BTH_MTU_MAX, + SO_BTH_MTU_MIN as SO_BTH_MTU_MIN, + SOL_RFCOMM as SOL_RFCOMM, + TCP_QUICKACK as TCP_QUICKACK, + ) + + __all__ += ["SOL_RFCOMM", "SO_BTH_ENCRYPT", "SO_BTH_MTU", "SO_BTH_MTU_MAX", "SO_BTH_MTU_MIN", "TCP_QUICKACK"] + + if sys.platform == "linux": + from _socket import ( + CAN_RAW_ERR_FILTER as CAN_RAW_ERR_FILTER, + IP_FREEBIND as IP_FREEBIND, + IP_RECVORIGDSTADDR as IP_RECVORIGDSTADDR, + SO_ORIGINAL_DST as SO_ORIGINAL_DST, + VMADDR_CID_LOCAL as VMADDR_CID_LOCAL, + ) + + __all__ += ["CAN_RAW_ERR_FILTER", "IP_FREEBIND", "IP_RECVORIGDSTADDR", "VMADDR_CID_LOCAL"] + +# Re-exported from errno +EBADF: int +EAGAIN: int +EWOULDBLOCK: int + +# These errors are implemented in _socket at runtime +# but they consider themselves to live in socket so we'll put them here. +error = OSError + +class herror(error): ... +class gaierror(error): ... + +if sys.version_info >= (3, 10): + timeout = TimeoutError +else: + class timeout(error): ... + +class AddressFamily(IntEnum): + AF_INET = 2 + AF_INET6 = 10 + AF_APPLETALK = 5 + AF_IPX = 4 + AF_SNA = 22 + AF_UNSPEC = 0 + if sys.platform != "darwin": + AF_IRDA = 23 + if sys.platform != "win32": + AF_ROUTE = 16 + AF_UNIX = 1 + if sys.platform == "darwin": + AF_SYSTEM = 32 + if sys.platform != "win32" and sys.platform != "darwin": + AF_ASH = 18 + AF_ATMPVC = 8 + AF_ATMSVC = 20 + AF_AX25 = 3 + AF_BRIDGE = 7 + AF_ECONET = 19 + AF_KEY = 15 + AF_LLC = 26 + AF_NETBEUI = 13 + AF_NETROM = 6 + AF_PPPOX = 24 + AF_ROSE = 11 + AF_SECURITY = 14 + AF_WANPIPE = 25 + AF_X25 = 9 + if sys.platform == "linux": + AF_CAN = 29 + AF_PACKET = 17 + AF_RDS = 21 + AF_TIPC = 30 + AF_ALG = 38 + AF_NETLINK = 16 + AF_VSOCK = 40 + AF_QIPCRTR = 42 + if sys.platform != "linux": + AF_LINK = 33 + if sys.platform != "darwin" and sys.platform != "linux": + AF_BLUETOOTH = 32 + if sys.platform == "win32" and sys.version_info >= (3, 12): + AF_HYPERV = 34 + if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 12): + # FreeBSD >= 14.0 + AF_DIVERT = 44 + +AF_INET = AddressFamily.AF_INET +AF_INET6 = AddressFamily.AF_INET6 +AF_APPLETALK = AddressFamily.AF_APPLETALK +AF_DECnet: Literal[12] +AF_IPX = AddressFamily.AF_IPX +AF_SNA = AddressFamily.AF_SNA +AF_UNSPEC = AddressFamily.AF_UNSPEC + +if sys.platform != "darwin": + AF_IRDA = AddressFamily.AF_IRDA + +if sys.platform != "win32": + AF_ROUTE = AddressFamily.AF_ROUTE + AF_UNIX = AddressFamily.AF_UNIX + +if sys.platform == "darwin": + AF_SYSTEM = AddressFamily.AF_SYSTEM + +if sys.platform != "win32" and sys.platform != "darwin": + AF_ASH = AddressFamily.AF_ASH + AF_ATMPVC = AddressFamily.AF_ATMPVC + AF_ATMSVC = AddressFamily.AF_ATMSVC + AF_AX25 = AddressFamily.AF_AX25 + AF_BRIDGE = AddressFamily.AF_BRIDGE + AF_ECONET = AddressFamily.AF_ECONET + AF_KEY = AddressFamily.AF_KEY + AF_LLC = AddressFamily.AF_LLC + AF_NETBEUI = AddressFamily.AF_NETBEUI + AF_NETROM = AddressFamily.AF_NETROM + AF_PPPOX = AddressFamily.AF_PPPOX + AF_ROSE = AddressFamily.AF_ROSE + AF_SECURITY = AddressFamily.AF_SECURITY + AF_WANPIPE = AddressFamily.AF_WANPIPE + AF_X25 = AddressFamily.AF_X25 + +if sys.platform == "linux": + AF_CAN = AddressFamily.AF_CAN + AF_PACKET = AddressFamily.AF_PACKET + AF_RDS = AddressFamily.AF_RDS + AF_TIPC = AddressFamily.AF_TIPC + AF_ALG = AddressFamily.AF_ALG + AF_NETLINK = AddressFamily.AF_NETLINK + AF_VSOCK = AddressFamily.AF_VSOCK + AF_QIPCRTR = AddressFamily.AF_QIPCRTR + +if sys.platform != "linux": + AF_LINK = AddressFamily.AF_LINK +if sys.platform != "darwin" and sys.platform != "linux": + AF_BLUETOOTH = AddressFamily.AF_BLUETOOTH +if sys.platform == "win32" and sys.version_info >= (3, 12): + AF_HYPERV = AddressFamily.AF_HYPERV +if sys.platform != "linux" and sys.platform != "win32" and sys.platform != "darwin" and sys.version_info >= (3, 12): + # FreeBSD >= 14.0 + AF_DIVERT = AddressFamily.AF_DIVERT + +class SocketKind(IntEnum): + SOCK_STREAM = 1 + SOCK_DGRAM = 2 + SOCK_RAW = 3 + SOCK_RDM = 4 + SOCK_SEQPACKET = 5 + if sys.platform == "linux": + SOCK_CLOEXEC = 524288 + SOCK_NONBLOCK = 2048 + +SOCK_STREAM = SocketKind.SOCK_STREAM +SOCK_DGRAM = SocketKind.SOCK_DGRAM +SOCK_RAW = SocketKind.SOCK_RAW +SOCK_RDM = SocketKind.SOCK_RDM +SOCK_SEQPACKET = SocketKind.SOCK_SEQPACKET +if sys.platform == "linux": + SOCK_CLOEXEC = SocketKind.SOCK_CLOEXEC + SOCK_NONBLOCK = SocketKind.SOCK_NONBLOCK + +class MsgFlag(IntFlag): + MSG_CTRUNC = 8 + MSG_DONTROUTE = 4 + MSG_OOB = 1 + MSG_PEEK = 2 + MSG_TRUNC = 32 + MSG_WAITALL = 256 + if sys.platform == "win32": + MSG_BCAST = 1024 + MSG_MCAST = 2048 + + if sys.platform != "darwin": + MSG_ERRQUEUE = 8192 + + if sys.platform != "win32" and sys.platform != "darwin": + MSG_CMSG_CLOEXEC = 1073741821 + MSG_CONFIRM = 2048 + MSG_FASTOPEN = 536870912 + MSG_MORE = 32768 + + if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": + MSG_NOTIFICATION = 8192 + + if sys.platform != "win32": + MSG_DONTWAIT = 64 + MSG_EOR = 128 + MSG_NOSIGNAL = 16384 # sometimes this exists on darwin, sometimes not + if sys.platform != "win32" and sys.platform != "linux": + MSG_EOF = 256 + +MSG_CTRUNC = MsgFlag.MSG_CTRUNC +MSG_DONTROUTE = MsgFlag.MSG_DONTROUTE +MSG_OOB = MsgFlag.MSG_OOB +MSG_PEEK = MsgFlag.MSG_PEEK +MSG_TRUNC = MsgFlag.MSG_TRUNC +MSG_WAITALL = MsgFlag.MSG_WAITALL + +if sys.platform == "win32": + MSG_BCAST = MsgFlag.MSG_BCAST + MSG_MCAST = MsgFlag.MSG_MCAST + +if sys.platform != "darwin": + MSG_ERRQUEUE = MsgFlag.MSG_ERRQUEUE + +if sys.platform != "win32": + MSG_DONTWAIT = MsgFlag.MSG_DONTWAIT + MSG_EOR = MsgFlag.MSG_EOR + MSG_NOSIGNAL = MsgFlag.MSG_NOSIGNAL # Sometimes this exists on darwin, sometimes not + +if sys.platform != "win32" and sys.platform != "darwin": + MSG_CMSG_CLOEXEC = MsgFlag.MSG_CMSG_CLOEXEC + MSG_CONFIRM = MsgFlag.MSG_CONFIRM + MSG_FASTOPEN = MsgFlag.MSG_FASTOPEN + MSG_MORE = MsgFlag.MSG_MORE + +if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux": + MSG_NOTIFICATION = MsgFlag.MSG_NOTIFICATION + +if sys.platform != "win32" and sys.platform != "linux": + MSG_EOF = MsgFlag.MSG_EOF + +class AddressInfo(IntFlag): + AI_ADDRCONFIG = 32 + AI_ALL = 16 + AI_CANONNAME = 2 + AI_NUMERICHOST = 4 + AI_NUMERICSERV = 1024 + AI_PASSIVE = 1 + AI_V4MAPPED = 8 + if sys.platform != "win32" and sys.platform != "linux": + AI_DEFAULT = 1536 + AI_MASK = 5127 + AI_V4MAPPED_CFG = 512 + +AI_ADDRCONFIG = AddressInfo.AI_ADDRCONFIG +AI_ALL = AddressInfo.AI_ALL +AI_CANONNAME = AddressInfo.AI_CANONNAME +AI_NUMERICHOST = AddressInfo.AI_NUMERICHOST +AI_NUMERICSERV = AddressInfo.AI_NUMERICSERV +AI_PASSIVE = AddressInfo.AI_PASSIVE +AI_V4MAPPED = AddressInfo.AI_V4MAPPED + +if sys.platform != "win32" and sys.platform != "linux": + AI_DEFAULT = AddressInfo.AI_DEFAULT + AI_MASK = AddressInfo.AI_MASK + AI_V4MAPPED_CFG = AddressInfo.AI_V4MAPPED_CFG + +if sys.platform == "win32": + errorTab: dict[int, str] # undocumented + +class _SendableFile(Protocol): + def read(self, size: int, /) -> bytes: ... + def seek(self, offset: int, /) -> object: ... + + # optional fields: + # + # @property + # def mode(self) -> str: ... + # def fileno(self) -> int: ... + +class socket(_socket.socket): + def __init__( + self, family: AddressFamily | int = -1, type: SocketKind | int = -1, proto: int = -1, fileno: int | None = None + ) -> None: ... + def __enter__(self) -> Self: ... + def __exit__(self, *args: Unused) -> None: ... + def dup(self) -> Self: ... + def accept(self) -> tuple[socket, _RetAddress]: ... + # Note that the makefile's documented windows-specific behavior is not represented + # mode strings with duplicates are intentionally excluded + @overload + def makefile( + self, + mode: Literal["b", "rb", "br", "wb", "bw", "rwb", "rbw", "wrb", "wbr", "brw", "bwr"], + buffering: Literal[0], + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> SocketIO: ... + @overload + def makefile( + self, + mode: Literal["rwb", "rbw", "wrb", "wbr", "brw", "bwr"], + buffering: Literal[-1, 1] | None = None, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> BufferedRWPair: ... + @overload + def makefile( + self, + mode: Literal["rb", "br"], + buffering: Literal[-1, 1] | None = None, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> BufferedReader: ... + @overload + def makefile( + self, + mode: Literal["wb", "bw"], + buffering: Literal[-1, 1] | None = None, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> BufferedWriter: ... + @overload + def makefile( + self, + mode: Literal["b", "rb", "br", "wb", "bw", "rwb", "rbw", "wrb", "wbr", "brw", "bwr"], + buffering: int, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> IOBase: ... + @overload + def makefile( + self, + mode: Literal["r", "w", "rw", "wr", ""] = "r", + buffering: int | None = None, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> TextIOWrapper: ... + def sendfile(self, file: _SendableFile, offset: int = 0, count: int | None = None) -> int: ... + @property + def family(self) -> AddressFamily: ... + @property + def type(self) -> SocketKind: ... + def get_inheritable(self) -> bool: ... + def set_inheritable(self, inheritable: bool) -> None: ... + +def fromfd(fd: SupportsIndex, family: AddressFamily | int, type: SocketKind | int, proto: int = 0) -> socket: ... + +if sys.platform != "win32": + def send_fds( + sock: socket, buffers: Iterable[ReadableBuffer], fds: Iterable[int], flags: Unused = 0, address: Unused = None + ) -> int: ... + def recv_fds(sock: socket, bufsize: int, maxfds: int, flags: int = 0) -> tuple[bytes, list[int], int, Any]: ... + +if sys.platform == "win32": + def fromshare(info: bytes) -> socket: ... + +if sys.platform == "win32": + def socketpair(family: int = ..., type: int = ..., proto: int = 0) -> tuple[socket, socket]: ... + +else: + def socketpair( + family: int | AddressFamily | None = None, type: SocketType | int = ..., proto: int = 0 + ) -> tuple[socket, socket]: ... + +class SocketIO(RawIOBase): + def __init__(self, sock: socket, mode: Literal["r", "w", "rw", "rb", "wb", "rwb"]) -> None: ... + def readinto(self, b: WriteableBuffer) -> int | None: ... + def write(self, b: ReadableBuffer) -> int | None: ... + @property + def name(self) -> int: ... # return value is really "int" + @property + def mode(self) -> Literal["rb", "wb", "rwb"]: ... + +def getfqdn(name: str = "") -> str: ... + +if sys.version_info >= (3, 11): + def create_connection( + address: tuple[str | None, int], + timeout: float | None = ..., + source_address: _Address | None = None, + *, + all_errors: bool = False, + ) -> socket: ... + +else: + def create_connection( + address: tuple[str | None, int], timeout: float | None = ..., source_address: _Address | None = None + ) -> socket: ... + +def has_dualstack_ipv6() -> bool: ... +def create_server( + address: _Address, *, family: int = ..., backlog: int | None = None, reuse_port: bool = False, dualstack_ipv6: bool = False +) -> socket: ... + +# The 5th tuple item is the socket address, for IP4, IP6, or IP6 if Python is compiled with --disable-ipv6, respectively. +def getaddrinfo( + host: bytes | str | None, port: bytes | str | int | None, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0 +) -> list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/socketserver.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/socketserver.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/socketserver.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/socketserver.pyi index ae6575d850822..061932f0fac7e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/socketserver.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/socketserver.pyi @@ -38,29 +38,22 @@ _AfInetAddress: TypeAlias = tuple[str | bytes | bytearray, int] # address accep # This can possibly be generic at some point: class BaseServer: - address_family: int server_address: _Address - socket: _socket - allow_reuse_address: bool - request_queue_size: int - socket_type: int timeout: float | None RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler] def __init__( self, server_address: _Address, RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler] ) -> None: ... - def fileno(self) -> int: ... def handle_request(self) -> None: ... def serve_forever(self, poll_interval: float = 0.5) -> None: ... def shutdown(self) -> None: ... def server_close(self) -> None: ... def finish_request(self, request: _RequestType, client_address: _RetAddress) -> None: ... - def get_request(self) -> tuple[Any, Any]: ... + def get_request(self) -> tuple[Any, Any]: ... # Not implemented here, but expected to exist on subclasses def handle_error(self, request: _RequestType, client_address: _RetAddress) -> None: ... def handle_timeout(self) -> None: ... def process_request(self, request: _RequestType, client_address: _RetAddress) -> None: ... def server_activate(self) -> None: ... - def server_bind(self) -> None: ... def verify_request(self, request: _RequestType, client_address: _RetAddress) -> bool: ... def __enter__(self) -> Self: ... def __exit__( @@ -71,6 +64,11 @@ class BaseServer: def close_request(self, request: _RequestType) -> None: ... # undocumented class TCPServer(BaseServer): + address_family: int + socket: _socket + allow_reuse_address: bool + request_queue_size: int + socket_type: int if sys.version_info >= (3, 11): allow_reuse_port: bool server_address: _AfInetAddress @@ -80,7 +78,9 @@ class TCPServer(BaseServer): RequestHandlerClass: Callable[[Any, _RetAddress, Self], BaseRequestHandler], bind_and_activate: bool = True, ) -> None: ... + def fileno(self) -> int: ... def get_request(self) -> tuple[_socket, _RetAddress]: ... + def server_bind(self) -> None: ... class UDPServer(TCPServer): max_packet_size: ClassVar[int] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/spwd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/spwd.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/spwd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/spwd.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi new file mode 100644 index 0000000000000..5d3c2330be5e8 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/__init__.pyi @@ -0,0 +1,469 @@ +import sys +from _typeshed import MaybeNone, ReadableBuffer, StrOrBytesPath, SupportsLenAndGetItem, Unused +from collections.abc import Callable, Generator, Iterable, Iterator, Mapping, Sequence +from sqlite3.dbapi2 import ( + PARSE_COLNAMES as PARSE_COLNAMES, + PARSE_DECLTYPES as PARSE_DECLTYPES, + SQLITE_ALTER_TABLE as SQLITE_ALTER_TABLE, + SQLITE_ANALYZE as SQLITE_ANALYZE, + SQLITE_ATTACH as SQLITE_ATTACH, + SQLITE_CREATE_INDEX as SQLITE_CREATE_INDEX, + SQLITE_CREATE_TABLE as SQLITE_CREATE_TABLE, + SQLITE_CREATE_TEMP_INDEX as SQLITE_CREATE_TEMP_INDEX, + SQLITE_CREATE_TEMP_TABLE as SQLITE_CREATE_TEMP_TABLE, + SQLITE_CREATE_TEMP_TRIGGER as SQLITE_CREATE_TEMP_TRIGGER, + SQLITE_CREATE_TEMP_VIEW as SQLITE_CREATE_TEMP_VIEW, + SQLITE_CREATE_TRIGGER as SQLITE_CREATE_TRIGGER, + SQLITE_CREATE_VIEW as SQLITE_CREATE_VIEW, + SQLITE_CREATE_VTABLE as SQLITE_CREATE_VTABLE, + SQLITE_DELETE as SQLITE_DELETE, + SQLITE_DENY as SQLITE_DENY, + SQLITE_DETACH as SQLITE_DETACH, + SQLITE_DONE as SQLITE_DONE, + SQLITE_DROP_INDEX as SQLITE_DROP_INDEX, + SQLITE_DROP_TABLE as SQLITE_DROP_TABLE, + SQLITE_DROP_TEMP_INDEX as SQLITE_DROP_TEMP_INDEX, + SQLITE_DROP_TEMP_TABLE as SQLITE_DROP_TEMP_TABLE, + SQLITE_DROP_TEMP_TRIGGER as SQLITE_DROP_TEMP_TRIGGER, + SQLITE_DROP_TEMP_VIEW as SQLITE_DROP_TEMP_VIEW, + SQLITE_DROP_TRIGGER as SQLITE_DROP_TRIGGER, + SQLITE_DROP_VIEW as SQLITE_DROP_VIEW, + SQLITE_DROP_VTABLE as SQLITE_DROP_VTABLE, + SQLITE_FUNCTION as SQLITE_FUNCTION, + SQLITE_IGNORE as SQLITE_IGNORE, + SQLITE_INSERT as SQLITE_INSERT, + SQLITE_OK as SQLITE_OK, + SQLITE_PRAGMA as SQLITE_PRAGMA, + SQLITE_READ as SQLITE_READ, + SQLITE_RECURSIVE as SQLITE_RECURSIVE, + SQLITE_REINDEX as SQLITE_REINDEX, + SQLITE_SAVEPOINT as SQLITE_SAVEPOINT, + SQLITE_SELECT as SQLITE_SELECT, + SQLITE_TRANSACTION as SQLITE_TRANSACTION, + SQLITE_UPDATE as SQLITE_UPDATE, + Binary as Binary, + Date as Date, + DateFromTicks as DateFromTicks, + Time as Time, + TimeFromTicks as TimeFromTicks, + TimestampFromTicks as TimestampFromTicks, + adapt as adapt, + adapters as adapters, + apilevel as apilevel, + complete_statement as complete_statement, + connect as connect, + converters as converters, + enable_callback_tracebacks as enable_callback_tracebacks, + paramstyle as paramstyle, + register_adapter as register_adapter, + register_converter as register_converter, + sqlite_version as sqlite_version, + sqlite_version_info as sqlite_version_info, + threadsafety as threadsafety, +) +from types import TracebackType +from typing import Any, Literal, Protocol, SupportsIndex, TypeVar, final, overload, type_check_only +from typing_extensions import Self, TypeAlias + +if sys.version_info < (3, 14): + from sqlite3.dbapi2 import version_info as version_info + +if sys.version_info >= (3, 12): + from sqlite3.dbapi2 import ( + LEGACY_TRANSACTION_CONTROL as LEGACY_TRANSACTION_CONTROL, + SQLITE_DBCONFIG_DEFENSIVE as SQLITE_DBCONFIG_DEFENSIVE, + SQLITE_DBCONFIG_DQS_DDL as SQLITE_DBCONFIG_DQS_DDL, + SQLITE_DBCONFIG_DQS_DML as SQLITE_DBCONFIG_DQS_DML, + SQLITE_DBCONFIG_ENABLE_FKEY as SQLITE_DBCONFIG_ENABLE_FKEY, + SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER as SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, + SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION as SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, + SQLITE_DBCONFIG_ENABLE_QPSG as SQLITE_DBCONFIG_ENABLE_QPSG, + SQLITE_DBCONFIG_ENABLE_TRIGGER as SQLITE_DBCONFIG_ENABLE_TRIGGER, + SQLITE_DBCONFIG_ENABLE_VIEW as SQLITE_DBCONFIG_ENABLE_VIEW, + SQLITE_DBCONFIG_LEGACY_ALTER_TABLE as SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, + SQLITE_DBCONFIG_LEGACY_FILE_FORMAT as SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, + SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE as SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, + SQLITE_DBCONFIG_RESET_DATABASE as SQLITE_DBCONFIG_RESET_DATABASE, + SQLITE_DBCONFIG_TRIGGER_EQP as SQLITE_DBCONFIG_TRIGGER_EQP, + SQLITE_DBCONFIG_TRUSTED_SCHEMA as SQLITE_DBCONFIG_TRUSTED_SCHEMA, + SQLITE_DBCONFIG_WRITABLE_SCHEMA as SQLITE_DBCONFIG_WRITABLE_SCHEMA, + ) + +if sys.version_info >= (3, 11): + from sqlite3.dbapi2 import ( + SQLITE_ABORT as SQLITE_ABORT, + SQLITE_ABORT_ROLLBACK as SQLITE_ABORT_ROLLBACK, + SQLITE_AUTH as SQLITE_AUTH, + SQLITE_AUTH_USER as SQLITE_AUTH_USER, + SQLITE_BUSY as SQLITE_BUSY, + SQLITE_BUSY_RECOVERY as SQLITE_BUSY_RECOVERY, + SQLITE_BUSY_SNAPSHOT as SQLITE_BUSY_SNAPSHOT, + SQLITE_BUSY_TIMEOUT as SQLITE_BUSY_TIMEOUT, + SQLITE_CANTOPEN as SQLITE_CANTOPEN, + SQLITE_CANTOPEN_CONVPATH as SQLITE_CANTOPEN_CONVPATH, + SQLITE_CANTOPEN_DIRTYWAL as SQLITE_CANTOPEN_DIRTYWAL, + SQLITE_CANTOPEN_FULLPATH as SQLITE_CANTOPEN_FULLPATH, + SQLITE_CANTOPEN_ISDIR as SQLITE_CANTOPEN_ISDIR, + SQLITE_CANTOPEN_NOTEMPDIR as SQLITE_CANTOPEN_NOTEMPDIR, + SQLITE_CANTOPEN_SYMLINK as SQLITE_CANTOPEN_SYMLINK, + SQLITE_CONSTRAINT as SQLITE_CONSTRAINT, + SQLITE_CONSTRAINT_CHECK as SQLITE_CONSTRAINT_CHECK, + SQLITE_CONSTRAINT_COMMITHOOK as SQLITE_CONSTRAINT_COMMITHOOK, + SQLITE_CONSTRAINT_FOREIGNKEY as SQLITE_CONSTRAINT_FOREIGNKEY, + SQLITE_CONSTRAINT_FUNCTION as SQLITE_CONSTRAINT_FUNCTION, + SQLITE_CONSTRAINT_NOTNULL as SQLITE_CONSTRAINT_NOTNULL, + SQLITE_CONSTRAINT_PINNED as SQLITE_CONSTRAINT_PINNED, + SQLITE_CONSTRAINT_PRIMARYKEY as SQLITE_CONSTRAINT_PRIMARYKEY, + SQLITE_CONSTRAINT_ROWID as SQLITE_CONSTRAINT_ROWID, + SQLITE_CONSTRAINT_TRIGGER as SQLITE_CONSTRAINT_TRIGGER, + SQLITE_CONSTRAINT_UNIQUE as SQLITE_CONSTRAINT_UNIQUE, + SQLITE_CONSTRAINT_VTAB as SQLITE_CONSTRAINT_VTAB, + SQLITE_CORRUPT as SQLITE_CORRUPT, + SQLITE_CORRUPT_INDEX as SQLITE_CORRUPT_INDEX, + SQLITE_CORRUPT_SEQUENCE as SQLITE_CORRUPT_SEQUENCE, + SQLITE_CORRUPT_VTAB as SQLITE_CORRUPT_VTAB, + SQLITE_EMPTY as SQLITE_EMPTY, + SQLITE_ERROR as SQLITE_ERROR, + SQLITE_ERROR_MISSING_COLLSEQ as SQLITE_ERROR_MISSING_COLLSEQ, + SQLITE_ERROR_RETRY as SQLITE_ERROR_RETRY, + SQLITE_ERROR_SNAPSHOT as SQLITE_ERROR_SNAPSHOT, + SQLITE_FORMAT as SQLITE_FORMAT, + SQLITE_FULL as SQLITE_FULL, + SQLITE_INTERNAL as SQLITE_INTERNAL, + SQLITE_INTERRUPT as SQLITE_INTERRUPT, + SQLITE_IOERR as SQLITE_IOERR, + SQLITE_IOERR_ACCESS as SQLITE_IOERR_ACCESS, + SQLITE_IOERR_AUTH as SQLITE_IOERR_AUTH, + SQLITE_IOERR_BEGIN_ATOMIC as SQLITE_IOERR_BEGIN_ATOMIC, + SQLITE_IOERR_BLOCKED as SQLITE_IOERR_BLOCKED, + SQLITE_IOERR_CHECKRESERVEDLOCK as SQLITE_IOERR_CHECKRESERVEDLOCK, + SQLITE_IOERR_CLOSE as SQLITE_IOERR_CLOSE, + SQLITE_IOERR_COMMIT_ATOMIC as SQLITE_IOERR_COMMIT_ATOMIC, + SQLITE_IOERR_CONVPATH as SQLITE_IOERR_CONVPATH, + SQLITE_IOERR_CORRUPTFS as SQLITE_IOERR_CORRUPTFS, + SQLITE_IOERR_DATA as SQLITE_IOERR_DATA, + SQLITE_IOERR_DELETE as SQLITE_IOERR_DELETE, + SQLITE_IOERR_DELETE_NOENT as SQLITE_IOERR_DELETE_NOENT, + SQLITE_IOERR_DIR_CLOSE as SQLITE_IOERR_DIR_CLOSE, + SQLITE_IOERR_DIR_FSYNC as SQLITE_IOERR_DIR_FSYNC, + SQLITE_IOERR_FSTAT as SQLITE_IOERR_FSTAT, + SQLITE_IOERR_FSYNC as SQLITE_IOERR_FSYNC, + SQLITE_IOERR_GETTEMPPATH as SQLITE_IOERR_GETTEMPPATH, + SQLITE_IOERR_LOCK as SQLITE_IOERR_LOCK, + SQLITE_IOERR_MMAP as SQLITE_IOERR_MMAP, + SQLITE_IOERR_NOMEM as SQLITE_IOERR_NOMEM, + SQLITE_IOERR_RDLOCK as SQLITE_IOERR_RDLOCK, + SQLITE_IOERR_READ as SQLITE_IOERR_READ, + SQLITE_IOERR_ROLLBACK_ATOMIC as SQLITE_IOERR_ROLLBACK_ATOMIC, + SQLITE_IOERR_SEEK as SQLITE_IOERR_SEEK, + SQLITE_IOERR_SHMLOCK as SQLITE_IOERR_SHMLOCK, + SQLITE_IOERR_SHMMAP as SQLITE_IOERR_SHMMAP, + SQLITE_IOERR_SHMOPEN as SQLITE_IOERR_SHMOPEN, + SQLITE_IOERR_SHMSIZE as SQLITE_IOERR_SHMSIZE, + SQLITE_IOERR_SHORT_READ as SQLITE_IOERR_SHORT_READ, + SQLITE_IOERR_TRUNCATE as SQLITE_IOERR_TRUNCATE, + SQLITE_IOERR_UNLOCK as SQLITE_IOERR_UNLOCK, + SQLITE_IOERR_VNODE as SQLITE_IOERR_VNODE, + SQLITE_IOERR_WRITE as SQLITE_IOERR_WRITE, + SQLITE_LIMIT_ATTACHED as SQLITE_LIMIT_ATTACHED, + SQLITE_LIMIT_COLUMN as SQLITE_LIMIT_COLUMN, + SQLITE_LIMIT_COMPOUND_SELECT as SQLITE_LIMIT_COMPOUND_SELECT, + SQLITE_LIMIT_EXPR_DEPTH as SQLITE_LIMIT_EXPR_DEPTH, + SQLITE_LIMIT_FUNCTION_ARG as SQLITE_LIMIT_FUNCTION_ARG, + SQLITE_LIMIT_LENGTH as SQLITE_LIMIT_LENGTH, + SQLITE_LIMIT_LIKE_PATTERN_LENGTH as SQLITE_LIMIT_LIKE_PATTERN_LENGTH, + SQLITE_LIMIT_SQL_LENGTH as SQLITE_LIMIT_SQL_LENGTH, + SQLITE_LIMIT_TRIGGER_DEPTH as SQLITE_LIMIT_TRIGGER_DEPTH, + SQLITE_LIMIT_VARIABLE_NUMBER as SQLITE_LIMIT_VARIABLE_NUMBER, + SQLITE_LIMIT_VDBE_OP as SQLITE_LIMIT_VDBE_OP, + SQLITE_LIMIT_WORKER_THREADS as SQLITE_LIMIT_WORKER_THREADS, + SQLITE_LOCKED as SQLITE_LOCKED, + SQLITE_LOCKED_SHAREDCACHE as SQLITE_LOCKED_SHAREDCACHE, + SQLITE_LOCKED_VTAB as SQLITE_LOCKED_VTAB, + SQLITE_MISMATCH as SQLITE_MISMATCH, + SQLITE_MISUSE as SQLITE_MISUSE, + SQLITE_NOLFS as SQLITE_NOLFS, + SQLITE_NOMEM as SQLITE_NOMEM, + SQLITE_NOTADB as SQLITE_NOTADB, + SQLITE_NOTFOUND as SQLITE_NOTFOUND, + SQLITE_NOTICE as SQLITE_NOTICE, + SQLITE_NOTICE_RECOVER_ROLLBACK as SQLITE_NOTICE_RECOVER_ROLLBACK, + SQLITE_NOTICE_RECOVER_WAL as SQLITE_NOTICE_RECOVER_WAL, + SQLITE_OK_LOAD_PERMANENTLY as SQLITE_OK_LOAD_PERMANENTLY, + SQLITE_OK_SYMLINK as SQLITE_OK_SYMLINK, + SQLITE_PERM as SQLITE_PERM, + SQLITE_PROTOCOL as SQLITE_PROTOCOL, + SQLITE_RANGE as SQLITE_RANGE, + SQLITE_READONLY as SQLITE_READONLY, + SQLITE_READONLY_CANTINIT as SQLITE_READONLY_CANTINIT, + SQLITE_READONLY_CANTLOCK as SQLITE_READONLY_CANTLOCK, + SQLITE_READONLY_DBMOVED as SQLITE_READONLY_DBMOVED, + SQLITE_READONLY_DIRECTORY as SQLITE_READONLY_DIRECTORY, + SQLITE_READONLY_RECOVERY as SQLITE_READONLY_RECOVERY, + SQLITE_READONLY_ROLLBACK as SQLITE_READONLY_ROLLBACK, + SQLITE_ROW as SQLITE_ROW, + SQLITE_SCHEMA as SQLITE_SCHEMA, + SQLITE_TOOBIG as SQLITE_TOOBIG, + SQLITE_WARNING as SQLITE_WARNING, + SQLITE_WARNING_AUTOINDEX as SQLITE_WARNING_AUTOINDEX, + ) + +if sys.version_info < (3, 12): + from sqlite3.dbapi2 import enable_shared_cache as enable_shared_cache, version as version + +if sys.version_info < (3, 10): + from sqlite3.dbapi2 import OptimizedUnicode as OptimizedUnicode + +_CursorT = TypeVar("_CursorT", bound=Cursor) +_SqliteData: TypeAlias = str | ReadableBuffer | int | float | None +# Data that is passed through adapters can be of any type accepted by an adapter. +_AdaptedInputData: TypeAlias = _SqliteData | Any +# The Mapping must really be a dict, but making it invariant is too annoying. +_Parameters: TypeAlias = SupportsLenAndGetItem[_AdaptedInputData] | Mapping[str, _AdaptedInputData] + +class _AnyParamWindowAggregateClass(Protocol): + def step(self, *args: Any) -> object: ... + def inverse(self, *args: Any) -> object: ... + def value(self) -> _SqliteData: ... + def finalize(self) -> _SqliteData: ... + +class _WindowAggregateClass(Protocol): + step: Callable[..., object] + inverse: Callable[..., object] + def value(self) -> _SqliteData: ... + def finalize(self) -> _SqliteData: ... + +class _AggregateProtocol(Protocol): + def step(self, value: int, /) -> object: ... + def finalize(self) -> int: ... + +class _SingleParamWindowAggregateClass(Protocol): + def step(self, param: Any, /) -> object: ... + def inverse(self, param: Any, /) -> object: ... + def value(self) -> _SqliteData: ... + def finalize(self) -> _SqliteData: ... + +# These classes are implemented in the C module _sqlite3. At runtime, they're imported +# from there into sqlite3.dbapi2 and from that module to here. However, they +# consider themselves to live in the sqlite3.* namespace, so we'll define them here. + +class Error(Exception): + if sys.version_info >= (3, 11): + sqlite_errorcode: int + sqlite_errorname: str + +class DatabaseError(Error): ... +class DataError(DatabaseError): ... +class IntegrityError(DatabaseError): ... +class InterfaceError(Error): ... +class InternalError(DatabaseError): ... +class NotSupportedError(DatabaseError): ... +class OperationalError(DatabaseError): ... +class ProgrammingError(DatabaseError): ... +class Warning(Exception): ... + +class Connection: + @property + def DataError(self) -> type[DataError]: ... + @property + def DatabaseError(self) -> type[DatabaseError]: ... + @property + def Error(self) -> type[Error]: ... + @property + def IntegrityError(self) -> type[IntegrityError]: ... + @property + def InterfaceError(self) -> type[InterfaceError]: ... + @property + def InternalError(self) -> type[InternalError]: ... + @property + def NotSupportedError(self) -> type[NotSupportedError]: ... + @property + def OperationalError(self) -> type[OperationalError]: ... + @property + def ProgrammingError(self) -> type[ProgrammingError]: ... + @property + def Warning(self) -> type[Warning]: ... + @property + def in_transaction(self) -> bool: ... + isolation_level: str | None # one of '', 'DEFERRED', 'IMMEDIATE' or 'EXCLUSIVE' + @property + def total_changes(self) -> int: ... + if sys.version_info >= (3, 12): + @property + def autocommit(self) -> int: ... + @autocommit.setter + def autocommit(self, val: int) -> None: ... + row_factory: Any + text_factory: Any + if sys.version_info >= (3, 12): + def __init__( + self, + database: StrOrBytesPath, + timeout: float = ..., + detect_types: int = ..., + isolation_level: str | None = ..., + check_same_thread: bool = ..., + factory: type[Connection] | None = ..., + cached_statements: int = ..., + uri: bool = ..., + autocommit: bool = ..., + ) -> None: ... + else: + def __init__( + self, + database: StrOrBytesPath, + timeout: float = ..., + detect_types: int = ..., + isolation_level: str | None = ..., + check_same_thread: bool = ..., + factory: type[Connection] | None = ..., + cached_statements: int = ..., + uri: bool = ..., + ) -> None: ... + + def close(self) -> None: ... + if sys.version_info >= (3, 11): + def blobopen(self, table: str, column: str, row: int, /, *, readonly: bool = False, name: str = "main") -> Blob: ... + + def commit(self) -> None: ... + def create_aggregate(self, name: str, n_arg: int, aggregate_class: Callable[[], _AggregateProtocol]) -> None: ... + if sys.version_info >= (3, 11): + # num_params determines how many params will be passed to the aggregate class. We provide an overload + # for the case where num_params = 1, which is expected to be the common case. + @overload + def create_window_function( + self, name: str, num_params: Literal[1], aggregate_class: Callable[[], _SingleParamWindowAggregateClass] | None, / + ) -> None: ... + # And for num_params = -1, which means the aggregate must accept any number of parameters. + @overload + def create_window_function( + self, name: str, num_params: Literal[-1], aggregate_class: Callable[[], _AnyParamWindowAggregateClass] | None, / + ) -> None: ... + @overload + def create_window_function( + self, name: str, num_params: int, aggregate_class: Callable[[], _WindowAggregateClass] | None, / + ) -> None: ... + + def create_collation(self, name: str, callback: Callable[[str, str], int | SupportsIndex] | None, /) -> None: ... + def create_function( + self, name: str, narg: int, func: Callable[..., _SqliteData] | None, *, deterministic: bool = False + ) -> None: ... + @overload + def cursor(self, factory: None = None) -> Cursor: ... + @overload + def cursor(self, factory: Callable[[Connection], _CursorT]) -> _CursorT: ... + def execute(self, sql: str, parameters: _Parameters = ..., /) -> Cursor: ... + def executemany(self, sql: str, parameters: Iterable[_Parameters], /) -> Cursor: ... + def executescript(self, sql_script: str, /) -> Cursor: ... + def interrupt(self) -> None: ... + if sys.version_info >= (3, 13): + def iterdump(self, *, filter: str | None = None) -> Generator[str, None, None]: ... + else: + def iterdump(self) -> Generator[str, None, None]: ... + + def rollback(self) -> None: ... + def set_authorizer( + self, authorizer_callback: Callable[[int, str | None, str | None, str | None, str | None], int] | None + ) -> None: ... + def set_progress_handler(self, progress_handler: Callable[[], int | None] | None, n: int) -> None: ... + def set_trace_callback(self, trace_callback: Callable[[str], object] | None) -> None: ... + # enable_load_extension and load_extension is not available on python distributions compiled + # without sqlite3 loadable extension support. see footnotes https://docs.python.org/3/library/sqlite3.html#f1 + def enable_load_extension(self, enable: bool, /) -> None: ... + if sys.version_info >= (3, 12): + def load_extension(self, name: str, /, *, entrypoint: str | None = None) -> None: ... + else: + def load_extension(self, name: str, /) -> None: ... + + def backup( + self, + target: Connection, + *, + pages: int = -1, + progress: Callable[[int, int, int], object] | None = None, + name: str = "main", + sleep: float = 0.25, + ) -> None: ... + if sys.version_info >= (3, 11): + def setlimit(self, category: int, limit: int, /) -> int: ... + def getlimit(self, category: int, /) -> int: ... + def serialize(self, *, name: str = "main") -> bytes: ... + def deserialize(self, data: ReadableBuffer, /, *, name: str = "main") -> None: ... + if sys.version_info >= (3, 12): + def getconfig(self, op: int, /) -> bool: ... + def setconfig(self, op: int, enable: bool = True, /) -> bool: ... + + def __call__(self, sql: str, /) -> _Statement: ... + def __enter__(self) -> Self: ... + def __exit__( + self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None, / + ) -> Literal[False]: ... + +class Cursor: + arraysize: int + @property + def connection(self) -> Connection: ... + # May be None, but using `| MaybeNone` (`| Any`) instead to avoid slightly annoying false positives. + @property + def description(self) -> tuple[tuple[str, None, None, None, None, None, None], ...] | MaybeNone: ... + @property + def lastrowid(self) -> int | None: ... + row_factory: Callable[[Cursor, Row], object] | None + @property + def rowcount(self) -> int: ... + def __init__(self, cursor: Connection, /) -> None: ... + def close(self) -> None: ... + def execute(self, sql: str, parameters: _Parameters = (), /) -> Self: ... + def executemany(self, sql: str, seq_of_parameters: Iterable[_Parameters], /) -> Self: ... + def executescript(self, sql_script: str, /) -> Cursor: ... + def fetchall(self) -> list[Any]: ... + def fetchmany(self, size: int | None = 1) -> list[Any]: ... + # Returns either a row (as created by the row_factory) or None, but + # putting None in the return annotation causes annoying false positives. + def fetchone(self) -> Any: ... + def setinputsizes(self, sizes: Unused, /) -> None: ... # does nothing + def setoutputsize(self, size: Unused, column: Unused = None, /) -> None: ... # does nothing + def __iter__(self) -> Self: ... + def __next__(self) -> Any: ... + +@final +class PrepareProtocol: + def __init__(self, *args: object, **kwargs: object) -> None: ... + +class Row(Sequence[Any]): + def __new__(cls, cursor: Cursor, data: tuple[Any, ...], /) -> Self: ... + def keys(self) -> list[str]: ... + @overload + def __getitem__(self, key: int | str, /) -> Any: ... + @overload + def __getitem__(self, key: slice, /) -> tuple[Any, ...]: ... + def __hash__(self) -> int: ... + def __iter__(self) -> Iterator[Any]: ... + def __len__(self) -> int: ... + # These return NotImplemented for anything that is not a Row. + def __eq__(self, value: object, /) -> bool: ... + def __ge__(self, value: object, /) -> bool: ... + def __gt__(self, value: object, /) -> bool: ... + def __le__(self, value: object, /) -> bool: ... + def __lt__(self, value: object, /) -> bool: ... + def __ne__(self, value: object, /) -> bool: ... + +# This class is not exposed. It calls itself sqlite3.Statement. +@final +@type_check_only +class _Statement: ... + +if sys.version_info >= (3, 11): + @final + class Blob: + def close(self) -> None: ... + def read(self, length: int = -1, /) -> bytes: ... + def write(self, data: ReadableBuffer, /) -> None: ... + def tell(self) -> int: ... + # whence must be one of os.SEEK_SET, os.SEEK_CUR, os.SEEK_END + def seek(self, offset: int, origin: int = 0, /) -> None: ... + def __len__(self) -> int: ... + def __enter__(self) -> Self: ... + def __exit__(self, type: object, val: object, tb: object, /) -> Literal[False]: ... + def __getitem__(self, key: SupportsIndex | slice, /) -> int: ... + def __setitem__(self, key: SupportsIndex | slice, value: int, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sqlite3/dbapi2.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/dbapi2.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sqlite3/dbapi2.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/dbapi2.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/dump.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/dump.pyi new file mode 100644 index 0000000000000..ed95fa46e1c78 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sqlite3/dump.pyi @@ -0,0 +1,2 @@ +# This file is intentionally empty. The runtime module contains only +# private functions. diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sre_compile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sre_compile.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sre_compile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sre_compile.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/sre_constants.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sre_constants.pyi new file mode 100644 index 0000000000000..c41a52b26d5ab --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sre_constants.pyi @@ -0,0 +1,126 @@ +import sys +from re import error as error +from typing import Final +from typing_extensions import Self + +MAXGROUPS: Final[int] + +MAGIC: Final[int] + +class _NamedIntConstant(int): + name: str + def __new__(cls, value: int, name: str) -> Self: ... + +MAXREPEAT: Final[_NamedIntConstant] +OPCODES: list[_NamedIntConstant] +ATCODES: list[_NamedIntConstant] +CHCODES: list[_NamedIntConstant] +OP_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] +OP_LOCALE_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] +OP_UNICODE_IGNORE: dict[_NamedIntConstant, _NamedIntConstant] +AT_MULTILINE: dict[_NamedIntConstant, _NamedIntConstant] +AT_LOCALE: dict[_NamedIntConstant, _NamedIntConstant] +AT_UNICODE: dict[_NamedIntConstant, _NamedIntConstant] +CH_LOCALE: dict[_NamedIntConstant, _NamedIntConstant] +CH_UNICODE: dict[_NamedIntConstant, _NamedIntConstant] +# flags +if sys.version_info < (3, 13): + SRE_FLAG_TEMPLATE: Final = 1 +SRE_FLAG_IGNORECASE: Final = 2 +SRE_FLAG_LOCALE: Final = 4 +SRE_FLAG_MULTILINE: Final = 8 +SRE_FLAG_DOTALL: Final = 16 +SRE_FLAG_UNICODE: Final = 32 +SRE_FLAG_VERBOSE: Final = 64 +SRE_FLAG_DEBUG: Final = 128 +SRE_FLAG_ASCII: Final = 256 +# flags for INFO primitive +SRE_INFO_PREFIX: Final = 1 +SRE_INFO_LITERAL: Final = 2 +SRE_INFO_CHARSET: Final = 4 + +# Stubgen above; manually defined constants below (dynamic at runtime) + +# from OPCODES +FAILURE: Final[_NamedIntConstant] +SUCCESS: Final[_NamedIntConstant] +ANY: Final[_NamedIntConstant] +ANY_ALL: Final[_NamedIntConstant] +ASSERT: Final[_NamedIntConstant] +ASSERT_NOT: Final[_NamedIntConstant] +AT: Final[_NamedIntConstant] +BRANCH: Final[_NamedIntConstant] +if sys.version_info < (3, 11): + CALL: Final[_NamedIntConstant] +CATEGORY: Final[_NamedIntConstant] +CHARSET: Final[_NamedIntConstant] +BIGCHARSET: Final[_NamedIntConstant] +GROUPREF: Final[_NamedIntConstant] +GROUPREF_EXISTS: Final[_NamedIntConstant] +GROUPREF_IGNORE: Final[_NamedIntConstant] +IN: Final[_NamedIntConstant] +IN_IGNORE: Final[_NamedIntConstant] +INFO: Final[_NamedIntConstant] +JUMP: Final[_NamedIntConstant] +LITERAL: Final[_NamedIntConstant] +LITERAL_IGNORE: Final[_NamedIntConstant] +MARK: Final[_NamedIntConstant] +MAX_UNTIL: Final[_NamedIntConstant] +MIN_UNTIL: Final[_NamedIntConstant] +NOT_LITERAL: Final[_NamedIntConstant] +NOT_LITERAL_IGNORE: Final[_NamedIntConstant] +NEGATE: Final[_NamedIntConstant] +RANGE: Final[_NamedIntConstant] +REPEAT: Final[_NamedIntConstant] +REPEAT_ONE: Final[_NamedIntConstant] +SUBPATTERN: Final[_NamedIntConstant] +MIN_REPEAT_ONE: Final[_NamedIntConstant] +if sys.version_info >= (3, 11): + ATOMIC_GROUP: Final[_NamedIntConstant] + POSSESSIVE_REPEAT: Final[_NamedIntConstant] + POSSESSIVE_REPEAT_ONE: Final[_NamedIntConstant] +RANGE_UNI_IGNORE: Final[_NamedIntConstant] +GROUPREF_LOC_IGNORE: Final[_NamedIntConstant] +GROUPREF_UNI_IGNORE: Final[_NamedIntConstant] +IN_LOC_IGNORE: Final[_NamedIntConstant] +IN_UNI_IGNORE: Final[_NamedIntConstant] +LITERAL_LOC_IGNORE: Final[_NamedIntConstant] +LITERAL_UNI_IGNORE: Final[_NamedIntConstant] +NOT_LITERAL_LOC_IGNORE: Final[_NamedIntConstant] +NOT_LITERAL_UNI_IGNORE: Final[_NamedIntConstant] +MIN_REPEAT: Final[_NamedIntConstant] +MAX_REPEAT: Final[_NamedIntConstant] + +# from ATCODES +AT_BEGINNING: Final[_NamedIntConstant] +AT_BEGINNING_LINE: Final[_NamedIntConstant] +AT_BEGINNING_STRING: Final[_NamedIntConstant] +AT_BOUNDARY: Final[_NamedIntConstant] +AT_NON_BOUNDARY: Final[_NamedIntConstant] +AT_END: Final[_NamedIntConstant] +AT_END_LINE: Final[_NamedIntConstant] +AT_END_STRING: Final[_NamedIntConstant] +AT_LOC_BOUNDARY: Final[_NamedIntConstant] +AT_LOC_NON_BOUNDARY: Final[_NamedIntConstant] +AT_UNI_BOUNDARY: Final[_NamedIntConstant] +AT_UNI_NON_BOUNDARY: Final[_NamedIntConstant] + +# from CHCODES +CATEGORY_DIGIT: Final[_NamedIntConstant] +CATEGORY_NOT_DIGIT: Final[_NamedIntConstant] +CATEGORY_SPACE: Final[_NamedIntConstant] +CATEGORY_NOT_SPACE: Final[_NamedIntConstant] +CATEGORY_WORD: Final[_NamedIntConstant] +CATEGORY_NOT_WORD: Final[_NamedIntConstant] +CATEGORY_LINEBREAK: Final[_NamedIntConstant] +CATEGORY_NOT_LINEBREAK: Final[_NamedIntConstant] +CATEGORY_LOC_WORD: Final[_NamedIntConstant] +CATEGORY_LOC_NOT_WORD: Final[_NamedIntConstant] +CATEGORY_UNI_DIGIT: Final[_NamedIntConstant] +CATEGORY_UNI_NOT_DIGIT: Final[_NamedIntConstant] +CATEGORY_UNI_SPACE: Final[_NamedIntConstant] +CATEGORY_UNI_NOT_SPACE: Final[_NamedIntConstant] +CATEGORY_UNI_WORD: Final[_NamedIntConstant] +CATEGORY_UNI_NOT_WORD: Final[_NamedIntConstant] +CATEGORY_UNI_LINEBREAK: Final[_NamedIntConstant] +CATEGORY_UNI_NOT_LINEBREAK: Final[_NamedIntConstant] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sre_parse.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sre_parse.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sre_parse.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sre_parse.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/ssl.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/ssl.pyi similarity index 94% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/ssl.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/ssl.pyi index 1d97c02acc5e0..9fbf5e8dfa847 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/ssl.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/ssl.pyi @@ -27,8 +27,8 @@ from _ssl import ( ) from _typeshed import ReadableBuffer, StrOrBytesPath, WriteableBuffer from collections.abc import Callable, Iterable -from typing import Any, Literal, NamedTuple, TypedDict, overload -from typing_extensions import Never, Self, TypeAlias +from typing import Any, Literal, NamedTuple, TypedDict, overload, type_check_only +from typing_extensions import Never, Self, TypeAlias, deprecated if sys.version_info >= (3, 13): from _ssl import HAS_PSK as HAS_PSK @@ -309,6 +309,8 @@ ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE: AlertDescription ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION: AlertDescription ALERT_DESCRIPTION_USER_CANCELLED: AlertDescription +# This class is not exposed. It calls itself ssl._ASN1Object. +@type_check_only class _ASN1ObjectBase(NamedTuple): nid: int shortname: str @@ -323,6 +325,10 @@ class _ASN1Object(_ASN1ObjectBase): def fromname(cls, name: str) -> Self: ... class Purpose(_ASN1Object, enum.Enum): + # Normally this class would inherit __new__ from _ASN1Object, but + # because this is an enum, the inherited __new__ is replaced at runtime with + # Enum.__new__. + def __new__(cls, value: object) -> Self: ... SERVER_AUTH = (129, "serverAuth", "TLS Web Server Authentication", "1.3.6.1.5.5.7.3.2") # pyright: ignore[reportCallIssue] CLIENT_AUTH = (130, "clientAuth", "TLS Web Client Authentication", "1.3.6.1.5.5.7.3.1") # pyright: ignore[reportCallIssue] @@ -363,7 +369,12 @@ class SSLSocket(socket.socket): def compression(self) -> str | None: ... def get_channel_binding(self, cb_type: str = "tls-unique") -> bytes | None: ... def selected_alpn_protocol(self) -> str | None: ... - def selected_npn_protocol(self) -> str | None: ... + if sys.version_info >= (3, 10): + @deprecated("Deprecated in 3.10. Use ALPN instead.") + def selected_npn_protocol(self) -> str | None: ... + else: + def selected_npn_protocol(self) -> str | None: ... + def accept(self) -> tuple[SSLSocket, socket._RetAddress]: ... def unwrap(self) -> socket.socket: ... def version(self) -> str | None: ... @@ -428,7 +439,12 @@ class SSLContext(_SSLContext): def set_default_verify_paths(self) -> None: ... def set_ciphers(self, cipherlist: str, /) -> None: ... def set_alpn_protocols(self, alpn_protocols: Iterable[str]) -> None: ... - def set_npn_protocols(self, npn_protocols: Iterable[str]) -> None: ... + if sys.version_info >= (3, 10): + @deprecated("Deprecated in 3.10. Use ALPN instead.") + def set_npn_protocols(self, npn_protocols: Iterable[str]) -> None: ... + else: + def set_npn_protocols(self, npn_protocols: Iterable[str]) -> None: ... + def set_servername_callback(self, server_name_callback: _SrvnmeCbType | None) -> None: ... def load_dh_params(self, path: str, /) -> None: ... def set_ecdh_curve(self, name: str, /) -> None: ... @@ -469,7 +485,12 @@ class SSLObject: @overload def getpeercert(self, binary_form: bool) -> _PeerCertRetType: ... def selected_alpn_protocol(self) -> str | None: ... - def selected_npn_protocol(self) -> str | None: ... + if sys.version_info >= (3, 10): + @deprecated("Deprecated in 3.10. Use ALPN instead.") + def selected_npn_protocol(self) -> str | None: ... + else: + def selected_npn_protocol(self) -> str | None: ... + def cipher(self) -> tuple[str, str, int] | None: ... def shared_ciphers(self) -> list[tuple[str, str, int]] | None: ... def compression(self) -> str | None: ... @@ -506,8 +527,6 @@ SSL_ERROR_ZERO_RETURN: SSLErrorNumber # undocumented def get_protocol_name(protocol_code: int) -> str: ... -if sys.version_info < (3, 9): - AF_INET: int PEM_FOOTER: str PEM_HEADER: str SOCK_STREAM: int diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/stat.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/stat.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/stat.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/stat.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/statistics.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/statistics.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/statistics.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/statistics.pyi index c8ecbbceab1ab..6d7d3fbb4956a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/statistics.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/statistics.pyi @@ -3,7 +3,7 @@ from _typeshed import SupportsRichComparisonT from collections.abc import Callable, Hashable, Iterable, Sequence from decimal import Decimal from fractions import Fraction -from typing import Any, Literal, NamedTuple, SupportsFloat, TypeVar +from typing import Literal, NamedTuple, SupportsFloat, SupportsIndex, TypeVar from typing_extensions import Self, TypeAlias __all__ = [ @@ -38,6 +38,9 @@ _NumberT = TypeVar("_NumberT", float, Decimal, Fraction) # Used in mode, multimode _HashableT = TypeVar("_HashableT", bound=Hashable) +# Used in NormalDist.samples and kde_random +_Seed: TypeAlias = int | float | str | bytes | bytearray # noqa: Y041 + class StatisticsError(ValueError): ... if sys.version_info >= (3, 11): @@ -89,24 +92,22 @@ class NormalDist: def variance(self) -> float: ... @classmethod def from_samples(cls, data: Iterable[SupportsFloat]) -> Self: ... - def samples(self, n: int, *, seed: Any | None = None) -> list[float]: ... + def samples(self, n: SupportsIndex, *, seed: _Seed | None = None) -> list[float]: ... def pdf(self, x: float) -> float: ... def cdf(self, x: float) -> float: ... def inv_cdf(self, p: float) -> float: ... def overlap(self, other: NormalDist) -> float: ... def quantiles(self, n: int = 4) -> list[float]: ... - if sys.version_info >= (3, 9): - def zscore(self, x: float) -> float: ... - - def __eq__(self, x2: object) -> bool: ... - def __add__(self, x2: float | NormalDist) -> NormalDist: ... - def __sub__(self, x2: float | NormalDist) -> NormalDist: ... - def __mul__(self, x2: float) -> NormalDist: ... - def __truediv__(self, x2: float) -> NormalDist: ... - def __pos__(self) -> NormalDist: ... - def __neg__(self) -> NormalDist: ... + def zscore(self, x: float) -> float: ... + def __eq__(x1, x2: object) -> bool: ... + def __add__(x1, x2: float | NormalDist) -> NormalDist: ... + def __sub__(x1, x2: float | NormalDist) -> NormalDist: ... + def __mul__(x1, x2: float) -> NormalDist: ... + def __truediv__(x1, x2: float) -> NormalDist: ... + def __pos__(x1) -> NormalDist: ... + def __neg__(x1) -> NormalDist: ... __radd__ = __add__ - def __rsub__(self, x2: float | NormalDist) -> NormalDist: ... + def __rsub__(x1, x2: float | NormalDist) -> NormalDist: ... __rmul__ = __mul__ def __hash__(self) -> int: ... @@ -153,9 +154,5 @@ if sys.version_info >= (3, 13): data: Sequence[float], h: float, kernel: _Kernel = "normal", *, cumulative: bool = False ) -> Callable[[float], float]: ... def kde_random( - data: Sequence[float], - h: float, - kernel: _Kernel = "normal", - *, - seed: int | float | str | bytes | bytearray | None = None, # noqa: Y041 + data: Sequence[float], h: float, kernel: _Kernel = "normal", *, seed: _Seed | None = None ) -> Callable[[], float]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/string/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/string/__init__.pyi new file mode 100644 index 0000000000000..da752327d3f78 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/string/__init__.pyi @@ -0,0 +1,76 @@ +import sys +from _typeshed import StrOrLiteralStr +from collections.abc import Iterable, Mapping, Sequence +from re import Pattern, RegexFlag +from typing import Any, ClassVar, overload +from typing_extensions import LiteralString + +__all__ = [ + "ascii_letters", + "ascii_lowercase", + "ascii_uppercase", + "capwords", + "digits", + "hexdigits", + "octdigits", + "printable", + "punctuation", + "whitespace", + "Formatter", + "Template", +] + +ascii_letters: LiteralString +ascii_lowercase: LiteralString +ascii_uppercase: LiteralString +digits: LiteralString +hexdigits: LiteralString +octdigits: LiteralString +punctuation: LiteralString +printable: LiteralString +whitespace: LiteralString + +def capwords(s: StrOrLiteralStr, sep: StrOrLiteralStr | None = None) -> StrOrLiteralStr: ... + +class Template(metaclass=type): + template: str + delimiter: ClassVar[str] + idpattern: ClassVar[str] + braceidpattern: ClassVar[str | None] + flags: ClassVar[RegexFlag] + pattern: ClassVar[Pattern[str]] + def __init__(self, template: str) -> None: ... + def substitute(self, mapping: Mapping[str, object] = {}, /, **kwds: object) -> str: ... + def safe_substitute(self, mapping: Mapping[str, object] = {}, /, **kwds: object) -> str: ... + if sys.version_info >= (3, 11): + def get_identifiers(self) -> list[str]: ... + def is_valid(self) -> bool: ... + +class Formatter: + @overload + def format(self, format_string: LiteralString, /, *args: LiteralString, **kwargs: LiteralString) -> LiteralString: ... + @overload + def format(self, format_string: str, /, *args: Any, **kwargs: Any) -> str: ... + @overload + def vformat( + self, format_string: LiteralString, args: Sequence[LiteralString], kwargs: Mapping[LiteralString, LiteralString] + ) -> LiteralString: ... + @overload + def vformat(self, format_string: str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> str: ... + def _vformat( # undocumented + self, + format_string: str, + args: Sequence[Any], + kwargs: Mapping[str, Any], + used_args: set[int | str], + recursion_depth: int, + auto_arg_index: int = 0, + ) -> tuple[str, int]: ... + def parse( + self, format_string: StrOrLiteralStr + ) -> Iterable[tuple[StrOrLiteralStr, StrOrLiteralStr | None, StrOrLiteralStr | None, StrOrLiteralStr | None]]: ... + def get_field(self, field_name: str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> Any: ... + def get_value(self, key: int | str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> Any: ... + def check_unused_args(self, used_args: set[int | str], args: Sequence[Any], kwargs: Mapping[str, Any]) -> None: ... + def format_field(self, value: Any, format_spec: str) -> Any: ... + def convert_field(self, value: Any, conversion: str | None) -> Any: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/string/templatelib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/string/templatelib.pyi new file mode 100644 index 0000000000000..01b95377a49c5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/string/templatelib.pyi @@ -0,0 +1,28 @@ +from collections.abc import Iterator +from typing import Any, Literal, final + +__all__ = ["Interpolation", "Template"] + +@final +class Template: # TODO: consider making `Template` generic on `TypeVarTuple` + strings: tuple[str, ...] + interpolations: tuple[Interpolation, ...] + + def __new__(cls, *args: str | Interpolation) -> Template: ... + def __iter__(self) -> Iterator[str | Interpolation]: ... + def __add__(self, other: Template | str) -> Template: ... + @property + def values(self) -> tuple[Any, ...]: ... # Tuple of interpolation values, which can have any type + +@final +class Interpolation: + value: Any # TODO: consider making `Interpolation` generic in runtime + expression: str + conversion: Literal["a", "r", "s"] | None + format_spec: str + + __match_args__ = ("value", "expression", "conversion", "format_spec") + + def __new__( + cls, value: Any, expression: str, conversion: Literal["a", "r", "s"] | None = None, format_spec: str = "" + ) -> Interpolation: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/stringprep.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/stringprep.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/stringprep.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/stringprep.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/struct.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/struct.pyi new file mode 100644 index 0000000000000..2c26908746ecc --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/struct.pyi @@ -0,0 +1,5 @@ +from _struct import * + +__all__ = ["calcsize", "pack", "pack_into", "unpack", "unpack_from", "iter_unpack", "Struct", "error"] + +class error(Exception): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/subprocess.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/subprocess.pyi new file mode 100644 index 0000000000000..8b72e2ec7ae2d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/subprocess.pyi @@ -0,0 +1,2093 @@ +import sys +from _typeshed import MaybeNone, ReadableBuffer, StrOrBytesPath +from collections.abc import Callable, Collection, Iterable, Mapping, Sequence +from types import GenericAlias, TracebackType +from typing import IO, Any, AnyStr, Final, Generic, Literal, TypeVar, overload +from typing_extensions import Self, TypeAlias + +__all__ = [ + "Popen", + "PIPE", + "STDOUT", + "call", + "check_call", + "getstatusoutput", + "getoutput", + "check_output", + "run", + "CalledProcessError", + "DEVNULL", + "SubprocessError", + "TimeoutExpired", + "CompletedProcess", +] + +if sys.platform == "win32": + __all__ += [ + "CREATE_NEW_CONSOLE", + "CREATE_NEW_PROCESS_GROUP", + "STARTF_USESHOWWINDOW", + "STARTF_USESTDHANDLES", + "STARTUPINFO", + "STD_ERROR_HANDLE", + "STD_INPUT_HANDLE", + "STD_OUTPUT_HANDLE", + "SW_HIDE", + "ABOVE_NORMAL_PRIORITY_CLASS", + "BELOW_NORMAL_PRIORITY_CLASS", + "CREATE_BREAKAWAY_FROM_JOB", + "CREATE_DEFAULT_ERROR_MODE", + "CREATE_NO_WINDOW", + "DETACHED_PROCESS", + "HIGH_PRIORITY_CLASS", + "IDLE_PRIORITY_CLASS", + "NORMAL_PRIORITY_CLASS", + "REALTIME_PRIORITY_CLASS", + ] + +# We prefer to annotate inputs to methods (eg subprocess.check_call) with these +# union types. +# For outputs we use laborious literal based overloads to try to determine +# which specific return types to use, and prefer to fall back to Any when +# this does not work, so the caller does not have to use an assertion to confirm +# which type. +# +# For example: +# +# try: +# x = subprocess.check_output(["ls", "-l"]) +# reveal_type(x) # bytes, based on the overloads +# except TimeoutError as e: +# reveal_type(e.cmd) # Any, but morally is _CMD +_FILE: TypeAlias = None | int | IO[Any] +_InputString: TypeAlias = ReadableBuffer | str +_CMD: TypeAlias = StrOrBytesPath | Sequence[StrOrBytesPath] +if sys.platform == "win32": + _ENV: TypeAlias = Mapping[str, str] +else: + _ENV: TypeAlias = Mapping[bytes, StrOrBytesPath] | Mapping[str, StrOrBytesPath] + +_T = TypeVar("_T") + +# These two are private but documented +if sys.version_info >= (3, 11): + _USE_VFORK: Final[bool] +_USE_POSIX_SPAWN: Final[bool] + +class CompletedProcess(Generic[_T]): + # morally: _CMD + args: Any + returncode: int + # These can both be None, but requiring checks for None would be tedious + # and writing all the overloads would be horrific. + stdout: _T + stderr: _T + def __init__(self, args: _CMD, returncode: int, stdout: _T | None = None, stderr: _T | None = None) -> None: ... + def check_returncode(self) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +if sys.version_info >= (3, 11): + # 3.11 adds "process_group" argument + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: Literal[True], + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the *real* keyword only args start + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: None = None, + errors: None = None, + input: ReadableBuffer | None = None, + text: Literal[False] | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[bytes]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: _InputString | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> CompletedProcess[Any]: ... + +elif sys.version_info >= (3, 10): + # 3.10 adds "pipesize" argument + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: Literal[True], + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the *real* keyword only args start + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: None = None, + errors: None = None, + input: ReadableBuffer | None = None, + text: Literal[False] | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[bytes]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: _InputString | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> CompletedProcess[Any]: ... + +else: + # 3.9 adds arguments "user", "group", "extra_groups" and "umask" + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: Literal[True], + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the *real* keyword only args start + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: str | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[str]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: None = None, + errors: None = None, + input: ReadableBuffer | None = None, + text: Literal[False] | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[bytes]: ... + @overload + def run( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + capture_output: bool = False, + check: bool = False, + encoding: str | None = None, + errors: str | None = None, + input: _InputString | None = None, + text: bool | None = None, + timeout: float | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> CompletedProcess[Any]: ... + +# Same args as Popen.__init__ +if sys.version_info >= (3, 11): + # 3.11 adds "process_group" argument + def call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + encoding: str | None = None, + timeout: float | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> int: ... + +elif sys.version_info >= (3, 10): + # 3.10 adds "pipesize" argument + def call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + encoding: str | None = None, + timeout: float | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> int: ... + +else: + def call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + encoding: str | None = None, + timeout: float | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> int: ... + +# Same args as Popen.__init__ +if sys.version_info >= (3, 11): + # 3.11 adds "process_group" argument + def check_call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + timeout: float | None = ..., + *, + encoding: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> int: ... + +elif sys.version_info >= (3, 10): + # 3.10 adds "pipesize" argument + def check_call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + timeout: float | None = ..., + *, + encoding: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> int: ... + +else: + def check_call( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stdout: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + timeout: float | None = ..., + *, + encoding: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> int: ... + +if sys.version_info >= (3, 11): + # 3.11 adds "process_group" argument + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: Literal[True], + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the real keyword only ones start + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> bytes: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> Any: ... # morally: -> str | bytes + +elif sys.version_info >= (3, 10): + # 3.10 adds "pipesize" argument + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: Literal[True], + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the real keyword only ones start + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> bytes: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> Any: ... # morally: -> str | bytes + +else: + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: Literal[True], + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + # where the real keyword only ones start + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> str: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: None = None, + errors: None = None, + text: Literal[False] | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> bytes: ... + @overload + def check_output( + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE = None, + stderr: _FILE = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = ..., + *, + timeout: float | None = None, + input: _InputString | None = ..., + encoding: str | None = None, + errors: str | None = None, + text: bool | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> Any: ... # morally: -> str | bytes + +PIPE: Final[int] +STDOUT: Final[int] +DEVNULL: Final[int] + +class SubprocessError(Exception): ... + +class TimeoutExpired(SubprocessError): + def __init__( + self, cmd: _CMD, timeout: float, output: str | bytes | None = None, stderr: str | bytes | None = None + ) -> None: ... + # morally: _CMD + cmd: Any + timeout: float + # morally: str | bytes | None + output: Any + stdout: bytes | None + stderr: bytes | None + +class CalledProcessError(SubprocessError): + returncode: int + # morally: _CMD + cmd: Any + # morally: str | bytes | None + output: Any + + # morally: str | bytes | None + stdout: Any + stderr: Any + def __init__( + self, returncode: int, cmd: _CMD, output: str | bytes | None = None, stderr: str | bytes | None = None + ) -> None: ... + +class Popen(Generic[AnyStr]): + args: _CMD + stdin: IO[AnyStr] | None + stdout: IO[AnyStr] | None + stderr: IO[AnyStr] | None + pid: int + returncode: int | MaybeNone + universal_newlines: bool + + if sys.version_info >= (3, 11): + # process_group is added in 3.11 + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + # where the *real* keyword only args start + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[True], + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + @overload + def __init__( + self: Popen[bytes], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[False] | None = None, + encoding: None = None, + errors: None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + @overload + def __init__( + self: Popen[Any], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + process_group: int | None = None, + ) -> None: ... + elif sys.version_info >= (3, 10): + # pipesize is added in 3.10 + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + # where the *real* keyword only args start + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[True], + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[bytes], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[False] | None = None, + encoding: None = None, + errors: None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[Any], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + pipesize: int = -1, + ) -> None: ... + else: + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + *, + universal_newlines: Literal[True], + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + # where the *real* keyword only args start + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[str], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[True], + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[bytes], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: Literal[False] | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: Literal[False] | None = None, + encoding: None = None, + errors: None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + @overload + def __init__( + self: Popen[Any], + args: _CMD, + bufsize: int = -1, + executable: StrOrBytesPath | None = None, + stdin: _FILE | None = None, + stdout: _FILE | None = None, + stderr: _FILE | None = None, + preexec_fn: Callable[[], Any] | None = None, + close_fds: bool = True, + shell: bool = False, + cwd: StrOrBytesPath | None = None, + env: _ENV | None = None, + universal_newlines: bool | None = None, + startupinfo: Any | None = None, + creationflags: int = 0, + restore_signals: bool = True, + start_new_session: bool = False, + pass_fds: Collection[int] = (), + *, + text: bool | None = None, + encoding: str | None = None, + errors: str | None = None, + user: str | int | None = None, + group: str | int | None = None, + extra_groups: Iterable[str | int] | None = None, + umask: int = -1, + ) -> None: ... + + def poll(self) -> int | None: ... + def wait(self, timeout: float | None = None) -> int: ... + # morally the members of the returned tuple should be optional + # TODO: this should allow ReadableBuffer for Popen[bytes], but adding + # overloads for that runs into a mypy bug (python/mypy#14070). + def communicate(self, input: AnyStr | None = None, timeout: float | None = None) -> tuple[AnyStr, AnyStr]: ... + def send_signal(self, sig: int) -> None: ... + def terminate(self) -> None: ... + def kill(self) -> None: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + def __del__(self) -> None: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +# The result really is always a str. +if sys.version_info >= (3, 11): + def getstatusoutput(cmd: _CMD, *, encoding: str | None = None, errors: str | None = None) -> tuple[int, str]: ... + def getoutput(cmd: _CMD, *, encoding: str | None = None, errors: str | None = None) -> str: ... + +else: + def getstatusoutput(cmd: _CMD) -> tuple[int, str]: ... + def getoutput(cmd: _CMD) -> str: ... + +def list2cmdline(seq: Iterable[StrOrBytesPath]) -> str: ... # undocumented + +if sys.platform == "win32": + if sys.version_info >= (3, 13): + from _winapi import STARTF_FORCEOFFFEEDBACK, STARTF_FORCEONFEEDBACK + + __all__ += ["STARTF_FORCEOFFFEEDBACK", "STARTF_FORCEONFEEDBACK"] + + class STARTUPINFO: + def __init__( + self, + *, + dwFlags: int = 0, + hStdInput: Any | None = None, + hStdOutput: Any | None = None, + hStdError: Any | None = None, + wShowWindow: int = 0, + lpAttributeList: Mapping[str, Any] | None = None, + ) -> None: ... + dwFlags: int + hStdInput: Any | None + hStdOutput: Any | None + hStdError: Any | None + wShowWindow: int + lpAttributeList: Mapping[str, Any] + def copy(self) -> STARTUPINFO: ... + + from _winapi import ( + ABOVE_NORMAL_PRIORITY_CLASS as ABOVE_NORMAL_PRIORITY_CLASS, + BELOW_NORMAL_PRIORITY_CLASS as BELOW_NORMAL_PRIORITY_CLASS, + CREATE_BREAKAWAY_FROM_JOB as CREATE_BREAKAWAY_FROM_JOB, + CREATE_DEFAULT_ERROR_MODE as CREATE_DEFAULT_ERROR_MODE, + CREATE_NEW_CONSOLE as CREATE_NEW_CONSOLE, + CREATE_NEW_PROCESS_GROUP as CREATE_NEW_PROCESS_GROUP, + CREATE_NO_WINDOW as CREATE_NO_WINDOW, + DETACHED_PROCESS as DETACHED_PROCESS, + HIGH_PRIORITY_CLASS as HIGH_PRIORITY_CLASS, + IDLE_PRIORITY_CLASS as IDLE_PRIORITY_CLASS, + NORMAL_PRIORITY_CLASS as NORMAL_PRIORITY_CLASS, + REALTIME_PRIORITY_CLASS as REALTIME_PRIORITY_CLASS, + STARTF_USESHOWWINDOW as STARTF_USESHOWWINDOW, + STARTF_USESTDHANDLES as STARTF_USESTDHANDLES, + STD_ERROR_HANDLE as STD_ERROR_HANDLE, + STD_INPUT_HANDLE as STD_INPUT_HANDLE, + STD_OUTPUT_HANDLE as STD_OUTPUT_HANDLE, + SW_HIDE as SW_HIDE, + ) diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sunau.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sunau.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sunau.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sunau.pyi index 9b051e82b64bc..d81645cb5687f 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/sunau.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sunau.pyi @@ -1,4 +1,3 @@ -import sys from _typeshed import Unused from typing import IO, Any, Literal, NamedTuple, NoReturn, overload from typing_extensions import Self, TypeAlias @@ -81,6 +80,3 @@ def open(f: _File, mode: Literal["r", "rb"]) -> Au_read: ... def open(f: _File, mode: Literal["w", "wb"]) -> Au_write: ... @overload def open(f: _File, mode: str | None = None) -> Any: ... - -if sys.version_info < (3, 9): - openfp = open diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/symbol.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/symbol.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/symbol.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/symbol.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/symtable.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/symtable.pyi similarity index 92% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/symtable.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/symtable.pyi index ee0a1eb2f1cb5..d5f2be04b6009 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/symtable.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/symtable.pyi @@ -36,9 +36,6 @@ class SymbolTable: def is_optimized(self) -> bool: ... def is_nested(self) -> bool: ... def has_children(self) -> bool: ... - if sys.version_info < (3, 9): - def has_exec(self) -> bool: ... - def get_identifiers(self) -> dict_keys[str, int]: ... def lookup(self, name: str) -> Symbol: ... def get_symbols(self) -> list[Symbol]: ... @@ -52,9 +49,8 @@ class Function(SymbolTable): def get_nonlocals(self) -> tuple[str, ...]: ... class Class(SymbolTable): - if sys.version_info < (3, 16): - @deprecated("deprecated in Python 3.14, will be removed in Python 3.16") - def get_methods(self) -> tuple[str, ...]: ... + @deprecated("deprecated in Python 3.14, will be removed in Python 3.16") + def get_methods(self) -> tuple[str, ...]: ... class Symbol: def __init__( diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/sys/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sys/__init__.pyi new file mode 100644 index 0000000000000..2d894674c4af6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/sys/__init__.pyi @@ -0,0 +1,472 @@ +import sys +from _typeshed import MaybeNone, OptExcInfo, ProfileFunction, TraceFunction, structseq +from _typeshed.importlib import MetaPathFinderProtocol, PathEntryFinderProtocol +from builtins import object as _object +from collections.abc import AsyncGenerator, Callable, Sequence +from io import TextIOWrapper +from types import FrameType, ModuleType, TracebackType +from typing import Any, Final, Literal, NoReturn, Protocol, TextIO, TypeVar, final, type_check_only +from typing_extensions import LiteralString, TypeAlias + +_T = TypeVar("_T") + +# see https://github.com/python/typeshed/issues/8513#issue-1333671093 for the rationale behind this alias +_ExitCode: TypeAlias = str | int | None + +# ----- sys variables ----- +if sys.platform != "win32": + abiflags: str +argv: list[str] +base_exec_prefix: str +base_prefix: str +byteorder: Literal["little", "big"] +builtin_module_names: Sequence[str] # actually a tuple of strings +copyright: str +if sys.platform == "win32": + dllhandle: int +dont_write_bytecode: bool +displayhook: Callable[[object], Any] +excepthook: Callable[[type[BaseException], BaseException, TracebackType | None], Any] +exec_prefix: str +executable: str +float_repr_style: Literal["short", "legacy"] +hexversion: int +last_type: type[BaseException] | None +last_value: BaseException | None +last_traceback: TracebackType | None +if sys.version_info >= (3, 12): + last_exc: BaseException # or undefined. +maxsize: int +maxunicode: int +meta_path: list[MetaPathFinderProtocol] +modules: dict[str, ModuleType] +if sys.version_info >= (3, 10): + orig_argv: list[str] +path: list[str] +path_hooks: list[Callable[[str], PathEntryFinderProtocol]] +path_importer_cache: dict[str, PathEntryFinderProtocol | None] +platform: LiteralString +platlibdir: str +prefix: str +pycache_prefix: str | None +ps1: object +ps2: object + +# TextIO is used instead of more specific types for the standard streams, +# since they are often monkeypatched at runtime. At startup, the objects +# are initialized to instances of TextIOWrapper, but can also be None under +# some circumstances. +# +# To use methods from TextIOWrapper, use an isinstance check to ensure that +# the streams have not been overridden: +# +# if isinstance(sys.stdout, io.TextIOWrapper): +# sys.stdout.reconfigure(...) +stdin: TextIO | MaybeNone +stdout: TextIO | MaybeNone +stderr: TextIO | MaybeNone + +if sys.version_info >= (3, 10): + stdlib_module_names: frozenset[str] + +__stdin__: Final[TextIOWrapper | None] # Contains the original value of stdin +__stdout__: Final[TextIOWrapper | None] # Contains the original value of stdout +__stderr__: Final[TextIOWrapper | None] # Contains the original value of stderr +tracebacklimit: int | None +version: str +api_version: int +warnoptions: Any +# Each entry is a tuple of the form (action, message, category, module, +# lineno) +if sys.platform == "win32": + winver: str +_xoptions: dict[Any, Any] + +# Type alias used as a mixin for structseq classes that cannot be instantiated at runtime +# This can't be represented in the type system, so we just use `structseq[Any]` +_UninstantiableStructseq: TypeAlias = structseq[Any] + +flags: _flags + +# This class is not exposed at runtime. It calls itself sys.flags. +# As a tuple, it can have a length between 15 and 18. We don't model +# the exact length here because that varies by patch version due to +# the backported security fix int_max_str_digits. The exact length shouldn't +# be relied upon. See #13031 +# This can be re-visited when typeshed drops support for 3.10, +# at which point all supported versions will include int_max_str_digits +# in all patch versions. +# 3.9 is 15 or 16-tuple +# 3.10 is 16 or 17-tuple +# 3.11+ is an 18-tuple. +@final +@type_check_only +class _flags(_UninstantiableStructseq, tuple[int, ...]): + # `safe_path` was added in py311 + if sys.version_info >= (3, 11): + __match_args__: Final = ( + "debug", + "inspect", + "interactive", + "optimize", + "dont_write_bytecode", + "no_user_site", + "no_site", + "ignore_environment", + "verbose", + "bytes_warning", + "quiet", + "hash_randomization", + "isolated", + "dev_mode", + "utf8_mode", + "warn_default_encoding", + "safe_path", + "int_max_str_digits", + ) + elif sys.version_info >= (3, 10): + __match_args__: Final = ( + "debug", + "inspect", + "interactive", + "optimize", + "dont_write_bytecode", + "no_user_site", + "no_site", + "ignore_environment", + "verbose", + "bytes_warning", + "quiet", + "hash_randomization", + "isolated", + "dev_mode", + "utf8_mode", + "warn_default_encoding", + "int_max_str_digits", + ) + + @property + def debug(self) -> int: ... + @property + def inspect(self) -> int: ... + @property + def interactive(self) -> int: ... + @property + def optimize(self) -> int: ... + @property + def dont_write_bytecode(self) -> int: ... + @property + def no_user_site(self) -> int: ... + @property + def no_site(self) -> int: ... + @property + def ignore_environment(self) -> int: ... + @property + def verbose(self) -> int: ... + @property + def bytes_warning(self) -> int: ... + @property + def quiet(self) -> int: ... + @property + def hash_randomization(self) -> int: ... + @property + def isolated(self) -> int: ... + @property + def dev_mode(self) -> bool: ... + @property + def utf8_mode(self) -> int: ... + if sys.version_info >= (3, 10): + @property + def warn_default_encoding(self) -> int: ... + if sys.version_info >= (3, 11): + @property + def safe_path(self) -> bool: ... + # Whether or not this exists on lower versions of Python + # may depend on which patch release you're using + # (it was backported to all Python versions on 3.8+ as a security fix) + # Added in: 3.9.14, 3.10.7 + # and present in all versions of 3.11 and later. + @property + def int_max_str_digits(self) -> int: ... + +float_info: _float_info + +# This class is not exposed at runtime. It calls itself sys.float_info. +@final +@type_check_only +class _float_info(structseq[float], tuple[float, int, int, float, int, int, int, int, float, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ( + "max", + "max_exp", + "max_10_exp", + "min", + "min_exp", + "min_10_exp", + "dig", + "mant_dig", + "epsilon", + "radix", + "rounds", + ) + + @property + def max(self) -> float: ... # DBL_MAX + @property + def max_exp(self) -> int: ... # DBL_MAX_EXP + @property + def max_10_exp(self) -> int: ... # DBL_MAX_10_EXP + @property + def min(self) -> float: ... # DBL_MIN + @property + def min_exp(self) -> int: ... # DBL_MIN_EXP + @property + def min_10_exp(self) -> int: ... # DBL_MIN_10_EXP + @property + def dig(self) -> int: ... # DBL_DIG + @property + def mant_dig(self) -> int: ... # DBL_MANT_DIG + @property + def epsilon(self) -> float: ... # DBL_EPSILON + @property + def radix(self) -> int: ... # FLT_RADIX + @property + def rounds(self) -> int: ... # FLT_ROUNDS + +hash_info: _hash_info + +# This class is not exposed at runtime. It calls itself sys.hash_info. +@final +@type_check_only +class _hash_info(structseq[Any | int], tuple[int, int, int, int, int, str, int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("width", "modulus", "inf", "nan", "imag", "algorithm", "hash_bits", "seed_bits", "cutoff") + + @property + def width(self) -> int: ... + @property + def modulus(self) -> int: ... + @property + def inf(self) -> int: ... + @property + def nan(self) -> int: ... + @property + def imag(self) -> int: ... + @property + def algorithm(self) -> str: ... + @property + def hash_bits(self) -> int: ... + @property + def seed_bits(self) -> int: ... + @property + def cutoff(self) -> int: ... # undocumented + +implementation: _implementation + +# This class isn't really a thing. At runtime, implementation is an instance +# of types.SimpleNamespace. This allows for better typing. +@type_check_only +class _implementation: + name: str + version: _version_info + hexversion: int + cache_tag: str + # Define __getattr__, as the documentation states: + # > sys.implementation may contain additional attributes specific to the Python implementation. + # > These non-standard attributes must start with an underscore, and are not described here. + def __getattr__(self, name: str) -> Any: ... + +int_info: _int_info + +# This class is not exposed at runtime. It calls itself sys.int_info. +@final +@type_check_only +class _int_info(structseq[int], tuple[int, int, int, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("bits_per_digit", "sizeof_digit", "default_max_str_digits", "str_digits_check_threshold") + + @property + def bits_per_digit(self) -> int: ... + @property + def sizeof_digit(self) -> int: ... + @property + def default_max_str_digits(self) -> int: ... + @property + def str_digits_check_threshold(self) -> int: ... + +_ThreadInfoName: TypeAlias = Literal["nt", "pthread", "pthread-stubs", "solaris"] +_ThreadInfoLock: TypeAlias = Literal["semaphore", "mutex+cond"] | None + +# This class is not exposed at runtime. It calls itself sys.thread_info. +@final +@type_check_only +class _thread_info(_UninstantiableStructseq, tuple[_ThreadInfoName, _ThreadInfoLock, str | None]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("name", "lock", "version") + + @property + def name(self) -> _ThreadInfoName: ... + @property + def lock(self) -> _ThreadInfoLock: ... + @property + def version(self) -> str | None: ... + +thread_info: _thread_info +_ReleaseLevel: TypeAlias = Literal["alpha", "beta", "candidate", "final"] + +# This class is not exposed at runtime. It calls itself sys.version_info. +@final +@type_check_only +class _version_info(_UninstantiableStructseq, tuple[int, int, int, _ReleaseLevel, int]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("major", "minor", "micro", "releaselevel", "serial") + + @property + def major(self) -> int: ... + @property + def minor(self) -> int: ... + @property + def micro(self) -> int: ... + @property + def releaselevel(self) -> _ReleaseLevel: ... + @property + def serial(self) -> int: ... + +version_info: _version_info + +def call_tracing(func: Callable[..., _T], args: Any, /) -> _T: ... +def _clear_type_cache() -> None: ... +def _current_frames() -> dict[int, FrameType]: ... +def _getframe(depth: int = 0, /) -> FrameType: ... +def _debugmallocstats() -> None: ... +def __displayhook__(object: object, /) -> None: ... +def __excepthook__(exctype: type[BaseException], value: BaseException, traceback: TracebackType | None, /) -> None: ... +def exc_info() -> OptExcInfo: ... + +if sys.version_info >= (3, 11): + def exception() -> BaseException | None: ... + +def exit(status: _ExitCode = None, /) -> NoReturn: ... +def getallocatedblocks() -> int: ... +def getdefaultencoding() -> str: ... + +if sys.platform != "win32": + def getdlopenflags() -> int: ... + +def getfilesystemencoding() -> str: ... +def getfilesystemencodeerrors() -> str: ... +def getrefcount(object: Any, /) -> int: ... +def getrecursionlimit() -> int: ... +def getsizeof(obj: object, default: int = ...) -> int: ... +def getswitchinterval() -> float: ... +def getprofile() -> ProfileFunction | None: ... +def setprofile(function: ProfileFunction | None, /) -> None: ... +def gettrace() -> TraceFunction | None: ... +def settrace(function: TraceFunction | None, /) -> None: ... + +if sys.platform == "win32": + # A tuple of length 5, even though it has more than 5 attributes. + @final + class _WinVersion(_UninstantiableStructseq, tuple[int, int, int, int, str]): + @property + def major(self) -> int: ... + @property + def minor(self) -> int: ... + @property + def build(self) -> int: ... + @property + def platform(self) -> int: ... + @property + def service_pack(self) -> str: ... + @property + def service_pack_minor(self) -> int: ... + @property + def service_pack_major(self) -> int: ... + @property + def suite_mask(self) -> int: ... + @property + def product_type(self) -> int: ... + @property + def platform_version(self) -> tuple[int, int, int]: ... + + def getwindowsversion() -> _WinVersion: ... + +def intern(string: str, /) -> str: ... + +if sys.version_info >= (3, 13): + def _is_gil_enabled() -> bool: ... + def _clear_internal_caches() -> None: ... + def _is_interned(string: str, /) -> bool: ... + +def is_finalizing() -> bool: ... +def breakpointhook(*args: Any, **kwargs: Any) -> Any: ... + +__breakpointhook__ = breakpointhook # Contains the original value of breakpointhook + +if sys.platform != "win32": + def setdlopenflags(flags: int, /) -> None: ... + +def setrecursionlimit(limit: int, /) -> None: ... +def setswitchinterval(interval: float, /) -> None: ... +def gettotalrefcount() -> int: ... # Debug builds only + +# Doesn't exist at runtime, but exported in the stubs so pytest etc. can annotate their code more easily. +@type_check_only +class UnraisableHookArgs(Protocol): + exc_type: type[BaseException] + exc_value: BaseException | None + exc_traceback: TracebackType | None + err_msg: str | None + object: _object + +unraisablehook: Callable[[UnraisableHookArgs], Any] + +def __unraisablehook__(unraisable: UnraisableHookArgs, /) -> Any: ... +def addaudithook(hook: Callable[[str, tuple[Any, ...]], Any]) -> None: ... +def audit(event: str, /, *args: Any) -> None: ... + +_AsyncgenHook: TypeAlias = Callable[[AsyncGenerator[Any, Any]], None] | None + +# This class is not exposed at runtime. It calls itself builtins.asyncgen_hooks. +@final +@type_check_only +class _asyncgen_hooks(structseq[_AsyncgenHook], tuple[_AsyncgenHook, _AsyncgenHook]): + if sys.version_info >= (3, 10): + __match_args__: Final = ("firstiter", "finalizer") + + @property + def firstiter(self) -> _AsyncgenHook: ... + @property + def finalizer(self) -> _AsyncgenHook: ... + +def get_asyncgen_hooks() -> _asyncgen_hooks: ... +def set_asyncgen_hooks(firstiter: _AsyncgenHook = ..., finalizer: _AsyncgenHook = ...) -> None: ... + +if sys.platform == "win32": + def _enablelegacywindowsfsencoding() -> None: ... + +def get_coroutine_origin_tracking_depth() -> int: ... +def set_coroutine_origin_tracking_depth(depth: int) -> None: ... + +# The following two functions were added in 3.11.0, 3.10.7, and 3.9.14, +# as part of the response to CVE-2020-10735 +def set_int_max_str_digits(maxdigits: int) -> None: ... +def get_int_max_str_digits() -> int: ... + +if sys.version_info >= (3, 12): + if sys.version_info >= (3, 13): + def getunicodeinternedsize(*, _only_immortal: bool = False) -> int: ... + else: + def getunicodeinternedsize() -> int: ... + + def deactivate_stack_trampoline() -> None: ... + def is_stack_trampoline_active() -> bool: ... + # It always exists, but raises on non-linux platforms: + if sys.platform == "linux": + def activate_stack_trampoline(backend: str, /) -> None: ... + else: + def activate_stack_trampoline(backend: str, /) -> NoReturn: ... + + from . import _monitoring + + monitoring = _monitoring diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sys/_monitoring.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sys/_monitoring.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sys/_monitoring.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sys/_monitoring.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/sysconfig.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/sysconfig.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/sysconfig.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/sysconfig.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/syslog.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/syslog.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/syslog.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/syslog.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tabnanny.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tabnanny.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tabnanny.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tabnanny.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/tarfile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tarfile.pyi new file mode 100644 index 0000000000000..31094f87872dc --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tarfile.pyi @@ -0,0 +1,685 @@ +import bz2 +import io +import sys +from _typeshed import ReadableBuffer, StrOrBytesPath, StrPath, SupportsRead, WriteableBuffer +from builtins import list as _list # aliases to avoid name clashes with fields named "type" or "list" +from collections.abc import Callable, Iterable, Iterator, Mapping +from gzip import _ReadableFileobj as _GzipReadableFileobj, _WritableFileobj as _GzipWritableFileobj +from types import TracebackType +from typing import IO, ClassVar, Literal, Protocol, overload +from typing_extensions import Self, TypeAlias, deprecated + +__all__ = [ + "TarFile", + "TarInfo", + "is_tarfile", + "TarError", + "ReadError", + "CompressionError", + "StreamError", + "ExtractError", + "HeaderError", + "ENCODING", + "USTAR_FORMAT", + "GNU_FORMAT", + "PAX_FORMAT", + "DEFAULT_FORMAT", + "open", +] +if sys.version_info >= (3, 12): + __all__ += [ + "fully_trusted_filter", + "data_filter", + "tar_filter", + "FilterError", + "AbsoluteLinkError", + "OutsideDestinationError", + "SpecialFileError", + "AbsolutePathError", + "LinkOutsideDestinationError", + ] + +_FilterFunction: TypeAlias = Callable[[TarInfo, str], TarInfo | None] +_TarfileFilter: TypeAlias = Literal["fully_trusted", "tar", "data"] | _FilterFunction + +class _Fileobj(Protocol): + def read(self, size: int, /) -> bytes: ... + def write(self, b: bytes, /) -> object: ... + def tell(self) -> int: ... + def seek(self, pos: int, /) -> object: ... + def close(self) -> object: ... + # Optional fields: + # name: str | bytes + # mode: Literal["rb", "r+b", "wb", "xb"] + +class _Bz2ReadableFileobj(bz2._ReadableFileobj): + def close(self) -> object: ... + +class _Bz2WritableFileobj(bz2._WritableFileobj): + def close(self) -> object: ... + +# tar constants +NUL: bytes +BLOCKSIZE: int +RECORDSIZE: int +GNU_MAGIC: bytes +POSIX_MAGIC: bytes + +LENGTH_NAME: int +LENGTH_LINK: int +LENGTH_PREFIX: int + +REGTYPE: bytes +AREGTYPE: bytes +LNKTYPE: bytes +SYMTYPE: bytes +CONTTYPE: bytes +BLKTYPE: bytes +DIRTYPE: bytes +FIFOTYPE: bytes +CHRTYPE: bytes + +GNUTYPE_LONGNAME: bytes +GNUTYPE_LONGLINK: bytes +GNUTYPE_SPARSE: bytes + +XHDTYPE: bytes +XGLTYPE: bytes +SOLARIS_XHDTYPE: bytes + +USTAR_FORMAT: int +GNU_FORMAT: int +PAX_FORMAT: int +DEFAULT_FORMAT: int + +# tarfile constants + +SUPPORTED_TYPES: tuple[bytes, ...] +REGULAR_TYPES: tuple[bytes, ...] +GNU_TYPES: tuple[bytes, ...] +PAX_FIELDS: tuple[str, ...] +PAX_NUMBER_FIELDS: dict[str, type] +PAX_NAME_FIELDS: set[str] + +ENCODING: str + +class ExFileObject(io.BufferedReader): + def __init__(self, tarfile: TarFile, tarinfo: TarInfo) -> None: ... + +class TarFile: + OPEN_METH: ClassVar[Mapping[str, str]] + name: StrOrBytesPath | None + mode: Literal["r", "a", "w", "x"] + fileobj: _Fileobj | None + format: int | None + tarinfo: type[TarInfo] + dereference: bool | None + ignore_zeros: bool | None + encoding: str | None + errors: str + fileobject: type[ExFileObject] + pax_headers: Mapping[str, str] | None + debug: int | None + errorlevel: int | None + offset: int # undocumented + extraction_filter: _FilterFunction | None + if sys.version_info >= (3, 13): + stream: bool + def __init__( + self, + name: StrOrBytesPath | None = None, + mode: Literal["r", "a", "w", "x"] = "r", + fileobj: _Fileobj | None = None, + format: int | None = None, + tarinfo: type[TarInfo] | None = None, + dereference: bool | None = None, + ignore_zeros: bool | None = None, + encoding: str | None = None, + errors: str = "surrogateescape", + pax_headers: Mapping[str, str] | None = None, + debug: int | None = None, + errorlevel: int | None = None, + copybufsize: int | None = None, # undocumented + stream: bool = False, + ) -> None: ... + else: + def __init__( + self, + name: StrOrBytesPath | None = None, + mode: Literal["r", "a", "w", "x"] = "r", + fileobj: _Fileobj | None = None, + format: int | None = None, + tarinfo: type[TarInfo] | None = None, + dereference: bool | None = None, + ignore_zeros: bool | None = None, + encoding: str | None = None, + errors: str = "surrogateescape", + pax_headers: Mapping[str, str] | None = None, + debug: int | None = None, + errorlevel: int | None = None, + copybufsize: int | None = None, # undocumented + ) -> None: ... + + def __enter__(self) -> Self: ... + def __exit__( + self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + def __iter__(self) -> Iterator[TarInfo]: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None = None, + mode: Literal["r", "r:*", "r:", "r:gz", "r:bz2", "r:xz"] = "r", + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None, + mode: Literal["x", "x:", "a", "a:", "w", "w:", "w:tar"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None = None, + *, + mode: Literal["x", "x:", "a", "a:", "w", "w:", "w:tar"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None, + mode: Literal["x:gz", "x:bz2", "w:gz", "w:bz2"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + compresslevel: int = 9, + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None = None, + *, + mode: Literal["x:gz", "x:bz2", "w:gz", "w:bz2"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + compresslevel: int = 9, + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None, + mode: Literal["x:xz", "w:xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + preset: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9] | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | None = None, + *, + mode: Literal["x:xz", "w:xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + preset: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9] | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | ReadableBuffer | None, + mode: Literal["r|*", "r|", "r|gz", "r|bz2", "r|xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | ReadableBuffer | None = None, + *, + mode: Literal["r|*", "r|", "r|gz", "r|bz2", "r|xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | WriteableBuffer | None, + mode: Literal["w|", "w|xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | WriteableBuffer | None = None, + *, + mode: Literal["w|", "w|xz"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | WriteableBuffer | None, + mode: Literal["w|gz", "w|bz2"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + compresslevel: int = 9, + ) -> Self: ... + @overload + @classmethod + def open( + cls, + name: StrOrBytesPath | WriteableBuffer | None = None, + *, + mode: Literal["w|gz", "w|bz2"], + fileobj: _Fileobj | None = None, + bufsize: int = 10240, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + errors: str = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + compresslevel: int = 9, + ) -> Self: ... + @classmethod + def taropen( + cls, + name: StrOrBytesPath | None, + mode: Literal["r", "a", "w", "x"] = "r", + fileobj: _Fileobj | None = None, + *, + compresslevel: int = ..., + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def gzopen( + cls, + name: StrOrBytesPath | None, + mode: Literal["r"] = "r", + fileobj: _GzipReadableFileobj | None = None, + compresslevel: int = 9, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def gzopen( + cls, + name: StrOrBytesPath | None, + mode: Literal["w", "x"], + fileobj: _GzipWritableFileobj | None = None, + compresslevel: int = 9, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def bz2open( + cls, + name: StrOrBytesPath | None, + mode: Literal["w", "x"], + fileobj: _Bz2WritableFileobj | None = None, + compresslevel: int = 9, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @overload + @classmethod + def bz2open( + cls, + name: StrOrBytesPath | None, + mode: Literal["r"] = "r", + fileobj: _Bz2ReadableFileobj | None = None, + compresslevel: int = 9, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + @classmethod + def xzopen( + cls, + name: StrOrBytesPath | None, + mode: Literal["r", "w", "x"] = "r", + fileobj: IO[bytes] | None = None, + preset: int | None = None, + *, + format: int | None = ..., + tarinfo: type[TarInfo] | None = ..., + dereference: bool | None = ..., + ignore_zeros: bool | None = ..., + encoding: str | None = ..., + pax_headers: Mapping[str, str] | None = ..., + debug: int | None = ..., + errorlevel: int | None = ..., + ) -> Self: ... + def getmember(self, name: str) -> TarInfo: ... + def getmembers(self) -> _list[TarInfo]: ... + def getnames(self) -> _list[str]: ... + def list(self, verbose: bool = True, *, members: _list[TarInfo] | None = None) -> None: ... + def next(self) -> TarInfo | None: ... + # Calling this method without `filter` is deprecated, but it may be set either on the class or in an + # individual call, so we can't mark it as @deprecated here. + def extractall( + self, + path: StrOrBytesPath = ".", + members: Iterable[TarInfo] | None = None, + *, + numeric_owner: bool = False, + filter: _TarfileFilter | None = ..., + ) -> None: ... + # Same situation as for `extractall`. + def extract( + self, + member: str | TarInfo, + path: StrOrBytesPath = "", + set_attrs: bool = True, + *, + numeric_owner: bool = False, + filter: _TarfileFilter | None = ..., + ) -> None: ... + def _extract_member( + self, tarinfo: TarInfo, targetpath: str, set_attrs: bool = True, numeric_owner: bool = False + ) -> None: ... # undocumented + def extractfile(self, member: str | TarInfo) -> IO[bytes] | None: ... + def makedir(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def makefile(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def makeunknown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def makefifo(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def makedev(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def makelink(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def chown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath, numeric_owner: bool) -> None: ... # undocumented + def chmod(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def utime(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented + def add( + self, + name: StrPath, + arcname: StrPath | None = None, + recursive: bool = True, + *, + filter: Callable[[TarInfo], TarInfo | None] | None = None, + ) -> None: ... + def addfile(self, tarinfo: TarInfo, fileobj: SupportsRead[bytes] | None = None) -> None: ... + def gettarinfo( + self, name: StrOrBytesPath | None = None, arcname: str | None = None, fileobj: IO[bytes] | None = None + ) -> TarInfo: ... + def close(self) -> None: ... + +open = TarFile.open + +def is_tarfile(name: StrOrBytesPath | IO[bytes]) -> bool: ... + +class TarError(Exception): ... +class ReadError(TarError): ... +class CompressionError(TarError): ... +class StreamError(TarError): ... +class ExtractError(TarError): ... +class HeaderError(TarError): ... + +class FilterError(TarError): + # This attribute is only set directly on the subclasses, but the documentation guarantees + # that it is always present on FilterError. + tarinfo: TarInfo + +class AbsolutePathError(FilterError): + def __init__(self, tarinfo: TarInfo) -> None: ... + +class OutsideDestinationError(FilterError): + def __init__(self, tarinfo: TarInfo, path: str) -> None: ... + +class SpecialFileError(FilterError): + def __init__(self, tarinfo: TarInfo) -> None: ... + +class AbsoluteLinkError(FilterError): + def __init__(self, tarinfo: TarInfo) -> None: ... + +class LinkOutsideDestinationError(FilterError): + def __init__(self, tarinfo: TarInfo, path: str) -> None: ... + +def fully_trusted_filter(member: TarInfo, dest_path: str) -> TarInfo: ... +def tar_filter(member: TarInfo, dest_path: str) -> TarInfo: ... +def data_filter(member: TarInfo, dest_path: str) -> TarInfo: ... + +class TarInfo: + name: str + path: str + size: int + mtime: int | float + chksum: int + devmajor: int + devminor: int + offset: int + offset_data: int + sparse: bytes | None + mode: int + type: bytes + linkname: str + uid: int + gid: int + uname: str + gname: str + pax_headers: Mapping[str, str] + def __init__(self, name: str = "") -> None: ... + if sys.version_info >= (3, 13): + @property + @deprecated("Deprecated in Python 3.13; removal scheduled for Python 3.16") + def tarfile(self) -> TarFile | None: ... + @tarfile.setter + @deprecated("Deprecated in Python 3.13; removal scheduled for Python 3.16") + def tarfile(self, tarfile: TarFile | None) -> None: ... + else: + tarfile: TarFile | None + + @classmethod + def frombuf(cls, buf: bytes | bytearray, encoding: str, errors: str) -> Self: ... + @classmethod + def fromtarfile(cls, tarfile: TarFile) -> Self: ... + @property + def linkpath(self) -> str: ... + @linkpath.setter + def linkpath(self, linkname: str) -> None: ... + def replace( + self, + *, + name: str = ..., + mtime: float = ..., + mode: int = ..., + linkname: str = ..., + uid: int = ..., + gid: int = ..., + uname: str = ..., + gname: str = ..., + deep: bool = True, + ) -> Self: ... + def get_info(self) -> Mapping[str, str | int | bytes | Mapping[str, str]]: ... + def tobuf(self, format: int | None = 2, encoding: str | None = "utf-8", errors: str = "surrogateescape") -> bytes: ... + def create_ustar_header( + self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str, errors: str + ) -> bytes: ... + def create_gnu_header( + self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str, errors: str + ) -> bytes: ... + def create_pax_header(self, info: Mapping[str, str | int | bytes | Mapping[str, str]], encoding: str) -> bytes: ... + @classmethod + def create_pax_global_header(cls, pax_headers: Mapping[str, str]) -> bytes: ... + def isfile(self) -> bool: ... + def isreg(self) -> bool: ... + def issparse(self) -> bool: ... + def isdir(self) -> bool: ... + def issym(self) -> bool: ... + def islnk(self) -> bool: ... + def ischr(self) -> bool: ... + def isblk(self) -> bool: ... + def isfifo(self) -> bool: ... + def isdev(self) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/telnetlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/telnetlib.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/telnetlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/telnetlib.pyi index 294a1cb12b63e..6b599256d17b6 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/telnetlib.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/telnetlib.pyi @@ -1,5 +1,5 @@ import socket -from collections.abc import Callable, Sequence +from collections.abc import Callable, MutableSequence, Sequence from re import Match, Pattern from types import TracebackType from typing import Any @@ -114,7 +114,7 @@ class Telnet: def mt_interact(self) -> None: ... def listener(self) -> None: ... def expect( - self, list: Sequence[Pattern[bytes] | bytes], timeout: float | None = None + self, list: MutableSequence[Pattern[bytes] | bytes] | Sequence[Pattern[bytes]], timeout: float | None = None ) -> tuple[int, Match[bytes] | None, bytes]: ... def __enter__(self) -> Self: ... def __exit__( diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tempfile.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tempfile.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tempfile.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tempfile.pyi index 0c19d56fc7a65..ea6e057e410d4 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tempfile.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tempfile.pyi @@ -13,13 +13,10 @@ from _typeshed import ( WriteableBuffer, ) from collections.abc import Iterable, Iterator -from types import TracebackType +from types import GenericAlias, TracebackType from typing import IO, Any, AnyStr, Generic, Literal, overload from typing_extensions import Self -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "NamedTemporaryFile", "TemporaryFile", @@ -387,7 +384,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase): def write(self: SpooledTemporaryFile[bytes], s: ReadableBuffer) -> int: ... @overload def write(self, s: AnyStr) -> int: ... - @overload + @overload # type: ignore[override] def writelines(self: SpooledTemporaryFile[str], iterable: Iterable[str]) -> None: ... @overload def writelines(self: SpooledTemporaryFile[bytes], iterable: Iterable[ReadableBuffer]) -> None: ... @@ -399,8 +396,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase): def seekable(self) -> bool: ... def writable(self) -> bool: ... def __next__(self) -> AnyStr: ... # type: ignore[override] - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class TemporaryDirectory(Generic[AnyStr]): name: AnyStr @@ -458,8 +454,7 @@ class TemporaryDirectory(Generic[AnyStr]): def cleanup(self) -> None: ... def __enter__(self) -> AnyStr: ... def __exit__(self, exc: type[BaseException] | None, value: BaseException | None, tb: TracebackType | None) -> None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... # The overloads overlap, but they should still work fine. @overload diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/termios.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/termios.pyi new file mode 100644 index 0000000000000..5a5a1f53be3c6 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/termios.pyi @@ -0,0 +1,303 @@ +import sys +from _typeshed import FileDescriptorLike +from typing import Any +from typing_extensions import TypeAlias + +# Must be a list of length 7, containing 6 ints and a list of NCCS 1-character bytes or ints. +_Attr: TypeAlias = list[int | list[bytes | int]] | list[int | list[bytes]] | list[int | list[int]] +# Same as _Attr for return types; we use Any to avoid a union. +_AttrReturn: TypeAlias = list[Any] + +if sys.platform != "win32": + B0: int + B110: int + B115200: int + B1200: int + B134: int + B150: int + B1800: int + B19200: int + B200: int + B230400: int + B2400: int + B300: int + B38400: int + B4800: int + B50: int + B57600: int + B600: int + B75: int + B9600: int + BRKINT: int + BS0: int + BS1: int + BSDLY: int + CDSUSP: int + CEOF: int + CEOL: int + CEOT: int + CERASE: int + CFLUSH: int + CINTR: int + CKILL: int + CLNEXT: int + CLOCAL: int + CQUIT: int + CR0: int + CR1: int + CR2: int + CR3: int + CRDLY: int + CREAD: int + CRPRNT: int + CRTSCTS: int + CS5: int + CS6: int + CS7: int + CS8: int + CSIZE: int + CSTART: int + CSTOP: int + CSTOPB: int + CSUSP: int + CWERASE: int + ECHO: int + ECHOCTL: int + ECHOE: int + ECHOK: int + ECHOKE: int + ECHONL: int + ECHOPRT: int + EXTA: int + EXTB: int + FF0: int + FF1: int + FFDLY: int + FIOASYNC: int + FIOCLEX: int + FIONBIO: int + FIONCLEX: int + FIONREAD: int + FLUSHO: int + HUPCL: int + ICANON: int + ICRNL: int + IEXTEN: int + IGNBRK: int + IGNCR: int + IGNPAR: int + IMAXBEL: int + INLCR: int + INPCK: int + ISIG: int + ISTRIP: int + IXANY: int + IXOFF: int + IXON: int + NCCS: int + NL0: int + NL1: int + NLDLY: int + NOFLSH: int + OCRNL: int + OFDEL: int + OFILL: int + ONLCR: int + ONLRET: int + ONOCR: int + OPOST: int + PARENB: int + PARMRK: int + PARODD: int + PENDIN: int + TAB0: int + TAB1: int + TAB2: int + TAB3: int + TABDLY: int + TCIFLUSH: int + TCIOFF: int + TCIOFLUSH: int + TCION: int + TCOFLUSH: int + TCOOFF: int + TCOON: int + TCSADRAIN: int + TCSAFLUSH: int + TCSANOW: int + TIOCCONS: int + TIOCEXCL: int + TIOCGETD: int + TIOCGPGRP: int + TIOCGWINSZ: int + TIOCM_CAR: int + TIOCM_CD: int + TIOCM_CTS: int + TIOCM_DSR: int + TIOCM_DTR: int + TIOCM_LE: int + TIOCM_RI: int + TIOCM_RNG: int + TIOCM_RTS: int + TIOCM_SR: int + TIOCM_ST: int + TIOCMBIC: int + TIOCMBIS: int + TIOCMGET: int + TIOCMSET: int + TIOCNOTTY: int + TIOCNXCL: int + TIOCOUTQ: int + TIOCPKT_DATA: int + TIOCPKT_DOSTOP: int + TIOCPKT_FLUSHREAD: int + TIOCPKT_FLUSHWRITE: int + TIOCPKT_NOSTOP: int + TIOCPKT_START: int + TIOCPKT_STOP: int + TIOCPKT: int + TIOCSCTTY: int + TIOCSETD: int + TIOCSPGRP: int + TIOCSTI: int + TIOCSWINSZ: int + TOSTOP: int + VDISCARD: int + VEOF: int + VEOL: int + VEOL2: int + VERASE: int + VINTR: int + VKILL: int + VLNEXT: int + VMIN: int + VQUIT: int + VREPRINT: int + VSTART: int + VSTOP: int + VSUSP: int + VT0: int + VT1: int + VTDLY: int + VTIME: int + VWERASE: int + + if sys.version_info >= (3, 13): + EXTPROC: int + IUTF8: int + + if sys.platform == "darwin" and sys.version_info >= (3, 13): + ALTWERASE: int + B14400: int + B28800: int + B7200: int + B76800: int + CCAR_OFLOW: int + CCTS_OFLOW: int + CDSR_OFLOW: int + CDTR_IFLOW: int + CIGNORE: int + CRTS_IFLOW: int + MDMBUF: int + NL2: int + NL3: int + NOKERNINFO: int + ONOEOT: int + OXTABS: int + VDSUSP: int + VSTATUS: int + + if sys.platform == "darwin" and sys.version_info >= (3, 11): + TIOCGSIZE: int + TIOCSSIZE: int + + if sys.platform == "linux": + B1152000: int + B576000: int + CBAUD: int + CBAUDEX: int + CIBAUD: int + IOCSIZE_MASK: int + IOCSIZE_SHIFT: int + IUCLC: int + N_MOUSE: int + N_PPP: int + N_SLIP: int + N_STRIP: int + N_TTY: int + NCC: int + OLCUC: int + TCFLSH: int + TCGETA: int + TCGETS: int + TCSBRK: int + TCSBRKP: int + TCSETA: int + TCSETAF: int + TCSETAW: int + TCSETS: int + TCSETSF: int + TCSETSW: int + TCXONC: int + TIOCGICOUNT: int + TIOCGLCKTRMIOS: int + TIOCGSERIAL: int + TIOCGSOFTCAR: int + TIOCINQ: int + TIOCLINUX: int + TIOCMIWAIT: int + TIOCTTYGSTRUCT: int + TIOCSER_TEMT: int + TIOCSERCONFIG: int + TIOCSERGETLSR: int + TIOCSERGETMULTI: int + TIOCSERGSTRUCT: int + TIOCSERGWILD: int + TIOCSERSETMULTI: int + TIOCSERSWILD: int + TIOCSLCKTRMIOS: int + TIOCSSERIAL: int + TIOCSSOFTCAR: int + VSWTC: int + VSWTCH: int + XCASE: int + XTABS: int + + if sys.platform != "darwin": + B1000000: int + B1500000: int + B2000000: int + B2500000: int + B3000000: int + B3500000: int + B4000000: int + B460800: int + B500000: int + B921600: int + + if sys.platform != "linux": + TCSASOFT: int + + if sys.platform != "darwin" and sys.platform != "linux": + # not available on FreeBSD either. + CDEL: int + CEOL2: int + CESC: int + CNUL: int + COMMON: int + CSWTCH: int + IBSHIFT: int + INIT_C_CC: int + NSWTCH: int + + def tcgetattr(fd: FileDescriptorLike, /) -> _AttrReturn: ... + def tcsetattr(fd: FileDescriptorLike, when: int, attributes: _Attr, /) -> None: ... + def tcsendbreak(fd: FileDescriptorLike, duration: int, /) -> None: ... + def tcdrain(fd: FileDescriptorLike, /) -> None: ... + def tcflush(fd: FileDescriptorLike, queue: int, /) -> None: ... + def tcflow(fd: FileDescriptorLike, action: int, /) -> None: ... + if sys.version_info >= (3, 11): + def tcgetwinsize(fd: FileDescriptorLike, /) -> tuple[int, int]: ... + def tcsetwinsize(fd: FileDescriptorLike, winsize: tuple[int, int], /) -> None: ... + + class error(Exception): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/textwrap.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/textwrap.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/textwrap.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/textwrap.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/this.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/this.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/this.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/this.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/threading.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/threading.pyi new file mode 100644 index 0000000000000..d31351754d056 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/threading.pyi @@ -0,0 +1,203 @@ +import _thread +import sys +from _thread import _excepthook, _ExceptHookArgs, get_native_id as get_native_id +from _typeshed import ProfileFunction, TraceFunction +from collections.abc import Callable, Iterable, Mapping +from contextvars import ContextVar +from types import TracebackType +from typing import Any, TypeVar, final +from typing_extensions import deprecated + +_T = TypeVar("_T") + +__all__ = [ + "get_ident", + "active_count", + "Condition", + "current_thread", + "enumerate", + "main_thread", + "TIMEOUT_MAX", + "Event", + "Lock", + "RLock", + "Semaphore", + "BoundedSemaphore", + "Thread", + "Barrier", + "BrokenBarrierError", + "Timer", + "ThreadError", + "ExceptHookArgs", + "setprofile", + "settrace", + "local", + "stack_size", + "excepthook", + "get_native_id", +] + +if sys.version_info >= (3, 10): + __all__ += ["getprofile", "gettrace"] + +if sys.version_info >= (3, 12): + __all__ += ["setprofile_all_threads", "settrace_all_threads"] + +_profile_hook: ProfileFunction | None + +def active_count() -> int: ... +@deprecated("Use active_count() instead") +def activeCount() -> int: ... +def current_thread() -> Thread: ... +@deprecated("Use current_thread() instead") +def currentThread() -> Thread: ... +def get_ident() -> int: ... +def enumerate() -> list[Thread]: ... +def main_thread() -> Thread: ... +def settrace(func: TraceFunction) -> None: ... +def setprofile(func: ProfileFunction | None) -> None: ... + +if sys.version_info >= (3, 12): + def setprofile_all_threads(func: ProfileFunction | None) -> None: ... + def settrace_all_threads(func: TraceFunction) -> None: ... + +if sys.version_info >= (3, 10): + def gettrace() -> TraceFunction | None: ... + def getprofile() -> ProfileFunction | None: ... + +def stack_size(size: int = 0, /) -> int: ... + +TIMEOUT_MAX: float + +ThreadError = _thread.error +local = _thread._local + +class Thread: + name: str + @property + def ident(self) -> int | None: ... + daemon: bool + if sys.version_info >= (3, 14): + def __init__( + self, + group: None = None, + target: Callable[..., object] | None = None, + name: str | None = None, + args: Iterable[Any] = (), + kwargs: Mapping[str, Any] | None = None, + *, + daemon: bool | None = None, + context: ContextVar[Any] | None = None, + ) -> None: ... + else: + def __init__( + self, + group: None = None, + target: Callable[..., object] | None = None, + name: str | None = None, + args: Iterable[Any] = (), + kwargs: Mapping[str, Any] | None = None, + *, + daemon: bool | None = None, + ) -> None: ... + + def start(self) -> None: ... + def run(self) -> None: ... + def join(self, timeout: float | None = None) -> None: ... + @property + def native_id(self) -> int | None: ... # only available on some platforms + def is_alive(self) -> bool: ... + @deprecated("Get the daemon attribute instead") + def isDaemon(self) -> bool: ... + @deprecated("Set the daemon attribute instead") + def setDaemon(self, daemonic: bool) -> None: ... + @deprecated("Use the name attribute instead") + def getName(self) -> str: ... + @deprecated("Use the name attribute instead") + def setName(self, name: str) -> None: ... + +class _DummyThread(Thread): + def __init__(self) -> None: ... + +# This is actually the function _thread.allocate_lock for <= 3.12 +Lock = _thread.LockType + +# Python implementation of RLock. +@final +class _RLock: + _count: int + def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ... + def release(self) -> None: ... + __enter__ = acquire + def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... + + if sys.version_info >= (3, 14): + def locked(self) -> bool: ... + +RLock = _thread.RLock # Actually a function at runtime. + +class Condition: + def __init__(self, lock: Lock | _RLock | RLock | None = None) -> None: ... + def __enter__(self) -> bool: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + def acquire(self, blocking: bool = ..., timeout: float = ...) -> bool: ... + def release(self) -> None: ... + def wait(self, timeout: float | None = None) -> bool: ... + def wait_for(self, predicate: Callable[[], _T], timeout: float | None = None) -> _T: ... + def notify(self, n: int = 1) -> None: ... + def notify_all(self) -> None: ... + @deprecated("Use notify_all() instead") + def notifyAll(self) -> None: ... + +class Semaphore: + _value: int + def __init__(self, value: int = 1) -> None: ... + def __exit__(self, t: type[BaseException] | None, v: BaseException | None, tb: TracebackType | None) -> None: ... + def acquire(self, blocking: bool = True, timeout: float | None = None) -> bool: ... + def __enter__(self, blocking: bool = True, timeout: float | None = None) -> bool: ... + def release(self, n: int = 1) -> None: ... + +class BoundedSemaphore(Semaphore): ... + +class Event: + def is_set(self) -> bool: ... + @deprecated("Use is_set() instead") + def isSet(self) -> bool: ... + def set(self) -> None: ... + def clear(self) -> None: ... + def wait(self, timeout: float | None = None) -> bool: ... + +excepthook = _excepthook +ExceptHookArgs = _ExceptHookArgs + +class Timer(Thread): + args: Iterable[Any] # undocumented + finished: Event # undocumented + function: Callable[..., Any] # undocumented + interval: float # undocumented + kwargs: Mapping[str, Any] # undocumented + + def __init__( + self, + interval: float, + function: Callable[..., object], + args: Iterable[Any] | None = None, + kwargs: Mapping[str, Any] | None = None, + ) -> None: ... + def cancel(self) -> None: ... + +class Barrier: + @property + def parties(self) -> int: ... + @property + def n_waiting(self) -> int: ... + @property + def broken(self) -> bool: ... + def __init__(self, parties: int, action: Callable[[], None] | None = None, timeout: float | None = None) -> None: ... + def wait(self, timeout: float | None = None) -> int: ... + def reset(self) -> None: ... + def abort(self) -> None: ... + +class BrokenBarrierError(RuntimeError): ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/time.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/time.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/time.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/time.pyi index 71cdc4d78fdc4..6d2538ea7e3ee 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/time.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/time.pyi @@ -31,7 +31,7 @@ if sys.platform == "darwin": CLOCK_UPTIME_RAW_APPROX: int CLOCK_MONOTONIC_RAW_APPROX: int -if sys.version_info >= (3, 9) and sys.platform == "linux": +if sys.platform == "linux": CLOCK_TAI: int # Constructor takes an iterable of any type, of length between 9 and 11 elements. diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/timeit.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/timeit.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/timeit.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/timeit.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi new file mode 100644 index 0000000000000..e23ab07f123d4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/__init__.pyi @@ -0,0 +1,4089 @@ +import _tkinter +import sys +from _typeshed import Incomplete, MaybeNone, StrOrBytesPath +from collections.abc import Callable, Iterable, Mapping, Sequence +from tkinter.constants import * +from tkinter.font import _FontDescription +from types import TracebackType +from typing import Any, ClassVar, Generic, Literal, NamedTuple, Protocol, TypedDict, TypeVar, overload, type_check_only +from typing_extensions import TypeAlias, TypeVarTuple, Unpack, deprecated + +if sys.version_info >= (3, 11): + from enum import StrEnum +else: + from enum import Enum + +__all__ = [ + "TclError", + "NO", + "FALSE", + "OFF", + "YES", + "TRUE", + "ON", + "N", + "S", + "W", + "E", + "NW", + "SW", + "NE", + "SE", + "NS", + "EW", + "NSEW", + "CENTER", + "NONE", + "X", + "Y", + "BOTH", + "LEFT", + "TOP", + "RIGHT", + "BOTTOM", + "RAISED", + "SUNKEN", + "FLAT", + "RIDGE", + "GROOVE", + "SOLID", + "HORIZONTAL", + "VERTICAL", + "NUMERIC", + "CHAR", + "WORD", + "BASELINE", + "INSIDE", + "OUTSIDE", + "SEL", + "SEL_FIRST", + "SEL_LAST", + "END", + "INSERT", + "CURRENT", + "ANCHOR", + "ALL", + "NORMAL", + "DISABLED", + "ACTIVE", + "HIDDEN", + "CASCADE", + "CHECKBUTTON", + "COMMAND", + "RADIOBUTTON", + "SEPARATOR", + "SINGLE", + "BROWSE", + "MULTIPLE", + "EXTENDED", + "DOTBOX", + "UNDERLINE", + "PIESLICE", + "CHORD", + "ARC", + "FIRST", + "LAST", + "BUTT", + "PROJECTING", + "ROUND", + "BEVEL", + "MITER", + "MOVETO", + "SCROLL", + "UNITS", + "PAGES", + "TkVersion", + "TclVersion", + "READABLE", + "WRITABLE", + "EXCEPTION", + "EventType", + "Event", + "NoDefaultRoot", + "Variable", + "StringVar", + "IntVar", + "DoubleVar", + "BooleanVar", + "mainloop", + "getint", + "getdouble", + "getboolean", + "Misc", + "CallWrapper", + "XView", + "YView", + "Wm", + "Tk", + "Tcl", + "Pack", + "Place", + "Grid", + "BaseWidget", + "Widget", + "Toplevel", + "Button", + "Canvas", + "Checkbutton", + "Entry", + "Frame", + "Label", + "Listbox", + "Menu", + "Menubutton", + "Message", + "Radiobutton", + "Scale", + "Scrollbar", + "Text", + "OptionMenu", + "Image", + "PhotoImage", + "BitmapImage", + "image_names", + "image_types", + "Spinbox", + "LabelFrame", + "PanedWindow", +] + +# Using anything from tkinter.font in this file means that 'import tkinter' +# seems to also load tkinter.font. That's not how it actually works, but +# unfortunately not much can be done about it. https://github.com/python/typeshed/pull/4346 + +TclError = _tkinter.TclError +wantobjects: int +TkVersion: float +TclVersion: float +READABLE = _tkinter.READABLE +WRITABLE = _tkinter.WRITABLE +EXCEPTION = _tkinter.EXCEPTION + +# Quick guide for figuring out which widget class to choose: +# - Misc: any widget (don't use BaseWidget because Tk doesn't inherit from BaseWidget) +# - Widget: anything that is meant to be put into another widget with e.g. pack or grid +# +# Don't trust tkinter's docstrings, because they have been created by copy/pasting from +# Tk's manual pages more than 10 years ago. Use the latest manual pages instead: +# +# $ sudo apt install tk-doc tcl-doc +# $ man 3tk label # tkinter.Label +# $ man 3tk ttk_label # tkinter.ttk.Label +# $ man 3tcl after # tkinter.Misc.after +# +# You can also read the manual pages online: https://www.tcl.tk/doc/ + +# Some widgets have an option named -compound that accepts different values +# than the _Compound defined here. Many other options have similar things. +_Anchor: TypeAlias = Literal["nw", "n", "ne", "w", "center", "e", "sw", "s", "se"] # manual page: Tk_GetAnchor +_ButtonCommand: TypeAlias = str | Callable[[], Any] # accepts string of tcl code, return value is returned from Button.invoke() +_Compound: TypeAlias = Literal["top", "left", "center", "right", "bottom", "none"] # -compound in manual page named 'options' +# manual page: Tk_GetCursor +_Cursor: TypeAlias = str | tuple[str] | tuple[str, str] | tuple[str, str, str] | tuple[str, str, str, str] +# example when it's sequence: entry['invalidcommand'] = [entry.register(print), '%P'] +_EntryValidateCommand: TypeAlias = str | list[str] | tuple[str, ...] | Callable[[], bool] +_ImageSpec: TypeAlias = _Image | str # str can be from e.g. tkinter.image_names() +_Relief: TypeAlias = Literal["raised", "sunken", "flat", "ridge", "solid", "groove"] # manual page: Tk_GetRelief +_ScreenUnits: TypeAlias = str | float # Often the right type instead of int. Manual page: Tk_GetPixels +# -xscrollcommand and -yscrollcommand in 'options' manual page +_XYScrollCommand: TypeAlias = str | Callable[[float, float], object] +_TakeFocusValue: TypeAlias = bool | Literal[0, 1, ""] | Callable[[str], bool | None] # -takefocus in manual page named 'options' + +if sys.version_info >= (3, 11): + @type_check_only + class _VersionInfoTypeBase(NamedTuple): + major: int + minor: int + micro: int + releaselevel: str + serial: int + + class _VersionInfoType(_VersionInfoTypeBase): ... + +if sys.version_info >= (3, 11): + class EventType(StrEnum): + Activate = "36" + ButtonPress = "4" + Button = ButtonPress + ButtonRelease = "5" + Circulate = "26" + CirculateRequest = "27" + ClientMessage = "33" + Colormap = "32" + Configure = "22" + ConfigureRequest = "23" + Create = "16" + Deactivate = "37" + Destroy = "17" + Enter = "7" + Expose = "12" + FocusIn = "9" + FocusOut = "10" + GraphicsExpose = "13" + Gravity = "24" + KeyPress = "2" + Key = "2" + KeyRelease = "3" + Keymap = "11" + Leave = "8" + Map = "19" + MapRequest = "20" + Mapping = "34" + Motion = "6" + MouseWheel = "38" + NoExpose = "14" + Property = "28" + Reparent = "21" + ResizeRequest = "25" + Selection = "31" + SelectionClear = "29" + SelectionRequest = "30" + Unmap = "18" + VirtualEvent = "35" + Visibility = "15" + +else: + class EventType(str, Enum): + Activate = "36" + ButtonPress = "4" + Button = ButtonPress + ButtonRelease = "5" + Circulate = "26" + CirculateRequest = "27" + ClientMessage = "33" + Colormap = "32" + Configure = "22" + ConfigureRequest = "23" + Create = "16" + Deactivate = "37" + Destroy = "17" + Enter = "7" + Expose = "12" + FocusIn = "9" + FocusOut = "10" + GraphicsExpose = "13" + Gravity = "24" + KeyPress = "2" + Key = KeyPress + KeyRelease = "3" + Keymap = "11" + Leave = "8" + Map = "19" + MapRequest = "20" + Mapping = "34" + Motion = "6" + MouseWheel = "38" + NoExpose = "14" + Property = "28" + Reparent = "21" + ResizeRequest = "25" + Selection = "31" + SelectionClear = "29" + SelectionRequest = "30" + Unmap = "18" + VirtualEvent = "35" + Visibility = "15" + +_W = TypeVar("_W", bound=Misc) +# Events considered covariant because you should never assign to event.widget. +_W_co = TypeVar("_W_co", covariant=True, bound=Misc, default=Misc) + +class Event(Generic[_W_co]): + serial: int + num: int + focus: bool + height: int + width: int + keycode: int + state: int | str + time: int + x: int + y: int + x_root: int + y_root: int + char: str + send_event: bool + keysym: str + keysym_num: int + type: EventType + widget: _W_co + delta: int + +def NoDefaultRoot() -> None: ... + +class Variable: + def __init__(self, master: Misc | None = None, value: Incomplete | None = None, name: str | None = None) -> None: ... + def set(self, value) -> None: ... + initialize = set + def get(self): ... + def trace_add(self, mode: Literal["array", "read", "write", "unset"], callback: Callable[[str, str, str], object]) -> str: ... + def trace_remove(self, mode: Literal["array", "read", "write", "unset"], cbname: str) -> None: ... + def trace_info(self) -> list[tuple[tuple[Literal["array", "read", "write", "unset"], ...], str]]: ... + @deprecated("use trace_add() instead of trace()") + def trace(self, mode, callback): ... + @deprecated("use trace_add() instead of trace_variable()") + def trace_variable(self, mode, callback): ... + @deprecated("use trace_remove() instead of trace_vdelete()") + def trace_vdelete(self, mode, cbname) -> None: ... + @deprecated("use trace_info() instead of trace_vinfo()") + def trace_vinfo(self): ... + def __eq__(self, other: object) -> bool: ... + def __del__(self) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] + +class StringVar(Variable): + def __init__(self, master: Misc | None = None, value: str | None = None, name: str | None = None) -> None: ... + def set(self, value: str) -> None: ... + initialize = set + def get(self) -> str: ... + +class IntVar(Variable): + def __init__(self, master: Misc | None = None, value: int | None = None, name: str | None = None) -> None: ... + def set(self, value: int) -> None: ... + initialize = set + def get(self) -> int: ... + +class DoubleVar(Variable): + def __init__(self, master: Misc | None = None, value: float | None = None, name: str | None = None) -> None: ... + def set(self, value: float) -> None: ... + initialize = set + def get(self) -> float: ... + +class BooleanVar(Variable): + def __init__(self, master: Misc | None = None, value: bool | None = None, name: str | None = None) -> None: ... + def set(self, value: bool) -> None: ... + initialize = set + def get(self) -> bool: ... + +def mainloop(n: int = 0) -> None: ... + +getint: Incomplete +getdouble: Incomplete + +def getboolean(s): ... + +_Ts = TypeVarTuple("_Ts") + +class _GridIndexInfo(TypedDict, total=False): + minsize: _ScreenUnits + pad: _ScreenUnits + uniform: str | None + weight: int + +class _BusyInfo(TypedDict): + cursor: _Cursor + +class Misc: + master: Misc | None + tk: _tkinter.TkappType + children: dict[str, Widget] + def destroy(self) -> None: ... + def deletecommand(self, name: str) -> None: ... + def tk_strictMotif(self, boolean: Incomplete | None = None): ... + def tk_bisque(self) -> None: ... + def tk_setPalette(self, *args, **kw) -> None: ... + def wait_variable(self, name: str | Variable = "PY_VAR") -> None: ... + waitvar = wait_variable + def wait_window(self, window: Misc | None = None) -> None: ... + def wait_visibility(self, window: Misc | None = None) -> None: ... + def setvar(self, name: str = "PY_VAR", value: str = "1") -> None: ... + def getvar(self, name: str = "PY_VAR"): ... + def getint(self, s): ... + def getdouble(self, s): ... + def getboolean(self, s): ... + def focus_set(self) -> None: ... + focus = focus_set + def focus_force(self) -> None: ... + def focus_get(self) -> Misc | None: ... + def focus_displayof(self) -> Misc | None: ... + def focus_lastfor(self) -> Misc | None: ... + def tk_focusFollowsMouse(self) -> None: ... + def tk_focusNext(self) -> Misc | None: ... + def tk_focusPrev(self) -> Misc | None: ... + # .after() can be called without the "func" argument, but it is basically never what you want. + # It behaves like time.sleep() and freezes the GUI app. + def after(self, ms: int | Literal["idle"], func: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> str: ... + # after_idle is essentially partialmethod(after, "idle") + def after_idle(self, func: Callable[[Unpack[_Ts]], object], *args: Unpack[_Ts]) -> str: ... + def after_cancel(self, id: str) -> None: ... + if sys.version_info >= (3, 13): + def after_info(self, id: str | None = None) -> tuple[str, ...]: ... + + def bell(self, displayof: Literal[0] | Misc | None = 0) -> None: ... + if sys.version_info >= (3, 13): + # Supports options from `_BusyInfo`` + def tk_busy_cget(self, option: Literal["cursor"]) -> _Cursor: ... + busy_cget = tk_busy_cget + def tk_busy_configure(self, cnf: Any = None, **kw: Any) -> Any: ... + tk_busy_config = tk_busy_configure + busy_configure = tk_busy_configure + busy_config = tk_busy_configure + def tk_busy_current(self, pattern: str | None = None) -> list[Misc]: ... + busy_current = tk_busy_current + def tk_busy_forget(self) -> None: ... + busy_forget = tk_busy_forget + def tk_busy_hold(self, **kw: Unpack[_BusyInfo]) -> None: ... + tk_busy = tk_busy_hold + busy_hold = tk_busy_hold + busy = tk_busy_hold + def tk_busy_status(self) -> bool: ... + busy_status = tk_busy_status + + def clipboard_get(self, *, displayof: Misc = ..., type: str = ...) -> str: ... + def clipboard_clear(self, *, displayof: Misc = ...) -> None: ... + def clipboard_append(self, string: str, *, displayof: Misc = ..., format: str = ..., type: str = ...) -> None: ... + def grab_current(self): ... + def grab_release(self) -> None: ... + def grab_set(self) -> None: ... + def grab_set_global(self) -> None: ... + def grab_status(self) -> Literal["local", "global"] | None: ... + def option_add( + self, pattern, value, priority: int | Literal["widgetDefault", "startupFile", "userDefault", "interactive"] | None = None + ) -> None: ... + def option_clear(self) -> None: ... + def option_get(self, name, className): ... + def option_readfile(self, fileName, priority: Incomplete | None = None) -> None: ... + def selection_clear(self, **kw) -> None: ... + def selection_get(self, **kw): ... + def selection_handle(self, command, **kw) -> None: ... + def selection_own(self, **kw) -> None: ... + def selection_own_get(self, **kw): ... + def send(self, interp, cmd, *args): ... + def lower(self, belowThis: Incomplete | None = None) -> None: ... + def tkraise(self, aboveThis: Incomplete | None = None) -> None: ... + lift = tkraise + if sys.version_info >= (3, 11): + def info_patchlevel(self) -> _VersionInfoType: ... + + def winfo_atom(self, name: str, displayof: Literal[0] | Misc | None = 0) -> int: ... + def winfo_atomname(self, id: int, displayof: Literal[0] | Misc | None = 0) -> str: ... + def winfo_cells(self) -> int: ... + def winfo_children(self) -> list[Widget]: ... # Widget because it can't be Toplevel or Tk + def winfo_class(self) -> str: ... + def winfo_colormapfull(self) -> bool: ... + def winfo_containing(self, rootX: int, rootY: int, displayof: Literal[0] | Misc | None = 0) -> Misc | None: ... + def winfo_depth(self) -> int: ... + def winfo_exists(self) -> bool: ... + def winfo_fpixels(self, number: _ScreenUnits) -> float: ... + def winfo_geometry(self) -> str: ... + def winfo_height(self) -> int: ... + def winfo_id(self) -> int: ... + def winfo_interps(self, displayof: Literal[0] | Misc | None = 0) -> tuple[str, ...]: ... + def winfo_ismapped(self) -> bool: ... + def winfo_manager(self) -> str: ... + def winfo_name(self) -> str: ... + def winfo_parent(self) -> str: ... # return value needs nametowidget() + def winfo_pathname(self, id: int, displayof: Literal[0] | Misc | None = 0): ... + def winfo_pixels(self, number: _ScreenUnits) -> int: ... + def winfo_pointerx(self) -> int: ... + def winfo_pointerxy(self) -> tuple[int, int]: ... + def winfo_pointery(self) -> int: ... + def winfo_reqheight(self) -> int: ... + def winfo_reqwidth(self) -> int: ... + def winfo_rgb(self, color: str) -> tuple[int, int, int]: ... + def winfo_rootx(self) -> int: ... + def winfo_rooty(self) -> int: ... + def winfo_screen(self) -> str: ... + def winfo_screencells(self) -> int: ... + def winfo_screendepth(self) -> int: ... + def winfo_screenheight(self) -> int: ... + def winfo_screenmmheight(self) -> int: ... + def winfo_screenmmwidth(self) -> int: ... + def winfo_screenvisual(self) -> str: ... + def winfo_screenwidth(self) -> int: ... + def winfo_server(self) -> str: ... + def winfo_toplevel(self) -> Tk | Toplevel: ... + def winfo_viewable(self) -> bool: ... + def winfo_visual(self) -> str: ... + def winfo_visualid(self) -> str: ... + def winfo_visualsavailable(self, includeids: bool = False) -> list[tuple[str, int]]: ... + def winfo_vrootheight(self) -> int: ... + def winfo_vrootwidth(self) -> int: ... + def winfo_vrootx(self) -> int: ... + def winfo_vrooty(self) -> int: ... + def winfo_width(self) -> int: ... + def winfo_x(self) -> int: ... + def winfo_y(self) -> int: ... + def update(self) -> None: ... + def update_idletasks(self) -> None: ... + @overload + def bindtags(self, tagList: None = None) -> tuple[str, ...]: ... + @overload + def bindtags(self, tagList: list[str] | tuple[str, ...]) -> None: ... + # bind with isinstance(func, str) doesn't return anything, but all other + # binds do. The default value of func is not str. + @overload + def bind( + self, + sequence: str | None = None, + func: Callable[[Event[Misc]], object] | None = None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def bind(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + @overload + def bind(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + # There's no way to know what type of widget bind_all and bind_class + # callbacks will get, so those are Misc. + @overload + def bind_all( + self, + sequence: str | None = None, + func: Callable[[Event[Misc]], object] | None = None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def bind_all(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + @overload + def bind_all(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + @overload + def bind_class( + self, + className: str, + sequence: str | None = None, + func: Callable[[Event[Misc]], object] | None = None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def bind_class(self, className: str, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + @overload + def bind_class(self, className: str, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + def unbind(self, sequence: str, funcid: str | None = None) -> None: ... + def unbind_all(self, sequence: str) -> None: ... + def unbind_class(self, className: str, sequence: str) -> None: ... + def mainloop(self, n: int = 0) -> None: ... + def quit(self) -> None: ... + @property + def _windowingsystem(self) -> Literal["win32", "aqua", "x11"]: ... + def nametowidget(self, name: str | Misc | _tkinter.Tcl_Obj) -> Any: ... + def register( + self, func: Callable[..., object], subst: Callable[..., Sequence[Any]] | None = None, needcleanup: int = 1 + ) -> str: ... + def keys(self) -> list[str]: ... + @overload + def pack_propagate(self, flag: bool) -> bool | None: ... + @overload + def pack_propagate(self) -> None: ... + propagate = pack_propagate + def grid_anchor(self, anchor: _Anchor | None = None) -> None: ... + anchor = grid_anchor + @overload + def grid_bbox( + self, column: None = None, row: None = None, col2: None = None, row2: None = None + ) -> tuple[int, int, int, int] | None: ... + @overload + def grid_bbox(self, column: int, row: int, col2: None = None, row2: None = None) -> tuple[int, int, int, int] | None: ... + @overload + def grid_bbox(self, column: int, row: int, col2: int, row2: int) -> tuple[int, int, int, int] | None: ... + bbox = grid_bbox + def grid_columnconfigure( + self, + index: int | str | list[int] | tuple[int, ...], + cnf: _GridIndexInfo = {}, + *, + minsize: _ScreenUnits = ..., + pad: _ScreenUnits = ..., + uniform: str = ..., + weight: int = ..., + ) -> _GridIndexInfo | MaybeNone: ... # can be None but annoying to check + def grid_rowconfigure( + self, + index: int | str | list[int] | tuple[int, ...], + cnf: _GridIndexInfo = {}, + *, + minsize: _ScreenUnits = ..., + pad: _ScreenUnits = ..., + uniform: str = ..., + weight: int = ..., + ) -> _GridIndexInfo | MaybeNone: ... # can be None but annoying to check + columnconfigure = grid_columnconfigure + rowconfigure = grid_rowconfigure + def grid_location(self, x: _ScreenUnits, y: _ScreenUnits) -> tuple[int, int]: ... + @overload + def grid_propagate(self, flag: bool) -> None: ... + @overload + def grid_propagate(self) -> bool: ... + def grid_size(self) -> tuple[int, int]: ... + size = grid_size + # Widget because Toplevel or Tk is never a slave + def pack_slaves(self) -> list[Widget]: ... + def grid_slaves(self, row: int | None = None, column: int | None = None) -> list[Widget]: ... + def place_slaves(self) -> list[Widget]: ... + slaves = pack_slaves + def event_add(self, virtual: str, *sequences: str) -> None: ... + def event_delete(self, virtual: str, *sequences: str) -> None: ... + def event_generate( + self, + sequence: str, + *, + above: Misc | int = ..., + borderwidth: _ScreenUnits = ..., + button: int = ..., + count: int = ..., + data: Any = ..., # anything with usable str() value + delta: int = ..., + detail: str = ..., + focus: bool = ..., + height: _ScreenUnits = ..., + keycode: int = ..., + keysym: str = ..., + mode: str = ..., + override: bool = ..., + place: Literal["PlaceOnTop", "PlaceOnBottom"] = ..., + root: Misc | int = ..., + rootx: _ScreenUnits = ..., + rooty: _ScreenUnits = ..., + sendevent: bool = ..., + serial: int = ..., + state: int | str = ..., + subwindow: Misc | int = ..., + time: int = ..., + warp: bool = ..., + width: _ScreenUnits = ..., + when: Literal["now", "tail", "head", "mark"] = ..., + x: _ScreenUnits = ..., + y: _ScreenUnits = ..., + ) -> None: ... + def event_info(self, virtual: str | None = None) -> tuple[str, ...]: ... + def image_names(self) -> tuple[str, ...]: ... + def image_types(self) -> tuple[str, ...]: ... + # See #4363 and #4891 + def __setitem__(self, key: str, value: Any) -> None: ... + def __getitem__(self, key: str) -> Any: ... + def cget(self, key: str) -> Any: ... + def configure(self, cnf: Any = None) -> Any: ... + # TODO: config is an alias of configure, but adding that here creates + # conflict with the type of config in the subclasses. See #13149 + +class CallWrapper: + func: Incomplete + subst: Incomplete + widget: Incomplete + def __init__(self, func, subst, widget) -> None: ... + def __call__(self, *args): ... + +class XView: + @overload + def xview(self) -> tuple[float, float]: ... + @overload + def xview(self, *args): ... + def xview_moveto(self, fraction: float) -> None: ... + @overload + def xview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ... + @overload + def xview_scroll(self, number: _ScreenUnits, what: Literal["pixels"]) -> None: ... + +class YView: + @overload + def yview(self) -> tuple[float, float]: ... + @overload + def yview(self, *args): ... + def yview_moveto(self, fraction: float) -> None: ... + @overload + def yview_scroll(self, number: int, what: Literal["units", "pages"]) -> None: ... + @overload + def yview_scroll(self, number: _ScreenUnits, what: Literal["pixels"]) -> None: ... + +if sys.platform == "darwin": + @type_check_only + class _WmAttributes(TypedDict): + alpha: float + fullscreen: bool + modified: bool + notify: bool + titlepath: str + topmost: bool + transparent: bool + type: str # Present, but not actually used on darwin + +elif sys.platform == "win32": + @type_check_only + class _WmAttributes(TypedDict): + alpha: float + transparentcolor: str + disabled: bool + fullscreen: bool + toolwindow: bool + topmost: bool + +else: + # X11 + @type_check_only + class _WmAttributes(TypedDict): + alpha: float + topmost: bool + zoomed: bool + fullscreen: bool + type: str + +class Wm: + @overload + def wm_aspect(self, minNumer: int, minDenom: int, maxNumer: int, maxDenom: int) -> None: ... + @overload + def wm_aspect( + self, minNumer: None = None, minDenom: None = None, maxNumer: None = None, maxDenom: None = None + ) -> tuple[int, int, int, int] | None: ... + aspect = wm_aspect + if sys.version_info >= (3, 13): + @overload + def wm_attributes(self, *, return_python_dict: Literal[False] = False) -> tuple[Any, ...]: ... + @overload + def wm_attributes(self, *, return_python_dict: Literal[True]) -> _WmAttributes: ... + + else: + @overload + def wm_attributes(self) -> tuple[Any, ...]: ... + + @overload + def wm_attributes(self, option: Literal["-alpha"], /) -> float: ... + @overload + def wm_attributes(self, option: Literal["-fullscreen"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-topmost"], /) -> bool: ... + if sys.platform == "darwin": + @overload + def wm_attributes(self, option: Literal["-modified"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-notify"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-titlepath"], /) -> str: ... + @overload + def wm_attributes(self, option: Literal["-transparent"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-type"], /) -> str: ... + elif sys.platform == "win32": + @overload + def wm_attributes(self, option: Literal["-transparentcolor"], /) -> str: ... + @overload + def wm_attributes(self, option: Literal["-disabled"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-toolwindow"], /) -> bool: ... + else: + # X11 + @overload + def wm_attributes(self, option: Literal["-zoomed"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["-type"], /) -> str: ... + if sys.version_info >= (3, 13): + @overload + def wm_attributes(self, option: Literal["alpha"], /) -> float: ... + @overload + def wm_attributes(self, option: Literal["fullscreen"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["topmost"], /) -> bool: ... + if sys.platform == "darwin": + @overload + def wm_attributes(self, option: Literal["modified"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["notify"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["titlepath"], /) -> str: ... + @overload + def wm_attributes(self, option: Literal["transparent"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["type"], /) -> str: ... + elif sys.platform == "win32": + @overload + def wm_attributes(self, option: Literal["transparentcolor"], /) -> str: ... + @overload + def wm_attributes(self, option: Literal["disabled"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["toolwindow"], /) -> bool: ... + else: + # X11 + @overload + def wm_attributes(self, option: Literal["zoomed"], /) -> bool: ... + @overload + def wm_attributes(self, option: Literal["type"], /) -> str: ... + + @overload + def wm_attributes(self, option: str, /): ... + @overload + def wm_attributes(self, option: Literal["-alpha"], value: float, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-fullscreen"], value: bool, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-topmost"], value: bool, /) -> Literal[""]: ... + if sys.platform == "darwin": + @overload + def wm_attributes(self, option: Literal["-modified"], value: bool, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-notify"], value: bool, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-titlepath"], value: str, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-transparent"], value: bool, /) -> Literal[""]: ... + elif sys.platform == "win32": + @overload + def wm_attributes(self, option: Literal["-transparentcolor"], value: str, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-disabled"], value: bool, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-toolwindow"], value: bool, /) -> Literal[""]: ... + else: + # X11 + @overload + def wm_attributes(self, option: Literal["-zoomed"], value: bool, /) -> Literal[""]: ... + @overload + def wm_attributes(self, option: Literal["-type"], value: str, /) -> Literal[""]: ... + + @overload + def wm_attributes(self, option: str, value, /, *__other_option_value_pairs: Any) -> Literal[""]: ... + if sys.version_info >= (3, 13): + if sys.platform == "darwin": + @overload + def wm_attributes( + self, + *, + alpha: float = ..., + fullscreen: bool = ..., + modified: bool = ..., + notify: bool = ..., + titlepath: str = ..., + topmost: bool = ..., + transparent: bool = ..., + ) -> None: ... + elif sys.platform == "win32": + @overload + def wm_attributes( + self, + *, + alpha: float = ..., + transparentcolor: str = ..., + disabled: bool = ..., + fullscreen: bool = ..., + toolwindow: bool = ..., + topmost: bool = ..., + ) -> None: ... + else: + # X11 + @overload + def wm_attributes( + self, *, alpha: float = ..., topmost: bool = ..., zoomed: bool = ..., fullscreen: bool = ..., type: str = ... + ) -> None: ... + + attributes = wm_attributes + def wm_client(self, name: str | None = None) -> str: ... + client = wm_client + @overload + def wm_colormapwindows(self) -> list[Misc]: ... + @overload + def wm_colormapwindows(self, wlist: list[Misc] | tuple[Misc, ...], /) -> None: ... + @overload + def wm_colormapwindows(self, first_wlist_item: Misc, /, *other_wlist_items: Misc) -> None: ... + colormapwindows = wm_colormapwindows + def wm_command(self, value: str | None = None) -> str: ... + command = wm_command + # Some of these always return empty string, but return type is set to None to prevent accidentally using it + def wm_deiconify(self) -> None: ... + deiconify = wm_deiconify + def wm_focusmodel(self, model: Literal["active", "passive"] | None = None) -> Literal["active", "passive", ""]: ... + focusmodel = wm_focusmodel + def wm_forget(self, window: Wm) -> None: ... + forget = wm_forget + def wm_frame(self) -> str: ... + frame = wm_frame + @overload + def wm_geometry(self, newGeometry: None = None) -> str: ... + @overload + def wm_geometry(self, newGeometry: str) -> None: ... + geometry = wm_geometry + def wm_grid( + self, + baseWidth: Incomplete | None = None, + baseHeight: Incomplete | None = None, + widthInc: Incomplete | None = None, + heightInc: Incomplete | None = None, + ): ... + grid = wm_grid + def wm_group(self, pathName: Incomplete | None = None): ... + group = wm_group + def wm_iconbitmap(self, bitmap: Incomplete | None = None, default: Incomplete | None = None): ... + iconbitmap = wm_iconbitmap + def wm_iconify(self) -> None: ... + iconify = wm_iconify + def wm_iconmask(self, bitmap: Incomplete | None = None): ... + iconmask = wm_iconmask + def wm_iconname(self, newName: Incomplete | None = None) -> str: ... + iconname = wm_iconname + def wm_iconphoto(self, default: bool, image1: _PhotoImageLike | str, /, *args: _PhotoImageLike | str) -> None: ... + iconphoto = wm_iconphoto + def wm_iconposition(self, x: int | None = None, y: int | None = None) -> tuple[int, int] | None: ... + iconposition = wm_iconposition + def wm_iconwindow(self, pathName: Incomplete | None = None): ... + iconwindow = wm_iconwindow + def wm_manage(self, widget) -> None: ... + manage = wm_manage + @overload + def wm_maxsize(self, width: None = None, height: None = None) -> tuple[int, int]: ... + @overload + def wm_maxsize(self, width: int, height: int) -> None: ... + maxsize = wm_maxsize + @overload + def wm_minsize(self, width: None = None, height: None = None) -> tuple[int, int]: ... + @overload + def wm_minsize(self, width: int, height: int) -> None: ... + minsize = wm_minsize + @overload + def wm_overrideredirect(self, boolean: None = None) -> bool | None: ... # returns True or None + @overload + def wm_overrideredirect(self, boolean: bool) -> None: ... + overrideredirect = wm_overrideredirect + def wm_positionfrom(self, who: Literal["program", "user"] | None = None) -> Literal["", "program", "user"]: ... + positionfrom = wm_positionfrom + @overload + def wm_protocol(self, name: str, func: Callable[[], object] | str) -> None: ... + @overload + def wm_protocol(self, name: str, func: None = None) -> str: ... + @overload + def wm_protocol(self, name: None = None, func: None = None) -> tuple[str, ...]: ... + protocol = wm_protocol + @overload + def wm_resizable(self, width: None = None, height: None = None) -> tuple[bool, bool]: ... + @overload + def wm_resizable(self, width: bool, height: bool) -> None: ... + resizable = wm_resizable + def wm_sizefrom(self, who: Literal["program", "user"] | None = None) -> Literal["", "program", "user"]: ... + sizefrom = wm_sizefrom + @overload + def wm_state(self, newstate: None = None) -> str: ... + @overload + def wm_state(self, newstate: str) -> None: ... + state = wm_state + @overload + def wm_title(self, string: None = None) -> str: ... + @overload + def wm_title(self, string: str) -> None: ... + title = wm_title + @overload + def wm_transient(self, master: None = None) -> _tkinter.Tcl_Obj: ... + @overload + def wm_transient(self, master: Wm | _tkinter.Tcl_Obj) -> None: ... + transient = wm_transient + def wm_withdraw(self) -> None: ... + withdraw = wm_withdraw + +class Tk(Misc, Wm): + master: None + def __init__( + # Make sure to keep in sync with other functions that use the same + # args. + # use `git grep screenName` to find them + self, + screenName: str | None = None, + baseName: str | None = None, + className: str = "Tk", + useTk: bool = True, + sync: bool = False, + use: str | None = None, + ) -> None: ... + # Keep this in sync with ttktheme.ThemedTk. See issue #13858 + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + menu: Menu = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + takefocus: _TakeFocusValue = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def destroy(self) -> None: ... + def readprofile(self, baseName: str, className: str) -> None: ... + report_callback_exception: Callable[[type[BaseException], BaseException, TracebackType | None], object] + # Tk has __getattr__ so that tk_instance.foo falls back to tk_instance.tk.foo + # Please keep in sync with _tkinter.TkappType. + # Some methods are intentionally missing because they are inherited from Misc instead. + def adderrorinfo(self, msg, /): ... + def call(self, command: Any, /, *args: Any) -> Any: ... + def createcommand(self, name, func, /): ... + if sys.platform != "win32": + def createfilehandler(self, file, mask, func, /): ... + def deletefilehandler(self, file, /): ... + + def createtimerhandler(self, milliseconds, func, /): ... + def dooneevent(self, flags: int = ..., /): ... + def eval(self, script: str, /) -> str: ... + def evalfile(self, fileName, /): ... + def exprboolean(self, s, /): ... + def exprdouble(self, s, /): ... + def exprlong(self, s, /): ... + def exprstring(self, s, /): ... + def globalgetvar(self, *args, **kwargs): ... + def globalsetvar(self, *args, **kwargs): ... + def globalunsetvar(self, *args, **kwargs): ... + def interpaddr(self): ... + def loadtk(self) -> None: ... + def record(self, script, /): ... + if sys.version_info < (3, 11): + def split(self, arg, /): ... + + def splitlist(self, arg, /): ... + def unsetvar(self, *args, **kwargs): ... + def wantobjects(self, *args, **kwargs): ... + def willdispatch(self): ... + +def Tcl(screenName: str | None = None, baseName: str | None = None, className: str = "Tk", useTk: bool = False) -> Tk: ... + +_InMiscTotal = TypedDict("_InMiscTotal", {"in": Misc}) +_InMiscNonTotal = TypedDict("_InMiscNonTotal", {"in": Misc}, total=False) + +class _PackInfo(_InMiscTotal): + # 'before' and 'after' never appear in _PackInfo + anchor: _Anchor + expand: bool + fill: Literal["none", "x", "y", "both"] + side: Literal["left", "right", "top", "bottom"] + # Paddings come out as int or tuple of int, even though any _ScreenUnits + # can be specified in pack(). + ipadx: int + ipady: int + padx: int | tuple[int, int] + pady: int | tuple[int, int] + +class Pack: + # _PackInfo is not the valid type for cnf because pad stuff accepts any + # _ScreenUnits instead of int only. I didn't bother to create another + # TypedDict for cnf because it appears to be a legacy thing that was + # replaced by **kwargs. + def pack_configure( + self, + cnf: Mapping[str, Any] | None = {}, + *, + after: Misc = ..., + anchor: _Anchor = ..., + before: Misc = ..., + expand: bool | Literal[0, 1] = 0, + fill: Literal["none", "x", "y", "both"] = ..., + side: Literal["left", "right", "top", "bottom"] = ..., + ipadx: _ScreenUnits = ..., + ipady: _ScreenUnits = ..., + padx: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., + pady: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., + in_: Misc = ..., + **kw: Any, # allow keyword argument named 'in', see #4836 + ) -> None: ... + def pack_forget(self) -> None: ... + def pack_info(self) -> _PackInfo: ... # errors if widget hasn't been packed + pack = pack_configure + forget = pack_forget + propagate = Misc.pack_propagate + +class _PlaceInfo(_InMiscNonTotal): # empty dict if widget hasn't been placed + anchor: _Anchor + bordermode: Literal["inside", "outside", "ignore"] + width: str # can be int()ed (even after e.g. widget.place(height='2.3c') or similar) + height: str # can be int()ed + x: str # can be int()ed + y: str # can be int()ed + relheight: str # can be float()ed if not empty string + relwidth: str # can be float()ed if not empty string + relx: str # can be float()ed if not empty string + rely: str # can be float()ed if not empty string + +class Place: + def place_configure( + self, + cnf: Mapping[str, Any] | None = {}, + *, + anchor: _Anchor = ..., + bordermode: Literal["inside", "outside", "ignore"] = ..., + width: _ScreenUnits = ..., + height: _ScreenUnits = ..., + x: _ScreenUnits = ..., + y: _ScreenUnits = ..., + # str allowed for compatibility with place_info() + relheight: str | float = ..., + relwidth: str | float = ..., + relx: str | float = ..., + rely: str | float = ..., + in_: Misc = ..., + **kw: Any, # allow keyword argument named 'in', see #4836 + ) -> None: ... + def place_forget(self) -> None: ... + def place_info(self) -> _PlaceInfo: ... + place = place_configure + info = place_info + +class _GridInfo(_InMiscNonTotal): # empty dict if widget hasn't been gridded + column: int + columnspan: int + row: int + rowspan: int + ipadx: int + ipady: int + padx: int | tuple[int, int] + pady: int | tuple[int, int] + sticky: str # consists of letters 'n', 's', 'w', 'e', no repeats, may be empty + +class Grid: + def grid_configure( + self, + cnf: Mapping[str, Any] | None = {}, + *, + column: int = ..., + columnspan: int = ..., + row: int = ..., + rowspan: int = ..., + ipadx: _ScreenUnits = ..., + ipady: _ScreenUnits = ..., + padx: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., + pady: _ScreenUnits | tuple[_ScreenUnits, _ScreenUnits] = ..., + sticky: str = ..., # consists of letters 'n', 's', 'w', 'e', may contain repeats, may be empty + in_: Misc = ..., + **kw: Any, # allow keyword argument named 'in', see #4836 + ) -> None: ... + def grid_forget(self) -> None: ... + def grid_remove(self) -> None: ... + def grid_info(self) -> _GridInfo: ... + grid = grid_configure + location = Misc.grid_location + size = Misc.grid_size + +class BaseWidget(Misc): + master: Misc + widgetName: Incomplete + def __init__(self, master, widgetName, cnf={}, kw={}, extra=()) -> None: ... + def destroy(self) -> None: ... + +# This class represents any widget except Toplevel or Tk. +class Widget(BaseWidget, Pack, Place, Grid): + # Allow bind callbacks to take e.g. Event[Label] instead of Event[Misc]. + # Tk and Toplevel get notified for their child widgets' events, but other + # widgets don't. + @overload + def bind( + self: _W, + sequence: str | None = None, + func: Callable[[Event[_W]], object] | None = None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def bind(self, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + @overload + def bind(self, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + +class Toplevel(BaseWidget, Wm): + # Toplevel and Tk have the same options because they correspond to the same + # Tcl/Tk toplevel widget. For some reason, config and configure must be + # copy/pasted here instead of aliasing as 'config = Tk.config'. + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = 0, + bg: str = ..., + border: _ScreenUnits = 0, + borderwidth: _ScreenUnits = 0, + class_: str = "Toplevel", + colormap: Literal["new", ""] | Misc = "", + container: bool = False, + cursor: _Cursor = "", + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + menu: Menu = ..., + name: str = ..., + padx: _ScreenUnits = 0, + pady: _ScreenUnits = 0, + relief: _Relief = "flat", + screen: str = "", # can't be changed after creating widget + takefocus: _TakeFocusValue = 0, + use: int = ..., + visual: str | tuple[str, int] = "", + width: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + menu: Menu = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + takefocus: _TakeFocusValue = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class Button(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = "center", + background: str = ..., + bd: _ScreenUnits = ..., # same as borderwidth + bg: str = ..., # same as background + bitmap: str = "", + border: _ScreenUnits = ..., # same as borderwidth + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = "", + compound: _Compound = "none", + cursor: _Cursor = "", + default: Literal["normal", "active", "disabled"] = "disabled", + disabledforeground: str = ..., + fg: str = ..., # same as foreground + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + # width and height must be int for buttons containing just text, but + # ints are also valid _ScreenUnits + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 1, + image: _ImageSpec = "", + justify: Literal["left", "center", "right"] = "center", + name: str = ..., + overrelief: _Relief | Literal[""] = "", + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + repeatdelay: int = ..., + repeatinterval: int = ..., + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + text: float | str = "", + # We allow the textvariable to be any Variable, not necessarily + # StringVar. This is useful for e.g. a button that displays the value + # of an IntVar. + textvariable: Variable = ..., + underline: int = -1, + width: _ScreenUnits = 0, + wraplength: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = ..., + compound: _Compound = ..., + cursor: _Cursor = ..., + default: Literal["normal", "active", "disabled"] = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + image: _ImageSpec = ..., + justify: Literal["left", "center", "right"] = ..., + overrelief: _Relief | Literal[""] = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + repeatdelay: int = ..., + repeatinterval: int = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + underline: int = ..., + width: _ScreenUnits = ..., + wraplength: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def flash(self) -> None: ... + def invoke(self) -> Any: ... + +class Canvas(Widget, XView, YView): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = 0, + bg: str = ..., + border: _ScreenUnits = 0, + borderwidth: _ScreenUnits = 0, + closeenough: float = 1.0, + confine: bool = True, + cursor: _Cursor = "", + # canvas manual page has a section named COORDINATES, and the first + # part of it describes _ScreenUnits. + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = 0, + insertofftime: int = 300, + insertontime: int = 600, + insertwidth: _ScreenUnits = 2, + name: str = ..., + offset=..., # undocumented + relief: _Relief = "flat", + # Setting scrollregion to None doesn't reset it back to empty, + # but setting it to () does. + scrollregion: tuple[_ScreenUnits, _ScreenUnits, _ScreenUnits, _ScreenUnits] | tuple[()] = (), + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = 1, + selectforeground: str = ..., + # man page says that state can be 'hidden', but it can't + state: Literal["normal", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + width: _ScreenUnits = ..., + xscrollcommand: _XYScrollCommand = "", + xscrollincrement: _ScreenUnits = 0, + yscrollcommand: _XYScrollCommand = "", + yscrollincrement: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + closeenough: float = ..., + confine: bool = ..., + cursor: _Cursor = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = ..., + insertofftime: int = ..., + insertontime: int = ..., + insertwidth: _ScreenUnits = ..., + offset=..., # undocumented + relief: _Relief = ..., + scrollregion: tuple[_ScreenUnits, _ScreenUnits, _ScreenUnits, _ScreenUnits] | tuple[()] = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + state: Literal["normal", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + width: _ScreenUnits = ..., + xscrollcommand: _XYScrollCommand = ..., + xscrollincrement: _ScreenUnits = ..., + yscrollcommand: _XYScrollCommand = ..., + yscrollincrement: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def addtag(self, *args): ... # internal method + def addtag_above(self, newtag: str, tagOrId: str | int) -> None: ... + def addtag_all(self, newtag: str) -> None: ... + def addtag_below(self, newtag: str, tagOrId: str | int) -> None: ... + def addtag_closest( + self, newtag: str, x: _ScreenUnits, y: _ScreenUnits, halo: _ScreenUnits | None = None, start: str | int | None = None + ) -> None: ... + def addtag_enclosed(self, newtag: str, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> None: ... + def addtag_overlapping(self, newtag: str, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> None: ... + def addtag_withtag(self, newtag: str, tagOrId: str | int) -> None: ... + def find(self, *args): ... # internal method + def find_above(self, tagOrId: str | int) -> tuple[int, ...]: ... + def find_all(self) -> tuple[int, ...]: ... + def find_below(self, tagOrId: str | int) -> tuple[int, ...]: ... + def find_closest( + self, x: _ScreenUnits, y: _ScreenUnits, halo: _ScreenUnits | None = None, start: str | int | None = None + ) -> tuple[int, ...]: ... + def find_enclosed(self, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: _ScreenUnits) -> tuple[int, ...]: ... + def find_overlapping(self, x1: _ScreenUnits, y1: _ScreenUnits, x2: _ScreenUnits, y2: float) -> tuple[int, ...]: ... + def find_withtag(self, tagOrId: str | int) -> tuple[int, ...]: ... + # Incompatible with Misc.bbox(), tkinter violates LSP + def bbox(self, *args: str | int) -> tuple[int, int, int, int]: ... # type: ignore[override] + @overload + def tag_bind( + self, + tagOrId: str | int, + sequence: str | None = None, + func: Callable[[Event[Canvas]], object] | None = None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def tag_bind( + self, tagOrId: str | int, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None + ) -> None: ... + @overload + def tag_bind(self, tagOrId: str | int, *, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + def tag_unbind(self, tagOrId: str | int, sequence: str, funcid: str | None = None) -> None: ... + def canvasx(self, screenx, gridspacing: Incomplete | None = None): ... + def canvasy(self, screeny, gridspacing: Incomplete | None = None): ... + @overload + def coords(self, tagOrId: str | int, /) -> list[float]: ... + @overload + def coords(self, tagOrId: str | int, args: list[int] | list[float] | tuple[float, ...], /) -> None: ... + @overload + def coords(self, tagOrId: str | int, x1: float, y1: float, /, *args: float) -> None: ... + # create_foo() methods accept coords as a list or tuple, or as separate arguments. + # Lists and tuples can be flat as in [1, 2, 3, 4], or nested as in [(1, 2), (3, 4)]. + # Keyword arguments should be the same in all overloads of each method. + def create_arc(self, *args, **kw) -> int: ... + def create_bitmap(self, *args, **kw) -> int: ... + def create_image(self, *args, **kw) -> int: ... + @overload + def create_line( + self, + x0: float, + y0: float, + x1: float, + y1: float, + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + arrow: Literal["first", "last", "both"] = ..., + arrowshape: tuple[float, float, float] = ..., + capstyle: Literal["round", "projecting", "butt"] = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_line( + self, + xy_pair_0: tuple[float, float], + xy_pair_1: tuple[float, float], + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + arrow: Literal["first", "last", "both"] = ..., + arrowshape: tuple[float, float, float] = ..., + capstyle: Literal["round", "projecting", "butt"] = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_line( + self, + coords: ( + tuple[float, float, float, float] + | tuple[tuple[float, float], tuple[float, float]] + | list[int] + | list[float] + | list[tuple[int, int]] + | list[tuple[float, float]] + ), + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + arrow: Literal["first", "last", "both"] = ..., + arrowshape: tuple[float, float, float] = ..., + capstyle: Literal["round", "projecting", "butt"] = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_oval( + self, + x0: float, + y0: float, + x1: float, + y1: float, + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_oval( + self, + xy_pair_0: tuple[float, float], + xy_pair_1: tuple[float, float], + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_oval( + self, + coords: ( + tuple[float, float, float, float] + | tuple[tuple[float, float], tuple[float, float]] + | list[int] + | list[float] + | list[tuple[int, int]] + | list[tuple[float, float]] + ), + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_polygon( + self, + x0: float, + y0: float, + x1: float, + y1: float, + /, + *xy_pairs: float, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_polygon( + self, + xy_pair_0: tuple[float, float], + xy_pair_1: tuple[float, float], + /, + *xy_pairs: tuple[float, float], + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_polygon( + self, + coords: ( + tuple[float, ...] + | tuple[tuple[float, float], ...] + | list[int] + | list[float] + | list[tuple[int, int]] + | list[tuple[float, float]] + ), + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + joinstyle: Literal["round", "bevel", "miter"] = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + smooth: bool = ..., + splinesteps: float = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_rectangle( + self, + x0: float, + y0: float, + x1: float, + y1: float, + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_rectangle( + self, + xy_pair_0: tuple[float, float], + xy_pair_1: tuple[float, float], + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_rectangle( + self, + coords: ( + tuple[float, float, float, float] + | tuple[tuple[float, float], tuple[float, float]] + | list[int] + | list[float] + | list[tuple[int, int]] + | list[tuple[float, float]] + ), + /, + *, + activedash: str | int | list[int] | tuple[int, ...] = ..., + activefill: str = ..., + activeoutline: str = ..., + activeoutlinestipple: str = ..., + activestipple: str = ..., + activewidth: _ScreenUnits = ..., + dash: str | int | list[int] | tuple[int, ...] = ..., + dashoffset: _ScreenUnits = ..., + disableddash: str | int | list[int] | tuple[int, ...] = ..., + disabledfill: str = ..., + disabledoutline: str = ..., + disabledoutlinestipple: str = ..., + disabledstipple: str = ..., + disabledwidth: _ScreenUnits = ..., + fill: str = ..., + offset: _ScreenUnits = ..., + outline: str = ..., + outlineoffset: _ScreenUnits = ..., + outlinestipple: str = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_text( + self, + x: float, + y: float, + /, + *, + activefill: str = ..., + activestipple: str = ..., + anchor: _Anchor = ..., + angle: float | str = ..., + disabledfill: str = ..., + disabledstipple: str = ..., + fill: str = ..., + font: _FontDescription = ..., + justify: Literal["left", "center", "right"] = ..., + offset: _ScreenUnits = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + text: float | str = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_text( + self, + coords: tuple[float, float] | list[int] | list[float], + /, + *, + activefill: str = ..., + activestipple: str = ..., + anchor: _Anchor = ..., + angle: float | str = ..., + disabledfill: str = ..., + disabledstipple: str = ..., + fill: str = ..., + font: _FontDescription = ..., + justify: Literal["left", "center", "right"] = ..., + offset: _ScreenUnits = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + stipple: str = ..., + tags: str | list[str] | tuple[str, ...] = ..., + text: float | str = ..., + width: _ScreenUnits = ..., + ) -> int: ... + @overload + def create_window( + self, + x: float, + y: float, + /, + *, + anchor: _Anchor = ..., + height: _ScreenUnits = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + window: Widget = ..., + ) -> int: ... + @overload + def create_window( + self, + coords: tuple[float, float] | list[int] | list[float], + /, + *, + anchor: _Anchor = ..., + height: _ScreenUnits = ..., + state: Literal["normal", "hidden", "disabled"] = ..., + tags: str | list[str] | tuple[str, ...] = ..., + width: _ScreenUnits = ..., + window: Widget = ..., + ) -> int: ... + def dchars(self, *args) -> None: ... + def delete(self, *tagsOrCanvasIds: str | int) -> None: ... + @overload + def dtag(self, tag: str, tag_to_delete: str | None = ..., /) -> None: ... + @overload + def dtag(self, id: int, tag_to_delete: str, /) -> None: ... + def focus(self, *args): ... + def gettags(self, tagOrId: str | int, /) -> tuple[str, ...]: ... + def icursor(self, *args) -> None: ... + def index(self, *args): ... + def insert(self, *args) -> None: ... + def itemcget(self, tagOrId, option): ... + # itemconfigure kwargs depend on item type, which is not known when type checking + def itemconfigure( + self, tagOrId: str | int, cnf: dict[str, Any] | None = None, **kw: Any + ) -> dict[str, tuple[str, str, str, str, str]] | None: ... + itemconfig = itemconfigure + def move(self, *args) -> None: ... + def moveto(self, tagOrId: str | int, x: Literal[""] | float = "", y: Literal[""] | float = "") -> None: ... + def postscript(self, cnf={}, **kw): ... + # tkinter does: + # lower = tag_lower + # lift = tkraise = tag_raise + # + # But mypy doesn't like aliasing here (maybe because Misc defines the same names) + def tag_lower(self, first: str | int, second: str | int | None = ..., /) -> None: ... + def lower(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] + def tag_raise(self, first: str | int, second: str | int | None = ..., /) -> None: ... + def tkraise(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] + def lift(self, first: str | int, second: str | int | None = ..., /) -> None: ... # type: ignore[override] + def scale( + self, tagOrId: str | int, xOrigin: _ScreenUnits, yOrigin: _ScreenUnits, xScale: float, yScale: float, / + ) -> None: ... + def scan_mark(self, x, y) -> None: ... + def scan_dragto(self, x, y, gain: int = 10) -> None: ... + def select_adjust(self, tagOrId, index) -> None: ... + def select_clear(self) -> None: ... + def select_from(self, tagOrId, index) -> None: ... + def select_item(self): ... + def select_to(self, tagOrId, index) -> None: ... + def type(self, tagOrId: str | int) -> int | None: ... + +class Checkbutton(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = "center", + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = "", + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = "", + compound: _Compound = "none", + cursor: _Cursor = "", + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 1, + image: _ImageSpec = "", + indicatoron: bool = True, + justify: Literal["left", "center", "right"] = "center", + name: str = ..., + offrelief: _Relief = ..., + # The checkbutton puts a value to its variable when it's checked or + # unchecked. We don't restrict the type of that value here, so + # Any-typing is fine. + # + # I think Checkbutton shouldn't be generic, because then specifying + # "any checkbutton regardless of what variable it uses" would be + # difficult, and we might run into issues just like how list[float] + # and list[int] are incompatible. Also, we would need a way to + # specify "Checkbutton not associated with any variable", which is + # done by setting variable to empty string (the default). + offvalue: Any = 0, + onvalue: Any = 1, + overrelief: _Relief | Literal[""] = "", + padx: _ScreenUnits = 1, + pady: _ScreenUnits = 1, + relief: _Relief = "flat", + selectcolor: str = ..., + selectimage: _ImageSpec = "", + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + text: float | str = "", + textvariable: Variable = ..., + tristateimage: _ImageSpec = "", + tristatevalue: Any = "", + underline: int = -1, + variable: Variable | Literal[""] = ..., + width: _ScreenUnits = 0, + wraplength: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = ..., + compound: _Compound = ..., + cursor: _Cursor = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + justify: Literal["left", "center", "right"] = ..., + offrelief: _Relief = ..., + offvalue: Any = ..., + onvalue: Any = ..., + overrelief: _Relief | Literal[""] = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + tristateimage: _ImageSpec = ..., + tristatevalue: Any = ..., + underline: int = ..., + variable: Variable | Literal[""] = ..., + width: _ScreenUnits = ..., + wraplength: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def deselect(self) -> None: ... + def flash(self) -> None: ... + def invoke(self) -> Any: ... + def select(self) -> None: ... + def toggle(self) -> None: ... + +class Entry(Widget, XView): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = "xterm", + disabledbackground: str = ..., + disabledforeground: str = ..., + exportselection: bool = True, + fg: str = ..., + font: _FontDescription = "TkTextFont", + foreground: str = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = 0, + insertofftime: int = 300, + insertontime: int = 600, + insertwidth: _ScreenUnits = ..., + invalidcommand: _EntryValidateCommand = "", + invcmd: _EntryValidateCommand = "", # same as invalidcommand + justify: Literal["left", "center", "right"] = "left", + name: str = ..., + readonlybackground: str = ..., + relief: _Relief = "sunken", + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + show: str = "", + state: Literal["normal", "disabled", "readonly"] = "normal", + takefocus: _TakeFocusValue = "", + textvariable: Variable = ..., + validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = "none", + validatecommand: _EntryValidateCommand = "", + vcmd: _EntryValidateCommand = "", # same as validatecommand + width: int = 20, + xscrollcommand: _XYScrollCommand = "", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + disabledbackground: str = ..., + disabledforeground: str = ..., + exportselection: bool = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = ..., + insertofftime: int = ..., + insertontime: int = ..., + insertwidth: _ScreenUnits = ..., + invalidcommand: _EntryValidateCommand = ..., + invcmd: _EntryValidateCommand = ..., + justify: Literal["left", "center", "right"] = ..., + readonlybackground: str = ..., + relief: _Relief = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + show: str = ..., + state: Literal["normal", "disabled", "readonly"] = ..., + takefocus: _TakeFocusValue = ..., + textvariable: Variable = ..., + validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = ..., + validatecommand: _EntryValidateCommand = ..., + vcmd: _EntryValidateCommand = ..., + width: int = ..., + xscrollcommand: _XYScrollCommand = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def delete(self, first: str | int, last: str | int | None = None) -> None: ... + def get(self) -> str: ... + def icursor(self, index: str | int) -> None: ... + def index(self, index: str | int) -> int: ... + def insert(self, index: str | int, string: str) -> None: ... + def scan_mark(self, x) -> None: ... + def scan_dragto(self, x) -> None: ... + def selection_adjust(self, index: str | int) -> None: ... + def selection_clear(self) -> None: ... # type: ignore[override] + def selection_from(self, index: str | int) -> None: ... + def selection_present(self) -> bool: ... + def selection_range(self, start: str | int, end: str | int) -> None: ... + def selection_to(self, index: str | int) -> None: ... + select_adjust = selection_adjust + select_clear = selection_clear + select_from = selection_from + select_present = selection_present + select_range = selection_range + select_to = selection_to + +class Frame(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = 0, + bg: str = ..., + border: _ScreenUnits = 0, + borderwidth: _ScreenUnits = 0, + class_: str = "Frame", # can't be changed with configure() + colormap: Literal["new", ""] | Misc = "", # can't be changed with configure() + container: bool = False, # can't be changed with configure() + cursor: _Cursor = "", + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + name: str = ..., + padx: _ScreenUnits = 0, + pady: _ScreenUnits = 0, + relief: _Relief = "flat", + takefocus: _TakeFocusValue = 0, + visual: str | tuple[str, int] = "", # can't be changed with configure() + width: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + takefocus: _TakeFocusValue = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class Label(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = "center", + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = "", + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + compound: _Compound = "none", + cursor: _Cursor = "", + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + image: _ImageSpec = "", + justify: Literal["left", "center", "right"] = "center", + name: str = ..., + padx: _ScreenUnits = 1, + pady: _ScreenUnits = 1, + relief: _Relief = "flat", + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = 0, + text: float | str = "", + textvariable: Variable = ..., + underline: int = -1, + width: _ScreenUnits = 0, + wraplength: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + compound: _Compound = ..., + cursor: _Cursor = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + image: _ImageSpec = ..., + justify: Literal["left", "center", "right"] = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + underline: int = ..., + width: _ScreenUnits = ..., + wraplength: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class Listbox(Widget, XView, YView): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activestyle: Literal["dotbox", "none", "underline"] = ..., + background: str = ..., + bd: _ScreenUnits = 1, + bg: str = ..., + border: _ScreenUnits = 1, + borderwidth: _ScreenUnits = 1, + cursor: _Cursor = "", + disabledforeground: str = ..., + exportselection: bool | Literal[0, 1] = 1, + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: int = 10, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + justify: Literal["left", "center", "right"] = "left", + # There's no tkinter.ListVar, but seems like bare tkinter.Variable + # actually works for this: + # + # >>> import tkinter + # >>> lb = tkinter.Listbox() + # >>> var = lb['listvariable'] = tkinter.Variable() + # >>> var.set(['foo', 'bar', 'baz']) + # >>> lb.get(0, 'end') + # ('foo', 'bar', 'baz') + listvariable: Variable = ..., + name: str = ..., + relief: _Relief = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = 0, + selectforeground: str = ..., + # from listbox man page: "The value of the [selectmode] option may be + # arbitrary, but the default bindings expect it to be either single, + # browse, multiple, or extended" + # + # I have never seen anyone setting this to something else than what + # "the default bindings expect", but let's support it anyway. + selectmode: str | Literal["single", "browse", "multiple", "extended"] = "browse", # noqa: Y051 + setgrid: bool = False, + state: Literal["normal", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + width: int = 20, + xscrollcommand: _XYScrollCommand = "", + yscrollcommand: _XYScrollCommand = "", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activestyle: Literal["dotbox", "none", "underline"] = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + disabledforeground: str = ..., + exportselection: bool = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: int = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + justify: Literal["left", "center", "right"] = ..., + listvariable: Variable = ..., + relief: _Relief = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + selectmode: str | Literal["single", "browse", "multiple", "extended"] = ..., # noqa: Y051 + setgrid: bool = ..., + state: Literal["normal", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + width: int = ..., + xscrollcommand: _XYScrollCommand = ..., + yscrollcommand: _XYScrollCommand = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def activate(self, index: str | int) -> None: ... + def bbox(self, index: str | int) -> tuple[int, int, int, int] | None: ... # type: ignore[override] + def curselection(self): ... + def delete(self, first: str | int, last: str | int | None = None) -> None: ... + def get(self, first: str | int, last: str | int | None = None): ... + def index(self, index: str | int) -> int: ... + def insert(self, index: str | int, *elements: str | float) -> None: ... + def nearest(self, y): ... + def scan_mark(self, x, y) -> None: ... + def scan_dragto(self, x, y) -> None: ... + def see(self, index: str | int) -> None: ... + def selection_anchor(self, index: str | int) -> None: ... + select_anchor = selection_anchor + def selection_clear(self, first: str | int, last: str | int | None = None) -> None: ... # type: ignore[override] + select_clear = selection_clear + def selection_includes(self, index: str | int): ... + select_includes = selection_includes + def selection_set(self, first: str | int, last: str | int | None = None) -> None: ... + select_set = selection_set + def size(self) -> int: ... # type: ignore[override] + def itemcget(self, index: str | int, option): ... + def itemconfigure(self, index: str | int, cnf: Incomplete | None = None, **kw): ... + itemconfig = itemconfigure + +class Menu(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeborderwidth: _ScreenUnits = ..., + activeforeground: str = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = "arrow", + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + name: str = ..., + postcommand: Callable[[], object] | str = "", + relief: _Relief = ..., + selectcolor: str = ..., + takefocus: _TakeFocusValue = 0, + tearoff: bool | Literal[0, 1] = 1, + # I guess tearoffcommand arguments are supposed to be widget objects, + # but they are widget name strings. Use nametowidget() to handle the + # arguments of tearoffcommand. + tearoffcommand: Callable[[str, str], object] | str = "", + title: str = "", + type: Literal["menubar", "tearoff", "normal"] = "normal", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeborderwidth: _ScreenUnits = ..., + activeforeground: str = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + postcommand: Callable[[], object] | str = ..., + relief: _Relief = ..., + selectcolor: str = ..., + takefocus: _TakeFocusValue = ..., + tearoff: bool = ..., + tearoffcommand: Callable[[str, str], object] | str = ..., + title: str = ..., + type: Literal["menubar", "tearoff", "normal"] = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def tk_popup(self, x: int, y: int, entry: str | int = "") -> None: ... + def activate(self, index: str | int) -> None: ... + def add(self, itemType, cnf={}, **kw): ... # docstring says "Internal function." + def insert(self, index, itemType, cnf={}, **kw): ... # docstring says "Internal function." + def add_cascade( + self, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + label: str = ..., + menu: Menu = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + ) -> None: ... + def add_checkbutton( + self, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + label: str = ..., + offvalue: Any = ..., + onvalue: Any = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + variable: Variable = ..., + ) -> None: ... + def add_command( + self, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + label: str = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + ) -> None: ... + def add_radiobutton( + self, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + label: str = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + value: Any = ..., + variable: Variable = ..., + ) -> None: ... + def add_separator(self, cnf: dict[str, Any] | None = {}, *, background: str = ...) -> None: ... + def insert_cascade( + self, + index: str | int, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + label: str = ..., + menu: Menu = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + ) -> None: ... + def insert_checkbutton( + self, + index: str | int, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + label: str = ..., + offvalue: Any = ..., + onvalue: Any = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + variable: Variable = ..., + ) -> None: ... + def insert_command( + self, + index: str | int, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + label: str = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + ) -> None: ... + def insert_radiobutton( + self, + index: str | int, + cnf: dict[str, Any] | None = {}, + *, + accelerator: str = ..., + activebackground: str = ..., + activeforeground: str = ..., + background: str = ..., + bitmap: str = ..., + columnbreak: int = ..., + command: Callable[[], object] | str = ..., + compound: _Compound = ..., + font: _FontDescription = ..., + foreground: str = ..., + hidemargin: bool = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + label: str = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + underline: int = ..., + value: Any = ..., + variable: Variable = ..., + ) -> None: ... + def insert_separator(self, index: str | int, cnf: dict[str, Any] | None = {}, *, background: str = ...) -> None: ... + def delete(self, index1: str | int, index2: str | int | None = None) -> None: ... + def entrycget(self, index: str | int, option: str) -> Any: ... + def entryconfigure( + self, index: str | int, cnf: dict[str, Any] | None = None, **kw: Any + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + entryconfig = entryconfigure + def index(self, index: str | int) -> int | None: ... + def invoke(self, index: str | int) -> Any: ... + def post(self, x: int, y: int) -> None: ... + def type(self, index: str | int) -> Literal["cascade", "checkbutton", "command", "radiobutton", "separator"]: ... + def unpost(self) -> None: ... + def xposition(self, index: str | int) -> int: ... + def yposition(self, index: str | int) -> int: ... + +class Menubutton(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = "", + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + compound: _Compound = "none", + cursor: _Cursor = "", + direction: Literal["above", "below", "left", "right", "flush"] = "below", + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + image: _ImageSpec = "", + indicatoron: bool = ..., + justify: Literal["left", "center", "right"] = ..., + menu: Menu = ..., + name: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = "flat", + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = 0, + text: float | str = "", + textvariable: Variable = ..., + underline: int = -1, + width: _ScreenUnits = 0, + wraplength: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + compound: _Compound = ..., + cursor: _Cursor = ..., + direction: Literal["above", "below", "left", "right", "flush"] = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + justify: Literal["left", "center", "right"] = ..., + menu: Menu = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + underline: int = ..., + width: _ScreenUnits = ..., + wraplength: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class Message(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + anchor: _Anchor = "center", + aspect: int = 150, + background: str = ..., + bd: _ScreenUnits = 1, + bg: str = ..., + border: _ScreenUnits = 1, + borderwidth: _ScreenUnits = 1, + cursor: _Cursor = "", + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + justify: Literal["left", "center", "right"] = "left", + name: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = "flat", + takefocus: _TakeFocusValue = 0, + text: float | str = "", + textvariable: Variable = ..., + # there's width but no height + width: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + anchor: _Anchor = ..., + aspect: int = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + justify: Literal["left", "center", "right"] = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class Radiobutton(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = "center", + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = "", + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = "", + compound: _Compound = "none", + cursor: _Cursor = "", + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 1, + image: _ImageSpec = "", + indicatoron: bool = True, + justify: Literal["left", "center", "right"] = "center", + name: str = ..., + offrelief: _Relief = ..., + overrelief: _Relief | Literal[""] = "", + padx: _ScreenUnits = 1, + pady: _ScreenUnits = 1, + relief: _Relief = "flat", + selectcolor: str = ..., + selectimage: _ImageSpec = "", + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + text: float | str = "", + textvariable: Variable = ..., + tristateimage: _ImageSpec = "", + tristatevalue: Any = "", + underline: int = -1, + value: Any = "", + variable: Variable | Literal[""] = ..., + width: _ScreenUnits = 0, + wraplength: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activeforeground: str = ..., + anchor: _Anchor = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bitmap: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: _ButtonCommand = ..., + compound: _Compound = ..., + cursor: _Cursor = ..., + disabledforeground: str = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + image: _ImageSpec = ..., + indicatoron: bool = ..., + justify: Literal["left", "center", "right"] = ..., + offrelief: _Relief = ..., + overrelief: _Relief | Literal[""] = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + selectcolor: str = ..., + selectimage: _ImageSpec = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + textvariable: Variable = ..., + tristateimage: _ImageSpec = ..., + tristatevalue: Any = ..., + underline: int = ..., + value: Any = ..., + variable: Variable | Literal[""] = ..., + width: _ScreenUnits = ..., + wraplength: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def deselect(self) -> None: ... + def flash(self) -> None: ... + def invoke(self) -> Any: ... + def select(self) -> None: ... + +class Scale(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + background: str = ..., + bd: _ScreenUnits = 1, + bg: str = ..., + bigincrement: float = 0.0, + border: _ScreenUnits = 1, + borderwidth: _ScreenUnits = 1, + # don't know why the callback gets string instead of float + command: str | Callable[[str], object] = "", + cursor: _Cursor = "", + digits: int = 0, + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + from_: float = 0.0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + label: str = "", + length: _ScreenUnits = 100, + name: str = ..., + orient: Literal["horizontal", "vertical"] = "vertical", + relief: _Relief = "flat", + repeatdelay: int = 300, + repeatinterval: int = 100, + resolution: float = 1.0, + showvalue: bool = True, + sliderlength: _ScreenUnits = 30, + sliderrelief: _Relief = "raised", + state: Literal["normal", "active", "disabled"] = "normal", + takefocus: _TakeFocusValue = "", + tickinterval: float = 0.0, + to: float = 100.0, + troughcolor: str = ..., + variable: IntVar | DoubleVar = ..., + width: _ScreenUnits = 15, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + bigincrement: float = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: str | Callable[[str], object] = ..., + cursor: _Cursor = ..., + digits: int = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + from_: float = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + label: str = ..., + length: _ScreenUnits = ..., + orient: Literal["horizontal", "vertical"] = ..., + relief: _Relief = ..., + repeatdelay: int = ..., + repeatinterval: int = ..., + resolution: float = ..., + showvalue: bool = ..., + sliderlength: _ScreenUnits = ..., + sliderrelief: _Relief = ..., + state: Literal["normal", "active", "disabled"] = ..., + takefocus: _TakeFocusValue = ..., + tickinterval: float = ..., + to: float = ..., + troughcolor: str = ..., + variable: IntVar | DoubleVar = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def get(self) -> float: ... + def set(self, value) -> None: ... + def coords(self, value: float | None = None) -> tuple[int, int]: ... + def identify(self, x, y) -> Literal["", "slider", "trough1", "trough2"]: ... + +class Scrollbar(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + activerelief: _Relief = "raised", + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + # There are many ways how the command may get called. Search for + # 'SCROLLING COMMANDS' in scrollbar man page. There doesn't seem to + # be any way to specify an overloaded callback function, so we say + # that it can take any args while it can't in reality. + command: Callable[..., tuple[float, float] | None] | str = "", + cursor: _Cursor = "", + elementborderwidth: _ScreenUnits = -1, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + jump: bool = False, + name: str = ..., + orient: Literal["horizontal", "vertical"] = "vertical", + relief: _Relief = ..., + repeatdelay: int = 300, + repeatinterval: int = 100, + takefocus: _TakeFocusValue = "", + troughcolor: str = ..., + width: _ScreenUnits = ..., + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + activerelief: _Relief = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + command: Callable[..., tuple[float, float] | None] | str = ..., + cursor: _Cursor = ..., + elementborderwidth: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + jump: bool = ..., + orient: Literal["horizontal", "vertical"] = ..., + relief: _Relief = ..., + repeatdelay: int = ..., + repeatinterval: int = ..., + takefocus: _TakeFocusValue = ..., + troughcolor: str = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def activate(self, index: Incomplete | None = None): ... + def delta(self, deltax: int, deltay: int) -> float: ... + def fraction(self, x: int, y: int) -> float: ... + def identify(self, x: int, y: int) -> Literal["arrow1", "arrow2", "slider", "trough1", "trough2", ""]: ... + def get(self) -> tuple[float, float, float, float] | tuple[float, float]: ... + def set(self, first: float | str, last: float | str) -> None: ... + +_TextIndex: TypeAlias = _tkinter.Tcl_Obj | str | float | Misc +_WhatToCount: TypeAlias = Literal[ + "chars", "displaychars", "displayindices", "displaylines", "indices", "lines", "xpixels", "ypixels" +] + +class Text(Widget, XView, YView): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + autoseparators: bool = True, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + blockcursor: bool = False, + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = "xterm", + endline: int | Literal[""] = "", + exportselection: bool = True, + fg: str = ..., + font: _FontDescription = "TkFixedFont", + foreground: str = ..., + # width is always int, but height is allowed to be ScreenUnits. + # This doesn't make any sense to me, and this isn't documented. + # The docs seem to say that both should be integers. + height: _ScreenUnits = 24, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + inactiveselectbackground: str = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = 0, + insertofftime: int = 300, + insertontime: int = 600, + insertunfocussed: Literal["none", "hollow", "solid"] = "none", + insertwidth: _ScreenUnits = ..., + maxundo: int = 0, + name: str = ..., + padx: _ScreenUnits = 1, + pady: _ScreenUnits = 1, + relief: _Relief = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + setgrid: bool = False, + spacing1: _ScreenUnits = 0, + spacing2: _ScreenUnits = 0, + spacing3: _ScreenUnits = 0, + startline: int | Literal[""] = "", + state: Literal["normal", "disabled"] = "normal", + # Literal inside Tuple doesn't actually work + tabs: _ScreenUnits | str | tuple[_ScreenUnits | str, ...] = "", + tabstyle: Literal["tabular", "wordprocessor"] = "tabular", + takefocus: _TakeFocusValue = "", + undo: bool = False, + width: int = 80, + wrap: Literal["none", "char", "word"] = "char", + xscrollcommand: _XYScrollCommand = "", + yscrollcommand: _XYScrollCommand = "", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + autoseparators: bool = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + blockcursor: bool = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + endline: int | Literal[""] = ..., + exportselection: bool = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + inactiveselectbackground: str = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = ..., + insertofftime: int = ..., + insertontime: int = ..., + insertunfocussed: Literal["none", "hollow", "solid"] = ..., + insertwidth: _ScreenUnits = ..., + maxundo: int = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + setgrid: bool = ..., + spacing1: _ScreenUnits = ..., + spacing2: _ScreenUnits = ..., + spacing3: _ScreenUnits = ..., + startline: int | Literal[""] = ..., + state: Literal["normal", "disabled"] = ..., + tabs: _ScreenUnits | str | tuple[_ScreenUnits | str, ...] = ..., + tabstyle: Literal["tabular", "wordprocessor"] = ..., + takefocus: _TakeFocusValue = ..., + undo: bool = ..., + width: int = ..., + wrap: Literal["none", "char", "word"] = ..., + xscrollcommand: _XYScrollCommand = ..., + yscrollcommand: _XYScrollCommand = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def bbox(self, index: _TextIndex) -> tuple[int, int, int, int] | None: ... # type: ignore[override] + def compare(self, index1: _TextIndex, op: Literal["<", "<=", "==", ">=", ">", "!="], index2: _TextIndex) -> bool: ... + if sys.version_info >= (3, 13): + @overload + def count(self, index1: _TextIndex, index2: _TextIndex, *, return_ints: Literal[True]) -> int: ... + @overload + def count( + self, index1: _TextIndex, index2: _TextIndex, arg: _WhatToCount | Literal["update"], /, *, return_ints: Literal[True] + ) -> int: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: Literal["update"], + arg2: _WhatToCount, + /, + *, + return_ints: Literal[True], + ) -> int: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount, + arg2: Literal["update"], + /, + *, + return_ints: Literal[True], + ) -> int: ... + @overload + def count( + self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: _WhatToCount, /, *, return_ints: Literal[True] + ) -> tuple[int, int]: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount | Literal["update"], + arg2: _WhatToCount | Literal["update"], + arg3: _WhatToCount | Literal["update"], + /, + *args: _WhatToCount | Literal["update"], + return_ints: Literal[True], + ) -> tuple[int, ...]: ... + @overload + def count(self, index1: _TextIndex, index2: _TextIndex, *, return_ints: Literal[False] = False) -> tuple[int] | None: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg: _WhatToCount | Literal["update"], + /, + *, + return_ints: Literal[False] = False, + ) -> tuple[int] | None: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: Literal["update"], + arg2: _WhatToCount, + /, + *, + return_ints: Literal[False] = False, + ) -> int | None: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount, + arg2: Literal["update"], + /, + *, + return_ints: Literal[False] = False, + ) -> int | None: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount, + arg2: _WhatToCount, + /, + *, + return_ints: Literal[False] = False, + ) -> tuple[int, int]: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount | Literal["update"], + arg2: _WhatToCount | Literal["update"], + arg3: _WhatToCount | Literal["update"], + /, + *args: _WhatToCount | Literal["update"], + return_ints: Literal[False] = False, + ) -> tuple[int, ...]: ... + else: + @overload + def count(self, index1: _TextIndex, index2: _TextIndex) -> tuple[int] | None: ... + @overload + def count( + self, index1: _TextIndex, index2: _TextIndex, arg: _WhatToCount | Literal["update"], / + ) -> tuple[int] | None: ... + @overload + def count(self, index1: _TextIndex, index2: _TextIndex, arg1: Literal["update"], arg2: _WhatToCount, /) -> int | None: ... + @overload + def count(self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: Literal["update"], /) -> int | None: ... + @overload + def count(self, index1: _TextIndex, index2: _TextIndex, arg1: _WhatToCount, arg2: _WhatToCount, /) -> tuple[int, int]: ... + @overload + def count( + self, + index1: _TextIndex, + index2: _TextIndex, + arg1: _WhatToCount | Literal["update"], + arg2: _WhatToCount | Literal["update"], + arg3: _WhatToCount | Literal["update"], + /, + *args: _WhatToCount | Literal["update"], + ) -> tuple[int, ...]: ... + + @overload + def debug(self, boolean: None = None) -> bool: ... + @overload + def debug(self, boolean: bool) -> None: ... + def delete(self, index1: _TextIndex, index2: _TextIndex | None = None) -> None: ... + def dlineinfo(self, index: _TextIndex) -> tuple[int, int, int, int, int] | None: ... + @overload + def dump( + self, + index1: _TextIndex, + index2: _TextIndex | None = None, + command: None = None, + *, + all: bool = ..., + image: bool = ..., + mark: bool = ..., + tag: bool = ..., + text: bool = ..., + window: bool = ..., + ) -> list[tuple[str, str, str]]: ... + @overload + def dump( + self, + index1: _TextIndex, + index2: _TextIndex | None, + command: Callable[[str, str, str], object] | str, + *, + all: bool = ..., + image: bool = ..., + mark: bool = ..., + tag: bool = ..., + text: bool = ..., + window: bool = ..., + ) -> None: ... + @overload + def dump( + self, + index1: _TextIndex, + index2: _TextIndex | None = None, + *, + command: Callable[[str, str, str], object] | str, + all: bool = ..., + image: bool = ..., + mark: bool = ..., + tag: bool = ..., + text: bool = ..., + window: bool = ..., + ) -> None: ... + def edit(self, *args): ... # docstring says "Internal method" + @overload + def edit_modified(self, arg: None = None) -> bool: ... # actually returns Literal[0, 1] + @overload + def edit_modified(self, arg: bool) -> None: ... # actually returns empty string + def edit_redo(self) -> None: ... # actually returns empty string + def edit_reset(self) -> None: ... # actually returns empty string + def edit_separator(self) -> None: ... # actually returns empty string + def edit_undo(self) -> None: ... # actually returns empty string + def get(self, index1: _TextIndex, index2: _TextIndex | None = None) -> str: ... + @overload + def image_cget(self, index: _TextIndex, option: Literal["image", "name"]) -> str: ... + @overload + def image_cget(self, index: _TextIndex, option: Literal["padx", "pady"]) -> int: ... + @overload + def image_cget(self, index: _TextIndex, option: Literal["align"]) -> Literal["baseline", "bottom", "center", "top"]: ... + @overload + def image_cget(self, index: _TextIndex, option: str) -> Any: ... + @overload + def image_configure(self, index: _TextIndex, cnf: str) -> tuple[str, str, str, str, str | int]: ... + @overload + def image_configure( + self, + index: _TextIndex, + cnf: dict[str, Any] | None = {}, + *, + align: Literal["baseline", "bottom", "center", "top"] = ..., + image: _ImageSpec = ..., + name: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, str, str | int]] | None: ... + def image_create( + self, + index: _TextIndex, + cnf: dict[str, Any] | None = {}, + *, + align: Literal["baseline", "bottom", "center", "top"] = ..., + image: _ImageSpec = ..., + name: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + ) -> str: ... + def image_names(self) -> tuple[str, ...]: ... + def index(self, index: _TextIndex) -> str: ... + def insert(self, index: _TextIndex, chars: str, *args: str | list[str] | tuple[str, ...]) -> None: ... + @overload + def mark_gravity(self, markName: str, direction: None = None) -> Literal["left", "right"]: ... + @overload + def mark_gravity(self, markName: str, direction: Literal["left", "right"]) -> None: ... # actually returns empty string + def mark_names(self) -> tuple[str, ...]: ... + def mark_set(self, markName: str, index: _TextIndex) -> None: ... + def mark_unset(self, *markNames: str) -> None: ... + def mark_next(self, index: _TextIndex) -> str | None: ... + def mark_previous(self, index: _TextIndex) -> str | None: ... + # **kw of peer_create is same as the kwargs of Text.__init__ + def peer_create(self, newPathName: str | Text, cnf: dict[str, Any] = {}, **kw) -> None: ... + def peer_names(self) -> tuple[_tkinter.Tcl_Obj, ...]: ... + def replace(self, index1: _TextIndex, index2: _TextIndex, chars: str, *args: str | list[str] | tuple[str, ...]) -> None: ... + def scan_mark(self, x: int, y: int) -> None: ... + def scan_dragto(self, x: int, y: int) -> None: ... + def search( + self, + pattern: str, + index: _TextIndex, + stopindex: _TextIndex | None = None, + forwards: bool | None = None, + backwards: bool | None = None, + exact: bool | None = None, + regexp: bool | None = None, + nocase: bool | None = None, + count: Variable | None = None, + elide: bool | None = None, + ) -> str: ... # returns empty string for not found + def see(self, index: _TextIndex) -> None: ... + def tag_add(self, tagName: str, index1: _TextIndex, *args: _TextIndex) -> None: ... + # tag_bind stuff is very similar to Canvas + @overload + def tag_bind( + self, + tagName: str, + sequence: str | None, + func: Callable[[Event[Text]], object] | None, + add: Literal["", "+"] | bool | None = None, + ) -> str: ... + @overload + def tag_bind(self, tagName: str, sequence: str | None, func: str, add: Literal["", "+"] | bool | None = None) -> None: ... + def tag_unbind(self, tagName: str, sequence: str, funcid: str | None = None) -> None: ... + # allowing any string for cget instead of just Literals because there's no other way to look up tag options + def tag_cget(self, tagName: str, option: str): ... + @overload + def tag_configure( + self, + tagName: str, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bgstipple: str = ..., + borderwidth: _ScreenUnits = ..., + border: _ScreenUnits = ..., # alias for borderwidth + elide: bool = ..., + fgstipple: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + justify: Literal["left", "right", "center"] = ..., + lmargin1: _ScreenUnits = ..., + lmargin2: _ScreenUnits = ..., + lmargincolor: str = ..., + offset: _ScreenUnits = ..., + overstrike: bool = ..., + overstrikefg: str = ..., + relief: _Relief = ..., + rmargin: _ScreenUnits = ..., + rmargincolor: str = ..., + selectbackground: str = ..., + selectforeground: str = ..., + spacing1: _ScreenUnits = ..., + spacing2: _ScreenUnits = ..., + spacing3: _ScreenUnits = ..., + tabs: Any = ..., # the exact type is kind of complicated, see manual page + tabstyle: Literal["tabular", "wordprocessor"] = ..., + underline: bool = ..., + underlinefg: str = ..., + wrap: Literal["none", "char", "word"] = ..., # be careful with "none" vs None + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def tag_configure(self, tagName: str, cnf: str) -> tuple[str, str, str, Any, Any]: ... + tag_config = tag_configure + def tag_delete(self, first_tag_name: str, /, *tagNames: str) -> None: ... # error if no tag names given + def tag_lower(self, tagName: str, belowThis: str | None = None) -> None: ... + def tag_names(self, index: _TextIndex | None = None) -> tuple[str, ...]: ... + def tag_nextrange( + self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None + ) -> tuple[str, str] | tuple[()]: ... + def tag_prevrange( + self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None + ) -> tuple[str, str] | tuple[()]: ... + def tag_raise(self, tagName: str, aboveThis: str | None = None) -> None: ... + def tag_ranges(self, tagName: str) -> tuple[_tkinter.Tcl_Obj, ...]: ... + # tag_remove and tag_delete are different + def tag_remove(self, tagName: str, index1: _TextIndex, index2: _TextIndex | None = None) -> None: ... + @overload + def window_cget(self, index: _TextIndex, option: Literal["padx", "pady"]) -> int: ... + @overload + def window_cget(self, index: _TextIndex, option: Literal["stretch"]) -> bool: ... # actually returns Literal[0, 1] + @overload + def window_cget(self, index: _TextIndex, option: Literal["align"]) -> Literal["baseline", "bottom", "center", "top"]: ... + @overload # window is set to a widget, but read as the string name. + def window_cget(self, index: _TextIndex, option: Literal["create", "window"]) -> str: ... + @overload + def window_cget(self, index: _TextIndex, option: str) -> Any: ... + @overload + def window_configure(self, index: _TextIndex, cnf: str) -> tuple[str, str, str, str, str | int]: ... + @overload + def window_configure( + self, + index: _TextIndex, + cnf: dict[str, Any] | None = None, + *, + align: Literal["baseline", "bottom", "center", "top"] = ..., + create: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + stretch: bool | Literal[0, 1] = ..., + window: Misc | str = ..., + ) -> dict[str, tuple[str, str, str, str, str | int]] | None: ... + window_config = window_configure + def window_create( + self, + index: _TextIndex, + cnf: dict[str, Any] | None = {}, + *, + align: Literal["baseline", "bottom", "center", "top"] = ..., + create: str = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + stretch: bool | Literal[0, 1] = ..., + window: Misc | str = ..., + ) -> None: ... + def window_names(self) -> tuple[str, ...]: ... + def yview_pickplace(self, *what): ... # deprecated + +class _setit: + def __init__(self, var, value, callback: Incomplete | None = None) -> None: ... + def __call__(self, *args) -> None: ... + +# manual page: tk_optionMenu +class OptionMenu(Menubutton): + widgetName: Incomplete + menuname: Incomplete + def __init__( + # differs from other widgets + self, + master: Misc | None, + variable: StringVar, + value: str, + *values: str, + # kwarg only from now on + command: Callable[[StringVar], object] | None = ..., + ) -> None: ... + # configure, config, cget are inherited from Menubutton + # destroy and __getitem__ are overridden, signature does not change + +# This matches tkinter's image classes (PhotoImage and BitmapImage) +# and PIL's tkinter-compatible class (PIL.ImageTk.PhotoImage), +# but not a plain PIL image that isn't tkinter compatible. +# The reason is that PIL has width and height attributes, not methods. +@type_check_only +class _Image(Protocol): + def width(self) -> int: ... + def height(self) -> int: ... + +@type_check_only +class _BitmapImageLike(_Image): ... + +@type_check_only +class _PhotoImageLike(_Image): ... + +class Image(_Image): + name: Incomplete + tk: _tkinter.TkappType + def __init__( + self, imgtype, name: Incomplete | None = None, cnf={}, master: Misc | _tkinter.TkappType | None = None, **kw + ) -> None: ... + def __del__(self) -> None: ... + def __setitem__(self, key, value) -> None: ... + def __getitem__(self, key): ... + configure: Incomplete + config: Incomplete + def type(self): ... + +class PhotoImage(Image, _PhotoImageLike): + # This should be kept in sync with PIL.ImageTK.PhotoImage.__init__() + def __init__( + self, + name: str | None = None, + cnf: dict[str, Any] = {}, + master: Misc | _tkinter.TkappType | None = None, + *, + data: str | bytes = ..., # not same as data argument of put() + format: str = ..., + file: StrOrBytesPath = ..., + gamma: float = ..., + height: int = ..., + palette: int | str = ..., + width: int = ..., + ) -> None: ... + def configure( + self, + *, + data: str | bytes = ..., + format: str = ..., + file: StrOrBytesPath = ..., + gamma: float = ..., + height: int = ..., + palette: int | str = ..., + width: int = ..., + ) -> None: ... + config = configure + def blank(self) -> None: ... + def cget(self, option: str) -> str: ... + def __getitem__(self, key: str) -> str: ... # always string: image['height'] can be '0' + if sys.version_info >= (3, 13): + def copy( + self, + *, + from_coords: Iterable[int] | None = None, + zoom: int | tuple[int, int] | list[int] | None = None, + subsample: int | tuple[int, int] | list[int] | None = None, + ) -> PhotoImage: ... + def subsample(self, x: int, y: Literal[""] = "", *, from_coords: Iterable[int] | None = None) -> PhotoImage: ... + def zoom(self, x: int, y: Literal[""] = "", *, from_coords: Iterable[int] | None = None) -> PhotoImage: ... + def copy_replace( + self, + sourceImage: PhotoImage | str, + *, + from_coords: Iterable[int] | None = None, + to: Iterable[int] | None = None, + shrink: bool = False, + zoom: int | tuple[int, int] | list[int] | None = None, + subsample: int | tuple[int, int] | list[int] | None = None, + # `None` defaults to overlay. + compositingrule: Literal["overlay", "set"] | None = None, + ) -> None: ... + else: + def copy(self) -> PhotoImage: ... + def zoom(self, x: int, y: int | Literal[""] = "") -> PhotoImage: ... + def subsample(self, x: int, y: int | Literal[""] = "") -> PhotoImage: ... + + def get(self, x: int, y: int) -> tuple[int, int, int]: ... + def put( + self, + data: ( + str + | bytes + | list[str] + | list[list[str]] + | list[tuple[str, ...]] + | tuple[str, ...] + | tuple[list[str], ...] + | tuple[tuple[str, ...], ...] + ), + to: tuple[int, int] | tuple[int, int, int, int] | None = None, + ) -> None: ... + if sys.version_info >= (3, 13): + def read( + self, + filename: StrOrBytesPath, + format: str | None = None, + *, + from_coords: Iterable[int] | None = None, + to: Iterable[int] | None = None, + shrink: bool = False, + ) -> None: ... + def write( + self, + filename: StrOrBytesPath, + format: str | None = None, + from_coords: Iterable[int] | None = None, + *, + background: str | None = None, + grayscale: bool = False, + ) -> None: ... + @overload + def data( + self, format: str, *, from_coords: Iterable[int] | None = None, background: str | None = None, grayscale: bool = False + ) -> bytes: ... + @overload + def data( + self, + format: None = None, + *, + from_coords: Iterable[int] | None = None, + background: str | None = None, + grayscale: bool = False, + ) -> tuple[str, ...]: ... + + else: + def write( + self, filename: StrOrBytesPath, format: str | None = None, from_coords: tuple[int, int] | None = None + ) -> None: ... + + def transparency_get(self, x: int, y: int) -> bool: ... + def transparency_set(self, x: int, y: int, boolean: bool) -> None: ... + +class BitmapImage(Image, _BitmapImageLike): + # This should be kept in sync with PIL.ImageTK.BitmapImage.__init__() + def __init__( + self, + name: Incomplete | None = None, + cnf: dict[str, Any] = {}, + master: Misc | _tkinter.TkappType | None = None, + *, + background: str = ..., + data: str | bytes = ..., + file: StrOrBytesPath = ..., + foreground: str = ..., + maskdata: str = ..., + maskfile: StrOrBytesPath = ..., + ) -> None: ... + +def image_names() -> tuple[str, ...]: ... +def image_types() -> tuple[str, ...]: ... + +class Spinbox(Widget, XView): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + activebackground: str = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + buttonbackground: str = ..., + buttoncursor: _Cursor = "", + buttondownrelief: _Relief = ..., + buttonuprelief: _Relief = ..., + # percent substitutions don't seem to be supported, it's similar to Entry's validation stuff + command: Callable[[], object] | str | list[str] | tuple[str, ...] = "", + cursor: _Cursor = "xterm", + disabledbackground: str = ..., + disabledforeground: str = ..., + exportselection: bool = True, + fg: str = ..., + font: _FontDescription = "TkTextFont", + foreground: str = ..., + format: str = "", + from_: float = 0.0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + increment: float = 1.0, + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = 0, + insertofftime: int = 300, + insertontime: int = 600, + insertwidth: _ScreenUnits = ..., + invalidcommand: _EntryValidateCommand = "", + invcmd: _EntryValidateCommand = "", + justify: Literal["left", "center", "right"] = "left", + name: str = ..., + readonlybackground: str = ..., + relief: _Relief = "sunken", + repeatdelay: int = 400, + repeatinterval: int = 100, + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + state: Literal["normal", "disabled", "readonly"] = "normal", + takefocus: _TakeFocusValue = "", + textvariable: Variable = ..., + to: float = 0.0, + validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = "none", + validatecommand: _EntryValidateCommand = "", + vcmd: _EntryValidateCommand = "", + values: list[str] | tuple[str, ...] = ..., + width: int = 20, + wrap: bool = False, + xscrollcommand: _XYScrollCommand = "", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + activebackground: str = ..., + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + buttonbackground: str = ..., + buttoncursor: _Cursor = ..., + buttondownrelief: _Relief = ..., + buttonuprelief: _Relief = ..., + command: Callable[[], object] | str | list[str] | tuple[str, ...] = ..., + cursor: _Cursor = ..., + disabledbackground: str = ..., + disabledforeground: str = ..., + exportselection: bool = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + format: str = ..., + from_: float = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + increment: float = ..., + insertbackground: str = ..., + insertborderwidth: _ScreenUnits = ..., + insertofftime: int = ..., + insertontime: int = ..., + insertwidth: _ScreenUnits = ..., + invalidcommand: _EntryValidateCommand = ..., + invcmd: _EntryValidateCommand = ..., + justify: Literal["left", "center", "right"] = ..., + readonlybackground: str = ..., + relief: _Relief = ..., + repeatdelay: int = ..., + repeatinterval: int = ..., + selectbackground: str = ..., + selectborderwidth: _ScreenUnits = ..., + selectforeground: str = ..., + state: Literal["normal", "disabled", "readonly"] = ..., + takefocus: _TakeFocusValue = ..., + textvariable: Variable = ..., + to: float = ..., + validate: Literal["none", "focus", "focusin", "focusout", "key", "all"] = ..., + validatecommand: _EntryValidateCommand = ..., + vcmd: _EntryValidateCommand = ..., + values: list[str] | tuple[str, ...] = ..., + width: int = ..., + wrap: bool = ..., + xscrollcommand: _XYScrollCommand = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def bbox(self, index) -> tuple[int, int, int, int] | None: ... # type: ignore[override] + def delete(self, first, last: Incomplete | None = None) -> Literal[""]: ... + def get(self) -> str: ... + def icursor(self, index): ... + def identify(self, x: int, y: int) -> Literal["", "buttondown", "buttonup", "entry"]: ... + def index(self, index: str | int) -> int: ... + def insert(self, index: str | int, s: str) -> Literal[""]: ... + # spinbox.invoke("asdf") gives error mentioning .invoke("none"), but it's not documented + def invoke(self, element: Literal["none", "buttonup", "buttondown"]) -> Literal[""]: ... + def scan(self, *args): ... + def scan_mark(self, x): ... + def scan_dragto(self, x): ... + def selection(self, *args) -> tuple[int, ...]: ... + def selection_adjust(self, index): ... + def selection_clear(self): ... # type: ignore[override] + def selection_element(self, element: Incomplete | None = None): ... + def selection_from(self, index: int) -> None: ... + def selection_present(self) -> None: ... + def selection_range(self, start: int, end: int) -> None: ... + def selection_to(self, index: int) -> None: ... + +class LabelFrame(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = 2, + bg: str = ..., + border: _ScreenUnits = 2, + borderwidth: _ScreenUnits = 2, + class_: str = "Labelframe", # can't be changed with configure() + colormap: Literal["new", ""] | Misc = "", # can't be changed with configure() + container: bool = False, # undocumented, can't be changed with configure() + cursor: _Cursor = "", + fg: str = ..., + font: _FontDescription = "TkDefaultFont", + foreground: str = ..., + height: _ScreenUnits = 0, + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = 0, + # 'ne' and 'en' are valid labelanchors, but only 'ne' is a valid _Anchor. + labelanchor: Literal["nw", "n", "ne", "en", "e", "es", "se", "s", "sw", "ws", "w", "wn"] = "nw", + labelwidget: Misc = ..., + name: str = ..., + padx: _ScreenUnits = 0, + pady: _ScreenUnits = 0, + relief: _Relief = "groove", + takefocus: _TakeFocusValue = 0, + text: float | str = "", + visual: str | tuple[str, int] = "", # can't be changed with configure() + width: _ScreenUnits = 0, + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + fg: str = ..., + font: _FontDescription = ..., + foreground: str = ..., + height: _ScreenUnits = ..., + highlightbackground: str = ..., + highlightcolor: str = ..., + highlightthickness: _ScreenUnits = ..., + labelanchor: Literal["nw", "n", "ne", "en", "e", "es", "se", "s", "sw", "ws", "w", "wn"] = ..., + labelwidget: Misc = ..., + padx: _ScreenUnits = ..., + pady: _ScreenUnits = ..., + relief: _Relief = ..., + takefocus: _TakeFocusValue = ..., + text: float | str = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + +class PanedWindow(Widget): + def __init__( + self, + master: Misc | None = None, + cnf: dict[str, Any] | None = {}, + *, + background: str = ..., + bd: _ScreenUnits = 1, + bg: str = ..., + border: _ScreenUnits = 1, + borderwidth: _ScreenUnits = 1, + cursor: _Cursor = "", + handlepad: _ScreenUnits = 8, + handlesize: _ScreenUnits = 8, + height: _ScreenUnits = "", + name: str = ..., + opaqueresize: bool = True, + orient: Literal["horizontal", "vertical"] = "horizontal", + proxybackground: str = "", + proxyborderwidth: _ScreenUnits = 2, + proxyrelief: _Relief = "flat", + relief: _Relief = "flat", + sashcursor: _Cursor = "", + sashpad: _ScreenUnits = 0, + sashrelief: _Relief = "flat", + sashwidth: _ScreenUnits = 3, + showhandle: bool = False, + width: _ScreenUnits = "", + ) -> None: ... + @overload + def configure( + self, + cnf: dict[str, Any] | None = None, + *, + background: str = ..., + bd: _ScreenUnits = ..., + bg: str = ..., + border: _ScreenUnits = ..., + borderwidth: _ScreenUnits = ..., + cursor: _Cursor = ..., + handlepad: _ScreenUnits = ..., + handlesize: _ScreenUnits = ..., + height: _ScreenUnits = ..., + opaqueresize: bool = ..., + orient: Literal["horizontal", "vertical"] = ..., + proxybackground: str = ..., + proxyborderwidth: _ScreenUnits = ..., + proxyrelief: _Relief = ..., + relief: _Relief = ..., + sashcursor: _Cursor = ..., + sashpad: _ScreenUnits = ..., + sashrelief: _Relief = ..., + sashwidth: _ScreenUnits = ..., + showhandle: bool = ..., + width: _ScreenUnits = ..., + ) -> dict[str, tuple[str, str, str, Any, Any]] | None: ... + @overload + def configure(self, cnf: str) -> tuple[str, str, str, Any, Any]: ... + config = configure + def add(self, child: Widget, **kw) -> None: ... + def remove(self, child) -> None: ... + forget: Incomplete + def identify(self, x: int, y: int): ... + def proxy(self, *args): ... + def proxy_coord(self): ... + def proxy_forget(self): ... + def proxy_place(self, x, y): ... + def sash(self, *args): ... + def sash_coord(self, index): ... + def sash_mark(self, index): ... + def sash_place(self, index, x, y): ... + def panecget(self, child, option): ... + def paneconfigure(self, tagOrId, cnf: Incomplete | None = None, **kw): ... + paneconfig: Incomplete + def panes(self): ... + +def _test() -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi new file mode 100644 index 0000000000000..d0d6de8426562 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/colorchooser.pyi @@ -0,0 +1,12 @@ +from tkinter import Misc +from tkinter.commondialog import Dialog +from typing import ClassVar + +__all__ = ["Chooser", "askcolor"] + +class Chooser(Dialog): + command: ClassVar[str] + +def askcolor( + color: str | bytes | None = None, *, initialcolor: str = ..., parent: Misc = ..., title: str = ... +) -> tuple[None, None] | tuple[tuple[int, int, int], str]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi similarity index 83% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi index d06c08df5b768..201ca13ddd9c5 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/commondialog.pyi @@ -1,10 +1,8 @@ -import sys from _typeshed import Incomplete from collections.abc import Mapping from typing import ClassVar -if sys.version_info >= (3, 9): - __all__ = ["Dialog"] +__all__ = ["Dialog"] class Dialog: command: ClassVar[str | None] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/constants.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/constants.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/constants.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/constants.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi index b7d74c0fa71e5..3dc059940964c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dialog.pyi @@ -1,11 +1,9 @@ -import sys from _typeshed import Incomplete from collections.abc import Mapping from tkinter import Widget from typing import Any, Final -if sys.version_info >= (3, 9): - __all__ = ["Dialog"] +__all__ = ["Dialog"] DIALOG_ICON: Final = "questhead" diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi similarity index 89% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi index d806be74068e3..fe2961701c61d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/dnd.pyi @@ -1,9 +1,7 @@ -import sys from tkinter import Event, Misc, Tk, Widget from typing import ClassVar, Protocol -if sys.version_info >= (3, 9): - __all__ = ["dnd_start", "DndHandler"] +__all__ = ["dnd_start", "DndHandler"] class _DndSource(Protocol): def dnd_end(self, target: Widget | None, event: Event[Misc] | None, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi similarity index 85% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi index 3d62f079178ef..cafcf61e8635d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/filedialog.pyi @@ -1,25 +1,23 @@ -import sys from _typeshed import Incomplete, StrOrBytesPath from collections.abc import Iterable from tkinter import Button, Entry, Frame, Listbox, Misc, Scrollbar, StringVar, Toplevel, commondialog from typing import IO, ClassVar, Literal -if sys.version_info >= (3, 9): - __all__ = [ - "FileDialog", - "LoadFileDialog", - "SaveFileDialog", - "Open", - "SaveAs", - "Directory", - "askopenfilename", - "asksaveasfilename", - "askopenfilenames", - "askopenfile", - "askopenfiles", - "asksaveasfile", - "askdirectory", - ] +__all__ = [ + "FileDialog", + "LoadFileDialog", + "SaveFileDialog", + "Open", + "SaveAs", + "Directory", + "askopenfilename", + "asksaveasfilename", + "askopenfilenames", + "askopenfile", + "askopenfiles", + "asksaveasfile", + "askdirectory", +] dialogstates: dict[Incomplete, tuple[Incomplete, Incomplete]] @@ -80,8 +78,8 @@ class Directory(commondialog.Dialog): # TODO: command kwarg available on macos def asksaveasfilename( *, - confirmoverwrite: bool | None = ..., - defaultextension: str | None = ..., + confirmoverwrite: bool | None = True, + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., @@ -91,7 +89,7 @@ def asksaveasfilename( ) -> str: ... # can be empty string def askopenfilename( *, - defaultextension: str | None = ..., + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., @@ -101,7 +99,7 @@ def askopenfilename( ) -> str: ... # can be empty string def askopenfilenames( *, - defaultextension: str | None = ..., + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., @@ -110,15 +108,15 @@ def askopenfilenames( typevariable: StringVar | str | None = ..., ) -> Literal[""] | tuple[str, ...]: ... def askdirectory( - *, initialdir: StrOrBytesPath | None = ..., mustexist: bool | None = ..., parent: Misc | None = ..., title: str | None = ... + *, initialdir: StrOrBytesPath | None = ..., mustexist: bool | None = False, parent: Misc | None = ..., title: str | None = ... ) -> str: ... # can be empty string # TODO: If someone actually uses these, overload to have the actual return type of open(..., mode) def asksaveasfile( mode: str = "w", *, - confirmoverwrite: bool | None = ..., - defaultextension: str | None = ..., + confirmoverwrite: bool | None = True, + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., @@ -129,7 +127,7 @@ def asksaveasfile( def askopenfile( mode: str = "r", *, - defaultextension: str | None = ..., + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., @@ -140,7 +138,7 @@ def askopenfile( def askopenfiles( mode: str = "r", *, - defaultextension: str | None = ..., + defaultextension: str | None = "", filetypes: Iterable[tuple[str, str | list[str] | tuple[str, ...]]] | None = ..., initialdir: StrOrBytesPath | None = ..., initialfile: StrOrBytesPath | None = ..., diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/font.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/font.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/font.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/font.pyi index 317f3068be63a..cab97490be340 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/font.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/font.pyi @@ -1,11 +1,11 @@ import _tkinter +import itertools import sys import tkinter -from typing import Any, Final, Literal, TypedDict, overload -from typing_extensions import TypeAlias +from typing import Any, ClassVar, Final, Literal, TypedDict, overload +from typing_extensions import TypeAlias, Unpack -if sys.version_info >= (3, 9): - __all__ = ["NORMAL", "ROMAN", "BOLD", "ITALIC", "nametofont", "Font", "families", "names"] +__all__ = ["NORMAL", "ROMAN", "BOLD", "ITALIC", "nametofont", "Font", "families", "names"] NORMAL: Final = "normal" ROMAN: Final = "roman" @@ -17,9 +17,9 @@ _FontDescription: TypeAlias = ( | Font # A font object constructed in Python | list[Any] # ["Helvetica", 12, BOLD] | tuple[str] # ("Liberation Sans",) needs wrapping in tuple/list to handle spaces - | tuple[str, int] # ("Liberation Sans", 12) - | tuple[str, int, str] # ("Liberation Sans", 12, "bold") - | tuple[str, int, list[str] | tuple[str, ...]] # e.g. bold and italic + # ("Liberation Sans", 12) or ("Liberation Sans", 12, "bold", "italic", "underline") + | tuple[str, int, Unpack[tuple[str, ...]]] # Any number of trailing options is permitted + | tuple[str, int, list[str] | tuple[str, ...]] # Options can also be passed as list/tuple | _tkinter.Tcl_Obj # A font object constructed in Tcl ) @@ -40,6 +40,7 @@ class _MetricsDict(TypedDict): class Font: name: str delete_font: bool + counter: ClassVar[itertools.count[int]] # undocumented def __init__( self, # In tkinter, 'root' refers to tkinter.Tk by convention, but the code @@ -56,6 +57,7 @@ class Font: underline: bool = ..., overstrike: bool = ..., ) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __setitem__(self, key: str, value: Any) -> None: ... @overload def cget(self, option: Literal["family"]) -> str: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi index 5cdfe512f9b76..902fab62ac05a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/messagebox.pyi @@ -1,18 +1,7 @@ -import sys from tkinter.commondialog import Dialog from typing import ClassVar, Final -if sys.version_info >= (3, 9): - __all__ = [ - "showinfo", - "showwarning", - "showerror", - "askquestion", - "askokcancel", - "askyesno", - "askyesnocancel", - "askretrycancel", - ] +__all__ = ["showinfo", "showwarning", "showerror", "askquestion", "askokcancel", "askyesno", "askyesnocancel", "askretrycancel"] ERROR: Final = "error" INFO: Final = "info" diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/scrolledtext.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/scrolledtext.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/scrolledtext.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/scrolledtext.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/simpledialog.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/simpledialog.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/simpledialog.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/simpledialog.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/tix.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/tix.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/tix.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/tix.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi similarity index 99% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi index b851f478140af..ab3c010938bef 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tkinter/ttk.pyi @@ -1,6 +1,6 @@ import _tkinter import tkinter -from _typeshed import Incomplete +from _typeshed import Incomplete, MaybeNone from collections.abc import Callable from tkinter.font import _FontDescription from typing import Any, Literal, TypedDict, overload @@ -562,7 +562,7 @@ class Notebook(Widget): compound: tkinter._Compound = ..., underline: int = ..., ) -> None: ... - def forget(self, tab_id) -> None: ... + def forget(self, tab_id) -> None: ... # type: ignore[override] def hide(self, tab_id) -> None: ... def identify(self, x: int, y: int) -> str: ... def index(self, tab_id): ... @@ -1100,7 +1100,7 @@ class Treeview(Widget, tkinter.XView, tkinter.YView): open: bool = ..., tags: str | list[str] | tuple[str, ...] = ..., ) -> None: ... - def move(self, item: str | int, parent: str, index: int) -> None: ... + def move(self, item: str | int, parent: str, index: int | Literal["end"]) -> None: ... reattach = move def next(self, item: str | int) -> str: ... # returning empty string means last item def parent(self, item: str | int) -> str: ... @@ -1156,7 +1156,7 @@ class Treeview(Widget, tkinter.XView, tkinter.YView): background: str = ..., font: _FontDescription = ..., image: tkinter._ImageSpec = ..., - ) -> _TreeviewTagDict | Any: ... # can be None but annoying to check + ) -> _TreeviewTagDict | MaybeNone: ... # can be None but annoying to check @overload def tag_has(self, tagname: str, item: None = None) -> tuple[str, ...]: ... @overload diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/token.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/token.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/token.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/token.pyi index 668987d7c2bfd..7c13b15d95b79 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/token.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/token.pyi @@ -76,7 +76,10 @@ if sys.version_info >= (3, 10): __all__ += ["SOFT_KEYWORD"] if sys.version_info >= (3, 12): - __all__ += ["EXCLAMATION", "FSTRING_END", "FSTRING_MIDDLE", "FSTRING_START"] + __all__ += ["EXCLAMATION", "FSTRING_END", "FSTRING_MIDDLE", "FSTRING_START", "EXACT_TOKEN_TYPES"] + +if sys.version_info >= (3, 14): + __all__ += ["TSTRING_START", "TSTRING_MIDDLE", "TSTRING_END"] ENDMARKER: int NAME: int @@ -155,6 +158,11 @@ if sys.version_info >= (3, 12): FSTRING_MIDDLE: int FSTRING_START: int +if sys.version_info >= (3, 14): + TSTRING_START: int + TSTRING_MIDDLE: int + TSTRING_END: int + def ISTERMINAL(x: int) -> bool: ... def ISNONTERMINAL(x: int) -> bool: ... def ISEOF(x: int) -> bool: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tokenize.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tokenize.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tokenize.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tokenize.pyi index e1c8fedee55c8..b658740a1ad7a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tokenize.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tokenize.pyi @@ -4,7 +4,7 @@ from collections.abc import Callable, Generator, Iterable, Sequence from re import Pattern from token import * from token import EXACT_TOKEN_TYPES as EXACT_TOKEN_TYPES -from typing import Any, NamedTuple, TextIO +from typing import Any, NamedTuple, TextIO, type_check_only from typing_extensions import TypeAlias __all__ = [ @@ -88,16 +88,21 @@ if sys.version_info >= (3, 10): __all__ += ["SOFT_KEYWORD"] if sys.version_info >= (3, 12): - __all__ += ["EXCLAMATION", "FSTRING_END", "FSTRING_MIDDLE", "FSTRING_START"] + __all__ += ["EXCLAMATION", "FSTRING_END", "FSTRING_MIDDLE", "FSTRING_START", "EXACT_TOKEN_TYPES"] if sys.version_info >= (3, 13): __all__ += ["TokenError", "open"] +if sys.version_info >= (3, 14): + __all__ += ["TSTRING_START", "TSTRING_MIDDLE", "TSTRING_END"] + cookie_re: Pattern[str] blank_re: Pattern[bytes] _Position: TypeAlias = tuple[int, int] +# This class is not exposed. It calls itself tokenize.TokenInfo. +@type_check_only class _TokenInfo(NamedTuple): type: int string: str @@ -123,14 +128,16 @@ class Untokenizer: prev_col: int encoding: str | None def add_whitespace(self, start: _Position) -> None: ... + if sys.version_info >= (3, 12): + def add_backslash_continuation(self, start: _Position) -> None: ... + def untokenize(self, iterable: Iterable[_Token]) -> str: ... def compat(self, token: Sequence[int | str], iterable: Iterable[_Token]) -> None: ... if sys.version_info >= (3, 12): def escape_brackets(self, token: str) -> str: ... -# the docstring says "returns bytes" but is incorrect -- -# if the ENCODING token is missing, it skips the encode -def untokenize(iterable: Iterable[_Token]) -> Any: ... +# Returns str, unless the ENCODING token is present, in which case it returns bytes. +def untokenize(iterable: Iterable[_Token]) -> str | Any: ... def detect_encoding(readline: Callable[[], bytes | bytearray]) -> tuple[str, Sequence[bytes]]: ... def tokenize(readline: Callable[[], bytes | bytearray]) -> Generator[TokenInfo, None, None]: ... def generate_tokens(readline: Callable[[], str]) -> Generator[TokenInfo, None, None]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/tomllib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tomllib.pyi new file mode 100644 index 0000000000000..c160ffc38bfdd --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tomllib.pyi @@ -0,0 +1,26 @@ +import sys +from _typeshed import SupportsRead +from collections.abc import Callable +from typing import Any, overload +from typing_extensions import deprecated + +__all__ = ("loads", "load", "TOMLDecodeError") + +if sys.version_info >= (3, 14): + class TOMLDecodeError(ValueError): + msg: str + doc: str + pos: int + lineno: int + colno: int + @overload + def __init__(self, msg: str, doc: str, pos: int) -> None: ... + @overload + @deprecated("Deprecated in Python 3.14; Please set 'msg', 'doc' and 'pos' arguments only.") + def __init__(self, msg: str | type = ..., doc: str | type = ..., pos: int | type = ..., *args: Any) -> None: ... + +else: + class TOMLDecodeError(ValueError): ... + +def load(fp: SupportsRead[bytes], /, *, parse_float: Callable[[str], Any] = ...) -> dict[str, Any]: ... +def loads(s: str, /, *, parse_float: Callable[[str], Any] = ...) -> dict[str, Any]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/trace.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/trace.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/trace.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/trace.pyi index 04390f1191951..7e7cc1e9ac54a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/trace.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/trace.pyi @@ -75,11 +75,7 @@ class Trace: def runctx( self, cmd: str | types.CodeType, globals: Mapping[str, Any] | None = None, locals: Mapping[str, Any] | None = None ) -> None: ... - if sys.version_info >= (3, 9): - def runfunc(self, func: Callable[_P, _T], /, *args: _P.args, **kw: _P.kwargs) -> _T: ... - else: - def runfunc(self, func: Callable[_P, _T], *args: _P.args, **kw: _P.kwargs) -> _T: ... - + def runfunc(self, func: Callable[_P, _T], /, *args: _P.args, **kw: _P.kwargs) -> _T: ... def file_module_function_of(self, frame: types.FrameType) -> _FileModuleFunction: ... def globaltrace_trackcallers(self, frame: types.FrameType, why: str, arg: Any) -> None: ... def globaltrace_countfuncs(self, frame: types.FrameType, why: str, arg: Any) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/traceback.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/traceback.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/traceback.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/traceback.pyi index 1c4a59de66aa2..4553dbd08384d 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/traceback.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/traceback.pyi @@ -2,7 +2,7 @@ import sys from _typeshed import SupportsWrite, Unused from collections.abc import Generator, Iterable, Iterator, Mapping from types import FrameType, TracebackType -from typing import Any, Literal, overload +from typing import Any, ClassVar, Literal, overload from typing_extensions import Self, TypeAlias, deprecated __all__ = [ @@ -27,6 +27,9 @@ __all__ = [ "walk_tb", ] +if sys.version_info >= (3, 14): + __all__ += ["print_list"] + _FrameSummaryTuple: TypeAlias = tuple[str, int, str, str | None] def print_tb(tb: TracebackType | None, limit: int | None = None, file: SupportsWrite[str] | None = None) -> None: ... @@ -81,8 +84,6 @@ def print_stack(f: FrameType | None = None, limit: int | None = None, file: Supp def extract_tb(tb: TracebackType | None, limit: int | None = None) -> StackSummary: ... def extract_stack(f: FrameType | None = None, limit: int | None = None) -> StackSummary: ... def format_list(extracted_list: Iterable[FrameSummary | _FrameSummaryTuple]) -> list[str]: ... - -# undocumented def print_list(extracted_list: Iterable[FrameSummary | _FrameSummaryTuple], file: SupportsWrite[str] | None = None) -> None: ... if sys.version_info >= (3, 13): @@ -113,15 +114,26 @@ if sys.version_info >= (3, 11): def emit(self, text_gen: str | Iterable[str], margin_char: str | None = None) -> Generator[str, None, None]: ... class TracebackException: - __cause__: TracebackException - __context__: TracebackException + __cause__: TracebackException | None + __context__: TracebackException | None + if sys.version_info >= (3, 11): + exceptions: list[TracebackException] | None __suppress_context__: bool + if sys.version_info >= (3, 11): + __notes__: list[str] | None stack: StackSummary + + # These fields only exist for `SyntaxError`s, but there is no way to express that in the type system. filename: str - lineno: int + lineno: str | None + if sys.version_info >= (3, 10): + end_lineno: str | None text: str offset: int + if sys.version_info >= (3, 10): + end_offset: int | None msg: str + if sys.version_info >= (3, 13): @property def exc_type_str(self) -> str: ... @@ -218,6 +230,7 @@ class TracebackException: ) -> Self: ... def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] if sys.version_info >= (3, 11): def format(self, *, chain: bool = True, _ctx: _ExceptionPrintContext | None = None) -> Generator[str, None, None]: ... else: @@ -281,6 +294,7 @@ class FrameSummary: def __iter__(self) -> Iterator[Any]: ... def __eq__(self, other: object) -> bool: ... def __len__(self) -> Literal[4]: ... + __hash__: ClassVar[None] # type: ignore[assignment] class StackSummary(list[FrameSummary]): @classmethod diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tracemalloc.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tracemalloc.pyi similarity index 88% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tracemalloc.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tracemalloc.pyi index e721e414138ba..05d98ae127d84 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/tracemalloc.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/tracemalloc.pyi @@ -69,10 +69,7 @@ class Frame: def __ge__(self, other: Frame, NotImplemented: Any = ...) -> bool: ... def __le__(self, other: Frame, NotImplemented: Any = ...) -> bool: ... -if sys.version_info >= (3, 9): - _TraceTuple: TypeAlias = tuple[int, int, Sequence[_FrameTuple], int | None] | tuple[int, int, Sequence[_FrameTuple]] -else: - _TraceTuple: TypeAlias = tuple[int, int, Sequence[_FrameTuple]] +_TraceTuple: TypeAlias = tuple[int, int, Sequence[_FrameTuple], int | None] | tuple[int, int, Sequence[_FrameTuple]] class Trace: @property @@ -86,13 +83,9 @@ class Trace: def __hash__(self) -> int: ... class Traceback(Sequence[Frame]): - if sys.version_info >= (3, 9): - @property - def total_nframe(self) -> int | None: ... - def __init__(self, frames: Sequence[_FrameTuple], total_nframe: int | None = None) -> None: ... - else: - def __init__(self, frames: Sequence[_FrameTuple]) -> None: ... - + @property + def total_nframe(self) -> int | None: ... + def __init__(self, frames: Sequence[_FrameTuple], total_nframe: int | None = None) -> None: ... def format(self, limit: int | None = None, most_recent_first: bool = False) -> list[str]: ... @overload def __getitem__(self, index: SupportsIndex) -> Frame: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/tty.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/tty.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/tty.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/tty.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/turtle.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/turtle.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/turtle.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/turtle.pyi index 29d2893039278..a2ab728de943f 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/turtle.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/turtle.pyi @@ -1,7 +1,7 @@ import sys from collections.abc import Callable, Sequence from tkinter import Canvas, Frame, Misc, PhotoImage, Scrollbar -from typing import Any, ClassVar, overload +from typing import Any, ClassVar, Literal, TypedDict, overload from typing_extensions import Self, TypeAlias __all__ = [ @@ -141,8 +141,18 @@ if sys.version_info < (3, 13): _Color: TypeAlias = str | tuple[float, float, float] _AnyColor: TypeAlias = Any -# TODO: Replace this with a TypedDict once it becomes standardized. -_PenState: TypeAlias = dict[str, Any] +class _PenState(TypedDict): + shown: bool + pendown: bool + pencolor: _Color + fillcolor: _Color + pensize: int + speed: int + resizemode: Literal["auto", "user", "noresize"] + stretchfactor: tuple[float, float] + shearfactor: float + outline: int + tilt: float _Speed: TypeAlias = str | float _PolygonCoords: TypeAlias = Sequence[tuple[float, float]] @@ -283,6 +293,7 @@ class TNavigator: def heading(self) -> float: ... def setheading(self, to_angle: float) -> None: ... def circle(self, radius: float, extent: float | None = None, steps: int | None = None) -> None: ... + def speed(self, s: int | None = 0) -> int | None: ... fd = forward bk = back backward = back @@ -363,7 +374,7 @@ class TPen: st = showturtle ht = hideturtle -class RawTurtle(TPen, TNavigator): +class RawTurtle(TPen, TNavigator): # type: ignore[misc] # Conflicting methods in base classes screen: TurtleScreen screens: ClassVar[list[TurtleScreen]] def __init__( diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/types.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/types.pyi new file mode 100644 index 0000000000000..1163d71d2c95a --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/types.pyi @@ -0,0 +1,702 @@ +import sys +from _typeshed import AnnotationForm, MaybeNone, SupportsKeysAndGetItem +from _typeshed.importlib import LoaderProtocol +from collections.abc import ( + AsyncGenerator, + Awaitable, + Callable, + Coroutine, + Generator, + ItemsView, + Iterable, + Iterator, + KeysView, + Mapping, + MutableSequence, + ValuesView, +) +from importlib.machinery import ModuleSpec +from typing import Any, ClassVar, Literal, TypeVar, final, overload +from typing_extensions import ParamSpec, Self, TypeAliasType, TypeVarTuple, deprecated + +if sys.version_info >= (3, 14): + from _typeshed import AnnotateFunc + +__all__ = [ + "FunctionType", + "LambdaType", + "CodeType", + "MappingProxyType", + "SimpleNamespace", + "GeneratorType", + "CoroutineType", + "AsyncGeneratorType", + "MethodType", + "BuiltinFunctionType", + "ModuleType", + "TracebackType", + "FrameType", + "GetSetDescriptorType", + "MemberDescriptorType", + "new_class", + "prepare_class", + "DynamicClassAttribute", + "coroutine", + "BuiltinMethodType", + "ClassMethodDescriptorType", + "MethodDescriptorType", + "MethodWrapperType", + "WrapperDescriptorType", + "resolve_bases", + "CellType", + "GenericAlias", +] + +if sys.version_info >= (3, 10): + __all__ += ["EllipsisType", "NoneType", "NotImplementedType", "UnionType"] + +if sys.version_info >= (3, 12): + __all__ += ["get_original_bases"] + +if sys.version_info >= (3, 13): + __all__ += ["CapsuleType"] + +# Note, all classes "defined" here require special handling. + +_T1 = TypeVar("_T1") +_T2 = TypeVar("_T2") +_KT = TypeVar("_KT") +_VT_co = TypeVar("_VT_co", covariant=True) + +# Make sure this class definition stays roughly in line with `builtins.function` +@final +class FunctionType: + @property + def __closure__(self) -> tuple[CellType, ...] | None: ... + __code__: CodeType + __defaults__: tuple[Any, ...] | None + __dict__: dict[str, Any] + @property + def __globals__(self) -> dict[str, Any]: ... + __name__: str + __qualname__: str + __annotations__: dict[str, AnnotationForm] + if sys.version_info >= (3, 14): + __annotate__: AnnotateFunc | None + __kwdefaults__: dict[str, Any] | None + if sys.version_info >= (3, 10): + @property + def __builtins__(self) -> dict[str, Any]: ... + if sys.version_info >= (3, 12): + __type_params__: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] + + __module__: str + if sys.version_info >= (3, 13): + def __new__( + cls, + code: CodeType, + globals: dict[str, Any], + name: str | None = None, + argdefs: tuple[object, ...] | None = None, + closure: tuple[CellType, ...] | None = None, + kwdefaults: dict[str, object] | None = None, + ) -> Self: ... + else: + def __new__( + cls, + code: CodeType, + globals: dict[str, Any], + name: str | None = None, + argdefs: tuple[object, ...] | None = None, + closure: tuple[CellType, ...] | None = None, + ) -> Self: ... + + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + @overload + def __get__(self, instance: None, owner: type, /) -> FunctionType: ... + @overload + def __get__(self, instance: object, owner: type | None = None, /) -> MethodType: ... + +LambdaType = FunctionType + +@final +class CodeType: + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + @property + def co_argcount(self) -> int: ... + @property + def co_posonlyargcount(self) -> int: ... + @property + def co_kwonlyargcount(self) -> int: ... + @property + def co_nlocals(self) -> int: ... + @property + def co_stacksize(self) -> int: ... + @property + def co_flags(self) -> int: ... + @property + def co_code(self) -> bytes: ... + @property + def co_consts(self) -> tuple[Any, ...]: ... + @property + def co_names(self) -> tuple[str, ...]: ... + @property + def co_varnames(self) -> tuple[str, ...]: ... + @property + def co_filename(self) -> str: ... + @property + def co_name(self) -> str: ... + @property + def co_firstlineno(self) -> int: ... + if sys.version_info >= (3, 10): + @property + @deprecated("Will be removed in Python 3.14. Use the co_lines() method instead.") + def co_lnotab(self) -> bytes: ... + else: + @property + def co_lnotab(self) -> bytes: ... + + @property + def co_freevars(self) -> tuple[str, ...]: ... + @property + def co_cellvars(self) -> tuple[str, ...]: ... + if sys.version_info >= (3, 10): + @property + def co_linetable(self) -> bytes: ... + def co_lines(self) -> Iterator[tuple[int, int, int | None]]: ... + if sys.version_info >= (3, 11): + @property + def co_exceptiontable(self) -> bytes: ... + @property + def co_qualname(self) -> str: ... + def co_positions(self) -> Iterable[tuple[int | None, int | None, int | None, int | None]]: ... + + if sys.version_info >= (3, 11): + def __new__( + cls, + argcount: int, + posonlyargcount: int, + kwonlyargcount: int, + nlocals: int, + stacksize: int, + flags: int, + codestring: bytes, + constants: tuple[object, ...], + names: tuple[str, ...], + varnames: tuple[str, ...], + filename: str, + name: str, + qualname: str, + firstlineno: int, + linetable: bytes, + exceptiontable: bytes, + freevars: tuple[str, ...] = ..., + cellvars: tuple[str, ...] = ..., + /, + ) -> Self: ... + elif sys.version_info >= (3, 10): + def __new__( + cls, + argcount: int, + posonlyargcount: int, + kwonlyargcount: int, + nlocals: int, + stacksize: int, + flags: int, + codestring: bytes, + constants: tuple[object, ...], + names: tuple[str, ...], + varnames: tuple[str, ...], + filename: str, + name: str, + firstlineno: int, + linetable: bytes, + freevars: tuple[str, ...] = ..., + cellvars: tuple[str, ...] = ..., + /, + ) -> Self: ... + else: + def __new__( + cls, + argcount: int, + posonlyargcount: int, + kwonlyargcount: int, + nlocals: int, + stacksize: int, + flags: int, + codestring: bytes, + constants: tuple[object, ...], + names: tuple[str, ...], + varnames: tuple[str, ...], + filename: str, + name: str, + firstlineno: int, + lnotab: bytes, + freevars: tuple[str, ...] = ..., + cellvars: tuple[str, ...] = ..., + /, + ) -> Self: ... + if sys.version_info >= (3, 11): + def replace( + self, + *, + co_argcount: int = -1, + co_posonlyargcount: int = -1, + co_kwonlyargcount: int = -1, + co_nlocals: int = -1, + co_stacksize: int = -1, + co_flags: int = -1, + co_firstlineno: int = -1, + co_code: bytes = ..., + co_consts: tuple[object, ...] = ..., + co_names: tuple[str, ...] = ..., + co_varnames: tuple[str, ...] = ..., + co_freevars: tuple[str, ...] = ..., + co_cellvars: tuple[str, ...] = ..., + co_filename: str = ..., + co_name: str = ..., + co_qualname: str = ..., + co_linetable: bytes = ..., + co_exceptiontable: bytes = ..., + ) -> Self: ... + elif sys.version_info >= (3, 10): + def replace( + self, + *, + co_argcount: int = -1, + co_posonlyargcount: int = -1, + co_kwonlyargcount: int = -1, + co_nlocals: int = -1, + co_stacksize: int = -1, + co_flags: int = -1, + co_firstlineno: int = -1, + co_code: bytes = ..., + co_consts: tuple[object, ...] = ..., + co_names: tuple[str, ...] = ..., + co_varnames: tuple[str, ...] = ..., + co_freevars: tuple[str, ...] = ..., + co_cellvars: tuple[str, ...] = ..., + co_filename: str = ..., + co_name: str = ..., + co_linetable: bytes = ..., + ) -> Self: ... + else: + def replace( + self, + *, + co_argcount: int = -1, + co_posonlyargcount: int = -1, + co_kwonlyargcount: int = -1, + co_nlocals: int = -1, + co_stacksize: int = -1, + co_flags: int = -1, + co_firstlineno: int = -1, + co_code: bytes = ..., + co_consts: tuple[object, ...] = ..., + co_names: tuple[str, ...] = ..., + co_varnames: tuple[str, ...] = ..., + co_freevars: tuple[str, ...] = ..., + co_cellvars: tuple[str, ...] = ..., + co_filename: str = ..., + co_name: str = ..., + co_lnotab: bytes = ..., + ) -> Self: ... + + if sys.version_info >= (3, 13): + __replace__ = replace + +@final +class MappingProxyType(Mapping[_KT, _VT_co]): + __hash__: ClassVar[None] # type: ignore[assignment] + def __new__(cls, mapping: SupportsKeysAndGetItem[_KT, _VT_co]) -> Self: ... + def __getitem__(self, key: _KT, /) -> _VT_co: ... + def __iter__(self) -> Iterator[_KT]: ... + def __len__(self) -> int: ... + def __eq__(self, value: object, /) -> bool: ... + def copy(self) -> dict[_KT, _VT_co]: ... + def keys(self) -> KeysView[_KT]: ... + def values(self) -> ValuesView[_VT_co]: ... + def items(self) -> ItemsView[_KT, _VT_co]: ... + @overload + def get(self, key: _KT, /) -> _VT_co | None: ... + @overload + def get(self, key: _KT, default: _VT_co | _T2, /) -> _VT_co | _T2: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __reversed__(self) -> Iterator[_KT]: ... + def __or__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ... + def __ror__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ... + +class SimpleNamespace: + __hash__: ClassVar[None] # type: ignore[assignment] + if sys.version_info >= (3, 13): + def __init__(self, mapping_or_iterable: Mapping[str, Any] | Iterable[tuple[str, Any]] = (), /, **kwargs: Any) -> None: ... + else: + def __init__(self, **kwargs: Any) -> None: ... + + def __eq__(self, value: object, /) -> bool: ... + def __getattribute__(self, name: str, /) -> Any: ... + def __setattr__(self, name: str, value: Any, /) -> None: ... + def __delattr__(self, name: str, /) -> None: ... + if sys.version_info >= (3, 13): + def __replace__(self, **kwargs: Any) -> Self: ... + +class ModuleType: + __name__: str + __file__: str | None + @property + def __dict__(self) -> dict[str, Any]: ... # type: ignore[override] + __loader__: LoaderProtocol | None + __package__: str | None + __path__: MutableSequence[str] + __spec__: ModuleSpec | None + # N.B. Although this is the same type as `builtins.object.__doc__`, + # it is deliberately redeclared here. Most symbols declared in the namespace + # of `types.ModuleType` are available as "implicit globals" within a module's + # namespace, but this is not true for symbols declared in the namespace of `builtins.object`. + # Redeclaring `__doc__` here helps some type checkers understand that `__doc__` is available + # as an implicit global in all modules, similar to `__name__`, `__file__`, `__spec__`, etc. + __doc__: str | None + __annotations__: dict[str, AnnotationForm] + if sys.version_info >= (3, 14): + __annotate__: AnnotateFunc | None + + def __init__(self, name: str, doc: str | None = ...) -> None: ... + # __getattr__ doesn't exist at runtime, + # but having it here in typeshed makes dynamic imports + # using `builtins.__import__` or `importlib.import_module` less painful + def __getattr__(self, name: str) -> Any: ... + +@final +class CellType: + def __new__(cls, contents: object = ..., /) -> Self: ... + __hash__: ClassVar[None] # type: ignore[assignment] + cell_contents: Any + +_YieldT_co = TypeVar("_YieldT_co", covariant=True) +_SendT_contra = TypeVar("_SendT_contra", contravariant=True) +_ReturnT_co = TypeVar("_ReturnT_co", covariant=True) + +@final +class GeneratorType(Generator[_YieldT_co, _SendT_contra, _ReturnT_co]): + @property + def gi_code(self) -> CodeType: ... + @property + def gi_frame(self) -> FrameType: ... + @property + def gi_running(self) -> bool: ... + @property + def gi_yieldfrom(self) -> GeneratorType[_YieldT_co, _SendT_contra, Any] | None: ... + if sys.version_info >= (3, 11): + @property + def gi_suspended(self) -> bool: ... + __name__: str + __qualname__: str + def __iter__(self) -> Self: ... + def __next__(self) -> _YieldT_co: ... + def send(self, arg: _SendT_contra, /) -> _YieldT_co: ... + @overload + def throw( + self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / + ) -> _YieldT_co: ... + @overload + def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... + if sys.version_info >= (3, 13): + def __class_getitem__(cls, item: Any, /) -> Any: ... + +@final +class AsyncGeneratorType(AsyncGenerator[_YieldT_co, _SendT_contra]): + @property + def ag_await(self) -> Awaitable[Any] | None: ... + @property + def ag_code(self) -> CodeType: ... + @property + def ag_frame(self) -> FrameType: ... + @property + def ag_running(self) -> bool: ... + __name__: str + __qualname__: str + if sys.version_info >= (3, 12): + @property + def ag_suspended(self) -> bool: ... + + def __aiter__(self) -> Self: ... + def __anext__(self) -> Coroutine[Any, Any, _YieldT_co]: ... + def asend(self, val: _SendT_contra, /) -> Coroutine[Any, Any, _YieldT_co]: ... + @overload + async def athrow( + self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / + ) -> _YieldT_co: ... + @overload + async def athrow(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... + def aclose(self) -> Coroutine[Any, Any, None]: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +@final +class CoroutineType(Coroutine[_YieldT_co, _SendT_contra, _ReturnT_co]): + __name__: str + __qualname__: str + @property + def cr_await(self) -> Any | None: ... + @property + def cr_code(self) -> CodeType: ... + @property + def cr_frame(self) -> FrameType: ... + @property + def cr_running(self) -> bool: ... + @property + def cr_origin(self) -> tuple[tuple[str, int, str], ...] | None: ... + if sys.version_info >= (3, 11): + @property + def cr_suspended(self) -> bool: ... + + def close(self) -> None: ... + def __await__(self) -> Generator[Any, None, _ReturnT_co]: ... + def send(self, arg: _SendT_contra, /) -> _YieldT_co: ... + @overload + def throw( + self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., / + ) -> _YieldT_co: ... + @overload + def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ... + if sys.version_info >= (3, 13): + def __class_getitem__(cls, item: Any, /) -> Any: ... + +@final +class MethodType: + @property + def __closure__(self) -> tuple[CellType, ...] | None: ... # inherited from the added function + @property + def __code__(self) -> CodeType: ... # inherited from the added function + @property + def __defaults__(self) -> tuple[Any, ...] | None: ... # inherited from the added function + @property + def __func__(self) -> Callable[..., Any]: ... + @property + def __self__(self) -> object: ... + @property + def __name__(self) -> str: ... # inherited from the added function + @property + def __qualname__(self) -> str: ... # inherited from the added function + def __new__(cls, func: Callable[..., Any], instance: object, /) -> Self: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + +@final +class BuiltinFunctionType: + @property + def __self__(self) -> object | ModuleType: ... + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + +BuiltinMethodType = BuiltinFunctionType + +@final +class WrapperDescriptorType: + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... + +@final +class MethodWrapperType: + @property + def __self__(self) -> object: ... + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __eq__(self, value: object, /) -> bool: ... + def __ne__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + +@final +class MethodDescriptorType: + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... + +@final +class ClassMethodDescriptorType: + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... + +@final +class TracebackType: + def __new__(cls, tb_next: TracebackType | None, tb_frame: FrameType, tb_lasti: int, tb_lineno: int) -> Self: ... + tb_next: TracebackType | None + # the rest are read-only + @property + def tb_frame(self) -> FrameType: ... + @property + def tb_lasti(self) -> int: ... + @property + def tb_lineno(self) -> int: ... + +@final +class FrameType: + @property + def f_back(self) -> FrameType | None: ... + @property + def f_builtins(self) -> dict[str, Any]: ... + @property + def f_code(self) -> CodeType: ... + @property + def f_globals(self) -> dict[str, Any]: ... + @property + def f_lasti(self) -> int: ... + # see discussion in #6769: f_lineno *can* sometimes be None, + # but you should probably file a bug report with CPython if you encounter it being None in the wild. + # An `int | None` annotation here causes too many false-positive errors, so applying `int | Any`. + @property + def f_lineno(self) -> int | MaybeNone: ... + @property + def f_locals(self) -> dict[str, Any]: ... + f_trace: Callable[[FrameType, str, Any], Any] | None + f_trace_lines: bool + f_trace_opcodes: bool + def clear(self) -> None: ... + +@final +class GetSetDescriptorType: + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... + def __set__(self, instance: Any, value: Any, /) -> None: ... + def __delete__(self, instance: Any, /) -> None: ... + +@final +class MemberDescriptorType: + @property + def __name__(self) -> str: ... + @property + def __qualname__(self) -> str: ... + @property + def __objclass__(self) -> type: ... + def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ... + def __set__(self, instance: Any, value: Any, /) -> None: ... + def __delete__(self, instance: Any, /) -> None: ... + +def new_class( + name: str, + bases: Iterable[object] = (), + kwds: dict[str, Any] | None = None, + exec_body: Callable[[dict[str, Any]], object] | None = None, +) -> type: ... +def resolve_bases(bases: Iterable[object]) -> tuple[Any, ...]: ... +def prepare_class( + name: str, bases: tuple[type, ...] = (), kwds: dict[str, Any] | None = None +) -> tuple[type, dict[str, Any], dict[str, Any]]: ... + +if sys.version_info >= (3, 12): + def get_original_bases(cls: type, /) -> tuple[Any, ...]: ... + +# Does not actually inherit from property, but saying it does makes sure that +# pyright handles this class correctly. +class DynamicClassAttribute(property): + fget: Callable[[Any], Any] | None + fset: Callable[[Any, Any], object] | None # type: ignore[assignment] + fdel: Callable[[Any], object] | None # type: ignore[assignment] + overwrite_doc: bool + __isabstractmethod__: bool + def __init__( + self, + fget: Callable[[Any], Any] | None = None, + fset: Callable[[Any, Any], object] | None = None, + fdel: Callable[[Any], object] | None = None, + doc: str | None = None, + ) -> None: ... + def __get__(self, instance: Any, ownerclass: type | None = None) -> Any: ... + def __set__(self, instance: Any, value: Any) -> None: ... + def __delete__(self, instance: Any) -> None: ... + def getter(self, fget: Callable[[Any], Any]) -> DynamicClassAttribute: ... + def setter(self, fset: Callable[[Any, Any], object]) -> DynamicClassAttribute: ... + def deleter(self, fdel: Callable[[Any], object]) -> DynamicClassAttribute: ... + +_Fn = TypeVar("_Fn", bound=Callable[..., object]) +_R = TypeVar("_R") +_P = ParamSpec("_P") + +# it's not really an Awaitable, but can be used in an await expression. Real type: Generator & Awaitable +@overload +def coroutine(func: Callable[_P, Generator[Any, Any, _R]]) -> Callable[_P, Awaitable[_R]]: ... +@overload +def coroutine(func: _Fn) -> _Fn: ... + +class GenericAlias: + @property + def __origin__(self) -> type | TypeAliasType: ... + @property + def __args__(self) -> tuple[Any, ...]: ... + @property + def __parameters__(self) -> tuple[Any, ...]: ... + def __new__(cls, origin: type, args: Any, /) -> Self: ... + def __getitem__(self, typeargs: Any, /) -> GenericAlias: ... + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + def __mro_entries__(self, bases: Iterable[object], /) -> tuple[type, ...]: ... + if sys.version_info >= (3, 11): + @property + def __unpacked__(self) -> bool: ... + @property + def __typing_unpacked_tuple_args__(self) -> tuple[Any, ...] | None: ... + if sys.version_info >= (3, 10): + def __or__(self, value: Any, /) -> UnionType: ... + def __ror__(self, value: Any, /) -> UnionType: ... + + # GenericAlias delegates attr access to `__origin__` + def __getattr__(self, name: str) -> Any: ... + +if sys.version_info >= (3, 10): + @final + class NoneType: + def __bool__(self) -> Literal[False]: ... + + @final + class EllipsisType: ... + + from builtins import _NotImplementedType + + NotImplementedType = _NotImplementedType + @final + class UnionType: + @property + def __args__(self) -> tuple[Any, ...]: ... + @property + def __parameters__(self) -> tuple[Any, ...]: ... + def __or__(self, value: Any, /) -> UnionType: ... + def __ror__(self, value: Any, /) -> UnionType: ... + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + +if sys.version_info >= (3, 13): + @final + class CapsuleType: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/typing.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/typing.pyi similarity index 75% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/typing.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/typing.pyi index ce16d9adff998..5aa85543ed2ca 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/typing.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/typing.pyi @@ -12,8 +12,8 @@ from re import Match as Match, Pattern as Pattern from types import ( BuiltinFunctionType, CodeType, - FrameType, FunctionType, + GenericAlias, MethodDescriptorType, MethodType, MethodWrapperType, @@ -23,13 +23,17 @@ from types import ( ) from typing_extensions import Never as _Never, ParamSpec as _ParamSpec, deprecated -if sys.version_info >= (3, 9): - from types import GenericAlias +if sys.version_info >= (3, 14): + from _typeshed import EvaluateFunc + + from annotationlib import Format + if sys.version_info >= (3, 10): from types import UnionType __all__ = [ "AbstractSet", + "Annotated", "Any", "AnyStr", "AsyncContextManager", @@ -37,7 +41,7 @@ __all__ = [ "AsyncIterable", "AsyncIterator", "Awaitable", - "ByteString", + "BinaryIO", "Callable", "ChainMap", "ClassVar", @@ -50,10 +54,12 @@ __all__ = [ "Deque", "Dict", "Final", + "ForwardRef", "FrozenSet", "Generator", "Generic", "Hashable", + "IO", "ItemsView", "Iterable", "Iterator", @@ -62,12 +68,16 @@ __all__ = [ "Literal", "Mapping", "MappingView", + "Match", "MutableMapping", "MutableSequence", "MutableSet", "NamedTuple", "NewType", + "NoReturn", "Optional", + "OrderedDict", + "Pattern", "Protocol", "Reversible", "Sequence", @@ -81,6 +91,7 @@ __all__ = [ "SupportsInt", "SupportsRound", "Text", + "TextIO", "Tuple", "Type", "TypeVar", @@ -97,13 +108,13 @@ __all__ = [ "no_type_check_decorator", "overload", "runtime_checkable", - "ForwardRef", - "NoReturn", - "OrderedDict", ] -if sys.version_info >= (3, 9): - __all__ += ["Annotated", "BinaryIO", "IO", "Match", "Pattern", "TextIO"] +if sys.version_info < (3, 14): + __all__ += ["ByteString"] + +if sys.version_info >= (3, 14): + __all__ += ["evaluate_forward_ref"] if sys.version_info >= (3, 10): __all__ += ["Concatenate", "ParamSpec", "ParamSpecArgs", "ParamSpecKwargs", "TypeAlias", "TypeGuard", "is_typeddict"] @@ -131,7 +142,12 @@ if sys.version_info >= (3, 12): if sys.version_info >= (3, 13): __all__ += ["get_protocol_members", "is_protocol", "NoDefault", "TypeIs", "ReadOnly"] -Any = object() +# We can't use this name here because it leads to issues with mypy, likely +# due to an import cycle. Below instead we use Any with a comment. +# from _typeshed import AnnotationForm + +class Any: ... +class _Final: ... def final(f: _T) -> _T: ... @final @@ -139,9 +155,9 @@ class TypeVar: @property def __name__(self) -> str: ... @property - def __bound__(self) -> Any | None: ... + def __bound__(self) -> Any | None: ... # AnnotationForm @property - def __constraints__(self) -> tuple[Any, ...]: ... + def __constraints__(self) -> tuple[Any, ...]: ... # AnnotationForm @property def __covariant__(self) -> bool: ... @property @@ -151,47 +167,69 @@ class TypeVar: def __infer_variance__(self) -> bool: ... if sys.version_info >= (3, 13): @property - def __default__(self) -> Any: ... + def __default__(self) -> Any: ... # AnnotationForm if sys.version_info >= (3, 13): - def __init__( - self, + def __new__( + cls, name: str, - *constraints: Any, - bound: Any | None = None, + *constraints: Any, # AnnotationForm + bound: Any | None = None, # AnnotationForm contravariant: bool = False, covariant: bool = False, infer_variance: bool = False, - default: Any = ..., - ) -> None: ... + default: Any = ..., # AnnotationForm + ) -> Self: ... elif sys.version_info >= (3, 12): - def __init__( - self, + def __new__( + cls, name: str, - *constraints: Any, - bound: Any | None = None, + *constraints: Any, # AnnotationForm + bound: Any | None = None, # AnnotationForm covariant: bool = False, contravariant: bool = False, infer_variance: bool = False, - ) -> None: ... + ) -> Self: ... + elif sys.version_info >= (3, 11): + def __new__( + cls, + name: str, + *constraints: Any, # AnnotationForm + bound: Any | None = None, # AnnotationForm + covariant: bool = False, + contravariant: bool = False, + ) -> Self: ... else: def __init__( - self, name: str, *constraints: Any, bound: Any | None = None, covariant: bool = False, contravariant: bool = False + self, + name: str, + *constraints: Any, # AnnotationForm + bound: Any | None = None, # AnnotationForm + covariant: bool = False, + contravariant: bool = False, ) -> None: ... if sys.version_info >= (3, 10): - def __or__(self, right: Any) -> _SpecialForm: ... - def __ror__(self, left: Any) -> _SpecialForm: ... + def __or__(self, right: Any) -> _SpecialForm: ... # AnnotationForm + def __ror__(self, left: Any) -> _SpecialForm: ... # AnnotationForm if sys.version_info >= (3, 11): def __typing_subst__(self, arg: Any) -> Any: ... if sys.version_info >= (3, 13): def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... def has_default(self) -> bool: ... + if sys.version_info >= (3, 14): + @property + def evaluate_bound(self) -> EvaluateFunc | None: ... + @property + def evaluate_constraints(self) -> EvaluateFunc | None: ... + @property + def evaluate_default(self) -> EvaluateFunc | None: ... # Used for an undocumented mypy feature. Does not exist at runtime. +# Obsolete, use _typeshed._type_checker_internals.promote instead. _promote = object() # N.B. Keep this definition in sync with typing_extensions._SpecialForm @final -class _SpecialForm: +class _SpecialForm(_Final): def __getitem__(self, parameters: Any) -> object: ... if sys.version_info >= (3, 10): def __or__(self, other: Any) -> _SpecialForm: ... @@ -199,7 +237,6 @@ class _SpecialForm: Union: _SpecialForm Generic: _SpecialForm -# Protocol is only present in 3.8 and later, but mypy needs it unconditionally Protocol: _SpecialForm Callable: _SpecialForm Type: _SpecialForm @@ -211,8 +248,7 @@ Tuple: _SpecialForm Final: _SpecialForm Literal: _SpecialForm -# TypedDict is a (non-subscriptable) special form. -TypedDict: object +TypedDict: _SpecialForm if sys.version_info >= (3, 11): Self: _SpecialForm @@ -228,38 +264,53 @@ if sys.version_info >= (3, 11): def __name__(self) -> str: ... if sys.version_info >= (3, 13): @property - def __default__(self) -> Any: ... + def __default__(self) -> Any: ... # AnnotationForm def has_default(self) -> bool: ... if sys.version_info >= (3, 13): - def __init__(self, name: str, *, default: Any = ...) -> None: ... + def __new__(cls, name: str, *, default: Any = ...) -> Self: ... # AnnotationForm + elif sys.version_info >= (3, 12): + def __new__(cls, name: str) -> Self: ... else: def __init__(self, name: str) -> None: ... def __iter__(self) -> Any: ... def __typing_subst__(self, arg: Never) -> Never: ... def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... + if sys.version_info >= (3, 14): + @property + def evaluate_default(self) -> EvaluateFunc | None: ... if sys.version_info >= (3, 10): @final class ParamSpecArgs: @property def __origin__(self) -> ParamSpec: ... - def __init__(self, origin: ParamSpec) -> None: ... + if sys.version_info >= (3, 12): + def __new__(cls, origin: ParamSpec) -> Self: ... + else: + def __init__(self, origin: ParamSpec) -> None: ... + def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] @final class ParamSpecKwargs: @property def __origin__(self) -> ParamSpec: ... - def __init__(self, origin: ParamSpec) -> None: ... + if sys.version_info >= (3, 12): + def __new__(cls, origin: ParamSpec) -> Self: ... + else: + def __init__(self, origin: ParamSpec) -> None: ... + def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] @final class ParamSpec: @property def __name__(self) -> str: ... @property - def __bound__(self) -> Any | None: ... + def __bound__(self) -> Any | None: ... # AnnotationForm @property def __covariant__(self) -> bool: ... @property @@ -269,31 +320,45 @@ if sys.version_info >= (3, 10): def __infer_variance__(self) -> bool: ... if sys.version_info >= (3, 13): @property - def __default__(self) -> Any: ... + def __default__(self) -> Any: ... # AnnotationForm if sys.version_info >= (3, 13): - def __init__( - self, + def __new__( + cls, name: str, *, - bound: Any | None = None, + bound: Any | None = None, # AnnotationForm contravariant: bool = False, covariant: bool = False, infer_variance: bool = False, - default: Any = ..., - ) -> None: ... + default: Any = ..., # AnnotationForm + ) -> Self: ... elif sys.version_info >= (3, 12): - def __init__( - self, + def __new__( + cls, name: str, *, - bound: Any | None = None, + bound: Any | None = None, # AnnotationForm contravariant: bool = False, covariant: bool = False, infer_variance: bool = False, - ) -> None: ... + ) -> Self: ... + elif sys.version_info >= (3, 11): + def __new__( + cls, + name: str, + *, + bound: Any | None = None, # AnnotationForm + contravariant: bool = False, + covariant: bool = False, + ) -> Self: ... else: def __init__( - self, name: str, *, bound: Any | None = None, contravariant: bool = False, covariant: bool = False + self, + name: str, + *, + bound: Any | None = None, # AnnotationForm + contravariant: bool = False, + covariant: bool = False, ) -> None: ... @property @@ -308,13 +373,16 @@ if sys.version_info >= (3, 10): def __ror__(self, left: Any) -> _SpecialForm: ... if sys.version_info >= (3, 13): def has_default(self) -> bool: ... + if sys.version_info >= (3, 14): + @property + def evaluate_default(self) -> EvaluateFunc | None: ... Concatenate: _SpecialForm TypeAlias: _SpecialForm TypeGuard: _SpecialForm class NewType: - def __init__(self, name: str, tp: Any) -> None: ... + def __init__(self, name: str, tp: Any) -> None: ... # AnnotationForm if sys.version_info >= (3, 11): @staticmethod def __call__(x: _T, /) -> _T: ... @@ -332,6 +400,8 @@ _F = TypeVar("_F", bound=Callable[..., Any]) _P = _ParamSpec("_P") _T = TypeVar("_T") +_FT = TypeVar("_FT", bound=Callable[..., Any] | type) + # These type variables are used by the container types. _S = TypeVar("_S") _KT = TypeVar("_KT") # Key type. @@ -346,7 +416,7 @@ def no_type_check(arg: _F) -> _F: ... def no_type_check_decorator(decorator: Callable[_P, _T]) -> Callable[_P, _T]: ... # This itself is only available during type checking -def type_check_only(func_or_cls: _F) -> _F: ... +def type_check_only(func_or_cls: _FT) -> _FT: ... # Type aliases and type constructors @@ -365,8 +435,7 @@ ChainMap = _Alias() OrderedDict = _Alias() -if sys.version_info >= (3, 9): - Annotated: _SpecialForm +Annotated: _SpecialForm # Predefined type variables. AnyStr = TypeVar("AnyStr", str, bytes) # noqa: Y001 @@ -450,7 +519,8 @@ _YieldT_co = TypeVar("_YieldT_co", covariant=True) _SendT_contra = TypeVar("_SendT_contra", contravariant=True, default=None) _ReturnT_co = TypeVar("_ReturnT_co", covariant=True, default=None) -class Generator(Iterator[_YieldT_co], Generic[_YieldT_co, _SendT_contra, _ReturnT_co]): +@runtime_checkable +class Generator(Iterator[_YieldT_co], Protocol[_YieldT_co, _SendT_contra, _ReturnT_co]): def __next__(self) -> _YieldT_co: ... @abstractmethod def send(self, value: _SendT_contra, /) -> _YieldT_co: ... @@ -462,16 +532,12 @@ class Generator(Iterator[_YieldT_co], Generic[_YieldT_co, _SendT_contra, _Return @overload @abstractmethod def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = None, /) -> _YieldT_co: ... - def close(self) -> None: ... + if sys.version_info >= (3, 13): + def close(self) -> _ReturnT_co | None: ... + else: + def close(self) -> None: ... + def __iter__(self) -> Generator[_YieldT_co, _SendT_contra, _ReturnT_co]: ... - @property - def gi_code(self) -> CodeType: ... - @property - def gi_frame(self) -> FrameType: ... - @property - def gi_running(self) -> bool: ... - @property - def gi_yieldfrom(self) -> Generator[Any, Any, Any] | None: ... # NOTE: Prior to Python 3.13 these aliases are lacking the second _ExitT_co parameter if sys.version_info >= (3, 13): @@ -491,22 +557,15 @@ class Awaitable(Protocol[_T_co]): def __await__(self) -> Generator[Any, Any, _T_co]: ... # Non-default variations to accommodate couroutines, and `AwaitableGenerator` having a 4th type parameter. -_SendT_contra_nd = TypeVar("_SendT_contra_nd", contravariant=True) -_ReturnT_co_nd = TypeVar("_ReturnT_co_nd", covariant=True) +_SendT_nd_contra = TypeVar("_SendT_nd_contra", contravariant=True) +_ReturnT_nd_co = TypeVar("_ReturnT_nd_co", covariant=True) -class Coroutine(Awaitable[_ReturnT_co_nd], Generic[_YieldT_co, _SendT_contra_nd, _ReturnT_co_nd]): +class Coroutine(Awaitable[_ReturnT_nd_co], Generic[_YieldT_co, _SendT_nd_contra, _ReturnT_nd_co]): __name__: str __qualname__: str - @property - def cr_await(self) -> Any | None: ... - @property - def cr_code(self) -> CodeType: ... - @property - def cr_frame(self) -> FrameType | None: ... - @property - def cr_running(self) -> bool: ... + @abstractmethod - def send(self, value: _SendT_contra_nd, /) -> _YieldT_co: ... + def send(self, value: _SendT_nd_contra, /) -> _YieldT_co: ... @overload @abstractmethod def throw( @@ -520,11 +579,12 @@ class Coroutine(Awaitable[_ReturnT_co_nd], Generic[_YieldT_co, _SendT_contra_nd, # NOTE: This type does not exist in typing.py or PEP 484 but mypy needs it to exist. # The parameters correspond to Generator, but the 4th is the original type. +# Obsolete, use _typeshed._type_checker_internals.AwaitableGenerator instead. @type_check_only class AwaitableGenerator( - Awaitable[_ReturnT_co_nd], - Generator[_YieldT_co, _SendT_contra_nd, _ReturnT_co_nd], - Generic[_YieldT_co, _SendT_contra_nd, _ReturnT_co_nd, _S], + Awaitable[_ReturnT_nd_co], + Generator[_YieldT_co, _SendT_nd_contra, _ReturnT_nd_co], + Generic[_YieldT_co, _SendT_nd_contra, _ReturnT_nd_co, _S], metaclass=ABCMeta, ): ... @@ -539,7 +599,8 @@ class AsyncIterator(AsyncIterable[_T_co], Protocol[_T_co]): def __anext__(self) -> Awaitable[_T_co]: ... def __aiter__(self) -> AsyncIterator[_T_co]: ... -class AsyncGenerator(AsyncIterator[_YieldT_co], Generic[_YieldT_co, _SendT_contra]): +@runtime_checkable +class AsyncGenerator(AsyncIterator[_YieldT_co], Protocol[_YieldT_co, _SendT_contra]): def __anext__(self) -> Coroutine[Any, Any, _YieldT_co]: ... @abstractmethod def asend(self, value: _SendT_contra, /) -> Coroutine[Any, Any, _YieldT_co]: ... @@ -554,14 +615,6 @@ class AsyncGenerator(AsyncIterator[_YieldT_co], Generic[_YieldT_co, _SendT_contr self, typ: BaseException, val: None = None, tb: TracebackType | None = None, / ) -> Coroutine[Any, Any, _YieldT_co]: ... def aclose(self) -> Coroutine[Any, Any, None]: ... - @property - def ag_await(self) -> Any: ... - @property - def ag_code(self) -> CodeType: ... - @property - def ag_frame(self) -> FrameType: ... - @property - def ag_running(self) -> bool: ... @runtime_checkable class Container(Protocol[_T_co]): @@ -575,7 +628,7 @@ class Collection(Iterable[_T_co], Container[_T_co], Protocol[_T_co]): @abstractmethod def __len__(self) -> int: ... -class Sequence(Collection[_T_co], Reversible[_T_co]): +class Sequence(Reversible[_T_co], Collection[_T_co]): @overload @abstractmethod def __getitem__(self, index: int) -> _T_co: ... @@ -659,7 +712,6 @@ class ItemsView(MappingView, AbstractSet[tuple[_KT_co, _VT_co]], Generic[_KT_co, def __rand__(self, other: Iterable[_T]) -> set[_T]: ... def __contains__(self, item: object) -> bool: ... def __iter__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... - def __reversed__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ... def __or__(self, other: Iterable[_T]) -> set[tuple[_KT_co, _VT_co] | _T]: ... def __ror__(self, other: Iterable[_T]) -> set[tuple[_KT_co, _VT_co] | _T]: ... def __sub__(self, other: Iterable[Any]) -> set[tuple[_KT_co, _VT_co]]: ... @@ -673,7 +725,6 @@ class KeysView(MappingView, AbstractSet[_KT_co]): def __rand__(self, other: Iterable[_T]) -> set[_T]: ... def __contains__(self, key: object) -> bool: ... def __iter__(self) -> Iterator[_KT_co]: ... - def __reversed__(self) -> Iterator[_KT_co]: ... def __or__(self, other: Iterable[_T]) -> set[_KT_co | _T]: ... def __ror__(self, other: Iterable[_T]) -> set[_KT_co | _T]: ... def __sub__(self, other: Iterable[Any]) -> set[_KT_co]: ... @@ -685,7 +736,6 @@ class ValuesView(MappingView, Collection[_VT_co]): def __init__(self, mapping: Mapping[Any, _VT_co]) -> None: ... # undocumented def __contains__(self, value: object) -> bool: ... def __iter__(self) -> Iterator[_VT_co]: ... - def __reversed__(self) -> Iterator[_VT_co]: ... class Mapping(Collection[_KT], Generic[_KT, _VT_co]): # TODO: We wish the key type could also be covariant, but that doesn't work, @@ -755,12 +805,12 @@ class MutableMapping(Mapping[_KT, _VT]): Text = str -TYPE_CHECKING: bool +TYPE_CHECKING: Final[bool] # In stubs, the arguments of the IO class are marked as positional-only. # This differs from runtime, but better reflects the fact that in reality # classes deriving from IO use different names for the arguments. -class IO(Iterator[AnyStr]): +class IO(Generic[AnyStr]): # At runtime these are all abstract properties, # but making them abstract in the stub is hugely disruptive, for not much gain. # See #8726 @@ -857,20 +907,25 @@ _get_type_hints_obj_allowed_types: typing_extensions.TypeAlias = ( # noqa: Y042 | MethodDescriptorType ) -if sys.version_info >= (3, 9): +if sys.version_info >= (3, 14): def get_type_hints( obj: _get_type_hints_obj_allowed_types, globalns: dict[str, Any] | None = None, localns: Mapping[str, Any] | None = None, include_extras: bool = False, - ) -> dict[str, Any]: ... + *, + format: Format | None = None, + ) -> dict[str, Any]: ... # AnnotationForm else: def get_type_hints( - obj: _get_type_hints_obj_allowed_types, globalns: dict[str, Any] | None = None, localns: Mapping[str, Any] | None = None - ) -> dict[str, Any]: ... + obj: _get_type_hints_obj_allowed_types, + globalns: dict[str, Any] | None = None, + localns: Mapping[str, Any] | None = None, + include_extras: bool = False, + ) -> dict[str, Any]: ... # AnnotationForm -def get_args(tp: Any) -> tuple[Any, ...]: ... +def get_args(tp: Any) -> tuple[Any, ...]: ... # AnnotationForm if sys.version_info >= (3, 10): @overload @@ -878,15 +933,10 @@ if sys.version_info >= (3, 10): @overload def get_origin(tp: UnionType) -> type[UnionType]: ... -if sys.version_info >= (3, 9): - @overload - def get_origin(tp: GenericAlias) -> type: ... - @overload - def get_origin(tp: Any) -> Any | None: ... - -else: - def get_origin(tp: Any) -> Any | None: ... - +@overload +def get_origin(tp: GenericAlias) -> type: ... +@overload +def get_origin(tp: Any) -> Any | None: ... # AnnotationForm @overload def cast(typ: type[_T], val: Any) -> _T: ... @overload @@ -897,7 +947,7 @@ def cast(typ: object, val: Any) -> Any: ... if sys.version_info >= (3, 11): def reveal_type(obj: _T, /) -> _T: ... def assert_never(arg: Never, /) -> Never: ... - def assert_type(val: _T, typ: Any, /) -> _T: ... + def assert_type(val: _T, typ: Any, /) -> _T: ... # AnnotationForm def clear_overloads() -> None: ... def get_overloads(func: Callable[..., object]) -> Sequence[Callable[..., object]]: ... def dataclass_transform( @@ -912,9 +962,8 @@ if sys.version_info >= (3, 11): # Type constructors +# Obsolete, will be changed to a function. Use _typeshed._type_checker_internals.NamedTupleFallback instead. class NamedTuple(tuple[Any, ...]): - if sys.version_info < (3, 9): - _field_types: ClassVar[dict[str, type]] _field_defaults: ClassVar[dict[str, Any]] _fields: ClassVar[tuple[str, ...]] # __orig_bases__ sometimes exists on <3.12, but not consistently @@ -938,16 +987,19 @@ class NamedTuple(tuple[Any, ...]): # Internal mypy fallback type for all typed dicts (does not exist at runtime) # N.B. Keep this mostly in sync with typing_extensions._TypedDict/mypy_extensions._TypedDict +# Obsolete, use _typeshed._type_checker_internals.TypedDictFallback instead. @type_check_only class _TypedDict(Mapping[str, object], metaclass=ABCMeta): __total__: ClassVar[bool] - if sys.version_info >= (3, 9): - __required_keys__: ClassVar[frozenset[str]] - __optional_keys__: ClassVar[frozenset[str]] + __required_keys__: ClassVar[frozenset[str]] + __optional_keys__: ClassVar[frozenset[str]] # __orig_bases__ sometimes exists on <3.12, but not consistently, # so we only add it to the stub on 3.12+ if sys.version_info >= (3, 12): __orig_bases__: ClassVar[tuple[Any, ...]] + if sys.version_info >= (3, 13): + __readonly_keys__: ClassVar[frozenset[str]] + __mutable_keys__: ClassVar[frozenset[str]] def copy(self) -> typing_extensions.Self: ... # Using Never so that only calls using mypy plugin hook that specialize the signature @@ -955,78 +1007,86 @@ class _TypedDict(Mapping[str, object], metaclass=ABCMeta): def setdefault(self, k: _Never, default: object) -> object: ... # Mypy plugin hook for 'pop' expects that 'default' has a type variable type. def pop(self, k: _Never, default: _T = ...) -> object: ... # pyright: ignore[reportInvalidTypeVarUse] - def update(self: _T, m: _T, /) -> None: ... + def update(self, m: typing_extensions.Self, /) -> None: ... def __delitem__(self, k: _Never) -> None: ... def items(self) -> dict_items[str, object]: ... def keys(self) -> dict_keys[str, object]: ... def values(self) -> dict_values[str, object]: ... - if sys.version_info >= (3, 9): - @overload - def __or__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... - @overload - def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... - @overload - def __ror__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... - @overload - def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... - # supposedly incompatible definitions of __or__ and __ior__ - def __ior__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... # type: ignore[misc] + @overload + def __or__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... + @overload + def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... + @overload + def __ror__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... + @overload + def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... + # supposedly incompatible definitions of __or__ and __ior__ + def __ior__(self, value: typing_extensions.Self, /) -> typing_extensions.Self: ... # type: ignore[misc] + +if sys.version_info >= (3, 14): + from annotationlib import ForwardRef as ForwardRef + + def evaluate_forward_ref( + forward_ref: ForwardRef, + *, + owner: object = None, + globals: dict[str, Any] | None = None, + locals: Mapping[str, Any] | None = None, + type_params: tuple[TypeVar, ParamSpec, TypeVarTuple] | None = None, + format: Format | None = None, + ) -> Any: ... # AnnotationForm + +else: + @final + class ForwardRef(_Final): + __forward_arg__: str + __forward_code__: CodeType + __forward_evaluated__: bool + __forward_value__: Any | None # AnnotationForm + __forward_is_argument__: bool + __forward_is_class__: bool + __forward_module__: Any | None -@final -class ForwardRef: - __forward_arg__: str - __forward_code__: CodeType - __forward_evaluated__: bool - __forward_value__: Any | None - __forward_is_argument__: bool - __forward_is_class__: bool - __forward_module__: Any | None - if sys.version_info >= (3, 9): - # The module and is_class arguments were added in later Python 3.9 versions. def __init__(self, arg: str, is_argument: bool = True, module: Any | None = None, *, is_class: bool = False) -> None: ... - else: - def __init__(self, arg: str, is_argument: bool = True) -> None: ... - if sys.version_info >= (3, 13): - @overload - @deprecated( - "Failing to pass a value to the 'type_params' parameter of ForwardRef._evaluate() is deprecated, " - "as it leads to incorrect behaviour when evaluating a stringified annotation " - "that references a PEP 695 type parameter. It will be disallowed in Python 3.15." - ) - def _evaluate( - self, globalns: dict[str, Any] | None, localns: Mapping[str, Any] | None, *, recursive_guard: frozenset[str] - ) -> Any | None: ... - @overload - def _evaluate( - self, - globalns: dict[str, Any] | None, - localns: Mapping[str, Any] | None, - type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...], - *, - recursive_guard: frozenset[str], - ) -> Any | None: ... - elif sys.version_info >= (3, 12): - def _evaluate( - self, - globalns: dict[str, Any] | None, - localns: Mapping[str, Any] | None, - type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] | None = None, - *, - recursive_guard: frozenset[str], - ) -> Any | None: ... - elif sys.version_info >= (3, 9): - def _evaluate( - self, globalns: dict[str, Any] | None, localns: Mapping[str, Any] | None, recursive_guard: frozenset[str] - ) -> Any | None: ... - else: - def _evaluate(self, globalns: dict[str, Any] | None, localns: Mapping[str, Any] | None) -> Any | None: ... + if sys.version_info >= (3, 13): + @overload + @deprecated( + "Failing to pass a value to the 'type_params' parameter of ForwardRef._evaluate() is deprecated, " + "as it leads to incorrect behaviour when evaluating a stringified annotation " + "that references a PEP 695 type parameter. It will be disallowed in Python 3.15." + ) + def _evaluate( + self, globalns: dict[str, Any] | None, localns: Mapping[str, Any] | None, *, recursive_guard: frozenset[str] + ) -> Any | None: ... # AnnotationForm + @overload + def _evaluate( + self, + globalns: dict[str, Any] | None, + localns: Mapping[str, Any] | None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...], + *, + recursive_guard: frozenset[str], + ) -> Any | None: ... # AnnotationForm + elif sys.version_info >= (3, 12): + def _evaluate( + self, + globalns: dict[str, Any] | None, + localns: Mapping[str, Any] | None, + type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] | None = None, + *, + recursive_guard: frozenset[str], + ) -> Any | None: ... # AnnotationForm + else: + def _evaluate( + self, globalns: dict[str, Any] | None, localns: Mapping[str, Any] | None, recursive_guard: frozenset[str] + ) -> Any | None: ... # AnnotationForm - def __eq__(self, other: object) -> bool: ... - def __hash__(self) -> int: ... - if sys.version_info >= (3, 11): - def __or__(self, other: Any) -> _SpecialForm: ... - def __ror__(self, other: Any) -> _SpecialForm: ... + def __eq__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + if sys.version_info >= (3, 11): + def __or__(self, other: Any) -> _SpecialForm: ... + def __ror__(self, other: Any) -> _SpecialForm: ... if sys.version_info >= (3, 10): def is_typeddict(tp: object) -> bool: ... @@ -1037,23 +1097,24 @@ if sys.version_info >= (3, 12): def override(method: _F, /) -> _F: ... @final class TypeAliasType: - def __init__( - self, name: str, value: Any, *, type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = () - ) -> None: ... + def __new__(cls, name: str, value: Any, *, type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = ()) -> Self: ... @property - def __value__(self) -> Any: ... + def __value__(self) -> Any: ... # AnnotationForm @property def __type_params__(self) -> tuple[TypeVar | ParamSpec | TypeVarTuple, ...]: ... @property - def __parameters__(self) -> tuple[Any, ...]: ... + def __parameters__(self) -> tuple[Any, ...]: ... # AnnotationForm @property def __name__(self) -> str: ... # It's writable on types, but not on instances of TypeAliasType. @property def __module__(self) -> str | None: ... # type: ignore[override] - def __getitem__(self, parameters: Any) -> GenericAlias: ... + def __getitem__(self, parameters: Any) -> GenericAlias: ... # AnnotationForm def __or__(self, right: Any) -> _SpecialForm: ... def __ror__(self, left: Any) -> _SpecialForm: ... + if sys.version_info >= (3, 14): + @property + def evaluate_value(self) -> EvaluateFunc: ... if sys.version_info >= (3, 13): def is_protocol(tp: type, /) -> bool: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/typing_extensions.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/typing_extensions.pyi new file mode 100644 index 0000000000000..37f8e8ba6a4b4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/typing_extensions.pyi @@ -0,0 +1,675 @@ +import abc +import enum +import sys +from _collections_abc import dict_items, dict_keys, dict_values +from _typeshed import AnnotationForm, IdentityFunction, Incomplete, Unused +from collections.abc import ( + AsyncGenerator as AsyncGenerator, + AsyncIterable as AsyncIterable, + AsyncIterator as AsyncIterator, + Awaitable as Awaitable, + Collection as Collection, + Container as Container, + Coroutine as Coroutine, + Generator as Generator, + Hashable as Hashable, + ItemsView as ItemsView, + Iterable as Iterable, + Iterator as Iterator, + KeysView as KeysView, + Mapping as Mapping, + MappingView as MappingView, + MutableMapping as MutableMapping, + MutableSequence as MutableSequence, + MutableSet as MutableSet, + Reversible as Reversible, + Sequence as Sequence, + Sized as Sized, + ValuesView as ValuesView, +) +from contextlib import AbstractAsyncContextManager as AsyncContextManager, AbstractContextManager as ContextManager +from re import Match as Match, Pattern as Pattern +from types import GenericAlias, ModuleType +from typing import ( # noqa: Y022,Y037,Y038,Y039,UP035 + IO as IO, + TYPE_CHECKING as TYPE_CHECKING, + AbstractSet as AbstractSet, + Any as Any, + AnyStr as AnyStr, + BinaryIO as BinaryIO, + Callable as Callable, + ChainMap as ChainMap, + ClassVar as ClassVar, + Counter as Counter, + DefaultDict as DefaultDict, + Deque as Deque, + Dict as Dict, + ForwardRef as ForwardRef, + FrozenSet as FrozenSet, + Generic as Generic, + List as List, + NoReturn as NoReturn, + Optional as Optional, + Set as Set, + Text as Text, + TextIO as TextIO, + Tuple as Tuple, + Type as Type, + TypedDict as TypedDict, + TypeVar as _TypeVar, + Union as Union, + _Alias, + cast as cast, + no_type_check as no_type_check, + no_type_check_decorator as no_type_check_decorator, + overload as overload, + type_check_only, +) + +if sys.version_info >= (3, 10): + from types import UnionType + +# Please keep order the same as at runtime. +__all__ = [ + # Super-special typing primitives. + "Any", + "ClassVar", + "Concatenate", + "Final", + "LiteralString", + "ParamSpec", + "ParamSpecArgs", + "ParamSpecKwargs", + "Self", + "Type", + "TypeVar", + "TypeVarTuple", + "Unpack", + # ABCs (from collections.abc). + "Awaitable", + "AsyncIterator", + "AsyncIterable", + "Coroutine", + "AsyncGenerator", + "AsyncContextManager", + "Buffer", + "ChainMap", + # Concrete collection types. + "ContextManager", + "Counter", + "Deque", + "DefaultDict", + "NamedTuple", + "OrderedDict", + "TypedDict", + # Structural checks, a.k.a. protocols. + "SupportsAbs", + "SupportsBytes", + "SupportsComplex", + "SupportsFloat", + "SupportsIndex", + "SupportsInt", + "SupportsRound", + # One-off things. + "Annotated", + "assert_never", + "assert_type", + "clear_overloads", + "dataclass_transform", + "deprecated", + "Doc", + "evaluate_forward_ref", + "get_overloads", + "final", + "Format", + "get_annotations", + "get_args", + "get_origin", + "get_original_bases", + "get_protocol_members", + "get_type_hints", + "IntVar", + "is_protocol", + "is_typeddict", + "Literal", + "NewType", + "overload", + "override", + "Protocol", + "reveal_type", + "runtime", + "runtime_checkable", + "Text", + "TypeAlias", + "TypeAliasType", + "TypeForm", + "TypeGuard", + "TypeIs", + "TYPE_CHECKING", + "Never", + "NoReturn", + "ReadOnly", + "Required", + "NotRequired", + "NoDefault", + "NoExtraItems", + # Pure aliases, have always been in typing + "AbstractSet", + "AnyStr", + "BinaryIO", + "Callable", + "Collection", + "Container", + "Dict", + "ForwardRef", + "FrozenSet", + "Generator", + "Generic", + "Hashable", + "IO", + "ItemsView", + "Iterable", + "Iterator", + "KeysView", + "List", + "Mapping", + "MappingView", + "Match", + "MutableMapping", + "MutableSequence", + "MutableSet", + "Optional", + "Pattern", + "Reversible", + "Sequence", + "Set", + "Sized", + "TextIO", + "Tuple", + "Union", + "ValuesView", + "cast", + "no_type_check", + "no_type_check_decorator", + # Added dynamically + "CapsuleType", +] + +_T = _TypeVar("_T") +_F = _TypeVar("_F", bound=Callable[..., Any]) +_TC = _TypeVar("_TC", bound=type[object]) +_T_co = _TypeVar("_T_co", covariant=True) # Any type covariant containers. + +class _Final: ... # This should be imported from typing but that breaks pytype + +# unfortunately we have to duplicate this class definition from typing.pyi or we break pytype +class _SpecialForm(_Final): + def __getitem__(self, parameters: Any) -> object: ... + if sys.version_info >= (3, 10): + def __or__(self, other: Any) -> _SpecialForm: ... + def __ror__(self, other: Any) -> _SpecialForm: ... + +# Do not import (and re-export) Protocol or runtime_checkable from +# typing module because type checkers need to be able to distinguish +# typing.Protocol and typing_extensions.Protocol so they can properly +# warn users about potential runtime exceptions when using typing.Protocol +# on older versions of Python. +Protocol: _SpecialForm + +def runtime_checkable(cls: _TC) -> _TC: ... + +# This alias for above is kept here for backwards compatibility. +runtime = runtime_checkable +Final: _SpecialForm + +def final(f: _F) -> _F: ... + +Literal: _SpecialForm + +def IntVar(name: str) -> Any: ... # returns a new TypeVar + +# Internal mypy fallback type for all typed dicts (does not exist at runtime) +# N.B. Keep this mostly in sync with typing._TypedDict/mypy_extensions._TypedDict +@type_check_only +class _TypedDict(Mapping[str, object], metaclass=abc.ABCMeta): + __required_keys__: ClassVar[frozenset[str]] + __optional_keys__: ClassVar[frozenset[str]] + __total__: ClassVar[bool] + __orig_bases__: ClassVar[tuple[Any, ...]] + # PEP 705 + __readonly_keys__: ClassVar[frozenset[str]] + __mutable_keys__: ClassVar[frozenset[str]] + # PEP 728 + __closed__: ClassVar[bool] + __extra_items__: ClassVar[AnnotationForm] + def copy(self) -> Self: ... + # Using Never so that only calls using mypy plugin hook that specialize the signature + # can go through. + def setdefault(self, k: Never, default: object) -> object: ... + # Mypy plugin hook for 'pop' expects that 'default' has a type variable type. + def pop(self, k: Never, default: _T = ...) -> object: ... # pyright: ignore[reportInvalidTypeVarUse] + def update(self, m: Self, /) -> None: ... + def items(self) -> dict_items[str, object]: ... + def keys(self) -> dict_keys[str, object]: ... + def values(self) -> dict_values[str, object]: ... + def __delitem__(self, k: Never) -> None: ... + @overload + def __or__(self, value: Self, /) -> Self: ... + @overload + def __or__(self, value: dict[str, Any], /) -> dict[str, object]: ... + @overload + def __ror__(self, value: Self, /) -> Self: ... + @overload + def __ror__(self, value: dict[str, Any], /) -> dict[str, object]: ... + # supposedly incompatible definitions of `__ior__` and `__or__`: + # Since this module defines "Self" it is not recognized by Ruff as typing_extensions.Self + def __ior__(self, value: Self, /) -> Self: ... # type: ignore[misc] + +OrderedDict = _Alias() + +if sys.version_info >= (3, 13): + from typing import get_type_hints as get_type_hints +else: + def get_type_hints( + obj: Any, globalns: dict[str, Any] | None = None, localns: Mapping[str, Any] | None = None, include_extras: bool = False + ) -> dict[str, AnnotationForm]: ... + +def get_args(tp: AnnotationForm) -> tuple[AnnotationForm, ...]: ... + +if sys.version_info >= (3, 10): + @overload + def get_origin(tp: UnionType) -> type[UnionType]: ... + +@overload +def get_origin(tp: GenericAlias) -> type: ... +@overload +def get_origin(tp: ParamSpecArgs | ParamSpecKwargs) -> ParamSpec: ... +@overload +def get_origin(tp: AnnotationForm) -> AnnotationForm | None: ... + +Annotated: _SpecialForm +_AnnotatedAlias: Any # undocumented + +# New and changed things in 3.10 +if sys.version_info >= (3, 10): + from typing import ( + Concatenate as Concatenate, + ParamSpecArgs as ParamSpecArgs, + ParamSpecKwargs as ParamSpecKwargs, + TypeAlias as TypeAlias, + TypeGuard as TypeGuard, + is_typeddict as is_typeddict, + ) +else: + @final + class ParamSpecArgs: + @property + def __origin__(self) -> ParamSpec: ... + def __init__(self, origin: ParamSpec) -> None: ... + + @final + class ParamSpecKwargs: + @property + def __origin__(self) -> ParamSpec: ... + def __init__(self, origin: ParamSpec) -> None: ... + + Concatenate: _SpecialForm + TypeAlias: _SpecialForm + TypeGuard: _SpecialForm + def is_typeddict(tp: object) -> bool: ... + +# New and changed things in 3.11 +if sys.version_info >= (3, 11): + from typing import ( + LiteralString as LiteralString, + NamedTuple as NamedTuple, + Never as Never, + NewType as NewType, + NotRequired as NotRequired, + Required as Required, + Self as Self, + Unpack as Unpack, + assert_never as assert_never, + assert_type as assert_type, + clear_overloads as clear_overloads, + dataclass_transform as dataclass_transform, + get_overloads as get_overloads, + reveal_type as reveal_type, + ) +else: + Self: _SpecialForm + Never: _SpecialForm + def reveal_type(obj: _T, /) -> _T: ... + def assert_never(arg: Never, /) -> Never: ... + def assert_type(val: _T, typ: AnnotationForm, /) -> _T: ... + def clear_overloads() -> None: ... + def get_overloads(func: Callable[..., object]) -> Sequence[Callable[..., object]]: ... + + Required: _SpecialForm + NotRequired: _SpecialForm + LiteralString: _SpecialForm + Unpack: _SpecialForm + + def dataclass_transform( + *, + eq_default: bool = True, + order_default: bool = False, + kw_only_default: bool = False, + frozen_default: bool = False, + field_specifiers: tuple[type[Any] | Callable[..., Any], ...] = (), + **kwargs: object, + ) -> IdentityFunction: ... + + class NamedTuple(tuple[Any, ...]): + _field_defaults: ClassVar[dict[str, Any]] + _fields: ClassVar[tuple[str, ...]] + __orig_bases__: ClassVar[tuple[Any, ...]] + @overload + def __init__(self, typename: str, fields: Iterable[tuple[str, Any]] = ...) -> None: ... + @overload + def __init__(self, typename: str, fields: None = None, **kwargs: Any) -> None: ... + @classmethod + def _make(cls, iterable: Iterable[Any]) -> Self: ... + def _asdict(self) -> dict[str, Any]: ... + def _replace(self, **kwargs: Any) -> Self: ... + + class NewType: + def __init__(self, name: str, tp: AnnotationForm) -> None: ... + def __call__(self, obj: _T, /) -> _T: ... + __supertype__: type | NewType + if sys.version_info >= (3, 10): + def __or__(self, other: Any) -> _SpecialForm: ... + def __ror__(self, other: Any) -> _SpecialForm: ... + +if sys.version_info >= (3, 12): + from collections.abc import Buffer as Buffer + from types import get_original_bases as get_original_bases + from typing import ( + SupportsAbs as SupportsAbs, + SupportsBytes as SupportsBytes, + SupportsComplex as SupportsComplex, + SupportsFloat as SupportsFloat, + SupportsIndex as SupportsIndex, + SupportsInt as SupportsInt, + SupportsRound as SupportsRound, + override as override, + ) +else: + def override(arg: _F, /) -> _F: ... + def get_original_bases(cls: type, /) -> tuple[Any, ...]: ... + + # mypy and pyright object to this being both ABC and Protocol. + # At runtime it inherits from ABC and is not a Protocol, but it is on the + # allowlist for use as a Protocol. + @runtime_checkable + class Buffer(Protocol, abc.ABC): # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + # Not actually a Protocol at runtime; see + # https://github.com/python/typeshed/issues/10224 for why we're defining it this way + def __buffer__(self, flags: int, /) -> memoryview: ... + + @runtime_checkable + class SupportsInt(Protocol, metaclass=abc.ABCMeta): + @abc.abstractmethod + def __int__(self) -> int: ... + + @runtime_checkable + class SupportsFloat(Protocol, metaclass=abc.ABCMeta): + @abc.abstractmethod + def __float__(self) -> float: ... + + @runtime_checkable + class SupportsComplex(Protocol, metaclass=abc.ABCMeta): + @abc.abstractmethod + def __complex__(self) -> complex: ... + + @runtime_checkable + class SupportsBytes(Protocol, metaclass=abc.ABCMeta): + @abc.abstractmethod + def __bytes__(self) -> bytes: ... + + @runtime_checkable + class SupportsIndex(Protocol, metaclass=abc.ABCMeta): + @abc.abstractmethod + def __index__(self) -> int: ... + + @runtime_checkable + class SupportsAbs(Protocol[_T_co]): + @abc.abstractmethod + def __abs__(self) -> _T_co: ... + + @runtime_checkable + class SupportsRound(Protocol[_T_co]): + @overload + @abc.abstractmethod + def __round__(self) -> int: ... + @overload + @abc.abstractmethod + def __round__(self, ndigits: int, /) -> _T_co: ... + +if sys.version_info >= (3, 13): + from types import CapsuleType as CapsuleType + from typing import ( + NoDefault as NoDefault, + ParamSpec as ParamSpec, + ReadOnly as ReadOnly, + TypeIs as TypeIs, + TypeVar as TypeVar, + TypeVarTuple as TypeVarTuple, + get_protocol_members as get_protocol_members, + is_protocol as is_protocol, + ) + from warnings import deprecated as deprecated +else: + def is_protocol(tp: type, /) -> bool: ... + def get_protocol_members(tp: type, /) -> frozenset[str]: ... + @final + class _NoDefaultType: ... + + NoDefault: _NoDefaultType + @final + class CapsuleType: ... + + class deprecated: + message: LiteralString + category: type[Warning] | None + stacklevel: int + def __init__(self, message: LiteralString, /, *, category: type[Warning] | None = ..., stacklevel: int = 1) -> None: ... + def __call__(self, arg: _T, /) -> _T: ... + + @final + class TypeVar: + @property + def __name__(self) -> str: ... + @property + def __bound__(self) -> AnnotationForm | None: ... + @property + def __constraints__(self) -> tuple[AnnotationForm, ...]: ... + @property + def __covariant__(self) -> bool: ... + @property + def __contravariant__(self) -> bool: ... + @property + def __infer_variance__(self) -> bool: ... + @property + def __default__(self) -> AnnotationForm: ... + def __init__( + self, + name: str, + *constraints: AnnotationForm, + bound: AnnotationForm | None = None, + covariant: bool = False, + contravariant: bool = False, + default: AnnotationForm = ..., + infer_variance: bool = False, + ) -> None: ... + def has_default(self) -> bool: ... + def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... + if sys.version_info >= (3, 10): + def __or__(self, right: Any) -> _SpecialForm: ... + def __ror__(self, left: Any) -> _SpecialForm: ... + if sys.version_info >= (3, 11): + def __typing_subst__(self, arg: Any) -> Any: ... + + @final + class ParamSpec: + @property + def __name__(self) -> str: ... + @property + def __bound__(self) -> AnnotationForm | None: ... + @property + def __covariant__(self) -> bool: ... + @property + def __contravariant__(self) -> bool: ... + @property + def __infer_variance__(self) -> bool: ... + @property + def __default__(self) -> AnnotationForm: ... + def __init__( + self, + name: str, + *, + bound: None | AnnotationForm | str = None, + contravariant: bool = False, + covariant: bool = False, + default: AnnotationForm = ..., + ) -> None: ... + @property + def args(self) -> ParamSpecArgs: ... + @property + def kwargs(self) -> ParamSpecKwargs: ... + def has_default(self) -> bool: ... + def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... + if sys.version_info >= (3, 10): + def __or__(self, right: Any) -> _SpecialForm: ... + def __ror__(self, left: Any) -> _SpecialForm: ... + + @final + class TypeVarTuple: + @property + def __name__(self) -> str: ... + @property + def __default__(self) -> AnnotationForm: ... + def __init__(self, name: str, *, default: AnnotationForm = ...) -> None: ... + def __iter__(self) -> Any: ... # Unpack[Self] + def has_default(self) -> bool: ... + def __typing_prepare_subst__(self, alias: Any, args: Any) -> tuple[Any, ...]: ... + + ReadOnly: _SpecialForm + TypeIs: _SpecialForm + +# TypeAliasType was added in Python 3.12, but had significant changes in 3.14. +if sys.version_info >= (3, 14): + from typing import TypeAliasType as TypeAliasType +else: + @final + class TypeAliasType: + def __init__( + self, name: str, value: AnnotationForm, *, type_params: tuple[TypeVar | ParamSpec | TypeVarTuple, ...] = () + ) -> None: ... + @property + def __value__(self) -> AnnotationForm: ... + @property + def __type_params__(self) -> tuple[TypeVar | ParamSpec | TypeVarTuple, ...]: ... + @property + # `__parameters__` can include special forms if a `TypeVarTuple` was + # passed as a `type_params` element to the constructor method. + def __parameters__(self) -> tuple[TypeVar | ParamSpec | AnnotationForm, ...]: ... + @property + def __name__(self) -> str: ... + # It's writable on types, but not on instances of TypeAliasType. + @property + def __module__(self) -> str | None: ... # type: ignore[override] + # Returns typing._GenericAlias, which isn't stubbed. + def __getitem__(self, parameters: Incomplete | tuple[Incomplete, ...]) -> AnnotationForm: ... + def __init_subclass__(cls, *args: Unused, **kwargs: Unused) -> NoReturn: ... + if sys.version_info >= (3, 10): + def __or__(self, right: Any) -> _SpecialForm: ... + def __ror__(self, left: Any) -> _SpecialForm: ... + +# PEP 727 +class Doc: + documentation: str + def __init__(self, documentation: str, /) -> None: ... + def __hash__(self) -> int: ... + def __eq__(self, other: object) -> bool: ... + +# PEP 728 +class _NoExtraItemsType: ... + +NoExtraItems: _NoExtraItemsType + +# PEP 747 +TypeForm: _SpecialForm + +# PEP 649/749 +if sys.version_info >= (3, 14): + from typing import evaluate_forward_ref as evaluate_forward_ref + + from annotationlib import Format as Format, get_annotations as get_annotations +else: + class Format(enum.IntEnum): + VALUE = 1 + VALUE_WITH_FAKE_GLOBALS = 2 + FORWARDREF = 3 + STRING = 4 + + @overload + def get_annotations( + obj: Any, # any object with __annotations__ or __annotate__ + *, + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + eval_str: bool = False, + format: Literal[Format.STRING], + ) -> dict[str, str]: ... + @overload + def get_annotations( + obj: Any, # any object with __annotations__ or __annotate__ + *, + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + eval_str: bool = False, + format: Literal[Format.FORWARDREF], + ) -> dict[str, AnnotationForm | ForwardRef]: ... + @overload + def get_annotations( + obj: Any, # any object with __annotations__ or __annotate__ + *, + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + eval_str: bool = False, + format: Format = Format.VALUE, # noqa: Y011 + ) -> dict[str, AnnotationForm]: ... + @overload + def evaluate_forward_ref( + forward_ref: ForwardRef, + *, + owner: Callable[..., object] | type[object] | ModuleType | None = None, # any callable, class, or module + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + type_params: Iterable[TypeVar | ParamSpec | TypeVarTuple] | None = None, + format: Literal[Format.STRING], + _recursive_guard: Container[str] = ..., + ) -> str: ... + @overload + def evaluate_forward_ref( + forward_ref: ForwardRef, + *, + owner: Callable[..., object] | type[object] | ModuleType | None = None, # any callable, class, or module + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + type_params: Iterable[TypeVar | ParamSpec | TypeVarTuple] | None = None, + format: Literal[Format.FORWARDREF], + _recursive_guard: Container[str] = ..., + ) -> AnnotationForm | ForwardRef: ... + @overload + def evaluate_forward_ref( + forward_ref: ForwardRef, + *, + owner: Callable[..., object] | type[object] | ModuleType | None = None, # any callable, class, or module + globals: Mapping[str, Any] | None = None, # value types depend on the key + locals: Mapping[str, Any] | None = None, # value types depend on the key + type_params: Iterable[TypeVar | ParamSpec | TypeVarTuple] | None = None, + format: Format = Format.VALUE, # noqa: Y011 + _recursive_guard: Container[str] = ..., + ) -> AnnotationForm: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unicodedata.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unicodedata.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unicodedata.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unicodedata.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/_log.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/_log.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/_log.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/_log.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi index 565dd91c0fda8..0b3fb9122c7b9 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/async_case.pyi @@ -21,5 +21,5 @@ class IsolatedAsyncioTestCase(TestCase): def addAsyncCleanup(self, func: Callable[_P, Awaitable[object]], /, *args: _P.args, **kwargs: _P.kwargs) -> None: ... if sys.version_info >= (3, 11): async def enterAsyncContext(self, cm: AbstractAsyncContextManager[_T]) -> _T: ... - if sys.version_info >= (3, 9): - def __del__(self) -> None: ... + + def __del__(self) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/case.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/case.pyi similarity index 90% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/case.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/case.pyi index a92f03f9745fe..89bcabf104c25 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/case.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/case.pyi @@ -5,27 +5,12 @@ from _typeshed import SupportsDunderGE, SupportsDunderGT, SupportsDunderLE, Supp from collections.abc import Callable, Container, Iterable, Mapping, Sequence, Set as AbstractSet from contextlib import AbstractContextManager from re import Pattern -from types import TracebackType -from typing import ( - Any, - AnyStr, - ClassVar, - Final, - Generic, - NamedTuple, - NoReturn, - Protocol, - SupportsAbs, - SupportsRound, - TypeVar, - overload, -) -from typing_extensions import ParamSpec, Self, TypeAlias +from types import GenericAlias, TracebackType +from typing import Any, AnyStr, Final, Generic, NoReturn, Protocol, SupportsAbs, SupportsRound, TypeVar, overload +from typing_extensions import Never, ParamSpec, Self, TypeAlias +from unittest._log import _AssertLogsContext, _LoggingWatcher from warnings import WarningMessage -if sys.version_info >= (3, 9): - from types import GenericAlias - if sys.version_info >= (3, 10): from types import UnionType @@ -33,6 +18,7 @@ _T = TypeVar("_T") _S = TypeVar("_S", bound=SupportsSub[Any, Any]) _E = TypeVar("_E", bound=BaseException) _FT = TypeVar("_FT", bound=Callable[..., Any]) +_SB = TypeVar("_SB", str, bytes, bytearray) _P = ParamSpec("_P") DIFF_OMITTED: Final[str] @@ -58,29 +44,6 @@ class _AssertRaisesBaseContext(_BaseTestCaseContext): # but it's not possible to construct an overload which expresses that def handle(self, name: str, args: list[Any], kwargs: dict[str, Any]) -> Any: ... -if sys.version_info >= (3, 9): - from unittest._log import _AssertLogsContext, _LoggingWatcher -else: - # Unused dummy for _AssertLogsContext. Starting with Python 3.10, - # this is generic over the logging watcher, but in lower versions - # the watcher is hard-coded. - _L = TypeVar("_L") - - class _LoggingWatcher(NamedTuple): - records: list[logging.LogRecord] - output: list[str] - - class _AssertLogsContext(_BaseTestCaseContext, Generic[_L]): - LOGGING_FORMAT: ClassVar[str] - logger_name: str - level: int - msg: None - def __init__(self, test_case: TestCase, logger_name: str, level: int) -> None: ... - def __enter__(self) -> _LoggingWatcher: ... - def __exit__( - self, exc_type: type[BaseException] | None, exc_value: BaseException | None, tb: TracebackType | None - ) -> bool | None: ... - def addModuleCleanup(function: Callable[_P, object], /, *args: _P.args, **kwargs: _P.kwargs) -> None: ... def doModuleCleanups() -> None: ... @@ -323,6 +286,20 @@ class TestCase: self, subset: Mapping[Any, Any], dictionary: Mapping[Any, Any], msg: object = None ) -> None: ... + if sys.version_info >= (3, 10): + # Runtime has *args, **kwargs, but will error if any are supplied + def __init_subclass__(cls, *args: Never, **kwargs: Never) -> None: ... + + if sys.version_info >= (3, 14): + def assertIsSubclass(self, cls: type, superclass: type | tuple[type, ...], msg: Any = None) -> None: ... + def assertNotIsSubclass(self, cls: type, superclass: type | tuple[type, ...], msg: Any = None) -> None: ... + def assertHasAttr(self, obj: object, name: str, msg: Any = None) -> None: ... + def assertNotHasAttr(self, obj: object, name: str, msg: Any = None) -> None: ... + def assertStartsWith(self, s: _SB, prefix: _SB | tuple[_SB, ...], msg: Any = None) -> None: ... + def assertNotStartsWith(self, s: _SB, prefix: _SB | tuple[_SB, ...], msg: Any = None) -> None: ... + def assertEndsWith(self, s: _SB, suffix: _SB | tuple[_SB, ...], msg: Any = None) -> None: ... + def assertNotEndsWith(self, s: _SB, suffix: _SB | tuple[_SB, ...], msg: Any = None) -> None: ... + class FunctionTestCase(TestCase): def __init__( self, @@ -341,8 +318,7 @@ class _AssertRaisesContext(_AssertRaisesBaseContext, Generic[_E]): def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, tb: TracebackType | None ) -> bool: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class _AssertWarnsContext(_AssertRaisesBaseContext): warning: WarningMessage diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/loader.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/loader.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/loader.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/loader.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/main.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/main.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/main.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/main.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/mock.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/mock.pyi similarity index 97% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/mock.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/mock.pyi index 193a4123c395a..9e353900f2d7f 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/mock.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/mock.pyi @@ -1,8 +1,9 @@ import sys +from _typeshed import MaybeNone from collections.abc import Awaitable, Callable, Coroutine, Iterable, Mapping, Sequence from contextlib import _GeneratorContextManager from types import TracebackType -from typing import Any, Final, Generic, Literal, TypeVar, overload +from typing import Any, ClassVar, Final, Generic, Literal, TypeVar, overload from typing_extensions import ParamSpec, Self, TypeAlias _T = TypeVar("_T") @@ -51,9 +52,6 @@ else: "seal", ) -if sys.version_info < (3, 9): - __version__: Final[str] - FILTER_DIR: Any class _SentinelObject: @@ -72,19 +70,17 @@ _CallValue: TypeAlias = str | tuple[Any, ...] | Mapping[str, Any] | _ArgsKwargs class _Call(tuple[Any, ...]): def __new__( - cls, value: _CallValue = (), name: str | None = "", parent: Any | None = None, two: bool = False, from_kall: bool = True + cls, value: _CallValue = (), name: str | None = "", parent: _Call | None = None, two: bool = False, from_kall: bool = True ) -> Self: ... - name: Any - parent: Any - from_kall: Any def __init__( self, value: _CallValue = (), name: str | None = None, - parent: Any | None = None, + parent: _Call | None = None, two: bool = False, from_kall: bool = True, ) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] def __eq__(self, other: object) -> bool: ... def __ne__(self, value: object, /) -> bool: ... def __call__(self, *args: Any, **kwargs: Any) -> _Call: ... @@ -164,7 +160,7 @@ class NonCallableMock(Base, Any): side_effect: Any called: bool call_count: int - call_args: Any + call_args: _Call | MaybeNone call_args_list: _CallList mock_calls: _CallList def _format_mock_call_signature(self, args: Any, kwargs: Any) -> str: ... @@ -403,6 +399,7 @@ class MagicProxy(Base): class _ANY: def __eq__(self, other: object) -> Literal[True]: ... def __ne__(self, other: object) -> Literal[False]: ... + __hash__: ClassVar[None] # type: ignore[assignment] ANY: Any diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/result.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/result.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/result.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/result.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/runner.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/runner.pyi similarity index 78% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/runner.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/runner.pyi index 46da85619d301..783764464a53c 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/runner.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/runner.pyi @@ -6,24 +6,29 @@ from _typeshed import SupportsFlush, SupportsWrite from collections.abc import Callable, Iterable from typing import Any, Generic, Protocol, TypeVar from typing_extensions import Never, TypeAlias +from warnings import _ActionKind -_ResultClassType: TypeAlias = Callable[[_TextTestStream, bool, int], TextTestResult] +_ResultClassType: TypeAlias = Callable[[_TextTestStream, bool, int], TextTestResult[Any]] class _SupportsWriteAndFlush(SupportsWrite[str], SupportsFlush, Protocol): ... # All methods used by unittest.runner.TextTestResult's stream class _TextTestStream(_SupportsWriteAndFlush, Protocol): - def writeln(self, arg: str | None = None) -> str: ... + def writeln(self, arg: str | None = None, /) -> None: ... # _WritelnDecorator should have all the same attrs as its stream param. # But that's not feasible to do Generically # We can expand the attributes if requested -class _WritelnDecorator(_TextTestStream): - def __init__(self, stream: _TextTestStream) -> None: ... +class _WritelnDecorator: + def __init__(self, stream: _SupportsWriteAndFlush) -> None: ... + def writeln(self, arg: str | None = None) -> None: ... def __getattr__(self, attr: str) -> Any: ... # Any attribute from the stream type passed to __init__ # These attributes are prevented by __getattr__ stream: Never __getstate__: Never + # Methods proxied from the wrapped stream object via __getattr__ + def flush(self) -> object: ... + def write(self, s: str, /) -> object: ... _StreamT = TypeVar("_StreamT", bound=_TextTestStream, default=_WritelnDecorator) @@ -35,10 +40,8 @@ class TextTestResult(unittest.result.TestResult, Generic[_StreamT]): showAll: bool # undocumented stream: _StreamT # undocumented if sys.version_info >= (3, 12): - durations: unittest.result._DurationsType | None - def __init__( - self, stream: _StreamT, descriptions: bool, verbosity: int, *, durations: unittest.result._DurationsType | None = None - ) -> None: ... + durations: int | None + def __init__(self, stream: _StreamT, descriptions: bool, verbosity: int, *, durations: int | None = None) -> None: ... else: def __init__(self, stream: _StreamT, descriptions: bool, verbosity: int) -> None: ... @@ -52,11 +55,11 @@ class TextTestRunner: verbosity: int failfast: bool buffer: bool - warnings: str | None + warnings: _ActionKind | None tb_locals: bool if sys.version_info >= (3, 12): - durations: unittest.result._DurationsType | None + durations: int | None def __init__( self, stream: _SupportsWriteAndFlush | None = None, @@ -65,10 +68,10 @@ class TextTestRunner: failfast: bool = False, buffer: bool = False, resultclass: _ResultClassType | None = None, - warnings: str | None = None, + warnings: _ActionKind | None = None, *, tb_locals: bool = False, - durations: unittest.result._DurationsType | None = None, + durations: int | None = None, ) -> None: ... else: def __init__( diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/signals.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/signals.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/signals.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/signals.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/suite.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/suite.pyi similarity index 91% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/suite.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/suite.pyi index ff583d0766a03..443396164b6fe 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/suite.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/suite.pyi @@ -1,6 +1,7 @@ import unittest.case import unittest.result from collections.abc import Iterable, Iterator +from typing import ClassVar from typing_extensions import TypeAlias _TestType: TypeAlias = unittest.case.TestCase | TestSuite @@ -17,6 +18,7 @@ class BaseTestSuite: def countTestCases(self) -> int: ... def __iter__(self) -> Iterator[_TestType]: ... def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] class TestSuite(BaseTestSuite): def run(self, result: unittest.result.TestResult, debug: bool = False) -> unittest.result.TestResult: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/unittest/util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/unittest/util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/unittest/util.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/urllib/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/__init__.pyi new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/error.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/error.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/error.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/urllib/error.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/parse.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/parse.pyi similarity index 81% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/parse.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/urllib/parse.pyi index 785bb9678ec7f..a5ed616d25af8 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/parse.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/parse.pyi @@ -1,11 +1,9 @@ import sys -from collections.abc import Callable, Iterable, Mapping, Sequence -from typing import Any, AnyStr, Generic, Literal, NamedTuple, TypeVar, overload +from collections.abc import Iterable, Mapping, Sequence +from types import GenericAlias +from typing import Any, AnyStr, Generic, Literal, NamedTuple, Protocol, overload, type_check_only from typing_extensions import TypeAlias -if sys.version_info >= (3, 9): - from types import GenericAlias - __all__ = [ "urlparse", "urlunparse", @@ -55,8 +53,7 @@ class _NetlocResultMixinBase(Generic[AnyStr]): def hostname(self) -> AnyStr | None: ... @property def port(self) -> int | None: ... - if sys.version_info >= (3, 9): - def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... class _NetlocResultMixinStr(_NetlocResultMixinBase[str], _ResultMixinStr): ... class _NetlocResultMixinBytes(_NetlocResultMixinBase[bytes], _ResultMixinBytes): ... @@ -127,13 +124,7 @@ def quote_from_bytes(bs: bytes | bytearray, safe: str | Iterable[int] = "/") -> def quote_plus(string: str, safe: str | Iterable[int] = "", encoding: str | None = None, errors: str | None = None) -> str: ... @overload def quote_plus(string: bytes | bytearray, safe: str | Iterable[int] = "") -> str: ... - -if sys.version_info >= (3, 9): - def unquote(string: str | bytes, encoding: str = "utf-8", errors: str = "replace") -> str: ... - -else: - def unquote(string: str, encoding: str = "utf-8", errors: str = "replace") -> str: ... - +def unquote(string: str | bytes, encoding: str = "utf-8", errors: str = "replace") -> str: ... def unquote_to_bytes(string: str | bytes | bytearray) -> bytes: ... def unquote_plus(string: str, encoding: str = "utf-8", errors: str = "replace") -> str: ... @overload @@ -141,38 +132,32 @@ def urldefrag(url: str) -> DefragResult: ... @overload def urldefrag(url: bytes | bytearray | None) -> DefragResultBytes: ... -_Q = TypeVar("_Q", bound=str | Iterable[int]) +# The values are passed through `str()` (unless they are bytes), so anything is valid. _QueryType: TypeAlias = ( - Mapping[Any, Any] | Mapping[Any, Sequence[Any]] | Sequence[tuple[Any, Any]] | Sequence[tuple[Any, Sequence[Any]]] + Mapping[str, object] + | Mapping[bytes, object] + | Mapping[str | bytes, object] + | Mapping[str, Sequence[object]] + | Mapping[bytes, Sequence[object]] + | Mapping[str | bytes, Sequence[object]] + | Sequence[tuple[str | bytes, object]] + | Sequence[tuple[str | bytes, Sequence[object]]] ) -@overload -def urlencode( - query: _QueryType, - doseq: bool = False, - safe: str = "", - encoding: str | None = None, - errors: str | None = None, - quote_via: Callable[[AnyStr, str, str, str], str] = ..., -) -> str: ... -@overload -def urlencode( - query: _QueryType, - doseq: bool, - safe: _Q, - encoding: str | None = None, - errors: str | None = None, - quote_via: Callable[[AnyStr, _Q, str, str], str] = ..., -) -> str: ... -@overload +@type_check_only +class _QuoteVia(Protocol): + @overload + def __call__(self, string: str, safe: str | bytes, encoding: str, errors: str, /) -> str: ... + @overload + def __call__(self, string: bytes, safe: str | bytes, /) -> str: ... + def urlencode( query: _QueryType, doseq: bool = False, - *, - safe: _Q, + safe: str | bytes = "", encoding: str | None = None, errors: str | None = None, - quote_via: Callable[[AnyStr, _Q, str, str], str] = ..., + quote_via: _QuoteVia = ..., ) -> str: ... def urljoin(base: AnyStr, url: AnyStr | None, allow_fragments: bool = True) -> AnyStr: ... @overload diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/urllib/request.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/request.pyi new file mode 100644 index 0000000000000..d8fc5e0d8f48d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/request.pyi @@ -0,0 +1,416 @@ +import ssl +import sys +from _typeshed import ReadableBuffer, StrOrBytesPath, SupportsRead +from collections.abc import Callable, Iterable, Mapping, MutableMapping, Sequence +from email.message import Message +from http.client import HTTPConnection, HTTPMessage, HTTPResponse +from http.cookiejar import CookieJar +from re import Pattern +from typing import IO, Any, ClassVar, NoReturn, Protocol, TypeVar, overload +from typing_extensions import TypeAlias, deprecated +from urllib.error import HTTPError as HTTPError +from urllib.response import addclosehook, addinfourl + +__all__ = [ + "Request", + "OpenerDirector", + "BaseHandler", + "HTTPDefaultErrorHandler", + "HTTPRedirectHandler", + "HTTPCookieProcessor", + "ProxyHandler", + "HTTPPasswordMgr", + "HTTPPasswordMgrWithDefaultRealm", + "HTTPPasswordMgrWithPriorAuth", + "AbstractBasicAuthHandler", + "HTTPBasicAuthHandler", + "ProxyBasicAuthHandler", + "AbstractDigestAuthHandler", + "HTTPDigestAuthHandler", + "ProxyDigestAuthHandler", + "HTTPHandler", + "FileHandler", + "FTPHandler", + "CacheFTPHandler", + "DataHandler", + "UnknownHandler", + "HTTPErrorProcessor", + "urlopen", + "install_opener", + "build_opener", + "pathname2url", + "url2pathname", + "getproxies", + "urlretrieve", + "urlcleanup", + "HTTPSHandler", +] +if sys.version_info < (3, 14): + __all__ += ["URLopener", "FancyURLopener"] + +_T = TypeVar("_T") +_UrlopenRet: TypeAlias = Any +_DataType: TypeAlias = ReadableBuffer | SupportsRead[bytes] | Iterable[bytes] | None + +if sys.version_info >= (3, 13): + def urlopen( + url: str | Request, data: _DataType | None = None, timeout: float | None = ..., *, context: ssl.SSLContext | None = None + ) -> _UrlopenRet: ... + +else: + def urlopen( + url: str | Request, + data: _DataType | None = None, + timeout: float | None = ..., + *, + cafile: str | None = None, + capath: str | None = None, + cadefault: bool = False, + context: ssl.SSLContext | None = None, + ) -> _UrlopenRet: ... + +def install_opener(opener: OpenerDirector) -> None: ... +def build_opener(*handlers: BaseHandler | Callable[[], BaseHandler]) -> OpenerDirector: ... + +if sys.version_info >= (3, 14): + def url2pathname(url: str, *, require_scheme: bool = False, resolve_host: bool = False) -> str: ... + def pathname2url(pathname: str, *, add_scheme: bool = False) -> str: ... + +else: + if sys.platform == "win32": + from nturl2path import pathname2url as pathname2url, url2pathname as url2pathname + else: + def url2pathname(pathname: str) -> str: ... + def pathname2url(pathname: str) -> str: ... + +def getproxies() -> dict[str, str]: ... +def getproxies_environment() -> dict[str, str]: ... +def parse_http_list(s: str) -> list[str]: ... +def parse_keqv_list(l: list[str]) -> dict[str, str]: ... + +if sys.platform == "win32" or sys.platform == "darwin": + def proxy_bypass(host: str) -> Any: ... # undocumented + +else: + def proxy_bypass(host: str, proxies: Mapping[str, str] | None = None) -> Any: ... # undocumented + +class Request: + @property + def full_url(self) -> str: ... + @full_url.setter + def full_url(self, value: str) -> None: ... + @full_url.deleter + def full_url(self) -> None: ... + type: str + host: str + origin_req_host: str + selector: str + data: _DataType + headers: MutableMapping[str, str] + unredirected_hdrs: dict[str, str] + unverifiable: bool + method: str | None + timeout: float | None # Undocumented, only set after __init__() by OpenerDirector.open() + def __init__( + self, + url: str, + data: _DataType = None, + headers: MutableMapping[str, str] = {}, + origin_req_host: str | None = None, + unverifiable: bool = False, + method: str | None = None, + ) -> None: ... + def get_method(self) -> str: ... + def add_header(self, key: str, val: str) -> None: ... + def add_unredirected_header(self, key: str, val: str) -> None: ... + def has_header(self, header_name: str) -> bool: ... + def remove_header(self, header_name: str) -> None: ... + def get_full_url(self) -> str: ... + def set_proxy(self, host: str, type: str) -> None: ... + @overload + def get_header(self, header_name: str) -> str | None: ... + @overload + def get_header(self, header_name: str, default: _T) -> str | _T: ... + def header_items(self) -> list[tuple[str, str]]: ... + def has_proxy(self) -> bool: ... + +class OpenerDirector: + addheaders: list[tuple[str, str]] + def add_handler(self, handler: BaseHandler) -> None: ... + def open(self, fullurl: str | Request, data: _DataType = None, timeout: float | None = ...) -> _UrlopenRet: ... + def error(self, proto: str, *args: Any) -> _UrlopenRet: ... + def close(self) -> None: ... + +class BaseHandler: + handler_order: ClassVar[int] + parent: OpenerDirector + def add_parent(self, parent: OpenerDirector) -> None: ... + def close(self) -> None: ... + def __lt__(self, other: object) -> bool: ... + +class HTTPDefaultErrorHandler(BaseHandler): + def http_error_default( + self, req: Request, fp: IO[bytes], code: int, msg: str, hdrs: HTTPMessage + ) -> HTTPError: ... # undocumented + +class HTTPRedirectHandler(BaseHandler): + max_redirections: ClassVar[int] # undocumented + max_repeats: ClassVar[int] # undocumented + inf_msg: ClassVar[str] # undocumented + def redirect_request( + self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage, newurl: str + ) -> Request | None: ... + def http_error_301(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + def http_error_302(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + def http_error_303(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + def http_error_307(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + if sys.version_info >= (3, 11): + def http_error_308( + self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage + ) -> _UrlopenRet | None: ... + +class HTTPCookieProcessor(BaseHandler): + cookiejar: CookieJar + def __init__(self, cookiejar: CookieJar | None = None) -> None: ... + def http_request(self, request: Request) -> Request: ... # undocumented + def http_response(self, request: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented + def https_request(self, request: Request) -> Request: ... # undocumented + def https_response(self, request: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented + +class ProxyHandler(BaseHandler): + def __init__(self, proxies: dict[str, str] | None = None) -> None: ... + def proxy_open(self, req: Request, proxy: str, type: str) -> _UrlopenRet | None: ... # undocumented + # TODO: add a method for every (common) proxy protocol + +class HTTPPasswordMgr: + def add_password(self, realm: str, uri: str | Sequence[str], user: str, passwd: str) -> None: ... + def find_user_password(self, realm: str, authuri: str) -> tuple[str | None, str | None]: ... + def is_suburi(self, base: str, test: str) -> bool: ... # undocumented + def reduce_uri(self, uri: str, default_port: bool = True) -> tuple[str, str]: ... # undocumented + +class HTTPPasswordMgrWithDefaultRealm(HTTPPasswordMgr): + def add_password(self, realm: str | None, uri: str | Sequence[str], user: str, passwd: str) -> None: ... + def find_user_password(self, realm: str | None, authuri: str) -> tuple[str | None, str | None]: ... + +class HTTPPasswordMgrWithPriorAuth(HTTPPasswordMgrWithDefaultRealm): + def add_password( + self, realm: str | None, uri: str | Sequence[str], user: str, passwd: str, is_authenticated: bool = False + ) -> None: ... + def update_authenticated(self, uri: str | Sequence[str], is_authenticated: bool = False) -> None: ... + def is_authenticated(self, authuri: str) -> bool | None: ... + +class AbstractBasicAuthHandler: + rx: ClassVar[Pattern[str]] # undocumented + passwd: HTTPPasswordMgr + add_password: Callable[[str, str | Sequence[str], str, str], None] + def __init__(self, password_mgr: HTTPPasswordMgr | None = None) -> None: ... + def http_error_auth_reqed(self, authreq: str, host: str, req: Request, headers: HTTPMessage) -> None: ... + def http_request(self, req: Request) -> Request: ... # undocumented + def http_response(self, req: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented + def https_request(self, req: Request) -> Request: ... # undocumented + def https_response(self, req: Request, response: HTTPResponse) -> HTTPResponse: ... # undocumented + def retry_http_basic_auth(self, host: str, req: Request, realm: str) -> _UrlopenRet | None: ... # undocumented + +class HTTPBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): + auth_header: ClassVar[str] # undocumented + def http_error_401(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + +class ProxyBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): + auth_header: ClassVar[str] + def http_error_407(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + +class AbstractDigestAuthHandler: + def __init__(self, passwd: HTTPPasswordMgr | None = None) -> None: ... + def reset_retry_count(self) -> None: ... + def http_error_auth_reqed(self, auth_header: str, host: str, req: Request, headers: HTTPMessage) -> None: ... + def retry_http_digest_auth(self, req: Request, auth: str) -> _UrlopenRet | None: ... + def get_cnonce(self, nonce: str) -> str: ... + def get_authorization(self, req: Request, chal: Mapping[str, str]) -> str | None: ... + def get_algorithm_impls(self, algorithm: str) -> tuple[Callable[[str], str], Callable[[str, str], str]]: ... + def get_entity_digest(self, data: ReadableBuffer | None, chal: Mapping[str, str]) -> str | None: ... + +class HTTPDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): + auth_header: ClassVar[str] # undocumented + def http_error_401(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + +class ProxyDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): + auth_header: ClassVar[str] # undocumented + def http_error_407(self, req: Request, fp: IO[bytes], code: int, msg: str, headers: HTTPMessage) -> _UrlopenRet | None: ... + +class _HTTPConnectionProtocol(Protocol): + def __call__( + self, + host: str, + /, + *, + port: int | None = ..., + timeout: float = ..., + source_address: tuple[str, int] | None = ..., + blocksize: int = ..., + ) -> HTTPConnection: ... + +class AbstractHTTPHandler(BaseHandler): # undocumented + if sys.version_info >= (3, 12): + def __init__(self, debuglevel: int | None = None) -> None: ... + else: + def __init__(self, debuglevel: int = 0) -> None: ... + + def set_http_debuglevel(self, level: int) -> None: ... + def do_request_(self, request: Request) -> Request: ... + def do_open(self, http_class: _HTTPConnectionProtocol, req: Request, **http_conn_args: Any) -> HTTPResponse: ... + +class HTTPHandler(AbstractHTTPHandler): + def http_open(self, req: Request) -> HTTPResponse: ... + def http_request(self, request: Request) -> Request: ... # undocumented + +class HTTPSHandler(AbstractHTTPHandler): + if sys.version_info >= (3, 12): + def __init__( + self, debuglevel: int | None = None, context: ssl.SSLContext | None = None, check_hostname: bool | None = None + ) -> None: ... + else: + def __init__( + self, debuglevel: int = 0, context: ssl.SSLContext | None = None, check_hostname: bool | None = None + ) -> None: ... + + def https_open(self, req: Request) -> HTTPResponse: ... + def https_request(self, request: Request) -> Request: ... # undocumented + +class FileHandler(BaseHandler): + names: ClassVar[tuple[str, ...] | None] # undocumented + def file_open(self, req: Request) -> addinfourl: ... + def get_names(self) -> tuple[str, ...]: ... # undocumented + def open_local_file(self, req: Request) -> addinfourl: ... # undocumented + +class DataHandler(BaseHandler): + def data_open(self, req: Request) -> addinfourl: ... + +class ftpwrapper: # undocumented + def __init__( + self, user: str, passwd: str, host: str, port: int, dirs: str, timeout: float | None = None, persistent: bool = True + ) -> None: ... + def close(self) -> None: ... + def endtransfer(self) -> None: ... + def file_close(self) -> None: ... + def init(self) -> None: ... + def real_close(self) -> None: ... + def retrfile(self, file: str, type: str) -> tuple[addclosehook, int | None]: ... + +class FTPHandler(BaseHandler): + def ftp_open(self, req: Request) -> addinfourl: ... + def connect_ftp( + self, user: str, passwd: str, host: str, port: int, dirs: str, timeout: float + ) -> ftpwrapper: ... # undocumented + +class CacheFTPHandler(FTPHandler): + def setTimeout(self, t: float) -> None: ... + def setMaxConns(self, m: int) -> None: ... + def check_cache(self) -> None: ... # undocumented + def clear_cache(self) -> None: ... # undocumented + +class UnknownHandler(BaseHandler): + def unknown_open(self, req: Request) -> NoReturn: ... + +class HTTPErrorProcessor(BaseHandler): + def http_response(self, request: Request, response: HTTPResponse) -> _UrlopenRet: ... + def https_response(self, request: Request, response: HTTPResponse) -> _UrlopenRet: ... + +def urlretrieve( + url: str, + filename: StrOrBytesPath | None = None, + reporthook: Callable[[int, int, int], object] | None = None, + data: _DataType = None, +) -> tuple[str, HTTPMessage]: ... +def urlcleanup() -> None: ... + +if sys.version_info < (3, 14): + @deprecated("Deprecated since Python 3.3; Removed in 3.14; Use newer urlopen functions and methods.") + class URLopener: + version: ClassVar[str] + def __init__(self, proxies: dict[str, str] | None = None, **x509: str) -> None: ... + def open(self, fullurl: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... + def open_unknown(self, fullurl: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... + def retrieve( + self, + url: str, + filename: str | None = None, + reporthook: Callable[[int, int, int], object] | None = None, + data: ReadableBuffer | None = None, + ) -> tuple[str, Message | None]: ... + def addheader(self, *args: tuple[str, str]) -> None: ... # undocumented + def cleanup(self) -> None: ... # undocumented + def close(self) -> None: ... # undocumented + def http_error( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: bytes | None = None + ) -> _UrlopenRet: ... # undocumented + def http_error_default( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage + ) -> _UrlopenRet: ... # undocumented + def open_data(self, url: str, data: ReadableBuffer | None = None) -> addinfourl: ... # undocumented + def open_file(self, url: str) -> addinfourl: ... # undocumented + def open_ftp(self, url: str) -> addinfourl: ... # undocumented + def open_http(self, url: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... # undocumented + def open_https(self, url: str, data: ReadableBuffer | None = None) -> _UrlopenRet: ... # undocumented + def open_local_file(self, url: str) -> addinfourl: ... # undocumented + def open_unknown_proxy(self, proxy: str, fullurl: str, data: ReadableBuffer | None = None) -> None: ... # undocumented + def __del__(self) -> None: ... + + @deprecated("Deprecated since Python 3.3; Removed in 3.14; Use newer urlopen functions and methods.") + class FancyURLopener(URLopener): + def prompt_user_passwd(self, host: str, realm: str) -> tuple[str, str]: ... + def get_user_passwd(self, host: str, realm: str, clear_cache: int = 0) -> tuple[str, str]: ... # undocumented + def http_error_301( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None + ) -> _UrlopenRet | addinfourl | None: ... # undocumented + def http_error_302( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None + ) -> _UrlopenRet | addinfourl | None: ... # undocumented + def http_error_303( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None + ) -> _UrlopenRet | addinfourl | None: ... # undocumented + def http_error_307( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None + ) -> _UrlopenRet | addinfourl | None: ... # undocumented + if sys.version_info >= (3, 11): + def http_error_308( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None = None + ) -> _UrlopenRet | addinfourl | None: ... # undocumented + + def http_error_401( + self, + url: str, + fp: IO[bytes], + errcode: int, + errmsg: str, + headers: HTTPMessage, + data: ReadableBuffer | None = None, + retry: bool = False, + ) -> _UrlopenRet | None: ... # undocumented + def http_error_407( + self, + url: str, + fp: IO[bytes], + errcode: int, + errmsg: str, + headers: HTTPMessage, + data: ReadableBuffer | None = None, + retry: bool = False, + ) -> _UrlopenRet | None: ... # undocumented + def http_error_default( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage + ) -> addinfourl: ... # undocumented + def redirect_internal( + self, url: str, fp: IO[bytes], errcode: int, errmsg: str, headers: HTTPMessage, data: ReadableBuffer | None + ) -> _UrlopenRet | None: ... # undocumented + def retry_http_basic_auth( + self, url: str, realm: str, data: ReadableBuffer | None = None + ) -> _UrlopenRet | None: ... # undocumented + def retry_https_basic_auth( + self, url: str, realm: str, data: ReadableBuffer | None = None + ) -> _UrlopenRet | None: ... # undocumented + def retry_proxy_http_basic_auth( + self, url: str, realm: str, data: ReadableBuffer | None = None + ) -> _UrlopenRet | None: ... # undocumented + def retry_proxy_https_basic_auth( + self, url: str, realm: str, data: ReadableBuffer | None = None + ) -> _UrlopenRet | None: ... # undocumented diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/response.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/response.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/response.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/urllib/response.pyi index bbec4cacc7501..65df9cdff58ff 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/response.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/response.pyi @@ -1,4 +1,3 @@ -import sys import tempfile from _typeshed import ReadableBuffer from collections.abc import Callable, Iterable @@ -34,10 +33,8 @@ class addinfo(addbase): class addinfourl(addinfo): url: str code: int | None - if sys.version_info >= (3, 9): - @property - def status(self) -> int | None: ... - + @property + def status(self) -> int | None: ... def __init__(self, fp: IO[bytes], headers: Message, url: str, code: int | None = None) -> None: ... def geturl(self) -> str: ... def getcode(self) -> int | None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/robotparser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/urllib/robotparser.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/urllib/robotparser.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/urllib/robotparser.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/uu.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/uu.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/uu.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/uu.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/uuid.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/uuid.pyi similarity index 77% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/uuid.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/uuid.pyi index 1be7a5ef009fc..99ac6eb223ef3 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/uuid.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/uuid.pyi @@ -1,8 +1,8 @@ import builtins import sys -from _typeshed import Unused from enum import Enum -from typing_extensions import TypeAlias +from typing import Final +from typing_extensions import LiteralString, TypeAlias _FieldsType: TypeAlias = tuple[int, int, int, int, int, int] @@ -65,14 +65,14 @@ class UUID: def __ge__(self, other: UUID) -> bool: ... def __hash__(self) -> builtins.int: ... -if sys.version_info >= (3, 9): - def getnode() -> int: ... - -else: - def getnode(*, getters: Unused = None) -> int: ... # undocumented - +def getnode() -> int: ... def uuid1(node: int | None = None, clock_seq: int | None = None) -> UUID: ... +if sys.version_info >= (3, 14): + def uuid6(node: int | None = None, clock_seq: int | None = None) -> UUID: ... + def uuid7() -> UUID: ... + def uuid8(a: int | None = None, b: int | None = None, c: int | None = None) -> UUID: ... + if sys.version_info >= (3, 12): def uuid3(namespace: UUID, name: str | bytes) -> UUID: ... @@ -87,14 +87,18 @@ if sys.version_info >= (3, 12): else: def uuid5(namespace: UUID, name: str) -> UUID: ... -NAMESPACE_DNS: UUID -NAMESPACE_URL: UUID -NAMESPACE_OID: UUID -NAMESPACE_X500: UUID -RESERVED_NCS: str -RFC_4122: str -RESERVED_MICROSOFT: str -RESERVED_FUTURE: str +if sys.version_info >= (3, 14): + NIL: Final[UUID] + MAX: Final[UUID] + +NAMESPACE_DNS: Final[UUID] +NAMESPACE_URL: Final[UUID] +NAMESPACE_OID: Final[UUID] +NAMESPACE_X500: Final[UUID] +RESERVED_NCS: Final[LiteralString] +RFC_4122: Final[LiteralString] +RESERVED_MICROSOFT: Final[LiteralString] +RESERVED_FUTURE: Final[LiteralString] if sys.version_info >= (3, 12): def main() -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/venv/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/venv/__init__.pyi new file mode 100644 index 0000000000000..0f71f0e073f5c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/venv/__init__.pyi @@ -0,0 +1,85 @@ +import logging +import sys +from _typeshed import StrOrBytesPath +from collections.abc import Iterable, Sequence +from types import SimpleNamespace + +logger: logging.Logger + +CORE_VENV_DEPS: tuple[str, ...] + +class EnvBuilder: + system_site_packages: bool + clear: bool + symlinks: bool + upgrade: bool + with_pip: bool + prompt: str | None + + if sys.version_info >= (3, 13): + def __init__( + self, + system_site_packages: bool = False, + clear: bool = False, + symlinks: bool = False, + upgrade: bool = False, + with_pip: bool = False, + prompt: str | None = None, + upgrade_deps: bool = False, + *, + scm_ignore_files: Iterable[str] = ..., + ) -> None: ... + else: + def __init__( + self, + system_site_packages: bool = False, + clear: bool = False, + symlinks: bool = False, + upgrade: bool = False, + with_pip: bool = False, + prompt: str | None = None, + upgrade_deps: bool = False, + ) -> None: ... + + def create(self, env_dir: StrOrBytesPath) -> None: ... + def clear_directory(self, path: StrOrBytesPath) -> None: ... # undocumented + def ensure_directories(self, env_dir: StrOrBytesPath) -> SimpleNamespace: ... + def create_configuration(self, context: SimpleNamespace) -> None: ... + def symlink_or_copy( + self, src: StrOrBytesPath, dst: StrOrBytesPath, relative_symlinks_ok: bool = False + ) -> None: ... # undocumented + def setup_python(self, context: SimpleNamespace) -> None: ... + def _setup_pip(self, context: SimpleNamespace) -> None: ... # undocumented + def setup_scripts(self, context: SimpleNamespace) -> None: ... + def post_setup(self, context: SimpleNamespace) -> None: ... + def replace_variables(self, text: str, context: SimpleNamespace) -> str: ... # undocumented + def install_scripts(self, context: SimpleNamespace, path: str) -> None: ... + def upgrade_dependencies(self, context: SimpleNamespace) -> None: ... + if sys.version_info >= (3, 13): + def create_git_ignore_file(self, context: SimpleNamespace) -> None: ... + +if sys.version_info >= (3, 13): + def create( + env_dir: StrOrBytesPath, + system_site_packages: bool = False, + clear: bool = False, + symlinks: bool = False, + with_pip: bool = False, + prompt: str | None = None, + upgrade_deps: bool = False, + *, + scm_ignore_files: Iterable[str] = ..., + ) -> None: ... + +else: + def create( + env_dir: StrOrBytesPath, + system_site_packages: bool = False, + clear: bool = False, + symlinks: bool = False, + with_pip: bool = False, + prompt: str | None = None, + upgrade_deps: bool = False, + ) -> None: ... + +def main(args: Sequence[str] | None = None) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/warnings.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/warnings.pyi similarity index 86% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/warnings.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/warnings.pyi index c7ab1cb091ddb..49c98cb07540e 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/warnings.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/warnings.pyi @@ -1,9 +1,10 @@ +import re import sys from _warnings import warn as warn, warn_explicit as warn_explicit from collections.abc import Sequence from types import ModuleType, TracebackType -from typing import Any, Generic, Literal, TextIO, TypeVar, overload -from typing_extensions import LiteralString, TypeAlias +from typing import Any, Generic, Literal, TextIO, overload +from typing_extensions import LiteralString, TypeAlias, TypeVar __all__ = [ "warn", @@ -20,12 +21,13 @@ if sys.version_info >= (3, 13): __all__ += ["deprecated"] _T = TypeVar("_T") -_W = TypeVar("_W", bound=list[WarningMessage] | None) +_W_co = TypeVar("_W_co", bound=list[WarningMessage] | None, default=list[WarningMessage] | None, covariant=True) + if sys.version_info >= (3, 14): _ActionKind: TypeAlias = Literal["default", "error", "ignore", "always", "module", "once"] else: _ActionKind: TypeAlias = Literal["default", "error", "ignore", "always", "all", "module", "once"] -filters: Sequence[tuple[str, str | None, type[Warning], str | None, int]] # undocumented, do not mutate +filters: Sequence[tuple[str, re.Pattern[str] | None, type[Warning], re.Pattern[str] | None, int]] # undocumented, do not mutate def showwarning( message: Warning | str, @@ -65,7 +67,7 @@ class WarningMessage: source: Any | None = None, ) -> None: ... -class catch_warnings(Generic[_W]): +class catch_warnings(Generic[_W_co]): if sys.version_info >= (3, 11): @overload def __init__( @@ -91,7 +93,7 @@ class catch_warnings(Generic[_W]): ) -> None: ... @overload def __init__( - self: catch_warnings[list[WarningMessage] | None], + self, *, record: bool, module: ModuleType | None = None, @@ -108,11 +110,9 @@ class catch_warnings(Generic[_W]): self: catch_warnings[list[WarningMessage]], *, record: Literal[True], module: ModuleType | None = None ) -> None: ... @overload - def __init__( - self: catch_warnings[list[WarningMessage] | None], *, record: bool, module: ModuleType | None = None - ) -> None: ... + def __init__(self, *, record: bool, module: ModuleType | None = None) -> None: ... - def __enter__(self) -> _W: ... + def __enter__(self) -> _W_co: ... def __exit__( self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None ) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wave.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wave.pyi similarity index 93% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wave.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wave.pyi index 9319d5347c791..ddc6f6bd02a50 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/wave.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/wave.pyi @@ -1,12 +1,8 @@ -import sys from _typeshed import ReadableBuffer, Unused from typing import IO, Any, BinaryIO, Final, Literal, NamedTuple, NoReturn, overload from typing_extensions import Self, TypeAlias, deprecated -if sys.version_info >= (3, 9): - __all__ = ["open", "Error", "Wave_read", "Wave_write"] -else: - __all__ = ["open", "openfp", "Error", "Wave_read", "Wave_write"] +__all__ = ["open", "Error", "Wave_read", "Wave_write"] _File: TypeAlias = str | IO[bytes] @@ -80,6 +76,3 @@ def open(f: _File, mode: Literal["r", "rb"]) -> Wave_read: ... def open(f: _File, mode: Literal["w", "wb"]) -> Wave_write: ... @overload def open(f: _File, mode: str | None = None) -> Any: ... - -if sys.version_info < (3, 9): - openfp = open diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/weakref.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/weakref.pyi new file mode 100644 index 0000000000000..593eb4615c8f4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/weakref.pyi @@ -0,0 +1,190 @@ +from _typeshed import SupportsKeysAndGetItem +from _weakref import getweakrefcount as getweakrefcount, getweakrefs as getweakrefs, proxy as proxy +from _weakrefset import WeakSet as WeakSet +from collections.abc import Callable, Iterable, Iterator, Mapping, MutableMapping +from types import GenericAlias +from typing import Any, ClassVar, Generic, TypeVar, final, overload +from typing_extensions import ParamSpec, Self + +__all__ = [ + "ref", + "proxy", + "getweakrefcount", + "getweakrefs", + "WeakKeyDictionary", + "ReferenceType", + "ProxyType", + "CallableProxyType", + "ProxyTypes", + "WeakValueDictionary", + "WeakSet", + "WeakMethod", + "finalize", +] + +_T = TypeVar("_T") +_T1 = TypeVar("_T1") +_T2 = TypeVar("_T2") +_KT = TypeVar("_KT") +_VT = TypeVar("_VT") +_CallableT = TypeVar("_CallableT", bound=Callable[..., Any]) +_P = ParamSpec("_P") + +ProxyTypes: tuple[type[Any], ...] + +# These classes are implemented in C and imported from _weakref at runtime. However, +# they consider themselves to live in the weakref module for sys.version_info >= (3, 11), +# so defining their stubs here means we match their __module__ value. +# Prior to 3.11 they did not declare a module for themselves and ended up looking like they +# came from the builtin module at runtime, which was just wrong, and we won't attempt to +# duplicate that. + +@final +class CallableProxyType(Generic[_CallableT]): # "weakcallableproxy" + def __eq__(self, value: object, /) -> bool: ... + def __getattr__(self, attr: str) -> Any: ... + __call__: _CallableT + __hash__: ClassVar[None] # type: ignore[assignment] + +@final +class ProxyType(Generic[_T]): # "weakproxy" + def __eq__(self, value: object, /) -> bool: ... + def __getattr__(self, attr: str) -> Any: ... + __hash__: ClassVar[None] # type: ignore[assignment] + +class ReferenceType(Generic[_T]): # "weakref" + __callback__: Callable[[Self], Any] + def __new__(cls, o: _T, callback: Callable[[Self], Any] | None = ..., /) -> Self: ... + def __call__(self) -> _T | None: ... + def __eq__(self, value: object, /) -> bool: ... + def __hash__(self) -> int: ... + def __class_getitem__(cls, item: Any, /) -> GenericAlias: ... + +ref = ReferenceType + +# everything below here is implemented in weakref.py + +class WeakMethod(ref[_CallableT]): + def __new__(cls, meth: _CallableT, callback: Callable[[Self], Any] | None = None) -> Self: ... + def __call__(self) -> _CallableT | None: ... + def __eq__(self, other: object) -> bool: ... + def __ne__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + +class WeakValueDictionary(MutableMapping[_KT, _VT]): + @overload + def __init__(self) -> None: ... + @overload + def __init__( + self: WeakValueDictionary[_KT, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + other: Mapping[_KT, _VT] | Iterable[tuple[_KT, _VT]], + /, + ) -> None: ... + @overload + def __init__( + self: WeakValueDictionary[str, _VT], # pyright: ignore[reportInvalidTypeVarUse] #11780 + other: Mapping[str, _VT] | Iterable[tuple[str, _VT]] = (), + /, + **kwargs: _VT, + ) -> None: ... + def __len__(self) -> int: ... + def __getitem__(self, key: _KT) -> _VT: ... + def __setitem__(self, key: _KT, value: _VT) -> None: ... + def __delitem__(self, key: _KT) -> None: ... + def __contains__(self, key: object) -> bool: ... + def __iter__(self) -> Iterator[_KT]: ... + def copy(self) -> WeakValueDictionary[_KT, _VT]: ... + __copy__ = copy + def __deepcopy__(self, memo: Any) -> Self: ... + @overload + def get(self, key: _KT, default: None = None) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _T) -> _VT | _T: ... + # These are incompatible with Mapping + def keys(self) -> Iterator[_KT]: ... # type: ignore[override] + def values(self) -> Iterator[_VT]: ... # type: ignore[override] + def items(self) -> Iterator[tuple[_KT, _VT]]: ... # type: ignore[override] + def itervaluerefs(self) -> Iterator[KeyedRef[_KT, _VT]]: ... + def valuerefs(self) -> list[KeyedRef[_KT, _VT]]: ... + def setdefault(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T) -> _VT | _T: ... + @overload + def update(self, other: SupportsKeysAndGetItem[_KT, _VT], /, **kwargs: _VT) -> None: ... + @overload + def update(self, other: Iterable[tuple[_KT, _VT]], /, **kwargs: _VT) -> None: ... + @overload + def update(self, other: None = None, /, **kwargs: _VT) -> None: ... + def __or__(self, other: Mapping[_T1, _T2]) -> WeakValueDictionary[_KT | _T1, _VT | _T2]: ... + def __ror__(self, other: Mapping[_T1, _T2]) -> WeakValueDictionary[_KT | _T1, _VT | _T2]: ... + # WeakValueDictionary.__ior__ should be kept roughly in line with MutableMapping.update() + @overload # type: ignore[misc] + def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... + @overload + def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... + +class KeyedRef(ref[_T], Generic[_KT, _T]): + key: _KT + def __new__(type, ob: _T, callback: Callable[[Self], Any], key: _KT) -> Self: ... + def __init__(self, ob: _T, callback: Callable[[Self], Any], key: _KT) -> None: ... + +class WeakKeyDictionary(MutableMapping[_KT, _VT]): + @overload + def __init__(self, dict: None = None) -> None: ... + @overload + def __init__(self, dict: Mapping[_KT, _VT] | Iterable[tuple[_KT, _VT]]) -> None: ... + def __len__(self) -> int: ... + def __getitem__(self, key: _KT) -> _VT: ... + def __setitem__(self, key: _KT, value: _VT) -> None: ... + def __delitem__(self, key: _KT) -> None: ... + def __contains__(self, key: object) -> bool: ... + def __iter__(self) -> Iterator[_KT]: ... + def copy(self) -> WeakKeyDictionary[_KT, _VT]: ... + __copy__ = copy + def __deepcopy__(self, memo: Any) -> Self: ... + @overload + def get(self, key: _KT, default: None = None) -> _VT | None: ... + @overload + def get(self, key: _KT, default: _T) -> _VT | _T: ... + # These are incompatible with Mapping + def keys(self) -> Iterator[_KT]: ... # type: ignore[override] + def values(self) -> Iterator[_VT]: ... # type: ignore[override] + def items(self) -> Iterator[tuple[_KT, _VT]]: ... # type: ignore[override] + def keyrefs(self) -> list[ref[_KT]]: ... + # Keep WeakKeyDictionary.setdefault in line with MutableMapping.setdefault, modulo positional-only differences + @overload + def setdefault(self: WeakKeyDictionary[_KT, _VT | None], key: _KT, default: None = None) -> _VT: ... + @overload + def setdefault(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _VT) -> _VT: ... + @overload + def pop(self, key: _KT, default: _T) -> _VT | _T: ... + @overload + def update(self, dict: SupportsKeysAndGetItem[_KT, _VT], /, **kwargs: _VT) -> None: ... + @overload + def update(self, dict: Iterable[tuple[_KT, _VT]], /, **kwargs: _VT) -> None: ... + @overload + def update(self, dict: None = None, /, **kwargs: _VT) -> None: ... + def __or__(self, other: Mapping[_T1, _T2]) -> WeakKeyDictionary[_KT | _T1, _VT | _T2]: ... + def __ror__(self, other: Mapping[_T1, _T2]) -> WeakKeyDictionary[_KT | _T1, _VT | _T2]: ... + # WeakKeyDictionary.__ior__ should be kept roughly in line with MutableMapping.update() + @overload # type: ignore[misc] + def __ior__(self, other: SupportsKeysAndGetItem[_KT, _VT]) -> Self: ... + @overload + def __ior__(self, other: Iterable[tuple[_KT, _VT]]) -> Self: ... + +class finalize(Generic[_P, _T]): + def __init__(self, obj: _T, func: Callable[_P, Any], /, *args: _P.args, **kwargs: _P.kwargs) -> None: ... + def __call__(self, _: Any = None) -> Any | None: ... + def detach(self) -> tuple[_T, Callable[_P, Any], tuple[Any, ...], dict[str, Any]] | None: ... + def peek(self) -> tuple[_T, Callable[_P, Any], tuple[Any, ...], dict[str, Any]] | None: ... + @property + def alive(self) -> bool: ... + atexit: bool diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/webbrowser.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/webbrowser.pyi similarity index 98% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/webbrowser.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/webbrowser.pyi index d7bf033172f65..773786c248219 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/webbrowser.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/webbrowser.pyi @@ -66,6 +66,7 @@ if sys.platform == "darwin": if sys.version_info < (3, 13): @deprecated("Deprecated in 3.11, to be removed in 3.13.") class MacOSX(BaseBrowser): + def __init__(self, name: str) -> None: ... def open(self, url: str, new: int = 0, autoraise: bool = True) -> bool: ... class MacOSXOSAScript(BaseBrowser): # In runtime this class does not have `name` and `basename` diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/winreg.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/winreg.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/winreg.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/winreg.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/winsound.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/winsound.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/winsound.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/winsound.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/__init__.pyi new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/handlers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/handlers.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/handlers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/handlers.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/headers.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/headers.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/headers.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/headers.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/simple_server.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/simple_server.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/simple_server.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/simple_server.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi new file mode 100644 index 0000000000000..57276fd05ea84 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/types.pyi @@ -0,0 +1,32 @@ +from _typeshed import OptExcInfo +from collections.abc import Callable, Iterable, Iterator +from typing import Any, Protocol +from typing_extensions import TypeAlias + +__all__ = ["StartResponse", "WSGIEnvironment", "WSGIApplication", "InputStream", "ErrorStream", "FileWrapper"] + +class StartResponse(Protocol): + def __call__( + self, status: str, headers: list[tuple[str, str]], exc_info: OptExcInfo | None = ..., / + ) -> Callable[[bytes], object]: ... + +WSGIEnvironment: TypeAlias = dict[str, Any] +WSGIApplication: TypeAlias = Callable[[WSGIEnvironment, StartResponse], Iterable[bytes]] + +class InputStream(Protocol): + def read(self, size: int = ..., /) -> bytes: ... + def readline(self, size: int = ..., /) -> bytes: ... + def readlines(self, hint: int = ..., /) -> list[bytes]: ... + def __iter__(self) -> Iterator[bytes]: ... + +class ErrorStream(Protocol): + def flush(self) -> object: ... + def write(self, s: str, /) -> object: ... + def writelines(self, seq: list[str], /) -> object: ... + +class _Readable(Protocol): + def read(self, size: int = ..., /) -> bytes: ... + # Optional: def close(self) -> object: ... + +class FileWrapper(Protocol): + def __call__(self, file: _Readable, block_size: int = ..., /) -> Iterable[bytes]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/util.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/util.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/util.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/util.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/validate.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/validate.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/wsgiref/validate.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/wsgiref/validate.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xdrlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xdrlib.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xdrlib.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xdrlib.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/__init__.pyi new file mode 100644 index 0000000000000..7a240965136e5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/__init__.pyi @@ -0,0 +1,3 @@ +# At runtime, listing submodules in __all__ without them being imported is +# valid, and causes them to be included in a star import. See #6523 +__all__ = ["dom", "parsers", "sax", "etree"] # noqa: F822 # pyright: ignore[reportUnsupportedDunderAll] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi new file mode 100644 index 0000000000000..007df982e06a8 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/NodeFilter.pyi @@ -0,0 +1,22 @@ +from typing import Literal +from xml.dom.minidom import Node + +class NodeFilter: + FILTER_ACCEPT: Literal[1] + FILTER_REJECT: Literal[2] + FILTER_SKIP: Literal[3] + + SHOW_ALL: int + SHOW_ELEMENT: int + SHOW_ATTRIBUTE: int + SHOW_TEXT: int + SHOW_CDATA_SECTION: int + SHOW_ENTITY_REFERENCE: int + SHOW_ENTITY: int + SHOW_PROCESSING_INSTRUCTION: int + SHOW_COMMENT: int + SHOW_DOCUMENT: int + SHOW_DOCUMENT_TYPE: int + SHOW_DOCUMENT_FRAGMENT: int + SHOW_NOTATION: int + def acceptNode(self, node: Node) -> int: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi new file mode 100644 index 0000000000000..d9615f9aacfea --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/__init__.pyi @@ -0,0 +1,100 @@ +from typing import Any, Final, Literal + +from .domreg import getDOMImplementation as getDOMImplementation, registerDOMImplementation as registerDOMImplementation + +class Node: + ELEMENT_NODE: Literal[1] + ATTRIBUTE_NODE: Literal[2] + TEXT_NODE: Literal[3] + CDATA_SECTION_NODE: Literal[4] + ENTITY_REFERENCE_NODE: Literal[5] + ENTITY_NODE: Literal[6] + PROCESSING_INSTRUCTION_NODE: Literal[7] + COMMENT_NODE: Literal[8] + DOCUMENT_NODE: Literal[9] + DOCUMENT_TYPE_NODE: Literal[10] + DOCUMENT_FRAGMENT_NODE: Literal[11] + NOTATION_NODE: Literal[12] + +# ExceptionCode +INDEX_SIZE_ERR: Final = 1 +DOMSTRING_SIZE_ERR: Final = 2 +HIERARCHY_REQUEST_ERR: Final = 3 +WRONG_DOCUMENT_ERR: Final = 4 +INVALID_CHARACTER_ERR: Final = 5 +NO_DATA_ALLOWED_ERR: Final = 6 +NO_MODIFICATION_ALLOWED_ERR: Final = 7 +NOT_FOUND_ERR: Final = 8 +NOT_SUPPORTED_ERR: Final = 9 +INUSE_ATTRIBUTE_ERR: Final = 10 +INVALID_STATE_ERR: Final = 11 +SYNTAX_ERR: Final = 12 +INVALID_MODIFICATION_ERR: Final = 13 +NAMESPACE_ERR: Final = 14 +INVALID_ACCESS_ERR: Final = 15 +VALIDATION_ERR: Final = 16 + +class DOMException(Exception): + code: int + def __init__(self, *args: Any, **kw: Any) -> None: ... + def _get_code(self) -> int: ... + +class IndexSizeErr(DOMException): + code: Literal[1] + +class DomstringSizeErr(DOMException): + code: Literal[2] + +class HierarchyRequestErr(DOMException): + code: Literal[3] + +class WrongDocumentErr(DOMException): + code: Literal[4] + +class InvalidCharacterErr(DOMException): + code: Literal[5] + +class NoDataAllowedErr(DOMException): + code: Literal[6] + +class NoModificationAllowedErr(DOMException): + code: Literal[7] + +class NotFoundErr(DOMException): + code: Literal[8] + +class NotSupportedErr(DOMException): + code: Literal[9] + +class InuseAttributeErr(DOMException): + code: Literal[10] + +class InvalidStateErr(DOMException): + code: Literal[11] + +class SyntaxErr(DOMException): + code: Literal[12] + +class InvalidModificationErr(DOMException): + code: Literal[13] + +class NamespaceErr(DOMException): + code: Literal[14] + +class InvalidAccessErr(DOMException): + code: Literal[15] + +class ValidationErr(DOMException): + code: Literal[16] + +class UserDataHandler: + NODE_CLONED: Literal[1] + NODE_IMPORTED: Literal[2] + NODE_DELETED: Literal[3] + NODE_RENAMED: Literal[4] + +XML_NAMESPACE: Final = "http://www.w3.org/XML/1998/namespace" +XMLNS_NAMESPACE: Final = "http://www.w3.org/2000/xmlns/" +XHTML_NAMESPACE: Final = "http://www.w3.org/1999/xhtml" +EMPTY_NAMESPACE: Final[None] +EMPTY_PREFIX: Final[None] diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/domreg.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/domreg.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/domreg.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/domreg.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi new file mode 100644 index 0000000000000..228ad07e15ad4 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/expatbuilder.pyi @@ -0,0 +1,121 @@ +from _typeshed import ReadableBuffer, SupportsRead +from typing import Any, NoReturn +from typing_extensions import TypeAlias +from xml.dom.minidom import Document, DocumentFragment, DOMImplementation, Element, Node, TypeInfo +from xml.dom.xmlbuilder import DOMBuilderFilter, Options +from xml.parsers.expat import XMLParserType + +_Model: TypeAlias = tuple[int, int, str | None, tuple[Any, ...]] # same as in pyexpat + +TEXT_NODE = Node.TEXT_NODE +CDATA_SECTION_NODE = Node.CDATA_SECTION_NODE +DOCUMENT_NODE = Node.DOCUMENT_NODE +FILTER_ACCEPT = DOMBuilderFilter.FILTER_ACCEPT +FILTER_REJECT = DOMBuilderFilter.FILTER_REJECT +FILTER_SKIP = DOMBuilderFilter.FILTER_SKIP +FILTER_INTERRUPT = DOMBuilderFilter.FILTER_INTERRUPT +theDOMImplementation: DOMImplementation + +class ElementInfo: + tagName: str + def __init__(self, tagName: str, model: _Model | None = None) -> None: ... + def getAttributeType(self, aname: str) -> TypeInfo: ... + def getAttributeTypeNS(self, namespaceURI: str | None, localName: str) -> TypeInfo: ... + def isElementContent(self) -> bool: ... + def isEmpty(self) -> bool: ... + def isId(self, aname: str) -> bool: ... + def isIdNS(self, euri: str, ename: str, auri: str, aname: str) -> bool: ... + +class ExpatBuilder: + document: Document # Created in self.reset() + curNode: DocumentFragment | Element | Document # Created in self.reset() + def __init__(self, options: Options | None = None) -> None: ... + def createParser(self) -> XMLParserType: ... + def getParser(self) -> XMLParserType: ... + def reset(self) -> None: ... + def install(self, parser: XMLParserType) -> None: ... + def parseFile(self, file: SupportsRead[ReadableBuffer | str]) -> Document: ... + def parseString(self, string: str | ReadableBuffer) -> Document: ... + def start_doctype_decl_handler( + self, doctypeName: str, systemId: str | None, publicId: str | None, has_internal_subset: bool + ) -> None: ... + def end_doctype_decl_handler(self) -> None: ... + def pi_handler(self, target: str, data: str) -> None: ... + def character_data_handler_cdata(self, data: str) -> None: ... + def character_data_handler(self, data: str) -> None: ... + def start_cdata_section_handler(self) -> None: ... + def end_cdata_section_handler(self) -> None: ... + def entity_decl_handler( + self, + entityName: str, + is_parameter_entity: bool, + value: str | None, + base: str | None, + systemId: str, + publicId: str | None, + notationName: str | None, + ) -> None: ... + def notation_decl_handler(self, notationName: str, base: str | None, systemId: str, publicId: str | None) -> None: ... + def comment_handler(self, data: str) -> None: ... + def external_entity_ref_handler(self, context: str, base: str | None, systemId: str | None, publicId: str | None) -> int: ... + def first_element_handler(self, name: str, attributes: list[str]) -> None: ... + def start_element_handler(self, name: str, attributes: list[str]) -> None: ... + def end_element_handler(self, name: str) -> None: ... + def element_decl_handler(self, name: str, model: _Model) -> None: ... + def attlist_decl_handler(self, elem: str, name: str, type: str, default: str | None, required: bool) -> None: ... + def xml_decl_handler(self, version: str, encoding: str | None, standalone: int) -> None: ... + +class FilterVisibilityController: + filter: DOMBuilderFilter + def __init__(self, filter: DOMBuilderFilter) -> None: ... + def startContainer(self, node: Node) -> int: ... + def acceptNode(self, node: Node) -> int: ... + +class FilterCrutch: + def __init__(self, builder: ExpatBuilder) -> None: ... + +class Rejecter(FilterCrutch): + def start_element_handler(self, *args: Any) -> None: ... + def end_element_handler(self, *args: Any) -> None: ... + +class Skipper(FilterCrutch): + def start_element_handler(self, *args: Any) -> None: ... + def end_element_handler(self, *args: Any) -> None: ... + +class FragmentBuilder(ExpatBuilder): + fragment: DocumentFragment | None + originalDocument: Document + context: Node + def __init__(self, context: Node, options: Options | None = None) -> None: ... + def reset(self) -> None: ... + def parseFile(self, file: SupportsRead[ReadableBuffer | str]) -> DocumentFragment: ... # type: ignore[override] + def parseString(self, string: ReadableBuffer | str) -> DocumentFragment: ... # type: ignore[override] + def external_entity_ref_handler(self, context: str, base: str | None, systemId: str | None, publicId: str | None) -> int: ... + +class Namespaces: + def createParser(self) -> XMLParserType: ... + def install(self, parser: XMLParserType) -> None: ... + def start_namespace_decl_handler(self, prefix: str | None, uri: str) -> None: ... + def start_element_handler(self, name: str, attributes: list[str]) -> None: ... + def end_element_handler(self, name: str) -> None: ... # only exists if __debug__ + +class ExpatBuilderNS(Namespaces, ExpatBuilder): ... +class FragmentBuilderNS(Namespaces, FragmentBuilder): ... +class ParseEscape(Exception): ... + +class InternalSubsetExtractor(ExpatBuilder): + subset: str | list[str] | None = None + def getSubset(self) -> str: ... + def parseFile(self, file: SupportsRead[ReadableBuffer | str]) -> None: ... # type: ignore[override] + def parseString(self, string: str | ReadableBuffer) -> None: ... # type: ignore[override] + def start_doctype_decl_handler( # type: ignore[override] + self, name: str, publicId: str | None, systemId: str | None, has_internal_subset: bool + ) -> None: ... + def end_doctype_decl_handler(self) -> NoReturn: ... + def start_element_handler(self, name: str, attrs: list[str]) -> NoReturn: ... + +def parse(file: str | SupportsRead[ReadableBuffer | str], namespaces: bool = True) -> Document: ... +def parseString(string: str | ReadableBuffer, namespaces: bool = True) -> Document: ... +def parseFragment(file: str | SupportsRead[ReadableBuffer | str], context: Node, namespaces: bool = True) -> DocumentFragment: ... +def parseFragmentString(string: str | ReadableBuffer, context: Node, namespaces: bool = True) -> DocumentFragment: ... +def makeBuilder(options: Options) -> ExpatBuilderNS | ExpatBuilder: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/minicompat.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/minicompat.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/dom/minicompat.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/minicompat.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi new file mode 100644 index 0000000000000..ab2ef87e38a85 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/minidom.pyi @@ -0,0 +1,650 @@ +import xml.dom +from _collections_abc import dict_keys, dict_values +from _typeshed import Incomplete, ReadableBuffer, SupportsRead, SupportsWrite +from collections.abc import Iterable, Sequence +from types import TracebackType +from typing import Any, ClassVar, Generic, Literal, NoReturn, Protocol, TypeVar, overload +from typing_extensions import Self, TypeAlias +from xml.dom.minicompat import EmptyNodeList, NodeList +from xml.dom.xmlbuilder import DocumentLS, DOMImplementationLS +from xml.sax.xmlreader import XMLReader + +_NSName: TypeAlias = tuple[str | None, str] + +# Entity can also have children, but it's not implemented the same way as the +# others, so is deliberately omitted here. +_NodesWithChildren: TypeAlias = DocumentFragment | Attr | Element | Document +_NodesThatAreChildren: TypeAlias = CDATASection | Comment | DocumentType | Element | Notation | ProcessingInstruction | Text + +_AttrChildren: TypeAlias = Text # Also EntityReference, but we don't implement it +_ElementChildren: TypeAlias = Element | ProcessingInstruction | Comment | Text | CDATASection +_EntityChildren: TypeAlias = Text # I think; documentation is a little unclear +_DocumentFragmentChildren: TypeAlias = Element | Text | CDATASection | ProcessingInstruction | Comment | Notation +_DocumentChildren: TypeAlias = Comment | DocumentType | Element | ProcessingInstruction + +_N = TypeVar("_N", bound=Node) +_ChildNodeVar = TypeVar("_ChildNodeVar", bound=_NodesThatAreChildren) +_ChildNodePlusFragmentVar = TypeVar("_ChildNodePlusFragmentVar", bound=_NodesThatAreChildren | DocumentFragment) +_DocumentChildrenVar = TypeVar("_DocumentChildrenVar", bound=_DocumentChildren) +_ImportableNodeVar = TypeVar( + "_ImportableNodeVar", + bound=DocumentFragment + | Attr + | Element + | ProcessingInstruction + | CharacterData + | Text + | Comment + | CDATASection + | Entity + | Notation, +) + +class _DOMErrorHandler(Protocol): + def handleError(self, error: Exception) -> bool: ... + +class _UserDataHandler(Protocol): + def handle(self, operation: int, key: str, data: Any, src: Node, dst: Node) -> None: ... + +def parse( + file: str | SupportsRead[ReadableBuffer | str], parser: XMLReader | None = None, bufsize: int | None = None +) -> Document: ... +def parseString(string: str | ReadableBuffer, parser: XMLReader | None = None) -> Document: ... +@overload +def getDOMImplementation(features: None = None) -> DOMImplementation: ... +@overload +def getDOMImplementation(features: str | Iterable[tuple[str, str | None]]) -> DOMImplementation | None: ... + +class Node(xml.dom.Node): + parentNode: _NodesWithChildren | Entity | None + ownerDocument: Document | None + nextSibling: _NodesThatAreChildren | None + previousSibling: _NodesThatAreChildren | None + namespaceURI: str | None # non-null only for Element and Attr + prefix: str | None # non-null only for NS Element and Attr + + # These aren't defined on Node, but they exist on all Node subclasses + # and various methods of Node require them to exist. + childNodes: ( + NodeList[_DocumentFragmentChildren] + | NodeList[_AttrChildren] + | NodeList[_ElementChildren] + | NodeList[_DocumentChildren] + | NodeList[_EntityChildren] + | EmptyNodeList + ) + nodeType: ClassVar[Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]] + nodeName: str | None # only possibly None on DocumentType + + # Not defined on Node, but exist on all Node subclasses. + nodeValue: str | None # non-null for Attr, ProcessingInstruction, Text, Comment, and CDATASection + attributes: NamedNodeMap | None # non-null only for Element + + @property + def firstChild(self) -> _NodesThatAreChildren | None: ... + @property + def lastChild(self) -> _NodesThatAreChildren | None: ... + @property + def localName(self) -> str | None: ... # non-null only for Element and Attr + def __bool__(self) -> Literal[True]: ... + @overload + def toxml(self, encoding: str, standalone: bool | None = None) -> bytes: ... + @overload + def toxml(self, encoding: None = None, standalone: bool | None = None) -> str: ... + @overload + def toprettyxml( + self, + indent: str = "\t", + newl: str = "\n", + # Handle any case where encoding is not provided or where it is passed with None + encoding: None = None, + standalone: bool | None = None, + ) -> str: ... + @overload + def toprettyxml( + self, + indent: str, + newl: str, + # Handle cases where encoding is passed as str *positionally* + encoding: str, + standalone: bool | None = None, + ) -> bytes: ... + @overload + def toprettyxml( + self, + indent: str = "\t", + newl: str = "\n", + # Handle all cases where encoding is passed as a keyword argument; because standalone + # comes after, it will also have to be a keyword arg if encoding is + *, + encoding: str, + standalone: bool | None = None, + ) -> bytes: ... + def hasChildNodes(self) -> bool: ... + def insertBefore( # type: ignore[misc] + self: _NodesWithChildren, # pyright: ignore[reportGeneralTypeIssues] + newChild: _ChildNodePlusFragmentVar, + refChild: _NodesThatAreChildren | None, + ) -> _ChildNodePlusFragmentVar: ... + def appendChild( # type: ignore[misc] + self: _NodesWithChildren, node: _ChildNodePlusFragmentVar # pyright: ignore[reportGeneralTypeIssues] + ) -> _ChildNodePlusFragmentVar: ... + @overload + def replaceChild( # type: ignore[misc] + self: _NodesWithChildren, newChild: DocumentFragment, oldChild: _ChildNodeVar + ) -> _ChildNodeVar | DocumentFragment: ... + @overload + def replaceChild( # type: ignore[misc] + self: _NodesWithChildren, newChild: _NodesThatAreChildren, oldChild: _ChildNodeVar + ) -> _ChildNodeVar | None: ... + def removeChild(self: _NodesWithChildren, oldChild: _ChildNodeVar) -> _ChildNodeVar: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def normalize(self: _NodesWithChildren) -> None: ... # type: ignore[misc] # pyright: ignore[reportGeneralTypeIssues] + def cloneNode(self, deep: bool) -> Self | None: ... + def isSupported(self, feature: str, version: str | None) -> bool: ... + def isSameNode(self, other: Node) -> bool: ... + def getInterface(self, feature: str) -> Self | None: ... + def getUserData(self, key: str) -> Any | None: ... + def setUserData(self, key: str, data: Any, handler: _UserDataHandler) -> Any: ... + def unlink(self) -> None: ... + def __enter__(self) -> Self: ... + def __exit__(self, et: type[BaseException] | None, ev: BaseException | None, tb: TracebackType | None) -> None: ... + +_DFChildrenVar = TypeVar("_DFChildrenVar", bound=_DocumentFragmentChildren) +_DFChildrenPlusFragment = TypeVar("_DFChildrenPlusFragment", bound=_DocumentFragmentChildren | DocumentFragment) + +class DocumentFragment(Node): + nodeType: ClassVar[Literal[11]] + nodeName: Literal["#document-fragment"] + nodeValue: None + attributes: None + + parentNode: None + nextSibling: None + previousSibling: None + childNodes: NodeList[_DocumentFragmentChildren] + @property + def firstChild(self) -> _DocumentFragmentChildren | None: ... + @property + def lastChild(self) -> _DocumentFragmentChildren | None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + def __init__(self) -> None: ... + def insertBefore( # type: ignore[override] + self, newChild: _DFChildrenPlusFragment, refChild: _DocumentFragmentChildren | None + ) -> _DFChildrenPlusFragment: ... + def appendChild(self, node: _DFChildrenPlusFragment) -> _DFChildrenPlusFragment: ... # type: ignore[override] + @overload # type: ignore[override] + def replaceChild(self, newChild: DocumentFragment, oldChild: _DFChildrenVar) -> _DFChildrenVar | DocumentFragment: ... + @overload + def replaceChild(self, newChild: _DocumentFragmentChildren, oldChild: _DFChildrenVar) -> _DFChildrenVar | None: ... # type: ignore[override] + def removeChild(self, oldChild: _DFChildrenVar) -> _DFChildrenVar: ... # type: ignore[override] + +_AttrChildrenVar = TypeVar("_AttrChildrenVar", bound=_AttrChildren) +_AttrChildrenPlusFragment = TypeVar("_AttrChildrenPlusFragment", bound=_AttrChildren | DocumentFragment) + +class Attr(Node): + nodeType: ClassVar[Literal[2]] + nodeName: str # same as Attr.name + nodeValue: str # same as Attr.value + attributes: None + + parentNode: None + nextSibling: None + previousSibling: None + childNodes: NodeList[_AttrChildren] + @property + def firstChild(self) -> _AttrChildren | None: ... + @property + def lastChild(self) -> _AttrChildren | None: ... + + namespaceURI: str | None + prefix: str | None + @property + def localName(self) -> str: ... + + name: str + value: str + specified: bool + ownerElement: Element | None + + def __init__( + self, qName: str, namespaceURI: str | None = None, localName: str | None = None, prefix: str | None = None + ) -> None: ... + def unlink(self) -> None: ... + @property + def isId(self) -> bool: ... + @property + def schemaType(self) -> TypeInfo: ... + def insertBefore(self, newChild: _AttrChildrenPlusFragment, refChild: _AttrChildren | None) -> _AttrChildrenPlusFragment: ... # type: ignore[override] + def appendChild(self, node: _AttrChildrenPlusFragment) -> _AttrChildrenPlusFragment: ... # type: ignore[override] + @overload # type: ignore[override] + def replaceChild(self, newChild: DocumentFragment, oldChild: _AttrChildrenVar) -> _AttrChildrenVar | DocumentFragment: ... + @overload + def replaceChild(self, newChild: _AttrChildren, oldChild: _AttrChildrenVar) -> _AttrChildrenVar | None: ... # type: ignore[override] + def removeChild(self, oldChild: _AttrChildrenVar) -> _AttrChildrenVar: ... # type: ignore[override] + +# In the DOM, this interface isn't specific to Attr, but our implementation is +# because that's the only place we use it. +class NamedNodeMap: + def __init__(self, attrs: dict[str, Attr], attrsNS: dict[_NSName, Attr], ownerElement: Element) -> None: ... + @property + def length(self) -> int: ... + def item(self, index: int) -> Node | None: ... + def items(self) -> list[tuple[str, str]]: ... + def itemsNS(self) -> list[tuple[_NSName, str]]: ... + def __contains__(self, key: str | _NSName) -> bool: ... + def keys(self) -> dict_keys[str, Attr]: ... + def keysNS(self) -> dict_keys[_NSName, Attr]: ... + def values(self) -> dict_values[str, Attr]: ... + def get(self, name: str, value: Attr | None = None) -> Attr | None: ... + __hash__: ClassVar[None] # type: ignore[assignment] + def __len__(self) -> int: ... + def __eq__(self, other: object) -> bool: ... + def __ge__(self, other: NamedNodeMap) -> bool: ... + def __gt__(self, other: NamedNodeMap) -> bool: ... + def __le__(self, other: NamedNodeMap) -> bool: ... + def __lt__(self, other: NamedNodeMap) -> bool: ... + def __getitem__(self, attname_or_tuple: _NSName | str) -> Attr: ... + def __setitem__(self, attname: str, value: Attr | str) -> None: ... + def getNamedItem(self, name: str) -> Attr | None: ... + def getNamedItemNS(self, namespaceURI: str | None, localName: str) -> Attr | None: ... + def removeNamedItem(self, name: str) -> Attr: ... + def removeNamedItemNS(self, namespaceURI: str | None, localName: str) -> Attr: ... + def setNamedItem(self, node: Attr) -> Attr | None: ... + def setNamedItemNS(self, node: Attr) -> Attr | None: ... + def __delitem__(self, attname_or_tuple: _NSName | str) -> None: ... + +AttributeList = NamedNodeMap + +class TypeInfo: + namespace: str | None + name: str | None + def __init__(self, namespace: Incomplete | None, name: str | None) -> None: ... + +_ElementChildrenVar = TypeVar("_ElementChildrenVar", bound=_ElementChildren) +_ElementChildrenPlusFragment = TypeVar("_ElementChildrenPlusFragment", bound=_ElementChildren | DocumentFragment) + +class Element(Node): + nodeType: ClassVar[Literal[1]] + nodeName: str # same as Element.tagName + nodeValue: None + @property + def attributes(self) -> NamedNodeMap: ... # type: ignore[override] + + parentNode: Document | Element | DocumentFragment | None + nextSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + previousSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + childNodes: NodeList[_ElementChildren] + @property + def firstChild(self) -> _ElementChildren | None: ... + @property + def lastChild(self) -> _ElementChildren | None: ... + + namespaceURI: str | None + prefix: str | None + @property + def localName(self) -> str: ... + + schemaType: TypeInfo + tagName: str + + def __init__( + self, tagName: str, namespaceURI: str | None = None, prefix: str | None = None, localName: str | None = None + ) -> None: ... + def unlink(self) -> None: ... + def getAttribute(self, attname: str) -> str: ... + def getAttributeNS(self, namespaceURI: str | None, localName: str) -> str: ... + def setAttribute(self, attname: str, value: str) -> None: ... + def setAttributeNS(self, namespaceURI: str | None, qualifiedName: str, value: str) -> None: ... + def getAttributeNode(self, attrname: str) -> Attr | None: ... + def getAttributeNodeNS(self, namespaceURI: str | None, localName: str) -> Attr | None: ... + def setAttributeNode(self, attr: Attr) -> Attr | None: ... + setAttributeNodeNS = setAttributeNode + def removeAttribute(self, name: str) -> None: ... + def removeAttributeNS(self, namespaceURI: str | None, localName: str) -> None: ... + def removeAttributeNode(self, node: Attr) -> Attr: ... + removeAttributeNodeNS = removeAttributeNode + def hasAttribute(self, name: str) -> bool: ... + def hasAttributeNS(self, namespaceURI: str | None, localName: str) -> bool: ... + def getElementsByTagName(self, name: str) -> NodeList[Element]: ... + def getElementsByTagNameNS(self, namespaceURI: str | None, localName: str) -> NodeList[Element]: ... + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + def hasAttributes(self) -> bool: ... + def setIdAttribute(self, name: str) -> None: ... + def setIdAttributeNS(self, namespaceURI: str | None, localName: str) -> None: ... + def setIdAttributeNode(self, idAttr: Attr) -> None: ... + def insertBefore( # type: ignore[override] + self, newChild: _ElementChildrenPlusFragment, refChild: _ElementChildren | None + ) -> _ElementChildrenPlusFragment: ... + def appendChild(self, node: _ElementChildrenPlusFragment) -> _ElementChildrenPlusFragment: ... # type: ignore[override] + @overload # type: ignore[override] + def replaceChild( + self, newChild: DocumentFragment, oldChild: _ElementChildrenVar + ) -> _ElementChildrenVar | DocumentFragment: ... + @overload + def replaceChild(self, newChild: _ElementChildren, oldChild: _ElementChildrenVar) -> _ElementChildrenVar | None: ... # type: ignore[override] + def removeChild(self, oldChild: _ElementChildrenVar) -> _ElementChildrenVar: ... # type: ignore[override] + +class Childless: + attributes: None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + def appendChild(self, node: _NodesThatAreChildren | DocumentFragment) -> NoReturn: ... + def hasChildNodes(self) -> Literal[False]: ... + def insertBefore( + self, newChild: _NodesThatAreChildren | DocumentFragment, refChild: _NodesThatAreChildren | None + ) -> NoReturn: ... + def removeChild(self, oldChild: _NodesThatAreChildren) -> NoReturn: ... + def normalize(self) -> None: ... + def replaceChild(self, newChild: _NodesThatAreChildren | DocumentFragment, oldChild: _NodesThatAreChildren) -> NoReturn: ... + +class ProcessingInstruction(Childless, Node): + nodeType: ClassVar[Literal[7]] + nodeName: str # same as ProcessingInstruction.target + nodeValue: str # same as ProcessingInstruction.data + attributes: None + + parentNode: Document | Element | DocumentFragment | None + nextSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + previousSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + + target: str + data: str + + def __init__(self, target: str, data: str) -> None: ... + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + +class CharacterData(Childless, Node): + nodeValue: str + attributes: None + + childNodes: EmptyNodeList + nextSibling: _NodesThatAreChildren | None + previousSibling: _NodesThatAreChildren | None + + @property + def localName(self) -> None: ... + + ownerDocument: Document | None + data: str + + def __init__(self) -> None: ... + @property + def length(self) -> int: ... + def __len__(self) -> int: ... + def substringData(self, offset: int, count: int) -> str: ... + def appendData(self, arg: str) -> None: ... + def insertData(self, offset: int, arg: str) -> None: ... + def deleteData(self, offset: int, count: int) -> None: ... + def replaceData(self, offset: int, count: int, arg: str) -> None: ... + +class Text(CharacterData): + nodeType: ClassVar[Literal[3]] + nodeName: Literal["#text"] + nodeValue: str # same as CharacterData.data, the content of the text node + attributes: None + + parentNode: Attr | Element | DocumentFragment | None + nextSibling: _DocumentFragmentChildren | _ElementChildren | _AttrChildren | None + previousSibling: _DocumentFragmentChildren | _ElementChildren | _AttrChildren | None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + + data: str + def splitText(self, offset: int) -> Self: ... + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + def replaceWholeText(self, content: str) -> Self | None: ... + @property + def isWhitespaceInElementContent(self) -> bool: ... + @property + def wholeText(self) -> str: ... + +class Comment(CharacterData): + nodeType: ClassVar[Literal[8]] + nodeName: Literal["#comment"] + nodeValue: str # same as CharacterData.data, the content of the comment + attributes: None + + parentNode: Document | Element | DocumentFragment | None + nextSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + previousSibling: _DocumentChildren | _ElementChildren | _DocumentFragmentChildren | None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + def __init__(self, data: str) -> None: ... + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + +class CDATASection(Text): + nodeType: ClassVar[Literal[4]] # type: ignore[assignment] + nodeName: Literal["#cdata-section"] # type: ignore[assignment] + nodeValue: str # same as CharacterData.data, the content of the CDATA Section + attributes: None + + parentNode: Element | DocumentFragment | None + nextSibling: _DocumentFragmentChildren | _ElementChildren | None + previousSibling: _DocumentFragmentChildren | _ElementChildren | None + + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + +class ReadOnlySequentialNamedNodeMap(Generic[_N]): + def __init__(self, seq: Sequence[_N] = ()) -> None: ... + def __len__(self) -> int: ... + def getNamedItem(self, name: str) -> _N | None: ... + def getNamedItemNS(self, namespaceURI: str | None, localName: str) -> _N | None: ... + def __getitem__(self, name_or_tuple: str | _NSName) -> _N | None: ... + def item(self, index: int) -> _N | None: ... + def removeNamedItem(self, name: str) -> NoReturn: ... + def removeNamedItemNS(self, namespaceURI: str | None, localName: str) -> NoReturn: ... + def setNamedItem(self, node: Node) -> NoReturn: ... + def setNamedItemNS(self, node: Node) -> NoReturn: ... + @property + def length(self) -> int: ... + +class Identified: + publicId: str | None + systemId: str | None + +class DocumentType(Identified, Childless, Node): + nodeType: ClassVar[Literal[10]] + nodeName: str | None # same as DocumentType.name + nodeValue: None + attributes: None + + parentNode: Document | None + nextSibling: _DocumentChildren | None + previousSibling: _DocumentChildren | None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + + name: str | None + internalSubset: str | None + entities: ReadOnlySequentialNamedNodeMap[Entity] + notations: ReadOnlySequentialNamedNodeMap[Notation] + + def __init__(self, qualifiedName: str | None) -> None: ... + def cloneNode(self, deep: bool) -> DocumentType | None: ... + def writexml(self, writer: SupportsWrite[str], indent: str = "", addindent: str = "", newl: str = "") -> None: ... + +class Entity(Identified, Node): + nodeType: ClassVar[Literal[6]] + nodeName: str # entity name + nodeValue: None + attributes: None + + parentNode: None + nextSibling: None + previousSibling: None + childNodes: NodeList[_EntityChildren] + @property + def firstChild(self) -> _EntityChildren | None: ... + @property + def lastChild(self) -> _EntityChildren | None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + + actualEncoding: str | None + encoding: str | None + version: str | None + notationName: str | None + + def __init__(self, name: str, publicId: str | None, systemId: str | None, notation: str | None) -> None: ... + def appendChild(self, newChild: _EntityChildren) -> NoReturn: ... # type: ignore[override] + def insertBefore(self, newChild: _EntityChildren, refChild: _EntityChildren | None) -> NoReturn: ... # type: ignore[override] + def removeChild(self, oldChild: _EntityChildren) -> NoReturn: ... # type: ignore[override] + def replaceChild(self, newChild: _EntityChildren, oldChild: _EntityChildren) -> NoReturn: ... # type: ignore[override] + +class Notation(Identified, Childless, Node): + nodeType: ClassVar[Literal[12]] + nodeName: str # notation name + nodeValue: None + attributes: None + + parentNode: DocumentFragment | None + nextSibling: _DocumentFragmentChildren | None + previousSibling: _DocumentFragmentChildren | None + childNodes: EmptyNodeList + @property + def firstChild(self) -> None: ... + @property + def lastChild(self) -> None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + def __init__(self, name: str, publicId: str | None, systemId: str | None) -> None: ... + +class DOMImplementation(DOMImplementationLS): + def hasFeature(self, feature: str, version: str | None) -> bool: ... + def createDocument(self, namespaceURI: str | None, qualifiedName: str | None, doctype: DocumentType | None) -> Document: ... + def createDocumentType(self, qualifiedName: str | None, publicId: str | None, systemId: str | None) -> DocumentType: ... + def getInterface(self, feature: str) -> Self | None: ... + +class ElementInfo: + tagName: str + def __init__(self, name: str) -> None: ... + def getAttributeType(self, aname: str) -> TypeInfo: ... + def getAttributeTypeNS(self, namespaceURI: str | None, localName: str) -> TypeInfo: ... + def isElementContent(self) -> bool: ... + def isEmpty(self) -> bool: ... + def isId(self, aname: str) -> bool: ... + def isIdNS(self, namespaceURI: str | None, localName: str) -> bool: ... + +_DocumentChildrenPlusFragment = TypeVar("_DocumentChildrenPlusFragment", bound=_DocumentChildren | DocumentFragment) + +class Document(Node, DocumentLS): + nodeType: ClassVar[Literal[9]] + nodeName: Literal["#document"] + nodeValue: None + attributes: None + + parentNode: None + previousSibling: None + nextSibling: None + childNodes: NodeList[_DocumentChildren] + @property + def firstChild(self) -> _DocumentChildren | None: ... + @property + def lastChild(self) -> _DocumentChildren | None: ... + + namespaceURI: None + prefix: None + @property + def localName(self) -> None: ... + + implementation: DOMImplementation + actualEncoding: str | None + encoding: str | None + standalone: bool | None + version: str | None + strictErrorChecking: bool + errorHandler: _DOMErrorHandler | None + documentURI: str | None + doctype: DocumentType | None + documentElement: Element | None + + def __init__(self) -> None: ... + def appendChild(self, node: _DocumentChildrenVar) -> _DocumentChildrenVar: ... # type: ignore[override] + def removeChild(self, oldChild: _DocumentChildrenVar) -> _DocumentChildrenVar: ... # type: ignore[override] + def unlink(self) -> None: ... + def cloneNode(self, deep: bool) -> Document | None: ... + def createDocumentFragment(self) -> DocumentFragment: ... + def createElement(self, tagName: str) -> Element: ... + def createTextNode(self, data: str) -> Text: ... + def createCDATASection(self, data: str) -> CDATASection: ... + def createComment(self, data: str) -> Comment: ... + def createProcessingInstruction(self, target: str, data: str) -> ProcessingInstruction: ... + def createAttribute(self, qName: str) -> Attr: ... + def createElementNS(self, namespaceURI: str | None, qualifiedName: str) -> Element: ... + def createAttributeNS(self, namespaceURI: str | None, qualifiedName: str) -> Attr: ... + def getElementById(self, id: str) -> Element | None: ... + def getElementsByTagName(self, name: str) -> NodeList[Element]: ... + def getElementsByTagNameNS(self, namespaceURI: str | None, localName: str) -> NodeList[Element]: ... + def isSupported(self, feature: str, version: str | None) -> bool: ... + def importNode(self, node: _ImportableNodeVar, deep: bool) -> _ImportableNodeVar: ... + def writexml( + self, + writer: SupportsWrite[str], + indent: str = "", + addindent: str = "", + newl: str = "", + encoding: str | None = None, + standalone: bool | None = None, + ) -> None: ... + @overload + def renameNode(self, n: Element, namespaceURI: str, name: str) -> Element: ... + @overload + def renameNode(self, n: Attr, namespaceURI: str, name: str) -> Attr: ... + @overload + def renameNode(self, n: Element | Attr, namespaceURI: str, name: str) -> Element | Attr: ... + def insertBefore( + self, newChild: _DocumentChildrenPlusFragment, refChild: _DocumentChildren | None # type: ignore[override] + ) -> _DocumentChildrenPlusFragment: ... + @overload # type: ignore[override] + def replaceChild( + self, newChild: DocumentFragment, oldChild: _DocumentChildrenVar + ) -> _DocumentChildrenVar | DocumentFragment: ... + @overload + def replaceChild(self, newChild: _DocumentChildren, oldChild: _DocumentChildrenVar) -> _DocumentChildrenVar | None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi new file mode 100644 index 0000000000000..d9458654c1853 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/pulldom.pyi @@ -0,0 +1,109 @@ +import sys +from _typeshed import Incomplete, Unused +from collections.abc import MutableSequence, Sequence +from typing import Final, Literal, NoReturn +from typing_extensions import Self, TypeAlias +from xml.dom.minidom import Comment, Document, DOMImplementation, Element, ProcessingInstruction, Text +from xml.sax import _SupportsReadClose +from xml.sax.handler import ContentHandler +from xml.sax.xmlreader import AttributesImpl, AttributesNSImpl, Locator, XMLReader + +START_ELEMENT: Final = "START_ELEMENT" +END_ELEMENT: Final = "END_ELEMENT" +COMMENT: Final = "COMMENT" +START_DOCUMENT: Final = "START_DOCUMENT" +END_DOCUMENT: Final = "END_DOCUMENT" +PROCESSING_INSTRUCTION: Final = "PROCESSING_INSTRUCTION" +IGNORABLE_WHITESPACE: Final = "IGNORABLE_WHITESPACE" +CHARACTERS: Final = "CHARACTERS" + +_NSName: TypeAlias = tuple[str | None, str] +_DocumentFactory: TypeAlias = DOMImplementation | None + +_Event: TypeAlias = ( + tuple[Literal["START_ELEMENT"], Element] + | tuple[Literal["END_ELEMENT"], Element] + | tuple[Literal["COMMENT"], Comment] + | tuple[Literal["START_DOCUMENT"], Document] + | tuple[Literal["END_DOCUMENT"], Document] + | tuple[Literal["PROCESSING_INSTRUCTION"], ProcessingInstruction] + | tuple[Literal["IGNORABLE_WHITESPACE"], Text] + | tuple[Literal["CHARACTERS"], Text] +) + +class PullDOM(ContentHandler): + document: Document | None + documentFactory: _DocumentFactory + + # firstEvent is a list of length 2 + # firstEvent[0] is always None + # firstEvent[1] is None prior to any events, after which it's a + # list of length 2, where the first item is of type _Event + # and the second item is None. + firstEvent: list[Incomplete] + + # lastEvent is also a list of length 2. The second item is always None, + # and the first item is of type _Event + # This is a slight lie: The second item is sometimes temporarily what was just + # described for the type of lastEvent, after which lastEvent is always updated + # with `self.lastEvent = self.lastEvent[1]`. + lastEvent: list[Incomplete] + + elementStack: MutableSequence[Element | Document] + pending_events: ( + list[Sequence[tuple[Literal["COMMENT"], str] | tuple[Literal["PROCESSING_INSTRUCTION"], str, str] | None]] | None + ) + def __init__(self, documentFactory: _DocumentFactory = None) -> None: ... + def pop(self) -> Element | Document: ... + def setDocumentLocator(self, locator: Locator) -> None: ... + def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... + def endPrefixMapping(self, prefix: str | None) -> None: ... + def startElementNS(self, name: _NSName, tagName: str | None, attrs: AttributesNSImpl) -> None: ... + def endElementNS(self, name: _NSName, tagName: str | None) -> None: ... + def startElement(self, name: str, attrs: AttributesImpl) -> None: ... + def endElement(self, name: str) -> None: ... + def comment(self, s: str) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + def ignorableWhitespace(self, chars: str) -> None: ... + def characters(self, chars: str) -> None: ... + def startDocument(self) -> None: ... + def buildDocument(self, uri: str | None, tagname: str | None) -> Element: ... + def endDocument(self) -> None: ... + def clear(self) -> None: ... + +class ErrorHandler: + def warning(self, exception: BaseException) -> None: ... + def error(self, exception: BaseException) -> NoReturn: ... + def fatalError(self, exception: BaseException) -> NoReturn: ... + +class DOMEventStream: + stream: _SupportsReadClose[bytes] | _SupportsReadClose[str] + parser: XMLReader # Set to none after .clear() is called + bufsize: int + pulldom: PullDOM + def __init__(self, stream: _SupportsReadClose[bytes] | _SupportsReadClose[str], parser: XMLReader, bufsize: int) -> None: ... + if sys.version_info < (3, 11): + def __getitem__(self, pos: Unused) -> _Event: ... + + def __next__(self) -> _Event: ... + def __iter__(self) -> Self: ... + def getEvent(self) -> _Event | None: ... + def expandNode(self, node: Document) -> None: ... + def reset(self) -> None: ... + def clear(self) -> None: ... + +class SAX2DOM(PullDOM): + def startElementNS(self, name: _NSName, tagName: str | None, attrs: AttributesNSImpl) -> None: ... + def startElement(self, name: str, attrs: AttributesImpl) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + def ignorableWhitespace(self, chars: str) -> None: ... + def characters(self, chars: str) -> None: ... + +default_bufsize: int + +def parse( + stream_or_string: str | _SupportsReadClose[bytes] | _SupportsReadClose[str], + parser: XMLReader | None = None, + bufsize: int | None = None, +) -> DOMEventStream: ... +def parseString(string: str, parser: XMLReader | None = None) -> DOMEventStream: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi new file mode 100644 index 0000000000000..6fb18bbc4eda3 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/dom/xmlbuilder.pyi @@ -0,0 +1,79 @@ +from _typeshed import SupportsRead +from typing import Any, Literal, NoReturn +from xml.dom.minidom import Document, Node, _DOMErrorHandler + +__all__ = ["DOMBuilder", "DOMEntityResolver", "DOMInputSource"] + +class Options: + namespaces: int + namespace_declarations: bool + validation: bool + external_parameter_entities: bool + external_general_entities: bool + external_dtd_subset: bool + validate_if_schema: bool + validate: bool + datatype_normalization: bool + create_entity_ref_nodes: bool + entities: bool + whitespace_in_element_content: bool + cdata_sections: bool + comments: bool + charset_overrides_xml_encoding: bool + infoset: bool + supported_mediatypes_only: bool + errorHandler: _DOMErrorHandler | None + filter: DOMBuilderFilter | None + +class DOMBuilder: + entityResolver: DOMEntityResolver | None + errorHandler: _DOMErrorHandler | None + filter: DOMBuilderFilter | None + ACTION_REPLACE: Literal[1] + ACTION_APPEND_AS_CHILDREN: Literal[2] + ACTION_INSERT_AFTER: Literal[3] + ACTION_INSERT_BEFORE: Literal[4] + def __init__(self) -> None: ... + def setFeature(self, name: str, state: int) -> None: ... + def supportsFeature(self, name: str) -> bool: ... + def canSetFeature(self, name: str, state: Literal[1, 0]) -> bool: ... + # getFeature could return any attribute from an instance of `Options` + def getFeature(self, name: str) -> Any: ... + def parseURI(self, uri: str) -> Document: ... + def parse(self, input: DOMInputSource) -> Document: ... + def parseWithContext(self, input: DOMInputSource, cnode: Node, action: Literal[1, 2, 3, 4]) -> NoReturn: ... + +class DOMEntityResolver: + def resolveEntity(self, publicId: str | None, systemId: str) -> DOMInputSource: ... + +class DOMInputSource: + byteStream: SupportsRead[bytes] | None + characterStream: SupportsRead[str] | None + stringData: str | None + encoding: str | None + publicId: str | None + systemId: str | None + baseURI: str | None + +class DOMBuilderFilter: + FILTER_ACCEPT: Literal[1] + FILTER_REJECT: Literal[2] + FILTER_SKIP: Literal[3] + FILTER_INTERRUPT: Literal[4] + whatToShow: int + def acceptNode(self, element: Node) -> Literal[1, 2, 3, 4]: ... + def startContainer(self, element: Node) -> Literal[1, 2, 3, 4]: ... + +class DocumentLS: + async_: bool + def abort(self) -> NoReturn: ... + def load(self, uri: str) -> NoReturn: ... + def loadXML(self, source: str) -> NoReturn: ... + def saveXML(self, snode: Node | None) -> str: ... + +class DOMImplementationLS: + MODE_SYNCHRONOUS: Literal[1] + MODE_ASYNCHRONOUS: Literal[2] + def createDOMBuilder(self, mode: Literal[1], schemaType: None) -> DOMBuilder: ... + def createDOMWriter(self) -> NoReturn: ... + def createDOMInputSource(self) -> DOMInputSource: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi new file mode 100644 index 0000000000000..8f20ee15a14e5 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementInclude.pyi @@ -0,0 +1,25 @@ +from _typeshed import FileDescriptorOrPath +from typing import Final, Literal, Protocol, overload +from xml.etree.ElementTree import Element + +class _Loader(Protocol): + @overload + def __call__(self, href: FileDescriptorOrPath, parse: Literal["xml"], encoding: str | None = None) -> Element: ... + @overload + def __call__(self, href: FileDescriptorOrPath, parse: Literal["text"], encoding: str | None = None) -> str: ... + +XINCLUDE: Final[str] +XINCLUDE_INCLUDE: Final[str] +XINCLUDE_FALLBACK: Final[str] + +DEFAULT_MAX_INCLUSION_DEPTH: Final = 6 + +class FatalIncludeError(SyntaxError): ... + +@overload +def default_loader(href: FileDescriptorOrPath, parse: Literal["xml"], encoding: str | None = None) -> Element: ... +@overload +def default_loader(href: FileDescriptorOrPath, parse: Literal["text"], encoding: str | None = None) -> str: ... +def include(elem: Element, loader: _Loader | None = None, base_url: str | None = None, max_depth: int | None = 6) -> None: ... + +class LimitedRecursiveIncludeError(FatalIncludeError): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi new file mode 100644 index 0000000000000..ebfb4f1ffbb9c --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementPath.pyi @@ -0,0 +1,41 @@ +from collections.abc import Callable, Generator, Iterable +from re import Pattern +from typing import Any, Literal, TypeVar, overload +from typing_extensions import TypeAlias +from xml.etree.ElementTree import Element + +xpath_tokenizer_re: Pattern[str] + +_Token: TypeAlias = tuple[str, str] +_Next: TypeAlias = Callable[[], _Token] +_Callback: TypeAlias = Callable[[_SelectorContext, Iterable[Element]], Generator[Element, None, None]] +_T = TypeVar("_T") + +def xpath_tokenizer(pattern: str, namespaces: dict[str, str] | None = None) -> Generator[_Token, None, None]: ... +def get_parent_map(context: _SelectorContext) -> dict[Element, Element]: ... +def prepare_child(next: _Next, token: _Token) -> _Callback: ... +def prepare_star(next: _Next, token: _Token) -> _Callback: ... +def prepare_self(next: _Next, token: _Token) -> _Callback: ... +def prepare_descendant(next: _Next, token: _Token) -> _Callback | None: ... +def prepare_parent(next: _Next, token: _Token) -> _Callback: ... +def prepare_predicate(next: _Next, token: _Token) -> _Callback | None: ... + +ops: dict[str, Callable[[_Next, _Token], _Callback | None]] + +class _SelectorContext: + parent_map: dict[Element, Element] | None + root: Element + def __init__(self, root: Element) -> None: ... + +@overload +def iterfind( # type: ignore[overload-overlap] + elem: Element[Any], path: Literal[""], namespaces: dict[str, str] | None = None +) -> None: ... +@overload +def iterfind(elem: Element[Any], path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... +def find(elem: Element[Any], path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... +def findall(elem: Element[Any], path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... +@overload +def findtext(elem: Element[Any], path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ... +@overload +def findtext(elem: Element[Any], path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi new file mode 100644 index 0000000000000..4c55a1a7452ef --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/ElementTree.pyi @@ -0,0 +1,364 @@ +import sys +from _collections_abc import dict_keys +from _typeshed import FileDescriptorOrPath, ReadableBuffer, SupportsRead, SupportsWrite +from collections.abc import Callable, Generator, ItemsView, Iterable, Iterator, Mapping, Sequence +from typing import Any, Final, Generic, Literal, Protocol, SupportsIndex, TypeVar, overload, type_check_only +from typing_extensions import TypeAlias, TypeGuard, deprecated +from xml.parsers.expat import XMLParserType + +__all__ = [ + "C14NWriterTarget", + "Comment", + "dump", + "Element", + "ElementTree", + "canonicalize", + "fromstring", + "fromstringlist", + "indent", + "iselement", + "iterparse", + "parse", + "ParseError", + "PI", + "ProcessingInstruction", + "QName", + "SubElement", + "tostring", + "tostringlist", + "TreeBuilder", + "VERSION", + "XML", + "XMLID", + "XMLParser", + "XMLPullParser", + "register_namespace", +] + +_T = TypeVar("_T") +_FileRead: TypeAlias = FileDescriptorOrPath | SupportsRead[bytes] | SupportsRead[str] +_FileWriteC14N: TypeAlias = FileDescriptorOrPath | SupportsWrite[bytes] +_FileWrite: TypeAlias = _FileWriteC14N | SupportsWrite[str] + +VERSION: Final[str] + +class ParseError(SyntaxError): + code: int + position: tuple[int, int] + +# In reality it works based on `.tag` attribute duck typing. +def iselement(element: object) -> TypeGuard[Element]: ... +@overload +def canonicalize( + xml_data: str | ReadableBuffer | None = None, + *, + out: None = None, + from_file: _FileRead | None = None, + with_comments: bool = False, + strip_text: bool = False, + rewrite_prefixes: bool = False, + qname_aware_tags: Iterable[str] | None = None, + qname_aware_attrs: Iterable[str] | None = None, + exclude_attrs: Iterable[str] | None = None, + exclude_tags: Iterable[str] | None = None, +) -> str: ... +@overload +def canonicalize( + xml_data: str | ReadableBuffer | None = None, + *, + out: SupportsWrite[str], + from_file: _FileRead | None = None, + with_comments: bool = False, + strip_text: bool = False, + rewrite_prefixes: bool = False, + qname_aware_tags: Iterable[str] | None = None, + qname_aware_attrs: Iterable[str] | None = None, + exclude_attrs: Iterable[str] | None = None, + exclude_tags: Iterable[str] | None = None, +) -> None: ... + +# The tag for Element can be set to the Comment or ProcessingInstruction +# functions defined in this module. _ElementCallable could be a recursive +# type, but defining it that way uncovered a bug in pytype. +_ElementCallable: TypeAlias = Callable[..., Element[Any]] +_CallableElement: TypeAlias = Element[_ElementCallable] + +_Tag = TypeVar("_Tag", default=str, bound=str | _ElementCallable) +_OtherTag = TypeVar("_OtherTag", default=str, bound=str | _ElementCallable) + +class Element(Generic[_Tag]): + tag: _Tag + attrib: dict[str, str] + text: str | None + tail: str | None + def __init__(self, tag: _Tag, attrib: dict[str, str] = {}, **extra: str) -> None: ... + def append(self, subelement: Element[Any], /) -> None: ... + def clear(self) -> None: ... + def extend(self, elements: Iterable[Element], /) -> None: ... + def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... + def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... + @overload + def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ... + @overload + def findtext(self, path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ... + @overload + def get(self, key: str, default: None = None) -> str | None: ... + @overload + def get(self, key: str, default: _T) -> str | _T: ... + def insert(self, index: int, subelement: Element, /) -> None: ... + def items(self) -> ItemsView[str, str]: ... + def iter(self, tag: str | None = None) -> Generator[Element, None, None]: ... + @overload + def iterfind(self, path: Literal[""], namespaces: dict[str, str] | None = None) -> None: ... # type: ignore[overload-overlap] + @overload + def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... + def itertext(self) -> Generator[str, None, None]: ... + def keys(self) -> dict_keys[str, str]: ... + # makeelement returns the type of self in Python impl, but not in C impl + def makeelement(self, tag: _OtherTag, attrib: dict[str, str], /) -> Element[_OtherTag]: ... + def remove(self, subelement: Element, /) -> None: ... + def set(self, key: str, value: str, /) -> None: ... + def __copy__(self) -> Element[_Tag]: ... # returns the type of self in Python impl, but not in C impl + def __deepcopy__(self, memo: Any, /) -> Element: ... # Only exists in C impl + def __delitem__(self, key: SupportsIndex | slice, /) -> None: ... + @overload + def __getitem__(self, key: SupportsIndex, /) -> Element: ... + @overload + def __getitem__(self, key: slice, /) -> list[Element]: ... + def __len__(self) -> int: ... + # Doesn't actually exist at runtime, but instance of the class are indeed iterable due to __getitem__. + def __iter__(self) -> Iterator[Element]: ... + @overload + def __setitem__(self, key: SupportsIndex, value: Element, /) -> None: ... + @overload + def __setitem__(self, key: slice, value: Iterable[Element], /) -> None: ... + + # Doesn't really exist in earlier versions, where __len__ is called implicitly instead + @deprecated("Testing an element's truth value is deprecated.") + def __bool__(self) -> bool: ... + +def SubElement(parent: Element, tag: str, attrib: dict[str, str] = ..., **extra: str) -> Element: ... +def Comment(text: str | None = None) -> _CallableElement: ... +def ProcessingInstruction(target: str, text: str | None = None) -> _CallableElement: ... + +PI = ProcessingInstruction + +class QName: + text: str + def __init__(self, text_or_uri: str, tag: str | None = None) -> None: ... + def __lt__(self, other: QName | str) -> bool: ... + def __le__(self, other: QName | str) -> bool: ... + def __gt__(self, other: QName | str) -> bool: ... + def __ge__(self, other: QName | str) -> bool: ... + def __eq__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + +_Root = TypeVar("_Root", Element, Element | None, default=Element | None) + +class ElementTree(Generic[_Root]): + def __init__(self, element: Element | None = None, file: _FileRead | None = None) -> None: ... + def getroot(self) -> _Root: ... + def parse(self, source: _FileRead, parser: XMLParser | None = None) -> Element: ... + def iter(self, tag: str | None = None) -> Generator[Element, None, None]: ... + def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ... + @overload + def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ... + @overload + def findtext(self, path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ... + def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ... + @overload + def iterfind(self, path: Literal[""], namespaces: dict[str, str] | None = None) -> None: ... # type: ignore[overload-overlap] + @overload + def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element, None, None]: ... + def write( + self, + file_or_filename: _FileWrite, + encoding: str | None = None, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + short_empty_elements: bool = True, + ) -> None: ... + def write_c14n(self, file: _FileWriteC14N) -> None: ... + +HTML_EMPTY: set[str] + +def register_namespace(prefix: str, uri: str) -> None: ... +@overload +def tostring( + element: Element, + encoding: None = None, + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> bytes: ... +@overload +def tostring( + element: Element, + encoding: Literal["unicode"], + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> str: ... +@overload +def tostring( + element: Element, + encoding: str, + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> Any: ... +@overload +def tostringlist( + element: Element, + encoding: None = None, + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> list[bytes]: ... +@overload +def tostringlist( + element: Element, + encoding: Literal["unicode"], + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> list[str]: ... +@overload +def tostringlist( + element: Element, + encoding: str, + method: Literal["xml", "html", "text", "c14n"] | None = None, + *, + xml_declaration: bool | None = None, + default_namespace: str | None = None, + short_empty_elements: bool = True, +) -> list[Any]: ... +def dump(elem: Element | ElementTree[Any]) -> None: ... +def indent(tree: Element | ElementTree[Any], space: str = " ", level: int = 0) -> None: ... +def parse(source: _FileRead, parser: XMLParser[Any] | None = None) -> ElementTree[Element]: ... + +# This class is defined inside the body of iterparse +@type_check_only +class _IterParseIterator(Iterator[tuple[str, Element]], Protocol): + def __next__(self) -> tuple[str, Element]: ... + if sys.version_info >= (3, 13): + def close(self) -> None: ... + if sys.version_info >= (3, 11): + def __del__(self) -> None: ... + +def iterparse(source: _FileRead, events: Sequence[str] | None = None, parser: XMLParser | None = None) -> _IterParseIterator: ... + +_EventQueue: TypeAlias = tuple[str] | tuple[str, tuple[str, str]] | tuple[str, None] + +class XMLPullParser(Generic[_E]): + def __init__(self, events: Sequence[str] | None = None, *, _parser: XMLParser[_E] | None = None) -> None: ... + def feed(self, data: str | ReadableBuffer) -> None: ... + def close(self) -> None: ... + def read_events(self) -> Iterator[_EventQueue | tuple[str, _E]]: ... + def flush(self) -> None: ... + +def XML(text: str | ReadableBuffer, parser: XMLParser | None = None) -> Element: ... +def XMLID(text: str | ReadableBuffer, parser: XMLParser | None = None) -> tuple[Element, dict[str, Element]]: ... + +# This is aliased to XML in the source. +fromstring = XML + +def fromstringlist(sequence: Sequence[str | ReadableBuffer], parser: XMLParser | None = None) -> Element: ... + +# This type is both not precise enough and too precise. The TreeBuilder +# requires the elementfactory to accept tag and attrs in its args and produce +# some kind of object that has .text and .tail properties. +# I've chosen to constrain the ElementFactory to always produce an Element +# because that is how almost everyone will use it. +# Unfortunately, the type of the factory arguments is dependent on how +# TreeBuilder is called by client code (they could pass strs, bytes or whatever); +# but we don't want to use a too-broad type, or it would be too hard to write +# elementfactories. +_ElementFactory: TypeAlias = Callable[[Any, dict[Any, Any]], Element] + +class TreeBuilder: + # comment_factory can take None because passing None to Comment is not an error + def __init__( + self, + element_factory: _ElementFactory | None = None, + *, + comment_factory: Callable[[str | None], Element[Any]] | None = None, + pi_factory: Callable[[str, str | None], Element[Any]] | None = None, + insert_comments: bool = False, + insert_pis: bool = False, + ) -> None: ... + insert_comments: bool + insert_pis: bool + + def close(self) -> Element: ... + def data(self, data: str, /) -> None: ... + # tag and attrs are passed to the element_factory, so they could be anything + # depending on what the particular factory supports. + def start(self, tag: Any, attrs: dict[Any, Any], /) -> Element: ... + def end(self, tag: str, /) -> Element: ... + # These two methods have pos-only parameters in the C implementation + def comment(self, text: str | None, /) -> Element[Any]: ... + def pi(self, target: str, text: str | None = None, /) -> Element[Any]: ... + +class C14NWriterTarget: + def __init__( + self, + write: Callable[[str], object], + *, + with_comments: bool = False, + strip_text: bool = False, + rewrite_prefixes: bool = False, + qname_aware_tags: Iterable[str] | None = None, + qname_aware_attrs: Iterable[str] | None = None, + exclude_attrs: Iterable[str] | None = None, + exclude_tags: Iterable[str] | None = None, + ) -> None: ... + def data(self, data: str) -> None: ... + def start_ns(self, prefix: str, uri: str) -> None: ... + def start(self, tag: str, attrs: Mapping[str, str]) -> None: ... + def end(self, tag: str) -> None: ... + def comment(self, text: str) -> None: ... + def pi(self, target: str, data: str) -> None: ... + +# The target type is tricky, because the implementation doesn't +# require any particular attribute to be present. This documents the attributes +# that can be present, but uncommenting any of them would require them. +class _Target(Protocol): + # start: Callable[str, dict[str, str], Any] | None + # end: Callable[[str], Any] | None + # start_ns: Callable[[str, str], Any] | None + # end_ns: Callable[[str], Any] | None + # data: Callable[[str], Any] | None + # comment: Callable[[str], Any] + # pi: Callable[[str, str], Any] | None + # close: Callable[[], Any] | None + ... + +_E = TypeVar("_E", default=Element) + +# This is generic because the return type of close() depends on the target. +# The default target is TreeBuilder, which returns Element. +# C14NWriterTarget does not implement a close method, so using it results +# in a type of XMLParser[None]. +class XMLParser(Generic[_E]): + parser: XMLParserType + target: _Target + # TODO: what is entity used for??? + entity: dict[str, str] + version: str + def __init__(self, *, target: _Target | None = None, encoding: str | None = None) -> None: ... + def close(self) -> _E: ... + def feed(self, data: str | ReadableBuffer, /) -> None: ... + def flush(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/__init__.pyi new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/cElementTree.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/cElementTree.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/etree/cElementTree.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/etree/cElementTree.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/__init__.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/errors.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/errors.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/errors.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/errors.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/model.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/model.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/parsers/expat/model.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/parsers/expat/model.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/__init__.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xml/sax/__init__.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/__init__.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi new file mode 100644 index 0000000000000..e9cc8856a9c8d --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/_exceptions.pyi @@ -0,0 +1,19 @@ +from typing import NoReturn +from xml.sax.xmlreader import Locator + +class SAXException(Exception): + def __init__(self, msg: str, exception: Exception | None = None) -> None: ... + def getMessage(self) -> str: ... + def getException(self) -> Exception | None: ... + def __getitem__(self, ix: object) -> NoReturn: ... + +class SAXParseException(SAXException): + def __init__(self, msg: str, exception: Exception | None, locator: Locator) -> None: ... + def getColumnNumber(self) -> int | None: ... + def getLineNumber(self) -> int | None: ... + def getPublicId(self) -> str | None: ... + def getSystemId(self) -> str | None: ... + +class SAXNotRecognizedException(SAXException): ... +class SAXNotSupportedException(SAXException): ... +class SAXReaderNotAvailable(SAXNotSupportedException): ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/expatreader.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/expatreader.pyi new file mode 100644 index 0000000000000..012d6c03e1219 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/expatreader.pyi @@ -0,0 +1,78 @@ +import sys +from _typeshed import ReadableBuffer +from collections.abc import Mapping +from typing import Any, Literal, overload +from typing_extensions import TypeAlias +from xml.sax import _Source, xmlreader +from xml.sax.handler import _ContentHandlerProtocol + +if sys.version_info >= (3, 10): + from xml.sax.handler import LexicalHandler + +_BoolType: TypeAlias = Literal[0, 1] | bool + +version: str +AttributesImpl = xmlreader.AttributesImpl +AttributesNSImpl = xmlreader.AttributesNSImpl + +class _ClosedParser: + ErrorColumnNumber: int + ErrorLineNumber: int + +class ExpatLocator(xmlreader.Locator): + def __init__(self, parser: ExpatParser) -> None: ... + def getColumnNumber(self) -> int | None: ... + def getLineNumber(self) -> int: ... + def getPublicId(self) -> str | None: ... + def getSystemId(self) -> str | None: ... + +class ExpatParser(xmlreader.IncrementalParser, xmlreader.Locator): + def __init__(self, namespaceHandling: _BoolType = 0, bufsize: int = 65516) -> None: ... + def parse(self, source: xmlreader.InputSource | _Source) -> None: ... + def prepareParser(self, source: xmlreader.InputSource) -> None: ... + def setContentHandler(self, handler: _ContentHandlerProtocol) -> None: ... + def getFeature(self, name: str) -> _BoolType: ... + def setFeature(self, name: str, state: _BoolType) -> None: ... + if sys.version_info >= (3, 10): + @overload + def getProperty(self, name: Literal["http://xml.org/sax/properties/lexical-handler"]) -> LexicalHandler | None: ... + + @overload + def getProperty(self, name: Literal["http://www.python.org/sax/properties/interning-dict"]) -> dict[str, Any] | None: ... + @overload + def getProperty(self, name: Literal["http://xml.org/sax/properties/xml-string"]) -> bytes | None: ... + @overload + def getProperty(self, name: str) -> object: ... + if sys.version_info >= (3, 10): + @overload + def setProperty(self, name: Literal["http://xml.org/sax/properties/lexical-handler"], value: LexicalHandler) -> None: ... + + @overload + def setProperty( + self, name: Literal["http://www.python.org/sax/properties/interning-dict"], value: dict[str, Any] + ) -> None: ... + @overload + def setProperty(self, name: str, value: object) -> None: ... + def feed(self, data: str | ReadableBuffer, isFinal: bool = False) -> None: ... + def flush(self) -> None: ... + def close(self) -> None: ... + def reset(self) -> None: ... + def getColumnNumber(self) -> int | None: ... + def getLineNumber(self) -> int: ... + def getPublicId(self) -> str | None: ... + def getSystemId(self) -> str | None: ... + def start_element(self, name: str, attrs: Mapping[str, str]) -> None: ... + def end_element(self, name: str) -> None: ... + def start_element_ns(self, name: str, attrs: Mapping[str, str]) -> None: ... + def end_element_ns(self, name: str) -> None: ... + def processing_instruction(self, target: str, data: str) -> None: ... + def character_data(self, data: str) -> None: ... + def start_namespace_decl(self, prefix: str | None, uri: str) -> None: ... + def end_namespace_decl(self, prefix: str | None) -> None: ... + def start_doctype_decl(self, name: str, sysid: str | None, pubid: str | None, has_internal_subset: bool) -> None: ... + def unparsed_entity_decl(self, name: str, base: str | None, sysid: str, pubid: str | None, notation_name: str) -> None: ... + def notation_decl(self, name: str, base: str | None, sysid: str, pubid: str | None) -> None: ... + def external_entity_ref(self, context: str, base: str | None, sysid: str, pubid: str | None) -> int: ... + def skipped_entity_handler(self, name: str, is_pe: bool) -> None: ... + +def create_parser(namespaceHandling: int = 0, bufsize: int = 65516) -> ExpatParser: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi new file mode 100644 index 0000000000000..5509117345968 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/handler.pyi @@ -0,0 +1,86 @@ +import sys +from typing import Literal, NoReturn, Protocol, type_check_only +from xml.sax import xmlreader + +version: str + +@type_check_only +class _ErrorHandlerProtocol(Protocol): # noqa: Y046 # Protocol is not used + def error(self, exception: BaseException) -> NoReturn: ... + def fatalError(self, exception: BaseException) -> NoReturn: ... + def warning(self, exception: BaseException) -> None: ... + +class ErrorHandler: + def error(self, exception: BaseException) -> NoReturn: ... + def fatalError(self, exception: BaseException) -> NoReturn: ... + def warning(self, exception: BaseException) -> None: ... + +@type_check_only +class _ContentHandlerProtocol(Protocol): # noqa: Y046 # Protocol is not used + def setDocumentLocator(self, locator: xmlreader.Locator) -> None: ... + def startDocument(self) -> None: ... + def endDocument(self) -> None: ... + def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... + def endPrefixMapping(self, prefix: str | None) -> None: ... + def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... + def endElement(self, name: str) -> None: ... + def startElementNS(self, name: tuple[str | None, str], qname: str | None, attrs: xmlreader.AttributesNSImpl) -> None: ... + def endElementNS(self, name: tuple[str | None, str], qname: str | None) -> None: ... + def characters(self, content: str) -> None: ... + def ignorableWhitespace(self, whitespace: str) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + def skippedEntity(self, name: str) -> None: ... + +class ContentHandler: + def setDocumentLocator(self, locator: xmlreader.Locator) -> None: ... + def startDocument(self) -> None: ... + def endDocument(self) -> None: ... + def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... + def endPrefixMapping(self, prefix: str | None) -> None: ... + def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... + def endElement(self, name: str) -> None: ... + def startElementNS(self, name: tuple[str | None, str], qname: str | None, attrs: xmlreader.AttributesNSImpl) -> None: ... + def endElementNS(self, name: tuple[str | None, str], qname: str | None) -> None: ... + def characters(self, content: str) -> None: ... + def ignorableWhitespace(self, whitespace: str) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + def skippedEntity(self, name: str) -> None: ... + +@type_check_only +class _DTDHandlerProtocol(Protocol): # noqa: Y046 # Protocol is not used + def notationDecl(self, name: str, publicId: str | None, systemId: str) -> None: ... + def unparsedEntityDecl(self, name: str, publicId: str | None, systemId: str, ndata: str) -> None: ... + +class DTDHandler: + def notationDecl(self, name: str, publicId: str | None, systemId: str) -> None: ... + def unparsedEntityDecl(self, name: str, publicId: str | None, systemId: str, ndata: str) -> None: ... + +@type_check_only +class _EntityResolverProtocol(Protocol): # noqa: Y046 # Protocol is not used + def resolveEntity(self, publicId: str | None, systemId: str) -> str: ... + +class EntityResolver: + def resolveEntity(self, publicId: str | None, systemId: str) -> str: ... + +feature_namespaces: str +feature_namespace_prefixes: str +feature_string_interning: str +feature_validation: str +feature_external_ges: str +feature_external_pes: str +all_features: list[str] +property_lexical_handler: Literal["http://xml.org/sax/properties/lexical-handler"] +property_declaration_handler: Literal["http://xml.org/sax/properties/declaration-handler"] +property_dom_node: Literal["http://xml.org/sax/properties/dom-node"] +property_xml_string: Literal["http://xml.org/sax/properties/xml-string"] +property_encoding: Literal["http://www.python.org/sax/properties/encoding"] +property_interning_dict: Literal["http://www.python.org/sax/properties/interning-dict"] +all_properties: list[str] + +if sys.version_info >= (3, 10): + class LexicalHandler: + def comment(self, content: str) -> None: ... + def startDTD(self, name: str, public_id: str | None, system_id: str | None) -> None: ... + def endDTD(self) -> None: ... + def startCDATA(self) -> None: ... + def endCDATA(self) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi new file mode 100644 index 0000000000000..a29588faae2ae --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/saxutils.pyi @@ -0,0 +1,68 @@ +from _typeshed import SupportsWrite +from codecs import StreamReaderWriter, StreamWriter +from collections.abc import Mapping +from io import RawIOBase, TextIOBase +from typing import Literal, NoReturn +from xml.sax import _Source, handler, xmlreader + +def escape(data: str, entities: Mapping[str, str] = {}) -> str: ... +def unescape(data: str, entities: Mapping[str, str] = {}) -> str: ... +def quoteattr(data: str, entities: Mapping[str, str] = {}) -> str: ... + +class XMLGenerator(handler.ContentHandler): + def __init__( + self, + out: TextIOBase | RawIOBase | StreamWriter | StreamReaderWriter | SupportsWrite[bytes] | None = None, + encoding: str = "iso-8859-1", + short_empty_elements: bool = False, + ) -> None: ... + def _qname(self, name: tuple[str | None, str]) -> str: ... + def startDocument(self) -> None: ... + def endDocument(self) -> None: ... + def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... + def endPrefixMapping(self, prefix: str | None) -> None: ... + def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... + def endElement(self, name: str) -> None: ... + def startElementNS(self, name: tuple[str | None, str], qname: str | None, attrs: xmlreader.AttributesNSImpl) -> None: ... + def endElementNS(self, name: tuple[str | None, str], qname: str | None) -> None: ... + def characters(self, content: str) -> None: ... + def ignorableWhitespace(self, content: str) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + +class XMLFilterBase(xmlreader.XMLReader): + def __init__(self, parent: xmlreader.XMLReader | None = None) -> None: ... + # ErrorHandler methods + def error(self, exception: BaseException) -> NoReturn: ... + def fatalError(self, exception: BaseException) -> NoReturn: ... + def warning(self, exception: BaseException) -> None: ... + # ContentHandler methods + def setDocumentLocator(self, locator: xmlreader.Locator) -> None: ... + def startDocument(self) -> None: ... + def endDocument(self) -> None: ... + def startPrefixMapping(self, prefix: str | None, uri: str) -> None: ... + def endPrefixMapping(self, prefix: str | None) -> None: ... + def startElement(self, name: str, attrs: xmlreader.AttributesImpl) -> None: ... + def endElement(self, name: str) -> None: ... + def startElementNS(self, name: tuple[str | None, str], qname: str | None, attrs: xmlreader.AttributesNSImpl) -> None: ... + def endElementNS(self, name: tuple[str | None, str], qname: str | None) -> None: ... + def characters(self, content: str) -> None: ... + def ignorableWhitespace(self, chars: str) -> None: ... + def processingInstruction(self, target: str, data: str) -> None: ... + def skippedEntity(self, name: str) -> None: ... + # DTDHandler methods + def notationDecl(self, name: str, publicId: str | None, systemId: str) -> None: ... + def unparsedEntityDecl(self, name: str, publicId: str | None, systemId: str, ndata: str) -> None: ... + # EntityResolver methods + def resolveEntity(self, publicId: str | None, systemId: str) -> str: ... + # XMLReader methods + def parse(self, source: xmlreader.InputSource | _Source) -> None: ... + def setLocale(self, locale: str) -> None: ... + def getFeature(self, name: str) -> Literal[1, 0] | bool: ... + def setFeature(self, name: str, state: Literal[1, 0] | bool) -> None: ... + def getProperty(self, name: str) -> object: ... + def setProperty(self, name: str, value: object) -> None: ... + # XMLFilter methods + def getParent(self) -> xmlreader.XMLReader | None: ... + def setParent(self, parent: xmlreader.XMLReader) -> None: ... + +def prepare_input_source(source: xmlreader.InputSource | _Source, base: str = "") -> xmlreader.InputSource: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi new file mode 100644 index 0000000000000..e7d04ddeadb80 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xml/sax/xmlreader.pyi @@ -0,0 +1,90 @@ +from _typeshed import ReadableBuffer +from collections.abc import Mapping +from typing import Generic, Literal, TypeVar, overload +from typing_extensions import Self, TypeAlias +from xml.sax import _Source, _SupportsReadClose +from xml.sax.handler import _ContentHandlerProtocol, _DTDHandlerProtocol, _EntityResolverProtocol, _ErrorHandlerProtocol + +class XMLReader: + def parse(self, source: InputSource | _Source) -> None: ... + def getContentHandler(self) -> _ContentHandlerProtocol: ... + def setContentHandler(self, handler: _ContentHandlerProtocol) -> None: ... + def getDTDHandler(self) -> _DTDHandlerProtocol: ... + def setDTDHandler(self, handler: _DTDHandlerProtocol) -> None: ... + def getEntityResolver(self) -> _EntityResolverProtocol: ... + def setEntityResolver(self, resolver: _EntityResolverProtocol) -> None: ... + def getErrorHandler(self) -> _ErrorHandlerProtocol: ... + def setErrorHandler(self, handler: _ErrorHandlerProtocol) -> None: ... + def setLocale(self, locale: str) -> None: ... + def getFeature(self, name: str) -> Literal[0, 1] | bool: ... + def setFeature(self, name: str, state: Literal[0, 1] | bool) -> None: ... + def getProperty(self, name: str) -> object: ... + def setProperty(self, name: str, value: object) -> None: ... + +class IncrementalParser(XMLReader): + def __init__(self, bufsize: int = 65536) -> None: ... + def parse(self, source: InputSource | _Source) -> None: ... + def feed(self, data: str | ReadableBuffer) -> None: ... + def prepareParser(self, source: InputSource) -> None: ... + def close(self) -> None: ... + def reset(self) -> None: ... + +class Locator: + def getColumnNumber(self) -> int | None: ... + def getLineNumber(self) -> int | None: ... + def getPublicId(self) -> str | None: ... + def getSystemId(self) -> str | None: ... + +class InputSource: + def __init__(self, system_id: str | None = None) -> None: ... + def setPublicId(self, public_id: str | None) -> None: ... + def getPublicId(self) -> str | None: ... + def setSystemId(self, system_id: str | None) -> None: ... + def getSystemId(self) -> str | None: ... + def setEncoding(self, encoding: str | None) -> None: ... + def getEncoding(self) -> str | None: ... + def setByteStream(self, bytefile: _SupportsReadClose[bytes] | None) -> None: ... + def getByteStream(self) -> _SupportsReadClose[bytes] | None: ... + def setCharacterStream(self, charfile: _SupportsReadClose[str] | None) -> None: ... + def getCharacterStream(self) -> _SupportsReadClose[str] | None: ... + +_AttrKey = TypeVar("_AttrKey", default=str) + +class AttributesImpl(Generic[_AttrKey]): + def __init__(self, attrs: Mapping[_AttrKey, str]) -> None: ... + def getLength(self) -> int: ... + def getType(self, name: str) -> str: ... + def getValue(self, name: _AttrKey) -> str: ... + def getValueByQName(self, name: str) -> str: ... + def getNameByQName(self, name: str) -> _AttrKey: ... + def getQNameByName(self, name: _AttrKey) -> str: ... + def getNames(self) -> list[_AttrKey]: ... + def getQNames(self) -> list[str]: ... + def __len__(self) -> int: ... + def __getitem__(self, name: _AttrKey) -> str: ... + def keys(self) -> list[_AttrKey]: ... + def __contains__(self, name: _AttrKey) -> bool: ... + @overload + def get(self, name: _AttrKey, alternative: None = None) -> str | None: ... + @overload + def get(self, name: _AttrKey, alternative: str) -> str: ... + def copy(self) -> Self: ... + def items(self) -> list[tuple[_AttrKey, str]]: ... + def values(self) -> list[str]: ... + +_NSName: TypeAlias = tuple[str | None, str] + +class AttributesNSImpl(AttributesImpl[_NSName]): + def __init__(self, attrs: Mapping[_NSName, str], qnames: Mapping[_NSName, str]) -> None: ... + def getValue(self, name: _NSName) -> str: ... + def getNameByQName(self, name: str) -> _NSName: ... + def getQNameByName(self, name: _NSName) -> str: ... + def getNames(self) -> list[_NSName]: ... + def __getitem__(self, name: _NSName) -> str: ... + def keys(self) -> list[_NSName]: ... + def __contains__(self, name: _NSName) -> bool: ... + @overload + def get(self, name: _NSName, alternative: None = None) -> str | None: ... + @overload + def get(self, name: _NSName, alternative: str) -> str: ... + def items(self) -> list[tuple[_NSName, str]]: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/__init__.pyi new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi new file mode 100644 index 0000000000000..6cc4361f4a096 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/client.pyi @@ -0,0 +1,297 @@ +import gzip +import http.client +import time +from _typeshed import ReadableBuffer, SizedBuffer, SupportsRead, SupportsWrite +from collections.abc import Callable, Iterable, Mapping +from datetime import datetime +from io import BytesIO +from types import TracebackType +from typing import Any, ClassVar, Final, Literal, Protocol, overload +from typing_extensions import Self, TypeAlias + +class _SupportsTimeTuple(Protocol): + def timetuple(self) -> time.struct_time: ... + +_DateTimeComparable: TypeAlias = DateTime | datetime | str | _SupportsTimeTuple +_Marshallable: TypeAlias = ( + bool + | int + | float + | str + | bytes + | bytearray + | None + | tuple[_Marshallable, ...] + # Ideally we'd use _Marshallable for list and dict, but invariance makes that impractical + | list[Any] + | dict[str, Any] + | datetime + | DateTime + | Binary +) +_XMLDate: TypeAlias = int | datetime | tuple[int, ...] | time.struct_time +_HostType: TypeAlias = tuple[str, dict[str, str]] | str + +def escape(s: str) -> str: ... # undocumented + +MAXINT: Final[int] # undocumented +MININT: Final[int] # undocumented + +PARSE_ERROR: Final[int] # undocumented +SERVER_ERROR: Final[int] # undocumented +APPLICATION_ERROR: Final[int] # undocumented +SYSTEM_ERROR: Final[int] # undocumented +TRANSPORT_ERROR: Final[int] # undocumented + +NOT_WELLFORMED_ERROR: Final[int] # undocumented +UNSUPPORTED_ENCODING: Final[int] # undocumented +INVALID_ENCODING_CHAR: Final[int] # undocumented +INVALID_XMLRPC: Final[int] # undocumented +METHOD_NOT_FOUND: Final[int] # undocumented +INVALID_METHOD_PARAMS: Final[int] # undocumented +INTERNAL_ERROR: Final[int] # undocumented + +class Error(Exception): ... + +class ProtocolError(Error): + url: str + errcode: int + errmsg: str + headers: dict[str, str] + def __init__(self, url: str, errcode: int, errmsg: str, headers: dict[str, str]) -> None: ... + +class ResponseError(Error): ... + +class Fault(Error): + faultCode: int + faultString: str + def __init__(self, faultCode: int, faultString: str, **extra: Any) -> None: ... + +boolean = bool +Boolean = bool + +def _iso8601_format(value: datetime) -> str: ... # undocumented +def _strftime(value: _XMLDate) -> str: ... # undocumented + +class DateTime: + value: str # undocumented + def __init__(self, value: int | str | datetime | time.struct_time | tuple[int, ...] = 0) -> None: ... + __hash__: ClassVar[None] # type: ignore[assignment] + def __lt__(self, other: _DateTimeComparable) -> bool: ... + def __le__(self, other: _DateTimeComparable) -> bool: ... + def __gt__(self, other: _DateTimeComparable) -> bool: ... + def __ge__(self, other: _DateTimeComparable) -> bool: ... + def __eq__(self, other: _DateTimeComparable) -> bool: ... # type: ignore[override] + def make_comparable(self, other: _DateTimeComparable) -> tuple[str, str]: ... # undocumented + def timetuple(self) -> time.struct_time: ... # undocumented + def decode(self, data: Any) -> None: ... + def encode(self, out: SupportsWrite[str]) -> None: ... + +def _datetime(data: Any) -> DateTime: ... # undocumented +def _datetime_type(data: str) -> datetime: ... # undocumented + +class Binary: + data: bytes + def __init__(self, data: bytes | bytearray | None = None) -> None: ... + def decode(self, data: ReadableBuffer) -> None: ... + def encode(self, out: SupportsWrite[str]) -> None: ... + def __eq__(self, other: object) -> bool: ... + __hash__: ClassVar[None] # type: ignore[assignment] + +def _binary(data: ReadableBuffer) -> Binary: ... # undocumented + +WRAPPERS: Final[tuple[type[DateTime], type[Binary]]] # undocumented + +class ExpatParser: # undocumented + def __init__(self, target: Unmarshaller) -> None: ... + def feed(self, data: str | ReadableBuffer) -> None: ... + def close(self) -> None: ... + +_WriteCallback: TypeAlias = Callable[[str], object] + +class Marshaller: + dispatch: dict[type[_Marshallable] | Literal["_arbitrary_instance"], Callable[[Marshaller, Any, _WriteCallback], None]] + memo: dict[Any, None] + data: None + encoding: str | None + allow_none: bool + def __init__(self, encoding: str | None = None, allow_none: bool = False) -> None: ... + def dumps(self, values: Fault | Iterable[_Marshallable]) -> str: ... + def __dump(self, value: _Marshallable, write: _WriteCallback) -> None: ... # undocumented + def dump_nil(self, value: None, write: _WriteCallback) -> None: ... + def dump_bool(self, value: bool, write: _WriteCallback) -> None: ... + def dump_long(self, value: int, write: _WriteCallback) -> None: ... + def dump_int(self, value: int, write: _WriteCallback) -> None: ... + def dump_double(self, value: float, write: _WriteCallback) -> None: ... + def dump_unicode(self, value: str, write: _WriteCallback, escape: Callable[[str], str] = ...) -> None: ... + def dump_bytes(self, value: ReadableBuffer, write: _WriteCallback) -> None: ... + def dump_array(self, value: Iterable[_Marshallable], write: _WriteCallback) -> None: ... + def dump_struct( + self, value: Mapping[str, _Marshallable], write: _WriteCallback, escape: Callable[[str], str] = ... + ) -> None: ... + def dump_datetime(self, value: _XMLDate, write: _WriteCallback) -> None: ... + def dump_instance(self, value: object, write: _WriteCallback) -> None: ... + +class Unmarshaller: + dispatch: dict[str, Callable[[Unmarshaller, str], None]] + + _type: str | None + _stack: list[_Marshallable] + _marks: list[int] + _data: list[str] + _value: bool + _methodname: str | None + _encoding: str + append: Callable[[Any], None] + _use_datetime: bool + _use_builtin_types: bool + def __init__(self, use_datetime: bool = False, use_builtin_types: bool = False) -> None: ... + def close(self) -> tuple[_Marshallable, ...]: ... + def getmethodname(self) -> str | None: ... + def xml(self, encoding: str, standalone: Any) -> None: ... # Standalone is ignored + def start(self, tag: str, attrs: dict[str, str]) -> None: ... + def data(self, text: str) -> None: ... + def end(self, tag: str) -> None: ... + def end_dispatch(self, tag: str, data: str) -> None: ... + def end_nil(self, data: str) -> None: ... + def end_boolean(self, data: str) -> None: ... + def end_int(self, data: str) -> None: ... + def end_double(self, data: str) -> None: ... + def end_bigdecimal(self, data: str) -> None: ... + def end_string(self, data: str) -> None: ... + def end_array(self, data: str) -> None: ... + def end_struct(self, data: str) -> None: ... + def end_base64(self, data: str) -> None: ... + def end_dateTime(self, data: str) -> None: ... + def end_value(self, data: str) -> None: ... + def end_params(self, data: str) -> None: ... + def end_fault(self, data: str) -> None: ... + def end_methodName(self, data: str) -> None: ... + +class _MultiCallMethod: # undocumented + __call_list: list[tuple[str, tuple[_Marshallable, ...]]] + __name: str + def __init__(self, call_list: list[tuple[str, _Marshallable]], name: str) -> None: ... + def __getattr__(self, name: str) -> _MultiCallMethod: ... + def __call__(self, *args: _Marshallable) -> None: ... + +class MultiCallIterator: # undocumented + results: list[list[_Marshallable]] + def __init__(self, results: list[list[_Marshallable]]) -> None: ... + def __getitem__(self, i: int) -> _Marshallable: ... + +class MultiCall: + __server: ServerProxy + __call_list: list[tuple[str, tuple[_Marshallable, ...]]] + def __init__(self, server: ServerProxy) -> None: ... + def __getattr__(self, name: str) -> _MultiCallMethod: ... + def __call__(self) -> MultiCallIterator: ... + +# A little white lie +FastMarshaller: Marshaller | None +FastParser: ExpatParser | None +FastUnmarshaller: Unmarshaller | None + +def getparser(use_datetime: bool = False, use_builtin_types: bool = False) -> tuple[ExpatParser, Unmarshaller]: ... +def dumps( + params: Fault | tuple[_Marshallable, ...], + methodname: str | None = None, + methodresponse: bool | None = None, + encoding: str | None = None, + allow_none: bool = False, +) -> str: ... +def loads( + data: str | ReadableBuffer, use_datetime: bool = False, use_builtin_types: bool = False +) -> tuple[tuple[_Marshallable, ...], str | None]: ... +def gzip_encode(data: ReadableBuffer) -> bytes: ... # undocumented +def gzip_decode(data: ReadableBuffer, max_decode: int = 20971520) -> bytes: ... # undocumented + +class GzipDecodedResponse(gzip.GzipFile): # undocumented + io: BytesIO + def __init__(self, response: SupportsRead[ReadableBuffer]) -> None: ... + +class _Method: # undocumented + __send: Callable[[str, tuple[_Marshallable, ...]], _Marshallable] + __name: str + def __init__(self, send: Callable[[str, tuple[_Marshallable, ...]], _Marshallable], name: str) -> None: ... + def __getattr__(self, name: str) -> _Method: ... + def __call__(self, *args: _Marshallable) -> _Marshallable: ... + +class Transport: + user_agent: str + accept_gzip_encoding: bool + encode_threshold: int | None + + _use_datetime: bool + _use_builtin_types: bool + _connection: tuple[_HostType | None, http.client.HTTPConnection | None] + _headers: list[tuple[str, str]] + _extra_headers: list[tuple[str, str]] + + def __init__( + self, use_datetime: bool = False, use_builtin_types: bool = False, *, headers: Iterable[tuple[str, str]] = () + ) -> None: ... + def request( + self, host: _HostType, handler: str, request_body: SizedBuffer, verbose: bool = False + ) -> tuple[_Marshallable, ...]: ... + def single_request( + self, host: _HostType, handler: str, request_body: SizedBuffer, verbose: bool = False + ) -> tuple[_Marshallable, ...]: ... + def getparser(self) -> tuple[ExpatParser, Unmarshaller]: ... + def get_host_info(self, host: _HostType) -> tuple[str, list[tuple[str, str]], dict[str, str]]: ... + def make_connection(self, host: _HostType) -> http.client.HTTPConnection: ... + def close(self) -> None: ... + def send_request( + self, host: _HostType, handler: str, request_body: SizedBuffer, debug: bool + ) -> http.client.HTTPConnection: ... + def send_headers(self, connection: http.client.HTTPConnection, headers: list[tuple[str, str]]) -> None: ... + def send_content(self, connection: http.client.HTTPConnection, request_body: SizedBuffer) -> None: ... + def parse_response(self, response: http.client.HTTPResponse) -> tuple[_Marshallable, ...]: ... + +class SafeTransport(Transport): + def __init__( + self, + use_datetime: bool = False, + use_builtin_types: bool = False, + *, + headers: Iterable[tuple[str, str]] = (), + context: Any | None = None, + ) -> None: ... + def make_connection(self, host: _HostType) -> http.client.HTTPSConnection: ... + +class ServerProxy: + __host: str + __handler: str + __transport: Transport + __encoding: str + __verbose: bool + __allow_none: bool + + def __init__( + self, + uri: str, + transport: Transport | None = None, + encoding: str | None = None, + verbose: bool = False, + allow_none: bool = False, + use_datetime: bool = False, + use_builtin_types: bool = False, + *, + headers: Iterable[tuple[str, str]] = (), + context: Any | None = None, + ) -> None: ... + def __getattr__(self, name: str) -> _Method: ... + @overload + def __call__(self, attr: Literal["close"]) -> Callable[[], None]: ... + @overload + def __call__(self, attr: Literal["transport"]) -> Transport: ... + @overload + def __call__(self, attr: str) -> Callable[[], None] | Transport: ... + def __enter__(self) -> Self: ... + def __exit__( + self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None + ) -> None: ... + def __close(self) -> None: ... # undocumented + def __request(self, methodname: str, params: tuple[_Marshallable, ...]) -> tuple[_Marshallable, ...]: ... # undocumented + +Server = ServerProxy diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/server.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/server.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xmlrpc/server.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xmlrpc/server.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/xxlimited.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/xxlimited.pyi similarity index 75% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/xxlimited.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/xxlimited.pyi index 6bae87a8db2a2..78a50b85f405a 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/xxlimited.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/xxlimited.pyi @@ -1,5 +1,5 @@ import sys -from typing import Any, final +from typing import Any, ClassVar, final class Str(str): ... @@ -17,6 +17,8 @@ if sys.version_info >= (3, 10): else: class error(Exception): ... - class Null: ... + + class Null: + __hash__: ClassVar[None] # type: ignore[assignment] def roj(b: Any, /) -> None: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipapp.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zipapp.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/zipapp.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/zipapp.pyi diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi new file mode 100644 index 0000000000000..ede732c0f86ae --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/__init__.pyi @@ -0,0 +1,370 @@ +import io +import sys +from _typeshed import SizedBuffer, StrOrBytesPath, StrPath +from collections.abc import Callable, Iterable, Iterator +from io import TextIOWrapper +from os import PathLike +from types import TracebackType +from typing import IO, Final, Literal, Protocol, overload +from typing_extensions import Self, TypeAlias + +__all__ = [ + "BadZipFile", + "BadZipfile", + "Path", + "error", + "ZIP_STORED", + "ZIP_DEFLATED", + "ZIP_BZIP2", + "ZIP_LZMA", + "is_zipfile", + "ZipInfo", + "ZipFile", + "PyZipFile", + "LargeZipFile", +] + +# TODO: use TypeAlias for these two when mypy bugs are fixed +# https://github.com/python/mypy/issues/16581 +_DateTuple = tuple[int, int, int, int, int, int] # noqa: Y026 +_ZipFileMode = Literal["r", "w", "x", "a"] # noqa: Y026 + +_ReadWriteMode: TypeAlias = Literal["r", "w"] + +class BadZipFile(Exception): ... + +BadZipfile = BadZipFile +error = BadZipfile + +class LargeZipFile(Exception): ... + +class _ZipStream(Protocol): + def read(self, n: int, /) -> bytes: ... + # The following methods are optional: + # def seekable(self) -> bool: ... + # def tell(self) -> int: ... + # def seek(self, n: int, /) -> object: ... + +# Stream shape as required by _EndRecData() and _EndRecData64(). +class _SupportsReadSeekTell(Protocol): + def read(self, n: int = ..., /) -> bytes: ... + def seek(self, cookie: int, whence: int, /) -> object: ... + def tell(self) -> int: ... + +class _ClosableZipStream(_ZipStream, Protocol): + def close(self) -> object: ... + +class ZipExtFile(io.BufferedIOBase): + MAX_N: int + MIN_READ_SIZE: int + MAX_SEEK_READ: int + newlines: list[bytes] | None + mode: _ReadWriteMode + name: str + @overload + def __init__( + self, fileobj: _ClosableZipStream, mode: _ReadWriteMode, zipinfo: ZipInfo, pwd: bytes | None, close_fileobj: Literal[True] + ) -> None: ... + @overload + def __init__( + self, + fileobj: _ClosableZipStream, + mode: _ReadWriteMode, + zipinfo: ZipInfo, + pwd: bytes | None = None, + *, + close_fileobj: Literal[True], + ) -> None: ... + @overload + def __init__( + self, + fileobj: _ZipStream, + mode: _ReadWriteMode, + zipinfo: ZipInfo, + pwd: bytes | None = None, + close_fileobj: Literal[False] = False, + ) -> None: ... + def read(self, n: int | None = -1) -> bytes: ... + def readline(self, limit: int = -1) -> bytes: ... # type: ignore[override] + def peek(self, n: int = 1) -> bytes: ... + def read1(self, n: int | None) -> bytes: ... # type: ignore[override] + def seek(self, offset: int, whence: int = 0) -> int: ... + +class _Writer(Protocol): + def write(self, s: str, /) -> object: ... + +class _ZipReadable(Protocol): + def seek(self, offset: int, whence: int = 0, /) -> int: ... + def read(self, n: int = -1, /) -> bytes: ... + +class _ZipTellable(Protocol): + def tell(self) -> int: ... + +class _ZipReadableTellable(_ZipReadable, _ZipTellable, Protocol): ... + +class _ZipWritable(Protocol): + def flush(self) -> None: ... + def close(self) -> None: ... + def write(self, b: bytes, /) -> int: ... + +class ZipFile: + filename: str | None + debug: int + comment: bytes + filelist: list[ZipInfo] + fp: IO[bytes] | None + NameToInfo: dict[str, ZipInfo] + start_dir: int # undocumented + compression: int # undocumented + compresslevel: int | None # undocumented + mode: _ZipFileMode # undocumented + pwd: bytes | None # undocumented + # metadata_encoding is new in 3.11 + if sys.version_info >= (3, 11): + @overload + def __init__( + self, + file: StrPath | IO[bytes], + mode: _ZipFileMode = "r", + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + metadata_encoding: str | None = None, + ) -> None: ... + # metadata_encoding is only allowed for read mode + @overload + def __init__( + self, + file: StrPath | _ZipReadable, + mode: Literal["r"] = "r", + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + metadata_encoding: str | None = None, + ) -> None: ... + @overload + def __init__( + self, + file: StrPath | _ZipWritable, + mode: Literal["w", "x"] = ..., + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + metadata_encoding: None = None, + ) -> None: ... + @overload + def __init__( + self, + file: StrPath | _ZipReadableTellable, + mode: Literal["a"] = ..., + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + metadata_encoding: None = None, + ) -> None: ... + else: + @overload + def __init__( + self, + file: StrPath | IO[bytes], + mode: _ZipFileMode = "r", + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + ) -> None: ... + @overload + def __init__( + self, + file: StrPath | _ZipReadable, + mode: Literal["r"] = "r", + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + ) -> None: ... + @overload + def __init__( + self, + file: StrPath | _ZipWritable, + mode: Literal["w", "x"] = ..., + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + ) -> None: ... + @overload + def __init__( + self, + file: StrPath | _ZipReadableTellable, + mode: Literal["a"] = ..., + compression: int = 0, + allowZip64: bool = True, + compresslevel: int | None = None, + *, + strict_timestamps: bool = True, + ) -> None: ... + + def __enter__(self) -> Self: ... + def __exit__( + self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None + ) -> None: ... + def close(self) -> None: ... + def getinfo(self, name: str) -> ZipInfo: ... + def infolist(self) -> list[ZipInfo]: ... + def namelist(self) -> list[str]: ... + def open( + self, name: str | ZipInfo, mode: _ReadWriteMode = "r", pwd: bytes | None = None, *, force_zip64: bool = False + ) -> IO[bytes]: ... + def extract(self, member: str | ZipInfo, path: StrPath | None = None, pwd: bytes | None = None) -> str: ... + def extractall( + self, path: StrPath | None = None, members: Iterable[str | ZipInfo] | None = None, pwd: bytes | None = None + ) -> None: ... + def printdir(self, file: _Writer | None = None) -> None: ... + def setpassword(self, pwd: bytes) -> None: ... + def read(self, name: str | ZipInfo, pwd: bytes | None = None) -> bytes: ... + def testzip(self) -> str | None: ... + def write( + self, + filename: StrPath, + arcname: StrPath | None = None, + compress_type: int | None = None, + compresslevel: int | None = None, + ) -> None: ... + def writestr( + self, + zinfo_or_arcname: str | ZipInfo, + data: SizedBuffer | str, + compress_type: int | None = None, + compresslevel: int | None = None, + ) -> None: ... + if sys.version_info >= (3, 11): + def mkdir(self, zinfo_or_directory_name: str | ZipInfo, mode: int = 0o777) -> None: ... + + def __del__(self) -> None: ... + +class PyZipFile(ZipFile): + def __init__( + self, file: str | IO[bytes], mode: _ZipFileMode = "r", compression: int = 0, allowZip64: bool = True, optimize: int = -1 + ) -> None: ... + def writepy(self, pathname: str, basename: str = "", filterfunc: Callable[[str], bool] | None = None) -> None: ... + +class ZipInfo: + filename: str + date_time: _DateTuple + compress_type: int + comment: bytes + extra: bytes + create_system: int + create_version: int + extract_version: int + reserved: int + flag_bits: int + volume: int + internal_attr: int + external_attr: int + header_offset: int + CRC: int + compress_size: int + file_size: int + orig_filename: str # undocumented + if sys.version_info >= (3, 13): + compress_level: int | None + + def __init__(self, filename: str = "NoName", date_time: _DateTuple = (1980, 1, 1, 0, 0, 0)) -> None: ... + @classmethod + def from_file(cls, filename: StrPath, arcname: StrPath | None = None, *, strict_timestamps: bool = True) -> Self: ... + def is_dir(self) -> bool: ... + def FileHeader(self, zip64: bool | None = None) -> bytes: ... + +if sys.version_info >= (3, 12): + from zipfile._path import CompleteDirs as CompleteDirs, Path as Path + +else: + class CompleteDirs(ZipFile): + def resolve_dir(self, name: str) -> str: ... + @overload + @classmethod + def make(cls, source: ZipFile) -> CompleteDirs: ... + @overload + @classmethod + def make(cls, source: StrPath | IO[bytes]) -> Self: ... + + class Path: + root: CompleteDirs + at: str + def __init__(self, root: ZipFile | StrPath | IO[bytes], at: str = "") -> None: ... + @property + def name(self) -> str: ... + @property + def parent(self) -> PathLike[str]: ... # undocumented + if sys.version_info >= (3, 10): + @property + def filename(self) -> PathLike[str]: ... # undocumented + if sys.version_info >= (3, 11): + @property + def suffix(self) -> str: ... + @property + def suffixes(self) -> list[str]: ... + @property + def stem(self) -> str: ... + + @overload + def open( + self, + mode: Literal["r", "w"] = "r", + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + line_buffering: bool = ..., + write_through: bool = ..., + *, + pwd: bytes | None = None, + ) -> TextIOWrapper: ... + @overload + def open(self, mode: Literal["rb", "wb"], *, pwd: bytes | None = None) -> IO[bytes]: ... + + if sys.version_info >= (3, 10): + def iterdir(self) -> Iterator[Self]: ... + else: + def iterdir(self) -> Iterator[Path]: ... + + def is_dir(self) -> bool: ... + def is_file(self) -> bool: ... + def exists(self) -> bool: ... + def read_text( + self, + encoding: str | None = ..., + errors: str | None = ..., + newline: str | None = ..., + line_buffering: bool = ..., + write_through: bool = ..., + ) -> str: ... + def read_bytes(self) -> bytes: ... + if sys.version_info >= (3, 10): + def joinpath(self, *other: StrPath) -> Path: ... + else: + def joinpath(self, add: StrPath) -> Path: ... # undocumented + + def __truediv__(self, add: StrPath) -> Path: ... + +def is_zipfile(filename: StrOrBytesPath | _SupportsReadSeekTell) -> bool: ... + +ZIP_STORED: Final[int] +ZIP_DEFLATED: Final[int] +ZIP64_LIMIT: Final[int] +ZIP_FILECOUNT_LIMIT: Final[int] +ZIP_MAX_COMMENT: Final[int] +ZIP_BZIP2: Final[int] +ZIP_LZMA: Final[int] diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/__init__.pyi new file mode 100644 index 0000000000000..4c7b39ec4c6ca --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/__init__.pyi @@ -0,0 +1,83 @@ +import sys +from _typeshed import StrPath +from collections.abc import Iterator, Sequence +from io import TextIOWrapper +from os import PathLike +from typing import IO, Literal, TypeVar, overload +from typing_extensions import Self +from zipfile import ZipFile + +_ZF = TypeVar("_ZF", bound=ZipFile) + +if sys.version_info >= (3, 12): + __all__ = ["Path"] + + class InitializedState: + def __init__(self, *args: object, **kwargs: object) -> None: ... + def __getstate__(self) -> tuple[list[object], dict[object, object]]: ... + def __setstate__(self, state: Sequence[tuple[list[object], dict[object, object]]]) -> None: ... + + class CompleteDirs(InitializedState, ZipFile): + def resolve_dir(self, name: str) -> str: ... + @overload + @classmethod + def make(cls, source: ZipFile) -> CompleteDirs: ... + @overload + @classmethod + def make(cls, source: StrPath | IO[bytes]) -> Self: ... + if sys.version_info >= (3, 13): + @classmethod + def inject(cls, zf: _ZF) -> _ZF: ... + + class Path: + root: CompleteDirs + at: str + def __init__(self, root: ZipFile | StrPath | IO[bytes], at: str = "") -> None: ... + @property + def name(self) -> str: ... + @property + def parent(self) -> PathLike[str]: ... # undocumented + @property + def filename(self) -> PathLike[str]: ... # undocumented + @property + def suffix(self) -> str: ... + @property + def suffixes(self) -> list[str]: ... + @property + def stem(self) -> str: ... + @overload + def open( + self, + mode: Literal["r", "w"] = "r", + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + line_buffering: bool = ..., + write_through: bool = ..., + *, + pwd: bytes | None = None, + ) -> TextIOWrapper: ... + @overload + def open(self, mode: Literal["rb", "wb"], *, pwd: bytes | None = None) -> IO[bytes]: ... + def iterdir(self) -> Iterator[Self]: ... + def is_dir(self) -> bool: ... + def is_file(self) -> bool: ... + def exists(self) -> bool: ... + def read_text( + self, + encoding: str | None = ..., + errors: str | None = ..., + newline: str | None = ..., + line_buffering: bool = ..., + write_through: bool = ..., + ) -> str: ... + def read_bytes(self) -> bytes: ... + def joinpath(self, *other: StrPath) -> Path: ... + def glob(self, pattern: str) -> Iterator[Self]: ... + def rglob(self, pattern: str) -> Iterator[Self]: ... + def is_symlink(self) -> Literal[False]: ... + def relative_to(self, other: Path, *extra: StrPath) -> str: ... + def match(self, path_pattern: str) -> bool: ... + def __eq__(self, other: object) -> bool: ... + def __hash__(self) -> int: ... + def __truediv__(self, add: StrPath) -> Path: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/glob.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/glob.pyi new file mode 100644 index 0000000000000..f25ae71725c02 --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zipfile/_path/glob.pyi @@ -0,0 +1,22 @@ +import sys +from collections.abc import Iterator +from re import Match + +if sys.version_info >= (3, 13): + class Translator: + def __init__(self, seps: str = ...) -> None: ... + def translate(self, pattern: str) -> str: ... + def extend(self, pattern: str) -> str: ... + def match_dirs(self, pattern: str) -> str: ... + def translate_core(self, pattern: str) -> str: ... + def replace(self, match: Match[str]) -> str: ... + def restrict_rglob(self, pattern: str) -> None: ... + def star_not_empty(self, pattern: str) -> str: ... + +else: + def translate(pattern: str) -> str: ... + def match_dirs(pattern: str) -> str: ... + def translate_core(pattern: str) -> str: ... + def replace(match: Match[str]) -> str: ... + +def separate(pattern: str) -> Iterator[Match[str]]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipimport.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zipimport.pyi similarity index 84% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/zipimport.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/zipimport.pyi index f53b09e188ebc..3e94c681b7a2b 100644 --- a/crates/red_knot_vendored/vendor/typeshed/stdlib/zipimport.pyi +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zipimport.pyi @@ -3,12 +3,18 @@ from _typeshed import StrOrBytesPath from importlib.abc import ResourceReader from importlib.machinery import ModuleSpec from types import CodeType, ModuleType +from typing_extensions import deprecated + +if sys.version_info >= (3, 10): + from _frozen_importlib_external import _LoaderBasics +else: + _LoaderBasics = object __all__ = ["ZipImportError", "zipimporter"] class ZipImportError(ImportError): ... -class zipimporter: +class zipimporter(_LoaderBasics): archive: str prefix: str if sys.version_info >= (3, 11): @@ -26,6 +32,7 @@ class zipimporter: def get_resource_reader(self, fullname: str) -> ResourceReader | None: ... # undocumented def get_source(self, fullname: str) -> str | None: ... def is_package(self, fullname: str) -> bool: ... + @deprecated("Deprecated since 3.10; use exec_module() instead") def load_module(self, fullname: str) -> ModuleType: ... if sys.version_info >= (3, 10): def exec_module(self, module: ModuleType) -> None: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/zlib.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zlib.pyi new file mode 100644 index 0000000000000..7cafb44b34a7b --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zlib.pyi @@ -0,0 +1,70 @@ +import sys +from _typeshed import ReadableBuffer +from typing import Any, Final, final, type_check_only +from typing_extensions import Self + +DEFLATED: Final = 8 +DEF_MEM_LEVEL: int # can change +DEF_BUF_SIZE: Final = 16384 +MAX_WBITS: int +ZLIB_VERSION: str # can change +ZLIB_RUNTIME_VERSION: str # can change +Z_NO_COMPRESSION: Final = 0 +Z_PARTIAL_FLUSH: Final = 1 +Z_BEST_COMPRESSION: Final = 9 +Z_BEST_SPEED: Final = 1 +Z_BLOCK: Final = 5 +Z_DEFAULT_COMPRESSION: Final = -1 +Z_DEFAULT_STRATEGY: Final = 0 +Z_FILTERED: Final = 1 +Z_FINISH: Final = 4 +Z_FIXED: Final = 4 +Z_FULL_FLUSH: Final = 3 +Z_HUFFMAN_ONLY: Final = 2 +Z_NO_FLUSH: Final = 0 +Z_RLE: Final = 3 +Z_SYNC_FLUSH: Final = 2 +Z_TREES: Final = 6 + +class error(Exception): ... + +# This class is not exposed at runtime. It calls itself zlib.Compress. +@final +@type_check_only +class _Compress: + def __copy__(self) -> Self: ... + def __deepcopy__(self, memo: Any, /) -> Self: ... + def compress(self, data: ReadableBuffer, /) -> bytes: ... + def flush(self, mode: int = 4, /) -> bytes: ... + def copy(self) -> _Compress: ... + +# This class is not exposed at runtime. It calls itself zlib.Decompress. +@final +@type_check_only +class _Decompress: + @property + def unused_data(self) -> bytes: ... + @property + def unconsumed_tail(self) -> bytes: ... + @property + def eof(self) -> bool: ... + def __copy__(self) -> Self: ... + def __deepcopy__(self, memo: Any, /) -> Self: ... + def decompress(self, data: ReadableBuffer, /, max_length: int = 0) -> bytes: ... + def flush(self, length: int = 16384, /) -> bytes: ... + def copy(self) -> _Decompress: ... + +def adler32(data: ReadableBuffer, value: int = 1, /) -> int: ... + +if sys.version_info >= (3, 11): + def compress(data: ReadableBuffer, /, level: int = -1, wbits: int = 15) -> bytes: ... + +else: + def compress(data: ReadableBuffer, /, level: int = -1) -> bytes: ... + +def compressobj( + level: int = -1, method: int = 8, wbits: int = 15, memLevel: int = 8, strategy: int = 0, zdict: ReadableBuffer | None = None +) -> _Compress: ... +def crc32(data: ReadableBuffer, value: int = 0, /) -> int: ... +def decompress(data: ReadableBuffer, /, wbits: int = 15, bufsize: int = 16384) -> bytes: ... +def decompressobj(wbits: int = 15, zdict: ReadableBuffer = b"") -> _Decompress: ... diff --git a/crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi new file mode 100644 index 0000000000000..35381758a1b7e --- /dev/null +++ b/crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/__init__.pyi @@ -0,0 +1,28 @@ +from collections.abc import Iterable +from datetime import datetime, timedelta, tzinfo +from typing_extensions import Self +from zoneinfo._common import ZoneInfoNotFoundError as ZoneInfoNotFoundError, _IOBytes +from zoneinfo._tzpath import ( + TZPATH as TZPATH, + InvalidTZPathWarning as InvalidTZPathWarning, + available_timezones as available_timezones, + reset_tzpath as reset_tzpath, +) + +__all__ = ["ZoneInfo", "reset_tzpath", "available_timezones", "TZPATH", "ZoneInfoNotFoundError", "InvalidTZPathWarning"] + +class ZoneInfo(tzinfo): + @property + def key(self) -> str: ... + def __new__(cls, key: str) -> Self: ... + @classmethod + def no_cache(cls, key: str) -> Self: ... + @classmethod + def from_file(cls, fobj: _IOBytes, /, key: str | None = None) -> Self: ... + @classmethod + def clear_cache(cls, *, only_keys: Iterable[str] | None = None) -> None: ... + def tzname(self, dt: datetime | None, /) -> str | None: ... + def utcoffset(self, dt: datetime | None, /) -> timedelta | None: ... + def dst(self, dt: datetime | None, /) -> timedelta | None: ... + +def __dir__() -> list[str]: ... diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/_common.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/_common.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/_common.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/_common.pyi diff --git a/crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/_tzpath.pyi b/crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/_tzpath.pyi similarity index 100% rename from crates/red_knot_vendored/vendor/typeshed/stdlib/zoneinfo/_tzpath.pyi rename to crates/ty_vendored/vendor/typeshed/stdlib/zoneinfo/_tzpath.pyi diff --git a/crates/ty_wasm/Cargo.toml b/crates/ty_wasm/Cargo.toml new file mode 100644 index 0000000000000..3c96fa77e812b --- /dev/null +++ b/crates/ty_wasm/Cargo.toml @@ -0,0 +1,50 @@ +[package] +name = "ty_wasm" +version = "0.0.0" +publish = false +authors = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +homepage = { workspace = true } +documentation = { workspace = true } +repository = { workspace = true } +license = { workspace = true } +description = "WebAssembly bindings for ty" + +[lib] +crate-type = ["cdylib", "rlib"] +doctest = false + +[features] +default = ["console_error_panic_hook"] + +[dependencies] +ty_ide = { workspace = true } +ty_project = { workspace = true, default-features = false, features = [ + "deflate", + "format" +] } +ty_python_semantic = { workspace = true } + +ruff_db = { workspace = true, default-features = false, features = [] } +ruff_notebook = { workspace = true } +ruff_python_formatter = { workspace = true } +ruff_source_file = { workspace = true } +ruff_text_size = { workspace = true } + +console_error_panic_hook = { workspace = true, optional = true } +console_log = { workspace = true } +js-sys = { workspace = true } +log = { workspace = true } +# Not a direct dependency but required to enable the `wasm_js` feature. +# See https://docs.rs/getrandom/latest/getrandom/#webassembly-support +getrandom = { workspace = true, features = ["wasm_js"] } +serde-wasm-bindgen = { workspace = true } + +wasm-bindgen = { workspace = true } + +[dev-dependencies] +wasm-bindgen-test = { workspace = true } + +[lints] +workspace = true diff --git a/crates/ty_wasm/src/lib.rs b/crates/ty_wasm/src/lib.rs new file mode 100644 index 0000000000000..809309edcbfda --- /dev/null +++ b/crates/ty_wasm/src/lib.rs @@ -0,0 +1,691 @@ +use std::any::Any; + +use js_sys::{Error, JsString}; +use ruff_db::Upcast; +use ruff_db::diagnostic::{self, DisplayDiagnosticConfig}; +use ruff_db::files::{File, FileRange, system_path_to_file}; +use ruff_db::source::{line_index, source_text}; +use ruff_db::system::walk_directory::WalkDirectoryBuilder; +use ruff_db::system::{ + CaseSensitivity, DirectoryEntry, GlobError, MemoryFileSystem, Metadata, PatternError, System, + SystemPath, SystemPathBuf, SystemVirtualPath, +}; +use ruff_notebook::Notebook; +use ruff_python_formatter::formatted_file; +use ruff_source_file::{LineIndex, OneIndexed, SourceLocation}; +use ruff_text_size::{Ranged, TextSize}; +use ty_ide::{MarkupKind, goto_type_definition, hover, inlay_hints}; +use ty_project::ProjectMetadata; +use ty_project::metadata::options::Options; +use ty_project::metadata::value::ValueSource; +use ty_project::watch::{ChangeEvent, ChangedKind, CreatedKind, DeletedKind}; +use ty_project::{Db, ProjectDatabase}; +use ty_python_semantic::Program; +use wasm_bindgen::prelude::*; + +#[wasm_bindgen(start)] +pub fn run() { + use log::Level; + + // When the `console_error_panic_hook` feature is enabled, we can call the + // `set_panic_hook` function at least once during initialization, and then + // we will get better error messages if our code ever panics. + // + // For more details see + // https://github.com/rustwasm/console_error_panic_hook#readme + #[cfg(feature = "console_error_panic_hook")] + console_error_panic_hook::set_once(); + + console_log::init_with_level(Level::Debug).expect("Initializing logger went wrong."); +} + +#[wasm_bindgen] +pub struct Workspace { + db: ProjectDatabase, + position_encoding: PositionEncoding, + system: WasmSystem, +} + +#[wasm_bindgen] +impl Workspace { + #[wasm_bindgen(constructor)] + pub fn new( + root: &str, + position_encoding: PositionEncoding, + options: JsValue, + ) -> Result<Workspace, Error> { + let options = Options::deserialize_with( + ValueSource::Cli, + serde_wasm_bindgen::Deserializer::from(options), + ) + .map_err(into_error)?; + + let system = WasmSystem::new(SystemPath::new(root)); + + let project = ProjectMetadata::from_options(options, SystemPathBuf::from(root), None) + .map_err(into_error)?; + + let db = ProjectDatabase::new(project, system.clone()).map_err(into_error)?; + + Ok(Self { + db, + position_encoding, + system, + }) + } + + #[wasm_bindgen(js_name = "updateOptions")] + pub fn update_options(&mut self, options: JsValue) -> Result<(), Error> { + let options = Options::deserialize_with( + ValueSource::Cli, + serde_wasm_bindgen::Deserializer::from(options), + ) + .map_err(into_error)?; + + let project = ProjectMetadata::from_options( + options, + self.db.project().root(&self.db).to_path_buf(), + None, + ) + .map_err(into_error)?; + + let program_settings = project.to_program_settings(&self.system); + Program::get(&self.db) + .update_from_settings(&mut self.db, program_settings) + .map_err(into_error)?; + + self.db.project().reload(&mut self.db, project); + + Ok(()) + } + + #[wasm_bindgen(js_name = "openFile")] + pub fn open_file(&mut self, path: &str, contents: &str) -> Result<FileHandle, Error> { + let path = SystemPath::absolute(path, self.db.project().root(&self.db)); + + self.system + .fs + .write_file_all(&path, contents) + .map_err(into_error)?; + + self.db.apply_changes( + vec![ChangeEvent::Created { + path: path.clone(), + kind: CreatedKind::File, + }], + None, + ); + + let file = system_path_to_file(&self.db, &path).expect("File to exist"); + + self.db.project().open_file(&mut self.db, file); + + Ok(FileHandle { path, file }) + } + + #[wasm_bindgen(js_name = "updateFile")] + pub fn update_file(&mut self, file_id: &FileHandle, contents: &str) -> Result<(), Error> { + if !self.system.fs.exists(&file_id.path) { + return Err(Error::new("File does not exist")); + } + + self.system + .fs + .write_file(&file_id.path, contents) + .map_err(into_error)?; + + self.db.apply_changes( + vec![ + ChangeEvent::Changed { + path: file_id.path.to_path_buf(), + kind: ChangedKind::FileContent, + }, + ChangeEvent::Changed { + path: file_id.path.to_path_buf(), + kind: ChangedKind::FileMetadata, + }, + ], + None, + ); + + Ok(()) + } + + #[wasm_bindgen(js_name = "closeFile")] + #[allow( + clippy::needless_pass_by_value, + reason = "It's intentional that the file handle is consumed because it is no longer valid after closing" + )] + pub fn close_file(&mut self, file_id: FileHandle) -> Result<(), Error> { + let file = file_id.file; + + self.db.project().close_file(&mut self.db, file); + self.system + .fs + .remove_file(&file_id.path) + .map_err(into_error)?; + + self.db.apply_changes( + vec![ChangeEvent::Deleted { + path: file_id.path.to_path_buf(), + kind: DeletedKind::File, + }], + None, + ); + + Ok(()) + } + + /// Checks a single file. + #[wasm_bindgen(js_name = "checkFile")] + pub fn check_file(&self, file_id: &FileHandle) -> Result<Vec<Diagnostic>, Error> { + let result = self.db.check_file(file_id.file).map_err(into_error)?; + + Ok(result.into_iter().map(Diagnostic::wrap).collect()) + } + + /// Checks all open files + pub fn check(&self) -> Result<Vec<Diagnostic>, Error> { + let result = self.db.check().map_err(into_error)?; + + Ok(result.into_iter().map(Diagnostic::wrap).collect()) + } + + /// Returns the parsed AST for `path` + pub fn parsed(&self, file_id: &FileHandle) -> Result<String, Error> { + let parsed = ruff_db::parsed::parsed_module(&self.db, file_id.file); + + Ok(format!("{:#?}", parsed.syntax())) + } + + pub fn format(&self, file_id: &FileHandle) -> Result<Option<String>, Error> { + formatted_file(&self.db, file_id.file).map_err(into_error) + } + + /// Returns the token stream for `path` serialized as a string. + pub fn tokens(&self, file_id: &FileHandle) -> Result<String, Error> { + let parsed = ruff_db::parsed::parsed_module(&self.db, file_id.file); + + Ok(format!("{:#?}", parsed.tokens())) + } + + #[wasm_bindgen(js_name = "sourceText")] + pub fn source_text(&self, file_id: &FileHandle) -> Result<String, Error> { + let source_text = ruff_db::source::source_text(&self.db, file_id.file); + + Ok(source_text.to_string()) + } + + #[wasm_bindgen(js_name = "gotoTypeDefinition")] + pub fn goto_type_definition( + &self, + file_id: &FileHandle, + position: Position, + ) -> Result<Vec<LocationLink>, Error> { + let source = source_text(&self.db, file_id.file); + let index = line_index(&self.db, file_id.file); + + let offset = position.to_text_size(&source, &index, self.position_encoding)?; + + let Some(targets) = goto_type_definition(&self.db, file_id.file, offset) else { + return Ok(Vec::new()); + }; + + let source_range = Range::from_text_range( + targets.file_range().range(), + &index, + &source, + self.position_encoding, + ); + + let links: Vec<_> = targets + .into_iter() + .map(|target| LocationLink { + path: target.file().path(&self.db).to_string(), + full_range: Range::from_file_range( + &self.db, + FileRange::new(target.file(), target.full_range()), + self.position_encoding, + ), + selection_range: Some(Range::from_file_range( + &self.db, + FileRange::new(target.file(), target.focus_range()), + self.position_encoding, + )), + origin_selection_range: Some(source_range), + }) + .collect(); + + Ok(links) + } + + #[wasm_bindgen] + pub fn hover(&self, file_id: &FileHandle, position: Position) -> Result<Option<Hover>, Error> { + let source = source_text(&self.db, file_id.file); + let index = line_index(&self.db, file_id.file); + + let offset = position.to_text_size(&source, &index, self.position_encoding)?; + + let Some(range_info) = hover(&self.db, file_id.file, offset) else { + return Ok(None); + }; + + let source_range = Range::from_text_range( + range_info.file_range().range(), + &index, + &source, + self.position_encoding, + ); + + Ok(Some(Hover { + markdown: range_info + .display(&self.db, MarkupKind::Markdown) + .to_string(), + range: source_range, + })) + } + + #[wasm_bindgen(js_name = "inlayHints")] + pub fn inlay_hints(&self, file_id: &FileHandle, range: Range) -> Result<Vec<InlayHint>, Error> { + let index = line_index(&self.db, file_id.file); + let source = source_text(&self.db, file_id.file); + + let result = inlay_hints( + &self.db, + file_id.file, + range.to_text_range(&index, &source, self.position_encoding)?, + ); + + Ok(result + .into_iter() + .map(|hint| InlayHint { + markdown: hint.display(&self.db).to_string(), + position: Position::from_text_size( + hint.position, + &index, + &source, + self.position_encoding, + ), + }) + .collect()) + } +} + +pub(crate) fn into_error<E: std::fmt::Display>(err: E) -> Error { + Error::new(&err.to_string()) +} + +#[derive(Debug, Eq, PartialEq)] +#[wasm_bindgen(inspectable)] +pub struct FileHandle { + path: SystemPathBuf, + file: File, +} + +#[wasm_bindgen] +impl FileHandle { + #[wasm_bindgen(js_name = toString)] + pub fn js_to_string(&self) -> String { + format!("file(id: {:?}, path: {})", self.file, self.path) + } + + pub fn path(&self) -> String { + self.path.to_string() + } +} + +#[wasm_bindgen] +pub struct Diagnostic { + #[wasm_bindgen(readonly)] + inner: diagnostic::Diagnostic, +} + +#[wasm_bindgen] +impl Diagnostic { + fn wrap(diagnostic: diagnostic::Diagnostic) -> Self { + Self { inner: diagnostic } + } + + #[wasm_bindgen] + pub fn message(&self) -> JsString { + JsString::from(self.inner.concise_message().to_string()) + } + + #[wasm_bindgen] + pub fn id(&self) -> JsString { + JsString::from(self.inner.id().to_string()) + } + + #[wasm_bindgen] + pub fn severity(&self) -> Severity { + Severity::from(self.inner.severity()) + } + + #[wasm_bindgen(js_name = "textRange")] + pub fn text_range(&self) -> Option<TextRange> { + self.inner + .primary_span() + .and_then(|span| Some(TextRange::from(span.range()?))) + } + + #[wasm_bindgen(js_name = "toRange")] + pub fn to_range(&self, workspace: &Workspace) -> Option<Range> { + self.inner.primary_span().and_then(|span| { + Some(Range::from_file_range( + &workspace.db, + FileRange::new(span.expect_ty_file(), span.range()?), + workspace.position_encoding, + )) + }) + } + + #[wasm_bindgen] + pub fn display(&self, workspace: &Workspace) -> JsString { + let config = DisplayDiagnosticConfig::default().color(false); + self.inner + .display(&workspace.db.upcast(), &config) + .to_string() + .into() + } +} + +#[wasm_bindgen] +#[derive(Copy, Clone, Eq, PartialEq, Debug)] +pub struct Range { + pub start: Position, + pub end: Position, +} + +#[wasm_bindgen] +impl Range { + #[wasm_bindgen(constructor)] + pub fn new(start: Position, end: Position) -> Self { + Self { start, end } + } +} + +impl Range { + fn from_file_range( + db: &dyn Db, + file_range: FileRange, + position_encoding: PositionEncoding, + ) -> Self { + let index = line_index(db.upcast(), file_range.file()); + let source = source_text(db.upcast(), file_range.file()); + + Self::from_text_range(file_range.range(), &index, &source, position_encoding) + } + + fn from_text_range( + text_range: ruff_text_size::TextRange, + line_index: &LineIndex, + source: &str, + position_encoding: PositionEncoding, + ) -> Self { + Self { + start: Position::from_text_size( + text_range.start(), + line_index, + source, + position_encoding, + ), + end: Position::from_text_size(text_range.end(), line_index, source, position_encoding), + } + } + + fn to_text_range( + self, + line_index: &LineIndex, + source: &str, + position_encoding: PositionEncoding, + ) -> Result<ruff_text_size::TextRange, Error> { + let start = self + .start + .to_text_size(source, line_index, position_encoding)?; + let end = self + .end + .to_text_size(source, line_index, position_encoding)?; + + Ok(ruff_text_size::TextRange::new(start, end)) + } +} + +#[wasm_bindgen] +#[derive(Copy, Clone, Eq, PartialEq, Debug)] +pub struct Position { + /// One indexed line number + pub line: usize, + + /// One indexed column number (the nth character on the line) + pub column: usize, +} + +#[wasm_bindgen] +impl Position { + #[wasm_bindgen(constructor)] + pub fn new(line: usize, column: usize) -> Self { + Self { line, column } + } +} + +impl Position { + fn to_text_size( + self, + text: &str, + index: &LineIndex, + position_encoding: PositionEncoding, + ) -> Result<TextSize, Error> { + let text_size = index.offset( + SourceLocation { + line: OneIndexed::new(self.line).ok_or_else(|| { + Error::new( + "Invalid value `0` for `position.line`. The line index is 1-indexed.", + ) + })?, + character_offset: OneIndexed::new(self.column).ok_or_else(|| { + Error::new( + "Invalid value `0` for `position.column`. The column index is 1-indexed.", + ) + })?, + }, + text, + position_encoding.into(), + ); + + Ok(text_size) + } + + fn from_text_size( + offset: TextSize, + line_index: &LineIndex, + source: &str, + position_encoding: PositionEncoding, + ) -> Self { + let location = line_index.source_location(offset, source, position_encoding.into()); + Self { + line: location.line.get(), + column: location.character_offset.get(), + } + } +} + +#[wasm_bindgen] +#[derive(Copy, Clone, Hash, PartialEq, Eq)] +pub enum Severity { + Info, + Warning, + Error, + Fatal, +} + +impl From<diagnostic::Severity> for Severity { + fn from(value: diagnostic::Severity) -> Self { + match value { + diagnostic::Severity::Info => Self::Info, + diagnostic::Severity::Warning => Self::Warning, + diagnostic::Severity::Error => Self::Error, + diagnostic::Severity::Fatal => Self::Fatal, + } + } +} + +#[wasm_bindgen] +pub struct TextRange { + pub start: u32, + pub end: u32, +} + +impl From<ruff_text_size::TextRange> for TextRange { + fn from(value: ruff_text_size::TextRange) -> Self { + Self { + start: value.start().into(), + end: value.end().into(), + } + } +} + +#[derive(Default, Copy, Clone)] +#[wasm_bindgen] +pub enum PositionEncoding { + #[default] + Utf8, + Utf16, + Utf32, +} + +impl From<PositionEncoding> for ruff_source_file::PositionEncoding { + fn from(value: PositionEncoding) -> Self { + match value { + PositionEncoding::Utf8 => Self::Utf8, + PositionEncoding::Utf16 => Self::Utf16, + PositionEncoding::Utf32 => Self::Utf32, + } + } +} + +#[wasm_bindgen] +pub struct LocationLink { + /// The target file path + #[wasm_bindgen(getter_with_clone)] + pub path: String, + + /// The full range of the target + pub full_range: Range, + /// The target's range that should be selected/highlighted + pub selection_range: Option<Range>, + /// The range of the origin. + pub origin_selection_range: Option<Range>, +} + +#[wasm_bindgen] +pub struct Hover { + #[wasm_bindgen(getter_with_clone)] + pub markdown: String, + + pub range: Range, +} + +#[wasm_bindgen] +pub struct InlayHint { + #[wasm_bindgen(getter_with_clone)] + pub markdown: String, + + pub position: Position, +} + +#[derive(Debug, Clone)] +struct WasmSystem { + fs: MemoryFileSystem, +} + +impl WasmSystem { + fn new(root: &SystemPath) -> Self { + Self { + fs: MemoryFileSystem::with_current_directory(root), + } + } +} + +impl System for WasmSystem { + fn path_metadata(&self, path: &SystemPath) -> ruff_db::system::Result<Metadata> { + self.fs.metadata(path) + } + + fn canonicalize_path(&self, path: &SystemPath) -> ruff_db::system::Result<SystemPathBuf> { + self.fs.canonicalize(path) + } + + fn read_to_string(&self, path: &SystemPath) -> ruff_db::system::Result<String> { + self.fs.read_to_string(path) + } + + fn read_to_notebook( + &self, + path: &SystemPath, + ) -> Result<ruff_notebook::Notebook, ruff_notebook::NotebookError> { + let content = self.read_to_string(path)?; + Notebook::from_source_code(&content) + } + + fn read_virtual_path_to_string( + &self, + _path: &SystemVirtualPath, + ) -> ruff_db::system::Result<String> { + Err(not_found()) + } + + fn read_virtual_path_to_notebook( + &self, + _path: &SystemVirtualPath, + ) -> Result<Notebook, ruff_notebook::NotebookError> { + Err(ruff_notebook::NotebookError::Io(not_found())) + } + + fn path_exists_case_sensitive(&self, path: &SystemPath, _prefix: &SystemPath) -> bool { + self.path_exists(path) + } + + fn case_sensitivity(&self) -> CaseSensitivity { + CaseSensitivity::CaseSensitive + } + + fn current_directory(&self) -> &SystemPath { + self.fs.current_directory() + } + + fn user_config_directory(&self) -> Option<SystemPathBuf> { + None + } + + fn read_directory<'a>( + &'a self, + path: &SystemPath, + ) -> ruff_db::system::Result< + Box<dyn Iterator<Item = ruff_db::system::Result<DirectoryEntry>> + 'a>, + > { + Ok(Box::new(self.fs.read_directory(path)?)) + } + + fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder { + self.fs.walk_directory(path) + } + + fn glob( + &self, + pattern: &str, + ) -> Result<Box<dyn Iterator<Item = Result<SystemPathBuf, GlobError>> + '_>, PatternError> { + Ok(Box::new(self.fs.glob(pattern)?)) + } + + fn as_any(&self) -> &dyn Any { + self + } + + fn as_any_mut(&mut self) -> &mut dyn Any { + self + } +} + +fn not_found() -> std::io::Error { + std::io::Error::new(std::io::ErrorKind::NotFound, "No such file or directory") +} diff --git a/crates/ty_wasm/tests/api.rs b/crates/ty_wasm/tests/api.rs new file mode 100644 index 0000000000000..f98381f43b8fc --- /dev/null +++ b/crates/ty_wasm/tests/api.rs @@ -0,0 +1,34 @@ +#![cfg(target_arch = "wasm32")] + +use ty_wasm::{Position, PositionEncoding, Workspace}; +use wasm_bindgen_test::wasm_bindgen_test; + +#[wasm_bindgen_test] +fn check() { + let mut workspace = Workspace::new( + "/", + PositionEncoding::Utf32, + js_sys::JSON::parse("{}").unwrap(), + ) + .expect("Workspace to be created"); + + workspace + .open_file("test.py", "import random22\n") + .expect("File to be opened"); + + let result = workspace.check().expect("Check to succeed"); + + assert_eq!(result.len(), 1); + + let diagnostic = &result[0]; + + assert_eq!(diagnostic.id(), "unresolved-import"); + assert_eq!( + diagnostic.to_range(&workspace).unwrap().start, + Position { line: 1, column: 8 } + ); + assert_eq!( + diagnostic.message(), + "Cannot resolve imported module `random22`" + ); +} diff --git a/dist-workspace.toml b/dist-workspace.toml new file mode 100644 index 0000000000000..e3968dfbe7c45 --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,75 @@ +[workspace] +members = ["cargo:."] +packages = ["ruff"] + +# Config for 'dist' +[dist] +# The preferred dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.28.5-prerelease.1" +# Whether to consider the binaries in a package for distribution (defaults true) +dist = false +# CI backends to support +ci = "github" +# The installers to generate for each app +installers = ["shell", "powershell"] +# The archive format to use for windows builds (defaults .zip) +windows-archive = ".zip" +# The archive format to use for non-windows builds (defaults .tar.xz) +unix-archive = ".tar.gz" +# Target platforms to build apps for (Rust target-triple syntax) +targets = [ + "aarch64-apple-darwin", + "aarch64-unknown-linux-gnu", + "aarch64-unknown-linux-musl", + "aarch64-pc-windows-msvc", + "arm-unknown-linux-musleabihf", + "armv7-unknown-linux-gnueabihf", + "armv7-unknown-linux-musleabihf", + "x86_64-apple-darwin", + "powerpc64-unknown-linux-gnu", + "powerpc64le-unknown-linux-gnu", + "s390x-unknown-linux-gnu", + "x86_64-unknown-linux-gnu", + "x86_64-unknown-linux-musl", + "x86_64-pc-windows-msvc", + "i686-unknown-linux-gnu", + "i686-unknown-linux-musl", + "i686-pc-windows-msvc" +] +# Whether to auto-include files like READMEs, LICENSEs, and CHANGELOGs (default true) +auto-includes = false +# Whether dist should create a Github Release or use an existing draft +create-release = true +# Which actions to run on pull requests +pr-run-mode = "plan" +# Whether CI should trigger releases with dispatches instead of tag pushes +dispatch-releases = true +# Which phase dist should use to create the GitHub release +github-release = "announce" +# Whether CI should include auto-generated code to build local artifacts +build-local-artifacts = false +# Local artifacts jobs to run in CI +local-artifacts-jobs = ["./build-binaries", "./build-docker"] +# Publish jobs to run in CI +publish-jobs = ["./publish-pypi", "./publish-wasm"] +# Post-announce jobs to run in CI +post-announce-jobs = [ + "./notify-dependents", + "./publish-docs", + "./publish-playground" +] +# Custom permissions for GitHub Jobs +github-custom-job-permissions = { "build-docker" = { packages = "write", contents = "read" }, "publish-wasm" = { contents = "read", id-token = "write", packages = "write" } } +# Whether to install an updater program +install-updater = false +# Path that installers should place binaries in +install-path = ["$XDG_BIN_HOME/", "$XDG_DATA_HOME/../bin", "~/.local/bin"] + +[dist.github-custom-runners] +global = "depot-ubuntu-latest-4" + +[dist.github-action-commits] +"actions/checkout" = "85e6279cec87321a52edac9c87bce653a07cf6c2" # v4 +"actions/upload-artifact" = "6027e3dd177782cd8ab9af838c04fd81a07f1d47" # v4.6.2 +"actions/download-artifact" = "d3f86a106a0bac45b974a628896c90dbdf5c8093" # v4.3.0 +"actions/attest-build-provenance" = "c074443f1aee8d4aeeae555aebba3282517141b2" #v2.2.3 diff --git a/docs/configuration.md b/docs/configuration.md index 20da0743dfa64..533c04c71dcd8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -47,11 +47,11 @@ If left unspecified, Ruff's default configuration is equivalent to: line-length = 88 indent-width = 4 - # Assume Python 3.8 - target-version = "py38" + # Assume Python 3.9 + target-version = "py39" [tool.ruff.lint] - # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. + # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or # McCabe complexity (`C901`) by default. select = ["E4", "E7", "E9", "F"] @@ -129,11 +129,11 @@ If left unspecified, Ruff's default configuration is equivalent to: line-length = 88 indent-width = 4 - # Assume Python 3.8 - target-version = "py38" + # Assume Python 3.9 + target-version = "py39" [lint] - # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. + # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default. # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or # McCabe complexity (`C901`) by default. select = ["E4", "E7", "E9", "F"] @@ -307,6 +307,17 @@ If Ruff detects multiple configuration files in the same directory, the `.ruff.t precedence over the `ruff.toml` file, and the `ruff.toml` file will take precedence over the `pyproject.toml` file. +### Inferring the Python version +When no discovered configuration specifies a [`target-version`](settings.md#target-version), Ruff will attempt to fall back to the minimum version compatible with the `requires-python` field in a nearby `pyproject.toml`. +The rules for this behavior are as follows: + +1. If a configuration file is passed directly, Ruff does not attempt to infer a missing `target-version`. +1. If a configuration file is found in the filesystem hierarchy, Ruff will infer a missing `target-version` from the `requires-python` field in a `pyproject.toml` file in the same directory as the found configuration. +1. If we are using a user-level configuration from `${config_dir}/ruff/pyproject.toml`, the `requires-python` field in the first `pyproject.toml` file found in an ancestor of the current working directory takes precedence over the `target-version` in the user-level configuration. +1. If no configuration files are found, Ruff will infer the `target-version` from the `requires-python` field in the first `pyproject.toml` file found in an ancestor of the current working directory. + +Note that in these last two cases, the behavior of Ruff may differ depending on the working directory from which it is invoked. + ## Python file discovery When passed a path on the command-line, Ruff will automatically discover all Python files in that @@ -597,7 +608,7 @@ Options: RUFF_OUTPUT_FILE=] --target-version <TARGET_VERSION> The minimum Python version that should be supported [possible values: - py37, py38, py39, py310, py311, py312, py313] + py37, py38, py39, py310, py311, py312, py313, py314] --preview Enable preview mode; checks will include unstable rules and fixes. Use `--no-preview` to disable @@ -712,7 +723,7 @@ Options: notebooks, use `--extension ipy:ipynb` --target-version <TARGET_VERSION> The minimum Python version that should be supported [possible values: - py37, py38, py39, py310, py311, py312, py313] + py37, py38, py39, py310, py311, py312, py313, py314] --preview Enable preview mode; enables unstable formatting. Use `--no-preview` to disable @@ -726,6 +737,9 @@ Miscellaneous: Path to the cache directory [env: RUFF_CACHE_DIR=] --stdin-filename <STDIN_FILENAME> The name of the file when passing it through stdin + --exit-non-zero-on-format + Exit with a non-zero status code if any files were modified via + format, even if all files were formatted successfully File selection: --respect-gitignore diff --git a/docs/editors/features.md b/docs/editors/features.md index 4e977ddda3754..c6cd7828aa49f 100644 --- a/docs/editors/features.md +++ b/docs/editors/features.md @@ -95,6 +95,7 @@ Similar to Ruff's CLI, the Ruff Language Server fully supports Jupyter Notebook capabilities available to Python files. !!! note + Unlike [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) and similar to the Ruff's CLI, the native language server requires user to explicitly include the Jupyter Notebook files in the set of files to lint and format. Refer to the [Jupyter Notebook discovery](https://docs.astral.sh/ruff/configuration/#jupyter-notebook-discovery) diff --git a/docs/editors/index.md b/docs/editors/index.md index f0f193be21d7b..3d33a7cbad66f 100644 --- a/docs/editors/index.md +++ b/docs/editors/index.md @@ -22,6 +22,7 @@ The Ruff Language Server was available first in Ruff [v0.4.5](https://astral.sh/ in beta and stabilized in Ruff [v0.5.3](https://github.com/astral-sh/ruff/releases/tag/0.5.3). !!! note + This is the documentation for Ruff's built-in language server written in Rust (`ruff server`). If you are looking for the documentation for the `ruff-lsp` language server, please refer to the [README](https://github.com/astral-sh/ruff-lsp) of the `ruff-lsp` repository. diff --git a/docs/editors/migration.md b/docs/editors/migration.md index b9db53e729035..194e6f21a9ced 100644 --- a/docs/editors/migration.md +++ b/docs/editors/migration.md @@ -1,32 +1,54 @@ # Migrating from `ruff-lsp` -While `ruff server` supports the same feature set as [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp), migrating to -`ruff server` may require changes to your Ruff or language server configuration. +[`ruff-lsp`][ruff-lsp] is the [Language Server Protocol] implementation for Ruff to power the editor +integrations. It is written in Python and is a separate package from Ruff itself. The **native +server**, however, is the [Language Server Protocol] implementation which is **written in Rust** and +is available under the `ruff server` command. This guide is intended to help users migrate from +[`ruff-lsp`][ruff-lsp] to the native server. !!! note - The [VS Code extension](https://github.com/astral-sh/ruff-vscode) settings include documentation to indicate which - settings are supported by `ruff server`. As such, this migration guide is primarily targeted at editors that lack - explicit documentation for `ruff server` settings, such as Helix or Neovim. + + The native server was first introduced in Ruff version `0.3.5`. It was marked as [beta in + version `0.4.5`](https://astral.sh/blog/ruff-v0.4.5) and officially [stabilized in version + `0.5.3`](https://github.com/astral-sh/ruff/releases/tag/0.5.3). It is recommended to use the + latest version of Ruff to ensure the best experience. + +The migration process involves any or all of the following: + +1. Migrate [deprecated settings](#unsupported-settings) to the [new settings](#new-settings) +1. [Remove settings](#removed-settings) that are no longer supported +1. Update the `ruff` version + +Read on to learn more about the unsupported or new settings, or jump to the [examples](#examples) +that enumerate some of the common settings and how to migrate them. ## Unsupported Settings -Several `ruff-lsp` settings are not supported by `ruff server`. These are, as follows: +The following [`ruff-lsp`][ruff-lsp] settings are not supported by the native server: -- `format.args` -- `ignoreStandardLibrary` -- `interpreter` -- `lint.args` -- `lint.run` -- `path` +- [`lint.run`](settings.md#lintrun): This setting is no longer relevant for the native language + server, which runs on every keystroke by default. +- [`lint.args`](settings.md#lintargs), [`format.args`](settings.md#formatargs): These settings have + been replaced by more granular settings in the native server like [`lint.select`](settings.md#select), + [`format.preview`](settings.md#format_preview), etc. along with the ability to override any + configuration using the [`configuration`](settings.md#configuration) setting. -!!! note - Some of these settings, like `interpreter` and `path`, are still accepted by the VS Code - extension. `path`, in particular, can be used to specify a dedicated binary to use when - initializing `ruff server`. But the language server itself will no longer accept such settings. +The following settings are not accepted by the language server but are still used by the [VS Code extension]. +Refer to their respective documentation for more information on how each is used by the extension: + +- [`path`](settings.md#path) +- [`interpreter`](settings.md#interpreter) + +## Removed Settings + +Additionally, the following settings are not supported by the native server and should be removed: + +- [`ignoreStandardLibrary`](settings.md#ignorestandardlibrary) +- [`showNotifications`](settings.md#shownotifications) ## New Settings -`ruff server` introduces several new settings that `ruff-lsp` does not have. These are, as follows: +The native server introduces several new settings that [`ruff-lsp`][ruff-lsp] does not have: - [`configuration`](settings.md#configuration) - [`configurationPreference`](settings.md#configurationpreference) @@ -38,44 +60,96 @@ Several `ruff-lsp` settings are not supported by `ruff server`. These are, as fo - [`lint.ignore`](settings.md#ignore) - [`lint.preview`](settings.md#lint_preview) -Several of these new settings are replacements for the now-unsupported `format.args` and `lint.args`. For example, if -you've been passing `--select=<RULES>` to `lint.args`, you can migrate to the new server by using `lint.select` with a -value of `["<RULES>"]`. - ## Examples -Let's say you have these settings in VS Code: +All of the examples mentioned below are only valid for the [VS Code extension]. For other editors, +please refer to their respective documentation sections in the [settings](settings.md) page. + +### Configuration file + +If you've been providing a configuration file as shown below: ```json { - "ruff.lint.args": "--select=E,F --line-length 80 --config ~/.config/custom_ruff_config.toml" + "ruff.lint.args": "--config ~/.config/custom_ruff_config.toml", + "ruff.format.args": "--config ~/.config/custom_ruff_config.toml" } ``` -After enabling the native server, you can migrate your settings like so: +You can migrate to the new server by using the [`configuration`](settings.md#configuration) setting +like below which will apply the configuration to both the linter and the formatter: ```json { - "ruff.configuration": "~/.config/custom_ruff_config.toml", - "ruff.lineLength": 80, - "ruff.lint.select": ["E", "F"] + "ruff.configuration": "~/.config/custom_ruff_config.toml" } ``` -Similarly, let's say you have these settings in Helix: +### `lint.args` + +If you're providing the linter flags by using `ruff.lint.args` like so: -```toml -[language-server.ruff.config.lint] -args = "--select=E,F --line-length 80 --config ~/.config/custom_ruff_config.toml" +```json +{ + "ruff.lint.args": "--select=E,F --unfixable=F401 --unsafe-fixes" +} +``` + +You can migrate to the new server by using the [`lint.select`](settings.md#select) and +[`configuration`](settings.md#configuration) setting like so: + +```json +{ + "ruff.lint.select": ["E", "F"], + "ruff.configuration": { + "unsafe-fixes": true, + "lint": { + "unfixable": ["F401"] + } + } +} ``` -These can be migrated like so: +The following options can be set directly in the editor settings: -```toml -[language-server.ruff.config] -configuration = "~/.config/custom_ruff_config.toml" -lineLength = 80 +- [`lint.select`](settings.md#select) +- [`lint.extendSelect`](settings.md#extendselect) +- [`lint.ignore`](settings.md#ignore) +- [`lint.preview`](settings.md#lint_preview) + +The remaining options can be set using the [`configuration`](settings.md#configuration) setting. + +### `format.args` -[language-server.ruff.config.lint] -select = ["E", "F"] +If you're also providing formatter flags by using `ruff.format.args` like so: + +```json +{ + "ruff.format.args": "--line-length 80 --config='format.quote-style=double'" +} ``` + +You can migrate to the new server by using the [`lineLength`](settings.md#linelength) and +[`configuration`](settings.md#configuration) setting like so: + +```json +{ + "ruff.lineLength": 80, + "ruff.configuration": { + "format": { + "quote-style": "double" + } + } +} +``` + +The following options can be set directly in the editor settings: + +- [`lineLength`](settings.md#linelength) +- [`format.preview`](settings.md#format_preview) + +The remaining options can be set using the [`configuration`](settings.md#configuration) setting. + +[language server protocol]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/ +[ruff-lsp]: https://github.com/astral-sh/ruff-lsp +[vs code extension]: https://github.com/astral-sh/ruff-vscode diff --git a/docs/editors/settings.md b/docs/editors/settings.md index 9d200c9c9450e..1eb36af3a6d28 100644 --- a/docs/editors/settings.md +++ b/docs/editors/settings.md @@ -11,10 +11,39 @@ as per the editor. ### `configuration` -Path to a `ruff.toml` or `pyproject.toml` file to use for configuration. +The `configuration` setting allows you to configure editor-specific Ruff behavior. This can be done +in one of the following ways: -By default, Ruff will discover configuration for each project from the filesystem, mirroring the -behavior of the Ruff CLI. +1. **Configuration file path:** Specify the path to a `ruff.toml` or `pyproject.toml` file that + contains the configuration. User home directory and environment variables will be expanded. +1. **Inline JSON configuration:** Directly provide the configuration as a JSON object. + +!!! note "Added in Ruff `0.9.8`" + + The **Inline JSON configuration** option was introduced in Ruff `0.9.8`. + +The default behavior, if `configuration` is unset, is to load the settings from the project's +configuration (a `ruff.toml` or `pyproject.toml` in the project's directory), consistent with when +running Ruff on the command-line. + +The [`configurationPreference`](#configurationpreference) setting controls the precedence if both an +editor-provided configuration (`configuration`) and a project level configuration file are present. + +#### Resolution order {: #configuration_resolution_order } + +In an editor, Ruff supports three sources of configuration, prioritized as follows (from highest to +lowest): + +1. **Specific settings:** Individual settings like [`lineLength`](#linelength) or + [`lint.select`](#select) defined in the editor +1. [**`ruff.configuration`**](#configuration): Settings provided via the + [`configuration`](#configuration) field (either a path to a configuration file or an inline + configuration object) +1. **Configuration file:** Settings defined in a `ruff.toml` or `pyproject.toml` file in the + project's directory (if present) + +For example, if the line length is specified in all three sources, Ruff will use the value from the +[`lineLength`](#linelength) setting. **Default value**: `null` @@ -22,7 +51,10 @@ behavior of the Ruff CLI. **Example usage**: +_Using configuration file path:_ + === "VS Code" + ```json { "ruff.configuration": "~/path/to/ruff.toml" @@ -30,11 +62,107 @@ behavior of the Ruff CLI. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { - settings = { - configuration = "~/path/to/ruff.toml" + configuration = "~/path/to/ruff.toml" + } + } + ``` + +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "configuration": "~/path/to/ruff.toml" + } + } + } + } + } + ``` + +_Using inline configuration:_ + +=== "VS Code" + + ```json + { + "ruff.configuration": { + "lint": { + "unfixable": ["F401"], + "extend-select": ["TID251"], + "flake8-tidy-imports": { + "banned-api": { + "typing.TypedDict": { + "msg": "Use `typing_extensions.TypedDict` instead", + } + } + } + }, + "format": { + "quote-style": "single" + } + } + } + ``` + +=== "Neovim" + + ```lua + require('lspconfig').ruff.setup { + init_options = { + configuration = { + lint = { + unfixable = {"F401"}, + ["extend-select"] = {"TID251"}, + ["flake8-tidy-imports"] = { + ["banned-api"] = { + ["typing.TypedDict"] = { + msg = "Use `typing_extensions.TypedDict` instead" + } + } + } + }, + format = { + ["quote-style"] = "single" + } + } + } + } + ``` + +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "configuration": { + "lint": { + "unfixable": ["F401"], + "extend-select": ["TID251"], + "flake8-tidy-imports": { + "banned-api": { + "typing.TypedDict": { + "msg": "Use `typing_extensions.TypedDict` instead" + } + } + } + }, + "format": { + "quote-style": "single" + } + } + } + } } } } @@ -57,6 +185,7 @@ configuration is prioritized over `ruff.toml` and `pyproject.toml` files. **Example usage**: === "VS Code" + ```json { "ruff.configurationPreference": "filesystemFirst" @@ -64,6 +193,7 @@ configuration is prioritized over `ruff.toml` and `pyproject.toml` files. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -74,6 +204,22 @@ configuration is prioritized over `ruff.toml` and `pyproject.toml` files. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "configurationPreference": "filesystemFirst" + } + } + } + } + } + ``` + ### `exclude` A list of file patterns to exclude from linting and formatting. See [the @@ -86,6 +232,7 @@ documentation](https://docs.astral.sh/ruff/settings/#exclude) for more details. **Example usage**: === "VS Code" + ```json { "ruff.exclude": ["**/tests/**"] @@ -93,6 +240,7 @@ documentation](https://docs.astral.sh/ruff/settings/#exclude) for more details. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -103,6 +251,22 @@ documentation](https://docs.astral.sh/ruff/settings/#exclude) for more details. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "exclude": ["**/tests/**"] + } + } + } + } + } + ``` + ### `lineLength` The line length to use for the linter and formatter. @@ -114,6 +278,7 @@ The line length to use for the linter and formatter. **Example usage**: === "VS Code" + ```json { "ruff.lineLength": 100 @@ -121,6 +286,7 @@ The line length to use for the linter and formatter. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -131,6 +297,22 @@ The line length to use for the linter and formatter. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lineLength": 100 + } + } + } + } + } + ``` + ### `fixAll` Whether to register the server as capable of handling `source.fixAll` code actions. @@ -142,6 +324,7 @@ Whether to register the server as capable of handling `source.fixAll` code actio **Example usage**: === "VS Code" + ```json { "ruff.fixAll": false @@ -149,6 +332,7 @@ Whether to register the server as capable of handling `source.fixAll` code actio ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -159,6 +343,22 @@ Whether to register the server as capable of handling `source.fixAll` code actio } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "fixAll": false + } + } + } + } + } + ``` + ### `organizeImports` Whether to register the server as capable of handling `source.organizeImports` code actions. @@ -170,6 +370,7 @@ Whether to register the server as capable of handling `source.organizeImports` c **Example usage**: === "VS Code" + ```json { "ruff.organizeImports": false @@ -177,6 +378,7 @@ Whether to register the server as capable of handling `source.organizeImports` c ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -187,6 +389,22 @@ Whether to register the server as capable of handling `source.organizeImports` c } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "organizeImports": false + } + } + } + } + } + ``` + ### `showSyntaxErrors` _New in Ruff [v0.5.0](https://astral.sh/blog/ruff-v0.5.0#changes-to-e999-and-reporting-of-syntax-errors)_ @@ -200,6 +418,7 @@ Whether to show syntax error diagnostics. **Example usage**: === "VS Code" + ```json { "ruff.showSyntaxErrors": false @@ -207,6 +426,7 @@ Whether to show syntax error diagnostics. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -217,6 +437,22 @@ Whether to show syntax error diagnostics. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "showSyntaxErrors": false + } + } + } + } + } + ``` + ### `logLevel` The log level to use for the server. @@ -228,6 +464,7 @@ The log level to use for the server. **Example usage**: === "VS Code" + ```json { "ruff.logLevel": "debug" @@ -235,6 +472,7 @@ The log level to use for the server. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -245,6 +483,22 @@ The log level to use for the server. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "logLevel": "debug" + } + } + } + } + } + ``` + ### `logFile` Path to the log file to use for the server. @@ -258,6 +512,7 @@ If not set, logs will be written to stderr. **Example usage**: === "VS Code" + ```json { "ruff.logFile": "~/path/to/ruff.log" @@ -265,6 +520,7 @@ If not set, logs will be written to stderr. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -275,6 +531,22 @@ If not set, logs will be written to stderr. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "logFile": "~/path/to/ruff.log" + } + } + } + } + } + ``` + ## `codeAction` Enable or disable code actions provided by the server. @@ -290,6 +562,7 @@ Whether to display Quick Fix actions to disable rules via `noqa` suppression com **Example usage**: === "VS Code" + ```json { "ruff.codeAction.disableRuleComment.enable": false @@ -297,6 +570,7 @@ Whether to display Quick Fix actions to disable rules via `noqa` suppression com ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -311,6 +585,26 @@ Whether to display Quick Fix actions to disable rules via `noqa` suppression com } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "codeAction": { + "disableRuleComment": { + "enable": false + } + } + } + } + } + } + } + ``` + ### `fixViolation.enable` Whether to display Quick Fix actions to autofix violations. @@ -322,6 +616,7 @@ Whether to display Quick Fix actions to autofix violations. **Example usage**: === "VS Code" + ```json { "ruff.codeAction.fixViolation.enable": false @@ -329,6 +624,7 @@ Whether to display Quick Fix actions to autofix violations. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -343,6 +639,26 @@ Whether to display Quick Fix actions to autofix violations. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "codeAction": { + "fixViolation": = { + "enable": false + } + } + } + } + } + } + } + ``` + ## `lint` Settings specific to the Ruff linter. @@ -358,6 +674,7 @@ Whether to enable linting. Set to `false` to use Ruff exclusively as a formatter **Example usage**: === "VS Code" + ```json { "ruff.lint.enable": false @@ -365,6 +682,7 @@ Whether to enable linting. Set to `false` to use Ruff exclusively as a formatter ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -377,6 +695,24 @@ Whether to enable linting. Set to `false` to use Ruff exclusively as a formatter } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lint": { + "enable": false + } + } + } + } + } + } + ``` + ### `preview` {: #lint_preview } Whether to enable Ruff's preview mode when linting. @@ -388,6 +724,7 @@ Whether to enable Ruff's preview mode when linting. **Example usage**: === "VS Code" + ```json { "ruff.lint.preview": true @@ -395,6 +732,7 @@ Whether to enable Ruff's preview mode when linting. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -407,6 +745,24 @@ Whether to enable Ruff's preview mode when linting. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lint": { + "preview": true + } + } + } + } + } + } + ``` + ### `select` Rules to enable by default. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_select). @@ -418,6 +774,7 @@ Rules to enable by default. See [the documentation](https://docs.astral.sh/ruff/ **Example usage**: === "VS Code" + ```json { "ruff.lint.select": ["E", "F"] @@ -425,6 +782,7 @@ Rules to enable by default. See [the documentation](https://docs.astral.sh/ruff/ ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -437,6 +795,24 @@ Rules to enable by default. See [the documentation](https://docs.astral.sh/ruff/ } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lint": { + "select": ["E", "F"] + } + } + } + } + } + } + ``` + ### `extendSelect` Rules to enable in addition to those in [`lint.select`](#select). @@ -448,6 +824,7 @@ Rules to enable in addition to those in [`lint.select`](#select). **Example usage**: === "VS Code" + ```json { "ruff.lint.extendSelect": ["W"] @@ -455,6 +832,7 @@ Rules to enable in addition to those in [`lint.select`](#select). ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -467,6 +845,24 @@ Rules to enable in addition to those in [`lint.select`](#select). } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lint": { + "extendSelect": ["W"] + } + } + } + } + } + } + ``` + ### `ignore` Rules to disable by default. See [the documentation](https://docs.astral.sh/ruff/settings/#lint_ignore). @@ -478,6 +874,7 @@ Rules to disable by default. See [the documentation](https://docs.astral.sh/ruff **Example usage**: === "VS Code" + ```json { "ruff.lint.ignore": ["E4", "E7"] @@ -485,6 +882,7 @@ Rules to disable by default. See [the documentation](https://docs.astral.sh/ruff ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -497,30 +895,18 @@ Rules to disable by default. See [the documentation](https://docs.astral.sh/ruff } ``` -### `extendIgnore` - -Rules to disable in addition to those in [`lint.ignore`](#ignore). - -**Default value**: `null` - -**Type**: `string[]` - -**Example usage**: +=== "Zed" -=== "VS Code" ```json { - "ruff.lint.extendIgnore": ["W1"] - } - ``` - -=== "Neovim" - ```lua - require('lspconfig').ruff.setup { - init_options = { - settings = { - lint = { - extendIgnore = {"W1"} + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "lint": { + "ignore": ["E4", "E7"] + } + } } } } @@ -542,6 +928,7 @@ Whether to enable Ruff's preview mode when formatting. **Example usage**: === "VS Code" + ```json { "ruff.format.preview": true @@ -549,6 +936,7 @@ Whether to enable Ruff's preview mode when formatting. ``` === "Neovim" + ```lua require('lspconfig').ruff.setup { init_options = { @@ -561,6 +949,24 @@ Whether to enable Ruff's preview mode when formatting. } ``` +=== "Zed" + + ```json + { + "lsp": { + "ruff": { + "initialization_options": { + "settings": { + "format": { + "preview": true + } + } + } + } + } + } + ``` + ## VS Code specific Additionally, the Ruff extension provides the following settings specific to VS Code. These settings @@ -584,6 +990,12 @@ Whether to enable the Ruff extension. Modifying this setting requires restarting ### `format.args` +!!! warning "Deprecated" + + This setting is only used by [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) which is + deprecated in favor of the native language server. Refer to the [migration + guide](migration.md) for more information. + _**This setting is not used by the native language server.**_ Additional arguments to pass to the Ruff formatter. @@ -602,6 +1014,12 @@ Additional arguments to pass to the Ruff formatter. ### `ignoreStandardLibrary` +!!! warning "Deprecated" + + This setting is only used by [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) which is + deprecated in favor of the native language server. Refer to the [migration + guide](migration.md) for more information. + _**This setting is not used by the native language server.**_ Whether to ignore files that are inferred to be part of the Python standard library. @@ -662,6 +1080,12 @@ This setting depends on the [`ruff.nativeServer`](#nativeserver) setting: ### `lint.args` +!!! warning "Deprecated" + + This setting is only used by [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) which is + deprecated in favor of the native language server. Refer to the [migration + guide](migration.md) for more information. + _**This setting is not used by the native language server.**_ Additional arguments to pass to the Ruff linter. @@ -680,6 +1104,12 @@ Additional arguments to pass to the Ruff linter. ### `lint.run` +!!! warning "Deprecated" + + This setting is only used by [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) which is + deprecated in favor of the native language server. Refer to the [migration + guide](migration.md) for more information. + _**This setting is not used by the native language server.**_ Run Ruff on every keystroke (`onType`) or on save (`onSave`). @@ -710,7 +1140,7 @@ automatically decide between the two based on the Ruff version and extension set 1. If the Ruff version is >= `0.5.3`, use the native language server unless any deprecated settings are detected. In that case, show a warning and use [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) instead. - 1. If the Ruff version is \< `0.5.3`, use [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp). A + 1. If the Ruff version is < `0.5.3`, use [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp). A warning will be displayed if settings specific to the native server are detected. - `true`: Same as `on` - `false`: Same as `off` @@ -748,6 +1178,12 @@ The first executable in the list which is exists is used. This setting takes pre ### `showNotifications` +!!! warning "Deprecated" + + This setting is only used by [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) which is + deprecated in favor of the native language server. Refer to the [migration + guide](migration.md) for more information. + Setting to control when a notification is shown. **Default value**: `"off"` diff --git a/docs/editors/setup.md b/docs/editors/setup.md index 472abaed684de..507e9d450c461 100644 --- a/docs/editors/setup.md +++ b/docs/editors/setup.md @@ -8,11 +8,13 @@ regardless of editor, there are several settings which have changed or are no lo the [migration guide](./migration.md) for more. !!! note + The setup instructions provided below are on a best-effort basis. If you encounter any issues while setting up the Ruff in an editor, please [open an issue](https://github.com/astral-sh/ruff/issues/new) for assistance and help in improving this documentation. !!! tip + Regardless of the editor, it is recommended to disable the older language server ([`ruff-lsp`](https://github.com/astral-sh/ruff-lsp)) to prevent any conflicts. @@ -34,17 +36,34 @@ Ruff Language Server in Neovim. To set it up, install [configuration](https://github.com/neovim/nvim-lspconfig#configuration) documentation, and add the following to your `init.lua`: -```lua -require('lspconfig').ruff.setup({ - init_options = { - settings = { - -- Ruff language server settings go here - } - } -}) -``` +=== "Neovim 0.10 (with [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig))" + + ```lua + require('lspconfig').ruff.setup({ + init_options = { + settings = { + -- Ruff language server settings go here + } + } + }) + ``` + +=== "Neovim 0.11+ (with [`vim.lsp.config`](https://neovim.io/doc/user/lsp.html#vim.lsp.config()))" + + ```lua + vim.lsp.config('ruff', { + init_options = { + settings = { + -- Ruff language server settings go here + } + } + }) + + vim.lsp.enable('ruff') + ``` !!! note + If the installed version of `nvim-lspconfig` includes the changes from [neovim/nvim-lspconfig@`70d1c2c`](https://github.com/neovim/nvim-lspconfig/commit/70d1c2c31a88af4b36019dc1551be16bffb8f9db), you will need to use Ruff version `0.5.3` or later. @@ -89,13 +108,11 @@ require('lspconfig').pyright.setup { } ``` -By default, Ruff will not show any logs. To enable logging in Neovim, you'll need to set the -[`trace`](https://neovim.io/doc/user/lsp.html#vim.lsp.ClientConfig) setting to either `messages` or `verbose`, and use the -[`logLevel`](./settings.md#loglevel) setting to change the log level: +By default, the log level for Ruff is set to `info`. To change the log level, you can set the +[`logLevel`](./settings.md#loglevel) setting: ```lua require('lspconfig').ruff.setup { - trace = 'messages', init_options = { settings = { logLevel = 'debug', @@ -104,10 +121,16 @@ require('lspconfig').ruff.setup { } ``` -By default, this will write logs to stderr which will be available in Neovim's LSP client log file +By default, Ruff will write logs to stderr which will be available in Neovim's LSP client log file (`:lua vim.print(vim.lsp.get_log_path())`). It's also possible to divert these logs to a separate file with the [`logFile`](./settings.md#logfile) setting. +To view the trace logs between Neovim and Ruff, set the log level for Neovim's LSP client to `debug`: + +```lua +vim.lsp.set_log_level('debug') +``` + ## Vim The [`vim-lsp`](https://github.com/prabirshrestha/vim-lsp) plugin can be used to configure the Ruff Language Server in Vim. @@ -150,12 +173,15 @@ extension for [coc.nvim](https://github.com/neoclide/coc.nvim). <summary>With the <a href="https://github.com/dense-analysis/ale">ALE</a> plugin for Vim or Neovim.</summary> ```vim -" Linter +" Linters let g:ale_linters = { "python": ["ruff"] } -" Formatter -let g:ale_fixers = { "python": ["ruff_format"] } +" Fixers +let g:ale_fixers = { "python": ["ruff", "ruff_format"] } ``` +For the fixers, `ruff` will run `ruff check --fix` (to fix all auto-fixable problems) whereas +`ruff_format` will run `ruff format`. + </details> <details> @@ -239,6 +265,7 @@ language-servers = ["ruff", "pylsp"] ``` !!! note + Support for multiple language servers for a language is only available in Helix version [`23.10`](https://github.com/helix-editor/helix/blob/master/CHANGELOG.md#2310-2023-10-24) and later. @@ -267,15 +294,13 @@ preview = false preview = true ``` -By default, Ruff does not log anything to Helix. To enable logging, set the `RUFF_TRACE` environment -variable to either `messages` or `verbose`, and use the [`logLevel`](./settings.md#loglevel) setting to change -the log level: +By default, the log level for Ruff is set to `info`. To change the log level, you can set the +[`logLevel`](./settings.md#loglevel) setting: ```toml [language-server.ruff] command = "ruff" args = ["server"] -environment = { "RUFF_TRACE" = "messages" } [language-server.ruff.config.settings] logLevel = "debug" @@ -283,9 +308,11 @@ logLevel = "debug" You can also divert Ruff's logs to a separate file with the [`logFile`](./settings.md#logfile) setting. -!!! note - Setting `RUFF_TRACE=verbose` does not enable Helix's verbose mode by itself. You'll need to run - Helix with `-v` for verbose logging. +To view the trace logs between Helix and Ruff, pass in the `-v` (verbose) flag when starting Helix: + +```sh +hx -v path/to/file.py +``` ## Kate @@ -310,6 +337,7 @@ See [LSP Client documentation](https://docs.kde.org/stable5/en/kate/kate/kate-ap on how to configure the server from there. !!! important + Kate's LSP Client plugin does not support multiple servers for the same language. As a workaround, you can use the [`python-lsp-server`](https://github.com/python-lsp/python-lsp-server) along with the [`python-lsp-ruff`](https://github.com/python-lsp/python-lsp-ruff) plugin to @@ -428,6 +456,7 @@ under the [`lsp.ruff.initialization_options.settings`](https://zed.dev/docs/conf ``` !!! note + Support for multiple formatters for a given language is only available in Zed version `0.146.0` and later. @@ -435,6 +464,7 @@ You can configure Ruff to format Python code on-save by registering the Ruff for and enabling the [`format_on_save`](https://zed.dev/docs/configuring-zed#format-on-save) setting: === "Zed 0.146.0+" + ```json { "languages": { @@ -457,6 +487,7 @@ You can configure Ruff to fix lint violations and/or organize imports on-save by `source.fixAll.ruff` and `source.organizeImports.ruff` code actions respectively: === "Zed 0.146.0+" + ```json { "languages": { @@ -482,12 +513,14 @@ Taken together, you can configure Ruff to format, fix, and organize imports on-s following `settings.json`: !!! note + For this configuration, it is important to use the correct order of the code action and formatter language server settings. The code actions should be defined before the formatter to ensure that the formatter takes care of any remaining style issues after the code actions have been applied. === "Zed 0.146.0+" + ```json { "languages": { diff --git a/docs/faq.md b/docs/faq.md index 3718b85c0b6cc..6ed942e1f3b84 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -28,7 +28,7 @@ to see a few differences on the margins, but the vast majority of your code shou When run over _non_-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. -See [_Black compatibility_](formatter.md#black-compatibility) for more. +See [_Style Guide_](formatter.md#style-guide) for more. ## How does Ruff's linter compare to Flake8? @@ -220,14 +220,39 @@ Ruff is installable under any Python version from 3.7 onwards. ## Do I need to install Rust to use Ruff? -Nope! Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI: +Nope! Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI. We recommend installing Ruff with [uv](https://docs.astral.sh/uv/), +though it's also installable with `pip`, `pipx`, and a [variety of other package managers](installation.md): ```console +$ # Install Ruff globally. +$ uv tool install ruff@latest + +$ # Or add Ruff to your project. +$ uv add --dev ruff + +$ # With pip. $ pip install ruff + +$ # With pipx. +$ pipx install ruff +``` + +Starting with version `0.5.0`, Ruff can also be installed with our standalone installers: + +```console +$ # On macOS and Linux. +$ curl -LsSf https://astral.sh/ruff/install.sh | sh + +$ # On Windows. +$ powershell -c "irm https://astral.sh/ruff/install.ps1 | iex" + +$ # For a specific version. +$ curl -LsSf https://astral.sh/ruff/0.5.0/install.sh | sh +$ powershell -c "irm https://astral.sh/ruff/0.5.0/install.ps1 | iex" ``` -Ruff ships with wheels for all major platforms, which enables `pip` to install Ruff without relying -on Rust at all. +Ruff ships with wheels for all major platforms, which enables `uv`, `pip`, and other tools to install Ruff without +relying on a Rust toolchain at all. ## Can I write my own linter plugins for Ruff? @@ -284,7 +309,31 @@ my_project When Ruff sees an import like `import foo`, it will then iterate over the `src` directories, looking for a corresponding Python module (in reality, a directory named `foo` or a file named -`foo.py`). +`foo.py`). For module paths with multiple components like `import foo.bar`, +the default behavior is to search only for a directory named `foo` or a file +named `foo.py`. However, if `preview` is enabled, Ruff will require that the full relative path `foo/bar` exists as a directory, or that `foo/bar.py` or `foo/bar.pyi` exist as files. Finally, imports of the form `from foo import bar`, Ruff will only use `foo` when determining whether a module is first-party or third-party. + +If there is a directory +whose name matches a third-party package, but does not contain Python code, +it could happen that the above algorithm incorrectly infers an import to be first-party. +To prevent this, you can modify the [`known-third-party`](settings.md#lint_isort_known-third-party) setting. For example, if you import +the package `wandb` but also have a subdirectory of your `src` with +the same name, you can add the following: + +=== "pyproject.toml" + + ```toml + [tool.ruff.lint.isort] + known-third-party = ["wandb"] + ``` + +=== "ruff.toml" + + ```toml + [lint.isort] + known-third-party = ["wandb"] + ``` + If the `src` field is omitted, Ruff will default to using the "project root", along with a `"src"` subdirectory, as the first-party sources, to support both flat and nested project layouts. @@ -498,47 +547,47 @@ then selectively enable or disable any additional rules on top of it: ``` The PEP 257 convention includes all `D` errors apart from: -[`D203`](rules/one-blank-line-before-class.md), +[`D203`](rules/incorrect-blank-line-before-class.md), [`D212`](rules/multi-line-summary-first-line.md), [`D213`](rules/multi-line-summary-second-line.md), -[`D214`](rules/section-not-over-indented.md), -[`D215`](rules/section-underline-not-over-indented.md), +[`D214`](rules/overindented-section.md), +[`D215`](rules/overindented-section-underline.md), [`D404`](rules/docstring-starts-with-this.md), -[`D405`](rules/capitalize-section-name.md), -[`D406`](rules/new-line-after-section-name.md), -[`D407`](rules/dashed-underline-after-section.md), -[`D408`](rules/section-underline-after-name.md), -[`D409`](rules/section-underline-matches-section-length.md), +[`D405`](rules/non-capitalized-section-name.md), +[`D406`](rules/missing-new-line-after-section-name.md), +[`D407`](rules/missing-dashed-underline-after-section.md), +[`D408`](rules/missing-section-underline-after-name.md), +[`D409`](rules/mismatched-section-underline-length.md), [`D410`](rules/no-blank-line-after-section.md), [`D411`](rules/no-blank-line-before-section.md), [`D413`](rules/no-blank-line-after-section.md), -[`D415`](rules/ends-in-punctuation.md), -[`D416`](rules/section-name-ends-in-colon.md), and +[`D415`](rules/missing-terminal-punctuation.md), +[`D416`](rules/missing-section-name-colon.md), and [`D417`](rules/undocumented-param.md). The NumPy convention includes all `D` errors apart from: [`D107`](rules/undocumented-public-init.md), -[`D203`](rules/one-blank-line-before-class.md), +[`D203`](rules/incorrect-blank-line-before-class.md), [`D212`](rules/multi-line-summary-first-line.md), [`D213`](rules/multi-line-summary-second-line.md), -[`D402`](rules/no-signature.md), +[`D402`](rules/signature-in-docstring.md), [`D413`](rules/no-blank-line-after-section.md), -[`D415`](rules/ends-in-punctuation.md), -[`D416`](rules/section-name-ends-in-colon.md), and +[`D415`](rules/missing-terminal-punctuation.md), +[`D416`](rules/missing-section-name-colon.md), and [`D417`](rules/undocumented-param.md). The Google convention includes all `D` errors apart from: -[`D203`](rules/one-blank-line-before-class.md), -[`D204`](rules/one-blank-line-after-class.md), +[`D203`](rules/incorrect-blank-line-before-class.md), +[`D204`](rules/incorrect-blank-line-after-class.md), [`D213`](rules/multi-line-summary-second-line.md), -[`D215`](rules/section-underline-not-over-indented.md), -[`D400`](rules/ends-in-period.md), +[`D215`](rules/overindented-section-underline.md), +[`D400`](rules/missing-trailing-period.md), [`D401`](rules/non-imperative-mood.md), [`D404`](rules/docstring-starts-with-this.md), -[`D406`](rules/new-line-after-section-name.md), -[`D407`](rules/dashed-underline-after-section.md), -[`D408`](rules/section-underline-after-name.md), -[`D409`](rules/section-underline-matches-section-length.md), and +[`D406`](rules/missing-new-line-after-section-name.md), +[`D407`](rules/missing-dashed-underline-after-section.md), +[`D408`](rules/missing-section-underline-after-name.md), +[`D409`](rules/mismatched-section-underline-length.md), and [`D413`](rules/no-blank-line-after-section.md). By default, no [`convention`](settings.md#lint_pydocstyle_convention) is set, and so the enabled rules @@ -614,7 +663,28 @@ making changes to code, even for seemingly trivial fixes. If a "safe" fix breaks Ruff's color output is powered by the [`colored`](https://crates.io/crates/colored) crate, which attempts to automatically detect whether the output stream supports color. However, you can force colors off by setting the `NO_COLOR` environment variable to any value (e.g., `NO_COLOR=1`), or -force colors on by setting `FORCE_COLOR` to any non-empty value (e.g. `FORCE_COLOR=1`). +force colors on by setting `FORCE_COLOR` to any non-empty value (e.g., `FORCE_COLOR=1`). [`colored`](https://crates.io/crates/colored) also supports the `CLICOLOR` and `CLICOLOR_FORCE` environment variables (see the [spec](https://bixense.com/clicolors/)). + +## Ruff behaves unexpectedly when using `source.*` code actions in Notebooks. What's going on? {: #source-code-actions-in-notebooks } + +Ruff does not support `source.organizeImports` and `source.fixAll` code actions in Jupyter Notebooks +(`notebook.codeActionsOnSave` in VS Code). It's recommended to use the `notebook` prefixed code +actions for the same such as `notebook.source.organizeImports` and `notebook.source.fixAll` +respectively. + +Ruff requires to have a full view of the notebook to provide accurate diagnostics and fixes. For +example, if you have a cell that imports a module and another cell that uses that module, Ruff +needs to see both cells to mark the import as used. If Ruff were to only see one cell at a time, +it would incorrectly mark the import as unused. + +When using the `source.*` code actions for a Notebook, Ruff will be asked to fix any issues for each +cell in parallel, which can lead to unexpected behavior. For example, if a user has configured to +run `source.organizeImports` code action on save for a Notebook, Ruff will attempt to fix the +imports for the entire notebook corresponding to each cell. This leads to the client making the same +changes to the notebook multiple times, which can lead to unexpected behavior +([astral-sh/ruff-vscode#680](https://github.com/astral-sh/ruff-vscode/issues/680), +[astral-sh/ruff-vscode#640](https://github.com/astral-sh/ruff-vscode/issues/640), +[astral-sh/ruff-vscode#391](https://github.com/astral-sh/ruff-vscode/issues/391)). diff --git a/docs/formatter.md b/docs/formatter.md index c85b8c82c42c5..a80028d09e8a4 100644 --- a/docs/formatter.md +++ b/docs/formatter.md @@ -3,8 +3,6 @@ The Ruff formatter is an extremely fast Python code formatter designed as a drop-in replacement for [Black](https://pypi.org/project/black/), available as part of the `ruff` CLI via `ruff format`. -The Ruff formatter is available as of Ruff [v0.1.2](https://astral.sh/blog/the-ruff-formatter). - ## `ruff format` `ruff format` is the primary entrypoint to the formatter. It accepts a list of files or @@ -22,10 +20,6 @@ and instead exit with a non-zero status code upon detecting any unformatted file For the full list of supported options, run `ruff format --help`. -!!! note - As of Ruff v0.1.7 the `ruff format` command uses the current working directory (`.`) as the default path to format. - See [the file discovery documentation](configuration.md#python-file-discovery) for details. - ## Philosophy The initial goal of the Ruff formatter is _not_ to innovate on code style, but rather, to innovate @@ -39,7 +33,7 @@ adoption is minimally disruptive for the vast majority of projects. Specifically, the formatter is intended to emit near-identical output when run over existing Black-formatted code. When run over extensive Black-formatted projects like Django and Zulip, > 99.9% -of lines are formatted identically. (See: [_Black compatibility_](#black-compatibility).) +of lines are formatted identically. (See: [_Style Guide_](#style-guide).) Given this focus on Black compatibility, the formatter thus adheres to [Black's (stable) code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html), which aims for "consistency, generality, readability and reducing git diffs". To give you a sense @@ -328,7 +322,7 @@ When using Ruff as a formatter, we recommend avoiding the following lint rules: - [`indentation-with-invalid-multiple`](rules/indentation-with-invalid-multiple.md) (`E111`) - [`indentation-with-invalid-multiple-comment`](rules/indentation-with-invalid-multiple-comment.md) (`E114`) - [`over-indented`](rules/over-indented.md) (`E117`) -- [`indent-with-spaces`](rules/indent-with-spaces.md) (`D206`) +- [`docstring-tab-indentation`](rules/docstring-tab-indentation.md) (`D206`) - [`triple-single-quotes`](rules/triple-single-quotes.md) (`D300`) - [`bad-quotes-inline-string`](rules/bad-quotes-inline-string.md) (`Q000`) - [`bad-quotes-multiline-string`](rules/bad-quotes-multiline-string.md) (`Q001`) @@ -336,8 +330,7 @@ When using Ruff as a formatter, we recommend avoiding the following lint rules: - [`avoidable-escaped-quote`](rules/avoidable-escaped-quote.md) (`Q003`) - [`missing-trailing-comma`](rules/missing-trailing-comma.md) (`COM812`) - [`prohibited-trailing-comma`](rules/prohibited-trailing-comma.md) (`COM819`) -- [`single-line-implicit-string-concatenation`](rules/single-line-implicit-string-concatenation.md) (`ISC001`) -- [`multi-line-implicit-string-concatenation`](rules/multi-line-implicit-string-concatenation.md) (`ISC002`) +- [`multi-line-implicit-string-concatenation`](rules/multi-line-implicit-string-concatenation.md) (`ISC002`) if used without `ISC001` and `flake8-implicit-str-concat.allow-multiline = false` While the [`line-too-long`](rules/line-too-long.md) (`E501`) rule _can_ be used alongside the formatter, the formatter only makes a best-effort attempt to wrap lines at the configured @@ -380,21 +373,10 @@ Meanwhile, `ruff format --check` exits with the following status codes: - `2` if Ruff terminates abnormally due to invalid configuration, invalid CLI options, or an internal error. -## Black compatibility +## Style Guide <span id="black-compatibility"></span> The formatter is designed to be a drop-in replacement for [Black](https://github.com/psf/black). - -Specifically, the formatter is intended to emit near-identical output when run over Black-formatted -code. When run over extensive Black-formatted projects like Django and Zulip, > 99.9% of lines -are formatted identically. When migrating an existing project from Black to Ruff, you should expect -to see a few differences on the margins, but the vast majority of your code should be unchanged. - -When run over _non_-Black-formatted code, the formatter makes some different decisions than Black, -and so more deviations should be expected, especially around the treatment of end-of-line comments. - -If you identify deviations in your project, spot-check them against the [known deviations](formatter/black.md), -as well as the [unintentional deviations](https://github.com/astral-sh/ruff/issues?q=is%3Aopen+is%3Aissue+label%3Aformatter) -filed in the issue tracker. If you've identified a new deviation, please [file an issue](https://github.com/astral-sh/ruff/issues/new). +This section documents the areas where the Ruff formatter goes beyond Black in terms of code style. ### Intentional deviations @@ -405,17 +387,119 @@ Black's code style, while others fall out of differences in the underlying imple For a complete enumeration of these intentional deviations, see [_Known deviations_](formatter/black.md). Unintentional deviations from Black are tracked in the [issue tracker](https://github.com/astral-sh/ruff/issues?q=is%3Aopen+is%3Aissue+label%3Aformatter). +If you've identified a new deviation, please [file an issue](https://github.com/astral-sh/ruff/issues/new). ### Preview style -Black gates formatting changes behind a [`preview`](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style) -flag. The formatter does not yet support Black's preview style, though the intention is to support -it within the coming months behind Ruff's own [`preview`](https://docs.astral.sh/ruff/settings/#preview) -flag. +Similar to [Black](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style), Ruff implements formatting changes +under the [`preview`](https://docs.astral.sh/ruff/settings/#format_preview) flag, promoting them to stable through minor releases, in accordance with our [versioning policy](https://github.com/astral-sh/ruff/discussions/6998#discussioncomment-7016766). + +### F-string formatting + +_Stabilized in Ruff 0.9.0_ + +Unlike Black, Ruff formats the expression parts of f-strings which are the parts inside the curly +braces `{...}`. This is a [known deviation](formatter/black.md#f-strings) from Black. + +Ruff employs several heuristics to determine how an f-string should be formatted which are detailed +below. + +#### Quotes + +Ruff will use the [configured quote style] for the f-string expression unless doing so would result in +invalid syntax for the target Python version or requires more backslash escapes than the original +expression. Specifically, Ruff will preserve the original quote style for the following cases: + +When the target Python version is < 3.12 and a [self-documenting f-string] contains a string +literal with the [configured quote style]: + +```python +# format.quote-style = "double" + +f'{10 + len("hello")=}' +# This f-string cannot be formatted as follows when targeting Python < 3.12 +f"{10 + len("hello")=}" +``` + +When the target Python version is < 3.12 and an f-string contains any triple-quoted string, byte +or f-string literal that contains the [configured quote style]: + +```python +# format.quote-style = "double" + +f'{"""nested " """}' +# This f-string cannot be formatted as follows when targeting Python < 3.12 +f"{'''nested " '''}" +``` + +For all target Python versions, when a [self-documenting f-string] contains an expression between +the curly braces (`{...}`) with a format specifier containing the [configured quote style]: + +```python +# format.quote-style = "double" + +f'{1=:"foo}' +# This f-string cannot be formatted as follows for all target Python versions +f"{1=:"foo}" +``` + +For nested f-strings, Ruff alternates quote styles, starting with the [configured quote style] for the +outermost f-string. For example, consider the following f-string: + +```python +# format.quote-style = "double" + +f"outer f-string {f"nested f-string {f"another nested f-string"} end"} end" +``` + +Ruff formats it as: + +```python +f"outer f-string {f'nested f-string {f"another nested f-string"} end'} end" +``` + +#### Line breaks + +Starting with Python 3.12 ([PEP 701](https://peps.python.org/pep-0701/)), the expression parts of an f-string can +span multiple lines. Ruff needs to decide when to introduce a line break in an f-string expression. +This depends on the semantic content of the expression parts of an f-string - for example, +introducing a line break in the middle of a natural-language sentence is undesirable. Since Ruff +doesn't have enough information to make that decision, it adopts a heuristic similar to [Prettier](https://prettier.io/docs/en/next/rationale.html#template-literals): +it will only split the expression parts of an f-string across multiple lines if there was already a line break +within any of the expression parts. + +For example, the following code: + +```python +f"this f-string has a multiline expression { + ['red', 'green', 'blue', 'yellow',]} and does not fit within the line length" +``` + +... is formatted as: + +```python +# The list expression is split across multiple lines because of the trailing comma +f"this f-string has a multiline expression { + [ + 'red', + 'green', + 'blue', + 'yellow', + ] +} and does not fit within the line length" +``` + +But, the following will not be split across multiple lines even though it exceeds the line length: + +```python +f"this f-string has a multiline expression {['red', 'green', 'blue', 'yellow']} and does not fit within the line length" +``` + +If you want Ruff to split an f-string across multiple lines, ensure there's a linebreak somewhere within the +`{...}` parts of an f-string. -Black promotes some of its preview styling to stable at the end of each year. Ruff will similarly -implement formatting changes under the [`preview`](https://docs.astral.sh/ruff/settings/#preview) -flag, promoting them to stable through minor releases, in accordance with our [versioning policy](https://github.com/astral-sh/ruff/discussions/6998#discussioncomment-7016766). +[self-documenting f-string]: https://realpython.com/python-f-strings/#self-documenting-expressions-for-debugging +[configured quote style]: settings.md/#format_quote-style ## Sorting imports diff --git a/docs/formatter/black.md b/docs/formatter/black.md index 5f0c12b388180..9b18bf54431e1 100644 --- a/docs/formatter/black.md +++ b/docs/formatter/black.md @@ -197,70 +197,95 @@ if x: Currently, we are concerned that allowing blank lines at the start of a block leads [to unintentional blank lines when refactoring or moving code](https://github.com/astral-sh/ruff/issues/8893#issuecomment-1867259744). However, we will consider adopting Black's formatting at a later point with an improved heuristic. The style change is tracked in [#9745](https://github.com/astral-sh/ruff/issues/9745). -### Hex codes and Unicode sequences -Ruff normalizes hex codes and Unicode sequences in strings ([#9280](https://github.com/astral-sh/ruff/pull/9280)). Black intended to ship this change as part of the 2024 style but accidentally didn't. +### F-strings + +Ruff formats expression parts in f-strings whereas Black does not: ```python +# Input +f'test{inner + "nested_string"} including math {5 ** 3 + 10}' + # Black -a = "\x1B" -b = "\u200B" -c = "\U0001F977" -d = "\N{CYRILLIC small LETTER BYELORUSSIAN-UKRAINIAN I}" +f'test{inner + "nested_string"} including math {5 ** 3 + 10}' # Ruff -a = "\x1b" -b = "\u200b" -c = "\U0001f977" -d = "\N{CYRILLIC SMALL LETTER BYELORUSSIAN-UKRAINIAN I}" +f"test{inner + 'nested_string'} including math {5**3 + 10}" ``` -### Module docstrings +For more details on the formatting style, refer to the [f-string +formatting](../formatter.md#f-string-formatting) section. -Ruff formats module docstrings similar to class or function docstrings, whereas Black does not. +### Implicit concatenated strings + +Ruff merges implicitly concatenated strings if the entire string fits on a single line: ```python # Input -"""Module docstring - -""" +def test(max_history): + raise argparse.ArgumentTypeError( + f"The value of `--max-history {max_history}` " f"is not a positive integer." + ) # Black -"""Module docstring - -""" +def test(max_history): + raise argparse.ArgumentTypeError( + f"The value of `--max-history {max_history}` " f"is not a positive integer." + ) # Ruff -"""Module docstring""" - +def test(max_history): + raise argparse.ArgumentTypeError( + f"The value of `--max-history {max_history}` is not a positive integer." + ) ``` +Black's unstable style applies the same formatting. -### Walruses in slice expressions - -Black avoids inserting space around `:=` operators within slices. For example, the following adheres -to Black stable style: +There are few rare cases where Ruff can't merge the implicitly concatenated strings automatically. +In those cases, Ruff preserves if the implicit concatenated strings are formatted over multiple lines: ```python # Input -x[y:=1] +a = ( + r"aaaaaaa" + "bbbbbbbbbbbb" +) # Black -x[y:=1] +a = r"aaaaaaa" "bbbbbbbbbbbb" + +# Ruff +a = ( + r"aaaaaaa" + "bbbbbbbbbbbb" +) ``` -Ruff will instead add space around the `:=` operator: +This ensures compatibility with `ISC001` ([#8272](https://github.com/astral-sh/ruff/issues/8272)). + +### `assert` statements + +Unlike Black, Ruff prefers breaking the message over breaking the assertion, similar to how both Ruff and Black prefer breaking the assignment value over breaking the assignment target: ```python # Input -x[y:=1] +assert ( + len(policy_types) >= priority + num_duplicates +), f"This tests needs at least {priority+num_duplicates} many types." + + +# Black +assert ( + len(policy_types) >= priority + num_duplicates +), f"This tests needs at least {priority+num_duplicates} many types." # Ruff -x[y := 1] +assert len(policy_types) >= priority + num_duplicates, ( + f"This tests needs at least {priority + num_duplicates} many types." +) ``` -This will likely be incorporated into Black's preview style ([#3823](https://github.com/psf/black/pull/3823)). - ### `global` and `nonlocal` names are broken across multiple lines by continuations If a `global` or `nonlocal` statement includes multiple names, and exceeds the configured line @@ -279,36 +304,6 @@ global \ analyze_size_model ``` -### Newlines are inserted after all class docstrings - -Black typically enforces a single newline after a class docstring. However, it does not apply such -formatting if the docstring is single-quoted rather than triple-quoted, while Ruff enforces a -single newline in both cases: - -```python -# Input -class IntFromGeom(GEOSFuncFactory): - "Argument is a geometry, return type is an integer." - argtypes = [GEOM_PTR] - restype = c_int - errcheck = staticmethod(check_minus_one) - -# Black -class IntFromGeom(GEOSFuncFactory): - "Argument is a geometry, return type is an integer." - argtypes = [GEOM_PTR] - restype = c_int - errcheck = staticmethod(check_minus_one) - -# Ruff -class IntFromGeom(GEOSFuncFactory): - "Argument is a geometry, return type is an integer." - - argtypes = [GEOM_PTR] - restype = c_int - errcheck = staticmethod(check_minus_one) -``` - ### Trailing own-line comments on imports are not moved to the next line Black enforces a single empty line between an import and a trailing own-line comment. Ruff leaves @@ -385,9 +380,7 @@ would instead format the above as: ```python print( - "aaaaaaaaaaaaaaaa" "aaaaaaaaaaaaaaaa".format( - bbbbbbbbbbbbbbbbbb + bbbbbbbbbbbbbbbbbb - ) + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".format(bbbbbbbbbbbbbbbbbb + bbbbbbbbbbbbbbbbbb) ) ``` @@ -495,38 +488,6 @@ cases: Adding parentheses around single-element tuples adds visual distinction and helps avoid "accidental" tuples created by extraneous trailing commas (see, e.g., [#17181](https://github.com/django/django/pull/17181)). -### Trailing commas are inserted when expanding a function definition with a single argument - -When a function definition with a single argument is expanded over multiple lines, Black -will add a trailing comma in some cases, depending on whether the argument includes a type -annotation and/or a default value. - -For example, Black will add a trailing comma to the first and second function definitions below, -but not the third: - -```python -def func( - aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, -) -> None: - ... - - -def func( - aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa=1, -) -> None: - ... - - -def func( - aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa: Argument( - "network_messages.pickle", - help="The path of the pickle file that will contain the network messages", - ) = 1 -) -> None: - ... -``` - -Ruff will instead insert a trailing comma in all such cases for consistency. ### Parentheses around call-chain assignment values are not preserved @@ -651,6 +612,65 @@ assert AAAAAAAAAAAAAAAAAAAAAA.bbbbbb.fooo( ) * foooooo * len(list(foo(bar(4, foo), foo))) ``` +### Single `with` item targeting Python 3.8 or older + +Unlike Black, Ruff uses the same layout for `with` statements with a single context manager as it does for `while`, `if` and other compound statements: + +```python +# Input +def run(data_path, model_uri): + with pyspark.sql.SparkSession.builder.config( + key="spark.python.worker.reuse", value=True + ).config(key="spark.ui.enabled", value=False).master( + "local-cluster[2, 1, 1024]" + ).getOrCreate(): + # ignore spark log output + spark.sparkContext.setLogLevel("OFF") + print(score_model(spark, data_path, model_uri)) + +# Black +def run(data_path, model_uri): + with pyspark.sql.SparkSession.builder.config( + key="spark.python.worker.reuse", value=True + ).config(key="spark.ui.enabled", value=False).master( + "local-cluster[2, 1, 1024]" + ).getOrCreate(): + # ignore spark log output + spark.sparkContext.setLogLevel("OFF") + print(score_model(spark, data_path, model_uri)) + +# Ruff +def run(data_path, model_uri): + with ( + pyspark.sql.SparkSession.builder.config( + key="spark.python.worker.reuse", value=True + ) + .config(key="spark.ui.enabled", value=False) + .master("local-cluster[2, 1, 1024]") + .getOrCreate() + ): + # ignore spark log output + spark.sparkContext.setLogLevel("OFF") + print(score_model(spark, data_path, model_uri)) +``` + +Ruff's formatting matches the formatting of other compound statements: + +```python +def test(): + if ( + pyspark.sql.SparkSession.builder.config( + key="spark.python.worker.reuse", value=True + ) + .config(key="spark.ui.enabled", value=False) + .master("local-cluster[2, 1, 1024]") + .getOrCreate() + ): + # ignore spark log output + spark.sparkContext.setLogLevel("OFF") + print(score_model(spark, data_path, model_uri)) +``` + ### The last context manager in a `with` statement may be collapsed onto a single line When using a `with` statement with multiple unparenthesized context managers, Ruff may collapse the @@ -699,3 +719,26 @@ with tempfile.TemporaryDirectory() as d1: ): pass ``` + +### Preserving parentheses around single-element lists + +Ruff preserves at least one parentheses around list elements, even if the list only contains a single element. The Black 2025 or newer, on the other hand, removes the parentheses +for single-element lists if they aren't multiline and doing so does not change semantics: + +```python +# Input +items = [(True)] +items = [(((((True)))))] +items = {(123)} + +# Black +items = [True] +items = [True] +items = {123} + +# Ruff +items = [(True)] +items = [(True)] +items = {(123)} + +``` diff --git a/docs/installation.md b/docs/installation.md index d73fafa1c1e80..c8df38ee164c2 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,9 +1,28 @@ # Installing Ruff -Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI: +Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI. + +Ruff can be invoked directly with [`uvx`](https://docs.astral.sh/uv/): + +```shell +uvx ruff check # Lint all files in the current directory. +uvx ruff format # Format all files in the current directory. +``` + +Or installed with `uv` (recommended), `pip`, or `pipx`: ```console +$ # Install Ruff globally. +$ uv tool install ruff@latest + +$ # Or add Ruff to your project. +$ uv add --dev ruff + +$ # With pip. $ pip install ruff + +$ # With pipx. +$ pipx install ruff ``` Once installed, you can run Ruff from the command line: @@ -13,7 +32,7 @@ $ ruff check # Lint all files in the current directory. $ ruff format # Format all files in the current directory. ``` -Starting with version `0.5.0`, Ruff can be installed with our standalone installers: +Starting with version `0.5.0`, Ruff can also be installed with our standalone installers: ```console $ # On macOS and Linux. diff --git a/docs/integrations.md b/docs/integrations.md index e8479db3b90ab..7be48ce36a001 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -46,13 +46,13 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: astral-sh/ruff-action@v1 + - uses: astral-sh/ruff-action@v3 ``` Alternatively, you can include `ruff-action` as a step in any other workflow file: ```yaml - - uses: astral-sh/ruff-action@v1 + - uses: astral-sh/ruff-action@v3 ``` `ruff-action` accepts optional configuration parameters via `with:`, including: @@ -61,12 +61,12 @@ Alternatively, you can include `ruff-action` as a step in any other workflow fil - `args`: The command-line arguments to pass to Ruff (default: `"check"`). - `src`: The source paths to pass to Ruff (default: `[".", "src"]`). -For example, to run `ruff check --select B ./src` using Ruff version `0.0.259`: +For example, to run `ruff check --select B ./src` using Ruff version `0.8.0`: ```yaml -- uses: astral-sh/ruff-action@v1 +- uses: astral-sh/ruff-action@v3 with: - version: 0.0.259 + version: 0.8.0 args: check --select B src: "./src" ``` @@ -80,13 +80,13 @@ You can add the following configuration to `.gitlab-ci.yml` to run a `ruff forma stage: build interruptible: true image: - name: ghcr.io/astral-sh/ruff:0.7.1-alpine + name: ghcr.io/astral-sh/ruff:0.11.10-alpine before_script: - cd $CI_PROJECT_DIR - ruff --version Ruff Check: - extends: .base_ruff + extends: .base_ruff script: - ruff check --output-format=gitlab > code-quality-report.json artifacts: @@ -106,7 +106,7 @@ Ruff can be used as a [pre-commit](https://pre-commit.com) hook via [`ruff-pre-c ```yaml - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.7.1 + rev: v0.11.10 hooks: # Run the linter. - id: ruff @@ -119,7 +119,7 @@ To enable lint fixes, add the `--fix` argument to the lint hook: ```yaml - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.7.1 + rev: v0.11.10 hooks: # Run the linter. - id: ruff @@ -128,20 +128,20 @@ To enable lint fixes, add the `--fix` argument to the lint hook: - id: ruff-format ``` -To run the hooks over Jupyter Notebooks too, add `jupyter` to the list of allowed filetypes: +To avoid running on Jupyter Notebooks, remove `jupyter` from the list of allowed filetypes: ```yaml - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.7.1 + rev: v0.11.10 hooks: # Run the linter. - id: ruff - types_or: [ python, pyi, jupyter ] + types_or: [ python, pyi ] args: [ --fix ] # Run the formatter. - id: ruff-format - types_or: [ python, pyi, jupyter ] + types_or: [ python, pyi ] ``` When running with `--fix`, Ruff's lint hook should be placed _before_ Ruff's formatter hook, and diff --git a/docs/linter.md b/docs/linter.md index 66e90bc83a8d7..1f3e4f22b5efa 100644 --- a/docs/linter.md +++ b/docs/linter.md @@ -8,22 +8,19 @@ and more. ## `ruff check` `ruff check` is the primary entrypoint to the Ruff linter. It accepts a list of files or -directories, and lints all discovered Python files, optionally fixing any fixable errors: +directories, and lints all discovered Python files, optionally fixing any fixable errors. +When linting a directory, Ruff searches for Python files recursively in that directory +and all its subdirectories: ```console -$ ruff check # Lint all files in the current directory. -$ ruff check --fix # Lint all files in the current directory, and fix any fixable errors. -$ ruff check --watch # Lint all files in the current directory, and re-lint on change. -$ ruff check path/to/code/ # Lint all files in `path/to/code` (and any subdirectories). +$ ruff check # Lint files in the current directory. +$ ruff check --fix # Lint files in the current directory and fix any fixable errors. +$ ruff check --watch # Lint files in the current directory and re-lint on change. +$ ruff check path/to/code/ # Lint files in `path/to/code`. ``` For the full list of supported options, run `ruff check --help`. -!!! note - As of Ruff v0.1.7 the `ruff check` command uses the current working directory (`.`) as the default path to check. - On older versions, you must provide this manually e.g. `ruff check .`. - See [the file discovery documentation](configuration.md#python-file-discovery) for details. - ## Rule selection The set of enabled rules is controlled via the [`lint.select`](settings.md#lint_select), @@ -161,7 +158,11 @@ whether a rule supports fixing, see [_Rules_](rules.md). ### Fix safety Ruff labels fixes as "safe" and "unsafe". The meaning and intent of your code will be retained when -applying safe fixes, but the meaning could be changed when applying unsafe fixes. +applying safe fixes, but the meaning could change when applying unsafe fixes. + +Specifically, an unsafe fix could lead to a change in runtime behavior, the removal of comments, or both, +while safe fixes are intended to preserve runtime behavior and will only remove comments when deleting +entire statements or expressions (e.g., removing unused imports). For example, [`unnecessary-iterable-allocation-for-first-element`](rules/unnecessary-iterable-allocation-for-first-element.md) (`RUF015`) is a rule which checks for potentially unperformant use of `list(...)[0]`. The fix @@ -177,7 +178,7 @@ $ python -m timeit "head = next(iter(range(99999999)))" 5000000 loops, best of 5: 70.8 nsec per loop ``` -However, when the collection is empty, this changes the raised exception from an `IndexError` to `StopIteration`: +However, when the collection is empty, this raised exception changes from an `IndexError` to `StopIteration`: ```console $ python -c 'list(range(0))[0]' @@ -193,7 +194,7 @@ Traceback (most recent call last): StopIteration ``` -Since this could break error handling, this fix is categorized as unsafe. +Since the change in exception type could break error handling upstream, this fix is categorized as unsafe. Ruff only enables safe fixes by default. Unsafe fixes can be enabled by settings [`unsafe-fixes`](settings.md#unsafe-fixes) in your configuration file or passing the `--unsafe-fixes` flag to `ruff check`: @@ -336,6 +337,27 @@ violations on a single line. Note that Ruff will also respect Flake8's `# flake8: noqa` directive, and will treat it as equivalent to `# ruff: noqa`. +### Full suppression comment specification + +The full specification is as follows: + +- An inline blanket `noqa` comment is given by a case-insensitive match for + `#noqa` with optional whitespace after the `#` symbol, followed by either: the + end of the comment, the beginning of a new comment (`#`), or whitespace + followed by any character other than `:`. +- An inline rule suppression is given by first finding a case-insensitive match + for `#noqa` with optional whitespace after the `#` symbol, optional whitespace + after `noqa`, and followed by the symbol `:`. After this we are expected to + have a list of rule codes which is given by sequences of uppercase ASCII + characters followed by ASCII digits, separated by whitespace or commas. The + list ends at the last valid code. We will attempt to interpret rules with a + missing delimiter (e.g. `F401F841`), though a warning will be emitted in this + case. +- A file-level exemption comment is given by a case-sensitive match for `#ruff:` + or `#flake8:`, with optional whitespace after `#` and before `:`, followed by + optional whitespace and a case-insensitive match for `noqa`. After this, the + specification is as in the inline case. + ### Detecting unused suppression comments Ruff implements a special rule, [`unused-noqa`](https://docs.astral.sh/ruff/rules/unused-noqa/), diff --git a/docs/preview.md b/docs/preview.md index bba1b5bd3e4e5..56590c7578400 100644 --- a/docs/preview.md +++ b/docs/preview.md @@ -12,7 +12,7 @@ Enabling preview mode does not on its own enable all preview rules. See the [rul Preview mode can be enabled with the `--preview` flag on the CLI or by setting `preview = true` in your Ruff configuration file. -Preview mode can be configured separately for linting and formatting (requires Ruff v0.1.1+). To enable preview lint rules without preview style formatting: +Preview mode can be configured separately for linting and formatting. To enable preview lint rules without preview style formatting: === "pyproject.toml" @@ -177,7 +177,7 @@ setting in your configuration file: ``` In our previous example, `--select` with `ALL` `HYP`, `HYP0`, or `HYP00` would not enable `HYP001`. Each preview -rule will need to be selected with its exact code, e.g. `--select ALL,HYP001`. +rule will need to be selected with its exact code: for example, `--select ALL,HYP001`. If preview mode is not enabled, this setting has no effect. diff --git a/docs/requirements-insiders.txt b/docs/requirements-insiders.txt index 1ff9edc94d662..bd78766ab9941 100644 --- a/docs/requirements-insiders.txt +++ b/docs/requirements-insiders.txt @@ -1,11 +1,8 @@ PyYAML==6.0.2 -ruff==0.7.1 +ruff==0.11.10 mkdocs==1.6.1 -mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 -mkdocs-redirects==1.2.1 -mdformat==0.7.18 -mdformat-mkdocs==3.0.1 -mdformat-admon==2.0.6 -# Using a commit from pygments main branch so we get -# https://github.com/pygments/pygments/pull/2773 before it's been released -pygments @ git+https://github.com/pygments/pygments.git@67b460fdde6d9a00342b5102b37b3a8399f0e8ef +mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@39da7a5e761410349e9a1b8abf593b0cdd5453ff +mkdocs-redirects==1.2.2 +mdformat==0.7.22 +mdformat-mkdocs==4.1.2 +mkdocs-github-admonitions-plugin @ https://github.com/PGijsbers/admonitions.git#7343d2f4a92e4d1491094530ef3d0d02d93afbb7 diff --git a/docs/requirements.txt b/docs/requirements.txt index b326261551c51..b1bfb2b640917 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,11 +1,8 @@ PyYAML==6.0.2 -ruff==0.7.1 +ruff==0.11.10 mkdocs==1.6.1 -mkdocs-material==9.1.18 -mkdocs-redirects==1.2.1 -mdformat==0.7.18 -mdformat-mkdocs==3.0.1 -mdformat-admon==2.0.6 -# Using a commit from pygments main branch so we get -# https://github.com/pygments/pygments/pull/2773 before it's been released -pygments @ git+https://github.com/pygments/pygments.git@67b460fdde6d9a00342b5102b37b3a8399f0e8ef +mkdocs-material==9.5.38 +mkdocs-redirects==1.2.2 +mdformat==0.7.22 +mdformat-mkdocs==4.1.2 +mkdocs-github-admonitions-plugin @ https://github.com/PGijsbers/admonitions.git#7343d2f4a92e4d1491094530ef3d0d02d93afbb7 diff --git a/docs/tutorial.md b/docs/tutorial.md index 313745f985a2b..1e249e10c8c51 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -5,21 +5,26 @@ your project. For a more detailed overview, see [_Configuring Ruff_](configurati ## Getting Started -To start, we'll install Ruff through PyPI (or with your [preferred package manager](installation.md)): +To start, we'll initialize a project using [uv](https://docs.astral.sh/uv/): ```console -$ pip install ruff +$ uv init --lib numbers ``` -Let's then assume that our project structure looks like: +This command creates a Python project with the following structure: ```text numbers - ├── __init__.py - └── numbers.py + ├── README.md + ├── pyproject.toml + └── src + └── numbers + ├── __init__.py + └── py.typed ``` -...where `numbers.py` contains the following code: +We'll then clear out the auto-generated content in `src/numbers/__init__.py` +and create `src/numbers/calculate.py` with the following code: ```python from typing import Iterable @@ -35,28 +40,40 @@ def sum_even_numbers(numbers: Iterable[int]) -> int: ) ``` -We can run the Ruff linter over our project via `ruff check`: +Next, we'll add Ruff to our project: ```console -$ ruff check -numbers/numbers.py:3:8: F401 [*] `os` imported but unused +$ uv add --dev ruff +``` + +We can then run the Ruff linter over our project via `uv run ruff check`: + +```console +$ uv run ruff check +src/numbers/calculate.py:3:8: F401 [*] `os` imported but unused Found 1 error. [*] 1 fixable with the `--fix` option. ``` +!!! note + + As an alternative to `uv run`, you can also run Ruff by activating the project's virtual + environment (`source .venv/bin/active` on Linux and macOS, or `.venv\Scripts\activate` on + Windows) and running `ruff check` directly. + Ruff identified an unused import, which is a common error in Python code. Ruff considers this a "fixable" error, so we can resolve the issue automatically by running `ruff check --fix`: ```console -$ ruff check --fix +$ uv run ruff check --fix Found 1 error (1 fixed, 0 remaining). ``` Running `git diff` shows the following: ```diff ---- a/numbers/numbers.py -+++ b/numbers/numbers.py +--- a/src/numbers/calculate.py ++++ b/src/numbers/calculate.py @@ -1,7 +1,5 @@ from typing import Iterable @@ -74,13 +91,13 @@ def sum_even_numbers(numbers: Iterable[int]) -> int: Note Ruff runs in the current directory by default, but you can pass specific paths to check: ```console -$ ruff check numbers/numbers.py +$ uv run ruff check src/numbers/calculate.py ``` Now that our project is passing `ruff check`, we can run the Ruff formatter via `ruff format`: ```console -$ ruff format +$ uv run ruff format 1 file reformatted ``` @@ -88,8 +105,8 @@ Running `git diff` shows that the `sum` call was reformatted to fit within the d line length limit: ```diff ---- a/numbers.py -+++ b/numbers.py +--- a/src/numbers/calculate.py ++++ b/src/numbers/calculate.py @@ -3,7 +3,4 @@ from typing import Iterable def sum_even_numbers(numbers: Iterable[int]) -> int: @@ -109,7 +126,7 @@ Ruff's behavior. To determine the appropriate settings for each Python file, Ruff looks for the first `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file in the file's directory or any parent directory. -To configure Ruff, let's create a configuration file in our project's root directory: +To configure Ruff, we'll add the following to the configuration file in our project's root directory: === "pyproject.toml" @@ -141,8 +158,8 @@ To configure Ruff, let's create a configuration file in our project's root direc Running Ruff again, we see that it now enforces a maximum line width, with a limit of 79: ```console -$ ruff check -numbers/numbers.py:5:80: E501 Line too long (90 > 79) +$ uv run ruff check +src/numbers/calculate.py:5:80: E501 Line too long (90 > 79) Found 1 error. ``` @@ -223,8 +240,8 @@ If we run Ruff again, we'll see that it now enforces the pyupgrade rules. In par the use of the deprecated `typing.Iterable` instead of `collections.abc.Iterable`: ```console -$ ruff check -numbers/numbers.py:1:1: UP035 [*] Import from `collections.abc` instead: `Iterable` +$ uv run ruff check +src/numbers/calculate.py:1:1: UP035 [*] Import from `collections.abc` instead: `Iterable` Found 1 error. [*] 1 fixable with the `--fix` option. ``` @@ -266,10 +283,16 @@ all functions have docstrings: If we run Ruff again, we'll see that it now enforces the pydocstyle rules: ```console -$ ruff check -numbers/__init__.py:1:1: D104 Missing docstring in public package -numbers/numbers.py:1:1: UP035 [*] Import from `collections.abc` instead: `Iterable` -numbers/numbers.py:1:1: D100 Missing docstring in public module +$ uv run ruff check +src/numbers/__init__.py:1:1: D104 Missing docstring in public package +src/numbers/calculate.py:1:1: UP035 [*] Import from `collections.abc` instead: `Iterable` + | +1 | from typing import Iterable + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ UP035 + | + = help: Import from `collections.abc` + +src/numbers/calculate.py:1:1: D100 Missing docstring in public module Found 3 errors. [*] 1 fixable with the `--fix` option. ``` @@ -291,10 +314,10 @@ def sum_even_numbers(numbers: Iterable[int]) -> int: Running `ruff check` again, we'll see that it no longer flags the `Iterable` import: ```console -$ ruff check -numbers/__init__.py:1:1: D104 Missing docstring in public package -numbers/numbers.py:1:1: D100 Missing docstring in public module -Found 3 errors. +$ uv run ruff check +src/numbers/__init__.py:1:1: D104 Missing docstring in public package +src/numbers/calculate.py:1:1: D100 Missing docstring in public module +Found 2 errors. ``` If we want to ignore a rule for an entire file, we can add the line `# ruff: noqa: {code}` anywhere @@ -322,23 +345,20 @@ line based on its existing violations. We can combine `--add-noqa` with the `--s flag to add `# noqa` directives to all existing `UP035` violations: ```console -$ ruff check --select UP035 --add-noqa . +$ uv run ruff check --select UP035 --add-noqa . Added 1 noqa directive. ``` Running `git diff` shows the following: ```diff -diff --git a/tutorial/src/main.py b/tutorial/src/main.py -index b9291c5ca..b9f15b8c1 100644 ---- a/numbers/numbers.py -+++ b/numbers/numbers.py +diff --git a/numbers/src/numbers/calculate.py b/numbers/src/numbers/calculate.py +index 71fca60c8d..e92d839f1b 100644 +--- a/numbers/src/numbers/calculate.py ++++ b/numbers/src/numbers/calculate.py @@ -1,4 +1,4 @@ -from typing import Iterable +from typing import Iterable # noqa: UP035 - - - def sum_even_numbers(numbers: Iterable[int]) -> int: ``` ## Integrations @@ -349,7 +369,7 @@ This tutorial has focused on Ruff's command-line interface, but Ruff can also be ```yaml - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.1.4 + rev: v0.11.10 hooks: # Run the linter. - id: ruff diff --git a/docs/versioning.md b/docs/versioning.md index 3546d0a696cc4..2740cf2b6efc7 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -48,6 +48,15 @@ Ruff uses a custom versioning scheme that uses the **minor** version number for - A new server setting is added - A server setting is deprecated +## Minimum supported Rust version + +The minimum supported Rust version required to compile Ruff is listed in the `rust-version` key of +the `[workspace.package]` section in `Cargo.toml`. It may change in any release (minor or patch). It +will never be newer than N-2 Rust versions, where N is the latest stable version. For example, if +the latest stable Rust version is 1.85, Ruff's minimum supported Rust version will be at most 1.83. + +This is only relevant to users who build Ruff from source. Installing Ruff from the Python package +index usually installs a pre-built binary and does not require Rust compilation. ## Preview mode diff --git a/fuzz/.gitignore b/fuzz/.gitignore index 0aae9a3e34315..41cc193fba36a 100644 --- a/fuzz/.gitignore +++ b/fuzz/.gitignore @@ -1,3 +1,3 @@ artifacts/ -corpus/ruff_fix_validity +corpus/ Cargo.lock diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml index 24c0e57e3e85b..6eca24519666c 100644 --- a/fuzz/Cargo.toml +++ b/fuzz/Cargo.toml @@ -2,8 +2,8 @@ name = "ruff-fuzz" version = "0.0.0" authors = [ - "Charlie Marsh <charlie.r.marsh@gmail.com>", - "Addison Crump <research@addisoncrump.info>", + "Charlie Marsh <charlie.r.marsh@gmail.com>", + "Addison Crump <research@addisoncrump.info>", ] publish = false edition = "2021" @@ -17,21 +17,31 @@ libfuzzer = ["libfuzzer-sys/link_libfuzzer"] cargo-fuzz = true [dependencies] +ruff_db = { path = "../crates/ruff_db" } ruff_linter = { path = "../crates/ruff_linter" } ruff_python_ast = { path = "../crates/ruff_python_ast" } ruff_python_codegen = { path = "../crates/ruff_python_codegen" } ruff_python_parser = { path = "../crates/ruff_python_parser" } ruff_source_file = { path = "../crates/ruff_source_file" } -ruff_python_formatter = { path = "../crates/ruff_python_formatter"} +ruff_python_formatter = { path = "../crates/ruff_python_formatter" } ruff_text_size = { path = "../crates/ruff_text_size" } +ty_python_semantic = { path = "../crates/ty_python_semantic" } +ty_vendored = { path = "../crates/ty_vendored" } + libfuzzer-sys = { git = "https://github.com/rust-fuzz/libfuzzer", default-features = false } +salsa = { git = "https://github.com/salsa-rs/salsa.git", rev = "4818b15f3b7516555d39f5a41cb75970448bee4c" } similar = { version = "2.5.0" } +tracing = { version = "0.1.40" } # Prevent this from interfering with workspaces [workspace] members = ["."] +[[bin]] +name = "ty_check_invalid_syntax" +path = "fuzz_targets/ty_check_invalid_syntax.rs" + [[bin]] name = "ruff_parse_simple" path = "fuzz_targets/ruff_parse_simple.rs" diff --git a/fuzz/README.md b/fuzz/README.md index 1b91e57d05c1f..8d249780d0a51 100644 --- a/fuzz/README.md +++ b/fuzz/README.md @@ -12,8 +12,11 @@ To use the fuzzers provided in this directory, start by invoking: This will install [`cargo-fuzz`](https://github.com/rust-fuzz/cargo-fuzz) and optionally download a [dataset](https://zenodo.org/record/3628784) which improves the efficacy of the testing. -**This step is necessary for initialising the corpus directory, as all fuzzers share a common -corpus.** + +> [!NOTE] +> +> This step is necessary for initialising the corpus directory, as all fuzzers share a common corpus. + The dataset may take several hours to download and clean, so if you're just looking to try out the fuzzers, skip the dataset download, though be warned that some features simply cannot be tested without it (very unlikely for the fuzzer to generate valid python code from "thin air"). @@ -24,13 +27,23 @@ Once you have initialised the fuzzers, you can then execute any fuzzer with: cargo fuzz run -s none name_of_fuzzer -- -timeout=1 ``` -**Users using Apple M1 devices must use a nightly compiler and omit the `-s none` portion of this -command, as this architecture does not support fuzzing without a sanitizer.** +> [!NOTE] +> +> Users using Apple M1 devices must use a nightly compiler and omit the `-s none` portion of this +> command, as this architecture does not support fuzzing without a sanitizer. +> +> ```shell +> cargo +nightly fuzz run name_of_fuzzer -- -timeout=1 +> ``` + You can view the names of the available fuzzers with `cargo fuzz list`. For specific details about how each fuzzer works, please read this document in its entirety. -**IMPORTANT: You should run `./reinit-fuzzer.sh` after adding more file-based testcases.** This will -allow the testing of new features that you've added unit tests for. +> [!NOTE] +> +> Re-run `./init-fuzzer.sh` (say no to the dataset download) after adding more file-based test cases +> to the repository. This will make sure that the corpus is up to date with any new Python code +> added to the repository. ### Debugging a crash @@ -74,6 +87,15 @@ Each fuzzer harness in [`fuzz_targets`](fuzz_targets) targets a different aspect them in different ways. While there is implementation-specific documentation in the source code itself, each harness is briefly described below. +### `ty_check_invalid_syntax` + +This fuzz harness checks that the type checker (ty) does not panic when checking a source +file with invalid syntax. This rejects any corpus entries that is already valid Python code. +Currently, this is limited to syntax errors that's produced by Ruff's Python parser which means +that it does not cover all possible syntax errors (<https://github.com/astral-sh/ruff/issues/11934>). +A possible workaround for now would be to bypass the parser and run the type checker on all inputs +regardless of syntax errors. + ### `ruff_parse_simple` This fuzz harness does not perform any "smart" testing of Ruff; it merely checks that the parsing diff --git a/fuzz/corpus/ruff_formatter_idempotency b/fuzz/corpus/ruff_formatter_idempotency deleted file mode 120000 index 38dc5bc1ea310..0000000000000 --- a/fuzz/corpus/ruff_formatter_idempotency +++ /dev/null @@ -1 +0,0 @@ -ruff_fix_validity \ No newline at end of file diff --git a/fuzz/corpus/ruff_formatter_validity b/fuzz/corpus/ruff_formatter_validity deleted file mode 120000 index 38dc5bc1ea310..0000000000000 --- a/fuzz/corpus/ruff_formatter_validity +++ /dev/null @@ -1 +0,0 @@ -ruff_fix_validity \ No newline at end of file diff --git a/fuzz/corpus/ruff_new_parser_equiv b/fuzz/corpus/ruff_new_parser_equiv deleted file mode 120000 index 38dc5bc1ea310..0000000000000 --- a/fuzz/corpus/ruff_new_parser_equiv +++ /dev/null @@ -1 +0,0 @@ -ruff_fix_validity \ No newline at end of file diff --git a/fuzz/corpus/ruff_parse_idempotency b/fuzz/corpus/ruff_parse_idempotency deleted file mode 120000 index 61e7ad4b4cd6f..0000000000000 --- a/fuzz/corpus/ruff_parse_idempotency +++ /dev/null @@ -1 +0,0 @@ -ruff_parse_simple \ No newline at end of file diff --git a/fuzz/corpus/ruff_parse_simple b/fuzz/corpus/ruff_parse_simple deleted file mode 120000 index 018c02efec25c..0000000000000 --- a/fuzz/corpus/ruff_parse_simple +++ /dev/null @@ -1 +0,0 @@ -ruff_fix_validity/ \ No newline at end of file diff --git a/fuzz/fuzz_targets/ruff_formatter_validity.rs b/fuzz/fuzz_targets/ruff_formatter_validity.rs index a3b9276c43b4a..cd7b39e78ec91 100644 --- a/fuzz/fuzz_targets/ruff_formatter_validity.rs +++ b/fuzz/fuzz_targets/ruff_formatter_validity.rs @@ -37,7 +37,7 @@ fn do_fuzz(case: &[u8]) -> Corpus { ParseSource::None, ); - if linter_result.has_syntax_error { + if linter_result.has_syntax_errors() { return Corpus::Keep; // keep, but don't continue } @@ -63,7 +63,7 @@ fn do_fuzz(case: &[u8]) -> Corpus { ); assert!( - !linter_result.has_syntax_error, + !linter_result.has_syntax_errors(), "formatter introduced a parse error" ); diff --git a/fuzz/fuzz_targets/ty_check_invalid_syntax.rs b/fuzz/fuzz_targets/ty_check_invalid_syntax.rs new file mode 100644 index 0000000000000..dbc814644c78a --- /dev/null +++ b/fuzz/fuzz_targets/ty_check_invalid_syntax.rs @@ -0,0 +1,159 @@ +//! Fuzzer harness that runs the type checker to catch for panics for source code containing +//! syntax errors. + +#![no_main] + +use std::sync::{Arc, Mutex, OnceLock}; + +use libfuzzer_sys::{Corpus, fuzz_target}; + +use ruff_db::files::{File, Files, system_path_to_file}; +use ruff_db::system::{ + DbWithTestSystem, DbWithWritableSystem as _, System, SystemPathBuf, TestSystem, +}; +use ruff_db::vendored::VendoredFileSystem; +use ruff_db::{Db as SourceDb, Upcast}; +use ruff_python_ast::PythonVersion; +use ruff_python_parser::{Mode, ParseOptions, parse_unchecked}; +use ty_python_semantic::lint::LintRegistry; +use ty_python_semantic::types::check_types; +use ty_python_semantic::{ + Db as SemanticDb, Program, ProgramSettings, PythonPlatform, SearchPathSettings, + default_lint_registry, lint::RuleSelection, PythonVersionWithSource, +}; + +/// Database that can be used for testing. +/// +/// Uses an in memory filesystem and it stubs out the vendored files by default. +#[salsa::db] +#[derive(Clone)] +struct TestDb { + storage: salsa::Storage<Self>, + files: Files, + system: TestSystem, + vendored: VendoredFileSystem, + rule_selection: Arc<RuleSelection>, +} + +impl TestDb { + fn new() -> Self { + Self { + storage: salsa::Storage::new(Some(Box::new({ + move |event| { + tracing::trace!("event: {:?}", event); + } + }))), + system: TestSystem::default(), + vendored: ty_vendored::file_system().clone(), + files: Files::default(), + rule_selection: RuleSelection::from_registry(default_lint_registry()).into(), + } + } +} + +#[salsa::db] +impl SourceDb for TestDb { + fn vendored(&self) -> &VendoredFileSystem { + &self.vendored + } + + fn system(&self) -> &dyn System { + &self.system + } + + fn files(&self) -> &Files { + &self.files + } + + fn python_version(&self) -> PythonVersion { + Program::get(self).python_version(self) + } +} + +impl DbWithTestSystem for TestDb { + fn test_system(&self) -> &TestSystem { + &self.system + } + + fn test_system_mut(&mut self) -> &mut TestSystem { + &mut self.system + } +} + +impl Upcast<dyn SourceDb> for TestDb { + fn upcast(&self) -> &(dyn SourceDb + 'static) { + self + } + fn upcast_mut(&mut self) -> &mut (dyn SourceDb + 'static) { + self + } +} + +#[salsa::db] +impl SemanticDb for TestDb { + fn is_file_open(&self, file: File) -> bool { + !file.path(self).is_vendored_path() + } + + fn rule_selection(&self) -> &RuleSelection { + &self.rule_selection + } + + fn lint_registry(&self) -> &LintRegistry { + default_lint_registry() + } +} + +#[salsa::db] +impl salsa::Database for TestDb {} + +fn setup_db() -> TestDb { + let db = TestDb::new(); + + let src_root = SystemPathBuf::from("/src"); + db.memory_file_system() + .create_directory_all(&src_root) + .unwrap(); + + Program::from_settings( + &db, + ProgramSettings { + python_version: PythonVersionWithSource::default(), + python_platform: PythonPlatform::default(), + search_paths: SearchPathSettings::new(vec![src_root]), + }, + ) + .expect("Valid search path settings"); + + db +} + +static TEST_DB: OnceLock<Mutex<TestDb>> = OnceLock::new(); + +fn do_fuzz(case: &[u8]) -> Corpus { + let Ok(code) = std::str::from_utf8(case) else { + return Corpus::Reject; + }; + + let parsed = parse_unchecked(code, ParseOptions::from(Mode::Module)); + if parsed.has_valid_syntax() { + return Corpus::Reject; + } + + let mut db = TEST_DB + .get_or_init(|| Mutex::new(setup_db())) + .lock() + .unwrap(); + + for path in &["/src/a.py", "/src/a.pyi"] { + db.write_file(path, code).unwrap(); + let file = system_path_to_file(&*db, path).unwrap(); + check_types(&*db, file); + db.memory_file_system().remove_file(path).unwrap(); + file.sync(&mut *db); + } + + Corpus::Keep +} + +fuzz_target!(|case: &[u8]| -> Corpus { do_fuzz(case) }); diff --git a/fuzz/init-fuzzer.sh b/fuzz/init-fuzzer.sh index 77d4cdfcb30bf..2419ae24662f9 100755 --- a/fuzz/init-fuzzer.sh +++ b/fuzz/init-fuzzer.sh @@ -6,21 +6,47 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) cd "$SCRIPT_DIR" if ! cargo fuzz --help >&/dev/null; then + echo "Installing cargo-fuzz..." cargo install --git https://github.com/rust-fuzz/cargo-fuzz.git fi -if [ ! -d corpus/ruff_fix_validity ]; then - mkdir -p corpus/ruff_fix_validity - read -p "Would you like to build a corpus from a python source code dataset? (this will take a long time!) [Y/n] " -n 1 -r - echo - cd corpus/ruff_fix_validity - if [[ $REPLY =~ ^[Yy]$ ]]; then - curl -L 'https://zenodo.org/record/3628784/files/python-corpus.tar.gz?download=1' | tar xz +if [ ! -d corpus/common ]; then + mkdir -p corpus/common + + echo "Creating symlinks for fuzz targets to the common corpus directory..." + for target in fuzz_targets/*; do + corpus_dir="$(basename "$target" .rs)" + ln -vs "./common" "corpus/$corpus_dir" + done + + ( + cd corpus/common + + read -p "Would you like to build a corpus from a python source code dataset? (this will take a long time!) [Y/n] " -n 1 -r + echo + if [[ $REPLY =~ ^[Yy]$ ]]; then + echo "Downloading the Python source code dataset..." + curl -L 'https://zenodo.org/record/3628784/files/python-corpus.tar.gz?download=1' | tar xz + fi + + # Build a smaller corpus in addition to the (optional) larger corpus + echo "Building a smaller corpus dataset..." + curl -L 'https://github.com/python/cpython/archive/refs/tags/v3.13.0.tar.gz' | tar xz + cp -r "../../../crates/ty_project/resources/test/corpus" "ty_project" + cp -r "../../../crates/ruff_linter/resources/test/fixtures" "ruff_linter" + cp -r "../../../crates/ruff_python_formatter/resources/test/fixtures" "ruff_python_formatter" + cp -r "../../../crates/ruff_python_parser/resources" "ruff_python_parser" + + # Delete all non-Python files + find . -type f -not -name "*.py" -delete + ) + + echo "Minifying the corpus dataset..." + if [[ "$OSTYPE" == "darwin"* ]]; then + cargo +nightly fuzz cmin ruff_fix_validity corpus/common -- -timeout=5 + else + cargo fuzz cmin -s none ruff_fix_validity corpus/common -- -timeout=5 fi - curl -L 'https://github.com/python/cpython/archive/refs/tags/v3.12.0b2.tar.gz' | tar xz - cp -r "../../../crates/ruff_linter/resources/test" . - cd - - cargo fuzz cmin -s none ruff_fix_validity -- -timeout=5 fi -echo "Done! You are ready to fuzz." +echo "Done! You are ready to fuzz" diff --git a/fuzz/reinit-fuzzer.sh b/fuzz/reinit-fuzzer.sh deleted file mode 100755 index f1e2a698fb192..0000000000000 --- a/fuzz/reinit-fuzzer.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -# https://stackoverflow.com/a/246128/3549270 -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -cd "$SCRIPT_DIR" - -cd corpus/ruff_fix_validity -curl -L 'https://github.com/python/cpython/archive/refs/tags/v3.12.0b2.tar.gz' | tar xz -cp -r "../../../crates/ruff_linter/resources/test" . -cd - -cargo fuzz cmin -s none ruff_fix_validity -- -timeout=5 - -echo "Done! You are ready to fuzz." diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml index 1842e9ead28c5..701443809ae3b 100644 --- a/mkdocs.insiders.yml +++ b/mkdocs.insiders.yml @@ -1 +1,3 @@ INHERIT: mkdocs.generated.yml +watch: + - mkdocs.generated.yml diff --git a/mkdocs.public.yml b/mkdocs.public.yml index 45b0689071e65..b6d7ae6ecaeee 100644 --- a/mkdocs.public.yml +++ b/mkdocs.public.yml @@ -2,3 +2,5 @@ INHERIT: mkdocs.generated.yml # Omit the `typeset` plugin which is only available in the Insiders version. plugins: - search +watch: + - mkdocs.generated.yml diff --git a/mkdocs.template.yml b/mkdocs.template.yml index d722bb97ce119..41f9bbddcc3c8 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -62,6 +62,7 @@ markdown_extensions: alternate_style: true plugins: - search + - gh-admonitions extra_css: - stylesheets/extra.css extra_javascript: @@ -72,6 +73,15 @@ not_in_nav: | extra: analytics: provider: fathom + social: + - icon: fontawesome/brands/github + link: https://github.com/astral-sh/ruff + - icon: fontawesome/brands/discord + link: https://discord.com/invite/astral-sh + - icon: fontawesome/brands/python + link: https://pypi.org/project/ruff/ + - icon: fontawesome/brands/x-twitter + link: https://x.com/astral_sh validation: omitted_files: warn absolute_links: warn diff --git a/playground/.eslintrc b/playground/.eslintrc deleted file mode 100644 index 987e93306e975..0000000000000 --- a/playground/.eslintrc +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parser": "@typescript-eslint/parser", - "plugins": ["@typescript-eslint"], - "extends": [ - "eslint:recommended", - "plugin:@typescript-eslint/eslint-recommended", - "plugin:@typescript-eslint/recommended", - "plugin:react/recommended", - "plugin:react/jsx-runtime", - "plugin:react-hooks/recommended", - "plugin:import/recommended", - "plugin:import/typescript" - ], - "rules": { - // Disable some recommended rules that we don't want to enforce. - "@typescript-eslint/no-explicit-any": "off", - "eqeqeq": ["error","always", { "null": "never"}] - }, - "settings": { - "react": { - "version": "detect" - } - } -} diff --git a/playground/.prettierignore b/playground/.prettierignore index e1fc035dff6e4..8c7763fecfb74 100644 --- a/playground/.prettierignore +++ b/playground/.prettierignore @@ -1,2 +1,5 @@ **.md -pkg +ruff/dist +ruff/ruff_wasm +ty/dist +ty/ty_wasm \ No newline at end of file diff --git a/playground/.prettierrc.json b/playground/.prettierrc.json deleted file mode 100644 index bf357fbbc081d..0000000000000 --- a/playground/.prettierrc.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "trailingComma": "all" -} diff --git a/playground/README.md b/playground/README.md index 3b7c0f394a627..22ba019a2dbf1 100644 --- a/playground/README.md +++ b/playground/README.md @@ -4,15 +4,16 @@ In-browser playground for Ruff. Available [https://play.ruff.rs/](https://play.r ## Getting started -In order to build the WASM module install [`wasm-pack`](https://rustwasm.github.io/wasm-pack/). +Install the NPM dependencies with `npm install`, and run, and run the development server with +`npm start --workspace ruff-playground` or `npm start --workspace ty-playground`. +You may need to restart the server after making changes to Ruff or ty to re-build the WASM +module. -Next, build the WASM module by running `npm run build:wasm` (release build) or `npm run dev:wasm` (debug build) from the `./playground` directory. - -Finally, install TypeScript dependencies with `npm install`, and run the development server with `npm run dev`. - -To run the datastore, which is based on [Workers KV](https://developers.cloudflare.com/workers/runtime-apis/kv/), +To run the datastore, which is based +on [Workers KV](https://developers.cloudflare.com/workers/runtime-apis/kv/), install the [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/install-and-update/), -then run `npx wrangler dev --local` from the `./playground/api` directory. Note that the datastore is +then run `npx wrangler dev --local` from the `./playground/api` directory. Note that the datastore +is only required to generate shareable URLs for code snippets. The development datastore does not require Cloudflare authentication or login, but in turn only persists data locally. @@ -23,8 +24,17 @@ The playground is implemented as a single-page React application powered by [Monaco](https://github.com/microsoft/monaco-editor). The playground stores state in `localStorage`, but supports persisting code snippets to -a persistent datastore based on [Workers KV](https://developers.cloudflare.com/workers/runtime-apis/kv/) -and exposed via a [Cloudflare Worker](https://developers.cloudflare.com/workers/learning/how-workers-works/). +a persistent datastore based +on [Workers KV](https://developers.cloudflare.com/workers/runtime-apis/kv/) +and exposed via +a [Cloudflare Worker](https://developers.cloudflare.com/workers/learning/how-workers-works/). The playground design is originally based on [Tailwind Play](https://play.tailwindcss.com/), with -additional inspiration from the [Rome Tools Playground](https://docs.rome.tools/playground/). +additional inspiration from the [Biome Playground](https://biomejs.dev/playground/). + +## Known issues + +### Stack overflows + +If you see stack overflows in the playground, build the WASM module in release mode: +`npm run --workspace ty-playground build:wasm`. diff --git a/playground/api/package-lock.json b/playground/api/package-lock.json index ad390eaad2b56..f9f9a44bba0a4 100644 --- a/playground/api/package-lock.json +++ b/playground/api/package-lock.json @@ -10,32 +10,32 @@ "dependencies": { "@miniflare/kv": "^2.14.0", "@miniflare/storage-memory": "^2.14.0", - "uuid": "^10.0.0" + "uuid": "^11.0.0" }, "devDependencies": { "@cloudflare/workers-types": "^4.20230801.0", - "miniflare": "^3.20230801.1", + "miniflare": "^4.0.0", "typescript": "^5.1.6", - "wrangler": "3.83.0" + "wrangler": "^4.1.0" } }, "node_modules/@cloudflare/kv-asset-handler": { - "version": "0.3.4", - "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.3.4.tgz", - "integrity": "sha512-YLPHc8yASwjNkmcDMQMY35yiWjoKAKnhUbPRszBRS0YgH+IXtsMp61j+yTcnCE3oO2DgP0U3iejLC8FTtKDC8Q==", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.4.0.tgz", + "integrity": "sha512-+tv3z+SPp+gqTIcImN9o0hqE9xyfQjI1XD9pL6NuKjua9B1y7mNYv0S9cP+QEbA4ppVgGZEmKOvHX5G5Ei1CVA==", "dev": true, "license": "MIT OR Apache-2.0", "dependencies": { "mime": "^3.0.0" }, "engines": { - "node": ">=16.13" + "node": ">=18.0.0" } }, "node_modules/@cloudflare/workerd-darwin-64": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-64/-/workerd-darwin-64-1.20241022.0.tgz", - "integrity": "sha512-1NNYun37myMTgCUiPQEJ0cMal4mKZVTpkD0b2tx9hV70xji+frVJcSK8YVLeUm1P+Rw1d/ct8DMgQuCpsz3Fsw==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-64/-/workerd-darwin-64-1.20250508.0.tgz", + "integrity": "sha512-9x09MrA9Y5RQs3zqWvWns8xHgM2pVNXWpeJ+3hQYu4PrwPFZXtTD6b/iMmOnlYKzINlREq1RGeEybMFyWEUlUg==", "cpu": [ "x64" ], @@ -50,9 +50,9 @@ } }, "node_modules/@cloudflare/workerd-darwin-arm64": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-arm64/-/workerd-darwin-arm64-1.20241022.0.tgz", - "integrity": "sha512-FOO/0P0U82EsTLTdweNVgw+4VOk5nghExLPLSppdOziq6IR5HVgP44Kmq5LdsUeHUhwUmfOh9hzaTpkNzUqKvw==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-darwin-arm64/-/workerd-darwin-arm64-1.20250508.0.tgz", + "integrity": "sha512-0Ili+nE2LLRzYue/yPc1pepSyNNg6LxR3/ng/rlQzVQUxPXIXldHFkJ/ynsYwQnAcf6OxasSi/kbTm6yvDoSAQ==", "cpu": [ "arm64" ], @@ -67,9 +67,9 @@ } }, "node_modules/@cloudflare/workerd-linux-64": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-64/-/workerd-linux-64-1.20241022.0.tgz", - "integrity": "sha512-RsNc19BQJG9yd+ngnjuDeG9ywZG+7t1L4JeglgceyY5ViMNMKVO7Zpbsu69kXslU9h6xyQG+lrmclg3cBpnhYA==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-64/-/workerd-linux-64-1.20250508.0.tgz", + "integrity": "sha512-5saVrZ3uVwYxvBa7BaonXjeqB6X0YF3ak05qvBaWcmZ3FNmnarMm2W8842cnbhnckDVBpB/iDo51Sy6Y7y1jcw==", "cpu": [ "x64" ], @@ -84,9 +84,9 @@ } }, "node_modules/@cloudflare/workerd-linux-arm64": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-arm64/-/workerd-linux-arm64-1.20241022.0.tgz", - "integrity": "sha512-x5mUXpKxfsosxcFmcq5DaqLs37PejHYVRsNz1cWI59ma7aC4y4Qn6Tf3i0r9MwQTF/MccP4SjVslMU6m4W7IaA==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-linux-arm64/-/workerd-linux-arm64-1.20250508.0.tgz", + "integrity": "sha512-muQe1pkxRi3eaq1Q417xvfGd2SlktbLTzNhT5Yftsx8OecWrYuB8i4ttR6Nr5ER06bfEj0FqQjqJJhcp6wLLUQ==", "cpu": [ "arm64" ], @@ -101,9 +101,9 @@ } }, "node_modules/@cloudflare/workerd-windows-64": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workerd-windows-64/-/workerd-windows-64-1.20241022.0.tgz", - "integrity": "sha512-eBCClx4szCOgKqOlxxbdNszMqQf3MRG1B9BRIqEM/diDfdR9IrZ8l3FaEm+l9gXgPmS6m1NBn40aWuGBl8UTSw==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workerd-windows-64/-/workerd-windows-64-1.20250508.0.tgz", + "integrity": "sha512-EJj8iTWFMqjgvZUxxNvzK7frA1JMFi3y/9eDIdZPL/OaQh3cmk5Lai5DCXsKYUxfooMBZWYTp53zOLrvuJI8VQ==", "cpu": [ "x64" ], @@ -117,24 +117,10 @@ "node": ">=16" } }, - "node_modules/@cloudflare/workers-shared": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workers-shared/-/workers-shared-0.7.0.tgz", - "integrity": "sha512-LLQRTqx7lKC7o2eCYMpyc5FXV8d0pUX6r3A+agzhqS9aoR5A6zCPefwQGcvbKx83ozX22ATZcemwxQXn12UofQ==", - "dev": true, - "license": "MIT OR Apache-2.0", - "dependencies": { - "mime": "^3.0.0", - "zod": "^3.22.3" - }, - "engines": { - "node": ">=16.7.0" - } - }, "node_modules/@cloudflare/workers-types": { - "version": "4.20241022.0", - "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20241022.0.tgz", - "integrity": "sha512-1zOAw5QIDKItzGatzCrEpfLOB1AuMTwVqKmbw9B9eBfCUGRFNfJYMrJxIwcse9EmKahsQt2GruqU00pY/GyXgg==", + "version": "4.20250519.0", + "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20250519.0.tgz", + "integrity": "sha512-glS4kimqTyxVuNNPCoOzE/BmQ3w+HVQuPwYdPAQrUDaj2AKS8Y3O5w85TVFTKZGhCtwfNs8h4iohldjEs/P5Vw==", "dev": true, "license": "MIT OR Apache-2.0" }, @@ -150,378 +136,440 @@ "node": ">=12" } }, - "node_modules/@esbuild-plugins/node-globals-polyfill": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@esbuild-plugins/node-globals-polyfill/-/node-globals-polyfill-0.2.3.tgz", - "integrity": "sha512-r3MIryXDeXDOZh7ih1l/yE9ZLORCd5e8vWg02azWRGj5SPTuoh69A2AIyn0Z31V/kHBfZ4HgWJ+OK3GTTwLmnw==", + "node_modules/@emnapi/runtime": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.3.1.tgz", + "integrity": "sha512-kEBmG8KyqtxJZv+ygbEim+KCGtIq1fC22Ms3S4ziXmYKm8uyoLX0MHONVKwp+9opg390VaKRNt4a7A9NwmpNhw==", "dev": true, - "peerDependencies": { - "esbuild": "*" + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" } }, - "node_modules/@esbuild-plugins/node-modules-polyfill": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/@esbuild-plugins/node-modules-polyfill/-/node-modules-polyfill-0.2.2.tgz", - "integrity": "sha512-LXV7QsWJxRuMYvKbiznh+U1ilIop3g2TeKRzUxOG5X3YITc8JyyTa90BmLwqqv0YnX4v32CSlG+vsziZp9dMvA==", + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.4.tgz", + "integrity": "sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==", + "cpu": [ + "ppc64" + ], "dev": true, - "dependencies": { - "escape-string-regexp": "^4.0.0", - "rollup-plugin-node-polyfills": "^0.2.1" - }, - "peerDependencies": { - "esbuild": "*" + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" } }, "node_modules/@esbuild/android-arm": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.17.19.tgz", - "integrity": "sha512-rIKddzqhmav7MSmoFCmDIb6e2W57geRsM94gV2l38fzhXMwq7hZoClug9USI2pFRGL06f4IOPHHpFNOkWieR8A==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.4.tgz", + "integrity": "sha512-QNdQEps7DfFwE3hXiU4BZeOV68HHzYwGd0Nthhd3uCkkEKK7/R6MTgM0P7H7FAs5pU/DIWsviMmEGxEoxIZ+ZQ==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/android-arm64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.17.19.tgz", - "integrity": "sha512-KBMWvEZooR7+kzY0BtbTQn0OAYY7CsiydT63pVEaPtVYF0hXbUaOyZog37DKxK7NF3XacBJOpYT4adIJh+avxA==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.4.tgz", + "integrity": "sha512-bBy69pgfhMGtCnwpC/x5QhfxAz/cBgQ9enbtwjf6V9lnPI/hMyT9iWpR1arm0l3kttTr4L0KSLpKmLp/ilKS9A==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/android-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.17.19.tgz", - "integrity": "sha512-uUTTc4xGNDT7YSArp/zbtmbhO0uEEK9/ETW29Wk1thYUJBz3IVnvgEiEwEa9IeLyvnpKrWK64Utw2bgUmDveww==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.4.tgz", + "integrity": "sha512-TVhdVtQIFuVpIIR282btcGC2oGQoSfZfmBdTip2anCaVYcqWlZXGcdcKIUklfX2wj0JklNYgz39OBqh2cqXvcQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.17.19.tgz", - "integrity": "sha512-80wEoCfF/hFKM6WE1FyBHc9SfUblloAWx6FJkFWTWiCoht9Mc0ARGEM47e67W9rI09YoUxJL68WHfDRYEAvOhg==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.4.tgz", + "integrity": "sha512-Y1giCfM4nlHDWEfSckMzeWNdQS31BQGs9/rouw6Ub91tkK79aIMTH3q9xHvzH8d0wDru5Ci0kWB8b3up/nl16g==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.17.19.tgz", - "integrity": "sha512-IJM4JJsLhRYr9xdtLytPLSH9k/oxR3boaUIYiHkAawtwNOXKE8KoU8tMvryogdcT8AU+Bflmh81Xn6Q0vTZbQw==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.4.tgz", + "integrity": "sha512-CJsry8ZGM5VFVeyUYB3cdKpd/H69PYez4eJh1W/t38vzutdjEjtP7hB6eLKBoOdxcAlCtEYHzQ/PJ/oU9I4u0A==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.17.19.tgz", - "integrity": "sha512-pBwbc7DufluUeGdjSU5Si+P3SoMF5DQ/F/UmTSb8HXO80ZEAJmrykPyzo1IfNbAoaqw48YRpv8shwd1NoI0jcQ==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.4.tgz", + "integrity": "sha512-yYq+39NlTRzU2XmoPW4l5Ifpl9fqSk0nAJYM/V/WUGPEFfek1epLHJIkTQM6bBs1swApjO5nWgvr843g6TjxuQ==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.17.19.tgz", - "integrity": "sha512-4lu+n8Wk0XlajEhbEffdy2xy53dpR06SlzvhGByyg36qJw6Kpfk7cp45DR/62aPH9mtJRmIyrXAS5UWBrJT6TQ==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.4.tgz", + "integrity": "sha512-0FgvOJ6UUMflsHSPLzdfDnnBBVoCDtBTVyn/MrWloUNvq/5SFmh13l3dvgRPkDihRxb77Y17MbqbCAa2strMQQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-arm": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.17.19.tgz", - "integrity": "sha512-cdmT3KxjlOQ/gZ2cjfrQOtmhG4HJs6hhvm3mWSRDPtZ/lP5oe8FWceS10JaSJC13GBd4eH/haHnqf7hhGNLerA==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.4.tgz", + "integrity": "sha512-kro4c0P85GMfFYqW4TWOpvmF8rFShbWGnrLqlzp4X1TNWjRY3JMYUfDCtOxPKOIY8B0WC8HN51hGP4I4hz4AaQ==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.17.19.tgz", - "integrity": "sha512-ct1Tg3WGwd3P+oZYqic+YZF4snNl2bsnMKRkb3ozHmnM0dGWuxcPTTntAF6bOP0Sp4x0PjSF+4uHQ1xvxfRKqg==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.4.tgz", + "integrity": "sha512-+89UsQTfXdmjIvZS6nUnOOLoXnkUTB9hR5QAeLrQdzOSWZvNSAXAtcRDHWtqAUtAmv7ZM1WPOOeSxDzzzMogiQ==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.17.19.tgz", - "integrity": "sha512-w4IRhSy1VbsNxHRQpeGCHEmibqdTUx61Vc38APcsRbuVgK0OPEnQ0YD39Brymn96mOx48Y2laBQGqgZ0j9w6SQ==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.4.tgz", + "integrity": "sha512-yTEjoapy8UP3rv8dB0ip3AfMpRbyhSN3+hY8mo/i4QXFeDxmiYbEKp3ZRjBKcOP862Ua4b1PDfwlvbuwY7hIGQ==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.17.19.tgz", - "integrity": "sha512-2iAngUbBPMq439a+z//gE+9WBldoMp1s5GWsUSgqHLzLJ9WoZLZhpwWuym0u0u/4XmZ3gpHmzV84PonE+9IIdQ==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.4.tgz", + "integrity": "sha512-NeqqYkrcGzFwi6CGRGNMOjWGGSYOpqwCjS9fvaUlX5s3zwOtn1qwg1s2iE2svBe4Q/YOG1q6875lcAoQK/F4VA==", "cpu": [ "loong64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.17.19.tgz", - "integrity": "sha512-LKJltc4LVdMKHsrFe4MGNPp0hqDFA1Wpt3jE1gEyM3nKUvOiO//9PheZZHfYRfYl6AwdTH4aTcXSqBerX0ml4A==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.4.tgz", + "integrity": "sha512-IcvTlF9dtLrfL/M8WgNI/qJYBENP3ekgsHbYUIzEzq5XJzzVEV/fXY9WFPfEEXmu3ck2qJP8LG/p3Q8f7Zc2Xg==", "cpu": [ "mips64el" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.17.19.tgz", - "integrity": "sha512-/c/DGybs95WXNS8y3Ti/ytqETiW7EU44MEKuCAcpPto3YjQbyK3IQVKfF6nbghD7EcLUGl0NbiL5Rt5DMhn5tg==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.4.tgz", + "integrity": "sha512-HOy0aLTJTVtoTeGZh4HSXaO6M95qu4k5lJcH4gxv56iaycfz1S8GO/5Jh6X4Y1YiI0h7cRyLi+HixMR+88swag==", "cpu": [ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.17.19.tgz", - "integrity": "sha512-FC3nUAWhvFoutlhAkgHf8f5HwFWUL6bYdvLc/TTuxKlvLi3+pPzdZiFKSWz/PF30TB1K19SuCxDTI5KcqASJqA==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.4.tgz", + "integrity": "sha512-i8JUDAufpz9jOzo4yIShCTcXzS07vEgWzyX3NH2G7LEFVgrLEhjwL3ajFE4fZI3I4ZgiM7JH3GQ7ReObROvSUA==", "cpu": [ "riscv64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.17.19.tgz", - "integrity": "sha512-IbFsFbxMWLuKEbH+7sTkKzL6NJmG2vRyy6K7JJo55w+8xDk7RElYn6xvXtDW8HCfoKBFK69f3pgBJSUSQPr+4Q==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.4.tgz", + "integrity": "sha512-jFnu+6UbLlzIjPQpWCNh5QtrcNfMLjgIavnwPQAfoGx4q17ocOU9MsQ2QVvFxwQoWpZT8DvTLooTvmOQXkO51g==", "cpu": [ "s390x" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.17.19.tgz", - "integrity": "sha512-68ngA9lg2H6zkZcyp22tsVt38mlhWde8l3eJLWkyLrp4HwMUr3c1s/M2t7+kHIhvMjglIBrFpncX1SzMckomGw==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.4.tgz", + "integrity": "sha512-6e0cvXwzOnVWJHq+mskP8DNSrKBr1bULBvnFLpc1KY+d+irZSgZ02TGse5FsafKS5jg2e4pbvK6TPXaF/A6+CA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.4.tgz", + "integrity": "sha512-vUnkBYxZW4hL/ie91hSqaSNjulOnYXE1VSLusnvHg2u3jewJBz3YzB9+oCw8DABeVqZGg94t9tyZFoHma8gWZQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.17.19.tgz", - "integrity": "sha512-CwFq42rXCR8TYIjIfpXCbRX0rp1jo6cPIUPSaWwzbVI4aOfX96OXY8M6KNmtPcg7QjYeDmN+DD0Wp3LaBOLf4Q==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.4.tgz", + "integrity": "sha512-XAg8pIQn5CzhOB8odIcAm42QsOfa98SBeKUdo4xa8OvX8LbMZqEtgeWE9P/Wxt7MlG2QqvjGths+nq48TrUiKw==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" ], "engines": { - "node": ">=12" + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.4.tgz", + "integrity": "sha512-Ct2WcFEANlFDtp1nVAXSNBPDxyU+j7+tId//iHXU2f/lN5AmO4zLyhDcpR5Cz1r08mVxzt3Jpyt4PmXQ1O6+7A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.17.19.tgz", - "integrity": "sha512-cnq5brJYrSZ2CF6c35eCmviIN3k3RczmHz8eYaVlNasVqsNY+JKohZU5MKmaOI+KkllCdzOKKdPs762VCPC20g==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.4.tgz", + "integrity": "sha512-xAGGhyOQ9Otm1Xu8NT1ifGLnA6M3sJxZ6ixylb+vIUVzvvd6GOALpwQrYrtlPouMqd/vSbgehz6HaVk4+7Afhw==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.17.19.tgz", - "integrity": "sha512-vCRT7yP3zX+bKWFeP/zdS6SqdWB8OIpaRq/mbXQxTGHnIxspRtigpkUcDMlSCOejlHowLqII7K2JKevwyRP2rg==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.4.tgz", + "integrity": "sha512-Mw+tzy4pp6wZEK0+Lwr76pWLjrtjmJyUB23tHKqEDP74R3q95luY/bXqXZeYl4NYlvwOqoRKlInQialgCKy67Q==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "sunos" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.17.19.tgz", - "integrity": "sha512-yYx+8jwowUstVdorcMdNlzklLYhPxjniHWFKgRqH7IFlUEa0Umu3KuYplf1HUZZ422e3NU9F4LGb+4O0Kdcaag==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.4.tgz", + "integrity": "sha512-AVUP428VQTSddguz9dO9ngb+E5aScyg7nOeJDrF1HPYu555gmza3bDGMPhmVXL8svDSoqPCsCPjb265yG/kLKQ==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.17.19.tgz", - "integrity": "sha512-eggDKanJszUtCdlVs0RB+h35wNlb5v4TWEkq4vZcmVt5u/HiDZrTXe2bWFQUez3RgNHwx/x4sk5++4NSSicKkw==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.4.tgz", + "integrity": "sha512-i1sW+1i+oWvQzSgfRcxxG2k4I9n3O9NRqy8U+uugaT2Dy7kLO9Y7wI72haOahxceMX8hZAzgGou1FhndRldxRg==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-x64": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.17.19.tgz", - "integrity": "sha512-lAhycmKnVOuRYNtRtatQR1LPQf2oYCkRGkSFnseDAKPl8lu5SOsK/e1sXe5a0Pc5kHIHe6P2I/ilntNv2xf3cA==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.4.tgz", + "integrity": "sha512-nOT2vZNw6hJ+z43oP1SPea/G/6AbN6X+bGNhNuq8NtRHy4wsMhw765IKLNmnjek7GvjWBYQ8Q5VBoYTFg9y1UQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@fastify/busboy": { @@ -533,6 +581,386 @@ "node": ">=14" } }, + "node_modules/@img/sharp-darwin-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.33.5.tgz", + "integrity": "sha512-UT4p+iz/2H4twwAoLCqfA9UH5pI6DggwKEGuaPy7nCVQ8ZsiY5PIcrRvD1DzuY3qYL07NtIQcWnBSY/heikIFQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-darwin-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.33.5.tgz", + "integrity": "sha512-fyHac4jIc1ANYGRDxtiqelIbdWkIuQaI84Mv45KvGRRxSAa7o7d1ZKAOBaYbnepLC1WqxfpimdeWfvqqSGwR2Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.0.4.tgz", + "integrity": "sha512-XblONe153h0O2zuFfTAbQYAX2JhYmDHeWikp1LM9Hul9gVPjFY427k6dFEcOL72O01QxQsWi761svJ/ev9xEDg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.0.4.tgz", + "integrity": "sha512-xnGR8YuZYfJGmWPvmlunFaWJsb9T/AO2ykoP3Fz/0X5XV2aoYBPkX6xqCQvUTKKiLddarLaxpzNe+b1hjeWHAQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.0.5.tgz", + "integrity": "sha512-gvcC4ACAOPRNATg/ov8/MnbxFDJqf/pDePbBnuBDcjsI8PssmjoKMAz4LtLaVi+OnSb5FK/yIOamqDwGmXW32g==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.0.4.tgz", + "integrity": "sha512-9B+taZ8DlyyqzZQnoeIvDVR/2F4EbMepXMc/NdVbkzsJbzkUjhXv/70GQJ7tdLA4YJgNP25zukcxpX2/SueNrA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.0.4.tgz", + "integrity": "sha512-u7Wz6ntiSSgGSGcjZ55im6uvTrOxSIS8/dgoVMoiGE9I6JAfU50yH5BoDlYA1tcuGS7g/QNtetJnxA6QEsCVTA==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.0.4.tgz", + "integrity": "sha512-MmWmQ3iPFZr0Iev+BAgVMb3ZyC4KeFc3jFxnNbEPas60e1cIfevbtuyf9nDGIzOaW9PdnDciJm+wFFaTlj5xYw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.0.4.tgz", + "integrity": "sha512-9Ti+BbTYDcsbp4wfYib8Ctm1ilkugkA/uscUn6UXK1ldpC1JjiXbLfFZtRlBhjPZ5o1NCLiDbg8fhUPKStHoTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.0.4.tgz", + "integrity": "sha512-viYN1KX9m+/hGkJtvYYp+CCLgnJXwiQB39damAO7WMdKWlIhmYTfHjwSbQeUK/20vY154mwezd9HflVFM1wVSw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-linux-arm": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.33.5.tgz", + "integrity": "sha512-JTS1eldqZbJxjvKaAkxhZmBqPRGmxgu+qFKSInv8moZ2AmT5Yib3EQ1c6gp493HvrvV8QgdOXdyaIBrhvFhBMQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.0.5" + } + }, + "node_modules/@img/sharp-linux-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.33.5.tgz", + "integrity": "sha512-JMVv+AMRyGOHtO1RFBiJy/MBsgz0x4AWrT6QoEVVTyh1E39TrCUpTRI7mx9VksGX4awWASxqCYLCV4wBZHAYxA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-s390x": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.33.5.tgz", + "integrity": "sha512-y/5PCd+mP4CA/sPDKl2961b+C9d+vPAveS33s6Z3zfASk2j5upL6fXVPZi7ztePZ5CuH+1kW8JtvxgbuXHRa4Q==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.33.5.tgz", + "integrity": "sha512-opC+Ok5pRNAzuvq1AG0ar+1owsu842/Ab+4qvU879ippJBHvyY5n2mxF1izXqkPYlGuP/M556uh53jRLJmzTWA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.33.5.tgz", + "integrity": "sha512-XrHMZwGQGvJg2V/oRSUfSAfjfPxO+4DkiRh6p2AFjLQztWUuY/o8Mq0eMQVIY7HJ1CDQUJlxGGZRw1a5bqmd1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.33.5.tgz", + "integrity": "sha512-WT+d/cgqKkkKySYmqoZ8y3pxx7lx9vVejxW/W4DOFMYVSkErR+w7mf2u8m/y4+xHe7yY9DAXQMWQhpnMuFfScw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-wasm32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.33.5.tgz", + "integrity": "sha512-ykUW4LVGaMcU9lu9thv85CbRMAwfeadCJHRsg2GmeRa/cJxsVY9Rbd57JcMxBkKHag5U/x7TSBpScF4U8ElVzg==", + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.2.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-ia32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.33.5.tgz", + "integrity": "sha512-T36PblLaTwuVJ/zw/LaH0PdZkRz5rd3SmMHX8GSmR7vtNSP5Z6bQkExdSK7xGWyxLw4sUknBuugTelgw2faBbQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.33.5.tgz", + "integrity": "sha512-MpY/o8/8kj+EcnxwvrP4aTJSWw/aZ7JIGR4aBeZkZw5B7/Jn+tY9/VNwtcoGmdT7GfggGIU4kygOMSbYnOrAbg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, "node_modules/@jridgewell/resolve-uri": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", @@ -611,10 +1039,11 @@ "integrity": "sha512-0mHckf6D2DiIAzh8fM8f3HQCvMKDpK94YQ0DSVkfWTG9BZleYIWudw9cJxX8oCk9bM+vAkDyujDV6dmKHbvQpg==" }, "node_modules/acorn": { - "version": "8.10.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz", - "integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==", + "version": "8.14.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz", + "integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==", "dev": true, + "license": "MIT", "bin": { "acorn": "bin/acorn" }, @@ -623,43 +1052,22 @@ } }, "node_modules/acorn-walk": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", - "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", + "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.4.0" } }, - "node_modules/anymatch": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", - "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", - "dev": true, - "dependencies": { - "normalize-path": "^3.0.0", - "picomatch": "^2.0.4" - }, - "engines": { - "node": ">= 8" - } - }, "node_modules/as-table": { "version": "1.0.55", "resolved": "https://registry.npmjs.org/as-table/-/as-table-1.0.55.tgz", "integrity": "sha512-xvsWESUJn0JN421Xb9MQw6AsMHRCUknCe0Wjlxvjud80mU4E6hQf1A6NzQKcYNmYw62MfzEtXc+badstZP3JpQ==", - "dev": true, - "dependencies": { - "printable-characters": "^1.0.42" - } - }, - "node_modules/binary-extensions": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.2.0.tgz", - "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==", - "dev": true, - "engines": { - "node": ">=8" + "dev": true, + "dependencies": { + "printable-characters": "^1.0.42" } }, "node_modules/blake3-wasm": { @@ -668,18 +1076,6 @@ "integrity": "sha512-F1+K8EbfOZE49dtoPtmxUQrpXaBIl3ICvasLh+nJta0xkz+9kF/7uet9fLnwKqhDrmj6g+6K3Tw9yQPUg2ka5g==", "dev": true }, - "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dev": true, - "dependencies": { - "fill-range": "^7.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/builtins": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", @@ -688,48 +1084,61 @@ "semver": "^7.0.0" } }, - "node_modules/capnp-ts": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/capnp-ts/-/capnp-ts-0.7.0.tgz", - "integrity": "sha512-XKxXAC3HVPv7r674zP0VC3RTXz+/JKhfyw94ljvF80yynK6VkTnqE3jMuN8b3dUVmmc43TjyxjW4KTsmB3c86g==", + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", "dev": true, + "license": "MIT", + "optional": true, "dependencies": { - "debug": "^4.3.1", - "tslib": "^2.2.0" + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" } }, - "node_modules/chokidar": { - "version": "3.5.3", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", - "integrity": "sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==", + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://paulmillr.com/funding/" - } - ], + "license": "MIT", + "optional": true, "dependencies": { - "anymatch": "~3.1.2", - "braces": "~3.0.2", - "glob-parent": "~5.1.2", - "is-binary-path": "~2.1.0", - "is-glob": "~4.0.1", - "normalize-path": "~3.0.0", - "readdirp": "~3.6.0" + "color-name": "~1.1.4" }, "engines": { - "node": ">= 8.10.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" } }, "node_modules/cookie": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.5.0.tgz", - "integrity": "sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==", + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.6" } @@ -753,34 +1162,6 @@ "integrity": "sha512-ND9qDTLc6diwj+Xe5cdAgVTbLVdXbtxTJRXRhli8Mowuaan+0EJOtdqJ0QCHNSSPyoXGx9HX2/VMnKeC34AChA==", "dev": true }, - "node_modules/date-fns": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-4.1.0.tgz", - "integrity": "sha512-Ukq0owbQXxa/U3EGtsdVBkR1w7KOQ5gIBqdH2hkvknzZPYvBxb/aa6E8L7tmjFtkwZBu3UXBbjIgPo/Ez4xaNg==", - "dev": true, - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/kossnocorp" - } - }, - "node_modules/debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, "node_modules/defu": { "version": "6.1.4", "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", @@ -788,61 +1169,58 @@ "dev": true, "license": "MIT" }, + "node_modules/detect-libc": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.3.tgz", + "integrity": "sha512-bwy0MGW55bG41VqxxypOsdSdGqLwXPI/focwgTYCFMbdUiBAxLg9CFzG08sz2aqzknwiX7Hkl0bQENjg8iLByw==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "engines": { + "node": ">=8" + } + }, "node_modules/esbuild": { - "version": "0.17.19", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.17.19.tgz", - "integrity": "sha512-XQ0jAPFkK/u3LcVRcvVHQcTIqD6E2H1fvZMA5dQPSOWb3suUbWbfbRf94pjc0bNzRYLfIrDRQXr7X+LHIm5oHw==", + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.4.tgz", + "integrity": "sha512-8pgjLUcUjcgDg+2Q4NYXnPbo/vncAY4UmyaCm0jZevERqCHZIaWwdJHkf8XQtu4AxSKCdvrUbT0XUr1IdZzI8Q==", "dev": true, "hasInstallScript": true, + "license": "MIT", "bin": { "esbuild": "bin/esbuild" }, "engines": { - "node": ">=12" + "node": ">=18" }, "optionalDependencies": { - "@esbuild/android-arm": "0.17.19", - "@esbuild/android-arm64": "0.17.19", - "@esbuild/android-x64": "0.17.19", - "@esbuild/darwin-arm64": "0.17.19", - "@esbuild/darwin-x64": "0.17.19", - "@esbuild/freebsd-arm64": "0.17.19", - "@esbuild/freebsd-x64": "0.17.19", - "@esbuild/linux-arm": "0.17.19", - "@esbuild/linux-arm64": "0.17.19", - "@esbuild/linux-ia32": "0.17.19", - "@esbuild/linux-loong64": "0.17.19", - "@esbuild/linux-mips64el": "0.17.19", - "@esbuild/linux-ppc64": "0.17.19", - "@esbuild/linux-riscv64": "0.17.19", - "@esbuild/linux-s390x": "0.17.19", - "@esbuild/linux-x64": "0.17.19", - "@esbuild/netbsd-x64": "0.17.19", - "@esbuild/openbsd-x64": "0.17.19", - "@esbuild/sunos-x64": "0.17.19", - "@esbuild/win32-arm64": "0.17.19", - "@esbuild/win32-ia32": "0.17.19", - "@esbuild/win32-x64": "0.17.19" - } - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "@esbuild/aix-ppc64": "0.25.4", + "@esbuild/android-arm": "0.25.4", + "@esbuild/android-arm64": "0.25.4", + "@esbuild/android-x64": "0.25.4", + "@esbuild/darwin-arm64": "0.25.4", + "@esbuild/darwin-x64": "0.25.4", + "@esbuild/freebsd-arm64": "0.25.4", + "@esbuild/freebsd-x64": "0.25.4", + "@esbuild/linux-arm": "0.25.4", + "@esbuild/linux-arm64": "0.25.4", + "@esbuild/linux-ia32": "0.25.4", + "@esbuild/linux-loong64": "0.25.4", + "@esbuild/linux-mips64el": "0.25.4", + "@esbuild/linux-ppc64": "0.25.4", + "@esbuild/linux-riscv64": "0.25.4", + "@esbuild/linux-s390x": "0.25.4", + "@esbuild/linux-x64": "0.25.4", + "@esbuild/netbsd-arm64": "0.25.4", + "@esbuild/netbsd-x64": "0.25.4", + "@esbuild/openbsd-arm64": "0.25.4", + "@esbuild/openbsd-x64": "0.25.4", + "@esbuild/sunos-x64": "0.25.4", + "@esbuild/win32-arm64": "0.25.4", + "@esbuild/win32-ia32": "0.25.4", + "@esbuild/win32-x64": "0.25.4" } }, - "node_modules/estree-walker": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-0.6.1.tgz", - "integrity": "sha512-SqmZANLWS0mnatqbSfRP5g8OXZC12Fgg1IwNtLsyHDzJizORW4khDfjPqJZsemPWBB2uqykUah5YpQ6epsqC/w==", - "dev": true - }, "node_modules/execa": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/execa/-/execa-6.1.0.tgz", @@ -877,17 +1255,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "node_modules/exsolve": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/exsolve/-/exsolve-1.0.4.tgz", + "integrity": "sha512-xsZH6PXaER4XoV+NiT7JHp1bJodJVT+cxeSH1G0f0tlT0lJqYuHUP3bUx2HtfTDvOagMINYp8rsqusxud3RXhw==", "dev": true, - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } + "license": "MIT" }, "node_modules/fsevents": { "version": "2.3.2", @@ -903,15 +1276,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/function-bind": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", - "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "dev": true, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/get-source": { "version": "2.0.12", "resolved": "https://registry.npmjs.org/get-source/-/get-source-2.0.12.tgz", @@ -933,36 +1297,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/glob-to-regexp": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", "dev": true }, - "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, - "dependencies": { - "function-bind": "^1.1.2" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/human-signals": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-3.0.1.tgz", @@ -971,59 +1311,13 @@ "node": ">=12.20.0" } }, - "node_modules/is-binary-path": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", - "dev": true, - "dependencies": { - "binary-extensions": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/is-core-module": { - "version": "2.13.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", - "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "node_modules/is-arrayish": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", "dev": true, - "dependencies": { - "hasown": "^2.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dev": true, - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "engines": { - "node": ">=0.12.0" - } + "license": "MIT", + "optional": true }, "node_modules/is-stream": { "version": "3.0.0", @@ -1041,13 +1335,6 @@ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==" }, - "node_modules/itty-time": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/itty-time/-/itty-time-1.0.6.tgz", - "integrity": "sha512-+P8IZaLLBtFv8hCkIjcymZOp4UJ+xW6bSlQsXGqrkmJh7vSiMFSlNne0mCYagEE0N7HDNR5jJBRxwN0oYv61Rw==", - "dev": true, - "license": "MIT" - }, "node_modules/kleur": { "version": "4.1.5", "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", @@ -1056,26 +1343,6 @@ "node": ">=6" } }, - "node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/magic-string": { - "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", - "dev": true, - "dependencies": { - "sourcemap-codec": "^1.4.8" - } - }, "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -1086,6 +1353,7 @@ "resolved": "https://registry.npmjs.org/mime/-/mime-3.0.0.tgz", "integrity": "sha512-jSCU7/VB1loIWBZe14aEYHU/+1UMEHoaO7qxCOVJOw9GgH72VAWppxNcjU+x9a2k3GSIBXNKxXQFqRvvZ7vr3A==", "dev": true, + "license": "MIT", "bin": { "mime": "cli.js" }, @@ -1105,38 +1373,31 @@ } }, "node_modules/miniflare": { - "version": "3.20241022.0", - "resolved": "https://registry.npmjs.org/miniflare/-/miniflare-3.20241022.0.tgz", - "integrity": "sha512-x9Fbq1Hmz1f0osIT9Qmj78iX4UpCP2EqlZnA/tzj/3+I49vc3Kq0fNqSSKplcdf6HlCHdL3fOBicmreQF4BUUQ==", + "version": "4.20250508.2", + "resolved": "https://registry.npmjs.org/miniflare/-/miniflare-4.20250508.2.tgz", + "integrity": "sha512-+2XoHLSbY49LNQgZoAJRX+SyUwC767Cz46pgx4T/j1YGKSrMzAxCOk59b12QoFNnN50Gtd9HkT3ukZn2nzrIVw==", "dev": true, "license": "MIT", "dependencies": { "@cspotcode/source-map-support": "0.8.1", - "acorn": "^8.8.0", - "acorn-walk": "^8.2.0", - "capnp-ts": "^0.7.0", - "exit-hook": "^2.2.1", - "glob-to-regexp": "^0.4.1", - "stoppable": "^1.1.0", - "undici": "^5.28.4", - "workerd": "1.20241022.0", - "ws": "^8.17.1", - "youch": "^3.2.2", - "zod": "^3.22.3" + "acorn": "8.14.0", + "acorn-walk": "8.3.2", + "exit-hook": "2.2.1", + "glob-to-regexp": "0.4.1", + "stoppable": "1.1.0", + "undici": "^5.28.5", + "workerd": "1.20250508.0", + "ws": "8.18.0", + "youch": "3.3.4", + "zod": "3.22.3" }, "bin": { "miniflare": "bootstrap.js" }, "engines": { - "node": ">=16.13" + "node": ">=18.0.0" } }, - "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, "node_modules/mustache": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz", @@ -1146,42 +1407,6 @@ "mustache": "bin/mustache" } }, - "node_modules/nanoid": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", - "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } - }, - "node_modules/node-forge": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.1.tgz", - "integrity": "sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==", - "dev": true, - "engines": { - "node": ">= 6.13.0" - } - }, - "node_modules/normalize-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", - "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/npm-run-path": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.1.0.tgz", @@ -1219,9 +1444,9 @@ } }, "node_modules/ohash": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/ohash/-/ohash-1.1.4.tgz", - "integrity": "sha512-FlDryZAahJmEF3VR3w1KogSEdWX3WhA5GPakFx4J81kEAiHyLMpdLLElS8n8dfNadMgAne/MywcvmogzscVt4g==", + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/ohash/-/ohash-2.0.11.tgz", + "integrity": "sha512-RdR9FQrFwNBNXAr4GixM8YaRZRJ5PUWbKYbE5eOsrwAjJW0q2REGcf79oYPsLyskQCZG1PLN+S/K1V00joZAoQ==", "dev": true, "license": "MIT" }, @@ -1252,12 +1477,6 @@ "node": ">=8" } }, - "node_modules/path-parse": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "dev": true - }, "node_modules/path-to-regexp": { "version": "6.3.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.3.0.tgz", @@ -1266,9 +1485,9 @@ "license": "MIT" }, "node_modules/pathe": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-1.1.2.tgz", - "integrity": "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "dev": true, "license": "MIT" }, @@ -1289,98 +1508,57 @@ "integrity": "sha512-dKp+C4iXWK4vVYZmYSd0KBH5F/h1HoZRsbJ82AVKRO3PEo8L4lBS/vLwhVtpwwuYcoIsVY+1JYKR268yn480uQ==", "dev": true }, - "node_modules/readdirp": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", - "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", - "dev": true, - "dependencies": { - "picomatch": "^2.2.1" - }, - "engines": { - "node": ">=8.10.0" - } - }, - "node_modules/resolve": { - "version": "1.22.8", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", - "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", - "dev": true, - "dependencies": { - "is-core-module": "^2.13.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, + "node_modules/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==", + "license": "ISC", "bin": { - "resolve": "bin/resolve" + "semver": "bin/semver.js" }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/resolve.exports": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.2.tgz", - "integrity": "sha512-X2UW6Nw3n/aMgDVy+0rSqgHlv39WZAlZrXCdnbyEiKm17DSqHX4MmQMaST3FbeWR5FTuRcUwYAziZajji0Y7mg==", - "dev": true, "engines": { "node": ">=10" } }, - "node_modules/rollup-plugin-inject": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rollup-plugin-inject/-/rollup-plugin-inject-3.0.2.tgz", - "integrity": "sha512-ptg9PQwzs3orn4jkgXJ74bfs5vYz1NCZlSQMBUA0wKcGp5i5pA1AO3fOUEte8enhGUC+iapTCzEWw2jEFFUO/w==", - "deprecated": "This package has been deprecated and is no longer maintained. Please use @rollup/plugin-inject.", - "dev": true, - "dependencies": { - "estree-walker": "^0.6.1", - "magic-string": "^0.25.3", - "rollup-pluginutils": "^2.8.1" - } - }, - "node_modules/rollup-plugin-node-polyfills": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/rollup-plugin-node-polyfills/-/rollup-plugin-node-polyfills-0.2.1.tgz", - "integrity": "sha512-4kCrKPTJ6sK4/gLL/U5QzVT8cxJcofO0OU74tnB19F40cmuAKSzH5/siithxlofFEjwvw1YAhPmbvGNA6jEroA==", - "dev": true, - "dependencies": { - "rollup-plugin-inject": "^3.0.0" - } - }, - "node_modules/rollup-pluginutils": { - "version": "2.8.2", - "resolved": "https://registry.npmjs.org/rollup-pluginutils/-/rollup-pluginutils-2.8.2.tgz", - "integrity": "sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ==", - "dev": true, - "dependencies": { - "estree-walker": "^0.6.1" - } - }, - "node_modules/selfsigned": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-2.1.1.tgz", - "integrity": "sha512-GSL3aowiF7wa/WtSFwnUrludWFoNhftq8bUkH9pkzjpN2XSPOAYEgg6e0sS9s0rZwgJzJiQRPU18A6clnoW5wQ==", + "node_modules/sharp": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.33.5.tgz", + "integrity": "sha512-haPVm1EkS9pgvHrQ/F3Xy+hgcuMV0Wm9vfIBSiwZ05k+xgb0PkBQpGsAA/oWdDobNaZTH5ppvHtzCFbnSEwHVw==", "dev": true, + "hasInstallScript": true, + "license": "Apache-2.0", + "optional": true, "dependencies": { - "node-forge": "^1" + "color": "^4.2.3", + "detect-libc": "^2.0.3", + "semver": "^7.6.3" }, "engines": { - "node": ">=10" - } - }, - "node_modules/semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dependencies": { - "lru-cache": "^6.0.0" + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" }, - "bin": { - "semver": "bin/semver.js" + "funding": { + "url": "https://opencollective.com/libvips" }, - "engines": { - "node": ">=10" + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.33.5", + "@img/sharp-darwin-x64": "0.33.5", + "@img/sharp-libvips-darwin-arm64": "1.0.4", + "@img/sharp-libvips-darwin-x64": "1.0.4", + "@img/sharp-libvips-linux-arm": "1.0.5", + "@img/sharp-libvips-linux-arm64": "1.0.4", + "@img/sharp-libvips-linux-s390x": "1.0.4", + "@img/sharp-libvips-linux-x64": "1.0.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4", + "@img/sharp-libvips-linuxmusl-x64": "1.0.4", + "@img/sharp-linux-arm": "0.33.5", + "@img/sharp-linux-arm64": "0.33.5", + "@img/sharp-linux-s390x": "0.33.5", + "@img/sharp-linux-x64": "0.33.5", + "@img/sharp-linuxmusl-arm64": "0.33.5", + "@img/sharp-linuxmusl-x64": "0.33.5", + "@img/sharp-wasm32": "0.33.5", + "@img/sharp-win32-ia32": "0.33.5", + "@img/sharp-win32-x64": "0.33.5" } }, "node_modules/shebang-command": { @@ -1407,6 +1585,17 @@ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" }, + "node_modules/simple-swizzle": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -1416,13 +1605,6 @@ "node": ">=0.10.0" } }, - "node_modules/sourcemap-codec": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", - "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead", - "dev": true - }, "node_modules/stacktracey": { "version": "2.1.8", "resolved": "https://registry.npmjs.org/stacktracey/-/stacktracey-2.1.8.tgz", @@ -1454,40 +1636,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/supports-preserve-symlinks-flag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, "node_modules/tslib": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.1.tgz", - "integrity": "sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig==", - "dev": true + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "dev": true, + "license": "0BSD", + "optional": true }, "node_modules/typescript": { - "version": "5.6.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", - "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1506,9 +1666,9 @@ "license": "MIT" }, "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", + "version": "5.28.5", + "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.5.tgz", + "integrity": "sha512-zICwjrDrcrUE0pyyJc1I2QzBkLM8FINsgOrt6WjA+BgajVq9Nxu2PbFFXUrAggLfDXlZGZBVZYw7WNV5KiBiBA==", "dev": true, "license": "MIT", "dependencies": { @@ -1518,31 +1678,17 @@ "node": ">=14.0" } }, - "node_modules/unenv": { - "name": "unenv-nightly", - "version": "2.0.0-20241018-011344-e666fcf", - "resolved": "https://registry.npmjs.org/unenv-nightly/-/unenv-nightly-2.0.0-20241018-011344-e666fcf.tgz", - "integrity": "sha512-D00bYn8rzkCBOlLx+k1iHQlc69jvtJRT7Eek4yIGQ6461a2tUBjngGZdRpqsoXAJCz/qBW0NgPting7Zvg+ysg==", - "dev": true, - "license": "MIT", - "dependencies": { - "defu": "^6.1.4", - "ohash": "^1.1.4", - "pathe": "^1.1.2", - "ufo": "^1.5.4" - } - }, "node_modules/uuid": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-10.0.0.tgz", - "integrity": "sha512-8XkAphELsDnEGrDxUOHB3RGvXz6TeuYSGEZBOjtTtPm2lwhGBjLgOzLHB63IUWfBpNucQjND6d3AOudO+H3RWQ==", + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-11.1.0.tgz", + "integrity": "sha512-0/A9rDy9P7cJ+8w1c9WD9V//9Wj15Ce2MPz8Ri6032usz+NfePxx5AcN3bN+r6ZL6jEo066/yNYB3tn4pQEx+A==", "funding": [ "https://github.com/sponsors/broofa", "https://github.com/sponsors/ctavan" ], "license": "MIT", "bin": { - "uuid": "dist/bin/uuid" + "uuid": "dist/esm/bin/uuid" } }, "node_modules/validate-npm-package-name": { @@ -1571,9 +1717,9 @@ } }, "node_modules/workerd": { - "version": "1.20241022.0", - "resolved": "https://registry.npmjs.org/workerd/-/workerd-1.20241022.0.tgz", - "integrity": "sha512-jyGXsgO9DRcJyx6Ovv7gUyDPc3UYC2i/E0p9GFUg6GUzpldw4Y93y9kOmdfsOnKZ3+lY53veSiUniiBPE6Q2NQ==", + "version": "1.20250508.0", + "resolved": "https://registry.npmjs.org/workerd/-/workerd-1.20250508.0.tgz", + "integrity": "sha512-ffLxe7dXSuGoA6jb3Qx2SClIV1aLHfJQ6RhGhzYHjQgv7dL6fdUOSIIGgzmu2mRKs+WFSujp6c8WgKquco6w3w==", "dev": true, "hasInstallScript": true, "license": "Apache-2.0", @@ -1584,52 +1730,42 @@ "node": ">=16" }, "optionalDependencies": { - "@cloudflare/workerd-darwin-64": "1.20241022.0", - "@cloudflare/workerd-darwin-arm64": "1.20241022.0", - "@cloudflare/workerd-linux-64": "1.20241022.0", - "@cloudflare/workerd-linux-arm64": "1.20241022.0", - "@cloudflare/workerd-windows-64": "1.20241022.0" + "@cloudflare/workerd-darwin-64": "1.20250508.0", + "@cloudflare/workerd-darwin-arm64": "1.20250508.0", + "@cloudflare/workerd-linux-64": "1.20250508.0", + "@cloudflare/workerd-linux-arm64": "1.20250508.0", + "@cloudflare/workerd-windows-64": "1.20250508.0" } }, "node_modules/wrangler": { - "version": "3.83.0", - "resolved": "https://registry.npmjs.org/wrangler/-/wrangler-3.83.0.tgz", - "integrity": "sha512-qDzdUuTngKqmm2OJUZm7Gk4+Hv37F2nNNAHuhIgItEIhxBdOVDsgKmvpd+f41MFxyuGg3fbGWYANHI+0V2Z5yw==", + "version": "4.15.2", + "resolved": "https://registry.npmjs.org/wrangler/-/wrangler-4.15.2.tgz", + "integrity": "sha512-Rv7zP61DOVzIS3af+/1UzJkRVpqu6VDRi6uIVMiwD1LkXG5Ov08tv94jgnE9bSjVf0paQg3dl0E89h+wQ0x/Bw==", "dev": true, "license": "MIT OR Apache-2.0", "dependencies": { - "@cloudflare/kv-asset-handler": "0.3.4", - "@cloudflare/workers-shared": "0.7.0", - "@esbuild-plugins/node-globals-polyfill": "^0.2.3", - "@esbuild-plugins/node-modules-polyfill": "^0.2.2", - "blake3-wasm": "^2.1.5", - "chokidar": "^3.5.3", - "date-fns": "^4.1.0", - "esbuild": "0.17.19", - "itty-time": "^1.0.6", - "miniflare": "3.20241022.0", - "nanoid": "^3.3.3", - "path-to-regexp": "^6.3.0", - "resolve": "^1.22.8", - "resolve.exports": "^2.0.2", - "selfsigned": "^2.0.1", - "source-map": "^0.6.1", - "unenv": "npm:unenv-nightly@2.0.0-20241018-011344-e666fcf", - "workerd": "1.20241022.0", - "xxhash-wasm": "^1.0.1" + "@cloudflare/kv-asset-handler": "0.4.0", + "@cloudflare/unenv-preset": "2.3.1", + "blake3-wasm": "2.1.5", + "esbuild": "0.25.4", + "miniflare": "4.20250508.2", + "path-to-regexp": "6.3.0", + "unenv": "2.0.0-rc.15", + "workerd": "1.20250508.0" }, "bin": { "wrangler": "bin/wrangler.js", "wrangler2": "bin/wrangler.js" }, "engines": { - "node": ">=16.17.0" + "node": ">=18.0.0" }, "optionalDependencies": { - "fsevents": "~2.3.2" + "fsevents": "~2.3.2", + "sharp": "^0.33.5" }, "peerDependencies": { - "@cloudflare/workers-types": "^4.20241022.0" + "@cloudflare/workers-types": "^4.20250508.0" }, "peerDependenciesMeta": { "@cloudflare/workers-types": { @@ -1637,10 +1773,40 @@ } } }, + "node_modules/wrangler/node_modules/@cloudflare/unenv-preset": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/@cloudflare/unenv-preset/-/unenv-preset-2.3.1.tgz", + "integrity": "sha512-Xq57Qd+ADpt6hibcVBO0uLG9zzRgyRhfCUgBT9s+g3+3Ivg5zDyVgLFy40ES1VdNcu8rPNSivm9A+kGP5IVaPg==", + "dev": true, + "license": "MIT OR Apache-2.0", + "peerDependencies": { + "unenv": "2.0.0-rc.15", + "workerd": "^1.20250320.0" + }, + "peerDependenciesMeta": { + "workerd": { + "optional": true + } + } + }, + "node_modules/wrangler/node_modules/unenv": { + "version": "2.0.0-rc.15", + "resolved": "https://registry.npmjs.org/unenv/-/unenv-2.0.0-rc.15.tgz", + "integrity": "sha512-J/rEIZU8w6FOfLNz/hNKsnY+fFHWnu9MH4yRbSZF3xbbGHovcetXPs7sD+9p8L6CeNC//I9bhRYAOsBt2u7/OA==", + "dev": true, + "license": "MIT", + "dependencies": { + "defu": "^6.1.4", + "exsolve": "^1.0.4", + "ohash": "^2.0.11", + "pathe": "^2.0.3", + "ufo": "^1.5.4" + } + }, "node_modules/ws": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz", - "integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==", + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz", + "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==", "dev": true, "license": "MIT", "engines": { @@ -1659,32 +1825,22 @@ } } }, - "node_modules/xxhash-wasm": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/xxhash-wasm/-/xxhash-wasm-1.0.2.tgz", - "integrity": "sha512-ibF0Or+FivM9lNrg+HGJfVX8WJqgo+kCLDc4vx6xMeTce7Aj+DLttKbxxRR/gNLSAelRc1omAPlJ77N/Jem07A==", - "dev": true - }, - "node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" - }, "node_modules/youch": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/youch/-/youch-3.2.3.tgz", - "integrity": "sha512-ZBcWz/uzZaQVdCvfV4uk616Bbpf2ee+F/AvuKDR5EwX/Y4v06xWdtMluqTD7+KlZdM93lLm9gMZYo0sKBS0pgw==", + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/youch/-/youch-3.3.4.tgz", + "integrity": "sha512-UeVBXie8cA35DS6+nBkls68xaBBXCye0CNznrhszZjTbRVnJKQuNsyLKBTTL4ln1o1rh2PKtv35twV7irj5SEg==", "dev": true, + "license": "MIT", "dependencies": { - "cookie": "^0.5.0", + "cookie": "^0.7.1", "mustache": "^4.2.0", "stacktracey": "^2.1.8" } }, "node_modules/zod": { - "version": "3.23.8", - "resolved": "https://registry.npmjs.org/zod/-/zod-3.23.8.tgz", - "integrity": "sha512-XBx9AXhXktjUqnepgTiE5flcKIYWi/rme0Eaj+5Y0lftuGBq+jyRu/md4WnuxqgP1ubdpNCsYEYPxrzVHD8d6g==", + "version": "3.22.3", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.22.3.tgz", + "integrity": "sha512-EjIevzuJRiRPbVH4mGc8nApb/lVLKVpmUhAaR5R5doKGfAnGJ6Gr3CViAVjP+4FWSxCsybeWQdcgCtbX+7oZug==", "dev": true, "license": "MIT", "funding": { diff --git a/playground/api/package.json b/playground/api/package.json index 6a8e313ff6513..79e9d41c7dcdd 100644 --- a/playground/api/package.json +++ b/playground/api/package.json @@ -3,9 +3,9 @@ "version": "0.0.0", "devDependencies": { "@cloudflare/workers-types": "^4.20230801.0", - "miniflare": "^3.20230801.1", + "miniflare": "^4.0.0", "typescript": "^5.1.6", - "wrangler": "3.83.0" + "wrangler": "^4.1.0" }, "private": true, "scripts": { @@ -15,6 +15,6 @@ "dependencies": { "@miniflare/kv": "^2.14.0", "@miniflare/storage-memory": "^2.14.0", - "uuid": "^10.0.0" + "uuid": "^11.0.0" } } diff --git a/playground/api/src/index.ts b/playground/api/src/index.ts index 2fbd4eaebfe7d..9ac1ff5a97d6d 100644 --- a/playground/api/src/index.ts +++ b/playground/api/src/index.ts @@ -31,6 +31,12 @@ const PRODUCTION_HEADERS = { "Access-Control-Allow-Origin": "https://play.ruff.rs", }; +const ALLOWED_DOMAINS = new Set([ + "https://playknot.ruff.rs", + "https://types.ruff.rs", + "https://play.ty.dev", +]); + export default { async fetch( request: Request, @@ -41,6 +47,13 @@ export default { const headers = DEV ? DEVELOPMENT_HEADERS : PRODUCTION_HEADERS; + if (!DEV) { + const origin = request.headers.get("origin"); + if (origin && ALLOWED_DOMAINS.has(origin)) { + headers["Access-Control-Allow-Origin"] = origin; + } + } + switch (request.method) { case "GET": { // Ex) `https://api.astral-1ad.workers.dev/<key>` @@ -55,7 +68,7 @@ export default { } const playground = await PLAYGROUND.get(key); - if (playground === null) { + if (playground == null) { return new Response("Not Found", { status: 404, headers, diff --git a/playground/eslint.config.mjs b/playground/eslint.config.mjs new file mode 100644 index 0000000000000..5e0c342582cda --- /dev/null +++ b/playground/eslint.config.mjs @@ -0,0 +1,38 @@ +import react from "eslint-plugin-react"; +import tseslint from "typescript-eslint"; +import reactHooks from "eslint-plugin-react-hooks"; +import importPlugin from "eslint-plugin-import"; + +export default tseslint.config( + tseslint.configs.eslintRecommended, + tseslint.configs.recommended, + reactHooks.configs["recommended-latest"], + importPlugin.flatConfigs.recommended, + importPlugin.flatConfigs.typescript, + { + ...react.configs.flat.recommended, + ...react.configs.flat["jsx-runtime"], + files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"], + languageOptions: { + ...react.configs.flat.recommended.languageOptions, + ecmaVersion: "latest", + sourceType: "module", + }, + rules: { + eqeqeq: [ + "error", + "always", + { + null: "never", + }, + ], + "@typescript-eslint/no-explicit-any": "off", + // Handled by typescript. It doesn't support shared? + "import/no-unresolved": "off", + "no-console": "error", + }, + }, + { + ignores: ["src/pkg/**"], + }, +); diff --git a/playground/package-lock.json b/playground/package-lock.json index 9846ff3702e64..bfebd62270630 100644 --- a/playground/package-lock.json +++ b/playground/package-lock.json @@ -7,60 +7,47 @@ "": { "name": "playground", "version": "0.0.0", - "dependencies": { - "@monaco-editor/react": "^4.4.6", - "classnames": "^2.3.2", - "lz-string": "^1.5.0", - "monaco-editor": "^0.52.0", - "react": "^18.2.0", - "react-dom": "^18.2.0", - "react-resizable-panels": "^2.0.0", - "smol-toml": "^1.3.0" - }, + "workspaces": [ + "ty", + "ruff", + "shared" + ], "devDependencies": { - "@types/react": "^18.0.26", - "@types/react-dom": "^18.0.9", - "@typescript-eslint/eslint-plugin": "^8.0.0", - "@typescript-eslint/parser": "^8.0.0", + "@eslint/js": "^9.21.0", + "@tailwindcss/vite": "^4.0.14", + "@types/react": "^19.0.11", + "@types/react-dom": "^19.0.0", "@vitejs/plugin-react-swc": "^3.0.0", - "autoprefixer": "^10.4.13", - "eslint": "^8.30.0", - "eslint-config-prettier": "^9.0.0", - "eslint-plugin-import": "^2.29.1", + "eslint": "^9.22.0", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-react": "^7.31.11", - "eslint-plugin-react-hooks": "^5.0.0", - "postcss": "^8.4.20", - "prettier": "^3.0.0", - "tailwindcss": "^3.2.4", - "typescript": "^5.1.6", - "vite": "^5.0.0" + "eslint-plugin-react-hooks": "^5.2.0", + "prettier": "^3.5.3", + "tailwindcss": "^4.0.14", + "typescript": "^5.8.2", + "typescript-eslint": "^8.26.1", + "vite": "^6.2.2", + "wasm-pack": "^0.13.1" } }, - "node_modules/@aashutoshrathi/word-wrap": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz", - "integrity": "sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/@alloc/quick-lru": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/@alloc/quick-lru/-/quick-lru-5.2.0.tgz", - "integrity": "sha512-UrcABB+4bUrFABwbluTIBErXwvbsU/V7TZWfmbgJfbkwiBuziS9gxdODUyuiecfdGQ85jglMW6juS3+z5TsKLw==", + "node_modules/@ampproject/remapping": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", + "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", "dev": true, - "engines": { - "node": ">=10" + "license": "Apache-2.0", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "engines": { + "node": ">=6.0.0" } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", - "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.1.tgz", + "integrity": "sha512-kfYGy8IdzTGy+z0vFGvExZtxkFlA4zAxgKEahG9KE1ScBjpQnFsNOX8KTU5ojNru5ed5CVoJYXFtoxaq5nFbjQ==", "cpu": [ "ppc64" ], @@ -71,13 +58,13 @@ "aix" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/android-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", - "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.1.tgz", + "integrity": "sha512-dp+MshLYux6j/JjdqVLnMglQlFu+MuVeNrmT5nk6q07wNhCdSnB7QZj+7G8VMUGh1q+vj2Bq8kRsuyA00I/k+Q==", "cpu": [ "arm" ], @@ -88,13 +75,13 @@ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/android-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", - "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.1.tgz", + "integrity": "sha512-50tM0zCJW5kGqgG7fQ7IHvQOcAn9TKiVRuQ/lN0xR+T2lzEFvAi1ZcS8DiksFcEpf1t/GYOeOfCAgDHFpkiSmA==", "cpu": [ "arm64" ], @@ -105,13 +92,13 @@ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/android-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", - "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.1.tgz", + "integrity": "sha512-GCj6WfUtNldqUzYkN/ITtlhwQqGWu9S45vUXs7EIYf+7rCiiqH9bCloatO9VhxsL0Pji+PF4Lz2XXCES+Q8hDw==", "cpu": [ "x64" ], @@ -122,13 +109,13 @@ "android" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", - "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.1.tgz", + "integrity": "sha512-5hEZKPf+nQjYoSr/elb62U19/l1mZDdqidGfmFutVUjjUZrOazAtwK+Kr+3y0C/oeJfLlxo9fXb1w7L+P7E4FQ==", "cpu": [ "arm64" ], @@ -139,13 +126,13 @@ "darwin" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", - "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.1.tgz", + "integrity": "sha512-hxVnwL2Dqs3fM1IWq8Iezh0cX7ZGdVhbTfnOy5uURtao5OIVCEyj9xIzemDi7sRvKsuSdtCAhMKarxqtlyVyfA==", "cpu": [ "x64" ], @@ -156,13 +143,13 @@ "darwin" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", - "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.1.tgz", + "integrity": "sha512-1MrCZs0fZa2g8E+FUo2ipw6jw5qqQiH+tERoS5fAfKnRx6NXH31tXBKI3VpmLijLH6yriMZsxJtaXUyFt/8Y4A==", "cpu": [ "arm64" ], @@ -173,13 +160,13 @@ "freebsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", - "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.1.tgz", + "integrity": "sha512-0IZWLiTyz7nm0xuIs0q1Y3QWJC52R8aSXxe40VUxm6BB1RNmkODtW6LHvWRrGiICulcX7ZvyH6h5fqdLu4gkww==", "cpu": [ "x64" ], @@ -190,13 +177,13 @@ "freebsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", - "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.1.tgz", + "integrity": "sha512-NdKOhS4u7JhDKw9G3cY6sWqFcnLITn6SqivVArbzIaf3cemShqfLGHYMx8Xlm/lBit3/5d7kXvriTUGa5YViuQ==", "cpu": [ "arm" ], @@ -207,13 +194,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", - "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.1.tgz", + "integrity": "sha512-jaN3dHi0/DDPelk0nLcXRm1q7DNJpjXy7yWaWvbfkPvI+7XNSc/lDOnCLN7gzsyzgu6qSAmgSvP9oXAhP973uQ==", "cpu": [ "arm64" ], @@ -224,13 +211,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", - "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.1.tgz", + "integrity": "sha512-OJykPaF4v8JidKNGz8c/q1lBO44sQNUQtq1KktJXdBLn1hPod5rE/Hko5ugKKZd+D2+o1a9MFGUEIUwO2YfgkQ==", "cpu": [ "ia32" ], @@ -241,13 +228,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", - "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.1.tgz", + "integrity": "sha512-nGfornQj4dzcq5Vp835oM/o21UMlXzn79KobKlcs3Wz9smwiifknLy4xDCLUU0BWp7b/houtdrgUz7nOGnfIYg==", "cpu": [ "loong64" ], @@ -258,13 +245,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", - "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.1.tgz", + "integrity": "sha512-1osBbPEFYwIE5IVB/0g2X6i1qInZa1aIoj1TdL4AaAb55xIIgbg8Doq6a5BzYWgr+tEcDzYH67XVnTmUzL+nXg==", "cpu": [ "mips64el" ], @@ -275,13 +262,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", - "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.1.tgz", + "integrity": "sha512-/6VBJOwUf3TdTvJZ82qF3tbLuWsscd7/1w+D9LH0W/SqUgM5/JJD0lrJ1fVIfZsqB6RFmLCe0Xz3fmZc3WtyVg==", "cpu": [ "ppc64" ], @@ -292,13 +279,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", - "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.1.tgz", + "integrity": "sha512-nSut/Mx5gnilhcq2yIMLMe3Wl4FK5wx/o0QuuCLMtmJn+WeWYoEGDN1ipcN72g1WHsnIbxGXd4i/MF0gTcuAjQ==", "cpu": [ "riscv64" ], @@ -309,13 +296,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", - "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.1.tgz", + "integrity": "sha512-cEECeLlJNfT8kZHqLarDBQso9a27o2Zd2AQ8USAEoGtejOrCYHNtKP8XQhMDJMtthdF4GBmjR2au3x1udADQQQ==", "cpu": [ "s390x" ], @@ -326,13 +313,13 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/linux-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", - "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.1.tgz", + "integrity": "sha512-xbfUhu/gnvSEg+EGovRc+kjBAkrvtk38RlerAzQxvMzlB4fXpCFCeUAYzJvrnhFtdeyVCDANSjJvOvGYoeKzFA==", "cpu": [ "x64" ], @@ -343,13 +330,30 @@ "linux" ], "engines": { - "node": ">=12" + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.1.tgz", + "integrity": "sha512-O96poM2XGhLtpTh+s4+nP7YCCAfb4tJNRVZHfIE7dgmax+yMP2WgMd2OecBuaATHKTHsLWHQeuaxMRnCsH8+5g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", - "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.1.tgz", + "integrity": "sha512-X53z6uXip6KFXBQ+Krbx25XHV/NCbzryM6ehOAeAil7X7oa4XIq+394PWGnwaSQ2WRA0KI6PUO6hTO5zeF5ijA==", "cpu": [ "x64" ], @@ -360,13 +364,30 @@ "netbsd" ], "engines": { - "node": ">=12" + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.1.tgz", + "integrity": "sha512-Na9T3szbXezdzM/Kfs3GcRQNjHzM6GzFBeU1/6IV/npKP5ORtp9zbQjvkDJ47s6BCgaAZnnnu/cY1x342+MvZg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", - "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.1.tgz", + "integrity": "sha512-T3H78X2h1tszfRSf+txbt5aOp/e7TAz3ptVKu9Oyir3IAOFPGV6O9c2naym5TOriy1l0nNf6a4X5UXRZSGX/dw==", "cpu": [ "x64" ], @@ -377,13 +398,13 @@ "openbsd" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", - "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.1.tgz", + "integrity": "sha512-2H3RUvcmULO7dIE5EWJH8eubZAI4xw54H1ilJnRNZdeo8dTADEZ21w6J22XBkXqGJbe0+wnNJtw3UXRoLJnFEg==", "cpu": [ "x64" ], @@ -394,13 +415,13 @@ "sunos" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", - "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.1.tgz", + "integrity": "sha512-GE7XvrdOzrb+yVKB9KsRMq+7a2U/K5Cf/8grVFRAGJmfADr/e/ODQ134RK2/eeHqYV5eQRFxb1hY7Nr15fv1NQ==", "cpu": [ "arm64" ], @@ -411,13 +432,13 @@ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", - "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.1.tgz", + "integrity": "sha512-uOxSJCIcavSiT6UnBhBzE8wy3n0hOkJsBOzy7HDAuTDE++1DJMRRVCPGisULScHL+a/ZwdXPpXD3IyFKjA7K8A==", "cpu": [ "ia32" ], @@ -428,13 +449,13 @@ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@esbuild/win32-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", - "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.1.tgz", + "integrity": "sha512-Y1EQdcfwMSeQN/ujR5VayLOJ1BHaK+ssyk0AEzPjC+t1lITgsnccPqFjb6V+LsTp/9Iov4ysfjxLaGJ9RPtkVg==", "cpu": [ "x64" ], @@ -445,43 +466,100 @@ "win32" ], "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", - "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", + "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", "dev": true, + "license": "MIT", "dependencies": { - "eslint-visitor-keys": "^3.3.0" + "eslint-visitor-keys": "^3.4.3" }, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, + "funding": { + "url": "https://opencollective.com/eslint" + }, "peerDependencies": { "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" } }, + "node_modules/@eslint-community/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/@eslint-community/regexpp": { - "version": "4.10.0", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.10.0.tgz", - "integrity": "sha512-Cu96Sd2By9mCNTx2iyKOmq10v22jUVQv0lQnlGNy16oE9589yE+QADPbrMGCkA51cKZSg3Pu/aTJVTGfL/qjUA==", + "version": "4.12.1", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", + "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", "dev": true, + "license": "MIT", "engines": { "node": "^12.0.0 || ^14.0.0 || >=16.0.0" } }, + "node_modules/@eslint/config-array": { + "version": "0.20.0", + "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.20.0.tgz", + "integrity": "sha512-fxlS1kkIjx8+vy2SjuCB94q3htSNrufYTXubwiBFeaQHbH6Ipi43gFJq2zCMt6PHhImH3Xmr0NksKDvchWlpQQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@eslint/object-schema": "^2.1.6", + "debug": "^4.3.1", + "minimatch": "^3.1.2" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@eslint/config-helpers": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.2.2.tgz", + "integrity": "sha512-+GPzk8PlG0sPpzdU5ZvIRMPidzAnZDl/s9L+y13iodqvb8leL53bTannOrQ/Im7UkpsmFU5Ily5U60LWixnmLg==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@eslint/core": { + "version": "0.14.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.14.0.tgz", + "integrity": "sha512-qIbV0/JZr7iSDjqAc60IqbLdsj9GDt16xQtWD+B78d/HAlvysGdZZ6rpJHGAc2T0FQx1X6thsSPdnoiGKdNtdg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@types/json-schema": "^7.0.15" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, "node_modules/@eslint/eslintrc": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", - "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.1.tgz", + "integrity": "sha512-gtF186CXhIl1p4pJNGZw8Yc6RlshoePRvE0X91oPGb3vZ8pM3qOS9W9NGPat9LziaBV7XrJWGylNQXkGcnM3IQ==", "dev": true, + "license": "MIT", "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", - "espree": "^9.6.0", - "globals": "^13.19.0", + "espree": "^10.0.1", + "globals": "^14.0.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", "js-yaml": "^4.1.0", @@ -489,36 +567,85 @@ "strip-json-comments": "^3.1.1" }, "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "url": "https://opencollective.com/eslint" } }, "node_modules/@eslint/js": { - "version": "8.57.1", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", - "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", + "version": "9.27.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.27.0.tgz", + "integrity": "sha512-G5JD9Tu5HJEu4z2Uo4aHY2sLV64B7CDMXxFzqzjl3NKd6RVzSXNoE80jk7Y0lJkTTkjiIhBAqmlYwjuBY3tvpA==", "dev": true, "license": "MIT", "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "url": "https://eslint.org/donate" + } + }, + "node_modules/@eslint/object-schema": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", + "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, - "node_modules/@humanwhocodes/config-array": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", - "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", - "deprecated": "Use @eslint/config-array instead", + "node_modules/@eslint/plugin-kit": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.1.tgz", + "integrity": "sha512-0J+zgWxHN+xXONWIyPWKFMgVuJoZuGiIFu8yxk7RJjxkzpGmyja5wRFqZIVtjDVOQpV+Rw0iOAjYPE2eQyjr0w==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@humanwhocodes/object-schema": "^2.0.3", - "debug": "^4.3.1", - "minimatch": "^3.0.5" + "@eslint/core": "^0.14.0", + "levn": "^0.4.1" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@humanfs/core": { + "version": "0.19.1", + "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", + "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=18.18.0" + } + }, + "node_modules/@humanfs/node": { + "version": "0.16.6", + "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", + "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@humanfs/core": "^0.19.1", + "@humanwhocodes/retry": "^0.3.0" }, "engines": { - "node": ">=10.10.0" + "node": ">=18.18.0" + } + }, + "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", + "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=18.18" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" } }, "node_modules/@humanwhocodes/module-importer": { @@ -526,6 +653,7 @@ "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.22" }, @@ -534,88 +662,117 @@ "url": "https://github.com/sponsors/nzakas" } }, - "node_modules/@humanwhocodes/object-schema": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", - "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", - "dev": true + "node_modules/@humanwhocodes/retry": { + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.2.tgz", + "integrity": "sha512-xeO57FpIu4p1Ri3Jq/EXq4ClRm86dVF2z/+kvFnyqVYRavTZmaFaUBbWCOuuTh0o/g7DSsk6kc2vrS4Vl5oPOQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=18.18" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" + } + }, + "node_modules/@isaacs/fs-minipass": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz", + "integrity": "sha512-wgm9Ehl2jpeqP3zw/7mo3kRHFp5MEDhqAdwy1fTGkHAwnkGOVsgpvQhL8B5n1qlb01jV3n/bI0ZfZp5lWA1k4w==", + "dev": true, + "license": "ISC", + "dependencies": { + "minipass": "^7.0.4" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@isaacs/fs-minipass/node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } }, "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.3.tgz", - "integrity": "sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ==", + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", + "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", "dev": true, + "license": "MIT", "dependencies": { - "@jridgewell/set-array": "^1.0.1", + "@jridgewell/set-array": "^1.2.1", "@jridgewell/sourcemap-codec": "^1.4.10", - "@jridgewell/trace-mapping": "^0.3.9" + "@jridgewell/trace-mapping": "^0.3.24" }, "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/resolve-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz", - "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==", + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", "dev": true, + "license": "MIT", "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/set-array": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.1.2.tgz", - "integrity": "sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", "dev": true, + "license": "MIT", "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.4.15", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", - "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", - "dev": true + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true, + "license": "MIT" }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.18", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.18.tgz", - "integrity": "sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==", + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", "dev": true, + "license": "MIT", "dependencies": { - "@jridgewell/resolve-uri": "3.1.0", - "@jridgewell/sourcemap-codec": "1.4.14" + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" } }, - "node_modules/@jridgewell/trace-mapping/node_modules/@jridgewell/sourcemap-codec": { - "version": "1.4.14", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz", - "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", - "dev": true - }, "node_modules/@monaco-editor/loader": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/@monaco-editor/loader/-/loader-1.4.0.tgz", - "integrity": "sha512-00ioBig0x642hytVspPl7DbQyaSWRaolYie/UFNjoTdvoKPzo6xrXLhTk9ixgIKcLH5b5vDOjVNiGyY+uDCUlg==", + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@monaco-editor/loader/-/loader-1.5.0.tgz", + "integrity": "sha512-hKoGSM+7aAc7eRTRjpqAZucPmoNOC4UUbknb/VNoTkEIkCPhqV8LfbsgM1webRM7S/z21eHEx9Fkwx8Z/C/+Xw==", + "license": "MIT", "dependencies": { "state-local": "^1.0.6" - }, - "peerDependencies": { - "monaco-editor": ">= 0.21.0 < 1" } }, "node_modules/@monaco-editor/react": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@monaco-editor/react/-/react-4.6.0.tgz", - "integrity": "sha512-RFkU9/i7cN2bsq/iTkurMWOEErmYcY6JiQI3Jn+WeR/FGISH8JbHERjpS9oRuSOPvDMJI0Z8nJeKkbOs9sBYQw==", + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/@monaco-editor/react/-/react-4.7.0.tgz", + "integrity": "sha512-cyzXQCtO47ydzxpQtCGSQGOC8Gk3ZUeBXFAxD+CWXYFo5OqZyZUonFl0DwUlTyAfRHntBfw2p3w4s9R6oe1eCA==", + "license": "MIT", "dependencies": { - "@monaco-editor/loader": "^1.4.0" + "@monaco-editor/loader": "^1.5.0" }, "peerDependencies": { "monaco-editor": ">= 0.25.0 < 1", - "react": "^16.8.0 || ^17.0.0 || ^18.0.0", - "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0" + "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" } }, "node_modules/@nodelib/fs.scandir": { @@ -623,6 +780,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -636,6 +794,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } @@ -645,6 +804,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -654,9 +814,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.21.0.tgz", - "integrity": "sha512-WTWD8PfoSAJ+qL87lE7votj3syLavxunWhzCnx3XFxFiI/BA/r3X7MUM8dVrH8rb2r4AiO8jJsr3ZjdaftmnfA==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.36.0.tgz", + "integrity": "sha512-jgrXjjcEwN6XpZXL0HUeOVGfjXhPyxAbbhD0BlXUB+abTOpbPiN5Wb3kOT7yb+uEtATNYF5x5gIfwutmuBA26w==", "cpu": [ "arm" ], @@ -668,9 +828,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.21.0.tgz", - "integrity": "sha512-a1sR2zSK1B4eYkiZu17ZUZhmUQcKjk2/j9Me2IDjk1GHW7LB5Z35LEzj9iJch6gtUfsnvZs1ZNyDW2oZSThrkA==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.36.0.tgz", + "integrity": "sha512-NyfuLvdPdNUfUNeYKUwPwKsE5SXa2J6bCt2LdB/N+AxShnkpiczi3tcLJrm5mA+eqpy0HmaIY9F6XCa32N5yzg==", "cpu": [ "arm64" ], @@ -682,9 +842,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.21.0.tgz", - "integrity": "sha512-zOnKWLgDld/svhKO5PD9ozmL6roy5OQ5T4ThvdYZLpiOhEGY+dp2NwUmxK0Ld91LrbjrvtNAE0ERBwjqhZTRAA==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.36.0.tgz", + "integrity": "sha512-JQ1Jk5G4bGrD4pWJQzWsD8I1n1mgPXq33+/vP4sk8j/z/C2siRuxZtaUA7yMTf71TCZTZl/4e1bfzwUmFb3+rw==", "cpu": [ "arm64" ], @@ -696,9 +856,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.21.0.tgz", - "integrity": "sha512-7doS8br0xAkg48SKE2QNtMSFPFUlRdw9+votl27MvT46vo44ATBmdZdGysOevNELmZlfd+NEa0UYOA8f01WSrg==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.36.0.tgz", + "integrity": "sha512-6c6wMZa1lrtiRsbDziCmjE53YbTkxMYhhnWnSW8R/yqsM7a6mSJ3uAVT0t8Y/DGt7gxUWYuFM4bwWk9XCJrFKA==", "cpu": [ "x64" ], @@ -709,10 +869,38 @@ "darwin" ] }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.36.0.tgz", + "integrity": "sha512-KXVsijKeJXOl8QzXTsA+sHVDsFOmMCdBRgFmBb+mfEb/7geR7+C8ypAml4fquUt14ZyVXaw2o1FWhqAfOvA4sg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.36.0.tgz", + "integrity": "sha512-dVeWq1ebbvByI+ndz4IJcD4a09RJgRYmLccwlQ8bPd4olz3Y213uf1iwvc7ZaxNn2ab7bjc08PrtBgMu6nb4pQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.21.0.tgz", - "integrity": "sha512-pWJsfQjNWNGsoCq53KjMtwdJDmh/6NubwQcz52aEwLEuvx08bzcy6tOUuawAOncPnxz/3siRtd8hiQ32G1y8VA==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.36.0.tgz", + "integrity": "sha512-bvXVU42mOVcF4le6XSjscdXjqx8okv4n5vmwgzcmtvFdifQ5U4dXFYaCB87namDRKlUL9ybVtLQ9ztnawaSzvg==", "cpu": [ "arm" ], @@ -724,9 +912,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.21.0.tgz", - "integrity": "sha512-efRIANsz3UHZrnZXuEvxS9LoCOWMGD1rweciD6uJQIx2myN3a8Im1FafZBzh7zk1RJ6oKcR16dU3UPldaKd83w==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.36.0.tgz", + "integrity": "sha512-JFIQrDJYrxOnyDQGYkqnNBtjDwTgbasdbUiQvcU8JmGDfValfH1lNpng+4FWlhaVIR4KPkeddYjsVVbmJYvDcg==", "cpu": [ "arm" ], @@ -738,9 +926,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.21.0.tgz", - "integrity": "sha512-ZrPhydkTVhyeGTW94WJ8pnl1uroqVHM3j3hjdquwAcWnmivjAwOYjTEAuEDeJvGX7xv3Z9GAvrBkEzCgHq9U1w==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.36.0.tgz", + "integrity": "sha512-KqjYVh3oM1bj//5X7k79PSCZ6CvaVzb7Qs7VMWS+SlWB5M8p3FqufLP9VNp4CazJ0CsPDLwVD9r3vX7Ci4J56A==", "cpu": [ "arm64" ], @@ -752,9 +940,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.21.0.tgz", - "integrity": "sha512-cfaupqd+UEFeURmqNP2eEvXqgbSox/LHOyN9/d2pSdV8xTrjdg3NgOFJCtc1vQ/jEke1qD0IejbBfxleBPHnPw==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.36.0.tgz", + "integrity": "sha512-QiGnhScND+mAAtfHqeT+cB1S9yFnNQ/EwCg5yE3MzoaZZnIV0RV9O5alJAoJKX/sBONVKeZdMfO8QSaWEygMhw==", "cpu": [ "arm64" ], @@ -765,10 +953,24 @@ "linux" ] }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.36.0.tgz", + "integrity": "sha512-1ZPyEDWF8phd4FQtTzMh8FQwqzvIjLsl6/84gzUxnMNFBtExBtpL51H67mV9xipuxl1AEAerRBgBwFNpkw8+Lg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.21.0.tgz", - "integrity": "sha512-ZKPan1/RvAhrUylwBXC9t7B2hXdpb/ufeu22pG2psV7RN8roOfGurEghw1ySmX/CmDDHNTDDjY3lo9hRlgtaHg==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.36.0.tgz", + "integrity": "sha512-VMPMEIUpPFKpPI9GZMhJrtu8rxnp6mJR3ZzQPykq4xc2GmdHj3Q4cA+7avMyegXy4n1v+Qynr9fR88BmyO74tg==", "cpu": [ "ppc64" ], @@ -780,9 +982,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.21.0.tgz", - "integrity": "sha512-H1eRaCwd5E8eS8leiS+o/NqMdljkcb1d6r2h4fKSsCXQilLKArq6WS7XBLDu80Yz+nMqHVFDquwcVrQmGr28rg==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.36.0.tgz", + "integrity": "sha512-ttE6ayb/kHwNRJGYLpuAvB7SMtOeQnVXEIpMtAvx3kepFQeowVED0n1K9nAdraHUPJ5hydEMxBpIR7o4nrm8uA==", "cpu": [ "riscv64" ], @@ -794,9 +996,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.21.0.tgz", - "integrity": "sha512-zJ4hA+3b5tu8u7L58CCSI0A9N1vkfwPhWd/puGXwtZlsB5bTkwDNW/+JCU84+3QYmKpLi+XvHdmrlwUwDA6kqw==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.36.0.tgz", + "integrity": "sha512-4a5gf2jpS0AIe7uBjxDeUMNcFmaRTbNv7NxI5xOCs4lhzsVyGR/0qBXduPnoWf6dGC365saTiwag8hP1imTgag==", "cpu": [ "s390x" ], @@ -808,9 +1010,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.21.0.tgz", - "integrity": "sha512-e2hrvElFIh6kW/UNBQK/kzqMNY5mO+67YtEh9OA65RM5IJXYTWiXjX6fjIiPaqOkBthYF1EqgiZ6OXKcQsM0hg==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.36.0.tgz", + "integrity": "sha512-5KtoW8UWmwFKQ96aQL3LlRXX16IMwyzMq/jSSVIIyAANiE1doaQsx/KRyhAvpHlPjPiSU/AYX/8m+lQ9VToxFQ==", "cpu": [ "x64" ], @@ -822,9 +1024,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.21.0.tgz", - "integrity": "sha512-1vvmgDdUSebVGXWX2lIcgRebqfQSff0hMEkLJyakQ9JQUbLDkEaMsPTLOmyccyC6IJ/l3FZuJbmrBw/u0A0uCQ==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.36.0.tgz", + "integrity": "sha512-sycrYZPrv2ag4OCvaN5js+f01eoZ2U+RmT5as8vhxiFz+kxwlHrsxOwKPSA8WyS+Wc6Epid9QeI/IkQ9NkgYyQ==", "cpu": [ "x64" ], @@ -836,9 +1038,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.21.0.tgz", - "integrity": "sha512-s5oFkZ/hFcrlAyBTONFY1TWndfyre1wOMwU+6KCpm/iatybvrRgmZVM+vCFwxmC5ZhdlgfE0N4XorsDpi7/4XQ==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.36.0.tgz", + "integrity": "sha512-qbqt4N7tokFwwSVlWDsjfoHgviS3n/vZ8LK0h1uLG9TYIRuUTJC88E1xb3LM2iqZ/WTqNQjYrtmtGmrmmawB6A==", "cpu": [ "arm64" ], @@ -850,9 +1052,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.21.0.tgz", - "integrity": "sha512-G9+TEqRnAA6nbpqyUqgTiopmnfgnMkR3kMukFBDsiyy23LZvUCpiUwjTRx6ezYCjJODXrh52rBR9oXvm+Fp5wg==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.36.0.tgz", + "integrity": "sha512-t+RY0JuRamIocMuQcfwYSOkmdX9dtkr1PbhKW42AMvaDQa+jOdpUYysroTF/nuPpAaQMWp7ye+ndlmmthieJrQ==", "cpu": [ "ia32" ], @@ -864,9 +1066,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.21.0.tgz", - "integrity": "sha512-2jsCDZwtQvRhejHLfZ1JY6w6kEuEtfF9nzYsZxzSlNVKDX+DpsDJ+Rbjkm74nvg2rdx0gwBS+IMdvwJuq3S9pQ==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.36.0.tgz", + "integrity": "sha512-aRXd7tRZkWLqGbChgcMMDEHjOKudo1kChb1Jt1IfR8cY/KIpgNviLeJy5FUb9IpSuQj8dU2fAYNMPW/hLKOSTw==", "cpu": [ "x64" ], @@ -885,15 +1087,15 @@ "license": "MIT" }, "node_modules/@swc/core": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core/-/core-1.7.26.tgz", - "integrity": "sha512-f5uYFf+TmMQyYIoxkn/evWhNGuUzC730dFwAKGwBVHHVoPyak1/GvJUm6i1SKl+2Hrj9oN0i3WSoWWZ4pgI8lw==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core/-/core-1.11.24.tgz", + "integrity": "sha512-MaQEIpfcEMzx3VWWopbofKJvaraqmL6HbLlw2bFZ7qYqYw3rkhM0cQVEgyzbHtTWwCwPMFZSC2DUbhlZgrMfLg==", "dev": true, "hasInstallScript": true, "license": "Apache-2.0", "dependencies": { "@swc/counter": "^0.1.3", - "@swc/types": "^0.1.12" + "@swc/types": "^0.1.21" }, "engines": { "node": ">=10" @@ -903,19 +1105,19 @@ "url": "https://opencollective.com/swc" }, "optionalDependencies": { - "@swc/core-darwin-arm64": "1.7.26", - "@swc/core-darwin-x64": "1.7.26", - "@swc/core-linux-arm-gnueabihf": "1.7.26", - "@swc/core-linux-arm64-gnu": "1.7.26", - "@swc/core-linux-arm64-musl": "1.7.26", - "@swc/core-linux-x64-gnu": "1.7.26", - "@swc/core-linux-x64-musl": "1.7.26", - "@swc/core-win32-arm64-msvc": "1.7.26", - "@swc/core-win32-ia32-msvc": "1.7.26", - "@swc/core-win32-x64-msvc": "1.7.26" + "@swc/core-darwin-arm64": "1.11.24", + "@swc/core-darwin-x64": "1.11.24", + "@swc/core-linux-arm-gnueabihf": "1.11.24", + "@swc/core-linux-arm64-gnu": "1.11.24", + "@swc/core-linux-arm64-musl": "1.11.24", + "@swc/core-linux-x64-gnu": "1.11.24", + "@swc/core-linux-x64-musl": "1.11.24", + "@swc/core-win32-arm64-msvc": "1.11.24", + "@swc/core-win32-ia32-msvc": "1.11.24", + "@swc/core-win32-x64-msvc": "1.11.24" }, "peerDependencies": { - "@swc/helpers": "*" + "@swc/helpers": ">=0.5.17" }, "peerDependenciesMeta": { "@swc/helpers": { @@ -924,9 +1126,9 @@ } }, "node_modules/@swc/core-darwin-arm64": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-darwin-arm64/-/core-darwin-arm64-1.7.26.tgz", - "integrity": "sha512-FF3CRYTg6a7ZVW4yT9mesxoVVZTrcSWtmZhxKCYJX9brH4CS/7PRPjAKNk6kzWgWuRoglP7hkjQcd6EpMcZEAw==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-arm64/-/core-darwin-arm64-1.11.24.tgz", + "integrity": "sha512-dhtVj0PC1APOF4fl5qT2neGjRLgHAAYfiVP8poJelhzhB/318bO+QCFWAiimcDoyMgpCXOhTp757gnoJJrheWA==", "cpu": [ "arm64" ], @@ -941,9 +1143,9 @@ } }, "node_modules/@swc/core-darwin-x64": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-darwin-x64/-/core-darwin-x64-1.7.26.tgz", - "integrity": "sha512-az3cibZdsay2HNKmc4bjf62QVukuiMRh5sfM5kHR/JMTrLyS6vSw7Ihs3UTkZjUxkLTT8ro54LI6sV6sUQUbLQ==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-x64/-/core-darwin-x64-1.11.24.tgz", + "integrity": "sha512-H/3cPs8uxcj2Fe3SoLlofN5JG6Ny5bl8DuZ6Yc2wr7gQFBmyBkbZEz+sPVgsID7IXuz7vTP95kMm1VL74SO5AQ==", "cpu": [ "x64" ], @@ -958,9 +1160,9 @@ } }, "node_modules/@swc/core-linux-arm-gnueabihf": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.7.26.tgz", - "integrity": "sha512-VYPFVJDO5zT5U3RpCdHE5v1gz4mmR8BfHecUZTmD2v1JeFY6fv9KArJUpjrHEEsjK/ucXkQFmJ0jaiWXmpOV9Q==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.11.24.tgz", + "integrity": "sha512-PHJgWEpCsLo/NGj+A2lXZ2mgGjsr96ULNW3+T3Bj2KTc8XtMUkE8tmY2Da20ItZOvPNC/69KroU7edyo1Flfbw==", "cpu": [ "arm" ], @@ -975,9 +1177,9 @@ } }, "node_modules/@swc/core-linux-arm64-gnu": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.7.26.tgz", - "integrity": "sha512-YKevOV7abpjcAzXrhsl+W48Z9mZvgoVs2eP5nY+uoMAdP2b3GxC0Df1Co0I90o2lkzO4jYBpTMcZlmUXLdXn+Q==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.11.24.tgz", + "integrity": "sha512-C2FJb08+n5SD4CYWCTZx1uR88BN41ZieoHvI8A55hfVf2woT8+6ZiBzt74qW2g+ntZ535Jts5VwXAKdu41HpBg==", "cpu": [ "arm64" ], @@ -992,9 +1194,9 @@ } }, "node_modules/@swc/core-linux-arm64-musl": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.7.26.tgz", - "integrity": "sha512-3w8iZICMkQQON0uIcvz7+Q1MPOW6hJ4O5ETjA0LSP/tuKqx30hIniCGOgPDnv3UTMruLUnQbtBwVCZTBKR3Rkg==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.11.24.tgz", + "integrity": "sha512-ypXLIdszRo0re7PNNaXN0+2lD454G8l9LPK/rbfRXnhLWDBPURxzKlLlU/YGd2zP98wPcVooMmegRSNOKfvErw==", "cpu": [ "arm64" ], @@ -1009,9 +1211,9 @@ } }, "node_modules/@swc/core-linux-x64-gnu": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.7.26.tgz", - "integrity": "sha512-c+pp9Zkk2lqb06bNGkR2Looxrs7FtGDMA4/aHjZcCqATgp348hOKH5WPvNLBl+yPrISuWjbKDVn3NgAvfvpH4w==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.11.24.tgz", + "integrity": "sha512-IM7d+STVZD48zxcgo69L0yYptfhaaE9cMZ+9OoMxirNafhKKXwoZuufol1+alEFKc+Wbwp+aUPe/DeWC/Lh3dg==", "cpu": [ "x64" ], @@ -1026,9 +1228,9 @@ } }, "node_modules/@swc/core-linux-x64-musl": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.7.26.tgz", - "integrity": "sha512-PgtyfHBF6xG87dUSSdTJHwZ3/8vWZfNIXQV2GlwEpslrOkGqy+WaiiyE7Of7z9AvDILfBBBcJvJ/r8u980wAfQ==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.11.24.tgz", + "integrity": "sha512-DZByJaMVzSfjQKKQn3cqSeqwy6lpMaQDQQ4HPlch9FWtDx/dLcpdIhxssqZXcR2rhaQVIaRQsCqwV6orSDGAGw==", "cpu": [ "x64" ], @@ -1043,9 +1245,9 @@ } }, "node_modules/@swc/core-win32-arm64-msvc": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.7.26.tgz", - "integrity": "sha512-9TNXPIJqFynlAOrRD6tUQjMq7KApSklK3R/tXgIxc7Qx+lWu8hlDQ/kVPLpU7PWvMMwC/3hKBW+p5f+Tms1hmA==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.11.24.tgz", + "integrity": "sha512-Q64Ytn23y9aVDKN5iryFi8mRgyHw3/kyjTjT4qFCa8AEb5sGUuSj//AUZ6c0J7hQKMHlg9do5Etvoe61V98/JQ==", "cpu": [ "arm64" ], @@ -1060,9 +1262,9 @@ } }, "node_modules/@swc/core-win32-ia32-msvc": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.7.26.tgz", - "integrity": "sha512-9YngxNcG3177GYdsTum4V98Re+TlCeJEP4kEwEg9EagT5s3YejYdKwVAkAsJszzkXuyRDdnHUpYbTrPG6FiXrQ==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.11.24.tgz", + "integrity": "sha512-9pKLIisE/Hh2vJhGIPvSoTK4uBSPxNVyXHmOrtdDot4E1FUUI74Vi8tFdlwNbaj8/vusVnb8xPXsxF1uB0VgiQ==", "cpu": [ "ia32" ], @@ -1077,9 +1279,9 @@ } }, "node_modules/@swc/core-win32-x64-msvc": { - "version": "1.7.26", - "resolved": "https://registry.npmjs.org/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.7.26.tgz", - "integrity": "sha512-VR+hzg9XqucgLjXxA13MtV5O3C0bK0ywtLIBw/+a+O+Oc6mxFWHtdUeXDbIi5AiPbn0fjgVJMqYnyjGyyX8u0w==", + "version": "1.11.24", + "resolved": "https://registry.npmjs.org/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.11.24.tgz", + "integrity": "sha512-sybnXtOsdB+XvzVFlBVGgRHLqp3yRpHK7CrmpuDKszhj/QhmsaZzY/GHSeALlMtLup13M0gqbcQvsTNlAHTg3w==", "cpu": [ "x64" ], @@ -1101,70 +1303,486 @@ "license": "Apache-2.0" }, "node_modules/@swc/types": { - "version": "0.1.12", - "resolved": "https://registry.npmjs.org/@swc/types/-/types-0.1.12.tgz", - "integrity": "sha512-wBJA+SdtkbFhHjTMYH+dEH1y4VpfGdAc2Kw/LK09i9bXd/K6j6PkDcFCEzb6iVfZMkPRrl/q0e3toqTAJdkIVA==", + "version": "0.1.21", + "resolved": "https://registry.npmjs.org/@swc/types/-/types-0.1.21.tgz", + "integrity": "sha512-2YEtj5HJVbKivud9N4bpPBAyZhj4S2Ipe5LkUG94alTpr7in/GU/EARgPAd3BwU+YOmFVJC2+kjqhGRi3r0ZpQ==", "dev": true, "license": "Apache-2.0", "dependencies": { "@swc/counter": "^0.1.3" } }, - "node_modules/@types/estree": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", - "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", - "dev": true - }, - "node_modules/@types/json5": { - "version": "0.0.29", - "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", - "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", - "dev": true - }, - "node_modules/@types/prop-types": { - "version": "15.7.5", - "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.5.tgz", - "integrity": "sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==", - "dev": true - }, - "node_modules/@types/react": { - "version": "18.3.12", - "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.12.tgz", - "integrity": "sha512-D2wOSq/d6Agt28q7rSI3jhU7G6aiuzljDGZ2hTZHIkrTLUI+AF3WMeKkEZ9nN2fkBAlcktT6vcZjDFiIhMYEQw==", + "node_modules/@tailwindcss/node": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/node/-/node-4.1.7.tgz", + "integrity": "sha512-9rsOpdY9idRI2NH6CL4wORFY0+Q6fnx9XP9Ju+iq/0wJwGD5IByIgFmwVbyy4ymuyprj8Qh4ErxMKTUL4uNh3g==", "dev": true, "license": "MIT", "dependencies": { - "@types/prop-types": "*", - "csstype": "^3.0.2" + "@ampproject/remapping": "^2.3.0", + "enhanced-resolve": "^5.18.1", + "jiti": "^2.4.2", + "lightningcss": "1.30.1", + "magic-string": "^0.30.17", + "source-map-js": "^1.2.1", + "tailwindcss": "4.1.7" } }, - "node_modules/@types/react-dom": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.1.tgz", - "integrity": "sha512-qW1Mfv8taImTthu4KoXgDfLuk4bydU6Q/TkADnDWWHwi4NX4BR+LWfTp2sVmTqRrsHvyDDTelgelxJ+SsejKKQ==", + "node_modules/@tailwindcss/oxide": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide/-/oxide-4.1.7.tgz", + "integrity": "sha512-5SF95Ctm9DFiUyjUPnDGkoKItPX/k+xifcQhcqX5RA85m50jw1pT/KzjdvlqxRja45Y52nR4MR9fD1JYd7f8NQ==", "dev": true, + "hasInstallScript": true, "license": "MIT", "dependencies": { - "@types/react": "*" + "detect-libc": "^2.0.4", + "tar": "^7.4.3" + }, + "engines": { + "node": ">= 10" + }, + "optionalDependencies": { + "@tailwindcss/oxide-android-arm64": "4.1.7", + "@tailwindcss/oxide-darwin-arm64": "4.1.7", + "@tailwindcss/oxide-darwin-x64": "4.1.7", + "@tailwindcss/oxide-freebsd-x64": "4.1.7", + "@tailwindcss/oxide-linux-arm-gnueabihf": "4.1.7", + "@tailwindcss/oxide-linux-arm64-gnu": "4.1.7", + "@tailwindcss/oxide-linux-arm64-musl": "4.1.7", + "@tailwindcss/oxide-linux-x64-gnu": "4.1.7", + "@tailwindcss/oxide-linux-x64-musl": "4.1.7", + "@tailwindcss/oxide-wasm32-wasi": "4.1.7", + "@tailwindcss/oxide-win32-arm64-msvc": "4.1.7", + "@tailwindcss/oxide-win32-x64-msvc": "4.1.7" + } + }, + "node_modules/@tailwindcss/oxide-android-arm64": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-android-arm64/-/oxide-android-arm64-4.1.7.tgz", + "integrity": "sha512-IWA410JZ8fF7kACus6BrUwY2Z1t1hm0+ZWNEzykKmMNM09wQooOcN/VXr0p/WJdtHZ90PvJf2AIBS/Ceqx1emg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" } }, - "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.11.0.tgz", - "integrity": "sha512-KhGn2LjW1PJT2A/GfDpiyOfS4a8xHQv2myUagTM5+zsormOmBlYsnQ6pobJ8XxJmh6hnHwa2Mbe3fPrDJoDhbA==", + "node_modules/@tailwindcss/oxide-darwin-arm64": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-darwin-arm64/-/oxide-darwin-arm64-4.1.7.tgz", + "integrity": "sha512-81jUw9To7fimGGkuJ2W5h3/oGonTOZKZ8C2ghm/TTxbwvfSiFSDPd6/A/KE2N7Jp4mv3Ps9OFqg2fEKgZFfsvg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-darwin-x64": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-darwin-x64/-/oxide-darwin-x64-4.1.7.tgz", + "integrity": "sha512-q77rWjEyGHV4PdDBtrzO0tgBBPlQWKY7wZK0cUok/HaGgbNKecegNxCGikuPJn5wFAlIywC3v+WMBt0PEBtwGw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-freebsd-x64": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-freebsd-x64/-/oxide-freebsd-x64-4.1.7.tgz", + "integrity": "sha512-RfmdbbK6G6ptgF4qqbzoxmH+PKfP4KSVs7SRlTwcbRgBwezJkAO3Qta/7gDy10Q2DcUVkKxFLXUQO6J3CRvBGw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-linux-arm-gnueabihf": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-linux-arm-gnueabihf/-/oxide-linux-arm-gnueabihf-4.1.7.tgz", + "integrity": "sha512-OZqsGvpwOa13lVd1z6JVwQXadEobmesxQ4AxhrwRiPuE04quvZHWn/LnihMg7/XkN+dTioXp/VMu/p6A5eZP3g==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-linux-arm64-gnu": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-linux-arm64-gnu/-/oxide-linux-arm64-gnu-4.1.7.tgz", + "integrity": "sha512-voMvBTnJSfKecJxGkoeAyW/2XRToLZ227LxswLAwKY7YslG/Xkw9/tJNH+3IVh5bdYzYE7DfiaPbRkSHFxY1xA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-linux-arm64-musl": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-linux-arm64-musl/-/oxide-linux-arm64-musl-4.1.7.tgz", + "integrity": "sha512-PjGuNNmJeKHnP58M7XyjJyla8LPo+RmwHQpBI+W/OxqrwojyuCQ+GUtygu7jUqTEexejZHr/z3nBc/gTiXBj4A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-linux-x64-gnu": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-linux-x64-gnu/-/oxide-linux-x64-gnu-4.1.7.tgz", + "integrity": "sha512-HMs+Va+ZR3gC3mLZE00gXxtBo3JoSQxtu9lobbZd+DmfkIxR54NO7Z+UQNPsa0P/ITn1TevtFxXTpsRU7qEvWg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-linux-x64-musl": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-linux-x64-musl/-/oxide-linux-x64-musl-4.1.7.tgz", + "integrity": "sha512-MHZ6jyNlutdHH8rd+YTdr3QbXrHXqwIhHw9e7yXEBcQdluGwhpQY2Eku8UZK6ReLaWtQ4gijIv5QoM5eE+qlsA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-wasm32-wasi/-/oxide-wasm32-wasi-4.1.7.tgz", + "integrity": "sha512-ANaSKt74ZRzE2TvJmUcbFQ8zS201cIPxUDm5qez5rLEwWkie2SkGtA4P+GPTj+u8N6JbPrC8MtY8RmJA35Oo+A==", + "bundleDependencies": [ + "@napi-rs/wasm-runtime", + "@emnapi/core", + "@emnapi/runtime", + "@tybys/wasm-util", + "@emnapi/wasi-threads", + "tslib" + ], + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/core": "^1.4.3", + "@emnapi/runtime": "^1.4.3", + "@emnapi/wasi-threads": "^1.0.2", + "@napi-rs/wasm-runtime": "^0.2.9", + "@tybys/wasm-util": "^0.9.0", + "tslib": "^2.8.0" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/@emnapi/core": { + "version": "1.4.3", + "dev": true, + "inBundle": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/wasi-threads": "1.0.2", + "tslib": "^2.4.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/@emnapi/runtime": { + "version": "1.4.3", + "dev": true, + "inBundle": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/@emnapi/wasi-threads": { + "version": "1.0.2", + "dev": true, + "inBundle": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/@napi-rs/wasm-runtime": { + "version": "0.2.9", + "dev": true, + "inBundle": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/core": "^1.4.0", + "@emnapi/runtime": "^1.4.0", + "@tybys/wasm-util": "^0.9.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/@tybys/wasm-util": { + "version": "0.9.0", + "dev": true, + "inBundle": true, + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@tailwindcss/oxide-wasm32-wasi/node_modules/tslib": { + "version": "2.8.0", + "dev": true, + "inBundle": true, + "license": "0BSD", + "optional": true + }, + "node_modules/@tailwindcss/oxide-win32-arm64-msvc": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-win32-arm64-msvc/-/oxide-win32-arm64-msvc-4.1.7.tgz", + "integrity": "sha512-HUiSiXQ9gLJBAPCMVRk2RT1ZrBjto7WvqsPBwUrNK2BcdSxMnk19h4pjZjI7zgPhDxlAbJSumTC4ljeA9y0tEw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide-win32-x64-msvc": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/oxide-win32-x64-msvc/-/oxide-win32-x64-msvc-4.1.7.tgz", + "integrity": "sha512-rYHGmvoHiLJ8hWucSfSOEmdCBIGZIq7SpkPRSqLsH2Ab2YUNgKeAPT1Fi2cx3+hnYOrAb0jp9cRyode3bBW4mQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/chownr": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-3.0.0.tgz", + "integrity": "sha512-+IxzY9BZOQd/XuYPRmrvEVjF/nqj5kgT4kEq7VofrDoM1MxoRjEWkrCC3EtLi59TVawxTAn+orJwFQcrqEN1+g==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/minizlib": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.0.2.tgz", + "integrity": "sha512-oG62iEk+CYt5Xj2YqI5Xi9xWUeZhDI8jjQmC5oThVH5JGCTgIjr7ciJDzC7MBzYd//WvR1OTmP5Q38Q8ShQtVA==", + "dev": true, + "license": "MIT", + "dependencies": { + "minipass": "^7.1.2" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/mkdirp": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-3.0.1.tgz", + "integrity": "sha512-+NsyUUAZDmo6YVHzL/stxSu3t9YS1iljliy3BSDrXJ/dkn1KYdmtZODGGjLcc9XLgVVpH4KshHB8XmZgMhaBXg==", + "dev": true, + "license": "MIT", + "bin": { + "mkdirp": "dist/cjs/src/bin.js" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/tar": { + "version": "7.4.3", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.4.3.tgz", + "integrity": "sha512-5S7Va8hKfV7W5U6g3aYxXmlPoZVAwUMy9AOKyF2fVuZa2UD3qZjg578OrLRt8PcNN1PleVaL/5/yYATNL0ICUw==", + "dev": true, + "license": "ISC", + "dependencies": { + "@isaacs/fs-minipass": "^4.0.0", + "chownr": "^3.0.0", + "minipass": "^7.1.2", + "minizlib": "^3.0.1", + "mkdirp": "^3.0.1", + "yallist": "^5.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/@tailwindcss/oxide/node_modules/yallist": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-5.0.0.tgz", + "integrity": "sha512-YgvUTfwqyc7UXVMrB+SImsVYSmTS8X/tSrtdNZMImM+n7+QTriRXyXim0mBrTXNeqzVF0KWGgHPeiyViFFrNDw==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@tailwindcss/vite": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/vite/-/vite-4.1.7.tgz", + "integrity": "sha512-tYa2fO3zDe41I7WqijyVbRd8oWT0aEID1Eokz5hMT6wShLIHj3yvwj9XbfuloHP9glZ6H+aG2AN/+ZrxJ1Y5RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@tailwindcss/node": "4.1.7", + "@tailwindcss/oxide": "4.1.7", + "tailwindcss": "4.1.7" + }, + "peerDependencies": { + "vite": "^5.2.0 || ^6" + } + }, + "node_modules/@types/estree": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "19.1.4", + "resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.4.tgz", + "integrity": "sha512-EB1yiiYdvySuIITtD5lhW4yPyJ31RkJkkDw794LaQYrxCSaQV/47y5o1FMC4zF9ZyjUjzJMZwbovEnT5yHTW6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "csstype": "^3.0.2" + } + }, + "node_modules/@types/react-dom": { + "version": "19.1.5", + "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-19.1.5.tgz", + "integrity": "sha512-CMCjrWucUBZvohgZxkjd6S9h0nZxXjzus6yDfUb+xLxYM7VvjKNH1tQrE9GWLql1XoOP4/Ds3bwFqShHUYraGg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@types/react": "^19.0.0" + } + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.32.1.tgz", + "integrity": "sha512-6u6Plg9nP/J1GRpe/vcjjabo6Uc5YQPAMxsgQyGC/I0RuukiG1wIe3+Vtg3IrSCVJDmqK3j8adrtzXSENRtFgg==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.11.0", - "@typescript-eslint/type-utils": "8.11.0", - "@typescript-eslint/utils": "8.11.0", - "@typescript-eslint/visitor-keys": "8.11.0", + "@typescript-eslint/scope-manager": "8.32.1", + "@typescript-eslint/type-utils": "8.32.1", + "@typescript-eslint/utils": "8.32.1", + "@typescript-eslint/visitor-keys": "8.32.1", "graphemer": "^1.4.0", - "ignore": "^5.3.1", + "ignore": "^7.0.0", "natural-compare": "^1.4.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.1.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1175,25 +1793,31 @@ }, "peerDependencies": { "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/ignore": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.4.tgz", + "integrity": "sha512-gJzzk+PQNznz8ysRrC0aOkBNVRBDtE1n53IqyqEf3PXrYwomFs5q4pGMizBMJF+ykh03insJ27hB8gSrD2Hn8A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" } }, "node_modules/@typescript-eslint/parser": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.11.0.tgz", - "integrity": "sha512-lmt73NeHdy1Q/2ul295Qy3uninSqi6wQI18XwSpm8w0ZbQXUpjCAWP1Vlv/obudoBiIjJVjlztjQ+d/Md98Yxg==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.32.1.tgz", + "integrity": "sha512-LKMrmwCPoLhM45Z00O1ulb6jwyVr2kr3XJp+G+tSEZcbauNnScewcQwtJqXDhXeYPDEjZ8C1SjXm015CirEmGg==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.11.0", - "@typescript-eslint/types": "8.11.0", - "@typescript-eslint/typescript-estree": "8.11.0", - "@typescript-eslint/visitor-keys": "8.11.0", + "@typescript-eslint/scope-manager": "8.32.1", + "@typescript-eslint/types": "8.32.1", + "@typescript-eslint/typescript-estree": "8.32.1", + "@typescript-eslint/visitor-keys": "8.32.1", "debug": "^4.3.4" }, "engines": { @@ -1204,23 +1828,19 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.11.0.tgz", - "integrity": "sha512-Uholz7tWhXmA4r6epo+vaeV7yjdKy5QFCERMjs1kMVsLRKIrSdM6o21W2He9ftp5PP6aWOVpD5zvrvuHZC0bMQ==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.32.1.tgz", + "integrity": "sha512-7IsIaIDeZn7kffk7qXC3o6Z4UblZJKV3UBpkvRNpr5NSyLji7tvTcvmnMNYuYLyh26mN8W723xpo3i4MlD33vA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.11.0", - "@typescript-eslint/visitor-keys": "8.11.0" + "@typescript-eslint/types": "8.32.1", + "@typescript-eslint/visitor-keys": "8.32.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1231,16 +1851,16 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.11.0.tgz", - "integrity": "sha512-ItiMfJS6pQU0NIKAaybBKkuVzo6IdnAhPFZA/2Mba/uBjuPQPet/8+zh5GtLHwmuFRShZx+8lhIs7/QeDHflOg==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.32.1.tgz", + "integrity": "sha512-mv9YpQGA8iIsl5KyUPi+FGLm7+bA4fgXaeRcFKRDRwDMu4iwrSHeDPipwueNXhdIIZltwCJv+NkxftECbIZWfA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.11.0", - "@typescript-eslint/utils": "8.11.0", + "@typescript-eslint/typescript-estree": "8.32.1", + "@typescript-eslint/utils": "8.32.1", "debug": "^4.3.4", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.1.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1249,16 +1869,15 @@ "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/types": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.11.0.tgz", - "integrity": "sha512-tn6sNMHf6EBAYMvmPUaKaVeYvhUsrE6x+bXQTxjQRp360h1giATU0WvgeEys1spbvb5R+VpNOZ+XJmjD8wOUHw==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.32.1.tgz", + "integrity": "sha512-YmybwXUJcgGqgAp6bEsgpPXEg6dcCyPyCSr0CAAueacR/CCBi25G3V8gGQ2kRzQRBNol7VQknxMs9HvVa9Rvfg==", "dev": true, "license": "MIT", "engines": { @@ -1270,20 +1889,20 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.11.0.tgz", - "integrity": "sha512-yHC3s1z1RCHoCz5t06gf7jH24rr3vns08XXhfEqzYpd6Hll3z/3g23JRi0jM8A47UFKNc3u/y5KIMx8Ynbjohg==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.32.1.tgz", + "integrity": "sha512-Y3AP9EIfYwBb4kWGb+simvPaqQoT5oJuzzj9m0i6FCY6SPvlomY2Ei4UEMm7+FXtlNJbor80ximyslzaQF6xhg==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.11.0", - "@typescript-eslint/visitor-keys": "8.11.0", + "@typescript-eslint/types": "8.32.1", + "@typescript-eslint/visitor-keys": "8.32.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.1.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1291,11 +1910,9 @@ "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + }, + "peerDependencies": { + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { @@ -1324,17 +1941,30 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { + "version": "7.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", + "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@typescript-eslint/utils": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.11.0.tgz", - "integrity": "sha512-CYiX6WZcbXNJV7UNB4PLDIBtSdRmRI/nb0FMyqHPTQD1rMjA0foPLaPUV39C/MxkTd/QKSeX+Gb34PPsDVC35g==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.32.1.tgz", + "integrity": "sha512-DsSFNIgLSrc89gpq1LJB7Hm1YpuhK086DRDJSNrewcGvYloWW1vZLHBTIvarKZDcAORIy/uWNx8Gad+4oMpkSA==", "dev": true, "license": "MIT", "dependencies": { - "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.11.0", - "@typescript-eslint/types": "8.11.0", - "@typescript-eslint/typescript-estree": "8.11.0" + "@eslint-community/eslint-utils": "^4.7.0", + "@typescript-eslint/scope-manager": "8.32.1", + "@typescript-eslint/types": "8.32.1", + "@typescript-eslint/typescript-estree": "8.32.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1344,18 +1974,19 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.11.0.tgz", - "integrity": "sha512-EaewX6lxSjRJnc+99+dqzTeoDZUfyrA52d2/HRrkI830kgovWsmIiTfmr0NZorzqic7ga+1bS60lRBUgR3n/Bw==", + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.32.1.tgz", + "integrity": "sha512-ar0tjQfObzhSaW3C3QNmTc5ofj0hDoNQ5XWrCy6zDyabdr0TWhCkClp+rywGNj/odAFBVzzJrK4tEq5M4Hmu4w==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.11.0", - "eslint-visitor-keys": "^3.4.3" + "@typescript-eslint/types": "8.32.1", + "eslint-visitor-keys": "^4.2.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1365,30 +1996,25 @@ "url": "https://opencollective.com/typescript-eslint" } }, - "node_modules/@ungap/structured-clone": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", - "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", - "dev": true - }, "node_modules/@vitejs/plugin-react-swc": { - "version": "3.7.1", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-react-swc/-/plugin-react-swc-3.7.1.tgz", - "integrity": "sha512-vgWOY0i1EROUK0Ctg1hwhtC3SdcDjZcdit4Ups4aPkDcB1jYhmo+RMYWY87cmXMhvtD5uf8lV89j2w16vkdSVg==", + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-react-swc/-/plugin-react-swc-3.9.0.tgz", + "integrity": "sha512-jYFUSXhwMCYsh/aQTgSGLIN3Foz5wMbH9ahb0Zva//UzwZYbMiZd7oT3AU9jHT9DLswYDswsRwPU9jVF3yA48Q==", "dev": true, "license": "MIT", "dependencies": { - "@swc/core": "^1.7.26" + "@swc/core": "^1.11.21" }, "peerDependencies": { - "vite": "^4 || ^5" + "vite": "^4 || ^5 || ^6" } }, "node_modules/acorn": { - "version": "8.11.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", - "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "version": "8.14.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", + "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", "dev": true, + "license": "MIT", "bin": { "acorn": "bin/acorn" }, @@ -1401,6 +2027,7 @@ "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", "dev": true, + "license": "MIT", "peerDependencies": { "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } @@ -1410,6 +2037,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -1421,20 +2049,12 @@ "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", "dev": true, + "license": "MIT", "dependencies": { "color-convert": "^2.0.1" }, @@ -1445,17 +2065,12 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/any-promise": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/any-promise/-/any-promise-1.3.0.tgz", - "integrity": "sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A==", - "dev": true - }, "node_modules/anymatch": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", "dev": true, + "license": "ISC", "dependencies": { "normalize-path": "^3.0.0", "picomatch": "^2.0.4" @@ -1464,26 +2079,22 @@ "node": ">= 8" } }, - "node_modules/arg": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", - "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", - "dev": true - }, "node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true + "dev": true, + "license": "Python-2.0" }, "node_modules/array-buffer-byte-length": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", - "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", + "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.5", - "is-array-buffer": "^3.0.4" + "call-bound": "^1.0.3", + "is-array-buffer": "^3.0.5" }, "engines": { "node": ">= 0.4" @@ -1497,6 +2108,7 @@ "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -1517,6 +2129,7 @@ "resolved": "https://registry.npmjs.org/array.prototype.findlast/-/array.prototype.findlast-1.2.5.tgz", "integrity": "sha512-CVvd6FHg1Z3POpBLxO6E6zr+rSKEQ9L6rZHAaY7lLfhKsWYUBBOuMs0e9o24oopj6H+geRCX0YJ+TJLBK2eHyQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -1533,17 +2146,19 @@ } }, "node_modules/array.prototype.findlastindex": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", - "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.6.tgz", + "integrity": "sha512-F/TKATkzseUExPlfvmwQKGITM3DGTK+vkAsCZoDc5daVygbJBnjEUCbgkAvVFsgfXfX4YIqZ/27G3k3tdXrTxQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.2", + "es-abstract": "^1.23.9", "es-errors": "^1.3.0", - "es-object-atoms": "^1.0.0", - "es-shim-unscopables": "^1.0.2" + "es-object-atoms": "^1.1.1", + "es-shim-unscopables": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -1553,15 +2168,16 @@ } }, "node_modules/array.prototype.flat": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", - "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.3.tgz", + "integrity": "sha512-rwG/ja1neyLqCuGZ5YYrznA62D4mZXg0i1cIskIUKSiqF3Cje9/wXAls9B9s1Wa2fomMsIv8czB8jZcPmxCXFg==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "es-shim-unscopables": "^1.0.0" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.5", + "es-shim-unscopables": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -1571,15 +2187,16 @@ } }, "node_modules/array.prototype.flatmap": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", - "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.3.tgz", + "integrity": "sha512-Y7Wt51eKJSyi80hFrJCePGGNo5ktJCslFuboqJsbf57CCPcm5zztluPlc4/aD8sWsKvlwatezpV4U1efk8kpjg==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "es-shim-unscopables": "^1.0.0" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.5", + "es-shim-unscopables": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -1606,19 +2223,19 @@ } }, "node_modules/arraybuffer.prototype.slice": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", - "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.4.tgz", + "integrity": "sha512-BNoCY6SXXPQ7gF2opIP4GBE+Xw7U+pHMYKuzjgCN3GwiaIR09UUeKfheyIry77QtrCBlC0KK0q5/TER/tYh3PQ==", "dev": true, + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.1", - "call-bind": "^1.0.5", + "call-bind": "^1.0.8", "define-properties": "^1.2.1", - "es-abstract": "^1.22.3", - "es-errors": "^1.2.1", - "get-intrinsic": "^1.2.3", - "is-array-buffer": "^3.0.4", - "is-shared-array-buffer": "^1.0.2" + "es-abstract": "^1.23.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.6", + "is-array-buffer": "^3.0.4" }, "engines": { "node": ">= 0.4" @@ -1627,42 +2244,14 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/autoprefixer": { - "version": "10.4.20", - "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.20.tgz", - "integrity": "sha512-XY25y5xSv/wEoqzDyXXME4AFfkZI0P23z6Fs3YgymDnKJkCGOnkL0iTxCa85UTqaSgfcqyf3UA6+c7wUvx/16g==", + "node_modules/async-function": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/async-function/-/async-function-1.0.0.tgz", + "integrity": "sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA==", "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/autoprefixer" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], "license": "MIT", - "dependencies": { - "browserslist": "^4.23.3", - "caniuse-lite": "^1.0.30001646", - "fraction.js": "^4.3.7", - "normalize-range": "^0.1.2", - "picocolors": "^1.0.1", - "postcss-value-parser": "^4.2.0" - }, - "bin": { - "autoprefixer": "bin/autoprefixer" - }, "engines": { - "node": "^10 || ^12 || >=14" - }, - "peerDependencies": { - "postcss": "^8.1.0" + "node": ">= 0.4" } }, "node_modules/available-typed-arrays": { @@ -1670,6 +2259,7 @@ "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", "dev": true, + "license": "MIT", "dependencies": { "possible-typed-array-names": "^1.0.0" }, @@ -1680,19 +2270,49 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/axios": { + "version": "0.26.1", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", + "integrity": "sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA==", + "dev": true, + "license": "MIT", + "dependencies": { + "follow-redirects": "^1.14.8" + } + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/binary-extensions": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.2.0.tgz", - "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/binary-install": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/binary-install/-/binary-install-1.1.0.tgz", + "integrity": "sha512-rkwNGW+3aQVSZoD0/o3mfPN6Yxh3Id0R/xzTVBVVpGNlVz8EGwusksxRlbk/A5iKTZt9zkMn3qIqmAt3vpfbzg==", + "dev": true, + "license": "MIT", + "dependencies": { + "axios": "^0.26.1", + "rimraf": "^3.0.2", + "tar": "^6.1.11" + }, + "engines": { + "node": ">=10" } }, "node_modules/brace-expansion": { @@ -1700,67 +2320,67 @@ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, + "license": "MIT", "dependencies": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" }, "engines": { "node": ">=8" } }, - "node_modules/browserslist": { - "version": "4.23.3", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", - "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], "license": "MIT", "dependencies": { - "caniuse-lite": "^1.0.30001646", - "electron-to-chromium": "^1.5.4", - "node-releases": "^2.0.18", - "update-browserslist-db": "^1.1.0" - }, - "bin": { - "browserslist": "cli.js" + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" }, "engines": { - "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/call-bind": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", - "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", "dev": true, + "license": "MIT", "dependencies": { - "es-define-property": "^1.0.0", "es-errors": "^1.3.0", - "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.4", - "set-function-length": "^1.2.1" + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" }, "engines": { "node": ">= 0.4" @@ -1774,45 +2394,17 @@ "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } }, - "node_modules/camelcase-css": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/camelcase-css/-/camelcase-css-2.0.1.tgz", - "integrity": "sha512-QOSvevhslijgYwRx6Rv7zKdMF8lbRmx+uQGx2+vDc+KI/eBnsy9kit5aj23AgGu3pa4t9AgwbnXWqS+iOY+2aA==", - "dev": true, - "engines": { - "node": ">= 6" - } - }, - "node_modules/caniuse-lite": { - "version": "1.0.30001647", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001647.tgz", - "integrity": "sha512-n83xdNiyeNcHpzWY+1aFbqCK7LuLfBricc4+alSQL2Xb6OR3XpnQAmlDG+pQcdTfiHRuLcQ96VOfrPSGiNJYSg==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/caniuse-lite" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "CC-BY-4.0" - }, "node_modules/chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, + "license": "MIT", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -1825,16 +2417,11 @@ } }, "node_modules/chokidar": { - "version": "3.5.3", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", - "integrity": "sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==", + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://paulmillr.com/funding/" - } - ], + "license": "MIT", "dependencies": { "anymatch": "~3.1.2", "braces": "~3.0.2", @@ -1847,6 +2434,9 @@ "engines": { "node": ">= 8.10.0" }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, "optionalDependencies": { "fsevents": "~2.3.2" } @@ -1856,6 +2446,7 @@ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -1863,16 +2454,28 @@ "node": ">= 6" } }, + "node_modules/chownr": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", + "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, "node_modules/classnames": { "version": "2.5.1", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz", - "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==" + "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==", + "license": "MIT" }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", "dev": true, + "license": "MIT", "dependencies": { "color-name": "~1.1.4" }, @@ -1884,28 +2487,22 @@ "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true - }, - "node_modules/commander": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz", - "integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==", "dev": true, - "engines": { - "node": ">= 6" - } + "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, + "license": "MIT", "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -1915,33 +2512,23 @@ "node": ">= 8" } }, - "node_modules/cssesc": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", - "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", - "dev": true, - "bin": { - "cssesc": "bin/cssesc" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/csstype": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.2.tgz", - "integrity": "sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ==", - "dev": true + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", + "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", + "dev": true, + "license": "MIT" }, "node_modules/data-view-buffer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", - "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.2.tgz", + "integrity": "sha512-EmKO5V3OLXh1rtK2wgXRansaK1/mtVdTUEiEI0W8RkvgT05kfxaH29PliLnpLP73yYO6142Q72QNa8Wx/A5CqQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.6", + "call-bound": "^1.0.3", "es-errors": "^1.3.0", - "is-data-view": "^1.0.1" + "is-data-view": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -1951,29 +2538,31 @@ } }, "node_modules/data-view-byte-length": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", - "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.2.tgz", + "integrity": "sha512-tuhGbE6CfTM9+5ANGf+oQb72Ky/0+s3xKUpHvShfiz2RxMFgFPjsXuRLBVMtvMs15awe45SRb83D6wH4ew6wlQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bound": "^1.0.3", "es-errors": "^1.3.0", - "is-data-view": "^1.0.1" + "is-data-view": "^1.0.2" }, "engines": { "node": ">= 0.4" }, "funding": { - "url": "https://github.com/sponsors/ljharb" + "url": "https://github.com/sponsors/inspect-js" } }, "node_modules/data-view-byte-offset": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", - "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.1.tgz", + "integrity": "sha512-BS8PfmtDGnrgYdOonGZQdLZslWIeCGFP9tpan0hi1Co2Zr2NKADsvGYA8XxuG/4UWgJ6Cjtv+YJnB6MM69QGlQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.6", + "call-bound": "^1.0.2", "es-errors": "^1.3.0", "is-data-view": "^1.0.1" }, @@ -1985,12 +2574,13 @@ } }, "node_modules/debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "dev": true, + "license": "MIT", "dependencies": { - "ms": "2.1.2" + "ms": "^2.1.3" }, "engines": { "node": ">=6.0" @@ -2005,13 +2595,15 @@ "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/define-data-property": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", "dev": true, + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", @@ -2029,6 +2621,7 @@ "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", "dev": true, + "license": "MIT", "dependencies": { "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", @@ -2041,90 +2634,116 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/didyoumean": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/didyoumean/-/didyoumean-1.2.2.tgz", - "integrity": "sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw==", - "dev": true - }, - "node_modules/dlv": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/dlv/-/dlv-1.1.3.tgz", - "integrity": "sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==", - "dev": true + "node_modules/detect-libc": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.4.tgz", + "integrity": "sha512-3UDv+G9CsCKO1WKMGw9fwq/SWJYbI0c5Y7LU1AXYoDdbhE2AHQ6N6Nb34sG8Fj7T5APy8qXDCKuuIHd1BR0tVA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=8" + } }, "node_modules/doctrine": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", - "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", "dev": true, + "license": "Apache-2.0", "dependencies": { "esutils": "^2.0.2" }, "engines": { - "node": ">=6.0.0" + "node": ">=0.10.0" } }, - "node_modules/electron-to-chromium": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.4.tgz", - "integrity": "sha512-orzA81VqLyIGUEA77YkVA1D+N+nNfl2isJVjjmOyrlxuooZ19ynb+dOlaDTqd/idKRS9lDCSBmtzM+kyCsMnkA==", + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", "dev": true, - "license": "ISC" + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/enhanced-resolve": { + "version": "5.18.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.18.1.tgz", + "integrity": "sha512-ZSW3ma5GkcQBIpwZTSRAI8N71Uuwgs93IezB7mf7R60tC8ZbJideoDNKjHn2O9KIlx6rkGTTEk1xUCK2E1Y2Yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.2.0" + }, + "engines": { + "node": ">=10.13.0" + } }, "node_modules/es-abstract": { - "version": "1.23.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", - "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "version": "1.23.9", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.9.tgz", + "integrity": "sha512-py07lI0wjxAC/DcfK1S6G7iANonniZwTISvdPzk9hzeH0IZIshbuuFxLIU96OyF89Yb9hiqWn8M/bY83KY5vzA==", "dev": true, "license": "MIT", "dependencies": { - "array-buffer-byte-length": "^1.0.1", - "arraybuffer.prototype.slice": "^1.0.3", + "array-buffer-byte-length": "^1.0.2", + "arraybuffer.prototype.slice": "^1.0.4", "available-typed-arrays": "^1.0.7", - "call-bind": "^1.0.7", - "data-view-buffer": "^1.0.1", - "data-view-byte-length": "^1.0.1", - "data-view-byte-offset": "^1.0.0", - "es-define-property": "^1.0.0", + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "data-view-buffer": "^1.0.2", + "data-view-byte-length": "^1.0.2", + "data-view-byte-offset": "^1.0.1", + "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", - "es-set-tostringtag": "^2.0.3", - "es-to-primitive": "^1.2.1", - "function.prototype.name": "^1.1.6", - "get-intrinsic": "^1.2.4", - "get-symbol-description": "^1.0.2", - "globalthis": "^1.0.3", - "gopd": "^1.0.1", + "es-set-tostringtag": "^2.1.0", + "es-to-primitive": "^1.3.0", + "function.prototype.name": "^1.1.8", + "get-intrinsic": "^1.2.7", + "get-proto": "^1.0.0", + "get-symbol-description": "^1.1.0", + "globalthis": "^1.0.4", + "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", - "has-proto": "^1.0.3", - "has-symbols": "^1.0.3", + "has-proto": "^1.2.0", + "has-symbols": "^1.1.0", "hasown": "^2.0.2", - "internal-slot": "^1.0.7", - "is-array-buffer": "^3.0.4", + "internal-slot": "^1.1.0", + "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", - "is-data-view": "^1.0.1", - "is-negative-zero": "^2.0.3", - "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.3", - "is-string": "^1.0.7", - "is-typed-array": "^1.1.13", - "is-weakref": "^1.0.2", - "object-inspect": "^1.13.1", + "is-data-view": "^1.0.2", + "is-regex": "^1.2.1", + "is-shared-array-buffer": "^1.0.4", + "is-string": "^1.1.1", + "is-typed-array": "^1.1.15", + "is-weakref": "^1.1.0", + "math-intrinsics": "^1.1.0", + "object-inspect": "^1.13.3", "object-keys": "^1.1.1", - "object.assign": "^4.1.5", - "regexp.prototype.flags": "^1.5.2", - "safe-array-concat": "^1.1.2", - "safe-regex-test": "^1.0.3", - "string.prototype.trim": "^1.2.9", - "string.prototype.trimend": "^1.0.8", + "object.assign": "^4.1.7", + "own-keys": "^1.0.1", + "regexp.prototype.flags": "^1.5.3", + "safe-array-concat": "^1.1.3", + "safe-push-apply": "^1.0.0", + "safe-regex-test": "^1.1.0", + "set-proto": "^1.0.0", + "string.prototype.trim": "^1.2.10", + "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", - "typed-array-buffer": "^1.0.2", - "typed-array-byte-length": "^1.0.1", - "typed-array-byte-offset": "^1.0.2", - "typed-array-length": "^1.0.6", - "unbox-primitive": "^1.0.2", - "which-typed-array": "^1.1.15" + "typed-array-buffer": "^1.0.3", + "typed-array-byte-length": "^1.0.3", + "typed-array-byte-offset": "^1.0.4", + "typed-array-length": "^1.0.7", + "unbox-primitive": "^1.1.0", + "which-typed-array": "^1.1.18" }, "engines": { "node": ">= 0.4" @@ -2134,13 +2753,11 @@ } }, "node_modules/es-define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", - "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", "dev": true, - "dependencies": { - "get-intrinsic": "^1.2.4" - }, + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -2150,41 +2767,45 @@ "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/es-iterator-helpers": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.1.0.tgz", - "integrity": "sha512-/SurEfycdyssORP/E+bj4sEu1CWw4EmLDsHynHwSXQ7utgbrMRWW195pTrCjFgFCddf/UkYm3oqKPRq5i8bJbw==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.2.1.tgz", + "integrity": "sha512-uDn+FE1yrDzyC0pCo961B2IHbdM8y/ACZsKD4dG6WqrjV53BADjwa7D+1aom2rsNVfLyDgU/eigvlJGJ08OQ4w==", "dev": true, "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", "define-properties": "^1.2.1", - "es-abstract": "^1.23.3", + "es-abstract": "^1.23.6", "es-errors": "^1.3.0", "es-set-tostringtag": "^2.0.3", "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.4", + "get-intrinsic": "^1.2.6", "globalthis": "^1.0.4", + "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", - "has-proto": "^1.0.3", - "has-symbols": "^1.0.3", - "internal-slot": "^1.0.7", - "iterator.prototype": "^1.1.3", - "safe-array-concat": "^1.1.2" + "has-proto": "^1.2.0", + "has-symbols": "^1.1.0", + "internal-slot": "^1.1.0", + "iterator.prototype": "^1.1.4", + "safe-array-concat": "^1.1.3" }, "engines": { "node": ">= 0.4" } }, "node_modules/es-object-atoms": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", - "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", "dev": true, + "license": "MIT", "dependencies": { "es-errors": "^1.3.0" }, @@ -2193,37 +2814,44 @@ } }, "node_modules/es-set-tostringtag": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", - "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", + "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", "dev": true, + "license": "MIT", "dependencies": { - "get-intrinsic": "^1.2.4", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.6", "has-tostringtag": "^1.0.2", - "hasown": "^2.0.1" + "hasown": "^2.0.2" }, "engines": { "node": ">= 0.4" } }, "node_modules/es-shim-unscopables": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", - "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.1.0.tgz", + "integrity": "sha512-d9T8ucsEhh8Bi1woXCf+TIKDIROLG5WCkxg8geBCbvk22kzwC5G2OnXVMO6FUsvQlgUUXQ2itephWDLqDzbeCw==", "dev": true, + "license": "MIT", "dependencies": { - "hasown": "^2.0.0" + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" } }, "node_modules/es-to-primitive": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", - "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.3.0.tgz", + "integrity": "sha512-w+5mJ3GuFL+NjVtJlvydShqE1eN3h3PbI7/5LAsYJP/2qtuMXjfL2LpHSRqo4b4eSF5K/DH1JXKUAHSB2UW50g==", "dev": true, + "license": "MIT", "dependencies": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" + "is-callable": "^1.2.7", + "is-date-object": "^1.0.5", + "is-symbol": "^1.0.4" }, "engines": { "node": ">= 0.4" @@ -2233,9 +2861,9 @@ } }, "node_modules/esbuild": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", - "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.1.tgz", + "integrity": "sha512-BGO5LtrGC7vxnqucAe/rmvKdJllfGaYWdyABvyMoXQlfYMb2bbRuReWR5tEGE//4LcNJj9XrkovTqNYRFZHAMQ==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -2243,42 +2871,34 @@ "esbuild": "bin/esbuild" }, "engines": { - "node": ">=12" + "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.21.5", - "@esbuild/android-arm": "0.21.5", - "@esbuild/android-arm64": "0.21.5", - "@esbuild/android-x64": "0.21.5", - "@esbuild/darwin-arm64": "0.21.5", - "@esbuild/darwin-x64": "0.21.5", - "@esbuild/freebsd-arm64": "0.21.5", - "@esbuild/freebsd-x64": "0.21.5", - "@esbuild/linux-arm": "0.21.5", - "@esbuild/linux-arm64": "0.21.5", - "@esbuild/linux-ia32": "0.21.5", - "@esbuild/linux-loong64": "0.21.5", - "@esbuild/linux-mips64el": "0.21.5", - "@esbuild/linux-ppc64": "0.21.5", - "@esbuild/linux-riscv64": "0.21.5", - "@esbuild/linux-s390x": "0.21.5", - "@esbuild/linux-x64": "0.21.5", - "@esbuild/netbsd-x64": "0.21.5", - "@esbuild/openbsd-x64": "0.21.5", - "@esbuild/sunos-x64": "0.21.5", - "@esbuild/win32-arm64": "0.21.5", - "@esbuild/win32-ia32": "0.21.5", - "@esbuild/win32-x64": "0.21.5" - } - }, - "node_modules/escalade": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz", - "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" + "@esbuild/aix-ppc64": "0.25.1", + "@esbuild/android-arm": "0.25.1", + "@esbuild/android-arm64": "0.25.1", + "@esbuild/android-x64": "0.25.1", + "@esbuild/darwin-arm64": "0.25.1", + "@esbuild/darwin-x64": "0.25.1", + "@esbuild/freebsd-arm64": "0.25.1", + "@esbuild/freebsd-x64": "0.25.1", + "@esbuild/linux-arm": "0.25.1", + "@esbuild/linux-arm64": "0.25.1", + "@esbuild/linux-ia32": "0.25.1", + "@esbuild/linux-loong64": "0.25.1", + "@esbuild/linux-mips64el": "0.25.1", + "@esbuild/linux-ppc64": "0.25.1", + "@esbuild/linux-riscv64": "0.25.1", + "@esbuild/linux-s390x": "0.25.1", + "@esbuild/linux-x64": "0.25.1", + "@esbuild/netbsd-arm64": "0.25.1", + "@esbuild/netbsd-x64": "0.25.1", + "@esbuild/openbsd-arm64": "0.25.1", + "@esbuild/openbsd-x64": "0.25.1", + "@esbuild/sunos-x64": "0.25.1", + "@esbuild/win32-arm64": "0.25.1", + "@esbuild/win32-ia32": "0.25.1", + "@esbuild/win32-x64": "0.25.1" } }, "node_modules/escape-string-regexp": { @@ -2286,6 +2906,7 @@ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -2294,71 +2915,64 @@ } }, "node_modules/eslint": { - "version": "8.57.1", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.1.tgz", - "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", + "version": "9.27.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.27.0.tgz", + "integrity": "sha512-ixRawFQuMB9DZ7fjU3iGGganFDp3+45bPOdaRurcFHSXO1e/sYwUX/FtQZpLZJR6SjMoJH8hR2pPEAfDyCoU2Q==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", - "@eslint-community/regexpp": "^4.6.1", - "@eslint/eslintrc": "^2.1.4", - "@eslint/js": "8.57.1", - "@humanwhocodes/config-array": "^0.13.0", + "@eslint-community/regexpp": "^4.12.1", + "@eslint/config-array": "^0.20.0", + "@eslint/config-helpers": "^0.2.1", + "@eslint/core": "^0.14.0", + "@eslint/eslintrc": "^3.3.1", + "@eslint/js": "9.27.0", + "@eslint/plugin-kit": "^0.3.1", + "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", - "@nodelib/fs.walk": "^1.2.8", - "@ungap/structured-clone": "^1.2.0", + "@humanwhocodes/retry": "^0.4.2", + "@types/estree": "^1.0.6", + "@types/json-schema": "^7.0.15", "ajv": "^6.12.4", "chalk": "^4.0.0", - "cross-spawn": "^7.0.2", + "cross-spawn": "^7.0.6", "debug": "^4.3.2", - "doctrine": "^3.0.0", "escape-string-regexp": "^4.0.0", - "eslint-scope": "^7.2.2", - "eslint-visitor-keys": "^3.4.3", - "espree": "^9.6.1", - "esquery": "^1.4.2", + "eslint-scope": "^8.3.0", + "eslint-visitor-keys": "^4.2.0", + "espree": "^10.3.0", + "esquery": "^1.5.0", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", - "file-entry-cache": "^6.0.1", + "file-entry-cache": "^8.0.0", "find-up": "^5.0.0", "glob-parent": "^6.0.2", - "globals": "^13.19.0", - "graphemer": "^1.4.0", "ignore": "^5.2.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", - "is-path-inside": "^3.0.3", - "js-yaml": "^4.1.0", "json-stable-stringify-without-jsonify": "^1.0.1", - "levn": "^0.4.1", "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", - "optionator": "^0.9.3", - "strip-ansi": "^6.0.1", - "text-table": "^0.2.0" + "optionator": "^0.9.3" }, "bin": { "eslint": "bin/eslint.js" }, "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint-config-prettier": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-9.1.0.tgz", - "integrity": "sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw==", - "dev": true, - "bin": { - "eslint-config-prettier": "bin/cli.js" + "url": "https://eslint.org/donate" }, "peerDependencies": { - "eslint": ">=7.0.0" + "jiti": "*" + }, + "peerDependenciesMeta": { + "jiti": { + "optional": true + } } }, "node_modules/eslint-import-resolver-node": { @@ -2366,6 +2980,7 @@ "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", "dev": true, + "license": "MIT", "dependencies": { "debug": "^3.2.7", "is-core-module": "^2.13.0", @@ -2377,27 +2992,11 @@ "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", "dev": true, + "license": "MIT", "dependencies": { "ms": "^2.1.1" } }, - "node_modules/eslint-import-resolver-node/node_modules/resolve": { - "version": "1.22.8", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", - "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", - "dev": true, - "dependencies": { - "is-core-module": "^2.13.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, - "bin": { - "resolve": "bin/resolve" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/eslint-module-utils": { "version": "2.12.0", "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz", @@ -2421,6 +3020,7 @@ "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", "dev": true, + "license": "MIT", "dependencies": { "ms": "^2.1.1" } @@ -2469,53 +3069,30 @@ "ms": "^2.1.1" } }, - "node_modules/eslint-plugin-import/node_modules/doctrine": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", - "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "esutils": "^2.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eslint-plugin-import/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/eslint-plugin-react": { - "version": "7.37.2", - "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.2.tgz", - "integrity": "sha512-EsTAnj9fLVr/GZleBLFbj/sSuXeWmp1eXIN60ceYnZveqEaUCyW4X+Vh4WTdUhCkW4xutXYqTXCUSyqD4rB75w==", + "version": "7.37.5", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.5.tgz", + "integrity": "sha512-Qteup0SqU15kdocexFNAJMvCJEfa2xUKNV4CC1xsVMrIIqEy3SQ/rqyxCWNzfrd3/ldy6HMlD2e0JDVpDg2qIA==", "dev": true, "license": "MIT", "dependencies": { "array-includes": "^3.1.8", "array.prototype.findlast": "^1.2.5", - "array.prototype.flatmap": "^1.3.2", + "array.prototype.flatmap": "^1.3.3", "array.prototype.tosorted": "^1.1.4", "doctrine": "^2.1.0", - "es-iterator-helpers": "^1.1.0", + "es-iterator-helpers": "^1.2.1", "estraverse": "^5.3.0", "hasown": "^2.0.2", "jsx-ast-utils": "^2.4.1 || ^3.0.0", "minimatch": "^3.1.2", - "object.entries": "^1.1.8", + "object.entries": "^1.1.9", "object.fromentries": "^2.0.8", - "object.values": "^1.2.0", + "object.values": "^1.2.1", "prop-types": "^15.8.1", "resolve": "^2.0.0-next.5", "semver": "^6.3.1", - "string.prototype.matchall": "^4.0.11", + "string.prototype.matchall": "^4.0.12", "string.prototype.repeat": "^1.0.0" }, "engines": { @@ -2526,9 +3103,9 @@ } }, "node_modules/eslint-plugin-react-hooks": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-5.0.0.tgz", - "integrity": "sha512-hIOwI+5hYGpJEc4uPRmz2ulCjAGD/N13Lukkh8cLV0i2IRk/bdZDYjgLVHj+U9Z704kLIdIO6iueGvxNur0sgw==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-5.2.0.tgz", + "integrity": "sha512-+f15FfK64YQwZdJNELETdn5ibXEUQmW1DZL6KXhNnc2heoy/sg9VJJeT7n8TlMWouzWqSWavFkIhHyIbIAEapg==", "dev": true, "license": "MIT", "engines": { @@ -2538,19 +3115,6 @@ "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0 || ^9.0.0" } }, - "node_modules/eslint-plugin-react/node_modules/doctrine": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", - "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "esutils": "^2.0.2" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/eslint-plugin-react/node_modules/resolve": { "version": "2.0.0-next.5", "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", @@ -2569,66 +3133,60 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/eslint-plugin-react/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/eslint-scope": { - "version": "7.2.2", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", - "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.3.0.tgz", + "integrity": "sha512-pUNxi75F8MJ/GdeKtVLSbYg4ZI34J6C0C7sbL4YOp2exGwen7ZsuBqKzUhXd0qMQ362yET3z+uPwKeg/0C2XCQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" }, "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "url": "https://opencollective.com/eslint" } }, "node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", + "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", "dev": true, + "license": "Apache-2.0", "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "url": "https://opencollective.com/eslint" } }, "node_modules/espree": { - "version": "9.6.1", - "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", - "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-10.3.0.tgz", + "integrity": "sha512-0QYC8b24HWY8zjRnDTL6RiHfDbAWn63qb4LMj1Z4b076A4une81+z03Kg7l7mn/48PUTqoLptSXez8oknU8Clg==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { - "acorn": "^8.9.0", + "acorn": "^8.14.0", "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^3.4.1" + "eslint-visitor-keys": "^4.2.0" }, "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "url": "https://opencollective.com/eslint" } }, "node_modules/esquery": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.5.0.tgz", - "integrity": "sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", + "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "estraverse": "^5.1.0" }, @@ -2641,6 +3199,7 @@ "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "estraverse": "^5.2.0" }, @@ -2653,6 +3212,7 @@ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=4.0" } @@ -2662,6 +3222,7 @@ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=0.10.0" } @@ -2670,12 +3231,13 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", "dev": true, "license": "MIT", "dependencies": { @@ -2683,7 +3245,7 @@ "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", - "micromatch": "^4.0.4" + "micromatch": "^4.0.8" }, "engines": { "node": ">=8.6.0" @@ -2694,6 +3256,7 @@ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -2705,40 +3268,45 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/fast-levenshtein": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/fastq": { - "version": "1.15.0", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz", - "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==", + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", + "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", "dev": true, + "license": "ISC", "dependencies": { "reusify": "^1.0.4" } }, "node_modules/file-entry-cache": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", - "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", + "integrity": "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==", "dev": true, + "license": "MIT", "dependencies": { - "flat-cache": "^3.0.4" + "flat-cache": "^4.0.0" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": ">=16.0.0" } }, "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dev": true, + "license": "MIT", "dependencies": { "to-regex-range": "^5.0.1" }, @@ -2751,6 +3319,7 @@ "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, + "license": "MIT", "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" @@ -2763,52 +3332,110 @@ } }, "node_modules/flat-cache": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", - "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", + "integrity": "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==", "dev": true, + "license": "MIT", "dependencies": { "flatted": "^3.2.9", - "keyv": "^4.5.3", - "rimraf": "^3.0.2" + "keyv": "^4.5.4" }, "engines": { - "node": "^10.12.0 || >=12.0.0" + "node": ">=16" } }, "node_modules/flatted": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.1.tgz", - "integrity": "sha512-X8cqMLLie7KsNUDSdzeN8FYK9rEt4Dt67OsG/DNGnYTSDBG4uFAJFBnUeiV+zCVAvwFy56IjM9sH51jVaEhNxw==", - "dev": true + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", + "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", + "dev": true, + "license": "ISC" + }, + "node_modules/follow-redirects": { + "version": "1.15.9", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz", + "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } }, "node_modules/for-each": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", - "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", "dev": true, + "license": "MIT", "dependencies": { - "is-callable": "^1.1.3" + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/fraction.js": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-4.3.7.tgz", - "integrity": "sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew==", + "node_modules/fs-extra": { + "version": "11.3.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.0.tgz", + "integrity": "sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew==", "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, "engines": { - "node": "*" + "node": ">=14.14" + } + }, + "node_modules/fs-minipass": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", + "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", + "dev": true, + "license": "ISC", + "dependencies": { + "minipass": "^3.0.0" }, - "funding": { - "type": "patreon", - "url": "https://github.com/sponsors/rawify" + "engines": { + "node": ">= 8" + } + }, + "node_modules/fs-minipass/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" } }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/fsevents": { "version": "2.3.3", @@ -2816,6 +3443,7 @@ "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", "dev": true, "hasInstallScript": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -2829,20 +3457,24 @@ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", "dev": true, + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/function.prototype.name": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", - "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "version": "1.1.8", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.8.tgz", + "integrity": "sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "functions-have-names": "^1.2.3" + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "functions-have-names": "^1.2.3", + "hasown": "^2.0.2", + "is-callable": "^1.2.7" }, "engines": { "node": ">= 0.4" @@ -2856,21 +3488,28 @@ "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", "dev": true, + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/get-intrinsic": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", - "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", "dev": true, + "license": "MIT", "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", "function-bind": "^1.1.2", - "has-proto": "^1.0.1", - "has-symbols": "^1.0.3", - "hasown": "^2.0.0" + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -2879,15 +3518,30 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/get-symbol-description": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", - "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.1.0.tgz", + "integrity": "sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.5", + "call-bound": "^1.0.3", "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.4" + "get-intrinsic": "^1.2.6" }, "engines": { "node": ">= 0.4" @@ -2900,7 +3554,9 @@ "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, + "license": "ISC", "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -2921,6 +3577,7 @@ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.3" }, @@ -2929,15 +3586,13 @@ } }, "node_modules/globals": { - "version": "13.24.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", - "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", + "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, + "license": "MIT", "engines": { - "node": ">=8" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -2961,28 +3616,41 @@ } }, "node_modules/gopd": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", - "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", "dev": true, - "dependencies": { - "get-intrinsic": "^1.1.3" + "license": "MIT", + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, "node_modules/graphemer": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/has-bigints": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", - "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", + "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -2992,6 +3660,7 @@ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -3001,6 +3670,7 @@ "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", "dev": true, + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0" }, @@ -3009,10 +3679,14 @@ } }, "node_modules/has-proto": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", - "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.2.0.tgz", + "integrity": "sha512-KIL7eQPfHQRC8+XluaIw7BHUwwqL19bQn4hzNgdr+1wXoU0KKj6rufu47lhY7KbJR2C6T6+PfyN0Ea7wkSS+qQ==", "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -3021,10 +3695,11 @@ } }, "node_modules/has-symbols": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", - "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -3037,6 +3712,7 @@ "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "dev": true, + "license": "MIT", "dependencies": { "has-symbols": "^1.0.3" }, @@ -3052,6 +3728,7 @@ "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", "dev": true, + "license": "MIT", "dependencies": { "function-bind": "^1.1.2" }, @@ -3060,19 +3737,21 @@ } }, "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 4" } }, "node_modules/import-fresh": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", - "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", + "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", "dev": true, + "license": "MIT", "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" @@ -3089,6 +3768,7 @@ "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.8.19" } @@ -3097,7 +3777,9 @@ "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", "dev": true, + "license": "ISC", "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -3107,30 +3789,34 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/internal-slot": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", - "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", "dev": true, + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", - "hasown": "^2.0.0", - "side-channel": "^1.0.4" + "hasown": "^2.0.2", + "side-channel": "^1.1.0" }, "engines": { "node": ">= 0.4" } }, "node_modules/is-array-buffer": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", - "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", + "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.1" + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" }, "engines": { "node": ">= 0.4" @@ -3140,13 +3826,17 @@ } }, "node_modules/is-async-function": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.0.0.tgz", - "integrity": "sha512-Y1JXKrfykRJGdlDwdKlLpLyMIiWqWvuSd17TvZk68PLAOGOoF4Xyav1z0Xhoi+gCYjZVeC5SI+hYFOfvXmGRCA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.1.1.tgz", + "integrity": "sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ==", "dev": true, "license": "MIT", "dependencies": { - "has-tostringtag": "^1.0.0" + "async-function": "^1.0.0", + "call-bound": "^1.0.3", + "get-proto": "^1.0.1", + "has-tostringtag": "^1.0.2", + "safe-regex-test": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -3156,12 +3846,16 @@ } }, "node_modules/is-bigint": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", - "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", + "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", "dev": true, + "license": "MIT", "dependencies": { - "has-bigints": "^1.0.1" + "has-bigints": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -3172,6 +3866,7 @@ "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", "dev": true, + "license": "MIT", "dependencies": { "binary-extensions": "^2.0.0" }, @@ -3180,13 +3875,14 @@ } }, "node_modules/is-boolean-object": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", - "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", + "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -3200,6 +3896,7 @@ "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -3208,9 +3905,9 @@ } }, "node_modules/is-core-module": { - "version": "2.15.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", - "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", + "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", "dev": true, "license": "MIT", "dependencies": { @@ -3224,11 +3921,14 @@ } }, "node_modules/is-data-view": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", - "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.2.tgz", + "integrity": "sha512-RKtWF8pGmS87i2D6gqQu/l7EYRlVdfzemCJN/P3UOs//x1QE7mfhvzHIApBTRf7axvT6DMGwSwBXYCT0nfB9xw==", "dev": true, + "license": "MIT", "dependencies": { + "call-bound": "^1.0.2", + "get-intrinsic": "^1.2.6", "is-typed-array": "^1.1.13" }, "engines": { @@ -3239,12 +3939,14 @@ } }, "node_modules/is-date-object": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", - "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", + "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", "dev": true, + "license": "MIT", "dependencies": { - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -3258,31 +3960,38 @@ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/is-finalizationregistry": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.0.2.tgz", - "integrity": "sha512-0by5vtUJs8iFQb5TYUHHPudOR+qXYIMKtiUzvLIZITZUjknFmziyBJuLhVRc+Ds0dREFlskDNJKYIdIzu/9pfw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.1.1.tgz", + "integrity": "sha512-1pC6N8qWJbWoPtEjgcL2xyhQOP491EQjeUo3qTKcmV8YSDDJrOepfG8pcC7h/QgnQHYSv0mJ3Z/ZWxmatVrysg==", "dev": true, "license": "MIT", "dependencies": { - "call-bind": "^1.0.2" + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/is-generator-function": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.0.10.tgz", - "integrity": "sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.1.0.tgz", + "integrity": "sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ==", "dev": true, "license": "MIT", "dependencies": { - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.3", + "get-proto": "^1.0.0", + "has-tostringtag": "^1.0.2", + "safe-regex-test": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -3296,6 +4005,7 @@ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", "dev": true, + "license": "MIT", "dependencies": { "is-extglob": "^2.1.1" }, @@ -3316,34 +4026,25 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-negative-zero": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", - "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", - "dev": true, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.12.0" } }, "node_modules/is-number-object": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", - "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", + "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", "dev": true, + "license": "MIT", "dependencies": { - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -3352,23 +4053,17 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-path-inside": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", - "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/is-regex": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", - "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", + "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.2", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" }, "engines": { "node": ">= 0.4" @@ -3391,12 +4086,13 @@ } }, "node_modules/is-shared-array-buffer": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", - "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", + "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7" + "call-bound": "^1.0.3" }, "engines": { "node": ">= 0.4" @@ -3406,12 +4102,14 @@ } }, "node_modules/is-string": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", - "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", + "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", "dev": true, + "license": "MIT", "dependencies": { - "has-tostringtag": "^1.0.0" + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -3421,12 +4119,15 @@ } }, "node_modules/is-symbol": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", - "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", + "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", "dev": true, + "license": "MIT", "dependencies": { - "has-symbols": "^1.0.2" + "call-bound": "^1.0.2", + "has-symbols": "^1.1.0", + "safe-regex-test": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -3436,12 +4137,13 @@ } }, "node_modules/is-typed-array": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", - "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.15.tgz", + "integrity": "sha512-p3EcsicXjit7SaskXHs1hA91QxgTw46Fv6EFKKGS5DRFLD8yKnohjF3hxoju94b/OcMZoQukzpPpBE9uLVKzgQ==", "dev": true, + "license": "MIT", "dependencies": { - "which-typed-array": "^1.1.14" + "which-typed-array": "^1.1.16" }, "engines": { "node": ">= 0.4" @@ -3464,26 +4166,30 @@ } }, "node_modules/is-weakref": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", - "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.1.1.tgz", + "integrity": "sha512-6i9mGWSlqzNMEqpCp93KwRS1uUOodk2OJ6b+sq7ZPDSy2WuI5NFIxp/254TytR8ftefexkWn5xNiHUNpPOfSew==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2" + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/is-weakset": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.3.tgz", - "integrity": "sha512-LvIm3/KWzS9oRFHugab7d+M/GcBXuXX5xZkzPmN+NxihdQlZUQ4dWuSV1xR/sq6upL1TJEDrfBgRepHFdBtSNQ==", + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", "dev": true, "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", - "get-intrinsic": "^1.2.4" + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" }, "engines": { "node": ">= 0.4" @@ -3496,144 +4202,396 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/iterator.prototype": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.3.tgz", - "integrity": "sha512-FW5iMbeQ6rBGm/oKgzq2aW4KvAGpxPzYES8N4g4xNXUKpL1mclMvOe+76AcLDTvD+Ze+sOpVhgdAQEKF4L9iGQ==", + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.5.tgz", + "integrity": "sha512-H0dkQoCa3b2VEeKQBOxFph+JAbcrQdE7KC0UkqwpLmv2EC4P41QXP+rqo9wYodACiG5/WM5s9oDApTU8utwj9g==", "dev": true, "license": "MIT", "dependencies": { - "define-properties": "^1.2.1", - "get-intrinsic": "^1.2.1", - "has-symbols": "^1.0.3", - "reflect.getprototypeof": "^1.0.4", - "set-function-name": "^2.0.1" + "define-data-property": "^1.1.4", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.6", + "get-proto": "^1.0.0", + "has-symbols": "^1.1.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/jiti": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.4.2.tgz", + "integrity": "sha512-rg9zJN+G4n2nfJl5MW3BMygZX56zKPNVEYYqq7adpmMh4Jn2QNEwhvQlFy6jPVdcod7txZtKHWnyZiA3a0zP7A==", + "dev": true, + "license": "MIT", + "bin": { + "jiti": "lib/jiti-cli.mjs" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/json5": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsx-ast-utils": { + "version": "3.3.5", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", + "integrity": "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-includes": "^3.1.6", + "array.prototype.flat": "^1.3.1", + "object.assign": "^4.1.4", + "object.values": "^1.1.6" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/lightningcss": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.30.1.tgz", + "integrity": "sha512-xi6IyHML+c9+Q3W0S4fCQJOym42pyurFiJUHEcEyHS0CeKzia4yZDEsLlqOFykxOdHpNy0NmvVO31vcSqAxJCg==", + "dev": true, + "license": "MPL-2.0", + "dependencies": { + "detect-libc": "^2.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-darwin-arm64": "1.30.1", + "lightningcss-darwin-x64": "1.30.1", + "lightningcss-freebsd-x64": "1.30.1", + "lightningcss-linux-arm-gnueabihf": "1.30.1", + "lightningcss-linux-arm64-gnu": "1.30.1", + "lightningcss-linux-arm64-musl": "1.30.1", + "lightningcss-linux-x64-gnu": "1.30.1", + "lightningcss-linux-x64-musl": "1.30.1", + "lightningcss-win32-arm64-msvc": "1.30.1", + "lightningcss-win32-x64-msvc": "1.30.1" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.30.1.tgz", + "integrity": "sha512-c8JK7hyE65X1MHMN+Viq9n11RRC7hgin3HhYKhrMyaXflk5GVplZ60IxyoVtzILeKr+xAJwg6zK6sjTBJ0FKYQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.30.1.tgz", + "integrity": "sha512-k1EvjakfumAQoTfcXUcHQZhSpLlkAuEkdMBsI/ivWw9hL+7FtilQc0Cy3hrx0AAQrVtQAbMI7YjCgYgvn37PzA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 12.0.0" }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.30.1.tgz", + "integrity": "sha512-kmW6UGCGg2PcyUE59K5r0kWfKPAVy4SltVeut+umLCFoJ53RdCUWxcRDzO1eTaxf/7Q2H7LTquFHPL5R+Gjyig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "freebsd" + ], "engines": { - "node": ">= 0.4" + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/jiti": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.0.tgz", - "integrity": "sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==", + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.30.1.tgz", + "integrity": "sha512-MjxUShl1v8pit+6D/zSPq9S9dQ2NPFSQwGvxBCYaBYLPlCWuPh9/t1MRS8iUaR8i+a6w7aps+B4N0S1TYP/R+Q==", + "cpu": [ + "arm" + ], "dev": true, - "bin": { - "jiti": "bin/jiti.js" + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/js-tokens": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" - }, - "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.30.1.tgz", + "integrity": "sha512-gB72maP8rmrKsnKYy8XUuXi/4OctJiuQjcuqWNlJQ6jZiWqtPvqFziskH3hnajfvKB27ynbVCucKSm2rkQp4Bw==", + "cpu": [ + "arm64" + ], "dev": true, - "dependencies": { - "argparse": "^2.0.1" + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" }, - "bin": { - "js-yaml": "bin/js-yaml.js" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true - }, - "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true - }, - "node_modules/json-stable-stringify-without-jsonify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true - }, - "node_modules/json5": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", - "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.30.1.tgz", + "integrity": "sha512-jmUQVx4331m6LIX+0wUhBbmMX7TCfjF5FoOH6SD1CttzuYlGNVpA7QnrmLxrsub43ClTINfGSYyHe2HWeLl5CQ==", + "cpu": [ + "arm64" + ], "dev": true, - "dependencies": { - "minimist": "^1.2.0" + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" }, - "bin": { - "json5": "lib/cli.js" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/jsx-ast-utils": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.4.tgz", - "integrity": "sha512-fX2TVdCViod6HwKEtSWGHs57oFhVfCMwieb9PuRDgjDPh5XeqJiHFFFJCHxU5cnTc3Bu/GRL+kPiFmw8XWOfKw==", + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.30.1.tgz", + "integrity": "sha512-piWx3z4wN8J8z3+O5kO74+yr6ze/dKmPnI7vLqfSqI8bccaTGY5xiSGVIJBDd5K5BHlvVLpUB3S2YCfelyJ1bw==", + "cpu": [ + "x64" + ], "dev": true, - "dependencies": { - "array-includes": "^3.1.6", - "array.prototype.flat": "^1.3.1", - "object.assign": "^4.1.4", - "object.values": "^1.1.6" - }, + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">=4.0" + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.30.1.tgz", + "integrity": "sha512-rRomAK7eIkL+tHY0YPxbc5Dra2gXlI63HL+v1Pdi1a3sC+tJTcFrHX+E86sulgAXeI7rSzDYhPSeHHjqFhqfeQ==", + "cpu": [ + "x64" + ], "dev": true, - "dependencies": { - "json-buffer": "3.0.1" + "license": "MPL-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/levn": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "node_modules/lightningcss-win32-arm64-msvc": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.30.1.tgz", + "integrity": "sha512-mSL4rqPi4iXq5YVqzSsJgMVFENoa4nGTT/GjO2c0Yl9OuQfPsIfncvLrEW6RbbB24WtZ3xP/2CCmI3tNkNV4oA==", + "cpu": [ + "arm64" + ], "dev": true, - "dependencies": { - "prelude-ls": "^1.2.1", - "type-check": "~0.4.0" - }, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], "engines": { - "node": ">= 0.8.0" + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/lilconfig": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-2.1.0.tgz", - "integrity": "sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==", + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.30.1.tgz", + "integrity": "sha512-PVqXh48wh4T53F/1CCu8PIPCxLzWyCnn/9T5W1Jpmdy5h9Cwd+0YQS6/LwhHXSafuc61/xg9Lv5OrCby6a++jg==", + "cpu": [ + "x64" + ], "dev": true, + "license": "MPL-2.0", + "optional": true, + "os": [ + "win32" + ], "engines": { - "node": ">=10" + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" } }, - "node_modules/lines-and-columns": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", - "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", - "dev": true - }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, + "license": "MIT", "dependencies": { "p-locate": "^5.0.0" }, @@ -3648,12 +4606,15 @@ "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/loose-envify": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "license": "MIT", "dependencies": { "js-tokens": "^3.0.0 || ^4.0.0" }, @@ -3665,26 +4626,49 @@ "version": "1.5.0", "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "license": "MIT", "bin": { "lz-string": "bin/bin.js" } }, + "node_modules/magic-string": { + "version": "0.30.17", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", + "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } }, "node_modules/micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, + "license": "MIT", "dependencies": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" }, "engines": { @@ -3696,6 +4680,7 @@ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -3708,37 +4693,78 @@ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", "dev": true, + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/monaco-editor": { - "version": "0.52.0", - "resolved": "https://registry.npmjs.org/monaco-editor/-/monaco-editor-0.52.0.tgz", - "integrity": "sha512-OeWhNpABLCeTqubfqLMXGsqf6OmPU6pHM85kF3dhy6kq5hnhuVS1p3VrEW/XhWHc71P2tHyS5JFySD8mgs1crw==", - "license": "MIT" + "node_modules/minipass": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", + "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=8" + } }, - "node_modules/ms": { + "node_modules/minizlib": { "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", + "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "minipass": "^3.0.0", + "yallist": "^4.0.0" + }, + "engines": { + "node": ">= 8" + } }, - "node_modules/mz": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/mz/-/mz-2.7.0.tgz", - "integrity": "sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q==", + "node_modules/minizlib/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", "dev": true, + "license": "ISC", "dependencies": { - "any-promise": "^1.0.0", - "object-assign": "^4.0.1", - "thenify-all": "^1.0.0" + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "license": "MIT", + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" } }, + "node_modules/monaco-editor": { + "version": "0.52.2", + "resolved": "https://registry.npmjs.org/monaco-editor/-/monaco-editor-0.52.2.tgz", + "integrity": "sha512-GEQWEZmfkOGLdd3XK8ryrfWz3AIP8YymVXiPHEdewrUq7mh0qrKrfHLNCXcbB6sTnMLnOZ3ztSiKcciFUkIJwQ==", + "license": "MIT" + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, "node_modules/nanoid": { - "version": "3.3.7", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", - "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", + "version": "3.3.10", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.10.tgz", + "integrity": "sha512-vSJJTG+t/dIKAUhUDw/dLdZ9s//5OxcHqLaDWWrW4Cdq7o6tdLIczUkMXt2MBNmk6sJRZBZRXVixs7URY1CmIg==", "dev": true, "funding": [ { @@ -3746,6 +4772,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "bin": { "nanoid": "bin/nanoid.cjs" }, @@ -3757,12 +4784,6 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true - }, - "node_modules/node-releases": { - "version": "2.0.18", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", - "integrity": "sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==", "dev": true, "license": "MIT" }, @@ -3771,15 +4792,7 @@ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/normalize-range": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/normalize-range/-/normalize-range-0.1.2.tgz", - "integrity": "sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA==", - "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -3789,24 +4802,20 @@ "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, - "node_modules/object-hash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-3.0.0.tgz", - "integrity": "sha512-RSn9F68PjH9HqtltsSnqYC1XXoWe9Bju5+213R98cNGttag9q9yAOTzdbsqvIa7aNm5WffBZFpWYr2aWrklWAw==", - "dev": true, - "engines": { - "node": ">= 6" - } - }, "node_modules/object-inspect": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.1.tgz", - "integrity": "sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==", + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -3816,19 +4825,23 @@ "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/object.assign": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", - "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.5", + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", "define-properties": "^1.2.1", - "has-symbols": "^1.0.3", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", "object-keys": "^1.1.1" }, "engines": { @@ -3839,14 +4852,16 @@ } }, "node_modules/object.entries": { - "version": "1.1.8", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.8.tgz", - "integrity": "sha512-cmopxi8VwRIAw/fkijJohSfpef5PdN0pMQJN6VC/ZKvn0LIknWD8KtgY6KlQdEc4tIjcQ3HxSMmnvtzIscdaYQ==", + "version": "1.1.9", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.9.tgz", + "integrity": "sha512-8u/hfXFRBD1O0hPUjioLhoWFHRmt6tKA4/vZPyckBr18l1KE9uHrFaFaUi8MDRTpi4uak2goyPTSNJLXX2k2Hw==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-object-atoms": "^1.0.0" + "es-object-atoms": "^1.1.1" }, "engines": { "node": ">= 0.4" @@ -3857,6 +4872,7 @@ "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3875,6 +4891,7 @@ "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3885,12 +4902,14 @@ } }, "node_modules/object.values": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", - "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.1.tgz", + "integrity": "sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", "define-properties": "^1.2.1", "es-object-atoms": "^1.0.0" }, @@ -3906,32 +4925,53 @@ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", "dev": true, + "license": "ISC", "dependencies": { "wrappy": "1" } }, "node_modules/optionator": { - "version": "0.9.3", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.3.tgz", - "integrity": "sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg==", + "version": "0.9.4", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", + "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", "dev": true, + "license": "MIT", "dependencies": { - "@aashutoshrathi/word-wrap": "^1.2.3", "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", - "type-check": "^0.4.0" + "type-check": "^0.4.0", + "word-wrap": "^1.2.5" }, "engines": { "node": ">= 0.8.0" } }, + "node_modules/own-keys": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/own-keys/-/own-keys-1.0.1.tgz", + "integrity": "sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.6", + "object-keys": "^1.1.1", + "safe-push-apply": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, + "license": "MIT", "dependencies": { "yocto-queue": "^0.1.0" }, @@ -3947,11 +4987,25 @@ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, + "license": "MIT", "dependencies": { "p-limit": "^3.0.2" }, "engines": { - "node": ">=10" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-map": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-7.0.3.tgz", + "integrity": "sha512-VkndIv2fIB99swvQoA65bm+fsmt6UNdGeIB0oxBs+WhAhdh08QA04JXpI7rbB9r08/nkbysKoya9rtDERYOYMA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -3962,6 +5016,7 @@ "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", "dev": true, + "license": "MIT", "dependencies": { "callsites": "^3.0.0" }, @@ -3974,6 +5029,7 @@ "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -3983,6 +5039,7 @@ "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -3992,6 +5049,7 @@ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -4000,12 +5058,13 @@ "version": "1.0.7", "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/picocolors": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", - "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", "dev": true, "license": "ISC" }, @@ -4014,6 +5073,7 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true, + "license": "MIT", "engines": { "node": ">=8.6" }, @@ -4021,37 +5081,20 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/pify": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", - "integrity": "sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/pirates": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.6.tgz", - "integrity": "sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==", - "dev": true, - "engines": { - "node": ">= 6" - } - }, "node_modules/possible-typed-array-names": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", - "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/postcss": { - "version": "8.4.47", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.47.tgz", - "integrity": "sha512-56rxCq7G/XfB4EkXq9Egn5GCqugWvDFjafDOThIdMBsI15iqPqR5r15TfSr1YPYeEI19YeaXMCbY6u88Y76GLQ==", + "version": "8.5.3", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", + "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", "dev": true, "funding": [ { @@ -4069,130 +5112,28 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.7", - "picocolors": "^1.1.0", + "nanoid": "^3.3.8", + "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, "engines": { "node": "^10 || ^12 || >=14" } }, - "node_modules/postcss-import": { - "version": "15.1.0", - "resolved": "https://registry.npmjs.org/postcss-import/-/postcss-import-15.1.0.tgz", - "integrity": "sha512-hpr+J05B2FVYUAXHeK1YyI267J/dDDhMU6B6civm8hSY1jYJnBXxzKDKDswzJmtLHryrjhnDjqqp/49t8FALew==", - "dev": true, - "dependencies": { - "postcss-value-parser": "^4.0.0", - "read-cache": "^1.0.0", - "resolve": "^1.1.7" - }, - "engines": { - "node": ">=14.0.0" - }, - "peerDependencies": { - "postcss": "^8.0.0" - } - }, - "node_modules/postcss-js": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/postcss-js/-/postcss-js-4.0.1.tgz", - "integrity": "sha512-dDLF8pEO191hJMtlHFPRa8xsizHaM82MLfNkUHdUtVEV3tgTp5oj+8qbEqYM57SLfc74KSbw//4SeJma2LRVIw==", - "dev": true, - "dependencies": { - "camelcase-css": "^2.0.1" - }, - "engines": { - "node": "^12 || ^14 || >= 16" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - "peerDependencies": { - "postcss": "^8.4.21" - } - }, - "node_modules/postcss-load-config": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/postcss-load-config/-/postcss-load-config-4.0.1.tgz", - "integrity": "sha512-vEJIc8RdiBRu3oRAI0ymerOn+7rPuMvRXslTvZUKZonDHFIczxztIyJ1urxM1x9JXEikvpWWTUUqal5j/8QgvA==", - "dev": true, - "dependencies": { - "lilconfig": "^2.0.5", - "yaml": "^2.1.1" - }, - "engines": { - "node": ">= 14" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - "peerDependencies": { - "postcss": ">=8.0.9", - "ts-node": ">=9.0.0" - }, - "peerDependenciesMeta": { - "postcss": { - "optional": true - }, - "ts-node": { - "optional": true - } - } - }, - "node_modules/postcss-nested": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/postcss-nested/-/postcss-nested-6.0.1.tgz", - "integrity": "sha512-mEp4xPMi5bSWiMbsgoPfcP74lsWLHkQbZc3sY+jWYd65CUwXrUaTp0fmNpa01ZcETKlIgUdFN/MpS2xZtqL9dQ==", - "dev": true, - "dependencies": { - "postcss-selector-parser": "^6.0.11" - }, - "engines": { - "node": ">=12.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - "peerDependencies": { - "postcss": "^8.2.14" - } - }, - "node_modules/postcss-selector-parser": { - "version": "6.0.13", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.0.13.tgz", - "integrity": "sha512-EaV1Gl4mUEV4ddhDnv/xtj7sxwrwxdetHdWUGnT4VJQf+4d05v6lHYZr8N573k5Z0BViss7BDhfWtKS3+sfAqQ==", - "dev": true, - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-value-parser": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", - "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", - "dev": true - }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.8.0" } }, "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz", + "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==", "dev": true, "license": "MIT", "bin": { @@ -4210,6 +5151,7 @@ "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", "dev": true, + "license": "MIT", "dependencies": { "loose-envify": "^1.4.0", "object-assign": "^4.1.1", @@ -4221,10 +5163,23 @@ "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } }, + "node_modules/pyodide": { + "version": "0.27.6", + "resolved": "https://registry.npmjs.org/pyodide/-/pyodide-0.27.6.tgz", + "integrity": "sha512-ahiSHHs6iFKl2f8aO1wALINAlMNDLAtb44xCI87GQyH2tLDk8F8VWip3u1ZNIyglGSCYAOSFzWKwS1f9gBFVdg==", + "license": "Apache-2.0", + "dependencies": { + "ws": "^8.5.0" + }, + "engines": { + "node": ">=18.0.0" + } + }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -4243,61 +5198,53 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/react": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", - "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", - "dependencies": { - "loose-envify": "^1.1.0" - }, + "version": "19.1.0", + "resolved": "https://registry.npmjs.org/react/-/react-19.1.0.tgz", + "integrity": "sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/react-dom": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", - "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", + "version": "19.1.0", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.1.0.tgz", + "integrity": "sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g==", + "license": "MIT", "dependencies": { - "loose-envify": "^1.1.0", - "scheduler": "^0.23.2" + "scheduler": "^0.26.0" }, "peerDependencies": { - "react": "^18.3.1" + "react": "^19.1.0" } }, "node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/react-resizable-panels": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/react-resizable-panels/-/react-resizable-panels-2.1.6.tgz", - "integrity": "sha512-oIqo/7pp2TsR+Dp1qZMr1l4RBDV4Zz/0HEG5zxliBJoHqqFnG0MbmFbk+5Q1VMGfPQ4uhXxefunLC1o7v38PDQ==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/react-resizable-panels/-/react-resizable-panels-3.0.2.tgz", + "integrity": "sha512-j4RNII75fnHkLnbsTb5G5YsDvJsSEZrJK2XSF2z0Tc2jIonYlIVir/Yh/5LvcUFCfs1HqrMAoiBFmIrRjC4XnA==", "license": "MIT", "peerDependencies": { "react": "^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc", "react-dom": "^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc" } }, - "node_modules/read-cache": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz", - "integrity": "sha512-Owdv/Ft7IjOgm/i0xvNDZ1LrRANRfew4b2prF3OWMQLxLfu3bS8FVhCsrSCMK4lR56Y9ya+AThoTpDCTxCmpRA==", - "dev": true, - "dependencies": { - "pify": "^2.3.0" - } - }, "node_modules/readdirp": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", "dev": true, + "license": "MIT", "dependencies": { "picomatch": "^2.2.1" }, @@ -4306,19 +5253,20 @@ } }, "node_modules/reflect.getprototypeof": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.6.tgz", - "integrity": "sha512-fmfw4XgoDke3kdI6h4xcUz1dG8uaiv5q9gcEwLS4Pnth2kxT+GZ7YehS1JTMGBQmtV7Y4GFGbs2re2NqhdozUg==", + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz", + "integrity": "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==", "dev": true, "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", "define-properties": "^1.2.1", - "es-abstract": "^1.23.1", + "es-abstract": "^1.23.9", "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.4", - "globalthis": "^1.0.3", - "which-builtin-type": "^1.1.3" + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.7", + "get-proto": "^1.0.1", + "which-builtin-type": "^1.2.1" }, "engines": { "node": ">= 0.4" @@ -4328,15 +5276,18 @@ } }, "node_modules/regexp.prototype.flags": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", - "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.6", + "call-bind": "^1.0.8", "define-properties": "^1.2.1", "es-errors": "^1.3.0", - "set-function-name": "^2.0.1" + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" }, "engines": { "node": ">= 0.4" @@ -4346,18 +5297,22 @@ } }, "node_modules/resolve": { - "version": "1.22.2", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.2.tgz", - "integrity": "sha512-Sb+mjNHOULsBv818T40qSPeRiuWLyaGMa5ewydRLFimneixmVy2zdivRl+AF6jaYPC8ERxGDmFSiqui6SfPd+g==", + "version": "1.22.10", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", + "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", "dev": true, + "license": "MIT", "dependencies": { - "is-core-module": "^2.11.0", + "is-core-module": "^2.16.0", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, "bin": { "resolve": "bin/resolve" }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -4367,15 +5322,17 @@ "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true, + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", "dev": true, + "license": "MIT", "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" @@ -4385,7 +5342,9 @@ "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, + "license": "ISC", "dependencies": { "glob": "^7.1.3" }, @@ -4397,13 +5356,13 @@ } }, "node_modules/rollup": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.21.0.tgz", - "integrity": "sha512-vo+S/lfA2lMS7rZ2Qoubi6I5hwZwzXeUIctILZLbHI+laNtvhhOIon2S1JksA5UEDQ7l3vberd0fxK44lTYjbQ==", + "version": "4.36.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.36.0.tgz", + "integrity": "sha512-zwATAXNQxUcd40zgtQG0ZafcRK4g004WtEl7kbuhTWPvf07PsfohXl39jVUvPF7jvNAIkKPQ2XrsDlWuxBd++Q==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.5" + "@types/estree": "1.0.6" }, "bin": { "rollup": "dist/bin/rollup" @@ -4413,25 +5372,36 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.21.0", - "@rollup/rollup-android-arm64": "4.21.0", - "@rollup/rollup-darwin-arm64": "4.21.0", - "@rollup/rollup-darwin-x64": "4.21.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.21.0", - "@rollup/rollup-linux-arm-musleabihf": "4.21.0", - "@rollup/rollup-linux-arm64-gnu": "4.21.0", - "@rollup/rollup-linux-arm64-musl": "4.21.0", - "@rollup/rollup-linux-powerpc64le-gnu": "4.21.0", - "@rollup/rollup-linux-riscv64-gnu": "4.21.0", - "@rollup/rollup-linux-s390x-gnu": "4.21.0", - "@rollup/rollup-linux-x64-gnu": "4.21.0", - "@rollup/rollup-linux-x64-musl": "4.21.0", - "@rollup/rollup-win32-arm64-msvc": "4.21.0", - "@rollup/rollup-win32-ia32-msvc": "4.21.0", - "@rollup/rollup-win32-x64-msvc": "4.21.0", + "@rollup/rollup-android-arm-eabi": "4.36.0", + "@rollup/rollup-android-arm64": "4.36.0", + "@rollup/rollup-darwin-arm64": "4.36.0", + "@rollup/rollup-darwin-x64": "4.36.0", + "@rollup/rollup-freebsd-arm64": "4.36.0", + "@rollup/rollup-freebsd-x64": "4.36.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.36.0", + "@rollup/rollup-linux-arm-musleabihf": "4.36.0", + "@rollup/rollup-linux-arm64-gnu": "4.36.0", + "@rollup/rollup-linux-arm64-musl": "4.36.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.36.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.36.0", + "@rollup/rollup-linux-riscv64-gnu": "4.36.0", + "@rollup/rollup-linux-s390x-gnu": "4.36.0", + "@rollup/rollup-linux-x64-gnu": "4.36.0", + "@rollup/rollup-linux-x64-musl": "4.36.0", + "@rollup/rollup-win32-arm64-msvc": "4.36.0", + "@rollup/rollup-win32-ia32-msvc": "4.36.0", + "@rollup/rollup-win32-x64-msvc": "4.36.0", "fsevents": "~2.3.2" } }, + "node_modules/ruff_wasm": { + "resolved": "ruff/ruff_wasm", + "link": true + }, + "node_modules/ruff-playground": { + "resolved": "ruff", + "link": true + }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -4451,19 +5421,22 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "queue-microtask": "^1.2.2" } }, "node_modules/safe-array-concat": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", - "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.3.tgz", + "integrity": "sha512-AURm5f0jYEOydBj7VQlVvDrjeFgthDdEF5H1dP+6mNpoXOMo1quQqJ4wvJDyRZ9+pO3kGWoOdmV08cSv2aJV6Q==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", - "get-intrinsic": "^1.2.4", - "has-symbols": "^1.0.3", + "call-bind": "^1.0.8", + "call-bound": "^1.0.2", + "get-intrinsic": "^1.2.6", + "has-symbols": "^1.1.0", "isarray": "^2.0.5" }, "engines": { @@ -4473,15 +5446,15 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/safe-regex-test": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", - "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "node_modules/safe-push-apply": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/safe-push-apply/-/safe-push-apply-1.0.0.tgz", + "integrity": "sha512-iKE9w/Z7xCzUMIZqdBsp6pEQvwuEebH4vdpjcDWnyzaI6yl6O9FHvVpmGelvEHNsoY6wGblkxR6Zty/h00WiSA==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.6", "es-errors": "^1.3.0", - "is-regex": "^1.1.4" + "isarray": "^2.0.5" }, "engines": { "node": ">= 0.4" @@ -4490,25 +5463,38 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/scheduler": { - "version": "0.23.2", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", - "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", + "node_modules/safe-regex-test": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", + "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "dev": true, + "license": "MIT", "dependencies": { - "loose-envify": "^1.1.0" + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "is-regex": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/scheduler": { + "version": "0.26.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.26.0.tgz", + "integrity": "sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA==", + "license": "MIT" + }, "node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", "dev": true, "license": "ISC", "bin": { "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" } }, "node_modules/set-function-length": { @@ -4516,6 +5502,7 @@ "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", "dev": true, + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -4533,6 +5520,7 @@ "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", "dev": true, + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -4543,11 +5531,31 @@ "node": ">= 0.4" } }, + "node_modules/set-proto": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/set-proto/-/set-proto-1.0.0.tgz", + "integrity": "sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/shared": { + "resolved": "shared", + "link": true + }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", "dev": true, + "license": "MIT", "dependencies": { "shebang-regex": "^3.0.0" }, @@ -4560,20 +5568,79 @@ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/side-channel": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", - "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.4", - "object-inspect": "^1.13.1" + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" }, "engines": { "node": ">= 0.4" @@ -4583,9 +5650,9 @@ } }, "node_modules/smol-toml": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.3.0.tgz", - "integrity": "sha512-tWpi2TsODPScmi48b/OQZGi2lgUmBCHy6SZrhi/FdnnHiU1GwebbCfuQuxsC3nHaLwtYeJGPrDZDIeodDOc4pA==", + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.3.4.tgz", + "integrity": "sha512-UOPtVuYkzYGee0Bd2Szz8d2G3RfMfJ2t3qVdZUAozZyAk+a0Sxa+QKix0YCwjL/A1RR0ar44nCxaoN9FxdJGwA==", "license": "BSD-3-Clause", "engines": { "node": ">= 18" @@ -4607,26 +5674,29 @@ "node_modules/state-local": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/state-local/-/state-local-1.0.7.tgz", - "integrity": "sha512-HTEHMNieakEnoe33shBYcZ7NX83ACUjCu8c40iOGEZsngj9zRnkqS9j1pqQPXwobB0ZcVTk27REb7COQ0UR59w==" + "integrity": "sha512-HTEHMNieakEnoe33shBYcZ7NX83ACUjCu8c40iOGEZsngj9zRnkqS9j1pqQPXwobB0ZcVTk27REb7COQ0UR59w==", + "license": "MIT" }, "node_modules/string.prototype.matchall": { - "version": "4.0.11", - "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.11.tgz", - "integrity": "sha512-NUdh0aDavY2og7IbBPenWqR9exH+E26Sv8e0/eTe1tltDGZL+GtBkDAnnyBtmekfK6/Dq3MkcGtzXFEd1LQrtg==", + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.12.tgz", + "integrity": "sha512-6CC9uyBL+/48dYizRf7H7VAYCMCNTBeM78x/VTUe9bFEaxBepPJDa1Ow99LqI/1yF7kuy7Q3cQsYMrcjGUcskA==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", "define-properties": "^1.2.1", - "es-abstract": "^1.23.2", + "es-abstract": "^1.23.6", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", - "get-intrinsic": "^1.2.4", - "gopd": "^1.0.1", - "has-symbols": "^1.0.3", - "internal-slot": "^1.0.7", - "regexp.prototype.flags": "^1.5.2", + "get-intrinsic": "^1.2.6", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "internal-slot": "^1.1.0", + "regexp.prototype.flags": "^1.5.3", "set-function-name": "^2.0.2", - "side-channel": "^1.0.6" + "side-channel": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -4647,15 +5717,19 @@ } }, "node_modules/string.prototype.trim": { - "version": "1.2.9", - "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", - "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "version": "1.2.10", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.10.tgz", + "integrity": "sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.2", + "define-data-property": "^1.1.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.0", - "es-object-atoms": "^1.0.0" + "es-abstract": "^1.23.5", + "es-object-atoms": "^1.0.0", + "has-property-descriptors": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -4665,15 +5739,20 @@ } }, "node_modules/string.prototype.trimend": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", - "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.9.tgz", + "integrity": "sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.2", "define-properties": "^1.2.1", "es-object-atoms": "^1.0.0" }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -4683,6 +5762,7 @@ "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -4695,23 +5775,12 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/strip-bom": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==", "dev": true, + "license": "MIT", "engines": { "node": ">=4" } @@ -4721,6 +5790,7 @@ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" }, @@ -4728,53 +5798,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/sucrase": { - "version": "3.33.0", - "resolved": "https://registry.npmjs.org/sucrase/-/sucrase-3.33.0.tgz", - "integrity": "sha512-ARGC7vbufOHfpvyGcZZXFaXCMZ9A4fffOGC5ucOW7+WHDGlAe8LJdf3Jts1sWhDeiI1RSWrKy5Hodl+JWGdW2A==", - "dev": true, - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.2", - "commander": "^4.0.0", - "glob": "7.1.6", - "lines-and-columns": "^1.1.6", - "mz": "^2.7.0", - "pirates": "^4.0.1", - "ts-interface-checker": "^0.1.9" - }, - "bin": { - "sucrase": "bin/sucrase", - "sucrase-node": "bin/sucrase-node" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/sucrase/node_modules/glob": { - "version": "7.1.6", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", - "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", - "dev": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", "dev": true, + "license": "MIT", "dependencies": { "has-flag": "^4.0.0" }, @@ -4787,6 +5816,7 @@ "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -4795,68 +5825,83 @@ } }, "node_modules/tailwindcss": { - "version": "3.4.14", - "resolved": "https://registry.npmjs.org/tailwindcss/-/tailwindcss-3.4.14.tgz", - "integrity": "sha512-IcSvOcTRcUtQQ7ILQL5quRDg7Xs93PdJEk1ZLbhhvJc7uj/OAhYOnruEiwnGgBvUtaUAJ8/mhSw1o8L2jCiENA==", + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/tailwindcss/-/tailwindcss-4.1.7.tgz", + "integrity": "sha512-kr1o/ErIdNhTz8uzAYL7TpaUuzKIE6QPQ4qmSdxnoX/lo+5wmUHQA6h3L5yIqEImSRnAAURDirLu/BgiXGPAhg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tapable": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", + "integrity": "sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==", "dev": true, "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/tar": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/tar/-/tar-6.2.1.tgz", + "integrity": "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==", + "dev": true, + "license": "ISC", "dependencies": { - "@alloc/quick-lru": "^5.2.0", - "arg": "^5.0.2", - "chokidar": "^3.5.3", - "didyoumean": "^1.2.2", - "dlv": "^1.1.3", - "fast-glob": "^3.3.0", - "glob-parent": "^6.0.2", - "is-glob": "^4.0.3", - "jiti": "^1.21.0", - "lilconfig": "^2.1.0", - "micromatch": "^4.0.5", - "normalize-path": "^3.0.0", - "object-hash": "^3.0.0", - "picocolors": "^1.0.0", - "postcss": "^8.4.23", - "postcss-import": "^15.1.0", - "postcss-js": "^4.0.1", - "postcss-load-config": "^4.0.1", - "postcss-nested": "^6.0.1", - "postcss-selector-parser": "^6.0.11", - "resolve": "^1.22.2", - "sucrase": "^3.32.0" - }, - "bin": { - "tailwind": "lib/cli.js", - "tailwindcss": "lib/cli.js" + "chownr": "^2.0.0", + "fs-minipass": "^2.0.0", + "minipass": "^5.0.0", + "minizlib": "^2.1.1", + "mkdirp": "^1.0.3", + "yallist": "^4.0.0" }, "engines": { - "node": ">=14.0.0" + "node": ">=10" } }, - "node_modules/text-table": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", - "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", - "dev": true - }, - "node_modules/thenify": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/thenify/-/thenify-3.3.1.tgz", - "integrity": "sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==", + "node_modules/tinyglobby": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz", + "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==", "dev": true, + "license": "MIT", "dependencies": { - "any-promise": "^1.0.0" + "fdir": "^6.4.4", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" } }, - "node_modules/thenify-all": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/thenify-all/-/thenify-all-1.6.0.tgz", - "integrity": "sha512-RNxQH/qI8/t3thXJDwcstUO4zeqo64+Uy/+sNVRBx4Xn2OX+OZ9oP+iJnNFqplFra2ZUVeKCSa2oVWi3T4uVmA==", + "node_modules/tinyglobby/node_modules/fdir": { + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", + "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", "dev": true, - "dependencies": { - "thenify": ">= 3.1.0 < 4" + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/tinyglobby/node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "dev": true, + "license": "MIT", "engines": { - "node": ">=0.8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" } }, "node_modules/to-regex-range": { @@ -4864,6 +5909,7 @@ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", "dev": true, + "license": "MIT", "dependencies": { "is-number": "^7.0.0" }, @@ -4872,28 +5918,24 @@ } }, "node_modules/ts-api-utils": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.3.0.tgz", - "integrity": "sha512-UQMIo7pb8WRomKR1/+MFVLTroIvDVtMX3K6OUir8ynLyzB8Jeriont2bTAtmNPa1ekAgN7YPDyf6V+ygrdU+eQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", + "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", "dev": true, + "license": "MIT", "engines": { - "node": ">=16" + "node": ">=18.12" }, "peerDependencies": { - "typescript": ">=4.2.0" + "typescript": ">=4.8.4" } }, - "node_modules/ts-interface-checker": { - "version": "0.1.13", - "resolved": "https://registry.npmjs.org/ts-interface-checker/-/ts-interface-checker-0.1.13.tgz", - "integrity": "sha512-Y/arvbn+rrz3JCKl9C4kVNfTfSm2/mEp5FSz5EsZSANGPSlQrpRI5M4PKF+mJnE52jOO90PnPSc3Ur3bTQw0gA==", - "dev": true - }, "node_modules/tsconfig-paths": { "version": "3.15.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", "dev": true, + "license": "MIT", "dependencies": { "@types/json5": "^0.0.29", "json5": "^1.0.2", @@ -4901,11 +5943,20 @@ "strip-bom": "^3.0.0" } }, + "node_modules/ty_wasm": { + "resolved": "ty/ty_wasm", + "link": true + }, + "node_modules/ty-playground": { + "resolved": "ty", + "link": true + }, "node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, + "license": "MIT", "dependencies": { "prelude-ls": "^1.2.1" }, @@ -4913,43 +5964,33 @@ "node": ">= 0.8.0" } }, - "node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/typed-array-buffer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", - "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.3.tgz", + "integrity": "sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bound": "^1.0.3", "es-errors": "^1.3.0", - "is-typed-array": "^1.1.13" + "is-typed-array": "^1.1.14" }, "engines": { "node": ">= 0.4" } }, "node_modules/typed-array-byte-length": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", - "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.3.tgz", + "integrity": "sha512-BaXgOuIxz8n8pIq3e7Atg/7s+DpiYrxn4vdot3w9KbnBhcRQq6o3xemQdIfynqSeXeDrF32x+WvfzmOjPiY9lg==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", "for-each": "^0.3.3", - "gopd": "^1.0.1", - "has-proto": "^1.0.3", - "is-typed-array": "^1.1.13" + "gopd": "^1.2.0", + "has-proto": "^1.2.0", + "is-typed-array": "^1.1.14" }, "engines": { "node": ">= 0.4" @@ -4959,17 +6000,19 @@ } }, "node_modules/typed-array-byte-offset": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", - "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.4.tgz", + "integrity": "sha512-bTlAFB/FBYMcuX81gbL4OcpH5PmlFHqlCCpAl8AlEzMz5k53oNDvN8p1PNOWLEmI2x4orp3raOFB51tv9X+MFQ==", "dev": true, + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", "for-each": "^0.3.3", - "gopd": "^1.0.1", - "has-proto": "^1.0.3", - "is-typed-array": "^1.1.13" + "gopd": "^1.2.0", + "has-proto": "^1.2.0", + "is-typed-array": "^1.1.15", + "reflect.getprototypeof": "^1.0.9" }, "engines": { "node": ">= 0.4" @@ -4979,17 +6022,18 @@ } }, "node_modules/typed-array-length": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", - "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.7.tgz", + "integrity": "sha512-3KS2b+kL7fsuk/eJZ7EQdnEmQoaho/r6KUef7hxvltNA5DR8NAUM+8wJMbJyZ4G9/7i3v5zPBIMN5aybAh2/Jg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "for-each": "^0.3.3", "gopd": "^1.0.1", - "has-proto": "^1.0.3", "is-typed-array": "^1.1.13", - "possible-typed-array-names": "^1.0.0" + "possible-typed-array-names": "^1.0.0", + "reflect.getprototypeof": "^1.0.6" }, "engines": { "node": ">= 0.4" @@ -4999,9 +6043,9 @@ } }, "node_modules/typescript": { - "version": "5.6.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", - "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -5012,50 +6056,56 @@ "node": ">=14.17" } }, - "node_modules/unbox-primitive": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", - "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", + "node_modules/typescript-eslint": { + "version": "8.32.1", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.32.1.tgz", + "integrity": "sha512-D7el+eaDHAmXvrZBy1zpzSNIRqnCOrkwTgZxTu3MUqRWk8k0q9m9Ho4+vPf7iHtgUfrK/o8IZaEApsxPlHTFCg==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "has-bigints": "^1.0.2", - "has-symbols": "^1.0.3", - "which-boxed-primitive": "^1.0.2" + "@typescript-eslint/eslint-plugin": "8.32.1", + "@typescript-eslint/parser": "8.32.1", + "@typescript-eslint/utils": "8.32.1" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { - "url": "https://github.com/sponsors/ljharb" + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, - "node_modules/update-browserslist-db": { + "node_modules/unbox-primitive": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", - "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", + "integrity": "sha512-nWJ91DjeOkej/TA8pXQ3myruKpKEYgqvpw9lz4OPHj/NWFNluYrjbz9j01CJ8yKQd2g4jFoOkINCTW2I5LEEyw==", "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], "license": "MIT", "dependencies": { - "escalade": "^3.1.2", - "picocolors": "^1.0.1" + "call-bound": "^1.0.3", + "has-bigints": "^1.0.2", + "has-symbols": "^1.1.0", + "which-boxed-primitive": "^1.1.1" }, - "bin": { - "update-browserslist-db": "cli.js" + "engines": { + "node": ">= 0.4" }, - "peerDependencies": { - "browserslist": ">= 4.21.0" + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" } }, "node_modules/uri-js": { @@ -5063,32 +6113,30 @@ "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "punycode": "^2.1.0" } }, - "node_modules/util-deprecate": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", - "dev": true - }, "node_modules/vite": { - "version": "5.4.10", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.10.tgz", - "integrity": "sha512-1hvaPshuPUtxeQ0hsVH3Mud0ZanOLwVTneA1EgbAM5LhaZEqyPWGRQ7BtaMvUrTDeEaC8pxtj6a6jku3x4z6SQ==", + "version": "6.3.5", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", + "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.21.3", - "postcss": "^8.4.43", - "rollup": "^4.20.0" + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" }, "bin": { "vite": "bin/vite.js" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://github.com/vitejs/vite?sponsor=1" @@ -5097,19 +6145,25 @@ "fsevents": "~2.3.3" }, "peerDependencies": { - "@types/node": "^18.0.0 || >=20.0.0", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", "less": "*", "lightningcss": "^1.21.0", "sass": "*", "sass-embedded": "*", "stylus": "*", "sugarss": "*", - "terser": "^5.4.0" + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" }, "peerDependenciesMeta": { "@types/node": { "optional": true }, + "jiti": { + "optional": true + }, "less": { "optional": true }, @@ -5130,14 +6184,83 @@ }, "terser": { "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-plugin-static-copy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/vite-plugin-static-copy/-/vite-plugin-static-copy-3.0.0.tgz", + "integrity": "sha512-Uki9pPUQ4ZnoMEdIFabvoh9h6Bh9Q1m3iF7BrZvoiF30reREpJh2gZb4jOnW1/uYFzyRiLCmFSkM+8hwiq1vWQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "chokidar": "^3.5.3", + "fs-extra": "^11.3.0", + "p-map": "^7.0.3", + "picocolors": "^1.1.1", + "tinyglobby": "^0.2.13" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "peerDependencies": { + "vite": "^5.0.0 || ^6.0.0" + } + }, + "node_modules/vite/node_modules/fdir": { + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", + "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true } } }, + "node_modules/vite/node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/wasm-pack": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/wasm-pack/-/wasm-pack-0.13.1.tgz", + "integrity": "sha512-P9exD4YkjpDbw68xUhF3MDm/CC/3eTmmthyG5bHJ56kalxOTewOunxTke4SyF8MTXV6jUtNjXggPgrGmMtczGg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT OR Apache-2.0", + "dependencies": { + "binary-install": "^1.0.1" + }, + "bin": { + "wasm-pack": "run.js" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, + "license": "ISC", "dependencies": { "isexe": "^2.0.0" }, @@ -5149,40 +6272,45 @@ } }, "node_modules/which-boxed-primitive": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", - "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", + "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", "dev": true, + "license": "MIT", "dependencies": { - "is-bigint": "^1.0.1", - "is-boolean-object": "^1.1.0", - "is-number-object": "^1.0.4", - "is-string": "^1.0.5", - "is-symbol": "^1.0.3" + "is-bigint": "^1.1.0", + "is-boolean-object": "^1.2.1", + "is-number-object": "^1.1.1", + "is-string": "^1.1.1", + "is-symbol": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/which-builtin-type": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.1.4.tgz", - "integrity": "sha512-bppkmBSsHFmIMSl8BO9TbsyzsvGjVoppt8xUiGzwiu/bhDCGxnpOKCxgqj6GuyHE0mINMDecBFPlOm2hzY084w==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.2.1.tgz", + "integrity": "sha512-6iBczoX+kDQ7a3+YJBnh3T+KZRxM/iYNPXicqk66/Qfm1b93iu+yOImkg0zHbj5LNOcNv1TEADiZ0xa34B4q6Q==", "dev": true, "license": "MIT", "dependencies": { + "call-bound": "^1.0.2", "function.prototype.name": "^1.1.6", "has-tostringtag": "^1.0.2", "is-async-function": "^2.0.0", - "is-date-object": "^1.0.5", - "is-finalizationregistry": "^1.0.2", + "is-date-object": "^1.1.0", + "is-finalizationregistry": "^1.1.0", "is-generator-function": "^1.0.10", - "is-regex": "^1.1.4", + "is-regex": "^1.2.1", "is-weakref": "^1.0.2", "isarray": "^2.0.5", - "which-boxed-primitive": "^1.0.2", + "which-boxed-primitive": "^1.1.0", "which-collection": "^1.0.2", - "which-typed-array": "^1.1.15" + "which-typed-array": "^1.1.16" }, "engines": { "node": ">= 0.4" @@ -5211,15 +6339,18 @@ } }, "node_modules/which-typed-array": { - "version": "1.1.15", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", - "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", + "version": "1.1.19", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.19.tgz", + "integrity": "sha512-rEvr90Bck4WZt9HHFC4DJMsjvu7x+r6bImz0/BrbWb7A2djJ8hnZMrWnHo9F8ssv0OMErasDhftrfROTyqSDrw==", "dev": true, + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", - "call-bind": "^1.0.7", - "for-each": "^0.3.3", - "gopd": "^1.0.1", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", "has-tostringtag": "^1.0.2" }, "engines": { @@ -5229,32 +6360,116 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/word-wrap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", + "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", - "dev": true - }, - "node_modules/yaml": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.1.tgz", - "integrity": "sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ==", "dev": true, + "license": "ISC" + }, + "node_modules/ws": { + "version": "8.18.2", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.2.tgz", + "integrity": "sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ==", + "license": "MIT", "engines": { - "node": ">= 14" + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } } }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true, + "license": "ISC" + }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } + }, + "ruff": { + "name": "ruff-playground", + "version": "0.0.0", + "dependencies": { + "@monaco-editor/react": "^4.4.6", + "classnames": "^2.3.2", + "lz-string": "^1.5.0", + "monaco-editor": "^0.52.0", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-resizable-panels": "^3.0.0", + "ruff_wasm": "file:ruff_wasm", + "shared": "0.0.0", + "smol-toml": "^1.3.0" + } + }, + "ruff/ruff_wasm": { + "version": "0.11.8", + "license": "MIT" + }, + "shared": { + "version": "0.0.0", + "dependencies": { + "@monaco-editor/react": "^4.7.0", + "classnames": "^2.3.2", + "react": "^19.0.0", + "react-resizable-panels": "^3.0.0" + } + }, + "ty": { + "name": "ty-playground", + "version": "0.0.0", + "dependencies": { + "@monaco-editor/react": "^4.7.0", + "classnames": "^2.5.1", + "lz-string": "^1.5.0", + "monaco-editor": "^0.52.2", + "pyodide": "^0.27.4", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-resizable-panels": "^3.0.0", + "shared": "0.0.0", + "smol-toml": "^1.3.1", + "ty_wasm": "file:ty_wasm" + }, + "devDependencies": { + "vite-plugin-static-copy": "^3.0.0" + } + }, + "ty/ty_wasm": { + "version": "0.0.0", + "license": "MIT" } } } diff --git a/playground/package.json b/playground/package.json index 380fb08e244c9..9a3255ad9c492 100644 --- a/playground/package.json +++ b/playground/package.json @@ -4,42 +4,37 @@ "version": "0.0.0", "type": "module", "scripts": { - "build:wasm": "wasm-pack build ../crates/ruff_wasm --target web --out-dir ../../playground/src/pkg", - "build": "tsc && vite build", - "check": "npm run lint && npm run tsc", - "dev": "vite", - "dev:wasm": "wasm-pack build ../crates/ruff_wasm --dev --target web --out-dir ../../playground/src/pkg", + "check": "npm run dev:wasm && npm run lint && npm run tsc", + "dev:wasm": "npm run dev:wasm --workspace ty-playground && npm run dev:wasm --workspace ruff-playground", + "dev:build": "npm run dev:build --workspace ty-playground && npm run dev:build --workspace ruff-playground", "fmt": "prettier --cache -w .", - "lint": "eslint --cache --ext .ts,.tsx src", - "preview": "vite preview", + "fmt:check": "prettier --cache --check .", + "lint": "eslint --cache --ext .ts,.tsx ruff/src ty/src", "tsc": "tsc" }, - "dependencies": { - "@monaco-editor/react": "^4.4.6", - "classnames": "^2.3.2", - "lz-string": "^1.5.0", - "monaco-editor": "^0.52.0", - "react": "^18.2.0", - "react-dom": "^18.2.0", - "react-resizable-panels": "^2.0.0", - "smol-toml": "^1.3.0" + "workspaces": [ + "ty", + "ruff", + "shared" + ], + "prettier": { + "trailingComma": "all" }, "devDependencies": { - "@types/react": "^18.0.26", - "@types/react-dom": "^18.0.9", - "@typescript-eslint/eslint-plugin": "^8.0.0", - "@typescript-eslint/parser": "^8.0.0", + "@eslint/js": "^9.21.0", + "@tailwindcss/vite": "^4.0.14", + "@types/react": "^19.0.11", + "@types/react-dom": "^19.0.0", "@vitejs/plugin-react-swc": "^3.0.0", - "autoprefixer": "^10.4.13", - "eslint": "^8.30.0", - "eslint-config-prettier": "^9.0.0", - "eslint-plugin-import": "^2.29.1", + "eslint": "^9.22.0", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-react": "^7.31.11", - "eslint-plugin-react-hooks": "^5.0.0", - "postcss": "^8.4.20", - "prettier": "^3.0.0", - "tailwindcss": "^3.2.4", - "typescript": "^5.1.6", - "vite": "^5.0.0" + "eslint-plugin-react-hooks": "^5.2.0", + "prettier": "^3.5.3", + "tailwindcss": "^4.0.14", + "typescript": "^5.8.2", + "typescript-eslint": "^8.26.1", + "vite": "^6.2.2", + "wasm-pack": "^0.13.1" } } diff --git a/playground/postcss.config.cjs b/playground/postcss.config.cjs deleted file mode 100644 index cbfea5ea20fc5..0000000000000 --- a/playground/postcss.config.cjs +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = { - plugins: { - "tailwindcss/nesting": {}, - tailwindcss: {}, - autoprefixer: {}, - }, -}; diff --git a/playground/public/fonts/Alliance-PlattMedium.otf b/playground/public/fonts/Alliance-PlattMedium.otf deleted file mode 100644 index 4ab85a6a06b40..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattMedium.otf and /dev/null differ diff --git a/playground/public/fonts/Alliance-PlattMedium.woff b/playground/public/fonts/Alliance-PlattMedium.woff deleted file mode 100644 index 2e61cda1b99ef..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattMedium.woff and /dev/null differ diff --git a/playground/public/fonts/Alliance-PlattMedium.woff2 b/playground/public/fonts/Alliance-PlattMedium.woff2 deleted file mode 100644 index ce7326b49e2d5..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattMedium.woff2 and /dev/null differ diff --git a/playground/public/fonts/Alliance-PlattRegular.otf b/playground/public/fonts/Alliance-PlattRegular.otf deleted file mode 100644 index e3fb5ccc67553..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattRegular.otf and /dev/null differ diff --git a/playground/public/fonts/Alliance-PlattRegular.woff b/playground/public/fonts/Alliance-PlattRegular.woff deleted file mode 100644 index 875da29046467..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattRegular.woff and /dev/null differ diff --git a/playground/public/fonts/Alliance-PlattRegular.woff2 b/playground/public/fonts/Alliance-PlattRegular.woff2 deleted file mode 100644 index 1e6ce3f81891c..0000000000000 Binary files a/playground/public/fonts/Alliance-PlattRegular.woff2 and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextMedium.otf b/playground/public/fonts/Alliance-TextMedium.otf deleted file mode 100644 index 305858821ead8..0000000000000 Binary files a/playground/public/fonts/Alliance-TextMedium.otf and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextMedium.woff b/playground/public/fonts/Alliance-TextMedium.woff deleted file mode 100644 index 25a79ab90ee4a..0000000000000 Binary files a/playground/public/fonts/Alliance-TextMedium.woff and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextMedium.woff2 b/playground/public/fonts/Alliance-TextMedium.woff2 deleted file mode 100644 index 7d168fb54ca55..0000000000000 Binary files a/playground/public/fonts/Alliance-TextMedium.woff2 and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextRegular.otf b/playground/public/fonts/Alliance-TextRegular.otf deleted file mode 100644 index 0af4a82ce6eea..0000000000000 Binary files a/playground/public/fonts/Alliance-TextRegular.otf and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextRegular.woff b/playground/public/fonts/Alliance-TextRegular.woff deleted file mode 100644 index 3e837e3a4917d..0000000000000 Binary files a/playground/public/fonts/Alliance-TextRegular.woff and /dev/null differ diff --git a/playground/public/fonts/Alliance-TextRegular.woff2 b/playground/public/fonts/Alliance-TextRegular.woff2 deleted file mode 100644 index a15707cdc4e4b..0000000000000 Binary files a/playground/public/fonts/Alliance-TextRegular.woff2 and /dev/null differ diff --git a/playground/index.html b/playground/ruff/index.html similarity index 100% rename from playground/index.html rename to playground/ruff/index.html diff --git a/playground/ruff/package.json b/playground/ruff/package.json new file mode 100644 index 0000000000000..b14927998d447 --- /dev/null +++ b/playground/ruff/package.json @@ -0,0 +1,35 @@ +{ + "name": "ruff-playground", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "prebuild": "npm run build:wasm", + "build": "vite build", + "build:wasm": "wasm-pack build ../../crates/ruff_wasm --target web --out-dir ../../playground/ruff/ruff_wasm", + "dev:wasm": "wasm-pack build ../../crates/ruff_wasm --dev --target web --out-dir ../../playground/ruff/ruff_wasm", + "predev:build": "npm run dev:wasm", + "dev:build": "vite build", + "prestart": "npm run dev:wasm", + "start": "vite", + "preview": "vite preview" + }, + "dependencies": { + "@monaco-editor/react": "^4.4.6", + "classnames": "^2.3.2", + "lz-string": "^1.5.0", + "monaco-editor": "^0.52.0", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-resizable-panels": "^3.0.0", + "ruff_wasm": "file:ruff_wasm", + "shared": "0.0.0", + "smol-toml": "^1.3.0" + }, + "overrides": { + "@monaco-editor/react": { + "react": "$react", + "react-dom": "$react-dom" + } + } +} diff --git a/playground/public/Ruff.png b/playground/ruff/public/Ruff.png similarity index 100% rename from playground/public/Ruff.png rename to playground/ruff/public/Ruff.png diff --git a/playground/public/apple-touch-icon.png b/playground/ruff/public/apple-touch-icon.png similarity index 100% rename from playground/public/apple-touch-icon.png rename to playground/ruff/public/apple-touch-icon.png diff --git a/playground/public/favicon-16x16.png b/playground/ruff/public/favicon-16x16.png similarity index 100% rename from playground/public/favicon-16x16.png rename to playground/ruff/public/favicon-16x16.png diff --git a/playground/public/favicon-32x32.png b/playground/ruff/public/favicon-32x32.png similarity index 100% rename from playground/public/favicon-32x32.png rename to playground/ruff/public/favicon-32x32.png diff --git a/playground/public/favicon.ico b/playground/ruff/public/favicon.ico similarity index 100% rename from playground/public/favicon.ico rename to playground/ruff/public/favicon.ico diff --git a/playground/ruff/src/Editor/Chrome.tsx b/playground/ruff/src/Editor/Chrome.tsx new file mode 100644 index 0000000000000..43d798b0d021b --- /dev/null +++ b/playground/ruff/src/Editor/Chrome.tsx @@ -0,0 +1,137 @@ +import ruffSchema from "../../../../ruff.schema.json"; +import { useCallback, useMemo, useRef, useState } from "react"; +import { Header, useTheme, setupMonaco } from "shared"; +import { persist, persistLocal, restore, stringify } from "./settings"; +import { default as Editor, Source } from "./Editor"; +import initRuff, { Workspace } from "ruff_wasm"; +import { loader } from "@monaco-editor/react"; +import { DEFAULT_PYTHON_SOURCE } from "../constants"; + +export default function Chrome() { + const initPromise = useRef<null | Promise<void>>(null); + const [pythonSource, setPythonSource] = useState<null | string>(null); + const [settings, setSettings] = useState<null | string>(null); + const [revision, setRevision] = useState(0); + const [ruffVersion, setRuffVersion] = useState<string | null>(null); + + const [theme, setTheme] = useTheme(); + + const handleShare = useCallback(() => { + if (settings == null || pythonSource == null) { + return; + } + + persist(settings, pythonSource).catch((error) => + // eslint-disable-next-line no-console + console.error(`Failed to share playground: ${error}`), + ); + }, [pythonSource, settings]); + + if (initPromise.current == null) { + initPromise.current = startPlayground() + .then(({ sourceCode, settings, ruffVersion }) => { + setPythonSource(sourceCode); + setSettings(settings); + setRuffVersion(ruffVersion); + setRevision(1); + }) + .catch((error) => { + // eslint-disable-next-line no-console + console.error("Failed to initialize playground.", error); + }); + } + + const handleSourceChanged = useCallback( + (source: string) => { + setPythonSource(source); + setRevision((revision) => revision + 1); + + if (settings != null) { + persistLocal({ pythonSource: source, settingsSource: settings }); + } + }, + [settings], + ); + + const handleSettingsChanged = useCallback( + (settings: string) => { + setSettings(settings); + setRevision((revision) => revision + 1); + + if (pythonSource != null) { + persistLocal({ pythonSource: pythonSource, settingsSource: settings }); + } + }, + [pythonSource], + ); + + const handleResetClicked = useCallback(() => { + const pythonSource = DEFAULT_PYTHON_SOURCE; + const settings = stringify(Workspace.defaultSettings()); + + persistLocal({ pythonSource, settingsSource: settings }); + setPythonSource(pythonSource); + setSettings(settings); + }, []); + + const source: Source | null = useMemo(() => { + if (pythonSource == null || settings == null) { + return null; + } + + return { pythonSource, settingsSource: settings }; + }, [settings, pythonSource]); + + return ( + <main className="flex flex-col h-full bg-ayu-background dark:bg-ayu-background-dark"> + <Header + edit={revision} + theme={theme} + tool="ruff" + version={ruffVersion} + onChangeTheme={setTheme} + onShare={handleShare} + onReset={handleResetClicked} + /> + + <div className="flex grow"> + {source != null && ( + <Editor + theme={theme} + source={source} + onSettingsChanged={handleSettingsChanged} + onSourceChanged={handleSourceChanged} + /> + )} + </div> + </main> + ); +} + +// Run once during startup. Initializes monaco, loads the wasm file, and restores the previous editor state. +async function startPlayground(): Promise<{ + sourceCode: string; + settings: string; + ruffVersion: string; +}> { + await initRuff(); + const monaco = await loader.init(); + + setupMonaco(monaco, { + uri: "https://raw.githubusercontent.com/astral-sh/ruff/main/ruff.schema.json", + fileMatch: ["ruff.json"], + schema: ruffSchema, + }); + + const response = await restore(); + const [settingsSource, pythonSource] = response ?? [ + stringify(Workspace.defaultSettings()), + DEFAULT_PYTHON_SOURCE, + ]; + + return { + sourceCode: pythonSource, + settings: settingsSource, + ruffVersion: Workspace.version(), + }; +} diff --git a/playground/ruff/src/Editor/Diagnostics.tsx b/playground/ruff/src/Editor/Diagnostics.tsx new file mode 100644 index 0000000000000..427e5b24b2ccd --- /dev/null +++ b/playground/ruff/src/Editor/Diagnostics.tsx @@ -0,0 +1,98 @@ +import { Diagnostic } from "ruff_wasm"; +import classNames from "classnames"; +import { Theme } from "shared"; +import { useMemo } from "react"; + +interface Props { + diagnostics: Diagnostic[]; + theme: Theme; + + onGoTo(line: number, column: number): void; +} + +export default function Diagnostics({ + diagnostics: unsorted, + theme, + onGoTo, +}: Props) { + const diagnostics = useMemo(() => { + const sorted = [...unsorted]; + sorted.sort((a, b) => { + if (a.start_location.row === b.start_location.row) { + return a.start_location.column - b.start_location.column; + } + + return a.start_location.row - b.start_location.row; + }); + + return sorted; + }, [unsorted]); + + return ( + <div + className={classNames( + "flex grow flex-col overflow-hidden", + theme === "dark" ? "text-white" : null, + )} + > + <div + className={classNames( + "border-b border-gray-200 px-2 py-1", + theme === "dark" ? "border-rock" : null, + )} + > + Diagnostics ({diagnostics.length}) + </div> + + <div className="flex grow p-2 overflow-hidden"> + <Items diagnostics={diagnostics} onGoTo={onGoTo} /> + </div> + </div> + ); +} + +function Items({ + diagnostics, + onGoTo, +}: { + diagnostics: Array<Diagnostic>; + onGoTo(line: number, column: number): void; +}) { + if (diagnostics.length === 0) { + return ( + <div className={"flex flex-auto flex-col justify-center items-center"}> + Everything is looking good! + </div> + ); + } + + const uniqueIds: Map<string, number> = new Map(); + + return ( + <ul className="space-y-0.5 grow overflow-y-scroll"> + {diagnostics.map((diagnostic) => { + const row = diagnostic.start_location.row; + const column = diagnostic.start_location.column; + const mostlyUniqueId = `${row}:${column}-${diagnostic.code}`; + + const disambiguator = uniqueIds.get(mostlyUniqueId) ?? 0; + uniqueIds.set(mostlyUniqueId, disambiguator + 1); + + return ( + <li key={`${mostlyUniqueId}-${disambiguator}`}> + <button + onClick={() => onGoTo(row, column)} + className="w-full text-start cursor-pointer select-text" + > + {diagnostic.message}{" "} + <span className="text-gray-500"> + {diagnostic.code != null && `(${diagnostic.code})`} [Ln {row}, + Col {column}] + </span> + </button> + </li> + ); + })} + </ul> + ); +} diff --git a/playground/ruff/src/Editor/Editor.tsx b/playground/ruff/src/Editor/Editor.tsx new file mode 100644 index 0000000000000..de085185a7987 --- /dev/null +++ b/playground/ruff/src/Editor/Editor.tsx @@ -0,0 +1,350 @@ +import { + useCallback, + useDeferredValue, + useMemo, + useRef, + useState, +} from "react"; +import { Panel, PanelGroup } from "react-resizable-panels"; +import { Diagnostic, Workspace } from "ruff_wasm"; +import { + ErrorMessage, + Theme, + HorizontalResizeHandle, + VerticalResizeHandle, +} from "shared"; +import PrimarySideBar from "./PrimarySideBar"; +import SecondaryPanel, { + SecondaryPanelResult, + SecondaryTool, +} from "./SecondaryPanel"; +import SecondarySideBar from "./SecondarySideBar"; +import SettingsEditor from "./SettingsEditor"; +import SourceEditor from "./SourceEditor"; +import Diagnostics from "./Diagnostics"; +import { editor } from "monaco-editor"; +import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; + +type Tab = "Source" | "Settings"; + +export interface Source { + pythonSource: string; + settingsSource: string; +} + +interface CheckResult { + diagnostics: Diagnostic[]; + error: string | null; + secondary: SecondaryPanelResult; +} + +type Props = { + source: Source; + theme: Theme; + + onSourceChanged(source: string): void; + onSettingsChanged(settings: string): void; +}; + +export default function Editor({ + source, + theme, + onSourceChanged, + onSettingsChanged, +}: Props) { + const editorRef = useRef<IStandaloneCodeEditor | null>(null); + const [tab, setTab] = useState<Tab>("Source"); + const [secondaryTool, setSecondaryTool] = useState<SecondaryTool | null>( + () => { + const secondaryValue = new URLSearchParams(location.search).get( + "secondary", + ); + if (secondaryValue == null) { + return null; + } else { + return parseSecondaryTool(secondaryValue); + } + }, + ); + const [selection, setSelection] = useState<number | null>(null); + + // Ideally this would be retrieved right from the URL... but routing without a proper + // router is hard (there's no location changed event) and pulling in a router + // feels overkill. + const handleSecondaryToolSelected = (tool: SecondaryTool | null) => { + if (tool === secondaryTool) { + tool = null; + } + + const url = new URL(location.href); + + if (tool == null) { + url.searchParams.delete("secondary"); + } else { + url.searchParams.set("secondary", tool); + } + + history.replaceState(null, "", url); + + setSecondaryTool(tool); + }; + + const handleGoTo = useCallback((line: number, column: number) => { + const editor = editorRef.current; + + if (editor == null) { + return; + } + + const range = { + startLineNumber: line, + startColumn: column, + endLineNumber: line, + endColumn: column, + }; + editor.revealRange(range); + editor.setSelection(range); + }, []); + + const handleSourceEditorMount = useCallback( + (editor: IStandaloneCodeEditor) => { + editorRef.current = editor; + + editor.addAction({ + contextMenuGroupId: "navigation", + contextMenuOrder: 0, + id: "reveal-node", + label: "Reveal node", + precondition: "editorTextFocus", + + run(editor: editor.ICodeEditor): void | Promise<void> { + const position = editor.getPosition(); + if (position == null) { + return; + } + + const offset = editor.getModel()!.getOffsetAt(position); + + setSelection( + charOffsetToByteOffset(editor.getModel()!.getValue(), offset), + ); + }, + }); + }, + [], + ); + + const handleSelectByteRange = useCallback( + (startByteOffset: number, endByteOffset: number) => { + const model = editorRef.current?.getModel(); + + if (model == null || editorRef.current == null) { + return; + } + + const startCharacterOffset = byteOffsetToCharOffset( + source.pythonSource, + startByteOffset, + ); + const endCharacterOffset = byteOffsetToCharOffset( + source.pythonSource, + endByteOffset, + ); + + const start = model.getPositionAt(startCharacterOffset); + const end = model.getPositionAt(endCharacterOffset); + + const range = { + startLineNumber: start.lineNumber, + startColumn: start.column, + endLineNumber: end.lineNumber, + endColumn: end.column, + }; + editorRef.current?.revealRange(range); + editorRef.current?.setSelection(range); + }, + [source.pythonSource], + ); + + const deferredSource = useDeferredValue(source); + + const checkResult: CheckResult = useMemo(() => { + const { pythonSource, settingsSource } = deferredSource; + + try { + const config = JSON.parse(settingsSource); + const workspace = new Workspace(config); + const diagnostics = workspace.check(pythonSource); + + let secondary: SecondaryPanelResult = null; + + try { + switch (secondaryTool) { + case "AST": + secondary = { + status: "ok", + content: workspace.parse(pythonSource), + }; + break; + + case "Format": + secondary = { + status: "ok", + content: workspace.format(pythonSource), + }; + break; + + case "FIR": + secondary = { + status: "ok", + content: workspace.format_ir(pythonSource), + }; + break; + + case "Comments": + secondary = { + status: "ok", + content: workspace.comments(pythonSource), + }; + break; + + case "Tokens": + secondary = { + status: "ok", + content: workspace.tokens(pythonSource), + }; + break; + } + } catch (error: unknown) { + secondary = { + status: "error", + error: error instanceof Error ? error.message : error + "", + }; + } + + return { + diagnostics, + error: null, + secondary, + }; + } catch (e) { + return { + diagnostics: [], + error: (e as Error).message, + secondary: null, + }; + } + }, [deferredSource, secondaryTool]); + + return ( + <> + <PanelGroup direction="horizontal" autoSaveId="main"> + <PrimarySideBar onSelectTool={(tool) => setTab(tool)} selected={tab} /> + + <Panel id="main" order={0} minSize={10}> + <PanelGroup id="vertical" direction="vertical"> + <Panel minSize={10} className="my-2" order={0}> + <SourceEditor + visible={tab === "Source"} + source={source.pythonSource} + theme={theme} + diagnostics={checkResult.diagnostics} + onChange={onSourceChanged} + onMount={handleSourceEditorMount} + /> + <SettingsEditor + visible={tab === "Settings"} + source={source.settingsSource} + theme={theme} + onChange={onSettingsChanged} + /> + </Panel> + {tab === "Source" && ( + <> + <VerticalResizeHandle /> + <Panel + id="diagnostics" + minSize={3} + order={1} + className="my-2 flex grow" + > + <Diagnostics + diagnostics={checkResult.diagnostics} + onGoTo={handleGoTo} + theme={theme} + /> + </Panel> + </> + )} + </PanelGroup> + </Panel> + {secondaryTool != null && ( + <> + <HorizontalResizeHandle /> + <Panel + id="secondary-panel" + order={1} + className={"my-2"} + minSize={10} + > + <SecondaryPanel + theme={theme} + tool={secondaryTool} + result={checkResult.secondary} + selectionOffset={selection} + onSourceByteRangeClicked={handleSelectByteRange} + /> + </Panel> + </> + )} + <SecondarySideBar + selected={secondaryTool} + onSelected={handleSecondaryToolSelected} + /> + </PanelGroup> + + {checkResult.error && tab === "Source" ? ( + <div + style={{ + position: "fixed", + left: "10%", + right: "10%", + bottom: "10%", + }} + > + <ErrorMessage>{checkResult.error}</ErrorMessage> + </div> + ) : null} + </> + ); +} + +function parseSecondaryTool(tool: string): SecondaryTool | null { + if (Object.hasOwn(SecondaryTool, tool)) { + return tool as any; + } + + return null; +} + +function byteOffsetToCharOffset(content: string, byteOffset: number): number { + // Create a Uint8Array from the UTF-8 string + const encoder = new TextEncoder(); + const utf8Bytes = encoder.encode(content); + + // Slice the byte array up to the byteOffset + const slicedBytes = utf8Bytes.slice(0, byteOffset); + + // Decode the sliced bytes to get a substring + const decoder = new TextDecoder("utf-8"); + const decodedString = decoder.decode(slicedBytes); + return decodedString.length; +} + +function charOffsetToByteOffset(content: string, charOffset: number): number { + // Create a Uint8Array from the UTF-8 string + const encoder = new TextEncoder(); + const utf8Bytes = encoder.encode(content.substring(0, charOffset)); + + return utf8Bytes.length; +} diff --git a/playground/src/Editor/PrimarySideBar.tsx b/playground/ruff/src/Editor/PrimarySideBar.tsx similarity index 81% rename from playground/src/Editor/PrimarySideBar.tsx rename to playground/ruff/src/Editor/PrimarySideBar.tsx index c2f7e8b366f65..026e19ef9f27d 100644 --- a/playground/src/Editor/PrimarySideBar.tsx +++ b/playground/ruff/src/Editor/PrimarySideBar.tsx @@ -1,5 +1,4 @@ -import { FileIcon, SettingsIcon } from "./Icons"; -import SideBar, { SideBarEntry } from "./SideBar"; +import { Icons, SideBar, SideBarEntry } from "shared"; type Tool = "Settings" | "Source"; @@ -20,7 +19,7 @@ export default function PrimarySideBar({ onClick={() => onSelectTool("Source")} selected={selected === "Source"} > - <FileIcon /> + <Icons.File /> </SideBarEntry> <SideBarEntry @@ -29,7 +28,7 @@ export default function PrimarySideBar({ onClick={() => onSelectTool("Settings")} selected={selected === "Settings"} > - <SettingsIcon /> + <Icons.Settings /> </SideBarEntry> </SideBar> ); diff --git a/playground/ruff/src/Editor/SecondaryPanel.tsx b/playground/ruff/src/Editor/SecondaryPanel.tsx new file mode 100644 index 0000000000000..4245d92ae17b1 --- /dev/null +++ b/playground/ruff/src/Editor/SecondaryPanel.tsx @@ -0,0 +1,231 @@ +import { Theme } from "shared"; +import { useCallback, useEffect, useState } from "react"; +import { editor, Range } from "monaco-editor"; +import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; +import MonacoEditor from "@monaco-editor/react"; + +export enum SecondaryTool { + "Format" = "Format", + "AST" = "AST", + "Tokens" = "Tokens", + "FIR" = "FIR", + "Comments" = "Comments", +} + +export type SecondaryPanelResult = + | null + | { status: "ok"; content: string } + | { status: "error"; error: string }; + +export type SecondaryPanelProps = { + tool: SecondaryTool; + result: SecondaryPanelResult; + theme: Theme; + selectionOffset: number | null; + onSourceByteRangeClicked(start: number, end: number): void; +}; + +export default function SecondaryPanel({ + tool, + result, + theme, + selectionOffset, + onSourceByteRangeClicked, +}: SecondaryPanelProps) { + return ( + <div className="flex flex-col h-full"> + <div className="grow"> + <Content + tool={tool} + result={result} + theme={theme} + selectionOffset={selectionOffset} + onSourceByteRangeClicked={onSourceByteRangeClicked} + /> + </div> + </div> + ); +} + +function Content({ + tool, + result, + theme, + selectionOffset, + onSourceByteRangeClicked, +}: { + tool: SecondaryTool; + result: SecondaryPanelResult; + theme: Theme; + selectionOffset: number | null; + onSourceByteRangeClicked(start: number, end: number): void; +}) { + const [editor, setEditor] = useState<IStandaloneCodeEditor | null>(null); + const [prevSelection, setPrevSelection] = useState<number | null>(null); + const [ranges, setRanges] = useState< + Array<{ byteRange: { start: number; end: number }; textRange: Range }> + >([]); + + if ( + editor != null && + selectionOffset != null && + selectionOffset !== prevSelection + ) { + const range = ranges.findLast( + (range) => + range.byteRange.start <= selectionOffset && + range.byteRange.end >= selectionOffset, + ); + + if (range != null) { + editor.revealRange(range.textRange); + editor.setSelection(range.textRange); + } + setPrevSelection(selectionOffset); + } + + useEffect(() => { + const model = editor?.getModel(); + if (editor == null || model == null) { + return; + } + + const handler = editor.onMouseDown((event) => { + if (event.target.range == null) { + return; + } + + const range = model + .getDecorationsInRange( + event.target.range, + undefined, + true, + false, + false, + ) + .map((decoration) => { + const decorationRange = decoration.range; + return ranges.find((range) => + Range.equalsRange(range.textRange, decorationRange), + ); + }) + .find((range) => range != null); + + if (range == null) { + return; + } + + onSourceByteRangeClicked(range.byteRange.start, range.byteRange.end); + }); + + return () => handler.dispose(); + }, [editor, onSourceByteRangeClicked, ranges]); + + const handleDidMount = useCallback((editor: IStandaloneCodeEditor) => { + setEditor(editor); + + const model = editor.getModel(); + const collection = editor.createDecorationsCollection([]); + + function updateRanges() { + if (model == null) { + setRanges([]); + collection.set([]); + return; + } + + const matches = model.findMatches( + String.raw`(\d+)\.\.(\d+)`, + false, + true, + false, + ",", + true, + ); + + const ranges = matches + .map((match) => { + const startByteOffset = parseInt(match.matches![1] ?? "", 10); + const endByteOffset = parseInt(match.matches![2] ?? "", 10); + + if (Number.isNaN(startByteOffset) || Number.isNaN(endByteOffset)) { + return null; + } + + return { + byteRange: { start: startByteOffset, end: endByteOffset }, + textRange: match.range, + }; + }) + .filter((range) => range != null); + + setRanges(ranges); + + const decorations = ranges.map((range) => { + return { + range: range.textRange, + options: { + inlineClassName: + "underline decoration-slate-600 decoration-1 cursor-pointer", + }, + }; + }); + + collection.set(decorations); + } + + updateRanges(); + const handler = editor.onDidChangeModelContent(updateRanges); + + return () => handler.dispose(); + }, []); + + if (result == null) { + return ""; + } else { + let language; + switch (result.status) { + case "ok": + switch (tool) { + case "Format": + language = "python"; + break; + + case "AST": + language = "RustPythonAst"; + break; + + case "Tokens": + language = "RustPythonTokens"; + break; + + case "FIR": + language = "fir"; + break; + + case "Comments": + language = "Comments"; + break; + } + + return ( + <MonacoEditor + options={{ + readOnly: true, + minimap: { enabled: false }, + fontSize: 14, + roundedSelection: false, + scrollBeyondLastLine: false, + contextmenu: false, + }} + onMount={handleDidMount} + language={language} + value={result.content} + theme={theme === "light" ? "Ayu-Light" : "Ayu-Dark"} + /> + ); + case "error": + return <code className="whitespace-pre-wrap">{result.error}</code>; + } + } +} diff --git a/playground/ruff/src/Editor/SecondarySideBar.tsx b/playground/ruff/src/Editor/SecondarySideBar.tsx new file mode 100644 index 0000000000000..77ad9d3d722c2 --- /dev/null +++ b/playground/ruff/src/Editor/SecondarySideBar.tsx @@ -0,0 +1,61 @@ +import { Icons, SideBar, SideBarEntry } from "shared"; +import { SecondaryTool } from "./SecondaryPanel"; + +interface RightSideBarProps { + selected: SecondaryTool | null; + onSelected(tool: SecondaryTool): void; +} + +export default function SecondarySideBar({ + selected, + onSelected, +}: RightSideBarProps) { + return ( + <SideBar position="right"> + <SideBarEntry + title="Format" + position={"right"} + selected={selected === SecondaryTool.Format} + onClick={() => onSelected(SecondaryTool.Format)} + > + <Icons.Format /> + </SideBarEntry> + + <SideBarEntry + title="AST" + position={"right"} + selected={selected === SecondaryTool.AST} + onClick={() => onSelected(SecondaryTool.AST)} + > + <Icons.Structure /> + </SideBarEntry> + + <SideBarEntry + title="Tokens" + position={"right"} + selected={selected === SecondaryTool.Tokens} + onClick={() => onSelected(SecondaryTool.Tokens)} + > + <Icons.Token /> + </SideBarEntry> + + <SideBarEntry + title="Formatter IR" + position={"right"} + selected={selected === SecondaryTool.FIR} + onClick={() => onSelected(SecondaryTool.FIR)} + > + <Icons.FormatterIR /> + </SideBarEntry> + + <SideBarEntry + title="Formatter comments" + position={"right"} + selected={selected === SecondaryTool.Comments} + onClick={() => onSelected(SecondaryTool.Comments)} + > + <Icons.Comments /> + </SideBarEntry> + </SideBar> + ); +} diff --git a/playground/src/Editor/SettingsEditor.tsx b/playground/ruff/src/Editor/SettingsEditor.tsx similarity index 97% rename from playground/src/Editor/SettingsEditor.tsx rename to playground/ruff/src/Editor/SettingsEditor.tsx index b97c6bae94ff8..3087848d0af39 100644 --- a/playground/src/Editor/SettingsEditor.tsx +++ b/playground/ruff/src/Editor/SettingsEditor.tsx @@ -3,7 +3,7 @@ */ import { useCallback } from "react"; -import { Theme } from "./theme"; +import { Theme } from "shared"; import MonacoEditor from "@monaco-editor/react"; import { editor } from "monaco-editor"; import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; @@ -91,6 +91,7 @@ export default function SettingsEditor({ model.setValue(JSON.stringify(cleansed, null, 4)); } catch (e) { // Turned out to not be TOML after all. + // eslint-disable-next-line no-console console.warn("Failed to parse settings as TOML", e); } }); @@ -114,6 +115,7 @@ export default function SettingsEditor({ onMount={handleMount} wrapperProps={visible ? {} : { style: { display: "none" } }} language="json" + path="ruff.json" value={source} theme={theme === "light" ? "Ayu-Light" : "Ayu-Dark"} onChange={handleChange} diff --git a/playground/src/Editor/SourceEditor.tsx b/playground/ruff/src/Editor/SourceEditor.tsx similarity index 94% rename from playground/src/Editor/SourceEditor.tsx rename to playground/ruff/src/Editor/SourceEditor.tsx index b5eacfa5fc8e5..a131a4e1533f0 100644 --- a/playground/src/Editor/SourceEditor.tsx +++ b/playground/ruff/src/Editor/SourceEditor.tsx @@ -12,8 +12,8 @@ import { Range, } from "monaco-editor"; import { useCallback, useEffect, useRef } from "react"; -import { Diagnostic } from "../pkg"; -import { Theme } from "./theme"; +import { Diagnostic } from "ruff_wasm"; +import { Theme } from "shared"; import CodeActionProvider = languages.CodeActionProvider; import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; @@ -124,7 +124,7 @@ class RuffCodeActionProvider implements CodeActionProvider { range: Range, ): languages.ProviderResult<languages.CodeActionList> { const actions = this.diagnostics - .filter((check) => range.startLineNumber === check.location.row) + .filter((check) => range.startLineNumber === check.start_location.row) .filter(({ fix }) => fix) .map((check) => ({ title: check.fix @@ -173,8 +173,8 @@ function updateMarkers(monaco: Monaco, diagnostics: Array<Diagnostic>) { model, "owner", diagnostics.map((diagnostic) => ({ - startLineNumber: diagnostic.location.row, - startColumn: diagnostic.location.column, + startLineNumber: diagnostic.start_location.row, + startColumn: diagnostic.start_location.column, endLineNumber: diagnostic.end_location.row, endColumn: diagnostic.end_location.column, message: diagnostic.code diff --git a/playground/src/Editor/api.ts b/playground/ruff/src/Editor/api.ts similarity index 100% rename from playground/src/Editor/api.ts rename to playground/ruff/src/Editor/api.ts diff --git a/playground/src/Editor/index.tsx b/playground/ruff/src/Editor/index.tsx similarity index 100% rename from playground/src/Editor/index.tsx rename to playground/ruff/src/Editor/index.tsx diff --git a/playground/src/Editor/settings.ts b/playground/ruff/src/Editor/settings.ts similarity index 100% rename from playground/src/Editor/settings.ts rename to playground/ruff/src/Editor/settings.ts diff --git a/playground/src/constants.ts b/playground/ruff/src/constants.ts similarity index 100% rename from playground/src/constants.ts rename to playground/ruff/src/constants.ts diff --git a/playground/ruff/src/index.css b/playground/ruff/src/index.css new file mode 100644 index 0000000000000..ddf502c867552 --- /dev/null +++ b/playground/ruff/src/index.css @@ -0,0 +1,126 @@ +@import "tailwindcss"; + +@source "../../shared/"; + +@custom-variant dark (&:is(.dark *)); + +@theme { + --color-ayu-accent: #ffac2f; + + --color-ayu-background: #f8f9fa; + --color-ayu-background-dark: #0b0e14; + + --color-black: #261230; + --color-white: #ffffff; + --color-radiate: #d7ff64; + --color-flare: #6340ac; + --color-rock: #78876e; + --color-galaxy: #261230; + --color-space: #30173d; + --color-comet: #6f5d6f; + --color-cosmic: #de5fe9; + --color-sun: #ffac2f; + --color-electron: #46ebe1; + --color-aurora: #46eb74; + --color-constellation: #5f6de9; + --color-neutron: #cff3cf; + --color-proton: #f6afbc; + --color-nebula: #cdcbfb; + --color-supernova: #f1aff6; + --color-starlight: #f4f4f1; + --color-lunar: #fbf2fc; + --color-asteroid: #e3cee3; + --color-crater: #f0dfdf; + + --font-heading: + Alliance Platt, system-ui, -apple-system, Segoe UI, Roboto, Helvetica, + Arial, monospace, Apple Color Emoji, Segoe UI Emoji; + --font-body: + Alliance Text, system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial, + sans-serif, Apple Color Emoji, Segoe UI Emoji; + --font-mono: + Roboto Mono, ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, + "Liberation Mono", "Courier New", monospace; + + --text-xs: 0.75rem; + --text-sm: 0.875rem; + --text-base: 1rem; + --text-lg: 1.125rem; + --text-xl: 1.25rem; + --text-2xl: 1.5rem; + --text-3xl: 1.875rem; + --text-4xl: 2.25rem; + --text-5xl: 3rem; +} + +* { + box-sizing: border-box; +} + +body, +html, +#root { + margin: 0; + height: 100%; + width: 100%; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +.shadow-copied { + --tw-shadow: 0 0 0 1px var(--color-white), inset 0 0 0 1px var(--color-white); + --tw-shadow-colored: + 0 0 0 1px var(--tw-shadow-color), inset 0 0 0 1px var(--tw-shadow-color); + + box-shadow: + var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), + var(--tw-shadow); +} + +@font-face { + font-family: "Alliance Text"; + src: + url("https://static.astral.sh/fonts/Alliance-TextRegular.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-TextRegular.woff") + format("woff"); + font-weight: normal; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Text"; + src: + url("https://static.astral.sh/fonts/Alliance-TextMedium.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-TextMedium.woff") + format("woff"); + font-weight: 500; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Platt"; + src: + url("https://static.astral.sh/fonts/Alliance-PlattMedium.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-PlattMedium.woff") + format("woff"); + font-weight: 500; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Platt"; + src: + url("https://static.astral.sh/fonts/Alliance-PlattRegular.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-PlattRegular.woff") + format("woff"); + font-weight: normal; + font-style: normal; + font-display: block; +} diff --git a/playground/src/main.tsx b/playground/ruff/src/main.tsx similarity index 100% rename from playground/src/main.tsx rename to playground/ruff/src/main.tsx diff --git a/playground/src/third-party.d.ts b/playground/ruff/src/third-party.d.ts similarity index 100% rename from playground/src/third-party.d.ts rename to playground/ruff/src/third-party.d.ts diff --git a/playground/src/vite-env.d.ts b/playground/ruff/src/vite-env.d.ts similarity index 100% rename from playground/src/vite-env.d.ts rename to playground/ruff/src/vite-env.d.ts diff --git a/playground/ruff/vite.config.ts b/playground/ruff/vite.config.ts new file mode 100644 index 0000000000000..4667d4047f85e --- /dev/null +++ b/playground/ruff/vite.config.ts @@ -0,0 +1,8 @@ +import { defineConfig } from "vite"; +import tailwindcss from "@tailwindcss/vite"; +import react from "@vitejs/plugin-react-swc"; + +// https://vitejs.dev/config/ +export default defineConfig({ + plugins: [react(), tailwindcss()], +}); diff --git a/playground/shared/package.json b/playground/shared/package.json new file mode 100644 index 0000000000000..50b86da136b6a --- /dev/null +++ b/playground/shared/package.json @@ -0,0 +1,13 @@ +{ + "name": "shared", + "private": true, + "version": "0.0.0", + "type": "module", + "dependencies": { + "@monaco-editor/react": "^4.7.0", + "classnames": "^2.3.2", + "react": "^19.0.0", + "react-resizable-panels": "^3.0.0" + }, + "exports": "./src/index.ts" +} diff --git a/playground/src/Editor/AstralButton.tsx b/playground/shared/src/AstralButton.tsx similarity index 93% rename from playground/src/Editor/AstralButton.tsx rename to playground/shared/src/AstralButton.tsx index 099b5313f8449..8776eaff18860 100644 --- a/playground/src/Editor/AstralButton.tsx +++ b/playground/shared/src/AstralButton.tsx @@ -12,11 +12,13 @@ export default function AstralButton({ "uppercase", "ease-in-out", "font-heading", + "outline-radiate", "transition-all duration-200", "bg-radiate", "text-black", "hover:text-white", "hover:bg-galaxy", + "cursor-pointer", "outline-1", "dark:outline", "dark:hover:outline-white", diff --git a/playground/shared/src/ErrorMessage.tsx b/playground/shared/src/ErrorMessage.tsx new file mode 100644 index 0000000000000..e48c87aea5e25 --- /dev/null +++ b/playground/shared/src/ErrorMessage.tsx @@ -0,0 +1,15 @@ +export function ErrorMessage({ children }: { children: string }) { + return ( + <div + className="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4" + role="alert" + > + <p className="font-bold">Error</p> + <p className="block sm:inline"> + {children.startsWith("Error: ") + ? children.slice("Error: ".length) + : children} + </p> + </div> + ); +} diff --git a/playground/shared/src/Header.tsx b/playground/shared/src/Header.tsx new file mode 100644 index 0000000000000..694ec20a25c9d --- /dev/null +++ b/playground/shared/src/Header.tsx @@ -0,0 +1,140 @@ +import classNames from "classnames"; +import RepoButton from "./RepoButton"; +import ThemeButton from "./ThemeButton"; +import ShareButton from "./ShareButton"; +import { Theme } from "./theme"; +import VersionTag from "./VersionTag"; +import AstralButton from "./AstralButton"; + +export default function Header({ + edit, + theme, + tool, + version, + onChangeTheme, + onReset, + onShare, +}: { + edit: number | null; + theme: Theme; + tool: "ruff" | "ty"; + version: string | null; + onChangeTheme: (theme: Theme) => void; + onReset?(): void; + onShare: () => void; +}) { + return ( + <div + className=" + w-full + flex + justify-between + antialiased + border-b + border-gray-200 + dark:border-b-radiate + dark:bg-galaxy + " + > + <div className="py-4 pl-2"> + <Logo name={tool} className="fill-galaxy dark:fill-radiate" /> + </div> + <div className="flex items-center min-w-0 gap-4 mx-2"> + {version ? ( + <div className="hidden sm:flex"> + <VersionTag>v{version}</VersionTag> + </div> + ) : null} + <Divider /> + <RepoButton href={`https://github.com/astral-sh/${tool}`} /> + <Divider /> + <div className="max-sm:hidden flex"> + <ResetButton onClicked={onReset} /> + </div> + <div className="max-sm:hidden flex"> + <ShareButton key={edit} onShare={onShare} /> + </div> + <Divider /> + + <ThemeButton theme={theme} onChange={onChangeTheme} /> + </div> + </div> + ); +} + +function Divider() { + return ( + <div + className={classNames( + "max-sm:hidden", + "visible", + "w-px", + "h-8", + "bg-gray-200", + "dark:bg-gray-700", + )} + /> + ); +} + +function Logo({ name, className }: { name: "ruff" | "ty"; className: string }) { + switch (name) { + case "ruff": + return ( + <svg + height={32} + viewBox="0 0 272 64" + className={className} + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M61.5 0C62.8807 0 64 1.11929 64 2.5V32.06C64 33.4407 62.8807 34.56 61.5 34.56H51.2V39.68H64V64H34.56V44.8H29.44V64H0V0H61.5ZM39.68 29.44V24.32H24.32V29.44H39.68ZM69.12 0H98.56V41.6H103.68V0H133.12V61.5C133.12 62.8807 132.001 64 130.62 64H71.62C70.2393 64 69.12 62.8807 69.12 61.5V0ZM202.24 0H145.86C144.479 0 143.36 1.11929 143.36 2.5V29.44H138.24V53.76H143.36V64H172.8V53.76H199.74C201.121 53.76 202.24 52.6407 202.24 51.26V29.44H172.8V24.32H202.24V0ZM214.98 0H271.36V24.32H241.92V29.44H271.36V51.26C271.36 52.6407 270.241 53.76 268.86 53.76H241.92V64H212.48V53.76H207.36V29.44H212.48V2.5C212.48 1.11929 213.599 0 214.98 0Z" + /> + </svg> + ); + case "ty": + return ( + <svg + height={32} + viewBox="0 0 640 100" + fill="none" + xmlns="http://www.w3.org/2000/svg" + className={className} + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M431.998 9.98526C431.998 4.47055 436.469 0 441.984 0H522.013C527.528 0 531.998 4.47056 531.998 9.98526V100H485.998V70H477.998V100H431.998V9.98526ZM493.998 46V38H469.998V46H493.998Z" + /> + <path + fillRule="evenodd" + clipRule="evenodd" + d="M0 9.98526C0 4.47055 4.47055 0 9.98526 0H90.0147C95.5294 0 99.9999 4.47056 99.9999 9.98526V100H54V70H46V100H0V9.98526ZM62 46V38H38V46H62Z" + /> + <path d="M107.998 9.98526C107.998 4.47055 112.469 0 117.983 0H198.013C203.527 0 207.998 4.47055 207.998 9.98526V30H161.998V22H153.998V38H198.013C203.527 38 207.998 42.4706 207.998 47.9853V90.0147C207.998 95.5294 203.527 100 198.013 100H117.983C112.469 100 107.998 95.5294 107.998 90.0147V70L153.998 70V78H161.998V62L117.983 62C112.469 62 107.998 57.5294 107.998 52.0147V9.98526Z" /> + <path d="M315.998 16H269.998V0H223.998V16H215.998V54H223.998V90.0147C223.998 95.5294 228.469 100 233.983 100H315.998V62H269.998V54H306.013C311.527 54 315.998 49.5294 315.998 44.0147V16Z" /> + <path + fillRule="evenodd" + clipRule="evenodd" + d="M423.998 9.98526C423.998 4.47055 419.528 0 414.013 0H323.998V100H369.998V70H377.998V100H423.998V62H403.998V54H414.013C419.528 54 423.998 49.5294 423.998 44.0147V9.98526ZM385.998 38V46H361.998V38H385.998Z" + /> + <path d="M585.999 62L639.998 62V100H539.999V2.18557e-06L585.999 0L585.999 62Z" /> + </svg> + ); + } +} + +function ResetButton({ onClicked }: { onClicked?: () => void }) { + return ( + <AstralButton + type="button" + className="relative flex-none leading-6 py-1.5 px-3 shadow-xs disabled:opacity-50" + disabled={onClicked == null} + onClick={onClicked} + > + Reset + </AstralButton> + ); +} diff --git a/playground/shared/src/Icons.tsx b/playground/shared/src/Icons.tsx new file mode 100644 index 0000000000000..4c6c4bbfbb63e --- /dev/null +++ b/playground/shared/src/Icons.tsx @@ -0,0 +1,282 @@ +// Icons from the [VS code icon set](https://github.com/microsoft/vscode-icons/). +// +// Icon-LICENSE: +// MIT License +// +// Copyright (c) Microsoft Corporation. +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE + +export function File({ + width = 24, + height = 24, +}: { + width?: number; + height?: number; +}) { + return ( + <svg + width={width} + height={height} + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M10.57 1.14L13.85 4.44L14 4.8V14.5L13.5 15H2.5L2 14.5V1.5L2.5 1H10.22L10.57 1.14ZM10 5H13L10 2V5ZM3 2V14H13V6H9.5L9 5.5V2H3ZM5.062 9.533L6.879 7.705L6.17 7L4 9.179V9.886L6.171 12.06L6.878 11.353L5.062 9.533ZM8.8 7.714L9.5 7.005L11.689 9.18V9.889L9.5 12.062L8.795 11.353L10.626 9.533L8.8 7.714Z" + /> + </svg> + ); +} + +export function Run({ + width = 24, + height = 24, +}: { + width?: number; + height?: number; +}) { + return ( + <svg + width={width} + height={height} + viewBox="0 0 16 16" + fill="none" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M4.00024 2V14.4805L12.9149 8.24024L4.00024 2ZM11.1812 8.24024L4.99524 12.5684V3.91209L11.1812 8.24024Z" + fill="#ffffff" + /> + </svg> + ); +} + +export function Settings() { + return ( + <svg + width="24" + height="24" + viewBox="0 0 24 24" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M19.85 8.75L24 9.57996V14.42L19.85 15.25L22.2 18.77L18.77 22.2L15.25 19.85L14.42 24H9.57996L8.75 19.85L5.22998 22.2L1.80005 18.77L4.15002 15.25L0 14.42V9.57996L4.15002 8.75L1.80005 5.22998L5.22998 1.80005L8.75 4.15002L9.57996 0H14.42L15.25 4.15002L18.77 1.80005L22.2 5.22998L19.85 8.75ZM18.28 13.8199L22.28 13.01V11.01L18.28 10.2L17.74 8.90002L20.03 5.46997L18.6 4.04004L15.17 6.32996L13.87 5.79004L13.0601 1.79004H11.0601L10.25 5.79004L8.94995 6.32996L5.52002 4.04004L4.08997 5.46997L6.38 8.90002L5.83997 10.2L1.83997 11.01V13.01L5.83997 13.8199L6.38 15.12L4.08997 18.55L5.52002 19.98L8.94995 17.6899L10.25 18.23L11.0601 22.23H13.0601L13.87 18.23L15.17 17.6899L18.6 19.98L20.03 18.55L17.74 15.12L18.28 13.8199ZM10.0943 9.14807C10.6584 8.77118 11.3216 8.56995 12 8.56995C12.9089 8.57258 13.7798 8.93484 14.4225 9.57751C15.0652 10.2202 15.4274 11.0911 15.43 12C15.43 12.6784 15.2288 13.3416 14.8519 13.9056C14.475 14.4697 13.9394 14.9093 13.3126 15.1689C12.6859 15.4286 11.9962 15.4965 11.3308 15.3641C10.6654 15.2318 10.0543 14.9051 9.57457 14.4254C9.09488 13.9457 8.7682 13.3345 8.63585 12.6692C8.50351 12.0038 8.57143 11.3141 8.83104 10.6874C9.09065 10.0606 9.53029 9.52496 10.0943 9.14807ZM11.0499 13.4218C11.3311 13.6097 11.6618 13.71 12 13.71C12.2249 13.7113 12.4479 13.668 12.656 13.5825C12.8641 13.4971 13.0531 13.3712 13.2121 13.2122C13.3712 13.0531 13.497 12.8641 13.5825 12.656C13.668 12.4479 13.7113 12.2249 13.7099 12C13.7099 11.6618 13.6096 11.3311 13.4217 11.0499C13.2338 10.7687 12.9669 10.5496 12.6544 10.4202C12.3419 10.2907 11.9981 10.2569 11.6664 10.3229C11.3347 10.3889 11.03 10.5517 10.7909 10.7909C10.5517 11.03 10.3888 11.3347 10.3229 11.6664C10.2569 11.9981 10.2907 12.342 10.4202 12.6544C10.5496 12.9669 10.7687 13.2339 11.0499 13.4218Z" + /> + </svg> + ); +} + +export function Structure() { + return ( + <svg + width="24" + height="24" + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M2 2L1 3V6L2 7H14L15 6V3L14 2H2ZM2 3H3H13H14V4V5V6H13H3H2V5V4V3ZM1 10L2 9H5L6 10V13L5 14H2L1 13V10ZM3 10H2V11V12V13H3H4H5V12V11V10H4H3ZM10 10L11 9H14L15 10V13L14 14H11L10 13V10ZM12 10H11V11V12V13H12H13H14V12V11V10H13H12Z" + /> + </svg> + ); +} + +export function Format() { + return ( + <svg + width="24" + height="24" + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M6 2.98361V2.97184V2H5.91083C5.59743 2 5.29407 2.06161 5.00128 2.18473C4.70818 2.30798 4.44942 2.48474 4.22578 2.71498C4.00311 2.94422 3.83792 3.19498 3.73282 3.46766L3.73233 3.46898C3.63382 3.7352 3.56814 4.01201 3.53533 4.29917L3.53519 4.30053C3.50678 4.5805 3.4987 4.86844 3.51084 5.16428C3.52272 5.45379 3.52866 5.74329 3.52866 6.03279C3.52866 6.23556 3.48974 6.42594 3.412 6.60507L3.4116 6.60601C3.33687 6.78296 3.23423 6.93866 3.10317 7.07359C2.97644 7.20405 2.82466 7.31055 2.64672 7.3925C2.4706 7.46954 2.28497 7.5082 2.08917 7.5082H2V7.6V8.4V8.4918H2.08917C2.28465 8.4918 2.47001 8.53238 2.64601 8.61334L2.64742 8.61396C2.82457 8.69157 2.97577 8.79762 3.10221 8.93161L3.10412 8.93352C3.23428 9.0637 3.33659 9.21871 3.41129 9.39942L3.41201 9.40108C3.48986 9.58047 3.52866 9.76883 3.52866 9.96721C3.52866 10.2567 3.52272 10.5462 3.51084 10.8357C3.4987 11.1316 3.50677 11.4215 3.53516 11.7055L3.53535 11.7072C3.56819 11.9903 3.63387 12.265 3.73232 12.531L3.73283 12.5323C3.83793 12.805 4.00311 13.0558 4.22578 13.285C4.44942 13.5153 4.70818 13.692 5.00128 13.8153C5.29407 13.9384 5.59743 14 5.91083 14H6V13.2V13.0164H5.91083C5.71095 13.0164 5.52346 12.9777 5.34763 12.9008C5.17396 12.8191 5.02194 12.7126 4.89086 12.5818C4.76386 12.4469 4.66104 12.2911 4.58223 12.1137C4.50838 11.9346 4.47134 11.744 4.47134 11.541C4.47134 11.3127 4.4753 11.0885 4.48321 10.8686C4.49125 10.6411 4.49127 10.4195 4.48324 10.2039C4.47914 9.98246 4.46084 9.76883 4.42823 9.56312C4.39513 9.35024 4.33921 9.14757 4.26039 8.95536C4.18091 8.76157 4.07258 8.57746 3.93616 8.40298C3.82345 8.25881 3.68538 8.12462 3.52283 8C3.68538 7.87538 3.82345 7.74119 3.93616 7.59702C4.07258 7.42254 4.18091 7.23843 4.26039 7.04464C4.33913 6.85263 4.39513 6.65175 4.42826 6.44285C4.46082 6.2333 4.47914 6.01973 4.48324 5.80219C4.49127 5.58262 4.49125 5.36105 4.48321 5.13749C4.4753 4.9134 4.47134 4.68725 4.47134 4.45902C4.47134 4.26019 4.50833 4.07152 4.58238 3.89205C4.66135 3.71034 4.76421 3.55475 4.89086 3.42437C5.02193 3.28942 5.17461 3.18275 5.34802 3.10513C5.5238 3.02427 5.71113 2.98361 5.91083 2.98361H6ZM10 13.0164V13.0282V14H10.0892C10.4026 14 10.7059 13.9384 10.9987 13.8153C11.2918 13.692 11.5506 13.5153 11.7742 13.285C11.9969 13.0558 12.1621 12.805 12.2672 12.5323L12.2677 12.531C12.3662 12.2648 12.4319 11.988 12.4647 11.7008L12.4648 11.6995C12.4932 11.4195 12.5013 11.1316 12.4892 10.8357C12.4773 10.5462 12.4713 10.2567 12.4713 9.96721C12.4713 9.76444 12.5103 9.57406 12.588 9.39493L12.5884 9.39399C12.6631 9.21704 12.7658 9.06134 12.8968 8.92642C13.0236 8.79595 13.1753 8.68945 13.3533 8.6075C13.5294 8.53046 13.715 8.4918 13.9108 8.4918H14V8.4V7.6V7.5082H13.9108C13.7153 7.5082 13.53 7.46762 13.354 7.38666L13.3526 7.38604C13.1754 7.30844 13.0242 7.20238 12.8978 7.06839L12.8959 7.06648C12.7657 6.9363 12.6634 6.78129 12.5887 6.60058L12.588 6.59892C12.5101 6.41953 12.4713 6.23117 12.4713 6.03279C12.4713 5.74329 12.4773 5.45379 12.4892 5.16428C12.5013 4.86842 12.4932 4.57848 12.4648 4.29454L12.4646 4.29285C12.4318 4.00971 12.3661 3.73502 12.2677 3.46897L12.2672 3.46766C12.1621 3.19499 11.9969 2.94422 11.7742 2.71498C11.5506 2.48474 11.2918 2.30798 10.9987 2.18473C10.7059 2.06161 10.4026 2 10.0892 2H10V2.8V2.98361H10.0892C10.2891 2.98361 10.4765 3.0223 10.6524 3.09917C10.826 3.18092 10.9781 3.28736 11.1091 3.41823C11.2361 3.55305 11.339 3.70889 11.4178 3.88628C11.4916 4.0654 11.5287 4.25596 11.5287 4.45902C11.5287 4.68727 11.5247 4.91145 11.5168 5.13142C11.5088 5.35894 11.5087 5.58049 11.5168 5.79605C11.5209 6.01754 11.5392 6.23117 11.5718 6.43688C11.6049 6.64976 11.6608 6.85243 11.7396 7.04464C11.8191 7.23843 11.9274 7.42254 12.0638 7.59702C12.1765 7.74119 12.3146 7.87538 12.4772 8C12.3146 8.12462 12.1765 8.25881 12.0638 8.40298C11.9274 8.57746 11.8191 8.76157 11.7396 8.95536C11.6609 9.14737 11.6049 9.34825 11.5717 9.55715C11.5392 9.7667 11.5209 9.98027 11.5168 10.1978C11.5087 10.4174 11.5087 10.6389 11.5168 10.8625C11.5247 11.0866 11.5287 11.3128 11.5287 11.541C11.5287 11.7398 11.4917 11.9285 11.4176 12.1079C11.3386 12.2897 11.2358 12.4452 11.1091 12.5756C10.9781 12.7106 10.8254 12.8173 10.652 12.8949C10.4762 12.9757 10.2889 13.0164 10.0892 13.0164H10Z" + /> + </svg> + ); +} + +export function Token() { + return ( + <svg + width="24" + height="24" + viewBox="0 0 24 24" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M19.5 0V1.5L21 3V22.5L19.5 24H4.5L3 22.5V3L4.5 1.5V0H6V1.5H9V0H10.5V1.5H13.5V0H15V1.5H18V0H19.5ZM4.5 22.5H19.5V3H4.5V22.5ZM7.5 6H16.5V7.5H7.5V6ZM16.5 12H7.5V13.5H16.5V12ZM7.5 18H16.5V19.5H7.5V18Z" + /> + </svg> + ); +} + +export function FormatterIR() { + return ( + <svg + width="24" + height="24" + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M4 2H12V6C12.3415 6.03511 12.6774 6.11234 13 6.22998V1H3V9.47998L4 7.72998V2ZM6.14001 10L5 8L4 9.75L3.29004 11L1 15H9L6.70996 11L6.14001 10ZM2.71997 14L4.43994 11L5 10L5.56006 11L7.28003 14H2.71997ZM9.55552 7.58984C10.1311 7.20526 10.8077 7 11.5 7C12.4282 7 13.3185 7.36877 13.9748 8.02515C14.6312 8.68152 15 9.57174 15 10.5C15 11.1922 14.7947 11.8689 14.4101 12.4445C14.0256 13.02 13.4789 13.4686 12.8393 13.7335C12.1998 13.9984 11.4961 14.0678 10.8171 13.9327C10.1382 13.7977 9.51461 13.4643 9.02513 12.9749C8.53564 12.4854 8.20229 11.8618 8.06724 11.1829C7.93219 10.5039 8.00155 9.80019 8.26646 9.16064C8.53137 8.5211 8.97995 7.97443 9.55552 7.58984ZM10.1111 12.5786C10.5222 12.8533 11.0055 13 11.5 13C12.163 13 12.799 12.7367 13.2678 12.2678C13.7366 11.799 14 11.163 14 10.5C14 10.0055 13.8533 9.52221 13.5786 9.11108C13.3039 8.69996 12.9135 8.37953 12.4566 8.19031C11.9998 8.00109 11.4973 7.95163 11.0123 8.0481C10.5274 8.14456 10.0818 8.38255 9.73216 8.73218C9.38253 9.08181 9.14454 9.52738 9.04808 10.0123C8.95161 10.4973 9.00107 10.9998 9.19029 11.4567C9.37951 11.9135 9.69994 12.3039 10.1111 12.5786Z" + /> + </svg> + ); +} + +export function Comments() { + return ( + <svg + viewBox="0 0 24 24" + xmlns="http://www.w3.org/2000/svg" + width={24} + height={24} + > + <path + d="M7.7,18.3H19.4a2.1,2.1,0,0,0,2.1-2.1V4.6a2.1,2.1,0,0,0-2.1-2.1H4.6A2.1,2.1,0,0,0,2.5,4.6V21.5Z" + stroke="#ffffff" + fill="none" + ></path> + </svg> + ); +} + +export function Add() { + return ( + <svg + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + className="fill-current" + width={16} + height={16} + > + <path d="M14.0004 7V8H8.00037V14H7.00037V8H1.00037V7H7.00037V1H8.00037V7H14.0004Z" /> + </svg> + ); +} + +export function Close() { + return ( + <svg + viewBox="0 0 16 16" + xmlns="http://www.w3.org/2000/svg" + className="fill-current" + width={16} + height={16} + > + <path + fillRule="evenodd" + clipRule="evenodd" + d="M8.00028 8.70711L11.6467 12.3536L12.3538 11.6465L8.70739 8.00001L12.3538 4.35356L11.6467 3.64645L8.00028 7.2929L4.35384 3.64645L3.64673 4.35356L7.29317 8.00001L3.64673 11.6465L4.35384 12.3536L8.00028 8.70711Z" + /> + </svg> + ); +} + +// https://github.com/material-extensions/vscode-material-icon-theme/blob/main/icons/python.svg +export function Python({ + height = 24, + width = 24, +}: { + height?: number; + width?: number; +}) { + return ( + <svg + viewBox="0 0 24 24" + xmlns="http://www.w3.org/2000/svg" + width={width} + height={height} + > + <path + fill="#0288D1" + d="M9.86 2A2.86 2.86 0 0 0 7 4.86v1.68h4.29c.39 0 .71.57.71.96H4.86A2.86 2.86 0 0 0 2 10.36v3.781a2.86 2.86 0 0 0 2.86 2.86h1.18v-2.68a2.85 2.85 0 0 1 2.85-2.86h5.25c1.58 0 2.86-1.271 2.86-2.851V4.86A2.86 2.86 0 0 0 14.14 2zm-.72 1.61c.4 0 .72.12.72.71s-.32.891-.72.891c-.39 0-.71-.3-.71-.89s.32-.711.71-.711z" + /> + <path + fill="#fdd835" + d="M17.959 7v2.68a2.85 2.85 0 0 1-2.85 2.859H9.86A2.85 2.85 0 0 0 7 15.389v3.75a2.86 2.86 0 0 0 2.86 2.86h4.28A2.86 2.86 0 0 0 17 19.14v-1.68h-4.291c-.39 0-.709-.57-.709-.96h7.14A2.86 2.86 0 0 0 22 13.64V9.86A2.86 2.86 0 0 0 19.14 7zM8.32 11.513l-.004.004c.012-.002.025-.001.038-.004zm6.54 7.276c.39 0 .71.3.71.89a.71.71 0 0 1-.71.71c-.4 0-.72-.12-.72-.71s.32-.89.72-.89z" + /> + </svg> + ); +} + +/** https://github.com/material-extensions/vscode-material-icon-theme/blob/main/icons/json.svg */ +export function Json({ + height = 24, + width = 24, +}: { + height?: number; + width?: number; +}) { + return ( + <svg + xmlns="http://www.w3.org/2000/svg" + viewBox="0 -960 960 960" + width={width} + height={height} + > + <path + fill="#f9a825" + d="M560-160v-80h120q17 0 28.5-11.5T720-280v-80q0-38 22-69t58-44v-14q-36-13-58-44t-22-69v-80q0-17-11.5-28.5T680-720H560v-80h120q50 0 85 35t35 85v80q0 17 11.5 28.5T840-560h40v160h-40q-17 0-28.5 11.5T800-360v80q0 50-35 85t-85 35zm-280 0q-50 0-85-35t-35-85v-80q0-17-11.5-28.5T120-400H80v-160h40q17 0 28.5-11.5T160-600v-80q0-50 35-85t85-35h120v80H280q-17 0-28.5 11.5T240-680v80q0 38-22 69t-58 44v14q36 13 58 44t22 69v80q0 17 11.5 28.5T280-240h120v80z" + /> + </svg> + ); +} + +/** https://github.com/material-extensions/vscode-material-icon-theme/blob/main/icons/jupyter.svg **/ +export function Jupyter({ + height = 24, + width = 24, +}: { + height?: number; + width?: number; +}) { + return ( + <svg + xmlns="http://www.w3.org/2000/svg" + viewBox="0 0 32 32" + width={width} + height={height} + > + <path + fill="#f57c00" + d="M6.2 18a22.7 22.7 0 0 0 9.8 2 22.7 22.7 0 0 0 9.8-2 10.002 10.002 0 0 1-19.6 0m19.6-4a22.7 22.7 0 0 0-9.8-2 22.7 22.7 0 0 0-9.8 2 10.002 10.002 0 0 1 19.6 0" + /> + <circle cx="27" cy="5" r="3" fill="#757575" /> + <circle cx="5" cy="27" r="3" fill="#9e9e9e" /> + <circle cx="5" cy="5" r="3" fill="#616161" /> + </svg> + ); +} diff --git a/playground/src/Editor/RepoButton.tsx b/playground/shared/src/RepoButton.tsx similarity index 86% rename from playground/src/Editor/RepoButton.tsx rename to playground/shared/src/RepoButton.tsx index 1834d4dc4c4a7..a992810f48ee4 100644 --- a/playground/src/Editor/RepoButton.tsx +++ b/playground/shared/src/RepoButton.tsx @@ -1,11 +1,6 @@ -export default function RepoButton() { +export default function RepoButton({ href }: { href: string }) { return ( - <a - className="rounded-full" - href="https://github.com/astral-sh/ruff" - target="_blank" - rel="noreferrer" - > + <a className="rounded-full" href={href} target="_blank" rel="noreferrer"> <svg xmlns="http://www.w3.org/2000/svg" width="24" diff --git a/playground/src/Editor/ResizeHandle.tsx b/playground/shared/src/ResizeHandle.tsx similarity index 100% rename from playground/src/Editor/ResizeHandle.tsx rename to playground/shared/src/ResizeHandle.tsx diff --git a/playground/src/Editor/ShareButton.tsx b/playground/shared/src/ShareButton.tsx similarity index 78% rename from playground/src/Editor/ShareButton.tsx rename to playground/shared/src/ShareButton.tsx index 4938639e50039..65fdca5da7041 100644 --- a/playground/src/Editor/ShareButton.tsx +++ b/playground/shared/src/ShareButton.tsx @@ -1,7 +1,7 @@ import { useEffect, useState } from "react"; import AstralButton from "./AstralButton"; -export default function ShareButton({ onShare }: { onShare?: () => void }) { +export default function ShareButton({ onShare }: { onShare: () => void }) { const [copied, setCopied] = useState(false); useEffect(() => { @@ -27,16 +27,12 @@ export default function ShareButton({ onShare }: { onShare?: () => void }) { ) : ( <AstralButton type="button" - className="relative flex-none leading-6 py-1.5 px-3 shadow-sm disabled:opacity-50" - disabled={!onShare || copied} - onClick={ - onShare - ? () => { - setCopied(true); - onShare(); - } - : undefined - } + className="relative flex-none leading-6 py-1.5 px-3 shadow-xs disabled:opacity-50" + disabled={copied} + onClick={() => { + setCopied(true); + onShare(); + }} > <span className="absolute inset-0 flex items-center justify-center" diff --git a/playground/src/Editor/SideBar.tsx b/playground/shared/src/SideBar.tsx similarity index 83% rename from playground/src/Editor/SideBar.tsx rename to playground/shared/src/SideBar.tsx index 4651c59da51f5..497bcf8415be4 100644 --- a/playground/src/Editor/SideBar.tsx +++ b/playground/shared/src/SideBar.tsx @@ -10,7 +10,7 @@ export default function SideBar({ children, position }: SideBarProps) { return ( <ul className={classNames( - "w-12 flex-initial flex flex-col items-stretch bg-galaxy", + "w-12 flex-initial flex flex-col items-stretch bg-galaxy border-gray-200", position === "left" ? "border-r" : "border-l", )} > @@ -40,7 +40,7 @@ export function SideBarEntry({ aria-label={title} onClick={onClick} role="button" - className={`group py-4 px-2 relative flex items-center justify-center flex-col fill-white text-white ${ + className={`group py-4 px-2 relative flex items-center justify-center flex-col fill-white text-white cursor-pointer ${ selected ? "opacity-100" : "opacity-50 hover:opacity-100" }`} > @@ -62,7 +62,7 @@ interface TooltipProps { function Tooltip({ children, position }: TooltipProps) { return ( <span - className={`z-10 absolute w-100 rounded dark:border-[1px] dark:border-white bg-space dark:bg-white px-2 py-1 hidden text-xs text-white dark:text-black group-hover:flex whitespace-nowrap ${ + className={`z-10 absolute rounded dark:border-[1px] dark:border-white bg-space dark:bg-white px-2 py-1 hidden text-xs text-white dark:text-black group-hover:flex whitespace-nowrap ${ position === "right" ? "right-[52px]" : "left-[52px]" }`} > diff --git a/playground/src/Editor/ThemeButton.tsx b/playground/shared/src/ThemeButton.tsx similarity index 96% rename from playground/src/Editor/ThemeButton.tsx rename to playground/shared/src/ThemeButton.tsx index a7bed3f584cb1..229cf40bae11c 100644 --- a/playground/src/Editor/ThemeButton.tsx +++ b/playground/shared/src/ThemeButton.tsx @@ -14,7 +14,7 @@ export default function ThemeButton({ return ( <AstralButton type="button" - className="ml-4 sm:ml-0 dark:shadow-copied" + className="sm:ml-0 dark:shadow-copied" onClick={() => onChange(theme === "light" ? "dark" : "light")} > <span className="sr-only"> diff --git a/playground/src/Editor/VersionTag.tsx b/playground/shared/src/VersionTag.tsx similarity index 100% rename from playground/src/Editor/VersionTag.tsx rename to playground/shared/src/VersionTag.tsx diff --git a/playground/shared/src/index.ts b/playground/shared/src/index.ts new file mode 100644 index 0000000000000..29bd886823d79 --- /dev/null +++ b/playground/shared/src/index.ts @@ -0,0 +1,14 @@ +export { default as AstralButton } from "./AstralButton"; +export { ErrorMessage } from "./ErrorMessage"; +export { default as Header } from "./Header"; +export { default as RepoButton } from "./RepoButton"; +export * as Icons from "./Icons"; +export { default as ShareButton } from "./ShareButton"; +export { type Theme, useTheme } from "./theme"; +export { HorizontalResizeHandle, VerticalResizeHandle } from "./ResizeHandle"; +export { setupMonaco } from "./setupMonaco"; +export { + default as SideBar, + SideBarEntry, + type SideBarEntryProps, +} from "./SideBar"; diff --git a/playground/src/Editor/setupMonaco.tsx b/playground/shared/src/setupMonaco.tsx similarity index 99% rename from playground/src/Editor/setupMonaco.tsx rename to playground/shared/src/setupMonaco.tsx index 9eaf2ccb44b8c..b5f38c98a1c41 100644 --- a/playground/src/Editor/setupMonaco.tsx +++ b/playground/shared/src/setupMonaco.tsx @@ -3,7 +3,6 @@ */ import { Monaco } from "@monaco-editor/react"; -import schema from "../../../ruff.schema.json"; export const WHITE = "#ffffff"; export const RADIATE = "#d7ff64"; @@ -26,7 +25,14 @@ export const LUNAR = "#fbf2fc"; export const ASTEROID = "#e3cee3"; export const CRATER = "#f0dfdf"; -export function setupMonaco(monaco: Monaco) { +export function setupMonaco( + monaco: Monaco, + settingsSchema: { + fileMatch: [string]; + uri: string; + schema: object; + }, +) { defineAyuThemes(monaco); defineFirLanguage(monaco); defineRustPythonTokensLanguage(monaco); @@ -34,13 +40,7 @@ export function setupMonaco(monaco: Monaco) { defineCommentsLanguage(monaco); monaco.languages.json.jsonDefaults.setDiagnosticsOptions({ - schemas: [ - { - uri: "https://raw.githubusercontent.com/astral-sh/ruff/main/ruff.schema.json", - fileMatch: ["*"], - schema, - }, - ], + schemas: [settingsSchema], }); } diff --git a/playground/src/Editor/theme.ts b/playground/shared/src/theme.ts similarity index 100% rename from playground/src/Editor/theme.ts rename to playground/shared/src/theme.ts diff --git a/playground/src/Editor/Chrome.tsx b/playground/src/Editor/Chrome.tsx deleted file mode 100644 index 671f91d2292ee..0000000000000 --- a/playground/src/Editor/Chrome.tsx +++ /dev/null @@ -1,121 +0,0 @@ -import { useCallback, useMemo, useRef, useState } from "react"; -import Header from "./Header"; -import { persist, persistLocal, restore, stringify } from "./settings"; -import { useTheme } from "./theme"; -import { default as Editor, Source } from "./Editor"; -import initRuff, { Workspace } from "../pkg"; -import { loader } from "@monaco-editor/react"; -import { setupMonaco } from "./setupMonaco"; -import { DEFAULT_PYTHON_SOURCE } from "../constants"; - -export default function Chrome() { - const initPromise = useRef<null | Promise<void>>(null); - const [pythonSource, setPythonSource] = useState<null | string>(null); - const [settings, setSettings] = useState<null | string>(null); - const [revision, setRevision] = useState(0); - const [ruffVersion, setRuffVersion] = useState<string | null>(null); - - const [theme, setTheme] = useTheme(); - - const handleShare = useCallback(() => { - if (settings == null || pythonSource == null) { - return; - } - - persist(settings, pythonSource).catch((error) => - console.error(`Failed to share playground: ${error}`), - ); - }, [pythonSource, settings]); - - if (initPromise.current == null) { - initPromise.current = startPlayground() - .then(({ sourceCode, settings, ruffVersion }) => { - setPythonSource(sourceCode); - setSettings(settings); - setRuffVersion(ruffVersion); - setRevision(1); - }) - .catch((error) => { - console.error("Failed to initialize playground.", error); - }); - } - - const handleSourceChanged = useCallback( - (source: string) => { - setPythonSource(source); - setRevision((revision) => revision + 1); - - if (settings != null) { - persistLocal({ pythonSource: source, settingsSource: settings }); - } - }, - [settings], - ); - - const handleSettingsChanged = useCallback( - (settings: string) => { - setSettings(settings); - setRevision((revision) => revision + 1); - - if (pythonSource != null) { - persistLocal({ pythonSource: pythonSource, settingsSource: settings }); - } - }, - [pythonSource], - ); - - const source: Source | null = useMemo(() => { - if (pythonSource == null || settings == null) { - return null; - } - - return { pythonSource, settingsSource: settings }; - }, [settings, pythonSource]); - - return ( - <main className="flex flex-col h-full bg-ayu-background dark:bg-ayu-background-dark"> - <Header - edit={revision} - theme={theme} - version={ruffVersion} - onChangeTheme={setTheme} - onShare={handleShare} - /> - - <div className="flex flex-grow"> - {source != null && ( - <Editor - theme={theme} - source={source} - onSettingsChanged={handleSettingsChanged} - onSourceChanged={handleSourceChanged} - /> - )} - </div> - </main> - ); -} - -// Run once during startup. Initializes monaco, loads the wasm file, and restores the previous editor state. -async function startPlayground(): Promise<{ - sourceCode: string; - settings: string; - ruffVersion: string; -}> { - await initRuff(); - const monaco = await loader.init(); - - setupMonaco(monaco); - - const response = await restore(); - const [settingsSource, pythonSource] = response ?? [ - stringify(Workspace.defaultSettings()), - DEFAULT_PYTHON_SOURCE, - ]; - - return { - sourceCode: pythonSource, - settings: settingsSource, - ruffVersion: Workspace.version(), - }; -} diff --git a/playground/src/Editor/Diagnostics.tsx b/playground/src/Editor/Diagnostics.tsx deleted file mode 100644 index 850de4725528b..0000000000000 --- a/playground/src/Editor/Diagnostics.tsx +++ /dev/null @@ -1,92 +0,0 @@ -import { Diagnostic } from "../pkg"; -import classNames from "classnames"; -import { Theme } from "./theme"; -import { useMemo } from "react"; - -interface Props { - diagnostics: Diagnostic[]; - theme: Theme; - onGoTo(line: number, column: number): void; -} - -export default function Diagnostics({ - diagnostics: unsorted, - theme, - onGoTo, -}: Props) { - const diagnostics = useMemo(() => { - const sorted = [...unsorted]; - sorted.sort((a, b) => { - if (a.location.row === b.location.row) { - return a.location.column - b.location.column; - } - - return a.location.row - b.location.row; - }); - - return sorted; - }, [unsorted]); - - return ( - <div - className={classNames( - "flex flex-grow flex-col overflow-hidden", - theme === "dark" ? "text-white" : null, - )} - > - <div - className={classNames( - "border-b border-gray-200 px-2 py-1", - theme === "dark" ? "border-rock" : null, - )} - > - Diagnostics ({diagnostics.length}) - </div> - - <div className="flex flex-grow p-2 overflow-hidden"> - <Items diagnostics={diagnostics} onGoTo={onGoTo} /> - </div> - </div> - ); -} - -function Items({ - diagnostics, - onGoTo, -}: { - diagnostics: Array<Diagnostic>; - onGoTo(line: number, column: number): void; -}) { - if (diagnostics.length === 0) { - return ( - <div className={"flex flex-auto flex-col justify-center items-center"}> - Everything is looking good! - </div> - ); - } - - return ( - <ul className="space-y-0.5 flex-grow overflow-y-scroll"> - {diagnostics.map((diagnostic, index) => { - return ( - <li - key={`${diagnostic.location.row}:${diagnostic.location.column}-${diagnostic.code ?? index}`} - > - <button - onClick={() => - onGoTo(diagnostic.location.row, diagnostic.location.column) - } - className="w-full text-start" - > - {diagnostic.message}{" "} - <span className="text-gray-500"> - {diagnostic.code != null && `(${diagnostic.code})`} [Ln{" "} - {diagnostic.location.row}, Col {diagnostic.location.column}] - </span> - </button> - </li> - ); - })} - </ul> - ); -} diff --git a/playground/src/Editor/Editor.tsx b/playground/src/Editor/Editor.tsx deleted file mode 100644 index 1a69ae0f248a2..0000000000000 --- a/playground/src/Editor/Editor.tsx +++ /dev/null @@ -1,347 +0,0 @@ -import { - useCallback, - useDeferredValue, - useMemo, - useRef, - useState, -} from "react"; -import { Panel, PanelGroup } from "react-resizable-panels"; -import { Diagnostic, Workspace } from "../pkg"; -import { ErrorMessage } from "./ErrorMessage"; -import PrimarySideBar from "./PrimarySideBar"; -import { HorizontalResizeHandle, VerticalResizeHandle } from "./ResizeHandle"; -import SecondaryPanel, { - SecondaryPanelResult, - SecondaryTool, -} from "./SecondaryPanel"; -import SecondarySideBar from "./SecondarySideBar"; -import SettingsEditor from "./SettingsEditor"; -import SourceEditor from "./SourceEditor"; -import { Theme } from "./theme"; -import Diagnostics from "./Diagnostics"; -import { editor } from "monaco-editor"; -import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; - -type Tab = "Source" | "Settings"; - -export interface Source { - pythonSource: string; - settingsSource: string; -} - -interface CheckResult { - diagnostics: Diagnostic[]; - error: string | null; - secondary: SecondaryPanelResult; -} - -type Props = { - source: Source; - theme: Theme; - - onSourceChanged(source: string): void; - onSettingsChanged(settings: string): void; -}; - -export default function Editor({ - source, - theme, - onSourceChanged, - onSettingsChanged, -}: Props) { - const editorRef = useRef<IStandaloneCodeEditor | null>(null); - const [tab, setTab] = useState<Tab>("Source"); - const [secondaryTool, setSecondaryTool] = useState<SecondaryTool | null>( - () => { - const secondaryValue = new URLSearchParams(location.search).get( - "secondary", - ); - if (secondaryValue == null) { - return null; - } else { - return parseSecondaryTool(secondaryValue); - } - }, - ); - const [selection, setSelection] = useState<number | null>(null); - - // Ideally this would be retrieved right from the URL... but routing without a proper - // router is hard (there's no location changed event) and pulling in a router - // feels overkill. - const handleSecondaryToolSelected = (tool: SecondaryTool | null) => { - if (tool === secondaryTool) { - tool = null; - } - - const url = new URL(location.href); - - if (tool == null) { - url.searchParams.delete("secondary"); - } else { - url.searchParams.set("secondary", tool); - } - - history.replaceState(null, "", url); - - setSecondaryTool(tool); - }; - - const handleGoTo = useCallback((line: number, column: number) => { - const editor = editorRef.current; - - if (editor == null) { - return; - } - - const range = { - startLineNumber: line, - startColumn: column, - endLineNumber: line, - endColumn: column, - }; - editor.revealRange(range); - editor.setSelection(range); - }, []); - - const handleSourceEditorMount = useCallback( - (editor: IStandaloneCodeEditor) => { - editorRef.current = editor; - - editor.addAction({ - contextMenuGroupId: "navigation", - contextMenuOrder: 0, - id: "reveal-node", - label: "Reveal node", - precondition: "editorTextFocus", - - run(editor: editor.ICodeEditor): void | Promise<void> { - const position = editor.getPosition(); - if (position == null) { - return; - } - - const offset = editor.getModel()!.getOffsetAt(position); - - setSelection( - charOffsetToByteOffset(editor.getModel()!.getValue(), offset), - ); - }, - }); - }, - [], - ); - - const handleSelectByteRange = useCallback( - (startByteOffset: number, endByteOffset: number) => { - const model = editorRef.current?.getModel(); - - if (model == null || editorRef.current == null) { - return; - } - - const startCharacterOffset = byteOffsetToCharOffset( - source.pythonSource, - startByteOffset, - ); - const endCharacterOffset = byteOffsetToCharOffset( - source.pythonSource, - endByteOffset, - ); - - const start = model.getPositionAt(startCharacterOffset); - const end = model.getPositionAt(endCharacterOffset); - - const range = { - startLineNumber: start.lineNumber, - startColumn: start.column, - endLineNumber: end.lineNumber, - endColumn: end.column, - }; - editorRef.current?.revealRange(range); - editorRef.current?.setSelection(range); - }, - [source.pythonSource], - ); - - const deferredSource = useDeferredValue(source); - - const checkResult: CheckResult = useMemo(() => { - const { pythonSource, settingsSource } = deferredSource; - - try { - const config = JSON.parse(settingsSource); - const workspace = new Workspace(config); - const diagnostics = workspace.check(pythonSource); - - let secondary: SecondaryPanelResult = null; - - try { - switch (secondaryTool) { - case "AST": - secondary = { - status: "ok", - content: workspace.parse(pythonSource), - }; - break; - - case "Format": - secondary = { - status: "ok", - content: workspace.format(pythonSource), - }; - break; - - case "FIR": - secondary = { - status: "ok", - content: workspace.format_ir(pythonSource), - }; - break; - - case "Comments": - secondary = { - status: "ok", - content: workspace.comments(pythonSource), - }; - break; - - case "Tokens": - secondary = { - status: "ok", - content: workspace.tokens(pythonSource), - }; - break; - } - } catch (error: unknown) { - secondary = { - status: "error", - error: error instanceof Error ? error.message : error + "", - }; - } - - return { - diagnostics, - error: null, - secondary, - }; - } catch (e) { - return { - diagnostics: [], - error: (e as Error).message, - secondary: null, - }; - } - }, [deferredSource, secondaryTool]); - - return ( - <> - <PanelGroup direction="horizontal" autoSaveId="main"> - <PrimarySideBar onSelectTool={(tool) => setTab(tool)} selected={tab} /> - - <Panel id="main" order={0} minSize={10}> - <PanelGroup id="main" direction="vertical"> - <Panel minSize={10} className="my-2" order={0}> - <SourceEditor - visible={tab === "Source"} - source={source.pythonSource} - theme={theme} - diagnostics={checkResult.diagnostics} - onChange={onSourceChanged} - onMount={handleSourceEditorMount} - /> - <SettingsEditor - visible={tab === "Settings"} - source={source.settingsSource} - theme={theme} - onChange={onSettingsChanged} - /> - </Panel> - {tab === "Source" && ( - <> - <VerticalResizeHandle /> - <Panel - id="diagnostics" - minSize={3} - order={1} - className="my-2 flex flex-grow" - > - <Diagnostics - diagnostics={checkResult.diagnostics} - onGoTo={handleGoTo} - theme={theme} - /> - </Panel> - </> - )} - </PanelGroup> - </Panel> - {secondaryTool != null && ( - <> - <HorizontalResizeHandle /> - <Panel - id="secondary-panel" - order={1} - className={"my-2"} - minSize={10} - > - <SecondaryPanel - theme={theme} - tool={secondaryTool} - result={checkResult.secondary} - selectionOffset={selection} - onSourceByteRangeClicked={handleSelectByteRange} - /> - </Panel> - </> - )} - <SecondarySideBar - selected={secondaryTool} - onSelected={handleSecondaryToolSelected} - /> - </PanelGroup> - - {checkResult.error && tab === "Source" ? ( - <div - style={{ - position: "fixed", - left: "10%", - right: "10%", - bottom: "10%", - }} - > - <ErrorMessage>{checkResult.error}</ErrorMessage> - </div> - ) : null} - </> - ); -} - -function parseSecondaryTool(tool: string): SecondaryTool | null { - if (Object.hasOwn(SecondaryTool, tool)) { - return tool as any; - } - - return null; -} - -function byteOffsetToCharOffset(content: string, byteOffset: number): number { - // Create a Uint8Array from the UTF-8 string - const encoder = new TextEncoder(); - const utf8Bytes = encoder.encode(content); - - // Slice the byte array up to the byteOffset - const slicedBytes = utf8Bytes.slice(0, byteOffset); - - // Decode the sliced bytes to get a substring - const decoder = new TextDecoder("utf-8"); - const decodedString = decoder.decode(slicedBytes); - return decodedString.length; -} - -function charOffsetToByteOffset(content: string, charOffset: number): number { - // Create a Uint8Array from the UTF-8 string - const encoder = new TextEncoder(); - const utf8Bytes = encoder.encode(content.substring(0, charOffset)); - - return utf8Bytes.length; -} diff --git a/playground/src/Editor/ErrorMessage.tsx b/playground/src/Editor/ErrorMessage.tsx deleted file mode 100644 index d5b6da4e34540..0000000000000 --- a/playground/src/Editor/ErrorMessage.tsx +++ /dev/null @@ -1,26 +0,0 @@ -function truncate(str: string, length: number) { - if (str.length > length) { - return str.slice(0, length) + "..."; - } else { - return str; - } -} - -export function ErrorMessage({ children }: { children: string }) { - return ( - <div - className="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4" - role="alert" - > - <p className="font-bold">Error</p> - <p className="block sm:inline"> - {truncate( - children.startsWith("Error: ") - ? children.slice("Error: ".length) - : children, - 120, - )} - </p> - </div> - ); -} diff --git a/playground/src/Editor/Header.tsx b/playground/src/Editor/Header.tsx deleted file mode 100644 index 537f7d332f2d9..0000000000000 --- a/playground/src/Editor/Header.tsx +++ /dev/null @@ -1,80 +0,0 @@ -import classNames from "classnames"; -import RepoButton from "./RepoButton"; -import ThemeButton from "./ThemeButton"; -import ShareButton from "./ShareButton"; -import { Theme } from "./theme"; -import VersionTag from "./VersionTag"; - -export type Tab = "Source" | "Settings"; - -export default function Header({ - edit, - theme, - version, - onChangeTheme, - onShare, -}: { - edit: number | null; - theme: Theme; - version: string | null; - onChangeTheme: (theme: Theme) => void; - onShare?: () => void; -}) { - return ( - <div - className={classNames( - "w-full", - "flex", - "justify-between", - "pl-5", - "sm:pl-1", - "pr-4", - "lg:pr-6", - "z-10", - "top-0", - "left-0", - "-mb-px", - "antialiased", - "border-b", - "border-gray-200", - "dark:border-b-radiate", - "dark:bg-galaxy", - )} - > - <div className="py-4 pl-2"> - <svg - width="136" - height="32" - viewBox="0 0 272 64" - className="fill-galaxy dark:fill-radiate" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M61.5 0C62.8807 0 64 1.11929 64 2.5V32.06C64 33.4407 62.8807 34.56 61.5 34.56H51.2V39.68H64V64H34.56V44.8H29.44V64H0V0H61.5ZM39.68 29.44V24.32H24.32V29.44H39.68ZM69.12 0H98.56V41.6H103.68V0H133.12V61.5C133.12 62.8807 132.001 64 130.62 64H71.62C70.2393 64 69.12 62.8807 69.12 61.5V0ZM202.24 0H145.86C144.479 0 143.36 1.11929 143.36 2.5V29.44H138.24V53.76H143.36V64H172.8V53.76H199.74C201.121 53.76 202.24 52.6407 202.24 51.26V29.44H172.8V24.32H202.24V0ZM214.98 0H271.36V24.32H241.92V29.44H271.36V51.26C271.36 52.6407 270.241 53.76 268.86 53.76H241.92V64H212.48V53.76H207.36V29.44H212.48V2.5C212.48 1.11929 213.599 0 214.98 0Z" - /> - </svg> - </div> - <div className="flex items-center min-w-0"> - {version ? ( - <div className="hidden sm:flex items-center"> - <VersionTag>v{version}</VersionTag> - </div> - ) : null} - <Divider /> - <RepoButton /> - <Divider /> - <ShareButton key={edit} onShare={onShare} /> - <Divider /> - <ThemeButton theme={theme} onChange={onChangeTheme} /> - </div> - </div> - ); -} - -function Divider() { - return ( - <div className="hidden sm:block mx-6 lg:mx-4 w-px h-8 bg-gray-200 dark:bg-gray-700" /> - ); -} diff --git a/playground/src/Editor/Icons.tsx b/playground/src/Editor/Icons.tsx deleted file mode 100644 index 6d14d02341c0a..0000000000000 --- a/playground/src/Editor/Icons.tsx +++ /dev/null @@ -1,142 +0,0 @@ -// Icons from the [VS code icon set](https://github.com/microsoft/vscode-icons/). -// -// Icon-LICENSE: -// MIT License -// -// Copyright (c) Microsoft Corporation. -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE - -export function FileIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 16 16" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M10.57 1.14L13.85 4.44L14 4.8V14.5L13.5 15H2.5L2 14.5V1.5L2.5 1H10.22L10.57 1.14ZM10 5H13L10 2V5ZM3 2V14H13V6H9.5L9 5.5V2H3ZM5.062 9.533L6.879 7.705L6.17 7L4 9.179V9.886L6.171 12.06L6.878 11.353L5.062 9.533ZM8.8 7.714L9.5 7.005L11.689 9.18V9.889L9.5 12.062L8.795 11.353L10.626 9.533L8.8 7.714Z" - /> - </svg> - ); -} - -export function SettingsIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M19.85 8.75L24 9.57996V14.42L19.85 15.25L22.2 18.77L18.77 22.2L15.25 19.85L14.42 24H9.57996L8.75 19.85L5.22998 22.2L1.80005 18.77L4.15002 15.25L0 14.42V9.57996L4.15002 8.75L1.80005 5.22998L5.22998 1.80005L8.75 4.15002L9.57996 0H14.42L15.25 4.15002L18.77 1.80005L22.2 5.22998L19.85 8.75ZM18.28 13.8199L22.28 13.01V11.01L18.28 10.2L17.74 8.90002L20.03 5.46997L18.6 4.04004L15.17 6.32996L13.87 5.79004L13.0601 1.79004H11.0601L10.25 5.79004L8.94995 6.32996L5.52002 4.04004L4.08997 5.46997L6.38 8.90002L5.83997 10.2L1.83997 11.01V13.01L5.83997 13.8199L6.38 15.12L4.08997 18.55L5.52002 19.98L8.94995 17.6899L10.25 18.23L11.0601 22.23H13.0601L13.87 18.23L15.17 17.6899L18.6 19.98L20.03 18.55L17.74 15.12L18.28 13.8199ZM10.0943 9.14807C10.6584 8.77118 11.3216 8.56995 12 8.56995C12.9089 8.57258 13.7798 8.93484 14.4225 9.57751C15.0652 10.2202 15.4274 11.0911 15.43 12C15.43 12.6784 15.2288 13.3416 14.8519 13.9056C14.475 14.4697 13.9394 14.9093 13.3126 15.1689C12.6859 15.4286 11.9962 15.4965 11.3308 15.3641C10.6654 15.2318 10.0543 14.9051 9.57457 14.4254C9.09488 13.9457 8.7682 13.3345 8.63585 12.6692C8.50351 12.0038 8.57143 11.3141 8.83104 10.6874C9.09065 10.0606 9.53029 9.52496 10.0943 9.14807ZM11.0499 13.4218C11.3311 13.6097 11.6618 13.71 12 13.71C12.2249 13.7113 12.4479 13.668 12.656 13.5825C12.8641 13.4971 13.0531 13.3712 13.2121 13.2122C13.3712 13.0531 13.497 12.8641 13.5825 12.656C13.668 12.4479 13.7113 12.2249 13.7099 12C13.7099 11.6618 13.6096 11.3311 13.4217 11.0499C13.2338 10.7687 12.9669 10.5496 12.6544 10.4202C12.3419 10.2907 11.9981 10.2569 11.6664 10.3229C11.3347 10.3889 11.03 10.5517 10.7909 10.7909C10.5517 11.03 10.3888 11.3347 10.3229 11.6664C10.2569 11.9981 10.2907 12.342 10.4202 12.6544C10.5496 12.9669 10.7687 13.2339 11.0499 13.4218Z" - /> - </svg> - ); -} - -export function StructureIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 16 16" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M2 2L1 3V6L2 7H14L15 6V3L14 2H2ZM2 3H3H13H14V4V5V6H13H3H2V5V4V3ZM1 10L2 9H5L6 10V13L5 14H2L1 13V10ZM3 10H2V11V12V13H3H4H5V12V11V10H4H3ZM10 10L11 9H14L15 10V13L14 14H11L10 13V10ZM12 10H11V11V12V13H12H13H14V12V11V10H13H12Z" - /> - </svg> - ); -} - -export function FormatIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 16 16" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M6 2.98361V2.97184V2H5.91083C5.59743 2 5.29407 2.06161 5.00128 2.18473C4.70818 2.30798 4.44942 2.48474 4.22578 2.71498C4.00311 2.94422 3.83792 3.19498 3.73282 3.46766L3.73233 3.46898C3.63382 3.7352 3.56814 4.01201 3.53533 4.29917L3.53519 4.30053C3.50678 4.5805 3.4987 4.86844 3.51084 5.16428C3.52272 5.45379 3.52866 5.74329 3.52866 6.03279C3.52866 6.23556 3.48974 6.42594 3.412 6.60507L3.4116 6.60601C3.33687 6.78296 3.23423 6.93866 3.10317 7.07359C2.97644 7.20405 2.82466 7.31055 2.64672 7.3925C2.4706 7.46954 2.28497 7.5082 2.08917 7.5082H2V7.6V8.4V8.4918H2.08917C2.28465 8.4918 2.47001 8.53238 2.64601 8.61334L2.64742 8.61396C2.82457 8.69157 2.97577 8.79762 3.10221 8.93161L3.10412 8.93352C3.23428 9.0637 3.33659 9.21871 3.41129 9.39942L3.41201 9.40108C3.48986 9.58047 3.52866 9.76883 3.52866 9.96721C3.52866 10.2567 3.52272 10.5462 3.51084 10.8357C3.4987 11.1316 3.50677 11.4215 3.53516 11.7055L3.53535 11.7072C3.56819 11.9903 3.63387 12.265 3.73232 12.531L3.73283 12.5323C3.83793 12.805 4.00311 13.0558 4.22578 13.285C4.44942 13.5153 4.70818 13.692 5.00128 13.8153C5.29407 13.9384 5.59743 14 5.91083 14H6V13.2V13.0164H5.91083C5.71095 13.0164 5.52346 12.9777 5.34763 12.9008C5.17396 12.8191 5.02194 12.7126 4.89086 12.5818C4.76386 12.4469 4.66104 12.2911 4.58223 12.1137C4.50838 11.9346 4.47134 11.744 4.47134 11.541C4.47134 11.3127 4.4753 11.0885 4.48321 10.8686C4.49125 10.6411 4.49127 10.4195 4.48324 10.2039C4.47914 9.98246 4.46084 9.76883 4.42823 9.56312C4.39513 9.35024 4.33921 9.14757 4.26039 8.95536C4.18091 8.76157 4.07258 8.57746 3.93616 8.40298C3.82345 8.25881 3.68538 8.12462 3.52283 8C3.68538 7.87538 3.82345 7.74119 3.93616 7.59702C4.07258 7.42254 4.18091 7.23843 4.26039 7.04464C4.33913 6.85263 4.39513 6.65175 4.42826 6.44285C4.46082 6.2333 4.47914 6.01973 4.48324 5.80219C4.49127 5.58262 4.49125 5.36105 4.48321 5.13749C4.4753 4.9134 4.47134 4.68725 4.47134 4.45902C4.47134 4.26019 4.50833 4.07152 4.58238 3.89205C4.66135 3.71034 4.76421 3.55475 4.89086 3.42437C5.02193 3.28942 5.17461 3.18275 5.34802 3.10513C5.5238 3.02427 5.71113 2.98361 5.91083 2.98361H6ZM10 13.0164V13.0282V14H10.0892C10.4026 14 10.7059 13.9384 10.9987 13.8153C11.2918 13.692 11.5506 13.5153 11.7742 13.285C11.9969 13.0558 12.1621 12.805 12.2672 12.5323L12.2677 12.531C12.3662 12.2648 12.4319 11.988 12.4647 11.7008L12.4648 11.6995C12.4932 11.4195 12.5013 11.1316 12.4892 10.8357C12.4773 10.5462 12.4713 10.2567 12.4713 9.96721C12.4713 9.76444 12.5103 9.57406 12.588 9.39493L12.5884 9.39399C12.6631 9.21704 12.7658 9.06134 12.8968 8.92642C13.0236 8.79595 13.1753 8.68945 13.3533 8.6075C13.5294 8.53046 13.715 8.4918 13.9108 8.4918H14V8.4V7.6V7.5082H13.9108C13.7153 7.5082 13.53 7.46762 13.354 7.38666L13.3526 7.38604C13.1754 7.30844 13.0242 7.20238 12.8978 7.06839L12.8959 7.06648C12.7657 6.9363 12.6634 6.78129 12.5887 6.60058L12.588 6.59892C12.5101 6.41953 12.4713 6.23117 12.4713 6.03279C12.4713 5.74329 12.4773 5.45379 12.4892 5.16428C12.5013 4.86842 12.4932 4.57848 12.4648 4.29454L12.4646 4.29285C12.4318 4.00971 12.3661 3.73502 12.2677 3.46897L12.2672 3.46766C12.1621 3.19499 11.9969 2.94422 11.7742 2.71498C11.5506 2.48474 11.2918 2.30798 10.9987 2.18473C10.7059 2.06161 10.4026 2 10.0892 2H10V2.8V2.98361H10.0892C10.2891 2.98361 10.4765 3.0223 10.6524 3.09917C10.826 3.18092 10.9781 3.28736 11.1091 3.41823C11.2361 3.55305 11.339 3.70889 11.4178 3.88628C11.4916 4.0654 11.5287 4.25596 11.5287 4.45902C11.5287 4.68727 11.5247 4.91145 11.5168 5.13142C11.5088 5.35894 11.5087 5.58049 11.5168 5.79605C11.5209 6.01754 11.5392 6.23117 11.5718 6.43688C11.6049 6.64976 11.6608 6.85243 11.7396 7.04464C11.8191 7.23843 11.9274 7.42254 12.0638 7.59702C12.1765 7.74119 12.3146 7.87538 12.4772 8C12.3146 8.12462 12.1765 8.25881 12.0638 8.40298C11.9274 8.57746 11.8191 8.76157 11.7396 8.95536C11.6609 9.14737 11.6049 9.34825 11.5717 9.55715C11.5392 9.7667 11.5209 9.98027 11.5168 10.1978C11.5087 10.4174 11.5087 10.6389 11.5168 10.8625C11.5247 11.0866 11.5287 11.3128 11.5287 11.541C11.5287 11.7398 11.4917 11.9285 11.4176 12.1079C11.3386 12.2897 11.2358 12.4452 11.1091 12.5756C10.9781 12.7106 10.8254 12.8173 10.652 12.8949C10.4762 12.9757 10.2889 13.0164 10.0892 13.0164H10Z" - /> - </svg> - ); -} - -export function TokensIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M19.5 0V1.5L21 3V22.5L19.5 24H4.5L3 22.5V3L4.5 1.5V0H6V1.5H9V0H10.5V1.5H13.5V0H15V1.5H18V0H19.5ZM4.5 22.5H19.5V3H4.5V22.5ZM7.5 6H16.5V7.5H7.5V6ZM16.5 12H7.5V13.5H16.5V12ZM7.5 18H16.5V19.5H7.5V18Z" - /> - </svg> - ); -} - -export function FormatterIRIcon() { - return ( - <svg - width="24" - height="24" - viewBox="0 0 16 16" - xmlns="http://www.w3.org/2000/svg" - > - <path - fillRule="evenodd" - clipRule="evenodd" - d="M4 2H12V6C12.3415 6.03511 12.6774 6.11234 13 6.22998V1H3V9.47998L4 7.72998V2ZM6.14001 10L5 8L4 9.75L3.29004 11L1 15H9L6.70996 11L6.14001 10ZM2.71997 14L4.43994 11L5 10L5.56006 11L7.28003 14H2.71997ZM9.55552 7.58984C10.1311 7.20526 10.8077 7 11.5 7C12.4282 7 13.3185 7.36877 13.9748 8.02515C14.6312 8.68152 15 9.57174 15 10.5C15 11.1922 14.7947 11.8689 14.4101 12.4445C14.0256 13.02 13.4789 13.4686 12.8393 13.7335C12.1998 13.9984 11.4961 14.0678 10.8171 13.9327C10.1382 13.7977 9.51461 13.4643 9.02513 12.9749C8.53564 12.4854 8.20229 11.8618 8.06724 11.1829C7.93219 10.5039 8.00155 9.80019 8.26646 9.16064C8.53137 8.5211 8.97995 7.97443 9.55552 7.58984ZM10.1111 12.5786C10.5222 12.8533 11.0055 13 11.5 13C12.163 13 12.799 12.7367 13.2678 12.2678C13.7366 11.799 14 11.163 14 10.5C14 10.0055 13.8533 9.52221 13.5786 9.11108C13.3039 8.69996 12.9135 8.37953 12.4566 8.19031C11.9998 8.00109 11.4973 7.95163 11.0123 8.0481C10.5274 8.14456 10.0818 8.38255 9.73216 8.73218C9.38253 9.08181 9.14454 9.52738 9.04808 10.0123C8.95161 10.4973 9.00107 10.9998 9.19029 11.4567C9.37951 11.9135 9.69994 12.3039 10.1111 12.5786Z" - /> - </svg> - ); -} -export function CommentsIcon() { - return ( - <svg - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - width={24} - height={24} - > - <path - d="M7.7,18.3H19.4a2.1,2.1,0,0,0,2.1-2.1V4.6a2.1,2.1,0,0,0-2.1-2.1H4.6A2.1,2.1,0,0,0,2.5,4.6V21.5Z" - stroke="#ffffff" - fill="none" - ></path> - </svg> - ); -} diff --git a/playground/src/Editor/SecondaryPanel.tsx b/playground/src/Editor/SecondaryPanel.tsx deleted file mode 100644 index ad60885ea568c..0000000000000 --- a/playground/src/Editor/SecondaryPanel.tsx +++ /dev/null @@ -1,231 +0,0 @@ -import { Theme } from "./theme"; -import { useCallback, useEffect, useState } from "react"; -import { editor, Range } from "monaco-editor"; -import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; -import MonacoEditor from "@monaco-editor/react"; - -export enum SecondaryTool { - "Format" = "Format", - "AST" = "AST", - "Tokens" = "Tokens", - "FIR" = "FIR", - "Comments" = "Comments", -} - -export type SecondaryPanelResult = - | null - | { status: "ok"; content: string } - | { status: "error"; error: string }; - -export type SecondaryPanelProps = { - tool: SecondaryTool; - result: SecondaryPanelResult; - theme: Theme; - selectionOffset: number | null; - onSourceByteRangeClicked(start: number, end: number): void; -}; - -export default function SecondaryPanel({ - tool, - result, - theme, - selectionOffset, - onSourceByteRangeClicked, -}: SecondaryPanelProps) { - return ( - <div className="flex flex-col h-full"> - <div className="flex-grow"> - <Content - tool={tool} - result={result} - theme={theme} - selectionOffset={selectionOffset} - onSourceByteRangeClicked={onSourceByteRangeClicked} - /> - </div> - </div> - ); -} - -function Content({ - tool, - result, - theme, - selectionOffset, - onSourceByteRangeClicked, -}: { - tool: SecondaryTool; - result: SecondaryPanelResult; - theme: Theme; - selectionOffset: number | null; - onSourceByteRangeClicked(start: number, end: number): void; -}) { - const [editor, setEditor] = useState<IStandaloneCodeEditor | null>(null); - const [prevSelection, setPrevSelection] = useState<number | null>(null); - const [ranges, setRanges] = useState< - Array<{ byteRange: { start: number; end: number }; textRange: Range }> - >([]); - - if ( - editor != null && - selectionOffset != null && - selectionOffset !== prevSelection - ) { - const range = ranges.findLast( - (range) => - range.byteRange.start <= selectionOffset && - range.byteRange.end >= selectionOffset, - ); - - if (range != null) { - editor.revealRange(range.textRange); - editor.setSelection(range.textRange); - } - setPrevSelection(selectionOffset); - } - - useEffect(() => { - const model = editor?.getModel(); - if (editor == null || model == null) { - return; - } - - const handler = editor.onMouseDown((event) => { - if (event.target.range == null) { - return; - } - - const range = model - .getDecorationsInRange( - event.target.range, - undefined, - true, - false, - false, - ) - .map((decoration) => { - const decorationRange = decoration.range; - return ranges.find((range) => - Range.equalsRange(range.textRange, decorationRange), - ); - }) - .find((range) => range != null); - - if (range == null) { - return; - } - - onSourceByteRangeClicked(range.byteRange.start, range.byteRange.end); - }); - - return () => handler.dispose(); - }, [editor, onSourceByteRangeClicked, ranges]); - - const handleDidMount = useCallback((editor: IStandaloneCodeEditor) => { - setEditor(editor); - - const model = editor.getModel(); - const collection = editor.createDecorationsCollection([]); - - function updateRanges() { - if (model == null) { - setRanges([]); - collection.set([]); - return; - } - - const matches = model.findMatches( - String.raw`(\d+)\.\.(\d+)`, - false, - true, - false, - ",", - true, - ); - - const ranges = matches - .map((match) => { - const startByteOffset = parseInt(match.matches![1] ?? "", 10); - const endByteOffset = parseInt(match.matches![2] ?? "", 10); - - if (Number.isNaN(startByteOffset) || Number.isNaN(endByteOffset)) { - return null; - } - - return { - byteRange: { start: startByteOffset, end: endByteOffset }, - textRange: match.range, - }; - }) - .filter((range) => range != null); - - setRanges(ranges); - - const decorations = ranges.map((range) => { - return { - range: range.textRange, - options: { - inlineClassName: - "underline decoration-slate-600 decoration-1 cursor-pointer", - }, - }; - }); - - collection.set(decorations); - } - - updateRanges(); - const handler = editor.onDidChangeModelContent(updateRanges); - - return () => handler.dispose(); - }, []); - - if (result == null) { - return ""; - } else { - let language; - switch (result.status) { - case "ok": - switch (tool) { - case "Format": - language = "python"; - break; - - case "AST": - language = "RustPythonAst"; - break; - - case "Tokens": - language = "RustPythonTokens"; - break; - - case "FIR": - language = "fir"; - break; - - case "Comments": - language = "Comments"; - break; - } - - return ( - <MonacoEditor - options={{ - readOnly: true, - minimap: { enabled: false }, - fontSize: 14, - roundedSelection: false, - scrollBeyondLastLine: false, - contextmenu: false, - }} - onMount={handleDidMount} - language={language} - value={result.content} - theme={theme === "light" ? "Ayu-Light" : "Ayu-Dark"} - /> - ); - case "error": - return <code className="whitespace-pre-wrap">{result.error}</code>; - } - } -} diff --git a/playground/src/Editor/SecondarySideBar.tsx b/playground/src/Editor/SecondarySideBar.tsx deleted file mode 100644 index 2accc7b915e3f..0000000000000 --- a/playground/src/Editor/SecondarySideBar.tsx +++ /dev/null @@ -1,68 +0,0 @@ -import SideBar, { SideBarEntry } from "./SideBar"; -import { - FormatIcon, - FormatterIRIcon, - StructureIcon, - TokensIcon, - CommentsIcon, -} from "./Icons"; -import { SecondaryTool } from "./SecondaryPanel"; - -interface RightSideBarProps { - selected: SecondaryTool | null; - onSelected(tool: SecondaryTool): void; -} - -export default function SecondarySideBar({ - selected, - onSelected, -}: RightSideBarProps) { - return ( - <SideBar position="right"> - <SideBarEntry - title="Format" - position={"right"} - selected={selected === SecondaryTool.Format} - onClick={() => onSelected(SecondaryTool.Format)} - > - <FormatIcon /> - </SideBarEntry> - - <SideBarEntry - title="AST" - position={"right"} - selected={selected === SecondaryTool.AST} - onClick={() => onSelected(SecondaryTool.AST)} - > - <StructureIcon /> - </SideBarEntry> - - <SideBarEntry - title="Tokens" - position={"right"} - selected={selected === SecondaryTool.Tokens} - onClick={() => onSelected(SecondaryTool.Tokens)} - > - <TokensIcon /> - </SideBarEntry> - - <SideBarEntry - title="Formatter IR" - position={"right"} - selected={selected === SecondaryTool.FIR} - onClick={() => onSelected(SecondaryTool.FIR)} - > - <FormatterIRIcon /> - </SideBarEntry> - - <SideBarEntry - title="Formatter comments" - position={"right"} - selected={selected === SecondaryTool.Comments} - onClick={() => onSelected(SecondaryTool.Comments)} - > - <CommentsIcon /> - </SideBarEntry> - </SideBar> - ); -} diff --git a/playground/src/Editor/utils.ts b/playground/src/Editor/utils.ts deleted file mode 100644 index 233b0dcc005ca..0000000000000 --- a/playground/src/Editor/utils.ts +++ /dev/null @@ -1,7 +0,0 @@ -export async function copyTextToClipboard(text: string) { - if ("clipboard" in navigator) { - return await navigator.clipboard.writeText(text); - } else { - return document.execCommand("copy", true, text); - } -} diff --git a/playground/src/index.css b/playground/src/index.css deleted file mode 100644 index b644d5add34e7..0000000000000 --- a/playground/src/index.css +++ /dev/null @@ -1,67 +0,0 @@ -@tailwind base; -@tailwind components; -@tailwind utilities; - -* { - box-sizing: border-box; -} - -body, -html, -#root { - margin: 0; - height: 100%; - width: 100%; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; -} - -.shadow-copied { - --tw-shadow: 0 0 0 1px theme("colors.white"), - inset 0 0 0 1px theme("colors.white"); - --tw-shadow-colored: 0 0 0 1px var(--tw-shadow-color), - inset 0 0 0 1px var(--tw-shadow-color); - - box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), - var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow); -} - -@font-face { - font-family: "Alliance Text"; - src: - url("../fonts/Alliance-TextRegular.woff2") format("woff2"), - url("../fonts/Alliance-TextRegular.woff") format("woff"); - font-weight: normal; - font-style: normal; - font-display: block; -} - -@font-face { - font-family: "Alliance Text"; - src: - url("../fonts/Alliance-TextMedium.woff2") format("woff2"), - url("../fonts/Alliance-TextMedium.woff") format("woff"); - font-weight: 500; - font-style: normal; - font-display: block; -} - -@font-face { - font-family: "Alliance Platt"; - src: - url("../fonts/Alliance-PlattMedium.woff2") format("woff2"), - url("../fonts/Alliance-PlattMedium.woff") format("woff"); - font-weight: 500; - font-style: normal; - font-display: block; -} - -@font-face { - font-family: "Alliance Platt"; - src: - url("../fonts/Alliance-PlattRegular.woff2") format("woff2"), - url("../fonts/Alliance-PlattRegular.woff") format("woff"); - font-weight: normal; - font-style: normal; - font-display: block; -} diff --git a/playground/tailwind.config.cjs b/playground/tailwind.config.cjs deleted file mode 100644 index 5ed0e9dc11121..0000000000000 --- a/playground/tailwind.config.cjs +++ /dev/null @@ -1,78 +0,0 @@ -/** @type {import('tailwindcss').Config} */ -const defaultTheme = require("tailwindcss/defaultTheme"); - -module.exports = { - darkMode: "class", - content: ["./index.html", "./src/**/*.{js,ts,jsx,tsx}"], - theme: { - extend: { - colors: { - "ayu-accent": "#ffac2f", - "ayu-background": { - DEFAULT: "#f8f9fa", - dark: "#0b0e14", - }, - black: "#261230", - white: "#FFFFFF", - radiate: "#D7FF64", - flare: "#6340AC", - rock: "#78876E", - galaxy: "#261230", - space: "#30173D", - comet: "#6F5D6F", - cosmic: "#DE5FE9", - sun: "#FFAC2F", - electron: "#46EBE1", - aurora: "#46EB74", - constellation: "#5F6DE9", - neutron: "#CFF3CF", - proton: "#F6AFBC", - nebula: "#CDCBFB", - supernova: "#F1AFF6", - starlight: "#F4F4F1", - lunar: "#FBF2FC", - asteroid: "#E3CEE3", - crater: "#F0DFDF", - }, - fontFamily: { - heading: [ - "Alliance Platt", - "system-ui", - "-apple-system", - "Segoe UI", - "Roboto", - "Helvetica", - "Arial", - "monospace", - "Apple Color Emoji", - "Segoe UI Emoji", - ], - body: [ - "Alliance Text", - "system-ui", - "-apple-system", - "Segoe UI", - "Roboto", - "Helvetica", - "Arial", - "sans-serif", - "Apple Color Emoji", - "Segoe UI Emoji", - ], - mono: ["Roboto Mono"], - }, - fontSize: { - xs: "0.75rem" /* 12px */, - sm: "0.875rem" /* 14px */, - base: "1rem" /* 16px */, - lg: "1.125rem" /* 18px */, - xl: "1.25rem" /* 20px */, - "2xl": "1.5rem" /* 25px */, - "3xl": "1.875rem" /* 30px */, - "4xl": "2.25rem" /* 36px */, - "5xl": "3rem" /* 48px */, - }, - }, - }, - plugins: [], -}; diff --git a/playground/tsconfig.json b/playground/tsconfig.json index 3d0a51a86e202..408d95de6a45f 100644 --- a/playground/tsconfig.json +++ b/playground/tsconfig.json @@ -9,13 +9,17 @@ "allowSyntheticDefaultImports": true, "strict": true, "forceConsistentCasingInFileNames": true, - "module": "ESNext", - "moduleResolution": "Node", + "module": "esnext", + "moduleResolution": "bundler", "resolveJsonModule": true, "isolatedModules": true, "noEmit": true, "jsx": "react-jsx" }, - "include": ["src"], - "references": [{ "path": "./tsconfig.node.json" }] + "include": ["ruff/src", "ty/src"], + "references": [ + { + "path": "./tsconfig.node.json" + } + ] } diff --git a/playground/tsconfig.node.json b/playground/tsconfig.node.json index 9d31e2aed93c8..56ea1c6b3753a 100644 --- a/playground/tsconfig.node.json +++ b/playground/tsconfig.node.json @@ -5,5 +5,5 @@ "moduleResolution": "Node", "allowSyntheticDefaultImports": true }, - "include": ["vite.config.ts"] + "include": ["ruff/vite.config.ts", "ty/vite.config.ts"] } diff --git a/playground/ty/index.html b/playground/ty/index.html new file mode 100644 index 0000000000000..6a8728e4ccad1 --- /dev/null +++ b/playground/ty/index.html @@ -0,0 +1,42 @@ +<!doctype html> +<html lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="referrer" content="no-referrer-when-downgrade" /> + <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" /> + <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" /> + <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" /> + <meta name="msapplication-TileColor" content="#d7ff64" /> + <meta name="theme-color" content="#ffffff" /> + <title>Playground | ty + + + + + + + + + + + + + +
+ + + diff --git a/playground/ty/package.json b/playground/ty/package.json new file mode 100644 index 0000000000000..f71812795a9bc --- /dev/null +++ b/playground/ty/package.json @@ -0,0 +1,39 @@ +{ + "name": "ty-playground", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "prebuild": "npm run build:wasm", + "build": "vite build", + "build:wasm": "wasm-pack build ../../crates/ty_wasm --target web --out-dir ../../playground/ty/ty_wasm", + "dev:wasm": "wasm-pack build ../../crates/ty_wasm --dev --target web --out-dir ../../playground/ty/ty_wasm", + "predev:build": "npm run dev:wasm", + "dev:build": "vite build", + "prestart": "npm run dev:wasm", + "start": "vite", + "preview": "vite preview" + }, + "dependencies": { + "@monaco-editor/react": "^4.7.0", + "classnames": "^2.5.1", + "lz-string": "^1.5.0", + "monaco-editor": "^0.52.2", + "pyodide": "^0.27.4", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-resizable-panels": "^3.0.0", + "shared": "0.0.0", + "smol-toml": "^1.3.1", + "ty_wasm": "file:ty_wasm" + }, + "overrides": { + "@monaco-editor/react": { + "react": "$react", + "react-dom": "$react-dom" + } + }, + "devDependencies": { + "vite-plugin-static-copy": "^3.0.0" + } +} diff --git a/playground/ty/public/Astral.png b/playground/ty/public/Astral.png new file mode 100644 index 0000000000000..012dd96ec26f9 Binary files /dev/null and b/playground/ty/public/Astral.png differ diff --git a/playground/ty/public/apple-touch-icon.png b/playground/ty/public/apple-touch-icon.png new file mode 100644 index 0000000000000..eae28581c31e5 Binary files /dev/null and b/playground/ty/public/apple-touch-icon.png differ diff --git a/playground/ty/public/favicon-16x16.png b/playground/ty/public/favicon-16x16.png new file mode 100644 index 0000000000000..10c29f0955899 Binary files /dev/null and b/playground/ty/public/favicon-16x16.png differ diff --git a/playground/ty/public/favicon-32x32.png b/playground/ty/public/favicon-32x32.png new file mode 100644 index 0000000000000..4c2ff24155a86 Binary files /dev/null and b/playground/ty/public/favicon-32x32.png differ diff --git a/playground/ty/public/favicon.ico b/playground/ty/public/favicon.ico new file mode 100644 index 0000000000000..1f3780390840a Binary files /dev/null and b/playground/ty/public/favicon.ico differ diff --git a/playground/ty/src/Editor/Chrome.tsx b/playground/ty/src/Editor/Chrome.tsx new file mode 100644 index 0000000000000..334f47a282610 --- /dev/null +++ b/playground/ty/src/Editor/Chrome.tsx @@ -0,0 +1,331 @@ +import { + lazy, + use, + useCallback, + useDeferredValue, + useMemo, + useRef, + useState, +} from "react"; +import { + ErrorMessage, + HorizontalResizeHandle, + Theme, + VerticalResizeHandle, +} from "shared"; +import type { Workspace } from "ty_wasm"; +import { Panel, PanelGroup } from "react-resizable-panels"; +import { Files, isPythonFile } from "./Files"; +import SecondarySideBar from "./SecondarySideBar"; +import SecondaryPanel, { + SecondaryPanelResult, + SecondaryTool, +} from "./SecondaryPanel"; +import Diagnostics, { Diagnostic } from "./Diagnostics"; +import { FileId, ReadonlyFiles } from "../Playground"; +import type { editor } from "monaco-editor"; +import type { Monaco } from "@monaco-editor/react"; + +const Editor = lazy(() => import("./Editor")); + +interface CheckResult { + diagnostics: Diagnostic[]; + error: string | null; + secondary: SecondaryPanelResult; +} + +export interface Props { + workspacePromise: Promise; + files: ReadonlyFiles; + theme: Theme; + selectedFileName: string; + + onAddFile(workspace: Workspace, name: string): void; + + onChangeFile(workspace: Workspace, content: string): void; + + onRenameFile(workspace: Workspace, file: FileId, newName: string): void; + + onRemoveFile(workspace: Workspace, file: FileId): void; + + onSelectFile(id: FileId): void; +} + +export default function Chrome({ + files, + selectedFileName, + workspacePromise, + theme, + onAddFile, + onRenameFile, + onRemoveFile, + onSelectFile, + onChangeFile, +}: Props) { + const workspace = use(workspacePromise); + + const [secondaryTool, setSecondaryTool] = useState( + null, + ); + + const editorRef = useRef<{ + editor: editor.IStandaloneCodeEditor; + monaco: Monaco; + } | null>(null); + + const handleFileRenamed = (file: FileId, newName: string) => { + onRenameFile(workspace, file, newName); + editorRef.current?.editor.focus(); + }; + + const handleSecondaryToolSelected = useCallback( + (tool: SecondaryTool | null) => { + setSecondaryTool((secondaryTool) => { + if (tool === secondaryTool) { + return null; + } + + return tool; + }); + }, + [], + ); + + const handleEditorMount = useCallback( + (editor: editor.IStandaloneCodeEditor, monaco: Monaco) => { + editorRef.current = { editor, monaco }; + }, + [], + ); + + const handleGoTo = useCallback((line: number, column: number) => { + const editor = editorRef.current?.editor; + + if (editor == null) { + return; + } + + const range = { + startLineNumber: line, + startColumn: column, + endLineNumber: line, + endColumn: column, + }; + editor.revealRange(range); + editor.setSelection(range); + }, []); + + const handleRemoved = useCallback( + async (id: FileId) => { + const name = files.index.find((file) => file.id === id)?.name; + + if (name != null && editorRef.current != null) { + // Remove the file from the monaco state to avoid that monaco "restores" the old content. + // An alternative is to use a `key` on the `Editor` but that means we lose focus and selection + // range when changing between tabs. + const monaco = await import("monaco-editor"); + editorRef.current.monaco.editor + .getModel(monaco.Uri.file(name)) + ?.dispose(); + } + + onRemoveFile(workspace, id); + }, + [workspace, files.index, onRemoveFile], + ); + + const checkResult = useCheckResult(files, workspace, secondaryTool); + + return ( + <> + {files.selected != null ? ( + <> + onAddFile(workspace, name)} + onRename={handleFileRenamed} + onSelect={onSelectFile} + onRemove={handleRemoved} + /> + + + + + onChangeFile(workspace, content)} + onOpenFile={onSelectFile} + /> + {checkResult.error ? ( +
+ {checkResult.error} +
+ ) : null} + + + + + + + + {secondaryTool != null && ( + <> + + + + + + )} + + + + ) : null} + + ); +} + +function useCheckResult( + files: ReadonlyFiles, + workspace: Workspace, + secondaryTool: SecondaryTool | null, +): CheckResult { + const deferredContent = useDeferredValue( + files.selected == null ? null : files.contents[files.selected], + ); + + return useMemo(() => { + if (files.selected == null || deferredContent == null) { + return { + diagnostics: [], + error: null, + secondary: null, + }; + } + + const currentHandle = files.handles[files.selected]; + if (currentHandle == null || !isPythonFile(currentHandle)) { + return { + diagnostics: [], + error: null, + secondary: null, + }; + } + + try { + const diagnostics = workspace.checkFile(currentHandle); + + let secondary: SecondaryPanelResult = null; + + try { + switch (secondaryTool) { + case "AST": + secondary = { + status: "ok", + content: workspace.parsed(currentHandle), + }; + break; + + case "Tokens": + secondary = { + status: "ok", + content: workspace.tokens(currentHandle), + }; + break; + + case "Run": + secondary = { + status: "ok", + content: "", + }; + break; + } + } catch (error: unknown) { + secondary = { + status: "error", + error: error instanceof Error ? error.message : error + "", + }; + } + + // Eagerly convert the diagnostic to avoid out of bound errors + // when the diagnostics are "deferred". + const serializedDiagnostics = diagnostics.map((diagnostic) => ({ + id: diagnostic.id(), + message: diagnostic.message(), + severity: diagnostic.severity(), + range: diagnostic.toRange(workspace) ?? null, + textRange: diagnostic.textRange() ?? null, + })); + + return { + diagnostics: serializedDiagnostics, + error: null, + secondary, + }; + } catch (e) { + // eslint-disable-next-line no-console + console.error(e); + + return { + diagnostics: [], + error: formatError(e), + secondary: null, + }; + } + }, [ + deferredContent, + workspace, + files.selected, + files.handles, + secondaryTool, + ]); +} + +export function formatError(error: unknown): string { + const message = error instanceof Error ? error.message : `${error}`; + return message.startsWith("Error: ") + ? message.slice("Error: ".length) + : message; +} diff --git a/playground/ty/src/Editor/Diagnostics.tsx b/playground/ty/src/Editor/Diagnostics.tsx new file mode 100644 index 0000000000000..c1a395d2a12ff --- /dev/null +++ b/playground/ty/src/Editor/Diagnostics.tsx @@ -0,0 +1,106 @@ +import type { Severity, Range, TextRange } from "ty_wasm"; +import classNames from "classnames"; +import { Theme } from "shared"; +import { useMemo } from "react"; + +interface Props { + diagnostics: Diagnostic[]; + theme: Theme; + + onGoTo(line: number, column: number): void; +} + +export default function Diagnostics({ + diagnostics: unsorted, + theme, + onGoTo, +}: Props) { + const diagnostics = useMemo(() => { + const sorted = [...unsorted]; + sorted.sort((a, b) => { + return (a.textRange?.start ?? 0) - (b.textRange?.start ?? 0); + }); + + return sorted; + }, [unsorted]); + + return ( +
+
+ File diagnostics ({diagnostics.length}) +
+ +
+ +
+
+ ); +} + +function Items({ + diagnostics, + onGoTo, +}: { + diagnostics: Array; + onGoTo(line: number, column: number): void; +}) { + if (diagnostics.length === 0) { + return ( +
+ Everything is looking good! +
+ ); + } + + const uniqueIds: Map = new Map(); + + return ( +
    + {diagnostics.map((diagnostic) => { + const position = diagnostic.range; + const start = position?.start; + const id = diagnostic.id; + + const startLine = start?.line ?? 1; + const startColumn = start?.column ?? 1; + + const mostlyUniqueId = `${startLine}:${startColumn}-${id}`; + + const disambiguator = uniqueIds.get(mostlyUniqueId) ?? 0; + uniqueIds.set(mostlyUniqueId, disambiguator + 1); + + return ( +
  • + +
    • + ); + })} +
+ ); +} + +export interface Diagnostic { + id: string; + message: string; + severity: Severity; + range: Range | null; + textRange: TextRange | null; +} diff --git a/playground/ty/src/Editor/Editor.tsx b/playground/ty/src/Editor/Editor.tsx new file mode 100644 index 0000000000000..7936ce5ac89aa --- /dev/null +++ b/playground/ty/src/Editor/Editor.tsx @@ -0,0 +1,467 @@ +/** + * Editor for the Python source code. + */ + +import Moncao, { Monaco, OnMount } from "@monaco-editor/react"; +import { + CancellationToken, + editor, + IDisposable, + IPosition, + IRange, + languages, + MarkerSeverity, + Position, + Range, + Uri, +} from "monaco-editor"; +import { useCallback, useEffect, useRef } from "react"; +import { Theme } from "shared"; +import { + Range as TyRange, + Severity, + type Workspace, + Position as TyPosition, +} from "ty_wasm"; + +import IStandaloneCodeEditor = editor.IStandaloneCodeEditor; +import { FileId, ReadonlyFiles } from "../Playground"; +import { isPythonFile } from "./Files"; +import { Diagnostic } from "./Diagnostics"; + +type Props = { + visible: boolean; + fileName: string; + selected: FileId; + files: ReadonlyFiles; + diagnostics: Diagnostic[]; + theme: Theme; + workspace: Workspace; + onChange(content: string): void; + onMount(editor: IStandaloneCodeEditor, monaco: Monaco): void; + onOpenFile(file: FileId): void; +}; + +export default function Editor({ + visible, + fileName, + selected, + files, + theme, + diagnostics, + workspace, + onChange, + onMount, + onOpenFile, +}: Props) { + const serverRef = useRef(null); + + if (serverRef.current != null) { + serverRef.current.update({ + files, + workspace, + onOpenFile, + }); + } + + // Update the diagnostics in the editor. + useEffect(() => { + const server = serverRef.current; + + if (server == null) { + return; + } + + server.updateDiagnostics(diagnostics); + }, [diagnostics]); + + const handleChange = useCallback( + (value: string | undefined) => { + onChange(value ?? ""); + }, + [onChange], + ); + + useEffect(() => { + return () => { + const server = serverRef.current; + + if (server != null) { + server.dispose(); + } + }; + }, []); + + const handleMount: OnMount = useCallback( + (editor, instance) => { + serverRef.current?.dispose(); + + const server = new PlaygroundServer(instance, { + workspace, + files, + onOpenFile, + }); + + server.updateDiagnostics(diagnostics); + serverRef.current = server; + + onMount(editor, instance); + }, + + [files, onOpenFile, workspace, onMount, diagnostics], + ); + + return ( + + ); +} + +interface PlaygroundServerProps { + workspace: Workspace; + files: ReadonlyFiles; + onOpenFile: (file: FileId) => void; +} + +class PlaygroundServer + implements + languages.TypeDefinitionProvider, + editor.ICodeEditorOpener, + languages.HoverProvider, + languages.InlayHintsProvider, + languages.DocumentFormattingEditProvider +{ + private typeDefinitionProviderDisposable: IDisposable; + private editorOpenerDisposable: IDisposable; + private hoverDisposable: IDisposable; + private inlayHintsDisposable: IDisposable; + private formatDisposable: IDisposable; + + constructor( + private monaco: Monaco, + private props: PlaygroundServerProps, + ) { + this.typeDefinitionProviderDisposable = + monaco.languages.registerTypeDefinitionProvider("python", this); + this.hoverDisposable = monaco.languages.registerHoverProvider( + "python", + this, + ); + this.inlayHintsDisposable = monaco.languages.registerInlayHintsProvider( + "python", + this, + ); + this.editorOpenerDisposable = monaco.editor.registerEditorOpener(this); + this.formatDisposable = + monaco.languages.registerDocumentFormattingEditProvider("python", this); + } + + provideInlayHints( + _model: editor.ITextModel, + range: Range, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _token: CancellationToken, + ): languages.ProviderResult { + const workspace = this.props.workspace; + const selectedFile = this.props.files.selected; + + if (selectedFile == null) { + return; + } + + const selectedHandle = this.props.files.handles[selectedFile]; + + if (selectedHandle == null) { + return; + } + + const inlayHints = workspace.inlayHints( + selectedHandle, + MonacoRangeToTyRange(range), + ); + + if (inlayHints.length === 0) { + return undefined; + } + + return { + dispose: () => {}, + hints: inlayHints.map((hint) => ({ + label: hint.markdown, + position: { + lineNumber: hint.position.line, + column: hint.position.column, + }, + })), + }; + } + + resolveInlayHint( + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _hint: languages.InlayHint, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _token: CancellationToken, + ): languages.ProviderResult { + return undefined; + } + + update(props: PlaygroundServerProps) { + this.props = props; + } + + updateDiagnostics(diagnostics: Array) { + if (this.props.files.selected == null) { + return; + } + + const handle = this.props.files.handles[this.props.files.selected]; + + if (handle == null) { + return; + } + + const editor = this.monaco.editor; + const model = editor.getModel(Uri.parse(handle.path())); + + if (model == null) { + return; + } + + editor.setModelMarkers( + model, + "owner", + diagnostics.map((diagnostic) => { + const mapSeverity = (severity: Severity) => { + switch (severity) { + case Severity.Info: + return MarkerSeverity.Info; + case Severity.Warning: + return MarkerSeverity.Warning; + case Severity.Error: + return MarkerSeverity.Error; + case Severity.Fatal: + return MarkerSeverity.Error; + } + }; + + const range = diagnostic.range; + + return { + code: diagnostic.id, + startLineNumber: range?.start?.line ?? 0, + startColumn: range?.start?.column ?? 0, + endLineNumber: range?.end?.line ?? 0, + endColumn: range?.end?.column ?? 0, + message: diagnostic.message, + severity: mapSeverity(diagnostic.severity), + tags: [], + }; + }), + ); + } + + provideHover( + model: editor.ITextModel, + position: Position, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _token: CancellationToken, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + context?: languages.HoverContext | undefined, + ): languages.ProviderResult { + const workspace = this.props.workspace; + + const selectedFile = this.props.files.selected; + if (selectedFile == null) { + return; + } + + const selectedHandle = this.props.files.handles[selectedFile]; + + if (selectedHandle == null) { + return; + } + + const hover = workspace.hover( + selectedHandle, + new TyPosition(position.lineNumber, position.column), + ); + + if (hover == null) { + return; + } + + return { + range: tyRangeToMonacoRange(hover.range), + contents: [{ value: hover.markdown, isTrusted: true }], + }; + } + + provideTypeDefinition( + model: editor.ITextModel, + position: Position, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _: CancellationToken, + ): languages.ProviderResult { + const workspace = this.props.workspace; + + const selectedFile = this.props.files.selected; + if (selectedFile == null) { + return; + } + + const selectedHandle = this.props.files.handles[selectedFile]; + + if (selectedHandle == null) { + return; + } + + const links = workspace.gotoTypeDefinition( + selectedHandle, + new TyPosition(position.lineNumber, position.column), + ); + + return ( + links + .map((link) => { + const targetSelection = + link.selection_range == null + ? undefined + : tyRangeToMonacoRange(link.selection_range); + + const originSelection = + link.origin_selection_range == null + ? undefined + : tyRangeToMonacoRange(link.origin_selection_range); + + return { + uri: Uri.parse(link.path), + range: tyRangeToMonacoRange(link.full_range), + targetSelectionRange: targetSelection, + originSelectionRange: originSelection, + } as languages.LocationLink; + }) + // Filter out vendored files because they aren't open in the editor. + .filter((link) => link.uri.scheme !== "vendored") + ); + } + + openCodeEditor( + source: editor.ICodeEditor, + resource: Uri, + selectionOrPosition?: IRange | IPosition, + ): boolean { + const files = this.props.files; + + const fileId = files.index.find((file) => { + return Uri.file(file.name).toString() === resource.toString(); + })?.id; + + if (fileId == null) { + return false; + } + + const handle = files.handles[fileId]; + + let model = this.monaco.editor.getModel(resource); + if (model == null) { + const language = + handle != null && isPythonFile(handle) ? "python" : undefined; + model = this.monaco.editor.createModel( + files.contents[fileId], + language, + resource, + ); + } + + // it's a bit hacky to create the model manually + // but only using `onOpenFile` isn't enough + // because the model doesn't get updated until the next render. + if (files.selected !== fileId) { + source.setModel(model); + + this.props.onOpenFile(fileId); + } + + if (selectionOrPosition != null) { + if (Position.isIPosition(selectionOrPosition)) { + source.setPosition(selectionOrPosition); + source.revealPosition(selectionOrPosition); + } else { + source.setSelection(selectionOrPosition); + source.revealPosition({ + lineNumber: selectionOrPosition.startLineNumber, + column: selectionOrPosition.startColumn, + }); + } + } + + return true; + } + + provideDocumentFormattingEdits( + model: editor.ITextModel, + ): languages.ProviderResult { + if (this.props.files.selected == null) { + return null; + } + + const fileHandle = this.props.files.handles[this.props.files.selected]; + + if (fileHandle == null) { + return null; + } + + const formatted = this.props.workspace.format(fileHandle); + if (formatted != null) { + return [ + { + range: model.getFullModelRange(), + text: formatted, + }, + ]; + } + + return null; + } + + dispose() { + this.hoverDisposable.dispose(); + this.editorOpenerDisposable.dispose(); + this.typeDefinitionProviderDisposable.dispose(); + this.inlayHintsDisposable.dispose(); + this.formatDisposable.dispose(); + } +} + +function tyRangeToMonacoRange(range: TyRange): IRange { + return { + startLineNumber: range.start.line, + startColumn: range.start.column, + endLineNumber: range.end.line, + endColumn: range.end.column, + }; +} + +function MonacoRangeToTyRange(range: IRange): TyRange { + return new TyRange( + new TyPosition(range.startLineNumber, range.startColumn), + new TyPosition(range.endLineNumber, range.endColumn), + ); +} diff --git a/playground/ty/src/Editor/Files.tsx b/playground/ty/src/Editor/Files.tsx new file mode 100644 index 0000000000000..d345754901331 --- /dev/null +++ b/playground/ty/src/Editor/Files.tsx @@ -0,0 +1,204 @@ +import { Icons, Theme } from "shared"; +import classNames from "classnames"; +import { useState } from "react"; +import { FileId } from "../Playground"; +import { type FileHandle } from "ty_wasm"; + +export interface Props { + // The file names + files: ReadonlyArray<{ id: FileId; name: string }>; + theme: Theme; + selected: FileId; + + onAdd(name: string): void; + + onRemove(id: FileId): void; + + onSelect(id: FileId): void; + + onRename(id: FileId, newName: string): void; +} + +export function Files({ + files, + selected, + theme, + onAdd, + onRemove, + onRename, + onSelect, +}: Props) { + const handleAdd = () => { + let index: number | null = null; + let fileName = "module.py"; + + while (files.some(({ name }) => name === fileName)) { + index = (index ?? 0) + 1; + fileName = `module${index}.py`; + } + + onAdd(fileName); + }; + + const lastFile = files.length === 1; + + return ( +
    + {files.map(({ id, name }) => ( + + onSelect(id)} + onRenamed={(newName) => { + if (!files.some(({ name }) => name === newName)) { + onRename(id, newName); + } + }} + /> + + + + ))} + + + +
+ ); +} + +interface ListItemProps { + selected: boolean; + children: React.ReactNode; + theme: Theme; +} + +function ListItem({ children, selected, theme }: ListItemProps) { + const activeBorderColor = + theme === "light" ? "border-galaxy" : "border-radiate"; + + return ( +
  • + {children} +
    • + ); +} + +interface FileEntryProps { + selected: boolean; + name: string; + + onClicked(): void; + + onRenamed(name: string): void; +} + +function FileEntry({ name, onClicked, onRenamed, selected }: FileEntryProps) { + const [newName, setNewName] = useState(null); + + if (!selected && newName != null) { + setNewName(null); + } + + const handleRenamed = (newName: string) => { + setNewName(null); + if (name !== newName) { + onRenamed(newName); + } + }; + + const extension = name.split(".").pop()?.toLowerCase(); + + const icon = + extension === "py" || extension === "pyi" ? ( + + ) : extension === "json" ? ( + + ) : extension === "ipynb" ? ( + + ) : ( + + ); + + return ( + + ); +} + +export function isPythonFile(handle: FileHandle): boolean { + const extension = handle?.path().toLowerCase().split(".").pop() ?? ""; + return ["py", "pyi", "pyw"].includes(extension); +} diff --git a/playground/ty/src/Editor/SecondaryPanel.tsx b/playground/ty/src/Editor/SecondaryPanel.tsx new file mode 100644 index 0000000000000..191e1c8d9fb07 --- /dev/null +++ b/playground/ty/src/Editor/SecondaryPanel.tsx @@ -0,0 +1,217 @@ +import MonacoEditor from "@monaco-editor/react"; +import { AstralButton, Theme } from "shared"; +import { ReadonlyFiles } from "../Playground"; +import { Suspense, use, useState } from "react"; +import { loadPyodide, PyodideInterface } from "pyodide"; +import classNames from "classnames"; + +export enum SecondaryTool { + "AST" = "AST", + "Tokens" = "Tokens", + "Run" = "Run", +} + +export type SecondaryPanelResult = + | null + | { status: "ok"; content: string } + | { status: "error"; error: string }; + +export interface SecondaryPanelProps { + files: ReadonlyFiles; + tool: SecondaryTool; + result: SecondaryPanelResult; + theme: Theme; +} + +export default function SecondaryPanel({ + tool, + result, + files, + theme, +}: SecondaryPanelProps) { + return ( +
    + +
    + ); +} + +function Content({ + files, + tool, + result, + theme, + revision, +}: { + tool: SecondaryTool; + files: ReadonlyFiles; + revision: number; + result: SecondaryPanelResult; + theme: Theme; +}) { + if (result == null) { + return ""; + } else { + let language; + switch (result.status) { + case "ok": + switch (tool) { + case "AST": + language = "RustPythonAst"; + break; + + case "Tokens": + language = "RustPythonTokens"; + break; + + case "Run": + return ; + } + + return ( +
    + +
    + ); + case "error": + return ( +
    + {result.error} +
    + ); + } + } +} + +let pyodidePromise: Promise | null = null; + +function Run({ files, theme }: { files: ReadonlyFiles; theme: Theme }) { + if (pyodidePromise == null) { + pyodidePromise = loadPyodide(); + } + + return ( + Loading} + > + + + ); +} + +function RunWithPyiodide({ + files, + pyodidePromise, + theme, +}: { + files: ReadonlyFiles; + theme: Theme; + pyodidePromise: Promise; +}) { + const pyodide = use(pyodidePromise); + + const [output, setOutput] = useState(null); + + if (output == null) { + const handleRun = () => { + let combined_output = ""; + + const outputHandler = (output: string) => { + combined_output += output + "\n"; + }; + + pyodide.setStdout({ batched: outputHandler }); + pyodide.setStderr({ batched: outputHandler }); + + const main = files.selected == null ? "" : files.contents[files.selected]; + + let fileName = "main.py"; + for (const file of files.index) { + pyodide.FS.writeFile(file.name, files.contents[file.id]); + + if (file.id === files.selected) { + fileName = file.name; + } + } + + const dict = pyodide.globals.get("dict"); + const globals = dict(); + + try { + // Patch up reveal types + pyodide.runPython(` + import builtins + + def reveal_type(obj): + import typing + print(f"Runtime value is '{obj}'") + return typing.reveal_type(obj) + + builtins.reveal_type = reveal_type`); + + pyodide.runPython(main, { + globals, + locals: globals, + filename: fileName, + }); + + setOutput(combined_output); + } catch (e) { + setOutput(`Failed to run Python script: ${e}`); + } finally { + globals.destroy(); + dict.destroy(); + } + }; + return ( +
    + + + Run... + + +
    + ); + } + return ( + 
    +      {output}
+
    + ); +} diff --git a/playground/ty/src/Editor/SecondarySideBar.tsx b/playground/ty/src/Editor/SecondarySideBar.tsx new file mode 100644 index 0000000000000..a4909d611f4a4 --- /dev/null +++ b/playground/ty/src/Editor/SecondarySideBar.tsx @@ -0,0 +1,40 @@ +import { Icons, SideBar, SideBarEntry } from "shared"; +import { SecondaryTool } from "./SecondaryPanel"; + +interface Props { + selected: SecondaryTool | null; + + onSelected(tool: SecondaryTool): void; +} + +export default function SecondarySideBar({ selected, onSelected }: Props) { + return ( + + onSelected(SecondaryTool.AST)} + > + + + + onSelected(SecondaryTool.Tokens)} + > + + + onSelected(SecondaryTool.Run)} + > + + + + ); +} diff --git a/playground/ty/src/Editor/api.ts b/playground/ty/src/Editor/api.ts new file mode 100644 index 0000000000000..e039a57f1f46c --- /dev/null +++ b/playground/ty/src/Editor/api.ts @@ -0,0 +1,38 @@ +const API_URL = import.meta.env.PROD + ? "https://api.astral-1ad.workers.dev" + : "http://0.0.0.0:8787"; + +export type Playground = { + files: { [name: string]: string }; + /// the name of the current file + current: string; +}; + +/** + * Fetch a playground by ID. + */ +export async function fetchPlayground(id: string): Promise { + const response = await fetch(`${API_URL}/${encodeURIComponent(id)}`); + + if (!response.ok) { + throw new Error(`Failed to fetch playground ${id}: ${response.status}`); + } + + return await response.json(); +} + +/** + * Save a playground and return its ID. + */ +export async function savePlayground(playground: Playground): Promise { + const response = await fetch(API_URL, { + method: "POST", + body: JSON.stringify(playground), + }); + + if (!response.ok) { + throw new Error(`Failed to save playground: ${response.status}`); + } + + return await response.text(); +} diff --git a/playground/ty/src/Editor/persist.ts b/playground/ty/src/Editor/persist.ts new file mode 100644 index 0000000000000..2adc5f3fe9e5b --- /dev/null +++ b/playground/ty/src/Editor/persist.ts @@ -0,0 +1,54 @@ +import { fetchPlayground, savePlayground } from "./api"; + +interface Workspace { + files: { [name: string]: string }; + + // Name of the current file + current: string; +} + +/** + * Persist the configuration to a URL. + */ +export async function persist(workspace: Workspace): Promise { + const id = await savePlayground(workspace); + + await navigator.clipboard.writeText( + `${window.location.origin}/${encodeURIComponent(id)}`, + ); +} + +/** + * Restore the workspace by fetching the data for the ID specified in the URL + * or by restoring from local storage. + */ +export async function restore(): Promise { + // URLs stored in the database, like: + // https://play.ruff.rs/1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed + const id = window.location.pathname.slice(1); + if (id !== "") { + const playground = await fetchPlayground(id); + if (playground == null) { + return null; + } + + return playground; + } + + // If no URL is present, restore from local storage. + return restoreLocal(); +} + +export function persistLocal(workspace: Workspace) { + localStorage.setItem("workspace", JSON.stringify(workspace)); +} + +function restoreLocal(): Workspace | null { + const workspace = localStorage.getItem("workspace"); + + if (workspace == null) { + return null; + } else { + return JSON.parse(workspace); + } +} diff --git a/playground/ty/src/Playground.tsx b/playground/ty/src/Playground.tsx new file mode 100644 index 0000000000000..eca7f6657b6dc --- /dev/null +++ b/playground/ty/src/Playground.tsx @@ -0,0 +1,555 @@ +import { + ActionDispatch, + Suspense, + useCallback, + useDeferredValue, + useEffect, + useMemo, + useReducer, + useRef, + useState, +} from "react"; +import { ErrorMessage, Header, setupMonaco, useTheme } from "shared"; +import { FileHandle, PositionEncoding, Workspace } from "ty_wasm"; +import { persist, persistLocal, restore } from "./Editor/persist"; +import { loader } from "@monaco-editor/react"; +import tySchema from "../../../ty.schema.json"; +import Chrome, { formatError } from "./Editor/Chrome"; + +export const SETTINGS_FILE_NAME = "ty.json"; + +export default function Playground() { + const [theme, setTheme] = useTheme(); + const [version, setVersion] = useState("0.0.0"); + const [error, setError] = useState(null); + const workspacePromiseRef = useRef | null>(null); + const [workspace, setWorkspace] = useState(null); + + let workspacePromise = workspacePromiseRef.current; + if (workspacePromise == null) { + workspacePromiseRef.current = workspacePromise = startPlayground().then( + (fetched) => { + setVersion(fetched.version); + const workspace = new Workspace("/", PositionEncoding.Utf16, {}); + restoreWorkspace(workspace, fetched.workspace, dispatchFiles, setError); + setWorkspace(workspace); + return workspace; + }, + ); + } + + const [files, dispatchFiles] = useReducer(filesReducer, INIT_FILES_STATE); + + const fileName = useMemo(() => { + return ( + files.index.find((file) => file.id === files.selected)?.name ?? "lib.py" + ); + }, [files.index, files.selected]); + + usePersistLocally(files); + + const handleShare = useCallback(() => { + const serialized = serializeFiles(files); + + if (serialized != null) { + persist(serialized).catch((error) => { + // eslint-disable-next-line no-console + console.error("Failed to share playground", error); + }); + } + }, [files]); + + const handleFileAdded = (workspace: Workspace, name: string) => { + let handle = null; + + if (name === SETTINGS_FILE_NAME) { + updateOptions(workspace, "{}", setError); + } else { + handle = workspace.openFile(name, ""); + } + + dispatchFiles({ type: "add", name, handle, content: "" }); + }; + + const handleFileChanged = (workspace: Workspace, content: string) => { + if (files.selected == null) { + return; + } + + dispatchFiles({ + type: "change", + id: files.selected, + content, + }); + + const handle = files.handles[files.selected]; + + if (handle != null) { + updateFile(workspace, handle, content, setError); + } else if (fileName === SETTINGS_FILE_NAME) { + updateOptions(workspace, content, setError); + } + }; + + const handleFileRenamed = ( + workspace: Workspace, + file: FileId, + newName: string, + ) => { + const handle = files.handles[file]; + let newHandle: FileHandle | null = null; + if (handle == null) { + updateOptions(workspace, null, setError); + } else { + workspace.closeFile(handle); + } + + if (newName === SETTINGS_FILE_NAME) { + updateOptions(workspace, files.contents[file], setError); + } else { + newHandle = workspace.openFile(newName, files.contents[file]); + } + + dispatchFiles({ type: "rename", id: file, to: newName, newHandle }); + }; + + const handleFileRemoved = (workspace: Workspace, file: FileId) => { + const handle = files.handles[file]; + if (handle == null) { + updateOptions(workspace, null, setError); + } else { + workspace.closeFile(handle); + } + + dispatchFiles({ type: "remove", id: file }); + }; + + const handleFileSelected = useCallback((file: FileId) => { + dispatchFiles({ type: "selectFile", id: file }); + }, []); + + const handleReset = useCallback(() => { + if (workspace == null) { + return; + } + + // Close all open files + for (const file of files.index) { + const handle = files.handles[file.id]; + + if (handle != null) { + try { + workspace.closeFile(handle); + } catch (e) { + setError(formatError(e)); + } + } + } + + dispatchFiles({ type: "reset" }); + + restoreWorkspace(workspace, DEFAULT_WORKSPACE, dispatchFiles, setError); + }, [files.handles, files.index, workspace]); + + return ( +
    +
    + + }> + + + {error ? ( +
    + {error} +
    + ) : null} +
    + ); +} + +export const DEFAULT_SETTINGS = JSON.stringify( + { + environment: { + "python-version": "3.13", + }, + rules: { + "division-by-zero": "error", + }, + }, + null, + 4, +); + +const DEFAULT_PROGRAM = `from typing import Literal + +type Style = Literal["italic", "bold", "underline"] + +# Add parameter annotations \`line: str, word: str, style: Style\` and a return +# type annotation \`-> str\` to see if you can find the mistakes in this program. + +def with_style(line, word, style): + if style == "italic": + return line.replace(word, f"*{word}*") + elif style == "bold": + return line.replace(word, f"__{word}__") + + position = line.find(word) + output = line + "\\n" + output += " " * position + output += "-" * len(word) + + +print(with_style("ty is a fast type checker for Python.", "fast", "underlined")) +`; + +const DEFAULT_WORKSPACE = { + files: { + "main.py": DEFAULT_PROGRAM, + "ty.json": DEFAULT_SETTINGS, + }, + current: "main.py", +}; + +/** + * Persists the files to local storage. This is done deferred to avoid too frequent writes. + */ +function usePersistLocally(files: FilesState): void { + const deferredFiles = useDeferredValue(files); + + useEffect(() => { + const serialized = serializeFiles(deferredFiles); + if (serialized != null) { + persistLocal(serialized); + } + }, [deferredFiles]); +} + +export type FileId = number; + +export type ReadonlyFiles = Readonly; + +interface FilesState { + /** + * The currently selected file that is shown in the editor. + */ + selected: FileId | null; + + /** + * The files in display order (ordering is sensitive) + */ + index: ReadonlyArray<{ id: FileId; name: string }>; + + /** + * The database file handles by file id. + * + * Files without a file handle are well-known files that are only handled by the + * playground (e.g. ty.json) + */ + handles: Readonly<{ [id: FileId]: FileHandle | null }>; + + /** + * The content per file indexed by file id. + */ + contents: Readonly<{ [id: FileId]: string }>; + + /** + * The revision. Gets incremented every time files changes. + */ + revision: number; + + /** + * Revision identifying this playground. Gets incremented every time the + * playground is reset. + */ + playgroundRevision: number; + + nextId: FileId; +} + +export type FileAction = + | { + type: "add"; + handle: FileHandle | null; + /// The file name + name: string; + content: string; + } + | { + type: "change"; + id: FileId; + content: string; + } + | { type: "rename"; id: FileId; to: string; newHandle: FileHandle | null } + | { + type: "remove"; + id: FileId; + } + | { type: "selectFile"; id: FileId } + | { type: "selectFileByName"; name: string } + | { type: "reset" }; + +const INIT_FILES_STATE: ReadonlyFiles = { + index: [], + contents: Object.create(null), + handles: Object.create(null), + nextId: 0, + revision: 0, + selected: null, + playgroundRevision: 0, +}; + +function filesReducer( + state: Readonly, + action: FileAction, +): FilesState { + switch (action.type) { + case "add": { + const { handle, name, content } = action; + const id = state.nextId; + return { + ...state, + selected: id, + index: [...state.index, { id, name }], + handles: { ...state.handles, [id]: handle }, + contents: { ...state.contents, [id]: content }, + nextId: state.nextId + 1, + revision: state.revision + 1, + }; + } + + case "change": { + const { id, content } = action; + return { + ...state, + contents: { ...state.contents, [id]: content }, + revision: state.revision + 1, + }; + } + + case "remove": { + const { id } = action; + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const { [id]: _content, ...contents } = state.contents; + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const { [id]: _handle, ...handles } = state.handles; + + let selected = state.selected; + + if (state.selected === id) { + const index = state.index.findIndex((file) => file.id === id); + + selected = + index > 0 ? state.index[index - 1].id : state.index[index + 1].id; + } + + return { + ...state, + selected, + index: state.index.filter((file) => file.id !== id), + contents, + handles, + revision: state.revision + 1, + }; + } + case "rename": { + const { id, to, newHandle } = action; + + const index = state.index.findIndex((file) => file.id === id); + const newIndex = [...state.index]; + newIndex.splice(index, 1, { id, name: to }); + + return { + ...state, + index: newIndex, + handles: { ...state.handles, [id]: newHandle }, + }; + } + + case "selectFile": { + const { id } = action; + + return { + ...state, + selected: id, + }; + } + + case "selectFileByName": { + const { name } = action; + + const selected = + state.index.find((file) => file.name === name)?.id ?? null; + + return { + ...state, + selected, + }; + } + + case "reset": { + return { + ...INIT_FILES_STATE, + playgroundRevision: state.playgroundRevision + 1, + revision: state.revision + 1, + }; + } + } +} + +function serializeFiles(files: FilesState): { + files: { [name: string]: string }; + current: string; +} | null { + const serializedFiles = Object.create(null); + let selected = null; + + for (const { id, name } of files.index) { + serializedFiles[name] = files.contents[id]; + + if (files.selected === id) { + selected = name; + } + } + + if (selected == null) { + return null; + } + + return { files: serializedFiles, current: selected }; +} + +export interface InitializedPlayground { + version: string; + workspace: { files: { [name: string]: string }; current: string }; +} + +// Run once during startup. Initializes monaco, loads the wasm file, and restores the previous editor state. +async function startPlayground(): Promise { + const ty = await import("../ty_wasm"); + await ty.default(); + const monaco = await loader.init(); + + setupMonaco(monaco, { + uri: "https://raw.githubusercontent.com/astral-sh/ruff/main/ty.schema.json", + fileMatch: ["ty.json"], + schema: tySchema, + }); + + const restored = await restore(); + + const workspace = restored ?? DEFAULT_WORKSPACE; + + return { + version: "0.0.0", + workspace, + }; +} + +function updateOptions( + workspace: Workspace | null, + content: string | null, + setError: (error: string | null) => void, +) { + content = content ?? DEFAULT_SETTINGS; + + try { + const settings = JSON.parse(content); + workspace?.updateOptions(settings); + setError(null); + } catch (error) { + setError(`Failed to update 'ty.json' options: ${formatError(error)}`); + } +} + +function updateFile( + workspace: Workspace, + handle: FileHandle, + content: string, + setError: (error: string | null) => void, +) { + try { + workspace.updateFile(handle, content); + setError(null); + } catch (error) { + setError(`Failed to update file: ${formatError(error)}`); + } +} + +function Loading() { + return ( +
    + Loading... +
    + ); +} + +function restoreWorkspace( + workspace: Workspace, + state: { + files: { [name: string]: string }; + current: string; + }, + dispatchFiles: ActionDispatch<[FileAction]>, + setError: (error: string | null) => void, +) { + let hasSettings = false; + + // eslint-disable-next-line prefer-const + for (let [name, content] of Object.entries(state.files)) { + let handle = null; + + if ( + name === "knot.json" && + !Object.keys(state.files).includes(SETTINGS_FILE_NAME) + ) { + name = SETTINGS_FILE_NAME; + } + + if (name === SETTINGS_FILE_NAME) { + updateOptions(workspace, content, setError); + hasSettings = true; + } else { + handle = workspace.openFile(name, content); + } + + dispatchFiles({ type: "add", handle, content, name }); + } + + if (!hasSettings) { + updateOptions(workspace, null, setError); + } + + const selected = + state.current === "knot.json" ? SETTINGS_FILE_NAME : state.current; + + dispatchFiles({ + type: "selectFileByName", + name: selected, + }); +} diff --git a/playground/ty/src/index.css b/playground/ty/src/index.css new file mode 100644 index 0000000000000..ddf502c867552 --- /dev/null +++ b/playground/ty/src/index.css @@ -0,0 +1,126 @@ +@import "tailwindcss"; + +@source "../../shared/"; + +@custom-variant dark (&:is(.dark *)); + +@theme { + --color-ayu-accent: #ffac2f; + + --color-ayu-background: #f8f9fa; + --color-ayu-background-dark: #0b0e14; + + --color-black: #261230; + --color-white: #ffffff; + --color-radiate: #d7ff64; + --color-flare: #6340ac; + --color-rock: #78876e; + --color-galaxy: #261230; + --color-space: #30173d; + --color-comet: #6f5d6f; + --color-cosmic: #de5fe9; + --color-sun: #ffac2f; + --color-electron: #46ebe1; + --color-aurora: #46eb74; + --color-constellation: #5f6de9; + --color-neutron: #cff3cf; + --color-proton: #f6afbc; + --color-nebula: #cdcbfb; + --color-supernova: #f1aff6; + --color-starlight: #f4f4f1; + --color-lunar: #fbf2fc; + --color-asteroid: #e3cee3; + --color-crater: #f0dfdf; + + --font-heading: + Alliance Platt, system-ui, -apple-system, Segoe UI, Roboto, Helvetica, + Arial, monospace, Apple Color Emoji, Segoe UI Emoji; + --font-body: + Alliance Text, system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial, + sans-serif, Apple Color Emoji, Segoe UI Emoji; + --font-mono: + Roboto Mono, ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, + "Liberation Mono", "Courier New", monospace; + + --text-xs: 0.75rem; + --text-sm: 0.875rem; + --text-base: 1rem; + --text-lg: 1.125rem; + --text-xl: 1.25rem; + --text-2xl: 1.5rem; + --text-3xl: 1.875rem; + --text-4xl: 2.25rem; + --text-5xl: 3rem; +} + +* { + box-sizing: border-box; +} + +body, +html, +#root { + margin: 0; + height: 100%; + width: 100%; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +.shadow-copied { + --tw-shadow: 0 0 0 1px var(--color-white), inset 0 0 0 1px var(--color-white); + --tw-shadow-colored: + 0 0 0 1px var(--tw-shadow-color), inset 0 0 0 1px var(--tw-shadow-color); + + box-shadow: + var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), + var(--tw-shadow); +} + +@font-face { + font-family: "Alliance Text"; + src: + url("https://static.astral.sh/fonts/Alliance-TextRegular.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-TextRegular.woff") + format("woff"); + font-weight: normal; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Text"; + src: + url("https://static.astral.sh/fonts/Alliance-TextMedium.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-TextMedium.woff") + format("woff"); + font-weight: 500; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Platt"; + src: + url("https://static.astral.sh/fonts/Alliance-PlattMedium.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-PlattMedium.woff") + format("woff"); + font-weight: 500; + font-style: normal; + font-display: block; +} + +@font-face { + font-family: "Alliance Platt"; + src: + url("https://static.astral.sh/fonts/Alliance-PlattRegular.woff2") + format("woff2"), + url("https://static.astral.sh/fonts/Alliance-PlattRegular.woff") + format("woff"); + font-weight: normal; + font-style: normal; + font-display: block; +} diff --git a/playground/ty/src/main.tsx b/playground/ty/src/main.tsx new file mode 100644 index 0000000000000..d285d8abfb7a2 --- /dev/null +++ b/playground/ty/src/main.tsx @@ -0,0 +1,10 @@ +import React from "react"; +import ReactDOM from "react-dom/client"; +import "./index.css"; +import Playground from "./Playground"; + +ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render( + + + , +); diff --git a/playground/ty/src/third-party.d.ts b/playground/ty/src/third-party.d.ts new file mode 100644 index 0000000000000..9ce038a9cad5d --- /dev/null +++ b/playground/ty/src/third-party.d.ts @@ -0,0 +1,6 @@ +declare module "lz-string" { + function decompressFromEncodedURIComponent( + input: string | null, + ): string | null; + function compressToEncodedURIComponent(input: string | null): string; +} diff --git a/playground/ty/src/vite-env.d.ts b/playground/ty/src/vite-env.d.ts new file mode 100644 index 0000000000000..11f02fe2a0061 --- /dev/null +++ b/playground/ty/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/playground/ty/vite.config.ts b/playground/ty/vite.config.ts new file mode 100644 index 0000000000000..4011bb6f8d63c --- /dev/null +++ b/playground/ty/vite.config.ts @@ -0,0 +1,31 @@ +import { defineConfig } from "vite"; +import tailwindcss from "@tailwindcss/vite"; +import react from "@vitejs/plugin-react-swc"; +import { dirname, join } from "path"; +import { fileURLToPath } from "url"; +import { viteStaticCopy } from "vite-plugin-static-copy"; + +const PYODIDE_EXCLUDE = [ + "!**/*.{md,html}", + "!**/*.d.ts", + "!**/*.whl", + "!**/node_modules", +]; + +// https://vitejs.dev/config/ +export default defineConfig({ + plugins: [react(), tailwindcss(), viteStaticCopyPyodide()], + optimizeDeps: { exclude: ["pyodide"] }, +}); + +export function viteStaticCopyPyodide() { + const pyodideDir = dirname(fileURLToPath(import.meta.resolve("pyodide"))); + return viteStaticCopy({ + targets: [ + { + src: [join(pyodideDir, "*"), ...PYODIDE_EXCLUDE], + dest: "assets", + }, + ], + }); +} diff --git a/playground/vite.config.ts b/playground/vite.config.ts deleted file mode 100644 index d366e8c8d7caf..0000000000000 --- a/playground/vite.config.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { defineConfig } from "vite"; -import react from "@vitejs/plugin-react-swc"; - -// https://vitejs.dev/config/ -export default defineConfig({ - plugins: [react()], -}); diff --git a/pyproject.toml b/pyproject.toml index 0f6810dd80852..b034bca36b719 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,38 +4,38 @@ build-backend = "maturin" [project] name = "ruff" -version = "0.7.1" +version = "0.11.10" description = "An extremely fast Python linter and code formatter, written in Rust." authors = [{ name = "Astral Software Inc.", email = "hey@astral.sh" }] readme = "README.md" requires-python = ">=3.7" license = { file = "LICENSE" } keywords = [ - "automation", - "flake8", - "pycodestyle", - "pyflakes", - "pylint", - "clippy", + "automation", + "flake8", + "pycodestyle", + "pyflakes", + "pylint", + "clippy", ] classifiers = [ - "Development Status :: 5 - Production/Stable", - "Environment :: Console", - "Intended Audience :: Developers", - "License :: OSI Approved :: MIT License", - "Operating System :: OS Independent", - "Programming Language :: Python", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Programming Language :: Python :: 3.13", - "Programming Language :: Python :: 3 :: Only", - "Programming Language :: Rust", - "Topic :: Software Development :: Libraries :: Python Modules", - "Topic :: Software Development :: Quality Assurance", + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Rust", + "Topic :: Software Development :: Libraries :: Python Modules", + "Topic :: Software Development :: Quality Assurance", ] [project.urls] @@ -50,32 +50,56 @@ module-name = "ruff" python-source = "python" strip = true exclude = [ - "crates/ruff_linter/resources/test/fixtures/**/*", - "crates/ruff_linter/src/rules/*/snapshots/**/*" + "crates/ruff_linter/resources/test/fixtures/**/*", + "crates/ruff_linter/src/rules/*/snapshots/**/*" ] include = [ - "rust-toolchain.toml" + "rust-toolchain.toml" ] [tool.ruff] +target-version = "py38" extend-exclude = [ - "crates/red_knot_vendored/vendor/", - "crates/ruff/resources/", - "crates/ruff_linter/resources/", - "crates/ruff_python_formatter/resources/", - "crates/ruff_python_parser/resources/" + "crates/ty_vendored/vendor/", + "crates/ruff/resources/", + "crates/ruff_linter/resources/", + "crates/ruff_python_formatter/resources/", + "crates/ruff_python_parser/resources/", + "crates/ruff_python_semantic/resources/" ] [tool.ruff.lint] +select = [ + "E", # pycodestyle (error) + "F", # pyflakes + "B", # bugbear + "B9", + "C4", # flake8-comprehensions + "SIM", # flake8-simplify + "I", # isort + "UP", # pyupgrade + "PIE", # flake8-pie + "PGH", # pygrep-hooks + "PYI", # flake8-pyi + "RUF", +] + ignore = [ - # Conflicts with the formatter - "COM812", "ISC001" + # only relevant if you run a script with `python -0`, + # which seems unlikely for any of the scripts in this repo + "B011", + # Leave it to the formatter to split long lines and + # the judgement of all of us. + "E501" ] +[tool.ruff.lint.isort] +required-imports = ["from __future__ import annotations"] + [tool.black] force-exclude = ''' /( - | crates/red_knot_vendored/vendor + | crates/ty_vendored/vendor | crates/ruff_linter/resources | crates/ruff_python_formatter/resources | crates/ruff_python_parser/resources @@ -86,16 +110,21 @@ force-exclude = ''' major_labels = [] # Ruff never uses the major version number minor_labels = ["breaking"] # Bump the minor version on breaking changes -changelog_ignore_labels = ["internal", "ci", "red-knot"] +changelog_ignore_labels = ["internal", "ci", "testing", "ty"] changelog_sections.breaking = "Breaking changes" changelog_sections.preview = "Preview features" +changelog_sections.bug = "Bug fixes" changelog_sections.rule = "Rule changes" +changelog_sections.diagnostics = "Rule changes" +changelog_sections.docstring = "Rule changes" +changelog_sections.fixes = "Rule changes" +changelog_sections.isort = "Rule changes" +changelog_sections.performance = "Performance" changelog_sections.formatter = "Formatter" changelog_sections.server = "Server" changelog_sections.cli = "CLI" changelog_sections.configuration = "Configuration" -changelog_sections.bug = "Bug fixes" changelog_sections.documentation = "Documentation" changelog_sections.__unknown__ = "Other changes" @@ -104,10 +133,11 @@ changelog_sections.__unknown__ = "Other changes" changelog_contributors = false version_files = [ - "README.md", - "docs/integrations.md", - "crates/ruff/Cargo.toml", - "crates/ruff_linter/Cargo.toml", - "crates/ruff_wasm/Cargo.toml", - "scripts/benchmarks/pyproject.toml", + "README.md", + "docs/integrations.md", + "docs/tutorial.md", + "crates/ruff/Cargo.toml", + "crates/ruff_linter/Cargo.toml", + "crates/ruff_wasm/Cargo.toml", + "scripts/benchmarks/pyproject.toml", ] diff --git a/python/py-fuzzer/README.md b/python/py-fuzzer/README.md new file mode 100644 index 0000000000000..5e6c71340592c --- /dev/null +++ b/python/py-fuzzer/README.md @@ -0,0 +1,8 @@ +# py-fuzzer + +A fuzzer script to run Ruff executables on randomly generated +(but syntactically valid) Python source-code files. + +Run `uvx --from ./python/py-fuzzer fuzz -h` from the repository root +for more information and example invocations +(requires [`uv`](https://github.com/astral-sh/uv) to be installed). diff --git a/python/py-fuzzer/fuzz.py b/python/py-fuzzer/fuzz.py new file mode 100644 index 0000000000000..3b3c3f042344a --- /dev/null +++ b/python/py-fuzzer/fuzz.py @@ -0,0 +1,444 @@ +""" +Run a Ruff executable on randomly generated (but syntactically valid) +Python source-code files. + +This script can be installed into a virtual environment using +`uv pip install -e ./python/py-fuzzer` from the Ruff repository root, +or can be run using `uvx --from ./python/py-fuzzer fuzz` +(in which case the virtual environment does not need to be activated). + +Example invocations of the script using `uv`: +- Run the fuzzer on Ruff's parser using seeds 0, 1, 2, 78 and 93 to generate the code: + `uvx --from ./python/py-fuzzer fuzz --bin ruff 0-2 78 93` +- Run the fuzzer concurrently using seeds in range 0-10 inclusive, + but only reporting bugs that are new on your branch: + `uvx --from ./python/py-fuzzer fuzz --bin ruff 0-10 --only-new-bugs` +- Run the fuzzer concurrently on 10,000 different Python source-code files, + using a random selection of seeds, and only print a summary at the end + (the `shuf` command is Unix-specific): + `uvx --from ./python/py-fuzzer fuzz --bin ruff $(shuf -i 0-1000000 -n 10000) --quiet + +If you make local modifications to this script, you'll need to run the above +with `--reinstall` to get your changes reflected in the uv-cached installed +package. Alternatively, if iterating quickly on changes, you can add +`--with-editable ./python/py-fuzzer`. +""" + +from __future__ import annotations + +import argparse +import ast +import concurrent.futures +import enum +import subprocess +import tempfile +from collections.abc import Callable +from dataclasses import KW_ONLY, dataclass +from functools import partial +from pathlib import Path +from typing import NewType, NoReturn, assert_never + +from pysource_codegen import generate as generate_random_code +from pysource_minimize import CouldNotMinimize, minimize as minimize_repro +from rich_argparse import RawDescriptionRichHelpFormatter +from termcolor import colored + +MinimizedSourceCode = NewType("MinimizedSourceCode", str) +Seed = NewType("Seed", int) +ExitCode = NewType("ExitCode", int) + + +def ty_contains_bug(code: str, *, ty_executable: Path) -> bool: + """Return `True` if the code triggers a panic in type-checking code.""" + with tempfile.TemporaryDirectory() as tempdir: + input_file = Path(tempdir, "input.py") + input_file.write_text(code) + completed_process = subprocess.run( + [ty_executable, "check", input_file], capture_output=True, text=True + ) + return completed_process.returncode not in {0, 1, 2} + + +def ruff_contains_bug(code: str, *, ruff_executable: Path) -> bool: + """Return `True` if the code triggers a parser error.""" + completed_process = subprocess.run( + [ + ruff_executable, + "check", + "--config", + "lint.select=[]", + "--no-cache", + "--target-version", + "py313", + "--preview", + "-", + ], + capture_output=True, + text=True, + input=code, + ) + return completed_process.returncode != 0 + + +def contains_bug(code: str, *, executable: Executable, executable_path: Path) -> bool: + """Return `True` if the code triggers an error.""" + match executable: + case Executable.RUFF: + return ruff_contains_bug(code, ruff_executable=executable_path) + case Executable.TY: + return ty_contains_bug(code, ty_executable=executable_path) + case _ as unreachable: + assert_never(unreachable) + + +def contains_new_bug( + code: str, + *, + executable: Executable, + test_executable_path: Path, + baseline_executable_path: Path, +) -> bool: + """Return `True` if the code triggers a *new* parser error. + + A "new" parser error is one that exists with `test_executable`, + but did not exist with `baseline_executable`. + """ + return contains_bug( + code, executable=executable, executable_path=test_executable_path + ) and not contains_bug( + code, executable=executable, executable_path=baseline_executable_path + ) + + +@dataclass(slots=True) +class FuzzResult: + # The seed used to generate the random Python file. + # The same seed always generates the same file. + seed: Seed + # If we found a bug, this will be the minimum Python code + # required to trigger the bug. If not, it will be `None`. + maybe_bug: MinimizedSourceCode | None + # The executable we're testing + executable: Executable + _: KW_ONLY + only_new_bugs: bool + + def print_description(self, index: int, num_seeds: int) -> None: + """Describe the results of fuzzing the parser with this seed.""" + progress = f"[{index}/{num_seeds}]" + msg = ( + colored(f"Ran fuzzer on seed {self.seed}", "red") + if self.maybe_bug + else colored(f"Ran fuzzer successfully on seed {self.seed}", "green") + ) + print(f"{msg:<60} {progress:>15}", flush=True) + + new = "new " if self.only_new_bugs else "" + + if self.maybe_bug: + match self.executable: + case Executable.RUFF: + panic_message = f"The following code triggers a {new}parser bug:" + case Executable.TY: + panic_message = f"The following code triggers a {new}ty panic:" + case _ as unreachable: + assert_never(unreachable) + + print(colored(panic_message, "red")) + print() + print(self.maybe_bug) + print(flush=True) + + +def fuzz_code(seed: Seed, args: ResolvedCliArgs) -> FuzzResult: + """Return a `FuzzResult` instance describing the fuzzing result from this seed.""" + # TODO(carljm) remove once we debug the slowness of these seeds + skip_check = seed in {120, 160, 335} + + code = generate_random_code(seed) + bug_found = False + minimizer_callback: Callable[[str], bool] | None = None + + if args.baseline_executable_path is None: + only_new_bugs = False + if not skip_check and contains_bug( + code, executable=args.executable, executable_path=args.test_executable_path + ): + bug_found = True + minimizer_callback = partial( + contains_bug, + executable=args.executable, + executable_path=args.test_executable_path, + ) + else: + only_new_bugs = True + if not skip_check and contains_new_bug( + code, + executable=args.executable, + test_executable_path=args.test_executable_path, + baseline_executable_path=args.baseline_executable_path, + ): + bug_found = True + minimizer_callback = partial( + contains_new_bug, + executable=args.executable, + test_executable_path=args.test_executable_path, + baseline_executable_path=args.baseline_executable_path, + ) + + if not bug_found: + return FuzzResult(seed, None, args.executable, only_new_bugs=only_new_bugs) + + assert minimizer_callback is not None + + try: + maybe_bug = MinimizedSourceCode(minimize_repro(code, minimizer_callback)) + except CouldNotMinimize as e: + # This is to double-check that there isn't a bug in + # `pysource-minimize`/`pysource-codegen`. + # `pysource-minimize` *should* never produce code that's invalid syntax. + try: + ast.parse(code) + except SyntaxError: + raise e from None + else: + maybe_bug = MinimizedSourceCode(code) + + return FuzzResult(seed, maybe_bug, args.executable, only_new_bugs=only_new_bugs) + + +def run_fuzzer_concurrently(args: ResolvedCliArgs) -> list[FuzzResult]: + num_seeds = len(args.seeds) + print( + f"Concurrently running the fuzzer on " + f"{num_seeds} randomly generated source-code " + f"file{'s' if num_seeds != 1 else ''}..." + ) + bugs: list[FuzzResult] = [] + with concurrent.futures.ProcessPoolExecutor() as executor: + fuzz_result_futures = [ + executor.submit(fuzz_code, seed, args) for seed in args.seeds + ] + try: + for i, future in enumerate( + concurrent.futures.as_completed(fuzz_result_futures), start=1 + ): + fuzz_result = future.result() + if not args.quiet: + fuzz_result.print_description(i, num_seeds) + if fuzz_result.maybe_bug: + bugs.append(fuzz_result) + except KeyboardInterrupt: + print("\nShutting down the ProcessPoolExecutor due to KeyboardInterrupt...") + print("(This might take a few seconds)") + executor.shutdown(cancel_futures=True) + raise + return bugs + + +def run_fuzzer_sequentially(args: ResolvedCliArgs) -> list[FuzzResult]: + num_seeds = len(args.seeds) + print( + f"Sequentially running the fuzzer on " + f"{num_seeds} randomly generated source-code " + f"file{'s' if num_seeds != 1 else ''}..." + ) + bugs: list[FuzzResult] = [] + for i, seed in enumerate(args.seeds, start=1): + fuzz_result = fuzz_code(seed, args) + if not args.quiet: + fuzz_result.print_description(i, num_seeds) + if fuzz_result.maybe_bug: + bugs.append(fuzz_result) + return bugs + + +def run_fuzzer(args: ResolvedCliArgs) -> ExitCode: + if len(args.seeds) <= 5: + bugs = run_fuzzer_sequentially(args) + else: + bugs = run_fuzzer_concurrently(args) + noun_phrase = "New bugs" if args.baseline_executable_path is not None else "Bugs" + if bugs: + print(colored(f"{noun_phrase} found in the following seeds:", "red")) + print(*sorted(bug.seed for bug in bugs)) + return ExitCode(1) + else: + print(colored(f"No {noun_phrase.lower()} found!", "green")) + return ExitCode(0) + + +def parse_seed_argument(arg: str) -> int | range: + """Helper for argument parsing""" + if "-" in arg: + start, end = map(int, arg.split("-")) + if end <= start: + raise argparse.ArgumentTypeError( + f"Error when parsing seed argument {arg!r}: " + f"range end must be > range start" + ) + seed_range = range(start, end + 1) + range_too_long = ( + f"Error when parsing seed argument {arg!r}: " + f"maximum allowed range length is 1_000_000_000" + ) + try: + if len(seed_range) > 1_000_000_000: + raise argparse.ArgumentTypeError(range_too_long) + except OverflowError: + raise argparse.ArgumentTypeError(range_too_long) from None + return range(int(start), int(end) + 1) + return int(arg) + + +class Executable(enum.StrEnum): + RUFF = "ruff" + TY = "ty" + + +@dataclass(slots=True) +class ResolvedCliArgs: + seeds: list[Seed] + _: KW_ONLY + executable: Executable + test_executable_path: Path + baseline_executable_path: Path | None + quiet: bool + + +def parse_args() -> ResolvedCliArgs: + """Parse command-line arguments""" + parser = argparse.ArgumentParser( + description=__doc__, formatter_class=RawDescriptionRichHelpFormatter + ) + parser.add_argument( + "seeds", + type=parse_seed_argument, + nargs="+", + help="Either a single seed, or an inclusive range of seeds in the format `0-5`", + ) + parser.add_argument( + "--only-new-bugs", + action="store_true", + help=( + "Only report bugs if they exist on the current branch, " + "but *didn't* exist on the released version " + "installed into the Python environment we're running in" + ), + ) + parser.add_argument( + "--quiet", + action="store_true", + help="Print fewer things to the terminal while running the fuzzer", + ) + parser.add_argument( + "--test-executable", + help=( + "Executable to test. " + "Defaults to a fresh build of the currently checked-out branch." + ), + type=Path, + ) + parser.add_argument( + "--baseline-executable", + help=( + "Executable to compare results against. " + "Defaults to whatever version is installed " + "in the Python environment." + ), + type=Path, + ) + parser.add_argument( + "--bin", + help="Which executable to test.", + required=True, + choices=[member.value for member in Executable], + ) + + args = parser.parse_args() + + executable = Executable(args.bin) + + if args.baseline_executable: + if not args.only_new_bugs: + parser.error( + "Specifying `--baseline-executable` has no effect " + "unless `--only-new-bugs` is also specified" + ) + try: + subprocess.run( + [args.baseline_executable, "--version"], check=True, capture_output=True + ) + except FileNotFoundError: + parser.error( + f"Bad argument passed to `--baseline-executable`: " + f"no such file or executable {args.baseline_executable!r}" + ) + elif args.only_new_bugs: + try: + version_proc = subprocess.run( + [executable, "--version"], text=True, capture_output=True, check=True + ) + except FileNotFoundError: + parser.error( + "`--only-new-bugs` was specified without specifying a baseline " + f"executable, and no released version of `{executable}` appears to be " + "installed in your Python environment" + ) + else: + if not args.quiet: + version = version_proc.stdout.strip().split(" ")[1] + print( + f"`--only-new-bugs` was specified without specifying a baseline " + f"executable; falling back to using `{executable}=={version}` as " + f"the baseline (the version of `{executable}` installed in your " + f"current Python environment)" + ) + + if not args.test_executable: + print( + "Running `cargo build --release` since no test executable was specified...", + flush=True, + ) + cmd: list[str] = [ + "cargo", + "build", + "--release", + "--locked", + "--color", + "always", + "--bin", + executable, + ] + try: + subprocess.run(cmd, check=True, capture_output=True, text=True) + except subprocess.CalledProcessError as e: + print(e.stderr) + raise + args.test_executable = Path("target", "release", executable) + assert args.test_executable.is_file() + + seed_arguments: list[range | int] = args.seeds + seen_seeds: set[int] = set() + for arg in seed_arguments: + if isinstance(arg, int): + seen_seeds.add(arg) + else: + seen_seeds.update(arg) + + return ResolvedCliArgs( + sorted(map(Seed, seen_seeds)), + quiet=args.quiet, + executable=executable, + test_executable_path=args.test_executable, + baseline_executable_path=args.baseline_executable, + ) + + +def main() -> NoReturn: + args = parse_args() + raise SystemExit(run_fuzzer(args)) + + +if __name__ == "__main__": + main() diff --git a/python/py-fuzzer/pyproject.toml b/python/py-fuzzer/pyproject.toml new file mode 100644 index 0000000000000..d6e380395ac6d --- /dev/null +++ b/python/py-fuzzer/pyproject.toml @@ -0,0 +1,79 @@ +[project] +name = "py-fuzzer" +version = "0.0.0" +readme = "README.md" +requires-python = ">=3.12" +dependencies = [ + "pysource-codegen>=0.6.0", + "pysource-minimize>=0.8.0", + "rich-argparse>=1.7.0", + "ruff>=0.11.9", + "termcolor>=3.1.0", +] + +[project.scripts] +fuzz = "fuzz:main" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[dependency-groups] +dev = ["mypy", "ruff"] + +[tool.hatch.build.targets.wheel] +include = ["fuzz.py"] + +[tool.mypy] +files = "fuzz.py" +pretty = true +strict = true +warn_unreachable = true +local_partial_types = true +enable_error_code = "ignore-without-code,redundant-expr,truthy-bool" + +[tool.ruff] +fix = true +preview = true + +[tool.ruff.format] +docstring-code-format = true +skip-magic-trailing-comma = true + +[tool.ruff.lint] +select = [ + "ARG", + "E", + "F", + "B", + "B9", + "C4", + "SIM", + "I", + "UP", + "PIE", + "PGH", + "PYI", + "RUF", +] +ignore = [ + # only relevant if you run a script with `python -0`, + "B011", + # These are enforced by, or incompatible with, the ruff formatter: + "E203", + "E501", + # Makes code slower and more verbose + # https://github.com/astral-sh/ruff/issues/7871 + "UP038", +] +unfixable = [ + "F841", # unused variable. ruff keeps the call, but mostly it's best to get rid of it all + "F601", # automatic fix might obscure issue + "F602", # automatic fix might obscure issue + "B018", # automatic fix might obscure issue + "RUF017", # Ruff's fix is faster, but I prefer using itertools.chain_from_iterable +] + +[tool.ruff.lint.isort] +combine-as-imports = true +split-on-trailing-comma = false diff --git a/python/py-fuzzer/uv.lock b/python/py-fuzzer/uv.lock new file mode 100644 index 0000000000000..1be4ceed235b2 --- /dev/null +++ b/python/py-fuzzer/uv.lock @@ -0,0 +1,187 @@ +version = 1 +revision = 1 +requires-python = ">=3.12" + +[[package]] +name = "markdown-it-py" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mdurl" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/38/71/3b932df36c1a044d397a1f92d1cf91ee0a503d91e470cbd670aa66b07ed0/markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb", size = 74596 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f/markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", size = 87528 }, +] + +[[package]] +name = "mdurl" +version = "0.1.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979 }, +] + +[[package]] +name = "mypy" +version = "1.13.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mypy-extensions" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/e8/21/7e9e523537991d145ab8a0a2fd98548d67646dc2aaaf6091c31ad883e7c1/mypy-1.13.0.tar.gz", hash = "sha256:0291a61b6fbf3e6673e3405cfcc0e7650bebc7939659fdca2702958038bd835e", size = 3152532 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fb/31/c526a7bd2e5c710ae47717c7a5f53f616db6d9097caf48ad650581e81748/mypy-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:5c7051a3461ae84dfb5dd15eff5094640c61c5f22257c8b766794e6dd85e72d5", size = 11077900 }, + { url = "https://files.pythonhosted.org/packages/83/67/b7419c6b503679d10bd26fc67529bc6a1f7a5f220bbb9f292dc10d33352f/mypy-1.13.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:39bb21c69a5d6342f4ce526e4584bc5c197fd20a60d14a8624d8743fffb9472e", size = 10074818 }, + { url = "https://files.pythonhosted.org/packages/ba/07/37d67048786ae84e6612575e173d713c9a05d0ae495dde1e68d972207d98/mypy-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:164f28cb9d6367439031f4c81e84d3ccaa1e19232d9d05d37cb0bd880d3f93c2", size = 12589275 }, + { url = "https://files.pythonhosted.org/packages/1f/17/b1018c6bb3e9f1ce3956722b3bf91bff86c1cefccca71cec05eae49d6d41/mypy-1.13.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a4c1bfcdbce96ff5d96fc9b08e3831acb30dc44ab02671eca5953eadad07d6d0", size = 13037783 }, + { url = "https://files.pythonhosted.org/packages/cb/32/cd540755579e54a88099aee0287086d996f5a24281a673f78a0e14dba150/mypy-1.13.0-cp312-cp312-win_amd64.whl", hash = "sha256:a0affb3a79a256b4183ba09811e3577c5163ed06685e4d4b46429a271ba174d2", size = 9726197 }, + { url = "https://files.pythonhosted.org/packages/11/bb/ab4cfdc562cad80418f077d8be9b4491ee4fb257440da951b85cbb0a639e/mypy-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:a7b44178c9760ce1a43f544e595d35ed61ac2c3de306599fa59b38a6048e1aa7", size = 11069721 }, + { url = "https://files.pythonhosted.org/packages/59/3b/a393b1607cb749ea2c621def5ba8c58308ff05e30d9dbdc7c15028bca111/mypy-1.13.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5d5092efb8516d08440e36626f0153b5006d4088c1d663d88bf79625af3d1d62", size = 10063996 }, + { url = "https://files.pythonhosted.org/packages/d1/1f/6b76be289a5a521bb1caedc1f08e76ff17ab59061007f201a8a18cc514d1/mypy-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:de2904956dac40ced10931ac967ae63c5089bd498542194b436eb097a9f77bc8", size = 12584043 }, + { url = "https://files.pythonhosted.org/packages/a6/83/5a85c9a5976c6f96e3a5a7591aa28b4a6ca3a07e9e5ba0cec090c8b596d6/mypy-1.13.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:7bfd8836970d33c2105562650656b6846149374dc8ed77d98424b40b09340ba7", size = 13036996 }, + { url = "https://files.pythonhosted.org/packages/b4/59/c39a6f752f1f893fccbcf1bdd2aca67c79c842402b5283563d006a67cf76/mypy-1.13.0-cp313-cp313-win_amd64.whl", hash = "sha256:9f73dba9ec77acb86457a8fc04b5239822df0c14a082564737833d2963677dbc", size = 9737709 }, + { url = "https://files.pythonhosted.org/packages/3b/86/72ce7f57431d87a7ff17d442f521146a6585019eb8f4f31b7c02801f78ad/mypy-1.13.0-py3-none-any.whl", hash = "sha256:9c250883f9fd81d212e0952c92dbfcc96fc237f4b7c92f56ac81fd48460b3e5a", size = 2647043 }, +] + +[[package]] +name = "mypy-extensions" +version = "1.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/98/a4/1ab47638b92648243faf97a5aeb6ea83059cc3624972ab6b8d2316078d3f/mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782", size = 4433 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2a/e2/5d3f6ada4297caebe1a2add3b126fe800c96f56dbe5d1988a2cbe0b267aa/mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d", size = 4695 }, +] + +[[package]] +name = "py-fuzzer" +version = "0.0.0" +source = { editable = "." } +dependencies = [ + { name = "pysource-codegen" }, + { name = "pysource-minimize" }, + { name = "rich-argparse" }, + { name = "ruff" }, + { name = "termcolor" }, +] + +[package.dev-dependencies] +dev = [ + { name = "mypy" }, + { name = "ruff" }, +] + +[package.metadata] +requires-dist = [ + { name = "pysource-codegen", specifier = ">=0.6.0" }, + { name = "pysource-minimize", specifier = ">=0.8.0" }, + { name = "rich-argparse", specifier = ">=1.7.0" }, + { name = "ruff", specifier = ">=0.11.9" }, + { name = "termcolor", specifier = ">=3.1.0" }, +] + +[package.metadata.requires-dev] +dev = [ + { name = "mypy" }, + { name = "ruff" }, +] + +[[package]] +name = "pygments" +version = "2.18.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/8e/62/8336eff65bcbc8e4cb5d05b55faf041285951b6e80f33e2bff2024788f31/pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199", size = 4891905 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f7/3f/01c8b82017c199075f8f788d0d906b9ffbbc5a47dc9918a945e13d5a2bda/pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a", size = 1205513 }, +] + +[[package]] +name = "pysource-codegen" +version = "0.6.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/38/5d/1ab81f5f4eb3fb9203a91ea3cdb7da7b19b38993d669e39000a6454128e1/pysource_codegen-0.6.0.tar.gz", hash = "sha256:0337e3cf3639f017567ab298684c78eb15c877b093965259c725a13a4917be4e", size = 157342 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/45/e4/c3a105d7d43bf237b18169eb1a06e1b93dc0daa96e74efa14c6d908979b4/pysource_codegen-0.6.0-py3-none-any.whl", hash = "sha256:858f2bbed6de7a7b7e9bbea5cb8212ec7e66fa7f2a7ba433fe05f72438017b30", size = 19489 }, +] + +[[package]] +name = "pysource-minimize" +version = "0.8.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/90/d3/6786a52121987875b2e9d273399504e2bdb868e7b80b603ecb29c900846f/pysource_minimize-0.8.0.tar.gz", hash = "sha256:e9a88c68717891dc7dc74beab769ef4c2e397599e1620b2046b89783fb500652", size = 715267 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4a/7d/4e9ed2a376bb7372d74fdec557f35f70c2bf5373f2c67e05535555d0a6d4/pysource_minimize-0.8.0-py3-none-any.whl", hash = "sha256:edee433c24a2e8f81701aa7e01ba4c1e63f481f683dd3a561610762bc03ed6c3", size = 14635 }, +] + +[[package]] +name = "rich" +version = "13.9.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown-it-py" }, + { name = "pygments" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ab/3a/0316b28d0761c6734d6bc14e770d85506c986c85ffb239e688eeaab2c2bc/rich-13.9.4.tar.gz", hash = "sha256:439594978a49a09530cff7ebc4b5c7103ef57baf48d5ea3184f21d9a2befa098", size = 223149 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/19/71/39c7c0d87f8d4e6c020a393182060eaefeeae6c01dab6a84ec346f2567df/rich-13.9.4-py3-none-any.whl", hash = "sha256:6049d5e6ec054bf2779ab3358186963bac2ea89175919d699e378b99738c2a90", size = 242424 }, +] + +[[package]] +name = "rich-argparse" +version = "1.7.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "rich" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/aa/b9/ff53663ee7fa6a4195fa96d91da499f2e00ca067541e016d345cce1c9ad2/rich_argparse-1.7.0.tar.gz", hash = "sha256:f31d809c465ee43f367d599ccaf88b73bc2c4d75d74ed43f2d538838c53544ba", size = 38009 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bb/9c/dc7cbeb99a7b7422392ed7f327efdbb958bc0faf424aef5f130309320bda/rich_argparse-1.7.0-py3-none-any.whl", hash = "sha256:b8ec8943588e9731967f4f97b735b03dc127c416f480a083060433a97baf2fd3", size = 25339 }, +] + +[[package]] +name = "ruff" +version = "0.11.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f5/e7/e55dda1c92cdcf34b677ebef17486669800de01e887b7831a1b8fdf5cb08/ruff-0.11.9.tar.gz", hash = "sha256:ebd58d4f67a00afb3a30bf7d383e52d0e036e6195143c6db7019604a05335517", size = 4132134 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fb/71/75dfb7194fe6502708e547941d41162574d1f579c4676a8eb645bf1a6842/ruff-0.11.9-py3-none-linux_armv6l.whl", hash = "sha256:a31a1d143a5e6f499d1fb480f8e1e780b4dfdd580f86e05e87b835d22c5c6f8c", size = 10335453 }, + { url = "https://files.pythonhosted.org/packages/74/fc/ad80c869b1732f53c4232bbf341f33c5075b2c0fb3e488983eb55964076a/ruff-0.11.9-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:66bc18ca783b97186a1f3100e91e492615767ae0a3be584e1266aa9051990722", size = 11072566 }, + { url = "https://files.pythonhosted.org/packages/87/0d/0ccececef8a0671dae155cbf7a1f90ea2dd1dba61405da60228bbe731d35/ruff-0.11.9-py3-none-macosx_11_0_arm64.whl", hash = "sha256:bd576cd06962825de8aece49f28707662ada6a1ff2db848d1348e12c580acbf1", size = 10435020 }, + { url = "https://files.pythonhosted.org/packages/52/01/e249e1da6ad722278094e183cbf22379a9bbe5f21a3e46cef24ccab76e22/ruff-0.11.9-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5b1d18b4be8182cc6fddf859ce432cc9631556e9f371ada52f3eaefc10d878de", size = 10593935 }, + { url = "https://files.pythonhosted.org/packages/ed/9a/40cf91f61e3003fe7bd43f1761882740e954506c5a0f9097b1cff861f04c/ruff-0.11.9-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:0f3f46f759ac623e94824b1e5a687a0df5cd7f5b00718ff9c24f0a894a683be7", size = 10172971 }, + { url = "https://files.pythonhosted.org/packages/61/12/d395203de1e8717d7a2071b5a340422726d4736f44daf2290aad1085075f/ruff-0.11.9-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f34847eea11932d97b521450cf3e1d17863cfa5a94f21a056b93fb86f3f3dba2", size = 11748631 }, + { url = "https://files.pythonhosted.org/packages/66/d6/ef4d5eba77677eab511644c37c55a3bb8dcac1cdeb331123fe342c9a16c9/ruff-0.11.9-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:f33b15e00435773df97cddcd263578aa83af996b913721d86f47f4e0ee0ff271", size = 12409236 }, + { url = "https://files.pythonhosted.org/packages/c5/8f/5a2c5fc6124dd925a5faf90e1089ee9036462118b619068e5b65f8ea03df/ruff-0.11.9-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7b27613a683b086f2aca8996f63cb3dd7bc49e6eccf590563221f7b43ded3f65", size = 11881436 }, + { url = "https://files.pythonhosted.org/packages/39/d1/9683f469ae0b99b95ef99a56cfe8c8373c14eba26bd5c622150959ce9f64/ruff-0.11.9-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9e0d88756e63e8302e630cee3ce2ffb77859797cc84a830a24473939e6da3ca6", size = 13982759 }, + { url = "https://files.pythonhosted.org/packages/4e/0b/c53a664f06e0faab596397867c6320c3816df479e888fe3af63bc3f89699/ruff-0.11.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:537c82c9829d7811e3aa680205f94c81a2958a122ac391c0eb60336ace741a70", size = 11541985 }, + { url = "https://files.pythonhosted.org/packages/23/a0/156c4d7e685f6526a636a60986ee4a3c09c8c4e2a49b9a08c9913f46c139/ruff-0.11.9-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:440ac6a7029f3dee7d46ab7de6f54b19e34c2b090bb4f2480d0a2d635228f381", size = 10465775 }, + { url = "https://files.pythonhosted.org/packages/43/d5/88b9a6534d9d4952c355e38eabc343df812f168a2c811dbce7d681aeb404/ruff-0.11.9-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:71c539bac63d0788a30227ed4d43b81353c89437d355fdc52e0cda4ce5651787", size = 10170957 }, + { url = "https://files.pythonhosted.org/packages/f0/b8/2bd533bdaf469dc84b45815ab806784d561fab104d993a54e1852596d581/ruff-0.11.9-py3-none-musllinux_1_2_i686.whl", hash = "sha256:c67117bc82457e4501473c5f5217d49d9222a360794bfb63968e09e70f340abd", size = 11143307 }, + { url = "https://files.pythonhosted.org/packages/2f/d9/43cfba291788459b9bfd4e09a0479aa94d05ab5021d381a502d61a807ec1/ruff-0.11.9-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:e4b78454f97aa454586e8a5557facb40d683e74246c97372af3c2d76901d697b", size = 11603026 }, + { url = "https://files.pythonhosted.org/packages/22/e6/7ed70048e89b01d728ccc950557a17ecf8df4127b08a56944b9d0bae61bc/ruff-0.11.9-py3-none-win32.whl", hash = "sha256:7fe1bc950e7d7b42caaee2a8a3bc27410547cc032c9558ee2e0f6d3b209e845a", size = 10548627 }, + { url = "https://files.pythonhosted.org/packages/90/36/1da5d566271682ed10f436f732e5f75f926c17255c9c75cefb77d4bf8f10/ruff-0.11.9-py3-none-win_amd64.whl", hash = "sha256:52edaa4a6d70f8180343a5b7f030c7edd36ad180c9f4d224959c2d689962d964", size = 11634340 }, + { url = "https://files.pythonhosted.org/packages/40/f7/70aad26e5877c8f7ee5b161c4c9fa0100e63fc4c944dc6d97b9c7e871417/ruff-0.11.9-py3-none-win_arm64.whl", hash = "sha256:bcf42689c22f2e240f496d0c183ef2c6f7b35e809f12c1db58f75d9aa8d630ca", size = 10741080 }, +] + +[[package]] +name = "termcolor" +version = "3.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ca/6c/3d75c196ac07ac8749600b60b03f4f6094d54e132c4d94ebac6ee0e0add0/termcolor-3.1.0.tar.gz", hash = "sha256:6a6dd7fbee581909eeec6a756cff1d7f7c376063b14e4a298dc4980309e55970", size = 14324 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4f/bd/de8d508070629b6d84a30d01d57e4a65c69aa7f5abe7560b8fad3b50ea59/termcolor-3.1.0-py3-none-any.whl", hash = "sha256:591dd26b5c2ce03b9e43f391264626557873ce1d379019786f99b0c2bee140aa", size = 7684 }, +] + +[[package]] +name = "typing-extensions" +version = "4.12.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/df/db/f35a00659bc03fec321ba8bce9420de607a1d37f8342eee1863174c69557/typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8", size = 85321 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/26/9f/ad63fc0248c5379346306f8668cda6e2e2e9c95e01216d2b8ffd9ff037d0/typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d", size = 37438 }, +] diff --git a/python/ruff-ecosystem/README.md b/python/ruff-ecosystem/README.md index 3e61fb8ae407b..243028e7757e2 100644 --- a/python/ruff-ecosystem/README.md +++ b/python/ruff-ecosystem/README.md @@ -4,10 +4,10 @@ Compare lint and format results for two different ruff versions (e.g. main and a ## Installation -From the Ruff project root, install with `pip`: +From the Ruff project root, install with [uv](https://docs.astral.sh/uv/): ```shell -pip install -e ./python/ruff-ecosystem +uv tool install -e ./python/ruff-ecosystem ``` ## Usage diff --git a/python/ruff-ecosystem/pyproject.toml b/python/ruff-ecosystem/pyproject.toml index 73fd29c0651fe..f688f10094741 100644 --- a/python/ruff-ecosystem/pyproject.toml +++ b/python/ruff-ecosystem/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "hatchling.build" name = "ruff-ecosystem" version = "0.0.0" requires-python = ">=3.11" -dependencies = ["unidiff==0.7.5", "tomli_w==1.1.0", "tomli==2.0.2"] +dependencies = ["unidiff==0.7.5", "tomli_w==1.2.0", "tomli==2.2.1"] [project.scripts] ruff-ecosystem = "ruff_ecosystem.cli:entrypoint" diff --git a/python/ruff-ecosystem/ruff_ecosystem/check.py b/python/ruff-ecosystem/ruff_ecosystem/check.py index 7aa6cdda13f6f..bf8d222125e28 100644 --- a/python/ruff-ecosystem/ruff_ecosystem/check.py +++ b/python/ruff-ecosystem/ruff_ecosystem/check.py @@ -45,7 +45,7 @@ ) CHECK_DIAGNOSTIC_LINE_RE = re.compile( - r"^(?P[+-])? ?(?P.*): (?P[A-Z]{1,4}[0-9]{3,4})(?P \[\*\])? (?P.*)" + r"^(?P[+-])? ?(?P.*): (?P[A-Z]{1,4}[0-9]{3,4}|SyntaxError:)(?P \[\*\])? (?P.*)" ) CHECK_VIOLATION_FIX_INDICATOR = " [*]" diff --git a/python/ruff-ecosystem/ruff_ecosystem/defaults.py b/python/ruff-ecosystem/ruff_ecosystem/defaults.py index fb7e84985a449..3c07c571ee0d3 100644 --- a/python/ruff-ecosystem/ruff_ecosystem/defaults.py +++ b/python/ruff-ecosystem/ruff_ecosystem/defaults.py @@ -4,6 +4,7 @@ from ruff_ecosystem.projects import ( CheckOptions, + FormatOptions, Project, Repository, ) @@ -34,8 +35,7 @@ repo=Repository(owner="bokeh", name="bokeh", ref="branch-3.3"), check_options=CheckOptions(select="ALL"), ), - # Disabled due to use of explicit `select` with `E999`, which is no longer - # supported in `--preview`. + # Disabled due to use of explicit `select` with `E999`, which has been removed. # See: https://github.com/astral-sh/ruff/pull/12129 # Project( # repo=Repository(owner="demisto", name="content", ref="master"), @@ -122,6 +122,7 @@ # These notebooks contain syntax errors because certain plain text / markdown # cells are marked as code cells. "exclude": [ + "examples/Assistants_API_overview_python.ipynb", "examples/Chat_finetuning_data_prep.ipynb", "examples/chatgpt/gpt_actions_library/gpt_action_google_drive.ipynb", "examples/chatgpt/gpt_actions_library/gpt_action_redshift.ipynb", @@ -134,6 +135,12 @@ Project(repo=Repository(owner="wntrblm", name="nox", ref="main")), Project(repo=Repository(owner="pytest-dev", name="pytest", ref="main")), Project(repo=Repository(owner="encode", name="httpx", ref="master")), - Project(repo=Repository(owner="mesonbuild", name="meson-python", ref="main")), + Project( + repo=Repository(owner="mesonbuild", name="meson-python", ref="main"), + format_options=FormatOptions( + exclude="tests/packages/symlinks/baz.py,tests/packages/symlinks/qux.py" + ), + ), Project(repo=Repository(owner="pdm-project", name="pdm", ref="main")), + Project(repo=Repository(owner="astropy", name="astropy", ref="main")), ] diff --git a/python/ruff-ecosystem/ruff_ecosystem/projects.py b/python/ruff-ecosystem/ruff_ecosystem/projects.py index 63670a0be234d..cf7b73240978d 100644 --- a/python/ruff-ecosystem/ruff_ecosystem/projects.py +++ b/python/ruff-ecosystem/ruff_ecosystem/projects.py @@ -209,6 +209,8 @@ def to_ruff_args(self) -> list[str]: # Ignore internal test rules "--ignore", "RUF9", + # Never apply fixes, as they pollute the comparison results + "--no-fix", # Use the concise format for comparing violations "--output-format", "concise", diff --git a/python/ruff/__main__.py b/python/ruff/__main__.py index d536867ad2a1b..21fa9a20fa8e7 100644 --- a/python/ruff/__main__.py +++ b/python/ruff/__main__.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import os import sys import sysconfig @@ -35,22 +37,40 @@ def find_ruff_bin() -> str: # Search for pip-specific build environments. # + # Expect to find ruff in /pip-build-env-/overlay/bin/ruff + # Expect to find a "normal" folder at /pip-build-env-/normal + # # See: https://github.com/pypa/pip/blob/102d8187a1f5a4cd5de7a549fd8a9af34e89a54f/src/pip/_internal/build_env.py#L87 paths = os.environ.get("PATH", "").split(os.pathsep) if len(paths) >= 2: - first, second = os.path.split(paths[0]), os.path.split(paths[1]) - # Search for both an `overlay` and `normal` folder within a `pip-build-env-{random}` folder. (The final segment - # of the path is the `bin` directory.) + + def get_last_three_path_parts(path: str) -> list[str]: + """Return a list of up to the last three parts of a path.""" + parts = [] + + while len(parts) < 3: + head, tail = os.path.split(path) + if tail or head != path: + parts.append(tail) + path = head + else: + parts.append(path) + break + + return parts + + maybe_overlay = get_last_three_path_parts(paths[0]) + maybe_normal = get_last_three_path_parts(paths[1]) if ( - len(first) >= 3 - and len(second) >= 3 - and first[-3].startswith("pip-build-env-") - and first[-2] == "overlay" - and second[-3].startswith("pip-build-env-") - and second[-2] == "normal" + len(maybe_normal) >= 3 + and maybe_normal[-1].startswith("pip-build-env-") + and maybe_normal[-2] == "normal" + and len(maybe_overlay) >= 3 + and maybe_overlay[-1].startswith("pip-build-env-") + and maybe_overlay[-2] == "overlay" ): # The overlay must contain the ruff binary. - candidate = os.path.join(first, ruff_exe) + candidate = os.path.join(paths[0], ruff_exe) if os.path.isfile(candidate): return candidate diff --git a/ruff.schema.json b/ruff.schema.json index 7412f47258dda..0059b7bb2fbaf 100644 --- a/ruff.schema.json +++ b/ruff.schema.json @@ -436,7 +436,7 @@ ] }, "ignore": { - "description": "A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.", + "description": "A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. `ignore` takes precedence over `select` if the same prefix appears in both.", "deprecated": true, "type": [ "array", @@ -578,6 +578,16 @@ } } }, + "per-file-target-version": { + "description": "A list of mappings from glob-style file pattern to Python version to use when checking the corresponding file(s).\n\nThis may be useful for overriding the global Python version settings in `target-version` or `requires-python` for a subset of files. For example, if you have a project with a minimum supported Python version of 3.9 but a subdirectory of developer scripts that want to use a newer feature like the `match` statement from Python 3.10, you can use `per-file-target-version` to specify `\"developer_scripts/*.py\" = \"py310\"`.\n\nThis setting is used by the linter to enforce any enabled version-specific lint rules, as well as by the formatter for any version-specific formatting options, such as parenthesizing context managers on Python 3.10+.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/PythonVersion" + } + }, "preview": { "description": "Whether to enable preview mode. When preview mode is enabled, Ruff will use unstable rules, fixes, and formatting.", "type": [ @@ -664,7 +674,7 @@ ] }, "select": { - "description": "A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.", + "description": "A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. `ignore` takes precedence over `select` if the same prefix appears in both.", "deprecated": true, "type": [ "array", @@ -682,7 +692,7 @@ ] }, "src": { - "description": "The directories to consider when resolving first- vs. third-party imports.\n\nWhen omitted, the `src` directory will typically default to including both:\n\n1. The directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the \"project root\"). 2. The `\"src\"` subdirectory of the project root.\n\nThese defaults ensure that uv supports both flat layouts and `src` layouts out-of-the-box. (If a configuration file is explicitly provided (e.g., via the `--config` command-line flag), the current working directory will be considered the project root.)\n\nAs an example, consider an alternative project structure, like:\n\n```text my_project ├── pyproject.toml └── lib └── my_package ├── __init__.py ├── foo.py └── bar.py ```\n\nIn this case, the `./lib` directory should be included in the `src` option (e.g., `src = [\"lib\"]`), such that when resolving imports, `my_package.foo` is considered first-party.\n\nThis field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = [\"python_modules/*\"]` would expand to incorporate all packages in that directory. User home directory and environment variables will also be expanded.", + "description": "The directories to consider when resolving first- vs. third-party imports.\n\nWhen omitted, the `src` directory will typically default to including both:\n\n1. The directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the \"project root\"). 2. The `\"src\"` subdirectory of the project root.\n\nThese defaults ensure that Ruff supports both flat layouts and `src` layouts out-of-the-box. (If a configuration file is explicitly provided (e.g., via the `--config` command-line flag), the current working directory will be considered the project root.)\n\nAs an example, consider an alternative project structure, like:\n\n```text my_project ├── pyproject.toml └── lib └── my_package ├── __init__.py ├── foo.py └── bar.py ```\n\nIn this case, the `./lib` directory should be included in the `src` option (e.g., `src = [\"lib\"]`), such that when resolving imports, `my_package.foo` is considered first-party.\n\nThis field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = [\"python_modules/*\"]` would expand to incorporate all packages in that directory. User home directory and environment variables will also be expanded.", "type": [ "array", "null" @@ -692,7 +702,7 @@ } }, "target-version": { - "description": "The minimum Python version to target, e.g., when considering automatic code upgrades, like rewriting type annotations. Ruff will not propose changes using features that are not available in the given version.\n\nFor example, to represent supporting Python >=3.10 or ==3.10 specify `target-version = \"py310\"`.\n\nIf you're already using a `pyproject.toml` file, we recommend `project.requires-python` instead, as it's based on Python packaging standards, and will be respected by other tools. For example, Ruff treats the following as identical to `target-version = \"py38\"`:\n\n```toml [project] requires-python = \">=3.8\" ```\n\nIf both are specified, `target-version` takes precedence over `requires-python`.\n\nNote that a stub file can [sometimes make use of a typing feature](https://typing.readthedocs.io/en/latest/spec/distributing.html#syntax) before it is available at runtime, as long as the stub does not make use of new *syntax*. For example, a type checker will understand `int | str` in a stub as being a `Union` type annotation, even if the type checker is run using Python 3.9, despite the fact that the `|` operator can only be used to create union types at runtime on Python 3.10+. As such, Ruff will often recommend newer features in a stub file than it would for an equivalent runtime file with the same target version.", + "description": "The minimum Python version to target, e.g., when considering automatic code upgrades, like rewriting type annotations. Ruff will not propose changes using features that are not available in the given version.\n\nFor example, to represent supporting Python >=3.10 or ==3.10 specify `target-version = \"py310\"`.\n\nIf you're already using a `pyproject.toml` file, we recommend `project.requires-python` instead, as it's based on Python packaging standards, and will be respected by other tools. For example, Ruff treats the following as identical to `target-version = \"py38\"`:\n\n```toml [project] requires-python = \">=3.8\" ```\n\nIf both are specified, `target-version` takes precedence over `requires-python`. See [_Inferring the Python version_](https://docs.astral.sh/ruff/configuration/#inferring-the-python-version) for a complete description of how the `target-version` is determined when left unspecified.\n\nNote that a stub file can [sometimes make use of a typing feature](https://typing.python.org/en/latest/spec/distributing.html#syntax) before it is available at runtime, as long as the stub does not make use of new *syntax*. For example, a type checker will understand `int | str` in a stub as being a `Union` type annotation, even if the type checker is run using Python 3.9, despite the fact that the `|` operator can only be used to create union types at runtime on Python 3.10+. As such, Ruff will often recommend newer features in a stub file than it would for an equivalent runtime file with the same target version.", "anyOf": [ { "$ref": "#/definitions/PythonVersion" @@ -745,6 +755,9 @@ }, "additionalProperties": false, "definitions": { + "Alias": { + "type": "string" + }, "AnalyzeOptions": { "description": "Configures Ruff's `analyze` command.", "type": "object", @@ -778,7 +791,7 @@ } }, "include-dependencies": { - "description": "A map from file path to the list of file paths or globs that should be considered dependencies of that file, regardless of whether relevant imports are detected.", + "description": "A map from file path to the list of Python or non-Python file paths or globs that should be considered dependencies of that file, regardless of whether relevant imports are detected.", "type": [ "object", "null" @@ -876,7 +889,7 @@ "anyOf": [ { "description": "Wrap docstring code examples at a fixed line width.", - "allOf": [ + "oneOf": [ { "$ref": "#/definitions/LineWidth" } @@ -884,19 +897,12 @@ }, { "description": "Respect the line length limit setting for the surrounding Python code.", - "allOf": [ - { - "$ref": "#/definitions/Dynamic" - } - ] + "const": "dynamic" } ] }, - "Dynamic": { - "type": "string", - "const": "dynamic" - }, "Flake8AnnotationsOptions": { + "description": "Options for the `flake8-annotations` plugin.", "type": "object", "properties": { "allow-star-arg-any": { @@ -938,8 +944,19 @@ "additionalProperties": false }, "Flake8BanditOptions": { + "description": "Options for the `flake8-bandit` plugin.", "type": "object", "properties": { + "allowed-markup-calls": { + "description": "A list of callable names, whose result may be safely passed into [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup).\n\nExpects to receive a list of fully-qualified names (e.g., `bleach.clean`, rather than `clean`).\n\nThis setting helps you avoid false positives in code like:\n\n```python from bleach import clean from markupsafe import Markup\n\ncleaned_markup = Markup(clean(some_user_input)) ```\n\nWhere the use of [`bleach.clean`](https://bleach.readthedocs.io/en/latest/clean.html) usually ensures that there's no XSS vulnerability.\n\nAlthough it is not recommended, you may also use this setting to whitelist other kinds of calls, e.g. calls to i18n translation functions, where how safe that is will depend on the implementation and how well the translations are audited.\n\nAnother common use-case is to wrap the output of functions that generate markup like [`xml.etree.ElementTree.tostring`](https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring) or template rendering engines where sanitization of potential user input is either already baked in or has to happen before rendering.", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, "check-typed-exception": { "description": "Whether to disallow `try`-`except`-`pass` (`S110`) for specific exception types. By default, `try`-`except`-`pass` is only disallowed for `Exception` and `BaseException`.", "type": [ @@ -947,8 +964,18 @@ "null" ] }, + "extend-markup-names": { + "description": "A list of additional callable names that behave like [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup).\n\nExpects to receive a list of fully-qualified names (e.g., `webhelpers.html.literal`, rather than `literal`).", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, "hardcoded-tmp-directory": { - "description": "A list of directories to consider temporary.", + "description": "A list of directories to consider temporary (see `S108`).", "type": [ "array", "null" @@ -958,7 +985,7 @@ } }, "hardcoded-tmp-directory-extend": { - "description": "A list of directories to consider temporary, in addition to those specified by [`hardcoded-tmp-directory`](#lint_flake8-bandit_hardcoded-tmp-directory).", + "description": "A list of directories to consider temporary, in addition to those specified by [`hardcoded-tmp-directory`](#lint_flake8-bandit_hardcoded-tmp-directory) (see `S108`).", "type": [ "array", "null" @@ -971,6 +998,7 @@ "additionalProperties": false }, "Flake8BooleanTrapOptions": { + "description": "Options for the `flake8-boolean-trap` plugin", "type": "object", "properties": { "extend-allowed-calls": { @@ -987,6 +1015,7 @@ "additionalProperties": false }, "Flake8BugbearOptions": { + "description": "Options for the `flake8-bugbear` plugin.", "type": "object", "properties": { "extend-immutable-calls": { @@ -1003,9 +1032,10 @@ "additionalProperties": false }, "Flake8BuiltinsOptions": { + "description": "Options for the `flake8-builtins` plugin.", "type": "object", "properties": { - "builtins-allowed-modules": { + "allowed-modules": { "description": "List of builtin module names to allow.", "type": [ "array", @@ -1015,7 +1045,37 @@ "type": "string" } }, + "builtins-allowed-modules": { + "description": "DEPRECATED: This option has been renamed to `allowed-modules`. Use `allowed-modules` instead.\n\nList of builtin module names to allow.\n\nThis option is ignored if both `allowed-modules` and `builtins-allowed-modules` are set.", + "deprecated": true, + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, "builtins-ignorelist": { + "description": "DEPRECATED: This option has been renamed to `ignorelist`. Use `ignorelist` instead.\n\nIgnore list of builtins.\n\nThis option is ignored if both `ignorelist` and `builtins-ignorelist` are set.", + "deprecated": true, + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "builtins-strict-checking": { + "description": "DEPRECATED: This option has been renamed to `strict-checking`. Use `strict-checking` instead.\n\nCompare module names instead of full module paths.\n\nThis option is ignored if both `strict-checking` and `builtins-strict-checking` are set.", + "deprecated": true, + "type": [ + "boolean", + "null" + ] + }, + "ignorelist": { "description": "Ignore list of builtins.", "type": [ "array", @@ -1024,11 +1084,19 @@ "items": { "type": "string" } + }, + "strict-checking": { + "description": "Compare module names instead of full module paths.\n\nUsed by [`A005` - `stdlib-module-shadowing`](https://docs.astral.sh/ruff/rules/stdlib-module-shadowing/).", + "type": [ + "boolean", + "null" + ] } }, "additionalProperties": false }, "Flake8ComprehensionsOptions": { + "description": "Options for the `flake8-comprehensions` plugin.", "type": "object", "properties": { "allow-dict-calls-with-keyword-arguments": { @@ -1042,6 +1110,7 @@ "additionalProperties": false }, "Flake8CopyrightOptions": { + "description": "Options for the `flake8-copyright` plugin.", "type": "object", "properties": { "author": { @@ -1071,6 +1140,7 @@ "additionalProperties": false }, "Flake8ErrMsgOptions": { + "description": "Options for the `flake8-errmsg` plugin.", "type": "object", "properties": { "max-string-length": { @@ -1086,6 +1156,7 @@ "additionalProperties": false }, "Flake8GetTextOptions": { + "description": "Options for the `flake8-gettext` plugin.", "type": "object", "properties": { "extend-function-names": { @@ -1112,6 +1183,7 @@ "additionalProperties": false }, "Flake8ImplicitStrConcatOptions": { + "description": "Options for the `flake8-implicit-str-concat` plugin", "type": "object", "properties": { "allow-multiline": { @@ -1125,6 +1197,7 @@ "additionalProperties": false }, "Flake8ImportConventionsOptions": { + "description": "Options for the `flake8-import-conventions` plugin", "type": "object", "properties": { "aliases": { @@ -1134,7 +1207,7 @@ "null" ], "additionalProperties": { - "type": "string" + "$ref": "#/definitions/Alias" } }, "banned-aliases": { @@ -1165,13 +1238,14 @@ "null" ], "additionalProperties": { - "type": "string" + "$ref": "#/definitions/Alias" } } }, "additionalProperties": false }, "Flake8PytestStyleOptions": { + "description": "Options for the `flake8-pytest-style` plugin", "type": "object", "properties": { "fixture-parentheses": { @@ -1240,11 +1314,32 @@ "items": { "type": "string" } + }, + "warns-extend-require-match-for": { + "description": "List of additional warning names that require a match= parameter in a `pytest.warns()` call. This extends the default list of warnings that require a match= parameter.\n\nThis option is useful if you want to extend the default list of warnings that require a match= parameter without having to specify the entire list.\n\nNote that this option does not remove any warnings from the default list.\n\nSupports glob patterns. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "warns-require-match-for": { + "description": "List of warning names that require a match= parameter in a `pytest.warns()` call.\n\nSupports glob patterns. For more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } }, "additionalProperties": false }, "Flake8QuotesOptions": { + "description": "Options for the `flake8-quotes` plugin.", "type": "object", "properties": { "avoid-escape": { @@ -1291,6 +1386,7 @@ "additionalProperties": false }, "Flake8SelfOptions": { + "description": "Options for the `flake8_self` plugin.", "type": "object", "properties": { "extend-ignore-names": { @@ -1317,6 +1413,7 @@ "additionalProperties": false }, "Flake8TidyImportsOptions": { + "description": "Options for the `flake8-tidy-imports` plugin", "type": "object", "properties": { "ban-relative-imports": { @@ -1354,6 +1451,7 @@ "additionalProperties": false }, "Flake8TypeCheckingOptions": { + "description": "Options for the `flake8-type-checking` plugin", "type": "object", "properties": { "exempt-modules": { @@ -1384,7 +1482,7 @@ } }, "runtime-evaluated-decorators": { - "description": "Exempt classes and functions decorated with any of the enumerated decorators from being moved into type-checking blocks.\n\nCommon examples include Pydantic's `@pydantic.validate_call` decorator (for functions) and attrs' `@attrs.define` decorator (for classes).", + "description": "Exempt classes and functions decorated with any of the enumerated decorators from being moved into type-checking blocks.\n\nCommon examples include Pydantic's `@pydantic.validate_call` decorator (for functions) and attrs' `@attrs.define` decorator (for classes).\n\nThis also supports framework decorators like FastAPI's `fastapi.FastAPI.get` which will work across assignments in the same module.\n\nFor example: ```python import fastapi\n\napp = FastAPI(\"app\")\n\n@app.get(\"/home\") def home() -> str: ... ```\n\nHere `app.get` will correctly be identified as `fastapi.FastAPI.get`.", "type": [ "array", "null" @@ -1404,6 +1502,7 @@ "additionalProperties": false }, "Flake8UnusedArgumentsOptions": { + "description": "Options for the `flake8-unused-arguments` plugin", "type": "object", "properties": { "ignore-variadic-names": { @@ -1543,6 +1642,7 @@ "minimum": 1.0 }, "IsortOptions": { + "description": "Options for the `isort` plugin.", "type": "object", "properties": { "case-sensitive": { @@ -1700,7 +1800,7 @@ ] }, "lines-after-imports": { - "description": "The number of blank lines to place after imports. Use `-1` for automatic determination.\n\nRuff uses at most one blank line after imports in typing stub files (files with `.pyi` extension) in accordance to the typing style recommendations ([source](https://typing.readthedocs.io/en/latest/source/stubs.html#blank-lines)).\n\nWhen using the formatter, only the values `-1`, `1`, and `2` are compatible because it enforces at least one empty and at most two empty lines after imports.", + "description": "The number of blank lines to place after imports. Use `-1` for automatic determination.\n\nRuff uses at most one blank line after imports in typing stub files (files with `.pyi` extension) in accordance to the typing style recommendations ([source](https://typing.python.org/en/latest/guides/writing_stubs.html#blank-lines)).\n\nWhen using the formatter, only the values `-1`, `1`, and `2` are compatible because it enforces at least one empty and at most two empty lines after imports.", "type": [ "integer", "null" @@ -2182,7 +2282,7 @@ ] }, "ignore": { - "description": "A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.", + "description": "A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. `ignore` takes precedence over `select` if the same prefix appears in both.", "type": [ "array", "null" @@ -2273,6 +2373,17 @@ } ] }, + "pydoclint": { + "description": "Options for the `pydoclint` plugin.", + "anyOf": [ + { + "$ref": "#/definitions/PydoclintOptions" + }, + { + "type": "null" + } + ] + }, "pydocstyle": { "description": "Options for the `pydocstyle` plugin.", "anyOf": [ @@ -2329,7 +2440,7 @@ ] }, "select": { - "description": "A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes.", + "description": "A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like `F841`), entire categories (like `F`), or anything in between.\n\nWhen breaking ties between enabled and disabled rules (via `select` and `ignore`, respectively), more specific prefixes override less specific prefixes. `ignore` takes precedence over `select` if the same prefix appears in both.", "type": [ "array", "null" @@ -2348,6 +2459,13 @@ "type": "string" } }, + "typing-extensions": { + "description": "Whether to allow imports from the third-party `typing_extensions` module for Python versions before a symbol was added to the first-party `typing` module.\n\nMany rules try to import symbols from the `typing` module but fall back to `typing_extensions` for earlier versions of Python. This option can be used to disable this fallback behavior in cases where `typing_extensions` is not installed.", + "type": [ + "boolean", + "null" + ] + }, "typing-modules": { "description": "A list of modules whose exports should be treated equivalently to members of the `typing` module.\n\nThis is useful for ensuring proper type annotation inference for projects that re-export `typing` and `typing_extensions` members from a compatibility module. If omitted, any members imported from modules apart from `typing` and `typing_extensions` will be treated as ordinary Python objects.", "type": [ @@ -2372,6 +2490,7 @@ "additionalProperties": false }, "McCabeOptions": { + "description": "Options for the `mccabe` plugin.", "type": "object", "properties": { "max-complexity": { @@ -2429,6 +2548,7 @@ ] }, "Pep8NamingOptions": { + "description": "Options for the `pep8-naming` plugin.", "type": "object", "properties": { "classmethod-decorators": { @@ -2475,6 +2595,7 @@ "additionalProperties": false }, "PyUpgradeOptions": { + "description": "Options for the `pyupgrade` plugin.", "type": "object", "properties": { "keep-runtime-typing": { @@ -2488,6 +2609,7 @@ "additionalProperties": false }, "PycodestyleOptions": { + "description": "Options for the `pycodestyle` plugin.", "type": "object", "properties": { "ignore-overlong-task-comments": { @@ -2522,7 +2644,22 @@ }, "additionalProperties": false }, + "PydoclintOptions": { + "description": "Options for the `pydoclint` plugin.", + "type": "object", + "properties": { + "ignore-one-line-docstrings": { + "description": "Skip docstrings which fit on a single line.\n\nNote: The corresponding setting in `pydoclint` is named `skip-checking-short-docstrings`.", + "type": [ + "boolean", + "null" + ] + } + }, + "additionalProperties": false + }, "PydocstyleOptions": { + "description": "Options for the `pydocstyle` plugin.", "type": "object", "properties": { "convention": { @@ -2546,6 +2683,13 @@ "type": "string" } }, + "ignore-var-parameters": { + "description": "If set to `true`, ignore missing documentation for `*args` and `**kwargs` parameters.", + "type": [ + "boolean", + "null" + ] + }, "property-decorators": { "description": "A list of decorators that, when applied to a method, indicate that the method should be treated as a property (in addition to the builtin `@property` and standard-library `@functools.cached_property`).\n\nFor example, Ruff will expect that any method decorated by a decorator in this list can use a non-imperative summary line.", "type": [ @@ -2560,6 +2704,7 @@ "additionalProperties": false }, "PyflakesOptions": { + "description": "Options for the `pyflakes` plugin.", "type": "object", "properties": { "allowed-unused-imports": { @@ -2586,6 +2731,7 @@ "additionalProperties": false }, "PylintOptions": { + "description": "Options for the `pylint` plugin.", "type": "object", "properties": { "allow-dunder-method-names": { @@ -2702,7 +2848,8 @@ "py310", "py311", "py312", - "py313" + "py313", + "py314" ] }, "Quote": { @@ -2753,8 +2900,31 @@ "type": "string" }, "RuffOptions": { + "description": "Options for the `ruff` plugin", "type": "object", "properties": { + "allowed-markup-calls": { + "description": "A list of callable names, whose result may be safely passed into [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup).\n\nExpects to receive a list of fully-qualified names (e.g., `bleach.clean`, rather than `clean`).\n\nThis setting helps you avoid false positives in code like:\n\n```python from bleach import clean from markupsafe import Markup\n\ncleaned_markup = Markup(clean(some_user_input)) ```\n\nWhere the use of [`bleach.clean`](https://bleach.readthedocs.io/en/latest/clean.html) usually ensures that there's no XSS vulnerability.\n\nAlthough it is not recommended, you may also use this setting to whitelist other kinds of calls, e.g. calls to i18n translation functions, where how safe that is will depend on the implementation and how well the translations are audited.\n\nAnother common use-case is to wrap the output of functions that generate markup like [`xml.etree.ElementTree.tostring`](https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring) or template rendering engines where sanitization of potential user input is either already baked in or has to happen before rendering.", + "deprecated": true, + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "extend-markup-names": { + "description": "A list of additional callable names that behave like [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup).\n\nExpects to receive a list of fully-qualified names (e.g., `webhelpers.html.literal`, rather than `literal`).", + "deprecated": true, + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, "parenthesize-tuple-in-subscript": { "description": "Whether to prefer accessing items keyed by tuples with parentheses around the tuple (see `RUF031`).", "type": [ @@ -2781,6 +2951,14 @@ "AIR0", "AIR00", "AIR001", + "AIR002", + "AIR3", + "AIR30", + "AIR301", + "AIR302", + "AIR31", + "AIR311", + "AIR312", "ALL", "ANN", "ANN0", @@ -2788,10 +2966,6 @@ "ANN001", "ANN002", "ANN003", - "ANN1", - "ANN10", - "ANN101", - "ANN102", "ANN2", "ANN20", "ANN201", @@ -2875,9 +3049,12 @@ "B9", "B90", "B901", + "B903", "B904", "B905", "B909", + "B91", + "B911", "BLE", "BLE0", "BLE00", @@ -3013,6 +3190,9 @@ "DTZ01", "DTZ011", "DTZ012", + "DTZ9", + "DTZ90", + "DTZ901", "E", "E1", "E10", @@ -3099,8 +3279,6 @@ "E9", "E90", "E902", - "E99", - "E999", "EM", "EM1", "EM10", @@ -3222,6 +3400,7 @@ "FURB116", "FURB118", "FURB12", + "FURB122", "FURB129", "FURB13", "FURB131", @@ -3239,6 +3418,7 @@ "FURB157", "FURB16", "FURB161", + "FURB162", "FURB163", "FURB164", "FURB166", @@ -3253,6 +3433,7 @@ "FURB181", "FURB187", "FURB188", + "FURB189", "FURB19", "FURB192", "G", @@ -3303,8 +3484,12 @@ "LOG00", "LOG001", "LOG002", + "LOG004", "LOG007", "LOG009", + "LOG01", + "LOG014", + "LOG015", "N", "N8", "N80", @@ -3409,6 +3594,9 @@ "PLC0414", "PLC0415", "PLC1", + "PLC18", + "PLC180", + "PLC1802", "PLC19", "PLC190", "PLC1901", @@ -3582,6 +3770,7 @@ "PLW021", "PLW0211", "PLW024", + "PLW0244", "PLW0245", "PLW04", "PLW040", @@ -3600,6 +3789,7 @@ "PLW15", "PLW150", "PLW1501", + "PLW1507", "PLW1508", "PLW1509", "PLW151", @@ -3628,8 +3818,6 @@ "PT001", "PT002", "PT003", - "PT004", - "PT005", "PT006", "PT007", "PT008", @@ -3654,6 +3842,11 @@ "PT025", "PT026", "PT027", + "PT028", + "PT029", + "PT03", + "PT030", + "PT031", "PTH", "PTH1", "PTH10", @@ -3693,6 +3886,9 @@ "PTH205", "PTH206", "PTH207", + "PTH208", + "PTH21", + "PTH210", "PYI", "PYI0", "PYI00", @@ -3752,6 +3948,7 @@ "PYI058", "PYI059", "PYI06", + "PYI061", "PYI062", "PYI063", "PYI064", @@ -3815,10 +4012,36 @@ "RUF032", "RUF033", "RUF034", + "RUF036", + "RUF037", + "RUF038", + "RUF039", + "RUF04", + "RUF040", + "RUF041", + "RUF043", + "RUF045", + "RUF046", + "RUF047", + "RUF048", + "RUF049", + "RUF05", + "RUF051", + "RUF052", + "RUF053", + "RUF054", + "RUF055", + "RUF056", + "RUF057", + "RUF058", + "RUF059", + "RUF06", + "RUF060", "RUF1", "RUF10", "RUF100", "RUF101", + "RUF102", "RUF2", "RUF20", "RUF200", @@ -3913,6 +4136,7 @@ "S70", "S701", "S702", + "S704", "SIM", "SIM1", "SIM10", @@ -3953,6 +4177,8 @@ "SIM40", "SIM401", "SIM9", + "SIM90", + "SIM905", "SIM91", "SIM910", "SIM911", @@ -3974,16 +4200,19 @@ "T20", "T201", "T203", - "TCH", - "TCH0", - "TCH00", - "TCH001", - "TCH002", - "TCH003", - "TCH004", - "TCH005", - "TCH01", - "TCH010", + "TC", + "TC0", + "TC00", + "TC001", + "TC002", + "TC003", + "TC004", + "TC005", + "TC006", + "TC007", + "TC008", + "TC01", + "TC010", "TD", "TD0", "TD00", @@ -4047,7 +4276,6 @@ "UP024", "UP025", "UP026", - "UP027", "UP028", "UP029", "UP03", @@ -4066,6 +4294,11 @@ "UP041", "UP042", "UP043", + "UP044", + "UP045", + "UP046", + "UP047", + "UP049", "W", "W1", "W19", diff --git a/rust-toolchain.toml b/rust-toolchain.toml index 76fcadb5b3218..0837c1fca7304 100644 --- a/rust-toolchain.toml +++ b/rust-toolchain.toml @@ -1,2 +1,2 @@ [toolchain] -channel = "1.82" +channel = "1.87" diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000000000..f3e454b618cda --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,2 @@ +edition = "2024" +style_edition = "2024" diff --git a/scripts/_mdformat_utils.py b/scripts/_mdformat_utils.py deleted file mode 100644 index 8827551cbd85e..0000000000000 --- a/scripts/_mdformat_utils.py +++ /dev/null @@ -1,44 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -import mdformat - -if TYPE_CHECKING: - import argparse - - from markdown_it import MarkdownIt - from mdformat.renderer import RenderContext, RenderTreeNode - - -class NoEscapeTextPlugin: - r"""Overrides the default text formatting behavior of mdformat. - - By default mdformat will escape any markdown special character found in a - text block, e.g., <. Some of these characters are found in our - documentation, and when escaped (i.e. \<) will be rendered incorrectly by - mkdocs, i.e., the backslash will appear in the render. Because our only - purpose in using mdformat is to manage the line-breaks, it makes sense to - override its text formatting behavior. - """ - - def __init__(self: NoEscapeTextPlugin) -> None: - self.POSTPROCESSORS = {"text": NoEscapeTextPlugin.text} - self.RENDERERS = {} - - @staticmethod - def add_cli_options(parser: argparse.ArgumentParser) -> None: - pass - - @staticmethod - def update_mdit(mdit: MarkdownIt) -> None: - pass - - @staticmethod - def text(_text: str, node: RenderTreeNode, _context: RenderContext) -> str: - return node.content - - -def add_no_escape_text_plugin() -> None: - """Add NoEscapeTextPlugin to the list of mdformat extensions.""" - mdformat.plugins.PARSER_EXTENSIONS["no-escape-text"] = NoEscapeTextPlugin() diff --git a/scripts/add_rule.py b/scripts/add_rule.py index fbb2f66b18d0e..013505a2e45e6 100755 --- a/scripts/add_rule.py +++ b/scripts/add_rule.py @@ -93,7 +93,7 @@ def main(*, name: str, prefix: str, code: str, linter: str) -> None: fp.write( f"""\ use ruff_diagnostics::Violation; -use ruff_macros::{{derive_message_formats, violation}}; +use ruff_macros::{{ViolationMetadata, derive_message_formats}}; use crate::checkers::ast::Checker; @@ -108,8 +108,8 @@ def main(*, name: str, prefix: str, code: str, linter: str) -> None: /// Use instead: /// ```python /// ``` -#[violation] -pub struct {name}; +#[derive(ViolationMetadata)] +pub(crate) struct {name}; impl Violation for {name} {{ #[derive_message_formats] diff --git a/scripts/benchmarks/README.md b/scripts/benchmarks/README.md index d54171c0c2496..efe7d5c6d6e55 100644 --- a/scripts/benchmarks/README.md +++ b/scripts/benchmarks/README.md @@ -4,10 +4,10 @@ Utilities for benchmarking Ruff. ## Getting Started -Run `./scripts/benchmarks/run.sh` to clone the benchmarking target (CPython). +Run `./scripts/benchmarks/setup.sh` to clone the benchmarking target (CPython). -If you're looking to benchmark Ruff against other tools, you'll also need to run `poetry install` -to create a virtual environment with the required dependencies. +If you're looking to benchmark Ruff against other tools, you'll also need to run `uv venv --project ./scripts/benchmarks`, +activate the venv and finally `uv sync --project ./scripts/benchmarks` to create a virtual environment with the required dependencies. ## Running Benchmarks diff --git a/scripts/benchmarks/poetry.lock b/scripts/benchmarks/poetry.lock deleted file mode 100644 index 61db8766a49d2..0000000000000 --- a/scripts/benchmarks/poetry.lock +++ /dev/null @@ -1,523 +0,0 @@ -# This file is automatically @generated by Poetry and should not be changed by hand. - -[[package]] -name = "astroid" -version = "2.15.6" -description = "An abstract syntax tree for Python with inference support." -category = "main" -optional = false -python-versions = ">=3.7.2" -files = [ - {file = "astroid-2.15.6-py3-none-any.whl", hash = "sha256:389656ca57b6108f939cf5d2f9a2a825a3be50ba9d589670f393236e0a03b91c"}, - {file = "astroid-2.15.6.tar.gz", hash = "sha256:903f024859b7c7687d7a7f3a3f73b17301f8e42dfd9cc9df9d4418172d3e2dbd"}, -] - -[package.dependencies] -lazy-object-proxy = ">=1.4.0" -typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.11\""} -wrapt = [ - {version = ">=1.11,<2", markers = "python_version < \"3.11\""}, - {version = ">=1.14,<2", markers = "python_version >= \"3.11\""}, -] - -[[package]] -name = "autoflake" -version = "2.2.1" -description = "Removes unused imports and unused variables" -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "autoflake-2.2.1-py3-none-any.whl", hash = "sha256:265cde0a43c1f44ecfb4f30d95b0437796759d07be7706a2f70e4719234c0f79"}, - {file = "autoflake-2.2.1.tar.gz", hash = "sha256:62b7b6449a692c3c9b0c916919bbc21648da7281e8506bcf8d3f8280e431ebc1"}, -] - -[package.dependencies] -pyflakes = ">=3.0.0" -tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""} - -[[package]] -name = "autopep8" -version = "2.0.4" -description = "A tool that automatically formats Python code to conform to the PEP 8 style guide" -category = "main" -optional = false -python-versions = ">=3.6" -files = [ - {file = "autopep8-2.0.4-py2.py3-none-any.whl", hash = "sha256:067959ca4a07b24dbd5345efa8325f5f58da4298dab0dde0443d5ed765de80cb"}, - {file = "autopep8-2.0.4.tar.gz", hash = "sha256:2913064abd97b3419d1cc83ea71f042cb821f87e45b9c88cad5ad3c4ea87fe0c"}, -] - -[package.dependencies] -pycodestyle = ">=2.10.0" -tomli = {version = "*", markers = "python_version < \"3.11\""} - -[[package]] -name = "black" -version = "23.9.1" -description = "The uncompromising code formatter." -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "black-23.9.1-cp310-cp310-macosx_10_16_arm64.whl", hash = "sha256:d6bc09188020c9ac2555a498949401ab35bb6bf76d4e0f8ee251694664df6301"}, - {file = "black-23.9.1-cp310-cp310-macosx_10_16_universal2.whl", hash = "sha256:13ef033794029b85dfea8032c9d3b92b42b526f1ff4bf13b2182ce4e917f5100"}, - {file = "black-23.9.1-cp310-cp310-macosx_10_16_x86_64.whl", hash = "sha256:75a2dc41b183d4872d3a500d2b9c9016e67ed95738a3624f4751a0cb4818fe71"}, - {file = "black-23.9.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:13a2e4a93bb8ca74a749b6974925c27219bb3df4d42fc45e948a5d9feb5122b7"}, - {file = "black-23.9.1-cp310-cp310-win_amd64.whl", hash = "sha256:adc3e4442eef57f99b5590b245a328aad19c99552e0bdc7f0b04db6656debd80"}, - {file = "black-23.9.1-cp311-cp311-macosx_10_16_arm64.whl", hash = "sha256:8431445bf62d2a914b541da7ab3e2b4f3bc052d2ccbf157ebad18ea126efb91f"}, - {file = "black-23.9.1-cp311-cp311-macosx_10_16_universal2.whl", hash = "sha256:8fc1ddcf83f996247505db6b715294eba56ea9372e107fd54963c7553f2b6dfe"}, - {file = "black-23.9.1-cp311-cp311-macosx_10_16_x86_64.whl", hash = "sha256:7d30ec46de88091e4316b17ae58bbbfc12b2de05e069030f6b747dfc649ad186"}, - {file = "black-23.9.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:031e8c69f3d3b09e1aa471a926a1eeb0b9071f80b17689a655f7885ac9325a6f"}, - {file = "black-23.9.1-cp311-cp311-win_amd64.whl", hash = "sha256:538efb451cd50f43aba394e9ec7ad55a37598faae3348d723b59ea8e91616300"}, - {file = "black-23.9.1-cp38-cp38-macosx_10_16_arm64.whl", hash = "sha256:638619a559280de0c2aa4d76f504891c9860bb8fa214267358f0a20f27c12948"}, - {file = "black-23.9.1-cp38-cp38-macosx_10_16_universal2.whl", hash = "sha256:a732b82747235e0542c03bf352c126052c0fbc458d8a239a94701175b17d4855"}, - {file = "black-23.9.1-cp38-cp38-macosx_10_16_x86_64.whl", hash = "sha256:cf3a4d00e4cdb6734b64bf23cd4341421e8953615cba6b3670453737a72ec204"}, - {file = "black-23.9.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cf99f3de8b3273a8317681d8194ea222f10e0133a24a7548c73ce44ea1679377"}, - {file = "black-23.9.1-cp38-cp38-win_amd64.whl", hash = "sha256:14f04c990259576acd093871e7e9b14918eb28f1866f91968ff5524293f9c573"}, - {file = "black-23.9.1-cp39-cp39-macosx_10_16_arm64.whl", hash = "sha256:c619f063c2d68f19b2d7270f4cf3192cb81c9ec5bc5ba02df91471d0b88c4c5c"}, - {file = "black-23.9.1-cp39-cp39-macosx_10_16_universal2.whl", hash = "sha256:6a3b50e4b93f43b34a9d3ef00d9b6728b4a722c997c99ab09102fd5efdb88325"}, - {file = "black-23.9.1-cp39-cp39-macosx_10_16_x86_64.whl", hash = "sha256:c46767e8df1b7beefb0899c4a95fb43058fa8500b6db144f4ff3ca38eb2f6393"}, - {file = "black-23.9.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:50254ebfa56aa46a9fdd5d651f9637485068a1adf42270148cd101cdf56e0ad9"}, - {file = "black-23.9.1-cp39-cp39-win_amd64.whl", hash = "sha256:403397c033adbc45c2bd41747da1f7fc7eaa44efbee256b53842470d4ac5a70f"}, - {file = "black-23.9.1-py3-none-any.whl", hash = "sha256:6ccd59584cc834b6d127628713e4b6b968e5f79572da66284532525a042549f9"}, - {file = "black-23.9.1.tar.gz", hash = "sha256:24b6b3ff5c6d9ea08a8888f6977eae858e1f340d7260cf56d70a49823236b62d"}, -] - -[package.dependencies] -click = ">=8.0.0" -mypy-extensions = ">=0.4.3" -packaging = ">=22.0" -pathspec = ">=0.9.0" -platformdirs = ">=2" -tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""} - -[package.extras] -colorama = ["colorama (>=0.4.3)"] -d = ["aiohttp (>=3.7.4)"] -jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] -uvloop = ["uvloop (>=0.15.2)"] - -[[package]] -name = "click" -version = "8.1.7" -description = "Composable command line interface toolkit" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, - {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, -] - -[package.dependencies] -colorama = {version = "*", markers = "platform_system == \"Windows\""} - -[[package]] -name = "colorama" -version = "0.4.6" -description = "Cross-platform colored terminal text." -category = "main" -optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" -files = [ - {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, - {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, -] - -[[package]] -name = "dill" -version = "0.3.8" -description = "serialize all of Python" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "dill-0.3.8-py3-none-any.whl", hash = "sha256:c36ca9ffb54365bdd2f8eb3eff7d2a21237f8452b57ace88b1ac615b7e815bd7"}, - {file = "dill-0.3.8.tar.gz", hash = "sha256:3ebe3c479ad625c4553aca177444d89b486b1d84982eeacded644afc0cf797ca"}, -] - -[package.extras] -graph = ["objgraph (>=1.7.2)"] - -[[package]] -name = "flake8" -version = "6.1.0" -description = "the modular source code checker: pep8 pyflakes and co" -category = "main" -optional = false -python-versions = ">=3.8.1" -files = [ - {file = "flake8-6.1.0-py2.py3-none-any.whl", hash = "sha256:ffdfce58ea94c6580c77888a86506937f9a1a227dfcd15f245d694ae20a6b6e5"}, - {file = "flake8-6.1.0.tar.gz", hash = "sha256:d5b3857f07c030bdb5bf41c7f53799571d75c4491748a3adcd47de929e34cd23"}, -] - -[package.dependencies] -mccabe = ">=0.7.0,<0.8.0" -pycodestyle = ">=2.11.0,<2.12.0" -pyflakes = ">=3.1.0,<3.2.0" - -[[package]] -name = "importlib-metadata" -version = "6.8.0" -description = "Read metadata from Python packages" -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "importlib_metadata-6.8.0-py3-none-any.whl", hash = "sha256:3ebb78df84a805d7698245025b975d9d67053cd94c79245ba4b3eb694abe68bb"}, - {file = "importlib_metadata-6.8.0.tar.gz", hash = "sha256:dbace7892d8c0c4ac1ad096662232f831d4e64f4c4545bd53016a3e9d4654743"}, -] - -[package.dependencies] -zipp = ">=0.5" - -[package.extras] -docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -perf = ["ipython"] -testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] - -[[package]] -name = "isort" -version = "5.12.0" -description = "A Python utility / library to sort Python imports." -category = "main" -optional = false -python-versions = ">=3.8.0" -files = [ - {file = "isort-5.12.0-py3-none-any.whl", hash = "sha256:f84c2818376e66cf843d497486ea8fed8700b340f308f076c6fb1229dff318b6"}, - {file = "isort-5.12.0.tar.gz", hash = "sha256:8bef7dde241278824a6d83f44a544709b065191b95b6e50894bdc722fcba0504"}, -] - -[package.extras] -colors = ["colorama (>=0.4.3)"] -pipfile-deprecated-finder = ["pip-shims (>=0.5.2)", "pipreqs", "requirementslib"] -plugins = ["setuptools"] -requirements-deprecated-finder = ["pip-api", "pipreqs"] - -[[package]] -name = "lazy-object-proxy" -version = "1.9.0" -description = "A fast and thorough lazy object proxy." -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "lazy-object-proxy-1.9.0.tar.gz", hash = "sha256:659fb5809fa4629b8a1ac5106f669cfc7bef26fbb389dda53b3e010d1ac4ebae"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b40387277b0ed2d0602b8293b94d7257e17d1479e257b4de114ea11a8cb7f2d7"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e8c6cfb338b133fbdbc5cfaa10fe3c6aeea827db80c978dbd13bc9dd8526b7d4"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:721532711daa7db0d8b779b0bb0318fa87af1c10d7fe5e52ef30f8eff254d0cd"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:66a3de4a3ec06cd8af3f61b8e1ec67614fbb7c995d02fa224813cb7afefee701"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:1aa3de4088c89a1b69f8ec0dcc169aa725b0ff017899ac568fe44ddc1396df46"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-win32.whl", hash = "sha256:f0705c376533ed2a9e5e97aacdbfe04cecd71e0aa84c7c0595d02ef93b6e4455"}, - {file = "lazy_object_proxy-1.9.0-cp310-cp310-win_amd64.whl", hash = "sha256:ea806fd4c37bf7e7ad82537b0757999264d5f70c45468447bb2b91afdbe73a6e"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:946d27deaff6cf8452ed0dba83ba38839a87f4f7a9732e8f9fd4107b21e6ff07"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:79a31b086e7e68b24b99b23d57723ef7e2c6d81ed21007b6281ebcd1688acb0a"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f699ac1c768270c9e384e4cbd268d6e67aebcfae6cd623b4d7c3bfde5a35db59"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:bfb38f9ffb53b942f2b5954e0f610f1e721ccebe9cce9025a38c8ccf4a5183a4"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:189bbd5d41ae7a498397287c408617fe5c48633e7755287b21d741f7db2706a9"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-win32.whl", hash = "sha256:81fc4d08b062b535d95c9ea70dbe8a335c45c04029878e62d744bdced5141586"}, - {file = "lazy_object_proxy-1.9.0-cp311-cp311-win_amd64.whl", hash = "sha256:f2457189d8257dd41ae9b434ba33298aec198e30adf2dcdaaa3a28b9994f6adb"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:d9e25ef10a39e8afe59a5c348a4dbf29b4868ab76269f81ce1674494e2565a6e"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cbf9b082426036e19c6924a9ce90c740a9861e2bdc27a4834fd0a910742ac1e8"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9f5fa4a61ce2438267163891961cfd5e32ec97a2c444e5b842d574251ade27d2"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:8fa02eaab317b1e9e03f69aab1f91e120e7899b392c4fc19807a8278a07a97e8"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:e7c21c95cae3c05c14aafffe2865bbd5e377cfc1348c4f7751d9dc9a48ca4bda"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-win32.whl", hash = "sha256:f12ad7126ae0c98d601a7ee504c1122bcef553d1d5e0c3bfa77b16b3968d2734"}, - {file = "lazy_object_proxy-1.9.0-cp37-cp37m-win_amd64.whl", hash = "sha256:edd20c5a55acb67c7ed471fa2b5fb66cb17f61430b7a6b9c3b4a1e40293b1671"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:2d0daa332786cf3bb49e10dc6a17a52f6a8f9601b4cf5c295a4f85854d61de63"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9cd077f3d04a58e83d04b20e334f678c2b0ff9879b9375ed107d5d07ff160171"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:660c94ea760b3ce47d1855a30984c78327500493d396eac4dfd8bd82041b22be"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:212774e4dfa851e74d393a2370871e174d7ff0ebc980907723bb67d25c8a7c30"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:f0117049dd1d5635bbff65444496c90e0baa48ea405125c088e93d9cf4525b11"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-win32.whl", hash = "sha256:0a891e4e41b54fd5b8313b96399f8b0e173bbbfc03c7631f01efbe29bb0bcf82"}, - {file = "lazy_object_proxy-1.9.0-cp38-cp38-win_amd64.whl", hash = "sha256:9990d8e71b9f6488e91ad25f322898c136b008d87bf852ff65391b004da5e17b"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9e7551208b2aded9c1447453ee366f1c4070602b3d932ace044715d89666899b"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5f83ac4d83ef0ab017683d715ed356e30dd48a93746309c8f3517e1287523ef4"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7322c3d6f1766d4ef1e51a465f47955f1e8123caee67dd641e67d539a534d006"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:18b78ec83edbbeb69efdc0e9c1cb41a3b1b1ed11ddd8ded602464c3fc6020494"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:09763491ce220c0299688940f8dc2c5d05fd1f45af1e42e636b2e8b2303e4382"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-win32.whl", hash = "sha256:9090d8e53235aa280fc9239a86ae3ea8ac58eff66a705fa6aa2ec4968b95c821"}, - {file = "lazy_object_proxy-1.9.0-cp39-cp39-win_amd64.whl", hash = "sha256:db1c1722726f47e10e0b5fdbf15ac3b8adb58c091d12b3ab713965795036985f"}, -] - -[[package]] -name = "mccabe" -version = "0.7.0" -description = "McCabe checker, plugin for flake8" -category = "main" -optional = false -python-versions = ">=3.6" -files = [ - {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, - {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, -] - -[[package]] -name = "mypy-extensions" -version = "1.0.0" -description = "Type system extensions for programs checked with the mypy type checker." -category = "main" -optional = false -python-versions = ">=3.5" -files = [ - {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, - {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, -] - -[[package]] -name = "packaging" -version = "23.1" -description = "Core utilities for Python packages" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "packaging-23.1-py3-none-any.whl", hash = "sha256:994793af429502c4ea2ebf6bf664629d07c1a9fe974af92966e4b8d2df7edc61"}, - {file = "packaging-23.1.tar.gz", hash = "sha256:a392980d2b6cffa644431898be54b0045151319d1e7ec34f0cfed48767dd334f"}, -] - -[[package]] -name = "pathspec" -version = "0.11.2" -description = "Utility library for gitignore style pattern matching of file paths." -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20"}, - {file = "pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"}, -] - -[[package]] -name = "platformdirs" -version = "3.10.0" -description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "platformdirs-3.10.0-py3-none-any.whl", hash = "sha256:d7c24979f292f916dc9cbf8648319032f551ea8c49a4c9bf2fb556a02070ec1d"}, - {file = "platformdirs-3.10.0.tar.gz", hash = "sha256:b45696dab2d7cc691a3226759c0d3b00c47c8b6e293d96f6436f733303f77f6d"}, -] - -[package.extras] -docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.1)", "sphinx-autodoc-typehints (>=1.24)"] -test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)"] - -[[package]] -name = "pycodestyle" -version = "2.11.0" -description = "Python style guide checker" -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pycodestyle-2.11.0-py2.py3-none-any.whl", hash = "sha256:5d1013ba8dc7895b548be5afb05740ca82454fd899971563d2ef625d090326f8"}, - {file = "pycodestyle-2.11.0.tar.gz", hash = "sha256:259bcc17857d8a8b3b4a2327324b79e5f020a13c16074670f9c8c8f872ea76d0"}, -] - -[[package]] -name = "pyflakes" -version = "3.1.0" -description = "passive checker of Python programs" -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pyflakes-3.1.0-py2.py3-none-any.whl", hash = "sha256:4132f6d49cb4dae6819e5379898f2b8cce3c5f23994194c24b77d5da2e36f774"}, - {file = "pyflakes-3.1.0.tar.gz", hash = "sha256:a0aae034c444db0071aa077972ba4768d40c830d9539fd45bf4cd3f8f6992efc"}, -] - -[[package]] -name = "pylint" -version = "2.17.5" -description = "python code static checker" -category = "main" -optional = false -python-versions = ">=3.7.2" -files = [ - {file = "pylint-2.17.5-py3-none-any.whl", hash = "sha256:73995fb8216d3bed149c8d51bba25b2c52a8251a2c8ac846ec668ce38fab5413"}, - {file = "pylint-2.17.5.tar.gz", hash = "sha256:f7b601cbc06fef7e62a754e2b41294c2aa31f1cb659624b9a85bcba29eaf8252"}, -] - -[package.dependencies] -astroid = ">=2.15.6,<=2.17.0-dev0" -colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} -dill = [ - {version = ">=0.2", markers = "python_version < \"3.11\""}, - {version = ">=0.3.6", markers = "python_version >= \"3.11\""}, -] -isort = ">=4.2.5,<6" -mccabe = ">=0.6,<0.8" -platformdirs = ">=2.2.0" -tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -tomlkit = ">=0.10.1" - -[package.extras] -spelling = ["pyenchant (>=3.2,<4.0)"] -testutils = ["gitpython (>3)"] - -[[package]] -name = "tomli" -version = "2.0.1" -description = "A lil' TOML parser" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"}, - {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"}, -] - -[[package]] -name = "tomlkit" -version = "0.12.1" -description = "Style preserving TOML library" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "tomlkit-0.12.1-py3-none-any.whl", hash = "sha256:712cbd236609acc6a3e2e97253dfc52d4c2082982a88f61b640ecf0817eab899"}, - {file = "tomlkit-0.12.1.tar.gz", hash = "sha256:38e1ff8edb991273ec9f6181244a6a391ac30e9f5098e7535640ea6be97a7c86"}, -] - -[[package]] -name = "typing-extensions" -version = "4.7.1" -description = "Backported and Experimental Type Hints for Python 3.7+" -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "typing_extensions-4.7.1-py3-none-any.whl", hash = "sha256:440d5dd3af93b060174bf433bccd69b0babc3b15b1a8dca43789fd7f61514b36"}, - {file = "typing_extensions-4.7.1.tar.gz", hash = "sha256:b75ddc264f0ba5615db7ba217daeb99701ad295353c45f9e95963337ceeeffb2"}, -] - -[[package]] -name = "wrapt" -version = "1.15.0" -description = "Module for decorators, wrappers and monkey patching." -category = "main" -optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" -files = [ - {file = "wrapt-1.15.0-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:ca1cccf838cd28d5a0883b342474c630ac48cac5df0ee6eacc9c7290f76b11c1"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:e826aadda3cae59295b95343db8f3d965fb31059da7de01ee8d1c40a60398b29"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:5fc8e02f5984a55d2c653f5fea93531e9836abbd84342c1d1e17abc4a15084c2"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux2010_i686.whl", hash = "sha256:96e25c8603a155559231c19c0349245eeb4ac0096fe3c1d0be5c47e075bd4f46"}, - {file = "wrapt-1.15.0-cp27-cp27m-manylinux2010_x86_64.whl", hash = "sha256:40737a081d7497efea35ab9304b829b857f21558acfc7b3272f908d33b0d9d4c"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:f87ec75864c37c4c6cb908d282e1969e79763e0d9becdfe9fe5473b7bb1e5f09"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:1286eb30261894e4c70d124d44b7fd07825340869945c79d05bda53a40caa079"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux2010_i686.whl", hash = "sha256:493d389a2b63c88ad56cdc35d0fa5752daac56ca755805b1b0c530f785767d5e"}, - {file = "wrapt-1.15.0-cp27-cp27mu-manylinux2010_x86_64.whl", hash = "sha256:58d7a75d731e8c63614222bcb21dd992b4ab01a399f1f09dd82af17bbfc2368a"}, - {file = "wrapt-1.15.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:21f6d9a0d5b3a207cdf7acf8e58d7d13d463e639f0c7e01d82cdb671e6cb7923"}, - {file = "wrapt-1.15.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ce42618f67741d4697684e501ef02f29e758a123aa2d669e2d964ff734ee00ee"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:41d07d029dd4157ae27beab04d22b8e261eddfc6ecd64ff7000b10dc8b3a5727"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:54accd4b8bc202966bafafd16e69da9d5640ff92389d33d28555c5fd4f25ccb7"}, - {file = "wrapt-1.15.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2fbfbca668dd15b744418265a9607baa970c347eefd0db6a518aaf0cfbd153c0"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:76e9c727a874b4856d11a32fb0b389afc61ce8aaf281ada613713ddeadd1cfec"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e20076a211cd6f9b44a6be58f7eeafa7ab5720eb796975d0c03f05b47d89eb90"}, - {file = "wrapt-1.15.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a74d56552ddbde46c246b5b89199cb3fd182f9c346c784e1a93e4dc3f5ec9975"}, - {file = "wrapt-1.15.0-cp310-cp310-win32.whl", hash = "sha256:26458da5653aa5b3d8dc8b24192f574a58984c749401f98fff994d41d3f08da1"}, - {file = "wrapt-1.15.0-cp310-cp310-win_amd64.whl", hash = "sha256:75760a47c06b5974aa5e01949bf7e66d2af4d08cb8c1d6516af5e39595397f5e"}, - {file = "wrapt-1.15.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ba1711cda2d30634a7e452fc79eabcadaffedf241ff206db2ee93dd2c89a60e7"}, - {file = "wrapt-1.15.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:56374914b132c702aa9aa9959c550004b8847148f95e1b824772d453ac204a72"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a89ce3fd220ff144bd9d54da333ec0de0399b52c9ac3d2ce34b569cf1a5748fb"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3bbe623731d03b186b3d6b0d6f51865bf598587c38d6f7b0be2e27414f7f214e"}, - {file = "wrapt-1.15.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3abbe948c3cbde2689370a262a8d04e32ec2dd4f27103669a45c6929bcdbfe7c"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:b67b819628e3b748fd3c2192c15fb951f549d0f47c0449af0764d7647302fda3"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:7eebcdbe3677e58dd4c0e03b4f2cfa346ed4049687d839adad68cc38bb559c92"}, - {file = "wrapt-1.15.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:74934ebd71950e3db69960a7da29204f89624dde411afbfb3b4858c1409b1e98"}, - {file = "wrapt-1.15.0-cp311-cp311-win32.whl", hash = "sha256:bd84395aab8e4d36263cd1b9308cd504f6cf713b7d6d3ce25ea55670baec5416"}, - {file = "wrapt-1.15.0-cp311-cp311-win_amd64.whl", hash = "sha256:a487f72a25904e2b4bbc0817ce7a8de94363bd7e79890510174da9d901c38705"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:4ff0d20f2e670800d3ed2b220d40984162089a6e2c9646fdb09b85e6f9a8fc29"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:9ed6aa0726b9b60911f4aed8ec5b8dd7bf3491476015819f56473ffaef8959bd"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux2010_i686.whl", hash = "sha256:896689fddba4f23ef7c718279e42f8834041a21342d95e56922e1c10c0cc7afb"}, - {file = "wrapt-1.15.0-cp35-cp35m-manylinux2010_x86_64.whl", hash = "sha256:75669d77bb2c071333417617a235324a1618dba66f82a750362eccbe5b61d248"}, - {file = "wrapt-1.15.0-cp35-cp35m-win32.whl", hash = "sha256:fbec11614dba0424ca72f4e8ba3c420dba07b4a7c206c8c8e4e73f2e98f4c559"}, - {file = "wrapt-1.15.0-cp35-cp35m-win_amd64.whl", hash = "sha256:fd69666217b62fa5d7c6aa88e507493a34dec4fa20c5bd925e4bc12fce586639"}, - {file = "wrapt-1.15.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:b0724f05c396b0a4c36a3226c31648385deb6a65d8992644c12a4963c70326ba"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bbeccb1aa40ab88cd29e6c7d8585582c99548f55f9b2581dfc5ba68c59a85752"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:38adf7198f8f154502883242f9fe7333ab05a5b02de7d83aa2d88ea621f13364"}, - {file = "wrapt-1.15.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:578383d740457fa790fdf85e6d346fda1416a40549fe8db08e5e9bd281c6a475"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:a4cbb9ff5795cd66f0066bdf5947f170f5d63a9274f99bdbca02fd973adcf2a8"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:af5bd9ccb188f6a5fdda9f1f09d9f4c86cc8a539bd48a0bfdc97723970348418"}, - {file = "wrapt-1.15.0-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:b56d5519e470d3f2fe4aa7585f0632b060d532d0696c5bdfb5e8319e1d0f69a2"}, - {file = "wrapt-1.15.0-cp36-cp36m-win32.whl", hash = "sha256:77d4c1b881076c3ba173484dfa53d3582c1c8ff1f914c6461ab70c8428b796c1"}, - {file = "wrapt-1.15.0-cp36-cp36m-win_amd64.whl", hash = "sha256:077ff0d1f9d9e4ce6476c1a924a3332452c1406e59d90a2cf24aeb29eeac9420"}, - {file = "wrapt-1.15.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5c5aa28df055697d7c37d2099a7bc09f559d5053c3349b1ad0c39000e611d317"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3a8564f283394634a7a7054b7983e47dbf39c07712d7b177b37e03f2467a024e"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:780c82a41dc493b62fc5884fb1d3a3b81106642c5c5c78d6a0d4cbe96d62ba7e"}, - {file = "wrapt-1.15.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e169e957c33576f47e21864cf3fc9ff47c223a4ebca8960079b8bd36cb014fd0"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:b02f21c1e2074943312d03d243ac4388319f2456576b2c6023041c4d57cd7019"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f2e69b3ed24544b0d3dbe2c5c0ba5153ce50dcebb576fdc4696d52aa22db6034"}, - {file = "wrapt-1.15.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:d787272ed958a05b2c86311d3a4135d3c2aeea4fc655705f074130aa57d71653"}, - {file = "wrapt-1.15.0-cp37-cp37m-win32.whl", hash = "sha256:02fce1852f755f44f95af51f69d22e45080102e9d00258053b79367d07af39c0"}, - {file = "wrapt-1.15.0-cp37-cp37m-win_amd64.whl", hash = "sha256:abd52a09d03adf9c763d706df707c343293d5d106aea53483e0ec8d9e310ad5e"}, - {file = "wrapt-1.15.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cdb4f085756c96a3af04e6eca7f08b1345e94b53af8921b25c72f096e704e145"}, - {file = "wrapt-1.15.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:230ae493696a371f1dbffaad3dafbb742a4d27a0afd2b1aecebe52b740167e7f"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:63424c681923b9f3bfbc5e3205aafe790904053d42ddcc08542181a30a7a51bd"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d6bcbfc99f55655c3d93feb7ef3800bd5bbe963a755687cbf1f490a71fb7794b"}, - {file = "wrapt-1.15.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c99f4309f5145b93eca6e35ac1a988f0dc0a7ccf9ccdcd78d3c0adf57224e62f"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:b130fe77361d6771ecf5a219d8e0817d61b236b7d8b37cc045172e574ed219e6"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:96177eb5645b1c6985f5c11d03fc2dbda9ad24ec0f3a46dcce91445747e15094"}, - {file = "wrapt-1.15.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d5fe3e099cf07d0fb5a1e23d399e5d4d1ca3e6dfcbe5c8570ccff3e9208274f7"}, - {file = "wrapt-1.15.0-cp38-cp38-win32.whl", hash = "sha256:abd8f36c99512755b8456047b7be10372fca271bf1467a1caa88db991e7c421b"}, - {file = "wrapt-1.15.0-cp38-cp38-win_amd64.whl", hash = "sha256:b06fa97478a5f478fb05e1980980a7cdf2712015493b44d0c87606c1513ed5b1"}, - {file = "wrapt-1.15.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2e51de54d4fb8fb50d6ee8327f9828306a959ae394d3e01a1ba8b2f937747d86"}, - {file = "wrapt-1.15.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0970ddb69bba00670e58955f8019bec4a42d1785db3faa043c33d81de2bf843c"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:76407ab327158c510f44ded207e2f76b657303e17cb7a572ffe2f5a8a48aa04d"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd525e0e52a5ff16653a3fc9e3dd827981917d34996600bbc34c05d048ca35cc"}, - {file = "wrapt-1.15.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9d37ac69edc5614b90516807de32d08cb8e7b12260a285ee330955604ed9dd29"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:078e2a1a86544e644a68422f881c48b84fef6d18f8c7a957ffd3f2e0a74a0d4a"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:2cf56d0e237280baed46f0b5316661da892565ff58309d4d2ed7dba763d984b8"}, - {file = "wrapt-1.15.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7dc0713bf81287a00516ef43137273b23ee414fe41a3c14be10dd95ed98a2df9"}, - {file = "wrapt-1.15.0-cp39-cp39-win32.whl", hash = "sha256:46ed616d5fb42f98630ed70c3529541408166c22cdfd4540b88d5f21006b0eff"}, - {file = "wrapt-1.15.0-cp39-cp39-win_amd64.whl", hash = "sha256:eef4d64c650f33347c1f9266fa5ae001440b232ad9b98f1f43dfe7a79435c0a6"}, - {file = "wrapt-1.15.0-py3-none-any.whl", hash = "sha256:64b1df0f83706b4ef4cfb4fb0e4c2669100fd7ecacfb59e091fad300d4e04640"}, - {file = "wrapt-1.15.0.tar.gz", hash = "sha256:d06730c6aed78cee4126234cf2d071e01b44b915e725a6cb439a879ec9754a3a"}, -] - -[[package]] -name = "yapf" -version = "0.40.1" -description = "A formatter for Python code." -category = "main" -optional = false -python-versions = ">=3.7" -files = [ - {file = "yapf-0.40.1-py3-none-any.whl", hash = "sha256:b8bfc1f280949153e795181768ca14ef43d7312629a06c43e7abd279323af313"}, - {file = "yapf-0.40.1.tar.gz", hash = "sha256:958587eb5c8ec6c860119a9c25d02addf30a44f75aa152a4220d30e56a98037c"}, -] - -[package.dependencies] -importlib-metadata = ">=6.6.0" -platformdirs = ">=3.5.1" -tomli = ">=2.0.1" - -[[package]] -name = "zipp" -version = "3.16.2" -description = "Backport of pathlib-compatible object wrapper for zip files" -category = "main" -optional = false -python-versions = ">=3.8" -files = [ - {file = "zipp-3.16.2-py3-none-any.whl", hash = "sha256:679e51dd4403591b2d6838a48de3d283f3d188412a9782faadf845f298736ba0"}, - {file = "zipp-3.16.2.tar.gz", hash = "sha256:ebc15946aa78bd63458992fc81ec3b6f7b1e92d51c35e6de1c3804e73b799147"}, -] - -[package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy (>=0.9.1)", "pytest-ruff"] - -[extras] -formatter = ["black", "yapf", "autopep8"] -linter = ["autoflake", "flake8", "pycodestyle", "pyflakes", "pylint", "isort"] - -[metadata] -lock-version = "2.0" -python-versions = ">=3.10,<3.12" -content-hash = "6d486d66e3a6567aea218bed65725bf557c28875bcc4e91c2e9810d367ea035e" diff --git a/scripts/benchmarks/pyproject.toml b/scripts/benchmarks/pyproject.toml index 1edebef90a6f1..db8d6ca413070 100644 --- a/scripts/benchmarks/pyproject.toml +++ b/scripts/benchmarks/pyproject.toml @@ -1,38 +1,26 @@ -[tool.poetry] +[project] name = "scripts" -version = "0.7.1" +version = "0.11.10" description = "" authors = ["Charles Marsh "] -[tool.poetry.dependencies] + python = ">=3.10,<3.12" -autoflake = "*" -autopep8 = "*" -black = "*" -flake8 = "*" -isort = "*" -pycodestyle = "*" -pyflakes = "*" -pylint = "*" -yapf = "*" -[tool.poetry.dev-dependencies] +dependencies = ["autoflake", "autopep8", "black", "flake8", "isort", "pycodestyle", "pyflakes", "pylint", "yapf"] -[tool.poetry.extras] +[dependency-groups] formatter = [ - "black", - "yapf", - "autopep8", + "black", + "yapf", + "autopep8", ] linter = [ - "autoflake", - "flake8", - "pycodestyle", - "pyflakes", - "pylint", - "isort", + "autoflake", + "flake8", + "pycodestyle", + "pyflakes", + "pylint", + "isort", ] -[build-system] -requires = ["poetry-core>=1.0.0"] -build-backend = "poetry.core.masonry.api" diff --git a/scripts/benchmarks/run.sh b/scripts/benchmarks/run.sh index c0d633729802c..5cf8b94cc6bc6 100755 --- a/scripts/benchmarks/run.sh +++ b/scripts/benchmarks/run.sh @@ -4,5 +4,5 @@ # Benchmark Ruff on the CPython codebase. ### -cargo build --release && hyperfine --ignore-failure --warmup 10 \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache" +cargo build --release && hyperfine --warmup 10 \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --exit-zero" diff --git a/scripts/benchmarks/run_all.sh b/scripts/benchmarks/run_all.sh index 67a0c21046227..018c02d3bf105 100755 --- a/scripts/benchmarks/run_all.sh +++ b/scripts/benchmarks/run_all.sh @@ -20,7 +20,7 @@ # }) hyperfine --ignore-failure --warmup 5 \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --select ALL" \ - "flake8 crates/ruff_linter/resources/test/cpython -qq --docstring-convention=all" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --select ALL --exit-zero" \ + "flake8 crates/ruff_linter/resources/test/cpython -qq --exit-zero" \ "pycodestyle crates/ruff_linter/resources/test/cpython -qq" \ - "pylint crates/ruff_linter/resources/test/cpython -j 0 --recursive=y --disable=E,W,C,R" + "pylint crates/ruff_linter/resources/test/cpython -j 0 --recursive=y --disable=E,W,C,R --exit-zero" diff --git a/scripts/benchmarks/run_comparisons.sh b/scripts/benchmarks/run_comparisons.sh index 696d3345e5602..d364be8a36747 100755 --- a/scripts/benchmarks/run_comparisons.sh +++ b/scripts/benchmarks/run_comparisons.sh @@ -4,9 +4,9 @@ # Benchmark Ruff's performance against a variety of similar tools. ### -hyperfine --ignore-failure --warmup 5 \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache" \ +hyperfine --ignore-failure --warmup 2 --runs 5\ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --exit-zero" \ "pyflakes crates/ruff_linter/resources/test/cpython" \ "autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys crates/ruff_linter/resources/test/cpython" \ "pycodestyle crates/ruff_linter/resources/test/cpython" \ - "flake8 crates/ruff_linter/resources/test/cpython" + "flake8 crates/ruff_linter/resources/test/cpython --exit-zero" diff --git a/scripts/benchmarks/run_plugins.sh b/scripts/benchmarks/run_plugins.sh old mode 100644 new mode 100755 index 83e1e9a14915f..13e7dce404e3f --- a/scripts/benchmarks/run_plugins.sh +++ b/scripts/benchmarks/run_plugins.sh @@ -4,40 +4,40 @@ # Benchmark the incremental performance of each subsequent plugin. ### -cargo build --release && hyperfine --ignore-failure --warmup 10 \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select C90" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select I" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select D" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select UP" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select N" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select YTT" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ANN" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select S" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select BLE" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select FBT" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select B" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select A" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select C4" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select T10" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select EM" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ISC" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ICN" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select T20" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PT" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select Q" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select RET" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select SIM" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select TID" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ARG" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select DTZ" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ERA" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PD" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PGH" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLC" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLE" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLR" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLW" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PIE" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select COM" \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select RUF" +cargo build --release && hyperfine --warmup 10 \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select C90 --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select I --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select D --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select UP --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select N --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select YTT --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ANN --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select S --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select BLE --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select FBT --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select B --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select A --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select C4 --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select T10 --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select EM --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ISC --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ICN --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select T20 --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PT --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select Q --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select RET --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select SIM --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select TID --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ARG --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select DTZ --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select ERA --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PD --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PGH --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLC --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLE --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLR --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PLW --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select PIE --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select COM --exit-zero" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --extend-select RUF --exit-zero" diff --git a/scripts/benchmarks/run_silent.sh b/scripts/benchmarks/run_silent.sh index d7d7d25808ea4..a6996a35cda65 100755 --- a/scripts/benchmarks/run_silent.sh +++ b/scripts/benchmarks/run_silent.sh @@ -6,7 +6,7 @@ ### hyperfine --ignore-failure --warmup 5 \ - "./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent" \ + "./target/release/ruff check ./crates/ruff_linter/resources/test/cpython/ --no-cache --silent --exit-zero" \ "pycodestyle ./crates/ruff_linter/resources/test/cpython -qq" \ - "flake8 ./crates/ruff_linter/resources/test/cpython -qq" \ - "pylint ./crates/ruff_linter/resources/test/cpython -j 0 --recursive=y --disable=E,W,C,R" + "flake8 ./crates/ruff_linter/resources/test/cpython -qq --exit-zero" \ + "pylint ./crates/ruff_linter/resources/test/cpython -j 0 --recursive=y --disable=E,W,C,R--exit-zero" diff --git a/scripts/benchmarks/setup.sh b/scripts/benchmarks/setup.sh index 8caed7c113170..ad0d8f35c94e9 100755 --- a/scripts/benchmarks/setup.sh +++ b/scripts/benchmarks/setup.sh @@ -4,4 +4,4 @@ # Setup the CPython repository to enable benchmarking. ### -git clone --branch 3.10 https://github.com/python/cpython.git crates/ruff_linter/resources/test/cpython --filter=blob:none +git clone --branch 3.12 https://github.com/python/cpython.git crates/ruff_linter/resources/test/cpython --filter=blob:none --depth=1 diff --git a/scripts/benchmarks/uv.lock b/scripts/benchmarks/uv.lock new file mode 100644 index 0000000000000..842ff01a1cfbd --- /dev/null +++ b/scripts/benchmarks/uv.lock @@ -0,0 +1,269 @@ +version = 1 +requires-python = ">=3.13" + +[[package]] +name = "astroid" +version = "3.3.7" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/20/f6/7725404e3dcaeafe695d4fe42ad99eefbcba4cad2c83ca122e6b439c9f96/astroid-3.3.7.tar.gz", hash = "sha256:29fe1df7ef64dc17a54dbfad67b40b445340fcdba7c4012e7ecc9270c9b2f5b6", size = 398091 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/83/0b/ef3a51abbf2064ac50447a02d1cd14c1f008590e96f780042c21108b6b56/astroid-3.3.7-py3-none-any.whl", hash = "sha256:e1ea2c358a3c760ef583d4963e773100fa2c693b27ed158a1d0e81adb4436903", size = 275125 }, +] + +[[package]] +name = "autoflake" +version = "2.3.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyflakes" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/2a/cb/486f912d6171bc5748c311a2984a301f4e2d054833a1da78485866c71522/autoflake-2.3.1.tar.gz", hash = "sha256:c98b75dc5b0a86459c4f01a1d32ac7eb4338ec4317a4469515ff1e687ecd909e", size = 27642 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a2/ee/3fd29bf416eb4f1c5579cf12bf393ae954099258abd7bde03c4f9716ef6b/autoflake-2.3.1-py3-none-any.whl", hash = "sha256:3ae7495db9084b7b32818b4140e6dc4fc280b712fb414f5b8fe57b0a8e85a840", size = 32483 }, +] + +[[package]] +name = "autopep8" +version = "2.3.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pycodestyle" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/6c/52/65556a5f917a4b273fd1b705f98687a6bd721dbc45966f0f6687e90a18b0/autopep8-2.3.1.tar.gz", hash = "sha256:8d6c87eba648fdcfc83e29b788910b8643171c395d9c4bcf115ece035b9c9dda", size = 92064 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ad/9e/f0beffe45b507dca9d7540fad42b316b2fd1076dc484c9b1f23d9da570d7/autopep8-2.3.1-py2.py3-none-any.whl", hash = "sha256:a203fe0fcad7939987422140ab17a930f684763bf7335bdb6709991dd7ef6c2d", size = 45667 }, +] + +[[package]] +name = "black" +version = "24.10.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "mypy-extensions" }, + { name = "packaging" }, + { name = "pathspec" }, + { name = "platformdirs" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d8/0d/cc2fb42b8c50d80143221515dd7e4766995bd07c56c9a3ed30baf080b6dc/black-24.10.0.tar.gz", hash = "sha256:846ea64c97afe3bc677b761787993be4991810ecc7a4a937816dd6bddedc4875", size = 645813 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d0/a0/a993f58d4ecfba035e61fca4e9f64a2ecae838fc9f33ab798c62173ed75c/black-24.10.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1cbacacb19e922a1d75ef2b6ccaefcd6e93a2c05ede32f06a21386a04cedb981", size = 1643986 }, + { url = "https://files.pythonhosted.org/packages/37/d5/602d0ef5dfcace3fb4f79c436762f130abd9ee8d950fa2abdbf8bbc555e0/black-24.10.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:1f93102e0c5bb3907451063e08b9876dbeac810e7da5a8bfb7aeb5a9ef89066b", size = 1448085 }, + { url = "https://files.pythonhosted.org/packages/47/6d/a3a239e938960df1a662b93d6230d4f3e9b4a22982d060fc38c42f45a56b/black-24.10.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ddacb691cdcdf77b96f549cf9591701d8db36b2f19519373d60d31746068dbf2", size = 1760928 }, + { url = "https://files.pythonhosted.org/packages/dd/cf/af018e13b0eddfb434df4d9cd1b2b7892bab119f7a20123e93f6910982e8/black-24.10.0-cp313-cp313-win_amd64.whl", hash = "sha256:680359d932801c76d2e9c9068d05c6b107f2584b2a5b88831c83962eb9984c1b", size = 1436875 }, + { url = "https://files.pythonhosted.org/packages/8d/a7/4b27c50537ebca8bec139b872861f9d2bf501c5ec51fcf897cb924d9e264/black-24.10.0-py3-none-any.whl", hash = "sha256:3bb2b7a1f7b685f85b11fed1ef10f8a9148bceb49853e47a294a3dd963c1dd7d", size = 206898 }, +] + +[[package]] +name = "click" +version = "8.1.8" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "platform_system == 'Windows'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b9/2e/0090cbf739cee7d23781ad4b89a9894a41538e4fcf4c31dcdd705b78eb8b/click-8.1.8.tar.gz", hash = "sha256:ed53c9d8990d83c2a27deae68e4ee337473f6330c040a31d4225c9574d16096a", size = 226593 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7e/d4/7ebdbd03970677812aac39c869717059dbb71a4cfc033ca6e5221787892c/click-8.1.8-py3-none-any.whl", hash = "sha256:63c132bbbed01578a06712a2d1f497bb62d9c1c0d329b7903a866228027263b2", size = 98188 }, +] + +[[package]] +name = "colorama" +version = "0.4.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335 }, +] + +[[package]] +name = "dill" +version = "0.3.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/70/43/86fe3f9e130c4137b0f1b50784dd70a5087b911fe07fa81e53e0c4c47fea/dill-0.3.9.tar.gz", hash = "sha256:81aa267dddf68cbfe8029c42ca9ec6a4ab3b22371d1c450abc54422577b4512c", size = 187000 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/46/d1/e73b6ad76f0b1fb7f23c35c6d95dbc506a9c8804f43dda8cb5b0fa6331fd/dill-0.3.9-py3-none-any.whl", hash = "sha256:468dff3b89520b474c0397703366b7b95eebe6303f108adf9b19da1f702be87a", size = 119418 }, +] + +[[package]] +name = "flake8" +version = "7.1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mccabe" }, + { name = "pycodestyle" }, + { name = "pyflakes" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/37/72/e8d66150c4fcace3c0a450466aa3480506ba2cae7b61e100a2613afc3907/flake8-7.1.1.tar.gz", hash = "sha256:049d058491e228e03e67b390f311bbf88fce2dbaa8fa673e7aea87b7198b8d38", size = 48054 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d9/42/65004373ac4617464f35ed15931b30d764f53cdd30cc78d5aea349c8c050/flake8-7.1.1-py2.py3-none-any.whl", hash = "sha256:597477df7860daa5aa0fdd84bf5208a043ab96b8e96ab708770ae0364dd03213", size = 57731 }, +] + +[[package]] +name = "isort" +version = "5.13.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/87/f9/c1eb8635a24e87ade2efce21e3ce8cd6b8630bb685ddc9cdaca1349b2eb5/isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109", size = 175303 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/b3/8def84f539e7d2289a02f0524b944b15d7c75dab7628bedf1c4f0992029c/isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6", size = 92310 }, +] + +[[package]] +name = "mccabe" +version = "0.7.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e7/ff/0ffefdcac38932a54d2b5eed4e0ba8a408f215002cd178ad1df0f2806ff8/mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325", size = 9658 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/27/1a/1f68f9ba0c207934b35b86a8ca3aad8395a3d6dd7921c0686e23853ff5a9/mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e", size = 7350 }, +] + +[[package]] +name = "mypy-extensions" +version = "1.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/98/a4/1ab47638b92648243faf97a5aeb6ea83059cc3624972ab6b8d2316078d3f/mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782", size = 4433 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2a/e2/5d3f6ada4297caebe1a2add3b126fe800c96f56dbe5d1988a2cbe0b267aa/mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d", size = 4695 }, +] + +[[package]] +name = "packaging" +version = "24.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d0/63/68dbb6eb2de9cb10ee4c9c14a0148804425e13c4fb20d61cce69f53106da/packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f", size = 163950 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/88/ef/eb23f262cca3c0c4eb7ab1933c3b1f03d021f2c48f54763065b6f0e321be/packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759", size = 65451 }, +] + +[[package]] +name = "pathspec" +version = "0.12.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ca/bc/f35b8446f4531a7cb215605d100cd88b7ac6f44ab3fc94870c120ab3adbf/pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712", size = 51043 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cc/20/ff623b09d963f88bfde16306a54e12ee5ea43e9b597108672ff3a408aad6/pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08", size = 31191 }, +] + +[[package]] +name = "platformdirs" +version = "4.3.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/13/fc/128cc9cb8f03208bdbf93d3aa862e16d376844a14f9a0ce5cf4507372de4/platformdirs-4.3.6.tar.gz", hash = "sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907", size = 21302 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3c/a6/bc1012356d8ece4d66dd75c4b9fc6c1f6650ddd5991e421177d9f8f671be/platformdirs-4.3.6-py3-none-any.whl", hash = "sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb", size = 18439 }, +] + +[[package]] +name = "pycodestyle" +version = "2.12.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/43/aa/210b2c9aedd8c1cbeea31a50e42050ad56187754b34eb214c46709445801/pycodestyle-2.12.1.tar.gz", hash = "sha256:6838eae08bbce4f6accd5d5572075c63626a15ee3e6f842df996bf62f6d73521", size = 39232 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3a/d8/a211b3f85e99a0daa2ddec96c949cac6824bd305b040571b82a03dd62636/pycodestyle-2.12.1-py2.py3-none-any.whl", hash = "sha256:46f0fb92069a7c28ab7bb558f05bfc0110dac69a0cd23c61ea0040283a9d78b3", size = 31284 }, +] + +[[package]] +name = "pyflakes" +version = "3.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/57/f9/669d8c9c86613c9d568757c7f5824bd3197d7b1c6c27553bc5618a27cce2/pyflakes-3.2.0.tar.gz", hash = "sha256:1c61603ff154621fb2a9172037d84dca3500def8c8b630657d1701f026f8af3f", size = 63788 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d4/d7/f1b7db88d8e4417c5d47adad627a93547f44bdc9028372dbd2313f34a855/pyflakes-3.2.0-py2.py3-none-any.whl", hash = "sha256:84b5be138a2dfbb40689ca07e2152deb896a65c3a3e24c251c5c62489568074a", size = 62725 }, +] + +[[package]] +name = "pylint" +version = "3.3.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "astroid" }, + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "dill" }, + { name = "isort" }, + { name = "mccabe" }, + { name = "platformdirs" }, + { name = "tomlkit" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/81/d8/4471b2cb4ad18b4af717918c468209bd2bd5a02c52f60be5ee8a71b5af2c/pylint-3.3.2.tar.gz", hash = "sha256:9ec054ec992cd05ad30a6df1676229739a73f8feeabf3912c995d17601052b01", size = 1516485 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/61/55/5eaf6c415f6ddb09b9b039278823a8e27fb81ea7a34ec80c6d9223b17f2e/pylint-3.3.2-py3-none-any.whl", hash = "sha256:77f068c287d49b8683cd7c6e624243c74f92890f767f106ffa1ddf3c0a54cb7a", size = 521873 }, +] + +[[package]] +name = "scripts" +version = "0.8.4" +source = { virtual = "." } +dependencies = [ + { name = "autoflake" }, + { name = "autopep8" }, + { name = "black" }, + { name = "flake8" }, + { name = "isort" }, + { name = "pycodestyle" }, + { name = "pyflakes" }, + { name = "pylint" }, + { name = "yapf" }, +] + +[package.dev-dependencies] +formatter = [ + { name = "autopep8" }, + { name = "black" }, + { name = "yapf" }, +] +linter = [ + { name = "autoflake" }, + { name = "flake8" }, + { name = "isort" }, + { name = "pycodestyle" }, + { name = "pyflakes" }, + { name = "pylint" }, +] + +[package.metadata] +requires-dist = [ + { name = "autoflake" }, + { name = "autopep8" }, + { name = "black" }, + { name = "flake8" }, + { name = "isort" }, + { name = "pycodestyle" }, + { name = "pyflakes" }, + { name = "pylint" }, + { name = "yapf" }, +] + +[package.metadata.requires-dev] +formatter = [ + { name = "autopep8" }, + { name = "black" }, + { name = "yapf" }, +] +linter = [ + { name = "autoflake" }, + { name = "flake8" }, + { name = "isort" }, + { name = "pycodestyle" }, + { name = "pyflakes" }, + { name = "pylint" }, +] + +[[package]] +name = "tomlkit" +version = "0.13.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b1/09/a439bec5888f00a54b8b9f05fa94d7f901d6735ef4e55dcec9bc37b5d8fa/tomlkit-0.13.2.tar.gz", hash = "sha256:fff5fe59a87295b278abd31bec92c15d9bc4a06885ab12bcea52c71119392e79", size = 192885 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f9/b6/a447b5e4ec71e13871be01ba81f5dfc9d0af7e473da256ff46bc0e24026f/tomlkit-0.13.2-py3-none-any.whl", hash = "sha256:7a974427f6e119197f670fbbbeae7bef749a6c14e793db934baefc1b5f03efde", size = 37955 }, +] + +[[package]] +name = "yapf" +version = "0.43.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "platformdirs" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/23/97/b6f296d1e9cc1ec25c7604178b48532fa5901f721bcf1b8d8148b13e5588/yapf-0.43.0.tar.gz", hash = "sha256:00d3aa24bfedff9420b2e0d5d9f5ab6d9d4268e72afbf59bb3fa542781d5218e", size = 254907 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/37/81/6acd6601f61e31cfb8729d3da6d5df966f80f374b78eff83760714487338/yapf-0.43.0-py3-none-any.whl", hash = "sha256:224faffbc39c428cb095818cf6ef5511fdab6f7430a10783fdfb292ccf2852ca", size = 256158 }, +] diff --git a/scripts/check_docs_formatted.py b/scripts/check_docs_formatted.py index c262722056267..dc45579ca02f1 100755 --- a/scripts/check_docs_formatted.py +++ b/scripts/check_docs_formatted.py @@ -1,9 +1,10 @@ #!/usr/bin/env python3 -"""Check code snippets in docs are formatted by black.""" +"""Check code snippets in docs are formatted by Ruff.""" from __future__ import annotations import argparse +import json import os import re import subprocess @@ -16,13 +17,27 @@ from collections.abc import Sequence SNIPPED_RE = re.compile( - r"(?P^(?P *)```(?:\s*(?P\w+))?\n)" + r"(?P^(?P\x20*)```(?:\s*(?P\w+))?\n)" r"(?P.*?)" r"(?P^(?P=indent)```\s*$)", re.DOTALL | re.MULTILINE, ) -# For some rules, we don't want black to fix the formatting as this would "fix" the +# Long explanation: https://www.rexegg.com/regex-best-trick.html +# +# Short explanation: +# Match both code blocks and shortcut links, then discard the former. +# Whatever matched by the second branch is guaranteed to never be +# part of a code block, as that would already be caught by the first. +BACKTICKED_SHORTCUT_LINK_RE = re.compile( + rf"""(?msx) + (?:{SNIPPED_RE} + | \[`(?P[^`\n]+)`](?![\[(]) + ) + """ +) + +# For some rules, we don't want Ruff to fix the formatting as this would "fix" the # example. KNOWN_FORMATTING_VIOLATIONS = [ "avoidable-escaped-quote", @@ -31,13 +46,16 @@ "bad-quotes-multiline-string", "blank-line-after-decorator", "blank-line-before-class", + "blank-line-before-function", "blank-line-between-methods", "blank-lines-after-function-or-class", "blank-lines-before-nested-definition", "blank-lines-top-level", + "docstring-tab-indentation", "explicit-string-concatenation", "f-string-missing-placeholders", - "indent-with-spaces", + "incorrect-blank-line-after-class", + "incorrect-blank-line-before-class", "indentation-with-invalid-multiple", "line-too-long", "missing-trailing-comma", @@ -58,20 +76,18 @@ "multiple-spaces-before-operator", "multiple-statements-on-one-line-colon", "multiple-statements-on-one-line-semicolon", - "no-blank-line-before-function", "no-indented-block-comment", "no-return-argument-annotation-in-stub", "no-space-after-block-comment", "no-space-after-inline-comment", "non-empty-stub-body", - "one-blank-line-after-class", - "one-blank-line-before-class", "over-indentation", "over-indented", "pass-statement-stub-body", "prohibited-trailing-comma", "redundant-backslash", "shebang-leading-whitespace", + "single-line-implicit-string-concatenation", "surrounding-whitespace", "too-few-spaces-before-inline-comment", "too-many-blank-lines", @@ -92,10 +108,11 @@ "whitespace-before-punctuation", ] -# For some docs, black is unable to parse the example code. +# For some docs, Ruff is unable to parse the example code. KNOWN_PARSE_ERRORS = [ "blank-line-with-whitespace", "indentation-with-invalid-multiple-comment", + "indented-form-feed", "missing-newline-at-end-of-file", "mixed-spaces-and-tabs", "no-indented-block", @@ -159,7 +176,7 @@ def _snipped_match(match: Match[str]) -> str: case _: # We are only interested in checking the formatting of py or pyi code # blocks so we can return early if the language is not one of these. - return f'{match["before"]}{match["code"]}{match["after"]}' + return f"{match['before']}{match['code']}{match['after']}" code = textwrap.dedent(match["code"]) try: @@ -170,7 +187,7 @@ def _snipped_match(match: Match[str]) -> str: raise e code = textwrap.indent(code, match["indent"]) - return f'{match["before"]}{code}{match["after"]}' + return f"{match['before']}{code}{match['after']}" src = SNIPPED_RE.sub(_snipped_match, src) return src, errors @@ -236,10 +253,32 @@ def format_file(file: Path, error_known: bool, args: argparse.Namespace) -> int: return 0 +def find_backticked_shortcut_links( + path: Path, all_config_names: dict[str, object] +) -> set[str]: + """Check for links of the form: [`foobar`]. + + See explanation at #16010. + """ + + with path.open() as file: + contents = file.read() + + broken_link_names: set[str] = set() + + for match in BACKTICKED_SHORTCUT_LINK_RE.finditer(contents): + name = match["name"] + + if name is not None and name not in all_config_names: + broken_link_names.add(name) + + return broken_link_names + + def main(argv: Sequence[str] | None = None) -> int: - """Check code snippets in docs are formatted by black.""" + """Check code snippets in docs are formatted by Ruff.""" parser = argparse.ArgumentParser( - description="Check code snippets in docs are formatted by black.", + description="Check code snippets in docs are formatted by Ruff.", ) parser.add_argument("--skip-errors", action="store_true") parser.add_argument("--generate-docs", action="store_true") @@ -289,8 +328,14 @@ def main(argv: Sequence[str] | None = None) -> int: print("Please remove them and re-run.") return 1 + ruff_config_output = subprocess.check_output( + ["ruff", "config", "--output-format", "json"], encoding="utf-8" + ) + all_config_names = json.loads(ruff_config_output) + violations = 0 errors = 0 + broken_links: dict[str, set[str]] = {} print("Checking docs formatting...") for file in [*static_docs, *generated_docs]: rule_name = file.name.split(".")[0] @@ -305,13 +350,38 @@ def main(argv: Sequence[str] | None = None) -> int: elif result == 2 and not error_known: errors += 1 + broken_links_in_file = find_backticked_shortcut_links(file, all_config_names) + + if broken_links_in_file: + broken_links[file.name] = broken_links_in_file + if violations > 0: print(f"Formatting violations identified: {violations}") if errors > 0: print(f"New code block parse errors identified: {errors}") - if violations > 0 or errors > 0: + if broken_links: + print() + print("Do not use backticked shortcut links: [`foobar`]") + print( + "They work with Mkdocs but cannot be rendered by CommonMark and GFM-compliant implementers." + ) + print("Instead, use an explicit label:") + print("```markdown") + print("[`lorem.ipsum`][lorem-ipsum]") + print() + print("[lorem-ipsum]: https://example.com/") + print("```") + + print() + print("The following links are found to be broken:") + + for filename, link_names in broken_links.items(): + print(f"- {filename}:") + print("\n".join(f" - {name}" for name in link_names)) + + if violations > 0 or errors > 0 or broken_links: return 1 print("All docs are formatted correctly.") diff --git a/scripts/check_ecosystem.py b/scripts/check_ecosystem.py index e9b38d3d4e136..824cdcc217e33 100755 --- a/scripts/check_ecosystem.py +++ b/scripts/check_ecosystem.py @@ -104,9 +104,9 @@ async def _get_commit(self: Self, checkout_dir: Path) -> str: stdout=PIPE, ) git_sha_stdout, _ = await git_sha_process.communicate() - assert ( - await git_sha_process.wait() == 0 - ), f"Failed to retrieve commit sha at {checkout_dir}" + assert await git_sha_process.wait() == 0, ( + f"Failed to retrieve commit sha at {checkout_dir}" + ) return git_sha_stdout.decode().strip() @@ -126,8 +126,7 @@ async def _get_commit(self: Self, checkout_dir: Path) -> str: Repository("binary-husky", "gpt_academic", "master"), Repository("bloomberg", "pytest-memray", "main"), Repository("bokeh", "bokeh", "branch-3.3", select="ALL"), - # Disabled due to use of explicit `select` with `E999`, which is no longer - # supported in `--preview`. + # Disabled due to use of explicit `select` with `E999`, which has been removed. # See: https://github.com/astral-sh/ruff/pull/12129 # Repository("demisto", "content", "master"), Repository("docker", "docker-py", "main"), @@ -450,7 +449,7 @@ async def limited_parallelism(coroutine: T) -> T: if matches is None: # Handle case where there are no regex matches e.g. - # + "?application=AIRFLOW&authenticator=TEST_AUTH&role=TEST_ROLE&warehouse=TEST_WAREHOUSE" # noqa: E501 + # + "?application=AIRFLOW&authenticator=TEST_AUTH&role=TEST_ROLE&warehouse=TEST_WAREHOUSE" # Which was found in local testing continue diff --git a/scripts/formatter_ecosystem_checks.sh b/scripts/formatter_ecosystem_checks.sh index 366e53b74e6c0..5d0956c186bda 100755 --- a/scripts/formatter_ecosystem_checks.sh +++ b/scripts/formatter_ecosystem_checks.sh @@ -8,7 +8,7 @@ # errors. # # This script will first clone a diverse set of (mostly) black formatted -# repositories with fixed revisions to target/progress_projects. Each project +# repositories with fixed revisions to target/formatter-ecosystem. Each project # gets formatted (without modifying the files on disk) to check how # similar our style is to black. It also catches common issues such as # unstable formatting, internal formatter errors and printing invalid syntax. @@ -18,72 +18,103 @@ set -e target=$(git rev-parse --show-toplevel)/target -dir="$target/progress_projects" +dir="$target/formatter-ecosystem" mkdir -p "$dir" +# Perform an idempotent clone and checkout of a commit +clone_commit() { + local repo="$1" + local name="$2" + local ref="$3" + + if [ -z "$repo" ] || [ -z "$name" ] || [ -z "$ref" ]; then + echo "Usage: clone_commit " + return 1 + fi + + local target="$dir/projects/$name" + + if [ ! -d "$target/.git" ]; then + echo "Cloning $repo to $name" + # Perform a minimal clone, we only need a single commit + git clone --filter=blob:none --depth=1 --no-tags --no-checkout --single-branch "$repo" "$target" + fi + + echo "Using $repo at $ref" + git -C "$target" fetch --filter=blob:none --depth=1 --no-tags origin "$ref" + git -C "$target" checkout -q "$ref" +} + # small util library -if [ ! -d "$dir/twine/.git" ]; then - git clone --filter=tree:0 https://github.com/pypa/twine "$dir/twine" -fi -git -C "$dir/twine" checkout -q ae71822a3cb0478d0f6a0cccb65d6f8e6275ece5 +clone_commit \ + "https://github.com/pypa/twine" \ + "twine" \ + "ae71822a3cb0478d0f6a0cccb65d6f8e6275ece5" & # web framework that implements a lot of magic -if [ ! -d "$dir/django/.git" ]; then - git clone --filter=tree:0 https://github.com/django/django "$dir/django" -fi -git -C "$dir/django" checkout -q ee5147cfd7de2add74a285537a8968ec074e70cd +clone_commit \ + "https://github.com/django/django" \ + "django" \ + "ee5147cfd7de2add74a285537a8968ec074e70cd" & # an ML project -if [ ! -d "$dir/transformers/.git" ]; then - git clone --filter=tree:0 https://github.com/huggingface/transformers "$dir/transformers" -fi -git -C "$dir/transformers" checkout -q ac5a0556f14dec503b064d5802da1092e0b558ea +clone_commit \ + "https://github.com/huggingface/transformers" \ + "transformers" \ + "ac5a0556f14dec503b064d5802da1092e0b558ea" & # type annotations -if [ ! -d "$dir/typeshed/.git" ]; then - git clone --filter=tree:0 https://github.com/python/typeshed "$dir/typeshed" -fi -git -C "$dir/typeshed" checkout -q d34ef50754de993d01630883dbcd1d27ba507143 +clone_commit \ + "https://github.com/python/typeshed" \ + "typeshed" \ + "d34ef50754de993d01630883dbcd1d27ba507143" & # python 3.11, typing and 100% test coverage -if [ ! -d "$dir/warehouse/.git" ]; then - git clone --filter=tree:0 https://github.com/pypi/warehouse "$dir/warehouse" -fi -git -C "$dir/warehouse" checkout -q 5a4d2cadec641b5d6a6847d0127940e0f532f184 +clone_commit \ + "https://github.com/pypi/warehouse" \ + "warehouse" \ + "5a4d2cadec641b5d6a6847d0127940e0f532f184" & # zulip, a django user -if [ ! -d "$dir/zulip/.git" ]; then - git clone --filter=tree:0 https://github.com/zulip/zulip "$dir/zulip" -fi -git -C "$dir/zulip" checkout -q ccddbba7a3074283ccaac3bde35fd32b19faf042 +clone_commit \ + "https://github.com/zulip/zulip" \ + "zulip" \ + "ccddbba7a3074283ccaac3bde35fd32b19faf042" & # home-assistant, home automation with 1ok files -if [ ! -d "$dir/home-assistant/.git" ]; then - git clone --filter=tree:0 https://github.com/home-assistant/core "$dir/home-assistant" -fi -git -C "$dir/home-assistant" checkout -q 3601c531f400255d10b82529549e564fbe483a54 +clone_commit \ + "https://github.com/home-assistant/core" \ + "home-assistant" \ + "3601c531f400255d10b82529549e564fbe483a54" & # poetry, a package manager that uses black preview style -if [ ! -d "$dir/poetry/.git" ]; then - git clone --filter=tree:0 https://github.com/python-poetry/poetry "$dir/poetry" -fi -git -C "$dir/poetry" checkout -q 36fedb59b8e655252168055b536ead591068e1e4 +clone_commit \ + "https://github.com/python-poetry/poetry" \ + "poetry" \ + "36fedb59b8e655252168055b536ead591068e1e4" & # cpython itself -if [ ! -d "$dir/cpython/.git" ]; then - git clone --filter=tree:0 https://github.com/python/cpython "$dir/cpython" -fi -git -C "$dir/cpython" checkout -q 28aea5d07d163105b42acd81c1651397ef95ea57 +clone_commit \ + "https://github.com/python/cpython" \ + "cpython" \ + "28aea5d07d163105b42acd81c1651397ef95ea57" & + +# wait for the concurrent clones to complete +wait # Uncomment if you want to update the hashes #for i in "$dir"/*/; do git -C "$i" switch main && git -C "$i" pull; done #for i in "$dir"/*/; do echo "# $(basename "$i") $(git -C "$i" rev-parse HEAD)"; done time cargo run --bin ruff_dev -- format-dev --stability-check \ - --error-file "$target/progress_projects_errors.txt" --log-file "$target/progress_projects_log.txt" --stats-file "$target/progress_projects_stats.txt" \ - --files-with-errors 3 --multi-project "$dir" || ( + --error-file "$dir/errors.txt" \ + --log-file "$dir/log.txt" \ + --stats-file "$dir/stats.txt" \ + --files-with-errors 3 --multi-project "$dir/projects" \ +|| ( echo "Ecosystem check failed" - cat "$target/progress_projects_log.txt" + cat "$dir/log.txt" exit 1 ) -cat "$target/progress_projects_stats.txt" + +cat "$dir/stats.txt" diff --git a/scripts/fuzz-parser/fuzz.py b/scripts/fuzz-parser/fuzz.py deleted file mode 100644 index 9ef36cee191c4..0000000000000 --- a/scripts/fuzz-parser/fuzz.py +++ /dev/null @@ -1,336 +0,0 @@ -""" -Run the parser on randomly generated (but syntactically valid) Python source-code files. - -To install all dependencies for this script into an environment using `uv`, run: - uv pip install -r scripts/fuzz-parser/requirements.txt - -Example invocations of the script: -- Run the fuzzer using seeds 0, 1, 2, 78 and 93 to generate the code: - `python scripts/fuzz-parser/fuzz.py 0-2 78 93` -- Run the fuzzer concurrently using seeds in range 0-10 inclusive, - but only reporting bugs that are new on your branch: - `python scripts/fuzz-parser/fuzz.py 0-10 --new-bugs-only` -- Run the fuzzer concurrently on 10,000 different Python source-code files, - using a random selection of seeds, and only print a summary at the end - (the `shuf` command is Unix-specific): - `python scripts/fuzz-parser/fuzz.py $(shuf -i 0-1000000 -n 10000) --quiet -""" - -from __future__ import annotations - -import argparse -import concurrent.futures -import os.path -import subprocess -from dataclasses import KW_ONLY, dataclass -from functools import partial -from typing import NewType - -from pysource_codegen import generate as generate_random_code -from pysource_minimize import minimize as minimize_repro -from rich_argparse import RawDescriptionRichHelpFormatter -from termcolor import colored - -MinimizedSourceCode = NewType("MinimizedSourceCode", str) -Seed = NewType("Seed", int) -ExitCode = NewType("ExitCode", int) - - -def contains_bug(code: str, *, ruff_executable: str) -> bool: - """Return `True` if the code triggers a parser error.""" - completed_process = subprocess.run( - [ruff_executable, "check", "--config", "lint.select=[]", "--no-cache", "-"], - capture_output=True, - text=True, - input=code, - ) - return completed_process.returncode != 0 - - -def contains_new_bug( - code: str, *, test_executable: str, baseline_executable: str -) -> bool: - """Return `True` if the code triggers a *new* parser error. - - A "new" parser error is one that exists with `test_executable`, - but did not exist with `baseline_executable`. - """ - return contains_bug(code, ruff_executable=test_executable) and not contains_bug( - code, ruff_executable=baseline_executable - ) - - -@dataclass(slots=True) -class FuzzResult: - # The seed used to generate the random Python file. - # The same seed always generates the same file. - seed: Seed - # If we found a bug, this will be the minimum Python code - # required to trigger the bug. If not, it will be `None`. - maybe_bug: MinimizedSourceCode | None - - def print_description(self, index: int, num_seeds: int) -> None: - """Describe the results of fuzzing the parser with this seed.""" - progress = f"[{index}/{num_seeds}]" - msg = ( - colored(f"Ran fuzzer on seed {self.seed}", "red") - if self.maybe_bug - else colored(f"Ran fuzzer successfully on seed {self.seed}", "green") - ) - print(f"{msg:<60} {progress:>15}", flush=True) - if self.maybe_bug: - print(colored("The following code triggers a bug:", "red")) - print() - print(self.maybe_bug) - print(flush=True) - - -def fuzz_code( - seed: Seed, - *, - test_executable: str, - baseline_executable: str, - only_new_bugs: bool, -) -> FuzzResult: - """Return a `FuzzResult` instance describing the fuzzing result from this seed.""" - code = generate_random_code(seed) - has_bug = ( - contains_new_bug( - code, - test_executable=test_executable, - baseline_executable=baseline_executable, - ) - if only_new_bugs - else contains_bug(code, ruff_executable=test_executable) - ) - if has_bug: - maybe_bug = MinimizedSourceCode( - minimize_repro(code, partial(contains_bug, ruff_executable=test_executable)) - ) - else: - maybe_bug = None - return FuzzResult(seed, maybe_bug) - - -def run_fuzzer_concurrently(args: ResolvedCliArgs) -> list[FuzzResult]: - num_seeds = len(args.seeds) - print( - f"Concurrently running the fuzzer on " - f"{num_seeds} randomly generated source-code files..." - ) - bugs: list[FuzzResult] = [] - with concurrent.futures.ProcessPoolExecutor() as executor: - fuzz_result_futures = [ - executor.submit( - fuzz_code, - seed, - test_executable=args.test_executable, - baseline_executable=args.baseline_executable, - only_new_bugs=args.only_new_bugs, - ) - for seed in args.seeds - ] - try: - for i, future in enumerate( - concurrent.futures.as_completed(fuzz_result_futures), start=1 - ): - fuzz_result = future.result() - if not args.quiet: - fuzz_result.print_description(i, num_seeds) - if fuzz_result.maybe_bug: - bugs.append(fuzz_result) - except KeyboardInterrupt: - print("\nShutting down the ProcessPoolExecutor due to KeyboardInterrupt...") - print("(This might take a few seconds)") - executor.shutdown(cancel_futures=True) - raise - return bugs - - -def run_fuzzer_sequentially(args: ResolvedCliArgs) -> list[FuzzResult]: - num_seeds = len(args.seeds) - print( - f"Sequentially running the fuzzer on " - f"{num_seeds} randomly generated source-code files..." - ) - bugs: list[FuzzResult] = [] - for i, seed in enumerate(args.seeds, start=1): - fuzz_result = fuzz_code( - seed, - test_executable=args.test_executable, - baseline_executable=args.baseline_executable, - only_new_bugs=args.only_new_bugs, - ) - if not args.quiet: - fuzz_result.print_description(i, num_seeds) - if fuzz_result.maybe_bug: - bugs.append(fuzz_result) - return bugs - - -def main(args: ResolvedCliArgs) -> ExitCode: - if len(args.seeds) <= 5: - bugs = run_fuzzer_sequentially(args) - else: - bugs = run_fuzzer_concurrently(args) - noun_phrase = "New bugs" if args.only_new_bugs else "Bugs" - if bugs: - print(colored(f"{noun_phrase} found in the following seeds:", "red")) - print(*sorted(bug.seed for bug in bugs)) - return ExitCode(1) - else: - print(colored(f"No {noun_phrase.lower()} found!", "green")) - return ExitCode(0) - - -def parse_seed_argument(arg: str) -> int | range: - """Helper for argument parsing""" - if "-" in arg: - start, end = map(int, arg.split("-")) - if end <= start: - raise argparse.ArgumentTypeError( - f"Error when parsing seed argument {arg!r}: " - f"range end must be > range start" - ) - seed_range = range(start, end + 1) - range_too_long = ( - f"Error when parsing seed argument {arg!r}: " - f"maximum allowed range length is 1_000_000_000" - ) - try: - if len(seed_range) > 1_000_000_000: - raise argparse.ArgumentTypeError(range_too_long) - except OverflowError: - raise argparse.ArgumentTypeError(range_too_long) from None - return range(int(start), int(end) + 1) - return int(arg) - - -@dataclass(slots=True) -class ResolvedCliArgs: - seeds: list[Seed] - _: KW_ONLY - test_executable: str - baseline_executable: str - only_new_bugs: bool - quiet: bool - - -def parse_args() -> ResolvedCliArgs: - """Parse command-line arguments""" - parser = argparse.ArgumentParser( - description=__doc__, formatter_class=RawDescriptionRichHelpFormatter - ) - parser.add_argument( - "seeds", - type=parse_seed_argument, - nargs="+", - help="Either a single seed, or an inclusive range of seeds in the format `0-5`", - ) - parser.add_argument( - "--only-new-bugs", - action="store_true", - help=( - "Only report bugs if they exist on the current branch, " - "but *didn't* exist on the released version of Ruff " - "installed into the Python environment we're running in" - ), - ) - parser.add_argument( - "--quiet", - action="store_true", - help="Print fewer things to the terminal while running the fuzzer", - ) - parser.add_argument( - "--test-executable", - help=( - "`ruff` executable to test. " - "Defaults to a fresh build of the currently checked-out branch." - ), - ) - parser.add_argument( - "--baseline-executable", - help=( - "`ruff` executable to compare results against. " - "Defaults to whatever `ruff` version is installed " - "in the Python environment." - ), - ) - - args = parser.parse_args() - - if args.baseline_executable: - if not args.only_new_bugs: - parser.error( - "Specifying `--baseline-executable` has no effect " - "unless `--only-new-bugs` is also specified" - ) - try: - subprocess.run( - [args.baseline_executable, "--version"], check=True, capture_output=True - ) - except FileNotFoundError: - parser.error( - f"Bad argument passed to `--baseline-executable`: " - f"no such file or executable {args.baseline_executable!r}" - ) - elif args.only_new_bugs: - try: - ruff_version_proc = subprocess.run( - ["ruff", "--version"], text=True, capture_output=True, check=True - ) - except FileNotFoundError: - parser.error( - "`--only-new-bugs` was specified without specifying a baseline " - "executable, and no released version of Ruff appears to be installed " - "in your Python environment" - ) - else: - if not args.quiet: - ruff_version = ruff_version_proc.stdout.strip().split(" ")[1] - print( - f"`--only-new-bugs` was specified without specifying a baseline " - f"executable; falling back to using `ruff=={ruff_version}` as the " - f"baseline (the version of Ruff installed in your current Python " - f"environment)" - ) - args.baseline_executable = "ruff" - - if not args.test_executable: - print( - "Running `cargo build --release` since no test executable was specified...", - flush=True, - ) - try: - subprocess.run( - ["cargo", "build", "--release", "--locked", "--color", "always"], - check=True, - capture_output=True, - text=True, - ) - except subprocess.CalledProcessError as e: - print(e.stderr) - raise - args.test_executable = os.path.join("target", "release", "ruff") - assert os.path.exists(args.test_executable) - - seed_arguments: list[range | int] = args.seeds - seen_seeds: set[int] = set() - for arg in seed_arguments: - if isinstance(arg, int): - seen_seeds.add(arg) - else: - seen_seeds.update(arg) - - return ResolvedCliArgs( - sorted(map(Seed, seen_seeds)), - only_new_bugs=args.only_new_bugs, - quiet=args.quiet, - test_executable=args.test_executable, - baseline_executable=args.baseline_executable, - ) - - -if __name__ == "__main__": - args = parse_args() - raise SystemExit(main(args)) diff --git a/scripts/fuzz-parser/requirements.in b/scripts/fuzz-parser/requirements.in deleted file mode 100644 index b73747bdbcbee..0000000000000 --- a/scripts/fuzz-parser/requirements.in +++ /dev/null @@ -1,5 +0,0 @@ -pysource-codegen -pysource-minimize -rich-argparse -ruff -termcolor diff --git a/scripts/fuzz-parser/requirements.txt b/scripts/fuzz-parser/requirements.txt deleted file mode 100644 index b277f9f4abe65..0000000000000 --- a/scripts/fuzz-parser/requirements.txt +++ /dev/null @@ -1,36 +0,0 @@ -# This file was autogenerated by uv via the following command: -# uv pip compile scripts/fuzz-parser/requirements.in --output-file scripts/fuzz-parser/requirements.txt -asttokens==2.4.1 - # via pysource-minimize -astunparse==1.6.3 - # via pysource-minimize -click==8.1.7 - # via pysource-minimize -markdown-it-py==3.0.0 - # via rich -mdurl==0.1.2 - # via markdown-it-py -pygments==2.18.0 - # via rich -pysource-codegen==0.5.2 - # via -r scripts/fuzz-parser/requirements.in -pysource-minimize==0.6.3 - # via -r scripts/fuzz-parser/requirements.in -rich==13.7.1 - # via - # pysource-minimize - # rich-argparse -rich-argparse==1.5.2 - # via -r scripts/fuzz-parser/requirements.in -ruff==0.5.0 - # via -r scripts/fuzz-parser/requirements.in -six==1.16.0 - # via - # asttokens - # astunparse -termcolor==2.4.0 - # via -r scripts/fuzz-parser/requirements.in -typing-extensions==4.12.2 - # via pysource-codegen -wheel==0.43.0 - # via astunparse diff --git a/scripts/generate_builtin_modules.py b/scripts/generate_builtin_modules.py index b1a193773153a..8f1171498fcce 100644 --- a/scripts/generate_builtin_modules.py +++ b/scripts/generate_builtin_modules.py @@ -70,7 +70,7 @@ def generate_module( /// modules. /// /// [builtin module]: https://docs.python.org/3/library/sys.html#sys.builtin_module_names - #[allow(clippy::unnested_or_patterns)] + #[expect(clippy::unnested_or_patterns)] pub fn is_builtin_module(minor_version: u8, module: &str) -> bool { matches!((minor_version, module), """, diff --git a/scripts/generate_known_standard_library.py b/scripts/generate_known_standard_library.py index 22117b60d4f99..84355af82a4f7 100644 --- a/scripts/generate_known_standard_library.py +++ b/scripts/generate_known_standard_library.py @@ -13,6 +13,7 @@ (3, 11), (3, 12), (3, 13), + (3, 14), ] with PATH.open("w") as f: diff --git a/scripts/generate_mkdocs.py b/scripts/generate_mkdocs.py index 1e3c5ba521487..54e224cd66df6 100644 --- a/scripts/generate_mkdocs.py +++ b/scripts/generate_mkdocs.py @@ -8,14 +8,13 @@ import shutil import subprocess from collections.abc import Sequence +from itertools import chain from pathlib import Path from typing import NamedTuple import mdformat import yaml -from _mdformat_utils import add_no_escape_text_plugin - class Section(NamedTuple): """A section to include in the MkDocs documentation.""" @@ -104,31 +103,69 @@ def clean_file_content(content: str, title: str) -> str: return f"# {title}\n\n" + content -def add_meta_description(rule_doc: Path) -> str: - """Add a meta description to the rule doc.""" - # Read the rule doc into lines +def generate_rule_metadata(rule_doc: Path) -> None: + """Add frontmatter metadata containing a rule's code and description. + + For example: + ```yaml + --- + description: Checks for abstract classes without abstract methods or properties. + tags: + - B024 + --- + ``` + """ + # Read the rule doc into lines. with rule_doc.open("r", encoding="utf-8") as f: lines = f.readlines() - # Get the description from the rule doc lines + # Get the description and rule code from the rule doc lines. + rule_code = None + description = None what_it_does_found = False for line in lines: if line == "\n": continue + # Assume that the only first-level heading is the rule title and code. + # + # For example: given `# abstract-base-class-without-abstract-method (B024)`, + # extract the rule code (`B024`). + if line.startswith("# "): + rule_code = line.strip().rsplit("(", 1) + rule_code = rule_code[1][:-1] + if line.startswith("## What it does"): what_it_does_found = True continue # Skip the '## What it does' line - if what_it_does_found: + if what_it_does_found and not description: description = line.removesuffix("\n") + + if all([rule_code, description]): break else: + if not rule_code: + raise ValueError("Missing title line") + if not what_it_does_found: raise ValueError(f"Missing '## What it does' in {rule_doc}") with rule_doc.open("w", encoding="utf-8") as f: - f.writelines("\n".join(["---", f"description: {description}", "---", "", ""])) + f.writelines( + "\n".join( + [ + "---", + "description: |-", + f" {description}", + "tags:", + f"- {rule_code}", + "---", + "", + "", + ] + ) + ) f.writelines(lines) @@ -191,14 +228,13 @@ def main() -> None: f.write(clean_file_content(file_content, title)) - add_no_escape_text_plugin() for rule_doc in Path("docs/rules").glob("*.md"): # Format rules docs. This has to be completed before adding the meta description # otherwise the meta description will be formatted in a way that mkdocs does not # support. - mdformat.file(rule_doc, extensions=["mkdocs", "admon", "no-escape-text"]) + mdformat.file(rule_doc, extensions=["mkdocs"]) - add_meta_description(rule_doc) + generate_rule_metadata(rule_doc) with Path("mkdocs.template.yml").open(encoding="utf8") as fp: config = yaml.safe_load(fp) @@ -222,10 +258,18 @@ def main() -> None: config["plugins"].append( { "redirects": { - "redirect_maps": { - f'rules/{rule["code"]}.md': f'rules/{rule["name"]}.md' - for rule in rules - }, + "redirect_maps": dict( + chain.from_iterable( + [ + (f"rules/{rule['code']}.md", f"rules/{rule['name']}.md"), + ( + f"rules/{rule['code'].lower()}.md", + f"rules/{rule['name']}.md", + ), + ] + for rule in rules + ) + ), }, }, ) diff --git a/scripts/knot_benchmark/README.md b/scripts/knot_benchmark/README.md deleted file mode 100644 index 622d6da747873..0000000000000 --- a/scripts/knot_benchmark/README.md +++ /dev/null @@ -1,21 +0,0 @@ -## Getting started - -1. [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/) - -- Unix: `curl -LsSf https://astral.sh/uv/install.sh | sh` -- Windows: `powershell -c "irm https://astral.sh/uv/install.ps1 | iex"` - -1. Build red_knot: `cargo build --bin red_knot --release` -1. `cd` into the benchmark directory: `cd scripts/knot_benchmark` -1. Run benchmarks: `uv run benchmark` - -## Known limitations - -Red Knot only implements a tiny fraction of Mypy's and Pyright's functionality, -so the benchmarks aren't in any way a fair comparison today. However, -they'll become more meaningful as we build out more type checking features in Red Knot. - -### Windows support - -The script should work on Windows, but we haven't tested it yet. -We do make use of `shlex` which has known limitations when using non-POSIX shells. diff --git a/scripts/knot_benchmark/pyproject.toml b/scripts/knot_benchmark/pyproject.toml deleted file mode 100644 index e1c5191232cf7..0000000000000 --- a/scripts/knot_benchmark/pyproject.toml +++ /dev/null @@ -1,21 +0,0 @@ -[project] -name = "knot_benchmark" -version = "0.0.1" -description = "Package for running end-to-end Red Knot benchmarks" -requires-python = ">=3.12" -dependencies = ["mypy", "pyright"] - -[project.scripts] -benchmark = "benchmark.run:main" - -[build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" - -[tool.hatch.build.targets.wheel] -packages = ["src/benchmark"] - -[tool.ruff.lint] -ignore = [ - "E501", # We use ruff format -] diff --git a/scripts/knot_benchmark/uv.lock b/scripts/knot_benchmark/uv.lock deleted file mode 100644 index 0fcb11197a1e9..0000000000000 --- a/scripts/knot_benchmark/uv.lock +++ /dev/null @@ -1,74 +0,0 @@ -version = 1 -requires-python = ">=3.12" - -[[package]] -name = "knot-benchmark" -version = "0.0.1" -source = { editable = "." } -dependencies = [ - { name = "mypy" }, - { name = "pyright" }, -] - -[package.metadata] -requires-dist = [ - { name = "mypy" }, - { name = "pyright" }, -] - -[[package]] -name = "mypy" -version = "1.11.1" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "mypy-extensions" }, - { name = "typing-extensions" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/b6/9c/a4b3bda53823439cf395db8ecdda6229a83f9bf201714a68a15190bb2919/mypy-1.11.1.tar.gz", hash = "sha256:f404a0b069709f18bbdb702eb3dcfe51910602995de00bd39cea3050b5772d08", size = 3078369 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/3a/34/69638cee2e87303f19a0c35e80d42757e14d9aba328f272fdcdc0bf3c9b8/mypy-1.11.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f39918a50f74dc5969807dcfaecafa804fa7f90c9d60506835036cc1bc891dc8", size = 10995789 }, - { url = "https://files.pythonhosted.org/packages/c4/3c/3e0611348fc53a4a7c80485959478b4f6eae706baf3b7c03cafa22639216/mypy-1.11.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0bc71d1fb27a428139dd78621953effe0d208aed9857cb08d002280b0422003a", size = 10002696 }, - { url = "https://files.pythonhosted.org/packages/1c/21/a6b46c91b4c9d1918ee59c305f46850cde7cbea748635a352e7c3c8ed204/mypy-1.11.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b868d3bcff720dd7217c383474008ddabaf048fad8d78ed948bb4b624870a417", size = 12505772 }, - { url = "https://files.pythonhosted.org/packages/c4/55/07904d4c8f408e70308015edcbff067eaa77514475938a9dd81b063de2a8/mypy-1.11.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a707ec1527ffcdd1c784d0924bf5cb15cd7f22683b919668a04d2b9c34549d2e", size = 12954190 }, - { url = "https://files.pythonhosted.org/packages/1e/b7/3a50f318979c8c541428c2f1ee973cda813bcc89614de982dafdd0df2b3e/mypy-1.11.1-cp312-cp312-win_amd64.whl", hash = "sha256:64f4a90e3ea07f590c5bcf9029035cf0efeae5ba8be511a8caada1a4893f5525", size = 9663138 }, - { url = "https://files.pythonhosted.org/packages/f8/d4/4960d0df55f30a7625d9c3c9414dfd42f779caabae137ef73ffaed0c97b9/mypy-1.11.1-py3-none-any.whl", hash = "sha256:0624bdb940255d2dd24e829d99a13cfeb72e4e9031f9492148f410ed30bcab54", size = 2619257 }, -] - -[[package]] -name = "mypy-extensions" -version = "1.0.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/98/a4/1ab47638b92648243faf97a5aeb6ea83059cc3624972ab6b8d2316078d3f/mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782", size = 4433 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/2a/e2/5d3f6ada4297caebe1a2add3b126fe800c96f56dbe5d1988a2cbe0b267aa/mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d", size = 4695 }, -] - -[[package]] -name = "nodeenv" -version = "1.9.1" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/43/16/fc88b08840de0e0a72a2f9d8c6bae36be573e475a6326ae854bcc549fc45/nodeenv-1.9.1.tar.gz", hash = "sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f", size = 47437 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/d2/1d/1b658dbd2b9fa9c4c9f32accbfc0205d532c8c6194dc0f2a4c0428e7128a/nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9", size = 22314 }, -] - -[[package]] -name = "pyright" -version = "1.1.377" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "nodeenv" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/49/f0/25b0db363d6888164adb7c828b877bbf2c30936955fb9513922ae03e70e4/pyright-1.1.377.tar.gz", hash = "sha256:aabc30fedce0ded34baa0c49b24f10e68f4bfc8f68ae7f3d175c4b0f256b4fcf", size = 17484 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/34/c9/89c40c4de44fe9463e77dddd0c4e2d2dd7a93e8ddc6858dfe7d5f75d263d/pyright-1.1.377-py3-none-any.whl", hash = "sha256:af0dd2b6b636c383a6569a083f8c5a8748ae4dcde5df7914b3f3f267e14dd162", size = 18223 }, -] - -[[package]] -name = "typing-extensions" -version = "4.12.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/df/db/f35a00659bc03fec321ba8bce9420de607a1d37f8342eee1863174c69557/typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8", size = 85321 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/26/9f/ad63fc0248c5379346306f8668cda6e2e2e9c95e01216d2b8ffd9ff037d0/typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d", size = 37438 }, -] diff --git a/scripts/pyproject.toml b/scripts/pyproject.toml index 3a597fcf834b0..475e14805e4a2 100644 --- a/scripts/pyproject.toml +++ b/scripts/pyproject.toml @@ -8,29 +8,4 @@ requires-python = ">=3.11" line-length = 88 [tool.ruff] -line-length = 88 - -[tool.ruff.lint] -select = [ - "E", # pycodestyle (error) - "F", # pyflakes - "B", # bugbear - "B9", - "C4", # flake8-comprehensions - "SIM", # flake8-simplify - "I", # isort - "UP", # pyupgrade - "PIE", # flake8-pie - "PGH", # pygrep-hooks - "PYI", # flake8-pyi - "RUF", -] - -ignore = [ - # only relevant if you run a script with `python -0`, - # which seems unlikely for any of the scripts in this directory - "B011" -] - -[tool.ruff.lint.isort] -required-imports = ["from __future__ import annotations"] +extend = "../pyproject.toml" diff --git a/scripts/ty_benchmark/README.md b/scripts/ty_benchmark/README.md new file mode 100644 index 0000000000000..e55150d4f1a14 --- /dev/null +++ b/scripts/ty_benchmark/README.md @@ -0,0 +1,21 @@ +## Getting started + +1. [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/) + +- Unix: `curl -LsSf https://astral.sh/uv/install.sh | sh` +- Windows: `powershell -c "irm https://astral.sh/uv/install.ps1 | iex"` + +1. Build ty: `cargo build --bin ty --release` +1. `cd` into the benchmark directory: `cd scripts/ty_benchmark` +1. Run benchmarks: `uv run benchmark` + +## Known limitations + +ty only implements a tiny fraction of Mypy's and Pyright's functionality, +so the benchmarks aren't in any way a fair comparison today. However, +they'll become more meaningful as we build out more type checking features in ty. + +### Windows support + +The script should work on Windows, but we haven't tested it yet. +We do make use of `shlex` which has known limitations when using non-POSIX shells. diff --git a/scripts/ty_benchmark/pyproject.toml b/scripts/ty_benchmark/pyproject.toml new file mode 100644 index 0000000000000..99040466fb1a9 --- /dev/null +++ b/scripts/ty_benchmark/pyproject.toml @@ -0,0 +1,21 @@ +[project] +name = "ty_benchmark" +version = "0.0.1" +description = "Package for running end-to-end ty benchmarks" +requires-python = ">=3.12" +dependencies = ["mypy", "pyright"] + +[project.scripts] +benchmark = "benchmark.run:main" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["src/benchmark"] + +[tool.ruff.lint] +ignore = [ + "E501", # We use ruff format +] diff --git a/scripts/knot_benchmark/src/benchmark/__init__.py b/scripts/ty_benchmark/src/benchmark/__init__.py similarity index 100% rename from scripts/knot_benchmark/src/benchmark/__init__.py rename to scripts/ty_benchmark/src/benchmark/__init__.py diff --git a/scripts/knot_benchmark/src/benchmark/cases.py b/scripts/ty_benchmark/src/benchmark/cases.py similarity index 88% rename from scripts/knot_benchmark/src/benchmark/cases.py rename to scripts/ty_benchmark/src/benchmark/cases.py index 3f97a1bfd7434..786b4b373ff50 100644 --- a/scripts/knot_benchmark/src/benchmark/cases.py +++ b/scripts/ty_benchmark/src/benchmark/cases.py @@ -26,9 +26,9 @@ class Benchmark(enum.Enum): def which_tool(name: str) -> Path: tool = shutil.which(name) - assert ( - tool is not None - ), f"Tool {name} not found. Run the script with `uv run